@loaders.gl/mvt 4.2.1 → 4.3.0-alpha.1

package/dist/lib/vector-tile/vector-tile-feature.js

@@ -0,0 +1,345 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright vis.gl contributors
+import { classifyRings, classifyRingsFlat, projectToLngLatFlat } from "../utils/geometry-utils.js";
+export class VectorTileFeature {
+    properties;
+    extent;
+    type;
+    id;
+    _pbf;
+    _geometry;
+    _keys;
+    _values;
+    _geometryInfo;
+    static types = ['Unknown', 'Point', 'LineString', 'Polygon'];
+    // eslint-disable-next-line max-params
+    constructor(pbf, end, extent, keys, values, geometryInfo) {
+        // Public
+        this.properties = {};
+        this.extent = extent;
+        this.type = 0;
+        this.id = null;
+        // Private
+        this._pbf = pbf;
+        this._geometry = -1;
+        this._keys = keys;
+        this._values = values;
+        // Only used by binary tiles
+        this._geometryInfo = geometryInfo;
+        pbf.readFields(readFeature, this, end);
+    }
+    toGeoJSON(options) {
+        const coords = this.loadGeometry();
+        if (typeof options === 'function') {
+            return _toGeoJSON(this, coords, options);
+        }
+        const { x, y, z } = options;
+        const size = this.extent * Math.pow(2, z);
+        const x0 = this.extent * x;
+        const y0 = this.extent * y;
+        function project(line) {
+            for (let j = 0; j < line.length; j++) {
+                const p = line[j];
+                p[0] = ((p[0] + x0) * 360) / size - 180;
+                const y2 = 180 - ((p[1] + y0) * 360) / size;
+                p[1] = (360 / Math.PI) * Math.atan(Math.exp((y2 * Math.PI) / 180)) - 90;
+            }
+        }
+        return _toGeoJSON(this, coords, project);
+    }
+    /**
+     *
+     * @param options
+     * @returns
+     */
+    toBinaryCoordinates(options) {
+        if (typeof options === 'function') {
+            return this._toBinaryCoordinates(options);
+        }
+        const tileIndex = options;
+        return this._toBinaryCoordinates((data) => projectToLngLatFlat(data, tileIndex, this.extent));
+    }
+    // eslint-disable-next-line max-statements
+    bbox() {
+        const pbf = this._pbf;
+        pbf.pos = this._geometry;
+        const end = pbf.readVarint() + pbf.pos;
+        let cmd = 1;
+        let length = 0;
+        let x = 0;
+        let y = 0;
+        let x1 = Infinity;
+        let x2 = -Infinity;
+        let y1 = Infinity;
+        let y2 = -Infinity;
+        while (pbf.pos < end) {
+            if (length <= 0) {
+                const cmdLen = pbf.readVarint();
+                cmd = cmdLen & 0x7;
+                length = cmdLen >> 3;
+            }
+            length--;
+            if (cmd === 1 || cmd === 2) {
+                x += pbf.readSVarint();
+                y += pbf.readSVarint();
+                if (x < x1)
+                    x1 = x;
+                if (x > x2)
+                    x2 = x;
+                if (y < y1)
+                    y1 = y;
+                if (y > y2)
+                    y2 = y;
+            }
+            else if (cmd !== 7) {
+                throw new Error(`unknown command ${cmd}`);
+            }
+        }
+        return [x1, y1, x2, y2];
+    }
+    // BINARY HELPERS
+    /**
+     *
+     * @param transform
+     * @returns result
+     */
+    _toBinaryCoordinates(transform) {
+        // Expands the protobuf data to an intermediate Flat GeoJSON
+        // data format, which maps closely to the binary data buffers.
+        // It is similar to GeoJSON, but rather than storing the coordinates
+        // in multidimensional arrays, we have a 1D `data` with all the
+        // coordinates, and then index into this using the `indices`
+        // parameter, e.g.
+        //
+        // geometry: {
+        //   type: 'Point', data: [1,2], indices: [0]
+        // }
+        // geometry: {
+        //   type: 'LineString', data: [1,2,3,4,...], indices: [0]
+        // }
+        // geometry: {
+        //   type: 'Polygon', data: [1,2,3,4,...], indices: [[0, 2]]
+        // }
+        // Thus the indices member lets us look up the relevant range
+        // from the data array.
+        // The Multi* versions of the above types share the same data
+        // structure, just with multiple elements in the indices array
+        const geom = this.loadFlatGeometry();
+        let geometry;
+        // Apply the supplied transformation to data
+        transform(geom.data, this);
+        const coordLength = 2;
+        // eslint-disable-next-line default-case
+        switch (this.type) {
+            case 1: // Point
+                this._geometryInfo.pointFeaturesCount++;
+                this._geometryInfo.pointPositionsCount += geom.indices.length;
+                geometry = { type: 'Point', ...geom };
+                break;
+            case 2: // LineString
+                this._geometryInfo.lineFeaturesCount++;
+                this._geometryInfo.linePathsCount += geom.indices.length;
+                this._geometryInfo.linePositionsCount += geom.data.length / coordLength;
+                geometry = { type: 'LineString', ...geom };
+                break;
+            case 3: // Polygon
+                geometry = classifyRingsFlat(geom);
+                // Unlike Point & LineString geom.indices is a 2D array, thanks
+                // to the classifyRings method
+                this._geometryInfo.polygonFeaturesCount++;
+                this._geometryInfo.polygonObjectsCount += geometry.indices.length;
+                for (const indices of geometry.indices) {
+                    this._geometryInfo.polygonRingsCount += indices.length;
+                }
+                this._geometryInfo.polygonPositionsCount += geometry.data.length / coordLength;
+                break;
+            default:
+                throw new Error(`Invalid geometry type: ${this.type}`);
+        }
+        const result = { type: 'Feature', geometry, properties: this.properties };
+        if (this.id !== null) {
+            result.id = this.id;
+        }
+        return result;
+    }
+    // GEOJSON HELPER
+    // eslint-disable-next-line complexity, max-statements
+    loadGeometry() {
+        const pbf = this._pbf;
+        pbf.pos = this._geometry;
+        const end = pbf.readVarint() + pbf.pos;
+        let cmd = 1;
+        let length = 0;
+        let x = 0;
+        let y = 0;
+        const lines = [];
+        let line;
+        while (pbf.pos < end) {
+            if (length <= 0) {
+                const cmdLen = pbf.readVarint();
+                cmd = cmdLen & 0x7;
+                length = cmdLen >> 3;
+            }
+            length--;
+            switch (cmd) {
+                case 1:
+                case 2:
+                    x += pbf.readSVarint();
+                    y += pbf.readSVarint();
+                    if (cmd === 1) {
+                        // moveTo
+                        if (line)
+                            lines.push(line);
+                        line = [];
+                    }
+                    if (line)
+                        line.push([x, y]);
+                    break;
+                case 7:
+                    // Workaround for https://github.com/mapbox/mapnik-vector-tile/issues/90
+                    if (line) {
+                        line.push(line[0].slice()); // closePolygon
+                    }
+                    break;
+                default:
+                    throw new Error(`unknown command ${cmd}`);
+            }
+        }
+        if (line)
+            lines.push(line);
+        return lines;
+    }
+    // eslint-disable-next-line complexity, max-statements
+    loadFlatGeometry() {
+        const pbf = this._pbf;
+        pbf.pos = this._geometry;
+        const endPos = pbf.readVarint() + pbf.pos;
+        let cmd = 1;
+        let cmdLen;
+        let length = 0;
+        let x = 0;
+        let y = 0;
+        let i = 0;
+        // Note: I attempted to replace the `data` array with a
+        // Float32Array, but performance was worse, both using
+        // `set()` and direct index access. Also, we cannot
+        // know how large the buffer should be, so it would
+        // increase memory usage
+        const indices = []; // Indices where geometries start
+        const data = []; // Flat array of coordinate data
+        while (pbf.pos < endPos) {
+            if (length <= 0) {
+                cmdLen = pbf.readVarint();
+                cmd = cmdLen & 0x7;
+                length = cmdLen >> 3;
+            }
+            length--;
+            if (cmd === 1 || cmd === 2) {
+                x += pbf.readSVarint();
+                y += pbf.readSVarint();
+                if (cmd === 1) {
+                    // New line
+                    indices.push(i);
+                }
+                data.push(x, y);
+                i += 2;
+            }
+            else if (cmd === 7) {
+                // Workaround for https://github.com/mapbox/mapnik-vector-tile/issues/90
+                if (i > 0) {
+                    const start = indices[indices.length - 1]; // start index of polygon
+                    data.push(data[start], data[start + 1]); // closePolygon
+                    i += 2;
+                }
+            }
+            else {
+                throw new Error(`unknown command ${cmd}`);
+            }
+        }
+        return { data, indices };
+    }
+}
+function _toGeoJSON(vtFeature, coords, transform) {
+    let type = VectorTileFeature.types[vtFeature.type];
+    let i;
+    let j;
+    let coordinates;
+    switch (vtFeature.type) {
+        case 1:
+            const points = [];
+            for (i = 0; i < coords.length; i++) {
+                points[i] = coords[i][0];
+            }
+            coordinates = points;
+            transform(coordinates, vtFeature);
+            break;
+        case 2:
+            coordinates = coords;
+            for (i = 0; i < coordinates.length; i++) {
+                transform(coordinates[i], vtFeature);
+            }
+            break;
+        case 3:
+            coordinates = classifyRings(coords);
+            for (i = 0; i < coordinates.length; i++) {
+                for (j = 0; j < coordinates[i].length; j++) {
+                    transform(coordinates[i][j], vtFeature);
+                }
+            }
+            break;
+        default:
+            throw new Error('illegal vector tile type');
+    }
+    if (coordinates.length === 1) {
+        // @ts-expect-error
+        coordinates = coordinates[0];
+    }
+    else {
+        type = `Multi${type}`;
+    }
+    const result = {
+        type: 'Feature',
+        geometry: {
+            type: type,
+            coordinates: coordinates
+        },
+        properties: vtFeature.properties
+    };
+    if (vtFeature.id !== null) {
+        result.id = vtFeature.id;
+    }
+    return result;
+}
+// PBF READER UTILS
+/**
+ *
+ * @param tag
+ * @param feature
+ * @param pbf
+ */
+function readFeature(tag, feature, pbf) {
+    if (feature && pbf) {
+        if (tag === 1)
+            feature.id = pbf.readVarint();
+        else if (tag === 2)
+            readTag(pbf, feature);
+        else if (tag === 3)
+            feature.type = pbf.readVarint();
+        else if (tag === 4)
+            feature._geometry = pbf.pos;
+    }
+}
+/**
+ *
+ * @param pbf
+ * @param feature
+ */
+function readTag(pbf, feature) {
+    const end = pbf.readVarint() + pbf.pos;
+    while (pbf.pos < end) {
+        const key = feature._keys[pbf.readVarint()];
+        const value = feature._values[pbf.readVarint()];
+        feature.properties[key] = value;
+    }
+}

