4a381c2a10
* Update all non-major dependencies * Delint Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Prettier Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> --------- Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Michael Telatynski <7t3chguy@gmail.com>
105 lines
3.6 KiB
TypeScript
105 lines
3.6 KiB
TypeScript
/*
|
|
Copyright 2024 New Vector Ltd.
|
|
Copyright 2019-2023 The Matrix.org Foundation C.I.C.
|
|
|
|
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
|
|
Please see LICENSE files in the repository root for full details.
|
|
*/
|
|
|
|
import { type SdkContextClass } from "../contexts/SDKContext";
|
|
import SettingsStore from "../settings/SettingsStore";
|
|
import { isLocalRoom } from "../utils/localRoom/isLocalRoom";
|
|
import Timer from "../utils/Timer";
|
|
|
|
const TYPING_USER_TIMEOUT = 10000;
|
|
const TYPING_SERVER_TIMEOUT = 30000;
|
|
|
|
/**
|
|
* Tracks typing state for users.
|
|
*/
|
|
export default class TypingStore {
|
|
private typingStates: {
|
|
[roomId: string]: {
|
|
isTyping: boolean;
|
|
userTimer: Timer;
|
|
serverTimer: Timer;
|
|
};
|
|
} = {};
|
|
|
|
public constructor(private readonly context: SdkContextClass) {
|
|
this.reset();
|
|
}
|
|
|
|
/**
|
|
* Clears all cached typing states. Intended to be called when the
|
|
* MatrixClientPeg client changes.
|
|
*/
|
|
public reset(): void {
|
|
this.typingStates = {
|
|
// "roomId": {
|
|
// isTyping: bool, // Whether the user is typing or not
|
|
// userTimer: Timer, // Local timeout for "user has stopped typing"
|
|
// serverTimer: Timer, // Maximum timeout for the typing state
|
|
// },
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Changes the typing status for the MatrixClientPeg user.
|
|
* @param {string} roomId The room ID to set the typing state in.
|
|
* @param {boolean} isTyping Whether the user is typing or not.
|
|
*/
|
|
public setSelfTyping(roomId: string, threadId: string | null, isTyping: boolean): void {
|
|
// No typing notifications for local rooms
|
|
if (isLocalRoom(roomId)) return;
|
|
|
|
if (!SettingsStore.getValue("sendTypingNotifications")) return;
|
|
if (SettingsStore.getValue("lowBandwidth")) return;
|
|
// Disable typing notification for threads for the initial launch
|
|
// before we figure out a better user experience for them
|
|
if (threadId) return;
|
|
|
|
let currentTyping = this.typingStates[roomId];
|
|
if ((!isTyping && !currentTyping) || currentTyping?.isTyping === isTyping) {
|
|
// No change in state, so don't do anything. We'll let the timer run its course.
|
|
return;
|
|
}
|
|
|
|
if (!currentTyping) {
|
|
currentTyping = this.typingStates[roomId] = {
|
|
isTyping: isTyping,
|
|
serverTimer: new Timer(TYPING_SERVER_TIMEOUT),
|
|
userTimer: new Timer(TYPING_USER_TIMEOUT),
|
|
};
|
|
}
|
|
|
|
currentTyping.isTyping = isTyping;
|
|
|
|
if (isTyping) {
|
|
if (!currentTyping.serverTimer.isRunning()) {
|
|
currentTyping.serverTimer
|
|
.restart()
|
|
.finished()
|
|
.then(() => {
|
|
const currentTyping = this.typingStates[roomId];
|
|
if (currentTyping) currentTyping.isTyping = false;
|
|
|
|
// The server will (should) time us out on typing, so we don't
|
|
// need to advertise a stop of typing.
|
|
});
|
|
} else currentTyping.serverTimer.restart();
|
|
|
|
if (!currentTyping.userTimer.isRunning()) {
|
|
currentTyping.userTimer
|
|
.restart()
|
|
.finished()
|
|
.then(() => {
|
|
this.setSelfTyping(roomId, threadId, false);
|
|
});
|
|
} else currentTyping.userTimer.restart();
|
|
}
|
|
|
|
this.context.client?.sendTyping(roomId, isTyping, TYPING_SERVER_TIMEOUT);
|
|
}
|
|
}
|