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

package/build/api-client.d.cts

@@ -388,8 +388,6 @@ 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>;
 };
 type LocalCacheOptions = {
     /**
@@ -525,7 +523,7 @@ 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[];
     minresolution: number;
     maxresolution: number;
@@ -637,6 +635,11 @@ 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
@@ -660,10 +663,11 @@ 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;
@@ -689,26 +693,16 @@ type QueryResult = {
     }[];
 };
 
-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;
-};
+type QueryOptions = SourceOptions & QuerySourceOptions;
 declare const query: (options: QueryOptions) => Promise<QueryResult>;
 
-declare function requestWithParameters<T = any>({ baseUrl, parameters, headers: customHeaders, errorContext, maxLengthURL, localCache, signal, }: {
+declare function requestWithParameters<T = any>({ baseUrl, parameters, headers: customHeaders, errorContext, maxLengthURL, localCache, }: {
     baseUrl: string;
     parameters?: Record<string, unknown>;
     headers?: Record<string, string>;
     errorContext: APIErrorContext;
     maxLengthURL?: number;
     localCache?: LocalCacheOptions;
-    signal?: AbortSignal;
 }): Promise<T>;
 /**
  * Clears the HTTP response cache for all requests using the default cache.
@@ -1351,7 +1345,7 @@ type FormulaResponse = {
 };
 /** Entry in the category widget response, see  {@link WidgetRemoteSource#getCategories}. */
 type CategoryResponseEntry = {
-    name: string | null;
+    name: string | number | null;
     value: number;
 };
 /** Response from {@link WidgetRemoteSource#getCategories}. */
@@ -1469,7 +1463,6 @@ interface ModelSource {
     spatialDataColumn?: string;
     spatialDataType?: SpatialDataType;
     spatialFiltersMode?: SpatialFilterPolyfillMode;
-    tags?: Record<string, string>;
 }
 
 type WidgetRemoteSourceProps = WidgetSourceProps;

package/build/api-client.d.ts

@@ -388,8 +388,6 @@ 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>;
 };
 type LocalCacheOptions = {
     /**
@@ -525,7 +523,7 @@ 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[];
     minresolution: number;
     maxresolution: number;
@@ -637,6 +635,11 @@ 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
@@ -660,10 +663,11 @@ 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;
@@ -689,26 +693,16 @@ type QueryResult = {
     }[];
 };
 
-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;
-};
+type QueryOptions = SourceOptions & QuerySourceOptions;
 declare const query: (options: QueryOptions) => Promise<QueryResult>;
 
-declare function requestWithParameters<T = any>({ baseUrl, parameters, headers: customHeaders, errorContext, maxLengthURL, localCache, signal, }: {
+declare function requestWithParameters<T = any>({ baseUrl, parameters, headers: customHeaders, errorContext, maxLengthURL, localCache, }: {
     baseUrl: string;
     parameters?: Record<string, unknown>;
     headers?: Record<string, string>;
     errorContext: APIErrorContext;
     maxLengthURL?: number;
     localCache?: LocalCacheOptions;
-    signal?: AbortSignal;
 }): Promise<T>;
 /**
  * Clears the HTTP response cache for all requests using the default cache.
@@ -1351,7 +1345,7 @@ type FormulaResponse = {
 };
 /** Entry in the category widget response, see  {@link WidgetRemoteSource#getCategories}. */
 type CategoryResponseEntry = {
-    name: string | null;
+    name: string | number | null;
     value: number;
 };
 /** Response from {@link WidgetRemoteSource#getCategories}. */
@@ -1469,7 +1463,6 @@ interface ModelSource {
     spatialDataColumn?: string;
     spatialDataType?: SpatialDataType;
     spatialFiltersMode?: SpatialFilterPolyfillMode;
-    tags?: Record<string, string>;
 }
 
 type WidgetRemoteSourceProps = WidgetSourceProps;

package/build/api-client.js

@@ -5839,8 +5839,7 @@ async function requestWithParameters({
   headers: customHeaders = {},
   errorContext,
   maxLengthURL = DEFAULT_MAX_LENGTH_URL,
-  localCache,
-  signal
+  localCache
 }) {
   parameters = {
     v: V3_MINOR_VERSION,
@@ -5863,9 +5862,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) => {
@@ -5917,12 +5915,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();
@@ -5966,7 +5962,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,
@@ -6168,8 +6164,7 @@ function executeModel(props) {
     filtersLogicalOperator = "and",
     spatialDataType = "geo",
     spatialDataColumn = DEFAULT_GEO_COLUMN,
-    spatialFiltersMode = "intersects",
-    tags
+    spatialFiltersMode = "intersects"
   } = source;
   const queryParams = {
     type,
@@ -6178,8 +6173,7 @@ function executeModel(props) {
     params,
     queryParameters: source.queryParameters || "",
     filters,
-    filtersLogicalOperator,
-    ...tags ?? {}
+    filtersLogicalOperator
   };
   queryParams.spatialDataType = spatialDataType;
   queryParams.spatialDataColumn = spatialDataColumn;
@@ -6312,8 +6306,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) {
@@ -6800,17 +6793,20 @@ function groupValuesByColumn({
 function getSorter(orderBy) {
   switch (orderBy) {
     case "frequency_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":
-      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":
-      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":
-      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, b) {
-  return (a ?? "null").localeCompare(b ?? "null");
+function nameCompare(a, b) {
+  if (typeof a === "number" && typeof b === "number") {
+    return a - b;
+  }
+  return String(a ?? "null").localeCompare(String(b ?? "null"));
 }
 
 // src/utils/dateUtils.ts
@@ -8116,8 +8112,7 @@ var query = async function(options) {
     localCache,
     connectionName,
     sqlQuery,
-    queryParameters,
-    internalParameters
+    queryParameters
   } = options;
   const urlParameters = { q: sqlQuery };
   if (queryParameters) {
@@ -8128,12 +8123,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,
@@ -8146,8 +8136,7 @@ var query = async function(options) {
     headers,
     errorContext,
     maxLengthURL,
-    localCache,
-    signal: options.signal
+    localCache
   });
 };