ol 9.0.0-dev.1708359055761 → 9.0.0-dev.1708371033297

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ol",
-  "version": "9.0.0-dev.1708359055761",
+  "version": "9.0.0-dev.1708371033297",
   "description": "OpenLayers mapping library",
   "keywords": [
     "map",

package/source/Google.d.ts

@@ -0,0 +1,255 @@
+export default Google;
+export type Options = {
+    /**
+     * Google Map Tiles API key. Get yours at https://developers.google.com/maps/documentation/tile/get-api-key.
+     */
+    key: string;
+    /**
+     * The type of [base map](https://developers.google.com/maps/documentation/tile/session_tokens#required_fields).
+     */
+    mapType?: string | undefined;
+    /**
+     * An [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) for information displayed on the tiles.
+     */
+    language?: string | undefined;
+    /**
+     * A [Common Locale Data Repository](https://cldr.unicode.org/) (CLDR) region identifier that represents the user location.
+     */
+    region?: string | undefined;
+    /**
+     * The image format used for the map tiles (e.g. `'jpeg'`, or `'png'`).
+     */
+    imageFormat?: string | undefined;
+    /**
+     * Scale for map elements (`'scaleFactor1x'`, `'scaleFactor2x'`, or `'scaleFactor4x'`).
+     */
+    scale?: string | undefined;
+    /**
+     * Use high-resolution tiles.
+     */
+    highDpi?: boolean | undefined;
+    /**
+     * The layer types added to the map (e.g. `'layerRoadmap'`, `'layerStreetview'`, or `'layerTraffic'`).
+     */
+    layerTypes?: string[] | undefined;
+    /**
+     * Display only the `layerTypes` and not the underlying `mapType` (only works if `layerTypes` is provided).
+     */
+    overlay?: boolean | undefined;
+    /**
+     * [Custom styles](https://developers.google.com/maps/documentation/tile/style-reference) applied to the map.
+     */
+    styles?: any[] | undefined;
+    /**
+     * Attributions.
+     */
+    attributions?: import("./Source.js").AttributionLike | undefined;
+    /**
+     * Use interpolated values when resampling.  By default,
+     * linear interpolation is used when resampling.  Set to false to use the nearest neighbor instead.
+     */
+    interpolate?: boolean | undefined;
+    /**
+     * Initial tile cache size. Will auto-grow to hold at least the number of tiles in the viewport.
+     */
+    cacheSize?: number | undefined;
+    /**
+     * Maximum allowed reprojection error (in pixels).
+     * Higher values can increase reprojection performance, but decrease precision.
+     */
+    reprojectionErrorThreshold?: number | undefined;
+    /**
+     * Optional function to load a tile given a URL. The default is
+     * ```js
+     * function(imageTile, src) {
+     * imageTile.getImage().src = src;
+     * };
+     * ```
+     */
+    tileLoadFunction?: import("../Tile.js").LoadFunction | undefined;
+    /**
+     * Wrap the world horizontally.
+     */
+    wrapX?: boolean | undefined;
+    /**
+     * Duration of the opacity transition for rendering.
+     * To disable the opacity transition, pass `transition: 0`.
+     */
+    transition?: number | undefined;
+    /**
+     * Choose whether to use tiles with a higher or lower zoom level when between integer
+     * zoom levels. See {@link module :ol/tilegrid/TileGrid~TileGrid#getZForResolution}.
+     */
+    zDirection?: number | import("../array.js").NearestDirectionFunction | undefined;
+};
+export type SessionTokenRequest = {
+    /**
+     * The map type.
+     */
+    mapType: string;
+    /**
+     * The language.
+     */
+    language: string;
+    /**
+     * The region.
+     */
+    region: string;
+    /**
+     * The image format.
+     */
+    imageFormat?: string | undefined;
+    /**
+     * The scale.
+     */
+    scale?: string | undefined;
+    /**
+     * Use high resolution tiles.
+     */
+    highDpi?: boolean | undefined;
+    /**
+     * The layer types.
+     */
+    layerTypes?: string[] | undefined;
+    /**
+     * The overlay.
+     */
+    overlay?: boolean | undefined;
+    /**
+     * The styles.
+     */
+    styles?: any[] | undefined;
+};
+export type SessionTokenResponse = {
+    /**
+     * The session token.
+     */
+    session: string;
+    /**
+     * The session token expiry (seconds since the epoch as a string).
+     */
+    expiry: string;
+    /**
+     * The tile width.
+     */
+    tileWidth: number;
+    /**
+     * The tile height.
+     */
+    tileHeight: number;
+    /**
+     * The image format.
+     */
+    imageFormat: string;
+};
+/**
+ * @typedef {Object} Options
+ * @property {string} key Google Map Tiles API key. Get yours at https://developers.google.com/maps/documentation/tile/get-api-key.
+ * @property {string} [mapType='roadmap'] The type of [base map](https://developers.google.com/maps/documentation/tile/session_tokens#required_fields).
+ * @property {string} [language='en-US'] An [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) for information displayed on the tiles.
+ * @property {string} [region='US'] A [Common Locale Data Repository](https://cldr.unicode.org/) (CLDR) region identifier that represents the user location.
+ * @property {string} [imageFormat] The image format used for the map tiles (e.g. `'jpeg'`, or `'png'`).
+ * @property {string} [scale] Scale for map elements (`'scaleFactor1x'`, `'scaleFactor2x'`, or `'scaleFactor4x'`).
+ * @property {boolean} [highDpi=false] Use high-resolution tiles.
+ * @property {Array<string>} [layerTypes] The layer types added to the map (e.g. `'layerRoadmap'`, `'layerStreetview'`, or `'layerTraffic'`).
+ * @property {boolean} [overlay=false] Display only the `layerTypes` and not the underlying `mapType` (only works if `layerTypes` is provided).
+ * @property {Array<Object>} [styles] [Custom styles](https://developers.google.com/maps/documentation/tile/style-reference) applied to the map.
+ * @property {import("./Source.js").AttributionLike} [attributions] Attributions.
+ * @property {boolean} [interpolate=true] Use interpolated values when resampling.  By default,
+ * linear interpolation is used when resampling.  Set to false to use the nearest neighbor instead.
+ * @property {number} [cacheSize] Initial tile cache size. Will auto-grow to hold at least the number of tiles in the viewport.
+ * @property {number} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels).
+ * Higher values can increase reprojection performance, but decrease precision.
+ * @property {import("../Tile.js").LoadFunction} [tileLoadFunction] Optional function to load a tile given a URL. The default is
+ * ```js
+ * function(imageTile, src) {
+ *   imageTile.getImage().src = src;
+ * };
+ * ```
+ * @property {boolean} [wrapX=true] Wrap the world horizontally.
+ * @property {number} [transition] Duration of the opacity transition for rendering.
+ * To disable the opacity transition, pass `transition: 0`.
+ * @property {number|import("../array.js").NearestDirectionFunction} [zDirection=0]
+ * Choose whether to use tiles with a higher or lower zoom level when between integer
+ * zoom levels. See {@link module:ol/tilegrid/TileGrid~TileGrid#getZForResolution}.
+ */
+/**
+ * @typedef {Object} SessionTokenRequest
+ * @property {string} mapType The map type.
+ * @property {string} language The language.
+ * @property {string} region The region.
+ * @property {string} [imageFormat] The image format.
+ * @property {string} [scale] The scale.
+ * @property {boolean} [highDpi] Use high resolution tiles.
+ * @property {Array<string>} [layerTypes] The layer types.
+ * @property {boolean} [overlay] The overlay.
+ * @property {Array<Object>} [styles] The styles.
+ */
+/**
+ * @typedef {Object} SessionTokenResponse
+ * @property {string} session The session token.
+ * @property {string} expiry The session token expiry (seconds since the epoch as a string).
+ * @property {number} tileWidth The tile width.
+ * @property {number} tileHeight The tile height.
+ * @property {string} imageFormat The image format.
+ */
+/**
+ * @classdesc
+ * A tile layer source that renders tiles from the Google [Map Tiles API](https://developers.google.com/maps/documentation/tile/overview).
+ * The constructor takes options that are passed to the request to create a session token.  Refer to the
+ * [documentation](https://developers.google.com/maps/documentation/tile/session_tokens#required_fields)
+ * for additional details.
+ * @api
+ */
+declare class Google extends TileImage {
+    /**
+     * @param {Options} options Google Maps options.
+     */
+    constructor(options: Options);
+    /**
+     * @type {string}
+     * @private
+     */
+    private apiKey_;
+    /**
+     * @type {Error|null}
+     */
+    error_: Error | null;
+    /**
+     * @type {SessionTokenRequest}
+     * @private
+     */
+    private sessionTokenRequest_;
+    /**
+     * @type {ReturnType<typeof setTimeout>}
+     * @private
+     */
+    private sessionRefreshId_;
+    /**
+     * @return {Error|null} A source loading error. When the source state is `error`, use this function
+     * to get more information about the error. To debug a faulty configuration, you may want to use
+     * a listener like
+     * ```js
+     * source.on('change', () => {
+     *   if (source.getState() === 'error') {
+     *     console.error(source.getError());
+     *   }
+     * });
+     * ```
+     */
+    getError(): Error | null;
+    /**
+     * Exposed here so it can be overridden in the tests.
+     * @param {string} url The URL.
+     * @param {RequestInit} config The config.
+     * @return {Promise<Response>} A promise that resolves with the response.
+     */
+    fetchSessionToken(url: string, config: RequestInit): Promise<Response>;
+    /**
+     * Get or renew a session token for use with tile requests.
+     * @private
+     */
+    private createSession_;
+}
+import TileImage from './TileImage.js';
+//# sourceMappingURL=Google.d.ts.map

package/source/Google.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Google.d.ts","sourceRoot":"","sources":["Google.js"],"names":[],"mappings":";;;;;SAmBc,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aAgCN,MAAM;;;;cACN,MAAM;;;;YACN,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aAWN,MAAM;;;;YACN,MAAM;;;;eACN,MAAM;;;;gBACN,MAAM;;;;iBACN,MAAM;;AAnDpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AAEH;;;;;;;;;;;GAWG;AAEH;;;;;;;GAOG;AAEH;;;;;;;GAOG;AACH;IACE;;OAEG;IACH,qBAFW,OAAO,EA0EjB;IAnDC;;;OAGG;IACH,gBAA0B;IAE1B;;OAEG;IACH,QAFU,KAAK,GAAC,IAAI,CAEF;IA6BlB;;;OAGG;IACH,6BAA+C;IAE/C;;;OAGG;IACH,0BAAsB;IAKxB;;;;;;;;;;;OAWG;IACH,YAXY,KAAK,GAAC,IAAI,CAarB;IAED;;;;;OAKG;IACH,uBAJW,MAAM,UACN,WAAW,GACV,QAAQ,QAAQ,CAAC,CAI5B;IAED;;;OAGG;IACH,uBAuDC;CAMF;sBApPqB,gBAAgB"}

package/source/Google.js

@@ -0,0 +1,251 @@
+/**
+ * @module ol/source/Google
+ */
+
+import TileImage from './TileImage.js';
+import {createXYZ, extentFromProjection} from '../tilegrid.js';
+
+const defaultAttribution =
+  'Google Maps' +
+  '<a class="ol-attribution-google-tos" href="https://cloud.google.com/maps-platform/terms/" target="_blank">Terms of Use</a>' +
+  ' and ' +
+  '<a class="ol-attribution-google-tos" href="https://policies.google.com/privacy" target="_blank">Privacy Policy</a>';
+
+const createSessionUrl = 'https://tile.googleapis.com/v1/createSession';
+const tileUrl = 'https://tile.googleapis.com/v1/2dtiles';
+const maxZoom = 22;
+
+/**
+ * @typedef {Object} Options
+ * @property {string} key Google Map Tiles API key. Get yours at https://developers.google.com/maps/documentation/tile/get-api-key.
+ * @property {string} [mapType='roadmap'] The type of [base map](https://developers.google.com/maps/documentation/tile/session_tokens#required_fields).
+ * @property {string} [language='en-US'] An [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) for information displayed on the tiles.
+ * @property {string} [region='US'] A [Common Locale Data Repository](https://cldr.unicode.org/) (CLDR) region identifier that represents the user location.
+ * @property {string} [imageFormat] The image format used for the map tiles (e.g. `'jpeg'`, or `'png'`).
+ * @property {string} [scale] Scale for map elements (`'scaleFactor1x'`, `'scaleFactor2x'`, or `'scaleFactor4x'`).
+ * @property {boolean} [highDpi=false] Use high-resolution tiles.
+ * @property {Array<string>} [layerTypes] The layer types added to the map (e.g. `'layerRoadmap'`, `'layerStreetview'`, or `'layerTraffic'`).
+ * @property {boolean} [overlay=false] Display only the `layerTypes` and not the underlying `mapType` (only works if `layerTypes` is provided).
+ * @property {Array<Object>} [styles] [Custom styles](https://developers.google.com/maps/documentation/tile/style-reference) applied to the map.
+ * @property {import("./Source.js").AttributionLike} [attributions] Attributions.
+ * @property {boolean} [interpolate=true] Use interpolated values when resampling.  By default,
+ * linear interpolation is used when resampling.  Set to false to use the nearest neighbor instead.
+ * @property {number} [cacheSize] Initial tile cache size. Will auto-grow to hold at least the number of tiles in the viewport.
+ * @property {number} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels).
+ * Higher values can increase reprojection performance, but decrease precision.
+ * @property {import("../Tile.js").LoadFunction} [tileLoadFunction] Optional function to load a tile given a URL. The default is
+ * ```js
+ * function(imageTile, src) {
+ *   imageTile.getImage().src = src;
+ * };
+ * ```
+ * @property {boolean} [wrapX=true] Wrap the world horizontally.
+ * @property {number} [transition] Duration of the opacity transition for rendering.
+ * To disable the opacity transition, pass `transition: 0`.
+ * @property {number|import("../array.js").NearestDirectionFunction} [zDirection=0]
+ * Choose whether to use tiles with a higher or lower zoom level when between integer
+ * zoom levels. See {@link module:ol/tilegrid/TileGrid~TileGrid#getZForResolution}.
+ */
+
+/**
+ * @typedef {Object} SessionTokenRequest
+ * @property {string} mapType The map type.
+ * @property {string} language The language.
+ * @property {string} region The region.
+ * @property {string} [imageFormat] The image format.
+ * @property {string} [scale] The scale.
+ * @property {boolean} [highDpi] Use high resolution tiles.
+ * @property {Array<string>} [layerTypes] The layer types.
+ * @property {boolean} [overlay] The overlay.
+ * @property {Array<Object>} [styles] The styles.
+ */
+
+/**
+ * @typedef {Object} SessionTokenResponse
+ * @property {string} session The session token.
+ * @property {string} expiry The session token expiry (seconds since the epoch as a string).
+ * @property {number} tileWidth The tile width.
+ * @property {number} tileHeight The tile height.
+ * @property {string} imageFormat The image format.
+ */
+
+/**
+ * @classdesc
+ * A tile layer source that renders tiles from the Google [Map Tiles API](https://developers.google.com/maps/documentation/tile/overview).
+ * The constructor takes options that are passed to the request to create a session token.  Refer to the
+ * [documentation](https://developers.google.com/maps/documentation/tile/session_tokens#required_fields)
+ * for additional details.
+ * @api
+ */
+class Google extends TileImage {
+  /**
+   * @param {Options} options Google Maps options.
+   */
+  constructor(options) {
+    const highDpi = !!options.highDpi;
+    const opaque = !(options.overlay === true);
+    const attributions = options.attributions || [defaultAttribution];
+
+    super({
+      attributions: attributions,
+      cacheSize: options.cacheSize,
+      crossOrigin: 'anonymous',
+      interpolate: options.interpolate,
+      opaque: opaque,
+      projection: 'EPSG:3857',
+      reprojectionErrorThreshold: options.reprojectionErrorThreshold,
+      state: 'loading',
+      tileLoadFunction: options.tileLoadFunction,
+      tilePixelRatio: highDpi ? 2 : 1,
+      wrapX: options.wrapX !== undefined ? options.wrapX : true,
+      transition: options.transition,
+      zDirection: options.zDirection,
+    });
+
+    /**
+     * @type {string}
+     * @private
+     */
+    this.apiKey_ = options.key;
+
+    /**
+     * @type {Error|null}
+     */
+    this.error_ = null;
+
+    /**
+     * @type {SessionTokenRequest}
+     */
+    const sessionTokenRequest = {
+      mapType: options.mapType || 'roadmap',
+      language: options.language || 'en-US',
+      region: options.region || 'US',
+    };
+    if (options.imageFormat) {
+      sessionTokenRequest.imageFormat = options.imageFormat;
+    }
+    if (options.scale) {
+      sessionTokenRequest.scale = options.scale;
+    }
+    if (highDpi) {
+      sessionTokenRequest.highDpi = true;
+    }
+    if (options.layerTypes) {
+      sessionTokenRequest.layerTypes = options.layerTypes;
+    }
+    if (options.styles) {
+      sessionTokenRequest.styles = options.styles;
+    }
+    if (options.overlay === true) {
+      sessionTokenRequest.overlay = true;
+    }
+
+    /**
+     * @type {SessionTokenRequest}
+     * @private
+     */
+    this.sessionTokenRequest_ = sessionTokenRequest;
+
+    /**
+     * @type {ReturnType<typeof setTimeout>}
+     * @private
+     */
+    this.sessionRefreshId_;
+
+    this.createSession_();
+  }
+
+  /**
+   * @return {Error|null} A source loading error. When the source state is `error`, use this function
+   * to get more information about the error. To debug a faulty configuration, you may want to use
+   * a listener like
+   * ```js
+   * source.on('change', () => {
+   *   if (source.getState() === 'error') {
+   *     console.error(source.getError());
+   *   }
+   * });
+   * ```
+   */
+  getError() {
+    return this.error_;
+  }
+
+  /**
+   * Exposed here so it can be overridden in the tests.
+   * @param {string} url The URL.
+   * @param {RequestInit} config The config.
+   * @return {Promise<Response>} A promise that resolves with the response.
+   */
+  fetchSessionToken(url, config) {
+    return fetch(url, config);
+  }
+
+  /**
+   * Get or renew a session token for use with tile requests.
+   * @private
+   */
+  async createSession_() {
+    const url = createSessionUrl + '?key=' + this.apiKey_;
+    const config = {
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/json',
+      },
+      body: JSON.stringify(this.sessionTokenRequest_),
+    };
+
+    const response = await this.fetchSessionToken(url, config);
+    if (!response.ok) {
+      try {
+        const body = await response.json();
+        this.error_ = new Error(body.error.message);
+      } catch {
+        this.error_ = new Error('Error fetching session token');
+      }
+      this.setState('error');
+      return;
+    }
+
+    /**
+     * @type {SessionTokenResponse}
+     */
+    const sessionTokenResponse = await response.json();
+
+    const tilePixelRatio = this.getTilePixelRatio(1);
+    const tileSize = [
+      sessionTokenResponse.tileWidth / tilePixelRatio,
+      sessionTokenResponse.tileHeight / tilePixelRatio,
+    ];
+
+    this.tileGrid = createXYZ({
+      extent: extentFromProjection(this.getProjection()),
+      maxZoom: maxZoom,
+      tileSize: tileSize,
+    });
+
+    const session = sessionTokenResponse.session;
+    const key = this.apiKey_;
+    this.tileUrlFunction = function (tileCoord, pixelRatio, projection) {
+      const z = tileCoord[0];
+      const x = tileCoord[1];
+      const y = tileCoord[2];
+      const url = `${tileUrl}/${z}/${x}/${y}?session=${session}&key=${key}`;
+      return url;
+    };
+
+    const expiry = parseInt(sessionTokenResponse.expiry, 10) * 1000;
+    const timeout = Math.max(expiry - Date.now() - 60 * 1000, 1);
+    this.sessionRefreshId_ = setTimeout(() => this.createSession_(), timeout);
+
+    // even if the state is already ready, we want the change event
+    this.setState('ready');
+  }
+
+  disposeInternal() {
+    clearTimeout(this.sessionRefreshId_);
+    super.disposeInternal();
+  }
+}
+
+export default Google;

package/util.js

@@ -33,4 +33,4 @@ export function getUid(obj) {
  * OpenLayers version.
  * @type {string}
  */
-export const VERSION = '9.0.0-dev.1708359055761';
+export const VERSION = '9.0.0-dev.1708371033297';