@carto/kepler.gl 0.0.1-alpha.map-libre

package/src/reducers/vis-state.js

@@ -0,0 +1,155 @@
+// Copyright (c) 2022 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.
+
+import ActionTypes from 'constants/action-types';
+import {handleActions} from 'redux-actions';
+import * as visStateUpdaters from './vis-state-updaters';
+
+/**
+ * Important: Do not rename `actionHandler` or the assignment pattern of property value.
+ * It is used to generate documentation
+ */
+const actionHandler = {
+  [ActionTypes.ADD_FILTER]: visStateUpdaters.addFilterUpdater,
+
+  [ActionTypes.ADD_LAYER]: visStateUpdaters.addLayerUpdater,
+
+  [ActionTypes.DUPLICATE_LAYER]: visStateUpdaters.duplicateLayerUpdater,
+
+  [ActionTypes.ENLARGE_FILTER]: visStateUpdaters.enlargeFilterUpdater,
+
+  [ActionTypes.INTERACTION_CONFIG_CHANGE]: visStateUpdaters.interactionConfigChangeUpdater,
+
+  [ActionTypes.LAYER_CLICK]: visStateUpdaters.layerClickUpdater,
+
+  [ActionTypes.LAYER_CONFIG_CHANGE]: visStateUpdaters.layerConfigChangeUpdater,
+
+  [ActionTypes.LAYER_HOVER]: visStateUpdaters.layerHoverUpdater,
+
+  [ActionTypes.LAYER_TYPE_CHANGE]: visStateUpdaters.layerTypeChangeUpdater,
+
+  [ActionTypes.LAYER_VIS_CONFIG_CHANGE]: visStateUpdaters.layerVisConfigChangeUpdater,
+
+  [ActionTypes.LAYER_TEXT_LABEL_CHANGE]: visStateUpdaters.layerTextLabelChangeUpdater,
+
+  [ActionTypes.LAYER_VISUAL_CHANNEL_CHANGE]: visStateUpdaters.layerVisualChannelChangeUpdater,
+
+  [ActionTypes.LAYER_COLOR_UI_CHANGE]: visStateUpdaters.layerColorUIChangeUpdater,
+
+  [ActionTypes.TOGGLE_LAYER_ANIMATION]: visStateUpdaters.toggleLayerAnimationUpdater,
+
+  [ActionTypes.TOGGLE_LAYER_ANIMATION_CONTROL]: visStateUpdaters.toggleLayerAnimationControlUpdater,
+
+  [ActionTypes.LOAD_FILES]: visStateUpdaters.loadFilesUpdater,
+
+  [ActionTypes.LOAD_FILES_ERR]: visStateUpdaters.loadFilesErrUpdater,
+
+  [ActionTypes.LOAD_NEXT_FILE]: visStateUpdaters.loadNextFileUpdater,
+
+  [ActionTypes.LOAD_FILE_STEP_SUCCESS]: visStateUpdaters.loadFileStepSuccessUpdater,
+
+  [ActionTypes.MAP_CLICK]: visStateUpdaters.mapClickUpdater,
+
+  [ActionTypes.MOUSE_MOVE]: visStateUpdaters.mouseMoveUpdater,
+
+  [ActionTypes.RECEIVE_MAP_CONFIG]: visStateUpdaters.receiveMapConfigUpdater,
+
+  [ActionTypes.REMOVE_DATASET]: visStateUpdaters.removeDatasetUpdater,
+
+  [ActionTypes.REMOVE_FILTER]: visStateUpdaters.removeFilterUpdater,
+
+  [ActionTypes.REMOVE_LAYER]: visStateUpdaters.removeLayerUpdater,
+
+  [ActionTypes.REORDER_LAYER]: visStateUpdaters.reorderLayerUpdater,
+
+  [ActionTypes.RESET_MAP_CONFIG]: visStateUpdaters.resetMapConfigUpdater,
+
+  [ActionTypes.SET_FILTER]: visStateUpdaters.setFilterUpdater,
+
+  [ActionTypes.SET_FILTER_ANIMATION_TIME]: visStateUpdaters.setFilterAnimationTimeUpdater,
+
+  [ActionTypes.SET_FILTER_ANIMATION_TIME_CONFIG]:
+    visStateUpdaters.setFilterAnimationTimeConfigUpdater,
+
+  [ActionTypes.SET_FILTER_ANIMATION_WINDOW]: visStateUpdaters.setFilterAnimationWindowUpdater,
+
+  [ActionTypes.SET_FILTER_PLOT]: visStateUpdaters.setFilterPlotUpdater,
+
+  [ActionTypes.SET_MAP_INFO]: visStateUpdaters.setMapInfoUpdater,
+
+  [ActionTypes.SHOW_DATASET_TABLE]: visStateUpdaters.showDatasetTableUpdater,
+
+  [ActionTypes.TOGGLE_FILTER_ANIMATION]: visStateUpdaters.toggleFilterAnimationUpdater,
+
+  [ActionTypes.UPDATE_FILTER_ANIMATION_SPEED]: visStateUpdaters.updateFilterAnimationSpeedUpdater,
+
+  [ActionTypes.SET_LAYER_ANIMATION_TIME]: visStateUpdaters.setLayerAnimationTimeUpdater,
+
+  [ActionTypes.UPDATE_LAYER_ANIMATION_SPEED]: visStateUpdaters.updateLayerAnimationSpeedUpdater,
+
+  [ActionTypes.TOGGLE_LAYER_FOR_MAP]: visStateUpdaters.toggleLayerForMapUpdater,
+
+  [ActionTypes.TOGGLE_SPLIT_MAP]: visStateUpdaters.toggleSplitMapUpdater,
+
+  [ActionTypes.UPDATE_LAYER_BLENDING]: visStateUpdaters.updateLayerBlendingUpdater,
+
+  [ActionTypes.UPDATE_VIS_DATA]: visStateUpdaters.updateVisDataUpdater,
+
+  [ActionTypes.RENAME_DATASET]: visStateUpdaters.renameDatasetUpdater,
+
+  [ActionTypes.SET_FEATURES]: visStateUpdaters.setFeaturesUpdater,
+
+  [ActionTypes.DELETE_FEATURE]: visStateUpdaters.deleteFeatureUpdater,
+
+  [ActionTypes.SET_POLYGON_FILTER_LAYER]: visStateUpdaters.setPolygonFilterLayerUpdater,
+
+  [ActionTypes.SET_SELECTED_FEATURE]: visStateUpdaters.setSelectedFeatureUpdater,
+
+  [ActionTypes.SET_EDITOR_MODE]: visStateUpdaters.setEditorModeUpdater,
+
+  [ActionTypes.TOGGLE_EDITOR_VISIBILITY]: visStateUpdaters.toggleEditorVisibilityUpdater,
+
+  [ActionTypes.TOGGLE_FILTER_FEATURE]: visStateUpdaters.toggleFilterFeatureUpdater,
+
+  [ActionTypes.APPLY_CPU_FILTER]: visStateUpdaters.applyCPUFilterUpdater,
+
+  [ActionTypes.SORT_TABLE_COLUMN]: visStateUpdaters.sortTableColumnUpdater,
+
+  [ActionTypes.PIN_TABLE_COLUMN]: visStateUpdaters.pinTableColumnUpdater,
+
+  [ActionTypes.COPY_TABLE_COLUMN]: visStateUpdaters.copyTableColumnUpdater,
+
+  [ActionTypes.NEXT_FILE_BATCH]: visStateUpdaters.nextFileBatchUpdater,
+
+  [ActionTypes.PROCESS_FILE_CONTENT]: visStateUpdaters.processFileContentUpdater,
+
+  [ActionTypes.SET_LAYER_ANIMATION_TIME_CONFIG]: visStateUpdaters.setLayerAnimationTimeConfigUpdater
+};
+
+// construct vis-state reducer
+export const visStateReducerFactory = (initialState = {}) =>
+  // @ts-ignore
+  handleActions(actionHandler, {
+    ...visStateUpdaters.INITIAL_VIS_STATE,
+    ...initialState,
+    initialState
+  });
+
+export default visStateReducerFactory();

