@unwanted/matrix-sdk-mini 34.12.0-1

package/lib/filter-component.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filter-component.js","names":["FILTER_RELATED_BY_REL_TYPES","FILTER_RELATED_BY_SENDERS","THREAD_RELATION_TYPE","matchesWildcard","actualValue","filterValue","endsWith","typePrefix","slice","length","FilterComponent","constructor","filterJson","userId","check","event","_event$getUnsigned","_bundledRelationships","bundledRelationships","getUnsigned","relations","Object","keys","relationSenders","name","current_user_participated","push","checkFields","getRoomId","getSender","getType","getContent","url","undefined","toJSON","types","not_types","rooms","not_rooms","senders","not_senders","contains_url","roomId","sender","eventType","containsUrl","relationTypes","literalKeys","v","matchFunc","notName","disallowedValues","some","allowedValues","containsUrlFilter","relationTypesFilter","arrayMatchesFilter","relationSendersFilter","filter","values","every","value","includes","events","limit"],"sources":["../src/filter-component.ts"],"sourcesContent":["/*\nCopyright 2016 - 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 { RelationType } from \"./@types/event.ts\";\nimport { MatrixEvent } from \"./models/event.ts\";\nimport { FILTER_RELATED_BY_REL_TYPES, FILTER_RELATED_BY_SENDERS, THREAD_RELATION_TYPE } from \"./models/thread.ts\";\n\n/**\n * Checks if a value matches a given field value, which may be a * terminated\n * wildcard pattern.\n * @param actualValue -  The value to be compared\n * @param filterValue -  The filter pattern to be compared\n * @returns true if the actualValue matches the filterValue\n */\nfunction matchesWildcard(actualValue: string, filterValue: string): boolean {\n    if (filterValue.endsWith(\"*\")) {\n        const typePrefix = filterValue.slice(0, -1);\n        return actualValue.slice(0, typePrefix.length) === typePrefix;\n    } else {\n        return actualValue === filterValue;\n    }\n}\n\n/* eslint-disable camelcase */\nexport interface IFilterComponent {\n    \"types\"?: string[];\n    \"not_types\"?: string[];\n    \"rooms\"?: string[];\n    \"not_rooms\"?: string[];\n    \"senders\"?: string[];\n    \"not_senders\"?: string[];\n    \"contains_url\"?: boolean;\n    \"limit\"?: number;\n    \"related_by_senders\"?: Array<RelationType | string>;\n    \"related_by_rel_types\"?: string[];\n\n    // Unstable values\n    \"io.element.relation_senders\"?: Array<RelationType | string>;\n    \"io.element.relation_types\"?: string[];\n}\n/* eslint-enable camelcase */\n\n/**\n * FilterComponent is a section of a Filter definition which defines the\n * types, rooms, senders filters etc to be applied to a particular type of resource.\n * This is all ported over from synapse's Filter object.\n *\n * N.B. that synapse refers to these as 'Filters', and what js-sdk refers to as\n * 'Filters' are referred to as 'FilterCollections'.\n */\nexport class FilterComponent {\n    public constructor(\n        private filterJson: IFilterComponent,\n        public readonly userId?: string | undefined | null,\n    ) {}\n\n    /**\n     * Checks with the filter component matches the given event\n     * @param event - event to be checked against the filter\n     * @returns true if the event matches the filter\n     */\n    public check(event: MatrixEvent): boolean {\n        const bundledRelationships = event.getUnsigned()?.[\"m.relations\"] || {};\n        const relations: Array<string | RelationType> = Object.keys(bundledRelationships);\n        // Relation senders allows in theory a look-up of any senders\n        // however clients can only know about the current user participation status\n        // as sending a whole list of participants could be proven problematic in terms\n        // of performance\n        // This should be improved when bundled relationships solve that problem\n        const relationSenders: string[] = [];\n        if (this.userId && bundledRelationships?.[THREAD_RELATION_TYPE.name]?.current_user_participated) {\n            relationSenders.push(this.userId);\n        }\n\n        return this.checkFields(\n            event.getRoomId(),\n            event.getSender(),\n            event.getType(),\n            event.getContent() ? event.getContent().url !== undefined : false,\n            relations,\n            relationSenders,\n        );\n    }\n\n    /**\n     * Converts the filter component into the form expected over the wire\n     */\n    public toJSON(): object {\n        return {\n            types: this.filterJson.types || null,\n            not_types: this.filterJson.not_types || [],\n            rooms: this.filterJson.rooms || null,\n            not_rooms: this.filterJson.not_rooms || [],\n            senders: this.filterJson.senders || null,\n            not_senders: this.filterJson.not_senders || [],\n            contains_url: this.filterJson.contains_url || null,\n            [FILTER_RELATED_BY_SENDERS.name]: this.filterJson[FILTER_RELATED_BY_SENDERS.name] || [],\n            [FILTER_RELATED_BY_REL_TYPES.name]: this.filterJson[FILTER_RELATED_BY_REL_TYPES.name] || [],\n        };\n    }\n\n    /**\n     * Checks whether the filter component matches the given event fields.\n     * @param roomId -        the roomId for the event being checked\n     * @param sender -        the sender of the event being checked\n     * @param eventType -     the type of the event being checked\n     * @param containsUrl -  whether the event contains a content.url field\n     * @param relationTypes -  whether has aggregated relation of the given type\n     * @param relationSenders - whether one of the relation is sent by the user listed\n     * @returns true if the event fields match the filter\n     */\n    private checkFields(\n        roomId: string | undefined,\n        sender: string | undefined,\n        eventType: string,\n        containsUrl: boolean,\n        relationTypes: Array<RelationType | string>,\n        relationSenders: string[],\n    ): boolean {\n        const literalKeys = {\n            rooms: function (v: string): boolean {\n                return roomId === v;\n            },\n            senders: function (v: string): boolean {\n                return sender === v;\n            },\n            types: function (v: string): boolean {\n                return matchesWildcard(eventType, v);\n            },\n        } as const;\n\n        for (const name in literalKeys) {\n            const matchFunc = literalKeys[<keyof typeof literalKeys>name];\n            const notName = \"not_\" + name;\n            const disallowedValues = this.filterJson[<`not_${keyof typeof literalKeys}`>notName];\n            if (disallowedValues?.some(matchFunc)) {\n                return false;\n            }\n\n            const allowedValues = this.filterJson[name as keyof typeof literalKeys];\n            if (allowedValues && !allowedValues.some(matchFunc)) {\n                return false;\n            }\n        }\n\n        const containsUrlFilter = this.filterJson.contains_url;\n        if (containsUrlFilter !== undefined && containsUrlFilter !== containsUrl) {\n            return false;\n        }\n\n        const relationTypesFilter = this.filterJson[FILTER_RELATED_BY_REL_TYPES.name];\n        if (relationTypesFilter !== undefined) {\n            if (!this.arrayMatchesFilter(relationTypesFilter, relationTypes)) {\n                return false;\n            }\n        }\n\n        const relationSendersFilter = this.filterJson[FILTER_RELATED_BY_SENDERS.name];\n        if (relationSendersFilter !== undefined) {\n            if (!this.arrayMatchesFilter(relationSendersFilter, relationSenders)) {\n                return false;\n            }\n        }\n\n        return true;\n    }\n\n    private arrayMatchesFilter(filter: any[], values: any[]): boolean {\n        return (\n            values.length > 0 &&\n            filter.every((value) => {\n                return values.includes(value);\n            })\n        );\n    }\n\n    /**\n     * Filters a list of events down to those which match this filter component\n     * @param events -  Events to be checked against the filter component\n     * @returns events which matched the filter component\n     */\n    public filter(events: MatrixEvent[]): MatrixEvent[] {\n        return events.filter(this.check, this);\n    }\n\n    /**\n     * Returns the limit field for a given filter component, providing a default of\n     * 10 if none is otherwise specified. Cargo-culted from Synapse.\n     * @returns the limit for this filter component.\n     */\n    public limit(): number {\n        return this.filterJson.limit !== undefined ? this.filterJson.limit : 10;\n    }\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAIA,SAASA,2BAA2B,EAAEC,yBAAyB,EAAEC,oBAAoB,QAAQ,oBAAoB;;AAEjH;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASC,eAAeA,CAACC,WAAmB,EAAEC,WAAmB,EAAW;EACxE,IAAIA,WAAW,CAACC,QAAQ,CAAC,GAAG,CAAC,EAAE;IAC3B,IAAMC,UAAU,GAAGF,WAAW,CAACG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3C,OAAOJ,WAAW,CAACI,KAAK,CAAC,CAAC,EAAED,UAAU,CAACE,MAAM,CAAC,KAAKF,UAAU;EACjE,CAAC,MAAM;IACH,OAAOH,WAAW,KAAKC,WAAW;EACtC;AACJ;;AAEA;;AAiBA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMK,eAAe,CAAC;EAClBC,WAAWA,CACNC,UAA4B,EACpBC,MAAkC,EACpD;IAAA,KAFUD,UAA4B,GAA5BA,UAA4B;IAAA,KACpBC,MAAkC,GAAlCA,MAAkC;EACnD;;EAEH;AACJ;AACA;AACA;AACA;EACWC,KAAKA,CAACC,KAAkB,EAAW;IAAA,IAAAC,kBAAA,EAAAC,qBAAA;IACtC,IAAMC,oBAAoB,GAAG,EAAAF,kBAAA,GAAAD,KAAK,CAACI,WAAW,CAAC,CAAC,cAAAH,kBAAA,uBAAnBA,kBAAA,CAAsB,aAAa,CAAC,KAAI,CAAC,CAAC;IACvE,IAAMI,SAAuC,GAAGC,MAAM,CAACC,IAAI,CAACJ,oBAAoB,CAAC;IACjF;IACA;IACA;IACA;IACA;IACA,IAAMK,eAAyB,GAAG,EAAE;IACpC,IAAI,IAAI,CAACV,MAAM,IAAIK,oBAAoB,aAApBA,oBAAoB,gBAAAD,qBAAA,GAApBC,oBAAoB,CAAGhB,oBAAoB,CAACsB,IAAI,CAAC,cAAAP,qBAAA,eAAjDA,qBAAA,CAAmDQ,yBAAyB,EAAE;MAC7FF,eAAe,CAACG,IAAI,CAAC,IAAI,CAACb,MAAM,CAAC;IACrC;IAEA,OAAO,IAAI,CAACc,WAAW,CACnBZ,KAAK,CAACa,SAAS,CAAC,CAAC,EACjBb,KAAK,CAACc,SAAS,CAAC,CAAC,EACjBd,KAAK,CAACe,OAAO,CAAC,CAAC,EACff,KAAK,CAACgB,UAAU,CAAC,CAAC,GAAGhB,KAAK,CAACgB,UAAU,CAAC,CAAC,CAACC,GAAG,KAAKC,SAAS,GAAG,KAAK,EACjEb,SAAS,EACTG,eACJ,CAAC;EACL;;EAEA;AACJ;AACA;EACWW,MAAMA,CAAA,EAAW;IACpB,OAAO;MACHC,KAAK,EAAE,IAAI,CAACvB,UAAU,CAACuB,KAAK,IAAI,IAAI;MACpCC,SAAS,EAAE,IAAI,CAACxB,UAAU,CAACwB,SAAS,IAAI,EAAE;MAC1CC,KAAK,EAAE,IAAI,CAACzB,UAAU,CAACyB,KAAK,IAAI,IAAI;MACpCC,SAAS,EAAE,IAAI,CAAC1B,UAAU,CAAC0B,SAAS,IAAI,EAAE;MAC1CC,OAAO,EAAE,IAAI,CAAC3B,UAAU,CAAC2B,OAAO,IAAI,IAAI;MACxCC,WAAW,EAAE,IAAI,CAAC5B,UAAU,CAAC4B,WAAW,IAAI,EAAE;MAC9CC,YAAY,EAAE,IAAI,CAAC7B,UAAU,CAAC6B,YAAY,IAAI,IAAI;MAClD,CAACxC,yBAAyB,CAACuB,IAAI,GAAG,IAAI,CAACZ,UAAU,CAACX,yBAAyB,CAACuB,IAAI,CAAC,IAAI,EAAE;MACvF,CAACxB,2BAA2B,CAACwB,IAAI,GAAG,IAAI,CAACZ,UAAU,CAACZ,2BAA2B,CAACwB,IAAI,CAAC,IAAI;IAC7F,CAAC;EACL;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACYG,WAAWA,CACfe,MAA0B,EAC1BC,MAA0B,EAC1BC,SAAiB,EACjBC,WAAoB,EACpBC,aAA2C,EAC3CvB,eAAyB,EAClB;IACP,IAAMwB,WAAW,GAAG;MAChBV,KAAK,EAAE,SAAPA,KAAKA,CAAYW,CAAS,EAAW;QACjC,OAAON,MAAM,KAAKM,CAAC;MACvB,CAAC;MACDT,OAAO,EAAE,SAATA,OAAOA,CAAYS,CAAS,EAAW;QACnC,OAAOL,MAAM,KAAKK,CAAC;MACvB,CAAC;MACDb,KAAK,EAAE,SAAPA,KAAKA,CAAYa,CAAS,EAAW;QACjC,OAAO7C,eAAe,CAACyC,SAAS,EAAEI,CAAC,CAAC;MACxC;IACJ,CAAU;IAEV,KAAK,IAAMxB,IAAI,IAAIuB,WAAW,EAAE;MAC5B,IAAME,SAAS,GAAGF,WAAW,CAA2BvB,IAAI,CAAC;MAC7D,IAAM0B,OAAO,GAAG,MAAM,GAAG1B,IAAI;MAC7B,IAAM2B,gBAAgB,GAAG,IAAI,CAACvC,UAAU,CAAoCsC,OAAO,CAAC;MACpF,IAAIC,gBAAgB,aAAhBA,gBAAgB,eAAhBA,gBAAgB,CAAEC,IAAI,CAACH,SAAS,CAAC,EAAE;QACnC,OAAO,KAAK;MAChB;MAEA,IAAMI,aAAa,GAAG,IAAI,CAACzC,UAAU,CAACY,IAAI,CAA6B;MACvE,IAAI6B,aAAa,IAAI,CAACA,aAAa,CAACD,IAAI,CAACH,SAAS,CAAC,EAAE;QACjD,OAAO,KAAK;MAChB;IACJ;IAEA,IAAMK,iBAAiB,GAAG,IAAI,CAAC1C,UAAU,CAAC6B,YAAY;IACtD,IAAIa,iBAAiB,KAAKrB,SAAS,IAAIqB,iBAAiB,KAAKT,WAAW,EAAE;MACtE,OAAO,KAAK;IAChB;IAEA,IAAMU,mBAAmB,GAAG,IAAI,CAAC3C,UAAU,CAACZ,2BAA2B,CAACwB,IAAI,CAAC;IAC7E,IAAI+B,mBAAmB,KAAKtB,SAAS,EAAE;MACnC,IAAI,CAAC,IAAI,CAACuB,kBAAkB,CAACD,mBAAmB,EAAET,aAAa,CAAC,EAAE;QAC9D,OAAO,KAAK;MAChB;IACJ;IAEA,IAAMW,qBAAqB,GAAG,IAAI,CAAC7C,UAAU,CAACX,yBAAyB,CAACuB,IAAI,CAAC;IAC7E,IAAIiC,qBAAqB,KAAKxB,SAAS,EAAE;MACrC,IAAI,CAAC,IAAI,CAACuB,kBAAkB,CAACC,qBAAqB,EAAElC,eAAe,CAAC,EAAE;QAClE,OAAO,KAAK;MAChB;IACJ;IAEA,OAAO,IAAI;EACf;EAEQiC,kBAAkBA,CAACE,MAAa,EAAEC,MAAa,EAAW;IAC9D,OACIA,MAAM,CAAClD,MAAM,GAAG,CAAC,IACjBiD,MAAM,CAACE,KAAK,CAAEC,KAAK,IAAK;MACpB,OAAOF,MAAM,CAACG,QAAQ,CAACD,KAAK,CAAC;IACjC,CAAC,CAAC;EAEV;;EAEA;AACJ;AACA;AACA;AACA;EACWH,MAAMA,CAACK,MAAqB,EAAiB;IAChD,OAAOA,MAAM,CAACL,MAAM,CAAC,IAAI,CAAC5C,KAAK,EAAE,IAAI,CAAC;EAC1C;;EAEA;AACJ;AACA;AACA;AACA;EACWkD,KAAKA,CAAA,EAAW;IACnB,OAAO,IAAI,CAACpD,UAAU,CAACoD,KAAK,KAAK/B,SAAS,GAAG,IAAI,CAACrB,UAAU,CAACoD,KAAK,GAAG,EAAE;EAC3E;AACJ","ignoreList":[]}

package/lib/filter.d.ts

@@ -0,0 +1,97 @@
+import { EventType, RelationType } from "./@types/event.ts";
+import { FilterComponent, IFilterComponent } from "./filter-component.ts";
+import { MatrixEvent } from "./models/event.ts";
+export interface IFilterDefinition {
+    event_fields?: string[];
+    event_format?: "client" | "federation";
+    presence?: IFilterComponent;
+    account_data?: IFilterComponent;
+    room?: IRoomFilter;
+}
+export interface IRoomEventFilter extends IFilterComponent {
+    "lazy_load_members"?: boolean;
+    "include_redundant_members"?: boolean;
+    "types"?: Array<EventType | string>;
+    "related_by_senders"?: Array<RelationType | string>;
+    "related_by_rel_types"?: string[];
+    "unread_thread_notifications"?: boolean;
+    "org.matrix.msc3773.unread_thread_notifications"?: boolean;
+    "io.element.relation_senders"?: Array<RelationType | string>;
+    "io.element.relation_types"?: string[];
+}
+interface IStateFilter extends IRoomEventFilter {
+}
+interface IRoomFilter {
+    not_rooms?: string[];
+    rooms?: string[];
+    ephemeral?: IRoomEventFilter;
+    include_leave?: boolean;
+    state?: IStateFilter;
+    timeline?: IRoomEventFilter;
+    account_data?: IRoomEventFilter;
+}
+export declare class Filter {
+    readonly userId: string | undefined | null;
+    filterId?: string | undefined;
+    static LAZY_LOADING_MESSAGES_FILTER: {
+        lazy_load_members: boolean;
+    };
+    /**
+     * Create a filter from existing data.
+     */
+    static fromJson(userId: string | undefined | null, filterId: string, jsonObj: IFilterDefinition): Filter;
+    private definition;
+    private roomFilter?;
+    private roomTimelineFilter?;
+    /**
+     * Construct a new Filter.
+     * @param userId - The user ID for this filter.
+     * @param filterId - The filter ID if known.
+     */
+    constructor(userId: string | undefined | null, filterId?: string | undefined);
+    /**
+     * Get the ID of this filter on your homeserver (if known)
+     * @returns The filter ID
+     */
+    getFilterId(): string | undefined;
+    /**
+     * Get the JSON body of the filter.
+     * @returns The filter definition
+     */
+    getDefinition(): IFilterDefinition;
+    /**
+     * Set the JSON body of the filter
+     * @param definition - The filter definition
+     */
+    setDefinition(definition: IFilterDefinition): void;
+    /**
+     * Get the room.timeline filter component of the filter
+     * @returns room timeline filter component
+     */
+    getRoomTimelineFilterComponent(): FilterComponent | undefined;
+    /**
+     * Filter the list of events based on whether they are allowed in a timeline
+     * based on this filter
+     * @param events -  the list of events being filtered
+     * @returns the list of events which match the filter
+     */
+    filterRoomTimeline(events: MatrixEvent[]): MatrixEvent[];
+    /**
+     * Set the max number of events to return for each room's timeline.
+     * @param limit - The max number of events to return for each room.
+     */
+    setTimelineLimit(limit: number): void;
+    /**
+     * Enable threads unread notification
+     */
+    setUnreadThreadNotifications(enabled: boolean): void;
+    setLazyLoadMembers(enabled: boolean): void;
+    /**
+     * Control whether left rooms should be included in responses.
+     * @param includeLeave - True to make rooms the user has left appear
+     * in responses.
+     */
+    setIncludeLeaveRooms(includeLeave: boolean): void;
+}
+export {};
+//# sourceMappingURL=filter.d.ts.map

package/lib/filter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filter.d.ts","sourceRoot":"","sources":["../src/filter.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAE5D,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAiBhD,MAAM,WAAW,iBAAiB;IAC9B,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,YAAY,CAAC,EAAE,QAAQ,GAAG,YAAY,CAAC;IACvC,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,IAAI,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACtD,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,2BAA2B,CAAC,EAAE,OAAO,CAAC;IACtC,OAAO,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,MAAM,CAAC,CAAC;IACpC,oBAAoB,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,MAAM,CAAC,CAAC;IACpD,sBAAsB,CAAC,EAAE,MAAM,EAAE,CAAC;IAClC,6BAA6B,CAAC,EAAE,OAAO,CAAC;IACxC,gDAAgD,CAAC,EAAE,OAAO,CAAC;IAG3D,6BAA6B,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,MAAM,CAAC,CAAC;IAC7D,2BAA2B,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1C;AAED,UAAU,YAAa,SAAQ,gBAAgB;CAAG;AAElD,UAAU,WAAW;IACjB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAC7B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B,YAAY,CAAC,EAAE,gBAAgB,CAAC;CACnC;AAGD,qBAAa,MAAM;aAwBK,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;IAC1C,QAAQ,CAAC,EAAE,MAAM;IAxB5B,OAAc,4BAA4B;;MAExC;IAEF;;OAEG;WACW,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,GAAG,MAAM;IAM/G,OAAO,CAAC,UAAU,CAAyB;IAC3C,OAAO,CAAC,UAAU,CAAC,CAAkB;IACrC,OAAO,CAAC,kBAAkB,CAAC,CAAkB;IAE7C;;;;OAIG;gBAEiB,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,EAC1C,QAAQ,CAAC,EAAE,MAAM,YAAA;IAG5B;;;OAGG;IACI,WAAW,IAAI,MAAM,GAAG,SAAS;IAIxC;;;OAGG;IACI,aAAa,IAAI,iBAAiB;IAIzC;;;OAGG;IACI,aAAa,CAAC,UAAU,EAAE,iBAAiB,GAAG,IAAI;IAiEzD;;;OAGG;IACI,8BAA8B,IAAI,eAAe,GAAG,SAAS;IAIpE;;;;;OAKG;IACI,kBAAkB,CAAC,MAAM,EAAE,WAAW,EAAE,GAAG,WAAW,EAAE;IAU/D;;;OAGG;IACI,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAI5C;;OAEG;IACI,4BAA4B,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAapD,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAIjD;;;;OAIG;IACI,oBAAoB,CAAC,YAAY,EAAE,OAAO,GAAG,IAAI;CAG3D"}

package/lib/filter.js

@@ -0,0 +1,207 @@
+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.
+
+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 { UNREAD_THREAD_NOTIFICATIONS } from "./@types/sync.js";
+import { FilterComponent } from "./filter-component.js";
+/**
+ */
+function setProp(obj, keyNesting, val) {
+  var nestedKeys = keyNesting.split(".");
+  var currentObj = obj;
+  for (var i = 0; i < nestedKeys.length - 1; i++) {
+    if (!currentObj[nestedKeys[i]]) {
+      currentObj[nestedKeys[i]] = {};
+    }
+    currentObj = currentObj[nestedKeys[i]];
+  }
+  currentObj[nestedKeys[nestedKeys.length - 1]] = val;
+}
+
+/* eslint-disable camelcase */
+
+/* eslint-enable camelcase */
+
+export class Filter {
+  /**
+   * Create a filter from existing data.
+   */
+  static fromJson(userId, filterId, jsonObj) {
+    var filter = new Filter(userId, filterId);
+    filter.setDefinition(jsonObj);
+    return filter;
+  }
+  /**
+   * Construct a new Filter.
+   * @param userId - The user ID for this 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);
+  }
+
+  /**
+   * Get the ID of this filter on your homeserver (if known)
+   * @returns The filter ID
+   */
+  getFilterId() {
+    return this.filterId;
+  }
+
+  /**
+   * Get the JSON body of the filter.
+   * @returns The filter definition
+   */
+  getDefinition() {
+    return this.definition;
+  }
+
+  /**
+   * Set the JSON body of the filter
+   * @param definition - The filter definition
+   */
+  setDefinition(definition) {
+    this.definition = definition;
+
+    // This is all ported from synapse's FilterCollection()
+
+    // definitions look something like:
+    // {
+    //   "room": {
+    //     "rooms": ["!abcde:example.com"],
+    //     "not_rooms": ["!123456:example.com"],
+    //     "state": {
+    //       "types": ["m.room.*"],
+    //       "not_rooms": ["!726s6s6q:example.com"],
+    //       "lazy_load_members": true,
+    //     },
+    //     "timeline": {
+    //       "limit": 10,
+    //       "types": ["m.room.message"],
+    //       "not_rooms": ["!726s6s6q:example.com"],
+    //       "not_senders": ["@spam:example.com"]
+    //       "contains_url": true
+    //     },
+    //     "ephemeral": {
+    //       "types": ["m.receipt", "m.typing"],
+    //       "not_rooms": ["!726s6s6q:example.com"],
+    //       "not_senders": ["@spam:example.com"]
+    //     }
+    //   },
+    //   "presence": {
+    //     "types": ["m.presence"],
+    //     "not_senders": ["@alice:example.com"]
+    //   },
+    //   "event_format": "client",
+    //   "event_fields": ["type", "content", "sender"]
+    // }
+
+    var roomFilterJson = definition.room;
+
+    // consider the top level rooms/not_rooms filter
+    var roomFilterFields = {};
+    if (roomFilterJson) {
+      if (roomFilterJson.rooms) {
+        roomFilterFields.rooms = roomFilterJson.rooms;
+      }
+      if (roomFilterJson.rooms) {
+        roomFilterFields.not_rooms = roomFilterJson.not_rooms;
+      }
+    }
+    this.roomFilter = new FilterComponent(roomFilterFields, this.userId);
+    this.roomTimelineFilter = new FilterComponent((roomFilterJson === null || roomFilterJson === void 0 ? void 0 : roomFilterJson.timeline) || {}, this.userId);
+
+    // don't bother porting this from synapse yet:
+    // this._room_state_filter =
+    //     new FilterComponent(roomFilterJson.state || {});
+    // this._room_ephemeral_filter =
+    //     new FilterComponent(roomFilterJson.ephemeral || {});
+    // this._room_account_data_filter =
+    //     new FilterComponent(roomFilterJson.account_data || {});
+    // this._presence_filter =
+    //     new FilterComponent(definition.presence || {});
+    // this._account_data_filter =
+    //     new FilterComponent(definition.account_data || {});
+  }
+
+  /**
+   * Get the room.timeline filter component of the filter
+   * @returns room timeline filter component
+   */
+  getRoomTimelineFilterComponent() {
+    return this.roomTimelineFilter;
+  }
+
+  /**
+   * Filter the list of events based on whether they are allowed in a timeline
+   * based on this filter
+   * @param events -  the list of events being filtered
+   * @returns the list of events which match the filter
+   */
+  filterRoomTimeline(events) {
+    if (this.roomFilter) {
+      events = this.roomFilter.filter(events);
+    }
+    if (this.roomTimelineFilter) {
+      events = this.roomTimelineFilter.filter(events);
+    }
+    return events;
+  }
+
+  /**
+   * Set the max number of events to return for each room's timeline.
+   * @param limit - The max number of events to return for each room.
+   */
+  setTimelineLimit(limit) {
+    setProp(this.definition, "room.timeline.limit", limit);
+  }
+
+  /**
+   * 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), {}, {
+          [UNREAD_THREAD_NOTIFICATIONS.name]: enabled
+        })
+      })
+    });
+  }
+  setLazyLoadMembers(enabled) {
+    setProp(this.definition, "room.state.lazy_load_members", enabled);
+  }
+
+  /**
+   * Control whether left rooms should be included in responses.
+   * @param includeLeave - True to make rooms the user has left appear
+   * in responses.
+   */
+  setIncludeLeaveRooms(includeLeave) {
+    setProp(this.definition, "room.include_leave", includeLeave);
+  }
+}
+_defineProperty(Filter, "LAZY_LOADING_MESSAGES_FILTER", {
+  lazy_load_members: true
+});
+//# sourceMappingURL=filter.js.map

package/lib/filter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filter.js","names":["UNREAD_THREAD_NOTIFICATIONS","FilterComponent","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","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 { EventType, RelationType } from \"./@types/event.ts\";\nimport { UNREAD_THREAD_NOTIFICATIONS } from \"./@types/sync.ts\";\nimport { FilterComponent, IFilterComponent } from \"./filter-component.ts\";\nimport { MatrixEvent } from \"./models/event.ts\";\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}\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/* 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"],"mappings":";;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA,SAASA,2BAA2B,QAAQ,kBAAkB;AAC9D,SAASC,eAAe,QAA0B,uBAAuB;AAGzE;AACA;AACA,SAASC,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;;AAkCA;;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,IAAI3B,eAAe,CAACwB,gBAAgB,EAAE,IAAI,CAACZ,MAAM,CAAC;IACpE,IAAI,CAACgB,kBAAkB,GAAG,IAAI5B,eAAe,CAAC,CAAAsB,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,CAAC9B,2BAA2B,CAACyC,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;AACJ;AAACzB,eAAA,CA7KYR,MAAM,kCAC8B;EACzCkC,iBAAiB,EAAE;AACvB,CAAC","ignoreList":[]}

