@itwin/core-common 3.0.0-extension.0 → 3.1.0-dev.5

package/lib/cjs/Localization.js.map

@@ -1 +1 @@
-{"version":3,"file":"Localization.js","sourceRoot":"","sources":["../../src/Localization.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAkGH;;GAEG;AACH,MAAa,iBAAiB;IACrB,KAAK,CAAC,UAAU,KAAoB,CAAC;IACrC,kBAAkB,CAAC,GAAsB,IAAY,OAAO,OAAO,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACtG,+BAA+B,CAAC,UAAkB,EAAE,GAAsB,IAAY,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAC5H,gBAAgB,CAAC,UAAkB,EAAE,GAAsB,IAAY,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAC7G,gBAAgB,CAAC,WAAmB,IAAY,OAAO,WAAW,CAAC,CAAC,CAAC;IACrE,KAAK,CAAC,iBAAiB,KAAoB,CAAC;IAC5C,mBAAmB,KAAW,CAAC;IAC/B,mBAAmB,KAAgC,OAAO,SAAS,CAAC,CAAC,CAAC;IACtE,eAAe,KAAwB,OAAO,EAAE,CAAC,CAAC,CAAC;IACnD,KAAK,CAAC,cAAc,KAAK,CAAC;CAClC;AAXD,8CAWC","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 Localization\r\n */\r\n\r\n/** Options for Localization\r\n * @public\r\n */\r\ninterface LocalizationOptions {\r\n  /** for interpolation values */\r\n  [key: string]: any;\r\n  /**\r\n   * defaultValue to return if a translation was not found\r\n   */\r\n  defaultValue?: any;\r\n  /**\r\n   * count value used for plurals\r\n   */\r\n  count?: number;\r\n  /**\r\n   * used for contexts (eg. male\\female)\r\n   */\r\n  context?: any;\r\n  /**\r\n   * override languages to use\r\n   */\r\n  lngs?: string[];\r\n  /**\r\n   * override language to lookup key if not found see fallbacks for details\r\n   */\r\n  fallbackLng?: string;\r\n}\r\n\r\n/** The interface defining the localization requirements of [IModelApp]($frontend).\r\n * @public\r\n */\r\nexport interface Localization {\r\n  /** This method must be called and awaited before using an instance of Localization.\r\n   * @param namespaces an array of namespaces to load. There must be at least one namespace, and it\r\n   * becomes the default namespace.\r\n   * @note IModelApp.startup calls this internally, so you should not call this method directly\r\n   * except for Localization instances outside of IModelApp (e.g., for tests.)\r\n   */\r\n  initialize(namespaces: string[]): Promise<void>;\r\n\r\n  /** Return the translated value of a key.\r\n   * @param key - the key that matches a property in the JSON localization file.\r\n   * @note The key includes the namespace, which identifies the particular localization file that contains the property,\r\n   * followed by a colon, followed by the property in the JSON file.\r\n   * For example:\r\n   * ``` ts\r\n   * const dataString: string = IModelApp.localization.getLocalizedString(\"iModelJs:BackgroundMap.BingDataAttribution\");\r\n   *  ```\r\n   * assigns to dataString the string with property BackgroundMap.BingDataAttribution from the iModelJs.json localization file.\r\n   * @returns The string corresponding to the first key that resolves.\r\n   * @throws Error if no keys resolve to a string.\r\n   */\r\n  getLocalizedString(key: string | string[], options?: LocalizationOptions): string;\r\n  /** Similar to 'translate()' but the namespace is a separate param and the key does not include the namespace.\r\n   * @param namespace - the namespace that identifies the particular localization file that contains the property.\r\n   * @param key - the key that matches a property in the JSON localization file.\r\n   * @returns The string corresponding to the first key that resolves.\r\n   * @throws Error if no keys resolve to a string.\r\n   */\r\n  getLocalizedStringWithNamespace(namespace: string, key: string | string[], options?: LocalizationOptions): string;\r\n  /** get the English string for a key. */\r\n  getEnglishString(namespace: string, key: string | string[], options?: LocalizationOptions): string;\r\n  /** Replace all instances of `%{key}` within a string with the translations of those keys.\r\n   * For example:\r\n   * ``` ts\r\n   * \"MyKeys\": {\r\n   *   \"Key1\": \"First value\",\r\n   *   \"Key2\": \"Second value\"\r\n   *  }\r\n   * ```\r\n   *\r\n   * ``` ts\r\n   * getLocalizedKeys(\"string with %{MyKeys.Key1} followed by %{MyKeys.Key2}!\"\") // returns \"string with First Value followed by Second Value!\"\r\n   * ```\r\n   */\r\n  getLocalizedKeys(inputString: string): string;\r\n\r\n  /** Register a new Namespace and return a Promise that is fulfilled when the content is loaded.\r\n   * If the namespace is already registered, its Promise will be returned.\r\n   * @param name - the name of the namespace.\r\n   * @note - The registerNamespace method starts fetching the appropriate version of the JSON localization file from the server,\r\n   * based on the current locale. To make sure that fetch is complete before performing translations from this namespace, await\r\n   * fulfillment of returned Promise.\r\n   * @see [Localization in iTwin.js]($docs/learning/frontend/Localization.md)\r\n   */\r\n  registerNamespace(namespace: string): Promise<void>;\r\n  /** @internal */\r\n  unregisterNamespace(namespace: string): void;\r\n  /** @internal */\r\n  getNamespacePromise(name: string): Promise<void> | undefined;\r\n  /** Get the list of available languages for translations */\r\n  getLanguageList(): readonly string[];\r\n  /** Change the language for translations. This overrides the language from the browser, for tests. */\r\n  changeLanguage(language: string): Promise<void>;\r\n}\r\n\r\n/** An empty [[Localization]] used if one is not provided to [IModelApp]($frontend). Does not perform localizations (merely returns the key.)\r\n * @public\r\n */\r\nexport class EmptyLocalization implements Localization {\r\n  public async initialize(): Promise<void> { }\r\n  public getLocalizedString(key: string | string[]): string { return typeof (key) == \"string\" ? key : key[0]; }\r\n  public getLocalizedStringWithNamespace(_namespace: string, key: string | string[]): string { return this.getLocalizedString(key); }\r\n  public getEnglishString(_namespace: string, key: string | string[]): string { return this.getLocalizedString(key); }\r\n  public getLocalizedKeys(inputString: string): string { return inputString; }\r\n  public async registerNamespace(): Promise<void> { }\r\n  public unregisterNamespace(): void { }\r\n  public getNamespacePromise(): Promise<void> | undefined { return undefined; }\r\n  public getLanguageList(): readonly string[] { return []; }\r\n  public async changeLanguage() { }\r\n}\r\n"]}
+{"version":3,"file":"Localization.js","sourceRoot":"","sources":["../../src/Localization.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAkGH;;GAEG;AACH,MAAa,iBAAiB;IACrB,KAAK,CAAC,UAAU,KAAoB,CAAC;IACrC,kBAAkB,CAAC,GAAsB,IAAY,OAAO,OAAO,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACtG,+BAA+B,CAAC,UAAkB,EAAE,GAAsB,IAAY,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAC5H,gBAAgB,CAAC,UAAkB,EAAE,GAAsB,IAAY,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAC7G,gBAAgB,CAAC,WAAmB,IAAY,OAAO,WAAW,CAAC,CAAC,CAAC;IACrE,KAAK,CAAC,iBAAiB,KAAoB,CAAC;IAC5C,mBAAmB,KAAW,CAAC;IAC/B,mBAAmB,KAAgC,OAAO,SAAS,CAAC,CAAC,CAAC;IACtE,eAAe,KAAwB,OAAO,EAAE,CAAC,CAAC,CAAC;IACnD,KAAK,CAAC,cAAc,KAAK,CAAC;CAClC;AAXD,8CAWC","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 Localization\r\n */\r\n\r\n/** Options for Localization\r\n * @public\r\n */\r\ninterface LocalizationOptions {\r\n  /** for interpolation values */\r\n  [key: string]: any;\r\n  /**\r\n   * defaultValue to return if a translation was not found\r\n   */\r\n  defaultValue?: any;\r\n  /**\r\n   * count value used for plurals\r\n   */\r\n  count?: number;\r\n  /**\r\n   * used for contexts (eg. male\\female)\r\n   */\r\n  context?: any;\r\n  /**\r\n   * override languages to use\r\n   */\r\n  lngs?: string[];\r\n  /**\r\n   * override language to lookup key if not found see fallbacks for details\r\n   */\r\n  fallbackLng?: string;\r\n}\r\n\r\n/** The interface defining the localization requirements of [IModelApp]($frontend).\r\n * @public\r\n */\r\nexport interface Localization {\r\n  /** This method must be called and awaited before using an instance of Localization.\r\n   * @param namespaces an array of namespaces to load. There must be at least one namespace, and it\r\n   * becomes the default namespace.\r\n   * @note IModelApp.startup calls this internally, so you should not call this method directly\r\n   * except for Localization instances outside of IModelApp (e.g., for tests.)\r\n   */\r\n  initialize(namespaces: string[]): Promise<void>;\r\n\r\n  /** Return the translated value of a key.\r\n   * @param key - the key that matches a property in the JSON localization file.\r\n   * @note The key includes the namespace, which identifies the particular localization file that contains the property,\r\n   * followed by a colon, followed by the property in the JSON file.\r\n   * For example:\r\n   * ``` ts\r\n   * const dataString: string = IModelApp.localization.getLocalizedString(\"iModelJs:BackgroundMap.BingDataAttribution\");\r\n   *  ```\r\n   * assigns to dataString the string with property BackgroundMap.BingDataAttribution from the iModelJs.json localization file.\r\n   * @returns The string corresponding to the first key that resolves.\r\n   * @throws Error if no keys resolve to a string.\r\n   */\r\n  getLocalizedString(key: string | string[], options?: LocalizationOptions): string;\r\n  /** Similar to `getLocalizedString` but the namespace is a separate param and the key does not include the namespace.\r\n   * @param namespace - the namespace that identifies the particular localization file that contains the property.\r\n   * @param key - the key that matches a property in the JSON localization file.\r\n   * @returns The string corresponding to the first key that resolves.\r\n   * @throws Error if no keys resolve to a string.\r\n   */\r\n  getLocalizedStringWithNamespace(namespace: string, key: string | string[], options?: LocalizationOptions): string;\r\n  /** get the English string for a key. */\r\n  getEnglishString(namespace: string, key: string | string[], options?: LocalizationOptions): string;\r\n  /** Replace all instances of `%{key}` within a string with the translations of those keys.\r\n   * For example:\r\n   * ``` ts\r\n   * \"MyKeys\": {\r\n   *   \"Key1\": \"First value\",\r\n   *   \"Key2\": \"Second value\"\r\n   *  }\r\n   * ```\r\n   *\r\n   * ``` ts\r\n   * getLocalizedKeys(\"string with %{MyKeys.Key1} followed by %{MyKeys.Key2}!\"\") // returns \"string with First Value followed by Second Value!\"\r\n   * ```\r\n   */\r\n  getLocalizedKeys(inputString: string): string;\r\n\r\n  /** Register a new Namespace and return a Promise that is fulfilled when the content is loaded.\r\n   * If the namespace is already registered, its Promise will be returned.\r\n   * @param name - the name of the namespace.\r\n   * @note - The registerNamespace method starts fetching the appropriate version of the JSON localization file from the server,\r\n   * based on the current locale. To make sure that fetch is complete before performing translations from this namespace, await\r\n   * fulfillment of returned Promise.\r\n   * @see [Localization in iTwin.js]($docs/learning/frontend/Localization.md)\r\n   */\r\n  registerNamespace(namespace: string): Promise<void>;\r\n  /** @internal */\r\n  unregisterNamespace(namespace: string): void;\r\n  /** @internal */\r\n  getNamespacePromise(name: string): Promise<void> | undefined;\r\n  /** Get the list of available languages for translations */\r\n  getLanguageList(): readonly string[];\r\n  /** Change the language for translations. This overrides the language from the browser, for tests. */\r\n  changeLanguage(language: string): Promise<void>;\r\n}\r\n\r\n/** An empty [[Localization]] used if one is not provided to [IModelApp]($frontend). Does not perform localizations (merely returns the key.)\r\n * @public\r\n */\r\nexport class EmptyLocalization implements Localization {\r\n  public async initialize(): Promise<void> { }\r\n  public getLocalizedString(key: string | string[]): string { return typeof (key) == \"string\" ? key : key[0]; }\r\n  public getLocalizedStringWithNamespace(_namespace: string, key: string | string[]): string { return this.getLocalizedString(key); }\r\n  public getEnglishString(_namespace: string, key: string | string[]): string { return this.getLocalizedString(key); }\r\n  public getLocalizedKeys(inputString: string): string { return inputString; }\r\n  public async registerNamespace(): Promise<void> { }\r\n  public unregisterNamespace(): void { }\r\n  public getNamespacePromise(): Promise<void> | undefined { return undefined; }\r\n  public getLanguageList(): readonly string[] { return []; }\r\n  public async changeLanguage() { }\r\n}\r\n"]}

package/lib/cjs/MapLayerSettings.d.ts

