@itwin/core-common 3.5.0-dev.16 → 3.5.0-dev.18

package/lib/esm/BackgroundMapSettings.js.map

@@ -1 +1 @@
-{"version":3,"file":"BackgroundMapSettings.js","sourceRoot":"","sources":["../../src/BackgroundMapSettings.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AACnF,OAAO,EAAuB,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAC/E,OAAO,EAAgB,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAElE;;;;;GAKG;AACH,MAAM,CAAN,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,oCAAoC;IACpC,mDAAa,CAAA;IACb,8BAA8B;IAC9B,2CAAS,CAAA;AACX,CAAC,EALW,SAAS,KAAT,SAAS,QAKpB;AAgED,SAAS,kBAAkB,CAAC,IAAgB;IAC1C,OAAO,SAAS,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC;AAC/D,CAAC;AAED,SAAS,qBAAqB,CAAC,KAAsB;IACnD,IAAI,QAAQ,KAAK,OAAO,KAAK;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;IAEzC,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,MAAM,OAAO,qBAAqB;IAqChC,YAAoB,KAAwD;;QAC1E,IAAI,CAAC,UAAU,GAAG,MAAA,KAAK,CAAC,UAAU,mCAAI,CAAC,CAAC;QACxC,IAAI,CAAC,YAAY,GAAG,qBAAqB,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAC9D,IAAI,CAAC,cAAc,GAAG,MAAA,KAAK,CAAC,cAAc,mCAAI,KAAK,CAAC;QACpD,IAAI,CAAC,YAAY,GAAG,MAAA,KAAK,CAAC,YAAY,mCAAI,KAAK,CAAC;QAChD,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QACvE,IAAI,CAAC,SAAS,GAAG,kBAAkB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACrD,IAAI,CAAC,UAAU,GAAG,IAAI,KAAK,KAAK,CAAC,YAAY,CAAC;QAC9C,IAAI,CAAC,cAAc,GAAG,sBAAsB,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAC5E,IAAI,CAAC,SAAS,GAAG,qBAAqB,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;IACvE,CAAC;IA1BD;;OAEG;IACH,IAAW,SAAS;QAClB,2CAA2C;QAC3C,mFAAmF;QACnF,oDAAoD;QACpD,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,eAAe,CAAC,YAAY;YACxD,OAAO,KAAK,CAAC;QAEf,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,sFAAsF;IACtF,IAAW,oBAAoB,KAAyB,OAAO,KAAK,KAAK,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IAc7H;;OAEG;IACI,MAAM,CAAC,kBAAkB,CAAC,IAAmC;QAClE,OAAO,IAAI,IAAI,CAAC,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,QAAQ,CAAC,IAAyB;QAC9C,OAAO,IAAI,qBAAqB,CAAC,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACI,MAAM;QACX,MAAM,KAAK,GAAuB,EAAE,CAAC;QACrC,IAAI,CAAC,KAAK,IAAI,CAAC,UAAU;YACvB,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACrC,IAAI,IAAI,CAAC,YAAY;YACnB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;QAC5B,IAAI,KAAK,KAAK,IAAI,CAAC,YAAY;YAC7B,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QACzC,IAAI,SAAS,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS;YACxC,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACnC,IAAI,IAAI,CAAC,cAAc;YACrB,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC;QAC9B,IAAI,CAAC,IAAI,CAAC,UAAU;YAClB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;QAE5B,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC;QACtD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE;YACjD,IAAI,SAAS,KAAK,IAAI,EAAE;gBACtB,KAAK,CAAC,eAAe,GAAG,eAAe,CAAC;gBACxC,MAAM;aACP;SACF;QAED,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO;YAC7B,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC;QAEtD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACI,gBAAgB;QACrB,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,EAAkC,CAAC;QAE5D,mDAAmD;QACnD,IAAI,cAAc,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI;YACxC,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,8CAA8C;QAC1F,IAAI,iBAAiB,CAAC,MAAM,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI;YAClD,KAAK,CAAC,YAAY,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,8CAA8C;QAEvG,OAAO,KAAK,CAAC;IACf,CAAC;IAED,mFAAmF;IAC5E,UAAU,CAAC,IAAyB;QACzC,OAAO,IAAI,CAAC,MAAM,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,+FAA+F;IACxF,oBAAoB,CAAC,IAAmC;QAC7D,OAAO,IAAI,CAAC,MAAM,CAAC,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC;IACrE,CAAC;IAED,gEAAgE;IACzD,MAAM,CAAC,KAA4B;QACxC,OAAO,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,CAAC,cAAc,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;eAClI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;eACtH,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC;eACtG,IAAI,CAAC,SAAS,CAAC,IAAI,KAAK,KAAK,CAAC,SAAS,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,KAAK,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC;IACpG,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAAiC;;QAC5C,IAAI,SAAS,KAAK,YAAY;YAC5B,OAAO,IAAI,CAAC;QAEd,MAAM,KAAK,GAAG;YACZ,UAAU,EAAE,MAAA,YAAY,CAAC,UAAU,mCAAI,IAAI,CAAC,UAAU;YACtD,YAAY,EAAE,MAAA,YAAY,CAAC,YAAY,mCAAI,IAAI,CAAC,YAAY;YAC5D,cAAc,EAAE,MAAA,YAAY,CAAC,cAAc,mCAAI,IAAI,CAAC,cAAc;YAClE,SAAS,EAAE,MAAA,YAAY,CAAC,SAAS,mCAAI,IAAI,CAAC,SAAS;YACnD,YAAY,EAAE,MAAA,YAAY,CAAC,YAAY,mCAAI,CAAC,IAAI,CAAC,UAAU;YAC3D,YAAY,EAAE,MAAA,YAAY,CAAC,YAAY,mCAAI,IAAI,CAAC,YAAY;YAC5D,eAAe,EAAE,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE;YACjJ,cAAc,EAAE,YAAY,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE;YAC5I,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI;YACjC,YAAY,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE;SAC/C,CAAC;QAEF,OAAO,qBAAqB,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IACzD,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module DisplayStyles\r\n */\r\n\r\nimport { BackgroundMapProvider, BackgroundMapType } from \"./BackgroundMapProvider\";\r\nimport { PlanarClipMaskProps, PlanarClipMaskSettings } from \"./PlanarClipMask\";\r\nimport { TerrainProps, TerrainSettings } from \"./TerrainSettings\";\r\n\r\n/** Describes the projection of the background map\r\n * @see [[BackgroundMapProps]]\r\n * @see [[DisplayStyleSettingsProps]]\r\n * @public\r\n * @extensions\r\n */\r\nexport enum GlobeMode {\r\n  /** Display Earth as 3d ellipsoid */\r\n  Ellipsoid = 0,\r\n  /** Display Earth as plane. */\r\n  Plane = 1,\r\n}\r\n\r\n/** In-memory JSON representation of a [[BackgroundMapSettings]].\r\n * @see [[PersistentBackgroundMapProps]] for the persistent JSON representation.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface BackgroundMapProps {\r\n  /** The elevation of the map in meters relative the WGS84 ellipsoid. Default value: 0. */\r\n  groundBias?: number;\r\n  /** A transparency value from 0.0 (fully opaque) to 1.0 (fully transparent) to apply to map graphics when drawing, or false to indicate the transparency should not be overridden.\r\n   * Default value: false.\r\n   */\r\n  transparency?: number | false;\r\n  /** If set to true, the map tiles will be rendered with depth, allowing them to obscure other geometry. Otherwise, they are always rendered behind all other geometry. Default value: false. */\r\n  useDepthBuffer?: boolean;\r\n  /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */\r\n  applyTerrain?: boolean;\r\n  /** Properties associated with terrain display. */\r\n  terrainSettings?: TerrainProps;\r\n  /** Globe Mode. Default value: GlobeMode.Ellipsoid */\r\n  globeMode?: GlobeMode;\r\n  /** If true, the map will be treated as non-locatable - i.e., tools will not interact with it. This is particularly useful when the map is transparent - it\r\n   * allows the user to select elements that are behind the map.\r\n   */\r\n  nonLocatable?: boolean;\r\n  /** A planar mask applied to the map geometry\r\n   * @beta\r\n   */\r\n  planarClipMask?: PlanarClipMaskProps;\r\n\r\n  /** See [[DeprecatedBackgroundMapProps.providerName]]. */\r\n  providerName?: never;\r\n  /** See [[DeprecatedBackgroundMapProps.providerData]]. */\r\n  providerData?: never;\r\n}\r\n\r\n/** Properties of [[PersistentBackgroundMapProps]] that have been deprecated, but are retained for backwards compatibility.\r\n * These properties are omitted from [[BackgroundMapProps]] as they are no longer part of the API, but are included in\r\n * [[PersistentBackgroundMapProps]] because they remain part of the persistence format.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface DeprecatedBackgroundMapProps {\r\n  /** Identifies the source of the map tiles. Currently supported providers are \"BingProvider\" and \"MapBoxProvider\".\r\n   * Default value: \"BingProvider\"\r\n   * @deprecated use MapImageryProps.backgroundBase.\r\n   */\r\n  providerName?: string;\r\n  /** Options for customizing the tiles supplied by the provider. If undefined, default values of all members are used.\r\n   * @deprecated use MapImageryProps.backgroundBase\r\n   */\r\n  providerData?: {\r\n    /** The type of map graphics to request. Default value: BackgroundMapType.Hybrid. */\r\n    mapType?: BackgroundMapType;\r\n  };\r\n}\r\n\r\n/** Persistent JSON representation of a [[BackgroundMapSettings]].\r\n * @public\r\n * @extensions\r\n */\r\nexport type PersistentBackgroundMapProps = Omit<BackgroundMapProps, keyof DeprecatedBackgroundMapProps> & DeprecatedBackgroundMapProps;\r\n\r\nfunction normalizeGlobeMode(mode?: GlobeMode): GlobeMode {\r\n  return GlobeMode.Plane === mode ? mode : GlobeMode.Ellipsoid;\r\n}\r\n\r\nfunction normalizeTransparency(trans?: number | false): number | false {\r\n  if (\"number\" === typeof trans)\r\n    return Math.min(1, Math.max(0, trans));\r\n\r\n  return false;\r\n}\r\n\r\n/** As part of a [[DisplayStyleSettings]], controls aspects of how the background map is displayed.\r\n * @see [[DisplayStyleSettings.backgroundMap]] to query or change these settings for a display style.\r\n * @see [[MapImagerySettings]] to control the type of imagery applied to the background map.\r\n * @public\r\n */\r\nexport class BackgroundMapSettings {\r\n  /** Retained strictly for persistence. */\r\n  private readonly _provider: BackgroundMapProvider;\r\n\r\n  /** Elevation in meters, relative to WGS84 Ellipsoid.. */\r\n  public readonly groundBias: number;\r\n  /** A transparency value from 0.0 (fully opaque) to 1.0 (fully transparent) to apply to map graphics when drawing, or false to indicate the transparency should not be overridden. Default value: false. */\r\n  public readonly transparency: number | false;\r\n  /** If set to true, the map tiles will be rendered with depth, allowing them to obscure other geometry. Otherwise, they are always rendered behind all other geometry. Default value: false. */\r\n  public readonly useDepthBuffer: boolean;\r\n  /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */\r\n  public readonly applyTerrain: boolean;\r\n  /** Settings associated with terrain display. */\r\n  public readonly terrainSettings: TerrainSettings;\r\n  /** Globe display mode. */\r\n  public readonly globeMode: GlobeMode;\r\n  /** Planar Mask - used to mask the background map to avoid overlapping with other geometry\r\n   * @beta\r\n   */\r\n  public readonly planarClipMask: PlanarClipMaskSettings;\r\n  private readonly _locatable: boolean;\r\n  /** If false, the map will be treated as non-locatable - i.e., tools will not interact with it. This is particularly useful when the map is transparent - it\r\n   * allows the user to select elements that are behind the map.\r\n   */\r\n  public get locatable(): boolean {\r\n    // Handle legacy TerrainProps.nonLocatable:\r\n    // - If TerrainProps.nonLocatable=true and terrain is on, terrain is not locatable.\r\n    // - Otherwise, use BackgroundMapProps.nonLocatable.\r\n    if (this.applyTerrain && this.terrainSettings.nonLocatable)\r\n      return false;\r\n\r\n    return this._locatable;\r\n  }\r\n\r\n  /** If transparency is overridden, the transparency to apply; otherwise, undefined. */\r\n  public get transparencyOverride(): number | undefined { return false !== this.transparency ? this.transparency : undefined; }\r\n\r\n  private constructor(props: BackgroundMapProps | PersistentBackgroundMapProps) {\r\n    this.groundBias = props.groundBias ?? 0;\r\n    this.transparency = normalizeTransparency(props.transparency);\r\n    this.useDepthBuffer = props.useDepthBuffer ?? false;\r\n    this.applyTerrain = props.applyTerrain ?? false;\r\n    this.terrainSettings = TerrainSettings.fromJSON(props.terrainSettings);\r\n    this.globeMode = normalizeGlobeMode(props.globeMode);\r\n    this._locatable = true !== props.nonLocatable;\r\n    this.planarClipMask = PlanarClipMaskSettings.fromJSON(props.planarClipMask);\r\n    this._provider = BackgroundMapProvider.fromBackgroundMapProps(props);\r\n  }\r\n\r\n  /** Create settings from their persistent representation. In general, this method should only be used when reading the settings directly from\r\n   * the iModel - otherwise, prefer [[fromJSON]].\r\n   */\r\n  public static fromPersistentJSON(json?: PersistentBackgroundMapProps): BackgroundMapSettings {\r\n    return new this(json ?? {});\r\n  }\r\n\r\n  /** Construct from JSON, performing validation and applying default values for undefined fields.\r\n   * @see [[fromPersistentJSON]] if you are reading the settings directly from the iModel.\r\n   */\r\n  public static fromJSON(json?: BackgroundMapProps): BackgroundMapSettings {\r\n    return new BackgroundMapSettings(json ?? {});\r\n  }\r\n\r\n  /** Convert these settings to their in-memory JSON representation.\r\n   * @see [[toPersistentJSON]] if you intend to write the JSON directly to an iModel.\r\n   */\r\n  public toJSON(): BackgroundMapProps {\r\n    const props: BackgroundMapProps = {};\r\n    if (0 !== this.groundBias)\r\n      props.groundBias = this.groundBias;\r\n    if (this.applyTerrain)\r\n      props.applyTerrain = true;\r\n    if (false !== this.transparency)\r\n      props.transparency = this.transparency;\r\n    if (GlobeMode.Ellipsoid !== this.globeMode)\r\n      props.globeMode = this.globeMode;\r\n    if (this.useDepthBuffer)\r\n      props.useDepthBuffer = true;\r\n    if (!this._locatable)\r\n      props.nonLocatable = true;\r\n\r\n    const terrainSettings = this.terrainSettings.toJSON();\r\n    for (const prop of Object.values(terrainSettings)) {\r\n      if (undefined !== prop) {\r\n        props.terrainSettings = terrainSettings;\r\n        break;\r\n      }\r\n    }\r\n\r\n    if (this.planarClipMask.isValid)\r\n      props.planarClipMask = this.planarClipMask.toJSON();\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Convert these settings to their persistent representation. In general, this method should only be used when writing the settings directly to\r\n   * the iModel - otherwise, prefer [[toJSON]].\r\n   */\r\n  public toPersistentJSON(): PersistentBackgroundMapProps {\r\n    const props = this.toJSON() as PersistentBackgroundMapProps;\r\n\r\n    // Preserve deprecated imagery provider properties.\r\n    if (\"BingProvider\" !== this._provider.name)\r\n      props.providerName = this._provider.name; // eslint-disable-line deprecation/deprecation\r\n    if (BackgroundMapType.Hybrid !== this._provider.type)\r\n      props.providerData = { mapType: this._provider.type }; // eslint-disable-line deprecation/deprecation\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Returns true if these settings are equivalent to the supplied JSON settings. */\r\n  public equalsJSON(json?: BackgroundMapProps): boolean {\r\n    return this.equals(BackgroundMapSettings.fromJSON(json));\r\n  }\r\n\r\n  /** Returns true if the persistent representation of these settings is equivalent to `json`. */\r\n  public equalsPersistentJSON(json?: PersistentBackgroundMapProps): boolean {\r\n    return this.equals(BackgroundMapSettings.fromPersistentJSON(json));\r\n  }\r\n\r\n  /** Returns true if these settings are equivalent to `other`. */\r\n  public equals(other: BackgroundMapSettings): boolean {\r\n    return this.groundBias === other.groundBias && this.useDepthBuffer === other.useDepthBuffer && this.transparency === other.transparency\r\n      && this.globeMode === other.globeMode && this._locatable === other._locatable && this.applyTerrain === other.applyTerrain\r\n      && this.terrainSettings.equals(other.terrainSettings) && this.planarClipMask.equals(other.planarClipMask)\r\n      && this._provider.name === other._provider.name && this._provider.type === other._provider.type;\r\n  }\r\n\r\n  /** Create a copy of this BackgroundMapSettings, optionally modifying some of its properties.\r\n   * @param changedProps JSON representation of the properties to change.\r\n   * @returns A BackgroundMapSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.\r\n   */\r\n  public clone(changedProps?: BackgroundMapProps): BackgroundMapSettings {\r\n    if (undefined === changedProps)\r\n      return this;\r\n\r\n    const props = {\r\n      groundBias: changedProps.groundBias ?? this.groundBias,\r\n      transparency: changedProps.transparency ?? this.transparency,\r\n      useDepthBuffer: changedProps.useDepthBuffer ?? this.useDepthBuffer,\r\n      globeMode: changedProps.globeMode ?? this.globeMode,\r\n      nonLocatable: changedProps.nonLocatable ?? !this._locatable,\r\n      applyTerrain: changedProps.applyTerrain ?? this.applyTerrain,\r\n      terrainSettings: changedProps.terrainSettings ? this.terrainSettings.clone(changedProps.terrainSettings).toJSON() : this.terrainSettings.toJSON(),\r\n      planarClipMask: changedProps.planarClipMask ? this.planarClipMask.clone(changedProps.planarClipMask).toJSON() : this.planarClipMask.toJSON(),\r\n      providerName: this._provider.name,\r\n      providerData: { mapType: this._provider.type },\r\n    };\r\n\r\n    return BackgroundMapSettings.fromPersistentJSON(props);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"BackgroundMapSettings.js","sourceRoot":"","sources":["../../src/BackgroundMapSettings.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AACnF,OAAO,EAAuB,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAC/E,OAAO,EAAgB,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAElE;;;;;GAKG;AACH,MAAM,CAAN,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,oCAAoC;IACpC,mDAAa,CAAA;IACb,8BAA8B;IAC9B,2CAAS,CAAA;AACX,CAAC,EALW,SAAS,KAAT,SAAS,QAKpB;AAgED,SAAS,kBAAkB,CAAC,IAAgB;IAC1C,OAAO,SAAS,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC;AAC/D,CAAC;AAED,SAAS,qBAAqB,CAAC,KAAsB;IACnD,IAAI,QAAQ,KAAK,OAAO,KAAK;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;IAEzC,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,MAAM,OAAO,qBAAqB;IAqChC,YAAoB,KAAwD;;QAC1E,IAAI,CAAC,UAAU,GAAG,MAAA,KAAK,CAAC,UAAU,mCAAI,CAAC,CAAC;QACxC,IAAI,CAAC,YAAY,GAAG,qBAAqB,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAC9D,IAAI,CAAC,cAAc,GAAG,MAAA,KAAK,CAAC,cAAc,mCAAI,KAAK,CAAC;QACpD,IAAI,CAAC,YAAY,GAAG,MAAA,KAAK,CAAC,YAAY,mCAAI,KAAK,CAAC;QAChD,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QACvE,IAAI,CAAC,SAAS,GAAG,kBAAkB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACrD,IAAI,CAAC,UAAU,GAAG,IAAI,KAAK,KAAK,CAAC,YAAY,CAAC;QAC9C,IAAI,CAAC,cAAc,GAAG,sBAAsB,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAC5E,IAAI,CAAC,SAAS,GAAG,qBAAqB,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;IACvE,CAAC;IA1BD;;OAEG;IACH,IAAW,SAAS;QAClB,2CAA2C;QAC3C,mFAAmF;QACnF,oDAAoD;QACpD,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,eAAe,CAAC,YAAY;YACxD,OAAO,KAAK,CAAC;QAEf,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,sFAAsF;IACtF,IAAW,oBAAoB,KAAyB,OAAO,KAAK,KAAK,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IAc7H;;OAEG;IACI,MAAM,CAAC,kBAAkB,CAAC,IAAmC;QAClE,OAAO,IAAI,IAAI,CAAC,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,QAAQ,CAAC,IAAyB;QAC9C,OAAO,IAAI,qBAAqB,CAAC,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACI,MAAM;QACX,MAAM,KAAK,GAAuB,EAAE,CAAC;QACrC,IAAI,CAAC,KAAK,IAAI,CAAC,UAAU;YACvB,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACrC,IAAI,IAAI,CAAC,YAAY;YACnB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;QAC5B,IAAI,KAAK,KAAK,IAAI,CAAC,YAAY;YAC7B,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QACzC,IAAI,SAAS,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS;YACxC,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACnC,IAAI,IAAI,CAAC,cAAc;YACrB,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC;QAC9B,IAAI,CAAC,IAAI,CAAC,UAAU;YAClB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;QAE5B,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC;QACtD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE;YACjD,IAAI,SAAS,KAAK,IAAI,EAAE;gBACtB,KAAK,CAAC,eAAe,GAAG,eAAe,CAAC;gBACxC,MAAM;aACP;SACF;QAED,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO;YAC7B,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC;QAEtD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACI,gBAAgB;QACrB,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,EAAkC,CAAC;QAE5D,mDAAmD;QACnD,IAAI,cAAc,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI;YACxC,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,8CAA8C;QAC1F,IAAI,iBAAiB,CAAC,MAAM,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI;YAClD,KAAK,CAAC,YAAY,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,8CAA8C;QAEvG,OAAO,KAAK,CAAC;IACf,CAAC;IAED,mFAAmF;IAC5E,UAAU,CAAC,IAAyB;QACzC,OAAO,IAAI,CAAC,MAAM,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,+FAA+F;IACxF,oBAAoB,CAAC,IAAmC;QAC7D,OAAO,IAAI,CAAC,MAAM,CAAC,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC;IACrE,CAAC;IAED,gEAAgE;IACzD,MAAM,CAAC,KAA4B;QACxC,OAAO,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,CAAC,cAAc,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;eAClI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;eACtH,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC;eACtG,IAAI,CAAC,SAAS,CAAC,IAAI,KAAK,KAAK,CAAC,SAAS,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,KAAK,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC;IACpG,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAAiC;;QAC5C,IAAI,SAAS,KAAK,YAAY;YAC5B,OAAO,IAAI,CAAC;QAEd,MAAM,KAAK,GAAG;YACZ,UAAU,EAAE,MAAA,YAAY,CAAC,UAAU,mCAAI,IAAI,CAAC,UAAU;YACtD,YAAY,EAAE,MAAA,YAAY,CAAC,YAAY,mCAAI,IAAI,CAAC,YAAY;YAC5D,cAAc,EAAE,MAAA,YAAY,CAAC,cAAc,mCAAI,IAAI,CAAC,cAAc;YAClE,SAAS,EAAE,MAAA,YAAY,CAAC,SAAS,mCAAI,IAAI,CAAC,SAAS;YACnD,YAAY,EAAE,MAAA,YAAY,CAAC,YAAY,mCAAI,CAAC,IAAI,CAAC,UAAU;YAC3D,YAAY,EAAE,MAAA,YAAY,CAAC,YAAY,mCAAI,IAAI,CAAC,YAAY;YAC5D,eAAe,EAAE,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE;YACjJ,cAAc,EAAE,YAAY,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE;YAC5I,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI;YACjC,YAAY,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE;SAC/C,CAAC;QAEF,OAAO,qBAAqB,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IACzD,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module DisplayStyles\n */\n\nimport { BackgroundMapProvider, BackgroundMapType } from \"./BackgroundMapProvider\";\nimport { PlanarClipMaskProps, PlanarClipMaskSettings } from \"./PlanarClipMask\";\nimport { TerrainProps, TerrainSettings } from \"./TerrainSettings\";\n\n/** Describes the projection of the background map\n * @see [[BackgroundMapProps]]\n * @see [[DisplayStyleSettingsProps]]\n * @public\n * @extensions\n */\nexport enum GlobeMode {\n  /** Display Earth as 3d ellipsoid */\n  Ellipsoid = 0,\n  /** Display Earth as plane. */\n  Plane = 1,\n}\n\n/** In-memory JSON representation of a [[BackgroundMapSettings]].\n * @see [[PersistentBackgroundMapProps]] for the persistent JSON representation.\n * @public\n * @extensions\n */\nexport interface BackgroundMapProps {\n  /** The elevation of the map in meters relative the WGS84 ellipsoid. Default value: 0. */\n  groundBias?: number;\n  /** A transparency value from 0.0 (fully opaque) to 1.0 (fully transparent) to apply to map graphics when drawing, or false to indicate the transparency should not be overridden.\n   * Default value: false.\n   */\n  transparency?: number | false;\n  /** If set to true, the map tiles will be rendered with depth, allowing them to obscure other geometry. Otherwise, they are always rendered behind all other geometry. Default value: false. */\n  useDepthBuffer?: boolean;\n  /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */\n  applyTerrain?: boolean;\n  /** Properties associated with terrain display. */\n  terrainSettings?: TerrainProps;\n  /** Globe Mode. Default value: GlobeMode.Ellipsoid */\n  globeMode?: GlobeMode;\n  /** If true, the map will be treated as non-locatable - i.e., tools will not interact with it. This is particularly useful when the map is transparent - it\n   * allows the user to select elements that are behind the map.\n   */\n  nonLocatable?: boolean;\n  /** A planar mask applied to the map geometry\n   * @beta\n   */\n  planarClipMask?: PlanarClipMaskProps;\n\n  /** See [[DeprecatedBackgroundMapProps.providerName]]. */\n  providerName?: never;\n  /** See [[DeprecatedBackgroundMapProps.providerData]]. */\n  providerData?: never;\n}\n\n/** Properties of [[PersistentBackgroundMapProps]] that have been deprecated, but are retained for backwards compatibility.\n * These properties are omitted from [[BackgroundMapProps]] as they are no longer part of the API, but are included in\n * [[PersistentBackgroundMapProps]] because they remain part of the persistence format.\n * @public\n * @extensions\n */\nexport interface DeprecatedBackgroundMapProps {\n  /** Identifies the source of the map tiles. Currently supported providers are \"BingProvider\" and \"MapBoxProvider\".\n   * Default value: \"BingProvider\"\n   * @deprecated use MapImageryProps.backgroundBase.\n   */\n  providerName?: string;\n  /** Options for customizing the tiles supplied by the provider. If undefined, default values of all members are used.\n   * @deprecated use MapImageryProps.backgroundBase\n   */\n  providerData?: {\n    /** The type of map graphics to request. Default value: BackgroundMapType.Hybrid. */\n    mapType?: BackgroundMapType;\n  };\n}\n\n/** Persistent JSON representation of a [[BackgroundMapSettings]].\n * @public\n * @extensions\n */\nexport type PersistentBackgroundMapProps = Omit<BackgroundMapProps, keyof DeprecatedBackgroundMapProps> & DeprecatedBackgroundMapProps;\n\nfunction normalizeGlobeMode(mode?: GlobeMode): GlobeMode {\n  return GlobeMode.Plane === mode ? mode : GlobeMode.Ellipsoid;\n}\n\nfunction normalizeTransparency(trans?: number | false): number | false {\n  if (\"number\" === typeof trans)\n    return Math.min(1, Math.max(0, trans));\n\n  return false;\n}\n\n/** As part of a [[DisplayStyleSettings]], controls aspects of how the background map is displayed.\n * @see [[DisplayStyleSettings.backgroundMap]] to query or change these settings for a display style.\n * @see [[MapImagerySettings]] to control the type of imagery applied to the background map.\n * @public\n */\nexport class BackgroundMapSettings {\n  /** Retained strictly for persistence. */\n  private readonly _provider: BackgroundMapProvider;\n\n  /** Elevation in meters, relative to WGS84 Ellipsoid.. */\n  public readonly groundBias: number;\n  /** A transparency value from 0.0 (fully opaque) to 1.0 (fully transparent) to apply to map graphics when drawing, or false to indicate the transparency should not be overridden. Default value: false. */\n  public readonly transparency: number | false;\n  /** If set to true, the map tiles will be rendered with depth, allowing them to obscure other geometry. Otherwise, they are always rendered behind all other geometry. Default value: false. */\n  public readonly useDepthBuffer: boolean;\n  /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */\n  public readonly applyTerrain: boolean;\n  /** Settings associated with terrain display. */\n  public readonly terrainSettings: TerrainSettings;\n  /** Globe display mode. */\n  public readonly globeMode: GlobeMode;\n  /** Planar Mask - used to mask the background map to avoid overlapping with other geometry\n   * @beta\n   */\n  public readonly planarClipMask: PlanarClipMaskSettings;\n  private readonly _locatable: boolean;\n  /** If false, the map will be treated as non-locatable - i.e., tools will not interact with it. This is particularly useful when the map is transparent - it\n   * allows the user to select elements that are behind the map.\n   */\n  public get locatable(): boolean {\n    // Handle legacy TerrainProps.nonLocatable:\n    // - If TerrainProps.nonLocatable=true and terrain is on, terrain is not locatable.\n    // - Otherwise, use BackgroundMapProps.nonLocatable.\n    if (this.applyTerrain && this.terrainSettings.nonLocatable)\n      return false;\n\n    return this._locatable;\n  }\n\n  /** If transparency is overridden, the transparency to apply; otherwise, undefined. */\n  public get transparencyOverride(): number | undefined { return false !== this.transparency ? this.transparency : undefined; }\n\n  private constructor(props: BackgroundMapProps | PersistentBackgroundMapProps) {\n    this.groundBias = props.groundBias ?? 0;\n    this.transparency = normalizeTransparency(props.transparency);\n    this.useDepthBuffer = props.useDepthBuffer ?? false;\n    this.applyTerrain = props.applyTerrain ?? false;\n    this.terrainSettings = TerrainSettings.fromJSON(props.terrainSettings);\n    this.globeMode = normalizeGlobeMode(props.globeMode);\n    this._locatable = true !== props.nonLocatable;\n    this.planarClipMask = PlanarClipMaskSettings.fromJSON(props.planarClipMask);\n    this._provider = BackgroundMapProvider.fromBackgroundMapProps(props);\n  }\n\n  /** Create settings from their persistent representation. In general, this method should only be used when reading the settings directly from\n   * the iModel - otherwise, prefer [[fromJSON]].\n   */\n  public static fromPersistentJSON(json?: PersistentBackgroundMapProps): BackgroundMapSettings {\n    return new this(json ?? {});\n  }\n\n  /** Construct from JSON, performing validation and applying default values for undefined fields.\n   * @see [[fromPersistentJSON]] if you are reading the settings directly from the iModel.\n   */\n  public static fromJSON(json?: BackgroundMapProps): BackgroundMapSettings {\n    return new BackgroundMapSettings(json ?? {});\n  }\n\n  /** Convert these settings to their in-memory JSON representation.\n   * @see [[toPersistentJSON]] if you intend to write the JSON directly to an iModel.\n   */\n  public toJSON(): BackgroundMapProps {\n    const props: BackgroundMapProps = {};\n    if (0 !== this.groundBias)\n      props.groundBias = this.groundBias;\n    if (this.applyTerrain)\n      props.applyTerrain = true;\n    if (false !== this.transparency)\n      props.transparency = this.transparency;\n    if (GlobeMode.Ellipsoid !== this.globeMode)\n      props.globeMode = this.globeMode;\n    if (this.useDepthBuffer)\n      props.useDepthBuffer = true;\n    if (!this._locatable)\n      props.nonLocatable = true;\n\n    const terrainSettings = this.terrainSettings.toJSON();\n    for (const prop of Object.values(terrainSettings)) {\n      if (undefined !== prop) {\n        props.terrainSettings = terrainSettings;\n        break;\n      }\n    }\n\n    if (this.planarClipMask.isValid)\n      props.planarClipMask = this.planarClipMask.toJSON();\n\n    return props;\n  }\n\n  /** Convert these settings to their persistent representation. In general, this method should only be used when writing the settings directly to\n   * the iModel - otherwise, prefer [[toJSON]].\n   */\n  public toPersistentJSON(): PersistentBackgroundMapProps {\n    const props = this.toJSON() as PersistentBackgroundMapProps;\n\n    // Preserve deprecated imagery provider properties.\n    if (\"BingProvider\" !== this._provider.name)\n      props.providerName = this._provider.name; // eslint-disable-line deprecation/deprecation\n    if (BackgroundMapType.Hybrid !== this._provider.type)\n      props.providerData = { mapType: this._provider.type }; // eslint-disable-line deprecation/deprecation\n\n    return props;\n  }\n\n  /** Returns true if these settings are equivalent to the supplied JSON settings. */\n  public equalsJSON(json?: BackgroundMapProps): boolean {\n    return this.equals(BackgroundMapSettings.fromJSON(json));\n  }\n\n  /** Returns true if the persistent representation of these settings is equivalent to `json`. */\n  public equalsPersistentJSON(json?: PersistentBackgroundMapProps): boolean {\n    return this.equals(BackgroundMapSettings.fromPersistentJSON(json));\n  }\n\n  /** Returns true if these settings are equivalent to `other`. */\n  public equals(other: BackgroundMapSettings): boolean {\n    return this.groundBias === other.groundBias && this.useDepthBuffer === other.useDepthBuffer && this.transparency === other.transparency\n      && this.globeMode === other.globeMode && this._locatable === other._locatable && this.applyTerrain === other.applyTerrain\n      && this.terrainSettings.equals(other.terrainSettings) && this.planarClipMask.equals(other.planarClipMask)\n      && this._provider.name === other._provider.name && this._provider.type === other._provider.type;\n  }\n\n  /** Create a copy of this BackgroundMapSettings, optionally modifying some of its properties.\n   * @param changedProps JSON representation of the properties to change.\n   * @returns A BackgroundMapSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.\n   */\n  public clone(changedProps?: BackgroundMapProps): BackgroundMapSettings {\n    if (undefined === changedProps)\n      return this;\n\n    const props = {\n      groundBias: changedProps.groundBias ?? this.groundBias,\n      transparency: changedProps.transparency ?? this.transparency,\n      useDepthBuffer: changedProps.useDepthBuffer ?? this.useDepthBuffer,\n      globeMode: changedProps.globeMode ?? this.globeMode,\n      nonLocatable: changedProps.nonLocatable ?? !this._locatable,\n      applyTerrain: changedProps.applyTerrain ?? this.applyTerrain,\n      terrainSettings: changedProps.terrainSettings ? this.terrainSettings.clone(changedProps.terrainSettings).toJSON() : this.terrainSettings.toJSON(),\n      planarClipMask: changedProps.planarClipMask ? this.planarClipMask.clone(changedProps.planarClipMask).toJSON() : this.planarClipMask.toJSON(),\n      providerName: this._provider.name,\n      providerData: { mapType: this._provider.type },\n    };\n\n    return BackgroundMapSettings.fromPersistentJSON(props);\n  }\n}\n"]}

