@carto/api-client 0.0.1-0 → 0.0.1-2

package/build/sources/types.d.ts

@@ -1,25 +1,44 @@
+import { GroupDateType } from '../constants';
 import { AggregationType, 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?: AggregationType;
+    operationColumn?: string;
+}
+/** Options for {@link WidgetBaseSource#getFormula}. */
 export interface FormulaRequestOptions extends BaseRequestOptions {
     column: string;
     operation?: AggregationType;
     operationExp?: string;
 }
-export interface CategoryRequestOptions extends BaseRequestOptions {
+/** Options for {@link WidgetBaseSource#getHistogram}. */
+export interface HistogramRequestOptions extends BaseRequestOptions {
     column: string;
+    ticks: number[];
     operation?: AggregationType;
-    operationColumn?: string;
 }
+/** 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?: AggregationType;
+    yAxisColumn: string;
+    yAxisJoinOperation?: AggregationType;
+}
+/** Options for {@link WidgetBaseSource#getTable}. */
 export interface TableRequestOptions extends BaseRequestOptions {
     columns: string[];
     sortBy?: string;
@@ -28,15 +47,10 @@ export interface TableRequestOptions extends BaseRequestOptions {
     page?: number;
     rowsPerPage?: number;
 }
-export interface ScatterRequestOptions extends BaseRequestOptions {
-    xAxisColumn: string;
-    xAxisJoinOperation?: AggregationType;
-    yAxisColumn: string;
-    yAxisJoinOperation?: AggregationType;
-}
+/** Options for {@link WidgetBaseSource#getTimeSeries}. */
 export interface TimeSeriesRequestOptions extends BaseRequestOptions {
     column: string;
-    stepSize?: number;
+    stepSize?: GroupDateType;
     stepMultiplier?: number;
     operation?: AggregationType;
     operationColumn?: string;
@@ -45,30 +59,31 @@ export interface TimeSeriesRequestOptions extends BaseRequestOptions {
     splitByCategoryLimit?: number;
     splitByCategoryValues?: string[];
 }
-export interface HistogramRequestOptions extends BaseRequestOptions {
-    column: string;
-    ticks: number[];
-    operation?: AggregationType;
-}
 /******************************************************************************
  * 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;
@@ -76,5 +91,6 @@ export type TimeSeriesResponse = {
     }[];
     categories: string[];
 };
+/** Response from {@link WidgetBaseSource#getHistogram}. */
 export type HistogramResponse = number[];
 export {};

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

@@ -1,32 +1,87 @@
 import { CategoryRequestOptions, CategoryResponse, FormulaRequestOptions, FormulaResponse, HistogramRequestOptions, HistogramResponse, RangeRequestOptions, RangeResponse, ScatterRequestOptions, ScatterResponse, TableRequestOptions, TableResponse, TimeSeriesRequestOptions, TimeSeriesResponse } from './types.js';
-import { Source, FilterLogicalOperator, Credentials, Filter } from '../types.js';
+import { FilterLogicalOperator, Filter } from '../types.js';
 import { SourceOptions } from '@deck.gl/carto';
-import { MapType } from '../constants.js';
-/**
- * TODO(cleanup): Consolidate {@link SourceOptions} and {@link Source}.
- */
-export interface WidgetBaseSourceProps extends SourceOptions, Credentials {
-    type?: MapType;
+import { ApiVersion } from '../constants-internal.js';
+import { ModelSource } from '../models/model.js';
+export interface WidgetBaseSourceProps extends Omit<SourceOptions, 'filters'> {
+    apiVersion?: ApiVersion;
+    geoColumn?: string;
     filters?: Record<string, Filter>;
     filtersLogicalOperator?: FilterLogicalOperator;
-    queryParameters?: unknown[];
-    provider?: string;
 }
 export type WidgetSource = WidgetBaseSource<WidgetBaseSourceProps>;
-export declare class WidgetBaseSource<Props extends 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;
-    readonly credentials: Required<Credentials> & {
-        clientId: string;
-    };
-    readonly connectionName: string;
     static defaultProps: Partial<WidgetBaseSourceProps>;
     constructor(props: Props);
-    protected getSource(owner?: string): Source;
-    getFormula(props: FormulaRequestOptions): Promise<FormulaResponse>;
+    /**
+     * 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'>;
+    /****************************************************************************
+     * CATEGORIES
+     */
+    /**
+     * Returns a list of labeled datapoints for categorical data. Suitable for
+     * charts including grouped bar charts, pie charts, and tree charts.
+     */
     getCategories(props: CategoryRequestOptions): Promise<CategoryResponse>;
+    /****************************************************************************
+     * FORMULA
+     */
+    /**
+     * Returns a scalar numerical statistic over all matching data. Suitable
+     * for 'headline' or 'scorecard' figures such as counts and sums.
+     */
+    getFormula(props: 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(props: 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(props: RangeRequestOptions): Promise<RangeResponse>;
-    getTable(props: TableRequestOptions): Promise<TableResponse>;
+    /****************************************************************************
+     * SCATTER
+     */
+    /**
+     * Returns a list of bivariate datapoints defined as numerical 'x' and 'y'
+     * values. Suitable for rendering scatter plots.
+     */
     getScatter(props: ScatterRequestOptions): Promise<ScatterResponse>;
+    /****************************************************************************
+     * TABLE
+     */
+    /**
+     * Returns a list of arbitrary data rows, with support for pagination and
+     * sorting. Suitable for displaying tables and lists.
+     */
+    getTable(props: 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(props: TimeSeriesRequestOptions): Promise<TimeSeriesResponse>;
-    getHistogram(props: HistogramRequestOptions): Promise<HistogramResponse>;
 }

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

@@ -1,8 +1,30 @@
 import { H3QuerySourceOptions, QuadbinQuerySourceOptions, VectorQuerySourceOptions } from '@deck.gl/carto';
 import { WidgetBaseSource, WidgetBaseSourceProps } from './widget-base-source.js';
-import { Source } from '../types.js';
-type LayerQuerySourceOptions = VectorQuerySourceOptions | H3QuerySourceOptions | QuadbinQuerySourceOptions;
+import { ModelSource } from '../models/model.js';
+type LayerQuerySourceOptions = Omit<VectorQuerySourceOptions, 'filters'> | Omit<H3QuerySourceOptions, 'filters'> | Omit<QuadbinQuerySourceOptions, 'filters'>;
+/**
+ * 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 getSource(owner: string): Source;
+    protected getModelSource(owner: string): ModelSource;
 }
 export {};

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

@@ -1,8 +1,30 @@
 import { H3TableSourceOptions, QuadbinTableSourceOptions, VectorTableSourceOptions } from '@deck.gl/carto';
 import { WidgetBaseSource, WidgetBaseSourceProps } from './widget-base-source.js';
-import { Source } from '../types.js';
-type LayerTableSourceOptions = VectorTableSourceOptions | H3TableSourceOptions | QuadbinTableSourceOptions;
+import { ModelSource } from '../models/model.js';
+type LayerTableSourceOptions = Omit<VectorTableSourceOptions, 'filters'> | Omit<H3TableSourceOptions, 'filters'> | Omit<QuadbinTableSourceOptions, 'filters'>;
+/**
+ * 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 getSource(owner: string): Source;
+    protected getModelSource(owner: string): ModelSource;
 }
 export {};

package/build/sources/wrappers.d.ts

@@ -1,7 +1,8 @@
-import { h3TableSource as _h3TableSource, h3QuerySource as _h3QuerySource, vectorTableSource as _vectorTableSource, vectorQuerySource as _vectorQuerySource, quadbinTableSource as _quadbinTableSource, quadbinQuerySource as _quadbinQuerySource, VectorTableSourceOptions, VectorQuerySourceOptions, H3TableSourceOptions, H3QuerySourceOptions, QuadbinQuerySourceOptions, QuadbinTableSourceOptions } from '@deck.gl/carto';
+import { h3TableSource as _h3TableSource, h3QuerySource as _h3QuerySource, vectorTableSource as _vectorTableSource, vectorQuerySource as _vectorQuerySource, quadbinTableSource as _quadbinTableSource, quadbinQuerySource as _quadbinQuerySource, VectorTableSourceOptions as _VectorTableSourceOptions, VectorQuerySourceOptions as _VectorQuerySourceOptions, H3TableSourceOptions as _H3TableSourceOptions, H3QuerySourceOptions as _H3QuerySourceOptions, QuadbinTableSourceOptions as _QuadbinTableSourceOptions, QuadbinQuerySourceOptions as _QuadbinQuerySourceOptions } from '@deck.gl/carto';
 import { WidgetBaseSourceProps } from './widget-base-source.js';
 import { WidgetQuerySource } from './widget-query-source.js';
 import { WidgetTableSource } from './widget-table-source.js';
+type WrappedSourceOptions<T> = Omit<T, 'filters'> & WidgetBaseSourceProps;
 /******************************************************************************
  * RESPONSE OBJECTS
  */
@@ -20,28 +21,34 @@ export type QuadbinQuerySourceResponse = WidgetQuerySourceResponse & Awaited<Ret
 /******************************************************************************
  * VECTOR SOURCES
  */
-/** Wrapper adding widget support to {@link _vectorTableSource}. */
-export declare function vectorTableSource(props: VectorTableSourceOptions & WidgetBaseSourceProps): Promise<VectorTableSourceResponse>;
-/** Wrapper adding widget support to {@link _vectorQuerySource}. */
-export declare function vectorQuerySource(props: VectorQuerySourceOptions & WidgetBaseSourceProps): Promise<VectorQuerySourceResponse>;
-/** Wrapper adding widget support to {@link _vectorTilesetSource}. */
+export type VectorTableSourceOptions = WrappedSourceOptions<_VectorTableSourceOptions>;
+export type VectorQuerySourceOptions = WrappedSourceOptions<_VectorQuerySourceOptions>;
+/** Wrapper adding Widget API support to [vectorTableSource](https://deck.gl/docs/api-reference/carto/data-sources). */
+export declare function vectorTableSource(props: VectorTableSourceOptions): Promise<VectorTableSourceResponse>;
+/** Wrapper adding Widget API support to [vectorQuerySource](https://deck.gl/docs/api-reference/carto/data-sources). */
+export declare function vectorQuerySource(props: VectorQuerySourceOptions): Promise<VectorQuerySourceResponse>;
+/** Wrapper adding Widget API support to [vectorTilesetSource](https://deck.gl/docs/api-reference/carto/data-sources). */
 export declare function vectorTilesetSource(): Promise<void>;
 /******************************************************************************
  * H3 SOURCES
  */
-/** Wrapper adding widget support to {@link _h3TableSource}. */
-export declare function h3TableSource(props: H3TableSourceOptions & WidgetBaseSourceProps): Promise<H3TableSourceResponse>;
-/** Wrapper adding widget support to {@link _h3QuerySource}. */
-export declare function h3QuerySource(props: H3QuerySourceOptions & WidgetBaseSourceProps): Promise<H3QuerySourceResponse>;
-/** Wrapper adding widget support to {@link _h3TilesetSource}. */
+export type H3TableSourceOptions = WrappedSourceOptions<_H3TableSourceOptions>;
+export type H3QuerySourceOptions = WrappedSourceOptions<_H3QuerySourceOptions>;
+/** Wrapper adding Widget API support to [h3TableSource](https://deck.gl/docs/api-reference/carto/data-sources). */
+export declare function h3TableSource(props: H3TableSourceOptions): Promise<H3TableSourceResponse>;
+/** Wrapper adding Widget API support to [h3QuerySource](https://deck.gl/docs/api-reference/carto/data-sources). */
+export declare function h3QuerySource(props: H3QuerySourceOptions): Promise<H3QuerySourceResponse>;
+/** Wrapper adding Widget API support to [h3TilesetSource](https://deck.gl/docs/api-reference/carto/data-sources). */
 export declare function h3TilesetSource(): Promise<void>;
 /******************************************************************************
  * QUADBIN SOURCES
  */
-/** Wrapper adding widget support to {@link _quadbinTableSource}. */
+export type QuadbinTableSourceOptions = WrappedSourceOptions<_QuadbinTableSourceOptions>;
+export type QuadbinQuerySourceOptions = WrappedSourceOptions<_QuadbinQuerySourceOptions>;
+/** Wrapper adding Widget API support to [quadbinTableSource](https://deck.gl/docs/api-reference/carto/data-sources). */
 export declare function quadbinTableSource(props: QuadbinTableSourceOptions & WidgetBaseSourceProps): Promise<QuadbinTableSourceResponse>;
-/** Wrapper adding widget support to {@link _quadbinQuerySource}. */
+/** Wrapper adding Widget API support to [quadbinQuerySource](https://deck.gl/docs/api-reference/carto/data-sources). */
 export declare function quadbinQuerySource(props: QuadbinQuerySourceOptions & WidgetBaseSourceProps): Promise<QuadbinQuerySourceResponse>;
-/** Wrapper adding widget support to {@link _quadbinTilesetSource}. */
+/** Wrapper adding Widget API support to [quadbinTilesetSource](https://deck.gl/docs/api-reference/carto/data-sources). */
 export declare function quadbinTilesetSource(): Promise<void>;
 export {};

package/build/types.d.ts

@@ -1,35 +1,10 @@
-import type { ApiVersion, MapType, FilterType } from './constants';
-/******************************************************************************
- * AUTHENTICATION
- */
-/** @internalRemarks Source: @carto/react-api */
-export type Credentials = {
-    apiVersion?: ApiVersion;
-    apiBaseUrl?: string;
-    geoColumn?: string;
-    accessToken: string;
-};
-/******************************************************************************
- * SOURCES
- */
-/** @internalRemarks Source: @carto/react-api */
-export type Source = {
-    type: MapType;
-    connection: string;
-    credentials: Credentials;
-    data: string;
-    geoColumn?: string;
-    queryParameters?: unknown[];
-    filters?: Record<string, Filter>;
-    filtersLogicalOperator?: 'and' | 'or';
-};
+import type { FilterType } from './constants';
 /******************************************************************************
  * AGGREGATION
  */
 /**
- * Enum for the different types of aggregations available for widgets
- * @enum {string}
- * @readonly
+ * 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.
  */
@@ -71,3 +46,14 @@ export type FilterLogicalOperator = 'and' | 'or';
  */
 export type SortDirection = 'asc' | 'desc';
 export type SortColumnType = 'number' | 'string' | 'date';
+/******************************************************************************
+ * SQL QUERY PARAMETERS
+ */
+/** @internalRemarks Source: @deck.gl/carto */
+export type QueryParameterValue = string | number | boolean | Array<QueryParameterValue> | object;
+/** @internalRemarks Source: @deck.gl/carto */
+export type NamedQueryParameter = Record<string, QueryParameterValue>;
+/** @internalRemarks Source: @deck.gl/carto */
+export type PositionalQueryParameter = QueryParameterValue[];
+/** @internalRemarks Source: @deck.gl/carto */
+export type QueryParameters = NamedQueryParameter | PositionalQueryParameter;

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@carto/api-client",
-  "version": "0.0.1-0",
+  "version": "0.0.1-2",
   "publishConfig": {
     "access": "public",
     "tag": "alpha"
   },
-  "packageManager": "yarn@4.2.2",
+  "packageManager": "yarn@4.3.1",
   "author": "Don McCurdy <donmccurdy@carto.com>",
   "license": "UNLICENSED",
   "type": "module",
@@ -36,10 +36,8 @@
     "lint": "prettier \"**/*.{cjs,html,js,json,md,ts}\" --ignore-path ./.eslintignore --check",
     "format": "prettier \"**/*.{cjs,html,js,json,md,ts}\" --ignore-path ./.eslintignore --write",
     "clean": "rimraf build/*",
-    "version": "git add -u",
     "prepack": "yarn clean && yarn build",
-    "prepublish": "yarn lint && yarn test",
-    "postpublish": "git push && git push --tags"
+    "prepublish": "yarn lint && yarn test"
   },
   "files": [
     "build",
@@ -85,5 +83,5 @@
     "vitest": "1.6.0",
     "vue": "^3.4.27"
   },
-  "stableVersion": "0.0.0"
+  "stableVersion": "0.0.1-1"
 }

package/src/client.ts

@@ -1,17 +1,25 @@
-import {CLIENT_ID} from './constants.js';
-
 /**
- * Default client
+ * @internal
  * @internalRemarks Source: @carto/react-core
  */
-let client = CLIENT_ID;
+let client = 'carto-api-client';
 
-/** @internalRemarks Source: @carto/react-core */
+/**
+ * Returns current client ID, used to categorize API requests. For internal use only.
+ *
+ * @internal
+ * @internalRemarks Source: @carto/react-core
+ */
 export function getClient() {
   return client;
 }
 
-/** @internalRemarks Source: @carto/react-core */
+/**
+ * Sets current client ID, used to categorize API requests. For internal use only.
+ *
+ * @internal
+ * @internalRemarks Source: @carto/react-core
+ */
 export function setClient(c: string) {
   client = c;
 }

package/src/constants-internal.ts

@@ -1,9 +1,6 @@
-/**
- * Threshold to use GET requests, vs POST
- * @internalRemarks Source: @carto/constants
- * @internal
+/******************************************************************************
+ * DEFAULTS
  */
-export const REQUEST_GET_MAX_URL_LENGTH = 2048;
 
 /**
  * @internalRemarks Source: @carto/constants
@@ -22,3 +19,27 @@ export const DEFAULT_CLIENT = 'deck-gl-carto';
  * @internal
  */
 export const DEFAULT_GEO_COLUMN = 'geom';
+
+/******************************************************************************
+ * ENUMS
+ */
+
+/**
+ * @internal
+ * @internalRemarks Source: @carto/constants
+ */
+export enum MapType {
+  TABLE = 'table',
+  QUERY = 'query',
+  TILESET = 'tileset',
+}
+
+/**
+ * @internal
+ * @internalRemarks Source: @carto/constants
+ */
+export enum ApiVersion {
+  V1 = 'v1',
+  V2 = 'v2',
+  V3 = 'v3',
+}

package/src/constants.ts

@@ -1,20 +1,8 @@
-export const CLIENT_ID = 'carto-api-client';
-
-/** @internalRemarks Source: @carto/constants */
-export enum MapType {
-  TABLE = 'table',
-  QUERY = 'query',
-  TILESET = 'tileset',
-}
-
-/** @internalRemarks Source: @carto/constants */
-export enum ApiVersion {
-  V1 = 'v1',
-  V2 = 'v2',
-  V3 = 'v3',
-}
-
-/** @internalRemarks Source: @carto/react-core */
+/**
+ * Defines a step size increment for use with {@link TimeSeriesRequestOptions}.
+ *
+ * @internalRemarks Source: @carto/react-core
+ */
 export enum GroupDateType {
   YEARS = 'year',
   MONTHS = 'month',
@@ -25,7 +13,20 @@ export enum GroupDateType {
   SECONDS = 'second',
 }
 
-/** @internalRemarks Source: @carto/react-api, @deck.gl/carto */
+/**
+ * Defines a comparator used when matching a column's values against given filter values.
+ *
+ * Example:
+ *
+ * ```javascript
+ * import { FilterType } from '@carto/api-client';
+ * const filters = {
+ *   column_name: { [FilterType.IN]: { values: ['a', 'b', 'c'] } }
+ * };
+ * ```
+ *
+ * @internalRemarks Source: @carto/react-api, @deck.gl/carto
+ */
 export enum FilterType {
   IN = 'in',
   /** [a, b] both are included. */

package/src/index.ts

@@ -1,5 +1,4 @@
 export * from './client.js';
 export * from './constants.js';
-export * from './models/index.js';
 export * from './sources/index.js';
 export * from './types.js';

package/src/models/common.ts

@@ -1,5 +1,4 @@
 import {$TODO} from '../types-internal.js';
-import {Credentials} from '../types.js';
 import {InvalidColumnError} from '../utils.js';
 
 /** @internalRemarks Source: @carto/react-api */
@@ -43,21 +42,14 @@ export function dealWithApiError({
   }
 }
 
-/** @internalRemarks Source: @carto/react-api */
-export function checkCredentials(credentials: Credentials) {
-  if (!credentials || !credentials.apiBaseUrl || !credentials.accessToken) {
-    throw new Error('Missing or bad credentials provided');
-  }
-}
-
 /** @internalRemarks Source: @carto/react-api */
 export async function makeCall({
   url,
-  credentials,
+  accessToken,
   opts,
 }: {
   url: string;
-  credentials: Credentials;
+  accessToken: string;
   opts: ModelRequestOptions;
 }) {
   let response;
@@ -66,15 +58,13 @@ export async function makeCall({
   try {
     response = await fetch(url.toString(), {
       headers: {
-        Authorization: `Bearer ${credentials.accessToken}`,
-        ...(isPost ? {'Content-Type': 'application/json'} : {}),
+        Authorization: `Bearer ${accessToken}`,
+        ...(isPost && {'Content-Type': 'application/json'}),
       },
-      ...(isPost
-        ? {
-            method: opts?.method,
-            body: opts?.body,
-          }
-        : {}),
+      ...(isPost && {
+        method: opts?.method,
+        body: opts?.body,
+      }),
       signal: opts?.abortController?.signal,
       ...opts?.otherOptions,
     });