@versatiles/versatiles-rs 4.7.0 → 4.9.0

package/vpl.js

@@ -1,21 +1,23 @@
 // AUTO-GENERATED — DO NOT EDIT
 // Generated from Rust VPL operation metadata
-import { TileSource } from './index.js';
-function serializeParam(key, value) {
-    if (typeof value === 'boolean') {
-        return `${key}=${value}`;
-    }
-    if (typeof value === 'number') {
-        return `${key}=${value}`;
-    }
-    if (Array.isArray(value)) {
-        return `${key}=[${value.join(',')}]`;
-    }
-    const str = String(value);
-    if (/^[a-zA-Z0-9._-]+$/.test(str)) {
-        return `${key}=${str}`;
-    }
-    return `${key}="${str.replace(/\\/g, '\\\\').replace(/"/g, '\\"')}"`;
+import { TileSource, parseVpl, parseVplCst, stringifyVpl, stringifyVplCst } from './index.js';
+/** Parse VPL text into a lossless syntax tree, returning the error rather than throwing. */
+export function parseCstResult(vpl) {
+    return JSON.parse(parseVplCst(vpl));
+}
+/** Parse VPL text into a lossless syntax tree, throwing on a syntax error. */
+export function parseCst(vpl) {
+    const result = parseCstResult(vpl);
+    if (!result.ok) {
+        const error = new SyntaxError(result.error.message);
+        error.vpl = result.error;
+        throw error;
+    }
+    return result.cst;
+}
+/** Write a lossless syntax tree back out as VPL text. */
+export function stringifyCst(cst) {
+    return stringifyVplCst(JSON.stringify(cst));
 }
 export class VPL {
     steps;
@@ -37,6 +39,8 @@ export class VPL {
     static fromContainer(options) {
         const params = {};
         params['filename'] = options.filename;
+        if (options.sshIdentity !== undefined)
+            params['ssh_identity'] = options.sshIdentity;
         return new VPL([{ name: 'from_container', params }]);
     }
     /** Reads a CSV file with longitude/latitude columns and emits MVT point tiles. */
@@ -116,7 +120,50 @@ export class VPL {
             params['ignore_id'] = options.ignoreId;
         return new VPL([{ name: 'from_geo', params }]);
     }
-    /** Merges multiple vector tile sources. */
+    /** Generates vector tiles containing the cells of a projected square grid, ready to be joined with data keyed on the cell id. */
+    static fromGrid(options) {
+        const params = {};
+        params['epsg'] = options.epsg;
+        params['size'] = options.size;
+        params['bbox'] = options.bbox;
+        if (options.offset !== undefined)
+            params['offset'] = options.offset;
+        if (options.maxCellsPerTile !== undefined)
+            params['max_cells_per_tile'] = options.maxCellsPerTile;
+        if (options.maxZoom !== undefined)
+            params['max_zoom'] = options.maxZoom;
+        if (options.idPreset !== undefined)
+            params['id_preset'] = options.idPreset;
+        if (options.idTemplate !== undefined)
+            params['id_template'] = options.idTemplate;
+        if (options.idField !== undefined)
+            params['id_field'] = options.idField;
+        if (options.xField !== undefined)
+            params['x_field'] = options.xField;
+        if (options.yField !== undefined)
+            params['y_field'] = options.yField;
+        if (options.densifyTolerance !== undefined)
+            params['densify_tolerance'] = options.densifyTolerance;
+        if (options.layerName !== undefined)
+            params['layer_name'] = options.layerName;
+        return new VPL([{ name: 'from_grid', params }]);
+    }
+    /** Generates vector tiles containing H3 grid cells, ready to be joined with data keyed on the H3 index. */
+    static fromH3(options) {
+        const params = {};
+        params['resolution'] = options.resolution;
+        params['bbox'] = options.bbox;
+        if (options.maxCellsPerTile !== undefined)
+            params['max_cells_per_tile'] = options.maxCellsPerTile;
+        if (options.maxZoom !== undefined)
+            params['max_zoom'] = options.maxZoom;
+        if (options.layerName !== undefined)
+            params['layer_name'] = options.layerName;
+        if (options.idField !== undefined)
+            params['id_field'] = options.idField;
+        return new VPL([{ name: 'from_h3', params }]);
+    }
+    /** Merges multiple vector tile sources. Each resulting tile will contain all the features and properties from all the sources. */
     static fromMergedVector(sources) {
         const params = {};
         return new VPL([{ name: 'from_merged_vector', params, sources }]);
@@ -141,7 +188,7 @@ export class VPL {
         params['filename'] = options.filename;
         return new VPL([{ name: 'from_tile', params }]);
     }
-    /** Reads tiles from a remote tile server via a TileJSON endpoint. */
+    /** Reads tiles from a remote tile server via a TileJSON endpoint. The TileJSON is fetched from the given URL, and tiles are loaded individually using the URL template from the TileJSON `tiles` array. */
     static fromTilejson(options) {
         const params = {};
         params['url'] = options.url;
@@ -156,6 +203,8 @@ export class VPL {
         const params = {};
         if (options?.bbox !== undefined)
             params['bbox'] = options?.bbox;
+        if (options?.bboxBorder !== undefined)
+            params['bbox_border'] = options?.bboxBorder;
         if (options?.levelMin !== undefined)
             params['level_min'] = options?.levelMin;
         if (options?.levelMax !== undefined)
@@ -197,6 +246,17 @@ export class VPL {
             params['vector_layers_file'] = options?.vectorLayersFile;
         return new VPL([...this.steps, { name: 'meta_update', params }]);
     }
+    /** Relabels tile coordinates, e.g. to correct a source that uses TMS row order or `z/y/x` paths. */
+    remapCoords(options) {
+        const params = {};
+        if (options?.flipX !== undefined)
+            params['flip_x'] = options?.flipX;
+        if (options?.flipY !== undefined)
+            params['flip_y'] = options?.flipY;
+        if (options?.swapXy !== undefined)
+            params['swap_xy'] = options?.swapXy;
+        return new VPL([...this.steps, { name: 'remap_coords', params }]);
+    }
     /** Generate lower-zoom DEM overview tiles by averaging 24-bit elevation values. */
     demOverview(options) {
         const params = {};
@@ -257,7 +317,7 @@ export class VPL {
             params['gamma'] = options?.gamma;
         return new VPL([...this.steps, { name: 'raster_levels', params }]);
     }
-    /** Apply a polygon mask from GeoJSON to raster tiles. */
+    /** Apply a polygon mask from GeoJSON to raster tiles. Pixels outside the polygon become transparent. */
     rasterMask(options) {
         const params = {};
         params['geojson'] = options.geojson;
@@ -294,7 +354,7 @@ export class VPL {
             params['tile_size'] = options?.tileSize;
         return new VPL([...this.steps, { name: 'raster_tile_resize', params }]);
     }
-    /** Drops vector features in selected layers that do not satisfy a boolean CEL expression. */
+    /** Drops vector features in selected layers that do not satisfy a boolean CEL expression. Features in layers outside `layer` pass through untouched. */
     vectorFilterFeatures(options) {
         const params = {};
         params['layer'] = options.layer;
@@ -358,17 +418,7 @@ export class VPL {
     }
     /** Serialize this VPL pipeline to a string. */
     toString() {
-        return this.steps.map(step => {
-            let result = step.name;
-            if (step.sources && step.sources.length > 0) {
-                const pipelines = step.sources.map(s => s.toString());
-                result += ' [ ' + pipelines.join(', ') + ' ]';
-            }
-            for (const [key, value] of Object.entries(step.params)) {
-                result += ' ' + serializeParam(key, value);
-            }
-            return result;
-        }).join(' | ');
+        return stringifyVpl(JSON.stringify(this.toJSON()));
     }
     /** Convert this VPL pipeline to a JSON-serializable array of steps. */
     toJSON() {
@@ -380,6 +430,29 @@ export class VPL {
             return obj;
         });
     }
+    /** A syntax error, with byte offsets into the parsed text. */
+    static parseError(vpl) {
+        const result = JSON.parse(parseVpl(vpl));
+        return result.ok ? undefined : result.error;
+    }
+    /** Rebuild a pipeline from the JSON form, nesting child pipelines as VPL. */
+    static fromJSON(steps) {
+        return new VPL(steps.map(step => ({
+            name: step.name,
+            params: step.params,
+            sources: step.sources?.map(source => VPL.fromJSON(source)),
+        })));
+    }
+    /** Parse VPL text, throwing on a syntax error. */
+    static parse(vpl) {
+        const result = JSON.parse(parseVpl(vpl));
+        if (!result.ok) {
+            const error = new SyntaxError(result.error.message);
+            error.vpl = result.error;
+            throw error;
+        }
+        return VPL.fromJSON(result.pipeline);
+    }
     /** Execute this VPL pipeline and return a TileSource. */
     async fromPath(dir) {
         return TileSource.fromPipeline(JSON.stringify(this.toJSON()), dir);