@itwin/core-backend 3.5.0-dev.8 → 3.5.1

package/lib/cjs/TileStorage.js

@@ -1,91 +1,91 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TileStorage = void 0;
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-const zlib_1 = require("zlib");
-const util_1 = require("util");
-const core_common_1 = require("@itwin/core-common");
-const core_bentley_1 = require("@itwin/core-bentley");
-const BackendLoggerCategory_1 = require("./BackendLoggerCategory");
-const IModelHost_1 = require("./IModelHost");
-/** @beta */
-class TileStorage {
-    constructor(storage) {
-        this.storage = storage;
-        this._initializedIModels = new Set();
-    }
-    async initialize(iModelId) {
-        if (this._initializedIModels.has(iModelId))
-            return;
-        if (!(await this.storage.baseDirectoryExists({ baseDirectory: iModelId }))) {
-            await this.storage.createBaseDirectory({ baseDirectory: iModelId });
-        }
-        this._initializedIModels.add(iModelId);
-    }
-    async getDownloadConfig(iModelId, expiresInSeconds) {
-        try {
-            return await this.storage.getDownloadConfig({ baseDirectory: iModelId }, expiresInSeconds);
-        }
-        catch (err) {
-            this.logException("Failed to get download config", err);
-            throw err;
-        }
-    }
-    async uploadTile(iModelId, changesetId, treeId, contentId, content, guid, metadata) {
-        try {
-            await this.storage.upload((0, core_common_1.getTileObjectReference)(iModelId, changesetId, treeId, contentId, guid), Buffer.from(IModelHost_1.IModelHost.compressCachedTiles ? await (0, util_1.promisify)(zlib_1.gzip)(content.buffer) : content.buffer), metadata, IModelHost_1.IModelHost.compressCachedTiles ? { contentEncoding: "gzip" } : undefined);
-        }
-        catch (err) {
-            this.logException("Failed to upload tile", err);
-            throw err;
-        }
-    }
-    async downloadTile(iModelId, changesetId, treeId, contentId, guid) {
-        try {
-            const buffer = await this.storage.download((0, core_common_1.getTileObjectReference)(iModelId, changesetId, treeId, contentId, guid), "buffer");
-            return IModelHost_1.IModelHost.compressCachedTiles ? await (0, util_1.promisify)(zlib_1.gunzip)(buffer) : buffer;
-        }
-        catch (err) {
-            this.logException("Failed to download tile", err);
-            throw err;
-        }
-    }
-    async getCachedTiles(iModelId, _prefix) {
-        return (await this.storage.listObjects({ baseDirectory: iModelId }))
-            .map((objectReference) => {
-            var _a, _b;
-            return ({
-                parts: (_b = (_a = objectReference.relativeDirectory) === null || _a === void 0 ? void 0 : _a.split("/")) !== null && _b !== void 0 ? _b : [""],
-                objectName: objectReference.objectName,
-            });
-        })
-            .filter(({ parts, objectName }) => {
-            if (parts[0] !== "tiles")
-                return false;
-            if (parts.length !== 3) {
-                core_bentley_1.Logger.logWarning(BackendLoggerCategory_1.BackendLoggerCategory.IModelTileStorage, "Malformed tile id found in tile cache: {tileId}", { tileId: [...parts, objectName].join("/") });
-                return false;
-            }
-            return true;
-        }).map(({ parts, objectName }) => {
-            // relativeDirectory = tiles/<treeId>/<guid>
-            // objectName = <contentId>
-            return {
-                treeId: parts[1],
-                contentId: objectName,
-                guid: parts[2],
-            };
-        });
-    }
-    async isTileCached(iModelId, changesetId, treeId, contentId, guid) {
-        return this.storage.objectExists((0, core_common_1.getTileObjectReference)(iModelId, changesetId, treeId, contentId, guid));
-    }
-    logException(message, err) {
-        core_bentley_1.Logger.logException(BackendLoggerCategory_1.BackendLoggerCategory.IModelTileStorage, err, (category, msg, errorMetadata) => core_bentley_1.Logger.logError(category, `${message}: {errorMessage}`, { ...errorMetadata, errorMessage: msg }));
-    }
-}
-exports.TileStorage = TileStorage;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TileStorage = void 0;
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+const zlib_1 = require("zlib");
+const util_1 = require("util");
+const core_common_1 = require("@itwin/core-common");
+const core_bentley_1 = require("@itwin/core-bentley");
+const BackendLoggerCategory_1 = require("./BackendLoggerCategory");
+const IModelHost_1 = require("./IModelHost");
+/** @beta */
+class TileStorage {
+    constructor(storage) {
+        this.storage = storage;
+        this._initializedIModels = new Set();
+    }
+    async initialize(iModelId) {
+        if (this._initializedIModels.has(iModelId))
+            return;
+        if (!(await this.storage.baseDirectoryExists({ baseDirectory: iModelId }))) {
+            await this.storage.createBaseDirectory({ baseDirectory: iModelId });
+        }
+        this._initializedIModels.add(iModelId);
+    }
+    async getDownloadConfig(iModelId, expiresInSeconds) {
+        try {
+            return await this.storage.getDownloadConfig({ baseDirectory: iModelId }, expiresInSeconds);
+        }
+        catch (err) {
+            this.logException("Failed to get download config", err);
+            throw err;
+        }
+    }
+    async uploadTile(iModelId, changesetId, treeId, contentId, content, guid, metadata) {
+        try {
+            await this.storage.upload((0, core_common_1.getTileObjectReference)(iModelId, changesetId, treeId, contentId, guid), Buffer.from(IModelHost_1.IModelHost.compressCachedTiles ? await (0, util_1.promisify)(zlib_1.gzip)(content.buffer) : content.buffer), metadata, IModelHost_1.IModelHost.compressCachedTiles ? { contentEncoding: "gzip" } : undefined);
+        }
+        catch (err) {
+            this.logException("Failed to upload tile", err);
+            throw err;
+        }
+    }
+    async downloadTile(iModelId, changesetId, treeId, contentId, guid) {
+        try {
+            const buffer = await this.storage.download((0, core_common_1.getTileObjectReference)(iModelId, changesetId, treeId, contentId, guid), "buffer");
+            return IModelHost_1.IModelHost.compressCachedTiles ? await (0, util_1.promisify)(zlib_1.gunzip)(buffer) : buffer;
+        }
+        catch (err) {
+            this.logException("Failed to download tile", err);
+            throw err;
+        }
+    }
+    async getCachedTiles(iModelId, _prefix) {
+        return (await this.storage.listObjects({ baseDirectory: iModelId }))
+            .map((objectReference) => {
+            var _a, _b;
+            return ({
+                parts: (_b = (_a = objectReference.relativeDirectory) === null || _a === void 0 ? void 0 : _a.split("/")) !== null && _b !== void 0 ? _b : [""],
+                objectName: objectReference.objectName,
+            });
+        })
+            .filter(({ parts, objectName }) => {
+            if (parts[0] !== "tiles")
+                return false;
+            if (parts.length !== 3) {
+                core_bentley_1.Logger.logWarning(BackendLoggerCategory_1.BackendLoggerCategory.IModelTileStorage, "Malformed tile id found in tile cache: {tileId}", { tileId: [...parts, objectName].join("/") });
+                return false;
+            }
+            return true;
+        }).map(({ parts, objectName }) => {
+            // relativeDirectory = tiles/<treeId>/<guid>
+            // objectName = <contentId>
+            return {
+                treeId: parts[1],
+                contentId: objectName,
+                guid: parts[2],
+            };
+        });
+    }
+    async isTileCached(iModelId, changesetId, treeId, contentId, guid) {
+        return this.storage.objectExists((0, core_common_1.getTileObjectReference)(iModelId, changesetId, treeId, contentId, guid));
+    }
+    logException(message, err) {
+        core_bentley_1.Logger.logException(BackendLoggerCategory_1.BackendLoggerCategory.IModelTileStorage, err, (category, msg, errorMetadata) => core_bentley_1.Logger.logError(category, `${message}: {errorMessage}`, { ...errorMetadata, errorMessage: msg }));
+    }
+}
+exports.TileStorage = TileStorage;
 //# sourceMappingURL=TileStorage.js.map

