@deck.gl/carto 8.8.6 → 8.8.9

package/package.json

@@ -2,7 +2,7 @@
   "name": "@deck.gl/carto",
   "description": "CARTO official integration with Deck.gl. Build geospatial applications using CARTO and Deck.gl.",
   "license": "MIT",
-  "version": "8.8.6",
+  "version": "8.8.9",
   "publishConfig": {
     "access": "public"
   },
@@ -61,5 +61,5 @@
     "@deck.gl/layers": "^8.0.0",
     "@loaders.gl/core": "^3.0.0"
   },
-  "gitHead": "a0e9fda8ed34ad91a6b25451c8df290ae025028f"
+  "gitHead": "1cceaed3dad056c3fb51864e7f56585271ed1e5a"
 }

package/src/api/maps-v3-client.ts

@@ -29,9 +29,11 @@ import {assert} from '../utils';
 const MAX_GET_LENGTH = 2048;
 const DEFAULT_CLIENT = 'deck-gl-carto';
 
+export type Headers = Record<string, string>;
 interface RequestParams {
   method?: string;
   url: string;
+  headers?: Headers;
   accessToken?: string;
   body?: any;
 }
@@ -39,8 +41,15 @@ interface RequestParams {
 /**
  * Request against Maps API
  */
-async function request({method, url, accessToken, body}: RequestParams): Promise<Response> {
-  const headers: Record<string, string> = {
+async function request({
+  method,
+  url,
+  headers: customHeaders,
+  accessToken,
+  body
+}: RequestParams): Promise<Response> {
+  const headers: Headers = {
+    ...customHeaders,
     Accept: 'application/json'
   };
 
@@ -67,10 +76,11 @@ async function request({method, url, accessToken, body}: RequestParams): Promise
 async function requestJson<T = unknown>({
   method,
   url,
+  headers,
   accessToken,
   body
 }: RequestParams): Promise<T> {
-  const response = await request({method, url, accessToken, body});
+  const response = await request({method, url, headers, accessToken, body});
   const json = await response.json();
 
   if (!response.ok) {
@@ -121,6 +131,7 @@ type FetchLayerDataParams = {
   clientId?: string;
   format?: Format;
   formatTiles?: TileFormat;
+  headers?: Headers;
   aggregationExp?: string;
   aggregationResLevel?: number;
   queryParameters?: QueryParameters;
@@ -180,6 +191,7 @@ export async function mapInstantiation({
   geoColumn,
   columns,
   clientId,
+  headers,
   aggregationExp,
   aggregationResLevel,
   queryParameters
@@ -204,10 +216,10 @@ export async function mapInstantiation({
       client: clientId || DEFAULT_CLIENT,
       queryParameters
     });
-    return await requestJson({method: 'POST', url: baseUrl, accessToken, body});
+    return await requestJson({method: 'POST', url: baseUrl, headers, accessToken, body});
   }
 
-  return await requestJson({url, accessToken});
+  return await requestJson({url, headers, accessToken});
 }
 
 function getUrlFromMetadata(metadata: MapInstantiation, format: Format): string | null {
@@ -277,6 +289,7 @@ export async function fetchLayerData({
   format,
   formatTiles,
   clientId,
+  headers,
   aggregationExp,
   aggregationResLevel,
   queryParameters
@@ -293,6 +306,7 @@ export async function fetchLayerData({
     format,
     formatTiles,
     clientId,
+    headers,
     aggregationExp,
     aggregationResLevel,
     queryParameters
@@ -313,6 +327,7 @@ async function _fetchDataUrl({
   format,
   formatTiles,
   clientId,
+  headers,
   aggregationExp,
   aggregationResLevel,
   queryParameters
@@ -347,6 +362,7 @@ async function _fetchDataUrl({
     geoColumn,
     columns,
     clientId,
+    headers,
     aggregationExp,
     aggregationResLevel,
     queryParameters
@@ -389,6 +405,7 @@ async function _fetchMapDataset(
   accessToken: string,
   credentials: CloudNativeCredentials,
   clientId?: string,
+  headers?: Headers,
   queryParameters?: QueryParameters
 ) {
   const {
@@ -411,6 +428,7 @@ async function _fetchMapDataset(
     columns,
     format,
     geoColumn,
+    headers,
     source,
     type,
     queryParameters
@@ -457,9 +475,12 @@ async function _fetchTilestats(
 async function fillInMapDatasets(
   {datasets, token},
   clientId: string,
-  credentials: CloudNativeCredentials
+  credentials: CloudNativeCredentials,
+  headers?: Headers
 ) {
-  const promises = datasets.map(dataset => _fetchMapDataset(dataset, token, credentials, clientId));
+  const promises = datasets.map(dataset =>
+    _fetchMapDataset(dataset, token, credentials, clientId, headers)
+  );
   return await Promise.all(promises);
 }
 
@@ -503,12 +524,14 @@ export async function fetchMap({
   cartoMapId,
   clientId,
   credentials,
+  headers,
   autoRefresh,
   onNewData
 }: {
   cartoMapId: string;
   clientId: string;
   credentials?: CloudNativeCredentials;
+  headers?: Headers;
   autoRefresh?: number;
   onNewData?: (map: any) => void;
 }) {
@@ -537,7 +560,7 @@ export async function fetchMap({
   }
 
   const url = `${localCreds.mapsUrl}/public/${cartoMapId}`;
-  const map = await requestJson<any>({url, accessToken});
+  const map = await requestJson<any>({url, headers, accessToken});
 
   // Periodically check if the data has changed. Note that this
   // will not update when a map is published.
@@ -545,7 +568,7 @@ export async function fetchMap({
   if (autoRefresh) {
     // eslint-disable-next-line @typescript-eslint/no-misused-promises
     const intervalId = setInterval(async () => {
-      const changed = await fillInMapDatasets(map, clientId, localCreds);
+      const changed = await fillInMapDatasets(map, clientId, localCreds, headers);
       if (onNewData && changed.some(v => v === true)) {
         onNewData(parseMap(map));
       }
@@ -566,7 +589,7 @@ export async function fetchMap({
   });
 
   // Mutates map.datasets so that dataset.data contains data
-  await fillInMapDatasets(map, clientId, localCreds);
+  await fillInMapDatasets(map, clientId, localCreds, headers);
 
   // Mutates attributes in visualChannels to contain tile stats
   await fillInTileStats(map, localCreds);

package/src/layers/carto-layer.ts

@@ -25,7 +25,7 @@ import {
   Credentials,
   getDefaultCredentials
 } from '../config';
-import {FetchLayerDataResult} from '../api/maps-v3-client';
+import {FetchLayerDataResult, Headers} from '../api/maps-v3-client';
 import {assert} from '../utils';
 
 const defaultProps = {
@@ -61,6 +61,9 @@ const defaultProps = {
   // (Array<String>, optional): names of columns to fetch. By default, all columns are fetched.
   columns: {type: 'array', value: null},
 
+  // (Headers, optional): Custom headers to include in the map instantiation request.
+  headers: {type: 'object', value: {}, optional: true},
+
   // (String, optional): aggregation SQL expression. Only used for spatial index datasets
   aggregationExp: null,
 
@@ -148,6 +151,9 @@ type _CartoLayerProps = {
 
   clientId?: string;
 
+  /** Custom headers to include in the map instantiation request **/
+  headers?: Headers;
+
   /** Aggregation SQL expression. Only used for spatial index datasets **/
   aggregationExp?: string;
 

package/src/layers/carto-tile-layer.ts

@@ -12,7 +12,7 @@ import {
 } from '@deck.gl/geo-layers';
 import {GeoJsonLayer} from '@deck.gl/layers';
 import {geojsonToBinary} from '@loaders.gl/gis';
-import {Properties, Tile, TileReader} from './schema/carto-tile';
+import {KeyValueProperties, Tile, TileReader} from './schema/carto-tile';
 import {TileFormat, TILE_FORMATS} from '../api/maps-api-common';
 import {LoaderOptions, LoaderWithParser} from '@loaders.gl/loader-utils';
 import type {BinaryFeatures} from '@loaders.gl/schema';
@@ -28,7 +28,7 @@ function parsePbf(buffer: ArrayBuffer): Tile {
   return tile;
 }
 
-function unpackProperties(properties: Properties[]) {
+function unpackProperties(properties: KeyValueProperties[]) {
   if (!properties || !properties.length) {
     return [];
   }
@@ -67,7 +67,10 @@ const CartoTileLoader: LoaderWithParser = {
   id: 'cartoTile',
   module: 'carto',
   extensions: ['pbf'],
-  mimeTypes: ['application/x-protobuf'],
+  mimeTypes: [
+    'application/vnd.carto-vector-tile',
+    'application/x-protobuf' // Back-compatibility
+  ],
   category: 'geometry',
   worker: false,
   parse: async (arrayBuffer, options) => parseCartoTile(arrayBuffer, options),

package/src/layers/quadbin-utils.ts

@@ -12,11 +12,11 @@ const B = [
 ];
 const S = [0n, 1n, 2n, 4n, 8n, 16n];
 
-function indexToBigInt(index: string): bigint {
+export function indexToBigInt(index: string): bigint {
   return BigInt(`0x${index}`);
 }
 
-function bigIntToIndex(quadbin: bigint): string {
+export function bigIntToIndex(quadbin: bigint): string {
   return quadbin.toString(16);
 }
 

package/src/layers/schema/carto-spatial-tile-loader.ts

@@ -0,0 +1,59 @@
+import Protobuf from 'pbf';
+import {LoaderOptions, LoaderWithParser} from '@loaders.gl/loader-utils';
+
+import {KeyValueProperties} from './carto-tile';
+import {binaryToSpatialjson, Properties, SpatialJson} from './spatialjson-utils';
+import {Tile, TileReader} from './carto-spatial-tile';
+
+const CartoSpatialTileLoader: LoaderWithParser = {
+  name: 'CARTO Spatial Tile',
+  version: '1',
+  id: 'cartoSpatialTile',
+  module: 'carto',
+  extensions: ['pbf'],
+  mimeTypes: [
+    'application/vnd.carto-spatial-tile',
+    'application/x-protobuf' // Back-compatibility
+  ],
+  category: 'geometry',
+  worker: false,
+  parse: async (arrayBuffer, options) => parseCartoSpatialTile(arrayBuffer, options),
+  parseSync: parseCartoSpatialTile,
+  options: {}
+};
+
+function parsePbf(buffer: ArrayBuffer): Tile {
+  const pbf = new Protobuf(buffer);
+  const tile = TileReader.read(pbf);
+  return tile;
+}
+
+function unpackProperties(properties: KeyValueProperties[]): Properties[] {
+  if (!properties || !properties.length) {
+    return [];
+  }
+  return properties.map(item => {
+    const currentRecord: Properties = {};
+    item.data.forEach(({key, value}) => {
+      currentRecord[key] = value;
+    });
+    return currentRecord;
+  });
+}
+
+function parseCartoSpatialTile(
+  arrayBuffer: ArrayBuffer,
+  options?: LoaderOptions
+): SpatialJson | null {
+  if (!arrayBuffer) return null;
+  const tile = parsePbf(arrayBuffer);
+
+  const {cells} = tile;
+  const data = {
+    cells: {...cells, properties: unpackProperties(cells.properties)}
+  };
+
+  return binaryToSpatialjson(data);
+}
+
+export default CartoSpatialTileLoader;

package/src/layers/schema/carto-spatial-tile.ts

@@ -0,0 +1,83 @@
+import {Indices, IndexScheme} from './spatialjson-utils';
+import {
+  KeyValueProperties,
+  NumericProp,
+  NumericPropKeyValueReader,
+  PropertiesReader
+} from './carto-tile';
+
+// Indices =====================================
+
+export class IndicesReader {
+  static read(pbf, end?: number): Indices {
+    const {value} = pbf.readFields(IndicesReader._readField, {value: []}, end);
+    return {value: new BigUint64Array(value)};
+  }
+  static _readField(this: void, tag: number, obj, pbf) {
+    if (tag === 1) readPackedFixed64(pbf, obj.value);
+  }
+}
+
+// Cells =========================================
+
+interface Cells {
+  indices: Indices;
+  properties: KeyValueProperties[];
+  numericProps: Record<string, NumericProp>;
+}
+
+class CellsReader {
+  static read(pbf, end?: number): Cells {
+    return pbf.readFields(
+      CellsReader._readField,
+      {indices: null, properties: [], numericProps: {}},
+      end
+    );
+  }
+  static _readField(this: void, tag: number, obj: Cells, pbf) {
+    if (tag === 1) obj.indices = IndicesReader.read(pbf, pbf.readVarint() + pbf.pos);
+    else if (tag === 2) obj.properties.push(PropertiesReader.read(pbf, pbf.readVarint() + pbf.pos));
+    else if (tag === 3) {
+      const entry = NumericPropKeyValueReader.read(pbf, pbf.readVarint() + pbf.pos);
+      obj.numericProps[entry.key] = entry.value;
+    }
+  }
+}
+
+// Tile ========================================
+
+// TODO this type is very similar to SpatialBinary, should align
+export interface Tile {
+  scheme: IndexScheme;
+  cells: Cells;
+}
+
+export class TileReader {
+  static read(pbf, end?: number): Tile {
+    return pbf.readFields(TileReader._readField, {scheme: 0, cells: null}, end);
+  }
+  static _readField(this: void, tag: number, obj: Tile, pbf) {
+    if (tag === 1) obj.scheme = pbf.readVarint();
+    else if (tag === 2) obj.cells = CellsReader.read(pbf, pbf.readVarint() + pbf.pos);
+  }
+}
+
+// pbf doesn't support BigInt natively, implement support for packed fixed64 type
+const SHIFT_LEFT_32 = BigInt((1 << 16) * (1 << 16));
+
+function readPackedEnd(pbf) {
+  return pbf.type === 2 ? pbf.readVarint() + pbf.pos : pbf.pos + 1;
+}
+function readFixed64(pbf) {
+  const a = BigInt(pbf.readFixed32());
+  const b = BigInt(pbf.readFixed32());
+  return a + b * SHIFT_LEFT_32;
+}
+
+function readPackedFixed64(pbf, arr) {
+  if (pbf.type !== 2) return arr.push(readFixed64(pbf));
+  const end = readPackedEnd(pbf);
+  arr = arr || [];
+  while (pbf.pos < end) arr.push(readFixed64(pbf));
+  return arr;
+}

package/src/layers/schema/carto-tile.ts

@@ -16,15 +16,15 @@ class KeyValueObjectReader {
 
 // Properties ========================================
 
-export interface Properties {
+export interface KeyValueProperties {
   data: KeyValueObject[];
 }
 
-class PropertiesReader {
+export class PropertiesReader {
   static read(pbf, end?: number) {
     return pbf.readFields(PropertiesReader._readField, {data: []}, end);
   }
-  static _readField(this: void, tag: number, obj: Properties, pbf) {
+  static _readField(this: void, tag: number, obj: KeyValueProperties, pbf) {
     if (tag === 1) obj.data.push(KeyValueObjectReader.read(pbf, pbf.readVarint() + pbf.pos));
   }
 }
@@ -69,7 +69,7 @@ class IntsReader {
 
 // NumericProp ========================================
 
-interface NumericProp {
+export interface NumericProp {
   value: number[];
 }
 
@@ -88,7 +88,7 @@ interface NumbericPropKeyValue {
   value: NumericProp;
 }
 
-class NumericPropKeyValueReader {
+export class NumericPropKeyValueReader {
   static read(pbf, end?: number): NumbericPropKeyValue {
     return pbf.readFields(NumericPropKeyValueReader._readField, {key: '', value: null}, end);
   }
@@ -104,7 +104,7 @@ interface Points {
   positions: Doubles;
   globalFeatureIds: Ints;
   featureIds: Ints;
-  properties: Properties[];
+  properties: KeyValueProperties[];
   numericProps: Record<string, NumericProp>;
 }
 

package/src/layers/schema/spatialjson-utils.ts

@@ -0,0 +1,35 @@
+import {bigIntToIndex} from '../quadbin-utils';
+
+export type IndexScheme = 'h3' | 'quadbin';
+type TypedArray = Float32Array | Float64Array;
+
+export type Indices = {value: BigUint64Array};
+export type NumericProps = Record<string, {value: number[] | TypedArray}>;
+export type Properties = Record<string, string | number | boolean | null>;
+export type Cells = {
+  indices: Indices;
+  numericProps: NumericProps;
+  properties: Properties[];
+};
+export type SpatialBinary = {scheme?: IndexScheme; cells: Cells};
+export type SpatialJson = {
+  id: string;
+  properties: Properties;
+}[];
+
+export function binaryToSpatialjson(binary: SpatialBinary): SpatialJson {
+  const {cells} = binary;
+  const count = cells.indices.value.length;
+  const spatial: any[] = [];
+  for (let i = 0; i < count; i++) {
+    const id = bigIntToIndex(cells.indices.value[i]);
+
+    const properties = {...cells.properties[i]};
+    for (const key of Object.keys(cells.numericProps)) {
+      properties[key] = cells.numericProps[key].value[i];
+    }
+    spatial.push({id, properties});
+  }
+
+  return spatial;
+}

package/src/layers/spatial-index-tile-layer.ts

@@ -1,3 +1,7 @@
+import {registerLoaders} from '@loaders.gl/core';
+import CartoSpatialTileLoader from './schema/carto-spatial-tile-loader';
+registerLoaders([CartoSpatialTileLoader]);
+
 import {PickingInfo} from '@deck.gl/core';
 import {TileLayer, _Tile2DHeader as Tile2DHeader} from '@deck.gl/geo-layers';
 

package/typed/api/index.js

@@ -0,0 +1,3 @@
+export { FORMATS, TILE_FORMATS, MAP_TYPES, API_VERSIONS } from './maps-api-common';
+export { getDataV2, CONNECTIONS } from './maps-client';
+export { fetchLayerData, fetchMap, getData, mapInstantiation } from './maps-v3-client';