@unwanted/matrix-sdk-mini 34.12.0-1

package/lib/models/beacon.d.ts

@@ -0,0 +1,53 @@
+import { BeaconInfoState, BeaconLocationState } from "../content-helpers.ts";
+import { MatrixEvent } from "./event.ts";
+import { TypedEventEmitter } from "./typed-event-emitter.ts";
+export declare enum BeaconEvent {
+    New = "Beacon.new",
+    Update = "Beacon.update",
+    LivenessChange = "Beacon.LivenessChange",
+    Destroy = "Beacon.Destroy",
+    LocationUpdate = "Beacon.LocationUpdate"
+}
+export type BeaconEventHandlerMap = {
+    [BeaconEvent.Update]: (event: MatrixEvent, beacon: Beacon) => void;
+    [BeaconEvent.LivenessChange]: (isLive: boolean, beacon: Beacon) => void;
+    [BeaconEvent.Destroy]: (beaconIdentifier: string) => void;
+    [BeaconEvent.LocationUpdate]: (locationState: BeaconLocationState) => void;
+    [BeaconEvent.Destroy]: (beaconIdentifier: string) => void;
+};
+export declare const isTimestampInDuration: (startTimestamp: number, durationMs: number, timestamp: number) => boolean;
+export type BeaconIdentifier = string;
+export declare const getBeaconInfoIdentifier: (event: MatrixEvent) => BeaconIdentifier;
+export declare class Beacon extends TypedEventEmitter<Exclude<BeaconEvent, BeaconEvent.New>, BeaconEventHandlerMap> {
+    private rootEvent;
+    readonly roomId: string;
+    private _beaconInfo;
+    private _isLive?;
+    private livenessWatchTimeout?;
+    private _latestLocationEvent?;
+    constructor(rootEvent: MatrixEvent);
+    get isLive(): boolean;
+    get identifier(): BeaconIdentifier;
+    get beaconInfoId(): string;
+    get beaconInfoOwner(): string;
+    get beaconInfoEventType(): string;
+    get beaconInfo(): BeaconInfoState;
+    get latestLocationState(): BeaconLocationState | undefined;
+    get latestLocationEvent(): MatrixEvent | undefined;
+    update(beaconInfoEvent: MatrixEvent): void;
+    destroy(): void;
+    /**
+     * Monitor liveness of a beacon
+     * Emits BeaconEvent.LivenessChange when beacon expires
+     */
+    monitorLiveness(): void;
+    /**
+     * Process Beacon locations
+     * Emits BeaconEvent.LocationUpdate
+     */
+    addLocations(beaconLocationEvents: MatrixEvent[]): void;
+    private clearLatestLocation;
+    private setBeaconInfo;
+    private checkLiveness;
+}
+//# sourceMappingURL=beacon.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"beacon.d.ts","sourceRoot":"","sources":["../../src/models/beacon.ts"],"names":[],"mappings":"AAiBA,OAAO,EACH,eAAe,EACf,mBAAmB,EAGtB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAE7D,oBAAY,WAAW;IACnB,GAAG,eAAe;IAClB,MAAM,kBAAkB;IACxB,cAAc,0BAA0B;IACxC,OAAO,mBAAmB;IAC1B,cAAc,0BAA0B;CAC3C;AAED,MAAM,MAAM,qBAAqB,GAAG;IAChC,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IACnE,CAAC,WAAW,CAAC,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IACxE,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,gBAAgB,EAAE,MAAM,KAAK,IAAI,CAAC;IAC1D,CAAC,WAAW,CAAC,cAAc,CAAC,EAAE,CAAC,aAAa,EAAE,mBAAmB,KAAK,IAAI,CAAC;IAC3E,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,gBAAgB,EAAE,MAAM,KAAK,IAAI,CAAC;CAC7D,CAAC;AAEF,eAAO,MAAM,qBAAqB,mBAAoB,MAAM,cAAc,MAAM,aAAa,MAAM,KAAG,OAC3B,CAAC;AAI5E,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC;AACtC,eAAO,MAAM,uBAAuB,UAAW,WAAW,KAAG,gBACZ,CAAC;AAGlD,qBAAa,MAAO,SAAQ,iBAAiB,CAAC,OAAO,CAAC,WAAW,EAAE,WAAW,CAAC,GAAG,CAAC,EAAE,qBAAqB,CAAC;IASpF,OAAO,CAAC,SAAS;IARpC,SAAgB,MAAM,EAAE,MAAM,CAAC;IAG/B,OAAO,CAAC,WAAW,CAAmB;IACtC,OAAO,CAAC,OAAO,CAAC,CAAU;IAC1B,OAAO,CAAC,oBAAoB,CAAC,CAAgC;IAC7D,OAAO,CAAC,oBAAoB,CAAC,CAAc;gBAEhB,SAAS,EAAE,WAAW;IAMjD,IAAW,MAAM,IAAI,OAAO,CAE3B;IAED,IAAW,UAAU,IAAI,gBAAgB,CAExC;IAED,IAAW,YAAY,IAAI,MAAM,CAEhC;IAED,IAAW,eAAe,IAAI,MAAM,CAEnC;IAED,IAAW,mBAAmB,IAAI,MAAM,CAEvC;IAED,IAAW,UAAU,IAAI,eAAe,CAEvC;IAED,IAAW,mBAAmB,IAAI,mBAAmB,GAAG,SAAS,CAEhE;IAED,IAAW,mBAAmB,IAAI,WAAW,GAAG,SAAS,CAExD;IAEM,MAAM,CAAC,eAAe,EAAE,WAAW,GAAG,IAAI;IAe1C,OAAO,IAAI,IAAI;IAStB;;;OAGG;IACI,eAAe,IAAI,IAAI;IAuB9B;;;OAGG;IACI,YAAY,CAAC,oBAAoB,EAAE,WAAW,EAAE,GAAG,IAAI;IA2B9D,OAAO,CAAC,mBAAmB,CAGzB;IAEF,OAAO,CAAC,aAAa;IAKrB,OAAO,CAAC,aAAa;CAqBxB"}

package/lib/models/beacon.js