package/lib/esm/Base64EncodedString.d.ts

@@ -1,31 +1,31 @@
-/** @packageDocumentation
- * @module Entities
- */
-/** Represents an array of bytes encoded in base-64 with a prefix indicating the encoding, as required when converting EC properties of `binary` type to and from JSON.
- * @see [[TextureProps.data]] and [[BRepEntity.DataProps.data]] for examples of properties of this type.
- * @public
- * @extensions
- */
-export declare type Base64EncodedString = string;
-/** Represents an array of bytes encoded in base-64 with a prefix indicating the encoding, as persisted in an [ECDb]($backend) for properties of `binary` type.
- * @public
- */
-export declare namespace Base64EncodedString {
-    /** The prefix prepended to the string identifying it as base-64-encoded. */
-    const prefix = "encoding=base64;";
-    /** Encode an array of bytes into a Base64EncodedString. */
-    function fromUint8Array(bytes: Uint8Array): Base64EncodedString;
-    /** Decode a Base64EncodedString into an array of bytes. */
-    function toUint8Array(base64: Base64EncodedString): Uint8Array;
-    /** Returns true if the input starts with [[Base64EncodedString.prefix]] indicating it is a well-formed Base64EncodedString. */
-    function hasPrefix(str: string): boolean;
-    /** Ensure that the base-64-encoded string starts with the [[Base64EncodedString.prefix]]. */
-    function ensurePrefix(base64: string): Base64EncodedString;
-    /** Remove the [[Base64EncodedString.prefix]] from the string if present. */
-    function stripPrefix(base64: Base64EncodedString): string;
-    /** A function suitable for use with `JSON.parse` to revive a Base64EncodedString into a Uint8Array. */
-    const reviver: (_name: string, value: any) => any;
-    /** A function suitable for use with `JSON.stringify` to serialize a Uint8Array as a Base64EncodedString. */
-    const replacer: (_name: string, value: any) => any;
-}
+/** @packageDocumentation
+ * @module Entities
+ */
+/** Represents an array of bytes encoded in base-64 with a prefix indicating the encoding, as required when converting EC properties of `binary` type to and from JSON.
+ * @see [[TextureProps.data]] and [[BRepEntity.DataProps.data]] for examples of properties of this type.
+ * @public
+ * @extensions
+ */
+export declare type Base64EncodedString = string;
+/** Represents an array of bytes encoded in base-64 with a prefix indicating the encoding, as persisted in an [ECDb]($backend) for properties of `binary` type.
+ * @public
+ */
+export declare namespace Base64EncodedString {
+    /** The prefix prepended to the string identifying it as base-64-encoded. */
+    const prefix = "encoding=base64;";
+    /** Encode an array of bytes into a Base64EncodedString. */
+    function fromUint8Array(bytes: Uint8Array): Base64EncodedString;
+    /** Decode a Base64EncodedString into an array of bytes. */
+    function toUint8Array(base64: Base64EncodedString): Uint8Array;
+    /** Returns true if the input starts with [[Base64EncodedString.prefix]] indicating it is a well-formed Base64EncodedString. */
+    function hasPrefix(str: string): boolean;
+    /** Ensure that the base-64-encoded string starts with the [[Base64EncodedString.prefix]]. */
+    function ensurePrefix(base64: string): Base64EncodedString;
+    /** Remove the [[Base64EncodedString.prefix]] from the string if present. */
+    function stripPrefix(base64: Base64EncodedString): string;
+    /** A function suitable for use with `JSON.parse` to revive a Base64EncodedString into a Uint8Array. */
+    const reviver: (_name: string, value: any) => any;
+    /** A function suitable for use with `JSON.stringify` to serialize a Uint8Array as a Base64EncodedString. */
+    const replacer: (_name: string, value: any) => any;
+}
 //# sourceMappingURL=Base64EncodedString.d.ts.map

