@elliemae/pui-app-sdk 5.48.0 → 5.48.2

package/build/docs/assets/js/1a5ba401.547a0455.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[7098],{8151(e,n,i){i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>a,default:()=>h,frontMatter:()=>l,metadata:()=>s,toc:()=>c});const s=JSON.parse('{"id":"api/classes/Analytics","title":"Analytics","description":"Analytics scripting object that captures business analytics events and","source":"@site/docs/api/classes/Analytics.md","sourceDirName":"api/classes","slug":"/api/classes/Analytics","permalink":"/app-sdk/api/classes/Analytics","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/classes/Analytics.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"App SDK API","permalink":"/app-sdk/api/"},"next":{"title":"CMicroAppGuest\\\\<AppObjects, AppEvents\\\\>","permalink":"/app-sdk/api/classes/CMicroAppGuest"}}');var r=i(6070),t=i(5676);const l={},a="Analytics",d={},c=[{value:"Destinations",id:"destinations",level:2},{value:"Use cases",id:"use-cases",level:2},{value:"1. Business analytics events (<code>sendBAEvent</code>)",id:"1-business-analytics-events-sendbaevent",level:3},{value:"2. Manual performance timing (<code>startTiming</code> / <code>endTiming</code>)",id:"2-manual-performance-timing-starttiming--endtiming",level:3},{value:"3. Automatic performance observation (<code>#monitorPerformance</code>)",id:"3-automatic-performance-observation-monitorperformance",level:3},{value:"4. Sampling ratio management",id:"4-sampling-ratio-management",level:3},{value:"Example",id:"example",level:2},{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:"params",id:"params",level:5},{value:"Returns",id:"returns-2",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Properties",id:"properties",level:2},{value:"_dispose",id:"_dispose",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"_toJSON",id:"_tojson",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Implementation of",id:"implementation-of-3",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"deleteTimingEventSamplingRatio",id:"deletetimingeventsamplingratio",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"names",id:"names",level:5},{value:"Returns",id:"returns-5",level:4},{value:"Example",id:"example-1",level:4},{value:"Implementation of",id:"implementation-of-4",level:4},{value:"dispose",id:"dispose",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"endTiming",id:"endtiming",level:3},{value:"What each destination receives",id:"what-each-destination-receives",level:2},{value:"Accepted <code>start</code> formats",id:"accepted-start-formats",level:2},{value:"Parameters",id:"parameters-2",level:4},{value:"start",id:"start",level:5},{value:"options",id:"options",level:5},{value:"Returns",id:"returns-7",level:4},{value:"Throws",id:"throws",level:4},{value:"Examples",id:"examples",level:4},{value:"Implementation of",id:"implementation-of-5",level:4},{value:"getAllTimingEventSamplingRatios",id:"getalltimingeventsamplingratios",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Example",id:"example-2",level:4},{value:"Implementation of",id:"implementation-of-6",level:4},{value:"getTimingEventSamplingRatio",id:"gettimingeventsamplingratio",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"names",id:"names-1",level:5},{value:"Returns",id:"returns-9",level:4},{value:"Example",id:"example-3",level:4},{value:"Implementation of",id:"implementation-of-7",level:4},{value:"sendBAEvent",id:"sendbaevent",level:3},{value:"GTM properties (<code>gtmDataLayer.push</code>)",id:"gtm-properties-gtmdatalayerpush",level:2},{value:"LogRocket properties (<code>logRocket.track</code>)",id:"logrocket-properties-logrockettrack",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"eve",id:"eve",level:5},{value:"Returns",id:"returns-10",level:4},{value:"Example",id:"example-4",level:4},{value:"Implementation of",id:"implementation-of-8",level:4},{value:"setTimingEventSamplingRatio",id:"settimingeventsamplingratio",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"ratios",id:"ratios",level:5},{value:"Returns",id:"returns-11",level:4},{value:"Example",id:"example-5",level:4},{value:"Implementation of",id:"implementation-of-9",level:4},{value:"startTiming",id:"starttiming",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"name",id:"name",level:5},{value:"options",id:"options-1",level:5},{value:"Returns",id:"returns-12",level:4},{value:"Throws",id:"throws-1",level:4},{value:"Example",id:"example-6",level:4},{value:"Implementation of",id:"implementation-of-10",level:4}];function o(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"analytics",children:"Analytics"})}),"\n",(0,r.jsx)(n.p,{children:"Analytics scripting object that captures business analytics events and\nperformance timing measurements, forwarding them to multiple destinations."}),"\n",(0,r.jsx)(n.h2,{id:"destinations",children:"Destinations"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Destination"}),(0,r.jsx)(n.th,{children:"Transport"}),(0,r.jsx)(n.th,{children:"What it receives"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:"Splunk"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"logger.info()"})}),(0,r.jsxs)(n.td,{children:["Timing events only \u2014 ",(0,r.jsx)(n.code,{children:"message"}),", ",(0,r.jsx)(n.code,{children:"event"}),", ",(0,r.jsx)(n.code,{children:"duration"}),", ",(0,r.jsx)(n.code,{children:"startTime"}),", ",(0,r.jsx)(n.code,{children:"detail"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:"GTM"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"window.gtmDataLayer.push()"})}),(0,r.jsx)(n.td,{children:"BA events and timing events \u2014 full enriched payload (BA params + product details + caller data)"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:"LogRocket"})}),(0,r.jsxs)(n.td,{children:[(0,r.jsx)(n.code,{children:"logRocket.track()"})," via lrTrackGuarded"]}),(0,r.jsx)(n.td,{children:"BA events only: caller-supplied fields"})]})]})]}),"\n",(0,r.jsx)(n.h2,{id:"use-cases",children:"Use cases"}),"\n",(0,r.jsxs)(n.h3,{id:"1-business-analytics-events-sendbaevent",children:["1. Business analytics events (",(0,r.jsx)(n.code,{children:"sendBAEvent"}),")"]}),"\n",(0,r.jsx)(n.p,{children:"Fire-and-forget event tracking for user actions, page views, feature usage,\nerrors, etc. No sampling \u2014 every call reaches GTM and LogRocket (subject to\nLR throttle). GTM receives the full enriched context; LogRocket receives\nonly the caller-supplied fields to conserve its 2,000-property session budget."}),"\n",(0,r.jsxs)(n.h3,{id:"2-manual-performance-timing-starttiming--endtiming",children:["2. Manual performance timing (",(0,r.jsx)(n.code,{children:"startTiming"})," / ",(0,r.jsx)(n.code,{children:"endTiming"}),")"]}),"\n",(0,r.jsxs)(n.p,{children:["Bracket a unit of work to measure its wall-clock duration. ",(0,r.jsx)(n.code,{children:"startTiming"}),"\ncreates a ",(0,r.jsx)(n.code,{children:"performance.mark()"}),"; ",(0,r.jsx)(n.code,{children:"endTiming"})," calls ",(0,r.jsx)(n.code,{children:"performance.measure()"}),"\nwhich is then picked up by the automatic pipeline (use case 3)."]}),"\n",(0,r.jsxs)(n.h3,{id:"3-automatic-performance-observation-monitorperformance",children:["3. Automatic performance observation (",(0,r.jsx)(n.code,{children:"#monitorPerformance"}),")"]}),"\n",(0,r.jsxs)(n.p,{children:["A page-wide ",(0,r.jsx)(n.code,{children:"PerformanceObserver"})," captures every ",(0,r.jsx)(n.code,{children:"performance.measure()"}),"\nentry \u2014 including those from ",(0,r.jsx)(n.code,{children:"endTiming"})," and any other code on the page.\nEach entry passes through:"]}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Third-party filter"})," \u2014 GTM/GA4 internal measures (names matching\n",(0,r.jsx)(n.code,{children:"GTM-*"})," or ",(0,r.jsx)(n.code,{children:"G-*"}),") are silently dropped."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Head sampling"})," \u2014 per-event-name ratio (default 25%) decides whether\nto record. Configurable via ",(0,r.jsx)(n.code,{children:"setTimingEventSamplingRatio"}),"."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Fan-out"})," \u2014 sampled entries are sent to Splunk and GTM.\nProcessing is deferred via ",(0,r.jsx)(n.code,{children:"queueMicrotask"})," so the caller's\n",(0,r.jsx)(n.code,{children:"performance.measure()"})," returns immediately."]}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"4-sampling-ratio-management",children:"4. Sampling ratio management"}),"\n",(0,r.jsxs)(n.p,{children:["Runtime CRUD for per-event sampling ratios via ",(0,r.jsx)(n.code,{children:"setTimingEventSamplingRatio"}),",\n",(0,r.jsx)(n.code,{children:"getTimingEventSamplingRatio"}),", ",(0,r.jsx)(n.code,{children:"deleteTimingEventSamplingRatio"}),", and\n",(0,r.jsx)(n.code,{children:"getAllTimingEventSamplingRatios"}),". Sampling applies uniformly to both\ntiming destinations (Splunk and GTM) \u2014 there is no per-destination sampling."]}),"\n",(0,r.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"const analytics = new Analytics({\n  logger,\n  timingEventSamplingRatios: { 'api-call': 0.1, 'page-load': 1.0 },\n});\n\n// Business event\nawait analytics.sendBAEvent({ event: 'user-login', method: 'oauth' });\n\n// Timing measurement\nconst mark = await analytics.startTiming('api-call', { appId: 'svc', appUrl: location.href });\nawait fetchData();\nawait analytics.endTiming(mark, { appId: 'svc', appUrl: location.href });\n"})}),"\n",(0,r.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.code,{children:"ScriptingObject"})}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"implements",children:"Implements"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.code,{children:"IAnalytics"})}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"accessors",children:"Accessors"}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,r.jsx)(n.h4,{id:"get-signature",children:"Get Signature"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"get id(): string;\n"})}),"\n",(0,r.jsx)(n.p,{children:"get unique id of the scripting object"}),"\n",(0,r.jsx)(n.h5,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"string"})}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IAnalytics.id\n"})}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"ScriptingObject.id\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"objecttype",children:"objectType"}),"\n",(0,r.jsx)(n.h4,{id:"get-signature-1",children:"Get Signature"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"get objectType(): string;\n"})}),"\n",(0,r.jsx)(n.p,{children:"get type of the scripting object"}),"\n",(0,r.jsx)(n.h5,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"string"})}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-1",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IAnalytics.objectType\n"})}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"ScriptingObject.objectType\n"})}),"\n",(0,r.jsx)(n.h2,{id:"constructors",children:"Constructors"}),"\n",(0,r.jsx)(n.h3,{id:"constructor",children:"Constructor"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"new Analytics(params: AnalyticsParams): Analytics;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Creates a new Analytics scripting object and immediately starts the\npage-wide PerformanceObserver for timing events."}),"\n",(0,r.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"params",children:"params"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"AnalyticsParams"})}),"\n",(0,r.jsx)(n.p,{children:"Analytics configuration"}),"\n",(0,r.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"Analytics"})}),"\n",(0,r.jsx)(n.h4,{id:"overrides",children:"Overrides"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"ScriptingObject.constructor\n"})}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"_dispose",children:"_dispose"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"_dispose: () => void;\n"})}),"\n",(0,r.jsx)(n.p,{children:"dispose the scripting object"}),"\n",(0,r.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-2",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IAnalytics._dispose\n"})}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"ScriptingObject._dispose\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"_tojson",children:"_toJSON"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"_toJSON: () => RemotingScriptingObject;\n"})}),"\n",(0,r.jsx)(n.p,{children:"transform the scripting object to a format suitable for transmitting over window.postMessage"}),"\n",(0,r.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"RemotingScriptingObject"})}),"\n",(0,r.jsx)(n.p,{children:"marshalled scripting object"}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-3",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IAnalytics._toJSON\n"})}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"ScriptingObject._toJSON\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"deletetimingeventsamplingratio",children:"deleteTimingEventSamplingRatio"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"deleteTimingEventSamplingRatio: (names: string[]) => void;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Remove explicit sampling configuration for the given timing event names."}),"\n",(0,r.jsx)(n.p,{children:"After deletion the events revert to the default ratio of 0.25 (25%).\nDeleting a name that was never configured is a no-op."}),"\n",(0,r.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"names",children:"names"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(n.p,{children:"Array of event names whose ratios should be removed"}),"\n",(0,r.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"example-1",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"analytics.deleteTimingEventSamplingRatio(['api-call', 'user-interaction']);\n// Both now sample at the default 25%\n"})}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-4",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IAnalytics.deleteTimingEventSamplingRatio\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"dispose",children:"dispose"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"dispose: () => void;\n"})}),"\n",(0,r.jsx)(n.p,{children:"dispose the scripting object"}),"\n",(0,r.jsx)(n.h4,{id:"returns-6",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"ScriptingObject.dispose\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"endtiming",children:"endTiming"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"endTiming: (start: string | PerfMark, options: TimingOptions) => Promise<void>;\n"})}),"\n",(0,r.jsxs)(n.p,{children:["End a performance timing measurement by calling ",(0,r.jsx)(n.code,{children:"performance.measure()"}),"."]}),"\n",(0,r.jsx)(n.p,{children:"The resulting measure entry is automatically captured by the\nPerformanceObserver pipeline, which filters, samples, and fans out\nto Splunk and GTM. The mark is cleared after measurement."}),"\n",(0,r.jsx)(n.h2,{id:"what-each-destination-receives",children:"What each destination receives"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Destination"}),(0,r.jsx)(n.th,{children:"Event name"}),(0,r.jsx)(n.th,{children:"Payload"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:"Splunk"})}),(0,r.jsxs)(n.td,{children:[(0,r.jsx)(n.code,{children:"entry.name"})," (the measurement name)"]}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"{ message: 'timing', event, duration, startTime, detail }"})})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:"GTM"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"timing:<name>"})}),(0,r.jsxs)(n.td,{children:["BA params + product details + ",(0,r.jsx)(n.code,{children:"{ duration, startTime, startAppId, startAppUrl, endAppId, endAppUrl }"})]})]})]})]}),"\n",(0,r.jsxs)(n.h2,{id:"accepted-start-formats",children:["Accepted ",(0,r.jsx)(n.code,{children:"start"})," formats"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"PerfMark"})})," (return value of ",(0,r.jsx)(n.a,{href:"#starttiming",children:"startTiming"}),") \u2014 uses ",(0,r.jsx)(n.code,{children:"startTime"}),"\nfor sub-millisecond accuracy even if the mark was cleared externally."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"string"})})," (the name passed to ",(0,r.jsx)(n.a,{href:"#starttiming",children:"startTiming"}),") \u2014 looks up the mark\nby name; falls back to ",(0,r.jsx)(n.code,{children:"performance.now()"})," if the mark is missing."]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"start",children:"start"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"string"})," | ",(0,r.jsx)(n.code,{children:"PerfMark"})]}),"\n",(0,r.jsxs)(n.p,{children:["The PerfMark returned by ",(0,r.jsx)(n.code,{children:"startTiming"}),", or the name string"]}),"\n",(0,r.jsx)(n.h5,{id:"options",children:"options"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"TimingOptions"})}),"\n",(0,r.jsxs)(n.p,{children:["Must include ",(0,r.jsx)(n.code,{children:"appId"})," and ",(0,r.jsx)(n.code,{children:"appUrl"})," for the end context"]}),"\n",(0,r.jsx)(n.h4,{id:"returns-7",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"A pre-resolved promise (for interface compatibility)"}),"\n",(0,r.jsx)(n.h4,{id:"throws",children:"Throws"}),"\n",(0,r.jsxs)(n.p,{children:["If ",(0,r.jsx)(n.code,{children:"start"})," is falsy or ",(0,r.jsx)(n.code,{children:"options.appId"})," / ",(0,r.jsx)(n.code,{children:"options.appUrl"})," are missing"]}),"\n",(0,r.jsx)(n.h4,{id:"examples",children:"Examples"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"// Using the PerfMark object (recommended)\nconst mark = await analytics.startTiming('LongTask', { appId: 'myApp', appUrl: 'https://myapp.com' });\nawait doWork();\nawait analytics.endTiming(mark, { appId: 'myApp', appUrl: 'https://myapp.com' });\n"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"// Using the name string (cross-app timing \u2014 start and end may differ)\nawait analytics.startTiming('LongTask', { appId: 'appA', appUrl: 'https://appA.com' });\nawait doWork();\nawait analytics.endTiming('LongTask', { appId: 'appB', appUrl: 'https://appB.com' });\n"})}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-5",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IAnalytics.endTiming\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"getalltimingeventsamplingratios",children:"getAllTimingEventSamplingRatios"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"getAllTimingEventSamplingRatios: () => Record<string, number>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Return a snapshot of all explicitly configured timing event sampling ratios."}),"\n",(0,r.jsxs)(n.p,{children:["Events using the default ratio (0.25) are ",(0,r.jsx)(n.strong,{children:"not"})," included. The returned\nobject is a copy \u2014 mutating it does not affect the internal state."]}),"\n",(0,r.jsx)(n.h4,{id:"returns-8",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Record"}),"<",(0,r.jsx)(n.code,{children:"string"}),", ",(0,r.jsx)(n.code,{children:"number"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"Map of event name to ratio for all explicitly configured events"}),"\n",(0,r.jsx)(n.h4,{id:"example-2",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"const ratios = analytics.getAllTimingEventSamplingRatios();\n// { 'api-call': 0.1, 'user-interaction': 0.5 }\n"})}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-6",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IAnalytics.getAllTimingEventSamplingRatios\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"gettimingeventsamplingratio",children:"getTimingEventSamplingRatio"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"getTimingEventSamplingRatio: (names: string[]) => Record<string, number | undefined>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Retrieve the current sampling ratios for the specified timing event names."}),"\n",(0,r.jsxs)(n.p,{children:["Returns ",(0,r.jsx)(n.code,{children:"undefined"})," for events that have no explicit ratio configured\n(i.e. they use the default 0.25)."]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"names-1",children:"names"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(n.p,{children:"Array of event names to query"}),"\n",(0,r.jsx)(n.h4,{id:"returns-9",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Record"}),"<",(0,r.jsx)(n.code,{children:"string"}),", ",(0,r.jsx)(n.code,{children:"number"})," | ",(0,r.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,r.jsxs)(n.p,{children:["Map of event name to ratio, or ",(0,r.jsx)(n.code,{children:"undefined"})," if using default"]}),"\n",(0,r.jsx)(n.h4,{id:"example-3",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"const ratios = analytics.getTimingEventSamplingRatio(['api-call', 'page-load']);\n// { 'api-call': 0.1, 'page-load': undefined }\n"})}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-7",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IAnalytics.getTimingEventSamplingRatio\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"sendbaevent",children:"sendBAEvent"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"sendBAEvent: (eve: BAEvent) => Promise<void>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Send a business analytics event to GTM and LogRocket."}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"No sampling or head-sampling is applied"})," \u2014 every call reaches both\ndestinations (subject to LogRocket's sliding-window throttle)."]}),"\n",(0,r.jsxs)(n.h2,{id:"gtm-properties-gtmdatalayerpush",children:["GTM properties (",(0,r.jsx)(n.code,{children:"gtmDataLayer.push"}),")"]}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Property"}),(0,r.jsx)(n.th,{children:"Source"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"event"})}),(0,r.jsxs)(n.td,{children:["Caller-supplied ",(0,r.jsx)(n.code,{children:"event"})," field"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"envName"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"sessionStorage.getItem('envName')"})})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"appId"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"window.emui.appId"})})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"instanceId"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"sessionStorage.getItem('instanceId')"})})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"userId"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"sessionStorage.getItem('userId')"})})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"...appParameters"})}),(0,r.jsxs)(n.td,{children:["Fields set via ",(0,r.jsx)(n.code,{children:"updateBAEventParameters()"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"productId"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"window.parent.emui.appId"})})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"productPath"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"window.parent.location.pathname"})})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"productUrl"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"window.parent.location.href"})})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"productPageTitle"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"window.parent.document.title"})})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"version"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"window.parent.emui.version"})})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"appPath"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"window.location.pathname"})})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"appUrl"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"window.location.href"})})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"appPageTitle"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"document.title"})})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"...rest"})}),(0,r.jsx)(n.td,{children:"All other caller-supplied fields"})]})]})]}),"\n",(0,r.jsxs)(n.h2,{id:"logrocket-properties-logrockettrack",children:["LogRocket properties (",(0,r.jsx)(n.code,{children:"logRocket.track"}),")"]}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Property"}),(0,r.jsx)(n.th,{children:"Source"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Track event name"}),(0,r.jsxs)(n.td,{children:["Caller-supplied ",(0,r.jsx)(n.code,{children:"event"})," field"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"...rest"})}),(0,r.jsxs)(n.td,{children:["All caller-supplied fields ",(0,r.jsx)(n.strong,{children:"except"})," ",(0,r.jsx)(n.code,{children:"event"})]})]})]})]}),"\n",(0,r.jsxs)(n.p,{children:["No ambient context (",(0,r.jsx)(n.code,{children:"envName"}),", ",(0,r.jsx)(n.code,{children:"appId"}),", ",(0,r.jsx)(n.code,{children:"instanceId"}),", ",(0,r.jsx)(n.code,{children:"userId"}),", product\ndetails, ",(0,r.jsx)(n.code,{children:"appParameters"}),") is sent to LogRocket."]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"eve",children:"eve"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"BAEvent"})}),"\n",(0,r.jsxs)(n.p,{children:["Business analytics event. Must contain an ",(0,r.jsx)(n.code,{children:"event"})," string field; all other fields are forwarded as-is. Returns immediately if ",(0,r.jsx)(n.code,{children:"event"})," is falsy."]}),"\n",(0,r.jsx)(n.h4,{id:"returns-10",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"A pre-resolved promise (for interface compatibility)"}),"\n",(0,r.jsx)(n.h4,{id:"example-4",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"// User action tracking\nawait analytics.sendBAEvent({ event: 'button-click', buttonId: 'submit' });\n\n// Page view tracking\nawait analytics.sendBAEvent({ event: 'page-view', page: '/dashboard' });\n\n// Feature usage\nawait analytics.sendBAEvent({ event: 'feature-used', feature: 'export-pdf' });\n\n// Error tracking\nawait analytics.sendBAEvent({ event: 'api-error', endpoint: '/users', status: 500 });\n"})}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-8",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IAnalytics.sendBAEvent\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"settimingeventsamplingratio",children:"setTimingEventSamplingRatio"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"setTimingEventSamplingRatio: (ratios: Record<string, number>) => void;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Set or update sampling ratios for one or more timing event names."}),"\n",(0,r.jsxs)(n.p,{children:["Sampling applies ",(0,r.jsx)(n.strong,{children:"uniformly to both timing destinations"})," (Splunk and\nGTM) \u2014 there is no per-destination sampling. Events not configured here\nfall back to the default ratio of 0.25 (25%)."]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"ratios",children:"ratios"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Record"}),"<",(0,r.jsx)(n.code,{children:"string"}),", ",(0,r.jsx)(n.code,{children:"number"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"Map of event name to ratio (0 = never, 1 = always)"}),"\n",(0,r.jsx)(n.h4,{id:"returns-11",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"example-5",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"analytics.setTimingEventSamplingRatio({\n  'api-call': 0.1,       // 10% \u2014 high-frequency, keep volume low\n  'page-load': 1.0,      // 100% \u2014 critical, capture every instance\n  'user-interaction': 0.5 // 50%\n});\n"})}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-9",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IAnalytics.setTimingEventSamplingRatio\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"starttiming",children:"startTiming"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"startTiming: (name: string, options: TimingOptions) => Promise<{\n  name: string;\n  startTime: number;\n}>;\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Start a performance timing measurement by creating a ",(0,r.jsx)(n.code,{children:"performance.mark()"}),"."]}),"\n",(0,r.jsxs)(n.p,{children:["The returned PerfMark (or the ",(0,r.jsx)(n.code,{children:"name"})," string) is later passed to\n",(0,r.jsx)(n.a,{href:"#endtiming",children:"endTiming"})," which calls ",(0,r.jsx)(n.code,{children:"performance.measure()"}),". That measure is\nautomatically picked up by the PerformanceObserver pipeline, which\nsamples and fans out to Splunk and GTM."]}),"\n",(0,r.jsxs)(n.p,{children:["If a mark with the same ",(0,r.jsx)(n.code,{children:"name"})," already exists it will be replaced by the\nbrowser's Performance API."]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"name",children:"name"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"string"})}),"\n",(0,r.jsxs)(n.p,{children:["Unique name for the measurement (e.g. ",(0,r.jsx)(n.code,{children:"'api-call'"}),", ",(0,r.jsx)(n.code,{children:"'page-load'"}),")"]}),"\n",(0,r.jsx)(n.h5,{id:"options-1",children:"options"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"TimingOptions"})}),"\n",(0,r.jsxs)(n.p,{children:["Must include ",(0,r.jsx)(n.code,{children:"appId"})," and ",(0,r.jsx)(n.code,{children:"appUrl"}),"; stored as ",(0,r.jsx)(n.code,{children:"detail"})," on the mark"]}),"\n",(0,r.jsx)(n.h4,{id:"returns-12",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<{\n",(0,r.jsx)(n.code,{children:"name"}),": ",(0,r.jsx)(n.code,{children:"string"}),";\n",(0,r.jsx)(n.code,{children:"startTime"}),": ",(0,r.jsx)(n.code,{children:"number"}),";\n}>"]}),"\n",(0,r.jsxs)(n.p,{children:["A promise resolving to ",(0,r.jsx)(n.code,{children:"{ name, startTime }"})," for passing to ",(0,r.jsx)(n.a,{href:"#endtiming",children:"endTiming"})]}),"\n",(0,r.jsx)(n.h4,{id:"throws-1",children:"Throws"}),"\n",(0,r.jsxs)(n.p,{children:["If ",(0,r.jsx)(n.code,{children:"name"})," is falsy or ",(0,r.jsx)(n.code,{children:"options.appId"})," / ",(0,r.jsx)(n.code,{children:"options.appUrl"})," are missing"]}),"\n",(0,r.jsx)(n.h4,{id:"example-6",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"const mark = await analytics.startTiming('api-call', {\n  appId: 'loan-service',\n  appUrl: 'https://app.example.com/loans',\n});\n// ... perform work ...\nawait analytics.endTiming(mark, { appId: 'loan-service', appUrl: 'https://app.example.com/loans' });\n"})}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-10",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IAnalytics.startTiming\n"})})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},5676(e,n,i){i.d(n,{R:()=>l,x:()=>a});var s=i(758);const r={},t=s.createContext(r);function l(e){const n=s.useContext(t);return s.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(r):e.components||r:l(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/1ad86f56.4f3470a0.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[124],{2505(e,r,n){n.r(r),n.d(r,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>l,metadata:()=>t,toc:()=>a});const t=JSON.parse('{"id":"api/variables/decorators","title":"decorators","description":"Type Declaration","source":"@site/docs/api/variables/decorators.md","sourceDirName":"api/variables","slug":"/api/variables/decorators","permalink":"/app-sdk/api/variables/decorators","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/variables/decorators.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"createSideEffect","permalink":"/app-sdk/api/variables/createSideEffect"},"next":{"title":"endSession","permalink":"/app-sdk/api/variables/endSession"}}');var s=n(6070),i=n(5676);const l={},c="decorators",d={},a=[{value:"Type Declaration",id:"type-declaration",level:2},{value:"class",id:"class",level:3},{value:"class.Mixins",id:"classmixins",level:4},{value:"Parameters",id:"parameters",level:5},{value:"constructors",id:"constructors",level:6},{value:"Returns",id:"returns",level:5},{value:"Example",id:"example",level:5},{value:"class.Singleton",id:"classsingleton",level:4},{value:"Type Parameters",id:"type-parameters",level:5},{value:"T",id:"t",level:6},{value:"Parameters",id:"parameters-1",level:5},{value:"type",id:"type",level:6},{value:"Returns",id:"returns-1",level:5},{value:"Example",id:"example-1",level:5},{value:"function",id:"function",level:3},{value:"function.AsyncSingleExecution",id:"functionasyncsingleexecution",level:4},{value:"Parameters",id:"parameters-2",level:5},{value:"_target",id:"_target",level:6},{value:"_propertyKey",id:"_propertykey",level:6},{value:"descriptor",id:"descriptor",level:6},{value:"Returns",id:"returns-2",level:5},{value:"Example",id:"example-2",level:5},{value:"Parameters",id:"parameters-3",level:5},{value:"_target",id:"_target-1",level:6},{value:"propertyKey",id:"propertykey",level:6},{value:"descriptor",id:"descriptor-1",level:6},{value:"Returns",id:"returns-3",level:5},{value:"Example",id:"example-3",level:5},{value:"function.Debounce",id:"functiondebounce",level:4},{value:"Parameters",id:"parameters-4",level:5},{value:"delay?",id:"delay",level:6},{value:"Returns",id:"returns-4",level:5},{value:"Example",id:"example-4",level:5},{value:"function.ImmutableArgs",id:"functionimmutableargs",level:4},{value:"Parameters",id:"parameters-5",level:5},{value:"_target",id:"_target-2",level:6},{value:"_propertyKey",id:"_propertykey-1",level:6},{value:"descriptor",id:"descriptor-2",level:6},{value:"Returns",id:"returns-5",level:5},{value:"Example",id:"example-5",level:5},{value:"function.Memoize",id:"functionmemoize",level:4},{value:"Parameters",id:"parameters-6",level:5},{value:"_target",id:"_target-3",level:6},{value:"_key",id:"_key",level:6},{value:"descriptor",id:"descriptor-3",level:6},{value:"Returns",id:"returns-6",level:5},{value:"Example",id:"example-6",level:5},{value:"function.MemoizeAsync",id:"functionmemoizeasync",level:4},{value:"Parameters",id:"parameters-7",level:5},{value:"_target",id:"_target-4",level:6},{value:"_propertyKey",id:"_propertykey-2",level:6},{value:"descriptor",id:"descriptor-4",level:6},{value:"Returns",id:"returns-7",level:5},{value:"Example",id:"example-7",level:5},{value:"function.MemoizeSingleArgPrimitive",id:"functionmemoizesingleargprimitive",level:4},{value:"Type Parameters",id:"type-parameters-1",level:5},{value:"T",id:"t-1",level:6},{value:"R",id:"r",level:6},{value:"Parameters",id:"parameters-8",level:5},{value:"_target",id:"_target-5",level:6},{value:"_propertyKey",id:"_propertykey-3",level:6},{value:"descriptor",id:"descriptor-5",level:6},{value:"Returns",id:"returns-8",level:5},{value:"Examples",id:"examples",level:5},{value:"function.QueueTask",id:"functionqueuetask",level:4},{value:"Parameters",id:"parameters-9",level:5},{value:"_target",id:"_target-6",level:6},{value:"_key",id:"_key-1",level:6},{value:"descriptor",id:"descriptor-6",level:6},{value:"Returns",id:"returns-9",level:5},{value:"Example",id:"example-8",level:5},{value:"function.RetryAsync",id:"functionretryasync",level:4},{value:"Parameters",id:"parameters-10",level:5},{value:"retries?",id:"retries",level:6},{value:"interval?",id:"interval",level:6},{value:"reThrowException?",id:"rethrowexception",level:6},{value:"Returns",id:"returns-10",level:5},{value:"Example",id:"example-9",level:5},{value:"function.Throttle",id:"functionthrottle",level:4},{value:"Parameters",id:"parameters-11",level:5},{value:"delay?",id:"delay-1",level:6},{value:"Returns",id:"returns-11",level:5},{value:"Example",id:"example-10",level:5},{value:"property",id:"property",level:3},{value:"property.MemoizeGetter",id:"propertymemoizegetter",level:4},{value:"Parameters",id:"parameters-12",level:5},{value:"_target",id:"_target-7",level:6},{value:"propertyKey",id:"propertykey-1",level:6},{value:"descriptor",id:"descriptor-7",level:6},{value:"Returns",id:"returns-12",level:5},{value:"Example",id:"example-11",level:5}];function o(e){const r={code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",h6:"h6",header:"header",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.header,{children:(0,s.jsx)(r.h1,{id:"decorators",children:"decorators"})}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"const decorators: {\n  class: {\n     Mixins: (...constructors: any[]) => (derivedCtor: any) => void;\n     Singleton: <T>(type: T) => SingletonType;\n  };\n  function: {\n     AsyncSingleExecution: (_target: any, _propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;\n     CacheUntilResolved: (_target: any, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;\n     Debounce: (delay?: number) => (_target: any, _propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;\n     ImmutableArgs: (_target: any, _propertyKey: string | symbol, descriptor: PropertyDescriptor) => PropertyDescriptor;\n     Memoize: (_target: any, _key: string, descriptor: PropertyDescriptor) => void;\n     MemoizeAsync: (_target: any, _propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;\n     MemoizeSingleArgPrimitive: <T, R>(_target: any, _propertyKey: string, descriptor: TypedPropertyDescriptor<(...args: any[]) => R>) => TypedPropertyDescriptor<(...args: any[]) => R>;\n     QueueTask: (_target: unknown, _key: string, descriptor: PropertyDescriptor) => void;\n     RetryAsync: (retries?: number, interval?: number, reThrowException?: boolean) => MethodDecorator;\n     Throttle: (delay?: number) => (_target: any, _propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;\n  };\n  property: {\n     MemoizeGetter: (_target: unknown, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;\n  };\n};\n"})}),"\n",(0,s.jsx)(r.h2,{id:"type-declaration",children:"Type Declaration"}),"\n",(0,s.jsx)(r.h3,{id:"class",children:"class"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"class: {\n  Mixins: (...constructors: any[]) => (derivedCtor: any) => void;\n  Singleton: <T>(type: T) => SingletonType;\n};\n"})}),"\n",(0,s.jsx)(r.h4,{id:"classmixins",children:"class.Mixins"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"Mixins: (...constructors: any[]) => (derivedCtor: any) => void;\n"})}),"\n",(0,s.jsx)(r.p,{children:"A decorator to mix multiple classes into a single class."}),"\n",(0,s.jsx)(r.h5,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsx)(r.h6,{id:"constructors",children:"constructors"}),"\n",(0,s.jsxs)(r.p,{children:["...",(0,s.jsx)(r.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(r.p,{children:"The constructors of the classes to be mixed in."}),"\n",(0,s.jsx)(r.h5,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:"A class decorator that mixes the provided classes into the target class."}),"\n",(0,s.jsxs)(r.p,{children:["(",(0,s.jsx)(r.code,{children:"derivedCtor"}),": ",(0,s.jsx)(r.code,{children:"any"}),") => ",(0,s.jsx)(r.code,{children:"void"})]}),"\n",(0,s.jsx)(r.h5,{id:"example",children:"Example"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-typescript",children:"class A {\n  methodA() {\n    console.log('A');\n  }\n}\n\nclass B {\n  methodB() {\n    console.log('B');\n  }\n}\n// Apply decorator\n// @Mixins(A, B)\nclass C {}\n\nconst instance = new C();\ninstance.methodA(); // Outputs: 'A'\ninstance.methodB(); // Outputs: 'B'\n"})}),"\n",(0,s.jsx)(r.h4,{id:"classsingleton",children:"class.Singleton"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"Singleton: <T>(type: T) => SingletonType;\n"})}),"\n",(0,s.jsx)(r.p,{children:"A decorator to make a class a singleton."}),"\n",(0,s.jsx)(r.h5,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,s.jsx)(r.h6,{id:"t",children:"T"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"T"})," ",(0,s.jsx)(r.em,{children:"extends"})," (...",(0,s.jsx)(r.code,{children:"args"}),": ",(0,s.jsx)(r.code,{children:"any"}),"[]) => ",(0,s.jsx)(r.code,{children:"any"})]}),"\n",(0,s.jsx)(r.h5,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsx)(r.h6,{id:"type",children:"type"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"T"})}),"\n",(0,s.jsx)(r.p,{children:"The class to be made a singleton."}),"\n",(0,s.jsx)(r.h5,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"SingletonType"})}),"\n",(0,s.jsx)(r.p,{children:"A proxy that ensures only one instance of the class is created."}),"\n",(0,s.jsx)(r.h5,{id:"example-1",children:"Example"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-typescript",children:"// @Singleton decorator\nclass MyClass {\n  constructor() {\n    console.log('Instance created');\n  }\n}\n\nconst instance1 = new MyClass(); // Outputs: 'Instance created'\nconst instance2 = new MyClass(); // No output, same instance returned\n\nconsole.log(instance1 === instance2); // Outputs: true\n"})}),"\n",(0,s.jsx)(r.h3,{id:"function",children:"function"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"function: {\n  AsyncSingleExecution: (_target: any, _propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;\n  CacheUntilResolved: (_target: any, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;\n  Debounce: (delay?: number) => (_target: any, _propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;\n  ImmutableArgs: (_target: any, _propertyKey: string | symbol, descriptor: PropertyDescriptor) => PropertyDescriptor;\n  Memoize: (_target: any, _key: string, descriptor: PropertyDescriptor) => void;\n  MemoizeAsync: (_target: any, _propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;\n  MemoizeSingleArgPrimitive: <T, R>(_target: any, _propertyKey: string, descriptor: TypedPropertyDescriptor<(...args: any[]) => R>) => TypedPropertyDescriptor<(...args: any[]) => R>;\n  QueueTask: (_target: unknown, _key: string, descriptor: PropertyDescriptor) => void;\n  RetryAsync: (retries?: number, interval?: number, reThrowException?: boolean) => MethodDecorator;\n  Throttle: (delay?: number) => (_target: any, _propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;\n};\n"})}),"\n",(0,s.jsx)(r.h4,{id:"functionasyncsingleexecution",children:"function.AsyncSingleExecution"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"AsyncSingleExecution: (_target: any, _propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;\n"})}),"\n",(0,s.jsx)(r.p,{children:"AsyncSingleExecution decorator ensures that multiple concurrent calls to an async function\nwith the same arguments will return the same promise instance until it resolves.\nOnce resolved, subsequent calls will trigger a new execution."}),"\n",(0,s.jsx)(r.h5,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsx)(r.h6,{id:"_target",children:"_target"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"any"})}),"\n",(0,s.jsx)(r.h6,{id:"_propertykey",children:"_propertyKey"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"string"})}),"\n",(0,s.jsx)(r.h6,{id:"descriptor",children:"descriptor"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"PropertyDescriptor"})}),"\n",(0,s.jsx)(r.h5,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"PropertyDescriptor"})}),"\n",(0,s.jsx)(r.p,{children:"A function that modifies the property descriptor."}),"\n",(0,s.jsx)(r.h5,{id:"example-2",children:"Example"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-typescript",children:"import { AsyncSingleExecution } from './functionDecorators';\n\nclass Example {\n  @AsyncSingleExecution\n  async fetchData(id: number) {\n    console.log('Fetching data for', id);\n    return new Promise(resolve => setTimeout(() => resolve(id), 1000));\n  }\n}\n\nconst instance = new Example();\nconst promise1 = instance.fetchData(1);\nconst promise2 = instance.fetchData(1);\n\nconsole.log(promise1 === promise2); // true\n"})}),"\n",(0,s.jsx)(r.p,{children:"// Output:\n// Fetching data for 1 (only logged once)"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{children:"\n#### function.CacheUntilResolved\n\n```ts\nCacheUntilResolved: (_target: any, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;\n"})}),"\n",(0,s.jsx)(r.p,{children:"Caches the result of a method until the promise is resolved."}),"\n",(0,s.jsx)(r.h5,{id:"parameters-3",children:"Parameters"}),"\n",(0,s.jsx)(r.h6,{id:"_target-1",children:"_target"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"any"})}),"\n",(0,s.jsx)(r.p,{children:"The target object."}),"\n",(0,s.jsx)(r.h6,{id:"propertykey",children:"propertyKey"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"string"})}),"\n",(0,s.jsx)(r.p,{children:"The name of the method."}),"\n",(0,s.jsx)(r.h6,{id:"descriptor-1",children:"descriptor"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"PropertyDescriptor"})}),"\n",(0,s.jsx)(r.p,{children:"The property descriptor."}),"\n",(0,s.jsx)(r.h5,{id:"returns-3",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"PropertyDescriptor"})}),"\n",(0,s.jsx)(r.p,{children:"The modified property descriptor."}),"\n",(0,s.jsx)(r.h5,{id:"example-3",children:"Example"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-typescript",children:"class Example {\n  // Apply decorator: CacheUntilResolved\n  async fetchData() {\n    // ...fetch data...\n  }\n}\n"})}),"\n",(0,s.jsx)(r.h4,{id:"functiondebounce",children:"function.Debounce"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"Debounce: (delay?: number) => (_target: any, _propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;\n"})}),"\n",(0,s.jsx)(r.p,{children:"Debounces the method call by the specified delay."}),"\n",(0,s.jsx)(r.h5,{id:"parameters-4",children:"Parameters"}),"\n",(0,s.jsx)(r.h6,{id:"delay",children:"delay?"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"number"})," = ",(0,s.jsx)(r.code,{children:"300"})]}),"\n",(0,s.jsx)(r.p,{children:"The delay in milliseconds."}),"\n",(0,s.jsx)(r.h5,{id:"returns-4",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:"A function that modifies the property descriptor."}),"\n",(0,s.jsxs)(r.p,{children:["(",(0,s.jsx)(r.code,{children:"_target"}),": ",(0,s.jsx)(r.code,{children:"any"}),", ",(0,s.jsx)(r.code,{children:"_propertyKey"}),": ",(0,s.jsx)(r.code,{children:"string"}),", ",(0,s.jsx)(r.code,{children:"descriptor"}),": ",(0,s.jsx)(r.code,{children:"PropertyDescriptor"}),") => ",(0,s.jsx)(r.code,{children:"PropertyDescriptor"})]}),"\n",(0,s.jsx)(r.h5,{id:"example-4",children:"Example"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-typescript",children:"class Example {\n  // Apply decorator: Debounce(500)\n  onResize() {\n    // ...handle resize...\n  }\n}\n"})}),"\n",(0,s.jsx)(r.h4,{id:"functionimmutableargs",children:"function.ImmutableArgs"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"ImmutableArgs: (_target: any, _propertyKey: string | symbol, descriptor: PropertyDescriptor) => PropertyDescriptor;\n"})}),"\n",(0,s.jsx)(r.p,{children:"Makes the arguments of a method immutable."}),"\n",(0,s.jsx)(r.h5,{id:"parameters-5",children:"Parameters"}),"\n",(0,s.jsx)(r.h6,{id:"_target-2",children:"_target"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"any"})}),"\n",(0,s.jsx)(r.p,{children:"The target object."}),"\n",(0,s.jsx)(r.h6,{id:"_propertykey-1",children:"_propertyKey"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"string"})," | ",(0,s.jsx)(r.code,{children:"symbol"})]}),"\n",(0,s.jsx)(r.p,{children:"The name of the method."}),"\n",(0,s.jsx)(r.h6,{id:"descriptor-2",children:"descriptor"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"PropertyDescriptor"})}),"\n",(0,s.jsx)(r.p,{children:"The property descriptor."}),"\n",(0,s.jsx)(r.h5,{id:"returns-5",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"PropertyDescriptor"})}),"\n",(0,s.jsx)(r.p,{children:"The modified property descriptor."}),"\n",(0,s.jsx)(r.h5,{id:"example-5",children:"Example"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-typescript",children:"class Example {\n  // Apply decorator: ImmutableArgs\n  updateData(data: any) {\n    // ...update data...\n  }\n}\n"})}),"\n",(0,s.jsx)(r.h4,{id:"functionmemoize",children:"function.Memoize"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"Memoize: (_target: any, _key: string, descriptor: PropertyDescriptor) => void;\n"})}),"\n",(0,s.jsx)(r.p,{children:"Memoizes the result of a method."}),"\n",(0,s.jsx)(r.h5,{id:"parameters-6",children:"Parameters"}),"\n",(0,s.jsx)(r.h6,{id:"_target-3",children:"_target"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"any"})}),"\n",(0,s.jsx)(r.p,{children:"The target object."}),"\n",(0,s.jsx)(r.h6,{id:"_key",children:"_key"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"string"})}),"\n",(0,s.jsx)(r.p,{children:"The name of the method."}),"\n",(0,s.jsx)(r.h6,{id:"descriptor-3",children:"descriptor"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"PropertyDescriptor"})}),"\n",(0,s.jsx)(r.p,{children:"The property descriptor."}),"\n",(0,s.jsx)(r.h5,{id:"returns-6",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"void"})}),"\n",(0,s.jsx)(r.p,{children:"The modified property descriptor."}),"\n",(0,s.jsx)(r.h5,{id:"example-6",children:"Example"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-typescript",children:"class Example {\n  // Apply decorator: Memoize\n  computeValue(x: number) {\n    return x * 2;\n  }\n}\n"})}),"\n",(0,s.jsx)(r.h4,{id:"functionmemoizeasync",children:"function.MemoizeAsync"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"MemoizeAsync: (_target: any, _propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;\n"})}),"\n",(0,s.jsx)(r.p,{children:"Memoizes the result of an async method."}),"\n",(0,s.jsx)(r.h5,{id:"parameters-7",children:"Parameters"}),"\n",(0,s.jsx)(r.h6,{id:"_target-4",children:"_target"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"any"})}),"\n",(0,s.jsx)(r.p,{children:"The target object."}),"\n",(0,s.jsx)(r.h6,{id:"_propertykey-2",children:"_propertyKey"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"string"})}),"\n",(0,s.jsx)(r.p,{children:"The name of the method."}),"\n",(0,s.jsx)(r.h6,{id:"descriptor-4",children:"descriptor"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"PropertyDescriptor"})}),"\n",(0,s.jsx)(r.p,{children:"The property descriptor."}),"\n",(0,s.jsx)(r.h5,{id:"returns-7",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"PropertyDescriptor"})}),"\n",(0,s.jsx)(r.p,{children:"The modified property descriptor."}),"\n",(0,s.jsx)(r.h5,{id:"example-7",children:"Example"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-typescript",children:"class Example {\n  // Apply decorator: MemoizeAsync\n  async fetchData() {\n    // ...fetch data...\n  }\n}\n"})}),"\n",(0,s.jsx)(r.h4,{id:"functionmemoizesingleargprimitive",children:"function.MemoizeSingleArgPrimitive"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"MemoizeSingleArgPrimitive: <T, R>(_target: any, _propertyKey: string, descriptor: TypedPropertyDescriptor<(...args: any[]) => R>) => TypedPropertyDescriptor<(...args: any[]) => R>;\n"})}),"\n",(0,s.jsx)(r.p,{children:"Memoizes the result of a function with a single primitive argument or no arguments.\nOnly caches results for functions that take exactly one primitive argument (string, number, boolean, symbol, null, or undefined)\nor no arguments at all. Uses a simple object as the cache."}),"\n",(0,s.jsx)(r.h5,{id:"type-parameters-1",children:"Type Parameters"}),"\n",(0,s.jsx)(r.h6,{id:"t-1",children:"T"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"T"})," ",(0,s.jsx)(r.em,{children:"extends"})," ",(0,s.jsx)(r.code,{children:"string"})," | ",(0,s.jsx)(r.code,{children:"number"})," | ",(0,s.jsx)(r.code,{children:"boolean"})," | ",(0,s.jsx)(r.code,{children:"symbol"})," | ",(0,s.jsx)(r.code,{children:"null"})," | ",(0,s.jsx)(r.code,{children:"undefined"})]}),"\n",(0,s.jsx)(r.h6,{id:"r",children:"R"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"R"})}),"\n",(0,s.jsx)(r.h5,{id:"parameters-8",children:"Parameters"}),"\n",(0,s.jsx)(r.h6,{id:"_target-5",children:"_target"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"any"})}),"\n",(0,s.jsx)(r.h6,{id:"_propertykey-3",children:"_propertyKey"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"string"})}),"\n",(0,s.jsx)(r.h6,{id:"descriptor-5",children:"descriptor"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"TypedPropertyDescriptor"}),"<(...",(0,s.jsx)(r.code,{children:"args"}),": ",(0,s.jsx)(r.code,{children:"any"}),"[]) => ",(0,s.jsx)(r.code,{children:"R"}),">"]}),"\n",(0,s.jsx)(r.h5,{id:"returns-8",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"TypedPropertyDescriptor"}),"<(...",(0,s.jsx)(r.code,{children:"args"}),": ",(0,s.jsx)(r.code,{children:"any"}),"[]) => ",(0,s.jsx)(r.code,{children:"R"}),">"]}),"\n",(0,s.jsx)(r.h5,{id:"examples",children:"Examples"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-typescript",children:"// Single primitive argument\nclass Example {\n  // Apply decorator: MemoizeSingleArgPrimitive\n  double(x: number) {\n    return x * 2;\n  }\n}\nconst ex = new Example();\nex.double(2); // Calls original, returns 4\nex.double(2); // Returns cached result, 4\n"})}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-typescript",children:"// No arguments\nclass ExampleNoArg {\n  // Apply decorator: MemoizeSingleArgPrimitive\n  getRandom() {\n    return Math.random();\n  }\n}\nconst ex2 = new ExampleNoArg();\nex2.getRandom(); // Calls original, returns a value\nex2.getRandom(); // Returns cached value\n"})}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-typescript",children:"// Not cached for non-primitive or multiple arguments\nclass ExampleObj {\n  // Apply decorator: MemoizeSingleArgPrimitive\n  sum(obj: { x: number }) {\n    return obj.x + 1;\n  }\n}\nconst ex3 = new ExampleObj();\nex3.sum({ x: 1 }); // Calls original\nex3.sum({ x: 1 }); // Calls original again (not cached)\n"})}),"\n",(0,s.jsx)(r.h4,{id:"functionqueuetask",children:"function.QueueTask"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"QueueTask: (_target: unknown, _key: string, descriptor: PropertyDescriptor) => void;\n"})}),"\n",(0,s.jsx)(r.p,{children:"Queues the method call as a microtask."}),"\n",(0,s.jsx)(r.h5,{id:"parameters-9",children:"Parameters"}),"\n",(0,s.jsx)(r.h6,{id:"_target-6",children:"_target"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"unknown"})}),"\n",(0,s.jsx)(r.p,{children:"The target object."}),"\n",(0,s.jsx)(r.h6,{id:"_key-1",children:"_key"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"string"})}),"\n",(0,s.jsx)(r.p,{children:"The name of the method."}),"\n",(0,s.jsx)(r.h6,{id:"descriptor-6",children:"descriptor"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"PropertyDescriptor"})}),"\n",(0,s.jsx)(r.p,{children:"The property descriptor."}),"\n",(0,s.jsx)(r.h5,{id:"returns-9",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"void"})}),"\n",(0,s.jsx)(r.p,{children:"The modified property descriptor."}),"\n",(0,s.jsx)(r.h5,{id:"example-8",children:"Example"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-typescript",children:"class Example {\n  // Apply decorator: QueueTask\n  processTask() {\n    // ...process task...\n  }\n}\n"})}),"\n",(0,s.jsx)(r.h4,{id:"functionretryasync",children:"function.RetryAsync"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"RetryAsync: (retries?: number, interval?: number, reThrowException?: boolean) => MethodDecorator;\n"})}),"\n",(0,s.jsx)(r.p,{children:"Retries an async method a specified number of times with a delay between attempts."}),"\n",(0,s.jsx)(r.h5,{id:"parameters-10",children:"Parameters"}),"\n",(0,s.jsx)(r.h6,{id:"retries",children:"retries?"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"number"})," = ",(0,s.jsx)(r.code,{children:"3"})]}),"\n",(0,s.jsx)(r.p,{children:"The number of retry attempts."}),"\n",(0,s.jsx)(r.h6,{id:"interval",children:"interval?"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"number"})," = ",(0,s.jsx)(r.code,{children:"2000"})]}),"\n",(0,s.jsx)(r.p,{children:"The delay in milliseconds between retries."}),"\n",(0,s.jsx)(r.h6,{id:"rethrowexception",children:"reThrowException?"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"boolean"})," = ",(0,s.jsx)(r.code,{children:"true"})]}),"\n",(0,s.jsx)(r.p,{children:"Whether to rethrow the exception after all retries fail."}),"\n",(0,s.jsx)(r.h5,{id:"returns-10",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"MethodDecorator"})}),"\n",(0,s.jsx)(r.p,{children:"A method decorator that modifies the property descriptor."}),"\n",(0,s.jsx)(r.h5,{id:"example-9",children:"Example"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"class Example {\n  @RetryAsync(3, 1000, true)\n  async fetchData() {\n    console.log('Attempting to fetch data...');\n    if (Math.random() < 0.7) {\n      throw new Error('Fetch failed');\n    }\n    return 'Data fetched successfully';\n  }\n}\n\nconst instance = new Example();\ninstance.fetchData().then(console.log).catch(console.error);\n\n// Output (example):\n// Attempting to fetch data...\n// Attempting to fetch data...\n// Attempting to fetch data...\n// Error: Fetch failed\n"})}),"\n",(0,s.jsx)(r.h4,{id:"functionthrottle",children:"function.Throttle"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"Throttle: (delay?: number) => (_target: any, _propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;\n"})}),"\n",(0,s.jsx)(r.p,{children:"Throttles the method call by the specified delay."}),"\n",(0,s.jsx)(r.h5,{id:"parameters-11",children:"Parameters"}),"\n",(0,s.jsx)(r.h6,{id:"delay-1",children:"delay?"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"number"})," = ",(0,s.jsx)(r.code,{children:"300"})]}),"\n",(0,s.jsx)(r.p,{children:"The delay in milliseconds."}),"\n",(0,s.jsx)(r.h5,{id:"returns-11",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:"A function that modifies the property descriptor."}),"\n",(0,s.jsxs)(r.p,{children:["(",(0,s.jsx)(r.code,{children:"_target"}),": ",(0,s.jsx)(r.code,{children:"any"}),", ",(0,s.jsx)(r.code,{children:"_propertyKey"}),": ",(0,s.jsx)(r.code,{children:"string"}),", ",(0,s.jsx)(r.code,{children:"descriptor"}),": ",(0,s.jsx)(r.code,{children:"PropertyDescriptor"}),") => ",(0,s.jsx)(r.code,{children:"PropertyDescriptor"})]}),"\n",(0,s.jsx)(r.h5,{id:"example-10",children:"Example"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"class Example {\n  @Throttle(500)\n  onScroll() {\n    // ...handle scroll...\n  }\n}\n"})}),"\n",(0,s.jsx)(r.h3,{id:"property",children:"property"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"property: {\n  MemoizeGetter: (_target: unknown, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;\n};\n"})}),"\n",(0,s.jsx)(r.h4,{id:"propertymemoizegetter",children:"property.MemoizeGetter"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-ts",children:"MemoizeGetter: (_target: unknown, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;\n"})}),"\n",(0,s.jsxs)(r.p,{children:["Memorizes the result of a getter so it is computed once per instance and the\nsame reference is returned on every later access. Unlike ",(0,s.jsx)(r.code,{children:"Memoize"})," (which\ncaches method results via ",(0,s.jsx)(r.code,{children:"descriptor.value"}),"), this caches accessor results\nvia ",(0,s.jsx)(r.code,{children:"descriptor.get"}),". The cache is keyed per instance through a ",(0,s.jsx)(r.code,{children:"WeakMap"}),", so\ndistinct instances get distinct values and entries are garbage-collected with\ntheir instance."]}),"\n",(0,s.jsx)(r.h5,{id:"parameters-12",children:"Parameters"}),"\n",(0,s.jsx)(r.h6,{id:"_target-7",children:"_target"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"unknown"})}),"\n",(0,s.jsx)(r.p,{children:"The target object."}),"\n",(0,s.jsx)(r.h6,{id:"propertykey-1",children:"propertyKey"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"string"})}),"\n",(0,s.jsx)(r.p,{children:"The name of the getter."}),"\n",(0,s.jsx)(r.h6,{id:"descriptor-7",children:"descriptor"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"PropertyDescriptor"})}),"\n",(0,s.jsx)(r.p,{children:"The property descriptor."}),"\n",(0,s.jsx)(r.h5,{id:"returns-12",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.code,{children:"PropertyDescriptor"})}),"\n",(0,s.jsx)(r.p,{children:"The modified property descriptor."}),"\n",(0,s.jsx)(r.h5,{id:"example-11",children:"Example"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-typescript",children:"class Styles {\n  // Apply decorator: MemoizeGetter\n  get Cell() {\n    return styled(Grid)`...`; // created once, reused thereafter\n  }\n}\n"})})]})}function p(e={}){const{wrapper:r}={...(0,i.R)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},5676(e,r,n){n.d(r,{R:()=>l,x:()=>c});var t=n(758);const s={},i=t.createContext(s);function l(e){const r=t.useContext(i);return t.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(s):e.components||s:l(e.components),t.createElement(i.Provider,{value:r},e.children)}}}]);

