isard 0.7.0 → 0.8.0

package/dist/terrain.d.ts

@@ -1,8 +1,3 @@
-/**
- * Altitudes encoded in the colors of PNG tiles, for the relief: Terrarium (Mapzen, the Terrain Tiles of AWS) and
- * Terrain-RGB (Mapbox, MapTiler). The engine reads raw floats only; a loader gives it the altitudes of each tile,
- * decoded in a worker of the map's pool (OffscreenCanvas), or in the page when the map has no workers.
- */
 /** The encodings of altitudes in the colors of PNG tiles */
 export type PngEncoding = 'terrarium' | 'mapbox';
 /** Altitudes (metres, rows from the north) of RGBA pixels in an encoding; below `floor` raised to it */

package/dist/terrain.js

@@ -3,6 +3,7 @@
  * Terrain-RGB (Mapbox, MapTiler). The engine reads raw floats only; a loader gives it the altitudes of each tile,
  * decoded in a worker of the map's pool (OffscreenCanvas), or in the page when the map has no workers.
  */
+import { withHeaders } from "./requests.js";
 const SIZE = 256;
 /** Altitudes (metres, rows from the north) of RGBA pixels in an encoding; below `floor` raised to it */
 export function decodeHeights(rgba, encoding, floor = Number.NEGATIVE_INFINITY) {
@@ -28,7 +29,7 @@ export function decodeHeights(rgba, encoding, floor = Number.NEGATIVE_INFINITY)
  * rejects (the engine retries). Where it runs: in a worker of the map, or in the page without workers
  */
 export async function fetchHeights(url, encoding, floor, signal, surface) {
-    const response = await fetch(url, { signal });
+    const response = await fetch(url, withHeaders(url, { signal }));
     if (response.status === 404 || response.status === 204 || response.status === 410)
         return null;
     if (!response.ok)

package/dist/terrain.js.map

@@ -1 +1 @@
-{"version":3,"file":"terrain.js","sourceRoot":"","sources":["../src/terrain.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH,MAAM,IAAI,GAAG,GAAG,CAAC;AAEjB,wGAAwG;AACxG,MAAM,UAAU,aAAa,CAC3B,IAAoC,EACpC,QAAqB,EACrB,KAAK,GAAG,MAAM,CAAC,iBAAiB;IAEhC,MAAM,CAAC,GAAG,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC;IAC3B,MAAM,GAAG,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,CAAC;IAChC,iEAAiE;IACjE,IAAI,QAAQ,KAAK,WAAW,EAAE,CAAC;QAC7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7C,MAAM,CAAC,GAAI,IAAI,CAAC,CAAC,CAAY,GAAG,GAAG,GAAI,IAAI,CAAC,CAAC,GAAG,CAAC,CAAY,GAAI,IAAI,CAAC,CAAC,GAAG,CAAC,CAAY,GAAG,GAAG,GAAG,KAAK,CAAC;YACtG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QACjC,CAAC;IACH,CAAC;SAAM,CAAC;QACN,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7C,MAAM,CAAC,GAAG,CAAC,KAAK,GAAG,CAAE,IAAI,CAAC,CAAC,CAAY,GAAG,KAAK,GAAI,IAAI,CAAC,CAAC,GAAG,CAAC,CAAY,GAAG,GAAG,GAAI,IAAI,CAAC,CAAC,GAAG,CAAC,CAAY,CAAC,GAAG,GAAG,CAAC;YACjH,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QACjC,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAOD;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,GAAW,EACX,QAAqB,EACrB,KAAyB,EACzB,MAAmB,EACnB,OAAgB;IAEhB,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAC9C,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG;QAAE,OAAO,IAAI,CAAC;IAC/F,IAAI,CAAC,QAAQ,CAAC,EAAE;QAAE,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,CAAC,GAAG,KAAK,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IACzE,oEAAoE;IACpE,MAAM,MAAM,GAAG,MAAM,iBAAiB,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,EAAE;QAC5D,gBAAgB,EAAE,MAAM;QACxB,oBAAoB,EAAE,MAAM;KAC7B,CAAC,CAAC;IACH,IAAI,CAAC;QACH,OAAO,CAAC,MAAM,KAAK,IAAI,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACnD,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,kBAAkB,EAAE,IAAI,EAAE,CAAC,CAAC;QACxE,IAAI,CAAC,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;QACzC,uFAAuF;QACvF,CAAC,CAAC,qBAAqB,GAAG,KAAK,CAAC;QAChC,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QAC9B,CAAC,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QACtC,OAAO,aAAa,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;IAC/E,CAAC;YAAS,CAAC;QACT,MAAM,CAAC,KAAK,EAAE,CAAC;IACjB,CAAC;AACH,CAAC;AAWD;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAClC,GAAW,EACX,QAAqB,EACrB,KAAc,EACd,MAAsB;IAEtB,MAAM,OAAO,GAAY,EAAE,CAAC;IAC5B,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE;QACzB,MAAM,IAAI,GAAG,GAAG,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACxG,OAAO,MAAM,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,CAAC,IAAI,YAAY,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IACpH,CAAC,CAAC;AACJ,CAAC","sourcesContent":["/**\n * Altitudes encoded in the colors of PNG tiles, for the relief: Terrarium (Mapzen, the Terrain Tiles of AWS) and\n * Terrain-RGB (Mapbox, MapTiler). The engine reads raw floats only; a loader gives it the altitudes of each tile,\n * decoded in a worker of the map's pool (OffscreenCanvas), or in the page when the map has no workers.\n */\n\n/** The encodings of altitudes in the colors of PNG tiles */\nexport type PngEncoding = 'terrarium' | 'mapbox';\n\nconst SIZE = 256;\n\n/** Altitudes (metres, rows from the north) of RGBA pixels in an encoding; below `floor` raised to it */\nexport function decodeHeights(\n  rgba: Uint8ClampedArray | Uint8Array,\n  encoding: PngEncoding,\n  floor = Number.NEGATIVE_INFINITY,\n): Float32Array {\n  const n = rgba.length >> 2;\n  const out = new Float32Array(n);\n  // A loop per encoding, without allocations: 65 536 pixels a tile\n  if (encoding === 'terrarium') {\n    for (let i = 0, j = 0; i < n; i += 1, j += 4) {\n      const h = (rgba[j] as number) * 256 + (rgba[j + 1] as number) + (rgba[j + 2] as number) / 256 - 32768;\n      out[i] = h > floor ? h : floor;\n    }\n  } else {\n    for (let i = 0, j = 0; i < n; i += 1, j += 4) {\n      const h = -10000 + ((rgba[j] as number) * 65536 + (rgba[j + 1] as number) * 256 + (rgba[j + 2] as number)) * 0.1;\n      out[i] = h > floor ? h : floor;\n    }\n  }\n  return out;\n}\n\n/** Where the tiles are drawn and read back, made on first use and kept (each tile drawn and read at once) */\nexport interface Surface {\n  canvas?: OffscreenCanvas;\n}\n\n/**\n * The altitudes of the PNG tile at `url`: 256 × 256, null where the server has no tile; a network or server error\n * rejects (the engine retries). Where it runs: in a worker of the map, or in the page without workers\n */\nexport async function fetchHeights(\n  url: string,\n  encoding: PngEncoding,\n  floor: number | undefined,\n  signal: AbortSignal,\n  surface: Surface,\n): Promise<Float32Array | null> {\n  const response = await fetch(url, { signal });\n  if (response.status === 404 || response.status === 204 || response.status === 410) return null;\n  if (!response.ok) throw new Error(`${response.url}: ${response.status}`);\n  // The colors as stored: no color management, no premultiplied alpha\n  const bitmap = await createImageBitmap(await response.blob(), {\n    premultiplyAlpha: 'none',\n    colorSpaceConversion: 'none',\n  });\n  try {\n    surface.canvas ??= new OffscreenCanvas(SIZE, SIZE);\n    const g = surface.canvas.getContext('2d', { willReadFrequently: true });\n    if (!g) throw new Error('no 2D context');\n    // Another size is resampled to the nearest pixel: an interpolated color is no altitude\n    g.imageSmoothingEnabled = false;\n    g.clearRect(0, 0, SIZE, SIZE);\n    g.drawImage(bitmap, 0, 0, SIZE, SIZE);\n    return decodeHeights(g.getImageData(0, 0, SIZE, SIZE).data, encoding, floor);\n  } finally {\n    bitmap.close();\n  }\n}\n\n/** `fetchHeights` run in a worker for tile `z`/`x`/`y`; undefined when the map has no workers (run in the page) */\nexport type RemoteHeights = (\n  url: string,\n  encoding: PngEncoding,\n  floor: number | undefined,\n  tile: [z: number, x: number, y: number],\n  signal: AbortSignal,\n) => Promise<Float32Array | null> | undefined;\n\n/**\n * A loader of the engine's relief for PNG tiles of `url` ({z}, {x}, {y}) in an encoding: 256 × 256 altitudes, null\n * where the server has no tile; a network or server error rejects (retried). `floor`: the lowest altitude kept (the\n * sea floor of a worldwide model flattened at sea level). `remote`: decodes in a worker when it can\n */\nexport function encodedTerrainLoader(\n  url: string,\n  encoding: PngEncoding,\n  floor?: number,\n  remote?: RemoteHeights,\n): (z: number, x: number, y: number, signal: AbortSignal) => Promise<Float32Array | null> {\n  const surface: Surface = {};\n  return (z, x, y, signal) => {\n    const tile = url.replaceAll('{z}', String(z)).replaceAll('{x}', String(x)).replaceAll('{y}', String(y));\n    return remote?.(tile, encoding, floor, [z, x, y], signal) ?? fetchHeights(tile, encoding, floor, signal, surface);\n  };\n}\n"]}
+{"version":3,"file":"terrain.js","sourceRoot":"","sources":["../src/terrain.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAK5C,MAAM,IAAI,GAAG,GAAG,CAAC;AAEjB,wGAAwG;AACxG,MAAM,UAAU,aAAa,CAC3B,IAAoC,EACpC,QAAqB,EACrB,KAAK,GAAG,MAAM,CAAC,iBAAiB;IAEhC,MAAM,CAAC,GAAG,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC;IAC3B,MAAM,GAAG,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,CAAC;IAChC,iEAAiE;IACjE,IAAI,QAAQ,KAAK,WAAW,EAAE,CAAC;QAC7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7C,MAAM,CAAC,GAAI,IAAI,CAAC,CAAC,CAAY,GAAG,GAAG,GAAI,IAAI,CAAC,CAAC,GAAG,CAAC,CAAY,GAAI,IAAI,CAAC,CAAC,GAAG,CAAC,CAAY,GAAG,GAAG,GAAG,KAAK,CAAC;YACtG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QACjC,CAAC;IACH,CAAC;SAAM,CAAC;QACN,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7C,MAAM,CAAC,GAAG,CAAC,KAAK,GAAG,CAAE,IAAI,CAAC,CAAC,CAAY,GAAG,KAAK,GAAI,IAAI,CAAC,CAAC,GAAG,CAAC,CAAY,GAAG,GAAG,GAAI,IAAI,CAAC,CAAC,GAAG,CAAC,CAAY,CAAC,GAAG,GAAG,CAAC;YACjH,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QACjC,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAOD;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,GAAW,EACX,QAAqB,EACrB,KAAyB,EACzB,MAAmB,EACnB,OAAgB;IAEhB,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,WAAW,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IAChE,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG;QAAE,OAAO,IAAI,CAAC;IAC/F,IAAI,CAAC,QAAQ,CAAC,EAAE;QAAE,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,CAAC,GAAG,KAAK,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IACzE,oEAAoE;IACpE,MAAM,MAAM,GAAG,MAAM,iBAAiB,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,EAAE;QAC5D,gBAAgB,EAAE,MAAM;QACxB,oBAAoB,EAAE,MAAM;KAC7B,CAAC,CAAC;IACH,IAAI,CAAC;QACH,OAAO,CAAC,MAAM,KAAK,IAAI,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACnD,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,kBAAkB,EAAE,IAAI,EAAE,CAAC,CAAC;QACxE,IAAI,CAAC,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;QACzC,uFAAuF;QACvF,CAAC,CAAC,qBAAqB,GAAG,KAAK,CAAC;QAChC,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QAC9B,CAAC,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QACtC,OAAO,aAAa,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;IAC/E,CAAC;YAAS,CAAC;QACT,MAAM,CAAC,KAAK,EAAE,CAAC;IACjB,CAAC;AACH,CAAC;AAWD;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAClC,GAAW,EACX,QAAqB,EACrB,KAAc,EACd,MAAsB;IAEtB,MAAM,OAAO,GAAY,EAAE,CAAC;IAC5B,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE;QACzB,MAAM,IAAI,GAAG,GAAG,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACxG,OAAO,MAAM,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,CAAC,IAAI,YAAY,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IACpH,CAAC,CAAC;AACJ,CAAC","sourcesContent":["/**\n * Altitudes encoded in the colors of PNG tiles, for the relief: Terrarium (Mapzen, the Terrain Tiles of AWS) and\n * Terrain-RGB (Mapbox, MapTiler). The engine reads raw floats only; a loader gives it the altitudes of each tile,\n * decoded in a worker of the map's pool (OffscreenCanvas), or in the page when the map has no workers.\n */\nimport { withHeaders } from './requests.ts';\n\n/** The encodings of altitudes in the colors of PNG tiles */\nexport type PngEncoding = 'terrarium' | 'mapbox';\n\nconst SIZE = 256;\n\n/** Altitudes (metres, rows from the north) of RGBA pixels in an encoding; below `floor` raised to it */\nexport function decodeHeights(\n  rgba: Uint8ClampedArray | Uint8Array,\n  encoding: PngEncoding,\n  floor = Number.NEGATIVE_INFINITY,\n): Float32Array {\n  const n = rgba.length >> 2;\n  const out = new Float32Array(n);\n  // A loop per encoding, without allocations: 65 536 pixels a tile\n  if (encoding === 'terrarium') {\n    for (let i = 0, j = 0; i < n; i += 1, j += 4) {\n      const h = (rgba[j] as number) * 256 + (rgba[j + 1] as number) + (rgba[j + 2] as number) / 256 - 32768;\n      out[i] = h > floor ? h : floor;\n    }\n  } else {\n    for (let i = 0, j = 0; i < n; i += 1, j += 4) {\n      const h = -10000 + ((rgba[j] as number) * 65536 + (rgba[j + 1] as number) * 256 + (rgba[j + 2] as number)) * 0.1;\n      out[i] = h > floor ? h : floor;\n    }\n  }\n  return out;\n}\n\n/** Where the tiles are drawn and read back, made on first use and kept (each tile drawn and read at once) */\nexport interface Surface {\n  canvas?: OffscreenCanvas;\n}\n\n/**\n * The altitudes of the PNG tile at `url`: 256 × 256, null where the server has no tile; a network or server error\n * rejects (the engine retries). Where it runs: in a worker of the map, or in the page without workers\n */\nexport async function fetchHeights(\n  url: string,\n  encoding: PngEncoding,\n  floor: number | undefined,\n  signal: AbortSignal,\n  surface: Surface,\n): Promise<Float32Array | null> {\n  const response = await fetch(url, withHeaders(url, { signal }));\n  if (response.status === 404 || response.status === 204 || response.status === 410) return null;\n  if (!response.ok) throw new Error(`${response.url}: ${response.status}`);\n  // The colors as stored: no color management, no premultiplied alpha\n  const bitmap = await createImageBitmap(await response.blob(), {\n    premultiplyAlpha: 'none',\n    colorSpaceConversion: 'none',\n  });\n  try {\n    surface.canvas ??= new OffscreenCanvas(SIZE, SIZE);\n    const g = surface.canvas.getContext('2d', { willReadFrequently: true });\n    if (!g) throw new Error('no 2D context');\n    // Another size is resampled to the nearest pixel: an interpolated color is no altitude\n    g.imageSmoothingEnabled = false;\n    g.clearRect(0, 0, SIZE, SIZE);\n    g.drawImage(bitmap, 0, 0, SIZE, SIZE);\n    return decodeHeights(g.getImageData(0, 0, SIZE, SIZE).data, encoding, floor);\n  } finally {\n    bitmap.close();\n  }\n}\n\n/** `fetchHeights` run in a worker for tile `z`/`x`/`y`; undefined when the map has no workers (run in the page) */\nexport type RemoteHeights = (\n  url: string,\n  encoding: PngEncoding,\n  floor: number | undefined,\n  tile: [z: number, x: number, y: number],\n  signal: AbortSignal,\n) => Promise<Float32Array | null> | undefined;\n\n/**\n * A loader of the engine's relief for PNG tiles of `url` ({z}, {x}, {y}) in an encoding: 256 × 256 altitudes, null\n * where the server has no tile; a network or server error rejects (retried). `floor`: the lowest altitude kept (the\n * sea floor of a worldwide model flattened at sea level). `remote`: decodes in a worker when it can\n */\nexport function encodedTerrainLoader(\n  url: string,\n  encoding: PngEncoding,\n  floor?: number,\n  remote?: RemoteHeights,\n): (z: number, x: number, y: number, signal: AbortSignal) => Promise<Float32Array | null> {\n  const surface: Surface = {};\n  return (z, x, y, signal) => {\n    const tile = url.replaceAll('{z}', String(z)).replaceAll('{x}', String(x)).replaceAll('{y}', String(y));\n    return remote?.(tile, encoding, floor, [z, x, y], signal) ?? fetchHeights(tile, encoding, floor, signal, surface);\n  };\n}\n"]}

package/dist/types.d.ts

@@ -201,6 +201,27 @@ export interface ViewshedOptions {
     /** Angle of view up and down, degrees (default 40) */
     verticalFov?: number;
 }
+/** An eye at street level (`GeoMap.setFirstPerson`) */
+export interface FirstPersonView {
+    /** Where it stands */
+    lonLat: LonLat;
+    /** Metres above the ground (default 1.7) */
+    height?: number;
+    /** Degrees clockwise from north it looks to */
+    bearing: number;
+    /** Degrees from straight down: 90 level (the default), 180 straight up */
+    pitch?: number;
+    /** Vertical field of view, degrees (default 75) */
+    fov?: number;
+}
+/** Layers shown on one side of a vertical line only (`GeoMap.setSwipe`) */
+export interface SwipeOptions {
+    /** CSS pixels from the left of the map */
+    position: number;
+    layers: readonly Layer[];
+    /** The side they show on (default 'left') */
+    side?: 'left' | 'right';
+}
 /** Animation of a camera move */
 export interface AnimationOptions {
     /** Milliseconds */
@@ -291,10 +312,16 @@ export interface Tiles3dStyle {
     opacity: number;
     /** Size of the points of point cloud tiles (`.pnts`, glTF points), CSS pixels: 2 by default */
     pointSize?: number;
+    /** A CSS color multiplying the textures of the meshes, the color of the untextured ones (buildings without
+     * textures are light grey without it); none by default */
+    color?: string;
 }
 export interface Tiles3dOptions extends Partial<Tiles3dStyle> {
     /** URL of a `tileset.json` (3D Tiles 1.0 b3dm and pnts, 1.1 glb meshes and points, external tilesets) */
     url: string;
+    /** Its heights are altitudes above the geoid (NGF-IGN69), as the IGN's Bâtiments 3D, rather than above the
+     * ellipsoid (3D Tiles as specified): each tile raised by the RAF20 geoid, onto the IGN relief (default false) */
+    geoid?: boolean;
 }
 export interface MapPointerEvent {
     point: Point;
@@ -306,7 +333,8 @@ export interface MapHoverFeatureEvent extends MapPointerEvent {
     /** The feature under the pointer (see `GeoMap.pickFeature`), undefined if none */
     hit: FeatureHit | undefined;
 }
-/** A picked feature: its layer handle, its index there and, for line, circle and fill layers, the feature itself */
+/** A picked feature: its layer handle, its index there and, for line, circle, fill, extrusion, point cloud and 3D
+ * Tiles layers, the feature itself (a building of 3D Tiles with its properties) */
 export interface FeatureHit {
     layer: Layer;
     index: number;

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"","sourcesContent":["/** Public types of the `isard` package */\nimport type { AttributionOptions } from './controls.ts';\nimport type { DecoderUrls } from './decoders.ts';\nimport type { Feature, Ramp, Size } from './features.ts';\nimport type { TileGrid } from './grid.ts';\nimport type { Layer } from './layers.ts';\nimport type { Camera, Engine } from './wasm/isard.js';\n\nexport type LonLat = [lon: number, lat: number];\nexport type Point = [x: number, y: number];\n\n/**\n * The named basemaps. OpenFreeMap's vector styles, OpenStreetMap data worldwide, their labels above the other layers:\n * `osm-positron` (light grey, quiet: data over it reads first), `osm-liberty` and `osm-bright` (in colour). The\n * Géoplateforme's (IGN, France): rasters (`ign-plan`, `ign-plan-grey`, `ign-ortho`, the aerial photographs) or vector\n * tiles with their labels (`ign-plan-vector`, `ign-plan-grey-vector`, the PLAN.IGN styles).\n */\nexport type BasemapName =\n  | 'osm-positron'\n  | 'osm-liberty'\n  | 'osm-bright'\n  | 'ign-plan'\n  | 'ign-plan-grey'\n  | 'ign-ortho'\n  | 'ign-plan-vector'\n  | 'ign-plan-grey-vector'\n  | 'none';\n\n/**\n * @deprecated The former names of the Géoplateforme basemaps, still accepted (with a warning): the same names with the\n * `ign-` prefix (`'plan-grey'` is `'ign-plan-grey'`)\n */\nexport type LegacyBasemap = 'plan' | 'plan-grey' | 'plan-vector' | 'plan-grey-vector' | 'ortho';\n\n/** A basemap by name (see `BasemapName`; the former names of `LegacyBasemap` are deprecated) */\nexport type Basemap = BasemapName | LegacyBasemap;\n\n/**\n * The Earth's named terrain models. `'terrain-tiles'`: worldwide, the Terrain Tiles of AWS's open data registry\n * (SRTM, EU-DEM, GMTED… merged by Mapzen, 30 m in most places), the sea floor flattened at sea level. `'ign'`: France,\n * the IGN's RGE ALTI from the Géoplateforme (1 to 5 m), raised by the RAF20 geoid to heights above the ellipsoid.\n */\nexport type TerrainModel = 'terrain-tiles' | 'ign';\n\n/** How tiles encode their altitudes: `'float32'`, raw little-endian floats (`image/x-bil;bits=32`, an ArcGIS raw\n * grid); `'terrarium'`, the colors of a PNG, `R × 256 + G + B / 256 - 32768`; `'mapbox'`, those of Terrain-RGB,\n * `(R × 65536 + G × 256 + B) / 10 - 10000` */\nexport type TerrainEncoding = 'float32' | 'terrarium' | 'mapbox';\n\n/**\n * How tiles load and show. 'immediate' (default): everything visible loads, tiles show as soon as they arrive.\n * 'smooth': during flights the levels flown through are skipped, off-center tiles wait while the camera moves, tiles\n * fade in; fewer downloads, for slow networks or GPUs.\n */\nexport type LoadingMode = 'immediate' | 'smooth';\n\n/** 'globe': a sphere at low zoom, blending into Web Mercator between zooms 5 and 7, up to three levels later under a\n * tilted camera (it sees much farther than its center: the horizon stays curved) */\nexport type Projection = 'globe' | 'mercator';\n\n/** A body to draw the map on, other than the named ones (`CelestialBody`) */\nexport interface BodyOptions {\n  /** Equatorial radius, metres */\n  radius: number;\n  /** Flattening of its ellipsoid, 0 for a sphere (default 0) */\n  flattening?: number;\n  /** An atmosphere: its halo around the globe, true for the Earth's light blue, or a CSS color (its alpha the\n   * halo's strength) (default false) */\n  atmosphere?: boolean | string;\n  /** Color of the globe where no tile covers it (past the Web Mercator latitudes, 85°), a CSS color (default\n   * `#808080`) */\n  color?: string;\n  /** Lowest and highest altitudes of its ground, metres around the ellipsoid: what its relief may raise into view\n   * (default ±1 % of the radius) */\n  relief?: [lowest: number, highest: number];\n}\n\n/**\n * The body the map is drawn on: 'earth' (WGS 84, the default), 'moon' (a sphere of 1 737 400 m, no atmosphere),\n * 'mars' (a sphere of 3 396 190 m, its equatorial radius, a thin dusty halo; planetocentric latitudes) or another\n * one. Zoom levels keep their meaning on screen (the Web Mercator tile pyramid), their metres follow the body:\n * altitudes, relief, buildings, 3D Tiles. Off the Earth, the map has none of the Earth's defaults: no basemap, no\n * credits, and space for its background; the Moon and Mars have NASA's relief for `terrain: true`.\n */\nexport type CelestialBody = 'earth' | 'moon' | 'mars' | BodyOptions;\n\nexport interface GeoMapOptions extends Partial<Camera> {\n  /** The body the map is drawn on (default 'earth'); set at creation */\n  body?: CelestialBody;\n  /** Default 'globe' */\n  projection?: Projection;\n  /** Default 'immediate' */\n  loading?: LoadingMode;\n  /** The basemap (default 'osm-positron'; 'none' off the Earth) */\n  basemap?: Basemap;\n  /** Opacity of the IGN hillshade over the basemap (France, Géoplateforme), 0 for none (default 0) */\n  hillshade?: number;\n  /** Color behind the map (sky of tilted flat views), a CSS color (default `#f2f2f0`; black off the Earth) */\n  background?: string;\n  /** Space behind the globe: stars and atmosphere halo, fading out as the globe turns flat (default true) */\n  sky?: boolean;\n  /** Relief under the basemap: true for the body's terrain model (on the Earth the worldwide Terrain Tiles; NASA's on\n   * the Moon and Mars: LOLA, MOLA), one of the Earth's models by name (`'ign'`: France, RGE ALTI), or its options\n   * (default false; on another body, its `url` is required). Network layers are draped on it */\n  terrain?: boolean | TerrainModel | TerrainOptions;\n  minZoom?: number;\n  maxZoom?: number;\n  /** Highest pitch, degrees, up to 85 (default 70) */\n  maxPitch?: number;\n  /** Sky over the plane, seen when the camera is tilted towards the horizon, and the fog the ground fades into\n   * (MapLibre's `setSky`); default none: the background color */\n  atmosphere?: AtmosphereOptions;\n  /** Mouse, touch and keyboard controls (default true) */\n  interactive?: boolean;\n  /** Keyboard controls once the map has the focus (it is reached with Tab): arrows pan, Shift + arrows rotate and\n   * tilt, + and - zoom (Shift: two levels), 0 faces north and levels the view (default true; none when not\n   * `interactive`) */\n  keyboard?: boolean;\n  /** Accessible name of the map, read by screen readers (default 'Map') */\n  ariaLabel?: string;\n  /** Where to load the engine with 3D Tiles from (`isard_bg.wasm`), when a bundler does not resolve the default URL.\n   * Given without `coreWasmUrl`, maps load this engine from the start */\n  wasmUrl?: string | URL;\n  /** Where to load the engine without 3D Tiles from (`isard_core_bg.wasm`, a third smaller), when a bundler does not\n   * resolve the default URL. Maps load it first, and the engine with 3D Tiles (`wasmUrl`) for their first 3D Tiles\n   * layer only */\n  coreWasmUrl?: string | URL;\n  /** Where the decoding workers load the point cloud module from (`isard_points_bg.wasm`, the LAZ decoder of COPC),\n   * when a bundler does not resolve the default URL. Loaded with the first point cloud only */\n  pointsWasmUrl?: string | URL;\n  /** Load the engine with 3D Tiles from the start (default false: it is loaded when the first 3D Tiles layer or glTF\n   * model is added, the map then moving its camera and layers onto it, a stall of about a frame or two). For a map that shows 3D Tiles\n   * at once: one engine downloaded instead of two. `'preload'`: the map starts on the engine without 3D Tiles and\n   * downloads and compiles the other once idle, without running it: its first 3D Tiles layer does not wait for the\n   * download (for a map that will show 3D Tiles later, on demand) */\n  tiles3d?: boolean | 'preload';\n  /** Where to load the vector basemap worker from, when a bundler does not resolve the default URL */\n  basemapWorkerUrl?: string | URL;\n  /** Texture size of the vector basemap's tiles, pixels (default 512: lines and edges sharp at every zoom on a screen\n   * of pixel ratio 1). 256: a quarter of the drawing in the workers, of the uploads and of the GPU memory, for lines\n   * and edges a little softer between two zoom levels (the tiles are shown 181 to 362 CSS pixels wide) */\n  basemapTileSize?: number;\n  /** Glyphs of the symbol layers: a URL with `{fontstack}` and `{range}` (MapLibre's glyph format; default\n   * OpenFreeMap's fonts, Noto Sans). A vector basemap's labels take the glyphs of its style */\n  glyphs?: string;\n  /** Workers decoding 3D Tiles off the main thread: a count, or false to decode on the main thread (default: cores - 1,\n   * 1 to 4). False (or 0) also decodes the PNG relief and reprojects the equirectangular rasters on the main thread,\n   * else done by the vector basemap's workers */\n  workers?: number | false;\n  /** Where to load the decoding worker from, when a bundler does not resolve the default URL */\n  workerUrl?: string | URL;\n  /** Folders of the Draco and Basis Universal decoders, loaded by the workers on first use (default: the official\n   * builds on gstatic.com and jsDelivr; self-host them for offline or locked-down networks). They run through\n   * `new Function`: a Content Security Policy needs `'unsafe-eval'` (see `DecoderUrls`) */\n  decoders?: Partial<DecoderUrls>;\n  /** Credits at the bottom right: false for none, or its options (default true: the credits of the basemap,\n   * hillshade and relief in use, compact on maps narrower than 640 px) */\n  attributionControl?: boolean | AttributionOptions;\n}\n\nexport interface TerrainOptions {\n  /** One of the Earth's named models (default `'terrain-tiles'` on the Earth); unused with a `url` */\n  model?: TerrainModel;\n  /** Altitudes of 256 × 256 tiles in `encoding`: a WMS GetMap URL with {bbox} (EPSG:3857 on the Earth, the body's\n   * Mercator metres elsewhere: the sphere of its radius), a tile URL with {z}, {x} and {y}, or an ArcGIS image service\n   * (a URL ending in `/ImageServer`), asked for raw altitudes in the body's Mercator (default: the `model`'s; on the\n   * Moon and Mars, NASA's Trek LOLA and MOLA models) */\n  url?: string;\n  /** How the tiles of `url` encode their altitudes (default `'float32'`); `'terrarium'` and `'mapbox'` take a URL with\n   * {z}, {x} and {y} */\n  encoding?: TerrainEncoding;\n  /** Vertical exaggeration, 1 for the true relief (default 1) */\n  exaggeration?: number;\n  /** Finest level of the relief, up to 15 (default 15; 14 for the Terrain Tiles, 8 for the Moon's and Mars's models). It\n   * starts at level 6 on the Earth, coarser on bodies of a larger relief for their size (3 on the Moon and Mars) */\n  maxZoom?: number;\n  /** Altitudes over mainland France raised by the height of the RAF20 geoid (the French one, 0 away from France), to\n   * heights above the ellipsoid (those of 3D Tiles); false keeps the altitudes as served (NGF-IGN69 for the IGN's)\n   * (default true for the `'ign'` model, false otherwise) */\n  geoid?: boolean;\n}\n\n/** Sky, horizon and fog over the plane, with the names and meanings of MapLibre's `setSky` */\nexport interface AtmosphereOptions {\n  /** A CSS color (default `#9cc7ec`) */\n  skyColor?: string;\n  /** (default `#e8f1f8`) */\n  horizonColor?: string;\n  /** (default `#f2f5f8`) */\n  fogColor?: string;\n  /** Blend from the horizon to the sky color, share of the field of view above the horizon, 0-1 (default 0.6) */\n  skyHorizonBlend?: number;\n  /** Blend from the horizon to the fog color below the horizon, 0-1 (default 0.7) */\n  horizonFogBlend?: number;\n  /** Share of the distance to the far plane over which the ground fades into the fog, 0-1 (default 0.4) */\n  fogGroundBlend?: number;\n}\n\n/** What can be seen from a point (`GeoMap.setViewshed`); with several observers, the colors, the opacity and the\n * cone's color are the first one's */\nexport interface ViewshedOptions {\n  /** The observer */\n  position: LonLat;\n  /** Metres above the ground (default 1.7, eye level) */\n  height?: number;\n  /** Metres around the observer that are tinted (default 1000) */\n  range?: number;\n  /** A CSS color for what is seen (default `#2f9e44`) */\n  visibleColor?: string;\n  /** A CSS color for what is hidden (default `#e03131`) */\n  hiddenColor?: string;\n  /** How strongly the colors tint the scene, multiplied into it so that its textures and shading stay, 0-1 (default\n   * 0.7) */\n  opacity?: number;\n  /** A CSS color for the cone drawn in 3D (one way only): its fan through the axis, at the eye's height and tilted\n   * with it, from the eye to the range; solid where nothing hides it, faint behind the scene; none by default */\n  coneColor?: string;\n  /** To look one way only (a camera, a lookout), degrees clockwise from north; all around without it */\n  direction?: number;\n  /** Degrees above the horizon the cone looks, negative below (default 0) */\n  tilt?: number;\n  /** Angle of view across, degrees (default 60) */\n  fov?: number;\n  /** Angle of view up and down, degrees (default 40) */\n  verticalFov?: number;\n}\n\n/** Animation of a camera move */\nexport interface AnimationOptions {\n  /** Milliseconds */\n  duration?: number;\n  /** Progress over time, both 0 to 1 */\n  easing?: (t: number) => number;\n}\n\nexport interface FlyToOptions extends AnimationOptions {\n  /** How far the flight zooms out on its way, as MapLibre's `curve` (default 1.42) */\n  curve?: number;\n  /** Average speed in screens per second when `duration` is not given (default 1.2) */\n  speed?: number;\n}\n\n/**\n * Tile grid of a raster's URL. 'mercator': Web Mercator (XYZ, WMTS PM), the engine's own. 'equirectangular':\n * longitudes and latitudes (Plate Carrée, EPSG:4326-like), two 256 px tiles side by side at level 0, rows from the\n * north (NASA's Trek WMTS, WorldCRS84Quad). A `TileGrid`: the tile matrices of a WMTS in any CRS (Lambert-93…), or a\n * WMS asked for each tile's box in its CRS. The last two are reprojected into Web Mercator tiles by the map's workers\n * (in the page with `workers: false`).\n */\nexport type RasterGrid = 'mercator' | 'equirectangular' | TileGrid;\n\n/** What `RasterLayer.setStyle` changes */\nexport interface RasterStyle {\n  opacity: number;\n  /** 0 = greyscale, 1 = original colors */\n  saturation: number;\n}\n\nexport interface RasterOptions {\n  /** Tile URL with {z}, {x} and {y} (256 px tiles); unused with a `loader` */\n  url: string;\n  /** Tile grid of `url` (default 'mercator'); with 'equirectangular', `minZoom` and `maxZoom` are levels of that\n   * grid; with a `TileGrid`, they are map zooms, by default those its matrices span */\n  grid?: RasterGrid;\n  minZoom?: number;\n  maxZoom?: number;\n  opacity?: number;\n  /** 0 = greyscale, 1 = original colors */\n  saturation?: number;\n  /** Side of the tiles' textures, pixels (default 256): more for sharper tiles drawn by a `loader` */\n  size?: number;\n  /** Draws each tile instead of fetching `url`: an image of `size` × `size`, null for nothing there; a rejection is\n   * retried like a network error */\n  loader?: (z: number, x: number, y: number, signal: AbortSignal) => Promise<ImageBitmap | null>;\n  /** Credits of the tiles, HTML: shown by the attribution control while the layer is on the map */\n  attribution?: string;\n}\n\nexport interface NetworkStyle {\n  /** Line width, CSS pixels, or zoom stops `[[zoom, width], …]` (default 2) */\n  width: Size;\n  /** Values above are drawn as unreached (default 1800) */\n  max: number;\n  /** Darker line every `contour` value units, 0 for none (default 0) */\n  contour: number;\n  opacity: number;\n  /** Width of the halo drawn under the lines, CSS pixels or zoom stops, 0 for none (default 0): wide and faint, the\n   * reached streets add up into a heat map that fills the blocks */\n  halo: Size;\n  /** Opacity of the halo at the middle of a line, fading quadratically to its sides (default 0.11) */\n  haloOpacity: number;\n  /** Colors from 0 to `max`: `[[fraction of max, color], …]` (default green to red) */\n  ramp: Ramp | undefined;\n  /** Color of the parts beyond `max` or unreached (default `rgba(140, 140, 140, 0.25)`) */\n  unreachedColor: string;\n  /** Share of `max` over which the colors fade out before it, 0 to 1 (default 0) */\n  fade: number;\n}\n\nexport interface NetworkOptions extends Partial<NetworkStyle> {\n  /** Node coordinates in degrees: lon0, lat0, lon1, lat1… */\n  nodes: Float64Array;\n  /** Edges as node index pairs: a0, b0, a1, b1… */\n  edges: Uint32Array;\n  /** Line of each edge, from A to B: the points of edge e are `points[start[e] .. start[e + 1]]` (lon, lat pairs,\n   * counted in points); with fewer than two points an edge is straight. Default: all straight. */\n  lines?: { start: Uint32Array; points: Float64Array };\n  /** Per edge, the cost of travelling it from A to B then from B to A, in value units (Infinity: closed that way;\n   * closed both ways: not drawn). A point along an edge then takes the quickest way there, min(value(A) + cost from\n   * A, value(B) + cost from B), as a travel time does. Without costs, values are interpolated along the edges. */\n  costs?: Float32Array;\n  /** Width factor of each edge (default 1): rail lines wider than streets */\n  edgeWidths?: Float32Array;\n}\n\nexport interface Tiles3dStyle {\n  /** Screen-space error (CSS pixels) above which a tile is refined: 16 by default, lower is finer and heavier */\n  maxScreenSpaceError: number;\n  opacity: number;\n  /** Size of the points of point cloud tiles (`.pnts`, glTF points), CSS pixels: 2 by default */\n  pointSize?: number;\n}\n\nexport interface Tiles3dOptions extends Partial<Tiles3dStyle> {\n  /** URL of a `tileset.json` (3D Tiles 1.0 b3dm and pnts, 1.1 glb meshes and points, external tilesets) */\n  url: string;\n}\n\nexport interface MapPointerEvent {\n  point: Point;\n  /** Undefined above the horizon */\n  lonLat: LonLat | undefined;\n}\n\n/** What 'hoverfeature' found under the pointer */\nexport interface MapHoverFeatureEvent extends MapPointerEvent {\n  /** The feature under the pointer (see `GeoMap.pickFeature`), undefined if none */\n  hit: FeatureHit | undefined;\n}\n\n/** A picked feature: its layer handle, its index there and, for line, circle and fill layers, the feature itself */\nexport interface FeatureHit {\n  layer: Layer;\n  index: number;\n  feature: Feature | undefined;\n}\n\nexport interface MapEvents {\n  /** The camera started moving (a gesture, an animation or `setCamera`) */\n  movestart: Camera;\n  /** The camera moved */\n  move: Camera;\n  /** The camera stopped: no gesture held, no animation running */\n  moveend: Camera;\n  /** The map changed size (CSS pixels) */\n  resize: { width: number; height: number };\n  /** The pointer moved over the map (at most once per frame, not while dragging) */\n  hover: MapPointerEvent;\n  /** What is under the pointer, picked without stalling the GPU: a frame or two after 'hover', only while listened to\n   * (radius and layers in `GeoMap.hoverPicking`) */\n  hoverfeature: MapHoverFeatureEvent;\n  /** Click without drag */\n  click: MapPointerEvent;\n  /** A frame was drawn; duration of the engine call in milliseconds */\n  render: { ms: number };\n  /** Everything in view is loaded and drawn, nothing moves: the end of a load, once after each change (as MapLibre's\n   * `idle`). Tiles requested by the first frame count, so it never fires before they arrive. */\n  idle: Record<string, never>;\n  /** The pointer left the canvas (a mouse going out of the map, or onto a control or marker) */\n  leave: Record<string, never>;\n}\n\n/** What a layer handle needs from its map */\nexport interface LayerHost {\n  readonly engine: Engine;\n  requestRender(): void;\n  /** Forgets a removed layer */\n  detach(layer: object): void;\n  /** Moves a layer under `before`, or on top */\n  moveLayer(layer: object, before: object | undefined): void;\n  /** A layer created again in the engine (new id): put at the place of its old id, which is removed */\n  replaceLayer(layer: object, old: number): void;\n}\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"","sourcesContent":["/** Public types of the `isard` package */\nimport type { AttributionOptions } from './controls.ts';\nimport type { DecoderUrls } from './decoders.ts';\nimport type { Feature, Ramp, Size } from './features.ts';\nimport type { TileGrid } from './grid.ts';\nimport type { Layer } from './layers.ts';\nimport type { Camera, Engine } from './wasm/isard.js';\n\nexport type LonLat = [lon: number, lat: number];\nexport type Point = [x: number, y: number];\n\n/**\n * The named basemaps. OpenFreeMap's vector styles, OpenStreetMap data worldwide, their labels above the other layers:\n * `osm-positron` (light grey, quiet: data over it reads first), `osm-liberty` and `osm-bright` (in colour). The\n * Géoplateforme's (IGN, France): rasters (`ign-plan`, `ign-plan-grey`, `ign-ortho`, the aerial photographs) or vector\n * tiles with their labels (`ign-plan-vector`, `ign-plan-grey-vector`, the PLAN.IGN styles).\n */\nexport type BasemapName =\n  | 'osm-positron'\n  | 'osm-liberty'\n  | 'osm-bright'\n  | 'ign-plan'\n  | 'ign-plan-grey'\n  | 'ign-ortho'\n  | 'ign-plan-vector'\n  | 'ign-plan-grey-vector'\n  | 'none';\n\n/**\n * @deprecated The former names of the Géoplateforme basemaps, still accepted (with a warning): the same names with the\n * `ign-` prefix (`'plan-grey'` is `'ign-plan-grey'`)\n */\nexport type LegacyBasemap = 'plan' | 'plan-grey' | 'plan-vector' | 'plan-grey-vector' | 'ortho';\n\n/** A basemap by name (see `BasemapName`; the former names of `LegacyBasemap` are deprecated) */\nexport type Basemap = BasemapName | LegacyBasemap;\n\n/**\n * The Earth's named terrain models. `'terrain-tiles'`: worldwide, the Terrain Tiles of AWS's open data registry\n * (SRTM, EU-DEM, GMTED… merged by Mapzen, 30 m in most places), the sea floor flattened at sea level. `'ign'`: France,\n * the IGN's RGE ALTI from the Géoplateforme (1 to 5 m), raised by the RAF20 geoid to heights above the ellipsoid.\n */\nexport type TerrainModel = 'terrain-tiles' | 'ign';\n\n/** How tiles encode their altitudes: `'float32'`, raw little-endian floats (`image/x-bil;bits=32`, an ArcGIS raw\n * grid); `'terrarium'`, the colors of a PNG, `R × 256 + G + B / 256 - 32768`; `'mapbox'`, those of Terrain-RGB,\n * `(R × 65536 + G × 256 + B) / 10 - 10000` */\nexport type TerrainEncoding = 'float32' | 'terrarium' | 'mapbox';\n\n/**\n * How tiles load and show. 'immediate' (default): everything visible loads, tiles show as soon as they arrive.\n * 'smooth': during flights the levels flown through are skipped, off-center tiles wait while the camera moves, tiles\n * fade in; fewer downloads, for slow networks or GPUs.\n */\nexport type LoadingMode = 'immediate' | 'smooth';\n\n/** 'globe': a sphere at low zoom, blending into Web Mercator between zooms 5 and 7, up to three levels later under a\n * tilted camera (it sees much farther than its center: the horizon stays curved) */\nexport type Projection = 'globe' | 'mercator';\n\n/** A body to draw the map on, other than the named ones (`CelestialBody`) */\nexport interface BodyOptions {\n  /** Equatorial radius, metres */\n  radius: number;\n  /** Flattening of its ellipsoid, 0 for a sphere (default 0) */\n  flattening?: number;\n  /** An atmosphere: its halo around the globe, true for the Earth's light blue, or a CSS color (its alpha the\n   * halo's strength) (default false) */\n  atmosphere?: boolean | string;\n  /** Color of the globe where no tile covers it (past the Web Mercator latitudes, 85°), a CSS color (default\n   * `#808080`) */\n  color?: string;\n  /** Lowest and highest altitudes of its ground, metres around the ellipsoid: what its relief may raise into view\n   * (default ±1 % of the radius) */\n  relief?: [lowest: number, highest: number];\n}\n\n/**\n * The body the map is drawn on: 'earth' (WGS 84, the default), 'moon' (a sphere of 1 737 400 m, no atmosphere),\n * 'mars' (a sphere of 3 396 190 m, its equatorial radius, a thin dusty halo; planetocentric latitudes) or another\n * one. Zoom levels keep their meaning on screen (the Web Mercator tile pyramid), their metres follow the body:\n * altitudes, relief, buildings, 3D Tiles. Off the Earth, the map has none of the Earth's defaults: no basemap, no\n * credits, and space for its background; the Moon and Mars have NASA's relief for `terrain: true`.\n */\nexport type CelestialBody = 'earth' | 'moon' | 'mars' | BodyOptions;\n\nexport interface GeoMapOptions extends Partial<Camera> {\n  /** The body the map is drawn on (default 'earth'); set at creation */\n  body?: CelestialBody;\n  /** Default 'globe' */\n  projection?: Projection;\n  /** Default 'immediate' */\n  loading?: LoadingMode;\n  /** The basemap (default 'osm-positron'; 'none' off the Earth) */\n  basemap?: Basemap;\n  /** Opacity of the IGN hillshade over the basemap (France, Géoplateforme), 0 for none (default 0) */\n  hillshade?: number;\n  /** Color behind the map (sky of tilted flat views), a CSS color (default `#f2f2f0`; black off the Earth) */\n  background?: string;\n  /** Space behind the globe: stars and atmosphere halo, fading out as the globe turns flat (default true) */\n  sky?: boolean;\n  /** Relief under the basemap: true for the body's terrain model (on the Earth the worldwide Terrain Tiles; NASA's on\n   * the Moon and Mars: LOLA, MOLA), one of the Earth's models by name (`'ign'`: France, RGE ALTI), or its options\n   * (default false; on another body, its `url` is required). Network layers are draped on it */\n  terrain?: boolean | TerrainModel | TerrainOptions;\n  minZoom?: number;\n  maxZoom?: number;\n  /** Highest pitch, degrees, up to 85 (default 70) */\n  maxPitch?: number;\n  /** Sky over the plane, seen when the camera is tilted towards the horizon, and the fog the ground fades into\n   * (MapLibre's `setSky`); default none: the background color */\n  atmosphere?: AtmosphereOptions;\n  /** Mouse, touch and keyboard controls (default true) */\n  interactive?: boolean;\n  /** Keyboard controls once the map has the focus (it is reached with Tab): arrows pan, Shift + arrows rotate and\n   * tilt, + and - zoom (Shift: two levels), 0 faces north and levels the view (default true; none when not\n   * `interactive`) */\n  keyboard?: boolean;\n  /** Accessible name of the map, read by screen readers (default 'Map') */\n  ariaLabel?: string;\n  /** Where to load the engine with 3D Tiles from (`isard_bg.wasm`), when a bundler does not resolve the default URL.\n   * Given without `coreWasmUrl`, maps load this engine from the start */\n  wasmUrl?: string | URL;\n  /** Where to load the engine without 3D Tiles from (`isard_core_bg.wasm`, a third smaller), when a bundler does not\n   * resolve the default URL. Maps load it first, and the engine with 3D Tiles (`wasmUrl`) for their first 3D Tiles\n   * layer only */\n  coreWasmUrl?: string | URL;\n  /** Where the decoding workers load the point cloud module from (`isard_points_bg.wasm`, the LAZ decoder of COPC),\n   * when a bundler does not resolve the default URL. Loaded with the first point cloud only */\n  pointsWasmUrl?: string | URL;\n  /** Load the engine with 3D Tiles from the start (default false: it is loaded when the first 3D Tiles layer or glTF\n   * model is added, the map then moving its camera and layers onto it, a stall of about a frame or two). For a map that shows 3D Tiles\n   * at once: one engine downloaded instead of two. `'preload'`: the map starts on the engine without 3D Tiles and\n   * downloads and compiles the other once idle, without running it: its first 3D Tiles layer does not wait for the\n   * download (for a map that will show 3D Tiles later, on demand) */\n  tiles3d?: boolean | 'preload';\n  /** Where to load the vector basemap worker from, when a bundler does not resolve the default URL */\n  basemapWorkerUrl?: string | URL;\n  /** Texture size of the vector basemap's tiles, pixels (default 512: lines and edges sharp at every zoom on a screen\n   * of pixel ratio 1). 256: a quarter of the drawing in the workers, of the uploads and of the GPU memory, for lines\n   * and edges a little softer between two zoom levels (the tiles are shown 181 to 362 CSS pixels wide) */\n  basemapTileSize?: number;\n  /** Glyphs of the symbol layers: a URL with `{fontstack}` and `{range}` (MapLibre's glyph format; default\n   * OpenFreeMap's fonts, Noto Sans). A vector basemap's labels take the glyphs of its style */\n  glyphs?: string;\n  /** Workers decoding 3D Tiles off the main thread: a count, or false to decode on the main thread (default: cores - 1,\n   * 1 to 4). False (or 0) also decodes the PNG relief and reprojects the equirectangular rasters on the main thread,\n   * else done by the vector basemap's workers */\n  workers?: number | false;\n  /** Where to load the decoding worker from, when a bundler does not resolve the default URL */\n  workerUrl?: string | URL;\n  /** Folders of the Draco and Basis Universal decoders, loaded by the workers on first use (default: the official\n   * builds on gstatic.com and jsDelivr; self-host them for offline or locked-down networks). They run through\n   * `new Function`: a Content Security Policy needs `'unsafe-eval'` (see `DecoderUrls`) */\n  decoders?: Partial<DecoderUrls>;\n  /** Credits at the bottom right: false for none, or its options (default true: the credits of the basemap,\n   * hillshade and relief in use, compact on maps narrower than 640 px) */\n  attributionControl?: boolean | AttributionOptions;\n}\n\nexport interface TerrainOptions {\n  /** One of the Earth's named models (default `'terrain-tiles'` on the Earth); unused with a `url` */\n  model?: TerrainModel;\n  /** Altitudes of 256 × 256 tiles in `encoding`: a WMS GetMap URL with {bbox} (EPSG:3857 on the Earth, the body's\n   * Mercator metres elsewhere: the sphere of its radius), a tile URL with {z}, {x} and {y}, or an ArcGIS image service\n   * (a URL ending in `/ImageServer`), asked for raw altitudes in the body's Mercator (default: the `model`'s; on the\n   * Moon and Mars, NASA's Trek LOLA and MOLA models) */\n  url?: string;\n  /** How the tiles of `url` encode their altitudes (default `'float32'`); `'terrarium'` and `'mapbox'` take a URL with\n   * {z}, {x} and {y} */\n  encoding?: TerrainEncoding;\n  /** Vertical exaggeration, 1 for the true relief (default 1) */\n  exaggeration?: number;\n  /** Finest level of the relief, up to 15 (default 15; 14 for the Terrain Tiles, 8 for the Moon's and Mars's models). It\n   * starts at level 6 on the Earth, coarser on bodies of a larger relief for their size (3 on the Moon and Mars) */\n  maxZoom?: number;\n  /** Altitudes over mainland France raised by the height of the RAF20 geoid (the French one, 0 away from France), to\n   * heights above the ellipsoid (those of 3D Tiles); false keeps the altitudes as served (NGF-IGN69 for the IGN's)\n   * (default true for the `'ign'` model, false otherwise) */\n  geoid?: boolean;\n}\n\n/** Sky, horizon and fog over the plane, with the names and meanings of MapLibre's `setSky` */\nexport interface AtmosphereOptions {\n  /** A CSS color (default `#9cc7ec`) */\n  skyColor?: string;\n  /** (default `#e8f1f8`) */\n  horizonColor?: string;\n  /** (default `#f2f5f8`) */\n  fogColor?: string;\n  /** Blend from the horizon to the sky color, share of the field of view above the horizon, 0-1 (default 0.6) */\n  skyHorizonBlend?: number;\n  /** Blend from the horizon to the fog color below the horizon, 0-1 (default 0.7) */\n  horizonFogBlend?: number;\n  /** Share of the distance to the far plane over which the ground fades into the fog, 0-1 (default 0.4) */\n  fogGroundBlend?: number;\n}\n\n/** What can be seen from a point (`GeoMap.setViewshed`); with several observers, the colors, the opacity and the\n * cone's color are the first one's */\nexport interface ViewshedOptions {\n  /** The observer */\n  position: LonLat;\n  /** Metres above the ground (default 1.7, eye level) */\n  height?: number;\n  /** Metres around the observer that are tinted (default 1000) */\n  range?: number;\n  /** A CSS color for what is seen (default `#2f9e44`) */\n  visibleColor?: string;\n  /** A CSS color for what is hidden (default `#e03131`) */\n  hiddenColor?: string;\n  /** How strongly the colors tint the scene, multiplied into it so that its textures and shading stay, 0-1 (default\n   * 0.7) */\n  opacity?: number;\n  /** A CSS color for the cone drawn in 3D (one way only): its fan through the axis, at the eye's height and tilted\n   * with it, from the eye to the range; solid where nothing hides it, faint behind the scene; none by default */\n  coneColor?: string;\n  /** To look one way only (a camera, a lookout), degrees clockwise from north; all around without it */\n  direction?: number;\n  /** Degrees above the horizon the cone looks, negative below (default 0) */\n  tilt?: number;\n  /** Angle of view across, degrees (default 60) */\n  fov?: number;\n  /** Angle of view up and down, degrees (default 40) */\n  verticalFov?: number;\n}\n\n/** An eye at street level (`GeoMap.setFirstPerson`) */\nexport interface FirstPersonView {\n  /** Where it stands */\n  lonLat: LonLat;\n  /** Metres above the ground (default 1.7) */\n  height?: number;\n  /** Degrees clockwise from north it looks to */\n  bearing: number;\n  /** Degrees from straight down: 90 level (the default), 180 straight up */\n  pitch?: number;\n  /** Vertical field of view, degrees (default 75) */\n  fov?: number;\n}\n\n/** Layers shown on one side of a vertical line only (`GeoMap.setSwipe`) */\nexport interface SwipeOptions {\n  /** CSS pixels from the left of the map */\n  position: number;\n  layers: readonly Layer[];\n  /** The side they show on (default 'left') */\n  side?: 'left' | 'right';\n}\n\n/** Animation of a camera move */\nexport interface AnimationOptions {\n  /** Milliseconds */\n  duration?: number;\n  /** Progress over time, both 0 to 1 */\n  easing?: (t: number) => number;\n}\n\nexport interface FlyToOptions extends AnimationOptions {\n  /** How far the flight zooms out on its way, as MapLibre's `curve` (default 1.42) */\n  curve?: number;\n  /** Average speed in screens per second when `duration` is not given (default 1.2) */\n  speed?: number;\n}\n\n/**\n * Tile grid of a raster's URL. 'mercator': Web Mercator (XYZ, WMTS PM), the engine's own. 'equirectangular':\n * longitudes and latitudes (Plate Carrée, EPSG:4326-like), two 256 px tiles side by side at level 0, rows from the\n * north (NASA's Trek WMTS, WorldCRS84Quad). A `TileGrid`: the tile matrices of a WMTS in any CRS (Lambert-93…), or a\n * WMS asked for each tile's box in its CRS. The last two are reprojected into Web Mercator tiles by the map's workers\n * (in the page with `workers: false`).\n */\nexport type RasterGrid = 'mercator' | 'equirectangular' | TileGrid;\n\n/** What `RasterLayer.setStyle` changes */\nexport interface RasterStyle {\n  opacity: number;\n  /** 0 = greyscale, 1 = original colors */\n  saturation: number;\n}\n\nexport interface RasterOptions {\n  /** Tile URL with {z}, {x} and {y} (256 px tiles); unused with a `loader` */\n  url: string;\n  /** Tile grid of `url` (default 'mercator'); with 'equirectangular', `minZoom` and `maxZoom` are levels of that\n   * grid; with a `TileGrid`, they are map zooms, by default those its matrices span */\n  grid?: RasterGrid;\n  minZoom?: number;\n  maxZoom?: number;\n  opacity?: number;\n  /** 0 = greyscale, 1 = original colors */\n  saturation?: number;\n  /** Side of the tiles' textures, pixels (default 256): more for sharper tiles drawn by a `loader` */\n  size?: number;\n  /** Draws each tile instead of fetching `url`: an image of `size` × `size`, null for nothing there; a rejection is\n   * retried like a network error */\n  loader?: (z: number, x: number, y: number, signal: AbortSignal) => Promise<ImageBitmap | null>;\n  /** Credits of the tiles, HTML: shown by the attribution control while the layer is on the map */\n  attribution?: string;\n}\n\nexport interface NetworkStyle {\n  /** Line width, CSS pixels, or zoom stops `[[zoom, width], …]` (default 2) */\n  width: Size;\n  /** Values above are drawn as unreached (default 1800) */\n  max: number;\n  /** Darker line every `contour` value units, 0 for none (default 0) */\n  contour: number;\n  opacity: number;\n  /** Width of the halo drawn under the lines, CSS pixels or zoom stops, 0 for none (default 0): wide and faint, the\n   * reached streets add up into a heat map that fills the blocks */\n  halo: Size;\n  /** Opacity of the halo at the middle of a line, fading quadratically to its sides (default 0.11) */\n  haloOpacity: number;\n  /** Colors from 0 to `max`: `[[fraction of max, color], …]` (default green to red) */\n  ramp: Ramp | undefined;\n  /** Color of the parts beyond `max` or unreached (default `rgba(140, 140, 140, 0.25)`) */\n  unreachedColor: string;\n  /** Share of `max` over which the colors fade out before it, 0 to 1 (default 0) */\n  fade: number;\n}\n\nexport interface NetworkOptions extends Partial<NetworkStyle> {\n  /** Node coordinates in degrees: lon0, lat0, lon1, lat1… */\n  nodes: Float64Array;\n  /** Edges as node index pairs: a0, b0, a1, b1… */\n  edges: Uint32Array;\n  /** Line of each edge, from A to B: the points of edge e are `points[start[e] .. start[e + 1]]` (lon, lat pairs,\n   * counted in points); with fewer than two points an edge is straight. Default: all straight. */\n  lines?: { start: Uint32Array; points: Float64Array };\n  /** Per edge, the cost of travelling it from A to B then from B to A, in value units (Infinity: closed that way;\n   * closed both ways: not drawn). A point along an edge then takes the quickest way there, min(value(A) + cost from\n   * A, value(B) + cost from B), as a travel time does. Without costs, values are interpolated along the edges. */\n  costs?: Float32Array;\n  /** Width factor of each edge (default 1): rail lines wider than streets */\n  edgeWidths?: Float32Array;\n}\n\nexport interface Tiles3dStyle {\n  /** Screen-space error (CSS pixels) above which a tile is refined: 16 by default, lower is finer and heavier */\n  maxScreenSpaceError: number;\n  opacity: number;\n  /** Size of the points of point cloud tiles (`.pnts`, glTF points), CSS pixels: 2 by default */\n  pointSize?: number;\n  /** A CSS color multiplying the textures of the meshes, the color of the untextured ones (buildings without\n   * textures are light grey without it); none by default */\n  color?: string;\n}\n\nexport interface Tiles3dOptions extends Partial<Tiles3dStyle> {\n  /** URL of a `tileset.json` (3D Tiles 1.0 b3dm and pnts, 1.1 glb meshes and points, external tilesets) */\n  url: string;\n  /** Its heights are altitudes above the geoid (NGF-IGN69), as the IGN's Bâtiments 3D, rather than above the\n   * ellipsoid (3D Tiles as specified): each tile raised by the RAF20 geoid, onto the IGN relief (default false) */\n  geoid?: boolean;\n}\n\nexport interface MapPointerEvent {\n  point: Point;\n  /** Undefined above the horizon */\n  lonLat: LonLat | undefined;\n}\n\n/** What 'hoverfeature' found under the pointer */\nexport interface MapHoverFeatureEvent extends MapPointerEvent {\n  /** The feature under the pointer (see `GeoMap.pickFeature`), undefined if none */\n  hit: FeatureHit | undefined;\n}\n\n/** A picked feature: its layer handle, its index there and, for line, circle, fill, extrusion, point cloud and 3D\n * Tiles layers, the feature itself (a building of 3D Tiles with its properties) */\nexport interface FeatureHit {\n  layer: Layer;\n  index: number;\n  feature: Feature | undefined;\n}\n\nexport interface MapEvents {\n  /** The camera started moving (a gesture, an animation or `setCamera`) */\n  movestart: Camera;\n  /** The camera moved */\n  move: Camera;\n  /** The camera stopped: no gesture held, no animation running */\n  moveend: Camera;\n  /** The map changed size (CSS pixels) */\n  resize: { width: number; height: number };\n  /** The pointer moved over the map (at most once per frame, not while dragging) */\n  hover: MapPointerEvent;\n  /** What is under the pointer, picked without stalling the GPU: a frame or two after 'hover', only while listened to\n   * (radius and layers in `GeoMap.hoverPicking`) */\n  hoverfeature: MapHoverFeatureEvent;\n  /** Click without drag */\n  click: MapPointerEvent;\n  /** A frame was drawn; duration of the engine call in milliseconds */\n  render: { ms: number };\n  /** Everything in view is loaded and drawn, nothing moves: the end of a load, once after each change (as MapLibre's\n   * `idle`). Tiles requested by the first frame count, so it never fires before they arrive. */\n  idle: Record<string, never>;\n  /** The pointer left the canvas (a mouse going out of the map, or onto a control or marker) */\n  leave: Record<string, never>;\n}\n\n/** What a layer handle needs from its map */\nexport interface LayerHost {\n  readonly engine: Engine;\n  requestRender(): void;\n  /** Forgets a removed layer */\n  detach(layer: object): void;\n  /** Moves a layer under `before`, or on top */\n  moveLayer(layer: object, before: object | undefined): void;\n  /** A layer created again in the engine (new id): put at the place of its old id, which is removed */\n  replaceLayer(layer: object, old: number): void;\n}\n"]}

package/dist/vectortiles.js

@@ -4,6 +4,7 @@ import { IGN_ATTRIBUTION } from "./geoplateforme.js";
 import { loadSprites, readPixels } from "./icons.js";
 import { Lru } from "./lru.js";
 import { pmtiles, pmtilesUrl } from "./pmtiles.js";
+import { headerRules, onHeaderRules, withHeaders } from "./requests.js";
 import { SOURCE_CACHE } from "./resample.js";
 import { labelFont, } from "./vectorstyle.js";
 /** OpenFreeMap's styles: OpenStreetMap data in the OpenMapTiles schema, worldwide, free and without a key */
@@ -53,7 +54,7 @@ export function size(value, fallback = 16) {
 }
 /** Fetches a JSON document (a style, a TileJSON) */
 async function json(url) {
-    const response = await fetch(url);
+    const response = await fetch(url, withHeaders(url));
     if (!response.ok)
         throw new Error(`${url}: ${response.status}`);
     return (await response.json());
@@ -123,6 +124,8 @@ export class BasemapWorkers {
     next = 1;
     namespaces = 0;
     terminated = false;
+    /** Stops following the page's request headers */
+    unfollow;
     constructor(count, url, create = (u) => new Worker(u, { type: 'module' })) {
         this.count = count;
         this.url = url;
@@ -144,8 +147,15 @@ export class BasemapWorkers {
                 this.fail(worker, `the vector basemap worker ${url} failed${event.message ? `: ${event.message}` : ''}`);
             };
             worker.onmessageerror = () => this.fail(worker, `the vector basemap worker ${url} sent an unreadable message`);
+            const rules = headerRules();
+            if (rules.length > 0)
+                worker.postMessage({ type: 'headers', rules });
             return worker;
         });
+        this.unfollow = onHeaderRules((rules) => {
+            for (const w of this.workers)
+                w.postMessage({ type: 'headers', rules });
+        });
     }
     /** A prefix for the renderer keys of one `VectorTiles` */
     namespace() {
@@ -239,6 +249,7 @@ export class BasemapWorkers {
         if (this.terminated)
             return;
         this.terminated = true;
+        this.unfollow();
         for (const w of this.workers)
             w.terminate();
         const pending = [...this.pending.values()];