@textrp/briij-js-sdk 41.0.0

package/lib/crypto/store/memory-crypto-store.js

@@ -0,0 +1,311 @@
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+/*
+Copyright 2017 - 2021 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import { safeSet } from "../../utils.js";
+import { MigrationState, SESSION_BATCH_SIZE } from "./base.js";
+function encodeSessionKey(senderCurve25519Key, sessionId) {
+  return encodeURIComponent(senderCurve25519Key) + "/" + encodeURIComponent(sessionId);
+}
+function decodeSessionKey(key) {
+  var keyParts = key.split("/");
+  var senderKey = decodeURIComponent(keyParts[0]);
+  var sessionId = decodeURIComponent(keyParts[1]);
+  return {
+    senderKey,
+    sessionId
+  };
+}
+
+/**
+ * Internal module. in-memory storage for e2e.
+ */
+
+export class MemoryCryptoStore {
+  constructor() {
+    _defineProperty(this, "migrationState", MigrationState.NOT_STARTED);
+    _defineProperty(this, "account", null);
+    _defineProperty(this, "crossSigningKeys", null);
+    _defineProperty(this, "privateKeys", {});
+    _defineProperty(this, "sessions", {});
+    _defineProperty(this, "inboundGroupSessions", {});
+    _defineProperty(this, "inboundGroupSessionsWithheld", {});
+    // Opaque device data object
+    _defineProperty(this, "rooms", {});
+    _defineProperty(this, "sessionsNeedingBackup", {});
+  }
+  /**
+   * Returns true if this CryptoStore has ever been initialised (ie, it might contain data).
+   *
+   * Implementation of {@link CryptoStore.containsData}.
+   *
+   * @internal
+   */
+  containsData() {
+    var _this = this;
+    return _asyncToGenerator(function* () {
+      // If it contains anything, it should contain an account.
+      return _this.account !== null;
+    })();
+  }
+
+  /**
+   * Ensure the database exists and is up-to-date.
+   *
+   * This must be called before the store can be used.
+   *
+   * @returns resolves to the store.
+   */
+  startup() {
+    var _this2 = this;
+    return _asyncToGenerator(function* () {
+      // No startup work to do for the memory store.
+      return _this2;
+    })();
+  }
+
+  /**
+   * Delete all data from this store.
+   *
+   * @returns Promise which resolves when the store has been cleared.
+   */
+  deleteAllData() {
+    return Promise.resolve();
+  }
+
+  /**
+   * Get data on how much of the libolm to Rust Crypto migration has been done.
+   *
+   * Implementation of {@link CryptoStore.getMigrationState}.
+   *
+   * @internal
+   */
+  getMigrationState() {
+    var _this3 = this;
+    return _asyncToGenerator(function* () {
+      return _this3.migrationState;
+    })();
+  }
+
+  /**
+   * Set data on how much of the libolm to Rust Crypto migration has been done.
+   *
+   * Implementation of {@link CryptoStore.setMigrationState}.
+   *
+   * @internal
+   */
+  setMigrationState(migrationState) {
+    var _this4 = this;
+    return _asyncToGenerator(function* () {
+      _this4.migrationState = migrationState;
+    })();
+  }
+
+  // Olm Account
+
+  getAccount(txn, func) {
+    func(this.account);
+  }
+  storeAccount(txn, accountPickle) {
+    this.account = accountPickle;
+  }
+  getCrossSigningKeys(txn, func) {
+    func(this.crossSigningKeys);
+  }
+  getSecretStorePrivateKey(txn, func, type) {
+    var result = this.privateKeys[type];
+    func(result || null);
+  }
+  storeSecretStorePrivateKey(txn, type, key) {
+    this.privateKeys[type] = key;
+  }
+
+  // Olm Sessions
+
+  countEndToEndSessions(txn, func) {
+    var count = 0;
+    for (var deviceSessions of Object.values(this.sessions)) {
+      count += Object.keys(deviceSessions).length;
+    }
+    func(count);
+  }
+  getEndToEndSession(deviceKey, sessionId, txn, func) {
+    var deviceSessions = this.sessions[deviceKey] || {};
+    func(deviceSessions[sessionId] || null);
+  }
+  getEndToEndSessions(deviceKey, txn, func) {
+    func(this.sessions[deviceKey] || {});
+  }
+  storeEndToEndSession(deviceKey, sessionId, sessionInfo, txn) {
+    var deviceSessions = this.sessions[deviceKey];
+    if (deviceSessions === undefined) {
+      deviceSessions = {};
+      this.sessions[deviceKey] = deviceSessions;
+    }
+    safeSet(deviceSessions, sessionId, sessionInfo);
+  }
+
+  /**
+   * Fetch a batch of Olm sessions from the database.
+   *
+   * Implementation of {@link CryptoStore.getEndToEndSessionsBatch}.
+   *
+   * @internal
+   */
+  getEndToEndSessionsBatch() {
+    var _this5 = this;
+    return _asyncToGenerator(function* () {
+      var result = [];
+      for (var deviceSessions of Object.values(_this5.sessions)) {
+        for (var session of Object.values(deviceSessions)) {
+          result.push(session);
+          if (result.length >= SESSION_BATCH_SIZE) {
+            return result;
+          }
+        }
+      }
+      if (result.length === 0) {
+        // No sessions left.
+        return null;
+      }
+
+      // There are fewer sessions than the batch size; return the final batch of sessions.
+      return result;
+    })();
+  }
+
+  /**
+   * Delete a batch of Olm sessions from the database.
+   *
+   * Implementation of {@link CryptoStore.deleteEndToEndSessionsBatch}.
+   *
+   * @internal
+   */
+  deleteEndToEndSessionsBatch(sessions) {
+    var _this6 = this;
+    return _asyncToGenerator(function* () {
+      for (var {
+        deviceKey,
+        sessionId
+      } of sessions) {
+        var deviceSessions = _this6.sessions[deviceKey] || {};
+        delete deviceSessions[sessionId];
+        if (Object.keys(deviceSessions).length === 0) {
+          // No more sessions for this device.
+          delete _this6.sessions[deviceKey];
+        }
+      }
+    })();
+  }
+
+  // Inbound Group Sessions
+
+  getEndToEndInboundGroupSession(senderCurve25519Key, sessionId, txn, func) {
+    var k = encodeSessionKey(senderCurve25519Key, sessionId);
+    func(this.inboundGroupSessions[k] || null, this.inboundGroupSessionsWithheld[k] || null);
+  }
+  storeEndToEndInboundGroupSession(senderCurve25519Key, sessionId, sessionData, txn) {
+    var k = encodeSessionKey(senderCurve25519Key, sessionId);
+    this.inboundGroupSessions[k] = sessionData;
+  }
+
+  /**
+   * Count the number of Megolm sessions in the database.
+   *
+   * Implementation of {@link CryptoStore.countEndToEndInboundGroupSessions}.
+   *
+   * @internal
+   */
+  countEndToEndInboundGroupSessions() {
+    var _this7 = this;
+    return _asyncToGenerator(function* () {
+      return Object.keys(_this7.inboundGroupSessions).length;
+    })();
+  }
+
+  /**
+   * Fetch a batch of Megolm sessions from the database.
+   *
+   * Implementation of {@link CryptoStore.getEndToEndInboundGroupSessionsBatch}.
+   *
+   * @internal
+   */
+  getEndToEndInboundGroupSessionsBatch() {
+    var _this8 = this;
+    return _asyncToGenerator(function* () {
+      var result = [];
+      for (var [key, session] of Object.entries(_this8.inboundGroupSessions)) {
+        result.push(_objectSpread(_objectSpread({}, decodeSessionKey(key)), {}, {
+          sessionData: session,
+          needsBackup: key in _this8.sessionsNeedingBackup
+        }));
+        if (result.length >= SESSION_BATCH_SIZE) {
+          return result;
+        }
+      }
+      if (result.length === 0) {
+        // No sessions left.
+        return null;
+      }
+
+      // There are fewer sessions than the batch size; return the final batch of sessions.
+      return result;
+    })();
+  }
+
+  /**
+   * Delete a batch of Megolm sessions from the database.
+   *
+   * Implementation of {@link CryptoStore.deleteEndToEndInboundGroupSessionsBatch}.
+   *
+   * @internal
+   */
+  deleteEndToEndInboundGroupSessionsBatch(sessions) {
+    var _this9 = this;
+    return _asyncToGenerator(function* () {
+      for (var {
+        senderKey,
+        sessionId
+      } of sessions) {
+        var k = encodeSessionKey(senderKey, sessionId);
+        delete _this9.inboundGroupSessions[k];
+      }
+    })();
+  }
+
+  // E2E rooms
+
+  getEndToEndRooms(txn, func) {
+    func(this.rooms);
+  }
+  markSessionsNeedingBackup(sessions) {
+    for (var session of sessions) {
+      var sessionKey = encodeSessionKey(session.senderKey, session.sessionId);
+      this.sessionsNeedingBackup[sessionKey] = true;
+    }
+    return Promise.resolve();
+  }
+
+  // Session key backups
+
+  doTxn(mode, stores, func) {
+    return Promise.resolve(func(null));
+  }
+}
+//# sourceMappingURL=memory-crypto-store.js.map

