@synerise/ds-utils 1.3.0 → 1.4.0

package/README.md

@@ -2,6 +2,7 @@
 Package contains utils used across different DS components:
 
 List of utils:
+
 - doubleClickListener,
 - focusWithArrowKeys,
 - getInitials,

package/dist/doubleClickListener/doubleClickListener.d.ts

@@ -1,3 +1,3 @@
-import React from 'react';
-declare function doubleClickListener<T extends any>(onClick: (e: React.SyntheticEvent<T>) => void, onDblClick: (e: React.SyntheticEvent<T>) => void, delay?: number): React.ReactEventHandler<T>;
+import type React from 'react';
+declare function doubleClickListener<T>(onClick: (e: React.SyntheticEvent<T>) => void, onDblClick: (e: React.SyntheticEvent<T>) => void, delay?: number): React.ReactEventHandler<T>;
 export default doubleClickListener;

package/dist/doubleClickListener/doubleClickListener.js

@@ -1,6 +1,4 @@
 var DEFAULT_DELAY = 250;
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 function doubleClickListener(onClick, onDblClick, delay) {
   if (delay === void 0) {
     delay = DEFAULT_DELAY;

package/dist/focusWithArrowKeys/focusWithArrowKeys.d.ts

@@ -1,3 +1,3 @@
-import { KeyboardEvent } from 'react';
+import { type KeyboardEvent } from 'react';
 declare const focusWithArrowKeys: (keyDownEvent: KeyboardEvent, focusableItemClass: string, fallback: () => void) => void;
 export default focusWithArrowKeys;

package/dist/getPopupContainer/getPopupContainer.js

@@ -1,6 +1,8 @@
 export function getClosest(elem, selector) {
   for (var node = elem; node && node !== document.body; node = node.parentElement) {
-    if (node.matches(selector)) return node;
+    if (node.matches(selector)) {
+      return node;
+    }
   }
   return null;
 }

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 export { default as hexToRgba } from './hexToRgba/hexToRgba';
 export { default as toCamelCase } from './toCamelCase/toCamelCase';
-export { useOnClickOutside } from './useOnClickOutside/useOnClickOutside';
+export { useOnClickOutside, type HandledEventsType, } from './useOnClickOutside/useOnClickOutside';
 export { renderWithHighlight } from './renderWithHighlight/renderWithHighlight';
 export { default as selectColorByLetter } from './selectColorByLetter/selectColorByLetter';
 export { default as focusWithArrowKeys } from './focusWithArrowKeys/focusWithArrowKeys';
@@ -8,7 +8,7 @@ export { default as escapeRegEx } from './regex/regex';
 export { default as doubleClickListener } from './doubleClickListener/doubleClickListener';
 export { default as useResize } from './useResize/useResize';
 export { default as useResizeObserver } from './useResizeObserver/useResizeObserver';
-export { default as useBreakpoint } from './useBreakpoint/useBreakpoint';
+export * from './useBreakpoint/useBreakpoint';
 export { default as useCombinedRefs } from './useCombinedRefs/useCombinedRefs';
 export { default as usePrevious } from './usePrevious/usePrevious';
 export { useIsMounted } from './useIsMounted/useIsMounted';
@@ -24,5 +24,4 @@ export * from './useTraceUpdate';
 export * from './getPopupContainer';
 export * from './useLatestRef';
 export declare const NOOP: () => void;
-export type { HandledEventsType } from './useOnClickOutside/useOnClickOutside';
-export type { DataAttributes, ExactlyOne, LiteralStringUnion, WithHTMLAttributes, DeepPartial, RequiredProps, } from './types/types';
+export type { DataAttributes, ExactlyOne, LiteralStringUnion, WithHTMLAttributes, DeepPartial, RequiredProps, ObjectStringKeys, } from './types/types';

package/dist/index.js

@@ -8,7 +8,7 @@ export { default as escapeRegEx } from './regex/regex';
 export { default as doubleClickListener } from './doubleClickListener/doubleClickListener';
 export { default as useResize } from './useResize/useResize';
 export { default as useResizeObserver } from './useResizeObserver/useResizeObserver';
-export { default as useBreakpoint } from './useBreakpoint/useBreakpoint';
+export * from './useBreakpoint/useBreakpoint';
 export { default as useCombinedRefs } from './useCombinedRefs/useCombinedRefs';
 export { default as usePrevious } from './usePrevious/usePrevious';
 export { useIsMounted } from './useIsMounted/useIsMounted';
@@ -23,4 +23,4 @@ export * from './omitKeys/omitKeys';
 export * from './useTraceUpdate';
 export * from './getPopupContainer';
 export * from './useLatestRef';
-export var NOOP = function NOOP() {}; // eslint-disable-line @typescript-eslint/no-empty-function
+export var NOOP = function NOOP() {};

package/dist/regex/regex.js

@@ -1,5 +1,4 @@
-// eslint-disable-next-line no-useless-escape
 var escapeRegEx = function escapeRegEx(s) {
-  return s.replace(/[-\/\\^$*+?.()|[\]{}]/g, '\\$&');
+  return s.replace(/[-/\\^$*+?.()|[\]{}]/g, '\\$&');
 };
 export default escapeRegEx;

package/dist/renderWithHighlight/renderWithHighlight.d.ts

@@ -1,2 +1,2 @@
-import { ReactNode } from 'react';
+import { type ReactNode } from 'react';
 export declare const renderWithHighlight: (name: string, highlight?: string, className?: string, testId?: string) => ReactNode;

package/dist/selectColorByLetter/selectColorByLetter.js

@@ -1,5 +1,5 @@
-import { theme } from '@synerise/ds-core';
 import latinize from 'latinize';
+import { theme } from '@synerise/ds-core';
 export var palette = ['blue', 'cyan', 'fern', 'green', 'orange', 'yellow', 'red', 'mars', 'pink', 'violet', 'purple'];
 function getColorByLetter() {
   var colors = {};
@@ -10,7 +10,9 @@ function getColorByLetter() {
 }
 export var colorByLetter = getColorByLetter();
 export function getColor(colorString, forAvatar) {
-  if (!forAvatar) return theme.palette[colorString];
+  if (!forAvatar) {
+    return theme.palette[colorString];
+  }
   return {
     color: colorString.split('-')[0],
     hue: colorString.split('-')[1]

package/dist/testing/index.js

@@ -1,3 +1,2 @@
-// eslint-disable-next-line import/prefer-default-export
 export { default as renderWithProvider } from './renderWithProvider/renderWithProvider';
 export { sleep } from './sleep';

package/dist/testing/renderWithProvider/renderWithProvider.d.ts

@@ -1,9 +1,10 @@
-import { ReactNode } from 'react';
-import { RenderOptions, RenderResult } from '@testing-library/react';
-import { DSProviderProps } from '@synerise/ds-core';
-import { DataFormatNotationType } from '@synerise/ds-data-format';
+import { type ReactNode } from 'react';
+import { type DSProviderProps } from '@synerise/ds-core';
+import { type DataFormatNotationType } from '@synerise/ds-data-format';
+import { type RenderOptions, type RenderResult } from '@testing-library/react';
 type Options = Omit<RenderOptions, 'queries'>;
-declare const renderWithProvider: (node: ReactNode, options?: Options, props?: Partial<Omit<DSProviderProps, 'onErrorIntl' | 'dataFormatConfig'>> & {
+declare const renderWithProvider: (node: ReactNode, options?: Options, props?: Partial<Omit<DSProviderProps, "onErrorIntl" | "dataFormatConfig">> & {
     notation?: DataFormatNotationType;
+    applyTimeZoneOffset?: boolean;
 }) => RenderResult;
 export default renderWithProvider;

package/dist/testing/renderWithProvider/renderWithProvider.js

@@ -1,20 +1,23 @@
-var _excluded = ["notation"];
+var _excluded = ["notation", "applyTimeZoneOffset"];
 function _extends() { return _extends = Object.assign ? Object.assign.bind() : function (n) { for (var e = 1; e < arguments.length; e++) { var t = arguments[e]; for (var r in t) ({}).hasOwnProperty.call(t, r) && (n[r] = t[r]); } return n; }, _extends.apply(null, arguments); }
 function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (-1 !== e.indexOf(n)) continue; t[n] = r[n]; } return t; }
 import React from 'react';
-import { render } from '@testing-library/react';
 import { DSProvider } from '@synerise/ds-core';
 import { getDataFormatConfigFromNotation } from '@synerise/ds-data-format';
+import { render } from '@testing-library/react';
 import { NOOP } from '../../index';
 var _renderWithProvider = function renderWithProvider(node, options, props) {
   var _ref = props || {},
     notation = _ref.notation,
+    applyTimeZoneOffset = _ref.applyTimeZoneOffset,
     providerProps = _objectWithoutPropertiesLoose(_ref, _excluded);
+  var dataFormatConfigProps = applyTimeZoneOffset !== undefined || notation ? _extends({}, notation ? getDataFormatConfigFromNotation(notation) : {}, {
+    applyTimeZoneOffset: applyTimeZoneOffset
+  }) : {};
   var rendered = render(/*#__PURE__*/React.createElement(DSProvider, _extends({
-    onErrorIntl: NOOP
-  }, notation ? {
-    dataFormatConfig: getDataFormatConfigFromNotation(notation)
-  } : {}, providerProps), node), options);
+    onErrorIntl: NOOP,
+    dataFormatConfig: dataFormatConfigProps
+  }, providerProps), node), options);
   return _extends({}, rendered, {
     rerender: function rerender(ui, opt) {
       return _renderWithProvider(ui, _extends({

package/dist/types/types.d.ts

@@ -1,4 +1,4 @@
-import { HTMLAttributes } from 'react';
+import { type HTMLAttributes } from 'react';
 /**
  *  Allows creating a literal string union type with auto-completion in IDEs
  */
@@ -20,3 +20,9 @@ export type DeepPartial<T> = T extends object ? {
  * Makes selected props of the base type required
  */
 export type RequiredProps<BaseType, PropName extends keyof BaseType> = Required<Pick<BaseType, PropName>> & Omit<BaseType, PropName>;
+/**
+ * Literal string union of keys from object
+ */
+export type ObjectStringKeys<T> = {
+    [K in keyof T]: T[K] extends string ? K : never;
+}[keyof T];

package/dist/useBreakpoint/useBreakpoint.d.ts

@@ -2,15 +2,16 @@ export type Dimensions = {
     width: number;
     height: number;
 };
+export type BreakpointKey = 'xxl' | 'xl' | 'lg' | 'md' | 'sm' | 'xs';
 export type Breakpoint = {
     min: number;
     max: number;
     columns: number;
-    name: string;
+    name: BreakpointKey;
 };
 export type DimensionsWithBreakpoint = {
     dimensions: Dimensions;
     breakpoint?: Breakpoint;
 };
-declare const useBreakpoint: () => DimensionsWithBreakpoint;
+export declare const useBreakpoint: () => DimensionsWithBreakpoint;
 export default useBreakpoint;

package/dist/useBreakpoint/useBreakpoint.js

@@ -32,7 +32,7 @@ var BREAKPOINTS = {
     columns: 4
   }
 };
-var useBreakpoint = function useBreakpoint() {
+export var useBreakpoint = function useBreakpoint() {
   var _React$useState = React.useState({
       width: 0,
       height: 0

package/dist/useCombinedRefs/useCombinedRefs.d.ts

@@ -1,3 +1,3 @@
 import React from 'react';
-declare const useCombinedRefs: <T extends unknown>(...refs: React.Ref<T | null>[]) => React.MutableRefObject<T | null>;
+declare const useCombinedRefs: <T>(...refs: React.Ref<T | null>[]) => React.MutableRefObject<T | null>;
 export default useCombinedRefs;

package/dist/useCombinedRefs/useCombinedRefs.js

@@ -12,7 +12,6 @@ var useCombinedRefs = function useCombinedRefs() {
       if (typeof ref === 'function') {
         ref(targetRef.current);
       } else {
-        // eslint-disable-next-line no-param-reassign
         ref.current = targetRef.current;
       }
     });

package/dist/useElementInView/useElementInView.d.ts

@@ -1,4 +1,4 @@
-import { MutableRefObject } from 'react';
+import { type MutableRefObject } from 'react';
 type IntersectionObserverOptions = {
     rootMargin?: string;
     threshold?: number | number[];

package/dist/useIsMounted/useIsMounted.d.ts

@@ -1,2 +1 @@
-/// <reference types="react" />
 export declare const useIsMounted: () => import("react").MutableRefObject<boolean>;

package/dist/useLatestRef/useLatestRef.d.ts

@@ -1,2 +1 @@
-/// <reference types="react" />
 export declare const useLatestRef: <T>(value: T) => import("react").MutableRefObject<T>;

package/dist/useOnClickOutside/useOnClickOutside.d.ts

@@ -1,9 +1,14 @@
-import { RefObject } from 'react';
+import { type RefObject } from 'react';
 declare const MOUSEDOWN = "mousedown";
 declare const TOUCHSTART = "touchstart";
-declare const CLICK = "click";
-declare const CONTEXTMENU = "contextmenu";
-type HandledEvents = [typeof MOUSEDOWN, typeof TOUCHSTART, typeof CLICK, typeof CONTEXTMENU];
+declare const _CLICK = "click";
+declare const _CONTEXTMENU = "contextmenu";
+type HandledEvents = [
+    typeof MOUSEDOWN,
+    typeof TOUCHSTART,
+    typeof _CLICK,
+    typeof _CONTEXTMENU
+];
 export type HandledEventsType = HandledEvents[number];
 type PossibleEvent = {
     [Type in HandledEventsType]: HTMLElementEventMap[Type];

package/dist/useOnClickOutside/useOnClickOutside.js

@@ -1,8 +1,8 @@
 import { useEffect, useRef } from 'react';
 var MOUSEDOWN = 'mousedown';
 var TOUCHSTART = 'touchstart';
-var CLICK = 'click';
-var CONTEXTMENU = 'contextmenu';
+var _CLICK = 'click';
+var _CONTEXTMENU = 'contextmenu';
 var defaultEvents = [MOUSEDOWN, TOUCHSTART];
 
 /**

package/dist/useOverscrollBlock/useOverscrollBlock.d.ts

@@ -1,3 +1,2 @@
-/// <reference types="react" />
 declare const useOverscrollBlock: <T extends HTMLElement>() => import("react").MutableRefObject<T | undefined>;
 export default useOverscrollBlock;

package/dist/useResize/useResize.js

@@ -1,5 +1,4 @@
 import React from 'react';
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 var useResize = function useResize(componentRef, visible) {
   if (visible === void 0) {
     visible = true;
@@ -12,9 +11,10 @@ var useResize = function useResize(componentRef, visible) {
     setDimensions = _React$useState[1];
   React.useEffect(function () {
     var getDimensions = function getDimensions() {
+      var _componentRef$current, _componentRef$current2;
       return {
-        width: (componentRef == null ? void 0 : componentRef.current.offsetWidth) || 0,
-        height: (componentRef == null ? void 0 : componentRef.current.offsetHeight) || 0
+        width: (componentRef == null || (_componentRef$current = componentRef.current) == null ? void 0 : _componentRef$current.offsetWidth) || 0,
+        height: (componentRef == null || (_componentRef$current2 = componentRef.current) == null ? void 0 : _componentRef$current2.offsetHeight) || 0
       };
     };
     var handleResize = function handleResize() {

package/dist/useResizeObserver/useResizeObserver.d.ts

@@ -1,3 +1,3 @@
-import { RefObject } from 'react';
-declare const useResizeObserver: (elementRef: RefObject<HTMLElement | undefined>, resizeHandler?: ((dimensions: DOMRect) => void) | undefined) => DOMRect;
+import { type RefObject } from 'react';
+declare const useResizeObserver: (elementRef: RefObject<HTMLElement | undefined>, resizeHandler?: (dimensions: DOMRect) => void) => DOMRect;
 export default useResizeObserver;

package/dist/useResizeObserver/useResizeObserver.js

@@ -1,4 +1,4 @@
-import { useEffect, useState, useRef, useCallback } from 'react';
+import { useCallback, useEffect, useRef, useState } from 'react';
 var useResizeObserver = function useResizeObserver(elementRef, resizeHandler) {
   var _useState = useState(new DOMRect()),
     dimensions = _useState[0],

package/dist/useResizeToFit/useResizeToFit.d.ts

@@ -1,9 +1,8 @@
-/// <reference types="react" />
 type useResizeToFitProps = {
     onResize: (width: number) => void;
     autoObserve?: boolean;
 };
-declare const useResizeToFit: <T extends HTMLElement = HTMLDivElement>({ onResize, autoObserve }: useResizeToFitProps) => {
+declare const useResizeToFit: <T extends HTMLElement = HTMLDivElement>({ onResize, autoObserve, }: useResizeToFitProps) => {
     elementRef: import("react").RefObject<T>;
     disconnect: () => void;
     observe: () => void;

package/dist/useResizeToFit/useResizeToFit.js

@@ -1,4 +1,4 @@
-import { useEffect, useRef, useCallback } from 'react';
+import { useCallback, useEffect, useRef } from 'react';
 var useResizeToFit = function useResizeToFit(_ref) {
   var onResize = _ref.onResize,
     autoObserve = _ref.autoObserve;

package/dist/useScrollContain/useScrollContain.d.ts

@@ -1,2 +1 @@
-/// <reference types="react" />
 export declare const useScrollContain: <ElementType extends HTMLElement>() => import("react").RefObject<ElementType>;

package/dist/useSearchResults/search.utils.d.ts

@@ -1,5 +1,5 @@
-import { ReactText } from 'react';
-import { BaseGroupType } from './useSearchResults';
-export declare const isItemInGroup: <GroupType extends BaseGroupType<GroupType>>(groupId?: ReactText, currentGroup?: GroupType | undefined) => boolean;
-export declare const getActiveTabGroup: <GroupType extends BaseGroupType<GroupType>>(tabIndex: number, groups?: GroupType[] | undefined) => GroupType | undefined;
-export declare const getGroupName: <GroupType extends BaseGroupType<GroupType>>(groupId: ReactText, groups: BaseGroupType<GroupType>[]) => string | undefined;
+import { type ReactText } from 'react';
+import { type BaseGroupType } from './useSearchResults';
+export declare const isItemInGroup: <GroupType extends BaseGroupType<GroupType>>(groupId?: ReactText, currentGroup?: GroupType) => boolean;
+export declare const getActiveTabGroup: <GroupType extends BaseGroupType<GroupType>>(tabIndex: number, groups?: GroupType[]) => GroupType | undefined;
+export declare const getGroupName: <GroupType extends BaseGroupType<GroupType>>(groupId: ReactText | undefined, groups: BaseGroupType<GroupType>[]) => string | undefined;

package/dist/useSearchResults/search.utils.js

@@ -1,5 +1,7 @@
 export var isItemInGroup = function isItemInGroup(groupId, currentGroup) {
-  if (!currentGroup || !groupId) return true;
+  if (!currentGroup || !groupId) {
+    return true;
+  }
   return currentGroup.subGroups ? (currentGroup == null ? void 0 : currentGroup.subGroups.findIndex(function (group) {
     return group.id === groupId;
   })) > -1 : groupId === currentGroup.id;
@@ -9,9 +11,9 @@ export var getActiveTabGroup = function getActiveTabGroup(tabIndex, groups) {
 };
 export var getGroupName = function getGroupName(groupId, groups) {
   var _groups$flatMap$find;
-  return (_groups$flatMap$find = groups.flatMap(function (group) {
+  return groupId ? (_groups$flatMap$find = groups.flatMap(function (group) {
     return group.subGroups ? group.subGroups : group;
   }).find(function (group) {
     return group.id === groupId;
-  })) == null ? void 0 : _groups$flatMap$find.name;
+  })) == null ? void 0 : _groups$flatMap$find.name : undefined;
 };

package/dist/useSearchResults/useSearchResults.d.ts

@@ -1,4 +1,4 @@
-import { ReactText } from 'react';
+import { type ReactText } from 'react';
 export type BaseItemType = {
     id: ReactText | null;
     groupId?: ReactText;
@@ -10,8 +10,8 @@ export type BaseGroupType<SubGroupType> = {
     name: string;
     subGroups?: SubGroupType[];
 };
-export declare const useSearchResults: <ItemType extends BaseItemType, GroupType extends BaseGroupType<GroupType>, GroupedListItemType>(items: ItemType[], groups: GroupType[], activeTab: number, groupByGroupName: (items: ItemType[], max?: number) => GroupedListItemType[], activeGroup?: GroupType | undefined, searchQuery?: string, maxSearchResultsInGroup?: number) => {
+export declare const useSearchResults: <ItemType extends BaseItemType, GroupType extends BaseGroupType<GroupType>, GroupedListItemType>(items: ItemType[], groups: GroupType[], activeTab: number, groupByGroupName: (items: ItemType[], max?: number) => GroupedListItemType[], activeGroup?: GroupType, searchQuery?: string, maxSearchResultsInGroup?: number) => {
     searchResults: GroupedListItemType[];
-    getActiveTabGroup: <GroupType_1 extends BaseGroupType<GroupType_1>>(tabIndex: number, groups?: GroupType_1[] | undefined) => GroupType_1 | undefined;
-    getGroupName: <GroupType_2 extends BaseGroupType<GroupType_2>>(groupId: ReactText, groups: BaseGroupType<GroupType_2>[]) => string | undefined;
+    getActiveTabGroup: <GroupType_1 extends BaseGroupType<GroupType_1>>(tabIndex: number, groups?: GroupType_1[]) => GroupType_1 | undefined;
+    getGroupName: <GroupType_1 extends BaseGroupType<GroupType_1>>(groupId: ReactText | undefined, groups: BaseGroupType<GroupType_1>[]) => string | undefined;
 };

package/dist/useSearchResults/useSearchResults.js

@@ -14,7 +14,9 @@ export var useSearchResults = function useSearchResults(items, groups, activeTab
     });
   }, [groups]);
   var searchResults = useMemo(function () {
-    if (!searchQuery) return [];
+    if (!searchQuery) {
+      return [];
+    }
     var result = [];
     var itemsNumber = items.length;
     for (var i = 0; i < itemsNumber; i += 1) {

package/dist/useTraceUpdate/index.js

@@ -1,6 +1,4 @@
 import { useEffect, useRef } from 'react';
-
-// eslint-disable-next-line import/prefer-default-export
 export var useTraceUpdate = function useTraceUpdate(props) {
   var prev = useRef(props);
   useEffect(function () {
@@ -8,7 +6,6 @@ export var useTraceUpdate = function useTraceUpdate(props) {
       var k = _ref[0],
         v = _ref[1];
       if (prev.current[k] !== v) {
-        // eslint-disable-next-line no-param-reassign
         ps[k] = [prev.current[k], v];
       }
       return ps;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@synerise/ds-utils",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Utils UI Component for the Synerise Design System",
   "license": "ISC",
   "repository": "synerise/synerise-design",
@@ -33,7 +33,7 @@
   ],
   "types": "dist/index.d.ts",
   "dependencies": {
-    "@synerise/ds-data-format": "^1.0.0",
+    "@synerise/ds-data-format": "^1.1.0",
     "latinize": "^0.5.0"
   },
   "peerDependencies": {
@@ -41,5 +41,5 @@
     "react": ">=16.9.0 <= 18.3.1",
     "styled-components": "^5.3.3"
   },
-  "gitHead": "f2713cd35cfe22f63a159f05144585834897a132"
+  "gitHead": "b35b1875727156fe9f5b3bad55aed5ca447c8c8d"
 }