@unwanted/matrix-sdk-mini 34.12.0-1

package/lib/models/poll.js

@@ -0,0 +1,241 @@
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+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.
+*/
+
+import { M_POLL_START } from "matrix-events-sdk";
+import { M_POLL_END, M_POLL_RESPONSE } from "../@types/polls.js";
+import { Relations } from "./relations.js";
+import { TypedEventEmitter } from "./typed-event-emitter.js";
+export var PollEvent = /*#__PURE__*/function (PollEvent) {
+  PollEvent["New"] = "Poll.new";
+  PollEvent["End"] = "Poll.end";
+  PollEvent["Update"] = "Poll.update";
+  PollEvent["Responses"] = "Poll.Responses";
+  PollEvent["Destroy"] = "Poll.Destroy";
+  PollEvent["UndecryptableRelations"] = "Poll.UndecryptableRelations";
+  return PollEvent;
+}({});
+var filterResponseRelations = (relationEvents, pollEndTimestamp) => {
+  var responseEvents = relationEvents.filter(event => {
+    if (event.isDecryptionFailure()) {
+      return;
+    }
+    return M_POLL_RESPONSE.matches(event.getType()) &&
+    // From MSC3381:
+    // "Votes sent on or before the end event's timestamp are valid votes"
+    event.getTs() <= pollEndTimestamp;
+  });
+  return {
+    responseEvents
+  };
+};
+export class Poll extends TypedEventEmitter {
+  constructor(rootEvent, matrixClient, room) {
+    super();
+    this.rootEvent = rootEvent;
+    this.matrixClient = matrixClient;
+    this.room = room;
+    _defineProperty(this, "roomId", void 0);
+    _defineProperty(this, "pollEvent", void 0);
+    _defineProperty(this, "_isFetchingResponses", false);
+    _defineProperty(this, "relationsNextBatch", void 0);
+    _defineProperty(this, "responses", null);
+    _defineProperty(this, "endEvent", void 0);
+    /**
+     * Keep track of undecryptable relations
+     * As incomplete result sets affect poll results
+     */
+    _defineProperty(this, "undecryptableRelationEventIds", new Set());
+    _defineProperty(this, "countUndecryptableEvents", events => {
+      var undecryptableEventIds = events.filter(event => event.isDecryptionFailure()).map(event => event.getId());
+      var previousCount = this.undecryptableRelationsCount;
+      this.undecryptableRelationEventIds = new Set([...this.undecryptableRelationEventIds, ...undecryptableEventIds]);
+      if (this.undecryptableRelationsCount !== previousCount) {
+        this.emit(PollEvent.UndecryptableRelations, this.undecryptableRelationsCount);
+      }
+    });
+    if (!this.rootEvent.getRoomId() || !this.rootEvent.getId()) {
+      throw new Error("Invalid poll start event.");
+    }
+    this.roomId = this.rootEvent.getRoomId();
+    this.pollEvent = this.rootEvent.unstableExtensibleEvent;
+  }
+  get pollId() {
+    return this.rootEvent.getId();
+  }
+  get endEventId() {
+    var _this$endEvent;
+    return (_this$endEvent = this.endEvent) === null || _this$endEvent === void 0 ? void 0 : _this$endEvent.getId();
+  }
+  get isEnded() {
+    return !!this.endEvent;
+  }
+  get isFetchingResponses() {
+    return this._isFetchingResponses;
+  }
+  get undecryptableRelationsCount() {
+    return this.undecryptableRelationEventIds.size;
+  }
+  getResponses() {
+    var _this = this;
+    return _asyncToGenerator(function* () {
+      // if we have already fetched some responses
+      // just return them
+      if (_this.responses) {
+        return _this.responses;
+      }
+
+      // if there is no fetching in progress
+      // start fetching
+      if (!_this.isFetchingResponses) {
+        yield _this.fetchResponses();
+      }
+      // return whatever responses we got from the first page
+      return _this.responses;
+    })();
+  }
+
+  /**
+   *
+   * @param event - event with a relation to the rootEvent
+   * @returns void
+   */
+  onNewRelation(event) {
+    var _this$endEvent2;
+    if (M_POLL_END.matches(event.getType()) && this.validateEndEvent(event)) {
+      this.endEvent = event;
+      this.refilterResponsesOnEnd();
+      this.emit(PollEvent.End);
+    }
+
+    // wait for poll responses to be initialised
+    if (!this.responses) {
+      return;
+    }
+    var pollEndTimestamp = ((_this$endEvent2 = this.endEvent) === null || _this$endEvent2 === void 0 ? void 0 : _this$endEvent2.getTs()) || Number.MAX_SAFE_INTEGER;
+    var {
+      responseEvents
+    } = filterResponseRelations([event], pollEndTimestamp);
+    this.countUndecryptableEvents([event]);
+    if (responseEvents.length) {
+      responseEvents.forEach(event => {
+        this.responses.addEvent(event);
+      });
+      this.emit(PollEvent.Responses, this.responses);
+    }
+  }
+  fetchResponses() {
+    var _this2 = this;
+    return _asyncToGenerator(function* () {
+      var _this2$endEvent, _allRelations$nextBat;
+      _this2._isFetchingResponses = true;
+
+      // we want:
+      // - stable and unstable M_POLL_RESPONSE
+      // - stable and unstable M_POLL_END
+      // so make one api call and filter by event type client side
+      var allRelations = yield _this2.matrixClient.relations(_this2.roomId, _this2.rootEvent.getId(), "m.reference", undefined, {
+        from: _this2.relationsNextBatch || undefined
+      });
+      yield Promise.all(allRelations.events.map(event => _this2.matrixClient.decryptEventIfNeeded(event)));
+      var responses = _this2.responses || new Relations("m.reference", M_POLL_RESPONSE.name, _this2.matrixClient, [M_POLL_RESPONSE.altName]);
+      var pollEndEvent = allRelations.events.find(event => M_POLL_END.matches(event.getType()));
+      if (_this2.validateEndEvent(pollEndEvent)) {
+        _this2.endEvent = pollEndEvent;
+        _this2.refilterResponsesOnEnd();
+        _this2.emit(PollEvent.End);
+      }
+      var pollCloseTimestamp = ((_this2$endEvent = _this2.endEvent) === null || _this2$endEvent === void 0 ? void 0 : _this2$endEvent.getTs()) || Number.MAX_SAFE_INTEGER;
+      var {
+        responseEvents
+      } = filterResponseRelations(allRelations.events, pollCloseTimestamp);
+      responseEvents.forEach(event => {
+        responses.addEvent(event);
+      });
+      _this2.relationsNextBatch = (_allRelations$nextBat = allRelations.nextBatch) !== null && _allRelations$nextBat !== void 0 ? _allRelations$nextBat : undefined;
+      _this2.responses = responses;
+      _this2.countUndecryptableEvents(allRelations.events);
+
+      // while there are more pages of relations
+      // fetch them
+      if (_this2.relationsNextBatch) {
+        // don't await
+        // we want to return the first page as soon as possible
+        _this2.fetchResponses();
+      } else {
+        // no more pages
+        _this2._isFetchingResponses = false;
+      }
+
+      // emit after updating _isFetchingResponses state
+      _this2.emit(PollEvent.Responses, _this2.responses);
+    })();
+  }
+
+  /**
+   * Only responses made before the poll ended are valid
+   * Refilter after an end event is recieved
+   * To ensure responses are valid
+   */
+  refilterResponsesOnEnd() {
+    var _this$endEvent3;
+    if (!this.responses) {
+      return;
+    }
+    var pollEndTimestamp = ((_this$endEvent3 = this.endEvent) === null || _this$endEvent3 === void 0 ? void 0 : _this$endEvent3.getTs()) || Number.MAX_SAFE_INTEGER;
+    this.responses.getRelations().forEach(event => {
+      if (event.getTs() > pollEndTimestamp) {
+        var _this$responses;
+        (_this$responses = this.responses) === null || _this$responses === void 0 || _this$responses.removeEvent(event);
+      }
+    });
+    this.emit(PollEvent.Responses, this.responses);
+  }
+  validateEndEvent(endEvent) {
+    if (!endEvent) {
+      return false;
+    }
+    /**
+     * Repeated end events are ignored -
+     * only the first (valid) closure event by origin_server_ts is counted.
+     */
+    if (this.endEvent && this.endEvent.getTs() < endEvent.getTs()) {
+      return false;
+    }
+
+    /**
+     * MSC3381
+     * If a m.poll.end event is received from someone other than the poll creator or user with permission to redact
+     * others' messages in the room, the event must be ignored by clients due to being invalid.
+     */
+    var roomCurrentState = this.room.currentState;
+    var endEventSender = endEvent.getSender();
+    return !!endEventSender && (endEventSender === this.rootEvent.getSender() || roomCurrentState.maySendRedactionForEvent(this.rootEvent, endEventSender));
+  }
+}
+
+/**
+ * Tests whether the event is a start, response or end poll event.
+ *
+ * @param event - Event to test
+ * @returns true if the event is a poll event, else false
+ */
+export var isPollEvent = event => {
+  var eventType = event.getType();
+  return M_POLL_START.matches(eventType) || M_POLL_RESPONSE.matches(eventType) || M_POLL_END.matches(eventType);
+};
+//# sourceMappingURL=poll.js.map

