matrix-js-sdk 34.5.0 → 34.6.0

package/CHANGELOG.md

@@ -1,3 +1,19 @@
+Changes in [34.6.0](https://github.com/matrix-org/matrix-js-sdk/releases/tag/v34.6.0) (2024-09-24)
+==================================================================================================
+## 🦖 Deprecations
+
+* Element-R: Mark unsupported MatrixClient methods as deprecated ([#4389](https://github.com/matrix-org/matrix-js-sdk/pull/4389)). Contributed by @richvdh.
+
+## ✨ Features
+
+* Add crypto mode setting for invisible crypto, and apply it to decrypting events ([#4407](https://github.com/matrix-org/matrix-js-sdk/pull/4407)). Contributed by @uhoreg.
+* Don't share full key history for RTC per-participant encryption ([#4406](https://github.com/matrix-org/matrix-js-sdk/pull/4406)). Contributed by @hughns.
+* Export membership types ([#4405](https://github.com/matrix-org/matrix-js-sdk/pull/4405)). Contributed by @Johennes.
+* Fix sending redacts in embedded (widget) mode ([#4398](https://github.com/matrix-org/matrix-js-sdk/pull/4398)). Contributed by @toger5.
+* Expose the event ID of a call membership ([#4395](https://github.com/matrix-org/matrix-js-sdk/pull/4395)). Contributed by @robintown.
+* MSC4133 - Extended profiles ([#4391](https://github.com/matrix-org/matrix-js-sdk/pull/4391)). Contributed by @Half-Shot.
+
+
 Changes in [34.5.0](https://github.com/matrix-org/matrix-js-sdk/releases/tag/v34.5.0) (2024-09-10)
 ==================================================================================================
 ## 🦖 Deprecations

package/git-revision.txt

@@ -1 +1 @@
-593a57fc2bb1131350da7e7c8304a076665bcc5a
+82e9eefce60349fe7de792ce2fbb7c4e55a283cb

package/lib/client.d.ts

@@ -321,6 +321,7 @@ export declare const UNSTABLE_MSC2666_SHARED_ROOMS = "uk.half-shot.msc2666";
 export declare const UNSTABLE_MSC2666_MUTUAL_ROOMS = "uk.half-shot.msc2666.mutual_rooms";
 export declare const UNSTABLE_MSC2666_QUERY_MUTUAL_ROOMS = "uk.half-shot.msc2666.query_mutual_rooms";
 export declare const UNSTABLE_MSC4140_DELAYED_EVENTS = "org.matrix.msc4140";
+export declare const UNSTABLE_MSC4133_EXTENDED_PROFILES = "uk.tcpip.msc4133";
 declare enum CrossSigningKeyType {
     MasterKey = "master_key",
     SelfSigningKey = "self_signing_key",
@@ -945,6 +946,8 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      * @returns Promise which resolves to undefined if a device could not be dehydrated, or
      *     to the new device ID if the dehydration was successful.
      * @returns Rejects: with an error response.
+     *
+     * @deprecated MSC2697 device dehydration is not supported for rust cryptography.
      */
     rehydrateDevice(): Promise<string | undefined>;
     /**
@@ -962,18 +965,23 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      * @param deviceDisplayName - The device display name for the
      *     dehydrated device.
      * @returns A promise that resolves when the dehydrated device is stored.
+     *
+     * @deprecated Not supported for Rust Cryptography.
      */
     setDehydrationKey(key: Uint8Array, keyInfo: IDehydratedDeviceKeyInfo, deviceDisplayName?: string): Promise<void>;
     /**
-     * Creates a new dehydrated device (without queuing periodic dehydration)
+     * Creates a new MSC2967 dehydrated device (without queuing periodic dehydration)
      * @param key - the dehydration key
      * @param keyInfo - Information about the key.  Primarily for
      *     information about how to generate the key from a passphrase.
      * @param deviceDisplayName - The device display name for the
      *     dehydrated device.
      * @returns the device id of the newly created dehydrated device
+     *
+     * @deprecated Not supported for Rust Cryptography. Prefer {@link CryptoApi.startDehydration}.
      */
     createDehydratedDevice(key: Uint8Array, keyInfo: IDehydratedDeviceKeyInfo, deviceDisplayName?: string): Promise<string | undefined>;
+    /** @deprecated Not supported for Rust Cryptography. */
     exportDevice(): Promise<IExportedDevice | undefined>;
     /**
      * Clear any data out of the persistent stores used by the client.
@@ -1161,6 +1169,8 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      *
      * It will return a Promise which will resolve when the crypto layer has been
      * successfully initialised.
+     *
+     * @deprecated libolm is deprecated. Prefer {@link initRustCrypto}.
      */
     initCrypto(): Promise<void>;
     /**
@@ -1207,7 +1217,7 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      * @returns base64-encoded ed25519 key. Null if crypto is
      *    disabled.
      *
-     * @deprecated Prefer {@link CryptoApi.getOwnDeviceKeys}
+     * @deprecated Not supported for Rust Cryptography.Prefer {@link CryptoApi.getOwnDeviceKeys}
      */
     getDeviceEd25519Key(): string | null;
     /**
@@ -1216,7 +1226,7 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      * @returns base64-encoded curve25519 key. Null if crypto is
      *    disabled.
      *
-     * @deprecated Use {@link CryptoApi.getOwnDeviceKeys}
+     * @deprecated Not supported for Rust Cryptography. Use {@link CryptoApi.getOwnDeviceKeys}
      */
     getDeviceCurve25519Key(): string | null;
     /**
@@ -1231,7 +1241,7 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      *
      * @returns A promise which resolves to a map userId-\>deviceId-\>`DeviceInfo`
      *
-     * @deprecated Prefer {@link CryptoApi.getUserDeviceInfo}
+     * @deprecated Not supported for Rust Cryptography. Prefer {@link CryptoApi.getUserDeviceInfo}
      */
     downloadKeys(userIds: string[], forceDownload?: boolean): Promise<DeviceInfoMap>;
     /**
@@ -1240,7 +1250,7 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      * @param userId - the user to list keys for.
      *
      * @returns list of devices
-     * @deprecated Prefer {@link CryptoApi.getUserDeviceInfo}
+     * @deprecated Not supported for Rust Cryptography. Prefer {@link CryptoApi.getUserDeviceInfo}
      */
     getStoredDevicesForUser(userId: string): DeviceInfo[];
     /**
@@ -1250,7 +1260,7 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      * @param deviceId - unique identifier for the device
      *
      * @returns device or null
-     * @deprecated Prefer {@link CryptoApi.getUserDeviceInfo}
+     * @deprecated Not supported for Rust Cryptography. Prefer {@link CryptoApi.getUserDeviceInfo}
      */
     getStoredDevice(userId: string, deviceId: string): DeviceInfo | null;
     /**
@@ -1283,6 +1293,8 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      *
      * @remarks
      * Fires {@link CryptoEvent.DeviceVerificationChanged}
+     *
+     * @deprecated Not supported for Rust Cryptography.
      */
     setDeviceBlocked(userId: string, deviceId: string, blocked?: boolean): Promise<void>;
     /**
@@ -1299,6 +1311,8 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      *
      * @remarks
      * Fires {@link CryptoEvent#DeviceVerificationChanged}
+     *
+     * @deprecated Not supported for Rust Cryptography.
      */
     setDeviceKnown(userId: string, deviceId: string, known?: boolean): Promise<void>;
     private setDeviceVerification;
@@ -1311,7 +1325,7 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      * @returns resolves to a VerificationRequest
      *    when the request has been sent to the other party.
      *
-     * @deprecated Prefer {@link CryptoApi.requestVerificationDM}.
+     * @deprecated Not supported for Rust Cryptography. Prefer {@link CryptoApi.requestVerificationDM}.
      */
     requestVerificationDM(userId: string, roomId: string): Promise<VerificationRequest>;
     /**
@@ -1320,7 +1334,7 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      * @param roomId - the room to use for verification
      *
      * @returns the VerificationRequest that is in progress, if any
-     * @deprecated Prefer {@link CryptoApi.findVerificationRequestDMInProgress}.
+     * @deprecated Not supported for Rust Cryptography. Prefer {@link CryptoApi.findVerificationRequestDMInProgress}.
      */
     findVerificationRequestDMInProgress(roomId: string): VerificationRequest | undefined;
     /**
@@ -1329,7 +1343,7 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      * @param userId - the ID of the user to query
      *
      * @returns the VerificationRequests that are in progress
-     * @deprecated Prefer {@link CryptoApi.getVerificationRequestsToDeviceInProgress}.
+     * @deprecated Not supported for Rust Cryptography. Prefer {@link CryptoApi.getVerificationRequestsToDeviceInProgress}.
      */
     getVerificationRequestsToDeviceInProgress(userId: string): VerificationRequest[];
     /**
@@ -1342,7 +1356,7 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      * @returns resolves to a VerificationRequest
      *    when the request has been sent to the other party.
      *
-     * @deprecated Prefer {@link CryptoApi#requestOwnUserVerification} or {@link CryptoApi#requestDeviceVerification}.
+     * @deprecated Not supported for Rust Cryptography. Prefer {@link CryptoApi#requestOwnUserVerification} or {@link CryptoApi#requestDeviceVerification}.
      */
     requestVerification(userId: string, devices?: string[]): Promise<VerificationRequest>;
     /**
@@ -1353,7 +1367,7 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      * @param deviceId - the device to verify
      *
      * @returns a verification object
-     * @deprecated Use `requestVerification` instead.
+     * @deprecated Prefer {@link CryptoApi#requestOwnUserVerification} or {@link CryptoApi#requestDeviceVerification}.
      */
     beginKeyVerification(method: string, userId: string, deviceId: string): Verification<any, any>;
     /**
@@ -1414,7 +1428,7 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      *     "master", "self_signing", or "user_signing".  Defaults to "master".
      *
      * @returns the key ID
-     * @deprecated prefer {@link Crypto.CryptoApi#getCrossSigningKeyId}
+     * @deprecated Not supported for Rust Cryptography. prefer {@link Crypto.CryptoApi#getCrossSigningKeyId}
      */
     getCrossSigningId(type?: CrossSigningKey | string): string | null;
     /**
@@ -1425,7 +1439,7 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      * @param userId - the user ID to get the cross-signing info for.
      *
      * @returns the cross signing information for the user.
-     * @deprecated Prefer {@link CryptoApi#userHasCrossSigningKeys}
+     * @deprecated Not supported for Rust Cryptography. Prefer {@link CryptoApi#userHasCrossSigningKeys}
      */
     getStoredCrossSigningForUser(userId: string): CrossSigningInfo | null;
     /**
@@ -1456,6 +1470,8 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      * @param deviceId - The ID of the device to check
      *
      * @returns true if the device is cross-signed
+     *
+     * @deprecated Not supported for Rust Cryptography.
      */
     checkIfOwnDeviceCrossSigned(deviceId: string): boolean;
     /**
@@ -1473,8 +1489,13 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      * @param privateKey - The private key
      * @param expectedPublicKey - The public key
      * @returns true if the key matches, otherwise false
+     *
+     * @deprecated Not supported for Rust Cryptography.
      */
     checkCrossSigningPrivateKey(privateKey: Uint8Array, expectedPublicKey: string): boolean;
+    /**
+     * @deprecated Not supported for Rust Cryptography. Prefer {@link CryptoApi#requestDeviceVerification}.
+     */
     legacyDeviceVerification(userId: string, deviceId: string, method: string): Promise<VerificationRequest>;
     /**
      * Perform any background tasks that can be done before a message is ready to
@@ -1549,6 +1570,8 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
     /**
      * Counts the number of end to end session keys that are waiting to be backed up
      * @returns Promise which resolves to the number of sessions requiring backup
+     *
+     * @deprecated Not supported for Rust Cryptography.
      */
     countSessionsNeedingBackup(): Promise<number>;
     /**
@@ -1684,6 +1707,7 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      * @param devices - the devices to request the secret from
      *
      * @returns the secret request object
+     * @deprecated Not supported for Rust Cryptography.
      */
     requestSecret(name: string, devices: string[]): ISecretRequest;
     /**
@@ -1725,6 +1749,7 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      * Get e2e information on the device that sent an event
      *
      * @param event - event to be checked
+     * @deprecated Not supported for Rust Cryptography.
      */
     getEventSenderDeviceInfo(event: MatrixEvent): Promise<DeviceInfo | null>;
     /**
@@ -1741,6 +1766,8 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      * @param event - The event to check for
      *
      * @returns A room key request, or null if there is none
+     *
+     * @deprecated Not supported for Rust Cryptography.
      */
     getOutgoingRoomKeyRequest(event: MatrixEvent): Promise<OutgoingRoomKeyRequest | null>;
     /**
@@ -1749,6 +1776,8 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      * @param event - event of which to cancel and resend the room
      *                            key request.
      * @returns A promise that will resolve when the key request is queued
+     *
+     * @deprecated Not supported for Rust Cryptography.
      */
     cancelAndResendEventRoomKeyRequest(event: MatrixEvent): Promise<void>;
     /**
@@ -1783,6 +1812,8 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      *     resolves once the message has been encrypted and sent to the given
      *     userDeviceMap, and returns the `{ contentMap, deviceInfoByDeviceId }`
      *     of the successfully sent messages.
+     *
+     * @deprecated Not supported for Rust Cryptography.
      */
     encryptAndSendToDevices(userDeviceInfoArr: IOlmDevice<DeviceInfo>[], payload: object): Promise<void>;
     /**
@@ -1792,7 +1823,6 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      * @param roomId - The ID of the room to discard the session for
      *
      * @deprecated Prefer {@link CryptoApi.forceDiscardSession | `CryptoApi.forceDiscardSession`}:
-     *
      */
     forceDiscardSession(roomId: string): void;
     /**
@@ -1849,7 +1879,7 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
     /**
      * @param info - key backup info dict from getKeyBackupVersion()
      *
-     * @deprecated Prefer {@link CryptoApi.isKeyBackupTrusted | `CryptoApi.isKeyBackupTrusted`}.
+     * @deprecated Not supported for Rust Cryptography. Prefer {@link CryptoApi.isKeyBackupTrusted | `CryptoApi.isKeyBackupTrusted`}.
      */
     isKeyBackupTrusted(info: IKeyBackupInfo): Promise<TrustInfo>;
     /**
@@ -1857,7 +1887,7 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      *     the server, otherwise false. If we haven't completed a successful check
      *     of key backup status yet, returns null.
      *
-     * @deprecated Prefer direct access to {@link Crypto.CryptoApi.getActiveSessionBackupVersion}:
+     * @deprecated Not supported for Rust Cryptography. Prefer direct access to {@link Crypto.CryptoApi.getActiveSessionBackupVersion}:
      *
      * ```javascript
      * let enabled = (await client.getCrypto().getActiveSessionBackupVersion()) !== null;
@@ -1877,7 +1907,7 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
     /**
      * Disable backing up of keys.
      *
-     * @deprecated It should be unnecessary to disable key backup.
+     * @deprecated Not supported for Rust Cryptography. It should be unnecessary to disable key backup.
      */
     disableKeyBackup(): void;
     /**
@@ -1891,7 +1921,7 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      * @returns Object that can be passed to createKeyBackupVersion and
      *     additionally has a 'recovery_key' member with the user-facing recovery key string.
      *
-     * @deprecated Use {@link Crypto.CryptoApi.resetKeyBackup | `CryptoApi.resetKeyBackup`}.
+     * @deprecated Not supported for Rust cryptography. Use {@link Crypto.CryptoApi.resetKeyBackup | `CryptoApi.resetKeyBackup`}.
      */
     prepareKeyBackupVersion(password?: string | Uint8Array | null, opts?: IKeyBackupPrepareOpts): Promise<Pick<IPreparedKeyBackupVersion, "algorithm" | "auth_data" | "recovery_key">>;
     /**
@@ -1924,6 +1954,8 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      * @param data - Object keys to send
      * @returns a promise that will resolve when the keys
      * are uploaded
+     *
+     * @deprecated Not supported for Rust Cryptography.
      */
     sendKeyBackup(roomId: undefined, sessionId: undefined, version: string | undefined, data: IKeyBackup): Promise<void>;
     sendKeyBackup(roomId: string, sessionId: undefined, version: string | undefined, data: IKeyBackup): Promise<void>;
@@ -1932,8 +1964,8 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      * Marks all group sessions as needing to be backed up and schedules them to
      * upload in the background as soon as possible.
      *
-     * (This is done automatically as part of {@link CryptoApi.resetKeyBackup},
-     * so there is probably no need to call this manually.)
+     * @deprecated Not supported for Rust Cryptography. This is done automatically as part of
+     * {@link CryptoApi.resetKeyBackup}, so there is probably no need to call this manually.
      */
     scheduleAllGroupSessionsForBackup(): Promise<void>;
     /**
@@ -1944,8 +1976,15 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      * so there is probably no need to call this manually.)
      *
      * @returns Promise which resolves to the number of sessions requiring a backup.
+     * @deprecated Not supported for Rust Cryptography.
      */
     flagAllGroupSessionsForBackup(): Promise<number>;
+    /**
+     * Return true if recovery key is valid.
+     * Try to decode the recovery key and check if it's successful.
+     * @param recoveryKey
+     * @deprecated Use {@link decodeRecoveryKey} directly
+     */
     isValidRecoveryKey(recoveryKey: string): boolean;
     /**
      * Get the raw key for a key backup from the password
@@ -1956,6 +1995,7 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      * @param password - Passphrase
      * @param backupInfo - Backup metadata from `checkKeyBackup`
      * @returns key backup key
+     * @deprecated Deriving a backup key from a passphrase is not part of the matrix spec. Instead, a random key is generated and stored/shared via 4S.
      */
     keyBackupKeyFromPassword(password: string, backupInfo: IKeyBackupInfo): Promise<Uint8Array>;
     /**
@@ -1966,6 +2006,7 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      *
      * @param recoveryKey - The recovery key
      * @returns key backup key
+     * @deprecated Use {@link decodeRecoveryKey} directly
      */
     keyBackupKeyFromRecoveryKey(recoveryKey: string): Uint8Array;
     /**
@@ -2048,6 +2089,9 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
      * @param roomId - the room for which keys should be shared.
      * @param userIds - a list of users to share with.  The keys will be sent to
      *     all of the user's current devices.
+     *
+     * @deprecated Do not use this method. It does not work with the Rust crypto stack, and even with the legacy
+     *     stack it introduces a security vulnerability.
      */
     sendSharedHistoryKeys(roomId: string, userIds: string[]): Promise<void>;
     /**
@@ -3046,6 +3090,8 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
     /**
      * The app may wish to see if we have a key cached without
      * triggering a user interaction.
+     *
+     * @deprecated Not supported for Rust Cryptography.
      */
     getCrossSigningCacheCallbacks(): ICacheCallbacks | undefined;
     /**
@@ -3457,6 +3503,81 @@ export declare class MatrixClient extends TypedEventEmitter<EmittedEvents, Clien
         avatar_url?: string;
         displayname?: string;
     }>;
+    /**
+     * Determine if the server supports extended profiles, as described by MSC4133.
+     *
+     * @returns `true` if supported, otherwise `false`
+     */
+    doesServerSupportExtendedProfiles(): Promise<boolean>;
+    /**
+     * Get the prefix used for extended profile requests.
+     *
+     * @returns The prefix for use with `authedRequest`
+     */
+    private getExtendedProfileRequestPrefix;
+    /**
+     * Fetch a user's *extended* profile, which may include additonal keys.
+     *
+     * @see https://github.com/tcpipuk/matrix-spec-proposals/blob/main/proposals/4133-extended-profiles.md
+     * @param userId The user ID to fetch the profile of.
+     * @returns A set of keys to property values.
+     *
+     * @throws An error if the server does not support MSC4133.
+     * @throws A M_NOT_FOUND error if the profile could not be found.
+     */
+    getExtendedProfile(userId: string): Promise<Record<string, unknown>>;
+    /**
+     * Fetch a specific key from the user's *extended* profile.
+     *
+     * @see https://github.com/tcpipuk/matrix-spec-proposals/blob/main/proposals/4133-extended-profiles.md
+     * @param userId The user ID to fetch the profile of.
+     * @param key The key of the property to fetch.
+     * @returns The property value.
+     *
+     * @throws An error if the server does not support MSC4133.
+     * @throws A M_NOT_FOUND error if the key was not set OR the profile could not be found.
+     */
+    getExtendedProfileProperty(userId: string, key: string): Promise<unknown>;
+    /**
+     * Set a property on your *extended* profile.
+     *
+     * @see https://github.com/tcpipuk/matrix-spec-proposals/blob/main/proposals/4133-extended-profiles.md
+     * @param key The key of the property to set.
+     * @param value The value to set on the propety.
+     *
+     * @throws An error if the server does not support MSC4133 OR the server disallows editing the user profile.
+     */
+    setExtendedProfileProperty(key: string, value: unknown): Promise<void>;
+    /**
+     * Delete a property on your *extended* profile.
+     *
+     * @see https://github.com/tcpipuk/matrix-spec-proposals/blob/main/proposals/4133-extended-profiles.md
+     * @param key The key of the property to delete.
+     *
+     * @throws An error if the server does not support MSC4133 OR the server disallows editing the user profile.
+     */
+    deleteExtendedProfileProperty(key: string): Promise<void>;
+    /**
+     * Update multiple properties on your *extended* profile. This will
+     * merge with any existing keys.
+     *
+     * @see https://github.com/tcpipuk/matrix-spec-proposals/blob/main/proposals/4133-extended-profiles.md
+     * @param profile The profile object to merge with the existing profile.
+     * @returns The newly merged profile.
+     *
+     * @throws An error if the server does not support MSC4133 OR the server disallows editing the user profile.
+     */
+    patchExtendedProfile(profile: Record<string, unknown>): Promise<Record<string, unknown>>;
+    /**
+     * Set multiple properties on your *extended* profile. This will completely
+     * replace the existing profile, removing any unspecified keys.
+     *
+     * @see https://github.com/tcpipuk/matrix-spec-proposals/blob/main/proposals/4133-extended-profiles.md
+     * @param profile The profile object to set.
+     *
+     * @throws An error if the server does not support MSC4133 OR the server disallows editing the user profile.
+     */
+    setExtendedProfile(profile: Record<string, unknown>): Promise<void>;
     /**
      * @returns Promise which resolves to a list of the user's threepids.
      * @returns Rejects: with an error response.