@jeongsu816/matrix-bot-sdk 0.0.0-stage → 0.8.1

package/lib/appservice/MatrixBridge.js

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MatrixBridge = exports.REMOTE_ROOM_MAP_ACCOUNT_DATA_EVENT_TYPE_PREFIX = exports.REMOTE_USER_MAP_ACCOUNT_DATA_EVENT_TYPE_PREFIX = exports.REMOTE_ROOM_INFO_ACCOUNT_DATA_EVENT_TYPE = exports.REMOTE_USER_INFO_ACCOUNT_DATA_EVENT_TYPE = void 0;
+exports.REMOTE_USER_INFO_ACCOUNT_DATA_EVENT_TYPE = "io.t2bot.sdk.bot.remote_user_info";
+exports.REMOTE_ROOM_INFO_ACCOUNT_DATA_EVENT_TYPE = "io.t2bot.sdk.bot.remote_room_info";
+exports.REMOTE_USER_MAP_ACCOUNT_DATA_EVENT_TYPE_PREFIX = "io.t2bot.sdk.bot.remote_user_map";
+exports.REMOTE_ROOM_MAP_ACCOUNT_DATA_EVENT_TYPE_PREFIX = "io.t2bot.sdk.bot.remote_room_map";
+/**
+ * Utility class for common operations performed by bridges (represented
+ * as appservices).
+ *
+ * The storage utilities are not intended for bridges which allow 1:many
+ * relationships with the remote network.
+ *
+ * Bridges are generally expected to create their own classes which extend
+ * the IRemoteRoomInfo and IRemoteUserInfo interfaces and serialize to JSON
+ * cleanly. The serialized version of these classes is persisted in various
+ * account data locations for future lookups.
+ * @category Application services
+ */
+class MatrixBridge {
+    constructor(appservice) {
+        this.appservice = appservice;
+    }
+    /**
+     * Gets information about a remote user.
+     * @param {Intent} userIntent The Matrix user intent to get information on.
+     * @returns {Promise<IRemoteUserInfo>} Resolves to the remote user information.
+     */
+    async getRemoteUserInfo(userIntent) {
+        await userIntent.ensureRegistered();
+        return userIntent.underlyingClient.getAccountData(exports.REMOTE_USER_INFO_ACCOUNT_DATA_EVENT_TYPE);
+    }
+    /**
+     * Sets information about a remote user. Calling this function will map the
+     * provided remote user ID to the intent's owner.
+     * @param {Intent} userIntent The Matrix user intent to store information on.
+     * @param {IRemoteUserInfo} remoteInfo The remote user information to store
+     * @returns {Promise<any>} Resolves when the information has been updated.
+     */
+    async setRemoteUserInfo(userIntent, remoteInfo) {
+        await userIntent.ensureRegistered();
+        await userIntent.underlyingClient.setAccountData(exports.REMOTE_USER_INFO_ACCOUNT_DATA_EVENT_TYPE, remoteInfo);
+        await this.updateRemoteUserMapping(userIntent.userId, remoteInfo.id);
+    }
+    /**
+     * Gets information about a remote room.
+     * @param {string} matrixRoomId The Matrix room ID to get information on.
+     * @returns {Promise<IRemoteRoomInfo>} Resolves to the remote room information.
+     */
+    async getRemoteRoomInfo(matrixRoomId) {
+        const bridgeBot = this.appservice.botIntent;
+        await bridgeBot.ensureRegistered();
+        // We do not need to ensure the user is joined to the room because we can associate
+        // room account data with any arbitrary room.
+        return bridgeBot.underlyingClient.getRoomAccountData(exports.REMOTE_ROOM_INFO_ACCOUNT_DATA_EVENT_TYPE, matrixRoomId);
+    }
+    /**
+     * Sets information about a remote room. Calling this function will map the
+     * provided remote room ID to the matrix room ID.
+     * @param {string} matrixRoomId The Matrix room ID to store information on.
+     * @param {IRemoteRoomInfo} remoteInfo The remote room information to store
+     * @returns {Promise<any>} Resolves when the information has been updated.
+     */
+    async setRemoteRoomInfo(matrixRoomId, remoteInfo) {
+        const bridgeBot = this.appservice.botIntent;
+        await bridgeBot.ensureRegistered();
+        // We do not need to ensure the user is joined to the room because we can associate
+        // room account data with any arbitrary room.
+        await bridgeBot.underlyingClient.setRoomAccountData(exports.REMOTE_ROOM_INFO_ACCOUNT_DATA_EVENT_TYPE, matrixRoomId, remoteInfo);
+        await this.updateRemoteRoomMapping(matrixRoomId, remoteInfo.id);
+    }
+    /**
+     * Gets the Matrix room ID for the provided remote room ID.
+     * @param {string} remoteRoomId The remote room ID to look up.
+     * @returns {Promise<string>} Resolves to the Matrix room ID.
+     */
+    async getMatrixRoomIdForRemote(remoteRoomId) {
+        const eventType = `${exports.REMOTE_ROOM_MAP_ACCOUNT_DATA_EVENT_TYPE_PREFIX}.${remoteRoomId}`;
+        const bridgeBot = this.appservice.botIntent;
+        await bridgeBot.ensureRegistered();
+        const result = await bridgeBot.underlyingClient.getAccountData(eventType);
+        return result['id'];
+    }
+    /**
+     * Gets a Matrix user intent for the provided remote user ID.
+     * @param {string} remoteUserId The remote user ID to look up.
+     * @returns {Promise<Intent>} Resolves to the Matrix user intent.
+     */
+    async getIntentForRemote(remoteUserId) {
+        const eventType = `${exports.REMOTE_USER_MAP_ACCOUNT_DATA_EVENT_TYPE_PREFIX}.${remoteUserId}`;
+        const bridgeBot = this.appservice.botIntent;
+        await bridgeBot.ensureRegistered();
+        const result = await bridgeBot.underlyingClient.getAccountData(eventType);
+        return this.appservice.getIntentForUserId(result['id']);
+    }
+    async updateRemoteUserMapping(matrixUserId, remoteUserId) {
+        const eventType = `${exports.REMOTE_USER_MAP_ACCOUNT_DATA_EVENT_TYPE_PREFIX}.${remoteUserId}`;
+        const bridgeBot = this.appservice.botIntent;
+        await bridgeBot.ensureRegistered();
+        await bridgeBot.underlyingClient.setAccountData(eventType, { id: matrixUserId });
+    }
+    async updateRemoteRoomMapping(matrixRoomId, remoteRoomId) {
+        const eventType = `${exports.REMOTE_ROOM_MAP_ACCOUNT_DATA_EVENT_TYPE_PREFIX}.${remoteRoomId}`;
+        const bridgeBot = this.appservice.botIntent;
+        await bridgeBot.ensureRegistered();
+        await bridgeBot.underlyingClient.setAccountData(eventType, { id: matrixRoomId });
+    }
+}
+exports.MatrixBridge = MatrixBridge;
+//# sourceMappingURL=MatrixBridge.js.map