package/dist/lib/{mapbox-vector-tile → vector-tile}/vector-tile-layer.d.ts

@@ -1,5 +1,6 @@
 import Protobuf from 'pbf';
 import { VectorTileFeature } from "./vector-tile-feature.js";
+import { GeojsonGeometryInfo } from '@loaders.gl/schema';
 export declare class VectorTileLayer {
     version: number;
     name: string;
@@ -15,6 +16,14 @@ export declare class VectorTileLayer {
      * @param index
      * @returns feature
      */
-    feature(i: number): VectorTileFeature;
+    getGeoJSONFeature(i: number): VectorTileFeature;
+    /**
+     * return binary feature `i` from this layer as a `VectorTileFeature`
+     *
+     * @param index
+     * @param geometryInfo
+     * @returns binary feature
+     */
+    getBinaryFeature(i: number, geometryInfo: GeojsonGeometryInfo): VectorTileFeature;
 }
 //# sourceMappingURL=vector-tile-layer.d.ts.map

package/dist/lib/vector-tile/vector-tile-layer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vector-tile-layer.d.ts","sourceRoot":"","sources":["../../../src/lib/vector-tile/vector-tile-layer.ts"],"names":[],"mappings":"AAOA,OAAO,QAAQ,MAAM,KAAK,CAAC;AAC3B,OAAO,EAAC,iBAAiB,EAAC,iCAA8B;AACxD,OAAO,EAAC,mBAAmB,EAAC,MAAM,oBAAoB,CAAC;AAEvD,qBAAa,eAAe;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,QAAQ,CAAC;IACf,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,OAAO,EAAE,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC,EAAE,CAAC;IAC9C,SAAS,EAAE,MAAM,EAAE,CAAC;gBAER,GAAG,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM;IAkBtC;;;;OAIG;IACH,iBAAiB,CAAC,CAAC,EAAE,MAAM,GAAG,iBAAiB;IAW/C;;;;;;OAMG;IACH,gBAAgB,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,mBAAmB,GAAG,iBAAiB;CAiBlF"}

package/dist/lib/{mapbox-vector-tile → vector-tile}/vector-tile-layer.js

@@ -30,7 +30,7 @@ export class VectorTileLayer {
      * @param index
      * @returns feature
      */
-    feature(i) {
+    getGeoJSONFeature(i) {
         if (i < 0 || i >= this._features.length) {
             throw new Error('feature index out of bounds');
         }
@@ -38,6 +38,21 @@ export class VectorTileLayer {
         const end = this._pbf.readVarint() + this._pbf.pos;
         return new VectorTileFeature(this._pbf, end, this.extent, this._keys, this._values);
     }
+    /**
+     * return binary feature `i` from this layer as a `VectorTileFeature`
+     *
+     * @param index
+     * @param geometryInfo
+     * @returns binary feature
+     */
+    getBinaryFeature(i, geometryInfo) {
+        if (i < 0 || i >= this._features.length) {
+            throw new Error('feature index out of bounds');
+        }
+        this._pbf.pos = this._features[i];
+        const end = this._pbf.readVarint() + this._pbf.pos;
+        return new VectorTileFeature(this._pbf, end, this.extent, this._keys, this._values, geometryInfo);
+    }
 }
 /**
  *

package/dist/lib/vector-tile/vector-tile.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vector-tile.d.ts","sourceRoot":"","sources":["../../../src/lib/vector-tile/vector-tile.ts"],"names":[],"mappings":"AAMA,OAAO,EAAC,eAAe,EAAC,+BAA4B;AACpD,OAAO,QAAQ,MAAM,KAAK,CAAC;AAE3B,qBAAa,UAAU;IACrB,MAAM,EAAE;QAAC,CAAC,CAAC,EAAE,MAAM,GAAG,eAAe,CAAA;KAAC,CAAC;gBAC3B,GAAG,EAAE,QAAQ,EAAE,GAAG,CAAC,EAAE,MAAM;CAGxC"}

package/dist/mvt-loader.d.ts

@@ -1,14 +1,25 @@
 import type { LoaderOptions } from '@loaders.gl/loader-utils';
 import { parseMVT } from "./lib/parse-mvt.js";
-import type { MVTOptions } from "./lib/types.js";
 export type MVTLoaderOptions = LoaderOptions & {
-    mvt?: MVTOptions & {
+    mvt?: {
+        /** Shape of returned data */
+        shape?: 'geojson-table' | 'columnar-table' | 'geojson' | 'binary' | 'binary-geometry';
+        /** `wgs84`: coordinates in long, lat (`tileIndex` must be provided. `local` coordinates are `0-1` from tile origin */
+        coordinates?: 'wgs84' | 'local';
+        /** An object containing tile index values (`x`, `y`, `z`) to reproject features' coordinates into WGS84. Mandatory with `wgs84` coordinates option. */
+        tileIndex?: {
+            x: number;
+            y: number;
+            z: number;
+        };
+        /** If provided, stored the layer name of each feature is added to `feature.properties[layerProperty]`. */
+        layerProperty?: string | number;
+        /** layer filter. If provided, only features belonging to the named layers will be included, otherwise features from all layers are returned. */
+        layers?: string[];
         /** Override the URL to the worker bundle (by default loads from unpkg.com) */
         workerUrl?: string;
     };
     gis?: {
-        /** `true`: parser will output the data in binary format. Equivalent to loading the data as GeoJSON and then applying geojsonToBinary */
-        binary?: boolean;
         /** @deprecated. Use options.mvt.shape */
         format?: 'geojson-table' | 'columnar-table' | 'geojson' | 'binary' | 'binary-geometry';
     };
@@ -32,8 +43,8 @@ export declare const MVTWorkerLoader: {
             readonly shape: "geojson";
             readonly coordinates: "local";
             readonly layerProperty: "layerName";
-            readonly layers: undefined;
-            readonly tileIndex: null;
+            readonly layers: never;
+            readonly tileIndex: never;
         };
     };
 };
