@textrp/briij-js-sdk 41.0.0

package/lib/models/invites-ignorer.js

@@ -0,0 +1,357 @@
+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.
+*/
+
+import { EventTimeline } from "./event-timeline.js";
+import { Preset } from "../@types/partials.js";
+import { globToRegexp } from "../utils.js";
+import { EventType } from "../@types/event.js";
+import { IGNORE_INVITES_ACCOUNT_EVENT_KEY, POLICIES_ACCOUNT_EVENT_TYPE, PolicyRecommendation, PolicyScope } from "./invites-ignorer-types.js";
+export { IGNORE_INVITES_ACCOUNT_EVENT_KEY, POLICIES_ACCOUNT_EVENT_TYPE, PolicyRecommendation, PolicyScope };
+var scopeToEventTypeMap = {
+  [PolicyScope.User]: EventType.PolicyRuleUser,
+  [PolicyScope.Room]: EventType.PolicyRuleRoom,
+  [PolicyScope.Server]: EventType.PolicyRuleServer
+};
+
+/**
+ * A container for ignored invites.
+ *
+ * # Performance
+ *
+ * This implementation is extremely naive. It expects that we are dealing
+ * with a very short list of sources (e.g. only one). If real-world
+ * applications turn out to require longer lists, we may need to rework
+ * our data structures.
+ */
+export class IgnoredInvites {
+  constructor(client) {
+    this.client = client;
+  }
+
+  /**
+   * Add a new rule.
+   *
+   * @param scope - The scope for this rule.
+   * @param entity - The entity covered by this rule. Globs are supported.
+   * @param reason - A human-readable reason for introducing this new rule.
+   * @returns The event id for the new rule.
+   */
+  addRule(scope, entity, reason) {
+    var _this = this;
+    return _asyncToGenerator(function* () {
+      var target = yield _this.getOrCreateTargetRoom();
+      var response = yield _this.client.sendStateEvent(target.roomId, scopeToEventTypeMap[scope], {
+        entity,
+        reason,
+        recommendation: PolicyRecommendation.Ban
+      });
+      return response.event_id;
+    })();
+  }
+
+  /**
+   * Remove a rule.
+   */
+  removeRule(event) {
+    var _this2 = this;
+    return _asyncToGenerator(function* () {
+      yield _this2.client.redactEvent(event.getRoomId(), event.getId());
+    })();
+  }
+
+  /**
+   * Add a new room to the list of sources. If the user isn't a member of the
+   * room, attempt to join it.
+   *
+   * @param roomId - A valid room id. If this room is already in the list
+   * of sources, it will not be duplicated.
+   * @returns `true` if the source was added, `false` if it was already present.
+   * @throws If `roomId` isn't the id of a room that the current user is already
+   * member of or can join.
+   *
+   * # Safety
+   *
+   * This method will rewrite the `Policies` object in the user's account data.
+   * This rewrite is inherently racy and could overwrite or be overwritten by
+   * other concurrent rewrites of the same object.
+   */
+  addSource(roomId) {
+    var _this3 = this;
+    return _asyncToGenerator(function* () {
+      // We attempt to join the room *before* calling
+      // `await this.getOrCreateSourceRooms()` to decrease the duration
+      // of the racy section.
+      yield _this3.client.joinRoom(roomId);
+      // Race starts.
+      var sources = (yield _this3.getOrCreateSourceRooms()).map(room => room.roomId);
+      if (sources.includes(roomId)) {
+        return false;
+      }
+      sources.push(roomId);
+      yield _this3.withIgnoreInvitesPolicies(ignoreInvitesPolicies => {
+        ignoreInvitesPolicies.sources = sources;
+      });
+
+      // Race ends.
+      return true;
+    })();
+  }
+
+  /**
+   * Find out whether an invite should be ignored.
+   *
+   * @param params
+   * @param params.sender - The user id for the user who issued the invite.
+   * @param params.roomId - The room to which the user is invited.
+   * @returns A rule matching the entity, if any was found, `null` otherwise.
+   */
+  getRuleForInvite(_ref) {
+    var _this4 = this;
+    return _asyncToGenerator(function* () {
+      var {
+        sender,
+        roomId
+      } = _ref;
+      // In this implementation, we perform a very naive lookup:
+      // - search in each policy room;
+      // - turn each (potentially glob) rule entity into a regexp.
+      //
+      // Real-world testing will tell us whether this is performant enough.
+      // In the (unfortunately likely) case it isn't, there are several manners
+      // in which we could optimize this:
+      // - match several entities per go;
+      // - pre-compile each rule entity into a regexp;
+      // - pre-compile entire rooms into a single regexp.
+      var policyRooms = yield _this4.getOrCreateSourceRooms();
+      var senderServer = sender.split(":")[1];
+      var roomServer = roomId.split(":")[1];
+      for (var room of policyRooms) {
+        var state = room.getUnfilteredTimelineSet().getLiveTimeline().getState(EventTimeline.FORWARDS);
+        for (var {
+          scope,
+          entities
+        } of [{
+          scope: PolicyScope.Room,
+          entities: [roomId]
+        }, {
+          scope: PolicyScope.User,
+          entities: [sender]
+        }, {
+          scope: PolicyScope.Server,
+          entities: [senderServer, roomServer]
+        }]) {
+          var events = state.getStateEvents(scopeToEventTypeMap[scope]);
+          for (var event of events) {
+            var content = event.getContent();
+            if ((content === null || content === void 0 ? void 0 : content.recommendation) != PolicyRecommendation.Ban) {
+              // Ignoring invites only looks at `m.ban` recommendations.
+              continue;
+            }
+            var glob = content === null || content === void 0 ? void 0 : content.entity;
+            if (!glob) {
+              // Invalid event.
+              continue;
+            }
+            var regexp = void 0;
+            try {
+              regexp = new RegExp(globToRegexp(glob));
+            } catch (_unused) {
+              // Assume invalid event.
+              continue;
+            }
+            for (var entity of entities) {
+              if (entity && regexp.test(entity)) {
+                return event;
+              }
+            }
+            // No match.
+          }
+        }
+      }
+      return null;
+    })();
+  }
+
+  /**
+   * Get the target room, i.e. the room in which any new rule should be written.
+   *
+   * If there is no target room setup, a target room is created.
+   *
+   * Note: This method is public for testing reasons. Most clients should not need
+   * to call it directly.
+   *
+   * # Safety
+   *
+   * This method will rewrite the `Policies` object in the user's account data.
+   * This rewrite is inherently racy and could overwrite or be overwritten by
+   * other concurrent rewrites of the same object.
+   */
+  getOrCreateTargetRoom() {
+    var _this5 = this;
+    return _asyncToGenerator(function* () {
+      var ignoreInvitesPolicies = _this5.getIgnoreInvitesPolicies();
+      var target = ignoreInvitesPolicies.target;
+      // Validate `target`. If it is invalid, trash out the current `target`
+      // and create a new room.
+      if (typeof target !== "string") {
+        target = null;
+      }
+      if (target) {
+        // Check that the room exists and is valid.
+        var room = _this5.client.getRoom(target);
+        if (room) {
+          return room;
+        } else {
+          target = null;
+        }
+      }
+      // We need to create our own policy room for ignoring invites.
+      target = (yield _this5.client.createRoom({
+        name: "Individual Policy Room",
+        preset: Preset.PrivateChat
+      })).room_id;
+      yield _this5.withIgnoreInvitesPolicies(ignoreInvitesPolicies => {
+        ignoreInvitesPolicies.target = target;
+      });
+
+      // Since we have just called `createRoom`, `getRoom` should not be `null`.
+      return _this5.client.getRoom(target);
+    })();
+  }
+
+  /**
+   * Get the list of source rooms, i.e. the rooms from which rules need to be read.
+   *
+   * If no source rooms are setup, the target room is used as sole source room.
+   *
+   * Note: This method is public for testing reasons. Most clients should not need
+   * to call it directly.
+   *
+   * # Safety
+   *
+   * This method will rewrite the `Policies` object in the user's account data.
+   * This rewrite is inherently racy and could overwrite or be overwritten by
+   * other concurrent rewrites of the same object.
+   */
+  getOrCreateSourceRooms() {
+    var _this6 = this;
+    return _asyncToGenerator(function* () {
+      var ignoreInvitesPolicies = _this6.getIgnoreInvitesPolicies();
+      var sources = ignoreInvitesPolicies.sources;
+
+      // Validate `sources`. If it is invalid, trash out the current `sources`
+      // and create a new list of sources from `target`.
+      var hasChanges = false;
+      if (!Array.isArray(sources)) {
+        // `sources` could not be an array.
+        hasChanges = true;
+        sources = [];
+      }
+      var sourceRooms = sources
+      // `sources` could contain non-string / invalid room ids
+      .filter(roomId => typeof roomId === "string").map(roomId => _this6.client.getRoom(roomId)).filter(room => !!room);
+      if (sourceRooms.length != sources.length) {
+        hasChanges = true;
+      }
+      if (sourceRooms.length == 0) {
+        // `sources` could be empty (possibly because we've removed
+        // invalid content)
+        var target = yield _this6.getOrCreateTargetRoom();
+        hasChanges = true;
+        sourceRooms = [target];
+      }
+      if (hasChanges) {
+        // Reload `policies`/`ignoreInvitesPolicies` in case it has been changed
+        // during or by our call to `this.getTargetRoom()`.
+        yield _this6.withIgnoreInvitesPolicies(ignoreInvitesPolicies => {
+          ignoreInvitesPolicies.sources = sources;
+        });
+      }
+      return sourceRooms;
+    })();
+  }
+
+  /**
+   * Fetch the `IGNORE_INVITES_POLICIES` object from account data.
+   *
+   * If both an unstable prefix version and a stable prefix version are available,
+   * it will return the stable prefix version preferentially.
+   *
+   * The result is *not* validated but is guaranteed to be a non-null object.
+   *
+   * @returns A non-null object.
+   */
+  getIgnoreInvitesPolicies() {
+    return this.getPoliciesAndIgnoreInvitesPolicies().ignoreInvitesPolicies;
+  }
+
+  /**
+   * Modify in place the `IGNORE_INVITES_POLICIES` object from account data.
+   */
+  withIgnoreInvitesPolicies(cb) {
+    var _this7 = this;
+    return _asyncToGenerator(function* () {
+      var {
+        policies,
+        ignoreInvitesPolicies
+      } = _this7.getPoliciesAndIgnoreInvitesPolicies();
+      cb(ignoreInvitesPolicies);
+      policies[IGNORE_INVITES_ACCOUNT_EVENT_KEY.name] = ignoreInvitesPolicies;
+      yield _this7.client.setAccountData(POLICIES_ACCOUNT_EVENT_TYPE.name, policies);
+    })();
+  }
+
+  /**
+   * As `getIgnoreInvitesPolicies` but also return the `POLICIES_ACCOUNT_EVENT_TYPE`
+   * object.
+   */
+  getPoliciesAndIgnoreInvitesPolicies() {
+    var policies = {};
+    for (var key of [POLICIES_ACCOUNT_EVENT_TYPE.name, POLICIES_ACCOUNT_EVENT_TYPE.altName]) {
+      var _this$client$getAccou;
+      if (!key) {
+        continue;
+      }
+      var value = (_this$client$getAccou = this.client.getAccountData(key)) === null || _this$client$getAccou === void 0 ? void 0 : _this$client$getAccou.getContent();
+      if (value) {
+        policies = value;
+        break;
+      }
+    }
+    var ignoreInvitesPolicies = {};
+    var hasIgnoreInvitesPolicies = false;
+    for (var _key of [IGNORE_INVITES_ACCOUNT_EVENT_KEY.name, IGNORE_INVITES_ACCOUNT_EVENT_KEY.altName]) {
+      if (!_key) {
+        continue;
+      }
+      var _value = policies[_key];
+      if (_value && typeof _value == "object") {
+        ignoreInvitesPolicies = _value;
+        hasIgnoreInvitesPolicies = true;
+        break;
+      }
+    }
+    if (!hasIgnoreInvitesPolicies) {
+      policies[IGNORE_INVITES_ACCOUNT_EVENT_KEY.name] = ignoreInvitesPolicies;
+    }
+    return {
+      policies,
+      ignoreInvitesPolicies
+    };
+  }
+}
+//# sourceMappingURL=invites-ignorer.js.map

