@carto/api-client 0.0.43 → 0.1.0

package/build/sources/types.d.ts

@@ -1,5 +1,4 @@
-import { GroupDateType } from '../constants';
-import { AggregationType, SortColumnType, SortDirection, SpatialFilter } from '../types';
+import { GroupDateType, SortColumnType, SortDirection, SpatialFilter } from '../types';
 /******************************************************************************
  * WIDGET API REQUESTS
  */
@@ -12,20 +11,20 @@ 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;
 }
 /** Options for {@link WidgetBaseSource#getHistogram}. */
 export interface HistogramRequestOptions extends BaseRequestOptions {
     column: string;
     ticks: number[];
-    operation?: AggregationType;
+    operation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
 }
 /** Options for {@link WidgetBaseSource#getRange}. */
 export interface RangeRequestOptions extends BaseRequestOptions {
@@ -34,9 +33,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}. */
 export interface TableRequestOptions extends BaseRequestOptions {
@@ -44,17 +43,17 @@ export interface TableRequestOptions extends BaseRequestOptions {
     sortBy?: string;
     sortDirection?: SortDirection;
     sortByColumnType?: SortColumnType;
-    page?: number;
-    rowsPerPage?: number;
+    offset?: number;
+    limit?: number;
 }
 /** Options for {@link WidgetBaseSource#getTimeSeries}. */
 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/build/types.d.ts

@@ -1,4 +1,4 @@
-import type { FilterType } from './constants';
+import type { FilterType } from './constants.js';
 /******************************************************************************
  * AGGREGATION
  */
@@ -41,6 +41,15 @@ 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
  */

package/package.json

@@ -4,7 +4,7 @@
   "repository": "github:CartoDB/carto-api-client",
   "author": "Don McCurdy <donmccurdy@carto.com>",
   "packageManager": "yarn@4.3.1",
-  "version": "0.0.43",
+  "version": "0.1.0",
   "license": "MIT",
   "publishConfig": {
     "access": "public",

package/src/constants.ts

@@ -1,18 +1,3 @@
-/**
- * Defines a step size increment for use with {@link TimeSeriesRequestOptions}.
- *
- * @internalRemarks Source: @carto/react-core
- */
-export enum GroupDateType {
-  YEARS = 'year',
-  MONTHS = 'month',
-  WEEKS = 'week',
-  DAYS = 'day',
-  HOURS = 'hour',
-  MINUTES = 'minute',
-  SECONDS = 'second',
-}
-
 /**
  * Defines a comparator used when matching a column's values against given filter values.
  *

package/src/filters.ts

@@ -53,7 +53,7 @@ export function removeFilter(
   }
 
   if (owner) {
-    for (const type in FilterType) {
+    for (const type of Object.values(FilterType)) {
       if (owner === filter[type as FilterType]?.owner) {
         delete filter[type as FilterType];
       }
@@ -78,3 +78,52 @@ export function clearFilters(
   }
   return filters;
 }
+
+export type HasFilterOptions = {
+  column: string;
+  owner?: string;
+};
+
+export function hasFilter(
+  filters: Record<string, Filter>,
+  {column, owner}: HasFilterOptions
+): boolean {
+  const filter = filters[column];
+  if (!filter) {
+    return false;
+  }
+
+  if (!owner) {
+    return true;
+  }
+
+  for (const type of Object.values(FilterType)) {
+    if (owner === filter[type as FilterType]?.owner) {
+      return true;
+    }
+  }
+
+  return false;
+}
+
+export type GetFilterOptions<T extends FilterType> = {
+  column: string;
+  type: T;
+  owner?: string;
+};
+
+export function getFilter<T extends FilterType>(
+  filters: Record<string, Filter>,
+  {column, type, owner}: GetFilterOptions<T>
+): Filter[T] | null {
+  const filter = filters[column];
+  if (!filter) {
+    return null;
+  }
+
+  if (!owner || owner === filter[type as FilterType]?.owner) {
+    return filter[type] || null;
+  }
+
+  return null;
+}

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
  */