@textrp/briij-js-sdk 41.0.0

package/lib/rust-crypto/DehydratedDeviceManager.js

@@ -0,0 +1,361 @@
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+/*
+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.
+*/
+
+import * as RustSdkCryptoJs from "@matrix-org/matrix-sdk-crypto-wasm";
+import { encodeUri } from "../utils.js";
+import { Method } from "../http-api/index.js";
+import { decodeBase64 } from "../base64.js";
+import { CryptoEvent } from "../crypto-api/index.js";
+import { TypedEventEmitter } from "../models/typed-event-emitter.js";
+
+/**
+ * The response body of `GET /_matrix/client/unstable/org.matrix.msc3814.v1/dehydrated_device`.
+ */
+
+/**
+ * The response body of `POST /_matrix/client/unstable/org.matrix.msc3814.v1/dehydrated_device/events`.
+ */
+
+/**
+ * The unstable URL prefix for dehydrated device endpoints
+ */
+export var UnstablePrefix = "/_matrix/client/unstable/org.matrix.msc3814.v1";
+/**
+ * The name used for the dehydration key in Secret Storage
+ */
+var SECRET_STORAGE_NAME = "org.matrix.msc3814";
+
+/**
+ * The interval between creating dehydrated devices. (one week)
+ */
+var DEHYDRATION_INTERVAL = 7 * 24 * 60 * 60 * 1000;
+
+/**
+ * Manages dehydrated devices
+ *
+ * We have one of these per `RustCrypto`.  It's responsible for
+ *
+ * * determining server support for dehydrated devices
+ * * creating new dehydrated devices when requested, including periodically
+ *   replacing the dehydrated device with a new one
+ * * rehydrating a device when requested, and when present
+ *
+ * @internal
+ */
+export class DehydratedDeviceManager extends TypedEventEmitter {
+  constructor(logger, olmMachine, http, outgoingRequestProcessor, secretStorage) {
+    super();
+    this.logger = logger;
+    this.olmMachine = olmMachine;
+    this.http = http;
+    this.outgoingRequestProcessor = outgoingRequestProcessor;
+    this.secretStorage = secretStorage;
+    /** the ID of the interval for periodically replacing the dehydrated device */
+    _defineProperty(this, "intervalId", void 0);
+  }
+  cacheKey(key) {
+    var _this = this;
+    return _asyncToGenerator(function* () {
+      yield _this.olmMachine.dehydratedDevices().saveDehydratedDeviceKey(key);
+      _this.emit(CryptoEvent.DehydrationKeyCached);
+    })();
+  }
+
+  /**
+   * Return whether the server supports dehydrated devices.
+   */
+  isSupported() {
+    var _this2 = this;
+    return _asyncToGenerator(function* () {
+      // call the endpoint to get a dehydrated device.  If it returns an
+      // M_UNRECOGNIZED error, then dehydration is unsupported.  If it returns
+      // a successful response, or an M_NOT_FOUND, then dehydration is supported.
+      // Any other exceptions are passed through.
+      try {
+        yield _this2.http.authedRequest(Method.Get, "/dehydrated_device", undefined, undefined, {
+          prefix: UnstablePrefix
+        });
+      } catch (error) {
+        var err = error;
+        if (err.errcode === "M_UNRECOGNIZED") {
+          return false;
+        } else if (err.errcode === "M_NOT_FOUND") {
+          return true;
+        }
+        throw error;
+      }
+      return true;
+    })();
+  }
+
+  /**
+   * Start using device dehydration.
+   *
+   * - Rehydrates a dehydrated device, if one is available and `opts.rehydrate`
+   *   is `true`.
+   * - Creates a new dehydration key, if necessary, and stores it in Secret
+   *   Storage.
+   *   - If `opts.createNewKey` is set to true, always creates a new key.
+   *   - If a dehydration key is not available, creates a new one.
+   * - Creates a new dehydrated device, and schedules periodically creating
+   *   new dehydrated devices.
+   *
+   * @param opts - options for device dehydration. For backwards compatibility
+   *     with old code, a boolean can be given here, which will be treated as
+   *     the `createNewKey` option. However, this is deprecated.
+   */
+  start() {
+    var _arguments = arguments,
+      _this3 = this;
+    return _asyncToGenerator(function* () {
+      var opts = _arguments.length > 0 && _arguments[0] !== undefined ? _arguments[0] : {};
+      if (typeof opts === "boolean") {
+        opts = {
+          createNewKey: opts
+        };
+      }
+      if (opts.onlyIfKeyCached && !(yield _this3.olmMachine.dehydratedDevices().getDehydratedDeviceKey())) {
+        return;
+      }
+      _this3.stop();
+      if (opts.rehydrate !== false) {
+        try {
+          yield _this3.rehydrateDeviceIfAvailable();
+        } catch (e) {
+          // If rehydration fails, there isn't much we can do about it.  Log
+          // the error, and create a new device.
+          _this3.logger.info("dehydration: Error rehydrating device:", e);
+          _this3.emit(CryptoEvent.RehydrationError, e.message);
+        }
+      }
+      if (opts.createNewKey) {
+        yield _this3.resetKey();
+      }
+      yield _this3.scheduleDeviceDehydration();
+    })();
+  }
+
+  /**
+   * Return whether the dehydration key is stored in Secret Storage.
+   */
+  isKeyStored() {
+    var _this4 = this;
+    return _asyncToGenerator(function* () {
+      return Boolean(yield _this4.secretStorage.isStored(SECRET_STORAGE_NAME));
+    })();
+  }
+
+  /**
+   * Reset the dehydration key.
+   *
+   * Creates a new key and stores it in secret storage.
+   *
+   * @returns The newly-generated key.
+   */
+  resetKey() {
+    var _this5 = this;
+    return _asyncToGenerator(function* () {
+      var key = RustSdkCryptoJs.DehydratedDeviceKey.createRandomKey();
+      yield _this5.secretStorage.store(SECRET_STORAGE_NAME, key.toBase64());
+      // Also cache it in the rust SDK's crypto store.
+      yield _this5.cacheKey(key);
+      return key;
+    })();
+  }
+
+  /**
+   * Get and cache the encryption key from secret storage.
+   *
+   * If `create` is `true`, creates a new key if no existing key is present.
+   *
+   * @returns the key, if available, or `null` if no key is available
+   */
+  getKey(create) {
+    var _this6 = this;
+    return _asyncToGenerator(function* () {
+      var cachedKey = yield _this6.olmMachine.dehydratedDevices().getDehydratedDeviceKey();
+      if (cachedKey) return cachedKey;
+      var keyB64 = yield _this6.secretStorage.get(SECRET_STORAGE_NAME);
+      if (keyB64 === undefined) {
+        if (!create) {
+          return null;
+        }
+        return yield _this6.resetKey();
+      }
+
+      // We successfully found the key in secret storage: decode it, and cache it in
+      // the rust SDK's crypto store.
+      var bytes = decodeBase64(keyB64);
+      try {
+        var key = RustSdkCryptoJs.DehydratedDeviceKey.createKeyFromArray(bytes);
+        yield _this6.cacheKey(key);
+        return key;
+      } finally {
+        bytes.fill(0);
+      }
+    })();
+  }
+
+  /**
+   * Rehydrate the dehydrated device stored on the server.
+   *
+   * Checks if there is a dehydrated device on the server.  If so, rehydrates
+   * the device and processes the to-device events.
+   *
+   * Returns whether or not a dehydrated device was found.
+   */
+  rehydrateDeviceIfAvailable() {
+    var _this7 = this;
+    return _asyncToGenerator(function* () {
+      var key = yield _this7.getKey(false);
+      if (!key) {
+        return false;
+      }
+      var dehydratedDeviceResp;
+      try {
+        dehydratedDeviceResp = yield _this7.http.authedRequest(Method.Get, "/dehydrated_device", undefined, undefined, {
+          prefix: UnstablePrefix
+        });
+      } catch (error) {
+        var err = error;
+        // We ignore M_NOT_FOUND (there is no dehydrated device, so nothing
+        // us to do) and M_UNRECOGNIZED (the server does not understand the
+        // endpoint).  We pass through any other errors.
+        if (err.errcode === "M_NOT_FOUND" || err.errcode === "M_UNRECOGNIZED") {
+          _this7.logger.info("dehydration: No dehydrated device");
+          return false;
+        }
+        throw err;
+      }
+      _this7.logger.info("dehydration: dehydrated device found");
+      _this7.emit(CryptoEvent.RehydrationStarted);
+      var rehydratedDevice = yield _this7.olmMachine.dehydratedDevices().rehydrate(key, new RustSdkCryptoJs.DeviceId(dehydratedDeviceResp.device_id), JSON.stringify(dehydratedDeviceResp.device_data));
+      _this7.logger.info("dehydration: device rehydrated");
+      var nextBatch = undefined;
+      var toDeviceCount = 0;
+      var roomKeyCount = 0;
+      var path = encodeUri("/dehydrated_device/$device_id/events", {
+        $device_id: dehydratedDeviceResp.device_id
+      });
+      // eslint-disable-next-line no-constant-condition
+      while (true) {
+        var eventResp = yield _this7.http.authedRequest(Method.Post, path, undefined, nextBatch ? {
+          next_batch: nextBatch
+        } : {}, {
+          prefix: UnstablePrefix
+        });
+        if (eventResp.events.length === 0) {
+          break;
+        }
+        toDeviceCount += eventResp.events.length;
+        nextBatch = eventResp.next_batch;
+        var roomKeyInfos = yield rehydratedDevice.receiveEvents(JSON.stringify(eventResp.events));
+        roomKeyCount += roomKeyInfos.length;
+        _this7.emit(CryptoEvent.RehydrationProgress, roomKeyCount, toDeviceCount);
+      }
+      _this7.logger.info("dehydration: received ".concat(roomKeyCount, " room keys from ").concat(toDeviceCount, " to-device events"));
+      _this7.emit(CryptoEvent.RehydrationCompleted);
+      return true;
+    })();
+  }
+
+  /**
+   * Creates and uploads a new dehydrated device.
+   *
+   * Creates and stores a new key in secret storage if none is available.
+   */
+  createAndUploadDehydratedDevice() {
+    var _this8 = this;
+    return _asyncToGenerator(function* () {
+      var key = yield _this8.getKey(true);
+      var dehydratedDevice = yield _this8.olmMachine.dehydratedDevices().create();
+      _this8.emit(CryptoEvent.DehydratedDeviceCreated);
+      var request = yield dehydratedDevice.keysForUpload("Dehydrated device", key);
+      yield _this8.outgoingRequestProcessor.makeOutgoingRequest(request);
+      _this8.emit(CryptoEvent.DehydratedDeviceUploaded);
+      _this8.logger.info("dehydration: uploaded device");
+    })();
+  }
+
+  /**
+   * Schedule periodic creation of dehydrated devices.
+   */
+  scheduleDeviceDehydration() {
+    var _this9 = this;
+    return _asyncToGenerator(function* () {
+      // cancel any previously-scheduled tasks
+      _this9.stop();
+      yield _this9.createAndUploadDehydratedDevice();
+      _this9.intervalId = setInterval(() => {
+        _this9.createAndUploadDehydratedDevice().catch(error => {
+          _this9.emit(CryptoEvent.DehydratedDeviceRotationError, error.message);
+          _this9.logger.error("Error creating dehydrated device:", error);
+        });
+      }, DEHYDRATION_INTERVAL);
+    })();
+  }
+
+  /**
+   * Stop the dehydrated device manager.
+   *
+   * Cancels any scheduled dehydration tasks.
+   */
+  stop() {
+    if (this.intervalId) {
+      clearInterval(this.intervalId);
+      this.intervalId = undefined;
+    }
+  }
+
+  /**
+   * Delete the current dehydrated device and stop the dehydrated device manager.
+   */
+  delete() {
+    var _this0 = this;
+    return _asyncToGenerator(function* () {
+      _this0.stop();
+      try {
+        yield _this0.http.authedRequest(Method.Delete, "/dehydrated_device", undefined, {}, {
+          prefix: UnstablePrefix
+        });
+      } catch (error) {
+        var err = error;
+        // If dehydrated devices aren't supported, or no dehydrated device
+        // is found, we don't consider it an error, because we we'll end up
+        // with no dehydrated device.
+        if (err.errcode === "M_UNRECOGNIZED") {
+          return;
+        } else if (err.errcode === "M_NOT_FOUND") {
+          return;
+        }
+        throw error;
+      }
+    })();
+  }
+}
+
+/**
+ * The events fired by the DehydratedDeviceManager
+ * @internal
+ */
+
+/**
+ * A map of the {@link DehydratedDeviceEvents} fired by the {@link DehydratedDeviceManager} and their payloads.
+ * @internal
+ */
+//# sourceMappingURL=DehydratedDeviceManager.js.map

