@reearth/ezu 0.6.1 → 0.8.0

package/web/ezu.d.ts

@@ -111,6 +111,16 @@ export class Renderer {
      * Drop every pending source binding. Call between tile renders.
      */
     clearSources(): void;
+    /**
+     * The style's declared `legend`, or `undefined` when it declares
+     * none. Pass a zoom to keep only the entries that apply there.
+     *
+     * Entries name the node that draws the symbol rather than restating
+     * a colour, so a host lays out the labels and asks the map itself
+     * for the swatches. The CLI's `ezu legend` renders those swatches;
+     * in a browser, render the named node.
+     */
+    legend(zoom?: number | null): any;
     /**
      * What this renderer is holding, in bytes, so a host can shed load
      * *before* an allocation fails rather than after.
@@ -200,6 +210,10 @@ export class Renderer {
      * - `format`: `"png"` (default) / `"webp"` / `"rgba"`
      * - `tileSize`, `pad`: override the style's canvas size for this
      *   call (hi-DPI / preview)
+     * - `params`: `{ name: number | boolean | string }` — render-time
+     *   overrides for the style's declared `params`, validated the same
+     *   way the CLI's `--param` is. Omitted names keep their declared
+     *   default.
      * - `png`: `{ compression?: "fast" | "default" | "best" }`
      */
     renderTile(z: number, x: number, y: number, opts?: object | null): Uint8Array;
@@ -216,6 +230,11 @@ export class Renderer {
      * fetches exactly what the recipe needs. An empty array means the
      * centre tile is enough.
      *
+     * A `dem` or `raster` source that declares `neighbor-fetch: false`
+     * reports no offsets whatever the graph asks for: the style has said
+     * not to stitch a neighbourhood for it, and this list is what a host
+     * fetches from.
+     *
      * Throws `UnknownSource` if `name` is not declared in the style.
      */
     requestedNeighborOffsets(name: string): Array<any>;
@@ -249,12 +268,38 @@ export class Renderer {
      * the intermediate cache and drops any pending source bindings.
      */
     setStyle(style_json: string): number;
+    /**
+     * The tile a host should actually fetch from `name` in order to draw
+     * `z/x/y`, as `{ z, x, y }`.
+     *
+     * For a source that declares `max-zoom`, a request past the ceiling
+     * answers with the covering ancestor — bind those bytes with
+     * `{ sourceZoom: <returned z> }` and the renderer resamples or
+     * reprojects them into the requested tile. Below the ceiling, and for
+     * a source that declares no ceiling, the answer is the tile itself.
+     *
+     * This exists so the ceiling lives in one place. A host that hard-codes
+     * the maxzoom of each source keeps a second copy of something the style
+     * already states, and the two drift.
+     *
+     * Throws `UnknownSource` if `name` is not declared in the style.
+     */
+    sourceTile(name: string, z: number, x: number, y: number): any;
     /**
      * Effective attribution declared by the style (document +
      * sources), joined with ` | `. Upstream TileJSON / PMTiles
      * metadata is the JS host's concern — merge it on that side.
      */
     readonly attribution: string | undefined;
+    /**
+     * JSON Schema for the current style's `params` — types, defaults,
+     * ranges, descriptions. The same document the CLI's tile server
+     * serves at `/style/params`. Generate sliders and colour pickers
+     * from this rather than parsing the style; it follows `setStyle`,
+     * so a params panel driven off it cannot drift from the graph
+     * being rendered.
+     */
+    readonly paramsSchema: any;
     /**
      * `tile-size` declared by the current style.
      */
@@ -310,14 +355,17 @@ export interface InitOutput {
     readonly renderer_bindSource: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number];
     readonly renderer_boundSources: (a: number) => [number, number];
     readonly renderer_clearSources: (a: number) => void;
+    readonly renderer_legend: (a: number, b: number) => [number, number, number];
     readonly renderer_memoryUsage: (a: number) => [number, number, number];
     readonly renderer_neededCodepoints: (a: number) => [number, number, number];
     readonly renderer_neededGlyphRanges: (a: number) => [number, number, number];
     readonly renderer_new: (a: number, b: number) => [number, number, number];
+    readonly renderer_paramsSchema: (a: number) => [number, number, number];
     readonly renderer_renderTile: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
     readonly renderer_requestedNeighborOffsets: (a: number, b: number, c: number) => [number, number, number];
     readonly renderer_setGlyphBudget: (a: number, b: number) => void;
     readonly renderer_setStyle: (a: number, b: number, c: number) => [number, number, number];
+    readonly renderer_sourceTile: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number, number];
     readonly renderer_tileSize: (a: number) => number;
     readonly simdEnabled: () => number;
     readonly threadsEnabled: () => number;

package/web/ezu.js

@@ -199,6 +199,24 @@ export class Renderer {
     clearSources() {
         wasm.renderer_clearSources(this.__wbg_ptr);
     }
+    /**
+     * The style's declared `legend`, or `undefined` when it declares
+     * none. Pass a zoom to keep only the entries that apply there.
+     *
+     * Entries name the node that draws the symbol rather than restating
+     * a colour, so a host lays out the labels and asks the map itself
+     * for the swatches. The CLI's `ezu legend` renders those swatches;
+     * in a browser, render the named node.
+     * @param {number | null} [zoom]
+     * @returns {any}
+     */
+    legend(zoom) {
+        const ret = wasm.renderer_legend(this.__wbg_ptr, isLikeNone(zoom) ? 0xFFFFFF : zoom);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
     /**
      * What this renderer is holding, in bytes, so a host can shed load
      * *before* an allocation fails rather than after.
@@ -313,6 +331,22 @@ export class Renderer {
         RendererFinalization.register(this, this.__wbg_ptr, this);
         return this;
     }
+    /**
+     * JSON Schema for the current style's `params` — types, defaults,
+     * ranges, descriptions. The same document the CLI's tile server
+     * serves at `/style/params`. Generate sliders and colour pickers
+     * from this rather than parsing the style; it follows `setStyle`,
+     * so a params panel driven off it cannot drift from the graph
+     * being rendered.
+     * @returns {any}
+     */
+    get paramsSchema() {
+        const ret = wasm.renderer_paramsSchema(this.__wbg_ptr);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
     /**
      * Render a single tile using whatever sources are currently bound.
      *
@@ -320,6 +354,10 @@ export class Renderer {
      * - `format`: `"png"` (default) / `"webp"` / `"rgba"`
      * - `tileSize`, `pad`: override the style's canvas size for this
      *   call (hi-DPI / preview)
+     * - `params`: `{ name: number | boolean | string }` — render-time
+     *   overrides for the style's declared `params`, validated the same
+     *   way the CLI's `--param` is. Omitted names keep their declared
+     *   default.
      * - `png`: `{ compression?: "fast" | "default" | "best" }`
      * @param {number} z
      * @param {number} x
@@ -349,6 +387,11 @@ export class Renderer {
      * fetches exactly what the recipe needs. An empty array means the
      * centre tile is enough.
      *
+     * A `dem` or `raster` source that declares `neighbor-fetch: false`
+     * reports no offsets whatever the graph asks for: the style has said
+     * not to stitch a neighbourhood for it, and this list is what a host
+     * fetches from.
+     *
      * Throws `UnknownSource` if `name` is not declared in the style.
      * @param {string} name
      * @returns {Array<any>}
@@ -405,6 +448,36 @@ export class Renderer {
         }
         return ret[0] >>> 0;
     }
+    /**
+     * The tile a host should actually fetch from `name` in order to draw
+     * `z/x/y`, as `{ z, x, y }`.
+     *
+     * For a source that declares `max-zoom`, a request past the ceiling
+     * answers with the covering ancestor — bind those bytes with
+     * `{ sourceZoom: <returned z> }` and the renderer resamples or
+     * reprojects them into the requested tile. Below the ceiling, and for
+     * a source that declares no ceiling, the answer is the tile itself.
+     *
+     * This exists so the ceiling lives in one place. A host that hard-codes
+     * the maxzoom of each source keeps a second copy of something the style
+     * already states, and the two drift.
+     *
+     * Throws `UnknownSource` if `name` is not declared in the style.
+     * @param {string} name
+     * @param {number} z
+     * @param {number} x
+     * @param {number} y
+     * @returns {any}
+     */
+    sourceTile(name, z, x, y) {
+        const ptr0 = passStringToWasm0(name, wasm.__wbindgen_malloc_command_export, wasm.__wbindgen_realloc_command_export);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.renderer_sourceTile(this.__wbg_ptr, ptr0, len0, z, x, y);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
     /**
      * `tile-size` declared by the current style.
      * @returns {number}
@@ -516,6 +589,10 @@ function __wbg_get_imports() {
             const ret = Reflect.get(arg0, arg1);
             return ret;
         }, arguments); },
+        __wbg_get_unchecked_6e0ad6d2a41b06f6: function(arg0, arg1) {
+            const ret = arg0[arg1 >>> 0];
+            return ret;
+        },
         __wbg_instanceof_Object_33f20e6f12439f3e: function(arg0) {
             let result;
             try {
@@ -530,6 +607,10 @@ function __wbg_get_imports() {
             const ret = Array.isArray(arg0);
             return ret;
         },
+        __wbg_keys_58421f8f96795607: function(arg0) {
+            const ret = Object.keys(arg0);
+            return ret;
+        },
         __wbg_length_370319915dc99107: function(arg0) {
             const ret = arg0.length;
             return ret;
@@ -554,6 +635,10 @@ function __wbg_get_imports() {
             const ret = Date.now();
             return ret;
         },
+        __wbg_parse_1c0d8a8656d7e016: function() { return handleError(function (arg0, arg1) {
+            const ret = JSON.parse(getStringFromWasm0(arg0, arg1));
+            return ret;
+        }, arguments); },
         __wbg_push_d2ae3af0c1217ae6: function(arg0, arg1) {
             const ret = arg0.push(arg1);
             return ret;

package/web/ezu_bg.wasm.d.ts

@@ -16,14 +16,17 @@ export const renderer_attribution: (a: number) => [number, number];
 export const renderer_bindSource: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number];
 export const renderer_boundSources: (a: number) => [number, number];
 export const renderer_clearSources: (a: number) => void;
+export const renderer_legend: (a: number, b: number) => [number, number, number];
 export const renderer_memoryUsage: (a: number) => [number, number, number];
 export const renderer_neededCodepoints: (a: number) => [number, number, number];
 export const renderer_neededGlyphRanges: (a: number) => [number, number, number];
 export const renderer_new: (a: number, b: number) => [number, number, number];
+export const renderer_paramsSchema: (a: number) => [number, number, number];
 export const renderer_renderTile: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
 export const renderer_requestedNeighborOffsets: (a: number, b: number, c: number) => [number, number, number];
 export const renderer_setGlyphBudget: (a: number, b: number) => void;
 export const renderer_setStyle: (a: number, b: number, c: number) => [number, number, number];
+export const renderer_sourceTile: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number, number];
 export const renderer_tileSize: (a: number) => number;
 export const simdEnabled: () => number;
 export const threadsEnabled: () => number;