ol 9.2.5-dev.1718652616882 → 9.2.5-dev.1718925536936

package/tileurlfunction.d.ts

@@ -1,9 +1,9 @@
 /**
  * @param {string} template Template.
- * @param {import("./tilegrid/TileGrid.js").default} tileGrid Tile grid.
+ * @param {import("./tilegrid/TileGrid.js").default|null} tileGrid Tile grid.
  * @return {import("./Tile.js").UrlFunction} Tile URL function.
  */
-export function createFromTemplate(template: string, tileGrid: import("./tilegrid/TileGrid.js").default): import("./Tile.js").UrlFunction;
+export function createFromTemplate(template: string, tileGrid: import("./tilegrid/TileGrid.js").default | null): import("./Tile.js").UrlFunction;
 /**
  * @param {Array<string>} templates Templates.
  * @param {import("./tilegrid/TileGrid.js").default} tileGrid Tile grid.
@@ -22,9 +22,5 @@ export function createFromTileUrlFunctions(tileUrlFunctions: Array<import("./Til
  * @return {string|undefined} Tile URL.
  */
 export function nullTileUrlFunction(tileCoord: import("./tilecoord.js").TileCoord, pixelRatio: number, projection: import("./proj/Projection.js").default): string | undefined;
-/**
- * @param {string} url URL.
- * @return {Array<string>} Array of urls.
- */
-export function expandUrl(url: string): Array<string>;
+export { expandUrl } from "./uri.js";
 //# sourceMappingURL=tileurlfunction.d.ts.map

package/tileurlfunction.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tileurlfunction.d.ts","sourceRoot":"","sources":["tileurlfunction.js"],"names":[],"mappings":"AAMA;;;;GAIG;AACH,6CAJW,MAAM,YACN,OAAO,wBAAwB,EAAE,OAAO,GACvC,OAAO,WAAW,EAAE,WAAW,CAmC1C;AAED;;;;GAIG;AACH,+CAJW,MAAM,MAAM,CAAC,YACb,OAAO,wBAAwB,EAAE,OAAO,GACvC,OAAO,WAAW,EAAE,WAAW,CAS1C;AAED;;;GAGG;AACH,6DAHW,MAAM,OAAO,WAAW,EAAE,WAAW,CAAC,GACrC,OAAO,WAAW,EAAE,WAAW,CAsB1C;AAED;;;;;GAKG;AACH,+CALW,OAAO,gBAAgB,EAAE,SAAS,cAClC,MAAM,cACN,OAAO,sBAAsB,EAAE,OAAO,GACrC,MAAM,GAAC,SAAS,CAI3B;AAED;;;GAGG;AACH,+BAHW,MAAM,GACL,MAAM,MAAM,CAAC,CA0BxB"}
+{"version":3,"file":"tileurlfunction.d.ts","sourceRoot":"","sources":["tileurlfunction.js"],"names":[],"mappings":"AAOA;;;;GAIG;AACH,6CAJW,MAAM,YACN,OAAO,wBAAwB,EAAE,OAAO,GAAC,IAAI,GAC5C,OAAO,WAAW,EAAE,WAAW,CA0B1C;AAED;;;;GAIG;AACH,+CAJW,MAAM,MAAM,CAAC,YACb,OAAO,wBAAwB,EAAE,OAAO,GACvC,OAAO,WAAW,EAAE,WAAW,CAS1C;AAED;;;GAGG;AACH,6DAHW,MAAM,OAAO,WAAW,EAAE,WAAW,CAAC,GACrC,OAAO,WAAW,EAAE,WAAW,CAsB1C;AAED;;;;;GAKG;AACH,+CALW,OAAO,gBAAgB,EAAE,SAAS,cAClC,MAAM,cACN,OAAO,sBAAsB,EAAE,OAAO,GACrC,MAAM,GAAC,SAAS,CAI3B"}

package/tileurlfunction.js

@@ -2,18 +2,15 @@
  * @module ol/tileurlfunction
  */
 import {modulo} from './math.js';
