@textrp/briij-js-sdk 41.0.1 → 43.0.0

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

@@ -1 +1 @@
-{"version":3,"file":"invites-ignorer-types.js","names":["UnstableValue","POLICIES_ACCOUNT_EVENT_TYPE","IGNORE_INVITES_ACCOUNT_EVENT_KEY","PolicyRecommendation","PolicyScope"],"sources":["../../src/models/invites-ignorer-types.ts"],"sourcesContent":["/*\r\nCopyright 2022 The Matrix.org Foundation C.I.C.\r\n\r\nLicensed under the Apache License, Version 2.0 (the \"License\");\r\nyou may not use this file except in compliance with the License.\r\nYou may obtain a copy of the License at\r\n\r\n    http://www.apache.org/licenses/LICENSE-2.0\r\n\r\nUnless required by applicable law or agreed to in writing, software\r\ndistributed under the License is distributed on an \"AS IS\" BASIS,\r\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r\nSee the License for the specific language governing permissions and\r\nlimitations under the License.\r\n*/\r\n\r\nimport { UnstableValue } from \"matrix-events-sdk\";\r\n\r\n/// The event type storing the user's individual policies.\r\n///\r\n/// Exported for testing purposes.\r\nexport const POLICIES_ACCOUNT_EVENT_TYPE = new UnstableValue(\"m.policies\", \"org.matrix.msc3847.policies\");\r\n\r\n/// The key within the user's individual policies storing the user's ignored invites.\r\n///\r\n/// Exported for testing purposes.\r\nexport const IGNORE_INVITES_ACCOUNT_EVENT_KEY = new UnstableValue(\r\n    \"m.ignore.invites\",\r\n    \"org.matrix.msc3847.ignore.invites\",\r\n);\r\n\r\n/// The types of recommendations understood.\r\nexport enum PolicyRecommendation {\r\n    Ban = \"m.ban\",\r\n}\r\n\r\n/**\r\n * The various scopes for policies.\r\n */\r\nexport enum PolicyScope {\r\n    /**\r\n     * The policy deals with an individual user, e.g. reject invites\r\n     * from this user.\r\n     */\r\n    User = \"m.policy.user\",\r\n\r\n    /**\r\n     * The policy deals with a room, e.g. reject invites towards\r\n     * a specific room.\r\n     */\r\n    Room = \"m.policy.room\",\r\n\r\n    /**\r\n     * The policy deals with a server, e.g. reject invites from\r\n     * this server.\r\n     */\r\n    Server = \"m.policy.server\",\r\n}\r\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,aAAa,QAAQ,mBAAmB;;AAEjD;AACA;AACA;AACA,OAAO,IAAMC,2BAA2B,GAAG,IAAID,aAAa,CAAC,YAAY,EAAE,6BAA6B,CAAC;;AAEzG;AACA;AACA;AACA,OAAO,IAAME,gCAAgC,GAAG,IAAIF,aAAa,CAC7D,kBAAkB,EAClB,mCACJ,CAAC;;AAED;AACA,WAAYG,oBAAoB,0BAApBA,oBAAoB;EAApBA,oBAAoB;EAAA,OAApBA,oBAAoB;AAAA;;AAIhC;AACA;AACA;AACA,WAAYC,WAAW,0BAAXA,WAAW;EACnB;AACJ;AACA;AACA;EAJYA,WAAW;EAOnB;AACJ;AACA;AACA;EAVYA,WAAW;EAanB;AACJ;AACA;AACA;EAhBYA,WAAW;EAAA,OAAXA,WAAW;AAAA","ignoreList":[]}
+{"version":3,"file":"invites-ignorer-types.js","names":["UnstableValue","POLICIES_ACCOUNT_EVENT_TYPE","IGNORE_INVITES_ACCOUNT_EVENT_KEY","PolicyRecommendation","PolicyScope"],"sources":["../../src/models/invites-ignorer-types.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 { UnstableValue } from \"matrix-events-sdk\";\n\n/// The event type storing the user's individual policies.\n///\n/// Exported for testing purposes.\nexport const POLICIES_ACCOUNT_EVENT_TYPE = new UnstableValue(\"m.policies\", \"org.matrix.msc3847.policies\");\n\n/// The key within the user's individual policies storing the user's ignored invites.\n///\n/// Exported for testing purposes.\nexport const IGNORE_INVITES_ACCOUNT_EVENT_KEY = new UnstableValue(\n    \"m.ignore.invites\",\n    \"org.matrix.msc3847.ignore.invites\",\n);\n\n/// The types of recommendations understood.\nexport enum PolicyRecommendation {\n    Ban = \"m.ban\",\n}\n\n/**\n * The various scopes for policies.\n */\nexport enum PolicyScope {\n    /**\n     * The policy deals with an individual user, e.g. reject invites\n     * from this user.\n     */\n    User = \"m.policy.user\",\n\n    /**\n     * The policy deals with a room, e.g. reject invites towards\n     * a specific room.\n     */\n    Room = \"m.policy.room\",\n\n    /**\n     * The policy deals with a server, e.g. reject invites from\n     * this server.\n     */\n    Server = \"m.policy.server\",\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,aAAa,QAAQ,mBAAmB;;AAEjD;AACA;AACA;AACA,OAAO,IAAMC,2BAA2B,GAAG,IAAID,aAAa,CAAC,YAAY,EAAE,6BAA6B,CAAC;;AAEzG;AACA;AACA;AACA,OAAO,IAAME,gCAAgC,GAAG,IAAIF,aAAa,CAC7D,kBAAkB,EAClB,mCACJ,CAAC;;AAED;AACA,WAAYG,oBAAoB,0BAApBA,oBAAoB;EAApBA,oBAAoB;EAAA,OAApBA,oBAAoB;AAAA;;AAIhC;AACA;AACA;AACA,WAAYC,WAAW,0BAAXA,WAAW;EACnB;AACJ;AACA;AACA;EAJYA,WAAW;EAOnB;AACJ;AACA;AACA;EAVYA,WAAW;EAanB;AACJ;AACA;AACA;EAhBYA,WAAW;EAAA,OAAXA,WAAW;AAAA","ignoreList":[]}

package/lib/models/profile-keys.js

@@ -1,34 +1,34 @@
-/*
-Copyright 2025 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.
+/*
+Copyright 2025 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.
 */
 
-/**
- * The timezone the user is currently in. The value of this property should
- * match a timezone provided in https://www.iana.org/time-zones.
- *
- * This key was introduced in Matrix v1.16.
+/**
+ * The timezone the user is currently in. The value of this property should
+ * match a timezone provided in https://www.iana.org/time-zones.
+ *
+ * This key was introduced in Matrix v1.16.
  */
 export var ProfileKeyTimezone = "m.tz";
 
-/**
- * The timezone the user is currently in. The value of this property should
- * match a timezone provided in https://www.iana.org/time-zones.
- *
- * @see https://github.com/matrix-org/matrix-spec-proposals/blob/clokep/profile-tz/proposals/4175-profile-field-time-zone.md
- * @experimental
- * @deprecated Unstable MSC field - Use `ProfileKeyTimezone`
+/**
+ * The timezone the user is currently in. The value of this property should
+ * match a timezone provided in https://www.iana.org/time-zones.
+ *
+ * @see https://github.com/matrix-org/matrix-spec-proposals/blob/clokep/profile-tz/proposals/4175-profile-field-time-zone.md
+ * @experimental
+ * @deprecated Unstable MSC field - Use `ProfileKeyTimezone`
  */
 export var ProfileKeyMSC4175Timezone = "us.cloke.msc4175.tz";
 //# sourceMappingURL=profile-keys.js.map

package/lib/models/profile-keys.js.map

@@ -1 +1 @@
-{"version":3,"file":"profile-keys.js","names":["ProfileKeyTimezone","ProfileKeyMSC4175Timezone"],"sources":["../../src/models/profile-keys.ts"],"sourcesContent":["/*\r\nCopyright 2025 The Matrix.org Foundation C.I.C.\r\n\r\nLicensed under the Apache License, Version 2.0 (the \"License\");\r\nyou may not use this file except in compliance with the License.\r\nYou may obtain a copy of the License at\r\n\r\n    http://www.apache.org/licenses/LICENSE-2.0\r\n\r\nUnless required by applicable law or agreed to in writing, software\r\ndistributed under the License is distributed on an \"AS IS\" BASIS,\r\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r\nSee the License for the specific language governing permissions and\r\nlimitations under the License.\r\n*/\r\n\r\n/**\r\n * The timezone the user is currently in. The value of this property should\r\n * match a timezone provided in https://www.iana.org/time-zones.\r\n *\r\n * This key was introduced in Matrix v1.16.\r\n */\r\nexport const ProfileKeyTimezone = \"m.tz\";\r\n\r\n/**\r\n * The timezone the user is currently in. The value of this property should\r\n * match a timezone provided in https://www.iana.org/time-zones.\r\n *\r\n * @see https://github.com/matrix-org/matrix-spec-proposals/blob/clokep/profile-tz/proposals/4175-profile-field-time-zone.md\r\n * @experimental\r\n * @deprecated Unstable MSC field - Use `ProfileKeyTimezone`\r\n */\r\nexport const ProfileKeyMSC4175Timezone = \"us.cloke.msc4175.tz\";\r\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,IAAMA,kBAAkB,GAAG,MAAM;;AAExC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,IAAMC,yBAAyB,GAAG,qBAAqB","ignoreList":[]}
+{"version":3,"file":"profile-keys.js","names":["ProfileKeyTimezone","ProfileKeyMSC4175Timezone"],"sources":["../../src/models/profile-keys.ts"],"sourcesContent":["/*\nCopyright 2025 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\n/**\n * The timezone the user is currently in. The value of this property should\n * match a timezone provided in https://www.iana.org/time-zones.\n *\n * This key was introduced in Matrix v1.16.\n */\nexport const ProfileKeyTimezone = \"m.tz\";\n\n/**\n * The timezone the user is currently in. The value of this property should\n * match a timezone provided in https://www.iana.org/time-zones.\n *\n * @see https://github.com/matrix-org/matrix-spec-proposals/blob/clokep/profile-tz/proposals/4175-profile-field-time-zone.md\n * @experimental\n * @deprecated Unstable MSC field - Use `ProfileKeyTimezone`\n */\nexport const ProfileKeyMSC4175Timezone = \"us.cloke.msc4175.tz\";\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,IAAMA,kBAAkB,GAAG,MAAM;;AAExC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,IAAMC,yBAAyB,GAAG,qBAAqB","ignoreList":[]}

package/lib/models/room-summary.js

@@ -1,35 +1,35 @@
-/*
-Copyright 2015 - 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.
+/*
+Copyright 2015 - 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.
 */
 
-/**
- * A stripped m.room.member event which contains the key renderable fields from the event,
- * sent only in simplified sliding sync (not `/v3/sync`).
- * This is very similar to MSC4186Hero from sliding-sync.ts but an internal format with
- * camelCase rather than underscores.
+/**
+ * A stripped m.room.member event which contains the key renderable fields from the event,
+ * sent only in simplified sliding sync (not `/v3/sync`).
+ * This is very similar to MSC4186Hero from sliding-sync.ts but an internal format with
+ * camelCase rather than underscores.
  */
 
-/**
- * High level summary information for a room, as returned by `/v3/sync`.
+/**
+ * High level summary information for a room, as returned by `/v3/sync`.
  */
 
-/**
- * Construct a new Room Summary. A summary can be used for display on a recent
- * list, without having to load the entire room list into memory.
- * @param roomId - Required. The ID of this room.
- * @param info - Optional. The summary info. Additional keys are supported.
+/**
+ * Construct a new Room Summary. A summary can be used for display on a recent
+ * list, without having to load the entire room list into memory.
+ * @param roomId - Required. The ID of this room.
+ * @param info - Optional. The summary info. Additional keys are supported.
  */
 export class RoomSummary {
   constructor(roomId, info) {

package/lib/models/room-summary.js.map

@@ -1 +1 @@
-{"version":3,"file":"room-summary.js","names":["RoomSummary","constructor","roomId","info"],"sources":["../../src/models/room-summary.ts"],"sourcesContent":["/*\r\nCopyright 2015 - 2021 The Matrix.org Foundation C.I.C.\r\n\r\nLicensed under the Apache License, Version 2.0 (the \"License\");\r\nyou may not use this file except in compliance with the License.\r\nYou may obtain a copy of the License at\r\n\r\n    http://www.apache.org/licenses/LICENSE-2.0\r\n\r\nUnless required by applicable law or agreed to in writing, software\r\ndistributed under the License is distributed on an \"AS IS\" BASIS,\r\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r\nSee the License for the specific language governing permissions and\r\nlimitations under the License.\r\n*/\r\n\r\n/**\r\n * A stripped m.room.member event which contains the key renderable fields from the event,\r\n * sent only in simplified sliding sync (not `/v3/sync`).\r\n * This is very similar to MSC4186Hero from sliding-sync.ts but an internal format with\r\n * camelCase rather than underscores.\r\n */\r\nexport type Hero = {\r\n    userId: string;\r\n    displayName?: string;\r\n    avatarUrl?: string;\r\n    /**\r\n     * If true, the hero is from an MSC4186 summary, in which case `displayName` and `avatarUrl` will\r\n     * have been set by the server if available. If false, the `Hero` has been constructed from a `/v3/sync` response,\r\n     * so these fields will always be undefined.\r\n     */\r\n    fromMSC4186: boolean;\r\n};\r\n\r\n/**\r\n * High level summary information for a room, as returned by `/v3/sync`.\r\n */\r\nexport interface IRoomSummary {\r\n    /**\r\n     * The room heroes: a selected set of members that can be used when summarising or\r\n     * generating a name for a room. List of user IDs.\r\n     */\r\n    \"m.heroes\": string[];\r\n    /**\r\n     * The number of joined members in the room.\r\n     */\r\n    \"m.joined_member_count\"?: number;\r\n    /**\r\n     * The number of invited members in the room.\r\n     */\r\n    \"m.invited_member_count\"?: number;\r\n}\r\n\r\ninterface IInfo {\r\n    /** The title of the room (e.g. `m.room.name`) */\r\n    title: string;\r\n    /** The description of the room (e.g. `m.room.topic`) */\r\n    desc?: string;\r\n    /** The number of joined users. */\r\n    numMembers?: number;\r\n    /** The list of aliases for this room. */\r\n    aliases?: string[];\r\n    /** The timestamp for this room. */\r\n    timestamp?: number;\r\n}\r\n\r\n/**\r\n * Construct a new Room Summary. A summary can be used for display on a recent\r\n * list, without having to load the entire room list into memory.\r\n * @param roomId - Required. The ID of this room.\r\n * @param info - Optional. The summary info. Additional keys are supported.\r\n */\r\nexport class RoomSummary {\r\n    public constructor(\r\n        public readonly roomId: string,\r\n        info?: IInfo,\r\n    ) {}\r\n}\r\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;;AAaA;AACA;AACA;;AA8BA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMA,WAAW,CAAC;EACdC,WAAWA,CACEC,MAAc,EAC9BC,IAAY,EACd;IAAA,KAFkBD,MAAc,GAAdA,MAAc;EAE/B;AACP","ignoreList":[]}
+{"version":3,"file":"room-summary.js","names":["RoomSummary","constructor","roomId","info"],"sources":["../../src/models/room-summary.ts"],"sourcesContent":["/*\nCopyright 2015 - 2021 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\n/**\n * A stripped m.room.member event which contains the key renderable fields from the event,\n * sent only in simplified sliding sync (not `/v3/sync`).\n * This is very similar to MSC4186Hero from sliding-sync.ts but an internal format with\n * camelCase rather than underscores.\n */\nexport type Hero = {\n    userId: string;\n    displayName?: string;\n    avatarUrl?: string;\n    /**\n     * If true, the hero is from an MSC4186 summary, in which case `displayName` and `avatarUrl` will\n     * have been set by the server if available. If false, the `Hero` has been constructed from a `/v3/sync` response,\n     * so these fields will always be undefined.\n     */\n    fromMSC4186: boolean;\n};\n\n/**\n * High level summary information for a room, as returned by `/v3/sync`.\n */\nexport interface IRoomSummary {\n    /**\n     * The room heroes: a selected set of members that can be used when summarising or\n     * generating a name for a room. List of user IDs.\n     */\n    \"m.heroes\": string[];\n    /**\n     * The number of joined members in the room.\n     */\n    \"m.joined_member_count\"?: number;\n    /**\n     * The number of invited members in the room.\n     */\n    \"m.invited_member_count\"?: number;\n}\n\ninterface IInfo {\n    /** The title of the room (e.g. `m.room.name`) */\n    title: string;\n    /** The description of the room (e.g. `m.room.topic`) */\n    desc?: string;\n    /** The number of joined users. */\n    numMembers?: number;\n    /** The list of aliases for this room. */\n    aliases?: string[];\n    /** The timestamp for this room. */\n    timestamp?: number;\n}\n\n/**\n * Construct a new Room Summary. A summary can be used for display on a recent\n * list, without having to load the entire room list into memory.\n * @param roomId - Required. The ID of this room.\n * @param info - Optional. The summary info. Additional keys are supported.\n */\nexport class RoomSummary {\n    public constructor(\n        public readonly roomId: string,\n        info?: IInfo,\n    ) {}\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;;AAaA;AACA;AACA;;AA8BA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMA,WAAW,CAAC;EACdC,WAAWA,CACEC,MAAc,EAC9BC,IAAY,EACd;IAAA,KAFkBD,MAAc,GAAdA,MAAc;EAE/B;AACP","ignoreList":[]}

package/lib/models/search-result.js

@@ -1,23 +1,23 @@
-/*
-Copyright 2015 - 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.
+/*
+Copyright 2015 - 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 { EventContext } from "./event-context.js";
 export class SearchResult {
-  /**
-   * Create a SearchResponse from the response to /search
+  /**
+   * Create a SearchResponse from the response to /search
    */
 
   static fromJson(jsonObj, eventMapper) {
@@ -37,12 +37,12 @@ export class SearchResult {
     return new SearchResult(jsonObj.rank, context);
   }
 
-  /**
-   * Construct a new SearchResult
-   *
-   * @param rank -   where this SearchResult ranks in the results
-   * @param context -  the matching event and its
-   *    context
+  /**
+   * Construct a new SearchResult
+   *
+   * @param rank -   where this SearchResult ranks in the results
+   * @param context -  the matching event and its
+   *    context
    */
   constructor(rank, context) {
     this.rank = rank;

package/lib/models/search-result.js.map

@@ -1 +1 @@
-{"version":3,"file":"search-result.js","names":["EventContext","SearchResult","fromJson","jsonObj","eventMapper","jsonContext","context","eventsBefore","events_before","map","eventsAfter","events_after","result","threadRootId","ourEvent","filter","e","setPaginateToken","start","addEvents","end","rank","constructor"],"sources":["../../src/models/search-result.ts"],"sourcesContent":["/*\r\nCopyright 2015 - 2021 The Matrix.org Foundation C.I.C.\r\n\r\nLicensed under the Apache License, Version 2.0 (the \"License\");\r\nyou may not use this file except in compliance with the License.\r\nYou may obtain a copy of the License at\r\n\r\n    http://www.apache.org/licenses/LICENSE-2.0\r\n\r\nUnless required by applicable law or agreed to in writing, software\r\ndistributed under the License is distributed on an \"AS IS\" BASIS,\r\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r\nSee the License for the specific language governing permissions and\r\nlimitations under the License.\r\n*/\r\n\r\nimport { EventContext } from \"./event-context.ts\";\r\nimport { type EventMapper } from \"../event-mapper.ts\";\r\nimport { type IResultContext, type ISearchResult } from \"../@types/search.ts\";\r\n\r\nexport class SearchResult {\r\n    /**\r\n     * Create a SearchResponse from the response to /search\r\n     */\r\n\r\n    public static fromJson(jsonObj: ISearchResult, eventMapper: EventMapper): SearchResult {\r\n        const jsonContext = jsonObj.context || ({} as IResultContext);\r\n        let eventsBefore = (jsonContext.events_before || []).map(eventMapper);\r\n        let eventsAfter = (jsonContext.events_after || []).map(eventMapper);\r\n\r\n        const context = new EventContext(eventMapper(jsonObj.result));\r\n\r\n        // Filter out any contextual events which do not correspond to the same timeline (thread or room)\r\n        const threadRootId = context.ourEvent.threadRootId;\r\n        eventsBefore = eventsBefore.filter((e) => e.threadRootId === threadRootId);\r\n        eventsAfter = eventsAfter.filter((e) => e.threadRootId === threadRootId);\r\n\r\n        context.setPaginateToken(jsonContext.start, true);\r\n        context.addEvents(eventsBefore, true);\r\n        context.addEvents(eventsAfter, false);\r\n        context.setPaginateToken(jsonContext.end, false);\r\n\r\n        return new SearchResult(jsonObj.rank, context);\r\n    }\r\n\r\n    /**\r\n     * Construct a new SearchResult\r\n     *\r\n     * @param rank -   where this SearchResult ranks in the results\r\n     * @param context -  the matching event and its\r\n     *    context\r\n     */\r\n    public constructor(\r\n        public readonly rank: number,\r\n        public readonly context: EventContext,\r\n    ) {}\r\n}\r\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,YAAY,QAAQ,oBAAoB;AAIjD,OAAO,MAAMC,YAAY,CAAC;EACtB;AACJ;AACA;;EAEI,OAAcC,QAAQA,CAACC,OAAsB,EAAEC,WAAwB,EAAgB;IACnF,IAAMC,WAAW,GAAGF,OAAO,CAACG,OAAO,IAAK,CAAC,CAAoB;IAC7D,IAAIC,YAAY,GAAG,CAACF,WAAW,CAACG,aAAa,IAAI,EAAE,EAAEC,GAAG,CAACL,WAAW,CAAC;IACrE,IAAIM,WAAW,GAAG,CAACL,WAAW,CAACM,YAAY,IAAI,EAAE,EAAEF,GAAG,CAACL,WAAW,CAAC;IAEnE,IAAME,OAAO,GAAG,IAAIN,YAAY,CAACI,WAAW,CAACD,OAAO,CAACS,MAAM,CAAC,CAAC;;IAE7D;IACA,IAAMC,YAAY,GAAGP,OAAO,CAACQ,QAAQ,CAACD,YAAY;IAClDN,YAAY,GAAGA,YAAY,CAACQ,MAAM,CAAEC,CAAC,IAAKA,CAAC,CAACH,YAAY,KAAKA,YAAY,CAAC;IAC1EH,WAAW,GAAGA,WAAW,CAACK,MAAM,CAAEC,CAAC,IAAKA,CAAC,CAACH,YAAY,KAAKA,YAAY,CAAC;IAExEP,OAAO,CAACW,gBAAgB,CAACZ,WAAW,CAACa,KAAK,EAAE,IAAI,CAAC;IACjDZ,OAAO,CAACa,SAAS,CAACZ,YAAY,EAAE,IAAI,CAAC;IACrCD,OAAO,CAACa,SAAS,CAACT,WAAW,EAAE,KAAK,CAAC;IACrCJ,OAAO,CAACW,gBAAgB,CAACZ,WAAW,CAACe,GAAG,EAAE,KAAK,CAAC;IAEhD,OAAO,IAAInB,YAAY,CAACE,OAAO,CAACkB,IAAI,EAAEf,OAAO,CAAC;EAClD;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;EACWgB,WAAWA,CACED,IAAY,EACZf,OAAqB,EACvC;IAAA,KAFkBe,IAAY,GAAZA,IAAY;IAAA,KACZf,OAAqB,GAArBA,OAAqB;EACtC;AACP","ignoreList":[]}
+{"version":3,"file":"search-result.js","names":["EventContext","SearchResult","fromJson","jsonObj","eventMapper","jsonContext","context","eventsBefore","events_before","map","eventsAfter","events_after","result","threadRootId","ourEvent","filter","e","setPaginateToken","start","addEvents","end","rank","constructor"],"sources":["../../src/models/search-result.ts"],"sourcesContent":["/*\nCopyright 2015 - 2021 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 { EventContext } from \"./event-context.ts\";\nimport { type EventMapper } from \"../event-mapper.ts\";\nimport { type IResultContext, type ISearchResult } from \"../@types/search.ts\";\n\nexport class SearchResult {\n    /**\n     * Create a SearchResponse from the response to /search\n     */\n\n    public static fromJson(jsonObj: ISearchResult, eventMapper: EventMapper): SearchResult {\n        const jsonContext = jsonObj.context || ({} as IResultContext);\n        let eventsBefore = (jsonContext.events_before || []).map(eventMapper);\n        let eventsAfter = (jsonContext.events_after || []).map(eventMapper);\n\n        const context = new EventContext(eventMapper(jsonObj.result));\n\n        // Filter out any contextual events which do not correspond to the same timeline (thread or room)\n        const threadRootId = context.ourEvent.threadRootId;\n        eventsBefore = eventsBefore.filter((e) => e.threadRootId === threadRootId);\n        eventsAfter = eventsAfter.filter((e) => e.threadRootId === threadRootId);\n\n        context.setPaginateToken(jsonContext.start, true);\n        context.addEvents(eventsBefore, true);\n        context.addEvents(eventsAfter, false);\n        context.setPaginateToken(jsonContext.end, false);\n\n        return new SearchResult(jsonObj.rank, context);\n    }\n\n    /**\n     * Construct a new SearchResult\n     *\n     * @param rank -   where this SearchResult ranks in the results\n     * @param context -  the matching event and its\n     *    context\n     */\n    public constructor(\n        public readonly rank: number,\n        public readonly context: EventContext,\n    ) {}\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,YAAY,QAAQ,oBAAoB;AAIjD,OAAO,MAAMC,YAAY,CAAC;EACtB;AACJ;AACA;;EAEI,OAAcC,QAAQA,CAACC,OAAsB,EAAEC,WAAwB,EAAgB;IACnF,IAAMC,WAAW,GAAGF,OAAO,CAACG,OAAO,IAAK,CAAC,CAAoB;IAC7D,IAAIC,YAAY,GAAG,CAACF,WAAW,CAACG,aAAa,IAAI,EAAE,EAAEC,GAAG,CAACL,WAAW,CAAC;IACrE,IAAIM,WAAW,GAAG,CAACL,WAAW,CAACM,YAAY,IAAI,EAAE,EAAEF,GAAG,CAACL,WAAW,CAAC;IAEnE,IAAME,OAAO,GAAG,IAAIN,YAAY,CAACI,WAAW,CAACD,OAAO,CAACS,MAAM,CAAC,CAAC;;IAE7D;IACA,IAAMC,YAAY,GAAGP,OAAO,CAACQ,QAAQ,CAACD,YAAY;IAClDN,YAAY,GAAGA,YAAY,CAACQ,MAAM,CAAEC,CAAC,IAAKA,CAAC,CAACH,YAAY,KAAKA,YAAY,CAAC;IAC1EH,WAAW,GAAGA,WAAW,CAACK,MAAM,CAAEC,CAAC,IAAKA,CAAC,CAACH,YAAY,KAAKA,YAAY,CAAC;IAExEP,OAAO,CAACW,gBAAgB,CAACZ,WAAW,CAACa,KAAK,EAAE,IAAI,CAAC;IACjDZ,OAAO,CAACa,SAAS,CAACZ,YAAY,EAAE,IAAI,CAAC;IACrCD,OAAO,CAACa,SAAS,CAACT,WAAW,EAAE,KAAK,CAAC;IACrCJ,OAAO,CAACW,gBAAgB,CAACZ,WAAW,CAACe,GAAG,EAAE,KAAK,CAAC;IAEhD,OAAO,IAAInB,YAAY,CAACE,OAAO,CAACkB,IAAI,EAAEf,OAAO,CAAC;EAClD;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;EACWgB,WAAWA,CACED,IAAY,EACZf,OAAqB,EACvC;IAAA,KAFkBe,IAAY,GAAZA,IAAY;IAAA,KACZf,OAAqB,GAArBA,OAAqB;EACtC;AACP","ignoreList":[]}

package/lib/models/typed-event-emitter.js

@@ -1,18 +1,18 @@
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
-/*
-Copyright 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.
+/*
+Copyright 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.
 */
 
 // eslint-disable-next-line no-restricted-imports
@@ -28,44 +28,44 @@ export var EventEmitterEvents = /*#__PURE__*/function (EventEmitterEvents) {
 
 /** Base class for types mapping from event name to the type of listeners to that event */
 
-/**
- * The expected type of a listener function for a particular event.
- *
- * Type parameters:
- *   * `E` - List of all events emitted by the `TypedEventEmitter`. Normally an enum type.
- *   * `A` - A type providing mappings from event names to listener types.
- *   * `T` - The name of the actual event that this listener is for. Normally one of the types in `E` or
- *           {@link EventEmitterEvents}.
+/**
+ * The expected type of a listener function for a particular event.
+ *
+ * Type parameters:
+ *   * `E` - List of all events emitted by the `TypedEventEmitter`. Normally an enum type.
+ *   * `A` - A type providing mappings from event names to listener types.
+ *   * `T` - The name of the actual event that this listener is for. Normally one of the types in `E` or
+ *           {@link EventEmitterEvents}.
  */
 
-/**
- * Typed Event Emitter class which can act as a Base Model for all our model
- * and communication events.
- * This makes it much easier for us to distinguish between events, as we now need
- * to properly type this, so that our events are not stringly-based and prone
- * to silly typos.
- *
- * Type parameters:
- *  * `Events` - List of all events emitted by this `TypedEventEmitter`. Normally an enum type.
- *  * `Arguments` - A {@link ListenerMap} type providing mappings from event names to listener types.
- *  * `SuperclassArguments` - TODO: not really sure. Alternative listener mappings, I think? But only honoured for `.emit`?
+/**
+ * Typed Event Emitter class which can act as a Base Model for all our model
+ * and communication events.
+ * This makes it much easier for us to distinguish between events, as we now need
+ * to properly type this, so that our events are not stringly-based and prone
+ * to silly typos.
+ *
+ * Type parameters:
+ *  * `Events` - List of all events emitted by this `TypedEventEmitter`. Normally an enum type.
+ *  * `Arguments` - A {@link ListenerMap} type providing mappings from event names to listener types.
+ *  * `SuperclassArguments` - TODO: not really sure. Alternative listener mappings, I think? But only honoured for `.emit`?
  */
 export class TypedEventEmitter extends EventEmitter {
-  /**
-   * Alias for {@link on}.
+  /**
+   * Alias for {@link on}.
    */
   addListener(event, listener) {
     return super.addListener(event, listener);
   }
 
-  /**
-   * Synchronously calls each of the listeners registered for the event named
-   * `event`, in the order they were registered, passing the supplied arguments
-   * to each.
-   *
-   * @param event - The name of the event to emit
-   * @param args - Arguments to pass to the listener
-   * @returns `true` if the event had listeners, `false` otherwise.
+  /**
+   * Synchronously calls each of the listeners registered for the event named
+   * `event`, in the order they were registered, passing the supplied arguments
+   * to each.
+   *
+   * @param event - The name of the event to emit
+   * @param args - Arguments to pass to the listener
+   * @returns `true` if the event had listeners, `false` otherwise.
    */
 
   emit(event) {
@@ -75,11 +75,11 @@ export class TypedEventEmitter extends EventEmitter {
     return super.emit(event, ...args);
   }
 
-  /**
-   * Similar to `emit` but calls all listeners within a `Promise.all` and returns the promise chain
-   * @param event - The name of the event to emit
-   * @param args - Arguments to pass to the listener
-   * @returns `true` if the event had listeners, `false` otherwise.
+  /**
+   * Similar to `emit` but calls all listeners within a `Promise.all` and returns the promise chain
+   * @param event - The name of the event to emit
+   * @param args - Arguments to pass to the listener
+   * @returns `true` if the event had listeners, `false` otherwise.
    */
 
   emitPromised(event) {
@@ -96,108 +96,108 @@ export class TypedEventEmitter extends EventEmitter {
     })();
   }
 
-  /**
-   * Returns the number of listeners listening to the event named `event`.
-   *
-   * @param event - The name of the event being listened for
+  /**
+   * Returns the number of listeners listening to the event named `event`.
+   *
+   * @param event - The name of the event being listened for
    */
   listenerCount(event) {
     return super.listenerCount(event);
   }
 
-  /**
-   * Returns a copy of the array of listeners for the event named `event`.
+  /**
+   * Returns a copy of the array of listeners for the event named `event`.
    */
   listeners(event) {
     return super.listeners(event);
   }
 
-  /**
-   * Alias for {@link removeListener}
+  /**
+   * Alias for {@link removeListener}
    */
   off(event, listener) {
     return super.off(event, listener);
   }
 
-  /**
-   * Adds the `listener` function to the end of the listeners array for the
-   * event named `event`.
-   *
-   * No checks are made to see if the `listener` has already been added. Multiple calls
-   * passing the same combination of `event` and `listener` will result in the `listener`
-   * being added, and called, multiple times.
-   *
-   * By default, event listeners are invoked in the order they are added. The
-   * {@link prependListener} method can be used as an alternative to add the
-   * event listener to the beginning of the listeners array.
-   *
-   * @param event - The name of the event.
-   * @param listener - The callback function
-   *
-   * @returns a reference to the `EventEmitter`, so that calls can be chained.
+  /**
+   * Adds the `listener` function to the end of the listeners array for the
+   * event named `event`.
+   *
+   * No checks are made to see if the `listener` has already been added. Multiple calls
+   * passing the same combination of `event` and `listener` will result in the `listener`
+   * being added, and called, multiple times.
+   *
+   * By default, event listeners are invoked in the order they are added. The
+   * {@link prependListener} method can be used as an alternative to add the
+   * event listener to the beginning of the listeners array.
+   *
+   * @param event - The name of the event.
+   * @param listener - The callback function
+   *
+   * @returns a reference to the `EventEmitter`, so that calls can be chained.
    */
   on(event, listener) {
     return super.on(event, listener);
   }
 
-  /**
-   * Adds a **one-time** `listener` function for the event named `event`. The
-   * next time `event` is triggered, this listener is removed and then invoked.
-   *
-   * Returns a reference to the `EventEmitter`, so that calls can be chained.
-   *
-   * By default, event listeners are invoked in the order they are added.
-   * The {@link prependOnceListener} method can be used as an alternative to add the
-   * event listener to the beginning of the listeners array.
-   *
-   * @param event - The name of the event.
-   * @param listener - The callback function
-   *
-   * @returns a reference to the `EventEmitter`, so that calls can be chained.
+  /**
+   * Adds a **one-time** `listener` function for the event named `event`. The
+   * next time `event` is triggered, this listener is removed and then invoked.
+   *
+   * Returns a reference to the `EventEmitter`, so that calls can be chained.
+   *
+   * By default, event listeners are invoked in the order they are added.
+   * The {@link prependOnceListener} method can be used as an alternative to add the
+   * event listener to the beginning of the listeners array.
+   *
+   * @param event - The name of the event.
+   * @param listener - The callback function
+   *
+   * @returns a reference to the `EventEmitter`, so that calls can be chained.
    */
   once(event, listener) {
     return super.once(event, listener);
   }
 
-  /**
-   * Adds the `listener` function to the _beginning_ of the listeners array for the
-   * event named `event`.
-   *
-   * No checks are made to see if the `listener` has already been added. Multiple calls
-   * passing the same combination of `event` and `listener` will result in the `listener`
-   * being added, and called, multiple times.
-   *
-   * @param event - The name of the event.
-   * @param listener - The callback function
-   *
-   * @returns a reference to the `EventEmitter`, so that calls can be chained.
+  /**
+   * Adds the `listener` function to the _beginning_ of the listeners array for the
+   * event named `event`.
+   *
+   * No checks are made to see if the `listener` has already been added. Multiple calls
+   * passing the same combination of `event` and `listener` will result in the `listener`
+   * being added, and called, multiple times.
+   *
+   * @param event - The name of the event.
+   * @param listener - The callback function
+   *
+   * @returns a reference to the `EventEmitter`, so that calls can be chained.
    */
   prependListener(event, listener) {
     return super.prependListener(event, listener);
   }
 
-  /**
-   * Adds a **one-time**`listener` function for the event named `event` to the _beginning_ of the listeners array.
-   * The next time `event` is triggered, this listener is removed, and then invoked.
-   *
-   * @param event - The name of the event.
-   * @param listener - The callback function
-   *
-   * @returns a reference to the `EventEmitter`, so that calls can be chained.
+  /**
+   * Adds a **one-time**`listener` function for the event named `event` to the _beginning_ of the listeners array.
+   * The next time `event` is triggered, this listener is removed, and then invoked.
+   *
+   * @param event - The name of the event.
+   * @param listener - The callback function
+   *
+   * @returns a reference to the `EventEmitter`, so that calls can be chained.
    */
   prependOnceListener(event, listener) {
     return super.prependOnceListener(event, listener);
   }
 
-  /**
-   * Removes all listeners, or those of the specified `event`.
-   *
-   * It is bad practice to remove listeners added elsewhere in the code,
-   * particularly when the `EventEmitter` instance was created by some other
-   * component or module (e.g. sockets or file streams).
-   *
-   * @param event - The name of the event. If undefined, all listeners everywhere are removed.
-   * @returns a reference to the `EventEmitter`, so that calls can be chained.
+  /**
+   * Removes all listeners, or those of the specified `event`.
+   *
+   * It is bad practice to remove listeners added elsewhere in the code,
+   * particularly when the `EventEmitter` instance was created by some other
+   * component or module (e.g. sockets or file streams).
+   *
+   * @param event - The name of the event. If undefined, all listeners everywhere are removed.
+   * @returns a reference to the `EventEmitter`, so that calls can be chained.
    */
   removeAllListeners(event) {
     // EventEmitter::removeAllListeners uses `arguments.length` to determine undefined case
@@ -207,18 +207,18 @@ export class TypedEventEmitter extends EventEmitter {
     return super.removeAllListeners(event);
   }
 
-  /**
-   * Removes the specified `listener` from the listener array for the event named `event`.
-   *
-   * @returns a reference to the `EventEmitter`, so that calls can be chained.
+  /**
+   * Removes the specified `listener` from the listener array for the event named `event`.
+   *
+   * @returns a reference to the `EventEmitter`, so that calls can be chained.
    */
   removeListener(event, listener) {
     return super.removeListener(event, listener);
   }
 
-  /**
-   * Returns a copy of the array of listeners for the event named `eventName`,
-   * including any wrappers (such as those created by `.once()`).
+  /**
+   * Returns a copy of the array of listeners for the event named `eventName`,
+   * including any wrappers (such as those created by `.once()`).
    */
   rawListeners(event) {
     return super.rawListeners(event);