first commit

node_modules/matrix-bot-sdk/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>;
+}

node_modules/matrix-bot-sdk/lib/preprocessors/IPreprocessor.js

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

node_modules/matrix-bot-sdk/lib/preprocessors/IPreprocessor.js.map

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

node_modules/matrix-bot-sdk/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>;
+}

node_modules/matrix-bot-sdk/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

node_modules/matrix-bot-sdk/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;YAChG,OAAO,GAAG,IAAI,CAAC,CAAC,uCAAuC;SAC1D;aAAM;YACH,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;gBACxF,OAAO,GAAG,IAAI,CAAC,CAAC,4BAA4B;aAC/C;iBAAM;gBACH,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;oBACV,OAAO,GAAG,IAAI,CAAC;iBAClB;qBAAM;oBACH,YAAY,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;iBAC7B;aACJ;SACJ;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;YACjC,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;gBAC7C,YAAY,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;aAC5C;iBAAM,IAAI,CAAC,iBAAiB,EAAE;gBAC3B,QAAQ,GAAG,EAAE,CAAC;gBACd,iBAAiB,GAAG,IAAI,CAAC;aAC5B;iBAAM;gBACH,QAAQ,IAAI,IAAI,GAAG,IAAI,CAAC;aAC3B;SACJ;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;YACV,OAAO,GAAG,IAAI,CAAC;SAClB;aAAM;YACH,cAAc,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;SAC/B;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;YAC7B,IAAI;gBACA,QAAQ,CAAC,SAAS,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,aAAa,CAAC,CAAC;aAC/E;YAAC,OAAO,CAAC,EAAE;gBACR,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;aACvD;SACJ;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"}