@deck.gl/carto 9.0.40 → 9.1.0-beta.3

package/dist/sources/types.d.ts

@@ -1,219 +0,0 @@
-import type { Feature } from 'geojson';
-import type { Filters, Format, MapInstantiation, QueryParameters } from "../api/types.js";
-export type SourceRequiredOptions = {
-    /** Carto platform access token. */
-    accessToken: string;
-    /** Data warehouse connection name in Carto platform. */
-    connectionName: string;
-};
-export type SourceOptionalOptions = {
-    /**
-     * 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;
-    /**
-     * Custom HTTP headers added to map instantiation and data requests.
-     */
-    headers: Record<string, string>;
-    /**
-     * Cache buster value returned by map instantiation.
-     *
-     * Carto source saves `cache` value of map instantiation response in `cache.value`, so it can be used to
-     * check if underlying map data has changed between distinct source requests.
-     */
-    cache?: {
-        value?: number;
-    };
-    clientId: string;
-    /** @deprecated  use `query` instead **/
-    format: Format;
-    /**
-     * Maximum URL character length. Above this limit, requests use POST.
-     * Used to avoid browser and CDN limits.
-     * @default {@link DEFAULT_MAX_LENGTH_URL}
-     */
-    maxLengthURL?: number;
-};
-export type SourceOptions = SourceRequiredOptions & Partial<SourceOptionalOptions>;
-export type AggregationOptions = {
-    /**
-     * Defines the aggregation expressions that will be calculated from the resulting columns on each grid cell.
-     *
-     * Example:
-     *
-     *     sum(pop) as total_population, avg(rev) as average_revenue
-     */
-    aggregationExp: string;
-    /**
-     * Defines the tile aggregation resolution.
-     *
-     * @default 6 for quadbin and 4 for h3 sources
-     */
-    aggregationResLevel?: number;
-};
-export type FilterOptions = {
-    /**
-     * Filters to apply to the data source on the server
-     */
-    filters?: Filters;
-};
-export type QuerySourceOptions = {
-    /**
-     * The column name and the type of geospatial support.
-     *
-     * If not present, defaults to `'geom'` for generic queries, `'quadbin'` for Quadbin sources and `'h3'` for H3 sources.
-     */
-    spatialDataColumn?: string;
-    /** SQL query. */
-    sqlQuery: string;
-    /**
-     * Relative resolution of a tile. Higher values increase density and data size. At `tileResolution = 1`, tile geometry is
-     * quantized to a 1024x1024 grid. Increasing or decreasing the resolution will increase or decrease the dimensions of
-     * the quantization grid proportionately.
-     *
-     * Supported `tileResolution` values, with corresponding grid sizes:
-     *
-     * - 0.25: 256x256
-     * - 0.5: 512x512
-     * - 1: 1024x1024
-     * - 2: 2048x2048
-     * - 4: 4096x4096
-     */
-    tileResolution?: TileResolution;
-    /**
-     * Values for named or positional paramteres in the query.
-     *
-     * The way query parameters are determined by data warehouse.
-     *
-     *  * BigQuery has named query parameters, specified with a dictionary, and referenced by key (`@key`)
-     *
-     *     ```
-     *     sqlQuery: "SELECT * FROM carto-demo-data.demo_tables.retail_stores WHERE storetype = ⁣@type AND revenue > ⁣@minRevenue"
-     *     queryParameters: { type: 'Supermarket', minRevenue: 1000000 }
-     *     ```
-     * * Snowflake supports positional parameters, in the form `:1`, `:2`, etc.
-     *
-     *     ```
-     *     sqlQuery: "SELECT * FROM demo_db.public.import_retail_stores WHERE storetype = :2 AND revenue > :1
-     *     queryParameters: [100000, "Supermarket"]
-     *     ```
-     * * Postgres and Redhisft supports positional parameters, but in the form `$1`, `$2`, etc.
-     *
-     *     ```
-     *     sqlQuery: "SELECT * FROM carto_demo_data.demo_tables.retail_stores WHERE storetype = $2 AND revenue > $1
-     *     queryParameters: [100000, "Supermarket"]
-     *     ```
-     */
-    queryParameters?: QueryParameters;
-};
-export type TableSourceOptions = {
-    /**
-     * Fully qualified name of table.
-     */
-    tableName: string;
-    /**
-     * The column name and the type of geospatial support.
-     *
-     * If not present, defaults to `'geom'` for generic tables, `'quadbin'` for Quadbin sources and `'h3'` for H3 sources.
-     */
-    spatialDataColumn?: string;
-    /**
-     * Relative resolution of a tile. Higher values increase density and data size. At `tileResolution = 1`, tile geometry is
-     * quantized to a 1024x1024 grid. Increasing or decreasing the resolution will increase or decrease the dimensions of
-     * the quantization grid proportionately.
-     *
-     * Supported `tileResolution` values, with corresponding grid sizes:
-     *
-     * - 0.25: 256x256
-     * - 0.5: 512x512
-     * - 1: 1024x1024
-     * - 2: 2048x2048
-     * - 4: 4096x4096
-     */
-    tileResolution?: TileResolution;
-};
-export type TilesetSourceOptions = {
-    /**
-     * Fully qualified name of tileset.
-     */
-    tableName: string;
-};
-export type ColumnsOption = {
-    /**
-     * Columns to retrieve from the table.
-     *
-     * If not present, all columns are returned.
-     */
-    columns?: string[];
-};
-export type SpatialDataType = 'geo' | 'h3' | 'quadbin';
-export type TilejsonMapInstantiation = MapInstantiation & {
-    tilejson: {
-        url: string[];
-    };
-};
-export type TileResolution = 0.25 | 0.5 | 1 | 2 | 4;
-export interface Tilejson {
-    tilejson: string;
-    name: string;
-    description: string;
-    version: string;
-    attribution: string;
-    scheme: string;
-    tiles: string[];
-    properties_tiles: string[];
-    minresolution: number;
-    maxresolution: number;
-    minzoom: number;
-    maxzoom: number;
-    bounds: [number, number, number, number];
-    center: [number, number, number];
-    vector_layers: VectorLayer[];
-    tilestats: Tilestats;
-    tileResolution?: TileResolution;
-}
-export interface Tilestats {
-    layerCount: number;
-    layers: Layer[];
-}
-export interface Layer {
-    layer: string;
-    count: number;
-    attributeCount: number;
-    attributes: Attribute[];
-}
-export interface Attribute {
-    attribute: string;
-    type: string;
-}
-export interface VectorLayer {
-    id: string;
-    minzoom: number;
-    maxzoom: number;
-    fields: Record<string, string>;
-}
-export type TilejsonResult = Tilejson & {
-    accessToken: string;
-};
-export type GeojsonResult = {
-    type: 'FeatureCollection';
-    features: Feature[];
-};
-export type JsonResult = any[];
-export type QueryResult = {
-    meta: {
-        cacheHit: boolean;
-        location: string;
-        totalBytesProcessed: string;
-    };
-    rows: Record<string, any>[];
-    schema: {
-        name: string;
-        type: string;
-    }[];
-};
-//# sourceMappingURL=types.d.ts.map

