chiitiler 1.23.2 → 1.23.4

package/README.md

@@ -108,6 +108,24 @@ const png = await getRenderedTileBuffer({
 
 Available renderers: `getRenderedTileBuffer`, `getRenderedClipBuffer`, `getRenderedCameraBuffer`, and their `*Stream` variants (`Sharp` instances for further piping).
 
+Types are re-exported as well, so you can annotate call sites without depending on
+`@maplibre/maplibre-gl-style-spec` resolution in your own tree:
+
+```ts
+import type {
+    StyleSpecification,
+    GetRenderedTileOptions,
+    GetRenderedClipOptions,
+    GetRenderedCameraOptions,
+    SupportedFormat,
+    Cache,
+} from 'chiitiler';
+```
+
+Prefer chiitiler's `StyleSpecification` over importing it from
+`@maplibre/maplibre-gl-style-spec` directly: if your tree resolves a different major of
+that package, the two structurally-different types are not assignable to each other.
+
 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
@@ -121,8 +139,11 @@ 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` | (none) |
+| `--prewarm` | `CHIITILER_PREWARM` | `false` |
 | — | `CHIITILER_PROCESSES` | `1` (set `0` for all CPUs) |
 
+With prewarm enabled, one tile is rendered at startup **before** the server starts listening, so renderer initialization (GL context, sharp/libvips, JIT) doesn't hit the first request. On AWS Lambda with Lambda Web Adapter, the readiness check keeps this inside the INIT phase, which runs with a full CPU boost.
+
 ### Cache
 
 | Flag | Env | Default |

package/dist/cli.js

@@ -3,6 +3,7 @@ import { Command } from 'commander';
 import { initServer } from './server/index.js';
 import * as caches from './cache/index.js';
 import { setUserAgent } from './source/userAgent.js';
+import { prewarm } from './render/warmup.js';
 function parseCacheStrategy(method, options) {
     // command-line option
     if (method === 'memory')
@@ -71,6 +72,10 @@ function parsePort(port) {
     // undefined or invalid
     return 3000;
 }
+function parsePrewarm(prewarmFlag) {
+    // command-line option, then env
+    return prewarmFlag === true || process.env.CHIITILER_PREWARM === 'true';
+}
 function parseDebug(debug) {
     // command-line option
     if (debug)
@@ -101,8 +106,9 @@ export function createProgram() {
         .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('--prewarm', 'render one tile at startup before listening, to warm up the renderer')
         .option('-D, --debug', 'debug mode')
-        .action((options) => {
+        .action(async (options) => {
         // env fallback (CHIITILER_USER_AGENT) is handled in userAgent.ts
         if (options.userAgent !== undefined)
             setUserAgent(options.userAgent);
@@ -130,6 +136,20 @@ export function createProgram() {
             console.log(`debug page: http://localhost:${serverOptions.port}/debug`);
             console.log(`editor page: http://localhost:${serverOptions.port}/editor`);
         }
+        // warm up BEFORE listening: Lambda Web Adapter polls the
+        // readiness check until the port opens, so work done here
+        // stays inside the INIT phase (full CPU boost)
+        if (parsePrewarm(options.prewarm)) {
+            const startedAt = Date.now();
+            try {
+                await prewarm(serverOptions.cache);
+                console.log(`prewarm done in ${Date.now() - startedAt}ms`);
+            }
+            catch (err) {
+                // 温まらないだけでサーバとしては動けるので起動は続行する
+                console.warn(`prewarm failed: ${err}`);
+            }
+        }
         const { start } = initServer(serverOptions);
         start();
     });

package/dist/index.d.ts

@@ -7,3 +7,6 @@ export declare function getRenderedTileBuffer(options: GetRenderedTileOptions):
 export { getRenderedTile as getRenderedTileStream };
 export * as ChiitilerCache from './cache/index.js';
 export { setUserAgent } from './source/userAgent.js';
+export type { GetRenderedClipOptions, GetRenderedTileOptions, GetRenderedCameraOptions, SupportedFormat, } from './render/index.js';
+export type { Cache } from './cache/index.js';
+export type { StyleSpecification } from '@maplibre/maplibre-gl-style-spec';

package/dist/render/warmup.d.ts

@@ -0,0 +1,9 @@
+import type { Cache } from '../cache/index.js';
+/**
+ * Render one z0 tile ahead of the first request so that renderer
+ * initialization happens at startup — on AWS Lambda (with Lambda Web
+ * Adapter's readiness check) this moves the work into the INIT phase,
+ * which runs with a full CPU boost.
+ */
+declare function prewarm(cache: Cache): Promise<void>;
+export { prewarm };

package/dist/render/warmup.js

@@ -0,0 +1,35 @@
+import { getRenderedTile } from './index.js';
+// スタイル固有のリソース(タイル/glyphs/sprite)は温まらないが、
+// EGL/GLコンテキスト・Xvfb接続・sharp(libvips)・JITの初期化は共通で効く。
+const MINIMAL_STYLE = {
+    version: 8,
+    sources: {},
+    layers: [
+        {
+            id: 'background',
+            type: 'background',
+            paint: { 'background-color': '#ffffff' },
+        },
+    ],
+};
+/**
+ * Render one z0 tile ahead of the first request so that renderer
+ * initialization happens at startup — on AWS Lambda (with Lambda Web
+ * Adapter's readiness check) this moves the work into the INIT phase,
+ * which runs with a full CPU boost.
+ */
+async function prewarm(cache) {
+    const sharp = await getRenderedTile({
+        stylejson: MINIMAL_STYLE,
+        z: 0,
+        x: 0,
+        y: 0,
+        tileSize: 512,
+        cache,
+        margin: 0,
+        ext: 'png',
+        quality: 100,
+    });
+    await sharp.toBuffer(); // force the actual encode
+}
+export { prewarm };

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "chiitiler",
-  "version": "1.23.2",
+  "version": "1.23.4",
   "description": "Tiny map rendering server for MapLibre Style Spec",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -41,14 +41,13 @@
     "@hono/node-server": "^2.0.0",
     "@mapbox/tilebelt": "^2.0.3",
     "@maplibre/maplibre-gl-native": "^6.4.1",
-    "@maplibre/maplibre-gl-style-spec": "^24.8.1",
+    "@maplibre/maplibre-gl-style-spec": "^26.4.2",
     "commander": "^14.0.3",
     "file-system-cache": "^2.4.7",
     "higuruma": "^0.1.6",
     "hono": "^4.12.14",
     "lightning-pool": "^4.12.0",
     "lru-cache": "^11.3.5",
-    "maplibre-gl": "^5.23.0",
     "pmtiles": "^4.4.1",
     "sharp": "^0.35.3"
   }