package/lib/crypto/store/memory-crypto-store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"memory-crypto-store.js","names":["safeSet","MigrationState","SESSION_BATCH_SIZE","encodeSessionKey","senderCurve25519Key","sessionId","encodeURIComponent","decodeSessionKey","key","keyParts","split","senderKey","decodeURIComponent","MemoryCryptoStore","constructor","_defineProperty","NOT_STARTED","containsData","_this","_asyncToGenerator","account","startup","_this2","deleteAllData","Promise","resolve","getMigrationState","_this3","migrationState","setMigrationState","_this4","getAccount","txn","func","storeAccount","accountPickle","getCrossSigningKeys","crossSigningKeys","getSecretStorePrivateKey","type","result","privateKeys","storeSecretStorePrivateKey","countEndToEndSessions","count","deviceSessions","Object","values","sessions","keys","length","getEndToEndSession","deviceKey","getEndToEndSessions","storeEndToEndSession","sessionInfo","undefined","getEndToEndSessionsBatch","_this5","session","push","deleteEndToEndSessionsBatch","_this6","getEndToEndInboundGroupSession","k","inboundGroupSessions","inboundGroupSessionsWithheld","storeEndToEndInboundGroupSession","sessionData","countEndToEndInboundGroupSessions","_this7","getEndToEndInboundGroupSessionsBatch","_this8","entries","_objectSpread","needsBackup","sessionsNeedingBackup","deleteEndToEndInboundGroupSessionsBatch","_this9","getEndToEndRooms","rooms","markSessionsNeedingBackup","sessionKey","doTxn","mode","stores"],"sources":["../../../src/crypto/store/memory-crypto-store.ts"],"sourcesContent":["/*\r\nCopyright 2017 - 2021 The Matrix.org Foundation C.I.C.\r\n\r\nLicensed under the Apache License, Version 2.0 (the \"License\");\r\nyou may not use this file except in compliance with the License.\r\nYou may obtain a copy of the License at\r\n\r\n    http://www.apache.org/licenses/LICENSE-2.0\r\n\r\nUnless required by applicable law or agreed to in writing, software\r\ndistributed under the License is distributed on an \"AS IS\" BASIS,\r\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r\nSee the License for the specific language governing permissions and\r\nlimitations under the License.\r\n*/\r\n\r\nimport { safeSet } from \"../../utils.ts\";\r\nimport {\r\n    type CryptoStore,\r\n    type ISession,\r\n    type SessionExtended,\r\n    type ISessionInfo,\r\n    type IWithheld,\r\n    MigrationState,\r\n    type Mode,\r\n    type SecretStorePrivateKeys,\r\n    SESSION_BATCH_SIZE,\r\n    type InboundGroupSessionData,\r\n    type IRoomEncryption,\r\n} from \"./base.ts\";\r\nimport { type CrossSigningKeyInfo } from \"../../crypto-api/index.ts\";\r\n\r\nfunction encodeSessionKey(senderCurve25519Key: string, sessionId: string): string {\r\n    return encodeURIComponent(senderCurve25519Key) + \"/\" + encodeURIComponent(sessionId);\r\n}\r\n\r\nfunction decodeSessionKey(key: string): { senderKey: string; sessionId: string } {\r\n    const keyParts = key.split(\"/\");\r\n    const senderKey = decodeURIComponent(keyParts[0]);\r\n    const sessionId = decodeURIComponent(keyParts[1]);\r\n    return { senderKey, sessionId };\r\n}\r\n\r\n/**\r\n * Internal module. in-memory storage for e2e.\r\n */\r\n\r\nexport class MemoryCryptoStore implements CryptoStore {\r\n    private migrationState: MigrationState = MigrationState.NOT_STARTED;\r\n    private account: string | null = null;\r\n    private crossSigningKeys: Record<string, CrossSigningKeyInfo> | null = null;\r\n    private privateKeys: Partial<SecretStorePrivateKeys> = {};\r\n\r\n    private sessions: { [deviceKey: string]: { [sessionId: string]: ISessionInfo } } = {};\r\n    private inboundGroupSessions: { [sessionKey: string]: InboundGroupSessionData } = {};\r\n    private inboundGroupSessionsWithheld: Record<string, IWithheld> = {};\r\n    // Opaque device data object\r\n    private rooms: { [roomId: string]: IRoomEncryption } = {};\r\n    private sessionsNeedingBackup: { [sessionKey: string]: boolean } = {};\r\n\r\n    /**\r\n     * Returns true if this CryptoStore has ever been initialised (ie, it might contain data).\r\n     *\r\n     * Implementation of {@link CryptoStore.containsData}.\r\n     *\r\n     * @internal\r\n     */\r\n    public async containsData(): Promise<boolean> {\r\n        // If it contains anything, it should contain an account.\r\n        return this.account !== null;\r\n    }\r\n\r\n    /**\r\n     * Ensure the database exists and is up-to-date.\r\n     *\r\n     * This must be called before the store can be used.\r\n     *\r\n     * @returns resolves to the store.\r\n     */\r\n    public async startup(): Promise<CryptoStore> {\r\n        // No startup work to do for the memory store.\r\n        return this;\r\n    }\r\n\r\n    /**\r\n     * Delete all data from this store.\r\n     *\r\n     * @returns Promise which resolves when the store has been cleared.\r\n     */\r\n    public deleteAllData(): Promise<void> {\r\n        return Promise.resolve();\r\n    }\r\n\r\n    /**\r\n     * Get data on how much of the libolm to Rust Crypto migration has been done.\r\n     *\r\n     * Implementation of {@link CryptoStore.getMigrationState}.\r\n     *\r\n     * @internal\r\n     */\r\n    public async getMigrationState(): Promise<MigrationState> {\r\n        return this.migrationState;\r\n    }\r\n\r\n    /**\r\n     * Set data on how much of the libolm to Rust Crypto migration has been done.\r\n     *\r\n     * Implementation of {@link CryptoStore.setMigrationState}.\r\n     *\r\n     * @internal\r\n     */\r\n    public async setMigrationState(migrationState: MigrationState): Promise<void> {\r\n        this.migrationState = migrationState;\r\n    }\r\n\r\n    // Olm Account\r\n\r\n    public getAccount(txn: unknown, func: (accountPickle: string | null) => void): void {\r\n        func(this.account);\r\n    }\r\n\r\n    public storeAccount(txn: unknown, accountPickle: string): void {\r\n        this.account = accountPickle;\r\n    }\r\n\r\n    public getCrossSigningKeys(txn: unknown, func: (keys: Record<string, CrossSigningKeyInfo> | null) => void): void {\r\n        func(this.crossSigningKeys);\r\n    }\r\n\r\n    public getSecretStorePrivateKey<K extends keyof SecretStorePrivateKeys>(\r\n        txn: unknown,\r\n        func: (key: SecretStorePrivateKeys[K] | null) => void,\r\n        type: K,\r\n    ): void {\r\n        const result = this.privateKeys[type] as SecretStorePrivateKeys[K] | undefined;\r\n        func(result || null);\r\n    }\r\n\r\n    public storeSecretStorePrivateKey<K extends keyof SecretStorePrivateKeys>(\r\n        txn: unknown,\r\n        type: K,\r\n        key: SecretStorePrivateKeys[K],\r\n    ): void {\r\n        this.privateKeys[type] = key;\r\n    }\r\n\r\n    // Olm Sessions\r\n\r\n    public countEndToEndSessions(txn: unknown, func: (count: number) => void): void {\r\n        let count = 0;\r\n        for (const deviceSessions of Object.values(this.sessions)) {\r\n            count += Object.keys(deviceSessions).length;\r\n        }\r\n        func(count);\r\n    }\r\n\r\n    public getEndToEndSession(\r\n        deviceKey: string,\r\n        sessionId: string,\r\n        txn: unknown,\r\n        func: (session: ISessionInfo) => void,\r\n    ): void {\r\n        const deviceSessions = this.sessions[deviceKey] || {};\r\n        func(deviceSessions[sessionId] || null);\r\n    }\r\n\r\n    public getEndToEndSessions(\r\n        deviceKey: string,\r\n        txn: unknown,\r\n        func: (sessions: { [sessionId: string]: ISessionInfo }) => void,\r\n    ): void {\r\n        func(this.sessions[deviceKey] || {});\r\n    }\r\n\r\n    public storeEndToEndSession(deviceKey: string, sessionId: string, sessionInfo: ISessionInfo, txn: unknown): void {\r\n        let deviceSessions = this.sessions[deviceKey];\r\n        if (deviceSessions === undefined) {\r\n            deviceSessions = {};\r\n            this.sessions[deviceKey] = deviceSessions;\r\n        }\r\n        safeSet(deviceSessions, sessionId, sessionInfo);\r\n    }\r\n\r\n    /**\r\n     * Fetch a batch of Olm sessions from the database.\r\n     *\r\n     * Implementation of {@link CryptoStore.getEndToEndSessionsBatch}.\r\n     *\r\n     * @internal\r\n     */\r\n    public async getEndToEndSessionsBatch(): Promise<null | ISessionInfo[]> {\r\n        const result: ISessionInfo[] = [];\r\n        for (const deviceSessions of Object.values(this.sessions)) {\r\n            for (const session of Object.values(deviceSessions)) {\r\n                result.push(session);\r\n                if (result.length >= SESSION_BATCH_SIZE) {\r\n                    return result;\r\n                }\r\n            }\r\n        }\r\n\r\n        if (result.length === 0) {\r\n            // No sessions left.\r\n            return null;\r\n        }\r\n\r\n        // There are fewer sessions than the batch size; return the final batch of sessions.\r\n        return result;\r\n    }\r\n\r\n    /**\r\n     * Delete a batch of Olm sessions from the database.\r\n     *\r\n     * Implementation of {@link CryptoStore.deleteEndToEndSessionsBatch}.\r\n     *\r\n     * @internal\r\n     */\r\n    public async deleteEndToEndSessionsBatch(sessions: { deviceKey: string; sessionId: string }[]): Promise<void> {\r\n        for (const { deviceKey, sessionId } of sessions) {\r\n            const deviceSessions = this.sessions[deviceKey] || {};\r\n            delete deviceSessions[sessionId];\r\n            if (Object.keys(deviceSessions).length === 0) {\r\n                // No more sessions for this device.\r\n                delete this.sessions[deviceKey];\r\n            }\r\n        }\r\n    }\r\n\r\n    // Inbound Group Sessions\r\n\r\n    public getEndToEndInboundGroupSession(\r\n        senderCurve25519Key: string,\r\n        sessionId: string,\r\n        txn: unknown,\r\n        func: (groupSession: InboundGroupSessionData | null, groupSessionWithheld: IWithheld | null) => void,\r\n    ): void {\r\n        const k = encodeSessionKey(senderCurve25519Key, sessionId);\r\n        func(this.inboundGroupSessions[k] || null, this.inboundGroupSessionsWithheld[k] || null);\r\n    }\r\n\r\n    public storeEndToEndInboundGroupSession(\r\n        senderCurve25519Key: string,\r\n        sessionId: string,\r\n        sessionData: InboundGroupSessionData,\r\n        txn: unknown,\r\n    ): void {\r\n        const k = encodeSessionKey(senderCurve25519Key, sessionId);\r\n        this.inboundGroupSessions[k] = sessionData;\r\n    }\r\n\r\n    /**\r\n     * Count the number of Megolm sessions in the database.\r\n     *\r\n     * Implementation of {@link CryptoStore.countEndToEndInboundGroupSessions}.\r\n     *\r\n     * @internal\r\n     */\r\n    public async countEndToEndInboundGroupSessions(): Promise<number> {\r\n        return Object.keys(this.inboundGroupSessions).length;\r\n    }\r\n\r\n    /**\r\n     * Fetch a batch of Megolm sessions from the database.\r\n     *\r\n     * Implementation of {@link CryptoStore.getEndToEndInboundGroupSessionsBatch}.\r\n     *\r\n     * @internal\r\n     */\r\n    public async getEndToEndInboundGroupSessionsBatch(): Promise<null | SessionExtended[]> {\r\n        const result: SessionExtended[] = [];\r\n        for (const [key, session] of Object.entries(this.inboundGroupSessions)) {\r\n            result.push({\r\n                ...decodeSessionKey(key),\r\n                sessionData: session,\r\n                needsBackup: key in this.sessionsNeedingBackup,\r\n            });\r\n            if (result.length >= SESSION_BATCH_SIZE) {\r\n                return result;\r\n            }\r\n        }\r\n\r\n        if (result.length === 0) {\r\n            // No sessions left.\r\n            return null;\r\n        }\r\n\r\n        // There are fewer sessions than the batch size; return the final batch of sessions.\r\n        return result;\r\n    }\r\n\r\n    /**\r\n     * Delete a batch of Megolm sessions from the database.\r\n     *\r\n     * Implementation of {@link CryptoStore.deleteEndToEndInboundGroupSessionsBatch}.\r\n     *\r\n     * @internal\r\n     */\r\n    public async deleteEndToEndInboundGroupSessionsBatch(\r\n        sessions: { senderKey: string; sessionId: string }[],\r\n    ): Promise<void> {\r\n        for (const { senderKey, sessionId } of sessions) {\r\n            const k = encodeSessionKey(senderKey, sessionId);\r\n            delete this.inboundGroupSessions[k];\r\n        }\r\n    }\r\n\r\n    // E2E rooms\r\n\r\n    public getEndToEndRooms(txn: unknown, func: (rooms: Record<string, IRoomEncryption>) => void): void {\r\n        func(this.rooms);\r\n    }\r\n\r\n    public markSessionsNeedingBackup(sessions: ISession[]): Promise<void> {\r\n        for (const session of sessions) {\r\n            const sessionKey = encodeSessionKey(session.senderKey, session.sessionId);\r\n            this.sessionsNeedingBackup[sessionKey] = true;\r\n        }\r\n        return Promise.resolve();\r\n    }\r\n\r\n    // Session key backups\r\n\r\n    public doTxn<T>(mode: Mode, stores: Iterable<string>, func: (txn?: unknown) => T): Promise<T> {\r\n        return Promise.resolve(func(null));\r\n    }\r\n}\r\n"],"mappings":";;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,OAAO,QAAQ,gBAAgB;AACxC,SAMIC,cAAc,EAGdC,kBAAkB,QAGf,WAAW;AAGlB,SAASC,gBAAgBA,CAACC,mBAA2B,EAAEC,SAAiB,EAAU;EAC9E,OAAOC,kBAAkB,CAACF,mBAAmB,CAAC,GAAG,GAAG,GAAGE,kBAAkB,CAACD,SAAS,CAAC;AACxF;AAEA,SAASE,gBAAgBA,CAACC,GAAW,EAA4C;EAC7E,IAAMC,QAAQ,GAAGD,GAAG,CAACE,KAAK,CAAC,GAAG,CAAC;EAC/B,IAAMC,SAAS,GAAGC,kBAAkB,CAACH,QAAQ,CAAC,CAAC,CAAC,CAAC;EACjD,IAAMJ,SAAS,GAAGO,kBAAkB,CAACH,QAAQ,CAAC,CAAC,CAAC,CAAC;EACjD,OAAO;IAAEE,SAAS;IAAEN;EAAU,CAAC;AACnC;;AAEA;AACA;AACA;;AAEA,OAAO,MAAMQ,iBAAiB,CAAwB;EAAAC,YAAA;IAAAC,eAAA,yBACTd,cAAc,CAACe,WAAW;IAAAD,eAAA,kBAClC,IAAI;IAAAA,eAAA,2BACkC,IAAI;IAAAA,eAAA,sBACpB,CAAC,CAAC;IAAAA,eAAA,mBAE0B,CAAC,CAAC;IAAAA,eAAA,+BACH,CAAC,CAAC;IAAAA,eAAA,uCAClB,CAAC,CAAC;IACpE;IAAAA,eAAA,gBACuD,CAAC,CAAC;IAAAA,eAAA,gCACU,CAAC,CAAC;EAAA;EAErE;AACJ;AACA;AACA;AACA;AACA;AACA;EACiBE,YAAYA,CAAA,EAAqB;IAAA,IAAAC,KAAA;IAAA,OAAAC,iBAAA;MAC1C;MACA,OAAOD,KAAI,CAACE,OAAO,KAAK,IAAI;IAAC;EACjC;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;EACiBC,OAAOA,CAAA,EAAyB;IAAA,IAAAC,MAAA;IAAA,OAAAH,iBAAA;MACzC;MACA,OAAOG,MAAI;IAAC;EAChB;;EAEA;AACJ;AACA;AACA;AACA;EACWC,aAAaA,CAAA,EAAkB;IAClC,OAAOC,OAAO,CAACC,OAAO,CAAC,CAAC;EAC5B;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;EACiBC,iBAAiBA,CAAA,EAA4B;IAAA,IAAAC,MAAA;IAAA,OAAAR,iBAAA;MACtD,OAAOQ,MAAI,CAACC,cAAc;IAAC;EAC/B;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;EACiBC,iBAAiBA,CAACD,cAA8B,EAAiB;IAAA,IAAAE,MAAA;IAAA,OAAAX,iBAAA;MAC1EW,MAAI,CAACF,cAAc,GAAGA,cAAc;IAAC;EACzC;;EAEA;;EAEOG,UAAUA,CAACC,GAAY,EAAEC,IAA4C,EAAQ;IAChFA,IAAI,CAAC,IAAI,CAACb,OAAO,CAAC;EACtB;EAEOc,YAAYA,CAACF,GAAY,EAAEG,aAAqB,EAAQ;IAC3D,IAAI,CAACf,OAAO,GAAGe,aAAa;EAChC;EAEOC,mBAAmBA,CAACJ,GAAY,EAAEC,IAAgE,EAAQ;IAC7GA,IAAI,CAAC,IAAI,CAACI,gBAAgB,CAAC;EAC/B;EAEOC,wBAAwBA,CAC3BN,GAAY,EACZC,IAAqD,EACrDM,IAAO,EACH;IACJ,IAAMC,MAAM,GAAG,IAAI,CAACC,WAAW,CAACF,IAAI,CAA0C;IAC9EN,IAAI,CAACO,MAAM,IAAI,IAAI,CAAC;EACxB;EAEOE,0BAA0BA,CAC7BV,GAAY,EACZO,IAAO,EACP/B,GAA8B,EAC1B;IACJ,IAAI,CAACiC,WAAW,CAACF,IAAI,CAAC,GAAG/B,GAAG;EAChC;;EAEA;;EAEOmC,qBAAqBA,CAACX,GAAY,EAAEC,IAA6B,EAAQ;IAC5E,IAAIW,KAAK,GAAG,CAAC;IACb,KAAK,IAAMC,cAAc,IAAIC,MAAM,CAACC,MAAM,CAAC,IAAI,CAACC,QAAQ,CAAC,EAAE;MACvDJ,KAAK,IAAIE,MAAM,CAACG,IAAI,CAACJ,cAAc,CAAC,CAACK,MAAM;IAC/C;IACAjB,IAAI,CAACW,KAAK,CAAC;EACf;EAEOO,kBAAkBA,CACrBC,SAAiB,EACjB/C,SAAiB,EACjB2B,GAAY,EACZC,IAAqC,EACjC;IACJ,IAAMY,cAAc,GAAG,IAAI,CAACG,QAAQ,CAACI,SAAS,CAAC,IAAI,CAAC,CAAC;IACrDnB,IAAI,CAACY,cAAc,CAACxC,SAAS,CAAC,IAAI,IAAI,CAAC;EAC3C;EAEOgD,mBAAmBA,CACtBD,SAAiB,EACjBpB,GAAY,EACZC,IAA+D,EAC3D;IACJA,IAAI,CAAC,IAAI,CAACe,QAAQ,CAACI,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;EACxC;EAEOE,oBAAoBA,CAACF,SAAiB,EAAE/C,SAAiB,EAAEkD,WAAyB,EAAEvB,GAAY,EAAQ;IAC7G,IAAIa,cAAc,GAAG,IAAI,CAACG,QAAQ,CAACI,SAAS,CAAC;IAC7C,IAAIP,cAAc,KAAKW,SAAS,EAAE;MAC9BX,cAAc,GAAG,CAAC,CAAC;MACnB,IAAI,CAACG,QAAQ,CAACI,SAAS,CAAC,GAAGP,cAAc;IAC7C;IACA7C,OAAO,CAAC6C,cAAc,EAAExC,SAAS,EAAEkD,WAAW,CAAC;EACnD;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;EACiBE,wBAAwBA,CAAA,EAAmC;IAAA,IAAAC,MAAA;IAAA,OAAAvC,iBAAA;MACpE,IAAMqB,MAAsB,GAAG,EAAE;MACjC,KAAK,IAAMK,cAAc,IAAIC,MAAM,CAACC,MAAM,CAACW,MAAI,CAACV,QAAQ,CAAC,EAAE;QACvD,KAAK,IAAMW,OAAO,IAAIb,MAAM,CAACC,MAAM,CAACF,cAAc,CAAC,EAAE;UACjDL,MAAM,CAACoB,IAAI,CAACD,OAAO,CAAC;UACpB,IAAInB,MAAM,CAACU,MAAM,IAAIhD,kBAAkB,EAAE;YACrC,OAAOsC,MAAM;UACjB;QACJ;MACJ;MAEA,IAAIA,MAAM,CAACU,MAAM,KAAK,CAAC,EAAE;QACrB;QACA,OAAO,IAAI;MACf;;MAEA;MACA,OAAOV,MAAM;IAAC;EAClB;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;EACiBqB,2BAA2BA,CAACb,QAAoD,EAAiB;IAAA,IAAAc,MAAA;IAAA,OAAA3C,iBAAA;MAC1G,KAAK,IAAM;QAAEiC,SAAS;QAAE/C;MAAU,CAAC,IAAI2C,QAAQ,EAAE;QAC7C,IAAMH,cAAc,GAAGiB,MAAI,CAACd,QAAQ,CAACI,SAAS,CAAC,IAAI,CAAC,CAAC;QACrD,OAAOP,cAAc,CAACxC,SAAS,CAAC;QAChC,IAAIyC,MAAM,CAACG,IAAI,CAACJ,cAAc,CAAC,CAACK,MAAM,KAAK,CAAC,EAAE;UAC1C;UACA,OAAOY,MAAI,CAACd,QAAQ,CAACI,SAAS,CAAC;QACnC;MACJ;IAAC;EACL;;EAEA;;EAEOW,8BAA8BA,CACjC3D,mBAA2B,EAC3BC,SAAiB,EACjB2B,GAAY,EACZC,IAAoG,EAChG;IACJ,IAAM+B,CAAC,GAAG7D,gBAAgB,CAACC,mBAAmB,EAAEC,SAAS,CAAC;IAC1D4B,IAAI,CAAC,IAAI,CAACgC,oBAAoB,CAACD,CAAC,CAAC,IAAI,IAAI,EAAE,IAAI,CAACE,4BAA4B,CAACF,CAAC,CAAC,IAAI,IAAI,CAAC;EAC5F;EAEOG,gCAAgCA,CACnC/D,mBAA2B,EAC3BC,SAAiB,EACjB+D,WAAoC,EACpCpC,GAAY,EACR;IACJ,IAAMgC,CAAC,GAAG7D,gBAAgB,CAACC,mBAAmB,EAAEC,SAAS,CAAC;IAC1D,IAAI,CAAC4D,oBAAoB,CAACD,CAAC,CAAC,GAAGI,WAAW;EAC9C;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;EACiBC,iCAAiCA,CAAA,EAAoB;IAAA,IAAAC,MAAA;IAAA,OAAAnD,iBAAA;MAC9D,OAAO2B,MAAM,CAACG,IAAI,CAACqB,MAAI,CAACL,oBAAoB,CAAC,CAACf,MAAM;IAAC;EACzD;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;EACiBqB,oCAAoCA,CAAA,EAAsC;IAAA,IAAAC,MAAA;IAAA,OAAArD,iBAAA;MACnF,IAAMqB,MAAyB,GAAG,EAAE;MACpC,KAAK,IAAM,CAAChC,GAAG,EAAEmD,OAAO,CAAC,IAAIb,MAAM,CAAC2B,OAAO,CAACD,MAAI,CAACP,oBAAoB,CAAC,EAAE;QACpEzB,MAAM,CAACoB,IAAI,CAAAc,aAAA,CAAAA,aAAA,KACJnE,gBAAgB,CAACC,GAAG,CAAC;UACxB4D,WAAW,EAAET,OAAO;UACpBgB,WAAW,EAAEnE,GAAG,IAAIgE,MAAI,CAACI;QAAqB,EACjD,CAAC;QACF,IAAIpC,MAAM,CAACU,MAAM,IAAIhD,kBAAkB,EAAE;UACrC,OAAOsC,MAAM;QACjB;MACJ;MAEA,IAAIA,MAAM,CAACU,MAAM,KAAK,CAAC,EAAE;QACrB;QACA,OAAO,IAAI;MACf;;MAEA;MACA,OAAOV,MAAM;IAAC;EAClB;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;EACiBqC,uCAAuCA,CAChD7B,QAAoD,EACvC;IAAA,IAAA8B,MAAA;IAAA,OAAA3D,iBAAA;MACb,KAAK,IAAM;QAAER,SAAS;QAAEN;MAAU,CAAC,IAAI2C,QAAQ,EAAE;QAC7C,IAAMgB,CAAC,GAAG7D,gBAAgB,CAACQ,SAAS,EAAEN,SAAS,CAAC;QAChD,OAAOyE,MAAI,CAACb,oBAAoB,CAACD,CAAC,CAAC;MACvC;IAAC;EACL;;EAEA;;EAEOe,gBAAgBA,CAAC/C,GAAY,EAAEC,IAAsD,EAAQ;IAChGA,IAAI,CAAC,IAAI,CAAC+C,KAAK,CAAC;EACpB;EAEOC,yBAAyBA,CAACjC,QAAoB,EAAiB;IAClE,KAAK,IAAMW,OAAO,IAAIX,QAAQ,EAAE;MAC5B,IAAMkC,UAAU,GAAG/E,gBAAgB,CAACwD,OAAO,CAAChD,SAAS,EAAEgD,OAAO,CAACtD,SAAS,CAAC;MACzE,IAAI,CAACuE,qBAAqB,CAACM,UAAU,CAAC,GAAG,IAAI;IACjD;IACA,OAAO1D,OAAO,CAACC,OAAO,CAAC,CAAC;EAC5B;;EAEA;;EAEO0D,KAAKA,CAAIC,IAAU,EAAEC,MAAwB,EAAEpD,IAA0B,EAAc;IAC1F,OAAOT,OAAO,CAACC,OAAO,CAACQ,IAAI,CAAC,IAAI,CAAC,CAAC;EACtC;AACJ","ignoreList":[]}

