@carto/kepler.gl 0.0.80 → 0.1.0-alpha.1

package/dist/reducers/ui-state-updaters.d.ts

@@ -0,0 +1,434 @@
+import { EXPORT_IMG_RATIOS, RESOLUTIONS } from 'constants/default-settings';
+import ActionTypes from '../constants/action-types';
+import * as UiStateActions from 'actions/ui-state-actions';
+import { KeplerGlInitPayload, LoadFilesErrUpdaterAction } from '../actions';
+export type ExportImage = {
+    ratio: keyof typeof EXPORT_IMG_RATIOS;
+    resolution: keyof typeof RESOLUTIONS;
+    legend: boolean;
+    mapH: number;
+    mapW: number;
+    imageSize: {
+        zoomOffset: number;
+        scale: number;
+        imageW: number;
+        imageH: number;
+    };
+    imageDataUri: string;
+    exporting: boolean;
+    processing: boolean;
+    error: Error | false;
+    center: boolean;
+};
+export type ExportData = {
+    selectedDataset: string;
+    dataType: string;
+    filtered: boolean;
+};
+export type ExportHtml = {
+    exportMapboxAccessToken: null | string;
+    userMapboxToken: string;
+    mode: string;
+};
+export type ExportJson = {
+    hasData: boolean;
+};
+export type ExportMap = {
+    HTML: ExportHtml;
+    JSON: ExportJson;
+    format: 'HTML' | 'JSON';
+};
+export type MapControl = {
+    show: boolean;
+    active: boolean;
+    disableClose?: boolean;
+    activeMapIndex?: number;
+};
+export type MapControls = {
+    visibleLayers?: MapControl;
+    mapLegend?: MapControl;
+    toggle3d?: MapControl;
+    splitMap?: MapControl;
+    mapDraw?: MapControl;
+    mapLocale?: MapControl;
+};
+export type LoadFiles = {
+    fileLoading: boolean;
+};
+export type Notifications = {
+    message: string;
+    type: string;
+    topic: string;
+    id: string;
+    count: number;
+    isExpanded?: boolean;
+};
+export type Locale = string;
+export type LayerPanelListView = 'list' | 'sortByDataset';
+export type UiState = {
+    readOnly: boolean;
+    activeSidePanel: string;
+    currentModal: string | null;
+    datasetKeyToRemove: string | null;
+    visibleDropdown: string | null;
+    exportImage: ExportImage;
+    exportData: ExportData;
+    exportMap: ExportMap;
+    mapControls: MapControls;
+    notifications: Notifications[];
+    loadFiles: LoadFiles;
+    locale: Locale;
+    layerPanelListView: LayerPanelListView;
+};
+export declare const DEFAULT_ACTIVE_SIDE_PANEL = "layer";
+export declare const DEFAULT_MODAL = "addData";
+/**
+ * A list of map control visibility and whether is it active.
+ * @memberof uiStateUpdaters
+ * @constant
+ * @property visibleLayers Default: `{show: true, active: false}`
+ * @property mapLegend Default: `{show: true, active: false}`
+ * @property toggle3d Default: `{show: true}`
+ * @property splitMap Default: `{show: true}`
+ * @property mapDraw Default: `{show: true, active: false}`
+ * @property mapLocale Default: `{show: false, active: false}`
+ * @public
+ */
+export declare const DEFAULT_MAP_CONTROLS: MapControls;
+/**
+ * Default image export config
+ * @memberof uiStateUpdaters
+ * @constant
+ * @property ratio Default: `'SCREEN'`,
+ * @property resolution Default: `'ONE_X'`,
+ * @property legend Default: `false`,
+ * @property mapH Default: 0,
+ * @property mapW Default: 0,
+ * @property imageSize Default: {zoomOffset: 0, scale: 1, imageW: 0, imageH: 0},
+ * @property imageDataUri Default: `''`,
+ * @property exporting Default: `false`
+ * @property error Default: `false`
+ * @public
+ */
+export declare const DEFAULT_EXPORT_IMAGE: ExportImage;
+export declare const DEFAULT_LOAD_FILES: {
+    fileLoading: boolean;
+};
+/**
+ * Default initial `exportData` settings
+ * @memberof uiStateUpdaters
+ * @constant
+ * @property selectedDataset Default: `''`,
+ * @property dataType Default: `'csv'`,
+ * @property filtered Default: `true`,
+ * @public
+ */
+export declare const DEFAULT_EXPORT_DATA: ExportData;
+/**
+ * @constant
+ */
+export declare const DEFAULT_NOTIFICATIONS: any[];
+/**
+ * @constant
+ * @property exportMapboxAccessToken - Default: null, this is used when we provide a default mapbox token for users to take advantage of
+ * @property userMapboxToken - Default: '', mapbox token provided by user through input field
+ * @property mode - Default: 'READ', read only or editable
+ * @public
+ */
+export declare const DEFAULT_EXPORT_HTML: ExportHtml;
+/**
+ * @constant
+ * @property hasData - Default: 'true',
+ * @public
+ */
+export declare const DEFAULT_EXPORT_JSON: ExportJson;
+/**
+ * Export Map Config
+ * @constant
+ * @property HTML - Default: 'DEFAULT_EXPORT_HTML',
+ * @property JSON - Default: 'DEFAULT_EXPORT_JSON',
+ * @property format - Default: 'HTML',
+ * @public
+ */
+export declare const DEFAULT_EXPORT_MAP: ExportMap;
+/**
+ * Default initial `uiState`
+ * @memberof uiStateUpdaters
+ * @constant
+ * @property readOnly Default: `false`
+ * @property activeSidePanel Default: `'layer'`
+ * @property currentModal Default: `'addData'`
+ * @property datasetKeyToRemove Default: `null`
+ * @property visibleDropdown Default: `null`
+ * @property exportImage Default: [`DEFAULT_EXPORT_IMAGE`](#default_export_image)
+ * @property exportData Default: [`DEFAULT_EXPORT_DATA`](#default_export_data)
+ * @property exportMap Default: [`DEFAULT_EXPORT_MAP`](#default_export_map)
+ * @property mapControls Default: [`DEFAULT_MAP_CONTROLS`](#default_map_controls)
+ * @property notifications Default: `[]`
+ * @property notifications Default: `[]`
+ * @property loadFiles
+ * @public
+ */
+export declare const INITIAL_UI_STATE: UiState;
+/**
+ * @memberof uiStateUpdaters
+
+ */
+export declare const initUiStateUpdater: (state: UiState, action: {
+    type?: (typeof ActionTypes)['INIT'];
+    payload: KeplerGlInitPayload;
+}) => UiState;
+/**
+ * Toggle active side panel
+ * @memberof uiStateUpdaters
+ * @param state `uiState`
+ * @param action
+ * @param action.payload id of side panel to be shown, one of `layer`, `filter`, `interaction`, `map`. close side panel if `null`
+ * @returns nextState
+ * @public
+ */
+export declare const toggleSidePanelUpdater: (state: UiState, { payload: id }: UiStateActions.ToggleSidePanelUpdaterAction) => UiState;
+/**
+ * Show and hide modal dialog
+ * @memberof uiStateUpdaters
+ * @param state `uiState`
+ * @param action
+ * @paramaction.payload id of modal to be shown, null to hide modals. One of:
+ *  - [`DATA_TABLE_ID`](../constants/default-settings.md#data_table_id)
+ *  - [`DELETE_DATA_ID`](../constants/default-settings.md#delete_data_id)
+ *  - [`ADD_DATA_ID`](../constants/default-settings.md#add_data_id)
+ *  - [`EXPORT_IMAGE_ID`](../constants/default-settings.md#export_image_id)
+ *  - [`EXPORT_DATA_ID`](../constants/default-settings.md#export_data_id)
+ *  - [`ADD_MAP_STYLE_ID`](../constants/default-settings.md#add_map_style_id)
+ * @returns nextState
+ * @public
+ */
+export declare const toggleModalUpdater: (state: UiState, { payload: id }: UiStateActions.ToggleModalUpdaterAction) => UiState;
+/**
+ * Hide and show side panel header dropdown, activated by clicking the share link on top of the side panel
+ * @memberof uiStateUpdaters
+ * @public
+ */
+export declare const showExportDropdownUpdater: (state: UiState, { payload: id }: UiStateActions.ShowExportDropdownUpdaterAction) => UiState;
+/**
+ * Hide side panel header dropdown, activated by clicking the share link on top of the side panel
+ * @memberof uiStateUpdaters
+ * @public
+ */
+export declare const hideExportDropdownUpdater: (state: UiState) => UiState;
+/**
+ * Toggle active map control panel
+ * @memberof uiStateUpdaters
+ * @param state `uiState`
+ * @param action action
+ * @param action.payload map control panel id, one of the keys of: [`DEFAULT_MAP_CONTROLS`](#default_map_controls)
+ * @returns nextState
+ * @public
+ */
+export declare const toggleMapControlUpdater: (state: UiState, { payload: { panelId, index } }: UiStateActions.ToggleMapControlUpdaterAction) => UiState;
+/**
+ * Toggle map control visibility
+ * @memberof uiStateUpdaters
+ * @param state `uiState`
+ * @param action action
+ * @param action.payload map control panel id, one of the keys of: [`DEFAULT_MAP_CONTROLS`](#default_map_controls)
+ * @returns nextState
+ * @public
+ */
+export declare const setMapControlVisibilityUpdater: (state: UiState, { payload: { panelId, show } }: UiStateActions.setMapControlVisibilityUpdaterAction) => UiState;
+/**
+ * Toggle active map control panel
+ * @memberof uiStateUpdaters
+ * @param state `uiState`
+ * @param action
+ * @param action.payload dataset id
+ * @returns nextState
+ * @public
+ */
+export declare const openDeleteModalUpdater: (state: UiState, { payload: datasetKeyToRemove }: UiStateActions.OpenDeleteModalUpdaterAction) => UiState;
+/**
+ * Set `exportImage.legend` to `true` or `false`
+ * @memberof uiStateUpdaters
+ * @param state `uiState`
+ * @returns nextState
+ * @public
+ */
+export declare const setExportImageSettingUpdater: (state: UiState, { payload: newSetting }: UiStateActions.SetExportImageSettingUpdaterAction) => UiState;
+/**
+ * Set `exportImage.setExportImageDataUri` to a image dataUri
+ * @memberof uiStateUpdaters
+ * @param state `uiState`
+ * @param action
+ * @param action.payload export image data uri
+ * @returns nextState
+ * @public
+ */
+export declare const setExportImageDataUriUpdater: (state: UiState, { payload: dataUri }: UiStateActions.SetExportImageDataUriUpdaterAction) => UiState;
+/**
+ * @memberof uiStateUpdaters
+ * @public
+ */
+export declare const setExportImageErrorUpdater: (state: UiState, { payload: error }: UiStateActions.SetExportImageErrorUpdaterAction) => UiState;
+/**
+ * Delete cached export image
+ * @memberof uiStateUpdaters
+ * @public
+ */
+export declare const cleanupExportImageUpdater: (state: UiState) => UiState;
+/**
+ * Start image exporting flow
+ * @memberof uiStateUpdaters
+ * @param state
+ * @param options
+ * @returns {UiState}
+ * @public
+ */
+export declare const startExportingImageUpdater: (state: UiState, { payload: options }: {
+    payload: Partial<ExportImage>;
+}) => UiState;
+/**
+ * Set selected dataset for export
+ * @memberof uiStateUpdaters
+ * @param state `uiState`
+ * @param action
+ * @param action.payload dataset id
+ * @returns nextState
+ * @public
+ */
+export declare const setExportSelectedDatasetUpdater: (state: UiState, { payload: dataset }: UiStateActions.SetExportSelectedDatasetUpdaterAction) => UiState;
+/**
+ * Set data format for exporting data
+ * @memberof uiStateUpdaters
+ * @param state `uiState`
+ * @param action
+ * @param action.payload one of `'text/csv'`
+ * @returns nextState
+ * @public
+ */
+export declare const setExportDataTypeUpdater: (state: UiState, { payload: dataType }: UiStateActions.SetExportDataTypeUpdaterAction) => UiState;
+/**
+ * Whether to export filtered data, `true` or `false`
+ * @memberof uiStateUpdaters
+ * @param state `uiState`
+ * @param action
+ * @param action.payload
+ * @returns nextState
+ * @public
+ */
+export declare const setExportFilteredUpdater: (state: UiState, { payload: filtered }: UiStateActions.SetExportFilteredUpdaterAction) => UiState;
+/**
+ * Whether to including data in map config, toggle between `true` or `false`
+ * @memberof uiStateUpdaters
+ * @param state `uiState`
+ * @returns nextState
+ * @public
+ */
+export declare const setExportDataUpdater: (state: UiState) => UiState;
+/**
+ * whether to export a mapbox access to HTML single page
+ * @param state - `uiState`
+ * @param action
+ * @param action.payload
+ * @returns nextState
+ * @public
+ */
+export declare const setUserMapboxAccessTokenUpdater: (state: UiState, { payload: userMapboxToken }: UiStateActions.SetUserMapboxAccessTokenUpdaterAction) => UiState;
+/**
+ * Sets the export map format
+ * @param state - `uiState`
+ * @param action
+ * @param action.payload format to use to export the map into
+ * @return nextState
+ */
+export declare const setExportMapFormatUpdater: (state: UiState, { payload: format }: UiStateActions.SetExportMapFormatUpdaterAction) => UiState;
+/**
+ * Set the export html map mode
+ * @param state - `uiState`
+ * @param action
+ * @param action.payload to be set (available modes: EXPORT_HTML_MAP_MODES)
+ * @return nextState
+ */
+export declare const setExportMapHTMLModeUpdater: (state: UiState, { payload: mode }: UiStateActions.SetExportHTMLMapModeUpdaterAction) => UiState;
+/**
+ * Adds a new notification.
+ * Updates a notification in case of matching ids.
+ * @memberof uiStateUpdaters
+ * @param state `uiState`
+ * @param action
+ * @param action.payload Params of a notification
+ * @returns nextState
+ * @public
+ */
+export declare const addNotificationUpdater: (state: UiState, { payload }: UiStateActions.AddNotificationUpdaterAction) => UiState;
+/**
+ * Remove a notification
+ * @memberof uiStateUpdaters
+ * @param state `uiState`
+ * @param action
+ * @param action.payload id of the notification to be removed
+ * @returns nextState
+ * @public
+ */
+export declare const removeNotificationUpdater: (state: UiState, { payload: id }: UiStateActions.RemoveNotificationUpdaterAction) => UiState;
+/**
+ * Fired when file loading begin
+ * @memberof uiStateUpdaters
+ * @param state `uiState`
+ * @returns nextState
+ * @public
+ */
+export declare const loadFilesUpdater: (state: UiState) => UiState;
+/**
+ * Handles loading file success and set fileLoading property to false
+ * @memberof uiStateUpdaters
+ * @param state `uiState`
+ * @returns nextState
+ */
+export declare const loadFilesSuccessUpdater: (state: UiState) => UiState;
+/**
+ * Handles load file error and set fileLoading property to false
+ * @memberof uiStateUpdaters
+ * @param state
+ * @param action
+ * @param action.error
+ * @returns nextState
+ * @public
+ */
+export declare const loadFilesErrUpdater: (state: UiState, { error }: LoadFilesErrUpdaterAction) => UiState;
+/**
+ * Handles toggle map split and reset all map control index to 0
+ * @memberof uiStateUpdaters
+ * @param state
+ * @returns nextState
+ * @public
+ */
+export declare const toggleSplitMapUpdater: (state: UiState) => UiState;
+/**
+ * Toggle modal data
+ * @memberof uiStateUpdaters
+ * @param state
+ * @returns nextState
+ * @public
+ */
+export declare const showDatasetTableUpdater: (state: UiState) => UiState;
+/**
+ * Set the locale of the UI
+ * @memberof uiStateUpdaters
+ * @param state `uiState`
+ * @param action
+ * @param action.payload
+ * @param action.payload.locale locale
+ * @returns nextState
+ * @public
+ */
+export declare const setLocaleUpdater: (state: UiState, { payload: { locale } }: UiStateActions.SetLocaleUpdaterAction) => UiState;
+/**
+ * Toggle layer panel list view
+ * @memberof uiStateUpdaters
+ * @param state `uiState`
+ * @param action
+ * @param action.payload layer panel listView value. Can be 'list' or 'sortByDataset'
+ * @returns nextState
+ * @public
+ */
+export declare const toggleLayerPanelListViewUpdater: (state: UiState, { payload: listView }: UiStateActions.ToggleLayerPanelListViewAction) => UiState;