package/lib/models/poll.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"poll.js","names":["M_POLL_START","M_POLL_END","M_POLL_RESPONSE","Relations","TypedEventEmitter","PollEvent","filterResponseRelations","relationEvents","pollEndTimestamp","responseEvents","filter","event","isDecryptionFailure","matches","getType","getTs","Poll","constructor","rootEvent","matrixClient","room","_defineProperty","Set","events","undecryptableEventIds","map","getId","previousCount","undecryptableRelationsCount","undecryptableRelationEventIds","emit","UndecryptableRelations","getRoomId","Error","roomId","pollEvent","unstableExtensibleEvent","pollId","endEventId","_this$endEvent","endEvent","isEnded","isFetchingResponses","_isFetchingResponses","size","getResponses","_this","_asyncToGenerator","responses","fetchResponses","onNewRelation","_this$endEvent2","validateEndEvent","refilterResponsesOnEnd","End","Number","MAX_SAFE_INTEGER","countUndecryptableEvents","length","forEach","addEvent","Responses","_this2","_this2$endEvent","_allRelations$nextBat","allRelations","relations","undefined","from","relationsNextBatch","Promise","all","decryptEventIfNeeded","name","altName","pollEndEvent","find","pollCloseTimestamp","nextBatch","_this$endEvent3","getRelations","_this$responses","removeEvent","roomCurrentState","currentState","endEventSender","getSender","maySendRedactionForEvent","isPollEvent","eventType"],"sources":["../../src/models/poll.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 { M_POLL_START } from \"matrix-events-sdk\";\n\nimport { M_POLL_END, M_POLL_RESPONSE } from \"../@types/polls.ts\";\nimport { MatrixClient } from \"../client.ts\";\nimport { PollStartEvent } from \"../extensible_events_v1/PollStartEvent.ts\";\nimport { MatrixEvent } from \"./event.ts\";\nimport { Relations } from \"./relations.ts\";\nimport { Room } from \"./room.ts\";\nimport { TypedEventEmitter } from \"./typed-event-emitter.ts\";\n\nexport enum PollEvent {\n    New = \"Poll.new\",\n    End = \"Poll.end\",\n    Update = \"Poll.update\",\n    Responses = \"Poll.Responses\",\n    Destroy = \"Poll.Destroy\",\n    UndecryptableRelations = \"Poll.UndecryptableRelations\",\n}\n\nexport type PollEventHandlerMap = {\n    [PollEvent.Update]: (event: MatrixEvent, poll: Poll) => void;\n    [PollEvent.Destroy]: (pollIdentifier: string) => void;\n    [PollEvent.End]: () => void;\n    [PollEvent.Responses]: (responses: Relations) => void;\n    [PollEvent.UndecryptableRelations]: (count: number) => void;\n};\n\nconst filterResponseRelations = (\n    relationEvents: MatrixEvent[],\n    pollEndTimestamp: number,\n): {\n    responseEvents: MatrixEvent[];\n} => {\n    const responseEvents = relationEvents.filter((event) => {\n        if (event.isDecryptionFailure()) {\n            return;\n        }\n        return (\n            M_POLL_RESPONSE.matches(event.getType()) &&\n            // From MSC3381:\n            // \"Votes sent on or before the end event's timestamp are valid votes\"\n            event.getTs() <= pollEndTimestamp\n        );\n    });\n\n    return { responseEvents };\n};\n\nexport class Poll extends TypedEventEmitter<Exclude<PollEvent, PollEvent.New>, PollEventHandlerMap> {\n    public readonly roomId: string;\n    public readonly pollEvent: PollStartEvent;\n    private _isFetchingResponses = false;\n    private relationsNextBatch: string | undefined;\n    private responses: null | Relations = null;\n    private endEvent: MatrixEvent | undefined;\n    /**\n     * Keep track of undecryptable relations\n     * As incomplete result sets affect poll results\n     */\n    private undecryptableRelationEventIds = new Set<string>();\n\n    public constructor(\n        public readonly rootEvent: MatrixEvent,\n        private matrixClient: MatrixClient,\n        private room: Room,\n    ) {\n        super();\n        if (!this.rootEvent.getRoomId() || !this.rootEvent.getId()) {\n            throw new Error(\"Invalid poll start event.\");\n        }\n        this.roomId = this.rootEvent.getRoomId()!;\n        this.pollEvent = this.rootEvent.unstableExtensibleEvent as unknown as PollStartEvent;\n    }\n\n    public get pollId(): string {\n        return this.rootEvent.getId()!;\n    }\n\n    public get endEventId(): string | undefined {\n        return this.endEvent?.getId();\n    }\n\n    public get isEnded(): boolean {\n        return !!this.endEvent;\n    }\n\n    public get isFetchingResponses(): boolean {\n        return this._isFetchingResponses;\n    }\n\n    public get undecryptableRelationsCount(): number {\n        return this.undecryptableRelationEventIds.size;\n    }\n\n    public async getResponses(): Promise<Relations> {\n        // if we have already fetched some responses\n        // just return them\n        if (this.responses) {\n            return this.responses;\n        }\n\n        // if there is no fetching in progress\n        // start fetching\n        if (!this.isFetchingResponses) {\n            await this.fetchResponses();\n        }\n        // return whatever responses we got from the first page\n        return this.responses!;\n    }\n\n    /**\n     *\n     * @param event - event with a relation to the rootEvent\n     * @returns void\n     */\n    public onNewRelation(event: MatrixEvent): void {\n        if (M_POLL_END.matches(event.getType()) && this.validateEndEvent(event)) {\n            this.endEvent = event;\n            this.refilterResponsesOnEnd();\n            this.emit(PollEvent.End);\n        }\n\n        // wait for poll responses to be initialised\n        if (!this.responses) {\n            return;\n        }\n\n        const pollEndTimestamp = this.endEvent?.getTs() || Number.MAX_SAFE_INTEGER;\n        const { responseEvents } = filterResponseRelations([event], pollEndTimestamp);\n\n        this.countUndecryptableEvents([event]);\n\n        if (responseEvents.length) {\n            responseEvents.forEach((event) => {\n                this.responses!.addEvent(event);\n            });\n\n            this.emit(PollEvent.Responses, this.responses);\n        }\n    }\n\n    private async fetchResponses(): Promise<void> {\n        this._isFetchingResponses = true;\n\n        // we want:\n        // - stable and unstable M_POLL_RESPONSE\n        // - stable and unstable M_POLL_END\n        // so make one api call and filter by event type client side\n        const allRelations = await this.matrixClient.relations(\n            this.roomId,\n            this.rootEvent.getId()!,\n            \"m.reference\",\n            undefined,\n            {\n                from: this.relationsNextBatch || undefined,\n            },\n        );\n\n        await Promise.all(allRelations.events.map((event) => this.matrixClient.decryptEventIfNeeded(event)));\n\n        const responses =\n            this.responses ||\n            new Relations(\"m.reference\", M_POLL_RESPONSE.name, this.matrixClient, [M_POLL_RESPONSE.altName!]);\n\n        const pollEndEvent = allRelations.events.find((event) => M_POLL_END.matches(event.getType()));\n\n        if (this.validateEndEvent(pollEndEvent)) {\n            this.endEvent = pollEndEvent;\n            this.refilterResponsesOnEnd();\n            this.emit(PollEvent.End);\n        }\n\n        const pollCloseTimestamp = this.endEvent?.getTs() || Number.MAX_SAFE_INTEGER;\n\n        const { responseEvents } = filterResponseRelations(allRelations.events, pollCloseTimestamp);\n\n        responseEvents.forEach((event) => {\n            responses.addEvent(event);\n        });\n\n        this.relationsNextBatch = allRelations.nextBatch ?? undefined;\n        this.responses = responses;\n        this.countUndecryptableEvents(allRelations.events);\n\n        // while there are more pages of relations\n        // fetch them\n        if (this.relationsNextBatch) {\n            // don't await\n            // we want to return the first page as soon as possible\n            this.fetchResponses();\n        } else {\n            // no more pages\n            this._isFetchingResponses = false;\n        }\n\n        // emit after updating _isFetchingResponses state\n        this.emit(PollEvent.Responses, this.responses);\n    }\n\n    /**\n     * Only responses made before the poll ended are valid\n     * Refilter after an end event is recieved\n     * To ensure responses are valid\n     */\n    private refilterResponsesOnEnd(): void {\n        if (!this.responses) {\n            return;\n        }\n\n        const pollEndTimestamp = this.endEvent?.getTs() || Number.MAX_SAFE_INTEGER;\n        this.responses.getRelations().forEach((event) => {\n            if (event.getTs() > pollEndTimestamp) {\n                this.responses?.removeEvent(event);\n            }\n        });\n\n        this.emit(PollEvent.Responses, this.responses);\n    }\n\n    private countUndecryptableEvents = (events: MatrixEvent[]): void => {\n        const undecryptableEventIds = events\n            .filter((event) => event.isDecryptionFailure())\n            .map((event) => event.getId()!);\n\n        const previousCount = this.undecryptableRelationsCount;\n        this.undecryptableRelationEventIds = new Set([...this.undecryptableRelationEventIds, ...undecryptableEventIds]);\n\n        if (this.undecryptableRelationsCount !== previousCount) {\n            this.emit(PollEvent.UndecryptableRelations, this.undecryptableRelationsCount);\n        }\n    };\n\n    private validateEndEvent(endEvent?: MatrixEvent): boolean {\n        if (!endEvent) {\n            return false;\n        }\n        /**\n         * Repeated end events are ignored -\n         * only the first (valid) closure event by origin_server_ts is counted.\n         */\n        if (this.endEvent && this.endEvent.getTs() < endEvent.getTs()) {\n            return false;\n        }\n\n        /**\n         * MSC3381\n         * If a m.poll.end event is received from someone other than the poll creator or user with permission to redact\n         * others' messages in the room, the event must be ignored by clients due to being invalid.\n         */\n        const roomCurrentState = this.room.currentState;\n        const endEventSender = endEvent.getSender();\n        return (\n            !!endEventSender &&\n            (endEventSender === this.rootEvent.getSender() ||\n                roomCurrentState.maySendRedactionForEvent(this.rootEvent, endEventSender))\n        );\n    }\n}\n\n/**\n * Tests whether the event is a start, response or end poll event.\n *\n * @param event - Event to test\n * @returns true if the event is a poll event, else false\n */\nexport const isPollEvent = (event: MatrixEvent): boolean => {\n    const eventType = event.getType();\n    return M_POLL_START.matches(eventType) || M_POLL_RESPONSE.matches(eventType) || M_POLL_END.matches(eventType);\n};\n"],"mappings":";;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,YAAY,QAAQ,mBAAmB;AAEhD,SAASC,UAAU,EAAEC,eAAe,QAAQ,oBAAoB;AAIhE,SAASC,SAAS,QAAQ,gBAAgB;AAE1C,SAASC,iBAAiB,QAAQ,0BAA0B;AAE5D,WAAYC,SAAS,0BAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAAA,OAATA,SAAS;AAAA;AAiBrB,IAAMC,uBAAuB,GAAGA,CAC5BC,cAA6B,EAC7BC,gBAAwB,KAGvB;EACD,IAAMC,cAAc,GAAGF,cAAc,CAACG,MAAM,CAAEC,KAAK,IAAK;IACpD,IAAIA,KAAK,CAACC,mBAAmB,CAAC,CAAC,EAAE;MAC7B;IACJ;IACA,OACIV,eAAe,CAACW,OAAO,CAACF,KAAK,CAACG,OAAO,CAAC,CAAC,CAAC;IACxC;IACA;IACAH,KAAK,CAACI,KAAK,CAAC,CAAC,IAAIP,gBAAgB;EAEzC,CAAC,CAAC;EAEF,OAAO;IAAEC;EAAe,CAAC;AAC7B,CAAC;AAED,OAAO,MAAMO,IAAI,SAASZ,iBAAiB,CAAyD;EAazFa,WAAWA,CACEC,SAAsB,EAC9BC,YAA0B,EAC1BC,IAAU,EACpB;IACE,KAAK,CAAC,CAAC;IAAC,KAJQF,SAAsB,GAAtBA,SAAsB;IAAA,KAC9BC,YAA0B,GAA1BA,YAA0B;IAAA,KAC1BC,IAAU,GAAVA,IAAU;IAAAC,eAAA;IAAAA,eAAA;IAAAA,eAAA,+BAbS,KAAK;IAAAA,eAAA;IAAAA,eAAA,oBAEE,IAAI;IAAAA,eAAA;IAE1C;AACJ;AACA;AACA;IAHIA,eAAA,wCAIwC,IAAIC,GAAG,CAAS,CAAC;IAAAD,eAAA,mCAgKrBE,MAAqB,IAAW;MAChE,IAAMC,qBAAqB,GAAGD,MAAM,CAC/Bb,MAAM,CAAEC,KAAK,IAAKA,KAAK,CAACC,mBAAmB,CAAC,CAAC,CAAC,CAC9Ca,GAAG,CAAEd,KAAK,IAAKA,KAAK,CAACe,KAAK,CAAC,CAAE,CAAC;MAEnC,IAAMC,aAAa,GAAG,IAAI,CAACC,2BAA2B;MACtD,IAAI,CAACC,6BAA6B,GAAG,IAAIP,GAAG,CAAC,CAAC,GAAG,IAAI,CAACO,6BAA6B,EAAE,GAAGL,qBAAqB,CAAC,CAAC;MAE/G,IAAI,IAAI,CAACI,2BAA2B,KAAKD,aAAa,EAAE;QACpD,IAAI,CAACG,IAAI,CAACzB,SAAS,CAAC0B,sBAAsB,EAAE,IAAI,CAACH,2BAA2B,CAAC;MACjF;IACJ,CAAC;IAnKG,IAAI,CAAC,IAAI,CAACV,SAAS,CAACc,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAACd,SAAS,CAACQ,KAAK,CAAC,CAAC,EAAE;MACxD,MAAM,IAAIO,KAAK,CAAC,2BAA2B,CAAC;IAChD;IACA,IAAI,CAACC,MAAM,GAAG,IAAI,CAAChB,SAAS,CAACc,SAAS,CAAC,CAAE;IACzC,IAAI,CAACG,SAAS,GAAG,IAAI,CAACjB,SAAS,CAACkB,uBAAoD;EACxF;EAEA,IAAWC,MAAMA,CAAA,EAAW;IACxB,OAAO,IAAI,CAACnB,SAAS,CAACQ,KAAK,CAAC,CAAC;EACjC;EAEA,IAAWY,UAAUA,CAAA,EAAuB;IAAA,IAAAC,cAAA;IACxC,QAAAA,cAAA,GAAO,IAAI,CAACC,QAAQ,cAAAD,cAAA,uBAAbA,cAAA,CAAeb,KAAK,CAAC,CAAC;EACjC;EAEA,IAAWe,OAAOA,CAAA,EAAY;IAC1B,OAAO,CAAC,CAAC,IAAI,CAACD,QAAQ;EAC1B;EAEA,IAAWE,mBAAmBA,CAAA,EAAY;IACtC,OAAO,IAAI,CAACC,oBAAoB;EACpC;EAEA,IAAWf,2BAA2BA,CAAA,EAAW;IAC7C,OAAO,IAAI,CAACC,6BAA6B,CAACe,IAAI;EAClD;EAEaC,YAAYA,CAAA,EAAuB;IAAA,IAAAC,KAAA;IAAA,OAAAC,iBAAA;MAC5C;MACA;MACA,IAAID,KAAI,CAACE,SAAS,EAAE;QAChB,OAAOF,KAAI,CAACE,SAAS;MACzB;;MAEA;MACA;MACA,IAAI,CAACF,KAAI,CAACJ,mBAAmB,EAAE;QAC3B,MAAMI,KAAI,CAACG,cAAc,CAAC,CAAC;MAC/B;MACA;MACA,OAAOH,KAAI,CAACE,SAAS;IAAE;EAC3B;;EAEA;AACJ;AACA;AACA;AACA;EACWE,aAAaA,CAACvC,KAAkB,EAAQ;IAAA,IAAAwC,eAAA;IAC3C,IAAIlD,UAAU,CAACY,OAAO,CAACF,KAAK,CAACG,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,CAACsC,gBAAgB,CAACzC,KAAK,CAAC,EAAE;MACrE,IAAI,CAAC6B,QAAQ,GAAG7B,KAAK;MACrB,IAAI,CAAC0C,sBAAsB,CAAC,CAAC;MAC7B,IAAI,CAACvB,IAAI,CAACzB,SAAS,CAACiD,GAAG,CAAC;IAC5B;;IAEA;IACA,IAAI,CAAC,IAAI,CAACN,SAAS,EAAE;MACjB;IACJ;IAEA,IAAMxC,gBAAgB,GAAG,EAAA2C,eAAA,OAAI,CAACX,QAAQ,cAAAW,eAAA,uBAAbA,eAAA,CAAepC,KAAK,CAAC,CAAC,KAAIwC,MAAM,CAACC,gBAAgB;IAC1E,IAAM;MAAE/C;IAAe,CAAC,GAAGH,uBAAuB,CAAC,CAACK,KAAK,CAAC,EAAEH,gBAAgB,CAAC;IAE7E,IAAI,CAACiD,wBAAwB,CAAC,CAAC9C,KAAK,CAAC,CAAC;IAEtC,IAAIF,cAAc,CAACiD,MAAM,EAAE;MACvBjD,cAAc,CAACkD,OAAO,CAAEhD,KAAK,IAAK;QAC9B,IAAI,CAACqC,SAAS,CAAEY,QAAQ,CAACjD,KAAK,CAAC;MACnC,CAAC,CAAC;MAEF,IAAI,CAACmB,IAAI,CAACzB,SAAS,CAACwD,SAAS,EAAE,IAAI,CAACb,SAAS,CAAC;IAClD;EACJ;EAEcC,cAAcA,CAAA,EAAkB;IAAA,IAAAa,MAAA;IAAA,OAAAf,iBAAA;MAAA,IAAAgB,eAAA,EAAAC,qBAAA;MAC1CF,MAAI,CAACnB,oBAAoB,GAAG,IAAI;;MAEhC;MACA;MACA;MACA;MACA,IAAMsB,YAAY,SAASH,MAAI,CAAC3C,YAAY,CAAC+C,SAAS,CAClDJ,MAAI,CAAC5B,MAAM,EACX4B,MAAI,CAAC5C,SAAS,CAACQ,KAAK,CAAC,CAAC,EACtB,aAAa,EACbyC,SAAS,EACT;QACIC,IAAI,EAAEN,MAAI,CAACO,kBAAkB,IAAIF;MACrC,CACJ,CAAC;MAED,MAAMG,OAAO,CAACC,GAAG,CAACN,YAAY,CAAC1C,MAAM,CAACE,GAAG,CAAEd,KAAK,IAAKmD,MAAI,CAAC3C,YAAY,CAACqD,oBAAoB,CAAC7D,KAAK,CAAC,CAAC,CAAC;MAEpG,IAAMqC,SAAS,GACXc,MAAI,CAACd,SAAS,IACd,IAAI7C,SAAS,CAAC,aAAa,EAAED,eAAe,CAACuE,IAAI,EAAEX,MAAI,CAAC3C,YAAY,EAAE,CAACjB,eAAe,CAACwE,OAAO,CAAE,CAAC;MAErG,IAAMC,YAAY,GAAGV,YAAY,CAAC1C,MAAM,CAACqD,IAAI,CAAEjE,KAAK,IAAKV,UAAU,CAACY,OAAO,CAACF,KAAK,CAACG,OAAO,CAAC,CAAC,CAAC,CAAC;MAE7F,IAAIgD,MAAI,CAACV,gBAAgB,CAACuB,YAAY,CAAC,EAAE;QACrCb,MAAI,CAACtB,QAAQ,GAAGmC,YAAY;QAC5Bb,MAAI,CAACT,sBAAsB,CAAC,CAAC;QAC7BS,MAAI,CAAChC,IAAI,CAACzB,SAAS,CAACiD,GAAG,CAAC;MAC5B;MAEA,IAAMuB,kBAAkB,GAAG,EAAAd,eAAA,GAAAD,MAAI,CAACtB,QAAQ,cAAAuB,eAAA,uBAAbA,eAAA,CAAehD,KAAK,CAAC,CAAC,KAAIwC,MAAM,CAACC,gBAAgB;MAE5E,IAAM;QAAE/C;MAAe,CAAC,GAAGH,uBAAuB,CAAC2D,YAAY,CAAC1C,MAAM,EAAEsD,kBAAkB,CAAC;MAE3FpE,cAAc,CAACkD,OAAO,CAAEhD,KAAK,IAAK;QAC9BqC,SAAS,CAACY,QAAQ,CAACjD,KAAK,CAAC;MAC7B,CAAC,CAAC;MAEFmD,MAAI,CAACO,kBAAkB,IAAAL,qBAAA,GAAGC,YAAY,CAACa,SAAS,cAAAd,qBAAA,cAAAA,qBAAA,GAAIG,SAAS;MAC7DL,MAAI,CAACd,SAAS,GAAGA,SAAS;MAC1Bc,MAAI,CAACL,wBAAwB,CAACQ,YAAY,CAAC1C,MAAM,CAAC;;MAElD;MACA;MACA,IAAIuC,MAAI,CAACO,kBAAkB,EAAE;QACzB;QACA;QACAP,MAAI,CAACb,cAAc,CAAC,CAAC;MACzB,CAAC,MAAM;QACH;QACAa,MAAI,CAACnB,oBAAoB,GAAG,KAAK;MACrC;;MAEA;MACAmB,MAAI,CAAChC,IAAI,CAACzB,SAAS,CAACwD,SAAS,EAAEC,MAAI,CAACd,SAAS,CAAC;IAAC;EACnD;;EAEA;AACJ;AACA;AACA;AACA;EACYK,sBAAsBA,CAAA,EAAS;IAAA,IAAA0B,eAAA;IACnC,IAAI,CAAC,IAAI,CAAC/B,SAAS,EAAE;MACjB;IACJ;IAEA,IAAMxC,gBAAgB,GAAG,EAAAuE,eAAA,OAAI,CAACvC,QAAQ,cAAAuC,eAAA,uBAAbA,eAAA,CAAehE,KAAK,CAAC,CAAC,KAAIwC,MAAM,CAACC,gBAAgB;IAC1E,IAAI,CAACR,SAAS,CAACgC,YAAY,CAAC,CAAC,CAACrB,OAAO,CAAEhD,KAAK,IAAK;MAC7C,IAAIA,KAAK,CAACI,KAAK,CAAC,CAAC,GAAGP,gBAAgB,EAAE;QAAA,IAAAyE,eAAA;QAClC,CAAAA,eAAA,OAAI,CAACjC,SAAS,cAAAiC,eAAA,eAAdA,eAAA,CAAgBC,WAAW,CAACvE,KAAK,CAAC;MACtC;IACJ,CAAC,CAAC;IAEF,IAAI,CAACmB,IAAI,CAACzB,SAAS,CAACwD,SAAS,EAAE,IAAI,CAACb,SAAS,CAAC;EAClD;EAeQI,gBAAgBA,CAACZ,QAAsB,EAAW;IACtD,IAAI,CAACA,QAAQ,EAAE;MACX,OAAO,KAAK;IAChB;IACA;AACR;AACA;AACA;IACQ,IAAI,IAAI,CAACA,QAAQ,IAAI,IAAI,CAACA,QAAQ,CAACzB,KAAK,CAAC,CAAC,GAAGyB,QAAQ,CAACzB,KAAK,CAAC,CAAC,EAAE;MAC3D,OAAO,KAAK;IAChB;;IAEA;AACR;AACA;AACA;AACA;IACQ,IAAMoE,gBAAgB,GAAG,IAAI,CAAC/D,IAAI,CAACgE,YAAY;IAC/C,IAAMC,cAAc,GAAG7C,QAAQ,CAAC8C,SAAS,CAAC,CAAC;IAC3C,OACI,CAAC,CAACD,cAAc,KACfA,cAAc,KAAK,IAAI,CAACnE,SAAS,CAACoE,SAAS,CAAC,CAAC,IAC1CH,gBAAgB,CAACI,wBAAwB,CAAC,IAAI,CAACrE,SAAS,EAAEmE,cAAc,CAAC,CAAC;EAEtF;AACJ;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,IAAMG,WAAW,GAAI7E,KAAkB,IAAc;EACxD,IAAM8E,SAAS,GAAG9E,KAAK,CAACG,OAAO,CAAC,CAAC;EACjC,OAAOd,YAAY,CAACa,OAAO,CAAC4E,SAAS,CAAC,IAAIvF,eAAe,CAACW,OAAO,CAAC4E,SAAS,CAAC,IAAIxF,UAAU,CAACY,OAAO,CAAC4E,SAAS,CAAC;AACjH,CAAC","ignoreList":[]}

