Improve Source types (#687)

CartoDB · May 25, 2023 · 2d681d7 · 2d681d7
1 parent e196a60
commit 2d681d7
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 11 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,7 @@
 - Fix widget calculation with very large viewports/masks [#680](https://github.com/CartoDB/carto-react/pull/680)
 - Storybook: show figma codes/theme code snippets for colors [#684](https://github.com/CartoDB/carto-react/pull/684)
 - Bar & Histogram & Formula & ComparativeFormula Widgets: Add a skeleton for loading state [#674](https://github.com/CartoDB/carto-react/pull/674)
+- Improve Source types [#687](https://github.com/CartoDB/carto-react/pull/687)
 
 ## 2.0
 

diff --git a/packages/react-api/src/hooks/useCartoLayerProps.d.ts b/packages/react-api/src/hooks/useCartoLayerProps.d.ts
@@ -1,7 +1,7 @@
 import { SourceProps, LayerConfig, UseCartoLayerFilterProps } from '../types';
 
 interface UseCartoLayerProps {
-  source: SourceProps & { id: string };
+  source: SourceProps;
   layerConfig?: LayerConfig;
   uniqueIdProperty?: string;
   viewportFeatures?: boolean;

diff --git a/packages/react-api/src/types.d.ts b/packages/react-api/src/types.d.ts
@@ -21,11 +21,12 @@ interface CredentialsCarto3 {
 export type Credentials = CredentialsCarto2 | CredentialsCarto3;
 
 export type SourceProps = {
+  id: string;
   data: string;
   type: MAP_TYPES.QUERY | MAP_TYPES.TABLE | MAP_TYPES.TILESET;
-  connection?: string;
-  credentials: Credentials;
-  queryParameters: QueryParameters;
+  connection: string;
+  credentials?: Credentials;
+  queryParameters?: QueryParameters;
 };
 
 export type LayerConfig = {

diff --git a/packages/react-redux/src/slices/cartoSlice.d.ts b/packages/react-redux/src/slices/cartoSlice.d.ts
@@ -7,10 +7,9 @@ import { AnyAction, Reducer } from 'redux';
 import { Feature, Polygon, MultiPolygon } from 'geojson';
 
 type Source = SourceProps & {
-  id: string
-  filters?: any
-  filtersLogicalOperator?: FiltersLogicalOperators
-  isDroppingFeatures?: boolean
+  filters?: any;
+  filtersLogicalOperator?: FiltersLogicalOperators;
+  isDroppingFeatures?: boolean;
 };
 
 type Layer = {
@@ -25,7 +24,7 @@ type FilterBasic = {
   type: _FilterTypes;
   values: string[] | number[] | number[][];
   owner?: string;
-  params?: Record<string, unknown>
+  params?: Record<string, unknown>;
 };
 
 type FilterCommonProps = {
@@ -71,7 +70,7 @@ declare enum CartoActions {
   SET_FEATURES_READY = 'carto/setFeaturesReady',
   SET_CREDENTIALS = 'carto/setCredentials',
   SET_FEATURE_SELECTION_MODE = 'carto/setFeatureSelectionMode',
-  SET_FEATURE_SELECTION_ENABLED = 'carto/setFeatureSelectionEnabled',
+  SET_FEATURE_SELECTION_ENABLED = 'carto/setFeatureSelectionEnabled'
 }
 
 export function createCartoSlice(
@@ -170,6 +169,9 @@ export function setFeatureSelectionEnabled(enabled: boolean): {
 
 export function selectViewport(state: any): Viewport | null;
 
-export function selectSpatialFilter(state: any, sourceId?: string): Feature<Polygon | MultiPolygon> | null;
+export function selectSpatialFilter(
+  state: any,
+  sourceId?: string
+): Feature<Polygon | MultiPolygon> | null;
 
 export function selectFeatureSelectionMode(state: any): string | null;