@elliemae/ds-utilities 2.3.0-alpha.8 → 2.3.0-alpha.9

package/dist/types/capitalize.d.ts

@@ -0,0 +1 @@
+export declare const capitalize: (string: string) => string;

package/dist/types/compose.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Composes single-argument functions from right to left. The rightmost
+ * function can take multiple arguments as it provides the signature for
+ * the resulting composite function. [From redux v4.0.5]
+ *
+ * @param {...Function} funcs The functions to compose.
+ * @returns {Function} A function obtained by composing the argument functions
+ * from right to left. For example, compose(f, g, h) is identical to doing
+ * (...args) => f(g(h(...args))).
+ */
+export declare const compose: (...funcs: any[]) => any;
+export default compose;

package/dist/types/getComponentFromProps.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+export declare const getComponentFromProps: (Component: any, props: any, children?: never[]) => JSX.Element | null;
+export default getComponentFromProps;

package/dist/types/hooks/index.d.ts

@@ -0,0 +1,19 @@
+export { default as useMeasure } from 'use-measure';
+export { default as useForceUpdate } from 'use-force-update';
+export { default as useOnClickOutside } from 'use-onclickoutside';
+export { useUncontrolled } from 'uncontrollable';
+export { useExecutionTimer } from './useExecutionTimer';
+export { useExpandState } from './useExpandState';
+export { useHotkeys } from './useHotkeys';
+export { useHoverHandlersDelay } from './useHoverHandlersDelay';
+export { useResizeObserver } from './useResizeObserver';
+export { useShouldRecalculate } from './useShouldRecalculate';
+export { useWindowScrollerList } from './useWindowScrollerList';
+export { useWindowSize } from './useWindowSize';
+export { usePrevious } from './usePrevious';
+export { useCancellableDelayedCallback } from './useCancellableDelayedCallback';
+export { useDerivedStateFromProps } from './useDerivedStateFromProps';
+export { useSetRef } from './useSetRef';
+export { useParentElement } from './useParentElement';
+export { useOnElementResize } from './useOnElementResize';
+export { useIsShowingEllipsis } from './useIsShowingEllipsis';

package/dist/types/hooks/useCancellableDelayedCallback.d.ts

@@ -0,0 +1,2 @@
+export declare const useCancellableDelayedCallback: (cb: any, delay: any) => ((...args: any[]) => void)[];
+export default useCancellableDelayedCallback;

package/dist/types/hooks/useDerivedStateFromProps.d.ts

@@ -0,0 +1,2 @@
+export declare const useDerivedStateFromProps: (prop: any, options?: {}) => any[];
+export default useDerivedStateFromProps;

package/dist/types/hooks/useExecutionTimer.d.ts

@@ -0,0 +1,2 @@
+export declare const useExecutionTimer: (startFn: any, cleanFn: any, delayTime: any) => ((...args: any[]) => void)[];
+export default useExecutionTimer;

package/dist/types/hooks/useExpandState.d.ts

@@ -0,0 +1,23 @@
+export declare const useExpandState: ({ items, itemKey, expanded: expandedProp, onExpand, onExpandChange, onExpandAll, onToggleExpand, onCollapse, }: {
+    items?: never[] | undefined;
+    itemKey?: string | undefined;
+    expanded?: {} | undefined;
+    onExpand: any;
+    onExpandChange?: (() => null) | undefined;
+    onExpandAll?: (() => null) | undefined;
+    onToggleExpand: any;
+    onCollapse: any;
+}) => {
+    state: {
+        expanded: any;
+        isExpandedAll: boolean;
+    };
+    actions: {
+        expand: (item: any, stateData?: boolean) => void;
+        toggleExpandAll: (stateData?: boolean) => void;
+        toggleExpand: (item: any, stateData?: boolean) => void;
+        collapse: (item: any) => void;
+    };
+    setExpanded: any;
+};
+export default useExpandState;

package/dist/types/hooks/useHotkeys.d.ts

@@ -0,0 +1,6 @@
+export declare const useHotkeys: ({ keys, handler, options }: {
+    keys: any;
+    handler: any;
+    options?: {} | undefined;
+}, deps?: never[]) => void;
+export default useHotkeys;

package/dist/types/hooks/useHoverHandlersDelay.d.ts

@@ -0,0 +1,10 @@
+export declare const useHoverHandlersDelay: ({ onMouseOver, onMouseLeave, hideDelay, showDelay, }: {
+    onMouseOver: any;
+    onMouseLeave: any;
+    hideDelay?: number | undefined;
+    showDelay?: number | undefined;
+}) => {
+    onMouseOver: () => void;
+    onMouseLeave: () => void;
+};
+export default useHoverHandlersDelay;