package/lib/appservice/MatrixBridge.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MatrixBridge.js","sourceRoot":"","sources":["../../src/appservice/MatrixBridge.ts"],"names":[],"mappings":";;;AAGa,QAAA,wCAAwC,GAAG,mCAAmC,CAAC;AAC/E,QAAA,wCAAwC,GAAG,mCAAmC,CAAC;AAC/E,QAAA,8CAA8C,GAAG,kCAAkC,CAAC;AACpF,QAAA,8CAA8C,GAAG,kCAAkC,CAAC;AAwBjG;;;;;;;;;;;;GAYG;AACH,MAAa,YAAY;IACrB,YAAoB,UAAsB;QAAtB,eAAU,GAAV,UAAU,CAAY;IAC1C,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,iBAAiB,CAA4B,UAAkB;QACxE,MAAM,UAAU,CAAC,gBAAgB,EAAE,CAAC;QACpC,OAAmB,UAAU,CAAC,gBAAgB,CAAC,cAAc,CAAC,gDAAwC,CAAC,CAAC;IAC5G,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,iBAAiB,CAA4B,UAAkB,EAAE,UAAa;QACvF,MAAM,UAAU,CAAC,gBAAgB,EAAE,CAAC;QACpC,MAAM,UAAU,CAAC,gBAAgB,CAAC,cAAc,CAAC,gDAAwC,EAAE,UAAU,CAAC,CAAC;QACvG,MAAM,IAAI,CAAC,uBAAuB,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,iBAAiB,CAA4B,YAAoB;QAC1E,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;QAC5C,MAAM,SAAS,CAAC,gBAAgB,EAAE,CAAC;QACnC,mFAAmF;QACnF,6CAA6C;QAC7C,OAAmB,SAAS,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,gDAAwC,EAAE,YAAY,CAAC,CAAC;IAC7H,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,iBAAiB,CAA4B,YAAoB,EAAE,UAAa;QACzF,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;QAC5C,MAAM,SAAS,CAAC,gBAAgB,EAAE,CAAC;QACnC,mFAAmF;QACnF,6CAA6C;QAC7C,MAAM,SAAS,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,gDAAwC,EAAE,YAAY,EAAE,UAAU,CAAC,CAAC;QACxH,MAAM,IAAI,CAAC,uBAAuB,CAAC,YAAY,EAAE,UAAU,CAAC,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,wBAAwB,CAAC,YAAoB;QACtD,MAAM,SAAS,GAAG,GAAG,sDAA8C,IAAI,YAAY,EAAE,CAAC;QACtF,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;QAC5C,MAAM,SAAS,CAAC,gBAAgB,EAAE,CAAC;QACnC,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,gBAAgB,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;QAC1E,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,kBAAkB,CAAC,YAAoB;QAChD,MAAM,SAAS,GAAG,GAAG,sDAA8C,IAAI,YAAY,EAAE,CAAC;QACtF,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;QAC5C,MAAM,SAAS,CAAC,gBAAgB,EAAE,CAAC;QACnC,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,gBAAgB,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;QAC1E,OAAO,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAC5D,CAAC;IAEO,KAAK,CAAC,uBAAuB,CAAC,YAAoB,EAAE,YAAoB;QAC5E,MAAM,SAAS,GAAG,GAAG,sDAA8C,IAAI,YAAY,EAAE,CAAC;QACtF,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;QAC5C,MAAM,SAAS,CAAC,gBAAgB,EAAE,CAAC;QACnC,MAAM,SAAS,CAAC,gBAAgB,CAAC,cAAc,CAAC,SAAS,EAAE,EAAE,EAAE,EAAE,YAAY,EAAE,CAAC,CAAC;IACrF,CAAC;IAEO,KAAK,CAAC,uBAAuB,CAAC,YAAoB,EAAE,YAAoB;QAC5E,MAAM,SAAS,GAAG,GAAG,sDAA8C,IAAI,YAAY,EAAE,CAAC;QACtF,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;QAC5C,MAAM,SAAS,CAAC,gBAAgB,EAAE,CAAC;QACnC,MAAM,SAAS,CAAC,gBAAgB,CAAC,cAAc,CAAC,SAAS,EAAE,EAAE,EAAE,EAAE,YAAY,EAAE,CAAC,CAAC;IACrF,CAAC;CACJ;AA/FD,oCA+FC"}

