@carto/api-client 0.5.9-alpha.PR193.3 → 0.5.9

package/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## 0.5
 
+### 0.5.9
+
+- feat(widgets): orderBy support in WidgetSource.getCategory (#203)
+
 ## 0.5.8
 
 - feat(widgets): Add othersThreshold to WidgetSource.getCategories (#194)

package/build/api-client.cjs

@@ -159,6 +159,7 @@ __export(src_exports, {
   getLayerProps: () => getLayerProps,
   getMaxMarkerSize: () => getMaxMarkerSize,
   getSizeAccessor: () => getSizeAccessor,
+  getSorter: () => getSorter,
   getSpatialIndexFromGeoColumn: () => getSpatialIndexFromGeoColumn,
   getTextAccessor: () => getTextAccessor,
   groupValuesByColumn: () => groupValuesByColumn,
@@ -6083,8 +6084,7 @@ async function requestWithParameters({
   headers: customHeaders = {},
   errorContext,
   maxLengthURL = DEFAULT_MAX_LENGTH_URL,
-  localCache,
-  signal
+  localCache
 }) {
   parameters = {
     v: V3_MINOR_VERSION,
@@ -6107,9 +6107,8 @@ async function requestWithParameters({
   const fetchPromise = url.length > maxLengthURL ? fetch(baseUrl, {
     method: "POST",
     body: JSON.stringify(parameters),
-    headers,
-    signal
-  }) : fetch(url, { headers, signal });
+    headers
+  }) : fetch(url, { headers });
   let response;
   let responseJson;
   const jsonPromise = fetchPromise.then((_response) => {
@@ -6161,12 +6160,10 @@ function createURLWithParameters(baseUrlString, parameters) {
     if (isPureObject(value) || Array.isArray(value)) {
       baseUrl.searchParams.set(key, JSON.stringify(value));
     } else {
-      if (value !== null && value !== void 0) {
-        baseUrl.searchParams.set(
-          key,
-          value.toString()
-        );
-      }
+      baseUrl.searchParams.set(
+        key,
+        value.toString()
+      );
     }
   }
   return baseUrl.toString();
@@ -6210,7 +6207,7 @@ async function baseSource(endpoint, options, urlParameters) {
     Authorization: `Bearer ${options.accessToken}`,
     ...options.headers
   };
-  const parameters = { client: clientId, ...options.tags, ...urlParameters };
+  const parameters = { client: clientId, ...urlParameters };
   const errorContext = {
     requestType: "Map instantiation",
     connection: options.connectionName,
@@ -6431,8 +6428,7 @@ function executeModel(props) {
     filtersLogicalOperator = "and",
     spatialDataType = "geo",
     spatialDataColumn = DEFAULT_GEO_COLUMN,
-    spatialFiltersMode = "intersects",
-    tags
+    spatialFiltersMode = "intersects"
   } = source;
   const queryParams = {
     type,
@@ -6441,8 +6437,7 @@ function executeModel(props) {
     params,
     queryParameters: source.queryParameters || "",
     filters,
-    filtersLogicalOperator,
-    ...tags ?? {}
+    filtersLogicalOperator
   };
   queryParams.spatialDataType = spatialDataType;
   queryParams.spatialDataColumn = spatialDataColumn;
@@ -6577,8 +6572,7 @@ var WidgetRemoteSource = class extends WidgetSource {
       filters: getApplicableFilters(filterOwner, filters || props.filters),
       filtersLogicalOperator: props.filtersLogicalOperator,
       spatialDataType: props.spatialDataType,
-      spatialDataColumn: props.spatialDataColumn,
-      tags: props.tags
+      spatialDataColumn: props.spatialDataColumn
     };
   }
   async getCategories(options) {
@@ -6591,7 +6585,14 @@ var WidgetRemoteSource = class extends WidgetSource {
       rawResult,
       ...params
     } = options;
-    const { column, operation: operation2, operationColumn, operationExp, othersThreshold } = params;
+    const {
+      column,
+      operation: operation2,
+      operationColumn,
+      operationExp,
+      othersThreshold,
+      orderBy
+    } = params;
     if (operation2 === AggregationTypes.Custom) {
       assert2(operationExp, "operationExp is required for custom operation");
     }
@@ -6607,7 +6608,8 @@ var WidgetRemoteSource = class extends WidgetSource {
         operation: operation2,
         operationExp,
         operationColumn: operationColumn || column,
-        othersThreshold
+        othersThreshold,
+        orderBy
       },
       opts: { signal, headers: this.props.headers }
     });
@@ -7027,7 +7029,8 @@ function groupValuesByColumn({
   joinOperation,
   keysColumn,
   operation: operation2,
-  othersThreshold
+  othersThreshold,
+  orderBy = "frequency_desc"
 }) {
   if (Array.isArray(data) && data.length === 0) {
     return { rows: null };
@@ -7051,7 +7054,7 @@ function groupValuesByColumn({
   const allCategories = Array.from(groups).map(([name, value]) => ({
     name,
     value: targetOperation(value)
-  })).sort((a, b) => b.value - a.value);
+  })).sort(getSorter(orderBy));
   if (othersThreshold && allCategories.length > othersThreshold) {
     const otherValue = allCategories.slice(othersThreshold).flatMap(({ name }) => groups.get(name));
     return {
@@ -7065,6 +7068,21 @@ function groupValuesByColumn({
     rows: allCategories
   };
 }
+function getSorter(orderBy) {
+  switch (orderBy) {
+    case "frequency_asc":
+      return (a, b) => a.value - b.value || localeCompare(a.name, b.name);
+    case "frequency_desc":
+      return (a, b) => b.value - a.value || localeCompare(a.name, b.name);
+    case "alphabetical_asc":
+      return (a, b) => localeCompare(a.name, b.name) || b.value - a.value;
+    case "alphabetical_desc":
+      return (a, b) => localeCompare(b.name, a.name) || b.value - a.value;
+  }
+}
+function localeCompare(a, b) {
+  return (a ?? "null").localeCompare(b ?? "null");
+}
 
 // src/operations/groupByDate.ts
 init_cjs_shims();
@@ -7639,6 +7657,7 @@ var WidgetTilesetSourceImpl = class extends WidgetSource {
     filterOwner,
     spatialFilter,
     othersThreshold,
+    orderBy = "frequency_desc",
     rawResult
   }) {
     const filteredFeatures = this._getFilteredFeatures(
@@ -7656,7 +7675,8 @@ var WidgetTilesetSourceImpl = class extends WidgetSource {
       joinOperation,
       keysColumn: column,
       operation: operation2,
-      othersThreshold
+      othersThreshold,
+      orderBy
     });
     if (rawResult) {
       return result;
@@ -8391,8 +8411,7 @@ var query = async function(options) {
     localCache,
     connectionName,
     sqlQuery,
-    queryParameters,
-    internalParameters
+    queryParameters
   } = options;
   const urlParameters = { q: sqlQuery };
   if (queryParameters) {
@@ -8403,12 +8422,7 @@ var query = async function(options) {
     Authorization: `Bearer ${options.accessToken}`,
     ...options.headers
   };
-  const parameters = {
-    client: clientId,
-    ...options.tags,
-    ...internalParameters,
-    ...urlParameters
-  };
+  const parameters = { client: clientId, ...urlParameters };
   const errorContext = {
     requestType: "SQL",
     connection: options.connectionName,
@@ -8421,8 +8435,7 @@ var query = async function(options) {
     headers,
     errorContext,
     maxLengthURL,
-    localCache,
-    signal: options.signal
+    localCache
   });
 };
 
@@ -10518,6 +10531,7 @@ function hashBuckets(initialCount) {
   getLayerProps,
   getMaxMarkerSize,
   getSizeAccessor,
+  getSorter,
   getSpatialIndexFromGeoColumn,
   getTextAccessor,
   groupValuesByColumn,