package/lib/esm/Base64EncodedString.js

@@ -1,54 +1,54 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Entities
- */
-import { Base64 } from "js-base64";
-/** Represents an array of bytes encoded in base-64 with a prefix indicating the encoding, as persisted in an [ECDb]($backend) for properties of `binary` type.
- * @public
- */
-export var Base64EncodedString;
-(function (Base64EncodedString) {
-    /** The prefix prepended to the string identifying it as base-64-encoded. */
-    Base64EncodedString.prefix = "encoding=base64;";
-    /** Encode an array of bytes into a Base64EncodedString. */
-    function fromUint8Array(bytes) {
-        return `${Base64EncodedString.prefix}${Base64.fromUint8Array(bytes)}`;
-    }
-    Base64EncodedString.fromUint8Array = fromUint8Array;
-    /** Decode a Base64EncodedString into an array of bytes. */
-    function toUint8Array(base64) {
-        return Base64.toUint8Array(stripPrefix(base64));
-    }
-    Base64EncodedString.toUint8Array = toUint8Array;
-    /** Returns true if the input starts with [[Base64EncodedString.prefix]] indicating it is a well-formed Base64EncodedString. */
-    function hasPrefix(str) {
-        return str.startsWith(Base64EncodedString.prefix);
-    }
-    Base64EncodedString.hasPrefix = hasPrefix;
-    /** Ensure that the base-64-encoded string starts with the [[Base64EncodedString.prefix]]. */
-    function ensurePrefix(base64) {
-        return hasPrefix(base64) ? base64 : `${Base64EncodedString.prefix}${base64}`;
-    }
-    Base64EncodedString.ensurePrefix = ensurePrefix;
-    /** Remove the [[Base64EncodedString.prefix]] from the string if present. */
-    function stripPrefix(base64) {
-        return hasPrefix(base64) ? base64.substr(Base64EncodedString.prefix.length) : base64;
-    }
-    Base64EncodedString.stripPrefix = stripPrefix;
-    /** A function suitable for use with `JSON.parse` to revive a Base64EncodedString into a Uint8Array. */
-    Base64EncodedString.reviver = (_name, value) => {
-        if (typeof value === "string" && hasPrefix(value))
-            value = toUint8Array(value);
-        return value;
-    };
-    /** A function suitable for use with `JSON.stringify` to serialize a Uint8Array as a Base64EncodedString. */
-    Base64EncodedString.replacer = (_name, value) => {
-        if (value && value.constructor === Uint8Array)
-            value = fromUint8Array(value);
-        return value;
-    };
-})(Base64EncodedString || (Base64EncodedString = {}));
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Entities
+ */
+import { Base64 } from "js-base64";
+/** Represents an array of bytes encoded in base-64 with a prefix indicating the encoding, as persisted in an [ECDb]($backend) for properties of `binary` type.
+ * @public
+ */
+export var Base64EncodedString;
+(function (Base64EncodedString) {
+    /** The prefix prepended to the string identifying it as base-64-encoded. */
+    Base64EncodedString.prefix = "encoding=base64;";
+    /** Encode an array of bytes into a Base64EncodedString. */
+    function fromUint8Array(bytes) {
+        return `${Base64EncodedString.prefix}${Base64.fromUint8Array(bytes)}`;
+    }
+    Base64EncodedString.fromUint8Array = fromUint8Array;
+    /** Decode a Base64EncodedString into an array of bytes. */
+    function toUint8Array(base64) {
+        return Base64.toUint8Array(stripPrefix(base64));
+    }
+    Base64EncodedString.toUint8Array = toUint8Array;
+    /** Returns true if the input starts with [[Base64EncodedString.prefix]] indicating it is a well-formed Base64EncodedString. */
+    function hasPrefix(str) {
+        return str.startsWith(Base64EncodedString.prefix);
+    }
+    Base64EncodedString.hasPrefix = hasPrefix;
+    /** Ensure that the base-64-encoded string starts with the [[Base64EncodedString.prefix]]. */
+    function ensurePrefix(base64) {
+        return hasPrefix(base64) ? base64 : `${Base64EncodedString.prefix}${base64}`;
+    }
+    Base64EncodedString.ensurePrefix = ensurePrefix;
+    /** Remove the [[Base64EncodedString.prefix]] from the string if present. */
+    function stripPrefix(base64) {
+        return hasPrefix(base64) ? base64.substr(Base64EncodedString.prefix.length) : base64;
+    }
+    Base64EncodedString.stripPrefix = stripPrefix;
+    /** A function suitable for use with `JSON.parse` to revive a Base64EncodedString into a Uint8Array. */
+    Base64EncodedString.reviver = (_name, value) => {
+        if (typeof value === "string" && hasPrefix(value))
+            value = toUint8Array(value);
+        return value;
+    };
+    /** A function suitable for use with `JSON.stringify` to serialize a Uint8Array as a Base64EncodedString. */
+    Base64EncodedString.replacer = (_name, value) => {
+        if (value && value.constructor === Uint8Array)
+            value = fromUint8Array(value);
+        return value;
+    };
+})(Base64EncodedString || (Base64EncodedString = {}));
 //# sourceMappingURL=Base64EncodedString.js.map