@@ -23,7 +23,7 @@ export interface MapSubLayerProps {
  * have been validated and default values have been applied where explicit values not defined.
  * A map sub layer represents a set of objects within the layer that can be controlled separately.  These
  * are produced only from map servers that produce images on demand and are not supported by tiled (cached) servers.
- * This class can represent an hierarchy, in this case a sub layer is visible only if all its ancestors are also visible.
+ * This class can represent a hierarchy, in this case a sub layer is visible only if all its ancestors are also visible.
  * @see [[MapLayerSettings]]
  * @beta
  */
@@ -93,7 +93,7 @@ export interface MapLayerKey {
     key: string;
     value: string;
 }
-/** Normalized representation of a [[MapLayerProps]] for which values have been  validated and default values have been applied where explicit values not defined.
+/** Normalized representation of a [[MapLayerProps]] for which values have been validated and default values have been applied where explicit values not defined.
  * One or more map layers may be included within [[MapImagerySettings]] object.
  * @see [[MapImagerySettings]]
  * @beta

package/lib/cjs/MapLayerSettings.js

@@ -14,7 +14,7 @@ const BackgroundMapProvider_1 = require("./BackgroundMapProvider");
  * have been validated and default values have been applied where explicit values not defined.
  * A map sub layer represents a set of objects within the layer that can be controlled separately.  These
  * are produced only from map servers that produce images on demand and are not supported by tiled (cached) servers.
- * This class can represent an hierarchy, in this case a sub layer is visible only if all its ancestors are also visible.
+ * This class can represent a hierarchy, in this case a sub layer is visible only if all its ancestors are also visible.
  * @see [[MapLayerSettings]]
  * @beta
  */
@@ -72,7 +72,7 @@ class MapSubLayerSettings {
     get idString() { return (typeof this.id === "number") ? this.id.toString(10) : this.id; }
 }
 exports.MapSubLayerSettings = MapSubLayerSettings;
-/** Normalized representation of a [[MapLayerProps]] for which values have been  validated and default values have been applied where explicit values not defined.
+/** Normalized representation of a [[MapLayerProps]] for which values have been validated and default values have been applied where explicit values not defined.
  * One or more map layers may be included within [[MapImagerySettings]] object.
  * @see [[MapImagerySettings]]
  * @beta

package/lib/cjs/MapLayerSettings.js.map

@@ -1 +1 @@
-{"version":3,"file":"MapLayerSettings.js","sourceRoot":"","sources":["../../src/MapLayerSettings.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA6C;AAC7C,mEAA+G;AAqB/G;;;;;;;GAOG;AACH,MAAa,mBAAmB;IAc9B,YAAY,IAAY,EAAE,KAAc,EAAE,OAAiB,EAAE,EAAe,EAAE,MAAmB,EAAE,QAAuB;QACxH,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,OAAO,GAAG,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC;QAChD,IAAI,CAAC,EAAE,GAAG,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IACD,mGAAmG;IAC5F,MAAM,CAAC,QAAQ,CAAC,IAAsB;QAC3C,OAAO,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IACjJ,CAAC;IACM,MAAM;QACX,MAAM,KAAK,GAAqB,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC;QAE3E,IAAI,SAAS,KAAK,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,IAAI;YAChD,KAAK,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;QAErB,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK;YAC1B,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QAE3B,IAAI,IAAI,CAAC,QAAQ;YACf,KAAK,CAAC,QAAQ,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEtC,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM;YAC3B,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAE7B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,uFAAuF;IAChF,KAAK,CAAC,YAAuC;;QAClD,IAAI,SAAS,KAAK,YAAY;YAC5B,OAAO,IAAI,CAAC;QAEd,MAAM,KAAK,GAAG;YACZ,IAAI,EAAE,SAAS,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI;YACrE,EAAE,EAAE,SAAS,KAAK,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE;YAC7D,OAAO,EAAE,SAAS,KAAK,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO;YACjF,MAAM,EAAE,SAAS,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM;YAC7E,QAAQ,EAAE,SAAS,KAAK,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,MAAA,IAAI,CAAC,QAAQ,0CAAE,KAAK,EAAE;YACtG,KAAK,EAAE,SAAS,KAAK,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK;SAC1E,CAAC;QACF,OAAO,mBAAmB,CAAC,QAAQ,CAAC,KAAK,CAAE,CAAC;IAC9C,CAAC;IACD,gBAAgB;IACT,cAAc,CAAC,KAA0B;QAC9C,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,CAAC;IACpE,CAAC;IACD,6CAA6C;IAC7C,IAAW,OAAO,KAAc,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;IAE9D,+DAA+D;IAC/D,IAAW,MAAM,KAAc,OAAO,IAAI,CAAC,QAAQ,KAAK,SAAS,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC;IAElG,uDAAuD;IACvD,IAAW,cAAc,KAAc,OAAO,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAE9E,sGAAsG;IACtG,IAAW,QAAQ,KAAa,OAAO,CAAC,OAAO,IAAI,CAAC,EAAE,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;CACzG;AA1ED,kDA0EC;AAwCD;;;;GAIG;AACH,MAAa,gBAAgB;IAkB3B,gBAAgB;IAChB,YAAsB,GAAW,EAAE,IAAY,EAAE,QAAgB,EAAE,OAAO,GAAG,IAAI,EAC/E,gBAAgD,SAAS,EAAE,eAAuB,CAAC,EACnF,qBAAqB,GAAG,IAAI,EAAE,MAAM,GAAG,KAAK,EAAE,QAAiB,EAAE,QAAiB,EAAE,SAAuB;;QAC3G,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,qBAAqB,GAAG,qBAAqB,CAAC;QACnD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,IAAI,KAAK,EAAuB,CAAC;QAClD,IAAI,aAAa,KAAK,SAAS,EAAE;YAC/B,IAAI,gBAAgB,GAAG,KAAK,CAAC;YAC7B,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE;gBACxC,MAAM,QAAQ,GAAG,mBAAmB,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;gBAC5D,IAAI,SAAS,KAAK,QAAQ,EAAE;oBAC1B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;oBAC9B,IAAI,CAAA,MAAA,QAAQ,CAAC,QAAQ,0CAAE,MAAM,MAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,CAAC,gBAAgB;wBAC3E,gBAAgB,GAAG,IAAI,CAAC;iBAC3B;aACF;YAED,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;YACzB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAC1B;QACD,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;IAhCM,cAAc,CAAC,QAAiB,EAAE,QAAiB;QACxD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IA+BD,mGAAmG;IAC5F,MAAM,CAAC,QAAQ,CAAC,IAAmB;QACxC,MAAM,qBAAqB,GAAG,CAAC,IAAI,CAAC,qBAAqB,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC;QAC7G,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,YAAY,EAAE,qBAAqB,EAAE,IAAI,CAAC,MAAM,KAAK,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAC1L,CAAC;IAED,iEAAiE;IAC1D,MAAM;QACX,MAAM,KAAK,GAAkB,EAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAC,CAAC;QACvF,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE;YAC7B,KAAK,CAAC,SAAS,GAAG,EAAE,CAAC;YACrB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;gBAClC,MAAM,YAAY,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC;gBACvC,IAAI,YAAY;oBACd,KAAK,CAAC,SAAU,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACxC,CAAC,CAAC,CAAC;SACJ;QAED,IAAI,CAAC,KAAK,IAAI,CAAC,YAAY;YACzB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QAEzC,IAAI,IAAI,CAAC,qBAAqB,KAAK,KAAK;YACtC,KAAK,CAAC,qBAAqB,GAAG,IAAI,CAAC,qBAAqB,CAAC;QAE3D,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI;YACtB,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAE7B,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC7B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IACN,MAAM,CAAC,WAAW,CAAC,IAAuB;QAClD,QAAQ,IAAI,EAAE;YACZ,KAAK,yCAAiB,CAAC,MAAM;gBAC3B,OAAO,gBAAgB,CAAC;YAC1B,QAAQ;YACR,KAAK,yCAAiB,CAAC,MAAM;gBAC3B,OAAO,4BAA4B,CAAC;YACtC,KAAK,yCAAiB,CAAC,MAAM;gBAC3B,OAAO,SAAS,CAAC;SACpB;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAAoC;QAC/C,MAAM,KAAK,GAAG,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC;QAEvE,0CAA0C;QAC1C,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAEjC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IACN,UAAU,CAAC,YAAoC;QACvD,OAAO;YACL,IAAI,EAAE,SAAS,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI;YACrE,QAAQ,EAAE,SAAS,KAAK,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ;YACrF,OAAO,EAAE,SAAS,KAAK,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO;YACjF,GAAG,EAAE,SAAS,KAAK,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG;YACjE,YAAY,EAAE,SAAS,KAAK,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY;YACrG,qBAAqB,EAAE,SAAS,KAAK,YAAY,CAAC,qBAAqB,CAAC,CAAC,CAAC,YAAY,CAAC,qBAAqB,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB;YACzI,SAAS,EAAE,SAAS,KAAK,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS;YACzF,SAAS,EAAE,SAAS,KAAK,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS;SAC1F,CAAC;IACJ,CAAC;IAED,gBAAgB;IACT,cAAc,CAAC,KAAuB;QAC3C,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC;eAC7C,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO;eAC9B,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;eACxC,IAAI,CAAC,qBAAqB,KAAK,KAAK,CAAC,qBAAqB;eAC1D,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,KAAK,CAAC,SAAS,CAAC,MAAM,EAAE;YACrD,OAAO,KAAK,CAAC;SACd;QAED,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,EAAE;YACxE,OAAO,KAAK,CAAC;SACd;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE;YAC5C,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;gBACvD,OAAO,KAAK,CAAC;QAEjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,gBAAgB;IACT,iBAAiB,CAAC,IAAY,EAAE,GAAW;QAChD,OAAO,IAAI,CAAC,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,GAAG,KAAK,GAAG,CAAC;IAChD,CAAC;IAED,iEAAiE;IAC1D,YAAY,CAAC,EAAe;QACjC,OAAO,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IAC9F,CAAC;IAEO,qBAAqB,CAAC,QAA8B;QAC1D,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,MAAM;YAC/B,OAAO,KAAK,CAAC;QAEf,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM;YACT,OAAO,KAAK,CAAC;QAEf,kGAAkG;QAClG,4HAA4H;QAC5H,OAAO,CAAC,CAAC,MAAM,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;IACpF,CAAC;IAED,4FAA4F;IACrF,iBAAiB,CAAC,QAA6B;QACpD,IAAI,CAAC,QAAQ,CAAC,OAAO;YACnB,OAAO,KAAK,CAAC;QAEf,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED,gDAAgD;IAChD,IAAW,qBAAqB;QAC9B,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC;YAC7B,OAAO,KAAK,CAAC;QAEf,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,cAAc,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC5G,CAAC;IAED,yCAAyC;IAClC,mBAAmB,CAAC,QAA6B;QACtD,IAAI,CAAC,QAAQ,CAAC,QAAQ;YACpB,OAAO,SAAS,CAAC;QAEnB,MAAM,QAAQ,GAAG,IAAI,KAAK,EAAuB,CAAC;QAClD,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YACpC,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;YACzC,IAAI,KAAK,KAAK,SAAS;gBACrB,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF;AAlMD,4CAkMC;AASD;;;;;;;GAOG;AACH,MAAa,oBAAqB,SAAQ,gBAAgB;IAGxD,sEAAsE;IACtE,IAAW,QAAQ,KAAwC,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAEnF;;;;OAIG;IACI,MAAM,CAAU,QAAQ,CAAC,KAAwB;QACtD,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACvC,IAAA,qBAAM,EAAC,QAAQ,YAAY,oBAAoB,CAAC,CAAC;QACjD,IAAI,KAAK,CAAC,QAAQ;YAChB,QAAQ,CAAC,SAAS,GAAG,6CAAqB,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAEtE,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,qDAAqD;IACrC,MAAM;QACpB,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,EAAuB,CAAC;QAClD,IAAI,IAAI,CAAC,QAAQ;YACf,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QAE1C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IACA,UAAU,CAAC,YAAoC;QAC7D,MAAM,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,YAAY,CAAsB,CAAC;QAClE,IAAI,IAAI,CAAC,QAAQ;YACf,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QAE1C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,mCAAmC;IACnB,KAAK,CAAC,YAAoC;QACxD,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC;QACzB,MAAM,KAAK,GAAG,oBAAoB,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAE,CAAC;QAE5E,IAAI,IAAI,CAAC,QAAQ,IAAI,OAAO,KAAK,IAAI,CAAC,GAAG;YACvC,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC;QAE9B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,wDAAwD;IACjD,MAAM,CAAC,YAAY,CAAC,QAA+B,EAAE,OAAwD;QAClH,IAAI,QAAgB,EAAE,GAAW,EAAE,IAAY,CAAC;QAChD,QAAQ,QAAQ,CAAC,IAAI,EAAE;YACrB,KAAK,cAAc,CAAC;YACpB;gBACE,QAAQ,GAAG,UAAU,CAAC;gBAEtB,IAAI,UAAU,CAAC;gBACf,QAAQ,QAAQ,CAAC,IAAI,EAAE;oBACrB,KAAK,yCAAiB,CAAC,MAAM;wBAC3B,UAAU,GAAG,MAAM,CAAC;wBACpB,MAAM;oBACR,KAAK,yCAAiB,CAAC,MAAM;wBAC3B,UAAU,GAAG,QAAQ,CAAC;wBACtB,MAAM;oBACR,KAAK,yCAAiB,CAAC,MAAM,CAAC;oBAC9B;wBACE,UAAU,GAAG,kBAAkB,CAAC;wBAChC,MAAM;iBACT;gBACD,IAAI,GAAG,cAAc,gBAAgB,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBACnE,GAAG,GAAG,yDAAyD,UAAU,6CAA6C,CAAC;gBACvH,MAAM;YAER,KAAK,gBAAgB;gBACnB,QAAQ,GAAG,eAAe,CAAC;gBAC3B,IAAI,GAAG,WAAW,gBAAgB,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBAChE,QAAQ,QAAQ,CAAC,IAAI,EAAE;oBACrB,KAAK,yCAAiB,CAAC,MAAM;wBAC3B,GAAG,GAAG,2CAA2C,CAAC;wBAClD,MAAM;oBACR,KAAK,yCAAiB,CAAC,MAAM;wBAC3B,GAAG,GAAG,6CAA6C,CAAC;wBACpD,MAAM;oBACR,KAAK,yCAAiB,CAAC,MAAM;wBAC3B,GAAG,GAAG,qDAAqD,CAAC;wBAC5D,MAAM;iBACT;gBACD,MAAM;SACT;QAED,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;YAC9B,IAAI;YACJ,QAAQ;YACR,GAAG;YACH,qBAAqB,EAAE,KAAK;YAC5B,MAAM,EAAE,IAAI;YACZ,OAAO,EAAE,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,CAAA;YAC5B,YAAY,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY;SACpC,CAAC,CAAC;QAEH,IAAA,qBAAM,EAAC,SAAS,KAAK,QAAQ,CAAC,CAAC;QAC/B,IAAA,qBAAM,EAAC,QAAQ,YAAY,oBAAoB,CAAC,CAAC;QAEjD,QAAQ,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC9B,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,sBAAsB,CAAC,KAAmC;QACtE,OAAO,IAAI,CAAC,YAAY,CAAC,6CAAqB,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC,CAAC;IAChF,CAAC;IAED,aAAa;IACN,iBAAiB,CAAC,QAA+B;QACtD,OAAO,oBAAoB,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,YAAY,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;IACpH,CAAC;CACF;AArHD,oDAqHC","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 { assert } from \"@itwin/core-bentley\";\r\nimport { BackgroundMapProvider, BackgroundMapProviderProps, BackgroundMapType } from \"./BackgroundMapProvider\";\r\nimport { DeprecatedBackgroundMapProps } from \"./BackgroundMapSettings\";\r\n\r\n/** @beta */\r\nexport type SubLayerId = string | number;\r\n\r\n/** JSON representation of the settings associated with a map sublayer included within a [[MapLayerProps]].\r\n * A map sub layer represents a set of objects within the layer that can be controlled separately.  These\r\n * are produced only from map servers that produce images on demand and are not supported by tiled (cached) servers.\r\n * @see [[MapLayerProps]]\r\n * @beta\r\n */\r\nexport interface MapSubLayerProps {\r\n  name: string;\r\n  title?: string;\r\n  visible?: boolean;\r\n  id?: SubLayerId;\r\n  parent?: SubLayerId;\r\n  children?: SubLayerId[];\r\n}\r\n\r\n/** Normalized representation of a [[MapSubLayerProps]] for which values\r\n * have been validated and default values have been applied where explicit values not defined.\r\n * A map sub layer represents a set of objects within the layer that can be controlled separately.  These\r\n * are produced only from map servers that produce images on demand and are not supported by tiled (cached) servers.\r\n * This class can represent an hierarchy, in this case a sub layer is visible only if all its ancestors are also visible.\r\n * @see [[MapLayerSettings]]\r\n * @beta\r\n */\r\nexport class MapSubLayerSettings {\r\n  /** Typically Name is a single word used for machine-to-machine communication while the Title is for the benefit of humans (WMS) */\r\n  public readonly name: string;\r\n  /** Title. */\r\n  public readonly title?: string;\r\n  /** If true the sub layer is visible.  If part of a hierarchy, a sub layer is visible only if its ancestors are also visible. */\r\n  public readonly visible: boolean;\r\n  /** A unique string or number that may be used to identify the sub layer (ArcGIS) */\r\n  public readonly id: SubLayerId;\r\n  /** One or more sublayer children */\r\n  public readonly children?: SubLayerId[];\r\n  /** sublayer parent. */\r\n  public readonly parent?: SubLayerId;\r\n\r\n  constructor(name: string, title?: string, visible?: boolean, id?: SubLayerId, parent?: SubLayerId, children?: SubLayerId[]) {\r\n    this.name = name;\r\n    this.title = title;\r\n    this.visible = visible !== undefined && visible;\r\n    this.id = (id === undefined) ? this.name : id;\r\n    this.parent = parent;\r\n    this.children = children;\r\n  }\r\n  /** Construct from JSON, performing validation and applying default values for undefined fields. */\r\n  public static fromJSON(json: MapSubLayerProps): MapSubLayerSettings {\r\n    return new MapSubLayerSettings(json.name, json.title, json.visible, (json.id === json.name) ? undefined : json.id, json.parent, json.children);\r\n  }\r\n  public toJSON(): MapSubLayerProps {\r\n    const props: MapSubLayerProps = { name: this.name, visible: this.visible };\r\n\r\n    if (undefined !== this.id && this.id !== this.name)\r\n      props.id = this.id;\r\n\r\n    if (undefined !== this.title)\r\n      props.title = this.title;\r\n\r\n    if (this.children)\r\n      props.children = [...this.children];\r\n\r\n    if (undefined !== this.parent)\r\n      props.parent = this.parent;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Creating a copy of this MapSubLayer, optionally modifying some if its properties */\r\n  public clone(changedProps: Partial<MapSubLayerProps>): MapSubLayerSettings {\r\n    if (undefined === changedProps)\r\n      return this;\r\n\r\n    const props = {\r\n      name: undefined !== changedProps.name ? changedProps.name : this.name,\r\n      id: undefined !== changedProps.id ? changedProps.id : this.id,\r\n      visible: undefined !== changedProps.visible ? changedProps.visible : this.visible,\r\n      parent: undefined !== changedProps.parent ? changedProps.parent : this.parent,\r\n      children: undefined !== changedProps.children ? changedProps.children.slice() : this.children?.slice(),\r\n      title: undefined !== changedProps.title ? changedProps.title : this.title,\r\n    };\r\n    return MapSubLayerSettings.fromJSON(props)!;\r\n  }\r\n  /** @internal */\r\n  public displayMatches(other: MapSubLayerSettings): boolean {\r\n    return this.name === other.name && this.visible === other.visible;\r\n  }\r\n  /** return true if this sublayer is named. */\r\n  public get isNamed(): boolean { return this.name.length > 0; }\r\n\r\n  /** return true if this sublayer is a leaf (has no children) */\r\n  public get isLeaf(): boolean { return this.children === undefined || this.children.length === 0; }\r\n\r\n  /** return true if this sublayer is an unnamed group */\r\n  public get isUnnamedGroup(): boolean { return !this.isLeaf && !this.isNamed; }\r\n\r\n  /** return a string representing this sublayer id (converting to string if underlying id is number) */\r\n  public get idString(): string { return (typeof this.id === \"number\") ? this.id.toString(10) : this.id; }\r\n}\r\n\r\n/** JSON representation of the settings associated with a map layer.  One or more map layers may be included within a [[MapImageryProps]] object.\r\n * @see [[MapImageryProps]]\r\n * @beta\r\n */\r\nexport interface MapLayerProps {\r\n  /** Controls visibility of layer. Defaults to 'true'. */\r\n  visible?: boolean;\r\n  /** Identifies the map layers source.*/\r\n  formatId: string;\r\n  /** Name */\r\n  name: string;\r\n  /** URL */\r\n  url: string;\r\n  /** Source layers. If undefined all layers are displayed. */\r\n  subLayers?: MapSubLayerProps[];\r\n  /** A transparency value from 0.0 (fully opaque) to 1.0 (fully transparent) to apply to map graphics when drawing,\r\n   * or false to indicate the transparency should not be overridden. Default value: 0.\r\n   * If omitted, defaults to 0. */\r\n  transparency?: number;\r\n  /** True to indicate background is transparent.  Defaults to 'true'. */\r\n  transparentBackground?: boolean;\r\n  /** Is a base layer.  Defaults to 'false'. */\r\n  isBase?: boolean;\r\n  /** Access Key for the Layer, like a subscription key or access token.\r\n   * TODO This does not belong in the props object. It should never be persisted.\r\n   */\r\n  accessKey?: MapLayerKey;\r\n}\r\n\r\n/**\r\n * stores key-value pair to be added to all requests made involving map layer.\r\n * @beta\r\n */\r\nexport interface MapLayerKey {\r\n  key: string;\r\n  value: string;\r\n}\r\n\r\n/** Normalized representation of a [[MapLayerProps]] for which values have been  validated and default values have been applied where explicit values not defined.\r\n * One or more map layers may be included within [[MapImagerySettings]] object.\r\n * @see [[MapImagerySettings]]\r\n * @beta\r\n */\r\nexport class MapLayerSettings {\r\n  public readonly visible: boolean;\r\n  public readonly formatId: string;\r\n  public readonly name: string;\r\n  public readonly url: string;\r\n  public readonly transparency: number;\r\n  public readonly subLayers: MapSubLayerSettings[];\r\n  public readonly transparentBackground: boolean;\r\n  public readonly isBase: boolean;\r\n  public userName?: string;\r\n  public password?: string;\r\n  public accessKey?: MapLayerKey;\r\n\r\n  public setCredentials(userName?: string, password?: string) {\r\n    this.userName = userName;\r\n    this.password = password;\r\n  }\r\n\r\n  /** @internal */\r\n  protected constructor(url: string, name: string, formatId: string, visible = true,\r\n    jsonSubLayers: MapSubLayerProps[] | undefined = undefined, transparency: number = 0,\r\n    transparentBackground = true, isBase = false, userName?: string, password?: string, accessKey?: MapLayerKey) {\r\n    this.formatId = formatId;\r\n    this.name = name;\r\n    this.visible = visible;\r\n    this.transparentBackground = transparentBackground;\r\n    this.isBase = isBase;\r\n    this.subLayers = new Array<MapSubLayerSettings>();\r\n    if (jsonSubLayers !== undefined) {\r\n      let hasUnnamedGroups = false;\r\n      for (const jsonSubLayer of jsonSubLayers) {\r\n        const subLayer = MapSubLayerSettings.fromJSON(jsonSubLayer);\r\n        if (undefined !== subLayer) {\r\n          this.subLayers.push(subLayer);\r\n          if (subLayer.children?.length !== 0 && !subLayer.isNamed && !hasUnnamedGroups)\r\n            hasUnnamedGroups = true;\r\n        }\r\n      }\r\n\r\n      this.userName = userName;\r\n      this.password = password;\r\n    }\r\n    this.accessKey = accessKey;\r\n    this.transparency = transparency;\r\n    this.url = url;\r\n  }\r\n\r\n  /** Construct from JSON, performing validation and applying default values for undefined fields. */\r\n  public static fromJSON(json: MapLayerProps): MapLayerSettings {\r\n    const transparentBackground = (json.transparentBackground === undefined) ? true : json.transparentBackground;\r\n    return new this(json.url, json.name, json.formatId, json.visible, json.subLayers, json.transparency, transparentBackground, json.isBase === true, undefined, undefined, json.accessKey);\r\n  }\r\n\r\n  /** return JSON representation of this MapLayerSettings object */\r\n  public toJSON(): MapLayerProps {\r\n    const props: MapLayerProps = {formatId: this.formatId, name: this.name, url: this.url};\r\n    if (this.subLayers.length > 0) {\r\n      props.subLayers = [];\r\n      this.subLayers.forEach((subLayer) => {\r\n        const subLayerJson = subLayer.toJSON();\r\n        if (subLayerJson)\r\n          props.subLayers!.push(subLayerJson);\r\n      });\r\n    }\r\n\r\n    if (0 !== this.transparency)\r\n      props.transparency = this.transparency;\r\n\r\n    if (this.transparentBackground === false)\r\n      props.transparentBackground = this.transparentBackground;\r\n\r\n    if (this.isBase === true)\r\n      props.isBase = this.isBase;\r\n\r\n    props.visible = this.visible;\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  protected static mapTypeName(type: BackgroundMapType) {   // TBD.. Localization.\r\n    switch (type) {\r\n      case BackgroundMapType.Aerial:\r\n        return \"Aerial Imagery\";\r\n      default:\r\n      case BackgroundMapType.Hybrid:\r\n        return \"Aerial Imagery with labels\";\r\n      case BackgroundMapType.Street:\r\n        return \"Streets\";\r\n    }\r\n  }\r\n\r\n  /** Create a copy of this MapLayerSettings, optionally modifying some of its properties.\r\n   * @param changedProps JSON representation of the properties to change.\r\n   * @returns A MapLayerSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.\r\n   */\r\n  public clone(changedProps: Partial<MapLayerProps>): MapLayerSettings {\r\n    const clone = MapLayerSettings.fromJSON(this.cloneProps(changedProps));\r\n\r\n    // Clone members not part of MapLayerProps\r\n    clone.userName = this.userName;\r\n    clone.password = this.password;\r\n    clone.accessKey = this.accessKey;\r\n\r\n    return clone;\r\n  }\r\n\r\n  /** @internal */\r\n  protected cloneProps(changedProps: Partial<MapLayerProps>): MapLayerProps {\r\n    return {\r\n      name: undefined !== changedProps.name ? changedProps.name : this.name,\r\n      formatId: undefined !== changedProps.formatId ? changedProps.formatId : this.formatId,\r\n      visible: undefined !== changedProps.visible ? changedProps.visible : this.visible,\r\n      url: undefined !== changedProps.url ? changedProps.url : this.url,\r\n      transparency: undefined !== changedProps.transparency ? changedProps.transparency : this.transparency,\r\n      transparentBackground: undefined !== changedProps.transparentBackground ? changedProps.transparentBackground : this.transparentBackground,\r\n      subLayers: undefined !== changedProps.subLayers ? changedProps.subLayers : this.subLayers,\r\n      accessKey: undefined !== changedProps.accessKey ? changedProps.accessKey : this.accessKey,\r\n    };\r\n  }\r\n\r\n  /** @internal */\r\n  public displayMatches(other: MapLayerSettings): boolean {\r\n    if (!this.matchesNameAndUrl(other.name, other.url)\r\n      || this.visible !== other.visible\r\n      || this.transparency !== other.transparency\r\n      || this.transparentBackground !== other.transparentBackground\r\n      || this.subLayers.length !== other.subLayers.length) {\r\n      return false;\r\n    }\r\n\r\n    if (this.userName !== other.userName || this.password !== other.password) {\r\n      return false;\r\n    }\r\n\r\n    for (let i = 0; i < this.subLayers.length; i++)\r\n      if (!this.subLayers[i].displayMatches(other.subLayers[i]))\r\n        return false;\r\n\r\n    return true;\r\n  }\r\n\r\n  /** @internal */\r\n  public matchesNameAndUrl(name: string, url: string): boolean {\r\n    return this.name === name && this.url === url;\r\n  }\r\n\r\n  /** Return a sublayer matching id -- or undefined if not found */\r\n  public subLayerById(id?: SubLayerId): MapSubLayerSettings | undefined {\r\n    return id === undefined ? undefined : this.subLayers.find((subLayer) => subLayer.id === id);\r\n  }\r\n\r\n  private hasInvisibleAncestors(subLayer?: MapSubLayerSettings): boolean {\r\n    if (!subLayer || !subLayer.parent)\r\n      return false;\r\n\r\n    const parent = this.subLayerById(subLayer.parent);\r\n    if (!parent)\r\n      return false;\r\n\r\n    // Visibility of named group has no impact on the visibility of children (only unnamed group does)\r\n    // i.e For WMS, its should be possible to request a child layer when its parent is not visible (if the parent is also named)\r\n    return (!parent.visible && !parent.isNamed) || this.hasInvisibleAncestors(parent);\r\n  }\r\n\r\n  /** Return true if sublayer is visible -- testing ancestors for visibility if they exist. */\r\n  public isSubLayerVisible(subLayer: MapSubLayerSettings): boolean {\r\n    if (!subLayer.visible)\r\n      return false;\r\n\r\n    return !this.hasInvisibleAncestors(subLayer);\r\n  }\r\n\r\n  /** Return true if all sublayers are visible. */\r\n  public get allSubLayersInvisible(): boolean {\r\n    if (this.subLayers.length === 0)\r\n      return false;\r\n\r\n    return this.subLayers.every((subLayer) => (subLayer.isUnnamedGroup || !this.isSubLayerVisible(subLayer)));\r\n  }\r\n\r\n  /** Return the children for a sublayer */\r\n  public getSubLayerChildren(subLayer: MapSubLayerSettings): MapSubLayerSettings[] | undefined {\r\n    if (!subLayer.children)\r\n      return undefined;\r\n\r\n    const children = new Array<MapSubLayerSettings>();\r\n    subLayer.children.forEach((childId) => {\r\n      const child = this.subLayerById(childId);\r\n      if (child !== undefined)\r\n        children.push(child);\r\n    });\r\n\r\n    return children;\r\n  }\r\n}\r\n\r\n/** JSON representation of a [[BaseMapLayerSettings]].\r\n * @beta\r\n */\r\nexport interface BaseMapLayerProps extends MapLayerProps {\r\n  provider?: BackgroundMapProviderProps;\r\n}\r\n\r\n/** A [[MapLayerSettings]] that can serve as the base layer for a [[MapImagerySettings]].\r\n * The base layer supports all of the same options as any other layer, but also allows for simplified configuration based\r\n * on a small set of known supported [[BackgroundMapProvider]]s like [Bing Maps](https://www.microsoft.com/en-us/maps).\r\n * If the base layer was configured from such a provider, that information will be preserved and can be queried; this allows\r\n * the imagery provider and/or type to be easily modified.\r\n * @see [[MapImagerySettings.backgroundBase]].\r\n * @beta\r\n */\r\nexport class BaseMapLayerSettings extends MapLayerSettings {\r\n  private _provider?: BackgroundMapProvider;\r\n\r\n  /** The provider from which this base layer was configured, if any. */\r\n  public get provider(): BackgroundMapProvider | undefined { return this._provider; }\r\n\r\n  /** Create a base layer from its JSON representation.\r\n   * TODO: This, MapLayerSettings.fromJSON, and MapSubLayerSettings.fromJSON should never return undefined.\r\n   * That means they should not accept undefined for props and should define props such that it fully describes the\r\n   * layer - e.g., url and name must be defined.\r\n   */\r\n  public static override fromJSON(props: BaseMapLayerProps): BaseMapLayerSettings {\r\n    const settings = super.fromJSON(props);\r\n    assert(settings instanceof BaseMapLayerSettings);\r\n    if (props.provider)\r\n      settings._provider = BackgroundMapProvider.fromJSON(props.provider);\r\n\r\n    return settings;\r\n  }\r\n\r\n  /** Convert this layer to its JSON representation. */\r\n  public override toJSON(): BaseMapLayerProps {\r\n    const props = super.toJSON() as BaseMapLayerProps;\r\n    if (this.provider)\r\n      props.provider = this.provider.toJSON();\r\n\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  public override cloneProps(changedProps: Partial<MapLayerProps>): BaseMapLayerProps {\r\n    const props = super.cloneProps(changedProps) as BaseMapLayerProps;\r\n    if (this.provider)\r\n      props.provider = this.provider.toJSON();\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Create a copy of this layer. */\r\n  public override clone(changedProps: Partial<MapLayerProps>): BaseMapLayerSettings {\r\n    const prevUrl = this.url;\r\n    const clone = BaseMapLayerSettings.fromJSON(this.cloneProps(changedProps))!;\r\n\r\n    if (this.provider && prevUrl !== this.url)\r\n      clone._provider = undefined;\r\n\r\n    return clone;\r\n  }\r\n\r\n  /** Create a base layer from a BackgroundMapProvider. */\r\n  public static fromProvider(provider: BackgroundMapProvider, options?: { invisible?: boolean, transparency?: number }): BaseMapLayerSettings {\r\n    let formatId: string, url: string, name: string;\r\n    switch (provider.name) {\r\n      case \"BingProvider\":\r\n      default:\r\n        formatId = \"BingMaps\";\r\n\r\n        let imagerySet;\r\n        switch (provider.type) {\r\n          case BackgroundMapType.Street:\r\n            imagerySet = \"Road\";\r\n            break;\r\n          case BackgroundMapType.Aerial:\r\n            imagerySet = \"Aerial\";\r\n            break;\r\n          case BackgroundMapType.Hybrid:\r\n          default:\r\n            imagerySet = \"AerialWithLabels\";\r\n            break;\r\n        }\r\n        name = `Bing Maps: ${MapLayerSettings.mapTypeName(provider.type)}`;\r\n        url = `https://dev.virtualearth.net/REST/v1/Imagery/Metadata/${imagerySet}?o=json&incl=ImageryProviders&key={bingKey}`;\r\n        break;\r\n\r\n      case \"MapBoxProvider\":\r\n        formatId = \"MapboxImagery\";\r\n        name = `MapBox: ${MapLayerSettings.mapTypeName(provider.type)}`;\r\n        switch (provider.type) {\r\n          case BackgroundMapType.Street:\r\n            url = \"https://api.mapbox.com/v4/mapbox.streets/\";\r\n            break;\r\n          case BackgroundMapType.Aerial:\r\n            url = \"https://api.mapbox.com/v4/mapbox.satellite/\";\r\n            break;\r\n          case BackgroundMapType.Hybrid:\r\n            url = \"https://api.mapbox.com/v4/mapbox.streets-satellite/\";\r\n            break;\r\n        }\r\n        break;\r\n    }\r\n\r\n    const settings = super.fromJSON({\r\n      name,\r\n      formatId,\r\n      url,\r\n      transparentBackground: false,\r\n      isBase: true,\r\n      visible: !options?.invisible,\r\n      transparency: options?.transparency,\r\n    });\r\n\r\n    assert(undefined !== settings);\r\n    assert(settings instanceof BaseMapLayerSettings);\r\n\r\n    settings._provider = provider;\r\n    return settings;\r\n  }\r\n\r\n  /** @internal */\r\n  public static fromBackgroundMapProps(props: DeprecatedBackgroundMapProps): BaseMapLayerSettings {\r\n    return this.fromProvider(BackgroundMapProvider.fromBackgroundMapProps(props));\r\n  }\r\n\r\n  /** @alpha */\r\n  public cloneWithProvider(provider: BackgroundMapProvider): BaseMapLayerSettings {\r\n    return BaseMapLayerSettings.fromProvider(provider, { invisible: !this.visible, transparency: this.transparency });\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"MapLayerSettings.js","sourceRoot":"","sources":["../../src/MapLayerSettings.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA6C;AAC7C,mEAA+G;AAqB/G;;;;;;;GAOG;AACH,MAAa,mBAAmB;IAc9B,YAAY,IAAY,EAAE,KAAc,EAAE,OAAiB,EAAE,EAAe,EAAE,MAAmB,EAAE,QAAuB;QACxH,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,OAAO,GAAG,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC;QAChD,IAAI,CAAC,EAAE,GAAG,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IACD,mGAAmG;IAC5F,MAAM,CAAC,QAAQ,CAAC,IAAsB;QAC3C,OAAO,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IACjJ,CAAC;IACM,MAAM;QACX,MAAM,KAAK,GAAqB,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC;QAE3E,IAAI,SAAS,KAAK,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,IAAI;YAChD,KAAK,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;QAErB,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK;YAC1B,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QAE3B,IAAI,IAAI,CAAC,QAAQ;YACf,KAAK,CAAC,QAAQ,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEtC,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM;YAC3B,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAE7B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,uFAAuF;IAChF,KAAK,CAAC,YAAuC;;QAClD,IAAI,SAAS,KAAK,YAAY;YAC5B,OAAO,IAAI,CAAC;QAEd,MAAM,KAAK,GAAG;YACZ,IAAI,EAAE,SAAS,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI;YACrE,EAAE,EAAE,SAAS,KAAK,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE;YAC7D,OAAO,EAAE,SAAS,KAAK,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO;YACjF,MAAM,EAAE,SAAS,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM;YAC7E,QAAQ,EAAE,SAAS,KAAK,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,MAAA,IAAI,CAAC,QAAQ,0CAAE,KAAK,EAAE;YACtG,KAAK,EAAE,SAAS,KAAK,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK;SAC1E,CAAC;QACF,OAAO,mBAAmB,CAAC,QAAQ,CAAC,KAAK,CAAE,CAAC;IAC9C,CAAC;IACD,gBAAgB;IACT,cAAc,CAAC,KAA0B;QAC9C,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,CAAC;IACpE,CAAC;IACD,6CAA6C;IAC7C,IAAW,OAAO,KAAc,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;IAE9D,+DAA+D;IAC/D,IAAW,MAAM,KAAc,OAAO,IAAI,CAAC,QAAQ,KAAK,SAAS,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC;IAElG,uDAAuD;IACvD,IAAW,cAAc,KAAc,OAAO,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAE9E,sGAAsG;IACtG,IAAW,QAAQ,KAAa,OAAO,CAAC,OAAO,IAAI,CAAC,EAAE,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;CACzG;AA1ED,kDA0EC;AAwCD;;;;GAIG;AACH,MAAa,gBAAgB;IAkB3B,gBAAgB;IAChB,YAAsB,GAAW,EAAE,IAAY,EAAE,QAAgB,EAAE,OAAO,GAAG,IAAI,EAC/E,gBAAgD,SAAS,EAAE,eAAuB,CAAC,EACnF,qBAAqB,GAAG,IAAI,EAAE,MAAM,GAAG,KAAK,EAAE,QAAiB,EAAE,QAAiB,EAAE,SAAuB;;QAC3G,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,qBAAqB,GAAG,qBAAqB,CAAC;QACnD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,IAAI,KAAK,EAAuB,CAAC;QAClD,IAAI,aAAa,KAAK,SAAS,EAAE;YAC/B,IAAI,gBAAgB,GAAG,KAAK,CAAC;YAC7B,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE;gBACxC,MAAM,QAAQ,GAAG,mBAAmB,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;gBAC5D,IAAI,SAAS,KAAK,QAAQ,EAAE;oBAC1B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;oBAC9B,IAAI,CAAA,MAAA,QAAQ,CAAC,QAAQ,0CAAE,MAAM,MAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,CAAC,gBAAgB;wBAC3E,gBAAgB,GAAG,IAAI,CAAC;iBAC3B;aACF;YAED,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;YACzB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAC1B;QACD,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;IAhCM,cAAc,CAAC,QAAiB,EAAE,QAAiB;QACxD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IA+BD,mGAAmG;IAC5F,MAAM,CAAC,QAAQ,CAAC,IAAmB;QACxC,MAAM,qBAAqB,GAAG,CAAC,IAAI,CAAC,qBAAqB,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC;QAC7G,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,YAAY,EAAE,qBAAqB,EAAE,IAAI,CAAC,MAAM,KAAK,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAC1L,CAAC;IAED,iEAAiE;IAC1D,MAAM;QACX,MAAM,KAAK,GAAkB,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC;QACzF,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE;YAC7B,KAAK,CAAC,SAAS,GAAG,EAAE,CAAC;YACrB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;gBAClC,MAAM,YAAY,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC;gBACvC,IAAI,YAAY;oBACd,KAAK,CAAC,SAAU,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACxC,CAAC,CAAC,CAAC;SACJ;QAED,IAAI,CAAC,KAAK,IAAI,CAAC,YAAY;YACzB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QAEzC,IAAI,IAAI,CAAC,qBAAqB,KAAK,KAAK;YACtC,KAAK,CAAC,qBAAqB,GAAG,IAAI,CAAC,qBAAqB,CAAC;QAE3D,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI;YACtB,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAE7B,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC7B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IACN,MAAM,CAAC,WAAW,CAAC,IAAuB;QAClD,QAAQ,IAAI,EAAE;YACZ,KAAK,yCAAiB,CAAC,MAAM;gBAC3B,OAAO,gBAAgB,CAAC;YAC1B,QAAQ;YACR,KAAK,yCAAiB,CAAC,MAAM;gBAC3B,OAAO,4BAA4B,CAAC;YACtC,KAAK,yCAAiB,CAAC,MAAM;gBAC3B,OAAO,SAAS,CAAC;SACpB;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAAoC;QAC/C,MAAM,KAAK,GAAG,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC;QAEvE,0CAA0C;QAC1C,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAEjC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IACN,UAAU,CAAC,YAAoC;QACvD,OAAO;YACL,IAAI,EAAE,SAAS,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI;YACrE,QAAQ,EAAE,SAAS,KAAK,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ;YACrF,OAAO,EAAE,SAAS,KAAK,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO;YACjF,GAAG,EAAE,SAAS,KAAK,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG;YACjE,YAAY,EAAE,SAAS,KAAK,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY;YACrG,qBAAqB,EAAE,SAAS,KAAK,YAAY,CAAC,qBAAqB,CAAC,CAAC,CAAC,YAAY,CAAC,qBAAqB,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB;YACzI,SAAS,EAAE,SAAS,KAAK,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS;YACzF,SAAS,EAAE,SAAS,KAAK,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS;SAC1F,CAAC;IACJ,CAAC;IAED,gBAAgB;IACT,cAAc,CAAC,KAAuB;QAC3C,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC;eAC7C,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO;eAC9B,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;eACxC,IAAI,CAAC,qBAAqB,KAAK,KAAK,CAAC,qBAAqB;eAC1D,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,KAAK,CAAC,SAAS,CAAC,MAAM,EAAE;YACrD,OAAO,KAAK,CAAC;SACd;QAED,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,EAAE;YACxE,OAAO,KAAK,CAAC;SACd;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE;YAC5C,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;gBACvD,OAAO,KAAK,CAAC;QAEjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,gBAAgB;IACT,iBAAiB,CAAC,IAAY,EAAE,GAAW;QAChD,OAAO,IAAI,CAAC,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,GAAG,KAAK,GAAG,CAAC;IAChD,CAAC;IAED,iEAAiE;IAC1D,YAAY,CAAC,EAAe;QACjC,OAAO,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IAC9F,CAAC;IAEO,qBAAqB,CAAC,QAA8B;QAC1D,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,MAAM;YAC/B,OAAO,KAAK,CAAC;QAEf,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM;YACT,OAAO,KAAK,CAAC;QAEf,kGAAkG;QAClG,4HAA4H;QAC5H,OAAO,CAAC,CAAC,MAAM,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;IACpF,CAAC;IAED,4FAA4F;IACrF,iBAAiB,CAAC,QAA6B;QACpD,IAAI,CAAC,QAAQ,CAAC,OAAO;YACnB,OAAO,KAAK,CAAC;QAEf,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED,gDAAgD;IAChD,IAAW,qBAAqB;QAC9B,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC;YAC7B,OAAO,KAAK,CAAC;QAEf,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,cAAc,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC5G,CAAC;IAED,yCAAyC;IAClC,mBAAmB,CAAC,QAA6B;QACtD,IAAI,CAAC,QAAQ,CAAC,QAAQ;YACpB,OAAO,SAAS,CAAC;QAEnB,MAAM,QAAQ,GAAG,IAAI,KAAK,EAAuB,CAAC;QAClD,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YACpC,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;YACzC,IAAI,KAAK,KAAK,SAAS;gBACrB,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF;AAlMD,4CAkMC;AASD;;;;;;;GAOG;AACH,MAAa,oBAAqB,SAAQ,gBAAgB;IAGxD,sEAAsE;IACtE,IAAW,QAAQ,KAAwC,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAEnF;;;;OAIG;IACI,MAAM,CAAU,QAAQ,CAAC,KAAwB;QACtD,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACvC,IAAA,qBAAM,EAAC,QAAQ,YAAY,oBAAoB,CAAC,CAAC;QACjD,IAAI,KAAK,CAAC,QAAQ;YAChB,QAAQ,CAAC,SAAS,GAAG,6CAAqB,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAEtE,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,qDAAqD;IACrC,MAAM;QACpB,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,EAAuB,CAAC;QAClD,IAAI,IAAI,CAAC,QAAQ;YACf,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QAE1C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IACA,UAAU,CAAC,YAAoC;QAC7D,MAAM,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,YAAY,CAAsB,CAAC;QAClE,IAAI,IAAI,CAAC,QAAQ;YACf,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QAE1C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,mCAAmC;IACnB,KAAK,CAAC,YAAoC;QACxD,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC;QACzB,MAAM,KAAK,GAAG,oBAAoB,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAE,CAAC;QAE5E,IAAI,IAAI,CAAC,QAAQ,IAAI,OAAO,KAAK,IAAI,CAAC,GAAG;YACvC,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC;QAE9B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,wDAAwD;IACjD,MAAM,CAAC,YAAY,CAAC,QAA+B,EAAE,OAAwD;QAClH,IAAI,QAAgB,EAAE,GAAW,EAAE,IAAY,CAAC;QAChD,QAAQ,QAAQ,CAAC,IAAI,EAAE;YACrB,KAAK,cAAc,CAAC;YACpB;gBACE,QAAQ,GAAG,UAAU,CAAC;gBAEtB,IAAI,UAAU,CAAC;gBACf,QAAQ,QAAQ,CAAC,IAAI,EAAE;oBACrB,KAAK,yCAAiB,CAAC,MAAM;wBAC3B,UAAU,GAAG,MAAM,CAAC;wBACpB,MAAM;oBACR,KAAK,yCAAiB,CAAC,MAAM;wBAC3B,UAAU,GAAG,QAAQ,CAAC;wBACtB,MAAM;oBACR,KAAK,yCAAiB,CAAC,MAAM,CAAC;oBAC9B;wBACE,UAAU,GAAG,kBAAkB,CAAC;wBAChC,MAAM;iBACT;gBACD,IAAI,GAAG,cAAc,gBAAgB,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBACnE,GAAG,GAAG,yDAAyD,UAAU,6CAA6C,CAAC;gBACvH,MAAM;YAER,KAAK,gBAAgB;gBACnB,QAAQ,GAAG,eAAe,CAAC;gBAC3B,IAAI,GAAG,WAAW,gBAAgB,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBAChE,QAAQ,QAAQ,CAAC,IAAI,EAAE;oBACrB,KAAK,yCAAiB,CAAC,MAAM;wBAC3B,GAAG,GAAG,2CAA2C,CAAC;wBAClD,MAAM;oBACR,KAAK,yCAAiB,CAAC,MAAM;wBAC3B,GAAG,GAAG,6CAA6C,CAAC;wBACpD,MAAM;oBACR,KAAK,yCAAiB,CAAC,MAAM;wBAC3B,GAAG,GAAG,qDAAqD,CAAC;wBAC5D,MAAM;iBACT;gBACD,MAAM;SACT;QAED,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;YAC9B,IAAI;YACJ,QAAQ;YACR,GAAG;YACH,qBAAqB,EAAE,KAAK;YAC5B,MAAM,EAAE,IAAI;YACZ,OAAO,EAAE,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,CAAA;YAC5B,YAAY,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY;SACpC,CAAC,CAAC;QAEH,IAAA,qBAAM,EAAC,SAAS,KAAK,QAAQ,CAAC,CAAC;QAC/B,IAAA,qBAAM,EAAC,QAAQ,YAAY,oBAAoB,CAAC,CAAC;QAEjD,QAAQ,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC9B,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,sBAAsB,CAAC,KAAmC;QACtE,OAAO,IAAI,CAAC,YAAY,CAAC,6CAAqB,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC,CAAC;IAChF,CAAC;IAED,aAAa;IACN,iBAAiB,CAAC,QAA+B;QACtD,OAAO,oBAAoB,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,YAAY,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;IACpH,CAAC;CACF;AArHD,oDAqHC","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 { assert } from \"@itwin/core-bentley\";\r\nimport { BackgroundMapProvider, BackgroundMapProviderProps, BackgroundMapType } from \"./BackgroundMapProvider\";\r\nimport { DeprecatedBackgroundMapProps } from \"./BackgroundMapSettings\";\r\n\r\n/** @beta */\r\nexport type SubLayerId = string | number;\r\n\r\n/** JSON representation of the settings associated with a map sublayer included within a [[MapLayerProps]].\r\n * A map sub layer represents a set of objects within the layer that can be controlled separately.  These\r\n * are produced only from map servers that produce images on demand and are not supported by tiled (cached) servers.\r\n * @see [[MapLayerProps]]\r\n * @beta\r\n */\r\nexport interface MapSubLayerProps {\r\n  name: string;\r\n  title?: string;\r\n  visible?: boolean;\r\n  id?: SubLayerId;\r\n  parent?: SubLayerId;\r\n  children?: SubLayerId[];\r\n}\r\n\r\n/** Normalized representation of a [[MapSubLayerProps]] for which values\r\n * have been validated and default values have been applied where explicit values not defined.\r\n * A map sub layer represents a set of objects within the layer that can be controlled separately.  These\r\n * are produced only from map servers that produce images on demand and are not supported by tiled (cached) servers.\r\n * This class can represent a hierarchy, in this case a sub layer is visible only if all its ancestors are also visible.\r\n * @see [[MapLayerSettings]]\r\n * @beta\r\n */\r\nexport class MapSubLayerSettings {\r\n  /** Typically Name is a single word used for machine-to-machine communication while the Title is for the benefit of humans (WMS) */\r\n  public readonly name: string;\r\n  /** Title. */\r\n  public readonly title?: string;\r\n  /** If true the sub layer is visible.  If part of a hierarchy, a sub layer is visible only if its ancestors are also visible. */\r\n  public readonly visible: boolean;\r\n  /** A unique string or number that may be used to identify the sub layer (ArcGIS) */\r\n  public readonly id: SubLayerId;\r\n  /** One or more sublayer children */\r\n  public readonly children?: SubLayerId[];\r\n  /** sublayer parent. */\r\n  public readonly parent?: SubLayerId;\r\n\r\n  constructor(name: string, title?: string, visible?: boolean, id?: SubLayerId, parent?: SubLayerId, children?: SubLayerId[]) {\r\n    this.name = name;\r\n    this.title = title;\r\n    this.visible = visible !== undefined && visible;\r\n    this.id = (id === undefined) ? this.name : id;\r\n    this.parent = parent;\r\n    this.children = children;\r\n  }\r\n  /** Construct from JSON, performing validation and applying default values for undefined fields. */\r\n  public static fromJSON(json: MapSubLayerProps): MapSubLayerSettings {\r\n    return new MapSubLayerSettings(json.name, json.title, json.visible, (json.id === json.name) ? undefined : json.id, json.parent, json.children);\r\n  }\r\n  public toJSON(): MapSubLayerProps {\r\n    const props: MapSubLayerProps = { name: this.name, visible: this.visible };\r\n\r\n    if (undefined !== this.id && this.id !== this.name)\r\n      props.id = this.id;\r\n\r\n    if (undefined !== this.title)\r\n      props.title = this.title;\r\n\r\n    if (this.children)\r\n      props.children = [...this.children];\r\n\r\n    if (undefined !== this.parent)\r\n      props.parent = this.parent;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Creating a copy of this MapSubLayer, optionally modifying some if its properties */\r\n  public clone(changedProps: Partial<MapSubLayerProps>): MapSubLayerSettings {\r\n    if (undefined === changedProps)\r\n      return this;\r\n\r\n    const props = {\r\n      name: undefined !== changedProps.name ? changedProps.name : this.name,\r\n      id: undefined !== changedProps.id ? changedProps.id : this.id,\r\n      visible: undefined !== changedProps.visible ? changedProps.visible : this.visible,\r\n      parent: undefined !== changedProps.parent ? changedProps.parent : this.parent,\r\n      children: undefined !== changedProps.children ? changedProps.children.slice() : this.children?.slice(),\r\n      title: undefined !== changedProps.title ? changedProps.title : this.title,\r\n    };\r\n    return MapSubLayerSettings.fromJSON(props)!;\r\n  }\r\n  /** @internal */\r\n  public displayMatches(other: MapSubLayerSettings): boolean {\r\n    return this.name === other.name && this.visible === other.visible;\r\n  }\r\n  /** return true if this sublayer is named. */\r\n  public get isNamed(): boolean { return this.name.length > 0; }\r\n\r\n  /** return true if this sublayer is a leaf (has no children) */\r\n  public get isLeaf(): boolean { return this.children === undefined || this.children.length === 0; }\r\n\r\n  /** return true if this sublayer is an unnamed group */\r\n  public get isUnnamedGroup(): boolean { return !this.isLeaf && !this.isNamed; }\r\n\r\n  /** return a string representing this sublayer id (converting to string if underlying id is number) */\r\n  public get idString(): string { return (typeof this.id === \"number\") ? this.id.toString(10) : this.id; }\r\n}\r\n\r\n/** JSON representation of the settings associated with a map layer.  One or more map layers may be included within a [[MapImageryProps]] object.\r\n * @see [[MapImageryProps]]\r\n * @beta\r\n */\r\nexport interface MapLayerProps {\r\n  /** Controls visibility of layer. Defaults to 'true'. */\r\n  visible?: boolean;\r\n  /** Identifies the map layers source.*/\r\n  formatId: string;\r\n  /** Name */\r\n  name: string;\r\n  /** URL */\r\n  url: string;\r\n  /** Source layers. If undefined all layers are displayed. */\r\n  subLayers?: MapSubLayerProps[];\r\n  /** A transparency value from 0.0 (fully opaque) to 1.0 (fully transparent) to apply to map graphics when drawing,\r\n   * or false to indicate the transparency should not be overridden. Default value: 0.\r\n   * If omitted, defaults to 0. */\r\n  transparency?: number;\r\n  /** True to indicate background is transparent.  Defaults to 'true'. */\r\n  transparentBackground?: boolean;\r\n  /** Is a base layer.  Defaults to 'false'. */\r\n  isBase?: boolean;\r\n  /** Access Key for the Layer, like a subscription key or access token.\r\n   * TODO This does not belong in the props object. It should never be persisted.\r\n   */\r\n  accessKey?: MapLayerKey;\r\n}\r\n\r\n/**\r\n * stores key-value pair to be added to all requests made involving map layer.\r\n * @beta\r\n */\r\nexport interface MapLayerKey {\r\n  key: string;\r\n  value: string;\r\n}\r\n\r\n/** Normalized representation of a [[MapLayerProps]] for which values have been validated and default values have been applied where explicit values not defined.\r\n * One or more map layers may be included within [[MapImagerySettings]] object.\r\n * @see [[MapImagerySettings]]\r\n * @beta\r\n */\r\nexport class MapLayerSettings {\r\n  public readonly visible: boolean;\r\n  public readonly formatId: string;\r\n  public readonly name: string;\r\n  public readonly url: string;\r\n  public readonly transparency: number;\r\n  public readonly subLayers: MapSubLayerSettings[];\r\n  public readonly transparentBackground: boolean;\r\n  public readonly isBase: boolean;\r\n  public userName?: string;\r\n  public password?: string;\r\n  public accessKey?: MapLayerKey;\r\n\r\n  public setCredentials(userName?: string, password?: string) {\r\n    this.userName = userName;\r\n    this.password = password;\r\n  }\r\n\r\n  /** @internal */\r\n  protected constructor(url: string, name: string, formatId: string, visible = true,\r\n    jsonSubLayers: MapSubLayerProps[] | undefined = undefined, transparency: number = 0,\r\n    transparentBackground = true, isBase = false, userName?: string, password?: string, accessKey?: MapLayerKey) {\r\n    this.formatId = formatId;\r\n    this.name = name;\r\n    this.visible = visible;\r\n    this.transparentBackground = transparentBackground;\r\n    this.isBase = isBase;\r\n    this.subLayers = new Array<MapSubLayerSettings>();\r\n    if (jsonSubLayers !== undefined) {\r\n      let hasUnnamedGroups = false;\r\n      for (const jsonSubLayer of jsonSubLayers) {\r\n        const subLayer = MapSubLayerSettings.fromJSON(jsonSubLayer);\r\n        if (undefined !== subLayer) {\r\n          this.subLayers.push(subLayer);\r\n          if (subLayer.children?.length !== 0 && !subLayer.isNamed && !hasUnnamedGroups)\r\n            hasUnnamedGroups = true;\r\n        }\r\n      }\r\n\r\n      this.userName = userName;\r\n      this.password = password;\r\n    }\r\n    this.accessKey = accessKey;\r\n    this.transparency = transparency;\r\n    this.url = url;\r\n  }\r\n\r\n  /** Construct from JSON, performing validation and applying default values for undefined fields. */\r\n  public static fromJSON(json: MapLayerProps): MapLayerSettings {\r\n    const transparentBackground = (json.transparentBackground === undefined) ? true : json.transparentBackground;\r\n    return new this(json.url, json.name, json.formatId, json.visible, json.subLayers, json.transparency, transparentBackground, json.isBase === true, undefined, undefined, json.accessKey);\r\n  }\r\n\r\n  /** return JSON representation of this MapLayerSettings object */\r\n  public toJSON(): MapLayerProps {\r\n    const props: MapLayerProps = { formatId: this.formatId, name: this.name, url: this.url };\r\n    if (this.subLayers.length > 0) {\r\n      props.subLayers = [];\r\n      this.subLayers.forEach((subLayer) => {\r\n        const subLayerJson = subLayer.toJSON();\r\n        if (subLayerJson)\r\n          props.subLayers!.push(subLayerJson);\r\n      });\r\n    }\r\n\r\n    if (0 !== this.transparency)\r\n      props.transparency = this.transparency;\r\n\r\n    if (this.transparentBackground === false)\r\n      props.transparentBackground = this.transparentBackground;\r\n\r\n    if (this.isBase === true)\r\n      props.isBase = this.isBase;\r\n\r\n    props.visible = this.visible;\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  protected static mapTypeName(type: BackgroundMapType) {   // TBD.. Localization.\r\n    switch (type) {\r\n      case BackgroundMapType.Aerial:\r\n        return \"Aerial Imagery\";\r\n      default:\r\n      case BackgroundMapType.Hybrid:\r\n        return \"Aerial Imagery with labels\";\r\n      case BackgroundMapType.Street:\r\n        return \"Streets\";\r\n    }\r\n  }\r\n\r\n  /** Create a copy of this MapLayerSettings, optionally modifying some of its properties.\r\n   * @param changedProps JSON representation of the properties to change.\r\n   * @returns A MapLayerSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.\r\n   */\r\n  public clone(changedProps: Partial<MapLayerProps>): MapLayerSettings {\r\n    const clone = MapLayerSettings.fromJSON(this.cloneProps(changedProps));\r\n\r\n    // Clone members not part of MapLayerProps\r\n    clone.userName = this.userName;\r\n    clone.password = this.password;\r\n    clone.accessKey = this.accessKey;\r\n\r\n    return clone;\r\n  }\r\n\r\n  /** @internal */\r\n  protected cloneProps(changedProps: Partial<MapLayerProps>): MapLayerProps {\r\n    return {\r\n      name: undefined !== changedProps.name ? changedProps.name : this.name,\r\n      formatId: undefined !== changedProps.formatId ? changedProps.formatId : this.formatId,\r\n      visible: undefined !== changedProps.visible ? changedProps.visible : this.visible,\r\n      url: undefined !== changedProps.url ? changedProps.url : this.url,\r\n      transparency: undefined !== changedProps.transparency ? changedProps.transparency : this.transparency,\r\n      transparentBackground: undefined !== changedProps.transparentBackground ? changedProps.transparentBackground : this.transparentBackground,\r\n      subLayers: undefined !== changedProps.subLayers ? changedProps.subLayers : this.subLayers,\r\n      accessKey: undefined !== changedProps.accessKey ? changedProps.accessKey : this.accessKey,\r\n    };\r\n  }\r\n\r\n  /** @internal */\r\n  public displayMatches(other: MapLayerSettings): boolean {\r\n    if (!this.matchesNameAndUrl(other.name, other.url)\r\n      || this.visible !== other.visible\r\n      || this.transparency !== other.transparency\r\n      || this.transparentBackground !== other.transparentBackground\r\n      || this.subLayers.length !== other.subLayers.length) {\r\n      return false;\r\n    }\r\n\r\n    if (this.userName !== other.userName || this.password !== other.password) {\r\n      return false;\r\n    }\r\n\r\n    for (let i = 0; i < this.subLayers.length; i++)\r\n      if (!this.subLayers[i].displayMatches(other.subLayers[i]))\r\n        return false;\r\n\r\n    return true;\r\n  }\r\n\r\n  /** @internal */\r\n  public matchesNameAndUrl(name: string, url: string): boolean {\r\n    return this.name === name && this.url === url;\r\n  }\r\n\r\n  /** Return a sublayer matching id -- or undefined if not found */\r\n  public subLayerById(id?: SubLayerId): MapSubLayerSettings | undefined {\r\n    return id === undefined ? undefined : this.subLayers.find((subLayer) => subLayer.id === id);\r\n  }\r\n\r\n  private hasInvisibleAncestors(subLayer?: MapSubLayerSettings): boolean {\r\n    if (!subLayer || !subLayer.parent)\r\n      return false;\r\n\r\n    const parent = this.subLayerById(subLayer.parent);\r\n    if (!parent)\r\n      return false;\r\n\r\n    // Visibility of named group has no impact on the visibility of children (only unnamed group does)\r\n    // i.e For WMS, its should be possible to request a child layer when its parent is not visible (if the parent is also named)\r\n    return (!parent.visible && !parent.isNamed) || this.hasInvisibleAncestors(parent);\r\n  }\r\n\r\n  /** Return true if sublayer is visible -- testing ancestors for visibility if they exist. */\r\n  public isSubLayerVisible(subLayer: MapSubLayerSettings): boolean {\r\n    if (!subLayer.visible)\r\n      return false;\r\n\r\n    return !this.hasInvisibleAncestors(subLayer);\r\n  }\r\n\r\n  /** Return true if all sublayers are visible. */\r\n  public get allSubLayersInvisible(): boolean {\r\n    if (this.subLayers.length === 0)\r\n      return false;\r\n\r\n    return this.subLayers.every((subLayer) => (subLayer.isUnnamedGroup || !this.isSubLayerVisible(subLayer)));\r\n  }\r\n\r\n  /** Return the children for a sublayer */\r\n  public getSubLayerChildren(subLayer: MapSubLayerSettings): MapSubLayerSettings[] | undefined {\r\n    if (!subLayer.children)\r\n      return undefined;\r\n\r\n    const children = new Array<MapSubLayerSettings>();\r\n    subLayer.children.forEach((childId) => {\r\n      const child = this.subLayerById(childId);\r\n      if (child !== undefined)\r\n        children.push(child);\r\n    });\r\n\r\n    return children;\r\n  }\r\n}\r\n\r\n/** JSON representation of a [[BaseMapLayerSettings]].\r\n * @beta\r\n */\r\nexport interface BaseMapLayerProps extends MapLayerProps {\r\n  provider?: BackgroundMapProviderProps;\r\n}\r\n\r\n/** A [[MapLayerSettings]] that can serve as the base layer for a [[MapImagerySettings]].\r\n * The base layer supports all of the same options as any other layer, but also allows for simplified configuration based\r\n * on a small set of known supported [[BackgroundMapProvider]]s like [Bing Maps](https://www.microsoft.com/en-us/maps).\r\n * If the base layer was configured from such a provider, that information will be preserved and can be queried; this allows\r\n * the imagery provider and/or type to be easily modified.\r\n * @see [[MapImagerySettings.backgroundBase]].\r\n * @beta\r\n */\r\nexport class BaseMapLayerSettings extends MapLayerSettings {\r\n  private _provider?: BackgroundMapProvider;\r\n\r\n  /** The provider from which this base layer was configured, if any. */\r\n  public get provider(): BackgroundMapProvider | undefined { return this._provider; }\r\n\r\n  /** Create a base layer from its JSON representation.\r\n   * TODO: This, MapLayerSettings.fromJSON, and MapSubLayerSettings.fromJSON should never return undefined.\r\n   * That means they should not accept undefined for props and should define props such that it fully describes the\r\n   * layer - e.g., url and name must be defined.\r\n   */\r\n  public static override fromJSON(props: BaseMapLayerProps): BaseMapLayerSettings {\r\n    const settings = super.fromJSON(props);\r\n    assert(settings instanceof BaseMapLayerSettings);\r\n    if (props.provider)\r\n      settings._provider = BackgroundMapProvider.fromJSON(props.provider);\r\n\r\n    return settings;\r\n  }\r\n\r\n  /** Convert this layer to its JSON representation. */\r\n  public override toJSON(): BaseMapLayerProps {\r\n    const props = super.toJSON() as BaseMapLayerProps;\r\n    if (this.provider)\r\n      props.provider = this.provider.toJSON();\r\n\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  public override cloneProps(changedProps: Partial<MapLayerProps>): BaseMapLayerProps {\r\n    const props = super.cloneProps(changedProps) as BaseMapLayerProps;\r\n    if (this.provider)\r\n      props.provider = this.provider.toJSON();\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Create a copy of this layer. */\r\n  public override clone(changedProps: Partial<MapLayerProps>): BaseMapLayerSettings {\r\n    const prevUrl = this.url;\r\n    const clone = BaseMapLayerSettings.fromJSON(this.cloneProps(changedProps))!;\r\n\r\n    if (this.provider && prevUrl !== this.url)\r\n      clone._provider = undefined;\r\n\r\n    return clone;\r\n  }\r\n\r\n  /** Create a base layer from a BackgroundMapProvider. */\r\n  public static fromProvider(provider: BackgroundMapProvider, options?: { invisible?: boolean, transparency?: number }): BaseMapLayerSettings {\r\n    let formatId: string, url: string, name: string;\r\n    switch (provider.name) {\r\n      case \"BingProvider\":\r\n      default:\r\n        formatId = \"BingMaps\";\r\n\r\n        let imagerySet;\r\n        switch (provider.type) {\r\n          case BackgroundMapType.Street:\r\n            imagerySet = \"Road\";\r\n            break;\r\n          case BackgroundMapType.Aerial:\r\n            imagerySet = \"Aerial\";\r\n            break;\r\n          case BackgroundMapType.Hybrid:\r\n          default:\r\n            imagerySet = \"AerialWithLabels\";\r\n            break;\r\n        }\r\n        name = `Bing Maps: ${MapLayerSettings.mapTypeName(provider.type)}`;\r\n        url = `https://dev.virtualearth.net/REST/v1/Imagery/Metadata/${imagerySet}?o=json&incl=ImageryProviders&key={bingKey}`;\r\n        break;\r\n\r\n      case \"MapBoxProvider\":\r\n        formatId = \"MapboxImagery\";\r\n        name = `MapBox: ${MapLayerSettings.mapTypeName(provider.type)}`;\r\n        switch (provider.type) {\r\n          case BackgroundMapType.Street:\r\n            url = \"https://api.mapbox.com/v4/mapbox.streets/\";\r\n            break;\r\n          case BackgroundMapType.Aerial:\r\n            url = \"https://api.mapbox.com/v4/mapbox.satellite/\";\r\n            break;\r\n          case BackgroundMapType.Hybrid:\r\n            url = \"https://api.mapbox.com/v4/mapbox.streets-satellite/\";\r\n            break;\r\n        }\r\n        break;\r\n    }\r\n\r\n    const settings = super.fromJSON({\r\n      name,\r\n      formatId,\r\n      url,\r\n      transparentBackground: false,\r\n      isBase: true,\r\n      visible: !options?.invisible,\r\n      transparency: options?.transparency,\r\n    });\r\n\r\n    assert(undefined !== settings);\r\n    assert(settings instanceof BaseMapLayerSettings);\r\n\r\n    settings._provider = provider;\r\n    return settings;\r\n  }\r\n\r\n  /** @internal */\r\n  public static fromBackgroundMapProps(props: DeprecatedBackgroundMapProps): BaseMapLayerSettings {\r\n    return this.fromProvider(BackgroundMapProvider.fromBackgroundMapProps(props));\r\n  }\r\n\r\n  /** @alpha */\r\n  public cloneWithProvider(provider: BackgroundMapProvider): BaseMapLayerSettings {\r\n    return BaseMapLayerSettings.fromProvider(provider, { invisible: !this.visible, transparency: this.transparency });\r\n  }\r\n}\r\n"]}

package/lib/cjs/NativeAppProps.d.ts

@@ -3,7 +3,6 @@
  */
 import { AccessToken, GuidString } from "@itwin/core-bentley";
 import { BriefcaseProps, LocalBriefcaseProps, RequestNewBriefcaseProps } from "./BriefcaseTypes";
-import { SessionProps } from "./SessionProps";
 /** @internal */
 export declare const nativeAppChannel = "nativeApp";
 /** @internal */
@@ -33,47 +32,14 @@ export declare enum OverriddenBy {
  */
 export interface NativeAppNotifications {
     notifyInternetConnectivityChanged(status: InternetConnectivityStatus): void;
-    notifyAccessTokenChanged(accessToken: AccessToken): void;
-}
-/**
- * Client configuration to generate OIDC/OAuth tokens for native applications
- * @beta
- */
-export interface NativeAppAuthorizationConfiguration {
-    /**
-     * The OAuth token issuer URL. Defaults to Bentley's auth URL if undefined.
-     */
-    issuerUrl?: string;
-    /**
-     * Upon signing in, the client application receives a response from the Bentley IMS OIDC/OAuth2 provider at this URI
-     * For mobile/desktop applications, must start with `http://localhost:${redirectPort}` or `https://localhost:${redirectPort}`
-     */
-    readonly redirectUri?: string;
-    /** Client application's identifier as registered with the OIDC/OAuth2 provider. */
-    readonly clientId: string;
-    /** List of space separated scopes to request access to various resources. */
-    readonly scope: string;
-    /**
-     * Time in seconds that's used as a buffer to check the token for validity/expiry.
-     * The checks for authorization, and refreshing access tokens all use this buffer - i.e., the token is considered expired if the current time is within the specified
-     * time of the actual expiry.
-     * @note If unspecified this defaults to 10 minutes.
-     */
-    readonly expiryBuffer?: number;
 }
 /**
  * The methods that may be invoked via Ipc from the frontend of a Native App and are implemented on its backend.
  * @internal
  */
 export interface NativeAppFunctions {
-    setAccessToken(token: AccessToken): Promise<void>;
-    /** returns expirySafety, in seconds */
-    initializeAuth(props: SessionProps, config?: NativeAppAuthorizationConfiguration): Promise<number>;
-    /** Called to start the sign-in process. Subscribe to onAccessTokenChanged to be notified when sign-in completes */
-    signIn(): Promise<void>;
-    /** Called to start the sign-out process. Subscribe to onAccessTokenChanged to be notified when sign-out completes */
-    signOut(): Promise<void>;
-    getAccessToken: () => Promise<AccessToken>;
+    /** If the user is signed in a valid access token will be returned. */
+    getAccessToken: () => Promise<AccessToken | undefined>;
     /** Check if the internet is reachable. */
     checkInternetConnectivity(): Promise<InternetConnectivityStatus>;
     /** Manually override internet reachability for testing purposes.

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

@@ -1 +1 @@
-{"version":3,"file":"NativeAppProps.d.ts","sourceRoot":"","sources":["../../src/NativeAppProps.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,MAAM,kBAAkB,CAAC;AACjG,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,gBAAgB;AAChB,eAAO,MAAM,gBAAgB,cAAc,CAAC;AAC5C,gBAAgB;AAChB,eAAO,MAAM,eAAe,qBAAqB,CAAC;AAElD;;;GAGG;AACH,oBAAY,YAAY,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,UAAU,CAAC;AAE9E;;GAEG;AACH,oBAAY,0BAA0B;IACpC,MAAM,IAAA;IACN,OAAO,IAAA;CACR;AAED;;GAEG;AACH,oBAAY,YAAY;IACtB,OAAO,IAAA;IACP,IAAI,IAAA;CACL;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,iCAAiC,CAAC,MAAM,EAAE,0BAA0B,GAAG,IAAI,CAAC;IAC5E,wBAAwB,CAAC,WAAW,EAAE,WAAW,GAAG,IAAI,CAAC;CAC1D;AAED;;;GAGG;AACH,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAE9B,mFAAmF;IACnF,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAE1B,6EAA6E;IAC7E,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAEvB;;;;;OAKG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,cAAc,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElD,uCAAuC;IACvC,cAAc,CAAC,KAAK,EAAE,YAAY,EAAE,MAAM,CAAC,EAAE,mCAAmC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAEnG,mHAAmH;IACnH,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAExB,qHAAqH;IACrH,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzB,cAAc,EAAE,MAAM,OAAO,CAAC,WAAW,CAAC,CAAC;IAE3C,0CAA0C;IAC1C,yBAAyB,IAAI,OAAO,CAAC,0BAA0B,CAAC,CAAC;IAEjE;;OAEG;IACH,4BAA4B,CAAC,aAAa,EAAE,YAAY,EAAE,OAAO,EAAE,0BAA0B,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9G,yEAAyE;IACzE,qBAAqB,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE9D;;QAEI;IACJ,oBAAoB,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE9D,uEAAuE;IACvE,iBAAiB,CAAC,aAAa,EAAE,wBAAwB,EAAE,eAAe,EAAE,OAAO,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAEvI;;;;OAIG;IACH,8BAA8B,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEpE;;;OAGG;IACH,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvD;;;OAGG;IACH,mBAAmB,CAAC,SAAS,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAAC;IAE5E;;;OAGG;IACH,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAEpD;;;;OAIG;IACH,eAAe,CAAC,UAAU,EAAE,MAAM,EAAE,cAAc,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5E;;;OAGG;IACH,eAAe,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAErC;;;;;OAKG;IACH,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC,CAAC;IAEhF;;;;;OAKG;IACH,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElF;;;;OAIG;IACH,aAAa,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/D;;;;OAIG;IACH,WAAW,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAEnD;;;OAGG;IACH,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpD,sEAAsE;IACtE,mBAAmB,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,YAAY,GAAG,MAAM,GAAG,SAAS,CAAC,CAAC;CACrI"}
+{"version":3,"file":"NativeAppProps.d.ts","sourceRoot":"","sources":["../../src/NativeAppProps.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,MAAM,kBAAkB,CAAC;AAEjG,gBAAgB;AAChB,eAAO,MAAM,gBAAgB,cAAc,CAAC;AAC5C,gBAAgB;AAChB,eAAO,MAAM,eAAe,qBAAqB,CAAC;AAElD;;;GAGG;AACH,oBAAY,YAAY,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,UAAU,CAAC;AAE9E;;GAEG;AACH,oBAAY,0BAA0B;IACpC,MAAM,IAAA;IACN,OAAO,IAAA;CACR;AAED;;GAEG;AACH,oBAAY,YAAY;IACtB,OAAO,IAAA;IACP,IAAI,IAAA;CACL;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,iCAAiC,CAAC,MAAM,EAAE,0BAA0B,GAAG,IAAI,CAAC;CAC7E;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IAEjC,sEAAsE;IACtE,cAAc,EAAE,MAAM,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC,CAAC;IAEvD,0CAA0C;IAC1C,yBAAyB,IAAI,OAAO,CAAC,0BAA0B,CAAC,CAAC;IAEjE;;OAEG;IACH,4BAA4B,CAAC,aAAa,EAAE,YAAY,EAAE,OAAO,EAAE,0BAA0B,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9G,yEAAyE;IACzE,qBAAqB,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE9D;;QAEI;IACJ,oBAAoB,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE9D,uEAAuE;IACvE,iBAAiB,CAAC,aAAa,EAAE,wBAAwB,EAAE,eAAe,EAAE,OAAO,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAEvI;;;;OAIG;IACH,8BAA8B,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEpE;;;OAGG;IACH,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvD;;;OAGG;IACH,mBAAmB,CAAC,SAAS,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAAC;IAE5E;;;OAGG;IACH,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAEpD;;;;OAIG;IACH,eAAe,CAAC,UAAU,EAAE,MAAM,EAAE,cAAc,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5E;;;OAGG;IACH,eAAe,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAErC;;;;;OAKG;IACH,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC,CAAC;IAEhF;;;;;OAKG;IACH,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElF;;;;OAIG;IACH,aAAa,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/D;;;;OAIG;IACH,WAAW,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAEnD;;;OAGG;IACH,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpD,sEAAsE;IACtE,mBAAmB,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,YAAY,GAAG,MAAM,GAAG,SAAS,CAAC,CAAC;CACrI"}

package/lib/cjs/NativeAppProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"NativeAppProps.js","sourceRoot":"","sources":["../../src/NativeAppProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAMH,gBAAgB;AACH,QAAA,gBAAgB,GAAG,WAAW,CAAC;AAC5C,gBAAgB;AACH,QAAA,eAAe,GAAG,kBAAkB,CAAC;AAQlD;;GAEG;AACH,IAAY,0BAGX;AAHD,WAAY,0BAA0B;IACpC,+EAAM,CAAA;IACN,iFAAO,CAAA;AACT,CAAC,EAHW,0BAA0B,GAA1B,kCAA0B,KAA1B,kCAA0B,QAGrC;AAED;;GAEG;AACH,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,qDAAO,CAAA;IACP,+CAAI,CAAA;AACN,CAAC,EAHW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAGvB","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 NativeApp\r\n */\r\n\r\nimport { AccessToken, GuidString } from \"@itwin/core-bentley\";\r\nimport { BriefcaseProps, LocalBriefcaseProps, RequestNewBriefcaseProps } from \"./BriefcaseTypes\";\r\nimport { SessionProps } from \"./SessionProps\";\r\n\r\n/** @internal */\r\nexport const nativeAppChannel = \"nativeApp\";\r\n/** @internal */\r\nexport const nativeAppNotify = \"nativeApp-notify\";\r\n\r\n/**\r\n * Type of value for storage values\r\n * @beta\r\n */\r\nexport type StorageValue = string | number | boolean | undefined | Uint8Array;\r\n\r\n/** Indicates whether or not the computer is currently connected to the internet.\r\n * @beta\r\n */\r\nexport enum InternetConnectivityStatus {\r\n  Online,\r\n  Offline,\r\n}\r\n\r\n/** Describes whether the user or the browser overrode the internet connectivity status.\r\n * @beta\r\n */\r\nexport enum OverriddenBy {\r\n  Browser,\r\n  User,\r\n}\r\n\r\n/**\r\n * Interface implemented by the frontend [NotificationHandler]($common) to be notified of events from NativeApp backend.\r\n * @internal\r\n */\r\nexport interface NativeAppNotifications {\r\n  notifyInternetConnectivityChanged(status: InternetConnectivityStatus): void;\r\n  notifyAccessTokenChanged(accessToken: AccessToken): void;\r\n}\r\n\r\n/**\r\n * Client configuration to generate OIDC/OAuth tokens for native applications\r\n * @beta\r\n */\r\nexport interface NativeAppAuthorizationConfiguration {\r\n  /**\r\n   * The OAuth token issuer URL. Defaults to Bentley's auth URL if undefined.\r\n   */\r\n  issuerUrl?: string;\r\n\r\n  /**\r\n   * Upon signing in, the client application receives a response from the Bentley IMS OIDC/OAuth2 provider at this URI\r\n   * For mobile/desktop applications, must start with `http://localhost:${redirectPort}` or `https://localhost:${redirectPort}`\r\n   */\r\n  readonly redirectUri?: string;\r\n\r\n  /** Client application's identifier as registered with the OIDC/OAuth2 provider. */\r\n  readonly clientId: string;\r\n\r\n  /** List of space separated scopes to request access to various resources. */\r\n  readonly scope: string;\r\n\r\n  /**\r\n   * Time in seconds that's used as a buffer to check the token for validity/expiry.\r\n   * The checks for authorization, and refreshing access tokens all use this buffer - i.e., the token is considered expired if the current time is within the specified\r\n   * time of the actual expiry.\r\n   * @note If unspecified this defaults to 10 minutes.\r\n   */\r\n  readonly expiryBuffer?: number;\r\n}\r\n\r\n/**\r\n * The methods that may be invoked via Ipc from the frontend of a Native App and are implemented on its backend.\r\n * @internal\r\n */\r\nexport interface NativeAppFunctions {\r\n  setAccessToken(token: AccessToken): Promise<void>;\r\n\r\n  /** returns expirySafety, in seconds */\r\n  initializeAuth(props: SessionProps, config?: NativeAppAuthorizationConfiguration): Promise<number>;\r\n\r\n  /** Called to start the sign-in process. Subscribe to onAccessTokenChanged to be notified when sign-in completes */\r\n  signIn(): Promise<void>;\r\n\r\n  /** Called to start the sign-out process. Subscribe to onAccessTokenChanged to be notified when sign-out completes */\r\n  signOut(): Promise<void>;\r\n\r\n  getAccessToken: () => Promise<AccessToken>;\r\n\r\n  /** Check if the internet is reachable. */\r\n  checkInternetConnectivity(): Promise<InternetConnectivityStatus>;\r\n\r\n  /** Manually override internet reachability for testing purposes.\r\n   * @param _status New status to set on backend.\r\n   */\r\n  overrideInternetConnectivity(_overriddenBy: OverriddenBy, _status: InternetConnectivityStatus): Promise<void>;\r\n\r\n  /** Acquire a new BriefcaseId for the supplied iModelId from iModelHub */\r\n  acquireNewBriefcaseId(_iModelId: GuidString): Promise<number>;\r\n\r\n  /** Get the filename in the briefcase cache for the supplied BriefcaseId and iModelId.\r\n   * @note this merely returns the full path fileName. It does not test for the existence of the file.\r\n    */\r\n  getBriefcaseFileName(_props: BriefcaseProps): Promise<string>;\r\n\r\n  /** Download a briefcase file for the supplied briefcase properties. */\r\n  downloadBriefcase(_requestProps: RequestNewBriefcaseProps, _reportProgress: boolean, _interval?: number): Promise<LocalBriefcaseProps>;\r\n\r\n  /**\r\n   * Cancels the previously requested download of a briefcase\r\n   * @param _key Key to locate the briefcase in the disk cache\r\n   * @note returns true if the cancel request was acknowledged. false otherwise\r\n   */\r\n  requestCancelDownloadBriefcase(_fileName: string): Promise<boolean>;\r\n\r\n  /**\r\n   * Delete a previously downloaded briefcase. The briefcase must be closed.\r\n   * @param _fileName the Briefcase to delete\r\n   */\r\n  deleteBriefcaseFiles(_fileName: string): Promise<void>;\r\n\r\n  /**\r\n   * Gets a list of all briefcases that were previously downloaded to the system briefcase cache.\r\n   * @note returns array of LocalBriefcaseProps.\r\n   */\r\n  getCachedBriefcases(_iModelId?: GuidString): Promise<LocalBriefcaseProps[]>;\r\n\r\n  /**\r\n   * Open a key/value pair base storage\r\n   * @param _storageId string identifier of storage\r\n   */\r\n  storageMgrOpen(_storageId: string): Promise<string>;\r\n\r\n  /**\r\n   * Close a key/value pair base storage\r\n   * @param _storageId string identifier of storage\r\n   * @param _deleteOnClose delete the storage on close\r\n   */\r\n  storageMgrClose(_storageId: string, _deleteOnClose: boolean): Promise<void>;\r\n\r\n  /**\r\n   * Get the names of available storages\r\n   * @note returns list of storage names\r\n   */\r\n  storageMgrNames(): Promise<string[]>;\r\n\r\n  /**\r\n   * Get the value associated with a key.\r\n   * @param _storageId string identifier of storage\r\n   * @param _key key identifier for value\r\n   * @note returns key value or undefined\r\n   */\r\n  storageGet(_storageId: string, _key: string): Promise<StorageValue | undefined>;\r\n\r\n  /**\r\n   * Set a value for a key.\r\n   * @param _storageId string identifier of storage\r\n   * @param _key key identifier for value\r\n   * @param _value value to be set\r\n   */\r\n  storageSet(_storageId: string, _key: string, _value: StorageValue): Promise<void>;\r\n\r\n  /**\r\n   * Remove a key/value pair.\r\n   * @param _storageId string identifier of storage\r\n   * @param _key key identifier for value\r\n   */\r\n  storageRemove(_storageId: string, _key: string): Promise<void>;\r\n\r\n  /**\r\n   * Get list of keys in a storage.\r\n   * @param _storageId string identifier of storage\r\n   * @note returns list of storage ids\r\n   */\r\n  storageKeys(_storageId: string): Promise<string[]>;\r\n\r\n  /**\r\n   * Delete all key/value pairs.\r\n   * @param _storageId string identifier of storage\r\n   */\r\n  storageRemoveAll(_storageId: string): Promise<void>;\r\n\r\n  /** get the type of a value for a key, or undefined if not present. */\r\n  storageGetValueType(_storageId: string, _key: string): Promise<\"number\" | \"string\" | \"boolean\" | \"Uint8Array\" | \"null\" | undefined>;\r\n}\r\n"]}
+{"version":3,"file":"NativeAppProps.js","sourceRoot":"","sources":["../../src/NativeAppProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAKH,gBAAgB;AACH,QAAA,gBAAgB,GAAG,WAAW,CAAC;AAC5C,gBAAgB;AACH,QAAA,eAAe,GAAG,kBAAkB,CAAC;AAQlD;;GAEG;AACH,IAAY,0BAGX;AAHD,WAAY,0BAA0B;IACpC,+EAAM,CAAA;IACN,iFAAO,CAAA;AACT,CAAC,EAHW,0BAA0B,GAA1B,kCAA0B,KAA1B,kCAA0B,QAGrC;AAED;;GAEG;AACH,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,qDAAO,CAAA;IACP,+CAAI,CAAA;AACN,CAAC,EAHW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAGvB","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 NativeApp\r\n */\r\n\r\nimport { AccessToken, GuidString } from \"@itwin/core-bentley\";\r\nimport { BriefcaseProps, LocalBriefcaseProps, RequestNewBriefcaseProps } from \"./BriefcaseTypes\";\r\n\r\n/** @internal */\r\nexport const nativeAppChannel = \"nativeApp\";\r\n/** @internal */\r\nexport const nativeAppNotify = \"nativeApp-notify\";\r\n\r\n/**\r\n * Type of value for storage values\r\n * @beta\r\n */\r\nexport type StorageValue = string | number | boolean | undefined | Uint8Array;\r\n\r\n/** Indicates whether or not the computer is currently connected to the internet.\r\n * @beta\r\n */\r\nexport enum InternetConnectivityStatus {\r\n  Online,\r\n  Offline,\r\n}\r\n\r\n/** Describes whether the user or the browser overrode the internet connectivity status.\r\n * @beta\r\n */\r\nexport enum OverriddenBy {\r\n  Browser,\r\n  User,\r\n}\r\n\r\n/**\r\n * Interface implemented by the frontend [NotificationHandler]($common) to be notified of events from NativeApp backend.\r\n * @internal\r\n */\r\nexport interface NativeAppNotifications {\r\n  notifyInternetConnectivityChanged(status: InternetConnectivityStatus): void;\r\n}\r\n\r\n/**\r\n * The methods that may be invoked via Ipc from the frontend of a Native App and are implemented on its backend.\r\n * @internal\r\n */\r\nexport interface NativeAppFunctions {\r\n\r\n  /** If the user is signed in a valid access token will be returned. */\r\n  getAccessToken: () => Promise<AccessToken | undefined>;\r\n\r\n  /** Check if the internet is reachable. */\r\n  checkInternetConnectivity(): Promise<InternetConnectivityStatus>;\r\n\r\n  /** Manually override internet reachability for testing purposes.\r\n   * @param _status New status to set on backend.\r\n   */\r\n  overrideInternetConnectivity(_overriddenBy: OverriddenBy, _status: InternetConnectivityStatus): Promise<void>;\r\n\r\n  /** Acquire a new BriefcaseId for the supplied iModelId from iModelHub */\r\n  acquireNewBriefcaseId(_iModelId: GuidString): Promise<number>;\r\n\r\n  /** Get the filename in the briefcase cache for the supplied BriefcaseId and iModelId.\r\n   * @note this merely returns the full path fileName. It does not test for the existence of the file.\r\n    */\r\n  getBriefcaseFileName(_props: BriefcaseProps): Promise<string>;\r\n\r\n  /** Download a briefcase file for the supplied briefcase properties. */\r\n  downloadBriefcase(_requestProps: RequestNewBriefcaseProps, _reportProgress: boolean, _interval?: number): Promise<LocalBriefcaseProps>;\r\n\r\n  /**\r\n   * Cancels the previously requested download of a briefcase\r\n   * @param _key Key to locate the briefcase in the disk cache\r\n   * @note returns true if the cancel request was acknowledged. false otherwise\r\n   */\r\n  requestCancelDownloadBriefcase(_fileName: string): Promise<boolean>;\r\n\r\n  /**\r\n   * Delete a previously downloaded briefcase. The briefcase must be closed.\r\n   * @param _fileName the Briefcase to delete\r\n   */\r\n  deleteBriefcaseFiles(_fileName: string): Promise<void>;\r\n\r\n  /**\r\n   * Gets a list of all briefcases that were previously downloaded to the system briefcase cache.\r\n   * @note returns array of LocalBriefcaseProps.\r\n   */\r\n  getCachedBriefcases(_iModelId?: GuidString): Promise<LocalBriefcaseProps[]>;\r\n\r\n  /**\r\n   * Open a key/value pair base storage\r\n   * @param _storageId string identifier of storage\r\n   */\r\n  storageMgrOpen(_storageId: string): Promise<string>;\r\n\r\n  /**\r\n   * Close a key/value pair base storage\r\n   * @param _storageId string identifier of storage\r\n   * @param _deleteOnClose delete the storage on close\r\n   */\r\n  storageMgrClose(_storageId: string, _deleteOnClose: boolean): Promise<void>;\r\n\r\n  /**\r\n   * Get the names of available storages\r\n   * @note returns list of storage names\r\n   */\r\n  storageMgrNames(): Promise<string[]>;\r\n\r\n  /**\r\n   * Get the value associated with a key.\r\n   * @param _storageId string identifier of storage\r\n   * @param _key key identifier for value\r\n   * @note returns key value or undefined\r\n   */\r\n  storageGet(_storageId: string, _key: string): Promise<StorageValue | undefined>;\r\n\r\n  /**\r\n   * Set a value for a key.\r\n   * @param _storageId string identifier of storage\r\n   * @param _key key identifier for value\r\n   * @param _value value to be set\r\n   */\r\n  storageSet(_storageId: string, _key: string, _value: StorageValue): Promise<void>;\r\n\r\n  /**\r\n   * Remove a key/value pair.\r\n   * @param _storageId string identifier of storage\r\n   * @param _key key identifier for value\r\n   */\r\n  storageRemove(_storageId: string, _key: string): Promise<void>;\r\n\r\n  /**\r\n   * Get list of keys in a storage.\r\n   * @param _storageId string identifier of storage\r\n   * @note returns list of storage ids\r\n   */\r\n  storageKeys(_storageId: string): Promise<string[]>;\r\n\r\n  /**\r\n   * Delete all key/value pairs.\r\n   * @param _storageId string identifier of storage\r\n   */\r\n  storageRemoveAll(_storageId: string): Promise<void>;\r\n\r\n  /** get the type of a value for a key, or undefined if not present. */\r\n  storageGetValueType(_storageId: string, _key: string): Promise<\"number\" | \"string\" | \"boolean\" | \"Uint8Array\" | \"null\" | undefined>;\r\n}\r\n"]}

package/lib/cjs/PlanarClipMask.d.ts

@@ -51,6 +51,75 @@ export interface PlanarClipMaskProps {
     priority?: number;
     /** @see [[PlanarClipMaskSettings.transparency]]. */
     transparency?: number;
+    /** @see PlanarClipMaskSettings.invert */
+    invert?: boolean;
+}
+/** Basic arguments supplied to [[PlanarClipMaskSettings.create]].
+ * @public
+ */
+export interface BasicPlanarClipMaskArgs {
+    /** @see [[PlanarClipMaskSettings.transparency]]. */
+    transparency?: number;
+    /** @see [[PlanarClipMaskSettings.invert]]. */
+    invert?: boolean;
+}
+/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.Models]].
+ * @public
+ */
+export interface ModelPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {
+    /** @see [[PlanarClipMaskSettings.modelIds]]. */
+    modelIds?: Iterable<Id64String>;
+    /** @internal */
+    exclude?: never;
+    /** @internal */
+    elementIds?: never;
+    /** @internal */
+    subCategoryIds?: never;
+    /** @internal */
+    priority?: never;
+}
+/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.IncludeElements]] or [[PlanarClipMaskMode.ExcludeElements]].
+ * @public
+ */
+export interface ElementPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {
+    /** @see [[PlanarClipMaskSettings.modelIds]]. */
+    modelIds?: Iterable<Id64String>;
+    /** The elements used by the mask. @see [[PlanarClipMaskSettings.subCategoryOrElementIds]]. */
+    elementIds: Iterable<Id64String>;
+    /** If true, creates a mask of [[PlanarClipMaskMode.ExcludeElements]]; otherwise, [[PlanarClipMaskMode.IncludeElements]]. */
+    exclude?: boolean;
+    /** @internal */
+    subCategoryIds?: never;
+    /** @internal */
+    priority?: never;
+}
+/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.IncludeSubCategories]].
+ * @public
+ */
+export interface SubCategoryPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {
+    /** @see [[PlanarClipMaskSettings.modelIds]]. */
+    modelIds?: Iterable<Id64String>;
+    /** The subcategories used by the mask. @see [[PlanarClipMaskSettings.subCategoryOrElementIds]]. */
+    subCategoryIds: Iterable<Id64String>;
+    /** @internal */
+    exclude?: never;
+    /** @internal */
+    elementIds?: never;
+    /** @internal */
+    priority?: never;
+}
+/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.Priority]].
+ * @public
+ */
+export interface PriorityPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {
+    /** @see [[PlanarClipMaskSettings.priority]]. */
+    priority: number;
+    /** @internal */
+    exclude?: never;
+    /** @internal */
+    elementIds?: never;
+    /** @internal */
+    modelIds?: never;
 }
 /** Describes how to mask the geometry of one [GeometricModel]($backend) for display. The mask is produced by projecting geometry from any number of other models -
  * optionally filtered by [SubCategory]($backend) or by a set of specific [GeometricElement]($backend)s - onto a plane. Regions of the masked model that intersect the
@@ -79,20 +148,16 @@ export declare class PlanarClipMaskSettings {
      If no transparency is defined then the transparencies of the mask elements are used.
      */
     readonly transparency?: number;
