chiitiler 1.18.0 → 1.19.0

package/README.md

@@ -197,11 +197,11 @@ Chiitiler is also published as an npm library. Core helpers return Sharp instanc
 ```ts
 import {
     getRenderedTileBuffer,
-    getRenderedBboxBuffer,
-    getRenderedImageBuffer,
+    getRenderedClipBuffer,
+    getRenderedCameraBuffer,
     getRenderedTileStream,
-    getRenderedBboxStream,
-    getRenderedImageStream,
+    getRenderedClipStream,
+    getRenderedCameraStream,
     ChiitilerCache,
 } from 'chiitiler';
 
@@ -219,7 +219,7 @@ const tile = await getRenderedTileBuffer({
     cache,
 });
 
-const clip = await getRenderedBboxBuffer({
+const clip = await getRenderedClipBuffer({
     stylejson: 'file://localdata/style.json',
     bbox: [123.4, 34.5, 124.5, 35.6],
     size: 1024,
@@ -228,7 +228,7 @@ const clip = await getRenderedBboxBuffer({
     cache: ChiitilerCache.noneCache(),
 });
 
-const image = await getRenderedImageBuffer({
+const camera = await getRenderedCameraBuffer({
     stylejson: 'file://localdata/style.json',
     center: [139.69, 35.68],
     zoom: 10,
@@ -254,7 +254,7 @@ const tileStream = await getRenderedTileStream({
     cache,
 });
 
-const bboxStream = await getRenderedBboxStream({
+const clipStream = await getRenderedClipStream({
     stylejson: 'file://localdata/style.json',
     bbox: [123.4, 34.5, 124.5, 35.6],
     size: 1024,
@@ -263,7 +263,7 @@ const bboxStream = await getRenderedBboxStream({
     cache,
 });
 
-const imageStream = await getRenderedImageStream({
+const cameraStream = await getRenderedCameraStream({
     stylejson: 'file://localdata/style.json',
     center: [139.69, 35.68],
     zoom: 10,

package/dist/index.d.ts

@@ -1,8 +1,8 @@
-import { getRenderedBbox, getRenderedTile, getRenderedImage, GetRenderedBboxOptions, GetRenderedTileOptions, GetRenderedImageOptions } from './render/index.js';
-export declare function getRenderedBboxBuffer(options: GetRenderedBboxOptions): Promise<Buffer>;
-export { getRenderedBbox as getRenderedBboxStream };
-export declare function getRenderedImageBuffer(options: GetRenderedImageOptions): Promise<Buffer>;
-export { getRenderedImage as getRenderedImageStream };
+import { getRenderedClip, getRenderedTile, getRenderedCamera, GetRenderedClipOptions, GetRenderedTileOptions, GetRenderedCameraOptions } from './render/index.js';
+export declare function getRenderedClipBuffer(options: GetRenderedClipOptions): Promise<Buffer>;
+export { getRenderedClip as getRenderedClipStream };
+export declare function getRenderedCameraBuffer(options: GetRenderedCameraOptions): Promise<Buffer>;
+export { getRenderedCamera as getRenderedCameraStream };
 export declare function getRenderedTileBuffer(options: GetRenderedTileOptions): Promise<Buffer>;
 export { getRenderedTile as getRenderedTileStream };
 export * as ChiitilerCache from './cache/index.js';

package/dist/index.js

@@ -1,14 +1,14 @@
-import { getRenderedBbox, getRenderedTile, getRenderedImage, } from './render/index.js';
-export async function getRenderedBboxBuffer(options) {
-    const sharp = await getRenderedBbox(options);
+import { getRenderedClip, getRenderedTile, getRenderedCamera, } from './render/index.js';
+export async function getRenderedClipBuffer(options) {
+    const sharp = await getRenderedClip(options);
     return sharp.toBuffer();
 }
-export { getRenderedBbox as getRenderedBboxStream };
-export async function getRenderedImageBuffer(options) {
-    const sharp = await getRenderedImage(options);
+export { getRenderedClip as getRenderedClipStream };
+export async function getRenderedCameraBuffer(options) {
+    const sharp = await getRenderedCamera(options);
     return sharp.toBuffer();
 }
-export { getRenderedImage as getRenderedImageStream };
+export { getRenderedCamera as getRenderedCameraStream };
 export async function getRenderedTileBuffer(options) {
     const sharp = await getRenderedTile(options);
     return sharp.toBuffer();

package/dist/render/index.d.ts

@@ -14,7 +14,7 @@ type GetRenderedTileOptions = {
 };
 type SupportedFormat = 'png' | 'jpeg' | 'jpg' | 'webp';
 declare function getRenderedTile({ stylejson, z, x, y, tileSize, cache, margin, ext, quality, }: GetRenderedTileOptions): Promise<sharp.Sharp>;
-type GetRenderedBboxOptions = {
+type GetRenderedClipOptions = {
     stylejson: string | StyleSpecification;
     bbox: [number, number, number, number];
     size: number;
@@ -22,8 +22,8 @@ type GetRenderedBboxOptions = {
     ext: SupportedFormat;
     quality: number;
 };
-declare function getRenderedBbox({ stylejson, bbox, size, cache, ext, quality, }: GetRenderedBboxOptions): Promise<sharp.Sharp>;
-type GetRenderedImageOptions = {
+declare function getRenderedClip({ stylejson, bbox, size, cache, ext, quality, }: GetRenderedClipOptions): Promise<sharp.Sharp>;
+type GetRenderedCameraOptions = {
     stylejson: string | StyleSpecification;
     cache: Cache;
     ext: SupportedFormat;
@@ -35,5 +35,5 @@ type GetRenderedImageOptions = {
     height: number;
     width: number;
 };
-declare function getRenderedImage(options: GetRenderedImageOptions): Promise<sharp.Sharp>;
-export { getRenderedTile, getRenderedBbox, getRenderedImage, type GetRenderedBboxOptions, type GetRenderedTileOptions, type GetRenderedImageOptions, type SupportedFormat, };
+declare function getRenderedCamera(options: GetRenderedCameraOptions): Promise<sharp.Sharp>;
+export { getRenderedTile, getRenderedClip, getRenderedCamera, type GetRenderedClipOptions, type GetRenderedTileOptions, type GetRenderedCameraOptions, type SupportedFormat, };

package/dist/render/index.js

@@ -112,7 +112,7 @@ const calcRenderingParams = (bbox, size) => {
     const center = mercator.ll(mercCenter, 25); // latlon
     return { zoom, width, height, center };
 };
-async function getRenderedBbox({ stylejson, bbox, size, cache, ext, quality, }) {
+async function getRenderedClip({ 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, {
@@ -138,7 +138,7 @@ async function getRenderedBbox({ stylejson, bbox, size, cache, ext, quality, })
             return _sharp.webp({ quality, effort: 0 });
     }
 }
-async function getRenderedImage(options) {
+async function getRenderedCamera(options) {
     const style = await loadStyle(options.stylejson, options.cache);
     const pixels = await render(style, {
         center: options.center,
@@ -165,4 +165,4 @@ async function getRenderedImage(options) {
             return _sharp.webp({ quality: options.quality, effort: 0 });
     }
 }
-export { getRenderedTile, getRenderedBbox, getRenderedImage, };
+export { getRenderedTile, getRenderedClip, getRenderedCamera, };

package/dist/server/routes/camera.js

@@ -1,6 +1,6 @@
 import { Hono } from 'hono';
 import { isSupportedFormat, isValidStylejson } from '../utils.js';
-import { getRenderedImage } from '../../render/index.js';
+import { getRenderedCamera } from '../../render/index.js';
 function isValidCamera({ zoom, lat, lon, bearing, pitch, }) {
     if (Number.isNaN(lat) || lat < -90 || lat > 90)
         return false;
@@ -51,7 +51,7 @@ function createCameraRouter(options) {
         const quality = Number(c.req.query('quality') ?? 100);
         c.header('Content-Type', `image/${ext}`);
         try {
-            const sharp = await getRenderedImage({
+            const sharp = await getRenderedCamera({
                 stylejson: url,
                 cache: options.cache,
                 ext,
@@ -104,7 +104,7 @@ function createCameraRouter(options) {
         const quality = Number(c.req.query('quality') ?? 100);
         c.header('Content-Type', `image/${ext}`);
         try {
-            const sharp = await getRenderedImage({
+            const sharp = await getRenderedCamera({
                 stylejson: style,
                 cache: options.cache,
                 ext,

package/dist/server/routes/clip.js

@@ -1,6 +1,6 @@
 import { Hono } from 'hono';
 import { isSupportedFormat, isValidStylejson } from '../utils.js';
-import { getRenderedBbox } from '../../render/index.js';
+import { getRenderedClip } from '../../render/index.js';
 function createClipRouter(options) {
     const clip = new Hono()
         .get('/:filename_ext', async (c) => {
@@ -24,7 +24,7 @@ function createClipRouter(options) {
         const size = Number(c.req.query('size') ?? 1024);
         c.header('Content-Type', `image/${ext}`);
         try {
-            const sharp = await getRenderedBbox({
+            const sharp = await getRenderedClip({
                 stylejson: url,
                 bbox: [minx, miny, maxx, maxy],
                 size,
@@ -62,7 +62,7 @@ function createClipRouter(options) {
         const size = Number(c.req.query('size') ?? 1024);
         c.header('Content-Type', `image/${ext}`);
         try {
-            const sharp = await getRenderedBbox({
+            const sharp = await getRenderedClip({
                 stylejson: style,
                 bbox: [minx, miny, maxx, maxy],
                 size,

package/package.json

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