package/dist/reducers/ui-state.d.ts

@@ -0,0 +1,3 @@
+export declare const uiStateReducerFactory: (initialState?: {}) => import("redux-actions").ReduxCompatibleReducer<object, object>;
+declare const _default: import("redux-actions").ReduxCompatibleReducer<object, object>;
+export default _default;

package/dist/reducers/vis-state-merger.d.ts

@@ -0,0 +1,110 @@
+import { VisState, Datasets } from './vis-state-updaters';
+import { KeplerTable } from '../utils';
+import { ParsedConfig, ParsedLayer } from 'schemas';
+import { Layer, LayerColumns, LayerColumn } from 'layers';
+import { TooltipInfo } from './vis-state-updaters';
+import { SavedInteractionConfig } from 'schemas/schema-manager';
+export type Merger = {
+    merge: (state: VisState, config: any, fromConfig?: boolean) => VisState;
+    prop: string;
+    toMergeProp?: string;
+};
+export type VisStateMergers = Merger[];
+/**
+ * Merge loaded filters with current state, if no fields or data are loaded
+ * save it for later
+ *
+ */
+export declare function mergeFilters(state: VisState, filtersToMerge: NonNullable<ParsedConfig['visState']>['filters'], fromConfig?: boolean): VisState;
+export declare function createLayerFromConfig(state: VisState, layerConfig: any): Layer | null;
+export declare function serializeLayer(newLayer: any): ParsedLayer;
+/**
+ * Merge layers from de-serialized state, if no fields or data are loaded
+ * save it for later
+ *
+ */
+export declare function mergeLayers(state: VisState, layersToMerge?: NonNullable<ParsedConfig['visState']>['layers'], fromConfig?: boolean): VisState;
+export declare function insertLayerAtRightOrder(currentLayers: any, layersToInsert: any, currentOrder: any, preservedOrder?: string[]): {
+    newLayerOrder: any;
+    newLayers: any;
+};
+/**
+ * Merge interactions with saved config
+ *
+ */
+export declare function mergeInteractions(state: VisState, interactionToBeMerged: Partial<SavedInteractionConfig> | undefined, fromConfig?: boolean): VisState;
+/**
+ * Merge splitMaps config with current visStete.
+ * 1. if current map is split, but splitMap DOESNOT contain maps
+ *    : don't merge anything
+ * 2. if current map is NOT split, but splitMaps contain maps
+ *    : add to splitMaps, and add current layers to splitMaps
+ */
+export declare function mergeSplitMaps(state: VisState, splitMaps?: NonNullable<ParsedConfig['visState']>['splitMaps'], fromConfig?: boolean): VisState;
+/**
+ * Merge interactionConfig.tooltip with saved config,
+ * validate fieldsToShow
+ *
+ * @param state
+ * @param tooltipConfig
+ * @return - {mergedTooltip: {}, unmergedTooltip: {}}
+ */
+export declare function mergeInteractionTooltipConfig(state: VisState, tooltipConfig?: Pick<TooltipInfo['config'], 'fieldsToShow'> | null): {
+    mergedTooltip: {
+        [key: string]: import("./vis-state-updaters").TooltipField[];
+    };
+    unmergedTooltip: {
+        [key: string]: import("./vis-state-updaters").TooltipField[];
+    };
+};
+/**
+ * Merge layerBlending with saved
+ *
+ */
+export declare function mergeLayerBlending(state: VisState, layerBlending: NonNullable<ParsedConfig['visState']>['layerBlending'], fromConfig?: boolean): VisState;
+/**
+ * Merge animation config
+ */
+export declare function mergeAnimationConfig(state: VisState, animation: NonNullable<ParsedConfig['visState']>['animationConfig'], fromConfig?: boolean): VisState;
+/**
+ * Validate saved layer columns with new data,
+ * update fieldIdx based on new fields
+ *
+ * @param fields
+ * @param savedCols
+ * @param emptyCols
+ * @return - validated columns or null
+ */
+export declare function validateSavedLayerColumns(fields: KeplerTable['fields'], savedCols: {
+    [key: string]: string;
+}, emptyCols: LayerColumns): LayerColumns;
+export declare function validateColumn(column: LayerColumn & {
+    validator?: typeof validateColumn;
+}, columns: LayerColumns, allFields: KeplerTable['fields']): boolean;
+/**
+ * Validate saved text label config with new data
+ * refer to vis-state-schema.js TextLabelSchemaV1
+ *
+ * @param {Array<Object>} fields
+ * @param {Object} savedTextLabel
+ * @return {Object} - validated textlabel
+ */
+export declare function validateSavedTextLabel(fields: any, [layerTextLabel]: [any], savedTextLabel: any): {}[];
+/**
+ * Validate saved visual channels config with new data,
+ * refer to vis-state-schema.js VisualChannelSchemaV1
+ */
+export declare function validateSavedVisualChannels(fields: KeplerTable['fields'], newLayer: Layer, savedLayer: ParsedLayer): null | Layer;
+export declare function validateLayersByDatasets(datasets: Datasets, layerClasses: VisState['layerClasses'], layers?: NonNullable<ParsedConfig['visState']>['layers']): {
+    validated: Layer[];
+    failed: ParsedLayer[];
+};
+/**
+ * Validate saved layer config with new data,
+ * update fieldIdx based on new fields
+ */
+export declare function validateLayerWithData({ fields, id: dataId }: KeplerTable, savedLayer: ParsedLayer, layerClasses: VisState['layerClasses'], options?: {
+    allowEmptyColumn?: boolean;
+}): Layer | null;
+export declare function isValidMerger(merger: Merger): boolean;
+export declare const VIS_STATE_MERGERS: VisStateMergers;

package/dist/reducers/vis-state-selectors.d.ts

@@ -0,0 +1,10 @@
+export declare const getFileFormatNames: ((state: any) => string[]) & import("reselect").OutputSelectorFields<(args_0: any) => string[], {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+export declare const getFileExtensions: ((state: any) => string[]) & import("reselect").OutputSelectorFields<(args_0: any) => string[], {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};