+import {renderXYZTemplate} from './uri.js';
 import {hash as tileCoordHash} from './tilecoord.js';
 
 /**
  * @param {string} template Template.
- * @param {import("./tilegrid/TileGrid.js").default} tileGrid Tile grid.
+ * @param {import("./tilegrid/TileGrid.js").default|null} tileGrid Tile grid.
  * @return {import("./Tile.js").UrlFunction} Tile URL function.
  */
 export function createFromTemplate(template, tileGrid) {
-  const zRegEx = /\{z\}/g;
-  const xRegEx = /\{x\}/g;
-  const yRegEx = /\{y\}/g;
-  const dashYRegEx = /\{-y\}/g;
   return (
     /**
      * @param {import("./tilecoord.js").TileCoord} tileCoord Tile Coordinate.
@@ -25,21 +22,16 @@ export function createFromTemplate(template, tileGrid) {
       if (!tileCoord) {
         return undefined;
       }
-      return template
-        .replace(zRegEx, tileCoord[0].toString())
-        .replace(xRegEx, tileCoord[1].toString())
-        .replace(yRegEx, tileCoord[2].toString())
-        .replace(dashYRegEx, function () {
-          const z = tileCoord[0];
-          const range = tileGrid.getFullTileRange(z);
-          if (!range) {
-            throw new Error(
-              'The {-y} placeholder requires a tile grid with extent',
-            );
-          }
-          const y = range.getHeight() - tileCoord[2] - 1;
-          return y.toString();
-        });
+      let maxY;
+      const z = tileCoord[0];
+      if (tileGrid) {
+        // The `{-y}` placeholder only works for sources that have a tile grid at construction
+        const range = tileGrid.getFullTileRange(z);
+        if (range) {
+          maxY = range.getHeight() - 1;
+        }
+      }
+      return renderXYZTemplate(template, z, tileCoord[1], tileCoord[2], maxY);
     }
   );
 }
@@ -95,31 +87,6 @@ export function nullTileUrlFunction(tileCoord, pixelRatio, projection) {
 }
 
 /**
- * @param {string} url URL.
- * @return {Array<string>} Array of urls.
+ * TODO: Update ol-mapbox-style to import this from the uri.js module.
  */
-export function expandUrl(url) {
-  const urls = [];
-  let match = /\{([a-z])-([a-z])\}/.exec(url);
-  if (match) {
-    // char range
-    const startCharCode = match[1].charCodeAt(0);
-    const stopCharCode = match[2].charCodeAt(0);
-    let charCode;
-    for (charCode = startCharCode; charCode <= stopCharCode; ++charCode) {
-      urls.push(url.replace(match[0], String.fromCharCode(charCode)));
-    }
-    return urls;
-  }
-  match = /\{(\d+)-(\d+)\}/.exec(url);
-  if (match) {
-    // number range
-    const stop = parseInt(match[2], 10);
-    for (let i = parseInt(match[1], 10); i <= stop; i++) {
-      urls.push(url.replace(match[0], i.toString()));
-    }
-    return urls;
-  }
-  urls.push(url);
-  return urls;
-}
+export {expandUrl} from './uri.js';

package/uri.d.ts

@@ -1,6 +1,3 @@
-/**
- * @module ol/uri
- */
 /**
  * Appends query parameters to a URI.
  *
@@ -10,4 +7,27 @@
  * @return {string} The new URI.
  */
 export function appendParams(uri: string, params: any): string;
+/**
+ * @param {string} template The URL template.  Should have `{x}`, `{y}`, and `{z}` placeholders.  If
+ * the template has a `{-y}` placeholder, the `maxY` parameter must be supplied.
+ * @param {number} z The tile z coordinate.
+ * @param {number} x The tile x coordinate.
+ * @param {number} y The tile y coordinate.
+ * @param {number} [maxY] The maximum y coordinate at the given z level.
+ * @return {string} The URL.
+ */
+export function renderXYZTemplate(template: string, z: number, x: number, y: number, maxY?: number | undefined): string;
+/**
+ * @param {Array<string>} urls List of URLs.
+ * @param {number} z The tile z coordinate.
+ * @param {number} x The tile x coordinate.
+ * @param {number} y The tile y coordinate.
+ * @return {string} The chosen URL.
+ */
+export function pickUrl(urls: Array<string>, z: number, x: number, y: number): string;
+/**
+ * @param {string} url URL.
+ * @return {Array<string>} Array of urls.
+ */
+export function expandUrl(url: string): Array<string>;
 //# sourceMappingURL=uri.d.ts.map

package/uri.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"uri.d.ts","sourceRoot":"","sources":["uri.js"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;;;GAOG;AACH,kCALW,MAAM,gBAGL,MAAM,CAiBjB"}
+{"version":3,"file":"uri.d.ts","sourceRoot":"","sources":["uri.js"],"names":[],"mappings":"AAOA;;;;;;;GAOG;AACH,kCALW,MAAM,gBAGL,MAAM,CAiBjB;AAOD;;;;;;;;GAQG;AACH,4CARW,MAAM,KAEN,MAAM,KACN,MAAM,KACN,MAAM,8BAEL,MAAM,CAejB;AAED;;;;;;GAMG;AACH,8BANW,MAAM,MAAM,CAAC,KACb,MAAM,KACN,MAAM,KACN,MAAM,GACL,MAAM,CAMjB;AAED;;;GAGG;AACH,+BAHW,MAAM,GACL,MAAM,MAAM,CAAC,CA0BxB"}

package/uri.js

@@ -2,6 +2,9 @@
  * @module ol/uri
  */
 
+import {hashZXY} from './tilecoord.js';
+import {modulo} from './math.js';
+
 /**
  * Appends query parameters to a URI.
  *
@@ -26,3 +29,75 @@ export function appendParams(uri, params) {
   uri += uri.includes('?') ? '&' : '?';
   return uri + qs;
 }
+
+const zRegEx = /\{z\}/g;
+const xRegEx = /\{x\}/g;
+const yRegEx = /\{y\}/g;
+const dashYRegEx = /\{-y\}/g;
+
+/**
+ * @param {string} template The URL template.  Should have `{x}`, `{y}`, and `{z}` placeholders.  If
+ * the template has a `{-y}` placeholder, the `maxY` parameter must be supplied.
+ * @param {number} z The tile z coordinate.
+ * @param {number} x The tile x coordinate.
+ * @param {number} y The tile y coordinate.
+ * @param {number} [maxY] The maximum y coordinate at the given z level.
+ * @return {string} The URL.
+ */
+export function renderXYZTemplate(template, z, x, y, maxY) {
+  return template
+    .replace(zRegEx, z.toString())
+    .replace(xRegEx, x.toString())
+    .replace(yRegEx, y.toString())
+    .replace(dashYRegEx, function () {
+      if (maxY === undefined) {
+        throw new Error(
+          'If the URL template has a {-y} placeholder, the grid extent must be known',
+        );
+      }
+      return (maxY - y).toString();
+    });
+}
+
+/**
+ * @param {Array<string>} urls List of URLs.
+ * @param {number} z The tile z coordinate.
+ * @param {number} x The tile x coordinate.
+ * @param {number} y The tile y coordinate.
+ * @return {string} The chosen URL.
+ */
+export function pickUrl(urls, z, x, y) {
+  const hash = hashZXY(z, x, y);
+  const index = modulo(hash, urls.length);
+  return urls[index];
+}
+
+/**
+ * @param {string} url URL.
+ * @return {Array<string>} Array of urls.
+ */
+export function expandUrl(url) {
+  const urls = [];
+  let match = /\{([a-z])-([a-z])\}/.exec(url);
+  if (match) {
+    // char range
+    const startCharCode = match[1].charCodeAt(0);
+    const stopCharCode = match[2].charCodeAt(0);
+    let charCode;
+    for (charCode = startCharCode; charCode <= stopCharCode; ++charCode) {
+      urls.push(url.replace(match[0], String.fromCharCode(charCode)));
+    }
+    return urls;
+  }
+  match = /\{(\d+)-(\d+)\}/.exec(url);
+  if (match) {
+    // number range
+    const stop = parseInt(match[2], 10);
+    for (let i = parseInt(match[1], 10); i <= stop; i++) {
+      urls.push(url.replace(match[0], i.toString()));
+    }
+    return urls;
+  }
+  urls.push(url);
+  return urls;
+}

package/util.js

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