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

package/lib/SynapseAdminApis.js

@@ -0,0 +1,244 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SynapseAdminApis = exports.SynapseRoomProperty = void 0;
+const MatrixError_1 = require("./models/MatrixError");
+/**
+ * Available properties on a Synapse room listing to order by.
+ * @category Admin APIs
+ */
+var SynapseRoomProperty;
+(function (SynapseRoomProperty) {
+    SynapseRoomProperty["Name"] = "name";
+    SynapseRoomProperty["CanonicalAlias"] = "canonical_alias";
+    SynapseRoomProperty["JoinedMembers"] = "joined_members";
+    SynapseRoomProperty["JoinedLocalMembers"] = "joined_local_members";
+    SynapseRoomProperty["Version"] = "version";
+    SynapseRoomProperty["Creator"] = "creator";
+    SynapseRoomProperty["Encryption"] = "encryption";
+    SynapseRoomProperty["CanFederate"] = "federatable";
+    SynapseRoomProperty["IsPublic"] = "public";
+    SynapseRoomProperty["JoinRules"] = "join_rules";
+    SynapseRoomProperty["GuestAccess"] = "guest_access";
+    SynapseRoomProperty["HistoryVisibility"] = "history_visibility";
+    SynapseRoomProperty["NumStateEvents"] = "state_events";
+})(SynapseRoomProperty || (exports.SynapseRoomProperty = SynapseRoomProperty = {}));
+/**
+ * Access to various administrative APIs specifically available in Synapse.
+ * @category Admin APIs
+ */
+class SynapseAdminApis {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Get information about a user. The client making the request must be an admin user.
+     * @param {string} userId The user ID to check.
+     * @returns {Promise<SynapseUser>} The resulting Synapse user record
+     */
+    async getUser(userId) {
+        return this.client.doRequest("GET", "/_synapse/admin/v2/users/" + encodeURIComponent(userId));
+    }
+    /**
+     * Create or update a given user on a Synapse server. The
+     * client making the request must be an admin user.
+     * @param {string} userId The user ID to check.
+     * @param {SynapseUserProperties} opts Options to set when creating or updating the user.
+     * @returns {Promise<SynapseUser>} The resulting Synapse user record
+     */
+    async upsertUser(userId, opts = {}) {
+        return this.client.doRequest("PUT", "/_synapse/admin/v2/users/" + encodeURIComponent(userId), undefined, opts);
+    }
+    /**
+     * Get a list of users registered with Synapse, optionally filtered by some criteria. The
+     * client making the request must be an admin user.
+     * @param {string} from The token to continue listing users from.
+     * @param {number} limit The maximum number of users to request.
+     * @param {string} name Optional localpart or display name filter for results.
+     * @param {boolean} guests Whether or not to include guest accounts. Default true.
+     * @param {boolean} deactivated Whether or not to include deactivated accounts. Default false.
+     * @returns {Promise<SynapseUserList>} A batch of user results.
+     */
+    async listUsers(from, limit, name, guests = true, deactivated = false) {
+        const qs = { guests, deactivated };
+        if (from)
+            qs['from'] = from;
+        if (limit)
+            qs['limit'] = limit;
+        if (name)
+            qs['name'] = name;
+        return this.client.doRequest("GET", "/_synapse/admin/v2/users", qs);
+    }
+    /**
+     * Get a list of all users registered with Synapse, optionally filtered by some criteria. The
+     * client making the request must be an admin user.
+     *
+     * This method returns an async generator that can be used to filter results.
+     * @param options Options to pass to the user listing function
+     * @example
+     * for await (const user of synapseAdminApis.listAllUsers()) {
+     *    if (user.name === '@alice:example.com') {
+     *       return user;
+     *    }
+     * }
+     */
+    async *listAllUsers(options = {}) {
+        let from = undefined;
+        let response;
+        do {
+            const qs = {
+                ...options,
+                ...(from && { from }),
+            };
+            response = await this.client.doRequest("GET", "/_synapse/admin/v2/users", qs);
+            for (const user of response.users) {
+                yield user;
+            }
+            from = response.next_token;
+        } while (from);
+    }
+    /**
+     * Determines if the given user is a Synapse server administrator for this homeserver. The
+     * client making the request must be an admin user themselves (check with `isSelfAdmin`)
+     * @param {string} userId The user ID to check.
+     * @returns {Promise<boolean>} Resolves to true if the user is an admin, false otherwise.
+     * Throws if there's an error.
+     */
+    async isAdmin(userId) {
+        const response = await this.client.doRequest("GET", `/_synapse/admin/v1/users/${encodeURIComponent(userId)}/admin`);
+        return response['admin'] || false;
+    }
+    /**
+     * Determines if the current user is an admin for the Synapse homeserver.
+     * @returns {Promise<boolean>} Resolve to true if the user is an admin, false otherwise.
+     * Throws if there's an error.
+     */
+    async isSelfAdmin() {
+        try {
+            return await this.isAdmin(await this.client.getUserId());
+        }
+        catch (err) {
+            if (err instanceof MatrixError_1.MatrixError && err.errcode === 'M_FORBIDDEN') {
+                return false;
+            }
+            throw err;
+        }
+    }
+    /**
+     * Lists the rooms on the server.
+     * @param {string} searchTerm A term to search for in the room names
+     * @param {string} from A previous batch token to search from
+     * @param {number} limit The maximum number of rooms to return
+     * @param {SynapseRoomProperty} orderBy A property of rooms to order by
+     * @param {boolean} reverseOrder True to reverse the orderBy direction.
+     * @returns {Promise<SynapseRoomList>} Resolves to the server's rooms, ordered and filtered.
+     */
+    async listRooms(searchTerm, from, limit, orderBy, reverseOrder = false) {
+        const params = {};
+        if (from)
+            params['from'] = from;
+        if (limit)
+            params['limit'] = limit;
+        if (searchTerm)
+            params['search_term'] = searchTerm;
+        if (orderBy)
+            params['order_by'] = orderBy;
+        if (reverseOrder) {
+            params['dir'] = 'b';
+        }
+        else {
+            params['dir'] = 'f';
+        }
+        return this.client.doRequest("GET", "/_synapse/admin/v1/rooms", params);
+    }
+    /**
+     * Gets a list of state events in a room.
+     * @param {string} roomId The room ID to get state for.
+     * @returns {Promise<any[]>} Resolves to the room's state events.
+     */
+    async getRoomState(roomId) {
+        const r = await this.client.doRequest("GET", `/_synapse/admin/v1/rooms/${encodeURIComponent(roomId)}/state`);
+        return r?.['state'] || [];
+    }
+    /**
+     * Deletes a room from the server, purging all record of it.
+     * @param {string} roomId The room to delete.
+     * @returns {Promise} Resolves when complete.
+     */
+    async deleteRoom(roomId) {
+        return this.client.doRequest("DELETE", `/_synapse/admin/v2/rooms/${encodeURIComponent(roomId)}`, {}, { purge: true });
+    }
+    /**
+     * Gets the status of all active deletion tasks, and all those completed in the last 24h, for the given room_id.
+     * @param {string} roomId The room ID to get deletion state for.
+     * @returns {Promise<any[]>} Resolves to the room's deletion status results.
+     */
+    async getDeleteRoomState(roomId) {
+        const r = await this.client.doRequest("GET", `/_synapse/admin/v2/rooms/${encodeURIComponent(roomId)}/delete_status`);
+        return r?.['results'] || [];
+    }
+    /**
+     * List all registration tokens on the homeserver.
+     * @param valid If true, only valid tokens are returned.
+     * If false, only tokens that have expired or have had all uses exhausted are returned.
+     * If omitted, all tokens are returned regardless of validity.
+
+     * @returns An array of registration tokens.
+     */
+    async listRegistrationTokens(valid) {
+        const res = await this.client.doRequest("GET", `/_synapse/admin/v1/registration_tokens`, { valid });
+        return res.registration_tokens;
+    }
+    /**
+     * Get details about a single token.
+     * @param token The token to fetch.
+     * @returns A registration tokens, or null if not found.
+     */
+    async getRegistrationToken(token) {
+        try {
+            return await this.client.doRequest("GET", `/_synapse/admin/v1/registration_tokens/${encodeURIComponent(token)}`);
+        }
+        catch (e) {
+            if (e?.statusCode === 404) {
+                return null;
+            }
+            throw e;
+        }
+    }
+    /**
+     * Create a new registration token.
+     * @param options Options to pass to the request.
+     * @returns The newly created token.
+     */
+    async createRegistrationToken(options = {}) {
+        return this.client.doRequest("POST", `/_synapse/admin/v1/registration_tokens/new`, undefined, options);
+    }
+    /**
+     * Update an existing registration token.
+     * @param token The token to update.
+     * @param options Options to pass to the request.
+     * @returns The newly created token.
+     */
+    async updateRegistrationToken(token, options) {
+        return this.client.doRequest("PUT", `/_synapse/admin/v1/registration_tokens/${encodeURIComponent(token)}`, undefined, options);
+    }
+    /**
+     * Delete a registration token
+     * @param token The token to update.
+     * @returns A promise that resolves upon success.
+     */
+    async deleteRegistrationToken(token) {
+        return this.client.doRequest("DELETE", `/_synapse/admin/v1/registration_tokens/${encodeURIComponent(token)}`, undefined, {});
+    }
+    /**
+     * Grants another user the highest power available to a local user who is in the room.
+     * If the user is not in the room, and it is not publicly joinable, then invite the user.
+     * @param roomId The room to make the user admin in.
+     * @param userId The user to make admin in the room. If undefined, it uses the authenticated user.
+     * @returns Resolves when complete.
+     */
+    async makeRoomAdmin(roomId, userId) {
+        return this.client.doRequest("POST", `/_synapse/admin/v1/rooms/${encodeURIComponent(roomId)}/make_room_admin`, {}, { user_id: userId });
+    }
+}
+exports.SynapseAdminApis = SynapseAdminApis;
+//# sourceMappingURL=SynapseAdminApis.js.map

