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

package/build/types-internal.d.ts

@@ -1,7 +1,7 @@
 /******************************************************************************
  * COMMON
  */
-import { Format } from './types';
+import { Format } from './types.js';
 /** @internal */
 export type $TODO = any;
 /** @internal */
@@ -10,7 +10,7 @@ export type $IntentionalAny = any;
  * MAP INSTANTIATION
  */
 /**
- * @internalRemarks Source: @deck.gl/carto
+ * @privateRemarks Source: @deck.gl/carto
  * @internal
  */
 export declare enum SchemaFieldType {
@@ -25,7 +25,7 @@ export declare enum SchemaFieldType {
     Unknown = "unknown"
 }
 /**
- * @internalRemarks Source: @deck.gl/carto
+ * @privateRemarks Source: @deck.gl/carto
  * @internal
  */
 export interface SchemaField {
@@ -33,7 +33,7 @@ export interface SchemaField {
     type: SchemaFieldType;
 }
 /**
- * @internalRemarks Source: @deck.gl/carto
+ * @privateRemarks Source: @deck.gl/carto
  * @internal
  */
 export interface MapInstantiation extends MapInstantiationFormats {
@@ -42,11 +42,15 @@ export interface MapInstantiation extends MapInstantiationFormats {
     schema: SchemaField[];
 }
 /**
- * @internalRemarks Source: @deck.gl/carto
+ * @privateRemarks Source: @deck.gl/carto
  * @internal
  */
 type MapInstantiationFormats = Record<Format, {
     url: string[];
     error?: any;
 }>;
+/******************************************************************************
+ * LOCAL CALCULATIONS
+ */
+export type FeatureData = Record<string, unknown>;
 export {};

package/build/types.d.ts

@@ -1,32 +1,77 @@
 import type { FilterType } from './constants.js';
-import type { Polygon, MultiPolygon } from 'geojson';
+import type { Polygon, MultiPolygon, Feature } from 'geojson';
+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.
+ * Order of values is "west", "south", "east", "north".
+ */
+export type Viewport = [number, number, number, number];
+/**
+ * Subset of deck.gl's Tile2DHeader type, containing only the properties
+ * 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.
+ * @privateRemarks Source: @deck.gl/geo-layers
+ */
+export type Tile = {
+    index: {
+        x: number;
+        y: number;
+        z: number;
+    };
+    id: string;
+    content: unknown;
+    zoom: number;
+    bbox: {
+        west: number;
+        east: number;
+        north: number;
+        south: number;
+    };
+    isVisible: boolean;
+    data?: BinaryFeatureCollection;
+};
+/** Subset of deck.gl's Tile2DHeader type, for spatial indexes. */
+export type SpatialIndexTile = Tile & {
+    data?: (Feature & {
+        id: bigint;
+    })[];
+};
+/** @privateRemarks Source: @deck.gl/carto */
+export type Raster = {
+    blockSize: number;
+    cells: {
+        numericProps: BinaryFeature['numericProps'];
+        properties: BinaryFeature['properties'];
+    };
+};
 /******************************************************************************
  * AGGREGATION
  */
 /**
  * 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;
@@ -49,17 +94,32 @@ export interface Filter {
     [FilterType.STRING_SEARCH]?: {
         owner?: string;
         values: string[];
+        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
+ * 'undefined' are intentionally allowed, and represent an unbounded value.
+ */
+export type FilterIntervalExtremum = number | null | undefined;
+export type FilterInterval = [FilterIntervalExtremum, FilterIntervalExtremum];
+export type FilterIntervalComplete = [number, number];
+export type StringSearchOptions = {
+    useRegExp?: boolean;
+    mustStart?: boolean;
+    mustEnd?: boolean;
+    caseSensitive?: boolean;
+    keepSpecialCharacters?: boolean;
+};
 /******************************************************************************
  * GROUPING
  */
 /**
  * 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';
 /******************************************************************************
@@ -70,11 +130,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/dateUtils.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Returns midnight (local time) on the Monday preceeding a given date, in
+ * milliseconds since the UNIX epoch.
+ */
+export declare function getMonday(date: number | Date): number;
+/**
+ * Returns midnight (UTC) on the Monday preceeding a given date, in
+ * milliseconds since the UNIX epoch.
+ */
+export declare function getUTCMonday(date: number | Date): number;

package/build/utils/getTileFormat.d.ts

@@ -0,0 +1,3 @@
+import { TileFormat } from '../constants.js';
+import { Tilejson } from '../sources/types.js';
+export declare function getTileFormat(tilejson: Tilejson): TileFormat;

package/build/utils/makeIntervalComplete.d.ts

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

package/build/utils/transformTileCoordsToWGS84.d.ts

@@ -0,0 +1,8 @@
+import { BBox, Geometry } from 'geojson';
+/**
+ * Transform tile coords to WGS84 coordinates.
+ *
+ * @param geometry - any valid geojson geometry
+ * @param bbox - geojson bbox
+ */
+export declare function transformTileCoordsToWGS84<T extends Geometry>(geometry: T, bbox: BBox): T;

package/build/utils/transformToTileCoords.d.ts

@@ -0,0 +1,9 @@
+import { BBox, Geometry } from 'geojson';
+/**
+ * Transform WGS84 coordinates to tile coords.
+ * It's the inverse of deck.gl coordinate-transform (https://github.com/visgl/deck.gl/blob/master/modules/geo-layers/src/mvt-layer/coordinate-transform.js)
+ *
+ * @param geometry - any valid geojson geometry
+ * @param bbox - geojson bbox
+ */
+export declare function transformToTileCoords<T extends Geometry>(geometry: T, bbox: BBox): T;

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

@@ -1,4 +1,6 @@
-export * from './widget-base-source.js';
+export * from './widget-source.js';
 export * from './widget-query-source.js';
+export * from './widget-remote-source.js';
 export * from './widget-table-source.js';
+export * from './widget-tileset-source.js';
 export * from './types.js';

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
  */
@@ -8,23 +8,29 @@ export interface ViewState {
     latitude: number;
     longitude: number;
 }
-/** Common options for {@link WidgetBaseSource} requests. */
+/** Common options for {@link WidgetRemoteSource} requests. */
 interface BaseRequestOptions {
+    /** @deprecated */
+    abortController?: AbortController;
+    signal?: AbortSignal;
     spatialFilter?: SpatialFilter;
     spatialFiltersMode?: SpatialFilterPolyfillMode;
     /** 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 WidgetBaseSource#getCategories}. */
+/** Options for {@link WidgetRemoteSource#getCategories}. */
 export interface CategoryRequestOptions extends BaseRequestOptions {
     column: string;
     operation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
     operationColumn?: string;
+    /** Local only. */
+    joinOperation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
 }
 /**
- * Options for {@link WidgetBaseSource#getFeatures}.
+ * Options for {@link WidgetRemoteSource#getFeatures}.
  * @experimental
  * @internal
  */
@@ -60,30 +66,33 @@ export interface FeaturesRequestOptions extends BaseRequestOptions {
      */
     tileResolution?: TileResolution;
 }
-/** Options for {@link WidgetBaseSource#getFormula}. */
+/** Options for {@link WidgetRemoteSource#getFormula}. */
 export interface FormulaRequestOptions extends BaseRequestOptions {
     column: string;
-    operation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
+    operation?: 'count' | 'avg' | 'min' | 'max' | 'sum' | 'custom';
     operationExp?: string;
+    joinOperation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
 }
-/** Options for {@link WidgetBaseSource#getHistogram}. */
+/** Options for {@link WidgetRemoteSource#getHistogram}. */
 export interface HistogramRequestOptions extends BaseRequestOptions {
     column: string;
     ticks: number[];
     operation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
+    /** Local only. */
+    joinOperation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
 }
-/** Options for {@link WidgetBaseSource#getRange}. */
+/** Options for {@link WidgetRemoteSource#getRange}. */
 export interface RangeRequestOptions extends BaseRequestOptions {
     column: string;
 }
-/** Options for {@link WidgetBaseSource#getScatter}. */
+/** Options for {@link WidgetRemoteSource#getScatter}. */
 export interface ScatterRequestOptions extends BaseRequestOptions {
     xAxisColumn: string;
     xAxisJoinOperation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
     yAxisColumn: string;
     yAxisJoinOperation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
 }
-/** Options for {@link WidgetBaseSource#getTable}. */
+/** Options for {@link WidgetRemoteSource#getTable}. */
 export interface TableRequestOptions extends BaseRequestOptions {
     columns: string[];
     sortBy?: string;
@@ -91,11 +100,15 @@ export interface TableRequestOptions extends BaseRequestOptions {
     sortByColumnType?: SortColumnType;
     offset?: number;
     limit?: number;
+    /** Local only. */
+    searchFilterColumn?: string;
+    /** Local only. */
+    searchFilterText?: string;
 }
-/** Options for {@link WidgetBaseSource#getTimeSeries}. */
+/** Options for {@link WidgetRemoteSource#getTimeSeries}. */
 export interface TimeSeriesRequestOptions extends BaseRequestOptions {
     column: string;
-    stepSize?: GroupDateType;
+    stepSize: GroupDateType;
     stepMultiplier?: number;
     operation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
     operationColumn?: string;
@@ -108,42 +121,42 @@ export interface TimeSeriesRequestOptions extends BaseRequestOptions {
  * WIDGET API RESPONSES
  */
 /**
- * Response from {@link WidgetBaseSource#getFeatures}.
+ * Response from {@link WidgetRemoteSource#getFeatures}.
  * @experimental
  * @internal
  */
 export type FeaturesResponse = {
     rows: Record<string, unknown>[];
 };
-/** Response from {@link WidgetBaseSource#getFormula}. */
+/** Response from {@link WidgetRemoteSource#getFormula}. */
 export type FormulaResponse = {
-    value: number;
+    value: number | null;
 };
-/** Response from {@link WidgetBaseSource#getCategories}. */
+/** Response from {@link WidgetRemoteSource#getCategories}. */
 export type CategoryResponse = {
     name: string;
     value: number;
 }[];
-/** Response from {@link WidgetBaseSource#getRange}. */
+/** Response from {@link WidgetRemoteSource#getRange}. */
 export type RangeResponse = {
     min: number;
     max: number;
-};
-/** Response from {@link WidgetBaseSource#getTable}. */
+} | null;
+/** Response from {@link WidgetRemoteSource#getTable}. */
 export type TableResponse = {
     totalCount: number;
     rows: Record<string, number | string>[];
 };
-/** Response from {@link WidgetBaseSource#getScatter}. */
+/** Response from {@link WidgetRemoteSource#getScatter}. */
 export type ScatterResponse = [number, number][];
-/** Response from {@link WidgetBaseSource#getTimeSeries}. */
+/** Response from {@link WidgetRemoteSource#getTimeSeries}. */
 export type TimeSeriesResponse = {
     rows: {
         name: string;
         value: number;
     }[];
-    categories: string[];
+    categories?: string[];
 };
-/** Response from {@link WidgetBaseSource#getHistogram}. */
+/** Response from {@link WidgetRemoteSource#getHistogram}. */
 export type HistogramResponse = number[];
 export {};

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

@@ -1,6 +1,7 @@
 import { H3QuerySourceOptions, QuadbinQuerySourceOptions, VectorQuerySourceOptions } from '../sources/index.js';
-import { WidgetBaseSource, WidgetBaseSourceProps } from './widget-base-source.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;
@@ -27,7 +28,7 @@ export type WidgetQuerySourceResult = {
  * const { widgetSource } = await data;
  * ```
  */
-export declare class WidgetQuerySource extends WidgetBaseSource<LayerQuerySourceOptions & WidgetBaseSourceProps> {
-    protected getModelSource(owner: string): ModelSource;
+export declare class WidgetQuerySource extends WidgetRemoteSource<LayerQuerySourceOptions & WidgetRemoteSourceProps> {
+    protected getModelSource(filters: Filters | undefined, filterOwner?: string): ModelSource;
 }
 export {};

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

@@ -0,0 +1,18 @@
+import { CategoryRequestOptions, CategoryResponse, FeaturesRequestOptions, FeaturesResponse, FormulaRequestOptions, FormulaResponse, HistogramRequestOptions, HistogramResponse, RangeRequestOptions, RangeResponse, ScatterRequestOptions, ScatterResponse, TableRequestOptions, TableResponse, TimeSeriesRequestOptions, TimeSeriesResponse } from './types.js';
+import { WidgetSource, WidgetSourceProps } from './widget-source.js';
+export type WidgetRemoteSourceProps = WidgetSourceProps;
+/**
+ * Source for Widget API requests.
+ *
+ * Abstract class. Use {@link WidgetQuerySource} or {@link WidgetTableSource}.
+ */
+export declare abstract class WidgetRemoteSource<Props extends WidgetRemoteSourceProps> extends WidgetSource<Props> {
+    getCategories(options: CategoryRequestOptions): Promise<CategoryResponse>;
+    getFeatures(options: FeaturesRequestOptions): Promise<FeaturesResponse>;
+    getFormula(options: FormulaRequestOptions): Promise<FormulaResponse>;
+    getHistogram(options: HistogramRequestOptions): Promise<HistogramResponse>;
+    getRange(options: RangeRequestOptions): Promise<RangeResponse>;
+    getScatter(options: ScatterRequestOptions): Promise<ScatterResponse>;
+    getTable(options: TableRequestOptions): Promise<TableResponse>;
+    getTimeSeries(options: TimeSeriesRequestOptions): Promise<TimeSeriesResponse>;
+}

package/build/widget-sources/{widget-base-source.d.ts → widget-source.d.ts}

@@ -1,43 +1,36 @@
 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';
-export interface WidgetBaseSourceProps extends Omit<SourceOptions, 'filters'> {
+export interface WidgetSourceProps extends Omit<SourceOptions, 'filters'> {
     apiVersion?: ApiVersion;
     filters?: Record<string, Filter>;
     filtersLogicalOperator?: FilterLogicalOperator;
 }
-export type WidgetSource = WidgetBaseSource<WidgetBaseSourceProps>;
 /**
  * Source for Widget API requests on a data source defined by a SQL query.
  *
  * Abstract class. Use {@link WidgetQuerySource} or {@link WidgetTableSource}.
  */
-export declare abstract class WidgetBaseSource<Props extends WidgetBaseSourceProps> {
+export declare abstract class WidgetSource<Props extends WidgetSourceProps> {
     readonly props: Props;
-    static defaultProps: Partial<WidgetBaseSourceProps>;
+    static defaultProps: Partial<WidgetSourceProps>;
     constructor(props: Props);
     /**
-     * Subclasses of {@link WidgetBaseSource} must implement this method, calling
-     * {@link WidgetBaseSource.prototype._getModelSource} for common source
+     * 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(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;
-    /****************************************************************************
-     * CATEGORIES
-     */
     /**
      * Returns a list of labeled datapoints for categorical data. Suitable for
      * charts including grouped bar charts, pie charts, and tree charts.
      */
-    getCategories(options: CategoryRequestOptions): Promise<CategoryResponse>;
-    /****************************************************************************
-     * FEATURES
-     */
+    abstract getCategories(options: CategoryRequestOptions): Promise<CategoryResponse>;
     /**
      * Given a list of feature IDs (as found in `_carto_feature_id`) returns all
      * matching features. In datasets containing features with duplicate geometries,
@@ -46,54 +39,36 @@ export declare abstract class WidgetBaseSource<Props extends WidgetBaseSourcePro
      * @internal
      * @experimental
      */
-    getFeatures(options: FeaturesRequestOptions): Promise<FeaturesResponse>;
-    /****************************************************************************
-     * FORMULA
-     */
+    abstract getFeatures(options: FeaturesRequestOptions): Promise<FeaturesResponse>;
     /**
      * Returns a scalar numerical statistic over all matching data. Suitable
      * for 'headline' or 'scorecard' figures such as counts and sums.
      */
-    getFormula(options: FormulaRequestOptions): Promise<FormulaResponse>;
-    /****************************************************************************
-     * HISTOGRAM
-     */
+    abstract getFormula(options: FormulaRequestOptions): Promise<FormulaResponse>;
     /**
      * Returns a list of labeled datapoints for 'bins' of data defined as ticks
      * over a numerical range. Suitable for histogram charts.
      */
-    getHistogram(options: HistogramRequestOptions): Promise<HistogramResponse>;
-    /****************************************************************************
-     * RANGE
-     */
+    abstract getHistogram(options: HistogramRequestOptions): Promise<HistogramResponse>;
     /**
      * Returns a range (min and max) for a numerical column of matching rows.
      * Suitable for displaying certain 'headline' or 'scorecard' statistics,
      * or rendering a range slider UI for filtering.
      */
-    getRange(options: RangeRequestOptions): Promise<RangeResponse>;
-    /****************************************************************************
-     * SCATTER
-     */
+    abstract getRange(options: RangeRequestOptions): Promise<RangeResponse>;
     /**
      * Returns a list of bivariate datapoints defined as numerical 'x' and 'y'
      * values. Suitable for rendering scatter plots.
      */
-    getScatter(options: ScatterRequestOptions): Promise<ScatterResponse>;
-    /****************************************************************************
-     * TABLE
-     */
+    abstract getScatter(options: ScatterRequestOptions): Promise<ScatterResponse>;
     /**
      * Returns a list of arbitrary data rows, with support for pagination and
      * sorting. Suitable for displaying tables and lists.
      */
-    getTable(options: TableRequestOptions): Promise<TableResponse>;
-    /****************************************************************************
-     * TIME SERIES
-     */
+    abstract getTable(options: TableRequestOptions): Promise<TableResponse>;
     /**
      * Returns a series of labeled numerical values, grouped into equally-sized
      * time intervals. Suitable for rendering time series charts.
      */
-    getTimeSeries(options: TimeSeriesRequestOptions): Promise<TimeSeriesResponse>;
+    abstract getTimeSeries(options: TimeSeriesRequestOptions): Promise<TimeSeriesResponse>;
 }

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

@@ -1,6 +1,7 @@
 import { H3TableSourceOptions, QuadbinTableSourceOptions, VectorTableSourceOptions } from '../sources/index.js';
-import { WidgetBaseSource, WidgetBaseSourceProps } from './widget-base-source.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;
@@ -27,7 +28,7 @@ export type WidgetTableSourceResult = {
  * const { widgetSource } = await data;
  * ```
  */
-export declare class WidgetTableSource extends WidgetBaseSource<LayerTableSourceOptions & WidgetBaseSourceProps> {
-    protected getModelSource(owner: string): ModelSource;
+export declare class WidgetTableSource extends WidgetRemoteSource<LayerTableSourceOptions & WidgetRemoteSourceProps> {
+    protected getModelSource(filters: Filters | undefined, filterOwner?: string): ModelSource;
 }
 export {};