@@ -0,0 +1,174 @@
+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 { parseBeaconContent, parseBeaconInfoContent } from "../content-helpers.js";
+import { sortEventsByLatestContentTimestamp } from "../utils.js";
+import { TypedEventEmitter } from "./typed-event-emitter.js";
+export var BeaconEvent = /*#__PURE__*/function (BeaconEvent) {
+  BeaconEvent["New"] = "Beacon.new";
+  BeaconEvent["Update"] = "Beacon.update";
+  BeaconEvent["LivenessChange"] = "Beacon.LivenessChange";
+  BeaconEvent["Destroy"] = "Beacon.Destroy";
+  BeaconEvent["LocationUpdate"] = "Beacon.LocationUpdate";
+  return BeaconEvent;
+}({});
+export var isTimestampInDuration = (startTimestamp, durationMs, timestamp) => timestamp >= startTimestamp && startTimestamp + durationMs >= timestamp;
+
+// beacon info events are uniquely identified by
+// `<roomId>_<state_key>`
+
+export var getBeaconInfoIdentifier = event => "".concat(event.getRoomId(), "_").concat(event.getStateKey());
+
+// https://github.com/matrix-org/matrix-spec-proposals/pull/3672
+export class Beacon extends TypedEventEmitter {
+  constructor(rootEvent) {
+    super();
+    this.rootEvent = rootEvent;
+    _defineProperty(this, "roomId", void 0);
+    // beaconInfo is assigned by setBeaconInfo in the constructor
+    // ! to make tsc believe it is definitely assigned
+    _defineProperty(this, "_beaconInfo", void 0);
+    _defineProperty(this, "_isLive", void 0);
+    _defineProperty(this, "livenessWatchTimeout", void 0);
+    _defineProperty(this, "_latestLocationEvent", void 0);
+    _defineProperty(this, "clearLatestLocation", () => {
+      this._latestLocationEvent = undefined;
+      this.emit(BeaconEvent.LocationUpdate, this.latestLocationState);
+    });
+    this.roomId = this.rootEvent.getRoomId();
+    this.setBeaconInfo(this.rootEvent);
+  }
+  get isLive() {
+    return !!this._isLive;
+  }
+  get identifier() {
+    return getBeaconInfoIdentifier(this.rootEvent);
+  }
+  get beaconInfoId() {
+    return this.rootEvent.getId();
+  }
+  get beaconInfoOwner() {
+    return this.rootEvent.getStateKey();
+  }
+  get beaconInfoEventType() {
+    return this.rootEvent.getType();
+  }
+  get beaconInfo() {
+    return this._beaconInfo;
+  }
+  get latestLocationState() {
+    return this._latestLocationEvent && parseBeaconContent(this._latestLocationEvent.getContent());
+  }
+  get latestLocationEvent() {
+    return this._latestLocationEvent;
+  }
+  update(beaconInfoEvent) {
+    if (getBeaconInfoIdentifier(beaconInfoEvent) !== this.identifier) {
+      throw new Error("Invalid updating event");
+    }
+    // don't update beacon with an older event
+    if (beaconInfoEvent.getTs() < this.rootEvent.getTs()) {
+      return;
+    }
+    this.rootEvent = beaconInfoEvent;
+    this.setBeaconInfo(this.rootEvent);
+    this.emit(BeaconEvent.Update, beaconInfoEvent, this);
+    this.clearLatestLocation();
+  }
+  destroy() {
+    if (this.livenessWatchTimeout) {
+      clearTimeout(this.livenessWatchTimeout);
+    }
+    this._isLive = false;
+    this.emit(BeaconEvent.Destroy, this.identifier);
+  }
+
+  /**
+   * Monitor liveness of a beacon
+   * Emits BeaconEvent.LivenessChange when beacon expires
+   */
+  monitorLiveness() {
+    if (this.livenessWatchTimeout) {
+      clearTimeout(this.livenessWatchTimeout);
+    }
+    this.checkLiveness();
+    if (!this.beaconInfo) return;
+    if (this.isLive) {
+      var expiryInMs = this.beaconInfo.timestamp + this.beaconInfo.timeout - Date.now();
+      if (expiryInMs > 1) {
+        this.livenessWatchTimeout = setTimeout(() => {
+          this.monitorLiveness();
+        }, expiryInMs);
+      }
+    } else if (this.beaconInfo.timestamp > Date.now()) {
+      // beacon start timestamp is in the future
+      // check liveness again then
+      this.livenessWatchTimeout = setTimeout(() => {
+        this.monitorLiveness();
+      }, this.beaconInfo.timestamp - Date.now());
+    }
+  }
+
+  /**
+   * Process Beacon locations
+   * Emits BeaconEvent.LocationUpdate
+   */
+  addLocations(beaconLocationEvents) {
+    var _validLocationEvents$;
+    // discard locations for beacons that are not live
+    if (!this.isLive) {
+      return;
+    }
+    var validLocationEvents = beaconLocationEvents.filter(event => {
+      var content = event.getContent();
+      var parsed = parseBeaconContent(content);
+      if (!parsed.uri || !parsed.timestamp) return false; // we won't be able to process these
+      var {
+        timestamp
+      } = parsed;
+      return this._beaconInfo.timestamp &&
+      // only include positions that were taken inside the beacon's live period
+      isTimestampInDuration(this._beaconInfo.timestamp, this._beaconInfo.timeout, timestamp) && (
+      // ignore positions older than our current latest location
+      !this.latestLocationState || timestamp > this.latestLocationState.timestamp);
+    });
+    var latestLocationEvent = (_validLocationEvents$ = validLocationEvents.sort(sortEventsByLatestContentTimestamp)) === null || _validLocationEvents$ === void 0 ? void 0 : _validLocationEvents$[0];
+    if (latestLocationEvent) {
+      this._latestLocationEvent = latestLocationEvent;
+      this.emit(BeaconEvent.LocationUpdate, this.latestLocationState);
+    }
+  }
+  setBeaconInfo(event) {
+    this._beaconInfo = parseBeaconInfoContent(event.getContent());
+    this.checkLiveness();
+  }
+  checkLiveness() {
+    var prevLiveness = this.isLive;
+
+    // element web sets a beacon's start timestamp to the senders local current time
+    // when Alice's system clock deviates slightly from Bob's a beacon Alice intended to be live
+    // may have a start timestamp in the future from Bob's POV
+    // handle this by adding 6min of leniency to the start timestamp when it is in the future
+    if (!this.beaconInfo) return;
+    var startTimestamp = this.beaconInfo.timestamp > Date.now() ? this.beaconInfo.timestamp - 360000 /* 6min */ : this.beaconInfo.timestamp;
+    this._isLive = !!this._beaconInfo.live && !!startTimestamp && isTimestampInDuration(startTimestamp, this._beaconInfo.timeout, Date.now());
+    if (prevLiveness !== this.isLive) {
+      this.emit(BeaconEvent.LivenessChange, this.isLive, this);
+    }
+  }
+}
+//# sourceMappingURL=beacon.js.map

