chiitiler 1.12.4 → 1.12.6

package/README.md

@@ -102,6 +102,7 @@ you can pass server options via environment variables
 | CHIITILER_S3CACHE_BUCKET           |          | s3cache bucket name                            |
 | CHIITILER_S3_REGION                | us-east1 | s3 bucket region for caching/fetching          |
 | CHIITILER_S3_ENDPOINT              |          | s3 endpoint for caching/fetching               |
+| CHIITILER_S3_FORCE_PATH_STYLE      | false    | force path style for s3, needed for minio      |
 
 ### Local
 
@@ -236,6 +237,58 @@ node dist/main.js tile-server -c s3 -s3b chiitiler -s3r ap-northeast-1
 }
 ```
 
+## Library Mode
+
+- chiitiler can be used as a library to render MapLibre Style.
+- methods to render MapLibre Style are exposed from `chiitiler` package.
+
+### installation
+
+```sh
+npm install chiitiler
+```
+
+- chiitiler requires some dependencies in runtime, you can find them in [Dockerfile](./Dockerfile)
+
+### Usage
+
+```typescript
+import {
+    getRenderedBboxBuffer,
+    getRenderedTileBuffer,
+    ChiitilerCache
+} from 'chiitiler';
+
+const s3Cache = ChiitilerCache.s3Cache({
+    bucket: 'chiitiler',
+    region: 'ap-northeast-1',
+    endpoint: null,
+});
+
+const tileBuf = await getRenderedTileBuffer({
+    stylejson: 'https://example.com/style.json', // or StyleSpecification object
+    z: 0,
+    x: 0,
+    y: 0,
+    tileSize: 512,
+    ext: 'webp', // png, webp, jpg
+    cache: s3Cache,
+    quality: 80,
+    margin: 0,
+});
+
+const bboxBuf = await getRenderedBboxBuffer({
+    stylejson: 'file://path/to/style.json', // or StyleSpecification object
+    bbox: [123.4, 34.5, 124.5, 35.6],
+    size: 1024,
+    cache: s3Cache,
+    ext: 'webp',
+    quality: 80,
+});
+
+// return value is Buffer - binary of each image
+```
+
 ## development
 
 - run `docker compose up`

package/dist/cache/s3.d.ts

@@ -2,7 +2,8 @@ import { type Cache } from './index.js';
 type S3CacheOptions = {
     bucket: string;
     region: string;
-    endpoint: string | null;
+    endpoint?: string;
+    forcePathStyle?: boolean;
 };
 declare function s3Cache(options: S3CacheOptions): Cache;
 export { s3Cache };

package/dist/cache/s3.js

@@ -4,6 +4,7 @@ function s3Cache(options) {
     const s3Client = getS3Client({
         region: options.region,
         endpoint: options.endpoint,
+        forcePathStyle: options.forcePathStyle,
     });
     return {
         name: 's3',

package/dist/cli.js

@@ -19,6 +19,7 @@ function parseCacheStrategy(method, options) {
             bucket: options.s3CacheBucket,
             region: options.s3Region,
             endpoint: options.s3Endpoint,
+            forcePathStyle: options.s3ForcePathStyle,
         });
     // command-line is not specified -> try to read from env
     const cacheEnv = process.env.CHIITILER_CACHE_METHOD;
@@ -36,7 +37,8 @@ function parseCacheStrategy(method, options) {
         return caches.s3Cache({
             bucket: process.env.CHIITILER_S3CACHE_BUCKET ?? '',
             region: process.env.CHIITILER_S3_REGION ?? 'us-east1',
-            endpoint: process.env.CHIITILER_S3_ENDPOINT ?? null,
+            endpoint: process.env.CHIITILER_S3_ENDPOINT,
+            forcePathStyle: process.env.CHIITILER_S3_FORCE_PATH_STYLE === 'true',
         });
     // undefined or invalid
     return caches.noneCache();
@@ -74,6 +76,7 @@ export function createProgram() {
         .option('-s3r --s3-region <region-name>', 's3 bucket region for get/put', 'us-east1')
         .option('-s3b --s3-cache-bucket <bucket-name>', 's3 cache bucket name', '')
         .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('-D --debug', 'debug mode')
         .action((options) => {
@@ -85,6 +88,7 @@ export function createProgram() {
                 s3CacheBucket: options.s3CacheBucket,
                 s3Region: options.s3Region,
                 s3Endpoint: options.s3Endpoint,
+                s3ForcePathStyle: options.s3ForcePathStyle === 'true',
             }),
             port: parsePort(options.port),
             debug: parseDebug(options.debug),

package/dist/index.d.ts

@@ -1,2 +1,2 @@
-export { initServer, type InitServerOptions } from './server/index.js';
-export * as cache from './cache/index.js';
+export { getRenderedBboxBuffer, getRenderedTileBuffer, } from './render/index.js';
+export * as ChiitilerCache from './cache/index.js';

package/dist/index.js

@@ -1,2 +1,2 @@
-export { initServer } from './server/index.js';
-export * as cache from './cache/index.js';
+export { getRenderedBboxBuffer, getRenderedTileBuffer, } from './render/index.js';
+export * as ChiitilerCache from './cache/index.js';

package/dist/s3.d.ts

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

package/dist/s3.js

@@ -1,23 +1,13 @@
 import { S3Client } from '@aws-sdk/client-s3';
 let s3Client; // singleton
-const getS3Client = function ({ region, endpoint, }) {
+const getS3Client = function ({ region, endpoint, forcePathStyle, }) {
     if (s3Client !== undefined)
         return s3Client;
-    let s3ClientConfig = {
+    const s3ClientConfig = {
         region,
-        endpoint: endpoint ?? undefined,
+        endpoint,
+        forcePathStyle,
     };
-    if (process.env.NODE_ENV === 'development') {
-        s3ClientConfig = {
-            region,
-            credentials: {
-                accessKeyId: 'minioadmin',
-                secretAccessKey: 'minioadmin',
-            },
-            forcePathStyle: true,
-            endpoint: 'http://minio:9000',
-        };
-    }
     s3Client = new S3Client(s3ClientConfig);
     return s3Client;
 };

package/dist/source/pmtiles.js

@@ -32,7 +32,8 @@ class S3Source {
         this.key = key;
         this.s3Client = getS3Client({
             region: process.env.CHIITILER_S3_REGION ?? 'us-east1',
-            endpoint: process.env.CHIITILER_S3_ENDPOINT ?? null,
+            endpoint: process.env.CHIITILER_S3_ENDPOINT,
+            forcePathStyle: process.env.CHIITILER_S3_FORCE_PATH_STYLE === 'true',
         });
     }
     getKey() {

package/dist/source/s3.js

@@ -3,7 +3,8 @@ import { getS3Client } from '../s3.js';
 async function getS3Source(uri) {
     const s3Client = getS3Client({
         region: process.env.CHIITILER_S3_REGION ?? 'us-east1',
-        endpoint: process.env.CHIITILER_S3_ENDPOINT ?? null,
+        endpoint: process.env.CHIITILER_S3_ENDPOINT,
+        forcePathStyle: process.env.CHIITILER_S3_FORCE_PATH_STYLE === 'true',
     });
     const bucket = uri.replace('s3://', '').split('/')[0];
     const key = uri.replace(`s3://${bucket}/`, '');

package/package.json

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