Skip to content

Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.

[chore] Exported layer utils methods and added onDragStart onDragEnd props (#2210)

Igor Dc06ceca747df
diff --git a/src/components/src/index.ts b/src/components/src/index.ts
index e49dd1da6..8b430b67b 100644
--- a/src/components/src/index.ts
+++ b/src/components/src/index.ts
@@ -267,6 +267,7 @@ export type {LayerTypeListItemType} from './side-panel/layer-panel/layer-type-li
export type {LayerGroupColorPickerProps} from './side-panel/map-style-panel/map-layer-group-color-picker';
export type {MapLegendPanelProps, MapLegendPanelFactoryDeps} from './map/map-legend-panel';
export type {FormatterDropdownProps} from './common/data-table/option-dropdown';
+export type {LayerListProps, LayerListFactoryDeps} from './side-panel/layer-panel/layer-list';
export {
Icons,
diff --git a/src/components/src/kepler-gl.tsx b/src/components/src/kepler-gl.tsx
index a80d32e14..57ecdea00 100644
--- a/src/components/src/kepler-gl.tsx
+++ b/src/components/src/kepler-gl.tsx
@@ -30,7 +30,7 @@ import {RootContext, FeatureFlagsContextProvider, FeatureFlags} from './context'
import {OnErrorCallBack, OnSuccessCallBack, Viewport} from '@kepler.gl/types';
import {Layer} from '@kepler.gl/layers';
-import {DndContext, DragOverlay} from '@dnd-kit/core';
+import {DndContext, DragOverlay, DragEndEvent, DragStartEvent} from '@dnd-kit/core';
import {
MapStateActions,
@@ -60,7 +60,6 @@ import {
import {
DragItem,
- DND_MODIFIERS,
DND_EMPTY_MODIFIERS,
DRAGOVERLAY_MODIFIERS,
findDndContainerId,
@@ -345,6 +344,9 @@ type KeplerGLBasicProps = {
topMapContainerProps?: object;
bottomMapContainerProps?: object;
+
+ onDragStart?: (event: DragStartEvent) => void;
+ onDragEnd?: (event: DragEndEvent) => void;
};
type KeplerGLProps = KeplerGlState & KeplerGlActions & KeplerGLBasicProps;
@@ -508,7 +510,13 @@ function KeplerGlFactory(
this.props.visStateActions.toggleLayerForMap(containerId, layerId);
};
- _handleDragStart = ({active}) => {
+ _handleDragStart = event => {
+ if (this.props.onDragStart) {
+ this.props.onDragStart(event);
+ return;
+ }
+
+ const {active} = event;
const {
visState: {layers},
visStateActions
@@ -521,7 +529,14 @@ function KeplerGlFactory(
}
};
- _handleDragEnd = ({active, over}) => {
+ _handleDragEnd = event => {
+ if (this.props.onDragEnd) {
+ this.props.onDragEnd(event);
+ return;
+ }
+
+ const {active, over} = event;
+
const {
visState: {layerOrder, splitMaps},
visStateActions
@@ -634,7 +649,7 @@ function KeplerGlFactory(
<DndContext
onDragStart={this._handleDragStart}
onDragEnd={this._handleDragEnd}
- modifiers={!isSplit ? DND_MODIFIERS : DND_EMPTY_MODIFIERS}
+ modifiers={DND_EMPTY_MODIFIERS}
>
{!uiState.readOnly && !readOnly && <SidePanel {...sideFields} />}
<MapsLayout className="maps">{mapContainers}</MapsLayout>
diff --git a/src/components/src/map-container.tsx b/src/components/src/map-container.tsx
index 096bd89f0..20b2d4f17 100644
--- a/src/components/src/map-container.tsx
+++ b/src/components/src/map-container.tsx
@@ -144,7 +144,7 @@ interface StyledDroppableProps {
}
const StyledDroppable = styled.div<StyledDroppableProps>`
- background-color: ${({isOver}) => (isOver ? 'rgba(128,128,128,0.2)' : 'none')};
+ background-color: ${props => (props.isOver ? props.theme.dndOverBackgroundColor : 'none')};
width: 100%;
height: 100%;
position: absolute;
@@ -156,7 +156,10 @@ export const isSplitSelector = props =>
props.visState.splitMaps && props.visState.splitMaps.length > 1;
export const Droppable = ({containerId}) => {
- const {isOver, setNodeRef} = useDroppable({id: containerId});
+ const {isOver, setNodeRef} = useDroppable({
+ id: containerId,
+ data: {type: 'map', index: containerId}
+ });
return <StyledDroppable ref={setNodeRef} isOver={isOver} />;
};
@@ -301,6 +304,9 @@ interface MapContainerProps {
transformRequest?: any;
datasetAttributions?: DatasetAttribution[];
+
+ generateMapboxLayers?: typeof generateMapboxLayers;
+ generateDeckGLLayers?: typeof computeDeckLayers;
}
export default function MapContainerFactory(
@@ -412,12 +418,16 @@ export default function MapContainerFactory(
}
);
+ generateMapboxLayerMethodSelector = props => props.generateMapboxLayers ?? generateMapboxLayers;
+
mapboxLayersSelector = createSelector(
this.layersSelector,
this.layerDataSelector,
this.layerOrderSelector,
this.layersToRenderSelector,
- generateMapboxLayers
+ this.generateMapboxLayerMethodSelector,
+ (layer, layerData, layerOrder, layersToRender, generateMapboxLayerMethod) =>
+ generateMapboxLayerMethod(layer, layerData, layerOrder, layersToRender)
);
// merge in a background-color style if the basemap choice is NO_MAP_ID
@@ -658,7 +668,8 @@ export default function MapContainerFactory(
deckGlProps,
index,
mapControls,
- theme
+ theme,
+ generateDeckGLLayers
} = this.props;
const {hoverInfo, editor} = visState;
@@ -675,7 +686,8 @@ export default function MapContainerFactory(
const {setFeatures, onLayerClick, setSelectedFeature} = visStateActions;
- const deckGlLayers = computeDeckLayers(
+ const generateDeckGLLayersMethod = generateDeckGLLayers ?? computeDeckLayers;
+ const deckGlLayers = generateDeckGLLayersMethod(
{
visState,
mapState,
diff --git a/src/components/src/side-panel/layer-panel/layer-list.tsx b/src/components/src/side-panel/layer-panel/layer-list.tsx
index 2349d1d6d..53d7c6b8a 100644
--- a/src/components/src/side-panel/layer-panel/layer-list.tsx
+++ b/src/components/src/side-panel/layer-panel/layer-list.tsx
@@ -31,7 +31,7 @@ import {useSortable, SortableContext, verticalListSortingStrategy} from '@dnd-ki
import {CSS} from '@dnd-kit/utilities';
import {findById} from '@kepler.gl/utils';
-type LayerListProps = {
+export type LayerListProps = {
datasets: Datasets;
layers: Layer[];
layerOrder: string[];
@@ -41,6 +41,8 @@ type LayerListProps = {
visStateActions: typeof VisStateActions;
};
+export type LayerListFactoryDeps = [typeof LayerPanelFactory];
+
// make sure the element is always visible while is being dragged
// item being dragged is appended in body, here to reset its global style
diff --git a/src/components/src/side-panel/layer-panel/layer-panel-header.tsx b/src/components/src/side-panel/layer-panel/layer-panel-header.tsx
index 2ccce34b2..d1e6b9ce1 100644
--- a/src/components/src/side-panel/layer-panel/layer-panel-header.tsx
+++ b/src/components/src/side-panel/layer-panel/layer-panel-header.tsx
@@ -194,7 +194,11 @@ const StyledDragHandle = styled.div`
}
`;
-export const DragHandle = ({className, listeners, children}) => (
+export const DragHandle: React.FC<{className?: string; listeners?: any}> = ({
+ className,
+ listeners,
+ children
+}) => (
<StyledDragHandle className={className} {...(listeners ? listeners : {})}>
{children}
</StyledDragHandle>
diff --git a/src/constants/src/default-settings.ts b/src/constants/src/default-settings.ts
index 3e99912a3..3857265b0 100644
--- a/src/constants/src/default-settings.ts
+++ b/src/constants/src/default-settings.ts
@@ -973,7 +973,7 @@ export const EXPORT_MAP_FORMAT_OPTIONS = Object.entries(EXPORT_MAP_FORMATS).map(
})
);
-export function getHTMLMapModeTileUrl(mode) {
+export function getHTMLMapModeTileUrl(mode: string): string {
return `https://d1a3f4spazzrp4.cloudfront.net/kepler.gl/documentation/map-${mode.toLowerCase()}-mode.png`;
}
diff --git a/src/layers/src/editor-layer/editor-layer.ts b/src/layers/src/editor-layer/editor-layer.ts
index 1c0965e41..a877ec9da 100644
--- a/src/layers/src/editor-layer/editor-layer.ts
+++ b/src/layers/src/editor-layer/editor-layer.ts
@@ -19,6 +19,7 @@
// THE SOFTWARE.
import {EditableGeoJsonLayer} from '@nebula.gl/layers';
+import {Layer as DeckLayer, LayerProps as DeckLayerProps} from '@deck.gl/core/typed';
import {
DrawPolygonMode,
TranslateMode,
@@ -70,7 +71,7 @@ export function getEditorLayer({
featureCollection,
selectedFeatureIndexes,
viewport
-}: GetEditorLayerProps): EditableGeoJsonLayer {
+}: GetEditorLayerProps): DeckLayer<DeckLayerProps<any>> {
const {mode: editorMode} = editor;
let mode = DEFAULT_COMPOSITE_MODE;
diff --git a/src/layers/src/index.ts b/src/layers/src/index.ts
index 986ca67d2..e7bb3c9a3 100644
--- a/src/layers/src/index.ts
+++ b/src/layers/src/index.ts
@@ -42,7 +42,7 @@ export {defaultElevation as h3DefaultElevation} from './h3-hexagon-layer/h3-hexa
import {default as ScenegraphLayer} from './scenegraph-layer/scenegraph-layer';
import {default as TripLayer} from './trip-layer/trip-layer';
export {defaultLineWidth as tripDefaultLineWidth} from './trip-layer/trip-layer';
-export {containValidTime, parseTripGeoJsonTimestamp} from './trip-layer/trip-utils';
+export {coordHasLength4, containValidTime, isTripGeoJsonField, parseTripGeoJsonTimestamp, getAnimationDomainFromTimestamps} from './trip-layer/trip-utils';
import {default as S2GeometryLayer} from './s2-geometry-layer/s2-geometry-layer';
export {defaultElevation as s2DefaultElevation} from './s2-geometry-layer/s2-geometry-layer';
export {getS2Center} from './s2-geometry-layer/s2-utils';
diff --git a/src/reducers/src/index.ts b/src/reducers/src/index.ts
index 516d2b411..20ac3af28 100644
--- a/src/reducers/src/index.ts
+++ b/src/reducers/src/index.ts
@@ -71,8 +71,6 @@ export * from './composer-helpers';
// export types
export * from './vis-state-updaters';
-export * from './layer-utils';
-
export {INITIAL_UI_STATE} from './ui-state-updaters';
export type {
diff --git a/src/reducers/src/layer-utils.ts b/src/reducers/src/layer-utils.ts
index 3c188e276..38a9ee1a2 100644
--- a/src/reducers/src/layer-utils.ts
+++ b/src/reducers/src/layer-utils.ts
@@ -19,6 +19,7 @@
// THE SOFTWARE.
import {GEOCODER_LAYER_ID} from '@kepler.gl/constants';
+import {Layer as DeckLayer, LayerProps as DeckLayerProps} from '@deck.gl/core/typed';
import {
Field,
TooltipField,
@@ -96,15 +97,20 @@ export function findDefaultLayer(dataset: KeplerTable, layerClasses: LayerClasse
});
}
+type MinVisState = {
+ datasets: VisState['datasets'];
+ animationConfig: VisState['animationConfig'];
+};
+
/**
* Calculate layer data based on layer type, col Config,
* return updated layer if colorDomain, dataMap has changed.
* Also, returns updated layer in case the input layer was in invalid state.
* Adds an error message to the layer in case of an exception.
*/
-export function calculateLayerData(
+export function calculateLayerData<S extends MinVisState>(
layer: Layer,
- state: {datasets: Datasets},
+ state: S,
oldLayerData?: any
): {
layerData: any;
@@ -248,7 +254,7 @@ export function isLayerVisible(layer, mapLayers) {
// return {[id]: true \ false}
export function prepareLayersForDeck(
layers: Layer[],
- layerData: any[]
+ layerData: VisState['layerData']
): {
[key: string]: boolean;
} {
@@ -279,7 +285,9 @@ export function prepareLayersToRender(
);
}
-export function getCustomDeckLayers(deckGlProps) {
+type CustomDeckLayer = DeckLayer<DeckLayerProps<any>>;
+
+export function getCustomDeckLayers(deckGlProps?: any): [CustomDeckLayer[], CustomDeckLayer[]] {
const bottomDeckLayers = Array.isArray(deckGlProps?.layers)
? deckGlProps?.layers
: isFunction(deckGlProps?.layers)
@@ -317,24 +325,26 @@ export type ComputeDeckLayersProps = {
};
};
-export function bindLayerCallbacks(layerCallbacks = {}, idx) {
+export function bindLayerCallbacks(layerCallbacks: LayerCallbacks = {}, idx: number) {
return Object.keys(layerCallbacks).reduce(
(accu, key) => ({
...accu,
[key]: val => layerCallbacks[key](idx, val)
}),
- {}
+ {} as Record<string, (_idx: number, val: any) => void>
);
}
+export type LayerCallbacks = {
+ onLayerHover?: (idx: number, value: any) => void;
+ onSetLayerDomain?: (idx: number, value: any) => void;
+};
+
// eslint-disable-next-line complexity
export function computeDeckLayers(
{visState, mapState, mapStyle}: any,
options?: ComputeDeckLayersProps,
- layerCallbacks?: {
- onLayerHover?: (idx: number, value: any) => void;
- onSetLayerDomain?: (idx: number, value: any) => void;
- },
+ layerCallbacks?: LayerCallbacks,
deckGlProps?: any
): Layer[] {
const {
diff --git a/src/reducers/src/vis-state-updaters.ts b/src/reducers/src/vis-state-updaters.ts
index 271652078..60b0b3115 100644
--- a/src/reducers/src/vis-state-updaters.ts
+++ b/src/reducers/src/vis-state-updaters.ts
@@ -816,7 +816,7 @@ export function setFilterUpdater(
// @ts-ignore
const layerIdDifference = xor(newFilter.layerId, oldFilter.layerId);
- const layerDataIds = uniq(
+ const layerDataIds = uniq<string>(
layerIdDifference
.map(lid =>
get(
@@ -824,22 +824,22 @@ export function setFilterUpdater(
['config', 'dataId']
)
)
- .filter(d => d)
+ .filter(d => d) as string[]
);
// only filter datasetsIds
datasetIds = layerDataIds;
// Update newFilter dataIds
- const newDataIds = uniq(
+ const newDataIds = uniq<string>(
newFilter.layerId
- .map(lid =>
+ ?.map(lid =>
get(
state.layers.find(l => l.id === lid),
['config', 'dataId']
)
)
- .filter(d => d)
+ .filter(d => d) as string[]
);
newFilter = {
@@ -1631,6 +1631,7 @@ export const updateVisDataUpdater = (
const datasets = toArray(action.datasets);
const newDataEntries = datasets.reduce(
+ // @ts-expect-error Type '{}' is missing the following properties from type 'ProtoDataset': data, info
(accu, {info = {}, ...rest} = {}) => ({
...accu,
...(createNewDataEntry({info, ...rest}, state.datasets) || {})
@@ -2770,7 +2771,11 @@ export function replaceDatasetDepsInState<T extends VisState>(
? replacePropValueInState(replacedState, replacedItem, mergerOptions)
: replacedState;
- if (replacedState[mergerOptions.toMergeProp]?.length && preserveOrder) {
+ if (
+ mergerOptions.toMergeProp !== undefined &&
+ replacedState[mergerOptions.toMergeProp]?.length &&
+ preserveOrder
+ ) {
replacedState[preserveOrder] = propValue.map(item => item.id);
}
});
diff --git a/src/schemas/src/index.ts b/src/schemas/src/index.ts
index 32fe16368..78c50e7d5 100644
--- a/src/schemas/src/index.ts
+++ b/src/schemas/src/index.ts
@@ -42,7 +42,9 @@ export {
DimensionFieldSchema,
SplitMapsSchema,
filterPropsV1,
- default as visStateSchema
+ default as visStateSchema,
+ layerPropsV1,
+ layerPropsV0
} from './vis-state-schema';
export type {
SavedField,
diff --git a/src/schemas/src/schema.ts b/src/schemas/src/schema.ts
index e76f7019c..bcc425270 100644
--- a/src/schemas/src/schema.ts
+++ b/src/schemas/src/schema.ts
@@ -53,7 +53,7 @@ export default class Schema {
loadPropertiesOrApplySchema(
node: any,
- parents: object[] = [],
+ parents: any[] = [],
accumulator?: any
): {[key: string]: any} {
return this._getPropertyValueFromSchema('load', node, parents, accumulator);
diff --git a/src/schemas/src/vis-state-schema.ts b/src/schemas/src/vis-state-schema.ts
index f22fbd0ea..b6e692762 100644
--- a/src/schemas/src/vis-state-schema.ts
+++ b/src/schemas/src/vis-state-schema.ts
@@ -42,7 +42,8 @@ import {
SavedLayer,
MinSavedLayer,
SavedVisState,
- SplitMap
+ SplitMap,
+ ValueOf
} from '@kepler.gl/types';
import {Datasets} from '@kepler.gl/table';
import {Layer, LayerClassesType} from '@kepler.gl/layers';
@@ -105,11 +106,11 @@ export type PostMergerPayload = {
options?: AddDataToMapOptions;
layerMergers?: Merger<any>[];
};
-export type MergerActionPayload<S extends VisState> = {
+export type MergerActionPayload<S extends {}> = {
mergers: Merger<S>[];
postMergerPayload: PostMergerPayload;
};
-export type MergerMergeFunc<S extends VisState> = (
+export type MergerMergeFunc<S extends {}> = (
state: S,
config: any,
fromConfig: boolean,
@@ -120,18 +121,18 @@ export type ReplaceParentDatasetIdsFunc<T> = (
dataId: string,
dataIdToReplace: string
) => T | null;
-export type Merger<S extends VisState> = {
+export type Merger<S extends {}> = {
merge: MergerMergeFunc<S>;
prop: string | string[];
toMergeProp?: string | string[];
preserveOrder?: string;
waitToFinish?: boolean;
waitForLayerData?: boolean;
- replaceParentDatasetIds?: ReplaceParentDatasetIdsFunc<S['filters']>;
+ replaceParentDatasetIds?: ReplaceParentDatasetIdsFunc<ValueOf<S>>;
saveUnmerged?: (state: S, unmerged: any) => S;
getChildDatasetIds?: any;
};
-export type VisStateMergers<S extends VisState> = Merger<S>[];
+export type VisStateMergers<S extends {}> = Merger<S>[];
// in v0 geojson there is only sizeField
diff --git a/src/styles/src/base.ts b/src/styles/src/base.ts
index 6d6b1a758..c119fbb57 100644
--- a/src/styles/src/base.ts
+++ b/src/styles/src/base.ts
@@ -206,6 +206,7 @@ export const dropdownListBorderTopLT = '#D3D8E0';
export const dropdownListLineHeight = 20;
export const dropdownWrapperZ = 100;
export const dropdownWapperMargin = 4;
+export const dndOverBackgroundColor = 'rgba(128, 128, 128, 0.2)';
// Switch
export const switchWidth = 24;
@@ -1125,6 +1126,7 @@ export const theme = {
dropdownListShadow,
dropdownWrapperZ,
dropdownWapperMargin,
+ dndOverBackgroundColor,
modalScrollBar,
scrollBar,
sidePanelScrollBar,
diff --git a/src/table/src/gpu-filter-utils.ts b/src/table/src/gpu-filter-utils.ts
index 99656e1d4..e212a9ed6 100644
--- a/src/table/src/gpu-filter-utils.ts
+++ b/src/table/src/gpu-filter-utils.ts
@@ -38,7 +38,7 @@ export function setFilterGpuMode(filter: Filter, filters: Filter[]) {
const gpuFilters = filters.filter(f => f.dataId.includes(dataId) && f.gpu);
if (filter.gpu && gpuFilters.length === MAX_GPU_FILTERS) {
- return set(['gpu'], false, filter);
+ set(['gpu'], false, filter);
}
});
diff --git a/src/utils/src/data-utils.ts b/src/utils/src/data-utils.ts
index 786385805..4a29c30b9 100644
--- a/src/utils/src/data-utils.ts
+++ b/src/utils/src/data-utils.ts
@@ -309,7 +309,7 @@ const arrayMoveMutate = <T>(array: T[], from: number, to: number) => {
* @param from
* @param to
*/
-export const arrayMove = <T>(array: T[], from: number, to: number) => {
+export const arrayMove = <T>(array: T[], from: number, to: number): T[] => {
array = array.slice();
arrayMoveMutate(array, from, to);
return array;
diff --git a/src/utils/src/filter-utils.ts b/src/utils/src/filter-utils.ts
index 89cce7fef..747127fbf 100644
--- a/src/utils/src/filter-utils.ts
+++ b/src/utils/src/filter-utils.ts
@@ -35,6 +35,7 @@ import {
LAYER_TYPES,
FILTER_VIEW_TYPES
} from '@kepler.gl/constants';
+import {VisState} from '@kepler.gl/schemas';
import * as ScaleUtils from './data-scale-utils';
import {h3IsValid} from 'h3-js';
@@ -171,6 +172,7 @@ export function getDefaultFilter(dataId: string | null | string[]): FilterBase<L
return {
...DEFAULT_FILTER_STRUCTURE,
// store it as dataId and it could be one or many
+ // @ts-expect-error returns empty array for null, not array of nulls
dataId: toArray(dataId),
id: generateHashId(FILTER_ID_LENGTH)
};
@@ -513,7 +515,7 @@ export function getFilterFunction<L extends {config: {dataId: string | null}; id
}
}
-export function updateFilterDataId(dataId: string): FilterBase<LineChart> {
+export function updateFilterDataId(dataId: string | string[]): FilterBase<LineChart> {
return getDefaultFilter(dataId);
}
@@ -1136,14 +1138,9 @@ export function filterDatasetCPU<T extends StateType<K, L>, K extends KeplerTabl
/**
* Validate parsed filters with datasets and add filterProps to field
*/
+type MinVisState = Pick<VisState, 'layers' | 'datasets' | 'isMergingDatasets'>;
export function validateFiltersUpdateDatasets<
- S extends {
- datasets: {[id: string]: K};
- layers: L[];
- isMergingDatasets: {
- [datasetId: string]: boolean;
- };
- },
+ S extends MinVisState,
K extends KeplerTableModel<K, L>,
L extends {config: {dataId: string | null; label: string}; id: string}
>(
@@ -1168,7 +1165,11 @@ export function validateFiltersUpdateDatasets<
// we can merge a filter only if all datasets in filter.dataId are loaded
if (datasetIds.every(d => datasets[d] && !state.isMergingDatasets[d])) {
// all datasetIds in filter must be present the state datasets
- const {filter: validatedFilter, applyToDatasets, augmentedDatasets} = datasetIds.reduce(
+ const {filter: validatedFilter, applyToDatasets, augmentedDatasets} = datasetIds.reduce<{
+ filter: Filter | null;
+ applyToDatasets: string[];
+ augmentedDatasets: {[datasetId: string]: any};
+ }>(
(acc, datasetId) => {
const dataset = updatedDatasets[datasetId];
const layers = state.layers.filter(l => l.config.dataId === dataset.id);
@@ -1185,7 +1186,8 @@ export function validateFiltersUpdateDatasets<
filter: acc.filter
? {
...acc.filter,
- ...mergeFilterDomainStep(acc, updatedFilter)
+ // TODO check: changed from acc to acc.filter to fix types
+ ...mergeFilterDomainStep(acc.filter, updatedFilter)
}
: updatedFilter,
diff --git a/src/utils/src/utils.ts b/src/utils/src/utils.ts
index dc788f5bd..a4fd06090 100644
--- a/src/utils/src/utils.ts
+++ b/src/utils/src/utils.ts
@@ -25,7 +25,7 @@ import window from 'global/window';
* @param {number} count
* @returns {string} hash string
*/
-export function generateHashId(count = 6) {
+export function generateHashId(count: number = 6): string {
return Math.random()
.toString(36)
.substr(count);
@@ -35,7 +35,7 @@ export function generateHashId(count = 6) {
* Detect chrome
* @returns {boolean} - yes or no
*/
-export function isChrome() {
+export function isChrome(): boolean {
// Chrome 1+
return window.chrome && window.chrome.webstore;
}
@@ -55,7 +55,7 @@ export function capitalizeFirstLetter(str) {
* @param {string} str
* @returns {string}
*/
-export function camelToTitle(str) {
+export function camelToTitle(str: string): string {
const breakWord = str.replace(/([A-Z])/g, ' $1');
return capitalizeFirstLetter(breakWord);
}
@@ -66,7 +66,7 @@ export function camelToTitle(str) {
* @param {string} str
* @returns {string}
*/
-export const camelize = str => {
+export const camelize = (str: string): string => {
return str.replace(/(?:^\w|[A-Z]|\b\w|\s+)/g, (match, index) => {
if (Number(match) === 0) return ''; // or if (/\s+/.test(match)) for white spaces
return index === 0 ? match.toLowerCase() : match.toUpperCase();
@@ -81,7 +81,7 @@ export const camelize = str => {
* @param {*} item
* @returns {array} boom! much array. very indexed. so useful.
*/
-export function toArray(item) {
+export function toArray<T>(item: T | T[]): T[] {
if (Array.isArray(item)) {
return item;
}
@@ -100,9 +100,13 @@ export function toArray(item) {
* @param {*} value
* @returns {Array|Object}
*/
-export const insertValue = (obj, key, value) => {
+export const insertValue = <T extends any[] | object>(
+ obj: T,
+ key: number | string,
+ value: any
+): T => {
if (Array.isArray(obj) && typeof key === 'number') {
- return [...obj.slice(0, key), value, ...obj.slice(key + 1, obj.length)];
+ return [...obj.slice(0, key), value, ...obj.slice(key + 1, obj.length)] as T;
}
return {...obj, [key]: value};
@@ -112,18 +116,22 @@ export const insertValue = (obj, key, value) => {
* check if value is a loose object including a plain object, array, function
* @param {*} value
*/
-export function isObject(value) {
+export function isObject(value): boolean {
return value !== null && (typeof value === 'object' || typeof value === 'function');
}
-const setPath = ([key, ...next], value, obj) => {
+const setPath = <T extends any[] | object>(
+ [key, ...next]: (string | number)[],
+ value: any,
+ obj: object | any[]
+): T => {
// is Object allows js object, array and function
if (!isObject(obj)) {
- return obj;
+ return obj as T;
}
if (next.length === 0) {
- return insertValue(obj, key, value);
+ return insertValue(obj, key, value) as T;
}
// @ts-ignore
@@ -138,7 +146,14 @@ const setPath = ([key, ...next], value, obj) => {
* @returns {Object}
*/
// @ts-ignore
-export const set = (path, value, obj) => (obj === null ? obj : setPath(path, value, obj));
+export const set = <T extends any[] | object>(path: (string | number)[], value: any, obj: T): T =>
+ obj === null ? obj : setPath(path, value, obj);
+
+type ErrorObject = {
+ error?: any;
+ err?: any;
+ message?: any;
+};
/**
* Get error information of unknown type
@@ -149,7 +164,7 @@ export const set = (path, value, obj) => (obj === null ? obj : setPath(path, val
* @param {*} err - Unknown error
* @return {string} - human readable error msg
*/
-export function getError(err) {
+export function getError(err?: Error | ErrorObject | string): string {
if (!err) {
return 'Something went wrong';
}
@@ -172,7 +187,7 @@ export function getError(err) {
return null;
}
-export function arrayInsert(arr, index, val) {
+export function arrayInsert<T>(arr: T[], index: number, val: T): T[] {
if (!Array.isArray(arr)) {
return arr;
}
@@ -180,17 +195,17 @@ export function arrayInsert(arr, index, val) {
return [...arr.slice(0, index), val, ...arr.slice(index)];
}
-export function hasMobileWidth(breakPointValues) {
+export function hasMobileWidth(breakPointValues: {palm: number; desk: number}): boolean {
const mobileWidth = window.matchMedia(`(max-width: ${breakPointValues.palm}px)`);
return mobileWidth.matches;
}
-export function hasPortableWidth(breakPointValues) {
+export function hasPortableWidth(breakPointValues: {palm: number; desk: number}): boolean {
const mobileWidth = window.matchMedia(`(max-width: ${breakPointValues.desk}px)`);
return mobileWidth.matches;
}
-export function isTest() {
+export function isTest(): boolean {
return process?.env?.NODE_ENV === 'test';
}
@@ -208,7 +223,7 @@ export function filterObjectByPredicate(obj, predicate) {
);
}
-export function isFunction(func) {
+export function isFunction(func): boolean {
return typeof func === 'function';
}