package/lib/appservice/UnstableAppserviceApis.d.ts

@@ -0,0 +1,41 @@
+import { MatrixClient } from "../MatrixClient";
+import { MSC2716BatchSendResponse } from "../models/MSC2176";
+/**
+ * Unstable APIs that shouldn't be used in most circumstances for appservices.
+ * @category Unstable APIs
+ */
+export declare class UnstableAppserviceApis {
+    private client;
+    private requestId;
+    constructor(client: MatrixClient);
+    /**
+     * Send several historical events into a room.
+     * @see https://github.com/matrix-org/matrix-doc/pull/2716
+     * @param {string} roomId The roomID to send to.
+     * @param {string} prevEventId The event ID where this batch will be inserted
+     * @param {string} chunkId The chunk ID returned from a previous call. Set falsy to start at the beginning.
+     * @param {any[]} events A set of event contents for events to be inserted into the room.
+     * @param {any[]} stateEventsAtStart A set of state events to be inserted into the room. Defaults to empty.
+     * @returns A set of eventIds and the next chunk ID
+     */
+    sendHistoricalEventBatch(roomId: string, prevEventId: string, events: any[], stateEventsAtStart?: any[], chunkId?: string): Promise<MSC2716BatchSendResponse>;
+    /**
+     * Sends an event to the given room with a given timestamp.
+     * @param {string} roomId the room ID to send the event to
+     * @param {string} eventType the type of event to send
+     * @param {string} content the event body to send
+     * @param {number} ts The origin_server_ts of the new event
+     * @returns {Promise<string>} resolves to the event ID that represents the event
+     */
+    sendEventWithTimestamp(roomId: string, eventType: string, content: any, ts: number): Promise<any>;
+    /**
+     * Sends a state event to the given room with a given timestamp.
+     * @param {string} roomId the room ID to send the event to
+     * @param {string} type the event type to send
+     * @param {string} stateKey the state key to send, should not be null
+     * @param {string} content the event body to send
+     * @param {number} ts The origin_server_ts of the new event
+     * @returns {Promise<string>} resolves to the event ID that represents the message
+     */
+    sendStateEventWithTimestamp(roomId: string, type: string, stateKey: string, content: any, ts: number): Promise<string>;
+}

