chiitiler 1.23.5 → 1.23.7

package/README.md

@@ -62,6 +62,10 @@ You're done. That same endpoint works as an XYZ tile source for Leaflet, MapLibr
 - **[Allmaps Latest](https://bsky.app/profile/latest.allmaps.org)** — Bluesky bot
 - **[Kumoy](https://www.kumoy.io/)** - used for thumbnail image of designed maps
 
+## Presentations
+
+- [FOSS4G Hiroshima 2026 — Presentation slides](https://drive.google.com/file/d/122JW5gJbrxnUVCVsSlcQMb22StPTnZQV/view?usp=sharing)
+
 ## HTTP API
 
 | Method | Endpoint | Description |
@@ -108,6 +112,21 @@ const png = await getRenderedTileBuffer({
 
 Available renderers: `getRenderedTileBuffer`, `getRenderedClipBuffer`, `getRenderedCameraBuffer`, and their `*Stream` variants (`Sharp` instances for further piping).
 
+For library use, explicitly call `prewarm(cache)` once per rendering process
+during application startup, before accepting requests:
+
+```ts
+import { prewarm, ChiitilerCache } from 'chiitiler';
+
+const cache = ChiitilerCache.noneCache();
+await prewarm(cache);
+```
+
+The promise resolves after a minimal tile has been rendered and PNG-encoded.
+It rejects if warmup fails; the application decides whether to continue startup.
+Library imports do not automatically run prewarm, and `CHIITILER_PREWARM` only
+controls the CLI server. Style-specific tiles, glyphs, and sprites are not preloaded.
+
 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:
 
@@ -139,10 +158,10 @@ 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_PREWARM` | `true` |
 | — | `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.
+Prewarm is enabled by default: one tile is rendered at startup **before** the server starts listening, moving shared renderer initialization work into startup. Either `--no-prewarm` or `CHIITILER_PREWARM=false` disables it. Style-specific tiles, glyphs, and sprites are not preloaded.
 
 ### Cache
 
@@ -181,7 +200,7 @@ npm install
 npm run dev              # tsx watch mode
 npm run test:unit        # vitest
 npm run test:integration # end-to-end
-npm run test:benchmark   # see BENCHMARK.md
+npm run test:benchmark   # see bench/BENCHMARK.md
 npm run build            # bundle to build/main.cjs
 ```
 

package/dist/cli.js

@@ -73,8 +73,8 @@ function parsePort(port) {
     return 3000;
 }
 function parsePrewarm(prewarmFlag) {
-    // command-line option, then env
-    return prewarmFlag === true || process.env.CHIITILER_PREWARM === 'true';
+    // Commander defaults a negated option to true; either opt-out disables warmup.
+    return prewarmFlag !== false && process.env.CHIITILER_PREWARM !== 'false';
 }
 function parseDebug(debug) {
     // command-line option
@@ -106,7 +106,7 @@ 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('--no-prewarm', 'disable startup renderer warmup (enabled by default)')
         .option('-D, --debug', 'debug mode')
         .action(async (options) => {
         // env fallback (CHIITILER_USER_AGENT) is handled in userAgent.ts

package/dist/index.d.ts

@@ -7,6 +7,7 @@ export declare function getRenderedTileBuffer(options: GetRenderedTileOptions):
 export { getRenderedTile as getRenderedTileStream };
 export * as ChiitilerCache from './cache/index.js';
 export { setUserAgent } from './source/userAgent.js';
+export { prewarm } from './render/warmup.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/index.js

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

package/dist/render/warmup.d.ts

@@ -1,9 +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.
+ * Render and PNG-encode a minimal tile to warm shared renderer initialization.
+ * Await once per rendering process during application startup, before accepting
+ * requests. This does not preload style-specific tiles, glyphs, or sprites.
+ * Resolves after encoding finishes; rejects if rendering or encoding fails.
  */
 declare function prewarm(cache: Cache): Promise<void>;
 export { prewarm };

package/dist/render/warmup.js

@@ -13,10 +13,10 @@ const MINIMAL_STYLE = {
     ],
 };
 /**
- * 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.
+ * Render and PNG-encode a minimal tile to warm shared renderer initialization.
+ * Await once per rendering process during application startup, before accepting
+ * requests. This does not preload style-specific tiles, glyphs, or sprites.
+ * Resolves after encoding finishes; rejects if rendering or encoding fails.
  */
 async function prewarm(cache) {
     const sharp = await getRenderedTile({

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "chiitiler",
-  "version": "1.23.5",
+  "version": "1.23.7",
   "description": "Tiny map rendering server for MapLibre Style Spec",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -24,31 +24,31 @@
     "url": "https://github.com/Kanahiro/chiitiler"
   },
   "devDependencies": {
-    "@tsconfig/node24": "^24.0.4",
+    "@tsconfig/node24": "^24.0.5",
     "@types/autocannon": "^7.12.7",
-    "@types/node": "^25.6.0",
+    "@types/node": "^25.9.6",
     "@vitest/coverage-v8": "^4.1.4",
     "autocannon": "^8.0.0",
-    "esbuild": "^0.28.0",
+    "esbuild": "^0.28.2",
     "image-size": "^2.0.2",
-    "tsx": "^4.21.0",
+    "tsx": "^4.23.13",
     "typescript": "^6.0.3",
     "vitest": "^4.1.4"
   },
   "dependencies": {
-    "@aws-sdk/client-s3": "^3.1032.0",
-    "@google-cloud/storage": "^7.19.0",
-    "@hono/node-server": "^2.0.0",
+    "@aws-sdk/client-s3": "^3.1131.0",
+    "@google-cloud/storage": "^7.22.0",
+    "@hono/node-server": "^2.1.1",
     "@mapbox/tilebelt": "^2.0.3",
     "@maplibre/maplibre-gl-native": "^6.4.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",
-    "pmtiles": "^4.4.1",
-    "sharp": "^0.35.3"
+    "hono": "^4.13.7",
+    "lightning-pool": "^4.14.0",
+    "lru-cache": "^11.5.2",
+    "pmtiles": "^4.5.0",
+    "sharp": "^0.35.4"
   }
 }