package/src/schemas/dataset-schema.js

@@ -0,0 +1,141 @@
+// Copyright (c) 2022 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.
+
+import pick from 'lodash.pick';
+import {console as globalConsole} from 'global/window';
+
+import {VERSIONS} from './versions';
+import Schema from './schema';
+import {getFieldsFromData, getSampleForTypeAnalyze} from 'processors/data-processor';
+
+// version v0
+const fieldPropertiesV0 = {
+  name: null,
+  type: null
+};
+
+const fieldPropertiesV1 = {
+  name: null,
+  type: null,
+  format: null,
+  analyzerType: null
+};
+
+class FieldSchema extends Schema {
+  save(fields) {
+    return {
+      [this.key]: fields.map(f => this.savePropertiesOrApplySchema(f)[this.key])
+    };
+  }
+  load(fields) {
+    return {[this.key]: fields};
+  }
+}
+
+const propertiesV0 = {
+  id: null,
+  label: null,
+  color: null,
+  allData: null,
+  fields: new FieldSchema({
+    key: 'fields',
+    version: VERSIONS.v0,
+    properties: fieldPropertiesV0
+  })
+};
+
+const propertiesV1 = {
+  ...propertiesV0,
+  fields: new FieldSchema({
+    key: 'fields',
+    version: VERSIONS.v1,
+    properties: fieldPropertiesV1
+  })
+};
+
+class DatasetSchema extends Schema {
+  key = 'dataset';
+
+  save(dataset) {
+    const datasetFlattened = dataset.dataContainer
+      ? {
+          ...dataset,
+          allData: dataset.dataContainer.flattenData()
+        }
+      : dataset;
+
+    return this.savePropertiesOrApplySchema(datasetFlattened)[this.key];
+  }
+  load(dataset) {
+    const {fields, allData} = dataset;
+    let updatedFields = fields;
+
+    // recalculate field type
+    // because we have updated type-analyzer
+    // we need to add format to each field
+    const needCalculateMeta =
+      fields[0] &&
+      (!fields[0].hasOwnProperty('format') || !fields[0].hasOwnProperty('analyzerType'));
+
+    if (needCalculateMeta) {
+      const fieldOrder = fields.map(f => f.name);
+
+      const sampleData = getSampleForTypeAnalyze({
+        fields: fieldOrder,
+        rows: allData
+      });
+      const meta = getFieldsFromData(sampleData, fieldOrder);
+
+      updatedFields = meta.map((f, i) => ({
+        ...pick(meta[i], ['name', 'type', 'format']),
+        analyzerType: meta[i].analyzerType
+      }));
+
+      updatedFields.forEach((f, i) => {
+        if (fields[i].type !== f.type) {
+          // if newly detected field type is different from saved type
+          // we log it but won't update it, cause we don't want to break people's map
+          globalConsole.warn(`detect ${f.name} type is now ${f.type} instead of ${fields[i].type}`);
+        }
+      });
+    }
+
+    // get format of all fields
+    return {
+      data: {fields: updatedFields, rows: dataset.allData},
+      info: pick(dataset, ['id', 'label', 'color'])
+    };
+  }
+}
+
+const datasetSchema = {
+  [VERSIONS.v0]: new DatasetSchema({
+    key: 'dataset',
+    version: VERSIONS.v0,
+    properties: propertiesV0
+  }),
+  [VERSIONS.v1]: new DatasetSchema({
+    key: 'dataset',
+    version: VERSIONS.v1,
+    properties: propertiesV1
+  })
+};
+
+export default datasetSchema;