package/lib/crypto-api/CryptoEvent.d.ts

@@ -0,0 +1,120 @@
+/**
+ * Cryptography-related events emitted by the {@link briij.BriijClient}.
+ */
+export declare enum CryptoEvent {
+    /**
+     * Fires when the trust status of a user changes.
+     * The payload is a pair (userId, userTrustLevel). The trust level is one of the values from UserVerificationStatus.
+     */
+    UserTrustStatusChanged = "userTrustStatusChanged",
+    /**
+     * Fires when the key backup status changes.
+     * The payload is a boolean indicating whether the key backup is enabled.
+     */
+    KeyBackupStatus = "crypto.keyBackupStatus",
+    /**
+     * Fires when we failed to back up the keys
+     * The payload is the error code of the error that occurred.
+     */
+    KeyBackupFailed = "crypto.keyBackupFailed",
+    /**
+     * Fires when the number of sessions that can be backed up changes.
+     * The payload is the remaining number of sessions that can be backed up.
+     */
+    KeyBackupSessionsRemaining = "crypto.keyBackupSessionsRemaining",
+    /**
+     * Fires when a new valid backup decryption key is in cache.
+     * This will happen when a secret is received from another session, from secret storage,
+     * or when a new backup is created from this session.
+     *
+     * The payload is the version of the backup for which we have the key for.
+     *
+     * This event is only fired by the rust crypto backend.
+     */
+    KeyBackupDecryptionKeyCached = "crypto.keyBackupDecryptionKeyCached",
+    /**
+     * Fires when a key verification request is received.
+     * The payload is a VerificationRequest object representing the request.
+     */
+    VerificationRequestReceived = "crypto.verificationRequestReceived",
+    /** @deprecated Use {@link DevicesUpdated} instead when using rust crypto */
+    WillUpdateDevices = "crypto.willUpdateDevices",
+    /**
+     * Fires whenever the stored devices for a user have been updated
+     * The payload is a pair (userIds, initialFetch).
+     */
+    DevicesUpdated = "crypto.devicesUpdated",
+    /**
+     * Fires when the user's cross-signing keys have changed or cross-signing
+     * has been enabled/disabled. The client can use getStoredCrossSigningForUser
+     * with the user ID of the logged in user to check if cross-signing is
+     * enabled on the account. If enabled, it can test whether the current key
+     * is trusted using with checkUserTrust with the user ID of the logged
+     * in user. The checkOwnCrossSigningTrust function may be used to reconcile
+     * the trust in the account key.
+     *
+     * The cross-signing API is currently UNSTABLE and may change without notice.
+     * @experimental
+     */
+    KeysChanged = "crossSigning.keysChanged",
+    /**
+     * Fires when data is being migrated from legacy crypto to rust crypto.
+     *
+     * The payload is a pair `(progress, total)`, where `progress` is the number of steps completed so far, and
+     * `total` is the total number of steps. When migration is complete, a final instance of the event is emitted, with
+     * `progress === total === -1`.
+     */
+    LegacyCryptoStoreMigrationProgress = "crypto.legacyCryptoStoreMigrationProgress",
+    /**
+     * Fires when a new dehydrated device is created locally.
+     *
+     * After the client calls {@link CryptoApi.startDehydration}, this event
+     * will be fired every time a new dehydrated device is created.  It may fire
+     * before `startDehydration` returns.
+     */
+    DehydratedDeviceCreated = "dehydration.DehydratedDeviceCreated",
+    /**
+     * Fires when a new dehydrated device is successfully uploaded to the server.
+     *
+     * This should fire shortly after {@link DehydratedDeviceCreated} fires. If
+     * upload is unsuccessful, this will be reported either by an error thrown
+     * by {@link CryptoApi.startDehydration} (for errors that happen before
+     * `startDehydration` returns), or by firing {@link DehydratedDeviceRotationError}
+     * (for errors that happen during regular rotation of the dehydrated device)
+     */
+    DehydratedDeviceUploaded = "dehydration.DehydratedDeviceUploaded",
+    /**
+     * Fires when rehydration has started.
+     *
+     * After the client calls {@link CryptoApi.startDehydration}, this event will
+     * fire if a dehydrated device is found and we attempt to rehydrate it.
+     */
+    RehydrationStarted = "dehydration.RehydrationStarted",
+    /**
+     * Fires during rehydration, to inform the application of rehydration progress.
+     *
+     * The payload is a pair `[roomKeyCount: number, toDeviceCount: number]`,
+     * where `roomKeyCount` is the number of room keys that have been received
+     * so far, and `toDeviceCount` is the number of to-device messages received
+     * so far (including the messages containing room keys).
+     */
+    RehydrationProgress = "dehydration.RehydrationProgress",
+    /** Fires when rehydration has completed successfully. */
+    RehydrationCompleted = "dehydration.RehydrationCompleted",
+    /** Fires when there was an error in rehydration.
+     *
+     * The payload is an error message as a string.
+     */
+    RehydrationError = "dehydration.RehydrationError",
+    /**
+     * Fires when a dehydrated device key has been cached in the local database.
+     */
+    DehydrationKeyCached = "dehydration.DehydrationKeyCached",
+    /**
+     * Fires when an error occurs during periodic rotation of the dehydrated device.
+     *
+     * The payload is an error message as a string.
+     */
+    DehydratedDeviceRotationError = "dehydration.DehydratedDeviceRotationError"
+}
+//# sourceMappingURL=CryptoEvent.d.ts.map

