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

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 - 2023 Travis Ralston
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,51 @@
-# Temporary Holding Version
+# matrix-bot-sdk
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+> **This is a fork**, published as [`@jeongsu816/matrix-bot-sdk`](https://www.npmjs.com/package/@jeongsu816/matrix-bot-sdk).
+> It is based on upstream [`turt2live/matrix-bot-sdk`](https://github.com/turt2live/matrix-bot-sdk) `main` and adds:
+>
+> - Cross-signing, secret storage (4S) and key backup from upstream PR
+>   [#396](https://github.com/turt2live/matrix-bot-sdk/pull/396), exposed as public `CryptoClient` methods.
+> - Idempotent startup helpers: `client.crypto.ensureCrossSigning()` and `client.crypto.ensureSecretStorage()`.
+> - `@matrix-org/matrix-sdk-crypto-nodejs` pinned to `0.6.1` (required for 4S).
+> - Dependency security fixes: `request` replaced by `@cypress/request`, `sanitize-html` ≥ 2.18.1.
+>   Requires Node.js ≥ 22.12.
+>
+> ```ts
+> import { passwordUiaCallback } from "@jeongsu816/matrix-bot-sdk";
+>
+> // "already-signed" | "restored" | "bootstrapped" | "skipped-no-auth"
+> const result = await client.crypto.ensureCrossSigning({
+>     uiaCallback: password ? passwordUiaCallback(userId, password) : undefined,
+>     recoveryPassphrase,
+> });
+> if (recoveryPassphrase) {
+>     await client.crypto.ensureSecretStorage(recoveryPassphrase); // also sets up key backup
+> }
+> ```
+>
+> `ensureCrossSigning` creates a new identity (replacing the account's existing cross-signing keys) only when
+> this device is not signed and the keys can't be restored from secret storage. Errors are thrown, so wrap it
+> if cross-signing should not be fatal for your bot.
+>
+> The rest of this README is from upstream.
+
+[![npm version](https://badge.fury.io/js/matrix-bot-sdk.svg)](https://www.npmjs.com/package/matrix-bot-sdk)
+
+TypeScript/JavaScript SDK for Matrix bots. For help and support, visit [#matrix-bot-sdk:t2bot.io](https://matrix.to/#/#matrix-bot-sdk:t2bot.io)
+
+# Documentation
+
+Documentation for the project is available [here](https://turt2live.github.io/matrix-bot-sdk/index.html).
+
+# Matrix version support
+
+The Matrix protocol is [versioned](https://spec.matrix.org/latest/#specification-versions) to ensure endpoints and
+functionality can safely rotate in and out of the ecosystem. The bot-sdk will assume it is connected to a homeserver 
+with support for at least one of the last 2 versions, at the time of the bot-sdk's release. This means that if you 
+connect the bot-sdk to a homeserver which is 3 or more Matrix versions out of date, things might not work for you.
+
+It is recommended to update the bot-sdk as frequently as spec releases themselves (or faster) to avoid this situation, 
+and watch the repo for updates in the event a release is delayed.
+
+**Note**: Currently the bot-sdk does not throw an error if the server appears to be incompatible, however this might
+change in the future.

package/lib/AdminApis.d.ts

@@ -0,0 +1,52 @@
+import { MatrixClient } from "./MatrixClient";
+import { SynapseAdminApis } from "./SynapseAdminApis";
+/**
+ * Whois information about a user.
+ * See https://matrix.org/docs/spec/client_server/r0.5.0#get-matrix-client-r0-admin-whois-userid for more information.
+ * @category Admin APIs
+ */
+export interface WhoisInfo {
+    user_id: string;
+    devices: {
+        [device_id: string]: {
+            sessions: [
+                {
+                    connections: WhoisConnectionInfo[];
+                }
+            ];
+        };
+    };
+}
+interface WhoisConnectionInfo {
+    /**
+     * Most recently seen IP address of the session.
+     */
+    ip: string;
+    /**
+     * Unix timestamp that the session was last active.
+     */
+    last_seen: number;
+    /**
+     * User agent string last seen in the session.
+     */
+    user_agent: string;
+}
+/**
+ * Access to various administrative APIs.
+ * @category Admin APIs
+ */
+export declare class AdminApis {
+    private client;
+    constructor(client: MatrixClient);
+    /**
+     * Gets access to the Synapse administrative APIs object.
+     */
+    get synapse(): SynapseAdminApis;
+    /**
+     * Gets information about a particular user.
+     * @param {string} userId the user ID to lookup
+     * @returns {Promise<WhoisInfo>} resolves to the whois information
+     */
+    whoisUser(userId: string): Promise<WhoisInfo>;
+}
+export {};

package/lib/AdminApis.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AdminApis = void 0;
+const SynapseAdminApis_1 = require("./SynapseAdminApis");
+/**
+ * Access to various administrative APIs.
+ * @category Admin APIs
+ */
+class AdminApis {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Gets access to the Synapse administrative APIs object.
+     */
+    get synapse() {
+        return new SynapseAdminApis_1.SynapseAdminApis(this.client);
+    }
+    /**
+     * Gets information about a particular user.
+     * @param {string} userId the user ID to lookup
+     * @returns {Promise<WhoisInfo>} resolves to the whois information
+     */
+    whoisUser(userId) {
+        return this.client.doRequest("GET", "/_matrix/client/v3/admin/whois/" + encodeURIComponent(userId));
+    }
+}
+exports.AdminApis = AdminApis;
+//# sourceMappingURL=AdminApis.js.map

package/lib/AdminApis.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AdminApis.js","sourceRoot":"","sources":["../src/AdminApis.ts"],"names":[],"mappings":";;;AACA,yDAAsD;AAmCtD;;;GAGG;AACH,MAAa,SAAS;IAClB,YAAoB,MAAoB;QAApB,WAAM,GAAN,MAAM,CAAc;IACxC,CAAC;IAED;;OAEG;IACH,IAAW,OAAO;QACd,OAAO,IAAI,mCAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACI,SAAS,CAAC,MAAc;QAC3B,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,iCAAiC,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC;IACxG,CAAC;CACJ;AAnBD,8BAmBC"}

package/lib/DMs.d.ts

@@ -0,0 +1,48 @@
+import { MatrixClient } from "./MatrixClient";
+/**
+ * Handles DM (direct messages) matching between users. Note that bots which
+ * existed prior to this might not have DM rooms populated correctly - the
+ * account data can be populated externally and that will be reflected here.
+ *
+ * Note that DM status is persisted across all access tokens for a user and
+ * is not persisted with the regular stores. The DM map is instead tracked
+ * on the homeserver as account data and thus survives the bot's own storage
+ * being wiped.
+ * @category Utilities
+ */
+export declare class DMs {
+    private client;
+    private cached;
+    private ready;
+    /**
+     * Creates a new DM map.
+     * @param {MatrixClient} client The client the DM map is for.
+     */
+    constructor(client: MatrixClient);
+    private updateFromAccountData;
+    private handleInvite;
+    private persistCache;
+    private fixDms;
+    /**
+     * Forces an update of the DM cache.
+     * @returns {Promise<void>} Resolves when complete.
+     */
+    update(): Promise<void>;
+    /**
+     * Gets or creates a DM with a given user. If a DM needs to be created, it will
+     * be created as an encrypted DM (if both the MatrixClient and target user support
+     * crypto). Otherwise, the createFn can be used to override the call. Note that
+     * when creating a DM room the room should have `is_direct: true` set.
+     * @param {string} userId The user ID to get/create a DM for.
+     * @param {Function} createFn Optional function to use to create the room. Resolves
+     * to the created room ID.
+     * @returns {Promise<string>} Resolves to the DM room ID.
+     */
+    getOrCreateDm(userId: string, createFn?: (targetUserId: string) => Promise<string>): Promise<string>;
+    /**
+     * Determines if a given room is a DM according to the cache.
+     * @param {string} roomId The room ID.
+     * @returns {boolean} True if the room ID is a cached DM room ID.
+     */
+    isDm(roomId: string): boolean;
+}

package/lib/DMs.js

@@ -0,0 +1,160 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DMs = void 0;
+const Crypto_1 = require("./models/Crypto");
+const LogService_1 = require("./logging/LogService");
+/**
+ * Handles DM (direct messages) matching between users. Note that bots which
+ * existed prior to this might not have DM rooms populated correctly - the
+ * account data can be populated externally and that will be reflected here.
+ *
+ * Note that DM status is persisted across all access tokens for a user and
+ * is not persisted with the regular stores. The DM map is instead tracked
+ * on the homeserver as account data and thus survives the bot's own storage
+ * being wiped.
+ * @category Utilities
+ */
+class DMs {
+    /**
+     * Creates a new DM map.
+     * @param {MatrixClient} client The client the DM map is for.
+     */
+    constructor(client) {
+        this.client = client;
+        this.cached = new Map();
+        this.client.on("account_data", (ev) => {
+            if (ev['type'] !== 'm.direct')
+                return;
+            // noinspection JSIgnoredPromiseFromCall
+            this.updateFromAccountData();
+        });
+        this.client.on("room.invite", (rid, ev) => this.handleInvite(rid, ev));
+    }
+    async updateFromAccountData() {
+        // Don't trust the sync update
+        let map = {};
+        try {
+            map = await this.client.getAccountData("m.direct");
+        }
+        catch (e) {
+            if (e.body?.errcode !== "M_NOT_FOUND" && e.statusCode !== 404) {
+                LogService_1.LogService.warn("DMs", "Error getting m.direct account data: ", e);
+            }
+        }
+        this.cached = new Map();
+        for (const [userId, roomIds] of Object.entries(map)) {
+            this.cached.set(userId, roomIds);
+        }
+    }
+    async handleInvite(roomId, ev) {
+        if (ev['content']?.['is_direct'] === true) {
+            const userId = ev['sender'];
+            if (!this.cached.has(userId))
+                this.cached.set(userId, []);
+            this.cached.set(userId, [roomId, ...this.cached.get(userId)]);
+            await this.persistCache();
+        }
+    }
+    async persistCache() {
+        const obj = {};
+        for (const [uid, rids] of this.cached.entries()) {
+            obj[uid] = rids;
+        }
+        await this.client.setAccountData("m.direct", obj);
+    }
+    async fixDms(userId) {
+        const currentRooms = this.cached.get(userId);
+        if (!currentRooms)
+            return;
+        const toKeep = [];
+        for (const roomId of currentRooms) {
+            try {
+                const members = await this.client.getAllRoomMembers(roomId);
+                const joined = members.filter(m => m.effectiveMembership === "join" || m.effectiveMembership === "invite");
+                if (joined.some(m => m.membershipFor === userId)) {
+                    toKeep.push(roomId);
+                }
+            }
+            catch (e) {
+                LogService_1.LogService.warn("DMs", `Unable to check ${roomId} for room members - assuming invalid DM`);
+            }
+        }
+        if (toKeep.length === currentRooms.length)
+            return; // no change
+        if (toKeep.length > 0) {
+            this.cached.set(userId, toKeep);
+        }
+        else {
+            this.cached.delete(userId);
+        }
+        await this.persistCache();
+    }
+    /**
+     * Forces an update of the DM cache.
+     * @returns {Promise<void>} Resolves when complete.
+     */
+    async update() {
+        await this.ready; // finish the existing call if present
+        this.ready = this.updateFromAccountData();
+        return this.ready;
+    }
+    /**
+     * Gets or creates a DM with a given user. If a DM needs to be created, it will
+     * be created as an encrypted DM (if both the MatrixClient and target user support
+     * crypto). Otherwise, the createFn can be used to override the call. Note that
+     * when creating a DM room the room should have `is_direct: true` set.
+     * @param {string} userId The user ID to get/create a DM for.
+     * @param {Function} createFn Optional function to use to create the room. Resolves
+     * to the created room ID.
+     * @returns {Promise<string>} Resolves to the DM room ID.
+     */
+    async getOrCreateDm(userId, createFn) {
+        await this.ready;
+        await this.fixDms(userId);
+        const rooms = this.cached.get(userId);
+        if (rooms?.length)
+            return rooms[0];
+        let roomId;
+        if (createFn) {
+            roomId = await createFn(userId);
+        }
+        else {
+            let hasKeys = false;
+            if (!!this.client.crypto) {
+                const keys = await this.client.getUserDevices([userId]);
+                const userKeys = keys?.device_keys?.[userId] ?? {};
+                hasKeys = Object.values(userKeys).filter(device => Object.values(device).length > 0).length > 0;
+            }
+            roomId = await this.client.createRoom({
+                invite: [userId],
+                is_direct: true,
+                preset: "trusted_private_chat",
+                initial_state: hasKeys ? [{
+                        type: "m.room.encryption",
+                        state_key: "",
+                        content: { algorithm: Crypto_1.EncryptionAlgorithm.MegolmV1AesSha2 },
+                    }] : [],
+            });
+        }
+        if (!this.cached.has(userId))
+            this.cached.set(userId, []);
+        this.cached.set(userId, [roomId, ...this.cached.get(userId)]);
+        await this.persistCache();
+        return roomId;
+    }
+    /**
+     * Determines if a given room is a DM according to the cache.
+     * @param {string} roomId The room ID.
+     * @returns {boolean} True if the room ID is a cached DM room ID.
+     */
+    isDm(roomId) {
+        for (const val of this.cached.values()) {
+            if (val.includes(roomId)) {
+                return true;
+            }
+        }
+        return false;
+    }
+}
+exports.DMs = DMs;
+//# sourceMappingURL=DMs.js.map

package/lib/DMs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DMs.js","sourceRoot":"","sources":["../src/DMs.ts"],"names":[],"mappings":";;;AACA,4CAAsD;AACtD,qDAAkD;AAElD;;;;;;;;;;GAUG;AACH,MAAa,GAAG;IAIZ;;;OAGG;IACH,YAA2B,MAAoB;QAApB,WAAM,GAAN,MAAM,CAAc;QAPvC,WAAM,GAAG,IAAI,GAAG,EAAoB,CAAC;QAQzC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,cAAc,EAAE,CAAC,EAAE,EAAE,EAAE;YAClC,IAAI,EAAE,CAAC,MAAM,CAAC,KAAK,UAAU;gBAAE,OAAO;YAEtC,wCAAwC;YACxC,IAAI,CAAC,qBAAqB,EAAE,CAAC;QACjC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,aAAa,EAAE,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC;IAC3E,CAAC;IAEO,KAAK,CAAC,qBAAqB;QAC/B,8BAA8B;QAC9B,IAAI,GAAG,GAAG,EAAE,CAAC;QACb,IAAI,CAAC;YACD,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QACvD,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACT,IAAI,CAAC,CAAC,IAAI,EAAE,OAAO,KAAK,aAAa,IAAI,CAAC,CAAC,UAAU,KAAK,GAAG,EAAE,CAAC;gBAC5D,uBAAU,CAAC,IAAI,CAAC,KAAK,EAAE,uCAAuC,EAAE,CAAC,CAAC,CAAC;YACvE,CAAC;QACL,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,IAAI,GAAG,EAAoB,CAAC;QAE1C,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YAClD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,OAAmB,CAAC,CAAC;QACjD,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,YAAY,CAAC,MAAc,EAAE,EAAO;QAC9C,IAAI,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,WAAW,CAAC,KAAK,IAAI,EAAE,CAAC;YACxC,MAAM,MAAM,GAAG,EAAE,CAAC,QAAQ,CAAC,CAAC;YAC5B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC;gBAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YAC1D,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAC9D,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QAC9B,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,YAAY;QACtB,MAAM,GAAG,GAA6B,EAAE,CAAC;QACzC,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC;YAC9C,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;QACpB,CAAC;QACD,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;IACtD,CAAC;IAEO,KAAK,CAAC,MAAM,CAAC,MAAc;QAC/B,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC7C,IAAI,CAAC,YAAY;YAAE,OAAO;QAE1B,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,KAAK,MAAM,MAAM,IAAI,YAAY,EAAE,CAAC;YAChC,IAAI,CAAC;gBACD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;gBAC5D,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,mBAAmB,KAAK,MAAM,IAAI,CAAC,CAAC,mBAAmB,KAAK,QAAQ,CAAC,CAAC;gBAC3G,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,aAAa,KAAK,MAAM,CAAC,EAAE,CAAC;oBAC/C,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACxB,CAAC;YACL,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACT,uBAAU,CAAC,IAAI,CAAC,KAAK,EAAE,mBAAmB,MAAM,yCAAyC,CAAC,CAAC;YAC/F,CAAC;QACL,CAAC;QAED,IAAI,MAAM,CAAC,MAAM,KAAK,YAAY,CAAC,MAAM;YAAE,OAAO,CAAC,YAAY;QAE/D,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACpC,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC/B,CAAC;QACD,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,MAAM;QACf,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC,sCAAsC;QACxD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC,KAAK,CAAC;IACtB,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,aAAa,CAAC,MAAc,EAAE,QAAoD;QAC3F,MAAM,IAAI,CAAC,KAAK,CAAC;QACjB,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC1B,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACtC,IAAI,KAAK,EAAE,MAAM;YAAE,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;QAEnC,IAAI,MAAc,CAAC;QACnB,IAAI,QAAQ,EAAE,CAAC;YACX,MAAM,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC,CAAC;QACpC,CAAC;aAAM,CAAC;YACJ,IAAI,OAAO,GAAG,KAAK,CAAC;YACpB,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;gBACvB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;gBACxD,MAAM,QAAQ,GAAG,IAAI,EAAE,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;gBACnD,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;YACpG,CAAC;YACD,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;gBAClC,MAAM,EAAE,CAAC,MAAM,CAAC;gBAChB,SAAS,EAAE,IAAI;gBACf,MAAM,EAAE,sBAAsB;gBAC9B,aAAa,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;wBACtB,IAAI,EAAE,mBAAmB;wBACzB,SAAS,EAAE,EAAE;wBACb,OAAO,EAAE,EAAE,SAAS,EAAE,4BAAmB,CAAC,eAAe,EAAE;qBAC9D,CAAC,CAAC,CAAC,CAAC,EAAE;aACV,CAAC,CAAC;QACP,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC;YAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAC1D,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAC9D,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QAE1B,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACI,IAAI,CAAC,MAAc;QACtB,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC;YACrC,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBACvB,OAAO,IAAI,CAAC;YAChB,CAAC;QACL,CAAC;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;CACJ;AApJD,kBAoJC"}

package/lib/IFilter.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Sync filter information.
+ */
+export interface IFilterInfo {
+    id: number;
+    filter: any;
+}

package/lib/IFilter.js

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

package/lib/IFilter.js.map

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

package/lib/MatrixAuth.d.ts

@@ -0,0 +1,45 @@
+import { MatrixClient } from "./MatrixClient";
+/**
+ * Functions for interacting with Matrix prior to having an access token. Intended
+ * to be used for logging in/registering to get a MatrixClient instance.
+ *
+ * By design, this limits the options used to create the MatrixClient. To specify
+ * custom elements to the client, get the access token from the returned client
+ * and create a new MatrixClient instance. Due to the nature of Matrix, it is
+ * also recommended to use the homeserverUrl from the generated MatrixClient as
+ * it may be different from that given to the MatrixAuth class.
+ */
+export declare class MatrixAuth {
+    private homeserverUrl;
+    /**
+     * Creates a new MatrixAuth class for creating a MatrixClient
+     * @param {string} homeserverUrl The homeserver URL to authenticate against.
+     */
+    constructor(homeserverUrl: string);
+    /**
+     * Generate a client with no access token so we can reuse the doRequest
+     * logic already written.
+     */
+    private createTemplateClient;
+    /**
+     * Performs simple registration using a password for the account. This will
+     * assume the server supports the m.login.password flow for registration, and
+     * will attempt to complete only that stage. The caller is expected to determine
+     * if the homeserver supports registration prior to invocation.
+     * @param {string} localpart The localpart (username) to register
+     * @param {string} password The password to register with
+     * @param {string} deviceName The name of the newly created device. Optional.
+     * @returns {Promise<MatrixClient>} Resolves to a logged-in MatrixClient
+     */
+    passwordRegister(localpart: string, password: string, deviceName?: string): Promise<MatrixClient>;
+    /**
+     * Performs simple password login with the homeserver. The caller is
+     * expected to confirm if the homeserver supports this login flow prior
+     * to invocation.
+     * @param {string} username The username (localpart or user ID) to log in with
+     * @param {string} password The password for the account
+     * @param {string} deviceName The name of the newly created device. Optional.
+     * @returns {Promise<MatrixClient>} Resolves to a logged-in MatrixClient
+     */
+    passwordLogin(username: string, password: string, deviceName?: string): Promise<MatrixClient>;
+}

package/lib/MatrixAuth.js

@@ -0,0 +1,125 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MatrixAuth = void 0;
+const MatrixClient_1 = require("./MatrixClient");
+/**
+ * Functions for interacting with Matrix prior to having an access token. Intended
+ * to be used for logging in/registering to get a MatrixClient instance.
+ *
+ * By design, this limits the options used to create the MatrixClient. To specify
+ * custom elements to the client, get the access token from the returned client
+ * and create a new MatrixClient instance. Due to the nature of Matrix, it is
+ * also recommended to use the homeserverUrl from the generated MatrixClient as
+ * it may be different from that given to the MatrixAuth class.
+ */
+class MatrixAuth {
+    /**
+     * Creates a new MatrixAuth class for creating a MatrixClient
+     * @param {string} homeserverUrl The homeserver URL to authenticate against.
+     */
+    constructor(homeserverUrl) {
+        this.homeserverUrl = homeserverUrl;
+        // nothing to do
+    }
+    /**
+     * Generate a client with no access token so we can reuse the doRequest
+     * logic already written.
+     */
+    createTemplateClient() {
+        return new MatrixClient_1.MatrixClient(this.homeserverUrl, "");
+    }
+    /**
+     * Performs simple registration using a password for the account. This will
+     * assume the server supports the m.login.password flow for registration, and
+     * will attempt to complete only that stage. The caller is expected to determine
+     * if the homeserver supports registration prior to invocation.
+     * @param {string} localpart The localpart (username) to register
+     * @param {string} password The password to register with
+     * @param {string} deviceName The name of the newly created device. Optional.
+     * @returns {Promise<MatrixClient>} Resolves to a logged-in MatrixClient
+     */
+    async passwordRegister(localpart, password, deviceName) {
+        // First try and complete the stage without UIA in hopes the server is kind to us:
+        const body = {
+            username: localpart,
+            password: password,
+            initial_device_display_name: deviceName,
+        };
+        let response;
+        try {
+            response = await this.createTemplateClient().doRequest("POST", "/_matrix/client/v3/register", null, body);
+        }
+        catch (e) {
+            if (e.statusCode === 401) {
+                if (typeof (e.body) === "string")
+                    e.body = JSON.parse(e.body);
+                if (!e.body)
+                    throw new Error(JSON.stringify(Object.keys(e)));
+                // 401 means we need to do UIA, so try and complete a stage
+                const sessionId = e.body['session'];
+                const expectedFlow = ["m.login.dummy"];
+                let hasFlow = false;
+                for (const flow of e.body['flows']) {
+                    const stages = flow['stages'];
+                    if (stages.length !== expectedFlow.length)
+                        continue;
+                    let stagesMatch = true;
+                    for (let i = 0; i < stages.length; i++) {
+                        if (stages[i] !== expectedFlow[i]) {
+                            stagesMatch = false;
+                            break;
+                        }
+                    }
+                    if (stagesMatch) {
+                        hasFlow = true;
+                        break;
+                    }
+                }
+                if (!hasFlow)
+                    throw new Error("Failed to find appropriate login flow in User-Interactive Authentication");
+                body['auth'] = {
+                    type: expectedFlow[0], // HACK: We assume we only have one entry here
+                    session: sessionId,
+                };
+                response = await this.createTemplateClient().doRequest("POST", "/_matrix/client/v3/register", null, body);
+            }
+        }
+        if (!response)
+            throw new Error("Failed to register");
+        const accessToken = response['access_token'];
+        if (!accessToken)
+            throw new Error("No access token returned");
+        return new MatrixClient_1.MatrixClient(this.homeserverUrl, accessToken);
+    }
+    /**
+     * Performs simple password login with the homeserver. The caller is
+     * expected to confirm if the homeserver supports this login flow prior
+     * to invocation.
+     * @param {string} username The username (localpart or user ID) to log in with
+     * @param {string} password The password for the account
+     * @param {string} deviceName The name of the newly created device. Optional.
+     * @returns {Promise<MatrixClient>} Resolves to a logged-in MatrixClient
+     */
+    async passwordLogin(username, password, deviceName) {
+        const body = {
+            type: "m.login.password",
+            identifier: {
+                type: "m.id.user",
+                user: username,
+            },
+            password: password,
+            initial_device_display_name: deviceName,
+        };
+        const response = await this.createTemplateClient().doRequest("POST", "/_matrix/client/v3/login", null, body);
+        const accessToken = response["access_token"];
+        if (!accessToken)
+            throw new Error("Expected access token in response - got nothing");
+        let homeserverUrl = this.homeserverUrl;
+        if (response['well_known'] && response['well_known']['m.homeserver'] && response['well_known']['m.homeserver']['base_url']) {
+            homeserverUrl = response['well_known']['m.homeserver']['base_url'];
+        }
+        return new MatrixClient_1.MatrixClient(homeserverUrl, accessToken);
+    }
+}
+exports.MatrixAuth = MatrixAuth;
+//# sourceMappingURL=MatrixAuth.js.map

package/lib/MatrixAuth.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MatrixAuth.js","sourceRoot":"","sources":["../src/MatrixAuth.ts"],"names":[],"mappings":";;;AAAA,iDAA8C;AAE9C;;;;;;;;;GASG;AACH,MAAa,UAAU;IACnB;;;OAGG;IACH,YAA2B,aAAqB;QAArB,kBAAa,GAAb,aAAa,CAAQ;QAC5C,gBAAgB;IACpB,CAAC;IAED;;;OAGG;IACK,oBAAoB;QACxB,OAAO,IAAI,2BAAY,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,gBAAgB,CAAC,SAAiB,EAAE,QAAgB,EAAE,UAAmB;QAClF,kFAAkF;QAClF,MAAM,IAAI,GAAG;YACT,QAAQ,EAAE,SAAS;YACnB,QAAQ,EAAE,QAAQ;YAClB,2BAA2B,EAAE,UAAU;SAC1C,CAAC;QAEF,IAAI,QAAQ,CAAC;QAEb,IAAI,CAAC;YACD,QAAQ,GAAG,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,6BAA6B,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QAC9G,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACT,IAAI,CAAC,CAAC,UAAU,KAAK,GAAG,EAAE,CAAC;gBACvB,IAAI,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,QAAQ;oBAAE,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;gBAC9D,IAAI,CAAC,CAAC,CAAC,IAAI;oBAAE,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAE7D,2DAA2D;gBAC3D,MAAM,SAAS,GAAG,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBACpC,MAAM,YAAY,GAAG,CAAC,eAAe,CAAC,CAAC;gBAEvC,IAAI,OAAO,GAAG,KAAK,CAAC;gBACpB,KAAK,MAAM,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;oBACjC,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;oBAC9B,IAAI,MAAM,CAAC,MAAM,KAAK,YAAY,CAAC,MAAM;wBAAE,SAAS;oBAEpD,IAAI,WAAW,GAAG,IAAI,CAAC;oBACvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;wBACrC,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;4BAChC,WAAW,GAAG,KAAK,CAAC;4BACpB,MAAM;wBACV,CAAC;oBACL,CAAC;oBAED,IAAI,WAAW,EAAE,CAAC;wBACd,OAAO,GAAG,IAAI,CAAC;wBACf,MAAM;oBACV,CAAC;gBACL,CAAC;gBAED,IAAI,CAAC,OAAO;oBAAE,MAAM,IAAI,KAAK,CAAC,0EAA0E,CAAC,CAAC;gBAE1G,IAAI,CAAC,MAAM,CAAC,GAAG;oBACX,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,8CAA8C;oBACrE,OAAO,EAAE,SAAS;iBACrB,CAAC;gBACF,QAAQ,GAAG,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,6BAA6B,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;YAC9G,CAAC;QACL,CAAC;QAED,IAAI,CAAC,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;QAErD,MAAM,WAAW,GAAG,QAAQ,CAAC,cAAc,CAAC,CAAC;QAC7C,IAAI,CAAC,WAAW;YAAE,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAE9D,OAAO,IAAI,2BAAY,CAAC,IAAI,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,aAAa,CAAC,QAAgB,EAAE,QAAgB,EAAE,UAAmB;QAC9E,MAAM,IAAI,GAAG;YACT,IAAI,EAAE,kBAAkB;YACxB,UAAU,EAAE;gBACR,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,QAAQ;aACjB;YACD,QAAQ,EAAE,QAAQ;YAClB,2BAA2B,EAAE,UAAU;SAC1C,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,0BAA0B,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QAC7G,MAAM,WAAW,GAAG,QAAQ,CAAC,cAAc,CAAC,CAAC;QAC7C,IAAI,CAAC,WAAW;YAAE,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;QAErF,IAAI,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QACvC,IAAI,QAAQ,CAAC,YAAY,CAAC,IAAI,QAAQ,CAAC,YAAY,CAAC,CAAC,cAAc,CAAC,IAAI,QAAQ,CAAC,YAAY,CAAC,CAAC,cAAc,CAAC,CAAC,UAAU,CAAC,EAAE,CAAC;YACzH,aAAa,GAAG,QAAQ,CAAC,YAAY,CAAC,CAAC,cAAc,CAAC,CAAC,UAAU,CAAC,CAAC;QACvE,CAAC;QAED,OAAO,IAAI,2BAAY,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;IACxD,CAAC;CACJ;AApHD,gCAoHC"}