package/lib/models/profile-keys.d.ts

@@ -0,0 +1,8 @@
+/**
+ * The timezone the user is currently in. The value of this property should
+ * match a timezone provided in https://www.iana.org/time-zones.
+ *
+ * @see https://github.com/matrix-org/matrix-spec-proposals/blob/clokep/profile-tz/proposals/4175-profile-field-time-zone.md
+ */
+export declare const ProfileKeyMSC4175Timezone = "us.cloke.msc4175.tz";
+//# sourceMappingURL=profile-keys.d.ts.map

package/lib/models/profile-keys.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"profile-keys.d.ts","sourceRoot":"","sources":["../../src/models/profile-keys.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,wBAAwB,CAAC"}

package/lib/models/profile-keys.js

@@ -0,0 +1,8 @@
+/**
+ * The timezone the user is currently in. The value of this property should
+ * match a timezone provided in https://www.iana.org/time-zones.
+ *
+ * @see https://github.com/matrix-org/matrix-spec-proposals/blob/clokep/profile-tz/proposals/4175-profile-field-time-zone.md
+ */
+export var ProfileKeyMSC4175Timezone = "us.cloke.msc4175.tz";
+//# sourceMappingURL=profile-keys.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"profile-keys.js","names":["ProfileKeyMSC4175Timezone"],"sources":["../../src/models/profile-keys.ts"],"sourcesContent":["/**\n * The timezone the user is currently in. The value of this property should\n * match a timezone provided in https://www.iana.org/time-zones.\n *\n * @see https://github.com/matrix-org/matrix-spec-proposals/blob/clokep/profile-tz/proposals/4175-profile-field-time-zone.md\n */\nexport const ProfileKeyMSC4175Timezone = \"us.cloke.msc4175.tz\";\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,IAAMA,yBAAyB,GAAG,qBAAqB","ignoreList":[]}