package/lib/appservice/UnstableAppserviceApis.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnstableAppserviceApis = void 0;
+/**
+ * Unstable APIs that shouldn't be used in most circumstances for appservices.
+ * @category Unstable APIs
+ */
+class UnstableAppserviceApis {
+    constructor(client) {
+        this.client = client;
+        this.requestId = 0;
+    }
+    /**
+     * Send several historical events into a room.
+     * @see https://github.com/matrix-org/matrix-doc/pull/2716
+     * @param {string} roomId The roomID to send to.
+     * @param {string} prevEventId The event ID where this batch will be inserted
+     * @param {string} chunkId The chunk ID returned from a previous call. Set falsy to start at the beginning.
+     * @param {any[]} events A set of event contents for events to be inserted into the room.
+     * @param {any[]} stateEventsAtStart A set of state events to be inserted into the room. Defaults to empty.
+     * @returns A set of eventIds and the next chunk ID
+     */
+    async sendHistoricalEventBatch(roomId, prevEventId, events, stateEventsAtStart = [], chunkId) {
+        return this.client.doRequest("POST", `/_matrix/client/unstable/org.matrix.msc2716/rooms/${encodeURIComponent(roomId)}/batch_send`, {
+            prev_event: prevEventId,
+            chunk_id: chunkId,
+        }, {
+            events,
+            state_events_at_start: stateEventsAtStart,
+        });
+    }
+    /**
+     * Sends an event to the given room with a given timestamp.
+     * @param {string} roomId the room ID to send the event to
+     * @param {string} eventType the type of event to send
+     * @param {string} content the event body to send
+     * @param {number} ts The origin_server_ts of the new event
+     * @returns {Promise<string>} resolves to the event ID that represents the event
+     */
+    async sendEventWithTimestamp(roomId, eventType, content, ts) {
+        const txnId = `${(new Date().getTime())}__inc_appts${++this.requestId}`;
+        const path = `/_matrix/client/v3/rooms/${encodeURIComponent(roomId)}/send/${encodeURIComponent(eventType)}/${encodeURIComponent(txnId)}`;
+        const response = await this.client.doRequest("PUT", path, { ts }, content);
+        return response.event_id;
+    }
+    /**
+     * Sends a state event to the given room with a given timestamp.
+     * @param {string} roomId the room ID to send the event to
+     * @param {string} type the event type to send
+     * @param {string} stateKey the state key to send, should not be null
+     * @param {string} content the event body to send
+     * @param {number} ts The origin_server_ts of the new event
+     * @returns {Promise<string>} resolves to the event ID that represents the message
+     */
+    async sendStateEventWithTimestamp(roomId, type, stateKey, content, ts) {
+        const path = `/_matrix/client/v3/rooms/${encodeURIComponent(roomId)}/state/${encodeURIComponent(type)}/${encodeURIComponent(stateKey)}`;
+        const response = await this.client.doRequest("PUT", path, { ts }, content);
+        return response.event_id;
+    }
+}
+exports.UnstableAppserviceApis = UnstableAppserviceApis;
+//# sourceMappingURL=UnstableAppserviceApis.js.map

package/lib/appservice/UnstableAppserviceApis.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UnstableAppserviceApis.js","sourceRoot":"","sources":["../../src/appservice/UnstableAppserviceApis.ts"],"names":[],"mappings":";;;AAGA;;;GAGG;AACH,MAAa,sBAAsB;IAG/B,YAAoB,MAAoB;QAApB,WAAM,GAAN,MAAM,CAAc;QAFhC,cAAS,GAAG,CAAC,CAAC;IAGtB,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,wBAAwB,CAAC,MAAc,EAAE,WAAmB,EAAE,MAAa,EAAE,qBAA4B,EAAE,EAAE,OAAgB;QACtI,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,qDAAqD,kBAAkB,CAAC,MAAM,CAAC,aAAa,EAAE;YAC/H,UAAU,EAAE,WAAW;YACvB,QAAQ,EAAE,OAAO;SACpB,EAAE;YACC,MAAM;YACN,qBAAqB,EAAE,kBAAkB;SAC5C,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,sBAAsB,CAAC,MAAc,EAAE,SAAiB,EAAE,OAAY,EAAE,EAAU;QAC3F,MAAM,KAAK,GAAG,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC,cAAc,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;QACxE,MAAM,IAAI,GAAG,4BAA4B,kBAAkB,CAAC,MAAM,CAAC,SAAS,kBAAkB,CAAC,SAAS,CAAC,IAAI,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC;QACzI,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;QAC3E,OAAO,QAAQ,CAAC,QAAQ,CAAC;IAC7B,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,2BAA2B,CAAC,MAAc,EAAE,IAAY,EAAE,QAAgB,EAAE,OAAY,EAAE,EAAU;QAC7G,MAAM,IAAI,GAAG,4BAA4B,kBAAkB,CAAC,MAAM,CAAC,UAAU,kBAAkB,CAAC,IAAI,CAAC,IAAI,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAC;QACxI,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;QAC3E,OAAO,QAAQ,CAAC,QAAQ,CAAC;IAC7B,CAAC;CACJ;AAvDD,wDAuDC"}