package/lib/models/beacon.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"beacon.js","names":["parseBeaconContent","parseBeaconInfoContent","sortEventsByLatestContentTimestamp","TypedEventEmitter","BeaconEvent","isTimestampInDuration","startTimestamp","durationMs","timestamp","getBeaconInfoIdentifier","event","concat","getRoomId","getStateKey","Beacon","constructor","rootEvent","_defineProperty","_latestLocationEvent","undefined","emit","LocationUpdate","latestLocationState","roomId","setBeaconInfo","isLive","_isLive","identifier","beaconInfoId","getId","beaconInfoOwner","beaconInfoEventType","getType","beaconInfo","_beaconInfo","getContent","latestLocationEvent","update","beaconInfoEvent","Error","getTs","Update","clearLatestLocation","destroy","livenessWatchTimeout","clearTimeout","Destroy","monitorLiveness","checkLiveness","expiryInMs","timeout","Date","now","setTimeout","addLocations","beaconLocationEvents","_validLocationEvents$","validLocationEvents","filter","content","parsed","uri","sort","prevLiveness","live","LivenessChange"],"sources":["../../src/models/beacon.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 { MBeaconEventContent } from \"../@types/beacon.ts\";\nimport {\n    BeaconInfoState,\n    BeaconLocationState,\n    parseBeaconContent,\n    parseBeaconInfoContent,\n} from \"../content-helpers.ts\";\nimport { MatrixEvent } from \"./event.ts\";\nimport { sortEventsByLatestContentTimestamp } from \"../utils.ts\";\nimport { TypedEventEmitter } from \"./typed-event-emitter.ts\";\n\nexport enum BeaconEvent {\n    New = \"Beacon.new\",\n    Update = \"Beacon.update\",\n    LivenessChange = \"Beacon.LivenessChange\",\n    Destroy = \"Beacon.Destroy\",\n    LocationUpdate = \"Beacon.LocationUpdate\",\n}\n\nexport type BeaconEventHandlerMap = {\n    [BeaconEvent.Update]: (event: MatrixEvent, beacon: Beacon) => void;\n    [BeaconEvent.LivenessChange]: (isLive: boolean, beacon: Beacon) => void;\n    [BeaconEvent.Destroy]: (beaconIdentifier: string) => void;\n    [BeaconEvent.LocationUpdate]: (locationState: BeaconLocationState) => void;\n    [BeaconEvent.Destroy]: (beaconIdentifier: string) => void;\n};\n\nexport const isTimestampInDuration = (startTimestamp: number, durationMs: number, timestamp: number): boolean =>\n    timestamp >= startTimestamp && startTimestamp + durationMs >= timestamp;\n\n// beacon info events are uniquely identified by\n// `<roomId>_<state_key>`\nexport type BeaconIdentifier = string;\nexport const getBeaconInfoIdentifier = (event: MatrixEvent): BeaconIdentifier =>\n    `${event.getRoomId()}_${event.getStateKey()}`;\n\n// https://github.com/matrix-org/matrix-spec-proposals/pull/3672\nexport class Beacon extends TypedEventEmitter<Exclude<BeaconEvent, BeaconEvent.New>, BeaconEventHandlerMap> {\n    public readonly roomId: string;\n    // beaconInfo is assigned by setBeaconInfo in the constructor\n    // ! to make tsc believe it is definitely assigned\n    private _beaconInfo!: BeaconInfoState;\n    private _isLive?: boolean;\n    private livenessWatchTimeout?: ReturnType<typeof setTimeout>;\n    private _latestLocationEvent?: MatrixEvent;\n\n    public constructor(private rootEvent: MatrixEvent) {\n        super();\n        this.roomId = this.rootEvent.getRoomId()!;\n        this.setBeaconInfo(this.rootEvent);\n    }\n\n    public get isLive(): boolean {\n        return !!this._isLive;\n    }\n\n    public get identifier(): BeaconIdentifier {\n        return getBeaconInfoIdentifier(this.rootEvent);\n    }\n\n    public get beaconInfoId(): string {\n        return this.rootEvent.getId()!;\n    }\n\n    public get beaconInfoOwner(): string {\n        return this.rootEvent.getStateKey()!;\n    }\n\n    public get beaconInfoEventType(): string {\n        return this.rootEvent.getType();\n    }\n\n    public get beaconInfo(): BeaconInfoState {\n        return this._beaconInfo;\n    }\n\n    public get latestLocationState(): BeaconLocationState | undefined {\n        return this._latestLocationEvent && parseBeaconContent(this._latestLocationEvent.getContent());\n    }\n\n    public get latestLocationEvent(): MatrixEvent | undefined {\n        return this._latestLocationEvent;\n    }\n\n    public update(beaconInfoEvent: MatrixEvent): void {\n        if (getBeaconInfoIdentifier(beaconInfoEvent) !== this.identifier) {\n            throw new Error(\"Invalid updating event\");\n        }\n        // don't update beacon with an older event\n        if (beaconInfoEvent.getTs() < this.rootEvent.getTs()) {\n            return;\n        }\n        this.rootEvent = beaconInfoEvent;\n        this.setBeaconInfo(this.rootEvent);\n\n        this.emit(BeaconEvent.Update, beaconInfoEvent, this);\n        this.clearLatestLocation();\n    }\n\n    public destroy(): void {\n        if (this.livenessWatchTimeout) {\n            clearTimeout(this.livenessWatchTimeout);\n        }\n\n        this._isLive = false;\n        this.emit(BeaconEvent.Destroy, this.identifier);\n    }\n\n    /**\n     * Monitor liveness of a beacon\n     * Emits BeaconEvent.LivenessChange when beacon expires\n     */\n    public monitorLiveness(): void {\n        if (this.livenessWatchTimeout) {\n            clearTimeout(this.livenessWatchTimeout);\n        }\n\n        this.checkLiveness();\n        if (!this.beaconInfo) return;\n        if (this.isLive) {\n            const expiryInMs = this.beaconInfo.timestamp! + this.beaconInfo.timeout - Date.now();\n            if (expiryInMs > 1) {\n                this.livenessWatchTimeout = setTimeout(() => {\n                    this.monitorLiveness();\n                }, expiryInMs);\n            }\n        } else if (this.beaconInfo.timestamp! > Date.now()) {\n            // beacon start timestamp is in the future\n            // check liveness again then\n            this.livenessWatchTimeout = setTimeout(() => {\n                this.monitorLiveness();\n            }, this.beaconInfo.timestamp! - Date.now());\n        }\n    }\n\n    /**\n     * Process Beacon locations\n     * Emits BeaconEvent.LocationUpdate\n     */\n    public addLocations(beaconLocationEvents: MatrixEvent[]): void {\n        // discard locations for beacons that are not live\n        if (!this.isLive) {\n            return;\n        }\n\n        const validLocationEvents = beaconLocationEvents.filter((event) => {\n            const content = event.getContent<MBeaconEventContent>();\n            const parsed = parseBeaconContent(content);\n            if (!parsed.uri || !parsed.timestamp) return false; // we won't be able to process these\n            const { timestamp } = parsed;\n            return (\n                this._beaconInfo.timestamp &&\n                // only include positions that were taken inside the beacon's live period\n                isTimestampInDuration(this._beaconInfo.timestamp, this._beaconInfo.timeout, timestamp) &&\n                // ignore positions older than our current latest location\n                (!this.latestLocationState || timestamp > this.latestLocationState.timestamp!)\n            );\n        });\n        const latestLocationEvent = validLocationEvents.sort(sortEventsByLatestContentTimestamp)?.[0];\n\n        if (latestLocationEvent) {\n            this._latestLocationEvent = latestLocationEvent;\n            this.emit(BeaconEvent.LocationUpdate, this.latestLocationState!);\n        }\n    }\n\n    private clearLatestLocation = (): void => {\n        this._latestLocationEvent = undefined;\n        this.emit(BeaconEvent.LocationUpdate, this.latestLocationState!);\n    };\n\n    private setBeaconInfo(event: MatrixEvent): void {\n        this._beaconInfo = parseBeaconInfoContent(event.getContent());\n        this.checkLiveness();\n    }\n\n    private checkLiveness(): void {\n        const prevLiveness = this.isLive;\n\n        // element web sets a beacon's start timestamp to the senders local current time\n        // when Alice's system clock deviates slightly from Bob's a beacon Alice intended to be live\n        // may have a start timestamp in the future from Bob's POV\n        // handle this by adding 6min of leniency to the start timestamp when it is in the future\n        if (!this.beaconInfo) return;\n        const startTimestamp =\n            this.beaconInfo.timestamp! > Date.now()\n                ? this.beaconInfo.timestamp! - 360000 /* 6min */\n                : this.beaconInfo.timestamp;\n        this._isLive =\n            !!this._beaconInfo.live &&\n            !!startTimestamp &&\n            isTimestampInDuration(startTimestamp, this._beaconInfo.timeout, Date.now());\n\n        if (prevLiveness !== this.isLive) {\n            this.emit(BeaconEvent.LivenessChange, this.isLive, this);\n        }\n    }\n}\n"],"mappings":";AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA,SAGIA,kBAAkB,EAClBC,sBAAsB,QACnB,uBAAuB;AAE9B,SAASC,kCAAkC,QAAQ,aAAa;AAChE,SAASC,iBAAiB,QAAQ,0BAA0B;AAE5D,WAAYC,WAAW,0BAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAA,OAAXA,WAAW;AAAA;AAgBvB,OAAO,IAAMC,qBAAqB,GAAGA,CAACC,cAAsB,EAAEC,UAAkB,EAAEC,SAAiB,KAC/FA,SAAS,IAAIF,cAAc,IAAIA,cAAc,GAAGC,UAAU,IAAIC,SAAS;;AAE3E;AACA;;AAEA,OAAO,IAAMC,uBAAuB,GAAIC,KAAkB,OAAAC,MAAA,CACnDD,KAAK,CAACE,SAAS,CAAC,CAAC,OAAAD,MAAA,CAAID,KAAK,CAACG,WAAW,CAAC,CAAC,CAAE;;AAEjD;AACA,OAAO,MAAMC,MAAM,SAASX,iBAAiB,CAA+D;EASjGY,WAAWA,CAASC,SAAsB,EAAE;IAC/C,KAAK,CAAC,CAAC;IAAC,KADeA,SAAsB,GAAtBA,SAAsB;IAAAC,eAAA;IAPjD;IACA;IAAAA,eAAA;IAAAA,eAAA;IAAAA,eAAA;IAAAA,eAAA;IAAAA,eAAA,8BA8H8B,MAAY;MACtC,IAAI,CAACC,oBAAoB,GAAGC,SAAS;MACrC,IAAI,CAACC,IAAI,CAAChB,WAAW,CAACiB,cAAc,EAAE,IAAI,CAACC,mBAAoB,CAAC;IACpE,CAAC;IAzHG,IAAI,CAACC,MAAM,GAAG,IAAI,CAACP,SAAS,CAACJ,SAAS,CAAC,CAAE;IACzC,IAAI,CAACY,aAAa,CAAC,IAAI,CAACR,SAAS,CAAC;EACtC;EAEA,IAAWS,MAAMA,CAAA,EAAY;IACzB,OAAO,CAAC,CAAC,IAAI,CAACC,OAAO;EACzB;EAEA,IAAWC,UAAUA,CAAA,EAAqB;IACtC,OAAOlB,uBAAuB,CAAC,IAAI,CAACO,SAAS,CAAC;EAClD;EAEA,IAAWY,YAAYA,CAAA,EAAW;IAC9B,OAAO,IAAI,CAACZ,SAAS,CAACa,KAAK,CAAC,CAAC;EACjC;EAEA,IAAWC,eAAeA,CAAA,EAAW;IACjC,OAAO,IAAI,CAACd,SAAS,CAACH,WAAW,CAAC,CAAC;EACvC;EAEA,IAAWkB,mBAAmBA,CAAA,EAAW;IACrC,OAAO,IAAI,CAACf,SAAS,CAACgB,OAAO,CAAC,CAAC;EACnC;EAEA,IAAWC,UAAUA,CAAA,EAAoB;IACrC,OAAO,IAAI,CAACC,WAAW;EAC3B;EAEA,IAAWZ,mBAAmBA,CAAA,EAAoC;IAC9D,OAAO,IAAI,CAACJ,oBAAoB,IAAIlB,kBAAkB,CAAC,IAAI,CAACkB,oBAAoB,CAACiB,UAAU,CAAC,CAAC,CAAC;EAClG;EAEA,IAAWC,mBAAmBA,CAAA,EAA4B;IACtD,OAAO,IAAI,CAAClB,oBAAoB;EACpC;EAEOmB,MAAMA,CAACC,eAA4B,EAAQ;IAC9C,IAAI7B,uBAAuB,CAAC6B,eAAe,CAAC,KAAK,IAAI,CAACX,UAAU,EAAE;MAC9D,MAAM,IAAIY,KAAK,CAAC,wBAAwB,CAAC;IAC7C;IACA;IACA,IAAID,eAAe,CAACE,KAAK,CAAC,CAAC,GAAG,IAAI,CAACxB,SAAS,CAACwB,KAAK,CAAC,CAAC,EAAE;MAClD;IACJ;IACA,IAAI,CAACxB,SAAS,GAAGsB,eAAe;IAChC,IAAI,CAACd,aAAa,CAAC,IAAI,CAACR,SAAS,CAAC;IAElC,IAAI,CAACI,IAAI,CAAChB,WAAW,CAACqC,MAAM,EAAEH,eAAe,EAAE,IAAI,CAAC;IACpD,IAAI,CAACI,mBAAmB,CAAC,CAAC;EAC9B;EAEOC,OAAOA,CAAA,EAAS;IACnB,IAAI,IAAI,CAACC,oBAAoB,EAAE;MAC3BC,YAAY,CAAC,IAAI,CAACD,oBAAoB,CAAC;IAC3C;IAEA,IAAI,CAAClB,OAAO,GAAG,KAAK;IACpB,IAAI,CAACN,IAAI,CAAChB,WAAW,CAAC0C,OAAO,EAAE,IAAI,CAACnB,UAAU,CAAC;EACnD;;EAEA;AACJ;AACA;AACA;EACWoB,eAAeA,CAAA,EAAS;IAC3B,IAAI,IAAI,CAACH,oBAAoB,EAAE;MAC3BC,YAAY,CAAC,IAAI,CAACD,oBAAoB,CAAC;IAC3C;IAEA,IAAI,CAACI,aAAa,CAAC,CAAC;IACpB,IAAI,CAAC,IAAI,CAACf,UAAU,EAAE;IACtB,IAAI,IAAI,CAACR,MAAM,EAAE;MACb,IAAMwB,UAAU,GAAG,IAAI,CAAChB,UAAU,CAACzB,SAAS,GAAI,IAAI,CAACyB,UAAU,CAACiB,OAAO,GAAGC,IAAI,CAACC,GAAG,CAAC,CAAC;MACpF,IAAIH,UAAU,GAAG,CAAC,EAAE;QAChB,IAAI,CAACL,oBAAoB,GAAGS,UAAU,CAAC,MAAM;UACzC,IAAI,CAACN,eAAe,CAAC,CAAC;QAC1B,CAAC,EAAEE,UAAU,CAAC;MAClB;IACJ,CAAC,MAAM,IAAI,IAAI,CAAChB,UAAU,CAACzB,SAAS,GAAI2C,IAAI,CAACC,GAAG,CAAC,CAAC,EAAE;MAChD;MACA;MACA,IAAI,CAACR,oBAAoB,GAAGS,UAAU,CAAC,MAAM;QACzC,IAAI,CAACN,eAAe,CAAC,CAAC;MAC1B,CAAC,EAAE,IAAI,CAACd,UAAU,CAACzB,SAAS,GAAI2C,IAAI,CAACC,GAAG,CAAC,CAAC,CAAC;IAC/C;EACJ;;EAEA;AACJ;AACA;AACA;EACWE,YAAYA,CAACC,oBAAmC,EAAQ;IAAA,IAAAC,qBAAA;IAC3D;IACA,IAAI,CAAC,IAAI,CAAC/B,MAAM,EAAE;MACd;IACJ;IAEA,IAAMgC,mBAAmB,GAAGF,oBAAoB,CAACG,MAAM,CAAEhD,KAAK,IAAK;MAC/D,IAAMiD,OAAO,GAAGjD,KAAK,CAACyB,UAAU,CAAsB,CAAC;MACvD,IAAMyB,MAAM,GAAG5D,kBAAkB,CAAC2D,OAAO,CAAC;MAC1C,IAAI,CAACC,MAAM,CAACC,GAAG,IAAI,CAACD,MAAM,CAACpD,SAAS,EAAE,OAAO,KAAK,CAAC,CAAC;MACpD,IAAM;QAAEA;MAAU,CAAC,GAAGoD,MAAM;MAC5B,OACI,IAAI,CAAC1B,WAAW,CAAC1B,SAAS;MAC1B;MACAH,qBAAqB,CAAC,IAAI,CAAC6B,WAAW,CAAC1B,SAAS,EAAE,IAAI,CAAC0B,WAAW,CAACgB,OAAO,EAAE1C,SAAS,CAAC;MACtF;MACC,CAAC,IAAI,CAACc,mBAAmB,IAAId,SAAS,GAAG,IAAI,CAACc,mBAAmB,CAACd,SAAU,CAAC;IAEtF,CAAC,CAAC;IACF,IAAM4B,mBAAmB,IAAAoB,qBAAA,GAAGC,mBAAmB,CAACK,IAAI,CAAC5D,kCAAkC,CAAC,cAAAsD,qBAAA,uBAA5DA,qBAAA,CAA+D,CAAC,CAAC;IAE7F,IAAIpB,mBAAmB,EAAE;MACrB,IAAI,CAAClB,oBAAoB,GAAGkB,mBAAmB;MAC/C,IAAI,CAAChB,IAAI,CAAChB,WAAW,CAACiB,cAAc,EAAE,IAAI,CAACC,mBAAoB,CAAC;IACpE;EACJ;EAOQE,aAAaA,CAACd,KAAkB,EAAQ;IAC5C,IAAI,CAACwB,WAAW,GAAGjC,sBAAsB,CAACS,KAAK,CAACyB,UAAU,CAAC,CAAC,CAAC;IAC7D,IAAI,CAACa,aAAa,CAAC,CAAC;EACxB;EAEQA,aAAaA,CAAA,EAAS;IAC1B,IAAMe,YAAY,GAAG,IAAI,CAACtC,MAAM;;IAEhC;IACA;IACA;IACA;IACA,IAAI,CAAC,IAAI,CAACQ,UAAU,EAAE;IACtB,IAAM3B,cAAc,GAChB,IAAI,CAAC2B,UAAU,CAACzB,SAAS,GAAI2C,IAAI,CAACC,GAAG,CAAC,CAAC,GACjC,IAAI,CAACnB,UAAU,CAACzB,SAAS,GAAI,MAAM,CAAC,aACpC,IAAI,CAACyB,UAAU,CAACzB,SAAS;IACnC,IAAI,CAACkB,OAAO,GACR,CAAC,CAAC,IAAI,CAACQ,WAAW,CAAC8B,IAAI,IACvB,CAAC,CAAC1D,cAAc,IAChBD,qBAAqB,CAACC,cAAc,EAAE,IAAI,CAAC4B,WAAW,CAACgB,OAAO,EAAEC,IAAI,CAACC,GAAG,CAAC,CAAC,CAAC;IAE/E,IAAIW,YAAY,KAAK,IAAI,CAACtC,MAAM,EAAE;MAC9B,IAAI,CAACL,IAAI,CAAChB,WAAW,CAAC6D,cAAc,EAAE,IAAI,CAACxC,MAAM,EAAE,IAAI,CAAC;IAC5D;EACJ;AACJ","ignoreList":[]}

