@itwin/core-backend 5.0.0-dev.90 → 5.0.0-dev.93

package/lib/esm/Texture.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Texture.d.ts","sourceRoot":"","sources":["../../src/Texture.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EACL,mBAAmB,EAAe,IAAI,EAAE,cAAc,EAAY,iBAAiB,EAAE,YAAY,EAClG,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC;IACpE,IAAI,EAAE,mBAAmB,GAAG,UAAU,CAAC;CACxC;AAED;;GAEG;AACH,qBAAa,OAAQ,SAAQ,iBAAiB;IAC5C,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAsB;IAC7D,MAAM,EAAE,iBAAiB,CAAC;IAC1B,IAAI,EAAE,UAAU,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IAE5B,YAAY;IACZ,SAAS,aAAa,KAAK,EAAE,kBAAkB,EAAE,MAAM,EAAE,QAAQ;IAOjD,MAAM,IAAI,YAAY;IAQtC;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAK5F;;;;;;;;;;OAUG;WACW,aAAa,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,iBAAiB,EAAE,IAAI,EAAE,UAAU,GAAG,mBAAmB,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO;IAc9L;;;;;;;;;;OAUG;WACW,aAAa,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,iBAAiB,EAAE,IAAI,EAAE,UAAU,GAAG,mBAAmB,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,UAAU;CAIlM"}

package/lib/esm/Texture.js

@@ -0,0 +1,81 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Elements
+ */
+import { Base64EncodedString, BisCodeSpec, Code, } from "@itwin/core-common";
+import { DefinitionElement } from "./Element";
+/** Defines a rendering texture that is associated with a Material and applied to surface geometry.
+ * @public
+ */
+export class Texture extends DefinitionElement {
+    /** @internal */
+    static get className() { return "Texture"; }
+    format;
+    data;
+    description;
+    /** @beta */
+    constructor(props, iModel) {
+        super(props, iModel);
+        this.format = props.format;
+        this.data = typeof props.data === "string" ? Base64EncodedString.toUint8Array(props.data) : props.data;
+        this.description = props.description;
+    }
+    toJSON() {
+        const val = super.toJSON();
+        val.format = this.format;
+        val.data = Base64EncodedString.fromUint8Array(this.data);
+        val.description = this.description;
+        return val;
+    }
+    /** Create a Code for a Texture given a name that is meant to be unique within the scope of the specified DefinitionModel.
+     * @param iModel  The IModelDb
+     * @param scopeModelId The Id of the DefinitionModel that contains the Texture and provides the scope for its name.
+     * @param name The Texture name
+     */
+    static createCode(iModel, scopeModelId, name) {
+        const codeSpec = iModel.codeSpecs.getByName(BisCodeSpec.texture);
+        return 0 === name.length ? Code.createEmpty() : new Code({ spec: codeSpec.id, scope: scopeModelId, value: name });
+    }
+    /** Create a texture with the given parameters.
+     * @param iModelDb The iModel to contain the texture.
+     * @param definitionModelId The [[DefinitionModel]] to contain the texture.
+     * @param name The name to serve as the texture's [Code]($common) value.
+     * @param format The format of the image data.
+     * @param data The image data in the format specified by `format`.
+     * @param description An optional description of the texture
+     * @returns The newly constructed Texture element.
+     * @throws [[IModelError]] if unable to create the element.
+     * @see [[insertTexture]] to insert a new texture into the iModel.
+     */
+    static createTexture(iModelDb, definitionModelId, name, format, data, description) {
+        const textureProps = {
+            classFullName: this.classFullName,
+            code: this.createCode(iModelDb, definitionModelId, name),
+            format,
+            data,
+            description,
+            model: definitionModelId,
+            isPrivate: false,
+        };
+        return new Texture(textureProps, iModelDb);
+    }
+    /** Insert a new texture into a [[DefinitionModel]].
+     * @param iModelDb The iModel to contain the texture.
+     * @param definitionModelId The [[DefinitionModel]] to contain the texture.
+     * @param name The name to serve as the texture's [Code]($common) value.
+     * @param format The format of the image data.
+     * @param data The image data in the format specified by `format`.
+     * @param description An optional description of the texture
+     * @returns The Id of the newly-inserted texture element.
+     * @throws [[IModelError]] if unable to insert the element.
+     * @see [[insertTexture]] to insert a new texture into the iModel.
+     */
+    static insertTexture(iModelDb, definitionModelId, name, format, data, description) {
+        const texture = this.createTexture(iModelDb, definitionModelId, name, format, data, description);
+        return iModelDb.elements.insertElement(texture.toJSON());
+    }
+}
+//# sourceMappingURL=Texture.js.map