package/build/docs/assets/js/1cc7c915.964923e1.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[5223],{8516(e,n,t){t.r(n),t.d(n,{assets:()=>p,contentTitle:()=>s,default:()=>u,frontMatter:()=>r,metadata:()=>i,toc:()=>o});const i=JSON.parse('{"id":"api/functions/getAppConfigValue","title":"getAppConfigValue()","description":"Gets a value from the application configuration using dot notation.","source":"@site/docs/api/functions/getAppConfigValue.md","sourceDirName":"api/functions","slug":"/api/functions/getAppConfigValue","permalink":"/app-sdk/api/functions/getAppConfigValue","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/getAppConfigValue.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"getAppConfig()","permalink":"/app-sdk/api/functions/getAppConfig"},"next":{"title":"getAuthHTTPClient()","permalink":"/app-sdk/api/functions/getAuthHTTPClient"}}');var a=t(6070),l=t(5676);const r={},s="getAppConfigValue()",p={},o=[{value:"Type Parameters",id:"type-parameters",level:2},{value:"Type",id:"type",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},{value:"Example",id:"example",level:2}];function c(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,l.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.header,{children:(0,a.jsx)(n.h1,{id:"getappconfigvalue",children:"getAppConfigValue()"})}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"function getAppConfigValue<Type>(key?: string, defaultValue?: unknown): Type;\n"})}),"\n",(0,a.jsx)(n.p,{children:"Gets a value from the application configuration using dot notation.\nReturns a deep clone to prevent accidental mutations."}),"\n",(0,a.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,a.jsx)(n.h3,{id:"type",children:"Type"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.code,{children:"Type"})}),"\n",(0,a.jsx)(n.p,{children:"Expected return type"}),"\n",(0,a.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,a.jsx)(n.h3,{id:"key",children:"key?"}),"\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.code,{children:"string"})," = ",(0,a.jsx)(n.code,{children:"''"})]}),"\n",(0,a.jsx)(n.p,{children:"Dot-notation path to the config value (e.g., 'serviceEndpoints.api')"}),"\n",(0,a.jsx)(n.h3,{id:"defaultvalue",children:"defaultValue?"}),"\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.code,{children:"unknown"})," = ",(0,a.jsx)(n.code,{children:"null"})]}),"\n",(0,a.jsx)(n.p,{children:"Value to return if key doesn't exist (default: null)"}),"\n",(0,a.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.code,{children:"Type"})}),"\n",(0,a.jsx)(n.p,{children:"The configuration value or default"}),"\n",(0,a.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-typescript",children:"const apiUrl = getAppConfigValue<string>('serviceEndpoints.api', 'https://default.com');\nconst timeout = getAppConfigValue<number>('requestTimeout', 30000);\n"})})]})}function u(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(c,{...e})}):c(e)}},5676(e,n,t){t.d(n,{R:()=>r,x:()=>s});var i=t(758);const a={},l=i.createContext(a);function r(e){const n=i.useContext(l);return i.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:r(e.components),i.createElement(l.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/1dfec420.7273a206.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[200],{6674(e,o,t){t.r(o),t.d(o,{assets:()=>a,contentTitle:()=>i,default:()=>d,frontMatter:()=>s,metadata:()=>n,toc:()=>c});const n=JSON.parse('{"id":"api/functions/AppRoot","title":"AppRoot()","description":"Root component for SDK-based applications.","source":"@site/docs/api/functions/AppRoot.md","sourceDirName":"api/functions","slug":"/api/functions/AppRoot","permalink":"/app-sdk/api/functions/AppRoot","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/AppRoot.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"GuestModule","permalink":"/app-sdk/api/classes/GuestModule"},"next":{"title":"Autocomplete()","permalink":"/app-sdk/api/functions/Autocomplete"}}');var p=t(6070),r=t(5676);const s={},i="AppRoot()",a={},c=[{value:"Parameters",id:"parameters",level:2},{value:"props",id:"props",level:3},{value:"Returns",id:"returns",level:2},{value:"Example",id:"example",level:2}];function l(e){const o={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,p.jsxs)(p.Fragment,{children:[(0,p.jsx)(o.header,{children:(0,p.jsx)(o.h1,{id:"approot",children:"AppRoot()"})}),"\n",(0,p.jsx)(o.pre,{children:(0,p.jsx)(o.code,{className:"language-ts",children:"function AppRoot(props: AppRootProps): Element;\n"})}),"\n",(0,p.jsx)(o.p,{children:"Root component for SDK-based applications.\nProvides Redux store, routing, theming, error boundaries, and session management."}),"\n",(0,p.jsx)(o.h2,{id:"parameters",children:"Parameters"}),"\n",(0,p.jsx)(o.h3,{id:"props",children:"props"}),"\n",(0,p.jsx)(o.p,{children:(0,p.jsx)(o.code,{children:"AppRootProps"})}),"\n",(0,p.jsx)(o.p,{children:"AppRoot component props"}),"\n",(0,p.jsx)(o.h2,{id:"returns",children:"Returns"}),"\n",(0,p.jsx)(o.p,{children:(0,p.jsx)(o.code,{children:"Element"})}),"\n",(0,p.jsx)(o.h2,{id:"example",children:"Example"}),"\n",(0,p.jsx)(o.pre,{children:(0,p.jsx)(o.code,{className:"language-typescript",children:"import { AppRoot, configureStore, history } from '@elliemae/pui-app-sdk';\n\nconst store = configureStore({}, history);\n\nReactDOM.render(\n  <AppRoot store={store} history={history}>\n    <App />\n  </AppRoot>,\n  document.getElementById('root')\n);\n"})})]})}function d(e={}){const{wrapper:o}={...(0,r.R)(),...e.components};return o?(0,p.jsx)(o,{...e,children:(0,p.jsx)(l,{...e})}):l(e)}},5676(e,o,t){t.d(o,{R:()=>s,x:()=>i});var n=t(758);const p={},r=n.createContext(p);function s(e){const o=n.useContext(r);return n.useMemo(function(){return"function"==typeof e?e(o):{...o,...e}},[o,e])}function i(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(p):e.components||p:s(e.components),n.createElement(r.Provider,{value:o},e.children)}}}]);

