@unwanted/matrix-sdk-mini 34.12.0-1

package/lib/extensible_events_v1/PollStartEvent.js

@@ -0,0 +1,185 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+/*
+Copyright 2022 - 2023 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import { NamespacedValue } from "matrix-events-sdk";
+import { MessageEvent } from "./MessageEvent.js";
+import { isEventTypeSame, M_TEXT } from "../@types/extensible_events.js";
+import { M_POLL_KIND_DISCLOSED, M_POLL_KIND_UNDISCLOSED, M_POLL_START } from "../@types/polls.js";
+import { InvalidEventError } from "./InvalidEventError.js";
+import { ExtensibleEvent } from "./ExtensibleEvent.js";
+
+/**
+ * Represents a poll answer. Note that this is represented as a subtype and is
+ * not registered as a parsable event - it is implied for usage exclusively
+ * within the PollStartEvent parsing.
+ */
+export class PollAnswerSubevent extends MessageEvent {
+  constructor(wireFormat) {
+    super(wireFormat);
+    /**
+     * The answer ID.
+     */
+    _defineProperty(this, "id", void 0);
+    var id = wireFormat.content.id;
+    if (!id || typeof id !== "string") {
+      throw new InvalidEventError("Answer ID must be a non-empty string");
+    }
+    this.id = id;
+  }
+  serialize() {
+    return {
+      type: "org.matrix.sdk.poll.answer",
+      content: _objectSpread({
+        id: this.id
+      }, this.serializeMMessageOnly())
+    };
+  }
+
+  /**
+   * Creates a new PollAnswerSubevent from ID and text.
+   * @param id - The answer ID (unique within the poll).
+   * @param text - The text.
+   * @returns The representative answer.
+   */
+  static from(id, text) {
+    return new PollAnswerSubevent({
+      type: "org.matrix.sdk.poll.answer",
+      content: {
+        id: id,
+        [M_TEXT.name]: text
+      }
+    });
+  }
+}
+
+/**
+ * Represents a poll start event.
+ */
+export class PollStartEvent extends ExtensibleEvent {
+  /**
+   * Creates a new PollStartEvent from a pure format. Note that the event is *not*
+   * parsed here: it will be treated as a literal m.poll.start primary typed event.
+   * @param wireFormat - The event.
+   */
+  constructor(wireFormat) {
+    super(wireFormat);
+    /**
+     * The question being asked, as a MessageEvent node.
+     */
+    _defineProperty(this, "question", void 0);
+    /**
+     * The interpreted kind of poll. Note that this will infer a value that is known to the
+     * SDK rather than verbatim - this means unknown types will be represented as undisclosed
+     * polls.
+     *
+     * To get the raw kind, use rawKind.
+     */
+    _defineProperty(this, "kind", void 0);
+    /**
+     * The true kind as provided by the event sender. Might not be valid.
+     */
+    _defineProperty(this, "rawKind", void 0);
+    /**
+     * The maximum number of selections a user is allowed to make.
+     */
+    _defineProperty(this, "maxSelections", void 0);
+    /**
+     * The possible answers for the poll.
+     */
+    _defineProperty(this, "answers", void 0);
+    var poll = M_POLL_START.findIn(this.wireContent);
+    if (!(poll !== null && poll !== void 0 && poll.question)) {
+      throw new InvalidEventError("A question is required");
+    }
+    this.question = new MessageEvent({
+      type: "org.matrix.sdk.poll.question",
+      content: poll.question
+    });
+    this.rawKind = poll.kind;
+    if (M_POLL_KIND_DISCLOSED.matches(this.rawKind)) {
+      this.kind = M_POLL_KIND_DISCLOSED;
+    } else {
+      this.kind = M_POLL_KIND_UNDISCLOSED; // default & assumed value
+    }
+    this.maxSelections = Number.isFinite(poll.max_selections) && poll.max_selections > 0 ? poll.max_selections : 1;
+    if (!Array.isArray(poll.answers)) {
+      throw new InvalidEventError("Poll answers must be an array");
+    }
+    var answers = poll.answers.slice(0, 20).map(a => new PollAnswerSubevent({
+      type: "org.matrix.sdk.poll.answer",
+      content: a
+    }));
+    if (answers.length <= 0) {
+      throw new InvalidEventError("No answers available");
+    }
+    this.answers = answers;
+  }
+  isEquivalentTo(primaryEventType) {
+    return isEventTypeSame(primaryEventType, M_POLL_START);
+  }
+  serialize() {
+    return {
+      type: M_POLL_START.name,
+      content: {
+        [M_POLL_START.name]: {
+          question: this.question.serialize().content,
+          kind: this.rawKind,
+          max_selections: this.maxSelections,
+          answers: this.answers.map(a => a.serialize().content)
+        },
+        [M_TEXT.name]: "".concat(this.question.text, "\n").concat(this.answers.map((a, i) => "".concat(i + 1, ". ").concat(a.text)).join("\n"))
+      }
+    };
+  }
+
+  /**
+   * Creates a new PollStartEvent from question, answers, and metadata.
+   * @param question - The question to ask.
+   * @param answers - The answers. Should be unique within each other.
+   * @param kind - The kind of poll.
+   * @param maxSelections - The maximum number of selections. Must be 1 or higher.
+   * @returns The representative poll start event.
+   */
+  static from(question, answers, kind) {
+    var maxSelections = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : 1;
+    return new PollStartEvent({
+      type: M_POLL_START.name,
+      content: {
+        [M_TEXT.name]: question,
+        // unused by parsing
+        [M_POLL_START.name]: {
+          question: {
+            [M_TEXT.name]: question
+          },
+          kind: kind instanceof NamespacedValue ? kind.name : kind,
+          max_selections: maxSelections,
+          answers: answers.map(a => ({
+            id: makeId(),
+            [M_TEXT.name]: a
+          }))
+        }
+      }
+    });
+  }
+}
+var LETTERS = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
+function makeId() {
+  return [...Array(16)].map(() => LETTERS.charAt(Math.floor(Math.random() * LETTERS.length))).join("");
+}
+//# sourceMappingURL=PollStartEvent.js.map

