@deck.gl/carto 9.0.28 → 9.0.29

package/dist/api/fetch-map.d.ts

@@ -1,11 +1,34 @@
 import { ParseMapResult } from "./parse-map.js";
 import type { Basemap } from "./types.js";
 export type FetchMapOptions = {
+    /**
+     * CARTO platform access token. Only required for private maps.
+     */
+    accessToken?: string;
+    /**
+     * Base URL of the CARTO Maps API.
+     *
+     * Example for account located in EU-west region: `https://gcp-eu-west1.api.carto.com`
+     *
+     * @default https://gcp-us-east1.api.carto.com
+     */
     apiBaseUrl?: string;
+    /**
+     * Identifier of map created in CARTO Builder.
+     */
     cartoMapId: string;
     clientId?: string;
+    /**
+     * Custom HTTP headers added to map instantiation and data requests.
+     */
     headers?: Record<string, string>;
+    /**
+     * Interval in seconds at which to autoRefresh the data. If provided, `onNewData` must also be provided.
+     */
     autoRefresh?: number;
+    /**
+     * Callback function that will be invoked whenever data in layers is changed. If provided, `autoRefresh` must also be provided.
+     */
     onNewData?: (map: any) => void;
 };
 export type FetchMapResult = ParseMapResult & {
@@ -15,5 +38,5 @@ export type FetchMapResult = ParseMapResult & {
     basemap: Basemap | null;
     stopAutoRefresh?: () => void;
 };
-export declare function fetchMap({ apiBaseUrl, cartoMapId, clientId, headers, autoRefresh, onNewData }: FetchMapOptions): Promise<FetchMapResult>;
+export declare function fetchMap({ accessToken, apiBaseUrl, cartoMapId, clientId, headers, autoRefresh, onNewData }: FetchMapOptions): Promise<FetchMapResult>;
 //# sourceMappingURL=fetch-map.d.ts.map

package/dist/api/fetch-map.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fetch-map.d.ts","sourceRoot":"","sources":["../../src/api/fetch-map.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAC,cAAc,EAAW,uBAAoB;AAGrD,OAAO,KAAK,EAAkB,OAAO,EAAmC,mBAAgB;AAyLxF,MAAM,MAAM,eAAe,GAAG;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,cAAc,GAAG;IAC5C;;OAEG;IACH,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IACxB,eAAe,CAAC,EAAE,MAAM,IAAI,CAAC;CAC9B,CAAC;AAGF,wBAAsB,QAAQ,CAAC,EAC7B,UAAiC,EACjC,UAAU,EACV,QAAyB,EACzB,OAAY,EACZ,WAAW,EACX,SAAS,EACV,EAAE,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC,CA+E3C"}
+{"version":3,"file":"fetch-map.d.ts","sourceRoot":"","sources":["../../src/api/fetch-map.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAC,cAAc,EAAW,uBAAoB;AAGrD,OAAO,KAAK,EAAkB,OAAO,EAAmC,mBAAgB;AAyLxF,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEjC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,cAAc,GAAG;IAC5C;;OAEG;IACH,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IACxB,eAAe,CAAC,EAAE,MAAM,IAAI,CAAC;CAC9B,CAAC;AAGF,wBAAsB,QAAQ,CAAC,EAC7B,WAAW,EACX,UAAiC,EACjC,UAAU,EACV,QAAyB,EACzB,OAAY,EACZ,WAAW,EACX,SAAS,EACV,EAAE,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC,CAmF3C"}

package/dist/api/fetch-map.js

@@ -1,7 +1,4 @@
 /* eslint-disable camelcase */
-/**
- * Maps API Client for Carto 3
- */
 import { CartoAPIError } from "./carto-api-error.js";
 import { DEFAULT_API_BASE_URL, DEFAULT_CLIENT } from "./common.js";
 import { buildPublicMapUrl, buildStatsUrl } from "./endpoints.js";
@@ -137,9 +134,12 @@ async function fillInTileStats({ datasets, keplerMapConfig, token }, apiBaseUrl)
     return await Promise.all(promises);
 }
 /* eslint-disable max-statements */
-export async function fetchMap({ apiBaseUrl = DEFAULT_API_BASE_URL, cartoMapId, clientId = DEFAULT_CLIENT, headers = {}, autoRefresh, onNewData }) {
+export async function fetchMap({ accessToken, apiBaseUrl = DEFAULT_API_BASE_URL, cartoMapId, clientId = DEFAULT_CLIENT, headers = {}, autoRefresh, onNewData }) {
     assert(cartoMapId, 'Must define CARTO map id: fetchMap({cartoMapId: "XXXX-XXXX-XXXX"})');
     assert(apiBaseUrl, 'Must define apiBaseUrl');
+    if (accessToken) {
+        headers = { Authorization: `Bearer ${accessToken}`, ...headers };
+    }
     if (autoRefresh || onNewData) {
         assert(onNewData, 'Must define `onNewData` when using autoRefresh');
         assert(typeof onNewData === 'function', '`onNewData` must be a function');

package/dist/cartoRasterTile-worker.js

@@ -1008,7 +1008,7 @@
   }
 
   // src/layers/schema/carto-raster-tile-loader.ts
-  var VERSION = true ? "9.0.28" : "latest";
+  var VERSION = true ? "9.0.29" : "latest";
   var id = "cartoRasterTile";
   var DEFAULT_OPTIONS = {
     cartoRasterTile: {

package/dist/cartoSpatialTile-worker.js

@@ -1397,7 +1397,7 @@
   }
 
   // src/layers/schema/carto-spatial-tile-loader.ts
-  var VERSION = true ? "9.0.28" : "latest";
+  var VERSION = true ? "9.0.29" : "latest";
   var id = "cartoSpatialTile";
   var DEFAULT_OPTIONS = {
     cartoSpatialTile: {

package/dist/cartoVectorTile-worker.js

@@ -1625,7 +1625,7 @@
   }
 
   // src/layers/schema/carto-vector-tile-loader.ts
-  var VERSION = true ? "9.0.28" : "latest";
+  var VERSION = true ? "9.0.29" : "latest";
   var id = "cartoVectorTile";
   var DEFAULT_OPTIONS = {
     cartoVectorTile: {

package/dist/dist.dev.js

@@ -14212,6 +14212,7 @@ ${formatErrorKey(key)}: ${errorContext[key]}`;
     return await Promise.all(promises);
   }
   async function fetchMap({
+    accessToken,
     apiBaseUrl = DEFAULT_API_BASE_URL,
     cartoMapId,
     clientId = DEFAULT_CLIENT,
@@ -14221,6 +14222,9 @@ ${formatErrorKey(key)}: ${errorContext[key]}`;
   }) {
     assert2(cartoMapId, 'Must define CARTO map id: fetchMap({cartoMapId: "XXXX-XXXX-XXXX"})');
     assert2(apiBaseUrl, "Must define apiBaseUrl");
+    if (accessToken) {
+      headers = { Authorization: `Bearer ${accessToken}`, ...headers };
+    }
     if (autoRefresh || onNewData) {
       assert2(onNewData, "Must define `onNewData` when using autoRefresh");
       assert2(typeof onNewData === "function", "`onNewData` must be a function");

package/dist/index.cjs

@@ -548,7 +548,7 @@ function binaryToSpatialjson(binary) {
 }
 
 // dist/layers/schema/carto-spatial-tile-loader.js
-var VERSION = true ? "9.0.28" : "latest";
+var VERSION = true ? "9.0.29" : "latest";
 var id = "cartoSpatialTile";
 var DEFAULT_OPTIONS = {
   cartoSpatialTile: {
@@ -912,7 +912,7 @@ var TileReader3 = class {
 };
 
 // dist/layers/schema/carto-raster-tile-loader.js
-var VERSION2 = true ? "9.0.28" : "latest";
+var VERSION2 = true ? "9.0.29" : "latest";
 var id2 = "cartoRasterTile";
 var DEFAULT_OPTIONS2 = {
   cartoRasterTile: {
@@ -1994,7 +1994,7 @@ var carto_properties_tile_loader_default = CartoPropertiesTileLoader;
 
 // dist/layers/schema/carto-vector-tile-loader.js
 var import_earcut = __toESM(require("earcut"), 1);
-var VERSION3 = true ? "9.0.28" : "latest";
+var VERSION3 = true ? "9.0.29" : "latest";
 var id3 = "cartoVectorTile";
 var DEFAULT_OPTIONS3 = {
   cartoVectorTile: {
@@ -3526,9 +3526,12 @@ async function fillInTileStats({ datasets, keplerMapConfig, token }, apiBaseUrl)
   const promises = filteredAttributes.map(({ attribute, dataset }) => _fetchTilestats(attribute, dataset, token, apiBaseUrl));
   return await Promise.all(promises);
 }
-async function fetchMap({ apiBaseUrl = DEFAULT_API_BASE_URL, cartoMapId, clientId = DEFAULT_CLIENT, headers = {}, autoRefresh, onNewData }) {
+async function fetchMap({ accessToken, apiBaseUrl = DEFAULT_API_BASE_URL, cartoMapId, clientId = DEFAULT_CLIENT, headers = {}, autoRefresh, onNewData }) {
   assert(cartoMapId, 'Must define CARTO map id: fetchMap({cartoMapId: "XXXX-XXXX-XXXX"})');
   assert(apiBaseUrl, "Must define apiBaseUrl");
+  if (accessToken) {
+    headers = { Authorization: `Bearer ${accessToken}`, ...headers };
+  }
   if (autoRefresh || onNewData) {
     assert(onNewData, "Must define `onNewData` when using autoRefresh");
     assert(typeof onNewData === "function", "`onNewData` must be a function");