package/lib/models/invites-ignorer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"invites-ignorer.js","names":["EventTimeline","Preset","globToRegexp","EventType","IGNORE_INVITES_ACCOUNT_EVENT_KEY","POLICIES_ACCOUNT_EVENT_TYPE","PolicyRecommendation","PolicyScope","scopeToEventTypeMap","User","PolicyRuleUser","Room","PolicyRuleRoom","Server","PolicyRuleServer","IgnoredInvites","constructor","client","addRule","scope","entity","reason","_this","_asyncToGenerator","target","getOrCreateTargetRoom","response","sendStateEvent","roomId","recommendation","Ban","event_id","removeRule","event","_this2","redactEvent","getRoomId","getId","addSource","_this3","joinRoom","sources","getOrCreateSourceRooms","map","room","includes","push","withIgnoreInvitesPolicies","ignoreInvitesPolicies","getRuleForInvite","_ref","_this4","sender","policyRooms","senderServer","split","roomServer","state","getUnfilteredTimelineSet","getLiveTimeline","getState","FORWARDS","entities","events","getStateEvents","content","getContent","glob","regexp","RegExp","_unused","test","_this5","getIgnoreInvitesPolicies","getRoom","createRoom","name","preset","PrivateChat","room_id","_this6","hasChanges","Array","isArray","sourceRooms","filter","length","getPoliciesAndIgnoreInvitesPolicies","cb","_this7","policies","setAccountData","key","altName","_this$client$getAccou","value","getAccountData","hasIgnoreInvitesPolicies"],"sources":["../../src/models/invites-ignorer.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 { type BriijClient } from \"../client.ts\";\nimport { type IContent, type BriijEvent } from \"./event.ts\";\nimport { EventTimeline } from \"./event-timeline.ts\";\nimport { Preset } from \"../@types/partials.ts\";\nimport { globToRegexp } from \"../utils.ts\";\nimport { type Room } from \"./room.ts\";\nimport { EventType, type StateEvents } from \"../@types/event.ts\";\nimport {\n    IGNORE_INVITES_ACCOUNT_EVENT_KEY,\n    POLICIES_ACCOUNT_EVENT_TYPE,\n    PolicyRecommendation,\n    PolicyScope,\n} from \"./invites-ignorer-types.ts\";\n\nexport { IGNORE_INVITES_ACCOUNT_EVENT_KEY, POLICIES_ACCOUNT_EVENT_TYPE, PolicyRecommendation, PolicyScope };\n\nconst scopeToEventTypeMap: Record<PolicyScope, keyof StateEvents> = {\n    [PolicyScope.User]: EventType.PolicyRuleUser,\n    [PolicyScope.Room]: EventType.PolicyRuleRoom,\n    [PolicyScope.Server]: EventType.PolicyRuleServer,\n};\n\n/**\n * A container for ignored invites.\n *\n * # Performance\n *\n * This implementation is extremely naive. It expects that we are dealing\n * with a very short list of sources (e.g. only one). If real-world\n * applications turn out to require longer lists, we may need to rework\n * our data structures.\n */\nexport class IgnoredInvites {\n    public constructor(private readonly client: BriijClient) {}\n\n    /**\n     * Add a new rule.\n     *\n     * @param scope - The scope for this rule.\n     * @param entity - The entity covered by this rule. Globs are supported.\n     * @param reason - A human-readable reason for introducing this new rule.\n     * @returns The event id for the new rule.\n     */\n    public async addRule(scope: PolicyScope, entity: string, reason: string): Promise<string> {\n        const target = await this.getOrCreateTargetRoom();\n        const response = await this.client.sendStateEvent(target.roomId, scopeToEventTypeMap[scope], {\n            entity,\n            reason,\n            recommendation: PolicyRecommendation.Ban,\n        });\n        return response.event_id;\n    }\n\n    /**\n     * Remove a rule.\n     */\n    public async removeRule(event: BriijEvent): Promise<void> {\n        await this.client.redactEvent(event.getRoomId()!, event.getId()!);\n    }\n\n    /**\n     * Add a new room to the list of sources. If the user isn't a member of the\n     * room, attempt to join it.\n     *\n     * @param roomId - A valid room id. If this room is already in the list\n     * of sources, it will not be duplicated.\n     * @returns `true` if the source was added, `false` if it was already present.\n     * @throws If `roomId` isn't the id of a room that the current user is already\n     * member of or can join.\n     *\n     * # Safety\n     *\n     * This method will rewrite the `Policies` object in the user's account data.\n     * This rewrite is inherently racy and could overwrite or be overwritten by\n     * other concurrent rewrites of the same object.\n     */\n    public async addSource(roomId: string): Promise<boolean> {\n        // We attempt to join the room *before* calling\n        // `await this.getOrCreateSourceRooms()` to decrease the duration\n        // of the racy section.\n        await this.client.joinRoom(roomId);\n        // Race starts.\n        const sources = (await this.getOrCreateSourceRooms()).map((room) => room.roomId);\n        if (sources.includes(roomId)) {\n            return false;\n        }\n        sources.push(roomId);\n        await this.withIgnoreInvitesPolicies((ignoreInvitesPolicies) => {\n            ignoreInvitesPolicies.sources = sources;\n        });\n\n        // Race ends.\n        return true;\n    }\n\n    /**\n     * Find out whether an invite should be ignored.\n     *\n     * @param params\n     * @param params.sender - The user id for the user who issued the invite.\n     * @param params.roomId - The room to which the user is invited.\n     * @returns A rule matching the entity, if any was found, `null` otherwise.\n     */\n    public async getRuleForInvite({\n        sender,\n        roomId,\n    }: {\n        sender: string;\n        roomId: string;\n    }): Promise<Readonly<BriijEvent | null>> {\n        // In this implementation, we perform a very naive lookup:\n        // - search in each policy room;\n        // - turn each (potentially glob) rule entity into a regexp.\n        //\n        // Real-world testing will tell us whether this is performant enough.\n        // In the (unfortunately likely) case it isn't, there are several manners\n        // in which we could optimize this:\n        // - match several entities per go;\n        // - pre-compile each rule entity into a regexp;\n        // - pre-compile entire rooms into a single regexp.\n        const policyRooms = await this.getOrCreateSourceRooms();\n        const senderServer = sender.split(\":\")[1];\n        const roomServer = roomId.split(\":\")[1];\n        for (const room of policyRooms) {\n            const state = room.getUnfilteredTimelineSet().getLiveTimeline().getState(EventTimeline.FORWARDS)!;\n\n            for (const { scope, entities } of [\n                { scope: PolicyScope.Room, entities: [roomId] },\n                { scope: PolicyScope.User, entities: [sender] },\n                { scope: PolicyScope.Server, entities: [senderServer, roomServer] },\n            ]) {\n                const events = state.getStateEvents(scopeToEventTypeMap[scope]);\n                for (const event of events) {\n                    const content = event.getContent();\n                    if (content?.recommendation != PolicyRecommendation.Ban) {\n                        // Ignoring invites only looks at `m.ban` recommendations.\n                        continue;\n                    }\n                    const glob = content?.entity;\n                    if (!glob) {\n                        // Invalid event.\n                        continue;\n                    }\n                    let regexp: RegExp;\n                    try {\n                        regexp = new RegExp(globToRegexp(glob));\n                    } catch {\n                        // Assume invalid event.\n                        continue;\n                    }\n                    for (const entity of entities) {\n                        if (entity && regexp.test(entity)) {\n                            return event;\n                        }\n                    }\n                    // No match.\n                }\n            }\n        }\n        return null;\n    }\n\n    /**\n     * Get the target room, i.e. the room in which any new rule should be written.\n     *\n     * If there is no target room setup, a target room is created.\n     *\n     * Note: This method is public for testing reasons. Most clients should not need\n     * to call it directly.\n     *\n     * # Safety\n     *\n     * This method will rewrite the `Policies` object in the user's account data.\n     * This rewrite is inherently racy and could overwrite or be overwritten by\n     * other concurrent rewrites of the same object.\n     */\n    public async getOrCreateTargetRoom(): Promise<Room> {\n        const ignoreInvitesPolicies = this.getIgnoreInvitesPolicies();\n        let target = ignoreInvitesPolicies.target;\n        // Validate `target`. If it is invalid, trash out the current `target`\n        // and create a new room.\n        if (typeof target !== \"string\") {\n            target = null;\n        }\n        if (target) {\n            // Check that the room exists and is valid.\n            const room = this.client.getRoom(target);\n            if (room) {\n                return room;\n            } else {\n                target = null;\n            }\n        }\n        // We need to create our own policy room for ignoring invites.\n        target = (\n            await this.client.createRoom({\n                name: \"Individual Policy Room\",\n                preset: Preset.PrivateChat,\n            })\n        ).room_id;\n        await this.withIgnoreInvitesPolicies((ignoreInvitesPolicies) => {\n            ignoreInvitesPolicies.target = target;\n        });\n\n        // Since we have just called `createRoom`, `getRoom` should not be `null`.\n        return this.client.getRoom(target)!;\n    }\n\n    /**\n     * Get the list of source rooms, i.e. the rooms from which rules need to be read.\n     *\n     * If no source rooms are setup, the target room is used as sole source room.\n     *\n     * Note: This method is public for testing reasons. Most clients should not need\n     * to call it directly.\n     *\n     * # Safety\n     *\n     * This method will rewrite the `Policies` object in the user's account data.\n     * This rewrite is inherently racy and could overwrite or be overwritten by\n     * other concurrent rewrites of the same object.\n     */\n    public async getOrCreateSourceRooms(): Promise<Room[]> {\n        const ignoreInvitesPolicies = this.getIgnoreInvitesPolicies();\n        let sources: string[] = ignoreInvitesPolicies.sources;\n\n        // Validate `sources`. If it is invalid, trash out the current `sources`\n        // and create a new list of sources from `target`.\n        let hasChanges = false;\n        if (!Array.isArray(sources)) {\n            // `sources` could not be an array.\n            hasChanges = true;\n            sources = [];\n        }\n        let sourceRooms = sources\n            // `sources` could contain non-string / invalid room ids\n            .filter((roomId) => typeof roomId === \"string\")\n            .map((roomId) => this.client.getRoom(roomId))\n            .filter((room) => !!room) as Room[];\n        if (sourceRooms.length != sources.length) {\n            hasChanges = true;\n        }\n        if (sourceRooms.length == 0) {\n            // `sources` could be empty (possibly because we've removed\n            // invalid content)\n            const target = await this.getOrCreateTargetRoom();\n            hasChanges = true;\n            sourceRooms = [target];\n        }\n        if (hasChanges) {\n            // Reload `policies`/`ignoreInvitesPolicies` in case it has been changed\n            // during or by our call to `this.getTargetRoom()`.\n            await this.withIgnoreInvitesPolicies((ignoreInvitesPolicies) => {\n                ignoreInvitesPolicies.sources = sources;\n            });\n        }\n        return sourceRooms;\n    }\n\n    /**\n     * Fetch the `IGNORE_INVITES_POLICIES` object from account data.\n     *\n     * If both an unstable prefix version and a stable prefix version are available,\n     * it will return the stable prefix version preferentially.\n     *\n     * The result is *not* validated but is guaranteed to be a non-null object.\n     *\n     * @returns A non-null object.\n     */\n    private getIgnoreInvitesPolicies(): { [key: string]: any } {\n        return this.getPoliciesAndIgnoreInvitesPolicies().ignoreInvitesPolicies;\n    }\n\n    /**\n     * Modify in place the `IGNORE_INVITES_POLICIES` object from account data.\n     */\n    private async withIgnoreInvitesPolicies(\n        cb: (ignoreInvitesPolicies: { [key: string]: any }) => void,\n    ): Promise<void> {\n        const { policies, ignoreInvitesPolicies } = this.getPoliciesAndIgnoreInvitesPolicies();\n        cb(ignoreInvitesPolicies);\n        policies[IGNORE_INVITES_ACCOUNT_EVENT_KEY.name] = ignoreInvitesPolicies;\n        await this.client.setAccountData(POLICIES_ACCOUNT_EVENT_TYPE.name, policies);\n    }\n\n    /**\n     * As `getIgnoreInvitesPolicies` but also return the `POLICIES_ACCOUNT_EVENT_TYPE`\n     * object.\n     */\n    private getPoliciesAndIgnoreInvitesPolicies(): {\n        policies: { [key: string]: any };\n        ignoreInvitesPolicies: { [key: string]: any };\n    } {\n        let policies: IContent = {};\n        for (const key of [POLICIES_ACCOUNT_EVENT_TYPE.name, POLICIES_ACCOUNT_EVENT_TYPE.altName]) {\n            if (!key) {\n                continue;\n            }\n            const value = this.client.getAccountData(key)?.getContent();\n            if (value) {\n                policies = value;\n                break;\n            }\n        }\n\n        let ignoreInvitesPolicies = {};\n        let hasIgnoreInvitesPolicies = false;\n        for (const key of [IGNORE_INVITES_ACCOUNT_EVENT_KEY.name, IGNORE_INVITES_ACCOUNT_EVENT_KEY.altName]) {\n            if (!key) {\n                continue;\n            }\n            const value = policies[key];\n            if (value && typeof value == \"object\") {\n                ignoreInvitesPolicies = value;\n                hasIgnoreInvitesPolicies = true;\n                break;\n            }\n        }\n        if (!hasIgnoreInvitesPolicies) {\n            policies[IGNORE_INVITES_ACCOUNT_EVENT_KEY.name] = ignoreInvitesPolicies;\n        }\n\n        return { policies, ignoreInvitesPolicies };\n    }\n}\n"],"mappings":";AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAIA,SAASA,aAAa,QAAQ,qBAAqB;AACnD,SAASC,MAAM,QAAQ,uBAAuB;AAC9C,SAASC,YAAY,QAAQ,aAAa;AAE1C,SAASC,SAAS,QAA0B,oBAAoB;AAChE,SACIC,gCAAgC,EAChCC,2BAA2B,EAC3BC,oBAAoB,EACpBC,WAAW,QACR,4BAA4B;AAEnC,SAASH,gCAAgC,EAAEC,2BAA2B,EAAEC,oBAAoB,EAAEC,WAAW;AAEzG,IAAMC,mBAA2D,GAAG;EAChE,CAACD,WAAW,CAACE,IAAI,GAAGN,SAAS,CAACO,cAAc;EAC5C,CAACH,WAAW,CAACI,IAAI,GAAGR,SAAS,CAACS,cAAc;EAC5C,CAACL,WAAW,CAACM,MAAM,GAAGV,SAAS,CAACW;AACpC,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,cAAc,CAAC;EACjBC,WAAWA,CAAkBC,MAAmB,EAAE;IAAA,KAArBA,MAAmB,GAAnBA,MAAmB;EAAG;;EAE1D;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;EACiBC,OAAOA,CAACC,KAAkB,EAAEC,MAAc,EAAEC,MAAc,EAAmB;IAAA,IAAAC,KAAA;IAAA,OAAAC,iBAAA;MACtF,IAAMC,MAAM,SAASF,KAAI,CAACG,qBAAqB,CAAC,CAAC;MACjD,IAAMC,QAAQ,SAASJ,KAAI,CAACL,MAAM,CAACU,cAAc,CAACH,MAAM,CAACI,MAAM,EAAEpB,mBAAmB,CAACW,KAAK,CAAC,EAAE;QACzFC,MAAM;QACNC,MAAM;QACNQ,cAAc,EAAEvB,oBAAoB,CAACwB;MACzC,CAAC,CAAC;MACF,OAAOJ,QAAQ,CAACK,QAAQ;IAAC;EAC7B;;EAEA;AACJ;AACA;EACiBC,UAAUA,CAACC,KAAiB,EAAiB;IAAA,IAAAC,MAAA;IAAA,OAAAX,iBAAA;MACtD,MAAMW,MAAI,CAACjB,MAAM,CAACkB,WAAW,CAACF,KAAK,CAACG,SAAS,CAAC,CAAC,EAAGH,KAAK,CAACI,KAAK,CAAC,CAAE,CAAC;IAAC;EACtE;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACiBC,SAASA,CAACV,MAAc,EAAoB;IAAA,IAAAW,MAAA;IAAA,OAAAhB,iBAAA;MACrD;MACA;MACA;MACA,MAAMgB,MAAI,CAACtB,MAAM,CAACuB,QAAQ,CAACZ,MAAM,CAAC;MAClC;MACA,IAAMa,OAAO,GAAG,OAAOF,MAAI,CAACG,sBAAsB,CAAC,CAAC,EAAEC,GAAG,CAAEC,IAAI,IAAKA,IAAI,CAAChB,MAAM,CAAC;MAChF,IAAIa,OAAO,CAACI,QAAQ,CAACjB,MAAM,CAAC,EAAE;QAC1B,OAAO,KAAK;MAChB;MACAa,OAAO,CAACK,IAAI,CAAClB,MAAM,CAAC;MACpB,MAAMW,MAAI,CAACQ,yBAAyB,CAAEC,qBAAqB,IAAK;QAC5DA,qBAAqB,CAACP,OAAO,GAAGA,OAAO;MAC3C,CAAC,CAAC;;MAEF;MACA,OAAO,IAAI;IAAC;EAChB;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;EACiBQ,gBAAgBA,CAAAC,IAAA,EAMY;IAAA,IAAAC,MAAA;IAAA,OAAA5B,iBAAA;MAAA,IANX;QAC1B6B,MAAM;QACNxB;MAIJ,CAAC,GAAAsB,IAAA;MACG;MACA;MACA;MACA;MACA;MACA;MACA;MACA;MACA;MACA;MACA,IAAMG,WAAW,SAASF,MAAI,CAACT,sBAAsB,CAAC,CAAC;MACvD,IAAMY,YAAY,GAAGF,MAAM,CAACG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;MACzC,IAAMC,UAAU,GAAG5B,MAAM,CAAC2B,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;MACvC,KAAK,IAAMX,IAAI,IAAIS,WAAW,EAAE;QAC5B,IAAMI,KAAK,GAAGb,IAAI,CAACc,wBAAwB,CAAC,CAAC,CAACC,eAAe,CAAC,CAAC,CAACC,QAAQ,CAAC5D,aAAa,CAAC6D,QAAQ,CAAE;QAEjG,KAAK,IAAM;UAAE1C,KAAK;UAAE2C;QAAS,CAAC,IAAI,CAC9B;UAAE3C,KAAK,EAAEZ,WAAW,CAACI,IAAI;UAAEmD,QAAQ,EAAE,CAAClC,MAAM;QAAE,CAAC,EAC/C;UAAET,KAAK,EAAEZ,WAAW,CAACE,IAAI;UAAEqD,QAAQ,EAAE,CAACV,MAAM;QAAE,CAAC,EAC/C;UAAEjC,KAAK,EAAEZ,WAAW,CAACM,MAAM;UAAEiD,QAAQ,EAAE,CAACR,YAAY,EAAEE,UAAU;QAAE,CAAC,CACtE,EAAE;UACC,IAAMO,MAAM,GAAGN,KAAK,CAACO,cAAc,CAACxD,mBAAmB,CAACW,KAAK,CAAC,CAAC;UAC/D,KAAK,IAAMc,KAAK,IAAI8B,MAAM,EAAE;YACxB,IAAME,OAAO,GAAGhC,KAAK,CAACiC,UAAU,CAAC,CAAC;YAClC,IAAI,CAAAD,OAAO,aAAPA,OAAO,uBAAPA,OAAO,CAAEpC,cAAc,KAAIvB,oBAAoB,CAACwB,GAAG,EAAE;cACrD;cACA;YACJ;YACA,IAAMqC,IAAI,GAAGF,OAAO,aAAPA,OAAO,uBAAPA,OAAO,CAAE7C,MAAM;YAC5B,IAAI,CAAC+C,IAAI,EAAE;cACP;cACA;YACJ;YACA,IAAIC,MAAc;YAClB,IAAI;cACAA,MAAM,GAAG,IAAIC,MAAM,CAACnE,YAAY,CAACiE,IAAI,CAAC,CAAC;YAC3C,CAAC,CAAC,OAAAG,OAAA,EAAM;cACJ;cACA;YACJ;YACA,KAAK,IAAMlD,MAAM,IAAI0C,QAAQ,EAAE;cAC3B,IAAI1C,MAAM,IAAIgD,MAAM,CAACG,IAAI,CAACnD,MAAM,CAAC,EAAE;gBAC/B,OAAOa,KAAK;cAChB;YACJ;YACA;UACJ;QACJ;MACJ;MACA,OAAO,IAAI;IAAC;EAChB;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACiBR,qBAAqBA,CAAA,EAAkB;IAAA,IAAA+C,MAAA;IAAA,OAAAjD,iBAAA;MAChD,IAAMyB,qBAAqB,GAAGwB,MAAI,CAACC,wBAAwB,CAAC,CAAC;MAC7D,IAAIjD,MAAM,GAAGwB,qBAAqB,CAACxB,MAAM;MACzC;MACA;MACA,IAAI,OAAOA,MAAM,KAAK,QAAQ,EAAE;QAC5BA,MAAM,GAAG,IAAI;MACjB;MACA,IAAIA,MAAM,EAAE;QACR;QACA,IAAMoB,IAAI,GAAG4B,MAAI,CAACvD,MAAM,CAACyD,OAAO,CAAClD,MAAM,CAAC;QACxC,IAAIoB,IAAI,EAAE;UACN,OAAOA,IAAI;QACf,CAAC,MAAM;UACHpB,MAAM,GAAG,IAAI;QACjB;MACJ;MACA;MACAA,MAAM,GAAG,OACCgD,MAAI,CAACvD,MAAM,CAAC0D,UAAU,CAAC;QACzBC,IAAI,EAAE,wBAAwB;QAC9BC,MAAM,EAAE5E,MAAM,CAAC6E;MACnB,CAAC,CAAC,EACJC,OAAO;MACT,MAAMP,MAAI,CAACzB,yBAAyB,CAAEC,qBAAqB,IAAK;QAC5DA,qBAAqB,CAACxB,MAAM,GAAGA,MAAM;MACzC,CAAC,CAAC;;MAEF;MACA,OAAOgD,MAAI,CAACvD,MAAM,CAACyD,OAAO,CAAClD,MAAM,CAAC;IAAE;EACxC;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACiBkB,sBAAsBA,CAAA,EAAoB;IAAA,IAAAsC,MAAA;IAAA,OAAAzD,iBAAA;MACnD,IAAMyB,qBAAqB,GAAGgC,MAAI,CAACP,wBAAwB,CAAC,CAAC;MAC7D,IAAIhC,OAAiB,GAAGO,qBAAqB,CAACP,OAAO;;MAErD;MACA;MACA,IAAIwC,UAAU,GAAG,KAAK;MACtB,IAAI,CAACC,KAAK,CAACC,OAAO,CAAC1C,OAAO,CAAC,EAAE;QACzB;QACAwC,UAAU,GAAG,IAAI;QACjBxC,OAAO,GAAG,EAAE;MAChB;MACA,IAAI2C,WAAW,GAAG3C;MACd;MAAA,CACC4C,MAAM,CAAEzD,MAAM,IAAK,OAAOA,MAAM,KAAK,QAAQ,CAAC,CAC9Ce,GAAG,CAAEf,MAAM,IAAKoD,MAAI,CAAC/D,MAAM,CAACyD,OAAO,CAAC9C,MAAM,CAAC,CAAC,CAC5CyD,MAAM,CAAEzC,IAAI,IAAK,CAAC,CAACA,IAAI,CAAW;MACvC,IAAIwC,WAAW,CAACE,MAAM,IAAI7C,OAAO,CAAC6C,MAAM,EAAE;QACtCL,UAAU,GAAG,IAAI;MACrB;MACA,IAAIG,WAAW,CAACE,MAAM,IAAI,CAAC,EAAE;QACzB;QACA;QACA,IAAM9D,MAAM,SAASwD,MAAI,CAACvD,qBAAqB,CAAC,CAAC;QACjDwD,UAAU,GAAG,IAAI;QACjBG,WAAW,GAAG,CAAC5D,MAAM,CAAC;MAC1B;MACA,IAAIyD,UAAU,EAAE;QACZ;QACA;QACA,MAAMD,MAAI,CAACjC,yBAAyB,CAAEC,qBAAqB,IAAK;UAC5DA,qBAAqB,CAACP,OAAO,GAAGA,OAAO;QAC3C,CAAC,CAAC;MACN;MACA,OAAO2C,WAAW;IAAC;EACvB;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACYX,wBAAwBA,CAAA,EAA2B;IACvD,OAAO,IAAI,CAACc,mCAAmC,CAAC,CAAC,CAACvC,qBAAqB;EAC3E;;EAEA;AACJ;AACA;EACkBD,yBAAyBA,CACnCyC,EAA2D,EAC9C;IAAA,IAAAC,MAAA;IAAA,OAAAlE,iBAAA;MACb,IAAM;QAAEmE,QAAQ;QAAE1C;MAAsB,CAAC,GAAGyC,MAAI,CAACF,mCAAmC,CAAC,CAAC;MACtFC,EAAE,CAACxC,qBAAqB,CAAC;MACzB0C,QAAQ,CAACtF,gCAAgC,CAACwE,IAAI,CAAC,GAAG5B,qBAAqB;MACvE,MAAMyC,MAAI,CAACxE,MAAM,CAAC0E,cAAc,CAACtF,2BAA2B,CAACuE,IAAI,EAAEc,QAAQ,CAAC;IAAC;EACjF;;EAEA;AACJ;AACA;AACA;EACYH,mCAAmCA,CAAA,EAGzC;IACE,IAAIG,QAAkB,GAAG,CAAC,CAAC;IAC3B,KAAK,IAAME,GAAG,IAAI,CAACvF,2BAA2B,CAACuE,IAAI,EAAEvE,2BAA2B,CAACwF,OAAO,CAAC,EAAE;MAAA,IAAAC,qBAAA;MACvF,IAAI,CAACF,GAAG,EAAE;QACN;MACJ;MACA,IAAMG,KAAK,IAAAD,qBAAA,GAAG,IAAI,CAAC7E,MAAM,CAAC+E,cAAc,CAACJ,GAAG,CAAC,cAAAE,qBAAA,uBAA/BA,qBAAA,CAAiC5B,UAAU,CAAC,CAAC;MAC3D,IAAI6B,KAAK,EAAE;QACPL,QAAQ,GAAGK,KAAK;QAChB;MACJ;IACJ;IAEA,IAAI/C,qBAAqB,GAAG,CAAC,CAAC;IAC9B,IAAIiD,wBAAwB,GAAG,KAAK;IACpC,KAAK,IAAML,IAAG,IAAI,CAACxF,gCAAgC,CAACwE,IAAI,EAAExE,gCAAgC,CAACyF,OAAO,CAAC,EAAE;MACjG,IAAI,CAACD,IAAG,EAAE;QACN;MACJ;MACA,IAAMG,MAAK,GAAGL,QAAQ,CAACE,IAAG,CAAC;MAC3B,IAAIG,MAAK,IAAI,OAAOA,MAAK,IAAI,QAAQ,EAAE;QACnC/C,qBAAqB,GAAG+C,MAAK;QAC7BE,wBAAwB,GAAG,IAAI;QAC/B;MACJ;IACJ;IACA,IAAI,CAACA,wBAAwB,EAAE;MAC3BP,QAAQ,CAACtF,gCAAgC,CAACwE,IAAI,CAAC,GAAG5B,qBAAqB;IAC3E;IAEA,OAAO;MAAE0C,QAAQ;MAAE1C;IAAsB,CAAC;EAC9C;AACJ","ignoreList":[]}

