@carto/ps-react-maps 3.0.0-canary.2 → 3.0.0-canary.3

package/dist/types/editable/lasso-tools/const.d.ts

@@ -27,5 +27,6 @@ export declare const DEFAULT_MASK_LAYER_PROPS: {
     lineWidthUnits: string;
     getLineWidth: number;
     lineWidthMinPixels: number;
+    operation: string;
 };
 export declare const DEFAULT_LASSO_TOOLS_MODES: LassoToolsModes<LassoToolsMode>;

package/dist/types/editable/lasso-tools/lasso-tools.d.ts

@@ -21,7 +21,7 @@ import { LassoToolsControls } from './lasso-tools-control';
  * </LassoTools>
  */
 export declare function LassoTools({ children, mapId, defaultProps: { styles, labels }, layerProps, defaultType, }: LassoToolsProps & {
-    children: ReactNode;
+    children?: ReactNode;
 }): ReactNode;
 export declare namespace LassoTools {
     var Controls: typeof LassoToolsControls;

package/dist/types/editable/lasso-tools/util.d.ts

@@ -0,0 +1,4 @@
+import { LassoToolsStore } from './provider/types';
+export declare function getMaskValues({ values, }: {
+    values?: LassoToolsStore['data'][number]['values'];
+}): import('./types').LassoToolsData[];

package/dist/types/editable/measurement-tools/measurement-tools.d.ts

@@ -1,7 +1,7 @@
 import { MeasurementToolsControl } from './measurement-tools-control';
 import { MeasurementToolsProps } from './types';
 export declare function MeasurementTools({ children, mapId, defaultProps: { styles }, layerProps, textOptions, }: MeasurementToolsProps & {
-    children: React.ReactNode;
+    children?: React.ReactNode;
 }): import('react').ReactNode;
 export declare namespace MeasurementTools {
     var Controls: typeof MeasurementToolsControl;

package/dist/types/index.d.ts

@@ -43,9 +43,11 @@ export { createMapStore } from './providers/map/store';
 export type { QuerySource, Source, SourceStore, TableSource, TilesetSource, } from './providers/sources/types';
 export { ApiBaseUrl, clientID } from './providers/sources/const';
 export { useSourceStore } from './providers/sources/store';
+export { MapsProvider } from './provider';
 export { useLayers } from './use-layers';
 export { useLegend } from './use-legend';
 export { useMapScreenshot } from './use-map-screenshot';
+export { useSpatialFilter, useLassoToolsSpatialFilter, useViewportSpatialFilter, } from './use-spatial-filter';
 export type { FieldFormatter, Formatter, Formatters, ObjectToHtmlOptions, Value, } from './utils/object-to-html/types';
 export { formatterTypes } from './utils/object-to-html/const';
 export { objectToHtml } from './utils/object-to-html/object-to-html';

package/dist/types/models/categories.d.ts

@@ -1,7 +1,7 @@
 import { UseQueryResult } from '@tanstack/react-query';
 import { CategoryRequestOptions, CategoryResponse } from '@carto/api-client';
 import { ModelProps } from './types';
-export declare function useCategories({ accessToken, sourceId, widgetProps, useQueryProps, }: ModelProps<CategoryRequestOptions, CategoryResponse>): UseQueryResult<CategoryResponse, Error>;
+export declare function useCategories({ accessToken, sourceId, widgetProps, useQueryProps: { enabled, ...useQueryProps }, }: ModelProps<CategoryRequestOptions, CategoryResponse>): UseQueryResult<CategoryResponse, Error>;
 export declare function CategoriesModel({ children, ...modelProps }: ModelProps<CategoryRequestOptions, CategoryResponse> & {
     children: (props: UseQueryResult<CategoryResponse, Error>) => React.ReactNode;
 }): import('react').ReactNode;

package/dist/types/models/features.d.ts

@@ -1,7 +1,7 @@
 import { UseQueryResult } from '@tanstack/react-query';
 import { FeaturesRequestOptions, FeaturesResponse } from '@carto/api-client';
 import { ModelProps } from './types';
-export declare function useFeatures({ accessToken, sourceId, widgetProps, useQueryProps, }: ModelProps<FeaturesRequestOptions, FeaturesResponse>): UseQueryResult<FeaturesResponse, Error>;
+export declare function useFeatures({ accessToken, sourceId, widgetProps, useQueryProps: { enabled, ...useQueryProps }, }: ModelProps<FeaturesRequestOptions, FeaturesResponse>): UseQueryResult<FeaturesResponse, Error>;
 export declare function FeaturesModel({ children, ...modelProps }: ModelProps<FeaturesRequestOptions, FeaturesResponse> & {
     children: (props: UseQueryResult<FeaturesResponse, Error>) => React.ReactNode;
 }): import('react').ReactNode;

package/dist/types/models/formula.d.ts

@@ -1,7 +1,7 @@
 import { UseQueryResult } from '@tanstack/react-query';
 import { FormulaRequestOptions, FormulaResponse } from '@carto/api-client';
 import { ModelProps } from './types';
-export declare function useFormula({ accessToken, sourceId, widgetProps, useQueryProps, }: ModelProps<FormulaRequestOptions, FormulaResponse>): UseQueryResult<FormulaResponse, Error>;
+export declare function useFormula({ accessToken, sourceId, widgetProps, useQueryProps: { enabled, ...useQueryProps }, }: ModelProps<FormulaRequestOptions, FormulaResponse>): UseQueryResult<FormulaResponse, Error>;
 export declare function FormulaModel({ children, ...modelProps }: ModelProps<FormulaRequestOptions, FormulaResponse> & {
     children: (props: UseQueryResult<FormulaResponse, Error>) => React.ReactNode;
 }): import('react').ReactNode;

package/dist/types/models/histogram..d.ts

@@ -1,7 +1,7 @@
 import { UseQueryResult } from '@tanstack/react-query';
 import { HistogramRequestOptions, HistogramResponse } from '@carto/api-client';
 import { ModelProps } from './types';
-export declare function useHistogram({ accessToken, sourceId, widgetProps, useQueryProps, }: ModelProps<HistogramRequestOptions, HistogramResponse>): UseQueryResult<HistogramResponse, Error>;
+export declare function useHistogram({ accessToken, sourceId, widgetProps, useQueryProps: { enabled, ...useQueryProps }, }: ModelProps<HistogramRequestOptions, HistogramResponse>): UseQueryResult<HistogramResponse, Error>;
 export declare function HistogramModel({ children, ...modelProps }: ModelProps<HistogramRequestOptions, HistogramResponse> & {
     children: (props: UseQueryResult<HistogramResponse, Error>) => React.ReactNode;
 }): import('react').ReactNode;

package/dist/types/models/range.d.ts

@@ -1,7 +1,7 @@
 import { UseQueryResult } from '@tanstack/react-query';
 import { RangeRequestOptions, RangeResponse } from '@carto/api-client';
 import { ModelProps } from './types';
-export declare function useRange({ accessToken, sourceId, widgetProps, useQueryProps, }: ModelProps<RangeRequestOptions, RangeResponse>): UseQueryResult<RangeResponse, Error>;
+export declare function useRange({ accessToken, sourceId, widgetProps, useQueryProps: { enabled, ...useQueryProps }, }: ModelProps<RangeRequestOptions, RangeResponse>): UseQueryResult<RangeResponse, Error>;
 export declare function RangeModel({ children, ...modelProps }: ModelProps<RangeRequestOptions, RangeResponse> & {
     children: (props: UseQueryResult<RangeResponse, Error>) => React.ReactNode;
 }): import('react').ReactNode;

package/dist/types/models/scatter.d.ts

@@ -1,7 +1,7 @@
 import { UseQueryResult } from '@tanstack/react-query';
 import { ScatterRequestOptions, ScatterResponse } from '@carto/api-client';
 import { ModelProps } from './types';
-export declare function useScatter({ accessToken, sourceId, widgetProps, useQueryProps, }: ModelProps<ScatterRequestOptions, ScatterResponse>): UseQueryResult<ScatterResponse, Error>;
+export declare function useScatter({ accessToken, sourceId, widgetProps, useQueryProps: { enabled, ...useQueryProps }, }: ModelProps<ScatterRequestOptions, ScatterResponse>): UseQueryResult<ScatterResponse, Error>;
 export declare function ScatterModel({ children, ...modelProps }: ModelProps<ScatterRequestOptions, ScatterResponse> & {
     children: (props: UseQueryResult<ScatterResponse, Error>) => React.ReactNode;
 }): import('react').ReactNode;

package/dist/types/models/table.d.ts

@@ -1,7 +1,7 @@
 import { UseQueryResult } from '@tanstack/react-query';
 import { TableRequestOptions, TableResponse } from '@carto/api-client';
 import { ModelProps } from './types';
-export declare function useTable({ accessToken, sourceId, widgetProps, useQueryProps, }: ModelProps<TableRequestOptions, TableResponse>): UseQueryResult<TableResponse, Error>;
+export declare function useTable({ accessToken, sourceId, widgetProps, useQueryProps: { enabled, ...useQueryProps }, }: ModelProps<TableRequestOptions, TableResponse>): UseQueryResult<TableResponse, Error>;
 export declare function TableModel({ children, ...modelProps }: ModelProps<TableRequestOptions, TableResponse> & {
     children: (props: UseQueryResult<TableResponse, Error>) => React.ReactNode;
 }): import('react').ReactNode;

package/dist/types/models/time-series.d.ts

@@ -1,7 +1,7 @@
 import { UseQueryResult } from '@tanstack/react-query';
 import { TimeSeriesRequestOptions, TimeSeriesResponse } from '@carto/api-client';
 import { ModelProps } from './types';
-export declare function useTimeSeries({ accessToken, sourceId, widgetProps, useQueryProps, }: ModelProps<TimeSeriesRequestOptions, TimeSeriesResponse>): UseQueryResult<TimeSeriesResponse, Error>;
+export declare function useTimeSeries({ accessToken, sourceId, widgetProps, useQueryProps: { enabled, ...useQueryProps }, }: ModelProps<TimeSeriesRequestOptions, TimeSeriesResponse>): UseQueryResult<TimeSeriesResponse, Error>;
 export declare function TimeSeriesModel({ children, ...modelProps }: ModelProps<TimeSeriesRequestOptions, TimeSeriesResponse> & {
     children: (props: UseQueryResult<TimeSeriesResponse, Error>) => React.ReactNode;
 }): import('react').ReactNode;

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

@@ -1 +1 @@
-export declare function useWidgetModel(accessToken: string, sourceId: string): import('@carto/api-client').WidgetRemoteSource<import('node_modules/@carto/api-client/build/widget-sources/widget-source').WidgetSourceProps> | null;
+export declare function useWidgetModel(accessToken: string, sourceId: string): import('@carto/api-client').WidgetRemoteSource<import('@carto/api-client').WidgetSourceProps> | null;

package/dist/types/provider.d.ts

@@ -0,0 +1,11 @@
+import { PropsWithChildren } from 'react';
+import { MapProviderProps } from './providers/map/types';
+import { LassoToolsProviderProps } from './editable/lasso-tools/provider/types';
+import { MeasurementToolsProviderProps } from './editable/measurement-tools/provider/types';
+interface Props {
+    maps: MapProviderProps['values'];
+    lassoTools?: LassoToolsProviderProps['values'];
+    measureTools?: MeasurementToolsProviderProps['values'];
+}
+export declare function MapsProvider({ children, maps, lassoTools, measureTools, }: PropsWithChildren<Props>): import("react/jsx-runtime").JSX.Element;
+export {};

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

@@ -1,19 +1,58 @@
-import { WidgetRemoteSource, WidgetRemoteSourceProps, VectorQuerySourceOptions, VectorTableSourceOptions, VectorTilesetSourceOptions, TileFormat } from '@carto/api-client';
+import { WidgetRemoteSource, WidgetRemoteSourceProps, VectorQuerySourceOptions, VectorTableSourceOptions, VectorTilesetSourceOptions, TileFormat, BoundaryQuerySourceOptions, BoundaryTableSourceOptions, H3QuerySourceOptions, QuadbinQuerySourceOptions, H3TilesetSourceOptions, QuadbinTilesetSourceOptions, H3TableSourceOptions, QuadbinTableSourceOptions, RasterSourceOptions, RasterMetadata } from '@carto/api-client';
+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>;
 export type QuerySource = {
     type: 'query';
-} & Omit<VectorQuerySourceOptions, 'accessToken' | 'sqlQuery'>;
+} & OmitQuery<VectorQuerySourceOptions>;
+export type H3QuerySource = {
+    type: 'query+h3';
+} & OmitQuery<H3QuerySourceOptions>;
+export type QuadbinQuerySource = {
+    type: 'query+quadbin';
+} & OmitQuery<QuadbinQuerySourceOptions>;
+export type BoundaryQuerySource = {
+    type: 'query+boundary';
+} & _Omit<BoundaryQuerySourceOptions, 'tilesetTableName'>;
+export type AllQuerySource = QuerySource | H3QuerySource | QuadbinQuerySource | BoundaryQuerySource;
 export type TilesetSource = {
     type: 'tileset';
     tileFormat: TileFormat;
-} & Omit<VectorTilesetSourceOptions, 'accessToken' | 'tableName'>;
+} & OmitTable<VectorTilesetSourceOptions>;
+export type H3TilesetSource = {
+    type: 'tileset+h3';
+    tileFormat: TileFormat;
+} & OmitTable<H3TilesetSourceOptions>;
+export type QuadbinTilesetSource = {
+    type: 'tileset+quadbin';
+    tileFormat: TileFormat;
+} & OmitTable<QuadbinTilesetSourceOptions>;
+export type AllTilesetSource = TilesetSource | H3TilesetSource | QuadbinTilesetSource;
 export type TableSource = {
     type: 'table';
-} & Omit<VectorTableSourceOptions, 'accessToken' | 'tableName'>;
-export type Source = (QuerySource | TilesetSource | TableSource) & {
+} & OmitTable<VectorTableSourceOptions>;
+export type h3TableSource = {
+    type: 'table+h3';
+} & OmitTable<H3TableSourceOptions>;
+export type QuadbinTableSource = {
+    type: 'table+quadbin';
+} & OmitTable<QuadbinTableSourceOptions>;
+export type BoundaryTableSource = {
+    type: 'table+boundary';
+} & _Omit<BoundaryTableSourceOptions, 'tilesetTableName'>;
+export type AllTableSource = TableSource | h3TableSource | QuadbinTableSource | BoundaryTableSource;
+export type RasterQuadbinTilesetSource = {
+    type: 'raster';
+    tileFormat: TileFormat;
+    rasterMetadata?: RasterMetadata;
+} & OmitTable<RasterSourceOptions>;
+export type AllRasterSource = RasterQuadbinTilesetSource;
+export type Source = (AllQuerySource | AllTilesetSource | AllTableSource | AllRasterSource) & {
     data: string;
-    widgets?: WidgetRemoteSource<WidgetRemoteSourceProps>;
+    widgets?: WidgetRemoteSource<WidgetRemoteSourceProps> | null;
 };
 export interface SourceStore {
     sources: Record<string, Source>;
     setSource: (id: string, source?: Partial<Source>) => void;
 }
