@itwin/map-layers-formats 5.1.0-dev.9 → 5.2.0-dev.1

package/lib/cjs/map-layers-formats.d.ts

@@ -1,5 +1,7 @@
 export * from "./ArcGisFeature/ArcGisFeatureProvider.js";
 export * from "./GoogleMaps/GoogleMaps.js";
+export * from "./GoogleMaps/GoogleMapsSession.js";
+export * from "./GoogleMaps/GoogleMapsImageryFormat.js";
 export * from "./mapLayersFormats.js";
 export * from "./Tools/MapFeatureInfoTool.js";
 /** @docs-package-description

package/lib/cjs/map-layers-formats.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"map-layers-formats.d.ts","sourceRoot":"","sources":["../../src/map-layers-formats.ts"],"names":[],"mappings":"AAKA,cAAc,0CAA0C,CAAC;AACzD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,uBAAuB,CAAC;AACtC,cAAc,+BAA+B,CAAC;AAE9C;;GAEG;AAEH;;GAEG"}
+{"version":3,"file":"map-layers-formats.d.ts","sourceRoot":"","sources":["../../src/map-layers-formats.ts"],"names":[],"mappings":"AAKA,cAAc,0CAA0C,CAAC;AACzD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mCAAmC,CAAC;AAClD,cAAc,yCAAyC,CAAA;AACvD,cAAc,uBAAuB,CAAC;AACtC,cAAc,+BAA+B,CAAC;AAE9C;;GAEG;AAEH;;GAEG"}

package/lib/cjs/map-layers-formats.js

@@ -20,6 +20,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./ArcGisFeature/ArcGisFeatureProvider.js"), exports);
 __exportStar(require("./GoogleMaps/GoogleMaps.js"), exports);
+__exportStar(require("./GoogleMaps/GoogleMapsSession.js"), exports);
+__exportStar(require("./GoogleMaps/GoogleMapsImageryFormat.js"), exports);
 __exportStar(require("./mapLayersFormats.js"), exports);
 __exportStar(require("./Tools/MapFeatureInfoTool.js"), exports);
 /** @docs-package-description

package/lib/cjs/map-layers-formats.js.map

@@ -1 +1 @@
-{"version":3,"file":"map-layers-formats.js","sourceRoot":"","sources":["../../src/map-layers-formats.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;;;;;;;;;;;;;;AAE/F,2EAAyD;AACzD,6DAA2C;AAC3C,wDAAsC;AACtC,gEAA8C;AAE9C;;GAEG;AAEH;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n\nexport * from \"./ArcGisFeature/ArcGisFeatureProvider.js\";\nexport * from \"./GoogleMaps/GoogleMaps.js\";\nexport * from \"./mapLayersFormats.js\";\nexport * from \"./Tools/MapFeatureInfoTool.js\";\n\n/** @docs-package-description\n * This package provides support for additional map layer formats that are not included in the @itwin/core-frontend package.\n */\n\n/** @docs-group-description MapLayersFormats\n * APIs for working with the map layer formats provided by this package.\n */\n"]}
+{"version":3,"file":"map-layers-formats.js","sourceRoot":"","sources":["../../src/map-layers-formats.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;;;;;;;;;;;;;;AAE/F,2EAAyD;AACzD,6DAA2C;AAC3C,oEAAkD;AAClD,0EAAuD;AACvD,wDAAsC;AACtC,gEAA8C;AAE9C;;GAEG;AAEH;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n\nexport * from \"./ArcGisFeature/ArcGisFeatureProvider.js\";\nexport * from \"./GoogleMaps/GoogleMaps.js\";\nexport * from \"./GoogleMaps/GoogleMapsSession.js\";\nexport * from \"./GoogleMaps/GoogleMapsImageryFormat.js\"\nexport * from \"./mapLayersFormats.js\";\nexport * from \"./Tools/MapFeatureInfoTool.js\";\n\n/** @docs-package-description\n * This package provides support for additional map layer formats that are not included in the @itwin/core-frontend package.\n */\n\n/** @docs-group-description MapLayersFormats\n * APIs for working with the map layer formats provided by this package.\n */\n"]}

package/lib/cjs/mapLayersFormats.d.ts

@@ -1,9 +1,17 @@
 import { Localization } from "@itwin/core-common";
+import { GoogleMapsSessionManager } from "./map-layers-formats.js";
 /** Configuration options.
  * @beta
  */
 export interface MapLayersFormatsConfig {
     localization?: Localization;
+    googleMapsOpts?: GoogleMapsOptions;
+}
+/** Google Maps options.
+ * @beta
+ */
+export interface GoogleMapsOptions {
+    sessionManager?: GoogleMapsSessionManager;
 }
 /** The primary API for the `@itwin/map-layers-formats` package. It allows the package's features to be [[initialize]]d.
  * @beta
@@ -11,6 +19,7 @@ export interface MapLayersFormatsConfig {
 export declare class MapLayersFormats {
     private static _defaultNs;
     static localization: Localization;
+    private static _googleMapsOpts?;
     /** Registers the [MapLayerFormat]($frontend)s provided by this package for use with [IModelApp]($frontend).
      * Typically, an application will call `MapLayersFormats.initialize` immediately after [IModelApp.startup]($frontend).
      * This function has no effect if called **before** [IModelApp.startup]($frontend) or **after** [IModelApp.shutdown]($frontend).
@@ -18,5 +27,6 @@ export declare class MapLayersFormats {
     static initialize(config?: MapLayersFormatsConfig): Promise<void>;
     /** The internationalization service namespace. */
     static get localizationNamespace(): string;
+    static get googleMapsOpts(): GoogleMapsOptions | undefined;
 }
 //# sourceMappingURL=mapLayersFormats.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"mapLayersFormats.d.ts","sourceRoot":"","sources":["../../src/mapLayersFormats.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAOlD;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B;AAED;;GAEG;AACH,qBAAa,gBAAgB;IAE3B,OAAO,CAAC,MAAM,CAAC,UAAU,CAAsB;IAC/C,OAAc,YAAY,EAAE,YAAY,CAAC;IAEzC;;;OAGG;WACiB,UAAU,CAAC,MAAM,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAiB9E,kDAAkD;IAClD,WAAkB,qBAAqB,IAAI,MAAM,CAEhD;CAEF"}