package/lib/models/compare-event-ordering.d.ts

@@ -0,0 +1,24 @@
+import { Room } from "./room.ts";
+/**
+ * Determine the order of two events in a room.
+ *
+ * In principle this should use the same order as the server, but in practice
+ * this is difficult for events that were not received over the Sync API. See
+ * MSC4033 for details.
+ *
+ * This implementation leans on the order of events within their timelines, and
+ * falls back to comparing event timestamps when they are in different
+ * timelines.
+ *
+ * See https://github.com/matrix-org/matrix-js-sdk/issues/3325 for where we are
+ * tracking the work to fix this.
+ *
+ * @param room - the room we are looking in
+ * @param leftEventId - the id of the first event
+ * @param rightEventId - the id of the second event
+
+ * @returns -1 if left \< right, 1 if left \> right, 0 if left == right, null if
+ *          we can't tell (because we can't find the events).
+ */
+export declare function compareEventOrdering(room: Room, leftEventId: string, rightEventId: string): number | null;
+//# sourceMappingURL=compare-event-ordering.d.ts.map

package/lib/models/compare-event-ordering.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"compare-event-ordering.d.ts","sourceRoot":"","sources":["../../src/models/compare-event-ordering.ts"],"names":[],"mappings":"AAiBA,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAGjC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAqBzG"}

