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

package/build/api-client.modern.js

@@ -28,17 +28,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.
  *
@@ -63,6 +52,31 @@ var FilterType;
   FilterType["TIME"] = "time";
   FilterType["STRING_SEARCH"] = "stringSearch";
 })(FilterType || (FilterType = {}));
+/** @internalRemarks Source: @carto/constants */
+var ApiVersion;
+(function (ApiVersion) {
+  ApiVersion["V1"] = "v1";
+  ApiVersion["V2"] = "v2";
+  ApiVersion["V3"] = "v3";
+})(ApiVersion || (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(FilterType));
 const isFilterType = type => FILTER_TYPES.has(type);
@@ -369,43 +383,6 @@ function _objectWithoutPropertiesLoose(r, e) {
   return t;
 }
 
-/******************************************************************************
- * 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
@@ -500,7 +477,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,
@@ -896,7 +873,7 @@ WidgetBaseSource.defaultProps = {
 class WidgetQuerySource extends WidgetBaseSource {
   getModelSource(owner) {
     return _extends({}, super._getModelSource(owner), {
-      type: MapType.QUERY,
+      type: 'query',
       data: this.props.sqlQuery,
       queryParameters: this.props.queryParameters
     });
@@ -928,7 +905,7 @@ class WidgetQuerySource extends WidgetBaseSource {
 class WidgetTableSource extends WidgetBaseSource {
   getModelSource(owner) {
     return _extends({}, super._getModelSource(owner), {
-      type: MapType.TABLE,
+      type: 'table',
       data: this.props.tableName
     });
   }
@@ -943,6 +920,27 @@ function joinPath(...args) {
 function buildV3Path(apiBaseUrl, version, endpoint, ...rest) {
   return joinPath(apiBaseUrl, version, endpoint, ...rest);
 }
+/** @internal Required by fetchMap(). */
+function buildPublicMapUrl({
+  apiBaseUrl,
+  cartoMapId
+}) {
+  return buildV3Path(apiBaseUrl, 'v3', 'maps', 'public', cartoMapId);
+}
+/** @internal Required by fetchMap(). */
+function buildStatsUrl({
+  attribute,
+  apiBaseUrl,
+  connectionName,
+  source,
+  type
+}) {
+  if (type === 'query') {
+    return buildV3Path(apiBaseUrl, 'v3', 'stats', connectionName, attribute);
+  }
+  // type === 'table'
+  return buildV3Path(apiBaseUrl, 'v3', 'stats', connectionName, source, attribute);
+}
 function buildSourceUrl({
   apiBaseUrl,
   connectionName,
@@ -950,6 +948,12 @@ function buildSourceUrl({
 }) {
   return buildV3Path(apiBaseUrl, 'v3', 'maps', connectionName, endpoint);
 }
+function buildQueryUrl({
+  apiBaseUrl,
+  connectionName
+}) {
+  return buildV3Path(apiBaseUrl, 'v3', 'sql', connectionName, 'query');
+}
 
 // deck.gl
 // SPDX-License-Identifier: MIT
@@ -1007,6 +1011,22 @@ function formatErrorKey(key) {
   return key.replace(/([A-Z])/g, ' $1').replace(/^./, s => s.toUpperCase());
 }
 
+/******************************************************************************
+ * 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;
+
 const DEFAULT_HEADERS = {
   Accept: 'application/json',
   'Content-Type': 'application/json'
@@ -1101,7 +1121,7 @@ function excludeURLParameters(baseUrlString, parameters) {
 
 const _excluded = ["accessToken", "connectionName", "cache"];
 const SOURCE_DEFAULTS = {
-  apiBaseUrl: DEFAULT_API_BASE_URL$1,
+  apiBaseUrl: DEFAULT_API_BASE_URL,
   clientId: DEFAULT_CLIENT,
   format: 'tilejson',
   headers: {},
@@ -1174,6 +1194,52 @@ async function baseSource(endpoint, options, urlParameters) {
   });
 }
 
+// deck.gl
+const boundaryQuerySource = async function boundaryQuerySource(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);
+};
+
+// deck.gl
+const boundaryTableSource = async function boundaryTableSource(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);
+};
+
 // deck.gl
 const h3QuerySource$1 = async function h3QuerySource(options) {
   const {
@@ -1226,6 +1292,32 @@ const h3TableSource$1 = async function h3TableSource(options) {
   return baseSource('table', options, urlParameters);
 };
 
+// deck.gl
+const h3TilesetSource = async function h3TilesetSource(options) {
+  const {
+    tableName
+  } = options;
+  const urlParameters = {
+    name: tableName
+  };
+  return baseSource('tileset', options, urlParameters);
+};
+
+// deck.gl
+const rasterSource = async function rasterSource(options) {
+  const {
+    tableName,
+    filters
+  } = options;
+  const urlParameters = {
+    name: tableName
+  };
+  if (filters) {
+    urlParameters.filters = filters;
+  }
+  return baseSource('raster', options, urlParameters);
+};
+
 // deck.gl
 const quadbinQuerySource$1 = async function quadbinQuerySource(options) {
   const {
@@ -1278,6 +1370,17 @@ const quadbinTableSource$1 = async function quadbinTableSource(options) {
   return baseSource('table', options, urlParameters);
 };
 
+// deck.gl
+const quadbinTilesetSource = async function quadbinTilesetSource(options) {
+  const {
+    tableName
+  } = options;
+  const urlParameters = {
+    name: tableName
+  };
+  return baseSource('tileset', options, urlParameters);
+};
+
 // deck.gl
 const vectorQuerySource$1 = async function vectorQuerySource(options) {
   const {
@@ -1330,6 +1433,17 @@ const vectorTableSource$1 = async function vectorTableSource(options) {
   return baseSource('table', options, urlParameters);
 };
 
+// deck.gl
+const vectorTilesetSource = async function vectorTilesetSource(options) {
+  const {
+    tableName
+  } = options;
+  const urlParameters = {
+    name: tableName
+  };
+  return baseSource('tileset', options, urlParameters);
+};
+
 /** Wrapper adding Widget API support to [vectorTableSource](https://deck.gl/docs/api-reference/carto/data-sources). */
 async function vectorTableSource(props) {
   const response = await vectorTableSource$1(props);
@@ -1373,5 +1487,45 @@ async function quadbinQuerySource(props) {
   });
 }
 
-export { API_CLIENT_VERSION, DEFAULT_AGGREGATION_RES_LEVEL_H3, DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN, DEFAULT_API_BASE_URL$1 as DEFAULT_API_BASE_URL, DEFAULT_CLIENT, DEFAULT_MAX_LENGTH_URL, DEFAULT_TILE_RESOLUTION, DEFAULT_TILE_SIZE, FilterType, V3_MINOR_VERSION, WidgetBaseSource, WidgetQuerySource, WidgetTableSource, addFilter, clearFilters, createPolygonSpatialFilter, createViewportSpatialFilter, getClient, getFilter, h3QuerySource, h3TableSource, hasFilter, quadbinQuerySource, quadbinTableSource, removeFilter, setClient, vectorQuerySource, vectorTableSource };
+const query = async function query(options) {
+  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 = _extends({
+    Authorization: `Bearer ${options.accessToken}`
+  }, options.headers);
+  const parameters = _extends({
+    client: clientId
+  }, urlParameters);
+  const errorContext = {
+    requestType: 'SQL',
+    connection: options.connectionName,
+    type: 'query',
+    source: JSON.stringify(parameters, undefined, 2)
+  };
+  return await requestWithParameters({
+    baseUrl,
+    parameters,
+    headers,
+    errorContext,
+    maxLengthURL
+  });
+};
+
+export { ApiVersion, CartoAPIError, DEFAULT_API_BASE_URL, DEFAULT_CLIENT, DEFAULT_GEO_COLUMN, DEFAULT_MAX_LENGTH_URL, DEFAULT_TILE_RESOLUTION, DEFAULT_TILE_SIZE, FilterType, SOURCE_DEFAULTS, WidgetBaseSource, WidgetQuerySource, WidgetTableSource, addFilter, boundaryQuerySource, boundaryTableSource, buildPublicMapUrl, buildStatsUrl, clearFilters, createPolygonSpatialFilter, createViewportSpatialFilter, getClient, getFilter, h3QuerySource, h3TableSource, h3TilesetSource, hasFilter, quadbinQuerySource, quadbinTableSource, quadbinTilesetSource, query, rasterSource, removeFilter, requestWithParameters, setClient, vectorQuerySource, vectorTableSource, vectorTilesetSource };
 //# sourceMappingURL=api-client.modern.js.map