@carto/api-client 0.5.0-alpha.0 → 0.5.0-alpha.2

package/build/sources/index.d.ts

@@ -1,5 +1,5 @@
 export { SOURCE_DEFAULTS } from './base-source';
-export type { GeojsonResult, JsonResult, QueryResult, QuerySourceOptions, RasterBandColorinterp, RasterMetadata, RasterMetadataBand, RasterMetadataBandStats, SourceOptions, TableSourceOptions, TilejsonResult, TilesetSourceOptions, VectorLayer, } from './types';
+export type { GeojsonResult, JsonResult, QueryResult, QuerySourceOptions, RasterBandColorinterp, RasterMetadata, RasterMetadataBand, RasterMetadataBandStats, SourceOptions, SpatialFilterPolyfillMode, TableSourceOptions, TilejsonResult, TileResolution, TilesetSourceOptions, VectorLayer, } from './types';
 export { boundaryQuerySource } from './boundary-query-source';
 export type { BoundaryQuerySourceOptions, BoundaryQuerySourceResponse, } from './boundary-query-source';
 export { boundaryTableSource } from './boundary-table-source';

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

@@ -1,3 +1,4 @@
+export * from './widget-source.js';
 export * from './widget-query-source.js';
 export * from './widget-remote-source.js';
 export * from './widget-table-source.js';

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

@@ -2,7 +2,7 @@ import { TilesetSourceOptions } from '../sources/index.js';
 import type { ModelSource } from '../models/index.js';
 import { CategoryRequestOptions, CategoryResponse, FeaturesRequestOptions, FeaturesResponse, FormulaRequestOptions, FormulaResponse, HistogramRequestOptions, HistogramResponse, RangeRequestOptions, RangeResponse, ScatterRequestOptions, ScatterResponse, TableRequestOptions, TableResponse, TimeSeriesRequestOptions, TimeSeriesResponse } from './types.js';
 import { TileFormat } from '../constants.js';
-import { SpatialFilter, Tile } from '../types.js';
+import { SpatialFilter } from '../types.js';
 import { TileFeatureExtractOptions } from '../filters/index.js';
 import { FeatureCollection } from 'geojson';
 import { SpatialDataType } from '../sources/types.js';