package/lib/SynapseAdminApis.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SynapseAdminApis.js","sourceRoot":"","sources":["../src/SynapseAdminApis.ts"],"names":[],"mappings":";;;AACA,sDAAmD;AAuMnD;;;GAGG;AACH,IAAY,mBAcX;AAdD,WAAY,mBAAmB;IAC3B,oCAAa,CAAA;IACb,yDAAkC,CAAA;IAClC,uDAAgC,CAAA;IAChC,kEAA2C,CAAA;IAC3C,0CAAmB,CAAA;IACnB,0CAAmB,CAAA;IACnB,gDAAyB,CAAA;IACzB,kDAA2B,CAAA;IAC3B,0CAAmB,CAAA;IACnB,+CAAwB,CAAA;IACxB,mDAA4B,CAAA;IAC5B,+DAAwC,CAAA;IACxC,sDAA+B,CAAA;AACnC,CAAC,EAdW,mBAAmB,mCAAnB,mBAAmB,QAc9B;AAqCD;;;GAGG;AACH,MAAa,gBAAgB;IACzB,YAAoB,MAAoB;QAApB,WAAM,GAAN,MAAM,CAAc;IACxC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,OAAO,CAAC,MAAc;QAC/B,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CACxB,KAAK,EAAE,2BAA2B,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAClE,CAAC;IACN,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,UAAU,CAAC,MAAc,EAAE,OAA8B,EAAE;QACpE,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CACxB,KAAK,EAAE,2BAA2B,GAAG,kBAAkB,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,IAAI,CACnF,CAAC;IACN,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,SAAS,CAAC,IAAa,EAAE,KAAc,EAAE,IAAa,EAAE,MAAM,GAAG,IAAI,EAAE,WAAW,GAAG,KAAK;QACnG,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;QACnC,IAAI,IAAI;YAAE,EAAE,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAC5B,IAAI,KAAK;YAAE,EAAE,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC;QAC/B,IAAI,IAAI;YAAE,EAAE,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAC5B,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,0BAA0B,EAAE,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,KAAK,CAAA,CAAE,YAAY,CAAC,UAAkC,EAAE;QAC3D,IAAI,IAAI,GAAuB,SAAS,CAAC;QACzC,IAAI,QAAyB,CAAC;QAC9B,GAAG,CAAC;YACA,MAAM,EAAE,GAAG;gBACP,GAAG,OAAO;gBACV,GAAG,CAAC,IAAI,IAAI,EAAE,IAAI,EAAE,CAAC;aACxB,CAAC;YACF,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,0BAA0B,EAAE,EAAE,CAAC,CAAC;YAC9E,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;gBAChC,MAAM,IAAI,CAAC;YACf,CAAC;YACD,IAAI,GAAG,QAAQ,CAAC,UAAU,CAAC;QAC/B,CAAC,QAAQ,IAAI,EAAE;IACnB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,OAAO,CAAC,MAAc;QAC/B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,4BAA4B,kBAAkB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACpH,OAAO,QAAQ,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,WAAW;QACpB,IAAI,CAAC;YACD,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;QAC7D,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,IAAI,GAAG,YAAY,yBAAW,IAAI,GAAG,CAAC,OAAO,KAAK,aAAa,EAAE,CAAC;gBAC9D,OAAO,KAAK,CAAC;YACjB,CAAC;YACD,MAAM,GAAG,CAAC;QACd,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,SAAS,CAAC,UAAmB,EAAE,IAAa,EAAE,KAAc,EAAE,OAA6B,EAAE,YAAY,GAAG,KAAK;QAC1H,MAAM,MAAM,GAAG,EAAE,CAAC;QAClB,IAAI,IAAI;YAAE,MAAM,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAChC,IAAI,KAAK;YAAE,MAAM,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC;QACnC,IAAI,UAAU;YAAE,MAAM,CAAC,aAAa,CAAC,GAAG,UAAU,CAAC;QACnD,IAAI,OAAO;YAAE,MAAM,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC;QAC1C,IAAI,YAAY,EAAE,CAAC;YACf,MAAM,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC;QACxB,CAAC;aAAM,CAAC;YACJ,MAAM,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC;QACxB,CAAC;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,0BAA0B,EAAE,MAAM,CAAC,CAAC;IAC5E,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,YAAY,CAAC,MAAc;QACpC,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,4BAA4B,kBAAkB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC7G,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,UAAU,CAAC,MAAc;QAClC,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,4BAA4B,kBAAkB,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAC1H,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,kBAAkB,CAAC,MAAc;QAC1C,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,4BAA4B,kBAAkB,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;QACrH,OAAO,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;IAChC,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,sBAAsB,CAAC,KAAe;QAC/C,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,wCAAwC,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QACpG,OAAO,GAAG,CAAC,mBAAmB,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,oBAAoB,CAAC,KAAa;QAC3C,IAAI,CAAC;YACD,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,0CAA0C,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACrH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACT,IAAI,CAAC,EAAE,UAAU,KAAK,GAAG,EAAE,CAAC;gBACxB,OAAO,IAAI,CAAC;YAChB,CAAC;YACD,MAAM,CAAC,CAAC;QACZ,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,uBAAuB,CAAC,UAA2C,EAAE;QAC9E,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,4CAA4C,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IAC3G,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,uBAAuB,CAAC,KAAa,EAAE,OAA8C;QAC9F,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,0CAA0C,kBAAkB,CAAC,KAAK,CAAC,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACnI,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,uBAAuB,CAAC,KAAa;QAC9C,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,0CAA0C,kBAAkB,CAAC,KAAK,CAAC,EAAE,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC;IACjI,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,aAAa,CAAC,MAAc,EAAE,MAAe;QACtD,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,4BAA4B,kBAAkB,CAAC,MAAM,CAAC,kBAAkB,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;IAC5I,CAAC;CACJ;AA9ND,4CA8NC"}