package/lib/appservice/http_responses.d.ts

@@ -0,0 +1,77 @@
+/**
+ * This is the response format documented in
+ * https://matrix.org/docs/spec/application_service/r0.1.2#get-matrix-app-v1-thirdparty-protocol-protocol
+ * @category Application services
+ */
+export interface IApplicationServiceProtocol {
+    user_fields: string[];
+    location_fields: string[];
+    icon: string;
+    field_types: {
+        [field: string]: IFieldType;
+    };
+    instances: {
+        [name: string]: IProtocolInstance;
+    };
+}
+interface IFieldType {
+    regexp: string;
+    placeholder: string;
+}
+interface IProtocolInstance {
+    desc: string;
+    icon: string;
+    fields: {
+        [field: string]: string;
+    };
+    network_id: string;
+}
+/**
+ * This is the response format for an MSC3983 `/keys/claim` request.
+ * See https://github.com/matrix-org/matrix-spec-proposals/pull/3983
+ * @deprecated This can be removed at any time without notice as it is unstable functionality.
+ * @category Application services
+ */
+export interface MSC3983KeyClaimResponse {
+    [userId: string]: {
+        [deviceId: string]: {
+            [keyId: string]: {
+                key: string;
+                signatures: {
+                    [userId: string]: {
+                        [keyId: string]: string;
+                    };
+                };
+            };
+        };
+    };
+}
+/**
+ * This is the response format for an MSC3984 `/keys/query` request.
+ * See https://github.com/matrix-org/matrix-spec-proposals/pull/3984
+ * @deprecated This can be removed at any time without notice as it is unstable functionality.
+ * @category Application services
+ */
+export interface MSC3984KeyQueryResponse {
+    device_keys: {
+        [userId: string]: {
+            [deviceId: string]: {
+                algorithms: string[];
+                device_id: string;
+                user_id: string;
+                keys: {
+                    [keyId: string]: string;
+                };
+                signatures: {
+                    [userId: string]: {
+                        [keyId: string]: string;
+                    };
+                };
+                unsigned?: {
+                    [key: string]: any;
+                };
+            };
+        };
+    };
+}
+export {};

package/lib/appservice/http_responses.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=http_responses.js.map

package/lib/appservice/http_responses.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"http_responses.js","sourceRoot":"","sources":["../../src/appservice/http_responses.ts"],"names":[],"mappings":""}

package/lib/b64.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Encodes Base64.
+ * @category Utilities
+ * @param {ArrayBuffer | Uint8Array} b The buffer to encode.
+ * @returns {string} The Base64 string.
+ */
+export declare function encodeBase64(b: ArrayBuffer | Uint8Array): string;
+/**
+ * Encodes Unpadded Base64.
+ * @category Utilities
+ * @param {ArrayBuffer | Uint8Array} b The buffer to encode.
+ * @returns {string} The Base64 string.
+ */
+export declare function encodeUnpaddedBase64(b: ArrayBuffer | Uint8Array): string;
+/**
+ * Encodes URL-Safe Unpadded Base64.
+ * @category Utilities
+ * @param {ArrayBuffer | Uint8Array} b The buffer to encode.
+ * @returns {string} The Base64 string.
+ */
+export declare function encodeUnpaddedUrlSafeBase64(b: ArrayBuffer | Uint8Array): string;
+/**
+ * Decodes Base64.
+ * @category Utilities
+ * @param {string} s The Base64 string.
+ * @returns {Uint8Array} The encoded data as a buffer.
+ */
+export declare function decodeBase64(s: string): Uint8Array;
+/**
+ * Decodes Unpadded Base64.
+ * @category Utilities
+ * @param {string} s The Base64 string.
+ * @returns {Uint8Array} The encoded data as a buffer.
+ */
+export declare function decodeUnpaddedBase64(s: string): Uint8Array;
+/**
+ * Decodes URL-Safe Unpadded Base64.
+ * @category Utilities
+ * @param {string} s The Base64 string.
+ * @returns {Uint8Array} The encoded data as a buffer.
+ */
+export declare function decodeUnpaddedUrlSafeBase64(s: string): Uint8Array;

