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

package/src/filters.ts

@@ -1,6 +1,6 @@
-import {FilterType} from './constants';
-import {Filter} from './types';
-import {isEmptyObject} from './utils';
+import {FilterType} from './constants.js';
+import {Filter} from './types.js';
+import {isEmptyObject} from './utils.js';
 
 type FilterTypeOptions<T extends FilterType> = {
   type: T;
@@ -121,7 +121,7 @@ export function getFilter<T extends FilterType>(
     return null;
   }
 
-  if (!owner || owner === filter[type as FilterType]?.owner) {
+  if (!owner || owner === filter[type]?.owner) {
     return filter[type] || null;
   }
 

package/src/geo.ts

@@ -4,7 +4,7 @@ import union from '@turf/union';
 import {getType} from '@turf/invariant';
 import {polygon, multiPolygon, feature, featureCollection} from '@turf/helpers';
 import type {BBox, Geometry, MultiPolygon, Polygon, Position} from 'geojson';
-import {SpatialFilter} from './types';
+import {SpatialFilter} from './types.js';
 
 /**
  * Returns a {@link SpatialFilter} for a given viewport, typically obtained
@@ -40,7 +40,7 @@ export function createPolygonSpatialFilter(
  * Check if a viewport is large enough to represent a global coverage.
  * In this case the spatial filter parameter for widget calculation is removed.
  *
- * @internalRemarks Source: @carto/react-core
+ * @privateRemarks Source: @carto/react-core
  */
 function _isGlobalViewport(viewport: BBox) {
   const [minx, miny, maxx, maxy] = viewport;
@@ -54,7 +54,7 @@ function _isGlobalViewport(viewport: BBox) {
  *
  * It results in a Polygon or MultiPolygon strictly inside the validity range.
  *
- * @internalRemarks Source: @carto/react-core
+ * @privateRemarks Source: @carto/react-core
  */
 function _normalizeGeometry(
   geometry: Polygon | MultiPolygon
@@ -100,19 +100,19 @@ function _normalizeGeometry(
   return result;
 }
 
-/** @internalRemarks Source: @carto/react-core */
+/** @privateRemarks Source: @carto/react-core */
 function _cleanPolygonCoords(cc: Position[][]) {
   const coords = cc.filter((c) => c.length > 0);
   return coords.length > 0 ? coords : null;
 }
 
-/** @internalRemarks Source: @carto/react-core */
+/** @privateRemarks Source: @carto/react-core */
 function _cleanMultiPolygonCoords(ccc: Position[][][]) {
   const coords = ccc.map(_cleanPolygonCoords).filter((cc) => cc);
   return coords.length > 0 ? coords : null;
 }
 
-/** @internalRemarks Source: @carto/react-core */
+/** @privateRemarks Source: @carto/react-core */
 function _clean(
   geometry: Polygon | MultiPolygon | null
 ): Polygon | MultiPolygon | null {
@@ -121,36 +121,34 @@ function _clean(
   }
 
   if (_isPolygon(geometry)) {
-    const coords = _cleanPolygonCoords((geometry as Polygon).coordinates);
+    const coords = _cleanPolygonCoords(geometry.coordinates);
     return coords ? polygon(coords).geometry : null;
   }
 
   if (_isMultiPolygon(geometry)) {
-    const coords = _cleanMultiPolygonCoords(
-      (geometry as MultiPolygon).coordinates
-    );
+    const coords = _cleanMultiPolygonCoords(geometry.coordinates);
     return coords ? multiPolygon(coords as Position[][][]).geometry : null;
   }
 
   return null;
 }
 
-/** @internalRemarks Source: @carto/react-core */
+/** @privateRemarks Source: @carto/react-core */
 function _txContourCoords(cc: Position[], distance: number) {
   return cc.map((c) => [c[0] + distance, c[1]]);
 }
 
-/** @internalRemarks Source: @carto/react-core */
+/** @privateRemarks Source: @carto/react-core */
 function _txPolygonCoords(ccc: Position[][], distance: number) {
   return ccc.map((cc) => _txContourCoords(cc, distance));
 }
 
-/** @internalRemarks Source: @carto/react-core */
+/** @privateRemarks Source: @carto/react-core */
 function _txMultiPolygonCoords(cccc: Position[][][], distance: number) {
   return cccc.map((ccc) => _txPolygonCoords(ccc, distance));
 }
 
-/** @internalRemarks Source: @carto/react-core */
+/** @privateRemarks Source: @carto/react-core */
 function _tx(geometry: Polygon | MultiPolygon, distance: number) {
   if (geometry && getType(geometry) === 'Polygon') {
     const coords = _txPolygonCoords(

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

@@ -1,5 +1,6 @@
 export * from './client.js';
 export * from './constants.js';
+export * from './deck/index.js';
 export * from './filters.js';
 export * from './geo.js';
 export * from './sources/index.js';

package/src/models/common.ts

@@ -1,8 +1,9 @@
 import {InvalidColumnError} from '../utils.js';
 
-/** @internalRemarks Source: @carto/react-api */
+/** @privateRemarks Source: @carto/react-api */
 export interface ModelRequestOptions {
   method: 'GET' | 'POST';
+  headers?: Record<string, string>;
   abortController?: AbortController;
   otherOptions?: Record<string, unknown>;
   body?: string;
@@ -16,7 +17,7 @@ interface ModelErrorResponse {
 
 /**
  * Return more descriptive error from API
- * @internalRemarks Source: @carto/react-api
+ * @privateRemarks Source: @carto/react-api
  */
 export function dealWithApiError({
   response,
@@ -42,15 +43,15 @@ export function dealWithApiError({
     case 403:
       throw new Error('Forbidden access to the requested data');
     default:
-      const msg =
+      throw new Error(
         data && data.error && typeof data.error === 'string'
           ? data.error
-          : JSON.stringify(data?.hint || data.error?.[0]);
-      throw new Error(msg);
+          : JSON.stringify(data?.hint || data.error?.[0])
+      );
   }
 }
 
-/** @internalRemarks Source: @carto/react-api */
+/** @privateRemarks Source: @carto/react-api */
 export async function makeCall({
   url,
   accessToken,
@@ -68,6 +69,7 @@ export async function makeCall({
       headers: {
         Authorization: `Bearer ${accessToken}`,
         ...(isPost && {'Content-Type': 'application/json'}),
+        ...opts.headers,
       },
       ...(isPost && {
         method: opts?.method,
@@ -80,7 +82,7 @@ export async function makeCall({
   } catch (error) {
     if ((error as Error).name === 'AbortError') throw error;
 
-    throw new Error(`Failed request: ${error}`);
+    throw new Error(`Failed request: ${error as Error}`);
   }
 
   if (!response.ok) {

package/src/models/model.ts

@@ -6,13 +6,12 @@ import {
   QueryParameters,
   SpatialFilter,
 } from '../types.js';
-import {$TODO} from '../types-internal.js';
 import {assert, isPureObject} from '../utils.js';
 import {ModelRequestOptions, makeCall} from './common.js';
 import {ApiVersion} from '../constants.js';
 import {SpatialDataType, SpatialFilterPolyfillMode} from '../sources/types.js';
 
-/** @internalRemarks Source: @carto/react-api */
+/** @privateRemarks Source: @carto/react-api */
 const AVAILABLE_MODELS = [
   'category',
   'histogram',
@@ -51,7 +50,7 @@ const REQUEST_GET_MAX_URL_LENGTH = 2048;
 
 /**
  * Execute a SQL model request.
- * @internalRemarks Source: @carto/react-api
+ * @privateRemarks Source: @carto/react-api
  */
 export function executeModel(props: {
   model: Model;
@@ -152,7 +151,7 @@ function objectToURLSearchParams(object: Record<string, unknown>) {
     } else if (object[key] === null) {
       params.append(key, 'null');
     } else if (object[key] !== undefined) {
-      params.append(key, String(object[key]));
+      params.append(key, String(object[key] as unknown));
     }
   }
   return params;

package/src/operations/aggregation.ts

@@ -1,14 +1,14 @@
-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 AggregationFunction = (
   values: unknown[] | FeatureData[],
   keys?: string[] | string,
   joinOperation?: AggregationType
 ) => number;
 
-/** @internalRemarks Source: @carto/react-core */
+/** @privateRemarks Source: @carto/react-core */
 export const aggregationFunctions: Record<
   Exclude<AggregationType, 'custom'>,
   AggregationFunction
@@ -20,7 +20,7 @@ export const aggregationFunctions: Record<
   avg: (...args) => applyAggregationFunction(avg, ...args),
 };
 
-/** @internalRemarks Source: @carto/react-core */
+/** @privateRemarks Source: @carto/react-core */
 export function aggregate(
   feature: FeatureData,
   keys?: string[],

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 & {

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 & {

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 &

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 &

package/src/sources/h3-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 H3TilesetSourceOptions = SourceOptions & TilesetSourceOptions;
 type UrlParameters = {name: string};
@@ -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/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,
@@ -19,73 +19,73 @@ export type {
   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 &

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 &