package/lib/SynchronousMatrixClient.d.ts

@@ -0,0 +1,82 @@
+import { MatrixClient } from "./MatrixClient";
+/**
+ * A MatrixClient class that handles events in sync for the /sync loop, instead
+ * of trying to push its way through the /sync loop as fast as possible. It is
+ * intended that the consumer extend this class and override the onWhatever()
+ * functions it needs. All of the onWhatever() functions have a default behaviour
+ * of doing nothing.
+ */
+export declare abstract class SynchronousMatrixClient extends MatrixClient {
+    /**
+     * Creates a new SynchronousMatrixClient. Note that this accepts a MatrixClient, though
+     * much of the class's properties are not brought over. Always convert your MatrixClient
+     * instance to a SynchronousMatrixClient as soon as possible to avoid diversion in which
+     * properties are proxied over.
+     * @param {MatrixClient} baseClient The client to wrap.
+     */
+    protected constructor(baseClient: MatrixClient);
+    private handleEvent;
+    protected startSyncInternal(): Promise<any>;
+    /**
+     * Handles the `account_data` event raised by the client.
+     * @param {any} event The account data event.
+     * @returns {Promise<any>} Resolves when complete.
+     */
+    protected onAccountData(event: any): Promise<any>;
+    /**
+     * Handles the `room.account_data` event raised by the client.
+     * @param {string} roomId The Room ID the account data applies to.
+     * @param {any} event The room account data event.
+     * @returns {Promise<any>} Resolves when complete.
+     */
+    protected onRoomAccountData(roomId: string, event: any): Promise<any>;
+    /**
+     * Handles the `room.leave` event raised by the client.
+     * @param {string} roomId The Room ID the event happened in.
+     * @param {any} event The event.
+     * @returns {Promise<any>} Resolves when complete.
+     */
+    protected onRoomLeave(roomId: string, event: any): Promise<any>;
+    /**
+     * Handles the `room.invite` event raised by the client.
+     * @param {string} roomId The Room ID the event happened in.
+     * @param {any} event The event.
+     * @returns {Promise<any>} Resolves when complete.
+     */
+    protected onRoomInvite(roomId: string, event: any): Promise<any>;
+    /**
+     * Handles the `room.join` event raised by the client.
+     * @param {string} roomId The Room ID the event happened in.
+     * @param {any} event The event.
+     * @returns {Promise<any>} Resolves when complete.
+     */
+    protected onRoomJoin(roomId: string, event: any): Promise<any>;
+    /**
+     * Handles the `room.message` event raised by the client.
+     * @param {string} roomId The Room ID the event happened in.
+     * @param {any} event The event.
+     * @returns {Promise<any>} Resolves when complete.
+     */
+    protected onRoomMessage(roomId: string, event: any): Promise<any>;
+    /**
+     * Handles the `room.archived` event raised by the client.
+     * @param {string} roomId The Room ID the event happened in.
+     * @param {any} event The event.
+     * @returns {Promise<any>} Resolves when complete.
+     */
+    protected onRoomArchived(roomId: string, event: any): Promise<any>;
+    /**
+     * Handles the `room.upgraded` event raised by the client.
+     * @param {string} roomId The Room ID the event happened in.
+     * @param {any} event The event.
+     * @returns {Promise<any>} Resolves when complete.
+     */
+    protected onRoomUpgraded(roomId: string, event: any): Promise<any>;
+    /**
+     * Handles the `room.event` event raised by the client.
+     * @param {string} roomId The Room ID the event happened in.
+     * @param {any} event The event.
+     * @returns {Promise<any>} Resolves when complete.
+     */
+    protected onRoomEvent(roomId: string, event: any): Promise<any>;
+}

