@carto/api-client 0.4.6 → 0.4.7-0

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

@@ -1,149 +0,0 @@
-import { SpatialFilterPolyfillMode, TileResolution } from '../sources/types';
-import { GroupDateType, SortColumnType, SortDirection, SpatialFilter } from '../types';
-/******************************************************************************
- * WIDGET API REQUESTS
- */
-export interface ViewState {
-    zoom: number;
-    latitude: number;
-    longitude: number;
-}
-/** Common options for {@link WidgetBaseSource} requests. */
-interface BaseRequestOptions {
-    spatialFilter?: SpatialFilter;
-    spatialFiltersMode?: SpatialFilterPolyfillMode;
-    /** Required for table- and query-based spatial index sources (H3, Quadbin). */
-    spatialIndexReferenceViewState?: ViewState;
-    abortController?: AbortController;
-    filterOwner?: string;
-}
-/** Options for {@link WidgetBaseSource#getCategories}. */
-export interface CategoryRequestOptions extends BaseRequestOptions {
-    column: string;
-    operation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
-    operationColumn?: string;
-}
-/**
- * Options for {@link WidgetBaseSource#getFeatures}.
- * @experimental
- * @internal
- */
-export interface FeaturesRequestOptions extends BaseRequestOptions {
-    /**
-     * Feature IDs, as found in `_carto_feature_id`. Feature IDs are a hash
-     * of geometry, and features with identical geometry will have the same
-     * feature ID. Order is important; features in the result set will be
-     * sorted according to the order of IDs in the request.
-     */
-    featureIds: string[];
-    /**
-     * Columns to be returned for each picked object. Note that for datasets
-     * containing features with identical geometry, more than one result per
-     * requested feature ID may be returned. To match results back to the
-     * requested feature ID, include `_carto_feature_id` in the columns list.
-     */
-    columns: string[];
-    /** Topology of objects to be picked. */
-    dataType: 'points' | 'lines' | 'polygons';
-    /** Zoom level, required if using 'points' data type. */
-    z?: number;
-    /**
-     * Maximum number of objects to return in the result set. For datasets
-     * containing features with identical geometry, those features will have
-     * the same feature IDs, and so more results may be returned than feature IDs
-     * given in the request.
-     */
-    limit?: number;
-    /**
-     * Must match `tileResolution` used when obtaining the `_carto_feature_id`
-     * column, typically in a layer's tile requests.
-     */
-    tileResolution?: TileResolution;
-}
-/** Options for {@link WidgetBaseSource#getFormula}. */
-export interface FormulaRequestOptions extends BaseRequestOptions {
-    column: string;
-    operation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
-    operationExp?: string;
-}
-/** Options for {@link WidgetBaseSource#getHistogram}. */
-export interface HistogramRequestOptions extends BaseRequestOptions {
-    column: string;
-    ticks: number[];
-    operation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
-}
-/** Options for {@link WidgetBaseSource#getRange}. */
-export interface RangeRequestOptions extends BaseRequestOptions {
-    column: string;
-}
-/** Options for {@link WidgetBaseSource#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}. */
-export interface TableRequestOptions extends BaseRequestOptions {
-    columns: string[];
-    sortBy?: string;
-    sortDirection?: SortDirection;
-    sortByColumnType?: SortColumnType;
-    offset?: number;
-    limit?: number;
-}
-/** Options for {@link WidgetBaseSource#getTimeSeries}. */
-export interface TimeSeriesRequestOptions extends BaseRequestOptions {
-    column: string;
-    stepSize?: GroupDateType;
-    stepMultiplier?: number;
-    operation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
-    operationColumn?: string;
-    joinOperation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
-    splitByCategory?: string;
-    splitByCategoryLimit?: number;
-    splitByCategoryValues?: string[];
-}
-/******************************************************************************
- * WIDGET API RESPONSES
- */
-/**
- * Response from {@link WidgetBaseSource#getFeatures}.
- * @experimental
- * @internal
- */
-export type FeaturesResponse = {
-    rows: Record<string, unknown>[];
-};
-/** Response from {@link WidgetBaseSource#getFormula}. */
-export type FormulaResponse = {
-    value: number;
-};
-/** Response from {@link WidgetBaseSource#getCategories}. */
-export type CategoryResponse = {
-    name: string;
-    value: number;
-}[];
-/** Response from {@link WidgetBaseSource#getRange}. */
-export type RangeResponse = {
-    min: number;
-    max: number;
-};
-/** Response from {@link WidgetBaseSource#getTable}. */
-export type TableResponse = {
-    totalCount: number;
-    rows: Record<string, number | string>[];
-};
-/** Response from {@link WidgetBaseSource#getScatter}. */
-export type ScatterResponse = [number, number][];
-/** Response from {@link WidgetBaseSource#getTimeSeries}. */
-export type TimeSeriesResponse = {
-    rows: {
-        name: string;
-        value: number;
-    }[];
-    categories: string[];
-};
-/** Response from {@link WidgetBaseSource#getHistogram}. */
-export type HistogramResponse = number[];
-export {};

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

