@beinformed/react 1.0.0-beta.0 → 1.0.0-beta.2

package/dist/hooks/index.d.cts

@@ -1,11 +1,12 @@
 import * as _beinformed_ui_models from '@beinformed/ui/models';
-import { ListModel, DetailModel, TabModel, SourceReferenceCollection, ContentModel, Href, ModelCatalogModel, ConceptIndexModel, ConceptDetailModel, ContentIndexModel, ContentTOCModel, ContentTypeModel, ModularUIModel, ApplicationModel, CaseViewModel, GroupingPanelModel, ListDetailModel, CaseSearchModel, UserProfileModel, ErrorResponse } from '@beinformed/ui/models';
+import { ListModel, DetailModel, TabModel, SourceReferenceCollection, ContentModel, Href, ListDetailModel, FilterCollection, IFilter, AttributeModel, LinkModel, LookupOptionsModel, ModelCatalogModel, ConceptIndexModel, ConceptDetailModel, ContentIndexModel, ContentTOCModel, ContentTypeModel, ResourceModel, ApplicationModel, ModularUIModel, CaseViewModel, GroupingPanelModel, UserProfileModel, ErrorResponse, CaseSearchModel } from '@beinformed/ui/models';
 import * as _reduxjs_toolkit from '@reduxjs/toolkit';
 import { AuthenticationType, ModularUIResponse, ModularUIRequest } from '@beinformed/ui/modularui';
-export { U as UpdateFormOptions, b as useAttributeUpdate, u as useForm, a as useFormNavigation, c as useRepeatableAttributeSet } from '../useForm-CG_DMYfZ.cjs';
-import * as lodash from 'lodash';
+import { EffectCallback, DependencyList } from 'react';
+export { U as UpdateFormOptions, b as useAttributeUpdate, u as useForm, a as useFormNavigation, c as useRepeatableAttributeSet } from '../useForm-BWwXFuv5.cjs';
 import { MessageParameters, ISO_DATE } from '@beinformed/ui/types';
-import { B as ModelEntry, M as MessageObject, S as ShowNotificationArguments, P as PreferencesState, V as RouterLocation, $ as RootState } from '../styled-components.d-CrkOxzv5.cjs';
+import { b as Locales, B as ModelEntry, M as MessageObject, S as ShowNotificationArguments, P as PreferencesState, T as ProgressIndicatorState, V as RouterLocation, $ as RootState } from '../styled-components.d-C19eFejP.cjs';
+import * as lodash from 'lodash';
 import { ModularUIRequestOptions } from '@beinformed/ui/utils';
 import 'history';
 import 'redux';