package/dist/types/hooks/useIsShowingEllipsis.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+export declare const useIsShowingEllipsis: <T extends HTMLElement = HTMLSpanElement>() => {
+    setElement: import("react").Dispatch<import("react").SetStateAction<T | undefined>>;
+    isShowingEllipsis: boolean;
+};

package/dist/types/hooks/useOnElementResize.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const useOnElementResize: (targetRef: React.RefObject<HTMLDivElement>) => Record<'width' | 'height', number>;

package/dist/types/hooks/useParentElement.d.ts

@@ -0,0 +1 @@
+export declare const useParentElement: (ref: any) => any;

package/dist/types/hooks/usePrevious.d.ts

@@ -0,0 +1,2 @@
+export declare const usePrevious: (value: any) => undefined;
+export default usePrevious;

package/dist/types/hooks/useResizeObserver.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+export declare const useResizeObserver: (handler: any, el: any) => import("react").Dispatch<any>[];
+export default useResizeObserver;

package/dist/types/hooks/useSetRef.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare const useSetRef: (initial: any) => (import("react").MutableRefObject<any> | ((node: any) => void))[];

package/dist/types/hooks/useShouldRecalculate.d.ts

@@ -0,0 +1,2 @@
+export declare const useShouldRecalculate: (bool: any) => number;
+export default useShouldRecalculate;

package/dist/types/hooks/useWindowScrollerList.d.ts

@@ -0,0 +1,5 @@
+export declare const useWindowScrollerList: ({ listInstance, outerListRef }: {
+    listInstance: any;
+    outerListRef: any;
+}) => void;
+export default useWindowScrollerList;

package/dist/types/hooks/useWindowSize.d.ts

@@ -0,0 +1,2 @@
+export declare const useWindowSize: () => false | number[];
+export default useWindowSize;

package/dist/types/index.d.ts

@@ -0,0 +1,13 @@
+export { default as getComponentFromProps } from './getComponentFromProps';
+export { default as onClickHandlerForNonInteractiveElements } from './onClickHandlerForNonInteractiveElements';
+export { capitalize } from './capitalize';
+export { checkNotEmpty, checkEmpty, greaterThan, validDate, equal, notEqual, isNull, isNotNull, isIn, isNotIn, greaterThanOrEquals, lessThanOrEquals, startsWith, contains, } from './operators';
+export { cx, runAll, hashArray, safeCall, removeUndefinedProperties, isObject, curry, arrayMove, uniq, filter, uniqBy, groupBy, property, get, set, cloneDeep, debounce, findIndex, isEmpty, isString, isEqual, maxBy, meanBy, noop, omit, orderBy, pull, sortBy, sumBy, transform, isFunction, range, parseInt, padStart, isNaN, values, throttle, toggleInObject, toggleInArray, pick, pickBy, differenceBy, differenceWith, addOrRemove, isEqualWith, isBoolean, } from './utils';
+export { setRef, mergeRefs, logger } from './system';
+export { useMeasure, useForceUpdate, useOnClickOutside, useUncontrolled, useExecutionTimer, useExpandState, useHotkeys, useHoverHandlersDelay, useResizeObserver, useShouldRecalculate, useWindowScrollerList, useWindowSize, usePrevious, useCancellableDelayedCallback, useDerivedStateFromProps, useSetRef, useParentElement, useOnElementResize, useIsShowingEllipsis, } from './hooks';
+export { getVisibleTimeByFormat, addLeadingZeros } from './timeUtils';
+export { compose } from './compose';
+export { DOCUMENT, WINDOW } from './platform';
+export { isClassComponent, isFunctionComponent, isReactComponent, isElement, isDOMTypeElement, isCompositeTypeElement, } from './reactTypesUtility';
+export { resetTimer } from './scrollingTimer';
+export { isRequired, isGreaterThan, isValidDate } from './validations';

package/dist/types/onClickHandlerForNonInteractiveElements.d.ts

@@ -0,0 +1,12 @@
+/**
+ * onClickHandler: callback
+ *
+ * @param onClickHandler
+ */
+export declare const onClickHandlerForNonInteractiveElements: (onClickHandler: any) => {
+    role: string;
+    tabIndex: string;
+    onClick: any;
+    onKeyPress: (event: any) => void;
+};
+export default onClickHandlerForNonInteractiveElements;