package/lib/models/compare-event-ordering.js

@@ -0,0 +1,120 @@
+/*
+Copyright 2023 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 { inMainTimelineForReceipt, threadIdForReceipt } from "../client.js";
+
+/**
+ * Determine the order of two events in a room.
+ *
+ * In principle this should use the same order as the server, but in practice
+ * this is difficult for events that were not received over the Sync API. See
+ * MSC4033 for details.
+ *
+ * This implementation leans on the order of events within their timelines, and
+ * falls back to comparing event timestamps when they are in different
+ * timelines.
+ *
+ * See https://github.com/matrix-org/matrix-js-sdk/issues/3325 for where we are
+ * tracking the work to fix this.
+ *
+ * @param room - the room we are looking in
+ * @param leftEventId - the id of the first event
+ * @param rightEventId - the id of the second event
+
+ * @returns -1 if left \< right, 1 if left \> right, 0 if left == right, null if
+ *          we can't tell (because we can't find the events).
+ */
+export function compareEventOrdering(room, leftEventId, rightEventId) {
+  var leftEvent = room.findEventById(leftEventId);
+  var rightEvent = room.findEventById(rightEventId);
+  if (!leftEvent || !rightEvent) {
+    // Without the events themselves, we can't find their thread or
+    // timeline, or guess based on timestamp, so we just don't know.
+    return null;
+  }
+
+  // Check whether the events are in the main timeline
+  var isLeftEventInMainTimeline = inMainTimelineForReceipt(leftEvent);
+  var isRightEventInMainTimeline = inMainTimelineForReceipt(rightEvent);
+  if (isLeftEventInMainTimeline && isRightEventInMainTimeline) {
+    return compareEventsInMainTimeline(room, leftEventId, rightEventId, leftEvent, rightEvent);
+  } else {
+    // At least one event is not in the timeline, so we can't use the room's
+    // unfiltered timeline set.
+    return compareEventsInThreads(leftEventId, rightEventId, leftEvent, rightEvent);
+  }
+}
+function compareEventsInMainTimeline(room, leftEventId, rightEventId, leftEvent, rightEvent) {
+  // Get the timeline set that contains all the events.
+  var timelineSet = room.getUnfilteredTimelineSet();
+
+  // If they are in the same timeline, compareEventOrdering does what we need
+  var compareSameTimeline = timelineSet.compareEventOrdering(leftEventId, rightEventId);
+  if (compareSameTimeline !== null) {
+    return compareSameTimeline;
+  }
+
+  // Find which timeline each event is in. Refuse to provide an ordering if we
+  // can't find either of the events.
+
+  var leftTimeline = timelineSet.getTimelineForEvent(leftEventId);
+  if (leftTimeline === timelineSet.getLiveTimeline()) {
+    // The left event is part of the live timeline, so it must be after the
+    // right event (since they are not in the same timeline or we would have
+    // returned after compareEventOrdering.
+    return 1;
+  }
+  var rightTimeline = timelineSet.getTimelineForEvent(rightEventId);
+  if (rightTimeline === timelineSet.getLiveTimeline()) {
+    // The right event is part of the live timeline, so it must be after the
+    // left event.
+    return -1;
+  }
+
+  // They are in older timeline sets (because they were fetched by paging up).
+  return guessOrderBasedOnTimestamp(leftEvent, rightEvent);
+}
+function compareEventsInThreads(leftEventId, rightEventId, leftEvent, rightEvent) {
+  var leftEventThreadId = threadIdForReceipt(leftEvent);
+  var rightEventThreadId = threadIdForReceipt(rightEvent);
+  var leftThread = leftEvent.getThread();
+  if (leftThread && leftEventThreadId === rightEventThreadId) {
+    // They are in the same thread, so we can ask the thread's timeline to
+    // figure it out for us
+    return leftThread.timelineSet.compareEventOrdering(leftEventId, rightEventId);
+  } else {
+    return guessOrderBasedOnTimestamp(leftEvent, rightEvent);
+  }
+}
+
+/**
+ * Guess the order of events based on server timestamp. This is not good, but
+ * difficult to avoid without MSC4033.
+ *
+ * See https://github.com/matrix-org/matrix-js-sdk/issues/3325
+ */
+function guessOrderBasedOnTimestamp(leftEvent, rightEvent) {
+  var leftTs = leftEvent.getTs();
+  var rightTs = rightEvent.getTs();
+  if (leftTs < rightTs) {
+    return -1;
+  } else if (leftTs > rightTs) {
+    return 1;
+  } else {
+    return 0;
+  }
+}
+//# sourceMappingURL=compare-event-ordering.js.map

