isard 1.3.0 → 1.4.0

package/dist/wasm/isard_grid.d.ts

@@ -0,0 +1,101 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * The grids of a file
+ */
+export class GridSet {
+    private constructor();
+    free(): void;
+    /**
+     * How many grids
+     */
+    count(): number;
+    /**
+     * Grid `i`'s description: name, standard name, units, level, time, width, height, bounds (JSON)
+     */
+    meta(i: number): string;
+    /**
+     * Grid `i`'s values, row after row from the north
+     */
+    values(i: number): Float32Array;
+}
+
+/**
+ * The flows of a city's streets for a wind of 1 m/s from the west and one from the south (see `street`): the east and
+ * north velocities of each, `width` × `height` cells each
+ */
+export class StreetFlow {
+    private constructor();
+    free(): void;
+    /**
+     * The flow of a wind towards the east: its east velocities, then its north ones
+     */
+    eastU(): Float32Array;
+    eastV(): Float32Array;
+    /**
+     * The flow of a wind towards the north: its east velocities, then its north ones
+     */
+    northU(): Float32Array;
+    northV(): Float32Array;
+}
+
+/**
+ * The grids of a GRIB2 or classic NetCDF file
+ *
+ * # Errors
+ *
+ * Throws (to JavaScript) when the file is of neither kind, malformed, or packed in a way not read
+ */
+export function readGrids(bytes: Uint8Array): GridSet;
+
+/**
+ * The flows of the streets of a grid of `width` × `height` cells round the buildings of `points` (their rings in
+ * cells, from the north-west corner, interleaved; `ring_start` the first point of each ring and the end,
+ * `polygon_start` the first ring of each polygon and the end), after `iterations` sweeps
+ */
+export function streetFlow(points: Float64Array, ring_start: Uint32Array, polygon_start: Uint32Array, width: number, height: number, iterations: number): StreetFlow;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly __wbg_gridset_free: (a: number, b: number) => void;
+    readonly __wbg_streetflow_free: (a: number, b: number) => void;
+    readonly gridset_count: (a: number) => number;
+    readonly gridset_meta: (a: number, b: number) => [number, number];
+    readonly gridset_values: (a: number, b: number) => any;
+    readonly readGrids: (a: number, b: number) => [number, number, number];
+    readonly streetFlow: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number) => number;
+    readonly streetflow_eastU: (a: number) => any;
+    readonly streetflow_eastV: (a: number) => any;
+    readonly streetflow_northU: (a: number) => any;
+    readonly streetflow_northV: (a: number) => any;
+    readonly __wbindgen_externrefs: WebAssembly.Table;
+    readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+    readonly __wbindgen_malloc: (a: number, b: number) => number;
+    readonly __externref_table_dealloc: (a: number) => void;
+    readonly __wbindgen_start: () => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+
+/**
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;

package/dist/wasm/isard_grid.js

@@ -0,0 +1,375 @@
+/* @ts-self-types="./isard_grid.d.ts" */
+
+/**
+ * The grids of a file
+ */
+export class GridSet {
+    static __wrap(ptr) {
+        const obj = Object.create(GridSet.prototype);
+        obj.__wbg_ptr = ptr;
+        GridSetFinalization.register(obj, obj.__wbg_ptr, obj);
+        return obj;
+    }
+    __destroy_into_raw() {
+        const ptr = this.__wbg_ptr;
+        this.__wbg_ptr = 0;
+        GridSetFinalization.unregister(this);
+        return ptr;
+    }
+    free() {
+        const ptr = this.__destroy_into_raw();
+        wasm.__wbg_gridset_free(ptr, 0);
+    }
+    /**
+     * How many grids
+     * @returns {number}
+     */
+    count() {
+        const ret = wasm.gridset_count(this.__wbg_ptr);
+        return ret >>> 0;
+    }
+    /**
+     * Grid `i`'s description: name, standard name, units, level, time, width, height, bounds (JSON)
+     * @param {number} i
+     * @returns {string}
+     */
+    meta(i) {
+        let deferred1_0;
+        let deferred1_1;
+        try {
+            const ret = wasm.gridset_meta(this.__wbg_ptr, i);
+            deferred1_0 = ret[0];
+            deferred1_1 = ret[1];
+            return getStringFromWasm0(ret[0], ret[1]);
+        } finally {
+            wasm.__wbindgen_free(deferred1_0, deferred1_1, 1);
+        }
+    }
+    /**
+     * Grid `i`'s values, row after row from the north
+     * @param {number} i
+     * @returns {Float32Array}
+     */
+    values(i) {
+        const ret = wasm.gridset_values(this.__wbg_ptr, i);
+        return ret;
+    }
+}
+if (Symbol.dispose) GridSet.prototype[Symbol.dispose] = GridSet.prototype.free;
+
+/**
+ * The flows of a city's streets for a wind of 1 m/s from the west and one from the south (see `street`): the east and
+ * north velocities of each, `width` × `height` cells each
+ */
+export class StreetFlow {
+    static __wrap(ptr) {
+        const obj = Object.create(StreetFlow.prototype);
+        obj.__wbg_ptr = ptr;
+        StreetFlowFinalization.register(obj, obj.__wbg_ptr, obj);
+        return obj;
+    }
+    __destroy_into_raw() {
+        const ptr = this.__wbg_ptr;
+        this.__wbg_ptr = 0;
+        StreetFlowFinalization.unregister(this);
+        return ptr;
+    }
+    free() {
+        const ptr = this.__destroy_into_raw();
+        wasm.__wbg_streetflow_free(ptr, 0);
+    }
+    /**
+     * The flow of a wind towards the east: its east velocities, then its north ones
+     * @returns {Float32Array}
+     */
+    eastU() {
+        const ret = wasm.streetflow_eastU(this.__wbg_ptr);
+        return ret;
+    }
+    /**
+     * @returns {Float32Array}
+     */
+    eastV() {
+        const ret = wasm.streetflow_eastV(this.__wbg_ptr);
+        return ret;
+    }
+    /**
+     * The flow of a wind towards the north: its east velocities, then its north ones
+     * @returns {Float32Array}
+     */
+    northU() {
+        const ret = wasm.streetflow_northU(this.__wbg_ptr);
+        return ret;
+    }
+    /**
+     * @returns {Float32Array}
+     */
+    northV() {
+        const ret = wasm.streetflow_northV(this.__wbg_ptr);
+        return ret;
+    }
+}
+if (Symbol.dispose) StreetFlow.prototype[Symbol.dispose] = StreetFlow.prototype.free;
+
+/**
+ * The grids of a GRIB2 or classic NetCDF file
+ *
+ * # Errors
+ *
+ * Throws (to JavaScript) when the file is of neither kind, malformed, or packed in a way not read
+ * @param {Uint8Array} bytes
+ * @returns {GridSet}
+ */
+export function readGrids(bytes) {
+    const ptr0 = passArray8ToWasm0(bytes, wasm.__wbindgen_malloc);
+    const len0 = WASM_VECTOR_LEN;
+    const ret = wasm.readGrids(ptr0, len0);
+    if (ret[2]) {
+        throw takeFromExternrefTable0(ret[1]);
+    }
+    return GridSet.__wrap(ret[0]);
+}
+
+/**
+ * The flows of the streets of a grid of `width` × `height` cells round the buildings of `points` (their rings in
+ * cells, from the north-west corner, interleaved; `ring_start` the first point of each ring and the end,
+ * `polygon_start` the first ring of each polygon and the end), after `iterations` sweeps
+ * @param {Float64Array} points
+ * @param {Uint32Array} ring_start
+ * @param {Uint32Array} polygon_start
+ * @param {number} width
+ * @param {number} height
+ * @param {number} iterations
+ * @returns {StreetFlow}
+ */
+export function streetFlow(points, ring_start, polygon_start, width, height, iterations) {
+    const ptr0 = passArrayF64ToWasm0(points, wasm.__wbindgen_malloc);
+    const len0 = WASM_VECTOR_LEN;
+    const ptr1 = passArray32ToWasm0(ring_start, wasm.__wbindgen_malloc);
+    const len1 = WASM_VECTOR_LEN;
+    const ptr2 = passArray32ToWasm0(polygon_start, wasm.__wbindgen_malloc);
+    const len2 = WASM_VECTOR_LEN;
+    const ret = wasm.streetFlow(ptr0, len0, ptr1, len1, ptr2, len2, width, height, iterations);
+    return StreetFlow.__wrap(ret);
+}
+function __wbg_get_imports() {
+    const import0 = {
+        __proto__: null,
+        __wbg___wbindgen_throw_41e9ee4f547fc59a: function(arg0, arg1) {
+            throw new Error(getStringFromWasm0(arg0, arg1));
+        },
+        __wbg_new_from_slice_ca6ad97db1f4779a: function(arg0, arg1) {
+            const ret = new Float32Array(getArrayF32FromWasm0(arg0, arg1));
+            return ret;
+        },
+        __wbindgen_generic_0000000000000001: function(arg0, arg1) {
+            // Cast intrinsic for `Ref(String) -> Externref`.
+            const ret = getStringFromWasm0(arg0, arg1);
+            return ret;
+        },
+        __wbindgen_init_externref_table: function() {
+            const table = wasm.__wbindgen_externrefs;
+            const offset = table.grow(4);
+            table.set(0, undefined);
+            table.set(offset + 0, undefined);
+            table.set(offset + 1, null);
+            table.set(offset + 2, true);
+            table.set(offset + 3, false);
+        },
+    };
+    return {
+        __proto__: null,
+        "./isard_grid_bg.js": import0,
+    };
+}
+
+const GridSetFinalization = (typeof FinalizationRegistry === 'undefined')
+    ? { register: () => {}, unregister: () => {} }
+    : new FinalizationRegistry(ptr => wasm.__wbg_gridset_free(ptr, 1));
+const StreetFlowFinalization = (typeof FinalizationRegistry === 'undefined')
+    ? { register: () => {}, unregister: () => {} }
+    : new FinalizationRegistry(ptr => wasm.__wbg_streetflow_free(ptr, 1));
+
+function getArrayF32FromWasm0(ptr, len) {
+    ptr = ptr >>> 0;
+    return getFloat32ArrayMemory0().subarray(ptr / 4, ptr / 4 + len);
+}
+
+let cachedFloat32ArrayMemory0 = null;
+function getFloat32ArrayMemory0() {
+    if (cachedFloat32ArrayMemory0 === null || cachedFloat32ArrayMemory0.byteLength === 0) {
+        cachedFloat32ArrayMemory0 = new Float32Array(wasm.memory.buffer);
+    }
+    return cachedFloat32ArrayMemory0;
+}
+
+let cachedFloat64ArrayMemory0 = null;
+function getFloat64ArrayMemory0() {
+    if (cachedFloat64ArrayMemory0 === null || cachedFloat64ArrayMemory0.byteLength === 0) {
+        cachedFloat64ArrayMemory0 = new Float64Array(wasm.memory.buffer);
+    }
+    return cachedFloat64ArrayMemory0;
+}
+
+function getStringFromWasm0(ptr, len) {
+    return decodeText(ptr >>> 0, len);
+}
+
+let cachedUint32ArrayMemory0 = null;
+function getUint32ArrayMemory0() {
+    if (cachedUint32ArrayMemory0 === null || cachedUint32ArrayMemory0.byteLength === 0) {
+        cachedUint32ArrayMemory0 = new Uint32Array(wasm.memory.buffer);
+    }
+    return cachedUint32ArrayMemory0;
+}
+
+let cachedUint8ArrayMemory0 = null;
+function getUint8ArrayMemory0() {
+    if (cachedUint8ArrayMemory0 === null || cachedUint8ArrayMemory0.byteLength === 0) {
+        cachedUint8ArrayMemory0 = new Uint8Array(wasm.memory.buffer);
+    }
+    return cachedUint8ArrayMemory0;
+}
+
+function passArray32ToWasm0(arg, malloc) {
+    const ptr = malloc(arg.length * 4, 4) >>> 0;
+    getUint32ArrayMemory0().set(arg, ptr / 4);
+    WASM_VECTOR_LEN = arg.length;
+    return ptr;
+}
+
+function passArray8ToWasm0(arg, malloc) {
+    const ptr = malloc(arg.length * 1, 1) >>> 0;
+    getUint8ArrayMemory0().set(arg, ptr / 1);
+    WASM_VECTOR_LEN = arg.length;
+    return ptr;
+}
+
+function passArrayF64ToWasm0(arg, malloc) {
+    const ptr = malloc(arg.length * 8, 8) >>> 0;
+    getFloat64ArrayMemory0().set(arg, ptr / 8);
+    WASM_VECTOR_LEN = arg.length;
+    return ptr;
+}
+
+function takeFromExternrefTable0(idx) {
+    const value = wasm.__wbindgen_externrefs.get(idx);
+    wasm.__externref_table_dealloc(idx);
+    return value;
+}
+
+let cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });
+cachedTextDecoder.decode();
+const MAX_SAFARI_DECODE_BYTES = 2146435072;
+let numBytesDecoded = 0;
+function decodeText(ptr, len) {
+    numBytesDecoded += len;
+    if (numBytesDecoded >= MAX_SAFARI_DECODE_BYTES) {
+        cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });
+        cachedTextDecoder.decode();
+        numBytesDecoded = len;
+    }
+    return cachedTextDecoder.decode(getUint8ArrayMemory0().subarray(ptr, ptr + len));
+}
+
+let WASM_VECTOR_LEN = 0;
+
+let wasmModule, wasmInstance, wasm;
+function __wbg_finalize_init(instance, module) {
+    wasmInstance = instance;
+    wasm = instance.exports;
+    wasmModule = module;
+    cachedFloat32ArrayMemory0 = null;
+    cachedFloat64ArrayMemory0 = null;
+    cachedUint32ArrayMemory0 = null;
+    cachedUint8ArrayMemory0 = null;
+    wasm.__wbindgen_start();
+    return wasm;
+}
+
+async function __wbg_load(module, imports) {
+    if (typeof Response === 'function' && module instanceof Response) {
+        if (!module.ok) {
+            throw new Error(`failed to fetch Wasm: ${module.status} ${module.statusText} fetching '${module.url}'`);
+        }
+
+        if (typeof WebAssembly.instantiateStreaming === 'function') {
+            try {
+                return await WebAssembly.instantiateStreaming(module, imports);
+            } catch (e) {
+                const validResponse = expectedResponseType(module.type);
+
+                if (validResponse && module.headers.get('Content-Type') !== 'application/wasm') {
+                    console.warn("`WebAssembly.instantiateStreaming` failed because your server does not serve Wasm with `application/wasm` MIME type. Falling back to `WebAssembly.instantiate` which is slower. Original error:\n", e);
+
+                } else { throw e; }
+            }
+        }
+
+        const bytes = await module.arrayBuffer();
+        return await WebAssembly.instantiate(bytes, imports);
+    } else {
+        const instance = await WebAssembly.instantiate(module, imports);
+
+        if (instance instanceof WebAssembly.Instance) {
+            return { instance, module };
+        } else {
+            return instance;
+        }
+    }
+
+    function expectedResponseType(type) {
+        switch (type) {
+            case 'basic': case 'cors': case 'default': return true;
+        }
+        return false;
+    }
+}
+
+function initSync(module) {
+    if (wasm !== undefined) return wasm;
+
+
+    if (module !== undefined) {
+        if (Object.getPrototypeOf(module) === Object.prototype) {
+            ({module} = module)
+        } else {
+            console.warn('using deprecated parameters for `initSync()`; pass a single object instead')
+        }
+    }
+
+    const imports = __wbg_get_imports();
+    if (!(module instanceof WebAssembly.Module)) {
+        module = new WebAssembly.Module(module);
+    }
+    const instance = new WebAssembly.Instance(module, imports);
+    return __wbg_finalize_init(instance, module);
+}
+
+async function __wbg_init(module_or_path) {
+    if (wasm !== undefined) return wasm;
+
+
+    if (module_or_path !== undefined) {
+        if (Object.getPrototypeOf(module_or_path) === Object.prototype) {
+            ({module_or_path} = module_or_path)
+        } else {
+            console.warn('using deprecated parameters for the initialization function; pass a single object instead')
+        }
+    }
+
+    if (module_or_path === undefined) {
+        module_or_path = new URL('isard_grid_bg.wasm', import.meta.url);
+    }
+    const imports = __wbg_get_imports();
+
+    if (typeof module_or_path === 'string' || (typeof Request === 'function' && module_or_path instanceof Request) || (typeof URL === 'function' && module_or_path instanceof URL)) {
+        module_or_path = fetch(module_or_path);
+    }
+
+    const { instance, module } = await __wbg_load(await module_or_path, imports);
+
+    return __wbg_finalize_init(instance, module);
+}
+
+export { initSync, __wbg_init as default };