package/lib/crypto-api/CryptoEvent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CryptoEvent.d.ts","sourceRoot":"","sources":["../../src/crypto-api/CryptoEvent.ts"],"names":[],"mappings":"AAgBA;;GAEG;AACH,oBAAY,WAAW;IACnB;;;OAGG;IACH,sBAAsB,2BAA2B;IAEjD;;;OAGG;IACH,eAAe,2BAA2B;IAE1C;;;OAGG;IACH,eAAe,2BAA2B;IAE1C;;;OAGG;IACH,0BAA0B,sCAAsC;IAEhE;;;;;;;;OAQG;IACH,4BAA4B,wCAAwC;IAEpE;;;OAGG;IACH,2BAA2B,uCAAuC;IAElE,4EAA4E;IAC5E,iBAAiB,6BAA6B;IAE9C;;;OAGG;IACH,cAAc,0BAA0B;IAExC;;;;;;;;;;;OAWG;IACH,WAAW,6BAA6B;IAExC;;;;;;OAMG;IACH,kCAAkC,8CAA8C;IAEhF;;;;;;OAMG;IACH,uBAAuB,wCAAwC;IAE/D;;;;;;;;OAQG;IACH,wBAAwB,yCAAyC;IAEjE;;;;;OAKG;IACH,kBAAkB,mCAAmC;IAErD;;;;;;;OAOG;IACH,mBAAmB,oCAAoC;IAEvD,yDAAyD;IACzD,oBAAoB,qCAAqC;IAEzD;;;OAGG;IACH,gBAAgB,iCAAiC;IAEjD;;OAEG;IACH,oBAAoB,qCAAqC;IAEzD;;;;OAIG;IACH,6BAA6B,8CAA8C;CAC9E"}

