chiitiler 1.21.2 → 1.22.0

package/README.md

@@ -107,6 +107,8 @@ 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.
+
 ## Configuration
 
 All options can be set via CLI flag or environment variable.
@@ -117,6 +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)` |
 | — | `CHIITILER_PROCESSES` | `1` (set `0` for all CPUs) |
 
 ### Cache

package/dist/cli.js

@@ -2,6 +2,7 @@ import process from 'node:process';
 import { Command } from 'commander';
 import { initServer } from './server/index.js';
 import * as caches from './cache/index.js';
+import { setUserAgent } from './source/userAgent.js';
 function parseCacheStrategy(method, options) {
     // command-line option
     if (method === 'memory')
@@ -99,8 +100,12 @@ export function createProgram() {
         .option('--gcs-cache-prefix <prefix>', 'gcs cache prefix', '')
         .option('--gcs-api-endpoint <api-endpoint>', 'gcs api endpoint', '')
         .option('-p, --port <port>', 'port number')
+        .option('--user-agent <user-agent>', 'User-Agent header for outbound HTTP requests')
         .option('-D, --debug', 'debug mode')
         .action((options) => {
+        // env fallback (CHIITILER_USER_AGENT) is handled in userAgent.ts
+        if (options.userAgent !== undefined)
+            setUserAgent(options.userAgent);
         const serverOptions = {
             cache: parseCacheStrategy(options.cache, {
                 cacheTtl: Number(options.cacheTtl),

package/dist/index.d.ts

@@ -6,3 +6,4 @@ export { getRenderedCamera as getRenderedCameraStream };
 export declare function getRenderedTileBuffer(options: GetRenderedTileOptions): Promise<Buffer>;
 export { getRenderedTile as getRenderedTileStream };
 export * as ChiitilerCache from './cache/index.js';
+export { setUserAgent } from './source/userAgent.js';

package/dist/index.js

@@ -15,3 +15,4 @@ export async function getRenderedTileBuffer(options) {
 }
 export { getRenderedTile as getRenderedTileStream };
 export * as ChiitilerCache from './cache/index.js';
+export { setUserAgent } from './source/userAgent.js';

package/dist/source/http.js

@@ -1,6 +1,7 @@
 /// <reference lib="dom" />
 // for using native fetch in TypeScript
 import { noneCache } from '../cache/index.js';
+import { getUserAgent } from './userAgent.js';
 async function getHttpSource(uri, cache = noneCache()) {
     // use cache only for http(s) sources
     const val = await cache.get(uri);
@@ -8,7 +9,9 @@ async function getHttpSource(uri, cache = noneCache()) {
         return val; // hit
     // miss
     try {
-        const res = await fetch(uri);
+        const res = await fetch(uri, {
+            headers: { 'User-Agent': getUserAgent() },
+        });
         if (!res.ok) {
             console.log(`failed to fetch ${uri}`);
             return null;

package/dist/source/pmtiles.js

@@ -1,9 +1,10 @@
 import * as fs from 'fs';
-import { PMTiles } from 'pmtiles';
+import { PMTiles, FetchSource } from 'pmtiles';
 import { GetObjectCommand, } from '@aws-sdk/client-s3';
 import { LRUCache } from 'lru-cache';
 import { getS3Client } from '../s3.js';
 import { noneCache } from '../cache/index.js';
+import { getUserAgent } from './userAgent.js';
 const pmtilesCache = new LRUCache({
     max: 50,
 });
@@ -82,7 +83,8 @@ async function getPmtilesSource(uri, cache = noneCache()) {
         if (val !== undefined)
             return val; // hit
         if (pmtiles === undefined) {
-            pmtiles = new PMTiles(pmtilesUri);
+            const fetchSource = new FetchSource(pmtilesUri, new Headers({ 'User-Agent': getUserAgent() }));
+            pmtiles = new PMTiles(fetchSource);
             pmtilesCache.set(pmtilesUri, pmtiles);
         }
     }

package/dist/source/userAgent.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Override the User-Agent sent with outbound HTTP requests.
+ * Takes precedence over the CHIITILER_USER_AGENT environment variable.
+ */
+declare function setUserAgent(userAgent: string | undefined): void;
+declare function getUserAgent(): string;
+export { getUserAgent, setUserAgent };

package/dist/source/userAgent.js

@@ -0,0 +1,18 @@
+// 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)';
+let overrideUserAgent;
+/**
+ * Override the User-Agent sent with outbound HTTP requests.
+ * Takes precedence over the CHIITILER_USER_AGENT environment variable.
+ */
+function setUserAgent(userAgent) {
+    overrideUserAgent = userAgent;
+}
+function getUserAgent() {
+    return (overrideUserAgent ??
+        process.env.CHIITILER_USER_AGENT ??
+        DEFAULT_USER_AGENT);
+}
+export { getUserAgent, setUserAgent };

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "chiitiler",
-  "version": "1.21.2",
+  "version": "1.22.0",
   "description": "Tiny map rendering server for MapLibre Style Spec",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",