1
|
{"version":3,"file":"MSC3089Branch.js","names":["_event","require","_eventTimeline","ownKeys","object","enumerableOnly","keys","Object","getOwnPropertySymbols","symbols","filter","sym","getOwnPropertyDescriptor","enumerable","push","apply","_objectSpread","target","i","arguments","length","source","forEach","key","_defineProperty2","default","getOwnPropertyDescriptors","defineProperties","defineProperty","MSC3089Branch","constructor","client","indexEvent","directory","id","stateKey","getStateKey","Error","isActive","getContent","version","_this$indexEvent$getC","roomId","getRoomId","delete","sendStateEvent","UNSTABLE_MSC3089_BRANCH","name","redactEvent","nextVersion","getVersionHistory","getName","setName","isLocked","setLocked","locked","getFileInfo","event","getFileEvent","file","getOriginalContent","httpUrl","mxcUrlToHttp","info","room","getRoom","getUnfilteredTimelineSet","findEventById","getLiveTimeline","getState","EventTimeline","BACKWARDS","paginationToken","scrollback","decryptEventIfNeeded","emit","isRetry","createNewVersion","encryptedContents","additionalContent","fileEventResponse","createFile","rel_type","RelationType","Replace","event_id","active","fileHistory","timelineEvents","getEvents","reverse","childEvent","parentEvent","find","e","replacingEventId","getId","branch","getFile","exports"],"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 { MatrixClient } from \"../client\";\nimport { IEncryptedFile, RelationType, UNSTABLE_MSC3089_BRANCH } from \"../@types/event\";\nimport { IContent, MatrixEvent } from \"./event\";\nimport { MSC3089TreeSpace } from \"./MSC3089TreeSpace\";\nimport { EventTimeline } from \"./event-timeline\";\nimport { FileType } from \"../http-api\";\nimport type { ISendEventResponse } from \"../@types/requests\";\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: IEncryptedFile; 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. We specifically set `emit: true`\n // to ensure that the relations system in the sdk will function.\n await this.client.decryptEventIfNeeded(event, { emit: true, isRetry: true });\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: Partial<IEncryptedFile>,\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":";;;;;;;;AAiBA,IAAAA,MAAA,GAAAC,OAAA;AAGA,IAAAC,cAAA,GAAAD,OAAA;AAAiD,SAAAE,QAAAC,MAAA,EAAAC,cAAA,QAAAC,IAAA,GAAAC,MAAA,CAAAD,IAAA,CAAAF,MAAA,OAAAG,MAAA,CAAAC,qBAAA,QAAAC,OAAA,GAAAF,MAAA,CAAAC,qBAAA,CAAAJ,MAAA,GAAAC,cAAA,KAAAI,OAAA,GAAAA,OAAA,CAAAC,MAAA,WAAAC,GAAA,WAAAJ,MAAA,CAAAK,wBAAA,CAAAR,MAAA,EAAAO,GAAA,EAAAE,UAAA,OAAAP,IAAA,CAAAQ,IAAA,CAAAC,KAAA,CAAAT,IAAA,EAAAG,OAAA,YAAAH,IAAA;AAAA,SAAAU,cAAAC,MAAA,aAAAC,CAAA,MAAAA,CAAA,GAAAC,SAAA,CAAAC,MAAA,EAAAF,CAAA,UAAAG,MAAA,WAAAF,SAAA,CAAAD,CAAA,IAAAC,SAAA,CAAAD,CAAA,QAAAA,CAAA,OAAAf,OAAA,CAAAI,MAAA,CAAAc,MAAA,OAAAC,OAAA,WAAAC,GAAA,QAAAC,gBAAA,CAAAC,OAAA,EAAAR,MAAA,EAAAM,GAAA,EAAAF,MAAA,CAAAE,GAAA,SAAAhB,MAAA,CAAAmB,yBAAA,GAAAnB,MAAA,CAAAoB,gBAAA,CAAAV,MAAA,EAAAV,MAAA,CAAAmB,yBAAA,CAAAL,MAAA,KAAAlB,OAAA,CAAAI,MAAA,CAAAc,MAAA,GAAAC,OAAA,WAAAC,GAAA,IAAAhB,MAAA,CAAAqB,cAAA,CAAAX,MAAA,EAAAM,GAAA,EAAAhB,MAAA,CAAAK,wBAAA,CAAAS,MAAA,EAAAE,GAAA,iBAAAN,MAAA;AAIjD;AACA;AACA;AACA;AACA;AACO,MAAMY,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,MAAMC,QAAQ,GAAG,IAAI,CAACH,UAAU,CAACI,WAAW,EAAE;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,EAAE,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,EAAE,CAAC,SAAS,CAAC,cAAAE,qBAAA,cAAAA,qBAAA,GAAI,CAAC;EACvD;EAEA,IAAYC,MAAMA,CAAA,EAAW;IACzB,OAAO,IAAI,CAACV,UAAU,CAACW,SAAS,EAAE;EACtC;;EAEA;AACJ;AACA;AACA;EACI,MAAaC,MAAMA,CAAA,EAAkB;IACjC,MAAM,IAAI,CAACb,MAAM,CAACc,cAAc,CAAC,IAAI,CAACH,MAAM,EAAEI,8BAAuB,CAACC,IAAI,EAAE,CAAC,CAAC,EAAE,IAAI,CAACb,EAAE,CAAC;IACxF,MAAM,IAAI,CAACH,MAAM,CAACiB,WAAW,CAAC,IAAI,CAACN,MAAM,EAAE,IAAI,CAACR,EAAE,CAAC;IAEnD,MAAMe,WAAW,GAAG,CAAC,MAAM,IAAI,CAACC,iBAAiB,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;IACzD,IAAID,WAAW,EAAE,MAAMA,WAAW,CAACL,MAAM,EAAE,CAAC,CAAC;EACjD;;EAEA;AACJ;AACA;AACA;EACWO,OAAOA,CAAA,EAAW;IACrB,OAAO,IAAI,CAACnB,UAAU,CAACO,UAAU,EAAE,CAAC,MAAM,CAAC,IAAI,cAAc;EACjE;;EAEA;AACJ;AACA;AACA;AACA;EACI,MAAaa,OAAOA,CAACL,IAAY,EAAiB;IAC9C,MAAM,IAAI,CAAChB,MAAM,CAACc,cAAc,CAC5B,IAAI,CAACH,MAAM,EACXI,8BAAuB,CAACC,IAAI,EAAA/B,aAAA,CAAAA,aAAA,KAErB,IAAI,CAACgB,UAAU,CAACO,UAAU,EAAE;MAC/BQ,IAAI,EAAEA;IAAI,IAEd,IAAI,CAACb,EAAE,CACV;EACL;;EAEA;AACJ;AACA;AACA;EACWmB,QAAQA,CAAA,EAAY;IACvB,OAAO,IAAI,CAACrB,UAAU,CAACO,UAAU,EAAE,CAAC,QAAQ,CAAC,IAAI,KAAK;EAC1D;;EAEA;AACJ;AACA;AACA;AACA;EACI,MAAae,SAASA,CAACC,MAAe,EAAiB;IACnD,MAAM,IAAI,CAACxB,MAAM,CAACc,cAAc,CAC5B,IAAI,CAACH,MAAM,EACXI,8BAAuB,CAACC,IAAI,EAAA/B,aAAA,CAAAA,aAAA,KAErB,IAAI,CAACgB,UAAU,CAACO,UAAU,EAAE;MAC/BgB,MAAM,EAAEA;IAAM,IAElB,IAAI,CAACrB,EAAE,CACV;EACL;;EAEA;AACJ;AACA;AACA;EACI,MAAasB,WAAWA,CAAA,EAAuD;IAC3E,MAAMC,KAAK,GAAG,MAAM,IAAI,CAACC,YAAY,EAAE;IAEvC,MAAMC,IAAI,GAAGF,KAAK,CAACG,kBAAkB,EAAE,CAAC,MAAM,CAAC;IAC/C,MAAMC,OAAO,GAAG,IAAI,CAAC9B,MAAM,CAAC+B,YAAY,CAACH,IAAI,CAAC,KAAK,CAAC,CAAC;IAErD,IAAI,CAACE,OAAO,EAAE;MACV,MAAM,IAAIxB,KAAK,CAAE,6BAA4BsB,IAAI,CAAC,KAAK,CAAE,EAAC,CAAC;IAC/D;IAEA,OAAO;MAAEI,IAAI,EAAEJ,IAAI;MAAEE,OAAO,EAAEA;IAAQ,CAAC;EAC3C;;EAEA;AACJ;AACA;AACA;EACI,MAAaH,YAAYA,CAAA,EAAyB;IAC9C,MAAMM,IAAI,GAAG,IAAI,CAACjC,MAAM,CAACkC,OAAO,CAAC,IAAI,CAACvB,MAAM,CAAC;IAC7C,IAAI,CAACsB,IAAI,EAAE,MAAM,IAAI3B,KAAK,CAAC,cAAc,CAAC;IAE1C,IAAIoB,KAA8B,GAAGO,IAAI,CAACE,wBAAwB,EAAE,CAACC,aAAa,CAAC,IAAI,CAACjC,EAAE,CAAC;;IAE3F;IACA,OAAO,CAACuB,KAAK,IAAIO,IAAI,CAACI,eAAe,EAAE,CAACC,QAAQ,CAACC,4BAAa,CAACC,SAAS,CAAC,CAAEC,eAAe,EAAE;MACxF,MAAM,IAAI,CAACzC,MAAM,CAAC0C,UAAU,CAACT,IAAI,EAAE,GAAG,CAAC;MACvCP,KAAK,GAAGO,IAAI,CAACE,wBAAwB,EAAE,CAACC,aAAa,CAAC,IAAI,CAACjC,EAAE,CAAC;IAClE;IAEA,IAAI,CAACuB,KAAK,EAAE,MAAM,IAAIpB,KAAK,CAAC,sBAAsB,CAAC;;IAEnD;IACA;IACA,MAAM,IAAI,CAACN,MAAM,CAAC2C,oBAAoB,CAACjB,KAAK,EAAE;MAAEkB,IAAI,EAAE,IAAI;MAAEC,OAAO,EAAE;IAAK,CAAC,CAAC;IAE5E,OAAOnB,KAAK;EAChB;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;EACI,MAAaoB,gBAAgBA,CACzB9B,IAAY,EACZ+B,iBAA2B,EAC3Bf,IAA6B,EAC7BgB,iBAA4B,EACD;IAC3B,MAAMC,iBAAiB,GAAG,MAAM,IAAI,CAAC/C,SAAS,CAACgD,UAAU,CAAClC,IAAI,EAAE+B,iBAAiB,EAAEf,IAAI,EAAA/C,aAAA,CAAAA,aAAA,KAC/E+D,iBAAiB,aAAjBA,iBAAiB,cAAjBA,iBAAiB,GAAI,CAAC,CAAC;MAC3B,eAAe,EAAE,IAAI;MACrB,cAAc,EAAE;QACZG,QAAQ,EAAEC,mBAAY,CAACC,OAAO;QAC9BC,QAAQ,EAAE,IAAI,CAACnD;MACnB;IAAC,GACH;;IAEF;IACA,MAAM,IAAI,CAACH,MAAM,CAACc,cAAc,CAC5B,IAAI,CAACH,MAAM,EACXI,8BAAuB,CAACC,IAAI,EAC5B;MACIuC,MAAM,EAAE,IAAI;MACZvC,IAAI,EAAEA,IAAI;MACVP,OAAO,EAAE,IAAI,CAACA,OAAO,GAAG;IAC5B,CAAC,EACDwC,iBAAiB,CAAC,UAAU,CAAC,CAChC;;IAED;IACA,MAAM,IAAI,CAACjD,MAAM,CAACc,cAAc,CAC5B,IAAI,CAACH,MAAM,EACXI,8BAAuB,CAACC,IAAI,EAAA/B,aAAA,CAAAA,aAAA,KAErB,IAAI,CAACgB,UAAU,CAACO,UAAU,EAAE;MAC/B+C,MAAM,EAAE;IAAK,IAEjB,IAAI,CAACpD,EAAE,CACV;IAED,OAAO8C,iBAAiB;EAC5B;;EAEA;AACJ;AACA;AACA;AACA;EACI,MAAa9B,iBAAiBA,CAAA,EAA6B;IACvD,MAAMqC,WAA4B,GAAG,EAAE;IACvCA,WAAW,CAACzE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;;IAExB,MAAMkD,IAAI,GAAG,IAAI,CAACjC,MAAM,CAACkC,OAAO,CAAC,IAAI,CAACvB,MAAM,CAAC;IAC7C,IAAI,CAACsB,IAAI,EAAE,MAAM,IAAI3B,KAAK,CAAC,yBAAyB,CAAC;;IAErD;IACA;IACA;IACA,MAAMmD,cAAc,GAAG,CAAC,GAAGxB,IAAI,CAACI,eAAe,EAAE,CAACqB,SAAS,EAAE,CAAC,CAACC,OAAO,EAAE;;IAExE;IACA;IACA;IACA,IAAIC,UAAmC;IACvC,IAAIC,WAAW,GAAG,MAAM,IAAI,CAAClC,YAAY,EAAE;IAC3C,GAAG;MACCiC,UAAU,GAAGH,cAAc,CAACK,IAAI,CAAEC,CAAC,IAAKA,CAAC,CAACC,gBAAgB,EAAE,KAAKH,WAAW,CAACI,KAAK,EAAE,CAAC;MACrF,IAAIL,UAAU,EAAE;QACZ,MAAMM,MAAM,GAAG,IAAI,CAAChE,SAAS,CAACiE,OAAO,CAACP,UAAU,CAACK,KAAK,EAAE,CAAE;QAC1D,IAAIC,MAAM,EAAE;UACRV,WAAW,CAACzE,IAAI,CAACmF,MAAM,CAAC;UACxBL,WAAW,GAAGD,UAAU;QAC5B,CAAC,MAAM;UACH,MAAM,CAAC;QACX;MACJ;IACJ,CAAC,QAAQA,UAAU;IAEnB,OAAOJ,WAAW;EACtB;AACJ;AAACY,OAAA,CAAAtE,aAAA,GAAAA,aAAA"}
|
