@carto/api-client 0.4.0-alpha.0 → 0.4.0-alpha.3

package/src/api/types.ts

@@ -1,301 +0,0 @@
-// deck.gl
-// SPDX-License-Identifier: MIT
-// Copyright (c) vis.gl contributors
-
-export type Format = 'json' | 'geojson' | 'tilejson';
-export type MapType = 'boundary' | 'query' | 'table' | 'tileset' | 'raster';
-export type RequestType =
-  | 'Map data'
-  | 'Map instantiation'
-  | 'Public map'
-  | 'Tile stats'
-  | 'SQL'
-  | 'Basemap style';
-export type ScaleType =
-  | 'linear'
-  | 'ordinal'
-  | 'log'
-  | 'point'
-  | 'quantile'
-  | 'quantize'
-  | 'sqrt'
-  | 'custom'
-  | 'identity';
-
-export type APIErrorContext = {
-  requestType: RequestType;
-  mapId?: string;
-  connection?: string;
-  source?: string;
-  type?: MapType;
-};
-
-export enum SchemaFieldType {
-  Number = 'number',
-  Bigint = 'bigint',
-  String = 'string',
-  Geometry = 'geometry',
-  Timestamp = 'timestamp',
-  Object = 'object',
-  Boolean = 'boolean',
-  Variant = 'variant',
-  Unknown = 'unknown',
-}
-export interface SchemaField {
-  name: string;
-  type: SchemaFieldType; // Field type in the CARTO stack, common for all providers
-}
-
-export interface MapInstantiation extends MapInstantiationFormats {
-  nrows: number;
-  size?: number;
-  schema: SchemaField[];
-}
-
-type MapInstantiationFormats = Record<
-  Format,
-  {
-    url: string[];
-    error?: any;
-  }
->;
-
-export type QueryParameterValue =
-  | string
-  | number
-  | boolean
-  | Array<QueryParameterValue>
-  | object;
-
-export type NamedQueryParameter = Record<string, QueryParameterValue>;
-
-export type PositionalQueryParameter = QueryParameterValue[];
-
-export type QueryParameters = NamedQueryParameter | PositionalQueryParameter;
-export type VisualChannelField = {
-  name: string;
-  type: string;
-  colorColumn?: string;
-};
-
-export interface Filters {
-  [column: string]: Filter;
-}
-
-interface Filter {
-  [FilterTypes.In]?: number[];
-  [FilterTypes.Between]?: number[][];
-  [FilterTypes.ClosedOpen]?: number[][];
-  [FilterTypes.Time]?: number[][];
-  [FilterTypes.StringSearch]?: string[];
-}
-
-export enum FilterTypes {
-  In = 'in',
-  Between = 'between', // [a, b] both are included
-  ClosedOpen = 'closed_open', // [a, b) a is included, b is not
-  Time = 'time',
-  StringSearch = 'stringSearch',
-}
-
-export type VisualChannels = {
-  colorField?: VisualChannelField;
-  colorScale?: ScaleType;
-
-  customMarkersField?: VisualChannelField;
-  customMarkersScale?: ScaleType;
-
-  radiusField?: VisualChannelField;
-  radiusScale?: ScaleType;
-
-  rotationScale?: ScaleType;
-  rotationField?: VisualChannelField;
-
-  sizeField?: VisualChannelField;
-  sizeScale?: ScaleType;
-
-  strokeColorField?: VisualChannelField;
-  strokeColorScale?: ScaleType;
-
-  heightField?: VisualChannelField;
-  heightScale?: ScaleType;
-
-  weightField?: VisualChannelField;
-};
-
-export type ColorRange = {
-  category: string;
-  colors: string[];
-  colorMap: string[][] | undefined;
-  name: string;
-  type: string;
-};
-
-export type CustomMarkersRange = {
-  markerMap: {
-    value: string;
-    markerUrl?: string;
-  }[];
-  othersMarker?: string;
-};
-
-export type VisConfig = {
-  filled?: boolean;
-  opacity?: number;
-  enable3d?: boolean;
-
-  colorAggregation?: any;
-  colorRange: ColorRange;
-
-  customMarkers?: boolean;
-  customMarkersRange?: CustomMarkersRange | null;
-  customMarkersUrl?: string | null;
-
-  radius: number;
-  radiusRange?: number[];
-
-  sizeAggregation?: any;
-  sizeRange?: any;
-
-  strokeColorAggregation?: any;
-  strokeOpacity?: number;
-  strokeColorRange?: ColorRange;
-
-  heightRange?: any;
-  heightAggregation?: any;
-
-  weightAggregation?: any;
-};
-
-export type TextLabel = {
-  field: VisualChannelField | null | undefined;
-  alignment?: 'center' | 'bottom' | 'top';
-  anchor?: 'middle' | 'start' | 'end';
-  size: number;
-  color?: number[];
-  offset?: [number, number];
-  outlineColor?: number[];
-};
-
-export type MapLayerConfig = {
-  columns?: Record<string, any>;
-  color?: number[];
-  label?: string;
-  dataId: string;
-  textLabel: TextLabel[];
-  visConfig: VisConfig;
-};
-
-export type MapTextSubLayerConfig = Omit<MapLayerConfig, 'textLabel'> & {
-  textLabel?: TextLabel;
-};
-
-export type MapConfigLayer = {
-  type: string;
-  id: string;
-  config: MapLayerConfig;
-  visualChannels: VisualChannels;
-};
-
-export type MapDataset = {
-  id: string;
-  data: any;
-  aggregationExp: string | null;
-  aggregationResLevel: number | null;
-  geoColumn: string;
-};
-
-export interface CustomStyle {
-  url?: string;
-  style?: any;
-  customAttribution?: string;
-}
-
-export type KeplerMapConfig = {
-  mapState: any;
-  mapStyle: {
-    styleType: string;
-    visibleLayerGroups: Record<string, boolean>;
-  };
-  visState: {
-    layers: MapConfigLayer[];
-  };
-  layerBlending: any;
-  interactionConfig: any;
-  customBaseMaps?: {
-    customStyle?: CustomStyle;
-  };
-};
-
-export type BasemapType = 'maplibre' | 'google-maps';
-
-export type Basemap = MapLibreBasemap | GoogleBasemap;
-
-export type BasemapCommon = {
-  /**
-   * Type of basemap.
-   */
-  type: BasemapType;
-
-  /**
-   * Custom attribution for style data if not provided by style definition.
-   */
-  attribution?: string;
-
-  /**
-   * Properties of the basemap. These properties are specific to the basemap type.
-   */
-  props: Record<string, any>;
-};
-
-export type MapLibreBasemap = BasemapCommon & {
-  type: 'maplibre';
-
-  /**
-   * MapLibre map properties.
-   *
-   * Meant to be passed to directly to `maplibregl.Map` object.
-   */
-  props: MapLibreBasemapProps;
-
-  /**
-   * Layer groups to be displayed in the basemap.
-   */
-  visibleLayerGroups?: Record<string, boolean>;
-
-  /**
-   * If `style` has been filtered by `visibleLayerGroups` then this property contains original style object, so user
-   * can use `applyLayerGroupFilters` again with new settings.
-   */
-  rawStyle?: string | Record<string, any>;
-};
-
-// Cherry-pick of maplibregl Map API props that are supported/provided by fetchMap interface
-export type MapLibreBasemapProps = {
-  style: string | Record<string, any>;
-  center: [number, number];
-  zoom: number;
-  pitch?: number;
-  bearing?: number;
-};
-
-export type GoogleBasemap = BasemapCommon & {
-  type: 'google-maps';
-
-  /**
-   * Google map properties.
-   *
-   * Meant to be passed to directly to `google.maps.Map` object.
-   */
-  props: GoogleBasemapProps;
-};
-
-// Cherry-pick of Google Map API props that are supported/provided by fetchMap interface
-export type GoogleBasemapProps = {
-  mapTypeId: string;
-  mapId?: string;
-  center?: {lat: number; lng: number};
-  zoom?: number;
-  tilt?: number;
-  heading?: number;
-};

