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

package/build/index.d.ts

@@ -4,8 +4,7 @@ export * from './filters.js';
 export * from './geo.js';
 export * from './widget-sources/index.js';
 export * from './types.js';
-export { APIErrorContext, Format, // TODO: Move to `types.ts`?
-MapType, // TODO: De-duplicate?
-RequestType, // TODO: Move to `types.ts`?
-QueryParameters, // TODO: Move to `types.ts`?
-QueryOptions, } from './api/index.js';
+export { APIErrorContext, APIRequestType, CartoAPIError, QueryOptions, buildPublicMapUrl, // Internal, but required for fetchMap().
+buildStatsUrl, // Internal, but required for fetchMap().
+query, requestWithParameters, } from './api/index.js';
+export { BoundaryQuerySourceOptions, BoundaryTableSourceOptions, GeojsonResult, H3QuerySourceOptions, H3TableSourceOptions, H3TilesetSourceOptions, JsonResult, QuadbinQuerySourceOptions, QuadbinTableSourceOptions, QuadbinTilesetSourceOptions, QueryResult, QuerySourceOptions, RasterSourceOptions, SOURCE_DEFAULTS, SourceOptions, TableSourceOptions, TilejsonResult, TilesetSourceOptions, VectorQuerySourceOptions, VectorTableSourceOptions, VectorTilesetSourceOptions, boundaryQuerySource, boundaryTableSource, h3QuerySource, h3TableSource, h3TilesetSource, quadbinQuerySource, quadbinTableSource, quadbinTilesetSource, rasterSource, vectorQuerySource, vectorTableSource, vectorTilesetSource, } from './sources/index.js';

package/build/models/model.d.ts

@@ -1,6 +1,6 @@
-import { ApiVersion, MapType } from '../constants-internal.js';
-import { Filter, FilterLogicalOperator, QueryParameters, SpatialFilter } from '../types.js';
+import { Filter, FilterLogicalOperator, MapType, QueryParameters, SpatialFilter } from '../types.js';
 import { ModelRequestOptions } from './common.js';
+import { ApiVersion } from '../constants.js';
 /** @internalRemarks Source: @carto/react-api */
 declare const AVAILABLE_MODELS: readonly ["category", "histogram", "formula", "timeseries", "range", "scatterplot", "table"];
 export type Model = (typeof AVAILABLE_MODELS)[number];

package/build/sources/base-source.d.ts

@@ -1,4 +1,4 @@
-import type { MapType } from '../api/types';
 import type { GeojsonResult, JsonResult, SourceOptionalOptions, SourceRequiredOptions, TilejsonResult } from './types';
+import { MapType } from '../types';
 export declare const SOURCE_DEFAULTS: SourceOptionalOptions;
 export declare function baseSource<UrlParameters extends Record<string, unknown>>(endpoint: MapType, options: Partial<SourceOptionalOptions> & SourceRequiredOptions, urlParameters: UrlParameters): Promise<TilejsonResult | GeojsonResult | JsonResult>;

package/build/sources/boundary-query-source.d.ts

