Skip to content

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

Enable modal prop types (#1190)

Ib Green5a5d64134efd
diff --git a/src/actions/actions.d.ts b/src/actions/actions.d.ts
index aa121e743..0645d0b21 100644
--- a/src/actions/actions.d.ts
+++ b/src/actions/actions.d.ts
@@ -53,7 +53,7 @@ export type AddDataToMapOptions = {
keepExistingConfig?: boolean;
};
-export type AddDataToMaoPayload = {
+export type AddDataToMapPayload = {
datasets: ProtoDataset[];
options?: AddDataToMapOptions;
config?: ParsedConfig;
@@ -61,8 +61,8 @@ export type AddDataToMaoPayload = {
};
export function addDataToMap(
- data: AddDataToMaoPayload
-): {type: ActionTypes.ADD_DATA_TO_MAP; payload: AddDataToMaoPayload};
+ data: AddDataToMapPayload
+): {type: ActionTypes.ADD_DATA_TO_MAP; payload: AddDataToMapPayload};
export function resetMapConfig(): {type: ActionTypes.RESET_MAP_CONFIG};
diff --git a/src/actions/vis-state-actions.d.ts b/src/actions/vis-state-actions.d.ts
index 005eb3e48..2db3777a4 100644
--- a/src/actions/vis-state-actions.d.ts
+++ b/src/actions/vis-state-actions.d.ts
@@ -20,7 +20,7 @@
// vis-state-reducer
import ActionTypes, {ActionType} from 'constants/action-types';
-import {ProtoDataset, AddDataToMaoPayload} from '../actions/actions';
+import {ProtoDataset, AddDataToMapPayload} from '../actions/actions';
import {ParsedConfig} from '../schemas';
import {FileCacheItem} from '../processors/file-handler';
import {Layer, LayerConfig, LayerVisConfig} from 'layers';
@@ -206,14 +206,14 @@ export type AddDaataToMapOUpdaterptions = {
};
export type UpdateVisDataUpdaterAction = {
- datasets: AddDataToMaoPayload['datasets'];
- options: AddDataToMaoPayload['options'];
- config: AddDataToMaoPayload['config'];
-} & AddDataToMaoPayload;
+ datasets: AddDataToMapPayload['datasets'];
+ options: AddDataToMapPayload['options'];
+ config: AddDataToMapPayload['config'];
+} & AddDataToMapPayload;
export function updateVisData(
- datasets: AddDataToMaoPayload['datasets'],
- options: AddDataToMaoPayload['options'],
- config: AddDataToMaoPayload['config']
+ datasets: AddDataToMapPayload['datasets'],
+ options: AddDataToMapPayload['options'],
+ config: AddDataToMapPayload['config']
): Merge<UpdateVisDataUpdaterAction, {type: ActionTypes.UPDATE_VIS_DATA}>;
export type ToggleFilterAnimationUpdaterAction = {
diff --git a/src/components/common/image-preview.js b/src/components/common/image-preview.js
index 2ff600000..1745aa1a5 100644
--- a/src/components/common/image-preview.js
+++ b/src/components/common/image-preview.js
@@ -22,6 +22,8 @@ import React from 'react';
import styled from 'styled-components';
import LoadingSpinner from 'components/common/loading-spinner';
+/** @typedef {import('../../reducers/ui-state-updaters').ExportImage} ExportImage */
+
const StyledImagePreview = styled.div.attrs({
className: 'image-preview'
})`
@@ -67,17 +69,6 @@ const StyledImagePreview = styled.div.attrs({
}
`;
-/** @typedef {{
- error: Error;
- imageDataUri: string;
- exporting: boolean;
- imageSize: {
- imageW: number;
- imageH: number;
- }
-}} ExportImage;
- */
-
/**
* @param {object} props
* @param {ExportImage} [props.exportImage]
@@ -107,7 +98,7 @@ const ImagePreview = ({exportImage, width = 400, showDimension = false}) => {
</div>
) : error ? (
<div className="preview-image--error">
- <span> {error.message || 'Generate map image failed!'}</span>
+ <span>{error.message || 'Generate map image failed!'}</span>
</div>
) : (
<img className="preview-image-placeholder" src={imageDataUri} />
diff --git a/src/components/modal-container.d.ts b/src/components/modal-container.d.ts
index 9f25fc318..ae51a5525 100644
--- a/src/components/modal-container.d.ts
+++ b/src/components/modal-container.d.ts
@@ -2,6 +2,15 @@ import React from 'react';
import * as VisStateActions from '../actions/vis-state-actions';
import * as UIStateActions from '../actions/ui-state-actions';
import * as MapStyleActions from '../actions/map-style-actions';
+import * as ProviderActions from '../actions/provider-actions';
+import {OnErrorCallBack, OnSuccessCallBack} from '../actions/provider-actions';
+
+import {MapState} from '../reducers/map-state-updaters';
+import {MapStyle} from '../reducers/map-style-updaters';
+import {UiState} from '../reducers/ui-state-updaters';
+import {VisState} from '../reducers/vis-state-updaters';
+import {ProviderState} from '../reducers/provider-state-updaters';
+import {OnSuccessCallBack} from 'actions';
export type ModalContainerProps = {
rootNode: object;
@@ -9,15 +18,21 @@ export type ModalContainerProps = {
containerH: number;
mapboxApiAccessToken: string;
mapboxApiUrl?: string;
- mapState: object;
- mapStyle: object;
- uiState: object;
- visState: object;
+ mapState: MapState;
+ mapStyle: MapStyle;
+ uiState: UiState;
+ visState: VisState;
+ providerState: ProviderState;
visStateActions: typeof VisStateActions;
uiStateActions: typeof UIStateActions;
mapStyleActions: typeof MapStyleActions;
+ providerActions: typeof ProviderActions;
onSaveToStorage: () => void,
- cloudProviders: object[]
+ cloudProviders: object[],
+ onLoadCloudMapSuccess: OnSuccessCallBack,
+ onLoadCloudMapError: OnErrorCallBack,
+ onExportToCloudSuccess:OnSuccessCallBack,
+ onExportToCloudError: OnErrorCallBack,
};
export default function ModalContainerFactory(): React.Component<ModelContainerProps>;
diff --git a/src/components/modal-container.js b/src/components/modal-container.js
index 0065d8592..981e2f686 100644
--- a/src/components/modal-container.js
+++ b/src/components/modal-container.js
@@ -117,8 +117,8 @@ export default function ModalContainerFactory(
SaveMapModal,
ShareMapModal
) {
- // /** @typedef {import('./modal-container').ModalContainerProps} ModalContainerProps */
- // /** @augments React.Component<ModalContainerProps> */
+ /** @typedef {import('./modal-container').ModalContainerProps} ModalContainerProps */
+ /** @augments React.Component<ModalContainerProps> */
class ModalContainer extends Component {
// TODO - remove when prop types are fully exported
static propTypes = {
@@ -204,6 +204,7 @@ export default function ModalContainerFactory(
const toSave = exportMap(this.props);
this.props.providerActions.exportFileToCloud({
+ // @ts-ignore
mapData: toSave,
provider,
options: {
@@ -218,6 +219,7 @@ export default function ModalContainerFactory(
_onSaveMap = (overwrite = false) => {
const {currentProvider} = this.props.providerState;
+ // @ts-ignore
const provider = this.props.cloudProviders.find(p => p.name === currentProvider);
this._exportFileToCloud({
provider,
@@ -269,10 +271,14 @@ export default function ModalContainerFactory(
let template = null;
let modalProps = {};
+ // TODO - currentModal is a string
+ // @ts-ignore
if (currentModal && currentModal.id && currentModal.template) {
// if currentMdoal template is already provided
// TODO: need to check whether template is valid
+ // @ts-ignore
template = <currentModal.template />;
+ // @ts-ignore
modalProps = currentModal.modalProps;
} else {
switch (currentModal) {
diff --git a/src/processors/file-handler.d.ts b/src/processors/file-handler.d.ts
index f91e999b8..f0aa8f572 100644
--- a/src/processors/file-handler.d.ts
+++ b/src/processors/file-handler.d.ts
@@ -18,7 +18,7 @@
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
-import {ProtoDataset, AddDataToMaoPayload} from 'actions/actions';
+import {ProtoDataset, AddDataToMapPayload} from 'actions/actions';
export type FileCacheItem = {
data: any;
@@ -38,4 +38,4 @@ export function processFileData(payload: {
fileCache: FileCacheItem[];
}): Promise<FileCacheItem[]>;
-export function filesToDataPayload(fileCache: FileCacheItem[]): AddDataToMaoPayload[];
+export function filesToDataPayload(fileCache: FileCacheItem[]): AddDataToMapPayload[];
diff --git a/src/reducers/combined-updaters.d.ts b/src/reducers/combined-updaters.d.ts
index aff74a916..43e9e871b 100644
--- a/src/reducers/combined-updaters.d.ts
+++ b/src/reducers/combined-updaters.d.ts
@@ -3,7 +3,7 @@ import {MapState} from './map-state-updaters';
import {UiState} from './ui-state-updaters';
import {MapStyle} from './map-style-updaters';
import {ProviderState} from './provider-state-updaters';
-import {AddDataToMaoPayload} from 'actions/actions';
+import {AddDataToMapPayload} from 'actions/actions';
import {FileCacheItem} from 'processors/file-handler';
import {loadFilesSuccessUpdaterAction} from 'actions/vis-state-actions';
@@ -17,7 +17,7 @@ export type KeplerGlState = {
export function addDataToMapUpdater(
state: KeplerGlState,
- action: {payload: AddDataToMaoPayload}
+ action: {payload: AddDataToMapPayload}
): KeplerGlState;
export function loadFilesSuccessUpdater(
diff --git a/src/reducers/ui-state-updaters.d.ts b/src/reducers/ui-state-updaters.d.ts
index c43cb2f19..49d9823b3 100644
--- a/src/reducers/ui-state-updaters.d.ts
+++ b/src/reducers/ui-state-updaters.d.ts
@@ -17,7 +17,7 @@ export type ExportImage = {
// exporting state
imageDataUri: string;
exporting: boolean;
- error: boolean;
+ error: Error;
};
export type ExportData = {