package/lib/http-api/errors.d.ts

@@ -0,0 +1,80 @@
+import { IMatrixApiError as IWidgetMatrixError } from "matrix-widget-api";
+import { IUsageLimit } from "../@types/partials.ts";
+import { MatrixEvent } from "../models/event.ts";
+interface IErrorJson extends Partial<IUsageLimit> {
+    [key: string]: any;
+    errcode?: string;
+    error?: string;
+}
+/**
+ * Construct a generic HTTP error. This is a JavaScript Error with additional information
+ * specific to HTTP responses.
+ * @param msg - The error message to include.
+ * @param httpStatus - The HTTP response status code.
+ * @param httpHeaders - The HTTP response headers.
+ */
+export declare class HTTPError extends Error {
+    readonly httpStatus?: number | undefined;
+    readonly httpHeaders?: Headers | undefined;
+    constructor(msg: string, httpStatus?: number | undefined, httpHeaders?: Headers | undefined);
+    /**
+     * Check if this error was due to rate-limiting on the server side (and should therefore be retried after a delay).
+     *
+     * If this returns `true`, {@link getRetryAfterMs} can be called to retrieve the server-side
+     * recommendation for the retry period.
+     *
+     * @returns Whether this error is due to rate-limiting.
+     */
+    isRateLimitError(): boolean;
+    /**
+     * @returns The recommended delay in milliseconds to wait before retrying
+     * the request that triggered this error, or null if no delay is recommended.
+     * @throws Error if the recommended delay is an invalid value.
+     * @see {@link safeGetRetryAfterMs} for a version of this check that doesn't throw.
+     */
+    getRetryAfterMs(): number | null;
+}
+export declare class MatrixError extends HTTPError {
+    url?: string | undefined;
+    event?: MatrixEvent | undefined;
+    readonly errcode?: string;
+    data: IErrorJson;
+    /**
+     * Construct a Matrix error. This is a JavaScript Error with additional
+     * information specific to the standard Matrix error response.
+     * @param errorJson - The Matrix error JSON returned from the homeserver.
+     * @param httpStatus - The numeric HTTP status code given
+     * @param httpHeaders - The HTTP response headers given
+     */
+    constructor(errorJson?: IErrorJson, httpStatus?: number, url?: string | undefined, event?: MatrixEvent | undefined, httpHeaders?: Headers);
+    isRateLimitError(): boolean;
+    getRetryAfterMs(): number | null;
+    /**
+     * @returns this error expressed as a JSON payload
+     * for use by Widget API error responses.
+     */
+    asWidgetApiErrorData(): IWidgetMatrixError;
+    /**
+     * @returns a new {@link MatrixError} from a JSON payload
+     * received from Widget API error responses.
+     */
+    static fromWidgetApiErrorData(data: IWidgetMatrixError): MatrixError;
+}
+/**
+ * @returns The recommended delay in milliseconds to wait before retrying
+ * the request that triggered {@link error}, or {@link defaultMs} if the
+ * error was not due to rate-limiting or if no valid delay is recommended.
+ */
+export declare function safeGetRetryAfterMs(error: unknown, defaultMs: number): number;
+/**
+ * Construct a ConnectionError. This is a JavaScript Error indicating
+ * that a request failed because of some error with the connection, either
+ * CORS was not correctly configured on the server, the server didn't response,
+ * the request timed out, or the internet connection on the client side went down.
+ */
+export declare class ConnectionError extends Error {
+    constructor(message: string, cause?: Error);
+    get name(): string;
+}
+export {};
+//# sourceMappingURL=errors.d.ts.map