package/src/schemas/index.d.ts

@@ -0,0 +1,24 @@
+import {KeplerGLSchema} from './schema-manager';
+import Schema from './schema';
+
+export {
+  default,
+  default as KeplerGlSchema,
+  ParsedConfig,
+  ParsedDataset,
+  ParsedLayer,
+  ParsedFilter,
+  SavedConfigV1,
+  SavedDatasetV1,
+  SavedMap,
+  reducerSchema
+} from './schema-manager';
+export {CURRENT_VERSION, VERSIONS} from './versions';
+
+export const KeplerGLSchemaClass: typeof KeplerGLSchema;
+export const visStateSchema: {[key: string]: Schema};
+export const datasetSchema: {[key: string]: Schema};
+export const mapStyleSchema: {[key: string]: Schema};
+export const mapStateSchema: {[key: string]: Schema};
+
+export {default as Schema} from './schema';

package/src/schemas/index.js

@@ -0,0 +1,42 @@
+// Copyright (c) 2022 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.
+
+// Schemas
+export {
+  default,
+  default as KeplerGlSchema,
+  reducerSchema,
+  KeplerGLSchema as KeplerGLSchemaClass
+} from './schema-manager';
+export {CURRENT_VERSION, VERSIONS} from './versions';
+export {
+  visStateSchemaV1,
+  FilterSchemaV0,
+  LayerSchemaV0,
+  InteractionSchemaV1,
+  DimensionFieldSchema,
+  SplitMapsSchema,
+  filterPropsV1,
+  default as visStateSchema
+} from './vis-state-schema';
+export {default as datasetSchema} from './dataset-schema';
+export {default as mapStyleSchema} from './map-style-schema';
+export {default as mapStateSchema} from './map-state-schema';
+export {default as Schema} from './schema';

