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

package/src/types-internal.ts

@@ -1,9 +1,62 @@
 /******************************************************************************
- * INTERNAL
+ * COMMON
  */
 
+import {Format} from './types';
+
 /** @internal */
 export type $TODO = any;
 
 /** @internal */
 export type $IntentionalAny = any;
+
+/******************************************************************************
+ * MAP INSTANTIATION
+ */
+
+/**
+ * @internalRemarks Source: @deck.gl/carto
+ * @internal
+ */
+export enum SchemaFieldType {
+  Number = 'number',
+  Bigint = 'bigint',
+  String = 'string',
+  Geometry = 'geometry',
+  Timestamp = 'timestamp',
+  Object = 'object',
+  Boolean = 'boolean',
+  Variant = 'variant',
+  Unknown = 'unknown',
+}
+
+/**
+ * @internalRemarks Source: @deck.gl/carto
+ * @internal
+ */
+export interface SchemaField {
+  name: string;
+  type: SchemaFieldType; // Field type in the CARTO stack, common for all providers
+}
+
+/**
+ * @internalRemarks Source: @deck.gl/carto
+ * @internal
+ */
+export interface MapInstantiation extends MapInstantiationFormats {
+  nrows: number;
+  size?: number;
+  schema: SchemaField[];
+}
+
+/**
+ * @internalRemarks Source: @deck.gl/carto
+ * @internal
+ */
+type MapInstantiationFormats = Record<
+  Format,
+  {
+    url: string[];
+    error?: any;
+  }
+>;

package/src/types.ts

@@ -1,6 +1,16 @@
 import type {FilterType} from './constants.js';
 import type {Polygon, MultiPolygon} from 'geojson';
 
+/******************************************************************************
+ * MAPS AND TILES
+ */
+
+/** @internalRemarks Source: @deck.gl/carto */
+export type Format = 'json' | 'geojson' | 'tilejson';
+
+/** @internalRemarks Source: @carto/constants, @deck.gl/carto */
+export type MapType = 'boundary' | 'query' | 'table' | 'tileset' | 'raster';
+
 /******************************************************************************
  * AGGREGATION
  */
@@ -26,6 +36,12 @@ export type AggregationType =
 /** @internalRemarks Source: @carto/react-api */
 export type SpatialFilter = Polygon | MultiPolygon;
 
+/** @internalRemarks Source: @deck.gl/carto */
+export interface Filters {
+  [column: string]: Filter;
+}
+
+// TODO: Would `{[FilterType.IN]?: number[] | string[]}` also be valid?
 /** @internalRemarks Source: @carto/react-api, @deck.gl/carto */
 export interface Filter {
   [FilterType.IN]?: {owner?: string; values: number[] | string[]};

package/src/widget-sources/widget-base-source.ts

@@ -17,14 +17,14 @@ import {
 } from './types.js';
 import {FilterLogicalOperator, Filter} from '../types.js';
 import {getApplicableFilters, normalizeObjectKeys} from '../utils.js';
-import {
-  DEFAULT_API_BASE_URL,
-  DEFAULT_GEO_COLUMN,
-  ApiVersion,
-} from '../constants-internal.js';
 import {getClient} from '../client.js';
 import {ModelSource} from '../models/model.js';
 import {SourceOptions} from '../sources/index.js';
+import {
+  ApiVersion,
+  DEFAULT_API_BASE_URL,
+  DEFAULT_GEO_COLUMN,
+} from '../constants.js';
 
 export interface WidgetBaseSourceProps extends Omit<SourceOptions, 'filters'> {
   apiVersion?: ApiVersion;

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

@@ -3,7 +3,6 @@ import {
   QuadbinQuerySourceOptions,
   VectorQuerySourceOptions,
 } from '../sources/index.js';
-import {MapType} from '../constants-internal.js';
 import {WidgetBaseSource, WidgetBaseSourceProps} from './widget-base-source.js';
 import {ModelSource} from '../models/model.js';
 
@@ -40,7 +39,7 @@ export class WidgetQuerySource extends WidgetBaseSource<
   protected override getModelSource(owner: string): ModelSource {
     return {
       ...super._getModelSource(owner),
-      type: MapType.QUERY,
+      type: 'query',
       data: this.props.sqlQuery,
       queryParameters: this.props.queryParameters,
     };

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

@@ -4,7 +4,6 @@ import {
   VectorTableSourceOptions,
 } from '../sources/index.js';
 import {WidgetBaseSource, WidgetBaseSourceProps} from './widget-base-source.js';
-import {MapType} from '../constants-internal.js';
 import {ModelSource} from '../models/model.js';
 
 type LayerTableSourceOptions =
@@ -40,7 +39,7 @@ export class WidgetTableSource extends WidgetBaseSource<
   protected override getModelSource(owner: string): ModelSource {
     return {
       ...super._getModelSource(owner),
-      type: MapType.TABLE,
+      type: 'table',
       data: this.props.tableName,
     };
   }

package/src/widget-sources/wrappers.ts

@@ -11,7 +11,6 @@ import {
   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';

package/build/api/types.d.ts

@@ -1,227 +0,0 @@
-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 declare 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;
-}
-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 declare 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>;
-};
-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;
-};
-export type GoogleBasemapProps = {
-    mapTypeId: string;
-    mapId?: string;
-    center?: {
-        lat: number;
-        lng: number;
-    };
-    zoom?: number;
-    tilt?: number;
-    heading?: number;
-};
-export {};

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