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

package/src/schemas/schema-manager.d.ts

@@ -0,0 +1,229 @@
+import {
+  InteractionConfig,
+  Filter,
+  TooltipInfo,
+  SplitMap,
+  AnimationConfig,
+  VisState,
+  RGBColor,
+  Merge,
+  RGBAColor
+} from 'reducers';
+import {Schema} from './schema';
+
+import {LayerTextLabel} from 'layers/layer-factory';
+import {datasetSchema, visStateSchema, mapStyleSchema, mapStateSchema} from 'schemas';
+
+export type SavedFilter = {
+  dataId: Filter['dataId'];
+  id: Filter['id'];
+  name: Filter['name'];
+  type: Filter['type'];
+  value: Filter['value'];
+  enlarged: Filter['enlarged'];
+  plotType: Filter['plotType'];
+  yAxis: {
+    name: string;
+    type: string;
+  } | null;
+  speed: Filter['speed'];
+  layerId: Filter['layerId'];
+};
+
+export type ParsedFilter = Partial<SavedFilter>;
+
+export type SavedInteractionConfig = {
+  tooltip: TooltipInfo['config'] & {
+    enabled: boolean;
+  };
+  geocoder: TooltipInfo['geocoder'] & {
+    enabled: boolean;
+  };
+  brush: TooltipInfo['brush'] & {
+    enabled: boolean;
+  };
+  coordinate: TooltipInfo['coordinate'] & {
+    enabled: boolean;
+  };
+};
+
+export type SavedField = {
+  name: string;
+  type: string;
+} | null;
+export type SavedScale = string;
+export type SavedVisualChannels = {
+  [key: string]: SavedField | SavedScale;
+};
+
+export type SavedLayer = {
+  id: string;
+  type: string;
+  config: {
+    dataId: string;
+    label: string;
+    color: RGBColor;
+    highlightColor: RGBAColor;
+    columns: {
+      [key: string]: string;
+    };
+    isVisible: boolean;
+    visConfig: object;
+    hidden: boolean;
+    visibilityByZoom: {min: number; max: number};
+    textLabel: Merge<LayerTextLabel, {field: {name: string; type: string} | null}>;
+  };
+  visualChannels: SavedVisualChannels;
+};
+
+export type ParsedLayer = {
+  id?: string;
+  type?: string;
+  config?: Partial<SavedLayer['config']>;
+};
+
+export type SavedAnimationConfig = {
+  currentTime: AnimationConfig['currentTime'];
+  speed: AnimationConfig['speed'];
+};
+
+export type SavedVisState = {
+  filters: SavedFilter[];
+  layers: SavedLayer[];
+  interactionConfig: SavedInteractionConfig;
+  layerBlending: string;
+  splitMaps: SplitMap[];
+  animationConfig: SavedAnimationConfig;
+};
+
+export type SavedMapState = {
+  bearing: number;
+  dragRotate: boolean;
+  latitude: number;
+  longitude: number;
+  pitch: number;
+  zoom: number;
+  isSplit: boolean;
+};
+
+export type SavedLayerGroups = {
+  [key: string]: boolean;
+};
+
+export type SavedCustomMapStyle = {
+  [key: string]: {
+    accessToken: string;
+    custom: boolean;
+    icon: string;
+    id: string;
+    label: string;
+    url: string;
+  };
+};
+
+export type SavedMapStyle = {
+  styleType: string;
+  topLayerGroups: SavedLayerGroups;
+  visibleLayerGroups: SavedLayerGroups;
+  threeDBuildingColor: RGBColor;
+  mapStyles: SavedCustomMapStyle;
+};
+
+/** Schema for v1 saved configuration */
+export type SavedConfigV1 = {
+  version: 'v1';
+  config: {
+    visState: SavedVisState;
+    mapState: SavedMapState;
+    mapStyle: SavedMapStyle;
+  };
+};
+
+/** Schema for a parsed configuration ("normalized" across versions) */
+export type ParsedConfig = {
+  version: string;
+  visState?: {
+    layers?: ParsedLayer[];
+    filters?: ParsedFilter[];
+    interactionConfig?: Partial<SavedInteractionConfig>;
+    layerBlending?: string;
+    splitMaps?: SplitMap[];
+    animationConfig?: Partial<SavedAnimationConfig>;
+  };
+  mapState?: Partial<SavedMapState>;
+  mapStyle?: Partial<SavedMapStyle>;
+};
+
+export type SavedField = {
+  name: string;
+  type: string;
+  format?: string;
+  analyzerType?: string;
+};
+
+export type ParsedField = {
+  name: string;
+  type: string;
+  format: string;
+  analyzerType: string;
+};
+
+export type SavedDatasetV1 = {
+  version: 'v1';
+  data: {
+    id: string;
+    label: string;
+    color: RGBColor;
+    allData: any[][];
+    fields: SavedField[];
+  };
+};
+
+export type ParsedDataset = {
+  data: {
+    fields: ParsedField[];
+    rows: anu[][];
+  };
+  info: {
+    id?: string;
+    label?: string;
+    color?: RGBColor;
+  };
+};
+
+export type SavedMap = {
+  datasets: SavedDatasetV1[];
+  config: SavedConfigV1;
+  info: {
+    app: string;
+    created_at: string;
+    title: string;
+    description: string;
+  };
+};
+
+export type LoadedMap = {datasets?: ParsedDataset[] | null; config?: ParsedConfig | null};
+export const reducerSchema: {
+  [key: string]: typeof mapStateSchema | typeof visStateSchema | typeof mapStyleSchema;
+};
+
+export class KeplerGLSchema {
+  constructor(prop: {
+    reducers?: typeof reducerSchema;
+    datasets?: typeof datasetSchema;
+    validVersions?: string[];
+    version?: string;
+  });
+  save(state: any): SavedMap;
+  load(arg1: SavedMap | SavedMap['datasets'] | any, arg1?: SavedMap['cnofig'] | any): LoadedMap;
+  getMapInfo(state: any): VisState['mapInfo'];
+  getDatasetToSave(state: any): SavedDatasetV1[];
+  getConfigToSave(state: any): SavedConfigV1;
+  parseSavedConfig(config: any): ParsedConfig | null;
+  parseSavedData(datasets: any): ParsedDataset[] | null;
+  validateVersion(version: any): string | null;
+  hasDataChanged(state: any): boolean;
+}
+const KeplerGLSchemaManager: KeplerGLSchema;
+
+export default KeplerGLSchemaManager;

