@carto/api-client 0.3.1 → 0.4.0-alpha.1

package/src/widget-sources/types.ts

@@ -0,0 +1,105 @@
+import {
+  GroupDateType,
+  SortColumnType,
+  SortDirection,
+  SpatialFilter,
+} from '../types';
+
+/******************************************************************************
+ * WIDGET API REQUESTS
+ */
+
+/** Common options for {@link WidgetBaseSource} requests. */
+interface BaseRequestOptions {
+  spatialFilter?: SpatialFilter;
+  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#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#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[];

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

@@ -16,15 +16,15 @@ import {
   TimeSeriesResponse,
 } from './types.js';
 import {FilterLogicalOperator, Filter} from '../types.js';
-import {SourceOptions} from '@deck.gl/carto';
 import {getApplicableFilters, normalizeObjectKeys} 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,
   DEFAULT_GEO_COLUMN,
-  ApiVersion,
-} from '../constants-internal.js';
-import {getClient} from '../client.js';
-import {ModelSource} from '../models/model.js';
+} from '../constants.js';
 
 export interface WidgetBaseSourceProps extends Omit<SourceOptions, 'filters'> {
   apiVersion?: ApiVersion;

package/src/{sources → widget-sources}/widget-query-source.ts

@@ -2,8 +2,7 @@ import {
   H3QuerySourceOptions,
   QuadbinQuerySourceOptions,
   VectorQuerySourceOptions,
-} from '@deck.gl/carto';
-import {MapType} from '../constants-internal.js';
+} from '../sources/index.js';
 import {WidgetBaseSource, WidgetBaseSourceProps} from './widget-base-source.js';
 import {ModelSource} from '../models/model.js';
 
@@ -40,7 +39,7 @@ export class WidgetQuerySource extends WidgetBaseSource<
   protected override getModelSource(owner: string): ModelSource {
     return {
       ...super._getModelSource(owner),
-      type: MapType.QUERY,
+      type: 'query',
       data: this.props.sqlQuery,
       queryParameters: this.props.queryParameters,
     };

package/src/{sources → widget-sources}/widget-table-source.ts

@@ -2,9 +2,8 @@ import {
   H3TableSourceOptions,
   QuadbinTableSourceOptions,
   VectorTableSourceOptions,
-} from '@deck.gl/carto';
+} from '../sources/index.js';
 import {WidgetBaseSource, WidgetBaseSourceProps} from './widget-base-source.js';
-import {MapType} from '../constants-internal.js';
 import {ModelSource} from '../models/model.js';
 
 type LayerTableSourceOptions =
@@ -40,7 +39,7 @@ export class WidgetTableSource extends WidgetBaseSource<
   protected override getModelSource(owner: string): ModelSource {
     return {
       ...super._getModelSource(owner),
-      type: MapType.TABLE,
+      type: 'table',
       data: this.props.tableName,
     };
   }

package/src/{sources → widget-sources}/wrappers.ts

@@ -11,8 +11,7 @@ import {
   H3QuerySourceOptions as _H3QuerySourceOptions,
   QuadbinTableSourceOptions as _QuadbinTableSourceOptions,
   QuadbinQuerySourceOptions as _QuadbinQuerySourceOptions,
-  SourceOptions,
-} from '@deck.gl/carto';
+} from '../sources/index.js';
 import {WidgetBaseSourceProps} from './widget-base-source.js';
 import {WidgetQuerySource} from './widget-query-source.js';
 import {WidgetTableSource} from './widget-table-source.js';
@@ -55,7 +54,6 @@ export type VectorQuerySourceOptions =
 export async function vectorTableSource(
   props: VectorTableSourceOptions
 ): Promise<VectorTableSourceResponse> {
-  assignDefaultProps(props);
   const response = await _vectorTableSource(props as _VectorTableSourceOptions);
   return {...response, widgetSource: new WidgetTableSource(props)};
 }
@@ -64,7 +62,6 @@ export async function vectorTableSource(
 export async function vectorQuerySource(
   props: VectorQuerySourceOptions
 ): Promise<VectorQuerySourceResponse> {
-  assignDefaultProps(props);
   const response = await _vectorQuerySource(props as _VectorQuerySourceOptions);
   return {...response, widgetSource: new WidgetQuerySource(props)};
 }
@@ -80,7 +77,6 @@ export type H3QuerySourceOptions = WrappedSourceOptions<_H3QuerySourceOptions>;
 export async function h3TableSource(
   props: H3TableSourceOptions
 ): Promise<H3TableSourceResponse> {
-  assignDefaultProps(props);
   const response = await _h3TableSource(props as _H3TableSourceOptions);
   return {...response, widgetSource: new WidgetTableSource(props)};
 }
@@ -89,7 +85,6 @@ export async function h3TableSource(
 export async function h3QuerySource(
   props: H3QuerySourceOptions
 ): Promise<H3QuerySourceResponse> {
-  assignDefaultProps(props);
   const response = await _h3QuerySource(props as _H3QuerySourceOptions);
   return {...response, widgetSource: new WidgetQuerySource(props)};
 }
@@ -108,7 +103,6 @@ export type QuadbinQuerySourceOptions =
 export async function quadbinTableSource(
   props: QuadbinTableSourceOptions & WidgetBaseSourceProps
 ): Promise<QuadbinTableSourceResponse> {
-  assignDefaultProps(props);
   const response = await _quadbinTableSource(
     props as _QuadbinTableSourceOptions
   );
@@ -119,23 +113,8 @@ export async function quadbinTableSource(
 export async function quadbinQuerySource(
   props: QuadbinQuerySourceOptions & WidgetBaseSourceProps
 ): Promise<QuadbinQuerySourceResponse> {
-  assignDefaultProps(props);
   const response = await _quadbinQuerySource(
     props as _QuadbinQuerySourceOptions
   );
   return {...response, widgetSource: new WidgetQuerySource(props)};
 }
-
-/******************************************************************************
- * DEFAULT PROPS
- */
-
-declare const deck: {VERSION?: string} | undefined;
-function assignDefaultProps<T extends SourceOptions>(props: T): void {
-  if (typeof deck !== 'undefined' && deck && deck.VERSION) {
-    props.clientId ||= 'deck-gl-carto';
-    // TODO: Uncomment if/when `@deck.gl/carto` devDependency is removed,
-    // and source functions are moved here rather than wrapped.
-    // props.deckglVersion ||= deck.VERSION;
-  }
-}