package/dist/sources/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/sources/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,SAAS,CAAC;AACrC,OAAO,KAAK,EAAC,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,eAAe,EAAC,wBAAqB;AAErF,MAAM,MAAM,qBAAqB,GAAG;IAClC,mCAAmC;IACnC,WAAW,EAAE,MAAM,CAAC;IAEpB,wDAAwD;IACxD,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;;;;OAMG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEhC;;;;;OAKG;IACH,KAAK,CAAC,EAAE;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAC,CAAC;IAEzB,QAAQ,EAAE,MAAM,CAAC;IACjB,wCAAwC;IACxC,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;AAEnF,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;;;OAMG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,iBAAiB;IACjB,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;;;;;;;;;OAYG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC;IAEhC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;;;;;;;;OAYG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,KAAK,GAAG,IAAI,GAAG,SAAS,CAAC;AAEvD,MAAM,MAAM,wBAAwB,GAAG,gBAAgB,GAAG;IACxD,QAAQ,EAAE;QAAC,GAAG,EAAE,MAAM,EAAE,CAAA;KAAC,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,IAAI,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAEpD,MAAM,WAAW,QAAQ;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,aAAa,EAAE,WAAW,EAAE,CAAC;IAC7B,SAAS,EAAE,SAAS,CAAC;IACrB,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC;AAED,MAAM,WAAW,SAAS;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,KAAK,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,KAAK;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,SAAS,EAAE,CAAC;CACzB;AAED,MAAM,WAAW,SAAS;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAChC;AAED,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG;IAAC,WAAW,EAAE,MAAM,CAAA;CAAC,CAAC;AAC9D,MAAM,MAAM,aAAa,GAAG;IAAC,IAAI,EAAE,mBAAmB,CAAC;IAAC,QAAQ,EAAE,OAAO,EAAE,CAAA;CAAC,CAAC;AAC7E,MAAM,MAAM,UAAU,GAAG,GAAG,EAAE,CAAC;AAC/B,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE;QAAC,QAAQ,EAAE,OAAO,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,mBAAmB,EAAE,MAAM,CAAA;KAAC,CAAC;IACzE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC;IAC5B,MAAM,EAAE;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAC,EAAE,CAAC;CACxC,CAAC"}

