@websolutespa/bom-mixer-hooks 1.8.1 → 1.8.3

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @websolutespa/bom-mixer-hooks
 
+## 1.8.3
+
+### Patch Changes
+
+- Added: usePageLoading
+- Modified: useSearchParams, useSearchParamsEncoded, useSearchParamsQs
+
+## 1.8.2
+
+### Patch Changes
+
+- Modified: useSearchParams, useSearchParamsEncoded, useSearchParamsQs added pushParams
+
 ## 1.8.1
 
 ### Patch Changes

package/dist/index.d.ts

@@ -396,6 +396,20 @@ declare function PageProvider({ children, page }: {
     page: IPage;
 }): react_jsx_runtime.JSX.Element;
 
+type IPageRoute = {
+    pathname: string;
+    query: Record<string, string>;
+    asPath: string;
+};
+declare function usePageLoading(options?: {
+    loading: boolean;
+}): {
+    loading: boolean;
+    error: void | Error | undefined;
+    pageRoute: IPageRoute | undefined;
+    previousPageRoute: IPageRoute | undefined;
+};
+
 type IPaginationInfo<T = any> = {
     items: T[];
     page: number;
@@ -434,26 +448,19 @@ declare function getRealSize(element: HTMLElement | null): SizeType;
 
 declare function useResize(callback: () => unknown, immediate?: boolean): void;
 
-type SSRState = {
-    isBrowser: boolean;
-    isServer: boolean;
-};
-declare const detectIsBrowser: () => boolean;
-declare function useSSR(): SSRState;
-
 type Scroll = {
     left: number;
     top: number;
 };
 declare function useScroll(): Scroll;
 
+declare function useScrolled(callback?: (top: number, left: number) => boolean): boolean;
+
 declare function useScrollTo(offset?: number): (event: React.MouseEvent<HTMLElement>) => void;
 declare function scrollToSelector(selector?: string, offset?: number): void;
 declare function scrollToRelativeY(y?: number, offset?: number): void;
 declare function scrollToY(y?: number): void;
 
-declare function useScrolled(callback?: (top: number, left: number) => boolean): boolean;
-
 declare function getSearchParams(url: string, key?: string): IParams | string | null;
 declare function updateSearchParams(currentPath: string, params: IParams): {
     pathname: string;
@@ -461,21 +468,23 @@ declare function updateSearchParams(currentPath: string, params: IParams): {
         [key: string]: string;
     };
 };
-declare function replaceSearchParams(router: NextRouter, params: IParams): void;
 declare function pushSearchParams(router: NextRouter, params: IParams): void;
-declare function replaceSearchParamsSilently(params: IParams): void;
-declare function useSearchParams(): IUseSearchParamsResult;
+declare function pushSearchParamsSilently(router: NextRouter, params: IParams): void;
+declare function replaceSearchParams(router: NextRouter, params: IParams): void;
+declare function replaceSearchParamsSilently(router: NextRouter, params: IParams): void;
 type IParams = {
     [key: string]: string;
 };
-type IUseSearchParamsValueResult = {
-    params: string | null;
-    replaceParamsSilently: (params: IParams) => void;
-};
 type IUseSearchParamsResult = {
     params: IParams;
-    replaceParamsSilently: (params: IParams) => void;
+    pushParams: (params: IParams) => void;
+    pushParamsSilently: (params: IParams) => void;
     replaceParams: (params: IParams) => void;
+    replaceParamsSilently: (params: IParams) => void;
+};
+declare function useSearchParams(): IUseSearchParamsResult;
+type IUseSearchParamsValueResult = Omit<IUseSearchParamsResult, 'params'> & {
+    params: string | null;
 };
 declare function useSearchParamsValue(key: string): IUseSearchParamsValueResult;
 
@@ -486,33 +495,39 @@ declare function updateSearchParamsEncoded(currentPath: string, value: IParamsEn
         [key: string]: string;
     };
 };
-declare function replaceSearchParamsEncoded(router: NextRouter, value: IParamsEncoded, key?: string): void;
 declare function pushSearchParamsEncoded(router: NextRouter, value: IParamsEncoded, key?: string): void;
