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

package/build/api-client.cjs

@@ -65,6 +65,8 @@ exports.ApiVersion = void 0;
   ApiVersion["V2"] = "v2";
   ApiVersion["V3"] = "v3";
 })(exports.ApiVersion || (exports.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(exports.FilterType));
 const isFilterType = type => FILTER_TYPES.has(type);
@@ -353,8 +355,10 @@ function _isMultiPolygon(geometry) {
   return invariant.getType(geometry) === 'MultiPolygon';
 }
 
-/** @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 */
@@ -468,7 +472,7 @@ function dealWithApiError(_ref) {
 }
 
 /** @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
 } = exports.ApiVersion;
@@ -502,9 +506,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 = {
@@ -516,9 +521,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);
@@ -615,6 +624,58 @@ class WidgetBaseSource {
       return Promise.reject(e);
     }
   }
+  /****************************************************************************
+   * 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
+   */
+  getFeatures(options) {
+    try {
+      const _this2 = this;
+      const {
+        filterOwner,
+        spatialFilter,
+        abortController,
+        ...params
+      } = options;
+      const {
+        columns,
+        dataType,
+        featureIds,
+        z,
+        limit,
+        tileResolution
+      } = params;
+      return Promise.resolve(executeModel({
+        model: 'pick',
+        source: {
+          ..._this2.getModelSource(filterOwner),
+          spatialFilter
+        },
+        params: {
+          columns,
+          dataType,
+          featureIds,
+          z,
+          limit: limit || 1000,
+          tileResolution: tileResolution || DEFAULT_TILE_RESOLUTION
+        },
+        opts: {
+          abortController
+        }
+      }).then(res => ({
+        rows: normalizeObjectKeys(res.rows)
+      })));
+    } catch (e) {
+      return Promise.reject(e);
+    }
+  }
   /****************************************************************************
    * FORMULA
    */
@@ -624,7 +685,7 @@ class WidgetBaseSource {
    */
   getFormula(options) {
     try {
-      const _this2 = this;
+      const _this3 = this;
       const {
         filterOwner,
         spatialFilter,
@@ -639,7 +700,7 @@ class WidgetBaseSource {
       return Promise.resolve(executeModel({
         model: 'formula',
         source: {
-          ..._this2.getModelSource(filterOwner),
+          ..._this3.getModelSource(filterOwner),
           spatialFilter
         },
         params: {
@@ -664,7 +725,7 @@ class WidgetBaseSource {
    */
   getHistogram(options) {
     try {
-      const _this3 = this;
+      const _this4 = this;
       const {
         filterOwner,
         spatialFilter,
@@ -679,7 +740,7 @@ class WidgetBaseSource {
       return Promise.resolve(executeModel({
         model: 'histogram',
         source: {
-          ..._this3.getModelSource(filterOwner),
+          ..._this4.getModelSource(filterOwner),
           spatialFilter
         },
         params: {
@@ -720,7 +781,7 @@ class WidgetBaseSource {
    */
   getRange(options) {
     try {
-      const _this4 = this;
+      const _this5 = this;
       const {
         filterOwner,
         spatialFilter,
@@ -733,7 +794,7 @@ class WidgetBaseSource {
       return Promise.resolve(executeModel({
         model: 'range',
         source: {
-          ..._this4.getModelSource(filterOwner),
+          ..._this5.getModelSource(filterOwner),
           spatialFilter
         },
         params: {
@@ -756,7 +817,7 @@ class WidgetBaseSource {
    */
   getScatter(options) {
     try {
-      const _this5 = this;
+      const _this6 = this;
       const {
         filterOwner,
         spatialFilter,
@@ -774,7 +835,7 @@ class WidgetBaseSource {
       return Promise.resolve(executeModel({
         model: 'scatterplot',
         source: {
-          ..._this5.getModelSource(filterOwner),
+          ..._this6.getModelSource(filterOwner),
           spatialFilter
         },
         params: {
@@ -807,7 +868,7 @@ class WidgetBaseSource {
    */
   getTable(options) {
     try {
-      const _this6 = this;
+      const _this7 = this;
       const {
         filterOwner,
         spatialFilter,
@@ -824,7 +885,7 @@ class WidgetBaseSource {
       return Promise.resolve(executeModel({
         model: 'table',
         source: {
-          ..._this6.getModelSource(filterOwner),
+          ..._this7.getModelSource(filterOwner),
           spatialFilter
         },
         params: {
@@ -855,7 +916,7 @@ class WidgetBaseSource {
    */
   getTimeSeries(options) {
     try {
-      const _this7 = this;
+      const _this8 = this;
       const {
         filterOwner,
         abortController,
@@ -876,7 +937,7 @@ class WidgetBaseSource {
       return Promise.resolve(executeModel({
         model: 'timeseries',
         source: {
-          ..._this7.getModelSource(filterOwner),
+          ..._this8.getModelSource(filterOwner),
           spatialFilter
         },
         params: {
@@ -1646,6 +1707,7 @@ const query = function (options) {
 };
 
 exports.CartoAPIError = CartoAPIError;
+exports.DEFAULT_API_BASE_URL = DEFAULT_API_BASE_URL;
 exports.SOURCE_DEFAULTS = SOURCE_DEFAULTS;
 exports.WidgetBaseSource = WidgetBaseSource;
 exports.WidgetQuerySource = WidgetQuerySource;