@carto/api-client 0.5.0-alpha.4 → 0.5.0-alpha.5

package/build/worker.d.ts

@@ -0,0 +1,2 @@
+
+export {  }

package/build/worker.js

@@ -0,0 +1,25 @@
+import {
+  WidgetTilesetSource
+} from "./chunk-V3E7BKVR.js";
+
+// src/workers/widget-tileset-worker.ts
+var SOURCES_BY_NAME = /* @__PURE__ */ new Map();
+addEventListener("message", (e) => {
+  const { tableName, method, params, requestId } = e.data;
+  if (method === "init" /* INIT */) {
+    const props = params[0];
+    SOURCES_BY_NAME.set(tableName, new WidgetTilesetSource(props));
+    return;
+  }
+  const source = SOURCES_BY_NAME.get(tableName);
+  if (!source) {
+    const error = `Unknown dataset: ${tableName}`;
+    postMessage({ ok: false, error, requestId });
+    return;
+  }
+  Promise.resolve(source[method](...params)).then((result) => {
+    postMessage({ ok: true, result, requestId });
+  }).catch((error) => {
+    postMessage({ ok: false, error, requestId });
+  });
+});

package/package.json

@@ -8,7 +8,7 @@
   "homepage": "https://github.com/CartoDB/carto-api-client#readme",
   "author": "Don McCurdy <donmccurdy@carto.com>",
   "packageManager": "yarn@4.3.1",
-  "version": "0.5.0-alpha.4",
+  "version": "0.5.0-alpha.5",
   "license": "MIT",
   "publishConfig": {
     "access": "public",
@@ -16,15 +16,20 @@
   },
   "type": "module",
   "sideEffects": false,
-  "source": "src/index.ts",
-  "types": "./build/index.d.ts",
-  "main": "./build/api-client.cjs",
-  "module": "./build/api-client.modern.js",
   "exports": {
     ".": {
-      "types": "./build/index.d.ts",
-      "require": "./build/api-client.cjs",
-      "default": "./build/api-client.modern.js"
+      "require": {
+        "types": "./build/api-client.d.cts",
+        "default": "./build/api-client.cjs"
+      },
+      "default": {
+        "types": "./build/api-client.d.ts",
+        "default": "./build/api-client.js"
+      }
+    },
+    "./worker": {
+      "types": "./build/worker.d.ts",
+      "default": "./build/worker.js"
     }
   },
   "browserslist": [
@@ -33,8 +38,8 @@
     "node >= 18"
   ],
   "scripts": {
-    "build": "microbundle --format cjs,modern --no-compress --define __CARTO_API_CLIENT_VERSION=$npm_package_version",
-    "build:watch": "microbundle watch --format cjs,modern --no-compress --define __CARTO_API_CLIENT_VERSION=$npm_package_version",
+    "build": "tsup",
+    "build:watch": "tsup --watch",
     "dev": "concurrently \"yarn build:watch\" \"vite --config examples/vite.config.ts --open\"",
     "test": "vitest run --typecheck",
     "test:watch": "vitest watch --typecheck",
@@ -44,7 +49,7 @@
     "format:check": "prettier \"**/*.{cjs,html,js,json,md,ts}\" --check",
     "clean": "rimraf build/*",
     "postversion": "yarn postversion:check && yarn postversion:commit && yarn postversion:push",
-    "postversion:check": "yarn lint && yarn format:check && yarn test",
+    "postversion:check": "yarn lint && yarn test",
     "postversion:commit": "node scripts/postversion-commit.js",
     "postversion:push": "git push && git push --tags",
     "prepublish": "yarn lint && yarn test",
@@ -68,8 +73,7 @@
     "@turf/invariant": "^7.2.0",
     "@turf/union": "^7.2.0",
     "@types/geojson": "^7946.0.16",
-    "h3-js": "4.1.0",
-    "quadbin": "^0.4.0-alpha.2"
+    "h3-js": "4.1.0"
   },
   "devDependencies": {
     "@deck.gl/aggregation-layers": "~9.1.0",
@@ -86,7 +90,6 @@
     "@luma.gl/core": "~9.1.0",
     "@luma.gl/engine": "~9.1.0",
     "@luma.gl/shadertools": "~9.1.0",
-    "@turf/buffer": "^7.2.0",
     "@types/json-schema": "^7.0.15",
     "@types/react": "^18.3.18",
     "@types/semver": "^7.5.8",
@@ -98,18 +101,15 @@
     "lit": "^3.2.1",
     "lit-analyzer": "^2.0.3",
     "maplibre-gl": "^5.1.0",
-    "microbundle": "^0.15.1",
     "prettier": "^3.4.2",
     "rimraf": "^6.0.1",
     "semver": "^7.7.1",
     "thenby": "^1.3.4",
+    "tsup": "^8.3.6",
     "typescript": "~5.7.3",
     "typescript-eslint": "^8.24.0",
     "vite": "^6.1.0",
     "vitest": "3.0.5"
   },