package/lib/models/compare-event-ordering.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"compare-event-ordering.js","names":["inMainTimelineForReceipt","threadIdForReceipt","compareEventOrdering","room","leftEventId","rightEventId","leftEvent","findEventById","rightEvent","isLeftEventInMainTimeline","isRightEventInMainTimeline","compareEventsInMainTimeline","compareEventsInThreads","timelineSet","getUnfilteredTimelineSet","compareSameTimeline","leftTimeline","getTimelineForEvent","getLiveTimeline","rightTimeline","guessOrderBasedOnTimestamp","leftEventThreadId","rightEventThreadId","leftThread","getThread","leftTs","getTs","rightTs"],"sources":["../../src/models/compare-event-ordering.ts"],"sourcesContent":["/*\nCopyright 2023 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 { MatrixEvent } from \"./event.ts\";\nimport { Room } from \"./room.ts\";\nimport { inMainTimelineForReceipt, threadIdForReceipt } from \"../client.ts\";\n\n/**\n * Determine the order of two events in a room.\n *\n * In principle this should use the same order as the server, but in practice\n * this is difficult for events that were not received over the Sync API. See\n * MSC4033 for details.\n *\n * This implementation leans on the order of events within their timelines, and\n * falls back to comparing event timestamps when they are in different\n * timelines.\n *\n * See https://github.com/matrix-org/matrix-js-sdk/issues/3325 for where we are\n * tracking the work to fix this.\n *\n * @param room - the room we are looking in\n * @param leftEventId - the id of the first event\n * @param rightEventId - the id of the second event\n\n * @returns -1 if left \\< right, 1 if left \\> right, 0 if left == right, null if\n *          we can't tell (because we can't find the events).\n */\nexport function compareEventOrdering(room: Room, leftEventId: string, rightEventId: string): number | null {\n    const leftEvent = room.findEventById(leftEventId);\n    const rightEvent = room.findEventById(rightEventId);\n\n    if (!leftEvent || !rightEvent) {\n        // Without the events themselves, we can't find their thread or\n        // timeline, or guess based on timestamp, so we just don't know.\n        return null;\n    }\n\n    // Check whether the events are in the main timeline\n    const isLeftEventInMainTimeline = inMainTimelineForReceipt(leftEvent);\n    const isRightEventInMainTimeline = inMainTimelineForReceipt(rightEvent);\n\n    if (isLeftEventInMainTimeline && isRightEventInMainTimeline) {\n        return compareEventsInMainTimeline(room, leftEventId, rightEventId, leftEvent, rightEvent);\n    } else {\n        // At least one event is not in the timeline, so we can't use the room's\n        // unfiltered timeline set.\n        return compareEventsInThreads(leftEventId, rightEventId, leftEvent, rightEvent);\n    }\n}\n\nfunction compareEventsInMainTimeline(\n    room: Room,\n    leftEventId: string,\n    rightEventId: string,\n    leftEvent: MatrixEvent,\n    rightEvent: MatrixEvent,\n): number | null {\n    // Get the timeline set that contains all the events.\n    const timelineSet = room.getUnfilteredTimelineSet();\n\n    // If they are in the same timeline, compareEventOrdering does what we need\n    const compareSameTimeline = timelineSet.compareEventOrdering(leftEventId, rightEventId);\n    if (compareSameTimeline !== null) {\n        return compareSameTimeline;\n    }\n\n    // Find which timeline each event is in. Refuse to provide an ordering if we\n    // can't find either of the events.\n\n    const leftTimeline = timelineSet.getTimelineForEvent(leftEventId);\n    if (leftTimeline === timelineSet.getLiveTimeline()) {\n        // The left event is part of the live timeline, so it must be after the\n        // right event (since they are not in the same timeline or we would have\n        // returned after compareEventOrdering.\n        return 1;\n    }\n\n    const rightTimeline = timelineSet.getTimelineForEvent(rightEventId);\n    if (rightTimeline === timelineSet.getLiveTimeline()) {\n        // The right event is part of the live timeline, so it must be after the\n        // left event.\n        return -1;\n    }\n\n    // They are in older timeline sets (because they were fetched by paging up).\n    return guessOrderBasedOnTimestamp(leftEvent, rightEvent);\n}\n\nfunction compareEventsInThreads(\n    leftEventId: string,\n    rightEventId: string,\n    leftEvent: MatrixEvent,\n    rightEvent: MatrixEvent,\n): number | null {\n    const leftEventThreadId = threadIdForReceipt(leftEvent);\n    const rightEventThreadId = threadIdForReceipt(rightEvent);\n\n    const leftThread = leftEvent.getThread();\n\n    if (leftThread && leftEventThreadId === rightEventThreadId) {\n        // They are in the same thread, so we can ask the thread's timeline to\n        // figure it out for us\n        return leftThread.timelineSet.compareEventOrdering(leftEventId, rightEventId);\n    } else {\n        return guessOrderBasedOnTimestamp(leftEvent, rightEvent);\n    }\n}\n\n/**\n * Guess the order of events based on server timestamp. This is not good, but\n * difficult to avoid without MSC4033.\n *\n * See https://github.com/matrix-org/matrix-js-sdk/issues/3325\n */\nfunction guessOrderBasedOnTimestamp(leftEvent: MatrixEvent, rightEvent: MatrixEvent): number {\n    const leftTs = leftEvent.getTs();\n    const rightTs = rightEvent.getTs();\n    if (leftTs < rightTs) {\n        return -1;\n    } else if (leftTs > rightTs) {\n        return 1;\n    } else {\n        return 0;\n    }\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAIA,SAASA,wBAAwB,EAAEC,kBAAkB,QAAQ,cAAc;;AAE3E;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,oBAAoBA,CAACC,IAAU,EAAEC,WAAmB,EAAEC,YAAoB,EAAiB;EACvG,IAAMC,SAAS,GAAGH,IAAI,CAACI,aAAa,CAACH,WAAW,CAAC;EACjD,IAAMI,UAAU,GAAGL,IAAI,CAACI,aAAa,CAACF,YAAY,CAAC;EAEnD,IAAI,CAACC,SAAS,IAAI,CAACE,UAAU,EAAE;IAC3B;IACA;IACA,OAAO,IAAI;EACf;;EAEA;EACA,IAAMC,yBAAyB,GAAGT,wBAAwB,CAACM,SAAS,CAAC;EACrE,IAAMI,0BAA0B,GAAGV,wBAAwB,CAACQ,UAAU,CAAC;EAEvE,IAAIC,yBAAyB,IAAIC,0BAA0B,EAAE;IACzD,OAAOC,2BAA2B,CAACR,IAAI,EAAEC,WAAW,EAAEC,YAAY,EAAEC,SAAS,EAAEE,UAAU,CAAC;EAC9F,CAAC,MAAM;IACH;IACA;IACA,OAAOI,sBAAsB,CAACR,WAAW,EAAEC,YAAY,EAAEC,SAAS,EAAEE,UAAU,CAAC;EACnF;AACJ;AAEA,SAASG,2BAA2BA,CAChCR,IAAU,EACVC,WAAmB,EACnBC,YAAoB,EACpBC,SAAsB,EACtBE,UAAuB,EACV;EACb;EACA,IAAMK,WAAW,GAAGV,IAAI,CAACW,wBAAwB,CAAC,CAAC;;EAEnD;EACA,IAAMC,mBAAmB,GAAGF,WAAW,CAACX,oBAAoB,CAACE,WAAW,EAAEC,YAAY,CAAC;EACvF,IAAIU,mBAAmB,KAAK,IAAI,EAAE;IAC9B,OAAOA,mBAAmB;EAC9B;;EAEA;EACA;;EAEA,IAAMC,YAAY,GAAGH,WAAW,CAACI,mBAAmB,CAACb,WAAW,CAAC;EACjE,IAAIY,YAAY,KAAKH,WAAW,CAACK,eAAe,CAAC,CAAC,EAAE;IAChD;IACA;IACA;IACA,OAAO,CAAC;EACZ;EAEA,IAAMC,aAAa,GAAGN,WAAW,CAACI,mBAAmB,CAACZ,YAAY,CAAC;EACnE,IAAIc,aAAa,KAAKN,WAAW,CAACK,eAAe,CAAC,CAAC,EAAE;IACjD;IACA;IACA,OAAO,CAAC,CAAC;EACb;;EAEA;EACA,OAAOE,0BAA0B,CAACd,SAAS,EAAEE,UAAU,CAAC;AAC5D;AAEA,SAASI,sBAAsBA,CAC3BR,WAAmB,EACnBC,YAAoB,EACpBC,SAAsB,EACtBE,UAAuB,EACV;EACb,IAAMa,iBAAiB,GAAGpB,kBAAkB,CAACK,SAAS,CAAC;EACvD,IAAMgB,kBAAkB,GAAGrB,kBAAkB,CAACO,UAAU,CAAC;EAEzD,IAAMe,UAAU,GAAGjB,SAAS,CAACkB,SAAS,CAAC,CAAC;EAExC,IAAID,UAAU,IAAIF,iBAAiB,KAAKC,kBAAkB,EAAE;IACxD;IACA;IACA,OAAOC,UAAU,CAACV,WAAW,CAACX,oBAAoB,CAACE,WAAW,EAAEC,YAAY,CAAC;EACjF,CAAC,MAAM;IACH,OAAOe,0BAA0B,CAACd,SAAS,EAAEE,UAAU,CAAC;EAC5D;AACJ;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,SAASY,0BAA0BA,CAACd,SAAsB,EAAEE,UAAuB,EAAU;EACzF,IAAMiB,MAAM,GAAGnB,SAAS,CAACoB,KAAK,CAAC,CAAC;EAChC,IAAMC,OAAO,GAAGnB,UAAU,CAACkB,KAAK,CAAC,CAAC;EAClC,IAAID,MAAM,GAAGE,OAAO,EAAE;IAClB,OAAO,CAAC,CAAC;EACb,CAAC,MAAM,IAAIF,MAAM,GAAGE,OAAO,EAAE;IACzB,OAAO,CAAC;EACZ,CAAC,MAAM;IACH,OAAO,CAAC;EACZ;AACJ","ignoreList":[]}