package/lib/crypto-api/CryptoEvent.js

@@ -0,0 +1,137 @@
+/*
+ * Copyright 2024 The Matrix.org Foundation C.I.C.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Cryptography-related events emitted by the {@link briij.BriijClient}.
+ */
+export var CryptoEvent = /*#__PURE__*/function (CryptoEvent) {
+  /**
+   * Fires when the trust status of a user changes.
+   * The payload is a pair (userId, userTrustLevel). The trust level is one of the values from UserVerificationStatus.
+   */
+  CryptoEvent["UserTrustStatusChanged"] = "userTrustStatusChanged";
+  /**
+   * Fires when the key backup status changes.
+   * The payload is a boolean indicating whether the key backup is enabled.
+   */
+  CryptoEvent["KeyBackupStatus"] = "crypto.keyBackupStatus";
+  /**
+   * Fires when we failed to back up the keys
+   * The payload is the error code of the error that occurred.
+   */
+  CryptoEvent["KeyBackupFailed"] = "crypto.keyBackupFailed";
+  /**
+   * Fires when the number of sessions that can be backed up changes.
+   * The payload is the remaining number of sessions that can be backed up.
+   */
+  CryptoEvent["KeyBackupSessionsRemaining"] = "crypto.keyBackupSessionsRemaining";
+  /**
+   * Fires when a new valid backup decryption key is in cache.
+   * This will happen when a secret is received from another session, from secret storage,
+   * or when a new backup is created from this session.
+   *
+   * The payload is the version of the backup for which we have the key for.
+   *
+   * This event is only fired by the rust crypto backend.
+   */
+  CryptoEvent["KeyBackupDecryptionKeyCached"] = "crypto.keyBackupDecryptionKeyCached";
+  /**
+   * Fires when a key verification request is received.
+   * The payload is a VerificationRequest object representing the request.
+   */
+  CryptoEvent["VerificationRequestReceived"] = "crypto.verificationRequestReceived";
+  /** @deprecated Use {@link DevicesUpdated} instead when using rust crypto */
+  CryptoEvent["WillUpdateDevices"] = "crypto.willUpdateDevices";
+  /**
+   * Fires whenever the stored devices for a user have been updated
+   * The payload is a pair (userIds, initialFetch).
+   */
+  CryptoEvent["DevicesUpdated"] = "crypto.devicesUpdated";
+  /**
+   * Fires when the user's cross-signing keys have changed or cross-signing
+   * has been enabled/disabled. The client can use getStoredCrossSigningForUser
+   * with the user ID of the logged in user to check if cross-signing is
+   * enabled on the account. If enabled, it can test whether the current key
+   * is trusted using with checkUserTrust with the user ID of the logged
+   * in user. The checkOwnCrossSigningTrust function may be used to reconcile
+   * the trust in the account key.
+   *
+   * The cross-signing API is currently UNSTABLE and may change without notice.
+   * @experimental
+   */
+  CryptoEvent["KeysChanged"] = "crossSigning.keysChanged";
+  /**
+   * Fires when data is being migrated from legacy crypto to rust crypto.
+   *
+   * The payload is a pair `(progress, total)`, where `progress` is the number of steps completed so far, and
+   * `total` is the total number of steps. When migration is complete, a final instance of the event is emitted, with
+   * `progress === total === -1`.
+   */
+  CryptoEvent["LegacyCryptoStoreMigrationProgress"] = "crypto.legacyCryptoStoreMigrationProgress";
+  /**
+   * Fires when a new dehydrated device is created locally.
+   *
+   * After the client calls {@link CryptoApi.startDehydration}, this event
+   * will be fired every time a new dehydrated device is created.  It may fire
+   * before `startDehydration` returns.
+   */
+  CryptoEvent["DehydratedDeviceCreated"] = "dehydration.DehydratedDeviceCreated";
+  /**
+   * Fires when a new dehydrated device is successfully uploaded to the server.
+   *
+   * This should fire shortly after {@link DehydratedDeviceCreated} fires. If
+   * upload is unsuccessful, this will be reported either by an error thrown
+   * by {@link CryptoApi.startDehydration} (for errors that happen before
+   * `startDehydration` returns), or by firing {@link DehydratedDeviceRotationError}
+   * (for errors that happen during regular rotation of the dehydrated device)
+   */
+  CryptoEvent["DehydratedDeviceUploaded"] = "dehydration.DehydratedDeviceUploaded";
+  /**
+   * Fires when rehydration has started.
+   *
+   * After the client calls {@link CryptoApi.startDehydration}, this event will
+   * fire if a dehydrated device is found and we attempt to rehydrate it.
+   */
+  CryptoEvent["RehydrationStarted"] = "dehydration.RehydrationStarted";
+  /**
+   * Fires during rehydration, to inform the application of rehydration progress.
+   *
+   * The payload is a pair `[roomKeyCount: number, toDeviceCount: number]`,
+   * where `roomKeyCount` is the number of room keys that have been received
+   * so far, and `toDeviceCount` is the number of to-device messages received
+   * so far (including the messages containing room keys).
+   */
+  CryptoEvent["RehydrationProgress"] = "dehydration.RehydrationProgress";
+  /** Fires when rehydration has completed successfully. */
+  CryptoEvent["RehydrationCompleted"] = "dehydration.RehydrationCompleted";
+  /** Fires when there was an error in rehydration.
+   *
+   * The payload is an error message as a string.
+   */
+  CryptoEvent["RehydrationError"] = "dehydration.RehydrationError";
+  /**
+   * Fires when a dehydrated device key has been cached in the local database.
+   */
+  CryptoEvent["DehydrationKeyCached"] = "dehydration.DehydrationKeyCached";
+  /**
+   * Fires when an error occurs during periodic rotation of the dehydrated device.
+   *
+   * The payload is an error message as a string.
+   */
+  CryptoEvent["DehydratedDeviceRotationError"] = "dehydration.DehydratedDeviceRotationError";
+  return CryptoEvent;
+}({});
+//# sourceMappingURL=CryptoEvent.js.map

