@carto/api-client 0.3.1 → 0.4.0-alpha.1

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

@@ -0,0 +1,53 @@
+// deck.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+import {QueryParameters} from '../types.js';
+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

@@ -0,0 +1,41 @@
+// deck.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+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

@@ -0,0 +1,63 @@
+// deck.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+/* eslint-disable camelcase */
+import {DEFAULT_AGGREGATION_RES_LEVEL_H3} from '../constants-internal';
+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

@@ -0,0 +1,59 @@
+// deck.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+/* eslint-disable camelcase */
+import {DEFAULT_AGGREGATION_RES_LEVEL_H3} from '../constants-internal';
+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

@@ -0,0 +1,26 @@
+// deck.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+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,5 +1,54 @@
-export * from './widget-base-source.js';
-export * from './widget-query-source.js';
-export * from './widget-table-source.js';
-export * from './wrappers.js';
-export * from './types.js';
+// deck.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+export {SOURCE_DEFAULTS} from './base-source';
+export type {
+  TilejsonResult,
+  GeojsonResult,
+  JsonResult,
+  QueryResult,
+} 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';

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

@@ -0,0 +1,64 @@
+// deck.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+/* eslint-disable camelcase */
+import {DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN} from '../constants-internal';
+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

@@ -0,0 +1,60 @@
+// deck.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+/* eslint-disable camelcase */
+import {DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN} from '../constants-internal';
+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

@@ -0,0 +1,26 @@
+// deck.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+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

@@ -0,0 +1,34 @@
+// deck.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+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>;
+};