package/lib/SynchronousMatrixClient.js

@@ -0,0 +1,130 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SynchronousMatrixClient = void 0;
+const MatrixClient_1 = require("./MatrixClient");
+/**
+ * A MatrixClient class that handles events in sync for the /sync loop, instead
+ * of trying to push its way through the /sync loop as fast as possible. It is
+ * intended that the consumer extend this class and override the onWhatever()
+ * functions it needs. All of the onWhatever() functions have a default behaviour
+ * of doing nothing.
+ */
+class SynchronousMatrixClient extends MatrixClient_1.MatrixClient {
+    /**
+     * Creates a new SynchronousMatrixClient. Note that this accepts a MatrixClient, though
+     * much of the class's properties are not brought over. Always convert your MatrixClient
+     * instance to a SynchronousMatrixClient as soon as possible to avoid diversion in which
+     * properties are proxied over.
+     * @param {MatrixClient} baseClient The client to wrap.
+     */
+    constructor(baseClient) {
+        super(baseClient.homeserverUrl, baseClient.accessToken, baseClient.storageProvider);
+    }
+    async handleEvent(emitType, arg1, arg2) {
+        if (emitType === 'account_data')
+            await this.onAccountData(arg1);
+        if (emitType === 'room.account_data')
+            await this.onRoomAccountData(arg1, arg2);
+        if (emitType === 'room.leave')
+            await this.onRoomLeave(arg1, arg2);
+        if (emitType === 'room.invite')
+            await this.onRoomInvite(arg1, arg2);
+        if (emitType === 'room.join')
+            await this.onRoomJoin(arg1, arg2);
+        if (emitType === 'room.archived')
+            await this.onRoomArchived(arg1, arg2);
+        if (emitType === 'room.upgraded')
+            await this.onRoomUpgraded(arg1, arg2);
+        if (emitType === 'room.message')
+            await this.onRoomMessage(arg1, arg2);
+        if (emitType === 'room.event')
+            await this.onRoomEvent(arg1, arg2);
+        // Still emit though for easier support of plugins.
+        this.emit(emitType, arg1, arg2);
+    }
+    startSyncInternal() {
+        return this.startSync(this.handleEvent.bind(this));
+    }
+    /**
+     * Handles the `account_data` event raised by the client.
+     * @param {any} event The account data event.
+     * @returns {Promise<any>} Resolves when complete.
+     */
+    onAccountData(event) {
+        return;
+    }
+    /**
+     * Handles the `room.account_data` event raised by the client.
+     * @param {string} roomId The Room ID the account data applies to.
+     * @param {any} event The room account data event.
+     * @returns {Promise<any>} Resolves when complete.
+     */
+    onRoomAccountData(roomId, event) {
+        return;
+    }
+    /**
+     * Handles the `room.leave` event raised by the client.
+     * @param {string} roomId The Room ID the event happened in.
+     * @param {any} event The event.
+     * @returns {Promise<any>} Resolves when complete.
+     */
+    onRoomLeave(roomId, event) {
+        return;
+    }
+    /**
+     * Handles the `room.invite` event raised by the client.
+     * @param {string} roomId The Room ID the event happened in.
+     * @param {any} event The event.
+     * @returns {Promise<any>} Resolves when complete.
+     */
+    onRoomInvite(roomId, event) {
+        return;
+    }
+    /**
+     * Handles the `room.join` event raised by the client.
+     * @param {string} roomId The Room ID the event happened in.
+     * @param {any} event The event.
+     * @returns {Promise<any>} Resolves when complete.
+     */
+    onRoomJoin(roomId, event) {
+        return;
+    }
+    /**
+     * Handles the `room.message` event raised by the client.
+     * @param {string} roomId The Room ID the event happened in.
+     * @param {any} event The event.
+     * @returns {Promise<any>} Resolves when complete.
+     */
+    onRoomMessage(roomId, event) {
+        return;
+    }
+    /**
+     * Handles the `room.archived` event raised by the client.
+     * @param {string} roomId The Room ID the event happened in.
+     * @param {any} event The event.
+     * @returns {Promise<any>} Resolves when complete.
+     */
+    onRoomArchived(roomId, event) {
+        return;
+    }
+    /**
+     * Handles the `room.upgraded` event raised by the client.
+     * @param {string} roomId The Room ID the event happened in.
+     * @param {any} event The event.
+     * @returns {Promise<any>} Resolves when complete.
+     */
+    onRoomUpgraded(roomId, event) {
+        return;
+    }
+    /**
+     * Handles the `room.event` event raised by the client.
+     * @param {string} roomId The Room ID the event happened in.
+     * @param {any} event The event.
+     * @returns {Promise<any>} Resolves when complete.
+     */
+    onRoomEvent(roomId, event) {
+        return;
+    }
+}
+exports.SynchronousMatrixClient = SynchronousMatrixClient;
+//# sourceMappingURL=SynchronousMatrixClient.js.map