package/src/widget-sources/wrappers.ts

@@ -1,121 +0,0 @@
-import {
-  h3TableSource as _h3TableSource,
-  h3QuerySource as _h3QuerySource,
-  vectorTableSource as _vectorTableSource,
-  vectorQuerySource as _vectorQuerySource,
-  quadbinTableSource as _quadbinTableSource,
-  quadbinQuerySource as _quadbinQuerySource,
-  VectorTableSourceOptions as _VectorTableSourceOptions,
-  VectorQuerySourceOptions as _VectorQuerySourceOptions,
-  H3TableSourceOptions as _H3TableSourceOptions,
-  H3QuerySourceOptions as _H3QuerySourceOptions,
-  QuadbinTableSourceOptions as _QuadbinTableSourceOptions,
-  QuadbinQuerySourceOptions as _QuadbinQuerySourceOptions,
-  SourceOptions,
-} from '../sources/index.js';
-import {WidgetBaseSourceProps} from './widget-base-source.js';
-import {WidgetQuerySource} from './widget-query-source.js';
-import {WidgetTableSource} from './widget-table-source.js';
-
-type WrappedSourceOptions<T> = Omit<T, 'filters'> & WidgetBaseSourceProps;
-
-/******************************************************************************
- * RESPONSE OBJECTS
- */
-
-type WidgetTableSourceResponse = {widgetSource: WidgetTableSource};
-type WidgetQuerySourceResponse = {widgetSource: WidgetQuerySource};
-
-export type VectorTableSourceResponse = WidgetTableSourceResponse &
-  Awaited<ReturnType<typeof _vectorTableSource>>;
-export type VectorQuerySourceResponse = WidgetQuerySourceResponse &
-  Awaited<ReturnType<typeof _vectorQuerySource>>;
-
-export type H3TableSourceResponse = WidgetTableSourceResponse &
-  Awaited<ReturnType<typeof _h3TableSource>>;
-export type H3QuerySourceResponse = WidgetQuerySourceResponse &
-  Awaited<ReturnType<typeof _h3QuerySource>>;
-
-export type QuadbinTableSourceResponse = WidgetTableSourceResponse &
-  Awaited<ReturnType<typeof _quadbinTableSource>>;
-export type QuadbinQuerySourceResponse = WidgetQuerySourceResponse &
-  Awaited<ReturnType<typeof _quadbinQuerySource>>;
-
-/******************************************************************************
- * VECTOR SOURCES
- */
-
-export type VectorTableSourceOptions =
-  WrappedSourceOptions<_VectorTableSourceOptions>;
-
-export type VectorQuerySourceOptions =
-  WrappedSourceOptions<_VectorQuerySourceOptions>;
-
-/** Wrapper adding Widget API support to [vectorTableSource](https://deck.gl/docs/api-reference/carto/data-sources). */
-export async function vectorTableSource(
-  props: VectorTableSourceOptions
-): Promise<VectorTableSourceResponse> {
-  const response = await _vectorTableSource(props as _VectorTableSourceOptions);
-  return {...response, widgetSource: new WidgetTableSource(props)};
-}
-
-/** Wrapper adding Widget API support to [vectorQuerySource](https://deck.gl/docs/api-reference/carto/data-sources). */
-export async function vectorQuerySource(
-  props: VectorQuerySourceOptions
-): Promise<VectorQuerySourceResponse> {
-  const response = await _vectorQuerySource(props as _VectorQuerySourceOptions);
-  return {...response, widgetSource: new WidgetQuerySource(props)};
-}
-
-/******************************************************************************
- * H3 SOURCES
- */
-
-export type H3TableSourceOptions = WrappedSourceOptions<_H3TableSourceOptions>;
-export type H3QuerySourceOptions = WrappedSourceOptions<_H3QuerySourceOptions>;
-
-/** Wrapper adding Widget API support to [h3TableSource](https://deck.gl/docs/api-reference/carto/data-sources). */
-export async function h3TableSource(
-  props: H3TableSourceOptions
-): Promise<H3TableSourceResponse> {
-  const response = await _h3TableSource(props as _H3TableSourceOptions);
-  return {...response, widgetSource: new WidgetTableSource(props)};
-}
-
-/** Wrapper adding Widget API support to [h3QuerySource](https://deck.gl/docs/api-reference/carto/data-sources). */
-export async function h3QuerySource(
-  props: H3QuerySourceOptions
-): Promise<H3QuerySourceResponse> {
-  const response = await _h3QuerySource(props as _H3QuerySourceOptions);
-  return {...response, widgetSource: new WidgetQuerySource(props)};
-}
-
-/******************************************************************************
- * QUADBIN SOURCES
- */
-
-export type QuadbinTableSourceOptions =
-  WrappedSourceOptions<_QuadbinTableSourceOptions>;
-
-export type QuadbinQuerySourceOptions =
-  WrappedSourceOptions<_QuadbinQuerySourceOptions>;
-
-/** Wrapper adding Widget API support to [quadbinTableSource](https://deck.gl/docs/api-reference/carto/data-sources). */
-export async function quadbinTableSource(
-  props: QuadbinTableSourceOptions & WidgetBaseSourceProps
-): Promise<QuadbinTableSourceResponse> {
-  const response = await _quadbinTableSource(
-    props as _QuadbinTableSourceOptions
-  );
-  return {...response, widgetSource: new WidgetTableSource(props)};
-}
-
-/** Wrapper adding Widget API support to [quadbinQuerySource](https://deck.gl/docs/api-reference/carto/data-sources). */
-export async function quadbinQuerySource(
-  props: QuadbinQuerySourceOptions & WidgetBaseSourceProps
-): Promise<QuadbinQuerySourceResponse> {
-  const response = await _quadbinQuerySource(
-    props as _QuadbinQuerySourceOptions
-  );
-  return {...response, widgetSource: new WidgetQuerySource(props)};
-}