-  "resolutions": {
-    "rollup": "^4.20.0"
-  },
   "stableVersion": "0.4.6"
 }

package/src/constants-internal.ts

@@ -1,9 +1,3 @@
-/**
- * Current version of @carto/api-client.
- * @internal
- */
-export const API_CLIENT_VERSION = __CARTO_API_CLIENT_VERSION;
-
 /** @internal */
 export const V3_MINOR_VERSION = '3.4';
 

package/src/filters/tileFeatures.ts

@@ -1,12 +1,10 @@
-import {RasterTile, SpatialFilter, SpatialIndexTile, Tile} from '../types.js';
+import {SpatialFilter, SpatialIndexTile, Tile} from '../types.js';
 import {tileFeaturesGeometries} from './tileFeaturesGeometries.js';
 import {tileFeaturesSpatialIndex} from './tileFeaturesSpatialIndex.js';
 import {TileFormat} from '../constants.js';
 import {DEFAULT_GEO_COLUMN} from '../constants-internal.js';
 import {FeatureData} from '../types-internal.js';
-import {RasterMetadata, SpatialDataType} from '../sources/types.js';
-import {isRasterTile, tileFeaturesRaster} from './tileFeaturesRaster.js';
-import {assert} from '../utils.js';
+import {SpatialDataType} from '../sources/types.js';
 
 /** @privateRemarks Source: @carto/react-core */
 export type TileFeatures = {
@@ -16,7 +14,6 @@ export type TileFeatures = {
   spatialDataColumn?: string;
   spatialFilter: SpatialFilter;
   uniqueIdProperty?: string;
-  rasterMetadata?: RasterMetadata;
   options?: TileFeatureExtractOptions;
 };
 
@@ -33,34 +30,21 @@ export function tileFeatures({
   tileFormat,
   spatialDataColumn = DEFAULT_GEO_COLUMN,
   spatialDataType,
-  rasterMetadata,
   options = {},
 }: TileFeatures): FeatureData[] {
-  if (spatialDataType === 'geo') {
-    return tileFeaturesGeometries({
-      tiles,
-      tileFormat,
-      spatialFilter,
-      uniqueIdProperty,
-      options,
-    });
-  }
-
-  if (tiles.some(isRasterTile)) {
-    assert(rasterMetadata, 'Missing raster metadata');
-    return tileFeaturesRaster({
-      tiles: tiles as RasterTile[],
+  if (spatialDataType !== 'geo') {
+    return tileFeaturesSpatialIndex({
+      tiles: tiles as SpatialIndexTile[],
       spatialFilter,
       spatialDataColumn,
       spatialDataType,
-      rasterMetadata,
     });
   }
-
-  return tileFeaturesSpatialIndex({
-    tiles: tiles as SpatialIndexTile[],
+  return tileFeaturesGeometries({
+    tiles,
+    tileFormat,
     spatialFilter,
-    spatialDataColumn,
-    spatialDataType,
+    uniqueIdProperty,
+    options,
   });
 }

package/src/global.d.ts

@@ -1,10 +1,5 @@
-/**
- * Injected by microbundle, with:
- * ```
- * --define __CARTO_API_CLIENT_VERSION=$npm_package_version
- * ```
- */
-declare const __CARTO_API_CLIENT_VERSION: string;
-
 /** Defined by @deck.gl/core. */
 declare const deck: {VERSION: string | undefined} | undefined;
+
+/** Defined by tsup. */
+declare const TSUP_FORMAT: 'esm' | 'cjs';

package/src/sources/h3-tileset-source.ts

@@ -6,7 +6,9 @@ import {getTileFormat} from '../utils/getTileFormat.js';
 import {
   WidgetTilesetSource,
   WidgetTilesetSourceResult,
+  WidgetTilesetWorkerSource,
 } from '../widget-sources/index.js';
+import {isModuleWorkerSupported} from '../workers/utils.js';
 import {baseSource} from './base-source.js';
 import type {
   SourceOptions,
@@ -26,10 +28,15 @@ export const h3TilesetSource = async function (
   const {tableName, spatialDataColumn = 'h3'} = options;
   const urlParameters: UrlParameters = {name: tableName};
 
+  const WidgetSourceClass =
+    options.widgetSourceWorker !== false && isModuleWorkerSupported()
+      ? WidgetTilesetWorkerSource
+      : WidgetTilesetSource;
+
   return baseSource<UrlParameters>('tileset', options, urlParameters).then(
     (result) => ({
       ...(result as TilejsonResult),
-      widgetSource: new WidgetTilesetSource({
+      widgetSource: new WidgetSourceClass({
         ...options,
         tileFormat: getTileFormat(result as TilejsonResult),
         spatialDataColumn,

package/src/sources/quadbin-tileset-source.ts

@@ -6,7 +6,9 @@ import {getTileFormat} from '../utils/getTileFormat.js';
 import {
   WidgetTilesetSource,
   WidgetTilesetSourceResult,
+  WidgetTilesetWorkerSource,
 } from '../widget-sources/index.js';
+import {isModuleWorkerSupported} from '../workers/utils.js';
 import {baseSource} from './base-source.js';
 import type {
   SourceOptions,
@@ -26,10 +28,15 @@ export const quadbinTilesetSource = async function (
   const {tableName, spatialDataColumn = 'quadbin'} = options;
   const urlParameters: UrlParameters = {name: tableName};
 
+  const WidgetSourceClass =
+    options.widgetSourceWorker !== false && isModuleWorkerSupported()
+      ? WidgetTilesetWorkerSource
+      : WidgetTilesetSource;
+
   return baseSource<UrlParameters>('tileset', options, urlParameters).then(
     (result) => ({
       ...(result as TilejsonResult),
-      widgetSource: new WidgetTilesetSource({
+      widgetSource: new WidgetSourceClass({
         ...options,
         tileFormat: getTileFormat(result as TilejsonResult),
         spatialDataColumn,

package/src/sources/raster-source.ts

@@ -3,12 +3,6 @@
 // Copyright (c) vis.gl contributors
 
 import {baseSource} from './base-source.js';
-import {getTileFormat} from '../utils/getTileFormat.js';
-import {
-  WidgetRasterSource,
-  WidgetRasterSourceResult,
-} from '../widget-sources/index.js';
-
 import type {
   FilterOptions,
   SourceOptions,
@@ -24,7 +18,7 @@ type UrlParameters = {
   filters?: Record<string, unknown>;
 };
 
-export type RasterSourceResponse = TilejsonResult & WidgetRasterSourceResult;
+export type RasterSourceResponse = TilejsonResult;
 
 export const rasterSource = async function (
   options: RasterSourceOptions
@@ -35,16 +29,9 @@ export const rasterSource = async function (
     urlParameters.filters = filters;
   }
 
-  return baseSource<UrlParameters>('raster', options, urlParameters).then(
-    (result) => ({
-      ...(result as TilejsonResult),
-      widgetSource: new WidgetRasterSource({
-        ...options,
-        tileFormat: getTileFormat(result as TilejsonResult),
-        spatialDataColumn: 'quadbin',
-        spatialDataType: 'quadbin',
-        rasterMetadata: (result as TilejsonResult).raster_metadata!,
-      }),
-    })
+  return baseSource<UrlParameters>(
+    'raster',
+    options,
+    urlParameters
   ) as Promise<RasterSourceResponse>;
 };

package/src/sources/types.ts

@@ -191,6 +191,12 @@ export type TilesetSourceOptions = {
    * Fully qualified name of tileset.
    */
   tableName: string;
+
+  /**
+   * Whether to use Web Workers for local widget calculations. Workers
+   * are used by default if the runtime environment supports ES Module Workers.
+   */
+  widgetSourceWorker?: boolean;
 };
 
 export type ColumnsOption = {
@@ -373,7 +379,7 @@ export type RasterMetadataBand = {
   /**
    * Default color mapping for unique values (or if coloprinterp is `palette`)
    */
-  colortable?: Record<string, [number, number, number, number]>;
+  colortable?: Record<string, number[]>;
 
   /**
    * No value representation.

package/src/sources/vector-tileset-source.ts

@@ -7,7 +7,9 @@ import {getTileFormat} from '../utils/getTileFormat.js';
 import {
   WidgetTilesetSource,
   WidgetTilesetSourceResult,
+  WidgetTilesetWorkerSource,
 } from '../widget-sources/index.js';
+import {isModuleWorkerSupported} from '../workers/utils.js';
 import {baseSource} from './base-source.js';
 import type {
   SourceOptions,
@@ -27,10 +29,15 @@ export const vectorTilesetSource = async function (
   const {tableName, spatialDataColumn = DEFAULT_GEO_COLUMN} = options;
   const urlParameters: UrlParameters = {name: tableName};
 
+  const WidgetSourceClass =
+    options.widgetSourceWorker !== false && isModuleWorkerSupported()
+      ? WidgetTilesetWorkerSource
+      : WidgetTilesetSource;
+
   return baseSource<UrlParameters>('tileset', options, urlParameters).then(
     (result) => ({
       ...(result as TilejsonResult),
-      widgetSource: new WidgetTilesetSource({
+      widgetSource: new WidgetSourceClass({
         ...options,
         tileFormat: getTileFormat(result as TilejsonResult),
         spatialDataColumn,

package/src/types.ts

@@ -40,12 +40,6 @@ export type SpatialIndexTile = Tile & {
   data?: (Feature & {id: bigint})[];
 };
 
-export type RasterTile = Tile & {
-  id: string;
-  index: {q: bigint; i: string};
-  data?: Raster;
-};
-
 /** @privateRemarks Source: @deck.gl/carto */
 export type Raster = {
   blockSize: number;

package/src/widget-sources/index.ts

@@ -1,7 +1,7 @@
 export * from './widget-source.js';
 export * from './widget-query-source.js';
-export * from './widget-raster-source.js';
 export * from './widget-remote-source.js';
 export * from './widget-table-source.js';
 export * from './widget-tileset-source.js';
+export * from './widget-tileset-worker-source.js';
 export * from './types.js';

package/src/widget-sources/widget-remote-source.ts

@@ -1,4 +1,4 @@
-import {executeModel} from '../models/index.js';
+import {executeModel, ModelSource} from '../models/index.js';
 import {
   CategoryRequestOptions,
   CategoryResponse,
@@ -17,9 +17,12 @@ import {
   TimeSeriesRequestOptions,
   TimeSeriesResponse,
 } from './types.js';
-import {normalizeObjectKeys} from '../utils.js';
+import {getApplicableFilters, normalizeObjectKeys} from '../utils.js';
 import {DEFAULT_TILE_RESOLUTION} from '../constants-internal.js';
 import {WidgetSource, WidgetSourceProps} from './widget-source.js';
+import {Filters} from '../types.js';
+import {ApiVersion} from '../constants.js';
+import {AggregationOptions} from '../sources/types.js';
 
 export type WidgetRemoteSourceProps = WidgetSourceProps;
 
@@ -38,6 +41,36 @@ export abstract class WidgetRemoteSource<
     this._headers = headers;
   }
 
+  /**
+   * Subclasses of {@link WidgetRemoteSource} must implement this method, calling
+   * {@link WidgetRemoteSource.prototype._getModelSource} for common source
+   * properties, and adding additional required properties including 'type' and
+   * 'data'.
+   */
+  protected abstract getModelSource(
+    filters: Filters | undefined,
+    filterOwner?: string
+  ): ModelSource;
+
+  protected _getModelSource(
+    filters: Filters | undefined,
+    filterOwner?: string
+  ): Omit<ModelSource, 'type' | 'data'> {
+    const props = this.props;
+    return {
+      apiVersion: props.apiVersion as ApiVersion,
+      apiBaseUrl: props.apiBaseUrl as string,
+      clientId: props.clientId as string,
+      accessToken: props.accessToken,
+      connectionName: props.connectionName,
+      filters: getApplicableFilters(filterOwner, filters || props.filters),
+      filtersLogicalOperator: props.filtersLogicalOperator,
+      spatialDataType: props.spatialDataType,
+      spatialDataColumn: props.spatialDataColumn,
+      dataResolution: (props as Partial<AggregationOptions>).dataResolution,
+    };
+  }
+
   async getCategories(
     options: CategoryRequestOptions
   ): Promise<CategoryResponse> {

package/src/widget-sources/widget-source.ts

@@ -17,19 +17,12 @@ import {
   TimeSeriesResponse,
   ViewState,
 } from './types.js';
-import {
-  FilterLogicalOperator,
-  Filter,
-  SpatialFilter,
-  Filters,
-} from '../types.js';
-import {getApplicableFilters} from '../utils.js';
+import {FilterLogicalOperator, Filter, SpatialFilter} from '../types.js';
 import {getClient} from '../client.js';
 import {ModelSource} from '../models/model.js';
 import {SourceOptions} from '../sources/index.js';
 import {ApiVersion, DEFAULT_API_BASE_URL} from '../constants.js';
 import {getSpatialFiltersResolution} from '../spatial-index.js';
-import {AggregationOptions} from '../sources/types.js';
 
 export interface WidgetSourceProps extends Omit<SourceOptions, 'filters'> {
   apiVersion?: ApiVersion;
@@ -57,36 +50,6 @@ export abstract class WidgetSource<Props extends WidgetSourceProps> {
     this.props = {...WidgetSource.defaultProps, ...props};
   }
 
-  /**
-   * Subclasses of {@link WidgetRemoteSource} must implement this method, calling
-   * {@link WidgetRemoteSource.prototype._getModelSource} for common source
-   * properties, and adding additional required properties including 'type' and
-   * 'data'.
-   */
-  protected abstract getModelSource(
-    filters: Filters | undefined,
-    filterOwner?: string
-  ): ModelSource;
-
-  protected _getModelSource(
-    filters: Filters | undefined,
-    filterOwner?: string
-  ): Omit<ModelSource, 'type' | 'data'> {
-    const props = this.props;
-    return {
-      apiVersion: props.apiVersion as ApiVersion,
-      apiBaseUrl: props.apiBaseUrl as string,
-      clientId: props.clientId as string,
-      accessToken: props.accessToken,
-      connectionName: props.connectionName,
-      filters: getApplicableFilters(filterOwner, filters || props.filters),
-      filtersLogicalOperator: props.filtersLogicalOperator,
-      spatialDataType: props.spatialDataType,
-      spatialDataColumn: props.spatialDataColumn,
-      dataResolution: (props as Partial<AggregationOptions>).dataResolution,
-    };
-  }
-
   protected _getSpatialFiltersResolution(
     source: Omit<ModelSource, 'type' | 'data'>,
     spatialFilter?: SpatialFilter,

package/src/widget-sources/widget-tileset-source.ts

@@ -1,6 +1,5 @@
 /* eslint-disable @typescript-eslint/require-await */
 import {TilesetSourceOptions} from '../sources/index.js';
-import type {ModelSource} from '../models/index.js';
 import {
   CategoryRequestOptions,
   CategoryResponse,
@@ -20,7 +19,7 @@ import {
 } from './types.js';
 import {InvalidColumnError, assert, getApplicableFilters} from '../utils.js';
 import {TileFormat} from '../constants.js';
-import {Filter, Filters, SpatialFilter, Tile} from '../types.js';
+import {Filter, SpatialFilter, Tile} from '../types.js';
 import {
   TileFeatureExtractOptions,
   applyFilters,
@@ -76,26 +75,13 @@ export type WidgetTilesetSourceResult = {widgetSource: WidgetTilesetSource};
  * const { widgetSource } = await data;
  * ```
  */
-export class WidgetTilesetSource<
-  Props extends WidgetTilesetSourceProps = WidgetTilesetSourceProps,
-> extends WidgetSource<Props> {
+export class WidgetTilesetSource extends WidgetSource<WidgetTilesetSourceProps> {
   private _tiles: Tile[] = [];
   private _features: FeatureData[] = [];
   private _tileFeatureExtractOptions: TileFeatureExtractOptions = {};
   private _tileFeatureExtractPreviousInputs: {spatialFilter?: SpatialFilter} =
     {};
 
-  protected override getModelSource(
-    filters: Filters | undefined,
-    filterOwner: string
-  ): ModelSource {
-    return {
-      ...super._getModelSource(filters, filterOwner),
-      type: 'tileset',
-      data: this.props.tableName,
-    };
-  }
-
   /**
    * Loads features as a list of tiles (typically provided by deck.gl).
    * After tiles are loaded, {@link extractTileFeatures} must be called
@@ -125,10 +111,13 @@ export class WidgetTilesetSource<
     }
 
     this._features = tileFeatures({
-      ...this.props,
-      ...this._tileFeatureExtractOptions,
       tiles: this._tiles,
+      tileFormat: this.props.tileFormat,
+      ...this._tileFeatureExtractOptions,
+
       spatialFilter,
+      spatialDataColumn: this.props.spatialDataColumn,
+      spatialDataType: this.props.spatialDataType,
     });
 
     prevInputs.spatialFilter = spatialFilter;