package/lib/SynchronousMatrixClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SynchronousMatrixClient.js","sourceRoot":"","sources":["../src/SynchronousMatrixClient.ts"],"names":[],"mappings":";;;AAAA,iDAA8C;AAE9C;;;;;;GAMG;AACH,MAAsB,uBAAwB,SAAQ,2BAAY;IAC9D;;;;;;OAMG;IACH,YAAsB,UAAwB;QAC1C,KAAK,CAAC,UAAU,CAAC,aAAa,EAAE,UAAU,CAAC,WAAW,EAAE,UAAU,CAAC,eAAe,CAAC,CAAC;IACxF,CAAC;IAEO,KAAK,CAAC,WAAW,CAAC,QAAgB,EAAE,IAAS,EAAE,IAAS;QAC5D,IAAI,QAAQ,KAAK,cAAc;YAAE,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAChE,IAAI,QAAQ,KAAK,mBAAmB;YAAE,MAAM,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC/E,IAAI,QAAQ,KAAK,YAAY;YAAE,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAClE,IAAI,QAAQ,KAAK,aAAa;YAAE,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACpE,IAAI,QAAQ,KAAK,WAAW;YAAE,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAChE,IAAI,QAAQ,KAAK,eAAe;YAAE,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACxE,IAAI,QAAQ,KAAK,eAAe;YAAE,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACxE,IAAI,QAAQ,KAAK,cAAc;YAAE,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACtE,IAAI,QAAQ,KAAK,YAAY;YAAE,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAElE,mDAAmD;QACnD,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IACpC,CAAC;IAES,iBAAiB;QACvB,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACO,aAAa,CAAC,KAAU;QAC9B,OAAO;IACX,CAAC;IAED;;;;;OAKG;IACO,iBAAiB,CAAC,MAAc,EAAE,KAAU;QAClD,OAAO;IACX,CAAC;IAED;;;;;OAKG;IACO,WAAW,CAAC,MAAc,EAAE,KAAU;QAC5C,OAAO;IACX,CAAC;IAED;;;;;OAKG;IACO,YAAY,CAAC,MAAc,EAAE,KAAU;QAC7C,OAAO;IACX,CAAC;IAED;;;;;OAKG;IACO,UAAU,CAAC,MAAc,EAAE,KAAU;QAC3C,OAAO;IACX,CAAC;IAED;;;;;OAKG;IACO,aAAa,CAAC,MAAc,EAAE,KAAU;QAC9C,OAAO;IACX,CAAC;IAED;;;;;OAKG;IACO,cAAc,CAAC,MAAc,EAAE,KAAU;QAC/C,OAAO;IACX,CAAC;IAED;;;;;OAKG;IACO,cAAc,CAAC,MAAc,EAAE,KAAU;QAC/C,OAAO;IACX,CAAC;IAED;;;;;OAKG;IACO,WAAW,CAAC,MAAc,EAAE,KAAU;QAC5C,OAAO;IACX,CAAC;CACJ;AAvHD,0DAuHC"}

