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

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,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,
@@ -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 &

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,15 +2,19 @@
 // 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 {getTileFormat} from '../utils/getTileFormat.js';
+import {
+  WidgetRasterSource,
+  WidgetRasterSourceResult,
+} from '../widget-sources/index.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. */
@@ -208,7 +208,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 &

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

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};
@@ -46,7 +46,7 @@ export type RasterTile = Tile & {
   data?: Raster;
 };
 
-/** @internalRemarks Source: @deck.gl/carto */
+/** @privateRemarks Source: @deck.gl/carto */
 export type Raster = {
   blockSize: number;
   cells: {
@@ -62,8 +62,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 +77,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 +100,7 @@ export interface Filter {
   };
 }
 
-/** @internalRemarks Source: @carto/react-core */
+/** @privateRemarks Source: @carto/react-core */
 export type FilterLogicalOperator = 'and' | 'or';
 
 /**
@@ -126,7 +126,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 +148,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 +156,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/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;
 }