package/dist/sources/types.js

@@ -1 +0,0 @@
-export {};

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

@@ -1,4 +0,0 @@
-import type { FilterOptions, SourceOptions, QuerySourceOptions, TilejsonResult, ColumnsOption } from "./types.js";
-export type VectorQuerySourceOptions = SourceOptions & QuerySourceOptions & FilterOptions & ColumnsOption;
-export declare const vectorQuerySource: (options: VectorQuerySourceOptions) => Promise<TilejsonResult>;
-//# sourceMappingURL=vector-query-source.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"vector-query-source.d.ts","sourceRoot":"","sources":["../../src/sources/vector-query-source.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,aAAa,EACb,aAAa,EACb,kBAAkB,EAElB,cAAc,EACd,aAAa,EACd,mBAAgB;AAEjB,MAAM,MAAM,wBAAwB,GAAG,aAAa,GAClD,kBAAkB,GAClB,aAAa,GACb,aAAa,CAAC;AAYhB,eAAO,MAAM,iBAAiB,YACnB,wBAAwB,KAChC,QAAQ,cAAc,CA2BxB,CAAC"}

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

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

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

@@ -1,4 +0,0 @@
-import type { FilterOptions, ColumnsOption, SourceOptions, TableSourceOptions, TilejsonResult } from "./types.js";
-export type VectorTableSourceOptions = SourceOptions & TableSourceOptions & FilterOptions & ColumnsOption;
-export declare const vectorTableSource: (options: VectorTableSourceOptions) => Promise<TilejsonResult>;
-//# sourceMappingURL=vector-table-source.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"vector-table-source.d.ts","sourceRoot":"","sources":["../../src/sources/vector-table-source.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,aAAa,EACb,aAAa,EACb,aAAa,EAEb,kBAAkB,EAClB,cAAc,EACf,mBAAgB;AAEjB,MAAM,MAAM,wBAAwB,GAAG,aAAa,GAClD,kBAAkB,GAClB,aAAa,GACb,aAAa,CAAC;AAUhB,eAAO,MAAM,iBAAiB,YACnB,wBAAwB,KAChC,QAAQ,cAAc,CAuBxB,CAAC"}

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();
-}