package/src/schemas/map-state-schema.js

@@ -0,0 +1,52 @@
+// Copyright (c) 2022 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.
+
+import {VERSIONS} from './versions';
+import Schema from './schema';
+
+// version v0
+export const propertiesV0 = {
+  bearing: null,
+  dragRotate: null,
+  latitude: null,
+  longitude: null,
+  pitch: null,
+  zoom: null
+};
+
+export const propertiesV1 = {
+  ...propertiesV0,
+  isSplit: null
+};
+
+const mapStateSchema = {
+  [VERSIONS.v0]: new Schema({
+    version: VERSIONS.v0,
+    properties: propertiesV0,
+    key: 'mapState'
+  }),
+  [VERSIONS.v1]: new Schema({
+    version: VERSIONS.v1,
+    properties: propertiesV1,
+    key: 'mapState'
+  })
+};
+
+export default mapStateSchema;

package/src/schemas/map-style-schema.js

@@ -0,0 +1,95 @@
+// Copyright (c) 2022 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.
+
+import {VERSIONS} from './versions';
+import Schema from './schema';
+
+export const customMapStylePropsV1 = {
+  accessToken: null,
+  custom: null,
+  icon: null,
+  id: null,
+  label: null,
+  url: null
+};
+
+const CustomMapStyleSchema = new Schema({
+  version: VERSIONS.v1,
+  key: 'customStyle',
+  properties: customMapStylePropsV1
+});
+
+class MapStyleSchemaV1 extends Schema {
+  version = VERSIONS.v1;
+  key = 'mapStyles';
+  save(mapStyles) {
+    // save all custom styles
+    const saveCustomStyle = Object.keys(mapStyles).reduce(
+      (accu, key) => ({
+        ...accu,
+        ...(mapStyles[key].custom
+          ? {[key]: CustomMapStyleSchema.save(mapStyles[key]).customStyle}
+          : {})
+      }),
+      {}
+    );
+
+    return {[this.key]: saveCustomStyle};
+  }
+
+  load(mapStyles) {
+    // If mapStyle is an empty object, do not load it
+    return typeof mapStyles === 'object' && Object.keys(mapStyles).length
+      ? {[this.key]: mapStyles}
+      : {};
+  }
+}
+
+// version v0
+export const propertiesV0 = {
+  styleType: null,
+  topLayerGroups: null,
+  visibleLayerGroups: null,
+  buildingLayer: null,
+  mapStyles: new MapStyleSchemaV1()
+};
+
+export const propertiesV1 = {
+  styleType: null,
+  topLayerGroups: null,
+  visibleLayerGroups: null,
+  threeDBuildingColor: null,
+  mapStyles: new MapStyleSchemaV1()
+};
+
+const mapStyleSchema = {
+  [VERSIONS.v0]: new Schema({
+    version: VERSIONS.v0,
+    properties: propertiesV0,
+    key: 'mapStyle'
+  }),
+  [VERSIONS.v1]: new Schema({
+    version: VERSIONS.v1,
+    properties: propertiesV1,
+    key: 'mapStyle'
+  })
+};
+
+export default mapStyleSchema;