@carto/api-client 0.5.11 → 0.5.13

package/build/api-client.d.cts

@@ -325,6 +325,15 @@ declare function buildStatsUrl({ attribute, apiBaseUrl, connectionName, source,
     type: MapType;
 }): string;
 
+declare enum RasterBandColorinterp {
+    Gray = "gray",
+    Red = "red",
+    Green = "green",
+    Blue = "blue",
+    Alpha = "alpha",
+    Palette = "palette"
+}
+
 type SourceRequiredOptions = {
     /** Carto platform access token. */
     accessToken: string;
@@ -388,6 +397,8 @@ 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 = {
     /**
@@ -622,14 +633,6 @@ type RasterMetadataBandStats = {
      */
     version?: string;
 };
-declare enum RasterBandColorinterp {
-    Gray = "gray",
-    Red = "red",
-    Green = "green",
-    Blue = "blue",
-    Alpha = "alpha",
-    Palette = "palette"
-}
 type RasterBandType = 'uint8' | 'int8' | 'uint16' | 'int16' | 'uint32' | 'int32' | 'uint64' | 'int64' | 'float32' | 'float64';
 type RasterMetadataBand = {
     type: RasterBandType;
@@ -693,16 +696,26 @@ type QueryResult = {
     }[];
 };
 
-type QueryOptions = SourceOptions & QuerySourceOptions;
+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;
+};
 declare const query: (options: QueryOptions) => Promise<QueryResult>;
 