+export {};

package/dist/types/types.d.ts

@@ -1,5 +1,5 @@
 import { Class, ValueOf } from 'type-fest';
-import { MutableRefObject, ReactNode, RefObject } from 'react';
+import { ReactNode, RefObject } from 'react';
 import { Layer, LayerProps, MapViewState, PickingInfo, ViewStateChangeParameters } from '@deck.gl/core';
 import { DeckGLProps, DeckGLRef } from '@deck.gl/react';
 import { MapRef } from 'react-map-gl/maplibre';
@@ -9,7 +9,7 @@ import { ViewStateSlice } from './providers/map/types';
 export * from '../types/common';
 export type BasemapKey = keyof typeof CartoBasemaps | keyof typeof GmapsBasemap;
 export type BasemapType = ValueOf<typeof MapsTypes>;
-export interface Tooltip extends PickingInfo {
+export interface Tooltip<T = unknown> extends PickingInfo<T> {
     text?: string | undefined;
     html?: string | undefined;
     className?: string | undefined;
@@ -17,7 +17,7 @@ export interface Tooltip extends PickingInfo {
 }
 export interface LayerType<T extends Class<Layer> = Class<Layer>, P extends LayerProps = LayerProps> {
     type: T | null;
-    props?: Partial<P>;
+    props: Partial<P>;
 }
 export type InstanceRef = DeckGLRef;
 export type OverlayRef = MapRef | google.maps.Map | null | undefined;
@@ -28,7 +28,7 @@ export type GmapsProps = Omit<MapProps, 'mapTypeId'> & {
 export interface DeckGLComponentProps extends Omit<DeckGLProps, 'layers' | 'onLoad'> {
     basemap?: BasemapKey;
     instanceRef?: RefObject<InstanceRef>;
-    overlayRef?: MutableRefObject<OverlayRef>;
+    overlayRef?: RefObject<OverlayRef>;
     layers: LayerType[];
     gmapsProps?: GmapsProps;
     onLoad?: (value: boolean) => void;
@@ -43,7 +43,7 @@ export interface LayersLoadedProps {
     id: MapComponentProps['id'];
 }
 export interface ZoomControl {
-    id: MapComponentProps['id'];
+    mapId: MapComponentProps['id'];
     children: (props: ZoomControlChildrenProps) => ReactNode;
 }
 export interface ZoomControlChildrenProps {

package/dist/types/use-layers.d.ts

@@ -1,4 +1,4 @@
 import { MapComponentProps } from './types';
-export declare function useLayers({ id }: {
-    id: MapComponentProps['id'];
+export declare function useLayers({ mapId }: {
+    mapId: MapComponentProps['id'];
 }): import('.').Layer[];

package/dist/types/use-spatial-filter.d.ts

@@ -0,0 +1,15 @@
+import { MapComponentProps } from './types';
+import { SpatialFilter } from '@carto/api-client';
+export declare function useSpatialFilter({ mapId, }: {
+    mapId: MapComponentProps['id'];
+}): {
+    spatialFilter: SpatialFilter | undefined;
+    lassoToolsSpatialFilter: SpatialFilter | undefined;
+    viewportSpatialFilter: SpatialFilter | undefined;
+};
+export declare function useViewportSpatialFilter({ mapId, }: {
+    mapId: MapComponentProps['id'];
+}): SpatialFilter | undefined;
+export declare function useLassoToolsSpatialFilter({ mapId, }: {
+    mapId: MapComponentProps['id'];
+}): import('geojson').MultiPolygon | undefined;

package/dist/types/zoom-controls.d.ts

@@ -1,2 +1,2 @@
 import { ZoomControl } from './types';
-export declare function ZoomControls({ children, id }: ZoomControl): import('react').ReactNode;
+export declare function ZoomControls({ children, mapId }: ZoomControl): import('react').ReactNode;

package/package.json

@@ -1,37 +1,38 @@
 {
   "name": "@carto/ps-react-maps",
-  "version": "3.0.0-canary.2",
+  "version": "3.0.0-canary.3",
   "description": "CARTO's Professional Service React DeckGL library",
   "type": "module",
   "dependencies": {
-    "@turf/turf": "7.1.0"
+    "@turf/turf": "7.2.0"
   },
   "devDependencies": {
-    "@tanstack/react-query": "5.61.0",
-    "@carto/api-client": "0.5.0-alpha.0",
+    "@tanstack/react-query": "5.64.2",
+    "@carto/api-client": "0.5.0-alpha.3",
     "@deck.gl-community/editable-layers": "9.0.3",
-    "@deck.gl/aggregation-layers": "9.0.38",
-    "@deck.gl/carto": "9.0.38",
-    "@deck.gl/core": "9.0.38",
-    "@deck.gl/extensions": "9.0.38",
-    "@deck.gl/geo-layers": "9.0.38",
-    "@deck.gl/google-maps": "9.0.38",
-    "@deck.gl/layers": "9.0.38",
-    "@deck.gl/mesh-layers": "9.0.38",
-    "@deck.gl/react": "9.0.38",
+    "@deck.gl/aggregation-layers": "9.0.40",
+    "@deck.gl/carto": "9.0.40",
+    "@deck.gl/core": "9.0.40",
+    "@deck.gl/extensions": "9.0.40",
+    "@deck.gl/geo-layers": "9.0.40",
+    "@deck.gl/google-maps": "9.0.40",
+    "@deck.gl/layers": "9.0.40",
+    "@deck.gl/mesh-layers": "9.0.40",
+    "@deck.gl/react": "9.0.40",
+    "@turf/helpers": "7.2.0",
     "@types/geojson": "7946.0.15",
-    "@vis.gl/react-google-maps": "1.4.3",
+    "@vis.gl/react-google-maps": "1.5.0",
     "convert-units": "3.0.0-beta.7",
     "html2canvas": "1.4.1",
     "maplibre-gl": "4.7.1",
     "react-map-gl": "7.1.8",
     "zustand": "5.0.3",
-    "@carto/ps-utils": "2.0.0-canary.2"
+    "@carto/ps-utils": "2.0.0-canary.3"
   },
   "peerDependencies": {
     "@tanstack/react-query": "^5.61.0",
-    "@carto/api-client": "^0.5.0-alpha.0",
-    "@deck.gl-community/editable-layers": "^9.0.0",
+    "@carto/api-client": "^0.5.0-alpha.1",
+    "@deck.gl-community/editable-layers": "^9.0.3",
     "@deck.gl/aggregation-layers": "^9.0.0",
     "@deck.gl/carto": "^9.0.0",
     "@deck.gl/core": "^9.0.0",
@@ -41,6 +42,7 @@
     "@deck.gl/layers": "^9.0.0",
     "@deck.gl/mesh-layers": "^9.0.0",
     "@deck.gl/react": "^9.0.0",
+    "@turf/helpers": "^7.2.0",
     "@vis.gl/react-google-maps": "^1.0.0",
     "convert-units": "3.0.0-beta.7",
     "html2canvas": "^1.4.1",
@@ -48,7 +50,7 @@
     "react": "^18.0.0 || ^19.0.0",
     "react-map-gl": "^7.1.8",
     "zustand": "^5.0.0",
-    "@carto/ps-utils": "2.0.0-canary.2"
+    "@carto/ps-utils": "2.0.0-canary.3"
   },
   "exports": {
     ".": {