package/lib/b64.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.encodeBase64 = encodeBase64;
+exports.encodeUnpaddedBase64 = encodeUnpaddedBase64;
+exports.encodeUnpaddedUrlSafeBase64 = encodeUnpaddedUrlSafeBase64;
+exports.decodeBase64 = decodeBase64;
+exports.decodeUnpaddedBase64 = decodeUnpaddedBase64;
+exports.decodeUnpaddedUrlSafeBase64 = decodeUnpaddedUrlSafeBase64;
+/**
+ * Encodes Base64.
+ * @category Utilities
+ * @param {ArrayBuffer | Uint8Array} b The buffer to encode.
+ * @returns {string} The Base64 string.
+ */
+function encodeBase64(b) {
+    if (b instanceof ArrayBuffer) {
+        return Buffer.from(b).toString('base64');
+    }
+    else {
+        return Buffer.from(b.buffer, b.byteOffset, b.byteLength).toString('base64');
+    }
+}
+/**
+ * Encodes Unpadded Base64.
+ * @category Utilities
+ * @param {ArrayBuffer | Uint8Array} b The buffer to encode.
+ * @returns {string} The Base64 string.
+ */
+function encodeUnpaddedBase64(b) {
+    return encodeBase64(b).replace(/=+/g, '');
+}
+/**
+ * Encodes URL-Safe Unpadded Base64.
+ * @category Utilities
+ * @param {ArrayBuffer | Uint8Array} b The buffer to encode.
+ * @returns {string} The Base64 string.
+ */
+function encodeUnpaddedUrlSafeBase64(b) {
+    return encodeUnpaddedBase64(b).replace(/\+/g, '-').replace(/\//g, '_');
+}
+/**
+ * Decodes Base64.
+ * @category Utilities
+ * @param {string} s The Base64 string.
+ * @returns {Uint8Array} The encoded data as a buffer.
+ */
+function decodeBase64(s) {
+    return Buffer.from(s, 'base64');
+}
+/**
+ * Decodes Unpadded Base64.
+ * @category Utilities
+ * @param {string} s The Base64 string.
+ * @returns {Uint8Array} The encoded data as a buffer.
+ */
+function decodeUnpaddedBase64(s) {
+    return decodeBase64(s); // yay, it's the same
+}
+/**
+ * Decodes URL-Safe Unpadded Base64.
+ * @category Utilities
+ * @param {string} s The Base64 string.
+ * @returns {Uint8Array} The encoded data as a buffer.
+ */
+function decodeUnpaddedUrlSafeBase64(s) {
+    return decodeUnpaddedBase64(s.replace(/-/g, '+').replace(/_/g, '/'));
+}
+//# sourceMappingURL=b64.js.map

package/lib/b64.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"b64.js","sourceRoot":"","sources":["../src/b64.ts"],"names":[],"mappings":";;AAMA,oCAMC;AAQD,oDAEC;AAQD,kEAEC;AAQD,oCAEC;AAQD,oDAEC;AAQD,kEAEC;AA9DD;;;;;GAKG;AACH,SAAgB,YAAY,CAAC,CAA2B;IACpD,IAAI,CAAC,YAAY,WAAW,EAAE,CAAC;QAC3B,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC7C,CAAC;SAAM,CAAC;QACJ,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAChF,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,SAAgB,oBAAoB,CAAC,CAA2B;IAC5D,OAAO,YAAY,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;AAC9C,CAAC;AAED;;;;;GAKG;AACH,SAAgB,2BAA2B,CAAC,CAA2B;IACnE,OAAO,oBAAoB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AAC3E,CAAC;AAED;;;;;GAKG;AACH,SAAgB,YAAY,CAAC,CAAS;IAClC,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;AACpC,CAAC;AAED;;;;;GAKG;AACH,SAAgB,oBAAoB,CAAC,CAAS;IAC1C,OAAO,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,qBAAqB;AACjD,CAAC;AAED;;;;;GAKG;AACH,SAAgB,2BAA2B,CAAC,CAAS;IACjD,OAAO,oBAAoB,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;AACzE,CAAC"}

package/lib/e2ee/CrossSigningBootstrap.d.ts

