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

package/lib/models/events/RoomTopicEvent.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RoomTopicEvent = void 0;
+const RoomEvent_1 = require("./RoomEvent");
+/**
+ * Represents an m.room.topic state event
+ * @category Matrix events
+ */
+class RoomTopicEvent extends RoomEvent_1.StateEvent {
+    constructor(event) {
+        super(event);
+    }
+    /**
+     * The topic of the room.
+     */
+    get topic() {
+        return this.content.topic;
+    }
+}
+exports.RoomTopicEvent = RoomTopicEvent;
+//# sourceMappingURL=RoomTopicEvent.js.map

package/lib/models/events/RoomTopicEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RoomTopicEvent.js","sourceRoot":"","sources":["../../../src/models/events/RoomTopicEvent.ts"],"names":[],"mappings":";;;AAAA,2CAAyC;AAWzC;;;GAGG;AACH,MAAa,cAAe,SAAQ,sBAAiC;IACjE,YAAY,KAAU;QAClB,KAAK,CAAC,KAAK,CAAC,CAAC;IACjB,CAAC;IAED;;OAEG;IACH,IAAW,KAAK;QACZ,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;IAC9B,CAAC;CACJ;AAXD,wCAWC"}

package/lib/models/events/SpaceChildEvent.d.ts

@@ -0,0 +1,53 @@
+import { StateEvent } from "./RoomEvent";
+/**
+ * The content definition for m.space.child events
+ * @category Matrix event contents
+ * @see SpaceChildEvent
+ */
+export interface SpaceChildEventContent {
+    /**
+     * The servers the client should provide to the server when trying to join the room.
+     * When not provided or empty, the child is considered not part of the space.
+     */
+    via: string[];
+    /**
+     * A short string to differentiate the rendering order of entities.
+     * @see validateSpaceOrderString
+     */
+    order?: string;
+    /**
+     * Whether or not the entity is intended to be a suggested entity.
+     */
+    suggested?: boolean;
+}
+/**
+ * Represents an m.space.child state event
+ * @category Matrix events
+ */
+export declare class SpaceChildEvent extends StateEvent<SpaceChildEventContent> {
+    constructor(event: any);
+    /**
+     * The room ID of the space or room this child represents.
+     */
+    get entityRoomId(): string;
+    /**
+     * Whether or not this child is "active" or valid. Inactive children are
+     * not considered part of a space.
+     */
+    get isActiveChild(): boolean;
+    /**
+     * The servers the client should provide to the homeserver when trying to
+     * join the entity (room). May be empty or falsey to denote the child is
+     * inactive.
+     */
+    get viaServers(): string[];
+    /**
+     * An optional short string to differentiate the rendering order of entities.
+     * @see validateSpaceOrderString
+     */
+    get order(): string;
+    /**
+     * Whether or not the child is a suggested entity for users to join.
+     */
+    get suggested(): boolean;
+}

package/lib/models/events/SpaceChildEvent.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SpaceChildEvent = void 0;
+const RoomEvent_1 = require("./RoomEvent");
+/**
+ * Represents an m.space.child state event
+ * @category Matrix events
+ */
+class SpaceChildEvent extends RoomEvent_1.StateEvent {
+    constructor(event) {
+        super(event);
+    }
+    /**
+     * The room ID of the space or room this child represents.
+     */
+    get entityRoomId() {
+        return this.stateKey;
+    }
+    /**
+     * Whether or not this child is "active" or valid. Inactive children are
+     * not considered part of a space.
+     */
+    get isActiveChild() {
+        return !!this.viaServers?.length;
+    }
+    /**
+     * The servers the client should provide to the homeserver when trying to
+     * join the entity (room). May be empty or falsey to denote the child is
+     * inactive.
+     */
+    get viaServers() {
+        return this.content.via;
+    }
+    /**
+     * An optional short string to differentiate the rendering order of entities.
+     * @see validateSpaceOrderString
+     */
+    get order() {
+        return this.content.order;
+    }
+    /**
+     * Whether or not the child is a suggested entity for users to join.
+     */
+    get suggested() {
+        return this.content.suggested ?? false;
+    }
+}
+exports.SpaceChildEvent = SpaceChildEvent;
+//# sourceMappingURL=SpaceChildEvent.js.map

