chiitiler 1.12.7 → 1.14.0

package/README.md

@@ -95,6 +95,7 @@ you can pass server options via environment variables
 | CHIITILER_PORT                     | 3000     | port number                                    |
 | CHIITILER_PROCESSES                | 1        | num of chiitiler processes. 0 means all-CPUs   |
 | CHIITILER_DEBUG                    | false    | debug mode                                     |
+| CHIITILER_STREAM_MODE              | false    | stream mode                                    |
 | CHIITILER_CACHE_METHOD             | none     | cache method, `none`, `memory`, `file` or `s3` |
 | CHIITILER_CACHE_TTL_SEC            | 3600     | cache ttl, effect to `memory` and `file`       |
 | CHIITILER_MEMORYCACHE_MAXITEMCOUNT | 1000     | max items for memorycache                      |
@@ -190,6 +191,13 @@ node dist/main.js tile-server -c s3 -s3b chiitiler -s3r ap-northeast-1
         "s3://tiles/{z}/{x}/{y}.pbf"
       ],
       "maxzoom": 6
+    },
+    "cog": {
+      "type": "raster",
+      "tiles": [
+        "cog://https://sentinel-cogs.s3.us-west-2.amazonaws.com/sentinel-s2-l2a-cogs/54/T/WN/2024/9/S2A_54TWN_20240908_0_L2A/TCI.tif/{z}/{x}/{y}"
+      ],
+      "tileSize": 256
     }
   },
   "layers": [
@@ -232,6 +240,14 @@ node dist/main.js tile-server -c s3 -s3b chiitiler -s3r ap-northeast-1
         "circle-radius": 3,
         "circle-color": "green"
       }
+    },
+    {
+      "id": "cog",
+      "source": "cog",
+      "type": "raster",
+      "paint": {
+        "raster-opacity": 0.5
+      }
     }
   ]
 }

package/dist/cache/index.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" resolution-mode="require"/>
 import { memoryCache } from './memory.js';
 import { s3Cache } from './s3.js';
 import { fileCache } from './file.js';

package/dist/cli.js

@@ -65,6 +65,17 @@ function parseDebug(debug) {
     // undefined or invalid
     return false;
 }