@@ -25,15 +26,11 @@ declare const useLogin: () => {
      * Indicates whether the user is currently authenticated.
      */
     isAuthenticated: boolean;
+    primaryAuthenticationType: {} | undefined;
     /**
      * An array of available authentication types supported by the application.
-     * Defaults to an array containing the `DEFAULT_AUTHENTICATION_TYPE` if no types are available in the application state.
      */
-    authenticationTypes: {
-        name: string;
-        authentication: string;
-        isPrimary: boolean;
-    }[];
+    authenticationTypes: AuthenticationType[];
     /**
      * The current authentication error message, if any.
      */
@@ -101,15 +98,11 @@ declare const useLogout: () => {
      * Indicates whether the user is currently authenticated.
      */
     isAuthenticated: boolean;
+    primaryAuthenticationType: {} | undefined;
     /**
      * An array of available authentication types supported by the application.
-     * Defaults to an array containing the `DEFAULT_AUTHENTICATION_TYPE` if no types are available in the application state.
      */
-    authenticationTypes: {
-        name: string;
-        authentication: string;
-        isPrimary: boolean;
-    }[];
+    authenticationTypes: AuthenticationType[];
     /**
      * Initiates the logout process.
      * If a redirect login was in progress, it redirects the user to the server's logout endpoint with a return URL to the current origin.
@@ -137,6 +130,7 @@ declare const useLogout: () => {
         arg: void;
         unwrap: () => Promise<void>;
     }) | undefined;
+    logoutUrl: string;
 };
 
 /**
@@ -144,30 +138,40 @@ declare const useLogout: () => {
  */
 declare const useContentFromSourceReferences: (sourceReferences: SourceReferenceCollection, renderChildSections: boolean) => ContentModel[];
 
-type Callback = () => void | (() => void);
-type DependencyList = unknown[];
-declare function useDeepCompareEffect(callback: Callback, dependencies: DependencyList): void;
+/**
+ * A replacement for useEffect that compares dependencies deeply.
+ */
+declare function useDeepCompareEffect(callback: EffectCallback, dependencies: DependencyList): void;
 
 declare const useMessage: (id: string, defaultMessage?: string, placeholders?: MessageParameters | undefined) => string;
 declare const useTranslate: () => ((id: string, defaultMessage?: string, placeholders?: MessageParameters | undefined) => string) & lodash.MemoizedFunction;
 declare const useLocale: () => string;
+declare const useLocales: () => Locales;
 /**
  * Retrieve all available locale codes
  */
 declare const useLocaleCodes: () => string[];
-
-type ModalHook = (modalId: string) => {
-    key: string | null;
-    size?: string | null;
-    visible: boolean;
-    show: () => void;
-    close: () => void;
-};
 /**
- * Manage modals
+ * A hook that returns a memoized function to update the application locale.
+ *
+ * @returns {(locale: string) => void} A memoized function to update the locale.
  */
-declare const useModal: ModalHook;
+declare const useUpdateLocale: () => (locale: string) => void;
 
+/**
+ * Configuration options for low-level modular UI requests.
+ */
+interface HookOptions {
+    key?: string;
+    origin?: string;
+    contextPath?: string;
+    removeOnUnmount?: boolean;
+    formdata?: string | undefined | null;
+}
+/**
+ * Configuration options for the useModularUIBasic hook.
+ * Allows for type enforcement, caching control, and reload behavior.
+ */
 interface UseModularUIBasicOptions<T> {
     expectedModels?: string[];
     targetModel?: new (modularuiResponse: ModularUIResponse) => T;
@@ -175,11 +179,69 @@ interface UseModularUIBasicOptions<T> {
     origin?: string;
     contextPath?: string;
     cache?: boolean;
+    key?: string;
+    isReload?: boolean;
+    removeOnUnmount?: boolean;
+    formdata?: string | undefined | null;
+}
+/**
+ * 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.
+ */
+declare const useModularUIBasic: <T>(defaultKey: string, href: string | Href, options?: UseModularUIBasicOptions<T>) => T | undefined;
+/**
+ * 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.
+ */
+declare const useReload: (modelKey: string, url: string) => boolean;
+
+interface ListNavigationOptions {
+    syncLocation?: boolean;
+    historyAction?: "push" | "replace";
 }
+declare const useList: (href: string | Href, options?: HookOptions) => ListModel | undefined;
+declare const useListOrDetail: (href: string | Href, options?: HookOptions) => ListModel | DetailModel<_beinformed_ui_models.DetailData, _beinformed_ui_models.DetailPanelContributions> | undefined;
+declare const useListDetail: (href: string | Href, options?: HookOptions) => ListDetailModel | undefined;
+declare const useListNavigation: ({ syncLocation, historyAction, }?: ListNavigationOptions) => {
+    update: (list: ListModel, resetPage?: boolean) => void;
+    updateFilters: (list: ListModel, filters: FilterCollection | IFilter[]) => void;
+    updateFilter: (list: ListModel, filter: IFilter, value: string, attribute?: AttributeModel) => void;
+    updateSort: (list: ListModel, sortOption: string) => void;
+    updatePage: (list: ListModel, page: number) => void;
+    updatePageSize: (list: ListModel, pagesize: number) => void;
+    resetFilters: (list: ListModel) => void;
+    removeFilter: (list: ListModel, filter: IFilter) => void;
+};
+
+interface UseLookupHook {
+    lookupOptions: LookupOptionsModel | null;
+    lookupLoading: boolean;
+}
+/**
+ * Lookup options call
+ */
+declare const useLookup: (lookupLink: LinkModel, filterInput?: string, minLength?: number, debounceMs?: number) => UseLookupHook;
+
+type ModalHook = (modalId: string) => {
+    key: string | null;
+    size?: string | null;
+    visible: boolean;
+    show: () => void;
+    close: () => void;
+};
 /**
- * useModularUIBasic Hook
+ * Manage modals
  */
-declare const useModularUIBasic: <T>(key: string, href: string | Href, options?: UseModularUIBasicOptions<T>) => T | undefined;
+declare const useModal: ModalHook;
 
 interface SearchFilter {
     index?: string;
@@ -210,6 +272,61 @@ declare const useEntryDate: () => {
     };
 };
 
+/**
+ * Returns all models in the store that are instances of the provided class
+ * and match the current application locale.
+ */
+declare const useAllModelsByInstance: <T extends new (...args: never[]) => ResourceModel>(instance: T) => InstanceType<T>[];
+/**
+ * Returns the first model found in the store that is an instance of the
+ * provided class and matches the current locale.
+ */
+declare const useFirstModelByInstance: <T extends new (...args: never[]) => ResourceModel>(instance: T) => InstanceType<T> | undefined;
+/**
+ * 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.
+ */
+declare const useActiveModelByInstance: <T extends new (...args: never[]) => ResourceModel>(instance: T) => InstanceType<T> | undefined;
+/**
+ * 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.
+ */
+declare const useModelByHref: (href: Href | string) => _beinformed_ui_models.ModularUIModel | undefined;
+/**
+ * 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.
+ */
+declare const useKeyByHref: (href: Href | string) => string | undefined;
+/**
+ * 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.
+ */
+declare const useAllKeysByHref: (href: Href | string) => string[];
+/**
+ * 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}>}
+ */
+declare const useActiveModels: () => {
+    key: string;
+    href: Href | undefined;
+    label: string;
+    type: string;
+}[];
+/**
+ * Returns all models in the store that have a status of MODULARUI_STATUS.FINISHED.
+ * @returns {Array<ModularUIModel>} An array of fully loaded models.
+ */
+declare const useAllFinishedModels: () => (_beinformed_ui_models.ModularUIModel | undefined)[];
+/**
+ * Returns the current active application, without retrying to request it.
+ */
+declare const useCurrentApplication: () => ApplicationModel | null;
+
 type ReloadCallback = (model: ModularUIModel | undefined) => boolean;
 type UseModels = () => {
     reload: (model: ModularUIModel, options?: Record<string, unknown>) => void;
@@ -221,14 +338,22 @@ type UseModels = () => {
 declare const useModels: UseModels;
 
 /**
- * Use redux action and selector to retrieve the correct modular ui service model
+ * 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.
  */
-declare const useModularUI: (modelKey: string, url: string | Href, options?: ModularUIRequestOptions) => ModelEntry;
+declare const useModularUI: (modelKey: string, url: string | Href, options?: ModularUIRequestOptions) => ModelEntry | undefined;
+
+/**
+ * Generates the key that is used in the modular ui reducer of redux
+ */
+declare const useModularUIKey: (modelKey: string, url: string) => string;
 
-interface HookOptions {
-    origin?: string;
-    contextPath?: string;
-}
 /**
  * Load application
  */
@@ -241,14 +366,8 @@ declare const useTab: (href: string | Href, options?: HookOptions) => TabModel |
  * Load caseview by href
  */
 declare const useCaseView: (href: string | Href, options?: HookOptions) => CaseViewModel | undefined;
-declare const usePanel: (href: string | Href, options?: HookOptions) => ListModel | GroupingPanelModel | DetailModel<_beinformed_ui_models.DetailData, _beinformed_ui_models.DetailPanelContributions> | undefined;
-declare const useList: (href: string | Href, options?: HookOptions) => ListModel | undefined;
-declare const useListOrDetail: (href: string | Href, options?: HookOptions) => ListModel | DetailModel<_beinformed_ui_models.DetailData, _beinformed_ui_models.DetailPanelContributions> | undefined;
-declare const useListDetail: (href: string | Href, options?: HookOptions) => ListDetailModel | undefined;
 declare const useGroupingPanel: (href: string | Href, options?: HookOptions) => GroupingPanelModel | undefined;
 declare const useDetailPanel: (href: string | Href, options?: HookOptions) => DetailModel<_beinformed_ui_models.DetailData, _beinformed_ui_models.DetailPanelContributions> | undefined;
-declare const useQuicksearch: (href: string | Href, options?: HookOptions) => CaseSearchModel | undefined;
-declare const useSearch: (href: string | Href, options?: HookOptions) => CaseSearchModel | undefined;
 declare const useUserProfile: (href: string | Href, options?: HookOptions) => UserProfileModel | undefined;
 
 /**
@@ -261,10 +380,7 @@ declare const useNotification: () => {
     messageType: string | undefined;
     message: MessageObject | undefined;
     error: ErrorResponse | undefined;
-    dismiss: () => {
-        payload: undefined;
-        type: "DISMISS_NOTIFICATION";
-    };
+    dismiss: () => void;
 };
 declare const useErrorNotification: () => (message: MessageObject, error?: ErrorResponse) => Promise<_reduxjs_toolkit.PayloadAction<void, string, {
     arg: ShowNotificationArguments;
@@ -289,36 +405,41 @@ declare const useErrorNotification: () => (message: MessageObject, error?: Error
     unwrap: () => Promise<void>;
 };
 
+declare const usePanel: (href?: string | Href, options?: HookOptions & {
+    fromRoute?: boolean;
+}) => ListModel | GroupingPanelModel | DetailModel | CaseSearchModel | undefined;
+
 declare const usePreference: (preferenceNames: string | string[]) => Pick<PreferencesState, string>;
 
 declare const useProgressIndicator: () => {
-    start: () => {
-        payload: undefined;
-        type: "START_PROGRESS";
-    };
-    finish: () => {
-        payload: undefined;
-        type: "FINISH_PROGRESS";
-    };
-    reset: () => {
-        payload: undefined;
-        type: "RESET_PROGRESS";
-    };
-    update: (percentComplete: number) => {
-        payload: {
-            percentComplete: number;
-        };
-        type: "UPDATE_PROGRESS";
-    };
-    count: number;
-    timestamp: number;
-    percentComplete: number;
+    start: () => void;
+    finish: () => void;
+    reset: () => void;
+    update: (percentComplete: number) => void;
 };
+/**
+ */
+declare const useProgressIndicatorState: () => ProgressIndicatorState;
 
+/**
+ * Returns the full location object from the router state.
+ */
 declare const useLocation: () => RouterLocation | undefined;
+/**
+ * Returns the unique key of the current location.
+ */
 declare const useLocationKey: () => string;
+/**
+ * Returns the current search (querystring) portion of the URL.
+ */
 declare const useQuerystring: () => string | undefined;
+/**
+ * Returns the current URL pathname.
+ */
 declare const usePathname: () => string | undefined;
+/**
+ * Provides navigation methods.
+ */
 declare const useNavigation: () => {
     push: (location: RouterLocation | string, state?: RootState) => {
         payload: {
@@ -350,4 +471,7 @@ declare const useNavigation: () => {
     };
 };
 
-export { type SearchFilter, type UseModularUIBasicOptions, useApplication, useCaseView, useCompleteSource, useConceptDetail, useConceptIndex, useConceptSearch, useContent, useContentFromSourceReferences, useContentIndex, useContentSearch, useContentTOC, useContentType, useDeepCompareEffect, useDetailPanel, useEntryDate, useErrorNotification, useGroupingPanel, useList, useListDetail, useListOrDetail, useLocale, useLocaleCodes, useLocation, useLocationKey, useLogin, useLogout, useMessage, useModal, useModelCatalog, useModels, useModularUI, useModularUIBasic, useModularUIRequest, useNavigation, useNotification, usePanel, usePathname, usePreference, useProgressIndicator, useQuerystring, useQuicksearch, useRelatedConcepts, useRetrieveFormsOnModel, useSearch, useTab, useTranslate, useUserProfile };
+declare const useQuicksearch: (href: string | Href, options?: HookOptions) => CaseSearchModel | undefined;
+declare const useSearch: (href: string | Href, options?: HookOptions) => CaseSearchModel | undefined;
+
+export { type HookOptions, type SearchFilter, type UseModularUIBasicOptions, useActiveModelByInstance, useActiveModels, useAllFinishedModels, useAllKeysByHref, useAllModelsByInstance, useApplication, useCaseView, useCompleteSource, useConceptDetail, useConceptIndex, useConceptSearch, useContent, useContentFromSourceReferences, useContentIndex, useContentSearch, useContentTOC, useContentType, useCurrentApplication, useDeepCompareEffect, useDetailPanel, useEntryDate, useErrorNotification, useFirstModelByInstance, useGroupingPanel, useKeyByHref, useList, useListDetail, useListNavigation, useListOrDetail, useLocale, useLocaleCodes, useLocales, useLocation, useLocationKey, useLogin, useLogout, useLookup, useMessage, useModal, useModelByHref, useModelCatalog, useModels, useModularUI, useModularUIBasic, useModularUIKey, useModularUIRequest, useNavigation, useNotification, usePanel, usePathname, usePreference, useProgressIndicator, useProgressIndicatorState, useQuerystring, useQuicksearch, useRelatedConcepts, useReload, useRetrieveFormsOnModel, useSearch, useTab, useTranslate, useUpdateLocale, useUserProfile };