-declare function requestWithParameters<T = any>({ baseUrl, parameters, headers: customHeaders, errorContext, maxLengthURL, localCache, }: {
+declare function requestWithParameters<T = any>({ baseUrl, parameters, headers: customHeaders, errorContext, maxLengthURL, localCache, signal, }: {
     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.
@@ -1463,6 +1476,7 @@ interface ModelSource {
     spatialDataColumn?: string;
     spatialDataType?: SpatialDataType;
     spatialFiltersMode?: SpatialFilterPolyfillMode;
+    tags?: Record<string, string>;
 }
 
 type WidgetRemoteSourceProps = WidgetSourceProps;

package/build/api-client.d.ts

@@ -325,6 +325,15 @@ declare function buildStatsUrl({ attribute, apiBaseUrl, connectionName, source,
     type: MapType;
 }): string;
 
+declare enum RasterBandColorinterp {
+    Gray = "gray",
+    Red = "red",
+    Green = "green",
+    Blue = "blue",
+    Alpha = "alpha",
+    Palette = "palette"
+}
+
 type SourceRequiredOptions = {
     /** Carto platform access token. */
     accessToken: string;
@@ -388,6 +397,8 @@ 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 = {
     /**
@@ -622,14 +633,6 @@ type RasterMetadataBandStats = {
      */
     version?: string;
 };
-declare enum RasterBandColorinterp {
-    Gray = "gray",
-    Red = "red",
-    Green = "green",
-    Blue = "blue",
-    Alpha = "alpha",
-    Palette = "palette"
-}
 type RasterBandType = 'uint8' | 'int8' | 'uint16' | 'int16' | 'uint32' | 'int32' | 'uint64' | 'int64' | 'float32' | 'float64';
 type RasterMetadataBand = {
     type: RasterBandType;
@@ -693,16 +696,26 @@ type QueryResult = {
     }[];
 };
 
-type QueryOptions = SourceOptions & QuerySourceOptions;
+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;
+};
 declare const query: (options: QueryOptions) => Promise<QueryResult>;
 
-declare function requestWithParameters<T = any>({ baseUrl, parameters, headers: customHeaders, errorContext, maxLengthURL, localCache, }: {
+declare function requestWithParameters<T = any>({ baseUrl, parameters, headers: customHeaders, errorContext, maxLengthURL, localCache, signal, }: {
     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.
@@ -1463,6 +1476,7 @@ interface ModelSource {
     spatialDataColumn?: string;
     spatialDataType?: SpatialDataType;
     spatialFiltersMode?: SpatialFilterPolyfillMode;
+    tags?: Record<string, string>;
 }
 
 type WidgetRemoteSourceProps = WidgetSourceProps;

package/build/api-client.js

@@ -5839,7 +5839,8 @@ async function requestWithParameters({
   headers: customHeaders = {},
   errorContext,
   maxLengthURL = DEFAULT_MAX_LENGTH_URL,
-  localCache
+  localCache,
+  signal
 }) {
   parameters = {
     v: V3_MINOR_VERSION,
@@ -5862,8 +5863,9 @@ async function requestWithParameters({
   const fetchPromise = url.length > maxLengthURL ? fetch(baseUrl, {
     method: "POST",
     body: JSON.stringify(parameters),
-    headers
-  }) : fetch(url, { headers });
+    headers,
+    signal
+  }) : fetch(url, { headers, signal });
   let response;
   let responseJson;
   const jsonPromise = fetchPromise.then((_response) => {
@@ -5915,10 +5917,12 @@ function createURLWithParameters(baseUrlString, parameters) {
     if (isPureObject(value) || Array.isArray(value)) {
       baseUrl.searchParams.set(key, JSON.stringify(value));
     } else {
-      baseUrl.searchParams.set(
-        key,
-        value.toString()
-      );
+      if (value !== null && value !== void 0) {
+        baseUrl.searchParams.set(
+          key,
+          value.toString()
+        );
+      }
     }
   }
   return baseUrl.toString();
@@ -5962,7 +5966,7 @@ async function baseSource(endpoint, options, urlParameters) {
     Authorization: `Bearer ${options.accessToken}`,
     ...options.headers
   };
-  const parameters = { client: clientId, ...urlParameters };
+  const parameters = { client: clientId, ...options.tags, ...urlParameters };
   const errorContext = {
     requestType: "Map instantiation",
     connection: options.connectionName,
@@ -6002,6 +6006,17 @@ async function baseSource(endpoint, options, urlParameters) {
   return json;
 }
 
+// src/sources/constants.ts
+var RasterBandColorinterp = /* @__PURE__ */ ((RasterBandColorinterp2) => {
+  RasterBandColorinterp2["Gray"] = "gray";
+  RasterBandColorinterp2["Red"] = "red";
+  RasterBandColorinterp2["Green"] = "green";
+  RasterBandColorinterp2["Blue"] = "blue";
+  RasterBandColorinterp2["Alpha"] = "alpha";
+  RasterBandColorinterp2["Palette"] = "palette";
+  return RasterBandColorinterp2;
+})(RasterBandColorinterp || {});
+
 // src/sources/boundary-query-source.ts
 var boundaryQuerySource = async function(options) {
   const {
@@ -6164,7 +6179,8 @@ function executeModel(props) {
     filtersLogicalOperator = "and",
     spatialDataType = "geo",
     spatialDataColumn = DEFAULT_GEO_COLUMN,
-    spatialFiltersMode = "intersects"
+    spatialFiltersMode = "intersects",
+    tags
   } = source;
   const queryParams = {
     type,
@@ -6173,7 +6189,8 @@ function executeModel(props) {
     params,
     queryParameters: source.queryParameters || "",
     filters,
-    filtersLogicalOperator
+    filtersLogicalOperator,
+    ...tags ?? {}
   };
   queryParams.spatialDataType = spatialDataType;
   queryParams.spatialDataColumn = spatialDataColumn;
@@ -6306,7 +6323,8 @@ var WidgetRemoteSource = class extends WidgetSource {
       filters: getApplicableFilters(filterOwner, filters || props.filters),
       filtersLogicalOperator: props.filtersLogicalOperator,
       spatialDataType: props.spatialDataType,
-      spatialDataColumn: props.spatialDataColumn
+      spatialDataColumn: props.spatialDataColumn,
+      tags: props.tags
     };
   }
   async getCategories(options) {
@@ -8112,7 +8130,8 @@ var query = async function(options) {
     localCache,
     connectionName,
     sqlQuery,
-    queryParameters
+    queryParameters,
+    internalParameters
   } = options;
   const urlParameters = { q: sqlQuery };
   if (queryParameters) {
@@ -8123,7 +8142,12 @@ var query = async function(options) {
     Authorization: `Bearer ${options.accessToken}`,
     ...options.headers
   };
-  const parameters = { client: clientId, ...urlParameters };
+  const parameters = {
+    client: clientId,
+    ...options.tags,
+    ...internalParameters,
+    ...urlParameters
+  };
   const errorContext = {
     requestType: "SQL",
     connection: options.connectionName,
@@ -8136,7 +8160,8 @@ var query = async function(options) {
     headers,
     errorContext,
     maxLengthURL,
-    localCache
+    localCache,
+    signal: options.signal
   });
 };
 
@@ -10149,6 +10174,7 @@ export {
   OPACITY_MAP,
   OTHERS_CATEGORY_NAME,
   Provider,
+  RasterBandColorinterp,
   SOURCE_DEFAULTS,
   SchemaFieldType,
   SpatialIndex,