+{"version":3,"file":"mapLayersFormats.d.ts","sourceRoot":"","sources":["../../src/mapLayersFormats.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAMlD,OAAO,EAAE,wBAAwB,EAAE,MAAM,yBAAyB,CAAC;AAEnE;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,cAAc,CAAC,EAAE,iBAAiB,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,cAAc,CAAC,EAAE,wBAAwB,CAAA;CAC1C;AAED;;GAEG;AACH,qBAAa,gBAAgB;IAE3B,OAAO,CAAC,MAAM,CAAC,UAAU,CAAsB;IAC/C,OAAc,YAAY,EAAE,YAAY,CAAC;IAEzC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,CAAoB;IAEnD;;;OAGG;WACiB,UAAU,CAAC,MAAM,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAkB9E,kDAAkD;IAClD,WAAkB,qBAAqB,IAAI,MAAM,CAEhD;IAED,WAAkB,cAAc,kCAE/B;CAEF"}

package/lib/cjs/mapLayersFormats.js

@@ -20,6 +20,7 @@ const MapFeatureInfoTool_js_1 = require("./Tools/MapFeatureInfoTool.js");
 class MapLayersFormats {
     static _defaultNs = "mapLayersFormats";
     static localization;
+    static _googleMapsOpts;
     /** Registers the [MapLayerFormat]($frontend)s provided by this package for use with [IModelApp]($frontend).
      * Typically, an application will call `MapLayersFormats.initialize` immediately after [IModelApp.startup]($frontend).
      * This function has no effect if called **before** [IModelApp.startup]($frontend) or **after** [IModelApp.shutdown]($frontend).
@@ -35,11 +36,15 @@ class MapLayersFormats {
         MapLayersFormats.localization = config?.localization ?? core_frontend_1.IModelApp.localization;
         await MapLayersFormats.localization.registerNamespace(MapLayersFormats.localizationNamespace);
         MapFeatureInfoTool_js_1.MapFeatureInfoTool.register(MapLayersFormats.localizationNamespace);
+        MapLayersFormats._googleMapsOpts = config?.googleMapsOpts;
     }
     /** The internationalization service namespace. */
     static get localizationNamespace() {
         return MapLayersFormats._defaultNs;
     }
+    static get googleMapsOpts() {
+        return MapLayersFormats._googleMapsOpts;
+    }
 }
 exports.MapLayersFormats = MapLayersFormats;
 //# sourceMappingURL=mapLayersFormats.js.map

package/lib/cjs/mapLayersFormats.js.map

@@ -1 +1 @@
-{"version":3,"file":"mapLayersFormats.js","sourceRoot":"","sources":["../../src/mapLayersFormats.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AACH,sDAA6C;AAE7C,wDAAiD;AACjD,mFAAqF;AACrF,wFAAmF;AACnF,sFAAwF;AACxF,yEAAmE;AASnE;;GAEG;AACH,MAAa,gBAAgB;IAEnB,MAAM,CAAC,UAAU,GAAG,kBAAkB,CAAC;IACxC,MAAM,CAAC,YAAY,CAAe;IAEzC;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,MAA+B;QAC5D,IAAA,qBAAM,EAAC,yBAAS,CAAC,WAAW,EAAE,kGAAkG,CAAC,CAAC;QAClI,IAAI,yBAAS,CAAC,WAAW,EAAE,CAAC;YAC1B,yBAAS,CAAC,sBAAsB,CAAC,QAAQ,CAAC,oDAA2B,CAAC,CAAC;YACvE,yBAAS,CAAC,sBAAsB,CAAC,QAAQ,CAAC,sDAA4B,CAAC,CAAC;YACxE,yBAAS,CAAC,sBAAsB,CAAC,QAAQ,CAAC,qDAAwB,CAAC,CAAC;QACtE,CAAC;QAED,mEAAmE;QACnE,gBAAgB,CAAC,YAAY,GAAG,MAAM,EAAE,YAAY,IAAI,yBAAS,CAAC,YAAY,CAAC;QAC/E,MAAM,gBAAgB,CAAC,YAAY,CAAC,iBAAiB,CACnD,gBAAgB,CAAC,qBAAqB,CACvC,CAAC;QAEF,0CAAkB,CAAC,QAAQ,CAAC,gBAAgB,CAAC,qBAAqB,CAAC,CAAC;IACtE,CAAC;IAED,kDAAkD;IAC3C,MAAM,KAAK,qBAAqB;QACrC,OAAO,gBAAgB,CAAC,UAAU,CAAC;IACrC,CAAC;;AA7BH,4CA+BC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n\n/** @packageDocumentation\n * @module MapLayersFormats\n */\nimport { assert } from \"@itwin/core-bentley\";\nimport { Localization } from \"@itwin/core-common\";\nimport { IModelApp } from \"@itwin/core-frontend\";\nimport { ArcGisFeatureMapLayerFormat } from \"./ArcGisFeature/ArcGisFeatureFormat.js\";\nimport { GoogleMapsMapLayerFormat } from \"./GoogleMaps/GoogleMapsImageryFormat.js\";\nimport { OgcApiFeaturesMapLayerFormat } from \"./OgcApiFeatures/OgcApiFeaturesFormat.js\";\nimport { MapFeatureInfoTool } from \"./Tools/MapFeatureInfoTool.js\";\n\n/** Configuration options.\n * @beta\n */\nexport interface MapLayersFormatsConfig {\n  localization?: Localization;\n}\n\n/** The primary API for the `@itwin/map-layers-formats` package. It allows the package's features to be [[initialize]]d.\n * @beta\n */\nexport class MapLayersFormats {\n\n  private static _defaultNs = \"mapLayersFormats\";\n  public static localization: Localization;\n\n  /** Registers the [MapLayerFormat]($frontend)s provided by this package for use with [IModelApp]($frontend).\n   * Typically, an application will call `MapLayersFormats.initialize` immediately after [IModelApp.startup]($frontend).\n   * This function has no effect if called **before** [IModelApp.startup]($frontend) or **after** [IModelApp.shutdown]($frontend).\n   */\n  public static async initialize(config?: MapLayersFormatsConfig): Promise<void> {\n    assert(IModelApp.initialized, \"MapLayersFormats.initialize must be called after IModelApp.startup and before IModelApp.shutdown\");\n    if (IModelApp.initialized) {\n      IModelApp.mapLayerFormatRegistry.register(ArcGisFeatureMapLayerFormat);\n      IModelApp.mapLayerFormatRegistry.register(OgcApiFeaturesMapLayerFormat);\n      IModelApp.mapLayerFormatRegistry.register(GoogleMapsMapLayerFormat);\n    }\n\n    // register namespace containing localized strings for this package\n    MapLayersFormats.localization = config?.localization ?? IModelApp.localization;\n    await MapLayersFormats.localization.registerNamespace(\n      MapLayersFormats.localizationNamespace,\n    );\n\n    MapFeatureInfoTool.register(MapLayersFormats.localizationNamespace);\n  }\n\n  /** The internationalization service namespace. */\n  public static get localizationNamespace(): string {\n    return MapLayersFormats._defaultNs;\n  }\n\n}\n"]}
+{"version":3,"file":"mapLayersFormats.js","sourceRoot":"","sources":["../../src/mapLayersFormats.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AACH,sDAA6C;AAE7C,wDAAiD;AACjD,mFAAqF;AACrF,wFAAmF;AACnF,sFAAwF;AACxF,yEAAmE;AAkBnE;;GAEG;AACH,MAAa,gBAAgB;IAEnB,MAAM,CAAC,UAAU,GAAG,kBAAkB,CAAC;IACxC,MAAM,CAAC,YAAY,CAAe;IAEjC,MAAM,CAAC,eAAe,CAAqB;IAEnD;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,MAA+B;QAC5D,IAAA,qBAAM,EAAC,yBAAS,CAAC,WAAW,EAAE,kGAAkG,CAAC,CAAC;QAClI,IAAI,yBAAS,CAAC,WAAW,EAAE,CAAC;YAC1B,yBAAS,CAAC,sBAAsB,CAAC,QAAQ,CAAC,oDAA2B,CAAC,CAAC;YACvE,yBAAS,CAAC,sBAAsB,CAAC,QAAQ,CAAC,sDAA4B,CAAC,CAAC;YACxE,yBAAS,CAAC,sBAAsB,CAAC,QAAQ,CAAC,qDAAwB,CAAC,CAAC;QACtE,CAAC;QAED,mEAAmE;QACnE,gBAAgB,CAAC,YAAY,GAAG,MAAM,EAAE,YAAY,IAAI,yBAAS,CAAC,YAAY,CAAC;QAC/E,MAAM,gBAAgB,CAAC,YAAY,CAAC,iBAAiB,CACnD,gBAAgB,CAAC,qBAAqB,CACvC,CAAC;QAEF,0CAAkB,CAAC,QAAQ,CAAC,gBAAgB,CAAC,qBAAqB,CAAC,CAAC;QACpE,gBAAgB,CAAC,eAAe,GAAG,MAAM,EAAE,cAAc,CAAC;IAC5D,CAAC;IAED,kDAAkD;IAC3C,MAAM,KAAK,qBAAqB;QACrC,OAAO,gBAAgB,CAAC,UAAU,CAAC;IACrC,CAAC;IAEM,MAAM,KAAK,cAAc;QAC9B,OAAO,gBAAgB,CAAC,eAAe,CAAC;IAC1C,CAAC;;AApCH,4CAsCC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n\n/** @packageDocumentation\n * @module MapLayersFormats\n */\nimport { assert } from \"@itwin/core-bentley\";\nimport { Localization } from \"@itwin/core-common\";\nimport { IModelApp } from \"@itwin/core-frontend\";\nimport { ArcGisFeatureMapLayerFormat } from \"./ArcGisFeature/ArcGisFeatureFormat.js\";\nimport { GoogleMapsMapLayerFormat } from \"./GoogleMaps/GoogleMapsImageryFormat.js\";\nimport { OgcApiFeaturesMapLayerFormat } from \"./OgcApiFeatures/OgcApiFeaturesFormat.js\";\nimport { MapFeatureInfoTool } from \"./Tools/MapFeatureInfoTool.js\";\nimport { GoogleMapsSessionManager } from \"./map-layers-formats.js\";\n\n/** Configuration options.\n * @beta\n */\nexport interface MapLayersFormatsConfig {\n  localization?: Localization;\n  googleMapsOpts?: GoogleMapsOptions;\n}\n\n/** Google Maps options.\n * @beta\n */\nexport interface GoogleMapsOptions {\n  sessionManager?: GoogleMapsSessionManager\n}\n\n/** The primary API for the `@itwin/map-layers-formats` package. It allows the package's features to be [[initialize]]d.\n * @beta\n */\nexport class MapLayersFormats {\n\n  private static _defaultNs = \"mapLayersFormats\";\n  public static localization: Localization;\n\n  private static _googleMapsOpts?: GoogleMapsOptions;\n\n  /** Registers the [MapLayerFormat]($frontend)s provided by this package for use with [IModelApp]($frontend).\n   * Typically, an application will call `MapLayersFormats.initialize` immediately after [IModelApp.startup]($frontend).\n   * This function has no effect if called **before** [IModelApp.startup]($frontend) or **after** [IModelApp.shutdown]($frontend).\n   */\n  public static async initialize(config?: MapLayersFormatsConfig): Promise<void> {\n    assert(IModelApp.initialized, \"MapLayersFormats.initialize must be called after IModelApp.startup and before IModelApp.shutdown\");\n    if (IModelApp.initialized) {\n      IModelApp.mapLayerFormatRegistry.register(ArcGisFeatureMapLayerFormat);\n      IModelApp.mapLayerFormatRegistry.register(OgcApiFeaturesMapLayerFormat);\n      IModelApp.mapLayerFormatRegistry.register(GoogleMapsMapLayerFormat);\n    }\n\n    // register namespace containing localized strings for this package\n    MapLayersFormats.localization = config?.localization ?? IModelApp.localization;\n    await MapLayersFormats.localization.registerNamespace(\n      MapLayersFormats.localizationNamespace,\n    );\n\n    MapFeatureInfoTool.register(MapLayersFormats.localizationNamespace);\n    MapLayersFormats._googleMapsOpts = config?.googleMapsOpts;\n  }\n\n  /** The internationalization service namespace. */\n  public static get localizationNamespace(): string {\n    return MapLayersFormats._defaultNs;\n  }\n\n  public static get googleMapsOpts() {\n    return MapLayersFormats._googleMapsOpts;\n  }\n\n}\n"]}

package/lib/esm/GoogleMaps/GoogleMaps.d.ts

@@ -2,131 +2,7 @@
  * @module MapLayersFormats
  */
 import { BaseMapLayerSettings, ImageMapLayerSettings } from "@itwin/core-common";
-import { MapCartoRectangle } from "@itwin/core-frontend";
-/**
- * The type of base map.
- * @beta*/
-export type GoogleMapsLayerTypes = "layerRoadmap" | "layerStreetview";
-/**
- *  Layer types that can be added to the map.
- * @beta
- * */
-export type GoogleMapsMapTypes = "roadmap" | "satellite" | "terrain";
-/**
- * Scale factors that can be applied to labels and objects in the map.
- * @beta
- * */
-export type GoogleMapsScaleFactors = "scaleFactor1x" | "scaleFactor2x" | "scaleFactor4x";
-/**
-* Represents the options to create a Google Maps session.
-* @beta
-*/
-export interface GoogleMapsCreateSessionOptions {
-    /**
-   * The type of base map.
-   *
-   * `roadmap`: The standard Google Maps painted map tiles.
-   *
-   * `satellite`: Satellite imagery.
-   *
-   * `terrain`: Terrain imagery. When selecting `terrain` as the map type, you must also include the `layerRoadmap` layer type.
-   * @beta
-   * */
-    mapType: GoogleMapsMapTypes;
-    /**
-     * An {@link https://en.wikipedia.org/wiki/IETF_language_tag | IETF language tag} that specifies the language used to display information on the tiles. For example, `en-US` specifies the English language as spoken in the United States.
-     */
-    language: string;
-    /**
-    * A {@link https://cldr.unicode.org/ | Common Locale Data Repository}  region identifier (two uppercase letters) that represents the physical location of the user. For example, `US`.
-    */
-    region: string;
-    /**
-     * An array of values that specifies the layer types added to the map.
-     *
-     * `layerRoadmap`: Required if you specify terrain as the map type. Can also be optionally overlaid on the satellite map type. Has no effect on roadmap tiles.
-     *
-     * `layerStreetview`: Shows Street View-enabled streets and locations using blue outlines on the map.
-     *
-     * @beta
-     * */
-    layerTypes?: GoogleMapsLayerTypes[];
-    /**
-     * Scales-up the size of map elements (such as road labels), while retaining the tile size and coverage area of the default tile.
-     * Increasing the scale also reduces the number of labels on the map, which reduces clutter.
-     *
-     * `scaleFactor1x`: The default.
-     *
-     * `scaleFactor2x`: Doubles label size and removes minor feature labels.
-     *
-     * `scaleFactor4x`: Quadruples label size and removes minor feature labels.
-     * @beta
-     * */
-    scale?: GoogleMapsScaleFactors;
-    /**
-     * A boolean value that specifies whether layerTypes should be rendered as a separate overlay, or combined with the base imagery.
-     * When true, the base map isn't displayed. If you haven't defined any layerTypes, then this value is ignored.
-     * Default is false.
-     * @beta
-     * */
-    overlay?: boolean;
-    /**
-     * An array of values specifying additional options to apply.
-     * @beta
-     * */
-    apiOptions?: string[];
-}
-/**
-* Structure representing a Google Maps session.
-* @beta
-*/
-export interface GoogleMapsSession {
-    /** A session token value that you must include in all of your Map Tiles API requests. */
-    session: string;
-    /**  string that contains the time (in seconds since the epoch) at which the token expires. A session token is valid for two weeks from its creation time, but this policy might change without notice. */
-    expiry: number;
-    /** The width of the tiles measured in pixels. */
-    tileWidth: number;
-    /** he height of the tiles measured in pixels. */
-    tileHeight: number;
-    /** The image format, which can be either `png` or `jpeg`. */
-    imageFormat: string;
-}
-/**
- * Represents the maximum zoom level available within a bounding rectangle.
-* @beta
-*/
-export interface MaxZoomRectangle {
-    maxZoom: number;
-    north: number;
-    south: number;
-    east: number;
-    west: number;
-}
-/**
- * Indicate which areas of given viewport have imagery, and at which zoom levels.
- * @beta
-*/
-export interface ViewportInfo {
-    /**  Attribution string that you must display on your map when you display roadmap and satellite tiles. */
-    copyright: string;
-    /** Array of bounding rectangles that overlap with the current viewport. Also contains the maximum zoom level available within each rectangle.. */
-    maxZoomRects: MaxZoomRectangle[];
-}
-/**
- * Request parameters for the getViewportInfo method.
- * @beta
-*/
-export interface ViewportInfoRequestParams {
-    /** Bounding rectangle */
-    rectangle: MapCartoRectangle;
-    /** Session token */
-    session: string;
-    /** The Google Cloud API key */
-    key: string;
-    /** Zoom level of the viewport */
-    zoom: number;
-}
+import { GoogleMapsCreateSessionOptions } from "./GoogleMapsSession.js";
 /**
  * Google Maps API
  * @beta
@@ -162,5 +38,12 @@ export declare const GoogleMaps: {
      * @beta
     */
     createBaseLayerSettings: (opts?: GoogleMapsCreateSessionOptions) => BaseMapLayerSettings;
+    /**
+     * Read the session options from the map layer settings.
+     * @param settings Map layer settings
+     * ```
+     * @beta
+    */
+    getMapLayerSessionOptions: (settings: ImageMapLayerSettings) => GoogleMapsCreateSessionOptions;
 };
 //# sourceMappingURL=GoogleMaps.d.ts.map