package/lib/esm/Base64EncodedString.js.map

@@ -1 +1 @@
-{"version":3,"file":"Base64EncodedString.js","sourceRoot":"","sources":["../../src/Base64EncodedString.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AASnC;;GAEG;AACH,MAAM,KAAW,mBAAmB,CA4CnC;AA5CD,WAAiB,mBAAmB;IAClC,4EAA4E;IAC/D,0BAAM,GAAG,kBAAkB,CAAC;IAEzC,2DAA2D;IAC3D,SAAgB,cAAc,CAAC,KAAiB;QAC9C,OAAO,GAAG,oBAAA,MAAM,GAAG,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;IACpD,CAAC;IAFe,kCAAc,iBAE7B,CAAA;IAED,2DAA2D;IAC3D,SAAgB,YAAY,CAAC,MAA2B;QACtD,OAAO,MAAM,CAAC,YAAY,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;IAClD,CAAC;IAFe,gCAAY,eAE3B,CAAA;IAED,+HAA+H;IAC/H,SAAgB,SAAS,CAAC,GAAW;QACnC,OAAO,GAAG,CAAC,UAAU,CAAC,oBAAA,MAAM,CAAC,CAAC;IAChC,CAAC;IAFe,6BAAS,YAExB,CAAA;IAED,6FAA6F;IAC7F,SAAgB,YAAY,CAAC,MAAc;QACzC,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,oBAAA,MAAM,GAAG,MAAM,EAAE,CAAC;IAC3D,CAAC;IAFe,gCAAY,eAE3B,CAAA;IAED,4EAA4E;IAC5E,SAAgB,WAAW,CAAC,MAA2B;QACrD,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,oBAAA,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;IACnE,CAAC;IAFe,+BAAW,cAE1B,CAAA;IAED,uGAAuG;IAC1F,2BAAO,GAAG,CAAC,KAAa,EAAE,KAAU,EAAO,EAAE;QACxD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,SAAS,CAAC,KAAK,CAAC;YAC/C,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;QAE9B,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IAEF,4GAA4G;IAC/F,4BAAQ,GAAG,CAAC,KAAa,EAAE,KAAU,EAAO,EAAE;QACzD,IAAI,KAAK,IAAI,KAAK,CAAC,WAAW,KAAK,UAAU;YAC3C,KAAK,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC;QAEhC,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;AACJ,CAAC,EA5CgB,mBAAmB,KAAnB,mBAAmB,QA4CnC","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 Entities\r\n */\r\n\r\nimport { Base64 } from \"js-base64\";\r\n\r\n/** Represents an array of bytes encoded in base-64 with a prefix indicating the encoding, as required when converting EC properties of `binary` type to and from JSON.\r\n * @see [[TextureProps.data]] and [[BRepEntity.DataProps.data]] for examples of properties of this type.\r\n * @public\r\n * @extensions\r\n */\r\nexport type Base64EncodedString = string;\r\n\r\n/** Represents an array of bytes encoded in base-64 with a prefix indicating the encoding, as persisted in an [ECDb]($backend) for properties of `binary` type.\r\n * @public\r\n */\r\nexport namespace Base64EncodedString { // eslint-disable-line @typescript-eslint/no-redeclare\r\n  /** The prefix prepended to the string identifying it as base-64-encoded. */\r\n  export const prefix = \"encoding=base64;\";\r\n\r\n  /** Encode an array of bytes into a Base64EncodedString. */\r\n  export function fromUint8Array(bytes: Uint8Array): Base64EncodedString {\r\n    return `${prefix}${Base64.fromUint8Array(bytes)}`;\r\n  }\r\n\r\n  /** Decode a Base64EncodedString into an array of bytes. */\r\n  export function toUint8Array(base64: Base64EncodedString): Uint8Array {\r\n    return Base64.toUint8Array(stripPrefix(base64));\r\n  }\r\n\r\n  /** Returns true if the input starts with [[Base64EncodedString.prefix]] indicating it is a well-formed Base64EncodedString. */\r\n  export function hasPrefix(str: string): boolean {\r\n    return str.startsWith(prefix);\r\n  }\r\n\r\n  /** Ensure that the base-64-encoded string starts with the [[Base64EncodedString.prefix]]. */\r\n  export function ensurePrefix(base64: string): Base64EncodedString {\r\n    return hasPrefix(base64) ? base64 : `${prefix}${base64}`;\r\n  }\r\n\r\n  /** Remove the [[Base64EncodedString.prefix]] from the string if present. */\r\n  export function stripPrefix(base64: Base64EncodedString): string {\r\n    return hasPrefix(base64) ? base64.substr(prefix.length) : base64;\r\n  }\r\n\r\n  /** A function suitable for use with `JSON.parse` to revive a Base64EncodedString into a Uint8Array. */\r\n  export const reviver = (_name: string, value: any): any => {\r\n    if (typeof value === \"string\" && hasPrefix(value))\r\n      value = toUint8Array(value);\r\n\r\n    return value;\r\n  };\r\n\r\n  /** A function suitable for use with `JSON.stringify` to serialize a Uint8Array as a Base64EncodedString. */\r\n  export const replacer = (_name: string, value: any): any => {\r\n    if (value && value.constructor === Uint8Array)\r\n      value = fromUint8Array(value);\r\n\r\n    return value;\r\n  };\r\n}\r\n"]}
+{"version":3,"file":"Base64EncodedString.js","sourceRoot":"","sources":["../../src/Base64EncodedString.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AASnC;;GAEG;AACH,MAAM,KAAW,mBAAmB,CA4CnC;AA5CD,WAAiB,mBAAmB;IAClC,4EAA4E;IAC/D,0BAAM,GAAG,kBAAkB,CAAC;IAEzC,2DAA2D;IAC3D,SAAgB,cAAc,CAAC,KAAiB;QAC9C,OAAO,GAAG,oBAAA,MAAM,GAAG,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;IACpD,CAAC;IAFe,kCAAc,iBAE7B,CAAA;IAED,2DAA2D;IAC3D,SAAgB,YAAY,CAAC,MAA2B;QACtD,OAAO,MAAM,CAAC,YAAY,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;IAClD,CAAC;IAFe,gCAAY,eAE3B,CAAA;IAED,+HAA+H;IAC/H,SAAgB,SAAS,CAAC,GAAW;QACnC,OAAO,GAAG,CAAC,UAAU,CAAC,oBAAA,MAAM,CAAC,CAAC;IAChC,CAAC;IAFe,6BAAS,YAExB,CAAA;IAED,6FAA6F;IAC7F,SAAgB,YAAY,CAAC,MAAc;QACzC,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,oBAAA,MAAM,GAAG,MAAM,EAAE,CAAC;IAC3D,CAAC;IAFe,gCAAY,eAE3B,CAAA;IAED,4EAA4E;IAC5E,SAAgB,WAAW,CAAC,MAA2B;QACrD,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,oBAAA,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;IACnE,CAAC;IAFe,+BAAW,cAE1B,CAAA;IAED,uGAAuG;IAC1F,2BAAO,GAAG,CAAC,KAAa,EAAE,KAAU,EAAO,EAAE;QACxD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,SAAS,CAAC,KAAK,CAAC;YAC/C,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;QAE9B,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IAEF,4GAA4G;IAC/F,4BAAQ,GAAG,CAAC,KAAa,EAAE,KAAU,EAAO,EAAE;QACzD,IAAI,KAAK,IAAI,KAAK,CAAC,WAAW,KAAK,UAAU;YAC3C,KAAK,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC;QAEhC,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;AACJ,CAAC,EA5CgB,mBAAmB,KAAnB,mBAAmB,QA4CnC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Entities\n */\n\nimport { Base64 } from \"js-base64\";\n\n/** Represents an array of bytes encoded in base-64 with a prefix indicating the encoding, as required when converting EC properties of `binary` type to and from JSON.\n * @see [[TextureProps.data]] and [[BRepEntity.DataProps.data]] for examples of properties of this type.\n * @public\n * @extensions\n */\nexport type Base64EncodedString = string;\n\n/** Represents an array of bytes encoded in base-64 with a prefix indicating the encoding, as persisted in an [ECDb]($backend) for properties of `binary` type.\n * @public\n */\nexport namespace Base64EncodedString { // eslint-disable-line @typescript-eslint/no-redeclare\n  /** The prefix prepended to the string identifying it as base-64-encoded. */\n  export const prefix = \"encoding=base64;\";\n\n  /** Encode an array of bytes into a Base64EncodedString. */\n  export function fromUint8Array(bytes: Uint8Array): Base64EncodedString {\n    return `${prefix}${Base64.fromUint8Array(bytes)}`;\n  }\n\n  /** Decode a Base64EncodedString into an array of bytes. */\n  export function toUint8Array(base64: Base64EncodedString): Uint8Array {\n    return Base64.toUint8Array(stripPrefix(base64));\n  }\n\n  /** Returns true if the input starts with [[Base64EncodedString.prefix]] indicating it is a well-formed Base64EncodedString. */\n  export function hasPrefix(str: string): boolean {\n    return str.startsWith(prefix);\n  }\n\n  /** Ensure that the base-64-encoded string starts with the [[Base64EncodedString.prefix]]. */\n  export function ensurePrefix(base64: string): Base64EncodedString {\n    return hasPrefix(base64) ? base64 : `${prefix}${base64}`;\n  }\n\n  /** Remove the [[Base64EncodedString.prefix]] from the string if present. */\n  export function stripPrefix(base64: Base64EncodedString): string {\n    return hasPrefix(base64) ? base64.substr(prefix.length) : base64;\n  }\n\n  /** A function suitable for use with `JSON.parse` to revive a Base64EncodedString into a Uint8Array. */\n  export const reviver = (_name: string, value: any): any => {\n    if (typeof value === \"string\" && hasPrefix(value))\n      value = toUint8Array(value);\n\n    return value;\n  };\n\n  /** A function suitable for use with `JSON.stringify` to serialize a Uint8Array as a Base64EncodedString. */\n  export const replacer = (_name: string, value: any): any => {\n    if (value && value.constructor === Uint8Array)\n      value = fromUint8Array(value);\n\n    return value;\n  };\n}\n"]}