package/lib/UnstableApis.d.ts

@@ -0,0 +1,43 @@
+import { MatrixClient } from "./MatrixClient";
+import { MSC2380MediaInfo } from "./models/unstable/MediaInfo";
+/**
+ * Unstable APIs that shouldn't be used in most circumstances.
+ * @category Unstable APIs
+ */
+export declare class UnstableApis {
+    private client;
+    constructor(client: MatrixClient);
+    /**
+     * Gets the local room aliases that are published for a given room.
+     * @param {string} roomId The room ID to get local aliases for.
+     * @returns {Promise<string[]>} Resolves to the aliases on the room, or an empty array.
+     * @deprecated Relies on MSC2432 endpoint.
+     */
+    getRoomAliases(roomId: string): Promise<string[]>;
+    /**
+     * Adds a reaction to an event. The contract for this function may change in the future.
+     * @param {string} roomId The room ID to react in
+     * @param {string} eventId The event ID to react against, in the given room
+     * @param {string} emoji The emoji to react with
+     * @returns {Promise<string>} Resolves to the event ID of the reaction
+     */
+    addReactionToEvent(roomId: string, eventId: string, emoji: string): Promise<string>;
+    /**
+     * Get relations for a given event.
+     * @param {string} roomId The room ID to for the given event.
+     * @param {string} eventId The event ID to list relations for.
+     * @param {string?} relationType The type of relations (e.g. `m.room.member`) to filter for. Optional.
+     * @param {string?} eventType The type of event to look for (e.g. `m.room.member`). Optional.
+     * @returns {Promise<{chunk: any[]}>} Resolves to an object containing the chunk of relations
+     * @deprecated Please use the function of the same name in MatrixClient. This will be removed in a future release.
+     */
+    getRelationsForEvent(roomId: string, eventId: string, relationType?: string, eventType?: string): Promise<{
+        chunk: any[];
+    }>;
+    /**
+     * Get information about a media item. Implements MSC2380
+     * @param {string} mxcUrl The MXC to get information about.
+     * @returns {Promise<MSC2380MediaInfo>} Resolves to an object containing the media information.
+     */
+    getMediaInfo(mxcUrl: string): Promise<MSC2380MediaInfo>;
+}

