matrix-react-sdk
Version:
SDK for matrix.org using React
93 lines (86 loc) • 11.8 kB
JavaScript
;
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.default = void 0;
var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
var _SettingsStore = _interopRequireDefault(require("../settings/SettingsStore"));
var _isLocalRoom = require("../utils/localRoom/isLocalRoom");
var _Timer = _interopRequireDefault(require("../utils/Timer"));
/*
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
Please see LICENSE files in the repository root for full details.
*/
const TYPING_USER_TIMEOUT = 10000;
const TYPING_SERVER_TIMEOUT = 30000;
/**
* Tracks typing state for users.
*/
class TypingStore {
constructor(context) {
(0, _defineProperty2.default)(this, "typingStates", {});
this.context = context;
this.reset();
}
/**
* Clears all cached typing states. Intended to be called when the
* MatrixClientPeg client changes.
*/
reset() {
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.
*/
setSelfTyping(roomId, threadId, isTyping) {
// No typing notifications for local rooms
if ((0, _isLocalRoom.isLocalRoom)(roomId)) return;
if (!_SettingsStore.default.getValue("sendTypingNotifications")) return;
if (_SettingsStore.default.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.default(TYPING_SERVER_TIMEOUT),
userTimer: new _Timer.default(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);
}
}
exports.default = TypingStore;
//# sourceMappingURL=data:application/json;charset=utf-8;base64,{"version":3,"names":["_SettingsStore","_interopRequireDefault","require","_isLocalRoom","_Timer","TYPING_USER_TIMEOUT","TYPING_SERVER_TIMEOUT","TypingStore","constructor","context","_defineProperty2","default","reset","typingStates","setSelfTyping","roomId","threadId","isTyping","isLocalRoom","SettingsStore","getValue","currentTyping","serverTimer","Timer","userTimer","isRunning","restart","finished","then","client","sendTyping","exports"],"sources":["../../src/stores/TypingStore.ts"],"sourcesContent":["/*\nCopyright 2024 New Vector Ltd.\nCopyright 2019-2023 The Matrix.org Foundation C.I.C.\n\nSPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only\nPlease see LICENSE files in the repository root for full details.\n*/\n\nimport { SdkContextClass } from \"../contexts/SDKContext\";\nimport SettingsStore from \"../settings/SettingsStore\";\nimport { isLocalRoom } from \"../utils/localRoom/isLocalRoom\";\nimport Timer from \"../utils/Timer\";\n\nconst TYPING_USER_TIMEOUT = 10000;\nconst TYPING_SERVER_TIMEOUT = 30000;\n\n/**\n * Tracks typing state for users.\n */\nexport default class TypingStore {\n    private typingStates: {\n        [roomId: string]: {\n            isTyping: boolean;\n            userTimer: Timer;\n            serverTimer: Timer;\n        };\n    } = {};\n\n    public constructor(private readonly context: SdkContextClass) {\n        this.reset();\n    }\n\n    /**\n     * Clears all cached typing states. Intended to be called when the\n     * MatrixClientPeg client changes.\n     */\n    public reset(): void {\n        this.typingStates = {\n            // \"roomId\": {\n            //     isTyping: bool,     // Whether the user is typing or not\n            //     userTimer: Timer,   // Local timeout for \"user has stopped typing\"\n            //     serverTimer: Timer, // Maximum timeout for the typing state\n            // },\n        };\n    }\n\n    /**\n     * Changes the typing status for the MatrixClientPeg user.\n     * @param {string} roomId The room ID to set the typing state in.\n     * @param {boolean} isTyping Whether the user is typing or not.\n     */\n    public setSelfTyping(roomId: string, threadId: string | null, isTyping: boolean): void {\n        // No typing notifications for local rooms\n        if (isLocalRoom(roomId)) return;\n\n        if (!SettingsStore.getValue(\"sendTypingNotifications\")) return;\n        if (SettingsStore.getValue(\"lowBandwidth\")) return;\n        // Disable typing notification for threads for the initial launch\n        // before we figure out a better user experience for them\n        if (threadId) return;\n\n        let currentTyping = this.typingStates[roomId];\n        if ((!isTyping && !currentTyping) || currentTyping?.isTyping === isTyping) {\n            // No change in state, so don't do anything. We'll let the timer run its course.\n            return;\n        }\n\n        if (!currentTyping) {\n            currentTyping = this.typingStates[roomId] = {\n                isTyping: isTyping,\n                serverTimer: new Timer(TYPING_SERVER_TIMEOUT),\n                userTimer: new Timer(TYPING_USER_TIMEOUT),\n            };\n        }\n\n        currentTyping.isTyping = isTyping;\n\n        if (isTyping) {\n            if (!currentTyping.serverTimer.isRunning()) {\n                currentTyping.serverTimer\n                    .restart()\n                    .finished()\n                    .then(() => {\n                        const currentTyping = this.typingStates[roomId];\n                        if (currentTyping) currentTyping.isTyping = false;\n\n                        // The server will (should) time us out on typing, so we don't\n                        // need to advertise a stop of typing.\n                    });\n            } else currentTyping.serverTimer.restart();\n\n            if (!currentTyping.userTimer.isRunning()) {\n                currentTyping.userTimer\n                    .restart()\n                    .finished()\n                    .then(() => {\n                        this.setSelfTyping(roomId, threadId, false);\n                    });\n            } else currentTyping.userTimer.restart();\n        }\n\n        this.context.client?.sendTyping(roomId, isTyping, TYPING_SERVER_TIMEOUT);\n    }\n}\n"],"mappings":";;;;;;;;AASA,IAAAA,cAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,YAAA,GAAAD,OAAA;AACA,IAAAE,MAAA,GAAAH,sBAAA,CAAAC,OAAA;AAXA;AACA;AACA;AACA;AACA;AACA;AACA;;AAOA,MAAMG,mBAAmB,GAAG,KAAK;AACjC,MAAMC,qBAAqB,GAAG,KAAK;;AAEnC;AACA;AACA;AACe,MAAMC,WAAW,CAAC;EAStBC,WAAWA,CAAkBC,OAAwB,EAAE;IAAA,IAAAC,gBAAA,CAAAC,OAAA,wBAF1D,CAAC,CAAC;IAAA,KAE8BF,OAAwB,GAAxBA,OAAwB;IACxD,IAAI,CAACG,KAAK,CAAC,CAAC;EAChB;;EAEA;AACJ;AACA;AACA;EACWA,KAAKA,CAAA,EAAS;IACjB,IAAI,CAACC,YAAY,GAAG;MAChB;MACA;MACA;MACA;MACA;IAAA,CACH;EACL;;EAEA;AACJ;AACA;AACA;AACA;EACWC,aAAaA,CAACC,MAAc,EAAEC,QAAuB,EAAEC,QAAiB,EAAQ;IACnF;IACA,IAAI,IAAAC,wBAAW,EAACH,MAAM,CAAC,EAAE;IAEzB,IAAI,CAACI,sBAAa,CAACC,QAAQ,CAAC,yBAAyB,CAAC,EAAE;IACxD,IAAID,sBAAa,CAACC,QAAQ,CAAC,cAAc,CAAC,EAAE;IAC5C;IACA;IACA,IAAIJ,QAAQ,EAAE;IAEd,IAAIK,aAAa,GAAG,IAAI,CAACR,YAAY,CAACE,MAAM,CAAC;IAC7C,IAAK,CAACE,QAAQ,IAAI,CAACI,aAAa,IAAKA,aAAa,EAAEJ,QAAQ,KAAKA,QAAQ,EAAE;MACvE;MACA;IACJ;IAEA,IAAI,CAACI,aAAa,EAAE;MAChBA,aAAa,GAAG,IAAI,CAACR,YAAY,CAACE,MAAM,CAAC,GAAG;QACxCE,QAAQ,EAAEA,QAAQ;QAClBK,WAAW,EAAE,IAAIC,cAAK,CAACjB,qBAAqB,CAAC;QAC7CkB,SAAS,EAAE,IAAID,cAAK,CAAClB,mBAAmB;MAC5C,CAAC;IACL;IAEAgB,aAAa,CAACJ,QAAQ,GAAGA,QAAQ;IAEjC,IAAIA,QAAQ,EAAE;MACV,IAAI,CAACI,aAAa,CAACC,WAAW,CAACG,SAAS,CAAC,CAAC,EAAE;QACxCJ,aAAa,CAACC,WAAW,CACpBI,OAAO,CAAC,CAAC,CACTC,QAAQ,CAAC,CAAC,CACVC,IAAI,CAAC,MAAM;UACR,MAAMP,aAAa,GAAG,IAAI,CAACR,YAAY,CAACE,MAAM,CAAC;UAC/C,IAAIM,aAAa,EAAEA,aAAa,CAACJ,QAAQ,GAAG,KAAK;;UAEjD;UACA;QACJ,CAAC,CAAC;MACV,CAAC,MAAMI,aAAa,CAACC,WAAW,CAACI,OAAO,CAAC,CAAC;MAE1C,IAAI,CAACL,aAAa,CAACG,SAAS,CAACC,SAAS,CAAC,CAAC,EAAE;QACtCJ,aAAa,CAACG,SAAS,CAClBE,OAAO,CAAC,CAAC,CACTC,QAAQ,CAAC,CAAC,CACVC,IAAI,CAAC,MAAM;UACR,IAAI,CAACd,aAAa,CAACC,MAAM,EAAEC,QAAQ,EAAE,KAAK,CAAC;QAC/C,CAAC,CAAC;MACV,CAAC,MAAMK,aAAa,CAACG,SAAS,CAACE,OAAO,CAAC,CAAC;IAC5C;IAEA,IAAI,CAACjB,OAAO,CAACoB,MAAM,EAAEC,UAAU,CAACf,MAAM,EAAEE,QAAQ,EAAEX,qBAAqB,CAAC;EAC5E;AACJ;AAACyB,OAAA,CAAApB,OAAA,GAAAJ,WAAA","ignoreList":[]}