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

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

@@ -2,17 +2,19 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-import {getTileFormat} from '../utils/getTileFormat';
+import {getTileFormat} from '../utils/getTileFormat.js';
 import {
   WidgetTilesetSource,
   WidgetTilesetSourceResult,
-} from '../widget-sources';
-import {baseSource} from './base-source';
+  WidgetTilesetWorkerSource,
+} from '../widget-sources/index.js';
+import {isModuleWorkerSupported} from '../workers/utils.js';
+import {baseSource} from './base-source.js';
 import type {
   SourceOptions,
   TilejsonResult,
   TilesetSourceOptions,
-} from './types';
+} from './types.js';
 
 export type QuadbinTilesetSourceOptions = SourceOptions & TilesetSourceOptions;
 type UrlParameters = {name: string};
@@ -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

@@ -2,15 +2,13 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-import {getTileFormat} from '../utils/getTileFormat';
-import {WidgetRasterSource, WidgetRasterSourceResult} from '../widget-sources';
-import {baseSource} from './base-source';
+import {baseSource} from './base-source.js';
 import type {
   FilterOptions,
   SourceOptions,
   TilejsonResult,
   TilesetSourceOptions,
-} from './types';
+} from './types.js';
 
 export type RasterSourceOptions = SourceOptions &
   TilesetSourceOptions &
@@ -20,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
@@ -31,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

@@ -3,8 +3,8 @@
 // Copyright (c) vis.gl contributors
 
 import type {Feature} from 'geojson';