package/lib/UnstableApis.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnstableApis = void 0;
+/**
+ * Unstable APIs that shouldn't be used in most circumstances.
+ * @category Unstable APIs
+ */
+class UnstableApis {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Gets the local room aliases that are published for a given room.
+     * @param {string} roomId The room ID to get local aliases for.
+     * @returns {Promise<string[]>} Resolves to the aliases on the room, or an empty array.
+     * @deprecated Relies on MSC2432 endpoint.
+     */
+    async getRoomAliases(roomId) {
+        const r = await this.client.doRequest("GET", "/_matrix/client/unstable/org.matrix.msc2432/rooms/" + encodeURIComponent(roomId) + "/aliases");
+        return r['aliases'] || [];
+    }
+    /**
+     * Adds a reaction to an event. The contract for this function may change in the future.
+     * @param {string} roomId The room ID to react in
+     * @param {string} eventId The event ID to react against, in the given room
+     * @param {string} emoji The emoji to react with
+     * @returns {Promise<string>} Resolves to the event ID of the reaction
+     */
+    async addReactionToEvent(roomId, eventId, emoji) {
+        return this.client.sendRawEvent(roomId, "m.reaction", {
+            "m.relates_to": {
+                event_id: eventId,
+                key: emoji,
+                rel_type: "m.annotation",
+            },
+        });
+    }
+    /**
+     * Get relations for a given event.
+     * @param {string} roomId The room ID to for the given event.
+     * @param {string} eventId The event ID to list relations for.
+     * @param {string?} relationType The type of relations (e.g. `m.room.member`) to filter for. Optional.
+     * @param {string?} eventType The type of event to look for (e.g. `m.room.member`). Optional.
+     * @returns {Promise<{chunk: any[]}>} Resolves to an object containing the chunk of relations
+     * @deprecated Please use the function of the same name in MatrixClient. This will be removed in a future release.
+     */
+    async getRelationsForEvent(roomId, eventId, relationType, eventType) {
+        let url = `/_matrix/client/unstable/rooms/${encodeURIComponent(roomId)}/relations/${encodeURIComponent(eventId)}`;
+        if (relationType) {
+            url += `/${relationType}`;
+        }
+        if (eventType) {
+            url += `/${eventType}`;
+        }
+        return this.client.doRequest("GET", url);
+    }
+    /**
+     * Get information about a media item. Implements MSC2380
+     * @param {string} mxcUrl The MXC to get information about.
+     * @returns {Promise<MSC2380MediaInfo>} Resolves to an object containing the media information.
+     */
+    async getMediaInfo(mxcUrl) {
+        if (!mxcUrl.toLowerCase().startsWith("mxc://")) {
+            throw Error("'mxcUrl' does not begin with mxc://");
+        }
+        const [domain, mediaId] = mxcUrl.substring("mxc://".length).split("/");
+        if (!domain || !mediaId) {
+            throw Error('Missing domain or media ID');
+        }
+        return this.client.doRequest("GET", `/_matrix/media/unstable/info/${encodeURIComponent(domain)}/${encodeURIComponent(mediaId)}`);
+    }
+}
+exports.UnstableApis = UnstableApis;
+//# sourceMappingURL=UnstableApis.js.map