package/lib/models/poll.d.ts

@@ -0,0 +1,67 @@
+import { type BriijClient } from "../client.ts";
+import { type PollStartEvent } from "../extensible_events_v1/PollStartEvent.ts";
+import { type BriijEvent } from "./event.ts";
+import { Relations } from "./relations.ts";
+import { type Room } from "./room.ts";
+import { TypedEventEmitter } from "./typed-event-emitter.ts";
+export declare enum PollEvent {
+    New = "Poll.new",
+    End = "Poll.end",
+    Update = "Poll.update",
+    Responses = "Poll.Responses",
+    Destroy = "Poll.Destroy",
+    UndecryptableRelations = "Poll.UndecryptableRelations"
+}
+export type PollEventHandlerMap = {
+    [PollEvent.Update]: (event: BriijEvent, poll: Poll) => void;
+    [PollEvent.Destroy]: (pollIdentifier: string) => void;
+    [PollEvent.End]: () => void;
+    [PollEvent.Responses]: (responses: Relations) => void;
+    [PollEvent.UndecryptableRelations]: (count: number) => void;
+};
+export declare class Poll extends TypedEventEmitter<Exclude<PollEvent, PollEvent.New>, PollEventHandlerMap> {
+    readonly rootEvent: BriijEvent;
+    private matrixClient;
+    private room;
+    readonly roomId: string;
+    readonly pollEvent: PollStartEvent;
+    private _isFetchingResponses;
+    private relationsNextBatch;
+    private responses;
+    private endEvent;
+    /**
+     * Keep track of undecryptable relations
+     * As incomplete result sets affect poll results
+     */
+    private undecryptableRelationEventIds;
+    constructor(rootEvent: BriijEvent, matrixClient: BriijClient, room: Room);
+    get pollId(): string;
+    get endEventId(): string | undefined;
+    get isEnded(): boolean;
+    get isFetchingResponses(): boolean;
+    get undecryptableRelationsCount(): number;
+    getResponses(): Promise<Relations>;
+    /**
+     *
+     * @param event - event with a relation to the rootEvent
+     * @returns void
+     */
+    onNewRelation(event: BriijEvent): void;
+    private fetchResponses;
+    /**
+     * Only responses made before the poll ended are valid
+     * Refilter after an end event is recieved
+     * To ensure responses are valid
+     */
+    private refilterResponsesOnEnd;
+    private countUndecryptableEvents;
+    private validateEndEvent;
+}
+/**
+ * Tests whether the event is a start, response or end poll event.
+ *
+ * @param event - Event to test
+ * @returns true if the event is a poll event, else false
+ */
+export declare const isPollEvent: (event: BriijEvent) => boolean;
+//# sourceMappingURL=poll.d.ts.map

