ol 7.5.0 → 7.5.1-dev.1691774516632

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ol",
-  "version": "7.5.0",
+  "version": "7.5.1-dev.1691774516632",
   "description": "OpenLayers mapping library",
   "keywords": [
     "map",

package/source/{Stamen.d.ts → StadiaMaps.d.ts}

@@ -1,4 +1,4 @@
-export default Stamen;
+export default StadiaMaps;
 export type Options = {
     /**
      * Initial tile cache size. Will auto-grow to hold at least the number of tiles in the viewport.
@@ -10,7 +10,7 @@ export type Options = {
      */
     interpolate?: boolean | undefined;
     /**
-     * Layer name.
+     * Layer name. Valid values: `alidade_smooth`, `alidade_smooth_dark`, `stadia_outdoors`, `stamen_terrain`, `stamen_terrain_background`, `stamen_terrain_labels`, `stamen_terrain_lines`, `stamen_toner_background`, `stamen_toner`, `stamen_toner_labels`, `stamen_toner_lines`, `stamen_toner_lite`, `stamen_watercolor`, and `osm_bright`.
      */
     layer: string;
     /**
@@ -53,13 +53,21 @@ export type Options = {
      * zoom levels. See {@link module :ol/tilegrid/TileGrid~TileGrid#getZForResolution}.
      */
     zDirection?: number | import("../array.js").NearestDirectionFunction | undefined;
+    /**
+     * Stadia Maps API key. Not required for localhost or most public web deployments. See https://docs.stadiamaps.com/authentication/ for details.
+     */
+    apiKey: string;
+    /**
+     * Use retina tiles (if available; not available for Stamen Watercolor).
+     */
+    retina: boolean;
 };
 /**
  * @typedef {Object} Options
  * @property {number} [cacheSize] Initial tile cache size. Will auto-grow to hold at least the number of tiles in the viewport.
  * @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 {string} layer Layer name.
+ * @property {string} layer Layer name. Valid values: `alidade_smooth`, `alidade_smooth_dark`, `stadia_outdoors`, `stamen_terrain`, `stamen_terrain_background`, `stamen_terrain_labels`, `stamen_terrain_lines`, `stamen_toner_background`, `stamen_toner`, `stamen_toner_labels`, `stamen_toner_lines`, `stamen_toner_lite`, `stamen_watercolor`, and `osm_bright`.
  * @property {number} [minZoom] Minimum zoom.
  * @property {number} [maxZoom] Maximum zoom.
  * @property {number} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels).
@@ -78,17 +86,19 @@ export type Options = {
  * @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}.
+ * @property {string} apiKey Stadia Maps API key. Not required for localhost or most public web deployments. See https://docs.stadiamaps.com/authentication/ for details.
+ * @property {boolean} retina Use retina tiles (if available; not available for Stamen Watercolor).
  */
 /**
  * @classdesc
- * Layer source for the Stamen tile server.
+ * Layer source for the Stadia Maps tile server.
  * @api
  */
-declare class Stamen extends XYZ {
+declare class StadiaMaps extends XYZ {
     /**
-     * @param {Options} options Stamen options.
+     * @param {Options} options StadiaMaps options.
      */
     constructor(options: Options);
 }
 import XYZ from './XYZ.js';
-//# sourceMappingURL=Stamen.d.ts.map
+//# sourceMappingURL=StadiaMaps.d.ts.map

package/source/StadiaMaps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StadiaMaps.d.ts","sourceRoot":"","sources":["StadiaMaps.js"],"names":[],"mappings":";;;;;;;;;;;;;;WAoHc,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAmBN,MAAM;;;;YACN,OAAO;;AAzBrB;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH;;;;GAIG;AACH;IACE;;OAEG;IACH,qBAFW,OAAO,EAsDjB;CACF;gBArMe,UAAU"}

package/source/{Stamen.js → StadiaMaps.js}

@@ -1,5 +1,5 @@
 /**
- * @module ol/source/Stamen
+ * @module ol/source/StadiaMaps
  */
 
 import XYZ from './XYZ.js';
@@ -7,80 +7,105 @@ import {ATTRIBUTION as OSM_ATTRIBUTION} from './OSM.js';
 
 /**
  * @const
- * @type {Array<string>}
+ * @type string
  */
-const ATTRIBUTIONS = [
-  'Map tiles by <a href="https://stamen.com/" target="_blank">Stamen Design</a>, ' +
-    'under <a href="https://creativecommons.org/licenses/by/3.0/" target="_blank">CC BY' +
-    ' 3.0</a>.',
-  OSM_ATTRIBUTION,
-];
+const STADIA_ATTRIBUTION =
+  '&copy; <a href="https://www.stadiamaps.com/" target="_blank">Stadia Maps</a>';
+
+/**
+ * @const
+ * @type string
+ */
+const OMT_ATTRIBUTION =
+  '&copy; <a href="https://openmaptiles.org/" target="_blank">OpenMapTiles</a>';
+
+/**
+ * @const
+ * @type string
+ */
+const STAMEN_ATTRIBUTION =
+  '&copy; <a href="https://stamen.com/" target="_blank">Stamen Design</a>';
 
 /**
  * @type {Object<string, {extension: string, opaque: boolean}>}
  */
 const LayerConfig = {
-  'terrain': {
+  'stamen_terrain': {
     extension: 'png',
     opaque: true,
   },
-  'terrain-background': {
+  'stamen_terrain_background': {
     extension: 'png',
     opaque: true,
   },
-  'terrain-labels': {
+  'stamen_terrain_labels': {
     extension: 'png',
     opaque: false,
   },
-  'terrain-lines': {
+  'stamen_terrain_lines': {
     extension: 'png',
     opaque: false,
   },
-  'toner-background': {
+  'stamen_toner_background': {
     extension: 'png',
     opaque: true,
   },
-  'toner': {
+  'stamen_toner': {
     extension: 'png',
     opaque: true,
   },
-  'toner-hybrid': {
+  'stamen_toner_labels': {
     extension: 'png',
     opaque: false,
   },
-  'toner-labels': {
+  'stamen_toner_lines': {
     extension: 'png',
     opaque: false,
   },
-  'toner-lines': {
+  'stamen_toner_lite': {
     extension: 'png',
-    opaque: false,
+    opaque: true,
+  },
+  'stamen_watercolor': {
+    extension: 'jpg',
+    opaque: true,
   },
-  'toner-lite': {
+  'alidade_smooth': {
     extension: 'png',
     opaque: true,
   },
-  'watercolor': {
-    extension: 'jpg',
+  'alidade_smooth_dark': {
+    extension: 'png',
+    opaque: true,
+  },
+  'stadia_outdoors': {
+    extension: 'png',
+    opaque: true,
+  },
+  'osm_bright': {
+    extension: 'png',
     opaque: true,
   },
 };
 
 /**
- * @type {Object<string, {minZoom: number, maxZoom: number}>}
+ * @type {Object<string, {minZoom: number, maxZoom: number, retina: boolean}>}
  */
 const ProviderConfig = {
-  'terrain': {
+  'stamen_terrain': {
     minZoom: 0,
     maxZoom: 18,
+    retina: true,
   },
-  'toner': {
+  'stamen_toner': {
     minZoom: 0,
     maxZoom: 20,
+    retina: true,
   },
-  'watercolor': {
-    minZoom: 0,
+  'stamen_watercolor': {
+    minZoom: 1,
     maxZoom: 18,
+    retina: false,
   },
 };
 
@@ -89,7 +114,7 @@ const ProviderConfig = {
  * @property {number} [cacheSize] Initial tile cache size. Will auto-grow to hold at least the number of tiles in the viewport.
  * @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 {string} layer Layer name.
+ * @property {string} layer Layer name. Valid values: `alidade_smooth`, `alidade_smooth_dark`, `stadia_outdoors`, `stamen_terrain`, `stamen_terrain_background`, `stamen_terrain_labels`, `stamen_terrain_lines`, `stamen_toner_background`, `stamen_toner`, `stamen_toner_labels`, `stamen_toner_lines`, `stamen_toner_lite`, `stamen_watercolor`, and `osm_bright`.
  * @property {number} [minZoom] Minimum zoom.
  * @property {number} [maxZoom] Maximum zoom.
  * @property {number} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels).
@@ -108,50 +133,72 @@ const ProviderConfig = {
  * @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}.
+ * @property {string} apiKey Stadia Maps API key. Not required for localhost or most public web deployments. See https://docs.stadiamaps.com/authentication/ for details.
+ * @property {boolean} retina Use retina tiles (if available; not available for Stamen Watercolor).
  */
 
 /**
  * @classdesc
- * Layer source for the Stamen tile server.
+ * Layer source for the Stadia Maps tile server.
  * @api
  */
-class Stamen extends XYZ {
+class StadiaMaps extends XYZ {
   /**
-   * @param {Options} options Stamen options.
+   * @param {Options} options StadiaMaps options.
    */
   constructor(options) {
     const i = options.layer.indexOf('-');
     const provider = i == -1 ? options.layer : options.layer.slice(0, i);
-    const providerConfig = ProviderConfig[provider];
+    const providerConfig = ProviderConfig[provider] || {
+      'minZoom': 0,
+      'maxZoom': 20,
+      'retina': true,
+    };
 
     const layerConfig = LayerConfig[options.layer];
+    const query = options.apiKey ? '?api_key=' + options.apiKey : '';
+    const retina = providerConfig.retina && options.retina ? '@2x' : '';
 
     const url =
       options.url !== undefined
         ? options.url
-        : 'https://stamen-tiles-{a-d}.a.ssl.fastly.net/' +
+        : 'https://tiles.stadiamaps.com/tiles/' +
           options.layer +
-          '/{z}/{x}/{y}.' +
-          layerConfig.extension;
+          '/{z}/{x}/{y}' +
+          retina +
+          '.' +
+          layerConfig.extension +
+          query;
+
+    const attributions = [STADIA_ATTRIBUTION, OMT_ATTRIBUTION, OSM_ATTRIBUTION];
+
+    if (options.layer.startsWith('stamen_')) {
+      attributions.splice(1, 0, STAMEN_ATTRIBUTION);
+    }
 
     super({
-      attributions: ATTRIBUTIONS,
+      attributions: attributions,
       cacheSize: options.cacheSize,
       crossOrigin: 'anonymous',
       interpolate: options.interpolate,
       maxZoom:
-        options.maxZoom != undefined ? options.maxZoom : providerConfig.maxZoom,
+        options.maxZoom !== undefined
+          ? options.maxZoom
+          : providerConfig.maxZoom,
       minZoom:
-        options.minZoom != undefined ? options.minZoom : providerConfig.minZoom,
+        options.minZoom !== undefined
+          ? options.minZoom
+          : providerConfig.minZoom,
       opaque: layerConfig.opaque,
       reprojectionErrorThreshold: options.reprojectionErrorThreshold,
       tileLoadFunction: options.tileLoadFunction,
       transition: options.transition,
       url: url,
+      tilePixelRatio: retina ? 2 : 1,
       wrapX: options.wrapX,
       zDirection: options.zDirection,
     });
   }
 }
 
-export default Stamen;
+export default StadiaMaps;

package/source.d.ts

@@ -28,7 +28,7 @@ export { default as OGCVectorTile } from "./source/OGCVectorTile.js";
 export { default as OSM } from "./source/OSM.js";
 export { default as Raster } from "./source/Raster.js";
 export { default as Source } from "./source/Source.js";
-export { default as Stamen } from "./source/Stamen.js";
+export { default as StadiaMaps } from "./source/StadiaMaps.js";
 export { default as Tile } from "./source/Tile.js";
 export { default as TileArcGISRest } from "./source/TileArcGISRest.js";
 export { default as TileDebug } from "./source/TileDebug.js";

package/source.js

@@ -22,7 +22,7 @@ export {default as OGCVectorTile} from './source/OGCVectorTile.js';
 export {default as OSM} from './source/OSM.js';
 export {default as Raster} from './source/Raster.js';
 export {default as Source} from './source/Source.js';
-export {default as Stamen} from './source/Stamen.js';
+export {default as StadiaMaps} from './source/StadiaMaps.js';
 export {default as Tile} from './source/Tile.js';
 export {default as TileArcGISRest} from './source/TileArcGISRest.js';
 export {default as TileDebug} from './source/TileDebug.js';

package/util.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["util.js"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,4BAFY,KAAK,CAIhB;AASD;;;;;;;;GAQG;AACH,kCAHY,MAAM,CAKjB;AAED;;;GAGG;AACH,sBAFU,MAAM,CAEe"}
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["util.js"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,4BAFY,KAAK,CAIhB;AASD;;;;;;;;GAQG;AACH,kCAHY,MAAM,CAKjB;AAED;;;GAGG;AACH,sBAFU,MAAM,CAEiC"}

package/util.js

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

package/source/Stamen.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Stamen.d.ts","sourceRoot":"","sources":["Stamen.js"],"names":[],"mappings":";;;;;;;;;;;;;;WA2Fc,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AALpB;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH;;;;GAIG;AACH;IACE;;OAEG;IACH,qBAFW,OAAO,EAkCjB;CACF;gBAtJe,UAAU"}