@itwin/core-backend 4.0.0-dev.10 → 4.0.0-dev.100

package/lib/cjs/Texture.d.ts

@@ -1,59 +1,59 @@
-/** @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.
- * @internal
- */
-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;
-    /** @internal */
-    constructor(props: TextureCreateProps, iModel: IModelDb);
-    /** @internal */
-    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;
-}
+/** @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.
+ * @internal
+ */
+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;
+    /** @internal */
+    constructor(props: TextureCreateProps, iModel: IModelDb);
+    /** @internal */
+    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/cjs/Texture.js

@@ -1,83 +1,83 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Texture = void 0;
-const core_common_1 = require("@itwin/core-common");
-const Element_1 = require("./Element");
-/** Defines a rendering texture that is associated with a Material and applied to surface geometry.
- * @public
- */
-class Texture extends Element_1.DefinitionElement {
-    /** @internal */
-    constructor(props, iModel) {
-        super(props, iModel);
-        this.format = props.format;
-        this.data = typeof props.data === "string" ? core_common_1.Base64EncodedString.toUint8Array(props.data) : props.data;
-        this.description = props.description;
-    }
-    /** @internal */
-    static get className() { return "Texture"; }
-    /** @internal */
-    toJSON() {
-        const val = super.toJSON();
-        val.format = this.format;
-        val.data = core_common_1.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(core_common_1.BisCodeSpec.texture);
-        return 0 === name.length ? core_common_1.Code.createEmpty() : new core_common_1.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());
-    }
-}
-exports.Texture = Texture;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Texture = void 0;
+const core_common_1 = require("@itwin/core-common");
+const Element_1 = require("./Element");
+/** Defines a rendering texture that is associated with a Material and applied to surface geometry.
+ * @public
+ */
+class Texture extends Element_1.DefinitionElement {
+    /** @internal */
+    static get className() { return "Texture"; }
+    /** @internal */
+    constructor(props, iModel) {
+        super(props, iModel);
+        this.format = props.format;
+        this.data = typeof props.data === "string" ? core_common_1.Base64EncodedString.toUint8Array(props.data) : props.data;
+        this.description = props.description;
+    }
+    /** @internal */
+    toJSON() {
+        const val = super.toJSON();
+        val.format = this.format;
+        val.data = core_common_1.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(core_common_1.BisCodeSpec.texture);
+        return 0 === name.length ? core_common_1.Code.createEmpty() : new core_common_1.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());
+    }
+}
+exports.Texture = Texture;
 //# sourceMappingURL=Texture.js.map

package/lib/cjs/Texture.js.map

