@carto/api-client 0.5.0-alpha.3 → 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.3",
+  "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,14 +38,15 @@
     "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",
     "coverage": "vitest run --coverage.enabled --coverage.all false",
-    "lint": "prettier \"**/*.{cjs,html,js,json,md,ts}\" --ignore-path ./.eslintignore --check",
-    "format": "prettier \"**/*.{cjs,html,js,json,md,ts}\" --ignore-path ./.eslintignore --write",
+    "lint": "eslint .",
+    "format": "prettier \"**/*.{cjs,html,js,json,md,ts}\" --write",
+    "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 test",
@@ -57,53 +63,53 @@
   ],
   "dependencies": {
     "@loaders.gl/schema": "^4.3.3",
-    "@turf/bbox-clip": "^7.1.0",
-    "@turf/bbox-polygon": "^7.1.0",
-    "@turf/boolean-intersects": "^7.1.0",
-    "@turf/boolean-within": "^7.1.0",
-    "@turf/helpers": "^7.1.0",
-    "@turf/intersect": "^7.1.0",
-    "@turf/invariant": "^7.1.0",
-    "@turf/union": "^7.1.0",
-    "@types/geojson": "^7946.0.15",
-    "h3-js": "4.1.0",
-    "quadbin": "^0.4.0-alpha.2"
+    "@turf/bbox-clip": "^7.2.0",
+    "@turf/bbox-polygon": "^7.2.0",
+    "@turf/boolean-equal": "^7.2.0",
+    "@turf/boolean-intersects": "^7.2.0",
+    "@turf/boolean-within": "^7.2.0",
+    "@turf/helpers": "^7.2.0",
+    "@turf/intersect": "^7.2.0",
+    "@turf/invariant": "^7.2.0",
+    "@turf/union": "^7.2.0",
+    "@types/geojson": "^7946.0.16",
+    "h3-js": "4.1.0"
   },
   "devDependencies": {
-    "@deck.gl/aggregation-layers": "^9.0.38",
-    "@deck.gl/carto": "^9.0.38",
-    "@deck.gl/core": "^9.0.38",
-    "@deck.gl/extensions": "^9.0.38",
-    "@deck.gl/geo-layers": "^9.0.38",
-    "@deck.gl/layers": "^9.0.38",
-    "@deck.gl/mesh-layers": "^9.0.38",
-    "@lit/react": "^1.0.6",
-    "@lit/task": "^1.0.1",
+    "@deck.gl/aggregation-layers": "~9.1.0",
+    "@deck.gl/carto": "~9.1.0",
+    "@deck.gl/core": "~9.1.0",
+    "@deck.gl/extensions": "~9.1.0",
+    "@deck.gl/geo-layers": "~9.1.0",
+    "@deck.gl/layers": "~9.1.0",
+    "@deck.gl/mesh-layers": "~9.1.0",
+    "@eslint/js": "^9.20.0",
+    "@lit/react": "^1.0.7",
+    "@lit/task": "^1.0.2",
     "@loaders.gl/core": "^4.3.3",
-    "@luma.gl/core": "~9.0.27",
-    "@luma.gl/engine": "~9.0.27",
-    "@turf/buffer": "^7.2.0",
+    "@luma.gl/core": "~9.1.0",
+    "@luma.gl/engine": "~9.1.0",
+    "@luma.gl/shadertools": "~9.1.0",
     "@types/json-schema": "^7.0.15",
     "@types/react": "^18.3.18",
     "@types/semver": "^7.5.8",
-    "@vitest/coverage-istanbul": "^3.0.2",
+    "@vitest/coverage-istanbul": "^3.0.5",
     "@webcomponents/webcomponentsjs": "^2.8.0",
     "concurrently": "^9.1.2",
     "echarts": "^5.6.0",
+    "eslint": "^9.20.1",
     "lit": "^3.2.1",
     "lit-analyzer": "^2.0.3",
-    "maplibre-gl": "^5.0.0",
-    "microbundle": "^0.15.1",
+    "maplibre-gl": "^5.1.0",
     "prettier": "^3.4.2",
     "rimraf": "^6.0.1",
-    "semver": "^7.6.3",
+    "semver": "^7.7.1",
     "thenby": "^1.3.4",
+    "tsup": "^8.3.6",
     "typescript": "~5.7.3",
-    "vite": "^6.0.7",
-    "vitest": "2.1.8"
+    "typescript-eslint": "^8.24.0",
+    "vite": "^6.1.0",
+    "vitest": "3.0.5"
   },
