@elliemae/pui-app-sdk 5.44.2 → 5.45.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/pui-app-sdk",
-  "version": "5.44.2",
+  "version": "5.45.0",
   "description": "ICE MT UI Platform Application SDK ",
   "sideEffects": [
     "*.css",

package/build/docs/assets/js/822e0178.dfd661b8.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[4082],{3227(e){e.exports=JSON.parse('{"version":{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"docsSidebar":[{"type":"category","label":"App SDK API","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"classes","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/app-sdk/api/classes/Analytics","label":"Analytics","docId":"api/classes/Analytics","unlisted":false},{"type":"link","href":"/app-sdk/api/classes/CMicroAppGuest","label":"CMicroAppGuest\\\\<AppObjects, AppEvents\\\\>","docId":"api/classes/CMicroAppGuest","unlisted":false},{"type":"link","href":"/app-sdk/api/classes/CMicroAppHost","label":"~~CMicroAppHost\\\\<AppObjects, AppEvents\\\\>~~","docId":"api/classes/CMicroAppHost","unlisted":false},{"type":"link","href":"/app-sdk/api/classes/ErrorBoundary","label":"ErrorBoundary","docId":"api/classes/ErrorBoundary","unlisted":false},{"type":"link","href":"/app-sdk/api/classes/GuestModule","label":"GuestModule","docId":"api/classes/GuestModule","unlisted":false}]},{"type":"category","label":"functions","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/app-sdk/api/functions/AppRoot","label":"AppRoot()","docId":"api/functions/AppRoot","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/Autocomplete","label":"Autocomplete()","docId":"api/functions/Autocomplete","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/CheckBox","label":"CheckBox()","docId":"api/functions/CheckBox","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/ComboBox","label":"ComboBox()","docId":"api/functions/ComboBox","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/ComboBoxV3","label":"ComboBoxV3()","docId":"api/functions/ComboBoxV3","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/ConnectForm","label":"ConnectForm()","docId":"api/functions/ConnectForm","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/DateInput","label":"DateInput()","docId":"api/functions/DateInput","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/DatePicker","label":"DatePicker()","docId":"api/functions/DatePicker","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/DateRangePicker","label":"DateRangePicker()","docId":"api/functions/DateRangePicker","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/DateTimePicker","label":"DateTimePicker()","docId":"api/functions/DateTimePicker","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/Form","label":"Form()","docId":"api/functions/Form","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/FormItemLayout","label":"FormItemLayout()","docId":"api/functions/FormItemLayout","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/FormLayoutBlockItem","label":"FormLayoutBlockItem()","docId":"api/functions/FormLayoutBlockItem","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/FormSubmitButton","label":"FormSubmitButton()","docId":"api/functions/FormSubmitButton","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/InputMask","label":"InputMask()","docId":"api/functions/InputMask","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/InputText","label":"InputText()","docId":"api/functions/InputText","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/LargeTextBox","label":"LargeTextBox()","docId":"api/functions/LargeTextBox","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/MaskedInputText","label":"MaskedInputText()","docId":"api/functions/MaskedInputText","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/Page","label":"Page()","docId":"api/functions/Page","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/Radio","label":"Radio()","docId":"api/functions/Radio","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/RadioGroup","label":"RadioGroup()","docId":"api/functions/RadioGroup","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/RegisterService","label":"RegisterService()","docId":"api/functions/RegisterService","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/RenderWithStateAddOns","label":"RenderWithStateAddOns()","docId":"api/functions/RenderWithStateAddOns","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/RequireAuth","label":"RequireAuth()","docId":"api/functions/RequireAuth","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/SessionTimeout","label":"SessionTimeout()","docId":"api/functions/SessionTimeout","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/TextBox","label":"TextBox()","docId":"api/functions/TextBox","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/Toggle","label":"Toggle()","docId":"api/functions/Toggle","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/authSaga","label":"authSaga()","docId":"api/functions/authSaga","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/authorize","label":"authorize()","docId":"api/functions/authorize","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/buildModuleParams","label":"buildModuleParams()","docId":"api/functions/buildModuleParams","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/cleanup","label":"cleanup()","docId":"api/functions/cleanup","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/configureStore","label":"configureStore()","docId":"api/functions/configureStore","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/createGuestModule","label":"createGuestModule()","docId":"api/functions/createGuestModule","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/createManager","label":"createManager()","docId":"api/functions/createManager","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/enableReactAppForHostIntegration","label":"enableReactAppForHostIntegration()","docId":"api/functions/enableReactAppForHostIntegration","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/fetchHostAppData","label":"fetchHostAppData()","docId":"api/functions/fetchHostAppData","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/fetchUserSettings","label":"fetchUserSettings()","docId":"api/functions/fetchUserSettings","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/getApiActionCreator","label":"getApiActionCreator()","docId":"api/functions/getApiActionCreator","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/getAppConfig","label":"getAppConfig()","docId":"api/functions/getAppConfig","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/getAppConfigValue","label":"getAppConfigValue()","docId":"api/functions/getAppConfigValue","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/getAuthHTTPClient","label":"getAuthHTTPClient()","docId":"api/functions/getAuthHTTPClient","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/getAuthorizationHeader","label":"getAuthorizationHeader()","docId":"api/functions/getAuthorizationHeader","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/getHTTPClient","label":"getHTTPClient()","docId":"api/functions/getHTTPClient","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/getHostAppDataByKey","label":"getHostAppDataByKey()","docId":"api/functions/getHostAppDataByKey","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/getLogger","label":"getLogger()","docId":"api/functions/getLogger","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/getMicroFrontEndAppConfig","label":"getMicroFrontEndAppConfig()","docId":"api/functions/getMicroFrontEndAppConfig","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/getNavigationLinks","label":"getNavigationLinks()","docId":"api/functions/getNavigationLinks","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/getRedirectUrl","label":"getRedirectUrl()","docId":"api/functions/getRedirectUrl","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/getSelectField","label":"getSelectField()","docId":"api/functions/getSelectField","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/getStore","label":"getStore()","docId":"api/functions/getStore","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/initServiceWorker","label":"initServiceWorker()","docId":"api/functions/initServiceWorker","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/isCIBuild","label":"isCIBuild()","docId":"api/functions/isCIBuild","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/isProd","label":"isProd()","docId":"api/functions/isProd","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/isUserAuthorized","label":"isUserAuthorized()","docId":"api/functions/isUserAuthorized","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/listenStorageEvents","label":"listenStorageEvents()","docId":"api/functions/listenStorageEvents","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/loadAppConfig","label":"loadAppConfig()","docId":"api/functions/loadAppConfig","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/loadable","label":"loadable()","docId":"api/functions/loadable","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/login","label":"login()","docId":"api/functions/login","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/notifyGuestUnloadComplete","label":"notifyGuestUnloadComplete()","docId":"api/functions/notifyGuestUnloadComplete","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/onAuthorizationFailure","label":"onAuthorizationFailure()","docId":"api/functions/onAuthorizationFailure","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/onGuestUnloadStart","label":"onGuestUnloadStart()","docId":"api/functions/onGuestUnloadStart","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/redactPii","label":"redactPii()","docId":"api/functions/redactPii","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/removeDoubleSlash","label":"removeDoubleSlash()","docId":"api/functions/removeDoubleSlash","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/removeStorageEvents","label":"removeStorageEvents()","docId":"api/functions/removeStorageEvents","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/render","label":"render()","docId":"api/functions/render","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/renderHook","label":"renderHook()","docId":"api/functions/renderHook","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/renderWithHostData","label":"renderWithHostData()","docId":"api/functions/renderWithHostData","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/renderWithRedux","label":"renderWithRedux()","docId":"api/functions/renderWithRedux","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/renderWithRouter","label":"renderWithRouter()","docId":"api/functions/renderWithRouter","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/renderWithRouterRedux","label":"renderWithRouterRedux()","docId":"api/functions/renderWithRouterRedux","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/sdkBaseQuery","label":"sdkBaseQuery()","docId":"api/functions/sdkBaseQuery","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/sendBAEvent","label":"~~sendBAEvent()~~","docId":"api/functions/sendBAEvent","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/sendMessageToHost","label":"sendMessageToHost()","docId":"api/functions/sendMessageToHost","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/setAppConfig","label":"setAppConfig()","docId":"api/functions/setAppConfig","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/setAppConfigValue","label":"setAppConfigValue()","docId":"api/functions/setAppConfigValue","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/setHostAppData","label":"setHostAppData()","docId":"api/functions/setHostAppData","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/setLoginParams","label":"setLoginParams()","docId":"api/functions/setLoginParams","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/subscribeToResetSession","label":"subscribeToResetSession()","docId":"api/functions/subscribeToResetSession","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/subscribeToSessionExpiry","label":"subscribeToSessionExpiry()","docId":"api/functions/subscribeToSessionExpiry","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/subscribeToSessionExpiryWarning","label":"subscribeToSessionExpiryWarning()","docId":"api/functions/subscribeToSessionExpiryWarning","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/trackActivity","label":"trackActivity()","docId":"api/functions/trackActivity","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/useAppDispatch","label":"useAppDispatch()","docId":"api/functions/useAppDispatch","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/useAppMiddleware","label":"useAppMiddleware()","docId":"api/functions/useAppMiddleware","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/useInjectQuery","label":"useInjectQuery()","docId":"api/functions/useInjectQuery","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/useInjectReducer","label":"useInjectReducer()","docId":"api/functions/useInjectReducer","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/useInjectSaga","label":"useInjectSaga()","docId":"api/functions/useInjectSaga","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/useInjectSideEffect","label":"useInjectSideEffect()","docId":"api/functions/useInjectSideEffect","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/useMediaQueryList","label":"useMediaQueryList()","docId":"api/functions/useMediaQueryList","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/useStateSelector","label":"useStateSelector()","docId":"api/functions/useStateSelector","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/useStateSelectorShallow","label":"useStateSelectorShallow()","docId":"api/functions/useStateSelectorShallow","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/waitFor","label":"waitFor()","docId":"api/functions/waitFor","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/waitForElementToBeRemoved","label":"waitForElementToBeRemoved()","docId":"api/functions/waitForElementToBeRemoved","unlisted":false},{"type":"link","href":"/app-sdk/api/functions/withAppDecorator","label":"withAppDecorator()","docId":"api/functions/withAppDecorator","unlisted":false}]},{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/app-sdk/api/interfaces/AppConfig","label":"AppConfig","docId":"api/interfaces/AppConfig","unlisted":false},{"type":"link","href":"/app-sdk/api/interfaces/GuestProps","label":"GuestProps\\\\<AppObjects, AppEvents\\\\>","docId":"api/interfaces/GuestProps","unlisted":false},{"type":"link","href":"/app-sdk/api/interfaces/UseStateSelectorOptions","label":"UseStateSelectorOptions\\\\<Selected\\\\>","docId":"api/interfaces/UseStateSelectorOptions","unlisted":false}]},{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/app-sdk/api/type-aliases/AppDispatch","label":"AppDispatch","docId":"api/type-aliases/AppDispatch","unlisted":false},{"type":"link","href":"/app-sdk/api/type-aliases/AppStore","label":"AppStore","docId":"api/type-aliases/AppStore","unlisted":false},{"type":"link","href":"/app-sdk/api/type-aliases/Await","label":"Await\\\\<T\\\\>","docId":"api/type-aliases/Await","unlisted":false},{"type":"link","href":"/app-sdk/api/type-aliases/EMUI","label":"EMUI\\\\<AppObjects, AppEvents\\\\>","docId":"api/type-aliases/EMUI","unlisted":false},{"type":"link","href":"/app-sdk/api/type-aliases/HostOptions","label":"~~HostOptions~~","docId":"api/type-aliases/HostOptions","unlisted":false},{"type":"link","href":"/app-sdk/api/type-aliases/HostProvidedParams","label":"HostProvidedParams","docId":"api/type-aliases/HostProvidedParams","unlisted":false},{"type":"link","href":"/app-sdk/api/type-aliases/ModuleOverrides","label":"ModuleOverrides","docId":"api/type-aliases/ModuleOverrides","unlisted":false},{"type":"link","href":"/app-sdk/api/type-aliases/OnHostInitCallback","label":"OnHostInitCallback","docId":"api/type-aliases/OnHostInitCallback","unlisted":false},{"type":"link","href":"/app-sdk/api/type-aliases/OnInitCallback","label":"OnInitCallback","docId":"api/type-aliases/OnInitCallback","unlisted":false},{"type":"link","href":"/app-sdk/api/type-aliases/OnMountCallback","label":"OnMountCallback","docId":"api/type-aliases/OnMountCallback","unlisted":false},{"type":"link","href":"/app-sdk/api/type-aliases/OnUnMountCallback","label":"OnUnMountCallback","docId":"api/type-aliases/OnUnMountCallback","unlisted":false},{"type":"link","href":"/app-sdk/api/type-aliases/RootState","label":"RootState","docId":"api/type-aliases/RootState","unlisted":false},{"type":"link","href":"/app-sdk/api/type-aliases/SelectStateFieldFunction","label":"SelectStateFieldFunction\\\\<TState, Selected\\\\>","docId":"api/type-aliases/SelectStateFieldFunction","unlisted":false}]},{"type":"category","label":"variables","collapsible":true,"collapsed":true,"items":[{"type":"link","href":"/app-sdk/api/variables/ErrorToast","label":"ErrorToast","docId":"api/variables/ErrorToast","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/FormPropsContext","label":"FormPropsContext","docId":"api/variables/FormPropsContext","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/GuestMicroApp","label":"GuestMicroApp","docId":"api/variables/GuestMicroApp","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/MASK_PIPES","label":"MASK\\\\_PIPES","docId":"api/variables/MASK_PIPES","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/MASK_TYPES","label":"MASK\\\\_TYPES","docId":"api/variables/MASK_TYPES","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/MicroApp","label":"~~MicroApp~~","docId":"api/variables/MicroApp","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/MicroIFrameApp","label":"~~MicroIFrameApp~~","docId":"api/variables/MicroIFrameApp","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/NavigationPrompt","label":"NavigationPrompt","docId":"api/variables/NavigationPrompt","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/NavigationPromptActions","label":"NavigationPromptActions","docId":"api/variables/NavigationPromptActions","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/Themes","label":"Themes","docId":"api/variables/Themes","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/VisuallyHidden","label":"VisuallyHidden","docId":"api/variables/VisuallyHidden","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/WaitMessage","label":"WaitMessage","docId":"api/variables/WaitMessage","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/act","label":"act","docId":"api/variables/act","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/ariaLive","label":"ariaLive","docId":"api/variables/ariaLive","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/auth","label":"auth","docId":"api/variables/auth","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/authReducer","label":"authReducer","docId":"api/variables/authReducer","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/clearSideEffects","label":"clearSideEffects","docId":"api/variables/clearSideEffects","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/createSideEffect","label":"createSideEffect","docId":"api/variables/createSideEffect","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/decorators","label":"decorators","docId":"api/variables/decorators","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/endSession","label":"endSession","docId":"api/variables/endSession","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/error","label":"error","docId":"api/variables/error","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/errorMiddleware","label":"errorMiddleware","docId":"api/variables/errorMiddleware","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/fireEvent","label":"fireEvent","docId":"api/variables/fireEvent","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/globalConstants","label":"globalConstants","docId":"api/variables/globalConstants","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/history","label":"history","docId":"api/variables/history","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/httpClientProps","label":"httpClientProps","docId":"api/variables/httpClientProps","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/logout","label":"logout","docId":"api/variables/logout","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/memoryHistory","label":"memoryHistory","docId":"api/variables/memoryHistory","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/removeSideEffect","label":"removeSideEffect","docId":"api/variables/removeSideEffect","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/resetUserIdleTime","label":"resetUserIdleTime","docId":"api/variables/resetUserIdleTime","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/screen","label":"screen","docId":"api/variables/screen","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/startSideEffect","label":"startSideEffect","docId":"api/variables/startSideEffect","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/updateBAEventParameters","label":"updateBAEventParameters","docId":"api/variables/updateBAEventParameters","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/useAppSelector","label":"useAppSelector","docId":"api/variables/useAppSelector","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/waitMessageAction","label":"waitMessageAction","docId":"api/variables/waitMessageAction","unlisted":false},{"type":"link","href":"/app-sdk/api/variables/within","label":"within","docId":"api/variables/within","unlisted":false}]}],"href":"/app-sdk/api/"},{"type":"link","href":"/app-sdk/","label":"Getting Started","docId":"index","unlisted":false},{"type":"link","href":"/app-sdk/usage-guide","label":"Usage Guide","docId":"usage-guide","unlisted":false}]},"docs":{"api/classes/Analytics":{"id":"api/classes/Analytics","title":"Analytics","description":"Analytics scripting object that captures business analytics events and","sidebar":"docsSidebar"},"api/classes/CMicroAppGuest":{"id":"api/classes/CMicroAppGuest","title":"CMicroAppGuest\\\\<AppObjects, AppEvents\\\\>","description":"Micro-frontend guest application class (singleton).","sidebar":"docsSidebar"},"api/classes/CMicroAppHost":{"id":"api/classes/CMicroAppHost","title":"~~CMicroAppHost\\\\<AppObjects, AppEvents\\\\>~~","description":"Micro-frontend host application class (singleton).","sidebar":"docsSidebar"},"api/classes/ErrorBoundary":{"id":"api/classes/ErrorBoundary","title":"ErrorBoundary","description":"React error boundary component that catches JavaScript errors in child components.","sidebar":"docsSidebar"},"api/classes/GuestModule":{"id":"api/classes/GuestModule","title":"GuestModule","description":"Default IModule implementation backed by a static parameters object.","sidebar":"docsSidebar"},"api/functions/AppRoot":{"id":"api/functions/AppRoot","title":"AppRoot()","description":"Root component for SDK-based applications.","sidebar":"docsSidebar"},"api/functions/authorize":{"id":"api/functions/authorize","title":"authorize()","description":"Handles the OAuth authorization callback after redirect from IDP.","sidebar":"docsSidebar"},"api/functions/authSaga":{"id":"api/functions/authSaga","title":"authSaga()","description":"Returns","sidebar":"docsSidebar"},"api/functions/Autocomplete":{"id":"api/functions/Autocomplete","title":"Autocomplete()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/buildModuleParams":{"id":"api/functions/buildModuleParams","title":"buildModuleParams()","description":"Build a ModuleParameters object for a self-initializing guest.","sidebar":"docsSidebar"},"api/functions/CheckBox":{"id":"api/functions/CheckBox","title":"CheckBox()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/cleanup":{"id":"api/functions/cleanup","title":"cleanup()","description":"Unmounts React trees that were mounted with render.","sidebar":"docsSidebar"},"api/functions/ComboBox":{"id":"api/functions/ComboBox","title":"ComboBox()","description":"Dropdown/select field component with React Hook Form integration.","sidebar":"docsSidebar"},"api/functions/ComboBoxV3":{"id":"api/functions/ComboBoxV3","title":"ComboBoxV3()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/configureStore":{"id":"api/functions/configureStore","title":"configureStore()","description":"Creates and configures the Redux store with SDK middleware and enhancers.","sidebar":"docsSidebar"},"api/functions/ConnectForm":{"id":"api/functions/ConnectForm","title":"ConnectForm()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/createGuestModule":{"id":"api/functions/createGuestModule","title":"createGuestModule()","description":"Create a module scripting object for a guest micro-app.","sidebar":"docsSidebar"},"api/functions/createManager":{"id":"api/functions/createManager","title":"createManager()","description":"Creates a \\"manager\\" component that will inject the provided reducer and saga","sidebar":"docsSidebar"},"api/functions/DateInput":{"id":"api/functions/DateInput","title":"DateInput()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/DatePicker":{"id":"api/functions/DatePicker","title":"DatePicker()","description":"Date picker field component with React Hook Form integration.","sidebar":"docsSidebar"},"api/functions/DateRangePicker":{"id":"api/functions/DateRangePicker","title":"DateRangePicker()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/DateTimePicker":{"id":"api/functions/DateTimePicker","title":"DateTimePicker()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/enableReactAppForHostIntegration":{"id":"api/functions/enableReactAppForHostIntegration","title":"enableReactAppForHostIntegration()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/fetchHostAppData":{"id":"api/functions/fetchHostAppData","title":"fetchHostAppData()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/fetchUserSettings":{"id":"api/functions/fetchUserSettings","title":"fetchUserSettings()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/Form":{"id":"api/functions/Form","title":"Form()","description":"Form component with integrated React Hook Form state management and validation.","sidebar":"docsSidebar"},"api/functions/FormItemLayout":{"id":"api/functions/FormItemLayout","title":"FormItemLayout()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/FormLayoutBlockItem":{"id":"api/functions/FormLayoutBlockItem","title":"FormLayoutBlockItem()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/FormSubmitButton":{"id":"api/functions/FormSubmitButton","title":"FormSubmitButton()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/getApiActionCreator":{"id":"api/functions/getApiActionCreator","title":"getApiActionCreator()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/getAppConfig":{"id":"api/functions/getAppConfig","title":"getAppConfig()","description":"Returns","sidebar":"docsSidebar"},"api/functions/getAppConfigValue":{"id":"api/functions/getAppConfigValue","title":"getAppConfigValue()","description":"Gets a value from the application configuration using dot notation.","sidebar":"docsSidebar"},"api/functions/getAuthHTTPClient":{"id":"api/functions/getAuthHTTPClient","title":"getAuthHTTPClient()","description":"Creates an authenticated HTTP client instance with authorization headers.","sidebar":"docsSidebar"},"api/functions/getAuthorizationHeader":{"id":"api/functions/getAuthorizationHeader","title":"getAuthorizationHeader()","description":"Gets the current authorization header value from session storage.","sidebar":"docsSidebar"},"api/functions/getHostAppDataByKey":{"id":"api/functions/getHostAppDataByKey","title":"getHostAppDataByKey()","description":"Type Parameters","sidebar":"docsSidebar"},"api/functions/getHTTPClient":{"id":"api/functions/getHTTPClient","title":"getHTTPClient()","description":"Creates a basic HTTP client instance using Axios.","sidebar":"docsSidebar"},"api/functions/getLogger":{"id":"api/functions/getLogger","title":"getLogger()","description":"Returns","sidebar":"docsSidebar"},"api/functions/getMicroFrontEndAppConfig":{"id":"api/functions/getMicroFrontEndAppConfig","title":"getMicroFrontEndAppConfig()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/getNavigationLinks":{"id":"api/functions/getNavigationLinks","title":"getNavigationLinks()","description":"Returns","sidebar":"docsSidebar"},"api/functions/getRedirectUrl":{"id":"api/functions/getRedirectUrl","title":"getRedirectUrl()","description":"Returns","sidebar":"docsSidebar"},"api/functions/getSelectField":{"id":"api/functions/getSelectField","title":"getSelectField()","description":"Why use this? It will prevent unnecessary rerenders hence improving performance, it also reduces the amount of code needed to select data from the store","sidebar":"docsSidebar"},"api/functions/getStore":{"id":"api/functions/getStore","title":"getStore()","description":"Gets the global Redux store instance.","sidebar":"docsSidebar"},"api/functions/initServiceWorker":{"id":"api/functions/initServiceWorker","title":"initServiceWorker()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/InputMask":{"id":"api/functions/InputMask","title":"InputMask()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/InputText":{"id":"api/functions/InputText","title":"InputText()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/isCIBuild":{"id":"api/functions/isCIBuild","title":"isCIBuild()","description":"Returns","sidebar":"docsSidebar"},"api/functions/isProd":{"id":"api/functions/isProd","title":"isProd()","description":"Returns","sidebar":"docsSidebar"},"api/functions/isUserAuthorized":{"id":"api/functions/isUserAuthorized","title":"isUserAuthorized()","description":"Checks if the user is currently authorized/authenticated.","sidebar":"docsSidebar"},"api/functions/LargeTextBox":{"id":"api/functions/LargeTextBox","title":"LargeTextBox()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/listenStorageEvents":{"id":"api/functions/listenStorageEvents","title":"listenStorageEvents()","description":"Returns","sidebar":"docsSidebar"},"api/functions/loadable":{"id":"api/functions/loadable","title":"loadable()","description":"Creates a lazily-loaded React component for code splitting.","sidebar":"docsSidebar"},"api/functions/loadAppConfig":{"id":"api/functions/loadAppConfig","title":"loadAppConfig()","description":"Loads the application configuration from a JSON file.","sidebar":"docsSidebar"},"api/functions/login":{"id":"api/functions/login","title":"login()","description":"Initiates the login flow using OAuth/OIDC authorization code flow.","sidebar":"docsSidebar"},"api/functions/MaskedInputText":{"id":"api/functions/MaskedInputText","title":"MaskedInputText()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/notifyGuestUnloadComplete":{"id":"api/functions/notifyGuestUnloadComplete","title":"notifyGuestUnloadComplete()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/onAuthorizationFailure":{"id":"api/functions/onAuthorizationFailure","title":"onAuthorizationFailure()","description":"Registers a callback to handle authorization failures (401 errors).","sidebar":"docsSidebar"},"api/functions/onGuestUnloadStart":{"id":"api/functions/onGuestUnloadStart","title":"onGuestUnloadStart()","description":"Returns","sidebar":"docsSidebar"},"api/functions/Page":{"id":"api/functions/Page","title":"Page()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/Radio":{"id":"api/functions/Radio","title":"Radio()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/RadioGroup":{"id":"api/functions/RadioGroup","title":"RadioGroup()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/redactPii":{"id":"api/functions/redactPii","title":"redactPii()","description":"Redacts personally identifiable information (PII) from data objects.","sidebar":"docsSidebar"},"api/functions/RegisterService":{"id":"api/functions/RegisterService","title":"RegisterService()","description":"Type Parameters","sidebar":"docsSidebar"},"api/functions/removeDoubleSlash":{"id":"api/functions/removeDoubleSlash","title":"removeDoubleSlash()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/removeStorageEvents":{"id":"api/functions/removeStorageEvents","title":"removeStorageEvents()","description":"Returns","sidebar":"docsSidebar"},"api/functions/render":{"id":"api/functions/render","title":"render()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/renderHook":{"id":"api/functions/renderHook","title":"renderHook()","description":"Allows you to render a hook within a test React component without having to","sidebar":"docsSidebar"},"api/functions/renderWithHostData":{"id":"api/functions/renderWithHostData","title":"renderWithHostData()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/renderWithRedux":{"id":"api/functions/renderWithRedux","title":"renderWithRedux()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/renderWithRouter":{"id":"api/functions/renderWithRouter","title":"renderWithRouter()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/renderWithRouterRedux":{"id":"api/functions/renderWithRouterRedux","title":"renderWithRouterRedux()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/RenderWithStateAddOns":{"id":"api/functions/RenderWithStateAddOns","title":"RenderWithStateAddOns()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/RequireAuth":{"id":"api/functions/RequireAuth","title":"RequireAuth()","description":"A React component that ensures authentication for its children.","sidebar":"docsSidebar"},"api/functions/sdkBaseQuery":{"id":"api/functions/sdkBaseQuery","title":"sdkBaseQuery()","description":"Base query function for RTK Query integration.","sidebar":"docsSidebar"},"api/functions/sendBAEvent":{"id":"api/functions/sendBAEvent","title":"~~sendBAEvent()~~","description":"Sends a business analytics event to Google Tag Manager data layer.","sidebar":"docsSidebar"},"api/functions/sendMessageToHost":{"id":"api/functions/sendMessageToHost","title":"sendMessageToHost()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/SessionTimeout":{"id":"api/functions/SessionTimeout","title":"SessionTimeout()","description":"Returns","sidebar":"docsSidebar"},"api/functions/setAppConfig":{"id":"api/functions/setAppConfig","title":"setAppConfig()","description":"Sets the entire application configuration.","sidebar":"docsSidebar"},"api/functions/setAppConfigValue":{"id":"api/functions/setAppConfigValue","title":"setAppConfigValue()","description":"Sets a value in the application configuration using dot notation.","sidebar":"docsSidebar"},"api/functions/setHostAppData":{"id":"api/functions/setHostAppData","title":"setHostAppData()","description":"Type Parameters","sidebar":"docsSidebar"},"api/functions/setLoginParams":{"id":"api/functions/setLoginParams","title":"setLoginParams()","description":"Sets login parameters for the authentication flow.","sidebar":"docsSidebar"},"api/functions/subscribeToResetSession":{"id":"api/functions/subscribeToResetSession","title":"subscribeToResetSession()","description":"Registers a callback when the idle clock is reset.","sidebar":"docsSidebar"},"api/functions/subscribeToSessionExpiry":{"id":"api/functions/subscribeToSessionExpiry","title":"subscribeToSessionExpiry()","description":"Registers a callback when idle time crosses the expiry threshold.","sidebar":"docsSidebar"},"api/functions/subscribeToSessionExpiryWarning":{"id":"api/functions/subscribeToSessionExpiryWarning","title":"subscribeToSessionExpiryWarning()","description":"Registers a callback when idle time crosses the warn threshold.","sidebar":"docsSidebar"},"api/functions/TextBox":{"id":"api/functions/TextBox","title":"TextBox()","description":"Text input field component with React Hook Form integration.","sidebar":"docsSidebar"},"api/functions/Toggle":{"id":"api/functions/Toggle","title":"Toggle()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/trackActivity":{"id":"api/functions/trackActivity","title":"trackActivity()","description":"Tracks user interaction on a document and invokes a callback (iframe guests).","sidebar":"docsSidebar"},"api/functions/useAppDispatch":{"id":"api/functions/useAppDispatch","title":"useAppDispatch()","description":"React hook to get the typed dispatch function.","sidebar":"docsSidebar"},"api/functions/useAppMiddleware":{"id":"api/functions/useAppMiddleware","title":"useAppMiddleware()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/useInjectQuery":{"id":"api/functions/useInjectQuery","title":"useInjectQuery()","description":"React hook to dynamically inject RTK Query API slice into the Redux store.","sidebar":"docsSidebar"},"api/functions/useInjectReducer":{"id":"api/functions/useInjectReducer","title":"useInjectReducer()","description":"A react hook that dynamically injects a reducer when the hook is run","sidebar":"docsSidebar"},"api/functions/useInjectSaga":{"id":"api/functions/useInjectSaga","title":"useInjectSaga()","description":"A react hook that dynamically injects a saga when the hook is run","sidebar":"docsSidebar"},"api/functions/useInjectSideEffect":{"id":"api/functions/useInjectSideEffect","title":"useInjectSideEffect()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/useMediaQueryList":{"id":"api/functions/useMediaQueryList","title":"useMediaQueryList()","description":"Parameters","sidebar":"docsSidebar"},"api/functions/useStateSelector":{"id":"api/functions/useStateSelector","title":"useStateSelector()","description":"Generic selector that receives a field selector function returned from getSelectField","sidebar":"docsSidebar"},"api/functions/useStateSelectorShallow":{"id":"api/functions/useStateSelectorShallow","title":"useStateSelectorShallow()","description":"Generic selector that receives a field selector function returned from getSelectField.","sidebar":"docsSidebar"},"api/functions/waitFor":{"id":"api/functions/waitFor","title":"waitFor()","description":"Type Parameters","sidebar":"docsSidebar"},"api/functions/waitForElementToBeRemoved":{"id":"api/functions/waitForElementToBeRemoved","title":"waitForElementToBeRemoved()","description":"Type Parameters","sidebar":"docsSidebar"},"api/functions/withAppDecorator":{"id":"api/functions/withAppDecorator","title":"withAppDecorator()","description":"Parameters","sidebar":"docsSidebar"},"api/index":{"id":"api/index","title":"App SDK API","description":"Classes","sidebar":"docsSidebar"},"api/interfaces/AppConfig":{"id":"api/interfaces/AppConfig","title":"AppConfig","description":"Properties","sidebar":"docsSidebar"},"api/interfaces/GuestProps":{"id":"api/interfaces/GuestProps","title":"GuestProps\\\\<AppObjects, AppEvents\\\\>","description":"Extends","sidebar":"docsSidebar"},"api/interfaces/UseStateSelectorOptions":{"id":"api/interfaces/UseStateSelectorOptions","title":"UseStateSelectorOptions\\\\<Selected\\\\>","description":"Type Parameters","sidebar":"docsSidebar"},"api/type-aliases/AppDispatch":{"id":"api/type-aliases/AppDispatch","title":"AppDispatch","description":"","sidebar":"docsSidebar"},"api/type-aliases/AppStore":{"id":"api/type-aliases/AppStore","title":"AppStore","description":"","sidebar":"docsSidebar"},"api/type-aliases/Await":{"id":"api/type-aliases/Await","title":"Await\\\\<T\\\\>","description":"Type Parameters","sidebar":"docsSidebar"},"api/type-aliases/EMUI":{"id":"api/type-aliases/EMUI","title":"EMUI\\\\<AppObjects, AppEvents\\\\>","description":"Type Declaration","sidebar":"docsSidebar"},"api/type-aliases/HostOptions":{"id":"api/type-aliases/HostOptions","title":"~~HostOptions~~","description":"Deprecated","sidebar":"docsSidebar"},"api/type-aliases/HostProvidedParams":{"id":"api/type-aliases/HostProvidedParams","title":"HostProvidedParams","description":"Host-provided values that can\'t be read from the app config.","sidebar":"docsSidebar"},"api/type-aliases/ModuleOverrides":{"id":"api/type-aliases/ModuleOverrides","title":"ModuleOverrides","description":"Optional method overrides the host can supply to customise","sidebar":"docsSidebar"},"api/type-aliases/OnHostInitCallback":{"id":"api/type-aliases/OnHostInitCallback","title":"OnHostInitCallback","description":"Parameters","sidebar":"docsSidebar"},"api/type-aliases/OnInitCallback":{"id":"api/type-aliases/OnInitCallback","title":"OnInitCallback","description":"Parameters","sidebar":"docsSidebar"},"api/type-aliases/OnMountCallback":{"id":"api/type-aliases/OnMountCallback","title":"OnMountCallback","description":"Parameters","sidebar":"docsSidebar"},"api/type-aliases/OnUnMountCallback":{"id":"api/type-aliases/OnUnMountCallback","title":"OnUnMountCallback","description":"Parameters","sidebar":"docsSidebar"},"api/type-aliases/RootState":{"id":"api/type-aliases/RootState","title":"RootState","description":"","sidebar":"docsSidebar"},"api/type-aliases/SelectStateFieldFunction":{"id":"api/type-aliases/SelectStateFieldFunction","title":"SelectStateFieldFunction\\\\<TState, Selected\\\\>","description":"Type Parameters","sidebar":"docsSidebar"},"api/variables/act":{"id":"api/variables/act","title":"act","description":"Simply calls ReactDOMTestUtils.act(cb)","sidebar":"docsSidebar"},"api/variables/ariaLive":{"id":"api/variables/ariaLive","title":"ariaLive","description":"","sidebar":"docsSidebar"},"api/variables/auth":{"id":"api/variables/auth","title":"auth","description":"Type Declaration","sidebar":"docsSidebar"},"api/variables/authReducer":{"id":"api/variables/authReducer","title":"authReducer","description":"","sidebar":"docsSidebar"},"api/variables/clearSideEffects":{"id":"api/variables/clearSideEffects","title":"clearSideEffects","description":"Clears all registered side effect listeners.","sidebar":"docsSidebar"},"api/variables/createSideEffect":{"id":"api/variables/createSideEffect","title":"createSideEffect","description":"Creates a new side effect listener.","sidebar":"docsSidebar"},"api/variables/decorators":{"id":"api/variables/decorators","title":"decorators","description":"Type Declaration","sidebar":"docsSidebar"},"api/variables/endSession":{"id":"api/variables/endSession","title":"endSession","description":"Ends the current user session and redirects to logout page.","sidebar":"docsSidebar"},"api/variables/error":{"id":"api/variables/error","title":"error","description":"","sidebar":"docsSidebar"},"api/variables/errorMiddleware":{"id":"api/variables/errorMiddleware","title":"errorMiddleware","description":"","sidebar":"docsSidebar"},"api/variables/ErrorToast":{"id":"api/variables/ErrorToast","title":"ErrorToast","description":"","sidebar":"docsSidebar"},"api/variables/fireEvent":{"id":"api/variables/fireEvent","title":"fireEvent","description":"","sidebar":"docsSidebar"},"api/variables/FormPropsContext":{"id":"api/variables/FormPropsContext","title":"FormPropsContext","description":"Side-channel context for the useForm configuration that the parent","sidebar":"docsSidebar"},"api/variables/globalConstants":{"id":"api/variables/globalConstants","title":"globalConstants","description":"Type Declaration","sidebar":"docsSidebar"},"api/variables/GuestMicroApp":{"id":"api/variables/GuestMicroApp","title":"GuestMicroApp","description":"Component to load a guest microapp.","sidebar":"docsSidebar"},"api/variables/history":{"id":"api/variables/history","title":"history","description":"","sidebar":"docsSidebar"},"api/variables/httpClientProps":{"id":"api/variables/httpClientProps","title":"httpClientProps","description":"","sidebar":"docsSidebar"},"api/variables/logout":{"id":"api/variables/logout","title":"logout","description":"Type Declaration","sidebar":"docsSidebar"},"api/variables/MASK_PIPES":{"id":"api/variables/MASK_PIPES","title":"MASK\\\\_PIPES","description":"","sidebar":"docsSidebar"},"api/variables/MASK_TYPES":{"id":"api/variables/MASK_TYPES","title":"MASK\\\\_TYPES","description":"","sidebar":"docsSidebar"},"api/variables/memoryHistory":{"id":"api/variables/memoryHistory","title":"memoryHistory","description":"","sidebar":"docsSidebar"},"api/variables/MicroApp":{"id":"api/variables/MicroApp","title":"~~MicroApp~~","description":"Component to render a guest microapp","sidebar":"docsSidebar"},"api/variables/MicroIFrameApp":{"id":"api/variables/MicroIFrameApp","title":"~~MicroIFrameApp~~","description":"Component to render a guest microapp in an iframe.","sidebar":"docsSidebar"},"api/variables/NavigationPrompt":{"id":"api/variables/NavigationPrompt","title":"NavigationPrompt","description":"","sidebar":"docsSidebar"},"api/variables/NavigationPromptActions":{"id":"api/variables/NavigationPromptActions","title":"NavigationPromptActions","description":"Type Declaration","sidebar":"docsSidebar"},"api/variables/removeSideEffect":{"id":"api/variables/removeSideEffect","title":"removeSideEffect","description":"Removes a side effect listener.","sidebar":"docsSidebar"},"api/variables/resetUserIdleTime":{"id":"api/variables/resetUserIdleTime","title":"resetUserIdleTime","description":"Resets the user idle clock without calling the auth introspection API.","sidebar":"docsSidebar"},"api/variables/screen":{"id":"api/variables/screen","title":"screen","description":"","sidebar":"docsSidebar"},"api/variables/startSideEffect":{"id":"api/variables/startSideEffect","title":"startSideEffect","description":"Starts a side effect listener.","sidebar":"docsSidebar"},"api/variables/Themes":{"id":"api/variables/Themes","title":"Themes","description":"Type Declaration","sidebar":"docsSidebar"},"api/variables/updateBAEventParameters":{"id":"api/variables/updateBAEventParameters","title":"updateBAEventParameters","description":"Updates the business analytics event parameters with new values","sidebar":"docsSidebar"},"api/variables/useAppSelector":{"id":"api/variables/useAppSelector","title":"useAppSelector","description":"React hook to select data from Redux store with type safety.","sidebar":"docsSidebar"},"api/variables/VisuallyHidden":{"id":"api/variables/VisuallyHidden","title":"VisuallyHidden","description":"","sidebar":"docsSidebar"},"api/variables/WaitMessage":{"id":"api/variables/WaitMessage","title":"WaitMessage","description":"","sidebar":"docsSidebar"},"api/variables/waitMessageAction":{"id":"api/variables/waitMessageAction","title":"waitMessageAction","description":"Type Declaration","sidebar":"docsSidebar"},"api/variables/within":{"id":"api/variables/within","title":"within","description":"","sidebar":"docsSidebar"},"index":{"id":"index","title":"Getting Started","description":"Welcome to the PUI App SDK - the ICE MT UI Platform Application SDK for building React micro-frontend applications with integrated cross-cutting concerns.","sidebar":"docsSidebar"},"usage-guide":{"id":"usage-guide","title":"Usage Guide","description":"This guide provides detailed examples and patterns for using the PUI App SDK in your applications. For initial setup, see the Getting Started Guide.","sidebar":"docsSidebar"}}}}')}}]);