package/lib/models/device.d.ts

@@ -0,0 +1,45 @@
+/** State of the verification of the device. */
+export declare enum DeviceVerification {
+    Blocked = -1,
+    Unverified = 0,
+    Verified = 1
+}
+/** A map from user ID to device ID to Device */
+export type DeviceMap = Map<string, Map<string, Device>>;
+type DeviceParameters = Pick<Device, "deviceId" | "userId" | "algorithms" | "keys"> & Partial<Device>;
+/**
+ *  Information on a user's device, as returned by {@link Crypto.CryptoApi.getUserDeviceInfo}.
+ */
+export declare class Device {
+    /** id of the device */
+    readonly deviceId: string;
+    /** id of the user that owns the device */
+    readonly userId: string;
+    /** list of algorithms supported by this device */
+    readonly algorithms: string[];
+    /** a map from `<key type>:<id> -> <base64-encoded key>` */
+    readonly keys: Map<string, string>;
+    /** whether the device has been verified/blocked by the user */
+    readonly verified: DeviceVerification;
+    /** a map `<userId, map<algorithm:device_id, signature>>` */
+    readonly signatures: Map<string, Map<string, string>>;
+    /** display name of the device */
+    readonly displayName?: string;
+    /** whether the device is a dehydrated device */
+    readonly dehydrated: boolean;
+    constructor(opts: DeviceParameters);
+    /**
+     * Get the fingerprint for this device (ie, the Ed25519 key)
+     *
+     * @returns base64-encoded fingerprint of this device
+     */
+    getFingerprint(): string | undefined;
+    /**
+     * Get the identity key for this device (ie, the Curve25519 key)
+     *
+     * @returns base64-encoded identity key of this device
+     */
+    getIdentityKey(): string | undefined;
+}
+export {};
+//# sourceMappingURL=device.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"device.d.ts","sourceRoot":"","sources":["../../src/models/device.ts"],"names":[],"mappings":"AAgBA,+CAA+C;AAC/C,oBAAY,kBAAkB;IAC1B,OAAO,KAAK;IACZ,UAAU,IAAI;IACd,QAAQ,IAAI;CACf;AAED,gDAAgD;AAChD,MAAM,MAAM,SAAS,GAAG,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAEzD,KAAK,gBAAgB,GAAG,IAAI,CAAC,MAAM,EAAE,UAAU,GAAG,QAAQ,GAAG,YAAY,GAAG,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AAEtG;;GAEG;AACH,qBAAa,MAAM;IACf,uBAAuB;IACvB,SAAgB,QAAQ,EAAE,MAAM,CAAC;IAEjC,0CAA0C;IAC1C,SAAgB,MAAM,EAAE,MAAM,CAAC;IAE/B,kDAAkD;IAClD,SAAgB,UAAU,EAAE,MAAM,EAAE,CAAC;IAErC,2DAA2D;IAC3D,SAAgB,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAE1C,+DAA+D;IAC/D,SAAgB,QAAQ,EAAE,kBAAkB,CAAC;IAE7C,4DAA4D;IAC5D,SAAgB,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAE7D,iCAAiC;IACjC,SAAgB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErC,gDAAgD;IAChD,SAAgB,UAAU,EAAE,OAAO,CAAS;gBAEzB,IAAI,EAAE,gBAAgB;IAWzC;;;;OAIG;IACI,cAAc,IAAI,MAAM,GAAG,SAAS;IAI3C;;;;OAIG;IACI,cAAc,IAAI,MAAM,GAAG,SAAS;CAG9C"}

package/lib/models/device.js

@@ -0,0 +1,77 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+/*
+Copyright 2023 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.
+*/
+
+/** State of the verification of the device. */
+export var DeviceVerification = /*#__PURE__*/function (DeviceVerification) {
+  DeviceVerification[DeviceVerification["Blocked"] = -1] = "Blocked";
+  DeviceVerification[DeviceVerification["Unverified"] = 0] = "Unverified";
+  DeviceVerification[DeviceVerification["Verified"] = 1] = "Verified";
+  return DeviceVerification;
+}({});
+
+/** A map from user ID to device ID to Device */
+
+/**
+ *  Information on a user's device, as returned by {@link Crypto.CryptoApi.getUserDeviceInfo}.
+ */
+export class Device {
+  constructor(opts) {
+    /** id of the device */
+    _defineProperty(this, "deviceId", void 0);
+    /** id of the user that owns the device */
+    _defineProperty(this, "userId", void 0);
+    /** list of algorithms supported by this device */
+    _defineProperty(this, "algorithms", void 0);
+    /** a map from `<key type>:<id> -> <base64-encoded key>` */
+    _defineProperty(this, "keys", void 0);
+    /** whether the device has been verified/blocked by the user */
+    _defineProperty(this, "verified", void 0);
+    /** a map `<userId, map<algorithm:device_id, signature>>` */
+    _defineProperty(this, "signatures", void 0);
+    /** display name of the device */
+    _defineProperty(this, "displayName", void 0);
+    /** whether the device is a dehydrated device */
+    _defineProperty(this, "dehydrated", false);
+    this.deviceId = opts.deviceId;
+    this.userId = opts.userId;
+    this.algorithms = opts.algorithms;
+    this.keys = opts.keys;
+    this.verified = opts.verified || DeviceVerification.Unverified;
+    this.signatures = opts.signatures || new Map();
+    this.displayName = opts.displayName;
+    this.dehydrated = !!opts.dehydrated;
+  }
+
+  /**
+   * Get the fingerprint for this device (ie, the Ed25519 key)
+   *
+   * @returns base64-encoded fingerprint of this device
+   */
+  getFingerprint() {
+    return this.keys.get("ed25519:".concat(this.deviceId));
+  }
+
+  /**
+   * Get the identity key for this device (ie, the Curve25519 key)
+   *
+   * @returns base64-encoded identity key of this device
+   */
+  getIdentityKey() {
+    return this.keys.get("curve25519:".concat(this.deviceId));
+  }
+}
+//# sourceMappingURL=device.js.map