package/lib/http-api/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/http-api/errors.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,eAAe,IAAI,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAE1E,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,UAAU,UAAW,SAAQ,OAAO,CAAC,WAAW,CAAC;IAC7C,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;GAMG;AACH,qBAAa,SAAU,SAAQ,KAAK;aAGZ,UAAU,CAAC,EAAE,MAAM;aACnB,WAAW,CAAC,EAAE,OAAO;gBAFrC,GAAG,EAAE,MAAM,EACK,UAAU,CAAC,EAAE,MAAM,YAAA,EACnB,WAAW,CAAC,EAAE,OAAO,YAAA;IAKzC;;;;;;;OAOG;IACI,gBAAgB,IAAI,OAAO;IAIlC;;;;;OAKG;IACI,eAAe,IAAI,MAAM,GAAG,IAAI;CAkB1C;AAED,qBAAa,WAAY,SAAQ,SAAS;IAgB3B,GAAG,CAAC,EAAE,MAAM;IACZ,KAAK,CAAC,EAAE,WAAW;IAf9B,SAAgB,OAAO,CAAC,EAAE,MAAM,CAAC;IAE1B,IAAI,EAAE,UAAU,CAAC;IAExB;;;;;;OAMG;gBAEC,SAAS,GAAE,UAAe,EAC1B,UAAU,CAAC,EAAE,MAAM,EACZ,GAAG,CAAC,EAAE,MAAM,YAAA,EACZ,KAAK,CAAC,EAAE,WAAW,YAAA,EAC1B,WAAW,CAAC,EAAE,OAAO;IAelB,gBAAgB,IAAI,OAAO;IAO3B,eAAe,IAAI,MAAM,GAAG,IAAI;IAevC;;;OAGG;IACI,oBAAoB,IAAI,kBAAkB;IAmBjD;;;OAGG;WACW,sBAAsB,CAAC,IAAI,EAAE,kBAAkB,GAAG,WAAW;CAG9E;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAS7E;AAED;;;;;GAKG;AACH,qBAAa,eAAgB,SAAQ,KAAK;gBACnB,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK;IAIjD,IAAW,IAAI,IAAI,MAAM,CAExB;CACJ"}

