@itwin/core-backend 4.1.0-dev.8 → 4.1.0-dev.81

package/lib/cjs/Texture.js

@@ -16,14 +16,13 @@ const Element_1 = require("./Element");
 class Texture extends Element_1.DefinitionElement {
     /** @internal */
     static get className() { return "Texture"; }
-    /** @internal */
+    /** @beta */
     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;

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;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"]}
+{"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,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,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;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,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;AAzED,0BAyEC","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/cjs/TileStorage.d.ts

@@ -17,6 +17,9 @@ export declare class TileStorage {
     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>;

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;;;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"}
+{"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;;;;;;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;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

@@ -33,11 +33,19 @@ class TileStorage {
     }
     /**
      * 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 {
-            return await this.storage.getDownloadConfig({ baseDirectory: iModelId }, expiresInSeconds);
+            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);

package/lib/cjs/TileStorage.js.map

@@ -1 +1 @@
-{"version":3,"file":"TileStorage.js","sourceRoot":"","sources":["../../src/TileStorage.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F,+BAAoC;AACpC,+BAAiC;AAEjC,oDAA4D;AAC5D,sDAA6C;AAC7C,mEAAgE;AAChE,6CAA0C;AAE1C;;;GAGG;AACH,MAAa,WAAW;IAOtB,YAAmB,OAAsB;QAIjC,wBAAmB,GAAgB,IAAI,GAAG,EAAE,CAAC;QAHnD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAID;;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;YAC1E,MAAM,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,CAAC;SACrE;QACD,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,iBAAiB,CAAC,QAAgB,EAAE,gBAAyB;QACxE,IAAI;YACF,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,aAAa,EAAE,QAAQ,EAAE,EAAE,gBAAgB,CAAC,CAAC;SAC5F;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,CAAC,YAAY,CAAC,+BAA+B,EAAE,GAAG,CAAC,CAAC;YACxD,MAAM,GAAG,CAAC;SACX;IACH,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,UAAU,CAAC,QAAgB,EAAE,WAAmB,EAAE,MAAc,EAAE,SAAiB,EAAE,OAAmB,EAAE,IAAa,EAAE,QAAmB;QACvJ,IAAI;YACF,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CACvB,IAAA,oCAAsB,EAAC,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,EACtE,MAAM,CAAC,IAAI,CAAC,uBAAU,CAAC,mBAAmB,CAAC,CAAC,CAAC,MAAM,IAAA,gBAAS,EAAC,WAAI,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EACpG,QAAQ,EACR,uBAAU,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS,CACzE,CAAC;SACH;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,CAAC,YAAY,CAAC,uBAAuB,EAAE,GAAG,CAAC,CAAC;YAChD,MAAM,GAAG,CAAC;SACX;IACH,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAY,CAAC,QAAgB,EAAE,WAAmB,EAAE,MAAc,EAAE,SAAiB,EAAE,IAAa;QAC/G,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CACxC,IAAA,oCAAsB,EAAC,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,EACtE,QAAQ,CACT,CAAC;YACF,OAAO,uBAAU,CAAC,mBAAmB,CAAC,CAAC,CAAC,MAAM,IAAA,gBAAS,EAAC,aAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;SAClF;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,CAAC,YAAY,CAAC,yBAAyB,EAAE,GAAG,CAAC,CAAC;YAClD,MAAM,GAAG,CAAC;SACX;IACH,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,cAAc,CAAC,QAAgB;QAC1C,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,CAAC;aACjE,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;gBACtB,qBAAM,CAAC,UAAU,CAAC,6CAAqB,CAAC,iBAAiB,EAAE,iDAAiD,EAAE,EAAE,MAAM,EAAE,CAAC,GAAG,KAAK,EAAE,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBAC5J,OAAO,KAAK,CAAC;aACd;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE;YAC/B,4CAA4C;YAC5C,2BAA2B;YAC3B,OAAO;gBACL,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;gBAChB,SAAS,EAAE,UAAU;gBACrB,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;aACf,CAAC;QACJ,CAAC,CAAC,CAAC;IACP,CAAC;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,IAAA,oCAAsB,EAAC,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;IAC3G,CAAC;IAEO,YAAY,CAAC,OAAe,EAAE,GAAY;QAChD,qBAAM,CAAC,YAAY,CACjB,6CAAqB,CAAC,iBAAiB,EACvC,GAAG,EACH,CAAC,QAAQ,EAAE,GAAG,EAAE,aAAa,EAAE,EAAE,CAAC,qBAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,OAAO,kBAAkB,EAAE,EAAE,GAAG,aAAa,EAAE,YAAY,EAAE,GAAG,EAAE,CAAC,CACnI,CAAC;IACJ,CAAC;CACF;AAjHD,kCAiHC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\nimport { gunzip, gzip } from \"zlib\";\r\nimport { promisify } from \"util\";\r\nimport { Metadata, ServerStorage, TransferConfig } from \"@itwin/object-storage-core\";\r\nimport { getTileObjectReference } from \"@itwin/core-common\";\r\nimport { Logger } from \"@itwin/core-bentley\";\r\nimport { BackendLoggerCategory } from \"./BackendLoggerCategory\";\r\nimport { IModelHost } from \"./IModelHost\";\r\n\r\n/**\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      await this.storage.createBaseDirectory({ baseDirectory: iModelId });\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   * @see [TileStorage]($frontend)\r\n   */\r\n  public async getDownloadConfig(iModelId: string, expiresInSeconds?: number): Promise<TransferConfig> {\r\n    try {\r\n      return await this.storage.getDownloadConfig({ baseDirectory: iModelId }, expiresInSeconds);\r\n    } catch (err) {\r\n      this.logException(\"Failed to get download config\", err);\r\n      throw err;\r\n    }\r\n  }\r\n\r\n  /**\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 a list of all tiles that are found in the cloud cache.\r\n   */\r\n  public async getCachedTiles(iModelId: string): Promise<{ treeId: string, contentId: string, guid: string }[]> {\r\n    return (await this.storage.listObjects({ baseDirectory: iModelId }))\r\n      .map((objectReference) => ({\r\n        parts: objectReference.relativeDirectory?.split(\"/\") ?? [\"\"],\r\n        objectName: objectReference.objectName,\r\n      }))\r\n      .filter(({ parts, objectName }) => {\r\n        if (parts[0] !== \"tiles\")\r\n          return false;\r\n        if (parts.length !== 3) {\r\n          Logger.logWarning(BackendLoggerCategory.IModelTileStorage, \"Malformed tile id found in tile cache: {tileId}\", { tileId: [...parts, objectName].join(\"/\") });\r\n          return false;\r\n        }\r\n        return true;\r\n      }).map(({ parts, objectName }) => {\r\n        // relativeDirectory = tiles/<treeId>/<guid>\r\n        // objectName = <contentId>\r\n        return {\r\n          treeId: parts[1],\r\n          contentId: objectName,\r\n          guid: parts[2],\r\n        };\r\n      });\r\n  }\r\n\r\n  /**\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"]}
+{"version":3,"file":"TileStorage.js","sourceRoot":"","sources":["../../src/TileStorage.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F,+BAAoC;AACpC,+BAAiC;AAEjC,oDAA4D;AAC5D,sDAA6C;AAC7C,mEAAgE;AAChE,6CAA0C;AAE1C;;;GAGG;AACH,MAAa,WAAW;IAOtB,YAAmB,OAAsB;QAIjC,wBAAmB,GAAgB,IAAI,GAAG,EAAE,CAAC;QAHnD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAID;;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;YAC1E,MAAM,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,CAAC;SACrE;QACD,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,iBAAiB,CAAC,QAAgB,EAAE,gBAAyB;QACxE,IAAI;YACF,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;SACzF;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,CAAC,YAAY,CAAC,+BAA+B,EAAE,GAAG,CAAC,CAAC;YACxD,MAAM,GAAG,CAAC;SACX;IACH,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,UAAU,CAAC,QAAgB,EAAE,WAAmB,EAAE,MAAc,EAAE,SAAiB,EAAE,OAAmB,EAAE,IAAa,EAAE,QAAmB;QACvJ,IAAI;YACF,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CACvB,IAAA,oCAAsB,EAAC,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,EACtE,MAAM,CAAC,IAAI,CAAC,uBAAU,CAAC,mBAAmB,CAAC,CAAC,CAAC,MAAM,IAAA,gBAAS,EAAC,WAAI,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EACpG,QAAQ,EACR,uBAAU,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS,CACzE,CAAC;SACH;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,CAAC,YAAY,CAAC,uBAAuB,EAAE,GAAG,CAAC,CAAC;YAChD,MAAM,GAAG,CAAC;SACX;IACH,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAY,CAAC,QAAgB,EAAE,WAAmB,EAAE,MAAc,EAAE,SAAiB,EAAE,IAAa;QAC/G,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CACxC,IAAA,oCAAsB,EAAC,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,EACtE,QAAQ,CACT,CAAC;YACF,OAAO,uBAAU,CAAC,mBAAmB,CAAC,CAAC,CAAC,MAAM,IAAA,gBAAS,EAAC,aAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;SAClF;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,CAAC,YAAY,CAAC,yBAAyB,EAAE,GAAG,CAAC,CAAC;YAClD,MAAM,GAAG,CAAC;SACX;IACH,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,cAAc,CAAC,QAAgB;QAC1C,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,CAAC;aACjE,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;gBACtB,qBAAM,CAAC,UAAU,CAAC,6CAAqB,CAAC,iBAAiB,EAAE,iDAAiD,EAAE,EAAE,MAAM,EAAE,CAAC,GAAG,KAAK,EAAE,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBAC5J,OAAO,KAAK,CAAC;aACd;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE;YAC/B,4CAA4C;YAC5C,2BAA2B;YAC3B,OAAO;gBACL,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;gBAChB,SAAS,EAAE,UAAU;gBACrB,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;aACf,CAAC;QACJ,CAAC,CAAC,CAAC;IACP,CAAC;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,IAAA,oCAAsB,EAAC,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;IAC3G,CAAC;IAEO,YAAY,CAAC,OAAe,EAAE,GAAY;QAChD,qBAAM,CAAC,YAAY,CACjB,6CAAqB,CAAC,iBAAiB,EACvC,GAAG,EACH,CAAC,QAAQ,EAAE,GAAG,EAAE,aAAa,EAAE,EAAE,CAAC,qBAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,OAAO,kBAAkB,EAAE,EAAE,GAAG,aAAa,EAAE,YAAY,EAAE,GAAG,EAAE,CAAC,CACnI,CAAC;IACJ,CAAC;CACF;AAzHD,kCAyHC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\nimport { gunzip, gzip } from \"zlib\";\r\nimport { promisify } from \"util\";\r\nimport { Metadata, ServerStorage, TransferConfig } from \"@itwin/object-storage-core\";\r\nimport { getTileObjectReference } from \"@itwin/core-common\";\r\nimport { Logger } from \"@itwin/core-bentley\";\r\nimport { BackendLoggerCategory } from \"./BackendLoggerCategory\";\r\nimport { IModelHost } from \"./IModelHost\";\r\n\r\n/**\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      await this.storage.createBaseDirectory({ baseDirectory: iModelId });\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 a list of all tiles that are found in the cloud cache.\r\n   */\r\n  public async getCachedTiles(iModelId: string): Promise<{ treeId: string, contentId: string, guid: string }[]> {\r\n    return (await this.storage.listObjects({ baseDirectory: iModelId }))\r\n      .map((objectReference) => ({\r\n        parts: objectReference.relativeDirectory?.split(\"/\") ?? [\"\"],\r\n        objectName: objectReference.objectName,\r\n      }))\r\n      .filter(({ parts, objectName }) => {\r\n        if (parts[0] !== \"tiles\")\r\n          return false;\r\n        if (parts.length !== 3) {\r\n          Logger.logWarning(BackendLoggerCategory.IModelTileStorage, \"Malformed tile id found in tile cache: {tileId}\", { tileId: [...parts, objectName].join(\"/\") });\r\n          return false;\r\n        }\r\n        return true;\r\n      }).map(({ parts, objectName }) => {\r\n        // relativeDirectory = tiles/<treeId>/<guid>\r\n        // objectName = <contentId>\r\n        return {\r\n          treeId: parts[1],\r\n          contentId: objectName,\r\n          guid: parts[2],\r\n        };\r\n      });\r\n  }\r\n\r\n  /**\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"]}

package/lib/cjs/ViewDefinition.d.ts

@@ -18,9 +18,7 @@ export declare class ModelSelector extends DefinitionElement {
     static get className(): string;
     /** The array of modelIds of the GeometricModels displayed by this ModelSelector */
     models: Id64String[];
-    /** @internal */
-    constructor(props: ModelSelectorProps, iModel: IModelDb);
-    /** @internal */
+    protected constructor(props: ModelSelectorProps, iModel: IModelDb);
     toJSON(): ModelSelectorProps;
     protected collectReferenceIds(referenceIds: EntityReferenceSet): void;
     /** Create a Code for a ModelSelector given a name that is meant to be unique within the scope of the specified DefinitionModel.
@@ -60,9 +58,7 @@ export declare class CategorySelector extends DefinitionElement {
     static get className(): string;
     /** The array of element Ids of the Categories selected by this CategorySelector */
     categories: Id64String[];
-    /** @internal */
-    constructor(props: CategorySelectorProps, iModel: IModelDb);
-    /** @internal */
+    protected constructor(props: CategorySelectorProps, iModel: IModelDb);
     toJSON(): CategorySelectorProps;
     protected collectReferenceIds(referenceIds: EntityReferenceSet): void;
     /** Create a Code for a CategorySelector given a name that is meant to be unique within the scope of the specified DefinitionModel.
@@ -95,14 +91,7 @@ export declare class CategorySelector extends DefinitionElement {
 /**
  * The definition element for a view. ViewDefinitions specify the area/volume that is viewed, the Ids of a DisplayStyle and a CategorySelector,
  * plus additional view-specific parameters in their [[Element.jsonProperties]].
- *
  * Subclasses of ViewDefinition determine which model(s) are viewed.
- *
- * **Example: Obtaining the background color for a view**
- * ``` ts
- * [[include:ViewDefinition.getBackgroundColor]]
- * ```
- *
  * @note ViewDefinition is only available in the backend. See [ViewState]($frontend) for usage in the frontend.
  * @public
  */
@@ -113,9 +102,7 @@ export declare abstract class ViewDefinition extends DefinitionElement {
     categorySelectorId: Id64String;
     /** The element Id of the [[DisplayStyle]] for this ViewDefinition */
     displayStyleId: Id64String;
-    /** @internal */
     protected constructor(props: ViewDefinitionProps, iModel: IModelDb);
-    /** @internal */
     toJSON(): ViewDefinitionProps;
     protected collectReferenceIds(referenceIds: EntityReferenceSet): void;
     /** @beta */
@@ -168,9 +155,7 @@ export declare abstract class ViewDefinition3d extends ViewDefinition {
     angles: YawPitchRollAngles;
     /** The camera used for this view, if `cameraOn` is true. */
     camera: Camera;
-    /** @internal */
-    constructor(props: ViewDefinition3dProps, iModel: IModelDb);
-    /** @internal */
+    protected constructor(props: ViewDefinition3dProps, iModel: IModelDb);
     toJSON(): ViewDefinition3dProps;
     /** Provides access to optional detail settings for this view. */
     get details(): ViewDetails3d;
@@ -194,11 +179,9 @@ export declare class SpatialViewDefinition extends ViewDefinition3d {
     static get className(): string;
     /** The Id of the [[ModelSelector]] for this SpatialViewDefinition. */
     modelSelectorId: Id64String;
-    /** @internal */
-    constructor(props: SpatialViewDefinitionProps, iModel: IModelDb);
+    protected constructor(props: SpatialViewDefinitionProps, iModel: IModelDb);
     /** Construct a SpatialViewDefinition from its JSON representation. */
     static fromJSON(props: Omit<SpatialViewDefinitionProps, "classFullName">, iModel: IModelDb): SpatialViewDefinition;
-    /** Convert this view to its JSON representation. */
     toJSON(): SpatialViewDefinitionProps;
     protected collectReferenceIds(referenceIds: EntityReferenceSet): void;
     /** @beta */
@@ -284,9 +267,7 @@ export declare class ViewDefinition2d extends ViewDefinition {
     delta: Point2d;
     /** The rotation of this view. */
     angle: Angle;
-    /** @internal */
-    constructor(props: ViewDefinition2dProps, iModel: IModelDb);
-    /** @internal */
+    protected constructor(props: ViewDefinition2dProps, iModel: IModelDb);
     toJSON(): ViewDefinition2dProps;
     protected collectReferenceIds(referenceIds: EntityReferenceSet): void;
     /** Provides access to optional detail settings for this view. */
@@ -300,8 +281,7 @@ export declare class ViewDefinition2d extends ViewDefinition {
 export declare class DrawingViewDefinition extends ViewDefinition2d {
     /** @internal */
     static get className(): string;
-    /** @internal */
-    constructor(props: ViewDefinition2dProps, iModel: IModelDb);
+    protected constructor(props: ViewDefinition2dProps, iModel: IModelDb);
     /** Create a DrawingViewDefinition
      * @param iModelDb The iModel
      * @param definitionModelId The [[DefinitionModel]]
@@ -424,7 +404,6 @@ export declare class LightLocation extends SpatialLocationElement {
     static get className(): string;
     /** Whether this light is currently turned on. */
     enabled: boolean;
-    /** @internal */
-    constructor(props: LightLocationProps, iModel: IModelDb);
+    protected constructor(props: LightLocationProps, iModel: IModelDb);
 }
 //# sourceMappingURL=ViewDefinition.d.ts.map

package/lib/cjs/ViewDefinition.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ViewDefinition.d.ts","sourceRoot":"","sources":["../../src/ViewDefinition.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAQ,SAAS,EAAE,UAAU,EAA2B,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EACL,KAAK,EAAY,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAa,QAAQ,EAAE,kBAAkB,EAChH,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,qBAAqB,EAAE,qBAAqB,EAAE,mBAAmB,EAAe,MAAM,EAAE,qBAAqB,EAAE,IAAI,EAAE,cAAc,EACzH,mBAAmB,EAAE,kBAAkB,EAAe,kBAAkB,EAAE,kBAAkB,EAAE,cAAc,EACtH,0BAA0B,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,WAAW,EAC/H,aAAa,EACd,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAC;AAC1F,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC9E,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE;;;;GAIG;AACH,qBAAa,aAAc,SAAQ,iBAAiB;IAClD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA4B;IAE1E,mFAAmF;IAC5E,MAAM,EAAE,UAAU,EAAE,CAAC;IAC5B,gBAAgB;gBACJ,KAAK,EAAE,kBAAkB,EAAE,MAAM,EAAE,QAAQ;IAKvD,gBAAgB;IACA,MAAM,IAAI,kBAAkB;cAMzB,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;IAK9E;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAKjG;;;;;;;;OAQG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,aAAa;IAUvH;;;;;;;;OAQG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,UAAU;CAIrH;AAED;;;;GAIG;AACH,qBAAa,gBAAiB,SAAQ,iBAAiB;IACrD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;IAC7E,mFAAmF;IAC5E,UAAU,EAAE,UAAU,EAAE,CAAC;IAChC,gBAAgB;gBACJ,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ;IAK1D,gBAAgB;IACA,MAAM,IAAI,qBAAqB;cAM5B,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;IAK9E;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAKjG;;;;;;;;OAQG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,GAAG,gBAAgB;IAW9H;;;;;;;;OAQG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,GAAG,UAAU;CAIzH;AAED;;;;;;;;;;;;;GAaG;AACH,8BAAsB,cAAe,SAAQ,iBAAiB;IAC5D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA6B;IAC3E,yEAAyE;IAClE,kBAAkB,EAAE,UAAU,CAAC;IACtC,qEAAqE;IAC9D,cAAc,EAAE,UAAU,CAAC;IAElC,gBAAgB;IAChB,SAAS,aAAa,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ;IAYlE,gBAAgB;IACA,MAAM,IAAI,mBAAmB;cAO1B,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;IAU9E,YAAY;IACZ,gBAAgC,qBAAqB,EAAE,aAAa,CAAC,MAAM,CAAC,CAA4E;IACxJ,aAAa;IACb,gBAAgC,2BAA2B,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAI9F;IAEF,gBAAgB;qBACU,QAAQ,CAAC,OAAO,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,mBAAmB,GAAG,IAAI;IAU9J,oDAAoD;IAC7C,QAAQ,IAAI,IAAI,IAAI,gBAAgB;IAC3C,mDAAmD;IAC5C,QAAQ,IAAI,IAAI,IAAI,gBAAgB;IAC3C,wDAAwD;IACjD,aAAa,IAAI,IAAI,IAAI,qBAAqB;IACrD,wDAAwD;IACjD,aAAa,IAAI,IAAI,IAAI,qBAAqB;IAErD,uDAAuD;IAChD,gBAAgB,IAAI,YAAY;IAEvC,2DAA2D;IACpD,oBAAoB,IAAI,gBAAgB;IAE/C,iEAAiE;IACjE,aAAoB,OAAO,IAAI,WAAW,CAAC;IAE3C,8GAA8G;IACvG,8BAA8B,IAAI,UAAU;IAInD;;OAEG;IACI,8BAA8B,CAAC,KAAK,EAAE,UAAU;IAIvD;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;CAIlG;AAED;;GAEG;AACH,8BAAsB,gBAAiB,SAAQ,cAAc;IAC3D,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgB;IACzC,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;IAC7E,0EAA0E;IACnE,QAAQ,EAAE,OAAO,CAAC;IACzB,sDAAsD;IAC/C,MAAM,EAAE,OAAO,CAAC;IACvB,8EAA8E;IACvE,OAAO,EAAE,QAAQ,CAAC;IACzB,2DAA2D;IACpD,MAAM,EAAE,kBAAkB,CAAC;IAClC,4DAA4D;IACrD,MAAM,EAAE,MAAM,CAAC;IAEtB,gBAAgB;gBACG,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ;IAUjE,gBAAgB;IACA,MAAM,IAAI,qBAAqB;IAU/C,iEAAiE;IACjE,IAAW,OAAO,IAAI,aAAa,CAA0B;IAE7D,yDAAyD;IAClD,kBAAkB,IAAI,cAAc;CAC5C;AAED;;;;;;;;;;;GAWG;AACH,qBAAa,qBAAsB,SAAQ,gBAAgB;IACzD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAoC;IAClF,sEAAsE;IAC/D,eAAe,EAAE,UAAU,CAAC;IAEnC,gBAAgB;gBACG,KAAK,EAAE,0BAA0B,EAAE,MAAM,EAAE,QAAQ;IAOtE,sEAAsE;WACxD,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,0BAA0B,EAAE,eAAe,CAAC,EAAE,MAAM,EAAE,QAAQ;IAIjG,oDAAoD;IACpC,MAAM,IAAI,0BAA0B;cAMjC,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;IAK9E,YAAY;IACZ,gBAAgC,qBAAqB,EAAE,aAAa,CAAC,MAAM,CAAC,CAAuD;IAEnI,aAAa;IACb,gBAAgC,2BAA2B,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAG9F;IAEF,wDAAwD;IACjD,iBAAiB,IAAI,aAAa;IACzC;;;;;;;;;;;;;OAaG;WACW,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,kBAAkB,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,oBAAwB,EAAE,WAAW,SAAuB,GAAG,qBAAqB;IA0BzS;;;;;OAKG;WACW,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,kBAAkB,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,oBAAwB,EAAE,WAAW,SAAuB,GAAG,UAAU;CAI/R;AAED;;;GAGG;AACH,qBAAa,0BAA2B,SAAQ,qBAAqB;IACnE,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAyC;gBAC3E,KAAK,EAAE,0BAA0B,EAAE,MAAM,EAAE,QAAQ;IAC/D;;;;;;;;;;;;OAYG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,kBAAkB,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,oBAAwB,GAAG,0BAA0B;IAqBhQ;;;;;;;;;;;;OAYG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,kBAAkB,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,oBAAwB,GAAG,UAAU;IAKhP,oFAAoF;IAC7E,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;CAOtC;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,cAAc;IAClD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAc;IAEvC,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;IAC7E,kDAAkD;IAC3C,WAAW,EAAE,UAAU,CAAC;IAC/B,+DAA+D;IACxD,MAAM,EAAE,OAAO,CAAC;IACvB,uEAAuE;IAChE,KAAK,EAAE,OAAO,CAAC;IACtB,iCAAiC;IAC1B,KAAK,EAAE,KAAK,CAAC;IAEpB,gBAAgB;gBACG,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ;IASjE,gBAAgB;IACA,MAAM,IAAI,qBAAqB;cAS5B,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;IAK9E,iEAAiE;IACjE,IAAW,OAAO,IAAI,WAAW,CAA0B;IAE3D,yDAAyD;IAClD,kBAAkB,IAAI,cAAc;CAC5C;AAED;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,gBAAgB;IACzD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAoC;IAClF,gBAAgB;gBACG,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ;IAIjE;;;;;;;;;OASG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,kBAAkB,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,GAAG,qBAAqB;IAejN,sEAAsE;WACxD,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,qBAAqB,EAAE,eAAe,CAAC,EAAE,MAAM,EAAE,QAAQ;IAI5F;;;;;;;;;OASG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,kBAAkB,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,GAAG,UAAU;CAIvM;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,gBAAgB;IACvD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAkC;CACjF;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,gBAAgB;IAC5D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAuC;CACtF;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,gBAAgB;IAC5D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAuC;CACtF;AAED;;;GAGG;AACH,8BAAsB,cAAe,SAAQ,iBAAiB;IAC5D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA6B;IACpE,IAAI,EAAG,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;gBACT,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ;CAChE;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,cAAc;IAClD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;IACtE,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,EAAG,MAAM,CAAC;gBACH,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ;IAEjE;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;CAIlG;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,cAAc;IAClD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;IACtE,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,GAAG,EAAG,MAAM,CAAC;IACb,KAAK,EAAG,MAAM,CAAC;IACf,IAAI,EAAG,MAAM,CAAC;gBACF,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ;IAEjE;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;CAIlG;AAED;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,gBAAgB;IACzD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAoC;IAClF;;;;OAIG;WACoB,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;CAI3G;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,kBAAkB;IACpD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA6B;IACpE,IAAI,EAAE,cAAc,CAAC;gBACT,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ;cAK5C,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;CAI/E;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,sBAAsB;IACvD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA4B;IAC1E,iDAAiD;IAC1C,OAAO,EAAG,OAAO,CAAC;IACzB,gBAAgB;gBACJ,KAAK,EAAE,kBAAkB,EAAE,MAAM,EAAE,QAAQ;CACxD"}
+{"version":3,"file":"ViewDefinition.d.ts","sourceRoot":"","sources":["../../src/ViewDefinition.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAQ,SAAS,EAAE,UAAU,EAA2B,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EACL,KAAK,EAAY,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAa,QAAQ,EAAE,kBAAkB,EAChH,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,qBAAqB,EAAE,qBAAqB,EAAE,mBAAmB,EAAe,MAAM,EAAE,qBAAqB,EAAE,IAAI,EAAE,cAAc,EACzH,mBAAmB,EAAE,kBAAkB,EAAe,kBAAkB,EAAE,kBAAkB,EAAE,cAAc,EACtH,0BAA0B,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,WAAW,EAC/H,aAAa,EACd,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAC;AAC1F,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC9E,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE;;;;GAIG;AACH,qBAAa,aAAc,SAAQ,iBAAiB;IAClD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA4B;IAE1E,mFAAmF;IAC5E,MAAM,EAAE,UAAU,EAAE,CAAC;IAE5B,SAAS,aAAa,KAAK,EAAE,kBAAkB,EAAE,MAAM,EAAE,QAAQ;IAKjD,MAAM,IAAI,kBAAkB;cAMzB,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;IAK9E;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAKjG;;;;;;;;OAQG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,aAAa;IAUvH;;;;;;;;OAQG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,UAAU;CAIrH;AAED;;;;GAIG;AACH,qBAAa,gBAAiB,SAAQ,iBAAiB;IACrD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;IAC7E,mFAAmF;IAC5E,UAAU,EAAE,UAAU,EAAE,CAAC;IAEhC,SAAS,aAAa,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ;IAKpD,MAAM,IAAI,qBAAqB;cAM5B,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;IAK9E;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAKjG;;;;;;;;OAQG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,GAAG,gBAAgB;IAW9H;;;;;;;;OAQG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,GAAG,UAAU;CAIzH;AAED;;;;;;GAMG;AACH,8BAAsB,cAAe,SAAQ,iBAAiB;IAC5D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA6B;IAC3E,yEAAyE;IAClE,kBAAkB,EAAE,UAAU,CAAC;IACtC,qEAAqE;IAC9D,cAAc,EAAE,UAAU,CAAC;IAElC,SAAS,aAAa,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ;IAYlD,MAAM,IAAI,mBAAmB;cAO1B,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;IAU9E,YAAY;IACZ,gBAAgC,qBAAqB,EAAE,aAAa,CAAC,MAAM,CAAC,CAA4E;IACxJ,aAAa;IACb,gBAAgC,2BAA2B,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAI9F;IAEF,gBAAgB;qBACU,QAAQ,CAAC,OAAO,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,mBAAmB,GAAG,IAAI;IAU9J,oDAAoD;IAC7C,QAAQ,IAAI,IAAI,IAAI,gBAAgB;IAC3C,mDAAmD;IAC5C,QAAQ,IAAI,IAAI,IAAI,gBAAgB;IAC3C,wDAAwD;IACjD,aAAa,IAAI,IAAI,IAAI,qBAAqB;IACrD,wDAAwD;IACjD,aAAa,IAAI,IAAI,IAAI,qBAAqB;IAErD,uDAAuD;IAChD,gBAAgB,IAAI,YAAY;IAEvC,2DAA2D;IACpD,oBAAoB,IAAI,gBAAgB;IAE/C,iEAAiE;IACjE,aAAoB,OAAO,IAAI,WAAW,CAAC;IAE3C,8GAA8G;IACvG,8BAA8B,IAAI,UAAU;IAInD;;OAEG;IACI,8BAA8B,CAAC,KAAK,EAAE,UAAU;IAIvD;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;CAIlG;AAED;;GAEG;AACH,8BAAsB,gBAAiB,SAAQ,cAAc;IAC3D,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgB;IACzC,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;IAC7E,0EAA0E;IACnE,QAAQ,EAAE,OAAO,CAAC;IACzB,sDAAsD;IAC/C,MAAM,EAAE,OAAO,CAAC;IACvB,8EAA8E;IACvE,OAAO,EAAE,QAAQ,CAAC;IACzB,2DAA2D;IACpD,MAAM,EAAE,kBAAkB,CAAC;IAClC,4DAA4D;IACrD,MAAM,EAAE,MAAM,CAAC;IAEtB,SAAS,aAAa,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ;IAUpD,MAAM,IAAI,qBAAqB;IAU/C,iEAAiE;IACjE,IAAW,OAAO,IAAI,aAAa,CAA0B;IAE7D,yDAAyD;IAClD,kBAAkB,IAAI,cAAc;CAC5C;AAED;;;;;;;;;;;GAWG;AACH,qBAAa,qBAAsB,SAAQ,gBAAgB;IACzD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAoC;IAClF,sEAAsE;IAC/D,eAAe,EAAE,UAAU,CAAC;IAEnC,SAAS,aAAa,KAAK,EAAE,0BAA0B,EAAE,MAAM,EAAE,QAAQ;IAOzE,sEAAsE;WACxD,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,0BAA0B,EAAE,eAAe,CAAC,EAAE,MAAM,EAAE,QAAQ;IAIjF,MAAM,IAAI,0BAA0B;cAMjC,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;IAK9E,YAAY;IACZ,gBAAgC,qBAAqB,EAAE,aAAa,CAAC,MAAM,CAAC,CAAuD;IAEnI,aAAa;IACb,gBAAgC,2BAA2B,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAG9F;IAEF,wDAAwD;IACjD,iBAAiB,IAAI,aAAa;IACzC;;;;;;;;;;;;;OAaG;WACW,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,kBAAkB,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,oBAAwB,EAAE,WAAW,SAAuB,GAAG,qBAAqB;IA0BzS;;;;;OAKG;WACW,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,kBAAkB,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,oBAAwB,EAAE,WAAW,SAAuB,GAAG,UAAU;CAI/R;AAED;;;GAGG;AACH,qBAAa,0BAA2B,SAAQ,qBAAqB;IACnE,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAyC;gBAE3E,KAAK,EAAE,0BAA0B,EAAE,MAAM,EAAE,QAAQ;IAE/D;;;;;;;;;;;;OAYG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,kBAAkB,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,oBAAwB,GAAG,0BAA0B;IAqBhQ;;;;;;;;;;;;OAYG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,kBAAkB,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,oBAAwB,GAAG,UAAU;IAKhP,oFAAoF;IAC7E,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;CAOtC;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,cAAc;IAClD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAc;IAEvC,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;IAC7E,kDAAkD;IAC3C,WAAW,EAAE,UAAU,CAAC;IAC/B,+DAA+D;IACxD,MAAM,EAAE,OAAO,CAAC;IACvB,uEAAuE;IAChE,KAAK,EAAE,OAAO,CAAC;IACtB,iCAAiC;IAC1B,KAAK,EAAE,KAAK,CAAC;IAEpB,SAAS,aAAa,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ;IASpD,MAAM,IAAI,qBAAqB;cAS5B,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;IAK9E,iEAAiE;IACjE,IAAW,OAAO,IAAI,WAAW,CAA0B;IAE3D,yDAAyD;IAClD,kBAAkB,IAAI,cAAc;CAC5C;AAED;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,gBAAgB;IACzD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAoC;IAElF,SAAS,aAAa,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ;IAIpE;;;;;;;;;OASG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,kBAAkB,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,GAAG,qBAAqB;IAejN,sEAAsE;WACxD,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,qBAAqB,EAAE,eAAe,CAAC,EAAE,MAAM,EAAE,QAAQ;IAI5F;;;;;;;;;OASG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,kBAAkB,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,GAAG,UAAU;CAIvM;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,gBAAgB;IACvD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAkC;CACjF;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,gBAAgB;IAC5D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAuC;CACtF;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,gBAAgB;IAC5D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAuC;CACtF;AAED;;;GAGG;AACH,8BAAsB,cAAe,SAAQ,iBAAiB;IAC5D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA6B;IACpE,IAAI,EAAG,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;gBACT,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ;CAChE;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,cAAc;IAClD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;IACtE,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,EAAG,MAAM,CAAC;gBACH,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ;IAEjE;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;CAIlG;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,cAAc;IAClD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;IACtE,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,GAAG,EAAG,MAAM,CAAC;IACb,KAAK,EAAG,MAAM,CAAC;IACf,IAAI,EAAG,MAAM,CAAC;gBACF,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ;IAEjE;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;CAIlG;AAED;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,gBAAgB;IACzD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAoC;IAClF;;;;OAIG;WACoB,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;CAI3G;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,kBAAkB;IACpD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA6B;IACpE,IAAI,EAAE,cAAc,CAAC;gBACT,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ;cAK5C,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;CAI/E;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,sBAAsB;IACvD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA4B;IAC1E,iDAAiD;IAC1C,OAAO,EAAG,OAAO,CAAC;IAEzB,SAAS,aAAa,KAAK,EAAE,kBAAkB,EAAE,MAAM,EAAE,QAAQ;CAClE"}

package/lib/cjs/ViewDefinition.js

@@ -21,12 +21,10 @@ const Element_1 = require("./Element");
 class ModelSelector extends Element_1.DefinitionElement {
     /** @internal */
     static get className() { return "ModelSelector"; }
-    /** @internal */
     constructor(props, iModel) {
         super(props, iModel);
         this.models = props.models;
     }
-    /** @internal */
     toJSON() {
         const val = super.toJSON();
         val.models = this.models;
@@ -87,12 +85,10 @@ exports.ModelSelector = ModelSelector;
 class CategorySelector extends Element_1.DefinitionElement {
     /** @internal */
     static get className() { return "CategorySelector"; }
-    /** @internal */
     constructor(props, iModel) {
         super(props, iModel);
         this.categories = props.categories;
     }
-    /** @internal */
     toJSON() {
         const val = super.toJSON();
         val.categories = this.categories;
@@ -148,21 +144,13 @@ exports.CategorySelector = CategorySelector;
 /**
  * The definition element for a view. ViewDefinitions specify the area/volume that is viewed, the Ids of a DisplayStyle and a CategorySelector,
  * plus additional view-specific parameters in their [[Element.jsonProperties]].
- *
  * Subclasses of ViewDefinition determine which model(s) are viewed.
- *
- * **Example: Obtaining the background color for a view**
- * ``` ts
- * [[include:ViewDefinition.getBackgroundColor]]
- * ```
- *
  * @note ViewDefinition is only available in the backend. See [ViewState]($frontend) for usage in the frontend.
  * @public
  */
 class ViewDefinition extends (_b = Element_1.DefinitionElement) {
     /** @internal */
     static get className() { return "ViewDefinition"; }
-    /** @internal */
     constructor(props, iModel) {
         super(props, iModel);
         this.categorySelectorId = core_bentley_1.Id64.fromJSON(props.categorySelectorId);
@@ -172,7 +160,6 @@ class ViewDefinition extends (_b = Element_1.DefinitionElement) {
         if (!core_bentley_1.Id64.isValid(this.displayStyleId))
             throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadArg, `displayStyleId is invalid`);
     }
-    /** @internal */
     toJSON() {
         const json = super.toJSON();
         json.categorySelectorId = this.categorySelectorId;
@@ -246,7 +233,6 @@ exports.ViewDefinition = ViewDefinition;
 class ViewDefinition3d extends ViewDefinition {
     /** @internal */
     static get className() { return "ViewDefinition3d"; }
-    /** @internal */
     constructor(props, iModel) {
         super(props, iModel);
         this.cameraOn = core_bentley_1.JsonUtils.asBool(props.cameraOn);
@@ -256,7 +242,6 @@ class ViewDefinition3d extends ViewDefinition {
         this.camera = new core_common_1.Camera(props.camera);
         this._details = new core_common_1.ViewDetails3d(this.jsonProperties);
     }
-    /** @internal */
     toJSON() {
         const val = super.toJSON();
         val.cameraOn = this.cameraOn;
@@ -287,7 +272,6 @@ exports.ViewDefinition3d = ViewDefinition3d;
 class SpatialViewDefinition extends (_d = ViewDefinition3d) {
     /** @internal */
     static get className() { return "SpatialViewDefinition"; }
-    /** @internal */
     constructor(props, iModel) {
         super(props, iModel);
         this.modelSelectorId = core_bentley_1.Id64.fromJSON(props.modelSelectorId);
@@ -298,7 +282,6 @@ class SpatialViewDefinition extends (_d = ViewDefinition3d) {
     static fromJSON(props, iModel) {
         return new SpatialViewDefinition({ ...props, classFullName: this.classFullName }, iModel);
     }
-    /** Convert this view to its JSON representation. */
     toJSON() {
         const json = super.toJSON();
         json.modelSelectorId = this.modelSelectorId;
@@ -442,7 +425,6 @@ exports.OrthographicViewDefinition = OrthographicViewDefinition;
 class ViewDefinition2d extends ViewDefinition {
     /** @internal */
     static get className() { return "ViewDefinition2d"; }
-    /** @internal */
     constructor(props, iModel) {
         super(props, iModel);
         this.baseModelId = core_bentley_1.Id64.fromJSON(props.baseModelId);
@@ -451,7 +433,6 @@ class ViewDefinition2d extends ViewDefinition {
         this.angle = core_geometry_1.Angle.fromJSON(props.angle);
         this._details = new core_common_1.ViewDetails(this.jsonProperties);
     }
-    /** @internal */
     toJSON() {
         const val = super.toJSON();
         val.baseModelId = this.baseModelId;
@@ -476,7 +457,6 @@ exports.ViewDefinition2d = ViewDefinition2d;
 class DrawingViewDefinition extends ViewDefinition2d {
     /** @internal */
     static get className() { return "DrawingViewDefinition"; }
-    /** @internal */
     constructor(props, iModel) {
         super(props, iModel);
     }
@@ -634,7 +614,6 @@ exports.ViewAttachment = ViewAttachment;
 class LightLocation extends Element_1.SpatialLocationElement {
     /** @internal */
     static get className() { return "LightLocation"; }
-    /** @internal */
     constructor(props, iModel) { super(props, iModel); }
 }
 exports.LightLocation = LightLocation;