-import {Filters, Format, QueryParameters} from '../types';
-import {MapInstantiation} from '../types-internal';
+import {Filters, Format, QueryParameters} from '../types.js';
+import {MapInstantiation} from '../types-internal.js';
 
 export type SourceRequiredOptions = {
   /** Carto platform access token. */
@@ -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 = {
@@ -208,7 +214,7 @@ export type SpatialDataType = 'geo' | 'h3' | 'quadbin';
  * Strategy used for covering spatial filter geometry with spatial indexes.
  * See https://docs.carto.com/data-and-analysis/analytics-toolbox-for-bigquery/sql-reference/quadbin#quadbin_polyfill_mode
  * or https://docs.carto.com/data-and-analysis/analytics-toolbox-for-bigquery/sql-reference/h3#h3_polyfill_mode for more information.
- * @internalRemarks Source: cloud-native maps-api
+ * @privateRemarks Source: cloud-native maps-api
  * */
 export type SpatialFilterPolyfillMode = 'center' | 'intersects' | 'contains';
 
@@ -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-query-source.ts

@@ -2,7 +2,6 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-/* eslint-disable camelcase */
 import {
   DEFAULT_GEO_COLUMN,
   DEFAULT_TILE_RESOLUTION,
@@ -11,7 +10,7 @@ import {
   WidgetQuerySource,
   WidgetQuerySourceResult,
 } from '../widget-sources/index.js';
-import {baseSource} from './base-source';
+import {baseSource} from './base-source.js';
 import type {
   FilterOptions,
   SourceOptions,
@@ -19,7 +18,7 @@ import type {
   SpatialDataType,
   TilejsonResult,
   ColumnsOption,
-} from './types';
+} from './types.js';
 
 export type VectorQuerySourceOptions = SourceOptions &
   QuerySourceOptions &

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

@@ -2,7 +2,6 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-/* eslint-disable camelcase */
 import {
   DEFAULT_GEO_COLUMN,
   DEFAULT_TILE_RESOLUTION,
@@ -11,7 +10,7 @@ import {
   WidgetTableSource,
   WidgetTableSourceResult,
 } from '../widget-sources/index.js';
-import {baseSource} from './base-source';
+import {baseSource} from './base-source.js';
 import type {
   FilterOptions,
   ColumnsOption,
@@ -19,7 +18,7 @@ import type {
   SpatialDataType,
   TableSourceOptions,
   TilejsonResult,
-} from './types';
+} from './types.js';
 
 export type VectorTableSourceOptions = SourceOptions &
   TableSourceOptions &

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

@@ -2,18 +2,20 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-import {DEFAULT_GEO_COLUMN} from '../constants-internal';
-import {getTileFormat} from '../utils/getTileFormat';
+import {DEFAULT_GEO_COLUMN} from '../constants-internal.js';
+import {getTileFormat} from '../utils/getTileFormat.js';
 import {
   WidgetTilesetSource,
   WidgetTilesetSourceResult,
-} from '../widget-sources';
-import {baseSource} from './base-source';
+  WidgetTilesetWorkerSource,
+} from '../widget-sources/index.js';
+import {isModuleWorkerSupported} from '../workers/utils.js';
+import {baseSource} from './base-source.js';
 import type {
   SourceOptions,
   TilesetSourceOptions,
   TilejsonResult,
-} from './types';
+} from './types.js';
 
 export type VectorTilesetSourceOptions = SourceOptions & TilesetSourceOptions;
 type UrlParameters = {name: string};
@@ -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/spatial-index.ts

@@ -1,10 +1,10 @@
 import {
   DEFAULT_AGGREGATION_RES_LEVEL_H3,
   DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN,
-} from './constants-internal';
-import type {ModelSource} from './models/model';
-import type {AggregationOptions} from './sources/types';
-import type {ViewState} from './widget-sources';
+} from './constants-internal.js';
+import type {ModelSource} from './models/model.js';
+import type {AggregationOptions} from './sources/types.js';
+import type {ViewState} from './widget-sources/index.js';
 
 const DEFAULT_TILE_SIZE = 512;
 const QUADBIN_ZOOM_MAX_OFFSET = 4;

package/src/types-internal.ts

@@ -2,7 +2,7 @@
  * COMMON
  */
 
-import {Format} from './types';
+import {Format} from './types.js';
 
 /** @internal */
 export type $TODO = any;
@@ -15,7 +15,7 @@ export type $IntentionalAny = any;
  */
 
 /**
- * @internalRemarks Source: @deck.gl/carto
+ * @privateRemarks Source: @deck.gl/carto
  * @internal
  */
 export enum SchemaFieldType {
@@ -31,7 +31,7 @@ export enum SchemaFieldType {
 }
 
 /**
- * @internalRemarks Source: @deck.gl/carto
+ * @privateRemarks Source: @deck.gl/carto
  * @internal
  */
 export interface SchemaField {
@@ -40,7 +40,7 @@ export interface SchemaField {
 }
 
 /**
- * @internalRemarks Source: @deck.gl/carto
+ * @privateRemarks Source: @deck.gl/carto
  * @internal
  */
 export interface MapInstantiation extends MapInstantiationFormats {
@@ -50,7 +50,7 @@ export interface MapInstantiation extends MapInstantiationFormats {
 }
 
 /**
- * @internalRemarks Source: @deck.gl/carto
+ * @privateRemarks Source: @deck.gl/carto
  * @internal
  */
 type MapInstantiationFormats = Record<

package/src/types.ts

@@ -6,10 +6,10 @@ import type {BinaryFeature, BinaryFeatureCollection} from '@loaders.gl/schema';
  * MAPS AND TILES
  */
 
-/** @internalRemarks Source: @deck.gl/carto */
+/** @privateRemarks Source: @deck.gl/carto */
 export type Format = 'json' | 'geojson' | 'tilejson';
 
-/** @internalRemarks Source: @carto/constants, @deck.gl/carto */
+/** @privateRemarks Source: @carto/constants, @deck.gl/carto */
 export type MapType = 'boundary' | 'query' | 'table' | 'tileset' | 'raster';
 
 /**
@@ -23,7 +23,7 @@ export type Viewport = [number, number, number, number];
  * required for local widget calculations. Deeper dependencies on deck.gl
  * APIs should be minimized within this library: @deck.gl/carto depends
  * on the API client, not the other way around.
- * @internalRemarks Source: @deck.gl/geo-layers
+ * @privateRemarks Source: @deck.gl/geo-layers
  */
 export type Tile = {
   index: {x: number; y: number; z: number};
@@ -40,13 +40,7 @@ export type SpatialIndexTile = Tile & {
   data?: (Feature & {id: bigint})[];
 };
 
-export type RasterTile = Tile & {
-  id: string;
-  index: {q: bigint; i: string};
-  data?: Raster;
-};
-
-/** @internalRemarks Source: @deck.gl/carto */
+/** @privateRemarks Source: @deck.gl/carto */
 export type Raster = {
   blockSize: number;
   cells: {
@@ -62,8 +56,8 @@ export type Raster = {
 /**
  * Enum for the different types of aggregations available for widgets.
  *
- * @internalRemarks Source: @carto/constants
- * @internalRemarks Converted from enum to type union, for improved declarative API.
+ * @privateRemarks Source: @carto/constants
+ * @privateRemarks Converted from enum to type union, for improved declarative API.
  */
 export type AggregationType =
   | 'count'
@@ -77,15 +71,15 @@ export type AggregationType =
  * FILTERS
  */
 
-/** @internalRemarks Source: @carto/react-api */
+/** @privateRemarks Source: @carto/react-api */
 export type SpatialFilter = Polygon | MultiPolygon;
 
-/** @internalRemarks Source: @deck.gl/carto */
+/** @privateRemarks Source: @deck.gl/carto */
 export interface Filters {
   [column: string]: Filter;
 }
 
-/** @internalRemarks Source: @carto/react-api, @deck.gl/carto */
+/** @privateRemarks Source: @carto/react-api, @deck.gl/carto */
 export interface Filter {
   [FilterType.IN]?: {owner?: string; values: number[] | string[]};
   /** [a, b] both are included. */
@@ -100,7 +94,7 @@ export interface Filter {
   };
 }
 
-/** @internalRemarks Source: @carto/react-core */
+/** @privateRemarks Source: @carto/react-core */
 export type FilterLogicalOperator = 'and' | 'or';
 
 /**
@@ -126,7 +120,7 @@ export type StringSearchOptions = {
 /**
  * Defines a step size increment for use with {@link TimeSeriesRequestOptions}.
  *
- * @internalRemarks Source: @carto/react-core
+ * @privateRemarks Source: @carto/react-core
  */
 export type GroupDateType =
   | 'year'
@@ -148,7 +142,7 @@ export type SortColumnType = 'number' | 'string' | 'date';
  * SQL QUERY PARAMETERS
  */
 
-/** @internalRemarks Source: @deck.gl/carto */
+/** @privateRemarks Source: @deck.gl/carto */
 export type QueryParameterValue =
   | string
   | number
@@ -156,11 +150,11 @@ export type QueryParameterValue =
   | Array<QueryParameterValue>
   | object;
 
-/** @internalRemarks Source: @deck.gl/carto */
+/** @privateRemarks Source: @deck.gl/carto */
 export type NamedQueryParameter = Record<string, QueryParameterValue>;
 
-/** @internalRemarks Source: @deck.gl/carto */
+/** @privateRemarks Source: @deck.gl/carto */
 export type PositionalQueryParameter = QueryParameterValue[];
 
-/** @internalRemarks Source: @deck.gl/carto */
+/** @privateRemarks Source: @deck.gl/carto */
 export type QueryParameters = NamedQueryParameter | PositionalQueryParameter;

package/src/utils/makeIntervalComplete.ts

@@ -1,4 +1,4 @@
-import {FilterInterval, FilterIntervalComplete} from '../types';
+import {FilterInterval, FilterIntervalComplete} from '../types.js';
 
 export function makeIntervalComplete(
   intervals: FilterInterval[]

package/src/utils.ts

@@ -39,7 +39,7 @@ type Row<T> = Record<string, T> | Record<string, T>[] | T[] | T;
  * Due to each data warehouse having its own behavior with columns,
  * we need to normalize them and transform every key to lowercase.
  *
- * @internalRemarks Source: @carto/react-widgets
+ * @privateRemarks Source: @carto/react-widgets
  * @internal
  */
 export function normalizeObjectKeys<T, R extends Row<T>>(el: R): R {
@@ -59,7 +59,7 @@ export function normalizeObjectKeys<T, R extends Row<T>>(el: R): R {
   ) as R;
 }
 
-/** @internalRemarks Source: @carto/react-core */
+/** @privateRemarks Source: @carto/react-core */
 export function assert(condition: unknown, message: string): asserts condition {
   if (!condition) {
     throw new Error(message);
@@ -67,7 +67,7 @@ export function assert(condition: unknown, message: string): asserts condition {
 }
 
 /**
- * @internalRemarks Source: @carto/react-core
+ * @privateRemarks Source: @carto/react-core
  * @internal
  */
 export class InvalidColumnError extends Error {

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/types.ts

@@ -1,11 +1,11 @@
-import {SpatialFilterPolyfillMode, TileResolution} from '../sources/types';
+import {SpatialFilterPolyfillMode, TileResolution} from '../sources/types.js';
 import {
+  Filters,
   GroupDateType,
   SortColumnType,
   SortDirection,
   SpatialFilter,
-} from '../types';
-import type {WidgetRemoteSource} from './widget-remote-source';
+} from '../types.js';
 
 /******************************************************************************
  * WIDGET API REQUESTS
@@ -24,6 +24,8 @@ interface BaseRequestOptions {
   /** Required for table- and query-based spatial index sources (H3, Quadbin). */
   spatialIndexReferenceViewState?: ViewState;
   abortController?: AbortController;
+  /** Overrides source filters, if any. */
+  filters?: Filters;
   filterOwner?: string;
 }
 

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

@@ -8,6 +8,7 @@ import {
   WidgetRemoteSourceProps,
 } from './widget-remote-source.js';
 import {ModelSource} from '../models/model.js';
+import {Filters} from '../types.js';
 
 type LayerQuerySourceOptions =
   | Omit<VectorQuerySourceOptions, 'filters'>
@@ -41,9 +42,12 @@ export type WidgetQuerySourceResult = {widgetSource: WidgetQuerySource};
 export class WidgetQuerySource extends WidgetRemoteSource<
   LayerQuerySourceOptions & WidgetRemoteSourceProps
 > {
-  protected override getModelSource(owner: string): ModelSource {
+  protected override getModelSource(
+    filters: Filters | undefined,
+    filterOwner?: string
+  ): ModelSource {
     return {
-      ...super._getModelSource(owner),
+      ...super._getModelSource(filters, filterOwner),
       type: 'query',
       data: this.props.sqlQuery,
       queryParameters: this.props.queryParameters,