package/lib/models/read-receipt.d.ts

@@ -0,0 +1,115 @@
+import { CachedReceipt, Receipt, ReceiptType, WrappedReceipt } from "../@types/read_receipts.ts";
+import { ListenerMap, TypedEventEmitter } from "./typed-event-emitter.ts";
+import { MatrixEvent } from "./event.ts";
+import { EventTimelineSet } from "./event-timeline-set.ts";
+import { NotificationCountType } from "./room.ts";
+/**
+ * Create a synthetic receipt for the given event
+ * @param userId - The user ID if the receipt sender
+ * @param event - The event that is to be acknowledged
+ * @param receiptType - The type of receipt
+ * @param unthreaded - the receipt is unthreaded
+ * @returns a new event with the synthetic receipt in it
+ */
+export declare function synthesizeReceipt(userId: string, event: MatrixEvent, receiptType: ReceiptType, unthreaded?: boolean): MatrixEvent;
+export declare abstract class ReadReceipt<Events extends string, Arguments extends ListenerMap<Events>, SuperclassArguments extends ListenerMap<any> = Arguments> extends TypedEventEmitter<Events, Arguments, SuperclassArguments> {
+    private receipts;
+    private receiptCacheByEventId;
+    abstract getUnfilteredTimelineSet(): EventTimelineSet;
+    abstract get timeline(): MatrixEvent[];
+    /**
+     * Gets the latest receipt for a given user in the room
+     * @param userId - The id of the user for which we want the receipt
+     * @param ignoreSynthesized - Whether to ignore synthesized receipts or not
+     * @param receiptType - Optional. The type of the receipt we want to get
+     * @returns the latest receipts of the chosen type for the chosen user
+     */
+    getReadReceiptForUserId(userId: string, ignoreSynthesized?: boolean, receiptType?: ReceiptType): WrappedReceipt | null;
+    private compareReceipts;
+    /**
+     * Get the ID of the event that a given user has read up to, or null if:
+     * - we have received no read receipts for them, or
+     * - the receipt we have points at an event we don't have, or
+     * - the thread ID in the receipt does not match the thread root of the
+     *   referenced event.
+     *
+     * (The event might not exist if it is not loaded, and the thread ID might
+     * not match if the event has moved thread because it was redacted.)
+     *
+     * @param userId - The user ID to get read receipt event ID for
+     * @param ignoreSynthesized - If true, return only receipts that have been
+     *                            sent by the server, not implicit ones generated
+     *                            by the JS SDK.
+     * @returns ID of the latest existing event that the given user has read, or null.
+     */
+    getEventReadUpTo(userId: string, ignoreSynthesized?: boolean): string | null;
+    /**
+     * Returns true if the event pointed at by this receipt exists, and its
+     * threadRootId is consistent with the thread information in the receipt.
+     */
+    private receiptPointsAtConsistentEvent;
+    private getLatestReceipt;
+    addReceiptToStructure(eventId: string, receiptType: ReceiptType, userId: string, receipt: Receipt, synthetic: boolean): void;
+    /**
+     * Get a list of receipts for the given event.
+     * @param event - the event to get receipts for
+     * @returns A list of receipts with a userId, type and data keys or
+     * an empty list.
+     */
+    getReceiptsForEvent(event: MatrixEvent): CachedReceipt[];
+    abstract addReceipt(event: MatrixEvent, synthetic: boolean): void;
+    abstract setUnread(type: NotificationCountType, count: number): void;
+    /**
+     * Look in this room/thread's timeline to find an event. If `this` is a
+     * room, we look in all threads, but if `this` is a thread, we look only
+     * inside this thread.
+     */
+    abstract findEventById(eventId: string): MatrixEvent | undefined;
+    /**
+     * This issue should also be addressed on synapse's side and is tracked as part
+     * of https://github.com/matrix-org/synapse/issues/14837
+     *
+     * Retrieves the read receipt for the logged in user and checks if it matches
+     * the last event in the room and whether that event originated from the logged
+     * in user.
+     * Under those conditions we can consider the context as read. This is useful
+     * because we never send read receipts against our own events
+     * @param userId - the logged in user
+     */
+    fixupNotifications(userId: string): void;
+    /**
+     * Add a temporary local-echo receipt to the room to reflect in the
+     * client the fact that we've sent one.
+     * @param userId - The user ID if the receipt sender
+     * @param e - The event that is to be acknowledged
+     * @param receiptType - The type of receipt
+     * @param unthreaded - the receipt is unthreaded
+     */
+    addLocalEchoReceipt(userId: string, e: MatrixEvent, receiptType: ReceiptType, unthreaded?: boolean): void;
+    /**
+     * Get a list of user IDs who have <b>read up to</b> the given event.
+     * @param event - the event to get read receipts for.
+     * @returns A list of user IDs.
+     */
+    getUsersReadUpTo(event: MatrixEvent): string[];
+    /**
+     * Determines if the given user has read a particular event ID with the known
+     * history of the room. This is not a definitive check as it relies only on
+     * what is available to the room at the time of execution.
+     * @param userId - The user ID to check the read state of.
+     * @param eventId - The event ID to check if the user read.
+     * @returns True if the user has read the event, false otherwise.
+     */
+    abstract hasUserReadEvent(userId: string, eventId: string): boolean;
+    /**
+     * Returns the most recent unthreaded receipt for a given user
+     * @param userId - the MxID of the User
+     * @returns an unthreaded Receipt. Can be undefined if receipts have been disabled
+     * or a user chooses to use private read receipts (or we have simply not received
+     * a receipt from this user yet).
+     *
+     * @deprecated use `hasUserReadEvent` or `getEventReadUpTo` instead
+     */
+    abstract getLastUnthreadedReceiptFor(userId: string): Receipt | undefined;
+}
+//# sourceMappingURL=read-receipt.d.ts.map