package/dist/workers/basemap/street.d.ts

@@ -0,0 +1,19 @@
+/** The wind of a city's streets: the buildings of the vector tiles around a square, laid on its grid of cells, and
+ * the flow round them for a wind towards the east and one towards the north (the grid module) */
+import { type StreetFlows } from '../../grid-module.ts';
+import type { Priority } from '../basemap.worker.ts';
+import type { Renderer } from './tiles.ts';
+/** What a street flow is asked with: its square (Mercator: west, north, east, south) and grid, the tiles of level `z`
+ * over it (x, y pairs), the sweeps, the grid module's URL */
+export interface StreetWork {
+    module: string;
+    z: number;
+    tiles: number[];
+    bounds: [x0: number, y0: number, x1: number, y1: number];
+    width: number;
+    height: number;
+    iterations: number;
+    priority?: Priority;
+}
+/** The streets' flows of a square: the buildings of its tiles in cells (those away from it left out), then solved */
+export declare const streetFlowOf: (r: Renderer, work: StreetWork, id: number) => Promise<StreetFlows>;

package/dist/workers/basemap.worker.d.ts

@@ -19,6 +19,8 @@ import { type Job } from '../basemap/resample.ts';
 import { type PngEncoding } from '../basemap/terrain.ts';
 import { type LabelCandidate, type RasterSource, type StyleLayer } from '../basemap/vectorstyle.ts';
 import { type HeaderRules } from '../engine/requests.ts';
