@deck.gl/carto 9.0.35 → 9.1.0-beta.1

package/dist/sources/vector-table-source.js

@@ -1,19 +0,0 @@
-/* eslint-disable camelcase */
-import { DEFAULT_TILE_RESOLUTION } from "../constants.js";
-import { baseSource } from "./base-source.js";
-export const vectorTableSource = async function (options) {
-    const { columns, filters, spatialDataColumn = 'geom', tableName, tileResolution = DEFAULT_TILE_RESOLUTION } = options;
-    const urlParameters = {
-        name: tableName,
-        spatialDataColumn,
-        spatialDataType: 'geo',
-        tileResolution: tileResolution.toString()
-    };
-    if (columns) {
-        urlParameters.columns = columns.join(',');
-    }
-    if (filters) {
-        urlParameters.filters = filters;
-    }
-    return baseSource('table', options, urlParameters);
-};

package/dist/sources/vector-tileset-source.d.ts

@@ -1,4 +0,0 @@
-import type { SourceOptions, TilesetSourceOptions, TilejsonResult } from "./types.js";
-export type VectorTilesetSourceOptions = SourceOptions & TilesetSourceOptions;
-export declare const vectorTilesetSource: (options: VectorTilesetSourceOptions) => Promise<TilejsonResult>;
-//# sourceMappingURL=vector-tileset-source.d.ts.map

package/dist/sources/vector-tileset-source.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"vector-tileset-source.d.ts","sourceRoot":"","sources":["../../src/sources/vector-tileset-source.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,aAAa,EAAE,oBAAoB,EAAE,cAAc,EAAC,mBAAgB;AAEjF,MAAM,MAAM,0BAA0B,GAAG,aAAa,GAAG,oBAAoB,CAAC;AAG9E,eAAO,MAAM,mBAAmB,YACrB,0BAA0B,KAClC,QAAQ,cAAc,CAKxB,CAAC"}

package/dist/sources/vector-tileset-source.js

@@ -1,6 +0,0 @@
-import { baseSource } from "./base-source.js";
-export const vectorTilesetSource = async function (options) {
-    const { tableName } = options;
-    const urlParameters = { name: tableName };
-    return baseSource('tileset', options, urlParameters);
-};

package/src/api/carto-api-error.ts

@@ -1,68 +0,0 @@
-import type {APIErrorContext} from './types';
-
-/**
- *
- * Custom error for reported errors in CARTO Maps API.
- * Provides useful debugging information in console and context for applications.
- *
- */
-export 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
-  ) {
-    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.responseJson = responseJson;
-    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/src/api/common.ts

@@ -1,6 +0,0 @@
-export const DEFAULT_API_BASE_URL = 'https://gcp-us-east1.api.carto.com';
-export const DEFAULT_CLIENT = 'deck-gl-carto';
-export const V3_MINOR_VERSION = '3.4';
-
-// Fastly default limit is 8192; leave some padding.
-export const DEFAULT_MAX_LENGTH_URL = 7000;

package/src/api/endpoints.ts

@@ -1,69 +0,0 @@
-import {MapType} from './types';
-
-export type V3Endpoint = 'maps' | 'stats' | 'sql';
-
-function joinPath(...args: string[]): string {
-  return args.map(part => (part.endsWith('/') ? part.slice(0, -1) : part)).join('/');
-}
-
-function buildV3Path(
-  apiBaseUrl: string,
-  version: 'v3',
-  endpoint: V3Endpoint,
-  ...rest: string[]
-): string {
-  return joinPath(apiBaseUrl, version, endpoint, ...rest);
-}
-
-export function buildPublicMapUrl({
-  apiBaseUrl,
-  cartoMapId
-}: {
-  apiBaseUrl: string;
-  cartoMapId: string;
-}): string {
-  return buildV3Path(apiBaseUrl, 'v3', 'maps', 'public', cartoMapId);
-}
-
-export function buildStatsUrl({
-  attribute,
-  apiBaseUrl,
-  connectionName,
-  source,
-  type
-}: {
-  attribute: string;
-  apiBaseUrl: string;
-  connectionName: string;
-  source: string;
-  type: MapType;
-}): string {
-  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
-}: {
-  apiBaseUrl: string;
-  connectionName: string;
-  endpoint: MapType;
-}): string {
-  return buildV3Path(apiBaseUrl, 'v3', 'maps', connectionName, endpoint);
-}
-
-export function buildQueryUrl({
-  apiBaseUrl,
-  connectionName
-}: {
-  apiBaseUrl: string;
-  connectionName: string;
-}): string {
-  return buildV3Path(apiBaseUrl, 'v3', 'sql', connectionName, 'query');
-}

