@carto/api-client 0.0.44 → 0.1.0

package/src/sources/types.ts

@@ -1,6 +1,5 @@
-import {GroupDateType} from '../constants';
 import {
-  AggregationType,
+  GroupDateType,
   SortColumnType,
   SortDirection,
   SpatialFilter,
@@ -20,14 +19,14 @@ interface BaseRequestOptions {
 /** Options for {@link WidgetBaseSource#getCategories}. */
 export interface CategoryRequestOptions extends BaseRequestOptions {
   column: string;
-  operation?: AggregationType;
+  operation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
   operationColumn?: string;
 }
 
 /** Options for {@link WidgetBaseSource#getFormula}. */
 export interface FormulaRequestOptions extends BaseRequestOptions {
   column: string;
-  operation?: AggregationType;
+  operation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
   operationExp?: string;
 }
 
@@ -35,7 +34,7 @@ export interface FormulaRequestOptions extends BaseRequestOptions {
 export interface HistogramRequestOptions extends BaseRequestOptions {
   column: string;
   ticks: number[];
-  operation?: AggregationType;
+  operation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
 }
 
 /** Options for {@link WidgetBaseSource#getRange}. */
@@ -46,9 +45,9 @@ export interface RangeRequestOptions extends BaseRequestOptions {
 /** Options for {@link WidgetBaseSource#getScatter}. */
 export interface ScatterRequestOptions extends BaseRequestOptions {
   xAxisColumn: string;
-  xAxisJoinOperation?: AggregationType;
+  xAxisJoinOperation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
   yAxisColumn: string;
-  yAxisJoinOperation?: AggregationType;
+  yAxisJoinOperation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
 }
 
 /** Options for {@link WidgetBaseSource#getTable}. */
@@ -57,8 +56,8 @@ export interface TableRequestOptions extends BaseRequestOptions {
   sortBy?: string;
   sortDirection?: SortDirection;
   sortByColumnType?: SortColumnType;
-  page?: number;
-  rowsPerPage?: number;
+  offset?: number;
+  limit?: number;
 }
 
 /** Options for {@link WidgetBaseSource#getTimeSeries}. */
@@ -66,9 +65,9 @@ export interface TimeSeriesRequestOptions extends BaseRequestOptions {
   column: string;
   stepSize?: GroupDateType;
   stepMultiplier?: number;
-  operation?: AggregationType;
+  operation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
   operationColumn?: string;
-  joinOperation?: AggregationType;
+  joinOperation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
   splitByCategory?: string;
   splitByCategoryLimit?: number;
   splitByCategoryValues?: string[];

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

@@ -239,7 +239,7 @@ export abstract class WidgetBaseSource<Props extends WidgetBaseSourceProps> {
    */
   async getTable(options: TableRequestOptions): Promise<TableResponse> {
     const {filterOwner, spatialFilter, abortController, ...params} = options;
-    const {columns, sortBy, sortDirection, page = 0, rowsPerPage = 10} = params;
+    const {columns, sortBy, sortDirection, offset = 0, limit = 10} = params;
 
     type TableModelResponse = {
       rows: Record<string, number | string>[];
@@ -253,8 +253,8 @@ export abstract class WidgetBaseSource<Props extends WidgetBaseSourceProps> {
         column: columns,
         sortBy,
         sortDirection,
-        limit: rowsPerPage,
-        offset: page * rowsPerPage,
+        limit,
+        offset,
       },
       opts: {abortController},
     }).then((res: TableModelResponse) => ({

package/src/types.ts

@@ -1,4 +1,4 @@
-import type {FilterType} from './constants';
+import type {FilterType} from './constants.js';
 
 /******************************************************************************
  * AGGREGATION
@@ -39,6 +39,24 @@ export interface Filter {
 /** @internalRemarks Source: @carto/react-core */
 export type FilterLogicalOperator = 'and' | 'or';
 
+/******************************************************************************
+ * GROUPING
+ */
+
+/**
+ * Defines a step size increment for use with {@link TimeSeriesRequestOptions}.
+ *
+ * @internalRemarks Source: @carto/react-core
+ */
+export type GroupDateType =
+  | 'year'
+  | 'month'
+  | 'week'
+  | 'day'
+  | 'hour'
+  | 'minute'
+  | 'second';
+
 /******************************************************************************
  * SORTING
  */