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

package/dist/hooks/index.d.cts

@@ -1,12 +1,13 @@
 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, ModelCatalogModel, ConceptIndexModel, ConceptDetailModel, ContentIndexModel, ContentTOCModel, ContentTypeModel, ModularUIModel, ApplicationModel, 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 { 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 * as lodash from 'lodash';
 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 { ModularUIRequestOptions } from '@beinformed/ui/utils';
+import { 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 'history';
 import 'redux';
 import 'immer';
@@ -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,9 +138,10 @@ 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;
@@ -156,18 +151,20 @@ declare const useLocale: () => string;
  */
 declare const useLocaleCodes: () => string[];
 
-type ModalHook = (modalId: string) => {
-    key: string | null;
-    size?: string | null;
-    visible: boolean;
-    show: () => void;
-    close: () => void;
-};
 /**
- * Manage modals
+ * 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.
  */
-declare const useModal: ModalHook;
-
 interface UseModularUIBasicOptions<T> {
     expectedModels?: string[];
     targetModel?: new (modularuiResponse: ModularUIResponse) => T;
@@ -175,11 +172,60 @@ interface UseModularUIBasicOptions<T> {
     origin?: string;
     contextPath?: string;
     cache?: boolean;
+    key?: string;
+    isReload?: boolean;
+    removeOnUnmount?: boolean;
+    formdata?: string | undefined | null;
 }
 /**
- * useModularUIBasic Hook
+ * 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;
+};
+
+type ModalHook = (modalId: string) => {
+    key: string | null;
+    size?: string | null;
+    visible: boolean;
+    show: () => void;
+    close: () => void;
+};
+/**
+ * Manage modals
  */
-declare const useModularUIBasic: <T>(key: string, href: string | Href, options?: UseModularUIBasicOptions<T>) => T | undefined;
+declare const useModal: ModalHook;
 
 interface SearchFilter {
     index?: string;
@@ -221,14 +267,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 +295,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;
 
 /**
@@ -289,36 +337,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 +403,4 @@ 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 };
+export { type HookOptions, type SearchFilter, type UseModularUIBasicOptions, useApplication, useCaseView, useCompleteSource, useConceptDetail, useConceptIndex, useConceptSearch, useContent, useContentFromSourceReferences, useContentIndex, useContentSearch, useContentTOC, useContentType, useDeepCompareEffect, useDetailPanel, useEntryDate, useErrorNotification, useGroupingPanel, useList, useListDetail, useListNavigation, useListOrDetail, useLocale, useLocaleCodes, useLocation, useLocationKey, useLogin, useLogout, useMessage, useModal, useModelCatalog, useModels, useModularUI, useModularUIBasic, useModularUIKey, useModularUIRequest, useNavigation, useNotification, usePanel, usePathname, usePreference, useProgressIndicator, useProgressIndicatorState, useQuerystring, useRelatedConcepts, useReload, useRetrieveFormsOnModel, useTab, useTranslate, useUserProfile };

package/dist/hooks/index.d.ts

@@ -1,12 +1,13 @@
 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, ModelCatalogModel, ConceptIndexModel, ConceptDetailModel, ContentIndexModel, ContentTOCModel, ContentTypeModel, ModularUIModel, ApplicationModel, 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-DW-a5mcV.js';
+import { EffectCallback, DependencyList } from 'react';
+export { U as UpdateFormOptions, b as useAttributeUpdate, u as useForm, a as useFormNavigation, c as useRepeatableAttributeSet } from '../useForm-DqaU9T78.js';
 import * as lodash from 'lodash';
 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.js';
 import { ModularUIRequestOptions } from '@beinformed/ui/utils';
+import { 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.js';
 import 'history';
 import 'redux';
 import 'immer';
@@ -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,9 +138,10 @@ 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;
@@ -156,18 +151,20 @@ declare const useLocale: () => string;
  */
 declare const useLocaleCodes: () => string[];
 
-type ModalHook = (modalId: string) => {
-    key: string | null;
-    size?: string | null;
-    visible: boolean;
-    show: () => void;
-    close: () => void;
-};
 /**
- * Manage modals
+ * 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.
  */
-declare const useModal: ModalHook;
-
 interface UseModularUIBasicOptions<T> {
     expectedModels?: string[];
     targetModel?: new (modularuiResponse: ModularUIResponse) => T;
@@ -175,11 +172,60 @@ interface UseModularUIBasicOptions<T> {
     origin?: string;
     contextPath?: string;
     cache?: boolean;
+    key?: string;
+    isReload?: boolean;
+    removeOnUnmount?: boolean;
+    formdata?: string | undefined | null;
 }
 /**
- * useModularUIBasic Hook
+ * 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;
+};
+
+type ModalHook = (modalId: string) => {
+    key: string | null;
+    size?: string | null;
+    visible: boolean;
+    show: () => void;
+    close: () => void;
+};
+/**
+ * Manage modals
  */
-declare const useModularUIBasic: <T>(key: string, href: string | Href, options?: UseModularUIBasicOptions<T>) => T | undefined;
+declare const useModal: ModalHook;
 
 interface SearchFilter {
     index?: string;
@@ -221,14 +267,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 +295,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;
 
 /**
@@ -289,36 +337,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 +403,4 @@ 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 };
+export { type HookOptions, type SearchFilter, type UseModularUIBasicOptions, useApplication, useCaseView, useCompleteSource, useConceptDetail, useConceptIndex, useConceptSearch, useContent, useContentFromSourceReferences, useContentIndex, useContentSearch, useContentTOC, useContentType, useDeepCompareEffect, useDetailPanel, useEntryDate, useErrorNotification, useGroupingPanel, useList, useListDetail, useListNavigation, useListOrDetail, useLocale, useLocaleCodes, useLocation, useLocationKey, useLogin, useLogout, useMessage, useModal, useModelCatalog, useModels, useModularUI, useModularUIBasic, useModularUIKey, useModularUIRequest, useNavigation, useNotification, usePanel, usePathname, usePreference, useProgressIndicator, useProgressIndicatorState, useQuerystring, useRelatedConcepts, useReload, useRetrieveFormsOnModel, useTab, useTranslate, useUserProfile };

package/dist/hooks/index.js

@@ -1,2 +1,2 @@
-import{A as E,B as F,C as G,D as H,E as I,F as J,G as K,H as L,I as M,J as N,K as O,L as P,M as Q,N as R,O as S,P as T,Q as U,R as V,S as W,T as X,U as Y,a,b,c,d,e as i,f as j,g as k,h as l,i as m,j as n,k as o,l as p,m as q,n as r,o as s,p as t,q as u,r as v,s as w,t as x,u as y,v as z,w as A,x as B,y as C,z as D}from"../chunk-UZIZDEU6.js";import{a as e,b as f,c as g,d as h}from"../chunk-RKGGCIUD.js";import"../chunk-Z2Y3OPVI.js";import"../chunk-Y7ESITVO.js";import"../chunk-JYAETKRB.js";import"../chunk-YJNJVQFW.js";import"../chunk-A4USB53Q.js";import"../chunk-WBPDMDW4.js";import"../chunk-6KRECIRI.js";import"../chunk-FW4363Y4.js";export{K as useApplication,o as useAttributeUpdate,M as useCaseView,D as useCompleteSource,z as useConceptDetail,y as useConceptIndex,G as useConceptSearch,C as useContent,j as useContentFromSourceReferences,A as useContentIndex,H as useContentSearch,B as useContentTOC,E as useContentType,k as useDeepCompareEffect,S as useDetailPanel,I as useEntryDate,X as useErrorNotification,m as useForm,n as useFormNavigation,R as useGroupingPanel,O as useList,Q as useListDetail,P as useListOrDetail,g as useLocale,h as useLocaleCodes,r as useLocation,s as useLocationKey,c as useLogin,d as useLogout,e as useMessage,q as useModal,x as useModelCatalog,J as useModels,l as useModularUI,w as useModularUIBasic,a as useModularUIRequest,v as useNavigation,W as useNotification,N as usePanel,u as usePathname,Y as usePreference,i as useProgressIndicator,t as useQuerystring,T as useQuicksearch,F as useRelatedConcepts,p as useRepeatableAttributeSet,b as useRetrieveFormsOnModel,U as useSearch,L as useTab,f as useTranslate,V as useUserProfile};
+import{A as E,B as F,C as G,D as H,E as I,F as J,G as K,H as L,I as M,J as N,K as O,L as P,M as Q,N as R,O as S,P as T,Q as U,R as V,S as W,T as X,U as Y,V as Z,W as _,a,b,c,d,e,f,g,h,i as m,j as n,k as o,l as p,m as q,n as r,o as s,p as t,q as u,r as v,s as w,t as x,u as y,v as z,w as A,x as B,y as C,z as D}from"../chunk-LUXTQYD2.js";import{a as i,b as j,c as k,d as l}from"../chunk-5MOCT43G.js";import"../chunk-ZNJONDQ6.js";import"../chunk-GHKA2XFO.js";import"../chunk-JYAETKRB.js";import"../chunk-7JMMW2FM.js";import"../chunk-TDYPCNQI.js";import"../chunk-L7DO7AZT.js";import"../chunk-HTR32BUX.js";import"../chunk-FW4363Y4.js";export{q as useApplication,D as useAttributeUpdate,s as useCaseView,Q as useCompleteSource,M as useConceptDetail,L as useConceptIndex,T as useConceptSearch,P as useContent,A as useContentFromSourceReferences,N as useContentIndex,U as useContentSearch,O as useContentTOC,R as useContentType,h as useDeepCompareEffect,u as useDetailPanel,V as useEntryDate,Y as useErrorNotification,B as useForm,C as useFormNavigation,t as useGroupingPanel,F as useList,H as useListDetail,I as useListNavigation,G as useListOrDetail,k as useLocale,l as useLocaleCodes,c as useLocation,d as useLocationKey,w as useLogin,x as useLogout,i as useMessage,J as useModal,K as useModelCatalog,W as useModels,n as useModularUI,o as useModularUIBasic,m as useModularUIKey,a as useModularUIRequest,g as useNavigation,X as useNotification,Z as usePanel,f as usePathname,_ as usePreference,y as useProgressIndicator,z as useProgressIndicatorState,e as useQuerystring,S as useRelatedConcepts,p as useReload,E as useRepeatableAttributeSet,b as useRetrieveFormsOnModel,r as useTab,j as useTranslate,v as useUserProfile};
 //# sourceMappingURL=index.js.map