package/src/api/query.ts

@@ -1,42 +0,0 @@
-import {SOURCE_DEFAULTS} from '../sources/index';
-import type {SourceOptions, QuerySourceOptions, QueryResult} from '../sources/types';
-import {buildQueryUrl} from './endpoints';
-import {requestWithParameters} from './request-with-parameters';
-import {APIErrorContext} from './types';
-
-export type QueryOptions = SourceOptions & Omit<QuerySourceOptions, 'spatialDataColumn'>;
-type UrlParameters = {q: string; queryParameters?: string};
-
-export const query = async function (options: QueryOptions): Promise<QueryResult> {
-  const {
-    apiBaseUrl = SOURCE_DEFAULTS.apiBaseUrl,
-    clientId = SOURCE_DEFAULTS.clientId,
-    maxLengthURL = SOURCE_DEFAULTS.maxLengthURL,
-    connectionName,
-    sqlQuery,
-    queryParameters
-  } = options;
-  const urlParameters: UrlParameters = {q: sqlQuery};
-
-  if (queryParameters) {
-    urlParameters.queryParameters = JSON.stringify(queryParameters);
-  }
-
-  const baseUrl = buildQueryUrl({apiBaseUrl, connectionName});
-  const headers = {Authorization: `Bearer ${options.accessToken}`, ...options.headers};
-  const parameters = {client: clientId, ...urlParameters};
-
-  const errorContext: APIErrorContext = {
-    requestType: 'SQL',
-    connection: options.connectionName,
-    type: 'query',
-    source: JSON.stringify(parameters, undefined, 2)
-  };
-  return await requestWithParameters<QueryResult>({
-    baseUrl,
-    parameters,
-    headers,
-    errorContext,
-    maxLengthURL
-  });
-};

package/src/api/request-with-parameters.ts

@@ -1,117 +0,0 @@
-import {VERSION} from '@deck.gl/core';
-import {isPureObject} from '../utils';
-import {CartoAPIError} from './carto-api-error';
-import {DEFAULT_MAX_LENGTH_URL, V3_MINOR_VERSION} from './common';
-import type {APIErrorContext} from './types';
-
-/**
- * Parameters added to all requests issued with `requestWithParameters()`.
- * These parameters override parameters already in the base URL, but not
- * user-provided parameters.
- */
-const DEFAULT_PARAMETERS = {
-  v: V3_MINOR_VERSION,
-  deckglVersion: VERSION
-};
-
-const DEFAULT_HEADERS = {
-  Accept: 'application/json',
-  'Content-Type': 'application/json'
-};
-
-const REQUEST_CACHE = new Map<string, Promise<unknown>>();
-
-export async function requestWithParameters<T = any>({
-  baseUrl,
-  parameters = {},
-  headers: customHeaders = {},
-  errorContext,
-  maxLengthURL = DEFAULT_MAX_LENGTH_URL
-}: {
-  baseUrl: string;
-  parameters?: Record<string, unknown>;
-  headers?: Record<string, string>;
-  errorContext: APIErrorContext;
-  maxLengthURL?: number;
-}): Promise<T> {
-  parameters = {...DEFAULT_PARAMETERS, ...parameters};
-  baseUrl = excludeURLParameters(baseUrl, Object.keys(parameters));
-  const key = createCacheKey(baseUrl, parameters, customHeaders);
-  if (REQUEST_CACHE.has(key)) {
-    return REQUEST_CACHE.get(key) as Promise<T>;
-  }
-
-  const url = createURLWithParameters(baseUrl, parameters);
-  const headers = {...DEFAULT_HEADERS, ...customHeaders};
-
-  /* global fetch */
-  const fetchPromise =
-    url.length > maxLengthURL
-      ? fetch(baseUrl, {method: 'POST', body: JSON.stringify(parameters), headers})
-      : fetch(url, {headers});
-
-  let response: Response | undefined;
-  let responseJson;
-  const jsonPromise: Promise<T> = fetchPromise
-    .then((_response: Response) => {
-      response = _response;
-      return response.json();
-    })
-    .then((json: any) => {
-      responseJson = json;
-      if (!response || !response.ok) {
-        throw new Error(json.error);
-      }
-      return json;
-    })
-    .catch((error: Error) => {
-      REQUEST_CACHE.delete(key);
-      throw new CartoAPIError(error, errorContext, response, responseJson);
-    });
-
-  REQUEST_CACHE.set(key, jsonPromise);
-  return jsonPromise;
-}
-
-function createCacheKey(
-  baseUrl: string,
-  parameters: Record<string, unknown>,
-  headers: Record<string, string>
-): string {
-  const parameterEntries = Object.entries(parameters).sort(([a], [b]) => (a > b ? 1 : -1));
-  const headerEntries = Object.entries(headers).sort(([a], [b]) => (a > b ? 1 : -1));
-  return JSON.stringify({baseUrl, parameters: parameterEntries, headers: headerEntries});
-}
-
-/**
- * Appends query string parameters to a URL. Existing URL parameters are kept,
- * unless there is a conflict, in which case the new parameters override
- * those already in the URL.
- */
-function createURLWithParameters(
-  baseUrlString: string,
-  parameters: Record<string, unknown>
-): string {
-  const baseUrl = new URL(baseUrlString);
-  for (const [key, value] of Object.entries(parameters)) {
-    if (isPureObject(value) || Array.isArray(value)) {
-      baseUrl.searchParams.set(key, JSON.stringify(value));
-    } else {
-      baseUrl.searchParams.set(key, (value as string | boolean | number).toString());
-    }
-  }
-  return baseUrl.toString();
-}
-
-/**
- * Deletes query string parameters from a URL.
- */
-function excludeURLParameters(baseUrlString: string, parameters: string[]) {
-  const baseUrl = new URL(baseUrlString);
-  for (const param of parameters) {
-    if (baseUrl.searchParams.has(param)) {
-      baseUrl.searchParams.delete(param);
-    }
-  }
-  return baseUrl.toString();
-}

