@beinformed/ui 1.65.29 → 2.0.0-beta.1

package/esm/hooks/useModelSelectors.js.flow

@@ -1,98 +0,0 @@
-// @flow
-import { useSelector } from "react-redux";
-
-import {
-  getAllModelsByInstance,
-  getFirstModelByInstance,
-  getActiveModelByInstance,
-  modelByHref,
-  keyByHref,
-  allKeysByHref,
-  getActiveModels,
-  getAllFinishedModels,
-} from "../redux/_modularui/ModularUISelectors";
-import type { ModularUIModel } from "../models/types";
-import type { ReduxState } from "../redux/types";
-import Href from "../models/href/Href";
-
-/**
- * Returns all models in the store that are instances of the provided class
- * and match the current application locale.
- */
-export const useAllModelsByInstance = <T>(
-  instance: Class<T>,
-): Array<ModularUIModel> => {
-  return useSelector((state: ReduxState) =>
-    getAllModelsByInstance(state, instance),
-  );
-};
-
-/**
- * Returns the first model found in the store that is an instance of the
- * provided class and matches the current locale.
- */
-export const useFirstModelByInstance = <T>(instance: Class<T>): T | null => {
-  return useSelector((state: ReduxState) =>
-    getFirstModelByInstance(state, instance),
-  );
-};
-
-/**
- * Returns the model instance that is currently "active" based on the URL path.
- * It checks if the current router location starts with the model's selfhref path.
- */
-export const useActiveModelByInstance = <T>(instance: Class<T>): T | null => {
-  return useSelector((state: ReduxState) =>
-    getActiveModelByInstance(state, instance),
-  );
-};
-
-/**
- * Retrieves a specific model from the store based on its unique Href.
- * @param {Href | string} href - The Href object or string path of the model.
- * @returns {ModularUIModel | null} The model matching the href or null.
- */
-export const useModelByHref = (href: Href | string): null | ModularUIModel => {
-  return useSelector((state: ReduxState) => modelByHref(state, href));
-};
-
-/**
- * Returns the unique store key (identifier) for a model associated with a specific Href.
- * @param {Href | string} href - The Href object or string path.
- * @returns {string | null | void} The internal key of the model.
- */
-export const useKeyByHref = (href: Href | string): ?string => {
-  return useSelector((state: ReduxState) => keyByHref(state, href));
-};
-
-/**
- * Returns all internal keys found in the store for a specific Href.
- * Useful if multiple versions/entries exist for the same path.
- * @param {Href | string} href - The Href object or string path.
- * @returns {Array<string>} An array of keys.
- */
-export const useAllKeysByHref = (href: Href | string): Array<string> => {
-  return useSelector((state: ReduxState) => allKeysByHref(state, href));
-};
-
-/**
- * Returns a list of simplified model info (key, href, label, type) for all
- * models currently active in the navigation context (breadcrumbs).
- * @returns {Array<{key: string, href: Href, label: string, type: string}>}
- */
-export const useActiveModels = (): Array<{
-  key: string,
-  href: Href,
-  label: string,
-  type: string,
-}> => {
-  return useSelector(getActiveModels);
-};
-
-/**
- * Returns all models in the store that have a status of MODULARUI_STATUS.FINISHED.
- * @returns {Array<ModularUIModel>} An array of fully loaded models.
- */
-export const useAllFinishedModels = (): Array<ModularUIModel> => {
-  return useSelector(getAllFinishedModels);
-};

