@carto/api-client 0.5.8 → 0.5.9-alpha.PR193.1

package/build/api-client.d.cts

@@ -388,6 +388,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 = {
     /**
@@ -687,16 +689,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.
@@ -1450,6 +1462,7 @@ interface ModelSource {
     spatialDataColumn?: string;
     spatialDataType?: SpatialDataType;
     spatialFiltersMode?: SpatialFilterPolyfillMode;
+    tags?: Record<string, string>;
 }
 
 type WidgetRemoteSourceProps = WidgetSourceProps;

package/build/api-client.d.ts

@@ -388,6 +388,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 = {
     /**
@@ -687,16 +689,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.
@@ -1450,6 +1462,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) => {
@@ -5962,7 +5964,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,
@@ -6164,7 +6166,8 @@ function executeModel(props) {
     filtersLogicalOperator = "and",
     spatialDataType = "geo",
     spatialDataColumn = DEFAULT_GEO_COLUMN,
-    spatialFiltersMode = "intersects"
+    spatialFiltersMode = "intersects",
+    tags
   } = source;
   const queryParams = {
     type,
@@ -6173,7 +6176,8 @@ function executeModel(props) {
     params,
     queryParameters: source.queryParameters || "",
     filters,
-    filtersLogicalOperator
+    filtersLogicalOperator,
+    tags
   };
   queryParams.spatialDataType = spatialDataType;
   queryParams.spatialDataColumn = spatialDataColumn;
@@ -6306,7 +6310,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) {
@@ -8083,7 +8088,8 @@ var query = async function(options) {
     localCache,
     connectionName,
     sqlQuery,
-    queryParameters
+    queryParameters,
+    internalParameters
   } = options;
   const urlParameters = { q: sqlQuery };
   if (queryParameters) {
@@ -8094,7 +8100,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,
@@ -8107,7 +8118,8 @@ var query = async function(options) {
     headers,
     errorContext,
     maxLengthURL,
-    localCache
+    localCache,
+    signal: options.signal
   });
 };