@deck.gl/carto 9.0.0-beta.2 → 9.0.0-beta.4

package/{typed → dist}/api/carto-api-error.d.ts

@@ -1,4 +1,4 @@
-import type { APIErrorContext } from './types';
+import type { APIErrorContext } from "./types.js";
 /**
  *
  * Custom error for reported errors in CARTO Maps API.

package/dist/api/carto-api-error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"carto-api-error.d.ts","sourceRoot":"","sources":["../../src/api/carto-api-error.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,eAAe,EAAC,mBAAgB;AAE7C;;;;;GAKG;AACH,qBAAa,aAAc,SAAQ,KAAK;IACtC,+BAA+B;IAC/B,KAAK,EAAE,KAAK,CAAC;IAEb,6DAA6D;IAC7D,YAAY,EAAE,eAAe,CAAC;IAE9B,2BAA2B;IAC3B,QAAQ,CAAC,EAAE,QAAQ,CAAC;gBAER,KAAK,EAAE,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,QAAQ,CAAC,EAAE,QAAQ;CAiC7E"}

package/dist/api/carto-api-error.js

@@ -0,0 +1,47 @@
+/**
+ *
+ * Custom error for reported errors in CARTO Maps API.
+ * Provides useful debugging information in console and context for applications.
+ *
+ */
+export class CartoAPIError extends Error {
+    constructor(error, errorContext, response) {
+        let responseString = 'Failed to connect';
+        if (response) {
+            responseString = 'Server returned: ';
+            if (response.status === 400) {
+                responseString += 'Bad request';
+            }
+            else if (response.status === 401 || response.status === 403) {
+                responseString += 'Unauthorized access';
+            }
+            else if (response.status === 404) {
+                responseString += 'Not found';
+            }
+            else {
+                responseString += 'Error';
+            }
+            responseString += ` (${response.status}):`;
+        }
+        responseString += ` ${error.message || error}`;
+        let message = `${errorContext.requestType} API request failed`;
+        message += `\n${responseString}`;
+        for (const key of Object.keys(errorContext)) {
+            if (key === 'requestType')
+                continue; // eslint-disable-line no-continue
+            message += `\n${formatErrorKey(key)}: ${errorContext[key]}`;
+        }
+        message += '\n';
+        super(message);
+        this.name = 'CartoAPIError';
+        this.response = response;
+        this.error = error;
+        this.errorContext = errorContext;
+    }
+}
+/**
+ * Converts camelCase to Camel Case
+ */
+function formatErrorKey(key) {
+    return key.replace(/([A-Z])/g, ' $1').replace(/^./, s => s.toUpperCase());
+}

package/dist/{esm/api → api}/common.js

@@ -3,11 +3,10 @@ export const DEFAULT_CLIENT = 'deck-gl-carto';
 export const V3_MINOR_VERSION = '3.3';
 export const MAX_GET_LENGTH = 8192;
 export const DEFAULT_PARAMETERS = {
-  client: DEFAULT_CLIENT,
-  v: V3_MINOR_VERSION
+    client: DEFAULT_CLIENT,
+    v: V3_MINOR_VERSION
 };
 export const DEFAULT_HEADERS = {
-  Accept: 'application/json',
-  'Content-Type': 'application/json'
+    Accept: 'application/json',
+    'Content-Type': 'application/json'
 };
-//# sourceMappingURL=common.js.map

package/{typed → dist}/api/endpoints.d.ts