@@ -0,0 +1,73 @@
+import { MatrixClient } from "../MatrixClient";
+import { UIACallback } from "./RustEngine";
+export type { UIACallback };
+/**
+ * The subset of RustEngine used by the cross-signing helpers below.
+ * @internal
+ */
+export interface CrossSigningEngine {
+    bootstrapCrossSigning(uiaCallback: UIACallback, reset?: boolean): Promise<void>;
+    bootstrapSecretStorageFromPassphrase(passphrase: string, opts?: {
+        withKeyBackup?: boolean;
+        reset?: boolean;
+    }): Promise<void>;
+    restoreSecretsFromSecretStorage(passphrase: string): Promise<void>;
+}
+/**
+ * Result of {@link CryptoClient.ensureCrossSigning}.
+ * - `already-signed`: our device was already signed by the account's self-signing key.
+ * - `restored`: the cross-signing keys were restored from secret storage (no reset).
+ * - `bootstrapped`: a new cross-signing identity was created and uploaded (reset).
+ * - `skipped-no-auth`: bootstrapping was needed, but no UIA callback was given.
+ * @category Encryption
+ */
+export type EnsureCrossSigningResult = "already-signed" | "restored" | "bootstrapped" | "skipped-no-auth";
+/**
+ * Result of {@link CryptoClient.ensureSecretStorage}.
+ * @category Encryption
+ */
+export type EnsureSecretStorageResult = "already-configured" | "bootstrapped";
+/**
+ * Options for {@link CryptoClient.ensureCrossSigning}.
+ * @category Encryption
+ */
+export interface EnsureCrossSigningOptions {
+    /**
+     * Answers the UIA challenge when uploading new cross-signing keys. Without it,
+     * bootstrapping is skipped. See {@link passwordUiaCallback}.
+     */
+    uiaCallback?: UIACallback;
+    /**
+     * Secret storage passphrase. When set and the account has secret storage, the
+     * existing cross-signing keys are restored from it before falling back to a reset.
+     */
+    recoveryPassphrase?: string;
+}
+/**
+ * Builds a UIA callback that answers with an `m.login.password` stage.
+ * @category Encryption
+ */
+export declare function passwordUiaCallback(userId: string, password: string): UIACallback;
+/**
+ * Checks whether the given device is signed by the account's self-signing key.
+ *
+ * This deliberately checks our device, not just whether the account has a master
+ * key: another client may have set up cross-signing without ever signing us.
+ * @internal
+ */
+export declare function isOwnDeviceCrossSigned(client: MatrixClient, deviceId: string): Promise<boolean>;
+/**
+ * Checks whether the account has a default secret storage key configured.
+ * @internal
+ */
+export declare function hasSecretStorage(client: MatrixClient): Promise<boolean>;
+/**
+ * @internal
+ */
+export declare function ensureCrossSigning(client: MatrixClient, engine: CrossSigningEngine, deviceId: string, opts: EnsureCrossSigningOptions): Promise<EnsureCrossSigningResult>;
+/**
+ * @internal
+ */
+export declare function ensureSecretStorage(client: MatrixClient, engine: CrossSigningEngine, passphrase: string, opts: {
+    withKeyBackup?: boolean;
+}): Promise<EnsureSecretStorageResult>;

package/lib/e2ee/CrossSigningBootstrap.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.passwordUiaCallback = passwordUiaCallback;
+exports.isOwnDeviceCrossSigned = isOwnDeviceCrossSigned;
+exports.hasSecretStorage = hasSecretStorage;
+exports.ensureCrossSigning = ensureCrossSigning;
+exports.ensureSecretStorage = ensureSecretStorage;
+const LogService_1 = require("../logging/LogService");
+/**
+ * Builds a UIA callback that answers with an `m.login.password` stage.
+ * @category Encryption
+ */
+function passwordUiaCallback(userId, password) {
+    return async (uia) => ({
+        type: "m.login.password",
+        identifier: { type: "m.id.user", user: userId },
+        password,
+        session: uia.session,
+    });
+}
+/**
+ * Checks whether the given device is signed by the account's self-signing key.
+ *
+ * This deliberately checks our device, not just whether the account has a master
+ * key: another client may have set up cross-signing without ever signing us.
+ * @internal
+ */
+async function isOwnDeviceCrossSigned(client, deviceId) {
+    const userId = await client.getUserId();
+    const resp = await client.doRequest("POST", "/_matrix/client/v3/keys/query", null, {
+        device_keys: { [userId]: [] },
+    });
+    const selfSigningKeyIds = Object.keys(resp?.["self_signing_keys"]?.[userId]?.["keys"] ?? {});
+    const deviceSignatures = resp?.["device_keys"]?.[userId]?.[deviceId]?.["signatures"]?.[userId] ?? {};
+    return selfSigningKeyIds.some((keyId) => keyId in deviceSignatures);
+}
+/**
+ * Checks whether the account has a default secret storage key configured.
+ * @internal
+ */
+async function hasSecretStorage(client) {
+    try {
+        const data = await client.getAccountData("m.secret_storage.default_key");
+        return Boolean(data?.key);
+    }
+    catch {
+        // getAccountData throws (404) when the event doesn't exist.
+        return false;
+    }
+}
+/**
+ * @internal
+ */
+async function ensureCrossSigning(client, engine, deviceId, opts) {
+    if (await isOwnDeviceCrossSigned(client, deviceId)) {
+        return "already-signed";
+    }
+    if (opts.recoveryPassphrase && await hasSecretStorage(client)) {
+        try {
+            await engine.restoreSecretsFromSecretStorage(opts.recoveryPassphrase);
+            return "restored";
+        }
+        catch (e) {
+            LogService_1.LogService.warn("CryptoClient", "Restoring cross-signing keys from secret storage failed, falling back to a reset:", e);
+        }
+    }
+    if (!opts.uiaCallback) {
+        return "skipped-no-auth";
+    }
+    // Neither signed nor restorable: create a fresh identity. This replaces any
+    // existing cross-signing keys on the account, so other devices' trust in the
+    // old identity is lost.
+    await engine.bootstrapCrossSigning(opts.uiaCallback, true);
+    return "bootstrapped";
+}
+/**
+ * @internal
+ */
+async function ensureSecretStorage(client, engine, passphrase, opts) {
+    if (await hasSecretStorage(client)) {
+        return "already-configured";
+    }
+    await engine.bootstrapSecretStorageFromPassphrase(passphrase, { withKeyBackup: opts.withKeyBackup ?? true });
+    return "bootstrapped";
+}
+//# sourceMappingURL=CrossSigningBootstrap.js.map