package/lib/UnstableApis.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UnstableApis.js","sourceRoot":"","sources":["../src/UnstableApis.ts"],"names":[],"mappings":";;;AAGA;;;GAGG;AACH,MAAa,YAAY;IACrB,YAAoB,MAAoB;QAApB,WAAM,GAAN,MAAM,CAAc;IACxC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,cAAc,CAAC,MAAc;QACtC,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,oDAAoD,GAAG,kBAAkB,CAAC,MAAM,CAAC,GAAG,UAAU,CAAC,CAAC;QAC7I,OAAO,CAAC,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;IAC9B,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,kBAAkB,CAAC,MAAc,EAAE,OAAe,EAAE,KAAa;QAC1E,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,YAAY,EAAE;YAClD,cAAc,EAAE;gBACZ,QAAQ,EAAE,OAAO;gBACjB,GAAG,EAAE,KAAK;gBACV,QAAQ,EAAE,cAAc;aAC3B;SACJ,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,oBAAoB,CAAC,MAAc,EAAE,OAAe,EAAE,YAAqB,EAAE,SAAkB;QACxG,IAAI,GAAG,GAAG,kCAAkC,kBAAkB,CAAC,MAAM,CAAC,cAAc,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC;QAClH,IAAI,YAAY,EAAE,CAAC;YACf,GAAG,IAAI,IAAI,YAAY,EAAE,CAAC;QAC9B,CAAC;QACD,IAAI,SAAS,EAAE,CAAC;YACZ,GAAG,IAAI,IAAI,SAAS,EAAE,CAAC;QAC3B,CAAC;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,YAAY,CAAC,MAAc;QACpC,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC7C,MAAM,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACvD,CAAC;QACD,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACvE,IAAI,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;YACtB,MAAM,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAC9C,CAAC;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,gCAAgC,kBAAkB,CAAC,MAAM,CAAC,IAAI,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACrI,CAAC;CACJ;AAnED,oCAmEC"}