@snack-uikit/utils 3.10.0 → 3.10.2-preview-23549ae9.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## 3.10.1 (2025-07-16)
+
+
+### Bug Fixes
+
+* **PDS-2594:** close watcher ([c7678e0](https://github.com/cloud-ru-tech/snack-uikit/commit/c7678e0f4167e0d6e3a4286cca7460d0fe25dec5))
+
+
+
+
+
 # 3.10.0 (2025-07-15)
 
 

package/README.md

@@ -75,14 +75,13 @@
 ### Props
 | name | type | default value | description |
 |------|------|---------------|-------------|
-| options | `FilterStateOptions<TFilter>` | - |  |
-| parser | `(jsonFilter: string) => TFilter` | - |  |
-| serializer | `(filter: TFilter) => string` | - |  |
+| options | `DataPersistOptions<TData>` | - |  |
+| parser | `(jsonData: string) => TData` | - |  |
+| serializer | `(data: TData) => string` | - |  |
 ## useModalOpenState
+`hook` 
+
 Хук для управления состоянием модалки
-### Props
-| name | type | default value | description |
-|------|------|---------------|-------------|
 ## ThemeProvider
 Провайдер, предназначенный для работы с темами
 ### Props

package/dist/cjs/hooks/useDataPersist/useDataPersist.d.ts

@@ -1,16 +1,16 @@
 import { StateProps } from './useSource';
-export type FilterStateOptions<T> = {
-    filterQueryKey: string;
-    filterLocalStorageKey: string;
+export type DataPersistOptions<T> = {
+    queryKey: string;
+    localStorageKey: string;
     validateData(value: unknown): value is T;
 };
-type FilterStateProps<TFilter> = Omit<StateProps<TFilter>, 'source'> & {
-    options?: FilterStateOptions<TFilter>;
-    parser?(jsonFilter: string): TFilter;
-    serializer?(filter: TFilter): string;
+type DataPersistProps<TData> = Omit<StateProps<TData>, 'source'> & {
+    options?: DataPersistOptions<TData>;
+    parser?(jsonData: string): TData;
+    serializer?(data: TData): string;
 };
-export declare const useDataPersist: <TFilter>({ options, parser, serializer }: FilterStateProps<TFilter>) => {
-    getDefaultFilter: () => NonNullable<TFilter> | null | undefined;
-    setDataToStorages: (data: TFilter) => void;
+export declare const useDataPersist: <TData>({ options, parser, serializer }: DataPersistProps<TData>) => {
+    getDefaultData: () => NonNullable<TData> | null | undefined;
+    setDataToStorages: (data: TData) => void;
 };
 export {};

package/dist/cjs/hooks/useDataPersist/useDataPersist.js

@@ -13,8 +13,8 @@ const useDataPersist = _ref => {
     parser,
     serializer
   } = _ref;
-  const querySource = (0, react_1.useMemo)(() => options ? new sources_1.QueryParamSource(options.filterQueryKey, options.validateData, parser, serializer) : undefined, [options, parser, serializer]);
-  const localStorageSource = (0, react_1.useMemo)(() => options ? new sources_1.LocalStorageSource(options.filterLocalStorageKey, options.validateData) : undefined, [options]);
+  const querySource = (0, react_1.useMemo)(() => options ? new sources_1.QueryParamSource(options.queryKey, options.validateData, parser, serializer) : undefined, [options, parser, serializer]);
+  const localStorageSource = (0, react_1.useMemo)(() => options ? new sources_1.LocalStorageSource(options.localStorageKey, options.validateData) : undefined, [options]);
   const {
     getData: getLocalStorageData,
     setData: setLocalStorageData
@@ -31,12 +31,12 @@ const useDataPersist = _ref => {
     setLocalStorageData(data);
     setQueryParamsData(data);
   }, [setLocalStorageData, setQueryParamsData]);
-  const getDefaultFilter = (0, react_1.useCallback)(() => {
+  const getDefaultData = (0, react_1.useCallback)(() => {
     const queryData = getQueryParamsData();
     return queryData ? queryData : getLocalStorageData();
   }, [getLocalStorageData, getQueryParamsData]);
   return {
-    getDefaultFilter,
+    getDefaultData,
     setDataToStorages
   };
 };

package/dist/cjs/hooks/useModalOpenState.d.ts

@@ -1,17 +1,18 @@
 type UseModalOpenStateOptions = {
+    /** закрывать модалку при переходе по истории браузера (по умолчанию false) */
     closeOnPopstate?: boolean;
+    /** закрывать модалку через CloseWatcher (по умолчанию true) */
     closeByCloseWatcher?: boolean;
-    onCloseRequest?: () => boolean;
 };
 /**
  * Хук для управления состоянием модалки
- * @param open состояние модалки
- * @param onClose колбек закрытия
- * @param options.closeOnPopstate закрывать модалку при переходе по истории браузера (по умолчанию false)
- * @param options.closeByCloseWatcher закрывать модалку через CloseWatcher (по умолчанию true)
- * @param options.onCloseRequest колбек запроса закрытия модалки (если возвращает true, то модалка закроется, если false, то не закроется)
  * @returns [open, onClose]
  * @see https://developer.mozilla.org/en-US/docs/Web/API/CloseWatcher
+ * @function hook
  */
-export declare function useModalOpenState(open: boolean, onClose: () => void, { closeOnPopstate, closeByCloseWatcher, onCloseRequest, }: UseModalOpenStateOptions): void;
+export declare function useModalOpenState(
+/** состояние модалки */
+open: boolean, 
+/** колбек закрытия */
+onClose: () => void, { closeOnPopstate, closeByCloseWatcher }: UseModalOpenStateOptions): void;
 export {};

package/dist/cjs/hooks/useModalOpenState.js

@@ -7,32 +7,26 @@ exports.useModalOpenState = useModalOpenState;
 const react_1 = require("react");
 const useEventHandler_1 = require("./useEventHandler");
 const usePopstateSubscription_1 = require("./usePopstateSubscription");
-const defaultOnCloseRequest = () => true;
 /**
  * Хук для управления состоянием модалки
- * @param open состояние модалки
- * @param onClose колбек закрытия
- * @param options.closeOnPopstate закрывать модалку при переходе по истории браузера (по умолчанию false)
- * @param options.closeByCloseWatcher закрывать модалку через CloseWatcher (по умолчанию true)
- * @param options.onCloseRequest колбек запроса закрытия модалки (если возвращает true, то модалка закроется, если false, то не закроется)
  * @returns [open, onClose]
  * @see https://developer.mozilla.org/en-US/docs/Web/API/CloseWatcher
+ * @function hook
  */
-function useModalOpenState(open, onClose, _ref) {
+function useModalOpenState(/** состояние модалки */
+open, /** колбек закрытия */
+onClose, _ref) {
   let {
     closeOnPopstate = false,
-    closeByCloseWatcher = true,
-    onCloseRequest = defaultOnCloseRequest
+    closeByCloseWatcher = true
   } = _ref;
   const closeHandler = (0, useEventHandler_1.useEventHandler)(onClose);
-  const onCloseRequestHandler = (0, useEventHandler_1.useEventHandler)(onCloseRequest);
   (0, usePopstateSubscription_1.usePopstateSubscription)(() => open && closeHandler(), closeOnPopstate);
   (0, react_1.useEffect)(() => {
     if (open && 'CloseWatcher' in window && closeByCloseWatcher) {
       const watcher = new CloseWatcher();
-      watcher.oncancel = e => !onCloseRequestHandler() && e.preventDefault();
       watcher.onclose = () => closeHandler();
       return () => watcher.destroy();
     }
-  }, [open, closeHandler, closeByCloseWatcher, onCloseRequestHandler]);
+  }, [open, closeHandler, closeByCloseWatcher]);
 }

package/dist/esm/hooks/useDataPersist/useDataPersist.d.ts

@@ -1,16 +1,16 @@
 import { StateProps } from './useSource';
-export type FilterStateOptions<T> = {
-    filterQueryKey: string;
-    filterLocalStorageKey: string;
+export type DataPersistOptions<T> = {
+    queryKey: string;
+    localStorageKey: string;
     validateData(value: unknown): value is T;
 };
-type FilterStateProps<TFilter> = Omit<StateProps<TFilter>, 'source'> & {
-    options?: FilterStateOptions<TFilter>;
-    parser?(jsonFilter: string): TFilter;
-    serializer?(filter: TFilter): string;
+type DataPersistProps<TData> = Omit<StateProps<TData>, 'source'> & {
+    options?: DataPersistOptions<TData>;
+    parser?(jsonData: string): TData;
+    serializer?(data: TData): string;
 };
-export declare const useDataPersist: <TFilter>({ options, parser, serializer }: FilterStateProps<TFilter>) => {
-    getDefaultFilter: () => NonNullable<TFilter> | null | undefined;
-    setDataToStorages: (data: TFilter) => void;
+export declare const useDataPersist: <TData>({ options, parser, serializer }: DataPersistProps<TData>) => {
+    getDefaultData: () => NonNullable<TData> | null | undefined;
+    setDataToStorages: (data: TData) => void;
 };
 export {};

package/dist/esm/hooks/useDataPersist/useDataPersist.js

@@ -2,10 +2,8 @@ import { useCallback, useMemo } from 'react';
 import { LocalStorageSource, QueryParamSource } from './sources';
 import { useSource } from './useSource';
 export const useDataPersist = ({ options, parser, serializer }) => {
-    const querySource = useMemo(() => options
-        ? new QueryParamSource(options.filterQueryKey, options.validateData, parser, serializer)
-        : undefined, [options, parser, serializer]);
-    const localStorageSource = useMemo(() => (options ? new LocalStorageSource(options.filterLocalStorageKey, options.validateData) : undefined), [options]);
+    const querySource = useMemo(() => options ? new QueryParamSource(options.queryKey, options.validateData, parser, serializer) : undefined, [options, parser, serializer]);
+    const localStorageSource = useMemo(() => (options ? new LocalStorageSource(options.localStorageKey, options.validateData) : undefined), [options]);
     const { getData: getLocalStorageData, setData: setLocalStorageData } = useSource({
         source: querySource,
     });
@@ -16,9 +14,9 @@ export const useDataPersist = ({ options, parser, serializer }) => {
         setLocalStorageData(data);
         setQueryParamsData(data);
     }, [setLocalStorageData, setQueryParamsData]);
-    const getDefaultFilter = useCallback(() => {
+    const getDefaultData = useCallback(() => {
         const queryData = getQueryParamsData();
         return queryData ? queryData : getLocalStorageData();
     }, [getLocalStorageData, getQueryParamsData]);
-    return { getDefaultFilter, setDataToStorages };
+    return { getDefaultData, setDataToStorages };
 };

package/dist/esm/hooks/useModalOpenState.d.ts

@@ -1,17 +1,18 @@
 type UseModalOpenStateOptions = {
+    /** закрывать модалку при переходе по истории браузера (по умолчанию false) */
     closeOnPopstate?: boolean;
+    /** закрывать модалку через CloseWatcher (по умолчанию true) */
     closeByCloseWatcher?: boolean;
-    onCloseRequest?: () => boolean;
 };
 /**
  * Хук для управления состоянием модалки
- * @param open состояние модалки
- * @param onClose колбек закрытия
- * @param options.closeOnPopstate закрывать модалку при переходе по истории браузера (по умолчанию false)
- * @param options.closeByCloseWatcher закрывать модалку через CloseWatcher (по умолчанию true)
- * @param options.onCloseRequest колбек запроса закрытия модалки (если возвращает true, то модалка закроется, если false, то не закроется)
  * @returns [open, onClose]
  * @see https://developer.mozilla.org/en-US/docs/Web/API/CloseWatcher
+ * @function hook
  */
-export declare function useModalOpenState(open: boolean, onClose: () => void, { closeOnPopstate, closeByCloseWatcher, onCloseRequest, }: UseModalOpenStateOptions): void;
+export declare function useModalOpenState(
+/** состояние модалки */
+open: boolean, 
+/** колбек закрытия */
+onClose: () => void, { closeOnPopstate, closeByCloseWatcher }: UseModalOpenStateOptions): void;
 export {};

package/dist/esm/hooks/useModalOpenState.js

@@ -1,27 +1,24 @@
 import { useEffect } from 'react';
 import { useEventHandler } from './useEventHandler';
 import { usePopstateSubscription } from './usePopstateSubscription';
-const defaultOnCloseRequest = () => true;
 /**
  * Хук для управления состоянием модалки
- * @param open состояние модалки
- * @param onClose колбек закрытия
- * @param options.closeOnPopstate закрывать модалку при переходе по истории браузера (по умолчанию false)
- * @param options.closeByCloseWatcher закрывать модалку через CloseWatcher (по умолчанию true)
- * @param options.onCloseRequest колбек запроса закрытия модалки (если возвращает true, то модалка закроется, если false, то не закроется)
  * @returns [open, onClose]
  * @see https://developer.mozilla.org/en-US/docs/Web/API/CloseWatcher
+ * @function hook
  */
-export function useModalOpenState(open, onClose, { closeOnPopstate = false, closeByCloseWatcher = true, onCloseRequest = defaultOnCloseRequest, }) {
+export function useModalOpenState(
+/** состояние модалки */
+open, 
+/** колбек закрытия */
+onClose, { closeOnPopstate = false, closeByCloseWatcher = true }) {
     const closeHandler = useEventHandler(onClose);
-    const onCloseRequestHandler = useEventHandler(onCloseRequest);
     usePopstateSubscription(() => open && closeHandler(), closeOnPopstate);
     useEffect(() => {
         if (open && 'CloseWatcher' in window && closeByCloseWatcher) {
             const watcher = new CloseWatcher();
-            watcher.oncancel = e => !onCloseRequestHandler() && e.preventDefault();
             watcher.onclose = () => closeHandler();
             return () => watcher.destroy();
         }
-    }, [open, closeHandler, closeByCloseWatcher, onCloseRequestHandler]);
+    }, [open, closeHandler, closeByCloseWatcher]);
 }

package/package.json

@@ -4,7 +4,7 @@
     "access": "public"
   },
   "title": "Utils",
-  "version": "3.10.0",
+  "version": "3.10.2-preview-23549ae9.0",
   "sideEffects": [
     "*.css",
     "*.woff",
@@ -39,5 +39,5 @@
     "react-swipeable": "7.0.2",
     "uncontrollable": "8.0.4"
   },
-  "gitHead": "60a306ca6f30a3dc7363ecc71b1584acc98dea58"
+  "gitHead": "e42f92b88079738efc564d7fa74f5fbd18e2fd6d"
 }

package/src/hooks/useDataPersist/useDataPersist.ts

@@ -3,50 +3,49 @@ import { useCallback, useMemo } from 'react';
 import { LocalStorageSource, QueryParamSource } from './sources';
 import { StateProps, useSource } from './useSource';
 
-export type FilterStateOptions<T> = {
-  filterQueryKey: string;
-  filterLocalStorageKey: string;
+export type DataPersistOptions<T> = {
+  queryKey: string;
+  localStorageKey: string;
   validateData(value: unknown): value is T;
 };
 
-type FilterStateProps<TFilter> = Omit<StateProps<TFilter>, 'source'> & {
-  options?: FilterStateOptions<TFilter>;
-  parser?(jsonFilter: string): TFilter;
-  serializer?(filter: TFilter): string;
+type DataPersistProps<TData> = Omit<StateProps<TData>, 'source'> & {
+  options?: DataPersistOptions<TData>;
+  parser?(jsonData: string): TData;
+  serializer?(data: TData): string;
 };
 
-export const useDataPersist = <TFilter>({ options, parser, serializer }: FilterStateProps<TFilter>) => {
+export const useDataPersist = <TData>({ options, parser, serializer }: DataPersistProps<TData>) => {
   const querySource = useMemo(
     () =>
-      options
-        ? new QueryParamSource<TFilter>(options.filterQueryKey, options.validateData, parser, serializer)
-        : undefined,
+      options ? new QueryParamSource<TData>(options.queryKey, options.validateData, parser, serializer) : undefined,
     [options, parser, serializer],
   );
   const localStorageSource = useMemo(
-    () => (options ? new LocalStorageSource<TFilter>(options.filterLocalStorageKey, options.validateData) : undefined),
+    () => (options ? new LocalStorageSource<TData>(options.localStorageKey, options.validateData) : undefined),
     [options],
   );
 
-  const { getData: getLocalStorageData, setData: setLocalStorageData } = useSource<TFilter>({
+  const { getData: getLocalStorageData, setData: setLocalStorageData } = useSource<TData>({
     source: querySource,
   });
-  const { getData: getQueryParamsData, setData: setQueryParamsData } = useSource<TFilter>({
+
+  const { getData: getQueryParamsData, setData: setQueryParamsData } = useSource<TData>({
     source: localStorageSource,
   });
 
   const setDataToStorages = useCallback(
-    (data: TFilter) => {
+    (data: TData) => {
       setLocalStorageData(data);
       setQueryParamsData(data);
     },
     [setLocalStorageData, setQueryParamsData],
   );
 
-  const getDefaultFilter = useCallback(() => {
+  const getDefaultData = useCallback(() => {
     const queryData = getQueryParamsData();
     return queryData ? queryData : getLocalStorageData();
   }, [getLocalStorageData, getQueryParamsData]);
 
-  return { getDefaultFilter, setDataToStorages };
+  return { getDefaultData, setDataToStorages };
 };

package/src/hooks/useModalOpenState.ts

@@ -4,44 +4,34 @@ import { useEventHandler } from './useEventHandler';
 import { usePopstateSubscription } from './usePopstateSubscription';
 
 type UseModalOpenStateOptions = {
+  /** закрывать модалку при переходе по истории браузера (по умолчанию false) */
   closeOnPopstate?: boolean;
+  /** закрывать модалку через CloseWatcher (по умолчанию true) */
   closeByCloseWatcher?: boolean;
-  onCloseRequest?: () => boolean;
 };
 
-const defaultOnCloseRequest = () => true;
-
 /**
  * Хук для управления состоянием модалки
- * @param open состояние модалки
- * @param onClose колбек закрытия
- * @param options.closeOnPopstate закрывать модалку при переходе по истории браузера (по умолчанию false)
- * @param options.closeByCloseWatcher закрывать модалку через CloseWatcher (по умолчанию true)
- * @param options.onCloseRequest колбек запроса закрытия модалки (если возвращает true, то модалка закроется, если false, то не закроется)
  * @returns [open, onClose]
  * @see https://developer.mozilla.org/en-US/docs/Web/API/CloseWatcher
+ * @function hook
  */
 export function useModalOpenState(
+  /** состояние модалки */
   open: boolean,
+  /** колбек закрытия */
   onClose: () => void,
-  {
-    closeOnPopstate = false,
-    closeByCloseWatcher = true,
-    onCloseRequest = defaultOnCloseRequest,
-  }: UseModalOpenStateOptions,
+  { closeOnPopstate = false, closeByCloseWatcher = true }: UseModalOpenStateOptions,
 ) {
   const closeHandler = useEventHandler(onClose);
-  const onCloseRequestHandler = useEventHandler(onCloseRequest);
 
   usePopstateSubscription(() => open && closeHandler(), closeOnPopstate);
 
   useEffect(() => {
     if (open && 'CloseWatcher' in window && closeByCloseWatcher) {
       const watcher = new CloseWatcher();
-      watcher.oncancel = e => !onCloseRequestHandler() && e.preventDefault();
       watcher.onclose = () => closeHandler();
-
       return () => watcher.destroy();
     }
-  }, [open, closeHandler, closeByCloseWatcher, onCloseRequestHandler]);
+  }, [open, closeHandler, closeByCloseWatcher]);
 }