@elliemae/pui-app-sdk 5.40.3 → 5.40.5

package/build/docs/assets/js/f72a372a.4118877c.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[3292],{4257(e,n,s){s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>p,frontMatter:()=>l,metadata:()=>i,toc:()=>a});const i=JSON.parse('{"id":"api/classes/CMicroAppGuest","title":"CMicroAppGuest\\\\<AppObjects, AppEvents\\\\>","description":"Micro-frontend guest application class (singleton).","source":"@site/docs/api/classes/CMicroAppGuest.md","sourceDirName":"api/classes","slug":"/api/classes/CMicroAppGuest","permalink":"/app-sdk/api/classes/CMicroAppGuest","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/classes/CMicroAppGuest.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"Analytics","permalink":"/app-sdk/api/classes/Analytics"},"next":{"title":"~~CMicroAppHost\\\\<AppObjects, AppEvents\\\\>~~","permalink":"/app-sdk/api/classes/CMicroAppHost"}}');var r=s(6070),t=s(5589);const l={},d="CMicroAppGuest<AppObjects, AppEvents>",c={},a=[{value:"Example",id:"example",level:2},{value:"Type Parameters",id:"type-parameters",level:2},{value:"AppObjects",id:"appobjects",level:3},{value:"AppEvents",id:"appevents",level:3},{value:"Implements",id:"implements",level:2},{value:"Accessors",id:"accessors",level:2},{value:"uuid",id:"uuid",level:3},{value:"Get Signature",id:"get-signature",level:4},{value:"Returns",id:"returns",level:5},{value:"Implementation of",id:"implementation-of",level:4},{value:"Methods",id:"methods",level:2},{value:"addScriptingObject()",id:"addscriptingobject",level:3},{value:"Type Parameters",id:"type-parameters-1",level:4},{value:"SO",id:"so",level:5},{value:"Parameters",id:"parameters",level:4},{value:"so",id:"so-1",level:5},{value:"params?",id:"params",level:5},{value:"Returns",id:"returns-1",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"dispatchEvent()",id:"dispatchevent",level:3},{value:"Type Parameters",id:"type-parameters-2",level:4},{value:"EventId",id:"eventid",level:5},{value:"Params",id:"params-1",level:5},{value:"Options",id:"options",level:5},{value:"Parameters",id:"parameters-1",level:4},{value:"params",id:"params-2",level:5},{value:"Returns",id:"returns-2",level:4},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"getHost()",id:"gethost",level:3},{value:"Returns",id:"returns-3",level:4},{value:"getLogger()",id:"getlogger",level:3},{value:"Returns",id:"returns-4",level:4},{value:"getObject()",id:"getobject",level:3},{value:"Type Parameters",id:"type-parameters-3",level:4},{value:"ObjectId",id:"objectid",level:5},{value:"Parameters",id:"parameters-2",level:4},{value:"objectId",id:"objectid-1",level:5},{value:"Returns",id:"returns-5",level:4},{value:"Implementation of",id:"implementation-of-3",level:4},{value:"getProps()",id:"getprops",level:3},{value:"Returns",id:"returns-6",level:4},{value:"<del>getRef()</del>",id:"getref",level:3},{value:"Type Parameters",id:"type-parameters-4",level:4},{value:"T",id:"t",level:5},{value:"Returns",id:"returns-7",level:4},{value:"Deprecated",id:"deprecated",level:4},{value:"Implementation of",id:"implementation-of-4",level:4},{value:"init()",id:"init",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"options",id:"options-1",level:5},{value:"Returns",id:"returns-8",level:4},{value:"Implementation of",id:"implementation-of-5",level:4},{value:"initialize()",id:"initialize",level:3},{value:"Returns",id:"returns-9",level:4},{value:"mount()",id:"mount",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"options?",id:"options-2",level:5},{value:"Returns",id:"returns-10",level:4},{value:"Implementation of",id:"implementation-of-6",level:4},{value:"navigate()",id:"navigate",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"url",id:"url",level:5},{value:"state?",id:"state",level:5},{value:"Returns",id:"returns-11",level:4},{value:"Implementation of",id:"implementation-of-7",level:4},{value:"removeScriptingObject()",id:"removescriptingobject",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"objectId",id:"objectid-2",level:5},{value:"Returns",id:"returns-12",level:4},{value:"Implementation of",id:"implementation-of-8",level:4},{value:"subscribe()",id:"subscribe",level:3},{value:"Type Parameters",id:"type-parameters-5",level:4},{value:"EventId",id:"eventid-1",level:5},{value:"Parameters",id:"parameters-7",level:4},{value:"params",id:"params-3",level:5},{value:"Returns",id:"returns-13",level:4},{value:"Implementation of",id:"implementation-of-9",level:4},{value:"unmount()",id:"unmount",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"options",id:"options-3",level:5},{value:"Returns",id:"returns-14",level:4},{value:"Implementation of",id:"implementation-of-10",level:4},{value:"unsubscribe()",id:"unsubscribe",level:3},{value:"Type Parameters",id:"type-parameters-6",level:4},{value:"EventId",id:"eventid-2",level:5},{value:"Parameters",id:"parameters-9",level:4},{value:"params",id:"params-4",level:5},{value:"Returns",id:"returns-15",level:4},{value:"Implementation of",id:"implementation-of-11",level:4},{value:"getInstance()",id:"getinstance",level:3},{value:"Type Parameters",id:"type-parameters-7",level:4},{value:"AppObjects",id:"appobjects-1",level:5},{value:"AppEvents",id:"appevents-1",level:5},{value:"Parameters",id:"parameters-10",level:4},{value:"params?",id:"params-5",level:5},{value:"Returns",id:"returns-16",level:4},{value:"isHosted()",id:"ishosted",level:3},{value:"Returns",id:"returns-17",level:4},{value:"isInitialized()",id:"isinitialized",level:3},{value:"Returns",id:"returns-18",level:4}];function o(e){const n={a:"a",code:"code",del:"del",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",li:"li",p:"p",pre:"pre",ul:"ul",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"cmicroappguestappobjects-appevents",children:"CMicroAppGuest<AppObjects, AppEvents>"})}),"\n",(0,r.jsx)(n.p,{children:"Micro-frontend guest application class (singleton).\nManages communication between a guest micro-app and its host application.\nSupports both SSF (Shared Service Framework) and App Bridge communication methods."}),"\n",(0,r.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"const guest = new CMicroAppGuest({\n  onInit: ({ history, theme, prevState }) => {\n    console.log('Guest initialized');\n  },\n  onMount: ({ container }) => {\n    // Render your React app\n    ReactDOM.render(<App />, container);\n  },\n  onUnmount: ({ container }) => {\n    // Cleanup\n    ReactDOM.unmountComponentAtNode(container);\n    return { savedState: 'some data' };\n  }\n});\n"})}),"\n",(0,r.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,r.jsx)(n.h3,{id:"appobjects",children:"AppObjects"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"AppObjects"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"ScriptingObjects"})," = ",(0,r.jsx)(n.code,{children:"Partial"}),"<",(0,r.jsx)(n.code,{children:"ScriptingObjectTypes"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"Type of custom scripting objects"}),"\n",(0,r.jsx)(n.h3,{id:"appevents",children:"AppEvents"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"AppEvents"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"EventListeners"})," = ",(0,r.jsx)(n.code,{children:"Events"})]}),"\n",(0,r.jsx)(n.p,{children:"Type of custom event listeners"}),"\n",(0,r.jsx)(n.h2,{id:"implements",children:"Implements"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"IMicroAppGuest"}),"<",(0,r.jsx)(n.code,{children:"AppObjects"}),", ",(0,r.jsx)(n.code,{children:"AppEvents"}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"accessors",children:"Accessors"}),"\n",(0,r.jsx)(n.h3,{id:"uuid",children:"uuid"}),"\n",(0,r.jsx)(n.h4,{id:"get-signature",children:"Get Signature"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"get uuid(): string;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Unique identifier for the microapp instance."}),"\n",(0,r.jsx)(n.h5,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"string"})}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.uuid\n"})}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"addscriptingobject",children:"addScriptingObject()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"addScriptingObject<SO>(so: SO, params?: AddScriptingObjectParams): void;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Register a scripting object for child micro-apps to use.\nAdds the object to both the App Bridge and the SSF Host so guests\nusing either transport can discover it. Always prefer this method\nover calling appBridge.addScriptingObject() directly."}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters-1",children:"Type Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"so",children:"SO"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"SO"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"IScriptingObject"})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"so-1",children:"so"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"SO"})}),"\n",(0,r.jsx)(n.p,{children:"The scripting object to be added."}),"\n",(0,r.jsx)(n.h5,{id:"params",children:"params?"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"AddScriptingObjectParams"})}),"\n",(0,r.jsxs)(n.p,{children:["Optional parameters (e.g. ",(0,r.jsx)(n.code,{children:"{ guestId }"})," to scope to a specific guest)."]}),"\n",(0,r.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-1",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.addScriptingObject\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"dispatchevent",children:"dispatchEvent()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"dispatchEvent<EventId, Params, Options>(params: DispatchEventParam<EventId, Params, Options>): Promise<void | unknown[]>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Dispatches an event to the child microapp."}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters-2",children:"Type Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"eventid",children:"EventId"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"EventId"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.h5,{id:"params-1",children:"Params"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Params"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"any"})]}),"\n",(0,r.jsx)(n.h5,{id:"options",children:"Options"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Options"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"EventOptions"})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"params-2",children:"params"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"DispatchEventParam"}),"<",(0,r.jsx)(n.code,{children:"EventId"}),", ",(0,r.jsx)(n.code,{children:"Params"}),", ",(0,r.jsx)(n.code,{children:"Options"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"Event parameters."}),"\n",(0,r.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"})," | ",(0,r.jsx)(n.code,{children:"unknown"}),"[]>"]}),"\n",(0,r.jsx)(n.p,{children:"A promise that resolves with the combined results of dispatched events."}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-2",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.dispatchEvent\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"gethost",children:"getHost()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"getHost(): \n  | IMicroAppHost<Partial<ScriptingObjectTypes>, Events>\n  | IMicroFEHost<Partial<ScriptingObjectTypes>, Events>\n  | SSFGuest<Partial<ScriptingObjectTypes>, Events>\n  | undefined;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:["| ",(0,r.jsx)(n.code,{children:"IMicroAppHost"}),"<",(0,r.jsx)(n.code,{children:"Partial"}),"<",(0,r.jsx)(n.code,{children:"ScriptingObjectTypes"}),">, ",(0,r.jsx)(n.code,{children:"Events"}),">\n| ",(0,r.jsx)(n.code,{children:"IMicroFEHost"}),"<",(0,r.jsx)(n.code,{children:"Partial"}),"<",(0,r.jsx)(n.code,{children:"ScriptingObjectTypes"}),">, ",(0,r.jsx)(n.code,{children:"Events"}),">\n| ",(0,r.jsx)(n.code,{children:"SSFGuest"}),"<",(0,r.jsx)(n.code,{children:"Partial"}),"<",(0,r.jsx)(n.code,{children:"ScriptingObjectTypes"}),">, ",(0,r.jsx)(n.code,{children:"Events"}),">\n| ",(0,r.jsx)(n.code,{children:"undefined"})]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"getlogger",children:"getLogger()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"getLogger(): MicroFrontEndLogger;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"MicroFrontEndLogger"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"getobject",children:"getObject()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"getObject<ObjectId>(objectId: ObjectId): Promise<AppObjects[ObjectId] | null>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Retrieves a reference to a scripting object (or proxy) by its unique name."}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters-3",children:"Type Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"objectid",children:"ObjectId"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"ObjectId"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"objectid-1",children:"objectId"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"ObjectId"})}),"\n",(0,r.jsx)(n.p,{children:"The unique name of the scripting object."}),"\n",(0,r.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"AppObjects"}),"[",(0,r.jsx)(n.code,{children:"ObjectId"}),"] | ",(0,r.jsx)(n.code,{children:"null"}),">"]}),"\n",(0,r.jsxs)(n.p,{children:["A promise that resolves to the scripting object reference or ",(0,r.jsx)(n.code,{children:"null"})," if not found."]}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-3",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.getObject\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"getprops",children:"getProps()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"getProps(): GuestProps<Partial<ScriptingObjectTypes>, Events>;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"returns-6",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/app-sdk/api/interfaces/GuestProps",children:(0,r.jsx)(n.code,{children:"GuestProps"})}),"<",(0,r.jsx)(n.code,{children:"Partial"}),"<",(0,r.jsx)(n.code,{children:"ScriptingObjectTypes"}),">, ",(0,r.jsx)(n.code,{children:"Events"}),">"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"getref",children:(0,r.jsx)(n.del,{children:"getRef()"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"getRef<T>(): T | null;\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Retrieves a generic reference of type ",(0,r.jsx)(n.code,{children:"T"}),"."]}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters-4",children:"Type Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"t",children:"T"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"T"})}),"\n",(0,r.jsx)(n.h4,{id:"returns-7",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"T"})," | ",(0,r.jsx)(n.code,{children:"null"})]}),"\n",(0,r.jsxs)(n.p,{children:["The reference of type ",(0,r.jsx)(n.code,{children:"T"})," or ",(0,r.jsx)(n.code,{children:"null"})," if not available."]}),"\n",(0,r.jsx)(n.h4,{id:"deprecated",children:"Deprecated"}),"\n",(0,r.jsx)(n.p,{children:"This method is deprecated and will be removed in future versions."}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-4",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.getRef\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"init",children:"init()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"init(options: InitOptions<AppObjects, AppEvents>): Promise<void>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Initializes the microapp with the provided options."}),"\n",(0,r.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"options-1",children:"options"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"InitOptions"}),"<",(0,r.jsx)(n.code,{children:"AppObjects"}),", ",(0,r.jsx)(n.code,{children:"AppEvents"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"Options for initializing the microapp."}),"\n",(0,r.jsx)(n.h4,{id:"returns-8",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"A promise that resolves when initialization is complete."}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-5",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.init\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"initialize",children:"initialize()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"initialize(): Promise<ModuleParameters>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Guest-initiated lifecycle: discovers the host and applies module\nparameters if available. After this resolves the guest is ready to render.\nRequires selfInitialize: true in the constructor so the bridge\nskips calling init() / mount() on this guest."}),"\n",(0,r.jsx)(n.p,{children:"The module scripting object is optional \u2014 if the host did not register\none, a warning is logged and the guest proceeds with its own config."}),"\n",(0,r.jsx)(n.h4,{id:"returns-9",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"ModuleParameters"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"module parameters provided by the host, or a minimal object with moduleId"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"mount",children:"mount()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"mount(options?: MountOptions): Promise<void>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Mounts the microapp with the provided options."}),"\n",(0,r.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"options-2",children:"options?"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"MountOptions"})," = ",(0,r.jsx)(n.code,{children:"..."})]}),"\n",(0,r.jsx)(n.p,{children:"Options for mounting the microapp."}),"\n",(0,r.jsx)(n.h4,{id:"returns-10",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"A promise that resolves when the microapp is successfully mounted."}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-6",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.mount\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"navigate",children:"navigate()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"navigate(url: To, state?: any): void;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Navigates the microapp to a specified URL with an optional state."}),"\n",(0,r.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"url",children:"url"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"To"})}),"\n",(0,r.jsx)(n.p,{children:"The target URL to navigate to."}),"\n",(0,r.jsx)(n.h5,{id:"state",children:"state?"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"any"})}),"\n",(0,r.jsx)(n.p,{children:"Optional state to pass during navigation."}),"\n",(0,r.jsx)(n.h4,{id:"returns-11",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-7",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.navigate\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"removescriptingobject",children:"removeScriptingObject()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"removeScriptingObject(objectId: Extract<keyof AppObjects, string>): void;\n"})}),"\n",(0,r.jsx)(n.p,{children:"removes scripting object from child microapp use"}),"\n",(0,r.jsx)(n.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"objectid-2",children:"objectId"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Extract"}),"<keyof ",(0,r.jsx)(n.code,{children:"AppObjects"}),", ",(0,r.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"unique id of the scripting object"}),"\n",(0,r.jsx)(n.h4,{id:"returns-12",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-8",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.removeScriptingObject\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"subscribe",children:"subscribe()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"subscribe<EventId>(params: SubscribeParam<EventId, AppEvents[EventId]>): string;\n"})}),"\n",(0,r.jsx)(n.p,{children:"subscribe to the scripting object event"}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters-5",children:"Type Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"eventid-1",children:"EventId"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"EventId"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-7",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"params-3",children:"params"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"SubscribeParam"}),"<",(0,r.jsx)(n.code,{children:"EventId"}),", ",(0,r.jsx)(n.code,{children:"AppEvents"}),"[",(0,r.jsx)(n.code,{children:"EventId"}),"]>"]}),"\n",(0,r.jsx)(n.p,{children:"the parameters for the subscription"}),"\n",(0,r.jsx)(n.h4,{id:"returns-13",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"string"})}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-9",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.subscribe\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"unmount",children:"unmount()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"unmount(options: MountOptions): Promise<JSONValue>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Unmounts the microapp with the provided options."}),"\n",(0,r.jsx)(n.h4,{id:"parameters-8",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"options-3",children:"options"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"MountOptions"})}),"\n",(0,r.jsx)(n.p,{children:"Options for unmounting the microapp."}),"\n",(0,r.jsx)(n.h4,{id:"returns-14",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"JSONValue"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"A promise that resolves to a JSON value upon successful unmounting."}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-10",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.unmount\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"unsubscribe",children:"unsubscribe()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"unsubscribe<EventId>(params: UnsubscribeParam<EventId>): void;\n"})}),"\n",(0,r.jsx)(n.p,{children:"unsubscribe from the scripting object event"}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters-6",children:"Type Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"eventid-2",children:"EventId"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"EventId"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-9",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"params-4",children:"params"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"UnsubscribeParam"}),"<",(0,r.jsx)(n.code,{children:"EventId"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"parameters for the unsubscription"}),"\n",(0,r.jsx)(n.h4,{id:"returns-15",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-11",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.unsubscribe\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"getinstance",children:"getInstance()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"static getInstance<AppObjects, AppEvents>(params?: ConstructorParams): CMicroAppGuest<AppObjects, AppEvents>;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters-7",children:"Type Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"appobjects-1",children:"AppObjects"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"AppObjects"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"ScriptingObjects"})," = ",(0,r.jsx)(n.code,{children:"Partial"}),"<",(0,r.jsx)(n.code,{children:"ScriptingObjectTypes"}),">"]}),"\n",(0,r.jsx)(n.h5,{id:"appevents-1",children:"AppEvents"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"AppEvents"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"EventListeners"})," = ",(0,r.jsx)(n.code,{children:"Events"})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-10",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"params-5",children:"params?"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"ConstructorParams"})}),"\n",(0,r.jsx)(n.h4,{id:"returns-16",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"CMicroAppGuest"}),"<",(0,r.jsx)(n.code,{children:"AppObjects"}),", ",(0,r.jsx)(n.code,{children:"AppEvents"}),">"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ishosted",children:"isHosted()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"static isHosted(): boolean;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"returns-17",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"boolean"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"isinitialized",children:"isInitialized()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"static isInitialized(): boolean;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"returns-18",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"boolean"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},5589(e,n,s){s.d(n,{R:()=>l,x:()=>d});var i=s(758);const r={},t=i.createContext(r);function l(e){const n=i.useContext(t);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:l(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/f72c86d0.d74270de.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[6209],{8600(e,t,a){a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>r,default:()=>d,frontMatter:()=>i,metadata:()=>n,toc:()=>l});const n=JSON.parse('{"id":"api/type-aliases/RootState","title":"RootState","description":"","source":"@site/docs/api/type-aliases/RootState.md","sourceDirName":"api/type-aliases","slug":"/api/type-aliases/RootState","permalink":"/app-sdk/api/type-aliases/RootState","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/type-aliases/RootState.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"OnUnMountCallback","permalink":"/app-sdk/api/type-aliases/OnUnMountCallback"},"next":{"title":"SelectStateFieldFunction\\\\<TState, Selected\\\\>","permalink":"/app-sdk/api/type-aliases/SelectStateFieldFunction"}}');var o=a(6070),s=a(5589);const i={},r="RootState",p={},l=[];function c(e){const t={code:"code",h1:"h1",header:"header",pre:"pre",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.header,{children:(0,o.jsx)(t.h1,{id:"rootstate",children:"RootState"})}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-ts",children:"type RootState = ReturnType<typeof rootReducer>;\n"})})]})}function d(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(c,{...e})}):c(e)}},5589(e,t,a){a.d(t,{R:()=>i,x:()=>r});var n=a(758);const o={},s=n.createContext(o);function i(e){const t=n.useContext(s);return n.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),n.createElement(s.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/f8fa0321.c4c3a620.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[1022],{1521(e,n,r){r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>d,default:()=>p,frontMatter:()=>i,metadata:()=>s,toc:()=>c});const s=JSON.parse('{"id":"api/functions/renderHook","title":"renderHook()","description":"Allows you to render a hook within a test React component without having to","source":"@site/docs/api/functions/renderHook.md","sourceDirName":"api/functions","slug":"/api/functions/renderHook","permalink":"/app-sdk/api/functions/renderHook","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/renderHook.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"render()","permalink":"/app-sdk/api/functions/render"},"next":{"title":"renderWithHostData()","permalink":"/app-sdk/api/functions/renderWithHostData"}}');var o=r(6070),t=r(5589);const i={},d="renderHook()",l={},c=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Result",id:"result",level:3},{value:"Props",id:"props",level:3},{value:"Q",id:"q",level:3},{value:"Container",id:"container",level:3},{value:"BaseElement",id:"baseelement",level:3},{value:"Parameters",id:"parameters",level:2},{value:"render",id:"render",level:3},{value:"options?",id:"options",level:3},{value:"Returns",id:"returns",level:2}];function a(e){const n={code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,t.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"renderhook",children:"renderHook()"})}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-ts",children:"function renderHook<Result, Props, Q, Container, BaseElement>(render: (initialProps: Props) => Result, options?: RenderHookOptions<Props, Q, Container, BaseElement>): RenderHookResult<Result, Props>;\n"})}),"\n",(0,o.jsx)(n.p,{children:"Allows you to render a hook within a test React component without having to\ncreate that component yourself."}),"\n",(0,o.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,o.jsx)(n.h3,{id:"result",children:"Result"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.code,{children:"Result"})}),"\n",(0,o.jsx)(n.h3,{id:"props",children:"Props"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.code,{children:"Props"})}),"\n",(0,o.jsx)(n.h3,{id:"q",children:"Q"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Q"})," ",(0,o.jsx)(n.em,{children:"extends"})," ",(0,o.jsx)(n.code,{children:"Queries"})," = ",(0,o.jsx)(n.code,{children:"__module"})]}),"\n",(0,o.jsx)(n.h3,{id:"container",children:"Container"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Container"})," ",(0,o.jsx)(n.em,{children:"extends"})," ",(0,o.jsx)(n.code,{children:"Element"})," | ",(0,o.jsx)(n.code,{children:"DocumentFragment"})," = ",(0,o.jsx)(n.code,{children:"HTMLElement"})]}),"\n",(0,o.jsx)(n.h3,{id:"baseelement",children:"BaseElement"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"BaseElement"})," ",(0,o.jsx)(n.em,{children:"extends"})," ",(0,o.jsx)(n.code,{children:"Element"})," | ",(0,o.jsx)(n.code,{children:"DocumentFragment"})," = ",(0,o.jsx)(n.code,{children:"Container"})]}),"\n",(0,o.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsx)(n.h3,{id:"render",children:"render"}),"\n",(0,o.jsxs)(n.p,{children:["(",(0,o.jsx)(n.code,{children:"initialProps"}),": ",(0,o.jsx)(n.code,{children:"Props"}),") => ",(0,o.jsx)(n.code,{children:"Result"})]}),"\n",(0,o.jsx)(n.h3,{id:"options",children:"options?"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"RenderHookOptions"}),"<",(0,o.jsx)(n.code,{children:"Props"}),", ",(0,o.jsx)(n.code,{children:"Q"}),", ",(0,o.jsx)(n.code,{children:"Container"}),", ",(0,o.jsx)(n.code,{children:"BaseElement"}),">"]}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"RenderHookResult"}),"<",(0,o.jsx)(n.code,{children:"Result"}),", ",(0,o.jsx)(n.code,{children:"Props"}),">"]})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(a,{...e})}):a(e)}},5589(e,n,r){r.d(n,{R:()=>i,x:()=>d});var s=r(758);const o={},t=s.createContext(o);function i(e){const n=s.useContext(t);return s.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/fc7c782f.bc0ad1ab.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[3753],{4026(e,t,a){a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>r,default:()=>d,frontMatter:()=>c,metadata:()=>i,toc:()=>o});const i=JSON.parse('{"id":"api/variables/act","title":"act","description":"Simply calls ReactDOMTestUtils.act(cb)","source":"@site/docs/api/variables/act.md","sourceDirName":"api/variables","slug":"/api/variables/act","permalink":"/app-sdk/api/variables/act","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/variables/act.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"WaitMessage","permalink":"/app-sdk/api/variables/WaitMessage"},"next":{"title":"ariaLive","permalink":"/app-sdk/api/variables/ariaLive"}}');var s=a(6070),n=a(5589);const c={},r="act",l={},o=[];function p(e){const t={code:"code",h1:"h1",header:"header",p:"p",pre:"pre",...(0,n.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.header,{children:(0,s.jsx)(t.h1,{id:"act",children:"act"})}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-ts",children:"const act: typeof reactAct extends undefined ? (callback: () => void) => void : typeof reactAct;\n"})}),"\n",(0,s.jsx)(t.p,{children:"Simply calls ReactDOMTestUtils.act(cb)\nIf that's not available (older version of react) then it\nsimply calls the given callback immediately"})]})}function d(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},5589(e,t,a){a.d(t,{R:()=>c,x:()=>r});var i=a(758);const s={},n=i.createContext(s);function c(e){const t=i.useContext(n);return i.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),i.createElement(n.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/fce396bf.9f7f818c.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[7943],{9227(e,t,r){r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>d,frontMatter:()=>s,metadata:()=>n,toc:()=>p});const n=JSON.parse('{"id":"api/functions/withAppDecorator","title":"withAppDecorator()","description":"Parameters","source":"@site/docs/api/functions/withAppDecorator.md","sourceDirName":"api/functions","slug":"/api/functions/withAppDecorator","permalink":"/app-sdk/api/functions/withAppDecorator","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/withAppDecorator.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"waitForElementToBeRemoved()","permalink":"/app-sdk/api/functions/waitForElementToBeRemoved"},"next":{"title":"AppConfig","permalink":"/app-sdk/api/interfaces/AppConfig"}}');var o=r(6070),i=r(5589);const s={},a="withAppDecorator()",c={},p=[{value:"Parameters",id:"parameters",level:2},{value:"theme",id:"theme",level:3},{value:"store",id:"store",level:3},{value:"story",id:"story",level:3},{value:"Returns",id:"returns",level:2}];function l(e){const t={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.header,{children:(0,o.jsx)(t.h1,{id:"withappdecorator",children:"withAppDecorator()"})}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-ts",children:"function withAppDecorator(\n   theme: Theme, \n   store: ToolkitStore, \n   story: StoreFn): Element;\n"})}),"\n",(0,o.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsx)(t.h3,{id:"theme",children:"theme"}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.code,{children:"Theme"})}),"\n",(0,o.jsx)(t.h3,{id:"store",children:"store"}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.code,{children:"ToolkitStore"})}),"\n",(0,o.jsx)(t.h3,{id:"story",children:"story"}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.code,{children:"StoreFn"})}),"\n",(0,o.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.code,{children:"Element"})})]})}function d(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},5589(e,t,r){r.d(t,{R:()=>s,x:()=>a});var n=r(758);const o={},i=n.createContext(o);function s(e){const t=n.useContext(i);return n.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),n.createElement(i.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/fdb0d9e1.d2893206.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[552],{2031(e,n,i){i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>d,frontMatter:()=>o,metadata:()=>t,toc:()=>c});const t=JSON.parse('{"id":"api/functions/setAppConfig","title":"setAppConfig()","description":"Sets the entire application configuration.","source":"@site/docs/api/functions/setAppConfig.md","sourceDirName":"api/functions","slug":"/api/functions/setAppConfig","permalink":"/app-sdk/api/functions/setAppConfig","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/setAppConfig.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"sendMessageToHost()","permalink":"/app-sdk/api/functions/sendMessageToHost"},"next":{"title":"setAppConfigValue()","permalink":"/app-sdk/api/functions/setAppConfigValue"}}');var p=i(6070),s=i(5589);const o={},a="setAppConfig()",r={},c=[{value:"Parameters",id:"parameters",level:2},{value:"config",id:"config",level:3},{value:"Returns",id:"returns",level:2},{value:"Example",id:"example",level:2}];function l(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,p.jsxs)(p.Fragment,{children:[(0,p.jsx)(n.header,{children:(0,p.jsx)(n.h1,{id:"setappconfig",children:"setAppConfig()"})}),"\n",(0,p.jsx)(n.pre,{children:(0,p.jsx)(n.code,{className:"language-ts",children:"function setAppConfig(config: AppConfig): void;\n"})}),"\n",(0,p.jsx)(n.p,{children:"Sets the entire application configuration.\nReplaces the current configuration with the provided config object."}),"\n",(0,p.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,p.jsx)(n.h3,{id:"config",children:"config"}),"\n",(0,p.jsx)(n.p,{children:(0,p.jsx)(n.a,{href:"/app-sdk/api/interfaces/AppConfig",children:(0,p.jsx)(n.code,{children:"AppConfig"})})}),"\n",(0,p.jsx)(n.p,{children:"The complete application configuration"}),"\n",(0,p.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,p.jsx)(n.p,{children:(0,p.jsx)(n.code,{children:"void"})}),"\n",(0,p.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,p.jsx)(n.pre,{children:(0,p.jsx)(n.code,{className:"language-typescript",children:"setAppConfig({\n  appId: 'my-app',\n  activeEnv: 'production',\n  serviceEndpoints: {\n    api: 'https://api.example.com',\n    idp: 'https://auth.example.com'\n  },\n  env: {...}\n});\n"})})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,p.jsx)(n,{...e,children:(0,p.jsx)(l,{...e})}):l(e)}},5589(e,n,i){i.d(n,{R:()=>o,x:()=>a});var t=i(758);const p={},s=t.createContext(p);function o(e){const n=t.useContext(s);return t.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(p):e.components||p:o(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/fed4ae4f.e788c07f.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[9712],{8417(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":"Subscribes to session reset events.","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(5589);const o={},c="subscribeToResetSession()",a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"onResetListener",id:"onresetlistener",level:3},{value:"Returns",id:"returns",level:2},{value:"Example",id:"example",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:"Subscribes to session reset events.\nThe callback is invoked when the session idle time 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:"Callback function that receives reset modal flag"}),"\n",(0,t.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(s.p,{children:"Unsubscribe function to remove the listener"}),"\n",(0,t.jsxs)(s.p,{children:["(...",(0,t.jsx)(s.code,{children:"args"}),": []) => ",(0,t.jsx)(s.code,{children:"void"})]}),"\n",(0,t.jsx)(s.h2,{id:"example",children:"Example"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-typescript",children:"subscribeToResetSession((shouldResetModal) => {\n  if (shouldResetModal) {\n    closeWarningModal();\n  }\n});\n"})})]})}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)}},5589(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)}}}]);

package/build/docs/assets/js/fefe9566.113c5960.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[1877],{7090(e,t,r){r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>n,default:()=>m,frontMatter:()=>a,metadata:()=>o,toc:()=>l});const o=JSON.parse('{"id":"api/variables/memoryHistory","title":"memoryHistory","description":"","source":"@site/docs/api/variables/memoryHistory.md","sourceDirName":"api/variables","slug":"/api/variables/memoryHistory","permalink":"/app-sdk/api/variables/memoryHistory","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/variables/memoryHistory.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"logout","permalink":"/app-sdk/api/variables/logout"},"next":{"title":"removeSideEffect","permalink":"/app-sdk/api/variables/removeSideEffect"}}');var i=r(6070),s=r(5589);const a={},n="memoryHistory",c={},l=[];function p(e){const t={code:"code",h1:"h1",header:"header",pre:"pre",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.header,{children:(0,i.jsx)(t.h1,{id:"memoryhistory",children:"memoryHistory"})}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-ts",children:"const memoryHistory: MemoryHistory;\n"})})]})}function m(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},5589(e,t,r){r.d(t,{R:()=>a,x:()=>n});var o=r(758);const i={},s=o.createContext(i);function a(e){const t=o.useContext(s);return o.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function n(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),o.createElement(s.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/ff0bf96e.e457283e.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[429],{6903(e,t,n){n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>d,frontMatter:()=>s,metadata:()=>r,toc:()=>c});const r=JSON.parse('{"id":"api/variables/fireEvent","title":"fireEvent","description":"","source":"@site/docs/api/variables/fireEvent.md","sourceDirName":"api/variables","slug":"/api/variables/fireEvent","permalink":"/app-sdk/api/variables/fireEvent","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/variables/fireEvent.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"errorMiddleware","permalink":"/app-sdk/api/variables/errorMiddleware"},"next":{"title":"globalConstants","permalink":"/app-sdk/api/variables/globalConstants"}}');var i=n(6070),a=n(5589);const s={},o="fireEvent",l={},c=[];function p(e){const t={code:"code",h1:"h1",header:"header",pre:"pre",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.header,{children:(0,i.jsx)(t.h1,{id:"fireevent",children:"fireEvent"})}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-ts",children:"const fireEvent: FireFunction & FireObject;\n"})})]})}function d(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},5589(e,t,n){n.d(t,{R:()=>s,x:()=>o});var r=n(758);const i={},a=r.createContext(i);function s(e){const t=r.useContext(a);return r.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),r.createElement(a.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/ff6d65a9.39317a08.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[1768],{3098(e,n,t){t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>l,frontMatter:()=>a,metadata:()=>r,toc:()=>p});const r=JSON.parse('{"id":"api/functions/CheckBox","title":"CheckBox()","description":"Parameters","source":"@site/docs/api/functions/CheckBox.md","sourceDirName":"api/functions","slug":"/api/functions/CheckBox","permalink":"/app-sdk/api/functions/CheckBox","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/CheckBox.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"Autocomplete()","permalink":"/app-sdk/api/functions/Autocomplete"},"next":{"title":"ComboBox()","permalink":"/app-sdk/api/functions/ComboBox"}}');var s=t(6070),o=t(5589);const a={},i="CheckBox()",c={},p=[{value:"Parameters",id:"parameters",level:2},{value:"__namedParameters",id:"__namedparameters",level:3},{value:"Returns",id:"returns",level:2}];function d(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"checkbox",children:"CheckBox()"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"function CheckBox(__namedParameters: CheckBoxProps): Element;\n"})}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsx)(n.h3,{id:"__namedparameters",children:"__namedParameters"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"CheckBoxProps"})}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"Element"})})]})}function l(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},5589(e,n,t){t.d(n,{R:()=>a,x:()=>i});var r=t(758);const s={},o=r.createContext(s);function a(e){const n=r.useContext(o);return r.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]);