@websolutespa/bom-mixer-hooks 1.3.0 → 1.4.0

package/CHANGELOG.md

@@ -1,63 +1,69 @@
-# @websolutespa/bom-mixer-hooks
-
-## 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.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

@@ -6,7 +6,7 @@ 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 { ICartItem, ICartAddItem, IAddressOptions, ICheckoutPartial, IFeatureType, IUser } from '@websolutespa/bom-mixer-models';
+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>];
@@ -392,6 +392,13 @@ declare function LayoutProvider({ children, layout }: {
     layout: ILayout;
 }): react_jsx_runtime.JSX.Element;
 
+type ILazyModulesContext = ILazyModules;
+declare const useLazyModules: () => ILazyModules;
+declare function LazyModulesProvider({ children, modules }: {
+    children?: React__default.ReactNode;
+    modules: ILazyModules;
+}): react_jsx_runtime.JSX.Element;
+
 declare function useModal(): [modal: UIValue, open: (value?: string) => void, close: () => void];
 
 declare function useMounted(): boolean;
@@ -571,4 +578,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, IPageContext, IPaginationInfo, IParams, IParamsEncoded, IParamsQs, IUseSearchParamsEncodedResult, IUseSearchParamsQsResult, IUseSearchParamsResult, IUseSearchParamsValueResult, KeyCode, KeyMod, KeyboardOptions, KeyboardResult, LabelProvider, LabelService, LayoutProvider, 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, 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, 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 };

package/dist/index.js