-  "resolutions": {
-    "rollup": "^4.20.0"
-  },
-  "stableVersion": "0.4.5"
+  "stableVersion": "0.4.6"
 }

package/src/api/carto-api-error.ts

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-import {MapType} from '../types';
+import {MapType} from '../types.js';
 
 export type APIRequestType =
   | 'Map data'

package/src/api/query.ts

@@ -2,15 +2,15 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-import {SOURCE_DEFAULTS} from '../sources/index';
+import {SOURCE_DEFAULTS} from '../sources/index.js';
 import type {
   SourceOptions,
   QuerySourceOptions,
   QueryResult,
-} from '../sources/types';
-import {buildQueryUrl} from './endpoints';
-import {requestWithParameters} from './request-with-parameters';
-import {APIErrorContext} from './carto-api-error';
+} from '../sources/types.js';
+import {buildQueryUrl} from './endpoints.js';
+import {requestWithParameters} from './request-with-parameters.js';
+import {APIErrorContext} from './carto-api-error.js';
 
 export type QueryOptions = SourceOptions & QuerySourceOptions;
 type UrlParameters = {q: string; queryParameters?: string};

package/src/api/request-with-parameters.ts

@@ -2,12 +2,12 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-import {isPureObject} from '../utils';
-import {CartoAPIError, APIErrorContext} from './carto-api-error';
-import {V3_MINOR_VERSION} from '../constants-internal';
-import {DEFAULT_MAX_LENGTH_URL} from '../constants-internal';
-import {getClient} from '../client';
-import {LocalCacheOptions} from '../sources/types';
+import {isPureObject} from '../utils.js';
+import {CartoAPIError, APIErrorContext} from './carto-api-error.js';
+import {V3_MINOR_VERSION} from '../constants-internal.js';
+import {DEFAULT_MAX_LENGTH_URL} from '../constants-internal.js';
+import {getClient} from '../client.js';
+import {LocalCacheOptions} from '../sources/types.js';
 
 const DEFAULT_HEADERS = {
   Accept: 'application/json',

package/src/client.ts

@@ -1,6 +1,6 @@
 /**
  * @internal
- * @internalRemarks Source: @carto/react-core, @carto/constants, @deck.gl/carto
+ * @privateRemarks Source: @carto/react-core, @carto/constants, @deck.gl/carto
  */
 let client = 'deck-gl-carto';
 
@@ -8,7 +8,7 @@ let client = 'deck-gl-carto';
  * Returns current client ID, used to categorize API requests. For internal use only.
  *
  * @internal
- * @internalRemarks Source: @carto/react-core
+ * @privateRemarks Source: @carto/react-core
  */
 export function getClient() {
   return client;
@@ -18,7 +18,7 @@ export function getClient() {
  * Sets current client ID, used to categorize API requests. For internal use only.
  *
  * @internal
- * @internalRemarks Source: @carto/react-core
+ * @privateRemarks Source: @carto/react-core
  */
 export function setClient(c: string) {
   client = c;

package/src/constants-internal.ts

@@ -1,32 +1,26 @@
-/**
- * Current version of @carto/api-client.
- * @internal
- */
-export const API_CLIENT_VERSION = __CARTO_API_CLIENT_VERSION;
-
 /** @internal */
 export const V3_MINOR_VERSION = '3.4';
 
-/** @internalRemarks Source: @carto/constants, @deck.gl/carto */
+/** @privateRemarks Source: @carto/constants, @deck.gl/carto */
 export const DEFAULT_GEO_COLUMN = 'geom';
 
 /**
  * Fastly default limit is 8192; leave some padding.
- * @internalRemarks Source: @deck.gl/carto
+ * @privateRemarks Source: @deck.gl/carto
  */
 export const DEFAULT_MAX_LENGTH_URL = 7000;
 
-/** @internalRemarks Source: @deck.gl/carto */
+/** @privateRemarks Source: @deck.gl/carto */
 export const DEFAULT_TILE_RESOLUTION = 0.5;
 
 /**
- * @internalRemarks Source: @deck.gl/carto
+ * @privateRemarks Source: @deck.gl/carto
  * @internal
  */
 export const DEFAULT_AGGREGATION_RES_LEVEL_H3 = 4;
 
 /**
- * @internalRemarks Source: @deck.gl/carto
+ * @privateRemarks Source: @deck.gl/carto
  * @internal
  */
 export const DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN = 6;

package/src/constants.ts

@@ -10,7 +10,7 @@
  * };
  * ```
  *
- * @internalRemarks Source: @carto/react-api, @deck.gl/carto
+ * @privateRemarks Source: @carto/react-api, @deck.gl/carto
  */
 export enum FilterType {
   IN = 'in',
@@ -22,17 +22,17 @@ export enum FilterType {
   STRING_SEARCH = 'stringSearch',
 }
 
-/** @internalRemarks Source: @carto/constants */
+/** @privateRemarks Source: @carto/constants */
 export enum ApiVersion {
   V1 = 'v1',
   V2 = 'v2',
   V3 = 'v3',
 }
 
-/** @internalRemarks Source: @carto/constants, @deck.gl/carto */
+/** @privateRemarks Source: @carto/constants, @deck.gl/carto */
 export const DEFAULT_API_BASE_URL = 'https://gcp-us-east1.api.carto.com';
 
-/** @internalRemarks Source: @carto/react-core */
+/** @privateRemarks Source: @carto/react-core */
 export enum TileFormat {
   MVT = 'mvt',
   JSON = 'json',
@@ -40,14 +40,14 @@ export enum TileFormat {
   BINARY = 'binary',
 }
 
-/** @internalRemarks Source: @carto/react-core */
+/** @privateRemarks Source: @carto/react-core */
 export enum SpatialIndex {
   H3 = 'h3',
   S2 = 's2',
   QUADBIN = 'quadbin',
 }
 
-/** @internalRemarks Source: @carto/react-core */
+/** @privateRemarks Source: @carto/react-core */
 export enum Provider {
   BIGQUERY = 'bigquery',
   REDSHIFT = 'redshift',

package/src/deck/get-data-filter-extension-props.ts

@@ -0,0 +1,146 @@
+import {Feature} from 'geojson';
+import {FilterLogicalOperator, Filters} from '../types.js';
+import {FilterType} from '../constants.js';
+import {_buildFeatureFilter} from '../filters/index.js';
+import {FeatureData} from '../types-internal.js';
+
+type TimeFilter = Filters['string'][FilterType.TIME] & {
+  params?: {offsetBy?: number};
+};
+
+/** @experimental Prefer type definition from deck.gl. */
+export type _DataFilterExtensionProps = {
+  filterRange: number[][];
+  updateTriggers: Record<string, string>;
+  getFilterValue: (feature: Feature | FeatureData) => number[];
+};
+
+/**
+ * Creates props for DataFilterExtension, from `@deck.gl/extensions`, given
+ * a set of filters.
+ *
+ * @privateRemarks DataFilterExtension accepts up to 4 values to filter. This
+ *  implementation uses the 1st for all filters except the time filter, and the
+ *  2nd for the time filter.
+ */
+export function getDataFilterExtensionProps(
+  filters: Filters,
+  filtersLogicalOperator?: FilterLogicalOperator,
+  filterSize?: 0 | 1 | 2 | 3 | 4
+): _DataFilterExtensionProps {
+  filterSize ??= 4;
+  const {filtersWithoutTimeType, timeColumn, timeFilter} =
+    getFiltersByType(filters);
+  return {
+    filterRange: getFilterRange(timeFilter, filterSize),
+    updateTriggers: getUpdateTriggers(
+      filtersWithoutTimeType,
+      timeColumn,
+      timeFilter
+    ),
+    getFilterValue: getFilterValue(
+      filtersWithoutTimeType,
+      timeColumn,
+      timeFilter,
+      filterSize,
+      filtersLogicalOperator
+    ),
+  };
+}
+
+/** @internal */
+function getFiltersByType(filters: Filters) {
+  const filtersWithoutTimeType: Filters = {};
+
+  let timeColumn: string | null = null;
+  let timeFilter: TimeFilter | null = null;
+
+  for (const [column, columnData] of Object.entries(filters)) {
+    for (const [type, typeData] of Object.entries(columnData) as [
+      FilterType,
+      unknown,
+    ][]) {
+      if (type === FilterType.TIME) {
+        timeColumn = column;
+        timeFilter = typeData as TimeFilter;
+      } else {
+        filtersWithoutTimeType[column] = {[type]: typeData};
+      }
+    }
+  }
+
+  return {
+    filtersWithoutTimeType,
+    timeColumn,
+    timeFilter,
+  };
+}
+
+/** @internal */
+function getFilterRange(
+  timeFilter: TimeFilter | null,
+  filterSize: number
+): number[][] {
+  const result = Array(filterSize).fill([0, 0]);
+  // According to getFilterValue all filters are resolved as 0 or 1 in the first position of the array
+  // except the time filter value that is resolved with the real value of the feature in the second position of the array
+  result[0] = [1, 1];
+  if (timeFilter) {
+    const offsetBy = timeFilter.params?.offsetBy || 0;
+    result[1] = timeFilter.values[0].map((v) => v - offsetBy);
+  }
+  return result;
+}
+
+/** @internal */
+function getUpdateTriggers(
+  filtersWithoutTimeType: Filters,
+  timeColumn: string | null,
+  timeFilter: TimeFilter | null
+) {
+  const result: Record<string, object> = {...filtersWithoutTimeType};
+
+  // We don't want to change the layer UpdateTriggers every time that the time filter changes
+  // because this filter is changed by the time series widget during its animation
+  // so we remove the time filter value from the `updateTriggers`
+  if (timeColumn && timeFilter) {
+    result[timeColumn] = {
+      ...result[timeColumn],
+      offsetBy: timeFilter.params?.offsetBy,
+      [FilterType.TIME]: {}, // Allows working with other filters, without an impact on performance.
+    };
+  }
+  return {
+    getFilterValue: JSON.stringify(result),
+  };
+}
+
+/** @internal */
+function getFilterValue(
+  filtersWithoutTimeType: Filters,
+  timeColumn: string | null,
+  timeFilter: TimeFilter | null,
+  filterSize: number,
+  filtersLogicalOperator?: FilterLogicalOperator
+) {
+  const result = Array(filterSize).fill(0);
+  const featureFilter = _buildFeatureFilter({
+    filters: filtersWithoutTimeType,
+    type: 'number',
+    filtersLogicalOperator,
+  });
+
+  // We evaluate all filters except the time filter using _buildFeatureFilter function.
+  // For the time filter, we return the value of the feature and we will change the getFilterRange result
+  // every time this filter changes
+  return (feature: Feature | FeatureData) => {
+    result[0] = featureFilter(feature);
+
+    if (timeColumn && timeFilter) {
+      const offsetBy = timeFilter.params?.offsetBy || 0;
+      const f = (feature.properties || feature) as Record<string, unknown>;
+      result[1] = (f[timeColumn] as number) - offsetBy;
+    }
+    return result;
+  };
+}

package/src/deck/index.ts

@@ -0,0 +1 @@
+export * from './get-data-filter-extension-props.js';

package/src/filters/Filter.ts

@@ -1,8 +1,8 @@
-import {filterFunctions} from './FilterTypes';
-import {Filter, FilterLogicalOperator, Filters} from '../types';
+import {filterFunctions} from './FilterTypes.js';
+import {Filter, FilterLogicalOperator, Filters} from '../types.js';
 import {Feature} from 'geojson';
-import {FilterType} from '../constants';
-import {FeatureData} from '../types-internal';
+import {FilterType} from '../constants.js';
+import {FeatureData} from '../types-internal.js';
 import {BinaryFeature} from '@loaders.gl/schema';
 
 const LOGICAL_OPERATOR_METHODS: Record<
@@ -44,7 +44,11 @@ function passesFilter(
   });
 }
 
-export function buildFeatureFilter({
+/**
+ * @internal
+ * @privateRemarks Exported for use in @deck.gl/carto's getDataFilterExtensionProps.
+ */
+export function _buildFeatureFilter({
   filters = {},
   type = 'boolean',
   filtersLogicalOperator = 'and',
@@ -74,18 +78,24 @@ export function buildFeatureFilter({
   };
 }
 
-// Apply certain filters to a collection of features
+/**
+ * Apply certain filters to a collection of features.
+ * @internal
+ */
 export function applyFilters(
   features: FeatureData[],
   filters: Filters,
   filtersLogicalOperator: FilterLogicalOperator
 ) {
   return Object.keys(filters).length
-    ? features.filter(buildFeatureFilter({filters, filtersLogicalOperator}))
+    ? features.filter(_buildFeatureFilter({filters, filtersLogicalOperator}))
     : features;
 }
 
-// Binary
+/**
+ * Binary.
+ * @internal
+ */
 export function buildBinaryFeatureFilter({filters = {}}: {filters: Filters}) {
   const columns = Object.keys(filters);
 

package/src/filters/FilterTypes.ts

@@ -1,5 +1,5 @@
-import {FilterType} from '../constants';
-import {FilterInterval, StringSearchOptions} from '../types';
+import {FilterType} from '../constants.js';
+import {FilterInterval, StringSearchOptions} from '../types.js';
 import {makeIntervalComplete} from '../utils/makeIntervalComplete.js';
 
 export type FilterFunction = (

package/src/filters/geosjonFeatures.ts

@@ -1,7 +1,7 @@
 import intersects from '@turf/boolean-intersects';
 import {FeatureCollection} from 'geojson';
-import {SpatialFilter} from '..';
-import {FeatureData} from '../types-internal';
+import {FeatureData} from '../types-internal.js';
+import {SpatialFilter} from '../types.js';
 
 export function geojsonFeatures({
   geojson,

package/src/filters/tileFeatures.ts

@@ -1,31 +1,28 @@
-import {RasterTile, SpatialFilter, SpatialIndexTile, Tile} from '../types';
-import {tileFeaturesGeometries} from './tileFeaturesGeometries';
-import {tileFeaturesSpatialIndex} from './tileFeaturesSpatialIndex';
-import {TileFormat} from '../constants';
-import {DEFAULT_GEO_COLUMN} from '../constants-internal';
-import {FeatureData} from '../types-internal';
-import {RasterMetadata, SpatialDataType} from '../sources/types';
-import {isRasterTile, tileFeaturesRaster} from './tileFeaturesRaster';
-import {assert} from '../utils';
+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 {SpatialDataType} from '../sources/types.js';
 
-/** @internalRemarks Source: @carto/react-core */
+/** @privateRemarks Source: @carto/react-core */
 export type TileFeatures = {
   tiles: Tile[];
   tileFormat: TileFormat;
   spatialDataType: SpatialDataType;
   spatialDataColumn?: string;
-  spatialFilter?: SpatialFilter;
+  spatialFilter: SpatialFilter;
   uniqueIdProperty?: string;
-  rasterMetadata?: RasterMetadata;
   options?: TileFeatureExtractOptions;
 };
 
-/** @internalRemarks Source: @carto/react-core */
+/** @privateRemarks Source: @carto/react-core */
 export type TileFeatureExtractOptions = {
   storeGeometry?: boolean;
 };
 
-/** @internalRemarks Source: @carto/react-core */
+/** @privateRemarks Source: @carto/react-core */
 export function tileFeatures({
   tiles,
   spatialFilter,
@@ -33,40 +30,21 @@ export function tileFeatures({
   tileFormat,
   spatialDataColumn = DEFAULT_GEO_COLUMN,
   spatialDataType,
-  rasterMetadata,
   options = {},
 }: TileFeatures): FeatureData[] {
-  // TODO(cleanup): Is an empty response the expected result when spatialFilter
-  // is omitted? Why not make the parameter required, or return the full input?
-  if (!spatialFilter) {
-    return [];
-  }
-
-  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,
   });
 }