package/dist/types/operators.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Check if the value is null undefined ''
+ *
+ * @param value
+ */
+export declare const checkNotEmpty: (value: any) => boolean;
+export declare const checkEmpty: (value: any) => boolean;
+/**
+ * @param value: number
+ * @param comparator: number
+ * @param value
+ * @param comparator
+ */
+export declare const greaterThan: (value: any, comparator: any) => boolean;
+/**
+ * Check if a valid date with format MM/DD/YYYY
+ *
+ * @param {*} value: string
+ * @param value
+ */
+export declare const validDate: (value: any) => boolean;
+export declare const equal: (a: any, b: any) => boolean;
+export declare const notEqual: (a: any, b: any) => boolean;
+export declare const isNull: (a: any) => boolean;
+export declare const isNotNull: (a: any) => boolean;
+export declare const isIn: (a: any, b: any) => boolean;
+export declare const isNotIn: (a: any, b: any) => boolean;
+export declare const greaterThanOrEquals: (value: any, comparator: any) => boolean;
+export declare const lessThanOrEquals: (value: any, comparator: any) => boolean;
+export declare const startsWith: (value: any, comparator: any) => boolean;
+export declare const contains: (value: any, comparator: any) => boolean;

package/dist/types/platform.d.ts

@@ -0,0 +1,2 @@
+export declare const DOCUMENT: Document | null;
+export declare const WINDOW: (Window & typeof globalThis) | null;

package/dist/types/reactTypesUtility.d.ts

@@ -0,0 +1,6 @@
+export declare function isClassComponent(component: any): boolean;
+export declare function isFunctionComponent(component: any): boolean;
+export declare function isReactComponent(component: any): boolean;
+export declare function isElement(element: any): boolean;
+export declare function isDOMTypeElement(element: any): boolean;
+export declare function isCompositeTypeElement(element: any): boolean;

package/dist/types/scrollingTimer.d.ts

@@ -0,0 +1 @@
+export declare const resetTimer: (func: any) => (...args: any[]) => void;

package/dist/types/system.d.ts

@@ -0,0 +1,3 @@
+export declare const setRef: (ref: any, value: any) => void;
+export declare function mergeRefs(...refs: any[]): (node: any) => void;
+export declare function logger(...args: any[]): void;

package/dist/types/timeUtils.d.ts

@@ -0,0 +1,7 @@
+export declare const getVisibleTimeByFormat: (format: any) => {
+    showHours: boolean;
+    showMinutes: boolean;
+    showSeconds: boolean;
+    use12Hours: boolean;
+};
+export declare const addLeadingZeros: (count: any) => (number: any) => string;

package/dist/types/utils.d.ts

@@ -0,0 +1,23 @@
+/**
+ * commonly used functions
+ * Add a level of indirection to lodash so we can replace
+ * it if desired, while keeping function names the same
+ */
+import { cloneDeep, filter, debounce, findIndex, isEmpty, isString, isEqual, noop, omit, orderBy, pull, sumBy, maxBy, meanBy, sortBy, transform, isFunction, uniq, uniqBy, groupBy, property, get, set, range, parseInt, padStart, isNaN, values, throttle, pick, pickBy, differenceBy, differenceWith, isEqualWith, curry, isObject, isBoolean } from 'lodash';
+/**
+ * Concatenates classNames from arguments
+ *
+ * @param {...any} classnames
+ */
+export declare const cx: (...classnames: any[]) => any;
+declare const toggleInObject: (obj: any, key: any, value: any) => any;
+declare const toggleInArray: (array: any, value: any) => any[];
+declare const arrayMove: (array: any, from: any, to: any) => any;
+declare const addOrRemove: (array: any, item: any, accessor?: (item: any) => any) => any;
+export declare function runAll(...fns: any[]): (...args: any[]) => void;
+export declare function hashArray(arr: any, fieldName: any): any;
+export declare function safeCall(fun: any, ...args: any[]): void;
+export declare const removeUndefinedProperties: (obj: any) => any;
+declare const _default: {};
+export default _default;
+export { isObject, curry, arrayMove, uniq, filter, uniqBy, groupBy, property, get, set, cloneDeep, debounce, findIndex, isEmpty, isString, isEqual, maxBy, meanBy, noop, omit, orderBy, pull, sortBy, sumBy, transform, isFunction, range, parseInt, padStart, isNaN, values, throttle, toggleInObject, toggleInArray, pick, pickBy, differenceBy, differenceWith, addOrRemove, isEqualWith, isBoolean, };

package/dist/types/validations.d.ts

@@ -0,0 +1,23 @@
+export declare const isRequired: ({ value, help }: {
+    value: any;
+    help?: string | undefined;
+}) => {
+    payload: string;
+    error: boolean;
+};
+export declare const isGreaterThan: ({ value, help, comparator }: {
+    value: any;
+    help: any;
+    comparator?: number | undefined;
+}) => {
+    payload: any;
+    error: boolean;
+};
+export declare const isValidDate: ({ value, help, format }: {
+    value: any;
+    help: any;
+    format?: string | undefined;
+}) => {
+    payload: any;
+    error: boolean;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/ds-utilities",
-  "version": "2.3.0-alpha.8",
+  "version": "2.3.0-alpha.9",
   "license": "MIT",
   "description": "ICE MT - Dimsum - Utilities",
   "files": [