@itwin/core-frontend 4.3.0-dev.2 → 4.3.0-dev.21

package/lib/cjs/tile/map/MapLayerFormatRegistry.js

@@ -12,33 +12,53 @@ const core_bentley_1 = require("@itwin/core-bentley");
 const IModelApp_1 = require("../../IModelApp");
 const internal_1 = require("../internal");
 const loggerCategory = "ArcGISFeatureProvider";
-/** Class representing a map-layer format.
+/**
+ * Class representing a map-layer format.
  * Each format has it's unique 'formatId' string, used to uniquely identify a format in the [[MapLayerFormatRegistry]].
  * When creating an [[ImageMapLayerSettings]] object, a format needs to be specified this 'formatId'.
  * The MapLayerFormat object can later be used to validate a source, or create a provider.
  *
- * Subclasses should override formatId and [[MapLayerFormat.createImageryProvider]].
+ * Subclasses should override formatId, [[MapLayerFormat.createImageryProvider]], and [[MapLayerFormat.createMapLayerTree]].
  * @public
  */
 class MapLayerFormat {
-    /** Register the current format in the [[MapLayerFormatRegistry]].
-    */
+    /** Register the current format in the [[MapLayerFormatRegistry]]. */
     static register() { IModelApp_1.IModelApp.mapLayerFormatRegistry.register(this); }
-    /** Allow a source of a specific to be validated before being attached as a map-layer.
-    */
+    /**
+     * Allow a source of a specific format to be validated before being attached as a map-layer.
+     * @param _url The URL of the source.
+     * @param _userName The username to access the source if needed.
+     * @param _password The password to access the source if needed.
+     * @param _ignoreCache Flag to skip cache lookup (i.e. force a new server request).
+     * @returns Validation Status. If successful, a list of available sub-layers may also be returned.
+     */
     static async validateSource(_url, _userName, _password, _ignoreCache) { return { status: internal_1.MapLayerSourceStatus.Valid }; }
-    /** Create a [[MapLayerImageryProvider]] that will be used to feed data in a map-layer tile Tree.
-     * @internal
-    */
-    static createImageryProvider(_settings) { (0, core_bentley_1.assert)(false); }
-    /** @internal */
+    /**
+     * Create a [[MapLayerImageryProvider]] that will be used to feed data in a map-layer tile tree.
+     * @param _settings The map layer settings to be applied to the imagery provider.
+     * @returns Returns the new imagery provider.
+     * @beta
+     */
+    static createImageryProvider(_settings) {
+        (0, core_bentley_1.assert)(false, "Subclasses must override this method.");
+        return undefined;
+    }
+    /**
+     * Creates a MapLayerTileTreeReference for this map layer format.
+     * @param _layerSettings Map layer settings that are applied to the MapLayerTileTreeReference.
+     * @param _layerIndex The index of the associated map layer.
+     * @param _iModel The iModel containing the MapLayerTileTreeReference.
+     * @returns Returns the new tile tree reference.
+     * @beta
+     */
     static createMapLayerTree(_layerSettings, _layerIndex, _iModel) {
-        (0, core_bentley_1.assert)(false);
+        (0, core_bentley_1.assert)(false, "Subclasses must override this method.");
         return undefined;
     }
 }
 exports.MapLayerFormat = MapLayerFormat;
-/** A registry of MapLayerFormats identified by their unique format IDs. The registry can be accessed via [[IModelApp.mapLayerFormatRegistry]].
+/**
+ * A registry of MapLayerFormats identified by their unique format IDs. The registry can be accessed via [[IModelApp.mapLayerFormatRegistry]].
  * @public
  */
 class MapLayerFormatRegistry {
@@ -81,7 +101,8 @@ class MapLayerFormatRegistry {
         }
         return format.createMapLayerTree(layerSettings, layerIndex, iModel);
     }