@@ -41,7 +52,7 @@ export declare const MVTWorkerLoader: {
  * Loader for the Mapbox Vector Tile format
  */
 export declare const MVTLoader: {
-    readonly parse: (arrayBuffer: ArrayBuffer, options?: MVTLoaderOptions) => Promise<import("@loaders.gl/schema").BinaryFeatureCollection | import("@loaders.gl/schema").GeoJSONTable | import("geojson").Feature<import("geojson").Geometry, import("geojson").GeoJsonProperties>[] | {
+    readonly parse: (arrayBuffer: ArrayBuffer, options?: MVTLoaderOptions) => Promise<import("@loaders.gl/schema").GeoJSONTable | import("geojson").Feature<import("geojson").Geometry, import("geojson").GeoJsonProperties>[] | import("@loaders.gl/schema").BinaryFeatureCollection | {
         shape: string;
         data: import("@loaders.gl/schema").BinaryFeatureCollection;
     }>;
@@ -62,8 +73,8 @@ export declare const MVTLoader: {
             readonly shape: "geojson";
             readonly coordinates: "local";
             readonly layerProperty: "layerName";
-            readonly layers: undefined;
-            readonly tileIndex: null;
+            readonly layers: never;
+            readonly tileIndex: never;
         };
     };
 };

package/dist/mvt-loader.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mvt-loader.d.ts","sourceRoot":"","sources":["../src/mvt-loader.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAA2B,aAAa,EAAC,MAAM,0BAA0B,CAAC;AACtF,OAAO,EAAC,QAAQ,EAAC,2BAAwB;AACzC,OAAO,KAAK,EAAC,UAAU,EAAC,uBAAoB;AAM5C,MAAM,MAAM,gBAAgB,GAAG,aAAa,GAAG;IAC7C,GAAG,CAAC,EAAE,UAAU,GAAG;QACjB,8EAA8E;QAC9E,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;IACF,GAAG,CAAC,EAAE;QACJ,wIAAwI;QACxI,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,yCAAyC;QACzC,MAAM,CAAC,EAAE,eAAe,GAAG,gBAAgB,GAAG,SAAS,GAAG,QAAQ,GAAG,iBAAiB,CAAC;KACxF,CAAC;CACH,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;CA+B3B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,SAAS;yDAEiB,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;CAOtD,CAAC"}
+{"version":3,"file":"mvt-loader.d.ts","sourceRoot":"","sources":["../src/mvt-loader.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAA2B,aAAa,EAAC,MAAM,0BAA0B,CAAC;AAEtF,OAAO,EAAC,QAAQ,EAAC,2BAAwB;AAMzC,MAAM,MAAM,gBAAgB,GAAG,aAAa,GAAG;IAC7C,GAAG,CAAC,EAAE;QACJ,6BAA6B;QAC7B,KAAK,CAAC,EAAE,eAAe,GAAG,gBAAgB,GAAG,SAAS,GAAG,QAAQ,GAAG,iBAAiB,CAAC;QACtF,sHAAsH;QACtH,WAAW,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;QAChC,uJAAuJ;QACvJ,SAAS,CAAC,EAAE;YAAC,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAA;SAAC,CAAC;QAC9C,0GAA0G;QAC1G,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAChC,gJAAgJ;QAChJ,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;QAClB,8EAA8E;QAC9E,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;IACF,GAAG,CAAC,EAAE;QACJ,yCAAyC;QACzC,MAAM,CAAC,EAAE,eAAe,GAAG,gBAAgB,GAAG,SAAS,GAAG,QAAQ,GAAG,iBAAiB,CAAC;KACxF,CAAC;CACH,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;CA+B3B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,SAAS;yDAEiB,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;CAOtD,CAAC"}

package/dist/mvt-loader.js

@@ -1,6 +1,7 @@
 // loaders.gl
 // SPDX-License-Identifier: MIT
 // Copyright vis.gl contributors
+// import type {MVTOptions} from './lib/types';
 import { parseMVT } from "./lib/parse-mvt.js";
 // __VERSION__ is injected by babel-plugin-version-inline
 // @ts-ignore TS2304: Cannot find name '__VERSION__'.
@@ -31,7 +32,7 @@ export const MVTWorkerLoader = {
             coordinates: 'local',
             layerProperty: 'layerName',
             layers: undefined,
-            tileIndex: null
+            tileIndex: undefined
         }
     }
 };