package/lib/models/device.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"device.js","names":["DeviceVerification","Device","constructor","opts","_defineProperty","deviceId","userId","algorithms","keys","verified","Unverified","signatures","Map","displayName","dehydrated","getFingerprint","get","concat","getIdentityKey"],"sources":["../../src/models/device.ts"],"sourcesContent":["/*\nCopyright 2023 The Matrix.org Foundation C.I.C.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\n/** State of the verification of the device. */\nexport enum DeviceVerification {\n    Blocked = -1,\n    Unverified = 0,\n    Verified = 1,\n}\n\n/** A map from user ID to device ID to Device */\nexport type DeviceMap = Map<string, Map<string, Device>>;\n\ntype DeviceParameters = Pick<Device, \"deviceId\" | \"userId\" | \"algorithms\" | \"keys\"> & Partial<Device>;\n\n/**\n *  Information on a user's device, as returned by {@link Crypto.CryptoApi.getUserDeviceInfo}.\n */\nexport class Device {\n    /** id of the device */\n    public readonly deviceId: string;\n\n    /** id of the user that owns the device */\n    public readonly userId: string;\n\n    /** list of algorithms supported by this device */\n    public readonly algorithms: string[];\n\n    /** a map from `<key type>:<id> -> <base64-encoded key>` */\n    public readonly keys: Map<string, string>;\n\n    /** whether the device has been verified/blocked by the user */\n    public readonly verified: DeviceVerification;\n\n    /** a map `<userId, map<algorithm:device_id, signature>>` */\n    public readonly signatures: Map<string, Map<string, string>>;\n\n    /** display name of the device */\n    public readonly displayName?: string;\n\n    /** whether the device is a dehydrated device */\n    public readonly dehydrated: boolean = false;\n\n    public constructor(opts: DeviceParameters) {\n        this.deviceId = opts.deviceId;\n        this.userId = opts.userId;\n        this.algorithms = opts.algorithms;\n        this.keys = opts.keys;\n        this.verified = opts.verified || DeviceVerification.Unverified;\n        this.signatures = opts.signatures || new Map();\n        this.displayName = opts.displayName;\n        this.dehydrated = !!opts.dehydrated;\n    }\n\n    /**\n     * Get the fingerprint for this device (ie, the Ed25519 key)\n     *\n     * @returns base64-encoded fingerprint of this device\n     */\n    public getFingerprint(): string | undefined {\n        return this.keys.get(`ed25519:${this.deviceId}`);\n    }\n\n    /**\n     * Get the identity key for this device (ie, the Curve25519 key)\n     *\n     * @returns base64-encoded identity key of this device\n     */\n    public getIdentityKey(): string | undefined {\n        return this.keys.get(`curve25519:${this.deviceId}`);\n    }\n}\n"],"mappings":";AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA,WAAYA,kBAAkB,0BAAlBA,kBAAkB;EAAlBA,kBAAkB,CAAlBA,kBAAkB;EAAlBA,kBAAkB,CAAlBA,kBAAkB;EAAlBA,kBAAkB,CAAlBA,kBAAkB;EAAA,OAAlBA,kBAAkB;AAAA;;AAM9B;;AAKA;AACA;AACA;AACA,OAAO,MAAMC,MAAM,CAAC;EAyBTC,WAAWA,CAACC,IAAsB,EAAE;IAxB3C;IAAAC,eAAA;IAGA;IAAAA,eAAA;IAGA;IAAAA,eAAA;IAGA;IAAAA,eAAA;IAGA;IAAAA,eAAA;IAGA;IAAAA,eAAA;IAGA;IAAAA,eAAA;IAGA;IAAAA,eAAA,qBACsC,KAAK;IAGvC,IAAI,CAACC,QAAQ,GAAGF,IAAI,CAACE,QAAQ;IAC7B,IAAI,CAACC,MAAM,GAAGH,IAAI,CAACG,MAAM;IACzB,IAAI,CAACC,UAAU,GAAGJ,IAAI,CAACI,UAAU;IACjC,IAAI,CAACC,IAAI,GAAGL,IAAI,CAACK,IAAI;IACrB,IAAI,CAACC,QAAQ,GAAGN,IAAI,CAACM,QAAQ,IAAIT,kBAAkB,CAACU,UAAU;IAC9D,IAAI,CAACC,UAAU,GAAGR,IAAI,CAACQ,UAAU,IAAI,IAAIC,GAAG,CAAC,CAAC;IAC9C,IAAI,CAACC,WAAW,GAAGV,IAAI,CAACU,WAAW;IACnC,IAAI,CAACC,UAAU,GAAG,CAAC,CAACX,IAAI,CAACW,UAAU;EACvC;;EAEA;AACJ;AACA;AACA;AACA;EACWC,cAAcA,CAAA,EAAuB;IACxC,OAAO,IAAI,CAACP,IAAI,CAACQ,GAAG,YAAAC,MAAA,CAAY,IAAI,CAACZ,QAAQ,CAAE,CAAC;EACpD;;EAEA;AACJ;AACA;AACA;AACA;EACWa,cAAcA,CAAA,EAAuB;IACxC,OAAO,IAAI,CAACV,IAAI,CAACQ,GAAG,eAAAC,MAAA,CAAe,IAAI,CAACZ,QAAQ,CAAE,CAAC;EACvD;AACJ","ignoreList":[]}

package/lib/models/event-context.d.ts

@@ -0,0 +1,62 @@
+import { MatrixEvent } from "./event.ts";
+export declare class EventContext {
+    readonly ourEvent: MatrixEvent;
+    private timeline;
+    private ourEventIndex;
+    private paginateTokens;
+    /**
+     * Construct a new EventContext
+     *
+     * An eventcontext is used for circumstances such as search results, when we
+     * have a particular event of interest, and a bunch of events before and after
+     * it.
+     *
+     * It also stores pagination tokens for going backwards and forwards in the
+     * timeline.
+     *
+     * @param ourEvent - the event at the centre of this context
+     */
+    constructor(ourEvent: MatrixEvent);
+    /**
+     * Get the main event of interest
+     *
+     * This is a convenience function for getTimeline()[getOurEventIndex()].
+     *
+     * @returns The event at the centre of this context.
+     */
+    getEvent(): MatrixEvent;
+    /**
+     * Get the list of events in this context
+     *
+     * @returns An array of MatrixEvents
+     */
+    getTimeline(): MatrixEvent[];
+    /**
+     * Get the index in the timeline of our event
+     */
+    getOurEventIndex(): number;
+    /**
+     * Get a pagination token.
+     *
+     * @param backwards -   true to get the pagination token for going
+     */
+    getPaginateToken(backwards?: boolean): string | null;
+    /**
+     * Set a pagination token.
+     *
+     * Generally this will be used only by the matrix js sdk.
+     *
+     * @param token -        pagination token
+     * @param backwards -   true to set the pagination token for going
+     *                                   backwards in time
+     */
+    setPaginateToken(token?: string, backwards?: boolean): void;
+    /**
+     * Add more events to the timeline
+     *
+     * @param events -      new events, in timeline order
+     * @param atStart -   true to insert new events at the start
+     */
+    addEvents(events: MatrixEvent[], atStart?: boolean): void;
+}
+//# sourceMappingURL=event-context.d.ts.map

package/lib/models/event-context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-context.d.ts","sourceRoot":"","sources":["../../src/models/event-context.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAGzC,qBAAa,YAAY;aAoBc,QAAQ,EAAE,WAAW;IAnBxD,OAAO,CAAC,QAAQ,CAAgB;IAChC,OAAO,CAAC,aAAa,CAAK;IAC1B,OAAO,CAAC,cAAc,CAGpB;IAEF;;;;;;;;;;;OAWG;gBACgC,QAAQ,EAAE,WAAW;IAIxD;;;;;;OAMG;IACI,QAAQ,IAAI,WAAW;IAI9B;;;;OAIG;IACI,WAAW,IAAI,WAAW,EAAE;IAInC;;OAEG;IACI,gBAAgB,IAAI,MAAM;IAIjC;;;;OAIG;IACI,gBAAgB,CAAC,SAAS,UAAQ,GAAG,MAAM,GAAG,IAAI;IAIzD;;;;;;;;OAQG;IACI,gBAAgB,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,SAAS,UAAQ,GAAG,IAAI;IAIhE;;;;;OAKG;IACI,SAAS,CAAC,MAAM,EAAE,WAAW,EAAE,EAAE,OAAO,UAAQ,GAAG,IAAI;CAWjE"}