Skip to content

Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.

UN-12 Technical: Translate redusers (main files) to typescript (#1722)

Maksim Suslove36cac5be9b6
diff --git a/src/components/map/locale-panel.d.ts b/src/components/map/locale-panel.d.ts
index efbae4596..dff7808df 100644
--- a/src/components/map/locale-panel.d.ts
+++ b/src/components/map/locale-panel.d.ts
@@ -1,5 +1,5 @@
import React from 'react';
-import {MapControls} from '../../reducers';
+import {MapControls} from 'reducers';
export type LocalePanelProps = {
availableLocales: ReadonlyArray<string>;
diff --git a/src/components/map/map-control.d.ts b/src/components/map/map-control.d.ts
index 552dfef5e..4be128d48 100644
--- a/src/components/map/map-control.d.ts
+++ b/src/components/map/map-control.d.ts
@@ -1,5 +1,5 @@
import React from 'react';
-import {Editor, MapControls} from '../../reducers';
+import {Editor, MapControls} from 'reducers';
import {Datasets} from 'reducers/vis-state-updaters';
import {FeatureFlags} from '../context';
import {Layer} from 'layers';
diff --git a/src/components/map/map-draw-panel.d.ts b/src/components/map/map-draw-panel.d.ts
index 4519d3ba0..efe5a592f 100644
--- a/src/components/map/map-draw-panel.d.ts
+++ b/src/components/map/map-draw-panel.d.ts
@@ -1,5 +1,5 @@
import React from 'react';
-import {Editor, MapControls} from '../../reducers';
+import {Editor, MapControls} from 'reducers';
import {MapDrawPanelIcons} from './map-control';
export type MapDrawPanelProps = {
diff --git a/src/components/map/map-legend-panel.d.ts b/src/components/map/map-legend-panel.d.ts
index b6699eb35..b617f94fa 100644
--- a/src/components/map/map-legend-panel.d.ts
+++ b/src/components/map/map-legend-panel.d.ts
@@ -1,6 +1,6 @@
import React, {Element} from 'react';
import {Layer} from 'layers';
-import {MapControls} from '../../reducers';
+import {MapControls} from 'reducers';
interface MapLegendPanelIcons {
legend: ComponentType<any>;
diff --git a/src/components/map/split-map-button.d.ts b/src/components/map/split-map-button.d.ts
index cb7dc1819..7e12de8f2 100644
--- a/src/components/map/split-map-button.d.ts
+++ b/src/components/map/split-map-button.d.ts
@@ -1,5 +1,5 @@
import React from 'react';
-import {MapControls} from '../../reducers';
+import {MapControls} from 'reducers';
interface SplitMapButtonIcons {
delete: ComponentType<any>;
diff --git a/src/components/map/toggle-3d-button.d.ts b/src/components/map/toggle-3d-button.d.ts
index f98ceef60..3cf94633f 100644
--- a/src/components/map/toggle-3d-button.d.ts
+++ b/src/components/map/toggle-3d-button.d.ts
@@ -1,5 +1,5 @@
import React from 'react';
-import {MapControls} from '../../reducers';
+import {MapControls} from 'reducers';
interface Toggle3dButtonIcons {
cube: ComponentType<any>;
diff --git a/src/components/modals/export-image-modal.d.ts b/src/components/modals/export-image-modal.d.ts
index 9ec0909b3..9ff387b75 100644
--- a/src/components/modals/export-image-modal.d.ts
+++ b/src/components/modals/export-image-modal.d.ts
@@ -1,6 +1,6 @@
import {FunctionComponent} from 'react';
import {SetExportImageSettingUpdaterAction} from '../../actions';
-import {ExportImage} from '../../reducers';
+import {ExportImage} from 'reducers';
import {IntlShape} from 'react-intl';
export type ExportImageModalProps = {
diff --git a/src/components/modals/save-map-modal.d.ts b/src/components/modals/save-map-modal.d.ts
index 905002565..f84c78406 100644
--- a/src/components/modals/save-map-modal.d.ts
+++ b/src/components/modals/save-map-modal.d.ts
@@ -1,6 +1,6 @@
import React from 'react';
import {Provider} from '../../cloud-providers';
-import {MapInfo, ExportImage} from '../../reducers';
+import {MapInfo, ExportImage} from 'reducers';
import {
setMapInfo
} from '../../actions';
diff --git a/src/components/side-panel.d.ts b/src/components/side-panel.d.ts
index fb05355dd..e0741f24f 100644
--- a/src/components/side-panel.d.ts
+++ b/src/components/side-panel.d.ts
@@ -1,5 +1,5 @@
import {ComponentType} from 'react';
-import {Datasets, Filter, InteractionConfig, MapStyle} from '../reducers';
+import {Datasets, Filter, InteractionConfig, MapStyle} from 'reducers';
import {Layer, LayerClassesType} from '../layers';
import * as MapStyleActions from 'actions/map-style-actions';
diff --git a/src/layers/index.d.ts b/src/layers/index.d.ts
index af41e1178..79a3bad4d 100644
--- a/src/layers/index.d.ts
+++ b/src/layers/index.d.ts
@@ -1,4 +1,4 @@
-import {RGBColor, RGBAColor, GpuFilter, MapState, Field, Filter, Datasets} from '../reducers';
+import {RGBColor, RGBAColor, GpuFilter, MapState, Field, Filter, Datasets} from 'reducers';
import {LayerTextLabel, ColorRange, ColorUI, VisConfigRange} from './layer-factory';
export {LAYER_VIS_CONFIGS, LayerVisConfig} from './layer-factory';
diff --git a/src/layers/trip-layer/trip-utils.d.ts b/src/layers/trip-layer/trip-utils.d.ts
index 4e9884d18..f17e91433 100644
--- a/src/layers/trip-layer/trip-utils.d.ts
+++ b/src/layers/trip-layer/trip-utils.d.ts
@@ -1,3 +1,3 @@
-import {Field} from '../../reducers';
+import {Field} from 'reducers';
export const containValidTime: (timestamps: string[]) => Field | null;
diff --git a/src/reducers/core.d.ts b/src/reducers/core.d.ts
deleted file mode 100644
index 1b8fa6e58..000000000
--- a/src/reducers/core.d.ts
+++ /dev/null
@@ -1,25 +0,0 @@
-import {Reducer} from 'redux';
-import {ReduxCompatibleReducer} from 'redux-actions';
-import {VisState} from './vis-state-updaters';
-import {MapState} from './map-state-updaters';
-import {MapStyle} from './map-style-updaters';
-import {ProviderState} from './provider-state-updaters';
-import {UiState} from './ui-state-updaters';
-
-export type KeplerGlState = {
- visState: VisState;
- mapState: MapState;
- mapStyle: MapStyle;
- uiState: UiState;
- providerState: ProviderState;
-};
-
-export function combineReducers_(r: {[key: string]: ReduxCompatibleReducer<any>}): Reducer<any>;
-
-export function mapStateLens(st: KeplerGlState): {mapState: MapState};
-export function mapStyleLens(st: KeplerGlState): {mapStyle: MapStyle};
-export function visStateLens(st: KeplerGlState): {visState: VisState};
-export function uiStateLens(st: KeplerGlState): {uiState: UiState};
-export function providerStateLens(st: KeplerGlState): {providerState: ProviderState};
-
-export function coreReducerFactory(initialState: any): (state: any, action: any) => any;
diff --git a/src/reducers/core.js b/src/reducers/core.ts
similarity index 74%
rename from src/reducers/core.js
rename to src/reducers/core.ts
index 74378b660..d16a289f1 100644
--- a/src/reducers/core.js
+++ b/src/reducers/core.ts
@@ -28,13 +28,22 @@ import {providerStateReducerFactory} from './provider-state';
import composers from './composers';
-/**
- * @type {typeof import('./core').combineReducers_}
- */
-const combineReducers_ = combineReducers;
+import {VisState} from './vis-state-updaters';
+import {MapState} from './map-state-updaters';
+import {MapStyle} from './map-style-updaters';
+import {ProviderState} from './provider-state-updaters';
+import {UiState} from './ui-state-updaters';
+
+export type KeplerGlState = {
+ visState: VisState;
+ mapState: MapState;
+ mapStyle: MapStyle;
+ uiState: UiState;
+ providerState: ProviderState;
+};
-const combined = (initialState = {}) =>
- combineReducers_({
+const combined = (initialState: Partial<KeplerGlState> = {}) =>
+ combineReducers({
visState: visStateReducerFactory(initialState.visState),
mapState: mapStateReducerFactory(initialState.mapState),
mapStyle: mapStyleReducerFactory(initialState.mapStyle),
@@ -42,7 +51,10 @@ const combined = (initialState = {}) =>
providerState: providerStateReducerFactory(initialState.providerState)
});
-export const coreReducerFactory = (initialState = {}) => (state, action) => {
+export const coreReducerFactory = (initialState: Partial<KeplerGlState> = {}) => (
+ state,
+ action
+) => {
if (composers[action.type]) {
return composers[action.type](state, action);
}
@@ -58,7 +70,7 @@ export default coreReducerFactory();
* @param {*} reduxState
* @public
*/
-export const mapStateLens = reduxState => ({mapState: reduxState.mapState});
+export const mapStateLens = (reduxState: KeplerGlState) => ({mapState: reduxState.mapState});
/**
* Connect subreducer `mapStyle`, used with `injectComponents`. Learn more at
@@ -67,7 +79,7 @@ export const mapStateLens = reduxState => ({mapState: reduxState.mapState});
* @param {*} reduxState
* @public
*/
-export const mapStyleLens = reduxState => ({mapStyle: reduxState.mapStyle});
+export const mapStyleLens = (reduxState: KeplerGlState) => ({mapStyle: reduxState.mapStyle});
/**
* Connect subreducer `visState`, used with `injectComponents`. Learn more at
@@ -76,7 +88,7 @@ export const mapStyleLens = reduxState => ({mapStyle: reduxState.mapStyle});
* @param {*} reduxState
* @public
*/
-export const visStateLens = reduxState => ({visState: reduxState.visState});
+export const visStateLens = (reduxState: KeplerGlState) => ({visState: reduxState.visState});
/**
* Connect subreducer `uiState`, used with `injectComponents`. Learn more at
@@ -85,7 +97,7 @@ export const visStateLens = reduxState => ({visState: reduxState.visState});
* @param {*} reduxState
* @public
*/
-export const uiStateLens = reduxState => ({uiState: reduxState.uiState});
+export const uiStateLens = (reduxState: KeplerGlState) => ({uiState: reduxState.uiState});
/**
* Connect subreducer `providerState`, used with `injectComponents`. Learn more at
@@ -94,4 +106,6 @@ export const uiStateLens = reduxState => ({uiState: reduxState.uiState});
* @param {*} reduxState
* @public
*/
-export const providerStateLens = reduxState => ({providerState: reduxState.providerState});
+export const providerStateLens = (reduxState: KeplerGlState) => ({
+ providerState: reduxState.providerState
+});
diff --git a/src/reducers/index.d.ts b/src/reducers/index.d.ts
index 80e91a4bd..d41dbc7e2 100644
--- a/src/reducers/index.d.ts
+++ b/src/reducers/index.d.ts
@@ -1,118 +1 @@
-// Copyright (c) 2020 Uber Technologies, Inc.
-//
-// Permission is hereby granted, free of charge, to any person obtaining a copy
-// of this software and associated documentation files (the "Software"), to deal
-// in the Software without restriction, including without limitation the rights
-// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-// copies of the Software, and to permit persons to whom the Software is
-// furnished to do so, subject to the following conditions:
-//
-// The above copyright notice and this permission notice shall be included in
-// all copies or substantial portions of the Software.
-//
-// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-// THE SOFTWARE.
-
-// Root Reducer, used to register, and remove core reducers of each instance
-// export {default} from './root';
-// export {default as keplerGlReducer} from './root';
-
-// Core Reducer
-export {
- default as keplerGlReducerCore,
- visStateLens,
- mapStateLens,
- uiStateLens,
- mapStyleLens
-} from './core';
-
-// Each individual reducer
-// export {default as visStateReducer} from './vis-state';
-// export {default as mapStateReducer} from './map-state';
-// export {default as mapStyleReducer} from './map-style';
-
-// reducer updaters
-export * as visStateUpdaters from './vis-state-updaters';
-export * as mapStateUpdaters from './map-state-updaters';
-export * as mapStyleUpdaters from './map-style-updaters';
-export * as uiStateUpdaters from './ui-state-updaters';
-
-// This will be deprecated
-export * as combineUpdaters from './combined-updaters';
-export * as combinedUpdaters from './combined-updaters';
-
-// reducer merges
-export * as visStateMergers from './vis-state-merger';
-
-// export types
-export {
- AnimationConfig,
- Brush,
- Coordinate,
- Dataset,
- Datasets,
- Editor,
- Feature,
- FeatureValue,
- Field,
- FieldDomain,
- FieldPair,
- Filter,
- FilterBase,
- FilterRecord,
- Geocoder,
- GpuFilter,
- HistogramBin,
- InteractionConfig,
- LineChart,
- MapInfo,
- MultiSelectFieldDomain,
- MultiSelectFilter,
- PolygonFilter,
- RangeFieldDomain,
- RangeFilter,
- SelectFieldDomain,
- SelectFilter,
- SplitMap,
- TimeRangeFieldDomain,
- TimeRangeFilter,
- TooltipInfo,
- VisState
-} from './vis-state-updaters';
-
-export {
- BaseMapStyle,
- InputStyle,
- LayerGroup,
- MapboxStyleUrl,
- MapStyle,
- MapStyles,
- VisibleLayerGroups
-} from './map-style-updaters';
-
-export {
- Bounds,
- MapState,
- Viewport
-} from './map-state-updaters';
-
-export {
- ExportData,
- ExportHtml,
- ExportImage,
- ExportJson,
- ExportMap,
- LoadFiles,
- Locale,
- MapControl,
- MapControls,
- Notifications,
- UiState
-} from './ui-state-updaters';
-
-export * from './types';
+// TODO: Delete this file
diff --git a/src/reducers/index.js b/src/reducers/index.ts
similarity index 69%
rename from src/reducers/index.js
rename to src/reducers/index.ts
index 3d3a0fbff..c2eda9e5d 100644
--- a/src/reducers/index.js
+++ b/src/reducers/index.ts
@@ -51,3 +51,66 @@ export * as visStateMergers from './vis-state-merger';
// Helpers
export * from './composer-helpers';
+
+// export types
+export type {
+ AnimationConfig,
+ Brush,
+ Coordinate,
+ Datasets,
+ Editor,
+ Feature,
+ FeatureValue,
+ FieldDomain,
+ Filter,
+ FilterBase,
+ Geocoder,
+ HistogramBin,
+ InteractionConfig,
+ LineChart,
+ MapInfo,
+ MultiSelectFieldDomain,
+ MultiSelectFilter,
+ PolygonFilter,
+ RangeFieldDomain,
+ RangeFilter,
+ SelectFieldDomain,
+ SelectFilter,
+ SplitMap,
+ TimeRangeFieldDomain,
+ TimeRangeFilter,
+ TooltipInfo,
+ VisState
+} from './vis-state-updaters';
+
+export type {
+ BaseMapStyle,
+ InputStyle,
+ LayerGroup,
+ MapboxStyleUrl,
+ MapStyle,
+ MapStyles,
+ VisibleLayerGroups
+} from './map-style-updaters';
+
+export type {
+ Bounds,
+ MapState,
+ Viewport
+} from './map-state-updaters';
+
+export type {
+ ExportData,
+ ExportHtml,
+ ExportImage,
+ ExportJson,
+ ExportMap,
+ LoadFiles,
+ Locale,
+ MapControl,
+ MapControls,
+ Notifications,
+ UiState
+} from './ui-state-updaters';
+
+export * from './types';
diff --git a/src/reducers/root.js b/src/reducers/root.ts
similarity index 97%
rename from src/reducers/root.js
rename to src/reducers/root.ts
index 62bcb7361..1d17463ce 100644
--- a/src/reducers/root.js
+++ b/src/reducers/root.ts
@@ -90,12 +90,13 @@ export function provideInitialState(initialState) {
[ActionTypes.RENAME_ENTRY]: handleRenameEntry
};
- // @ts-ignore
+ // TODO: Understand why the Lint sees an error here, while the IDE does not.
+ // @ts-expect-error
return handleActions(handlers, initialCoreState)(state, action);
};
}
-const _keplerGlReducer = provideInitialState();
+const _keplerGlReducer = provideInitialState(initialCoreState);
function mergeInitialState(saved = {}, provided = {}) {
const keys = ['mapState', 'mapStyle', 'visState', 'uiState'];
diff --git a/src/reducers/types.d.ts b/src/reducers/types.ts
similarity index 66%
rename from src/reducers/types.d.ts
rename to src/reducers/types.ts
index 39e20d470..0621e00c3 100644
--- a/src/reducers/types.d.ts
+++ b/src/reducers/types.ts
@@ -3,8 +3,8 @@ export type RGBAColor = [number, number, number, number];
export type HexColor = string; // this is the best tpescript can do at the moment
export type Millisecond = number;
-type ValueOf<T> = T[keyof T];
+export type ValueOf<T> = T[keyof T];
-type Merge<A, B> = {[K in keyof A]: K extends keyof B ? B[K] : A[K]} & B extends infer O
+export type Merge<A, B> = {[K in keyof A]: K extends keyof B ? B[K] : A[K]} & B extends infer O
? {[K in keyof O]: O[K]}
: never;