matrix-js-sdk 41.8.0 → 41.9.0

package/lib/filter.js

@@ -1,6 +1,5 @@
+import _objectSpread from "@babel/runtime/helpers/objectSpread2";
 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 2015 - 2021 Matrix.org Foundation C.I.C.
 
@@ -20,14 +19,14 @@ limitations under the License.
 import { UNREAD_THREAD_NOTIFICATIONS } from "./@types/sync.js";
 import { FilterComponent } from "./filter-component.js";
 import { NamespacedValue } from "./NamespacedValue.js";
-var profileFieldsFilterName = new NamespacedValue("profile_fields", "org.matrix.msc4429.profile_fields");
+const profileFieldsFilterName = new NamespacedValue("profile_fields", "org.matrix.msc4429.profile_fields");
 
 /**
  */
 function setProp(obj, keyNesting, val) {
-  var nestedKeys = keyNesting.split(".");
-  var currentObj = obj;
-  for (var i = 0; i < nestedKeys.length - 1; i++) {
+  const nestedKeys = keyNesting.split(".");
+  let currentObj = obj;
+  for (let i = 0; i < nestedKeys.length - 1; i++) {
     if (!currentObj[nestedKeys[i]]) {
       currentObj[nestedKeys[i]] = {};
     }
@@ -49,7 +48,7 @@ export class Filter {
    * Create a filter from existing data.
    */
   static fromJson(userId, filterId, jsonObj) {
-    var filter = new Filter(userId, filterId);
+    const filter = new Filter(userId, filterId);
     filter.setDefinition(jsonObj);
     return filter;
   }
@@ -59,11 +58,11 @@ export class Filter {
    * @param filterId - The filter ID if known.
    */
   constructor(userId, filterId) {
-    this.userId = userId;
-    this.filterId = filterId;
     _defineProperty(this, "definition", {});
     _defineProperty(this, "roomFilter", void 0);
     _defineProperty(this, "roomTimelineFilter", void 0);
+    this.userId = userId;
+    this.filterId = filterId;
   }
 
   /**
@@ -122,10 +121,10 @@ export class Filter {
     //   "event_fields": ["type", "content", "sender"]
     // }
 
-    var roomFilterJson = definition.room;
+    const roomFilterJson = definition.room;
 
     // consider the top level rooms/not_rooms filter
-    var roomFilterFields = {};
+    const roomFilterFields = {};
     if (roomFilterJson) {
       if (roomFilterJson.rooms) {
         roomFilterFields.rooms = roomFilterJson.rooms;
@@ -135,7 +134,7 @@ export class Filter {
       }
     }
     this.roomFilter = new FilterComponent(roomFilterFields, this.userId);
-    this.roomTimelineFilter = new FilterComponent((roomFilterJson === null || roomFilterJson === void 0 ? void 0 : roomFilterJson.timeline) || {}, this.userId);
+    this.roomTimelineFilter = new FilterComponent(roomFilterJson?.timeline || {}, this.userId);
 
     // don't bother porting this from synapse yet:
     // this._room_state_filter =
@@ -186,10 +185,9 @@ export class Filter {
    * Enable threads unread notification
    */
   setUnreadThreadNotifications(enabled) {
-    var _this$definition, _this$definition2;
     this.definition = _objectSpread(_objectSpread({}, this.definition), {}, {
-      room: _objectSpread(_objectSpread({}, (_this$definition = this.definition) === null || _this$definition === void 0 ? void 0 : _this$definition.room), {}, {
-        timeline: _objectSpread(_objectSpread({}, (_this$definition2 = this.definition) === null || _this$definition2 === void 0 || (_this$definition2 = _this$definition2.room) === null || _this$definition2 === void 0 ? void 0 : _this$definition2.timeline), {}, {
+      room: _objectSpread(_objectSpread({}, this.definition?.room), {}, {
+        timeline: _objectSpread(_objectSpread({}, this.definition?.room?.timeline), {}, {
           [UNREAD_THREAD_NOTIFICATIONS.name]: enabled
         })
       })
@@ -215,8 +213,7 @@ export class Filter {
    * @experimental
    */
   setUnstableMSC4429SyncUserProfiles(ids, stable) {
-    var _profileFieldsFilterN;
-    var field = stable ? profileFieldsFilterName.name : (_profileFieldsFilterN = profileFieldsFilterName.unstable) !== null && _profileFieldsFilterN !== void 0 ? _profileFieldsFilterN : profileFieldsFilterName.name;
+    const field = stable ? profileFieldsFilterName.name : profileFieldsFilterName.unstable ?? profileFieldsFilterName.name;
     this.definition[field] = {
       ids
     };

package/lib/filter.js.map

@@ -1 +1 @@
-{"version":3,"file":"filter.js","names":["UNREAD_THREAD_NOTIFICATIONS","FilterComponent","NamespacedValue","profileFieldsFilterName","setProp","obj","keyNesting","val","nestedKeys","split","currentObj","i","length","Filter","fromJson","userId","filterId","jsonObj","filter","setDefinition","constructor","_defineProperty","getFilterId","getDefinition","definition","roomFilterJson","room","roomFilterFields","rooms","not_rooms","roomFilter","roomTimelineFilter","timeline","getRoomTimelineFilterComponent","filterRoomTimeline","events","setTimelineLimit","limit","setUnreadThreadNotifications","enabled","_this$definition","_this$definition2","_objectSpread","name","setLazyLoadMembers","setIncludeLeaveRooms","includeLeave","setUnstableMSC4429SyncUserProfiles","ids","stable","_profileFieldsFilterN","field","unstable","lazy_load_members"],"sources":["../src/filter.ts"],"sourcesContent":["/*\nCopyright 2015 - 2021 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 EventType, type RelationType } from \"./@types/event.ts\";\nimport { UNREAD_THREAD_NOTIFICATIONS } from \"./@types/sync.ts\";\nimport { FilterComponent, type IFilterComponent } from \"./filter-component.ts\";\nimport { type MatrixEvent } from \"./models/event.ts\";\nimport { NamespacedValue } from \"./NamespacedValue.ts\";\n\nconst profileFieldsFilterName = new NamespacedValue(\"profile_fields\", \"org.matrix.msc4429.profile_fields\");\n\n/**\n */\nfunction setProp(obj: Record<string, any>, keyNesting: string, val: any): void {\n    const nestedKeys = keyNesting.split(\".\") as [keyof typeof obj];\n    let currentObj = obj;\n    for (let i = 0; i < nestedKeys.length - 1; i++) {\n        if (!currentObj[nestedKeys[i]]) {\n            currentObj[nestedKeys[i]] = {};\n        }\n        currentObj = currentObj[nestedKeys[i]];\n    }\n    currentObj[nestedKeys[nestedKeys.length - 1]] = val;\n}\n\n/* eslint-disable camelcase */\nexport interface IFilterDefinition {\n    \"event_fields\"?: string[];\n    \"event_format\"?: \"client\" | \"federation\";\n    \"presence\"?: IFilterComponent;\n    \"account_data\"?: IFilterComponent;\n    \"room\"?: IRoomFilter;\n    \"profile_fields\"?: ProfileFieldsFilter;\n    \"org.matrix.msc4429.profile_fields\"?: ProfileFieldsFilter;\n}\n\nexport interface IRoomEventFilter extends IFilterComponent {\n    \"lazy_load_members\"?: boolean;\n    \"include_redundant_members\"?: boolean;\n    \"types\"?: Array<EventType | string>;\n    \"related_by_senders\"?: Array<RelationType | string>;\n    \"related_by_rel_types\"?: string[];\n    \"unread_thread_notifications\"?: boolean;\n    \"org.matrix.msc3773.unread_thread_notifications\"?: boolean;\n\n    // Unstable values\n    \"io.element.relation_senders\"?: Array<RelationType | string>;\n    \"io.element.relation_types\"?: string[];\n}\n\ninterface IStateFilter extends IRoomEventFilter {}\n\ninterface IRoomFilter {\n    not_rooms?: string[];\n    rooms?: string[];\n    ephemeral?: IRoomEventFilter;\n    include_leave?: boolean;\n    state?: IStateFilter;\n    timeline?: IRoomEventFilter;\n    account_data?: IRoomEventFilter;\n}\n\n/**\n * Filter section used for requesting a set of extended profile fields that will be sent down the sync stream.\n */\ninterface ProfileFieldsFilter {\n    ids: string[];\n}\n\n/* eslint-enable camelcase */\n\nexport class Filter {\n    public static LAZY_LOADING_MESSAGES_FILTER = {\n        lazy_load_members: true,\n    };\n\n    /**\n     * Create a filter from existing data.\n     */\n    public static fromJson(userId: string | undefined | null, filterId: string, jsonObj: IFilterDefinition): Filter {\n        const filter = new Filter(userId, filterId);\n        filter.setDefinition(jsonObj);\n        return filter;\n    }\n\n    private definition: IFilterDefinition = {};\n    private roomFilter?: FilterComponent;\n    private roomTimelineFilter?: FilterComponent;\n\n    /**\n     * Construct a new Filter.\n     * @param userId - The user ID for this filter.\n     * @param filterId - The filter ID if known.\n     */\n    public constructor(\n        public readonly userId: string | undefined | null,\n        public filterId?: string,\n    ) {}\n\n    /**\n     * Get the ID of this filter on your homeserver (if known)\n     * @returns The filter ID\n     */\n    public getFilterId(): string | undefined {\n        return this.filterId;\n    }\n\n    /**\n     * Get the JSON body of the filter.\n     * @returns The filter definition\n     */\n    public getDefinition(): IFilterDefinition {\n        return this.definition;\n    }\n\n    /**\n     * Set the JSON body of the filter\n     * @param definition - The filter definition\n     */\n    public setDefinition(definition: IFilterDefinition): void {\n        this.definition = definition;\n\n        // This is all ported from synapse's FilterCollection()\n\n        // definitions look something like:\n        // {\n        //   \"room\": {\n        //     \"rooms\": [\"!abcde:example.com\"],\n        //     \"not_rooms\": [\"!123456:example.com\"],\n        //     \"state\": {\n        //       \"types\": [\"m.room.*\"],\n        //       \"not_rooms\": [\"!726s6s6q:example.com\"],\n        //       \"lazy_load_members\": true,\n        //     },\n        //     \"timeline\": {\n        //       \"limit\": 10,\n        //       \"types\": [\"m.room.message\"],\n        //       \"not_rooms\": [\"!726s6s6q:example.com\"],\n        //       \"not_senders\": [\"@spam:example.com\"]\n        //       \"contains_url\": true\n        //     },\n        //     \"ephemeral\": {\n        //       \"types\": [\"m.receipt\", \"m.typing\"],\n        //       \"not_rooms\": [\"!726s6s6q:example.com\"],\n        //       \"not_senders\": [\"@spam:example.com\"]\n        //     }\n        //   },\n        //   \"presence\": {\n        //     \"types\": [\"m.presence\"],\n        //     \"not_senders\": [\"@alice:example.com\"]\n        //   },\n        //   \"event_format\": \"client\",\n        //   \"event_fields\": [\"type\", \"content\", \"sender\"]\n        // }\n\n        const roomFilterJson = definition.room;\n\n        // consider the top level rooms/not_rooms filter\n        const roomFilterFields: IRoomFilter = {};\n        if (roomFilterJson) {\n            if (roomFilterJson.rooms) {\n                roomFilterFields.rooms = roomFilterJson.rooms;\n            }\n            if (roomFilterJson.rooms) {\n                roomFilterFields.not_rooms = roomFilterJson.not_rooms;\n            }\n        }\n\n        this.roomFilter = new FilterComponent(roomFilterFields, this.userId);\n        this.roomTimelineFilter = new FilterComponent(roomFilterJson?.timeline || {}, this.userId);\n\n        // don't bother porting this from synapse yet:\n        // this._room_state_filter =\n        //     new FilterComponent(roomFilterJson.state || {});\n        // this._room_ephemeral_filter =\n        //     new FilterComponent(roomFilterJson.ephemeral || {});\n        // this._room_account_data_filter =\n        //     new FilterComponent(roomFilterJson.account_data || {});\n        // this._presence_filter =\n        //     new FilterComponent(definition.presence || {});\n        // this._account_data_filter =\n        //     new FilterComponent(definition.account_data || {});\n    }\n\n    /**\n     * Get the room.timeline filter component of the filter\n     * @returns room timeline filter component\n     */\n    public getRoomTimelineFilterComponent(): FilterComponent | undefined {\n        return this.roomTimelineFilter;\n    }\n\n    /**\n     * Filter the list of events based on whether they are allowed in a timeline\n     * based on this filter\n     * @param events -  the list of events being filtered\n     * @returns the list of events which match the filter\n     */\n    public filterRoomTimeline(events: MatrixEvent[]): MatrixEvent[] {\n        if (this.roomFilter) {\n            events = this.roomFilter.filter(events);\n        }\n        if (this.roomTimelineFilter) {\n            events = this.roomTimelineFilter.filter(events);\n        }\n        return events;\n    }\n\n    /**\n     * Set the max number of events to return for each room's timeline.\n     * @param limit - The max number of events to return for each room.\n     */\n    public setTimelineLimit(limit: number): void {\n        setProp(this.definition, \"room.timeline.limit\", limit);\n    }\n\n    /**\n     * Enable threads unread notification\n     */\n    public setUnreadThreadNotifications(enabled: boolean): void {\n        this.definition = {\n            ...this.definition,\n            room: {\n                ...this.definition?.room,\n                timeline: {\n                    ...this.definition?.room?.timeline,\n                    [UNREAD_THREAD_NOTIFICATIONS.name]: enabled,\n                },\n            },\n        };\n    }\n\n    public setLazyLoadMembers(enabled: boolean): void {\n        setProp(this.definition, \"room.state.lazy_load_members\", enabled);\n    }\n\n    /**\n     * Control whether left rooms should be included in responses.\n     * @param includeLeave - True to make rooms the user has left appear\n     * in responses.\n     */\n    public setIncludeLeaveRooms(includeLeave: boolean): void {\n        setProp(this.definition, \"room.include_leave\", includeLeave);\n    }\n\n    /**\n     * Set the list of fields to be included in the profile information sent down the sync stream.\n     * @param ids The field IDs to sync.\n     * @param stable Whether to use the stable or unstable versions of this filter.\n     * @experimental\n     */\n    public setUnstableMSC4429SyncUserProfiles(ids: string[], stable: boolean): void {\n        const field = stable\n            ? profileFieldsFilterName.name\n            : (profileFieldsFilterName.unstable ?? profileFieldsFilterName.name);\n        this.definition[field] = { ids };\n    }\n}\n"],"mappings":";;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA,SAASA,2BAA2B,QAAQ,kBAAkB;AAC9D,SAASC,eAAe,QAA+B,uBAAuB;AAE9E,SAASC,eAAe,QAAQ,sBAAsB;AAEtD,IAAMC,uBAAuB,GAAG,IAAID,eAAe,CAAC,gBAAgB,EAAE,mCAAmC,CAAC;;AAE1G;AACA;AACA,SAASE,OAAOA,CAACC,GAAwB,EAAEC,UAAkB,EAAEC,GAAQ,EAAQ;EAC3E,IAAMC,UAAU,GAAGF,UAAU,CAACG,KAAK,CAAC,GAAG,CAAuB;EAC9D,IAAIC,UAAU,GAAGL,GAAG;EACpB,KAAK,IAAIM,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGH,UAAU,CAACI,MAAM,GAAG,CAAC,EAAED,CAAC,EAAE,EAAE;IAC5C,IAAI,CAACD,UAAU,CAACF,UAAU,CAACG,CAAC,CAAC,CAAC,EAAE;MAC5BD,UAAU,CAACF,UAAU,CAACG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IAClC;IACAD,UAAU,GAAGA,UAAU,CAACF,UAAU,CAACG,CAAC,CAAC,CAAC;EAC1C;EACAD,UAAU,CAACF,UAAU,CAACA,UAAU,CAACI,MAAM,GAAG,CAAC,CAAC,CAAC,GAAGL,GAAG;AACvD;;AAEA;;AAqCA;AACA;AACA;;AAKA;;AAEA,OAAO,MAAMM,MAAM,CAAC;EAKhB;AACJ;AACA;EACI,OAAcC,QAAQA,CAACC,MAAiC,EAAEC,QAAgB,EAAEC,OAA0B,EAAU;IAC5G,IAAMC,MAAM,GAAG,IAAIL,MAAM,CAACE,MAAM,EAAEC,QAAQ,CAAC;IAC3CE,MAAM,CAACC,aAAa,CAACF,OAAO,CAAC;IAC7B,OAAOC,MAAM;EACjB;EAMA;AACJ;AACA;AACA;AACA;EACWE,WAAWA,CACEL,MAAiC,EAC1CC,QAAiB,EAC1B;IAAA,KAFkBD,MAAiC,GAAjCA,MAAiC;IAAA,KAC1CC,QAAiB,GAAjBA,QAAiB;IAAAK,eAAA,qBAXY,CAAC,CAAC;IAAAA,eAAA;IAAAA,eAAA;EAYvC;;EAEH;AACJ;AACA;AACA;EACWC,WAAWA,CAAA,EAAuB;IACrC,OAAO,IAAI,CAACN,QAAQ;EACxB;;EAEA;AACJ;AACA;AACA;EACWO,aAAaA,CAAA,EAAsB;IACtC,OAAO,IAAI,CAACC,UAAU;EAC1B;;EAEA;AACJ;AACA;AACA;EACWL,aAAaA,CAACK,UAA6B,EAAQ;IACtD,IAAI,CAACA,UAAU,GAAGA,UAAU;;IAE5B;;IAEA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;;IAEA,IAAMC,cAAc,GAAGD,UAAU,CAACE,IAAI;;IAEtC;IACA,IAAMC,gBAA6B,GAAG,CAAC,CAAC;IACxC,IAAIF,cAAc,EAAE;MAChB,IAAIA,cAAc,CAACG,KAAK,EAAE;QACtBD,gBAAgB,CAACC,KAAK,GAAGH,cAAc,CAACG,KAAK;MACjD;MACA,IAAIH,cAAc,CAACG,KAAK,EAAE;QACtBD,gBAAgB,CAACE,SAAS,GAAGJ,cAAc,CAACI,SAAS;MACzD;IACJ;IAEA,IAAI,CAACC,UAAU,GAAG,IAAI7B,eAAe,CAAC0B,gBAAgB,EAAE,IAAI,CAACZ,MAAM,CAAC;IACpE,IAAI,CAACgB,kBAAkB,GAAG,IAAI9B,eAAe,CAAC,CAAAwB,cAAc,aAAdA,cAAc,uBAAdA,cAAc,CAAEO,QAAQ,KAAI,CAAC,CAAC,EAAE,IAAI,CAACjB,MAAM,CAAC;;IAE1F;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;EACJ;;EAEA;AACJ;AACA;AACA;EACWkB,8BAA8BA,CAAA,EAAgC;IACjE,OAAO,IAAI,CAACF,kBAAkB;EAClC;;EAEA;AACJ;AACA;AACA;AACA;AACA;EACWG,kBAAkBA,CAACC,MAAqB,EAAiB;IAC5D,IAAI,IAAI,CAACL,UAAU,EAAE;MACjBK,MAAM,GAAG,IAAI,CAACL,UAAU,CAACZ,MAAM,CAACiB,MAAM,CAAC;IAC3C;IACA,IAAI,IAAI,CAACJ,kBAAkB,EAAE;MACzBI,MAAM,GAAG,IAAI,CAACJ,kBAAkB,CAACb,MAAM,CAACiB,MAAM,CAAC;IACnD;IACA,OAAOA,MAAM;EACjB;;EAEA;AACJ;AACA;AACA;EACWC,gBAAgBA,CAACC,KAAa,EAAQ;IACzCjC,OAAO,CAAC,IAAI,CAACoB,UAAU,EAAE,qBAAqB,EAAEa,KAAK,CAAC;EAC1D;;EAEA;AACJ;AACA;EACWC,4BAA4BA,CAACC,OAAgB,EAAQ;IAAA,IAAAC,gBAAA,EAAAC,iBAAA;IACxD,IAAI,CAACjB,UAAU,GAAAkB,aAAA,CAAAA,aAAA,KACR,IAAI,CAAClB,UAAU;MAClBE,IAAI,EAAAgB,aAAA,CAAAA,aAAA,MAAAF,gBAAA,GACG,IAAI,CAAChB,UAAU,cAAAgB,gBAAA,uBAAfA,gBAAA,CAAiBd,IAAI;QACxBM,QAAQ,EAAAU,aAAA,CAAAA,aAAA,MAAAD,iBAAA,GACD,IAAI,CAACjB,UAAU,cAAAiB,iBAAA,gBAAAA,iBAAA,GAAfA,iBAAA,CAAiBf,IAAI,cAAAe,iBAAA,uBAArBA,iBAAA,CAAuBT,QAAQ;UAClC,CAAChC,2BAA2B,CAAC2C,IAAI,GAAGJ;QAAO;MAC9C;IACJ,EACJ;EACL;EAEOK,kBAAkBA,CAACL,OAAgB,EAAQ;IAC9CnC,OAAO,CAAC,IAAI,CAACoB,UAAU,EAAE,8BAA8B,EAAEe,OAAO,CAAC;EACrE;;EAEA;AACJ;AACA;AACA;AACA;EACWM,oBAAoBA,CAACC,YAAqB,EAAQ;IACrD1C,OAAO,CAAC,IAAI,CAACoB,UAAU,EAAE,oBAAoB,EAAEsB,YAAY,CAAC;EAChE;;EAEA;AACJ;AACA;AACA;AACA;AACA;EACWC,kCAAkCA,CAACC,GAAa,EAAEC,MAAe,EAAQ;IAAA,IAAAC,qBAAA;IAC5E,IAAMC,KAAK,GAAGF,MAAM,GACd9C,uBAAuB,CAACwC,IAAI,IAAAO,qBAAA,GAC3B/C,uBAAuB,CAACiD,QAAQ,cAAAF,qBAAA,cAAAA,qBAAA,GAAI/C,uBAAuB,CAACwC,IAAK;IACxE,IAAI,CAACnB,UAAU,CAAC2B,KAAK,CAAC,GAAG;MAAEH;IAAI,CAAC;EACpC;AACJ;AAAC3B,eAAA,CA1LYR,MAAM,kCAC8B;EACzCwC,iBAAiB,EAAE;AACvB,CAAC","ignoreList":[]}
+{"version":3,"file":"filter.js","names":[],"sources":["../src/filter.ts"],"sourcesContent":["/*\nCopyright 2015 - 2021 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 EventType, type RelationType } from \"./@types/event.ts\";\nimport { UNREAD_THREAD_NOTIFICATIONS } from \"./@types/sync.ts\";\nimport { FilterComponent, type IFilterComponent } from \"./filter-component.ts\";\nimport { type MatrixEvent } from \"./models/event.ts\";\nimport { NamespacedValue } from \"./NamespacedValue.ts\";\n\nconst profileFieldsFilterName = new NamespacedValue(\"profile_fields\", \"org.matrix.msc4429.profile_fields\");\n\n/**\n */\nfunction setProp(obj: Record<string, any>, keyNesting: string, val: any): void {\n    const nestedKeys = keyNesting.split(\".\") as [keyof typeof obj];\n    let currentObj = obj;\n    for (let i = 0; i < nestedKeys.length - 1; i++) {\n        if (!currentObj[nestedKeys[i]]) {\n            currentObj[nestedKeys[i]] = {};\n        }\n        currentObj = currentObj[nestedKeys[i]];\n    }\n    currentObj[nestedKeys[nestedKeys.length - 1]] = val;\n}\n\n/* eslint-disable camelcase */\nexport interface IFilterDefinition {\n    \"event_fields\"?: string[];\n    \"event_format\"?: \"client\" | \"federation\";\n    \"presence\"?: IFilterComponent;\n    \"account_data\"?: IFilterComponent;\n    \"room\"?: IRoomFilter;\n    \"profile_fields\"?: ProfileFieldsFilter;\n    \"org.matrix.msc4429.profile_fields\"?: ProfileFieldsFilter;\n}\n\nexport interface IRoomEventFilter extends IFilterComponent {\n    \"lazy_load_members\"?: boolean;\n    \"include_redundant_members\"?: boolean;\n    \"types\"?: Array<EventType | string>;\n    \"related_by_senders\"?: Array<RelationType | string>;\n    \"related_by_rel_types\"?: string[];\n    \"unread_thread_notifications\"?: boolean;\n    \"org.matrix.msc3773.unread_thread_notifications\"?: boolean;\n\n    // Unstable values\n    \"io.element.relation_senders\"?: Array<RelationType | string>;\n    \"io.element.relation_types\"?: string[];\n}\n\ninterface IStateFilter extends IRoomEventFilter {}\n\ninterface IRoomFilter {\n    not_rooms?: string[];\n    rooms?: string[];\n    ephemeral?: IRoomEventFilter;\n    include_leave?: boolean;\n    state?: IStateFilter;\n    timeline?: IRoomEventFilter;\n    account_data?: IRoomEventFilter;\n}\n\n/**\n * Filter section used for requesting a set of extended profile fields that will be sent down the sync stream.\n */\ninterface ProfileFieldsFilter {\n    ids: string[];\n}\n\n/* eslint-enable camelcase */\n\nexport class Filter {\n    public static LAZY_LOADING_MESSAGES_FILTER = {\n        lazy_load_members: true,\n    };\n\n    /**\n     * Create a filter from existing data.\n     */\n    public static fromJson(userId: string | undefined | null, filterId: string, jsonObj: IFilterDefinition): Filter {\n        const filter = new Filter(userId, filterId);\n        filter.setDefinition(jsonObj);\n        return filter;\n    }\n\n    private definition: IFilterDefinition = {};\n    private roomFilter?: FilterComponent;\n    private roomTimelineFilter?: FilterComponent;\n\n    /**\n     * Construct a new Filter.\n     * @param userId - The user ID for this filter.\n     * @param filterId - The filter ID if known.\n     */\n    public constructor(\n        public readonly userId: string | undefined | null,\n        public filterId?: string,\n    ) {}\n\n    /**\n     * Get the ID of this filter on your homeserver (if known)\n     * @returns The filter ID\n     */\n    public getFilterId(): string | undefined {\n        return this.filterId;\n    }\n\n    /**\n     * Get the JSON body of the filter.\n     * @returns The filter definition\n     */\n    public getDefinition(): IFilterDefinition {\n        return this.definition;\n    }\n\n    /**\n     * Set the JSON body of the filter\n     * @param definition - The filter definition\n     */\n    public setDefinition(definition: IFilterDefinition): void {\n        this.definition = definition;\n\n        // This is all ported from synapse's FilterCollection()\n\n        // definitions look something like:\n        // {\n        //   \"room\": {\n        //     \"rooms\": [\"!abcde:example.com\"],\n        //     \"not_rooms\": [\"!123456:example.com\"],\n        //     \"state\": {\n        //       \"types\": [\"m.room.*\"],\n        //       \"not_rooms\": [\"!726s6s6q:example.com\"],\n        //       \"lazy_load_members\": true,\n        //     },\n        //     \"timeline\": {\n        //       \"limit\": 10,\n        //       \"types\": [\"m.room.message\"],\n        //       \"not_rooms\": [\"!726s6s6q:example.com\"],\n        //       \"not_senders\": [\"@spam:example.com\"]\n        //       \"contains_url\": true\n        //     },\n        //     \"ephemeral\": {\n        //       \"types\": [\"m.receipt\", \"m.typing\"],\n        //       \"not_rooms\": [\"!726s6s6q:example.com\"],\n        //       \"not_senders\": [\"@spam:example.com\"]\n        //     }\n        //   },\n        //   \"presence\": {\n        //     \"types\": [\"m.presence\"],\n        //     \"not_senders\": [\"@alice:example.com\"]\n        //   },\n        //   \"event_format\": \"client\",\n        //   \"event_fields\": [\"type\", \"content\", \"sender\"]\n        // }\n\n        const roomFilterJson = definition.room;\n\n        // consider the top level rooms/not_rooms filter\n        const roomFilterFields: IRoomFilter = {};\n        if (roomFilterJson) {\n            if (roomFilterJson.rooms) {\n                roomFilterFields.rooms = roomFilterJson.rooms;\n            }\n            if (roomFilterJson.rooms) {\n                roomFilterFields.not_rooms = roomFilterJson.not_rooms;\n            }\n        }\n\n        this.roomFilter = new FilterComponent(roomFilterFields, this.userId);\n        this.roomTimelineFilter = new FilterComponent(roomFilterJson?.timeline || {}, this.userId);\n\n        // don't bother porting this from synapse yet:\n        // this._room_state_filter =\n        //     new FilterComponent(roomFilterJson.state || {});\n        // this._room_ephemeral_filter =\n        //     new FilterComponent(roomFilterJson.ephemeral || {});\n        // this._room_account_data_filter =\n        //     new FilterComponent(roomFilterJson.account_data || {});\n        // this._presence_filter =\n        //     new FilterComponent(definition.presence || {});\n        // this._account_data_filter =\n        //     new FilterComponent(definition.account_data || {});\n    }\n\n    /**\n     * Get the room.timeline filter component of the filter\n     * @returns room timeline filter component\n     */\n    public getRoomTimelineFilterComponent(): FilterComponent | undefined {\n        return this.roomTimelineFilter;\n    }\n\n    /**\n     * Filter the list of events based on whether they are allowed in a timeline\n     * based on this filter\n     * @param events -  the list of events being filtered\n     * @returns the list of events which match the filter\n     */\n    public filterRoomTimeline(events: MatrixEvent[]): MatrixEvent[] {\n        if (this.roomFilter) {\n            events = this.roomFilter.filter(events);\n        }\n        if (this.roomTimelineFilter) {\n            events = this.roomTimelineFilter.filter(events);\n        }\n        return events;\n    }\n\n    /**\n     * Set the max number of events to return for each room's timeline.\n     * @param limit - The max number of events to return for each room.\n     */\n    public setTimelineLimit(limit: number): void {\n        setProp(this.definition, \"room.timeline.limit\", limit);\n    }\n\n    /**\n     * Enable threads unread notification\n     */\n    public setUnreadThreadNotifications(enabled: boolean): void {\n        this.definition = {\n            ...this.definition,\n            room: {\n                ...this.definition?.room,\n                timeline: {\n                    ...this.definition?.room?.timeline,\n                    [UNREAD_THREAD_NOTIFICATIONS.name]: enabled,\n                },\n            },\n        };\n    }\n\n    public setLazyLoadMembers(enabled: boolean): void {\n        setProp(this.definition, \"room.state.lazy_load_members\", enabled);\n    }\n\n    /**\n     * Control whether left rooms should be included in responses.\n     * @param includeLeave - True to make rooms the user has left appear\n     * in responses.\n     */\n    public setIncludeLeaveRooms(includeLeave: boolean): void {\n        setProp(this.definition, \"room.include_leave\", includeLeave);\n    }\n\n    /**\n     * Set the list of fields to be included in the profile information sent down the sync stream.\n     * @param ids The field IDs to sync.\n     * @param stable Whether to use the stable or unstable versions of this filter.\n     * @experimental\n     */\n    public setUnstableMSC4429SyncUserProfiles(ids: string[], stable: boolean): void {\n        const field = stable\n            ? profileFieldsFilterName.name\n            : (profileFieldsFilterName.unstable ?? profileFieldsFilterName.name);\n        this.definition[field] = { ids };\n    }\n}\n"],"mappings":";;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA,SAAS,2BAA2B,QAAQ,kBAAkB;AAC9D,SAAS,eAAe,QAA+B,uBAAuB;AAE9E,SAAS,eAAe,QAAQ,sBAAsB;AAEtD,MAAM,uBAAuB,GAAG,IAAI,eAAe,CAAC,gBAAgB,EAAE,mCAAmC,CAAC;;AAE1G;AACA;AACA,SAAS,OAAO,CAAC,GAAwB,EAAE,UAAkB,EAAE,GAAQ,EAAQ;EAC3E,MAAM,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAuB;EAC9D,IAAI,UAAU,GAAG,GAAG;EACpB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;IAC5C,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE;MAC5B,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IAClC;IACA,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;EAC1C;EACA,UAAU,CAAC,UAAU,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG;AACvD;;AAEA;;AAqCA;AACA;AACA;;AAKA;;AAEA,OAAO,MAAM,MAAM,CAAC;EAKhB;AACJ;AACA;EACI,OAAc,QAAQ,CAAC,MAAiC,EAAE,QAAgB,EAAE,OAA0B,EAAU;IAC5G,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC;IAC3C,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC;IAC7B,OAAO,MAAM;EACjB;EAMA;AACJ;AACA;AACA;AACA;EACW,WAAW,CACE,MAAiC,EAC1C,QAAiB,EAC1B;IAAA,oCAZsC,CAAC,CAAC;IAAA;IAAA;IAAA,KAUtB,MAAiC,GAAjC,MAAiC;IAAA,KAC1C,QAAiB,GAAjB,QAAiB;EACzB;;EAEH;AACJ;AACA;AACA;EACW,WAAW,GAAuB;IACrC,OAAO,IAAI,CAAC,QAAQ;EACxB;;EAEA;AACJ;AACA;AACA;EACW,aAAa,GAAsB;IACtC,OAAO,IAAI,CAAC,UAAU;EAC1B;;EAEA;AACJ;AACA;AACA;EACW,aAAa,CAAC,UAA6B,EAAQ;IACtD,IAAI,CAAC,UAAU,GAAG,UAAU;;IAE5B;;IAEA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;;IAEA,MAAM,cAAc,GAAG,UAAU,CAAC,IAAI;;IAEtC;IACA,MAAM,gBAA6B,GAAG,CAAC,CAAC;IACxC,IAAI,cAAc,EAAE;MAChB,IAAI,cAAc,CAAC,KAAK,EAAE;QACtB,gBAAgB,CAAC,KAAK,GAAG,cAAc,CAAC,KAAK;MACjD;MACA,IAAI,cAAc,CAAC,KAAK,EAAE;QACtB,gBAAgB,CAAC,SAAS,GAAG,cAAc,CAAC,SAAS;MACzD;IACJ;IAEA,IAAI,CAAC,UAAU,GAAG,IAAI,eAAe,CAAC,gBAAgB,EAAE,IAAI,CAAC,MAAM,CAAC;IACpE,IAAI,CAAC,kBAAkB,GAAG,IAAI,eAAe,CAAC,cAAc,EAAE,QAAQ,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC;;IAE1F;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;EACJ;;EAEA;AACJ;AACA;AACA;EACW,8BAA8B,GAAgC;IACjE,OAAO,IAAI,CAAC,kBAAkB;EAClC;;EAEA;AACJ;AACA;AACA;AACA;AACA;EACW,kBAAkB,CAAC,MAAqB,EAAiB;IAC5D,IAAI,IAAI,CAAC,UAAU,EAAE;MACjB,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC;IAC3C;IACA,IAAI,IAAI,CAAC,kBAAkB,EAAE;MACzB,MAAM,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,MAAM,CAAC;IACnD;IACA,OAAO,MAAM;EACjB;;EAEA;AACJ;AACA;AACA;EACW,gBAAgB,CAAC,KAAa,EAAQ;IACzC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,qBAAqB,EAAE,KAAK,CAAC;EAC1D;;EAEA;AACJ;AACA;EACW,4BAA4B,CAAC,OAAgB,EAAQ;IACxD,IAAI,CAAC,UAAU,mCACR,IAAI,CAAC,UAAU;MAClB,IAAI,kCACG,IAAI,CAAC,UAAU,EAAE,IAAI;QACxB,QAAQ,kCACD,IAAI,CAAC,UAAU,EAAE,IAAI,EAAE,QAAQ;UAClC,CAAC,2BAA2B,CAAC,IAAI,GAAG;QAAO;MAC9C;IACJ,EACJ;EACL;EAEO,kBAAkB,CAAC,OAAgB,EAAQ;IAC9C,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,8BAA8B,EAAE,OAAO,CAAC;EACrE;;EAEA;AACJ;AACA;AACA;AACA;EACW,oBAAoB,CAAC,YAAqB,EAAQ;IACrD,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,oBAAoB,EAAE,YAAY,CAAC;EAChE;;EAEA;AACJ;AACA;AACA;AACA;AACA;EACW,kCAAkC,CAAC,GAAa,EAAE,MAAe,EAAQ;IAC5E,MAAM,KAAK,GAAG,MAAM,GACd,uBAAuB,CAAC,IAAI,GAC3B,uBAAuB,CAAC,QAAQ,IAAI,uBAAuB,CAAC,IAAK;IACxE,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG;MAAE;IAAI,CAAC;EACpC;AACJ;AAAC,gBA1LY,MAAM,kCAC8B;EACzC,iBAAiB,EAAE;AACvB,CAAC","ignoreList":[]}

package/lib/http-api/errors.js

@@ -1,7 +1,5 @@
-import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import _objectSpread from "@babel/runtime/helpers/objectSpread2";
 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 - 2024 The Matrix.org Foundation C.I.C.
 
@@ -52,17 +50,16 @@ export class HTTPError extends Error {
    * @see {@link safeGetRetryAfterMs} for a version of this check that doesn't throw.
    */
   getRetryAfterMs() {
-    var _this$httpHeaders;
-    var retryAfter = (_this$httpHeaders = this.httpHeaders) === null || _this$httpHeaders === void 0 ? void 0 : _this$httpHeaders.get("Retry-After");
+    const retryAfter = this.httpHeaders?.get("Retry-After");
     if (retryAfter != null) {
       if (/^\d+$/.test(retryAfter)) {
-        var ms = Number.parseInt(retryAfter) * 1000;
+        const ms = Number.parseInt(retryAfter) * 1000;
         if (!Number.isFinite(ms)) {
           throw new Error("Retry-After header integer value is too large");
         }
         return ms;
       }
-      var date = new Date(retryAfter);
+      const date = new Date(retryAfter);
       if (date.toUTCString() !== retryAfter) {
         throw new Error("Retry-After header value is not a valid HTTP-date or non-negative decimal integer");
       }
@@ -79,28 +76,23 @@ export class MatrixError extends HTTPError {
    * @param httpStatus - The numeric HTTP status code given
    * @param httpHeaders - The HTTP response headers given
    */
-  constructor() {
-    var errorJson = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-    var httpStatus = arguments.length > 1 ? arguments[1] : undefined;
-    var url = arguments.length > 2 ? arguments[2] : undefined;
-    var event = arguments.length > 3 ? arguments[3] : undefined;
-    var httpHeaders = arguments.length > 4 ? arguments[4] : undefined;
-    var message = errorJson.error || "Unknown message";
+  constructor(errorJson = {}, httpStatus, url, event, httpHeaders) {
+    let message = errorJson.error || "Unknown message";
     if (httpStatus) {
-      message = "[".concat(httpStatus, "] ").concat(message);
+      message = `[${httpStatus}] ${message}`;
     }
     if (url) {
-      message = "".concat(message, " (").concat(url, ")");
+      message = `${message} (${url})`;
     }
-    super("MatrixError: ".concat(message), httpStatus, httpHeaders);
-    this.url = url;
-    this.event = event;
+    super(`MatrixError: ${message}`, httpStatus, httpHeaders);
     // The Matrix 'errcode' value, e.g. "M_FORBIDDEN".
     _defineProperty(this, "errcode", void 0);
     // The Matrix 'error' value.
     _defineProperty(this, "error", void 0);
     // The raw Matrix error JSON used to construct this object.
     _defineProperty(this, "data", void 0);
+    this.url = url;
+    this.event = event;
     this.errcode = errorJson.errcode;
     this.error = errorJson.error;
     this.name = errorJson.errcode || "Unknown error code";
@@ -110,7 +102,7 @@ export class MatrixError extends HTTPError {
     return this.errcode === "M_LIMIT_EXCEEDED" || (this.errcode === "M_UNKNOWN" || this.errcode === undefined) && super.isRateLimitError();
   }
   getRetryAfterMs() {
-    var headerValue = super.getRetryAfterMs();
+    const headerValue = super.getRetryAfterMs();
     if (headerValue !== null) {
       return headerValue;
     }
@@ -129,23 +121,19 @@ export class MatrixError extends HTTPError {
    * for use by Widget API error responses.
    */
   asWidgetApiErrorData() {
-    var _this$httpStatus, _this$url, _this$errcode, _this$data$error;
-    var headers = {};
+    const headers = {};
     if (this.httpHeaders) {
-      for (var _ref3 of this.httpHeaders) {
-        var _ref2 = _slicedToArray(_ref3, 2);
-        var name = _ref2[0];
-        var value = _ref2[1];
+      for (const [name, value] of this.httpHeaders) {
         headers[name] = value;
       }
     }
     return {
-      http_status: (_this$httpStatus = this.httpStatus) !== null && _this$httpStatus !== void 0 ? _this$httpStatus : 400,
+      http_status: this.httpStatus ?? 400,
       http_headers: headers,
-      url: (_this$url = this.url) !== null && _this$url !== void 0 ? _this$url : "",
+      url: this.url ?? "",
       response: _objectSpread({
-        errcode: (_this$errcode = this.errcode) !== null && _this$errcode !== void 0 ? _this$errcode : "M_UNKNOWN",
-        error: (_this$data$error = this.data.error) !== null && _this$data$error !== void 0 ? _this$data$error : "Unknown message"
+        errcode: this.errcode ?? "M_UNKNOWN",
+        error: this.data.error ?? "Unknown message"
       }, this.data)
     };
   }
@@ -169,9 +157,8 @@ export function safeGetRetryAfterMs(error, defaultMs) {
     return defaultMs;
   }
   try {
-    var _error$getRetryAfterM;
-    return (_error$getRetryAfterM = error.getRetryAfterMs()) !== null && _error$getRetryAfterM !== void 0 ? _error$getRetryAfterM : defaultMs;
-  } catch (_unused) {
+    return error.getRetryAfterMs() ?? defaultMs;
+  } catch {
     return defaultMs;
   }
 }
@@ -184,7 +171,7 @@ export function safeGetRetryAfterMs(error, defaultMs) {
  */
 export class ConnectionError extends Error {
   constructor(message, cause) {
-    super(message + (cause ? ": ".concat(cause.message) : ""));
+    super(message + (cause ? `: ${cause.message}` : ""));
   }
   get name() {
     return "ConnectionError";
@@ -198,8 +185,7 @@ export class ConnectionError extends Error {
  */
 export class TokenRefreshError extends Error {
   constructor(cause) {
-    var _cause$message;
-    super((_cause$message = cause === null || cause === void 0 ? void 0 : cause.message) !== null && _cause$message !== void 0 ? _cause$message : "");
+    super(cause?.message ?? "");
   }
   get name() {
     return "TokenRefreshError";
@@ -212,14 +198,13 @@ export class TokenRefreshError extends Error {
  */
 export class TokenRefreshLogoutError extends Error {
   constructor(cause) {
-    var _cause$message2;
-    super((_cause$message2 = cause === null || cause === void 0 ? void 0 : cause.message) !== null && _cause$message2 !== void 0 ? _cause$message2 : "");
+    super(cause?.message ?? "");
   }
   get name() {
     return "TokenRefreshLogoutError";
   }
 }
-export var MatrixSafetyErrorCode = new NamespacedValue(null, "ORG.MATRIX.MSC4387_SAFETY");
+export const MatrixSafetyErrorCode = new NamespacedValue(null, "ORG.MATRIX.MSC4387_SAFETY");
 
 /***
  * This error is thrown when the homeserver refuses to handle an action due to a
@@ -227,8 +212,8 @@ export var MatrixSafetyErrorCode = new NamespacedValue(null, "ORG.MATRIX.MSC4387
  * @see https://github.com/matrix-org/matrix-spec-proposals/pull/4387
  */
 export class MatrixSafetyError extends MatrixError {
-  constructor() {
-    super(...arguments);
+  constructor(...props) {
+    super(...props);
     /**
      * The kinds of harms detected by the server.
      * @see https://github.com/matrix-org/matrix-spec-proposals/pull/4387 for a list of spec defined harms.
@@ -238,9 +223,9 @@ export class MatrixSafetyError extends MatrixError {
      * The date at which a request can be reattempted.
      */
     _defineProperty(this, "expiry", void 0);
-    var body = arguments.length <= 0 ? undefined : arguments[0];
+    const body = props[0];
     this.harms = new Set(body && "harms" in body && Array.isArray(body.harms) ? body.harms : []);
-    this.message = "".concat(super.message, " (").concat([...this.harms].join(", "), ")");
+    this.message = `${super.message} (${[...this.harms].join(", ")})`;
     if (body && "expiry" in body && typeof body.expiry === "number") {
       this.expiry = new Date(body.expiry);
     }

package/lib/http-api/errors.js.map

@@ -1 +1 @@
-{"version":3,"file":"errors.js","names":["NamespacedValue","HTTPError","Error","constructor","msg","httpStatus","httpHeaders","isRateLimitError","getRetryAfterMs","_this$httpHeaders","retryAfter","get","test","ms","Number","parseInt","isFinite","date","Date","toUTCString","getTime","now","MatrixError","errorJson","arguments","length","undefined","url","event","message","error","concat","_defineProperty","errcode","name","data","headerValue","isInteger","retry_after_ms","asWidgetApiErrorData","_this$httpStatus","_this$url","_this$errcode","_this$data$error","headers","_ref3","_ref2","_slicedToArray","value","http_status","http_headers","response","_objectSpread","fromWidgetApiErrorData","Headers","safeGetRetryAfterMs","defaultMs","_error$getRetryAfterM","_unused","ConnectionError","cause","TokenRefreshError","_cause$message","TokenRefreshLogoutError","_cause$message2","MatrixSafetyErrorCode","MatrixSafetyError","body","harms","Set","Array","isArray","join","expiry"],"sources":["../../src/http-api/errors.ts"],"sourcesContent":["/*\nCopyright 2022 - 2024 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 IMatrixApiError as IWidgetMatrixError } from \"matrix-widget-api\";\n\nimport { type IUsageLimit } from \"../@types/partials.ts\";\nimport { type MatrixEvent } from \"../models/event.ts\";\nimport { NamespacedValue } from \"../NamespacedValue.ts\";\n\ninterface IErrorJson extends Partial<IUsageLimit> {\n    [key: string]: any; // extensible\n    errcode?: string;\n    error?: string;\n}\n\n/**\n * Construct a generic HTTP error. This is a JavaScript Error with additional information\n * specific to HTTP responses.\n * @param msg - The error message to include.\n * @param httpStatus - The HTTP response status code.\n * @param httpHeaders - The HTTP response headers.\n */\nexport class HTTPError extends Error {\n    public constructor(\n        msg: string,\n        public readonly httpStatus?: number,\n        public readonly httpHeaders?: Headers,\n    ) {\n        super(msg);\n    }\n\n    /**\n     * Check if this error was due to rate-limiting on the server side (and should therefore be retried after a delay).\n     *\n     * If this returns `true`, {@link getRetryAfterMs} can be called to retrieve the server-side\n     * recommendation for the retry period.\n     *\n     * @returns Whether this error is due to rate-limiting.\n     */\n    public isRateLimitError(): boolean {\n        return this.httpStatus === 429;\n    }\n\n    /**\n     * @returns The recommended delay in milliseconds to wait before retrying\n     * the request that triggered this error, or null if no delay is recommended.\n     * @throws Error if the recommended delay is an invalid value.\n     * @see {@link safeGetRetryAfterMs} for a version of this check that doesn't throw.\n     */\n    public getRetryAfterMs(): number | null {\n        const retryAfter = this.httpHeaders?.get(\"Retry-After\");\n        if (retryAfter != null) {\n            if (/^\\d+$/.test(retryAfter)) {\n                const ms = Number.parseInt(retryAfter) * 1000;\n                if (!Number.isFinite(ms)) {\n                    throw new Error(\"Retry-After header integer value is too large\");\n                }\n                return ms;\n            }\n            const date = new Date(retryAfter);\n            if (date.toUTCString() !== retryAfter) {\n                throw new Error(\"Retry-After header value is not a valid HTTP-date or non-negative decimal integer\");\n            }\n            return date.getTime() - Date.now();\n        }\n        return null;\n    }\n}\n\nexport class MatrixError extends HTTPError {\n    // The Matrix 'errcode' value, e.g. \"M_FORBIDDEN\".\n    public readonly errcode?: string;\n    // The Matrix 'error' value.\n    public readonly error?: string;\n    // The raw Matrix error JSON used to construct this object.\n    public data: IErrorJson;\n\n    /**\n     * Construct a Matrix error. This is a JavaScript Error with additional\n     * information specific to the standard Matrix error response.\n     * @param errorJson - The Matrix error JSON returned from the homeserver.\n     * @param httpStatus - The numeric HTTP status code given\n     * @param httpHeaders - The HTTP response headers given\n     */\n    public constructor(\n        errorJson: IErrorJson = {},\n        httpStatus?: number,\n        public url?: string,\n        public event?: MatrixEvent,\n        httpHeaders?: Headers,\n    ) {\n        let message = errorJson.error || \"Unknown message\";\n        if (httpStatus) {\n            message = `[${httpStatus}] ${message}`;\n        }\n        if (url) {\n            message = `${message} (${url})`;\n        }\n        super(`MatrixError: ${message}`, httpStatus, httpHeaders);\n        this.errcode = errorJson.errcode;\n        this.error = errorJson.error;\n        this.name = errorJson.errcode || \"Unknown error code\";\n        this.data = errorJson;\n    }\n\n    public isRateLimitError(): boolean {\n        return (\n            this.errcode === \"M_LIMIT_EXCEEDED\" ||\n            ((this.errcode === \"M_UNKNOWN\" || this.errcode === undefined) && super.isRateLimitError())\n        );\n    }\n\n    public getRetryAfterMs(): number | null {\n        const headerValue = super.getRetryAfterMs();\n        if (headerValue !== null) {\n            return headerValue;\n        }\n        // Note: retry_after_ms is deprecated as of spec version v1.10\n        if (this.errcode === \"M_LIMIT_EXCEEDED\" && \"retry_after_ms\" in this.data) {\n            if (!Number.isInteger(this.data.retry_after_ms)) {\n                throw new Error(\"retry_after_ms is not an integer\");\n            }\n            return this.data.retry_after_ms;\n        }\n        return null;\n    }\n\n    /**\n     * @returns this error expressed as a JSON payload\n     * for use by Widget API error responses.\n     */\n    public asWidgetApiErrorData(): IWidgetMatrixError {\n        const headers: Record<string, string> = {};\n        if (this.httpHeaders) {\n            for (const [name, value] of this.httpHeaders) {\n                headers[name] = value;\n            }\n        }\n        return {\n            http_status: this.httpStatus ?? 400,\n            http_headers: headers,\n            url: this.url ?? \"\",\n            response: {\n                errcode: this.errcode ?? \"M_UNKNOWN\",\n                error: this.data.error ?? \"Unknown message\",\n                ...this.data,\n            },\n        };\n    }\n\n    /**\n     * @returns a new {@link MatrixError} from a JSON payload\n     * received from Widget API error responses.\n     */\n    public static fromWidgetApiErrorData(data: IWidgetMatrixError): MatrixError {\n        return new MatrixError(data.response, data.http_status, data.url, undefined, new Headers(data.http_headers));\n    }\n}\n\n/**\n * @returns The recommended delay in milliseconds to wait before retrying the request.\n * @param error - The error to check for a retry delay.\n * @param defaultMs - The delay to use if the error was not due to rate-limiting or if no valid delay is recommended.\n */\nexport function safeGetRetryAfterMs(error: unknown, defaultMs: number): number {\n    if (!(error instanceof HTTPError) || !error.isRateLimitError()) {\n        return defaultMs;\n    }\n    try {\n        return error.getRetryAfterMs() ?? defaultMs;\n    } catch {\n        return defaultMs;\n    }\n}\n\n/**\n * Construct a ConnectionError. This is a JavaScript Error indicating\n * that a request failed because of some error with the connection, either\n * CORS was not correctly configured on the server, the server didn't response,\n * the request timed out, or the internet connection on the client side went down.\n */\nexport class ConnectionError extends Error {\n    public constructor(message: string, cause?: Error) {\n        super(message + (cause ? `: ${cause.message}` : \"\"));\n    }\n\n    public get name(): string {\n        return \"ConnectionError\";\n    }\n}\n\n/**\n * Construct a TokenRefreshError. This indicates that a request failed due to the token being expired,\n * and attempting to refresh said token also failed but in a way which was not indicative of token invalidation.\n * Assumed to be a temporary failure.\n */\nexport class TokenRefreshError extends Error {\n    public constructor(cause?: Error) {\n        super(cause?.message ?? \"\");\n    }\n\n    public get name(): string {\n        return \"TokenRefreshError\";\n    }\n}\n\n/**\n * Construct a TokenRefreshError. This indicates that a request failed due to the token being expired,\n * and attempting to refresh said token failed in a way indicative of token invalidation.\n */\nexport class TokenRefreshLogoutError extends Error {\n    public constructor(cause?: Error) {\n        super(cause?.message ?? \"\");\n    }\n\n    public get name(): string {\n        return \"TokenRefreshLogoutError\";\n    }\n}\n\nexport const MatrixSafetyErrorCode = new NamespacedValue(null, \"ORG.MATRIX.MSC4387_SAFETY\");\n\n/***\n * This error is thrown when the homeserver refuses to handle an action due to a\n * safety concern.\n * @see https://github.com/matrix-org/matrix-spec-proposals/pull/4387\n */\nexport class MatrixSafetyError extends MatrixError {\n    /**\n     * The kinds of harms detected by the server.\n     * @see https://github.com/matrix-org/matrix-spec-proposals/pull/4387 for a list of spec defined harms.\n     */\n    public readonly harms: Set<string>;\n    /**\n     * The date at which a request can be reattempted.\n     */\n    public readonly expiry?: Date;\n    public constructor(...props: ConstructorParameters<typeof MatrixError>) {\n        super(...props);\n        const body = props[0];\n\n        this.harms = new Set(body && \"harms\" in body && Array.isArray(body.harms) ? body.harms : []);\n        this.message = `${super.message} (${[...this.harms].join(\", \")})`;\n        if (body && \"expiry\" in body && typeof body.expiry === \"number\") {\n            this.expiry = new Date(body.expiry);\n        }\n    }\n}\n"],"mappings":";;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAMA,SAASA,eAAe,QAAQ,uBAAuB;AAQvD;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,SAAS,SAASC,KAAK,CAAC;EAC1BC,WAAWA,CACdC,GAAW,EACKC,UAAmB,EACnBC,WAAqB,EACvC;IACE,KAAK,CAACF,GAAG,CAAC;IAAC,KAHKC,UAAmB,GAAnBA,UAAmB;IAAA,KACnBC,WAAqB,GAArBA,WAAqB;EAGzC;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;EACWC,gBAAgBA,CAAA,EAAY;IAC/B,OAAO,IAAI,CAACF,UAAU,KAAK,GAAG;EAClC;;EAEA;AACJ;AACA;AACA;AACA;AACA;EACWG,eAAeA,CAAA,EAAkB;IAAA,IAAAC,iBAAA;IACpC,IAAMC,UAAU,IAAAD,iBAAA,GAAG,IAAI,CAACH,WAAW,cAAAG,iBAAA,uBAAhBA,iBAAA,CAAkBE,GAAG,CAAC,aAAa,CAAC;IACvD,IAAID,UAAU,IAAI,IAAI,EAAE;MACpB,IAAI,OAAO,CAACE,IAAI,CAACF,UAAU,CAAC,EAAE;QAC1B,IAAMG,EAAE,GAAGC,MAAM,CAACC,QAAQ,CAACL,UAAU,CAAC,GAAG,IAAI;QAC7C,IAAI,CAACI,MAAM,CAACE,QAAQ,CAACH,EAAE,CAAC,EAAE;UACtB,MAAM,IAAIX,KAAK,CAAC,+CAA+C,CAAC;QACpE;QACA,OAAOW,EAAE;MACb;MACA,IAAMI,IAAI,GAAG,IAAIC,IAAI,CAACR,UAAU,CAAC;MACjC,IAAIO,IAAI,CAACE,WAAW,CAAC,CAAC,KAAKT,UAAU,EAAE;QACnC,MAAM,IAAIR,KAAK,CAAC,mFAAmF,CAAC;MACxG;MACA,OAAOe,IAAI,CAACG,OAAO,CAAC,CAAC,GAAGF,IAAI,CAACG,GAAG,CAAC,CAAC;IACtC;IACA,OAAO,IAAI;EACf;AACJ;AAEA,OAAO,MAAMC,WAAW,SAASrB,SAAS,CAAC;EAQvC;AACJ;AACA;AACA;AACA;AACA;AACA;EACWE,WAAWA,CAAA,EAMhB;IAAA,IALEoB,SAAqB,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,CAAC,CAAC;IAAA,IAC1BnB,UAAmB,GAAAmB,SAAA,CAAAC,MAAA,OAAAD,SAAA,MAAAE,SAAA;IAAA,IACZC,GAAY,GAAAH,SAAA,CAAAC,MAAA,OAAAD,SAAA,MAAAE,SAAA;IAAA,IACZE,KAAmB,GAAAJ,SAAA,CAAAC,MAAA,OAAAD,SAAA,MAAAE,SAAA;IAAA,IAC1BpB,WAAqB,GAAAkB,SAAA,CAAAC,MAAA,OAAAD,SAAA,MAAAE,SAAA;IAErB,IAAIG,OAAO,GAAGN,SAAS,CAACO,KAAK,IAAI,iBAAiB;IAClD,IAAIzB,UAAU,EAAE;MACZwB,OAAO,OAAAE,MAAA,CAAO1B,UAAU,QAAA0B,MAAA,CAAKF,OAAO,CAAE;IAC1C;IACA,IAAIF,GAAG,EAAE;MACLE,OAAO,MAAAE,MAAA,CAAMF,OAAO,QAAAE,MAAA,CAAKJ,GAAG,MAAG;IACnC;IACA,KAAK,iBAAAI,MAAA,CAAiBF,OAAO,GAAIxB,UAAU,EAAEC,WAAW,CAAC;IAAC,KAXnDqB,GAAY,GAAZA,GAAY;IAAA,KACZC,KAAmB,GAAnBA,KAAmB;IAlB9B;IAAAI,eAAA;IAEA;IAAAA,eAAA;IAEA;IAAAA,eAAA;IAyBI,IAAI,CAACC,OAAO,GAAGV,SAAS,CAACU,OAAO;IAChC,IAAI,CAACH,KAAK,GAAGP,SAAS,CAACO,KAAK;IAC5B,IAAI,CAACI,IAAI,GAAGX,SAAS,CAACU,OAAO,IAAI,oBAAoB;IACrD,IAAI,CAACE,IAAI,GAAGZ,SAAS;EACzB;EAEOhB,gBAAgBA,CAAA,EAAY;IAC/B,OACI,IAAI,CAAC0B,OAAO,KAAK,kBAAkB,IAClC,CAAC,IAAI,CAACA,OAAO,KAAK,WAAW,IAAI,IAAI,CAACA,OAAO,KAAKP,SAAS,KAAK,KAAK,CAACnB,gBAAgB,CAAC,CAAE;EAElG;EAEOC,eAAeA,CAAA,EAAkB;IACpC,IAAM4B,WAAW,GAAG,KAAK,CAAC5B,eAAe,CAAC,CAAC;IAC3C,IAAI4B,WAAW,KAAK,IAAI,EAAE;MACtB,OAAOA,WAAW;IACtB;IACA;IACA,IAAI,IAAI,CAACH,OAAO,KAAK,kBAAkB,IAAI,gBAAgB,IAAI,IAAI,CAACE,IAAI,EAAE;MACtE,IAAI,CAACrB,MAAM,CAACuB,SAAS,CAAC,IAAI,CAACF,IAAI,CAACG,cAAc,CAAC,EAAE;QAC7C,MAAM,IAAIpC,KAAK,CAAC,kCAAkC,CAAC;MACvD;MACA,OAAO,IAAI,CAACiC,IAAI,CAACG,cAAc;IACnC;IACA,OAAO,IAAI;EACf;;EAEA;AACJ;AACA;AACA;EACWC,oBAAoBA,CAAA,EAAuB;IAAA,IAAAC,gBAAA,EAAAC,SAAA,EAAAC,aAAA,EAAAC,gBAAA;IAC9C,IAAMC,OAA+B,GAAG,CAAC,CAAC;IAC1C,IAAI,IAAI,CAACtC,WAAW,EAAE;MAClB,SAAAuC,KAAA,IAA4B,IAAI,CAACvC,WAAW,EAAE;QAAA,IAAAwC,KAAA,GAAAC,cAAA,CAAAF,KAAA;QAAA,IAAlCX,IAAI,GAAAY,KAAA;QAAA,IAAEE,KAAK,GAAAF,KAAA;QACnBF,OAAO,CAACV,IAAI,CAAC,GAAGc,KAAK;MACzB;IACJ;IACA,OAAO;MACHC,WAAW,GAAAT,gBAAA,GAAE,IAAI,CAACnC,UAAU,cAAAmC,gBAAA,cAAAA,gBAAA,GAAI,GAAG;MACnCU,YAAY,EAAEN,OAAO;MACrBjB,GAAG,GAAAc,SAAA,GAAE,IAAI,CAACd,GAAG,cAAAc,SAAA,cAAAA,SAAA,GAAI,EAAE;MACnBU,QAAQ,EAAAC,aAAA;QACJnB,OAAO,GAAAS,aAAA,GAAE,IAAI,CAACT,OAAO,cAAAS,aAAA,cAAAA,aAAA,GAAI,WAAW;QACpCZ,KAAK,GAAAa,gBAAA,GAAE,IAAI,CAACR,IAAI,CAACL,KAAK,cAAAa,gBAAA,cAAAA,gBAAA,GAAI;MAAiB,GACxC,IAAI,CAACR,IAAI;IAEpB,CAAC;EACL;;EAEA;AACJ;AACA;AACA;EACI,OAAckB,sBAAsBA,CAAClB,IAAwB,EAAe;IACxE,OAAO,IAAIb,WAAW,CAACa,IAAI,CAACgB,QAAQ,EAAEhB,IAAI,CAACc,WAAW,EAAEd,IAAI,CAACR,GAAG,EAAED,SAAS,EAAE,IAAI4B,OAAO,CAACnB,IAAI,CAACe,YAAY,CAAC,CAAC;EAChH;AACJ;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASK,mBAAmBA,CAACzB,KAAc,EAAE0B,SAAiB,EAAU;EAC3E,IAAI,EAAE1B,KAAK,YAAY7B,SAAS,CAAC,IAAI,CAAC6B,KAAK,CAACvB,gBAAgB,CAAC,CAAC,EAAE;IAC5D,OAAOiD,SAAS;EACpB;EACA,IAAI;IAAA,IAAAC,qBAAA;IACA,QAAAA,qBAAA,GAAO3B,KAAK,CAACtB,eAAe,CAAC,CAAC,cAAAiD,qBAAA,cAAAA,qBAAA,GAAID,SAAS;EAC/C,CAAC,CAAC,OAAAE,OAAA,EAAM;IACJ,OAAOF,SAAS;EACpB;AACJ;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMG,eAAe,SAASzD,KAAK,CAAC;EAChCC,WAAWA,CAAC0B,OAAe,EAAE+B,KAAa,EAAE;IAC/C,KAAK,CAAC/B,OAAO,IAAI+B,KAAK,QAAA7B,MAAA,CAAQ6B,KAAK,CAAC/B,OAAO,IAAK,EAAE,CAAC,CAAC;EACxD;EAEA,IAAWK,IAAIA,CAAA,EAAW;IACtB,OAAO,iBAAiB;EAC5B;AACJ;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAM2B,iBAAiB,SAAS3D,KAAK,CAAC;EAClCC,WAAWA,CAACyD,KAAa,EAAE;IAAA,IAAAE,cAAA;IAC9B,KAAK,EAAAA,cAAA,GAACF,KAAK,aAALA,KAAK,uBAALA,KAAK,CAAE/B,OAAO,cAAAiC,cAAA,cAAAA,cAAA,GAAI,EAAE,CAAC;EAC/B;EAEA,IAAW5B,IAAIA,CAAA,EAAW;IACtB,OAAO,mBAAmB;EAC9B;AACJ;;AAEA;AACA;AACA;AACA;AACA,OAAO,MAAM6B,uBAAuB,SAAS7D,KAAK,CAAC;EACxCC,WAAWA,CAACyD,KAAa,EAAE;IAAA,IAAAI,eAAA;IAC9B,KAAK,EAAAA,eAAA,GAACJ,KAAK,aAALA,KAAK,uBAALA,KAAK,CAAE/B,OAAO,cAAAmC,eAAA,cAAAA,eAAA,GAAI,EAAE,CAAC;EAC/B;EAEA,IAAW9B,IAAIA,CAAA,EAAW;IACtB,OAAO,yBAAyB;EACpC;AACJ;AAEA,OAAO,IAAM+B,qBAAqB,GAAG,IAAIjE,eAAe,CAAC,IAAI,EAAE,2BAA2B,CAAC;;AAE3F;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMkE,iBAAiB,SAAS5C,WAAW,CAAC;EAUxCnB,WAAWA,CAAA,EAAsD;IACpE,KAAK,CAAC,GAAAqB,SAAQ,CAAC;IAVnB;AACJ;AACA;AACA;IAHIQ,eAAA;IAKA;AACJ;AACA;IAFIA,eAAA;IAMI,IAAMmC,IAAI,GAAA3C,SAAA,CAAAC,MAAA,QAAAC,SAAA,GAAAF,SAAA,GAAW;IAErB,IAAI,CAAC4C,KAAK,GAAG,IAAIC,GAAG,CAACF,IAAI,IAAI,OAAO,IAAIA,IAAI,IAAIG,KAAK,CAACC,OAAO,CAACJ,IAAI,CAACC,KAAK,CAAC,GAAGD,IAAI,CAACC,KAAK,GAAG,EAAE,CAAC;IAC5F,IAAI,CAACvC,OAAO,MAAAE,MAAA,CAAM,KAAK,CAACF,OAAO,QAAAE,MAAA,CAAK,CAAC,GAAG,IAAI,CAACqC,KAAK,CAAC,CAACI,IAAI,CAAC,IAAI,CAAC,MAAG;IACjE,IAAIL,IAAI,IAAI,QAAQ,IAAIA,IAAI,IAAI,OAAOA,IAAI,CAACM,MAAM,KAAK,QAAQ,EAAE;MAC7D,IAAI,CAACA,MAAM,GAAG,IAAIvD,IAAI,CAACiD,IAAI,CAACM,MAAM,CAAC;IACvC;EACJ;AACJ","ignoreList":[]}
+{"version":3,"file":"errors.js","names":[],"sources":["../../src/http-api/errors.ts"],"sourcesContent":["/*\nCopyright 2022 - 2024 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 IMatrixApiError as IWidgetMatrixError } from \"matrix-widget-api\";\n\nimport { type IUsageLimit } from \"../@types/partials.ts\";\nimport { type MatrixEvent } from \"../models/event.ts\";\nimport { NamespacedValue } from \"../NamespacedValue.ts\";\n\ninterface IErrorJson extends Partial<IUsageLimit> {\n    [key: string]: any; // extensible\n    errcode?: string;\n    error?: string;\n}\n\n/**\n * Construct a generic HTTP error. This is a JavaScript Error with additional information\n * specific to HTTP responses.\n * @param msg - The error message to include.\n * @param httpStatus - The HTTP response status code.\n * @param httpHeaders - The HTTP response headers.\n */\nexport class HTTPError extends Error {\n    public constructor(\n        msg: string,\n        public readonly httpStatus?: number,\n        public readonly httpHeaders?: Headers,\n    ) {\n        super(msg);\n    }\n\n    /**\n     * Check if this error was due to rate-limiting on the server side (and should therefore be retried after a delay).\n     *\n     * If this returns `true`, {@link getRetryAfterMs} can be called to retrieve the server-side\n     * recommendation for the retry period.\n     *\n     * @returns Whether this error is due to rate-limiting.\n     */\n    public isRateLimitError(): boolean {\n        return this.httpStatus === 429;\n    }\n\n    /**\n     * @returns The recommended delay in milliseconds to wait before retrying\n     * the request that triggered this error, or null if no delay is recommended.\n     * @throws Error if the recommended delay is an invalid value.\n     * @see {@link safeGetRetryAfterMs} for a version of this check that doesn't throw.\n     */\n    public getRetryAfterMs(): number | null {\n        const retryAfter = this.httpHeaders?.get(\"Retry-After\");\n        if (retryAfter != null) {\n            if (/^\\d+$/.test(retryAfter)) {\n                const ms = Number.parseInt(retryAfter) * 1000;\n                if (!Number.isFinite(ms)) {\n                    throw new Error(\"Retry-After header integer value is too large\");\n                }\n                return ms;\n            }\n            const date = new Date(retryAfter);\n            if (date.toUTCString() !== retryAfter) {\n                throw new Error(\"Retry-After header value is not a valid HTTP-date or non-negative decimal integer\");\n            }\n            return date.getTime() - Date.now();\n        }\n        return null;\n    }\n}\n\nexport class MatrixError extends HTTPError {\n    // The Matrix 'errcode' value, e.g. \"M_FORBIDDEN\".\n    public readonly errcode?: string;\n    // The Matrix 'error' value.\n    public readonly error?: string;\n    // The raw Matrix error JSON used to construct this object.\n    public data: IErrorJson;\n\n    /**\n     * Construct a Matrix error. This is a JavaScript Error with additional\n     * information specific to the standard Matrix error response.\n     * @param errorJson - The Matrix error JSON returned from the homeserver.\n     * @param httpStatus - The numeric HTTP status code given\n     * @param httpHeaders - The HTTP response headers given\n     */\n    public constructor(\n        errorJson: IErrorJson = {},\n        httpStatus?: number,\n        public url?: string,\n        public event?: MatrixEvent,\n        httpHeaders?: Headers,\n    ) {\n        let message = errorJson.error || \"Unknown message\";\n        if (httpStatus) {\n            message = `[${httpStatus}] ${message}`;\n        }\n        if (url) {\n            message = `${message} (${url})`;\n        }\n        super(`MatrixError: ${message}`, httpStatus, httpHeaders);\n        this.errcode = errorJson.errcode;\n        this.error = errorJson.error;\n        this.name = errorJson.errcode || \"Unknown error code\";\n        this.data = errorJson;\n    }\n\n    public isRateLimitError(): boolean {\n        return (\n            this.errcode === \"M_LIMIT_EXCEEDED\" ||\n            ((this.errcode === \"M_UNKNOWN\" || this.errcode === undefined) && super.isRateLimitError())\n        );\n    }\n\n    public getRetryAfterMs(): number | null {\n        const headerValue = super.getRetryAfterMs();\n        if (headerValue !== null) {\n            return headerValue;\n        }\n        // Note: retry_after_ms is deprecated as of spec version v1.10\n        if (this.errcode === \"M_LIMIT_EXCEEDED\" && \"retry_after_ms\" in this.data) {\n            if (!Number.isInteger(this.data.retry_after_ms)) {\n                throw new Error(\"retry_after_ms is not an integer\");\n            }\n            return this.data.retry_after_ms;\n        }\n        return null;\n    }\n\n    /**\n     * @returns this error expressed as a JSON payload\n     * for use by Widget API error responses.\n     */\n    public asWidgetApiErrorData(): IWidgetMatrixError {\n        const headers: Record<string, string> = {};\n        if (this.httpHeaders) {\n            for (const [name, value] of this.httpHeaders) {\n                headers[name] = value;\n            }\n        }\n        return {\n            http_status: this.httpStatus ?? 400,\n            http_headers: headers,\n            url: this.url ?? \"\",\n            response: {\n                errcode: this.errcode ?? \"M_UNKNOWN\",\n                error: this.data.error ?? \"Unknown message\",\n                ...this.data,\n            },\n        };\n    }\n\n    /**\n     * @returns a new {@link MatrixError} from a JSON payload\n     * received from Widget API error responses.\n     */\n    public static fromWidgetApiErrorData(data: IWidgetMatrixError): MatrixError {\n        return new MatrixError(data.response, data.http_status, data.url, undefined, new Headers(data.http_headers));\n    }\n}\n\n/**\n * @returns The recommended delay in milliseconds to wait before retrying the request.\n * @param error - The error to check for a retry delay.\n * @param defaultMs - The delay to use if the error was not due to rate-limiting or if no valid delay is recommended.\n */\nexport function safeGetRetryAfterMs(error: unknown, defaultMs: number): number {\n    if (!(error instanceof HTTPError) || !error.isRateLimitError()) {\n        return defaultMs;\n    }\n    try {\n        return error.getRetryAfterMs() ?? defaultMs;\n    } catch {\n        return defaultMs;\n    }\n}\n\n/**\n * Construct a ConnectionError. This is a JavaScript Error indicating\n * that a request failed because of some error with the connection, either\n * CORS was not correctly configured on the server, the server didn't response,\n * the request timed out, or the internet connection on the client side went down.\n */\nexport class ConnectionError extends Error {\n    public constructor(message: string, cause?: Error) {\n        super(message + (cause ? `: ${cause.message}` : \"\"));\n    }\n\n    public get name(): string {\n        return \"ConnectionError\";\n    }\n}\n\n/**\n * Construct a TokenRefreshError. This indicates that a request failed due to the token being expired,\n * and attempting to refresh said token also failed but in a way which was not indicative of token invalidation.\n * Assumed to be a temporary failure.\n */\nexport class TokenRefreshError extends Error {\n    public constructor(cause?: Error) {\n        super(cause?.message ?? \"\");\n    }\n\n    public get name(): string {\n        return \"TokenRefreshError\";\n    }\n}\n\n/**\n * Construct a TokenRefreshError. This indicates that a request failed due to the token being expired,\n * and attempting to refresh said token failed in a way indicative of token invalidation.\n */\nexport class TokenRefreshLogoutError extends Error {\n    public constructor(cause?: Error) {\n        super(cause?.message ?? \"\");\n    }\n\n    public get name(): string {\n        return \"TokenRefreshLogoutError\";\n    }\n}\n\nexport const MatrixSafetyErrorCode = new NamespacedValue(null, \"ORG.MATRIX.MSC4387_SAFETY\");\n\n/***\n * This error is thrown when the homeserver refuses to handle an action due to a\n * safety concern.\n * @see https://github.com/matrix-org/matrix-spec-proposals/pull/4387\n */\nexport class MatrixSafetyError extends MatrixError {\n    /**\n     * The kinds of harms detected by the server.\n     * @see https://github.com/matrix-org/matrix-spec-proposals/pull/4387 for a list of spec defined harms.\n     */\n    public readonly harms: Set<string>;\n    /**\n     * The date at which a request can be reattempted.\n     */\n    public readonly expiry?: Date;\n    public constructor(...props: ConstructorParameters<typeof MatrixError>) {\n        super(...props);\n        const body = props[0];\n\n        this.harms = new Set(body && \"harms\" in body && Array.isArray(body.harms) ? body.harms : []);\n        this.message = `${super.message} (${[...this.harms].join(\", \")})`;\n        if (body && \"expiry\" in body && typeof body.expiry === \"number\") {\n            this.expiry = new Date(body.expiry);\n        }\n    }\n}\n"],"mappings":";;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAMA,SAAS,eAAe,QAAQ,uBAAuB;AAQvD;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAM,SAAS,SAAS,KAAK,CAAC;EAC1B,WAAW,CACd,GAAW,EACK,UAAmB,EACnB,WAAqB,EACvC;IACE,KAAK,CAAC,GAAG,CAAC;IAAC,KAHK,UAAmB,GAAnB,UAAmB;IAAA,KACnB,WAAqB,GAArB,WAAqB;EAGzC;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;EACW,gBAAgB,GAAY;IAC/B,OAAO,IAAI,CAAC,UAAU,KAAK,GAAG;EAClC;;EAEA;AACJ;AACA;AACA;AACA;AACA;EACW,eAAe,GAAkB;IACpC,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC,aAAa,CAAC;IACvD,IAAI,UAAU,IAAI,IAAI,EAAE;MACpB,IAAI,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;QAC1B,MAAM,EAAE,GAAG,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,IAAI;QAC7C,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE;UACtB,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC;QACpE;QACA,OAAO,EAAE;MACb;MACA,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,UAAU,CAAC;MACjC,IAAI,IAAI,CAAC,WAAW,CAAC,CAAC,KAAK,UAAU,EAAE;QACnC,MAAM,IAAI,KAAK,CAAC,mFAAmF,CAAC;MACxG;MACA,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;IACtC;IACA,OAAO,IAAI;EACf;AACJ;AAEA,OAAO,MAAM,WAAW,SAAS,SAAS,CAAC;EAQvC;AACJ;AACA;AACA;AACA;AACA;AACA;EACW,WAAW,CACd,SAAqB,GAAG,CAAC,CAAC,EAC1B,UAAmB,EACZ,GAAY,EACZ,KAAmB,EAC1B,WAAqB,EACvB;IACE,IAAI,OAAO,GAAG,SAAS,CAAC,KAAK,IAAI,iBAAiB;IAClD,IAAI,UAAU,EAAE;MACZ,OAAO,GAAG,IAAI,UAAU,KAAK,OAAO,EAAE;IAC1C;IACA,IAAI,GAAG,EAAE;MACL,OAAO,GAAG,GAAG,OAAO,KAAK,GAAG,GAAG;IACnC;IACA,KAAK,CAAC,gBAAgB,OAAO,EAAE,EAAE,UAAU,EAAE,WAAW,CAAC;IA5B7D;IAAA;IAEA;IAAA;IAEA;IAAA;IAAA,KAaW,GAAY,GAAZ,GAAY;IAAA,KACZ,KAAmB,GAAnB,KAAmB;IAW1B,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC,OAAO;IAChC,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC,KAAK;IAC5B,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC,OAAO,IAAI,oBAAoB;IACrD,IAAI,CAAC,IAAI,GAAG,SAAS;EACzB;EAEO,gBAAgB,GAAY;IAC/B,OACI,IAAI,CAAC,OAAO,KAAK,kBAAkB,IAClC,CAAC,IAAI,CAAC,OAAO,KAAK,WAAW,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,KAAK,KAAK,CAAC,gBAAgB,CAAC,CAAE;EAElG;EAEO,eAAe,GAAkB;IACpC,MAAM,WAAW,GAAG,KAAK,CAAC,eAAe,CAAC,CAAC;IAC3C,IAAI,WAAW,KAAK,IAAI,EAAE;MACtB,OAAO,WAAW;IACtB;IACA;IACA,IAAI,IAAI,CAAC,OAAO,KAAK,kBAAkB,IAAI,gBAAgB,IAAI,IAAI,CAAC,IAAI,EAAE;MACtE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE;QAC7C,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC;MACvD;MACA,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc;IACnC;IACA,OAAO,IAAI;EACf;;EAEA;AACJ;AACA;AACA;EACW,oBAAoB,GAAuB;IAC9C,MAAM,OAA+B,GAAG,CAAC,CAAC;IAC1C,IAAI,IAAI,CAAC,WAAW,EAAE;MAClB,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,WAAW,EAAE;QAC1C,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK;MACzB;IACJ;IACA,OAAO;MACH,WAAW,EAAE,IAAI,CAAC,UAAU,IAAI,GAAG;MACnC,YAAY,EAAE,OAAO;MACrB,GAAG,EAAE,IAAI,CAAC,GAAG,IAAI,EAAE;MACnB,QAAQ;QACJ,OAAO,EAAE,IAAI,CAAC,OAAO,IAAI,WAAW;QACpC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI;MAAiB,GACxC,IAAI,CAAC,IAAI;IAEpB,CAAC;EACL;;EAEA;AACJ;AACA;AACA;EACI,OAAc,sBAAsB,CAAC,IAAwB,EAAe;IACxE,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,GAAG,EAAE,SAAS,EAAE,IAAI,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;EAChH;AACJ;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAAS,mBAAmB,CAAC,KAAc,EAAE,SAAiB,EAAU;EAC3E,IAAI,EAAE,KAAK,YAAY,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,EAAE;IAC5D,OAAO,SAAS;EACpB;EACA,IAAI;IACA,OAAO,KAAK,CAAC,eAAe,CAAC,CAAC,IAAI,SAAS;EAC/C,CAAC,CAAC,MAAM;IACJ,OAAO,SAAS;EACpB;AACJ;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAM,eAAe,SAAS,KAAK,CAAC;EAChC,WAAW,CAAC,OAAe,EAAE,KAAa,EAAE;IAC/C,KAAK,CAAC,OAAO,IAAI,KAAK,GAAG,KAAK,KAAK,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;EACxD;EAEA,IAAW,IAAI,GAAW;IACtB,OAAO,iBAAiB;EAC5B;AACJ;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAM,iBAAiB,SAAS,KAAK,CAAC;EAClC,WAAW,CAAC,KAAa,EAAE;IAC9B,KAAK,CAAC,KAAK,EAAE,OAAO,IAAI,EAAE,CAAC;EAC/B;EAEA,IAAW,IAAI,GAAW;IACtB,OAAO,mBAAmB;EAC9B;AACJ;;AAEA;AACA;AACA;AACA;AACA,OAAO,MAAM,uBAAuB,SAAS,KAAK,CAAC;EACxC,WAAW,CAAC,KAAa,EAAE;IAC9B,KAAK,CAAC,KAAK,EAAE,OAAO,IAAI,EAAE,CAAC;EAC/B;EAEA,IAAW,IAAI,GAAW;IACtB,OAAO,yBAAyB;EACpC;AACJ;AAEA,OAAO,MAAM,qBAAqB,GAAG,IAAI,eAAe,CAAC,IAAI,EAAE,2BAA2B,CAAC;;AAE3F;AACA;AACA;AACA;AACA;AACA,OAAO,MAAM,iBAAiB,SAAS,WAAW,CAAC;EAUxC,WAAW,CAAC,GAAG,KAAgD,EAAE;IACpE,KAAK,CAAC,GAAG,KAAK,CAAC;IAVnB;AACJ;AACA;AACA;IAHI;IAKA;AACJ;AACA;IAFI;IAMI,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC;IAErB,IAAI,CAAC,KAAK,GAAG,IAAI,GAAG,CAAC,IAAI,IAAI,OAAO,IAAI,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;IAC5F,IAAI,CAAC,OAAO,GAAG,GAAG,KAAK,CAAC,OAAO,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;IACjE,IAAI,IAAI,IAAI,QAAQ,IAAI,IAAI,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ,EAAE;MAC7D,IAAI,CAAC,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;IACvC;EACJ;AACJ","ignoreList":[]}