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

package/build/api/carto-api-error.d.ts

@@ -1,4 +1,12 @@
-import type { APIErrorContext } from './types';
+import { MapType } from '../types';
+export type APIRequestType = 'Map data' | 'Map instantiation' | 'Public map' | 'Tile stats' | 'SQL' | 'Basemap style';
+export type APIErrorContext = {
+    requestType: APIRequestType;
+    mapId?: string;
+    connection?: string;
+    source?: string;
+    type?: MapType;
+};
 /**
  *
  * Custom error for reported errors in CARTO Maps API.

package/build/api/endpoints.d.ts

@@ -1,9 +1,11 @@
-import { MapType } from './types';
+import { MapType } from '../types.js';
 export type V3Endpoint = 'maps' | 'stats' | 'sql';
+/** @internal Required by fetchMap(). */
 export declare function buildPublicMapUrl({ apiBaseUrl, cartoMapId, }: {
     apiBaseUrl: string;
     cartoMapId: string;
 }): string;
+/** @internal Required by fetchMap(). */
 export declare function buildStatsUrl({ attribute, apiBaseUrl, connectionName, source, type, }: {
     attribute: string;
     apiBaseUrl: string;

package/build/api/index.d.ts

@@ -1,4 +1,5 @@
-export { CartoAPIError } from './carto-api-error';
-export type { APIErrorContext, Format, MapType, RequestType, QueryParameters, Basemap, MapLibreBasemap, GoogleBasemap, } from './types';
-export { query } from './query';
-export type { QueryOptions } from './query';
+export { CartoAPIError, APIErrorContext, APIRequestType, } from './carto-api-error.js';
+export { buildPublicMapUrl, buildStatsUrl } from './endpoints.js';
+export { query } from './query.js';
+export type { QueryOptions } from './query.js';
+export { requestWithParameters } from './request-with-parameters.js';

package/build/api/request-with-parameters.d.ts

@@ -1,4 +1,4 @@
-import type { APIErrorContext } from './types';
+import { APIErrorContext } from './carto-api-error';
 export declare function requestWithParameters<T = any>({ baseUrl, parameters, headers: customHeaders, errorContext, maxLengthURL, }: {
     baseUrl: string;
     parameters?: Record<string, unknown>;

package/build/api-client.cjs

@@ -34,17 +34,6 @@ function setClient(c) {
   client = c;
 }
 
-/** Current version of @carto/api-client. */
-const API_CLIENT_VERSION = "0.4.0-alpha.0";
-const DEFAULT_API_BASE_URL$1 = 'https://gcp-us-east1.api.carto.com';
-const DEFAULT_CLIENT = 'deck-gl-carto';
-const V3_MINOR_VERSION = '3.4';
-// Fastly default limit is 8192; leave some padding.
-const DEFAULT_MAX_LENGTH_URL = 7000;
-const DEFAULT_TILE_SIZE = 512;
-const DEFAULT_TILE_RESOLUTION = 0.5;
-const DEFAULT_AGGREGATION_RES_LEVEL_H3 = 4;
-const DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN = 6;
 /**
  * Defines a comparator used when matching a column's values against given filter values.
  *
@@ -69,6 +58,31 @@ exports.FilterType = void 0;
   FilterType["TIME"] = "time";
   FilterType["STRING_SEARCH"] = "stringSearch";
 })(exports.FilterType || (exports.FilterType = {}));
+/** @internalRemarks Source: @carto/constants */
+exports.ApiVersion = void 0;
+(function (ApiVersion) {
+  ApiVersion["V1"] = "v1";
+  ApiVersion["V2"] = "v2";
+  ApiVersion["V3"] = "v3";
+})(exports.ApiVersion || (exports.ApiVersion = {}));
+/******************************************************************************
+ * DEFAULTS
+ */
+/** @internalRemarks Source: @carto/constants, @deck.gl/carto */
+const DEFAULT_API_BASE_URL = 'https://gcp-us-east1.api.carto.com';
+/** @internalRemarks Source: @carto/constants, @deck.gl/carto */
+const DEFAULT_CLIENT = 'deck-gl-carto';
+/** @internalRemarks Source: @carto/constants, @deck.gl/carto */
+const DEFAULT_GEO_COLUMN = 'geom';
+/**
+ * Fastly default limit is 8192; leave some padding.
+ * @internalRemarks Source: @deck.gl/carto
+ */
+const DEFAULT_MAX_LENGTH_URL = 7000;
+/** @internalRemarks Source: @deck.gl/carto */
+const DEFAULT_TILE_SIZE = 512;
+/** @internalRemarks Source: @deck.gl/carto */
+const DEFAULT_TILE_RESOLUTION = 0.5;
 
 const FILTER_TYPES = new Set(Object.values(exports.FilterType));
 const isFilterType = type => FILTER_TYPES.has(type);
@@ -357,43 +371,6 @@ function _isMultiPolygon(geometry) {
   return invariant.getType(geometry) === 'MultiPolygon';
 }
 
-/******************************************************************************
- * DEFAULTS
- */
-/**
- * @internalRemarks Source: @carto/constants
- * @internal
- */
-const DEFAULT_API_BASE_URL = 'https://gcp-us-east1.api.carto.com';
-/**
- * @internalRemarks Source: @carto/react-api
- * @internal
- */
-const DEFAULT_GEO_COLUMN = 'geom';
-/******************************************************************************
- * ENUMS
- */
-/**
- * @internal
- * @internalRemarks Source: @carto/constants
- */
-var MapType;
-(function (MapType) {
-  MapType["TABLE"] = "table";
-  MapType["QUERY"] = "query";
-  MapType["TILESET"] = "tileset";
-})(MapType || (MapType = {}));
-/**
- * @internal
- * @internalRemarks Source: @carto/constants
- */
-var ApiVersion;
-(function (ApiVersion) {
-  ApiVersion["V1"] = "v1";
-  ApiVersion["V2"] = "v2";
-  ApiVersion["V3"] = "v3";
-})(ApiVersion || (ApiVersion = {}));
-
 /**
  * Return more descriptive error from API
  * @internalRemarks Source: @carto/react-api
@@ -488,7 +465,7 @@ function dealWithApiError(_ref) {
 const AVAILABLE_MODELS = ['category', 'histogram', 'formula', 'timeseries', 'range', 'scatterplot', 'table'];
 const {
   V3
-} = ApiVersion;
+} = exports.ApiVersion;
 const REQUEST_GET_MAX_URL_LENGTH = 2048;
 /**
  * Execute a SQL model request.
@@ -516,7 +493,7 @@ function executeModel(props) {
   assert(apiBaseUrl, 'executeModel: missing apiBaseUrl');
   assert(accessToken, 'executeModel: missing accessToken');
   assert(apiVersion === V3, 'executeModel: SQL Model API requires CARTO 3+');
-  assert(type !== MapType.TILESET, 'executeModel: Tilesets not supported');
+  assert(type !== 'tileset', 'executeModel: Tilesets not supported');
   let url = `${apiBaseUrl}/v3/sql/${connectionName}/model/${model}`;
   const {
     filters,
@@ -920,7 +897,7 @@ class WidgetBaseSource {
   }
 }
 WidgetBaseSource.defaultProps = {
-  apiVersion: ApiVersion.V3,
+  apiVersion: exports.ApiVersion.V3,
   apiBaseUrl: DEFAULT_API_BASE_URL,
   clientId: getClient(),
   filters: {},
@@ -954,7 +931,7 @@ class WidgetQuerySource extends WidgetBaseSource {
   getModelSource(owner) {
     return {
       ...super._getModelSource(owner),
-      type: MapType.QUERY,
+      type: 'query',
       data: this.props.sqlQuery,
       queryParameters: this.props.queryParameters
     };
@@ -987,30 +964,12 @@ class WidgetTableSource extends WidgetBaseSource {
   getModelSource(owner) {
     return {
       ...super._getModelSource(owner),
-      type: MapType.TABLE,
+      type: 'table',
       data: this.props.tableName
     };
   }
 }
 
-// deck.gl
-// SPDX-License-Identifier: MIT
-// Copyright (c) vis.gl contributors
-function joinPath() {
-  return [].slice.call(arguments).map(part => part.endsWith('/') ? part.slice(0, -1) : part).join('/');
-}
-function buildV3Path(apiBaseUrl, version, endpoint) {
-  return joinPath(apiBaseUrl, version, endpoint, ...[].slice.call(arguments, 3));
-}
-function buildSourceUrl(_ref3) {
-  let {
-    apiBaseUrl,
-    connectionName,
-    endpoint
-  } = _ref3;
-  return buildV3Path(apiBaseUrl, 'v3', 'maps', connectionName, endpoint);
-}
-
 // deck.gl
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
@@ -1067,6 +1026,70 @@ function formatErrorKey(key) {
   return key.replace(/([A-Z])/g, ' $1').replace(/^./, s => s.toUpperCase());
 }
 
+// deck.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+function joinPath() {
+  return [].slice.call(arguments).map(part => part.endsWith('/') ? part.slice(0, -1) : part).join('/');
+}
+function buildV3Path(apiBaseUrl, version, endpoint) {
+  return joinPath(apiBaseUrl, version, endpoint, ...[].slice.call(arguments, 3));
+}
+/** @internal Required by fetchMap(). */
+function buildPublicMapUrl(_ref) {
+  let {
+    apiBaseUrl,
+    cartoMapId
+  } = _ref;
+  return buildV3Path(apiBaseUrl, 'v3', 'maps', 'public', cartoMapId);
+}
+/** @internal Required by fetchMap(). */
+function buildStatsUrl(_ref2) {
+  let {
+    attribute,
+    apiBaseUrl,
+    connectionName,
+    source,
+    type
+  } = _ref2;
+  if (type === 'query') {
+    return buildV3Path(apiBaseUrl, 'v3', 'stats', connectionName, attribute);
+  }
+  // type === 'table'
+  return buildV3Path(apiBaseUrl, 'v3', 'stats', connectionName, source, attribute);
+}
+function buildSourceUrl(_ref3) {
+  let {
+    apiBaseUrl,
+    connectionName,
+    endpoint
+  } = _ref3;
+  return buildV3Path(apiBaseUrl, 'v3', 'maps', connectionName, endpoint);
+}
+function buildQueryUrl(_ref4) {
+  let {
+    apiBaseUrl,
+    connectionName
+  } = _ref4;
+  return buildV3Path(apiBaseUrl, 'v3', 'sql', connectionName, 'query');
+}
+
+/******************************************************************************
+ * VERSIONS
+ */
+/** @internal */
+const V3_MINOR_VERSION = '3.4';
+/**
+ * @internalRemarks Source: @deck.gl/carto
+ * @internal
+ */
+const DEFAULT_AGGREGATION_RES_LEVEL_H3 = 4;
+/**
+ * @internalRemarks Source: @deck.gl/carto
+ * @internal
+ */
+const DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN = 6;
+
 // deck.gl
 const requestWithParameters = function (_ref) {
   let {
@@ -1082,7 +1105,7 @@ const requestWithParameters = function (_ref) {
     // user-provided parameters.
     parameters = {
       v: V3_MINOR_VERSION,
-      clientId: DEFAULT_CLIENT,
+      client: DEFAULT_CLIENT,
       ...(typeof deck !== 'undefined' && deck.VERSION && {
         deckglVersion: deck.VERSION
       }),
@@ -1262,7 +1285,7 @@ const baseSource = function (endpoint, options, urlParameters) {
   }
 };
 const SOURCE_DEFAULTS = {
-  apiBaseUrl: DEFAULT_API_BASE_URL$1,
+  apiBaseUrl: DEFAULT_API_BASE_URL,
   clientId: DEFAULT_CLIENT,
   format: 'tilejson',
   headers: {},
@@ -1270,7 +1293,61 @@ const SOURCE_DEFAULTS = {
 };
 
 // deck.gl
-const h3QuerySource$1 = function (options) {
+const boundaryQuerySource = function (options) {
+  try {
+    const {
+      columns,
+      filters,
+      tilesetTableName,
+      propertiesSqlQuery,
+      queryParameters
+    } = options;
+    const urlParameters = {
+      tilesetTableName,
+      propertiesSqlQuery
+    };
+    if (columns) {
+      urlParameters.columns = columns.join(',');
+    }
+    if (filters) {
+      urlParameters.filters = filters;
+    }
+    if (queryParameters) {
+      urlParameters.queryParameters = queryParameters;
+    }
+    return Promise.resolve(baseSource('boundary', options, urlParameters));
+  } catch (e) {
+    return Promise.reject(e);
+  }
+};
+
+// deck.gl
+const boundaryTableSource = function (options) {
+  try {
+    const {
+      filters,
+      tilesetTableName,
+      columns,
+      propertiesTableName
+    } = options;
+    const urlParameters = {
+      tilesetTableName,
+      propertiesTableName
+    };
+    if (columns) {
+      urlParameters.columns = columns.join(',');
+    }
+    if (filters) {
+      urlParameters.filters = filters;
+    }
+    return Promise.resolve(baseSource('boundary', options, urlParameters));
+  } catch (e) {
+    return Promise.reject(e);
+  }
+};
+
+// deck.gl
+const h3QuerySource = function (options) {
   try {
     const {
       aggregationExp,
@@ -1295,14 +1372,17 @@ const h3QuerySource$1 = function (options) {
     if (filters) {
       urlParameters.filters = filters;
     }
-    return Promise.resolve(baseSource('query', options, urlParameters));
+    return Promise.resolve(baseSource('query', options, urlParameters).then(result => ({
+      ...result,
+      widgetSource: new WidgetQuerySource(options)
+    })));
   } catch (e) {
     return Promise.reject(e);
   }
 };
 
 // deck.gl
-const h3TableSource$1 = function (options) {
+const h3TableSource = function (options) {
   try {
     const {
       aggregationExp,
@@ -1323,14 +1403,51 @@ const h3TableSource$1 = function (options) {
     if (filters) {
       urlParameters.filters = filters;
     }
-    return Promise.resolve(baseSource('table', options, urlParameters));
+    return Promise.resolve(baseSource('table', options, urlParameters).then(result => ({
+      ...result,
+      widgetSource: new WidgetTableSource(options)
+    })));
   } catch (e) {
     return Promise.reject(e);
   }
 };
 
 // deck.gl
-const quadbinQuerySource$1 = function (options) {
+const h3TilesetSource = function (options) {
+  try {
+    const {
+      tableName
+    } = options;
+    const urlParameters = {
+      name: tableName
+    };
+    return Promise.resolve(baseSource('tileset', options, urlParameters));
+  } catch (e) {
+    return Promise.reject(e);
+  }
+};
+
+// deck.gl
+const rasterSource = function (options) {
+  try {
+    const {
+      tableName,
+      filters
+    } = options;
+    const urlParameters = {
+      name: tableName
+    };
+    if (filters) {
+      urlParameters.filters = filters;
+    }
+    return Promise.resolve(baseSource('raster', options, urlParameters));
+  } catch (e) {
+    return Promise.reject(e);
+  }
+};
+
+// deck.gl
+const quadbinQuerySource = function (options) {
   try {
     const {
       aggregationExp,
@@ -1355,14 +1472,17 @@ const quadbinQuerySource$1 = function (options) {
     if (filters) {
       urlParameters.filters = filters;
     }
-    return Promise.resolve(baseSource('query', options, urlParameters));
+    return Promise.resolve(baseSource('query', options, urlParameters).then(result => ({
+      ...result,
+      widgetSource: new WidgetQuerySource(options)
+    })));
   } catch (e) {
     return Promise.reject(e);
   }
 };
 
 // deck.gl
-const quadbinTableSource$1 = function (options) {
+const quadbinTableSource = function (options) {
   try {
     const {
       aggregationExp,
@@ -1383,14 +1503,32 @@ const quadbinTableSource$1 = function (options) {
     if (filters) {
       urlParameters.filters = filters;
     }
-    return Promise.resolve(baseSource('table', options, urlParameters));
+    return Promise.resolve(baseSource('table', options, urlParameters).then(result => ({
+      ...result,
+      widgetSource: new WidgetTableSource(options)
+    })));
+  } catch (e) {
+    return Promise.reject(e);
+  }
+};
+
+// deck.gl
+const quadbinTilesetSource = function (options) {
+  try {
+    const {
+      tableName
+    } = options;
+    const urlParameters = {
+      name: tableName
+    };
+    return Promise.resolve(baseSource('tileset', options, urlParameters));
   } catch (e) {
     return Promise.reject(e);
   }
 };
 
 // deck.gl
-const vectorQuerySource$1 = function (options) {
+const vectorQuerySource = function (options) {
   try {
     const {
       columns,
@@ -1415,14 +1553,17 @@ const vectorQuerySource$1 = function (options) {
     if (queryParameters) {
       urlParameters.queryParameters = queryParameters;
     }
-    return Promise.resolve(baseSource('query', options, urlParameters));
+    return Promise.resolve(baseSource('query', options, urlParameters).then(result => ({
+      ...result,
+      widgetSource: new WidgetQuerySource(options)
+    })));
   } catch (e) {
     return Promise.reject(e);
   }
 };
 
 // deck.gl
-const vectorTableSource$1 = function (options) {
+const vectorTableSource = function (options) {
   try {
     const {
       columns,
@@ -1443,105 +1584,93 @@ const vectorTableSource$1 = function (options) {
     if (filters) {
       urlParameters.filters = filters;
     }
-    return Promise.resolve(baseSource('table', options, urlParameters));
+    return Promise.resolve(baseSource('table', options, urlParameters).then(result => ({
+      ...result,
+      widgetSource: new WidgetTableSource(options)
+    })));
   } catch (e) {
     return Promise.reject(e);
   }
 };
 
-/** Wrapper adding Widget API support to [vectorTableSource](https://deck.gl/docs/api-reference/carto/data-sources). */
-
-/** Wrapper adding Widget API support to [quadbinQuerySource](https://deck.gl/docs/api-reference/carto/data-sources). */
-const quadbinQuerySource = function (props) {
-  try {
-    return Promise.resolve(quadbinQuerySource$1(props)).then(function (response) {
-      return {
-        ...response,
-        widgetSource: new WidgetQuerySource(props)
-      };
-    });
-  } catch (e) {
-    return Promise.reject(e);
-  }
-};
-/** Wrapper adding Widget API support to [quadbinTableSource](https://deck.gl/docs/api-reference/carto/data-sources). */
-const quadbinTableSource = function (props) {
-  try {
-    return Promise.resolve(quadbinTableSource$1(props)).then(function (response) {
-      return {
-        ...response,
-        widgetSource: new WidgetTableSource(props)
-      };
-    });
-  } catch (e) {
-    return Promise.reject(e);
-  }
-};
-/** Wrapper adding Widget API support to [h3QuerySource](https://deck.gl/docs/api-reference/carto/data-sources). */
-const h3QuerySource = function (props) {
-  try {
-    return Promise.resolve(h3QuerySource$1(props)).then(function (response) {
-      return {
-        ...response,
-        widgetSource: new WidgetQuerySource(props)
-      };
-    });
-  } catch (e) {
-    return Promise.reject(e);
-  }
-};
-/** Wrapper adding Widget API support to [h3TableSource](https://deck.gl/docs/api-reference/carto/data-sources). */
-const h3TableSource = function (props) {
-  try {
-    return Promise.resolve(h3TableSource$1(props)).then(function (response) {
-      return {
-        ...response,
-        widgetSource: new WidgetTableSource(props)
-      };
-    });
-  } catch (e) {
-    return Promise.reject(e);
-  }
-};
-/** Wrapper adding Widget API support to [vectorQuerySource](https://deck.gl/docs/api-reference/carto/data-sources). */
-const vectorQuerySource = function (props) {
+// deck.gl
+const vectorTilesetSource = function (options) {
   try {
-    return Promise.resolve(vectorQuerySource$1(props)).then(function (response) {
-      return {
-        ...response,
-        widgetSource: new WidgetQuerySource(props)
-      };
-    });
+    const {
+      tableName
+    } = options;
+    const urlParameters = {
+      name: tableName
+    };
+    return Promise.resolve(baseSource('tileset', options, urlParameters));
   } catch (e) {
     return Promise.reject(e);
   }
 };
-const vectorTableSource = function (props) {
+
+// deck.gl
+const query = function (options) {
   try {
-    return Promise.resolve(vectorTableSource$1(props)).then(function (response) {
-      return {
-        ...response,
-        widgetSource: new WidgetTableSource(props)
-      };
+    const {
+      apiBaseUrl = SOURCE_DEFAULTS.apiBaseUrl,
+      clientId = SOURCE_DEFAULTS.clientId,
+      maxLengthURL = SOURCE_DEFAULTS.maxLengthURL,
+      connectionName,
+      sqlQuery,
+      queryParameters
+    } = options;
+    const urlParameters = {
+      q: sqlQuery
+    };
+    if (queryParameters) {
+      urlParameters.queryParameters = JSON.stringify(queryParameters);
+    }
+    const baseUrl = buildQueryUrl({
+      apiBaseUrl,
+      connectionName
     });
+    const headers = {
+      Authorization: `Bearer ${options.accessToken}`,
+      ...options.headers
+    };
+    const parameters = {
+      client: clientId,
+      ...urlParameters
+    };
+    const errorContext = {
+      requestType: 'SQL',
+      connection: options.connectionName,
+      type: 'query',
+      source: JSON.stringify(parameters, undefined, 2)
+    };
+    return Promise.resolve(requestWithParameters({
+      baseUrl,
+      parameters,
+      headers,
+      errorContext,
+      maxLengthURL
+    }));
   } catch (e) {
     return Promise.reject(e);
   }
 };
 
-exports.API_CLIENT_VERSION = API_CLIENT_VERSION;
-exports.DEFAULT_AGGREGATION_RES_LEVEL_H3 = DEFAULT_AGGREGATION_RES_LEVEL_H3;
-exports.DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN = DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN;
-exports.DEFAULT_API_BASE_URL = DEFAULT_API_BASE_URL$1;
+exports.CartoAPIError = CartoAPIError;
+exports.DEFAULT_API_BASE_URL = DEFAULT_API_BASE_URL;
 exports.DEFAULT_CLIENT = DEFAULT_CLIENT;
+exports.DEFAULT_GEO_COLUMN = DEFAULT_GEO_COLUMN;
 exports.DEFAULT_MAX_LENGTH_URL = DEFAULT_MAX_LENGTH_URL;
 exports.DEFAULT_TILE_RESOLUTION = DEFAULT_TILE_RESOLUTION;
 exports.DEFAULT_TILE_SIZE = DEFAULT_TILE_SIZE;
-exports.V3_MINOR_VERSION = V3_MINOR_VERSION;
+exports.SOURCE_DEFAULTS = SOURCE_DEFAULTS;
 exports.WidgetBaseSource = WidgetBaseSource;
 exports.WidgetQuerySource = WidgetQuerySource;
 exports.WidgetTableSource = WidgetTableSource;
 exports.addFilter = addFilter;
+exports.boundaryQuerySource = boundaryQuerySource;
+exports.boundaryTableSource = boundaryTableSource;
+exports.buildPublicMapUrl = buildPublicMapUrl;
+exports.buildStatsUrl = buildStatsUrl;
 exports.clearFilters = clearFilters;
 exports.createPolygonSpatialFilter = createPolygonSpatialFilter;
 exports.createViewportSpatialFilter = createViewportSpatialFilter;
@@ -1549,11 +1678,17 @@ exports.getClient = getClient;
 exports.getFilter = getFilter;
 exports.h3QuerySource = h3QuerySource;
 exports.h3TableSource = h3TableSource;
+exports.h3TilesetSource = h3TilesetSource;
 exports.hasFilter = hasFilter;
 exports.quadbinQuerySource = quadbinQuerySource;
 exports.quadbinTableSource = quadbinTableSource;
+exports.quadbinTilesetSource = quadbinTilesetSource;
+exports.query = query;
+exports.rasterSource = rasterSource;
 exports.removeFilter = removeFilter;
+exports.requestWithParameters = requestWithParameters;
 exports.setClient = setClient;
 exports.vectorQuerySource = vectorQuerySource;
 exports.vectorTableSource = vectorTableSource;
+exports.vectorTilesetSource = vectorTilesetSource;
 //# sourceMappingURL=api-client.cjs.map