@carto/ps-react-maps 4.0.3 → 4.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +1868 -2212
- package/dist/index.js.map +1 -1
- package/dist/types/index.d.ts +2 -1
- package/dist/types/models/aggregations.d.ts +5 -0
- package/dist/types/models/categories.d.ts +4 -6
- package/dist/types/models/features.d.ts +4 -6
- package/dist/types/models/formula.d.ts +4 -6
- package/dist/types/models/histogram.d.ts +4 -6
- package/dist/types/models/range.d.ts +4 -6
- package/dist/types/models/scatter.d.ts +4 -6
- package/dist/types/models/table.d.ts +4 -6
- package/dist/types/models/time-series.d.ts +4 -6
- package/dist/types/models/utils/create-model.d.ts +17 -0
- package/dist/types/models/{use-common-model.d.ts → utils/use-common-model.d.ts} +3 -3
- package/dist/types/models/{use-filters-merged.d.ts → utils/use-filters-merged.d.ts} +1 -1
- package/dist/types/models/utils/use-widget-model.d.ts +1 -0
- package/package.json +5 -5
- package/dist/types/models/use-widget-model.d.ts +0 -1
package/dist/types/index.d.ts
CHANGED
|
@@ -27,6 +27,7 @@ export { CustomEditableGeojsonLayer } from './editable/custom-editable-geojson-l
|
|
|
27
27
|
export { getCursorDefault, getTooltipDefault } from './helpers';
|
|
28
28
|
export { MapComponent } from './maps/map';
|
|
29
29
|
export type { ModelProps } from './models/types';
|
|
30
|
+
export { AggregationsModel, useAggregations } from './models/aggregations';
|
|
30
31
|
export { CategoriesModel, useCategories } from './models/categories';
|
|
31
32
|
export { FeaturesModel, useFeatures } from './models/features';
|
|
32
33
|
export { FormulaModel, useFormula } from './models/formula';
|
|
@@ -35,7 +36,7 @@ export { RangeModel, useRange } from './models/range';
|
|
|
35
36
|
export { ScatterModel, useScatter } from './models/scatter';
|
|
36
37
|
export { TableModel, useTable } from './models/table';
|
|
37
38
|
export { TimeSeriesModel, useTimeSeries } from './models/time-series';
|
|
38
|
-
export { useWidgetModel } from './models/use-widget-model';
|
|
39
|
+
export { useWidgetModel } from './models/utils/use-widget-model';
|
|
39
40
|
export type { Layer, LayerStore, LayerLegend, LayerGroup, } from './providers/layers/types';
|
|
40
41
|
export { useLayerStore } from './providers/layers/store';
|
|
41
42
|
export type { MapProviderProps, MapStore, ViewportRect, } from './providers/map/types';
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import { AggregationsRequestOptions, AggregationsResponse } from '@carto/api-client';
|
|
2
|
+
declare const useAggregations: ({ accessToken, sourceId, widgetProps, additionalFilter, useQueryProps: { enabled, ...useQueryProps }, }: import('./types').ModelProps<AggregationsRequestOptions, AggregationsResponse>) => import('@tanstack/react-query').UseQueryResult<AggregationsResponse, Error>, AggregationsModel: ({ children, ...modelProps }: import('./types').ModelProps<AggregationsRequestOptions, AggregationsResponse> & {
|
|
3
|
+
children: (props: import('@tanstack/react-query').UseQueryResult<AggregationsResponse, Error>) => React.ReactNode;
|
|
4
|
+
}) => import('react').ReactNode;
|
|
5
|
+
export { useAggregations, AggregationsModel };
|
|
@@ -1,7 +1,5 @@
|
|
|
1
|
-
import { UseQueryResult } from '@tanstack/react-query';
|
|
2
1
|
import { CategoryRequestOptions, CategoryResponse } from '@carto/api-client';
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
}): import('react').ReactNode;
|
|
2
|
+
declare const useCategories: ({ accessToken, sourceId, widgetProps, additionalFilter, useQueryProps: { enabled, ...useQueryProps }, }: import('./types').ModelProps<CategoryRequestOptions, CategoryResponse>) => import('@tanstack/react-query').UseQueryResult<CategoryResponse, Error>, CategoriesModel: ({ children, ...modelProps }: import('./types').ModelProps<CategoryRequestOptions, CategoryResponse> & {
|
|
3
|
+
children: (props: import('@tanstack/react-query').UseQueryResult<CategoryResponse, Error>) => React.ReactNode;
|
|
4
|
+
}) => import('react').ReactNode;
|
|
5
|
+
export { useCategories, CategoriesModel };
|
|
@@ -1,7 +1,5 @@
|
|
|
1
|
-
import { UseQueryResult } from '@tanstack/react-query';
|
|
2
1
|
import { FeaturesRequestOptions, FeaturesResponse } from '@carto/api-client';
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
}): import('react').ReactNode;
|
|
2
|
+
declare const useFeatures: ({ accessToken, sourceId, widgetProps, additionalFilter, useQueryProps: { enabled, ...useQueryProps }, }: import('./types').ModelProps<FeaturesRequestOptions, FeaturesResponse>) => import('@tanstack/react-query').UseQueryResult<FeaturesResponse, Error>, FeaturesModel: ({ children, ...modelProps }: import('./types').ModelProps<FeaturesRequestOptions, FeaturesResponse> & {
|
|
3
|
+
children: (props: import('@tanstack/react-query').UseQueryResult<FeaturesResponse, Error>) => React.ReactNode;
|
|
4
|
+
}) => import('react').ReactNode;
|
|
5
|
+
export { useFeatures, FeaturesModel };
|
|
@@ -1,7 +1,5 @@
|
|
|
1
|
-
import { UseQueryResult } from '@tanstack/react-query';
|
|
2
1
|
import { FormulaRequestOptions, FormulaResponse } from '@carto/api-client';
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
}): import('react').ReactNode;
|
|
2
|
+
declare const useFormula: ({ accessToken, sourceId, widgetProps, additionalFilter, useQueryProps: { enabled, ...useQueryProps }, }: import('./types').ModelProps<FormulaRequestOptions, FormulaResponse>) => import('@tanstack/react-query').UseQueryResult<FormulaResponse, Error>, FormulaModel: ({ children, ...modelProps }: import('./types').ModelProps<FormulaRequestOptions, FormulaResponse> & {
|
|
3
|
+
children: (props: import('@tanstack/react-query').UseQueryResult<FormulaResponse, Error>) => React.ReactNode;
|
|
4
|
+
}) => import('react').ReactNode;
|
|
5
|
+
export { useFormula, FormulaModel };
|
|
@@ -1,7 +1,5 @@
|
|
|
1
|
-
import { UseQueryResult } from '@tanstack/react-query';
|
|
2
1
|
import { HistogramRequestOptions, HistogramResponse } from '@carto/api-client';
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
}): import('react').ReactNode;
|
|
2
|
+
declare const useHistogram: ({ accessToken, sourceId, widgetProps, additionalFilter, useQueryProps: { enabled, ...useQueryProps }, }: import('./types').ModelProps<HistogramRequestOptions, HistogramResponse>) => import('@tanstack/react-query').UseQueryResult<HistogramResponse, Error>, HistogramModel: ({ children, ...modelProps }: import('./types').ModelProps<HistogramRequestOptions, HistogramResponse> & {
|
|
3
|
+
children: (props: import('@tanstack/react-query').UseQueryResult<HistogramResponse, Error>) => React.ReactNode;
|
|
4
|
+
}) => import('react').ReactNode;
|
|
5
|
+
export { useHistogram, HistogramModel };
|
|
@@ -1,7 +1,5 @@
|
|
|
1
|
-
import { UseQueryResult } from '@tanstack/react-query';
|
|
2
1
|
import { RangeRequestOptions, RangeResponse } from '@carto/api-client';
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
}): import('react').ReactNode;
|
|
2
|
+
declare const useRange: ({ accessToken, sourceId, widgetProps, additionalFilter, useQueryProps: { enabled, ...useQueryProps }, }: import('./types').ModelProps<RangeRequestOptions, RangeResponse>) => import('@tanstack/react-query').UseQueryResult<RangeResponse, Error>, RangeModel: ({ children, ...modelProps }: import('./types').ModelProps<RangeRequestOptions, RangeResponse> & {
|
|
3
|
+
children: (props: import('@tanstack/react-query').UseQueryResult<RangeResponse, Error>) => React.ReactNode;
|
|
4
|
+
}) => import('react').ReactNode;
|
|
5
|
+
export { useRange, RangeModel };
|
|
@@ -1,7 +1,5 @@
|
|
|
1
|
-
import { UseQueryResult } from '@tanstack/react-query';
|
|
2
1
|
import { ScatterRequestOptions, ScatterResponse } from '@carto/api-client';
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
}): import('react').ReactNode;
|
|
2
|
+
declare const useScatter: ({ accessToken, sourceId, widgetProps, additionalFilter, useQueryProps: { enabled, ...useQueryProps }, }: import('./types').ModelProps<ScatterRequestOptions, ScatterResponse>) => import('@tanstack/react-query').UseQueryResult<ScatterResponse, Error>, ScatterModel: ({ children, ...modelProps }: import('./types').ModelProps<ScatterRequestOptions, ScatterResponse> & {
|
|
3
|
+
children: (props: import('@tanstack/react-query').UseQueryResult<ScatterResponse, Error>) => React.ReactNode;
|
|
4
|
+
}) => import('react').ReactNode;
|
|
5
|
+
export { useScatter, ScatterModel };
|
|
@@ -1,7 +1,5 @@
|
|
|
1
|
-
import { UseQueryResult } from '@tanstack/react-query';
|
|
2
1
|
import { TableRequestOptions, TableResponse } from '@carto/api-client';
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
}): import('react').ReactNode;
|
|
2
|
+
declare const useTable: ({ accessToken, sourceId, widgetProps, additionalFilter, useQueryProps: { enabled, ...useQueryProps }, }: import('./types').ModelProps<TableRequestOptions, TableResponse>) => import('@tanstack/react-query').UseQueryResult<TableResponse, Error>, TableModel: ({ children, ...modelProps }: import('./types').ModelProps<TableRequestOptions, TableResponse> & {
|
|
3
|
+
children: (props: import('@tanstack/react-query').UseQueryResult<TableResponse, Error>) => React.ReactNode;
|
|
4
|
+
}) => import('react').ReactNode;
|
|
5
|
+
export { useTable, TableModel };
|
|
@@ -1,7 +1,5 @@
|
|
|
1
|
-
import { UseQueryResult } from '@tanstack/react-query';
|
|
2
1
|
import { TimeSeriesRequestOptions, TimeSeriesResponse } from '@carto/api-client';
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
}): import('react').ReactNode;
|
|
2
|
+
declare const useTimeSeries: ({ accessToken, sourceId, widgetProps, additionalFilter, useQueryProps: { enabled, ...useQueryProps }, }: import('./types').ModelProps<TimeSeriesRequestOptions, TimeSeriesResponse>) => import('@tanstack/react-query').UseQueryResult<TimeSeriesResponse, Error>, TimeSeriesModel: ({ children, ...modelProps }: import('./types').ModelProps<TimeSeriesRequestOptions, TimeSeriesResponse> & {
|
|
3
|
+
children: (props: import('@tanstack/react-query').UseQueryResult<TimeSeriesResponse, Error>) => React.ReactNode;
|
|
4
|
+
}) => import('react').ReactNode;
|
|
5
|
+
export { useTimeSeries, TimeSeriesModel };
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { UseQueryResult } from '@tanstack/react-query';
|
|
2
|
+
import { ModelProps } from '../types';
|
|
3
|
+
import { useCommonModel } from './use-common-model';
|
|
4
|
+
interface ModelConfig<TRequestOptions, TResponse> {
|
|
5
|
+
queryKeyPrefix: string[];
|
|
6
|
+
getWidgetMethod: (widgetModel: NonNullable<ReturnType<typeof useCommonModel>['widgetModel']>) => (params: TRequestOptions & {
|
|
7
|
+
filters?: unknown;
|
|
8
|
+
signal?: AbortSignal;
|
|
9
|
+
}) => Promise<TResponse>;
|
|
10
|
+
}
|
|
11
|
+
export declare function createModel<TRequestOptions, TResponse>({ queryKeyPrefix, getWidgetMethod, }: ModelConfig<TRequestOptions, TResponse>): {
|
|
12
|
+
useModelHook: ({ accessToken, sourceId, widgetProps, additionalFilter, useQueryProps: { enabled, ...useQueryProps }, }: ModelProps<TRequestOptions, TResponse>) => UseQueryResult<import('@tanstack/react-query').NoInfer<TResponse>, Error>;
|
|
13
|
+
ModelComponent: ({ children, ...modelProps }: ModelProps<TRequestOptions, TResponse> & {
|
|
14
|
+
children: (props: UseQueryResult<TResponse, Error>) => React.ReactNode;
|
|
15
|
+
}) => import('react').ReactNode;
|
|
16
|
+
};
|
|
17
|
+
export {};
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { ModelProps } from '
|
|
1
|
+
import { ModelProps } from '../types';
|
|
2
2
|
export declare function useCommonModel<TRequestOptions, TResponse>({ accessToken, sourceId, widgetProps, additionalFilter, }: Pick<ModelProps<TRequestOptions, TResponse>, 'accessToken' | 'sourceId' | 'additionalFilter' | 'widgetProps'>): {
|
|
3
|
-
mergedFilters:
|
|
4
|
-
widgetModel: import('@carto/api-client').WidgetSource<import('@carto/api-client').WidgetSourceProps & (import('
|
|
3
|
+
mergedFilters: {} | undefined;
|
|
4
|
+
widgetModel: import('@carto/api-client').WidgetSource<import('@carto/api-client').WidgetSourceProps & (import('../..').QuerySource | import('../..').TilesetSource | import('../..').TableSource | import('../../providers/sources/types').RasterQuadbinTilesetSource)> | null;
|
|
5
5
|
queryKey: unknown[];
|
|
6
6
|
};
|
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
import { AddFilterOptions } from '@carto/api-client';
|
|
2
|
-
export declare function useFiltersMerged(sourceId: string, additionalFilter?: AddFilterOptions[]):
|
|
2
|
+
export declare function useFiltersMerged(sourceId: string, additionalFilter?: AddFilterOptions[]): {} | undefined;
|
|
@@ -0,0 +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;
|
package/package.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@carto/ps-react-maps",
|
|
3
|
-
"version": "4.0
|
|
3
|
+
"version": "4.2.0",
|
|
4
4
|
"description": "CARTO's Professional Service React DeckGL library",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"dependencies": {},
|
|
7
7
|
"devDependencies": {
|
|
8
|
-
"@tanstack/react-query": "5.
|
|
9
|
-
"@carto/api-client": "0.5.
|
|
8
|
+
"@tanstack/react-query": "5.89.0",
|
|
9
|
+
"@carto/api-client": "0.5.17",
|
|
10
10
|
"@deck.gl-community/editable-layers": "9.1.1",
|
|
11
11
|
"@deck.gl/aggregation-layers": "9.1.14",
|
|
12
12
|
"@deck.gl/carto": "9.1.14",
|
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
"@vis.gl/react-google-maps": "1.5.5",
|
|
23
23
|
"convert-units": "3.0.0-beta.8",
|
|
24
24
|
"html2canvas": "1.4.1",
|
|
25
|
-
"maplibre-gl": "5.7.
|
|
25
|
+
"maplibre-gl": "5.7.2",
|
|
26
26
|
"mjolnir.js": "3.0.0",
|
|
27
27
|
"react-map-gl": "8.0.4",
|
|
28
28
|
"zustand": "5.0.8",
|
|
@@ -31,7 +31,7 @@
|
|
|
31
31
|
},
|
|
32
32
|
"peerDependencies": {
|
|
33
33
|
"@tanstack/react-query": "^5.0.0",
|
|
34
|
-
"@carto/api-client": "^0.5.
|
|
34
|
+
"@carto/api-client": "^0.5.16",
|
|
35
35
|
"@deck.gl-community/editable-layers": "^9.1.0",
|
|
36
36
|
"@deck.gl/aggregation-layers": "^9.1.0",
|
|
37
37
|
"@deck.gl/carto": "^9.1.0",
|
|
@@ -1 +0,0 @@
|
|
|
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;
|