chiitiler 1.14.0 → 1.14.2

package/README.md

@@ -14,11 +14,17 @@ chii-tiler: "tiny" in Japanese is "chiisai", shorten into "chii"
 - In this type of server, there is a de-facto - [maptiler/tileserver-gl](https://github.com/maptiler/tileserver-gl), but this is too big for me.
 - I want a server accept style.json-url and respond raster tile, inspired by [developmentseed/titiler](https://github.com/developmentseed/titiler)
 
+## usecases
+
+- [MIERUNE/tiles](https://github.com/MIERUNE/tiles) - You can find example [here](https://mierune.github.io/tiles/color.html#11.62/43.064/141.3375)
+- [dayjournal/qgis-amazonlocationservice-plugin](https://github.com/dayjournal/qgis-amazonlocationservice-plugin) - used in Maps feature
+- [Allmaps Latest - Bluesky](https://bsky.app/profile/latest.allmaps.org)
+
 ## features
 
 ### /tiles
 
-chiitiler provides you with `/tiles` raster-tile endpoint. Once server launched, you can use like this:
+chiitiler provides you with an endpoint `/tiles`. Once server launched, you can use the endpoint like this:
 
 ```planetext
 http://localhost:3000/tiles/0/0/0.png?url=https://tile.openstreetmap.jp/styles/osm-bright/style.json
@@ -81,9 +87,6 @@ docker run -p 3000:3000 -d \
 -e CHIITILER_S3CACHE_BUCKET=bucketname \
 -e CHIITILER_S3_REGION=ap-northeast-1 \
 ghcr.io/kanahiro/chiitiler
-
-# you also can pass options
-docker run -p 8000:8000 ghcr.io/kanahiro/chiitiler tile-server -p 8000 -c s3 -s3b bucketname -s3r ap-northeast-1
 ```
 
 #### Environment Variables
@@ -105,56 +108,23 @@ you can pass server options via environment variables
 | CHIITILER_S3_ENDPOINT              |          | s3 endpoint for caching/fetching               |
 | CHIITILER_S3_FORCE_PATH_STYLE      | false    | force path style for s3, needed for minio      |
 
-### Local
-
-- Node.js v18 or v20
-
-```sh
-npm install
-npm run build
-node dist/main.js tile-server
-# running server: http://localhost:3000
-
-# develop
-npm run dev
-# running server: http://localhost:3000
-# debug page: http://localhost:3000/debug
-```
-
-#### options
-
-```sh
-node dist/main.js tile-server -p 8000 -c file -ctl 60 -fcd cachedir -D
-# -p: port number
-# -c: cache method
-# -ctl: cache ttl
-# -fcd: cache directory
-# -D: debug mode
-
-node dist/main.js tile-server -c memory -ctl 60 -mci 1000
-# -mci: max cache items
-
-node dist/main.js tile-server -c s3 -s3b chiitiler -s3r ap-northeast-1
-# -s3b: S3 bucket name for cache
-# -s3r: S3 bucket region
-# caution: TTL is not supported in S3 cache, please utilize S3 lifecycle policy
-```
-
-#### debug page
+### debug page
 
-- in debug mode, you can access debug page: <http://localhost:3000/debug>
-- You can pass style.json url:
-  - <http://localhost:3000/debug?url=https://tile.openstreetmap.jp/styles/osm-bright/style.json>
+- in debug mode, you can access:
+  - debug page: <http://localhost:3000/debug>
+    - You can pass style.json url: <http://localhost:3000/debug?url=https://tile.openstreetmap.jp/styles/osm-bright/style.json>
+  - editor page: <http://localhost:3000/editor>
 
 ## supported protocols in style.json
 
 - `http://` or `https://` protocol are used in Style Specification
 - In addition, chiitiler supports following protocols:
   - `s3://` for S3 bucket
-  - `file://` for local file
-  - `mbtiles://` for local MBTIles files
-  - `pmtiles://` form PMTiles, remote or local or s3
-- Only when `http://` and `https://` chiitiler will cache them with a specified method.
+  - `file://` for file system
+  - `mbtiles://` for MBTIles files
+  - `pmtiles://` for PMTiles, remote or local or s3
+  - `cog://` experimental, for Cloud Optimized GeoTIFF. CRS must be EPSG:3857.
+- Only when `http://` and `https://` chiitiler cache them with a method you specified.
 
 ### example
 

package/dist/render/rasterize.d.ts

@@ -1,7 +1,7 @@
 import type { RenderOptions } from '@maplibre/maplibre-gl-native';
 import type { StyleSpecification } from '@maplibre/maplibre-gl-style-spec';
 import type { Cache } from '../cache/index.js';
-declare function render(style: StyleSpecification, renderOptions: RenderOptions, cache: Cache, mode: 'tile' | 'static'): Promise<Uint8Array>;
+declare function render(style: StyleSpecification, renderOptions: RenderOptions, cache: Cache, mode: 'tile' | 'static'): Promise<Uint8Array<ArrayBufferLike>>;
 declare function renderTile(style: StyleSpecification, z: number, x: number, y: number, options: {
     tileSize: number;
     cache: Cache;

package/dist/source/fs.d.ts

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

package/dist/source/index.js

@@ -1,6 +1,6 @@
 import { getFilesystemSource } from './fs.js';
 import { getHttpSource } from './http.js';
-import { getPmtilesSoruce } from './pmtiles.js';
+import { getPmtilesSource } from './pmtiles.js';
 import { getMbtilesSource } from './mbtiles.js';
 import { getS3Source } from './s3.js';
 import { getCogSource } from './cog.js';
@@ -22,7 +22,7 @@ async function getSource(uri, cache = noneCache()) {
     else if (uri.startsWith('mbtiles://'))
         data = await getMbtilesSource(uri);
     else if (uri.startsWith('pmtiles://'))
-        data = await getPmtilesSoruce(uri, cache);
+        data = await getPmtilesSource(uri, cache);
     else if (uri.startsWith('cog://'))
         data = await getCogSource(uri);
     else

package/dist/source/pmtiles.d.ts

@@ -4,5 +4,5 @@ import { type Cache } from '../cache/index.js';
  * uri = pmtiles://http://url/to/file.pmtiles/{z}/{x}/{y}
  * uri = pmtiles://s3://bucket/key/to/file.pmtiles/{z}/{x}/{y}
  */
-declare function getPmtilesSoruce(uri: string, cache?: Cache): Promise<Buffer | null>;
-export { getPmtilesSoruce };
+declare function getPmtilesSource(uri: string, cache?: Cache): Promise<Buffer | null>;
+export { getPmtilesSource };

package/dist/source/pmtiles.js

@@ -72,7 +72,7 @@ class S3Source {
  * uri = pmtiles://http://url/to/file.pmtiles/{z}/{x}/{y}
  * uri = pmtiles://s3://bucket/key/to/file.pmtiles/{z}/{x}/{y}
  */
-async function getPmtilesSoruce(uri, cache = noneCache()) {
+async function getPmtilesSource(uri, cache = noneCache()) {
     const pmtilesUri = uri
         .replace('pmtiles://', '')
         .replace(/\/\d+\/\d+\/\d+$/, '');
@@ -112,4 +112,4 @@ async function getPmtilesSoruce(uri, cache = noneCache()) {
         cache.set(uri, buf);
     return buf;
 }
-export { getPmtilesSoruce };
+export { getPmtilesSource };

package/dist/source/s3.d.ts

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

package/package.json

@@ -1,53 +1,52 @@
 {
-  "type": "module",
-  "name": "chiitiler",
-  "version": "1.14.0",
-  "description": "Tiny map rendering server for MapLibre Style Spec",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "build": "tsc",
-    "dev": "tsx watch src/main.ts tile-server -D",
-    "start": "tsc && node ./dist/main.js tile-server",
-    "test:unit": "vitest src",
-    "test:coverage": "vitest src --coverage --coverage.provider=v8",
-    "test:integration": "vitest tests/integration.test.ts",
-    "test:benchmark": "vitest bench",
-    "prepare": "npm run build"
-  },
-  "keywords": [],
-  "author": "Kanahiro Iguchi",
-  "license": "MIT",
-  "devDependencies": {
-    "@tsconfig/node20": "^20.1.4",
-    "@types/better-sqlite3": "^7.6.10",
-    "@types/node": "^20.6.0",
-    "@vitest/coverage-v8": "^1.6.0",
-    "image-size": "^1.1.1",
-    "maplibre-gl": "^3.3.1",
-    "ts-node": "^10.9.1",
-    "tsx": "^4.7.1",
-    "typescript": "^5.2.2",
-    "vitest": "^1.6.0"
-  },
-  "dependencies": {
-    "@aws-sdk/client-s3": "^3.418.0",
-    "@hono/node-server": "^1.12.0",
-    "@mapbox/sphericalmercator": "^1.2.0",
-    "@mapbox/tilebelt": "^1.0.2",
-    "@maplibre/maplibre-gl-native": "^5.4.0",
-    "@maplibre/maplibre-gl-style-spec": "^20.2.0",
-    "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",
-    "pmtiles": "^3.0.5",
-    "sharp": "^0.32.5"
-  }
-}
+	"type": "module",
+	"name": "chiitiler",
+	"version": "1.14.2",
+	"description": "Tiny map rendering server for MapLibre Style Spec",
+	"main": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"files": [
+		"dist"
+	],
+	"scripts": {
+		"build": "npx esbuild --bundle src/main.ts --minify --outfile=build/main.cjs --platform=node --external:@maplibre/maplibre-gl-native --external:sharp",
+		"dev": "tsx watch src/main.ts tile-server -D",
+		"test:unit": "vitest src",
+		"test:coverage": "vitest src --coverage --coverage.provider=v8",
+		"test:integration": "vitest tests/integration.test.ts",
+		"test:benchmark": "vitest bench"
+	},
+	"keywords": [],
+	"author": "Kanahiro Iguchi",
+	"license": "MIT",
+	"devDependencies": {
+		"@tsconfig/node20": "^20.1.4",
+		"@types/better-sqlite3": "^7.6.10",
+		"@types/node": "^20.6.0",
+		"@vitest/coverage-v8": "^1.6.0",
+		"esbuild": "^0.25.0",
+		"image-size": "^1.1.1",
+		"ts-node": "^10.9.1",
+		"tsx": "^4.7.1",
+		"typescript": "^5.2.2",
+		"vitest": "^1.6.0"
+	},
+	"dependencies": {
+		"@aws-sdk/client-s3": "^3.418.0",
+		"@hono/node-server": "^1.12.0",
+		"@mapbox/sphericalmercator": "^1.2.0",
+		"@mapbox/tilebelt": "^1.0.2",
+		"@maplibre/maplibre-gl-native": "^5.4.0",
+		"@maplibre/maplibre-gl-style-spec": "^20.2.0",
+		"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",
+		"maplibre-gl": "^3.3.1",
+		"pmtiles": "^3.0.5",
+		"sharp": "^0.32.5"
+	}
+}