-    /** Returns a [[MapLayerImageryProvider]] based on the provided [[ImageMapLayerSettings]] object.
+    /**
+     * Returns a [[MapLayerImageryProvider]] based on the provided [[ImageMapLayerSettings]] object.
      * @internal
      */
     createImageryProvider(layerSettings) {

package/lib/cjs/tile/map/MapLayerFormatRegistry.js.map

@@ -1 +1 @@
-{"version":3,"file":"MapLayerFormatRegistry.js","sourceRoot":"","sources":["../../../../src/tile/map/MapLayerFormatRegistry.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAqD;AAErD,+CAA4C;AAE5C,0CAAuN;AACvN,MAAM,cAAc,GAAG,uBAAuB,CAAC;AAE/C;;;;;;;GAOG;AACH,MAAa,cAAc;IAGzB;MACE;IACK,MAAM,CAAC,QAAQ,KAAK,qBAAS,CAAC,sBAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAE7E;MACE;IACK,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,IAAY,EAAE,SAAkB,EAAE,SAAkB,EAAE,YAAsB,IAAuC,OAAO,EAAE,MAAM,EAAE,+BAAoB,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IAEtM;;MAEE;IACK,MAAM,CAAC,qBAAqB,CAAC,SAA2B,IAAyC,IAAA,qBAAM,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAExH,gBAAgB;IACT,MAAM,CAAC,kBAAkB,CAAC,cAAgC,EAAE,WAAmB,EAAE,OAAyB;QAC/G,IAAA,qBAAM,EAAC,KAAK,CAAC,CAAC;QACd,OAAO,SAAS,CAAC;IACnB,CAAC;CAEF;AAtBD,wCAsBC;AA2CD;;GAEG;AACH,MAAa,sBAAsB;IAEjC,YAAY,IAAsB;QAI1B,aAAQ,GAAG,IAAI,GAAG,EAA+B,CAAC;QAHxD,IAAI,CAAC,cAAc,GAAG,IAAI,IAAI,EAAE,CAAC;QACjC,yCAA8B,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;IAC5E,CAAC;IAGM,YAAY,CAAC,QAAgB,IAAI,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC;IAEpF,QAAQ,CAAC,WAA+B;QAC7C,IAAI,WAAW,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC;YACnC,OAAO,CAAC,uCAAuC;QAEjD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,YAAY;IACL,eAAe,CAAC,QAAgB,EAAE,YAAkC;QACzE,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC1C,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,KAAK,CAAC,YAAY,GAAG,YAAY,CAAC;YAClC,OAAO,IAAI,CAAC;SACb;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,YAAY;IACL,eAAe,CAAC,QAAgB;QACrC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;YACvB,OAAO,SAAS,CAAC;QAEnB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,YAAY,CAAC;IACnD,CAAC;IAED,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED,gBAAgB;IACT,yBAAyB,CAAC,aAAoC,EAAE,UAAkB,EAAE,MAAwB;QACjH,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QACxD,MAAM,MAAM,GAAG,KAAK,EAAE,IAAI,CAAC;QAC3B,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,0BAA0B,aAAa,CAAC,QAAQ,eAAe,CAAC,CAAC;YACjG,OAAO,SAAS,CAAC;SAClB;QACD,OAAO,MAAM,CAAC,kBAAkB,CAAC,aAAa,EAAE,UAAU,EAAE,MAAM,CAAiC,CAAC;IACtG,CAAC;IAED;;OAEG;IACI,qBAAqB,CAAC,aAAoC;QAC/D,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QACxD,MAAM,MAAM,GAAG,KAAK,EAAE,IAAI,CAAC;QAC3B,IAAI,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,QAAQ,CAAC,KAAK,SAAS,EAAE;YAC7D,MAAM,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,QAAQ,CAAE,CAAC;YAClE,MAAM,GAAG,GAAgB,EAAE,GAAG,EAAE,YAAY,CAAC,GAAG,EAAE,KAAK,EAAE,YAAY,CAAC,KAAK,EAAE,CAAC;YAC9E,aAAa,GAAG,aAAa,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,CAAC,CAAC;SACzD;QACD,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,qBAAqB,CAAC,aAAa,CAAC,CAAC;IAC1F,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,QAAgB,EAAE,GAAW,EAAE,QAAiB,EAAE,QAAiB,EAAE,WAAqB;QACpH,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC1C,MAAM,MAAM,GAAG,KAAK,EAAE,IAAI,CAAC;QAC3B,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,+BAAoB,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;IAC/I,CAAC;CACF;AArED,wDAqEC","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 MapLayers\r\n */\r\n\r\nimport { assert, Logger } from \"@itwin/core-bentley\";\r\nimport { ImageMapLayerSettings, MapLayerKey, MapLayerSettings, MapSubLayerProps } from \"@itwin/core-common\";\r\nimport { IModelApp } from \"../../IModelApp\";\r\nimport { IModelConnection } from \"../../IModelConnection\";\r\nimport { ImageryMapLayerTreeReference, internalMapLayerImageryFormats, MapLayerAccessClient, MapLayerAuthenticationInfo, MapLayerImageryProvider, MapLayerSourceStatus, MapLayerTileTreeReference } from \"../internal\";\r\nconst loggerCategory = \"ArcGISFeatureProvider\";\r\n\r\n/** Class representing a map-layer format.\r\n * Each format has it's unique 'formatId' string, used to uniquely identify a format in the [[MapLayerFormatRegistry]].\r\n * When creating an [[ImageMapLayerSettings]] object, a format needs to be specified this 'formatId'.\r\n * The MapLayerFormat object can later be used to validate a source, or create a provider.\r\n *\r\n * Subclasses should override formatId and [[MapLayerFormat.createImageryProvider]].\r\n * @public\r\n */\r\nexport class MapLayerFormat {\r\n  public static formatId: string;\r\n\r\n  /** Register the current format in the [[MapLayerFormatRegistry]].\r\n  */\r\n  public static register() { IModelApp.mapLayerFormatRegistry.register(this); }\r\n\r\n  /** Allow a source of a specific to be validated before being attached as a map-layer.\r\n  */\r\n  public static async validateSource(_url: string, _userName?: string, _password?: string, _ignoreCache?: boolean): Promise<MapLayerSourceValidation> { return { status: MapLayerSourceStatus.Valid }; }\r\n\r\n  /** Create a [[MapLayerImageryProvider]] that will be used to feed data in a map-layer tile Tree.\r\n   * @internal\r\n  */\r\n  public static createImageryProvider(_settings: MapLayerSettings): MapLayerImageryProvider | undefined { assert(false); }\r\n\r\n  /** @internal */\r\n  public static createMapLayerTree(_layerSettings: MapLayerSettings, _layerIndex: number, _iModel: IModelConnection): MapLayerTileTreeReference | undefined {\r\n    assert(false);\r\n    return undefined;\r\n  }\r\n\r\n}\r\n\r\n/** The type of a map layer format.\r\n * @public\r\n */\r\nexport type MapLayerFormatType = typeof MapLayerFormat;\r\n\r\n/** @public */\r\nexport interface MapLayerSourceValidation {\r\n  status: MapLayerSourceStatus;\r\n  subLayers?: MapSubLayerProps[];\r\n\r\n  /** @beta */\r\n  authInfo?: MapLayerAuthenticationInfo;\r\n}\r\n\r\n/**\r\n * Options supplied at startup via [[IModelAppOptions.mapLayerOptions]] to specify access keys for various map layer formats.\r\n * 'BingMaps' must have it's key value set to 'key'\r\n * 'MapboxImagery' must have it's key value set to 'access_token'\r\n *\r\n * @public\r\n */\r\nexport interface MapLayerOptions {\r\n  /** Access key for Azure Maps in the format `{ key: \"subscription-key\", value: \"your-azure-maps-key\" }`. */\r\n  // eslint-disable-next-line @typescript-eslint/naming-convention\r\n  AzureMaps?: MapLayerKey;\r\n  /** Access key for Mapbox in the format `{ key: \"access_token\", value: \"your-mapbox-key\" }`. */\r\n  // eslint-disable-next-line @typescript-eslint/naming-convention\r\n  MapboxImagery?: MapLayerKey;\r\n  /** Access key for Bing Maps in the format `{ key: \"key\", value: \"your-bing-maps-key\" }`. */\r\n  // eslint-disable-next-line @typescript-eslint/naming-convention\r\n  BingMaps?: MapLayerKey;\r\n  /** Access keys for additional map layer formats. */\r\n  [format: string]: MapLayerKey | undefined;\r\n}\r\n\r\n/** @internal */\r\nexport interface MapLayerFormatEntry {\r\n  type: MapLayerFormatType;\r\n  accessClient?: MapLayerAccessClient;\r\n}\r\n\r\n/** A registry of MapLayerFormats identified by their unique format IDs. The registry can be accessed via [[IModelApp.mapLayerFormatRegistry]].\r\n * @public\r\n */\r\nexport class MapLayerFormatRegistry {\r\n  private _configOptions: MapLayerOptions;\r\n  constructor(opts?: MapLayerOptions) {\r\n    this._configOptions = opts ?? {};\r\n    internalMapLayerImageryFormats.forEach((format) => this.register(format));\r\n  }\r\n  private _formats = new Map<string, MapLayerFormatEntry>();\r\n\r\n  public isRegistered(formatId: string) { return this._formats.get(formatId) !== undefined; }\r\n\r\n  public register(formatClass: MapLayerFormatType) {\r\n    if (formatClass.formatId.length === 0)\r\n      return; // must be an abstract class, ignore it\r\n\r\n    this._formats.set(formatClass.formatId, { type: formatClass });\r\n  }\r\n\r\n  /** @beta */\r\n  public setAccessClient(formatId: string, accessClient: MapLayerAccessClient): boolean {\r\n    const entry = this._formats.get(formatId);\r\n    if (entry !== undefined) {\r\n      entry.accessClient = accessClient;\r\n      return true;\r\n    }\r\n    return false;\r\n  }\r\n\r\n  /** @beta */\r\n  public getAccessClient(formatId: string): MapLayerAccessClient | undefined {\r\n    if (formatId.length === 0)\r\n      return undefined;\r\n\r\n    return this._formats.get(formatId)?.accessClient;\r\n  }\r\n\r\n  public get configOptions(): MapLayerOptions {\r\n    return this._configOptions;\r\n  }\r\n\r\n  /** @internal */\r\n  public createImageryMapLayerTree(layerSettings: ImageMapLayerSettings, layerIndex: number, iModel: IModelConnection): ImageryMapLayerTreeReference | undefined {\r\n    const entry = this._formats.get(layerSettings.formatId);\r\n    const format = entry?.type;\r\n    if (format === undefined) {\r\n      Logger.logError(loggerCategory, `Could not find format '${layerSettings.formatId}' in registry`);\r\n      return undefined;\r\n    }\r\n    return format.createMapLayerTree(layerSettings, layerIndex, iModel) as ImageryMapLayerTreeReference;\r\n  }\r\n\r\n  /** Returns a [[MapLayerImageryProvider]] based on the provided [[ImageMapLayerSettings]] object.\r\n   * @internal\r\n   */\r\n  public createImageryProvider(layerSettings: ImageMapLayerSettings): MapLayerImageryProvider | undefined {\r\n    const entry = this._formats.get(layerSettings.formatId);\r\n    const format = entry?.type;\r\n    if (this._configOptions[layerSettings.formatId] !== undefined) {\r\n      const keyValuePair = this._configOptions[layerSettings.formatId]!;\r\n      const key: MapLayerKey = { key: keyValuePair.key, value: keyValuePair.value };\r\n      layerSettings = layerSettings.clone({ accessKey: key });\r\n    }\r\n    return (format === undefined) ? undefined : format.createImageryProvider(layerSettings);\r\n  }\r\n\r\n  public async validateSource(formatId: string, url: string, userName?: string, password?: string, ignoreCache?: boolean): Promise<MapLayerSourceValidation> {\r\n    const entry = this._formats.get(formatId);\r\n    const format = entry?.type;\r\n    return (format === undefined) ? { status: MapLayerSourceStatus.InvalidFormat } : format.validateSource(url, userName, password, ignoreCache);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"MapLayerFormatRegistry.js","sourceRoot":"","sources":["../../../../src/tile/map/MapLayerFormatRegistry.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAqD;AAErD,+CAA4C;AAE5C,0CAAuN;AACvN,MAAM,cAAc,GAAG,uBAAuB,CAAC;AAE/C;;;;;;;;GAQG;AACH,MAAa,cAAc;IAGzB,qEAAqE;IAC9D,MAAM,CAAC,QAAQ,KAAK,qBAAS,CAAC,sBAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAE7E;;;;;;;OAOG;IACI,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,IAAY,EAAE,SAAkB,EAAE,SAAkB,EAAE,YAAsB,IAAuC,OAAO,EAAE,MAAM,EAAE,+BAAoB,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IAEtM;;;;;OAKG;IACI,MAAM,CAAC,qBAAqB,CAAC,SAA2B;QAC7D,IAAA,qBAAM,EAAC,KAAK,EAAE,uCAAuC,CAAC,CAAC;QACvD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,kBAAkB,CAAC,cAAgC,EAAE,WAAmB,EAAE,OAAyB;QAC/G,IAAA,qBAAM,EAAC,KAAK,EAAE,uCAAuC,CAAC,CAAC;QACvD,OAAO,SAAS,CAAC;IACnB,CAAC;CAEF;AAxCD,wCAwCC;AA4CD;;;GAGG;AACH,MAAa,sBAAsB;IAEjC,YAAY,IAAsB;QAI1B,aAAQ,GAAG,IAAI,GAAG,EAA+B,CAAC;QAHxD,IAAI,CAAC,cAAc,GAAG,IAAI,IAAI,EAAE,CAAC;QACjC,yCAA8B,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;IAC5E,CAAC;IAGM,YAAY,CAAC,QAAgB,IAAI,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC;IAEpF,QAAQ,CAAC,WAA+B;QAC7C,IAAI,WAAW,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC;YACnC,OAAO,CAAC,uCAAuC;QAEjD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,YAAY;IACL,eAAe,CAAC,QAAgB,EAAE,YAAkC;QACzE,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC1C,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,KAAK,CAAC,YAAY,GAAG,YAAY,CAAC;YAClC,OAAO,IAAI,CAAC;SACb;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,YAAY;IACL,eAAe,CAAC,QAAgB;QACrC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;YACvB,OAAO,SAAS,CAAC;QAEnB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,YAAY,CAAC;IACnD,CAAC;IAED,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED,gBAAgB;IACT,yBAAyB,CAAC,aAAoC,EAAE,UAAkB,EAAE,MAAwB;QACjH,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QACxD,MAAM,MAAM,GAAG,KAAK,EAAE,IAAI,CAAC;QAC3B,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,0BAA0B,aAAa,CAAC,QAAQ,eAAe,CAAC,CAAC;YACjG,OAAO,SAAS,CAAC;SAClB;QACD,OAAO,MAAM,CAAC,kBAAkB,CAAC,aAAa,EAAE,UAAU,EAAE,MAAM,CAAiC,CAAC;IACtG,CAAC;IAED;;;OAGG;IACI,qBAAqB,CAAC,aAAoC;QAC/D,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QACxD,MAAM,MAAM,GAAG,KAAK,EAAE,IAAI,CAAC;QAC3B,IAAI,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,QAAQ,CAAC,KAAK,SAAS,EAAE;YAC7D,MAAM,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,QAAQ,CAAE,CAAC;YAClE,MAAM,GAAG,GAAgB,EAAE,GAAG,EAAE,YAAY,CAAC,GAAG,EAAE,KAAK,EAAE,YAAY,CAAC,KAAK,EAAE,CAAC;YAC9E,aAAa,GAAG,aAAa,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,CAAC,CAAC;SACzD;QACD,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,qBAAqB,CAAC,aAAa,CAAC,CAAC;IAC1F,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,QAAgB,EAAE,GAAW,EAAE,QAAiB,EAAE,QAAiB,EAAE,WAAqB;QACpH,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC1C,MAAM,MAAM,GAAG,KAAK,EAAE,IAAI,CAAC;QAC3B,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,+BAAoB,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;IAC/I,CAAC;CACF;AAtED,wDAsEC","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 MapLayers\r\n */\r\n\r\nimport { assert, Logger } from \"@itwin/core-bentley\";\r\nimport { ImageMapLayerSettings, MapLayerKey, MapLayerSettings, MapSubLayerProps } from \"@itwin/core-common\";\r\nimport { IModelApp } from \"../../IModelApp\";\r\nimport { IModelConnection } from \"../../IModelConnection\";\r\nimport { ImageryMapLayerTreeReference, internalMapLayerImageryFormats, MapLayerAccessClient, MapLayerAuthenticationInfo, MapLayerImageryProvider, MapLayerSourceStatus, MapLayerTileTreeReference } from \"../internal\";\r\nconst loggerCategory = \"ArcGISFeatureProvider\";\r\n\r\n/**\r\n * Class representing a map-layer format.\r\n * Each format has it's unique 'formatId' string, used to uniquely identify a format in the [[MapLayerFormatRegistry]].\r\n * When creating an [[ImageMapLayerSettings]] object, a format needs to be specified this 'formatId'.\r\n * The MapLayerFormat object can later be used to validate a source, or create a provider.\r\n *\r\n * Subclasses should override formatId, [[MapLayerFormat.createImageryProvider]], and [[MapLayerFormat.createMapLayerTree]].\r\n * @public\r\n */\r\nexport class MapLayerFormat {\r\n  public static formatId: string;\r\n\r\n  /** Register the current format in the [[MapLayerFormatRegistry]]. */\r\n  public static register() { IModelApp.mapLayerFormatRegistry.register(this); }\r\n\r\n  /**\r\n   * Allow a source of a specific format to be validated before being attached as a map-layer.\r\n   * @param _url The URL of the source.\r\n   * @param _userName The username to access the source if needed.\r\n   * @param _password The password to access the source if needed.\r\n   * @param _ignoreCache Flag to skip cache lookup (i.e. force a new server request).\r\n   * @returns Validation Status. If successful, a list of available sub-layers may also be returned.\r\n   */\r\n  public static async validateSource(_url: string, _userName?: string, _password?: string, _ignoreCache?: boolean): Promise<MapLayerSourceValidation> { return { status: MapLayerSourceStatus.Valid }; }\r\n\r\n  /**\r\n   * Create a [[MapLayerImageryProvider]] that will be used to feed data in a map-layer tile tree.\r\n   * @param _settings The map layer settings to be applied to the imagery provider.\r\n   * @returns Returns the new imagery provider.\r\n   * @beta\r\n   */\r\n  public static createImageryProvider(_settings: MapLayerSettings): MapLayerImageryProvider | undefined {\r\n    assert(false, \"Subclasses must override this method.\");\r\n    return undefined;\r\n  }\r\n\r\n  /**\r\n   * Creates a MapLayerTileTreeReference for this map layer format.\r\n   * @param _layerSettings Map layer settings that are applied to the MapLayerTileTreeReference.\r\n   * @param _layerIndex The index of the associated map layer.\r\n   * @param _iModel The iModel containing the MapLayerTileTreeReference.\r\n   * @returns Returns the new tile tree reference.\r\n   * @beta\r\n   */\r\n  public static createMapLayerTree(_layerSettings: MapLayerSettings, _layerIndex: number, _iModel: IModelConnection): MapLayerTileTreeReference | undefined {\r\n    assert(false, \"Subclasses must override this method.\");\r\n    return undefined;\r\n  }\r\n\r\n}\r\n\r\n/**\r\n * The type of a map layer format.\r\n * @public\r\n */\r\nexport type MapLayerFormatType = typeof MapLayerFormat;\r\n\r\n/** @public */\r\nexport interface MapLayerSourceValidation {\r\n  status: MapLayerSourceStatus;\r\n  subLayers?: MapSubLayerProps[];\r\n\r\n  /** @beta */\r\n  authInfo?: MapLayerAuthenticationInfo;\r\n}\r\n\r\n/**\r\n * Options supplied at startup via [[IModelAppOptions.mapLayerOptions]] to specify access keys for various map layer formats.\r\n * 'BingMaps' must have it's key value set to 'key'\r\n * 'MapboxImagery' must have it's key value set to 'access_token'\r\n *\r\n * @public\r\n */\r\nexport interface MapLayerOptions {\r\n  /** Access key for Azure Maps in the format `{ key: \"subscription-key\", value: \"your-azure-maps-key\" }`. */\r\n  // eslint-disable-next-line @typescript-eslint/naming-convention\r\n  AzureMaps?: MapLayerKey;\r\n  /** Access key for Mapbox in the format `{ key: \"access_token\", value: \"your-mapbox-key\" }`. */\r\n  // eslint-disable-next-line @typescript-eslint/naming-convention\r\n  MapboxImagery?: MapLayerKey;\r\n  /** Access key for Bing Maps in the format `{ key: \"key\", value: \"your-bing-maps-key\" }`. */\r\n  // eslint-disable-next-line @typescript-eslint/naming-convention\r\n  BingMaps?: MapLayerKey;\r\n  /** Access keys for additional map layer formats. */\r\n  [format: string]: MapLayerKey | undefined;\r\n}\r\n\r\n/** @internal */\r\nexport interface MapLayerFormatEntry {\r\n  type: MapLayerFormatType;\r\n  accessClient?: MapLayerAccessClient;\r\n}\r\n\r\n/**\r\n * A registry of MapLayerFormats identified by their unique format IDs. The registry can be accessed via [[IModelApp.mapLayerFormatRegistry]].\r\n * @public\r\n */\r\nexport class MapLayerFormatRegistry {\r\n  private _configOptions: MapLayerOptions;\r\n  constructor(opts?: MapLayerOptions) {\r\n    this._configOptions = opts ?? {};\r\n    internalMapLayerImageryFormats.forEach((format) => this.register(format));\r\n  }\r\n  private _formats = new Map<string, MapLayerFormatEntry>();\r\n\r\n  public isRegistered(formatId: string) { return this._formats.get(formatId) !== undefined; }\r\n\r\n  public register(formatClass: MapLayerFormatType) {\r\n    if (formatClass.formatId.length === 0)\r\n      return; // must be an abstract class, ignore it\r\n\r\n    this._formats.set(formatClass.formatId, { type: formatClass });\r\n  }\r\n\r\n  /** @beta */\r\n  public setAccessClient(formatId: string, accessClient: MapLayerAccessClient): boolean {\r\n    const entry = this._formats.get(formatId);\r\n    if (entry !== undefined) {\r\n      entry.accessClient = accessClient;\r\n      return true;\r\n    }\r\n    return false;\r\n  }\r\n\r\n  /** @beta */\r\n  public getAccessClient(formatId: string): MapLayerAccessClient | undefined {\r\n    if (formatId.length === 0)\r\n      return undefined;\r\n\r\n    return this._formats.get(formatId)?.accessClient;\r\n  }\r\n\r\n  public get configOptions(): MapLayerOptions {\r\n    return this._configOptions;\r\n  }\r\n\r\n  /** @internal */\r\n  public createImageryMapLayerTree(layerSettings: ImageMapLayerSettings, layerIndex: number, iModel: IModelConnection): ImageryMapLayerTreeReference | undefined {\r\n    const entry = this._formats.get(layerSettings.formatId);\r\n    const format = entry?.type;\r\n    if (format === undefined) {\r\n      Logger.logError(loggerCategory, `Could not find format '${layerSettings.formatId}' in registry`);\r\n      return undefined;\r\n    }\r\n    return format.createMapLayerTree(layerSettings, layerIndex, iModel) as ImageryMapLayerTreeReference;\r\n  }\r\n\r\n  /**\r\n   * Returns a [[MapLayerImageryProvider]] based on the provided [[ImageMapLayerSettings]] object.\r\n   * @internal\r\n   */\r\n  public createImageryProvider(layerSettings: ImageMapLayerSettings): MapLayerImageryProvider | undefined {\r\n    const entry = this._formats.get(layerSettings.formatId);\r\n    const format = entry?.type;\r\n    if (this._configOptions[layerSettings.formatId] !== undefined) {\r\n      const keyValuePair = this._configOptions[layerSettings.formatId]!;\r\n      const key: MapLayerKey = { key: keyValuePair.key, value: keyValuePair.value };\r\n      layerSettings = layerSettings.clone({ accessKey: key });\r\n    }\r\n    return (format === undefined) ? undefined : format.createImageryProvider(layerSettings);\r\n  }\r\n\r\n  public async validateSource(formatId: string, url: string, userName?: string, password?: string, ignoreCache?: boolean): Promise<MapLayerSourceValidation> {\r\n    const entry = this._formats.get(formatId);\r\n    const format = entry?.type;\r\n    return (format === undefined) ? { status: MapLayerSourceStatus.InvalidFormat } : format.validateSource(url, userName, password, ignoreCache);\r\n  }\r\n}\r\n"]}

package/lib/cjs/tile/map/MapLayerImageryFormats.js

@@ -10,7 +10,7 @@ const internal_1 = require("../internal");
 class ImageryMapLayerFormat extends internal_1.MapLayerFormat {
     /** @internal */
     static createMapLayerTree(layerSettings, layerIndex, iModel) {
-        return new internal_1.ImageryMapLayerTreeReference(layerSettings, layerIndex, iModel);
+        return new internal_1.ImageryMapLayerTreeReference({ layerSettings, layerIndex, iModel });
     }
 }
 exports.ImageryMapLayerFormat = ImageryMapLayerFormat;

package/lib/cjs/tile/map/MapLayerImageryFormats.js.map

@@ -1 +1 @@
-{"version":3,"file":"MapLayerImageryFormats.js","sourceRoot":"","sources":["../../../../src/tile/map/MapLayerImageryFormats.ts"],"names":[],"mappings":";;;AASA,0CAkBqB;AAErB;;;;GAIG;AACH,MAAa,qBAAsB,SAAQ,yBAAc;IACvD,gBAAgB;IACT,MAAM,CAAU,kBAAkB,CAAC,aAAoC,EAAE,UAAkB,EAAE,MAAwB;QAC1H,OAAO,IAAI,uCAA4B,CAAC,aAAa,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;IAC7E,CAAC;CACF;AALD,sDAKC;AAED,MAAM,iBAAkB,SAAQ,qBAAqB;IAG5C,MAAM,CAAU,qBAAqB,CAAC,QAA+B;QAC1E,OAAO,IAAI,qCAA0B,CAAC,QAAQ,CAAC,CAAC;IAClD,CAAC;IACM,MAAM,CAAU,KAAK,CAAC,cAAc,CAAC,GAAW,EAAE,QAAiB,EAAE,QAAiB,EAAE,WAAqB;QAClH,IAAI;YACF,IAAI,SAAyC,CAAC;YAC9C,MAAM,mBAAmB,GAAG,EAAE,CAAC;YAC/B,MAAM,YAAY,GAAG,MAAM,0BAAe,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,QAAQ,IAAI,QAAQ,CAAC,CAAC,CAAC,EAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAC,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,WAAW,CAAC,CAAC;YACrI,IAAI,YAAY,KAAK,SAAS,EAAE;gBAC9B,SAAS,GAAG,YAAY,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;gBAC7C,MAAM,aAAa,GAAG,SAAS,EAAE,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC;gBACnF,MAAM,gBAAgB,GAAG,SAAS,IAAI,SAAS,CAAC,MAAM,GAAG,mBAAmB,CAAC;gBAE7E,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC;oBAC3B,OAAO,EAAE,MAAM,EAAE,+BAAoB,CAAC,KAAK,EAAE,SAAS,EAAE,CAAC;gBAE3D,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;oBAChC,oGAAoG;oBACpG,mDAAmD;oBACnD,2FAA2F;oBAC3F,IAAI,QAAQ,CAAC,EAAE,IAAI,QAAQ,CAAC,EAAE,KAAK,aAAa,EAAE,EAAE;2BAC/C,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,gBAAgB,CAAC,EAAE;wBACvE,QAAQ,CAAC,OAAO,GAAG,IAAI,CAAC;wBACxB,MAAM,CAAE,oEAAoE;qBAC7E;oBAED,0CAA0C;oBAC1C,IAAI,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,MAAM,KAAK,aAAa,EAAE,EAAE,IAAI,CAAC,gBAAgB,EAAE;wBACjF,MAAM,cAAc,GAAG,CAAC,KAAuB,EAAE,EAAE;4BACjD,OAAO,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;wBACjG,CAAC,CAAC;wBAEF,MAAM,mBAAmB,GAAG,CAAC,MAAsC,EAAE,KAAuB,EAAE,EAAE;4BAC9F,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gCACnC,MAAM,aAAa,GAAG,SAAS,EAAE,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,EAAE,EAAE,KAAK,OAAO,CAAC,CAAC;gCACxE,IAAI,aAAa,EAAE;oCACjB,aAAa,CAAC,OAAO,GAAG,IAAI,CAAC;oCAC7B,IAAI,cAAc,CAAC,aAAa,CAAC;wCAC/B,mBAAmB,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;iCAC9C;4BACH,CAAC,CAAC,CAAC;wBACL,CAAC,CAAC;wBAEF,QAAQ,CAAC,OAAO,GAAG,IAAI,CAAC;wBAExB,mGAAmG;wBACnG,IAAI,cAAc,CAAC,QAAQ,CAAC;4BAC1B,mBAAmB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;qBAC5C;iBACF;aACF;YAED,OAAO,EAAE,MAAM,EAAE,+BAAoB,CAAC,KAAK,EAAE,SAAS,EAAE,CAAC;SAC1D;QAAC,OAAO,GAAQ,EAAE;YACjB,IAAI,MAAM,GAAG,+BAAoB,CAAC,UAAU,CAAC;YAC7C,IAAI,GAAG,EAAE,MAAM,KAAK,GAAG,EAAE;gBACvB,MAAM,GAAG,CAAC,CAAC,QAAQ,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,+BAAoB,CAAC,kBAAkB,CAAC,CAAC,CAAC,+BAAoB,CAAC,WAAW,CAAC,CAAC;aAChH;YACD,OAAO,EAAE,MAAM,EAAC,CAAC;SAClB;IACH,CAAC;;AA9DsB,0BAAQ,GAAG,KAAK,CAAC;AAiE1C,MAAM,kBAAmB,SAAQ,qBAAqB;IAG7C,MAAM,CAAU,qBAAqB,CAAC,QAA+B;QAC1E,OAAO,IAAI,sCAA2B,CAAC,QAAQ,CAAC,CAAC;IACnD,CAAC;IAEM,MAAM,CAAU,KAAK,CAAC,cAAc,CAAC,GAAW,EAAE,QAAiB,EAAE,QAAiB,EAAE,WAAqB;QAClH,IAAI;YACF,MAAM,SAAS,GAAuB,EAAE,CAAC;YACzC,MAAM,YAAY,GAAG,MAAM,2BAAgB,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,QAAQ,IAAI,QAAQ,CAAC,CAAC,CAAC,EAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAC,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,WAAW,CAAC,CAAC;YACtI,IAAI,CAAC,YAAY;gBACf,OAAO,EAAE,MAAM,EAAE,+BAAoB,CAAC,UAAU,EAAE,CAAC;YAErD,2FAA2F;YAC3F,IAAI,YAAY,GAAoC,EAAE,CAAC;YACvD,MAAM,aAAa,GAAG,YAAY,EAAE,QAAQ,EAAE,oCAAoC,EAAE,CAAC;YACrF,IAAI,aAAa,EAAE;gBACjB,YAAY,GAAG,aAAa,CAAC;aAC9B;YACD,MAAM,QAAQ,GAAG,YAAY,EAAE,QAAQ,EAAE,kCAAkC,EAAE,CAAC;YAC9E,IAAI,QAAQ,EAAE;gBACZ,YAAY,GAAG,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;aAC9C;YAED,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC7B,8DAA8D;gBAC9D,OAAO,EAAE,MAAM,EAAE,+BAAoB,CAAC,uBAAuB,EAAE,CAAC;aACjE;YAED,IAAI,UAAU,GAAG,CAAC,CAAC;YACnB,YAAY,EAAE,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC/C,MAAM,eAAe,GAAG,YAAY,EAAE,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE;oBACjD,OAAO,KAAK,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,KAAK,GAAG,CAAC,UAAU,CAAC,CAAC;gBACxF,CAAC,CAAC,CAAC;gBACH,IAAI,eAAe,EAAE;oBACnB,SAAS,CAAC,IAAI,CAAC;wBACb,IAAI,EAAE,KAAK,CAAC,UAAU;wBACtB,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,UAAU;wBACtC,OAAO,EAAE,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,CAAC;wBACjC,MAAM,EAAE,SAAS;wBACjB,QAAQ,EAAE,SAAS;wBACnB,EAAE,EAAE,UAAU,EAAE;qBACjB,CAAC,CAAC;iBACJ;YACH,CAAC,CAAC,CAAC;YAEH,2DAA2D;YAC3D,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC;gBACxB,OAAO,EAAE,MAAM,EAAE,+BAAoB,CAAC,eAAe,EAAE,CAAC;YAE1D,OAAO,EAAE,MAAM,EAAE,+BAAoB,CAAC,KAAK,EAAE,SAAS,EAAE,CAAC;SAC1D;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,iCAAiC;YACrD,OAAO,EAAE,MAAM,EAAE,+BAAoB,CAAC,UAAU,EAAE,CAAC;SACpD;IACH,CAAC;;AAvDsB,2BAAQ,GAAG,MAAM,CAAC;AA2D3C,MAAM,oBAAqB,SAAQ,qBAAqB;IAE/C,MAAM,CAAU,KAAK,CAAC,cAAc,CAAC,GAAW,EAAE,QAAiB,EAAE,QAAiB,EAAE,WAAqB;QAElH,MAAM,aAAa,GAAG,0BAAe,CAAC,WAAW,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;QACpE,IAAI,aAAa,KAAK,+BAAoB,CAAC,KAAK;YAC9C,OAAO,EAAC,MAAM,EAAE,aAAa,EAAC,CAAC;QAEjC,gHAAgH;QAChH,OAAO,0BAAe,CAAC,cAAc,CAAC,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;IACjG,CAAC;IACM,MAAM,CAAU,qBAAqB,CAAC,QAA+B;QAC1E,OAAO,IAAI,wCAA6B,CAAC,QAAQ,CAAC,CAAC;IACrD,CAAC;;AAZsB,6BAAQ,GAAG,QAAQ,CAAC;AAe7C,6DAA6D;AAC7D,MAAM,uBAAwB,SAAQ,qBAAqB;IAElD,MAAM,CAAU,qBAAqB,CAAC,QAA+B;QAC1E,OAAO,IAAI,wCAA6B,CAAC,QAAQ,CAAC,CAAC;IACrD,CAAC;;AAHsB,gCAAQ,GAAG,WAAW,CAAC;AAKhD,MAAM,sBAAuB,SAAQ,qBAAqB;IAEjD,MAAM,CAAU,qBAAqB,CAAC,QAA+B;QAC1E,OAAO,IAAI,uCAA4B,CAAC,QAAQ,CAAC,CAAC;IACpD,CAAC;;AAHsB,+BAAQ,GAAG,UAAU,CAAC;AAM/C,MAAM,2BAA4B,SAAQ,qBAAqB;IAEtD,MAAM,CAAU,qBAAqB,CAAC,QAA+B;QAC1E,OAAO,IAAI,qCAA0B,CAAC,QAAQ,CAAC,CAAC;IAClD,CAAC;;AAHsB,oCAAQ,GAAG,eAAe,CAAC;AAKpD,MAAM,qBAAsB,SAAQ,qBAAqB;IAEhD,MAAM,CAAU,qBAAqB,CAAC,QAA+B,IAAyC,OAAO,IAAI,iCAAsB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;;AAD5I,8BAAQ,GAAG,SAAS,CAAC;AAI9C,gBAAgB;AACH,QAAA,8BAA8B,GAAG,CAAC,iBAAiB,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,8BAA8B,CAAC,sBAAsB,EAAE,2BAA2B,EAAE,qBAAqB,CAAC,CAAC","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 MapLayers\r\n */\r\nimport { ImageMapLayerSettings, MapSubLayerProps } from \"@itwin/core-common\";\r\nimport { IModelConnection } from \"../../IModelConnection\";\r\nimport {\r\n  ArcGISMapLayerImageryProvider,\r\n  ArcGisUtilities,\r\n  AzureMapsLayerImageryProvider,\r\n  BingMapsImageryLayerProvider,\r\n  ImageryMapLayerTreeReference,\r\n  MapBoxLayerImageryProvider,\r\n  MapLayerFormat,\r\n  MapLayerImageryProvider,\r\n  MapLayerSourceStatus,\r\n  MapLayerSourceValidation,\r\n  MapLayerTileTreeReference,\r\n  TileUrlImageryProvider,\r\n  WmsCapabilities,\r\n  WmsMapLayerImageryProvider,\r\n  WmtsCapabilities,\r\n  WmtsCapability,\r\n  WmtsMapLayerImageryProvider,\r\n} from \"../internal\";\r\n\r\n/** Base class imagery map layer formats.\r\n *  Subclasses should override formatId and [[MapLayerFormat.createImageryProvider]].\r\n * @see [[MapLayerFormat]]\r\n * @beta\r\n */\r\nexport class ImageryMapLayerFormat extends MapLayerFormat {\r\n  /** @internal */\r\n  public static override createMapLayerTree(layerSettings: ImageMapLayerSettings, layerIndex: number, iModel: IModelConnection): MapLayerTileTreeReference | undefined {\r\n    return new ImageryMapLayerTreeReference(layerSettings, layerIndex, iModel);\r\n  }\r\n}\r\n\r\nclass WmsMapLayerFormat extends ImageryMapLayerFormat {\r\n  public static override formatId = \"WMS\";\r\n\r\n  public static override createImageryProvider(settings: ImageMapLayerSettings): MapLayerImageryProvider | undefined {\r\n    return new WmsMapLayerImageryProvider(settings);\r\n  }\r\n  public static override async validateSource(url: string, userName?: string, password?: string, ignoreCache?: boolean): Promise<MapLayerSourceValidation> {\r\n    try {\r\n      let subLayers: MapSubLayerProps[] | undefined;\r\n      const maxVisibleSubLayers = 50;\r\n      const capabilities = await WmsCapabilities.create(url, (userName && password ? {user: userName, password} : undefined), ignoreCache);\r\n      if (capabilities !== undefined) {\r\n        subLayers = capabilities.getSubLayers(false);\r\n        const rootsSubLayer = subLayers?.find((sublayer) => sublayer.parent === undefined);\r\n        const hasTooManyLayers = subLayers && subLayers.length > maxVisibleSubLayers;\r\n\r\n        if (!Array.isArray(subLayers))\r\n          return { status: MapLayerSourceStatus.Valid, subLayers };\r\n\r\n        for (const subLayer of subLayers) {\r\n          // In general for WMS, we prefer to have the children of root node visible, but not the root itself.\r\n          // Thats simply to give more flexibility in the UI.\r\n          // Two exceptions to this rule: If there are too many layers or the root node is not named.\r\n          if (subLayer.id && subLayer.id === rootsSubLayer?.id\r\n            && (!(subLayer.name && subLayer.name.length > 0) || hasTooManyLayers)) {\r\n            subLayer.visible = true;\r\n            break;  // if root node is visible, don't bother turning ON any other layers\r\n          }\r\n\r\n          // Make children of the root node visible.\r\n          if (subLayer.parent && subLayer.parent === rootsSubLayer?.id && !hasTooManyLayers) {\r\n            const isUnnamedGroup = (layer: MapSubLayerProps) => {\r\n              return layer.children && layer.children.length > 0 && (!layer.name || layer.name.length === 0);\r\n            };\r\n\r\n            const makeChildrenVisible = (layers: MapSubLayerProps[] | undefined, layer: MapSubLayerProps) => {\r\n              layer?.children?.forEach((childId) => {\r\n                const childSubLayer = subLayers?.find((child) => child?.id === childId);\r\n                if (childSubLayer) {\r\n                  childSubLayer.visible = true;\r\n                  if (isUnnamedGroup(childSubLayer))\r\n                    makeChildrenVisible(layers, childSubLayer);\r\n                }\r\n              });\r\n            };\r\n\r\n            subLayer.visible = true;\r\n\r\n            // If we got a unnamed group, make children visible recursively until we have a leaf or named group\r\n            if (isUnnamedGroup(subLayer))\r\n              makeChildrenVisible(subLayers, subLayer);\r\n          }\r\n        }\r\n      }\r\n\r\n      return { status: MapLayerSourceStatus.Valid, subLayers };\r\n    } catch (err: any) {\r\n      let status = MapLayerSourceStatus.InvalidUrl;\r\n      if (err?.status === 401) {\r\n        status = ((userName && password) ? MapLayerSourceStatus.InvalidCredentials : MapLayerSourceStatus.RequireAuth);\r\n      }\r\n      return { status};\r\n    }\r\n  }\r\n}\r\n\r\nclass WmtsMapLayerFormat extends ImageryMapLayerFormat {\r\n  public static override formatId = \"WMTS\";\r\n\r\n  public static override createImageryProvider(settings: ImageMapLayerSettings): MapLayerImageryProvider | undefined {\r\n    return new WmtsMapLayerImageryProvider(settings);\r\n  }\r\n\r\n  public static override async validateSource(url: string, userName?: string, password?: string, ignoreCache?: boolean): Promise<MapLayerSourceValidation> {\r\n    try {\r\n      const subLayers: MapSubLayerProps[] = [];\r\n      const capabilities = await WmtsCapabilities.create(url, (userName && password ? {user: userName, password} : undefined), ignoreCache);\r\n      if (!capabilities)\r\n        return { status: MapLayerSourceStatus.InvalidUrl };\r\n\r\n      // Only returns layer that can be published in the Google maps or WGS84 aligned tile trees.\r\n      let supportedTms: WmtsCapability.TileMatrixSet[]  = [];\r\n      const googleMapsTms = capabilities?.contents?.getGoogleMapsCompatibleTileMatrixSet();\r\n      if (googleMapsTms) {\r\n        supportedTms = googleMapsTms;\r\n      }\r\n      const wsg84Tms = capabilities?.contents?.getEpsg4326CompatibleTileMatrixSet();\r\n      if (wsg84Tms) {\r\n        supportedTms = supportedTms.concat(wsg84Tms);\r\n      }\r\n\r\n      if (supportedTms.length === 0) {\r\n        // This WMTS server doesn't support either GoogleMaps or WSG84\r\n        return { status: MapLayerSourceStatus.InvalidCoordinateSystem };\r\n      }\r\n\r\n      let subLayerId = 0;\r\n      capabilities?.contents?.layers.forEach((layer) => {\r\n        const hasSupportedTms = supportedTms?.some((tms) => {\r\n          return layer.tileMatrixSetLinks.some((tmls) => tmls.tileMatrixSet === tms.identifier);\r\n        });\r\n        if (hasSupportedTms) {\r\n          subLayers.push({\r\n            name: layer.identifier,\r\n            title: layer.title ?? layer.identifier,\r\n            visible: (subLayers.length === 0),   // Make the first layer visible.\r\n            parent: undefined,\r\n            children: undefined,\r\n            id: subLayerId++,\r\n          });\r\n        }\r\n      });\r\n\r\n      // Return error if we could find a single compatible layer.\r\n      if (subLayers.length === 0)\r\n        return { status: MapLayerSourceStatus.InvalidTileTree };\r\n\r\n      return { status: MapLayerSourceStatus.Valid, subLayers };\r\n    } catch (err) {\r\n      console.error(err); // eslint-disable-line no-console\r\n      return { status: MapLayerSourceStatus.InvalidUrl };\r\n    }\r\n  }\r\n\r\n}\r\n\r\nclass ArcGISMapLayerFormat extends ImageryMapLayerFormat {\r\n  public static override formatId = \"ArcGIS\";\r\n  public static override async validateSource(url: string, userName?: string, password?: string, ignoreCache?: boolean): Promise<MapLayerSourceValidation> {\r\n\r\n    const urlValidation = ArcGisUtilities.validateUrl(url, \"MapServer\");\r\n    if (urlValidation !== MapLayerSourceStatus.Valid)\r\n      return {status: urlValidation};\r\n\r\n    // Some Map service supporting only tiles don't include the 'Map' capabilities, thus we can't make it mandatory.\r\n    return ArcGisUtilities.validateSource(url, this.formatId, [], userName, password, ignoreCache);\r\n  }\r\n  public static override createImageryProvider(settings: ImageMapLayerSettings): MapLayerImageryProvider | undefined {\r\n    return new ArcGISMapLayerImageryProvider(settings);\r\n  }\r\n}\r\n\r\n// eslint-disable-next-line @typescript-eslint/no-unused-vars\r\nclass AzureMapsMapLayerFormat extends ImageryMapLayerFormat {\r\n  public static override formatId = \"AzureMaps\";\r\n  public static override createImageryProvider(settings: ImageMapLayerSettings): MapLayerImageryProvider | undefined {\r\n    return new AzureMapsLayerImageryProvider(settings);\r\n  }\r\n}\r\nclass BingMapsMapLayerFormat extends ImageryMapLayerFormat {\r\n  public static override formatId = \"BingMaps\";\r\n  public static override createImageryProvider(settings: ImageMapLayerSettings): MapLayerImageryProvider | undefined {\r\n    return new BingMapsImageryLayerProvider(settings);\r\n  }\r\n}\r\n\r\nclass MapBoxImageryMapLayerFormat extends ImageryMapLayerFormat {\r\n  public static override formatId = \"MapboxImagery\";\r\n  public static override createImageryProvider(settings: ImageMapLayerSettings): MapLayerImageryProvider | undefined {\r\n    return new MapBoxLayerImageryProvider(settings);\r\n  }\r\n}\r\nclass TileUrlMapLayerFormat extends ImageryMapLayerFormat {\r\n  public static override formatId = \"TileURL\";\r\n  public static override createImageryProvider(settings: ImageMapLayerSettings): MapLayerImageryProvider | undefined { return new TileUrlImageryProvider(settings); }\r\n}\r\n\r\n/** @internal */\r\nexport const internalMapLayerImageryFormats = [WmsMapLayerFormat, WmtsMapLayerFormat, ArcGISMapLayerFormat, /* AzureMapsMapLayerFormat, */ BingMapsMapLayerFormat, MapBoxImageryMapLayerFormat, TileUrlMapLayerFormat];\r\n"]}
+{"version":3,"file":"MapLayerImageryFormats.js","sourceRoot":"","sources":["../../../../src/tile/map/MapLayerImageryFormats.ts"],"names":[],"mappings":";;;AASA,0CAkBqB;AAErB;;;;GAIG;AACH,MAAa,qBAAsB,SAAQ,yBAAc;IACvD,gBAAgB;IACT,MAAM,CAAU,kBAAkB,CAAC,aAAoC,EAAE,UAAkB,EAAE,MAAwB;QAC1H,OAAO,IAAI,uCAA4B,CAAC,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC,CAAC;IACjF,CAAC;CACF;AALD,sDAKC;AAED,MAAM,iBAAkB,SAAQ,qBAAqB;IAG5C,MAAM,CAAU,qBAAqB,CAAC,QAA+B;QAC1E,OAAO,IAAI,qCAA0B,CAAC,QAAQ,CAAC,CAAC;IAClD,CAAC;IACM,MAAM,CAAU,KAAK,CAAC,cAAc,CAAC,GAAW,EAAE,QAAiB,EAAE,QAAiB,EAAE,WAAqB;QAClH,IAAI;YACF,IAAI,SAAyC,CAAC;YAC9C,MAAM,mBAAmB,GAAG,EAAE,CAAC;YAC/B,MAAM,YAAY,GAAG,MAAM,0BAAe,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,QAAQ,IAAI,QAAQ,CAAC,CAAC,CAAC,EAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAC,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,WAAW,CAAC,CAAC;YACrI,IAAI,YAAY,KAAK,SAAS,EAAE;gBAC9B,SAAS,GAAG,YAAY,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;gBAC7C,MAAM,aAAa,GAAG,SAAS,EAAE,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC;gBACnF,MAAM,gBAAgB,GAAG,SAAS,IAAI,SAAS,CAAC,MAAM,GAAG,mBAAmB,CAAC;gBAE7E,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC;oBAC3B,OAAO,EAAE,MAAM,EAAE,+BAAoB,CAAC,KAAK,EAAE,SAAS,EAAE,CAAC;gBAE3D,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;oBAChC,oGAAoG;oBACpG,mDAAmD;oBACnD,2FAA2F;oBAC3F,IAAI,QAAQ,CAAC,EAAE,IAAI,QAAQ,CAAC,EAAE,KAAK,aAAa,EAAE,EAAE;2BAC/C,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,gBAAgB,CAAC,EAAE;wBACvE,QAAQ,CAAC,OAAO,GAAG,IAAI,CAAC;wBACxB,MAAM,CAAE,oEAAoE;qBAC7E;oBAED,0CAA0C;oBAC1C,IAAI,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,MAAM,KAAK,aAAa,EAAE,EAAE,IAAI,CAAC,gBAAgB,EAAE;wBACjF,MAAM,cAAc,GAAG,CAAC,KAAuB,EAAE,EAAE;4BACjD,OAAO,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;wBACjG,CAAC,CAAC;wBAEF,MAAM,mBAAmB,GAAG,CAAC,MAAsC,EAAE,KAAuB,EAAE,EAAE;4BAC9F,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gCACnC,MAAM,aAAa,GAAG,SAAS,EAAE,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,EAAE,EAAE,KAAK,OAAO,CAAC,CAAC;gCACxE,IAAI,aAAa,EAAE;oCACjB,aAAa,CAAC,OAAO,GAAG,IAAI,CAAC;oCAC7B,IAAI,cAAc,CAAC,aAAa,CAAC;wCAC/B,mBAAmB,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;iCAC9C;4BACH,CAAC,CAAC,CAAC;wBACL,CAAC,CAAC;wBAEF,QAAQ,CAAC,OAAO,GAAG,IAAI,CAAC;wBAExB,mGAAmG;wBACnG,IAAI,cAAc,CAAC,QAAQ,CAAC;4BAC1B,mBAAmB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;qBAC5C;iBACF;aACF;YAED,OAAO,EAAE,MAAM,EAAE,+BAAoB,CAAC,KAAK,EAAE,SAAS,EAAE,CAAC;SAC1D;QAAC,OAAO,GAAQ,EAAE;YACjB,IAAI,MAAM,GAAG,+BAAoB,CAAC,UAAU,CAAC;YAC7C,IAAI,GAAG,EAAE,MAAM,KAAK,GAAG,EAAE;gBACvB,MAAM,GAAG,CAAC,CAAC,QAAQ,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,+BAAoB,CAAC,kBAAkB,CAAC,CAAC,CAAC,+BAAoB,CAAC,WAAW,CAAC,CAAC;aAChH;YACD,OAAO,EAAE,MAAM,EAAC,CAAC;SAClB;IACH,CAAC;;AA9DsB,0BAAQ,GAAG,KAAK,CAAC;AAiE1C,MAAM,kBAAmB,SAAQ,qBAAqB;IAG7C,MAAM,CAAU,qBAAqB,CAAC,QAA+B;QAC1E,OAAO,IAAI,sCAA2B,CAAC,QAAQ,CAAC,CAAC;IACnD,CAAC;IAEM,MAAM,CAAU,KAAK,CAAC,cAAc,CAAC,GAAW,EAAE,QAAiB,EAAE,QAAiB,EAAE,WAAqB;QAClH,IAAI;YACF,MAAM,SAAS,GAAuB,EAAE,CAAC;YACzC,MAAM,YAAY,GAAG,MAAM,2BAAgB,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,QAAQ,IAAI,QAAQ,CAAC,CAAC,CAAC,EAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAC,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,WAAW,CAAC,CAAC;YACtI,IAAI,CAAC,YAAY;gBACf,OAAO,EAAE,MAAM,EAAE,+BAAoB,CAAC,UAAU,EAAE,CAAC;YAErD,2FAA2F;YAC3F,IAAI,YAAY,GAAoC,EAAE,CAAC;YACvD,MAAM,aAAa,GAAG,YAAY,EAAE,QAAQ,EAAE,oCAAoC,EAAE,CAAC;YACrF,IAAI,aAAa,EAAE;gBACjB,YAAY,GAAG,aAAa,CAAC;aAC9B;YACD,MAAM,QAAQ,GAAG,YAAY,EAAE,QAAQ,EAAE,kCAAkC,EAAE,CAAC;YAC9E,IAAI,QAAQ,EAAE;gBACZ,YAAY,GAAG,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;aAC9C;YAED,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC7B,8DAA8D;gBAC9D,OAAO,EAAE,MAAM,EAAE,+BAAoB,CAAC,uBAAuB,EAAE,CAAC;aACjE;YAED,IAAI,UAAU,GAAG,CAAC,CAAC;YACnB,YAAY,EAAE,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC/C,MAAM,eAAe,GAAG,YAAY,EAAE,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE;oBACjD,OAAO,KAAK,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,KAAK,GAAG,CAAC,UAAU,CAAC,CAAC;gBACxF,CAAC,CAAC,CAAC;gBACH,IAAI,eAAe,EAAE;oBACnB,SAAS,CAAC,IAAI,CAAC;wBACb,IAAI,EAAE,KAAK,CAAC,UAAU;wBACtB,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,UAAU;wBACtC,OAAO,EAAE,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,CAAC;wBACjC,MAAM,EAAE,SAAS;wBACjB,QAAQ,EAAE,SAAS;wBACnB,EAAE,EAAE,UAAU,EAAE;qBACjB,CAAC,CAAC;iBACJ;YACH,CAAC,CAAC,CAAC;YAEH,2DAA2D;YAC3D,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC;gBACxB,OAAO,EAAE,MAAM,EAAE,+BAAoB,CAAC,eAAe,EAAE,CAAC;YAE1D,OAAO,EAAE,MAAM,EAAE,+BAAoB,CAAC,KAAK,EAAE,SAAS,EAAE,CAAC;SAC1D;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,iCAAiC;YACrD,OAAO,EAAE,MAAM,EAAE,+BAAoB,CAAC,UAAU,EAAE,CAAC;SACpD;IACH,CAAC;;AAvDsB,2BAAQ,GAAG,MAAM,CAAC;AA2D3C,MAAM,oBAAqB,SAAQ,qBAAqB;IAE/C,MAAM,CAAU,KAAK,CAAC,cAAc,CAAC,GAAW,EAAE,QAAiB,EAAE,QAAiB,EAAE,WAAqB;QAElH,MAAM,aAAa,GAAG,0BAAe,CAAC,WAAW,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;QACpE,IAAI,aAAa,KAAK,+BAAoB,CAAC,KAAK;YAC9C,OAAO,EAAC,MAAM,EAAE,aAAa,EAAC,CAAC;QAEjC,gHAAgH;QAChH,OAAO,0BAAe,CAAC,cAAc,CAAC,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;IACjG,CAAC;IACM,MAAM,CAAU,qBAAqB,CAAC,QAA+B;QAC1E,OAAO,IAAI,wCAA6B,CAAC,QAAQ,CAAC,CAAC;IACrD,CAAC;;AAZsB,6BAAQ,GAAG,QAAQ,CAAC;AAe7C,6DAA6D;AAC7D,MAAM,uBAAwB,SAAQ,qBAAqB;IAElD,MAAM,CAAU,qBAAqB,CAAC,QAA+B;QAC1E,OAAO,IAAI,wCAA6B,CAAC,QAAQ,CAAC,CAAC;IACrD,CAAC;;AAHsB,gCAAQ,GAAG,WAAW,CAAC;AAKhD,MAAM,sBAAuB,SAAQ,qBAAqB;IAEjD,MAAM,CAAU,qBAAqB,CAAC,QAA+B;QAC1E,OAAO,IAAI,uCAA4B,CAAC,QAAQ,CAAC,CAAC;IACpD,CAAC;;AAHsB,+BAAQ,GAAG,UAAU,CAAC;AAM/C,MAAM,2BAA4B,SAAQ,qBAAqB;IAEtD,MAAM,CAAU,qBAAqB,CAAC,QAA+B;QAC1E,OAAO,IAAI,qCAA0B,CAAC,QAAQ,CAAC,CAAC;IAClD,CAAC;;AAHsB,oCAAQ,GAAG,eAAe,CAAC;AAKpD,MAAM,qBAAsB,SAAQ,qBAAqB;IAEhD,MAAM,CAAU,qBAAqB,CAAC,QAA+B,IAAyC,OAAO,IAAI,iCAAsB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;;AAD5I,8BAAQ,GAAG,SAAS,CAAC;AAI9C,gBAAgB;AACH,QAAA,8BAA8B,GAAG,CAAC,iBAAiB,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,8BAA8B,CAAC,sBAAsB,EAAE,2BAA2B,EAAE,qBAAqB,CAAC,CAAC","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 MapLayers\r\n */\r\nimport { ImageMapLayerSettings, MapSubLayerProps } from \"@itwin/core-common\";\r\nimport { IModelConnection } from \"../../IModelConnection\";\r\nimport {\r\n  ArcGISMapLayerImageryProvider,\r\n  ArcGisUtilities,\r\n  AzureMapsLayerImageryProvider,\r\n  BingMapsImageryLayerProvider,\r\n  ImageryMapLayerTreeReference,\r\n  MapBoxLayerImageryProvider,\r\n  MapLayerFormat,\r\n  MapLayerImageryProvider,\r\n  MapLayerSourceStatus,\r\n  MapLayerSourceValidation,\r\n  MapLayerTileTreeReference,\r\n  TileUrlImageryProvider,\r\n  WmsCapabilities,\r\n  WmsMapLayerImageryProvider,\r\n  WmtsCapabilities,\r\n  WmtsCapability,\r\n  WmtsMapLayerImageryProvider,\r\n} from \"../internal\";\r\n\r\n/** Base class imagery map layer formats.\r\n *  Subclasses should override formatId and [[MapLayerFormat.createImageryProvider]].\r\n * @see [[MapLayerFormat]]\r\n * @beta\r\n */\r\nexport class ImageryMapLayerFormat extends MapLayerFormat {\r\n  /** @internal */\r\n  public static override createMapLayerTree(layerSettings: ImageMapLayerSettings, layerIndex: number, iModel: IModelConnection): MapLayerTileTreeReference | undefined {\r\n    return new ImageryMapLayerTreeReference({ layerSettings, layerIndex, iModel });\r\n  }\r\n}\r\n\r\nclass WmsMapLayerFormat extends ImageryMapLayerFormat {\r\n  public static override formatId = \"WMS\";\r\n\r\n  public static override createImageryProvider(settings: ImageMapLayerSettings): MapLayerImageryProvider | undefined {\r\n    return new WmsMapLayerImageryProvider(settings);\r\n  }\r\n  public static override async validateSource(url: string, userName?: string, password?: string, ignoreCache?: boolean): Promise<MapLayerSourceValidation> {\r\n    try {\r\n      let subLayers: MapSubLayerProps[] | undefined;\r\n      const maxVisibleSubLayers = 50;\r\n      const capabilities = await WmsCapabilities.create(url, (userName && password ? {user: userName, password} : undefined), ignoreCache);\r\n      if (capabilities !== undefined) {\r\n        subLayers = capabilities.getSubLayers(false);\r\n        const rootsSubLayer = subLayers?.find((sublayer) => sublayer.parent === undefined);\r\n        const hasTooManyLayers = subLayers && subLayers.length > maxVisibleSubLayers;\r\n\r\n        if (!Array.isArray(subLayers))\r\n          return { status: MapLayerSourceStatus.Valid, subLayers };\r\n\r\n        for (const subLayer of subLayers) {\r\n          // In general for WMS, we prefer to have the children of root node visible, but not the root itself.\r\n          // Thats simply to give more flexibility in the UI.\r\n          // Two exceptions to this rule: If there are too many layers or the root node is not named.\r\n          if (subLayer.id && subLayer.id === rootsSubLayer?.id\r\n            && (!(subLayer.name && subLayer.name.length > 0) || hasTooManyLayers)) {\r\n            subLayer.visible = true;\r\n            break;  // if root node is visible, don't bother turning ON any other layers\r\n          }\r\n\r\n          // Make children of the root node visible.\r\n          if (subLayer.parent && subLayer.parent === rootsSubLayer?.id && !hasTooManyLayers) {\r\n            const isUnnamedGroup = (layer: MapSubLayerProps) => {\r\n              return layer.children && layer.children.length > 0 && (!layer.name || layer.name.length === 0);\r\n            };\r\n\r\n            const makeChildrenVisible = (layers: MapSubLayerProps[] | undefined, layer: MapSubLayerProps) => {\r\n              layer?.children?.forEach((childId) => {\r\n                const childSubLayer = subLayers?.find((child) => child?.id === childId);\r\n                if (childSubLayer) {\r\n                  childSubLayer.visible = true;\r\n                  if (isUnnamedGroup(childSubLayer))\r\n                    makeChildrenVisible(layers, childSubLayer);\r\n                }\r\n              });\r\n            };\r\n\r\n            subLayer.visible = true;\r\n\r\n            // If we got a unnamed group, make children visible recursively until we have a leaf or named group\r\n            if (isUnnamedGroup(subLayer))\r\n              makeChildrenVisible(subLayers, subLayer);\r\n          }\r\n        }\r\n      }\r\n\r\n      return { status: MapLayerSourceStatus.Valid, subLayers };\r\n    } catch (err: any) {\r\n      let status = MapLayerSourceStatus.InvalidUrl;\r\n      if (err?.status === 401) {\r\n        status = ((userName && password) ? MapLayerSourceStatus.InvalidCredentials : MapLayerSourceStatus.RequireAuth);\r\n      }\r\n      return { status};\r\n    }\r\n  }\r\n}\r\n\r\nclass WmtsMapLayerFormat extends ImageryMapLayerFormat {\r\n  public static override formatId = \"WMTS\";\r\n\r\n  public static override createImageryProvider(settings: ImageMapLayerSettings): MapLayerImageryProvider | undefined {\r\n    return new WmtsMapLayerImageryProvider(settings);\r\n  }\r\n\r\n  public static override async validateSource(url: string, userName?: string, password?: string, ignoreCache?: boolean): Promise<MapLayerSourceValidation> {\r\n    try {\r\n      const subLayers: MapSubLayerProps[] = [];\r\n      const capabilities = await WmtsCapabilities.create(url, (userName && password ? {user: userName, password} : undefined), ignoreCache);\r\n      if (!capabilities)\r\n        return { status: MapLayerSourceStatus.InvalidUrl };\r\n\r\n      // Only returns layer that can be published in the Google maps or WGS84 aligned tile trees.\r\n      let supportedTms: WmtsCapability.TileMatrixSet[]  = [];\r\n      const googleMapsTms = capabilities?.contents?.getGoogleMapsCompatibleTileMatrixSet();\r\n      if (googleMapsTms) {\r\n        supportedTms = googleMapsTms;\r\n      }\r\n      const wsg84Tms = capabilities?.contents?.getEpsg4326CompatibleTileMatrixSet();\r\n      if (wsg84Tms) {\r\n        supportedTms = supportedTms.concat(wsg84Tms);\r\n      }\r\n\r\n      if (supportedTms.length === 0) {\r\n        // This WMTS server doesn't support either GoogleMaps or WSG84\r\n        return { status: MapLayerSourceStatus.InvalidCoordinateSystem };\r\n      }\r\n\r\n      let subLayerId = 0;\r\n      capabilities?.contents?.layers.forEach((layer) => {\r\n        const hasSupportedTms = supportedTms?.some((tms) => {\r\n          return layer.tileMatrixSetLinks.some((tmls) => tmls.tileMatrixSet === tms.identifier);\r\n        });\r\n        if (hasSupportedTms) {\r\n          subLayers.push({\r\n            name: layer.identifier,\r\n            title: layer.title ?? layer.identifier,\r\n            visible: (subLayers.length === 0),   // Make the first layer visible.\r\n            parent: undefined,\r\n            children: undefined,\r\n            id: subLayerId++,\r\n          });\r\n        }\r\n      });\r\n\r\n      // Return error if we could find a single compatible layer.\r\n      if (subLayers.length === 0)\r\n        return { status: MapLayerSourceStatus.InvalidTileTree };\r\n\r\n      return { status: MapLayerSourceStatus.Valid, subLayers };\r\n    } catch (err) {\r\n      console.error(err); // eslint-disable-line no-console\r\n      return { status: MapLayerSourceStatus.InvalidUrl };\r\n    }\r\n  }\r\n\r\n}\r\n\r\nclass ArcGISMapLayerFormat extends ImageryMapLayerFormat {\r\n  public static override formatId = \"ArcGIS\";\r\n  public static override async validateSource(url: string, userName?: string, password?: string, ignoreCache?: boolean): Promise<MapLayerSourceValidation> {\r\n\r\n    const urlValidation = ArcGisUtilities.validateUrl(url, \"MapServer\");\r\n    if (urlValidation !== MapLayerSourceStatus.Valid)\r\n      return {status: urlValidation};\r\n\r\n    // Some Map service supporting only tiles don't include the 'Map' capabilities, thus we can't make it mandatory.\r\n    return ArcGisUtilities.validateSource(url, this.formatId, [], userName, password, ignoreCache);\r\n  }\r\n  public static override createImageryProvider(settings: ImageMapLayerSettings): MapLayerImageryProvider | undefined {\r\n    return new ArcGISMapLayerImageryProvider(settings);\r\n  }\r\n}\r\n\r\n// eslint-disable-next-line @typescript-eslint/no-unused-vars\r\nclass AzureMapsMapLayerFormat extends ImageryMapLayerFormat {\r\n  public static override formatId = \"AzureMaps\";\r\n  public static override createImageryProvider(settings: ImageMapLayerSettings): MapLayerImageryProvider | undefined {\r\n    return new AzureMapsLayerImageryProvider(settings);\r\n  }\r\n}\r\nclass BingMapsMapLayerFormat extends ImageryMapLayerFormat {\r\n  public static override formatId = \"BingMaps\";\r\n  public static override createImageryProvider(settings: ImageMapLayerSettings): MapLayerImageryProvider | undefined {\r\n    return new BingMapsImageryLayerProvider(settings);\r\n  }\r\n}\r\n\r\nclass MapBoxImageryMapLayerFormat extends ImageryMapLayerFormat {\r\n  public static override formatId = \"MapboxImagery\";\r\n  public static override createImageryProvider(settings: ImageMapLayerSettings): MapLayerImageryProvider | undefined {\r\n    return new MapBoxLayerImageryProvider(settings);\r\n  }\r\n}\r\nclass TileUrlMapLayerFormat extends ImageryMapLayerFormat {\r\n  public static override formatId = \"TileURL\";\r\n  public static override createImageryProvider(settings: ImageMapLayerSettings): MapLayerImageryProvider | undefined { return new TileUrlImageryProvider(settings); }\r\n}\r\n\r\n/** @internal */\r\nexport const internalMapLayerImageryFormats = [WmsMapLayerFormat, WmtsMapLayerFormat, ArcGISMapLayerFormat, /* AzureMapsMapLayerFormat, */ BingMapsMapLayerFormat, MapBoxImageryMapLayerFormat, TileUrlMapLayerFormat];\r\n"]}

