matrix-js-sdk 41.8.0 → 41.9.0

package/lib/matrixrtc/utils.js

@@ -1,6 +1,4 @@
-import _toArray from "@babel/runtime/helpers/toArray";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
-function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
 /*
 Copyright 2025-2026 The Matrix.org Foundation C.I.C.
 
@@ -34,12 +32,11 @@ export class OutdatedKeyFilter {
    * @param item
    */
   isOutdated(membership, item) {
-    var _this$tsBuffer$get;
-    var mapKey = getEncryptionKeyMapKey(membership);
+    const mapKey = getEncryptionKeyMapKey(membership);
     if (!this.tsBuffer.has(mapKey)) {
       this.tsBuffer.set(mapKey, new Map());
     }
-    var latestTimestamp = (_this$tsBuffer$get = this.tsBuffer.get(mapKey)) === null || _this$tsBuffer$get === void 0 ? void 0 : _this$tsBuffer$get.get(item.keyIndex);
+    const latestTimestamp = this.tsBuffer.get(mapKey)?.get(item.keyIndex);
     if (latestTimestamp && latestTimestamp > item.creationTS) {
       // The existing key is more recent, ignore this one
       return true;
@@ -55,11 +52,7 @@ export class OutdatedKeyFilter {
  * @throws If the format of `slotId` is invalid.
  */
 export function slotIdToDescription(slotId) {
-  var _slotId$split = slotId.split("#"),
-    _slotId$split2 = _toArray(_slotId$split),
-    application = _slotId$split2[0],
-    id = _slotId$split2[1],
-    unexpectedAdditionalValues = _arrayLikeToArray(_slotId$split2).slice(2);
+  const [application, id, ...unexpectedAdditionalValues] = slotId.split("#");
   if (unexpectedAdditionalValues.length) {
     throw Error("MatrixRTC Slot IDs *must* only contain two components seperated by one '#'. Additional '#' characters detected.");
   }
@@ -73,6 +66,6 @@ export function slotIdToDescription(slotId) {
  * Converts a SlotDescription into it's slot ID format.
  */
 export function computeSlotId(slotDescription) {
-  return "".concat(slotDescription.application, "#").concat(slotDescription.id);
+  return `${slotDescription.application}#${slotDescription.id}`;
 }
 //# sourceMappingURL=utils.js.map

package/lib/matrixrtc/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","names":["getEncryptionKeyMapKey","OutdatedKeyFilter","constructor","_defineProperty","Map","isOutdated","membership","item","_this$tsBuffer$get","mapKey","tsBuffer","has","set","latestTimestamp","get","keyIndex","creationTS","slotIdToDescription","slotId","_slotId$split","split","_slotId$split2","_toArray","application","id","unexpectedAdditionalValues","_arrayLikeToArray","slice","length","Error","computeSlotId","slotDescription","concat"],"sources":["../../src/matrixrtc/utils.ts"],"sourcesContent":["/*\nCopyright 2025-2026 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 { getEncryptionKeyMapKey, type CallMembershipIdentityParts } from \"./EncryptionManager.ts\";\nimport type { InboundEncryptionSession, EncryptionKeyMapKey, SlotDescription } from \"./types.ts\";\n\n/**\n * Detects when a key for a given index is outdated.\n */\nexport class OutdatedKeyFilter {\n    // Map of participantId -> keyIndex -> timestamp\n    private tsBuffer: Map<EncryptionKeyMapKey, Map<number, number>> = new Map();\n\n    public constructor() {}\n\n    /**\n     * Check if there is a recent key with the same keyId (index) and then use the creationTS to decide what to\n     * do with the key. If the key received is older than the one already in the buffer, it is ignored.\n     * @param participantId\n     * @param item\n     */\n    public isOutdated(membership: CallMembershipIdentityParts, item: InboundEncryptionSession): boolean {\n        const mapKey = getEncryptionKeyMapKey(membership);\n        if (!this.tsBuffer.has(mapKey)) {\n            this.tsBuffer.set(mapKey, new Map<number, number>());\n        }\n\n        const latestTimestamp = this.tsBuffer.get(mapKey)?.get(item.keyIndex);\n        if (latestTimestamp && latestTimestamp > item.creationTS) {\n            // The existing key is more recent, ignore this one\n            return true;\n        }\n        this.tsBuffer.get(mapKey)!.set(item.keyIndex, item.creationTS);\n        return false;\n    }\n}\n\n/**\n * Converts a slot ID into it's component application and ID portions.\n * @param slotId e.g. `m.call#call_id`\n * @throws If the format of `slotId` is invalid.\n */\nexport function slotIdToDescription(slotId: string): SlotDescription {\n    const [application, id, ...unexpectedAdditionalValues] = slotId.split(\"#\");\n    if (unexpectedAdditionalValues.length) {\n        throw Error(\n            \"MatrixRTC Slot IDs *must* only contain two components seperated by one '#'. Additional '#' characters detected.\",\n        );\n    }\n    return { application, id };\n}\n\n/**\n * Converts a SlotDescription into it's slot ID format.\n */\nexport function computeSlotId(slotDescription: SlotDescription): string {\n    return `${slotDescription.application}#${slotDescription.id}`;\n}\n"],"mappings":";;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,sBAAsB,QAA0C,wBAAwB;AAGjG;AACA;AACA;AACA,OAAO,MAAMC,iBAAiB,CAAC;EAIpBC,WAAWA,CAAA,EAAG;IAHrB;IAAAC,eAAA,mBACkE,IAAIC,GAAG,CAAC,CAAC;EAErD;;EAEtB;AACJ;AACA;AACA;AACA;AACA;EACWC,UAAUA,CAACC,UAAuC,EAAEC,IAA8B,EAAW;IAAA,IAAAC,kBAAA;IAChG,IAAMC,MAAM,GAAGT,sBAAsB,CAACM,UAAU,CAAC;IACjD,IAAI,CAAC,IAAI,CAACI,QAAQ,CAACC,GAAG,CAACF,MAAM,CAAC,EAAE;MAC5B,IAAI,CAACC,QAAQ,CAACE,GAAG,CAACH,MAAM,EAAE,IAAIL,GAAG,CAAiB,CAAC,CAAC;IACxD;IAEA,IAAMS,eAAe,IAAAL,kBAAA,GAAG,IAAI,CAACE,QAAQ,CAACI,GAAG,CAACL,MAAM,CAAC,cAAAD,kBAAA,uBAAzBA,kBAAA,CAA2BM,GAAG,CAACP,IAAI,CAACQ,QAAQ,CAAC;IACrE,IAAIF,eAAe,IAAIA,eAAe,GAAGN,IAAI,CAACS,UAAU,EAAE;MACtD;MACA,OAAO,IAAI;IACf;IACA,IAAI,CAACN,QAAQ,CAACI,GAAG,CAACL,MAAM,CAAC,CAAEG,GAAG,CAACL,IAAI,CAACQ,QAAQ,EAAER,IAAI,CAACS,UAAU,CAAC;IAC9D,OAAO,KAAK;EAChB;AACJ;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,mBAAmBA,CAACC,MAAc,EAAmB;EACjE,IAAAC,aAAA,GAAyDD,MAAM,CAACE,KAAK,CAAC,GAAG,CAAC;IAAAC,cAAA,GAAAC,QAAA,CAAAH,aAAA;IAAnEI,WAAW,GAAAF,cAAA;IAAEG,EAAE,GAAAH,cAAA;IAAKI,0BAA0B,GAAAC,iBAAA,CAAAL,cAAA,EAAAM,KAAA;EACrD,IAAIF,0BAA0B,CAACG,MAAM,EAAE;IACnC,MAAMC,KAAK,CACP,iHACJ,CAAC;EACL;EACA,OAAO;IAAEN,WAAW;IAAEC;EAAG,CAAC;AAC9B;;AAEA;AACA;AACA;AACA,OAAO,SAASM,aAAaA,CAACC,eAAgC,EAAU;EACpE,UAAAC,MAAA,CAAUD,eAAe,CAACR,WAAW,OAAAS,MAAA,CAAID,eAAe,CAACP,EAAE;AAC/D","ignoreList":[]}
+{"version":3,"file":"utils.js","names":[],"sources":["../../src/matrixrtc/utils.ts"],"sourcesContent":["/*\nCopyright 2025-2026 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 { getEncryptionKeyMapKey, type CallMembershipIdentityParts } from \"./EncryptionManager.ts\";\nimport type { InboundEncryptionSession, EncryptionKeyMapKey, SlotDescription } from \"./types.ts\";\n\n/**\n * Detects when a key for a given index is outdated.\n */\nexport class OutdatedKeyFilter {\n    // Map of participantId -> keyIndex -> timestamp\n    private tsBuffer: Map<EncryptionKeyMapKey, Map<number, number>> = new Map();\n\n    public constructor() {}\n\n    /**\n     * Check if there is a recent key with the same keyId (index) and then use the creationTS to decide what to\n     * do with the key. If the key received is older than the one already in the buffer, it is ignored.\n     * @param participantId\n     * @param item\n     */\n    public isOutdated(membership: CallMembershipIdentityParts, item: InboundEncryptionSession): boolean {\n        const mapKey = getEncryptionKeyMapKey(membership);\n        if (!this.tsBuffer.has(mapKey)) {\n            this.tsBuffer.set(mapKey, new Map<number, number>());\n        }\n\n        const latestTimestamp = this.tsBuffer.get(mapKey)?.get(item.keyIndex);\n        if (latestTimestamp && latestTimestamp > item.creationTS) {\n            // The existing key is more recent, ignore this one\n            return true;\n        }\n        this.tsBuffer.get(mapKey)!.set(item.keyIndex, item.creationTS);\n        return false;\n    }\n}\n\n/**\n * Converts a slot ID into it's component application and ID portions.\n * @param slotId e.g. `m.call#call_id`\n * @throws If the format of `slotId` is invalid.\n */\nexport function slotIdToDescription(slotId: string): SlotDescription {\n    const [application, id, ...unexpectedAdditionalValues] = slotId.split(\"#\");\n    if (unexpectedAdditionalValues.length) {\n        throw Error(\n            \"MatrixRTC Slot IDs *must* only contain two components seperated by one '#'. Additional '#' characters detected.\",\n        );\n    }\n    return { application, id };\n}\n\n/**\n * Converts a SlotDescription into it's slot ID format.\n */\nexport function computeSlotId(slotDescription: SlotDescription): string {\n    return `${slotDescription.application}#${slotDescription.id}`;\n}\n"],"mappings":";AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAAS,sBAAsB,QAA0C,wBAAwB;AAGjG;AACA;AACA;AACA,OAAO,MAAM,iBAAiB,CAAC;EAIpB,WAAW,GAAG;IAHrB;IAAA,kCACkE,IAAI,GAAG,CAAC,CAAC;EAErD;;EAEtB;AACJ;AACA;AACA;AACA;AACA;EACW,UAAU,CAAC,UAAuC,EAAE,IAA8B,EAAW;IAChG,MAAM,MAAM,GAAG,sBAAsB,CAAC,UAAU,CAAC;IACjD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;MAC5B,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,GAAG,CAAiB,CAAC,CAAC;IACxD;IAEA,MAAM,eAAe,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC;IACrE,IAAI,eAAe,IAAI,eAAe,GAAG,IAAI,CAAC,UAAU,EAAE;MACtD;MACA,OAAO,IAAI;IACf;IACA,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAE,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC;IAC9D,OAAO,KAAK;EAChB;AACJ;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAAS,mBAAmB,CAAC,MAAc,EAAmB;EACjE,MAAM,CAAC,WAAW,EAAE,EAAE,EAAE,GAAG,0BAA0B,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC;EAC1E,IAAI,0BAA0B,CAAC,MAAM,EAAE;IACnC,MAAM,KAAK,CACP,iHACJ,CAAC;EACL;EACA,OAAO;IAAE,WAAW;IAAE;EAAG,CAAC;AAC9B;;AAEA;AACA;AACA;AACA,OAAO,SAAS,aAAa,CAAC,eAAgC,EAAU;EACpE,OAAO,GAAG,eAAe,CAAC,WAAW,IAAI,eAAe,CAAC,EAAE,EAAE;AACjE","ignoreList":[]}

package/lib/models/MSC3089Branch.js

@@ -1,7 +1,4 @@
-import _defineProperty from "@babel/runtime/helpers/defineProperty";
-import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
-function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
-function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+import _objectSpread from "@babel/runtime/helpers/objectSpread2";
 /*
 Copyright 2021 The Matrix.org Foundation C.I.C.
 
@@ -36,7 +33,7 @@ export class MSC3089Branch {
    * The file ID.
    */
   get id() {
-    var stateKey = this.indexEvent.getStateKey();
+    const stateKey = this.indexEvent.getStateKey();
     if (!stateKey) {
       throw new Error("State key not found for branch");
     }
@@ -54,8 +51,7 @@ export class MSC3089Branch {
    * Version for the file, one-indexed.
    */
   get version() {
-    var _this$indexEvent$getC;
-    return (_this$indexEvent$getC = this.indexEvent.getContent()["version"]) !== null && _this$indexEvent$getC !== void 0 ? _this$indexEvent$getC : 1;
+    return this.indexEvent.getContent()["version"] ?? 1;
   }
   get roomId() {
     return this.indexEvent.getRoomId();
@@ -65,14 +61,11 @@ export class MSC3089Branch {
    * Deletes the file from the tree, including all prior edits/versions.
    * @returns Promise which resolves when complete.
    */
-  delete() {
-    var _this = this;
-    return _asyncToGenerator(function* () {
-      yield _this.client.sendStateEvent(_this.roomId, UNSTABLE_MSC3089_BRANCH.name, {}, _this.id);
-      yield _this.client.redactEvent(_this.roomId, _this.id);
-      var nextVersion = (yield _this.getVersionHistory())[1]; // [0] will be us
-      if (nextVersion) yield nextVersion.delete(); // implicit recursion
-    })();
+  async delete() {
+    await this.client.sendStateEvent(this.roomId, UNSTABLE_MSC3089_BRANCH.name, {}, this.id);
+    await this.client.redactEvent(this.roomId, this.id);
+    const nextVersion = (await this.getVersionHistory())[1]; // [0] will be us
+    if (nextVersion) await nextVersion.delete(); // implicit recursion
   }
 
   /**
@@ -88,13 +81,10 @@ export class MSC3089Branch {
    * @param name - The new name for this file.
    * @returns Promise which resolves when complete.
    */
-  setName(name) {
-    var _this2 = this;
-    return _asyncToGenerator(function* () {
-      yield _this2.client.sendStateEvent(_this2.roomId, UNSTABLE_MSC3089_BRANCH.name, _objectSpread(_objectSpread({}, _this2.indexEvent.getContent()), {}, {
-        name: name
-      }), _this2.id);
-    })();
+  async setName(name) {
+    await this.client.sendStateEvent(this.roomId, UNSTABLE_MSC3089_BRANCH.name, _objectSpread(_objectSpread({}, this.indexEvent.getContent()), {}, {
+      name: name
+    }), this.id);
   }
 
   /**
@@ -110,57 +100,48 @@ export class MSC3089Branch {
    * @param locked - True to lock the file, false otherwise.
    * @returns Promise which resolves when complete.
    */
-  setLocked(locked) {
-    var _this3 = this;
-    return _asyncToGenerator(function* () {
-      yield _this3.client.sendStateEvent(_this3.roomId, UNSTABLE_MSC3089_BRANCH.name, _objectSpread(_objectSpread({}, _this3.indexEvent.getContent()), {}, {
-        locked: locked
-      }), _this3.id);
-    })();
+  async setLocked(locked) {
+    await this.client.sendStateEvent(this.roomId, UNSTABLE_MSC3089_BRANCH.name, _objectSpread(_objectSpread({}, this.indexEvent.getContent()), {}, {
+      locked: locked
+    }), this.id);
   }
 
   /**
    * Gets information about the file needed to download it.
    * @returns Information about the file.
    */
-  getFileInfo() {
-    var _this4 = this;
-    return _asyncToGenerator(function* () {
-      var event = yield _this4.getFileEvent();
-      var file = event.getOriginalContent()["file"];
-      var httpUrl = _this4.client.mxcUrlToHttp(file["url"]);
-      if (!httpUrl) {
-        throw new Error("No HTTP URL available for ".concat(file["url"]));
-      }
-      return {
-        info: file,
-        httpUrl: httpUrl
-      };
-    })();
+  async getFileInfo() {
+    const event = await this.getFileEvent();
+    const file = event.getOriginalContent()["file"];
+    const httpUrl = this.client.mxcUrlToHttp(file["url"]);
+    if (!httpUrl) {
+      throw new Error(`No HTTP URL available for ${file["url"]}`);
+    }
+    return {
+      info: file,
+      httpUrl: httpUrl
+    };
   }
 
   /**
    * Gets the event the file points to.
    * @returns Promise which resolves to the file's event.
    */
-  getFileEvent() {
-    var _this5 = this;
-    return _asyncToGenerator(function* () {
-      var room = _this5.client.getRoom(_this5.roomId);
-      if (!room) throw new Error("Unknown room");
-      var event = room.getUnfilteredTimelineSet().findEventById(_this5.id);
-
-      // keep scrolling back if needed until we find the event or reach the start of the room:
-      while (!event && room.getLiveTimeline().getState(EventTimeline.BACKWARDS).paginationToken) {
-        yield _this5.client.scrollback(room, 100);
-        event = room.getUnfilteredTimelineSet().findEventById(_this5.id);
-      }
-      if (!event) throw new Error("Failed to find event");
+  async getFileEvent() {
+    const room = this.client.getRoom(this.roomId);
+    if (!room) throw new Error("Unknown room");
+    let event = room.getUnfilteredTimelineSet().findEventById(this.id);
+
+    // keep scrolling back if needed until we find the event or reach the start of the room:
+    while (!event && room.getLiveTimeline().getState(EventTimeline.BACKWARDS).paginationToken) {
+      await this.client.scrollback(room, 100);
+      event = room.getUnfilteredTimelineSet().findEventById(this.id);
+    }
+    if (!event) throw new Error("Failed to find event");
 
-      // Sometimes the event isn't decrypted for us, so do that.
-      yield _this5.client.decryptEventIfNeeded(event);
-      return event;
-    })();
+    // Sometimes the event isn't decrypted for us, so do that.
+    await this.client.decryptEventIfNeeded(event);
+    return event;
   }
 
   /**
@@ -171,30 +152,27 @@ export class MSC3089Branch {
    * @param additionalContent - Optional event content fields to include in the message.
    * @returns Promise which resolves to the file event's sent response.
    */
-  createNewVersion(name, encryptedContents, info, additionalContent) {
-    var _this6 = this;
-    return _asyncToGenerator(function* () {
-      var fileEventResponse = yield _this6.directory.createFile(name, encryptedContents, info, _objectSpread(_objectSpread({}, additionalContent !== null && additionalContent !== void 0 ? additionalContent : {}), {}, {
-        "m.new_content": true,
-        "m.relates_to": {
-          rel_type: RelationType.Replace,
-          event_id: _this6.id
-        }
-      }));
-
-      // Update the version of the new event
-      yield _this6.client.sendStateEvent(_this6.roomId, UNSTABLE_MSC3089_BRANCH.name, {
-        active: true,
-        name: name,
-        version: _this6.version + 1
-      }, fileEventResponse["event_id"]);
-
-      // Deprecate ourselves
-      yield _this6.client.sendStateEvent(_this6.roomId, UNSTABLE_MSC3089_BRANCH.name, _objectSpread(_objectSpread({}, _this6.indexEvent.getContent()), {}, {
-        active: false
-      }), _this6.id);
-      return fileEventResponse;
-    })();
+  async createNewVersion(name, encryptedContents, info, additionalContent) {
+    const fileEventResponse = await this.directory.createFile(name, encryptedContents, info, _objectSpread(_objectSpread({}, additionalContent), {}, {
+      "m.new_content": true,
+      "m.relates_to": {
+        rel_type: RelationType.Replace,
+        event_id: this.id
+      }
+    }));
+
+    // Update the version of the new event
+    await this.client.sendStateEvent(this.roomId, UNSTABLE_MSC3089_BRANCH.name, {
+      active: true,
+      name: name,
+      version: this.version + 1
+    }, fileEventResponse["event_id"]);
+
+    // Deprecate ourselves
+    await this.client.sendStateEvent(this.roomId, UNSTABLE_MSC3089_BRANCH.name, _objectSpread(_objectSpread({}, this.indexEvent.getContent()), {}, {
+      active: false
+    }), this.id);
+    return fileEventResponse;
   }
 
   /**
@@ -202,39 +180,36 @@ export class MSC3089Branch {
    * @returns Promise which resolves to the file's version history, with the
    * first element being the current version and the last element being the first version.
    */
-  getVersionHistory() {
-    var _this7 = this;
-    return _asyncToGenerator(function* () {
-      var fileHistory = [];
-      fileHistory.push(_this7); // start with ourselves
-
-      var room = _this7.client.getRoom(_this7.roomId);
-      if (!room) throw new Error("Invalid or unknown room");
-
-      // Clone the timeline to reverse it, getting most-recent-first ordering, hopefully
-      // shortening the awful loop below. Without the clone, we can unintentionally mutate
-      // the timeline.
-      var timelineEvents = [...room.getLiveTimeline().getEvents()].reverse();
-
-      // XXX: This is a very inefficient search, but it's the best we can do with the
-      // relations structure we have in the SDK. As of writing, it is not worth the
-      // investment in improving the structure.
-      var childEvent;
-      var parentEvent = yield _this7.getFileEvent();
-      do {
-        childEvent = timelineEvents.find(e => e.replacingEventId() === parentEvent.getId());
-        if (childEvent) {
-          var branch = _this7.directory.getFile(childEvent.getId());
-          if (branch) {
-            fileHistory.push(branch);
-            parentEvent = childEvent;
-          } else {
-            break; // prevent infinite loop
-          }
+  async getVersionHistory() {
+    const fileHistory = [];
+    fileHistory.push(this); // start with ourselves
+
+    const room = this.client.getRoom(this.roomId);
+    if (!room) throw new Error("Invalid or unknown room");
+
+    // Clone the timeline to reverse it, getting most-recent-first ordering, hopefully
+    // shortening the awful loop below. Without the clone, we can unintentionally mutate
+    // the timeline.
+    const timelineEvents = [...room.getLiveTimeline().getEvents()].reverse();
+
+    // XXX: This is a very inefficient search, but it's the best we can do with the
+    // relations structure we have in the SDK. As of writing, it is not worth the
+    // investment in improving the structure.
+    let childEvent;
+    let parentEvent = await this.getFileEvent();
+    do {
+      childEvent = timelineEvents.find(e => e.replacingEventId() === parentEvent.getId());
+      if (childEvent) {
+        const branch = this.directory.getFile(childEvent.getId());
+        if (branch) {
+          fileHistory.push(branch);
+          parentEvent = childEvent;
+        } else {
+          break; // prevent infinite loop
         }
-      } while (childEvent);
-      return fileHistory;
-    })();
+      }
+    } while (childEvent);
+    return fileHistory;
   }
 }
 //# sourceMappingURL=MSC3089Branch.js.map

package/lib/models/MSC3089Branch.js.map

@@ -1 +1 @@
-{"version":3,"file":"MSC3089Branch.js","names":["RelationType","UNSTABLE_MSC3089_BRANCH","EventTimeline","MSC3089Branch","constructor","client","indexEvent","directory","id","stateKey","getStateKey","Error","isActive","getContent","version","_this$indexEvent$getC","roomId","getRoomId","delete","_this","_asyncToGenerator","sendStateEvent","name","redactEvent","nextVersion","getVersionHistory","getName","setName","_this2","_objectSpread","isLocked","setLocked","locked","_this3","getFileInfo","_this4","event","getFileEvent","file","getOriginalContent","httpUrl","mxcUrlToHttp","concat","info","_this5","room","getRoom","getUnfilteredTimelineSet","findEventById","getLiveTimeline","getState","BACKWARDS","paginationToken","scrollback","decryptEventIfNeeded","createNewVersion","encryptedContents","additionalContent","_this6","fileEventResponse","createFile","rel_type","Replace","event_id","active","_this7","fileHistory","push","timelineEvents","getEvents","reverse","childEvent","parentEvent","find","e","replacingEventId","getId","branch","getFile"],"sources":["../../src/models/MSC3089Branch.ts"],"sourcesContent":["/*\nCopyright 2021 The Matrix.org Foundation C.I.C.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\nimport { type MatrixClient } from \"../client.ts\";\nimport { RelationType, UNSTABLE_MSC3089_BRANCH } from \"../@types/event.ts\";\nimport { type IContent, type MatrixEvent } from \"./event.ts\";\nimport { type MSC3089TreeSpace } from \"./MSC3089TreeSpace.ts\";\nimport { EventTimeline } from \"./event-timeline.ts\";\nimport { type FileType } from \"../http-api/index.ts\";\nimport type { ISendEventResponse } from \"../@types/requests.ts\";\nimport { type EncryptedFile } from \"../@types/media.ts\";\n\nexport interface MSC3089EventContent {\n    active?: boolean;\n    name?: string;\n    locked?: boolean;\n    version?: number;\n}\n\nexport interface MSC3089EventContent {\n    active?: boolean;\n    name?: string;\n    locked?: boolean;\n    version?: number;\n}\n\n/**\n * Represents a [MSC3089](https://github.com/matrix-org/matrix-doc/pull/3089) branch - a reference\n * to a file (leaf) in the tree. Note that this is UNSTABLE and subject to breaking changes\n * without notice.\n */\nexport class MSC3089Branch {\n    public constructor(\n        private client: MatrixClient,\n        public readonly indexEvent: MatrixEvent,\n        public readonly directory: MSC3089TreeSpace,\n    ) {\n        // Nothing to do\n    }\n\n    /**\n     * The file ID.\n     */\n    public get id(): string {\n        const stateKey = this.indexEvent.getStateKey();\n        if (!stateKey) {\n            throw new Error(\"State key not found for branch\");\n        }\n        return stateKey;\n    }\n\n    /**\n     * Whether this branch is active/valid.\n     */\n    public get isActive(): boolean {\n        return this.indexEvent.getContent()[\"active\"] === true;\n    }\n\n    /**\n     * Version for the file, one-indexed.\n     */\n    public get version(): number {\n        return this.indexEvent.getContent()[\"version\"] ?? 1;\n    }\n\n    private get roomId(): string {\n        return this.indexEvent.getRoomId()!;\n    }\n\n    /**\n     * Deletes the file from the tree, including all prior edits/versions.\n     * @returns Promise which resolves when complete.\n     */\n    public async delete(): Promise<void> {\n        await this.client.sendStateEvent(this.roomId, UNSTABLE_MSC3089_BRANCH.name, {}, this.id);\n        await this.client.redactEvent(this.roomId, this.id);\n\n        const nextVersion = (await this.getVersionHistory())[1]; // [0] will be us\n        if (nextVersion) await nextVersion.delete(); // implicit recursion\n    }\n\n    /**\n     * Gets the name for this file.\n     * @returns The name, or \"Unnamed File\" if unknown.\n     */\n    public getName(): string {\n        return this.indexEvent.getContent()[\"name\"] || \"Unnamed File\";\n    }\n\n    /**\n     * Sets the name for this file.\n     * @param name - The new name for this file.\n     * @returns Promise which resolves when complete.\n     */\n    public async setName(name: string): Promise<void> {\n        await this.client.sendStateEvent(\n            this.roomId,\n            UNSTABLE_MSC3089_BRANCH.name,\n            {\n                ...this.indexEvent.getContent(),\n                name: name,\n            },\n            this.id,\n        );\n    }\n\n    /**\n     * Gets whether or not a file is locked.\n     * @returns True if locked, false otherwise.\n     */\n    public isLocked(): boolean {\n        return this.indexEvent.getContent()[\"locked\"] || false;\n    }\n\n    /**\n     * Sets a file as locked or unlocked.\n     * @param locked - True to lock the file, false otherwise.\n     * @returns Promise which resolves when complete.\n     */\n    public async setLocked(locked: boolean): Promise<void> {\n        await this.client.sendStateEvent(\n            this.roomId,\n            UNSTABLE_MSC3089_BRANCH.name,\n            {\n                ...this.indexEvent.getContent(),\n                locked: locked,\n            },\n            this.id,\n        );\n    }\n\n    /**\n     * Gets information about the file needed to download it.\n     * @returns Information about the file.\n     */\n    public async getFileInfo(): Promise<{ info: EncryptedFile; httpUrl: string }> {\n        const event = await this.getFileEvent();\n\n        const file = event.getOriginalContent()[\"file\"];\n        const httpUrl = this.client.mxcUrlToHttp(file[\"url\"]);\n\n        if (!httpUrl) {\n            throw new Error(`No HTTP URL available for ${file[\"url\"]}`);\n        }\n\n        return { info: file, httpUrl: httpUrl };\n    }\n\n    /**\n     * Gets the event the file points to.\n     * @returns Promise which resolves to the file's event.\n     */\n    public async getFileEvent(): Promise<MatrixEvent> {\n        const room = this.client.getRoom(this.roomId);\n        if (!room) throw new Error(\"Unknown room\");\n\n        let event: MatrixEvent | undefined = room.getUnfilteredTimelineSet().findEventById(this.id);\n\n        // keep scrolling back if needed until we find the event or reach the start of the room:\n        while (!event && room.getLiveTimeline().getState(EventTimeline.BACKWARDS)!.paginationToken) {\n            await this.client.scrollback(room, 100);\n            event = room.getUnfilteredTimelineSet().findEventById(this.id);\n        }\n\n        if (!event) throw new Error(\"Failed to find event\");\n\n        // Sometimes the event isn't decrypted for us, so do that.\n        await this.client.decryptEventIfNeeded(event);\n\n        return event;\n    }\n\n    /**\n     * Creates a new version of this file with contents in a type that is compatible with MatrixClient.uploadContent().\n     * @param name - The name of the file.\n     * @param encryptedContents - The encrypted contents.\n     * @param info - The encrypted file information.\n     * @param additionalContent - Optional event content fields to include in the message.\n     * @returns Promise which resolves to the file event's sent response.\n     */\n    public async createNewVersion(\n        name: string,\n        encryptedContents: FileType,\n        info: EncryptedFile,\n        additionalContent?: IContent,\n    ): Promise<ISendEventResponse> {\n        const fileEventResponse = await this.directory.createFile(name, encryptedContents, info, {\n            ...(additionalContent ?? {}),\n            \"m.new_content\": true,\n            \"m.relates_to\": {\n                rel_type: RelationType.Replace,\n                event_id: this.id,\n            },\n        });\n\n        // Update the version of the new event\n        await this.client.sendStateEvent(\n            this.roomId,\n            UNSTABLE_MSC3089_BRANCH.name,\n            {\n                active: true,\n                name: name,\n                version: this.version + 1,\n            },\n            fileEventResponse[\"event_id\"],\n        );\n\n        // Deprecate ourselves\n        await this.client.sendStateEvent(\n            this.roomId,\n            UNSTABLE_MSC3089_BRANCH.name,\n            {\n                ...this.indexEvent.getContent(),\n                active: false,\n            },\n            this.id,\n        );\n\n        return fileEventResponse;\n    }\n\n    /**\n     * Gets the file's version history, starting at this file.\n     * @returns Promise which resolves to the file's version history, with the\n     * first element being the current version and the last element being the first version.\n     */\n    public async getVersionHistory(): Promise<MSC3089Branch[]> {\n        const fileHistory: MSC3089Branch[] = [];\n        fileHistory.push(this); // start with ourselves\n\n        const room = this.client.getRoom(this.roomId);\n        if (!room) throw new Error(\"Invalid or unknown room\");\n\n        // Clone the timeline to reverse it, getting most-recent-first ordering, hopefully\n        // shortening the awful loop below. Without the clone, we can unintentionally mutate\n        // the timeline.\n        const timelineEvents = [...room.getLiveTimeline().getEvents()].reverse();\n\n        // XXX: This is a very inefficient search, but it's the best we can do with the\n        // relations structure we have in the SDK. As of writing, it is not worth the\n        // investment in improving the structure.\n        let childEvent: MatrixEvent | undefined;\n        let parentEvent = await this.getFileEvent();\n        do {\n            childEvent = timelineEvents.find((e) => e.replacingEventId() === parentEvent.getId());\n            if (childEvent) {\n                const branch = this.directory.getFile(childEvent.getId()!);\n                if (branch) {\n                    fileHistory.push(branch);\n                    parentEvent = childEvent;\n                } else {\n                    break; // prevent infinite loop\n                }\n            }\n        } while (childEvent);\n\n        return fileHistory;\n    }\n}\n"],"mappings":";;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA,SAASA,YAAY,EAAEC,uBAAuB,QAAQ,oBAAoB;AAG1E,SAASC,aAAa,QAAQ,qBAAqB;AAmBnD;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,aAAa,CAAC;EAChBC,WAAWA,CACNC,MAAoB,EACZC,UAAuB,EACvBC,SAA2B,EAC7C;IAAA,KAHUF,MAAoB,GAApBA,MAAoB;IAAA,KACZC,UAAuB,GAAvBA,UAAuB;IAAA,KACvBC,SAA2B,GAA3BA,SAA2B;EAG/C,CAAC,CADG;;EAGJ;AACJ;AACA;EACI,IAAWC,EAAEA,CAAA,EAAW;IACpB,IAAMC,QAAQ,GAAG,IAAI,CAACH,UAAU,CAACI,WAAW,CAAC,CAAC;IAC9C,IAAI,CAACD,QAAQ,EAAE;MACX,MAAM,IAAIE,KAAK,CAAC,gCAAgC,CAAC;IACrD;IACA,OAAOF,QAAQ;EACnB;;EAEA;AACJ;AACA;EACI,IAAWG,QAAQA,CAAA,EAAY;IAC3B,OAAO,IAAI,CAACN,UAAU,CAACO,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,IAAI;EAC1D;;EAEA;AACJ;AACA;EACI,IAAWC,OAAOA,CAAA,EAAW;IAAA,IAAAC,qBAAA;IACzB,QAAAA,qBAAA,GAAO,IAAI,CAACT,UAAU,CAACO,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,cAAAE,qBAAA,cAAAA,qBAAA,GAAI,CAAC;EACvD;EAEA,IAAYC,MAAMA,CAAA,EAAW;IACzB,OAAO,IAAI,CAACV,UAAU,CAACW,SAAS,CAAC,CAAC;EACtC;;EAEA;AACJ;AACA;AACA;EACiBC,MAAMA,CAAA,EAAkB;IAAA,IAAAC,KAAA;IAAA,OAAAC,iBAAA;MACjC,MAAMD,KAAI,CAACd,MAAM,CAACgB,cAAc,CAACF,KAAI,CAACH,MAAM,EAAEf,uBAAuB,CAACqB,IAAI,EAAE,CAAC,CAAC,EAAEH,KAAI,CAACX,EAAE,CAAC;MACxF,MAAMW,KAAI,CAACd,MAAM,CAACkB,WAAW,CAACJ,KAAI,CAACH,MAAM,EAAEG,KAAI,CAACX,EAAE,CAAC;MAEnD,IAAMgB,WAAW,GAAG,OAAOL,KAAI,CAACM,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;MACzD,IAAID,WAAW,EAAE,MAAMA,WAAW,CAACN,MAAM,CAAC,CAAC,CAAC,CAAC;IAAA;EACjD;;EAEA;AACJ;AACA;AACA;EACWQ,OAAOA,CAAA,EAAW;IACrB,OAAO,IAAI,CAACpB,UAAU,CAACO,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,cAAc;EACjE;;EAEA;AACJ;AACA;AACA;AACA;EACiBc,OAAOA,CAACL,IAAY,EAAiB;IAAA,IAAAM,MAAA;IAAA,OAAAR,iBAAA;MAC9C,MAAMQ,MAAI,CAACvB,MAAM,CAACgB,cAAc,CAC5BO,MAAI,CAACZ,MAAM,EACXf,uBAAuB,CAACqB,IAAI,EAAAO,aAAA,CAAAA,aAAA,KAErBD,MAAI,CAACtB,UAAU,CAACO,UAAU,CAAC,CAAC;QAC/BS,IAAI,EAAEA;MAAI,IAEdM,MAAI,CAACpB,EACT,CAAC;IAAC;EACN;;EAEA;AACJ;AACA;AACA;EACWsB,QAAQA,CAAA,EAAY;IACvB,OAAO,IAAI,CAACxB,UAAU,CAACO,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,KAAK;EAC1D;;EAEA;AACJ;AACA;AACA;AACA;EACiBkB,SAASA,CAACC,MAAe,EAAiB;IAAA,IAAAC,MAAA;IAAA,OAAAb,iBAAA;MACnD,MAAMa,MAAI,CAAC5B,MAAM,CAACgB,cAAc,CAC5BY,MAAI,CAACjB,MAAM,EACXf,uBAAuB,CAACqB,IAAI,EAAAO,aAAA,CAAAA,aAAA,KAErBI,MAAI,CAAC3B,UAAU,CAACO,UAAU,CAAC,CAAC;QAC/BmB,MAAM,EAAEA;MAAM,IAElBC,MAAI,CAACzB,EACT,CAAC;IAAC;EACN;;EAEA;AACJ;AACA;AACA;EACiB0B,WAAWA,CAAA,EAAsD;IAAA,IAAAC,MAAA;IAAA,OAAAf,iBAAA;MAC1E,IAAMgB,KAAK,SAASD,MAAI,CAACE,YAAY,CAAC,CAAC;MAEvC,IAAMC,IAAI,GAAGF,KAAK,CAACG,kBAAkB,CAAC,CAAC,CAAC,MAAM,CAAC;MAC/C,IAAMC,OAAO,GAAGL,MAAI,CAAC9B,MAAM,CAACoC,YAAY,CAACH,IAAI,CAAC,KAAK,CAAC,CAAC;MAErD,IAAI,CAACE,OAAO,EAAE;QACV,MAAM,IAAI7B,KAAK,8BAAA+B,MAAA,CAA8BJ,IAAI,CAAC,KAAK,CAAC,CAAE,CAAC;MAC/D;MAEA,OAAO;QAAEK,IAAI,EAAEL,IAAI;QAAEE,OAAO,EAAEA;MAAQ,CAAC;IAAC;EAC5C;;EAEA;AACJ;AACA;AACA;EACiBH,YAAYA,CAAA,EAAyB;IAAA,IAAAO,MAAA;IAAA,OAAAxB,iBAAA;MAC9C,IAAMyB,IAAI,GAAGD,MAAI,CAACvC,MAAM,CAACyC,OAAO,CAACF,MAAI,CAAC5B,MAAM,CAAC;MAC7C,IAAI,CAAC6B,IAAI,EAAE,MAAM,IAAIlC,KAAK,CAAC,cAAc,CAAC;MAE1C,IAAIyB,KAA8B,GAAGS,IAAI,CAACE,wBAAwB,CAAC,CAAC,CAACC,aAAa,CAACJ,MAAI,CAACpC,EAAE,CAAC;;MAE3F;MACA,OAAO,CAAC4B,KAAK,IAAIS,IAAI,CAACI,eAAe,CAAC,CAAC,CAACC,QAAQ,CAAChD,aAAa,CAACiD,SAAS,CAAC,CAAEC,eAAe,EAAE;QACxF,MAAMR,MAAI,CAACvC,MAAM,CAACgD,UAAU,CAACR,IAAI,EAAE,GAAG,CAAC;QACvCT,KAAK,GAAGS,IAAI,CAACE,wBAAwB,CAAC,CAAC,CAACC,aAAa,CAACJ,MAAI,CAACpC,EAAE,CAAC;MAClE;MAEA,IAAI,CAAC4B,KAAK,EAAE,MAAM,IAAIzB,KAAK,CAAC,sBAAsB,CAAC;;MAEnD;MACA,MAAMiC,MAAI,CAACvC,MAAM,CAACiD,oBAAoB,CAAClB,KAAK,CAAC;MAE7C,OAAOA,KAAK;IAAC;EACjB;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;EACiBmB,gBAAgBA,CACzBjC,IAAY,EACZkC,iBAA2B,EAC3Bb,IAAmB,EACnBc,iBAA4B,EACD;IAAA,IAAAC,MAAA;IAAA,OAAAtC,iBAAA;MAC3B,IAAMuC,iBAAiB,SAASD,MAAI,CAACnD,SAAS,CAACqD,UAAU,CAACtC,IAAI,EAAEkC,iBAAiB,EAAEb,IAAI,EAAAd,aAAA,CAAAA,aAAA,KAC/E4B,iBAAiB,aAAjBA,iBAAiB,cAAjBA,iBAAiB,GAAI,CAAC,CAAC;QAC3B,eAAe,EAAE,IAAI;QACrB,cAAc,EAAE;UACZI,QAAQ,EAAE7D,YAAY,CAAC8D,OAAO;UAC9BC,QAAQ,EAAEL,MAAI,CAAClD;QACnB;MAAC,EACJ,CAAC;;MAEF;MACA,MAAMkD,MAAI,CAACrD,MAAM,CAACgB,cAAc,CAC5BqC,MAAI,CAAC1C,MAAM,EACXf,uBAAuB,CAACqB,IAAI,EAC5B;QACI0C,MAAM,EAAE,IAAI;QACZ1C,IAAI,EAAEA,IAAI;QACVR,OAAO,EAAE4C,MAAI,CAAC5C,OAAO,GAAG;MAC5B,CAAC,EACD6C,iBAAiB,CAAC,UAAU,CAChC,CAAC;;MAED;MACA,MAAMD,MAAI,CAACrD,MAAM,CAACgB,cAAc,CAC5BqC,MAAI,CAAC1C,MAAM,EACXf,uBAAuB,CAACqB,IAAI,EAAAO,aAAA,CAAAA,aAAA,KAErB6B,MAAI,CAACpD,UAAU,CAACO,UAAU,CAAC,CAAC;QAC/BmD,MAAM,EAAE;MAAK,IAEjBN,MAAI,CAAClD,EACT,CAAC;MAED,OAAOmD,iBAAiB;IAAC;EAC7B;;EAEA;AACJ;AACA;AACA;AACA;EACiBlC,iBAAiBA,CAAA,EAA6B;IAAA,IAAAwC,MAAA;IAAA,OAAA7C,iBAAA;MACvD,IAAM8C,WAA4B,GAAG,EAAE;MACvCA,WAAW,CAACC,IAAI,CAACF,MAAI,CAAC,CAAC,CAAC;;MAExB,IAAMpB,IAAI,GAAGoB,MAAI,CAAC5D,MAAM,CAACyC,OAAO,CAACmB,MAAI,CAACjD,MAAM,CAAC;MAC7C,IAAI,CAAC6B,IAAI,EAAE,MAAM,IAAIlC,KAAK,CAAC,yBAAyB,CAAC;;MAErD;MACA;MACA;MACA,IAAMyD,cAAc,GAAG,CAAC,GAAGvB,IAAI,CAACI,eAAe,CAAC,CAAC,CAACoB,SAAS,CAAC,CAAC,CAAC,CAACC,OAAO,CAAC,CAAC;;MAExE;MACA;MACA;MACA,IAAIC,UAAmC;MACvC,IAAIC,WAAW,SAASP,MAAI,CAAC5B,YAAY,CAAC,CAAC;MAC3C,GAAG;QACCkC,UAAU,GAAGH,cAAc,CAACK,IAAI,CAAEC,CAAC,IAAKA,CAAC,CAACC,gBAAgB,CAAC,CAAC,KAAKH,WAAW,CAACI,KAAK,CAAC,CAAC,CAAC;QACrF,IAAIL,UAAU,EAAE;UACZ,IAAMM,MAAM,GAAGZ,MAAI,CAAC1D,SAAS,CAACuE,OAAO,CAACP,UAAU,CAACK,KAAK,CAAC,CAAE,CAAC;UAC1D,IAAIC,MAAM,EAAE;YACRX,WAAW,CAACC,IAAI,CAACU,MAAM,CAAC;YACxBL,WAAW,GAAGD,UAAU;UAC5B,CAAC,MAAM;YACH,MAAM,CAAC;UACX;QACJ;MACJ,CAAC,QAAQA,UAAU;MAEnB,OAAOL,WAAW;IAAC;EACvB;AACJ","ignoreList":[]}
+{"version":3,"file":"MSC3089Branch.js","names":[],"sources":["../../src/models/MSC3089Branch.ts"],"sourcesContent":["/*\nCopyright 2021 The Matrix.org Foundation C.I.C.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\nimport { type MatrixClient } from \"../client.ts\";\nimport { RelationType, UNSTABLE_MSC3089_BRANCH } from \"../@types/event.ts\";\nimport { type IContent, type MatrixEvent } from \"./event.ts\";\nimport { type MSC3089TreeSpace } from \"./MSC3089TreeSpace.ts\";\nimport { EventTimeline } from \"./event-timeline.ts\";\nimport { type FileType } from \"../http-api/index.ts\";\nimport type { ISendEventResponse } from \"../@types/requests.ts\";\nimport { type EncryptedFile } from \"../@types/media.ts\";\n\nexport interface MSC3089EventContent {\n    active?: boolean;\n    name?: string;\n    locked?: boolean;\n    version?: number;\n}\n\nexport interface MSC3089EventContent {\n    active?: boolean;\n    name?: string;\n    locked?: boolean;\n    version?: number;\n}\n\n/**\n * Represents a [MSC3089](https://github.com/matrix-org/matrix-doc/pull/3089) branch - a reference\n * to a file (leaf) in the tree. Note that this is UNSTABLE and subject to breaking changes\n * without notice.\n */\nexport class MSC3089Branch {\n    public constructor(\n        private client: MatrixClient,\n        public readonly indexEvent: MatrixEvent,\n        public readonly directory: MSC3089TreeSpace,\n    ) {\n        // Nothing to do\n    }\n\n    /**\n     * The file ID.\n     */\n    public get id(): string {\n        const stateKey = this.indexEvent.getStateKey();\n        if (!stateKey) {\n            throw new Error(\"State key not found for branch\");\n        }\n        return stateKey;\n    }\n\n    /**\n     * Whether this branch is active/valid.\n     */\n    public get isActive(): boolean {\n        return this.indexEvent.getContent()[\"active\"] === true;\n    }\n\n    /**\n     * Version for the file, one-indexed.\n     */\n    public get version(): number {\n        return this.indexEvent.getContent()[\"version\"] ?? 1;\n    }\n\n    private get roomId(): string {\n        return this.indexEvent.getRoomId()!;\n    }\n\n    /**\n     * Deletes the file from the tree, including all prior edits/versions.\n     * @returns Promise which resolves when complete.\n     */\n    public async delete(): Promise<void> {\n        await this.client.sendStateEvent(this.roomId, UNSTABLE_MSC3089_BRANCH.name, {}, this.id);\n        await this.client.redactEvent(this.roomId, this.id);\n\n        const nextVersion = (await this.getVersionHistory())[1]; // [0] will be us\n        if (nextVersion) await nextVersion.delete(); // implicit recursion\n    }\n\n    /**\n     * Gets the name for this file.\n     * @returns The name, or \"Unnamed File\" if unknown.\n     */\n    public getName(): string {\n        return this.indexEvent.getContent()[\"name\"] || \"Unnamed File\";\n    }\n\n    /**\n     * Sets the name for this file.\n     * @param name - The new name for this file.\n     * @returns Promise which resolves when complete.\n     */\n    public async setName(name: string): Promise<void> {\n        await this.client.sendStateEvent(\n            this.roomId,\n            UNSTABLE_MSC3089_BRANCH.name,\n            {\n                ...this.indexEvent.getContent(),\n                name: name,\n            },\n            this.id,\n        );\n    }\n\n    /**\n     * Gets whether or not a file is locked.\n     * @returns True if locked, false otherwise.\n     */\n    public isLocked(): boolean {\n        return this.indexEvent.getContent()[\"locked\"] || false;\n    }\n\n    /**\n     * Sets a file as locked or unlocked.\n     * @param locked - True to lock the file, false otherwise.\n     * @returns Promise which resolves when complete.\n     */\n    public async setLocked(locked: boolean): Promise<void> {\n        await this.client.sendStateEvent(\n            this.roomId,\n            UNSTABLE_MSC3089_BRANCH.name,\n            {\n                ...this.indexEvent.getContent(),\n                locked: locked,\n            },\n            this.id,\n        );\n    }\n\n    /**\n     * Gets information about the file needed to download it.\n     * @returns Information about the file.\n     */\n    public async getFileInfo(): Promise<{ info: EncryptedFile; httpUrl: string }> {\n        const event = await this.getFileEvent();\n\n        const file = event.getOriginalContent()[\"file\"];\n        const httpUrl = this.client.mxcUrlToHttp(file[\"url\"]);\n\n        if (!httpUrl) {\n            throw new Error(`No HTTP URL available for ${file[\"url\"]}`);\n        }\n\n        return { info: file, httpUrl: httpUrl };\n    }\n\n    /**\n     * Gets the event the file points to.\n     * @returns Promise which resolves to the file's event.\n     */\n    public async getFileEvent(): Promise<MatrixEvent> {\n        const room = this.client.getRoom(this.roomId);\n        if (!room) throw new Error(\"Unknown room\");\n\n        let event: MatrixEvent | undefined = room.getUnfilteredTimelineSet().findEventById(this.id);\n\n        // keep scrolling back if needed until we find the event or reach the start of the room:\n        while (!event && room.getLiveTimeline().getState(EventTimeline.BACKWARDS)!.paginationToken) {\n            await this.client.scrollback(room, 100);\n            event = room.getUnfilteredTimelineSet().findEventById(this.id);\n        }\n\n        if (!event) throw new Error(\"Failed to find event\");\n\n        // Sometimes the event isn't decrypted for us, so do that.\n        await this.client.decryptEventIfNeeded(event);\n\n        return event;\n    }\n\n    /**\n     * Creates a new version of this file with contents in a type that is compatible with MatrixClient.uploadContent().\n     * @param name - The name of the file.\n     * @param encryptedContents - The encrypted contents.\n     * @param info - The encrypted file information.\n     * @param additionalContent - Optional event content fields to include in the message.\n     * @returns Promise which resolves to the file event's sent response.\n     */\n    public async createNewVersion(\n        name: string,\n        encryptedContents: FileType,\n        info: EncryptedFile,\n        additionalContent?: IContent,\n    ): Promise<ISendEventResponse> {\n        const fileEventResponse = await this.directory.createFile(name, encryptedContents, info, {\n            ...additionalContent,\n            \"m.new_content\": true,\n            \"m.relates_to\": {\n                rel_type: RelationType.Replace,\n                event_id: this.id,\n            },\n        });\n\n        // Update the version of the new event\n        await this.client.sendStateEvent(\n            this.roomId,\n            UNSTABLE_MSC3089_BRANCH.name,\n            {\n                active: true,\n                name: name,\n                version: this.version + 1,\n            },\n            fileEventResponse[\"event_id\"],\n        );\n\n        // Deprecate ourselves\n        await this.client.sendStateEvent(\n            this.roomId,\n            UNSTABLE_MSC3089_BRANCH.name,\n            {\n                ...this.indexEvent.getContent(),\n                active: false,\n            },\n            this.id,\n        );\n\n        return fileEventResponse;\n    }\n\n    /**\n     * Gets the file's version history, starting at this file.\n     * @returns Promise which resolves to the file's version history, with the\n     * first element being the current version and the last element being the first version.\n     */\n    public async getVersionHistory(): Promise<MSC3089Branch[]> {\n        const fileHistory: MSC3089Branch[] = [];\n        fileHistory.push(this); // start with ourselves\n\n        const room = this.client.getRoom(this.roomId);\n        if (!room) throw new Error(\"Invalid or unknown room\");\n\n        // Clone the timeline to reverse it, getting most-recent-first ordering, hopefully\n        // shortening the awful loop below. Without the clone, we can unintentionally mutate\n        // the timeline.\n        const timelineEvents = [...room.getLiveTimeline().getEvents()].reverse();\n\n        // XXX: This is a very inefficient search, but it's the best we can do with the\n        // relations structure we have in the SDK. As of writing, it is not worth the\n        // investment in improving the structure.\n        let childEvent: MatrixEvent | undefined;\n        let parentEvent = await this.getFileEvent();\n        do {\n            childEvent = timelineEvents.find((e) => e.replacingEventId() === parentEvent.getId());\n            if (childEvent) {\n                const branch = this.directory.getFile(childEvent.getId()!);\n                if (branch) {\n                    fileHistory.push(branch);\n                    parentEvent = childEvent;\n                } else {\n                    break; // prevent infinite loop\n                }\n            }\n        } while (childEvent);\n\n        return fileHistory;\n    }\n}\n"],"mappings":";AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA,SAAS,YAAY,EAAE,uBAAuB,QAAQ,oBAAoB;AAG1E,SAAS,aAAa,QAAQ,qBAAqB;AAmBnD;AACA;AACA;AACA;AACA;AACA,OAAO,MAAM,aAAa,CAAC;EAChB,WAAW,CACN,MAAoB,EACZ,UAAuB,EACvB,SAA2B,EAC7C;IAAA,KAHU,MAAoB,GAApB,MAAoB;IAAA,KACZ,UAAuB,GAAvB,UAAuB;IAAA,KACvB,SAA2B,GAA3B,SAA2B;EAG/C,CAAC,CADG;;EAGJ;AACJ;AACA;EACI,IAAW,EAAE,GAAW;IACpB,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;IAC9C,IAAI,CAAC,QAAQ,EAAE;MACX,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC;IACrD;IACA,OAAO,QAAQ;EACnB;;EAEA;AACJ;AACA;EACI,IAAW,QAAQ,GAAY;IAC3B,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,IAAI;EAC1D;;EAEA;AACJ;AACA;EACI,IAAW,OAAO,GAAW;IACzB,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC;EACvD;EAEA,IAAY,MAAM,GAAW;IACzB,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;EACtC;;EAEA;AACJ;AACA;AACA;EACI,MAAa,MAAM,GAAkB;IACjC,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,uBAAuB,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC;IACxF,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC;IAEnD,MAAM,WAAW,GAAG,CAAC,MAAM,IAAI,CAAC,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACzD,IAAI,WAAW,EAAE,MAAM,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;EACjD;;EAEA;AACJ;AACA;AACA;EACW,OAAO,GAAW;IACrB,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,cAAc;EACjE;;EAEA;AACJ;AACA;AACA;AACA;EACI,MAAa,OAAO,CAAC,IAAY,EAAiB;IAC9C,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,CAC5B,IAAI,CAAC,MAAM,EACX,uBAAuB,CAAC,IAAI,kCAErB,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;MAC/B,IAAI,EAAE;IAAI,IAEd,IAAI,CAAC,EACT,CAAC;EACL;;EAEA;AACJ;AACA;AACA;EACW,QAAQ,GAAY;IACvB,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,KAAK;EAC1D;;EAEA;AACJ;AACA;AACA;AACA;EACI,MAAa,SAAS,CAAC,MAAe,EAAiB;IACnD,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,CAC5B,IAAI,CAAC,MAAM,EACX,uBAAuB,CAAC,IAAI,kCAErB,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;MAC/B,MAAM,EAAE;IAAM,IAElB,IAAI,CAAC,EACT,CAAC;EACL;;EAEA;AACJ;AACA;AACA;EACI,MAAa,WAAW,GAAsD;IAC1E,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,CAAC;IAEvC,MAAM,IAAI,GAAG,KAAK,CAAC,kBAAkB,CAAC,CAAC,CAAC,MAAM,CAAC;IAC/C,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAErD,IAAI,CAAC,OAAO,EAAE;MACV,MAAM,IAAI,KAAK,CAAC,6BAA6B,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;IAC/D;IAEA,OAAO;MAAE,IAAI,EAAE,IAAI;MAAE,OAAO,EAAE;IAAQ,CAAC;EAC3C;;EAEA;AACJ;AACA;AACA;EACI,MAAa,YAAY,GAAyB;IAC9C,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC;IAC7C,IAAI,CAAC,IAAI,EAAE,MAAM,IAAI,KAAK,CAAC,cAAc,CAAC;IAE1C,IAAI,KAA8B,GAAG,IAAI,CAAC,wBAAwB,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;;IAE3F;IACA,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,SAAS,CAAC,CAAE,eAAe,EAAE;MACxF,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC;MACvC,KAAK,GAAG,IAAI,CAAC,wBAAwB,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;IAClE;IAEA,IAAI,CAAC,KAAK,EAAE,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC;;IAEnD;IACA,MAAM,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,KAAK,CAAC;IAE7C,OAAO,KAAK;EAChB;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;EACI,MAAa,gBAAgB,CACzB,IAAY,EACZ,iBAA2B,EAC3B,IAAmB,EACnB,iBAA4B,EACD;IAC3B,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,EAAE,iBAAiB,EAAE,IAAI,kCAChF,iBAAiB;MACpB,eAAe,EAAE,IAAI;MACrB,cAAc,EAAE;QACZ,QAAQ,EAAE,YAAY,CAAC,OAAO;QAC9B,QAAQ,EAAE,IAAI,CAAC;MACnB;IAAC,EACJ,CAAC;;IAEF;IACA,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,CAC5B,IAAI,CAAC,MAAM,EACX,uBAAuB,CAAC,IAAI,EAC5B;MACI,MAAM,EAAE,IAAI;MACZ,IAAI,EAAE,IAAI;MACV,OAAO,EAAE,IAAI,CAAC,OAAO,GAAG;IAC5B,CAAC,EACD,iBAAiB,CAAC,UAAU,CAChC,CAAC;;IAED;IACA,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,CAC5B,IAAI,CAAC,MAAM,EACX,uBAAuB,CAAC,IAAI,kCAErB,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;MAC/B,MAAM,EAAE;IAAK,IAEjB,IAAI,CAAC,EACT,CAAC;IAED,OAAO,iBAAiB;EAC5B;;EAEA;AACJ;AACA;AACA;AACA;EACI,MAAa,iBAAiB,GAA6B;IACvD,MAAM,WAA4B,GAAG,EAAE;IACvC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;;IAExB,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC;IAC7C,IAAI,CAAC,IAAI,EAAE,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC;;IAErD;IACA;IACA;IACA,MAAM,cAAc,GAAG,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;;IAExE;IACA;IACA;IACA,IAAI,UAAmC;IACvC,IAAI,WAAW,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,CAAC;IAC3C,GAAG;MACC,UAAU,GAAG,cAAc,CAAC,IAAI,CAAE,CAAC,IAAK,CAAC,CAAC,gBAAgB,CAAC,CAAC,KAAK,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;MACrF,IAAI,UAAU,EAAE;QACZ,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAE,CAAC;QAC1D,IAAI,MAAM,EAAE;UACR,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC;UACxB,WAAW,GAAG,UAAU;QAC5B,CAAC,MAAM;UACH,MAAM,CAAC;QACX;MACJ;IACJ,CAAC,QAAQ,UAAU;IAEnB,OAAO,WAAW;EACtB;AACJ","ignoreList":[]}