@@ -1,4 +1,4 @@
-import { MapType } from './types';
+import { MapType } from "./types.js";
 export type V3Endpoint = 'maps' | 'stats' | 'sql';
 export declare function buildPublicMapUrl({ apiBaseUrl, cartoMapId }: {
     apiBaseUrl: string;

package/dist/api/endpoints.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"endpoints.d.ts","sourceRoot":"","sources":["../../src/api/endpoints.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,EAAC,mBAAgB;AAEhC,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC;AAelD,wBAAgB,iBAAiB,CAAC,EAChC,UAAU,EACV,UAAU,EACX,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB,GAAG,MAAM,CAET;AAED,wBAAgB,aAAa,CAAC,EAC5B,SAAS,EACT,UAAU,EACV,cAAc,EACd,MAAM,EACN,IAAI,EACL,EAAE;IACD,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,OAAO,CAAC;CACf,GAAG,MAAM,CAOT;AAED,wBAAgB,cAAc,CAAC,EAC7B,UAAU,EACV,cAAc,EACd,QAAQ,EACT,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,OAAO,CAAC;CACnB,GAAG,MAAM,CAET;AAED,wBAAgB,aAAa,CAAC,EAC5B,UAAU,EACV,cAAc,EACf,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;CACxB,GAAG,MAAM,CAET"}

package/dist/api/endpoints.js

@@ -0,0 +1,22 @@
+function joinPath(...args) {
+    return args.map(part => (part.endsWith('/') ? part.slice(0, -1) : part)).join('/');
+}
+function buildV3Path(apiBaseUrl, version, endpoint, ...rest) {
+    return joinPath(apiBaseUrl, version, endpoint, ...rest);
+}
+export function buildPublicMapUrl({ apiBaseUrl, cartoMapId }) {
+    return buildV3Path(apiBaseUrl, 'v3', 'maps', 'public', cartoMapId);
+}
+export function buildStatsUrl({ attribute, apiBaseUrl, connectionName, source, type }) {
+    if (type === 'query') {
+        return buildV3Path(apiBaseUrl, 'v3', 'stats', connectionName, attribute);
+    }
+    // type === 'table'
+    return buildV3Path(apiBaseUrl, 'v3', 'stats', connectionName, source, attribute);
+}
+export function buildSourceUrl({ apiBaseUrl, connectionName, endpoint }) {
+    return buildV3Path(apiBaseUrl, 'v3', 'maps', connectionName, endpoint);
+}
+export function buildQueryUrl({ apiBaseUrl, connectionName }) {
+    return buildV3Path(apiBaseUrl, 'v3', 'sql', connectionName, 'query');
+}

package/dist/api/fetch-map.js

@@ -0,0 +1,187 @@
+/* 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";
+import { h3QuerySource, h3TableSource, quadbinQuerySource, quadbinTableSource, vectorQuerySource, vectorTableSource, vectorTilesetSource } from "../sources/index.js";
+import { parseMap } from "./parse-map.js";
+import { requestWithParameters } from "./request-with-parameters.js";
+import { assert } from "../utils.js";
+/* global clearInterval, setInterval, URL */
+/* eslint-disable complexity, max-statements */
+async function _fetchMapDataset(dataset, accessToken, apiBaseUrl, clientId, headers) {
+    const { aggregationExp, aggregationResLevel, connectionName, columns, format, geoColumn, source, type, queryParameters } = dataset;
+    const cache = {};
+    const globalOptions = {
+        accessToken,
+        apiBaseUrl,
+        cache,
+        clientId,
+        connectionName,
+        format,
+        headers
+    };
+    if (type === 'tileset') {
+        // TODO do we want a generic tilesetSource?
+        // @ts-ignore
+        dataset.data = await vectorTilesetSource({ ...globalOptions, tableName: source });
+    }
+    else {
+        const [spatialDataType, spatialDataColumn] = geoColumn ? geoColumn.split(':') : ['geom'];
+        if (spatialDataType === 'geom') {
+            const options = { ...globalOptions, spatialDataColumn };
+            if (type === 'table') {
+                dataset.data = await vectorTableSource({ ...options, columns, tableName: source });
+            }
+            else if (type === 'query') {
+                dataset.data = await vectorQuerySource({ ...options, sqlQuery: source, queryParameters });
+            }
+        }
+        else if (spatialDataType === 'h3') {
+            const options = { ...globalOptions, aggregationExp, aggregationResLevel, spatialDataColumn };
+            if (type === 'table') {
+                dataset.data = await h3TableSource({ ...options, columns, tableName: source });
+            }
+            else if (type === 'query') {
+                dataset.data = await h3QuerySource({ ...options, sqlQuery: source, queryParameters });
+            }
+        }
+        else if (spatialDataType === 'quadbin') {
+            const options = { ...globalOptions, aggregationExp, aggregationResLevel, spatialDataColumn };
+            if (type === 'table') {
+                dataset.data = await quadbinTableSource({ ...options, columns, tableName: source });
+            }
+            else if (type === 'query') {
+                dataset.data = await quadbinQuerySource({ ...options, sqlQuery: source, queryParameters });
+            }
+        }
+    }
+    let cacheChanged = true;
+    if (cache.value) {
+        cacheChanged = dataset.cache !== cache.value;
+        dataset.cache = cache.value;
+    }
+    return cacheChanged;
+}
+async function _fetchTilestats(attribute, dataset, accessToken, apiBaseUrl) {
+    const { connectionName, data, id, source, type, queryParameters } = dataset;
+    const errorContext = {
+        requestType: 'Tile stats',
+        connection: connectionName,
+        type,
+        source
+    };
+    if (!('tilestats' in data)) {
+        throw new CartoAPIError(new Error(`Invalid dataset for tilestats: ${id}`), errorContext);
+    }
+    const baseUrl = buildStatsUrl({ attribute, apiBaseUrl, ...dataset });
+    const headers = { Authorization: `Bearer ${accessToken}` };
+    const parameters = {};
+    if (type === 'query') {
+        parameters.q = source;
+        if (queryParameters) {
+            parameters.queryParameters = JSON.stringify(queryParameters);
+        }
+    }
+    const stats = await requestWithParameters({
+        baseUrl,
+        headers,
+        parameters,
+        errorContext
+    });
+    // Replace tilestats for attribute with value from API
+    const { attributes } = data.tilestats.layers[0];
+    const index = attributes.findIndex(d => d.attribute === attribute);
+    attributes[index] = stats;
+    return true;
+}
+async function fillInMapDatasets({ datasets, token }, clientId, apiBaseUrl, headers) {
+    const promises = datasets.map(dataset => _fetchMapDataset(dataset, token, apiBaseUrl, clientId, headers));
+    return await Promise.all(promises);
+}
+async function fillInTileStats({ datasets, keplerMapConfig, token }, apiBaseUrl) {
+    const attributes = [];
+    const { layers } = keplerMapConfig.config.visState;
+    for (const layer of layers) {
+        for (const channel of Object.keys(layer.visualChannels)) {
+            const attribute = layer.visualChannels[channel]?.name;
+            if (attribute) {
+                const dataset = datasets.find(d => d.id === layer.config.dataId);
+                if (dataset && dataset.type !== 'tileset' && dataset.data.tilestats) {
+                    // Only fetch stats for QUERY & TABLE map types
+                    attributes.push({ attribute, dataset });
+                }
+            }
+        }
+    }
+    // Remove duplicates to avoid repeated requests
+    const filteredAttributes = [];
+    for (const a of attributes) {
+        if (!filteredAttributes.find(({ attribute, dataset }) => attribute === a.attribute && dataset === a.dataset)) {
+            filteredAttributes.push(a);
+        }
+    }
+    const promises = filteredAttributes.map(({ attribute, dataset }) => _fetchTilestats(attribute, dataset, 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 }) {
+    assert(cartoMapId, 'Must define CARTO map id: fetchMap({cartoMapId: "XXXX-XXXX-XXXX"})');
+    assert(apiBaseUrl, 'Must define apiBaseUrl');
+    if (autoRefresh || onNewData) {
+        assert(onNewData, 'Must define `onNewData` when using autoRefresh');
+        assert(typeof onNewData === 'function', '`onNewData` must be a function');
+        assert(typeof autoRefresh === 'number' && autoRefresh > 0, '`autoRefresh` must be a positive number');
+    }
+    const baseUrl = buildPublicMapUrl({ apiBaseUrl, cartoMapId });
+    const errorContext = { requestType: 'Public map', mapId: cartoMapId };
+    const map = await requestWithParameters({ baseUrl, headers, errorContext });
+    // Periodically check if the data has changed. Note that this
+    // will not update when a map is published.
+    let stopAutoRefresh;
+    if (autoRefresh) {
+        // eslint-disable-next-line @typescript-eslint/no-misused-promises
+        const intervalId = setInterval(async () => {
+            const changed = await fillInMapDatasets(map, clientId, apiBaseUrl, {
+                ...headers,
+                'If-Modified-Since': new Date().toUTCString()
+            });
+            if (onNewData && changed.some(v => v === true)) {
+                onNewData(parseMap(map));
+            }
+        }, autoRefresh * 1000);
+        stopAutoRefresh = () => {
+            clearInterval(intervalId);
+        };
+    }
+    const geojsonLayers = map.keplerMapConfig.config.visState.layers.filter(({ type }) => type === 'geojson' || type === 'point');
+    const geojsonDatasetIds = geojsonLayers.map(({ config }) => config.dataId);
+    map.datasets.forEach(dataset => {
+        if (geojsonDatasetIds.includes(dataset.id)) {
+            const { config } = geojsonLayers.find(({ config }) => config.dataId === dataset.id);
+            dataset.format = 'geojson';
+            // Support for very old maps. geoColumn was not stored in the past
+            if (!dataset.geoColumn && config.columns.geojson) {
+                dataset.geoColumn = config.columns.geojson;
+            }
+        }
+    });
+    // Mutates map.datasets so that dataset.data contains data
+    await fillInMapDatasets(map, clientId, apiBaseUrl, headers);
+    // Mutates attributes in visualChannels to contain tile stats
+    await fillInTileStats(map, apiBaseUrl);
+    const out = { ...parseMap(map), ...{ stopAutoRefresh } };
+    const textLayers = out.layers.filter(layer => {
+        const pointType = layer.props.pointType || '';
+        return pointType.includes('text');
+    });
+    /* global FontFace, window, document */
+    if (textLayers.length && window.FontFace && !document.fonts.check('12px Inter')) {
+        // Fetch font needed for labels
+        const font = new FontFace('Inter', 'url(https://fonts.gstatic.com/s/inter/v12/UcC73FwrK3iLTeHuS_fvQtMwCp50KnMa1ZL7W0Q5nw.woff2)');
+        await font.load().then(f => document.fonts.add(f));
+    }
+    return out;
+}

package/dist/api/index.d.ts

@@ -0,0 +1,7 @@
+export { CartoAPIError } from "./carto-api-error.js";
+export { fetchMap } from "./fetch-map.js";
+export type { FetchMapOptions } from "./fetch-map.js";
+export type { APIErrorContext, Format, MapType, RequestType, QueryParameters } from "./types.js";
+export { query } from "./query.js";
+export type { QueryOptions } from "./query.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/api/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAC,6BAA0B;AAChD,OAAO,EAAC,QAAQ,EAAC,uBAAoB;AACrC,YAAY,EAAC,eAAe,EAAC,uBAAoB;AACjD,YAAY,EAAC,eAAe,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,eAAe,EAAC,mBAAgB;AAC5F,OAAO,EAAC,KAAK,EAAC,mBAAgB;AAC9B,YAAY,EAAC,YAAY,EAAC,mBAAgB"}

package/dist/api/index.js

@@ -0,0 +1,3 @@
+export { CartoAPIError } from "./carto-api-error.js";
+export { fetchMap } from "./fetch-map.js";
+export { query } from "./query.js";

package/{typed → dist}/api/layer-map.d.ts

@@ -1,11 +1,11 @@
 import { scaleLinear, scaleOrdinal, scaleLog, scalePoint, scaleQuantile, scaleQuantize, scaleSqrt, scaleThreshold } from 'd3-scale';
 import { Accessor, Layer, _ConstructorOf as ConstructorOf } from '@deck.gl/core';
-import H3TileLayer from '../layers/h3-tile-layer';
-import QuadbinTileLayer from '../layers/quadbin-tile-layer';
-import VectorTileLayer from '../layers/vector-tile-layer';
-import { MapType } from './types';
-import { scaleIdentity } from '../utils';
-import { CustomMarkersRange, MapDataset, MapTextSubLayerConfig, VisConfig, VisualChannelField, VisualChannels } from './types';
+import H3TileLayer from "../layers/h3-tile-layer.js";
+import QuadbinTileLayer from "../layers/quadbin-tile-layer.js";
+import VectorTileLayer from "../layers/vector-tile-layer.js";
+import { MapType } from "./types.js";
+import { scaleIdentity } from "../utils.js";
+import { CustomMarkersRange, MapDataset, MapTextSubLayerConfig, VisConfig, VisualChannelField, VisualChannels } from "./types.js";
 declare const SCALE_FUNCS: {
     linear: typeof scaleLinear;
     ordinal: typeof scaleOrdinal;

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

@@ -0,0 +1 @@
+{"version":3,"file":"layer-map.d.ts","sourceRoot":"","sources":["../../src/api/layer-map.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,WAAW,EACX,YAAY,EACZ,QAAQ,EACR,UAAU,EACV,aAAa,EACb,aAAa,EACb,SAAS,EACT,cAAc,EACf,MAAM,UAAU,CAAC;AAIlB,OAAO,EAAC,QAAQ,EAAE,KAAK,EAAE,cAAc,IAAI,aAAa,EAAC,MAAM,eAAe,CAAC;AAK/E,OAAO,WAAW,mCAAgC;AAClD,OAAO,gBAAgB,wCAAqC;AAE5D,OAAO,eAAe,uCAAoC;AAC1D,OAAO,EAAC,OAAO,EAAC,mBAAgB;AAChC,OAAO,EAA4B,aAAa,EAAC,oBAAiB;AAClE,OAAO,EACL,kBAAkB,EAClB,UAAU,EACV,qBAAqB,EACrB,SAAS,EACT,kBAAkB,EAClB,cAAc,EACf,mBAAgB;AAEjB,QAAA,MAAM,WAAW;;;;;;;;;;CAUhB,CAAC;AACF,MAAM,MAAM,UAAU,GAAG,MAAM,OAAO,WAAW,CAAC;AAQlD,eAAO,MAAM,WAAW;;;;;CAKvB,CAAC;AAEF,eAAO,MAAM,WAAW;;;;CAIvB,CAAC;AAuEF,wBAAgB,QAAQ,CACtB,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,qBAAqB,EAC7B,OAAO,EAAE,UAAU,GAClB;IAAC,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;IAAC,OAAO,EAAE,GAAG,CAAC;IAAC,YAAY,EAAE,GAAG,CAAA;CAAC,CA6DhE;AAED,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,MAAM,EACd,IAAI,CAAC,EAAE,OAAO,GACb,OAAO,eAAe,GAAG,OAAO,WAAW,GAAG,OAAO,gBAAgB,CAYvE;AAuCD,iBAAS,gBAAgB,CAAC,MAAM,KAAA,EAAE,SAAS,EAAE,UAAU,OActD;AAoCD,wBAAgB,cAAc,CAAC,OAAO,CAAC,EAAE,MAAM,UAE9C;AAqBD,wBAAgB,qBAAqB,CAAC,EAAC,IAAI,EAAC;;CAAA,EAAE,gBAAgB,KAAA,EAAE,IAAI,EAAE,GAAG,OAIxE;AAED,wBAAgB,gBAAgB,CAC9B,EAAC,IAAI,EAAE,WAAW,EAAC,EAAE,kBAAkB,EACvC,SAAS,EAAE,UAAU,EACrB,EAAC,WAAW,EAAE,KAAK,EAAC;;;CAAA,EACpB,OAAO,EAAE,MAAM,GAAG,SAAS,EAC3B,IAAI,EAAE,GAAG,OAeV;AAmCD,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,kBAAkB,GAAG,IAAI,GAAG,SAAS,EAC5C,KAAK,EAAE,kBAAkB,GAAG,IAAI,GAAG,SAAS,EAC5C,EAAC,WAAW,EAAE,WAAW,EAAE,cAAc,EAAC;;;;CAAA,EAC1C,IAAI,EAAE,GAAG,OAgCV;AAED,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,SAAS,EAAE,cAAc,EAAE,cAAc,GAAG,MAAM,CAK7F;AAED,wBAAgB,cAAc,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC,CAEpF;AAED,wBAAgB,eAAe,CAC7B,EAAC,IAAI,EAAC;;CAAA,EACN,SAAS,EAAE,UAAU,GAAG,SAAS,EACjC,WAAW,KAAA,EACX,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,GAAG,SAAS,EAClC,IAAI,EAAE,GAAG,OAmBV;AAUD,wBAAgB,eAAe,CAAC,EAAC,IAAI,EAAE,IAAI,EAAC,EAAE,kBAAkB,EAAE,IAAI,KAAA,OAMrE;AAED,OAAO,EAAC,gBAAgB,IAAI,iBAAiB,EAAC,CAAC"}