package/src/sources/base-source.ts

@@ -1,79 +0,0 @@
-/* eslint-disable camelcase */
-import {DEFAULT_API_BASE_URL, DEFAULT_CLIENT, DEFAULT_MAX_LENGTH_URL} from '../api/common';
-import {buildSourceUrl} from '../api/endpoints';
-import {requestWithParameters} from '../api/request-with-parameters';
-import type {APIErrorContext, MapType} from '../api/types';
-import type {
-  GeojsonResult,
-  JsonResult,
-  SourceOptionalOptions,
-  SourceRequiredOptions,
-  TilejsonMapInstantiation,
-  TilejsonResult
-} from './types';
-
-export const SOURCE_DEFAULTS: SourceOptionalOptions = {
-  apiBaseUrl: DEFAULT_API_BASE_URL,
-  clientId: DEFAULT_CLIENT,
-  format: 'tilejson',
-  headers: {},
-  maxLengthURL: DEFAULT_MAX_LENGTH_URL
-};
-
-export async function baseSource<UrlParameters extends Record<string, unknown>>(
-  endpoint: MapType,
-  options: Partial<SourceOptionalOptions> & SourceRequiredOptions,
-  urlParameters: UrlParameters
-): Promise<TilejsonResult | GeojsonResult | JsonResult> {
-  const {accessToken, connectionName, cache, ...optionalOptions} = options;
-  const mergedOptions = {...SOURCE_DEFAULTS, accessToken, connectionName, endpoint};
-  for (const key in optionalOptions) {
-    if (optionalOptions[key]) {
-      mergedOptions[key] = optionalOptions[key];
-    }
-  }
-  const baseUrl = buildSourceUrl(mergedOptions);
-  const {clientId, maxLengthURL, format} = mergedOptions;
-  const headers = {Authorization: `Bearer ${options.accessToken}`, ...options.headers};
-  const parameters = {client: clientId, ...urlParameters};
-
-  const errorContext: APIErrorContext = {
-    requestType: 'Map instantiation',
-    connection: options.connectionName,
-    type: endpoint,
-    source: JSON.stringify(parameters, undefined, 2)
-  };
-  const mapInstantiation = await requestWithParameters<TilejsonMapInstantiation>({
-    baseUrl,
-    parameters,
-    headers,
-    errorContext,
-    maxLengthURL
-  });
-
-  const dataUrl = mapInstantiation[format].url[0];
-  if (cache) {
-    cache.value = parseInt(new URL(dataUrl).searchParams.get('cache') || '', 10);
-  }
-  errorContext.requestType = 'Map data';
-
-  if (format === 'tilejson') {
-    const json = await requestWithParameters<TilejsonResult>({
-      baseUrl: dataUrl,
-      headers,
-      errorContext,
-      maxLengthURL
-    });
-    if (accessToken) {
-      json.accessToken = accessToken;
-    }
-    return json;
-  }
-
-  return await requestWithParameters<GeojsonResult | JsonResult>({
-    baseUrl: dataUrl,
-    headers,
-    errorContext,
-    maxLengthURL
-  });
-}

