@elliemae/pui-app-sdk 5.48.1 → 5.48.2

package/build/docs/assets/js/3b0e1261.8b607451.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[6051],{8225(e,r,t){t.r(r),t.d(r,{assets:()=>s,contentTitle:()=>a,default:()=>l,frontMatter:()=>o,metadata:()=>n,toc:()=>c});const n=JSON.parse('{"id":"api/variables/MicroApp","title":"~~MicroApp~~","description":"Component to render a guest microapp","source":"@site/docs/api/variables/MicroApp.md","sourceDirName":"api/variables","slug":"/api/variables/MicroApp","permalink":"/app-sdk/api/variables/MicroApp","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/variables/MicroApp.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"MASK\\\\_TYPES","permalink":"/app-sdk/api/variables/MASK_TYPES"},"next":{"title":"~~MicroIFrameApp~~","permalink":"/app-sdk/api/variables/MicroIFrameApp"}}');var i=t(6070),p=t(5676);const o={},a="MicroApp",s={},c=[{value:"Deprecated",id:"deprecated",level:2}];function d(e){const r={code:"code",del:"del",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,p.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(r.header,{children:(0,i.jsx)(r.h1,{id:"microapp",children:(0,i.jsx)(r.del,{children:"MicroApp"})})}),"\n",(0,i.jsx)(r.pre,{children:(0,i.jsx)(r.code,{className:"language-ts",children:"const MicroApp: NamedExoticComponent<MicroAppProps>;\n"})}),"\n",(0,i.jsx)(r.p,{children:"Component to render a guest microapp"}),"\n",(0,i.jsx)(r.h2,{id:"deprecated",children:"Deprecated"}),"\n",(0,i.jsxs)(r.p,{children:["This component is deprecated and will be removed in future versions.\nUse the ",(0,i.jsx)(r.code,{children:"GuestMicroApp"})," component instead."]})]})}function l(e={}){const{wrapper:r}={...(0,p.R)(),...e.components};return r?(0,i.jsx)(r,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},5676(e,r,t){t.d(r,{R:()=>o,x:()=>a});var n=t(758);const i={},p=n.createContext(i);function o(e){const r=n.useContext(p);return n.useMemo(function(){return"function"==typeof e?e(r):{...r,...e}},[r,e])}function a(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),n.createElement(p.Provider,{value:r},e.children)}}}]);

package/build/docs/assets/js/3b333d5b.d27f2abc.js

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

package/build/docs/assets/js/3cb0b0a9.6631cb21.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[7255],{2163(e,s,n){n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>t,metadata:()=>i,toc:()=>p});const i=JSON.parse('{"id":"api/functions/subscribeToSessionExpiry","title":"subscribeToSessionExpiry()","description":"Registers a callback when idle time crosses the expiry threshold.","source":"@site/docs/api/functions/subscribeToSessionExpiry.md","sourceDirName":"api/functions","slug":"/api/functions/subscribeToSessionExpiry","permalink":"/app-sdk/api/functions/subscribeToSessionExpiry","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/functions/subscribeToSessionExpiry.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"subscribeToResetSession()","permalink":"/app-sdk/api/functions/subscribeToResetSession"},"next":{"title":"subscribeToSessionExpiryWarning()","permalink":"/app-sdk/api/functions/subscribeToSessionExpiryWarning"}}');var r=n(6070),o=n(5676);const t={},c="subscribeToSessionExpiry()",a={},p=[{value:"Parameters",id:"parameters",level:2},{value:"onSessionExpiry",id:"onsessionexpiry",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,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.header,{children:(0,r.jsx)(s.h1,{id:"subscribetosessionexpiry",children:"subscribeToSessionExpiry()"})}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ts",children:"function subscribeToSessionExpiry(onSessionExpiry: LISTENER): (...args: []) => void;\n"})}),"\n",(0,r.jsx)(s.p,{children:"Registers a callback when idle time crosses the expiry threshold."}),"\n",(0,r.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsx)(s.h3,{id:"onsessionexpiry",children:"onSessionExpiry"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"LISTENER"})}),"\n",(0,r.jsx)(s.p,{children:"Invoked once when the session should end."}),"\n",(0,r.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:"Unsubscribe function."}),"\n",(0,r.jsxs)(s.p,{children:["(...",(0,r.jsx)(s.code,{children:"args"}),": []) => ",(0,r.jsx)(s.code,{children:"void"})]})]})}function u(e={}){const{wrapper:s}={...(0,o.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},5676(e,s,n){n.d(s,{R:()=>t,x:()=>c});var i=n(758);const r={},o=i.createContext(r);function t(e){const s=i.useContext(o);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(r):e.components||r:t(e.components),i.createElement(o.Provider,{value:s},e.children)}}}]);

package/build/docs/assets/js/3cd01694.8013af74.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[2923],{5359(e,n,r){r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>l,frontMatter:()=>a,metadata:()=>s,toc:()=>c});const s=JSON.parse('{"id":"api/functions/sdkBaseQuery","title":"sdkBaseQuery()","description":"Base query function for RTK Query integration.","source":"@site/docs/api/functions/sdkBaseQuery.md","sourceDirName":"api/functions","slug":"/api/functions/sdkBaseQuery","permalink":"/app-sdk/api/functions/sdkBaseQuery","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/functions/sdkBaseQuery.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"renderWithRouterRedux()","permalink":"/app-sdk/api/functions/renderWithRouterRedux"},"next":{"title":"~~sendBAEvent()~~","permalink":"/app-sdk/api/functions/sendBAEvent"}}');var t=r(6070),i=r(5676);const a={},o="sdkBaseQuery()",d={},c=[{value:"Parameters",id:"parameters",level:2},{value:"config?",id:"config",level:3},{value:"authorization?",id:"authorization",level:4},{value:"baseUrl?",id:"baseurl",level:4},{value:"Returns",id:"returns",level:2},{value:"Examples",id:"examples",level:2}];function u(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"sdkbasequery",children:"sdkBaseQuery()"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"function sdkBaseQuery(config?: {\n  authorization?: string;\n  baseUrl?: string;\n}): BaseQueryFunction;\n"})}),"\n",(0,t.jsx)(n.p,{children:"Base query function for RTK Query integration.\nProvides automatic error handling, authentication, and token refresh capabilities.\nUse this as the baseQuery for RTK Query API slices."}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsx)(n.h3,{id:"config",children:"config?"}),"\n",(0,t.jsx)(n.p,{children:"Configuration options"}),"\n",(0,t.jsx)(n.h4,{id:"authorization",children:"authorization?"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"string"})}),"\n",(0,t.jsx)(n.p,{children:"Authorization token applied to every request;\noverrides the session-stored token. Per-endpoint headers still take precedence."}),"\n",(0,t.jsx)(n.h4,{id:"baseurl",children:"baseUrl?"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"string"})}),"\n",(0,t.jsx)(n.p,{children:"Base URL for API requests"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"BaseQueryFunction"})}),"\n",(0,t.jsx)(n.p,{children:"RTK Query base query function"}),"\n",(0,t.jsx)(n.h2,{id:"examples",children:"Examples"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-typescript",children:"import { createApi } from '@reduxjs/toolkit/query/react';\n\nconst api = createApi({\n  reducerPath: 'api',\n  baseQuery: sdkBaseQuery({ baseUrl: 'https://api.example.com' }),\n  endpoints: (builder) => ({\n    getUser: builder.query({\n      query: (id) => ({ url: `/users/${id}`, method: 'GET' })\n    })\n  })\n});\n"})}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Passing a custom authorization token at the slice level:"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-typescript",children:"const api = createApi({\n  reducerPath: 'api',\n  baseQuery: sdkBaseQuery({\n    baseUrl: 'https://api.example.com',\n    authorization: 'Bearer my-custom-token',\n  }),\n  endpoints: (builder) => ({\n    getUser: builder.query({\n      query: (id) => ({ url: `/users/${id}`, method: 'GET' })\n    })\n  })\n});\n"})}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Overriding the token for a specific endpoint via headers:"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-typescript",children:"const api = createApi({\n  reducerPath: 'api',\n  baseQuery: sdkBaseQuery({ baseUrl: 'https://api.example.com' }),\n  endpoints: (builder) => ({\n    getUser: builder.query({\n      query: (id) => ({\n        url: `/users/${id}`,\n        method: 'GET',\n        headers: { Authorization: 'Bearer per-endpoint-token' },\n      })\n    })\n  })\n});\n"})})]})}function l(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},5676(e,n,r){r.d(n,{R:()=>a,x:()=>o});var s=r(758);const t={},i=s.createContext(t);function a(e){const n=s.useContext(i);return s.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(t):e.components||t:a(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/413bfdf1.a4aaea1f.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[8600],{7372(e,n,t){t.r(n),t.d(n,{assets:()=>p,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>s,toc:()=>c});const s=JSON.parse('{"id":"api/functions/InputMask","title":"InputMask()","description":"Parameters","source":"@site/docs/api/functions/InputMask.md","sourceDirName":"api/functions","slug":"/api/functions/InputMask","permalink":"/app-sdk/api/functions/InputMask","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/functions/InputMask.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"FormSubmitButton()","permalink":"/app-sdk/api/functions/FormSubmitButton"},"next":{"title":"InputText()","permalink":"/app-sdk/api/functions/InputText"}}');var r=t(6070),a=t(5676);const i={},o="InputMask()",p={},c=[{value:"Parameters",id:"parameters",level:2},{value:"__namedParameters",id:"__namedparameters",level:3},{value:"Returns",id:"returns",level:2}];function u(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"inputmask",children:"InputMask()"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"function InputMask(__namedParameters: InputMaskProps): Element;\n"})}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsx)(n.h3,{id:"__namedparameters",children:"__namedParameters"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"InputMaskProps"})}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"Element"})})]})}function d(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},5676(e,n,t){t.d(n,{R:()=>i,x:()=>o});var s=t(758);const r={},a=s.createContext(r);function i(e){const n=s.useContext(a);return s.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(r):e.components||r:i(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/41f4ce7f.381f9467.js

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