package/esm/hooks/useModelSelectors.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"useModelSelectors.js","names":["useSelector","getAllModelsByInstance","getFirstModelByInstance","getActiveModelByInstance","modelByHref","keyByHref","allKeysByHref","getActiveModels","getAllFinishedModels","Href","useAllModelsByInstance","instance","state","useFirstModelByInstance","useActiveModelByInstance","useModelByHref","href","useKeyByHref","useAllKeysByHref","useActiveModels","useAllFinishedModels"],"sources":["../../src/hooks/useModelSelectors.js"],"sourcesContent":["// @flow\nimport { useSelector } from \"react-redux\";\n\nimport {\n  getAllModelsByInstance,\n  getFirstModelByInstance,\n  getActiveModelByInstance,\n  modelByHref,\n  keyByHref,\n  allKeysByHref,\n  getActiveModels,\n  getAllFinishedModels,\n} from \"../redux/_modularui/ModularUISelectors\";\nimport type { ModularUIModel } from \"../models/types\";\nimport type { ReduxState } from \"../redux/types\";\nimport Href from \"../models/href/Href\";\n\n/**\n * Returns all models in the store that are instances of the provided class\n * and match the current application locale.\n */\nexport const useAllModelsByInstance = <T>(\n  instance: Class<T>,\n): Array<ModularUIModel> => {\n  return useSelector((state: ReduxState) =>\n    getAllModelsByInstance(state, instance),\n  );\n};\n\n/**\n * Returns the first model found in the store that is an instance of the\n * provided class and matches the current locale.\n */\nexport const useFirstModelByInstance = <T>(instance: Class<T>): T | null => {\n  return useSelector((state: ReduxState) =>\n    getFirstModelByInstance(state, instance),\n  );\n};\n\n/**\n * Returns the model instance that is currently \"active\" based on the URL path.\n * It checks if the current router location starts with the model's selfhref path.\n */\nexport const useActiveModelByInstance = <T>(instance: Class<T>): T | null => {\n  return useSelector((state: ReduxState) =>\n    getActiveModelByInstance(state, instance),\n  );\n};\n\n/**\n * Retrieves a specific model from the store based on its unique Href.\n * @param {Href | string} href - The Href object or string path of the model.\n * @returns {ModularUIModel | null} The model matching the href or null.\n */\nexport const useModelByHref = (href: Href | string): null | ModularUIModel => {\n  return useSelector((state: ReduxState) => modelByHref(state, href));\n};\n\n/**\n * Returns the unique store key (identifier) for a model associated with a specific Href.\n * @param {Href | string} href - The Href object or string path.\n * @returns {string | null | void} The internal key of the model.\n */\nexport const useKeyByHref = (href: Href | string): ?string => {\n  return useSelector((state: ReduxState) => keyByHref(state, href));\n};\n\n/**\n * Returns all internal keys found in the store for a specific Href.\n * Useful if multiple versions/entries exist for the same path.\n * @param {Href | string} href - The Href object or string path.\n * @returns {Array<string>} An array of keys.\n */\nexport const useAllKeysByHref = (href: Href | string): Array<string> => {\n  return useSelector((state: ReduxState) => allKeysByHref(state, href));\n};\n\n/**\n * Returns a list of simplified model info (key, href, label, type) for all\n * models currently active in the navigation context (breadcrumbs).\n * @returns {Array<{key: string, href: Href, label: string, type: string}>}\n */\nexport const useActiveModels = (): Array<{\n  key: string,\n  href: Href,\n  label: string,\n  type: string,\n}> => {\n  return useSelector(getActiveModels);\n};\n\n/**\n * Returns all models in the store that have a status of MODULARUI_STATUS.FINISHED.\n * @returns {Array<ModularUIModel>} An array of fully loaded models.\n */\nexport const useAllFinishedModels = (): Array<ModularUIModel> => {\n  return useSelector(getAllFinishedModels);\n};\n"],"mappings":"AACA,SAASA,WAAW,QAAQ,aAAa;AAEzC,SACEC,sBAAsB,EACtBC,uBAAuB,EACvBC,wBAAwB,EACxBC,WAAW,EACXC,SAAS,EACTC,aAAa,EACbC,eAAe,EACfC,oBAAoB,QACf,wCAAwC;AAG/C,OAAOC,IAAI,MAAM,qBAAqB;;AAEtC;AACA;AACA;AACA;AACA,OAAO,MAAMC,sBAAsB,GACjCC,QAAkB,IACQ;EAC1B,OAAOX,WAAW,CAAEY,KAAiB,IACnCX,sBAAsB,CAACW,KAAK,EAAED,QAAQ,CACxC,CAAC;AACH,CAAC;;AAED;AACA;AACA;AACA;AACA,OAAO,MAAME,uBAAuB,GAAOF,QAAkB,IAAe;EAC1E,OAAOX,WAAW,CAAEY,KAAiB,IACnCV,uBAAuB,CAACU,KAAK,EAAED,QAAQ,CACzC,CAAC;AACH,CAAC;;AAED;AACA;AACA;AACA;AACA,OAAO,MAAMG,wBAAwB,GAAOH,QAAkB,IAAe;EAC3E,OAAOX,WAAW,CAAEY,KAAiB,IACnCT,wBAAwB,CAACS,KAAK,EAAED,QAAQ,CAC1C,CAAC;AACH,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMI,cAAc,GAAIC,IAAmB,IAA4B;EAC5E,OAAOhB,WAAW,CAAEY,KAAiB,IAAKR,WAAW,CAACQ,KAAK,EAAEI,IAAI,CAAC,CAAC;AACrE,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,YAAY,GAAID,IAAmB,IAAc;EAC5D,OAAOhB,WAAW,CAAEY,KAAiB,IAAKP,SAAS,CAACO,KAAK,EAAEI,IAAI,CAAC,CAAC;AACnE,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAME,gBAAgB,GAAIF,IAAmB,IAAoB;EACtE,OAAOhB,WAAW,CAAEY,KAAiB,IAAKN,aAAa,CAACM,KAAK,EAAEI,IAAI,CAAC,CAAC;AACvE,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMG,eAAe,GAAGA,CAAA,KAKzB;EACJ,OAAOnB,WAAW,CAACO,eAAe,CAAC;AACrC,CAAC;;AAED;AACA;AACA;AACA;AACA,OAAO,MAAMa,oBAAoB,GAAGA,CAAA,KAA6B;EAC/D,OAAOpB,WAAW,CAACQ,oBAAoB,CAAC;AAC1C,CAAC","ignoreList":[]}

package/esm/hooks/useModels.js

