@carto/api-client 0.4.7-0 → 0.4.7-alpha.0

package/CHANGELOG.md

@@ -1,9 +1,25 @@
 # CHANGELOG
 
-## Not released
+## 0.5 (Unreleased)
+
+### 0.5.0 (Unreleased)
+
+- BREAKING CHANGE: Replace 'abortController' with 'signal' parameter (#110)
+- feat: Add widget calculations for tileset sources (#50)
+- feat: Add widget calculations for raster sources (#119)
+- feat: Enable Web Workers for local tileset and raster widget calculations (#119)
 
 ## 0.4
 
+### 0.4.7
+
+- fix: Fix clientId customization in table and query widget calls (#120)
+- feat: Add getDataFilterExtensionProps (#105, #113)
+- feat: Add option to override HTTP headers in widget calls (#100, #111)
+- feat: Add filters parameter in widget calls (#103)
+- chore: Update to turf.js v7.2 (#98)
+- chore: Enable compatibility with moduleResolution=nodenext (#106)
+
 ### 0.4.6
 
 - chore: Add repository and homepage in npm package metadata

package/build/api/carto-api-error.d.ts

@@ -0,0 +1,26 @@
+import { MapType } from '../types.js';
+export type APIRequestType = 'Map data' | 'Map instantiation' | 'Public map' | 'Tile stats' | 'SQL' | 'Basemap style';
+export type APIErrorContext = {
+    requestType: APIRequestType;
+    mapId?: string;
+    connection?: string;
+    source?: string;
+    type?: MapType;
+};
+/**
+ *
+ * Custom error for reported errors in CARTO Maps API.
+ * Provides useful debugging information in console and context for applications.
+ *
+ */
+export declare class CartoAPIError extends Error {
+    /** Source error from server */
+    error: Error;
+    /** Context (API call & parameters) in which error occured */
+    errorContext: APIErrorContext;
+    /** Response from server */
+    response?: Response;
+    /** JSON Response from server */
+    responseJson?: any;
+    constructor(error: Error, errorContext: APIErrorContext, response?: Response, responseJson?: any);
+}

package/build/api/endpoints.d.ts

@@ -0,0 +1,24 @@
+import { MapType } from '../types.js';
+export type V3Endpoint = 'maps' | 'stats' | 'sql';
+/** @internal Required by fetchMap(). */
+export declare function buildPublicMapUrl({ apiBaseUrl, cartoMapId, }: {
+    apiBaseUrl: string;
+    cartoMapId: string;
+}): string;
+/** @internal Required by fetchMap(). */
+export declare function buildStatsUrl({ attribute, apiBaseUrl, connectionName, source, type, }: {
+    attribute: string;
+    apiBaseUrl: string;
+    connectionName: string;
+    source: string;
+    type: MapType;
+}): string;
+export declare function buildSourceUrl({ apiBaseUrl, connectionName, endpoint, }: {
+    apiBaseUrl: string;
+    connectionName: string;
+    endpoint: MapType;
+}): string;
+export declare function buildQueryUrl({ apiBaseUrl, connectionName, }: {
+    apiBaseUrl: string;
+    connectionName: string;
+}): string;

package/build/api/index.d.ts

@@ -0,0 +1,5 @@
+export { CartoAPIError, APIErrorContext, APIRequestType, } from './carto-api-error.js';
+export { buildPublicMapUrl, buildStatsUrl } from './endpoints.js';
+export { query } from './query.js';
+export type { QueryOptions } from './query.js';
+export { requestWithParameters } from './request-with-parameters.js';

package/build/api/query.d.ts

@@ -0,0 +1,3 @@
+import type { SourceOptions, QuerySourceOptions, QueryResult } from '../sources/types.js';
+export type QueryOptions = SourceOptions & QuerySourceOptions;
+export declare const query: (options: QueryOptions) => Promise<QueryResult>;

package/build/api/request-with-parameters.d.ts

@@ -0,0 +1,10 @@
+import { APIErrorContext } from './carto-api-error.js';
+import { LocalCacheOptions } from '../sources/types.js';
+export 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;
+}): Promise<T>;