package/lib/esm/GoogleMaps/GoogleMaps.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"GoogleMaps.d.ts","sourceRoot":"","sources":["../../../src/GoogleMaps/GoogleMaps.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AACjF,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAIzD;;UAEU;AACV,MAAM,MAAM,oBAAoB,GAAG,cAAc,GAAG,iBAAiB,CAAC;AAEtE;;;KAGK;AACL,MAAM,MAAM,kBAAkB,GAAI,SAAS,GAAC,WAAW,GAAC,SAAS,CAAC;AAElE;;;KAGK;AACL,MAAM,MAAM,sBAAsB,GAAI,eAAe,GAAG,eAAe,GAAG,eAAe,CAAC;AAE1F;;;EAGE;AACF,MAAM,WAAW,8BAA8B;IAC3C;;;;;;;;;OASG;IACL,OAAO,EAAE,kBAAkB,CAAC;IAC5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACf;;MAEE;IACJ,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;SAQK;IACL,UAAU,CAAC,EAAE,oBAAoB,EAAE,CAAC;IAEpC;;;;;;;;;;SAUK;IACL,KAAK,CAAC,EAAE,sBAAsB,CAAA;IAE9B;;;;;SAKK;IACH,OAAO,CAAC,EAAG,OAAO,CAAC;IAEnB;;;SAGK;IACL,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB;AAED;;;EAGE;AACF,MAAM,WAAW,iBAAiB;IAChC,yFAAyF;IACzF,OAAO,EAAE,MAAM,CAAC;IAEhB,0MAA0M;IAC1M,MAAM,EAAE,MAAM,CAAC;IAEf,iDAAiD;IACjD,SAAS,EAAE,MAAM,CAAC;IAElB,iDAAiD;IACjD,UAAU,EAAE,MAAM,CAAC;IAEnB,6DAA6D;IAC7D,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;EAGE;AACF,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;EAGE;AACF,MAAM,WAAW,YAAY;IAC3B,0GAA0G;IAC1G,SAAS,EAAE,MAAM,CAAC;IAElB,kJAAkJ;IAClJ,YAAY,EAAE,gBAAgB,EAAE,CAAC;CAClC;AAED;;;EAGE;AACF,MAAM,WAAW,yBAAyB;IACxC,yBAAyB;IACzB,SAAS,EAAE,iBAAiB,CAAC;IAE7B,oBAAoB;IACpB,OAAO,EAAE,MAAM,CAAC;IAEhB,+BAA+B;IAC/B,GAAG,EAAE,MAAM,CAAC;IAEZ,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;EAGE;AAEF,eAAO,MAAM,UAAU;IACvB;;;;;;;;;;;;;MAaE;oCACgC,MAAM,SAAS,8BAA8B;IAI/E;;;;;;;;;;;;;MAaE;qCACiC,8BAA8B;CAGhE,CAAC"}
+{"version":3,"file":"GoogleMaps.d.ts","sourceRoot":"","sources":["../../../src/GoogleMaps/GoogleMaps.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AACjF,OAAO,EAAE,8BAA8B,EAAE,MAAM,wBAAwB,CAAC;AAIxE;;;EAGE;AAEF,eAAO,MAAM,UAAU;IACrB;;;;;;;;;;;;;MAaE;oCAC8B,MAAM,SAAS,8BAA8B;IAI7E;;;;;;;;;;;;;MAaE;qCAC+B,8BAA8B;IAI/D;;;;;MAKE;0CACoC,qBAAqB;CAG5D,CAAC"}

package/lib/esm/GoogleMaps/GoogleMaps.js

@@ -7,8 +7,6 @@
  */
 import { BaseMapLayerSettings, ImageMapLayerSettings } from "@itwin/core-common";
 import { GoogleMapsUtils } from "../internal/GoogleMapsUtils.js";
-;
-;
 /**
  * Google Maps API
  * @beta
@@ -48,6 +46,15 @@ export const GoogleMaps = {
     */
     createBaseLayerSettings: (opts) => {
         return BaseMapLayerSettings.fromJSON(GoogleMapsUtils.createMapLayerProps("GoogleMaps", opts));
-    }
+    },
+    /**
+     * Read the session options from the map layer settings.
+     * @param settings Map layer settings
+     * ```
+     * @beta
+    */
+    getMapLayerSessionOptions: (settings) => {
+        return GoogleMapsUtils.getSessionOptionsFromMapLayer(settings);
+    },
 };
 //# sourceMappingURL=GoogleMaps.js.map