@@ -1,4 +1,4 @@
-import { QueryParameters } from '../api/index';
+import { QueryParameters } from '../types.js';
 import type { FilterOptions, SourceOptions, TilejsonResult } from './types';
 export type BoundaryQuerySourceOptions = SourceOptions & FilterOptions & {
     columns?: string[];

package/build/sources/h3-query-source.d.ts

@@ -1,3 +1,4 @@
+import { WidgetQuerySourceResult } from '../widget-sources';
 import type { AggregationOptions, FilterOptions, QuerySourceOptions, SourceOptions, TilejsonResult } from './types';
 export type H3QuerySourceOptions = SourceOptions & QuerySourceOptions & AggregationOptions & FilterOptions;
-export declare const h3QuerySource: (options: H3QuerySourceOptions) => Promise<TilejsonResult>;
+export declare const h3QuerySource: (options: H3QuerySourceOptions) => Promise<TilejsonResult & WidgetQuerySourceResult>;

package/build/sources/h3-table-source.d.ts

@@ -1,3 +1,4 @@
+import { WidgetTableSourceResult } from '../widget-sources';
 import type { AggregationOptions, FilterOptions, SourceOptions, TableSourceOptions, TilejsonResult } from './types';
 export type H3TableSourceOptions = SourceOptions & TableSourceOptions & AggregationOptions & FilterOptions;
-export declare const h3TableSource: (options: H3TableSourceOptions) => Promise<TilejsonResult>;
+export declare const h3TableSource: (options: H3TableSourceOptions) => Promise<TilejsonResult & WidgetTableSourceResult>;

package/build/sources/index.d.ts

@@ -1,5 +1,5 @@
 export { SOURCE_DEFAULTS } from './base-source';
-export type { TilejsonResult, GeojsonResult, JsonResult } from './types';
+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';

package/build/sources/quadbin-query-source.d.ts

@@ -1,3 +1,4 @@
+import { WidgetQuerySourceResult } from '../widget-sources';
 import type { AggregationOptions, FilterOptions, QuerySourceOptions, SourceOptions, TilejsonResult } from './types';
 export type QuadbinQuerySourceOptions = SourceOptions & QuerySourceOptions & AggregationOptions & FilterOptions;
-export declare const quadbinQuerySource: (options: QuadbinQuerySourceOptions) => Promise<TilejsonResult>;
+export declare const quadbinQuerySource: (options: QuadbinQuerySourceOptions) => Promise<TilejsonResult & WidgetQuerySourceResult>;

package/build/sources/quadbin-table-source.d.ts

@@ -1,3 +1,4 @@
+import { WidgetTableSourceResult } from '../widget-sources';
 import type { AggregationOptions, FilterOptions, SourceOptions, TableSourceOptions, TilejsonResult } from './types';
 export type QuadbinTableSourceOptions = SourceOptions & TableSourceOptions & AggregationOptions & FilterOptions;
-export declare const quadbinTableSource: (options: QuadbinTableSourceOptions) => Promise<TilejsonResult>;
+export declare const quadbinTableSource: (options: QuadbinTableSourceOptions) => Promise<TilejsonResult & WidgetTableSourceResult>;

package/build/sources/types.d.ts

@@ -1,5 +1,6 @@
 import type { Feature } from 'geojson';
-import type { Filters, Format, MapInstantiation, QueryParameters } from '../api/types';
+import { Filters, Format, QueryParameters } from '../types';
+import { MapInstantiation } from '../types-internal';
 export type SourceRequiredOptions = {
     /** Carto platform access token. */
     accessToken: string;

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

@@ -1,3 +1,4 @@
+import { WidgetQuerySourceResult } from '../widget-sources/index.js';
 import type { FilterOptions, SourceOptions, QuerySourceOptions, TilejsonResult, ColumnsOption } from './types';
 export type VectorQuerySourceOptions = SourceOptions & QuerySourceOptions & FilterOptions & ColumnsOption;
-export declare const vectorQuerySource: (options: VectorQuerySourceOptions) => Promise<TilejsonResult>;
+export declare const vectorQuerySource: (options: VectorQuerySourceOptions) => Promise<TilejsonResult & WidgetQuerySourceResult>;

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

@@ -1,3 +1,4 @@
+import { WidgetTableSourceResult } from '../widget-sources/index.js';
 import type { FilterOptions, ColumnsOption, SourceOptions, TableSourceOptions, TilejsonResult } from './types';
 export type VectorTableSourceOptions = SourceOptions & TableSourceOptions & FilterOptions & ColumnsOption;
-export declare const vectorTableSource: (options: VectorTableSourceOptions) => Promise<TilejsonResult>;
+export declare const vectorTableSource: (options: VectorTableSourceOptions) => Promise<TilejsonResult & WidgetTableSourceResult>;

package/build/types-internal.d.ts

@@ -1,7 +1,52 @@
 /******************************************************************************
- * 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 declare 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;
+}
+/**
+ * @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;
+}>;
+export {};

package/build/types.d.ts

@@ -1,5 +1,12 @@
 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
  */
@@ -15,6 +22,10 @@ export type AggregationType = 'count' | 'avg' | 'min' | 'max' | 'sum' | 'custom'
  */
 /** @internalRemarks Source: @carto/react-api */
 export type SpatialFilter = Polygon | MultiPolygon;
+/** @internalRemarks Source: @deck.gl/carto */
+export interface Filters {
+    [column: string]: Filter;
+}
 /** @internalRemarks Source: @carto/react-api, @deck.gl/carto */
 export interface Filter {
     [FilterType.IN]?: {

package/build/widget-sources/index.d.ts

@@ -1,5 +1,4 @@
 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';

package/build/widget-sources/widget-base-source.d.ts

@@ -1,8 +1,8 @@
 import { CategoryRequestOptions, CategoryResponse, FormulaRequestOptions, FormulaResponse, HistogramRequestOptions, HistogramResponse, RangeRequestOptions, RangeResponse, ScatterRequestOptions, ScatterResponse, TableRequestOptions, TableResponse, TimeSeriesRequestOptions, TimeSeriesResponse } from './types.js';
 import { FilterLogicalOperator, Filter } from '../types.js';
-import { ApiVersion } from '../constants-internal.js';
 import { ModelSource } from '../models/model.js';
 import { SourceOptions } from '../sources/index.js';
+import { ApiVersion } from '../constants.js';
 export interface WidgetBaseSourceProps extends Omit<SourceOptions, 'filters'> {
     apiVersion?: ApiVersion;
     geoColumn?: string;

package/build/widget-sources/widget-query-source.d.ts

@@ -2,6 +2,9 @@ import { H3QuerySourceOptions, QuadbinQuerySourceOptions, VectorQuerySourceOptio
 import { WidgetBaseSource, WidgetBaseSourceProps } from './widget-base-source.js';
 import { ModelSource } from '../models/model.js';
 type LayerQuerySourceOptions = Omit<VectorQuerySourceOptions, 'filters'> | Omit<H3QuerySourceOptions, 'filters'> | Omit<QuadbinQuerySourceOptions, 'filters'>;
+export type WidgetQuerySourceResult = {
+    widgetSource: WidgetQuerySource;
+};
 /**
  * Source for Widget API requests on a data source defined by a SQL query.
  *

package/build/widget-sources/widget-table-source.d.ts

@@ -2,6 +2,9 @@ import { H3TableSourceOptions, QuadbinTableSourceOptions, VectorTableSourceOptio
 import { WidgetBaseSource, WidgetBaseSourceProps } from './widget-base-source.js';
 import { ModelSource } from '../models/model.js';
 type LayerTableSourceOptions = Omit<VectorTableSourceOptions, 'filters'> | Omit<H3TableSourceOptions, 'filters'> | Omit<QuadbinTableSourceOptions, 'filters'>;
+export type WidgetTableSourceResult = {
+    widgetSource: WidgetTableSource;
+};
 /**
  * Source for Widget API requests on a data source defined as a table.
  *

package/package.json

@@ -4,7 +4,7 @@
   "repository": "github:CartoDB/carto-api-client",
   "author": "Don McCurdy <donmccurdy@carto.com>",
   "packageManager": "yarn@4.3.1",
-  "version": "0.4.0-alpha.0",
+  "version": "0.4.0-alpha.3",
   "license": "MIT",
   "publishConfig": {
     "access": "public",
@@ -34,7 +34,7 @@
     "dev": "concurrently \"yarn build:watch\" \"vite --config examples/vite.config.ts --open\"",
     "test": "vitest run --typecheck",
     "test:watch": "vitest watch --typecheck",
-    "coverage": "vitest run --coverage",
+    "coverage": "vitest run --coverage.enabled --coverage.all false",
     "lint": "prettier \"**/*.{cjs,html,js,json,md,ts}\" --ignore-path ./.eslintignore --check",
     "format": "prettier \"**/*.{cjs,html,js,json,md,ts}\" --ignore-path ./.eslintignore --write",
     "clean": "rimraf build/*",

package/src/api/carto-api-error.ts

@@ -2,7 +2,23 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-import type {APIErrorContext} from './types';
+import {MapType} from '../types';
+
+export type APIRequestType =
+  | 'Map data'
+  | 'Map instantiation'
+  | 'Public map'
+  | 'Tile stats'
+  | 'SQL'
+  | 'Basemap style';
+
+export type APIErrorContext = {
+  requestType: APIRequestType;
+  mapId?: string;
+  connection?: string;
+  source?: string;
+  type?: MapType;
+};
 
 /**
  *

package/src/api/endpoints.ts

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-import {MapType} from './types';
+import {MapType} from '../types.js';
 
 export type V3Endpoint = 'maps' | 'stats' | 'sql';
 
@@ -21,6 +21,7 @@ function buildV3Path(
   return joinPath(apiBaseUrl, version, endpoint, ...rest);
 }
 
+/** @internal Required by fetchMap(). */
 export function buildPublicMapUrl({
   apiBaseUrl,
   cartoMapId,
@@ -31,6 +32,7 @@ export function buildPublicMapUrl({
   return buildV3Path(apiBaseUrl, 'v3', 'maps', 'public', cartoMapId);
 }
 
+/** @internal Required by fetchMap(). */
 export function buildStatsUrl({
   attribute,
   apiBaseUrl,

package/src/api/index.ts

@@ -2,16 +2,13 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-export {CartoAPIError} from './carto-api-error';
-export type {
+export {
+  CartoAPIError,
   APIErrorContext,
-  Format,
-  MapType,
-  RequestType,
-  QueryParameters,
-  Basemap,
-  MapLibreBasemap,
-  GoogleBasemap,
-} from './types';
-export {query} from './query';
-export type {QueryOptions} from './query';
+  APIRequestType,
+} from './carto-api-error.js';
+// Internal, but required for fetchMap().
+export {buildPublicMapUrl, buildStatsUrl} from './endpoints.js';
+export {query} from './query.js';
+export type {QueryOptions} from './query.js';
+export {requestWithParameters} from './request-with-parameters.js';

package/src/api/query.ts

@@ -10,7 +10,7 @@ import type {
 } from '../sources/types';
 import {buildQueryUrl} from './endpoints';
 import {requestWithParameters} from './request-with-parameters';
-import {APIErrorContext} from './types';
+import {APIErrorContext} from './carto-api-error';
 
 export type QueryOptions = SourceOptions &
   Omit<QuerySourceOptions, 'spatialDataColumn'>;

package/src/api/request-with-parameters.ts

@@ -3,13 +3,9 @@
 // Copyright (c) vis.gl contributors
 
 import {isPureObject} from '../utils';
-import {CartoAPIError} from './carto-api-error';
-import type {APIErrorContext} from './types';
-import {
-  DEFAULT_CLIENT,
-  DEFAULT_MAX_LENGTH_URL,
-  V3_MINOR_VERSION,
-} from '../constants';
+import {CartoAPIError, APIErrorContext} from './carto-api-error';
+import {V3_MINOR_VERSION} from '../constants-internal';
+import {DEFAULT_CLIENT, DEFAULT_MAX_LENGTH_URL} from '../constants';
 
 const DEFAULT_HEADERS = {
   Accept: 'application/json',
@@ -36,7 +32,7 @@ export async function requestWithParameters<T = any>({
   // user-provided parameters.
   parameters = {
     v: V3_MINOR_VERSION,
-    clientId: DEFAULT_CLIENT,
+    client: DEFAULT_CLIENT,
     ...(typeof deck !== 'undefined' &&
       deck.VERSION && {deckglVersion: deck.VERSION}),
     ...parameters,

package/src/constants-internal.ts

@@ -1,45 +1,24 @@
 /******************************************************************************
- * DEFAULTS
+ * VERSIONS
  */
 
 /**
- * @internalRemarks Source: @carto/constants
+ * Current version of @carto/api-client.
  * @internal
  */
-export const DEFAULT_API_BASE_URL = 'https://gcp-us-east1.api.carto.com';
+export const API_CLIENT_VERSION = __CARTO_API_CLIENT_VERSION;
 
-/**
- * @internalRemarks Source: @carto/constants
- * @internal
- */
-export const DEFAULT_CLIENT = 'deck-gl-carto';
-
-/**
- * @internalRemarks Source: @carto/react-api
- * @internal
- */
-export const DEFAULT_GEO_COLUMN = 'geom';
-
-/******************************************************************************
- * ENUMS
- */
+/** @internal */
+export const V3_MINOR_VERSION = '3.4';
 
 /**
+ * @internalRemarks Source: @deck.gl/carto
  * @internal
- * @internalRemarks Source: @carto/constants
  */
-export enum MapType {
-  TABLE = 'table',
-  QUERY = 'query',
-  TILESET = 'tileset',
-}
+export const DEFAULT_AGGREGATION_RES_LEVEL_H3 = 4;
 
 /**
+ * @internalRemarks Source: @deck.gl/carto
  * @internal
- * @internalRemarks Source: @carto/constants
  */
-export enum ApiVersion {
-  V1 = 'v1',
-  V2 = 'v2',
-  V3 = 'v3',
-}
+export const DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN = 6;

package/src/constants.ts

@@ -1,19 +1,3 @@
-/** Current version of @carto/api-client. */
-export const API_CLIENT_VERSION = __CARTO_API_CLIENT_VERSION;
-
-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;
-
-export const DEFAULT_TILE_SIZE = 512;
-export const DEFAULT_TILE_RESOLUTION = 0.5;
-
-export const DEFAULT_AGGREGATION_RES_LEVEL_H3 = 4;
-export const DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN = 6;
-
 /**
  * Defines a comparator used when matching a column's values against given filter values.
  *
@@ -37,3 +21,35 @@ export enum FilterType {
   TIME = 'time',
   STRING_SEARCH = 'stringSearch',
 }
+
+/** @internalRemarks Source: @carto/constants */
+export enum ApiVersion {
+  V1 = 'v1',
+  V2 = 'v2',
+  V3 = 'v3',
+}
+
+/******************************************************************************
+ * DEFAULTS
+ */
+
+/** @internalRemarks Source: @carto/constants, @deck.gl/carto */
+export const DEFAULT_API_BASE_URL = 'https://gcp-us-east1.api.carto.com';
+
+/** @internalRemarks Source: @carto/constants, @deck.gl/carto */
+export const DEFAULT_CLIENT = 'deck-gl-carto';
+
+/** @internalRemarks Source: @carto/constants, @deck.gl/carto */
+export const DEFAULT_GEO_COLUMN = 'geom';
+
+/**
+ * Fastly default limit is 8192; leave some padding.
+ * @internalRemarks Source: @deck.gl/carto
+ */
+export const DEFAULT_MAX_LENGTH_URL = 7000;
+
+/** @internalRemarks Source: @deck.gl/carto */
+export const DEFAULT_TILE_SIZE = 512;
+
+/** @internalRemarks Source: @deck.gl/carto */
+export const DEFAULT_TILE_RESOLUTION = 0.5;

package/src/index.ts

@@ -7,9 +7,47 @@ export * from './types.js';
 
 export {
   APIErrorContext,
-  Format, // TODO: Move to `types.ts`?
-  MapType, // TODO: De-duplicate?
-  RequestType, // TODO: Move to `types.ts`?
-  QueryParameters, // TODO: Move to `types.ts`?
-  QueryOptions, // TODO: Move to `types.ts`?
+  APIRequestType,
+  CartoAPIError,
+  QueryOptions,
+  buildPublicMapUrl, // Internal, but required for fetchMap().
+  buildStatsUrl, // Internal, but required for fetchMap().
+  query,
+  requestWithParameters,
 } from './api/index.js';
+
+export {
+  BoundaryQuerySourceOptions,
+  BoundaryTableSourceOptions,
+  GeojsonResult,
+  H3QuerySourceOptions,
+  H3TableSourceOptions,
+  H3TilesetSourceOptions,
+  JsonResult,
+  QuadbinQuerySourceOptions,
+  QuadbinTableSourceOptions,
+  QuadbinTilesetSourceOptions,
+  QueryResult,
+  QuerySourceOptions,
+  RasterSourceOptions,
+  SOURCE_DEFAULTS,
+  SourceOptions,
+  TableSourceOptions,
+  TilejsonResult,
+  TilesetSourceOptions,
+  VectorQuerySourceOptions,
+  VectorTableSourceOptions,
+  VectorTilesetSourceOptions,
+  boundaryQuerySource,
+  boundaryTableSource,
+  h3QuerySource,
+  h3TableSource,
+  h3TilesetSource,
+  quadbinQuerySource,
+  quadbinTableSource,
+  quadbinTilesetSource,
+  rasterSource,
+  vectorQuerySource,
+  vectorTableSource,
+  vectorTilesetSource,
+} from './sources/index.js';

package/src/models/model.ts

@@ -1,17 +1,15 @@
-import {
-  ApiVersion,
-  DEFAULT_GEO_COLUMN,
-  MapType,
-} from '../constants-internal.js';
+import {DEFAULT_GEO_COLUMN} from '../constants.js';
 import {
   Filter,
   FilterLogicalOperator,
+  MapType,
   QueryParameters,
   SpatialFilter,
 } from '../types.js';
 import {$TODO} from '../types-internal.js';
 import {assert} from '../utils.js';
 import {ModelRequestOptions, makeCall} from './common.js';
+import {ApiVersion} from '../constants.js';
 
 /** @internalRemarks Source: @carto/react-api */
 const AVAILABLE_MODELS = [
@@ -72,7 +70,7 @@ export function executeModel(props: {
   assert(apiBaseUrl, 'executeModel: missing apiBaseUrl');
   assert(accessToken, 'executeModel: missing accessToken');
   assert(apiVersion === V3, 'executeModel: SQL Model API requires CARTO 3+');
-  assert(type !== MapType.TILESET, 'executeModel: Tilesets not supported');
+  assert(type !== 'tileset', 'executeModel: Tilesets not supported');
 
   let url = `${apiBaseUrl}/v3/sql/${connectionName}/model/${model}`;
 

package/src/sources/base-source.ts

@@ -10,7 +10,6 @@ import {
 } from '../constants';
 import {buildSourceUrl} from '../api/endpoints';
 import {requestWithParameters} from '../api/request-with-parameters';
-import type {APIErrorContext, MapType} from '../api/types';
 import type {
   GeojsonResult,
   JsonResult,
@@ -19,6 +18,8 @@ import type {
   TilejsonMapInstantiation,
   TilejsonResult,
 } from './types';
+import {MapType} from '../types';
+import {APIErrorContext} from '../api';
 
 export const SOURCE_DEFAULTS: SourceOptionalOptions = {
   apiBaseUrl: DEFAULT_API_BASE_URL,

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

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-import {QueryParameters} from '../api/index';
+import {QueryParameters} from '../types.js';
 import {baseSource} from './base-source';
 import type {FilterOptions, SourceOptions, TilejsonResult} from './types';
 

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

@@ -3,7 +3,8 @@
 // Copyright (c) vis.gl contributors
 
 /* eslint-disable camelcase */
-import {DEFAULT_AGGREGATION_RES_LEVEL_H3} from '../constants';
+import {DEFAULT_AGGREGATION_RES_LEVEL_H3} from '../constants-internal';
+import {WidgetQuerySource, WidgetQuerySourceResult} from '../widget-sources';
 import {baseSource} from './base-source';
 import type {
   AggregationOptions,
@@ -30,7 +31,7 @@ type UrlParameters = {
 
 export const h3QuerySource = async function (
   options: H3QuerySourceOptions
-): Promise<TilejsonResult> {
+): Promise<TilejsonResult & WidgetQuerySourceResult> {
   const {
     aggregationExp,
     aggregationResLevel = DEFAULT_AGGREGATION_RES_LEVEL_H3,
@@ -55,9 +56,10 @@ export const h3QuerySource = async function (
   if (filters) {
     urlParameters.filters = filters;
   }
-  return baseSource<UrlParameters>(
-    'query',
-    options,
-    urlParameters
-  ) as Promise<TilejsonResult>;
+  return baseSource<UrlParameters>('query', options, urlParameters).then(
+    (result) => ({
+      ...(result as TilejsonResult),
+      widgetSource: new WidgetQuerySource(options),
+    })
+  );
 };

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

@@ -3,7 +3,8 @@
 // Copyright (c) vis.gl contributors
 
 /* eslint-disable camelcase */
-import {DEFAULT_AGGREGATION_RES_LEVEL_H3} from '../constants';
+import {DEFAULT_AGGREGATION_RES_LEVEL_H3} from '../constants-internal';
+import {WidgetTableSource, WidgetTableSourceResult} from '../widget-sources';
 import {baseSource} from './base-source';
 import type {
   AggregationOptions,
@@ -30,7 +31,7 @@ type UrlParameters = {
 
 export const h3TableSource = async function (
   options: H3TableSourceOptions
-): Promise<TilejsonResult> {
+): Promise<TilejsonResult & WidgetTableSourceResult> {
   const {
     aggregationExp,
     aggregationResLevel = DEFAULT_AGGREGATION_RES_LEVEL_H3,
@@ -51,9 +52,10 @@ export const h3TableSource = async function (
   if (filters) {
     urlParameters.filters = filters;
   }
-  return baseSource<UrlParameters>(
-    'table',
-    options,
-    urlParameters
-  ) as Promise<TilejsonResult>;
+  return baseSource<UrlParameters>('table', options, urlParameters).then(
+    (result) => ({
+      ...(result as TilejsonResult),
+      widgetSource: new WidgetTableSource(options),
+    })
+  );
 };