package/lib/models/events/SpaceChildEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SpaceChildEvent.js","sourceRoot":"","sources":["../../../src/models/events/SpaceChildEvent.ts"],"names":[],"mappings":";;;AAAA,2CAAyC;AA0BzC;;;GAGG;AACH,MAAa,eAAgB,SAAQ,sBAAkC;IACnE,YAAY,KAAU;QAClB,KAAK,CAAC,KAAK,CAAC,CAAC;IACjB,CAAC;IAED;;OAEG;IACH,IAAW,YAAY;QACnB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAED;;;OAGG;IACH,IAAW,aAAa;QACpB,OAAO,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACH,IAAW,UAAU;QACjB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACH,IAAW,KAAK;QACZ,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;IAC9B,CAAC;IAED;;OAEG;IACH,IAAW,SAAS;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,KAAK,CAAC;IAC3C,CAAC;CACJ;AA3CD,0CA2CC"}

package/lib/models/events/converter.d.ts

@@ -0,0 +1,8 @@
+import { RoomEvent } from "./RoomEvent";
+/**
+ * Wraps a room event into a more suitable container.
+ * @param {any} event The event object to wrap.
+ * @returns {RoomEvent<any>} An instance of the most suitable container for the event.
+ * @category Matrix events
+ */
+export declare function wrapRoomEvent(event: any): RoomEvent<any>;

package/lib/models/events/converter.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.wrapRoomEvent = wrapRoomEvent;
+const MembershipEvent_1 = require("./MembershipEvent");
+const RoomEvent_1 = require("./RoomEvent");
+const MessageEvent_1 = require("./MessageEvent");
+/**
+ * Wraps a room event into a more suitable container.
+ * @param {any} event The event object to wrap.
+ * @returns {RoomEvent<any>} An instance of the most suitable container for the event.
+ * @category Matrix events
+ */
+function wrapRoomEvent(event) {
+    if (!event)
+        return null;
+    if (typeof (event['state_key']) === 'string') {
+        if (event['type'] === 'm.room.member') {
+            return new MembershipEvent_1.MembershipEvent(event);
+        }
+        else {
+            return new RoomEvent_1.StateEvent(event);
+        }
+    }
+    else if (event['type'] === 'm.room.message') {
+        const content = event['content'];
+        const msgtype = content ? content['msgtype'] : null;
+        if (msgtype === "m.text" || msgtype === "m.notice" || msgtype === "m.emote") {
+            return new MessageEvent_1.MessageEvent(event);
+        }
+        else if (msgtype === "m.audio") {
+            return new MessageEvent_1.MessageEvent(event);
+        }
+        else if (msgtype === "m.video") {
+            return new MessageEvent_1.MessageEvent(event);
+        }
+        else if (msgtype === "m.image") {
+            return new MessageEvent_1.MessageEvent(event);
+        }
+        else if (msgtype === "m.location") {
+            return new MessageEvent_1.MessageEvent(event);
+        }
+        else {
+            return new MessageEvent_1.MessageEvent(event);
+        }
+    }
+    else {
+        return new RoomEvent_1.RoomEvent(event);
+    }
+}
+//# sourceMappingURL=converter.js.map