package/lib/crypto-api/CryptoEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CryptoEvent.js","names":["CryptoEvent"],"sources":["../../src/crypto-api/CryptoEvent.ts"],"sourcesContent":["/*\n * Copyright 2024 The Matrix.org Foundation C.I.C.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/**\n * Cryptography-related events emitted by the {@link briij.BriijClient}.\n */\nexport enum CryptoEvent {\n    /**\n     * Fires when the trust status of a user changes.\n     * The payload is a pair (userId, userTrustLevel). The trust level is one of the values from UserVerificationStatus.\n     */\n    UserTrustStatusChanged = \"userTrustStatusChanged\",\n\n    /**\n     * Fires when the key backup status changes.\n     * The payload is a boolean indicating whether the key backup is enabled.\n     */\n    KeyBackupStatus = \"crypto.keyBackupStatus\",\n\n    /**\n     * Fires when we failed to back up the keys\n     * The payload is the error code of the error that occurred.\n     */\n    KeyBackupFailed = \"crypto.keyBackupFailed\",\n\n    /**\n     * Fires when the number of sessions that can be backed up changes.\n     * The payload is the remaining number of sessions that can be backed up.\n     */\n    KeyBackupSessionsRemaining = \"crypto.keyBackupSessionsRemaining\",\n\n    /**\n     * Fires when a new valid backup decryption key is in cache.\n     * This will happen when a secret is received from another session, from secret storage,\n     * or when a new backup is created from this session.\n     *\n     * The payload is the version of the backup for which we have the key for.\n     *\n     * This event is only fired by the rust crypto backend.\n     */\n    KeyBackupDecryptionKeyCached = \"crypto.keyBackupDecryptionKeyCached\",\n\n    /**\n     * Fires when a key verification request is received.\n     * The payload is a VerificationRequest object representing the request.\n     */\n    VerificationRequestReceived = \"crypto.verificationRequestReceived\",\n\n    /** @deprecated Use {@link DevicesUpdated} instead when using rust crypto */\n    WillUpdateDevices = \"crypto.willUpdateDevices\",\n\n    /**\n     * Fires whenever the stored devices for a user have been updated\n     * The payload is a pair (userIds, initialFetch).\n     */\n    DevicesUpdated = \"crypto.devicesUpdated\",\n\n    /**\n     * Fires when the user's cross-signing keys have changed or cross-signing\n     * has been enabled/disabled. The client can use getStoredCrossSigningForUser\n     * with the user ID of the logged in user to check if cross-signing is\n     * enabled on the account. If enabled, it can test whether the current key\n     * is trusted using with checkUserTrust with the user ID of the logged\n     * in user. The checkOwnCrossSigningTrust function may be used to reconcile\n     * the trust in the account key.\n     *\n     * The cross-signing API is currently UNSTABLE and may change without notice.\n     * @experimental\n     */\n    KeysChanged = \"crossSigning.keysChanged\",\n\n    /**\n     * Fires when data is being migrated from legacy crypto to rust crypto.\n     *\n     * The payload is a pair `(progress, total)`, where `progress` is the number of steps completed so far, and\n     * `total` is the total number of steps. When migration is complete, a final instance of the event is emitted, with\n     * `progress === total === -1`.\n     */\n    LegacyCryptoStoreMigrationProgress = \"crypto.legacyCryptoStoreMigrationProgress\",\n\n    /**\n     * Fires when a new dehydrated device is created locally.\n     *\n     * After the client calls {@link CryptoApi.startDehydration}, this event\n     * will be fired every time a new dehydrated device is created.  It may fire\n     * before `startDehydration` returns.\n     */\n    DehydratedDeviceCreated = \"dehydration.DehydratedDeviceCreated\",\n\n    /**\n     * Fires when a new dehydrated device is successfully uploaded to the server.\n     *\n     * This should fire shortly after {@link DehydratedDeviceCreated} fires. If\n     * upload is unsuccessful, this will be reported either by an error thrown\n     * by {@link CryptoApi.startDehydration} (for errors that happen before\n     * `startDehydration` returns), or by firing {@link DehydratedDeviceRotationError}\n     * (for errors that happen during regular rotation of the dehydrated device)\n     */\n    DehydratedDeviceUploaded = \"dehydration.DehydratedDeviceUploaded\",\n\n    /**\n     * Fires when rehydration has started.\n     *\n     * After the client calls {@link CryptoApi.startDehydration}, this event will\n     * fire if a dehydrated device is found and we attempt to rehydrate it.\n     */\n    RehydrationStarted = \"dehydration.RehydrationStarted\",\n\n    /**\n     * Fires during rehydration, to inform the application of rehydration progress.\n     *\n     * The payload is a pair `[roomKeyCount: number, toDeviceCount: number]`,\n     * where `roomKeyCount` is the number of room keys that have been received\n     * so far, and `toDeviceCount` is the number of to-device messages received\n     * so far (including the messages containing room keys).\n     */\n    RehydrationProgress = \"dehydration.RehydrationProgress\",\n\n    /** Fires when rehydration has completed successfully. */\n    RehydrationCompleted = \"dehydration.RehydrationCompleted\",\n\n    /** Fires when there was an error in rehydration.\n     *\n     * The payload is an error message as a string.\n     */\n    RehydrationError = \"dehydration.RehydrationError\",\n\n    /**\n     * Fires when a dehydrated device key has been cached in the local database.\n     */\n    DehydrationKeyCached = \"dehydration.DehydrationKeyCached\",\n\n    /**\n     * Fires when an error occurs during periodic rotation of the dehydrated device.\n     *\n     * The payload is an error message as a string.\n     */\n    DehydratedDeviceRotationError = \"dehydration.DehydratedDeviceRotationError\",\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA,WAAYA,WAAW,0BAAXA,WAAW;EACnB;AACJ;AACA;AACA;EAJYA,WAAW;EAOnB;AACJ;AACA;AACA;EAVYA,WAAW;EAanB;AACJ;AACA;AACA;EAhBYA,WAAW;EAmBnB;AACJ;AACA;AACA;EAtBYA,WAAW;EAyBnB;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EAjCYA,WAAW;EAoCnB;AACJ;AACA;AACA;EAvCYA,WAAW;EA0CnB;EA1CQA,WAAW;EA6CnB;AACJ;AACA;AACA;EAhDYA,WAAW;EAmDnB;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EA9DYA,WAAW;EAiEnB;AACJ;AACA;AACA;AACA;AACA;AACA;EAvEYA,WAAW;EA0EnB;AACJ;AACA;AACA;AACA;AACA;AACA;EAhFYA,WAAW;EAmFnB;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EA3FYA,WAAW;EA8FnB;AACJ;AACA;AACA;AACA;AACA;EAnGYA,WAAW;EAsGnB;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;EA7GYA,WAAW;EAgHnB;EAhHQA,WAAW;EAmHnB;AACJ;AACA;AACA;EAtHYA,WAAW;EAyHnB;AACJ;AACA;EA3HYA,WAAW;EA8HnB;AACJ;AACA;AACA;AACA;EAlIYA,WAAW;EAAA,OAAXA,WAAW;AAAA","ignoreList":[]}