package/build/docs/assets/js/a48fd09c.49a10fd0.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[6526],{4495(e,n,s){s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>a,metadata:()=>t,toc:()=>p});const t=JSON.parse('{"id":"api/functions/setLoginParams","title":"setLoginParams()","description":"Sets login parameters for the authentication flow.","source":"@site/docs/api/functions/setLoginParams.md","sourceDirName":"api/functions","slug":"/api/functions/setLoginParams","permalink":"/app-sdk/api/functions/setLoginParams","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/setLoginParams.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"setHostAppData()","permalink":"/app-sdk/api/functions/setHostAppData"},"next":{"title":"subscribeToResetSession()","permalink":"/app-sdk/api/functions/subscribeToResetSession"}}');var i=s(6070),r=s(5676);const a={},o="setLoginParams()",c={},p=[{value:"Parameters",id:"parameters",level:2},{value:"params",id:"params",level:3},{value:"Returns",id:"returns",level:2},{value:"Example",id:"example",level:2}];function l(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"setloginparams",children:"setLoginParams()"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:'function setLoginParams(params: Omit<LoginParams, "redirectUri"> & {\n  redirectUri?: string;\n}): void;\n'})}),"\n",(0,i.jsx)(n.p,{children:"Sets login parameters for the authentication flow.\nStores parameters in the global window object for use across the application."}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsx)(n.h3,{id:"params",children:"params"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Omit"}),"<",(0,i.jsx)(n.code,{children:"LoginParams"}),", ",(0,i.jsx)(n.code,{children:'"redirectUri"'}),"> & {\n",(0,i.jsx)(n.code,{children:"redirectUri?"}),": ",(0,i.jsx)(n.code,{children:"string"}),";\n}"]}),"\n",(0,i.jsx)(n.p,{children:"Login parameters"}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-typescript",children:"setLoginParams({\n  clientId: 'my-app',\n  scope: 'openid profile email'\n});\n"})})]})}function d(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},5676(e,n,s){s.d(n,{R:()=>a,x:()=>o});var t=s(758);const i={},r=t.createContext(i);function a(e){const n=t.useContext(r);return t.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/fed4ae4f.4cbcd19c.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[9712],{1761(e,s,n){n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>i,toc:()=>l});const i=JSON.parse('{"id":"api/functions/subscribeToResetSession","title":"subscribeToResetSession()","description":"Registers a callback when the idle clock is reset.","source":"@site/docs/api/functions/subscribeToResetSession.md","sourceDirName":"api/functions","slug":"/api/functions/subscribeToResetSession","permalink":"/app-sdk/api/functions/subscribeToResetSession","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/subscribeToResetSession.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"setLoginParams()","permalink":"/app-sdk/api/functions/setLoginParams"},"next":{"title":"subscribeToSessionExpiry()","permalink":"/app-sdk/api/functions/subscribeToSessionExpiry"}}');var t=n(6070),r=n(5676);const o={},c="subscribeToResetSession()",a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"onResetListener",id:"onresetlistener",level:3},{value:"Returns",id:"returns",level:2}];function d(e){const s={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.header,{children:(0,t.jsx)(s.h1,{id:"subscribetoresetsession",children:"subscribeToResetSession()"})}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-ts",children:"function subscribeToResetSession(onResetListener: RESETLISTENER): (...args: []) => void;\n"})}),"\n",(0,t.jsx)(s.p,{children:"Registers a callback when the idle clock is reset."}),"\n",(0,t.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsx)(s.h3,{id:"onresetlistener",children:"onResetListener"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.code,{children:"RESETLISTENER"})}),"\n",(0,t.jsx)(s.p,{children:"Receives the resetWarningModal flag."}),"\n",(0,t.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(s.p,{children:"Unsubscribe function."}),"\n",(0,t.jsxs)(s.p,{children:["(...",(0,t.jsx)(s.code,{children:"args"}),": []) => ",(0,t.jsx)(s.code,{children:"void"})]})]})}function u(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},5676(e,s,n){n.d(s,{R:()=>o,x:()=>c});var i=n(758);const t={},r=i.createContext(t);function o(e){const s=i.useContext(r);return i.useMemo(function(){return"function"==typeof e?e(s):{...s,...e}},[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(r.Provider,{value:s},e.children)}}}]);