@@ -37,11 +37,20 @@ export type WidgetTilesetSourceResult = {
  * ```
  */
 export declare class WidgetTilesetSource extends WidgetSource<WidgetTilesetSourceProps> {
+    private _tiles;
     private _features;
     protected getModelSource(owner: string): ModelSource;
-    /** Loads features as a list of tiles (typically provided by deck.gl). */
-    loadTiles({ tiles, spatialFilter, uniqueIdProperty, options, }: {
-        tiles: Tile[];
+    /**
+     * Loads features as a list of tiles (typically provided by deck.gl).
+     * After tiles are loaded, {@link extractTileFeatures} must be called
+     * before computing statistics on the tiles.
+     */
+    loadTiles(tiles: unknown[]): void;
+    /**
+     * Extracts feature data from tiles previously loaded with {@link loadTiles}.
+     * Must be called before computing statistics on tiles.
+     */
+    extractTileFeatures({ spatialFilter, uniqueIdProperty, options, }: {
         spatialFilter: SpatialFilter;
         uniqueIdProperty?: string;
         options?: TileFeatureExtractOptions;

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.5.0-alpha.0",
+  "version": "0.5.0-alpha.2",
   "license": "MIT",
   "publishConfig": {
     "access": "public",
@@ -99,5 +99,5 @@
   "resolutions": {
     "rollup": "^4.20.0"
   },
-  "stableVersion": "0.4.4"
+  "stableVersion": "0.4.5"
 }

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

@@ -47,6 +47,7 @@ export const boundaryQuerySource = async function (
   if (queryParameters) {
     urlParameters.queryParameters = queryParameters;
   }
+
   return baseSource<UrlParameters>(
     'boundary',
     options,

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

@@ -35,6 +35,7 @@ export const boundaryTableSource = async function (
   if (filters) {
     urlParameters.filters = filters;
   }
+
   return baseSource<UrlParameters>(
     'boundary',
     options,

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

@@ -43,10 +43,13 @@ export const h3QuerySource = async function (
     queryParameters,
     filters,
   } = options;
+
+  const spatialDataType = 'h3';
+
   const urlParameters: UrlParameters = {
     aggregationExp,
     spatialDataColumn,
-    spatialDataType: 'h3',
+    spatialDataType,
     q: sqlQuery,
   };
 
@@ -59,14 +62,15 @@ export const h3QuerySource = async function (
   if (filters) {
     urlParameters.filters = filters;
   }
+
   return baseSource<UrlParameters>('query', options, urlParameters).then(
     (result) => ({
       ...(result as TilejsonResult),
       widgetSource: new WidgetQuerySource({
         ...options,
-        // NOTE: passing redundant spatialDataColumn here to apply the default value 'h3'
+        // NOTE: Parameters with default values above must be explicitly passed here.
         spatialDataColumn,
-        spatialDataType: 'h3',
+        spatialDataType,
       }),
     })
   );

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

@@ -41,11 +41,14 @@ export const h3TableSource = async function (
     tableName,
     filters,
   } = options;
+
+  const spatialDataType = 'h3';
+
   const urlParameters: UrlParameters = {
     aggregationExp,
     name: tableName,
     spatialDataColumn,
-    spatialDataType: 'h3',
+    spatialDataType,
   };
 
   if (aggregationResLevel) {
@@ -54,14 +57,15 @@ export const h3TableSource = async function (
   if (filters) {
     urlParameters.filters = filters;
   }
+
   return baseSource<UrlParameters>('table', options, urlParameters).then(
     (result) => ({
       ...(result as TilejsonResult),
       widgetSource: new WidgetTableSource({
         ...options,
-        // NOTE: passing redundant spatialDataColumn here to apply the default value 'h3'
+        // NOTE: Parameters with default values above must be explicitly passed here.
         spatialDataColumn,
-        spatialDataType: 'h3',
+        spatialDataType,
       }),
     })
   );

package/src/sources/index.ts

@@ -13,8 +13,10 @@ export type {
   RasterMetadataBand,
   RasterMetadataBandStats,
   SourceOptions,
+  SpatialFilterPolyfillMode,
   TableSourceOptions,
   TilejsonResult,
+  TileResolution,
   TilesetSourceOptions,
   VectorLayer,
 } from './types';

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

@@ -44,11 +44,14 @@ export const quadbinQuerySource = async function (
     queryParameters,
     filters,
   } = options;
+
+  const spatialDataType = 'quadbin';
+
   const urlParameters: UrlParameters = {
     aggregationExp,
     q: sqlQuery,
     spatialDataColumn,
-    spatialDataType: 'quadbin',
+    spatialDataType,
   };
 
   if (aggregationResLevel) {
@@ -60,14 +63,15 @@ export const quadbinQuerySource = async function (
   if (filters) {
     urlParameters.filters = filters;
   }
+
   return baseSource<UrlParameters>('query', options, urlParameters).then(
     (result) => ({
       ...(result as TilejsonResult),
       widgetSource: new WidgetQuerySource({
         ...options,
-        // NOTE: passing redundant spatialDataColumn here to apply the default value 'quadbin'
+        // NOTE: Parameters with default values above must be explicitly passed here.
         spatialDataColumn,
-        spatialDataType: 'quadbin',
+        spatialDataType,
       }),
     })
   );

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

@@ -43,11 +43,13 @@ export const quadbinTableSource = async function (
     filters,
   } = options;
 
+  const spatialDataType = 'quadbin';
+
   const urlParameters: UrlParameters = {
     aggregationExp,
     name: tableName,
     spatialDataColumn,
-    spatialDataType: 'quadbin',
+    spatialDataType,
   };
 
   if (aggregationResLevel) {
@@ -56,14 +58,15 @@ export const quadbinTableSource = async function (
   if (filters) {
     urlParameters.filters = filters;
   }
+
   return baseSource<UrlParameters>('table', options, urlParameters).then(
     (result) => ({
       ...(result as TilejsonResult),
       widgetSource: new WidgetTableSource({
         ...options,
-        // NOTE: passing redundant spatialDataColumn here to apply the default value 'quadbin'
+        // NOTE: Parameters with default values above must be explicitly passed here.
         spatialDataColumn,
-        spatialDataType: 'quadbin',
+        spatialDataType,
       }),
     })
   );

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

@@ -53,9 +53,11 @@ export const vectorQuerySource = async function (
     aggregationExp,
   } = options;
 
+  const spatialDataType = 'geo';
+
   const urlParameters: UrlParameters = {
     spatialDataColumn,
-    spatialDataType: 'geo',
+    spatialDataType,
     tileResolution: tileResolution.toString(),
     q: sqlQuery,
   };
@@ -72,13 +74,16 @@ export const vectorQuerySource = async function (
   if (aggregationExp) {
     urlParameters.aggregationExp = aggregationExp;
   }
+
   return baseSource<UrlParameters>('query', options, urlParameters).then(
     (result) => ({
       ...(result as TilejsonResult),
       widgetSource: new WidgetQuerySource({
         ...options,
+        // NOTE: Parameters with default values above must be explicitly passed here.
         spatialDataColumn,
-        spatialDataType: 'geo',
+        spatialDataType,
+        tileResolution,
       }),
     })
   );

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

@@ -51,10 +51,12 @@ export const vectorTableSource = async function (
     aggregationExp,
   } = options;
 
+  const spatialDataType = 'geo';
+
   const urlParameters: UrlParameters = {
     name: tableName,
     spatialDataColumn,
-    spatialDataType: 'geo',
+    spatialDataType,
     tileResolution: tileResolution.toString(),
   };
 
@@ -67,13 +69,16 @@ export const vectorTableSource = async function (
   if (aggregationExp) {
     urlParameters.aggregationExp = aggregationExp;
   }
+
   return baseSource<UrlParameters>('table', options, urlParameters).then(
     (result) => ({
       ...(result as TilejsonResult),
       widgetSource: new WidgetTableSource({
         ...options,
+        // NOTE: Parameters with default values above must be explicitly passed here.
         spatialDataColumn,
-        spatialDataType: 'geo',
+        spatialDataType,
+        tileResolution,
       }),
     })
   );

package/src/widget-sources/index.ts

@@ -1,3 +1,4 @@
+export * from './widget-source.js';
 export * from './widget-query-source.js';
 export * from './widget-remote-source.js';
 export * from './widget-table-source.js';

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

@@ -76,6 +76,7 @@ export type WidgetTilesetSourceResult = {widgetSource: WidgetTilesetSource};
  * ```
  */
 export class WidgetTilesetSource extends WidgetSource<WidgetTilesetSourceProps> {
+  private _tiles: Tile[] = [];
   private _features: FeatureData[] = [];
 
   protected override getModelSource(owner: string): ModelSource {
@@ -86,14 +87,24 @@ export class WidgetTilesetSource extends WidgetSource<WidgetTilesetSourceProps>
     };
   }
 
-  /** Loads features as a list of tiles (typically provided by deck.gl). */
-  loadTiles({
-    tiles,
+  /**
+   * Loads features as a list of tiles (typically provided by deck.gl).
+   * After tiles are loaded, {@link extractTileFeatures} must be called
+   * before computing statistics on the tiles.
+   */
+  loadTiles(tiles: unknown[]) {
+    this._tiles = tiles as Tile[];
+  }
+
+  /**
+   * Extracts feature data from tiles previously loaded with {@link loadTiles}.
+   * Must be called before computing statistics on tiles.
+   */
+  extractTileFeatures({
     spatialFilter,
     uniqueIdProperty,
     options,
   }: {
-    tiles: Tile[];
     spatialFilter: SpatialFilter;
     // TODO(cleanup): As an optional property, 'uniqueIdProperty' will be easy to forget.
     // Would it be better to configure it on the source function, rather than separately
@@ -102,7 +113,7 @@ export class WidgetTilesetSource extends WidgetSource<WidgetTilesetSourceProps>
     options?: TileFeatureExtractOptions;
   }) {
     this._features = tileFeatures({
-      tiles,
+      tiles: this._tiles,
       options,
       spatialFilter,
       uniqueIdProperty,