@beinformed/react 1.0.0-beta.0

package/dist/hooks/index.d.cts

@@ -0,0 +1,353 @@
+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 * 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 { 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 'history';
+import 'redux';
+import 'immer';
+import '@beinformed/ui/settings';
+import 'styled-components';
+
+declare const useRetrieveFormsOnModel: (model: ListModel | DetailModel | TabModel) => null;
+
+/**
+ * Provides access to authentication state and actions.
+ * Includes functionality for standard username/password login and redirect-based login.
+ * @returns An object containing authentication status, available authentication types, error messages, and login/logout functions.
+ */
+declare const useLogin: () => {
+    /**
+     * Indicates whether the user is currently authenticated.
+     */
+    isAuthenticated: boolean;
+    /**
+     * 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;
+    }[];
+    /**
+     * The current authentication error message, if any.
+     */
+    errorMessage: string | null;
+    /**
+     * Resets the authentication error message in the Redux store.
+     */
+    resetErrors: () => {
+        payload: undefined;
+        type: "AUTHENTICATION_RESET_ERRORS";
+    };
+    /**
+     * Attempts to log in the user with the provided username and password.
+     * Dispatches the `login` action to the Redux store.
+     * @param username The username for authentication.
+     * @param password The password for authentication.
+     */
+    login: (username: string, password: string) => Promise<_reduxjs_toolkit.PayloadAction<void, string, {
+        arg: {
+            username: string;
+            password: string;
+        };
+        requestId: string;
+        requestStatus: "fulfilled";
+    }, never> | _reduxjs_toolkit.PayloadAction<unknown, string, {
+        arg: {
+            username: string;
+            password: string;
+        };
+        requestId: string;
+        requestStatus: "rejected";
+        aborted: boolean;
+        condition: boolean;
+    } & ({
+        rejectedWithValue: true;
+    } | ({
+        rejectedWithValue: false;
+    } & {})), _reduxjs_toolkit.SerializedError>> & {
+        __linterBrands: "SafePromise";
+    } & {
+        abort: (reason?: string) => void;
+        requestId: string;
+        arg: {
+            username: string;
+            password: string;
+        };
+        unwrap: () => Promise<void>;
+    };
+    /**
+     * Initiates a redirect-based login flow for a specific authentication type.
+     * If a redirect login is already in progress, it throws an `IllegalStateException` to prevent infinite loops.
+     * If the user is not currently authenticated, it sets a flag in the cache and redirects the browser to the authentication provider's redirect URI.
+     * @param authenticationType The authentication type to initiate the redirect for.
+     * @throws {IllegalStateException} If a redirect login is already in progress for a different authentication type.
+     */
+    redirectLogin: (authenticationType: AuthenticationType) => void;
+};
+/**
+ * Provides access to logout functionality.
+ * Handles both standard logout and redirect-based logout scenarios.
+ * @returns An object containing the authentication status, available authentication types, and the logout function.
+ */
+declare const useLogout: () => {
+    /**
+     * Indicates whether the user is currently authenticated.
+     */
+    isAuthenticated: boolean;
+    /**
+     * 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;
+    }[];
+    /**
+     * 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.
+     * Otherwise, it dispatches the `logout` action to the Redux store.
+     */
+    logout: () => (Promise<_reduxjs_toolkit.PayloadAction<void, string, {
+        arg: void;
+        requestId: string;
+        requestStatus: "fulfilled";
+    }, never> | _reduxjs_toolkit.PayloadAction<unknown, string, {
+        arg: void;
+        requestId: string;
+        requestStatus: "rejected";
+        aborted: boolean;
+        condition: boolean;
+    } & ({
+        rejectedWithValue: true;
+    } | ({
+        rejectedWithValue: false;
+    } & {})), _reduxjs_toolkit.SerializedError>> & {
+        __linterBrands: "SafePromise";
+    } & {
+        abort: (reason?: string) => void;
+        requestId: string;
+        arg: void;
+        unwrap: () => Promise<void>;
+    }) | undefined;
+};
+
+/**
+ * Hook to retrieve multiple source references at once
+ */
+declare const useContentFromSourceReferences: (sourceReferences: SourceReferenceCollection, renderChildSections: boolean) => ContentModel[];
+
+type Callback = () => void | (() => void);
+type DependencyList = unknown[];
+declare function useDeepCompareEffect(callback: Callback, 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;
+/**
+ * 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
+ */
+declare const useModal: ModalHook;
+
+interface UseModularUIBasicOptions<T> {
+    expectedModels?: string[];
+    targetModel?: new (modularuiResponse: ModularUIResponse) => T;
+    forceTargetModel?: boolean;
+    origin?: string;
+    contextPath?: string;
+    cache?: boolean;
+}
+/**
+ * useModularUIBasic Hook
+ */
+declare const useModularUIBasic: <T>(key: string, href: string | Href, options?: UseModularUIBasicOptions<T>) => T | undefined;
+
+interface SearchFilter {
+    index?: string;
+    label?: string;
+    type?: string | string[];
+    modelCategory?: string | string[];
+    entryDate?: string;
+}
+declare const useModelCatalog: (options?: UseModularUIBasicOptions<ModelCatalogModel>) => ModelCatalogModel | undefined;
+declare const useConceptIndex: (href: string | Href, key?: string, options?: UseModularUIBasicOptions<ConceptIndexModel>) => ConceptIndexModel | undefined;
+declare const useConceptDetail: (concept: string | Href, key?: string, options?: UseModularUIBasicOptions<ConceptDetailModel>) => ConceptDetailModel | undefined;
+declare const useContentIndex: (href: string | Href, key?: string, options?: UseModularUIBasicOptions<ContentIndexModel>) => ContentIndexModel | undefined;
+declare const useContentTOC: (content: string | Href, key?: string, options?: UseModularUIBasicOptions<ContentTOCModel>) => ContentTOCModel | undefined;
+declare const useContent: (content: string | Href, key?: string, options?: UseModularUIBasicOptions<ContentModel>) => ContentModel | undefined;
+declare const useCompleteSource: (content: string | Href, key?: string, options?: UseModularUIBasicOptions<ContentModel | ContentTOCModel>) => ContentModel | ContentTOCModel | undefined;
+declare const useContentType: (contentType: string | Href, key?: string, options?: UseModularUIBasicOptions<ContentTypeModel>) => ContentTypeModel | undefined;
+declare const useRelatedConcepts: (href: string | Href, key?: string, options?: UseModularUIBasicOptions<ConceptIndexModel>) => ConceptIndexModel | undefined;
+declare const useConceptSearch: (filters: SearchFilter, key: string | "conceptSearch", options?: UseModularUIBasicOptions<ConceptIndexModel>) => ConceptIndexModel | undefined;
+declare const useContentSearch: (filters: SearchFilter, key: string | "contentSearch", options?: UseModularUIBasicOptions<ContentIndexModel>) => ContentIndexModel | undefined;
+/**
+ * Retrieve and update the entrydate for the modelcatalog
+ */
+declare const useEntryDate: () => {
+    entryDate: string;
+    setEntryDate: (entryDate: ISO_DATE) => {
+        payload: string;
+        type: "UPDATE_ENTRYDATE";
+    };
+};
+
+type ReloadCallback = (model: ModularUIModel | undefined) => boolean;
+type UseModels = () => {
+    reload: (model: ModularUIModel, options?: Record<string, unknown>) => void;
+    reloadWithFilter: (callbackFn: ReloadCallback, options?: Record<string, unknown>) => void;
+};
+/**
+ * Hook that contains the reload property that can be used to reload a model
+ */
+declare const useModels: UseModels;
+
+/**
+ * Use redux action and selector to retrieve the correct modular ui service model
+ */
+declare const useModularUI: (modelKey: string, url: string | Href, options?: ModularUIRequestOptions) => ModelEntry;
+
+interface HookOptions {
+    origin?: string;
+    contextPath?: string;
+}
+/**
+ * Load application
+ */
+declare const useApplication: (options?: HookOptions) => ApplicationModel | undefined;
+/**
+ * Load a tab by href
+ */
+declare const useTab: (href: string | Href, options?: HookOptions) => TabModel | undefined;
+/**
+ * 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;
+
+/**
+ * Creates a ModularUIRequest with the locale as available in the redux store
+ */
+declare const useModularUIRequest: () => ((href: Href, options?: ModularUIRequestOptions) => ModularUIRequest);
+
+declare const useNotification: () => {
+    render: boolean;
+    messageType: string | undefined;
+    message: MessageObject | undefined;
+    error: ErrorResponse | undefined;
+    dismiss: () => {
+        payload: undefined;
+        type: "DISMISS_NOTIFICATION";
+    };
+};
+declare const useErrorNotification: () => (message: MessageObject, error?: ErrorResponse) => Promise<_reduxjs_toolkit.PayloadAction<void, string, {
+    arg: ShowNotificationArguments;
+    requestId: string;
+    requestStatus: "fulfilled";
+}, never> | _reduxjs_toolkit.PayloadAction<unknown, string, {
+    arg: ShowNotificationArguments;
+    requestId: string;
+    requestStatus: "rejected";
+    aborted: boolean;
+    condition: boolean;
+} & ({
+    rejectedWithValue: true;
+} | ({
+    rejectedWithValue: false;
+} & {})), _reduxjs_toolkit.SerializedError>> & {
+    __linterBrands: "SafePromise";
+} & {
+    abort: (reason?: string) => void;
+    requestId: string;
+    arg: ShowNotificationArguments;
+    unwrap: () => Promise<void>;
+};
+
+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;
+};
+
+declare const useLocation: () => RouterLocation | undefined;
+declare const useLocationKey: () => string;
+declare const useQuerystring: () => string | undefined;
+declare const usePathname: () => string | undefined;
+declare const useNavigation: () => {
+    push: (location: RouterLocation | string, state?: RootState) => {
+        payload: {
+            location: string | RouterLocation;
+            state: unknown;
+        };
+        type: "ROUTER/PUSH";
+    };
+    replace: (location: RouterLocation | string, state?: RootState) => {
+        payload: {
+            location: string | RouterLocation;
+            state: unknown;
+        };
+        type: "ROUTER/REPLACE";
+    };
+    go: (delta: number) => {
+        payload: {
+            delta: number;
+        };
+        type: "ROUTER/GO";
+    };
+    goBack: () => {
+        payload: undefined;
+        type: "ROUTER/GOBACK";
+    };
+    goForward: () => {
+        payload: undefined;
+        type: "ROUTER/GOFORWARD";
+    };
+};
+
+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 };