package/src/sources/boundary-query-source.ts

@@ -1,39 +0,0 @@
-import {QueryParameters} from '../api/index';
-import {baseSource} from './base-source';
-import type {FilterOptions, SourceOptions, TilejsonResult} from './types';
-
-export type BoundaryQuerySourceOptions = SourceOptions &
-  FilterOptions & {
-    columns?: string[];
-    tilesetTableName: string;
-    propertiesSqlQuery: string;
-    queryParameters?: QueryParameters;
-  };
-type UrlParameters = {
-  columns?: string;
-  filters?: Record<string, unknown>;
-  tilesetTableName: string;
-  propertiesSqlQuery: string;
-  queryParameters?: Record<string, unknown> | unknown[];
-};
-
-export const boundaryQuerySource = async function (
-  options: BoundaryQuerySourceOptions
-): Promise<TilejsonResult> {
-  const {columns, filters, tilesetTableName, propertiesSqlQuery, queryParameters} = options;
-  const urlParameters: UrlParameters = {
-    tilesetTableName,
-    propertiesSqlQuery
-  };
-
-  if (columns) {
-    urlParameters.columns = columns.join(',');
-  }
-  if (filters) {
-    urlParameters.filters = filters;
-  }
-  if (queryParameters) {
-    urlParameters.queryParameters = queryParameters;
-  }
-  return baseSource<UrlParameters>('boundary', options, urlParameters) as Promise<TilejsonResult>;
-};

package/src/sources/boundary-table-source.ts

@@ -1,33 +0,0 @@
-import {baseSource} from './base-source';
-import type {FilterOptions, SourceOptions, TilejsonResult} from './types';
-
-export type BoundaryTableSourceOptions = SourceOptions &
-  FilterOptions & {
-    tilesetTableName: string;
-    columns?: string[];
-    propertiesTableName: string;
-  };
-type UrlParameters = {
-  filters?: Record<string, unknown>;
-  tilesetTableName: string;
-  columns?: string;
-  propertiesTableName: string;
-};
-
-export const boundaryTableSource = async function (
-  options: BoundaryTableSourceOptions
-): Promise<TilejsonResult> {
-  const {filters, tilesetTableName, columns, propertiesTableName} = options;
-  const urlParameters: UrlParameters = {
-    tilesetTableName,
-    propertiesTableName
-  };
-
-  if (columns) {
-    urlParameters.columns = columns.join(',');
-  }
-  if (filters) {
-    urlParameters.filters = filters;
-  }
-  return baseSource<UrlParameters>('boundary', options, urlParameters) as Promise<TilejsonResult>;
-};

package/src/sources/h3-query-source.ts

@@ -1,55 +0,0 @@
-/* eslint-disable camelcase */
-import {DEFAULT_AGGREGATION_RES_LEVEL_H3} from '../constants';
-import {baseSource} from './base-source';
-import type {
-  AggregationOptions,
-  FilterOptions,
-  QuerySourceOptions,
-  SourceOptions,
-  SpatialDataType,
-  TilejsonResult
-} from './types';
-
-export type H3QuerySourceOptions = SourceOptions &
-  QuerySourceOptions &
-  AggregationOptions &
-  FilterOptions;
-type UrlParameters = {
-  aggregationExp: string;
-  aggregationResLevel?: string;
-  spatialDataType: SpatialDataType;
-  spatialDataColumn?: string;
-  q: string;
-  queryParameters?: Record<string, unknown> | unknown[];
-  filters?: Record<string, unknown>;
-};
-
-export const h3QuerySource = async function (
-  options: H3QuerySourceOptions
-): Promise<TilejsonResult> {
-  const {
-    aggregationExp,
-    aggregationResLevel = DEFAULT_AGGREGATION_RES_LEVEL_H3,
-    sqlQuery,
-    spatialDataColumn = 'h3',
-    queryParameters,
-    filters
-  } = options;
-  const urlParameters: UrlParameters = {
-    aggregationExp,
-    spatialDataColumn,
-    spatialDataType: 'h3',
-    q: sqlQuery
-  };
-
-  if (aggregationResLevel) {
-    urlParameters.aggregationResLevel = String(aggregationResLevel);
-  }
-  if (queryParameters) {
-    urlParameters.queryParameters = queryParameters;
-  }
-  if (filters) {
-    urlParameters.filters = filters;
-  }
-  return baseSource<UrlParameters>('query', options, urlParameters) as Promise<TilejsonResult>;
-};

