@deck.gl/carto 8.9.24 → 8.9.25

package/package.json

@@ -2,7 +2,7 @@
   "name": "@deck.gl/carto",
   "description": "CARTO official integration with Deck.gl. Build geospatial applications using CARTO and Deck.gl.",
   "license": "MIT",
-  "version": "8.9.24",
+  "version": "8.9.25",
   "publishConfig": {
     "access": "public"
   },
@@ -28,7 +28,9 @@
   ],
   "sideEffects": false,
   "scripts": {
-    "build-bundle": "ocular-bundle ./bundle.ts",
+    "build-bundle": "npm run build-workers && ocular-bundle ./bundle.ts",
+    "build-workers": "npm run build-worker --cartoloader=RasterTile && npm run build-worker --cartoloader=SpatialTile && npm run build-worker --cartoloader=VectorTile",
+    "build-worker": "esbuild src/workers/carto$npm_config_cartoloader.ts --bundle --outfile=dist/carto$npm_config_cartoloader-worker.js --define:__VERSION__=\\\"$npm_package_version\\\"",
     "prepublishOnly": "npm run build-bundle && npm run build-bundle -- --env=dev"
   },
   "dependencies": {
@@ -63,5 +65,5 @@
     "@deck.gl/layers": "^8.0.0",
     "@loaders.gl/core": "^3.4.2"
   },
-  "gitHead": "9301941c03dc97beb95e92581150c4375df875af"
+  "gitHead": "f292dd419819aa9e0a66f3d93f90936d03d8cbe9"
 }

package/src/layers/schema/carto-raster-tile-loader.ts

@@ -2,20 +2,37 @@ import {LoaderOptions, LoaderWithParser} from '@loaders.gl/loader-utils';
 
 import {TileReader} from './carto-raster-tile';
 import {parsePbf} from './tile-loader-utils';
+import {getWorkerUrl} from '../../utils';
 import {NumericProps, Properties} from './spatialjson-utils';
 
+const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';
+const id = 'cartoRasterTile';
+
+type CartoRasterTileLoaderOptions = LoaderOptions & {
+  cartoRasterTile?: {
+    workerUrl: string;
+  };
+};
+
+const DEFAULT_OPTIONS: CartoRasterTileLoaderOptions = {
+  cartoRasterTile: {
+    workerUrl: getWorkerUrl(id, VERSION)
+  }
+};
+
 const CartoRasterTileLoader: LoaderWithParser = {
   name: 'CARTO Raster Tile',
-  version: '1',
-  id: 'cartoRasterTile',
+  version: VERSION,
+  id,
   module: 'carto',
   extensions: ['pbf'],
   mimeTypes: ['application/vnd.carto-raster-tile'],
   category: 'geometry',
-  worker: false,
-  parse: async (arrayBuffer, options) => parseCartoRasterTile(arrayBuffer, options),
+  parse: async (arrayBuffer, options?: CartoRasterTileLoaderOptions) =>
+    parseCartoRasterTile(arrayBuffer, options),
   parseSync: parseCartoRasterTile,
-  options: {}
+  worker: false, // TODO set to true once workers deployed to unpkg
+  options: DEFAULT_OPTIONS
 };
 
 export type Raster = {
@@ -27,7 +44,10 @@ export type Raster = {
   };
 };
 
