@loaders.gl/mvt 3.1.8 → 3.2.0-alpha.3

package/dist/lib/types.d.ts

@@ -1,28 +1,69 @@
-export declare type MvtOptions = {
-    coordinates: string | number[];
+import type { LoaderOptions } from '@loaders.gl/loader-utils';
+/** For local coordinates, the tileIndex is not required */
+declare type MVTLocalCoordinatesOptions = {
+    /**
+     * When set to `local`, the parser will return a flat array of GeoJSON objects with local coordinates decoded from tile origin.
+     */
+    coordinates: 'local';
+    tileIndex: null;
+};
+/** In WGS84 coordinates, the tileIndex is required */
+declare type MVTWgs84CoordinatesOptions = {
+    /**
+     * When set to `wgs84`, the parser will return a flat array of GeoJSON objects with coordinates in longitude, latitude decoded from the provided tile index.
+     */
+    coordinates: 'wgs84';
+    /**
+     * Mandatory with `wgs84` coordinates option. An object containing tile index values (`x`, `y`,
+     * `z`) to reproject features' coordinates into WGS84.
+     */
     tileIndex: {
         x: number;
         y: number;
         z: number;
     };
-    layerProperty: string | number;
-    layerName: string;
 };
-export declare type MvtMapboxGeometry = {
+export declare type MVTOptions = (MVTLocalCoordinatesOptions | MVTWgs84CoordinatesOptions) & {
+    /**
+     * When non-`null`, the layer name of each feature is added to
+     * `feature.properties[layerProperty]`. (A `feature.properties` object is created if the feature
+     * has no existing properties). If set to `null`, a layer name property will not be added.
+     */
+    layerProperty?: string | number;
+    /**
+     * Optional list of layer names. If not `null`, only features belonging to the named layers will
+     * be included in the output. If `null`, features from all layers are returned.
+     */
+    layers?: string[];
+    shape?: 'geojson-row-table' | 'columnar-table' | 'geojson' | 'binary' | 'binary-geometry';
+};
+export declare type MVTMapboxGeometry = {
     type?: string;
     id?: number;
     length: number;
     coordinates?: any[];
 };
-export declare type MvtMapboxCoordinates = {
+export declare type MVTMapboxCoordinates = {
     type: string;
     geometry: {
         type: string;
-        coordinates: MvtMapboxGeometry;
+        coordinates: MVTMapboxGeometry;
     };
     properties: {
         [x: string]: string | number | boolean | null;
     };
     id?: number;
 };
+export declare type MVTLoaderOptions = LoaderOptions & {
+    mvt?: MVTOptions;
+    gis?: {
+        /**
+         * When set to `true`, the parser will output the data in binary format. This is equivalent to loading the data as GeoJSON and then applying [geojsonToBinary](https://loaders.gl/modules/gis/docs/api-reference/geojson-to-binary).
+         */
+        binary?: boolean;
+        /** @deprecated. Use options.mvt.shape */
+        format?: 'geojson-row-table' | 'columnar-table' | 'geojson' | 'binary' | 'binary-geometry';
+    };
+};
+export {};
 //# sourceMappingURL=types.d.ts.map

package/dist/lib/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/lib/types.ts"],"names":[],"mappings":"AAAA,oBAAY,UAAU,GAAG;IACvB,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC/B,SAAS,EAAE;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAC,CAAC;IAC7C,aAAa,EAAE,MAAM,GAAG,MAAM,CAAC;IAC/B,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,oBAAY,iBAAiB,GAAG;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,GAAG,EAAE,CAAC;CACrB,CAAC;AAEF,oBAAY,oBAAoB,GAAG;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE;QACR,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,iBAAiB,CAAC;KAChC,CAAC;IACF,UAAU,EAAE;QAAC,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAA;KAAC,CAAC;IAC5D,EAAE,CAAC,EAAE,MAAM,CAAC;CACb,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/lib/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,0BAA0B,CAAC;AAE5D,2DAA2D;AAC3D,aAAK,0BAA0B,GAAG;IAChC;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IACrB,SAAS,EAAE,IAAI,CAAC;CACjB,CAAC;AAEF,sDAAsD;AACtD,aAAK,0BAA0B,GAAG;IAChC;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;;OAGG;IACH,SAAS,EAAE;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAC,CAAC;CAC9C,CAAC;AAEF,oBAAY,UAAU,GAAG,CAAC,0BAA0B,GAAG,0BAA0B,CAAC,GAAG;IACnF;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAEhC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,KAAK,CAAC,EAAE,mBAAmB,GAAG,gBAAgB,GAAG,SAAS,GAAG,QAAQ,GAAG,iBAAiB,CAAC;CAC3F,CAAC;AAEF,oBAAY,iBAAiB,GAAG;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,GAAG,EAAE,CAAC;CACrB,CAAC;AAEF,oBAAY,oBAAoB,GAAG;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE;QACR,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,iBAAiB,CAAC;KAChC,CAAC;IACF,UAAU,EAAE;QAAC,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAA;KAAC,CAAC;IAC5D,EAAE,CAAC,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,oBAAY,gBAAgB,GAAG,aAAa,GAAG;IAC7C,GAAG,CAAC,EAAE,UAAU,CAAC;IACjB,GAAG,CAAC,EAAE;QACJ;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,yCAAyC;QACzC,MAAM,CAAC,EAAE,mBAAmB,GAAG,gBAAgB,GAAG,SAAS,GAAG,QAAQ,GAAG,iBAAiB,CAAC;KAC5F,CAAC;CACH,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"mvt-loader.d.ts","sourceRoot":"","sources":["../src/mvt-loader.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,MAAM,EAAE,gBAAgB,EAAC,MAAM,0BAA0B,CAAC;AAOvE;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,MAsB7B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,SAAS,EAAE,gBAKvB,CAAC"}
+{"version":3,"file":"mvt-loader.d.ts","sourceRoot":"","sources":["../src/mvt-loader.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,MAAM,EAAE,gBAAgB,EAAC,MAAM,0BAA0B,CAAC;AAkBvE;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,MAe7B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,SAAS,EAAE,gBAKvB,CAAC"}

package/dist/mvt-loader.js

@@ -8,6 +8,15 @@ const parse_mvt_1 = __importDefault(require("./lib/parse-mvt"));
 // __VERSION__ is injected by babel-plugin-version-inline
 // @ts-ignore TS2304: Cannot find name '__VERSION__'.
 const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';
+const DEFAULT_MVT_LOADER_OPTIONS = {
+    mvt: {
+        shape: 'geojson',
+        coordinates: 'local',
+        layerProperty: 'layerName',
+        layers: undefined,
+        tileIndex: null
+    }
+};
 /**
  * Worker loader for the Mapbox Vector Tile format
  */
@@ -25,14 +34,7 @@ exports.MVTWorkerLoader = {
     ],
     worker: true,
     category: 'geometry',
-    options: {
-        mvt: {
-            coordinates: 'local',
-            layerProperty: 'layerName',
-            layers: null,
-            tileIndex: null
-        }
-    }
+    options: DEFAULT_MVT_LOADER_OPTIONS
 };
 /**
  * Loader for the Mapbox Vector Tile format