package/lib/extensible_events_v1/PollStartEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PollStartEvent.js","names":["NamespacedValue","MessageEvent","isEventTypeSame","M_TEXT","M_POLL_KIND_DISCLOSED","M_POLL_KIND_UNDISCLOSED","M_POLL_START","InvalidEventError","ExtensibleEvent","PollAnswerSubevent","constructor","wireFormat","_defineProperty","id","content","serialize","type","_objectSpread","serializeMMessageOnly","from","text","name","PollStartEvent","poll","findIn","wireContent","question","rawKind","kind","matches","maxSelections","Number","isFinite","max_selections","Array","isArray","answers","slice","map","a","length","isEquivalentTo","primaryEventType","concat","i","join","arguments","undefined","makeId","LETTERS","charAt","Math","floor","random"],"sources":["../../src/extensible_events_v1/PollStartEvent.ts"],"sourcesContent":["/*\nCopyright 2022 - 2023 The Matrix.org Foundation C.I.C.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\nimport { NamespacedValue } from \"matrix-events-sdk\";\n\nimport { MessageEvent } from \"./MessageEvent.ts\";\nimport { ExtensibleEventType, IPartialEvent, isEventTypeSame, M_TEXT } from \"../@types/extensible_events.ts\";\nimport {\n    KnownPollKind,\n    M_POLL_KIND_DISCLOSED,\n    M_POLL_KIND_UNDISCLOSED,\n    M_POLL_START,\n    PollStartEventContent,\n    PollStartSubtype,\n    PollAnswer,\n} from \"../@types/polls.ts\";\nimport { InvalidEventError } from \"./InvalidEventError.ts\";\nimport { ExtensibleEvent } from \"./ExtensibleEvent.ts\";\n\n/**\n * Represents a poll answer. Note that this is represented as a subtype and is\n * not registered as a parsable event - it is implied for usage exclusively\n * within the PollStartEvent parsing.\n */\nexport class PollAnswerSubevent extends MessageEvent {\n    /**\n     * The answer ID.\n     */\n    public readonly id: string;\n\n    public constructor(wireFormat: IPartialEvent<PollAnswer>) {\n        super(wireFormat);\n\n        const id = wireFormat.content.id;\n        if (!id || typeof id !== \"string\") {\n            throw new InvalidEventError(\"Answer ID must be a non-empty string\");\n        }\n        this.id = id;\n    }\n\n    public serialize(): IPartialEvent<object> {\n        return {\n            type: \"org.matrix.sdk.poll.answer\",\n            content: {\n                id: this.id,\n                ...this.serializeMMessageOnly(),\n            },\n        };\n    }\n\n    /**\n     * Creates a new PollAnswerSubevent from ID and text.\n     * @param id - The answer ID (unique within the poll).\n     * @param text - The text.\n     * @returns The representative answer.\n     */\n    public static from(id: string, text: string): PollAnswerSubevent {\n        return new PollAnswerSubevent({\n            type: \"org.matrix.sdk.poll.answer\",\n            content: {\n                id: id,\n                [M_TEXT.name]: text,\n            },\n        });\n    }\n}\n\n/**\n * Represents a poll start event.\n */\nexport class PollStartEvent extends ExtensibleEvent<PollStartEventContent> {\n    /**\n     * The question being asked, as a MessageEvent node.\n     */\n    public readonly question: MessageEvent;\n\n    /**\n     * The interpreted kind of poll. Note that this will infer a value that is known to the\n     * SDK rather than verbatim - this means unknown types will be represented as undisclosed\n     * polls.\n     *\n     * To get the raw kind, use rawKind.\n     */\n    public readonly kind: KnownPollKind;\n\n    /**\n     * The true kind as provided by the event sender. Might not be valid.\n     */\n    public readonly rawKind: string;\n\n    /**\n     * The maximum number of selections a user is allowed to make.\n     */\n    public readonly maxSelections: number;\n\n    /**\n     * The possible answers for the poll.\n     */\n    public readonly answers: PollAnswerSubevent[];\n\n    /**\n     * Creates a new PollStartEvent from a pure format. Note that the event is *not*\n     * parsed here: it will be treated as a literal m.poll.start primary typed event.\n     * @param wireFormat - The event.\n     */\n    public constructor(wireFormat: IPartialEvent<PollStartEventContent>) {\n        super(wireFormat);\n\n        const poll = M_POLL_START.findIn<PollStartSubtype>(this.wireContent);\n\n        if (!poll?.question) {\n            throw new InvalidEventError(\"A question is required\");\n        }\n\n        this.question = new MessageEvent({ type: \"org.matrix.sdk.poll.question\", content: poll.question });\n\n        this.rawKind = poll.kind;\n        if (M_POLL_KIND_DISCLOSED.matches(this.rawKind)) {\n            this.kind = M_POLL_KIND_DISCLOSED;\n        } else {\n            this.kind = M_POLL_KIND_UNDISCLOSED; // default & assumed value\n        }\n\n        this.maxSelections =\n            Number.isFinite(poll.max_selections) && poll.max_selections! > 0 ? poll.max_selections! : 1;\n\n        if (!Array.isArray(poll.answers)) {\n            throw new InvalidEventError(\"Poll answers must be an array\");\n        }\n        const answers = poll.answers.slice(0, 20).map(\n            (a) =>\n                new PollAnswerSubevent({\n                    type: \"org.matrix.sdk.poll.answer\",\n                    content: a,\n                }),\n        );\n        if (answers.length <= 0) {\n            throw new InvalidEventError(\"No answers available\");\n        }\n        this.answers = answers;\n    }\n\n    public isEquivalentTo(primaryEventType: ExtensibleEventType): boolean {\n        return isEventTypeSame(primaryEventType, M_POLL_START);\n    }\n\n    public serialize(): IPartialEvent<object> {\n        return {\n            type: M_POLL_START.name,\n            content: {\n                [M_POLL_START.name]: {\n                    question: this.question.serialize().content,\n                    kind: this.rawKind,\n                    max_selections: this.maxSelections,\n                    answers: this.answers.map((a) => a.serialize().content),\n                },\n                [M_TEXT.name]: `${this.question.text}\\n${this.answers.map((a, i) => `${i + 1}. ${a.text}`).join(\"\\n\")}`,\n            },\n        };\n    }\n\n    /**\n     * Creates a new PollStartEvent from question, answers, and metadata.\n     * @param question - The question to ask.\n     * @param answers - The answers. Should be unique within each other.\n     * @param kind - The kind of poll.\n     * @param maxSelections - The maximum number of selections. Must be 1 or higher.\n     * @returns The representative poll start event.\n     */\n    public static from(\n        question: string,\n        answers: string[],\n        kind: KnownPollKind | string,\n        maxSelections = 1,\n    ): PollStartEvent {\n        return new PollStartEvent({\n            type: M_POLL_START.name,\n            content: {\n                [M_TEXT.name]: question, // unused by parsing\n                [M_POLL_START.name]: {\n                    question: { [M_TEXT.name]: question },\n                    kind: kind instanceof NamespacedValue ? kind.name : kind,\n                    max_selections: maxSelections,\n                    answers: answers.map((a) => ({ id: makeId(), [M_TEXT.name]: a })),\n                },\n            },\n        });\n    }\n}\n\nconst LETTERS = \"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789\";\nfunction makeId(): string {\n    return [...Array(16)].map(() => LETTERS.charAt(Math.floor(Math.random() * LETTERS.length))).join(\"\");\n}\n"],"mappings":";;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,eAAe,QAAQ,mBAAmB;AAEnD,SAASC,YAAY,QAAQ,mBAAmB;AAChD,SAA6CC,eAAe,EAAEC,MAAM,QAAQ,gCAAgC;AAC5G,SAEIC,qBAAqB,EACrBC,uBAAuB,EACvBC,YAAY,QAIT,oBAAoB;AAC3B,SAASC,iBAAiB,QAAQ,wBAAwB;AAC1D,SAASC,eAAe,QAAQ,sBAAsB;;AAEtD;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,kBAAkB,SAASR,YAAY,CAAC;EAM1CS,WAAWA,CAACC,UAAqC,EAAE;IACtD,KAAK,CAACA,UAAU,CAAC;IANrB;AACJ;AACA;IAFIC,eAAA;IAQI,IAAMC,EAAE,GAAGF,UAAU,CAACG,OAAO,CAACD,EAAE;IAChC,IAAI,CAACA,EAAE,IAAI,OAAOA,EAAE,KAAK,QAAQ,EAAE;MAC/B,MAAM,IAAIN,iBAAiB,CAAC,sCAAsC,CAAC;IACvE;IACA,IAAI,CAACM,EAAE,GAAGA,EAAE;EAChB;EAEOE,SAASA,CAAA,EAA0B;IACtC,OAAO;MACHC,IAAI,EAAE,4BAA4B;MAClCF,OAAO,EAAAG,aAAA;QACHJ,EAAE,EAAE,IAAI,CAACA;MAAE,GACR,IAAI,CAACK,qBAAqB,CAAC,CAAC;IAEvC,CAAC;EACL;;EAEA;AACJ;AACA;AACA;AACA;AACA;EACI,OAAcC,IAAIA,CAACN,EAAU,EAAEO,IAAY,EAAsB;IAC7D,OAAO,IAAIX,kBAAkB,CAAC;MAC1BO,IAAI,EAAE,4BAA4B;MAClCF,OAAO,EAAE;QACLD,EAAE,EAAEA,EAAE;QACN,CAACV,MAAM,CAACkB,IAAI,GAAGD;MACnB;IACJ,CAAC,CAAC;EACN;AACJ;;AAEA;AACA;AACA;AACA,OAAO,MAAME,cAAc,SAASd,eAAe,CAAwB;EA8BvE;AACJ;AACA;AACA;AACA;EACWE,WAAWA,CAACC,UAAgD,EAAE;IACjE,KAAK,CAACA,UAAU,CAAC;IAnCrB;AACJ;AACA;IAFIC,eAAA;IAKA;AACJ;AACA;AACA;AACA;AACA;AACA;IANIA,eAAA;IASA;AACJ;AACA;IAFIA,eAAA;IAKA;AACJ;AACA;IAFIA,eAAA;IAKA;AACJ;AACA;IAFIA,eAAA;IAaI,IAAMW,IAAI,GAAGjB,YAAY,CAACkB,MAAM,CAAmB,IAAI,CAACC,WAAW,CAAC;IAEpE,IAAI,EAACF,IAAI,aAAJA,IAAI,eAAJA,IAAI,CAAEG,QAAQ,GAAE;MACjB,MAAM,IAAInB,iBAAiB,CAAC,wBAAwB,CAAC;IACzD;IAEA,IAAI,CAACmB,QAAQ,GAAG,IAAIzB,YAAY,CAAC;MAAEe,IAAI,EAAE,8BAA8B;MAAEF,OAAO,EAAES,IAAI,CAACG;IAAS,CAAC,CAAC;IAElG,IAAI,CAACC,OAAO,GAAGJ,IAAI,CAACK,IAAI;IACxB,IAAIxB,qBAAqB,CAACyB,OAAO,CAAC,IAAI,CAACF,OAAO,CAAC,EAAE;MAC7C,IAAI,CAACC,IAAI,GAAGxB,qBAAqB;IACrC,CAAC,MAAM;MACH,IAAI,CAACwB,IAAI,GAAGvB,uBAAuB,CAAC,CAAC;IACzC;IAEA,IAAI,CAACyB,aAAa,GACdC,MAAM,CAACC,QAAQ,CAACT,IAAI,CAACU,cAAc,CAAC,IAAIV,IAAI,CAACU,cAAc,GAAI,CAAC,GAAGV,IAAI,CAACU,cAAc,GAAI,CAAC;IAE/F,IAAI,CAACC,KAAK,CAACC,OAAO,CAACZ,IAAI,CAACa,OAAO,CAAC,EAAE;MAC9B,MAAM,IAAI7B,iBAAiB,CAAC,+BAA+B,CAAC;IAChE;IACA,IAAM6B,OAAO,GAAGb,IAAI,CAACa,OAAO,CAACC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAACC,GAAG,CACxCC,CAAC,IACE,IAAI9B,kBAAkB,CAAC;MACnBO,IAAI,EAAE,4BAA4B;MAClCF,OAAO,EAAEyB;IACb,CAAC,CACT,CAAC;IACD,IAAIH,OAAO,CAACI,MAAM,IAAI,CAAC,EAAE;MACrB,MAAM,IAAIjC,iBAAiB,CAAC,sBAAsB,CAAC;IACvD;IACA,IAAI,CAAC6B,OAAO,GAAGA,OAAO;EAC1B;EAEOK,cAAcA,CAACC,gBAAqC,EAAW;IAClE,OAAOxC,eAAe,CAACwC,gBAAgB,EAAEpC,YAAY,CAAC;EAC1D;EAEOS,SAASA,CAAA,EAA0B;IACtC,OAAO;MACHC,IAAI,EAAEV,YAAY,CAACe,IAAI;MACvBP,OAAO,EAAE;QACL,CAACR,YAAY,CAACe,IAAI,GAAG;UACjBK,QAAQ,EAAE,IAAI,CAACA,QAAQ,CAACX,SAAS,CAAC,CAAC,CAACD,OAAO;UAC3Cc,IAAI,EAAE,IAAI,CAACD,OAAO;UAClBM,cAAc,EAAE,IAAI,CAACH,aAAa;UAClCM,OAAO,EAAE,IAAI,CAACA,OAAO,CAACE,GAAG,CAAEC,CAAC,IAAKA,CAAC,CAACxB,SAAS,CAAC,CAAC,CAACD,OAAO;QAC1D,CAAC;QACD,CAACX,MAAM,CAACkB,IAAI,MAAAsB,MAAA,CAAM,IAAI,CAACjB,QAAQ,CAACN,IAAI,QAAAuB,MAAA,CAAK,IAAI,CAACP,OAAO,CAACE,GAAG,CAAC,CAACC,CAAC,EAAEK,CAAC,QAAAD,MAAA,CAAQC,CAAC,GAAG,CAAC,QAAAD,MAAA,CAAKJ,CAAC,CAACnB,IAAI,CAAE,CAAC,CAACyB,IAAI,CAAC,IAAI,CAAC;MACzG;IACJ,CAAC;EACL;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;EACI,OAAc1B,IAAIA,CACdO,QAAgB,EAChBU,OAAiB,EACjBR,IAA4B,EAEd;IAAA,IADdE,aAAa,GAAAgB,SAAA,CAAAN,MAAA,QAAAM,SAAA,QAAAC,SAAA,GAAAD,SAAA,MAAG,CAAC;IAEjB,OAAO,IAAIxB,cAAc,CAAC;MACtBN,IAAI,EAAEV,YAAY,CAACe,IAAI;MACvBP,OAAO,EAAE;QACL,CAACX,MAAM,CAACkB,IAAI,GAAGK,QAAQ;QAAE;QACzB,CAACpB,YAAY,CAACe,IAAI,GAAG;UACjBK,QAAQ,EAAE;YAAE,CAACvB,MAAM,CAACkB,IAAI,GAAGK;UAAS,CAAC;UACrCE,IAAI,EAAEA,IAAI,YAAY5B,eAAe,GAAG4B,IAAI,CAACP,IAAI,GAAGO,IAAI;UACxDK,cAAc,EAAEH,aAAa;UAC7BM,OAAO,EAAEA,OAAO,CAACE,GAAG,CAAEC,CAAC,KAAM;YAAE1B,EAAE,EAAEmC,MAAM,CAAC,CAAC;YAAE,CAAC7C,MAAM,CAACkB,IAAI,GAAGkB;UAAE,CAAC,CAAC;QACpE;MACJ;IACJ,CAAC,CAAC;EACN;AACJ;AAEA,IAAMU,OAAO,GAAG,gEAAgE;AAChF,SAASD,MAAMA,CAAA,EAAW;EACtB,OAAO,CAAC,GAAGd,KAAK,CAAC,EAAE,CAAC,CAAC,CAACI,GAAG,CAAC,MAAMW,OAAO,CAACC,MAAM,CAACC,IAAI,CAACC,KAAK,CAACD,IAAI,CAACE,MAAM,CAAC,CAAC,GAAGJ,OAAO,CAACT,MAAM,CAAC,CAAC,CAAC,CAACK,IAAI,CAAC,EAAE,CAAC;AACxG","ignoreList":[]}

package/lib/extensible_events_v1/utilities.d.ts

@@ -0,0 +1,14 @@
+import { Optional } from "matrix-events-sdk";
+/**
+ * Determines if the given optional was provided a value.
+ * @param s - The optional to test.
+ * @returns True if the value is defined.
+ */
+export declare function isProvided<T>(s: Optional<T>): boolean;
+/**
+ * Determines if the given optional string is a defined string.
+ * @param s - The input string.
+ * @returns True if the input is a defined string.
+ */
+export declare function isOptionalAString(s: Optional<string>): s is string;
+//# sourceMappingURL=utilities.d.ts.map

package/lib/extensible_events_v1/utilities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utilities.d.ts","sourceRoot":"","sources":["../../src/extensible_events_v1/utilities.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,OAAO,CAErD;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,MAAM,CAElE"}

package/lib/extensible_events_v1/utilities.js

@@ -0,0 +1,34 @@
+/*
+Copyright 2021 - 2023 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+/**
+ * Determines if the given optional was provided a value.
+ * @param s - The optional to test.
+ * @returns True if the value is defined.
+ */
+export function isProvided(s) {
+  return s !== null && s !== undefined;
+}
+
+/**
+ * Determines if the given optional string is a defined string.
+ * @param s - The input string.
+ * @returns True if the input is a defined string.
+ */
+export function isOptionalAString(s) {
+  return isProvided(s) && typeof s === "string";
+}
+//# sourceMappingURL=utilities.js.map

package/lib/extensible_events_v1/utilities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utilities.js","names":["isProvided","s","undefined","isOptionalAString"],"sources":["../../src/extensible_events_v1/utilities.ts"],"sourcesContent":["/*\nCopyright 2021 - 2023 The Matrix.org Foundation C.I.C.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\nimport { Optional } from \"matrix-events-sdk\";\n\n/**\n * Determines if the given optional was provided a value.\n * @param s - The optional to test.\n * @returns True if the value is defined.\n */\nexport function isProvided<T>(s: Optional<T>): boolean {\n    return s !== null && s !== undefined;\n}\n\n/**\n * Determines if the given optional string is a defined string.\n * @param s - The input string.\n * @returns True if the input is a defined string.\n */\nexport function isOptionalAString(s: Optional<string>): s is string {\n    return isProvided(s) && typeof s === \"string\";\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAIA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASA,UAAUA,CAAIC,CAAc,EAAW;EACnD,OAAOA,CAAC,KAAK,IAAI,IAAIA,CAAC,KAAKC,SAAS;AACxC;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,iBAAiBA,CAACF,CAAmB,EAAe;EAChE,OAAOD,UAAU,CAACC,CAAC,CAAC,IAAI,OAAOA,CAAC,KAAK,QAAQ;AACjD","ignoreList":[]}

package/lib/feature.d.ts

@@ -0,0 +1,20 @@
+import { IServerVersions } from "./client.ts";
+export declare enum ServerSupport {
+    Stable = 0,
+    Unstable = 1,
+    Unsupported = 2
+}
+export declare enum Feature {
+    Thread = "Thread",
+    ThreadUnreadNotifications = "ThreadUnreadNotifications",
+    /**
+     * @deprecated this is now exposed as a capability not a feature
+     */
+    LoginTokenRequest = "LoginTokenRequest",
+    RelationBasedRedactions = "RelationBasedRedactions",
+    AccountDataDeletion = "AccountDataDeletion",
+    RelationsRecursion = "RelationsRecursion",
+    IntentionalMentions = "IntentionalMentions"
+}
+export declare function buildFeatureSupportMap(versions: IServerVersions): Promise<Map<Feature, ServerSupport>>;
+//# sourceMappingURL=feature.d.ts.map

package/lib/feature.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"feature.d.ts","sourceRoot":"","sources":["../src/feature.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAE9C,oBAAY,aAAa;IACrB,MAAM,IAAA;IACN,QAAQ,IAAA;IACR,WAAW,IAAA;CACd;AAED,oBAAY,OAAO;IACf,MAAM,WAAW;IACjB,yBAAyB,8BAA8B;IACvD;;OAEG;IACH,iBAAiB,sBAAsB;IACvC,uBAAuB,4BAA4B;IACnD,mBAAmB,wBAAwB;IAC3C,kBAAkB,uBAAuB;IACzC,mBAAmB,wBAAwB;CAC9C;AAkCD,wBAAsB,sBAAsB,CAAC,QAAQ,EAAE,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC,CAiB5G"}

package/lib/feature.js

@@ -0,0 +1,85 @@
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+/*
+Copyright 2022 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+export var ServerSupport = /*#__PURE__*/function (ServerSupport) {
+  ServerSupport[ServerSupport["Stable"] = 0] = "Stable";
+  ServerSupport[ServerSupport["Unstable"] = 1] = "Unstable";
+  ServerSupport[ServerSupport["Unsupported"] = 2] = "Unsupported";
+  return ServerSupport;
+}({});
+export var Feature = /*#__PURE__*/function (Feature) {
+  Feature["Thread"] = "Thread";
+  Feature["ThreadUnreadNotifications"] = "ThreadUnreadNotifications";
+  Feature["LoginTokenRequest"] = "LoginTokenRequest";
+  Feature["RelationBasedRedactions"] = "RelationBasedRedactions";
+  Feature["AccountDataDeletion"] = "AccountDataDeletion";
+  Feature["RelationsRecursion"] = "RelationsRecursion";
+  Feature["IntentionalMentions"] = "IntentionalMentions";
+  return Feature;
+}({});
+var featureSupportResolver = {
+  [Feature.Thread]: {
+    unstablePrefixes: ["org.matrix.msc3440"],
+    matrixVersion: "v1.3"
+  },
+  [Feature.ThreadUnreadNotifications]: {
+    unstablePrefixes: ["org.matrix.msc3771", "org.matrix.msc3773"],
+    matrixVersion: "v1.4"
+  },
+  [Feature.LoginTokenRequest]: {
+    unstablePrefixes: ["org.matrix.msc3882"]
+  },
+  [Feature.RelationBasedRedactions]: {
+    unstablePrefixes: ["org.matrix.msc3912"]
+  },
+  [Feature.AccountDataDeletion]: {
+    unstablePrefixes: ["org.matrix.msc3391"]
+  },
+  [Feature.RelationsRecursion]: {
+    unstablePrefixes: ["org.matrix.msc3981"]
+  },
+  [Feature.IntentionalMentions]: {
+    unstablePrefixes: ["org.matrix.msc3952_intentional_mentions"],
+    matrixVersion: "v1.7"
+  }
+};
+export function buildFeatureSupportMap(_x) {
+  return _buildFeatureSupportMap.apply(this, arguments);
+}
+function _buildFeatureSupportMap() {
+  _buildFeatureSupportMap = _asyncToGenerator(function* (versions) {
+    var supportMap = new Map();
+    for (var [feature, supportCondition] of Object.entries(featureSupportResolver)) {
+      var _versions$versions$in, _versions$versions, _supportCondition$uns, _supportCondition$uns2;
+      var supportMatrixVersion = (_versions$versions$in = (_versions$versions = versions.versions) === null || _versions$versions === void 0 ? void 0 : _versions$versions.includes(supportCondition.matrixVersion || "")) !== null && _versions$versions$in !== void 0 ? _versions$versions$in : false;
+      var supportUnstablePrefixes = (_supportCondition$uns = (_supportCondition$uns2 = supportCondition.unstablePrefixes) === null || _supportCondition$uns2 === void 0 ? void 0 : _supportCondition$uns2.every(unstablePrefix => {
+        var _versions$unstable_fe;
+        return ((_versions$unstable_fe = versions.unstable_features) === null || _versions$unstable_fe === void 0 ? void 0 : _versions$unstable_fe[unstablePrefix]) === true;
+      })) !== null && _supportCondition$uns !== void 0 ? _supportCondition$uns : false;
+      if (supportMatrixVersion) {
+        supportMap.set(feature, ServerSupport.Stable);
+      } else if (supportUnstablePrefixes) {
+        supportMap.set(feature, ServerSupport.Unstable);
+      } else {
+        supportMap.set(feature, ServerSupport.Unsupported);
+      }
+    }
+    return supportMap;
+  });
+  return _buildFeatureSupportMap.apply(this, arguments);
+}
+//# sourceMappingURL=feature.js.map

package/lib/feature.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"feature.js","names":["ServerSupport","Feature","featureSupportResolver","Thread","unstablePrefixes","matrixVersion","ThreadUnreadNotifications","LoginTokenRequest","RelationBasedRedactions","AccountDataDeletion","RelationsRecursion","IntentionalMentions","buildFeatureSupportMap","_x","_buildFeatureSupportMap","apply","arguments","_asyncToGenerator","versions","supportMap","Map","feature","supportCondition","Object","entries","_versions$versions$in","_versions$versions","_supportCondition$uns","_supportCondition$uns2","supportMatrixVersion","includes","supportUnstablePrefixes","every","unstablePrefix","_versions$unstable_fe","unstable_features","set","Stable","Unstable","Unsupported"],"sources":["../src/feature.ts"],"sourcesContent":["/*\nCopyright 2022 The Matrix.org Foundation C.I.C.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\nimport { IServerVersions } from \"./client.ts\";\n\nexport enum ServerSupport {\n    Stable,\n    Unstable,\n    Unsupported,\n}\n\nexport enum Feature {\n    Thread = \"Thread\",\n    ThreadUnreadNotifications = \"ThreadUnreadNotifications\",\n    /**\n     * @deprecated this is now exposed as a capability not a feature\n     */\n    LoginTokenRequest = \"LoginTokenRequest\",\n    RelationBasedRedactions = \"RelationBasedRedactions\",\n    AccountDataDeletion = \"AccountDataDeletion\",\n    RelationsRecursion = \"RelationsRecursion\",\n    IntentionalMentions = \"IntentionalMentions\",\n}\n\ntype FeatureSupportCondition = {\n    unstablePrefixes?: string[];\n    matrixVersion?: string;\n};\n\nconst featureSupportResolver: Record<string, FeatureSupportCondition> = {\n    [Feature.Thread]: {\n        unstablePrefixes: [\"org.matrix.msc3440\"],\n        matrixVersion: \"v1.3\",\n    },\n    [Feature.ThreadUnreadNotifications]: {\n        unstablePrefixes: [\"org.matrix.msc3771\", \"org.matrix.msc3773\"],\n        matrixVersion: \"v1.4\",\n    },\n    [Feature.LoginTokenRequest]: {\n        unstablePrefixes: [\"org.matrix.msc3882\"],\n    },\n    [Feature.RelationBasedRedactions]: {\n        unstablePrefixes: [\"org.matrix.msc3912\"],\n    },\n    [Feature.AccountDataDeletion]: {\n        unstablePrefixes: [\"org.matrix.msc3391\"],\n    },\n    [Feature.RelationsRecursion]: {\n        unstablePrefixes: [\"org.matrix.msc3981\"],\n    },\n    [Feature.IntentionalMentions]: {\n        unstablePrefixes: [\"org.matrix.msc3952_intentional_mentions\"],\n        matrixVersion: \"v1.7\",\n    },\n};\n\nexport async function buildFeatureSupportMap(versions: IServerVersions): Promise<Map<Feature, ServerSupport>> {\n    const supportMap = new Map<Feature, ServerSupport>();\n    for (const [feature, supportCondition] of Object.entries(featureSupportResolver)) {\n        const supportMatrixVersion = versions.versions?.includes(supportCondition.matrixVersion || \"\") ?? false;\n        const supportUnstablePrefixes =\n            supportCondition.unstablePrefixes?.every((unstablePrefix) => {\n                return versions.unstable_features?.[unstablePrefix] === true;\n            }) ?? false;\n        if (supportMatrixVersion) {\n            supportMap.set(feature as Feature, ServerSupport.Stable);\n        } else if (supportUnstablePrefixes) {\n            supportMap.set(feature as Feature, ServerSupport.Unstable);\n        } else {\n            supportMap.set(feature as Feature, ServerSupport.Unsupported);\n        }\n    }\n    return supportMap;\n}\n"],"mappings":";AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAIA,WAAYA,aAAa,0BAAbA,aAAa;EAAbA,aAAa,CAAbA,aAAa;EAAbA,aAAa,CAAbA,aAAa;EAAbA,aAAa,CAAbA,aAAa;EAAA,OAAbA,aAAa;AAAA;AAMzB,WAAYC,OAAO,0BAAPA,OAAO;EAAPA,OAAO;EAAPA,OAAO;EAAPA,OAAO;EAAPA,OAAO;EAAPA,OAAO;EAAPA,OAAO;EAAPA,OAAO;EAAA,OAAPA,OAAO;AAAA;AAkBnB,IAAMC,sBAA+D,GAAG;EACpE,CAACD,OAAO,CAACE,MAAM,GAAG;IACdC,gBAAgB,EAAE,CAAC,oBAAoB,CAAC;IACxCC,aAAa,EAAE;EACnB,CAAC;EACD,CAACJ,OAAO,CAACK,yBAAyB,GAAG;IACjCF,gBAAgB,EAAE,CAAC,oBAAoB,EAAE,oBAAoB,CAAC;IAC9DC,aAAa,EAAE;EACnB,CAAC;EACD,CAACJ,OAAO,CAACM,iBAAiB,GAAG;IACzBH,gBAAgB,EAAE,CAAC,oBAAoB;EAC3C,CAAC;EACD,CAACH,OAAO,CAACO,uBAAuB,GAAG;IAC/BJ,gBAAgB,EAAE,CAAC,oBAAoB;EAC3C,CAAC;EACD,CAACH,OAAO,CAACQ,mBAAmB,GAAG;IAC3BL,gBAAgB,EAAE,CAAC,oBAAoB;EAC3C,CAAC;EACD,CAACH,OAAO,CAACS,kBAAkB,GAAG;IAC1BN,gBAAgB,EAAE,CAAC,oBAAoB;EAC3C,CAAC;EACD,CAACH,OAAO,CAACU,mBAAmB,GAAG;IAC3BP,gBAAgB,EAAE,CAAC,yCAAyC,CAAC;IAC7DC,aAAa,EAAE;EACnB;AACJ,CAAC;AAED,gBAAsBO,sBAAsBA,CAAAC,EAAA;EAAA,OAAAC,uBAAA,CAAAC,KAAA,OAAAC,SAAA;AAAA;AAiB3C,SAAAF,wBAAA;EAAAA,uBAAA,GAAAG,iBAAA,CAjBM,WAAsCC,QAAyB,EAAwC;IAC1G,IAAMC,UAAU,GAAG,IAAIC,GAAG,CAAyB,CAAC;IACpD,KAAK,IAAM,CAACC,OAAO,EAAEC,gBAAgB,CAAC,IAAIC,MAAM,CAACC,OAAO,CAACtB,sBAAsB,CAAC,EAAE;MAAA,IAAAuB,qBAAA,EAAAC,kBAAA,EAAAC,qBAAA,EAAAC,sBAAA;MAC9E,IAAMC,oBAAoB,IAAAJ,qBAAA,IAAAC,kBAAA,GAAGR,QAAQ,CAACA,QAAQ,cAAAQ,kBAAA,uBAAjBA,kBAAA,CAAmBI,QAAQ,CAACR,gBAAgB,CAACjB,aAAa,IAAI,EAAE,CAAC,cAAAoB,qBAAA,cAAAA,qBAAA,GAAI,KAAK;MACvG,IAAMM,uBAAuB,IAAAJ,qBAAA,IAAAC,sBAAA,GACzBN,gBAAgB,CAAClB,gBAAgB,cAAAwB,sBAAA,uBAAjCA,sBAAA,CAAmCI,KAAK,CAAEC,cAAc,IAAK;QAAA,IAAAC,qBAAA;QACzD,OAAO,EAAAA,qBAAA,GAAAhB,QAAQ,CAACiB,iBAAiB,cAAAD,qBAAA,uBAA1BA,qBAAA,CAA6BD,cAAc,CAAC,MAAK,IAAI;MAChE,CAAC,CAAC,cAAAN,qBAAA,cAAAA,qBAAA,GAAI,KAAK;MACf,IAAIE,oBAAoB,EAAE;QACtBV,UAAU,CAACiB,GAAG,CAACf,OAAO,EAAarB,aAAa,CAACqC,MAAM,CAAC;MAC5D,CAAC,MAAM,IAAIN,uBAAuB,EAAE;QAChCZ,UAAU,CAACiB,GAAG,CAACf,OAAO,EAAarB,aAAa,CAACsC,QAAQ,CAAC;MAC9D,CAAC,MAAM;QACHnB,UAAU,CAACiB,GAAG,CAACf,OAAO,EAAarB,aAAa,CAACuC,WAAW,CAAC;MACjE;IACJ;IACA,OAAOpB,UAAU;EACrB,CAAC;EAAA,OAAAL,uBAAA,CAAAC,KAAA,OAAAC,SAAA;AAAA","ignoreList":[]}