package/lib/esm/BlobReader.d.ts

@@ -1,32 +1,32 @@
-/** @packageDocumentation
- * @module iModels
- */
-import { Id64String } from "@itwin/core-bentley";
-import { BlobOptions, BlobRange, DbBlobRequest, DbBlobResponse, DbRequestExecutor } from "./ConcurrentQuery";
-/** @beta */
-export declare class Uint8Chunks implements Iterable<Uint8Array> {
-    private _chunks;
-    append(chunk: Uint8Array): void;
-    at(idx: number): Uint8Array;
-    get length(): number;
-    [Symbol.iterator](): Iterator<Uint8Array, any, undefined>;
-    combine(): Uint8Array;
-}
-/** @beta */
-export declare class BlobReader {
-    private _executor;
-    readonly className: string;
-    readonly accessString: string;
-    readonly instanceId: Id64String;
-    private _chunks;
-    private _lengthToRead;
-    private _options;
-    constructor(_executor: DbRequestExecutor<DbBlobRequest, DbBlobResponse>, className: string, accessString: string, instanceId: Id64String, options?: BlobOptions);
-    reset(options?: BlobOptions): void;
-    get range(): BlobRange;
-    step(): Promise<boolean>;
-    readToEnd(): Promise<Uint8Array>;
-    get current(): Uint8Array;
-    get chunks(): Uint8Chunks;
-}
+/** @packageDocumentation
+ * @module iModels
+ */
+import { Id64String } from "@itwin/core-bentley";
+import { BlobOptions, BlobRange, DbBlobRequest, DbBlobResponse, DbRequestExecutor } from "./ConcurrentQuery";
+/** @beta */
+export declare class Uint8Chunks implements Iterable<Uint8Array> {
+    private _chunks;
+    append(chunk: Uint8Array): void;
+    at(idx: number): Uint8Array;
+    get length(): number;
+    [Symbol.iterator](): Iterator<Uint8Array, any, undefined>;
+    combine(): Uint8Array;
+}
+/** @beta */
+export declare class BlobReader {
+    private _executor;
+    readonly className: string;
+    readonly accessString: string;
+    readonly instanceId: Id64String;
+    private _chunks;
+    private _lengthToRead;
+    private _options;
+    constructor(_executor: DbRequestExecutor<DbBlobRequest, DbBlobResponse>, className: string, accessString: string, instanceId: Id64String, options?: BlobOptions);
+    reset(options?: BlobOptions): void;
+    get range(): BlobRange;
+    step(): Promise<boolean>;
+    readToEnd(): Promise<Uint8Array>;
+    get current(): Uint8Array;
+    get chunks(): Uint8Chunks;
+}
 //# sourceMappingURL=BlobReader.d.ts.map

