@carto/ps-react-maps 3.5.0-canary.1 → 3.5.0-canary.3

package/dist/types/index.d.ts

@@ -29,7 +29,7 @@ export type { ModelProps } from './models/types';
 export { CategoriesModel, useCategories } from './models/categories';
 export { FeaturesModel, useFeatures } from './models/features';
 export { FormulaModel, useFormula } from './models/formula';
-export { HistogramModel, useHistogram } from './models/histogram.';
+export { HistogramModel, useHistogram } from './models/histogram';
 export { RangeModel, useRange } from './models/range';
 export { ScatterModel, useScatter } from './models/scatter';
 export { TableModel, useTable } from './models/table';
@@ -43,7 +43,7 @@ export { MapProvider, useMapStore } from './providers/map/provider';
 export { createMapStore } from './providers/map/store';
 export type { QuerySource, Source, SourceStore, TableSource, TilesetSource, } from './providers/sources/types';
 export { clientID } from './providers/sources/const';
-export { useSourceStore } from './providers/sources/store';
+export { useSourceStore, useSource, useFilters, useSourceWithFilters, getFilterValues, } from './providers/sources/store';
 export { MapsProvider } from './provider';
 export { useEventManager } from './use-event-manager';
 export { useLayers } from './use-layers';

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

@@ -2,6 +2,6 @@ import { UseQueryOptions } from '@tanstack/react-query';
 export interface ModelProps<T, R> {
     accessToken: string;
     sourceId: string;
-    widgetProps: T;
+    widgetProps: Omit<T, 'filters'>;
     useQueryProps?: Omit<UseQueryOptions<unknown, Error, R>, 'queryKey' | 'queryFn'>;
 }

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

@@ -1,3 +1,60 @@
 import { Source, SourceStore } from './types';
-export declare const useSourceStore: import('zustand').UseBoundStore<import('zustand').StoreApi<SourceStore>>;
+import { Filters, FilterType } from '@carto/api-client';
+export declare const useSourceStore: import('zustand').UseBoundStore<Omit<import('zustand').StoreApi<SourceStore>, "setState"> & {
+    setState(partial: SourceStore | Partial<SourceStore> | ((state: SourceStore) => SourceStore | Partial<SourceStore>), replace?: false | undefined, action?: (string | {
+        [x: string]: unknown;
+        [x: number]: unknown;
+        [x: symbol]: unknown;
+        type: string;
+    }) | undefined): void;
+    setState(state: SourceStore | ((state: SourceStore) => SourceStore), replace: true, action?: (string | {
+        [x: string]: unknown;
+        [x: number]: unknown;
+        [x: symbol]: unknown;
+        type: string;
+    }) | undefined): void;
+}>;
+/**
+ * Shortcut to grabbing the source from the sources store object
+ * @param id - the id of the source you want to grab
+ * @returns source object without filters
+ */
 export declare function useSource(id: string): Source | undefined;
+/**
+ * Shortcut to grabbing the filters from the filters store object
+ * @param id - the id of the source the filters are applied to
+ * @returns filters object as used in the `@carto/api-client` methods calls
+ */
+export declare function useFilters(id: string): Filters | undefined;
+/**
+ * Returns a source together with its filters, pulling from the separate `sources` and `filters` state objects
+ * @param id - the id of the source
+ * @returns source object as used in `@carto/api-client`
+ */
+export declare function useSourceWithFilters(id: string): {
+    filters: Filters;
+    widgets?: (import('@carto/api-client').WidgetSource<import('@carto/api-client').WidgetSourceProps> | 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;
+    format?: import('@carto/api-client').Format | undefined;
+    maxLengthURL?: number | undefined;
+    spatialDataColumn?: string | undefined;
+    spatialDataType?: ("h3" | "geo" | "quadbin") | undefined;
+    tileResolution?: import('@carto/api-client').TileResolution | undefined;
+    localCache?: {
+        cache?: Map<string, Promise<unknown>>;
+        cacheControl?: ("no-cache" | "no-store")[];
+    } | undefined;
+    connectionName: string;
+    apiVersion?: import('@carto/api-client').ApiVersion | undefined;
+} | undefined;
+export declare function getFilterValues(filters: Filters | undefined, { column, type }: {
+    column: string;
+    type: FilterType;
+}): string[] | number[] | number[][];

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

@@ -47,22 +47,15 @@ export type RasterQuadbinTilesetSource = {
     rasterMetadata?: RasterMetadata;
 } & OmitTable<RasterSourceOptions>;
 export type AllRasterSource = RasterQuadbinTilesetSource;
-export type Source = (AllQuerySource | AllTilesetSource | AllTableSource | AllRasterSource) & {
+export type Source = Omit<(AllQuerySource | AllTilesetSource | AllTableSource | AllRasterSource) & {
     data: string;
     widgets?: WidgetSource<WidgetSourceProps> | null;
-    filters?: Filters;
     apiVersion?: ApiVersion;
-};
-export interface SourceFilters {
-    filters?: Record<string, Record<string, {
-        values: string[] | number[];
-        owner?: string;
-    }>>;
-}
+}, 'filters'>;
 export interface SourceStore {
     sources: Record<string, Source>;
     filters: Record<string, Filters>;
-    setSource: (id: string, source?: Partial<Omit<Source, 'filters'>>) => void;
+    setSource: (id: string, source?: Partial<Source>) => void;
     removeSource: (id: string) => void;
     setFilters: (id: string, filters: (AddFilterOptions | RemoveFilterOptions)[]) => void;
     removeFilters: (id: string, column?: RemoveFilterOptions['column'], owner?: RemoveFilterOptions['owner']) => void;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@carto/ps-react-maps",
-  "version": "3.5.0-canary.1",
+  "version": "3.5.0-canary.3",
   "description": "CARTO's Professional Service React DeckGL library",
   "type": "module",
   "dependencies": {},
   "devDependencies": {
     "@tanstack/react-query": "5.66.5",
-    "@carto/api-client": "0.5.0-alpha.14",
+    "@carto/api-client": "0.5.0",
     "@deck.gl-community/editable-layers": "9.0.3",
     "@deck.gl/aggregation-layers": "9.0.41",
     "@deck.gl/carto": "9.0.41",
@@ -32,7 +32,7 @@
   },
   "peerDependencies": {
     "@tanstack/react-query": "^5.0.0",
-    "@carto/api-client": "0.5.0-alpha.14",
+    "@carto/api-client": "0.5.0",
     "@deck.gl-community/editable-layers": "^9.0.3",
     "@deck.gl/aggregation-layers": "^9.0.0",
     "@deck.gl/carto": "^9.0.0",