+    /** A value of true indicates that the mask should be inverted and only content within the mask should be displayed, in other words the area inside the mask is displayed rather than outside. */
+    readonly invert: boolean;
     private readonly _modelIds?;
     private readonly _subCategoryOrElementIds?;
     /** The compressed representation of [[modelIds]]. */
     get compressedModelIds(): CompressedId64Set | undefined;
     /** Create a new [[PlanarClipMaskSettings]] object from its JSON representation. */
     static fromJSON(json?: PlanarClipMaskProps): PlanarClipMaskSettings;
-    /** Create settings for [[PlanarClipMaskMode.Models]]. */
-    static createForModels(modelIds: Iterable<Id64String> | undefined, transparency?: number): PlanarClipMaskSettings;
-    /** Create settings that filter by element or subcategory. */
-    static createForElementsOrSubCategories(mode: PlanarClipMaskMode.IncludeElements | PlanarClipMaskMode.ExcludeElements | PlanarClipMaskMode.IncludeSubCategories, elementOrSubCategoryIds: Iterable<Id64String>, modelIds?: Iterable<Id64String>, transparency?: number): PlanarClipMaskSettings;
-    /** Create settings that mask by priority.
-     * @see [[PlanarClipMaskPriority]] for default priority values based on model type.
-     */
-    static createByPriority(priority: number, transparency?: number): PlanarClipMaskSettings;
+    /** Create a new PlanarClipMaskSettings. */
+    static create(args: ModelPlanarClipMaskArgs | ElementPlanarClipMaskArgs | SubCategoryPlanarClipMaskArgs | PriorityPlanarClipMaskArgs): PlanarClipMaskSettings;
     /** Create JSON object representing this [[PlanarClipMaskSettings]] */
     toJSON(): PlanarClipMaskProps;
     /** Returns true if masking is enabled. */

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

