chiitiler 1.22.0 → 1.22.3

package/README.md

@@ -60,6 +60,7 @@ You're done. That same endpoint works as an XYZ tile source for Leaflet, MapLibr
 - **[PLATEAU VIEW](https://plateauview.mlit.go.jp/)** — Cesium.js imagery via `/tiles`
 - **[qgis-amazonlocationservice-plugin](https://github.com/dayjournal/qgis-amazonlocationservice-plugin)** — QGIS integration
 - **[Allmaps Latest](https://bsky.app/profile/latest.allmaps.org)** — Bluesky bot
+- **[Kumoy](https://www.kumoy.io/)** - used for thumbnail image of designed maps
 
 ## HTTP API
 
@@ -107,7 +108,7 @@ const png = await getRenderedTileBuffer({
 
 Available renderers: `getRenderedTileBuffer`, `getRenderedClipBuffer`, `getRenderedCameraBuffer`, and their `*Stream` variants (`Sharp` instances for further piping).
 
-Outbound HTTP requests send a `User-Agent` identifying chiitiler by default; override it with `setUserAgent('my-app/1.0')` or the `CHIITILER_USER_AGENT` environment variable.
+chiitiler doesn't override the `User-Agent` on outbound HTTP requests by default, so the runtime's default is used (Node sends `node`). Some tile providers (e.g. OpenStreetMap) require an identifying User-Agent — set one with `setUserAgent('my-app/1.0')` or the `CHIITILER_USER_AGENT` environment variable.
 
 ## Configuration
 
@@ -119,7 +120,7 @@ All options can be set via CLI flag or environment variable.
 | --- | --- | --- |
 | `--port <n>` | `CHIITILER_PORT` | `3000` |
 | `--debug` | `CHIITILER_DEBUG` | `false` |
-| `--user-agent <ua>` | `CHIITILER_USER_AGENT` | `chiitiler (+https://github.com/Kanahiro/chiitiler)` |
+| `--user-agent <ua>` | `CHIITILER_USER_AGENT` | (none) |
 | — | `CHIITILER_PROCESSES` | `1` (set `0` for all CPUs) |
 
 ### Cache

package/dist/render/index.d.ts

@@ -1,4 +1,4 @@
-import sharp from 'sharp';
+import { type Sharp } from 'sharp';
 import type { StyleSpecification } from '@maplibre/maplibre-gl-style-spec';
 import type { Cache } from '../cache/index.js';
 type GetRenderedTileOptions = {
@@ -13,7 +13,7 @@ type GetRenderedTileOptions = {
     quality: number;
 };
 type SupportedFormat = 'png' | 'jpeg' | 'jpg' | 'webp';
-declare function getRenderedTile({ stylejson, z, x, y, tileSize, cache, margin, ext, quality, }: GetRenderedTileOptions): Promise<sharp.Sharp>;
+declare function getRenderedTile({ stylejson, z, x, y, tileSize, cache, margin, ext, quality, }: GetRenderedTileOptions): Promise<Sharp>;
 type GetRenderedClipOptions = {
     stylejson: string | StyleSpecification;
     bbox: [number, number, number, number];
@@ -22,7 +22,7 @@ type GetRenderedClipOptions = {
     ext: SupportedFormat;
     quality: number;
 };
-declare function getRenderedClip({ stylejson, bbox, size, cache, ext, quality, }: GetRenderedClipOptions): Promise<sharp.Sharp>;
+declare function getRenderedClip({ stylejson, bbox, size, cache, ext, quality, }: GetRenderedClipOptions): Promise<Sharp>;
 type GetRenderedCameraOptions = {
     stylejson: string | StyleSpecification;
     cache: Cache;
@@ -35,5 +35,5 @@ type GetRenderedCameraOptions = {
     height: number;
     width: number;
 };
-declare function getRenderedCamera(options: GetRenderedCameraOptions): Promise<sharp.Sharp>;
+declare function getRenderedCamera(options: GetRenderedCameraOptions): Promise<Sharp>;
 export { getRenderedTile, getRenderedClip, getRenderedCamera, type GetRenderedClipOptions, type GetRenderedTileOptions, type GetRenderedCameraOptions, type SupportedFormat, };

package/dist/source/fs.d.ts

@@ -1,2 +1,2 @@
-declare function getFilesystemSource(uri: string): Promise<Buffer<ArrayBufferLike> | null>;
+declare function getFilesystemSource(uri: string): Promise<Buffer | null>;
 export { getFilesystemSource };

package/dist/source/fs.js

@@ -1,15 +1,25 @@
-import fs from 'fs';
-function getFilesystemSource(uri) {
-    return new Promise((resolve, _) => {
-        fs.readFile(uri.replace('file://', ''), (err, data) => {
-            if (err) {
-                console.error(`[ERROR]: ${err}`);
-                resolve(null);
-            }
-            else {
-                resolve(data);
-            }
-        });
-    });
+import fs from 'node:fs/promises';
+async function getFilesystemSource(uri) {
+    const path = uri.replace('file://', '');
+    const data = await fs.readFile(path).catch(() => null);
+    if (data !== null)
+        return data;
+    // maplibre-gl-native percent-encodes {fontstack} in glyphs URLs
+    // (e.g. "Noto Sans Regular" -> "Noto%20Sans%20Regular"),
+    // so retry with the percent-decoded path
+    let decodedPath;
+    try {
+        decodedPath = decodeURIComponent(path);
+    }
+    catch {
+        decodedPath = path;
+    }
+    if (decodedPath !== path) {
+        const decodedData = await fs.readFile(decodedPath).catch(() => null);
+        if (decodedData !== null)
+            return decodedData;
+    }
+    console.error(`[ERROR]: failed to read ${path}`);
+    return null;
 }
 export { getFilesystemSource };

package/dist/source/http.js

@@ -9,8 +9,9 @@ async function getHttpSource(uri, cache = noneCache()) {
         return val; // hit
     // miss
     try {
+        const userAgent = getUserAgent();
         const res = await fetch(uri, {
-            headers: { 'User-Agent': getUserAgent() },
+            headers: userAgent ? { 'User-Agent': userAgent } : undefined,
         });
         if (!res.ok) {
             console.log(`failed to fetch ${uri}`);

package/dist/source/pmtiles.js

@@ -83,7 +83,11 @@ async function getPmtilesSource(uri, cache = noneCache()) {
         if (val !== undefined)
             return val; // hit
         if (pmtiles === undefined) {
-            const fetchSource = new FetchSource(pmtilesUri, new Headers({ 'User-Agent': getUserAgent() }));
+            const userAgent = getUserAgent();
+            const headers = new Headers();
+            if (userAgent)
+                headers.set('User-Agent', userAgent);
+            const fetchSource = new FetchSource(pmtilesUri, headers);
             pmtiles = new PMTiles(fetchSource);
             pmtilesCache.set(pmtilesUri, pmtiles);
         }

package/dist/source/userAgent.d.ts

@@ -3,5 +3,9 @@
  * Takes precedence over the CHIITILER_USER_AGENT environment variable.
  */
 declare function setUserAgent(userAgent: string | undefined): void;
-declare function getUserAgent(): string;
+/**
+ * Returns the configured User-Agent, or undefined when none is set (in which
+ * case no User-Agent header should be added).
+ */
+declare function getUserAgent(): string | undefined;
 export { getUserAgent, setUserAgent };

package/dist/source/userAgent.js

@@ -1,7 +1,7 @@
 // User-Agent for all outbound HTTP requests (http(s):// and pmtiles://http(s)://).
-// Some tile providers (e.g. OpenStreetMap) reject requests without an
-// identifying User-Agent, so we always send one.
-const DEFAULT_USER_AGENT = 'chiitiler (+https://github.com/Kanahiro/chiitiler)';
+// By default we don't override the User-Agent at all (the runtime's default is
+// used). Set one explicitly via --user-agent, CHIITILER_USER_AGENT, or
+// setUserAgent() — e.g. some tile providers (OpenStreetMap) require one.
 let overrideUserAgent;
 /**
  * Override the User-Agent sent with outbound HTTP requests.
@@ -10,9 +10,11 @@ let overrideUserAgent;
 function setUserAgent(userAgent) {
     overrideUserAgent = userAgent;
 }
+/**
+ * Returns the configured User-Agent, or undefined when none is set (in which
+ * case no User-Agent header should be added).
+ */
 function getUserAgent() {
-    return (overrideUserAgent ??
-        process.env.CHIITILER_USER_AGENT ??
-        DEFAULT_USER_AGENT);
+    return overrideUserAgent ?? process.env.CHIITILER_USER_AGENT;
 }
 export { getUserAgent, setUserAgent };

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "chiitiler",
-  "version": "1.22.0",
+  "version": "1.22.3",
   "description": "Tiny map rendering server for MapLibre Style Spec",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -50,6 +50,6 @@
     "lru-cache": "^11.3.5",
     "maplibre-gl": "^5.23.0",
     "pmtiles": "^4.4.1",
-    "sharp": "^0.34.5"
+    "sharp": "^0.35.3"
   }
 }