@carto/api-client 0.4.0-alpha.3 → 0.4.0-alpha.5

package/build/models/common.d.ts

@@ -1,4 +1,3 @@
-import { $TODO } from '../types-internal.js';
 /** @internalRemarks Source: @carto/react-api */
 export interface ModelRequestOptions {
     method: 'GET' | 'POST';
@@ -6,13 +5,18 @@ export interface ModelRequestOptions {
     otherOptions?: Record<string, unknown>;
     body?: string;
 }
+interface ModelErrorResponse {
+    error?: string | string[];
+    hint?: string;
+    column_name?: string;
+}
 /**
  * Return more descriptive error from API
  * @internalRemarks Source: @carto/react-api
  */
 export declare function dealWithApiError({ response, data, }: {
     response: Response;
-    data: $TODO;
+    data: ModelErrorResponse;
 }): void;
 /** @internalRemarks Source: @carto/react-api */
 export declare function makeCall({ url, accessToken, opts, }: {
@@ -20,3 +24,4 @@ export declare function makeCall({ url, accessToken, opts, }: {
     accessToken: string;
     opts: ModelRequestOptions;
 }): Promise<any>;
+export {};

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.4.0-alpha.3",
+  "version": "0.4.0-alpha.5",
   "license": "MIT",
   "publishConfig": {
     "access": "public",
@@ -34,7 +34,7 @@
     "dev": "concurrently \"yarn build:watch\" \"vite --config examples/vite.config.ts --open\"",
     "test": "vitest run --typecheck",
     "test:watch": "vitest watch --typecheck",
-    "coverage": "vitest run --coverage.enabled --coverage.all false",
+    "coverage": "vitest run --coverage",
     "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/*",

package/src/api/request-with-parameters.ts

@@ -5,7 +5,8 @@
 import {isPureObject} from '../utils';
 import {CartoAPIError, APIErrorContext} from './carto-api-error';
 import {V3_MINOR_VERSION} from '../constants-internal';
-import {DEFAULT_CLIENT, DEFAULT_MAX_LENGTH_URL} from '../constants';
+import {DEFAULT_MAX_LENGTH_URL} from '../constants-internal';
+import {getClient} from '../client';
 
 const DEFAULT_HEADERS = {
   Accept: 'application/json',
@@ -32,7 +33,7 @@ export async function requestWithParameters<T = any>({
   // user-provided parameters.
   parameters = {
     v: V3_MINOR_VERSION,
-    client: DEFAULT_CLIENT,
+    client: getClient(),
     ...(typeof deck !== 'undefined' &&
       deck.VERSION && {deckglVersion: deck.VERSION}),
     ...parameters,

package/src/client.ts

@@ -1,8 +1,8 @@
 /**
  * @internal
- * @internalRemarks Source: @carto/react-core
+ * @internalRemarks Source: @carto/react-core, @carto/constants, @deck.gl/carto
  */
-let client = 'carto-api-client';
+let client = 'deck-gl-carto';
 
 /**
  * Returns current client ID, used to categorize API requests. For internal use only.

package/src/constants-internal.ts

@@ -1,7 +1,3 @@
-/******************************************************************************
- * VERSIONS
- */
-
 /**
  * Current version of @carto/api-client.
  * @internal
@@ -11,6 +7,18 @@ export const API_CLIENT_VERSION = __CARTO_API_CLIENT_VERSION;
 /** @internal */
 export const V3_MINOR_VERSION = '3.4';
 
+/** @internalRemarks Source: @carto/constants, @deck.gl/carto */
+export const DEFAULT_GEO_COLUMN = 'geom';
+
+/**
+ * Fastly default limit is 8192; leave some padding.
+ * @internalRemarks Source: @deck.gl/carto
+ */
+export const DEFAULT_MAX_LENGTH_URL = 7000;
+
+/** @internalRemarks Source: @deck.gl/carto */
+export const DEFAULT_TILE_RESOLUTION = 0.5;
+
 /**
  * @internalRemarks Source: @deck.gl/carto
  * @internal

package/src/constants.ts

@@ -29,27 +29,5 @@ export enum ApiVersion {
   V3 = 'v3',
 }
 
-/******************************************************************************
- * DEFAULTS
- */
-
 /** @internalRemarks Source: @carto/constants, @deck.gl/carto */
 export const DEFAULT_API_BASE_URL = 'https://gcp-us-east1.api.carto.com';
-
-/** @internalRemarks Source: @carto/constants, @deck.gl/carto */
-export const DEFAULT_CLIENT = 'deck-gl-carto';
-
-/** @internalRemarks Source: @carto/constants, @deck.gl/carto */
-export const DEFAULT_GEO_COLUMN = 'geom';
-
-/**
- * Fastly default limit is 8192; leave some padding.
- * @internalRemarks Source: @deck.gl/carto
- */
-export const DEFAULT_MAX_LENGTH_URL = 7000;
-
-/** @internalRemarks Source: @deck.gl/carto */
-export const DEFAULT_TILE_SIZE = 512;
-
-/** @internalRemarks Source: @deck.gl/carto */
-export const DEFAULT_TILE_RESOLUTION = 0.5;

package/src/models/common.ts

@@ -1,4 +1,3 @@
-import {$TODO} from '../types-internal.js';
 import {InvalidColumnError} from '../utils.js';
 
 /** @internalRemarks Source: @carto/react-api */
@@ -9,6 +8,12 @@ export interface ModelRequestOptions {
   body?: string;
 }
 
+interface ModelErrorResponse {
+  error?: string | string[];
+  hint?: string;
+  column_name?: string;
+}
+
 /**
  * Return more descriptive error from API
  * @internalRemarks Source: @carto/react-api
@@ -18,13 +23,16 @@ export function dealWithApiError({
   data,
 }: {
   response: Response;
-  data: $TODO;
+  data: ModelErrorResponse;
 }) {
   if (data.error === 'Column not found') {
     throw new InvalidColumnError(`${data.error} ${data.column_name}`);
   }
 
-  if (data.error?.includes('Missing columns')) {
+  if (
+    typeof data.error === 'string' &&
+    data.error?.includes('Missing columns')
+  ) {
     throw new InvalidColumnError(data.error);
   }
 

package/src/models/model.ts

@@ -1,4 +1,4 @@
-import {DEFAULT_GEO_COLUMN} from '../constants.js';
+import {DEFAULT_GEO_COLUMN} from '../constants-internal.js';
 import {
   Filter,
   FilterLogicalOperator,

package/src/sources/base-source.ts

@@ -2,12 +2,8 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-/* eslint-disable camelcase */
-import {
-  DEFAULT_API_BASE_URL,
-  DEFAULT_CLIENT,
-  DEFAULT_MAX_LENGTH_URL,
-} from '../constants';
+import {DEFAULT_API_BASE_URL} from '../constants';
+import {DEFAULT_MAX_LENGTH_URL} from '../constants-internal';
 import {buildSourceUrl} from '../api/endpoints';
 import {requestWithParameters} from '../api/request-with-parameters';
 import type {
@@ -20,10 +16,11 @@ import type {
 } from './types';
 import {MapType} from '../types';
 import {APIErrorContext} from '../api';
+import {getClient} from '../client';
 
 export const SOURCE_DEFAULTS: SourceOptionalOptions = {
   apiBaseUrl: DEFAULT_API_BASE_URL,
-  clientId: DEFAULT_CLIENT,
+  clientId: getClient(),
   format: 'tilejson',
   headers: {},
   maxLengthURL: DEFAULT_MAX_LENGTH_URL,

package/src/sources/vector-query-source.ts

@@ -3,7 +3,7 @@
 // Copyright (c) vis.gl contributors
 
 /* eslint-disable camelcase */
-import {DEFAULT_TILE_RESOLUTION} from '../constants.js';
+import {DEFAULT_TILE_RESOLUTION} from '../constants-internal.js';
 import {
   WidgetQuerySource,
   WidgetQuerySourceResult,

package/src/sources/vector-table-source.ts

@@ -3,7 +3,7 @@
 // Copyright (c) vis.gl contributors
 
 /* eslint-disable camelcase */
-import {DEFAULT_TILE_RESOLUTION} from '../constants.js';
+import {DEFAULT_TILE_RESOLUTION} from '../constants-internal.js';
 import {
   WidgetTableSource,
   WidgetTableSourceResult,

package/src/types.ts

@@ -41,7 +41,6 @@ export interface Filters {
   [column: string]: Filter;
 }
 
-// TODO: Would `{[FilterType.IN]?: number[] | string[]}` also be valid?
 /** @internalRemarks Source: @carto/react-api, @deck.gl/carto */
 export interface Filter {
   [FilterType.IN]?: {owner?: string; values: number[] | string[]};

package/src/utils.ts

@@ -1,6 +1,5 @@
 import {Filter} from './types.js';
 import {FilterType} from './constants.js';
-import {$TODO} from './types-internal.js';
 
 const FILTER_TYPES = new Set(Object.values(FilterType));
 const isFilterType = (type: string): type is FilterType =>
@@ -26,7 +25,7 @@ export function getApplicableFilters(
       const isApplicable = !owner || !filter?.owner || filter?.owner !== owner;
       if (filter && isApplicable) {
         applicableFilters[column] ||= {};
-        applicableFilters[column][type] = filter as $TODO;
+        (applicableFilters[column][type] as typeof filter) = filter;
       }
     }
   }

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

@@ -20,11 +20,8 @@ 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,
-} from '../constants.js';
+import {ApiVersion, DEFAULT_API_BASE_URL} from '../constants.js';
+import {DEFAULT_GEO_COLUMN} from '../constants-internal.js';
 
 export interface WidgetBaseSourceProps extends Omit<SourceOptions, 'filters'> {
   apiVersion?: ApiVersion;