package/lib/rust-crypto/DehydratedDeviceManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DehydratedDeviceManager.js","names":["RustSdkCryptoJs","encodeUri","Method","decodeBase64","CryptoEvent","TypedEventEmitter","UnstablePrefix","SECRET_STORAGE_NAME","DEHYDRATION_INTERVAL","DehydratedDeviceManager","constructor","logger","olmMachine","http","outgoingRequestProcessor","secretStorage","_defineProperty","cacheKey","key","_this","_asyncToGenerator","dehydratedDevices","saveDehydratedDeviceKey","emit","DehydrationKeyCached","isSupported","_this2","authedRequest","Get","undefined","prefix","error","err","errcode","start","_arguments","arguments","_this3","opts","length","createNewKey","onlyIfKeyCached","getDehydratedDeviceKey","stop","rehydrate","rehydrateDeviceIfAvailable","e","info","RehydrationError","message","resetKey","scheduleDeviceDehydration","isKeyStored","_this4","Boolean","isStored","_this5","DehydratedDeviceKey","createRandomKey","store","toBase64","getKey","create","_this6","cachedKey","keyB64","get","bytes","createKeyFromArray","fill","_this7","dehydratedDeviceResp","RehydrationStarted","rehydratedDevice","DeviceId","device_id","JSON","stringify","device_data","nextBatch","toDeviceCount","roomKeyCount","path","$device_id","eventResp","Post","next_batch","events","roomKeyInfos","receiveEvents","RehydrationProgress","concat","RehydrationCompleted","createAndUploadDehydratedDevice","_this8","dehydratedDevice","DehydratedDeviceCreated","request","keysForUpload","makeOutgoingRequest","DehydratedDeviceUploaded","_this9","intervalId","setInterval","catch","DehydratedDeviceRotationError","clearInterval","delete","_this0","Delete"],"sources":["../../src/rust-crypto/DehydratedDeviceManager.ts"],"sourcesContent":["/*\nCopyright 2024 The Matrix.org Foundation C.I.C.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\nimport * as RustSdkCryptoJs from \"@matrix-org/matrix-sdk-crypto-wasm\";\n\nimport { type OutgoingRequestProcessor } from \"./OutgoingRequestProcessor.ts\";\nimport { encodeUri } from \"../utils.ts\";\nimport { type IHttpOpts, type BriijError, type BriijHttpApi, Method } from \"../http-api/index.ts\";\nimport { type IToDeviceEvent } from \"../sync-accumulator.ts\";\nimport { type ServerSideSecretStorage } from \"../secret-storage.ts\";\nimport { decodeBase64 } from \"../base64.ts\";\nimport { type Logger } from \"../logger.ts\";\nimport { CryptoEvent, type CryptoEventHandlerMap, type StartDehydrationOpts } from \"../crypto-api/index.ts\";\nimport { TypedEventEmitter } from \"../models/typed-event-emitter.ts\";\n\n/**\n * The response body of `GET /_matrix/client/unstable/org.matrix.msc3814.v1/dehydrated_device`.\n */\ninterface DehydratedDeviceResp {\n    device_id: string;\n    device_data: {\n        algorithm: string;\n    };\n}\n/**\n * The response body of `POST /_matrix/client/unstable/org.matrix.msc3814.v1/dehydrated_device/events`.\n */\ninterface DehydratedDeviceEventsResp {\n    events: IToDeviceEvent[];\n    next_batch: string;\n}\n\n/**\n * The unstable URL prefix for dehydrated device endpoints\n */\nexport const UnstablePrefix = \"/_matrix/client/unstable/org.matrix.msc3814.v1\";\n/**\n * The name used for the dehydration key in Secret Storage\n */\nconst SECRET_STORAGE_NAME = \"org.matrix.msc3814\";\n\n/**\n * The interval between creating dehydrated devices. (one week)\n */\nconst DEHYDRATION_INTERVAL = 7 * 24 * 60 * 60 * 1000;\n\n/**\n * Manages dehydrated devices\n *\n * We have one of these per `RustCrypto`.  It's responsible for\n *\n * * determining server support for dehydrated devices\n * * creating new dehydrated devices when requested, including periodically\n *   replacing the dehydrated device with a new one\n * * rehydrating a device when requested, and when present\n *\n * @internal\n */\nexport class DehydratedDeviceManager extends TypedEventEmitter<DehydratedDevicesEvents, DehydratedDevicesEventMap> {\n    /** the ID of the interval for periodically replacing the dehydrated device */\n    private intervalId?: ReturnType<typeof setInterval>;\n\n    public constructor(\n        private readonly logger: Logger,\n        private readonly olmMachine: RustSdkCryptoJs.OlmMachine,\n        private readonly http: BriijHttpApi<IHttpOpts & { onlyData: true }>,\n        private readonly outgoingRequestProcessor: OutgoingRequestProcessor,\n        private readonly secretStorage: ServerSideSecretStorage,\n    ) {\n        super();\n    }\n\n    private async cacheKey(key: RustSdkCryptoJs.DehydratedDeviceKey): Promise<void> {\n        await this.olmMachine.dehydratedDevices().saveDehydratedDeviceKey(key);\n        this.emit(CryptoEvent.DehydrationKeyCached);\n    }\n\n    /**\n     * Return whether the server supports dehydrated devices.\n     */\n    public async isSupported(): Promise<boolean> {\n        // call the endpoint to get a dehydrated device.  If it returns an\n        // M_UNRECOGNIZED error, then dehydration is unsupported.  If it returns\n        // a successful response, or an M_NOT_FOUND, then dehydration is supported.\n        // Any other exceptions are passed through.\n        try {\n            await this.http.authedRequest<DehydratedDeviceResp>(\n                Method.Get,\n                \"/dehydrated_device\",\n                undefined,\n                undefined,\n                {\n                    prefix: UnstablePrefix,\n                },\n            );\n        } catch (error) {\n            const err = error as BriijError;\n            if (err.errcode === \"M_UNRECOGNIZED\") {\n                return false;\n            } else if (err.errcode === \"M_NOT_FOUND\") {\n                return true;\n            }\n            throw error;\n        }\n        return true;\n    }\n\n    /**\n     * Start using device dehydration.\n     *\n     * - Rehydrates a dehydrated device, if one is available and `opts.rehydrate`\n     *   is `true`.\n     * - Creates a new dehydration key, if necessary, and stores it in Secret\n     *   Storage.\n     *   - If `opts.createNewKey` is set to true, always creates a new key.\n     *   - If a dehydration key is not available, creates a new one.\n     * - Creates a new dehydrated device, and schedules periodically creating\n     *   new dehydrated devices.\n     *\n     * @param opts - options for device dehydration. For backwards compatibility\n     *     with old code, a boolean can be given here, which will be treated as\n     *     the `createNewKey` option. However, this is deprecated.\n     */\n    public async start(opts: StartDehydrationOpts | boolean = {}): Promise<void> {\n        if (typeof opts === \"boolean\") {\n            opts = { createNewKey: opts };\n        }\n\n        if (opts.onlyIfKeyCached && !(await this.olmMachine.dehydratedDevices().getDehydratedDeviceKey())) {\n            return;\n        }\n        this.stop();\n        if (opts.rehydrate !== false) {\n            try {\n                await this.rehydrateDeviceIfAvailable();\n            } catch (e) {\n                // If rehydration fails, there isn't much we can do about it.  Log\n                // the error, and create a new device.\n                this.logger.info(\"dehydration: Error rehydrating device:\", e);\n                this.emit(CryptoEvent.RehydrationError, (e as Error).message);\n            }\n        }\n        if (opts.createNewKey) {\n            await this.resetKey();\n        }\n        await this.scheduleDeviceDehydration();\n    }\n\n    /**\n     * Return whether the dehydration key is stored in Secret Storage.\n     */\n    public async isKeyStored(): Promise<boolean> {\n        return Boolean(await this.secretStorage.isStored(SECRET_STORAGE_NAME));\n    }\n\n    /**\n     * Reset the dehydration key.\n     *\n     * Creates a new key and stores it in secret storage.\n     *\n     * @returns The newly-generated key.\n     */\n    public async resetKey(): Promise<RustSdkCryptoJs.DehydratedDeviceKey> {\n        const key = RustSdkCryptoJs.DehydratedDeviceKey.createRandomKey();\n        await this.secretStorage.store(SECRET_STORAGE_NAME, key.toBase64());\n        // Also cache it in the rust SDK's crypto store.\n        await this.cacheKey(key);\n        return key;\n    }\n\n    /**\n     * Get and cache the encryption key from secret storage.\n     *\n     * If `create` is `true`, creates a new key if no existing key is present.\n     *\n     * @returns the key, if available, or `null` if no key is available\n     */\n    private async getKey(create: boolean): Promise<RustSdkCryptoJs.DehydratedDeviceKey | null> {\n        const cachedKey = await this.olmMachine.dehydratedDevices().getDehydratedDeviceKey();\n        if (cachedKey) return cachedKey;\n        const keyB64 = await this.secretStorage.get(SECRET_STORAGE_NAME);\n        if (keyB64 === undefined) {\n            if (!create) {\n                return null;\n            }\n            return await this.resetKey();\n        }\n\n        // We successfully found the key in secret storage: decode it, and cache it in\n        // the rust SDK's crypto store.\n        const bytes = decodeBase64(keyB64);\n        try {\n            const key = RustSdkCryptoJs.DehydratedDeviceKey.createKeyFromArray(bytes);\n            await this.cacheKey(key);\n            return key;\n        } finally {\n            bytes.fill(0);\n        }\n    }\n\n    /**\n     * Rehydrate the dehydrated device stored on the server.\n     *\n     * Checks if there is a dehydrated device on the server.  If so, rehydrates\n     * the device and processes the to-device events.\n     *\n     * Returns whether or not a dehydrated device was found.\n     */\n    public async rehydrateDeviceIfAvailable(): Promise<boolean> {\n        const key = await this.getKey(false);\n        if (!key) {\n            return false;\n        }\n\n        let dehydratedDeviceResp;\n        try {\n            dehydratedDeviceResp = await this.http.authedRequest<DehydratedDeviceResp>(\n                Method.Get,\n                \"/dehydrated_device\",\n                undefined,\n                undefined,\n                {\n                    prefix: UnstablePrefix,\n                },\n            );\n        } catch (error) {\n            const err = error as BriijError;\n            // We ignore M_NOT_FOUND (there is no dehydrated device, so nothing\n            // us to do) and M_UNRECOGNIZED (the server does not understand the\n            // endpoint).  We pass through any other errors.\n            if (err.errcode === \"M_NOT_FOUND\" || err.errcode === \"M_UNRECOGNIZED\") {\n                this.logger.info(\"dehydration: No dehydrated device\");\n                return false;\n            }\n            throw err;\n        }\n\n        this.logger.info(\"dehydration: dehydrated device found\");\n        this.emit(CryptoEvent.RehydrationStarted);\n\n        const rehydratedDevice = await this.olmMachine\n            .dehydratedDevices()\n            .rehydrate(\n                key,\n                new RustSdkCryptoJs.DeviceId(dehydratedDeviceResp.device_id),\n                JSON.stringify(dehydratedDeviceResp.device_data),\n            );\n\n        this.logger.info(\"dehydration: device rehydrated\");\n\n        let nextBatch: string | undefined = undefined;\n        let toDeviceCount = 0;\n        let roomKeyCount = 0;\n        const path = encodeUri(\"/dehydrated_device/$device_id/events\", {\n            $device_id: dehydratedDeviceResp.device_id,\n        });\n        // eslint-disable-next-line no-constant-condition\n        while (true) {\n            const eventResp: DehydratedDeviceEventsResp = await this.http.authedRequest<DehydratedDeviceEventsResp>(\n                Method.Post,\n                path,\n                undefined,\n                nextBatch ? { next_batch: nextBatch } : {},\n                {\n                    prefix: UnstablePrefix,\n                },\n            );\n\n            if (eventResp.events.length === 0) {\n                break;\n            }\n            toDeviceCount += eventResp.events.length;\n            nextBatch = eventResp.next_batch;\n            const roomKeyInfos = await rehydratedDevice.receiveEvents(JSON.stringify(eventResp.events));\n            roomKeyCount += roomKeyInfos.length;\n\n            this.emit(CryptoEvent.RehydrationProgress, roomKeyCount, toDeviceCount);\n        }\n        this.logger.info(`dehydration: received ${roomKeyCount} room keys from ${toDeviceCount} to-device events`);\n        this.emit(CryptoEvent.RehydrationCompleted);\n\n        return true;\n    }\n\n    /**\n     * Creates and uploads a new dehydrated device.\n     *\n     * Creates and stores a new key in secret storage if none is available.\n     */\n    public async createAndUploadDehydratedDevice(): Promise<void> {\n        const key = (await this.getKey(true))!;\n\n        const dehydratedDevice = await this.olmMachine.dehydratedDevices().create();\n        this.emit(CryptoEvent.DehydratedDeviceCreated);\n        const request = await dehydratedDevice.keysForUpload(\"Dehydrated device\", key);\n\n        await this.outgoingRequestProcessor.makeOutgoingRequest(request);\n        this.emit(CryptoEvent.DehydratedDeviceUploaded);\n\n        this.logger.info(\"dehydration: uploaded device\");\n    }\n\n    /**\n     * Schedule periodic creation of dehydrated devices.\n     */\n    public async scheduleDeviceDehydration(): Promise<void> {\n        // cancel any previously-scheduled tasks\n        this.stop();\n\n        await this.createAndUploadDehydratedDevice();\n        this.intervalId = setInterval(() => {\n            this.createAndUploadDehydratedDevice().catch((error) => {\n                this.emit(CryptoEvent.DehydratedDeviceRotationError, error.message);\n                this.logger.error(\"Error creating dehydrated device:\", error);\n            });\n        }, DEHYDRATION_INTERVAL);\n    }\n\n    /**\n     * Stop the dehydrated device manager.\n     *\n     * Cancels any scheduled dehydration tasks.\n     */\n    public stop(): void {\n        if (this.intervalId) {\n            clearInterval(this.intervalId);\n            this.intervalId = undefined;\n        }\n    }\n\n    /**\n     * Delete the current dehydrated device and stop the dehydrated device manager.\n     */\n    public async delete(): Promise<void> {\n        this.stop();\n        try {\n            await this.http.authedRequest(\n                Method.Delete,\n                \"/dehydrated_device\",\n                undefined,\n                {},\n                {\n                    prefix: UnstablePrefix,\n                },\n            );\n        } catch (error) {\n            const err = error as BriijError;\n            // If dehydrated devices aren't supported, or no dehydrated device\n            // is found, we don't consider it an error, because we we'll end up\n            // with no dehydrated device.\n            if (err.errcode === \"M_UNRECOGNIZED\") {\n                return;\n            } else if (err.errcode === \"M_NOT_FOUND\") {\n                return;\n            }\n            throw error;\n        }\n    }\n}\n\n/**\n * The events fired by the DehydratedDeviceManager\n * @internal\n */\ntype DehydratedDevicesEvents =\n    | CryptoEvent.DehydratedDeviceCreated\n    | CryptoEvent.DehydratedDeviceUploaded\n    | CryptoEvent.RehydrationStarted\n    | CryptoEvent.RehydrationProgress\n    | CryptoEvent.RehydrationCompleted\n    | CryptoEvent.RehydrationError\n    | CryptoEvent.DehydrationKeyCached\n    | CryptoEvent.DehydratedDeviceRotationError;\n\n/**\n * A map of the {@link DehydratedDeviceEvents} fired by the {@link DehydratedDeviceManager} and their payloads.\n * @internal\n */\ntype DehydratedDevicesEventMap = Pick<CryptoEventHandlerMap, DehydratedDevicesEvents>;\n"],"mappings":";;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,OAAO,KAAKA,eAAe,MAAM,oCAAoC;AAGrE,SAASC,SAAS,QAAQ,aAAa;AACvC,SAA6DC,MAAM,QAAQ,sBAAsB;AAGjG,SAASC,YAAY,QAAQ,cAAc;AAE3C,SAASC,WAAW,QAA+D,wBAAwB;AAC3G,SAASC,iBAAiB,QAAQ,kCAAkC;;AAEpE;AACA;AACA;;AAOA;AACA;AACA;;AAMA;AACA;AACA;AACA,OAAO,IAAMC,cAAc,GAAG,gDAAgD;AAC9E;AACA;AACA;AACA,IAAMC,mBAAmB,GAAG,oBAAoB;;AAEhD;AACA;AACA;AACA,IAAMC,oBAAoB,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI;;AAEpD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,uBAAuB,SAASJ,iBAAiB,CAAqD;EAIxGK,WAAWA,CACGC,MAAc,EACdC,UAAsC,EACtCC,IAAkD,EAClDC,wBAAkD,EAClDC,aAAsC,EACzD;IACE,KAAK,CAAC,CAAC;IAAC,KANSJ,MAAc,GAAdA,MAAc;IAAA,KACdC,UAAsC,GAAtCA,UAAsC;IAAA,KACtCC,IAAkD,GAAlDA,IAAkD;IAAA,KAClDC,wBAAkD,GAAlDA,wBAAkD;IAAA,KAClDC,aAAsC,GAAtCA,aAAsC;IAR3D;IAAAC,eAAA;EAWA;EAEcC,QAAQA,CAACC,GAAwC,EAAiB;IAAA,IAAAC,KAAA;IAAA,OAAAC,iBAAA;MAC5E,MAAMD,KAAI,CAACP,UAAU,CAACS,iBAAiB,CAAC,CAAC,CAACC,uBAAuB,CAACJ,GAAG,CAAC;MACtEC,KAAI,CAACI,IAAI,CAACnB,WAAW,CAACoB,oBAAoB,CAAC;IAAC;EAChD;;EAEA;AACJ;AACA;EACiBC,WAAWA,CAAA,EAAqB;IAAA,IAAAC,MAAA;IAAA,OAAAN,iBAAA;MACzC;MACA;MACA;MACA;MACA,IAAI;QACA,MAAMM,MAAI,CAACb,IAAI,CAACc,aAAa,CACzBzB,MAAM,CAAC0B,GAAG,EACV,oBAAoB,EACpBC,SAAS,EACTA,SAAS,EACT;UACIC,MAAM,EAAExB;QACZ,CACJ,CAAC;MACL,CAAC,CAAC,OAAOyB,KAAK,EAAE;QACZ,IAAMC,GAAG,GAAGD,KAAmB;QAC/B,IAAIC,GAAG,CAACC,OAAO,KAAK,gBAAgB,EAAE;UAClC,OAAO,KAAK;QAChB,CAAC,MAAM,IAAID,GAAG,CAACC,OAAO,KAAK,aAAa,EAAE;UACtC,OAAO,IAAI;QACf;QACA,MAAMF,KAAK;MACf;MACA,OAAO,IAAI;IAAC;EAChB;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACiBG,KAAKA,CAAA,EAA2D;IAAA,IAAAC,UAAA,GAAAC,SAAA;MAAAC,MAAA;IAAA,OAAAjB,iBAAA;MAAA,IAA1DkB,IAAoC,GAAAH,UAAA,CAAAI,MAAA,QAAAJ,UAAA,QAAAN,SAAA,GAAAM,UAAA,MAAG,CAAC,CAAC;MACxD,IAAI,OAAOG,IAAI,KAAK,SAAS,EAAE;QAC3BA,IAAI,GAAG;UAAEE,YAAY,EAAEF;QAAK,CAAC;MACjC;MAEA,IAAIA,IAAI,CAACG,eAAe,IAAI,QAAQJ,MAAI,CAACzB,UAAU,CAACS,iBAAiB,CAAC,CAAC,CAACqB,sBAAsB,CAAC,CAAC,CAAC,EAAE;QAC/F;MACJ;MACAL,MAAI,CAACM,IAAI,CAAC,CAAC;MACX,IAAIL,IAAI,CAACM,SAAS,KAAK,KAAK,EAAE;QAC1B,IAAI;UACA,MAAMP,MAAI,CAACQ,0BAA0B,CAAC,CAAC;QAC3C,CAAC,CAAC,OAAOC,CAAC,EAAE;UACR;UACA;UACAT,MAAI,CAAC1B,MAAM,CAACoC,IAAI,CAAC,wCAAwC,EAAED,CAAC,CAAC;UAC7DT,MAAI,CAACd,IAAI,CAACnB,WAAW,CAAC4C,gBAAgB,EAAGF,CAAC,CAAWG,OAAO,CAAC;QACjE;MACJ;MACA,IAAIX,IAAI,CAACE,YAAY,EAAE;QACnB,MAAMH,MAAI,CAACa,QAAQ,CAAC,CAAC;MACzB;MACA,MAAMb,MAAI,CAACc,yBAAyB,CAAC,CAAC;IAAC;EAC3C;;EAEA;AACJ;AACA;EACiBC,WAAWA,CAAA,EAAqB;IAAA,IAAAC,MAAA;IAAA,OAAAjC,iBAAA;MACzC,OAAOkC,OAAO,OAAOD,MAAI,CAACtC,aAAa,CAACwC,QAAQ,CAAChD,mBAAmB,CAAC,CAAC;IAAC;EAC3E;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;EACiB2C,QAAQA,CAAA,EAAiD;IAAA,IAAAM,MAAA;IAAA,OAAApC,iBAAA;MAClE,IAAMF,GAAG,GAAGlB,eAAe,CAACyD,mBAAmB,CAACC,eAAe,CAAC,CAAC;MACjE,MAAMF,MAAI,CAACzC,aAAa,CAAC4C,KAAK,CAACpD,mBAAmB,EAAEW,GAAG,CAAC0C,QAAQ,CAAC,CAAC,CAAC;MACnE;MACA,MAAMJ,MAAI,CAACvC,QAAQ,CAACC,GAAG,CAAC;MACxB,OAAOA,GAAG;IAAC;EACf;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;EACkB2C,MAAMA,CAACC,MAAe,EAAuD;IAAA,IAAAC,MAAA;IAAA,OAAA3C,iBAAA;MACvF,IAAM4C,SAAS,SAASD,MAAI,CAACnD,UAAU,CAACS,iBAAiB,CAAC,CAAC,CAACqB,sBAAsB,CAAC,CAAC;MACpF,IAAIsB,SAAS,EAAE,OAAOA,SAAS;MAC/B,IAAMC,MAAM,SAASF,MAAI,CAAChD,aAAa,CAACmD,GAAG,CAAC3D,mBAAmB,CAAC;MAChE,IAAI0D,MAAM,KAAKpC,SAAS,EAAE;QACtB,IAAI,CAACiC,MAAM,EAAE;UACT,OAAO,IAAI;QACf;QACA,aAAaC,MAAI,CAACb,QAAQ,CAAC,CAAC;MAChC;;MAEA;MACA;MACA,IAAMiB,KAAK,GAAGhE,YAAY,CAAC8D,MAAM,CAAC;MAClC,IAAI;QACA,IAAM/C,GAAG,GAAGlB,eAAe,CAACyD,mBAAmB,CAACW,kBAAkB,CAACD,KAAK,CAAC;QACzE,MAAMJ,MAAI,CAAC9C,QAAQ,CAACC,GAAG,CAAC;QACxB,OAAOA,GAAG;MACd,CAAC,SAAS;QACNiD,KAAK,CAACE,IAAI,CAAC,CAAC,CAAC;MACjB;IAAC;EACL;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;EACiBxB,0BAA0BA,CAAA,EAAqB;IAAA,IAAAyB,MAAA;IAAA,OAAAlD,iBAAA;MACxD,IAAMF,GAAG,SAASoD,MAAI,CAACT,MAAM,CAAC,KAAK,CAAC;MACpC,IAAI,CAAC3C,GAAG,EAAE;QACN,OAAO,KAAK;MAChB;MAEA,IAAIqD,oBAAoB;MACxB,IAAI;QACAA,oBAAoB,SAASD,MAAI,CAACzD,IAAI,CAACc,aAAa,CAChDzB,MAAM,CAAC0B,GAAG,EACV,oBAAoB,EACpBC,SAAS,EACTA,SAAS,EACT;UACIC,MAAM,EAAExB;QACZ,CACJ,CAAC;MACL,CAAC,CAAC,OAAOyB,KAAK,EAAE;QACZ,IAAMC,GAAG,GAAGD,KAAmB;QAC/B;QACA;QACA;QACA,IAAIC,GAAG,CAACC,OAAO,KAAK,aAAa,IAAID,GAAG,CAACC,OAAO,KAAK,gBAAgB,EAAE;UACnEqC,MAAI,CAAC3D,MAAM,CAACoC,IAAI,CAAC,mCAAmC,CAAC;UACrD,OAAO,KAAK;QAChB;QACA,MAAMf,GAAG;MACb;MAEAsC,MAAI,CAAC3D,MAAM,CAACoC,IAAI,CAAC,sCAAsC,CAAC;MACxDuB,MAAI,CAAC/C,IAAI,CAACnB,WAAW,CAACoE,kBAAkB,CAAC;MAEzC,IAAMC,gBAAgB,SAASH,MAAI,CAAC1D,UAAU,CACzCS,iBAAiB,CAAC,CAAC,CACnBuB,SAAS,CACN1B,GAAG,EACH,IAAIlB,eAAe,CAAC0E,QAAQ,CAACH,oBAAoB,CAACI,SAAS,CAAC,EAC5DC,IAAI,CAACC,SAAS,CAACN,oBAAoB,CAACO,WAAW,CACnD,CAAC;MAELR,MAAI,CAAC3D,MAAM,CAACoC,IAAI,CAAC,gCAAgC,CAAC;MAElD,IAAIgC,SAA6B,GAAGlD,SAAS;MAC7C,IAAImD,aAAa,GAAG,CAAC;MACrB,IAAIC,YAAY,GAAG,CAAC;MACpB,IAAMC,IAAI,GAAGjF,SAAS,CAAC,sCAAsC,EAAE;QAC3DkF,UAAU,EAAEZ,oBAAoB,CAACI;MACrC,CAAC,CAAC;MACF;MACA,OAAO,IAAI,EAAE;QACT,IAAMS,SAAqC,SAASd,MAAI,CAACzD,IAAI,CAACc,aAAa,CACvEzB,MAAM,CAACmF,IAAI,EACXH,IAAI,EACJrD,SAAS,EACTkD,SAAS,GAAG;UAAEO,UAAU,EAAEP;QAAU,CAAC,GAAG,CAAC,CAAC,EAC1C;UACIjD,MAAM,EAAExB;QACZ,CACJ,CAAC;QAED,IAAI8E,SAAS,CAACG,MAAM,CAAChD,MAAM,KAAK,CAAC,EAAE;UAC/B;QACJ;QACAyC,aAAa,IAAII,SAAS,CAACG,MAAM,CAAChD,MAAM;QACxCwC,SAAS,GAAGK,SAAS,CAACE,UAAU;QAChC,IAAME,YAAY,SAASf,gBAAgB,CAACgB,aAAa,CAACb,IAAI,CAACC,SAAS,CAACO,SAAS,CAACG,MAAM,CAAC,CAAC;QAC3FN,YAAY,IAAIO,YAAY,CAACjD,MAAM;QAEnC+B,MAAI,CAAC/C,IAAI,CAACnB,WAAW,CAACsF,mBAAmB,EAAET,YAAY,EAAED,aAAa,CAAC;MAC3E;MACAV,MAAI,CAAC3D,MAAM,CAACoC,IAAI,0BAAA4C,MAAA,CAA0BV,YAAY,sBAAAU,MAAA,CAAmBX,aAAa,sBAAmB,CAAC;MAC1GV,MAAI,CAAC/C,IAAI,CAACnB,WAAW,CAACwF,oBAAoB,CAAC;MAE3C,OAAO,IAAI;IAAC;EAChB;;EAEA;AACJ;AACA;AACA;AACA;EACiBC,+BAA+BA,CAAA,EAAkB;IAAA,IAAAC,MAAA;IAAA,OAAA1E,iBAAA;MAC1D,IAAMF,GAAG,SAAU4E,MAAI,CAACjC,MAAM,CAAC,IAAI,CAAG;MAEtC,IAAMkC,gBAAgB,SAASD,MAAI,CAAClF,UAAU,CAACS,iBAAiB,CAAC,CAAC,CAACyC,MAAM,CAAC,CAAC;MAC3EgC,MAAI,CAACvE,IAAI,CAACnB,WAAW,CAAC4F,uBAAuB,CAAC;MAC9C,IAAMC,OAAO,SAASF,gBAAgB,CAACG,aAAa,CAAC,mBAAmB,EAAEhF,GAAG,CAAC;MAE9E,MAAM4E,MAAI,CAAChF,wBAAwB,CAACqF,mBAAmB,CAACF,OAAO,CAAC;MAChEH,MAAI,CAACvE,IAAI,CAACnB,WAAW,CAACgG,wBAAwB,CAAC;MAE/CN,MAAI,CAACnF,MAAM,CAACoC,IAAI,CAAC,8BAA8B,CAAC;IAAC;EACrD;;EAEA;AACJ;AACA;EACiBI,yBAAyBA,CAAA,EAAkB;IAAA,IAAAkD,MAAA;IAAA,OAAAjF,iBAAA;MACpD;MACAiF,MAAI,CAAC1D,IAAI,CAAC,CAAC;MAEX,MAAM0D,MAAI,CAACR,+BAA+B,CAAC,CAAC;MAC5CQ,MAAI,CAACC,UAAU,GAAGC,WAAW,CAAC,MAAM;QAChCF,MAAI,CAACR,+BAA+B,CAAC,CAAC,CAACW,KAAK,CAAEzE,KAAK,IAAK;UACpDsE,MAAI,CAAC9E,IAAI,CAACnB,WAAW,CAACqG,6BAA6B,EAAE1E,KAAK,CAACkB,OAAO,CAAC;UACnEoD,MAAI,CAAC1F,MAAM,CAACoB,KAAK,CAAC,mCAAmC,EAAEA,KAAK,CAAC;QACjE,CAAC,CAAC;MACN,CAAC,EAAEvB,oBAAoB,CAAC;IAAC;EAC7B;;EAEA;AACJ;AACA;AACA;AACA;EACWmC,IAAIA,CAAA,EAAS;IAChB,IAAI,IAAI,CAAC2D,UAAU,EAAE;MACjBI,aAAa,CAAC,IAAI,CAACJ,UAAU,CAAC;MAC9B,IAAI,CAACA,UAAU,GAAGzE,SAAS;IAC/B;EACJ;;EAEA;AACJ;AACA;EACiB8E,MAAMA,CAAA,EAAkB;IAAA,IAAAC,MAAA;IAAA,OAAAxF,iBAAA;MACjCwF,MAAI,CAACjE,IAAI,CAAC,CAAC;MACX,IAAI;QACA,MAAMiE,MAAI,CAAC/F,IAAI,CAACc,aAAa,CACzBzB,MAAM,CAAC2G,MAAM,EACb,oBAAoB,EACpBhF,SAAS,EACT,CAAC,CAAC,EACF;UACIC,MAAM,EAAExB;QACZ,CACJ,CAAC;MACL,CAAC,CAAC,OAAOyB,KAAK,EAAE;QACZ,IAAMC,GAAG,GAAGD,KAAmB;QAC/B;QACA;QACA;QACA,IAAIC,GAAG,CAACC,OAAO,KAAK,gBAAgB,EAAE;UAClC;QACJ,CAAC,MAAM,IAAID,GAAG,CAACC,OAAO,KAAK,aAAa,EAAE;UACtC;QACJ;QACA,MAAMF,KAAK;MACf;IAAC;EACL;AACJ;;AAEA;AACA;AACA;AACA;;AAWA;AACA;AACA;AACA","ignoreList":[]}