@@ -1,37 +0,0 @@
-import _Object$keys from "@babel/runtime-corejs3/core-js-stable/object/keys";
-import _filterInstanceProperty from "@babel/runtime-corejs3/core-js-stable/instance/filter";
-import { createSelector } from "reselect";
-import { useSelector, useDispatch } from "react-redux";
-import { reloadModel } from "../redux/_modularui/ModularUIActions";
-import { MODULARUI_STATUS } from "../constants/Constants";
-/**
- * Hook that contains the reload property that can be used to reload a model
- */
-export const useModels = () => {
-  const dispatch = useDispatch();
-  const selectModularUI = state => state.modularui;
-  const selector = createSelector([selectModularUI], modularui => {
-    const models = [];
-    const keys = _Object$keys(modularui);
-    for (const key of keys) {
-      const model = modularui[key];
-      if (model?.status === MODULARUI_STATUS.FINISHED) {
-        models.push(model.model);
-      }
-    }
-    return models;
-  });
-  const modularuiModels = useSelector(selector);
-  return {
-    reload: (model, options) => {
-      dispatch(reloadModel(model, options));
-    },
-    reloadWithFilter: (callbackFn, options) => {
-      const modelsToReload = _filterInstanceProperty(modularuiModels).call(modularuiModels, callbackFn);
-      for (const modelToReload of modelsToReload) {
-        dispatch(reloadModel(modelToReload, options));
-      }
-    }
-  };
-};
-//# sourceMappingURL=useModels.js.map

package/esm/hooks/useModels.js.flow

@@ -1,50 +0,0 @@
-// @flow
-import { createSelector } from "reselect";
-import { useSelector, useDispatch } from "react-redux";
-
-import { reloadModel } from "../redux/_modularui/ModularUIActions";
-import { MODULARUI_STATUS } from "../constants/Constants";
-
-import type { ModularUIModel } from "../models/types";
-import type { ReduxState, ModelEntry } from "../redux";
-
-type ReloadCallback = (model: ModularUIModel) => boolean;
-
-type UseModels = () => {
-  reload: (model: ModularUIModel, options?: any) => void,
-  reloadWithFilter: (callbackFn: ReloadCallback, options?: any) => void,
-};
-
-/**
- * Hook that contains the reload property that can be used to reload a model
- */
-export const useModels: UseModels = () => {
-  const dispatch = useDispatch();
-
-  const selectModularUI = (state: ReduxState) => state.modularui;
-  const selector = createSelector([selectModularUI], (modularui) => {
-    const models = [];
-    const keys = Object.keys(modularui);
-    for (const key of keys) {
-      const model: ModelEntry = modularui[key];
-      if (model?.status === MODULARUI_STATUS.FINISHED) {
-        models.push(model.model);
-      }
-    }
-    return models;
-  });
-
-  const modularuiModels = useSelector(selector);
-
-  return {
-    reload: (model: ModularUIModel, options?: Object) => {
-      dispatch(reloadModel(model, options));
-    },
-    reloadWithFilter: (callbackFn: ReloadCallback, options?: Object) => {
-      const modelsToReload = modularuiModels.filter(callbackFn);
-      for (const modelToReload of modelsToReload) {
-        dispatch(reloadModel(modelToReload, options));
-      }
-    },
-  };
-};