@@ -1,99 +0,0 @@
-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 { ModelSource } from '../models/model.js';
-import { SourceOptions } from '../sources/index.js';
-import { ApiVersion } from '../constants.js';
-export interface WidgetBaseSourceProps 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> {
-    readonly props: Props;
-    static defaultProps: Partial<WidgetBaseSourceProps>;
-    constructor(props: Props);
-    /**
-     * Subclasses of {@link WidgetBaseSource} must implement this method, calling
-     * {@link WidgetBaseSource.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 _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
-     */
-    /**
-     * Given a list of feature IDs (as found in `_carto_feature_id`) returns all
-     * matching features. In datasets containing features with duplicate geometries,
-     * feature IDs may be duplicated (IDs are a hash of geometry) and so more
-     * results may be returned than IDs in the request.
-     * @internal
-     * @experimental
-     */
-    getFeatures(options: FeaturesRequestOptions): Promise<FeaturesResponse>;
-    /****************************************************************************
-     * FORMULA
-     */
-    /**
-     * 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
-     */
-    /**
-     * 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
-     */
-    /**
-     * 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
-     */
-    /**
-     * Returns a list of bivariate datapoints defined as numerical 'x' and 'y'
-     * values. Suitable for rendering scatter plots.
-     */
-    getScatter(options: ScatterRequestOptions): Promise<ScatterResponse>;
-    /****************************************************************************
-     * TABLE
-     */
-    /**
-     * 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
-     */
-    /**
-     * Returns a series of labeled numerical values, grouped into equally-sized
-     * time intervals. Suitable for rendering time series charts.
-     */
-    getTimeSeries(options: TimeSeriesRequestOptions): Promise<TimeSeriesResponse>;
-}

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

@@ -1,33 +0,0 @@
-import { H3QuerySourceOptions, QuadbinQuerySourceOptions, VectorQuerySourceOptions } from '../sources/index.js';
-import { WidgetBaseSource, WidgetBaseSourceProps } from './widget-base-source.js';
-import { ModelSource } from '../models/model.js';
-type LayerQuerySourceOptions = Omit<VectorQuerySourceOptions, 'filters'> | Omit<H3QuerySourceOptions, 'filters'> | Omit<QuadbinQuerySourceOptions, 'filters'>;
-export type WidgetQuerySourceResult = {
-    widgetSource: WidgetQuerySource;
-};
-/**
- * Source for Widget API requests on a data source defined by a SQL query.
- *
- * Generally not intended to be constructed directly. Instead, call
- * {@link vectorQuerySource}, {@link h3QuerySource}, or {@link quadbinQuerySource},
- * which can be shared with map layers. Sources contain a `widgetSource` property,
- * for use by widget implementations.
- *
- * Example:
- *
- * ```javascript
- * import { vectorQuerySource } from '@carto/api-client';
- *
- * const data = vectorQuerySource({
- *   accessToken: '••••',
- *   connectionName: 'carto_dw',
- *   sqlQuery: 'SELECT * FROM carto-demo-data.demo_tables.retail_stores'
- * });
- *
- * const { widgetSource } = await data;
- * ```
- */
-export declare class WidgetQuerySource extends WidgetBaseSource<LayerQuerySourceOptions & WidgetBaseSourceProps> {
-    protected getModelSource(owner: string): ModelSource;
-}
-export {};

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

@@ -1,33 +0,0 @@
-import { H3TableSourceOptions, QuadbinTableSourceOptions, VectorTableSourceOptions } from '../sources/index.js';
-import { WidgetBaseSource, WidgetBaseSourceProps } from './widget-base-source.js';
-import { ModelSource } from '../models/model.js';
-type LayerTableSourceOptions = Omit<VectorTableSourceOptions, 'filters'> | Omit<H3TableSourceOptions, 'filters'> | Omit<QuadbinTableSourceOptions, 'filters'>;
-export type WidgetTableSourceResult = {
-    widgetSource: WidgetTableSource;
-};
-/**
- * Source for Widget API requests on a data source defined as a table.
- *
- * Generally not intended to be constructed directly. Instead, call
- * {@link vectorTableSource}, {@link h3TableSource}, or {@link quadbinTableSource},
- * which can be shared with map layers. Sources contain a `widgetSource` property,
- * for use by widget implementations.
- *
- * Example:
- *
- * ```javascript
- * import { vectorTableSource } from '@carto/api-client';
- *
- * const data = vectorTableSource({
- *   accessToken: '••••',
- *   connectionName: 'carto_dw',
- *   tableName: 'carto-demo-data.demo_tables.retail_stores'
- * });
- *
- * const { widgetSource } = await data;
- * ```
- */
-export declare class WidgetTableSource extends WidgetBaseSource<LayerTableSourceOptions & WidgetBaseSourceProps> {
-    protected getModelSource(owner: string): ModelSource;
-}
-export {};