package/src/schemas/schema-manager.js

@@ -0,0 +1,228 @@
+// 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 {console as Console} from 'global/window';
+
+import visStateSchema from './vis-state-schema';
+import datasetSchema from './dataset-schema';
+import mapStyleSchema from './map-style-schema';
+import mapStateSchema from './map-state-schema';
+
+import {CURRENT_VERSION, VERSIONS} from './versions';
+import {isPlainObject} from 'utils/utils';
+
+export const reducerSchema = {
+  visState: visStateSchema,
+  mapState: mapStateSchema,
+  mapStyle: mapStyleSchema
+};
+
+/** @type {typeof import('./schema-manager').KeplerGLSchema} */
+export class KeplerGLSchema {
+  constructor({
+    reducers = reducerSchema,
+    datasets = datasetSchema,
+    validVersions = VERSIONS,
+    version = CURRENT_VERSION
+  } = {}) {
+    this._validVersions = validVersions;
+    this._version = version;
+    this._reducerSchemas = reducers;
+    this._datasetSchema = datasets;
+
+    this._datasetLastSaved = null;
+    this._savedDataset = null;
+  }
+
+  /**
+   * stateToSave = {
+   *   datasets: [
+   *     {
+   *       version: 'v0',
+   *       data: {id, label, color, allData, fields}
+   *     },
+   *     {
+   *       version: 'v0',
+   *       data: {id, label, color, allData, fields}
+   *     }
+   *   ],
+   *   config: {
+   *     version: 'v0',
+   *     config: {}
+   *   },
+   *   info: {
+   *     app: 'kepler.gl',
+   *     create_at: 'Mon May 28 2018 21:04:46 GMT-0700 (PDT)'
+   *   }
+   * }
+   *
+   * Get config and data of current map to save
+   * @param state
+   * @returns app state to save
+   */
+  save(state) {
+    return {
+      datasets: this.getDatasetToSave(state),
+      config: this.getConfigToSave(state),
+      info: {
+        app: 'kepler.gl',
+        created_at: new Date().toString(),
+        ...this.getMapInfo(state)
+      }
+    };
+  }
+
+  getMapInfo(state) {
+    return state.visState.mapInfo;
+  }
+  /**
+   *  Load saved map, argument can be (datasets, config) or ({datasets, config})
+   * @param savedDatasets
+   * @param savedConfig
+   */
+  load(savedDatasets, savedConfig) {
+    // if pass dataset and config in as a single object
+    if (
+      arguments.length === 1 &&
+      isPlainObject(arguments[0]) &&
+      (Array.isArray(arguments[0].datasets) || isPlainObject(arguments[0].config))
+    ) {
+      return this.load(arguments[0].datasets, arguments[0].config);
+    }
+
+    return {
+      ...(Array.isArray(savedDatasets) ? {datasets: this.parseSavedData(savedDatasets)} : {}),
+      ...(savedConfig ? {config: this.parseSavedConfig(savedConfig)} : {})
+    };
+  }
+
+  /**
+   * Get data to save
+   * @param state - app state
+   * @returns - dataset to save
+   */
+  getDatasetToSave(state) {
+    const dataChangedSinceLastSave = this.hasDataChanged(state);
+    if (!dataChangedSinceLastSave) {
+      return this._savedDataset;
+    }
+
+    const {visState} = state;
+
+    const datasets = Object.values(visState.datasets).map(ds => ({
+      version: this._version,
+      data: this._datasetSchema[this._version].save(ds)
+    }));
+
+    // keep a copy of formatted datasets to save
+    this._datasetLastSaved = visState.datasets;
+    this._savedDataset = datasets;
+
+    return datasets;
+  }
+
+  /**
+   * Get App config to save
+   * @param {Object} state - app state
+   * @returns {{version: String, config: Object}} - config to save
+   */
+  getConfigToSave(state) {
+    const config = Object.keys(this._reducerSchemas).reduce(
+      (accu, key) => ({
+        ...accu,
+        ...(state[key] ? this._reducerSchemas[key][this._version].save(state[key]) : {})
+      }),
+      {}
+    );
+
+    return {
+      version: this._version,
+      config
+    };
+  }
+
+  /**
+   * Parse saved data
+   * @param datasets
+   * @returns - dataset to pass to addDataToMap
+   */
+  parseSavedData(datasets) {
+    return datasets.reduce((accu, ds) => {
+      const validVersion = this.validateVersion(ds.version);
+      if (!validVersion) {
+        return accu;
+      }
+      accu.push(this._datasetSchema[validVersion].load(ds.data));
+      return accu;
+    }, []);
+  }
+
+  /**
+   * Parse saved App config
+   */
+  parseSavedConfig({version, config}, state = {}) {
+    const validVersion = this.validateVersion(version);
+    if (!validVersion) {
+      return null;
+    }
+
+    return Object.keys(config).reduce(
+      (accu, key) => ({
+        ...accu,
+        ...(key in this._reducerSchemas
+          ? this._reducerSchemas[key][validVersion].load(config[key])
+          : {})
+      }),
+      {}
+    );
+  }
+
+  /**
+   * Validate version
+   * @param version
+   * @returns validVersion
+   */
+  validateVersion(version) {
+    if (!version) {
+      Console.error('There is no version number associated with this saved map');
+      return null;
+    }
+
+    if (!this._validVersions[version]) {
+      Console.error(`${version} is not a valid version`);
+      return null;
+    }
+
+    return version;
+  }
+
+  /**
+   * Check if data has changed since last save
+   * @param state
+   * @returns - whether data has changed or not
+   */
+  hasDataChanged(state) {
+    return this._datasetLastSaved !== state.visState.datasets;
+  }
+}
+
+const KeplerGLSchemaManager = new KeplerGLSchema();
+
+export default KeplerGLSchemaManager;

