chiitiler 1.22.0 → 1.22.1

package/README.md

@@ -107,7 +107,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 +119,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/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.1",
   "description": "Tiny map rendering server for MapLibre Style Spec",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",