package/lib/e2ee/CrossSigningBootstrap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CrossSigningBootstrap.js","sourceRoot":"","sources":["../../src/e2ee/CrossSigningBootstrap.ts"],"names":[],"mappings":";;AAqDA,kDAOC;AASD,wDAQC;AAMD,4CAQC;AAKD,gDA4BC;AAKD,kDAWC;AA3ID,sDAAmD;AAgDnD;;;GAGG;AACH,SAAgB,mBAAmB,CAAC,MAAc,EAAE,QAAgB;IAChE,OAAO,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;QACnB,IAAI,EAAE,kBAAkB;QACxB,UAAU,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE;QAC/C,QAAQ;QACR,OAAO,EAAE,GAAG,CAAC,OAAO;KACvB,CAAC,CAAC;AACP,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,sBAAsB,CAAC,MAAoB,EAAE,QAAgB;IAC/E,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,SAAS,EAAE,CAAC;IACxC,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,+BAA+B,EAAE,IAAI,EAAE;QAC/E,WAAW,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE;KAChC,CAAC,CAAC;IACH,MAAM,iBAAiB,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,mBAAmB,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;IAC7F,MAAM,gBAAgB,GAAG,IAAI,EAAE,CAAC,aAAa,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,YAAY,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;IACrG,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,IAAI,gBAAgB,CAAC,CAAC;AACxE,CAAC;AAED;;;GAGG;AACI,KAAK,UAAU,gBAAgB,CAAC,MAAoB;IACvD,IAAI,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,cAAc,CAAmB,8BAA8B,CAAC,CAAC;QAC3F,OAAO,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAC9B,CAAC;IAAC,MAAM,CAAC;QACL,4DAA4D;QAC5D,OAAO,KAAK,CAAC;IACjB,CAAC;AACL,CAAC;AAED;;GAEG;AACI,KAAK,UAAU,kBAAkB,CACpC,MAAoB,EACpB,MAA0B,EAC1B,QAAgB,EAChB,IAA+B;IAE/B,IAAI,MAAM,sBAAsB,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC;QACjD,OAAO,gBAAgB,CAAC;IAC5B,CAAC;IAED,IAAI,IAAI,CAAC,kBAAkB,IAAI,MAAM,gBAAgB,CAAC,MAAM,CAAC,EAAE,CAAC;QAC5D,IAAI,CAAC;YACD,MAAM,MAAM,CAAC,+BAA+B,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;YACtE,OAAO,UAAU,CAAC;QACtB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACT,uBAAU,CAAC,IAAI,CAAC,cAAc,EAAE,mFAAmF,EAAE,CAAC,CAAC,CAAC;QAC5H,CAAC;IACL,CAAC;IAED,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;QACpB,OAAO,iBAAiB,CAAC;IAC7B,CAAC;IAED,4EAA4E;IAC5E,6EAA6E;IAC7E,wBAAwB;IACxB,MAAM,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;IAC3D,OAAO,cAAc,CAAC;AAC1B,CAAC;AAED;;GAEG;AACI,KAAK,UAAU,mBAAmB,CACrC,MAAoB,EACpB,MAA0B,EAC1B,UAAkB,EAClB,IAAiC;IAEjC,IAAI,MAAM,gBAAgB,CAAC,MAAM,CAAC,EAAE,CAAC;QACjC,OAAO,oBAAoB,CAAC;IAChC,CAAC;IACD,MAAM,MAAM,CAAC,oCAAoC,CAAC,UAAU,EAAE,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,IAAI,IAAI,EAAE,CAAC,CAAC;IAC7G,OAAO,cAAc,CAAC;AAC1B,CAAC"}