@openclaw/matrix 2026.10.2 → 2026.10.5-beta.2

package/node_modules/@matrix-org/matrix-sdk-crypto-wasm/pkg/matrix_sdk_crypto_wasm.d.ts

@@ -518,19 +518,19 @@ export class DecryptedRoomEvent {
     shieldState(strict: boolean): ShieldState;
     /**
      * If the keys for this message were shared-on-invite as part of an
-     * [MSC4268] key bundle, the ID of the user who sent us the bundle.
+     * [MSC4268] key bundle, the ID of the device from which this bundle
+     * was sent.
      *
      * [MSC4268]: https://github.com/matrix-org/matrix-spec-proposals/pull/4268
      */
-    readonly forwarder: UserId | undefined;
+    readonly forwarderDevice: DeviceId | undefined;
     /**
      * If the keys for this message were shared-on-invite as part of an
-     * [MSC4268] key bundle, the ID of the device from which this bundle
-     * was sent.
+     * [MSC4268] key bundle, the ID of the user who sent us the bundle.
      *
      * [MSC4268]: https://github.com/matrix-org/matrix-spec-proposals/pull/4268
      */
-    readonly forwarderDevice: DeviceId | undefined;
+    readonly forwarder: UserId | undefined;
     /**
      * Returns an empty array
      *
@@ -542,11 +542,6 @@ export class DecryptedRoomEvent {
      * @see https://github.com/matrix-org/matrix-spec/issues/1089
      */
     readonly forwardingCurve25519KeyChain: string[];
-    /**
-     * The user ID of the event sender, note this is untrusted data
-     * unless the `verification_state` is as well trusted.
-     */
-    readonly sender: UserId;
     /**
      * The signing Ed25519 key that have created the megolm key that
      * was used to decrypt this session.
@@ -563,6 +558,11 @@ export class DecryptedRoomEvent {
      * trusted.
      */
     readonly senderDevice: DeviceId | undefined;
+    /**
+     * The user ID of the event sender, note this is untrusted data
+     * unless the `verification_state` is as well trusted.
+     */
+    readonly sender: UserId;
     /**
      * The JSON-encoded decrypted event.
      */
@@ -2324,6 +2324,14 @@ export class OlmMachine {
      * A {@link UserDevices} object.
      */
     getUserDevices(user_id: UserId, timeout_secs?: number | null): Promise<UserDevices>;
+    /**
+     * Get a verification request object with the given flow ID.
+     */
+    getVerificationRequest(user_id: UserId, flow_id: string): VerificationRequest | undefined;
+    /**
+     * Get all the verification requests of a given user.
+     */
+    getVerificationRequests(user_id: UserId): VerificationRequest[];
     /**
      * Get a verification object for the given user ID with the given
      * flow ID (a to-device request ID if the verification has been
@@ -2334,14 +2342,6 @@ export class OlmMachine {
      * or `Qr` object.
      */
     getVerification(user_id: UserId, flow_id: string): Sas | Qr | undefined;
-    /**
-     * Get a verification request object with the given flow ID.
-     */
-    getVerificationRequest(user_id: UserId, flow_id: string): VerificationRequest | undefined;
-    /**
-     * Get all the verification requests of a given user.
-     */
-    getVerificationRequests(user_id: UserId): VerificationRequest[];
     /**
      * Get whether we have previously downloaded all message keys for a
      * particular room from the key backup. Typically called in advance of
@@ -2601,30 +2601,31 @@ export class OlmMachine {
      */
     receiveRoomKeyBundle(bundle_data: StoredRoomKeyBundleData, encrypted_bundle: Uint8Array): Promise<undefined>;
     /**
-     * Handle to-device events and one-time key counts from a sync
-     * response.
+     * Handle the changes to the end-to-end encryption state we received from
+     * a [MSC4186](https://github.com/matrix-org/matrix-spec-proposals/pull/4186)
+     * (simplified sliding sync) response.
      *
-     * This will decrypt and handle to-device events returning the
-     * decrypted versions of them.
+     * This behaves exactly like {@link receiveSyncChanges}, except for the
+     * handling of `one_time_keys_counts`: under MSC4186 semantics, a missing
+     * entry for an algorithm means that the number of keys on the server is
+     * *unchanged*, rather than zero.
      *
-     * To decrypt an event from the room timeline call
-     * `decrypt_room_event`.
+     * This is therefore also the method to use when the caller has no
+     * information about the one-time key counts, for example because it is
+     * processing only the to-device events or the device list changes from a
+     * sync response.
      *
      * # Arguments
      *
-     * * `to_device_events`: the JSON-encoded to-device evens from the `/sync`
+     * * `to_device_events`: the JSON-encoded to-device events from the sync
      *   response
      * * `changed_devices`: the mapping of changed and left devices, from the
-     *   `/sync` response
+     *   sync response
      * * `one_time_keys_counts`: The number of one-time keys on the server,
-     *   from the `/sync` response. A `Map` from string (encryption algorithm)
-     *   to number (number of keys). Following the sync v2 semantics, a missing
-     *   entry for an algorithm means that there are *zero* keys of that type
-     *   on the server. If the caller has no information about the key counts
-     *   (for example, because it is processing only part of a sync response),
-     *   it should use {@link receiveSyncChangesMsc4186} instead.
+     *   from the sync response. A `Map` from string (encryption algorithm) to
+     *   number (number of keys). A missing entry means "unchanged".
      * * `unused_fallback_keys`: Optionally, a `Set` of unused fallback keys on
-     *   the server, from the `/sync` response. If this is set, it is used to
+     *   the server, from the sync response. If this is set, it is used to
      *   determine if new fallback keys should be uploaded.
      * * `decryption_settings`: Optionally, the settings to use when decrypting
      *   to-device events. If not set, to-device events will be decrypted with
@@ -2638,33 +2639,32 @@ export class OlmMachine {
      *   * {@link UTDToDeviceEvent}
      *   * {@link InvalidToDeviceEvent}
      */
-    receiveSyncChanges(to_device_events: string, changed_devices: DeviceLists, one_time_keys_counts: Map<string, number>, unused_fallback_keys?: Set<string>, decryption_settings?: DecryptionSettings): Promise<ProcessedToDeviceEvent[]>;
+    receiveSyncChangesMsc4186(to_device_events: string, changed_devices: DeviceLists, one_time_keys_counts: Map<string, number>, unused_fallback_keys?: Set<string>, decryption_settings?: DecryptionSettings): Promise<ProcessedToDeviceEvent[]>;
     /**
-     * Handle the changes to the end-to-end encryption state we received from
-     * a [MSC4186](https://github.com/matrix-org/matrix-spec-proposals/pull/4186)
-     * (simplified sliding sync) response.
+     * Handle to-device events and one-time key counts from a sync
+     * response.
      *
-     * This behaves exactly like {@link receiveSyncChanges}, except for the
-     * handling of `one_time_keys_counts`: under MSC4186 semantics, a missing
-     * entry for an algorithm means that the number of keys on the server is
-     * *unchanged*, rather than zero.
+     * This will decrypt and handle to-device events returning the
+     * decrypted versions of them.
      *
-     * This is therefore also the method to use when the caller has no
-     * information about the one-time key counts, for example because it is
-     * processing only the to-device events or the device list changes from a
-     * sync response.
+     * To decrypt an event from the room timeline call
+     * `decrypt_room_event`.
      *
      * # Arguments
      *
-     * * `to_device_events`: the JSON-encoded to-device events from the sync
+     * * `to_device_events`: the JSON-encoded to-device evens from the `/sync`
      *   response
      * * `changed_devices`: the mapping of changed and left devices, from the
-     *   sync response
+     *   `/sync` response
      * * `one_time_keys_counts`: The number of one-time keys on the server,
-     *   from the sync response. A `Map` from string (encryption algorithm) to
-     *   number (number of keys). A missing entry means "unchanged".
+     *   from the `/sync` response. A `Map` from string (encryption algorithm)
+     *   to number (number of keys). Following the sync v2 semantics, a missing
+     *   entry for an algorithm means that there are *zero* keys of that type
+     *   on the server. If the caller has no information about the key counts
+     *   (for example, because it is processing only part of a sync response),
+     *   it should use {@link receiveSyncChangesMsc4186} instead.
      * * `unused_fallback_keys`: Optionally, a `Set` of unused fallback keys on
-     *   the server, from the sync response. If this is set, it is used to
+     *   the server, from the `/sync` response. If this is set, it is used to
      *   determine if new fallback keys should be uploaded.
      * * `decryption_settings`: Optionally, the settings to use when decrypting
      *   to-device events. If not set, to-device events will be decrypted with
@@ -2678,7 +2678,7 @@ export class OlmMachine {
      *   * {@link UTDToDeviceEvent}
      *   * {@link InvalidToDeviceEvent}
      */
-    receiveSyncChangesMsc4186(to_device_events: string, changed_devices: DeviceLists, one_time_keys_counts: Map<string, number>, unused_fallback_keys?: Set<string>, decryption_settings?: DecryptionSettings): Promise<ProcessedToDeviceEvent[]>;
+    receiveSyncChanges(to_device_events: string, changed_devices: DeviceLists, one_time_keys_counts: Map<string, number>, unused_fallback_keys?: Set<string>, decryption_settings?: DecryptionSettings): Promise<ProcessedToDeviceEvent[]>;
     /**
      * Receive a verification event.
      *
@@ -2792,6 +2792,15 @@ export class OlmMachine {
      * settings can be retrieved via {@link getRoomSettings}.
      */
     setRoomSettings(room_id: RoomId, room_settings: RoomSettings): Promise<void>;
+    /**
+     * Collect the devices belonging to the given user, and send the details
+     * of a room key bundle to those devices.
+     *
+     * Returns a list of to-device requests which must be sent.
+     *
+     * @experimental
+     */
+    shareRoomKeyBundleData(user: UserId, room: RoomId, url: string, media_encryption_info: string | null | undefined, sharing_strategy: CollectStrategy): Promise<ToDeviceRequest[]>;
     /**
      * Get to-device requests to share a room key with users in a room.
      *
@@ -2808,15 +2817,6 @@ export class OlmMachine {
      * to use the `UserId`s after this method has been called.
      */
     shareRoomKey(room_id: RoomId, users: UserId[], encryption_settings: EncryptionSettings): Promise<ToDeviceRequest[]>;
-    /**
-     * Collect the devices belonging to the given user, and send the details
-     * of a room key bundle to those devices.
-     *
-     * Returns a list of to-device requests which must be sent.
-     *
-     * @experimental
-     */
-    shareRoomKeyBundleData(user: UserId, room: RoomId, url: string, media_encryption_info: string | null | undefined, sharing_strategy: CollectStrategy): Promise<ToDeviceRequest[]>;
     /**
      * Sign the given message using our device key and if available
      * cross-signing master key.
@@ -3250,15 +3250,15 @@ export class PickledSession {
 export class PkDecryption {
     free(): void;
     [Symbol.dispose](): void;
-    /**
-     * Decrypts an encrypted message and returns the raw `Uint8Array`.
-     */
-    decrypt(message: PkMessage): Uint8Array;
     /**
      * Decrypts an encrypted message and returns the plaintext as a UTF-8
      * string.
      */
     decryptString(message: PkMessage): string;
+    /**
+     * Decrypts an encrypted message and returns the raw `Uint8Array`.
+     */
+    decrypt(message: PkMessage): Uint8Array;
     /**
      * Creates a `PkDecryption` instance from a secret key.
      */
@@ -3295,14 +3295,14 @@ export class PkEncryption {
     private constructor();
     free(): void;
     [Symbol.dispose](): void;
-    /**
-     * Encrypts a byte message and returns an encrypted {@link PkMessage}.
-     */
-    encrypt(message: Uint8Array): PkMessage;
     /**
      * Encrypts a string message and returns an encrypted {@link PkMessage}.
      */
     encryptString(message: string): PkMessage;
+    /**
+     * Encrypts a byte message and returns an encrypted {@link PkMessage}.
+     */
+    encrypt(message: Uint8Array): PkMessage;
     /**
      * Creates a new `PkEncryption` instance from a public key.
      */
@@ -3411,13 +3411,6 @@ export class Qr {
     private constructor();
     free(): void;
     [Symbol.dispose](): void;
-    /**
-     * Cancel the verification flow.
-     *
-     * Returns either an `OutgoingVerificationRequest` which should be sent
-     * out, or `undefined` if the verification is already cancelled.
-     */
-    cancel(): OutgoingVerificationRequest | undefined;
     /**
      * Get info about the cancellation if the verification flow has
      * been cancelled.
@@ -3432,6 +3425,13 @@ export class Qr {
      * out, or `undefined` if the verification is already cancelled.
      */
     cancelWithCode(code: string): OutgoingVerificationRequest | undefined;
+    /**
+     * Cancel the verification flow.
+     *
+     * Returns either an `OutgoingVerificationRequest` which should be sent
+     * out, or `undefined` if the verification is already cancelled.
+     */
+    cancel(): OutgoingVerificationRequest | undefined;
     /**
      * Confirm that the other side has scanned our QR code.
      *
@@ -3578,6 +3578,15 @@ export class QrCodeData {
      * The slice of bytes would generally be returned by a QR code decoder.
      */
     static fromBytes(bytes: Uint8Array): QrCodeData;
+    /**
+     * Create new {@link QrCodeData} from a given public key, a rendezvous ID
+     * and, a base homeserver URL.
+     *
+     * This creates a QR code which conforms to
+     * {@link https://github.com/matrix-org/matrix-spec-proposals/pull/4388 MSC4388} of the data
+     * format for QR login.
+     */
+    static newMsc4388(public_key: Curve25519PublicKey, rendezvous_id: string, base_url: string, intent: QrCodeIntent): QrCodeData;
     /**
      * Create new {@link QrCodeData} from a given public key, a rendezvous URL
      * and, optionally, a server name for the homeserver.
@@ -3591,15 +3600,6 @@ export class QrCodeData {
      * new device to display the QR code.
      */
     constructor(public_key: Curve25519PublicKey, rendezvous_url: string, server_name?: string | null);
-    /**
-     * Create new {@link QrCodeData} from a given public key, a rendezvous ID
-     * and, a base homeserver URL.
-     *
-     * This creates a QR code which conforms to
-     * {@link https://github.com/matrix-org/matrix-spec-proposals/pull/4388 MSC4388} of the data
-     * format for QR login.
-     */
-    static newMsc4388(public_key: Curve25519PublicKey, rendezvous_id: string, base_url: string, intent: QrCodeIntent): QrCodeData;
     /**
      * Encode the {@link QrCodeData} into a string using base64.
      *
@@ -4085,13 +4085,6 @@ export class Sas {
      * Are we in a state where we can show the short auth string?
      */
     canBePresented(): boolean;
-    /**
-     * Cancel the verification.
-     *
-     * Returns either an `OutgoingVerificationRequest` which should be sent
-     * out, or `undefined` if the verification is already cancelled.
-     */
-    cancel(): OutgoingVerificationRequest | undefined;
     /**
      * Get info about the cancellation if the verification flow has
      * been cancelled.
@@ -4106,6 +4099,13 @@ export class Sas {
      * out, or `undefined` if the verification is already cancelled.
      */
     cancelWithCode(code: string): OutgoingVerificationRequest | undefined;
+    /**
+     * Cancel the verification.
+     *
+     * Returns either an `OutgoingVerificationRequest` which should be sent
+     * out, or `undefined` if the verification is already cancelled.
+     */
+    cancel(): OutgoingVerificationRequest | undefined;
     /**
      * Confirm the SAS verification.
      *
@@ -4125,13 +4125,6 @@ export class Sas {
      * represent the short auth string.
      */
     decimals(): Uint16Array | undefined;
-    /**
-     * Get the emoji version of the short auth string.
-     *
-     * Returns `undefined` if we can't yet present the short auth string,
-     * otherwise an array of seven `Emoji` objects.
-     */
-    emoji(): Emoji[] | undefined;
     /**
      * Get the index of the emoji representing the short auth string
      *
@@ -4142,6 +4135,13 @@ export class Sas {
      * entry](https://spec.matrix.org/unstable/client-server-api/#sas-method-emoji).
      */
     emojiIndex(): Uint8Array | undefined;
+    /**
+     * Get the emoji version of the short auth string.
+     *
+     * Returns `undefined` if we can't yet present the short auth string,
+     * otherwise an array of seven `Emoji` objects.
+     */
+    emoji(): Emoji[] | undefined;
     /**
      * Has the verification been accepted by both parties?
      */
@@ -4486,15 +4486,15 @@ export class Signatures {
      * Remove all the signatures we currently hold.
      */
     clear(): void;
-    /**
-     * Get the map of signatures that belong to the given user.
-     */
-    get(signer: UserId): Map<string, MaybeSignature> | undefined;
     /**
      * Try to find an Ed25519 signature from the given signer with
      * the given key ID.
      */
     getSignature(signer: UserId, key_id: DeviceKeyId): Ed25519Signature | undefined;
+    /**
+     * Get the map of signatures that belong to the given user.
+     */
+    get(signer: UserId): Map<string, MaybeSignature> | undefined;
     /**
      * Do we hold any signatures or is our collection completely
      * empty.
@@ -4521,6 +4521,22 @@ export class StoreHandle {
     private constructor();
     free(): void;
     [Symbol.dispose](): void;
+    /**
+     * Open a crypto store based on IndexedDB, using the given key for
+     * encryption.
+     *
+     * # Arguments
+     *
+     * * `store_name` - The name that should be used to open the IndexedDB
+     *   based database.
+     *
+     * * `store_key` - The key that should be used to encrypt the store, for
+     *   IndexedDB-based stores. Must be a 32-byte array.
+     *
+     * * `logger` - An optional logger instance to use for writing log messages
+     *   during the open operation. An instance of `JsLogger`.
+     */
+    static openWithKey(store_name: string, store_key: Uint8Array, logger?: JsLogger): Promise<StoreHandle>;
     /**
      * Open a crypto store.
      *
@@ -4542,22 +4558,6 @@ export class StoreHandle {
      *   during the open operation. An instance of `JsLogger`.
      */
     static open(store_name: string | null | undefined, store_passphrase: string | null | undefined, logger?: JsLogger): Promise<StoreHandle>;
-    /**
-     * Open a crypto store based on IndexedDB, using the given key for
-     * encryption.
-     *
-     * # Arguments
-     *
-     * * `store_name` - The name that should be used to open the IndexedDB
-     *   based database.
-     *
-     * * `store_key` - The key that should be used to encrypt the store, for
-     *   IndexedDB-based stores. Must be a 32-byte array.
-     *
-     * * `logger` - An optional logger instance to use for writing log messages
-     *   during the open operation. An instance of `JsLogger`.
-     */
-    static openWithKey(store_name: string, store_key: Uint8Array, logger?: JsLogger): Promise<StoreHandle>;
 }
 
 /**
@@ -4920,6 +4920,17 @@ export class VerificationRequest {
     private constructor();
     free(): void;
     [Symbol.dispose](): void;
+    /**
+     * Accept the verification request signaling that our client
+     * supports the given verification methods.
+     *
+     * `methods` represents the methods that we should advertise as
+     * supported by us.
+     *
+     * It returns either a `ToDeviceRequest`, a `RoomMessageRequest`
+     * or `undefined`.
+     */
+    acceptWithMethods(methods: VerificationMethod[]): OutgoingVerificationRequest | undefined;
     /**
      * Accept the verification request.
      *
@@ -4937,17 +4948,6 @@ export class VerificationRequest {
      * or `undefined`.
      */
     accept(): OutgoingVerificationRequest | undefined;
-    /**
-     * Accept the verification request signaling that our client
-     * supports the given verification methods.
-     *
-     * `methods` represents the methods that we should advertise as
-     * supported by us.
-     *
-     * It returns either a `ToDeviceRequest`, a `RoomMessageRequest`
-     * or `undefined`.
-     */
-    acceptWithMethods(methods: VerificationMethod[]): OutgoingVerificationRequest | undefined;
     /**
      * Cancel the verification request.
      *