package/src/schemas/schema-utils.js

@@ -0,0 +1,54 @@
+// 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.
+
+/**
+ * Recursively save / load value for state based on property keys,
+ * if property[key] is another schema
+ * Use is to get value to save
+ * @param {Object} state - state to save
+ * @param {Object} properties - properties schema
+ * @returns {Object} - saved state
+ */
+export function savePropertiesOrApplySchema(state, properties) {
+  return getPropertyValueFromSchema('save', state, properties);
+}
+
+export function loadPropertiesOrApplySchema(state, properties) {
+  return getPropertyValueFromSchema('load', state, properties);
+}
+
+export function getPropertyValueFromSchema(operation, state, properties) {
+  return Object.keys(properties).reduce(
+    (accu, key) => ({
+      ...accu,
+      ...(key in state
+        ? properties[key]
+          ? // if it's another schema
+            properties[key][operation]
+            ? // call save or load
+              properties[key][operation](state[key], state)
+            : // if it's another property object
+              getPropertyValueFromSchema(operation, state[key], properties[key])
+          : {[key]: state[key]}
+        : {})
+    }),
+    {}
+  );
+}

package/src/schemas/schema.d.ts

@@ -0,0 +1,47 @@
+// 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.
+
+type Properties =
+  | {
+      [key: string]: null | Schema;
+    }
+  | string[]
+  | null;
+
+export class Schema {
+  constructor(prop?: {version?: string; key?: string; properties?: Properties}): any;
+  version: string;
+  key: string;
+  properties: Properties;
+  load(node: any, parents?: string[], accumulator?: any): {[key: string]: any};
+  save(node: any, parents?: string[], accumulator?: any): {[key: string]: any};
+  savePropertiesOrApplySchema(
+    node: any,
+    parents?: string[],
+    accumulator?: any
+  ): {[key: string]: any};
+  loadPropertiesOrApplySchema(
+    node: any,
+    parents?: string[],
+    accumulator?: any
+  ): {[key: string]: any};
+}
+
+export default Schema;