package/lib/models/events/converter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"converter.js","sourceRoot":"","sources":["../../../src/models/events/converter.ts"],"names":[],"mappings":";;AAkBA,sCA4BC;AA9CD,uDAAoD;AACpD,2CAAoD;AACpD,iDAQwB;AAExB;;;;;GAKG;AACH,SAAgB,aAAa,CAAC,KAAU;IACpC,IAAI,CAAC,KAAK;QAAE,OAAO,IAAI,CAAC;IAExB,IAAI,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;QAC3C,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,eAAe,EAAE,CAAC;YACpC,OAAO,IAAI,iCAAe,CAAC,KAAK,CAAC,CAAC;QACtC,CAAC;aAAM,CAAC;YACJ,OAAO,IAAI,sBAAU,CAAM,KAAK,CAAC,CAAC;QACtC,CAAC;IACL,CAAC;SAAM,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,gBAAgB,EAAE,CAAC;QAC5C,MAAM,OAAO,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;QACjC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACpD,IAAI,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,UAAU,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1E,OAAO,IAAI,2BAAY,CAA6B,KAAK,CAAC,CAAC;QAC/D,CAAC;aAAM,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC/B,OAAO,IAAI,2BAAY,CAA2B,KAAK,CAAC,CAAC;QAC7D,CAAC;aAAM,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC/B,OAAO,IAAI,2BAAY,CAA2B,KAAK,CAAC,CAAC;QAC7D,CAAC;aAAM,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC/B,OAAO,IAAI,2BAAY,CAA2B,KAAK,CAAC,CAAC;QAC7D,CAAC;aAAM,IAAI,OAAO,KAAK,YAAY,EAAE,CAAC;YAClC,OAAO,IAAI,2BAAY,CAA8B,KAAK,CAAC,CAAC;QAChE,CAAC;aAAM,CAAC;YACJ,OAAO,IAAI,2BAAY,CAAsB,KAAK,CAAC,CAAC;QACxD,CAAC;IACL,CAAC;SAAM,CAAC;QACJ,OAAO,IAAI,qBAAS,CAAM,KAAK,CAAC,CAAC;IACrC,CAAC;AACL,CAAC"}

