@unwanted/matrix-sdk-mini 34.12.0-1

package/lib/NamespacedValue.d.ts

@@ -0,0 +1,33 @@
+import { Optional } from "matrix-events-sdk/lib/types";
+/**
+ * Represents a simple Matrix namespaced value. This will assume that if a stable prefix
+ * is provided that the stable prefix should be used when representing the identifier.
+ */
+export declare class NamespacedValue<S extends string, U extends string> {
+    readonly stable?: (S | null) | undefined;
+    readonly unstable?: U | undefined;
+    constructor(stable: S, unstable: U);
+    constructor(stable: S, unstable?: U);
+    constructor(stable: null | undefined, unstable: U);
+    get name(): U | S;
+    get altName(): U | S | null | undefined;
+    get names(): (U | S)[];
+    matches(val: string): boolean;
+    findIn<T>(obj: any): Optional<T>;
+    includedIn(arr: any[]): boolean;
+}
+export declare class ServerControlledNamespacedValue<S extends string, U extends string> extends NamespacedValue<S, U> {
+    private preferUnstable;
+    setPreferUnstable(preferUnstable: boolean): void;
+    get name(): U | S;
+}
+/**
+ * Represents a namespaced value which prioritizes the unstable value over the stable
+ * value.
+ */
+export declare class UnstableValue<S extends string, U extends string> extends NamespacedValue<S, U> {
+    constructor(stable: S, unstable: U);
+    get name(): U;
+    get altName(): S;
+}
+//# sourceMappingURL=NamespacedValue.d.ts.map

package/lib/NamespacedValue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NamespacedValue.d.ts","sourceRoot":"","sources":["../src/NamespacedValue.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAEvD;;;GAGG;AACH,qBAAa,eAAe,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM;aAOvC,MAAM,CAAC,GAAE,CAAC,GAAG,IAAI;aACjB,QAAQ,CAAC,EAAE,CAAC;gBALb,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC;gBACtB,MAAM,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,CAAC;gBACvB,MAAM,EAAE,IAAI,GAAG,SAAS,EAAE,QAAQ,EAAE,CAAC;IAUxD,IAAW,IAAI,IAAI,CAAC,GAAG,CAAC,CAKvB;IAED,IAAW,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,SAAS,CAK7C;IAED,IAAW,KAAK,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAK5B;IAEM,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAM7B,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,GAAG,QAAQ,CAAC,CAAC,CAAC;IAWhC,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,OAAO;CAUzC;AAED,qBAAa,+BAA+B,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,CAAE,SAAQ,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC;IAC1G,OAAO,CAAC,cAAc,CAAS;IAExB,iBAAiB,CAAC,cAAc,EAAE,OAAO,GAAG,IAAI;IAIvD,IAAW,IAAI,IAAI,CAAC,GAAG,CAAC,CAKvB;CACJ;AAED;;;GAGG;AACH,qBAAa,aAAa,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,CAAE,SAAQ,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC;gBAErE,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC;IAOzC,IAAW,IAAI,IAAI,CAAC,CAEnB;IAED,IAAW,OAAO,IAAI,CAAC,CAEtB;CACJ"}

package/lib/NamespacedValue.js

@@ -0,0 +1,113 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+/*
+Copyright 2021 - 2022 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+/**
+ * Represents a simple Matrix namespaced value. This will assume that if a stable prefix
+ * is provided that the stable prefix should be used when representing the identifier.
+ */
+export class NamespacedValue {
+  // Stable is optional, but one of the two parameters is required, hence the weird-looking types.
+  // Goal is to to have developers explicitly say there is no stable value (if applicable).
+
+  constructor(stable, unstable) {
+    this.stable = stable;
+    this.unstable = unstable;
+    if (!this.unstable && !this.stable) {
+      throw new Error("One of stable or unstable values must be supplied");
+    }
+  }
+  get name() {
+    if (this.stable) {
+      return this.stable;
+    }
+    return this.unstable;
+  }
+  get altName() {
+    if (!this.stable) {
+      return null;
+    }
+    return this.unstable;
+  }
+  get names() {
+    var names = [this.name];
+    var altName = this.altName;
+    if (altName) names.push(altName);
+    return names;
+  }
+  matches(val) {
+    return this.name === val || this.altName === val;
+  }
+
+  // this desperately wants https://github.com/microsoft/TypeScript/pull/26349 at the top level of the class
+  // so we can instantiate `NamespacedValue<string, _, _>` as a default type for that namespace.
+  findIn(obj) {
+    var val = undefined;
+    if (this.name) {
+      val = obj === null || obj === void 0 ? void 0 : obj[this.name];
+    }
+    if (!val && this.altName) {
+      val = obj === null || obj === void 0 ? void 0 : obj[this.altName];
+    }
+    return val;
+  }
+  includedIn(arr) {
+    var included = false;
+    if (this.name) {
+      included = arr.includes(this.name);
+    }
+    if (!included && this.altName) {
+      included = arr.includes(this.altName);
+    }
+    return included;
+  }
+}
+export class ServerControlledNamespacedValue extends NamespacedValue {
+  constructor() {
+    super(...arguments);
+    _defineProperty(this, "preferUnstable", false);
+  }
+  setPreferUnstable(preferUnstable) {
+    this.preferUnstable = preferUnstable;
+  }
+  get name() {
+    if (this.stable && !this.preferUnstable) {
+      return this.stable;
+    }
+    return this.unstable;
+  }
+}
+
+/**
+ * Represents a namespaced value which prioritizes the unstable value over the stable
+ * value.
+ */
+export class UnstableValue extends NamespacedValue {
+  // Note: Constructor difference is that `unstable` is *required*.
+  constructor(stable, unstable) {
+    super(stable, unstable);
+    if (!this.unstable) {
+      throw new Error("Unstable value must be supplied");
+    }
+  }
+  get name() {
+    return this.unstable;
+  }
+  get altName() {
+    return this.stable;
+  }
+}
+//# sourceMappingURL=NamespacedValue.js.map