package/lib/esm/BlobReader.js

@@ -1,80 +1,80 @@
-import { BlobOptionsBuilder, DbQueryError, DbRequestKind, } from "./ConcurrentQuery";
-/** @beta */
-export class Uint8Chunks {
-    constructor() {
-        this._chunks = [];
-    }
-    append(chunk) {
-        this._chunks.push(chunk);
-    }
-    at(idx) { return this._chunks[idx]; }
-    get length() { return this._chunks.length; }
-    [Symbol.iterator]() {
-        return this._chunks[Symbol.iterator];
-    }
-    combine() {
-        const totalChunkLength = this._chunks.reduce((acc, v) => acc + v.length, 0);
-        const combineChunk = new Uint8Array(totalChunkLength);
-        let offset = 0;
-        for (const array of this._chunks) {
-            combineChunk.set(array, offset);
-            offset += array.length;
-        }
-        return combineChunk;
-    }
-}
-/** @beta */
-export class BlobReader {
-    constructor(_executor, className, accessString, instanceId, options) {
-        this._executor = _executor;
-        this.className = className;
-        this.accessString = accessString;
-        this.instanceId = instanceId;
-        this._chunks = new Uint8Chunks();
-        this._lengthToRead = -1;
-        this._options = new BlobOptionsBuilder().getOptions();
-        this.reset(options);
-    }
-    reset(options) {
-        if (options) {
-            this._options = options;
-        }
-        this._chunks = new Uint8Chunks();
-        this._lengthToRead = this.range.count;
-    }
-    get range() { return this._options.range; }
-    async step() {
-        if (this._lengthToRead === this._chunks.length) {
-            return false;
-        }
-        const request = {
-            kind: DbRequestKind.BlobIO,
-            className: this.className,
-            accessString: this.accessString,
-            instanceId: this.instanceId,
-            ...this._options,
-        };
-        request.range = { offset: this._chunks.length, count: this.range ? this._lengthToRead - this._chunks.length : 0 };
-        const resp = await this._executor.execute(request);
-        DbQueryError.throwIfError(resp, request);
-        if (this._lengthToRead === -1) {
-            this._lengthToRead = resp.rawBlobSize;
-        }
-        if (resp.data && resp.data.length > 0) {
-            this._chunks.append(resp.data);
-        }
-        return true;
-    }
-    async readToEnd() {
-        while (await this.step()) { }
-        return this._chunks.combine();
-    }
-    get current() {
-        if (this._chunks.length === 0) {
-            throw new Error("there is no current buffer");
-        }
-        return this._chunks.at(this._chunks.length);
-    }
-    get chunks() { return this._chunks; }
-}
+import { BlobOptionsBuilder, DbQueryError, DbRequestKind, } from "./ConcurrentQuery";
+/** @beta */
+export class Uint8Chunks {
+    constructor() {
+        this._chunks = [];
+    }
+    append(chunk) {
+        this._chunks.push(chunk);
+    }
+    at(idx) { return this._chunks[idx]; }
+    get length() { return this._chunks.length; }
+    [Symbol.iterator]() {
+        return this._chunks[Symbol.iterator];
+    }
+    combine() {
+        const totalChunkLength = this._chunks.reduce((acc, v) => acc + v.length, 0);
+        const combineChunk = new Uint8Array(totalChunkLength);
+        let offset = 0;
+        for (const array of this._chunks) {
+            combineChunk.set(array, offset);
+            offset += array.length;
+        }
+        return combineChunk;
+    }
+}
+/** @beta */
+export class BlobReader {
+    constructor(_executor, className, accessString, instanceId, options) {
+        this._executor = _executor;
+        this.className = className;
+        this.accessString = accessString;
+        this.instanceId = instanceId;
+        this._chunks = new Uint8Chunks();
+        this._lengthToRead = -1;
+        this._options = new BlobOptionsBuilder().getOptions();
+        this.reset(options);
+    }
+    reset(options) {
+        if (options) {
+            this._options = options;
+        }
+        this._chunks = new Uint8Chunks();
+        this._lengthToRead = this.range.count;
+    }
+    get range() { return this._options.range; }
+    async step() {
+        if (this._lengthToRead === this._chunks.length) {
+            return false;
+        }
+        const request = {
+            kind: DbRequestKind.BlobIO,
+            className: this.className,
+            accessString: this.accessString,
+            instanceId: this.instanceId,
+            ...this._options,
+        };
+        request.range = { offset: this._chunks.length, count: this.range ? this._lengthToRead - this._chunks.length : 0 };
+        const resp = await this._executor.execute(request);
+        DbQueryError.throwIfError(resp, request);
+        if (this._lengthToRead === -1) {
+            this._lengthToRead = resp.rawBlobSize;
+        }
+        if (resp.data && resp.data.length > 0) {
+            this._chunks.append(resp.data);
+        }
+        return true;
+    }
+    async readToEnd() {
+        while (await this.step()) { }
+        return this._chunks.combine();
+    }
+    get current() {
+        if (this._chunks.length === 0) {
+            throw new Error("there is no current buffer");
+        }
+        return this._chunks.at(this._chunks.length);
+    }
+    get chunks() { return this._chunks; }
+}
 //# sourceMappingURL=BlobReader.js.map