package/lib/models/unstable/MediaInfo.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This interface implements the schema defined in [MSC2380](https://github.com/matrix-org/matrix-doc/pull/2380).
+ * @category Unstable APIs
+ */
+export interface MSC2380MediaInfo {
+    content_type: string;
+    width?: number;
+    height?: number;
+    size: number;
+    thumbnails?: {
+        width: number;
+        height: number;
+        ready: boolean;
+    }[];
+    duration?: number;
+}

package/lib/models/unstable/MediaInfo.js

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

package/lib/models/unstable/MediaInfo.js.map

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

package/lib/preprocessors/IPreprocessor.d.ts

@@ -0,0 +1,22 @@
+import { MatrixClient } from "../MatrixClient";
+import { EventKind } from "..";
+/**
+ * Represents a preprocessor.
+ * @category Preprocessors
+ */
+export interface IPreprocessor {
+    /**
+     * Gets the types of events this preprocessor supports.
+     */
+    getSupportedEventTypes(): string[];
+    /**
+     * Processes an event, modifying it in-place if needed.
+     * @param {any} event The event that should be processed.
+     * @param {MatrixClient} client The Matrix client that is providing the event.
+     * @param {EventKind|null|undefined} kind Optional kind identifier for an event. When not
+     * supplied, the event is assumed to be a RoomEvent.
+     * @returns {Promise<any>} Resolved when the event is has been modified. The resolved
+     * value is ignored.
+     */
+    processEvent(event: any, client: MatrixClient, kind?: EventKind): Promise<any>;
+}

package/lib/preprocessors/IPreprocessor.js

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

package/lib/preprocessors/IPreprocessor.js.map

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

package/lib/preprocessors/RichRepliesPreprocessor.d.ts

@@ -0,0 +1,67 @@
+import { MatrixClient } from "../MatrixClient";
+import { IPreprocessor } from "./IPreprocessor";
+import { EventKind } from "..";
+/**
+ * Metadata for a rich reply. Usually stored under the "mx_richreply"
+ * field of an event (at the top level).
+ * @category Preprocessors
+ * @see RichRepliesPreprocessor
+ */
+export interface IRichReplyMetadata {
+    /**
+     * If true, the preprocessor found some inconsistencies in the reply
+     * information that does not match the specification. For example,
+     * this may indicate that a reply was sent without an HTML component.
+     */
+    wasLenient: boolean;
+    /**
+     * The event ID the event references. May be an empty string if
+     * wasLenient is true.
+     */
+    parentEventId: string;
+    /**
+     * The fallback plain text the preprocessor found. May be an empty
+     * string if wasLenient is true. The prefix characters to indicate
+     * this is a fallback will have already been removed.
+     */
+    fallbackPlainBody: string;
+    /**
+     * The fallback HTML the processor found. May be an empty string if
+     * wasLenient is true. The fallback structure will have already been
+     * removed, leaving just the original assumed HTML.
+     */
+    fallbackHtmlBody: string;
+    /**
+     * The user ID that sent the parent event, as determined by the fallback
+     * text. This should not be relied upon for anything serious, and instead
+     * the preprocessor should be configured to fetch the real event to
+     * populate the realEvent property. May be an empty string if wasLenient
+     * is true.
+     */
+    fallbackSender: string;
+    /**
+     * If the preprocessor is configured to fetch event content, this field
+     * will contain the event as reported by the homeserver. May be null if
+     * wasLenient is true.
+     */
+    realEvent: any;
+}
+/**
+ * Processes rich replies found in events. This automatically strips
+ * the fallback representation from events, providing the information
+ * as a top level "mx_richreply" key. The "mx_richreply" property may
+ * be cast to the type IRichReplyMetadata.
+ * @category Preprocessors
+ */
+export declare class RichRepliesPreprocessor implements IPreprocessor {
+    private fetchRealEventContents;
+    /**
+     * Creates a new rich replies preprocessor.
+     * @param fetchRealEventContents If enabled, this preprocessor will
+     * attempt to get the real event contents and append them to the event
+     * information.
+     */
+    constructor(fetchRealEventContents?: boolean);
+    getSupportedEventTypes(): string[];
+    processEvent(event: any, client: MatrixClient, kind?: EventKind): Promise<any>;
+}

package/lib/preprocessors/RichRepliesPreprocessor.js

@@ -0,0 +1,112 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RichRepliesPreprocessor = void 0;
+const __1 = require("..");
+/**
+ * Processes rich replies found in events. This automatically strips
+ * the fallback representation from events, providing the information
+ * as a top level "mx_richreply" key. The "mx_richreply" property may
+ * be cast to the type IRichReplyMetadata.
+ * @category Preprocessors
+ */
+class RichRepliesPreprocessor {
+    /**
+     * Creates a new rich replies preprocessor.
+     * @param fetchRealEventContents If enabled, this preprocessor will
+     * attempt to get the real event contents and append them to the event
+     * information.
+     */
+    constructor(fetchRealEventContents = false) {
+        this.fetchRealEventContents = fetchRealEventContents;
+    }
+    getSupportedEventTypes() {
+        return ["m.room.message"];
+    }
+    async processEvent(event, client, kind) {
+        if (kind && kind !== __1.EventKind.RoomEvent)
+            return;
+        if (!event["content"])
+            return;
+        if (!event["content"]["m.relates_to"])
+            return;
+        if (!event["content"]["m.relates_to"]["m.in_reply_to"])
+            return;
+        const parentEventId = event["content"]["m.relates_to"]["m.in_reply_to"]["event_id"];
+        if (!parentEventId)
+            return;
+        let fallbackHtml = "";
+        let fallbackText = "";
+        let fallbackSender = "";
+        let realHtml = event["content"]["formatted_body"];
+        let realText = event["content"]["body"];
+        let lenient = false;
+        if (event["content"]["format"] !== "org.matrix.custom.html" || !event["content"]["formatted_body"]) {
+            lenient = true; // Not safe to parse: probably not HTML
+        }
+        else {
+            const formattedBody = event["content"]["formatted_body"];
+            if (!formattedBody.startsWith("<mx-reply>") || formattedBody.indexOf("</mx-reply>") === -1) {
+                lenient = true; // Doesn't look like a reply
+            }
+            else {
+                const parts = formattedBody.split("</mx-reply>");
+                const fbHtml = parts[0];
+                realHtml = parts[1];
+                const results = fbHtml.match(/<br[ ]*[/]{0,2}>(.*)<\/blockquote>\s*$/i);
+                if (!results) {
+                    lenient = true;
+                }
+                else {
+                    fallbackHtml = results[1];
+                }
+            }
+        }
+        let processedFallback = false;
+        const body = event["content"]["body"] || "";
+        for (const line of body.split("\n")) {
+            if (line.startsWith("> ") && !processedFallback) {
+                fallbackText += line.substring(2) + "\n";
+            }
+            else if (!processedFallback) {
+                realText = "";
+                processedFallback = true;
+            }
+            else {
+                realText += line + "\n";
+            }
+        }
+        const firstFallbackLine = fallbackText.split("\n")[0];
+        const matches = firstFallbackLine.match(/<(@.*:.*)>/);
+        if (!matches) {
+            lenient = true;
+        }
+        else {
+            fallbackSender = matches[1];
+        }
+        const metadata = {
+            wasLenient: lenient,
+            fallbackHtmlBody: fallbackHtml ? fallbackHtml.trim() : "",
+            fallbackPlainBody: fallbackText ? fallbackText.trim() : "",
+            fallbackSender: fallbackSender ? fallbackSender.trim() : "",
+            parentEventId: parentEventId ? parentEventId.trim() : "",
+            realEvent: null,
+        };
+        if (this.fetchRealEventContents) {
+            try {
+                metadata.realEvent = await client.getEvent(event["room_id"], parentEventId);
+            }
+            catch (e) {
+                __1.LogService.error("RichRepliesPreprocessor", "Failed to fetch real event:");
+                __1.LogService.error("RichRepliesPreprocessor", (0, __1.extractRequestError)(e));
+                metadata.wasLenient = true; // failed to fetch event
+            }
+        }
+        event["mx_richreply"] = metadata;
+        event["content"]["body"] = realText.trim();
+        if (realHtml)
+            event["content"]["formatted_body"] = realHtml.trim();
+        return event;
+    }
+}
+exports.RichRepliesPreprocessor = RichRepliesPreprocessor;
+//# sourceMappingURL=RichRepliesPreprocessor.js.map

package/lib/preprocessors/RichRepliesPreprocessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RichRepliesPreprocessor.js","sourceRoot":"","sources":["../../src/preprocessors/RichRepliesPreprocessor.ts"],"names":[],"mappings":";;;AAEA,0BAAgE;AAqDhE;;;;;;GAMG;AACH,MAAa,uBAAuB;IAChC;;;;;OAKG;IACH,YAA2B,yBAAyB,KAAK;QAA9B,2BAAsB,GAAtB,sBAAsB,CAAQ;IACzD,CAAC;IAEM,sBAAsB;QACzB,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC9B,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,KAAU,EAAE,MAAoB,EAAE,IAAgB;QACxE,IAAI,IAAI,IAAI,IAAI,KAAK,aAAS,CAAC,SAAS;YAAE,OAAO;QAEjD,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC;YAAE,OAAO;QAC9B,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC;YAAE,OAAO;QAC9C,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,CAAC,eAAe,CAAC;YAAE,OAAO;QAE/D,MAAM,aAAa,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,CAAC,eAAe,CAAC,CAAC,UAAU,CAAC,CAAC;QACpF,IAAI,CAAC,aAAa;YAAE,OAAO;QAE3B,IAAI,YAAY,GAAG,EAAE,CAAC;QACtB,IAAI,YAAY,GAAG,EAAE,CAAC;QACtB,IAAI,cAAc,GAAG,EAAE,CAAC;QACxB,IAAI,QAAQ,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,gBAAgB,CAAC,CAAC;QAClD,IAAI,QAAQ,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;QACxC,IAAI,OAAO,GAAG,KAAK,CAAC;QAEpB,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,KAAK,wBAAwB,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACjG,OAAO,GAAG,IAAI,CAAC,CAAC,uCAAuC;QAC3D,CAAC;aAAM,CAAC;YACJ,MAAM,aAAa,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,gBAAgB,CAAC,CAAC;YACzD,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,YAAY,CAAC,IAAI,aAAa,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;gBACzF,OAAO,GAAG,IAAI,CAAC,CAAC,4BAA4B;YAChD,CAAC;iBAAM,CAAC;gBACJ,MAAM,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;gBACjD,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;gBACxB,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;gBAEpB,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,yCAAyC,CAAC,CAAC;gBACxE,IAAI,CAAC,OAAO,EAAE,CAAC;oBACX,OAAO,GAAG,IAAI,CAAC;gBACnB,CAAC;qBAAM,CAAC;oBACJ,YAAY,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;gBAC9B,CAAC;YACL,CAAC;QACL,CAAC;QAED,IAAI,iBAAiB,GAAG,KAAK,CAAC;QAC9B,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QAC5C,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YAClC,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;gBAC9C,YAAY,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;YAC7C,CAAC;iBAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;gBAC5B,QAAQ,GAAG,EAAE,CAAC;gBACd,iBAAiB,GAAG,IAAI,CAAC;YAC7B,CAAC;iBAAM,CAAC;gBACJ,QAAQ,IAAI,IAAI,GAAG,IAAI,CAAC;YAC5B,CAAC;QACL,CAAC;QAED,MAAM,iBAAiB,GAAG,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACtD,MAAM,OAAO,GAAG,iBAAiB,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QACtD,IAAI,CAAC,OAAO,EAAE,CAAC;YACX,OAAO,GAAG,IAAI,CAAC;QACnB,CAAC;aAAM,CAAC;YACJ,cAAc,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QAChC,CAAC;QAED,MAAM,QAAQ,GAAuB;YACjC,UAAU,EAAE,OAAO;YACnB,gBAAgB,EAAE,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE;YACzD,iBAAiB,EAAE,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE;YAC1D,cAAc,EAAE,cAAc,CAAC,CAAC,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE;YAC3D,aAAa,EAAE,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE;YACxD,SAAS,EAAE,IAAI;SAClB,CAAC;QAEF,IAAI,IAAI,CAAC,sBAAsB,EAAE,CAAC;YAC9B,IAAI,CAAC;gBACD,QAAQ,CAAC,SAAS,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,aAAa,CAAC,CAAC;YAChF,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACT,cAAU,CAAC,KAAK,CAAC,yBAAyB,EAAE,6BAA6B,CAAC,CAAC;gBAC3E,cAAU,CAAC,KAAK,CAAC,yBAAyB,EAAE,IAAA,uBAAmB,EAAC,CAAC,CAAC,CAAC,CAAC;gBACpE,QAAQ,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC,wBAAwB;YACxD,CAAC;QACL,CAAC;QAED,KAAK,CAAC,cAAc,CAAC,GAAG,QAAQ,CAAC;QACjC,KAAK,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC3C,IAAI,QAAQ;YAAE,KAAK,CAAC,SAAS,CAAC,CAAC,gBAAgB,CAAC,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;QACnE,OAAO,KAAK,CAAC;IACjB,CAAC;CACJ;AAhGD,0DAgGC"}

package/lib/request.d.ts

@@ -0,0 +1,13 @@
+import * as origRequestFn from "request";
+/**
+ * Sets the function to use for performing HTTP requests. Must be compatible with `request`.
+ * @param fn The new request function.
+ * @category Unit testing
+ */
+export declare function setRequestFn(fn: any): void;
+/**
+ * Gets the `request`-compatible function for performing HTTP requests.
+ * @returns The request function.
+ * @category Unit testing
+ */
+export declare function getRequestFn(): typeof origRequestFn;

package/lib/request.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setRequestFn = setRequestFn;
+exports.getRequestFn = getRequestFn;
+const origRequestFn = require("request");
+let requestFn = origRequestFn;
+/**
+ * Sets the function to use for performing HTTP requests. Must be compatible with `request`.
+ * @param fn The new request function.
+ * @category Unit testing
+ */
+function setRequestFn(fn) {
+    requestFn = fn;
+}
+/**
+ * Gets the `request`-compatible function for performing HTTP requests.
+ * @returns The request function.
+ * @category Unit testing
+ */
+function getRequestFn() {
+    return requestFn;
+}
+//# sourceMappingURL=request.js.map

package/lib/request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.js","sourceRoot":"","sources":["../src/request.ts"],"names":[],"mappings":";;AASA,oCAEC;AAOD,oCAEC;AApBD,yCAAyC;AAEzC,IAAI,SAAS,GAAG,aAAa,CAAC;AAE9B;;;;GAIG;AACH,SAAgB,YAAY,CAAC,EAAE;IAC3B,SAAS,GAAG,EAAE,CAAC;AACnB,CAAC;AAED;;;;GAIG;AACH,SAAgB,YAAY;IACxB,OAAO,SAAS,CAAC;AACrB,CAAC"}

package/lib/simple-validation.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Validate the 'order' parameter of a child space entry. It must be a
+ * string between the range of \x20 - \x7F and contain no more than 50
+ * characters.
+ * @param {string} order The 'order' parameter of a m.space.child
+ * @throws {Error} If the string is not valid
+ * @returns {boolean} True if the string is valid
+ * @category Utilities
+ */
+export declare function validateSpaceOrderString(order: string): true;

package/lib/simple-validation.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateSpaceOrderString = validateSpaceOrderString;
+/**
+ * Validate the 'order' parameter of a child space entry. It must be a
+ * string between the range of \x20 - \x7F and contain no more than 50
+ * characters.
+ * @param {string} order The 'order' parameter of a m.space.child
+ * @throws {Error} If the string is not valid
+ * @returns {boolean} True if the string is valid
+ * @category Utilities
+ */
+function validateSpaceOrderString(order) {
+    if (typeof (order) !== 'string') {
+        // Just in case, even though TS should catch this.
+        throw Error('order is not a string');
+    }
+    if (order.length === 0) {
+        throw Error('order cannot be empty');
+    }
+    if (order.length > 50) {
+        throw Error('order is more than 50 characters and is disallowed');
+    }
+    if (!order.match(/^[\x20-\x7E]+$/)) {
+        // String must be between this range
+        throw Error('order contained characters outside the range of the spec.');
+    }
+    return true;
+}
+//# sourceMappingURL=simple-validation.js.map

package/lib/simple-validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"simple-validation.js","sourceRoot":"","sources":["../src/simple-validation.ts"],"names":[],"mappings":";;AASA,4DAoBC;AA7BD;;;;;;;;GAQG;AACH,SAAgB,wBAAwB,CAAC,KAAa;IAClD,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE,CAAC;QAC9B,kDAAkD;QAClD,MAAM,KAAK,CAAC,uBAAuB,CAAC,CAAC;IACzC,CAAC;IAED,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrB,MAAM,KAAK,CAAC,uBAAuB,CAAC,CAAC;IACzC,CAAC;IAED,IAAI,KAAK,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;QACpB,MAAM,KAAK,CAAC,oDAAoD,CAAC,CAAC;IACtE,CAAC;IAED,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE,CAAC;QACjC,oCAAoC;QACpC,MAAM,KAAK,CAAC,2DAA2D,CAAC,CAAC;IAC7E,CAAC;IAED,OAAO,IAAI,CAAC;AAChB,CAAC"}

