@snack-uikit/utils 3.10.1 → 3.10.2-preview-05f26bf6.0

package/README.md

@@ -75,9 +75,9 @@
 ### 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` 
 

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

@@ -1,11 +1,11 @@
-export declare abstract class BaseSource<TFilter> {
+export declare abstract class BaseSource<TData> {
     filterKey: string;
     private validate;
-    protected parser: (value: string) => TFilter;
-    protected serializer: (value: TFilter) => string;
+    protected parser: (value: string) => TData;
+    protected serializer: (value: TData) => string;
     protected abstract getFromSource(): string;
     protected abstract setToSource(value: string): void;
-    constructor(filterKey: string, validate: (value: unknown) => value is TFilter, parser?: (value: string) => TFilter, serializer?: (value: TFilter) => string);
-    getFilter: () => NonNullable<TFilter> | null;
-    setFilter: (filter: TFilter) => void;
+    constructor(filterKey: string, validate: (value: unknown) => value is TData, parser?: (value: string) => TData, serializer?: (value: TData) => string);
+    getData: () => NonNullable<TData> | null;
+    setData: (filter: TData) => void;
 }

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

@@ -10,7 +10,7 @@ class BaseSource {
     this.validate = validate;
     this.parser = JSON.parse;
     this.serializer = JSON.stringify;
-    this.getFilter = () => {
+    this.getData = () => {
       try {
         const filterFromQueryParams = this.getFromSource();
         const parsedValue = filterFromQueryParams ? this.parser(filterFromQueryParams) : null;
@@ -20,7 +20,7 @@ class BaseSource {
         return null;
       }
     };
-    this.setFilter = filter => {
+    this.setData = filter => {
       const encodedValue = this.serializer(filter);
       this.setToSource(encodedValue);
     };

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

@@ -1,5 +1,5 @@
 import { BaseSource } from './baseSource';
-export declare class LocalStorageSource<TFilter> extends BaseSource<TFilter> {
+export declare class LocalStorageSource<TData> extends BaseSource<TData> {
     getFromSource(): string;
     setToSource(value: string): void;
 }

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

@@ -1,5 +1,5 @@
 import { BaseSource } from './baseSource';
-export declare class QueryParamSource<TFilter> extends BaseSource<TFilter> {
+export declare class QueryParamSource<TData> extends BaseSource<TData> {
     getFromSource(): string;
     setToSource(value: string): void;
 }

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/useDataPersist/useSource.d.ts

@@ -1,8 +1,8 @@
-import { BaseSource } from './sources/baseSource';
+import { BaseSource } from './sources';
 export type StateProps<T> = {
     source?: BaseSource<T>;
 };
 export declare const useSource: <T>({ source }: StateProps<T>) => {
     getData: () => NonNullable<T> | null | undefined;
-    setData: (filter: T) => void;
+    setData: (data: T) => void;
 };

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

@@ -9,13 +9,13 @@ const useSource = _ref => {
   let {
     source
   } = _ref;
-  const setData = (0, react_1.useCallback)(filter => {
+  const setData = (0, react_1.useCallback)(data => {
     if (!source) {
       return;
     }
-    source.setFilter(filter);
+    source.setData(data);
   }, [source]);
-  const getData = (0, react_1.useCallback)(() => source === null || source === void 0 ? void 0 : source.getFilter(), [source]);
+  const getData = (0, react_1.useCallback)(() => source === null || source === void 0 ? void 0 : source.getData(), [source]);
   return {
     getData,
     setData

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

@@ -1,11 +1,11 @@
-export declare abstract class BaseSource<TFilter> {
+export declare abstract class BaseSource<TData> {
     filterKey: string;
     private validate;
-    protected parser: (value: string) => TFilter;
-    protected serializer: (value: TFilter) => string;
+    protected parser: (value: string) => TData;
+    protected serializer: (value: TData) => string;
     protected abstract getFromSource(): string;
     protected abstract setToSource(value: string): void;
-    constructor(filterKey: string, validate: (value: unknown) => value is TFilter, parser?: (value: string) => TFilter, serializer?: (value: TFilter) => string);
-    getFilter: () => NonNullable<TFilter> | null;
-    setFilter: (filter: TFilter) => void;
+    constructor(filterKey: string, validate: (value: unknown) => value is TData, parser?: (value: string) => TData, serializer?: (value: TData) => string);
+    getData: () => NonNullable<TData> | null;
+    setData: (filter: TData) => void;
 }

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

@@ -4,7 +4,7 @@ export class BaseSource {
         this.validate = validate;
         this.parser = JSON.parse;
         this.serializer = JSON.stringify;
-        this.getFilter = () => {
+        this.getData = () => {
             try {
                 const filterFromQueryParams = this.getFromSource();
                 const parsedValue = filterFromQueryParams ? this.parser(filterFromQueryParams) : null;
@@ -15,7 +15,7 @@ export class BaseSource {
                 return null;
             }
         };
-        this.setFilter = (filter) => {
+        this.setData = (filter) => {
             const encodedValue = this.serializer(filter);
             this.setToSource(encodedValue);
         };

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

@@ -1,5 +1,5 @@
 import { BaseSource } from './baseSource';
-export declare class LocalStorageSource<TFilter> extends BaseSource<TFilter> {
+export declare class LocalStorageSource<TData> extends BaseSource<TData> {
     getFromSource(): string;
     setToSource(value: string): void;
 }

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

@@ -1,5 +1,5 @@
 import { BaseSource } from './baseSource';
-export declare class QueryParamSource<TFilter> extends BaseSource<TFilter> {
+export declare class QueryParamSource<TData> extends BaseSource<TData> {
     getFromSource(): string;
     setToSource(value: string): void;
 }

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/useDataPersist/useSource.d.ts

@@ -1,8 +1,8 @@
-import { BaseSource } from './sources/baseSource';
+import { BaseSource } from './sources';
 export type StateProps<T> = {
     source?: BaseSource<T>;
 };
 export declare const useSource: <T>({ source }: StateProps<T>) => {
     getData: () => NonNullable<T> | null | undefined;
-    setData: (filter: T) => void;
+    setData: (data: T) => void;
 };

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

@@ -1,11 +1,11 @@
 import { useCallback } from 'react';
 export const useSource = ({ source }) => {
-    const setData = useCallback((filter) => {
+    const setData = useCallback((data) => {
         if (!source) {
             return;
         }
-        source.setFilter(filter);
+        source.setData(data);
     }, [source]);
-    const getData = useCallback(() => source === null || source === void 0 ? void 0 : source.getFilter(), [source]);
+    const getData = useCallback(() => source === null || source === void 0 ? void 0 : source.getData(), [source]);
     return { getData, setData };
 };

package/package.json

@@ -4,7 +4,7 @@
     "access": "public"
   },
   "title": "Utils",
-  "version": "3.10.1",
+  "version": "3.10.2-preview-05f26bf6.0",
   "sideEffects": [
     "*.css",
     "*.woff",
@@ -39,5 +39,5 @@
     "react-swipeable": "7.0.2",
     "uncontrollable": "8.0.4"
   },
-  "gitHead": "2871794a46212ecbb3bc0002d7d8912310643332"
+  "gitHead": "6fee645f4608f0384f0e44df312a82b4120739ac"
 }

package/src/hooks/useDataPersist/sources/baseSource.ts

@@ -1,14 +1,14 @@
-export abstract class BaseSource<TFilter> {
-  protected parser: (value: string) => TFilter = JSON.parse;
-  protected serializer: (value: TFilter) => string = JSON.stringify;
+export abstract class BaseSource<TData> {
+  protected parser: (value: string) => TData = JSON.parse;
+  protected serializer: (value: TData) => string = JSON.stringify;
   protected abstract getFromSource(): string;
   protected abstract setToSource(value: string): void;
 
   constructor(
     public filterKey: string,
-    private validate: (value: unknown) => value is TFilter,
-    parser?: (value: string) => TFilter,
-    serializer?: (value: TFilter) => string,
+    private validate: (value: unknown) => value is TData,
+    parser?: (value: string) => TData,
+    serializer?: (value: TData) => string,
   ) {
     if (parser) {
       this.parser = parser;
@@ -18,10 +18,10 @@ export abstract class BaseSource<TFilter> {
     }
   }
 
-  getFilter = () => {
+  getData = () => {
     try {
       const filterFromQueryParams = this.getFromSource();
-      const parsedValue = filterFromQueryParams ? (this.parser(filterFromQueryParams) as TFilter) : null;
+      const parsedValue = filterFromQueryParams ? (this.parser(filterFromQueryParams) as TData) : null;
       const isValid = parsedValue && this.validate(parsedValue);
       return isValid ? parsedValue : null;
     } catch {
@@ -29,7 +29,7 @@ export abstract class BaseSource<TFilter> {
     }
   };
 
-  setFilter = (filter: TFilter) => {
+  setData = (filter: TData) => {
     const encodedValue = this.serializer(filter);
     this.setToSource(encodedValue);
   };

package/src/hooks/useDataPersist/sources/localStorageSource.ts

@@ -1,7 +1,7 @@
 import { isBrowser } from '../../../utils';
 import { BaseSource } from './baseSource';
 
-export class LocalStorageSource<TFilter> extends BaseSource<TFilter> {
+export class LocalStorageSource<TData> extends BaseSource<TData> {
   getFromSource(): string {
     if (isBrowser()) {
       return localStorage.getItem(this.filterKey) || '';

package/src/hooks/useDataPersist/sources/queryParamSource.ts

@@ -1,7 +1,7 @@
 import { isBrowser } from '../../../utils';
 import { BaseSource } from './baseSource';
 
-export class QueryParamSource<TFilter> extends BaseSource<TFilter> {
+export class QueryParamSource<TData> extends BaseSource<TData> {
   getFromSource(): string {
     if (isBrowser()) {
       return new URL(window.location.href).searchParams.get(this.filterKey) || '';

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/useDataPersist/useSource.ts

@@ -1,6 +1,6 @@
 import { useCallback } from 'react';
 
-import { BaseSource } from './sources/baseSource';
+import { BaseSource } from './sources';
 
 export type StateProps<T> = {
   source?: BaseSource<T>;
@@ -8,16 +8,16 @@ export type StateProps<T> = {
 
 export const useSource = <T>({ source }: StateProps<T>) => {
   const setData = useCallback(
-    (filter: T) => {
+    (data: T) => {
       if (!source) {
         return;
       }
-      source.setFilter(filter);
+      source.setData(data);
     },
     [source],
   );
 
-  const getData = useCallback(() => source?.getFilter(), [source]);
+  const getData = useCallback(() => source?.getData(), [source]);
 
   return { getData, setData };
 };