package/lib/cjs/TileStorage.js.map

@@ -1 +1 @@
-{"version":3,"file":"TileStorage.js","sourceRoot":"","sources":["../../src/TileStorage.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F,+BAAoC;AACpC,+BAAiC;AAEjC,oDAA4D;AAC5D,sDAA6C;AAC7C,mEAAgE;AAChE,6CAA0C;AAE1C,YAAY;AACZ,MAAa,WAAW;IACtB,YAAmC,OAAsB;QAAtB,YAAO,GAAP,OAAO,CAAe;QAEjD,wBAAmB,GAAgB,IAAI,GAAG,EAAE,CAAC;IAFQ,CAAC;IAIvD,KAAK,CAAC,UAAU,CAAC,QAAgB;QACtC,IAAI,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,CAAC;YACxC,OAAO;QACT,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,CAAC,EAAE;YAC1E,MAAM,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,CAAC;SACrE;QACD,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,QAAgB,EAAE,gBAAyB;QACxE,IAAI;YACF,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,aAAa,EAAE,QAAQ,EAAE,EAAE,gBAAgB,CAAC,CAAC;SAC5F;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,CAAC,YAAY,CAAC,+BAA+B,EAAE,GAAG,CAAC,CAAC;YACxD,MAAM,GAAG,CAAC;SACX;IACH,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,QAAgB,EAAE,WAAmB,EAAE,MAAc,EAAE,SAAiB,EAAE,OAAmB,EAAE,IAAa,EAAE,QAAmB;QACvJ,IAAI;YACF,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CACvB,IAAA,oCAAsB,EAAC,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,EACtE,MAAM,CAAC,IAAI,CAAC,uBAAU,CAAC,mBAAmB,CAAC,CAAC,CAAC,MAAM,IAAA,gBAAS,EAAC,WAAI,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EACpG,QAAQ,EACR,uBAAU,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS,CACzE,CAAC;SACH;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,CAAC,YAAY,CAAC,uBAAuB,EAAE,GAAG,CAAC,CAAC;YAChD,MAAM,GAAG,CAAC;SACX;IACH,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,QAAgB,EAAE,WAAmB,EAAE,MAAc,EAAE,SAAiB,EAAE,IAAa;QAC/G,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CACxC,IAAA,oCAAsB,EAAC,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,EACtE,QAAQ,CACT,CAAC;YACF,OAAO,uBAAU,CAAC,mBAAmB,CAAC,CAAC,CAAC,MAAM,IAAA,gBAAS,EAAC,aAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;SAClF;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,CAAC,YAAY,CAAC,yBAAyB,EAAE,GAAG,CAAC,CAAC;YAClD,MAAM,GAAG,CAAC;SACX;IACH,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,QAAgB,EAAE,OAAe;QAC3D,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,CAAC;aACjE,GAAG,CAAC,CAAC,eAAe,EAAE,EAAE;;YAAC,OAAA,CAAC;gBACzB,KAAK,EAAE,MAAA,MAAA,eAAe,CAAC,iBAAiB,0CAAE,KAAK,CAAC,GAAG,CAAC,mCAAI,CAAC,EAAE,CAAC;gBAC5D,UAAU,EAAE,eAAe,CAAC,UAAU;aACvC,CAAC,CAAA;SAAA,CAAC;aACF,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE;YAChC,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,OAAO;gBACtB,OAAO,KAAK,CAAC;YACf,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;gBACtB,qBAAM,CAAC,UAAU,CAAC,6CAAqB,CAAC,iBAAiB,EAAE,iDAAiD,EAAE,EAAE,MAAM,EAAE,CAAC,GAAG,KAAK,EAAE,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBAC5J,OAAO,KAAK,CAAC;aACd;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE;YAC/B,4CAA4C;YAC5C,2BAA2B;YAC3B,OAAO;gBACL,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;gBAChB,SAAS,EAAE,UAAU;gBACrB,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;aACf,CAAC;QACJ,CAAC,CAAC,CAAC;IACP,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,QAAgB,EAAE,WAAmB,EAAE,MAAc,EAAE,SAAiB,EAAE,IAAa;QAC/G,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,IAAA,oCAAsB,EAAC,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;IAC3G,CAAC;IAEO,YAAY,CAAC,OAAe,EAAE,GAAY;QAChD,qBAAM,CAAC,YAAY,CACjB,6CAAqB,CAAC,iBAAiB,EACvC,GAAG,EACH,CAAC,QAAQ,EAAE,GAAG,EAAE,aAAa,EAAE,EAAE,CAAC,qBAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,OAAO,kBAAkB,EAAE,EAAE,GAAG,aAAa,EAAE,YAAY,EAAE,GAAG,EAAE,CAAC,CACnI,CAAC;IACJ,CAAC;CACF;AAtFD,kCAsFC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\nimport { gunzip, gzip } from \"zlib\";\r\nimport { promisify } from \"util\";\r\nimport { Metadata, ServerStorage, TransferConfig } from \"@itwin/object-storage-core\";\r\nimport { getTileObjectReference } from \"@itwin/core-common\";\r\nimport { Logger } from \"@itwin/core-bentley\";\r\nimport { BackendLoggerCategory } from \"./BackendLoggerCategory\";\r\nimport { IModelHost } from \"./IModelHost\";\r\n\r\n/** @beta */\r\nexport class TileStorage {\r\n  public constructor(public readonly storage: ServerStorage) { }\r\n\r\n  private _initializedIModels: Set<string> = new Set();\r\n\r\n  public async initialize(iModelId: string): Promise<void> {\r\n    if (this._initializedIModels.has(iModelId))\r\n      return;\r\n    if (!(await this.storage.baseDirectoryExists({ baseDirectory: iModelId }))) {\r\n      await this.storage.createBaseDirectory({ baseDirectory: iModelId });\r\n    }\r\n    this._initializedIModels.add(iModelId);\r\n  }\r\n\r\n  public async getDownloadConfig(iModelId: string, expiresInSeconds?: number): Promise<TransferConfig> {\r\n    try {\r\n      return await this.storage.getDownloadConfig({ baseDirectory: iModelId }, expiresInSeconds);\r\n    } catch (err) {\r\n      this.logException(\"Failed to get download config\", err);\r\n      throw err;\r\n    }\r\n  }\r\n\r\n  public async uploadTile(iModelId: string, changesetId: string, treeId: string, contentId: string, content: Uint8Array, guid?: string, metadata?: Metadata): Promise<void> {\r\n    try {\r\n      await this.storage.upload(\r\n        getTileObjectReference(iModelId, changesetId, treeId, contentId, guid),\r\n        Buffer.from(IModelHost.compressCachedTiles ? await promisify(gzip)(content.buffer) : content.buffer),\r\n        metadata,\r\n        IModelHost.compressCachedTiles ? { contentEncoding: \"gzip\" } : undefined,\r\n      );\r\n    } catch (err) {\r\n      this.logException(\"Failed to upload tile\", err);\r\n      throw err;\r\n    }\r\n  }\r\n\r\n  public async downloadTile(iModelId: string, changesetId: string, treeId: string, contentId: string, guid?: string): Promise<Uint8Array> {\r\n    try {\r\n      const buffer = await this.storage.download(\r\n        getTileObjectReference(iModelId, changesetId, treeId, contentId, guid),\r\n        \"buffer\"\r\n      );\r\n      return IModelHost.compressCachedTiles ? await promisify(gunzip)(buffer) : buffer;\r\n    } catch (err) {\r\n      this.logException(\"Failed to download tile\", err);\r\n      throw err;\r\n    }\r\n  }\r\n\r\n  public async getCachedTiles(iModelId: string, _prefix: string): Promise<{ treeId: string, contentId: string, guid?: string }[]> {\r\n    return (await this.storage.listObjects({ baseDirectory: iModelId }))\r\n      .map((objectReference) => ({\r\n        parts: objectReference.relativeDirectory?.split(\"/\") ?? [\"\"],\r\n        objectName: objectReference.objectName,\r\n      }))\r\n      .filter(({ parts, objectName }) => {\r\n        if (parts[0] !== \"tiles\")\r\n          return false;\r\n        if (parts.length !== 3) {\r\n          Logger.logWarning(BackendLoggerCategory.IModelTileStorage, \"Malformed tile id found in tile cache: {tileId}\", { tileId: [...parts, objectName].join(\"/\") });\r\n          return false;\r\n        }\r\n        return true;\r\n      }).map(({ parts, objectName }) => {\r\n        // relativeDirectory = tiles/<treeId>/<guid>\r\n        // objectName = <contentId>\r\n        return {\r\n          treeId: parts[1],\r\n          contentId: objectName,\r\n          guid: parts[2],\r\n        };\r\n      });\r\n  }\r\n\r\n  public async isTileCached(iModelId: string, changesetId: string, treeId: string, contentId: string, guid?: string): Promise<boolean> {\r\n    return this.storage.objectExists(getTileObjectReference(iModelId, changesetId, treeId, contentId, guid));\r\n  }\r\n\r\n  private logException(message: string, err: unknown): void {\r\n    Logger.logException(\r\n      BackendLoggerCategory.IModelTileStorage,\r\n      err,\r\n      (category, msg, errorMetadata) => Logger.logError(category, `${message}: {errorMessage}`, { ...errorMetadata, errorMessage: msg })\r\n    );\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"TileStorage.js","sourceRoot":"","sources":["../../src/TileStorage.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F,+BAAoC;AACpC,+BAAiC;AAEjC,oDAA4D;AAC5D,sDAA6C;AAC7C,mEAAgE;AAChE,6CAA0C;AAE1C,YAAY;AACZ,MAAa,WAAW;IACtB,YAAmC,OAAsB;QAAtB,YAAO,GAAP,OAAO,CAAe;QAEjD,wBAAmB,GAAgB,IAAI,GAAG,EAAE,CAAC;IAFQ,CAAC;IAIvD,KAAK,CAAC,UAAU,CAAC,QAAgB;QACtC,IAAI,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,CAAC;YACxC,OAAO;QACT,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,CAAC,EAAE;YAC1E,MAAM,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,CAAC;SACrE;QACD,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,QAAgB,EAAE,gBAAyB;QACxE,IAAI;YACF,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,aAAa,EAAE,QAAQ,EAAE,EAAE,gBAAgB,CAAC,CAAC;SAC5F;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,CAAC,YAAY,CAAC,+BAA+B,EAAE,GAAG,CAAC,CAAC;YACxD,MAAM,GAAG,CAAC;SACX;IACH,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,QAAgB,EAAE,WAAmB,EAAE,MAAc,EAAE,SAAiB,EAAE,OAAmB,EAAE,IAAa,EAAE,QAAmB;QACvJ,IAAI;YACF,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CACvB,IAAA,oCAAsB,EAAC,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,EACtE,MAAM,CAAC,IAAI,CAAC,uBAAU,CAAC,mBAAmB,CAAC,CAAC,CAAC,MAAM,IAAA,gBAAS,EAAC,WAAI,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EACpG,QAAQ,EACR,uBAAU,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS,CACzE,CAAC;SACH;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,CAAC,YAAY,CAAC,uBAAuB,EAAE,GAAG,CAAC,CAAC;YAChD,MAAM,GAAG,CAAC;SACX;IACH,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,QAAgB,EAAE,WAAmB,EAAE,MAAc,EAAE,SAAiB,EAAE,IAAa;QAC/G,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CACxC,IAAA,oCAAsB,EAAC,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,EACtE,QAAQ,CACT,CAAC;YACF,OAAO,uBAAU,CAAC,mBAAmB,CAAC,CAAC,CAAC,MAAM,IAAA,gBAAS,EAAC,aAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;SAClF;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,CAAC,YAAY,CAAC,yBAAyB,EAAE,GAAG,CAAC,CAAC;YAClD,MAAM,GAAG,CAAC;SACX;IACH,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,QAAgB,EAAE,OAAe;QAC3D,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,CAAC;aACjE,GAAG,CAAC,CAAC,eAAe,EAAE,EAAE;;YAAC,OAAA,CAAC;gBACzB,KAAK,EAAE,MAAA,MAAA,eAAe,CAAC,iBAAiB,0CAAE,KAAK,CAAC,GAAG,CAAC,mCAAI,CAAC,EAAE,CAAC;gBAC5D,UAAU,EAAE,eAAe,CAAC,UAAU;aACvC,CAAC,CAAA;SAAA,CAAC;aACF,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE;YAChC,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,OAAO;gBACtB,OAAO,KAAK,CAAC;YACf,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;gBACtB,qBAAM,CAAC,UAAU,CAAC,6CAAqB,CAAC,iBAAiB,EAAE,iDAAiD,EAAE,EAAE,MAAM,EAAE,CAAC,GAAG,KAAK,EAAE,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBAC5J,OAAO,KAAK,CAAC;aACd;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE;YAC/B,4CAA4C;YAC5C,2BAA2B;YAC3B,OAAO;gBACL,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;gBAChB,SAAS,EAAE,UAAU;gBACrB,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;aACf,CAAC;QACJ,CAAC,CAAC,CAAC;IACP,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,QAAgB,EAAE,WAAmB,EAAE,MAAc,EAAE,SAAiB,EAAE,IAAa;QAC/G,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,IAAA,oCAAsB,EAAC,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;IAC3G,CAAC;IAEO,YAAY,CAAC,OAAe,EAAE,GAAY;QAChD,qBAAM,CAAC,YAAY,CACjB,6CAAqB,CAAC,iBAAiB,EACvC,GAAG,EACH,CAAC,QAAQ,EAAE,GAAG,EAAE,aAAa,EAAE,EAAE,CAAC,qBAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,OAAO,kBAAkB,EAAE,EAAE,GAAG,aAAa,EAAE,YAAY,EAAE,GAAG,EAAE,CAAC,CACnI,CAAC;IACJ,CAAC;CACF;AAtFD,kCAsFC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\nimport { gunzip, gzip } from \"zlib\";\nimport { promisify } from \"util\";\nimport { Metadata, ServerStorage, TransferConfig } from \"@itwin/object-storage-core\";\nimport { getTileObjectReference } from \"@itwin/core-common\";\nimport { Logger } from \"@itwin/core-bentley\";\nimport { BackendLoggerCategory } from \"./BackendLoggerCategory\";\nimport { IModelHost } from \"./IModelHost\";\n\n/** @beta */\nexport class TileStorage {\n  public constructor(public readonly storage: ServerStorage) { }\n\n  private _initializedIModels: Set<string> = new Set();\n\n  public async initialize(iModelId: string): Promise<void> {\n    if (this._initializedIModels.has(iModelId))\n      return;\n    if (!(await this.storage.baseDirectoryExists({ baseDirectory: iModelId }))) {\n      await this.storage.createBaseDirectory({ baseDirectory: iModelId });\n    }\n    this._initializedIModels.add(iModelId);\n  }\n\n  public async getDownloadConfig(iModelId: string, expiresInSeconds?: number): Promise<TransferConfig> {\n    try {\n      return await this.storage.getDownloadConfig({ baseDirectory: iModelId }, expiresInSeconds);\n    } catch (err) {\n      this.logException(\"Failed to get download config\", err);\n      throw err;\n    }\n  }\n\n  public async uploadTile(iModelId: string, changesetId: string, treeId: string, contentId: string, content: Uint8Array, guid?: string, metadata?: Metadata): Promise<void> {\n    try {\n      await this.storage.upload(\n        getTileObjectReference(iModelId, changesetId, treeId, contentId, guid),\n        Buffer.from(IModelHost.compressCachedTiles ? await promisify(gzip)(content.buffer) : content.buffer),\n        metadata,\n        IModelHost.compressCachedTiles ? { contentEncoding: \"gzip\" } : undefined,\n      );\n    } catch (err) {\n      this.logException(\"Failed to upload tile\", err);\n      throw err;\n    }\n  }\n\n  public async downloadTile(iModelId: string, changesetId: string, treeId: string, contentId: string, guid?: string): Promise<Uint8Array> {\n    try {\n      const buffer = await this.storage.download(\n        getTileObjectReference(iModelId, changesetId, treeId, contentId, guid),\n        \"buffer\"\n      );\n      return IModelHost.compressCachedTiles ? await promisify(gunzip)(buffer) : buffer;\n    } catch (err) {\n      this.logException(\"Failed to download tile\", err);\n      throw err;\n    }\n  }\n\n  public async getCachedTiles(iModelId: string, _prefix: string): Promise<{ treeId: string, contentId: string, guid?: string }[]> {\n    return (await this.storage.listObjects({ baseDirectory: iModelId }))\n      .map((objectReference) => ({\n        parts: objectReference.relativeDirectory?.split(\"/\") ?? [\"\"],\n        objectName: objectReference.objectName,\n      }))\n      .filter(({ parts, objectName }) => {\n        if (parts[0] !== \"tiles\")\n          return false;\n        if (parts.length !== 3) {\n          Logger.logWarning(BackendLoggerCategory.IModelTileStorage, \"Malformed tile id found in tile cache: {tileId}\", { tileId: [...parts, objectName].join(\"/\") });\n          return false;\n        }\n        return true;\n      }).map(({ parts, objectName }) => {\n        // relativeDirectory = tiles/<treeId>/<guid>\n        // objectName = <contentId>\n        return {\n          treeId: parts[1],\n          contentId: objectName,\n          guid: parts[2],\n        };\n      });\n  }\n\n  public async isTileCached(iModelId: string, changesetId: string, treeId: string, contentId: string, guid?: string): Promise<boolean> {\n    return this.storage.objectExists(getTileObjectReference(iModelId, changesetId, treeId, contentId, guid));\n  }\n\n  private logException(message: string, err: unknown): void {\n    Logger.logException(\n      BackendLoggerCategory.IModelTileStorage,\n      err,\n      (category, msg, errorMetadata) => Logger.logError(category, `${message}: {errorMessage}`, { ...errorMetadata, errorMessage: msg })\n    );\n  }\n}\n"]}