package/lib/storage/IAppserviceStorageProvider.d.ts

@@ -0,0 +1,48 @@
+import { ICryptoStorageProvider } from "./ICryptoStorageProvider";
+import { IStorageProvider } from "./IStorageProvider";
+/**
+ * A storage provider definition for appservices to use.
+ * @category Storage providers
+ */
+export interface IAppserviceStorageProvider {
+    /**
+     * Tracks a user ID as "registered".
+     * @returns {Promise<any>|void} Resolves when complete.
+     */
+    addRegisteredUser(userId: string): Promise<any> | void;
+    /**
+     * Determines if a user ID is registered or not.
+     * @returns {boolean|Promise<boolean>} True if registered. This may be a promise.
+     */
+    isUserRegistered(userId: string): boolean | Promise<boolean>;
+    /**
+     * Flags a transaction as completed.
+     * @param {string} transactionId The transaction ID.
+     * @returns {Promise<any>|void} Resolves when complete.
+     */
+    setTransactionCompleted(transactionId: string): Promise<any> | void;
+    /**
+     * Determines if a transaction has been flagged as completed.
+     * @param {string} transactionId The transaction ID to check.
+     * @returns {boolean} True if the transaction has been completed. This may be a promise.
+     */
+    isTransactionCompleted(transactionId: string): boolean | Promise<boolean>;
+    /**
+     * Gets a storage provider to use for the given user ID.
+     * @param {string} userId The user ID.
+     * @returns {ICryptoStorageProvider} The storage provider.
+     */
+    storageForUser?(userId: string): IStorageProvider;
+}
+/**
+ * A storage provider capable of only providing crypto-related storage to appservices.
+ * @category Storage providers
+ */
+export interface IAppserviceCryptoStorageProvider {
+    /**
+     * Gets a storage provider to use for the given user ID.
+     * @param {string} userId The user ID.
+     * @returns {ICryptoStorageProvider} The storage provider.
+     */
+    storageForUser(userId: string): ICryptoStorageProvider;
+}