@@ -1 +1 @@
-{"version":3,"file":"PlanarClipMask.d.ts","sourceRoot":"","sources":["../../src/PlanarClipMask.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAEzF;;GAEG;AACH,oBAAY,kBAAkB;IAC5B,kBAAkB;IAClB,IAAI,IAAI;IACR;;;OAGG;IACH,QAAQ,IAAI;IACZ,yGAAyG;IACzG,MAAM,IAAI;IACV,iGAAiG;IACjG,oBAAoB,IAAI;IACxB,2GAA2G;IAC3G,eAAe,IAAI;IACnB,qKAAqK;IACrK,eAAe,IAAI;CACpB;AAED;;;GAGG;AACH,oBAAY,sBAAsB;IAChC,sBAAsB;IACtB,aAAa,QAAQ;IACrB,6EAA6E;IAC7E,kBAAkB,QAAQ;IAC1B,4CAA4C;IAC5C,YAAY,IAAI;IAChB,yDAAyD;IACzD,WAAW,OAAO;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,kDAAkD;IAClD,IAAI,EAAE,kBAAkB,CAAC;IACzB,gDAAgD;IAChD,QAAQ,CAAC,EAAE,iBAAiB,CAAC;IAC7B,+DAA+D;IAC/D,uBAAuB,CAAC,EAAE,iBAAiB,CAAC;IAC5C,gDAAgD;IAChD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oDAAoD;IACpD,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;;GAQG;AACH,qBAAa,sBAAsB;IACjC,mDAAmD;IACnD,SAAgB,IAAI,EAAE,kBAAkB,CAAC;IACzC;;;OAGG;IACH,SAAgB,QAAQ,CAAC,EAAE,mBAAmB,CAAC;IAC/C;;OAEG;IACH,SAAgB,uBAAuB,CAAC,EAAE,mBAAmB,CAAC;IAC9D,+DAA+D;IAC/D,SAAgB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClC;;OAEG;IACH,SAAgB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAoB;IAC/C,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAAC,CAAoB;IAE9D,qDAAqD;IACrD,IAAW,kBAAkB,IAAI,iBAAiB,GAAG,SAAS,CAE7D;IAED,mFAAmF;WACrE,QAAQ,CAAC,IAAI,CAAC,EAAE,mBAAmB,GAAG,sBAAsB;IAO1E,yDAAyD;WAC3C,eAAe,CAAC,QAAQ,EAAE,QAAQ,CAAC,UAAU,CAAC,GAAG,SAAS,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,sBAAsB;IAQxH,6DAA6D;WAC/C,gCAAgC,CAAC,IAAI,EAAE,kBAAkB,CAAC,eAAe,GAAG,kBAAkB,CAAC,eAAe,GAAG,kBAAkB,CAAC,oBAAoB,EACpK,uBAAuB,EAAE,QAAQ,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC,EAAE,QAAQ,CAAC,UAAU,CAAC,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,sBAAsB;IAShI;;OAEG;WACW,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM;IAItE,sEAAsE;IAC/D,MAAM,IAAI,mBAAmB;IAiBpC,0CAA0C;IAC1C,IAAW,OAAO,IAAI,OAAO,CAE5B;IAEM,MAAM,CAAC,KAAK,EAAE,sBAAsB,GAAG,OAAO;IAQrD;;;OAGG;IACI,KAAK,CAAC,YAAY,CAAC,EAAE,mBAAmB,GAAG,sBAAsB;IAUxE,OAAO;IAcP,oDAAoD;IACpD,OAAc,QAAQ,yBAAuD;CAC9E"}
+{"version":3,"file":"PlanarClipMask.d.ts","sourceRoot":"","sources":["../../src/PlanarClipMask.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAEzF;;GAEG;AACH,oBAAY,kBAAkB;IAC5B,kBAAkB;IAClB,IAAI,IAAI;IACR;;;OAGG;IACH,QAAQ,IAAI;IACZ,yGAAyG;IACzG,MAAM,IAAI;IACV,iGAAiG;IACjG,oBAAoB,IAAI;IACxB,2GAA2G;IAC3G,eAAe,IAAI;IACnB,qKAAqK;IACrK,eAAe,IAAI;CACpB;AAED;;;GAGG;AACH,oBAAY,sBAAsB;IAChC,sBAAsB;IACtB,aAAa,QAAQ;IACrB,6EAA6E;IAC7E,kBAAkB,QAAQ;IAC1B,4CAA4C;IAC5C,YAAY,IAAI;IAChB,yDAAyD;IACzD,WAAW,OAAO;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,kDAAkD;IAClD,IAAI,EAAE,kBAAkB,CAAC;IACzB,gDAAgD;IAChD,QAAQ,CAAC,EAAE,iBAAiB,CAAC;IAC7B,+DAA+D;IAC/D,uBAAuB,CAAC,EAAE,iBAAiB,CAAC;IAC5C,gDAAgD;IAChD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oDAAoD;IACpD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,yCAAyC;IACzC,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,oDAAoD;IACpD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,8CAA8C;IAC9C,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,uBAAuB;IACtE,gDAAgD;IAChD,QAAQ,CAAC,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;IAChC,gBAAgB;IAChB,OAAO,CAAC,EAAE,KAAK,CAAC;IAChB,gBAAgB;IAChB,UAAU,CAAC,EAAE,KAAK,CAAC;IACnB,gBAAgB;IAChB,cAAc,CAAC,EAAE,KAAK,CAAC;IACvB,gBAAgB;IAChB,QAAQ,CAAC,EAAE,KAAK,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,uBAAuB;IACxE,gDAAgD;IAChD,QAAQ,CAAC,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;IAChC,8FAA8F;IAC9F,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;IACjC,4HAA4H;IAC5H,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,gBAAgB;IAChB,cAAc,CAAC,EAAE,KAAK,CAAC;IACvB,gBAAgB;IAChB,QAAQ,CAAC,EAAE,KAAK,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,uBAAuB;IAC5E,gDAAgD;IAChD,QAAQ,CAAC,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;IAChC,mGAAmG;IACnG,cAAc,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;IACrC,gBAAgB;IAChB,OAAO,CAAC,EAAE,KAAK,CAAC;IAChB,gBAAgB;IAChB,UAAU,CAAC,EAAE,KAAK,CAAC;IACnB,gBAAgB;IAChB,QAAQ,CAAC,EAAE,KAAK,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,uBAAuB;IACzE,gDAAgD;IAChD,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB;IAChB,OAAO,CAAC,EAAE,KAAK,CAAC;IAChB,gBAAgB;IAChB,UAAU,CAAC,EAAE,KAAK,CAAC;IACnB,gBAAgB;IAChB,QAAQ,CAAC,EAAE,KAAK,CAAC;CAClB;AAED;;;;;;;;GAQG;AACH,qBAAa,sBAAsB;IACjC,mDAAmD;IACnD,SAAgB,IAAI,EAAE,kBAAkB,CAAC;IACzC;;;OAGG;IACH,SAAgB,QAAQ,CAAC,EAAE,mBAAmB,CAAC;IAC/C;;OAEG;IACH,SAAgB,uBAAuB,CAAC,EAAE,mBAAmB,CAAC;IAC9D,+DAA+D;IAC/D,SAAgB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClC;;OAEG;IACH,SAAgB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtC,iMAAiM;IACjM,SAAgB,MAAM,EAAE,OAAO,CAAC;IAChC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAoB;IAC/C,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAAC,CAAoB;IAE9D,qDAAqD;IACrD,IAAW,kBAAkB,IAAI,iBAAiB,GAAG,SAAS,CAE7D;IAED,mFAAmF;WACrE,QAAQ,CAAC,IAAI,CAAC,EAAE,mBAAmB,GAAG,sBAAsB;IAO1E,2CAA2C;WAC7B,MAAM,CAAC,IAAI,EAAE,uBAAuB,GAAG,yBAAyB,GAAG,6BAA6B,GAAG,0BAA0B,GAAG,sBAAsB;IAYpK,sEAAsE;IAC/D,MAAM,IAAI,mBAAmB;IAoBpC,0CAA0C;IAC1C,IAAW,OAAO,IAAI,OAAO,CAE5B;IAEM,MAAM,CAAC,KAAK,EAAE,sBAAsB,GAAG,OAAO;IASrD;;;OAGG;IACI,KAAK,CAAC,YAAY,CAAC,EAAE,mBAAmB,GAAG,sBAAsB;IAUxE,OAAO;IAeP,oDAAoD;IACpD,OAAc,QAAQ,yBAAuD;CAC9E"}

package/lib/cjs/PlanarClipMask.js

@@ -55,11 +55,12 @@ var PlanarClipMaskPriority;
  * @public
  */
 class PlanarClipMaskSettings {
-    constructor(mode, transparency, modelIds, subCategoryOrElementIds, priority) {
+    constructor(mode, transparency, modelIds, subCategoryOrElementIds, priority, invert) {
         this.mode = mode;
         this._modelIds = modelIds;
         this._subCategoryOrElementIds = subCategoryOrElementIds;
         this.priority = priority;
+        this.invert = true === invert;
         this.transparency = undefined !== transparency ? Math.max(0, Math.min(1, transparency)) : undefined;
         if (modelIds)
             this.modelIds = core_bentley_1.CompressedId64Set.iterable(modelIds);
@@ -74,30 +75,19 @@ class PlanarClipMaskSettings {
     static fromJSON(json) {
         if (!json || undefined === json.mode)
             return this.defaults;
-        return new PlanarClipMaskSettings(json.mode, json.transparency, json.modelIds, json.subCategoryOrElementIds, json.priority);
+        return new PlanarClipMaskSettings(json.mode, json.transparency, json.modelIds, json.subCategoryOrElementIds, json.priority, json.invert);
     }
-    /** Create settings for [[PlanarClipMaskMode.Models]]. */
-    static createForModels(modelIds, transparency) {
-        return this.fromJSON({
-            mode: PlanarClipMaskMode.Models,
-            transparency,
-            modelIds: modelIds ? core_bentley_1.CompressedId64Set.sortAndCompress(modelIds) : undefined,
-        });
-    }
-    /** Create settings that filter by element or subcategory. */
-    static createForElementsOrSubCategories(mode, elementOrSubCategoryIds, modelIds, transparency) {
-        return this.fromJSON({
-            mode,
-            transparency,
-            modelIds: modelIds ? core_bentley_1.CompressedId64Set.sortAndCompress(modelIds) : undefined,
-            subCategoryOrElementIds: core_bentley_1.CompressedId64Set.sortAndCompress(elementOrSubCategoryIds),
-        });
-    }
-    /** Create settings that mask by priority.
-     * @see [[PlanarClipMaskPriority]] for default priority values based on model type.
-     */
-    static createByPriority(priority, transparency) {
-        return new PlanarClipMaskSettings(PlanarClipMaskMode.Priority, transparency, undefined, undefined, priority);
+    /** Create a new PlanarClipMaskSettings. */
+    static create(args) {
+        const modelIds = args.modelIds ? core_bentley_1.CompressedId64Set.sortAndCompress(args.modelIds) : undefined;
+        if (undefined !== args.priority)
+            return new PlanarClipMaskSettings(PlanarClipMaskMode.Priority, args.transparency, undefined, undefined, args.priority, args.invert);
+        else if (undefined !== args.subCategoryIds)
+            return new PlanarClipMaskSettings(PlanarClipMaskMode.IncludeSubCategories, args.transparency, modelIds, core_bentley_1.CompressedId64Set.sortAndCompress(args.subCategoryIds), undefined, args.invert);
+        else if (undefined !== args.elementIds)
+            return new PlanarClipMaskSettings(args.exclude ? PlanarClipMaskMode.ExcludeElements : PlanarClipMaskMode.IncludeElements, args.transparency, modelIds, core_bentley_1.CompressedId64Set.sortAndCompress(args.elementIds), undefined, args.invert);
+        else
+            return new PlanarClipMaskSettings(PlanarClipMaskMode.Models, args.transparency, modelIds, undefined, undefined, args.invert);
     }
     /** Create JSON object representing this [[PlanarClipMaskSettings]] */
     toJSON() {
@@ -110,6 +100,8 @@ class PlanarClipMaskSettings {
             props.priority = this.priority;
         if (undefined !== this.transparency)
             props.transparency = this.transparency;
+        if (this.invert)
+            props.invert = true;
         return props;
     }
     /** Returns true if masking is enabled. */
@@ -120,6 +112,7 @@ class PlanarClipMaskSettings {
         return this.mode === other.mode &&
             this.priority === other.priority &&
             this.transparency === other.transparency &&
+            this.invert === other.invert &&
             this._modelIds === other._modelIds &&
             this._subCategoryOrElementIds === other._subCategoryOrElementIds;
     }