@carto/api-client 0.5.10-alpha.PR193.4 → 0.5.11

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.10-alpha.PR193.4",
+  "version": "0.5.11",
   "license": "MIT",
   "publishConfig": {
     "access": "public"

package/src/api/query.ts

@@ -13,17 +13,7 @@ import {requestWithParameters} from './request-with-parameters.js';
 import type {APIErrorContext} from './carto-api-error.js';
 import {getClient} from '../client.js';
 
-export type QueryOptions = SourceOptions &
-  QuerySourceOptions & {
-    /**
-     * @internal
-     * @experimental
-     * Used to append additional parameters to the SQL API request for features specific to providers or integrations.
-     */
-    internalParameters?: Record<string, string | boolean | number>;
-    /** Used to abort the request. */
-    signal?: AbortSignal;
-  };
+export type QueryOptions = SourceOptions & QuerySourceOptions;
 type UrlParameters = {q: string; queryParameters?: string};
 
 export const query = async function (
@@ -37,7 +27,6 @@ export const query = async function (
     connectionName,
     sqlQuery,
     queryParameters,
-    internalParameters,
   } = options;
   const urlParameters: UrlParameters = {q: sqlQuery};
 
@@ -50,12 +39,7 @@ export const query = async function (
     Authorization: `Bearer ${options.accessToken}`,
     ...options.headers,
   };
-  const parameters = {
-    client: clientId,
-    ...options.tags,
-    ...internalParameters,
-    ...urlParameters,
-  };
+  const parameters = {client: clientId, ...urlParameters};
 
   const errorContext: APIErrorContext = {
     requestType: 'SQL',
@@ -70,6 +54,5 @@ export const query = async function (
     errorContext,
     maxLengthURL,
     localCache,
-    signal: options.signal,
   });
 };

package/src/api/request-with-parameters.ts

@@ -23,7 +23,6 @@ export async function requestWithParameters<T = any>({
   errorContext,
   maxLengthURL = DEFAULT_MAX_LENGTH_URL,
   localCache,
-  signal,
 }: {
   baseUrl: string;
   parameters?: Record<string, unknown>;
@@ -31,7 +30,6 @@ export async function requestWithParameters<T = any>({
   errorContext: APIErrorContext;
   maxLengthURL?: number;
   localCache?: LocalCacheOptions;
-  signal?: AbortSignal;
 }): Promise<T> {
   // Parameters added to all requests issued with `requestWithParameters()`.
   // These parameters override parameters already in the base URL, but not
@@ -67,9 +65,8 @@ export async function requestWithParameters<T = any>({
           method: 'POST',
           body: JSON.stringify(parameters),
           headers,
-          signal,
         })
-      : fetch(url, {headers, signal});
+      : fetch(url, {headers});
 
   let response: Response | undefined;
   let responseJson: unknown;
@@ -146,12 +143,10 @@ function createURLWithParameters(
     if (isPureObject(value) || Array.isArray(value)) {
       baseUrl.searchParams.set(key, JSON.stringify(value));
     } else {
-      if (value !== null && value !== undefined) {
-        baseUrl.searchParams.set(
-          key,
-          (value as string | boolean | number).toString()
-        );
-      }
+      baseUrl.searchParams.set(
+        key,
+        (value as string | boolean | number).toString()
+      );
     }
   }
   return baseUrl.toString();

package/src/models/model.ts

@@ -43,7 +43,6 @@ export interface ModelSource {
   spatialDataColumn?: string;
   spatialDataType?: SpatialDataType;
   spatialFiltersMode?: SpatialFilterPolyfillMode;
-  tags?: Record<string, string>;
 }
 
 const {V3} = ApiVersion;
@@ -88,7 +87,6 @@ export function executeModel(props: {
     spatialDataType = 'geo',
     spatialDataColumn = DEFAULT_GEO_COLUMN,
     spatialFiltersMode = 'intersects',
-    tags,
   } = source;
 
   const queryParams: Record<string, unknown> = {
@@ -99,7 +97,6 @@ export function executeModel(props: {
     queryParameters: source.queryParameters || '',
     filters,
     filtersLogicalOperator,
-    ...(tags ?? {}),
   };
 
   queryParams.spatialDataType = spatialDataType;

package/src/operations/groupBy.ts

@@ -85,19 +85,27 @@ export function getSorter(
   switch (orderBy) {
     case 'frequency_asc':
       // 'value ASC, name ASC'
-      return (a, b) => a.value - b.value || localeCompare(a.name, b.name);
+      return (a, b) => a.value - b.value || nameCompare(a.name, b.name);
     case 'frequency_desc':
       // 'value DESC, name ASC'
-      return (a, b) => b.value - a.value || localeCompare(a.name, b.name);
+      return (a, b) => b.value - a.value || nameCompare(a.name, b.name);
     case 'alphabetical_asc':
       // 'name ASC, value DESC'
-      return (a, b) => localeCompare(a.name, b.name) || b.value - a.value;
+      return (a, b) => nameCompare(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;
+      return (a, b) => nameCompare(b.name, a.name) || b.value - a.value;
   }
 }
 
-function localeCompare(a?: string | null, b?: string | null) {
-  return (a ?? 'null').localeCompare(b ?? 'null');
+function nameCompare(
+  a?: CategoryResponseEntry['name'],
+  b?: CategoryResponseEntry['name']
+) {
+  // Despite the naming of 'alphabetical_*' sort options, we still want to
+  // sort numeric category names (usually raster datasets) numerically.
+  if (typeof a === 'number' && typeof b === 'number') {
+    return a - b;
+  }
+  return String(a ?? 'null').localeCompare(String(b ?? 'null'));
 }

package/src/sources/base-source.ts

@@ -47,7 +47,7 @@ export async function baseSource<UrlParameters extends Record<string, unknown>>(
     Authorization: `Bearer ${options.accessToken}`,
     ...options.headers,
   };
-  const parameters = {client: clientId, ...options.tags, ...urlParameters};
+  const parameters = {client: clientId, ...urlParameters};
 
   const errorContext: APIErrorContext = {
     requestType: 'Map instantiation',

package/src/sources/types.ts

@@ -75,9 +75,6 @@ export type SourceOptionalOptions = {
    * By default, local in-memory caching is enabled.
    */
   localCache?: LocalCacheOptions;
-
-  /** Additional tags appended to HTTP requests, available for analytics and audits. */
-  tags?: Record<string, string>;
 };
 
 export type LocalCacheOptions = {
@@ -240,7 +237,7 @@ export interface Tilejson {
   minzoom: number;
   maxzoom: number;
   bounds: [left: number, bottom: number, right: number, top: number];
-  center: [longitute: number, latitude: number, zoom: number];
+  center: [longitude: number, latitude: number, zoom: number];
   vector_layers: VectorLayer[];
 
   //
@@ -385,6 +382,13 @@ export type RasterMetadataBand = {
   type: RasterBandType;
   name: string;
   stats: RasterMetadataBandStats;
+
+  /**
+   * Optional table of mappings from (integer) band values to (string) human
+   * readable labels. Values found in tiles are NOT guaranteed to have labels.
+   */
+  valuelabels?: Record<string, string>;
+
   /**
    * Known values:
    *  * `palette`: use unique value and `colortable` ad default mapping
@@ -411,10 +415,11 @@ export type RasterMetadata = {
   block_resolution: number;
   minresolution: number;
   maxresolution: number;
+  /** @deprecated Use {@link RasterMetadataBand.nodata} from {@link RasterMetadata.bands}. */
   nodata: number | string;
   bands: RasterMetadataBand[];
   bounds: [left: number, bottom: number, right: number, top: number];
-  center: [longitute: number, latitude: number, zoom: number];
+  center: [longitude: number, latitude: number, zoom: number];
   width: number;
   height: number;
   block_width: number;

package/src/widget-sources/types.ts

@@ -221,7 +221,11 @@ export type FeaturesResponse = {rows: Record<string, unknown>[]};
 export type FormulaResponse = {value: number | null};
 
 /** Entry in the category widget response, see  {@link WidgetRemoteSource#getCategories}. */
-export type CategoryResponseEntry = {name: string | null; value: number};
+export type CategoryResponseEntry = {
+  name: string | number | null;
+  value: number;
+};
+
 /** Response from {@link WidgetRemoteSource#getCategories}. */
 export type CategoryResponse = CategoryResponseEntry[];
 

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

@@ -61,7 +61,6 @@ export abstract class WidgetRemoteSource<
       filtersLogicalOperator: props.filtersLogicalOperator,
       spatialDataType: props.spatialDataType,
       spatialDataColumn: props.spatialDataColumn,
-      tags: props.tags,
     };
   }