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

package/build/types.d.ts

@@ -4,9 +4,9 @@ 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';
 /**
  * Alias for GeoJSON 'BBox' type, semantically representing a viewport.
@@ -18,7 +18,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: {
@@ -52,7 +52,7 @@ export type RasterTile = Tile & {
     };
     data?: Raster;
 };
-/** @internalRemarks Source: @deck.gl/carto */
+/** @privateRemarks Source: @deck.gl/carto */
 export type Raster = {
     blockSize: number;
     cells: {
@@ -66,20 +66,20 @@ 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' | 'avg' | 'min' | 'max' | 'sum' | 'custom';
 /******************************************************************************
  * 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;
@@ -105,7 +105,7 @@ export interface Filter {
         params?: StringSearchOptions;
     };
 }
-/** @internalRemarks Source: @carto/react-core */
+/** @privateRemarks Source: @carto/react-core */
 export type FilterLogicalOperator = 'and' | 'or';
 /**
  * Type for minimum or maximum value of an interval. Values 'null' and
@@ -127,7 +127,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' | 'month' | 'week' | 'day' | 'hour' | 'minute' | 'second';
 /******************************************************************************
@@ -138,11 +138,11 @@ export type SortColumnType = 'number' | 'string' | 'date';
 /******************************************************************************
  * SQL QUERY PARAMETERS
  */
-/** @internalRemarks Source: @deck.gl/carto */
+/** @privateRemarks Source: @deck.gl/carto */
 export type QueryParameterValue = string | number | boolean | 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/build/utils/makeIntervalComplete.d.ts

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

package/build/utils.d.ts

@@ -9,14 +9,14 @@ 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 declare function normalizeObjectKeys<T, R extends Row<T>>(el: R): R;
-/** @internalRemarks Source: @carto/react-core */
+/** @privateRemarks Source: @carto/react-core */
 export declare function assert(condition: unknown, message: string): asserts condition;
 /**
- * @internalRemarks Source: @carto/react-core
+ * @privateRemarks Source: @carto/react-core
  * @internal
  */
 export declare class InvalidColumnError extends Error {

package/build/widget-sources/types.d.ts

@@ -1,5 +1,5 @@
-import { SpatialFilterPolyfillMode, TileResolution } from '../sources/types';
-import { GroupDateType, SortColumnType, SortDirection, SpatialFilter } from '../types';
+import { SpatialFilterPolyfillMode, TileResolution } from '../sources/types.js';
+import { Filters, GroupDateType, SortColumnType, SortDirection, SpatialFilter } from '../types.js';
 /******************************************************************************
  * WIDGET API REQUESTS
  */
@@ -15,6 +15,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;
 }
 /** Options for {@link WidgetRemoteSource#getCategories}. */

package/build/widget-sources/widget-query-source.d.ts

@@ -1,6 +1,7 @@
 import { H3QuerySourceOptions, QuadbinQuerySourceOptions, VectorQuerySourceOptions } from '../sources/index.js';
 import { WidgetRemoteSource, WidgetRemoteSourceProps } from './widget-remote-source.js';
 import { ModelSource } from '../models/model.js';
+import { Filters } from '../types.js';
 type LayerQuerySourceOptions = Omit<VectorQuerySourceOptions, 'filters'> | Omit<H3QuerySourceOptions, 'filters'> | Omit<QuadbinQuerySourceOptions, 'filters'>;
 export type WidgetQuerySourceResult = {
     widgetSource: WidgetQuerySource;
@@ -28,6 +29,6 @@ export type WidgetQuerySourceResult = {
  * ```
  */
 export declare class WidgetQuerySource extends WidgetRemoteSource<LayerQuerySourceOptions & WidgetRemoteSourceProps> {
-    protected getModelSource(owner: string): ModelSource;
+    protected getModelSource(filters: Filters | undefined, filterOwner?: string): ModelSource;
 }
 export {};

package/build/widget-sources/widget-remote-source.d.ts

@@ -7,6 +7,9 @@ export type WidgetRemoteSourceProps = WidgetSourceProps;
  * Abstract class. Use {@link WidgetQuerySource} or {@link WidgetTableSource}.
  */
 export declare abstract class WidgetRemoteSource<Props extends WidgetRemoteSourceProps> extends WidgetSource<Props> {
+    protected _headers: Record<string, string>;
+    /** Assigns HTTP headers to be included on API requests from this source. */
+    setRequestHeaders(headers: Record<string, string>): void;
     getCategories(options: CategoryRequestOptions): Promise<CategoryResponse>;
     getFeatures(options: FeaturesRequestOptions): Promise<FeaturesResponse>;
     getFormula(options: FormulaRequestOptions): Promise<FormulaResponse>;

package/build/widget-sources/widget-source.d.ts

@@ -1,5 +1,5 @@
 import { CategoryRequestOptions, CategoryResponse, FeaturesRequestOptions, FeaturesResponse, FormulaRequestOptions, FormulaResponse, HistogramRequestOptions, HistogramResponse, RangeRequestOptions, RangeResponse, ScatterRequestOptions, ScatterResponse, TableRequestOptions, TableResponse, TimeSeriesRequestOptions, TimeSeriesResponse, ViewState } from './types.js';
-import { FilterLogicalOperator, Filter, SpatialFilter } from '../types.js';
+import { FilterLogicalOperator, Filter, SpatialFilter, Filters } from '../types.js';
 import { ModelSource } from '../models/model.js';
 import { SourceOptions } from '../sources/index.js';
 import { ApiVersion } from '../constants.js';
@@ -23,8 +23,8 @@ export declare abstract class WidgetSource<Props extends WidgetSourceProps> {
      * properties, and adding additional required properties including 'type' and
      * 'data'.
      */
-    protected abstract getModelSource(owner: string | undefined): ModelSource;
-    protected _getModelSource(owner?: string): Omit<ModelSource, 'type' | 'data'>;
+    protected abstract getModelSource(filters: Filters | undefined, filterOwner?: string): ModelSource;
+    protected _getModelSource(filters: Filters | undefined, filterOwner?: string): Omit<ModelSource, 'type' | 'data'>;
     protected _getSpatialFiltersResolution(source: Omit<ModelSource, 'type' | 'data'>, spatialFilter?: SpatialFilter, referenceViewState?: ViewState): number | undefined;
     /**
      * Returns a list of labeled datapoints for categorical data. Suitable for

package/build/widget-sources/widget-table-source.d.ts

@@ -1,6 +1,7 @@
 import { H3TableSourceOptions, QuadbinTableSourceOptions, VectorTableSourceOptions } from '../sources/index.js';
 import { WidgetRemoteSource, WidgetRemoteSourceProps } from './widget-remote-source.js';
 import { ModelSource } from '../models/model.js';
+import { Filters } from '../types.js';
 type LayerTableSourceOptions = Omit<VectorTableSourceOptions, 'filters'> | Omit<H3TableSourceOptions, 'filters'> | Omit<QuadbinTableSourceOptions, 'filters'>;
 export type WidgetTableSourceResult = {
     widgetSource: WidgetTableSource;
@@ -28,6 +29,6 @@ export type WidgetTableSourceResult = {
  * ```
  */
 export declare class WidgetTableSource extends WidgetRemoteSource<LayerTableSourceOptions & WidgetRemoteSourceProps> {
-    protected getModelSource(owner: string): ModelSource;
+    protected getModelSource(filters: Filters | undefined, filterOwner?: string): ModelSource;
 }
 export {};

package/build/widget-sources/widget-tileset-source.d.ts

@@ -1,10 +1,9 @@
 import { TilesetSourceOptions } from '../sources/index.js';
 import type { ModelSource } from '../models/index.js';
-import { CategoryRequestOptions, CategoryResponse, FeaturesRequestOptions, FeaturesResponse, FormulaRequestOptions, FormulaResponse, HistogramRequestOptions, HistogramResponse, RangeRequestOptions, RangeResponse, ScatterRequestOptions, ScatterResponse, TableRequestOptions, TableResponse, TimeSeriesRequestOptions, TimeSeriesResponse } from './types.js';
+import { CategoryRequestOptions, CategoryResponse, FeaturesResponse, FormulaRequestOptions, FormulaResponse, HistogramRequestOptions, HistogramResponse, RangeRequestOptions, RangeResponse, ScatterRequestOptions, ScatterResponse, TableRequestOptions, TableResponse, TimeSeriesRequestOptions, TimeSeriesResponse } from './types.js';
 import { TileFormat } from '../constants.js';
-import { SpatialFilter, Tile } from '../types.js';
+import { Filters, SpatialFilter } from '../types.js';
 import { TileFeatureExtractOptions } from '../filters/index.js';
-import { FeatureData } from '../types-internal.js';
 import { FeatureCollection } from 'geojson';
 import { SpatialDataType } from '../sources/types.js';
 import { WidgetSource, WidgetSourceProps } from './widget-source.js';
@@ -38,38 +37,37 @@ export type WidgetTilesetSourceResult = {
  * ```
  */
 export declare class WidgetTilesetSource<Props extends WidgetTilesetSourceProps = WidgetTilesetSourceProps> extends WidgetSource<Props> {
-    protected _tiles: Tile[];
-    protected _features: FeatureData[];
-    protected getModelSource(owner: string): ModelSource;
+    private _tiles;
+    private _features;
+    private _tileFeatureExtractOptions;
+    private _tileFeatureExtractPreviousInputs;
+    protected getModelSource(filters: Filters | undefined, filterOwner: string): ModelSource;
     /**
      * Loads features as a list of tiles (typically provided by deck.gl).
      * After tiles are loaded, {@link extractTileFeatures} must be called
      * before computing statistics on the tiles.
      */
     loadTiles(tiles: unknown[]): void;
+    /** Configures options used to extract features from tiles. */
+    setTileFeatureExtractOptions(options: TileFeatureExtractOptions): void;
+    protected _extractTileFeatures(spatialFilter: SpatialFilter): void;
     /**
-     * Extracts feature data from tiles previously loaded with {@link loadTiles}.
-     * Must be called before computing statistics on tiles.
+     * Loads features as GeoJSON (used for testing).
+     * @experimental
+     * @internal Not for public use. Spatial filters in other method calls will be ignored.
      */
-    extractTileFeatures({ spatialFilter, uniqueIdProperty, options, }: {
-        spatialFilter: SpatialFilter;
-        uniqueIdProperty?: string;
-        options?: TileFeatureExtractOptions;
-    }): void;
-    /** Loads features as GeoJSON (used for testing). */
-    loadGeoJSON({ geojson, spatialFilter, uniqueIdProperty, }: {
+    loadGeoJSON({ geojson, spatialFilter, }: {
         geojson: FeatureCollection;
         spatialFilter: SpatialFilter;
-        uniqueIdProperty?: string;
     }): void;
-    getFeatures(options: FeaturesRequestOptions): Promise<FeaturesResponse>;
-    getFormula({ column, operation, joinOperation, filterOwner, }: FormulaRequestOptions): Promise<FormulaResponse>;
-    getHistogram({ operation, ticks, column, joinOperation, filterOwner, }: HistogramRequestOptions): Promise<HistogramResponse>;
-    getCategories({ column, operation, operationColumn, joinOperation, filterOwner, }: CategoryRequestOptions): Promise<CategoryResponse>;
-    getScatter({ xAxisColumn, yAxisColumn, xAxisJoinOperation, yAxisJoinOperation, filterOwner, }: ScatterRequestOptions): Promise<ScatterResponse>;
-    getTable(options: TableRequestOptions): Promise<TableResponse>;
-    getTimeSeries({ column, stepSize, operation, operationColumn, joinOperation, filterOwner, }: TimeSeriesRequestOptions): Promise<TimeSeriesResponse>;
-    getRange({ column, filterOwner, }: RangeRequestOptions): Promise<RangeResponse>;
+    getFeatures(): Promise<FeaturesResponse>;
+    getFormula({ column, operation, joinOperation, filters, filterOwner, spatialFilter, }: FormulaRequestOptions): Promise<FormulaResponse>;
+    getHistogram({ operation, ticks, column, joinOperation, filters, filterOwner, spatialFilter, }: HistogramRequestOptions): Promise<HistogramResponse>;
+    getCategories({ column, operation, operationColumn, joinOperation, filters, filterOwner, spatialFilter, }: CategoryRequestOptions): Promise<CategoryResponse>;
+    getScatter({ xAxisColumn, yAxisColumn, xAxisJoinOperation, yAxisJoinOperation, filters, filterOwner, spatialFilter, }: ScatterRequestOptions): Promise<ScatterResponse>;
+    getTable({ columns, searchFilterColumn, searchFilterText, sortBy, sortDirection, sortByColumnType, offset, limit, filters, filterOwner, spatialFilter, }: TableRequestOptions): Promise<TableResponse>;
+    getTimeSeries({ column, stepSize, operation, operationColumn, joinOperation, filters, filterOwner, spatialFilter, }: TimeSeriesRequestOptions): Promise<TimeSeriesResponse>;
+    getRange({ column, filters, filterOwner, spatialFilter, }: RangeRequestOptions): Promise<RangeResponse>;
     /****************************************************************************
      * INTERNAL
      */

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.4",
   "license": "MIT",
   "publishConfig": {
     "access": "public",
@@ -39,11 +39,12 @@
     "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",
+    "postversion:check": "yarn lint && yarn format:check && yarn test",
     "postversion:commit": "node scripts/postversion-commit.js",
     "postversion:push": "git push && git push --tags",
     "prepublish": "yarn lint && yarn test",
@@ -57,53 +58,58 @@
   ],
   "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",
+    "@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",
     "quadbin": "^0.4.0-alpha.2"
   },
   "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",
+    "@luma.gl/core": "~9.1.0",
+    "@luma.gl/engine": "~9.1.0",
+    "@luma.gl/shadertools": "~9.1.0",
     "@turf/buffer": "^7.2.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",
+    "maplibre-gl": "^5.1.0",
     "microbundle": "^0.15.1",
     "prettier": "^3.4.2",
     "rimraf": "^6.0.1",
-    "semver": "^7.6.3",
+    "semver": "^7.7.1",
     "thenby": "^1.3.4",
     "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

@@ -7,26 +7,26 @@ 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',