@@ -1 +1 @@
-{"version":3,"file":"Texture.js","sourceRoot":"","sources":["../../src/Texture.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,oDAE4B;AAC5B,uCAA8C;AAW9C;;GAEG;AACH,MAAa,OAAQ,SAAQ,2BAAiB;IAO5C,gBAAgB;IAChB,YAAY,KAAyB,EAAE,MAAgB;QACrD,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,iCAAmB,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;IAZD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,SAAS,CAAC,CAAC,CAAC;IAapE,gBAAgB;IACA,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAkB,CAAC;QAC3C,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QACzB,GAAG,CAAC,IAAI,GAAG,iCAAmB,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,yBAAW,CAAC,OAAO,CAAC,CAAC;QAC3E,OAAO,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,kBAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,kBAAI,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;AA1ED,0BA0EC","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 * @internal\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  /** @internal */\r\n  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  /** @internal */\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"]}
+{"version":3,"file":"Texture.js","sourceRoot":"","sources":["../../src/Texture.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,oDAE4B;AAC5B,uCAA8C;AAW9C;;GAEG;AACH,MAAa,OAAQ,SAAQ,2BAAiB;IAC5C,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,SAAS,CAAC,CAAC,CAAC;IAKpE,gBAAgB;IAChB,YAAY,KAAyB,EAAE,MAAgB;QACrD,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,iCAAmB,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;IAED,gBAAgB;IACA,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAkB,CAAC;QAC3C,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QACzB,GAAG,CAAC,IAAI,GAAG,iCAAmB,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,yBAAW,CAAC,OAAO,CAAC,CAAC;QAC3E,OAAO,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,kBAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,kBAAI,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;AA1ED,0BA0EC","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 * @internal\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  /** @internal */\r\n  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  /** @internal */\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/cjs/TileStorage.d.ts

@@ -1,19 +1,45 @@
-import { Metadata, ServerStorage, TransferConfig } from "@itwin/object-storage-core";
-/** @beta */
-export declare class TileStorage {
-    readonly storage: ServerStorage;
-    constructor(storage: ServerStorage);
-    private _initializedIModels;
-    initialize(iModelId: string): Promise<void>;
-    getDownloadConfig(iModelId: string, expiresInSeconds?: number): Promise<TransferConfig>;
-    uploadTile(iModelId: string, changesetId: string, treeId: string, contentId: string, content: Uint8Array, guid?: string, metadata?: Metadata): Promise<void>;
-    downloadTile(iModelId: string, changesetId: string, treeId: string, contentId: string, guid?: string): Promise<Uint8Array>;
-    getCachedTiles(iModelId: string, _prefix: string): Promise<{
-        treeId: string;
-        contentId: string;
-        guid?: string;
-    }[]>;
-    isTileCached(iModelId: string, changesetId: string, treeId: string, contentId: string, guid?: string): Promise<boolean>;
-    private logException;
-}
+import { Metadata, ServerStorage, TransferConfig } from "@itwin/object-storage-core";
+/**
+ * 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
+     * @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 a list of all tiles that are found in the cloud cache.
+     */
+    getCachedTiles(iModelId: string): Promise<{
+        treeId: string;
+        contentId: string;
+        guid: string;
+    }[]>;
+    /**
+     * 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/cjs/TileStorage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TileStorage.d.ts","sourceRoot":"","sources":["../../src/TileStorage.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAMrF,YAAY;AACZ,qBAAa,WAAW;aACa,OAAO,EAAE,aAAa;gBAAtB,OAAO,EAAE,aAAa;IAEzD,OAAO,CAAC,mBAAmB,CAA0B;IAExC,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAS3C,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IASvF,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;IAc5J,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;IAa1H,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAyBlH,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"}
+{"version":3,"file":"TileStorage.d.ts","sourceRoot":"","sources":["../../src/TileStorage.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAMrF;;;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;IASxD;;;OAGG;IACU,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IASpG;;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;IACU,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAyB7G;;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/cjs/TileStorage.js

@@ -1,91 +1,110 @@
-"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");
+/**
+ * Facilitates interaction with cloud tile cache.
+ * @beta
+ */
+class TileStorage {
+    constructor(storage) {
+        this._initializedIModels = new Set();
+        this.storage = storage;
+    }
+    /**
+     * 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 }))) {
+            await this.storage.createBaseDirectory({ baseDirectory: iModelId });
+        }
+        this._initializedIModels.add(iModelId);
+    }
+    /**
+     * Returns config that can be used by frontends to download tiles
+     * @see [TileStorage]($frontend)
+     */
+    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;
+        }
+    }
+    /**
+     * Uploads a tile to the cloud cache.
+     */
+    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;
+        }
+    }
+    /**
+     * Downloads a tile from the cloud cache.
+     */
+    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;
+        }
+    }
+    /**
+     * Returns a list of all tiles that are found in the cloud cache.
+     */
+    async getCachedTiles(iModelId) {
+        return (await this.storage.listObjects({ baseDirectory: iModelId }))
+            .map((objectReference) => ({
+            parts: objectReference.relativeDirectory?.split("/") ?? [""],
+            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],
+            };
+        });
+    }
+    /**
+     * Returns a boolean indicating whether a tile exists in the cloud cache
+     */
+    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