-declare function replaceSearchParamsEncodedSilently(value: IParamsEncoded, key?: string): void;
+declare function pushSearchParamsEncodedSilently(router: NextRouter, value: IParamsEncoded, key?: string): void;
+declare function replaceSearchParamsEncoded(router: NextRouter, value: IParamsEncoded, key?: string): void;
+declare function replaceSearchParamsEncodedSilently(router: NextRouter, value: IParamsEncoded, key?: string): void;
 type IParamsEncoded = {
     [key: string]: any;
 } | null;
 type IUseSearchParamsEncodedResult = {
     params: IParamsEncoded;
-    replaceParamsSilently: (params: IParamsEncoded) => void;
+    pushParams: (params: IParamsEncoded) => void;
+    pushParamsSilently: (params: IParamsEncoded) => void;
     replaceParams: (params: IParamsEncoded) => void;
+    replaceParamsSilently: (params: IParamsEncoded) => void;
 };
 declare function useSearchParamsEncoded(key?: string): IUseSearchParamsEncodedResult;
 
 type IParamsQs = Record<string, any>;
 type IUseSearchParamsQsResult = {
     params: IParamsQs;
-    replaceParamsSilently: (params: IParamsQs) => void;
+    pushParams: (params: IParamsQs) => void;
+    pushParamsSilently: (params: IParamsQs) => void;
     replaceParams: (params: IParamsQs) => void;
+    replaceParamsSilently: (params: IParamsQs) => void;
 };
 declare function getSearchParamsQs(url: string, key?: string): IParamsQs;
 declare function updateSearchParamsQs(url: string, value: IParamsQs, key?: string): {
     pathname: string;
     query: string;
 };
-declare function replaceSearchParamsQs(router: NextRouter, value: IParamsQs, key?: string): void;
 declare function pushSearchParamsQs(router: NextRouter, value: IParamsQs, key?: string): void;
