@versatiles/png-renderer 2.3.0 → 2.4.0

package/dist/index.d.ts

@@ -3071,11 +3071,19 @@ interface FetchResponse {
     arrayBuffer(): Promise<ArrayBuffer>;
     json(): Promise<unknown>;
 }
+/**
+ * The part of `fetch`'s `RequestInit` the renderer passes. It sends request headers only
+ * to read part of a file: a `Range` header for a PMTiles archive.
+ */
+interface FetchRequestInit {
+    headers?: Record<string, string>;
+}
 /**
  * Loads a URL, like `fetch`: the renderer loads tiles, sprites, TileJSON documents and GeoJSON data through it. It is called
- * with the URL only, and should resolve to a `Response`.
+ * with the URL, and for part of a file with request headers as well, and should resolve to
+ * a `Response`.
  */
-type FetchFunction = (url: string) => Promise<FetchResponse>;
+type FetchFunction = (url: string, init?: FetchRequestInit) => Promise<FetchResponse>;
 
 /** Options for {@link SVGMapRenderer}: what stays the same for every view of the map. */
 interface SVGMapRendererOptions {
@@ -3086,7 +3094,9 @@ interface SVGMapRendererOptions {
      * (`url: '.../tiles.json'`), which is fetched once, like the sprite, with
      * {@link SVGMapRendererOptions.fetch}. As in MapLibre GL JS, `tiles`, `minzoom`,
      * `maxzoom` and the like come from the document unless the style sets them, and
-     * relative tile URLs are resolved against the document's URL. A GeoJSON source's `data`
+     * relative tile URLs are resolved against the document's URL. A PMTiles archive
+     * (`url: 'pmtiles://https://.../tiles.pmtiles'`) is read as with the `pmtiles` protocol in
+     * MapLibre GL JS, which needs no setup here. A GeoJSON source's `data`
      * may be a URL too. A source whose TileJSON or GeoJSON cannot be loaded is left out, and
      * the next render tries again.
      */
@@ -3133,6 +3143,9 @@ interface SVGMapRendererOptions {
      * Loads tiles, sprites, TileJSON documents and GeoJSON data, like `fetch`, which is the default. Pass your own to send
      * headers, go through a proxy, or keep tiles in a cache on disk.
      *
+     * It is called with the URL only, except to read part of a file, a PMTiles archive: then
+     * also with `{ headers: { Range: 'bytes=…' } }`, which it should pass on.
+     *
      * It must return a real `Response`, and its status matters: a 404 or 204 means the
      * server has no such tile, which is remembered (see {@link SVGMapRendererOptions.tileCacheSize}); any other
      * error status, or a rejected promise, counts as failed, and the next render tries
@@ -3242,7 +3255,7 @@ declare class SVGMapRenderer {
      */
     renderSVG(view?: ViewOptions): Promise<string>;
     /**
-     * Forgets the fetched tiles, sprite, TileJSON documents and GeoJSON data, so the next render fetches them again, e.g.
+     * Forgets the fetched tiles, sprite, TileJSON documents, PMTiles directories and GeoJSON data, so the next render fetches them again, e.g.
      * after they were updated on the server, or to free their memory.
      */
     clearCache(): void;
@@ -3505,4 +3518,4 @@ declare class PNGMapRenderer extends SVGMapRenderer {
 }
 
 export { PNGMapRenderer, SVGMapRenderer, renderToCanvas, renderToPNG, renderToSVG };
-export type { FetchFunction, FetchResponse, GlobalState, PNGMapRendererOptions, PNGViewOptions, RenderToPNGOptions, RenderToSVGOptions, SVGMapRendererOptions, ViewOptions };
+export type { FetchFunction, FetchRequestInit, FetchResponse, GlobalState, PNGMapRendererOptions, PNGViewOptions, RenderToPNGOptions, RenderToSVGOptions, SVGMapRendererOptions, ViewOptions };