+import { type GridDescription, type StreetFlows } from '../grid-module.ts';
+import { type StreetWork } from './basemap/street.ts';
 import { type Sprite } from './basemap/tiles.ts';
 export type { LabelCandidate, RasterSource, Sprite };
 /** Fetch priority of a request (`fetch`'s `priority`, a hint to the browser) */
@@ -85,6 +87,18 @@ export type BasemapWork = {
     url: string;
     encoding: PngEncoding;
     floor?: number;
+}
+/** The wind of a city's streets round the buildings of the renderer's layers (see `StreetWork`) */
+ | ({
+    type: 'street';
+    key: string;
+} & StreetWork)
+/** A GRIB2 or NetCDF file (fetched from `url`, or its `bytes`) read into grids by the grid module (`module`) */
+ | {
+    type: 'grids';
+    module: string;
+    url?: string;
+    bytes?: ArrayBuffer;
 } | {
     type: 'reproject';
     job: Job;
@@ -151,6 +165,13 @@ export type BasemapResponse = {
 } | {
     id: number;
     heights: Float32Array;
+} | {
+    id: number;
+    grids: GridDescription[];
+    values: Float32Array[];
+} | {
+    id: number;
+    street: StreetFlows;
 };
 /** The polygons of a tile in Mercator [0, 1], as the extrusions take them (`PolygonArrays`), and their properties */
 export interface TilePolygons {

package/dist/workers/basemap.worker.js

@@ -17,10 +17,12 @@
 import { resampler } from "../basemap/resample.js";
 import { fetchHeights } from "../basemap/terrain.js";
 import { vectorKind } from "../basemap/vectorstyle.js";
-import { setHeaderRules } from "../engine/requests.js";
+import { setHeaderRules, withHeaders } from "../engine/requests.js";
+import { decodeGrids } from "../grid-module.js";
 import { polygons, tess, tessellate, tessellator, vectors } from "./basemap/geometry.js";
 import { labels } from "./basemap/labels.js";
 import { render } from "./basemap/raster.js";
+import { streetFlowOf } from "./basemap/street.js";
 import { aborted, active, cache, cacheShare, renderers } from "./basemap/tiles.js";
 import { trees } from "./basemap/trees.js";
 /** The signals of the relief and reprojection requests in progress, aborted with them */
@@ -67,7 +69,7 @@ self.onmessage = async ({ data }) => {
         controllers.get(data.id)?.abort();
         return;
     }
-    if (data.type === 'heights' || data.type === 'reproject') {
+    if (data.type === 'heights' || data.type === 'reproject' || data.type === 'grids') {
         await decodeTile(data);
         return;
     }
@@ -90,6 +92,10 @@ self.onmessage = async ({ data }) => {
             else
                 post({ id: data.id, trees: out }, [out.buffer]);
         }
+        else if (data.type === 'street') {
+            const street = await streetFlowOf(r, data, data.id);
+            post({ id: data.id, street }, [street.eastU, street.eastV, street.northU, street.northV].map((a) => a.buffer));
+        }
         else if (data.type === 'polygons') {
             const tilePolygons = await polygons(r, data.z, data.x, data.y, data.id, data.priority);
             if (!tilePolygons)
@@ -148,12 +154,25 @@ self.onmessage = async ({ data }) => {
         aborted.delete(data.id);
     }
 };
-/** A tile of another layer: the altitudes of a relief tile, or a reprojected raster tile */
+/** A file's bytes, with the page's request headers */
+const fetchBytes = async (url, signal) => {
+    const response = await fetch(url, withHeaders(url, { signal }));
+    if (!response.ok)
+        throw new Error(`${url}: ${response.status}`);
+    return response.arrayBuffer();
+};
+/** A tile of another layer: the altitudes of a relief tile, or a reprojected raster tile; or a file's grids */
 const decodeTile = async (data) => {
     const controller = new AbortController();
     controllers.set(data.id, controller);
     try {
-        if (data.type === 'heights') {
+        if (data.type === 'grids') {
+            const { module, url, bytes } = data;
+            const file = bytes ?? (url ? await fetchBytes(url, controller.signal) : new ArrayBuffer(0));
+            const { grids, values } = await decodeGrids(new Uint8Array(file), module);
+            post({ id: data.id, grids, values }, values.map((v) => v.buffer));
+        }
+        else if (data.type === 'heights') {
             const heights = await fetchHeights(data.url, data.encoding, data.floor, controller.signal, heightsSurface);
             if (heights)
                 post({ id: data.id, heights }, [heights.buffer]);