package/lib/esm/GoogleMaps/GoogleMaps.js.map

@@ -1 +1 @@
-{"version":3,"file":"GoogleMaps.js","sourceRoot":"","sources":["../../../src/GoogleMaps/GoogleMaps.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAEjF,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AAkFhE,CAAC;AAqBD,CAAC;AA4CF;;;EAGE;AACF,gEAAgE;AAChE,MAAM,CAAC,MAAM,UAAU,GAAG;IAC1B;;;;;;;;;;;;;MAaE;IACA,sBAAsB,EAAE,CAAC,IAAa,EAAE,IAAqC,EAAE,EAAE;QAC/E,OAAO,qBAAqB,CAAC,QAAQ,CAAC,eAAe,CAAC,mBAAmB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;IACzF,CAAC;IAEH;;;;;;;;;;;;;MAaE;IACA,uBAAuB,EAAE,CAAC,IAAqC,EAAE,EAAE;QACjE,OAAO,oBAAoB,CAAC,QAAQ,CAAC,eAAe,CAAC,mBAAmB,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC;IAChG,CAAC;CACF,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module MapLayersFormats\n */\n\nimport { BaseMapLayerSettings, ImageMapLayerSettings } from \"@itwin/core-common\";\nimport { MapCartoRectangle } from \"@itwin/core-frontend\";\nimport { GoogleMapsUtils } from \"../internal/GoogleMapsUtils.js\";\n\n\n/**\n * The type of base map.\n * @beta*/\nexport type GoogleMapsLayerTypes = \"layerRoadmap\" | \"layerStreetview\";\n\n/**\n *  Layer types that can be added to the map.\n * @beta\n * */\nexport type GoogleMapsMapTypes =  \"roadmap\"|\"satellite\"|\"terrain\";\n\n/**\n * Scale factors that can be applied to labels and objects in the map.\n * @beta\n * */\nexport type GoogleMapsScaleFactors =  \"scaleFactor1x\" | \"scaleFactor2x\" | \"scaleFactor4x\";\n\n/**\n* Represents the options to create a Google Maps session.\n* @beta\n*/\nexport interface GoogleMapsCreateSessionOptions {\n    /**\n   * The type of base map.\n   *\n   * `roadmap`: The standard Google Maps painted map tiles.\n   *\n   * `satellite`: Satellite imagery.\n   *\n   * `terrain`: Terrain imagery. When selecting `terrain` as the map type, you must also include the `layerRoadmap` layer type.\n   * @beta\n   * */\n  mapType: GoogleMapsMapTypes,\n  /**\n   * An {@link https://en.wikipedia.org/wiki/IETF_language_tag | IETF language tag} that specifies the language used to display information on the tiles. For example, `en-US` specifies the English language as spoken in the United States.\n   */\n  language: string;\n    /**\n    * A {@link https://cldr.unicode.org/ | Common Locale Data Repository}  region identifier (two uppercase letters) that represents the physical location of the user. For example, `US`.\n    */\n  region: string;\n\n  /**\n   * An array of values that specifies the layer types added to the map.\n   *\n   * `layerRoadmap`: Required if you specify terrain as the map type. Can also be optionally overlaid on the satellite map type. Has no effect on roadmap tiles.\n   *\n   * `layerStreetview`: Shows Street View-enabled streets and locations using blue outlines on the map.\n   *\n   * @beta\n   * */\n  layerTypes?: GoogleMapsLayerTypes[];\n\n  /**\n   * Scales-up the size of map elements (such as road labels), while retaining the tile size and coverage area of the default tile.\n   * Increasing the scale also reduces the number of labels on the map, which reduces clutter.\n   *\n   * `scaleFactor1x`: The default.\n   *\n   * `scaleFactor2x`: Doubles label size and removes minor feature labels.\n   *\n   * `scaleFactor4x`: Quadruples label size and removes minor feature labels.\n   * @beta\n   * */\n  scale?: GoogleMapsScaleFactors\n\n  /**\n   * A boolean value that specifies whether layerTypes should be rendered as a separate overlay, or combined with the base imagery.\n   * When true, the base map isn't displayed. If you haven't defined any layerTypes, then this value is ignored.\n   * Default is false.\n   * @beta\n   * */\n    overlay? : boolean;\n\n    /**\n     * An array of values specifying additional options to apply.\n     * @beta\n     * */\n    apiOptions?: string[];\n};\n\n/**\n* Structure representing a Google Maps session.\n* @beta\n*/\nexport interface GoogleMapsSession {\n  /** A session token value that you must include in all of your Map Tiles API requests. */\n  session: string;\n\n  /**  string that contains the time (in seconds since the epoch) at which the token expires. A session token is valid for two weeks from its creation time, but this policy might change without notice. */\n  expiry: number;\n\n  /** The width of the tiles measured in pixels. */\n  tileWidth: number;\n\n  /** he height of the tiles measured in pixels. */\n  tileHeight: number;\n\n  /** The image format, which can be either `png` or `jpeg`. */\n  imageFormat: string;\n};\n\n/**\n * Represents the maximum zoom level available within a bounding rectangle.\n* @beta\n*/\nexport interface MaxZoomRectangle {\n  maxZoom: number;\n  north: number;\n  south: number;\n  east: number;\n  west: number;\n}\n\n/**\n * Indicate which areas of given viewport have imagery, and at which zoom levels.\n * @beta\n*/\nexport interface ViewportInfo {\n  /**  Attribution string that you must display on your map when you display roadmap and satellite tiles. */\n  copyright: string;\n\n  /** Array of bounding rectangles that overlap with the current viewport. Also contains the maximum zoom level available within each rectangle.. */\n  maxZoomRects: MaxZoomRectangle[];\n}\n\n/**\n * Request parameters for the getViewportInfo method.\n * @beta\n*/\nexport interface ViewportInfoRequestParams {\n  /** Bounding rectangle */\n  rectangle: MapCartoRectangle;\n\n  /** Session token */\n  session: string;\n\n  /** The Google Cloud API key */\n  key: string;\n\n  /** Zoom level of the viewport */\n  zoom: number;\n}\n\n/**\n * Google Maps API\n * @beta\n*/\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const GoogleMaps = {\n/**\n * Creates Google Maps map-layer settings.\n * @param name Name of the layer (Defaults to \"GoogleMaps\")\n * @param opts Options to create the session  (Defaults to satellite map type, English language, US region, and roadmap layer type)\n *\n * The following examples illustrates how a Googles Map layer can be attached to a viewport:\n * ```ts\n * [[include:GoogleMaps_AttachMapLayerSimple]]\n * ```\n * ```ts\n * [[include:GoogleMaps_AttachMapLayerOpts]]\n * ```\n * @beta\n*/\n  createMapLayerSettings: (name?: string, opts?: GoogleMapsCreateSessionOptions) => {\n    return ImageMapLayerSettings.fromJSON(GoogleMapsUtils.createMapLayerProps(name, opts));\n  },\n\n/**\n * Creates Google Maps base layer settings.\n * @param name Name of the layer (Defaults to \"GoogleMaps\")\n * @param opts Options to create the session  (Defaults to satellite map type, English language, US region, and roadmap layer type)\n *\n * The following examples illustrates how a Google Maps base layer can be set on a viewport:\n * ```ts\n * [[include:GoogleMaps_BaseMapSimple]]\n * ```\n * ```ts\n * [[include:GoogleMaps_BaseMapOpts]]\n * ```\n * @beta\n*/\n  createBaseLayerSettings: (opts?: GoogleMapsCreateSessionOptions) => {\n    return BaseMapLayerSettings.fromJSON(GoogleMapsUtils.createMapLayerProps(\"GoogleMaps\", opts));\n  }\n};"]}
+{"version":3,"file":"GoogleMaps.js","sourceRoot":"","sources":["../../../src/GoogleMaps/GoogleMaps.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAEjF,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AAGjE;;;EAGE;AACF,gEAAgE;AAChE,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB;;;;;;;;;;;;;MAaE;IACF,sBAAsB,EAAE,CAAC,IAAa,EAAE,IAAqC,EAAE,EAAE;QAC/E,OAAO,qBAAqB,CAAC,QAAQ,CAAC,eAAe,CAAC,mBAAmB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;;;;MAaE;IACF,uBAAuB,EAAE,CAAC,IAAqC,EAAE,EAAE;QACjE,OAAO,oBAAoB,CAAC,QAAQ,CAAC,eAAe,CAAC,mBAAmB,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC;IAChG,CAAC;IAED;;;;;MAKE;IACF,yBAAyB,EAAE,CAAC,QAA+B,EAAE,EAAE;QAC7D,OAAO,eAAe,CAAC,6BAA6B,CAAC,QAAQ,CAAC,CAAC;IACjE,CAAC;CACF,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module MapLayersFormats\n */\n\nimport { BaseMapLayerSettings, ImageMapLayerSettings } from \"@itwin/core-common\";\nimport { GoogleMapsCreateSessionOptions } from \"./GoogleMapsSession.js\";\nimport { GoogleMapsUtils } from \"../internal/GoogleMapsUtils.js\";\n\n\n/**\n * Google Maps API\n * @beta\n*/\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const GoogleMaps = {\n  /**\n   * Creates Google Maps map-layer settings.\n   * @param name Name of the layer (Defaults to \"GoogleMaps\")\n   * @param opts Options to create the session  (Defaults to satellite map type, English language, US region, and roadmap layer type)\n   *\n   * The following examples illustrates how a Googles Map layer can be attached to a viewport:\n   * ```ts\n   * [[include:GoogleMaps_AttachMapLayerSimple]]\n   * ```\n   * ```ts\n   * [[include:GoogleMaps_AttachMapLayerOpts]]\n   * ```\n   * @beta\n  */\n  createMapLayerSettings: (name?: string, opts?: GoogleMapsCreateSessionOptions) => {\n    return ImageMapLayerSettings.fromJSON(GoogleMapsUtils.createMapLayerProps(name, opts));\n  },\n\n  /**\n   * Creates Google Maps base layer settings.\n   * @param name Name of the layer (Defaults to \"GoogleMaps\")\n   * @param opts Options to create the session  (Defaults to satellite map type, English language, US region, and roadmap layer type)\n   *\n   * The following examples illustrates how a Google Maps base layer can be set on a viewport:\n   * ```ts\n   * [[include:GoogleMaps_BaseMapSimple]]\n   * ```\n   * ```ts\n   * [[include:GoogleMaps_BaseMapOpts]]\n   * ```\n   * @beta\n  */\n  createBaseLayerSettings: (opts?: GoogleMapsCreateSessionOptions) => {\n    return BaseMapLayerSettings.fromJSON(GoogleMapsUtils.createMapLayerProps(\"GoogleMaps\", opts));\n  },\n\n  /**\n   * Read the session options from the map layer settings.\n   * @param settings Map layer settings\n   * ```\n   * @beta\n  */\n  getMapLayerSessionOptions: (settings: ImageMapLayerSettings) => {\n    return GoogleMapsUtils.getSessionOptionsFromMapLayer(settings);\n  },\n};\n"]}

