@carto/ps-react-maps 4.4.0 → 4.5.0

package/dist/types/index.d.ts

@@ -43,7 +43,7 @@ export type { MapProviderProps, MapStore, ViewportRect, } from './providers/map/
 export { transitionFlyConfig } from './providers/map/const';
 export { MapProvider, useMapStore } from './providers/map/provider';
 export { createMapStore } from './providers/map/store';
-export type { Source, SourceStore, QuerySource, TableSource, TilesetSource, RasterSource, } from './providers/sources/types';
+export type { Source, SourceStore, QuerySource, TableSource, TilesetSource, RasterSource, GeoJSONSource, AllSources, AllExternalSources, } from './providers/sources/types';
 export { clientID } from './providers/sources/const';
 export { useSourceStore, useSource, useFilters, useSourceWithFilters, getFilterValues, } from './providers/sources/store';
 export { MapsProvider } from './provider';

package/dist/types/models/utils/use-common-model.d.ts

@@ -1,6 +1,8 @@
 import { ModelProps } from '../types';
-export declare function useCommonModel<TRequestOptions, TResponse>({ accessToken, sourceId, widgetProps, additionalFilter, }: Pick<ModelProps<TRequestOptions, TResponse>, 'accessToken' | 'sourceId' | 'additionalFilter' | 'widgetProps'>): {
+export declare function useCommonModel<TRequestOptions, TResponse>({ queryKeyPrefix, accessToken, sourceId, widgetProps, additionalFilter, }: Pick<ModelProps<TRequestOptions, TResponse>, 'accessToken' | 'sourceId' | 'additionalFilter' | 'widgetProps'> & {
+    queryKeyPrefix: string[];
+}): {
     mergedFilters: {} | undefined;
-    widgetModel: import('@carto/api-client').WidgetSource<import('@carto/api-client').WidgetSourceProps & (import('../..').QuerySource | import('../..').TilesetSource | import('../..').TableSource | import('../../providers/sources/types').RasterQuadbinTilesetSource)> | null;
+    widgetModel: import('@carto/api-client').WidgetQuerySource | import('@carto/api-client').WidgetTilesetSource<import('@carto/api-client').WidgetTilesetSourceProps> | import('@carto/api-client').WidgetTableSource | null;
     queryKey: unknown[];
 };

package/dist/types/models/utils/use-query-key.d.ts

@@ -0,0 +1,4 @@
+import { ModelProps } from '../types';
+export declare function useQueryKey<TRequestOptions, TResponse>({ queryKeyPrefix, accessToken, sourceId, }: Pick<ModelProps<TRequestOptions, TResponse>, 'accessToken' | 'sourceId'> & {
+    queryKeyPrefix: string[];
+}): unknown[];

package/dist/types/models/utils/use-widget-model.d.ts

@@ -1 +1 @@
-export declare function useWidgetModel(accessToken: string, sourceId: string): import('@carto/api-client').WidgetSource<import('@carto/api-client').WidgetSourceProps & (import('../..').QuerySource | import('../..').TilesetSource | import('../..').TableSource | import('../../providers/sources/types').RasterQuadbinTilesetSource)> | null;
+export declare function useWidgetModel(accessToken: string, sourceId: string): import('@carto/api-client').WidgetQuerySource | import('@carto/api-client').WidgetTilesetSource<import('@carto/api-client').WidgetTilesetSourceProps> | import('@carto/api-client').WidgetTableSource | null;

package/dist/types/providers/sources/store.d.ts

@@ -1,5 +1,5 @@
-import { QuerySource, TableSource, TilesetSource, Source, SourceStore } from './types';
-import { Filters, FilterType, SpatialDataType } from '@carto/api-client';
+import { Source, SourceStore, AllExternalSources, AllSources } from './types';
+import { Filters, FilterType } from '@carto/api-client';
 export declare const useSourceStore: import('zustand').UseBoundStore<Omit<import('zustand').StoreApi<SourceStore>, "setState" | "devtools"> & {
     setState(partial: SourceStore | Partial<SourceStore> | ((state: SourceStore) => SourceStore | Partial<SourceStore>), replace?: false | undefined, action?: (string | {
         [x: string]: unknown;
@@ -22,7 +22,7 @@ export declare const useSourceStore: import('zustand').UseBoundStore<Omit<import
  * @param id - the id of the source you want to grab
  * @returns source object without filters
  */
-export declare function useSource(id: string): Source<QuerySource | TilesetSource | TableSource | import('./types').RasterQuadbinTilesetSource> | undefined;
+export declare function useSource<T extends AllSources = AllExternalSources>(id: string): Source<T>;
 /**
  * Shortcut to grabbing the filters from the filters store object
  * @param id - the id of the source the filters are applied to
@@ -34,29 +34,10 @@ export declare function useFilters(id: string): Filters | undefined;
  * @param id - the id of the source
  * @returns source object as used in `@carto/api-client`
  */
-export declare function useSourceWithFilters(id: string): {
+export declare function useSourceWithFilters<T extends AllSources = AllExternalSources>(id: string): (Omit<T, "filters"> & {
     filters: Filters;
-    widgets?: import('@carto/api-client').WidgetSource<import('@carto/api-client').WidgetSourceProps & (QuerySource | TilesetSource | TableSource | import('./types').RasterQuadbinTilesetSource)> | null | undefined;
-    type: "table" | "query" | "query+h3" | "query+quadbin" | "query+boundary" | "tileset" | "tileset+h3" | "tileset+quadbin" | "table+h3" | "table+quadbin" | "table+boundary" | "raster";
-    data: string;
-    apiBaseUrl?: string | undefined;
-    headers?: Record<string, string> | undefined;
-    cache?: {
-        value?: number;
-    } | undefined;
-    clientId?: string | undefined;
-    maxLengthURL?: number | undefined;
-    spatialDataColumn?: string | undefined;
-    spatialDataType?: SpatialDataType | undefined;
-    tileResolution?: import('@carto/api-client').TileResolution | undefined;
-    localCache?: {
-        cache?: Map<string, Promise<unknown>>;
-        cacheControl?: ("no-cache" | "no-store")[];
-    } | undefined;
-    tags?: Record<string, string> | undefined;
-    connectionName: string;
-    apiVersion?: import('@carto/api-client').ApiVersion | undefined;
-} | undefined;
+    id: string;
+}) | undefined;
 export declare function getFilterValues(filters: Filters | undefined, { column, type }: {
     column: string;
     type: FilterType;

package/dist/types/providers/sources/types.d.ts

@@ -1,5 +1,14 @@
-import { VectorQuerySourceOptions, VectorTableSourceOptions, VectorTilesetSourceOptions, TileFormat, BoundaryQuerySourceOptions, BoundaryTableSourceOptions, H3QuerySourceOptions, QuadbinQuerySourceOptions, H3TilesetSourceOptions, QuadbinTilesetSourceOptions, H3TableSourceOptions, QuadbinTableSourceOptions, RasterSourceOptions, RasterMetadata, WidgetSource, WidgetSourceProps, Filters, AddFilterOptions, RemoveFilterOptions, ApiVersion } from '@carto/api-client';
-import { BBox } from 'geojson';
+import { VectorQuerySourceOptions, VectorTableSourceOptions, VectorTilesetSourceOptions, TileFormat, BoundaryQuerySourceOptions, BoundaryTableSourceOptions, H3QuerySourceOptions, QuadbinQuerySourceOptions, H3TilesetSourceOptions, QuadbinTilesetSourceOptions, H3TableSourceOptions, QuadbinTableSourceOptions, RasterSourceOptions, RasterMetadata, Filters, AddFilterOptions, RemoveFilterOptions, ApiVersion, WidgetQuerySource, WidgetTilesetSource, WidgetTableSource, WidgetRasterSource } from '@carto/api-client';
+import { BBox, Feature } from 'geojson';
+import { WidgetGeoJsonSource } from './widgets/widget-geojson-source';
+interface ExternalData {
+    data: string;
+    apiVersion?: ApiVersion;
+    apiBaseUrl?: string;
+}
+interface WithWidgets<T> {
+    widgets?: T | null;
+}
 type _Omit<T, P extends string = ''> = Omit<T, 'accessToken' | P>;
 type OmitQuery<T, P extends string = ''> = _Omit<T, 'sqlQuery' | P>;
 type OmitTable<T, P extends string = ''> = _Omit<T, 'tableName' | P>;
@@ -15,7 +24,7 @@ export type QuadbinQuerySource = {
 export type BoundaryQuerySource = {
     type: 'query+boundary';
 } & _Omit<BoundaryQuerySourceOptions, 'propertiesSqlQuery'>;
-export type QuerySource = VectorQuerySource | H3QuerySource | QuadbinQuerySource | BoundaryQuerySource;
+export type QuerySource = (VectorQuerySource | H3QuerySource | QuadbinQuerySource | BoundaryQuerySource) & ExternalData & WithWidgets<WidgetQuerySource>;
 export type VectorTilesetSource = {
     type: 'tileset';
 } & OmitTable<VectorTilesetSourceOptions>;
@@ -25,7 +34,7 @@ export type H3TilesetSource = {
 export type QuadbinTilesetSource = {
     type: 'tileset+quadbin';
 } & OmitTable<QuadbinTilesetSourceOptions>;
-export type TilesetSource = (VectorTilesetSource | H3TilesetSource | QuadbinTilesetSource) & {
+export type TilesetSource = (VectorTilesetSource | H3TilesetSource | QuadbinTilesetSource) & ExternalData & WithWidgets<WidgetTilesetSource> & {
     tileFormat: TileFormat;
     spatialDataBounds: BBox;
 };
@@ -41,24 +50,27 @@ export type QuadbinTableSource = {
 export type BoundaryTableSource = {
     type: 'table+boundary';
 } & _Omit<BoundaryTableSourceOptions, 'propertiesTableName'>;
-export type TableSource = VectorTableSource | H3TableSource | QuadbinTableSource | BoundaryTableSource;
+export type TableSource = (VectorTableSource | H3TableSource | QuadbinTableSource | BoundaryTableSource) & ExternalData & WithWidgets<WidgetTableSource>;
 export type RasterQuadbinTilesetSource = {
     type: 'raster';
     tileFormat: TileFormat;
     rasterMetadata?: RasterMetadata;
     spatialDataBounds: BBox;
 } & OmitTable<RasterSourceOptions>;
-export type RasterSource = RasterQuadbinTilesetSource;
-export type Source<T extends QuerySource | TilesetSource | TableSource | RasterSource = QuerySource | TilesetSource | TableSource | RasterSource> = Omit<T & {
-    data: string;
-    widgets?: WidgetSource<WidgetSourceProps & T> | null;
-    apiVersion?: ApiVersion;
-    apiBaseUrl?: string;
-}, 'filters'>;
+export type RasterSource = RasterQuadbinTilesetSource & ExternalData & WithWidgets<WidgetRasterSource>;
+export type GeoJSONSource = {
+    type: 'geojson';
+    data: Feature[];
+} & WithWidgets<WidgetGeoJsonSource>;
+export type AllExternalSources = QuerySource | TilesetSource | TableSource | RasterSource;
+export type AllSources = AllExternalSources | GeoJSONSource;
+export type Source<T extends AllSources = AllSources> = Omit<T, 'filters'> & {
+    id: string;
+};
 export interface SourceStore {
     sources: Record<string, Source>;
     filters: Record<string, Filters>;
-    setSource: <T extends Source>(id: string, source: Partial<T>) => void;
+    setSource: <T extends AllSources>(id: string, source: Partial<Source<T>>) => void;
     removeSource: (id: string) => void;
     setFilters: (id: string, filters: AddFilterOptions[]) => void;
     removeFilters: (id: string, column?: RemoveFilterOptions['column'], owner?: RemoveFilterOptions['owner']) => void;

package/dist/types/providers/sources/widgets/const.d.ts

@@ -0,0 +1,13 @@
+export declare const Method: {
+    readonly INIT: "init";
+    readonly LOAD_GEOJSON: "loadGeoJSON";
+    readonly GET_FORMULA: "getFormula";
+    readonly GET_HISTOGRAM: "getHistogram";
+    readonly GET_CATEGORIES: "getCategories";
+    readonly GET_SCATTER: "getScatter";
+    readonly GET_TABLE: "getTable";
+    readonly GET_TIME_SERIES: "getTimeSeries";
+    readonly GET_RANGE: "getRange";
+    readonly GET_AGGREGATIONS: "getAggregations";
+    readonly GET_EXTENT: "getExtent";
+};

package/dist/types/providers/sources/widgets/geojson-features.d.ts

@@ -0,0 +1,5 @@
+import { FeatureData } from './types';
+export declare function geojsonFeatures({ geojson, uniqueIdProperty, }: {
+    geojson: FeatureData[];
+    uniqueIdProperty?: string;
+}): FeatureData[];

package/dist/types/providers/sources/widgets/types.d.ts

@@ -0,0 +1,17 @@
+import { Feature, GeoJsonProperties, Geometry } from 'geojson';
+import { Method } from './const';
+export interface WorkerRequest {
+    requestId?: number;
+    method: (typeof Method)[keyof typeof Method];
+    params: unknown[];
+}
+export type WorkerResponse = {
+    requestId: number;
+    ok: true;
+    result: unknown;
+} | {
+    requestId: number;
+    ok: false;
+    error: string;
+};
+export type FeatureData = Feature<Geometry, GeoJsonProperties>;

package/dist/types/providers/sources/widgets/widget-geojson-source-impl.d.ts

@@ -0,0 +1,33 @@
+import { WidgetSource, AggregationsRequestOptions, AggregationsResponse, CategoryRequestOptions, CategoryResponse, ExtentResponse, FeaturesResponse, FormulaRequestOptions, FormulaResponse, HistogramRequestOptions, HistogramResponse, RangeRequestOptions, RangeResponse, ScatterRequestOptions, ScatterResponse, SpatialFilter, TableRequestOptions, TableResponse, TimeSeriesRequestOptions, TimeSeriesResponse } from '@carto/api-client';
+import { WidgetGeoJsonSourceProps } from './widget-geojson-source';
+import { FeatureData } from './types';
+/**
+ * Local (in-memory) implementation of geojson widget calculations. This class
+ * may be instantiated by {@link WidgetGeoJsonSource} in a Web Worker when
+ * supported, or on the main thread.
+ */
+export declare class WidgetGeoJsonSourceImpl extends WidgetSource<WidgetGeoJsonSourceProps> {
+    private features;
+    protected _filterFeaturesBySpatial(spatialFilter?: SpatialFilter): FeatureData[];
+    /**
+     * Loads features as GeoJSON.
+     */
+    loadGeoJSON({ geojson }: {
+        geojson: FeatureData[];
+    }): void;
+    getFeatures(): Promise<FeaturesResponse>;
+    getFormula({ column, operation, joinOperation, filters, filterOwner, spatialFilter, }: FormulaRequestOptions): Promise<FormulaResponse>;
+    getHistogram({ operation, ticks, column, joinOperation, filters, filterOwner, spatialFilter, }: HistogramRequestOptions): Promise<HistogramResponse>;
+    getCategories({ column, operation, operationColumn, joinOperation, filters, filterOwner, spatialFilter, othersThreshold, orderBy, rawResult, }: CategoryRequestOptions): Promise<CategoryResponse>;
+    getScatter({ xAxisColumn, yAxisColumn, xAxisJoinOperation, yAxisJoinOperation, filters, filterOwner, spatialFilter, }: ScatterRequestOptions): Promise<ScatterResponse>;
+    getTable({ columns, searchFilterColumn, searchFilterText, sortBy, sortDirection, sortByColumnType, offset, limit, filters, filterOwner, spatialFilter, }: TableRequestOptions): Promise<TableResponse>;
+    getTimeSeries({ column, stepSize, operation, operationColumn, joinOperation, filters, filterOwner, spatialFilter, }: TimeSeriesRequestOptions): Promise<TimeSeriesResponse>;
+    getRange({ column, filters, filterOwner, spatialFilter, }: RangeRequestOptions): Promise<RangeResponse>;
+    getAggregations({ aggregations, filters, filterOwner, spatialFilter, }: AggregationsRequestOptions): Promise<AggregationsResponse>;
+    /** @experimental */
+    getExtent(): Promise<ExtentResponse>;
+    /****************************************************************************
+     * INTERNAL
+     */
+    private _getFilteredFeatures;
+}

package/dist/types/providers/sources/widgets/widget-geojson-source.d.ts

@@ -0,0 +1,49 @@
+import { WidgetSource, AggregationsRequestOptions, AggregationsResponse, CategoryRequestOptions, CategoryResponse, ExtentResponse, FeaturesResponse, FormulaRequestOptions, FormulaResponse, HistogramRequestOptions, HistogramResponse, RangeRequestOptions, RangeResponse, ScatterRequestOptions, ScatterResponse, SpatialFilter, TableRequestOptions, TableResponse, TilesetSourceOptions, TimeSeriesRequestOptions, TimeSeriesResponse, WidgetSourceProps } from '@carto/api-client';
+import { Feature } from 'geojson';
+import { Method } from './const';
+import { WidgetGeoJsonSourceImpl } from './widget-geojson-source-impl';
+import { FeatureData } from './types';
+export type WidgetGeoJsonSourceProps = WidgetSourceProps & Omit<TilesetSourceOptions, 'filters' | 'tableName'> & {
+    data: Feature[] | string;
+};
+export interface WidgetGeoJsonSourceResult {
+    widgetSource: WidgetGeoJsonSource;
+}
+/**
+ * Source for Widget API requests on a data source defined by a geojson.
+ */
+export declare class WidgetGeoJsonSource<Props extends WidgetGeoJsonSourceProps = WidgetGeoJsonSourceProps> extends WidgetSource<Props> {
+    protected _localImpl: WidgetGeoJsonSourceImpl | null;
+    protected _workerImpl: Worker | null;
+    protected _workerEnabled: boolean;
+    protected _workerNextRequestId: number;
+    constructor(props: Props);
+    destroy(): void;
+    /**
+     * Returns an initialized Worker, to be reused for the lifecycle of this
+     * source instance.
+     */
+    protected _getWorker(): Worker;
+    /** Executes a given method on the worker. */
+    protected _executeWorkerMethod<T>(method: (typeof Method)[keyof typeof Method], params: unknown[], signal?: AbortSignal): Promise<T>;
+    /**
+     * Loads features as GeoJSON
+     */
+    loadGeoJSON({ geojson }: {
+        geojson: FeatureData[];
+    }): void;
+    getFeatures(): Promise<FeaturesResponse>;
+    getFormula({ signal, ...options }: FormulaRequestOptions): Promise<FormulaResponse>;
+    getHistogram({ signal, ...options }: HistogramRequestOptions): Promise<HistogramResponse>;
+    getCategories({ signal, ...options }: CategoryRequestOptions): Promise<CategoryResponse>;
+    getScatter({ signal, ...options }: ScatterRequestOptions): Promise<ScatterResponse>;
+    getTable({ signal, ...options }: TableRequestOptions): Promise<TableResponse>;
+    getTimeSeries({ signal, ...options }: TimeSeriesRequestOptions): Promise<TimeSeriesResponse>;
+    getRange({ signal, ...options }: RangeRequestOptions): Promise<RangeResponse>;
+    getAggregations({ signal, ...options }: AggregationsRequestOptions): Promise<AggregationsResponse>;
+    /** @experimental */
+    getExtent({ signal, ...options }: {
+        signal?: AbortSignal;
+        spatialFilter?: SpatialFilter;
+    }): Promise<ExtentResponse>;
+}

package/dist/types/providers/sources/widgets/widget-geojson-worker.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@carto/ps-react-maps",
-  "version": "4.4.0",
+  "version": "4.5.0",
   "description": "CARTO's Professional Service React DeckGL library",
   "type": "module",
   "dependencies": {},