package/esm/hooks/useModels.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"useModels.js","names":["createSelector","useSelector","useDispatch","reloadModel","MODULARUI_STATUS","useModels","dispatch","selectModularUI","state","modularui","selector","models","keys","_Object$keys","key","model","status","FINISHED","push","modularuiModels","reload","options","reloadWithFilter","callbackFn","modelsToReload","_filterInstanceProperty","call","modelToReload"],"sources":["../../src/hooks/useModels.js"],"sourcesContent":["// @flow\nimport { createSelector } from \"reselect\";\nimport { useSelector, useDispatch } from \"react-redux\";\n\nimport { reloadModel } from \"../redux/_modularui/ModularUIActions\";\nimport { MODULARUI_STATUS } from \"../constants/Constants\";\n\nimport type { ModularUIModel } from \"../models/types\";\nimport type { ReduxState, ModelEntry } from \"../redux\";\n\ntype ReloadCallback = (model: ModularUIModel) => boolean;\n\ntype UseModels = () => {\n  reload: (model: ModularUIModel, options?: any) => void,\n  reloadWithFilter: (callbackFn: ReloadCallback, options?: any) => void,\n};\n\n/**\n * Hook that contains the reload property that can be used to reload a model\n */\nexport const useModels: UseModels = () => {\n  const dispatch = useDispatch();\n\n  const selectModularUI = (state: ReduxState) => state.modularui;\n  const selector = createSelector([selectModularUI], (modularui) => {\n    const models = [];\n    const keys = Object.keys(modularui);\n    for (const key of keys) {\n      const model: ModelEntry = modularui[key];\n      if (model?.status === MODULARUI_STATUS.FINISHED) {\n        models.push(model.model);\n      }\n    }\n    return models;\n  });\n\n  const modularuiModels = useSelector(selector);\n\n  return {\n    reload: (model: ModularUIModel, options?: Object) => {\n      dispatch(reloadModel(model, options));\n    },\n    reloadWithFilter: (callbackFn: ReloadCallback, options?: Object) => {\n      const modelsToReload = modularuiModels.filter(callbackFn);\n      for (const modelToReload of modelsToReload) {\n        dispatch(reloadModel(modelToReload, options));\n      }\n    },\n  };\n};\n"],"mappings":";;AACA,SAASA,cAAc,QAAQ,UAAU;AACzC,SAASC,WAAW,EAAEC,WAAW,QAAQ,aAAa;AAEtD,SAASC,WAAW,QAAQ,sCAAsC;AAClE,SAASC,gBAAgB,QAAQ,wBAAwB;AAYzD;AACA;AACA;AACA,OAAO,MAAMC,SAAoB,GAAGA,CAAA,KAAM;EACxC,MAAMC,QAAQ,GAAGJ,WAAW,CAAC,CAAC;EAE9B,MAAMK,eAAe,GAAIC,KAAiB,IAAKA,KAAK,CAACC,SAAS;EAC9D,MAAMC,QAAQ,GAAGV,cAAc,CAAC,CAACO,eAAe,CAAC,EAAGE,SAAS,IAAK;IAChE,MAAME,MAAM,GAAG,EAAE;IACjB,MAAMC,IAAI,GAAGC,YAAA,CAAYJ,SAAS,CAAC;IACnC,KAAK,MAAMK,GAAG,IAAIF,IAAI,EAAE;MACtB,MAAMG,KAAiB,GAAGN,SAAS,CAACK,GAAG,CAAC;MACxC,IAAIC,KAAK,EAAEC,MAAM,KAAKZ,gBAAgB,CAACa,QAAQ,EAAE;QAC/CN,MAAM,CAACO,IAAI,CAACH,KAAK,CAACA,KAAK,CAAC;MAC1B;IACF;IACA,OAAOJ,MAAM;EACf,CAAC,CAAC;EAEF,MAAMQ,eAAe,GAAGlB,WAAW,CAACS,QAAQ,CAAC;EAE7C,OAAO;IACLU,MAAM,EAAEA,CAACL,KAAqB,EAAEM,OAAgB,KAAK;MACnDf,QAAQ,CAACH,WAAW,CAACY,KAAK,EAAEM,OAAO,CAAC,CAAC;IACvC,CAAC;IACDC,gBAAgB,EAAEA,CAACC,UAA0B,EAAEF,OAAgB,KAAK;MAClE,MAAMG,cAAc,GAAGC,uBAAA,CAAAN,eAAe,EAAAO,IAAA,CAAfP,eAAe,EAAQI,UAAU,CAAC;MACzD,KAAK,MAAMI,aAAa,IAAIH,cAAc,EAAE;QAC1ClB,QAAQ,CAACH,WAAW,CAACwB,aAAa,EAAEN,OAAO,CAAC,CAAC;MAC/C;IACF;EACF,CAAC;AACH,CAAC","ignoreList":[]}

package/esm/hooks/useModularUI.js

@@ -1,91 +0,0 @@
-import { useEffect, useMemo, useRef } from "react";
-import { useDispatch, useSelector } from "react-redux";
-import { useLocation } from "react-router";
-import { HTTP_METHODS, MODULARUI_STATUS } from "../constants";
-import { loadModularUI, removeModelByKey } from "../redux/_modularui/ModularUIActions";
-import useDeepCompareEffect from "./useDeepCompareEffect";
-import { useModularUIKey } from "./useModularUIKey";
-import Href from "../models/href/Href";
-/**
- * A custom hook to fetch and manage Be Informed modular UI resources.
- * It handles automatic data fetching based on URL/query changes, manages Redux state
- * synchronization, and provides cleanup logic when components unmount.
- *
- * @param {string} modelKey - A unique identifier for the type of model being fetched.
- * @param {string | Href} url - The endpoint URL or Href instance to fetch data from.
- * @param {RequestModularUIOptions} options - Configuration for the request (method, headers, etc.).
- * @returns {ModelEntry} The model data retrieved from the Redux store.
- */
-export const useModularUI = (modelKey, url, options = {}) => {
-  const dispatch = useDispatch();
-
-  // Normalize the URL input into a Href instance to safely access query params and paths
-  const hrefInstance = useMemo(() => new Href(url), [url]);
-  const requestUrl = useMemo(() => hrefInstance.toString(), [hrefInstance]);
-  const currentQueryString = hrefInstance.querystring;
-
-  // Persistence ref to detect if query parameters have changed between renders
-  const prevQueryRef = useRef(currentQueryString);
-
-  // Generate a unique key for the Redux store based on the model type and the full URL
-  const key = useModularUIKey(modelKey, requestUrl);
-
-  // Select the specific piece of state corresponding to this modular UI component
-  const model = useSelector(state => state.modularui[key]);
-
-  /**
-   * Memoize request options to prevent unnecessary re-renders.
-   * Merges default settings (GET method, auto-cleanup) with user-provided options.
-   */
-  const requestOptions = useMemo(() => {
-    const merged = {
-      method: HTTP_METHODS.GET,
-      removeOnUnmount: true,
-      ...options
-    };
-    if (url instanceof Href) {
-      merged.origin = merged.origin ?? url.origin;
-      merged.contextPath = merged.contextPath ?? url.contextPath;
-    }
-    return merged;
-  }, [options, url]);
-  const location = useLocation();
-  const redirectLocation = location.state?.redirectLocation;
-
-  /**
-   * Determines if a network request should be initiated.
-   * Logic includes:
-   * - Model doesn't exist yet (Initial load)
-   * - Previous request resulted in an error (Retry)
-   * - The query parameters changed (Filtering/Paging)
-   * - A redirect was triggered specifically for this URL
-   * - Manual 'isReload' flag is passed in options
-   */
-  const shouldLoad = model == null || model.status === MODULARUI_STATUS.ERROR || prevQueryRef.current !== currentQueryString || (redirectLocation instanceof Href ? redirectLocation.equals(requestUrl) : false) || requestOptions.isReload === true;
-
-  // Synchronize the ref after the render cycle determines if we should load
-  useEffect(() => {
-    prevQueryRef.current = currentQueryString;
-  }, [currentQueryString]);
-
-  // Execute the load action. Deep compare is used on options to prevent
-  // infinite loops caused by passing inline object literals.
-  useDeepCompareEffect(() => {
-    if (requestUrl !== "" && shouldLoad) {
-      dispatch(loadModularUI(key, requestUrl, requestOptions));
-    }
-  }, [key, requestUrl, requestOptions, shouldLoad]);
-
-  // Cleanup Effect:
-  // If 'removeOnUnmount' is true, this removes the model data from the Redux store
-  // when the component using this hook is destroyed.
-  useEffect(() => {
-    if (requestOptions.removeOnUnmount) {
-      return () => {
-        dispatch(removeModelByKey(key));
-      };
-    }
-  }, [dispatch, key, requestOptions.removeOnUnmount]);
-  return model;
-};
-//# sourceMappingURL=useModularUI.js.map