package/lib/filter-component.d.ts

@@ -0,0 +1,64 @@
+import { RelationType } from "./@types/event.ts";
+import { MatrixEvent } from "./models/event.ts";
+export interface IFilterComponent {
+    "types"?: string[];
+    "not_types"?: string[];
+    "rooms"?: string[];
+    "not_rooms"?: string[];
+    "senders"?: string[];
+    "not_senders"?: string[];
+    "contains_url"?: boolean;
+    "limit"?: number;
+    "related_by_senders"?: Array<RelationType | string>;
+    "related_by_rel_types"?: string[];
+    "io.element.relation_senders"?: Array<RelationType | string>;
+    "io.element.relation_types"?: string[];
+}
+/**
+ * FilterComponent is a section of a Filter definition which defines the
+ * types, rooms, senders filters etc to be applied to a particular type of resource.
+ * This is all ported over from synapse's Filter object.
+ *
+ * N.B. that synapse refers to these as 'Filters', and what js-sdk refers to as
+ * 'Filters' are referred to as 'FilterCollections'.
+ */
+export declare class FilterComponent {
+    private filterJson;
+    readonly userId?: string | undefined | null;
+    constructor(filterJson: IFilterComponent, userId?: string | undefined | null);
+    /**
+     * Checks with the filter component matches the given event
+     * @param event - event to be checked against the filter
+     * @returns true if the event matches the filter
+     */
+    check(event: MatrixEvent): boolean;
+    /**
+     * Converts the filter component into the form expected over the wire
+     */
+    toJSON(): object;
+    /**
+     * Checks whether the filter component matches the given event fields.
+     * @param roomId -        the roomId for the event being checked
+     * @param sender -        the sender of the event being checked
+     * @param eventType -     the type of the event being checked
+     * @param containsUrl -  whether the event contains a content.url field
+     * @param relationTypes -  whether has aggregated relation of the given type
+     * @param relationSenders - whether one of the relation is sent by the user listed
+     * @returns true if the event fields match the filter
+     */
+    private checkFields;
+    private arrayMatchesFilter;
+    /**
+     * Filters a list of events down to those which match this filter component
+     * @param events -  Events to be checked against the filter component
+     * @returns events which matched the filter component
+     */
+    filter(events: MatrixEvent[]): MatrixEvent[];
+    /**
+     * Returns the limit field for a given filter component, providing a default of
+     * 10 if none is otherwise specified. Cargo-culted from Synapse.
+     * @returns the limit for this filter component.
+     */
+    limit(): number;
+}
+//# sourceMappingURL=filter-component.d.ts.map

