@websolutespa/bom-mixer-hooks 1.4.0 → 1.4.1

package/CHANGELOG.md

@@ -1,69 +1,79 @@
-# @websolutespa/bom-mixer-hooks
-
-## 1.4.0
-
-### Minor Changes
-
-- Added useLazyModules.
-
-## 1.3.0
-
-### Minor Changes
-
-- Added: useSearchParamsQs.
-- Modified: useSearchParamsEncoded, useSearchParams, useScrollTo.
-
-## 1.2.1
-
-### Patch Changes
-
-- Added: LabelService.
-- Modified: useLabels, useScrollTo.
-
-## 1.2.0
-
-### Minor Changes
-
-- Updating: next 13.
-
-## 1.1.0
-
-### Minor Changes
-
-- Modified: useHttp, useApi.
-
-## 1.0.0
-
-### Minor Changes
-
-- Added: useScrolled.
-
-## 0.2.2
-
-### Patch Changes
-
-- Modified: useBreakpoint theme mediaQuery.
-
-## 0.2.1
-
-### Patch Changes
-
-- Added: source files.
-
-## 0.2.0
-
-### Minor Changes
-
-- Added: splat routes.
-
-## 0.1.0
-
-### Minor Changes
-
-- Added: @websolutespa/bom-core.
-
-## 0.0.2
-
-### Patch Changes
-
-- Added: first release.
+# @websolutespa/bom-mixer-hooks
+
+## 1.4.1
+
+### Patch Changes
+
+- Added: useCollectionApi, useExtra.
+- Modified: usePagination, useSearchParamsQs.
+- Updated dependencies
+  - @websolutespa/bom-mixer-models@1.5.2
+  - @websolutespa/bom-core@0.6.2
+
+## 1.4.0
+
+### Minor Changes
+
+- Added useLazyModules.
+
+## 1.3.0
+
+### Minor Changes
+
+- Added: useSearchParamsQs.
+- Modified: useSearchParamsEncoded, useSearchParams, useScrollTo.
+
+## 1.2.1
+
+### Patch Changes
+
+- Added: LabelService.
+- Modified: useLabels, useScrollTo.
+
+## 1.2.0
+
+### Minor Changes
+
+- Updating: next 13.
+
+## 1.1.0
+
+### Minor Changes
+
+- Modified: useHttp, useApi.
+
+## 1.0.0
+
+### Minor Changes
+
+- Added: useScrolled.
+
+## 0.2.2
+
+### Patch Changes
+
+- Modified: useBreakpoint theme mediaQuery.
+
+## 0.2.1
+
+### Patch Changes
+
+- Added: source files.
+
+## 0.2.0
+
+### Minor Changes
+
+- Added: splat routes.
+
+## 0.1.0
+
+### Minor Changes
+
+- Added: @websolutespa/bom-core.
+
+## 0.0.2
+
+### Patch Changes
+
+- Added: first release.

package/dist/index.d.ts

@@ -1,20 +1,20 @@
-import * as React$1 from 'react';
-import React__default, { RefObject, Dispatch, SetStateAction, MutableRefObject, ComponentProps, useEffect } from 'react';
+import * as react from 'react';
+import react__default, { RefObject, Dispatch, SetStateAction, MutableRefObject, ComponentProps, useEffect } from 'react';
 import { ApiRequestOptions } from '@websolutespa/bom-mixer-store';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as zustand_middleware from 'zustand/middleware';
 import { StateStorage } from 'zustand/middleware';
 import * as zustand from 'zustand';
-import { ISchema, IEquatable, ILabel, ILocalizable, ILayout, IPage } from '@websolutespa/bom-core';
+import { ISchema, QueryParams, IEquatable, ILabel, ILocalizable, ILayout, IPage } from '@websolutespa/bom-core';
 import { ICartItem, ICartAddItem, IAddressOptions, ICheckoutPartial, IFeatureType, ILazyModules, IUser } from '@websolutespa/bom-mixer-models';
 import { NextRouter } from 'next/router';
 