package/src/sources/h3-table-source.ts

@@ -1,51 +0,0 @@
-/* eslint-disable camelcase */
-import {DEFAULT_AGGREGATION_RES_LEVEL_H3} from '../constants';
-import {baseSource} from './base-source';
-import type {
-  AggregationOptions,
-  FilterOptions,
-  SourceOptions,
-  SpatialDataType,
-  TableSourceOptions,
-  TilejsonResult
-} from './types';
-
-export type H3TableSourceOptions = SourceOptions &
-  TableSourceOptions &
-  AggregationOptions &
-  FilterOptions;
-
-type UrlParameters = {
-  aggregationExp: string;
-  aggregationResLevel?: string;
-  spatialDataType: SpatialDataType;
-  spatialDataColumn?: string;
-  name: string;
-  filters?: Record<string, unknown>;
-};
-
-export const h3TableSource = async function (
-  options: H3TableSourceOptions
-): Promise<TilejsonResult> {
-  const {
-    aggregationExp,
-    aggregationResLevel = DEFAULT_AGGREGATION_RES_LEVEL_H3,
-    spatialDataColumn = 'h3',
-    tableName,
-    filters
-  } = options;
-  const urlParameters: UrlParameters = {
-    aggregationExp,
-    name: tableName,
-    spatialDataColumn,
-    spatialDataType: 'h3'
-  };
-
-  if (aggregationResLevel) {
-    urlParameters.aggregationResLevel = String(aggregationResLevel);
-  }
-  if (filters) {
-    urlParameters.filters = filters;
-  }
-  return baseSource<UrlParameters>('table', options, urlParameters) as Promise<TilejsonResult>;
-};

package/src/sources/h3-tileset-source.ts

@@ -1,14 +0,0 @@
-import {baseSource} from './base-source';
-import type {SourceOptions, TilejsonResult, TilesetSourceOptions} from './types';
-
-export type H3TilesetSourceOptions = SourceOptions & TilesetSourceOptions;
-type UrlParameters = {name: string};
-
-export const h3TilesetSource = async function (
-  options: H3TilesetSourceOptions
-): Promise<TilejsonResult> {
-  const {tableName} = options;
-  const urlParameters: UrlParameters = {name: tableName};
-
-  return baseSource<UrlParameters>('tileset', options, urlParameters) as Promise<TilejsonResult>;
-};

package/src/sources/index.ts

@@ -1,45 +0,0 @@
-export {SOURCE_DEFAULTS} from './base-source';
-export type {TilejsonResult, GeojsonResult, JsonResult} from './types';
-
-export {boundaryQuerySource} from './boundary-query-source';
-export type {BoundaryQuerySourceOptions} from './boundary-query-source';
-
-export {boundaryTableSource} from './boundary-table-source';
-export type {BoundaryTableSourceOptions} from './boundary-table-source';
-
-export {h3QuerySource} from './h3-query-source';
-export type {H3QuerySourceOptions} from './h3-query-source';
-
-export {h3TableSource} from './h3-table-source';
-export type {H3TableSourceOptions} from './h3-table-source';
-
-export {h3TilesetSource} from './h3-tileset-source';
-export type {H3TilesetSourceOptions} from './h3-tileset-source';
-
-export {rasterSource} from './raster-source';
-export type {RasterSourceOptions} from './raster-source';
-
-export {quadbinQuerySource} from './quadbin-query-source';
-export type {QuadbinQuerySourceOptions} from './quadbin-query-source';
-
-export {quadbinTableSource} from './quadbin-table-source';
-export type {QuadbinTableSourceOptions} from './quadbin-table-source';
-
-export {quadbinTilesetSource} from './quadbin-tileset-source';
-export type {QuadbinTilesetSourceOptions} from './quadbin-tileset-source';
-
-export {vectorQuerySource} from './vector-query-source';
-export type {VectorQuerySourceOptions} from './vector-query-source';
-
-export {vectorTableSource} from './vector-table-source';
-export type {VectorTableSourceOptions} from './vector-table-source';
-
-export {vectorTilesetSource} from './vector-tileset-source';
-export type {VectorTilesetSourceOptions} from './vector-tileset-source';
-
-export type {
-  SourceOptions,
-  QuerySourceOptions,
-  TableSourceOptions,
-  TilesetSourceOptions
-} from './types';