package/lib/esm/GoogleMaps/GoogleMapsImageryFormat.d.ts

@@ -3,8 +3,16 @@
  */
 import { ImageMapLayerSettings } from "@itwin/core-common";
 import { ImageryMapLayerFormat, MapLayerImageryProvider } from "@itwin/core-frontend";
+/**
+ * Google Maps imagery layer format.
+ * @public
+ */
 export declare class GoogleMapsMapLayerFormat extends ImageryMapLayerFormat {
+    /** Google Maps imagery layer format.
+     * @public
+     */
     static formatId: string;
+    /** @internal */
     static createImageryProvider(settings: ImageMapLayerSettings): MapLayerImageryProvider | undefined;
 }
 //# sourceMappingURL=GoogleMapsImageryFormat.d.ts.map

package/lib/esm/GoogleMaps/GoogleMapsImageryFormat.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"GoogleMapsImageryFormat.d.ts","sourceRoot":"","sources":["../../../src/GoogleMaps/GoogleMapsImageryFormat.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AAGtF,qBAAa,wBAAyB,SAAQ,qBAAqB;IACjE,OAAuB,QAAQ,SAAgB;WACxB,qBAAqB,CAAC,QAAQ,EAAE,qBAAqB,GAAG,uBAAuB,GAAG,SAAS;CAGnH"}
+{"version":3,"file":"GoogleMapsImageryFormat.d.ts","sourceRoot":"","sources":["../../../src/GoogleMaps/GoogleMapsImageryFormat.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AAItF;;;GAGG;AACH,qBAAa,wBAAyB,SAAQ,qBAAqB;IACjE;;OAEG;IACH,OAAuB,QAAQ,SAAgB;IAE/C,gBAAgB;WACO,qBAAqB,CAAC,QAAQ,EAAE,qBAAqB,GAAG,uBAAuB,GAAG,SAAS;CAGnH"}

package/lib/esm/GoogleMaps/GoogleMapsImageryFormat.js

@@ -7,10 +7,19 @@
  */
 import { ImageryMapLayerFormat } from "@itwin/core-frontend";
 import { GoogleMapsImageryProvider } from "./GoogleMapsImageryProvider.js";
+import { MapLayersFormats } from "../mapLayersFormats.js";
+/**
+ * Google Maps imagery layer format.
+ * @public
+ */
 export class GoogleMapsMapLayerFormat extends ImageryMapLayerFormat {
+    /** Google Maps imagery layer format.
+     * @public
+     */
     static formatId = "GoogleMaps";
+    /** @internal */
     static createImageryProvider(settings) {
-        return new GoogleMapsImageryProvider(settings);
+        return new GoogleMapsImageryProvider(settings, MapLayersFormats.googleMapsOpts?.sessionManager);
     }
 }
 //# sourceMappingURL=GoogleMapsImageryFormat.js.map

package/lib/esm/GoogleMaps/GoogleMapsImageryFormat.js.map

@@ -1 +1 @@
-{"version":3,"file":"GoogleMapsImageryFormat.js","sourceRoot":"","sources":["../../../src/GoogleMaps/GoogleMapsImageryFormat.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,qBAAqB,EAA2B,MAAM,sBAAsB,CAAC;AACtF,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAE3E,MAAM,OAAO,wBAAyB,SAAQ,qBAAqB;IAC1D,MAAM,CAAU,QAAQ,GAAG,YAAY,CAAC;IACxC,MAAM,CAAU,qBAAqB,CAAC,QAA+B;QAC1E,OAAO,IAAI,yBAAyB,CAAC,QAAQ,CAAC,CAAC;IACjD,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module MapLayersFormats\n */\n\nimport { ImageMapLayerSettings } from \"@itwin/core-common\";\nimport { ImageryMapLayerFormat, MapLayerImageryProvider } from \"@itwin/core-frontend\";\nimport { GoogleMapsImageryProvider } from \"./GoogleMapsImageryProvider.js\";\n\nexport class GoogleMapsMapLayerFormat extends ImageryMapLayerFormat {\n  public static override formatId = \"GoogleMaps\";\n  public static override createImageryProvider(settings: ImageMapLayerSettings): MapLayerImageryProvider | undefined {\n    return new GoogleMapsImageryProvider(settings);\n  }\n}\n"]}
+{"version":3,"file":"GoogleMapsImageryFormat.js","sourceRoot":"","sources":["../../../src/GoogleMaps/GoogleMapsImageryFormat.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,qBAAqB,EAA2B,MAAM,sBAAsB,CAAC;AACtF,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAC3E,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D;;;GAGG;AACH,MAAM,OAAO,wBAAyB,SAAQ,qBAAqB;IACjE;;OAEG;IACI,MAAM,CAAU,QAAQ,GAAG,YAAY,CAAC;IAE/C,gBAAgB;IACT,MAAM,CAAU,qBAAqB,CAAC,QAA+B;QAC1E,OAAO,IAAI,yBAAyB,CAAC,QAAQ,EAAE,gBAAgB,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;IAClG,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module MapLayersFormats\n */\n\nimport { ImageMapLayerSettings } from \"@itwin/core-common\";\nimport { ImageryMapLayerFormat, MapLayerImageryProvider } from \"@itwin/core-frontend\";\nimport { GoogleMapsImageryProvider } from \"./GoogleMapsImageryProvider.js\";\nimport { MapLayersFormats } from \"../mapLayersFormats.js\";\n\n/**\n * Google Maps imagery layer format.\n * @public\n */\nexport class GoogleMapsMapLayerFormat extends ImageryMapLayerFormat {\n  /** Google Maps imagery layer format.\n   * @public\n   */\n  public static override formatId = \"GoogleMaps\";\n\n  /** @internal */\n  public static override createImageryProvider(settings: ImageMapLayerSettings): MapLayerImageryProvider | undefined {\n    return new GoogleMapsImageryProvider(settings, MapLayersFormats.googleMapsOpts?.sessionManager);\n  }\n}\n"]}

package/lib/esm/GoogleMaps/GoogleMapsImageryProvider.d.ts

@@ -2,19 +2,22 @@
  * @module MapLayersFormats
  */
 import { ImageMapLayerSettings, ImageSource } from "@itwin/core-common";
-import { DecorateContext, MapLayerImageryProvider, MapLayerSourceValidation, ScreenViewport } from "@itwin/core-frontend";
-import { GoogleMapsSession } from "./GoogleMaps.js";
+import { DecorateContext, MapCartoRectangle, MapLayerImageryProvider, ScreenViewport } from "@itwin/core-frontend";
+import { GoogleMapsCreateSessionOptions, GoogleMapsSessionManager, ViewportInfo } from "./GoogleMapsSession.js";
 export declare class GoogleMapsImageryProvider extends MapLayerImageryProvider {
     private _decorator;
     private _hadUnrecoverableError;
     private _tileSize;
-    constructor(settings: ImageMapLayerSettings);
-    static validateUrlTemplate(template: string): MapLayerSourceValidation;
-    protected createSession(): Promise<GoogleMapsSession | undefined>;
+    private _sessionManager?;
+    private _sessionOptions;
+    private _activeSession?;
+    constructor(settings: ImageMapLayerSettings, sessionManager?: GoogleMapsSessionManager);
     get tileSize(): number;
     initialize(): Promise<void>;
-    private createCreateSessionOptions;
-    constructUrl(row: number, column: number, level: number): Promise<string>;
+    protected getSessionManager(): Promise<GoogleMapsSessionManager>;
+    protected createCreateSessionOptions(settings: ImageMapLayerSettings): GoogleMapsCreateSessionOptions;
+    constructUrl(_row: number, _column: number, _level: number): Promise<string>;
+    fetchViewportInfo(rectangle: MapCartoRectangle, zoomLevel: number): Promise<ViewportInfo>;
     private fetchAttributions;
     private logJsonError;
     loadTile(row: number, column: number, zoomLevel: number): Promise<ImageSource | undefined>;

package/lib/esm/GoogleMaps/GoogleMapsImageryProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"GoogleMapsImageryProvider.d.ts","sourceRoot":"","sources":["../../../src/GoogleMaps/GoogleMapsImageryProvider.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,qBAAqB,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACxE,OAAO,EAAE,eAAe,EAAgC,uBAAuB,EAAwB,wBAAwB,EAAW,cAAc,EAAQ,MAAM,sBAAsB,CAAC;AAG7L,OAAO,EAAoG,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAatJ,qBAAa,yBAA0B,SAAQ,uBAAuB;IAEpE,OAAO,CAAC,UAAU,CAAsB;IACxC,OAAO,CAAC,sBAAsB,CAAS;IACvC,OAAO,CAAC,SAAS,CAAM;gBACX,QAAQ,EAAE,qBAAqB;WAI7B,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,wBAAwB;cAI7D,aAAa,IAAK,OAAO,CAAC,iBAAiB,GAAC,SAAS,CAAC;IAYtE,IAAoB,QAAQ,IAAI,MAAM,CAA2B;IAE3C,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IA4BjD,OAAO,CAAC,0BAA0B;IAoCrB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;YAWxE,iBAAiB;YAqCjB,YAAY;IASJ,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;IA0ChG,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,IAAI;IAIxD,OAAO,CAAC,gBAAgB;IAIF,eAAe,CAAE,KAAK,EAAE,gBAAgB,EAAE,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAuBnG"}
+{"version":3,"file":"GoogleMapsImageryProvider.d.ts","sourceRoot":"","sources":["../../../src/GoogleMaps/GoogleMapsImageryProvider.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,qBAAqB,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACxE,OAAO,EAAE,eAAe,EAAkC,iBAAiB,EAAE,uBAAuB,EAAwB,cAAc,EAAQ,MAAM,sBAAsB,CAAC;AAC/K,OAAO,EAAE,8BAA8B,EAAuF,wBAAwB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAUrM,qBAAa,yBAA0B,SAAQ,uBAAuB;IAEpE,OAAO,CAAC,UAAU,CAAsB;IACxC,OAAO,CAAC,sBAAsB,CAAS;IACvC,OAAO,CAAC,SAAS,CAAO;IACxB,OAAO,CAAC,eAAe,CAAC,CAA2B;IACnD,OAAO,CAAC,eAAe,CAA2C;IAClE,OAAO,CAAC,cAAc,CAAC,CAAoB;gBAC/B,QAAQ,EAAE,qBAAqB,EAAE,cAAc,CAAC,EAAE,wBAAwB;IAMtF,IAAoB,QAAQ,IAAI,MAAM,CAA2B;IAE3C,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;cAajC,iBAAiB,IAAK,OAAO,CAAC,wBAAwB,CAAC;IAavE,SAAS,CAAC,0BAA0B,CAAC,QAAQ,EAAE,qBAAqB,GAAG,8BAA8B;IAoCxF,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAI5E,iBAAiB,CAAC,SAAS,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;YAoBxF,iBAAiB;YAiCjB,YAAY;IASJ,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;IAiDhG,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,IAAI;IAIxD,OAAO,CAAC,gBAAgB;IAIF,eAAe,CAAE,KAAK,EAAE,gBAAgB,EAAE,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAsBnG"}

package/lib/esm/GoogleMaps/GoogleMapsImageryProvider.js

@@ -6,69 +6,54 @@
  * @module MapLayersFormats
  */
 import { BentleyError, BentleyStatus, Logger } from "@itwin/core-bentley";
-import { IModelApp, MapCartoRectangle, MapLayerImageryProvider, MapLayerSourceStatus, MapTile } from "@itwin/core-frontend";
+import { GoogleMapsDecorator, IModelApp, MapCartoRectangle, MapLayerImageryProvider, MapTile } from "@itwin/core-frontend";
+import { NativeGoogleMapsSessionManager } from "../internal/NativeGoogleMapsSession.js";
 import { GoogleMapsUtils } from "../internal/GoogleMapsUtils.js";
-import { GoogleMapsDecorator } from "./GoogleMapDecorator.js";
 const loggerCategory = "MapLayersFormats.GoogleMaps";
-const levelToken = "{level}";
-const rowToken = "{row}";
-const columnToken = "{column}";
-const urlTemplate = `https://tile.googleapis.com/v1/2dtiles/${levelToken}/${columnToken}/${rowToken}`;
 /*
 * Google Maps imagery provider
-* @internal
+* @beta
 */
 export class GoogleMapsImageryProvider extends MapLayerImageryProvider {
     _decorator;
     _hadUnrecoverableError = false;
     _tileSize = 256;
-    constructor(settings) {
+    _sessionManager;
+    _sessionOptions;
+    _activeSession;
+    constructor(settings, sessionManager) {
         super(settings, true);
         this._decorator = new GoogleMapsDecorator();
-    }
-    static validateUrlTemplate(template) {
-        return { status: (template.indexOf(levelToken) > 0 && template.indexOf(columnToken) > 0 && template.indexOf(rowToken) > 0) ? MapLayerSourceStatus.Valid : MapLayerSourceStatus.InvalidUrl };
-    }
-    async createSession() {
-        const sessionOptions = this.createCreateSessionOptions();
-        if (this._settings.accessKey) {
-            // Create session and store in query parameters
-            const sessionObj = await GoogleMapsUtils.createSession(this._settings.accessKey.value, sessionOptions);
-            this._settings.unsavedQueryParams = { session: sessionObj.session };
-            return sessionObj;
-        }
-        else {
-            Logger.logError(loggerCategory, `Missing GoogleMaps api key`);
-            return undefined;
-        }
+        this._sessionManager = sessionManager;
     }
     get tileSize() { return this._tileSize; }
     async initialize() {
-        const layerPropertyKeys = this._settings.properties ? Object.keys(this._settings.properties) : undefined;
-        if (layerPropertyKeys === undefined ||
-            !layerPropertyKeys.includes("mapType") ||
-            !layerPropertyKeys.includes("language") ||
-            !layerPropertyKeys.includes("region")) {
-            const msg = "Missing session options";
+        this._sessionOptions = GoogleMapsUtils.getSessionOptionsFromMapLayer(this._settings);
+        this._sessionManager = await this.getSessionManager();
+        this._activeSession = await this._sessionManager.createSession(this._sessionOptions);
+        ;
+        this._tileSize = this._activeSession.getTileSize();
+        const isActivated = await this._decorator.activate(this._settings.properties.mapType);
+        if (!isActivated) {
+            const msg = `Failed to activate decorator`;
             Logger.logError(loggerCategory, msg);
             throw new BentleyError(BentleyStatus.ERROR, msg);
         }
-        const session = await this.createSession();
-        if (!session) {
-            const msg = `Failed to create session`;
-            Logger.logError(loggerCategory, msg);
-            throw new BentleyError(BentleyStatus.ERROR, msg);
+    }
+    async getSessionManager() {
+        if (this._sessionManager)
+            return this._sessionManager;
+        if (this._settings.accessKey?.value) {
+            return new NativeGoogleMapsSessionManager(this._settings.accessKey.value);
         }
-        this._tileSize = session.tileWidth; // assuming here tiles are square
-        const isActivated = await this._decorator.activate(this._settings.properties.mapType);
-        if (!isActivated) {
-            const msg = `Failed to activate decorator`;
+        else {
+            const msg = `Missing GoogleMaps api key`;
             Logger.logError(loggerCategory, msg);
             throw new BentleyError(BentleyStatus.ERROR, msg);
         }
     }
-    createCreateSessionOptions() {
-        const layerPropertyKeys = this._settings.properties ? Object.keys(this._settings.properties) : undefined;
+    createCreateSessionOptions(settings) {
+        const layerPropertyKeys = settings.properties ? Object.keys(settings.properties) : undefined;
         if (layerPropertyKeys === undefined ||
             !layerPropertyKeys.includes("mapType") ||
             !layerPropertyKeys.includes("language") ||
@@ -78,11 +63,11 @@ export class GoogleMapsImageryProvider extends MapLayerImageryProvider {
             throw new BentleyError(BentleyStatus.ERROR, msg);
         }
         const createSessionOptions = {
-            mapType: this._settings.properties.mapType,
+            mapType: settings.properties.mapType,
             region: this._settings.properties.region,
             language: this._settings.properties.language,
         };
-        if (this._settings.properties?.layerTypes !== undefined) {
+        if (Array.isArray(this._settings.properties?.layerTypes) && this._settings.properties.layerTypes.length > 0) {
             createSessionOptions.layerTypes = this._settings.properties.layerTypes;
         }
         if (this._settings.properties?.scale !== undefined) {
@@ -96,15 +81,27 @@ export class GoogleMapsImageryProvider extends MapLayerImageryProvider {
         }
         return createSessionOptions;
     }
-    // construct the Url from the desired Tile
-    async constructUrl(row, column, level) {
-        const tmpUrl = urlTemplate.replace(levelToken, level.toString()).replace(columnToken, column.toString()).replace(rowToken, row.toString());
-        const obj = new URL(tmpUrl);
-        if (this._settings.accessKey) {
-            obj.searchParams.append("key", this._settings.accessKey.value);
-        }
-        // We assume the 'session' param to be already part of the query parameters (checked in initialize)
-        return this.appendCustomParams(obj.toString());
+    // not used, see loadTile
+    async constructUrl(_row, _column, _level) {
+        return "";
+    }
+    async fetchViewportInfo(rectangle, zoomLevel) {
+        if (!this._activeSession) {
+            Logger.logError(loggerCategory, `Session is not initialized`);
+            throw new BentleyError(BentleyStatus.ERROR, "Session is not initialized");
+        }
+        const req = this._activeSession.getViewportInfoRequest(rectangle, zoomLevel);
+        const request = new Request(req.url, { method: "GET" });
+        if (req.authorization) {
+            request.headers.set("Authorization", req.authorization);
+        }
+        // Add the session token to the request
+        const response = await fetch(request);
+        if (!response.ok) {
+            Logger.logError(loggerCategory, `Error while loading viewport info: ${response.statusText}`);
+            throw new BentleyError(BentleyStatus.ERROR, `Error while loading viewport info: ${response.statusText}`);
+        }
+        return response.json();
     }
     async fetchAttributions(tiles) {
         const zooms = new Set();
@@ -123,14 +120,9 @@ export class GoogleMapsImageryProvider extends MapLayerImageryProvider {
                         cartoRect = rect;
                 }
             }
-            if (cartoRect) {
+            if (cartoRect && this._activeSession) {
                 try {
-                    const viewportInfo = await GoogleMapsUtils.getViewportInfo({
-                        rectangle: cartoRect,
-                        session: this._settings.collectQueryParams().session,
-                        key: this._settings.accessKey.value,
-                        zoom
-                    });
+                    const viewportInfo = await this.fetchViewportInfo(cartoRect, zoom);
                     if (viewportInfo?.copyright) {
                         matchingAttributions.push(viewportInfo.copyright);
                     }
@@ -152,18 +144,23 @@ export class GoogleMapsImageryProvider extends MapLayerImageryProvider {
         }
     }
     async loadTile(row, column, zoomLevel) {
+        const tilePos = { row, column, level: zoomLevel };
         if (this._hadUnrecoverableError)
             return undefined;
+        if (this._activeSession === undefined || this._sessionOptions === undefined) {
+            Logger.logError(loggerCategory, `Session manager is not initialized`);
+            return undefined;
+        }
         try {
-            let tileUrl = await this.constructUrl(row, column, zoomLevel);
-            let tileResponse = await this.makeTileRequest(tileUrl);
+            let tileRequest = this._activeSession.getTileRequest(tilePos);
+            let tileResponse = await this.makeTileRequest(tileRequest.url.toString(), undefined, tileRequest.authorization);
             if (!tileResponse.ok) {
-                if (tileResponse.headers.get("content-type")?.includes("application/json")) {
-                    // Session might have expired, lets try to re-new it.
-                    const isSessionCreated = await this.createSession();
-                    if (isSessionCreated) {
-                        tileUrl = await this.constructUrl(row, column, zoomLevel);
-                        tileResponse = await this.makeTileRequest(tileUrl);
+                if (tileResponse.headers.get("content-type")?.includes("application/json") && this._sessionManager) {
+                    try {
+                        // Session might have expired, lets try to refresh it
+                        this._activeSession = await this._sessionManager.createSession(this._sessionOptions);
+                        tileRequest = this._activeSession.getTileRequest(tilePos);
+                        tileResponse = await this.makeTileRequest(tileRequest.url.toString(), undefined, tileRequest.authorization);
                         if (!tileResponse.ok) {
                             if (tileResponse.headers.get("content-type")?.includes("application/json")) {
                                 await this.logJsonError(tileResponse);
@@ -175,7 +172,7 @@ export class GoogleMapsImageryProvider extends MapLayerImageryProvider {
                             return undefined;
                         }
                     }
-                    else {
+                    catch {
                         await this.logJsonError(tileResponse);
                     }
                 }