+function parseStream(stream) {
+    // command-line option
+    if (stream)
+        return true;
+    // command-line is not specified or false -> try to read from env
+    const streamEnv = process.env.CHIITILER_STREAM_MODE;
+    if (streamEnv !== undefined)
+        return streamEnv === 'true';
+    // undefined or invalid
+    return false;
+}
 export function createProgram() {
     const program = new Command();
     program
@@ -78,6 +89,7 @@ export function createProgram() {
         .option('-s3e --s3-endpoint <url>', 's3 endpoint url', '')
         .option('-3p --s3-force-path-style', 's3 force path style', '')
         .option('-p --port <port>', 'port number')
+        .option('-r --stream', 'stream mode')
         .option('-D --debug', 'debug mode')
         .action((options) => {
         const serverOptions = {
@@ -92,11 +104,14 @@ export function createProgram() {
             }),
             port: parsePort(options.port),
             debug: parseDebug(options.debug),
+            stream: parseStream(options.stream),
         };
         if (serverOptions.debug) {
             console.log(`running server: http://localhost:${serverOptions.port}`);
             console.log(`cache method: ${serverOptions.cache.name}`);
             console.log(`debug page: http://localhost:${serverOptions.port}/debug`);
+            console.log(`editor page: http://localhost:${serverOptions.port}/editor`);
+            console.log('stream mode:', serverOptions.stream ? 'enabled' : 'disabled');
         }
         const { start } = initServer(serverOptions);
         start();

package/dist/index.d.ts

@@ -1,2 +1,6 @@
-export { getRenderedBboxBuffer, getRenderedTileBuffer, } from './render/index.js';
+import { getRenderedBbox, getRenderedTile, GetRenderedBboxOptions, GetRenderedTileOptions } from './render/index.js';
+export declare function getRenderedBboxBuffer(options: GetRenderedBboxOptions): Promise<Buffer>;
+export { getRenderedBbox as getRenderedBboxStream };
+export declare function getRenderedTileBuffer(options: GetRenderedTileOptions): Promise<Buffer>;
+export { getRenderedTile as getRenderedTileStream };
 export * as ChiitilerCache from './cache/index.js';

package/dist/index.js

@@ -1,2 +1,12 @@
-export { getRenderedBboxBuffer, getRenderedTileBuffer, } from './render/index.js';
+import { getRenderedBbox, getRenderedTile, } from './render/index.js';
+export async function getRenderedBboxBuffer(options) {
+    const sharp = await getRenderedBbox(options);
+    return sharp.toBuffer();
+}
+export { getRenderedBbox as getRenderedBboxStream };
+export async function getRenderedTileBuffer(options) {
+    const sharp = await getRenderedTile(options);
+    return sharp.toBuffer();
+}
+export { getRenderedTile as getRenderedTileStream };
 export * as ChiitilerCache from './cache/index.js';

package/dist/render/index.d.ts

@@ -1,7 +1,7 @@
-/// <reference types="node" resolution-mode="require"/>
+import sharp from 'sharp';
 import type { StyleSpecification } from '@maplibre/maplibre-gl-style-spec';
 import type { Cache } from '../cache/index.js';
-type RenderTilePipelineOptions = {
+type GetRenderedTileOptions = {
     stylejson: string | StyleSpecification;
     z: number;
     x: number;
@@ -13,13 +13,14 @@ type RenderTilePipelineOptions = {
     quality: number;
 };
 type SupportedFormat = 'png' | 'jpeg' | 'jpg' | 'webp';
-declare function getRenderedTileBuffer({ stylejson, z, x, y, tileSize, cache, margin, ext, quality, }: RenderTilePipelineOptions): Promise<Buffer>;
-declare function getRenderedBboxBuffer({ stylejson, bbox, size, cache, ext, quality, }: {
+declare function getRenderedTile({ stylejson, z, x, y, tileSize, cache, margin, ext, quality, }: GetRenderedTileOptions): Promise<sharp.Sharp>;
+type GetRenderedBboxOptions = {
     stylejson: string | StyleSpecification;
     bbox: [number, number, number, number];
     size: number;
     cache: Cache;
     ext: SupportedFormat;
     quality: number;
-}): Promise<Buffer>;
-export { getRenderedTileBuffer, getRenderedBboxBuffer, type SupportedFormat };
+};
+declare function getRenderedBbox({ stylejson, bbox, size, cache, ext, quality, }: GetRenderedBboxOptions): Promise<sharp.Sharp>;
+export { getRenderedTile, getRenderedBbox, type GetRenderedBboxOptions, type GetRenderedTileOptions, type SupportedFormat, };

package/dist/render/index.js

@@ -32,7 +32,7 @@ async function loadStyle(stylejson, cache) {
     }
     return style;
 }
-async function getRenderedTileBuffer({ stylejson, z, x, y, tileSize, cache, margin, ext, quality, }) {
+async function getRenderedTile({ stylejson, z, x, y, tileSize, cache, margin, ext, quality, }) {
     const style = await loadStyle(stylejson, cache);
     let pixels;
     pixels = await renderTile(style, z, x, y, {
@@ -83,20 +83,15 @@ async function getRenderedTileBuffer({ stylejson, z, x, y, tileSize, cache, marg
         })
             .resize(tileSize, tileSize);
     }
-    let buf;
     switch (ext) {
         case 'png':
-            buf = await _sharp.png().toBuffer();
-            break;
+            return _sharp.png();
         case 'jpeg':
         case 'jpg':
-            buf = await _sharp.jpeg({ quality }).toBuffer();
-            break;
+            return _sharp.jpeg({ quality });
         case 'webp':
-            buf = await _sharp.webp({ quality, effort: 0 }).toBuffer();
-            break;
+            return _sharp.webp({ quality, effort: 0 });
     }
-    return buf;
 }
 const calcRenderingParams = (bbox, size) => {
     // reference: https://github.com/maptiler/tileserver-gl/blob/cc4b8f7954069fd0e1db731ff07f5349f7b9c8cd/src/serve_rendered.js#L346
@@ -117,7 +112,7 @@ const calcRenderingParams = (bbox, size) => {
     const center = mercator.ll(mercCenter, 25); // latlon
     return { zoom, width, height, center };
 };
-async function getRenderedBboxBuffer({ stylejson, bbox, size, cache, ext, quality, }) {
+async function getRenderedBbox({ stylejson, bbox, size, cache, ext, quality, }) {
     const style = await loadStyle(stylejson, cache);
     const { zoom, width, height, center } = calcRenderingParams(bbox, size);
     const pixels = await render(style, {
@@ -135,12 +130,12 @@ async function getRenderedBboxBuffer({ stylejson, bbox, size, cache, ext, qualit
     });
     switch (ext) {
         case 'png':
-            return await _sharp.png().toBuffer();
+            return _sharp.png();
         case 'jpeg':
         case 'jpg':
-            return await _sharp.jpeg({ quality }).toBuffer();
+            return _sharp.jpeg({ quality });
         case 'webp':
-            return await _sharp.webp({ quality, effort: 0 }).toBuffer();
+            return _sharp.webp({ quality, effort: 0 });
     }
 }
-export { getRenderedTileBuffer, getRenderedBboxBuffer };
+export { getRenderedTile, getRenderedBbox, };

package/dist/render/pool.js

@@ -11,6 +11,8 @@ const TRANSPARENT_BUFFER = {
     jpeg: Buffer.from('/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAABAAEDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwD3+iiigD//2Q=='),
 };
 function handleFileExt(uri) {
+    if (uri.startsWith('cog://'))
+        return 'png'; // cog:// always returns as png
     // extract extension only, take into account query string or hash
     const basename = path.basename(uri).split(/[?#]/)[0];
     const ext = basename.split('.').pop();

package/dist/s3.d.ts

@@ -1,7 +1,7 @@
 import { S3Client } from '@aws-sdk/client-s3';
 declare const getS3Client: ({ region, endpoint, forcePathStyle, }: {
     region: string;
-    endpoint?: string | undefined;
-    forcePathStyle?: boolean | undefined;
+    endpoint?: string;
+    forcePathStyle?: boolean;
 }) => S3Client;
 export { getS3Client };

package/dist/server/index.d.ts

@@ -4,6 +4,7 @@ type InitServerOptions = {
     cache: Cache;
     port: number;
     debug: boolean;
+    stream: boolean;
 };
 type InitializedServer = {
     app: Hono;

package/dist/server/index.js

@@ -1,8 +1,9 @@
 import { Hono } from 'hono/quick';
+import { stream } from 'hono/streaming';
 import { serve } from '@hono/node-server';
 import { validateStyleMin, } from '@maplibre/maplibre-gl-style-spec';
 import { getDebugPage, getEditorgPage } from './debug.js';
-import { getRenderedTileBuffer, getRenderedBboxBuffer, } from '../render/index.js';
+import { getRenderedTile, getRenderedBbox, } from '../render/index.js';
 function isValidStylejson(stylejson) {
     return validateStyleMin(stylejson).length === 0;
 }
@@ -35,9 +36,9 @@ function initServer(options) {
         const tileSize = Number(c.req.query('tileSize') ?? 512);
         const quality = Number(c.req.query('quality') ?? 100);
         const margin = Number(c.req.query('margin') ?? 0);
-        let buf;
+        c.header('Content-Type', `image/${ext}`);
         try {
-            buf = await getRenderedTileBuffer({
+            const sharp = await getRenderedTile({
                 stylejson: url,
                 z,
                 x,
@@ -48,13 +49,23 @@ function initServer(options) {
                 ext,
                 quality,
             });
+            if (options.stream) {
+                // stream mode
+                return stream(c, async (stream) => {
+                    for await (const chunk of sharp) {
+                        stream.write(chunk);
+                    }
+                });
+            }
+            else {
+                const buf = await sharp.toBuffer();
+                return c.body(buf);
+            }
         }
         catch (e) {
             console.error(`render error: ${e}`);
             return c.body('failed to render tile', 400);
         }
-        c.header('Content-Type', `image/${ext}`);
-        return c.body(buf);
     })
         .post('/:z/:x/:y_ext', async (c) => {
         // body
@@ -74,9 +85,9 @@ function initServer(options) {
         const tileSize = Number(c.req.query('tileSize') ?? 512);
         const quality = Number(c.req.query('quality') ?? 100);
         const margin = Number(c.req.query('margin') ?? 0);
-        let buf;
+        c.header('Content-Type', `image/${ext}`);
         try {
-            buf = await getRenderedTileBuffer({
+            const sharp = await getRenderedTile({
                 stylejson: style,
                 z,
                 x,
@@ -87,13 +98,23 @@ function initServer(options) {
                 ext,
                 quality,
             });
+            if (options.stream) {
+                // stream mode
+                return stream(c, async (stream) => {
+                    for await (const chunk of sharp) {
+                        stream.write(chunk);
+                    }
+                });
+            }
+            else {
+                const buf = await sharp.toBuffer();
+                return c.body(buf);
+            }
         }
         catch (e) {
             console.error(`render error: ${e}`);
             return c.body('failed to render tile', 400);
         }
-        c.header('Content-Type', `image/${ext}`);
-        return c.body(buf);
     });
     const clip = new Hono()
         .get('/:filename_ext', async (c) => {
@@ -115,8 +136,9 @@ function initServer(options) {
             return c.body('url is required', 400);
         const quality = Number(c.req.query('quality') ?? 100);
         const size = Number(c.req.query('size') ?? 1024);
+        c.header('Content-Type', `image/${ext}`);
         try {
-            const buf = await getRenderedBboxBuffer({
+            const sharp = await getRenderedBbox({
                 stylejson: url,
                 bbox: [minx, miny, maxx, maxy],
                 size,
@@ -124,12 +146,22 @@ function initServer(options) {
                 ext,
                 quality,
             });
-            c.header('Content-Type', `image/${ext}`);
-            return c.body(buf);
+            if (options.stream) {
+                // stream mode
+                return stream(c, async (stream) => {
+                    for await (const chunk of sharp) {
+                        stream.write(chunk);
+                    }
+                });
+            }
+            else {
+                const buf = await sharp.toBuffer();
+                return c.body(buf);
+            }
         }
         catch (e) {
             console.error(`render error: ${e}`);
-            return c.body('failed to render bbox', 400);
+            return c.body('failed to render tile', 400);
         }
     })
         .post('/:filename_ext', async (c) => {
@@ -152,8 +184,9 @@ function initServer(options) {
             return c.body('invalid bbox', 400);
         const quality = Number(c.req.query('quality') ?? 100);
         const size = Number(c.req.query('size') ?? 1024);
+        c.header('Content-Type', `image/${ext}`);
         try {
-            const buf = await getRenderedBboxBuffer({
+            const sharp = await getRenderedBbox({
                 stylejson: style,
                 bbox: [minx, miny, maxx, maxy],
                 size,
@@ -161,12 +194,22 @@ function initServer(options) {
                 ext,
                 quality,
             });
-            c.header('Content-Type', `image/${ext}`);
-            return c.body(buf);
+            if (options.stream) {
+                // stream mode
+                return stream(c, async (stream) => {
+                    for await (const chunk of sharp) {
+                        stream.write(chunk);
+                    }
+                });
+            }
+            else {
+                const buf = await sharp.toBuffer();
+                return c.body(buf);
+            }
         }
         catch (e) {
             console.error(`render error: ${e}`);
-            return c.body('failed to render bbox', 400);
+            return c.body('failed to render tile', 400);
         }
     });
     const hono = new Hono();

package/dist/source/cog.d.ts

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

package/dist/source/cog.js

@@ -0,0 +1,19 @@
+/// <reference lib="dom" />
+// for using native fetch in TypeScript
+import { renderTile } from 'higuruma';
+async function getCogSource(uri) {
+    const cogPath = uri.replace('cog://', '').replace(/\/\d+\/\d+\/\d+$/, '');
+    const [z, x, y] = uri.replace(`cog://${cogPath}/`, '').split('/');
+    try {
+        const tile = await renderTile(cogPath, Number(z), Number(x), Number(y));
+        const buf = Buffer.from(tile);
+        if (buf.byteLength === 129)
+            return null; // empty tile
+        return buf;
+    }
+    catch (e) {
+        console.error(`[ERROR] ${e}`);
+        return null;
+    }
+}
+export { getCogSource };

package/dist/source/fs.d.ts

@@ -1,3 +1,2 @@
-/// <reference types="node" resolution-mode="require"/>
 declare function getFilesystemSource(uri: string): Promise<Buffer | null>;
 export { getFilesystemSource };

package/dist/source/http.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" resolution-mode="require"/>
-/// <reference lib="dom" />
 import { type Cache } from '../cache/index.js';
 declare function getHttpSource(uri: string, cache?: Cache): Promise<Buffer | null>;
 export { getHttpSource };

package/dist/source/index.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" resolution-mode="require"/>
 import { Cache } from '../cache/index.js';
 /**
  * retrieve sources from the uri

package/dist/source/index.js

@@ -3,6 +3,7 @@ import { getHttpSource } from './http.js';
 import { getPmtilesSoruce } from './pmtiles.js';
 import { getMbtilesSource } from './mbtiles.js';
 import { getS3Source } from './s3.js';
+import { getCogSource } from './cog.js';
 import { noneCache } from '../cache/index.js';
 /**
  * retrieve sources from the uri
@@ -22,6 +23,10 @@ async function getSource(uri, cache = noneCache()) {
         data = await getMbtilesSource(uri);
     else if (uri.startsWith('pmtiles://'))
         data = await getPmtilesSoruce(uri, cache);
+    else if (uri.startsWith('cog://'))
+        data = await getCogSource(uri);
+    else
+        return null;
     return data;
 }
 export { getSource };

package/dist/source/mbtiles.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" resolution-mode="require"/>
 /**
  * uri = mbtiles://path/to/file.mbtiles/{z}/{x}/{y}
  */

package/dist/source/pmtiles.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" resolution-mode="require"/>
 import { type Cache } from '../cache/index.js';
 /**
  * uri = pmtiles://path/to/file.pmtiles/{z}/{x}/{y}

package/dist/source/s3.d.ts

@@ -1,3 +1,2 @@
-/// <reference types="node" resolution-mode="require"/>
 declare function getS3Source(uri: string): Promise<Buffer | null>;
 export { getS3Source };

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "chiitiler",
-  "version": "1.12.7",
+  "version": "1.14.0",
   "description": "Tiny map rendering server for MapLibre Style Spec",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -24,9 +24,7 @@
   "devDependencies": {
     "@tsconfig/node20": "^20.1.4",
     "@types/better-sqlite3": "^7.6.10",
-    "@types/generic-pool": "^3.8.1",
     "@types/node": "^20.6.0",
-    "@types/object-hash": "^3.0.6",
     "@vitest/coverage-v8": "^1.6.0",
     "image-size": "^1.1.1",
     "maplibre-gl": "^3.3.1",
@@ -45,6 +43,7 @@
     "better-sqlite3": "^9.6.0",
     "commander": "^11.0.0",
     "file-system-cache": "^2.4.4",
+    "higuruma": "^0.1.6",
     "hono": "^4.5.4",
     "lightning-pool": "^4.2.2",
     "lru-cache": "^11.0.0",