package/lib/models/poll.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"poll.d.ts","sourceRoot":"","sources":["../../src/models/poll.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,2CAA2C,CAAC;AAChF,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAE7D,oBAAY,SAAS;IACjB,GAAG,aAAa;IAChB,GAAG,aAAa;IAChB,MAAM,gBAAgB;IACtB,SAAS,mBAAmB;IAC5B,OAAO,iBAAiB;IACxB,sBAAsB,gCAAgC;CACzD;AAED,MAAM,MAAM,mBAAmB,GAAG;IAC9B,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,KAAK,IAAI,CAAC;IAC5D,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,IAAI,CAAC;IACtD,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,MAAM,IAAI,CAAC;IAC5B,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,EAAE,SAAS,KAAK,IAAI,CAAC;IACtD,CAAC,SAAS,CAAC,sBAAsB,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;CAC/D,CAAC;AAuBF,qBAAa,IAAK,SAAQ,iBAAiB,CAAC,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,GAAG,CAAC,EAAE,mBAAmB,CAAC;aAc3E,SAAS,EAAE,UAAU;IACrC,OAAO,CAAC,YAAY;IACpB,OAAO,CAAC,IAAI;IAfhB,SAAgB,MAAM,EAAE,MAAM,CAAC;IAC/B,SAAgB,SAAS,EAAE,cAAc,CAAC;IAC1C,OAAO,CAAC,oBAAoB,CAAS;IACrC,OAAO,CAAC,kBAAkB,CAAqB;IAC/C,OAAO,CAAC,SAAS,CAA0B;IAC3C,OAAO,CAAC,QAAQ,CAAyB;IACzC;;;OAGG;IACH,OAAO,CAAC,6BAA6B,CAAqB;gBAGtC,SAAS,EAAE,UAAU,EAC7B,YAAY,EAAE,WAAW,EACzB,IAAI,EAAE,IAAI;IAUtB,IAAW,MAAM,IAAI,MAAM,CAE1B;IAED,IAAW,UAAU,IAAI,MAAM,GAAG,SAAS,CAE1C;IAED,IAAW,OAAO,IAAI,OAAO,CAE5B;IAED,IAAW,mBAAmB,IAAI,OAAO,CAExC;IAED,IAAW,2BAA2B,IAAI,MAAM,CAE/C;IAEY,YAAY,IAAI,OAAO,CAAC,SAAS,CAAC;IAgB/C;;;;OAIG;IACI,aAAa,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI;YA0B/B,cAAc;IA0D5B;;;;OAIG;IACH,OAAO,CAAC,sBAAsB;IAe9B,OAAO,CAAC,wBAAwB,CAW9B;IAEF,OAAO,CAAC,gBAAgB;CAyB3B;AAED;;;;;GAKG;AACH,eAAO,MAAM,WAAW,GAAI,OAAO,UAAU,KAAG,OAG/C,CAAC"}