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

package/src/reducers/core.d.ts

@@ -0,0 +1,25 @@
+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;

package/src/reducers/core.js

@@ -0,0 +1,97 @@
+// 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 {combineReducers} from 'redux';
+
+import {visStateReducerFactory} from './vis-state';
+import {mapStateReducerFactory} from './map-state';
+import {mapStyleReducerFactory} from './map-style';
+import {uiStateReducerFactory} from './ui-state';
+import {providerStateReducerFactory} from './provider-state';
+
+import composers from './composers';
+
+/**
+ * @type {typeof import('./core').combineReducers_}
+ */
+const combineReducers_ = combineReducers;
+
+const combined = (initialState = {}) =>
+  combineReducers_({
+    visState: visStateReducerFactory(initialState.visState),
+    mapState: mapStateReducerFactory(initialState.mapState),
+    mapStyle: mapStyleReducerFactory(initialState.mapStyle),
+    uiState: uiStateReducerFactory(initialState.uiState),
+    providerState: providerStateReducerFactory(initialState.providerState)
+  });
+
+export const coreReducerFactory = (initialState = {}) => (state, action) => {
+  if (composers[action.type]) {
+    return composers[action.type](state, action);
+  }
+  return combined(initialState)(state, action);
+};
+
+export default coreReducerFactory();
+
+/**
+ * Connect subreducer `mapState`, used with `injectComponents`. Learn more at
+ * [Replace UI Component](../advanced-usages/replace-ui-component.md#pass-custom-component-props)
+ *
+ * @param {*} reduxState
+ * @public
+ */
+export const mapStateLens = reduxState => ({mapState: reduxState.mapState});
+
+/**
+ * Connect subreducer `mapStyle`, used with `injectComponents`. Learn more at
+ * [Replace UI Component](../advanced-usages/replace-ui-component.md#pass-custom-component-props)
+ *
+ * @param {*} reduxState
+ * @public
+ */
+export const mapStyleLens = reduxState => ({mapStyle: reduxState.mapStyle});
+
+/**
+ * Connect subreducer `visState`, used with `injectComponents`. Learn more at
+ * [Replace UI Component](../advanced-usages/replace-ui-component.md#pass-custom-component-props)
+ *
+ * @param {*} reduxState
+ * @public
+ */
+export const visStateLens = reduxState => ({visState: reduxState.visState});
+
+/**
+ * Connect subreducer `uiState`, used with `injectComponents`. Learn more at
+ * [Replace UI Component](../advanced-usages/replace-ui-component.md#pass-custom-component-props)
+ *
+ * @param {*} reduxState
+ * @public
+ */
+export const uiStateLens = reduxState => ({uiState: reduxState.uiState});
+
+/**
+ * Connect subreducer `providerState`, used with `injectComponents`. Learn more at
+ * [Replace UI Component](../advanced-usages/replace-ui-component.md#pass-custom-component-props)
+ *
+ * @param {*} reduxState
+ * @public
+ */
+export const providerStateLens = reduxState => ({providerState: reduxState.providerState});

package/src/reducers/index.d.ts

@@ -0,0 +1,118 @@
+// 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';

package/src/reducers/index.js

@@ -0,0 +1,53 @@
+// 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.
+
+// 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';
+
+// Helpers
+export * from './composer-helpers';

package/src/reducers/map-state-updaters.d.ts

@@ -0,0 +1,64 @@
+import * as MapStateActions from 'actions/map-state-actions';
+import {ReceiveMapConfigPayload} from '../actions/actions';
+import ActionTypes from 'constants/action-types';
+
+export type MapState = {
+  pitch: number;
+  bearing: number;
+  latitude: number;
+  longitude: number;
+  zoom: number;
+  dragRotate: boolean;
+  width: number;
+  height: number;
+  isSplit: boolean;
+  initialState?: any;
+};
+
+export type Bounds = [number, number, number, number];
+/** Width of viewport */
+export type Viewport = {
+  /**  Width of viewport */
+  width?: number;
+  /**  Height of viewport */
+  height?: number;
+  /**  Zoom of viewport */
+  zoom?: number;
+  /**  Camera angle in degrees (0 is straight down) */
+  pitch?: number;
+  /**  Map rotation in degrees (0 means north is up) */
+  bearing?: number;
+  /**  Latitude center of viewport on map in mercator projection */
+  latitude?: number;
+  /**  Longitude Center of viewport on map in mercator projection */
+  longitude?: number;
+  /**  Whether to enable drag and rotate map into perspective viewport */
+  dragRotate?: boolean;
+};
+
+export const INITIAL_MAP_STATE: MapState;
+
+export function updateMapUpdater(
+  state: MapState,
+  action: MapStateActions.UpdateMapUpdaterAction
+): MapState;
+export function fitBoundsUpdater(
+  state: MapState,
+  action: MapStateActions.FitBoundsUpdaterAction
+): MapState;
+export function togglePerspectiveUpdater(
+  state: MapState,
+  action: MapStateActions.TogglePerspectiveUpdaterAction
+): MapState;
+export function resetMapConfigUpdater(state: MapState): MapState;
+export function receiveMapConfigUpdater(
+  state: MapState,
+  action: {
+    type?: ActionTypes.RECEIVE_MAP_CONFIG;
+    payload: ReceiveMapConfigPayload;
+  }
+): MapState;
+export function toggleSplitMapUpdater(
+  state: MapState,
+  action: MapStateActions.ToggleSplitMapUpdaterAction
+): MapState;

