@carto/api-client 0.5.1-alpha.2 → 0.5.2-alpha.0

package/CHANGELOG.md

@@ -1,8 +1,13 @@
 # CHANGELOG
 
-## 0.5 (Unreleased)
+## 0.5
 
-### 0.5.0 (Unreleased)
+### 0.5.1
+
+- chore(types): Cleanup for tilesets, rasters, and backward-compatibility (#150)
+- feat(fetchMap): Export legendSettings (#153)
+
+### 0.5.0
 
 - BREAKING CHANGE: Replace 'abortController' with 'signal' parameter (#110)
 - feat: Add widget calculations for tileset sources (#50)

package/build/api-client.cjs

@@ -5531,21 +5531,25 @@ __export(src_exports, {
   buildPublicMapUrl: () => buildPublicMapUrl,
   buildStatsUrl: () => buildStatsUrl,
   clearFilters: () => clearFilters,
+  configureSource: () => configureSource,
   createPolygonSpatialFilter: () => createPolygonSpatialFilter,
   createViewportSpatialFilter: () => createViewportSpatialFilter,
   fetchBasemapProps: () => fetchBasemapProps,
   fetchMap: () => fetchMap,
   filterFunctions: () => filterFunctions,
   geojsonFeatures: () => geojsonFeatures,
+  getApplicableFilters: () => getApplicableFilters,
   getClient: () => getClient,
   getColorAccessor: () => getColorAccessor,
   getColorValueAccessor: () => getColorValueAccessor,
+  getColumnNameFromGeoColumn: () => getColumnNameFromGeoColumn,
   getDataFilterExtensionProps: () => getDataFilterExtensionProps,
   getFilter: () => getFilter,
   getIconUrlAccessor: () => getIconUrlAccessor,
   getLayerProps: () => getLayerProps,
   getMaxMarkerSize: () => getMaxMarkerSize,
   getSizeAccessor: () => getSizeAccessor,
+  getSpatialIndexFromGeoColumn: () => getSpatialIndexFromGeoColumn,
   getTextAccessor: () => getTextAccessor,
   groupValuesByColumn: () => groupValuesByColumn,
   groupValuesByDateColumn: () => groupValuesByDateColumn,
@@ -5565,6 +5569,7 @@ __export(src_exports, {
   rasterSource: () => rasterSource,
   removeFilter: () => removeFilter,
   requestWithParameters: () => requestWithParameters,
+  scaleAggregationResLevel: () => scaleAggregationResLevel,
   scatterPlot: () => scatterPlot,
   setClient: () => setClient,
   tileFeatures: () => tileFeatures,
@@ -11092,24 +11097,6 @@ function isValidBandValue(value, nodata) {
 
 // src/utils.ts
 init_cjs_shims();
-var FILTER_TYPES = new Set(Object.values(FilterType));
-var isFilterType = (type) => FILTER_TYPES.has(type);
-function getApplicableFilters(owner, filters) {
-  if (!filters) return {};
-  const applicableFilters = {};
-  for (const column in filters) {
-    for (const type in filters[column]) {
-      if (!isFilterType(type)) continue;
-      const filter = filters[column][type];
-      const isApplicable = !owner || !filter?.owner || filter?.owner !== owner;
-      if (filter && isApplicable) {
-        applicableFilters[column] || (applicableFilters[column] = {});
-        applicableFilters[column][type] = filter;
-      }
-    }
-  }
-  return applicableFilters;
-}
 function normalizeObjectKeys(el) {
   if (Array.isArray(el)) {
     return el.map((value) => normalizeObjectKeys(value));
@@ -11501,7 +11488,6 @@ function excludeURLParameters(baseUrlString, parameters) {
 // src/sources/base-source.ts
 var SOURCE_DEFAULTS = {
   apiBaseUrl: DEFAULT_API_BASE_URL,
-  format: "tilejson",
   headers: {},
   maxLengthURL: DEFAULT_MAX_LENGTH_URL
 };
@@ -11520,7 +11506,7 @@ async function baseSource(endpoint, options, urlParameters) {
     }
   }
   const baseUrl = buildSourceUrl(mergedOptions);
-  const { clientId, maxLengthURL, format, localCache } = mergedOptions;
+  const { clientId, maxLengthURL, localCache } = mergedOptions;
   const headers = {
     Authorization: `Bearer ${options.accessToken}`,
     ...options.headers
@@ -11540,7 +11526,7 @@ async function baseSource(endpoint, options, urlParameters) {
     maxLengthURL,
     localCache
   });
-  const dataUrl = mapInstantiation[format].url[0];
+  const dataUrl = mapInstantiation.tilejson.url[0];
   if (cache) {
     cache.value = parseInt(
       new URL(dataUrl).searchParams.get("cache") || "",
@@ -11548,21 +11534,7 @@ async function baseSource(endpoint, options, urlParameters) {
     );
   }
   errorContext.requestType = "Map data";
-  if (format === "tilejson") {
-    const json = await requestWithParameters({
-      baseUrl: dataUrl,
-      parameters: { client: clientId },
-      headers,
-      errorContext,
-      maxLengthURL,
-      localCache
-    });
-    if (accessToken) {
-      json.accessToken = accessToken;
-    }
-    return json;
-  }
-  return await requestWithParameters({
+  const json = await requestWithParameters({
     baseUrl: dataUrl,
     parameters: { client: clientId },
     headers,
@@ -11570,6 +11542,10 @@ async function baseSource(endpoint, options, urlParameters) {
     maxLengthURL,
     localCache
   });
+  if (accessToken) {
+    json.accessToken = accessToken;
+  }
+  return json;
 }
 
 // src/sources/boundary-query-source.ts
@@ -11595,11 +11571,7 @@ var boundaryQuerySource = async function(options) {
   if (queryParameters) {
     urlParameters.queryParameters = queryParameters;
   }
-  return baseSource(
-    "boundary",
-    options,
-    urlParameters
-  );
+  return baseSource("boundary", options, urlParameters);
 };
 
 // src/sources/boundary-table-source.ts
@@ -11616,11 +11588,7 @@ var boundaryTableSource = async function(options) {
   if (filters) {
     urlParameters.filters = filters;
   }
-  return baseSource(
-    "boundary",
-    options,
-    urlParameters
-  );
+  return baseSource("boundary", options, urlParameters);
 };
 
 // src/sources/h3-query-source.ts
@@ -11815,6 +11783,83 @@ function objectToURLSearchParams(object) {
   return params;
 }
 
+// src/filters.ts
+init_cjs_shims();
+var FILTER_TYPES = new Set(Object.values(FilterType));
+var isFilterType = (type) => FILTER_TYPES.has(type);
+function addFilter(filters, { column, type, values, owner }) {
+  if (!filters[column]) {
+    filters[column] = {};
+  }
+  const filter = { values, owner };
+  filters[column][type] = filter;
+  return filters;
+}
+function removeFilter(filters, { column, owner }) {
+  const filter = filters[column];
+  if (!filter) {
+    return filters;
+  }
+  if (owner) {
+    for (const type of FILTER_TYPES) {
+      if (owner === filter[type]?.owner) {
+        delete filter[type];
+      }
+    }
+  }
+  if (!owner || isEmptyObject(filter)) {
+    delete filters[column];
+  }
+  return filters;
+}
+function clearFilters(filters) {
+  for (const column of Object.keys(filters)) {
+    delete filters[column];
+  }
+  return filters;
+}
+function hasFilter(filters, { column, owner }) {
+  const filter = filters[column];
+  if (!filter) {
+    return false;
+  }
+  if (!owner) {
+    return true;
+  }
+  for (const type of FILTER_TYPES) {
+    if (owner === filter[type]?.owner) {
+      return true;
+    }
+  }
+  return false;
+}
+function getFilter(filters, { column, type, owner }) {
+  const filter = filters[column];
+  if (!filter) {
+    return null;
+  }
+  if (!owner || owner === filter[type]?.owner) {
+    return filter[type] || null;
+  }
+  return null;
+}
+function getApplicableFilters(owner, filters) {
+  if (!filters) return {};
+  const applicableFilters = {};
+  for (const column in filters) {
+    for (const type in filters[column]) {
+      if (!isFilterType(type)) continue;
+      const filter = filters[column][type];
+      const isApplicable = !owner || !filter?.owner || filter?.owner !== owner;
+      if (filter && isApplicable) {
+        applicableFilters[column] || (applicableFilters[column] = {});
+        applicableFilters[column][type] = filter;
+      }
+    }
+  }
+  return applicableFilters;
+}
+
 // src/widget-sources/widget-remote-source.ts
 var WidgetRemoteSource = class extends WidgetSource {
   _getModelSource(filters, filterOwner) {
@@ -12909,6 +12954,9 @@ var WidgetTilesetSourceImpl = class extends WidgetSource {
       return { rows: [], totalCount: 0 };
     }
     if (searchFilterColumn && searchFilterText) {
+      console.warn(
+        'WidgetTilesetSource: "searchFilterText" is deprecated, use "filters" and FilterType.STRING_SEARCH instead.'
+      );
       filteredFeatures = filteredFeatures.filter(
         (row) => row[searchFilterColumn] && String(row[searchFilterColumn]).toLowerCase().includes(String(searchFilterText).toLowerCase())
       );
@@ -14756,7 +14804,7 @@ function parseMap(json) {
   const { keplerMapConfig, datasets, token } = json;
   assert2(keplerMapConfig.version === "v1", "Only support Kepler v1");
   const config2 = keplerMapConfig.config;
-  const { filters, mapState, mapStyle, popupSettings } = config2;
+  const { filters, mapState, mapStyle, popupSettings, legendSettings } = config2;
   const { layers, layerBlending, interactionConfig } = config2.visState;
   return {
     id: json.id,
@@ -14768,6 +14816,7 @@ function parseMap(json) {
     /** @deprecated Use `basemap`. */
     mapStyle,
     popupSettings,
+    legendSettings,
     token,
     layers: layers.reverse().map(({ id, type, config: config3, visualChannels }) => {
       try {
@@ -15488,65 +15537,6 @@ async function fetchMap({
   return out;
 }
 
-// src/filters.ts
-init_cjs_shims();
-function addFilter(filters, { column, type, values, owner }) {
-  if (!filters[column]) {
-    filters[column] = {};
-  }
-  const filter = { values, owner };
-  filters[column][type] = filter;
-  return filters;
-}
-function removeFilter(filters, { column, owner }) {
-  const filter = filters[column];
-  if (!filter) {
-    return filters;
-  }
-  if (owner) {
-    for (const type of Object.values(FilterType)) {
-      if (owner === filter[type]?.owner) {
-        delete filter[type];
-      }
-    }
-  }
-  if (!owner || isEmptyObject(filter)) {
-    delete filters[column];
-  }
-  return filters;
-}
-function clearFilters(filters) {
-  for (const column of Object.keys(filters)) {
-    delete filters[column];
-  }
-  return filters;
-}
-function hasFilter(filters, { column, owner }) {
-  const filter = filters[column];
-  if (!filter) {
-    return false;
-  }
-  if (!owner) {
-    return true;
-  }
-  for (const type of Object.values(FilterType)) {
-    if (owner === filter[type]?.owner) {
-      return true;
-    }
-  }
-  return false;
-}
-function getFilter(filters, { column, type, owner }) {
-  const filter = filters[column];
-  if (!filter) {
-    return null;
-  }
-  if (!owner || owner === filter[type]?.owner) {
-    return filter[type] || null;
-  }
-  return null;
-}
-
 // src/geo.ts
 init_cjs_shims();
 
@@ -15722,21 +15712,25 @@ function _getHexagonResolution(viewport, tileSize) {
   buildPublicMapUrl,
   buildStatsUrl,
   clearFilters,
+  configureSource,
   createPolygonSpatialFilter,
   createViewportSpatialFilter,
   fetchBasemapProps,
   fetchMap,
   filterFunctions,
   geojsonFeatures,
+  getApplicableFilters,
   getClient,
   getColorAccessor,
   getColorValueAccessor,
+  getColumnNameFromGeoColumn,
   getDataFilterExtensionProps,
   getFilter,
   getIconUrlAccessor,
   getLayerProps,
   getMaxMarkerSize,
   getSizeAccessor,
+  getSpatialIndexFromGeoColumn,
   getTextAccessor,
   groupValuesByColumn,
   groupValuesByDateColumn,
@@ -15756,6 +15750,7 @@ function _getHexagonResolution(viewport, tileSize) {
   rasterSource,
   removeFilter,
   requestWithParameters,
+  scaleAggregationResLevel,
   scatterPlot,
   setClient,
   tileFeatures,