-declare function replaceSearchParamsQsSilently(value: IParamsQs, key?: string): void;
+declare function pushSearchParamsQsSilently(router: NextRouter, value: IParamsQs, key?: string): void;
+declare function replaceSearchParamsQs(router: NextRouter, value: IParamsQs, key?: string): void;
+declare function replaceSearchParamsQsSilently(router: NextRouter, value: IParamsQs, key?: string): void;
 declare function useSearchParamsQs(key?: string): IUseSearchParamsQsResult;
 
 type Sorting<T> = {
@@ -525,6 +540,13 @@ declare function useSorting<T>(items_: T[], callback_: (items: T[], sort?: IEqua
     setSort: (sort?: IEquatable) => void;
 };
 
+type SSRState = {
+    isBrowser: boolean;
+    isServer: boolean;
+};
+declare const detectIsBrowser: () => boolean;
+declare function useSSR(): SSRState;
+
 /**
  * Like `useRef`, but it returns immutable ref that contains actual value.
  *
@@ -549,4 +571,4 @@ type WindowSize = {
 };
 declare function useWindowSize(): WindowSize;
 
-export { BodyScrollOptions, ClickOutGetContainer, CurrentStateType, ElementStackItem, ExtraProvider, Filter, FilterMode, FilterParams, FilterValues, GeoLocationSensorState, IExtra, IFilter, IFilterOption, IGeolocationPositionError, ILabelContext, ILayoutContext, ILazyModulesContext, IPageContext, IPaginationInfo, IParams, IParamsEncoded, IParamsQs, IUseSearchParamsEncodedResult, IUseSearchParamsQsResult, IUseSearchParamsResult, IUseSearchParamsValueResult, KeyCode, KeyMod, KeyboardOptions, KeyboardResult, LabelProvider, LabelService, LayoutProvider, LazyModulesProvider, PageProvider, SSRState, SizeResult, SizeType, Sorting, UIReducer, UIValue, UseFiltersResultType, UseKeyboard, UseKeyboardHandler, createElementWithId, createGenericContext, detectIsBrowser, filtersToParams, getCurrentPosition, getFilteredItems, getFilters, getOwnerPaddingRight, getOwnerScrollbarWidth, getPagedItems, getPaginationInfo, getRealSize, getSearchParams, getSearchParamsEncoded, getSearchParamsQs, getUID, hasGeolocation, isElement, isPaginationInfo, localCollectionDelete, localCollectionFetch, localCollectionGet, localCollectionPatch, localCollectionPost, localCollectionPut, parseLabel, parseParams, pushSearchParams, pushSearchParamsEncoded, pushSearchParamsQs, replaceSearchParams, replaceSearchParamsEncoded, replaceSearchParamsEncodedSilently, replaceSearchParamsQs, replaceSearchParamsQsSilently, replaceSearchParamsSilently, scrollToRelativeY, scrollToSelector, scrollToY, setFilters, updateSearchParams, updateSearchParamsEncoded, updateSearchParamsQs, useApi, useApiDelete, useApiFetch, useApiGet, useApiPatch, useApiPost, useApiPut, useBodyScroll, useBreakpoint, useClickAnyWhere, useClickOut, useCollectionApi, useCollectionApiDelete, useCollectionApiGet, useCollectionApiPatch, useCollectionApiPost, useCollectionApiPut, useCurrency, useCurrentState, useDateTimeFormat, useDebounce, useDebounceCallback, useDebugChangedProps, useDomObserver, useDrawer, useElementSize, useEventListener, useExtra, useFilters, useGeolocation, useIdle, useInfiniteLoader, useIntersectionObserver, useIsomorphicLayoutEffect, useKeyboard, useLabel, useLayout, useLazyModules, useModal, useMounted, useNumber, usePage, usePagination, usePortal, usePrevious, useRealSize, useResize, useSSR, useScroll, useScrollTo, useScrolled, useSearchParams, useSearchParamsEncoded, useSearchParamsQs, useSearchParamsValue, useSorting, useSyncedRef, useUI, useUnit, useUnmountEffect, useWindowSize };
+export { BodyScrollOptions, ClickOutGetContainer, CurrentStateType, ElementStackItem, ExtraProvider, Filter, FilterMode, FilterParams, FilterValues, GeoLocationSensorState, IExtra, IFilter, IFilterOption, IGeolocationPositionError, ILabelContext, ILayoutContext, ILazyModulesContext, IPageContext, IPageRoute, IPaginationInfo, IParams, IParamsEncoded, IParamsQs, IUseSearchParamsEncodedResult, IUseSearchParamsQsResult, IUseSearchParamsResult, IUseSearchParamsValueResult, KeyCode, KeyMod, KeyboardOptions, KeyboardResult, LabelProvider, LabelService, LayoutProvider, LazyModulesProvider, PageProvider, SSRState, SizeResult, SizeType, Sorting, UIReducer, UIValue, UseFiltersResultType, UseKeyboard, UseKeyboardHandler, createElementWithId, createGenericContext, detectIsBrowser, filtersToParams, getCurrentPosition, getFilteredItems, getFilters, getOwnerPaddingRight, getOwnerScrollbarWidth, getPagedItems, getPaginationInfo, getRealSize, getSearchParams, getSearchParamsEncoded, getSearchParamsQs, getUID, hasGeolocation, isElement, isPaginationInfo, localCollectionDelete, localCollectionFetch, localCollectionGet, localCollectionPatch, localCollectionPost, localCollectionPut, parseLabel, parseParams, pushSearchParams, pushSearchParamsEncoded, pushSearchParamsEncodedSilently, pushSearchParamsQs, pushSearchParamsQsSilently, pushSearchParamsSilently, replaceSearchParams, replaceSearchParamsEncoded, replaceSearchParamsEncodedSilently, replaceSearchParamsQs, replaceSearchParamsQsSilently, replaceSearchParamsSilently, scrollToRelativeY, scrollToSelector, scrollToY, setFilters, updateSearchParams, updateSearchParamsEncoded, updateSearchParamsQs, useApi, useApiDelete, useApiFetch, useApiGet, useApiPatch, useApiPost, useApiPut, useBodyScroll, useBreakpoint, useClickAnyWhere, useClickOut, useCollectionApi, useCollectionApiDelete, useCollectionApiGet, useCollectionApiPatch, useCollectionApiPost, useCollectionApiPut, useCurrency, useCurrentState, useDateTimeFormat, useDebounce, useDebounceCallback, useDebugChangedProps, useDomObserver, useDrawer, useElementSize, useEventListener, useExtra, useFilters, useGeolocation, useIdle, useInfiniteLoader, useIntersectionObserver, useIsomorphicLayoutEffect, useKeyboard, useLabel, useLayout, useLazyModules, useModal, useMounted, useNumber, usePage, usePageLoading, usePagination, usePortal, usePrevious, useRealSize, useResize, useSSR, useScroll, useScrollTo, useScrolled, useSearchParams, useSearchParamsEncoded, useSearchParamsQs, useSearchParamsValue, useSorting, useSyncedRef, useUI, useUnit, useUnmountEffect, useWindowSize };