package/src/reducers/map-state-updaters.js

@@ -0,0 +1,224 @@
+// 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 {getCenterAndZoomFromBounds} from 'utils/projection-utils';
+
+/** @typedef {import('./map-state-updaters').MapState} MapState */
+
+/**
+ * Updaters for `mapState` reducer. Can be used in your root reducer to directly modify kepler.gl's state.
+ * Read more about [Using updaters](../advanced-usage/using-updaters.md)
+ * @public
+ * @example
+ *
+ * import keplerGlReducer, {mapStateUpdaters} from 'kepler.gl/reducers';
+ * // Root Reducer
+ * const reducers = combineReducers({
+ *  keplerGl: keplerGlReducer,
+ *  app: appReducer
+ * });
+ *
+ * const composedReducer = (state, action) => {
+ *  switch (action.type) {
+ *    // click button to close side panel
+ *    case 'CLICK_BUTTON':
+ *      return {
+ *        ...state,
+ *        keplerGl: {
+ *          ...state.keplerGl,
+ *          foo: {
+ *             ...state.keplerGl.foo,
+ *             mapState: mapStateUpdaters.fitBoundsUpdater(
+ *               mapState, {payload: [127.34, 31.09, 127.56, 31.59]]}
+ *             )
+ *          }
+ *        }
+ *      };
+ *  }
+ *  return reducers(state, action);
+ * };
+ *
+ * export default composedReducer;
+ */
+/* eslint-disable no-unused-vars */
+// @ts-ignore
+const mapStateUpdaters = null;
+/* eslint-enable no-unused-vars */
+
+/**
+ * Default initial `mapState`
+ * @memberof mapStateUpdaters
+ * @constant
+ * @property pitch Default: `0`
+ * @property bearing Default: `0`
+ * @property latitude Default: `37.75043`
+ * @property longitude Default: `-122.34679`
+ * @property zoom Default: `9`
+ * @property dragRotate Default: `false`
+ * @property width Default: `800`
+ * @property height Default: `800`
+ * @property isSplit Default: `false`
+ * @type {MapState}
+ * @public
+ */
+export const INITIAL_MAP_STATE = {
+  pitch: 0,
+  bearing: 0,
+  latitude: 37.75043,
+  longitude: -122.34679,
+  zoom: 9,
+  dragRotate: false,
+  width: 800,
+  height: 800,
+  isSplit: false
+};
+
+/* Updaters */
+/**
+ * Update map viewport
+ * @memberof mapStateUpdaters
+ * @type {typeof import('./map-state-updaters').updateMapUpdater}
+ * @public
+ */
+export const updateMapUpdater = (state, action) => ({
+  ...state,
+  ...(action.payload || {})
+});
+
+/**
+ * Fit map viewport to bounds
+ * @memberof mapStateUpdaters
+ * @type {typeof import('./map-state-updaters').fitBoundsUpdater}
+ * @public
+ */
+export const fitBoundsUpdater = (state, action) => {
+  const centerAndZoom = getCenterAndZoomFromBounds(action.payload, {
+    width: state.width,
+    height: state.height
+  });
+  if (!centerAndZoom) {
+    // bounds is invalid
+    return state;
+  }
+
+  return {
+    ...state,
+    latitude: centerAndZoom.center[1],
+    longitude: centerAndZoom.center[0],
+    // For marginal or invalid bounds, zoom may be NaN. Make sure to provide a valid value in order
+    // to avoid corrupt state and potential crashes as zoom is expected to be a number
+    ...(Number.isFinite(centerAndZoom.zoom) ? {zoom: centerAndZoom.zoom} : {})
+  };
+};
+
+/**
+ * Toggle between 3d and 2d map.
+ * @memberof mapStateUpdaters
+ * @type {typeof import('./map-state-updaters').togglePerspectiveUpdater}
+ * @public
+ */
+export const togglePerspectiveUpdater = state => ({
+  ...state,
+  ...{
+    pitch: state.dragRotate ? 0 : 50,
+    bearing: state.dragRotate ? 0 : 24
+  },
+  dragRotate: !state.dragRotate
+});
+
+/**
+ * reset mapState to initial State
+ * @memberof mapStateUpdaters
+ * @type {typeof import('./map-state-updaters').resetMapConfigUpdater}
+ * @public
+ */
+export const resetMapConfigUpdater = state => ({
+  ...INITIAL_MAP_STATE,
+  ...state.initialState,
+  initialState: state.initialState
+});
+
+// consider case where you have a split map and user wants to reset
+/**
+ * Update `mapState` to propagate a new config
+ * @memberof mapStateUpdaters
+ * @type {typeof import('./map-state-updaters').receiveMapConfigUpdater}
+ * @public
+ */
+export const receiveMapConfigUpdater = (
+  state,
+  {payload: {config = {}, options = {}, bounds = null}}
+) => {
+  const {mapState} = config || {};
+
+  // merged received mapstate with previous state
+  let mergedState = {...state, ...mapState};
+
+  // if center map
+  // center map will override mapState config
+  if (options.centerMap && bounds) {
+    mergedState = fitBoundsUpdater(mergedState, {
+      payload: bounds
+    });
+  }
+
+  return {
+    ...mergedState,
+    // update width if `isSplit` has changed
+    ...getMapDimForSplitMap(mergedState.isSplit, state)
+  };
+};
+
+/**
+ * Toggle between one or split maps
+ * @memberof mapStateUpdaters
+ * @type {typeof import('./map-state-updaters').toggleSplitMapUpdater}
+ * @public
+ */
+export const toggleSplitMapUpdater = state => ({
+  ...state,
+  isSplit: !state.isSplit,
+  ...getMapDimForSplitMap(!state.isSplit, state)
+});
+
+// Helpers
+export function getMapDimForSplitMap(isSplit, state) {
+  // cases:
+  // 1. state split: true - isSplit: true
+  // do nothing
+  // 2. state split: false - isSplit: false
+  // do nothing
+  if (state.isSplit === isSplit) {
+    return {};
+  }
+
+  const width =
+    state.isSplit && !isSplit
+      ? // 3. state split: true - isSplit: false
+        // double width
+        state.width * 2
+      : // 4. state split: false - isSplit: true
+        // split width
+        state.width / 2;
+
+  return {
+    width
+  };
+}