package/lib/cjs/tile/map/MapLayerImageryProvider.d.ts

@@ -45,18 +45,32 @@ export declare abstract class MapLayerImageryProvider {
     /** @internal */
     get useGeographicTilingScheme(): boolean;
     cartoRange?: MapCartoRectangle;
-    /** @internal */
+    /**
+     * This value is used internally for various computations, this should not get overriden.
+     * @internal
+     */
     protected readonly defaultMinimumZoomLevel = 0;
-    /** @internal */
+    /**
+     * This value is used internally for various computations, this should not get overriden.
+     * @internal
+     */
     protected readonly defaultMaximumZoomLevel = 22;
     /** @internal */
     protected get _filterByCartoRange(): boolean;
     constructor(_settings: ImageMapLayerSettings, _usesCachedTiles: boolean);
-    /** @internal */
+    /**
+     * Initialize the provider by loading the first tile at its default maximum zoom level.
+     * @beta
+     */
     initialize(): Promise<void>;
     abstract constructUrl(row: number, column: number, zoomLevel: number): Promise<string>;
     get tilingScheme(): MapTilingScheme;
-    /** @internal */
+    /**
+     * Add attribution logo cards for the data supplied by this provider to the [[Viewport]]'s logo div.
+     * @param _cards Logo cards HTML element that may contain custom data attributes.
+     * @param _viewport Viewport to add logo cards to.
+     * @beta
+     */
     addLogoCards(_cards: HTMLTableElement, _viewport: ScreenViewport): void;
     /** @internal */
     protected _missingTileData?: Uint8Array;
@@ -65,18 +79,32 @@ export declare abstract class MapLayerImageryProvider {
     /** @internal */
     protected _areChildrenAvailable(_tile: ImageryMapTile): Promise<boolean>;
     /** @internal */
-    getPotentialChildIds(tile: ImageryMapTile): QuadId[];
-    /** @internal */
-    protected _generateChildIds(tile: ImageryMapTile, resolveChildren: (childIds: QuadId[]) => void): void;
+    getPotentialChildIds(quadId: QuadId): QuadId[];
+    /**
+     * Get child IDs of a quad and generate tiles based on these child IDs.
+     * See [[ImageryTileTree._loadChildren]] for the definition of `resolveChildren` where this function is commonly called.
+     * @param quadId quad to generate child IDs for.
+     * @param resolveChildren Function that creates tiles from child IDs.
+     * @beta
+     */
+    protected _generateChildIds(quadId: QuadId, resolveChildren: (childIds: QuadId[]) => void): void;
     /** @internal */
     generateChildIds(tile: ImageryMapTile, resolveChildren: (childIds: QuadId[]) => void): void;
-    /** @internal */
+    /**
+     * Get tooltip text for a specific quad and cartographic position.
+     * @param strings List of strings to contain tooltip text.
+     * @param quadId Quad ID to get tooltip for.
+     * @param _carto Cartographic that may be used to retrieve and/or format tooltip text.
+     * @param tree Tree associated with the quad to get the tooltip for.
+     * @internal
+     */
     getToolTip(strings: string[], quadId: QuadId, _carto: Cartographic, tree: ImageryMapTileTree): Promise<void>;
     /** @internal */
     getFeatureInfo(featureInfos: MapLayerFeatureInfo[], _quadId: QuadId, _carto: Cartographic, _tree: ImageryMapTileTree, _hit: HitDetail, _options?: MapFeatureInfoOptions): Promise<void>;
     /** @internal */
     protected getImageFromTileResponse(tileResponse: Response, zoomLevel: number): Promise<ImageSource | undefined>;
-    /** Change the status of this provider.
+    /**
+     * Change the status of this provider.
      * Sub-classes should override 'onStatusUpdated' instead of this method.
      * @internal
      */
@@ -95,22 +123,52 @@ export declare abstract class MapLayerImageryProvider {
     protected toolTipFromUrl(strings: string[], url: string): Promise<void>;
     /** @internal */
     matchesMissingTile(tileData: Uint8Array): boolean;
-    /** @internal */
+    /**
+     * Calculates the projected x cartesian coordinate in EPSG:3857 from the longitude in EPSG:4326 (WGS84)
+     * @param longitude Longitude in EPSG:4326 (WGS84)
+     * @internal
+     */
     getEPSG3857X(longitude: number): number;
-    /** @internal */
+    /**
+     * Calculates the projected y cartesian coordinate in EPSG:3857 from the latitude in EPSG:4326 (WGS84)
+     * @param latitude Latitude in EPSG:4326 (WGS84)
+     * @internal
+     */
     getEPSG3857Y(latitude: number): number;
-    /** @internal */
+    /**
+     * Calculates the longitude in EPSG:4326 (WGS84) from the projected x cartesian coordinate in EPSG:3857
+     * @param x3857 Projected x cartesian coordinate in EPSG:3857
+     * @internal
+     */
     getEPSG4326Lon(x3857: number): number;
-    /** @internal */
+    /**
+     * Calculates the latitude in EPSG:4326 (WGS84) from the projected y cartesian coordinate in EPSG:3857
+     * @param y3857 Projected y cartesian coordinate in EPSG:3857
+     * @internal
+     */
     getEPSG4326Lat(y3857: number): number;
-    /** @internal */
+    /**
+     * Get the bounding box/extents of a tile in EPSG:4326 (WGS84) format.
+     * Map tile providers like Bing and Mapbox allow the URL to be constructed directly from the zoom level and tile coordinates.
+     * However, WMS-based servers take a bounding box instead. This method can help get that bounding box from a tile.
+     * @param row Row of the tile
+     * @param column Column of the tile
+     * @param zoomLevel Desired zoom level of the tile
+     * @internal
+     */
     getEPSG4326Extent(row: number, column: number, zoomLevel: number): {
         longitudeLeft: number;
         longitudeRight: number;
         latitudeTop: number;
         latitudeBottom: number;
     };
-    /** @internal */
+    /**
+     * Get the bounding box/extents of a tile in EPSG:3857 format.
+     * @param row Row of the tile
+     * @param column Column of the tile
+     * @param zoomLevel Desired zoom level of the tile
+     * @internal
+     */
     getEPSG3857Extent(row: number, column: number, zoomLevel: number): {
         left: number;
         right: number;

package/lib/cjs/tile/map/MapLayerImageryProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MapLayerImageryProvider.d.ts","sourceRoot":"","sources":["../../../../src/tile/map/MapLayerImageryProvider.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAU,OAAO,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAuB,YAAY,EAAE,qBAAqB,EAAE,WAAW,EAAqB,MAAM,oBAAoB,CAAC;AAI9H,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAA0B,cAAc,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,EAA2B,MAAM,aAAa,CAAC;AAC1M,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAO5C;;GAEG;AACH,oBAAY,6BAA6B;IACvC,KAAK,IAAA;IACL,WAAW,IAAA;CACZ;AAED;;;GAGG;AACH,8BAAsB,uBAAuB;IAmD/B,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,qBAAqB;IAAE,SAAS,CAAC,gBAAgB,EAAE,OAAO;IAlDpG,SAAS,CAAC,2BAA2B,UAAS;IAC9C,SAAgB,eAAe,qBAA0B,uBAAuB,KAAK,IAAI,EAAI;IAE7F,gBAAgB;IAChB,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAiC;IAEvE,gBAAgB;IAChB,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAAgC;IAExE,gBAAgB;IAChB,OAAO,CAAC,OAAO,CAAuC;IAEtD,gBAAgB;IAChB,IAAW,MAAM,kCAA2B;IAE5C,aAAa;IACb,IAAW,sBAAsB,YAAoB;IAE9C,WAAW;IAElB,gBAAgB;IAChB,IAAW,QAAQ,IAAI,MAAM,CAAqE;IAElG,gBAAgB;IAChB,IAAW,iBAAiB,WAAgC;IAE5D,IAAW,gBAAgB,IAAI,MAAM,CAAyC;IAE9E,IAAW,gBAAgB,IAAI,MAAM,CAAyC;IAE9E,gBAAgB;IAChB,IAAW,eAAe,YAAoC;IAE9D,IAAW,uBAAuB,IAAI,OAAO,CAAkB;IAE/D,gBAAgB;IAChB,IAAW,yBAAyB,YAAoB;IAEjD,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAGtC,gBAAgB;IAChB,SAAS,CAAC,QAAQ,CAAC,uBAAuB,KAAK;IAE/C,gBAAgB;IAChB,SAAS,CAAC,QAAQ,CAAC,uBAAuB,MAAM;IAEhD,gBAAgB;IAChB,SAAS,KAAK,mBAAmB,YAAmB;gBAErB,SAAS,EAAE,qBAAqB,EAAY,gBAAgB,EAAE,OAAO;IAKpG,gBAAgB;IACH,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;aAOxB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAE7F,IAAW,YAAY,IAAI,eAAe,CAAuG;IAEjJ,gBAAgB;IACT,YAAY,CAAC,MAAM,EAAE,gBAAgB,EAAE,SAAS,EAAE,cAAc,GAAG,IAAI;IAE9E,gBAAgB;IAChB,SAAS,CAAC,gBAAgB,CAAC,EAAE,UAAU,CAAC;IAExC,gBAAgB;IAChB,IAAW,2BAA2B,IAAI,MAAM,CAAoE;IAEpH,gBAAgB;cACA,qBAAqB,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAE9E,gBAAgB;IACT,oBAAoB,CAAC,IAAI,EAAE,cAAc,GAAG,MAAM,EAAE;IAK3D,gBAAgB;IAChB,SAAS,CAAC,iBAAiB,CAAC,IAAI,EAAE,cAAc,EAAE,eAAe,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,IAAI;IAI/F,gBAAgB;IACT,gBAAgB,CAAC,IAAI,EAAE,cAAc,EAAE,eAAe,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,IAAI;IAQ3F,gBAAgB;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAOzH,gBAAgB;IACH,cAAc,CAAC,YAAY,EAAE,mBAAmB,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,kBAAkB,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAKpM,gBAAgB;cACA,wBAAwB,CAAC,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM;IA0BlF;;;OAGG;IACI,SAAS,CAAC,MAAM,EAAE,6BAA6B;IAQtD;;OAEG;IACH,SAAS,CAAC,eAAe,CAAC,UAAU,EAAE,6BAA6B;IAEnE,gBAAgB;IAChB,SAAS,CAAC,uBAAuB,CAAC,OAAO,EAAE,OAAO;IAMlD,gBAAgB;IACH,eAAe,CAAC,GAAG,EAAE,MAAM;IASxC,0DAA0D;IAC7C,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;IA+BvG,gBAAgB;cACA,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAc7E,gBAAgB;IACT,kBAAkB,CAAC,QAAQ,EAAE,UAAU,GAAG,OAAO;IAaxD,gBAAgB;IAET,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM;IAI9C,gBAAgB;IAET,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAK7C,gBAAgB;IAET,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAI5C,gBAAgB;IAET,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAK5C,gBAAgB;IAGT,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG;QAAE,aAAa,EAAE,MAAM,CAAC;QAAC,cAAc,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC;QAAC,cAAc,EAAE,MAAM,CAAA;KAAE;IAkBxK,gBAAgB;IACT,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE;IAWtI,gBAAgB;IACT,uBAAuB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;IAK7E,gBAAgB;IACT,uBAAuB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,mBAAmB,EAAE,OAAO;CAU5G"}
+{"version":3,"file":"MapLayerImageryProvider.d.ts","sourceRoot":"","sources":["../../../../src/tile/map/MapLayerImageryProvider.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAU,OAAO,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAuB,YAAY,EAAE,qBAAqB,EAAE,WAAW,EAAqB,MAAM,oBAAoB,CAAC;AAI9H,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAA0B,cAAc,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,EAA2B,MAAM,aAAa,CAAC;AAC1M,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAO5C;;GAEG;AACH,oBAAY,6BAA6B;IACvC,KAAK,IAAA;IACL,WAAW,IAAA;CACZ;AAED;;;GAGG;AACH,8BAAsB,uBAAuB;IAwD/B,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,qBAAqB;IAAE,SAAS,CAAC,gBAAgB,EAAE,OAAO;IAvDpG,SAAS,CAAC,2BAA2B,UAAS;IAC9C,SAAgB,eAAe,qBAA0B,uBAAuB,KAAK,IAAI,EAAI;IAE7F,gBAAgB;IAChB,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAiC;IAEvE,gBAAgB;IAChB,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAAgC;IAExE,gBAAgB;IAChB,OAAO,CAAC,OAAO,CAAuC;IAEtD,gBAAgB;IAChB,IAAW,MAAM,kCAA2B;IAE5C,aAAa;IACb,IAAW,sBAAsB,YAAoB;IAE9C,WAAW;IAElB,gBAAgB;IAChB,IAAW,QAAQ,IAAI,MAAM,CAAqE;IAElG,gBAAgB;IAChB,IAAW,iBAAiB,WAAgC;IAE5D,IAAW,gBAAgB,IAAI,MAAM,CAAyC;IAE9E,IAAW,gBAAgB,IAAI,MAAM,CAAyC;IAE9E,gBAAgB;IAChB,IAAW,eAAe,YAAoC;IAE9D,IAAW,uBAAuB,IAAI,OAAO,CAAkB;IAE/D,gBAAgB;IAChB,IAAW,yBAAyB,YAAoB;IAEjD,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAEtC;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,uBAAuB,KAAK;IAE/C;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,uBAAuB,MAAM;IAEhD,gBAAgB;IAChB,SAAS,KAAK,mBAAmB,YAAmB;gBAErB,SAAS,EAAE,qBAAqB,EAAY,gBAAgB,EAAE,OAAO;IAKpG;;;OAGG;IACU,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;aAOxB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAE7F,IAAW,YAAY,IAAI,eAAe,CAAuG;IAEjJ;;;;;OAKG;IACI,YAAY,CAAC,MAAM,EAAE,gBAAgB,EAAE,SAAS,EAAE,cAAc,GAAG,IAAI;IAE9E,gBAAgB;IAChB,SAAS,CAAC,gBAAgB,CAAC,EAAE,UAAU,CAAC;IAExC,gBAAgB;IAChB,IAAW,2BAA2B,IAAI,MAAM,CAAoE;IAEpH,gBAAgB;cACA,qBAAqB,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAE9E,gBAAgB;IACT,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE;IAKrD;;;;;;OAMG;IACH,SAAS,CAAC,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,IAAI;IAIzF,gBAAgB;IACT,gBAAgB,CAAC,IAAI,EAAE,cAAc,EAAE,eAAe,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,IAAI;IAQ3F;;;;;;;OAOG;IACU,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAOzH,gBAAgB;IACH,cAAc,CAAC,YAAY,EAAE,mBAAmB,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,kBAAkB,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAKpM,gBAAgB;cACA,wBAAwB,CAAC,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM;IA0BlF;;;;OAIG;IACI,SAAS,CAAC,MAAM,EAAE,6BAA6B;IAQtD;;OAEG;IACH,SAAS,CAAC,eAAe,CAAC,UAAU,EAAE,6BAA6B;IAEnE,gBAAgB;IAChB,SAAS,CAAC,uBAAuB,CAAC,OAAO,EAAE,OAAO;IAMlD,gBAAgB;IACH,eAAe,CAAC,GAAG,EAAE,MAAM;IASxC,0DAA0D;IAC7C,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;IA+BvG,gBAAgB;cACA,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAc7E,gBAAgB;IACT,kBAAkB,CAAC,QAAQ,EAAE,UAAU,GAAG,OAAO;IAaxD;;;;OAIG;IACI,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM;IAI9C;;;;OAIG;IACI,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAK7C;;;;OAIG;IACI,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAI5C;;;;OAIG;IACI,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAK5C;;;;;;;;OAQG;IACI,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG;QAAE,aAAa,EAAE,MAAM,CAAC;QAAC,cAAc,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC;QAAC,cAAc,EAAE,MAAM,CAAA;KAAE;IAkBxK;;;;;;OAMG;IACI,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE;IAWtI,gBAAgB;IACT,uBAAuB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;IAK7E,gBAAgB;IACT,uBAAuB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,mBAAmB,EAAE,OAAO;CAU5G"}

package/lib/cjs/tile/map/MapLayerImageryProvider.js

@@ -60,15 +60,23 @@ class MapLayerImageryProvider {
         this._geographicTilingScheme = new internal_1.GeographicTilingScheme();
         /** @internal */
         this._status = MapLayerImageryProviderStatus.Valid;
-        // Those values are used internally for various computation, this should not get overriden.
-        /** @internal */
+        /**
+         * This value is used internally for various computations, this should not get overriden.
+         * @internal
+         */
         this.defaultMinimumZoomLevel = 0;
-        /** @internal */
+        /**
+         * This value is used internally for various computations, this should not get overriden.
+         * @internal
+         */
         this.defaultMaximumZoomLevel = 22;
         this._mercatorTilingScheme = new internal_1.WebMercatorTilingScheme();
         this._geographicTilingScheme = new internal_1.GeographicTilingScheme(2, 1, true);
     }
-    /** @internal */
+    /**
+     * Initialize the provider by loading the first tile at its default maximum zoom level.
+     * @beta
+     */
     async initialize() {
         this.loadTile(0, 0, this.defaultMaximumZoomLevel).then((tileData) => {
             if (tileData !== undefined)
@@ -76,20 +84,31 @@ class MapLayerImageryProvider {
         });
     }
     get tilingScheme() { return this.useGeographicTilingScheme ? this._geographicTilingScheme : this._mercatorTilingScheme; }
-    /** @internal */
+    /**
+     * Add attribution logo cards for the data supplied by this provider to the [[Viewport]]'s logo div.
+     * @param _cards Logo cards HTML element that may contain custom data attributes.
+     * @param _viewport Viewport to add logo cards to.
+     * @beta
+     */
     addLogoCards(_cards, _viewport) { }
     /** @internal */
     get transparentBackgroundString() { return this._settings.transparentBackground ? "true" : "false"; }
     /** @internal */
     async _areChildrenAvailable(_tile) { return true; }
     /** @internal */
-    getPotentialChildIds(tile) {
-        const childLevel = tile.quadId.level + 1;
-        return tile.quadId.getChildIds(this.tilingScheme.getNumberOfXChildrenAtLevel(childLevel), this.tilingScheme.getNumberOfYChildrenAtLevel(childLevel));
+    getPotentialChildIds(quadId) {
+        const childLevel = quadId.level + 1;
+        return quadId.getChildIds(this.tilingScheme.getNumberOfXChildrenAtLevel(childLevel), this.tilingScheme.getNumberOfYChildrenAtLevel(childLevel));
     }
-    /** @internal */
-    _generateChildIds(tile, resolveChildren) {
-        resolveChildren(this.getPotentialChildIds(tile));
+    /**
+     * Get child IDs of a quad and generate tiles based on these child IDs.
+     * See [[ImageryTileTree._loadChildren]] for the definition of `resolveChildren` where this function is commonly called.
+     * @param quadId quad to generate child IDs for.
+     * @param resolveChildren Function that creates tiles from child IDs.
+     * @beta
+     */
+    _generateChildIds(quadId, resolveChildren) {
+        resolveChildren(this.getPotentialChildIds(quadId));
     }
     /** @internal */
     generateChildIds(tile, resolveChildren) {
@@ -97,9 +116,16 @@ class MapLayerImageryProvider {
             tile.setLeaf();
             return;
         }
-        this._generateChildIds(tile, resolveChildren);
+        this._generateChildIds(tile.quadId, resolveChildren);
     }
-    /** @internal */
+    /**
+     * Get tooltip text for a specific quad and cartographic position.
+     * @param strings List of strings to contain tooltip text.
+     * @param quadId Quad ID to get tooltip for.
+     * @param _carto Cartographic that may be used to retrieve and/or format tooltip text.
+     * @param tree Tree associated with the quad to get the tooltip for.
+     * @internal
+     */
     async getToolTip(strings, quadId, _carto, tree) {
         if (doDebugToolTips) {
             const range = quadId.getLatLongRangeDegrees(tree.tilingScheme);
@@ -134,7 +160,8 @@ class MapLayerImageryProvider {
         (0, core_bentley_1.assert)(false, "Invalid tile content type");
         return undefined;
     }
-    /** Change the status of this provider.
+    /**
+     * Change the status of this provider.
      * Sub-classes should override 'onStatusUpdated' instead of this method.
      * @internal
      */
@@ -217,31 +244,49 @@ class MapLayerImageryProvider {
         }
         return true;
     }
-    /** @internal */
-    // calculates the projected x cartesian coordinate in EPSG:3857from the longitude in EPSG:4326 (WGS84)
+    /**
+     * Calculates the projected x cartesian coordinate in EPSG:3857 from the longitude in EPSG:4326 (WGS84)
+     * @param longitude Longitude in EPSG:4326 (WGS84)
+     * @internal
+     */
     getEPSG3857X(longitude) {
         return longitude * 20037508.34 / 180.0;
     }
-    /** @internal */
-    // calculates the projected y cartesian coordinate in EPSG:3857from the latitude in EPSG:4326 (WGS84)
+    /**
+     * Calculates the projected y cartesian coordinate in EPSG:3857 from the latitude in EPSG:4326 (WGS84)
+     * @param latitude Latitude in EPSG:4326 (WGS84)
+     * @internal
+     */
     getEPSG3857Y(latitude) {
         const y = Math.log(Math.tan((90.0 + latitude) * Math.PI / 360.0)) / (Math.PI / 180.0);
         return y * 20037508.34 / 180.0;
     }
-    /** @internal */
-    // calculates the longitude in EPSG:4326 (WGS84) from the projected x cartesian coordinate in EPSG:3857
+    /**
+     * Calculates the longitude in EPSG:4326 (WGS84) from the projected x cartesian coordinate in EPSG:3857
+     * @param x3857 Projected x cartesian coordinate in EPSG:3857
+     * @internal
+     */
     getEPSG4326Lon(x3857) {
         return core_geometry_1.Angle.radiansToDegrees(x3857 / earthRadius);
     }
-    /** @internal */
-    // calculates the latitude in EPSG:4326 (WGS84) from the projected y cartesian coordinate in EPSG:3857
+    /**
+     * Calculates the latitude in EPSG:4326 (WGS84) from the projected y cartesian coordinate in EPSG:3857
+     * @param y3857 Projected y cartesian coordinate in EPSG:3857
+     * @internal
+     */
     getEPSG4326Lat(y3857) {
         const y = 2 * Math.atan(Math.exp(y3857 / earthRadius)) - (Math.PI / 2);
         return core_geometry_1.Angle.radiansToDegrees(y);
     }
-    /** @internal */
-    // Map tile providers like Bing and Mapbox allow the URL to be constructed directory from the zoom level and tile coordinates.
-    // However, WMS-based servers take a bounding box instead. This method can help get that bounding box from a tile.
+    /**
+     * Get the bounding box/extents of a tile in EPSG:4326 (WGS84) format.
+     * Map tile providers like Bing and Mapbox allow the URL to be constructed directly from the zoom level and tile coordinates.
+     * However, WMS-based servers take a bounding box instead. This method can help get that bounding box from a tile.
+     * @param row Row of the tile
+     * @param column Column of the tile
+     * @param zoomLevel Desired zoom level of the tile
+     * @internal
+     */
     getEPSG4326Extent(row, column, zoomLevel) {
         // Shift left (this.tileSize << zoomLevel) overflow when using 512 pixels tile at higher resolution,
         // so use Math.pow instead (I assume the performance lost to be minimal)
@@ -256,7 +301,13 @@ class MapLayerImageryProvider {
         const latitudeTop = 90.0 - 360.0 * Math.atan(Math.exp(-y1 * 2 * Math.PI)) / Math.PI;
         return { longitudeLeft, longitudeRight, latitudeTop, latitudeBottom };
     }
-    /** @internal */
+    /**
+     * Get the bounding box/extents of a tile in EPSG:3857 format.
+     * @param row Row of the tile
+     * @param column Column of the tile
+     * @param zoomLevel Desired zoom level of the tile
+     * @internal
+     */
     getEPSG3857Extent(row, column, zoomLevel) {
         const epsg4326Extent = this.getEPSG4326Extent(row, column, zoomLevel);
         const left = this.getEPSG3857X(epsg4326Extent.longitudeLeft);