@carto/api-client 0.5.8-alpha-others-orderby.2 → 0.5.8

package/package.json

@@ -8,7 +8,7 @@
   "homepage": "https://github.com/CartoDB/carto-api-client#readme",
   "author": "Don McCurdy <donmccurdy@carto.com>",
   "packageManager": "yarn@4.3.1",
-  "version": "0.5.8-alpha-others-orderby.2",
+  "version": "0.5.8",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -126,7 +126,7 @@
     "typescript": "~5.8.2",
     "typescript-eslint": "^8.26.1",
     "vite": "^6.2.2",
-    "vitest": "3.1.4"
+    "vitest": "3.2.3"
   },
   "resolutions": {
     "@carto/api-client": "portal:./",

package/src/filters/tileFeaturesRaster.ts

@@ -1,8 +1,4 @@
-import {
-  cellToChildren as _cellToChildren,
-  cellToTile,
-  getResolution,
-} from 'quadbin';
+import {cellToTile, getResolution, tileToCell} from 'quadbin';
 import type {RasterTile, SpatialFilter, Tile} from '../types.js';
 import type {FeatureData} from '../types-internal.js';
 import type {
@@ -56,7 +52,7 @@ export function tileFeaturesRaster({
 
     if (intersection === false) continue;
 
-    const tileSortedCells = cellToChildrenSorted(parent, cellResolution);
+    const tileSortedCells = cellToChildrenRaster(parent, cellResolution);
 
     // For each pixel/cell within the spatial filter, create a FeatureData.
     // Order is row-major, starting from NW and ending at SE.
@@ -100,21 +96,28 @@ function isRasterTileVisible(tile: RasterTile): tile is Required<RasterTile> {
 }
 
 /**
- * For the raster format, children are sorted in row-major order, starting from
- * NW and ending at SE. Order returned by quadbin's cellToChildren() is not
- * defined (and not related to the raster format), so sort explicitly here.
+ * Alternative to `quadbin` module's `cellToChildren()` function, modified to
+ * return cells in row-major order, NW to SE, as stored in CARTO raster tiles.
+ * Sorting after computing cells is too slow.
  */
-function cellToChildrenSorted(parent: bigint, resolution: bigint): bigint[] {
-  return _cellToChildren(parent, resolution).sort(
-    (cellA: bigint, cellB: bigint) => {
-      const tileA = cellToTile(cellA);
-      const tileB = cellToTile(cellB);
-      if (tileA.y !== tileB.y) {
-        return tileA.y > tileB.y ? 1 : -1;
-      }
-      return tileA.x > tileB.x ? 1 : -1;
-    }
-  );
+function cellToChildrenRaster(parent: bigint, resolution: bigint): bigint[] {
+  const parentTile = cellToTile(parent);
+
+  // 1. Calculate x/y/z of upper left pixel in raster tile.
+  const childZ = Number(resolution);
+  const blockSize = 2 ** (childZ - parentTile.z);
+  const childBaseX = parentTile.x * blockSize;
+  const childBaseY = parentTile.y * blockSize;
+
+  // 2. Iterate pixels in raster tile order; compute cell ID from base x/y.
+  const cells: bigint[] = [];
+  for (let i = 0, il = blockSize ** 2; i < il; i++) {
+    const x = childBaseX + (i % blockSize);
+    const y = childBaseY + Math.floor(i / blockSize);
+    cells.push(tileToCell({x, y, z: childZ}));
+  }
+
+  return cells;
 }
 
 /**

package/src/operations/groupBy.ts

@@ -1,11 +1,7 @@
 import {aggregationFunctions, aggregate} from './aggregation.js';
 import type {AggregationType} from '../types.js';
 import type {FeatureData} from '../types-internal.js';
-import type {
-  CategoryOrderBy,
-  CategoryResponseEntry,
-  CategoryResponseRaw,
-} from '../widget-sources/types.js';
+import type {CategoryResponseRaw} from '../widget-sources/types.js';
 
 /** @privateRemarks Source: @carto/react-core */
 export function groupValuesByColumn({
@@ -15,7 +11,6 @@ export function groupValuesByColumn({
   keysColumn,
   operation,
   othersThreshold,
-  orderBy = 'frequency_desc',
 }: {
   data: FeatureData[];
   valuesColumns?: string[];
@@ -23,7 +18,6 @@ export function groupValuesByColumn({
   keysColumn: string;
   operation: AggregationType;
   othersThreshold?: number;
-  orderBy?: CategoryOrderBy;
 }): CategoryResponseRaw | null {
   if (Array.isArray(data) && data.length === 0) {
     return {rows: null};
@@ -60,7 +54,7 @@ export function groupValuesByColumn({
       name,
       value: targetOperation(value),
     }))
-    .sort(getSorter(orderBy));
+    .sort((a, b) => b.value - a.value);
 
   if (othersThreshold && allCategories.length > othersThreshold) {
     const otherValue = allCategories
@@ -78,26 +72,3 @@ export function groupValuesByColumn({
     rows: allCategories,
   };
 }
-
-export function getSorter(
-  orderBy: CategoryOrderBy
-): (a: CategoryResponseEntry, b: CategoryResponseEntry) => number {
-  switch (orderBy) {
-    case 'frequency_asc':
-      // 'value ASC, name ASC'
-      return (a, b) => a.value - b.value || localeCompare(a.name, b.name);
-    case 'frequency_desc':
-      // 'value DESC, name ASC'
-      return (a, b) => b.value - a.value || localeCompare(a.name, b.name);
-    case 'alphabetical_asc':
-      // 'name ASC, value DESC'
-      return (a, b) => localeCompare(a.name, b.name) || b.value - a.value;
-    case 'alphabetical_desc':
-      // 'name DESC, value DESC'
-      return (a, b) => localeCompare(b.name, a.name) || b.value - a.value;
-  }
-}
-
-function localeCompare(a?: string | null, b?: string | null) {
-  return (a ?? 'null').localeCompare(b ?? 'null');
-}

package/src/widget-sources/types.ts

@@ -31,12 +31,6 @@ export interface BaseRequestOptions {
   filterOwner?: string;
 }
 
-export type CategoryOrderBy =
-  | 'frequency_asc' // sort by aggregate value ascending, then by name ascending
-  | 'frequency_desc' // sort by aggregate value descending, then by name ascending
-  | 'alphabetical_asc' // sort by category name ascending, then by value descending
-  | 'alphabetical_desc'; // sort by category name descending, then by value descending
-
 /**
  * Examples:
  *   * population by state
@@ -67,11 +61,6 @@ export interface CategoryRequestOptions extends BaseRequestOptions {
   joinOperation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
   /** Calculate `_carto_others` category for all categories after first N (N is threshold). */
   othersThreshold?: number;
-  /**
-   * Order categories by frequency or alphabetically.
-   * @default 'frequency_desc'
-   */
-  orderBy?: CategoryOrderBy;
   /** Return raw result (CategoryResponseRaw). */
   rawResult?: boolean;
 }
@@ -220,7 +209,6 @@ export type FeaturesResponse = {rows: Record<string, unknown>[]};
 /** Response from {@link WidgetRemoteSource#getFormula}. */
 export type FormulaResponse = {value: number | null};
 
-/** Entry in the category widget response, see  {@link WidgetRemoteSource#getCategories}. */
 export type CategoryResponseEntry = {name: string | null; value: number};
 /** Response from {@link WidgetRemoteSource#getCategories}. */
 export type CategoryResponse = CategoryResponseEntry[];

package/src/widget-sources/widget-remote-source.ts

@@ -76,14 +76,8 @@ export abstract class WidgetRemoteSource<
       rawResult,
       ...params
     } = options;
-    const {
-      column,
-      operation,
-      operationColumn,
-      operationExp,
-      othersThreshold,
-      orderBy,
-    } = params;
+    const {column, operation, operationColumn, operationExp, othersThreshold} =
+      params;
 
     if (operation === AggregationTypes.Custom) {
       assert(operationExp, 'operationExp is required for custom operation');
@@ -102,7 +96,6 @@ export abstract class WidgetRemoteSource<
         operationExp,
         operationColumn: operationColumn || column,
         othersThreshold,
-        orderBy,
       },
       opts: {signal, headers: this.props.headers},
     });

package/src/widget-sources/widget-tileset-source-impl.ts

@@ -191,7 +191,6 @@ export class WidgetTilesetSourceImpl extends WidgetSource<WidgetTilesetSourcePro
     filterOwner,
     spatialFilter,
     othersThreshold,
-    orderBy = 'frequency_desc',
     rawResult,
   }: CategoryRequestOptions): Promise<CategoryResponse> {
     const filteredFeatures = this._getFilteredFeatures(
@@ -213,7 +212,6 @@ export class WidgetTilesetSourceImpl extends WidgetSource<WidgetTilesetSourcePro
       keysColumn: column,
       operation,
       othersThreshold,
-      orderBy,
     });
 
     if (rawResult) {