package/lib/esm/Texture.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Texture.js","sourceRoot":"","sources":["../../src/Texture.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EACL,mBAAmB,EAAE,WAAW,EAAE,IAAI,GACvC,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAW9C;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,iBAAiB;IAC5C,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,SAAS,CAAC,CAAC,CAAC;IAC7D,MAAM,CAAoB;IAC1B,IAAI,CAAa;IACjB,WAAW,CAAU;IAE5B,YAAY;IACZ,YAAsB,KAAyB,EAAE,MAAgB;QAC/D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,IAAI,GAAG,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,mBAAmB,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC;QACvG,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;IACvC,CAAC;IAEe,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAkB,CAAC;QAC3C,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QACzB,GAAG,CAAC,IAAI,GAAG,mBAAmB,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzD,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACnC,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,YAA4B,EAAE,IAAY;QACnF,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAC3E,OAAO,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACpH,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,aAAa,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY,EAAE,MAAyB,EAAE,IAAsC,EAAE,WAAoB;QAClL,MAAM,YAAY,GAAuB;YACvC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;YACxD,MAAM;YACN,IAAI;YACJ,WAAW;YACX,KAAK,EAAE,iBAAiB;YACxB,SAAS,EAAE,KAAK;SACjB,CAAC;QAEF,OAAO,IAAI,OAAO,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,aAAa,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY,EAAE,MAAyB,EAAE,IAAsC,EAAE,WAAoB;QAClL,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;QACjG,OAAO,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAC3D,CAAC;CACF","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*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Elements\n */\n\nimport { Id64String } from \"@itwin/core-bentley\";\nimport {\n  Base64EncodedString, BisCodeSpec, Code, CodeScopeProps, CodeSpec, ImageSourceFormat, TextureProps,\n} from \"@itwin/core-common\";\nimport { DefinitionElement } from \"./Element\";\nimport { IModelDb } from \"./IModelDb\";\n\n/** A [TextureProps]($common) in which the image data can be specified either as a base-64-encoded string or a Uint8Array.\n * @see [[Texture]] constructor.\n * @beta\n */\nexport interface TextureCreateProps extends Omit<TextureProps, \"data\"> {\n  data: Base64EncodedString | Uint8Array;\n}\n\n/** Defines a rendering texture that is associated with a Material and applied to surface geometry.\n * @public\n */\nexport class Texture extends DefinitionElement {\n  /** @internal */\n  public static override get className(): string { return \"Texture\"; }\n  public format: ImageSourceFormat;\n  public data: Uint8Array;\n  public description?: string;\n\n  /** @beta */\n  protected constructor(props: TextureCreateProps, iModel: IModelDb) {\n    super(props, iModel);\n    this.format = props.format;\n    this.data = typeof props.data === \"string\" ? Base64EncodedString.toUint8Array(props.data) : props.data;\n    this.description = props.description;\n  }\n\n  public override toJSON(): TextureProps {\n    const val = super.toJSON() as TextureProps;\n    val.format = this.format;\n    val.data = Base64EncodedString.fromUint8Array(this.data);\n    val.description = this.description;\n    return val;\n  }\n\n  /** Create a Code for a Texture given a name that is meant to be unique within the scope of the specified DefinitionModel.\n   * @param iModel  The IModelDb\n   * @param scopeModelId The Id of the DefinitionModel that contains the Texture and provides the scope for its name.\n   * @param name The Texture name\n   */\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, name: string): Code {\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(BisCodeSpec.texture);\n    return 0 === name.length ? Code.createEmpty() : new Code({ spec: codeSpec.id, scope: scopeModelId, value: name });\n  }\n\n  /** Create a texture with the given parameters.\n   * @param iModelDb The iModel to contain the texture.\n   * @param definitionModelId The [[DefinitionModel]] to contain the texture.\n   * @param name The name to serve as the texture's [Code]($common) value.\n   * @param format The format of the image data.\n   * @param data The image data in the format specified by `format`.\n   * @param description An optional description of the texture\n   * @returns The newly constructed Texture element.\n   * @throws [[IModelError]] if unable to create the element.\n   * @see [[insertTexture]] to insert a new texture into the iModel.\n   */\n  public static createTexture(iModelDb: IModelDb, definitionModelId: Id64String, name: string, format: ImageSourceFormat, data: Uint8Array | Base64EncodedString, description?: string): Texture {\n    const textureProps: TextureCreateProps = {\n      classFullName: this.classFullName,\n      code: this.createCode(iModelDb, definitionModelId, name),\n      format,\n      data,\n      description,\n      model: definitionModelId,\n      isPrivate: false,\n    };\n\n    return new Texture(textureProps, iModelDb);\n  }\n\n  /** Insert a new texture into a [[DefinitionModel]].\n   * @param iModelDb The iModel to contain the texture.\n   * @param definitionModelId The [[DefinitionModel]] to contain the texture.\n   * @param name The name to serve as the texture's [Code]($common) value.\n   * @param format The format of the image data.\n   * @param data The image data in the format specified by `format`.\n   * @param description An optional description of the texture\n   * @returns The Id of the newly-inserted texture element.\n   * @throws [[IModelError]] if unable to insert the element.\n   * @see [[insertTexture]] to insert a new texture into the iModel.\n   */\n  public static insertTexture(iModelDb: IModelDb, definitionModelId: Id64String, name: string, format: ImageSourceFormat, data: Uint8Array | Base64EncodedString, description?: string): Id64String {\n    const texture = this.createTexture(iModelDb, definitionModelId, name, format, data, description);\n    return iModelDb.elements.insertElement(texture.toJSON());\n  }\n}\n"]}

