Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.
[Chore] Add more types for schema (#2162)
Igor Dykhtaa41e0118aeed
diff --git a/src/actions/src/vis-state-actions.ts b/src/actions/src/vis-state-actions.tsindex ac3f216e3..e1f1c1afa 100644--- a/src/actions/src/vis-state-actions.ts+++ b/src/actions/src/vis-state-actions.ts@@ -34,7 +34,8 @@ import {Feature,FeatureSelectionContext,InteractionConfig,- Filter+ Filter,+ ParsedConfig} from '@kepler.gl/types';// TODO - import LoaderObject type from @loaders.gl/core when supported// TODO - import LoadOptions type from @loaders.gl/core when supported@@ -628,8 +629,8 @@ export type AddDataToMapUpdaterOptions = {export type UpdateVisDataUpdaterAction = {datasets: AddDataToMapPayload['datasets'];options: AddDataToMapPayload['options'];- config?: AddDataToMapPayload['config'];-} & AddDataToMapPayload;+ config?: ParsedConfig;+};// * @param dataset.info -info of a dataset// * @param dataset.info.id - id of this dataset. If config is defined, `id` should matches the `dataId` in config.// * @param dataset.info.label - A display name of this dataset@@ -654,7 +655,7 @@ export type UpdateVisDataUpdaterAction = {export function updateVisData(datasets: AddDataToMapPayload['datasets'],options: AddDataToMapPayload['options'],- config?: AddDataToMapPayload['config']+ config?: ParsedConfig): Merge<UpdateVisDataUpdaterAction, {type: typeof ActionTypes.UPDATE_VIS_DATA}> {return {type: ActionTypes.UPDATE_VIS_DATA,diff --git a/src/reducers/src/vis-state-merger.ts b/src/reducers/src/vis-state-merger.tsindex 51fe72086..427f7afbd 100644--- a/src/reducers/src/vis-state-merger.ts+++ b/src/reducers/src/vis-state-merger.ts@@ -30,15 +30,15 @@ import {import {LayerColumns, LayerColumn, Layer} from '@kepler.gl/layers';import {LAYER_BLENDINGS, OVERLAY_BLENDINGS} from '@kepler.gl/constants';+import {CURRENT_VERSION, VisState, VisStateMergers, visStateSchema} from '@kepler.gl/schemas';+import {- CURRENT_VERSION,- VisState,- VisStateMergers,- visStateSchema,+ ParsedLayer,+ SavedInteractionConfig,+ TooltipInfo,+ SavedEditor,ParsedConfig-} from '@kepler.gl/schemas';--import {ParsedLayer, SavedInteractionConfig, TooltipInfo, SavedEditor} from '@kepler.gl/types';+} from '@kepler.gl/types';import {KeplerTable, Datasets, assignGpuChannels, resetFilterGpuMode} from '@kepler.gl/table';/**diff --git a/src/reducers/src/vis-state-updaters.ts b/src/reducers/src/vis-state-updaters.tsindex 82a3719c2..e06fea816 100644--- a/src/reducers/src/vis-state-updaters.ts+++ b/src/reducers/src/vis-state-updaters.ts@@ -194,7 +194,9 @@ export const DEFAULT_ANIMATION_CONFIG: AnimationConfig = {isAnimating: false,timeFormat: null,timezone: null,- defaultTimeFormat: null+ defaultTimeFormat: null,+ hideControl: false,+ duration: null};export const DEFAULT_EDITOR: Editor = {@@ -1389,7 +1391,7 @@ export const resetMapConfigUpdater = (state: VisState): VisState => ({export const receiveMapConfigUpdater = (state: VisState,{- payload: {config = {version: ''}, options = {}}+ payload: {config = {}, options = {}}}: {type?: typeof ActionTypes.RECEIVE_MAP_CONFIG;payload: ReceiveMapConfigPayload;diff --git a/src/schemas/src/index.ts b/src/schemas/src/index.tsindex 2212a523a..32fe16368 100644--- a/src/schemas/src/index.ts+++ b/src/schemas/src/index.ts@@ -28,7 +28,6 @@ export {// eslint-disable-next-line prettier/prettierexport type {- ParsedConfig,SavedConfigV1,SavedMap,LoadedMap,diff --git a/src/schemas/src/schema-manager.ts b/src/schemas/src/schema-manager.tsindex ea5e35f44..e3197c8f1 100644--- a/src/schemas/src/schema-manager.ts+++ b/src/schemas/src/schema-manager.ts@@ -30,7 +30,7 @@ import {visStateSchema} from './vis-state-schema';import {CURRENT_VERSION, VERSIONS} from './versions';import {isPlainObject} from '@kepler.gl/utils';-import {MapInfo, ParsedVisState, RGBColor, SavedVisState} from '@kepler.gl/types';+import {MapInfo, SavedVisState, SavedMapStyle, ParsedConfig} from '@kepler.gl/types';export type SavedMapState = {bearing: number;@@ -57,14 +57,6 @@ export type SavedCustomMapStyle = {};};-export type SavedMapStyle = {- styleType: string;- topLayerGroups: SavedLayerGroups;- visibleLayerGroups: SavedLayerGroups;- threeDBuildingColor: RGBColor;- mapStyles: SavedCustomMapStyle;-};-/** Schema for v1 saved configuration */export type SavedConfigV1 = {version: 'v1';@@ -75,14 +67,6 @@ export type SavedConfigV1 = {};};-/** Schema for a parsed configuration ("normalized" across versions) */-export type ParsedConfig = {- version: string;- visState?: ParsedVisState;- mapState?: Partial<SavedMapState>;- mapStyle?: Partial<SavedMapStyle>;-};-export type SavedMap = {datasets: SavedDatasetV1[];config: SavedConfigV1;@@ -269,7 +253,6 @@ export class KeplerGLSchema {return null;}- // @ts-expect-errorreturn Object.keys(config).reduce((accu, key) => ({...accu,diff --git a/src/schemas/src/vis-state-schema.ts b/src/schemas/src/vis-state-schema.tsindex 936fedb39..04396c9c5 100644--- a/src/schemas/src/vis-state-schema.ts+++ b/src/schemas/src/vis-state-schema.ts@@ -37,8 +37,10 @@ import {ParsedLayer,ParsedVisState,SavedFilter,+ MinSavedFilter,SavedInteractionConfig,SavedLayer,+ MinSavedLayer,SavedVisState,SplitMap} from '@kepler.gl/types';@@ -570,7 +572,7 @@ export class LayerSchemaV0 extends Schema {}load(- layers: SavedLayer[] | undefined+ layers: SavedLayer[] | MinSavedLayer[] | undefined): {layers: ParsedLayer[] | undefined;} {@@ -591,7 +593,9 @@ export class FilterSchemaV0 extends Schema {.map(filter => this.savePropertiesOrApplySchema(filter).filters)};}- load(filters: undefined | SavedFilter[]): {filters: undefined | ParsedFilter[]} {+ load(+ filters: SavedFilter[] | MinSavedFilter[] | undefined+ ): {filters: ParsedFilter[] | undefined} {return {filters: filters?.map(filter => this.loadPropertiesOrApplySchema(filter).filters)diff --git a/src/types/actions.d.ts b/src/types/actions.d.tsindex d5a478a04..373253b72 100644--- a/src/types/actions.d.ts+++ b/src/types/actions.d.ts@@ -1,4 +1,4 @@-import {SavedMap, ParsedConfig} from './schemas';+import {SavedMap, ParsedConfig, SavedConfigV1, MinSavedConfigV1} from './schemas';/** EXPORT_FILE_TO_CLOUD */export type MapData = {@@ -67,6 +67,6 @@ export type AddDataToMapPayload = {// as the field is called `datasets`datasets: ProtoDataset[] | ProtoDataset;options?: AddDataToMapOptions;- config?: ParsedConfig;+ config?: ParsedConfig | SavedConfigV1 | MinSavedConfigV1;info?: Partial<MapInfo>;};diff --git a/src/types/reducers.d.ts b/src/types/reducers.d.tsindex c523b2396..b56ae9ee9 100644--- a/src/types/reducers.d.ts+++ b/src/types/reducers.d.ts@@ -191,6 +191,7 @@ export type AnimationConfig = {domain: number[] | null;currentTime: number | null;speed: number;+ duration?: number | null;isAnimating?: boolean;timeSteps?: null | number[];// auto generated based on time domaindiff --git a/src/types/schemas.d.ts b/src/types/schemas.d.tsindex af8e125a7..ac0fdb490 100644--- a/src/types/schemas.d.ts+++ b/src/types/schemas.d.ts@@ -1,4 +1,4 @@-import {RGBColor, Merge, RGBAColor} from './types';+import {RGBColor, Merge, RGBAColor, RequireFrom} from './types';import {Filter,@@ -28,8 +28,8 @@ export type SavedFilter = {speed: Filter['speed'];layerId: Filter['layerId'];};--export type ParsedFilter = Partial<SavedFilter>;+export type MinSavedFilter = RequireFrom<SavedFilter, 'dataId' | 'id' | 'name' | 'type' | 'value'>;+export type ParsedFilter = SavedFilter | MinSavedFilter;export type SavedInteractionConfig = {tooltip: TooltipInfo['config'] & {@@ -63,18 +63,20 @@ export type SavedLayer = {[key: string]: string;};isVisible: boolean;- visConfig: object;+ visConfig: Record<string, any>;hidden: boolean;textLabel: Merge<LayerTextLabel, {field: {name: string; type: string} | null}>;};visualChannels: SavedVisualChannels;};--export type ParsedLayer = {- id?: string;- type?: string;- config?: Partial<SavedLayer['config']>;+export type MinSavedLayerConfig = RequireFrom<SavedLayer['config'], 'dataId' | 'columns'>;+export type MinSavedLayer = {+ id: string;+ type: string;+ config: MinSavedLayerConfig;+ visualChannels?: SavedVisualChannels;};+export type ParsedLayer = SavedLayer | MinSavedLayer;export type SavedAnimationConfig = {currentTime: AnimationConfig['currentTime'];@@ -97,6 +99,18 @@ export type SavedVisState = {editor?: SavedEditor;};+// Min saved config can be passed to addDataToMap+export type MinSavedVisStateV1 = {+ filters?: MinSavedFilter[];+ layers?: MinSavedLayer[];+ interactionConfig?: Partial<SavedInteractionConfig>;+ layerBlending?: string;+ overlayBlending?: string;+ splitMaps?: SplitMap[];+ animationConfig?: SavedAnimationConfig;+ editor?: SavedEditor;+};+export type ParsedVisState = {layers?: ParsedLayer[];filters?: ParsedFilter[];@@ -117,6 +131,10 @@ export type SavedMapState = {isSplit: boolean;};+export type SavedMapStateV1 = SavedMapState;+export type MinSavedMapStateV1 = Partial<SavedMapState>;+export type ParsedMapState = Partial<SavedMapState>;+export type SavedLayerGroups = {[key: string]: boolean;};@@ -140,6 +158,11 @@ export type SavedMapStyle = {mapStyles: SavedCustomMapStyle;};+export type SavedMapStyleV1 = SavedMapStyle;+export type MinSavedMapStyleV1 = Partial<SavedMapStyleV1>;++export type ParsedMapStyle = Partial<SavedMapStyleV1>;+/** Schema for v1 saved configuration */export type SavedConfigV1 = {version: 'v1';@@ -150,12 +173,21 @@ export type SavedConfigV1 = {};};+// supported by addDataToMap+export type MinSavedConfigV1 = {+ version: 'v1';+ config: {+ visState?: MinSavedVisStateV1;+ mapState?: MinSavedMapStateV1;+ mapStyle?: MinSavedMapStyleV1;+ };+};+/** Schema for a parsed configuration ("normalized" across versions) */export type ParsedConfig = {- version: string;visState?: ParsedVisState;- mapState?: Partial<SavedMapState>;- mapStyle?: Partial<SavedMapStyle>;+ mapState?: ParsedMapState;+ mapStyle?: ParsedMapStyle;};export type SavedField = {diff --git a/src/types/types.d.ts b/src/types/types.d.tsindex a26ddea96..e65229e0a 100644--- a/src/types/types.d.ts+++ b/src/types/types.d.ts@@ -9,6 +9,8 @@ export type Merge<A, B> = {[K in keyof A]: K extends keyof B ? B[K] : A[K]} & B? {[K in keyof O]: O[K]}: never;+export type RequireFrom<T, K extends keyof T> = Merge<Required<Pick<T, K>>, Partial<Omit<T, K>>>;+export type Entries<T> = {[K in keyof T]: [K, T[K]];}[keyof T][];diff --git a/src/utils/src/filter-utils.ts b/src/utils/src/filter-utils.tsindex 12647731c..2a02803f6 100644--- a/src/utils/src/filter-utils.ts+++ b/src/utils/src/filter-utils.ts@@ -265,7 +265,6 @@ export function validateFilter<K extends KeplerTableModel<K, L>, L>(}const initializeFilter: Filter = {- // @ts-expect-error...getDefaultFilter(filter.dataId),...filter,dataId: filterDataId,diff --git a/test/node/reducers/vis-state-test.js b/test/node/reducers/vis-state-test.jsindex 1ca428b47..82d078aa1 100644--- a/test/node/reducers/vis-state-test.js+++ b/test/node/reducers/vis-state-test.js@@ -603,13 +603,10 @@ test('#visStateReducer -> LAYER_CONFIG_CHANGE -> isVisible -> animationConfig',t.deepEqual(nextState.animationConfig,{+ ...DEFAULT_ANIMATION_CONFIG,domain: null,currentTime: 1565577261000,- speed: 1,- isAnimating: false,- defaultTimeFormat: null,- timeFormat: null,- timezone: null+ isAnimating: false},'should set animationConfig to default');