package/lib/filter-component.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filter-component.d.ts","sourceRoot":"","sources":["../src/filter-component.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAoBhD,MAAM,WAAW,gBAAgB;IAC7B,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oBAAoB,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,MAAM,CAAC,CAAC;IACpD,sBAAsB,CAAC,EAAE,MAAM,EAAE,CAAC;IAGlC,6BAA6B,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,MAAM,CAAC,CAAC;IAC7D,2BAA2B,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1C;AAGD;;;;;;;GAOG;AACH,qBAAa,eAAe;IAEpB,OAAO,CAAC,UAAU;aACF,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;gBAD1C,UAAU,EAAE,gBAAgB,EACpB,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;IAGtD;;;;OAIG;IACI,KAAK,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO;IAuBzC;;OAEG;IACI,MAAM,IAAI,MAAM;IAcvB;;;;;;;;;OASG;IACH,OAAO,CAAC,WAAW;IAwDnB,OAAO,CAAC,kBAAkB;IAS1B;;;;OAIG;IACI,MAAM,CAAC,MAAM,EAAE,WAAW,EAAE,GAAG,WAAW,EAAE;IAInD;;;;OAIG;IACI,KAAK,IAAI,MAAM;CAGzB"}

package/lib/filter-component.js

@@ -0,0 +1,167 @@
+/*
+Copyright 2016 - 2021 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import { FILTER_RELATED_BY_REL_TYPES, FILTER_RELATED_BY_SENDERS, THREAD_RELATION_TYPE } from "./models/thread.js";
+
+/**
+ * Checks if a value matches a given field value, which may be a * terminated
+ * wildcard pattern.
+ * @param actualValue -  The value to be compared
+ * @param filterValue -  The filter pattern to be compared
+ * @returns true if the actualValue matches the filterValue
+ */
+function matchesWildcard(actualValue, filterValue) {
+  if (filterValue.endsWith("*")) {
+    var typePrefix = filterValue.slice(0, -1);
+    return actualValue.slice(0, typePrefix.length) === typePrefix;
+  } else {
+    return actualValue === filterValue;
+  }
+}
+
+/* eslint-disable camelcase */
+
+/* eslint-enable camelcase */
+
+/**
+ * FilterComponent is a section of a Filter definition which defines the
+ * types, rooms, senders filters etc to be applied to a particular type of resource.
+ * This is all ported over from synapse's Filter object.
+ *
+ * N.B. that synapse refers to these as 'Filters', and what js-sdk refers to as
+ * 'Filters' are referred to as 'FilterCollections'.
+ */
+export class FilterComponent {
+  constructor(filterJson, userId) {
+    this.filterJson = filterJson;
+    this.userId = userId;
+  }
+
+  /**
+   * Checks with the filter component matches the given event
+   * @param event - event to be checked against the filter
+   * @returns true if the event matches the filter
+   */
+  check(event) {
+    var _event$getUnsigned, _bundledRelationships;
+    var bundledRelationships = ((_event$getUnsigned = event.getUnsigned()) === null || _event$getUnsigned === void 0 ? void 0 : _event$getUnsigned["m.relations"]) || {};
+    var relations = Object.keys(bundledRelationships);
+    // Relation senders allows in theory a look-up of any senders
+    // however clients can only know about the current user participation status
+    // as sending a whole list of participants could be proven problematic in terms
+    // of performance
+    // This should be improved when bundled relationships solve that problem
+    var relationSenders = [];
+    if (this.userId && bundledRelationships !== null && bundledRelationships !== void 0 && (_bundledRelationships = bundledRelationships[THREAD_RELATION_TYPE.name]) !== null && _bundledRelationships !== void 0 && _bundledRelationships.current_user_participated) {
+      relationSenders.push(this.userId);
+    }
+    return this.checkFields(event.getRoomId(), event.getSender(), event.getType(), event.getContent() ? event.getContent().url !== undefined : false, relations, relationSenders);
+  }
+
+  /**
+   * Converts the filter component into the form expected over the wire
+   */
+  toJSON() {
+    return {
+      types: this.filterJson.types || null,
+      not_types: this.filterJson.not_types || [],
+      rooms: this.filterJson.rooms || null,
+      not_rooms: this.filterJson.not_rooms || [],
+      senders: this.filterJson.senders || null,
+      not_senders: this.filterJson.not_senders || [],
+      contains_url: this.filterJson.contains_url || null,
+      [FILTER_RELATED_BY_SENDERS.name]: this.filterJson[FILTER_RELATED_BY_SENDERS.name] || [],
+      [FILTER_RELATED_BY_REL_TYPES.name]: this.filterJson[FILTER_RELATED_BY_REL_TYPES.name] || []
+    };
+  }
+
+  /**
+   * Checks whether the filter component matches the given event fields.
+   * @param roomId -        the roomId for the event being checked
+   * @param sender -        the sender of the event being checked
+   * @param eventType -     the type of the event being checked
+   * @param containsUrl -  whether the event contains a content.url field
+   * @param relationTypes -  whether has aggregated relation of the given type
+   * @param relationSenders - whether one of the relation is sent by the user listed
+   * @returns true if the event fields match the filter
+   */
+  checkFields(roomId, sender, eventType, containsUrl, relationTypes, relationSenders) {
+    var literalKeys = {
+      rooms: function rooms(v) {
+        return roomId === v;
+      },
+      senders: function senders(v) {
+        return sender === v;
+      },
+      types: function types(v) {
+        return matchesWildcard(eventType, v);
+      }
+    };
+    for (var name in literalKeys) {
+      var matchFunc = literalKeys[name];
+      var notName = "not_" + name;
+      var disallowedValues = this.filterJson[notName];
+      if (disallowedValues !== null && disallowedValues !== void 0 && disallowedValues.some(matchFunc)) {
+        return false;
+      }
+      var allowedValues = this.filterJson[name];
+      if (allowedValues && !allowedValues.some(matchFunc)) {
+        return false;
+      }
+    }
+    var containsUrlFilter = this.filterJson.contains_url;
+    if (containsUrlFilter !== undefined && containsUrlFilter !== containsUrl) {
+      return false;
+    }
+    var relationTypesFilter = this.filterJson[FILTER_RELATED_BY_REL_TYPES.name];
+    if (relationTypesFilter !== undefined) {
+      if (!this.arrayMatchesFilter(relationTypesFilter, relationTypes)) {
+        return false;
+      }
+    }
+    var relationSendersFilter = this.filterJson[FILTER_RELATED_BY_SENDERS.name];
+    if (relationSendersFilter !== undefined) {
+      if (!this.arrayMatchesFilter(relationSendersFilter, relationSenders)) {
+        return false;
+      }
+    }
+    return true;
+  }
+  arrayMatchesFilter(filter, values) {
+    return values.length > 0 && filter.every(value => {
+      return values.includes(value);
+    });
+  }
+
+  /**
+   * Filters a list of events down to those which match this filter component
+   * @param events -  Events to be checked against the filter component
+   * @returns events which matched the filter component
+   */
+  filter(events) {
+    return events.filter(this.check, this);
+  }
+
+  /**
+   * Returns the limit field for a given filter component, providing a default of
+   * 10 if none is otherwise specified. Cargo-culted from Synapse.
+   * @returns the limit for this filter component.
+   */
+  limit() {
+    return this.filterJson.limit !== undefined ? this.filterJson.limit : 10;
+  }
+}
+//# sourceMappingURL=filter-component.js.map