package/lib/esm/BlobReader.js.map

@@ -1 +1 @@
-{"version":3,"file":"BlobReader.js","sourceRoot":"","sources":["../../src/BlobReader.ts"],"names":[],"mappings":"AAQA,OAAO,EACQ,kBAAkB,EAA4C,YAAY,EAAqB,aAAa,GAC1H,MAAM,mBAAmB,CAAC;AAE3B,YAAY;AACZ,MAAM,OAAO,WAAW;IAAxB;QACU,YAAO,GAAiB,EAAE,CAAC;IAmBrC,CAAC;IAlBQ,MAAM,CAAC,KAAiB;QAC7B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IACM,EAAE,CAAC,GAAW,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACpD,IAAW,MAAM,KAAK,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IAC5C,CAAC,MAAM,CAAC,QAAQ,CAAC;QACtB,OAAQ,IAAI,CAAC,OAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IACM,OAAO;QACZ,MAAM,gBAAgB,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC5E,MAAM,YAAY,GAAG,IAAI,UAAU,CAAC,gBAAgB,CAAC,CAAC;QACtD,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,EAAE;YAChC,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC;SACxB;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;CACF;AACD,YAAY;AACZ,MAAM,OAAO,UAAU;IAIrB,YAA2B,SAA2D,EACpE,SAAiB,EACjB,YAAoB,EACpB,UAAsB,EACtC,OAAqB;QAJI,cAAS,GAAT,SAAS,CAAkD;QACpE,cAAS,GAAT,SAAS,CAAQ;QACjB,iBAAY,GAAZ,YAAY,CAAQ;QACpB,eAAU,GAAV,UAAU,CAAY;QANhC,YAAO,GAAG,IAAI,WAAW,EAAE,CAAC;QAC5B,kBAAa,GAAW,CAAC,CAAC,CAAC;QAC3B,aAAQ,GAAG,IAAI,kBAAkB,EAAE,CAAC,UAAU,EAAE,CAAC;QAMvD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACtB,CAAC;IACM,KAAK,CAAC,OAAqB;QAChC,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;SACzB;QACD,IAAI,CAAC,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;QACjC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,KAAM,CAAC;IACzC,CAAC;IACD,IAAW,KAAK,KAAgB,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAM,CAAC,CAAC,CAAC;IACvD,KAAK,CAAC,IAAI;QACf,IAAI,IAAI,CAAC,aAAa,KAAK,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;YAC9C,OAAO,KAAK,CAAC;SACd;QACD,MAAM,OAAO,GAAkB;YAC7B,IAAI,EAAE,aAAa,CAAC,MAAM;YAC1B,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,GAAG,IAAI,CAAC,QAAQ;SACjB,CAAC;QACF,OAAO,CAAC,KAAK,GAAG,EAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAC,CAAC;QAChH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACnD,YAAY,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAEzC,IAAI,IAAI,CAAC,aAAa,KAAK,CAAC,CAAC,EAAE;YAC7B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC;SACvC;QACD,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;YACrC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAChC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACM,KAAK,CAAC,SAAS;QACpB,OAAO,MAAM,IAAI,CAAC,IAAI,EAAE,EAAE,GAAG;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IAChC,CAAC;IACD,IAAW,OAAO;QAChB,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE;YAC7B,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;SAC/C;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9C,CAAC;IACD,IAAW,MAAM,KAAkB,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;CAC1D","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 iModels\r\n */\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\nimport {\r\n  BlobOptions, BlobOptionsBuilder, BlobRange, DbBlobRequest, DbBlobResponse, DbQueryError, DbRequestExecutor, DbRequestKind,\r\n} from \"./ConcurrentQuery\";\r\n\r\n/** @beta */\r\nexport class Uint8Chunks implements Iterable<Uint8Array> {\r\n  private _chunks: Uint8Array[] = [];\r\n  public append(chunk: Uint8Array) {\r\n    this._chunks.push(chunk);\r\n  }\r\n  public at(idx: number) { return this._chunks[idx]; }\r\n  public get length() { return this._chunks.length; }\r\n  public [Symbol.iterator](): Iterator<Uint8Array, any, undefined> {\r\n    return (this._chunks as any)[Symbol.iterator];\r\n  }\r\n  public combine(): Uint8Array {\r\n    const totalChunkLength = this._chunks.reduce((acc, v) => acc + v.length, 0);\r\n    const combineChunk = new Uint8Array(totalChunkLength);\r\n    let offset = 0;\r\n    for (const array of this._chunks) {\r\n      combineChunk.set(array, offset);\r\n      offset += array.length;\r\n    }\r\n    return combineChunk;\r\n  }\r\n}\r\n/** @beta */\r\nexport class BlobReader {\r\n  private _chunks = new Uint8Chunks();\r\n  private _lengthToRead: number = -1;\r\n  private _options = new BlobOptionsBuilder().getOptions();\r\n  public constructor(private _executor: DbRequestExecutor<DbBlobRequest, DbBlobResponse>,\r\n    public readonly className: string,\r\n    public readonly accessString: string,\r\n    public readonly instanceId: Id64String,\r\n    options?: BlobOptions) {\r\n    this.reset(options);\r\n  }\r\n  public reset(options?: BlobOptions) {\r\n    if (options) {\r\n      this._options = options;\r\n    }\r\n    this._chunks = new Uint8Chunks();\r\n    this._lengthToRead = this.range.count!;\r\n  }\r\n  public get range(): BlobRange { return this._options.range!; }\r\n  public async step(): Promise<boolean> {\r\n    if (this._lengthToRead === this._chunks.length) {\r\n      return false;\r\n    }\r\n    const request: DbBlobRequest = {\r\n      kind: DbRequestKind.BlobIO,\r\n      className: this.className,\r\n      accessString: this.accessString,\r\n      instanceId: this.instanceId,\r\n      ...this._options,\r\n    };\r\n    request.range = {offset: this._chunks.length, count: this.range ? this._lengthToRead - this._chunks.length : 0};\r\n    const resp = await this._executor.execute(request);\r\n    DbQueryError.throwIfError(resp, request);\r\n\r\n    if (this._lengthToRead === -1) {\r\n      this._lengthToRead = resp.rawBlobSize;\r\n    }\r\n    if (resp.data && resp.data.length > 0) {\r\n      this._chunks.append(resp.data);\r\n    }\r\n    return true;\r\n  }\r\n  public async readToEnd(): Promise<Uint8Array> {\r\n    while (await this.step()) { }\r\n    return this._chunks.combine();\r\n  }\r\n  public get current(): Uint8Array {\r\n    if (this._chunks.length === 0) {\r\n      throw new Error(\"there is no current buffer\");\r\n    }\r\n    return this._chunks.at(this._chunks.length);\r\n  }\r\n  public get chunks(): Uint8Chunks { return this._chunks; }\r\n}\r\n"]}
+{"version":3,"file":"BlobReader.js","sourceRoot":"","sources":["../../src/BlobReader.ts"],"names":[],"mappings":"AAQA,OAAO,EACQ,kBAAkB,EAA4C,YAAY,EAAqB,aAAa,GAC1H,MAAM,mBAAmB,CAAC;AAE3B,YAAY;AACZ,MAAM,OAAO,WAAW;IAAxB;QACU,YAAO,GAAiB,EAAE,CAAC;IAmBrC,CAAC;IAlBQ,MAAM,CAAC,KAAiB;QAC7B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IACM,EAAE,CAAC,GAAW,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACpD,IAAW,MAAM,KAAK,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IAC5C,CAAC,MAAM,CAAC,QAAQ,CAAC;QACtB,OAAQ,IAAI,CAAC,OAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IACM,OAAO;QACZ,MAAM,gBAAgB,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC5E,MAAM,YAAY,GAAG,IAAI,UAAU,CAAC,gBAAgB,CAAC,CAAC;QACtD,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,EAAE;YAChC,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC;SACxB;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;CACF;AACD,YAAY;AACZ,MAAM,OAAO,UAAU;IAIrB,YAA2B,SAA2D,EACpE,SAAiB,EACjB,YAAoB,EACpB,UAAsB,EACtC,OAAqB;QAJI,cAAS,GAAT,SAAS,CAAkD;QACpE,cAAS,GAAT,SAAS,CAAQ;QACjB,iBAAY,GAAZ,YAAY,CAAQ;QACpB,eAAU,GAAV,UAAU,CAAY;QANhC,YAAO,GAAG,IAAI,WAAW,EAAE,CAAC;QAC5B,kBAAa,GAAW,CAAC,CAAC,CAAC;QAC3B,aAAQ,GAAG,IAAI,kBAAkB,EAAE,CAAC,UAAU,EAAE,CAAC;QAMvD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACtB,CAAC;IACM,KAAK,CAAC,OAAqB;QAChC,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;SACzB;QACD,IAAI,CAAC,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;QACjC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,KAAM,CAAC;IACzC,CAAC;IACD,IAAW,KAAK,KAAgB,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAM,CAAC,CAAC,CAAC;IACvD,KAAK,CAAC,IAAI;QACf,IAAI,IAAI,CAAC,aAAa,KAAK,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;YAC9C,OAAO,KAAK,CAAC;SACd;QACD,MAAM,OAAO,GAAkB;YAC7B,IAAI,EAAE,aAAa,CAAC,MAAM;YAC1B,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,GAAG,IAAI,CAAC,QAAQ;SACjB,CAAC;QACF,OAAO,CAAC,KAAK,GAAG,EAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAC,CAAC;QAChH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACnD,YAAY,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAEzC,IAAI,IAAI,CAAC,aAAa,KAAK,CAAC,CAAC,EAAE;YAC7B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC;SACvC;QACD,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;YACrC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAChC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACM,KAAK,CAAC,SAAS;QACpB,OAAO,MAAM,IAAI,CAAC,IAAI,EAAE,EAAE,GAAG;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IAChC,CAAC;IACD,IAAW,OAAO;QAChB,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE;YAC7B,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;SAC/C;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9C,CAAC;IACD,IAAW,MAAM,KAAkB,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;CAC1D","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module iModels\n */\nimport { Id64String } from \"@itwin/core-bentley\";\nimport {\n  BlobOptions, BlobOptionsBuilder, BlobRange, DbBlobRequest, DbBlobResponse, DbQueryError, DbRequestExecutor, DbRequestKind,\n} from \"./ConcurrentQuery\";\n\n/** @beta */\nexport class Uint8Chunks implements Iterable<Uint8Array> {\n  private _chunks: Uint8Array[] = [];\n  public append(chunk: Uint8Array) {\n    this._chunks.push(chunk);\n  }\n  public at(idx: number) { return this._chunks[idx]; }\n  public get length() { return this._chunks.length; }\n  public [Symbol.iterator](): Iterator<Uint8Array, any, undefined> {\n    return (this._chunks as any)[Symbol.iterator];\n  }\n  public combine(): Uint8Array {\n    const totalChunkLength = this._chunks.reduce((acc, v) => acc + v.length, 0);\n    const combineChunk = new Uint8Array(totalChunkLength);\n    let offset = 0;\n    for (const array of this._chunks) {\n      combineChunk.set(array, offset);\n      offset += array.length;\n    }\n    return combineChunk;\n  }\n}\n/** @beta */\nexport class BlobReader {\n  private _chunks = new Uint8Chunks();\n  private _lengthToRead: number = -1;\n  private _options = new BlobOptionsBuilder().getOptions();\n  public constructor(private _executor: DbRequestExecutor<DbBlobRequest, DbBlobResponse>,\n    public readonly className: string,\n    public readonly accessString: string,\n    public readonly instanceId: Id64String,\n    options?: BlobOptions) {\n    this.reset(options);\n  }\n  public reset(options?: BlobOptions) {\n    if (options) {\n      this._options = options;\n    }\n    this._chunks = new Uint8Chunks();\n    this._lengthToRead = this.range.count!;\n  }\n  public get range(): BlobRange { return this._options.range!; }\n  public async step(): Promise<boolean> {\n    if (this._lengthToRead === this._chunks.length) {\n      return false;\n    }\n    const request: DbBlobRequest = {\n      kind: DbRequestKind.BlobIO,\n      className: this.className,\n      accessString: this.accessString,\n      instanceId: this.instanceId,\n      ...this._options,\n    };\n    request.range = {offset: this._chunks.length, count: this.range ? this._lengthToRead - this._chunks.length : 0};\n    const resp = await this._executor.execute(request);\n    DbQueryError.throwIfError(resp, request);\n\n    if (this._lengthToRead === -1) {\n      this._lengthToRead = resp.rawBlobSize;\n    }\n    if (resp.data && resp.data.length > 0) {\n      this._chunks.append(resp.data);\n    }\n    return true;\n  }\n  public async readToEnd(): Promise<Uint8Array> {\n    while (await this.step()) { }\n    return this._chunks.combine();\n  }\n  public get current(): Uint8Array {\n    if (this._chunks.length === 0) {\n      throw new Error(\"there is no current buffer\");\n    }\n    return this._chunks.at(this._chunks.length);\n  }\n  public get chunks(): Uint8Chunks { return this._chunks; }\n}\n"]}