package/build/docs/assets/js/1fcf59a8.7f131093.js

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

package/build/docs/assets/js/22c6ac39.666917ed.js

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

package/build/docs/assets/js/24b1c163.5d0f1ad4.js

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

package/build/docs/assets/js/25ae0bf1.3dd19943.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[5623],{8506(e,s,n){n.r(s),n.d(s,{assets:()=>o,contentTitle:()=>d,default:()=>u,frontMatter:()=>t,metadata:()=>a,toc:()=>l});const a=JSON.parse('{"id":"api/functions/buildModuleParams","title":"buildModuleParams()","description":"Build a ModuleParameters object for a self-initializing guest.","source":"@site/docs/api/functions/buildModuleParams.md","sourceDirName":"api/functions","slug":"/api/functions/buildModuleParams","permalink":"/app-sdk/api/functions/buildModuleParams","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/buildModuleParams.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"authorize()","permalink":"/app-sdk/api/functions/authorize"},"next":{"title":"cleanup()","permalink":"/app-sdk/api/functions/cleanup"}}');var i=n(6070),r=n(5676);const t={},d="buildModuleParams()",o={},l=[{value:"Parameters",id:"parameters",level:2},{value:"guestId",id:"guestid",level:3},{value:"params?",id:"params",level:3},{value:"Returns",id:"returns",level:2}];function c(e){const s={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.header,{children:(0,i.jsx)(s.h1,{id:"buildmoduleparams",children:"buildModuleParams()"})}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-ts",children:"function buildModuleParams(guestId: string, params?: HostProvidedParams): ModuleParameters;\n"})}),"\n",(0,i.jsx)(s.p,{children:"Build a ModuleParameters object for a self-initializing guest."}),"\n",(0,i.jsxs)(s.p,{children:["Reads ",(0,i.jsx)(s.code,{children:"hostUrl"}),", ",(0,i.jsx)(s.code,{children:"manifestPath"}),", and ",(0,i.jsx)(s.code,{children:"homeRoute"})," from the app config\nfor the given guest id. The host only provides values the config\ndoesn't have: ",(0,i.jsx)(s.code,{children:"theme"}),", ",(0,i.jsx)(s.code,{children:"history"}),", and optionally ",(0,i.jsx)(s.code,{children:"initialRoute"}),"."]}),"\n",(0,i.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsx)(s.h3,{id:"guestid",children:"guestId"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.code,{children:"string"})}),"\n",(0,i.jsx)(s.p,{children:"App id as defined in app.config.json (e.g. 'loanapp')"}),"\n",(0,i.jsx)(s.h3,{id:"params",children:"params?"}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.a,{href:"/app-sdk/api/type-aliases/HostProvidedParams",children:(0,i.jsx)(s.code,{children:"HostProvidedParams"})})," = ",(0,i.jsx)(s.code,{children:"{}"})]}),"\n",(0,i.jsx)(s.p,{children:"Host-provided values (theme, history, initialRoute, custom keys)"}),"\n",(0,i.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.code,{children:"ModuleParameters"})}),"\n",(0,i.jsx)(s.p,{children:"ModuleParameters ready for getParameters()"})]})}function u(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},5676(e,s,n){n.d(s,{R:()=>t,x:()=>d});var a=n(758);const i={},r=a.createContext(i);function t(e){const s=a.useContext(r);return a.useMemo(function(){return"function"==typeof e?e(s):{...s,...e}},[s,e])}function d(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:t(e.components),a.createElement(r.Provider,{value:s},e.children)}}}]);

package/build/docs/assets/js/27c4a013.dc54bf81.js

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

package/build/docs/assets/js/27c8b774.2ec269ef.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[1567],{8209(e,n,r){r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>i,default:()=>h,frontMatter:()=>s,metadata:()=>t,toc:()=>a});const t=JSON.parse('{"id":"api/classes/ErrorBoundary","title":"ErrorBoundary","description":"React error boundary component that catches JavaScript errors in child components.","source":"@site/docs/api/classes/ErrorBoundary.md","sourceDirName":"api/classes","slug":"/api/classes/ErrorBoundary","permalink":"/app-sdk/api/classes/ErrorBoundary","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/classes/ErrorBoundary.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"~~CMicroAppHost\\\\<AppObjects, AppEvents\\\\>~~","permalink":"/app-sdk/api/classes/CMicroAppHost"},"next":{"title":"GuestModule","permalink":"/app-sdk/api/classes/GuestModule"}}');var d=r(6070),l=r(5676);const s={},i="ErrorBoundary",o={},a=[{value:"Example",id:"example",level:2},{value:"Extends",id:"extends",level:2},{value:"Constructors",id:"constructors",level:2},{value:"Constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"props",id:"props",level:5},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Methods",id:"methods",level:2},{value:"componentDidCatch()",id:"componentdidcatch",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"error",id:"error",level:5},{value:"errorInfo",id:"errorinfo",level:5},{value:"componentStack",id:"componentstack",level:6},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"componentDidMount()?",id:"componentdidmount",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"componentDidUpdate()?",id:"componentdidupdate",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"prevProps",id:"prevprops",level:5},{value:"prevState",id:"prevstate",level:5},{value:"snapshot?",id:"snapshot",level:5},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"<del>componentWillMount()?</del>",id:"componentwillmount",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Deprecated",id:"deprecated",level:4},{value:"See",id:"see",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"<del>componentWillReceiveProps()?</del>",id:"componentwillreceiveprops",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"nextProps",id:"nextprops",level:5},{value:"nextContext",id:"nextcontext",level:5},{value:"Returns",id:"returns-5",level:4},{value:"Deprecated",id:"deprecated-1",level:4},{value:"See",id:"see-1",level:4},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"componentWillUnmount()?",id:"componentwillunmount",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"<del>componentWillUpdate()?</del>",id:"componentwillupdate",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"nextProps",id:"nextprops-1",level:5},{value:"nextState",id:"nextstate",level:5},{value:"nextContext",id:"nextcontext-1",level:5},{value:"Returns",id:"returns-7",level:4},{value:"Deprecated",id:"deprecated-2",level:4},{value:"See",id:"see-2",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"forceUpdate()",id:"forceupdate",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"callback?",id:"callback",level:5},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"getSnapshotBeforeUpdate()?",id:"getsnapshotbeforeupdate",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"prevProps",id:"prevprops-1",level:5},{value:"prevState",id:"prevstate-1",level:5},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"render()",id:"render",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"setState()",id:"setstate",level:3},{value:"Type Parameters",id:"type-parameters",level:4},{value:"K",id:"k",level:5},{value:"Parameters",id:"parameters-7",level:4},{value:"state",id:"state",level:5},{value:"callback?",id:"callback-1",level:5},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"shouldComponentUpdate()?",id:"shouldcomponentupdate",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"nextProps",id:"nextprops-2",level:5},{value:"nextState",id:"nextstate-1",level:5},{value:"nextContext",id:"nextcontext-2",level:5},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"<del>UNSAFE_componentWillMount()?</del>",id:"unsafe_componentwillmount",level:3},{value:"Returns",id:"returns-13",level:4},{value:"Deprecated",id:"deprecated-3",level:4},{value:"See",id:"see-3",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"<del>UNSAFE_componentWillReceiveProps()?</del>",id:"unsafe_componentwillreceiveprops",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"nextProps",id:"nextprops-3",level:5},{value:"nextContext",id:"nextcontext-3",level:5},{value:"Returns",id:"returns-14",level:4},{value:"Deprecated",id:"deprecated-4",level:4},{value:"See",id:"see-4",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"<del>UNSAFE_componentWillUpdate()?</del>",id:"unsafe_componentwillupdate",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"nextProps",id:"nextprops-4",level:5},{value:"nextState",id:"nextstate-2",level:5},{value:"nextContext",id:"nextcontext-4",level:5},{value:"Returns",id:"returns-15",level:4},{value:"Deprecated",id:"deprecated-5",level:4},{value:"See",id:"see-5",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Properties",id:"properties",level:2},{value:"context",id:"context",level:3},{value:"Example",id:"example-1",level:4},{value:"See",id:"see-6",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"props",id:"props-1",level:3},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"<del>refs</del>",id:"refs",level:3},{value:"Index Signature",id:"index-signature",level:4},{value:"Deprecated",id:"deprecated-6",level:4},{value:"See",id:"see-7",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"state",id:"state-1",level:3},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"contextType?",id:"contexttype",level:3},{value:"Example",id:"example-2",level:4},{value:"See",id:"see-8",level:4},{value:"Inherited from",id:"inherited-from-17",level:4}];function c(e){const n={a:"a",code:"code",del:"del",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",h6:"h6",header:"header",hr:"hr",li:"li",p:"p",pre:"pre",ul:"ul",...(0,l.R)(),...e.components};return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(n.header,{children:(0,d.jsx)(n.h1,{id:"errorboundary",children:"ErrorBoundary"})}),"\n",(0,d.jsx)(n.p,{children:"React error boundary component that catches JavaScript errors in child components.\nLogs errors and displays a fallback UI instead of crashing the app."}),"\n",(0,d.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-tsx",children:"import { ErrorBoundary } from '@elliemae/pui-app-sdk';\n\nfunction App() {\n  return (\n    <ErrorBoundary>\n      <MyApp />\n    </ErrorBoundary>\n  );\n}\n\n// With custom error template\n<ErrorBoundary errorTemplate={CustomErrorPage}>\n  <MyApp />\n</ErrorBoundary>\n"})}),"\n",(0,d.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsxs)(n.li,{children:[(0,d.jsx)(n.code,{children:"Component"}),"<",(0,d.jsx)(n.code,{children:"ErrorBoundaryProps"}),">"]}),"\n"]}),"\n",(0,d.jsx)(n.h2,{id:"constructors",children:"Constructors"}),"\n",(0,d.jsx)(n.h3,{id:"constructor",children:"Constructor"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"new ErrorBoundary(props: ErrorBoundaryProps): ErrorBoundary;\n"})}),"\n",(0,d.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,d.jsx)(n.h5,{id:"props",children:"props"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.code,{children:"ErrorBoundaryProps"})}),"\n",(0,d.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.code,{children:"ErrorBoundary"})}),"\n",(0,d.jsx)(n.h4,{id:"overrides",children:"Overrides"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"React.Component<ErrorBoundaryProps>.constructor\n"})}),"\n",(0,d.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,d.jsx)(n.h3,{id:"componentdidcatch",children:"componentDidCatch()"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"componentDidCatch(error: Error, errorInfo: {\n  componentStack: string;\n}): void;\n"})}),"\n",(0,d.jsx)(n.p,{children:"Catches exceptions generated in descendant components. Unhandled exceptions will cause\nthe entire component tree to unmount."}),"\n",(0,d.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,d.jsx)(n.h5,{id:"error",children:"error"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.code,{children:"Error"})}),"\n",(0,d.jsx)(n.h5,{id:"errorinfo",children:"errorInfo"}),"\n",(0,d.jsx)(n.h6,{id:"componentstack",children:"componentStack"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.code,{children:"string"})}),"\n",(0,d.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.code,{children:"void"})}),"\n",(0,d.jsx)(n.h4,{id:"overrides-1",children:"Overrides"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"React.Component.componentDidCatch\n"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"componentdidmount",children:"componentDidMount()?"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"optional componentDidMount(): void;\n"})}),"\n",(0,d.jsx)(n.p,{children:"Called immediately after a component is mounted. Setting state here will trigger re-rendering."}),"\n",(0,d.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.code,{children:"void"})}),"\n",(0,d.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"React.Component.componentDidMount\n"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"componentdidupdate",children:"componentDidUpdate()?"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"optional componentDidUpdate(\n   prevProps: Readonly<P>, \n   prevState: Readonly<S>, \n   snapshot?: any): void;\n"})}),"\n",(0,d.jsx)(n.p,{children:"Called immediately after updating occurs. Not called for the initial render."}),"\n",(0,d.jsxs)(n.p,{children:["The snapshot is only present if ",(0,d.jsx)(n.a,{href:"#getsnapshotbeforeupdate",children:"getSnapshotBeforeUpdate"})," is present and returns non-null."]}),"\n",(0,d.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,d.jsx)(n.h5,{id:"prevprops",children:"prevProps"}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"Readonly"}),"<",(0,d.jsx)(n.code,{children:"P"}),">"]}),"\n",(0,d.jsx)(n.h5,{id:"prevstate",children:"prevState"}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"Readonly"}),"<",(0,d.jsx)(n.code,{children:"S"}),">"]}),"\n",(0,d.jsx)(n.h5,{id:"snapshot",children:"snapshot?"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.code,{children:"any"})}),"\n",(0,d.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.code,{children:"void"})}),"\n",(0,d.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"React.Component.componentDidUpdate\n"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"componentwillmount",children:(0,d.jsx)(n.del,{children:"componentWillMount()?"})}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"optional componentWillMount(): void;\n"})}),"\n",(0,d.jsx)(n.p,{children:"Called immediately before mounting occurs, and before Component.render.\nAvoid introducing any side-effects or subscriptions in this method."}),"\n",(0,d.jsx)(n.p,{children:"Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate\nor StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents\nthis from being invoked."}),"\n",(0,d.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.code,{children:"void"})}),"\n",(0,d.jsx)(n.h4,{id:"deprecated",children:"Deprecated"}),"\n",(0,d.jsx)(n.p,{children:"16.3, use ComponentLifecycle.componentDidMount componentDidMount or the constructor instead; will stop working in React 17"}),"\n",(0,d.jsx)(n.h4,{id:"see",children:"See"}),"\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsx)(n.li,{children:(0,d.jsx)(n.a,{href:"https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state",children:"https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state"})}),"\n",(0,d.jsx)(n.li,{children:(0,d.jsx)(n.a,{href:"https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",children:"https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"})}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"React.Component.componentWillMount\n"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"componentwillreceiveprops",children:(0,d.jsx)(n.del,{children:"componentWillReceiveProps()?"})}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"optional componentWillReceiveProps(nextProps: Readonly<P>, nextContext: any): void;\n"})}),"\n",(0,d.jsx)(n.p,{children:"Called when the component may be receiving new props.\nReact may call this even if props have not changed, so be sure to compare new and existing\nprops if you only want to handle changes."}),"\n",(0,d.jsx)(n.p,{children:"Calling Component.setState generally does not trigger this method."}),"\n",(0,d.jsx)(n.p,{children:"Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate\nor StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents\nthis from being invoked."}),"\n",(0,d.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,d.jsx)(n.h5,{id:"nextprops",children:"nextProps"}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"Readonly"}),"<",(0,d.jsx)(n.code,{children:"P"}),">"]}),"\n",(0,d.jsx)(n.h5,{id:"nextcontext",children:"nextContext"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.code,{children:"any"})}),"\n",(0,d.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.code,{children:"void"})}),"\n",(0,d.jsx)(n.h4,{id:"deprecated-1",children:"Deprecated"}),"\n",(0,d.jsx)(n.p,{children:"16.3, use static StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps instead; will stop working in React 17"}),"\n",(0,d.jsx)(n.h4,{id:"see-1",children:"See"}),"\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsx)(n.li,{children:(0,d.jsx)(n.a,{href:"https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props",children:"https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props"})}),"\n",(0,d.jsx)(n.li,{children:(0,d.jsx)(n.a,{href:"https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",children:"https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"})}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"React.Component.componentWillReceiveProps\n"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"componentwillunmount",children:"componentWillUnmount()?"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"optional componentWillUnmount(): void;\n"})}),"\n",(0,d.jsxs)(n.p,{children:["Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as\ncancelled network requests, or cleaning up any DOM elements created in ",(0,d.jsx)(n.code,{children:"componentDidMount"}),"."]}),"\n",(0,d.jsx)(n.h4,{id:"returns-6",children:"Returns"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.code,{children:"void"})}),"\n",(0,d.jsx)(n.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"React.Component.componentWillUnmount\n"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"componentwillupdate",children:(0,d.jsx)(n.del,{children:"componentWillUpdate()?"})}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"optional componentWillUpdate(\n   nextProps: Readonly<P>, \n   nextState: Readonly<S>, \n   nextContext: any): void;\n"})}),"\n",(0,d.jsx)(n.p,{children:"Called immediately before rendering when new props or state is received. Not called for the initial render."}),"\n",(0,d.jsx)(n.p,{children:"Note: You cannot call Component.setState here."}),"\n",(0,d.jsx)(n.p,{children:"Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate\nor StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents\nthis from being invoked."}),"\n",(0,d.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,d.jsx)(n.h5,{id:"nextprops-1",children:"nextProps"}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"Readonly"}),"<",(0,d.jsx)(n.code,{children:"P"}),">"]}),"\n",(0,d.jsx)(n.h5,{id:"nextstate",children:"nextState"}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"Readonly"}),"<",(0,d.jsx)(n.code,{children:"S"}),">"]}),"\n",(0,d.jsx)(n.h5,{id:"nextcontext-1",children:"nextContext"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.code,{children:"any"})}),"\n",(0,d.jsx)(n.h4,{id:"returns-7",children:"Returns"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.code,{children:"void"})}),"\n",(0,d.jsx)(n.h4,{id:"deprecated-2",children:"Deprecated"}),"\n",(0,d.jsx)(n.p,{children:"16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17"}),"\n",(0,d.jsx)(n.h4,{id:"see-2",children:"See"}),"\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsx)(n.li,{children:(0,d.jsx)(n.a,{href:"https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update",children:"https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update"})}),"\n",(0,d.jsx)(n.li,{children:(0,d.jsx)(n.a,{href:"https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",children:"https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"})}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"inherited-from-5",children:"Inherited from"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"React.Component.componentWillUpdate\n"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"forceupdate",children:"forceUpdate()"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"forceUpdate(callback?: () => void): void;\n"})}),"\n",(0,d.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,d.jsx)(n.h5,{id:"callback",children:"callback?"}),"\n",(0,d.jsxs)(n.p,{children:["() => ",(0,d.jsx)(n.code,{children:"void"})]}),"\n",(0,d.jsx)(n.h4,{id:"returns-8",children:"Returns"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.code,{children:"void"})}),"\n",(0,d.jsx)(n.h4,{id:"inherited-from-6",children:"Inherited from"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"React.Component.forceUpdate\n"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"getsnapshotbeforeupdate",children:"getSnapshotBeforeUpdate()?"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"optional getSnapshotBeforeUpdate(prevProps: Readonly<P>, prevState: Readonly<S>): any;\n"})}),"\n",(0,d.jsxs)(n.p,{children:["Runs before React applies the result of Component.render render to the document, and\nreturns an object to be given to ",(0,d.jsx)(n.a,{href:"#componentdidupdate",children:"componentDidUpdate"}),". Useful for saving\nthings such as scroll position before Component.render render causes changes to it."]}),"\n",(0,d.jsx)(n.p,{children:"Note: the presence of this method prevents any of the deprecated\nlifecycle events from running."}),"\n",(0,d.jsx)(n.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,d.jsx)(n.h5,{id:"prevprops-1",children:"prevProps"}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"Readonly"}),"<",(0,d.jsx)(n.code,{children:"P"}),">"]}),"\n",(0,d.jsx)(n.h5,{id:"prevstate-1",children:"prevState"}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"Readonly"}),"<",(0,d.jsx)(n.code,{children:"S"}),">"]}),"\n",(0,d.jsx)(n.h4,{id:"returns-9",children:"Returns"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.code,{children:"any"})}),"\n",(0,d.jsx)(n.h4,{id:"inherited-from-7",children:"Inherited from"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"React.Component.getSnapshotBeforeUpdate\n"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"render",children:"render()"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"render(): \n  | string\n  | number\n  | boolean\n  | Iterable<ReactNode, any, any>\n  | Element\n  | null\n  | undefined;\n"})}),"\n",(0,d.jsx)(n.h4,{id:"returns-10",children:"Returns"}),"\n",(0,d.jsxs)(n.p,{children:["| ",(0,d.jsx)(n.code,{children:"string"}),"\n| ",(0,d.jsx)(n.code,{children:"number"}),"\n| ",(0,d.jsx)(n.code,{children:"boolean"}),"\n| ",(0,d.jsx)(n.code,{children:"Iterable"}),"<",(0,d.jsx)(n.code,{children:"ReactNode"}),", ",(0,d.jsx)(n.code,{children:"any"}),", ",(0,d.jsx)(n.code,{children:"any"}),">\n| ",(0,d.jsx)(n.code,{children:"Element"}),"\n| ",(0,d.jsx)(n.code,{children:"null"}),"\n| ",(0,d.jsx)(n.code,{children:"undefined"})]}),"\n",(0,d.jsx)(n.h4,{id:"overrides-2",children:"Overrides"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"React.Component.render\n"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"setstate",children:"setState()"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"setState<K>(state: \n  | {\n}\n  | ((prevState: Readonly<S>, props: Readonly<P>) => \n  | {\n}\n  | Pick<{\n}, K>\n  | null)\n  | Pick<{\n}, K>\n  | null, callback?: () => void): void;\n"})}),"\n",(0,d.jsx)(n.h4,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,d.jsx)(n.h5,{id:"k",children:"K"}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"K"})," ",(0,d.jsx)(n.em,{children:"extends"})," ",(0,d.jsx)(n.code,{children:"never"})]}),"\n",(0,d.jsx)(n.h4,{id:"parameters-7",children:"Parameters"}),"\n",(0,d.jsx)(n.h5,{id:"state",children:"state"}),"\n",(0,d.jsxs)(n.p,{children:["| {\n}\n| ((",(0,d.jsx)(n.code,{children:"prevState"}),": ",(0,d.jsx)(n.code,{children:"Readonly"}),"<",(0,d.jsx)(n.code,{children:"S"}),">, ",(0,d.jsx)(n.code,{children:"props"}),": ",(0,d.jsx)(n.code,{children:"Readonly"}),"<",(0,d.jsx)(n.code,{children:"P"}),">) =>\n| {\n}\n| ",(0,d.jsx)(n.code,{children:"Pick"}),"<{\n}, ",(0,d.jsx)(n.code,{children:"K"}),">\n| ",(0,d.jsx)(n.code,{children:"null"}),")\n| ",(0,d.jsx)(n.code,{children:"Pick"}),"<{\n}, ",(0,d.jsx)(n.code,{children:"K"}),">\n| ",(0,d.jsx)(n.code,{children:"null"})]}),"\n",(0,d.jsx)(n.h5,{id:"callback-1",children:"callback?"}),"\n",(0,d.jsxs)(n.p,{children:["() => ",(0,d.jsx)(n.code,{children:"void"})]}),"\n",(0,d.jsx)(n.h4,{id:"returns-11",children:"Returns"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.code,{children:"void"})}),"\n",(0,d.jsx)(n.h4,{id:"inherited-from-8",children:"Inherited from"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"React.Component.setState\n"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"shouldcomponentupdate",children:"shouldComponentUpdate()?"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"optional shouldComponentUpdate(\n   nextProps: Readonly<P>, \n   nextState: Readonly<S>, \n   nextContext: any): boolean;\n"})}),"\n",(0,d.jsx)(n.p,{children:"Called to determine whether the change in props and state should trigger a re-render."}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"Component"})," always returns true.\n",(0,d.jsx)(n.code,{children:"PureComponent"})," implements a shallow comparison on props and state and returns true if any\nprops or states have changed."]}),"\n",(0,d.jsxs)(n.p,{children:["If false is returned, Component.render, ",(0,d.jsx)(n.code,{children:"componentWillUpdate"}),"\nand ",(0,d.jsx)(n.code,{children:"componentDidUpdate"})," will not be called."]}),"\n",(0,d.jsx)(n.h4,{id:"parameters-8",children:"Parameters"}),"\n",(0,d.jsx)(n.h5,{id:"nextprops-2",children:"nextProps"}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"Readonly"}),"<",(0,d.jsx)(n.code,{children:"P"}),">"]}),"\n",(0,d.jsx)(n.h5,{id:"nextstate-1",children:"nextState"}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"Readonly"}),"<",(0,d.jsx)(n.code,{children:"S"}),">"]}),"\n",(0,d.jsx)(n.h5,{id:"nextcontext-2",children:"nextContext"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.code,{children:"any"})}),"\n",(0,d.jsx)(n.h4,{id:"returns-12",children:"Returns"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.code,{children:"boolean"})}),"\n",(0,d.jsx)(n.h4,{id:"inherited-from-9",children:"Inherited from"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"React.Component.shouldComponentUpdate\n"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"unsafe_componentwillmount",children:(0,d.jsx)(n.del,{children:"UNSAFE_componentWillMount()?"})}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"optional UNSAFE_componentWillMount(): void;\n"})}),"\n",(0,d.jsx)(n.p,{children:"Called immediately before mounting occurs, and before Component.render.\nAvoid introducing any side-effects or subscriptions in this method."}),"\n",(0,d.jsx)(n.p,{children:"This method will not stop working in React 17."}),"\n",(0,d.jsx)(n.p,{children:"Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate\nor StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents\nthis from being invoked."}),"\n",(0,d.jsx)(n.h4,{id:"returns-13",children:"Returns"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.code,{children:"void"})}),"\n",(0,d.jsx)(n.h4,{id:"deprecated-3",children:"Deprecated"}),"\n",(0,d.jsx)(n.p,{children:"16.3, use ComponentLifecycle.componentDidMount componentDidMount or the constructor instead"}),"\n",(0,d.jsx)(n.h4,{id:"see-3",children:"See"}),"\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsx)(n.li,{children:(0,d.jsx)(n.a,{href:"https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state",children:"https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state"})}),"\n",(0,d.jsx)(n.li,{children:(0,d.jsx)(n.a,{href:"https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",children:"https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"})}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"inherited-from-10",children:"Inherited from"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"React.Component.UNSAFE_componentWillMount\n"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"unsafe_componentwillreceiveprops",children:(0,d.jsx)(n.del,{children:"UNSAFE_componentWillReceiveProps()?"})}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"optional UNSAFE_componentWillReceiveProps(nextProps: Readonly<P>, nextContext: any): void;\n"})}),"\n",(0,d.jsx)(n.p,{children:"Called when the component may be receiving new props.\nReact may call this even if props have not changed, so be sure to compare new and existing\nprops if you only want to handle changes."}),"\n",(0,d.jsx)(n.p,{children:"Calling Component.setState generally does not trigger this method."}),"\n",(0,d.jsx)(n.p,{children:"This method will not stop working in React 17."}),"\n",(0,d.jsx)(n.p,{children:"Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate\nor StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents\nthis from being invoked."}),"\n",(0,d.jsx)(n.h4,{id:"parameters-9",children:"Parameters"}),"\n",(0,d.jsx)(n.h5,{id:"nextprops-3",children:"nextProps"}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"Readonly"}),"<",(0,d.jsx)(n.code,{children:"P"}),">"]}),"\n",(0,d.jsx)(n.h5,{id:"nextcontext-3",children:"nextContext"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.code,{children:"any"})}),"\n",(0,d.jsx)(n.h4,{id:"returns-14",children:"Returns"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.code,{children:"void"})}),"\n",(0,d.jsx)(n.h4,{id:"deprecated-4",children:"Deprecated"}),"\n",(0,d.jsx)(n.p,{children:"16.3, use static StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps instead"}),"\n",(0,d.jsx)(n.h4,{id:"see-4",children:"See"}),"\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsx)(n.li,{children:(0,d.jsx)(n.a,{href:"https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props",children:"https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props"})}),"\n",(0,d.jsx)(n.li,{children:(0,d.jsx)(n.a,{href:"https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",children:"https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"})}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"inherited-from-11",children:"Inherited from"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"React.Component.UNSAFE_componentWillReceiveProps\n"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"unsafe_componentwillupdate",children:(0,d.jsx)(n.del,{children:"UNSAFE_componentWillUpdate()?"})}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"optional UNSAFE_componentWillUpdate(\n   nextProps: Readonly<P>, \n   nextState: Readonly<S>, \n   nextContext: any): void;\n"})}),"\n",(0,d.jsx)(n.p,{children:"Called immediately before rendering when new props or state is received. Not called for the initial render."}),"\n",(0,d.jsx)(n.p,{children:"Note: You cannot call Component.setState here."}),"\n",(0,d.jsx)(n.p,{children:"This method will not stop working in React 17."}),"\n",(0,d.jsx)(n.p,{children:"Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate\nor StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents\nthis from being invoked."}),"\n",(0,d.jsx)(n.h4,{id:"parameters-10",children:"Parameters"}),"\n",(0,d.jsx)(n.h5,{id:"nextprops-4",children:"nextProps"}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"Readonly"}),"<",(0,d.jsx)(n.code,{children:"P"}),">"]}),"\n",(0,d.jsx)(n.h5,{id:"nextstate-2",children:"nextState"}),"\n",(0,d.jsxs)(n.p,{children:[(0,d.jsx)(n.code,{children:"Readonly"}),"<",(0,d.jsx)(n.code,{children:"S"}),">"]}),"\n",(0,d.jsx)(n.h5,{id:"nextcontext-4",children:"nextContext"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.code,{children:"any"})}),"\n",(0,d.jsx)(n.h4,{id:"returns-15",children:"Returns"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.code,{children:"void"})}),"\n",(0,d.jsx)(n.h4,{id:"deprecated-5",children:"Deprecated"}),"\n",(0,d.jsx)(n.p,{children:"16.3, use getSnapshotBeforeUpdate instead"}),"\n",(0,d.jsx)(n.h4,{id:"see-5",children:"See"}),"\n",(0,d.jsxs)(n.ul,{children:["\n",(0,d.jsx)(n.li,{children:(0,d.jsx)(n.a,{href:"https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update",children:"https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update"})}),"\n",(0,d.jsx)(n.li,{children:(0,d.jsx)(n.a,{href:"https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path",children:"https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path"})}),"\n"]}),"\n",(0,d.jsx)(n.h4,{id:"inherited-from-12",children:"Inherited from"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"React.Component.UNSAFE_componentWillUpdate\n"})}),"\n",(0,d.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,d.jsx)(n.h3,{id:"context",children:"context"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"context: unknown;\n"})}),"\n",(0,d.jsxs)(n.p,{children:["If using the new style context, re-declare this in your class to be the\n",(0,d.jsx)(n.code,{children:"React.ContextType"})," of your ",(0,d.jsx)(n.code,{children:"static contextType"}),".\nShould be used with type annotation or static contextType."]}),"\n",(0,d.jsx)(n.h4,{id:"example-1",children:"Example"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"static contextType = MyContext\n// For TS pre-3.7:\ncontext!: React.ContextType<typeof MyContext>\n// For TS 3.7 and above:\ndeclare context: React.ContextType<typeof MyContext>\n"})}),"\n",(0,d.jsx)(n.h4,{id:"see-6",children:"See"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://react.dev/reference/react/Component#context",children:"React Docs"})}),"\n",(0,d.jsx)(n.h4,{id:"inherited-from-13",children:"Inherited from"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"React.Component.context\n"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"props-1",children:"props"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"readonly props: Readonly<P>;\n"})}),"\n",(0,d.jsx)(n.h4,{id:"inherited-from-14",children:"Inherited from"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"React.Component.props\n"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"refs",children:(0,d.jsx)(n.del,{children:"refs"})}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"refs: {\n[key: string]: ReactInstance;\n};\n"})}),"\n",(0,d.jsx)(n.h4,{id:"index-signature",children:"Index Signature"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"[key: string]: ReactInstance\n"})}),"\n",(0,d.jsx)(n.h4,{id:"deprecated-6",children:"Deprecated"}),"\n",(0,d.jsx)(n.h4,{id:"see-7",children:"See"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://legacy.reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs",children:"Legacy React Docs"})}),"\n",(0,d.jsx)(n.h4,{id:"inherited-from-15",children:"Inherited from"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"React.Component.refs\n"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"state-1",children:"state"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"state: Readonly<S>;\n"})}),"\n",(0,d.jsx)(n.h4,{id:"inherited-from-16",children:"Inherited from"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"React.Component.state\n"})}),"\n",(0,d.jsx)(n.hr,{}),"\n",(0,d.jsx)(n.h3,{id:"contexttype",children:"contextType?"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"static optional contextType?: Context<any>;\n"})}),"\n",(0,d.jsxs)(n.p,{children:["If set, ",(0,d.jsx)(n.code,{children:"this.context"})," will be set at runtime to the current value of the given Context."]}),"\n",(0,d.jsx)(n.h4,{id:"example-2",children:"Example"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"type MyContext = number\nconst Ctx = React.createContext<MyContext>(0)\n\nclass Foo extends React.Component {\n  static contextType = Ctx\n  context!: React.ContextType<typeof Ctx>\n  render () {\n    return <>My context's value: {this.context}</>;\n  }\n}\n"})}),"\n",(0,d.jsx)(n.h4,{id:"see-8",children:"See"}),"\n",(0,d.jsx)(n.p,{children:(0,d.jsx)(n.a,{href:"https://react.dev/reference/react/Component#static-contexttype",children:"https://react.dev/reference/react/Component#static-contexttype"})}),"\n",(0,d.jsx)(n.h4,{id:"inherited-from-17",children:"Inherited from"}),"\n",(0,d.jsx)(n.pre,{children:(0,d.jsx)(n.code,{className:"language-ts",children:"React.Component.contextType\n"})})]})}function h(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,d.jsx)(n,{...e,children:(0,d.jsx)(c,{...e})}):c(e)}},5676(e,n,r){r.d(n,{R:()=>s,x:()=>i});var t=r(758);const d={},l=t.createContext(d);function s(e){const n=t.useContext(l);return t.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:s(e.components),t.createElement(l.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/2b2c5b3b.a5c2ffde.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[9408],{100(e,n,s){s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>c,frontMatter:()=>l,metadata:()=>i,toc:()=>a});const i=JSON.parse('{"id":"api/interfaces/GuestProps","title":"GuestProps\\\\<AppObjects, AppEvents\\\\>","description":"Extends","source":"@site/docs/api/interfaces/GuestProps.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/GuestProps","permalink":"/app-sdk/api/interfaces/GuestProps","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/interfaces/GuestProps.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"AppConfig","permalink":"/app-sdk/api/interfaces/AppConfig"},"next":{"title":"UseStateSelectorOptions\\\\<Selected\\\\>","permalink":"/app-sdk/api/interfaces/UseStateSelectorOptions"}}');var r=s(6070),t=s(5676);const l={},d="GuestProps<AppObjects, AppEvents>",o={},a=[{value:"Extends",id:"extends",level:2},{value:"Type Parameters",id:"type-parameters",level:2},{value:"AppObjects",id:"appobjects",level:3},{value:"AppEvents",id:"appevents",level:3},{value:"Properties",id:"properties",level:2},{value:"containerId",id:"containerid",level:3},{value:"history",id:"history",level:3},{value:"Overrides",id:"overrides",level:4},{value:"homeRoute?",id:"homeroute",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"host?",id:"host",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"hostBreakpoint?",id:"hostbreakpoint",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"hostName?",id:"hostname",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"hostUrl?",id:"hosturl",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"hostViewportSize?",id:"hostviewportsize",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"initialRoute?",id:"initialroute",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"manifestPath?",id:"manifestpath",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"prevState",id:"prevstate",level:3},{value:"Overrides",id:"overrides-1",level:4},{value:"theme",id:"theme",level:3},{value:"Overrides",id:"overrides-2",level:4}];function h(e){const n={code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",pre:"pre",ul:"ul",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"guestpropsappobjects-appevents",children:"GuestProps<AppObjects, AppEvents>"})}),"\n",(0,r.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"InitOptions"}),"<",(0,r.jsx)(n.code,{children:"AppObjects"}),", ",(0,r.jsx)(n.code,{children:"AppEvents"}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,r.jsx)(n.h3,{id:"appobjects",children:"AppObjects"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"AppObjects"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"ScriptingObjects"})," = ",(0,r.jsx)(n.code,{children:"Partial"}),"<",(0,r.jsx)(n.code,{children:"ScriptingObjectTypes"}),">"]}),"\n",(0,r.jsx)(n.h3,{id:"appevents",children:"AppEvents"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"AppEvents"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"EventListeners"})," = ",(0,r.jsx)(n.code,{children:"Events"})]}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"containerid",children:"containerId"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"containerId: string;\n"})}),"\n",(0,r.jsxs)(n.p,{children:["DOM element ID where the guest app should render. Defaults to\nDEFAULT_CONTAINER_ID and can be overridden by the host via module\nparameters or the MountOptions passed to ",(0,r.jsx)(n.code,{children:"mount()"}),"."]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"history",children:"history"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"history: History;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"overrides",children:"Overrides"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"InitOptions.history\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"homeroute",children:"homeRoute?"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"optional homeRoute?: string;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"InitOptions.homeRoute\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"host",children:"host?"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"optional host?: \n  | IMicroAppHost<Partial<ScriptingObjectTypes>, Events>\n  | IMicroFEHost<AppObjects, AppEvents>\n| SSFGuest<AppObjects, AppEvents>;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"InitOptions.host\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"hostbreakpoint",children:"hostBreakpoint?"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"optional hostBreakpoint?: keyof BreakPoints;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"InitOptions.hostBreakpoint\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"hostname",children:"hostName?"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"optional hostName?: string;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"InitOptions.hostName\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"hosturl",children:"hostUrl?"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"optional hostUrl?: string;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"InitOptions.hostUrl\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"hostviewportsize",children:"hostViewportSize?"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"optional hostViewportSize?: ViewportSize;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-5",children:"Inherited from"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"InitOptions.hostViewportSize\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"initialroute",children:"initialRoute?"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"optional initialRoute?: To;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-6",children:"Inherited from"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"InitOptions.initialRoute\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"manifestpath",children:"manifestPath?"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"optional manifestPath?: string;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-7",children:"Inherited from"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"InitOptions.manifestPath\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"prevstate",children:"prevState"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"prevState: JSONValue;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"overrides-1",children:"Overrides"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"InitOptions.prevState\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"theme",children:"theme"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"theme: DefaultTheme;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"overrides-2",children:"Overrides"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"InitOptions.theme\n"})})]})}function c(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},5676(e,n,s){s.d(n,{R:()=>l,x:()=>d});var i=s(758);const r={},t=i.createContext(r);function l(e){const n=i.useContext(t);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:l(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/3072782a.aa783791.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[4835],{9064(e,n,t){t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>p,frontMatter:()=>i,metadata:()=>s,toc:()=>c});const s=JSON.parse('{"id":"api/functions/sendBAEvent","title":"~~sendBAEvent()~~","description":"Sends a business analytics event to Google Tag Manager data layer.","source":"@site/docs/api/functions/sendBAEvent.md","sourceDirName":"api/functions","slug":"/api/functions/sendBAEvent","permalink":"/app-sdk/api/functions/sendBAEvent","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/sendBAEvent.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"sdkBaseQuery()","permalink":"/app-sdk/api/functions/sdkBaseQuery"},"next":{"title":"sendMessageToHost()","permalink":"/app-sdk/api/functions/sendMessageToHost"}}');var a=t(6070),d=t(5676);const i={},r="sendBAEvent()",l={},c=[{value:"Parameters",id:"parameters",level:2},{value:"config",id:"config",level:3},{value:"data",id:"data",level:4},{value:"self?",id:"self",level:4},{value:"Returns",id:"returns",level:2},{value:"Deprecated",id:"deprecated",level:2},{value:"Example",id:"example",level:2}];function o(e){const n={code:"code",del:"del",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",pre:"pre",...(0,d.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.header,{children:(0,a.jsx)(n.h1,{id:"sendbaevent",children:(0,a.jsx)(n.del,{children:"sendBAEvent()"})})}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"function sendBAEvent(config: {\n  data: BAEvent;\n  self?: boolean;\n}): void;\n"})}),"\n",(0,a.jsx)(n.p,{children:"Sends a business analytics event to Google Tag Manager data layer.\nCan send events to the host app or handle locally."}),"\n",(0,a.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,a.jsx)(n.h3,{id:"config",children:"config"}),"\n",(0,a.jsx)(n.p,{children:"Event configuration"}),"\n",(0,a.jsx)(n.h4,{id:"data",children:"data"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.code,{children:"BAEvent"})}),"\n",(0,a.jsx)(n.p,{children:"The analytics event data"}),"\n",(0,a.jsx)(n.h4,{id:"self",children:"self?"}),"\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.code,{children:"boolean"})," = ",(0,a.jsx)(n.code,{children:"true"})]}),"\n",(0,a.jsx)(n.p,{children:"If true, sends to self; if false, sends to host app (default: true)"}),"\n",(0,a.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.code,{children:"void"})}),"\n",(0,a.jsx)(n.h2,{id:"deprecated",children:"Deprecated"}),"\n",(0,a.jsx)(n.p,{children:"Use Analytics.sendBAEvent scripting object method instead"}),"\n",(0,a.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-typescript",children:"sendBAEvent({\n  data: {\n    eventName: 'button_click',\n    eventCategory: 'user_interaction',\n    eventData: { buttonId: 'submit' }\n  },\n  self: true\n});\n"})})]})}function p(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(o,{...e})}):o(e)}},5676(e,n,t){t.d(n,{R:()=>i,x:()=>r});var s=t(758);const a={},d=s.createContext(a);function i(e){const n=s.useContext(d);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(a):e.components||a:i(e.components),s.createElement(d.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/3204d46b.1ff5c3fd.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[8644],{3361(e,n,s){s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>a,metadata:()=>t,toc:()=>l});const t=JSON.parse('{"id":"api/functions/getHTTPClient","title":"getHTTPClient()","description":"Creates a basic HTTP client instance using Axios.","source":"@site/docs/api/functions/getHTTPClient.md","sourceDirName":"api/functions","slug":"/api/functions/getHTTPClient","permalink":"/app-sdk/api/functions/getHTTPClient","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/getHTTPClient.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"getAuthorizationHeader()","permalink":"/app-sdk/api/functions/getAuthorizationHeader"},"next":{"title":"getHostAppDataByKey()","permalink":"/app-sdk/api/functions/getHostAppDataByKey"}}');var i=s(6070),r=s(5676);const a={},o="getHTTPClient()",c={},l=[{value:"Parameters",id:"parameters",level:2},{value:"config?",id:"config",level:3},{value:"baseURL?",id:"baseurl",level:4},{value:"headers?",id:"headers",level:4},{value:"sendLogRocketSessionHeader?",id:"sendlogrocketsessionheader",level:4},{value:"Returns",id:"returns",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,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"gethttpclient",children:"getHTTPClient()"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function getHTTPClient(config?: {\n  baseURL?: string;\n  headers?: RequestConfig;\n  sendLogRocketSessionHeader?: boolean;\n}): AxiosInstance;\n"})}),"\n",(0,i.jsx)(n.p,{children:"Creates a basic HTTP client instance using Axios.\nThe client includes request/response interceptors and automatic retry logic."}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsx)(n.h3,{id:"config",children:"config?"}),"\n",(0,i.jsx)(n.p,{children:"Configuration options"}),"\n",(0,i.jsx)(n.h4,{id:"baseurl",children:"baseURL?"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"string"})," = ",(0,i.jsx)(n.code,{children:"..."})]}),"\n",(0,i.jsx)(n.p,{children:"Base URL for API requests (defaults to app config value)"}),"\n",(0,i.jsx)(n.h4,{id:"headers",children:"headers?"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"RequestConfig"})," = ",(0,i.jsx)(n.code,{children:"{}"})]}),"\n",(0,i.jsx)(n.p,{children:"Custom headers to include in requests"}),"\n",(0,i.jsx)(n.h4,{id:"sendlogrocketsessionheader",children:"sendLogRocketSessionHeader?"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"boolean"})," = ",(0,i.jsx)(n.code,{children:"true"})]}),"\n",(0,i.jsxs)(n.p,{children:["Attach ",(0,i.jsx)(n.code,{children:"X-ICE-AppSessionLink"})," when LogRocket session URL is available (default ",(0,i.jsx)(n.code,{children:"true"}),")"]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"AxiosInstance"})}),"\n",(0,i.jsx)(n.p,{children:"Configured Axios instance"}),"\n",(0,i.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-typescript",children:"const client = getHTTPClient({\n  baseURL: 'https://api.example.com',\n  headers: { 'X-Custom-Header': 'value' }\n});\nconst response = await client.get('/endpoint');\n"})})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},5676(e,n,s){s.d(n,{R:()=>a,x:()=>o});var t=s(758);const i={},r=t.createContext(i);function a(e){const n=t.useContext(r);return t.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/322ec2e7.68dc3585.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[2212],{5797(e,t,n){n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>i,metadata:()=>r,toc:()=>d});const r=JSON.parse('{"id":"api/functions/removeStorageEvents","title":"removeStorageEvents()","description":"Returns","source":"@site/docs/api/functions/removeStorageEvents.md","sourceDirName":"api/functions","slug":"/api/functions/removeStorageEvents","permalink":"/app-sdk/api/functions/removeStorageEvents","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/removeStorageEvents.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"removeDoubleSlash()","permalink":"/app-sdk/api/functions/removeDoubleSlash"},"next":{"title":"render()","permalink":"/app-sdk/api/functions/render"}}');var o=n(6070),s=n(5676);const i={},a="removeStorageEvents()",c={},d=[{value:"Returns",id:"returns",level:2}];function p(e){const t={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.header,{children:(0,o.jsx)(t.h1,{id:"removestorageevents",children:"removeStorageEvents()"})}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-ts",children:"function removeStorageEvents(): void;\n"})}),"\n",(0,o.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.code,{children:"void"})})]})}function u(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},5676(e,t,n){n.d(t,{R:()=>i,x:()=>a});var r=n(758);const o={},s=r.createContext(o);function i(e){const t=r.useContext(s);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(o):e.components||o:i(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/336f5910.1650e1b8.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[5880],{2926(e,t,n){n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>p,default:()=>l,frontMatter:()=>i,metadata:()=>s,toc:()=>c});const s=JSON.parse('{"id":"api/functions/fetchHostAppData","title":"fetchHostAppData()","description":"Parameters","source":"@site/docs/api/functions/fetchHostAppData.md","sourceDirName":"api/functions","slug":"/api/functions/fetchHostAppData","permalink":"/app-sdk/api/functions/fetchHostAppData","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/fetchHostAppData.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"enableReactAppForHostIntegration()","permalink":"/app-sdk/api/functions/enableReactAppForHostIntegration"},"next":{"title":"fetchUserSettings()","permalink":"/app-sdk/api/functions/fetchUserSettings"}}');var r=n(6070),a=n(5676);const i={},p="fetchHostAppData()",o={},c=[{value:"Parameters",id:"parameters",level:2},{value:"hostedAppUrl",id:"hostedappurl",level:3},{value:"guestAppId",id:"guestappid",level:3},{value:"Returns",id:"returns",level:2}];function d(e){const t={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)(t.header,{children:(0,r.jsx)(t.h1,{id:"fetchhostappdata",children:"fetchHostAppData()"})}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ts",children:"function fetchHostAppData(hostedAppUrl: string, guestAppId: string): Promise<void>;\n"})}),"\n",(0,r.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsx)(t.h3,{id:"hostedappurl",children:"hostedAppUrl"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.code,{children:"string"})}),"\n",(0,r.jsx)(t.h3,{id:"guestappid",children:"guestAppId"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.code,{children:"string"})}),"\n",(0,r.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.code,{children:"Promise"}),"<",(0,r.jsx)(t.code,{children:"void"}),">"]})]})}function l(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},5676(e,t,n){n.d(t,{R:()=>i,x:()=>p});var s=n(758);const r={},a=s.createContext(r);function i(e){const t=s.useContext(a);return s.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function p(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),s.createElement(a.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/365a2c17.e11f7ef1.js

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