package/lib/cjs/TxnManager.d.ts

@@ -1,203 +1,203 @@
-/** @packageDocumentation
- * @module iModels
- */
-import { BeEvent, DbResult, Id64String, IModelStatus } from "@itwin/core-bentley";
-import { EntityIdAndClassIdIterable, ModelGeometryChangesProps, ModelIdAndGeometryGuid } from "@itwin/core-common";
-import { BriefcaseDb, StandaloneDb } from "./IModelDb";
-import { RelationshipProps } from "./Relationship";
-/** A string that identifies a Txn.
- * @public
- */
-export declare type TxnIdString = string;
-/** An error generated during dependency validation.
- * @see [[TxnManager.validationErrors]].
- * @public
- */
-export interface ValidationError {
-    /** If true, txn is aborted. */
-    fatal: boolean;
-    /** The type of error. */
-    errorType: string;
-    /** Optional description of what went wrong. */
-    message?: string;
-}
-/** Describes a set of [[Element]]s or [[Model]]s that changed as part of a transaction.
- * @see [[TxnManager.onElementsChanged]] and [[TxnManager.onModelsChanged]].
- * @public
- */
-export interface TxnChangedEntities {
-    /** The entities that were inserted by the transaction. */
-    readonly inserts: EntityIdAndClassIdIterable;
-    /** The entities that were deleted by the transaction. */
-    readonly deletes: EntityIdAndClassIdIterable;
-    /** The entities that were modified by the transaction, including any [[Element]]s for which one of their [[ElementAspect]]s was changed. */
-    readonly updates: EntityIdAndClassIdIterable;
-}
-/** Strictly for tests. @internal */
-export declare function setMaxEntitiesPerEvent(max: number): number;
-/** Manages local changes to a [[BriefcaseDb]] or [[StandaloneDb]] via [Txns]($docs/learning/InteractiveEditing.md)
- * @public
- */
-export declare class TxnManager {
-    private _iModel;
-    /** @internal */
-    private _isDisposed;
-    /** @internal */
-    get isDisposed(): boolean;
-    /** @internal */
-    constructor(_iModel: BriefcaseDb | StandaloneDb);
-    /** Array of errors from dependency propagation */
-    readonly validationErrors: ValidationError[];
-    private get _nativeDb();
-    private _getElementClass;
-    private _getRelationshipClass;
-    /** @internal */
-    protected _onBeforeOutputsHandled(elClassName: string, elId: Id64String): void;
-    /** @internal */
-    protected _onAllInputsHandled(elClassName: string, elId: Id64String): void;
-    /** @internal */
-    protected _onRootChanged(props: RelationshipProps): void;
-    /** @internal */
-    protected _onDeletedDependency(props: RelationshipProps): void;
-    /** @internal */
-    protected _onBeginValidate(): void;
-    /** called from native code after validation of a Txn, either from saveChanges or apply changeset.
-     * @internal
-     */
-    protected _onEndValidate(): void;
-    /** @internal */
-    protected _onGeometryChanged(modelProps: ModelGeometryChangesProps[]): void;
-    /** @internal */
-    protected _onGeometryGuidsChanged(changes: ModelIdAndGeometryGuid[]): void;
-    /** @internal */
-    protected _onCommit(): void;
-    /** @internal */
-    protected _onCommitted(): void;
-    /** @internal */
-    protected _onChangesApplied(): void;
-    /** @internal */
-    protected _onBeforeUndoRedo(isUndo: boolean): void;
-    /** @internal */
-    protected _onAfterUndoRedo(isUndo: boolean): void;
-    /** Dependency handlers may call method this to report a validation error.
-     * @param error The error. If error.fatal === true, the transaction will cancel rather than commit.
-     */
-    reportError(error: ValidationError): void;
-    /** Determine whether any fatal validation errors have occurred during dependency propagation.  */
-    get hasFatalError(): boolean;
-    /** @internal */
-    readonly onEndValidation: BeEvent<() => void>;
-    /** Called after validation completes from [[IModelDb.saveChanges]].
-     * The argument to the event holds the list of elements that were inserted, updated, and deleted.
-     * @note If there are many changed elements in a single Txn, the notifications are sent in batches so this event *may be called multiple times* per Txn.
-     */
-    readonly onElementsChanged: BeEvent<(changes: TxnChangedEntities) => void>;
-    /** Called after validation completes from [[IModelDb.saveChanges]].
-     * The argument to the event holds the list of models that were inserted, updated, and deleted.
-     * @note If there are many changed models in a single Txn, the notifications are sent in batches so this event *may be called multiple times* per Txn.
-     */
-    readonly onModelsChanged: BeEvent<(changes: TxnChangedEntities) => void>;
-    /** Event raised after the geometry within one or more [[GeometricModel]]s is modified by applying a changeset or validation of a transaction.
-     * A model's geometry can change as a result of:
-     *  - Insertion or deletion of a geometric element within the model; or
-     *  - Modification of an existing element's geometric properties; or
-     *  - An explicit request to flag it as changed via [[IModelDb.Models.updateModel]].
-     */
-    readonly onModelGeometryChanged: BeEvent<(changes: ReadonlyArray<ModelIdAndGeometryGuid>) => void>;
-    readonly onGeometryChanged: BeEvent<(models: ModelGeometryChangesProps[]) => void>;
-    /** Event raised before a commit operation is performed. Initiated by a call to [[IModelDb.saveChanges]], unless there are no changes to save. */
-    readonly onCommit: BeEvent<() => void>;
-    /** Event raised after a commit operation has been performed. Initiated by a call to [[IModelDb.saveChanges]], even if there were no changes to save. */
-    readonly onCommitted: BeEvent<() => void>;
-    /** Event raised after a ChangeSet has been applied to this briefcase */
-    readonly onChangesApplied: BeEvent<() => void>;
-    /** Event raised before an undo/redo operation is performed. */
-    readonly onBeforeUndoRedo: BeEvent<(isUndo: boolean) => void>;
-    /** Event raised after an undo/redo operation has been performed.
-     * @param _action The action that was performed.
-     */
-    readonly onAfterUndoRedo: BeEvent<(isUndo: boolean) => void>;
-    /**
-     * Restart the current TxnManager session. This causes all Txns in the current session to no longer be undoable (as if the file was closed
-     * and reopened.)
-     * @note This can be quite disconcerting to the user expecting to be able to undo previously made changes. It should only be used
-     * under extreme circumstances where damage to the file or session could happen if the currently committed are reversed. Use sparingly and with care.
-     * Probably a good idea to alert the user it happened.
-     */
-    restartSession(): void;
-    /** Determine whether current txn is propagating indirect changes or not. */
-    get isIndirectChanges(): boolean;
-    /** Determine if there are currently any reversible (undoable) changes from this editing session. */
-    get isUndoPossible(): boolean;
-    /** Determine if there are currently any reinstatable (redoable) changes */
-    get isRedoPossible(): boolean;
-    /** Get the description of the operation that would be reversed by calling reverseTxns(1).
-     * This is useful for showing the operation that would be undone, for example in a menu.
-     */
-    getUndoString(): string;
-    /** Get a description of the operation that would be reinstated by calling reinstateTxn.
-     * This is useful for showing the operation that would be redone, in a pull-down menu for example.
-     */
-    getRedoString(): string;
-    /** Begin a new multi-Txn operation. This can be used to cause a series of Txns that would normally
-     * be considered separate actions for undo to be grouped into a single undoable operation. This means that when reverseTxns(1) is called,
-     * the entire group of changes are undone together. Multi-Txn operations can be nested and until the outermost operation is closed
-     * all changes constitute a single operation.
-     * @note This method must always be paired with a call to endMultiTxnAction.
-     */
-    beginMultiTxnOperation(): DbResult;
-    /** End a multi-Txn operation */
-    endMultiTxnOperation(): DbResult;
-    /** Return the depth of the multi-Txn stack. Generally for diagnostic use only. */
-    getMultiTxnOperationDepth(): number;
-    /** Reverse (undo) the most recent operation(s) to this IModelDb.
-     * @param numOperations the number of operations to reverse. If this is greater than 1, the entire set of operations will
-     *  be reinstated together when/if ReinstateTxn is called.
-     * @note If there are any outstanding uncommitted changes, they are reversed.
-     * @note The term "operation" is used rather than Txn, since multiple Txns can be grouped together via [[beginMultiTxnOperation]]. So,
-     * even if numOperations is 1, multiple Txns may be reversed if they were grouped together when they were made.
-     * @note If numOperations is too large only the operations are reversible are reversed.
-     */
-    reverseTxns(numOperations: number): IModelStatus;
-    /** Reverse the most recent operation. */
-    reverseSingleTxn(): IModelStatus;
-    /** Reverse all changes back to the beginning of the session. */
-    reverseAll(): IModelStatus;
-    /** Reverse all changes back to a previously saved TxnId.
-     * @param txnId a TxnId obtained from a previous call to GetCurrentTxnId.
-     * @returns Success if the transactions were reversed, error status otherwise.
-     * @see  [[getCurrentTxnId]] [[cancelTo]]
-     */
-    reverseTo(txnId: TxnIdString): IModelStatus;
-    /** Reverse and then cancel (make non-reinstatable) all changes back to a previous TxnId.
-     * @param txnId a TxnId obtained from a previous call to [[getCurrentTxnId]]
-     * @returns Success if the transactions were reversed and cleared, error status otherwise.
-     */
-    cancelTo(txnId: TxnIdString): IModelStatus;
-    /** Reinstate the most recently reversed transaction. Since at any time multiple transactions can be reversed, it
-     * may take multiple calls to this method to reinstate all reversed operations.
-     * @returns Success if a reversed transaction was reinstated, error status otherwise.
-     * @note If there are any outstanding uncommitted changes, they are canceled before the Txn is reinstated.
-     */
-    reinstateTxn(): IModelStatus;
-    /** Get the Id of the first transaction, if any.
-     */
-    queryFirstTxnId(): TxnIdString;
-    /** Get the successor of the specified TxnId */
-    queryNextTxnId(txnId: TxnIdString): TxnIdString;
-    /** Get the predecessor of the specified TxnId */
-    queryPreviousTxnId(txnId: TxnIdString): TxnIdString;
-    /** Get the Id of the current (tip) transaction.  */
-    getCurrentTxnId(): TxnIdString;
-    /** Get the description that was supplied when the specified transaction was saved. */
-    getTxnDescription(txnId: TxnIdString): string;
-    /** Test if a TxnId is valid */
-    isTxnIdValid(txnId: TxnIdString): boolean;
-    /** Query if there are any pending Txns in this IModelDb that are waiting to be pushed.  */
-    get hasPendingTxns(): boolean;
-    /** Query if there are any changes in memory that have yet to be saved to the IModelDb. */
-    get hasUnsavedChanges(): boolean;
-    /** Query if there are un-saved or un-pushed local changes. */
-    get hasLocalChanges(): boolean;
-}
+/** @packageDocumentation
+ * @module iModels
+ */
+import { BeEvent, DbResult, Id64String, IModelStatus } from "@itwin/core-bentley";
+import { EntityIdAndClassIdIterable, ModelGeometryChangesProps, ModelIdAndGeometryGuid } from "@itwin/core-common";
+import { BriefcaseDb, StandaloneDb } from "./IModelDb";
+import { RelationshipProps } from "./Relationship";
+/** A string that identifies a Txn.
+ * @public
+ */
+export declare type TxnIdString = string;
+/** An error generated during dependency validation.
+ * @see [[TxnManager.validationErrors]].
+ * @public
+ */
+export interface ValidationError {
+    /** If true, txn is aborted. */
+    fatal: boolean;
+    /** The type of error. */
+    errorType: string;
+    /** Optional description of what went wrong. */
+    message?: string;
+}
+/** Describes a set of [[Element]]s or [[Model]]s that changed as part of a transaction.
+ * @see [[TxnManager.onElementsChanged]] and [[TxnManager.onModelsChanged]].
+ * @public
+ */
+export interface TxnChangedEntities {
+    /** The entities that were inserted by the transaction. */
+    readonly inserts: EntityIdAndClassIdIterable;
+    /** The entities that were deleted by the transaction. */
+    readonly deletes: EntityIdAndClassIdIterable;
+    /** The entities that were modified by the transaction, including any [[Element]]s for which one of their [[ElementAspect]]s was changed. */
+    readonly updates: EntityIdAndClassIdIterable;
+}
+/** Strictly for tests. @internal */
+export declare function setMaxEntitiesPerEvent(max: number): number;
+/** Manages local changes to a [[BriefcaseDb]] or [[StandaloneDb]] via [Txns]($docs/learning/InteractiveEditing.md)
+ * @public
+ */
+export declare class TxnManager {
+    private _iModel;
+    /** @internal */
+    private _isDisposed;
+    /** @internal */
+    get isDisposed(): boolean;
+    /** @internal */
+    constructor(_iModel: BriefcaseDb | StandaloneDb);
+    /** Array of errors from dependency propagation */
+    readonly validationErrors: ValidationError[];
+    private get _nativeDb();
+    private _getElementClass;
+    private _getRelationshipClass;
+    /** @internal */
+    protected _onBeforeOutputsHandled(elClassName: string, elId: Id64String): void;
+    /** @internal */
+    protected _onAllInputsHandled(elClassName: string, elId: Id64String): void;
+    /** @internal */
+    protected _onRootChanged(props: RelationshipProps): void;
+    /** @internal */
+    protected _onDeletedDependency(props: RelationshipProps): void;
+    /** @internal */
+    protected _onBeginValidate(): void;
+    /** called from native code after validation of a Txn, either from saveChanges or apply changeset.
+     * @internal
+     */
+    protected _onEndValidate(): void;
+    /** @internal */
+    protected _onGeometryChanged(modelProps: ModelGeometryChangesProps[]): void;
+    /** @internal */
+    protected _onGeometryGuidsChanged(changes: ModelIdAndGeometryGuid[]): void;
+    /** @internal */
+    protected _onCommit(): void;
+    /** @internal */
+    protected _onCommitted(): void;
+    /** @internal */
+    protected _onChangesApplied(): void;
+    /** @internal */
+    protected _onBeforeUndoRedo(isUndo: boolean): void;
+    /** @internal */
+    protected _onAfterUndoRedo(isUndo: boolean): void;
+    /** Dependency handlers may call method this to report a validation error.
+     * @param error The error. If error.fatal === true, the transaction will cancel rather than commit.
+     */
+    reportError(error: ValidationError): void;
+    /** Determine whether any fatal validation errors have occurred during dependency propagation.  */
+    get hasFatalError(): boolean;
+    /** @internal */
+    readonly onEndValidation: BeEvent<() => void>;
+    /** Called after validation completes from [[IModelDb.saveChanges]].
+     * The argument to the event holds the list of elements that were inserted, updated, and deleted.
+     * @note If there are many changed elements in a single Txn, the notifications are sent in batches so this event *may be called multiple times* per Txn.
+     */
+    readonly onElementsChanged: BeEvent<(changes: TxnChangedEntities) => void>;
+    /** Called after validation completes from [[IModelDb.saveChanges]].
+     * The argument to the event holds the list of models that were inserted, updated, and deleted.
+     * @note If there are many changed models in a single Txn, the notifications are sent in batches so this event *may be called multiple times* per Txn.
+     */
+    readonly onModelsChanged: BeEvent<(changes: TxnChangedEntities) => void>;
+    /** Event raised after the geometry within one or more [[GeometricModel]]s is modified by applying a changeset or validation of a transaction.
+     * A model's geometry can change as a result of:
+     *  - Insertion or deletion of a geometric element within the model; or
+     *  - Modification of an existing element's geometric properties; or
+     *  - An explicit request to flag it as changed via [[IModelDb.Models.updateModel]].
+     */
+    readonly onModelGeometryChanged: BeEvent<(changes: ReadonlyArray<ModelIdAndGeometryGuid>) => void>;
+    readonly onGeometryChanged: BeEvent<(models: ModelGeometryChangesProps[]) => void>;
+    /** Event raised before a commit operation is performed. Initiated by a call to [[IModelDb.saveChanges]], unless there are no changes to save. */
+    readonly onCommit: BeEvent<() => void>;
+    /** Event raised after a commit operation has been performed. Initiated by a call to [[IModelDb.saveChanges]], even if there were no changes to save. */
+    readonly onCommitted: BeEvent<() => void>;
+    /** Event raised after a ChangeSet has been applied to this briefcase */
+    readonly onChangesApplied: BeEvent<() => void>;
+    /** Event raised before an undo/redo operation is performed. */
+    readonly onBeforeUndoRedo: BeEvent<(isUndo: boolean) => void>;
+    /** Event raised after an undo/redo operation has been performed.
+     * @param _action The action that was performed.
+     */
+    readonly onAfterUndoRedo: BeEvent<(isUndo: boolean) => void>;
+    /**
+     * Restart the current TxnManager session. This causes all Txns in the current session to no longer be undoable (as if the file was closed
+     * and reopened.)
+     * @note This can be quite disconcerting to the user expecting to be able to undo previously made changes. It should only be used
+     * under extreme circumstances where damage to the file or session could happen if the currently committed are reversed. Use sparingly and with care.
+     * Probably a good idea to alert the user it happened.
+     */
+    restartSession(): void;
+    /** Determine whether current txn is propagating indirect changes or not. */
+    get isIndirectChanges(): boolean;
+    /** Determine if there are currently any reversible (undoable) changes from this editing session. */
+    get isUndoPossible(): boolean;
+    /** Determine if there are currently any reinstatable (redoable) changes */
+    get isRedoPossible(): boolean;
+    /** Get the description of the operation that would be reversed by calling reverseTxns(1).
+     * This is useful for showing the operation that would be undone, for example in a menu.
+     */
+    getUndoString(): string;
+    /** Get a description of the operation that would be reinstated by calling reinstateTxn.
+     * This is useful for showing the operation that would be redone, in a pull-down menu for example.
+     */
+    getRedoString(): string;
+    /** Begin a new multi-Txn operation. This can be used to cause a series of Txns that would normally
+     * be considered separate actions for undo to be grouped into a single undoable operation. This means that when reverseTxns(1) is called,
+     * the entire group of changes are undone together. Multi-Txn operations can be nested and until the outermost operation is closed
+     * all changes constitute a single operation.
+     * @note This method must always be paired with a call to endMultiTxnAction.
+     */
+    beginMultiTxnOperation(): DbResult;
+    /** End a multi-Txn operation */
+    endMultiTxnOperation(): DbResult;
+    /** Return the depth of the multi-Txn stack. Generally for diagnostic use only. */
+    getMultiTxnOperationDepth(): number;
+    /** Reverse (undo) the most recent operation(s) to this IModelDb.
+     * @param numOperations the number of operations to reverse. If this is greater than 1, the entire set of operations will
+     *  be reinstated together when/if ReinstateTxn is called.
+     * @note If there are any outstanding uncommitted changes, they are reversed.
+     * @note The term "operation" is used rather than Txn, since multiple Txns can be grouped together via [[beginMultiTxnOperation]]. So,
+     * even if numOperations is 1, multiple Txns may be reversed if they were grouped together when they were made.
+     * @note If numOperations is too large only the operations are reversible are reversed.
+     */
+    reverseTxns(numOperations: number): IModelStatus;
+    /** Reverse the most recent operation. */
+    reverseSingleTxn(): IModelStatus;
+    /** Reverse all changes back to the beginning of the session. */
+    reverseAll(): IModelStatus;
+    /** Reverse all changes back to a previously saved TxnId.
+     * @param txnId a TxnId obtained from a previous call to GetCurrentTxnId.
+     * @returns Success if the transactions were reversed, error status otherwise.
+     * @see  [[getCurrentTxnId]] [[cancelTo]]
+     */
+    reverseTo(txnId: TxnIdString): IModelStatus;
+    /** Reverse and then cancel (make non-reinstatable) all changes back to a previous TxnId.
+     * @param txnId a TxnId obtained from a previous call to [[getCurrentTxnId]]
+     * @returns Success if the transactions were reversed and cleared, error status otherwise.
+     */
+    cancelTo(txnId: TxnIdString): IModelStatus;
+    /** Reinstate the most recently reversed transaction. Since at any time multiple transactions can be reversed, it
+     * may take multiple calls to this method to reinstate all reversed operations.
+     * @returns Success if a reversed transaction was reinstated, error status otherwise.
+     * @note If there are any outstanding uncommitted changes, they are canceled before the Txn is reinstated.
+     */
+    reinstateTxn(): IModelStatus;
+    /** Get the Id of the first transaction, if any.
+     */
+    queryFirstTxnId(): TxnIdString;
+    /** Get the successor of the specified TxnId */
+    queryNextTxnId(txnId: TxnIdString): TxnIdString;
+    /** Get the predecessor of the specified TxnId */
+    queryPreviousTxnId(txnId: TxnIdString): TxnIdString;
+    /** Get the Id of the current (tip) transaction.  */
+    getCurrentTxnId(): TxnIdString;
+    /** Get the description that was supplied when the specified transaction was saved. */
+    getTxnDescription(txnId: TxnIdString): string;
+    /** Test if a TxnId is valid */
+    isTxnIdValid(txnId: TxnIdString): boolean;
+    /** Query if there are any pending Txns in this IModelDb that are waiting to be pushed.  */
+    get hasPendingTxns(): boolean;
+    /** Query if there are any changes in memory that have yet to be saved to the IModelDb. */
+    get hasUnsavedChanges(): boolean;
+    /** Query if there are un-saved or un-pushed local changes. */
+    get hasLocalChanges(): boolean;
+}
 //# sourceMappingURL=TxnManager.d.ts.map