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

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

@@ -1,56 +0,0 @@
-/* eslint-disable camelcase */
-import {DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN} from '../constants';
-import {baseSource} from './base-source';
-import type {
-  AggregationOptions,
-  FilterOptions,
-  QuerySourceOptions,
-  SourceOptions,
-  SpatialDataType,
-  TilejsonResult
-} from './types';
-
-export type QuadbinQuerySourceOptions = 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 quadbinQuerySource = async function (
-  options: QuadbinQuerySourceOptions
-): Promise<TilejsonResult> {
-  const {
-    aggregationExp,
-    aggregationResLevel = DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN,
-    sqlQuery,
-    spatialDataColumn = 'quadbin',
-    queryParameters,
-    filters
-  } = options;
-  const urlParameters: UrlParameters = {
-    aggregationExp,
-    q: sqlQuery,
-    spatialDataColumn,
-    spatialDataType: 'quadbin'
-  };
-
-  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/quadbin-table-source.ts

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

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

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

package/src/sources/raster-source.ts

@@ -1,17 +0,0 @@
-import {baseSource} from './base-source';
-import type {FilterOptions, SourceOptions, TilejsonResult, TilesetSourceOptions} from './types';
-
-export type RasterSourceOptions = SourceOptions & TilesetSourceOptions & FilterOptions;
-type UrlParameters = {
-  name: string;
-  filters?: Record<string, unknown>;
-};
-
-export const rasterSource = async function (options: RasterSourceOptions): Promise<TilejsonResult> {
-  const {tableName, filters} = options;
-  const urlParameters: UrlParameters = {name: tableName};
-  if (filters) {
-    urlParameters.filters = filters;
-  }
-  return baseSource<UrlParameters>('raster', options, urlParameters) as Promise<TilejsonResult>;
-};

package/src/sources/types.ts

@@ -1,231 +0,0 @@
-import type {Feature} from 'geojson';
-import type {Filters, Format, MapInstantiation, QueryParameters} from '../api/types';
-
-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}[];
-};

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

@@ -1,57 +0,0 @@
-/* eslint-disable camelcase */
-import {DEFAULT_TILE_RESOLUTION} from '../constants';
-import {baseSource} from './base-source';
-import type {
-  FilterOptions,
-  SourceOptions,
-  QuerySourceOptions,
-  SpatialDataType,
-  TilejsonResult,
-  ColumnsOption
-} from './types';
-
-export type VectorQuerySourceOptions = SourceOptions &
-  QuerySourceOptions &
-  FilterOptions &
-  ColumnsOption;
-
-type UrlParameters = {
-  columns?: string;
-  filters?: Record<string, unknown>;
-  spatialDataType: SpatialDataType;
-  spatialDataColumn?: string;
-  tileResolution?: string;
-  q: string;
-  queryParameters?: Record<string, unknown> | unknown[];
-};
-
-export const vectorQuerySource = async function (
-  options: VectorQuerySourceOptions
-): Promise<TilejsonResult> {
-  const {
-    columns,
-    filters,
-    spatialDataColumn = 'geom',
-    sqlQuery,
-    tileResolution = DEFAULT_TILE_RESOLUTION,
-    queryParameters
-  } = options;
-
-  const urlParameters: 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<UrlParameters>('query', options, urlParameters) as Promise<TilejsonResult>;
-};

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

@@ -1,51 +0,0 @@
-/* eslint-disable camelcase */
-import {DEFAULT_TILE_RESOLUTION} from '../constants';
-import {baseSource} from './base-source';
-import type {
-  FilterOptions,
-  ColumnsOption,
-  SourceOptions,
-  SpatialDataType,
-  TableSourceOptions,
-  TilejsonResult
-} from './types';
-
-export type VectorTableSourceOptions = SourceOptions &
-  TableSourceOptions &
-  FilterOptions &
-  ColumnsOption;
-type UrlParameters = {
-  columns?: string;
-  filters?: Record<string, unknown>;
-  spatialDataType: SpatialDataType;
-  spatialDataColumn?: string;
-  tileResolution?: string;
-  name: string;
-};
-
-export const vectorTableSource = async function (
-  options: VectorTableSourceOptions
-): Promise<TilejsonResult> {
-  const {
-    columns,
-    filters,
-    spatialDataColumn = 'geom',
-    tableName,
-    tileResolution = DEFAULT_TILE_RESOLUTION
-  } = options;
-
-  const urlParameters: UrlParameters = {
-    name: tableName,
-    spatialDataColumn,
-    spatialDataType: 'geo',
-    tileResolution: tileResolution.toString()
-  };
-
-  if (columns) {
-    urlParameters.columns = columns.join(',');
-  }
-  if (filters) {
-    urlParameters.filters = filters;
-  }
-  return baseSource<UrlParameters>('table', options, urlParameters) as Promise<TilejsonResult>;
-};

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

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