@carto/api-client 0.4.0-alpha.4 → 0.4.0-alpha.6

package/build/api-client.modern.js

@@ -59,6 +59,8 @@ var ApiVersion;
   ApiVersion["V2"] = "v2";
   ApiVersion["V3"] = "v3";
 })(ApiVersion || (ApiVersion = {}));
+/** @internalRemarks Source: @carto/constants, @deck.gl/carto */
+const DEFAULT_API_BASE_URL = 'https://gcp-us-east1.api.carto.com';
 
 const FILTER_TYPES = new Set(Object.values(FilterType));
 const isFilterType = type => FILTER_TYPES.has(type);
@@ -365,8 +367,10 @@ function _objectWithoutPropertiesLoose(r, e) {
   return t;
 }
 
-/** @internalRemarks Source: @carto/constants, @deck.gl/carto */
-const DEFAULT_API_BASE_URL = 'https://gcp-us-east1.api.carto.com';
+/**
+ * Current version of @carto/api-client.
+ * @internal
+ */
 /** @internal */
 const V3_MINOR_VERSION = '3.4';
 /** @internalRemarks Source: @carto/constants, @deck.gl/carto */
@@ -452,7 +456,7 @@ async function makeCall({
 }
 
 /** @internalRemarks Source: @carto/react-api */
-const AVAILABLE_MODELS = ['category', 'histogram', 'formula', 'timeseries', 'range', 'scatterplot', 'table'];
+const AVAILABLE_MODELS = ['category', 'histogram', 'formula', 'pick', 'timeseries', 'range', 'scatterplot', 'table'];
 const {
   V3
 } = ApiVersion;
@@ -486,9 +490,10 @@ function executeModel(props) {
   assert(type !== 'tileset', 'executeModel: Tilesets not supported');
   let url = `${apiBaseUrl}/v3/sql/${connectionName}/model/${model}`;
   const {
+    data,
     filters,
     filtersLogicalOperator = 'and',
-    data
+    geoColumn = DEFAULT_GEO_COLUMN
   } = source;
   const queryParameters = source.queryParameters ? JSON.stringify(source.queryParameters) : '';
   const queryParams = {
@@ -500,9 +505,13 @@ function executeModel(props) {
     filters: JSON.stringify(filters),
     filtersLogicalOperator
   };
+  // Picking Model API requires 'spatialDataColumn'.
+  if (model === 'pick') {
+    queryParams.spatialDataColumn = geoColumn;
+  }
   // API supports multiple filters, we apply it only to geoColumn
   const spatialFilters = source.spatialFilter ? {
-    [source.geoColumn ? source.geoColumn : DEFAULT_GEO_COLUMN]: source.spatialFilter
+    [geoColumn]: source.spatialFilter
   } : undefined;
   if (spatialFilters) {
     queryParams.spatialFilters = JSON.stringify(spatialFilters);
@@ -532,12 +541,13 @@ function executeModel(props) {
 }
 
 const _excluded$1 = ["filterOwner", "spatialFilter", "abortController"],
-  _excluded2 = ["filterOwner", "spatialFilter", "abortController", "operationExp"],
-  _excluded3 = ["filterOwner", "spatialFilter", "abortController"],
+  _excluded2 = ["filterOwner", "spatialFilter", "abortController"],
+  _excluded3 = ["filterOwner", "spatialFilter", "abortController", "operationExp"],
   _excluded4 = ["filterOwner", "spatialFilter", "abortController"],
   _excluded5 = ["filterOwner", "spatialFilter", "abortController"],
   _excluded6 = ["filterOwner", "spatialFilter", "abortController"],
-  _excluded7 = ["filterOwner", "abortController", "spatialFilter"];
+  _excluded7 = ["filterOwner", "spatialFilter", "abortController"],
+  _excluded8 = ["filterOwner", "abortController", "spatialFilter"];
 /**
  * Source for Widget API requests on a data source defined by a SQL query.
  *
@@ -595,6 +605,52 @@ class WidgetBaseSource {
       }
     }).then(res => normalizeObjectKeys(res.rows));
   }
+  /****************************************************************************
+   * FEATURES
+   */
+  /**
+   * Given a list of feature IDs (as found in `_carto_feature_id`) returns all
+   * matching features. In datasets containing features with duplicate geometries,
+   * feature IDs may be duplicated (IDs are a hash of geometry) and so more
+   * results may be returned than IDs in the request.
+   * @internal
+   * @experimental
+   */
+  async getFeatures(options) {
+    const {
+        filterOwner,
+        spatialFilter,
+        abortController
+      } = options,
+      params = _objectWithoutPropertiesLoose(options, _excluded2);
+    const {
+      columns,
+      dataType,
+      featureIds,
+      z,
+      limit,
+      tileResolution
+    } = params;
+    return executeModel({
+      model: 'pick',
+      source: _extends({}, this.getModelSource(filterOwner), {
+        spatialFilter
+      }),
+      params: {
+        columns,
+        dataType,
+        featureIds,
+        z,
+        limit: limit || 1000,
+        tileResolution: tileResolution || DEFAULT_TILE_RESOLUTION
+      },
+      opts: {
+        abortController
+      }
+    }).then(res => ({
+      rows: normalizeObjectKeys(res.rows)
+    }));
+  }
   /****************************************************************************
    * FORMULA
    */
@@ -609,7 +665,7 @@ class WidgetBaseSource {
         abortController,
         operationExp
       } = options,
-      params = _objectWithoutPropertiesLoose(options, _excluded2);
+      params = _objectWithoutPropertiesLoose(options, _excluded3);
     const {
       column,
       operation
@@ -642,7 +698,7 @@ class WidgetBaseSource {
         spatialFilter,
         abortController
       } = options,
-      params = _objectWithoutPropertiesLoose(options, _excluded3);
+      params = _objectWithoutPropertiesLoose(options, _excluded4);
     const {
       column,
       operation,
@@ -688,7 +744,7 @@ class WidgetBaseSource {
         spatialFilter,
         abortController
       } = options,
-      params = _objectWithoutPropertiesLoose(options, _excluded4);
+      params = _objectWithoutPropertiesLoose(options, _excluded5);
     const {
       column
     } = params;
@@ -718,7 +774,7 @@ class WidgetBaseSource {
         spatialFilter,
         abortController
       } = options,
-      params = _objectWithoutPropertiesLoose(options, _excluded5);
+      params = _objectWithoutPropertiesLoose(options, _excluded6);
     const {
       xAxisColumn,
       xAxisJoinOperation,
@@ -760,7 +816,7 @@ class WidgetBaseSource {
         spatialFilter,
         abortController
       } = options,
-      params = _objectWithoutPropertiesLoose(options, _excluded6);
+      params = _objectWithoutPropertiesLoose(options, _excluded7);
     const {
       columns,
       sortBy,
@@ -805,7 +861,7 @@ class WidgetBaseSource {
         abortController,
         spatialFilter
       } = options,
-      params = _objectWithoutPropertiesLoose(options, _excluded7);
+      params = _objectWithoutPropertiesLoose(options, _excluded8);
     const {
       column,
       operationColumn,
@@ -1480,5 +1536,5 @@ const query = async function query(options) {
   });
 };
 
-export { ApiVersion, CartoAPIError, 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 };
+export { ApiVersion, CartoAPIError, DEFAULT_API_BASE_URL, 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