package/lib/rust-crypto/KeyClaimManager.d.ts

@@ -0,0 +1,33 @@
+import { type OlmMachine, type UserId } from "@matrix-org/matrix-sdk-crypto-wasm";
+import { type OutgoingRequestProcessor } from "./OutgoingRequestProcessor.ts";
+import { type LogSpan } from "../logger.ts";
+/**
+ * KeyClaimManager: linearises calls to OlmMachine.getMissingSessions to avoid races
+ *
+ * We have one of these per `RustCrypto` (and hence per `BriijClient`).
+ *
+ * @internal
+ */
+export declare class KeyClaimManager {
+    private readonly olmMachine;
+    private readonly outgoingRequestProcessor;
+    private currentClaimPromise;
+    private stopped;
+    constructor(olmMachine: OlmMachine, outgoingRequestProcessor: OutgoingRequestProcessor);
+    /**
+     * Tell the KeyClaimManager to immediately stop processing requests.
+     *
+     * Any further calls, and any still in the queue, will fail with an error.
+     */
+    stop(): void;
+    /**
+     * Given a list of users, attempt to ensure that we have Olm Sessions active with each of their devices
+     *
+     * If we don't have an active olm session, we will claim a one-time key and start one.
+     * @param logger - logger to use
+     * @param userList - list of userIDs to claim
+     */
+    ensureSessionsForUsers(logger: LogSpan, userList: Array<UserId>): Promise<void>;
+    private ensureSessionsForUsersInner;
+}
+//# sourceMappingURL=KeyClaimManager.d.ts.map