package/lib/esm/TileStorage.d.ts

@@ -0,0 +1,59 @@
+import { Metadata, ServerStorage, TransferConfig } from "@itwin/object-storage-core";
+/**
+ * Identifies a tile in cloud tile cache.
+ * @beta
+ */
+export interface TileId {
+    treeId: string;
+    contentId: string;
+    guid: string;
+}
+/**
+ * Facilitates interaction with cloud tile cache.
+ * @beta
+ */
+export declare class TileStorage {
+    /**
+     * Allows using the underlying `ServerStorage` API directly.
+     * @see https://github.com/iTwin/object-storage/
+     */
+    readonly storage: ServerStorage;
+    constructor(storage: ServerStorage);
+    private _initializedIModels;
+    /**
+     * Ensures any required cloud storage resources for a specific iModel are ready to use.
+     */
+    initialize(iModelId: string): Promise<void>;
+    /**
+     * Returns config that can be used by frontends to download tiles
+     * @param iModelId Id of the iModel
+     * @param expiresInSeconds Optional number of seconds until the download URL expires. Defaults to expiring exactly at midnight of next Sunday to enable persistent client-side caching.
+     *  It is recommended to set this to a shorter period when using S3-compatible storage - an exact expiry date cannot be ensured due to limitations in their API.
+     * @see [TileStorage]($frontend)
+     */
+    getDownloadConfig(iModelId: string, expiresInSeconds?: number): Promise<TransferConfig>;
+    /**
+     * Uploads a tile to the cloud cache.
+     */
+    uploadTile(iModelId: string, changesetId: string, treeId: string, contentId: string, content: Uint8Array, guid?: string, metadata?: Metadata): Promise<void>;
+    /**
+     * Downloads a tile from the cloud cache.
+     */
+    downloadTile(iModelId: string, changesetId: string, treeId: string, contentId: string, guid?: string): Promise<Uint8Array>;
+    /**
+     * Returns an async iterator of all tiles that are found in the cloud cache.
+     */
+    getCachedTilesGenerator(iModelId: string): AsyncGenerator<TileId>;
+    private getCachedTilePages;
+    private convertPage;
+    /**
+     * Returns a list of all tiles that are found in the cloud cache.
+     */
+    getCachedTiles(iModelId: string): Promise<TileId[]>;
+    /**
+     * Returns a boolean indicating whether a tile exists in the cloud cache
+     */
+    isTileCached(iModelId: string, changesetId: string, treeId: string, contentId: string, guid?: string): Promise<boolean>;
+    private logException;
+}
+//# sourceMappingURL=TileStorage.d.ts.map