@@ -80,6 +80,7 @@ __export(src_exports, {
   LabelProvider: () => LabelProvider,
   LabelService: () => LabelService,
   LayoutProvider: () => LayoutProvider,
+  LazyModulesProvider: () => LazyModulesProvider,
   PageProvider: () => PageProvider,
   createElementWithId: () => createElementWithId,
   createGenericContext: () => createGenericContext,
@@ -146,6 +147,7 @@ __export(src_exports, {
   useKeyboard: () => useKeyboard,
   useLabel: () => useLabel,
   useLayout: () => useLayout,
+  useLazyModules: () => useLazyModules,
   useModal: () => useModal,
   useMounted: () => useMounted,
   useNumber: () => useNumber,
@@ -1384,6 +1386,13 @@ function parseParams(label, params) {
   });
 }
 
+// src/useLazyModules/useLazyModules.tsx
+var import_jsx_runtime5 = require("react/jsx-runtime");
+var [useLazyModules, LazyModulesContextProvider] = createGenericContext({});
+function LazyModulesProvider({ children, modules }) {
+  return /* @__PURE__ */ (0, import_jsx_runtime5.jsx)(LazyModulesContextProvider, { value: modules, children });
+}
+
 // src/useModal/useModal.ts
 function useModal() {
   const modal = useUI((state) => state.views.modal);
@@ -1411,10 +1420,10 @@ function useMounted() {
 }
 
 // src/usePage/usePage.tsx
-var import_jsx_runtime5 = require("react/jsx-runtime");
+var import_jsx_runtime6 = require("react/jsx-runtime");
 var [usePage, PageContextProvider] = createGenericContext();
 function PageProvider({ children, page }) {
-  return /* @__PURE__ */ (0, import_jsx_runtime5.jsx)(PageContextProvider, { value: page, children });
+  return /* @__PURE__ */ (0, import_jsx_runtime6.jsx)(PageContextProvider, { value: page, children });
 }
 
 // src/usePagination/pagination.service.ts
@@ -2026,6 +2035,7 @@ var useUser = (0, import_zustand4.create)((set) => ({
   LabelProvider,
   LabelService,
   LayoutProvider,
+  LazyModulesProvider,
   PageProvider,
   createElementWithId,
   createGenericContext,
@@ -2092,6 +2102,7 @@ var useUser = (0, import_zustand4.create)((set) => ({
   useKeyboard,
   useLabel,
   useLayout,
+  useLazyModules,
   useModal,
   useMounted,
   useNumber,

package/dist/index.mjs

@@ -1260,6 +1260,13 @@ function parseParams(label, params) {
   });
 }
 
+// src/useLazyModules/useLazyModules.tsx
+import { jsx as jsx5 } from "react/jsx-runtime";
+var [useLazyModules, LazyModulesContextProvider] = createGenericContext({});
+function LazyModulesProvider({ children, modules }) {
+  return /* @__PURE__ */ jsx5(LazyModulesContextProvider, { value: modules, children });
+}
+
 // src/useModal/useModal.ts
 function useModal() {
   const modal = useUI((state) => state.views.modal);
@@ -1287,10 +1294,10 @@ function useMounted() {
 }
 
 // src/usePage/usePage.tsx
-import { jsx as jsx5 } from "react/jsx-runtime";
+import { jsx as jsx6 } from "react/jsx-runtime";
 var [usePage, PageContextProvider] = createGenericContext();
 function PageProvider({ children, page }) {
-  return /* @__PURE__ */ jsx5(PageContextProvider, { value: page, children });
+  return /* @__PURE__ */ jsx6(PageContextProvider, { value: page, children });
 }
 
 // src/usePagination/pagination.service.ts
@@ -1901,6 +1908,7 @@ export {
   LabelProvider,
   LabelService,
   LayoutProvider,
+  LazyModulesProvider,
   PageProvider,
   createElementWithId,
   createGenericContext,
@@ -1967,6 +1975,7 @@ export {
   useKeyboard,
   useLabel,
   useLayout,
+  useLazyModules,
   useModal,
   useMounted,
   useNumber,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@websolutespa/bom-mixer-hooks",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Mixer Hooks module of the BOM Repository",
   "keywords": [
     "bom",

package/src/index.ts

@@ -27,6 +27,7 @@ export * from './useIsomorphicLayoutEffect/useIsomorphicLayoutEffect';
 export * from './useKeyboard/useKeyboard';
 export * from './useLabel/useLabel';
 export * from './useLayout/useLayout';
+export * from './useLazyModules/useLazyModules';
 export * from './useModal/useModal';
 export * from './useMounted/useMounted';
 export * from './useNumber/useNumber';

package/src/useLazyModules/component.tsx

@@ -0,0 +1,13 @@
+import { getClassNames } from '@websolutespa/bom-core';
+import { ILazyableProps } from '@websolutespa/bom-mixer-models';
+
+export type ComponentItem = {
+  title: string;
+};
+
+export const Component = ({ item }: ILazyableProps<ComponentItem>) => {
+  const classNames = getClassNames('component');
+  return (
+    <div className={classNames}>Component {item.title}</div>
+  );
+};

package/src/useLazyModules/useLazyModules.test.tsx

@@ -0,0 +1,40 @@
+// readme https://testing-library.com/
+import { renderHook } from '@testing-library/react';
+import { ILazyModules, ILazyProps } from '@websolutespa/bom-mixer-models';
+import dynamic from 'next/dynamic';
+import { ComponentItem } from './component';
+import { LazyModulesProvider, useLazyModules } from './useLazyModules';
+
+const LAZY_MODULES: ILazyModules = {
+  'component': dynamic<ILazyProps<ComponentItem>>(() => import('./component').then(
+    module => module.Component
+  )),
+};
+
+const wrapper = (props: { children: React.ReactNode }) => (
+  <LazyModulesProvider modules={LAZY_MODULES}>{props.children}</LazyModulesProvider>
+);
+
+describe('useLazyModules', () => {
+  beforeEach(() => {
+    jest.spyOn(console, 'error').mockImplementation(() => { });
+  });
+
+  test('should not throw without provider', () => {
+    expect(() => {
+      renderHook(() => useLazyModules());
+    }).not.toThrow();
+  });
+
+  test('should not throw with provider', () => {
+    expect(() => {
+      renderHook(() => useLazyModules(), { wrapper });
+    }).not.toThrow();
+  });
+
+  test('should return modules', () => {
+    const { result } = renderHook(() => useLazyModules(), { wrapper });
+    expect(result.current).toBe(LAZY_MODULES);
+  });
+
+});

package/src/useLazyModules/useLazyModules.tsx

@@ -0,0 +1,18 @@
+import { createGenericContext } from '@websolutespa/bom-mixer-hooks';
+import { ILazyModules } from '@websolutespa/bom-mixer-models';
+import React from 'react';
+
+export type ILazyModulesContext = ILazyModules;
+
+const [useLazyModules, LazyModulesContextProvider] = createGenericContext<ILazyModulesContext>({});
+
+function LazyModulesProvider({ children, modules }: { children?: React.ReactNode, modules: ILazyModules }) {
+  return (
+    <LazyModulesContextProvider value={modules}>
+      {children}
+    </LazyModulesContextProvider>
+  );
+}
+
+export { LazyModulesProvider, useLazyModules };
+