package/lib/rust-crypto/KeyClaimManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeyClaimManager.d.ts","sourceRoot":"","sources":["../../src/rust-crypto/KeyClaimManager.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,MAAM,EAAE,MAAM,oCAAoC,CAAC;AAElF,OAAO,EAAE,KAAK,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAC9E,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,cAAc,CAAC;AAE5C;;;;;;GAMG;AACH,qBAAa,eAAe;IAKpB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,wBAAwB;IAL7C,OAAO,CAAC,mBAAmB,CAAgB;IAC3C,OAAO,CAAC,OAAO,CAAS;gBAGH,UAAU,EAAE,UAAU,EACtB,wBAAwB,EAAE,wBAAwB;IAKvE;;;;OAIG;IACI,IAAI,IAAI,IAAI;IAInB;;;;;;OAMG;IACI,sBAAsB,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;YAcxE,2BAA2B;CAgB5C"}

package/lib/rust-crypto/KeyClaimManager.js

@@ -0,0 +1,82 @@
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+/*
+Copyright 2023 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.
+*/
+
+/**
+ * KeyClaimManager: linearises calls to OlmMachine.getMissingSessions to avoid races
+ *
+ * We have one of these per `RustCrypto` (and hence per `BriijClient`).
+ *
+ * @internal
+ */
+export class KeyClaimManager {
+  constructor(olmMachine, outgoingRequestProcessor) {
+    this.olmMachine = olmMachine;
+    this.outgoingRequestProcessor = outgoingRequestProcessor;
+    _defineProperty(this, "currentClaimPromise", void 0);
+    _defineProperty(this, "stopped", false);
+    this.currentClaimPromise = Promise.resolve();
+  }
+
+  /**
+   * Tell the KeyClaimManager to immediately stop processing requests.
+   *
+   * Any further calls, and any still in the queue, will fail with an error.
+   */
+  stop() {
+    this.stopped = true;
+  }
+
+  /**
+   * Given a list of users, attempt to ensure that we have Olm Sessions active with each of their devices
+   *
+   * If we don't have an active olm session, we will claim a one-time key and start one.
+   * @param logger - logger to use
+   * @param userList - list of userIDs to claim
+   */
+  ensureSessionsForUsers(logger, userList) {
+    // The Rust-SDK requires that we only have one getMissingSessions process in flight at once. This little dance
+    // ensures that, by only having one call to ensureSessionsForUsersInner active at once (and making them
+    // queue up in order).
+    var prom = this.currentClaimPromise.catch(() => {
+      // any errors in the previous claim will have been reported already, so there is nothing to do here.
+      // we just throw away the error and start anew.
+    }).then(() => this.ensureSessionsForUsersInner(logger, userList));
+    this.currentClaimPromise = prom;
+    return prom;
+  }
+  ensureSessionsForUsersInner(logger, userList) {
+    var _this = this;
+    return _asyncToGenerator(function* () {
+      // bail out quickly if we've been stopped.
+      if (_this.stopped) {
+        throw new Error("Cannot ensure Olm sessions: shutting down");
+      }
+      logger.info("Checking for missing Olm sessions");
+      // By passing the userId array to rust we transfer ownership of the items to rust, causing
+      // them to be invalidated on the JS side as soon as the method is called.
+      // As we haven't created the `userList` let's clone the users, to not break the caller from re-using it.
+      var claimRequest = yield _this.olmMachine.getMissingSessions(userList.map(u => u.clone()));
+      if (claimRequest) {
+        logger.info("Making /keys/claim request");
+        yield _this.outgoingRequestProcessor.makeOutgoingRequest(claimRequest);
+      }
+      logger.info("Olm sessions prepared");
+    })();
+  }
+}
+//# sourceMappingURL=KeyClaimManager.js.map