package/lib/esm/TileStorage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TileStorage.d.ts","sourceRoot":"","sources":["../../src/TileStorage.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,QAAQ,EAAmB,aAAa,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAMtG;;;GAGG;AACH,MAAM,WAAW,MAAM;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,qBAAa,WAAW;IACtB;;;OAGG;IACH,SAAgB,OAAO,EAAE,aAAa,CAAC;gBAEpB,OAAO,EAAE,aAAa;IAIzC,OAAO,CAAC,mBAAmB,CAA0B;IAErD;;OAEG;IACU,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBxD;;;;;;OAMG;IACU,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAcpG;;OAEG;IACU,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAczK;;OAEG;IACU,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAavI;;OAEG;IACW,uBAAuB,CAAC,QAAQ,EAAE,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC;YAShE,kBAAkB;IAcjC,OAAO,CAAC,WAAW;IAyBnB;;OAEG;IACU,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAQhE;;OAEG;IACU,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAIpI,OAAO,CAAC,YAAY;CAOrB"}

package/lib/esm/TileStorage.js

@@ -0,0 +1,158 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+import { gunzip, gzip } from "zlib";
+import { promisify } from "util";
+import { getTileObjectReference } from "@itwin/core-common";
+import { Logger } from "@itwin/core-bentley";
+import { BackendLoggerCategory } from "./BackendLoggerCategory";
+import { IModelHost } from "./IModelHost";
+/**
+ * Facilitates interaction with cloud tile cache.
+ * @beta
+ */
+export class TileStorage {
+    /**
+     * Allows using the underlying `ServerStorage` API directly.
+     * @see https://github.com/iTwin/object-storage/
+     */
+    storage;
+    constructor(storage) {
+        this.storage = storage;
+    }
+    _initializedIModels = new Set();
+    /**
+     * Ensures any required cloud storage resources for a specific iModel are ready to use.
+     */
+    async initialize(iModelId) {
+        if (this._initializedIModels.has(iModelId))
+            return;
+        if (!(await this.storage.baseDirectoryExists({ baseDirectory: iModelId }))) {
+            try {
+                await this.storage.createBaseDirectory({ baseDirectory: iModelId });
+            }
+            catch (e) {
+                // Ignore 409 errors. This is what Azure blob storage returns when the container already exists.
+                // Usually this means multiple backends tried to initialize tile storage at the same time.
+                if (e.statusCode !== 409)
+                    throw e;
+            }
+        }
+        this._initializedIModels.add(iModelId);
+    }
+    /**
+     * Returns config that can be used by frontends to download tiles
+     * @param iModelId Id of the iModel
+     * @param expiresInSeconds Optional number of seconds until the download URL expires. Defaults to expiring exactly at midnight of next Sunday to enable persistent client-side caching.
+     *  It is recommended to set this to a shorter period when using S3-compatible storage - an exact expiry date cannot be ensured due to limitations in their API.
+     * @see [TileStorage]($frontend)
+     */
+    async getDownloadConfig(iModelId, expiresInSeconds) {
+        try {
+            if (expiresInSeconds !== undefined)
+                return await this.storage.getDownloadConfig({ baseDirectory: iModelId }, { expiresInSeconds });
+            const expiresOn = new Date();
+            expiresOn.setDate(expiresOn.getDate() + (7 - expiresOn.getDay())); // next Sunday
+            expiresOn.setHours(0, 0, 0, 0); // exactly at midnight
+            return await this.storage.getDownloadConfig({ baseDirectory: iModelId }, { expiresOn });
+        }
+        catch (err) {
+            this.logException("Failed to get download config", err);
+            throw err;
+        }
+    }
+    /**
+     * Uploads a tile to the cloud cache.
+     */
+    async uploadTile(iModelId, changesetId, treeId, contentId, content, guid, metadata) {
+        try {
+            await this.storage.upload(getTileObjectReference(iModelId, changesetId, treeId, contentId, guid), Buffer.from(IModelHost.compressCachedTiles ? await promisify(gzip)(content.buffer) : content.buffer), metadata, IModelHost.compressCachedTiles ? { contentEncoding: "gzip" } : undefined);
+        }
+        catch (err) {
+            this.logException("Failed to upload tile", err);
+            throw err;
+        }
+    }
+    /**
+     * Downloads a tile from the cloud cache.
+     */
+    async downloadTile(iModelId, changesetId, treeId, contentId, guid) {
+        try {
+            const buffer = await this.storage.download(getTileObjectReference(iModelId, changesetId, treeId, contentId, guid), "buffer");
+            return IModelHost.compressCachedTiles ? await promisify(gunzip)(buffer) : buffer;
+        }
+        catch (err) {
+            this.logException("Failed to download tile", err);
+            throw err;
+        }
+    }
+    /**
+     * Returns an async iterator of all tiles that are found in the cloud cache.
+     */
+    async *getCachedTilesGenerator(iModelId) {
+        const iterator = this.getCachedTilePages(iModelId);
+        for await (const page of iterator) {
+            for (const tile of page) {
+                yield tile;
+            }
+        }
+    }
+    async *getCachedTilePages(iModelId) {
+        const iterator = this.storage.getListObjectsPagedIterator({ baseDirectory: iModelId }, 500);
+        let prevPage;
+        do {
+            // initiate loading the next page
+            const page = iterator.next();
+            // process results from the previous page
+            if (prevPage)
+                yield this.convertPage(prevPage.value);
+            // finish loading the next page
+            prevPage = await page;
+        } while (!prevPage.done);
+    }
+    convertPage(page) {
+        return page
+            .map((objectReference) => ({
+            parts: objectReference.relativeDirectory?.split("/") ?? [""],
+            objectName: objectReference.objectName,
+        }))
+            .filter(({ parts, objectName }) => {
+            if (parts[0] !== "tiles")
+                return false;
+            if (parts.length !== 3) {
+                Logger.logWarning(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],
+            };
+        });
+    }
+    /**
+     * Returns a list of all tiles that are found in the cloud cache.
+     */
+    async getCachedTiles(iModelId) {
+        const results = [];
+        for await (const page of this.getCachedTilePages(iModelId)) {
+            results.push(...page);
+        }
+        return results;
+    }
+    /**
+     * Returns a boolean indicating whether a tile exists in the cloud cache
+     */
+    async isTileCached(iModelId, changesetId, treeId, contentId, guid) {
+        return this.storage.objectExists(getTileObjectReference(iModelId, changesetId, treeId, contentId, guid));
+    }
+    logException(message, err) {
+        Logger.logException(BackendLoggerCategory.IModelTileStorage, err, (category, msg, errorMetadata) => Logger.logError(category, `${message}: {errorMessage}`, { ...errorMetadata, errorMessage: msg }));
+    }
+}
+//# sourceMappingURL=TileStorage.js.map