package/esm/hooks/useModularUI.js.flow

@@ -1,115 +0,0 @@
-// @flow
-import { useEffect, useMemo, useRef } from "react";
-import { useDispatch, useSelector } from "react-redux";
-import { useLocation } from "react-router";
-
-import { HTTP_METHODS, MODULARUI_STATUS } from "../constants";
-import {
-  loadModularUI,
-  removeModelByKey,
-} from "../redux/_modularui/ModularUIActions";
-
-import useDeepCompareEffect from "./useDeepCompareEffect";
-import { useModularUIKey } from "./useModularUIKey";
-
-import Href from "../models/href/Href";
-
-import type { RequestModularUIOptions } from "../utils";
-import type { ModelEntry } from "../redux";
-
-/**
- * A custom hook to fetch and manage Be Informed modular UI resources.
- * It handles automatic data fetching based on URL/query changes, manages Redux state
- * synchronization, and provides cleanup logic when components unmount.
- *
- * @param {string} modelKey - A unique identifier for the type of model being fetched.
- * @param {string | Href} url - The endpoint URL or Href instance to fetch data from.
- * @param {RequestModularUIOptions} options - Configuration for the request (method, headers, etc.).
- * @returns {ModelEntry} The model data retrieved from the Redux store.
- */
-export const useModularUI = (
-  modelKey: string,
-  url: string | Href,
-  options: RequestModularUIOptions = (({}: any): RequestModularUIOptions),
-): any => {
-  const dispatch = useDispatch();
-
-  // Normalize the URL input into a Href instance to safely access query params and paths
-  const hrefInstance = useMemo(() => new Href(url), [url]);
-  const requestUrl = useMemo(() => hrefInstance.toString(), [hrefInstance]);
-  const currentQueryString = hrefInstance.querystring;
-
-  // Persistence ref to detect if query parameters have changed between renders
-  const prevQueryRef = useRef(currentQueryString);
-
-  // Generate a unique key for the Redux store based on the model type and the full URL
-  const key = useModularUIKey(modelKey, requestUrl);
-
-  // Select the specific piece of state corresponding to this modular UI component
-  const model = useSelector((state) => state.modularui[key]);
-
-  /**
-   * Memoize request options to prevent unnecessary re-renders.
-   * Merges default settings (GET method, auto-cleanup) with user-provided options.
-   */
-  const requestOptions = useMemo(() => {
-    const merged = {
-      method: HTTP_METHODS.GET,
-      removeOnUnmount: true,
-      ...options,
-    };
-
-    if (url instanceof Href) {
-      merged.origin = merged.origin ?? url.origin;
-      merged.contextPath = merged.contextPath ?? url.contextPath;
-    }
-    return merged;
-  }, [options, url]);
-
-  const location = useLocation();
-  const redirectLocation = location.state?.redirectLocation;
-
-  /**
-   * Determines if a network request should be initiated.
-   * Logic includes:
-   * - Model doesn't exist yet (Initial load)
-   * - Previous request resulted in an error (Retry)
-   * - The query parameters changed (Filtering/Paging)
-   * - A redirect was triggered specifically for this URL
-   * - Manual 'isReload' flag is passed in options
-   */
-  const shouldLoad =
-    model == null ||
-    model.status === MODULARUI_STATUS.ERROR ||
-    prevQueryRef.current !== currentQueryString ||
-    (redirectLocation instanceof Href
-      ? redirectLocation.equals(requestUrl)
-      : false) ||
-    requestOptions.isReload === true;
-
-  // Synchronize the ref after the render cycle determines if we should load
-  useEffect(() => {
-    prevQueryRef.current = currentQueryString;
-  }, [currentQueryString]);
-
-  // Execute the load action. Deep compare is used on options to prevent
-  // infinite loops caused by passing inline object literals.
-  useDeepCompareEffect(() => {
-    if (requestUrl !== "" && shouldLoad) {
-      dispatch(loadModularUI(key, requestUrl, requestOptions));
-    }
-  }, [key, requestUrl, requestOptions, shouldLoad]);
-
-  // Cleanup Effect:
-  // If 'removeOnUnmount' is true, this removes the model data from the Redux store
-  // when the component using this hook is destroyed.
-  useEffect(() => {
-    if (requestOptions.removeOnUnmount) {
-      return () => {
-        dispatch(removeModelByKey(key));
-      };
-    }
-  }, [dispatch, key, requestOptions.removeOnUnmount]);
-
-  return model;
-};