package/dist/mvt-source.js

@@ -68,7 +68,7 @@ export class MVTSource extends DataSource {
         return this.mimeType;
     }
     async getTile(tileParams) {
-        const { x, y, zoom: z } = tileParams;
+        const { x, y, z } = tileParams;
         const tileUrl = this.getTileURL(x, y, z);
         const response = await this.fetch(tileUrl);
         if (!response.ok) {
@@ -83,7 +83,7 @@ export class MVTSource extends DataSource {
         const { x, y, z } = tileParams.index;
         // const metadata = await this.metadata;
         // mimeType = metadata?.tileMIMEType || 'application/vnd.mapbox-vector-tile';
-        const arrayBuffer = await this.getTile({ x, y, zoom: z, layers: [] });
+        const arrayBuffer = await this.getTile({ x, y, z, layers: [] });
         if (arrayBuffer === null) {
             return null;
         }
@@ -92,7 +92,7 @@ export class MVTSource extends DataSource {
             this.mimeType || imageMetadata?.mimeType || 'application/vnd.mapbox-vector-tile';
         switch (this.mimeType) {
             case 'application/vnd.mapbox-vector-tile':
-                return await this._parseVectorTile(arrayBuffer, { x, y, zoom: z, layers: [] });
+                return await this._parseVectorTile(arrayBuffer, { x, y, z, layers: [] });
             default:
                 return await this._parseImageTile(arrayBuffer);
         }
@@ -115,7 +115,7 @@ export class MVTSource extends DataSource {
             shape: 'geojson-table',
             mvt: {
                 coordinates: 'wgs84',
-                tileIndex: { x: tileParams.x, y: tileParams.y, z: tileParams.zoom },
+                tileIndex: { x: tileParams.x, y: tileParams.y, z: tileParams.z },
                 ...this.loadOptions?.mvt
             },
             ...this.loadOptions