package/lib/http-api/errors.js

@@ -0,0 +1,185 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+/*
+Copyright 2022 - 2024 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.
+*/
+
+/**
+ * Construct a generic HTTP error. This is a JavaScript Error with additional information
+ * specific to HTTP responses.
+ * @param msg - The error message to include.
+ * @param httpStatus - The HTTP response status code.
+ * @param httpHeaders - The HTTP response headers.
+ */
+export class HTTPError extends Error {
+  constructor(msg, httpStatus, httpHeaders) {
+    super(msg);
+    this.httpStatus = httpStatus;
+    this.httpHeaders = httpHeaders;
+  }
+
+  /**
+   * Check if this error was due to rate-limiting on the server side (and should therefore be retried after a delay).
+   *
+   * If this returns `true`, {@link getRetryAfterMs} can be called to retrieve the server-side
+   * recommendation for the retry period.
+   *
+   * @returns Whether this error is due to rate-limiting.
+   */
+  isRateLimitError() {
+    return this.httpStatus === 429;
+  }
+
+  /**
+   * @returns The recommended delay in milliseconds to wait before retrying
+   * the request that triggered this error, or null if no delay is recommended.
+   * @throws Error if the recommended delay is an invalid value.
+   * @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");
+    if (retryAfter != null) {
+      if (/^\d+$/.test(retryAfter)) {
+        var 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);
+      if (date.toUTCString() !== retryAfter) {
+        throw new Error("Retry-After header value is not a valid HTTP-date or non-negative decimal integer");
+      }
+      return date.getTime() - Date.now();
+    }
+    return null;
+  }
+}
+export class MatrixError extends HTTPError {
+  /**
+   * Construct a Matrix error. This is a JavaScript Error with additional
+   * information specific to the standard Matrix error response.
+   * @param errorJson - The Matrix error JSON returned from the homeserver.
+   * @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";
+    if (httpStatus) {
+      message = "[".concat(httpStatus, "] ").concat(message);
+    }
+    if (url) {
+      message = "".concat(message, " (").concat(url, ")");
+    }
+    super("MatrixError: ".concat(message), httpStatus, httpHeaders);
+    this.url = url;
+    this.event = event;
+    // The Matrix 'errcode' value, e.g. "M_FORBIDDEN".
+    _defineProperty(this, "errcode", void 0);
+    // The raw Matrix error JSON used to construct this object.
+    _defineProperty(this, "data", void 0);
+    this.errcode = errorJson.errcode;
+    this.name = errorJson.errcode || "Unknown error code";
+    this.data = errorJson;
+  }
+  isRateLimitError() {
+    return this.errcode === "M_LIMIT_EXCEEDED" || (this.errcode === "M_UNKNOWN" || this.errcode === undefined) && super.isRateLimitError();
+  }
+  getRetryAfterMs() {
+    var headerValue = super.getRetryAfterMs();
+    if (headerValue !== null) {
+      return headerValue;
+    }
+    // Note: retry_after_ms is deprecated as of spec version v1.10
+    if (this.errcode === "M_LIMIT_EXCEEDED" && "retry_after_ms" in this.data) {
+      if (!Number.isInteger(this.data.retry_after_ms)) {
+        throw new Error("retry_after_ms is not an integer");
+      }
+      return this.data.retry_after_ms;
+    }
+    return null;
+  }
+
+  /**
+   * @returns this error expressed as a JSON payload
+   * for use by Widget API error responses.
+   */
+  asWidgetApiErrorData() {
+    var _this$httpStatus, _this$url, _this$errcode, _this$data$error;
+    var headers = {};
+    if (this.httpHeaders) {
+      for (var [name, value] of this.httpHeaders) {
+        headers[name] = value;
+      }
+    }
+    return {
+      http_status: (_this$httpStatus = this.httpStatus) !== null && _this$httpStatus !== void 0 ? _this$httpStatus : 400,
+      http_headers: headers,
+      url: (_this$url = this.url) !== null && _this$url !== void 0 ? _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"
+      }, this.data)
+    };
+  }
+
+  /**
+   * @returns a new {@link MatrixError} from a JSON payload
+   * received from Widget API error responses.
+   */
+  static fromWidgetApiErrorData(data) {
+    return new MatrixError(data.response, data.http_status, data.url, undefined, new Headers(data.http_headers));
+  }
+}
+
+/**
+ * @returns The recommended delay in milliseconds to wait before retrying
+ * the request that triggered {@link error}, or {@link defaultMs} if the
+ * error was not due to rate-limiting or if no valid delay is recommended.
+ */
+export function safeGetRetryAfterMs(error, defaultMs) {
+  if (!(error instanceof HTTPError) || !error.isRateLimitError()) {
+    return defaultMs;
+  }
+  try {
+    var _error$getRetryAfterM;
+    return (_error$getRetryAfterM = error.getRetryAfterMs()) !== null && _error$getRetryAfterM !== void 0 ? _error$getRetryAfterM : defaultMs;
+  } catch (_unused) {
+    return defaultMs;
+  }
+}
+
+/**
+ * Construct a ConnectionError. This is a JavaScript Error indicating
+ * that a request failed because of some error with the connection, either
+ * CORS was not correctly configured on the server, the server didn't response,
+ * the request timed out, or the internet connection on the client side went down.
+ */
+export class ConnectionError extends Error {
+  constructor(message, cause) {
+    super(message + (cause ? ": ".concat(cause.message) : ""));
+  }
+  get name() {
+    return "ConnectionError";
+  }
+}
+//# sourceMappingURL=errors.js.map