package/build/docs/assets/js/46eb403d.9803c7a7.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[2181],{6148(e,n,t){t.r(n),t.d(n,{assets:()=>u,contentTitle:()=>c,default:()=>d,frontMatter:()=>r,metadata:()=>s,toc:()=>a});const s=JSON.parse('{"id":"api/functions/SessionTimeout","title":"SessionTimeout()","description":"Returns","source":"@site/docs/api/functions/SessionTimeout.md","sourceDirName":"api/functions","slug":"/api/functions/SessionTimeout","permalink":"/app-sdk/api/functions/SessionTimeout","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/functions/SessionTimeout.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"RequireAuth()","permalink":"/app-sdk/api/functions/RequireAuth"},"next":{"title":"TextBox()","permalink":"/app-sdk/api/functions/TextBox"}}');var i=t(6070),o=t(5676);const r={},c="SessionTimeout()",u={},a=[{value:"Returns",id:"returns",level:2}];function p(e){const n={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"sessiontimeout",children:"SessionTimeout()"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function SessionTimeout(): Element;\n"})}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"Element"})})]})}function d(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},5676(e,n,t){t.d(n,{R:()=>r,x:()=>c});var s=t(758);const i={},o=s.createContext(i);function r(e){const n=s.useContext(o);return s.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/47f7a134.b496cd35.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[5726],{7380(e,n,t){t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>l,frontMatter:()=>s,metadata:()=>a,toc:()=>c});const a=JSON.parse('{"id":"api/functions/Radio","title":"Radio()","description":"Parameters","source":"@site/docs/api/functions/Radio.md","sourceDirName":"api/functions","slug":"/api/functions/Radio","permalink":"/app-sdk/api/functions/Radio","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/functions/Radio.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"Page()","permalink":"/app-sdk/api/functions/Page"},"next":{"title":"RadioGroup()","permalink":"/app-sdk/api/functions/RadioGroup"}}');var r=t(6070),i=t(5676);const s={},o="Radio()",d={},c=[{value:"Parameters",id:"parameters",level:2},{value:"__namedParameters",id:"__namedparameters",level:3},{value:"Returns",id:"returns",level:2}];function p(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"radio",children:"Radio()"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"function Radio(__namedParameters: RadioProps): Element;\n"})}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsx)(n.h3,{id:"__namedparameters",children:"__namedParameters"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"RadioProps"})}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"Element"})})]})}function l(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},5676(e,n,t){t.d(n,{R:()=>s,x:()=>o});var a=t(758);const r={},i=a.createContext(r);function s(e){const n=a.useContext(i);return a.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(r):e.components||r:s(e.components),a.createElement(i.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/4acce17e.dc49d76f.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[6582],{3299(e,t,n){n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>l,frontMatter:()=>o,metadata:()=>s,toc:()=>d});const s=JSON.parse('{"id":"api/functions/isUserAuthorized","title":"isUserAuthorized()","description":"Checks if the user is currently authorized/authenticated.","source":"@site/docs/api/functions/isUserAuthorized.md","sourceDirName":"api/functions","slug":"/api/functions/isUserAuthorized","permalink":"/app-sdk/api/functions/isUserAuthorized","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/functions/isUserAuthorized.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"isProd()","permalink":"/app-sdk/api/functions/isProd"},"next":{"title":"listenStorageEvents()","permalink":"/app-sdk/api/functions/listenStorageEvents"}}');var i=n(6070),r=n(5676);const o={},a="isUserAuthorized()",c={},d=[{value:"Returns",id:"returns",level:2},{value:"Example",id:"example",level:2}];function u(e){const t={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.header,{children:(0,i.jsx)(t.h1,{id:"isuserauthorized",children:"isUserAuthorized()"})}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-ts",children:"function isUserAuthorized(): boolean;\n"})}),"\n",(0,i.jsx)(t.p,{children:"Checks if the user is currently authorized/authenticated."}),"\n",(0,i.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.code,{children:"boolean"})}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.code,{children:"true"})," if user has a valid authorization header, ",(0,i.jsx)(t.code,{children:"false"})," otherwise"]}),"\n",(0,i.jsx)(t.h2,{id:"example",children:"Example"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-typescript",children:"if (isUserAuthorized()) {\n  // User is logged in\n}\n"})})]})}function l(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(u,{...e})}):u(e)}},5676(e,t,n){n.d(t,{R:()=>o,x:()=>a});var s=n(758);const i={},r=s.createContext(i);function o(e){const t=s.useContext(r);return s.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(i):e.components||i:o(e.components),s.createElement(r.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/4b10ac31.751afbad.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[9814],{4142(e,t,n){n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>o,frontMatter:()=>i,metadata:()=>s,toc:()=>p});const s=JSON.parse('{"id":"api/functions/getHostAppDataByKey","title":"getHostAppDataByKey()","description":"Type Parameters","source":"@site/docs/api/functions/getHostAppDataByKey.md","sourceDirName":"api/functions","slug":"/api/functions/getHostAppDataByKey","permalink":"/app-sdk/api/functions/getHostAppDataByKey","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/functions/getHostAppDataByKey.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"getHTTPClient()","permalink":"/app-sdk/api/functions/getHTTPClient"},"next":{"title":"getLogger()","permalink":"/app-sdk/api/functions/getLogger"}}');var a=n(6070),r=n(5676);const i={},l="getHostAppDataByKey()",d={},p=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"T",id:"t",level:3},{value:"Parameters",id:"parameters",level:2},{value:"key?",id:"key",level:3},{value:"defaultValue?",id:"defaultvalue",level:3},{value:"Returns",id:"returns",level:2}];function c(e){const t={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.header,{children:(0,a.jsx)(t.h1,{id:"gethostappdatabykey",children:"getHostAppDataByKey()"})}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-ts",children:"function getHostAppDataByKey<T>(key?: string, defaultValue?: null): T;\n"})}),"\n",(0,a.jsx)(t.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,a.jsx)(t.h3,{id:"t",children:"T"}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.code,{children:"T"})}),"\n",(0,a.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,a.jsx)(t.h3,{id:"key",children:"key?"}),"\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.code,{children:"string"})," = ",(0,a.jsx)(t.code,{children:"''"})]}),"\n",(0,a.jsx)(t.h3,{id:"defaultvalue",children:"defaultValue?"}),"\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.code,{children:"null"})," = ",(0,a.jsx)(t.code,{children:"null"})]}),"\n",(0,a.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.code,{children:"T"})})]})}function o(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(c,{...e})}):c(e)}},5676(e,t,n){n.d(t,{R:()=>i,x:()=>l});var s=n(758);const a={},r=s.createContext(a);function i(e){const t=s.useContext(r);return s.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:i(e.components),s.createElement(r.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/4eef183e.897071da.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[1628],{9592(n,e,t){t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>r,default:()=>u,frontMatter:()=>a,metadata:()=>i,toc:()=>p});const i=JSON.parse('{"id":"api/functions/getNavigationLinks","title":"getNavigationLinks()","description":"Returns","source":"@site/docs/api/functions/getNavigationLinks.md","sourceDirName":"api/functions","slug":"/api/functions/getNavigationLinks","permalink":"/app-sdk/api/functions/getNavigationLinks","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/functions/getNavigationLinks.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"getMicroFrontEndAppConfig()","permalink":"/app-sdk/api/functions/getMicroFrontEndAppConfig"},"next":{"title":"getRedirectUrl()","permalink":"/app-sdk/api/functions/getRedirectUrl"}}');var s=t(6070),o=t(5676);const a={},r="getNavigationLinks()",c={},p=[{value:"Returns",id:"returns",level:2}];function d(n){const e={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,o.R)(),...n.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(e.header,{children:(0,s.jsx)(e.h1,{id:"getnavigationlinks",children:"getNavigationLinks()"})}),"\n",(0,s.jsx)(e.pre,{children:(0,s.jsx)(e.code,{className:"language-ts",children:"function getNavigationLinks(): NavLinks;\n"})}),"\n",(0,s.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(e.p,{children:(0,s.jsx)(e.code,{children:"NavLinks"})})]})}function u(n={}){const{wrapper:e}={...(0,o.R)(),...n.components};return e?(0,s.jsx)(e,{...n,children:(0,s.jsx)(d,{...n})}):d(n)}},5676(n,e,t){t.d(e,{R:()=>a,x:()=>r});var i=t(758);const s={},o=i.createContext(s);function a(n){const e=i.useContext(o);return i.useMemo(function(){return"function"==typeof n?n(e):{...e,...n}},[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:a(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]);

package/build/docs/assets/js/50ae2c89.8e99854b.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[4346],{5702(e,t,l){l.r(t),l.d(t,{assets:()=>r,contentTitle:()=>a,default:()=>h,frontMatter:()=>i,metadata:()=>s,toc:()=>d});const s=JSON.parse('{"id":"api/functions/useStateSelectorShallow","title":"useStateSelectorShallow()","description":"Generic selector that receives a field selector function returned from getSelectField.","source":"@site/docs/api/functions/useStateSelectorShallow.md","sourceDirName":"api/functions","slug":"/api/functions/useStateSelectorShallow","permalink":"/app-sdk/api/functions/useStateSelectorShallow","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/functions/useStateSelectorShallow.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"useStateSelector()","permalink":"/app-sdk/api/functions/useStateSelector"},"next":{"title":"waitFor()","permalink":"/app-sdk/api/functions/waitFor"}}');var n=l(6070),c=l(5676);const i={},a="useStateSelectorShallow()",r={},d=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"TState",id:"tstate",level:3},{value:"Selected",id:"selected",level:3},{value:"Parameters",id:"parameters",level:2},{value:"selectStateFieldFunc",id:"selectstatefieldfunc",level:3},{value:"fieldName?",id:"fieldname",level:3},{value:"opts?",id:"opts",level:3},{value:"Returns",id:"returns",level:2},{value:"See",id:"see",level:2}];function o(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,c.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.header,{children:(0,n.jsx)(t.h1,{id:"usestateselectorshallow",children:"useStateSelectorShallow()"})}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-ts",children:"function useStateSelectorShallow<TState, Selected>(\n   selectStateFieldFunc: SelectStateFieldFunction<TState, Selected>, \n   fieldName?: string | string[], \n   opts?: UseStateSelectorOptions<Selected>): Selected;\n"})}),"\n",(0,n.jsx)(t.p,{children:"Generic selector that receives a field selector function returned from getSelectField."}),"\n",(0,n.jsx)(t.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,n.jsx)(t.h3,{id:"tstate",children:"TState"}),"\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.code,{children:"TState"})," = ",(0,n.jsx)(t.code,{children:"unknown"})]}),"\n",(0,n.jsx)(t.h3,{id:"selected",children:"Selected"}),"\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.code,{children:"Selected"})," = ",(0,n.jsx)(t.code,{children:"unknown"})]}),"\n",(0,n.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsx)(t.h3,{id:"selectstatefieldfunc",children:"selectStateFieldFunc"}),"\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.a,{href:"/app-sdk/api/type-aliases/SelectStateFieldFunction",children:(0,n.jsx)(t.code,{children:"SelectStateFieldFunction"})}),"<",(0,n.jsx)(t.code,{children:"TState"}),", ",(0,n.jsx)(t.code,{children:"Selected"}),">"]}),"\n",(0,n.jsx)(t.p,{children:"the store state's field selector function"}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-javascript",children:" // reducer.js\nimport { getSelectField } from 'elliemae/pui-app-sdk';\n\nconst name = 'someState';\nexport selectStateFieldFunc = getSelectField(name);\n"})}),"\n",(0,n.jsx)(t.h3,{id:"fieldname",children:"fieldName?"}),"\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.code,{children:"string"})," | ",(0,n.jsx)(t.code,{children:"string"}),"[]"]}),"\n",(0,n.jsx)(t.p,{children:"the state's field you want to acccess, this accepts nested objects access, like so 'rootObj.childObj.field'"}),"\n",(0,n.jsx)(t.h3,{id:"opts",children:"opts?"}),"\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.a,{href:"/app-sdk/api/interfaces/UseStateSelectorOptions",children:(0,n.jsx)(t.code,{children:"UseStateSelectorOptions"})}),"<",(0,n.jsx)(t.code,{children:"Selected"}),"> = ",(0,n.jsx)(t.code,{children:"{}"})]}),"\n",(0,n.jsx)(t.p,{children:"options (defaultValue, equalityFn = shallowEqual)"}),"\n",(0,n.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.code,{children:"Selected"})}),"\n",(0,n.jsx)(t.h2,{id:"see",children:"See"}),"\n",(0,n.jsx)(t.p,{children:"/lib/api/helpers.ts#getSelectField"}),"\n",(0,n.jsx)(t.p,{children:"This is the same as useStateSelector with shallowEqual as default for equalityFn option."})]})}function h(e={}){const{wrapper:t}={...(0,c.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(o,{...e})}):o(e)}},5676(e,t,l){l.d(t,{R:()=>i,x:()=>a});var s=l(758);const n={},c=s.createContext(n);function i(e){const t=s.useContext(c);return s.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(n):e.components||n:i(e.components),s.createElement(c.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/50b500dc.658066cf.js

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

package/build/docs/assets/js/5113883b.8e91098c.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[1230],{1970(e,r,i){i.r(r),i.d(r,{assets:()=>d,contentTitle:()=>c,default:()=>l,frontMatter:()=>a,metadata:()=>n,toc:()=>p});const n=JSON.parse('{"id":"api/functions/RegisterService","title":"RegisterService()","description":"Type Parameters","source":"@site/docs/api/functions/RegisterService.md","sourceDirName":"api/functions","slug":"/api/functions/RegisterService","permalink":"/app-sdk/api/functions/RegisterService","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/functions/RegisterService.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"RadioGroup()","permalink":"/app-sdk/api/functions/RadioGroup"},"next":{"title":"RenderWithStateAddOns()","permalink":"/app-sdk/api/functions/RenderWithStateAddOns"}}');var t=i(6070),s=i(5676);const a={},c="RegisterService()",d={},p=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"T",id:"t",level:3},{value:"Parameters",id:"parameters",level:2},{value:"appId",id:"appid",level:3},{value:"ServiceName",id:"servicename",level:3},{value:"Returns",id:"returns",level:2}];function o(e){const r={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.header,{children:(0,t.jsx)(r.h1,{id:"registerservice",children:"RegisterService()"})}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-ts",children:"function RegisterService<T>(appId: string, ServiceName: () => T): () => void;\n"})}),"\n",(0,t.jsx)(r.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,t.jsx)(r.h3,{id:"t",children:"T"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.code,{children:"T"})}),"\n",(0,t.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsx)(r.h3,{id:"appid",children:"appId"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.code,{children:"string"})}),"\n",(0,t.jsx)(r.h3,{id:"servicename",children:"ServiceName"}),"\n",(0,t.jsxs)(r.p,{children:["() => ",(0,t.jsx)(r.code,{children:"T"})]}),"\n",(0,t.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(r.p,{children:["() => ",(0,t.jsx)(r.code,{children:"void"})]})]})}function l(e={}){const{wrapper:r}={...(0,s.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(o,{...e})}):o(e)}},5676(e,r,i){i.d(r,{R:()=>a,x:()=>c});var n=i(758);const t={},s=n.createContext(t);function a(e){const r=n.useContext(s);return n.useMemo(function(){return"function"==typeof e?e(r):{...r,...e}},[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:a(e.components),n.createElement(s.Provider,{value:r},e.children)}}}]);

package/build/docs/assets/js/51cd08ce.e434c019.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[3728],{9757(e,n,a){a.r(n),a.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>u,frontMatter:()=>c,metadata:()=>s,toc:()=>l});const s=JSON.parse('{"id":"api/functions/useInjectSaga","title":"useInjectSaga()","description":"A react hook that dynamically injects a saga when the hook is run","source":"@site/docs/api/functions/useInjectSaga.md","sourceDirName":"api/functions","slug":"/api/functions/useInjectSaga","permalink":"/app-sdk/api/functions/useInjectSaga","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/functions/useInjectSaga.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"useInjectReducer()","permalink":"/app-sdk/api/functions/useInjectReducer"},"next":{"title":"useInjectSideEffect()","permalink":"/app-sdk/api/functions/useInjectSideEffect"}}');var t=a(6070),i=a(5676);const c={},r="useInjectSaga()",o={},l=[{value:"Parameters",id:"parameters",level:2},{value:"options",id:"options",level:3},{value:"key",id:"key",level:4},{value:"saga",id:"saga",level:4},{value:"Returns",id:"returns",level:2},{value:"See",id:"see",level:2},{value:"Example",id:"example",level:2}];function d(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"useinjectsaga",children:"useInjectSaga()"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"function useInjectSaga(options: {\n  key: string;\n  saga: Saga;\n}): boolean;\n"})}),"\n",(0,t.jsx)(n.p,{children:"A react hook that dynamically injects a saga when the hook is run"}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsx)(n.h3,{id:"options",children:"options"}),"\n",(0,t.jsx)(n.h4,{id:"key",children:"key"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"string"})}),"\n",(0,t.jsx)(n.p,{children:"The key to inject the saga under"}),"\n",(0,t.jsx)(n.h4,{id:"saga",children:"saga"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"Saga"})}),"\n",(0,t.jsx)(n.p,{children:"The saga that will be injected"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"boolean"})}),"\n",(0,t.jsx)(n.p,{children:"flag indicating whether or not the saga has finished injecting"}),"\n",(0,t.jsx)(n.h2,{id:"see",children:"See"}),"\n",(0,t.jsx)(n.p,{children:"SagaInjectionModes for the other possible modes."}),"\n",(0,t.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:'function BooksManager() {\n useInjectSaga({ key: "books", saga: booksSaga })\n\n return null;\n}\n'})})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},5676(e,n,a){a.d(n,{R:()=>c,x:()=>r});var s=a(758);const t={},i=s.createContext(t);function c(e){const n=s.useContext(i);return s.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/533e434c.ffdd9efd.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[1099],{9801(e,n,s){s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>d,metadata:()=>i,toc:()=>o});const i=JSON.parse('{"id":"api/classes/GuestModule","title":"GuestModule","description":"Default IModule implementation backed by a static parameters object.","source":"@site/docs/api/classes/GuestModule.md","sourceDirName":"api/classes","slug":"/api/classes/GuestModule","permalink":"/app-sdk/api/classes/GuestModule","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/classes/GuestModule.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"ErrorBoundary","permalink":"/app-sdk/api/classes/ErrorBoundary"},"next":{"title":"AppRoot()","permalink":"/app-sdk/api/functions/AppRoot"}}');var l=s(6070),r=s(5676);const d={},t="GuestModule",a={},o=[{value:"Extends",id:"extends",level:2},{value:"Implements",id:"implements",level:2},{value:"Accessors",id:"accessors",level:2},{value:"id",id:"id",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:"Inherited from",id:"inherited-from",level:4},{value:"objectType",id:"objecttype",level:3},{value:"Get Signature",id:"get-signature-1",level:4},{value:"Returns",id:"returns-1",level:5},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Constructors",id:"constructors",level:2},{value:"Constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"guestId",id:"guestid",level:5},{value:"params?",id:"params",level:5},{value:"Returns",id:"returns-2",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Methods",id:"methods",level:2},{value:"_setUnloadHandler()",id:"_setunloadhandler",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"handler",id:"handler",level:5},{value:"Returns",id:"returns-3",level:4},{value:"getCapabilities()",id:"getcapabilities",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"getParameters()",id:"getparameters",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Implementation of",id:"implementation-of-3",level:4},{value:"log()",id:"log",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"message",id:"message",level:5},{value:"logLevel",id:"loglevel",level:5},{value:"Returns",id:"returns-6",level:4},{value:"Implementation of",id:"implementation-of-4",level:4},{value:"unload()",id:"unload",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Implementation of",id:"implementation-of-5",level:4},{value:"Properties",id:"properties",level:2},{value:"_dispose",id:"_dispose",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Implementation of",id:"implementation-of-6",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"_toJSON",id:"_tojson",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Implementation of",id:"implementation-of-7",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Close",id:"close",level:3},{value:"Implementation of",id:"implementation-of-8",level:4},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Unloading",id:"unloading",level:3},{value:"Implementation of",id:"implementation-of-9",level:4},{value:"Unmount",id:"unmount",level:3},{value:"Implementation of",id:"implementation-of-10",level:4}];function c(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",li:"li",p:"p",pre:"pre",ul:"ul",...(0,r.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(n.header,{children:(0,l.jsx)(n.h1,{id:"guestmodule",children:"GuestModule"})}),"\n",(0,l.jsxs)(n.p,{children:["Default IModule implementation backed by a static parameters object.\nHosts can instantiate this directly or use the ",(0,l.jsx)(n.a,{href:"/app-sdk/api/functions/createGuestModule",children:"createGuestModule"}),"\nfactory for a terser API."]}),"\n",(0,l.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:(0,l.jsx)(n.code,{children:"ScriptingObject"})}),"\n"]}),"\n",(0,l.jsx)(n.h2,{id:"implements",children:"Implements"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:(0,l.jsx)(n.code,{children:"IModule"})}),"\n"]}),"\n",(0,l.jsx)(n.h2,{id:"accessors",children:"Accessors"}),"\n",(0,l.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,l.jsx)(n.h4,{id:"get-signature",children:"Get Signature"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"get id(): string;\n"})}),"\n",(0,l.jsx)(n.p,{children:"get unique id of the scripting object"}),"\n",(0,l.jsx)(n.h5,{id:"returns",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"string"})}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IModule.id\n"})}),"\n",(0,l.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"ScriptingObject.id\n"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"objecttype",children:"objectType"}),"\n",(0,l.jsx)(n.h4,{id:"get-signature-1",children:"Get Signature"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"get objectType(): string;\n"})}),"\n",(0,l.jsx)(n.p,{children:"get type of the scripting object"}),"\n",(0,l.jsx)(n.h5,{id:"returns-1",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"string"})}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of-1",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IModule.objectType\n"})}),"\n",(0,l.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"ScriptingObject.objectType\n"})}),"\n",(0,l.jsx)(n.h2,{id:"constructors",children:"Constructors"}),"\n",(0,l.jsx)(n.h3,{id:"constructor",children:"Constructor"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"new GuestModule(guestId: string, params?: HostProvidedParams): GuestModule;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,l.jsx)(n.h5,{id:"guestid",children:"guestId"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"string"})}),"\n",(0,l.jsx)(n.h5,{id:"params",children:"params?"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.a,{href:"/app-sdk/api/type-aliases/HostProvidedParams",children:(0,l.jsx)(n.code,{children:"HostProvidedParams"})})," = ",(0,l.jsx)(n.code,{children:"{}"})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"GuestModule"})}),"\n",(0,l.jsx)(n.h4,{id:"overrides",children:"Overrides"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"ScriptingObject.constructor\n"})}),"\n",(0,l.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,l.jsx)(n.h3,{id:"_setunloadhandler",children:"_setUnloadHandler()"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"_setUnloadHandler(handler: () => Promise<void>): void;\n"})}),"\n",(0,l.jsx)(n.p,{children:"Bind the teardown logic that runs when the guest calls unload().\nPrefixed with _ so SSF's for\u2026in discovery skips it.\nThe App Bridge auto-binds this in openApp()."}),"\n",(0,l.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,l.jsx)(n.h5,{id:"handler",children:"handler"}),"\n",(0,l.jsxs)(n.p,{children:["() => ",(0,l.jsx)(n.code,{children:"Promise"}),"<",(0,l.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,l.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"getcapabilities",children:"getCapabilities()"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"getCapabilities(): Promise<Record<string, unknown>>;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"Promise"}),"<",(0,l.jsx)(n.code,{children:"Record"}),"<",(0,l.jsx)(n.code,{children:"string"}),", ",(0,l.jsx)(n.code,{children:"unknown"}),">>"]}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of-2",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IModule.getCapabilities\n"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"getparameters",children:"getParameters()"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"getParameters(): Promise<ModuleParameters>;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"Promise"}),"<",(0,l.jsx)(n.code,{children:"ModuleParameters"}),">"]}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of-3",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IModule.getParameters\n"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"log",children:"log()"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:'log(message: string | LogMessage, logLevel: "DEBUG" | "INFO" | "AUDIT" | "WARN" | "ERROR" | "FATAL"): Promise<void>;\n'})}),"\n",(0,l.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,l.jsx)(n.h5,{id:"message",children:"message"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"string"})," | ",(0,l.jsx)(n.code,{children:"LogMessage"})]}),"\n",(0,l.jsx)(n.h5,{id:"loglevel",children:"logLevel"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:'"DEBUG"'})," | ",(0,l.jsx)(n.code,{children:'"INFO"'})," | ",(0,l.jsx)(n.code,{children:'"AUDIT"'})," | ",(0,l.jsx)(n.code,{children:'"WARN"'})," | ",(0,l.jsx)(n.code,{children:'"ERROR"'})," | ",(0,l.jsx)(n.code,{children:'"FATAL"'})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-6",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"Promise"}),"<",(0,l.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of-4",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IModule.log\n"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"unload",children:"unload()"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"unload(): Promise<void>;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"returns-7",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"Promise"}),"<",(0,l.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of-5",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IModule.unload\n"})}),"\n",(0,l.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,l.jsx)(n.h3,{id:"_dispose",children:"_dispose"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"_dispose: () => void;\n"})}),"\n",(0,l.jsx)(n.p,{children:"dispose the scripting object"}),"\n",(0,l.jsx)(n.h4,{id:"returns-8",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of-6",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IModule._dispose\n"})}),"\n",(0,l.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"ScriptingObject._dispose\n"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"_tojson",children:"_toJSON"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"_toJSON: () => RemotingScriptingObject;\n"})}),"\n",(0,l.jsx)(n.p,{children:"transform the scripting object to a format suitable for transmitting over window.postMessage"}),"\n",(0,l.jsx)(n.h4,{id:"returns-9",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"RemotingScriptingObject"})}),"\n",(0,l.jsx)(n.p,{children:"marshalled scripting object"}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of-7",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IModule._toJSON\n"})}),"\n",(0,l.jsx)(n.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"ScriptingObject._toJSON\n"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"close",children:"Close"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"readonly Close: Event<Events>;\n"})}),"\n",(0,l.jsx)(n.p,{children:"event fired when the module to be closed"}),"\n",(0,l.jsx)(n.p,{children:"Use ModuleCloseListener to handle this event"}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of-8",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IModule.Close\n"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"dispose",children:"dispose"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"dispose: () => void;\n"})}),"\n",(0,l.jsx)(n.p,{children:"dispose the scripting object"}),"\n",(0,l.jsx)(n.h4,{id:"returns-10",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"ScriptingObject.dispose\n"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"unloading",children:"Unloading"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"readonly Unloading: Event<Events>;\n"})}),"\n",(0,l.jsx)(n.p,{children:"event fired when the module is unloading (veto \u2014 apps may return false)"}),"\n",(0,l.jsx)(n.p,{children:"Use ModuleUnLoadingListener to handle this event"}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of-9",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IModule.Unloading\n"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"unmount",children:"Unmount"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"readonly Unmount: Event<Events>;\n"})}),"\n",(0,l.jsx)(n.p,{children:"event fired after unload veto passes (SDK teardown \u2014 not a veto)"}),"\n",(0,l.jsx)(n.p,{children:"Use ModuleUnmountListener to handle this event"}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of-10",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IModule.Unmount\n"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(c,{...e})}):c(e)}},5676(e,n,s){s.d(n,{R:()=>d,x:()=>t});var i=s(758);const l={},r=i.createContext(l);function d(e){const n=i.useContext(r);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:d(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/53defe29.745c6300.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[5886],{3995(e,n,t){t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>c,frontMatter:()=>r,metadata:()=>i,toc:()=>d});const i=JSON.parse('{"id":"api/functions/notifyGuestUnloadComplete","title":"notifyGuestUnloadComplete()","description":"Parameters","source":"@site/docs/api/functions/notifyGuestUnloadComplete.md","sourceDirName":"api/functions","slug":"/api/functions/notifyGuestUnloadComplete","permalink":"/app-sdk/api/functions/notifyGuestUnloadComplete","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/functions/notifyGuestUnloadComplete.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"login()","permalink":"/app-sdk/api/functions/login"},"next":{"title":"onAuthorizationFailure()","permalink":"/app-sdk/api/functions/onAuthorizationFailure"}}');var o=t(6070),s=t(5676);const r={},a="notifyGuestUnloadComplete()",l={},d=[{value:"Parameters",id:"parameters",level:2},{value:"guestAppConfirmation",id:"guestappconfirmation",level:3},{value:"guestAppId",id:"guestappid",level:3},{value:"unloadType?",id:"unloadtype",level:3},{value:"Returns",id:"returns",level:2}];function p(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"notifyguestunloadcomplete",children:"notifyGuestUnloadComplete()"})}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-ts",children:"function notifyGuestUnloadComplete(\n   guestAppConfirmation: string, \n   guestAppId: string, \n   unloadType?: string): void;\n"})}),"\n",(0,o.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsx)(n.h3,{id:"guestappconfirmation",children:"guestAppConfirmation"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.code,{children:"string"})}),"\n",(0,o.jsx)(n.h3,{id:"guestappid",children:"guestAppId"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.code,{children:"string"})}),"\n",(0,o.jsx)(n.h3,{id:"unloadtype",children:"unloadType?"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"string"})," = ",(0,o.jsx)(n.code,{children:"'close_loan'"})]}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.code,{children:"void"})})]})}function c(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},5676(e,n,t){t.d(n,{R:()=>r,x:()=>a});var i=t(758);const o={},s=i.createContext(o);function r(e){const n=i.useContext(s);return i.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(o):e.components||o:r(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/54dea6f0.a8adba98.js

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

package/build/docs/assets/js/550f7dc1.c0d84a69.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[1394],{987(e,t,n){n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>p,frontMatter:()=>i,metadata:()=>r,toc:()=>o});const r=JSON.parse('{"id":"api/functions/RenderWithStateAddOns","title":"RenderWithStateAddOns()","description":"Parameters","source":"@site/docs/api/functions/RenderWithStateAddOns.md","sourceDirName":"api/functions","slug":"/api/functions/RenderWithStateAddOns","permalink":"/app-sdk/api/functions/RenderWithStateAddOns","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/functions/RenderWithStateAddOns.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"RegisterService()","permalink":"/app-sdk/api/functions/RegisterService"},"next":{"title":"RequireAuth()","permalink":"/app-sdk/api/functions/RequireAuth"}}');var s=n(6070),d=n(5676);const i={},a="RenderWithStateAddOns()",c={},o=[{value:"Parameters",id:"parameters",level:2},{value:"__namedParameters",id:"__namedparameters",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,d.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.header,{children:(0,s.jsx)(t.h1,{id:"renderwithstateaddons",children:"RenderWithStateAddOns()"})}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-ts",children:"function RenderWithStateAddOns(__namedParameters: RenderWithStateAddOnsProps): Element | null;\n"})}),"\n",(0,s.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsx)(t.h3,{id:"__namedparameters",children:"__namedParameters"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.code,{children:"RenderWithStateAddOnsProps"})}),"\n",(0,s.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.code,{children:"Element"})," | ",(0,s.jsx)(t.code,{children:"null"})]})]})}function p(e={}){const{wrapper:t}={...(0,d.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},5676(e,t,n){n.d(t,{R:()=>i,x:()=>a});var r=n(758);const s={},d=r.createContext(s);function i(e){const t=r.useContext(d);return r.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(s):e.components||s:i(e.components),r.createElement(d.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/5575829c.9c5b3b5f.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[9111],{5708(e,t,n){n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>r,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>a});const s=JSON.parse('{"id":"api/functions/useStateSelector","title":"useStateSelector()","description":"Generic selector that receives a field selector function returned from getSelectField","source":"@site/docs/api/functions/useStateSelector.md","sourceDirName":"api/functions","slug":"/api/functions/useStateSelector","permalink":"/app-sdk/api/functions/useStateSelector","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/functions/useStateSelector.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"useMediaQueryList()","permalink":"/app-sdk/api/functions/useMediaQueryList"},"next":{"title":"useStateSelectorShallow()","permalink":"/app-sdk/api/functions/useStateSelectorShallow"}}');var c=n(6070),l=n(5676);const i={},r="useStateSelector()",d={},a=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"TState",id:"tstate",level:3},{value:"Selected",id:"selected",level:3},{value:"Parameters",id:"parameters",level:2},{value:"selectStateFieldFunc",id:"selectstatefieldfunc",level:3},{value:"fieldName?",id:"fieldname",level:3},{value:"opts?",id:"opts",level:3},{value:"Returns",id:"returns",level:2},{value:"See",id:"see",level:2}];function o(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,l.R)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(t.header,{children:(0,c.jsx)(t.h1,{id:"usestateselector",children:"useStateSelector()"})}),"\n",(0,c.jsx)(t.pre,{children:(0,c.jsx)(t.code,{className:"language-ts",children:"function useStateSelector<TState, Selected>(\n   selectStateFieldFunc: SelectStateFieldFunction<TState, Selected>, \n   fieldName?: string | string[], \n   opts?: UseStateSelectorOptions<Selected>): Selected;\n"})}),"\n",(0,c.jsx)(t.p,{children:"Generic selector that receives a field selector function returned from getSelectField"}),"\n",(0,c.jsx)(t.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,c.jsx)(t.h3,{id:"tstate",children:"TState"}),"\n",(0,c.jsxs)(t.p,{children:[(0,c.jsx)(t.code,{children:"TState"})," = ",(0,c.jsx)(t.code,{children:"unknown"})]}),"\n",(0,c.jsx)(t.h3,{id:"selected",children:"Selected"}),"\n",(0,c.jsxs)(t.p,{children:[(0,c.jsx)(t.code,{children:"Selected"})," = ",(0,c.jsx)(t.code,{children:"unknown"})]}),"\n",(0,c.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,c.jsx)(t.h3,{id:"selectstatefieldfunc",children:"selectStateFieldFunc"}),"\n",(0,c.jsxs)(t.p,{children:[(0,c.jsx)(t.a,{href:"/app-sdk/api/type-aliases/SelectStateFieldFunction",children:(0,c.jsx)(t.code,{children:"SelectStateFieldFunction"})}),"<",(0,c.jsx)(t.code,{children:"TState"}),", ",(0,c.jsx)(t.code,{children:"Selected"}),">"]}),"\n",(0,c.jsx)(t.p,{children:"the store state's field selector function"}),"\n",(0,c.jsx)(t.pre,{children:(0,c.jsx)(t.code,{className:"language-javascript",children:" // reducer.js\nimport { getSelectField } from 'elliemae/pui-app-sdk';\n\nconst name = 'someState';\nexport selectStateFieldFunc = getSelectField(name);\n"})}),"\n",(0,c.jsx)(t.h3,{id:"fieldname",children:"fieldName?"}),"\n",(0,c.jsxs)(t.p,{children:[(0,c.jsx)(t.code,{children:"string"})," | ",(0,c.jsx)(t.code,{children:"string"}),"[]"]}),"\n",(0,c.jsx)(t.p,{children:"the state's field you want to acccess, this accepts nested objects access, like so 'rootObj.childObj.field'"}),"\n",(0,c.jsx)(t.h3,{id:"opts",children:"opts?"}),"\n",(0,c.jsxs)(t.p,{children:[(0,c.jsx)(t.a,{href:"/app-sdk/api/interfaces/UseStateSelectorOptions",children:(0,c.jsx)(t.code,{children:"UseStateSelectorOptions"})}),"<",(0,c.jsx)(t.code,{children:"Selected"}),"> = ",(0,c.jsx)(t.code,{children:"{}"})]}),"\n",(0,c.jsx)(t.p,{children:"options (defaultValue, equalityFn)"}),"\n",(0,c.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,c.jsx)(t.p,{children:(0,c.jsx)(t.code,{children:"Selected"})}),"\n",(0,c.jsx)(t.h2,{id:"see",children:"See"}),"\n",(0,c.jsx)(t.p,{children:"/lib/api/helpers.ts#getSelectField"})]})}function u(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,c.jsx)(t,{...e,children:(0,c.jsx)(o,{...e})}):o(e)}},5676(e,t,n){n.d(t,{R:()=>i,x:()=>r});var s=n(758);const c={},l=s.createContext(c);function i(e){const t=s.useContext(l);return s.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(c):e.components||c:i(e.components),s.createElement(l.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/58e12487.73bc34a4.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[9763],{6493(e,n,t){t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>l,default:()=>d,frontMatter:()=>r,metadata:()=>a,toc:()=>o});const a=JSON.parse('{"id":"api/type-aliases/OnInitCallback","title":"OnInitCallback","description":"Parameters","source":"@site/docs/api/type-aliases/OnInitCallback.md","sourceDirName":"api/type-aliases","slug":"/api/type-aliases/OnInitCallback","permalink":"/app-sdk/api/type-aliases/OnInitCallback","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/type-aliases/OnInitCallback.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"OnHostInitCallback","permalink":"/app-sdk/api/type-aliases/OnHostInitCallback"},"next":{"title":"OnMountCallback","permalink":"/app-sdk/api/type-aliases/OnMountCallback"}}');var s=t(6070),i=t(5676);const r={},l="OnInitCallback",c={},o=[{value:"Parameters",id:"parameters",level:2},{value:"options",id:"options",level:3},{value:"Returns",id:"returns",level:2}];function p(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"oninitcallback",children:"OnInitCallback"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"type OnInitCallback = (options: GuestProps) => void;\n"})}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsx)(n.h3,{id:"options",children:"options"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/app-sdk/api/interfaces/GuestProps",children:(0,s.jsx)(n.code,{children:"GuestProps"})})}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})})]})}function d(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},5676(e,n,t){t.d(n,{R:()=>r,x:()=>l});var a=t(758);const s={},i=a.createContext(s);function r(e){const n=a.useContext(i);return a.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),a.createElement(i.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/59169cbb.35f2707e.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[7460],{1998(n,e,t){t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>p,default:()=>l,frontMatter:()=>s,metadata:()=>i,toc:()=>a});const i=JSON.parse('{"id":"api/functions/getMicroFrontEndAppConfig","title":"getMicroFrontEndAppConfig()","description":"Parameters","source":"@site/docs/api/functions/getMicroFrontEndAppConfig.md","sourceDirName":"api/functions","slug":"/api/functions/getMicroFrontEndAppConfig","permalink":"/app-sdk/api/functions/getMicroFrontEndAppConfig","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/functions/getMicroFrontEndAppConfig.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"getLogger()","permalink":"/app-sdk/api/functions/getLogger"},"next":{"title":"getNavigationLinks()","permalink":"/app-sdk/api/functions/getNavigationLinks"}}');var r=t(6070),o=t(5676);const s={},p="getMicroFrontEndAppConfig()",c={},a=[{value:"Parameters",id:"parameters",level:2},{value:"appInfo",id:"appinfo",level:3},{value:"id",id:"id",level:4},{value:"Returns",id:"returns",level:2}];function d(n){const e={code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",pre:"pre",...(0,o.R)(),...n.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(e.header,{children:(0,r.jsx)(e.h1,{id:"getmicrofrontendappconfig",children:"getMicroFrontEndAppConfig()"})}),"\n",(0,r.jsx)(e.pre,{children:(0,r.jsx)(e.code,{className:"language-ts",children:"function getMicroFrontEndAppConfig(appInfo: {\n  id: string;\n}): MicroAppConfig;\n"})}),"\n",(0,r.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsx)(e.h3,{id:"appinfo",children:"appInfo"}),"\n",(0,r.jsx)(e.h4,{id:"id",children:"id"}),"\n",(0,r.jsx)(e.p,{children:(0,r.jsx)(e.code,{children:"string"})}),"\n",(0,r.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(e.p,{children:(0,r.jsx)(e.code,{children:"MicroAppConfig"})})]})}function l(n={}){const{wrapper:e}={...(0,o.R)(),...n.components};return e?(0,r.jsx)(e,{...n,children:(0,r.jsx)(d,{...n})}):d(n)}},5676(n,e,t){t.d(e,{R:()=>s,x:()=>p});var i=t(758);const r={},o=i.createContext(r);function s(n){const e=i.useContext(o);return i.useMemo(function(){return"function"==typeof n?n(e):{...e,...n}},[e,n])}function p(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(r):n.components||r:s(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]);

package/build/docs/assets/js/5c5cf8ae.ba837ad2.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[9451],{9154(e,n,s){s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>d,metadata:()=>i,toc:()=>c});const i=JSON.parse('{"id":"api/classes/CMicroAppHost","title":"~~CMicroAppHost\\\\<AppObjects, AppEvents\\\\>~~","description":"Micro-frontend host application class (singleton).","source":"@site/docs/api/classes/CMicroAppHost.md","sourceDirName":"api/classes","slug":"/api/classes/CMicroAppHost","permalink":"/app-sdk/api/classes/CMicroAppHost","draft":false,"unlisted":false,"editUrl":"https://github.com/intcx/PLATFORM-UI.pui-app-sdk.git/docs/api/classes/CMicroAppHost.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"CMicroAppGuest\\\\<AppObjects, AppEvents\\\\>","permalink":"/app-sdk/api/classes/CMicroAppGuest"},"next":{"title":"ErrorBoundary","permalink":"/app-sdk/api/classes/ErrorBoundary"}}');var l=s(6070),r=s(5676);const d={},t="CMicroAppHost<AppObjects, AppEvents>",a={},c=[{value:"Deprecated",id:"deprecated",level:2},{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:"Methods",id:"methods",level:2},{value:"<del>addScriptingObject()</del>",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",level:4},{value:"Implementation of",id:"implementation-of",level:4},{value:"<del>closeWaitMessage()</del>",id:"closewaitmessage",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"<del>dispatchEvent()</del>",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:"<del>getAuthToken()</del>",id:"getauthtoken",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Implementation of",id:"implementation-of-3",level:4},{value:"<del>getBreakpoint()</del>",id:"getbreakpoint",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Implementation of",id:"implementation-of-4",level:4},{value:"<del>getGuest()</del>",id:"getguest",level:3},{value:"Type Parameters",id:"type-parameters-3",level:4},{value:"T",id:"t",level:5},{value:"Parameters",id:"parameters-2",level:4},{value:"id",id:"id",level:5},{value:"Returns",id:"returns-5",level:4},{value:"Implementation of",id:"implementation-of-5",level:4},{value:"<del>getGuests()</del>",id:"getguests",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Implementation of",id:"implementation-of-6",level:4},{value:"<del>getItem()</del>",id:"getitem",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"key",id:"key",level:5},{value:"Returns",id:"returns-7",level:4},{value:"Implementation of",id:"implementation-of-7",level:4},{value:"<del>getLogger()</del>",id:"getlogger",level:3},{value:"Returns",id:"returns-8",level:4},{value:"<del>getObject()</del>",id:"getobject",level:3},{value:"Type Parameters",id:"type-parameters-4",level:4},{value:"T",id:"t-1",level:5},{value:"Parameters",id:"parameters-4",level:4},{value:"name",id:"name",level:5},{value:"Returns",id:"returns-9",level:4},{value:"Implementation of",id:"implementation-of-8",level:4},{value:"<del>getProps()</del>",id:"getprops",level:3},{value:"Returns",id:"returns-10",level:4},{value:"<del>getViewportSize()</del>",id:"getviewportsize",level:3},{value:"Returns",id:"returns-11",level:4},{value:"<del>height</del>",id:"height",level:5},{value:"<del>width</del>",id:"width",level:5},{value:"Implementation of",id:"implementation-of-9",level:4},{value:"<del>initialize()</del>",id:"initialize",level:3},{value:"Returns",id:"returns-12",level:4},{value:"<del>logout()</del>",id:"logout",level:3},{value:"Returns",id:"returns-13",level:4},{value:"Implementation of",id:"implementation-of-10",level:4},{value:"<del>navigate()</del>",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-14",level:4},{value:"Implementation of",id:"implementation-of-11",level:4},{value:"<del>onBreakpointChangeEvent()</del>",id:"onbreakpointchangeevent",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"eventHandler",id:"eventhandler",level:5},{value:"Returns",id:"returns-15",level:4},{value:"Implementation of",id:"implementation-of-12",level:4},{value:"<del>onResizeEvent()</del>",id:"onresizeevent",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"eventHandler",id:"eventhandler-1",level:5},{value:"Returns",id:"returns-16",level:4},{value:"Implementation of",id:"implementation-of-13",level:4},{value:"<del>openErrorBanner()</del>",id:"openerrorbanner",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"message",id:"message",level:5},{value:"Returns",id:"returns-17",level:4},{value:"Implementation of",id:"implementation-of-14",level:4},{value:"<del>openWaitMessage()</del>",id:"openwaitmessage",level:3},{value:"Returns",id:"returns-18",level:4},{value:"Implementation of",id:"implementation-of-15",level:4},{value:"<del>publish()</del>",id:"publish",level:3},{value:"Type Parameters",id:"type-parameters-5",level:4},{value:"Type",id:"type",level:5},{value:"Parameters",id:"parameters-9",level:4},{value:"message",id:"message-1",level:5},{value:"data?",id:"data",level:5},{value:"Returns",id:"returns-19",level:4},{value:"Implementation of",id:"implementation-of-16",level:4},{value:"<del>removeScriptingObject()</del>",id:"removescriptingobject",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"objectId",id:"objectid",level:5},{value:"guestId?",id:"guestid",level:5},{value:"Returns",id:"returns-20",level:4},{value:"Implementation of",id:"implementation-of-17",level:4},{value:"<del>renewAuthToken()</del>",id:"renewauthtoken",level:3},{value:"Returns",id:"returns-21",level:4},{value:"Implementation of",id:"implementation-of-18",level:4},{value:"<del>renewSessionTimer()</del>",id:"renewsessiontimer",level:3},{value:"Returns",id:"returns-22",level:4},{value:"Implementation of",id:"implementation-of-19",level:4},{value:"<del>sendBAEvent()</del>",id:"sendbaevent",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"data",id:"data-1",level:5},{value:"Returns",id:"returns-23",level:4},{value:"Implementation of",id:"implementation-of-20",level:4},{value:"<del>setItem()</del>",id:"setitem",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"key",id:"key-1",level:5},{value:"value",id:"value",level:5},{value:"Returns",id:"returns-24",level:4},{value:"Implementation of",id:"implementation-of-21",level:4},{value:"<del>setSystemVersion()</del>",id:"setsystemversion",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"version?",id:"version",level:5},{value:"Returns",id:"returns-25",level:4},{value:"<del>subscribe()</del>",id:"subscribe",level:3},{value:"Type Parameters",id:"type-parameters-6",level:4},{value:"T",id:"t-2",level:5},{value:"Parameters",id:"parameters-14",level:4},{value:"message",id:"message-2",level:5},{value:"func",id:"func",level:5},{value:"Returns",id:"returns-26",level:4},{value:"Implementation of",id:"implementation-of-22",level:4},{value:"<del>unsubscribe()</del>",id:"unsubscribe",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"token",id:"token",level:5},{value:"Returns",id:"returns-27",level:4},{value:"Implementation of",id:"implementation-of-23",level:4},{value:"<del>getInstance()</del>",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-16",level:4},{value:"params?",id:"params-3",level:5},{value:"Returns",id:"returns-28",level:4},{value:"<del>isInitialized()</del>",id:"isinitialized",level:3},{value:"Returns",id:"returns-29",level:4},{value:"Properties",id:"properties",level:2},{value:"<del>activeGuests</del>",id:"activeguests",level:3},{value:"<del>scriptingObjects</del>",id:"scriptingobjects",level:3}];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,r.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(n.header,{children:(0,l.jsx)(n.h1,{id:"cmicroapphostappobjects-appevents",children:(0,l.jsx)(n.del,{children:"CMicroAppHost<AppObjects, AppEvents>"})})}),"\n",(0,l.jsx)(n.p,{children:"Micro-frontend host application class (singleton).\nManages hosting and coordination of multiple micro-frontend guest applications.\nProvides shared services like navigation, theming, analytics, and state management."}),"\n",(0,l.jsx)(n.h2,{id:"deprecated",children:"Deprecated"}),"\n",(0,l.jsxs)(n.p,{children:["Use ",(0,l.jsx)(n.a,{href:"/app-sdk/api/classes/CMicroAppGuest",children:"CMicroApp"})," instead. CMicroApp now supports\nboth guest and host use cases via ",(0,l.jsx)(n.code,{children:"selfInitialize: true"})," and ",(0,l.jsx)(n.code,{children:"initialize()"}),"."]}),"\n",(0,l.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-typescript",children:"const host = new CMicroAppHost({\n  version: '1.0.0',\n  history: browserHistory,\n  onInit: ({ history, theme }) => {\n    console.log('Host initialized');\n  },\n  scriptingObjects: {\n    customService: new CustomService()\n  }\n});\n"})}),"\n",(0,l.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,l.jsx)(n.h3,{id:"appobjects",children:"AppObjects"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"AppObjects"})," ",(0,l.jsx)(n.em,{children:"extends"})," ",(0,l.jsx)(n.code,{children:"ScriptingObjects"})," = ",(0,l.jsx)(n.code,{children:"Partial"}),"<",(0,l.jsx)(n.code,{children:"ScriptingObjectTypes"}),">"]}),"\n",(0,l.jsx)(n.p,{children:"Type of custom scripting objects"}),"\n",(0,l.jsx)(n.h3,{id:"appevents",children:"AppEvents"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"AppEvents"})," ",(0,l.jsx)(n.em,{children:"extends"})," ",(0,l.jsx)(n.code,{children:"EventListeners"})," = ",(0,l.jsx)(n.code,{children:"Events"})]}),"\n",(0,l.jsx)(n.p,{children:"Type of custom event listeners"}),"\n",(0,l.jsx)(n.h2,{id:"implements",children:"Implements"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.code,{children:"IMicroAppHost"}),"<",(0,l.jsx)(n.code,{children:"AppObjects"}),", ",(0,l.jsx)(n.code,{children:"AppEvents"}),">"]}),"\n"]}),"\n",(0,l.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,l.jsx)(n.h3,{id:"addscriptingobject",children:(0,l.jsx)(n.del,{children:"addScriptingObject()"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"addScriptingObject<SO>(so: SO, params?: AddScriptingObjectParams): void;\n"})}),"\n",(0,l.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,l.jsx)(n.h4,{id:"type-parameters-1",children:"Type Parameters"}),"\n",(0,l.jsx)(n.h5,{id:"so",children:"SO"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"SO"})," ",(0,l.jsx)(n.em,{children:"extends"})," ",(0,l.jsx)(n.code,{children:"IScriptingObject"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,l.jsx)(n.h5,{id:"so-1",children:"so"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"SO"})}),"\n",(0,l.jsx)(n.p,{children:"The scripting object to be added."}),"\n",(0,l.jsx)(n.h5,{id:"params",children:"params?"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"AddScriptingObjectParams"})}),"\n",(0,l.jsxs)(n.p,{children:["Optional parameters (e.g. ",(0,l.jsx)(n.code,{children:"{ guestId }"})," to scope to a specific guest)."]}),"\n",(0,l.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IMicroAppHost.addScriptingObject\n"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"closewaitmessage",children:(0,l.jsx)(n.del,{children:"closeWaitMessage()"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"closeWaitMessage(): void;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of-1",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IMicroAppHost.closeWaitMessage\n"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"dispatchevent",children:(0,l.jsx)(n.del,{children:"dispatchEvent()"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"dispatchEvent<EventId, Params, Options>(params: DispatchEventParam<EventId, Params, Options>): Promise<void | unknown[]>;\n"})}),"\n",(0,l.jsx)(n.p,{children:"dispatch event to child microapp"}),"\n",(0,l.jsx)(n.h4,{id:"type-parameters-2",children:"Type Parameters"}),"\n",(0,l.jsx)(n.h5,{id:"eventid",children:"EventId"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"EventId"})," ",(0,l.jsx)(n.em,{children:"extends"})," ",(0,l.jsx)(n.code,{children:"string"})]}),"\n",(0,l.jsx)(n.h5,{id:"params-1",children:"Params"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"Params"})," ",(0,l.jsx)(n.em,{children:"extends"})," ",(0,l.jsx)(n.code,{children:"any"})]}),"\n",(0,l.jsx)(n.h5,{id:"options",children:"Options"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"Options"})," ",(0,l.jsx)(n.em,{children:"extends"})," ",(0,l.jsx)(n.code,{children:"EventOptions"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,l.jsx)(n.h5,{id:"params-2",children:"params"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"DispatchEventParam"}),"<",(0,l.jsx)(n.code,{children:"EventId"}),", ",(0,l.jsx)(n.code,{children:"Params"}),", ",(0,l.jsx)(n.code,{children:"Options"}),">"]}),"\n",(0,l.jsx)(n.p,{children:"event parameters"}),"\n",(0,l.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"Promise"}),"<",(0,l.jsx)(n.code,{children:"void"})," | ",(0,l.jsx)(n.code,{children:"unknown"}),"[]>"]}),"\n",(0,l.jsx)(n.p,{children:"A promise that resolves with the combined results of dispatched events."}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of-2",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IMicroAppHost.dispatchEvent\n"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"getauthtoken",children:(0,l.jsx)(n.del,{children:"getAuthToken()"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"getAuthToken(): string;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"string"})}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of-3",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IMicroAppHost.getAuthToken\n"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"getbreakpoint",children:(0,l.jsx)(n.del,{children:"getBreakpoint()"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"getBreakpoint(): keyof BreakPoints;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:["keyof ",(0,l.jsx)(n.code,{children:"BreakPoints"})]}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of-4",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IMicroAppHost.getBreakpoint\n"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"getguest",children:(0,l.jsx)(n.del,{children:"getGuest()"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"getGuest<T>(id: string): T | null;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"type-parameters-3",children:"Type Parameters"}),"\n",(0,l.jsx)(n.h5,{id:"t",children:"T"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"T"})}),"\n",(0,l.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,l.jsx)(n.h5,{id:"id",children:"id"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"string"})}),"\n",(0,l.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"T"})," | ",(0,l.jsx)(n.code,{children:"null"})]}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of-5",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IMicroAppHost.getGuest\n"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"getguests",children:(0,l.jsx)(n.del,{children:"getGuests()"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"getGuests(): Record<string, unknown>;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"returns-6",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"Record"}),"<",(0,l.jsx)(n.code,{children:"string"}),", ",(0,l.jsx)(n.code,{children:"unknown"}),">"]}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of-6",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IMicroAppHost.getGuests\n"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"getitem",children:(0,l.jsx)(n.del,{children:"getItem()"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"getItem(key: string): string | null;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,l.jsx)(n.h5,{id:"key",children:"key"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"string"})}),"\n",(0,l.jsx)(n.h4,{id:"returns-7",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"string"})," | ",(0,l.jsx)(n.code,{children:"null"})]}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of-7",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IMicroAppHost.getItem\n"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"getlogger",children:(0,l.jsx)(n.del,{children:"getLogger()"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"getLogger(): MicroFrontEndLogger;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"returns-8",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"MicroFrontEndLogger"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"getobject",children:(0,l.jsx)(n.del,{children:"getObject()"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"getObject<T>(name: string): Promise<T>;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"type-parameters-4",children:"Type Parameters"}),"\n",(0,l.jsx)(n.h5,{id:"t-1",children:"T"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"T"})}),"\n",(0,l.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,l.jsx)(n.h5,{id:"name",children:"name"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"string"})}),"\n",(0,l.jsx)(n.h4,{id:"returns-9",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"Promise"}),"<",(0,l.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of-8",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IMicroAppHost.getObject\n"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"getprops",children:(0,l.jsx)(n.del,{children:"getProps()"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"getProps(): HostOptions;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"returns-10",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"/app-sdk/api/type-aliases/HostOptions",children:(0,l.jsx)(n.code,{children:"HostOptions"})})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"getviewportsize",children:(0,l.jsx)(n.del,{children:"getViewportSize()"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"getViewportSize(): {\n  height: number;\n  width: number;\n};\n"})}),"\n",(0,l.jsx)(n.h4,{id:"returns-11",children:"Returns"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"{\n  height: number;\n  width: number;\n}\n"})}),"\n",(0,l.jsx)(n.h5,{id:"height",children:(0,l.jsx)(n.del,{children:"height"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"height: number;\n"})}),"\n",(0,l.jsx)(n.h5,{id:"width",children:(0,l.jsx)(n.del,{children:"width"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"width: number;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of-9",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IMicroAppHost.getViewportSize\n"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"initialize",children:(0,l.jsx)(n.del,{children:"initialize()"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"initialize(): Promise<HostOptions>;\n"})}),"\n",(0,l.jsxs)(n.p,{children:["Host-initiated lifecycle: loads app config, initializes the app bridge,\nand calls the onInit callback. Call this instead of relying on the\nautomatic constructor chain when ",(0,l.jsx)(n.code,{children:"selfInitialize: true"}),"."]}),"\n",(0,l.jsx)(n.h4,{id:"returns-12",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"Promise"}),"<",(0,l.jsx)(n.a,{href:"/app-sdk/api/type-aliases/HostOptions",children:(0,l.jsx)(n.code,{children:"HostOptions"})}),">"]}),"\n",(0,l.jsx)(n.p,{children:"host options (systemVersion, history, theme)"}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"logout",children:(0,l.jsx)(n.del,{children:"logout()"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"logout(): void;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"returns-13",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of-10",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IMicroAppHost.logout\n"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"navigate",children:(0,l.jsx)(n.del,{children:"navigate()"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"navigate(url: To, state?: any): void;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,l.jsx)(n.h5,{id:"url",children:"url"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"To"})}),"\n",(0,l.jsx)(n.h5,{id:"state",children:"state?"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"any"})}),"\n",(0,l.jsx)(n.h4,{id:"returns-14",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of-11",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IMicroAppHost.navigate\n"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"onbreakpointchangeevent",children:(0,l.jsx)(n.del,{children:"onBreakpointChangeEvent()"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"onBreakpointChangeEvent(eventHandler: BreakpointChangeEventHandler): string;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,l.jsx)(n.h5,{id:"eventhandler",children:"eventHandler"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"BreakpointChangeEventHandler"})}),"\n",(0,l.jsx)(n.h4,{id:"returns-15",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"string"})}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of-12",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IMicroAppHost.onBreakpointChangeEvent\n"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"onresizeevent",children:(0,l.jsx)(n.del,{children:"onResizeEvent()"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"onResizeEvent(eventHandler: ResizeEventHandler): string;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"parameters-7",children:"Parameters"}),"\n",(0,l.jsx)(n.h5,{id:"eventhandler-1",children:"eventHandler"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"ResizeEventHandler"})}),"\n",(0,l.jsx)(n.h4,{id:"returns-16",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"string"})}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of-13",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IMicroAppHost.onResizeEvent\n"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"openerrorbanner",children:(0,l.jsx)(n.del,{children:"openErrorBanner()"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"openErrorBanner(message: string): void;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"parameters-8",children:"Parameters"}),"\n",(0,l.jsx)(n.h5,{id:"message",children:"message"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"string"})}),"\n",(0,l.jsx)(n.h4,{id:"returns-17",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of-14",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IMicroAppHost.openErrorBanner\n"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"openwaitmessage",children:(0,l.jsx)(n.del,{children:"openWaitMessage()"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"openWaitMessage(): void;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"returns-18",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of-15",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IMicroAppHost.openWaitMessage\n"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"publish",children:(0,l.jsx)(n.del,{children:"publish()"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"publish<Type>(message: string | symbol, data?: Type): boolean;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"type-parameters-5",children:"Type Parameters"}),"\n",(0,l.jsx)(n.h5,{id:"type",children:"Type"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"Type"})}),"\n",(0,l.jsx)(n.h4,{id:"parameters-9",children:"Parameters"}),"\n",(0,l.jsx)(n.h5,{id:"message-1",children:"message"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"string"})," | ",(0,l.jsx)(n.code,{children:"symbol"})]}),"\n",(0,l.jsx)(n.h5,{id:"data",children:"data?"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"Type"})}),"\n",(0,l.jsx)(n.h4,{id:"returns-19",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"boolean"})}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of-16",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IMicroAppHost.publish\n"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"removescriptingobject",children:(0,l.jsx)(n.del,{children:"removeScriptingObject()"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"removeScriptingObject(objectId: Extract<keyof AppObjects, string>, guestId?: string): void;\n"})}),"\n",(0,l.jsx)(n.p,{children:"removes scripting object from child microapp use"}),"\n",(0,l.jsx)(n.h4,{id:"parameters-10",children:"Parameters"}),"\n",(0,l.jsx)(n.h5,{id:"objectid",children:"objectId"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"Extract"}),"<keyof ",(0,l.jsx)(n.code,{children:"AppObjects"}),", ",(0,l.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,l.jsx)(n.p,{children:"unique id of the scripting object"}),"\n",(0,l.jsx)(n.h5,{id:"guestid",children:"guestId?"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"string"})}),"\n",(0,l.jsx)(n.p,{children:"optional guest id when removing a guest-scoped object"}),"\n",(0,l.jsx)(n.h4,{id:"returns-20",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of-17",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IMicroAppHost.removeScriptingObject\n"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"renewauthtoken",children:(0,l.jsx)(n.del,{children:"renewAuthToken()"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"renewAuthToken(): string;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"returns-21",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"string"})}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of-18",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IMicroAppHost.renewAuthToken\n"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"renewsessiontimer",children:(0,l.jsx)(n.del,{children:"renewSessionTimer()"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"renewSessionTimer(): Promise<void>;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"returns-22",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"Promise"}),"<",(0,l.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of-19",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IMicroAppHost.renewSessionTimer\n"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"sendbaevent",children:(0,l.jsx)(n.del,{children:"sendBAEvent()"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"sendBAEvent(data: BAEvent): void;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"parameters-11",children:"Parameters"}),"\n",(0,l.jsx)(n.h5,{id:"data-1",children:"data"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"BAEvent"})}),"\n",(0,l.jsx)(n.h4,{id:"returns-23",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of-20",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IMicroAppHost.sendBAEvent\n"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"setitem",children:(0,l.jsx)(n.del,{children:"setItem()"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"setItem(key: string, value: string): void;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"parameters-12",children:"Parameters"}),"\n",(0,l.jsx)(n.h5,{id:"key-1",children:"key"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"string"})}),"\n",(0,l.jsx)(n.h5,{id:"value",children:"value"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"string"})}),"\n",(0,l.jsx)(n.h4,{id:"returns-24",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of-21",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IMicroAppHost.setItem\n"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"setsystemversion",children:(0,l.jsx)(n.del,{children:"setSystemVersion()"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"setSystemVersion(version?: string): void;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"parameters-13",children:"Parameters"}),"\n",(0,l.jsx)(n.h5,{id:"version",children:"version?"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"string"})," = ",(0,l.jsx)(n.code,{children:"'latest'"})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-25",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"subscribe",children:(0,l.jsx)(n.del,{children:"subscribe()"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"subscribe<T>(message: string | symbol, func: SubscriptionListener<T>): string;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"type-parameters-6",children:"Type Parameters"}),"\n",(0,l.jsx)(n.h5,{id:"t-2",children:"T"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"T"})}),"\n",(0,l.jsx)(n.h4,{id:"parameters-14",children:"Parameters"}),"\n",(0,l.jsx)(n.h5,{id:"message-2",children:"message"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"string"})," | ",(0,l.jsx)(n.code,{children:"symbol"})]}),"\n",(0,l.jsx)(n.h5,{id:"func",children:"func"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"SubscriptionListener"}),"<",(0,l.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,l.jsx)(n.h4,{id:"returns-26",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"string"})}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of-22",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IMicroAppHost.subscribe\n"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"unsubscribe",children:(0,l.jsx)(n.del,{children:"unsubscribe()"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"unsubscribe(token: string): void;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"parameters-15",children:"Parameters"}),"\n",(0,l.jsx)(n.h5,{id:"token",children:"token"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"string"})}),"\n",(0,l.jsx)(n.h4,{id:"returns-27",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.h4,{id:"implementation-of-23",children:"Implementation of"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"IMicroAppHost.unsubscribe\n"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"getinstance",children:(0,l.jsx)(n.del,{children:"getInstance()"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"static getInstance<AppObjects, AppEvents>(params?: ConstructorParams): CMicroAppHost<AppObjects, AppEvents>;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"type-parameters-7",children:"Type Parameters"}),"\n",(0,l.jsx)(n.h5,{id:"appobjects-1",children:"AppObjects"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"AppObjects"})," ",(0,l.jsx)(n.em,{children:"extends"})," ",(0,l.jsx)(n.code,{children:"ScriptingObjects"})," = ",(0,l.jsx)(n.code,{children:"Partial"}),"<",(0,l.jsx)(n.code,{children:"ScriptingObjectTypes"}),">"]}),"\n",(0,l.jsx)(n.h5,{id:"appevents-1",children:"AppEvents"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"AppEvents"})," ",(0,l.jsx)(n.em,{children:"extends"})," ",(0,l.jsx)(n.code,{children:"EventListeners"})," = ",(0,l.jsx)(n.code,{children:"Events"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-16",children:"Parameters"}),"\n",(0,l.jsx)(n.h5,{id:"params-3",children:"params?"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"ConstructorParams"})}),"\n",(0,l.jsx)(n.h4,{id:"returns-28",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"CMicroAppHost"}),"<",(0,l.jsx)(n.code,{children:"AppObjects"}),", ",(0,l.jsx)(n.code,{children:"AppEvents"}),">"]}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"isinitialized",children:(0,l.jsx)(n.del,{children:"isInitialized()"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"static isInitialized(): boolean;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"returns-29",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"boolean"})}),"\n",(0,l.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,l.jsx)(n.h3,{id:"activeguests",children:(0,l.jsx)(n.del,{children:"activeGuests"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"activeGuests: Record<string, unknown>;\n"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"scriptingobjects",children:(0,l.jsx)(n.del,{children:"scriptingObjects"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"scriptingObjects: Record<string, any>;\n"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(o,{...e})}):o(e)}},5676(e,n,s){s.d(n,{R:()=>d,x:()=>t});var i=s(758);const l={},r=i.createContext(l);function d(e){const n=i.useContext(r);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:d(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]);