package/lib/crypto-api/CryptoEventHandlerMap.d.ts

@@ -0,0 +1,26 @@
+import { type CryptoEvent } from "./CryptoEvent.ts";
+import { type VerificationRequest } from "./verification.ts";
+import { type UserVerificationStatus } from "./index.ts";
+import { type RustBackupCryptoEventMap } from "../rust-crypto/backup.ts";
+import { type EmptyObject } from "../@types/common.ts";
+/**
+ * A map of the {@link CryptoEvent} fired by the {@link CryptoApi} and their payloads.
+ */
+export type CryptoEventHandlerMap = {
+    [CryptoEvent.VerificationRequestReceived]: (request: VerificationRequest) => void;
+    [CryptoEvent.UserTrustStatusChanged]: (userId: string, userTrustLevel: UserVerificationStatus) => void;
+    [CryptoEvent.KeyBackupDecryptionKeyCached]: (version: string) => void;
+    [CryptoEvent.KeysChanged]: (data: EmptyObject) => void;
+    [CryptoEvent.WillUpdateDevices]: (users: string[], initialFetch: boolean) => void;
+    [CryptoEvent.DevicesUpdated]: (users: string[], initialFetch: boolean) => void;
+    [CryptoEvent.LegacyCryptoStoreMigrationProgress]: (progress: number, total: number) => void;
+    [CryptoEvent.DehydratedDeviceCreated]: () => void;
+    [CryptoEvent.DehydratedDeviceUploaded]: () => void;
+    [CryptoEvent.RehydrationStarted]: () => void;
+    [CryptoEvent.RehydrationProgress]: (roomKeyCount: number, toDeviceCount: number) => void;
+    [CryptoEvent.RehydrationCompleted]: () => void;
+    [CryptoEvent.RehydrationError]: (msg: string) => void;
+    [CryptoEvent.DehydrationKeyCached]: () => void;
+    [CryptoEvent.DehydratedDeviceRotationError]: (msg: string) => void;
+} & RustBackupCryptoEventMap;
+//# sourceMappingURL=CryptoEventHandlerMap.d.ts.map