package/esm/hooks/useModularUI.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"useModularUI.js","names":["useEffect","useMemo","useRef","useDispatch","useSelector","useLocation","HTTP_METHODS","MODULARUI_STATUS","loadModularUI","removeModelByKey","useDeepCompareEffect","useModularUIKey","Href","useModularUI","modelKey","url","options","dispatch","hrefInstance","requestUrl","toString","currentQueryString","querystring","prevQueryRef","key","model","state","modularui","requestOptions","merged","method","GET","removeOnUnmount","origin","contextPath","location","redirectLocation","shouldLoad","status","ERROR","current","equals","isReload"],"sources":["../../src/hooks/useModularUI.js"],"sourcesContent":["// @flow\nimport { useEffect, useMemo, useRef } from \"react\";\nimport { useDispatch, useSelector } from \"react-redux\";\nimport { useLocation } from \"react-router\";\n\nimport { HTTP_METHODS, MODULARUI_STATUS } from \"../constants\";\nimport {\n  loadModularUI,\n  removeModelByKey,\n} from \"../redux/_modularui/ModularUIActions\";\n\nimport useDeepCompareEffect from \"./useDeepCompareEffect\";\nimport { useModularUIKey } from \"./useModularUIKey\";\n\nimport Href from \"../models/href/Href\";\n\nimport type { RequestModularUIOptions } from \"../utils\";\nimport type { ModelEntry } from \"../redux\";\n\n/**\n * A custom hook to fetch and manage Be Informed modular UI resources.\n * It handles automatic data fetching based on URL/query changes, manages Redux state\n * synchronization, and provides cleanup logic when components unmount.\n *\n * @param {string} modelKey - A unique identifier for the type of model being fetched.\n * @param {string | Href} url - The endpoint URL or Href instance to fetch data from.\n * @param {RequestModularUIOptions} options - Configuration for the request (method, headers, etc.).\n * @returns {ModelEntry} The model data retrieved from the Redux store.\n */\nexport const useModularUI = (\n  modelKey: string,\n  url: string | Href,\n  options: RequestModularUIOptions = (({}: any): RequestModularUIOptions),\n): any => {\n  const dispatch = useDispatch();\n\n  // Normalize the URL input into a Href instance to safely access query params and paths\n  const hrefInstance = useMemo(() => new Href(url), [url]);\n  const requestUrl = useMemo(() => hrefInstance.toString(), [hrefInstance]);\n  const currentQueryString = hrefInstance.querystring;\n\n  // Persistence ref to detect if query parameters have changed between renders\n  const prevQueryRef = useRef(currentQueryString);\n\n  // Generate a unique key for the Redux store based on the model type and the full URL\n  const key = useModularUIKey(modelKey, requestUrl);\n\n  // Select the specific piece of state corresponding to this modular UI component\n  const model = useSelector((state) => state.modularui[key]);\n\n  /**\n   * Memoize request options to prevent unnecessary re-renders.\n   * Merges default settings (GET method, auto-cleanup) with user-provided options.\n   */\n  const requestOptions = useMemo(() => {\n    const merged = {\n      method: HTTP_METHODS.GET,\n      removeOnUnmount: true,\n      ...options,\n    };\n\n    if (url instanceof Href) {\n      merged.origin = merged.origin ?? url.origin;\n      merged.contextPath = merged.contextPath ?? url.contextPath;\n    }\n    return merged;\n  }, [options, url]);\n\n  const location = useLocation();\n  const redirectLocation = location.state?.redirectLocation;\n\n  /**\n   * Determines if a network request should be initiated.\n   * Logic includes:\n   * - Model doesn't exist yet (Initial load)\n   * - Previous request resulted in an error (Retry)\n   * - The query parameters changed (Filtering/Paging)\n   * - A redirect was triggered specifically for this URL\n   * - Manual 'isReload' flag is passed in options\n   */\n  const shouldLoad =\n    model == null ||\n    model.status === MODULARUI_STATUS.ERROR ||\n    prevQueryRef.current !== currentQueryString ||\n    (redirectLocation instanceof Href\n      ? redirectLocation.equals(requestUrl)\n      : false) ||\n    requestOptions.isReload === true;\n\n  // Synchronize the ref after the render cycle determines if we should load\n  useEffect(() => {\n    prevQueryRef.current = currentQueryString;\n  }, [currentQueryString]);\n\n  // Execute the load action. Deep compare is used on options to prevent\n  // infinite loops caused by passing inline object literals.\n  useDeepCompareEffect(() => {\n    if (requestUrl !== \"\" && shouldLoad) {\n      dispatch(loadModularUI(key, requestUrl, requestOptions));\n    }\n  }, [key, requestUrl, requestOptions, shouldLoad]);\n\n  // Cleanup Effect:\n  // If 'removeOnUnmount' is true, this removes the model data from the Redux store\n  // when the component using this hook is destroyed.\n  useEffect(() => {\n    if (requestOptions.removeOnUnmount) {\n      return () => {\n        dispatch(removeModelByKey(key));\n      };\n    }\n  }, [dispatch, key, requestOptions.removeOnUnmount]);\n\n  return model;\n};\n"],"mappings":"AACA,SAASA,SAAS,EAAEC,OAAO,EAAEC,MAAM,QAAQ,OAAO;AAClD,SAASC,WAAW,EAAEC,WAAW,QAAQ,aAAa;AACtD,SAASC,WAAW,QAAQ,cAAc;AAE1C,SAASC,YAAY,EAAEC,gBAAgB,QAAQ,cAAc;AAC7D,SACEC,aAAa,EACbC,gBAAgB,QACX,sCAAsC;AAE7C,OAAOC,oBAAoB,MAAM,wBAAwB;AACzD,SAASC,eAAe,QAAQ,mBAAmB;AAEnD,OAAOC,IAAI,MAAM,qBAAqB;AAKtC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,YAAY,GAAGA,CAC1BC,QAAgB,EAChBC,GAAkB,EAClBC,OAAgC,GAAK,CAAC,CAAiC,KAC/D;EACR,MAAMC,QAAQ,GAAGd,WAAW,CAAC,CAAC;;EAE9B;EACA,MAAMe,YAAY,GAAGjB,OAAO,CAAC,MAAM,IAAIW,IAAI,CAACG,GAAG,CAAC,EAAE,CAACA,GAAG,CAAC,CAAC;EACxD,MAAMI,UAAU,GAAGlB,OAAO,CAAC,MAAMiB,YAAY,CAACE,QAAQ,CAAC,CAAC,EAAE,CAACF,YAAY,CAAC,CAAC;EACzE,MAAMG,kBAAkB,GAAGH,YAAY,CAACI,WAAW;;EAEnD;EACA,MAAMC,YAAY,GAAGrB,MAAM,CAACmB,kBAAkB,CAAC;;EAE/C;EACA,MAAMG,GAAG,GAAGb,eAAe,CAACG,QAAQ,EAAEK,UAAU,CAAC;;EAEjD;EACA,MAAMM,KAAK,GAAGrB,WAAW,CAAEsB,KAAK,IAAKA,KAAK,CAACC,SAAS,CAACH,GAAG,CAAC,CAAC;;EAE1D;AACF;AACA;AACA;EACE,MAAMI,cAAc,GAAG3B,OAAO,CAAC,MAAM;IACnC,MAAM4B,MAAM,GAAG;MACbC,MAAM,EAAExB,YAAY,CAACyB,GAAG;MACxBC,eAAe,EAAE,IAAI;MACrB,GAAGhB;IACL,CAAC;IAED,IAAID,GAAG,YAAYH,IAAI,EAAE;MACvBiB,MAAM,CAACI,MAAM,GAAGJ,MAAM,CAACI,MAAM,IAAIlB,GAAG,CAACkB,MAAM;MAC3CJ,MAAM,CAACK,WAAW,GAAGL,MAAM,CAACK,WAAW,IAAInB,GAAG,CAACmB,WAAW;IAC5D;IACA,OAAOL,MAAM;EACf,CAAC,EAAE,CAACb,OAAO,EAAED,GAAG,CAAC,CAAC;EAElB,MAAMoB,QAAQ,GAAG9B,WAAW,CAAC,CAAC;EAC9B,MAAM+B,gBAAgB,GAAGD,QAAQ,CAACT,KAAK,EAAEU,gBAAgB;;EAEzD;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAMC,UAAU,GACdZ,KAAK,IAAI,IAAI,IACbA,KAAK,CAACa,MAAM,KAAK/B,gBAAgB,CAACgC,KAAK,IACvChB,YAAY,CAACiB,OAAO,KAAKnB,kBAAkB,KAC1Ce,gBAAgB,YAAYxB,IAAI,GAC7BwB,gBAAgB,CAACK,MAAM,CAACtB,UAAU,CAAC,GACnC,KAAK,CAAC,IACVS,cAAc,CAACc,QAAQ,KAAK,IAAI;;EAElC;EACA1C,SAAS,CAAC,MAAM;IACduB,YAAY,CAACiB,OAAO,GAAGnB,kBAAkB;EAC3C,CAAC,EAAE,CAACA,kBAAkB,CAAC,CAAC;;EAExB;EACA;EACAX,oBAAoB,CAAC,MAAM;IACzB,IAAIS,UAAU,KAAK,EAAE,IAAIkB,UAAU,EAAE;MACnCpB,QAAQ,CAACT,aAAa,CAACgB,GAAG,EAAEL,UAAU,EAAES,cAAc,CAAC,CAAC;IAC1D;EACF,CAAC,EAAE,CAACJ,GAAG,EAAEL,UAAU,EAAES,cAAc,EAAES,UAAU,CAAC,CAAC;;EAEjD;EACA;EACA;EACArC,SAAS,CAAC,MAAM;IACd,IAAI4B,cAAc,CAACI,eAAe,EAAE;MAClC,OAAO,MAAM;QACXf,QAAQ,CAACR,gBAAgB,CAACe,GAAG,CAAC,CAAC;MACjC,CAAC;IACH;EACF,CAAC,EAAE,CAACP,QAAQ,EAAEO,GAAG,EAAEI,cAAc,CAACI,eAAe,CAAC,CAAC;EAEnD,OAAOP,KAAK;AACd,CAAC","ignoreList":[]}