package/src/schemas/schema.js

@@ -0,0 +1,90 @@
+// 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 {console as Console} from 'global/window';
+
+import {CURRENT_VERSION} from './versions';
+
+/** @type {typeof import('./schema').Schema} */
+export default class Schema {
+  constructor({version = CURRENT_VERSION, key = '', properties = null} = {}) {
+    this.version = version;
+    this.properties = properties;
+    this.key = key;
+  }
+
+  loadPropertiesOrApplySchema(node, parents = [], accumulator) {
+    return this._getPropertyValueFromSchema('load', node, parents, accumulator);
+  }
+
+  savePropertiesOrApplySchema(node, parents = [], accumulator) {
+    return this._getPropertyValueFromSchema('save', node, parents, accumulator);
+  }
+
+  _getPropertyValueFromSchema(operation, node, parents = [], accumulator) {
+    const internal = `_${operation}`;
+    return {
+      [this.key]: this.properties
+        ? Object.keys(this.properties).reduce((accu, key) => {
+            return {
+              ...accu,
+              ...(key in node
+                ? this.properties[key]
+                  ? // if it's another schema
+                    this.properties[key][operation]
+                    ? // call save or load
+                      this.properties[key][internal](node[key], [...parents, node], accu)
+                    : {}
+                  : {[key]: node[key]}
+                : {})
+            };
+          }, {})
+        : node
+    };
+  }
+
+  _isCurrentVersion() {
+    return this.version === CURRENT_VERSION;
+  }
+
+  outdatedVersionError() {
+    if (!this._isCurrentVersion()) {
+      Console.error(`${this.key} ${this.version} is outdated. save should not be called anymore`);
+    }
+  }
+
+  _save(...args) {
+    // make sure nothing is saved to an outdated version
+    this.outdatedVersionError();
+    return this.save(...args);
+  }
+
+  save(node, parents = [], accumulator = {}) {
+    return this.savePropertiesOrApplySchema(node, parents, accumulator);
+  }
+
+  _load(...args) {
+    return this.load(...args);
+  }
+
+  load(node, parents = [], accumulator = {}) {
+    return this.loadPropertiesOrApplySchema(node, parents, accumulator);
+  }
+}

package/src/schemas/versions.d.ts

@@ -0,0 +1,23 @@
+// 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.
+
+export const VERSIONS: {[key: string]: string};
+
+export const CURRENT_VERSION: string;

package/src/schemas/versions.js

@@ -0,0 +1,28 @@
+// 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 keyMirror from 'keymirror';
+
+export const VERSIONS = keyMirror({
+  v0: null,
+  v1: null
+});
+
+export const CURRENT_VERSION = VERSIONS.v1;