-declare function useApiFetch<T = unknown>(pathname: string, options?: ApiRequestOptions): [T | undefined, boolean, any, React$1.Dispatch<any>];
-declare function useApiGet<T = unknown>(pathname: string, options?: ApiRequestOptions): [T | undefined, boolean, any, React$1.Dispatch<any>];
-declare function useApiPost<T = unknown>(pathname: string, payload: unknown, options?: ApiRequestOptions): [T | undefined, boolean, any, React$1.Dispatch<any>];
-declare function useApiPut<T = unknown>(pathname: string, payload: unknown, options?: ApiRequestOptions): [T | undefined, boolean, any, React$1.Dispatch<any>];
-declare function useApiPatch<T = unknown>(pathname: string, payload: unknown, options?: ApiRequestOptions): [T | undefined, boolean, any, React$1.Dispatch<any>];
-declare function useApiDelete<T = unknown>(pathname: string, options?: ApiRequestOptions): [T | undefined, boolean, any, React$1.Dispatch<any>];
+declare function useApiFetch<T = unknown>(pathname: string, options?: ApiRequestOptions): [T | undefined, boolean, any, react.Dispatch<any>];
+declare function useApiGet<T = unknown>(pathname: string, options?: ApiRequestOptions): [T | undefined, boolean, any, react.Dispatch<any>];
+declare function useApiPost<T = unknown>(pathname: string, payload: unknown, options?: ApiRequestOptions): [T | undefined, boolean, any, react.Dispatch<any>];
+declare function useApiPut<T = unknown>(pathname: string, payload: unknown, options?: ApiRequestOptions): [T | undefined, boolean, any, react.Dispatch<any>];
+declare function useApiPatch<T = unknown>(pathname: string, payload: unknown, options?: ApiRequestOptions): [T | undefined, boolean, any, react.Dispatch<any>];
+declare function useApiDelete<T = unknown>(pathname: string, options?: ApiRequestOptions): [T | undefined, boolean, any, react.Dispatch<any>];
 type Api = {
     get: <T = unknown>(pathname: string, options?: ApiRequestOptions) => Promise<T>;
     post: <T = unknown>(pathname: string, payload?: unknown, options?: ApiRequestOptions) => Promise<T>;
@@ -60,7 +60,7 @@ type CartActions = {
 type CartState = CartProps & {
     actions: CartActions;
 };
-declare const CartContext: React$1.Context<(Omit<zustand.StoreApi<CartState>, "persist"> & {
+declare const CartContext: react.Context<(Omit<zustand.StoreApi<CartState>, "persist"> & {
     persist: {
         setOptions: (options: Partial<zustand_middleware.PersistOptions<CartState, unknown>>) => void;
         clearStorage: () => void;
@@ -89,7 +89,7 @@ type CheckoutActions = {
 type CheckoutState = CheckoutProps & {
     actions: CheckoutActions;
 };
-declare const CheckoutContext: React$1.Context<(Omit<zustand.StoreApi<CheckoutState>, "persist"> & {
+declare const CheckoutContext: react.Context<(Omit<zustand.StoreApi<CheckoutState>, "persist"> & {
     persist: {
         setOptions: (options: Partial<zustand_middleware.PersistOptions<CheckoutState, unknown>>) => void;
         clearStorage: () => void;
@@ -113,6 +113,45 @@ declare function useClickAnyWhere(handler: (event: MouseEvent) => void): void;
 type ClickOutGetContainer = () => HTMLElement | null;
 declare function useClickOut(ref: MutableRefObject<HTMLElement | null>, handler: (event: MouseEvent) => void): void;
 
+declare function localCollectionFetch<T = unknown>(pathname: string, options?: ApiRequestOptions, serviceOptions?: {
+    locale: string;
+    market: string;
+}): Promise<T>;
+declare function localCollectionGet<T = unknown>(url: string, options?: ApiRequestOptions, serviceOptions?: {
+    locale: string;
+    market: string;
+}): Promise<T>;
+declare function localCollectionPost<T = unknown>(url: string, payload?: unknown, options?: ApiRequestOptions, serviceOptions?: {
+    locale: string;
+    market: string;
+}): Promise<T>;
+declare function localCollectionPut<T = unknown>(url: string, payload?: unknown, options?: ApiRequestOptions, serviceOptions?: {
+    locale: string;
+    market: string;
+}): Promise<T>;
+declare function localCollectionPatch<T = unknown>(url: string, payload?: unknown, options?: ApiRequestOptions, serviceOptions?: {
+    locale: string;
+    market: string;
+}): Promise<T>;
+declare function localCollectionDelete<T = unknown>(url: string, options?: ApiRequestOptions, serviceOptions?: {
+    locale: string;
+    market: string;
+}): Promise<T>;
+
+type CollectionApi = {
+    get: <T = unknown>(pathname: string, params?: QueryParams, options?: ApiRequestOptions) => Promise<T>;
+    post: <T = unknown>(pathname: string, payload?: unknown, options?: ApiRequestOptions) => Promise<T>;
+    put: <T = unknown>(pathname: string, payload?: unknown, options?: ApiRequestOptions) => Promise<T>;
+    patch: <T = unknown>(pathname: string, payload?: unknown, options?: ApiRequestOptions) => Promise<T>;
+    delete: <T = unknown>(pathname: string, options?: ApiRequestOptions) => Promise<T>;
+};
+declare function useCollectionApi(): CollectionApi;
+declare function useCollectionApiGet<T = unknown>(pathname: string, params?: QueryParams, options?: ApiRequestOptions): [T | undefined, boolean, any, react.Dispatch<any>];
+declare function useCollectionApiPost<T = unknown>(pathname: string, payload: unknown, options?: ApiRequestOptions): [T | undefined, boolean, any, react.Dispatch<any>];
+declare function useCollectionApiPut<T = unknown>(pathname: string, payload: unknown, options?: ApiRequestOptions): [T | undefined, boolean, any, react.Dispatch<any>];
+declare function useCollectionApiPatch<T = unknown>(pathname: string, payload: unknown, options?: ApiRequestOptions): [T | undefined, boolean, any, react.Dispatch<any>];
+declare function useCollectionApiDelete<T = unknown>(pathname: string, options?: ApiRequestOptions): [T | undefined, boolean, any, react.Dispatch<any>];
+
 declare function useCurrency(currency?: string, locale?: string): (value: number) => string;
 
 declare function useCurrentState<S>(initialState: S | (() => S)): CurrentStateType<S>;
@@ -161,6 +200,13 @@ declare function useEventListener_<K extends keyof HTMLElementEventMap, T extend
 declare function useEventListener_<K extends keyof DocumentEventMap>(eventName: K, handler: (event: DocumentEventMap[K]) => void, element: RefObject<Document>, options?: boolean | AddEventListenerOptions): void;
 declare const useEventListener: typeof useEventListener_;
 
+type IExtra = Record<string, any>;
+declare const useExtra: () => IExtra;
+declare function ExtraProvider({ children, extra }: {
+    children?: react__default.ReactNode;
+    extra: IExtra;
+}): react_jsx_runtime.JSX.Element;
+
 type FilterParams = {
     [key: string]: IEquatable[] | null;
 };
@@ -219,7 +265,7 @@ type UseFiltersResultType<T> = {
     itemsWithOmittedKeys: (...keys: string[]) => T[];
 };
 
-declare const createGenericContext: <T>(defaultContext?: T | null) => readonly [() => NonNullable<T>, React$1.Provider<T | undefined>];
+declare const createGenericContext: <T>(defaultContext?: T | null) => readonly [() => NonNullable<T>, react.Provider<T | undefined>];
 
 /**
  * @desc Made compatible with {GeolocationPositionError} and {PositionError} cause
@@ -360,21 +406,21 @@ type KeyboardOptions = {
 };
 type KeyboardResult = {
     bindings: {
-        onKeyDown: React__default.KeyboardEventHandler;
-        onKeyDownCapture: React__default.KeyboardEventHandler;
-        onKeyPress: React__default.KeyboardEventHandler;
-        onKeyPressCapture: React__default.KeyboardEventHandler;
-        onKeyUp: React__default.KeyboardEventHandler;
-        onKeyUpCapture: React__default.KeyboardEventHandler;
+        onKeyDown: react__default.KeyboardEventHandler;
+        onKeyDownCapture: react__default.KeyboardEventHandler;
+        onKeyPress: react__default.KeyboardEventHandler;
+        onKeyPressCapture: react__default.KeyboardEventHandler;
+        onKeyUp: react__default.KeyboardEventHandler;
+        onKeyUpCapture: react__default.KeyboardEventHandler;
     };
 };
-type UseKeyboardHandler = (event: React__default.KeyboardEvent | KeyboardEvent) => void;
+type UseKeyboardHandler = (event: react__default.KeyboardEvent | KeyboardEvent) => void;
 type UseKeyboard = (handler: UseKeyboardHandler, keyBindings: Array<number> | number, options?: KeyboardOptions) => KeyboardResult;
 
 type ILabelContext = (key: string, params?: Record<string, any>) => string;
 declare const useLabel: () => ILabelContext;
 declare function LabelProvider({ children }: {
-    children?: React__default.ReactNode;
+    children?: react__default.ReactNode;
 }): react_jsx_runtime.JSX.Element;
 declare class LabelService {
     labels: ILabel[];
@@ -388,14 +434,14 @@ declare function parseParams(label: string, params: Record<string, any>): string
 type ILayoutContext = ILayout;
 declare const useLayout: () => ILayout;
 declare function LayoutProvider({ children, layout }: {
-    children?: React__default.ReactNode;
+    children?: react__default.ReactNode;
     layout: ILayout;
 }): react_jsx_runtime.JSX.Element;
 
 type ILazyModulesContext = ILazyModules;
 declare const useLazyModules: () => ILazyModules;
 declare function LazyModulesProvider({ children, modules }: {
-    children?: React__default.ReactNode;
+    children?: react__default.ReactNode;
     modules: ILazyModules;
 }): react_jsx_runtime.JSX.Element;
 
@@ -408,18 +454,20 @@ declare function useNumber(options?: Intl.NumberFormatOptions, locale?: string):
 type IPageContext = IPage;
 declare const usePage: () => NonNullable<IPage>;
 declare function PageProvider({ children, page }: {
-    children?: React__default.ReactNode;
+    children?: react__default.ReactNode;
     page: IPage;
 }): react_jsx_runtime.JSX.Element;
 
-type IPaginationInfo<T> = {
+type IPaginationInfo<T = any> = {
     items: T[];
-    total: number;
-    pages: number;
     page: number;
+    pages: number;
     perPage: number;
+    total: number;
 };
+declare function isPaginationInfo(item: unknown): item is IPaginationInfo<any>;
 declare function getPagedItems<T>(items: T[], page: number, perPage: number): T[];
+declare function getPaginationInfo<T>(items: T[], page?: number, perPage?: number): IPaginationInfo<T>;
 
 declare function usePagination<T>($items: T[], $page?: number, $perPage?: number): {
     items: T[];
@@ -513,22 +561,20 @@ type IUseSearchParamsEncodedResult = {
 };
 declare function useSearchParamsEncoded(key?: string): IUseSearchParamsEncodedResult;
 
-declare function getSearchParamsQs(url: string, key?: string): {} | null;
-declare function updateSearchParamsQs(currentPath: string, value: IParamsQs, key?: string): {
+type IParamsQs = Record<string, any>;
+type IUseSearchParamsQsResult = {
+    params: IParamsQs;
+    replaceParamsSilently: (params: IParamsQs) => void;
+    replaceParams: (params: IParamsQs) => void;
+};
+declare function getSearchParamsQs(url: string, key?: string): IParamsQs;
+declare function updateSearchParamsQs(url: string, value: IParamsQs, key?: string): {
     pathname: string;
-    query: {
-        [key: string]: 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;
-type IParamsQs = {};
-type IUseSearchParamsQsResult = {
-    params: Record<string, any> | null;
-    replaceParamsSilently: (params: IParamsQs) => void;
-    replaceParams: (params: IParamsQs) => void;
-};
 declare function useSearchParamsQs(key?: string): IUseSearchParamsQsResult;
 
 type Sorting<T> = {
@@ -578,4 +624,4 @@ type WindowSize = {
 };
 declare function useWindowSize(): WindowSize;
 
-export { BodyScrollOptions, CartContext, CartProvider, CheckoutContext, CheckoutProvider, ClickOutGetContainer, CurrentStateType, ElementStackItem, Filter, FilterMode, FilterParams, FilterValues, GeoLocationSensorState, 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, getRealSize, getSearchParams, getSearchParamsEncoded, getSearchParamsQs, getUID, hasGeolocation, 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, useCart, useCheckout, useClickAnyWhere, useClickOut, useCurrency, useCurrentState, useDateTimeFormat, useDebounce, useDebounceCallback, useDebugChangedProps, useDomObserver, useDrawer, useElementSize, useEventListener, useFilters, useGeolocation, useIdle, useInfiniteLoader, useIsomorphicLayoutEffect, useKeyboard, useLabel, useLayout, useLazyModules, useModal, useMounted, useNumber, usePage, usePagination, usePortal, usePrevious, useRealSize, useResize, useSSR, useScroll, useScrollTo, useScrolled, useSearchParams, useSearchParamsEncoded, useSearchParamsQs, useSearchParamsValue, useSorting, useSwiperIndex, useSyncedRef, useUI, useUnit, useUnmountEffect, useUser, useWindowSize };
+export { BodyScrollOptions, CartContext, CartProvider, CheckoutContext, CheckoutProvider, 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, 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, useCart, useCheckout, useClickAnyWhere, useClickOut, useCollectionApi, useCollectionApiDelete, useCollectionApiGet, useCollectionApiPatch, useCollectionApiPost, useCollectionApiPut, useCurrency, useCurrentState, useDateTimeFormat, useDebounce, useDebounceCallback, useDebugChangedProps, useDomObserver, useDrawer, useElementSize, useEventListener, useExtra, useFilters, useGeolocation, useIdle, useInfiniteLoader, useIsomorphicLayoutEffect, useKeyboard, useLabel, useLayout, useLazyModules, useModal, useMounted, useNumber, usePage, usePagination, usePortal, usePrevious, useRealSize, useResize, useSSR, useScroll, useScrollTo, useScrolled, useSearchParams, useSearchParamsEncoded, useSearchParamsQs, useSearchParamsValue, useSorting, useSwiperIndex, useSyncedRef, useUI, useUnit, useUnmountEffect, useUser, useWindowSize };