package/lib/rust-crypto/KeyClaimManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeyClaimManager.js","names":["KeyClaimManager","constructor","olmMachine","outgoingRequestProcessor","_defineProperty","currentClaimPromise","Promise","resolve","stop","stopped","ensureSessionsForUsers","logger","userList","prom","catch","then","ensureSessionsForUsersInner","_this","_asyncToGenerator","Error","info","claimRequest","getMissingSessions","map","u","clone","makeOutgoingRequest"],"sources":["../../src/rust-crypto/KeyClaimManager.ts"],"sourcesContent":["/*\nCopyright 2023 The Matrix.org Foundation C.I.C.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\nimport { type OlmMachine, type UserId } from \"@matrix-org/matrix-sdk-crypto-wasm\";\n\nimport { type OutgoingRequestProcessor } from \"./OutgoingRequestProcessor.ts\";\nimport { type LogSpan } from \"../logger.ts\";\n\n/**\n * KeyClaimManager: linearises calls to OlmMachine.getMissingSessions to avoid races\n *\n * We have one of these per `RustCrypto` (and hence per `BriijClient`).\n *\n * @internal\n */\nexport class KeyClaimManager {\n    private currentClaimPromise: Promise<void>;\n    private stopped = false;\n\n    public constructor(\n        private readonly olmMachine: OlmMachine,\n        private readonly outgoingRequestProcessor: OutgoingRequestProcessor,\n    ) {\n        this.currentClaimPromise = Promise.resolve();\n    }\n\n    /**\n     * Tell the KeyClaimManager to immediately stop processing requests.\n     *\n     * Any further calls, and any still in the queue, will fail with an error.\n     */\n    public stop(): void {\n        this.stopped = true;\n    }\n\n    /**\n     * Given a list of users, attempt to ensure that we have Olm Sessions active with each of their devices\n     *\n     * If we don't have an active olm session, we will claim a one-time key and start one.\n     * @param logger - logger to use\n     * @param userList - list of userIDs to claim\n     */\n    public ensureSessionsForUsers(logger: LogSpan, userList: Array<UserId>): Promise<void> {\n        // The Rust-SDK requires that we only have one getMissingSessions process in flight at once. This little dance\n        // ensures that, by only having one call to ensureSessionsForUsersInner active at once (and making them\n        // queue up in order).\n        const prom = this.currentClaimPromise\n            .catch(() => {\n                // any errors in the previous claim will have been reported already, so there is nothing to do here.\n                // we just throw away the error and start anew.\n            })\n            .then(() => this.ensureSessionsForUsersInner(logger, userList));\n        this.currentClaimPromise = prom;\n        return prom;\n    }\n\n    private async ensureSessionsForUsersInner(logger: LogSpan, userList: Array<UserId>): Promise<void> {\n        // bail out quickly if we've been stopped.\n        if (this.stopped) {\n            throw new Error(`Cannot ensure Olm sessions: shutting down`);\n        }\n        logger.info(\"Checking for missing Olm sessions\");\n        // By passing the userId array to rust we transfer ownership of the items to rust, causing\n        // them to be invalidated on the JS side as soon as the method is called.\n        // As we haven't created the `userList` let's clone the users, to not break the caller from re-using it.\n        const claimRequest = await this.olmMachine.getMissingSessions(userList.map((u) => u.clone()));\n        if (claimRequest) {\n            logger.info(\"Making /keys/claim request\");\n            await this.outgoingRequestProcessor.makeOutgoingRequest(claimRequest);\n        }\n        logger.info(\"Olm sessions prepared\");\n    }\n}\n"],"mappings":";;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAOA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMA,eAAe,CAAC;EAIlBC,WAAWA,CACGC,UAAsB,EACtBC,wBAAkD,EACrE;IAAA,KAFmBD,UAAsB,GAAtBA,UAAsB;IAAA,KACtBC,wBAAkD,GAAlDA,wBAAkD;IAAAC,eAAA;IAAAA,eAAA,kBAJrD,KAAK;IAMnB,IAAI,CAACC,mBAAmB,GAAGC,OAAO,CAACC,OAAO,CAAC,CAAC;EAChD;;EAEA;AACJ;AACA;AACA;AACA;EACWC,IAAIA,CAAA,EAAS;IAChB,IAAI,CAACC,OAAO,GAAG,IAAI;EACvB;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;EACWC,sBAAsBA,CAACC,MAAe,EAAEC,QAAuB,EAAiB;IACnF;IACA;IACA;IACA,IAAMC,IAAI,GAAG,IAAI,CAACR,mBAAmB,CAChCS,KAAK,CAAC,MAAM;MACT;MACA;IAAA,CACH,CAAC,CACDC,IAAI,CAAC,MAAM,IAAI,CAACC,2BAA2B,CAACL,MAAM,EAAEC,QAAQ,CAAC,CAAC;IACnE,IAAI,CAACP,mBAAmB,GAAGQ,IAAI;IAC/B,OAAOA,IAAI;EACf;EAEcG,2BAA2BA,CAACL,MAAe,EAAEC,QAAuB,EAAiB;IAAA,IAAAK,KAAA;IAAA,OAAAC,iBAAA;MAC/F;MACA,IAAID,KAAI,CAACR,OAAO,EAAE;QACd,MAAM,IAAIU,KAAK,4CAA4C,CAAC;MAChE;MACAR,MAAM,CAACS,IAAI,CAAC,mCAAmC,CAAC;MAChD;MACA;MACA;MACA,IAAMC,YAAY,SAASJ,KAAI,CAACf,UAAU,CAACoB,kBAAkB,CAACV,QAAQ,CAACW,GAAG,CAAEC,CAAC,IAAKA,CAAC,CAACC,KAAK,CAAC,CAAC,CAAC,CAAC;MAC7F,IAAIJ,YAAY,EAAE;QACdV,MAAM,CAACS,IAAI,CAAC,4BAA4B,CAAC;QACzC,MAAMH,KAAI,CAACd,wBAAwB,CAACuB,mBAAmB,CAACL,YAAY,CAAC;MACzE;MACAV,MAAM,CAACS,IAAI,CAAC,uBAAuB,CAAC;IAAC;EACzC;AACJ","ignoreList":[]}

package/lib/rust-crypto/OutgoingRequestProcessor.d.ts

@@ -0,0 +1,36 @@
+import { type OlmMachine, type OutgoingRequest, PutDehydratedDeviceRequest, UploadSigningKeysRequest } from "@matrix-org/matrix-sdk-crypto-wasm";
+import { type Logger } from "../logger.ts";
+import { type IHttpOpts, type BriijHttpApi } from "../http-api/index.ts";
+import { type UIAuthCallback } from "../interactive-auth.ts";
+/**
+ * OutgoingRequestManager: turns `OutgoingRequest`s from the rust sdk into HTTP requests
+ *
+ * We have one of these per `RustCrypto` (and hence per `BriijClient`), not that it does anything terribly complicated.
+ * It's responsible for:
+ *
+ *   * holding the reference to the `BriijHttpApi`
+ *   * turning `OutgoingRequest`s from the rust backend into HTTP requests, and sending them
+ *   * sending the results of such requests back to the rust backend.
+ *
+ * @internal
+ */
+export declare class OutgoingRequestProcessor {
+    private readonly logger;
+    private readonly olmMachine;
+    private readonly http;
+    constructor(logger: Logger, olmMachine: OlmMachine, http: BriijHttpApi<IHttpOpts & {
+        onlyData: true;
+    }>);
+    makeOutgoingRequest<T>(msg: OutgoingRequest | UploadSigningKeysRequest | PutDehydratedDeviceRequest, uiaCallback?: UIAuthCallback<T>): Promise<void>;
+    /**
+     * Send the HTTP request for a `ToDeviceRequest`
+     *
+     * @param request - request to send
+     * @returns JSON-serialized body of the response, if successful
+     */
+    private sendToDeviceRequest;
+    private makeRequestWithUIA;
+    private requestWithRetry;
+    private rawJsonRequest;
+}
+//# sourceMappingURL=OutgoingRequestProcessor.d.ts.map

package/lib/rust-crypto/OutgoingRequestProcessor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OutgoingRequestProcessor.d.ts","sourceRoot":"","sources":["../../src/rust-crypto/OutgoingRequestProcessor.ts"],"names":[],"mappings":"AAgBA,OAAO,EAKH,KAAK,UAAU,EACf,KAAK,eAAe,EACpB,0BAA0B,EAI1B,wBAAwB,EAC3B,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAyB,KAAK,SAAS,EAAE,KAAK,YAAY,EAAU,MAAM,sBAAsB,CAAC;AAExG,OAAO,EAAiB,KAAK,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAI5E;;;;;;;;;;;GAWG;AACH,qBAAa,wBAAwB;IAE7B,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAFJ,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,UAAU,EACtB,IAAI,EAAE,YAAY,CAAC,SAAS,GAAG;QAAE,QAAQ,EAAE,IAAI,CAAA;KAAE,CAAC;IAG1D,mBAAmB,CAAC,CAAC,EAC9B,GAAG,EAAE,eAAe,GAAG,wBAAwB,GAAG,0BAA0B,EAC5E,WAAW,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,GAChC,OAAO,CAAC,IAAI,CAAC;IAsEhB;;;;;OAKG;YACW,mBAAmB;YAsBnB,kBAAkB;YA2BlB,gBAAgB;YAyBhB,cAAc;CAuB/B"}