-function parseCartoRasterTile(arrayBuffer: ArrayBuffer, options?: LoaderOptions): Raster | null {
+function parseCartoRasterTile(
+  arrayBuffer: ArrayBuffer,
+  options?: CartoRasterTileLoaderOptions
+): Raster | null {
   if (!arrayBuffer) return null;
   const tile = parsePbf(arrayBuffer, TileReader);
   const {bands, blockHeight, blockWidth} = tile;

package/src/layers/schema/carto-spatial-tile-loader.ts

@@ -2,35 +2,49 @@ import {LoaderOptions, LoaderWithParser} from '@loaders.gl/loader-utils';
 
 import {Tile, TileReader} from './carto-spatial-tile';
 import {parsePbf} from './tile-loader-utils';
+import {getWorkerUrl} from '../../utils';
 import {IndexScheme, binaryToSpatialjson, SpatialJson} from './spatialjson-utils';
 
+const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';
+const id = 'cartoSpatialTile';
+
+type CartoSpatialTileLoaderOptions = LoaderOptions & {
+  cartoSpatialTile?: {
+    scheme: IndexScheme;
+    workerUrl: string;
+  };
+};
+
+const DEFAULT_OPTIONS: CartoSpatialTileLoaderOptions = {
+  cartoSpatialTile: {
+    scheme: 'quadbin',
+    workerUrl: getWorkerUrl(id, VERSION)
+  }
+};
+
 const CartoSpatialTileLoader: LoaderWithParser = {
   name: 'CARTO Spatial Tile',
-  version: '1',
-  id: 'cartoSpatialTile',
+  version: VERSION,
+  id,
   module: 'carto',
   extensions: ['pbf'],
   mimeTypes: ['application/vnd.carto-spatial-tile'],
   category: 'geometry',
-  worker: false,
-  parse: async (arrayBuffer, options) => parseCartoSpatialTile(arrayBuffer, options),
+  parse: async (arrayBuffer, options?: CartoSpatialTileLoaderOptions) =>
+    parseCartoSpatialTile(arrayBuffer, options),
   parseSync: parseCartoSpatialTile,
-  options: {
-    cartoSpatialTile: {
-      scheme: 'quadbin'
-    } as {scheme: IndexScheme}
-  }
+  worker: false, // TODO set to true once workers deployed to unpkg
+  options: DEFAULT_OPTIONS
 };
 
 function parseCartoSpatialTile(
   arrayBuffer: ArrayBuffer,
-  options?: LoaderOptions
+  options?: CartoSpatialTileLoaderOptions
 ): SpatialJson | null {
   if (!arrayBuffer) return null;
   const tile: Tile = parsePbf(arrayBuffer, TileReader);
 
   const {cells} = tile;
-  // @ts-expect-error
   const scheme = options?.cartoSpatialTile?.scheme;
   const data = {cells, scheme};
 

package/src/layers/schema/carto-vector-tile-loader.ts

@@ -3,24 +3,41 @@ import type {BinaryFeatures} from '@loaders.gl/schema';
 
 import {TileReader} from './carto-tile';
 import {parsePbf} from './tile-loader-utils';
+import {getWorkerUrl} from '../../utils';
+
+const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';
+const id = 'cartoVectorTile';
+
+type CartoVectorTileLoaderOptions = LoaderOptions & {
+  cartoVectorTile?: {
+    workerUrl: string;
+  };
+};
+
+const DEFAULT_OPTIONS: CartoVectorTileLoaderOptions = {
+  cartoVectorTile: {
+    workerUrl: getWorkerUrl(id, VERSION)
+  }
+};
 
 const CartoVectorTileLoader: LoaderWithParser = {
   name: 'CARTO Vector Tile',
-  version: '1',
-  id: 'cartoVectorTile',
+  version: VERSION,
+  id,
   module: 'carto',
   extensions: ['pbf'],
   mimeTypes: ['application/vnd.carto-vector-tile'],
   category: 'geometry',
-  worker: false,
-  parse: async (arrayBuffer, options) => parseCartoVectorTile(arrayBuffer, options),
+  parse: async (arrayBuffer, options?: CartoVectorTileLoaderOptions) =>
+    parseCartoVectorTile(arrayBuffer, options),
   parseSync: parseCartoVectorTile,
-  options: {}
+  worker: false, // TODO set to true once workers deployed to unpkg
+  options: DEFAULT_OPTIONS
 };
 
 function parseCartoVectorTile(
   arrayBuffer: ArrayBuffer,
-  options?: LoaderOptions
+  options?: CartoVectorTileLoaderOptions
 ): BinaryFeatures | null {
   if (!arrayBuffer) return null;
   const tile = parsePbf(arrayBuffer, TileReader);

package/src/utils.ts

@@ -25,3 +25,9 @@ export function createBinaryProxy(
     }
   });
 }
+
+export function getWorkerUrl(id: string, version: string) {
+  // For local testing `yarn build-workers` and then host `modules/carto/dist/`
+  // return `http://localhost:8081/dist/${id}-worker.js`;
+  return `https://unpkg.com/@deck.gl/carto@${version}/dist/${id}-worker.js`;
+}

package/src/workers/cartoRasterTile.ts

@@ -0,0 +1,4 @@
+import {createLoaderWorker} from '@loaders.gl/loader-utils';
+import CartoRasterTileLoader from '../layers/schema/carto-raster-tile-loader';
+
+createLoaderWorker(CartoRasterTileLoader);

package/src/workers/cartoSpatialTile.ts

@@ -0,0 +1,4 @@
+import {createLoaderWorker} from '@loaders.gl/loader-utils';
+import CartoSpatialTileLoader from '../layers/schema/carto-spatial-tile-loader';
+
+createLoaderWorker(CartoSpatialTileLoader);

package/src/workers/cartoVectorTile.ts

@@ -0,0 +1,4 @@
+import {createLoaderWorker} from '@loaders.gl/loader-utils';
+import CartoVectorTileLoader from '../layers/schema/carto-vector-tile-loader';
+
+createLoaderWorker(CartoVectorTileLoader);

package/typed/layers/schema/carto-raster-tile-loader.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"carto-raster-tile-loader.d.ts","sourceRoot":"","sources":["../../../src/layers/schema/carto-raster-tile-loader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,gBAAgB,EAAC,MAAM,0BAA0B,CAAC;AAIzE,OAAO,EAAC,YAAY,EAAE,UAAU,EAAC,MAAM,qBAAqB,CAAC;AAE7D,QAAA,MAAM,qBAAqB,EAAE,gBAY5B,CAAC;AAEF,oBAAY,MAAM,GAAG;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE;QACL,YAAY,EAAE,YAAY,CAAC;QAC3B,UAAU,EAAE,UAAU,EAAE,CAAC;KAC1B,CAAC;CACH,CAAC;AAcF,eAAe,qBAAqB,CAAC"}
+{"version":3,"file":"carto-raster-tile-loader.d.ts","sourceRoot":"","sources":["../../../src/layers/schema/carto-raster-tile-loader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,gBAAgB,EAAC,MAAM,0BAA0B,CAAC;AAKzE,OAAO,EAAC,YAAY,EAAE,UAAU,EAAC,MAAM,qBAAqB,CAAC;AAiB7D,QAAA,MAAM,qBAAqB,EAAE,gBAa5B,CAAC;AAEF,oBAAY,MAAM,GAAG;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE;QACL,YAAY,EAAE,YAAY,CAAC;QAC3B,UAAU,EAAE,UAAU,EAAE,CAAC;KAC1B,CAAC;CACH,CAAC;AAiBF,eAAe,qBAAqB,CAAC"}

package/typed/layers/schema/carto-spatial-tile-loader.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"carto-spatial-tile-loader.d.ts","sourceRoot":"","sources":["../../../src/layers/schema/carto-spatial-tile-loader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,gBAAgB,EAAC,MAAM,0BAA0B,CAAC;AAMzE,QAAA,MAAM,sBAAsB,EAAE,gBAgB7B,CAAC;AAiBF,eAAe,sBAAsB,CAAC"}
+{"version":3,"file":"carto-spatial-tile-loader.d.ts","sourceRoot":"","sources":["../../../src/layers/schema/carto-spatial-tile-loader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,gBAAgB,EAAC,MAAM,0BAA0B,CAAC;AAwBzE,QAAA,MAAM,sBAAsB,EAAE,gBAa7B,CAAC;AAgBF,eAAe,sBAAsB,CAAC"}

package/typed/layers/schema/carto-vector-tile-loader.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"carto-vector-tile-loader.d.ts","sourceRoot":"","sources":["../../../src/layers/schema/carto-vector-tile-loader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,gBAAgB,EAAC,MAAM,0BAA0B,CAAC;AAMzE,QAAA,MAAM,qBAAqB,EAAE,gBAY5B,CAAC;AAaF,eAAe,qBAAqB,CAAC"}
+{"version":3,"file":"carto-vector-tile-loader.d.ts","sourceRoot":"","sources":["../../../src/layers/schema/carto-vector-tile-loader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,gBAAgB,EAAC,MAAM,0BAA0B,CAAC;AAsBzE,QAAA,MAAM,qBAAqB,EAAE,gBAa5B,CAAC;AAaF,eAAe,qBAAqB,CAAC"}

package/typed/utils.d.ts

@@ -4,4 +4,5 @@ export declare function createBinaryProxy(data: {
     numericProps: NumericProps;
     properties: Properties[];
 }, index: number): Properties;
+export declare function getWorkerUrl(id: string, version: string): string;
 //# sourceMappingURL=utils.d.ts.map

package/typed/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,UAAU,EAAE,YAAY,EAAC,MAAM,mCAAmC,CAAC;AAEhF,wBAAgB,MAAM,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAE9E;AAID,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE;IAAC,YAAY,EAAE,YAAY,CAAC;IAAC,UAAU,EAAE,UAAU,EAAE,CAAA;CAAC,EAC5D,KAAK,EAAE,MAAM,cAed"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,UAAU,EAAE,YAAY,EAAC,MAAM,mCAAmC,CAAC;AAEhF,wBAAgB,MAAM,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAE9E;AAID,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE;IAAC,YAAY,EAAE,YAAY,CAAC;IAAC,UAAU,EAAE,UAAU,EAAE,CAAA;CAAC,EAC5D,KAAK,EAAE,MAAM,cAed;AAED,wBAAgB,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,UAIvD"}

package/typed/workers/cartoRasterTile.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=cartoRasterTile.d.ts.map

package/typed/workers/cartoRasterTile.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cartoRasterTile.d.ts","sourceRoot":"","sources":["../../src/workers/cartoRasterTile.ts"],"names":[],"mappings":""}

package/typed/workers/cartoSpatialTile.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=cartoSpatialTile.d.ts.map

package/typed/workers/cartoSpatialTile.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cartoSpatialTile.d.ts","sourceRoot":"","sources":["../../src/workers/cartoSpatialTile.ts"],"names":[],"mappings":""}

package/typed/workers/cartoVectorTile.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=cartoVectorTile.d.ts.map

package/typed/workers/cartoVectorTile.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cartoVectorTile.d.ts","sourceRoot":"","sources":["../../src/workers/cartoVectorTile.ts"],"names":[],"mappings":""}

package/LICENSE

@@ -1,19 +0,0 @@
-Copyright Vis.gl contributors.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.