package/build/docs/assets/js/379bbc32.6e5c274c.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[2486],{9180(e,t,r){r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>n,metadata:()=>s,toc:()=>d});const s=JSON.parse('{"id":"api/variables/removeSideEffect","title":"removeSideEffect","description":"Removes a side effect listener.","source":"@site/docs/api/variables/removeSideEffect.md","sourceDirName":"api/variables","slug":"/api/variables/removeSideEffect","permalink":"/app-sdk/api/variables/removeSideEffect","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/variables/removeSideEffect.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"memoryHistory","permalink":"/app-sdk/api/variables/memoryHistory"},"next":{"title":"resetUserIdleTime","permalink":"/app-sdk/api/variables/resetUserIdleTime"}}');var i=r(6070),a=r(5676);const n={},o="removeSideEffect",c={},d=[{value:"Example",id:"example",level:2}];function l(e){const t={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.header,{children:(0,i.jsx)(t.h1,{id:"removesideeffect",children:"removeSideEffect"})}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-ts",children:"const removeSideEffect: TypedRemoveListener<CombinedState<{\n  breakpoint: BreakpointState;\n  error: ErrorState;\n  liveMessage: LiveMessageState;\n  waitMessage: WaitMessageState;\n}>, AppDispatch>;\n"})}),"\n",(0,i.jsx)(t.p,{children:"Removes a side effect listener."}),"\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:"const unsubscribe = startSideEffect({...});\nremoveSideEffect(unsubscribe);\n"})})]})}function p(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},5676(e,t,r){r.d(t,{R:()=>n,x:()=>o});var s=r(758);const i={},a=s.createContext(i);function n(e){const t=s.useContext(a);return s.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:n(e.components),s.createElement(a.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/3accd241.1030f906.js

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

package/build/docs/assets/js/3b0e1261.a37f3651.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk||=[]).push([[6051],{8225(e,r,t){t.r(r),t.d(r,{assets:()=>s,contentTitle:()=>o,default:()=>l,frontMatter:()=>a,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://git.elliemae.io/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 a={},o="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:()=>a,x:()=>o});var n=t(758);const i={},p=n.createContext(i);function a(e){const r=n.useContext(p);return n.useMemo(function(){return"function"==typeof e?e(r):{...r,...e}},[r,e])}function o(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),n.createElement(p.Provider,{value:r},e.children)}}}]);

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

@@ -1 +0,0 @@
-"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://git.elliemae.io/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.83d64f7a.js

@@ -1 +0,0 @@
-"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:()=>l,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://git.elliemae.io/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 l(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.7b0c1b24.js

@@ -1 +0,0 @@
-"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:()=>u});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://git.elliemae.io/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 i=r(6070),t=r(5676);const a={},o="sdkBaseQuery()",d={},u=[{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 c(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"sdkbasequery",children:"sdkBaseQuery()"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function sdkBaseQuery(config?: {\n  authorization?: string;\n  baseUrl?: string;\n}): BaseQueryFunction;\n"})}),"\n",(0,i.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,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsx)(n.h3,{id:"config",children:"config?"}),"\n",(0,i.jsx)(n.p,{children:"Configuration options"}),"\n",(0,i.jsx)(n.h4,{id:"authorization",children:"authorization?"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"string"})}),"\n",(0,i.jsx)(n.p,{children:"Authorization token applied to every request;\noverrides the session-stored token. Per-endpoint headers still take precedence."}),"\n",(0,i.jsx)(n.h4,{id:"baseurl",children:"baseUrl?"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"string"})}),"\n",(0,i.jsx)(n.p,{children:"Base URL for API requests"}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"BaseQueryFunction"})}),"\n",(0,i.jsx)(n.p,{children:"RTK Query base query function"}),"\n",(0,i.jsx)(n.h2,{id:"examples",children:"Examples"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.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,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Passing a custom authorization token at the slice level:"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.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,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Overriding the token for a specific endpoint via headers:"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.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,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},5676(e,n,r){r.d(n,{R:()=>a,x:()=>o});var s=r(758);const i={},t=s.createContext(i);function a(e){const n=s.useContext(t);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(i):e.components||i:a(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/413bfdf1.6fd754f1.js

@@ -1 +0,0 @@
-"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:()=>u});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://git.elliemae.io/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={},u=[{value:"Parameters",id:"parameters",level:2},{value:"__namedParameters",id:"__namedparameters",level:3},{value:"Returns",id:"returns",level:2}];function c(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)(c,{...e})}):c(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)}}}]);