package/lib/models/read-receipt.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"read-receipt.d.ts","sourceRoot":"","sources":["../../src/models/read-receipt.ts"],"names":[],"mappings":"AAaA,OAAO,EACH,aAAa,EAEb,OAAO,EAEP,WAAW,EACX,cAAc,EACjB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAE1E,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAE3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAIlD;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAC7B,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,WAAW,EAClB,WAAW,EAAE,WAAW,EACxB,UAAU,UAAQ,GACnB,WAAW,CAeb;AAKD,8BAAsB,WAAW,CAC7B,MAAM,SAAS,MAAM,EACrB,SAAS,SAAS,WAAW,CAAC,MAAM,CAAC,EACrC,mBAAmB,SAAS,WAAW,CAAC,GAAG,CAAC,GAAG,SAAS,CAC1D,SAAQ,iBAAiB,CAAC,MAAM,EAAE,SAAS,EAAE,mBAAmB,CAAC;IAM/D,OAAO,CAAC,QAAQ,CAGG;IACnB,OAAO,CAAC,qBAAqB,CAA2B;aAExC,wBAAwB,IAAI,gBAAgB;IAC5D,aAAoB,QAAQ,IAAI,WAAW,EAAE,CAAC;IAE9C;;;;;;OAMG;IACI,uBAAuB,CAC1B,MAAM,EAAE,MAAM,EACd,iBAAiB,UAAQ,EACzB,WAAW,cAAmB,GAC/B,cAAc,GAAG,IAAI;IASxB,OAAO,CAAC,eAAe;IAOvB;;;;;;;;;;;;;;;OAeG;IACI,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,iBAAiB,UAAQ,GAAG,MAAM,GAAG,IAAI;IAWjF;;;OAGG;IACH,OAAO,CAAC,8BAA8B;IA8EtC,OAAO,CAAC,gBAAgB;IAsBjB,qBAAqB,CACxB,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,WAAW,EACxB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,OAAO,EAChB,SAAS,EAAE,OAAO,GACnB,IAAI;IAqFP;;;;;OAKG;IACI,mBAAmB,CAAC,KAAK,EAAE,WAAW,GAAG,aAAa,EAAE;aAI/C,UAAU,CAAC,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,GAAG,IAAI;aAExD,SAAS,CAAC,IAAI,EAAE,qBAAqB,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAE3E;;;;OAIG;aACa,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS;IAEvE;;;;;;;;;;OAUG;IACI,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAU/C;;;;;;;OAOG;IACI,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,UAAU,UAAQ,GAAG,IAAI;IAI9G;;;;OAIG;IACI,gBAAgB,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM,EAAE;IAUrD;;;;;;;OAOG;aACa,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO;IAE1E;;;;;;;;OAQG;aACa,2BAA2B,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;CACnF"}