package/lib/storage/IAppserviceStorageProvider.js

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

package/lib/storage/IAppserviceStorageProvider.js.map

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

package/lib/storage/ICryptoStorageProvider.d.ts

@@ -0,0 +1,32 @@
+import { ICryptoRoomInformation } from "../e2ee/ICryptoRoomInformation";
+/**
+ * A storage provider capable of only providing crypto-related storage.
+ * @category Storage providers
+ */
+export interface ICryptoStorageProvider {
+    /**
+     * Sets the client's device ID.
+     * @param {string} deviceId The device ID.
+     * @returns {Promise<void>} Resolves when complete.
+     */
+    setDeviceId(deviceId: string): Promise<void>;
+    /**
+     * Gets the client's device ID, if known.
+     * @returns {Promise<string>} Resolves to the device ID, or falsy if not known.
+     */
+    getDeviceId(): Promise<string>;
+    /**
+     * Stores a room's configuration.
+     * @param {string} roomId The room ID to store the configuration for.
+     * @param {ICryptoRoomInformation} config The room's encryption config. May be empty.
+     * @returns {Promise<void>} Resolves when complete.
+     */
+    storeRoom(roomId: string, config: ICryptoRoomInformation): Promise<void>;
+    /**
+     * Gets a room's configuration. If the room is unknown, a falsy value is returned.
+     * @param {string} roomId The room ID to get the configuration for.
+     * @returns {Promise<ICryptoRoomInformation>} Resolves to the room's configuration, or
+     * to falsy if the room is unknown.
+     */
+    getRoom(roomId: string): Promise<ICryptoRoomInformation>;
+}

package/lib/storage/ICryptoStorageProvider.js

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

package/lib/storage/ICryptoStorageProvider.js.map

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