package/lib/NamespacedValue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NamespacedValue.js","names":["NamespacedValue","constructor","stable","unstable","Error","name","altName","names","push","matches","val","findIn","obj","undefined","includedIn","arr","included","includes","ServerControlledNamespacedValue","arguments","_defineProperty","setPreferUnstable","preferUnstable","UnstableValue"],"sources":["../src/NamespacedValue.ts"],"sourcesContent":["/*\nCopyright 2021 - 2022 The Matrix.org Foundation C.I.C.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\nimport { Optional } from \"matrix-events-sdk/lib/types\";\n\n/**\n * Represents a simple Matrix namespaced value. This will assume that if a stable prefix\n * is provided that the stable prefix should be used when representing the identifier.\n */\nexport class NamespacedValue<S extends string, U extends string> {\n    // Stable is optional, but one of the two parameters is required, hence the weird-looking types.\n    // Goal is to to have developers explicitly say there is no stable value (if applicable).\n    public constructor(stable: S, unstable: U);\n    public constructor(stable: S, unstable?: U);\n    public constructor(stable: null | undefined, unstable: U);\n    public constructor(\n        public readonly stable?: S | null,\n        public readonly unstable?: U,\n    ) {\n        if (!this.unstable && !this.stable) {\n            throw new Error(\"One of stable or unstable values must be supplied\");\n        }\n    }\n\n    public get name(): U | S {\n        if (this.stable) {\n            return this.stable;\n        }\n        return this.unstable!;\n    }\n\n    public get altName(): U | S | null | undefined {\n        if (!this.stable) {\n            return null;\n        }\n        return this.unstable;\n    }\n\n    public get names(): (U | S)[] {\n        const names = [this.name];\n        const altName = this.altName;\n        if (altName) names.push(altName);\n        return names;\n    }\n\n    public matches(val: string): boolean {\n        return this.name === val || this.altName === val;\n    }\n\n    // this desperately wants https://github.com/microsoft/TypeScript/pull/26349 at the top level of the class\n    // so we can instantiate `NamespacedValue<string, _, _>` as a default type for that namespace.\n    public findIn<T>(obj: any): Optional<T> {\n        let val: T | undefined = undefined;\n        if (this.name) {\n            val = obj?.[this.name];\n        }\n        if (!val && this.altName) {\n            val = obj?.[this.altName];\n        }\n        return val;\n    }\n\n    public includedIn(arr: any[]): boolean {\n        let included = false;\n        if (this.name) {\n            included = arr.includes(this.name);\n        }\n        if (!included && this.altName) {\n            included = arr.includes(this.altName);\n        }\n        return included;\n    }\n}\n\nexport class ServerControlledNamespacedValue<S extends string, U extends string> extends NamespacedValue<S, U> {\n    private preferUnstable = false;\n\n    public setPreferUnstable(preferUnstable: boolean): void {\n        this.preferUnstable = preferUnstable;\n    }\n\n    public get name(): U | S {\n        if (this.stable && !this.preferUnstable) {\n            return this.stable;\n        }\n        return this.unstable!;\n    }\n}\n\n/**\n * Represents a namespaced value which prioritizes the unstable value over the stable\n * value.\n */\nexport class UnstableValue<S extends string, U extends string> extends NamespacedValue<S, U> {\n    // Note: Constructor difference is that `unstable` is *required*.\n    public constructor(stable: S, unstable: U) {\n        super(stable, unstable);\n        if (!this.unstable) {\n            throw new Error(\"Unstable value must be supplied\");\n        }\n    }\n\n    public get name(): U {\n        return this.unstable!;\n    }\n\n    public get altName(): S {\n        return this.stable!;\n    }\n}\n"],"mappings":";AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAIA;AACA;AACA;AACA;AACA,OAAO,MAAMA,eAAe,CAAqC;EAC7D;EACA;;EAIOC,WAAWA,CACEC,MAAiB,EACjBC,QAAY,EAC9B;IAAA,KAFkBD,MAAiB,GAAjBA,MAAiB;IAAA,KACjBC,QAAY,GAAZA,QAAY;IAE5B,IAAI,CAAC,IAAI,CAACA,QAAQ,IAAI,CAAC,IAAI,CAACD,MAAM,EAAE;MAChC,MAAM,IAAIE,KAAK,CAAC,mDAAmD,CAAC;IACxE;EACJ;EAEA,IAAWC,IAAIA,CAAA,EAAU;IACrB,IAAI,IAAI,CAACH,MAAM,EAAE;MACb,OAAO,IAAI,CAACA,MAAM;IACtB;IACA,OAAO,IAAI,CAACC,QAAQ;EACxB;EAEA,IAAWG,OAAOA,CAAA,EAA6B;IAC3C,IAAI,CAAC,IAAI,CAACJ,MAAM,EAAE;MACd,OAAO,IAAI;IACf;IACA,OAAO,IAAI,CAACC,QAAQ;EACxB;EAEA,IAAWI,KAAKA,CAAA,EAAc;IAC1B,IAAMA,KAAK,GAAG,CAAC,IAAI,CAACF,IAAI,CAAC;IACzB,IAAMC,OAAO,GAAG,IAAI,CAACA,OAAO;IAC5B,IAAIA,OAAO,EAAEC,KAAK,CAACC,IAAI,CAACF,OAAO,CAAC;IAChC,OAAOC,KAAK;EAChB;EAEOE,OAAOA,CAACC,GAAW,EAAW;IACjC,OAAO,IAAI,CAACL,IAAI,KAAKK,GAAG,IAAI,IAAI,CAACJ,OAAO,KAAKI,GAAG;EACpD;;EAEA;EACA;EACOC,MAAMA,CAAIC,GAAQ,EAAe;IACpC,IAAIF,GAAkB,GAAGG,SAAS;IAClC,IAAI,IAAI,CAACR,IAAI,EAAE;MACXK,GAAG,GAAGE,GAAG,aAAHA,GAAG,uBAAHA,GAAG,CAAG,IAAI,CAACP,IAAI,CAAC;IAC1B;IACA,IAAI,CAACK,GAAG,IAAI,IAAI,CAACJ,OAAO,EAAE;MACtBI,GAAG,GAAGE,GAAG,aAAHA,GAAG,uBAAHA,GAAG,CAAG,IAAI,CAACN,OAAO,CAAC;IAC7B;IACA,OAAOI,GAAG;EACd;EAEOI,UAAUA,CAACC,GAAU,EAAW;IACnC,IAAIC,QAAQ,GAAG,KAAK;IACpB,IAAI,IAAI,CAACX,IAAI,EAAE;MACXW,QAAQ,GAAGD,GAAG,CAACE,QAAQ,CAAC,IAAI,CAACZ,IAAI,CAAC;IACtC;IACA,IAAI,CAACW,QAAQ,IAAI,IAAI,CAACV,OAAO,EAAE;MAC3BU,QAAQ,GAAGD,GAAG,CAACE,QAAQ,CAAC,IAAI,CAACX,OAAO,CAAC;IACzC;IACA,OAAOU,QAAQ;EACnB;AACJ;AAEA,OAAO,MAAME,+BAA+B,SAA6ClB,eAAe,CAAO;EAAAC,YAAA;IAAA,SAAAkB,SAAA;IAAAC,eAAA,yBAClF,KAAK;EAAA;EAEvBC,iBAAiBA,CAACC,cAAuB,EAAQ;IACpD,IAAI,CAACA,cAAc,GAAGA,cAAc;EACxC;EAEA,IAAWjB,IAAIA,CAAA,EAAU;IACrB,IAAI,IAAI,CAACH,MAAM,IAAI,CAAC,IAAI,CAACoB,cAAc,EAAE;MACrC,OAAO,IAAI,CAACpB,MAAM;IACtB;IACA,OAAO,IAAI,CAACC,QAAQ;EACxB;AACJ;;AAEA;AACA;AACA;AACA;AACA,OAAO,MAAMoB,aAAa,SAA6CvB,eAAe,CAAO;EACzF;EACOC,WAAWA,CAACC,MAAS,EAAEC,QAAW,EAAE;IACvC,KAAK,CAACD,MAAM,EAAEC,QAAQ,CAAC;IACvB,IAAI,CAAC,IAAI,CAACA,QAAQ,EAAE;MAChB,MAAM,IAAIC,KAAK,CAAC,iCAAiC,CAAC;IACtD;EACJ;EAEA,IAAWC,IAAIA,CAAA,EAAM;IACjB,OAAO,IAAI,CAACF,QAAQ;EACxB;EAEA,IAAWG,OAAOA,CAAA,EAAM;IACpB,OAAO,IAAI,CAACJ,MAAM;EACtB;AACJ","ignoreList":[]}

package/lib/ReEmitter.d.ts

@@ -0,0 +1,15 @@
+import { EventEmitter } from "events";
+import { ListenerMap, TypedEventEmitter } from "./models/typed-event-emitter.ts";
+export declare class ReEmitter {
+    private readonly target;
+    constructor(target: EventEmitter);
+    private reEmitters;
+    reEmit(source: EventEmitter, eventNames: string[]): void;
+    stopReEmitting(source: EventEmitter, eventNames: string[]): void;
+}
+export declare class TypedReEmitter<Events extends string, Arguments extends ListenerMap<Events>> extends ReEmitter {
+    constructor(target: TypedEventEmitter<Events, Arguments>);
+    reEmit<ReEmittedEvents extends string, T extends Events & ReEmittedEvents>(source: TypedEventEmitter<ReEmittedEvents, any>, eventNames: T[]): void;
+    stopReEmitting<ReEmittedEvents extends string, T extends Events & ReEmittedEvents>(source: TypedEventEmitter<ReEmittedEvents, any>, eventNames: T[]): void;
+}
+//# sourceMappingURL=ReEmitter.d.ts.map

package/lib/ReEmitter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReEmitter.d.ts","sourceRoot":"","sources":["../src/ReEmitter.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAEtC,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AAEjF,qBAAa,SAAS;IACC,OAAO,CAAC,QAAQ,CAAC,MAAM;gBAAN,MAAM,EAAE,YAAY;IAGxD,OAAO,CAAC,UAAU,CAAsE;IAEjF,MAAM,CAAC,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,IAAI;IAgCxD,cAAc,CAAC,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,IAAI;CAW1E;AAED,qBAAa,cAAc,CAAC,MAAM,SAAS,MAAM,EAAE,SAAS,SAAS,WAAW,CAAC,MAAM,CAAC,CAAE,SAAQ,SAAS;gBACpF,MAAM,EAAE,iBAAiB,CAAC,MAAM,EAAE,SAAS,CAAC;IAIxD,MAAM,CAAC,eAAe,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,GAAG,eAAe,EAC5E,MAAM,EAAE,iBAAiB,CAAC,eAAe,EAAE,GAAG,CAAC,EAC/C,UAAU,EAAE,CAAC,EAAE,GAChB,IAAI;IAIA,cAAc,CAAC,eAAe,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,GAAG,eAAe,EACpF,MAAM,EAAE,iBAAiB,CAAC,eAAe,EAAE,GAAG,CAAC,EAC/C,UAAU,EAAE,CAAC,EAAE,GAChB,IAAI;CAGV"}

package/lib/ReEmitter.js

@@ -0,0 +1,87 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+/*
+Copyright 2015, 2016 OpenMarket Ltd
+Copyright 2017 Vector Creations Ltd
+Copyright 2017 New Vector Ltd
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// eslint-disable-next-line no-restricted-imports
+
+export class ReEmitter {
+  constructor(target) {
+    this.target = target;
+    // Map from emitter to event name to re-emitter
+    _defineProperty(this, "reEmitters", new WeakMap());
+  }
+  reEmit(source, eventNames) {
+    var _this = this;
+    var reEmittersByEvent = this.reEmitters.get(source);
+    if (!reEmittersByEvent) {
+      reEmittersByEvent = new Map();
+      this.reEmitters.set(source, reEmittersByEvent);
+    }
+    var _loop = function _loop(eventName) {
+      if (reEmittersByEvent.has(eventName)) return 1; // continue
+
+      // We include the source as the last argument for event handlers which may need it,
+      // such as read receipt listeners on the client class which won't have the context
+      // of the room.
+      var forSource = function forSource() {
+        // EventEmitter special cases 'error' to make the emit function throw if no
+        // handler is attached, which sort of makes sense for making sure that something
+        // handles an error, but for re-emitting, there could be a listener on the original
+        // source object so the test doesn't really work. We *could* try to replicate the
+        // same logic and throw if there is no listener on either the source or the target,
+        // but this behaviour is fairly undesireable for us anyway: the main place we throw
+        // 'error' events is for calls, where error events are usually emitted some time
+        // later by a different part of the code where 'emit' throwing because the app hasn't
+        // added an error handler isn't terribly helpful. (A better fix in retrospect may
+        // have been to just avoid using the event name 'error', but backwards compat...)
+        if (eventName === "error" && _this.target.listenerCount("error") === 0) return;
+        for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+          args[_key] = arguments[_key];
+        }
+        _this.target.emit(eventName, ...args, source);
+      };
+      source.on(eventName, forSource);
+      reEmittersByEvent.set(eventName, forSource);
+    };
+    for (var eventName of eventNames) {
+      if (_loop(eventName)) continue;
+    }
+  }
+  stopReEmitting(source, eventNames) {
+    var reEmittersByEvent = this.reEmitters.get(source);
+    if (!reEmittersByEvent) return; // We were never re-emitting these events in the first place
+
+    for (var eventName of eventNames) {
+      source.off(eventName, reEmittersByEvent.get(eventName));
+      reEmittersByEvent.delete(eventName);
+    }
+    if (reEmittersByEvent.size === 0) this.reEmitters.delete(source);
+  }
+}
+export class TypedReEmitter extends ReEmitter {
+  constructor(target) {
+    super(target);
+  }
+  reEmit(source, eventNames) {
+    super.reEmit(source, eventNames);
+  }
+  stopReEmitting(source, eventNames) {
+    super.stopReEmitting(source, eventNames);
+  }
+}
+//# sourceMappingURL=ReEmitter.js.map

package/lib/ReEmitter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReEmitter.js","names":["ReEmitter","constructor","target","_defineProperty","WeakMap","reEmit","source","eventNames","_this","reEmittersByEvent","reEmitters","get","Map","set","_loop","eventName","has","forSource","listenerCount","_len","arguments","length","args","Array","_key","emit","on","stopReEmitting","off","delete","size","TypedReEmitter"],"sources":["../src/ReEmitter.ts"],"sourcesContent":["/*\nCopyright 2015, 2016 OpenMarket Ltd\nCopyright 2017 Vector Creations Ltd\nCopyright 2017 New Vector Ltd\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\n// eslint-disable-next-line no-restricted-imports\nimport { EventEmitter } from \"events\";\n\nimport { ListenerMap, TypedEventEmitter } from \"./models/typed-event-emitter.ts\";\n\nexport class ReEmitter {\n    public constructor(private readonly target: EventEmitter) {}\n\n    // Map from emitter to event name to re-emitter\n    private reEmitters = new WeakMap<EventEmitter, Map<string, (...args: any[]) => void>>();\n\n    public reEmit(source: EventEmitter, eventNames: string[]): void {\n        let reEmittersByEvent = this.reEmitters.get(source);\n        if (!reEmittersByEvent) {\n            reEmittersByEvent = new Map();\n            this.reEmitters.set(source, reEmittersByEvent);\n        }\n\n        for (const eventName of eventNames) {\n            if (reEmittersByEvent.has(eventName)) continue;\n\n            // We include the source as the last argument for event handlers which may need it,\n            // such as read receipt listeners on the client class which won't have the context\n            // of the room.\n            const forSource = (...args: any[]): void => {\n                // EventEmitter special cases 'error' to make the emit function throw if no\n                // handler is attached, which sort of makes sense for making sure that something\n                // handles an error, but for re-emitting, there could be a listener on the original\n                // source object so the test doesn't really work. We *could* try to replicate the\n                // same logic and throw if there is no listener on either the source or the target,\n                // but this behaviour is fairly undesireable for us anyway: the main place we throw\n                // 'error' events is for calls, where error events are usually emitted some time\n                // later by a different part of the code where 'emit' throwing because the app hasn't\n                // added an error handler isn't terribly helpful. (A better fix in retrospect may\n                // have been to just avoid using the event name 'error', but backwards compat...)\n                if (eventName === \"error\" && this.target.listenerCount(\"error\") === 0) return;\n                this.target.emit(eventName, ...args, source);\n            };\n            source.on(eventName, forSource);\n            reEmittersByEvent.set(eventName, forSource);\n        }\n    }\n\n    public stopReEmitting(source: EventEmitter, eventNames: string[]): void {\n        const reEmittersByEvent = this.reEmitters.get(source);\n        if (!reEmittersByEvent) return; // We were never re-emitting these events in the first place\n\n        for (const eventName of eventNames) {\n            source.off(eventName, reEmittersByEvent.get(eventName)!);\n            reEmittersByEvent.delete(eventName);\n        }\n\n        if (reEmittersByEvent.size === 0) this.reEmitters.delete(source);\n    }\n}\n\nexport class TypedReEmitter<Events extends string, Arguments extends ListenerMap<Events>> extends ReEmitter {\n    public constructor(target: TypedEventEmitter<Events, Arguments>) {\n        super(target);\n    }\n\n    public reEmit<ReEmittedEvents extends string, T extends Events & ReEmittedEvents>(\n        source: TypedEventEmitter<ReEmittedEvents, any>,\n        eventNames: T[],\n    ): void {\n        super.reEmit(source, eventNames);\n    }\n\n    public stopReEmitting<ReEmittedEvents extends string, T extends Events & ReEmittedEvents>(\n        source: TypedEventEmitter<ReEmittedEvents, any>,\n        eventNames: T[],\n    ): void {\n        super.stopReEmitting(source, eventNames);\n    }\n}\n"],"mappings":";AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;;AAKA,OAAO,MAAMA,SAAS,CAAC;EACZC,WAAWA,CAAkBC,MAAoB,EAAE;IAAA,KAAtBA,MAAoB,GAApBA,MAAoB;IAExD;IAAAC,eAAA,qBACqB,IAAIC,OAAO,CAAsD,CAAC;EAH5B;EAKpDC,MAAMA,CAACC,MAAoB,EAAEC,UAAoB,EAAQ;IAAA,IAAAC,KAAA;IAC5D,IAAIC,iBAAiB,GAAG,IAAI,CAACC,UAAU,CAACC,GAAG,CAACL,MAAM,CAAC;IACnD,IAAI,CAACG,iBAAiB,EAAE;MACpBA,iBAAiB,GAAG,IAAIG,GAAG,CAAC,CAAC;MAC7B,IAAI,CAACF,UAAU,CAACG,GAAG,CAACP,MAAM,EAAEG,iBAAiB,CAAC;IAClD;IAAC,IAAAK,KAAA,YAAAA,MAAAC,SAAA,EAEmC;MAChC,IAAIN,iBAAiB,CAACO,GAAG,CAACD,SAAS,CAAC;;MAEpC;MACA;MACA;MACA,IAAME,SAAS,GAAG,SAAZA,SAASA,CAAA,EAA6B;QACxC;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA,IAAIF,SAAS,KAAK,OAAO,IAAIP,KAAI,CAACN,MAAM,CAACgB,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QAAO,SAAAC,IAAA,GAAAC,SAAA,CAAAC,MAAA,EAX5DC,IAAI,OAAAC,KAAA,CAAAJ,IAAA,GAAAK,IAAA,MAAAA,IAAA,GAAAL,IAAA,EAAAK,IAAA;UAAJF,IAAI,CAAAE,IAAA,IAAAJ,SAAA,CAAAI,IAAA;QAAA;QAYtBhB,KAAI,CAACN,MAAM,CAACuB,IAAI,CAACV,SAAS,EAAE,GAAGO,IAAI,EAAEhB,MAAM,CAAC;MAChD,CAAC;MACDA,MAAM,CAACoB,EAAE,CAACX,SAAS,EAAEE,SAAS,CAAC;MAC/BR,iBAAiB,CAACI,GAAG,CAACE,SAAS,EAAEE,SAAS,CAAC;IAC/C,CAAC;IAtBD,KAAK,IAAMF,SAAS,IAAIR,UAAU;MAAA,IAAAO,KAAA,CAAAC,SAAA,GACQ;IAAS;EAsBvD;EAEOY,cAAcA,CAACrB,MAAoB,EAAEC,UAAoB,EAAQ;IACpE,IAAME,iBAAiB,GAAG,IAAI,CAACC,UAAU,CAACC,GAAG,CAACL,MAAM,CAAC;IACrD,IAAI,CAACG,iBAAiB,EAAE,OAAO,CAAC;;IAEhC,KAAK,IAAMM,SAAS,IAAIR,UAAU,EAAE;MAChCD,MAAM,CAACsB,GAAG,CAACb,SAAS,EAAEN,iBAAiB,CAACE,GAAG,CAACI,SAAS,CAAE,CAAC;MACxDN,iBAAiB,CAACoB,MAAM,CAACd,SAAS,CAAC;IACvC;IAEA,IAAIN,iBAAiB,CAACqB,IAAI,KAAK,CAAC,EAAE,IAAI,CAACpB,UAAU,CAACmB,MAAM,CAACvB,MAAM,CAAC;EACpE;AACJ;AAEA,OAAO,MAAMyB,cAAc,SAAuE/B,SAAS,CAAC;EACjGC,WAAWA,CAACC,MAA4C,EAAE;IAC7D,KAAK,CAACA,MAAM,CAAC;EACjB;EAEOG,MAAMA,CACTC,MAA+C,EAC/CC,UAAe,EACX;IACJ,KAAK,CAACF,MAAM,CAACC,MAAM,EAAEC,UAAU,CAAC;EACpC;EAEOoB,cAAcA,CACjBrB,MAA+C,EAC/CC,UAAe,EACX;IACJ,KAAK,CAACoB,cAAc,CAACrB,MAAM,EAAEC,UAAU,CAAC;EAC5C;AACJ","ignoreList":[]}

package/lib/ToDeviceMessageQueue.d.ts

@@ -0,0 +1,28 @@
+import { MatrixClient } from "./client.ts";
+import { ToDeviceBatch } from "./models/ToDeviceMessage.ts";
+/**
+ * Maintains a queue of outgoing to-device messages, sending them
+ * as soon as the homeserver is reachable.
+ */
+export declare class ToDeviceMessageQueue {
+    private client;
+    private sending;
+    private running;
+    private retryTimeout;
+    private retryAttempts;
+    constructor(client: MatrixClient);
+    start(): void;
+    stop(): void;
+    queueBatch(batch: ToDeviceBatch): Promise<void>;
+    sendQueue: () => Promise<void>;
+    /**
+     * Attempts to send a batch of to-device messages.
+     */
+    private sendBatch;
+    /**
+     * Listen to sync state changes and automatically resend any pending events
+     * once syncing is resumed
+     */
+    private onResumedSync;
+}
+//# sourceMappingURL=ToDeviceMessageQueue.d.ts.map

package/lib/ToDeviceMessageQueue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ToDeviceMessageQueue.d.ts","sourceRoot":"","sources":["../src/ToDeviceMessageQueue.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,YAAY,EAAe,MAAM,aAAa,CAAC;AAExD,OAAO,EAEH,aAAa,EAGhB,MAAM,6BAA6B,CAAC;AAOrC;;;GAGG;AACH,qBAAa,oBAAoB;IAMV,OAAO,CAAC,MAAM;IALjC,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,OAAO,CAAQ;IACvB,OAAO,CAAC,YAAY,CAA8C;IAClE,OAAO,CAAC,aAAa,CAAK;gBAEC,MAAM,EAAE,YAAY;IAExC,KAAK,IAAI,IAAI;IAMb,IAAI,IAAI,IAAI;IAON,UAAU,CAAC,KAAK,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBrD,SAAS,QAAa,OAAO,CAAC,IAAI,CAAC,CA6CxC;IAEF;;OAEG;YACW,SAAS;IAavB;;;OAGG;IACH,OAAO,CAAC,aAAa,CAKnB;CACL"}

package/lib/ToDeviceMessageQueue.js

@@ -0,0 +1,135 @@
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+/*
+Copyright 2022 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import { ToDeviceMessageId } from "./@types/event.js";
+import { logger } from "./logger.js";
+import { ClientEvent } from "./client.js";
+import { MatrixScheduler } from "./scheduler.js";
+import { SyncState } from "./sync.js";
+import { MapWithDefault } from "./utils.js";
+var MAX_BATCH_SIZE = 20;
+
+/**
+ * Maintains a queue of outgoing to-device messages, sending them
+ * as soon as the homeserver is reachable.
+ */
+export class ToDeviceMessageQueue {
+  constructor(client) {
+    var _this = this;
+    this.client = client;
+    _defineProperty(this, "sending", false);
+    _defineProperty(this, "running", true);
+    _defineProperty(this, "retryTimeout", null);
+    _defineProperty(this, "retryAttempts", 0);
+    _defineProperty(this, "sendQueue", /*#__PURE__*/_asyncToGenerator(function* () {
+      if (_this.retryTimeout !== null) clearTimeout(_this.retryTimeout);
+      _this.retryTimeout = null;
+      if (_this.sending || !_this.running) return;
+      logger.debug("Attempting to send queued to-device messages");
+      _this.sending = true;
+      var headBatch;
+      try {
+        while (_this.running) {
+          headBatch = yield _this.client.store.getOldestToDeviceBatch();
+          if (headBatch === null) break;
+          yield _this.sendBatch(headBatch);
+          yield _this.client.store.removeToDeviceBatch(headBatch.id);
+          _this.retryAttempts = 0;
+        }
+
+        // Make sure we're still running after the async tasks: if not, stop.
+        if (!_this.running) return;
+        logger.debug("All queued to-device messages sent");
+      } catch (e) {
+        ++_this.retryAttempts;
+        // eslint-disable-next-line @typescript-eslint/naming-convention
+        // eslint-disable-next-line new-cap
+        var retryDelay = MatrixScheduler.RETRY_BACKOFF_RATELIMIT(null, _this.retryAttempts, e);
+        if (retryDelay === -1) {
+          // the scheduler function doesn't differentiate between fatal errors and just getting
+          // bored and giving up for now
+          if (Math.floor(e.httpStatus / 100) === 4) {
+            logger.error("Fatal error when sending to-device message - dropping to-device batch!", e);
+            yield _this.client.store.removeToDeviceBatch(headBatch.id);
+          } else {
+            logger.info("Automatic retry limit reached for to-device messages.");
+          }
+          return;
+        }
+        logger.info("Failed to send batch of to-device messages. Will retry in ".concat(retryDelay, "ms"), e);
+        _this.retryTimeout = setTimeout(_this.sendQueue, retryDelay);
+      } finally {
+        _this.sending = false;
+      }
+    }));
+    /**
+     * Listen to sync state changes and automatically resend any pending events
+     * once syncing is resumed
+     */
+    _defineProperty(this, "onResumedSync", (state, oldState) => {
+      if (state === SyncState.Syncing && oldState !== SyncState.Syncing) {
+        logger.info("Resuming queue after resumed sync");
+        this.sendQueue();
+      }
+    });
+  }
+  start() {
+    this.running = true;
+    this.sendQueue();
+    this.client.on(ClientEvent.Sync, this.onResumedSync);
+  }
+  stop() {
+    this.running = false;
+    if (this.retryTimeout !== null) clearTimeout(this.retryTimeout);
+    this.retryTimeout = null;
+    this.client.removeListener(ClientEvent.Sync, this.onResumedSync);
+  }
+  queueBatch(batch) {
+    var _this2 = this;
+    return _asyncToGenerator(function* () {
+      var batches = [];
+      for (var i = 0; i < batch.batch.length; i += MAX_BATCH_SIZE) {
+        var batchWithTxnId = {
+          eventType: batch.eventType,
+          batch: batch.batch.slice(i, i + MAX_BATCH_SIZE),
+          txnId: _this2.client.makeTxnId()
+        };
+        batches.push(batchWithTxnId);
+        var msgmap = batchWithTxnId.batch.map(msg => "".concat(msg.userId, "/").concat(msg.deviceId, " (msgid ").concat(msg.payload[ToDeviceMessageId], ")"));
+        logger.info("Enqueuing batch of to-device messages. type=".concat(batch.eventType, " txnid=").concat(batchWithTxnId.txnId), msgmap);
+      }
+      yield _this2.client.store.saveToDeviceBatches(batches);
+      _this2.sendQueue();
+    })();
+  }
+  /**
+   * Attempts to send a batch of to-device messages.
+   */
+  sendBatch(batch) {
+    var _this3 = this;
+    return _asyncToGenerator(function* () {
+      var contentMap = new MapWithDefault(() => new Map());
+      for (var item of batch.batch) {
+        contentMap.getOrCreate(item.userId).set(item.deviceId, item.payload);
+      }
+      logger.info("Sending batch of ".concat(batch.batch.length, " to-device messages with ID ").concat(batch.id, " and txnId ").concat(batch.txnId));
+      yield _this3.client.sendToDevice(batch.eventType, contentMap, batch.txnId);
+    })();
+  }
+}
+//# sourceMappingURL=ToDeviceMessageQueue.js.map

package/lib/ToDeviceMessageQueue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ToDeviceMessageQueue.js","names":["ToDeviceMessageId","logger","ClientEvent","MatrixScheduler","SyncState","MapWithDefault","MAX_BATCH_SIZE","ToDeviceMessageQueue","constructor","client","_this","_defineProperty","_asyncToGenerator","retryTimeout","clearTimeout","sending","running","debug","headBatch","store","getOldestToDeviceBatch","sendBatch","removeToDeviceBatch","id","retryAttempts","e","retryDelay","RETRY_BACKOFF_RATELIMIT","Math","floor","httpStatus","error","info","concat","setTimeout","sendQueue","state","oldState","Syncing","start","on","Sync","onResumedSync","stop","removeListener","queueBatch","batch","_this2","batches","i","length","batchWithTxnId","eventType","slice","txnId","makeTxnId","push","msgmap","map","msg","userId","deviceId","payload","saveToDeviceBatches","_this3","contentMap","Map","item","getOrCreate","set","sendToDevice"],"sources":["../src/ToDeviceMessageQueue.ts"],"sourcesContent":["/*\nCopyright 2022 The Matrix.org Foundation C.I.C.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\nimport { ToDeviceMessageId } from \"./@types/event.ts\";\nimport { logger } from \"./logger.ts\";\nimport { MatrixClient, ClientEvent } from \"./client.ts\";\nimport { MatrixError } from \"./http-api/index.ts\";\nimport {\n    IndexedToDeviceBatch,\n    ToDeviceBatch,\n    ToDeviceBatchWithTxnId,\n    ToDevicePayload,\n} from \"./models/ToDeviceMessage.ts\";\nimport { MatrixScheduler } from \"./scheduler.ts\";\nimport { SyncState } from \"./sync.ts\";\nimport { MapWithDefault } from \"./utils.ts\";\n\nconst MAX_BATCH_SIZE = 20;\n\n/**\n * Maintains a queue of outgoing to-device messages, sending them\n * as soon as the homeserver is reachable.\n */\nexport class ToDeviceMessageQueue {\n    private sending = false;\n    private running = true;\n    private retryTimeout: ReturnType<typeof setTimeout> | null = null;\n    private retryAttempts = 0;\n\n    public constructor(private client: MatrixClient) {}\n\n    public start(): void {\n        this.running = true;\n        this.sendQueue();\n        this.client.on(ClientEvent.Sync, this.onResumedSync);\n    }\n\n    public stop(): void {\n        this.running = false;\n        if (this.retryTimeout !== null) clearTimeout(this.retryTimeout);\n        this.retryTimeout = null;\n        this.client.removeListener(ClientEvent.Sync, this.onResumedSync);\n    }\n\n    public async queueBatch(batch: ToDeviceBatch): Promise<void> {\n        const batches: ToDeviceBatchWithTxnId[] = [];\n        for (let i = 0; i < batch.batch.length; i += MAX_BATCH_SIZE) {\n            const batchWithTxnId = {\n                eventType: batch.eventType,\n                batch: batch.batch.slice(i, i + MAX_BATCH_SIZE),\n                txnId: this.client.makeTxnId(),\n            };\n            batches.push(batchWithTxnId);\n            const msgmap = batchWithTxnId.batch.map(\n                (msg) => `${msg.userId}/${msg.deviceId} (msgid ${msg.payload[ToDeviceMessageId]})`,\n            );\n            logger.info(\n                `Enqueuing batch of to-device messages. type=${batch.eventType} txnid=${batchWithTxnId.txnId}`,\n                msgmap,\n            );\n        }\n\n        await this.client.store.saveToDeviceBatches(batches);\n        this.sendQueue();\n    }\n\n    public sendQueue = async (): Promise<void> => {\n        if (this.retryTimeout !== null) clearTimeout(this.retryTimeout);\n        this.retryTimeout = null;\n\n        if (this.sending || !this.running) return;\n\n        logger.debug(\"Attempting to send queued to-device messages\");\n\n        this.sending = true;\n        let headBatch: IndexedToDeviceBatch | null;\n        try {\n            while (this.running) {\n                headBatch = await this.client.store.getOldestToDeviceBatch();\n                if (headBatch === null) break;\n                await this.sendBatch(headBatch);\n                await this.client.store.removeToDeviceBatch(headBatch.id);\n                this.retryAttempts = 0;\n            }\n\n            // Make sure we're still running after the async tasks: if not, stop.\n            if (!this.running) return;\n\n            logger.debug(\"All queued to-device messages sent\");\n        } catch (e) {\n            ++this.retryAttempts;\n            // eslint-disable-next-line @typescript-eslint/naming-convention\n            // eslint-disable-next-line new-cap\n            const retryDelay = MatrixScheduler.RETRY_BACKOFF_RATELIMIT(null, this.retryAttempts, <MatrixError>e);\n            if (retryDelay === -1) {\n                // the scheduler function doesn't differentiate between fatal errors and just getting\n                // bored and giving up for now\n                if (Math.floor((<MatrixError>e).httpStatus! / 100) === 4) {\n                    logger.error(\"Fatal error when sending to-device message - dropping to-device batch!\", e);\n                    await this.client.store.removeToDeviceBatch(headBatch!.id);\n                } else {\n                    logger.info(\"Automatic retry limit reached for to-device messages.\");\n                }\n                return;\n            }\n\n            logger.info(`Failed to send batch of to-device messages. Will retry in ${retryDelay}ms`, e);\n            this.retryTimeout = setTimeout(this.sendQueue, retryDelay);\n        } finally {\n            this.sending = false;\n        }\n    };\n\n    /**\n     * Attempts to send a batch of to-device messages.\n     */\n    private async sendBatch(batch: IndexedToDeviceBatch): Promise<void> {\n        const contentMap: MapWithDefault<string, Map<string, ToDevicePayload>> = new MapWithDefault(() => new Map());\n        for (const item of batch.batch) {\n            contentMap.getOrCreate(item.userId).set(item.deviceId, item.payload);\n        }\n\n        logger.info(\n            `Sending batch of ${batch.batch.length} to-device messages with ID ${batch.id} and txnId ${batch.txnId}`,\n        );\n\n        await this.client.sendToDevice(batch.eventType, contentMap, batch.txnId);\n    }\n\n    /**\n     * Listen to sync state changes and automatically resend any pending events\n     * once syncing is resumed\n     */\n    private onResumedSync = (state: SyncState | null, oldState: SyncState | null): void => {\n        if (state === SyncState.Syncing && oldState !== SyncState.Syncing) {\n            logger.info(`Resuming queue after resumed sync`);\n            this.sendQueue();\n        }\n    };\n}\n"],"mappings":";;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,iBAAiB,QAAQ,mBAAmB;AACrD,SAASC,MAAM,QAAQ,aAAa;AACpC,SAAuBC,WAAW,QAAQ,aAAa;AAQvD,SAASC,eAAe,QAAQ,gBAAgB;AAChD,SAASC,SAAS,QAAQ,WAAW;AACrC,SAASC,cAAc,QAAQ,YAAY;AAE3C,IAAMC,cAAc,GAAG,EAAE;;AAEzB;AACA;AACA;AACA;AACA,OAAO,MAAMC,oBAAoB,CAAC;EAMvBC,WAAWA,CAASC,MAAoB,EAAE;IAAA,IAAAC,KAAA;IAAA,KAAtBD,MAAoB,GAApBA,MAAoB;IAAAE,eAAA,kBAL7B,KAAK;IAAAA,eAAA,kBACL,IAAI;IAAAA,eAAA,uBACuC,IAAI;IAAAA,eAAA,wBACzC,CAAC;IAAAA,eAAA,iCAAAC,iBAAA,CAuCN,aAA2B;MAC1C,IAAIF,KAAI,CAACG,YAAY,KAAK,IAAI,EAAEC,YAAY,CAACJ,KAAI,CAACG,YAAY,CAAC;MAC/DH,KAAI,CAACG,YAAY,GAAG,IAAI;MAExB,IAAIH,KAAI,CAACK,OAAO,IAAI,CAACL,KAAI,CAACM,OAAO,EAAE;MAEnCf,MAAM,CAACgB,KAAK,CAAC,8CAA8C,CAAC;MAE5DP,KAAI,CAACK,OAAO,GAAG,IAAI;MACnB,IAAIG,SAAsC;MAC1C,IAAI;QACA,OAAOR,KAAI,CAACM,OAAO,EAAE;UACjBE,SAAS,SAASR,KAAI,CAACD,MAAM,CAACU,KAAK,CAACC,sBAAsB,CAAC,CAAC;UAC5D,IAAIF,SAAS,KAAK,IAAI,EAAE;UACxB,MAAMR,KAAI,CAACW,SAAS,CAACH,SAAS,CAAC;UAC/B,MAAMR,KAAI,CAACD,MAAM,CAACU,KAAK,CAACG,mBAAmB,CAACJ,SAAS,CAACK,EAAE,CAAC;UACzDb,KAAI,CAACc,aAAa,GAAG,CAAC;QAC1B;;QAEA;QACA,IAAI,CAACd,KAAI,CAACM,OAAO,EAAE;QAEnBf,MAAM,CAACgB,KAAK,CAAC,oCAAoC,CAAC;MACtD,CAAC,CAAC,OAAOQ,CAAC,EAAE;QACR,EAAEf,KAAI,CAACc,aAAa;QACpB;QACA;QACA,IAAME,UAAU,GAAGvB,eAAe,CAACwB,uBAAuB,CAAC,IAAI,EAAEjB,KAAI,CAACc,aAAa,EAAeC,CAAC,CAAC;QACpG,IAAIC,UAAU,KAAK,CAAC,CAAC,EAAE;UACnB;UACA;UACA,IAAIE,IAAI,CAACC,KAAK,CAAeJ,CAAC,CAAEK,UAAU,GAAI,GAAG,CAAC,KAAK,CAAC,EAAE;YACtD7B,MAAM,CAAC8B,KAAK,CAAC,wEAAwE,EAAEN,CAAC,CAAC;YACzF,MAAMf,KAAI,CAACD,MAAM,CAACU,KAAK,CAACG,mBAAmB,CAACJ,SAAS,CAAEK,EAAE,CAAC;UAC9D,CAAC,MAAM;YACHtB,MAAM,CAAC+B,IAAI,CAAC,uDAAuD,CAAC;UACxE;UACA;QACJ;QAEA/B,MAAM,CAAC+B,IAAI,8DAAAC,MAAA,CAA8DP,UAAU,SAAMD,CAAC,CAAC;QAC3Ff,KAAI,CAACG,YAAY,GAAGqB,UAAU,CAACxB,KAAI,CAACyB,SAAS,EAAET,UAAU,CAAC;MAC9D,CAAC,SAAS;QACNhB,KAAI,CAACK,OAAO,GAAG,KAAK;MACxB;IACJ,CAAC;IAkBD;AACJ;AACA;AACA;IAHIJ,eAAA,wBAIwB,CAACyB,KAAuB,EAAEC,QAA0B,KAAW;MACnF,IAAID,KAAK,KAAKhC,SAAS,CAACkC,OAAO,IAAID,QAAQ,KAAKjC,SAAS,CAACkC,OAAO,EAAE;QAC/DrC,MAAM,CAAC+B,IAAI,oCAAoC,CAAC;QAChD,IAAI,CAACG,SAAS,CAAC,CAAC;MACpB;IACJ,CAAC;EA7GiD;EAE3CI,KAAKA,CAAA,EAAS;IACjB,IAAI,CAACvB,OAAO,GAAG,IAAI;IACnB,IAAI,CAACmB,SAAS,CAAC,CAAC;IAChB,IAAI,CAAC1B,MAAM,CAAC+B,EAAE,CAACtC,WAAW,CAACuC,IAAI,EAAE,IAAI,CAACC,aAAa,CAAC;EACxD;EAEOC,IAAIA,CAAA,EAAS;IAChB,IAAI,CAAC3B,OAAO,GAAG,KAAK;IACpB,IAAI,IAAI,CAACH,YAAY,KAAK,IAAI,EAAEC,YAAY,CAAC,IAAI,CAACD,YAAY,CAAC;IAC/D,IAAI,CAACA,YAAY,GAAG,IAAI;IACxB,IAAI,CAACJ,MAAM,CAACmC,cAAc,CAAC1C,WAAW,CAACuC,IAAI,EAAE,IAAI,CAACC,aAAa,CAAC;EACpE;EAEaG,UAAUA,CAACC,KAAoB,EAAiB;IAAA,IAAAC,MAAA;IAAA,OAAAnC,iBAAA;MACzD,IAAMoC,OAAiC,GAAG,EAAE;MAC5C,KAAK,IAAIC,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGH,KAAK,CAACA,KAAK,CAACI,MAAM,EAAED,CAAC,IAAI3C,cAAc,EAAE;QACzD,IAAM6C,cAAc,GAAG;UACnBC,SAAS,EAAEN,KAAK,CAACM,SAAS;UAC1BN,KAAK,EAAEA,KAAK,CAACA,KAAK,CAACO,KAAK,CAACJ,CAAC,EAAEA,CAAC,GAAG3C,cAAc,CAAC;UAC/CgD,KAAK,EAAEP,MAAI,CAACtC,MAAM,CAAC8C,SAAS,CAAC;QACjC,CAAC;QACDP,OAAO,CAACQ,IAAI,CAACL,cAAc,CAAC;QAC5B,IAAMM,MAAM,GAAGN,cAAc,CAACL,KAAK,CAACY,GAAG,CAClCC,GAAG,OAAA1B,MAAA,CAAQ0B,GAAG,CAACC,MAAM,OAAA3B,MAAA,CAAI0B,GAAG,CAACE,QAAQ,cAAA5B,MAAA,CAAW0B,GAAG,CAACG,OAAO,CAAC9D,iBAAiB,CAAC,MACnF,CAAC;QACDC,MAAM,CAAC+B,IAAI,gDAAAC,MAAA,CACwCa,KAAK,CAACM,SAAS,aAAAnB,MAAA,CAAUkB,cAAc,CAACG,KAAK,GAC5FG,MACJ,CAAC;MACL;MAEA,MAAMV,MAAI,CAACtC,MAAM,CAACU,KAAK,CAAC4C,mBAAmB,CAACf,OAAO,CAAC;MACpDD,MAAI,CAACZ,SAAS,CAAC,CAAC;IAAC;EACrB;EAiDA;AACJ;AACA;EACkBd,SAASA,CAACyB,KAA2B,EAAiB;IAAA,IAAAkB,MAAA;IAAA,OAAApD,iBAAA;MAChE,IAAMqD,UAAgE,GAAG,IAAI5D,cAAc,CAAC,MAAM,IAAI6D,GAAG,CAAC,CAAC,CAAC;MAC5G,KAAK,IAAMC,IAAI,IAAIrB,KAAK,CAACA,KAAK,EAAE;QAC5BmB,UAAU,CAACG,WAAW,CAACD,IAAI,CAACP,MAAM,CAAC,CAACS,GAAG,CAACF,IAAI,CAACN,QAAQ,EAAEM,IAAI,CAACL,OAAO,CAAC;MACxE;MAEA7D,MAAM,CAAC+B,IAAI,qBAAAC,MAAA,CACaa,KAAK,CAACA,KAAK,CAACI,MAAM,kCAAAjB,MAAA,CAA+Ba,KAAK,CAACvB,EAAE,iBAAAU,MAAA,CAAca,KAAK,CAACQ,KAAK,CAC1G,CAAC;MAED,MAAMU,MAAI,CAACvD,MAAM,CAAC6D,YAAY,CAACxB,KAAK,CAACM,SAAS,EAAEa,UAAU,EAAEnB,KAAK,CAACQ,KAAK,CAAC;IAAC;EAC7E;AAYJ","ignoreList":[]}

package/lib/autodiscovery.d.ts

@@ -0,0 +1,136 @@
+import { IClientWellKnown, IWellKnownConfig } from "./client.ts";
+export declare enum AutoDiscoveryAction {
+    SUCCESS = "SUCCESS",
+    IGNORE = "IGNORE",
+    PROMPT = "PROMPT",
+    FAIL_PROMPT = "FAIL_PROMPT",
+    FAIL_ERROR = "FAIL_ERROR"
+}
+export declare enum AutoDiscoveryError {
+    Invalid = "Invalid homeserver discovery response",
+    GenericFailure = "Failed to get autodiscovery configuration from server",
+    InvalidHsBaseUrl = "Invalid base_url for m.homeserver",
+    InvalidHomeserver = "Homeserver URL does not appear to be a valid Matrix homeserver",
+    InvalidIsBaseUrl = "Invalid base_url for m.identity_server",
+    InvalidIdentityServer = "Identity server URL does not appear to be a valid identity server",
+    InvalidIs = "Invalid identity server discovery response",
+    MissingWellknown = "No .well-known JSON file found",
+    InvalidJson = "Invalid JSON",
+    UnsupportedHomeserverSpecVersion = "The homeserver does not meet the version requirements"
+}
+interface AutoDiscoveryState {
+    state: AutoDiscoveryAction;
+    error?: IWellKnownConfig["error"] | null;
+}
+interface WellKnownConfig extends Omit<IWellKnownConfig, "error">, AutoDiscoveryState {
+}
+export interface ClientConfig extends Omit<IClientWellKnown, "m.homeserver" | "m.identity_server"> {
+    "m.homeserver": WellKnownConfig;
+    "m.identity_server": WellKnownConfig;
+}
+/**
+ * Utilities for automatically discovery resources, such as homeservers
+ * for users to log in to.
+ */
+export declare class AutoDiscovery {
+    static readonly ERROR_INVALID = AutoDiscoveryError.Invalid;
+    static readonly ERROR_GENERIC_FAILURE = AutoDiscoveryError.GenericFailure;
+    static readonly ERROR_INVALID_HS_BASE_URL = AutoDiscoveryError.InvalidHsBaseUrl;
+    static readonly ERROR_INVALID_HOMESERVER = AutoDiscoveryError.InvalidHomeserver;
+    static readonly ERROR_INVALID_IS_BASE_URL = AutoDiscoveryError.InvalidIsBaseUrl;
+    static readonly ERROR_INVALID_IDENTITY_SERVER = AutoDiscoveryError.InvalidIdentityServer;
+    static readonly ERROR_INVALID_IS = AutoDiscoveryError.InvalidIs;
+    static readonly ERROR_MISSING_WELLKNOWN = AutoDiscoveryError.MissingWellknown;
+    static readonly ERROR_INVALID_JSON = AutoDiscoveryError.InvalidJson;
+    static readonly ERROR_UNSUPPORTED_HOMESERVER_SPEC_VERSION = AutoDiscoveryError.UnsupportedHomeserverSpecVersion;
+    static readonly ALL_ERRORS: AutoDiscoveryError[];
+    /**
+     * The auto discovery failed. The client is expected to communicate
+     * the error to the user and refuse logging in.
+     */
+    static readonly FAIL_ERROR = AutoDiscoveryAction.FAIL_ERROR;
+    /**
+     * The auto discovery failed, however the client may still recover
+     * from the problem. The client is recommended to that the same
+     * action it would for PROMPT while also warning the user about
+     * what went wrong. The client may also treat this the same as
+     * a FAIL_ERROR state.
+     */
+    static readonly FAIL_PROMPT = AutoDiscoveryAction.FAIL_PROMPT;
+    /**
+     * The auto discovery didn't fail but did not find anything of
+     * interest. The client is expected to prompt the user for more
+     * information, or fail if it prefers.
+     */
+    static readonly PROMPT = AutoDiscoveryAction.PROMPT;
+    /**
+     * The auto discovery was successful.
+     */
+    static readonly SUCCESS = AutoDiscoveryAction.SUCCESS;
+    /**
+     * Validates and verifies client configuration information for purposes
+     * of logging in. Such information includes the homeserver URL
+     * and identity server URL the client would want. Additional details
+     * may also be included, and will be transparently brought into the
+     * response object unaltered.
+     * @param wellknown - The configuration object itself, as returned
+     * by the .well-known auto-discovery endpoint.
+     * @returns Promise which resolves to the verified
+     * configuration, which may include error states. Rejects on unexpected
+     * failure, not when verification fails.
+     */
+    static fromDiscoveryConfig(wellknown: IClientWellKnown): Promise<ClientConfig>;
+    /**
+     * Attempts to automatically discover client configuration information
+     * prior to logging in. Such information includes the homeserver URL
+     * and identity server URL the client would want. Additional details
+     * may also be discovered, and will be transparently included in the
+     * response object unaltered.
+     * @param domain - The homeserver domain to perform discovery
+     * on. For example, "matrix.org".
+     * @returns Promise which resolves to the discovered
+     * configuration, which may include error states. Rejects on unexpected
+     * failure, not when discovery fails.
+     */
+    static findClientConfig(domain: string): Promise<ClientConfig>;
+    /**
+     * Gets the raw discovery client configuration for the given domain name.
+     * Should only be used if there's no validation to be done on the resulting
+     * object, otherwise use findClientConfig().
+     * @param domain - The domain to get the client config for.
+     * @returns Promise which resolves to the domain's client config. Can
+     * be an empty object.
+     */
+    static getRawClientConfig(domain?: string): Promise<IClientWellKnown>;
+    /**
+     * Sanitizes a given URL to ensure it is either an HTTP or HTTP URL and
+     * is suitable for the requirements laid out by .well-known auto discovery.
+     * If valid, the URL will also be stripped of any trailing slashes.
+     * @param url - The potentially invalid URL to sanitize.
+     * @returns The sanitized URL or a falsey value if the URL is invalid.
+     * @internal
+     */
+    private static sanitizeWellKnownUrl;
+    private static fetch;
+    private static fetchFn?;
+    static setFetchFn(fetchFn: typeof globalThis.fetch): void;
+    /**
+     * Fetches a JSON object from a given URL, as expected by all .well-known
+     * related lookups. If the server gives a 404 then the `action` will be
+     * IGNORE. If the server returns something that isn't JSON, the `action`
+     * will be FAIL_PROMPT. For any other failure the `action` will be FAIL_PROMPT.
+     *
+     * The returned object will be a result of the call in object form with
+     * the following properties:
+     *   raw: The JSON object returned by the server.
+     *   action: One of SUCCESS, IGNORE, or FAIL_PROMPT.
+     *   reason: Relatively human-readable description of what went wrong.
+     *   error: The actual Error, if one exists.
+     * @param url - The URL to fetch a JSON object from.
+     * @returns Promise which resolves to the returned state.
+     * @internal
+     */
+    private static fetchWellKnownObject;
+}
+export {};
+//# sourceMappingURL=autodiscovery.d.ts.map

package/lib/autodiscovery.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"autodiscovery.d.ts","sourceRoot":"","sources":["../src/autodiscovery.ts"],"names":[],"mappings":"AAiBA,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAmB,MAAM,aAAa,CAAC;AAQlF,oBAAY,mBAAmB;IAC3B,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,WAAW,gBAAgB;IAC3B,UAAU,eAAe;CAC5B;AAED,oBAAY,kBAAkB;IAC1B,OAAO,0CAA0C;IACjD,cAAc,0DAA0D;IACxE,gBAAgB,sCAAsC;IACtD,iBAAiB,mEAAmE;IACpF,gBAAgB,2CAA2C;IAC3D,qBAAqB,sEAAsE;IAC3F,SAAS,+CAA+C;IACxD,gBAAgB,mCAAmC;IACnD,WAAW,iBAAiB;IAC5B,gCAAgC,0DAA0D;CAI7F;AAED,UAAU,kBAAkB;IACxB,KAAK,EAAE,mBAAmB,CAAC;IAC3B,KAAK,CAAC,EAAE,gBAAgB,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;CAC5C;AACD,UAAU,eAAgB,SAAQ,IAAI,CAAC,gBAAgB,EAAE,OAAO,CAAC,EAAE,kBAAkB;CAAG;AAExF,MAAM,WAAW,YAAa,SAAQ,IAAI,CAAC,gBAAgB,EAAE,cAAc,GAAG,mBAAmB,CAAC;IAC9F,cAAc,EAAE,eAAe,CAAC;IAChC,mBAAmB,EAAE,eAAe,CAAC;CACxC;AAED;;;GAGG;AACH,qBAAa,aAAa;IAMtB,gBAAuB,aAAa,8BAA8B;IAElE,gBAAuB,qBAAqB,qCAAqC;IAEjF,gBAAuB,yBAAyB,uCAAuC;IAEvF,gBAAuB,wBAAwB,wCAAwC;IAEvF,gBAAuB,yBAAyB,uCAAuC;IAEvF,gBAAuB,6BAA6B,4CAA4C;IAEhG,gBAAuB,gBAAgB,gCAAgC;IAEvE,gBAAuB,uBAAuB,uCAAuC;IAErF,gBAAuB,kBAAkB,kCAAkC;IAE3E,gBAAuB,yCAAyC,uDACR;IAExD,gBAAuB,UAAU,EAAsC,kBAAkB,EAAE,CAAC;IAE5F;;;OAGG;IACH,gBAAuB,UAAU,kCAAkC;IAEnE;;;;;;OAMG;IACH,gBAAuB,WAAW,mCAAmC;IAErE;;;;OAIG;IACH,gBAAuB,MAAM,8BAA8B;IAE3D;;OAEG;IACH,gBAAuB,OAAO,+BAA+B;IAE7D;;;;;;;;;;;OAWG;WACiB,mBAAmB,CAAC,SAAS,EAAE,gBAAgB,GAAG,OAAO,CAAC,YAAY,CAAC;IAgK3F;;;;;;;;;;;OAWG;WACiB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IA2D3E;;;;;;;OAOG;WACiB,kBAAkB,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAUlF;;;;;;;OAOG;IACH,OAAO,CAAC,MAAM,CAAC,oBAAoB;IA2BnC,OAAO,CAAC,MAAM,CAAC,KAAK;IAOpB,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAA0B;WAEnC,UAAU,CAAC,OAAO,EAAE,OAAO,UAAU,CAAC,KAAK,GAAG,IAAI;IAIhE;;;;;;;;;;;;;;;OAeG;mBACkB,oBAAoB;CA2D5C"}