@itwin/core-backend 5.0.0-dev.11 → 5.0.0-dev.110

package/lib/esm/Texture.d.ts

@@ -0,0 +1,58 @@
+/** @packageDocumentation
+ * @module Elements
+ */
+import { Id64String } from "@itwin/core-bentley";
+import { Base64EncodedString, Code, CodeScopeProps, ImageSourceFormat, TextureProps } from "@itwin/core-common";
+import { DefinitionElement } from "./Element";
+import { IModelDb } from "./IModelDb";
+/** A [TextureProps]($common) in which the image data can be specified either as a base-64-encoded string or a Uint8Array.
+ * @see [[Texture]] constructor.
+ * @beta
+ */
+export interface TextureCreateProps extends Omit<TextureProps, "data"> {
+    data: Base64EncodedString | Uint8Array;
+}
+/** Defines a rendering texture that is associated with a Material and applied to surface geometry.
+ * @public
+ */
+export declare class Texture extends DefinitionElement {
+    /** @internal */
+    static get className(): string;
+    format: ImageSourceFormat;
+    data: Uint8Array;
+    description?: string;
+    /** @beta */
+    protected constructor(props: TextureCreateProps, iModel: IModelDb);
+    toJSON(): TextureProps;
+    /** 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: IModelDb, scopeModelId: CodeScopeProps, name: string): Code;
+    /** 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: IModelDb, definitionModelId: Id64String, name: string, format: ImageSourceFormat, data: Uint8Array | Base64EncodedString, description?: string): Texture;
+    /** 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: IModelDb, definitionModelId: Id64String, name: string, format: ImageSourceFormat, data: Uint8Array | Base64EncodedString, description?: string): Id64String;
+}
+//# sourceMappingURL=Texture.d.ts.map

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":["/*---------------------------------------------------------------------------------------------\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\n/** @packageDocumentation\r\n * @module Elements\r\n */\r\n\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\nimport {\r\n  Base64EncodedString, BisCodeSpec, Code, CodeScopeProps, CodeSpec, ImageSourceFormat, TextureProps,\r\n} from \"@itwin/core-common\";\r\nimport { DefinitionElement } from \"./Element\";\r\nimport { IModelDb } from \"./IModelDb\";\r\n\r\n/** A [TextureProps]($common) in which the image data can be specified either as a base-64-encoded string or a Uint8Array.\r\n * @see [[Texture]] constructor.\r\n * @beta\r\n */\r\nexport interface TextureCreateProps extends Omit<TextureProps, \"data\"> {\r\n  data: Base64EncodedString | Uint8Array;\r\n}\r\n\r\n/** Defines a rendering texture that is associated with a Material and applied to surface geometry.\r\n * @public\r\n */\r\nexport class Texture extends DefinitionElement {\r\n  /** @internal */\r\n  public static override get className(): string { return \"Texture\"; }\r\n  public format: ImageSourceFormat;\r\n  public data: Uint8Array;\r\n  public description?: string;\r\n\r\n  /** @beta */\r\n  protected constructor(props: TextureCreateProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.format = props.format;\r\n    this.data = typeof props.data === \"string\" ? Base64EncodedString.toUint8Array(props.data) : props.data;\r\n    this.description = props.description;\r\n  }\r\n\r\n  public override toJSON(): TextureProps {\r\n    const val = super.toJSON() as TextureProps;\r\n    val.format = this.format;\r\n    val.data = Base64EncodedString.fromUint8Array(this.data);\r\n    val.description = this.description;\r\n    return val;\r\n  }\r\n\r\n  /** Create a Code for a Texture given a name that is meant to be unique within the scope of the specified DefinitionModel.\r\n   * @param iModel  The IModelDb\r\n   * @param scopeModelId The Id of the DefinitionModel that contains the Texture and provides the scope for its name.\r\n   * @param name The Texture name\r\n   */\r\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, name: string): Code {\r\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(BisCodeSpec.texture);\r\n    return 0 === name.length ? Code.createEmpty() : new Code({ spec: codeSpec.id, scope: scopeModelId, value: name });\r\n  }\r\n\r\n  /** Create a texture with the given parameters.\r\n   * @param iModelDb The iModel to contain the texture.\r\n   * @param definitionModelId The [[DefinitionModel]] to contain the texture.\r\n   * @param name The name to serve as the texture's [Code]($common) value.\r\n   * @param format The format of the image data.\r\n   * @param data The image data in the format specified by `format`.\r\n   * @param description An optional description of the texture\r\n   * @returns The newly constructed Texture element.\r\n   * @throws [[IModelError]] if unable to create the element.\r\n   * @see [[insertTexture]] to insert a new texture into the iModel.\r\n   */\r\n  public static createTexture(iModelDb: IModelDb, definitionModelId: Id64String, name: string, format: ImageSourceFormat, data: Uint8Array | Base64EncodedString, description?: string): Texture {\r\n    const textureProps: TextureCreateProps = {\r\n      classFullName: this.classFullName,\r\n      code: this.createCode(iModelDb, definitionModelId, name),\r\n      format,\r\n      data,\r\n      description,\r\n      model: definitionModelId,\r\n      isPrivate: false,\r\n    };\r\n\r\n    return new Texture(textureProps, iModelDb);\r\n  }\r\n\r\n  /** Insert a new texture into a [[DefinitionModel]].\r\n   * @param iModelDb The iModel to contain the texture.\r\n   * @param definitionModelId The [[DefinitionModel]] to contain the texture.\r\n   * @param name The name to serve as the texture's [Code]($common) value.\r\n   * @param format The format of the image data.\r\n   * @param data The image data in the format specified by `format`.\r\n   * @param description An optional description of the texture\r\n   * @returns The Id of the newly-inserted texture element.\r\n   * @throws [[IModelError]] if unable to insert the element.\r\n   * @see [[insertTexture]] to insert a new texture into the iModel.\r\n   */\r\n  public static insertTexture(iModelDb: IModelDb, definitionModelId: Id64String, name: string, format: ImageSourceFormat, data: Uint8Array | Base64EncodedString, description?: string): Id64String {\r\n    const texture = this.createTexture(iModelDb, definitionModelId, name, format, data, description);\r\n    return iModelDb.elements.insertElement(texture.toJSON());\r\n  }\r\n}\r\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":["/*---------------------------------------------------------------------------------------------\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, ObjectReference, 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/**\r\n * Identifies a tile in cloud tile cache.\r\n * @beta\r\n */\r\nexport interface TileId {\r\n  treeId: string;\r\n  contentId: string;\r\n  guid: string;\r\n}\r\n\r\n/**\r\n * Facilitates interaction with cloud tile cache.\r\n * @beta\r\n */\r\nexport class TileStorage {\r\n  /**\r\n   * Allows using the underlying `ServerStorage` API directly.\r\n   * @see https://github.com/iTwin/object-storage/\r\n   */\r\n  public readonly storage: ServerStorage;\r\n\r\n  public constructor(storage: ServerStorage) {\r\n    this.storage = storage;\r\n  }\r\n\r\n  private _initializedIModels: Set<string> = new Set();\r\n\r\n  /**\r\n   * Ensures any required cloud storage resources for a specific iModel are ready to use.\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      try {\r\n        await this.storage.createBaseDirectory({ baseDirectory: iModelId });\r\n      } catch (e: any) {\r\n        // Ignore 409 errors. This is what Azure blob storage returns when the container already exists.\r\n        // Usually this means multiple backends tried to initialize tile storage at the same time.\r\n        if(e.statusCode !== 409)\r\n          throw e;\r\n      }\r\n    }\r\n    this._initializedIModels.add(iModelId);\r\n  }\r\n\r\n  /**\r\n   * Returns config that can be used by frontends to download tiles\r\n   * @param iModelId Id of the iModel\r\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.\r\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.\r\n   * @see [TileStorage]($frontend)\r\n   */\r\n  public async getDownloadConfig(iModelId: string, expiresInSeconds?: number): Promise<TransferConfig> {\r\n    try {\r\n      if (expiresInSeconds !== undefined)\r\n        return await this.storage.getDownloadConfig({ baseDirectory: iModelId }, { expiresInSeconds });\r\n      const expiresOn = new Date();\r\n      expiresOn.setDate(expiresOn.getDate() + (7 - expiresOn.getDay())); // next Sunday\r\n      expiresOn.setHours(0, 0, 0, 0); // exactly at midnight\r\n      return await this.storage.getDownloadConfig({ baseDirectory: iModelId }, { expiresOn });\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  /**\r\n   * Uploads a tile to the cloud cache.\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  /**\r\n   * Downloads a tile from the cloud cache.\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  /**\r\n   * Returns an async iterator of all tiles that are found in the cloud cache.\r\n   */\r\n  public async *getCachedTilesGenerator(iModelId: string): AsyncGenerator<TileId> {\r\n    const iterator = this.getCachedTilePages(iModelId);\r\n    for await (const page of iterator) {\r\n      for (const tile of page) {\r\n        yield tile;\r\n      }\r\n    }\r\n  }\r\n\r\n  private async *getCachedTilePages(iModelId: string): AsyncGenerator<TileId[]> {\r\n    const iterator = this.storage.getListObjectsPagedIterator({ baseDirectory: iModelId }, 500);\r\n    let prevPage: IteratorResult<ObjectReference[], any> | undefined;\r\n    do {\r\n      // initiate loading the next page\r\n      const page = iterator.next();\r\n      // process results from the previous page\r\n      if (prevPage)\r\n        yield this.convertPage(prevPage.value);\r\n      // finish loading the next page\r\n      prevPage = await page;\r\n    } while (!prevPage.done);\r\n  }\r\n\r\n  private convertPage(page: ObjectReference[]): TileId[] {\r\n    return page\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  /**\r\n   * Returns a list of all tiles that are found in the cloud cache.\r\n   */\r\n  public async getCachedTiles(iModelId: string): Promise<TileId[]> {\r\n    const results: TileId[] = [];\r\n    for await (const page of this.getCachedTilePages(iModelId)) {\r\n      results.push(...page);\r\n    }\r\n    return results;\r\n  }\r\n\r\n  /**\r\n   * Returns a boolean indicating whether a tile exists in the cloud cache\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"]}