package/src/reducers/map-state.js

@@ -0,0 +1,47 @@
+// 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 {handleActions} from 'redux-actions';
+import ActionTypes from 'constants/action-types';
+import * as mapStateUpdaters from './map-state-updaters';
+
+/**
+ * Important: Do not rename `actionHandler` or the assignment pattern of property value.
+ * It is used to generate documentation
+ */
+const actionHandler = {
+  [ActionTypes.UPDATE_MAP]: mapStateUpdaters.updateMapUpdater,
+  [ActionTypes.FIT_BOUNDS]: mapStateUpdaters.fitBoundsUpdater,
+  [ActionTypes.TOGGLE_PERSPECTIVE]: mapStateUpdaters.togglePerspectiveUpdater,
+  [ActionTypes.RECEIVE_MAP_CONFIG]: mapStateUpdaters.receiveMapConfigUpdater,
+  [ActionTypes.RESET_MAP_CONFIG]: mapStateUpdaters.resetMapConfigUpdater,
+  [ActionTypes.TOGGLE_SPLIT_MAP]: mapStateUpdaters.toggleSplitMapUpdater
+};
+
+/* Reducer */
+export const mapStateReducerFactory = (initialState = {}) =>
+  // @ts-ignore
+  handleActions(actionHandler, {
+    ...mapStateUpdaters.INITIAL_MAP_STATE,
+    ...initialState,
+    initialState
+  });
+
+export default mapStateReducerFactory();