@carto/api-client 0.5.0-alpha.0 → 0.5.0-alpha.11

package/src/operations/applySorting.ts

@@ -1,6 +1,6 @@
 import {firstBy} from 'thenby';
-import {SortDirection} from '../types';
-import {FeatureData} from '../types-internal';
+import {SortDirection} from '../types.js';
+import {FeatureData} from '../types-internal.js';
 
 // TODO(cleanup): Could this be simplified?
 type SortColumns = string | string[] | object[];
@@ -19,7 +19,7 @@ interface SortOptions {
  * @param [sortOptions.sortByDirection] - Direction by the columns will be sorted
  * @param [sortOptions.sortByColumnType] - Column type
  * @internal
- * @internalRemarks Source: @carto/react-core
+ * @privateRemarks Source: @carto/react-core
  */
 export function applySorting(
   features: FeatureData[],
@@ -63,7 +63,7 @@ function createSortFn({
   }) as Parameters<typeof firstBy>[];
 
   let sortFn = firstBy(...firstSortOption);
-  for (let sortOptions of othersSortOptions) {
+  for (const sortOptions of othersSortOptions) {
     sortFn = sortFn.thenBy(...sortOptions);
   }
 

package/src/operations/groupBy.ts

@@ -1,14 +1,14 @@
 import {aggregationFunctions, aggregate} from './aggregation.js';
-import {AggregationType} from '../types';
-import {FeatureData} from '../types-internal';
+import {AggregationType} from '../types.js';
+import {FeatureData} from '../types-internal.js';
 
-/** @internalRemarks Source: @carto/react-core */
+/** @privateRemarks Source: @carto/react-core */
 export type GroupByFeature = {
   name: string;
   value: number;
 }[];
 
-/** @internalRemarks Source: @carto/react-core */
+/** @privateRemarks Source: @carto/react-core */
 export function groupValuesByColumn({
   data,
   valuesColumns,

package/src/operations/groupByDate.ts

@@ -35,7 +35,7 @@ const GROUP_KEY_FN_MAPPING: Record<GroupDateType, (date: Date) => number> = {
     ),
 };
 
-/** @internalRemarks Source: @carto/react-core */
+/** @privateRemarks Source: @carto/react-core */
 export function groupValuesByDateColumn({
   data,
   valuesColumns,

package/src/operations/histogram.ts

@@ -1,10 +1,10 @@
-import {aggregate, aggregationFunctions} from './aggregation';
-import {AggregationType} from '../types';
-import {FeatureData} from '../types-internal';
+import {aggregate, aggregationFunctions} from './aggregation.js';
+import {AggregationType} from '../types.js';
+import {FeatureData} from '../types-internal.js';
 
 /**
  * Histogram computation.
- * @internalRemarks Source: @carto/react-core
+ * @privateRemarks Source: @carto/react-core
  */
 export function histogram({
   data,

package/src/operations/scatterPlot.ts

@@ -1,12 +1,12 @@
-import {aggregate} from './aggregation';
-import {FeatureData} from '../types-internal';
-import {AggregationType} from '../types';
+import {aggregate} from './aggregation.js';
+import {FeatureData} from '../types-internal.js';
+import {AggregationType} from '../types.js';
 
 export type ScatterPlotFeature = [number, number][];
 
 /**
  * Filters invalid features and formats  data.
- * @internalRemarks Source: @carto/react-core
+ * @privateRemarks Source: @carto/react-core
  */
 export function scatterPlot({
   data,

package/src/sources/base-source.ts

@@ -2,10 +2,10 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-import {DEFAULT_API_BASE_URL} from '../constants';
-import {DEFAULT_MAX_LENGTH_URL} from '../constants-internal';
-import {buildSourceUrl} from '../api/endpoints';
-import {requestWithParameters} from '../api/request-with-parameters';
+import {DEFAULT_API_BASE_URL} from '../constants.js';
+import {DEFAULT_MAX_LENGTH_URL} from '../constants-internal.js';
+import {buildSourceUrl} from '../api/endpoints.js';
+import {requestWithParameters} from '../api/request-with-parameters.js';
 import type {
   GeojsonResult,
   JsonResult,
@@ -13,10 +13,10 @@ import type {
   SourceRequiredOptions,
   TilejsonMapInstantiation,
   TilejsonResult,
-} from './types';
-import {MapType} from '../types';
-import {APIErrorContext} from '../api';
-import {getClient} from '../client';
+} from './types.js';
+import {MapType} from '../types.js';
+import {APIErrorContext} from '../api/index.js';
+import {getClient} from '../client.js';
 
 export const SOURCE_DEFAULTS: SourceOptionalOptions = {
   apiBaseUrl: DEFAULT_API_BASE_URL,

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

@@ -3,8 +3,8 @@
 // Copyright (c) vis.gl contributors
 
 import {QueryParameters} from '../types.js';
-import {baseSource} from './base-source';
-import type {FilterOptions, SourceOptions, TilejsonResult} from './types';
+import {baseSource} from './base-source.js';
+import type {FilterOptions, SourceOptions, TilejsonResult} from './types.js';
 
 export type BoundaryQuerySourceOptions = SourceOptions &
   FilterOptions & {
@@ -47,6 +47,7 @@ export const boundaryQuerySource = async function (
   if (queryParameters) {
     urlParameters.queryParameters = queryParameters;
   }
+
   return baseSource<UrlParameters>(
     'boundary',
     options,

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

@@ -2,8 +2,8 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-import {baseSource} from './base-source';
-import type {FilterOptions, SourceOptions, TilejsonResult} from './types';
+import {baseSource} from './base-source.js';
+import type {FilterOptions, SourceOptions, TilejsonResult} from './types.js';
 
 export type BoundaryTableSourceOptions = SourceOptions &
   FilterOptions & {
@@ -35,6 +35,7 @@ export const boundaryTableSource = async function (
   if (filters) {
     urlParameters.filters = filters;
   }
+
   return baseSource<UrlParameters>(
     'boundary',
     options,

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

@@ -2,10 +2,12 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-/* eslint-disable camelcase */
-import {DEFAULT_AGGREGATION_RES_LEVEL_H3} from '../constants-internal';
-import {WidgetQuerySource, WidgetQuerySourceResult} from '../widget-sources';
-import {baseSource} from './base-source';
+import {DEFAULT_AGGREGATION_RES_LEVEL_H3} from '../constants-internal.js';
+import {
+  WidgetQuerySource,
+  WidgetQuerySourceResult,
+} from '../widget-sources/index.js';
+import {baseSource} from './base-source.js';
 import type {
   AggregationOptions,
   FilterOptions,
@@ -13,7 +15,7 @@ import type {
   SourceOptions,
   SpatialDataType,
   TilejsonResult,
-} from './types';
+} from './types.js';
 
 export type H3QuerySourceOptions = SourceOptions &
   QuerySourceOptions &
@@ -43,10 +45,13 @@ export const h3QuerySource = async function (
     queryParameters,
     filters,
   } = options;
+
+  const spatialDataType = 'h3';
+
   const urlParameters: UrlParameters = {
     aggregationExp,
     spatialDataColumn,
-    spatialDataType: 'h3',
+    spatialDataType,
     q: sqlQuery,
   };
 
@@ -59,14 +64,15 @@ export const h3QuerySource = async function (
   if (filters) {
     urlParameters.filters = filters;
   }
+
   return baseSource<UrlParameters>('query', options, urlParameters).then(
     (result) => ({
       ...(result as TilejsonResult),
       widgetSource: new WidgetQuerySource({
         ...options,
-        // NOTE: passing redundant spatialDataColumn here to apply the default value 'h3'
+        // NOTE: Parameters with default values above must be explicitly passed here.
         spatialDataColumn,
-        spatialDataType: 'h3',
+        spatialDataType,
       }),
     })
   );

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

@@ -2,10 +2,12 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-/* eslint-disable camelcase */
-import {DEFAULT_AGGREGATION_RES_LEVEL_H3} from '../constants-internal';
-import {WidgetTableSource, WidgetTableSourceResult} from '../widget-sources';
-import {baseSource} from './base-source';
+import {DEFAULT_AGGREGATION_RES_LEVEL_H3} from '../constants-internal.js';
+import {
+  WidgetTableSource,
+  WidgetTableSourceResult,
+} from '../widget-sources/index.js';
+import {baseSource} from './base-source.js';
 import type {
   AggregationOptions,
   FilterOptions,
@@ -13,7 +15,7 @@ import type {
   SpatialDataType,
   TableSourceOptions,
   TilejsonResult,
-} from './types';
+} from './types.js';
 
 export type H3TableSourceOptions = SourceOptions &
   TableSourceOptions &
@@ -41,11 +43,14 @@ export const h3TableSource = async function (
     tableName,
     filters,
   } = options;
+
+  const spatialDataType = 'h3';
+
   const urlParameters: UrlParameters = {
     aggregationExp,
     name: tableName,
     spatialDataColumn,
-    spatialDataType: 'h3',
+    spatialDataType,
   };
 
   if (aggregationResLevel) {
@@ -54,14 +59,15 @@ export const h3TableSource = async function (
   if (filters) {
     urlParameters.filters = filters;
   }
+
   return baseSource<UrlParameters>('table', options, urlParameters).then(
     (result) => ({
       ...(result as TilejsonResult),
       widgetSource: new WidgetTableSource({
         ...options,
-        // NOTE: passing redundant spatialDataColumn here to apply the default value 'h3'
+        // NOTE: Parameters with default values above must be explicitly passed here.
         spatialDataColumn,
-        spatialDataType: 'h3',
+        spatialDataType,
       }),
     })
   );

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

@@ -2,17 +2,17 @@
 // 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';
+} from '../widget-sources/index.js';
+import {baseSource} from './base-source.js';
 import type {
   SourceOptions,
   TilejsonResult,
   TilesetSourceOptions,
-} from './types';
+} from './types.js';
 
 export type H3TilesetSourceOptions = SourceOptions & TilesetSourceOptions;
 type UrlParameters = {name: string};

package/src/sources/index.ts

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-export {SOURCE_DEFAULTS} from './base-source';
+export {SOURCE_DEFAULTS} from './base-source.js';
 export type {
   GeojsonResult,
   JsonResult,
@@ -13,77 +13,79 @@ export type {
   RasterMetadataBand,
   RasterMetadataBandStats,
   SourceOptions,
+  SpatialFilterPolyfillMode,
   TableSourceOptions,
   TilejsonResult,
+  TileResolution,
   TilesetSourceOptions,
   VectorLayer,
-} from './types';
+} from './types.js';
 
-export {boundaryQuerySource} from './boundary-query-source';
+export {boundaryQuerySource} from './boundary-query-source.js';
 export type {
   BoundaryQuerySourceOptions,
   BoundaryQuerySourceResponse,
-} from './boundary-query-source';
+} from './boundary-query-source.js';
 
-export {boundaryTableSource} from './boundary-table-source';
+export {boundaryTableSource} from './boundary-table-source.js';
 export type {
   BoundaryTableSourceOptions,
   BoundaryTableSourceResponse,
-} from './boundary-table-source';
+} from './boundary-table-source.js';
 
-export {h3QuerySource} from './h3-query-source';
+export {h3QuerySource} from './h3-query-source.js';
 export type {
   H3QuerySourceOptions,
   H3QuerySourceResponse,
-} from './h3-query-source';
+} from './h3-query-source.js';
 
-export {h3TableSource} from './h3-table-source';
+export {h3TableSource} from './h3-table-source.js';
 export type {
   H3TableSourceOptions,
   H3TableSourceResponse,
-} from './h3-table-source';
+} from './h3-table-source.js';
 
-export {h3TilesetSource} from './h3-tileset-source';
+export {h3TilesetSource} from './h3-tileset-source.js';
 export type {
   H3TilesetSourceOptions,
   H3TilesetSourceResponse,
-} from './h3-tileset-source';
+} from './h3-tileset-source.js';
 
-export {rasterSource} from './raster-source';
-export type {RasterSourceOptions} from './raster-source';
+export {rasterSource} from './raster-source.js';
+export type {RasterSourceOptions} from './raster-source.js';
 
-export {quadbinQuerySource} from './quadbin-query-source';
+export {quadbinQuerySource} from './quadbin-query-source.js';
 export type {
   QuadbinQuerySourceOptions,
   QuadbinQuerySourceResponse,
-} from './quadbin-query-source';
+} from './quadbin-query-source.js';
 
-export {quadbinTableSource} from './quadbin-table-source';
+export {quadbinTableSource} from './quadbin-table-source.js';
 export type {
   QuadbinTableSourceOptions,
   QuadbinTableSourceResponse,
-} from './quadbin-table-source';
+} from './quadbin-table-source.js';
 
-export {quadbinTilesetSource} from './quadbin-tileset-source';
+export {quadbinTilesetSource} from './quadbin-tileset-source.js';
 export type {
   QuadbinTilesetSourceOptions,
   QuadbinTilesetSourceResponse,
-} from './quadbin-tileset-source';
+} from './quadbin-tileset-source.js';
 
-export {vectorQuerySource} from './vector-query-source';
+export {vectorQuerySource} from './vector-query-source.js';
 export type {
   VectorQuerySourceOptions,
   VectorQuerySourceResponse,
-} from './vector-query-source';
+} from './vector-query-source.js';
 
-export {vectorTableSource} from './vector-table-source';
+export {vectorTableSource} from './vector-table-source.js';
 export type {
   VectorTableSourceOptions,
   VectorTableSourceResponse,
-} from './vector-table-source';
+} from './vector-table-source.js';
 
-export {vectorTilesetSource} from './vector-tileset-source';
+export {vectorTilesetSource} from './vector-tileset-source.js';
 export type {
   VectorTilesetSourceOptions,
   VectorTilesetSourceResponse,
-} from './vector-tileset-source';
+} from './vector-tileset-source.js';

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

@@ -2,10 +2,12 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-/* eslint-disable camelcase */
-import {DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN} from '../constants-internal';
-import {WidgetQuerySource, WidgetQuerySourceResult} from '../widget-sources';
-import {baseSource} from './base-source';
+import {DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN} from '../constants-internal.js';
+import {
+  WidgetQuerySource,
+  WidgetQuerySourceResult,
+} from '../widget-sources/index.js';
+import {baseSource} from './base-source.js';
 import type {
   AggregationOptions,
   FilterOptions,
@@ -13,7 +15,7 @@ import type {
   SourceOptions,
   SpatialDataType,
   TilejsonResult,
-} from './types';
+} from './types.js';
 
 export type QuadbinQuerySourceOptions = SourceOptions &
   QuerySourceOptions &
@@ -44,11 +46,14 @@ export const quadbinQuerySource = async function (
     queryParameters,
     filters,
   } = options;
+
+  const spatialDataType = 'quadbin';
+
   const urlParameters: UrlParameters = {
     aggregationExp,
     q: sqlQuery,
     spatialDataColumn,
-    spatialDataType: 'quadbin',
+    spatialDataType,
   };
 
   if (aggregationResLevel) {
@@ -60,14 +65,15 @@ export const quadbinQuerySource = async function (
   if (filters) {
     urlParameters.filters = filters;
   }
+
   return baseSource<UrlParameters>('query', options, urlParameters).then(
     (result) => ({
       ...(result as TilejsonResult),
       widgetSource: new WidgetQuerySource({
         ...options,
-        // NOTE: passing redundant spatialDataColumn here to apply the default value 'quadbin'
+        // NOTE: Parameters with default values above must be explicitly passed here.
         spatialDataColumn,
-        spatialDataType: 'quadbin',
+        spatialDataType,
       }),
     })
   );

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

@@ -2,10 +2,12 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-/* eslint-disable camelcase */
-import {DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN} from '../constants-internal';
-import {WidgetTableSource, WidgetTableSourceResult} from '../widget-sources';
-import {baseSource} from './base-source';
+import {DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN} from '../constants-internal.js';
+import {
+  WidgetTableSource,
+  WidgetTableSourceResult,
+} from '../widget-sources/index.js';
+import {baseSource} from './base-source.js';
 import type {
   AggregationOptions,
   FilterOptions,
@@ -13,7 +15,7 @@ import type {
   SpatialDataType,
   TableSourceOptions,
   TilejsonResult,
-} from './types';
+} from './types.js';
 
 export type QuadbinTableSourceOptions = SourceOptions &
   TableSourceOptions &
@@ -43,11 +45,13 @@ export const quadbinTableSource = async function (
     filters,
   } = options;
 
+  const spatialDataType = 'quadbin';
+
   const urlParameters: UrlParameters = {
     aggregationExp,
     name: tableName,
     spatialDataColumn,
-    spatialDataType: 'quadbin',
+    spatialDataType,
   };
 
   if (aggregationResLevel) {
@@ -56,14 +60,15 @@ export const quadbinTableSource = async function (
   if (filters) {
     urlParameters.filters = filters;
   }
+
   return baseSource<UrlParameters>('table', options, urlParameters).then(
     (result) => ({
       ...(result as TilejsonResult),
       widgetSource: new WidgetTableSource({
         ...options,
-        // NOTE: passing redundant spatialDataColumn here to apply the default value 'quadbin'
+        // NOTE: Parameters with default values above must be explicitly passed here.
         spatialDataColumn,
-        spatialDataType: 'quadbin',
+        spatialDataType,
       }),
     })
   );

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

@@ -2,17 +2,17 @@
 // 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';
+} from '../widget-sources/index.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};

package/src/sources/raster-source.ts

@@ -2,13 +2,13 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-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 &

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.
+   */
+  widgetWorker?: 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';
 

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 &
@@ -53,9 +52,11 @@ export const vectorQuerySource = async function (
     aggregationExp,
   } = options;
 
+  const spatialDataType = 'geo';
+
   const urlParameters: UrlParameters = {
     spatialDataColumn,
-    spatialDataType: 'geo',
+    spatialDataType,
     tileResolution: tileResolution.toString(),
     q: sqlQuery,
   };
@@ -72,13 +73,16 @@ export const vectorQuerySource = async function (
   if (aggregationExp) {
     urlParameters.aggregationExp = aggregationExp;
   }
+
   return baseSource<UrlParameters>('query', options, urlParameters).then(
     (result) => ({
       ...(result as TilejsonResult),
       widgetSource: new WidgetQuerySource({
         ...options,
+        // NOTE: Parameters with default values above must be explicitly passed here.
         spatialDataColumn,
-        spatialDataType: 'geo',
+        spatialDataType,
+        tileResolution,
       }),
     })
   );