package/esm/hooks/useModularUIBasic.js

@@ -1,118 +0,0 @@
-import _includesInstanceProperty from "@babel/runtime-corejs3/core-js-stable/instance/includes";
-import { useLocation } from "react-router";
-import { useSelector } from "react-redux";
-import { useMemo } from "react";
-import { useModularUI } from "./useModularUI";
-import { HTTP_METHODS, MODULARUI_STATUS } from "../constants";
-import { useModularUIKey } from "./useModularUIKey";
-
-/**
- * Configuration options for low-level modular UI requests.
- */
-
-/**
- * Configuration options for the useModularUIBasic hook.
- * Allows for type enforcement, caching control, and reload behavior.
- */
-
-/**
- * Internal helper to transform high-level hook options into a configuration
- * object compatible with the core useModularUI fetcher.
- * Logic:
- * 1. Defaults to GET method.
- * 2. If 'formdata' is present, it switches to POST and assigns 'data'.
- * 3. Forces 'isReload' if the useReload check returns true.
- */
-const createUseModularUIOptions = (options, href, mustReload) => {
-  const baseOptions = {
-    expectedModels: [],
-    method: HTTP_METHODS.GET,
-    data: undefined,
-    ...options,
-    isReload: mustReload || options.isReload
-  };
-  if (options.formdata != null) {
-    baseOptions.method = HTTP_METHODS.POST;
-    baseOptions.data = options.formdata;
-  }
-  return baseOptions;
-};
-
-/**
- * Validates that the returned model type matches one of the expected model strings.
- * Logs a warning to the console if there is a mismatch (useful for debugging UI-backend contracts).
- */
-const validateModel = (model, expectedModels) => {
-  if (expectedModels.length > 0) {
-    const isCorrectModel = _includesInstanceProperty(expectedModels).call(expectedModels, model.type);
-    if (!isCorrectModel) {
-      console.warn(model, "is not of instance", expectedModels);
-    }
-  }
-};
-
-/**
- * A simplified abstraction over useModularUI that includes automatic
- * model validation and smart-reload logic based on router state.
- *
- * @param {string} defaultKey - The default identifier for the model.
- * @param {string | Href} href - The endpoint to fetch.
- * @param {UseModularUIBasicOptions} options - Extended configuration options.
- */
-export const useModularUIBasic = (defaultKey, href, options = {}) => {
-  const memoizedHref = useMemo(() => href.toString(), [href]);
-
-  // Use the key provided in options if available, otherwise fallback to the default
-  const key = options.key ?? defaultKey;
-
-  // Determine if we need to bypass cache based on navigation 'reload' signals
-  const mustReload = useReload(key, memoizedHref);
-
-  // Memoize options to prevent useModularUI from re-fetching on every parent render
-  const modularUIOptions = useMemo(() => createUseModularUIOptions(options, memoizedHref, mustReload), [options, memoizedHref, mustReload]);
-  const modularUI = useModularUI(key, href, modularUIOptions);
-  const expectedModels = useMemo(() => options.expectedModels ?? [], [options.expectedModels]);
-
-  // Extract and validate the model from the modularUI wrapper object
-  return useMemo(() => {
-    if (modularUI?.model) {
-      validateModel(modularUI.model, expectedModels);
-      return modularUI.model;
-    }
-    return null;
-  }, [expectedModels, modularUI]);
-};
-
-/**
- * Determines if a model should be reloaded based on the 'reload' timestamp
- * found in the React Router location state.
- * This is used for "force refresh" scenarios where a user navigates to a
- * page and expects fresh data (e.g., after a form submission elsewhere).
- * @param {string} modelKey - The model type key.
- * @param {string} url - The resource URL.
- * @returns {boolean} True if the store data is stale compared to the reload signal.
- */
-export const useReload = (modelKey, url) => {
-  const location = useLocation();
-  const key = useModularUIKey(modelKey, url);
-
-  // Access the current entry in the Redux store
-  const modelEntry = useSelector(state => state.modularui[key]);
-  if (modelEntry) {
-    const reload = location.state?.reload || 0;
-
-    // If a reload timestamp exists in the router state
-    if (reload > 0) {
-      const isFullyLoaded = modelEntry?.status === MODULARUI_STATUS.FINISHED;
-      const lastModification = modelEntry?.lastModification ?? 0;
-
-      // Trigger reload only if the model is already finished loading
-      // AND the data we have is older than the requested reload time.
-      if (isFullyLoaded && lastModification < reload) {
-        return true;
-      }
-    }
-  }
-  return false;
-};
-//# sourceMappingURL=useModularUIBasic.js.map