@carto/api-client 0.2.2-alpha.1 → 0.3.0

package/CHANGELOG.md

@@ -1,7 +1,13 @@
 # CHANGELOG
 
+## 0.3
+
+### 0.3.0
+
+- deps: Add `@deck.gl/carto` as dependency
+
 ## 0.2
 
 ### 0.2.0
 
-- Initial release
+- feat: Initial release

package/build/api-client.cjs

@@ -3,6 +3,7 @@ var bboxPolygon = require('@turf/bbox-polygon');
 var union = require('@turf/union');
 var invariant = require('@turf/invariant');
 var helpers = require('@turf/helpers');
+var carto = require('@deck.gl/carto');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -34,6 +35,8 @@ function setClient(c) {
   client = c;
 }
 
+/** Current version of @carto/api-client. */
+const API_CLIENT_VERSION = "0.3.0";
 /**
  * Defines a comparator used when matching a column's values against given filter values.
  *
@@ -349,7 +352,7 @@ function _isMultiPolygon(geometry) {
  * @internalRemarks Source: @carto/constants
  * @internal
  */
-const DEFAULT_API_BASE_URL$1 = 'https://gcp-us-east1.api.carto.com';
+const DEFAULT_API_BASE_URL = 'https://gcp-us-east1.api.carto.com';
 /**
  * @internalRemarks Source: @carto/react-api
  * @internal
@@ -905,7 +908,7 @@ class WidgetBaseSource {
 }
 WidgetBaseSource.defaultProps = {
   apiVersion: ApiVersion.V3,
-  apiBaseUrl: DEFAULT_API_BASE_URL$1,
+  apiBaseUrl: DEFAULT_API_BASE_URL,
   clientId: getClient(),
   filters: {},
   filtersLogicalOperator: 'and',
@@ -977,521 +980,13 @@ class WidgetTableSource extends WidgetBaseSource {
   }
 }
 
-const DEFAULT_TILE_RESOLUTION = 0.5;
-const DEFAULT_AGGREGATION_RES_LEVEL_H3 = 4;
-const DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN = 6;
-
-const isObject = x => x !== null && typeof x === 'object';
-const isPureObject = x => isObject(x) && x.constructor === {}.constructor;
-
-/**
- *
- * Custom error for reported errors in CARTO Maps API.
- * Provides useful debugging information in console and context for applications.
- *
- */
-class CartoAPIError extends Error {
-  constructor(error, errorContext, response, responseJson) {
-    let responseString = 'Failed to connect';
-    if (response) {
-      responseString = 'Server returned: ';
-      if (response.status === 400) {
-        responseString += 'Bad request';
-      } else if (response.status === 401 || response.status === 403) {
-        responseString += 'Unauthorized access';
-      } else if (response.status === 404) {
-        responseString += 'Not found';
-      } else {
-        responseString += 'Error';
-      }
-      responseString += ` (${response.status}):`;
-    }
-    responseString += ` ${error.message || error}`;
-    let message = `${errorContext.requestType} API request failed`;
-    message += `\n${responseString}`;
-    for (const key of Object.keys(errorContext)) {
-      if (key === 'requestType') continue; // eslint-disable-line no-continue
-      message += `\n${formatErrorKey(key)}: ${errorContext[key]}`;
-    }
-    message += '\n';
-    super(message);
-    this.name = 'CartoAPIError';
-    this.response = response;
-    this.responseJson = responseJson;
-    this.error = error;
-    this.errorContext = errorContext;
-  }
-}
-/**
- * Converts camelCase to Camel Case
- */
-function formatErrorKey(key) {
-  return key.replace(/([A-Z])/g, ' $1').replace(/^./, s => s.toUpperCase());
-}
-
-const DEFAULT_API_BASE_URL = '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;
-
-function joinPath(...args) {
-  return args.map(part => part.endsWith('/') ? part.slice(0, -1) : part).join('/');
-}
-function buildV3Path(apiBaseUrl, version, endpoint, ...rest) {
-  return joinPath(apiBaseUrl, version, endpoint, ...rest);
-}
-function buildSourceUrl({
-  apiBaseUrl,
-  connectionName,
-  endpoint
-}) {
-  return buildV3Path(apiBaseUrl, 'v3', 'maps', connectionName, endpoint);
-}
-
-/**
- * Parameters added to all requests issued with `requestWithParameters()`.
- * These parameters override parameters already in the base URL, but not
- * user-provided parameters.
- */
-const DEFAULT_PARAMETERS = {
-  v: V3_MINOR_VERSION,
-  deckglVersion: "0.2.2-alpha.1"
-};
-const DEFAULT_HEADERS = {
-  Accept: 'application/json',
-  'Content-Type': 'application/json'
-};
-const REQUEST_CACHE = new Map();
-async function requestWithParameters({
-  baseUrl,
-  parameters = {},
-  headers: customHeaders = {},
-  errorContext,
-  maxLengthURL = DEFAULT_MAX_LENGTH_URL
-}) {
-  parameters = {
-    ...DEFAULT_PARAMETERS,
-    ...parameters
-  };
-  baseUrl = excludeURLParameters(baseUrl, Object.keys(parameters));
-  const key = createCacheKey(baseUrl, parameters, customHeaders);
-  if (REQUEST_CACHE.has(key)) {
-    return REQUEST_CACHE.get(key);
-  }
-  const url = createURLWithParameters(baseUrl, parameters);
-  const headers = {
-    ...DEFAULT_HEADERS,
-    ...customHeaders
-  };
-  /* global fetch */
-  const fetchPromise = url.length > maxLengthURL ? fetch(baseUrl, {
-    method: 'POST',
-    body: JSON.stringify(parameters),
-    headers
-  }) : fetch(url, {
-    headers
-  });
-  let response;
-  let responseJson;
-  const jsonPromise = fetchPromise.then(_response => {
-    response = _response;
-    return response.json();
-  }).then(json => {
-    responseJson = json;
-    if (!response || !response.ok) {
-      throw new Error(json.error);
-    }
-    return json;
-  }).catch(error => {
-    REQUEST_CACHE.delete(key);
-    throw new CartoAPIError(error, errorContext, response, responseJson);
-  });
-  REQUEST_CACHE.set(key, jsonPromise);
-  return jsonPromise;
-}
-function createCacheKey(baseUrl, parameters, headers) {
-  const parameterEntries = Object.entries(parameters).sort(([a], [b]) => a > b ? 1 : -1);
-  const headerEntries = Object.entries(headers).sort(([a], [b]) => a > b ? 1 : -1);
-  return JSON.stringify({
-    baseUrl,
-    parameters: parameterEntries,
-    headers: headerEntries
-  });
-}
-/**
- * Appends query string parameters to a URL. Existing URL parameters are kept,
- * unless there is a conflict, in which case the new parameters override
- * those already in the URL.
- */
-function createURLWithParameters(baseUrlString, parameters) {
-  const baseUrl = new URL(baseUrlString);
-  for (const [key, value] of Object.entries(parameters)) {
-    if (isPureObject(value) || Array.isArray(value)) {
-      baseUrl.searchParams.set(key, JSON.stringify(value));
-    } else {
-      baseUrl.searchParams.set(key, value.toString());
-    }
-  }
-  return baseUrl.toString();
-}
-/**
- * Deletes query string parameters from a URL.
- */
-function excludeURLParameters(baseUrlString, parameters) {
-  const baseUrl = new URL(baseUrlString);
-  for (const param of parameters) {
-    if (baseUrl.searchParams.has(param)) {
-      baseUrl.searchParams.delete(param);
-    }
-  }
-  return baseUrl.toString();
-}
-
-/* eslint-disable camelcase */
-const SOURCE_DEFAULTS = {
-  apiBaseUrl: DEFAULT_API_BASE_URL,
-  clientId: DEFAULT_CLIENT,
-  format: 'tilejson',
-  headers: {},
-  maxLengthURL: DEFAULT_MAX_LENGTH_URL
-};
-async function baseSource(endpoint, options, urlParameters) {
-  const {
-    accessToken,
-    connectionName,
-    cache,
-    ...optionalOptions
-  } = options;
-  const mergedOptions = {
-    ...SOURCE_DEFAULTS,
-    accessToken,
-    connectionName,
-    endpoint
-  };
-  for (const key in optionalOptions) {
-    if (optionalOptions[key]) {
-      mergedOptions[key] = optionalOptions[key];
-    }
-  }
-  const baseUrl = buildSourceUrl(mergedOptions);
-  const {
-    clientId,
-    maxLengthURL,
-    format
-  } = mergedOptions;
-  const headers = {
-    Authorization: `Bearer ${options.accessToken}`,
-    ...options.headers
-  };
-  const parameters = {
-    client: clientId,
-    ...urlParameters
-  };
-  const errorContext = {
-    requestType: 'Map instantiation',
-    connection: options.connectionName,
-    type: endpoint,
-    source: JSON.stringify(parameters, undefined, 2)
-  };
-  const mapInstantiation = await requestWithParameters({
-    baseUrl,
-    parameters,
-    headers,
-    errorContext,
-    maxLengthURL
-  });
-  const dataUrl = mapInstantiation[format].url[0];
-  if (cache) {
-    cache.value = parseInt(new URL(dataUrl).searchParams.get('cache') || '', 10);
-  }
-  errorContext.requestType = 'Map data';
-  if (format === 'tilejson') {
-    const json = await requestWithParameters({
-      baseUrl: dataUrl,
-      headers,
-      errorContext,
-      maxLengthURL
-    });
-    if (accessToken) {
-      json.accessToken = accessToken;
-    }
-    return json;
-  }
-  return await requestWithParameters({
-    baseUrl: dataUrl,
-    headers,
-    errorContext,
-    maxLengthURL
-  });
-}
-
-const boundaryQuerySource = async function (options) {
-  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 baseSource('boundary', options, urlParameters);
-};
-
-const boundaryTableSource = async function (options) {
-  const {
-    filters,
-    tilesetTableName,
-    columns,
-    propertiesTableName
-  } = options;
-  const urlParameters = {
-    tilesetTableName,
-    propertiesTableName
-  };
-  if (columns) {
-    urlParameters.columns = columns.join(',');
-  }
-  if (filters) {
-    urlParameters.filters = filters;
-  }
-  return baseSource('boundary', options, urlParameters);
-};
-
-/* eslint-disable camelcase */
-const h3QuerySource$1 = async function (options) {
-  const {
-    aggregationExp,
-    aggregationResLevel = DEFAULT_AGGREGATION_RES_LEVEL_H3,
-    sqlQuery,
-    spatialDataColumn = 'h3',
-    queryParameters,
-    filters
-  } = options;
-  const urlParameters = {
-    aggregationExp,
-    spatialDataColumn,
-    spatialDataType: 'h3',
-    q: sqlQuery
-  };
-  if (aggregationResLevel) {
-    urlParameters.aggregationResLevel = String(aggregationResLevel);
-  }
-  if (queryParameters) {
-    urlParameters.queryParameters = queryParameters;
-  }
-  if (filters) {
-    urlParameters.filters = filters;
-  }
-  return baseSource('query', options, urlParameters);
-};
-
-/* eslint-disable camelcase */
-const h3TableSource$1 = async function (options) {
-  const {
-    aggregationExp,
-    aggregationResLevel = DEFAULT_AGGREGATION_RES_LEVEL_H3,
-    spatialDataColumn = 'h3',
-    tableName,
-    filters
-  } = options;
-  const urlParameters = {
-    aggregationExp,
-    name: tableName,
-    spatialDataColumn,
-    spatialDataType: 'h3'
-  };
-  if (aggregationResLevel) {
-    urlParameters.aggregationResLevel = String(aggregationResLevel);
-  }
-  if (filters) {
-    urlParameters.filters = filters;
-  }
-  return baseSource('table', options, urlParameters);
-};
-
-const h3TilesetSource = async function (options) {
-  const {
-    tableName
-  } = options;
-  const urlParameters = {
-    name: tableName
-  };
-  return baseSource('tileset', options, urlParameters);
-};
-
-const rasterSource = async function (options) {
-  const {
-    tableName,
-    filters
-  } = options;
-  const urlParameters = {
-    name: tableName
-  };
-  if (filters) {
-    urlParameters.filters = filters;
-  }
-  return baseSource('raster', options, urlParameters);
-};
-
-/* eslint-disable camelcase */
-const quadbinQuerySource$1 = async function (options) {
-  const {
-    aggregationExp,
-    aggregationResLevel = DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN,
-    sqlQuery,
-    spatialDataColumn = 'quadbin',
-    queryParameters,
-    filters
-  } = options;
-  const urlParameters = {
-    aggregationExp,
-    q: sqlQuery,
-    spatialDataColumn,
-    spatialDataType: 'quadbin'
-  };
-  if (aggregationResLevel) {
-    urlParameters.aggregationResLevel = String(aggregationResLevel);
-  }
-  if (queryParameters) {
-    urlParameters.queryParameters = queryParameters;
-  }
-  if (filters) {
-    urlParameters.filters = filters;
-  }
-  return baseSource('query', options, urlParameters);
-};
-
-/* eslint-disable camelcase */
-const quadbinTableSource$1 = async function (options) {
-  const {
-    aggregationExp,
-    aggregationResLevel = DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN,
-    spatialDataColumn = 'quadbin',
-    tableName,
-    filters
-  } = options;
-  const urlParameters = {
-    aggregationExp,
-    name: tableName,
-    spatialDataColumn,
-    spatialDataType: 'quadbin'
-  };
-  if (aggregationResLevel) {
-    urlParameters.aggregationResLevel = String(aggregationResLevel);
-  }
-  if (filters) {
-    urlParameters.filters = filters;
-  }
-  return baseSource('table', options, urlParameters);
-};
-
-const quadbinTilesetSource = async function (options) {
-  const {
-    tableName
-  } = options;
-  const urlParameters = {
-    name: tableName
-  };
-  return baseSource('tileset', options, urlParameters);
-};
-
-/* eslint-disable camelcase */
-const vectorQuerySource$1 = async function (options) {
-  const {
-    columns,
-    filters,
-    spatialDataColumn = 'geom',
-    sqlQuery,
-    tileResolution = DEFAULT_TILE_RESOLUTION,
-    queryParameters
-  } = options;
-  const urlParameters = {
-    spatialDataColumn,
-    spatialDataType: 'geo',
-    tileResolution: tileResolution.toString(),
-    q: sqlQuery
-  };
-  if (columns) {
-    urlParameters.columns = columns.join(',');
-  }
-  if (filters) {
-    urlParameters.filters = filters;
-  }
-  if (queryParameters) {
-    urlParameters.queryParameters = queryParameters;
-  }
-  return baseSource('query', options, urlParameters);
-};
-
-/* eslint-disable camelcase */
-const vectorTableSource$1 = async function (options) {
-  const {
-    columns,
-    filters,
-    spatialDataColumn = 'geom',
-    tableName,
-    tileResolution = DEFAULT_TILE_RESOLUTION
-  } = options;
-  const urlParameters = {
-    name: tableName,
-    spatialDataColumn,
-    spatialDataType: 'geo',
-    tileResolution: tileResolution.toString()
-  };
-  if (columns) {
-    urlParameters.columns = columns.join(',');
-  }
-  if (filters) {
-    urlParameters.filters = filters;
-  }
-  return baseSource('table', options, urlParameters);
-};
-
-const vectorTilesetSource = async function (options) {
-  const {
-    tableName
-  } = options;
-  const urlParameters = {
-    name: tableName
-  };
-  return baseSource('tileset', options, urlParameters);
-};
-
-({
-  boundaryQuerySource,
-  boundaryTableSource,
-  h3QuerySource: h3QuerySource$1,
-  h3TableSource: h3TableSource$1,
-  h3TilesetSource,
-  rasterSource,
-  quadbinQuerySource: quadbinQuerySource$1,
-  quadbinTableSource: quadbinTableSource$1,
-  quadbinTilesetSource,
-  vectorQuerySource: vectorQuerySource$1,
-  vectorTableSource: vectorTableSource$1,
-  vectorTilesetSource
-});
-
 /** 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 {
     assignDefaultProps(props);
-    return Promise.resolve(quadbinQuerySource$1(props)).then(function (response) {
+    return Promise.resolve(carto.quadbinQuerySource(props)).then(function (response) {
       return {
         ...response,
         widgetSource: new WidgetQuerySource(props)
@@ -1505,7 +1000,7 @@ const quadbinQuerySource = function (props) {
 const quadbinTableSource = function (props) {
   try {
     assignDefaultProps(props);
-    return Promise.resolve(quadbinTableSource$1(props)).then(function (response) {
+    return Promise.resolve(carto.quadbinTableSource(props)).then(function (response) {
       return {
         ...response,
         widgetSource: new WidgetTableSource(props)
@@ -1519,7 +1014,7 @@ const quadbinTableSource = function (props) {
 const h3QuerySource = function (props) {
   try {
     assignDefaultProps(props);
-    return Promise.resolve(h3QuerySource$1(props)).then(function (response) {
+    return Promise.resolve(carto.h3QuerySource(props)).then(function (response) {
       return {
         ...response,
         widgetSource: new WidgetQuerySource(props)
@@ -1533,7 +1028,7 @@ const h3QuerySource = function (props) {
 const h3TableSource = function (props) {
   try {
     assignDefaultProps(props);
-    return Promise.resolve(h3TableSource$1(props)).then(function (response) {
+    return Promise.resolve(carto.h3TableSource(props)).then(function (response) {
       return {
         ...response,
         widgetSource: new WidgetTableSource(props)
@@ -1547,7 +1042,7 @@ const h3TableSource = function (props) {
 const vectorQuerySource = function (props) {
   try {
     assignDefaultProps(props);
-    return Promise.resolve(vectorQuerySource$1(props)).then(function (response) {
+    return Promise.resolve(carto.vectorQuerySource(props)).then(function (response) {
       return {
         ...response,
         widgetSource: new WidgetQuerySource(props)
@@ -1560,7 +1055,7 @@ const vectorQuerySource = function (props) {
 const vectorTableSource = function (props) {
   try {
     assignDefaultProps(props);
-    return Promise.resolve(vectorTableSource$1(props)).then(function (response) {
+    return Promise.resolve(carto.vectorTableSource(props)).then(function (response) {
       return {
         ...response,
         widgetSource: new WidgetTableSource(props)
@@ -1579,6 +1074,7 @@ function assignDefaultProps(props) {
   }
 }
 
+exports.API_CLIENT_VERSION = API_CLIENT_VERSION;
 exports.WidgetBaseSource = WidgetBaseSource;
 exports.WidgetQuerySource = WidgetQuerySource;
 exports.WidgetTableSource = WidgetTableSource;