package/lib/esm/TileStorage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TileStorage.js","sourceRoot":"","sources":["../../src/TileStorage.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AACpC,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AAEjC,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAY1C;;;GAGG;AACH,MAAM,OAAO,WAAW;IACtB;;;OAGG;IACa,OAAO,CAAgB;IAEvC,YAAmB,OAAsB;QACvC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAEO,mBAAmB,GAAgB,IAAI,GAAG,EAAE,CAAC;IAErD;;OAEG;IACI,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,CAAC;YAC3E,IAAI,CAAC;gBACH,MAAM,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,CAAC;YACtE,CAAC;YAAC,OAAO,CAAM,EAAE,CAAC;gBAChB,gGAAgG;gBAChG,0FAA0F;gBAC1F,IAAG,CAAC,CAAC,UAAU,KAAK,GAAG;oBACrB,MAAM,CAAC,CAAC;YACZ,CAAC;QACH,CAAC;QACD,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,iBAAiB,CAAC,QAAgB,EAAE,gBAAyB;QACxE,IAAI,CAAC;YACH,IAAI,gBAAgB,KAAK,SAAS;gBAChC,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,aAAa,EAAE,QAAQ,EAAE,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC;YACjG,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;YAC7B,SAAS,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,cAAc;YACjF,SAAS,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,sBAAsB;YACtD,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,aAAa,EAAE,QAAQ,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;QAC1F,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,YAAY,CAAC,+BAA+B,EAAE,GAAG,CAAC,CAAC;YACxD,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,UAAU,CAAC,QAAgB,EAAE,WAAmB,EAAE,MAAc,EAAE,SAAiB,EAAE,OAAmB,EAAE,IAAa,EAAE,QAAmB;QACvJ,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CACvB,sBAAsB,CAAC,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,EACtE,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC,CAAC,MAAM,SAAS,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EACpG,QAAQ,EACR,UAAU,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS,CACzE,CAAC;QACJ,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,YAAY,CAAC,uBAAuB,EAAE,GAAG,CAAC,CAAC;YAChD,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAY,CAAC,QAAgB,EAAE,WAAmB,EAAE,MAAc,EAAE,SAAiB,EAAE,IAAa;QAC/G,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CACxC,sBAAsB,CAAC,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,EACtE,QAAQ,CACT,CAAC;YACF,OAAO,UAAU,CAAC,mBAAmB,CAAC,CAAC,CAAC,MAAM,SAAS,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;QACnF,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,YAAY,CAAC,yBAAyB,EAAE,GAAG,CAAC,CAAC;YAClD,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,CAAC,uBAAuB,CAAC,QAAgB;QACpD,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACnD,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;YAClC,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;gBACxB,MAAM,IAAI,CAAC;YACb,CAAC;QACH,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,CAAC,kBAAkB,CAAC,QAAgB;QAChD,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,2BAA2B,CAAC,EAAE,aAAa,EAAE,QAAQ,EAAE,EAAE,GAAG,CAAC,CAAC;QAC5F,IAAI,QAA4D,CAAC;QACjE,GAAG,CAAC;YACF,iCAAiC;YACjC,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC7B,yCAAyC;YACzC,IAAI,QAAQ;gBACV,MAAM,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YACzC,+BAA+B;YAC/B,QAAQ,GAAG,MAAM,IAAI,CAAC;QACxB,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE;IAC3B,CAAC;IAEO,WAAW,CAAC,IAAuB;QACzC,OAAO,IAAI;aACR,GAAG,CAAC,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;YACzB,KAAK,EAAE,eAAe,CAAC,iBAAiB,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5D,UAAU,EAAE,eAAe,CAAC,UAAU;SACvC,CAAC,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,CAAC;gBACvB,MAAM,CAAC,UAAU,CAAC,qBAAqB,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;YACf,CAAC;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;IAED;;OAEG;IACI,KAAK,CAAC,cAAc,CAAC,QAAgB;QAC1C,MAAM,OAAO,GAAa,EAAE,CAAC;QAC7B,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC3D,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;QACxB,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAY,CAAC,QAAgB,EAAE,WAAmB,EAAE,MAAc,EAAE,SAAiB,EAAE,IAAa;QAC/G,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,sBAAsB,CAAC,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;IAC3G,CAAC;IAEO,YAAY,CAAC,OAAe,EAAE,GAAY;QAChD,MAAM,CAAC,YAAY,CACjB,qBAAqB,CAAC,iBAAiB,EACvC,GAAG,EACH,CAAC,QAAQ,EAAE,GAAG,EAAE,aAAa,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,OAAO,kBAAkB,EAAE,EAAE,GAAG,aAAa,EAAE,YAAY,EAAE,GAAG,EAAE,CAAC,CACnI,CAAC;IACJ,CAAC;CACF","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, ObjectReference, 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/**\n * Identifies a tile in cloud tile cache.\n * @beta\n */\nexport interface TileId {\n  treeId: string;\n  contentId: string;\n  guid: string;\n}\n\n/**\n * Facilitates interaction with cloud tile cache.\n * @beta\n */\nexport class TileStorage {\n  /**\n   * Allows using the underlying `ServerStorage` API directly.\n   * @see https://github.com/iTwin/object-storage/\n   */\n  public readonly storage: ServerStorage;\n\n  public constructor(storage: ServerStorage) {\n    this.storage = storage;\n  }\n\n  private _initializedIModels: Set<string> = new Set();\n\n  /**\n   * Ensures any required cloud storage resources for a specific iModel are ready to use.\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      try {\n        await this.storage.createBaseDirectory({ baseDirectory: iModelId });\n      } catch (e: any) {\n        // Ignore 409 errors. This is what Azure blob storage returns when the container already exists.\n        // Usually this means multiple backends tried to initialize tile storage at the same time.\n        if(e.statusCode !== 409)\n          throw e;\n      }\n    }\n    this._initializedIModels.add(iModelId);\n  }\n\n  /**\n   * Returns config that can be used by frontends to download tiles\n   * @param iModelId Id of the iModel\n   * @param expiresInSeconds Optional number of seconds until the download URL expires. Defaults to expiring exactly at midnight of next Sunday to enable persistent client-side caching.\n   *  It is recommended to set this to a shorter period when using S3-compatible storage - an exact expiry date cannot be ensured due to limitations in their API.\n   * @see [TileStorage]($frontend)\n   */\n  public async getDownloadConfig(iModelId: string, expiresInSeconds?: number): Promise<TransferConfig> {\n    try {\n      if (expiresInSeconds !== undefined)\n        return await this.storage.getDownloadConfig({ baseDirectory: iModelId }, { expiresInSeconds });\n      const expiresOn = new Date();\n      expiresOn.setDate(expiresOn.getDate() + (7 - expiresOn.getDay())); // next Sunday\n      expiresOn.setHours(0, 0, 0, 0); // exactly at midnight\n      return await this.storage.getDownloadConfig({ baseDirectory: iModelId }, { expiresOn });\n    } catch (err) {\n      this.logException(\"Failed to get download config\", err);\n      throw err;\n    }\n  }\n\n  /**\n   * Uploads a tile to the cloud cache.\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  /**\n   * Downloads a tile from the cloud cache.\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  /**\n   * Returns an async iterator of all tiles that are found in the cloud cache.\n   */\n  public async *getCachedTilesGenerator(iModelId: string): AsyncGenerator<TileId> {\n    const iterator = this.getCachedTilePages(iModelId);\n    for await (const page of iterator) {\n      for (const tile of page) {\n        yield tile;\n      }\n    }\n  }\n\n  private async *getCachedTilePages(iModelId: string): AsyncGenerator<TileId[]> {\n    const iterator = this.storage.getListObjectsPagedIterator({ baseDirectory: iModelId }, 500);\n    let prevPage: IteratorResult<ObjectReference[], any> | undefined;\n    do {\n      // initiate loading the next page\n      const page = iterator.next();\n      // process results from the previous page\n      if (prevPage)\n        yield this.convertPage(prevPage.value);\n      // finish loading the next page\n      prevPage = await page;\n    } while (!prevPage.done);\n  }\n\n  private convertPage(page: ObjectReference[]): TileId[] {\n    return page\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  /**\n   * Returns a list of all tiles that are found in the cloud cache.\n   */\n  public async getCachedTiles(iModelId: string): Promise<TileId[]> {\n    const results: TileId[] = [];\n    for await (const page of this.getCachedTilePages(iModelId)) {\n      results.push(...page);\n    }\n    return results;\n  }\n\n  /**\n   * Returns a boolean indicating whether a tile exists in the cloud cache\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/esm/TxnManager.d.ts

@@ -0,0 +1,296 @@
+/** @packageDocumentation
+ * @module iModels
+ */
+import { BeEvent, DbConflictResolution, DbResult, Id64String, IModelStatus } from "@itwin/core-bentley";
+import { EntityIdAndClassIdIterable, ModelGeometryChangesProps, ModelIdAndGeometryGuid } from "@itwin/core-common";
+import { BriefcaseDb, StandaloneDb } from "./IModelDb";
+import { RelationshipProps } from "./Relationship";
+import { DbRebaseChangesetConflictArgs, RebaseChangesetConflictArgs, TxnArgs } from "./internal/ChangesetConflictArgs";
+/** A string that identifies a Txn.
+ * @public
+ */
+export 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;
+}
+/** Arguments supplied to [[TxnManager.queryLocalChanges]].
+ * @beta
+ */
+export interface QueryLocalChangesArgs {
+    /** If supplied and non-empty, restricts the results to include only EC instances belonging to the specified classes or subclasses thereof. */
+    readonly includedClasses?: string[];
+    /** If `true`, include changes that have not yet been saved. */
+    readonly includeUnsavedChanges?: boolean;
+}
+/** Represents a change (insertion, deletion, or modification) to a single EC instance made in a local [[BriefcaseDb]].
+ * @see [[TxnManager.queryLocalChanges]] to iterate all of the changed instances.
+* @beta
+*/
+export interface ChangeInstanceKey {
+    /** ECInstanceId of the instance. */
+    id: Id64String;
+    /** Fully-qualified class name of the instance. */
+    classFullName: string;
+    /** The type of change. */
+    changeType: "inserted" | "updated" | "deleted";
+}
+/** Strictly for tests. @internal */
+export declare function setMaxEntitiesPerEvent(max: number): number;
+/**
+ * @internal
+ * Manages conflict resolution during a merge operation.
+*/
+export declare class ChangeMergeManager {
+    private _iModel;
+    private _conflictHandlers?;
+    constructor(_iModel: BriefcaseDb | StandaloneDb);
+    resume(): void;
+    inProgress(): boolean;
+    onConflict(args: RebaseChangesetConflictArgs): DbConflictResolution | undefined;
+    addConflictHandler(args: {
+        id: string;
+        handler: (args: RebaseChangesetConflictArgs) => DbConflictResolution | undefined;
+    }): void;
+    removeConflictHandler(id: string): void;
+}
+/** 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 */
+    readonly changeMergeManager: ChangeMergeManager;
+    /** @internal */
+    constructor(_iModel: BriefcaseDb | StandaloneDb);
+    /** Array of errors from dependency propagation */
+    readonly validationErrors: ValidationError[];
+    private get _nativeDb();
+    private _getElementClass;
+    private _getRelationshipClass;
+    /** If a -watch file exists for this iModel, update its timestamp so watching processes can be
+     * notified that we've modified the briefcase.
+     * @internal Used by IModelDb on push/pull.
+     */
+    touchWatchFile(): void;
+    /** @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 _onReplayExternalTxns(): void;
+    /** @internal */
+    protected _onReplayedExternalTxns(): void;
+    /** @internal */
+    protected _onChangesApplied(): void;
+    /** @internal */
+    protected _onBeforeUndoRedo(isUndo: boolean): void;
+    /** @internal */
+    protected _onAfterUndoRedo(isUndo: boolean): void;
+    private _onRebaseTxnBegin;
+    private _onRebaseTxnEnd;
+    private _onRebaseLocalTxnConflict;
+    /** 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>;
+    /** Event raised for a read-only briefcase that was opened with the `watchForChanges` flag enabled when changes made by another connection are applied to the briefcase.
+     * @see [[onReplayedExternalTxns]] for the event raised after all such changes have been applied.
+     */
+    readonly onReplayExternalTxns: BeEvent<() => void>;
+    /** Event raised for a read-only briefcase that was opened with the `watchForChanges` flag enabled when changes made by another connection are applied to the briefcase.
+     * @see [[onReplayExternalTxns]] for the event raised before the changes are applied.
+     */
+    readonly onReplayedExternalTxns: BeEvent<() => void>;
+    /** @internal */
+    readonly onRebaseTxnBegin: BeEvent<(txn: TxnArgs) => void>;
+    /** @internal */
+    readonly onRebaseTxnEnd: BeEvent<(txn: TxnArgs) => void>;
+    /**
+     * if handler is set and it does not return undefiend then default handler will not be called
+     * @internal
+     * */
+    appCustomConflictHandler?: (args: DbRebaseChangesetConflictArgs) => DbConflictResolution | undefined;
+    /**
+     * 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.
+     * @see [[IModelDb.pushChanges]]
+     */
+    get hasPendingTxns(): boolean;
+    /**
+     * Query if there are any changes in memory that have yet to be saved to the IModelDb.
+     * @see [[IModelDb.saveChanges]]
+     */
+    get hasUnsavedChanges(): boolean;
+    /**
+     * Query if there are changes in memory that have not been saved to the iModelDb or if there are Txns that are waiting to be pushed.
+     * @see [[IModelDb.saveChanges]]
+     * @see [[IModelDb.pushChanges]]
+     */
+    get hasLocalChanges(): boolean;
+    /** Destroy the record of all local changes that have yet to be saved and/or pushed.
+     * This permanently eradicates your changes - use with caution!
+     * Typically, callers will want to subsequently use [[LockControl.releaseAllLocks]].
+     * After calling this function, [[hasLocalChanges]], [[hasPendingTxns]], and [[hasUnsavedChanges]] will all be `false`.
+     */
+    deleteAllTxns(): void;
+    /** Obtain a list of the EC instances that have been changed locally by the [[BriefcaseDb]] associated with this `TxnManager` and have not yet been pushed to the iModel.
+     * @beta
+    */
+    queryLocalChanges(args?: QueryLocalChangesArgs): Iterable<ChangeInstanceKey>;
+    /** Query the number of bytes of memory currently allocated by SQLite to keep track of
+     * changes to the iModel, for debugging/diagnostic purposes, as reported by [sqlite3session_memory_used](https://www.sqlite.org/session/sqlite3session_memory_used.html).
+     */
+    getChangeTrackingMemoryUsed(): number;
+}
+//# sourceMappingURL=TxnManager.d.ts.map