@carto/api-client 0.4.7-0 → 0.4.7-alpha.1

package/src/sources/types.ts

@@ -191,12 +191,6 @@ 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 = {

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

@@ -2,12 +2,6 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-import {DEFAULT_GEO_COLUMN} from '../constants-internal.js';
-import {getTileFormat} from '../utils/getTileFormat.js';
-import {
-  WidgetTilesetSource,
-  WidgetTilesetSourceResult,
-} from '../widget-sources/index.js';
 import {baseSource} from './base-source.js';
 import type {
   SourceOptions,
@@ -18,24 +12,17 @@ import type {
 export type VectorTilesetSourceOptions = SourceOptions & TilesetSourceOptions;
 type UrlParameters = {name: string};
 
-export type VectorTilesetSourceResponse = TilejsonResult &
-  WidgetTilesetSourceResult;
+export type VectorTilesetSourceResponse = TilejsonResult;
 
 export const vectorTilesetSource = async function (
   options: VectorTilesetSourceOptions
 ): Promise<VectorTilesetSourceResponse> {
-  const {tableName, spatialDataColumn = DEFAULT_GEO_COLUMN} = options;
+  const {tableName} = options;
   const urlParameters: UrlParameters = {name: tableName};
 
-  return baseSource<UrlParameters>('tileset', options, urlParameters).then(
-    (result) => ({
-      ...(result as TilejsonResult),
-      widgetSource: new WidgetTilesetSource({
-        ...options,
-        tileFormat: getTileFormat(result as TilejsonResult),
-        spatialDataColumn,
-        spatialDataType: 'geo',
-      }),
-    })
+  return baseSource<UrlParameters>(
+    'tileset',
+    options,
+    urlParameters
   ) as Promise<VectorTilesetSourceResponse>;
 };

package/src/widget-sources/types.ts

@@ -19,6 +19,8 @@ export interface ViewState {
 
 /** Common options for {@link WidgetRemoteSource} requests. */
 interface BaseRequestOptions {
+  /** @deprecated */
+  abortController?: AbortController;
   signal?: AbortSignal;
   spatialFilter?: SpatialFilter;
   spatialFiltersMode?: SpatialFilterPolyfillMode;

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

@@ -1,4 +1,4 @@
-import {executeModel, ModelSource} from '../models/index.js';
+import {executeModel} from '../models/index.js';
 import {
   CategoryRequestOptions,
   CategoryResponse,
@@ -17,12 +17,9 @@ import {
   TimeSeriesRequestOptions,
   TimeSeriesResponse,
 } from './types.js';
-import {getApplicableFilters, normalizeObjectKeys} from '../utils.js';
+import {normalizeObjectKeys} from '../utils.js';
 import {DEFAULT_TILE_RESOLUTION} from '../constants-internal.js';
 import {WidgetSource, WidgetSourceProps} from './widget-source.js';
-import {Filters} from '../types.js';
-import {ApiVersion} from '../constants.js';
-import {AggregationOptions} from '../sources/types.js';
 
 export type WidgetRemoteSourceProps = WidgetSourceProps;
 
@@ -34,36 +31,6 @@ export type WidgetRemoteSourceProps = WidgetSourceProps;
 export abstract class WidgetRemoteSource<
   Props extends WidgetRemoteSourceProps,
 > extends WidgetSource<Props> {
-  /**
-   * Subclasses of {@link WidgetRemoteSource} must implement this method, calling
-   * {@link WidgetRemoteSource.prototype._getModelSource} for common source
-   * properties, and adding additional required properties including 'type' and
-   * 'data'.
-   */
-  protected abstract getModelSource(
-    filters: Filters | undefined,
-    filterOwner?: string
-  ): ModelSource;
-
-  protected _getModelSource(
-    filters: Filters | undefined,
-    filterOwner?: string
-  ): Omit<ModelSource, 'type' | 'data'> {
-    const props = this.props;
-    return {
-      apiVersion: props.apiVersion as ApiVersion,
-      apiBaseUrl: props.apiBaseUrl as string,
-      clientId: props.clientId as string,
-      accessToken: props.accessToken,
-      connectionName: props.connectionName,
-      filters: getApplicableFilters(filterOwner, filters || props.filters),
-      filtersLogicalOperator: props.filtersLogicalOperator,
-      spatialDataType: props.spatialDataType,
-      spatialDataColumn: props.spatialDataColumn,
-      dataResolution: (props as Partial<AggregationOptions>).dataResolution,
-    };
-  }
-
   async getCategories(
     options: CategoryRequestOptions
   ): Promise<CategoryResponse> {
@@ -107,7 +74,8 @@ export abstract class WidgetRemoteSource<
     options: FeaturesRequestOptions
   ): Promise<FeaturesResponse> {
     const {
-      signal,
+      abortController,
+      signal = abortController?.signal,
       filters = this.props.filters,
       filterOwner,
       spatialFilter,
@@ -148,7 +116,8 @@ export abstract class WidgetRemoteSource<
 
   async getFormula(options: FormulaRequestOptions): Promise<FormulaResponse> {
     const {
-      signal,
+      abortController,
+      signal = abortController?.signal,
       filters = this.props.filters,
       filterOwner,
       spatialFilter,
@@ -188,7 +157,8 @@ export abstract class WidgetRemoteSource<
     options: HistogramRequestOptions
   ): Promise<HistogramResponse> {
     const {
-      signal,
+      abortController,
+      signal = abortController?.signal,
       filters = this.props.filters,
       filterOwner,
       spatialFilter,
@@ -233,7 +203,8 @@ export abstract class WidgetRemoteSource<
 
   async getRange(options: RangeRequestOptions): Promise<RangeResponse> {
     const {
-      signal,
+      abortController,
+      signal = abortController?.signal,
       filters = this.props.filters,
       filterOwner,
       spatialFilter,
@@ -266,7 +237,8 @@ export abstract class WidgetRemoteSource<
 
   async getScatter(options: ScatterRequestOptions): Promise<ScatterResponse> {
     const {
-      signal,
+      abortController,
+      signal = abortController?.signal,
       filters = this.props.filters,
       filterOwner,
       spatialFilter,
@@ -312,7 +284,8 @@ export abstract class WidgetRemoteSource<
 
   async getTable(options: TableRequestOptions): Promise<TableResponse> {
     const {
-      signal,
+      abortController,
+      signal = abortController?.signal,
       filters = this.props.filters,
       filterOwner,
       spatialFilter,
@@ -360,7 +333,8 @@ export abstract class WidgetRemoteSource<
     options: TimeSeriesRequestOptions
   ): Promise<TimeSeriesResponse> {
     const {
-      signal,
+      abortController,
+      signal = abortController?.signal,
       filters = this.props.filters,
       filterOwner,
       spatialFilter,

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

@@ -17,12 +17,19 @@ import {
   TimeSeriesResponse,
   ViewState,
 } from './types.js';
-import {FilterLogicalOperator, Filter, SpatialFilter} from '../types.js';
+import {
+  FilterLogicalOperator,
+  Filter,
+  SpatialFilter,
+  Filters,
+} from '../types.js';
+import {getApplicableFilters} from '../utils.js';
 import {getClient} from '../client.js';
 import {ModelSource} from '../models/model.js';
 import {SourceOptions} from '../sources/index.js';
 import {ApiVersion, DEFAULT_API_BASE_URL} from '../constants.js';
 import {getSpatialFiltersResolution} from '../spatial-index.js';
+import {AggregationOptions} from '../sources/types.js';
 
 export interface WidgetSourceProps extends Omit<SourceOptions, 'filters'> {
   apiVersion?: ApiVersion;
@@ -35,9 +42,7 @@ export interface WidgetSourceProps extends Omit<SourceOptions, 'filters'> {
  *
  * Abstract class. Use {@link WidgetQuerySource} or {@link WidgetTableSource}.
  */
-export abstract class WidgetSource<
-  Props extends WidgetSourceProps = WidgetSourceProps,
-> {
+export abstract class WidgetSource<Props extends WidgetSourceProps> {
   readonly props: Props;
 
   static defaultProps: Partial<WidgetSourceProps> = {
@@ -49,18 +54,41 @@ export abstract class WidgetSource<
   };
 
   constructor(props: Props) {
-    this.props = {...WidgetSource.defaultProps, ...props};
+    this.props = {
+      ...WidgetSource.defaultProps,
+      clientId: getClient(), // Refresh clientId, default may have changed.
+      ...props,
+    };
   }
 
   /**
-   * Destroys the widget source and releases allocated resources.
-   *
-   * For remote sources (tables, queries) this has no effect, but for local
-   * sources (tilesets, rasters) these resources will affect performance
-   * and stability if many (10+) sources are created and not released.
+   * Subclasses of {@link WidgetRemoteSource} must implement this method, calling
+   * {@link WidgetRemoteSource.prototype._getModelSource} for common source
+   * properties, and adding additional required properties including 'type' and
+   * 'data'.
    */
-  destroy() {
-    // no-op in most cases, but required for worker sources.
+  protected abstract getModelSource(
+    filters: Filters | undefined,
+    filterOwner?: string
+  ): ModelSource;
+
+  protected _getModelSource(
+    filters: Filters | undefined,
+    filterOwner?: string
+  ): Omit<ModelSource, 'type' | 'data'> {
+    const props = this.props;
+    return {
+      apiVersion: props.apiVersion as ApiVersion,
+      apiBaseUrl: props.apiBaseUrl as string,
+      clientId: props.clientId as string,
+      accessToken: props.accessToken,
+      connectionName: props.connectionName,
+      filters: getApplicableFilters(filterOwner, filters || props.filters),
+      filtersLogicalOperator: props.filtersLogicalOperator,
+      spatialDataType: props.spatialDataType,
+      spatialDataColumn: props.spatialDataColumn,
+      dataResolution: (props as Partial<AggregationOptions>).dataResolution,
+    };
   }
 
   protected _getSpatialFiltersResolution(
@@ -143,3 +171,15 @@ export abstract class WidgetSource<
     options: TimeSeriesRequestOptions
   ): Promise<TimeSeriesResponse>;
 }
+
+/**
+ * @todo TODO(v0.5): Remove WidgetBaseSourceProps alias
+ * @deprecated Use WidgetSourceProps.
+ */
+export type WidgetBaseSourceProps = WidgetSourceProps;
+
+/**
+ * @todo TODO(v0.5): Remove WidgetBaseSource alias.
+ * @deprecated Use WidgetSourceP.
+ */
+export const WidgetBaseSource = WidgetSource;