package/lib/crypto-api/CryptoEventHandlerMap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CryptoEventHandlerMap.d.ts","sourceRoot":"","sources":["../../src/crypto-api/CryptoEventHandlerMap.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EAAE,KAAK,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAC7D,OAAO,EAAE,KAAK,sBAAsB,EAAE,MAAM,YAAY,CAAC;AACzD,OAAO,EAAE,KAAK,wBAAwB,EAAE,MAAM,0BAA0B,CAAC;AACzE,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAEvD;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAChC,CAAC,WAAW,CAAC,2BAA2B,CAAC,EAAE,CAAC,OAAO,EAAE,mBAAmB,KAAK,IAAI,CAAC;IAClF,CAAC,WAAW,CAAC,sBAAsB,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,sBAAsB,KAAK,IAAI,CAAC;IACvG,CAAC,WAAW,CAAC,4BAA4B,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IACtE,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,CAAC;IACvD,CAAC,WAAW,CAAC,iBAAiB,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,YAAY,EAAE,OAAO,KAAK,IAAI,CAAC;IAClF,CAAC,WAAW,CAAC,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,YAAY,EAAE,OAAO,KAAK,IAAI,CAAC;IAC/E,CAAC,WAAW,CAAC,kCAAkC,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAC5F,CAAC,WAAW,CAAC,uBAAuB,CAAC,EAAE,MAAM,IAAI,CAAC;IAClD,CAAC,WAAW,CAAC,wBAAwB,CAAC,EAAE,MAAM,IAAI,CAAC;IACnD,CAAC,WAAW,CAAC,kBAAkB,CAAC,EAAE,MAAM,IAAI,CAAC;IAC7C,CAAC,WAAW,CAAC,mBAAmB,CAAC,EAAE,CAAC,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,KAAK,IAAI,CAAC;IACzF,CAAC,WAAW,CAAC,oBAAoB,CAAC,EAAE,MAAM,IAAI,CAAC;IAC/C,CAAC,WAAW,CAAC,gBAAgB,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IACtD,CAAC,WAAW,CAAC,oBAAoB,CAAC,EAAE,MAAM,IAAI,CAAC;IAC/C,CAAC,WAAW,CAAC,6BAA6B,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;CACtE,GAAG,wBAAwB,CAAC"}

package/lib/crypto-api/CryptoEventHandlerMap.js

@@ -0,0 +1 @@
+export {};