@elliemae/pui-app-sdk 5.40.3 → 5.40.5

package/build/docs/assets/js/15f40f8f.62fbc501.js

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

package/build/docs/assets/js/1617.443ab77e.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[1617],{1617(e,a,i){i.d(a,{createEventModelingServices:()=>l.g});var l=i(8382);i(3228)}}]);

package/build/docs/assets/js/16427680.5a41da14.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[7623],{2683(e,t,n){n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>a,toc:()=>c});const a=JSON.parse('{"id":"api/functions/enableReactAppForHostIntegration","title":"enableReactAppForHostIntegration()","description":"Parameters","source":"@site/docs/api/functions/enableReactAppForHostIntegration.md","sourceDirName":"api/functions","slug":"/api/functions/enableReactAppForHostIntegration","permalink":"/app-sdk/api/functions/enableReactAppForHostIntegration","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/functions/enableReactAppForHostIntegration.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"createManager()","permalink":"/app-sdk/api/functions/createManager"},"next":{"title":"fetchHostAppData()","permalink":"/app-sdk/api/functions/fetchHostAppData"}}');var r=n(6070),s=n(5589);const o={},i="enableReactAppForHostIntegration()",p={},c=[{value:"Parameters",id:"parameters",level:2},{value:"__namedParameters",id:"__namedparameters",level:3},{value:"Returns",id:"returns",level:2}];function l(e){const t={a:"a",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:"enablereactappforhostintegration",children:"enableReactAppForHostIntegration()"})}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ts",children:"function enableReactAppForHostIntegration(__namedParameters: Options): CMicroAppGuest;\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:"Options"})}),"\n",(0,r.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"/app-sdk/api/classes/CMicroAppGuest",children:(0,r.jsx)(t.code,{children:"CMicroAppGuest"})})})]})}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)}},5589(e,t,n){n.d(t,{R:()=>o,x:()=>i});var a=n(758);const r={},s=a.createContext(r);function o(e){const t=a.useContext(s);return a.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(r):e.components||r:o(e.components),a.createElement(s.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/16fba083.0c978e4b.js

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

package/build/docs/assets/js/1700.bb38b1b9.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[1700],{1700(e,a,p){p.d(a,{createTreemapServices:()=>i.d});var i=p(5419);p(3228)}}]);

package/build/docs/assets/js/17896441.87af09c7.js

@@ -1 +0,0 @@
-(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[8401],{8772(e,n,t){"use strict";t.r(n),t.d(n,{default:()=>ss});var s=t(758),a=t(6194),r=t(358),o=t(6070);const i=s.createContext(null);function c({children:e,content:n}){const t=function(e){return(0,s.useMemo)(()=>({metadata:e.metadata,frontMatter:e.frontMatter,assets:e.assets,contentTitle:e.contentTitle,toc:e.toc}),[e])}(n);return(0,o.jsx)(i.Provider,{value:t,children:e})}function l(){const e=(0,s.useContext)(i);if(null===e)throw new r.dV("DocProvider");return e}function d(){const{metadata:e,frontMatter:n,assets:t}=l();return(0,o.jsx)(a.be,{title:e.title,description:e.description,keywords:n.keywords,image:t.image??n.image})}var u=t(3526),m=t(3527),h=t(8114),f=t(2052);function p(e){const{permalink:n,title:t,subLabel:s,isNext:a}=e;return(0,o.jsxs)(f.A,{className:(0,u.A)("pagination-nav__link",a?"pagination-nav__link--next":"pagination-nav__link--prev"),to:n,children:[s&&(0,o.jsx)("div",{className:"pagination-nav__sublabel",children:s}),(0,o.jsx)("div",{className:"pagination-nav__label",children:t})]})}function g(e){const{className:n,previous:t,next:s}=e;return(0,o.jsxs)("nav",{className:(0,u.A)(n,"pagination-nav"),"aria-label":(0,h.T)({id:"theme.docs.paginator.navAriaLabel",message:"Docs pages",description:"The ARIA label for the docs pagination"}),children:[t&&(0,o.jsx)(p,{...t,subLabel:(0,o.jsx)(h.A,{id:"theme.docs.paginator.previous",description:"The label used to navigate to the previous doc",children:"Previous"})}),s&&(0,o.jsx)(p,{...s,subLabel:(0,o.jsx)(h.A,{id:"theme.docs.paginator.next",description:"The label used to navigate to the next doc",children:"Next"}),isNext:!0})]})}function x(){const{metadata:e}=l();return(0,o.jsx)(g,{className:"docusaurus-mt-lg",previous:e.previous,next:e.next})}var b=t(9500),j=t(7506),v=t(4157),N=t(6819),A=t(2166);const y={unreleased:function({siteTitle:e,versionMetadata:n}){return(0,o.jsx)(h.A,{id:"theme.docs.versions.unreleasedVersionLabel",description:"The label used to tell the user that he's browsing an unreleased doc version",values:{siteTitle:e,versionLabel:(0,o.jsx)("b",{children:n.label})},children:"This is unreleased documentation for {siteTitle} {versionLabel} version."})},unmaintained:function({siteTitle:e,versionMetadata:n}){return(0,o.jsx)(h.A,{id:"theme.docs.versions.unmaintainedVersionLabel",description:"The label used to tell the user that he's browsing an unmaintained doc version",values:{siteTitle:e,versionLabel:(0,o.jsx)("b",{children:n.label})},children:"This is documentation for {siteTitle} {versionLabel}, which is no longer actively maintained."})}};function w(e){const n=y[e.versionMetadata.banner];return(0,o.jsx)(n,{...e})}function k({versionLabel:e,to:n,onClick:t}){return(0,o.jsx)(h.A,{id:"theme.docs.versions.latestVersionSuggestionLabel",description:"The label used to tell the user to check the latest version",values:{versionLabel:e,latestVersionLink:(0,o.jsx)("b",{children:(0,o.jsx)(f.A,{to:n,onClick:t,children:(0,o.jsx)(h.A,{id:"theme.docs.versions.latestVersionLinkLabel",description:"The label used for the latest version suggestion link label",children:"latest version"})})})},children:"For up-to-date documentation, see the {latestVersionLink} ({versionLabel})."})}function C({className:e,versionMetadata:n}){const{siteConfig:{title:t}}=(0,b.A)(),{pluginId:s}=(0,j.vT)({failfast:!0}),{savePreferredVersionName:a}=(0,N.g1)(s),{latestDocSuggestion:r,latestVersionSuggestion:i}=(0,j.HW)(s),c=r??(l=i).docs.find(e=>e.id===l.mainDocId);var l;return(0,o.jsxs)("div",{className:(0,u.A)(e,v.G.docs.docVersionBanner,"alert alert--warning margin-bottom--md"),role:"alert",children:[(0,o.jsx)("div",{children:(0,o.jsx)(w,{siteTitle:t,versionMetadata:n})}),(0,o.jsx)("div",{className:"margin-top--md",children:(0,o.jsx)(k,{versionLabel:i.label,to:c.path,onClick:()=>a(i.name)})})]})}function L({className:e}){const n=(0,A.r)();return n.banner?(0,o.jsx)(C,{className:e,versionMetadata:n}):null}function _({className:e}){const n=(0,A.r)();return n.badge?(0,o.jsx)("span",{className:(0,u.A)(e,v.G.docs.docVersionBadge,"badge badge--secondary"),children:(0,o.jsx)(h.A,{id:"theme.docs.versionBadge.label",values:{versionLabel:n.label},children:"Version: {versionLabel}"})}):null}const T="tag_k2Aw",B="tagRegular_aPR0",E="tagWithCount_iYWA";function H({permalink:e,label:n,count:t,description:s}){return(0,o.jsxs)(f.A,{rel:"tag",href:e,title:s,className:(0,u.A)(T,t?E:B),children:[n,t&&(0,o.jsx)("span",{children:t})]})}const M="tags_GASv",I="tag_KxT8";function S({tags:e}){return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("b",{children:(0,o.jsx)(h.A,{id:"theme.tags.tagsListLabel",description:"The label alongside a tag list",children:"Tags:"})}),(0,o.jsx)("ul",{className:(0,u.A)(M,"padding--none","margin-left--sm"),children:e.map(e=>(0,o.jsx)("li",{className:I,children:(0,o.jsx)(H,{...e})},e.permalink))})]})}const U="iconEdit_lW2Z";function V({className:e,...n}){return(0,o.jsx)("svg",{fill:"currentColor",height:"20",width:"20",viewBox:"0 0 40 40",className:(0,u.A)(U,e),"aria-hidden":"true",...n,children:(0,o.jsx)("g",{children:(0,o.jsx)("path",{d:"m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"})})})}function R({editUrl:e}){return(0,o.jsxs)(f.A,{to:e,className:v.G.common.editThisPage,children:[(0,o.jsx)(V,{}),(0,o.jsx)(h.A,{id:"theme.common.editThisPage",description:"The link label to edit the current page",children:"Edit this page"})]})}function $(e={}){const{i18n:{currentLocale:n}}=(0,b.A)(),t=function(){const{i18n:{currentLocale:e,localeConfigs:n}}=(0,b.A)();return n[e].calendar}();return new Intl.DateTimeFormat(n,{calendar:t,...e})}function D({lastUpdatedAt:e}){const n=new Date(e),t=$({day:"numeric",month:"short",year:"numeric",timeZone:"UTC"}).format(n);return(0,o.jsx)(h.A,{id:"theme.lastUpdated.atDate",description:"The words used to describe on which date a page has been last updated",values:{date:(0,o.jsx)("b",{children:(0,o.jsx)("time",{dateTime:n.toISOString(),itemProp:"dateModified",children:t})})},children:" on {date}"})}function z({lastUpdatedBy:e}){return(0,o.jsx)(h.A,{id:"theme.lastUpdated.byUser",description:"The words used to describe by who the page has been last updated",values:{user:(0,o.jsx)("b",{children:e})},children:" by {user}"})}function P({lastUpdatedAt:e,lastUpdatedBy:n}){return(0,o.jsxs)("span",{className:v.G.common.lastUpdated,children:[(0,o.jsx)(h.A,{id:"theme.lastUpdated.lastUpdatedAtBy",description:"The sentence used to display when a page has been last updated, and by who",values:{atDate:e?(0,o.jsx)(D,{lastUpdatedAt:e}):"",byUser:n?(0,o.jsx)(z,{lastUpdatedBy:n}):""},children:"Last updated{atDate}{byUser}"}),!1]})}const O="lastUpdated_jQ0h",W="noPrint_CXW_";function F({className:e,editUrl:n,lastUpdatedAt:t,lastUpdatedBy:s}){return(0,o.jsxs)("div",{className:(0,u.A)("row",e),children:[(0,o.jsx)("div",{className:(0,u.A)("col",W),children:n&&(0,o.jsx)(R,{editUrl:n})}),(0,o.jsx)("div",{className:(0,u.A)("col",O),children:(t||s)&&(0,o.jsx)(P,{lastUpdatedAt:t,lastUpdatedBy:s})})]})}function G(){const{metadata:e}=l(),{editUrl:n,lastUpdatedAt:t,lastUpdatedBy:s,tags:a}=e,r=a.length>0,i=!!(n||t||s);return r||i?(0,o.jsxs)("footer",{className:(0,u.A)(v.G.docs.docFooter,"docusaurus-mt-lg"),children:[r&&(0,o.jsx)("div",{className:(0,u.A)("row margin-top--sm",v.G.docs.docFooterTagsRow),children:(0,o.jsx)("div",{className:"col",children:(0,o.jsx)(S,{tags:a})})}),i&&(0,o.jsx)(F,{className:(0,u.A)("margin-top--sm",v.G.docs.docFooterEditMetaRow),editUrl:n,lastUpdatedAt:t,lastUpdatedBy:s})]}):null}var q=t(1464),Z=t(540);function X(e){const n=e.map(e=>({...e,parentIndex:-1,children:[]})),t=Array(7).fill(-1);n.forEach((e,n)=>{const s=t.slice(2,e.level);e.parentIndex=Math.max(...s),t[e.level]=n});const s=[];return n.forEach(e=>{const{parentIndex:t,...a}=e;t>=0?n[t].children.push(a):s.push(a)}),s}function J({toc:e,minHeadingLevel:n,maxHeadingLevel:t}){return e.flatMap(e=>{const s=J({toc:e.children,minHeadingLevel:n,maxHeadingLevel:t});return function(e){return e.level>=n&&e.level<=t}(e)?[{...e,children:s}]:s})}function K(e){const n=e.getBoundingClientRect();return n.top===n.bottom?K(e.parentNode):n}function Q(e,{anchorTopOffset:n}){const t=e.find(e=>K(e).top>=n);if(t){return function(e){return e.top>0&&e.bottom<window.innerHeight/2}(K(t))?t:e[e.indexOf(t)-1]??null}return e[e.length-1]??null}function Y(){const e=(0,s.useRef)(0),{navbar:{hideOnScroll:n}}=(0,Z.p)();return(0,s.useEffect)(()=>{e.current=n?0:document.querySelector(".navbar").clientHeight},[n]),e}function ee(e){const n=(0,s.useRef)(void 0),t=Y();(0,s.useEffect)(()=>{if(!e)return()=>{};const{linkClassName:s,linkActiveClassName:a,minHeadingLevel:r,maxHeadingLevel:o}=e;function i(){const e=function(e){return Array.from(document.getElementsByClassName(e))}(s),i=function({minHeadingLevel:e,maxHeadingLevel:n}){const t=[];for(let s=e;s<=n;s+=1)t.push(`h${s}.anchor`);return Array.from(document.querySelectorAll(t.join()))}({minHeadingLevel:r,maxHeadingLevel:o}),c=Q(i,{anchorTopOffset:t.current}),l=e.find(e=>c&&c.id===function(e){return decodeURIComponent(e.href.substring(e.href.indexOf("#")+1))}(e));e.forEach(e=>{!function(e,t){t?(n.current&&n.current!==e&&n.current.classList.remove(a),e.classList.add(a),n.current=e):e.classList.remove(a)}(e,e===l)})}return document.addEventListener("scroll",i),document.addEventListener("resize",i),i(),()=>{document.removeEventListener("scroll",i),document.removeEventListener("resize",i)}},[e,t])}function ne({toc:e,className:n,linkClassName:t,isChild:s}){return e.length?(0,o.jsx)("ul",{className:s?void 0:n,children:e.map(e=>(0,o.jsxs)("li",{children:[(0,o.jsx)(f.A,{to:`#${e.id}`,className:t??void 0,dangerouslySetInnerHTML:{__html:e.value}}),(0,o.jsx)(ne,{isChild:!0,toc:e.children,className:n,linkClassName:t})]},e.id))}):null}const te=s.memo(ne);function se({toc:e,className:n="table-of-contents table-of-contents__left-border",linkClassName:t="table-of-contents__link",linkActiveClassName:a,minHeadingLevel:r,maxHeadingLevel:i,...c}){const l=(0,Z.p)(),d=r??l.tableOfContents.minHeadingLevel,u=i??l.tableOfContents.maxHeadingLevel,m=function({toc:e,minHeadingLevel:n,maxHeadingLevel:t}){return(0,s.useMemo)(()=>J({toc:X(e),minHeadingLevel:n,maxHeadingLevel:t}),[e,n,t])}({toc:e,minHeadingLevel:d,maxHeadingLevel:u});return ee((0,s.useMemo)(()=>{if(t&&a)return{linkClassName:t,linkActiveClassName:a,minHeadingLevel:d,maxHeadingLevel:u}},[t,a,d,u])),(0,o.jsx)(te,{toc:m,className:n,linkClassName:t,...c})}const ae="tocCollapsibleButton_IsfN",re="tocCollapsibleButtonExpanded_X0Ww";function oe({collapsed:e,...n}){return(0,o.jsx)("button",{type:"button",...n,className:(0,u.A)("clean-btn",ae,!e&&re,n.className),children:(0,o.jsx)(h.A,{id:"theme.TOCCollapsible.toggleButtonLabel",description:"The label used by the button on the collapsible TOC component",children:"On this page"})})}const ie="tocCollapsible_iI5M",ce="tocCollapsibleContent_Recl",le="tocCollapsibleExpanded_nGGV";function de({toc:e,className:n,minHeadingLevel:t,maxHeadingLevel:s}){const{collapsed:a,toggleCollapsed:r}=(0,q.u)({initialState:!0});return(0,o.jsxs)("div",{className:(0,u.A)(ie,!a&&le,n),children:[(0,o.jsx)(oe,{collapsed:a,onClick:r}),(0,o.jsx)(q.N,{lazy:!0,className:ce,collapsed:a,children:(0,o.jsx)(se,{toc:e,minHeadingLevel:t,maxHeadingLevel:s})})]})}const ue="tocMobile_IiaZ";function me(){const{toc:e,frontMatter:n}=l();return(0,o.jsx)(de,{toc:e,minHeadingLevel:n.toc_min_heading_level,maxHeadingLevel:n.toc_max_heading_level,className:(0,u.A)(v.G.docs.docTocMobile,ue)})}const he="tableOfContents_HU9B";function fe({className:e,...n}){return(0,o.jsx)("div",{className:(0,u.A)(he,"thin-scrollbar",e),children:(0,o.jsx)(se,{...n,linkClassName:"table-of-contents__link toc-highlight",linkActiveClassName:"table-of-contents__link--active"})})}function pe(){const{toc:e,frontMatter:n}=l();return(0,o.jsx)(fe,{toc:e,minHeadingLevel:n.toc_min_heading_level,maxHeadingLevel:n.toc_max_heading_level,className:v.G.docs.docTocDesktop})}var ge=t(6445),xe=t(5589),be=t(5506),je=t(4949),ve=t(6499);function Ne(){const{prism:e}=(0,Z.p)(),{colorMode:n}=(0,ve.G)(),t=e.theme,s=e.darkTheme||t;return"dark"===n?s:t}var Ae=t(4809),ye=t.n(Ae);const we=/title=(?<quote>["'])(?<title>.*?)\1/,ke=/\{(?<range>[\d,-]+)\}/,Ce={js:{start:"\\/\\/",end:""},jsBlock:{start:"\\/\\*",end:"\\*\\/"},jsx:{start:"\\{\\s*\\/\\*",end:"\\*\\/\\s*\\}"},bash:{start:"#",end:""},html:{start:"\x3c!--",end:"--\x3e"}},Le={...Ce,lua:{start:"--",end:""},wasm:{start:"\\;\\;",end:""},tex:{start:"%",end:""},vb:{start:"['\u2018\u2019]",end:""},vbnet:{start:"(?:_\\s*)?['\u2018\u2019]",end:""},rem:{start:"[Rr][Ee][Mm]\\b",end:""},f90:{start:"!",end:""},ml:{start:"\\(\\*",end:"\\*\\)"},cobol:{start:"\\*>",end:""}},_e=Object.keys(Ce);function Te(e,n){const t=e.map(e=>{const{start:t,end:s}=Le[e];return`(?:${t}\\s*(${n.flatMap(e=>[e.line,e.block?.start,e.block?.end].filter(Boolean)).join("|")})\\s*${s})`}).join("|");return new RegExp(`^\\s*(?:${t})\\s*$`)}function Be({showLineNumbers:e,metastring:n}){return"boolean"==typeof e?e?1:void 0:"number"==typeof e?e:function(e){const n=e?.split(" ").find(e=>e.startsWith("showLineNumbers"));if(n){if(n.startsWith("showLineNumbers=")){const e=n.replace("showLineNumbers=","");return parseInt(e,10)}return 1}}(n)}function Ee(e,n){const{language:t,magicComments:s}=n;if(void 0===t)return{lineClassNames:{},code:e};const a=function(e,n){switch(e){case"js":case"javascript":case"ts":case"typescript":return Te(["js","jsBlock"],n);case"jsx":case"tsx":return Te(["js","jsBlock","jsx"],n);case"html":return Te(["js","jsBlock","html"],n);case"python":case"py":case"bash":return Te(["bash"],n);case"markdown":case"md":return Te(["html","jsx","bash"],n);case"tex":case"latex":case"matlab":return Te(["tex"],n);case"lua":case"haskell":return Te(["lua"],n);case"sql":return Te(["lua","jsBlock"],n);case"wasm":return Te(["wasm"],n);case"vb":case"vba":case"visual-basic":return Te(["vb","rem"],n);case"vbnet":return Te(["vbnet","rem"],n);case"batch":return Te(["rem"],n);case"basic":return Te(["rem","f90"],n);case"fsharp":return Te(["js","ml"],n);case"ocaml":case"sml":return Te(["ml"],n);case"fortran":return Te(["f90"],n);case"cobol":return Te(["cobol"],n);default:return Te(_e,n)}}(t,s),r=e.split(/\r?\n/),o=Object.fromEntries(s.map(e=>[e.className,{start:0,range:""}])),i=Object.fromEntries(s.filter(e=>e.line).map(({className:e,line:n})=>[n,e])),c=Object.fromEntries(s.filter(e=>e.block).map(({className:e,block:n})=>[n.start,e])),l=Object.fromEntries(s.filter(e=>e.block).map(({className:e,block:n})=>[n.end,e]));for(let u=0;u<r.length;){const e=r[u].match(a);if(!e){u+=1;continue}const n=e.slice(1).find(e=>void 0!==e);i[n]?o[i[n]].range+=`${u},`:c[n]?o[c[n]].start=u:l[n]&&(o[l[n]].range+=`${o[l[n]].start}-${u-1},`),r.splice(u,1)}const d={};return Object.entries(o).forEach(([e,{range:n}])=>{ye()(n).forEach(n=>{d[n]??=[],d[n].push(e)})}),{code:r.join("\n"),lineClassNames:d}}function He(e,n){const t=e.replace(/\r?\n$/,"");return function(e,{metastring:n,magicComments:t}){if(n&&ke.test(n)){const s=n.match(ke).groups.range;if(0===t.length)throw new Error(`A highlight range has been given in code block's metastring (\`\`\` ${n}), but no magic comment config is available. Docusaurus applies the first magic comment entry's className for metastring ranges.`);const a=t[0].className,r=ye()(s).filter(e=>e>0).map(e=>[e-1,[a]]);return{lineClassNames:Object.fromEntries(r),code:e}}return null}(t,{...n})??Ee(t,{...n})}function Me(e){const n=function(e){return n=e.language??function(e){if(!e)return;const n=e.split(" ").find(e=>e.startsWith("language-"));return n?.replace(/language-/,"")}(e.className)??e.defaultLanguage,n?.toLowerCase()??"text";var n}({language:e.language,defaultLanguage:e.defaultLanguage,className:e.className}),{lineClassNames:t,code:s}=He(e.code,{metastring:e.metastring,magicComments:e.magicComments,language:n}),a=function({className:e,language:n}){return(0,u.A)(e,n&&!e?.includes(`language-${n}`)&&`language-${n}`)}({className:e.className,language:n}),r=(o=e.metastring,(o?.match(we)?.groups.title??"")||e.title);var o;const i=Be({showLineNumbers:e.showLineNumbers,metastring:e.metastring});return{codeInput:e.code,code:s,className:a,language:n,title:r,lineNumbersStart:i,lineClassNames:t}}const Ie=(0,s.createContext)(null);function Se({metadata:e,wordWrap:n,children:t}){const a=(0,s.useMemo)(()=>({metadata:e,wordWrap:n}),[e,n]);return(0,o.jsx)(Ie.Provider,{value:a,children:t})}function Ue(){const e=(0,s.useContext)(Ie);if(null===e)throw new r.dV("CodeBlockContextProvider");return e}const Ve="codeBlockContainer_EUFB";function Re({as:e,...n}){const t=function(e){const n={color:"--prism-color",backgroundColor:"--prism-background-color"},t={};return Object.entries(e.plain).forEach(([e,s])=>{const a=n[e];a&&"string"==typeof s&&(t[a]=s)}),t}(Ne());return(0,o.jsx)(e,{...n,style:t,className:(0,u.A)(n.className,Ve,v.G.common.codeBlock)})}const $e="codeBlock_RL5w",De="codeBlockStandalone_ONTb",ze="codeBlockLines_V7PD",Pe="codeBlockLinesWithNumbering_eniH";function Oe({children:e,className:n}){return(0,o.jsx)(Re,{as:"pre",tabIndex:0,className:(0,u.A)(De,"thin-scrollbar",n),children:(0,o.jsx)("code",{className:ze,children:e})})}const We={attributes:!0,characterData:!0,childList:!0,subtree:!0};function Fe(e,n){const[t,a]=(0,s.useState)(),o=(0,s.useCallback)(()=>{a(e.current?.closest("[role=tabpanel][hidden]"))},[e,a]);(0,s.useEffect)(()=>{o()},[o]),function(e,n,t=We){const a=(0,r._q)(n),o=(0,r.Be)(t);(0,s.useEffect)(()=>{const n=new MutationObserver(a);return e&&n.observe(e,o),()=>n.disconnect()},[e,a,o])}(t,e=>{e.forEach(e=>{"attributes"===e.type&&"hidden"===e.attributeName&&(n(),o())})},{attributes:!0,characterData:!1,childList:!1,subtree:!1})}function Ge({children:e}){return e}var qe=t(3813);function Ze({line:e,token:n,...t}){return(0,o.jsx)("span",{...t})}const Xe="codeLine_EV4U",Je="codeLineNumber_iNrS",Ke="codeLineContent_DXk8";function Qe(){return(0,o.jsx)("br",{})}function Ye({line:e,classNames:n,showLineNumbers:t,getLineProps:s,getTokenProps:a}){const r=function(e){const n=1===e.length&&"\n"===e[0].content?e[0]:void 0;return n?[{...n,content:""}]:e}(e),i=s({line:r,className:(0,u.A)(n,t&&Xe)}),c=r.map((e,n)=>{const t=a({token:e});return(0,o.jsx)(Ze,{...t,line:r,token:e,children:t.children},n)});return(0,o.jsxs)("div",{...i,children:[t?(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)("span",{className:Je}),(0,o.jsx)("span",{className:Ke,children:c})]}):c,(0,o.jsx)(Qe,{})]})}const en=s.forwardRef((e,n)=>(0,o.jsx)("pre",{ref:n,tabIndex:0,...e,className:(0,u.A)(e.className,$e,"thin-scrollbar")}));function nn(e){const{metadata:n}=Ue();return(0,o.jsx)("code",{...e,className:(0,u.A)(e.className,ze,void 0!==n.lineNumbersStart&&Pe),style:{...e.style,counterReset:void 0===n.lineNumbersStart?void 0:"line-count "+(n.lineNumbersStart-1)}})}function tn({className:e}){const{metadata:n,wordWrap:t}=Ue(),s=Ne(),{code:a,language:r,lineNumbersStart:i,lineClassNames:c}=n;return(0,o.jsx)(qe.f4,{theme:s,code:a,language:r,children:({className:n,style:s,tokens:a,getLineProps:r,getTokenProps:l})=>(0,o.jsx)(en,{ref:t.codeBlockRef,className:(0,u.A)(e,n),style:s,children:(0,o.jsx)(nn,{children:a.map((e,n)=>(0,o.jsx)(Ye,{line:e,getLineProps:r,getTokenProps:l,classNames:c[n],showLineNumbers:void 0!==i},n))})})})}function sn({children:e,fallback:n}){return(0,je.A)()?(0,o.jsx)(o.Fragment,{children:e?.()}):n??null}function an({className:e,...n}){return(0,o.jsx)("button",{type:"button",...n,className:(0,u.A)("clean-btn",e)})}function rn(e){return(0,o.jsx)("svg",{viewBox:"0 0 24 24",...e,children:(0,o.jsx)("path",{fill:"currentColor",d:"M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"})})}function on(e){return(0,o.jsx)("svg",{viewBox:"0 0 24 24",...e,children:(0,o.jsx)("path",{fill:"currentColor",d:"M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"})})}const cn={copyButtonCopied:"copyButtonCopied_WguJ",copyButtonIcons:"copyButtonIcons_rJtr",copyButtonIcon:"copyButtonIcon_N2b8",copyButtonSuccessIcon:"copyButtonSuccessIcon_oDBk"};function ln(e){return e?(0,h.T)({id:"theme.CodeBlock.copied",message:"Copied",description:"The copied button label on code blocks"}):(0,h.T)({id:"theme.CodeBlock.copyButtonAriaLabel",message:"Copy code to clipboard",description:"The ARIA label for copy code blocks button"})}function dn(){const{metadata:{code:e}}=Ue(),[n,a]=(0,s.useState)(!1),r=(0,s.useRef)(void 0),o=(0,s.useCallback)(()=>{(async function(e){if(navigator.clipboard)return navigator.clipboard.writeText(e);const{default:n}=await t.e(821).then(t.bind(t,821));return n(e)})(e).then(()=>{a(!0),r.current=window.setTimeout(()=>{a(!1)},1e3)})},[e]);return(0,s.useEffect)(()=>()=>window.clearTimeout(r.current),[]),{copyCode:o,isCopied:n}}function un({className:e}){const{copyCode:n,isCopied:t}=dn();return(0,o.jsx)(an,{"aria-label":ln(t),title:(0,h.T)({id:"theme.CodeBlock.copy",message:"Copy",description:"The copy button label on code blocks"}),className:(0,u.A)(e,cn.copyButton,t&&cn.copyButtonCopied),onClick:n,children:(0,o.jsxs)("span",{className:cn.copyButtonIcons,"aria-hidden":"true",children:[(0,o.jsx)(rn,{className:cn.copyButtonIcon}),(0,o.jsx)(on,{className:cn.copyButtonSuccessIcon})]})})}function mn(e){return(0,o.jsx)("svg",{viewBox:"0 0 24 24",...e,children:(0,o.jsx)("path",{fill:"currentColor",d:"M4 19h6v-2H4v2zM20 5H4v2h16V5zm-3 6H4v2h13.25c1.1 0 2 .9 2 2s-.9 2-2 2H15v-2l-3 3l3 3v-2h2c2.21 0 4-1.79 4-4s-1.79-4-4-4z"})})}const hn="wordWrapButtonIcon_X0h8",fn="wordWrapButtonEnabled_uqan";function pn({className:e}){const{wordWrap:n}=Ue();if(!(n.isEnabled||n.isCodeScrollable))return!1;const t=(0,h.T)({id:"theme.CodeBlock.wordWrapToggle",message:"Toggle word wrap",description:"The title attribute for toggle word wrapping button of code block lines"});return(0,o.jsx)(an,{onClick:()=>n.toggle(),className:(0,u.A)(e,n.isEnabled&&fn),"aria-label":t,title:t,children:(0,o.jsx)(mn,{className:hn,"aria-hidden":"true"})})}const gn="buttonGroup_jasm";function xn({className:e}){return(0,o.jsx)(sn,{children:()=>(0,o.jsxs)("div",{className:(0,u.A)(e,gn),children:[(0,o.jsx)(pn,{}),(0,o.jsx)(un,{})]})})}const bn="codeBlockContent_UdBd",jn="codeBlockTitle_eNQs";function vn({className:e}){const{metadata:n}=Ue();return(0,o.jsxs)(Re,{as:"div",className:(0,u.A)(e,n.className),children:[n.title&&(0,o.jsx)("div",{className:jn,children:(0,o.jsx)(Ge,{children:n.title})}),(0,o.jsxs)("div",{className:bn,children:[(0,o.jsx)(tn,{}),(0,o.jsx)(xn,{})]})]})}function Nn(e){const n=function(e){const{prism:n}=(0,Z.p)();return Me({code:e.children,className:e.className,metastring:e.metastring,magicComments:n.magicComments,defaultLanguage:n.defaultLanguage,language:e.language,title:e.title,showLineNumbers:e.showLineNumbers})}(e),t=function(){const[e,n]=(0,s.useState)(!1),[t,a]=(0,s.useState)(!1),r=(0,s.useRef)(null),o=(0,s.useCallback)(()=>{const t=r.current.querySelector("code");e?t.removeAttribute("style"):(t.style.whiteSpace="pre-wrap",t.style.overflowWrap="anywhere"),n(e=>!e)},[r,e]),i=(0,s.useCallback)(()=>{const{scrollWidth:e,clientWidth:n}=r.current,t=e>n||r.current.querySelector("code").hasAttribute("style");a(t)},[r]);return Fe(r,i),(0,s.useEffect)(()=>{i()},[e,i]),(0,s.useEffect)(()=>(window.addEventListener("resize",i,{passive:!0}),()=>{window.removeEventListener("resize",i)}),[i]),{codeBlockRef:r,isEnabled:e,isCodeScrollable:t,toggle:o}}();return(0,o.jsx)(Se,{metadata:n,wordWrap:t,children:(0,o.jsx)(vn,{})})}function An({children:e,...n}){const t=(0,je.A)(),a=function(e){return s.Children.toArray(e).some(e=>(0,s.isValidElement)(e))?e:Array.isArray(e)?e.join(""):e}(e),r="string"==typeof a?Nn:Oe;return(0,o.jsx)(r,{...n,children:a},String(t))}function yn(e){return(0,o.jsx)("code",{...e})}var wn=t(7410);var kn=t(8243);const Cn="details_L_k2",Ln="isBrowser_K9R0",_n="collapsibleContent_Nx9F";function Tn(e){return!!e&&("SUMMARY"===e.tagName||Tn(e.parentElement))}function Bn(e,n){return!!e&&(e===n||Bn(e.parentElement,n))}function En({summary:e,children:n,...t}){(0,kn.A)().collectAnchor(t.id);const a=(0,je.A)(),r=(0,s.useRef)(null),{collapsed:i,setCollapsed:c}=(0,q.u)({initialState:!t.open}),[l,d]=(0,s.useState)(t.open),m=s.isValidElement(e)?e:(0,o.jsx)("summary",{children:e??"Details"});return(0,o.jsxs)("details",{...t,ref:r,open:l,"data-collapsed":i,className:(0,u.A)(Cn,a&&Ln,t.className),onMouseDown:e=>{Tn(e.target)&&e.detail>1&&e.preventDefault()},onClick:e=>{e.stopPropagation();const n=e.target;Tn(n)&&Bn(n,r.current)&&(e.preventDefault(),i?(c(!1),d(!0)):c(!0))},children:[m,(0,o.jsx)(q.N,{lazy:!1,collapsed:i,onCollapseTransitionEnd:e=>{c(e),d(!e)},children:(0,o.jsx)("div",{className:_n,children:n})})]})}const Hn="details_fErx";function Mn({...e}){return(0,o.jsx)(En,{...e,className:(0,u.A)("alert alert--info",Hn,e.className)})}function In(e){const n=s.Children.toArray(e.children),t=n.find(e=>s.isValidElement(e)&&"summary"===e.type),a=(0,o.jsx)(o.Fragment,{children:n.filter(e=>e!==t)});return(0,o.jsx)(Mn,{...e,summary:t,children:a})}function Sn(e){return(0,o.jsx)(ge.A,{...e})}const Un="containsTaskList_Zupw";function Vn(e){if(void 0!==e)return(0,u.A)(e,e?.includes("contains-task-list")&&Un)}const Rn="img_R4M0";function $n(e){const{mdxAdmonitionTitle:n,rest:t}=function(e){const n=s.Children.toArray(e),t=n.find(e=>s.isValidElement(e)&&"mdxAdmonitionTitle"===e.type),a=n.filter(e=>e!==t),r=t?.props.children;return{mdxAdmonitionTitle:r,rest:a.length>0?(0,o.jsx)(o.Fragment,{children:a}):null}}(e.children),a=e.title??n;return{...e,...a&&{title:a},children:t}}const Dn="admonition_fsSc",zn="admonitionHeading_aDnC",Pn="admonitionIcon_drq_",On="admonitionContent_aNFp";function Wn({type:e,className:n,children:t,id:s}){return(0,o.jsx)("div",{className:(0,u.A)(v.G.common.admonition,v.G.common.admonitionType(e),Dn,n),id:s,children:t})}function Fn({icon:e,title:n}){return(0,o.jsxs)("div",{className:zn,children:[(0,o.jsx)("span",{className:Pn,children:e}),n]})}function Gn({children:e}){return e?(0,o.jsx)("div",{className:On,children:e}):null}function qn(e){const{type:n,icon:t,title:s,children:a,className:r,id:i}=e;return(0,o.jsxs)(Wn,{type:n,className:r,id:i,children:[s||t?(0,o.jsx)(Fn,{title:s,icon:t}):null,(0,o.jsx)(Gn,{children:a})]})}function Zn(e){return(0,o.jsx)("svg",{viewBox:"0 0 14 16",...e,children:(0,o.jsx)("path",{fillRule:"evenodd",d:"M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"})})}const Xn={icon:(0,o.jsx)(Zn,{}),title:(0,o.jsx)(h.A,{id:"theme.admonition.note",description:"The default label used for the Note admonition (:::note)",children:"note"})};function Jn(e){return(0,o.jsx)(qn,{...Xn,...e,className:(0,u.A)("alert alert--secondary",e.className),children:e.children})}function Kn(e){return(0,o.jsx)("svg",{viewBox:"0 0 12 16",...e,children:(0,o.jsx)("path",{fillRule:"evenodd",d:"M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"})})}const Qn={icon:(0,o.jsx)(Kn,{}),title:(0,o.jsx)(h.A,{id:"theme.admonition.tip",description:"The default label used for the Tip admonition (:::tip)",children:"tip"})};function Yn(e){return(0,o.jsx)(qn,{...Qn,...e,className:(0,u.A)("alert alert--success",e.className),children:e.children})}function et(e){return(0,o.jsx)("svg",{viewBox:"0 0 14 16",...e,children:(0,o.jsx)("path",{fillRule:"evenodd",d:"M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"})})}const nt={icon:(0,o.jsx)(et,{}),title:(0,o.jsx)(h.A,{id:"theme.admonition.info",description:"The default label used for the Info admonition (:::info)",children:"info"})};function tt(e){return(0,o.jsx)(qn,{...nt,...e,className:(0,u.A)("alert alert--info",e.className),children:e.children})}function st(e){return(0,o.jsx)("svg",{viewBox:"0 0 16 16",...e,children:(0,o.jsx)("path",{fillRule:"evenodd",d:"M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"})})}const at={icon:(0,o.jsx)(st,{}),title:(0,o.jsx)(h.A,{id:"theme.admonition.warning",description:"The default label used for the Warning admonition (:::warning)",children:"warning"})};function rt(e){return(0,o.jsx)("svg",{viewBox:"0 0 12 16",...e,children:(0,o.jsx)("path",{fillRule:"evenodd",d:"M5.05.31c.81 2.17.41 3.38-.52 4.31C3.55 5.67 1.98 6.45.9 7.98c-1.45 2.05-1.7 6.53 3.53 7.7-2.2-1.16-2.67-4.52-.3-6.61-.61 2.03.53 3.33 1.94 2.86 1.39-.47 2.3.53 2.27 1.67-.02.78-.31 1.44-1.13 1.81 3.42-.59 4.78-3.42 4.78-5.56 0-2.84-2.53-3.22-1.25-5.61-1.52.13-2.03 1.13-1.89 2.75.09 1.08-1.02 1.8-1.86 1.33-.67-.41-.66-1.19-.06-1.78C8.18 5.31 8.68 2.45 5.05.32L5.03.3l.02.01z"})})}const ot={icon:(0,o.jsx)(rt,{}),title:(0,o.jsx)(h.A,{id:"theme.admonition.danger",description:"The default label used for the Danger admonition (:::danger)",children:"danger"})};const it={icon:(0,o.jsx)(st,{}),title:(0,o.jsx)(h.A,{id:"theme.admonition.caution",description:"The default label used for the Caution admonition (:::caution)",children:"caution"})};const ct={...{note:Jn,tip:Yn,info:tt,warning:function(e){return(0,o.jsx)(qn,{...at,...e,className:(0,u.A)("alert alert--warning",e.className),children:e.children})},danger:function(e){return(0,o.jsx)(qn,{...ot,...e,className:(0,u.A)("alert alert--danger",e.className),children:e.children})}},...{secondary:e=>(0,o.jsx)(Jn,{title:"secondary",...e}),important:e=>(0,o.jsx)(tt,{title:"important",...e}),success:e=>(0,o.jsx)(Yn,{title:"success",...e}),caution:function(e){return(0,o.jsx)(qn,{...it,...e,className:(0,u.A)("alert alert--warning",e.className),children:e.children})}}};function lt(e){const n=$n(e),t=(s=n.type,ct[s]||(console.warn(`No admonition component found for admonition type "${s}". Using Info as fallback.`),ct.info));var s;return(0,o.jsx)(t,{...n})}var dt=t(8642);const ut="errorBoundaryFallback_IAUr";function mt(e){return(0,o.jsx)("button",{type:"button",...e,children:(0,o.jsx)(h.A,{id:"theme.ErrorPageContent.tryAgain",description:"The label of the button to try again rendering when the React error boundary captures an error",children:"Try again"})})}function ht({error:e,tryAgain:n}){return(0,o.jsxs)("div",{className:ut,children:[(0,o.jsx)("p",{children:e.message}),(0,o.jsx)(mt,{onClick:n})]})}s.Component;t(6471);class ft extends Error{constructor(e,n){super(),this.name="ReactContextError",this.message=`Hook ${this.stack?.split("\n")[1]?.match(/at (?:\w+\.)?(?<name>\w+)/)?.groups.name??""} is called outside the <${e}>. ${n??""}`}}var pt=t(4180);const gt=pt.N;function xt({key:e,oldValue:n,newValue:t,storage:s}){if(n===t)return;const a=document.createEvent("StorageEvent");a.initStorageEvent("storage",!1,!1,e,n,t,window.location.href,s),window.dispatchEvent(a)}function bt(e=gt){if("undefined"==typeof window)throw new Error("Browser storage is not available on Node.js/Docusaurus SSR process.");if("none"===e)return null;try{return window[e]}catch(t){return n=t,jt||(console.warn("Docusaurus browser storage is not available.\nPossible reasons: running Docusaurus in an iframe, in an incognito browser session, or using too strict browser privacy settings.",n),jt=!0),null}var n}let jt=!1;const vt={get:()=>null,set:()=>{},del:()=>{},listen:()=>()=>{}};function Nt(e,n){const t=`${e}${pt.M}`;if("undefined"==typeof window)return function(e){function n(){throw new Error(`Illegal storage API usage for storage key "${e}".\nDocusaurus storage APIs are not supposed to be called on the server-rendering process.\nPlease only call storage APIs in effects and event handlers.`)}return{get:n,set:n,del:n,listen:n}}(t);const s=bt(n?.persistence);return null===s?vt:{get:()=>{try{return s.getItem(t)}catch(e){return console.error(`Docusaurus storage error, can't get key=${t}`,e),null}},set:e=>{try{const n=s.getItem(t);s.setItem(t,e),xt({key:t,oldValue:n,newValue:e,storage:s})}catch(n){console.error(`Docusaurus storage error, can't set ${t}=${e}`,n)}},del:()=>{try{const e=s.getItem(t);s.removeItem(t),xt({key:t,oldValue:e,newValue:null,storage:s})}catch(e){console.error(`Docusaurus storage error, can't delete key=${t}`,e)}},listen:e=>{try{const n=n=>{n.storageArea===s&&n.key===t&&e(n)};return window.addEventListener("storage",n),()=>window.removeEventListener("storage",n)}catch(n){return console.error(`Docusaurus storage error, can't listen for changes of key=${t}`,n),()=>{}}}}}const At=s.createContext(void 0);Nt("theme");let yt=null;async function wt(){return yt||(yt=async function(){return(await t.e(3992).then(t.bind(t,3992))).default}()),yt}function kt(){return(0,b.A)().siteConfig.themeConfig.mermaid}function Ct(){const{colorMode:e}=function(){const e=(0,s.useContext)(At);if(null==e)throw new ft("ColorModeProvider","Please see https://docusaurus.io/docs/api/themes/configuration#use-color-mode.");return e}(),n=kt(),t=n.theme[e],{options:a}=n;return(0,s.useMemo)(()=>({startOnLoad:!1,...a,theme:t}),[t,a])}function Lt({text:e,config:n}){const[t,a]=(0,s.useState)(null),r=(0,s.useState)(`mermaid-svg-${Math.round(1e7*Math.random())}`)[0],o=Ct(),i=n??o;return(0,s.useEffect)(()=>{(async function({id:e,text:n,config:t}){const s=await wt();s.initialize(t);try{return await s.render(e,n)}catch(a){throw document.querySelector(`#d${e}`)?.remove(),a}})({id:r,text:e,config:i}).then(a).catch(e=>{a(()=>{throw e})})},[r,e,i]),t}const _t="container_y9cx";function Tt({renderResult:e}){const n=(0,s.useRef)(null);return(0,s.useEffect)(()=>{const t=n.current;e.bindFunctions?.(t)},[e]),(0,o.jsx)("div",{ref:n,className:`docusaurus-mermaid-container ${_t}`,dangerouslySetInnerHTML:{__html:e.svg}})}function Bt({value:e}){const n=Lt({text:e});return null===n?null:(0,o.jsx)(Tt,{renderResult:n})}const Et={Head:be.A,details:In,Details:In,code:function(e){return function(e){return void 0!==e.children&&s.Children.toArray(e.children).every(e=>"string"==typeof e&&!e.includes("\n"))}(e)?(0,o.jsx)(yn,{...e}):(0,o.jsx)(An,{...e})},a:function(e){const n=(0,wn.v)(e.id);return(0,o.jsx)(f.A,{...e,className:(0,u.A)(n,e.className)})},pre:function(e){return(0,o.jsx)(o.Fragment,{children:e.children})},ul:function(e){return(0,o.jsx)("ul",{...e,className:Vn(e.className)})},li:function(e){(0,kn.A)().collectAnchor(e.id);const n=(0,wn.v)(e.id);return(0,o.jsx)("li",{className:(0,u.A)(n,e.className),...e})},img:function(e){return(0,o.jsx)("img",{decoding:"async",loading:"lazy",...e,className:(n=e.className,(0,u.A)(n,Rn))});var n},h1:e=>(0,o.jsx)(Sn,{as:"h1",...e}),h2:e=>(0,o.jsx)(Sn,{as:"h2",...e}),h3:e=>(0,o.jsx)(Sn,{as:"h3",...e}),h4:e=>(0,o.jsx)(Sn,{as:"h4",...e}),h5:e=>(0,o.jsx)(Sn,{as:"h5",...e}),h6:e=>(0,o.jsx)(Sn,{as:"h6",...e}),admonition:lt,mermaid:function(e){return(0,o.jsx)(dt.A,{fallback:e=>(0,o.jsx)(ht,{...e}),children:(0,o.jsx)(Bt,{...e})})}};function Ht({children:e}){return(0,o.jsx)(xe.x,{components:Et,children:e})}function Mt({children:e}){const n=function(){const{metadata:e,frontMatter:n,contentTitle:t}=l();return n.hide_title||void 0!==t?null:e.title}();return(0,o.jsxs)("div",{className:(0,u.A)(v.G.docs.docMarkdown,"markdown"),children:[n&&(0,o.jsx)("header",{children:(0,o.jsx)(ge.A,{as:"h1",children:n})}),(0,o.jsx)(Ht,{children:e})]})}var It=t(818),St=t(3603),Ut=t(9343);function Vt(e){return(0,o.jsx)("svg",{viewBox:"0 0 24 24",...e,children:(0,o.jsx)("path",{d:"M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z",fill:"currentColor"})})}const Rt="breadcrumbHomeIcon_keIu";function $t(){const e=(0,Ut.Ay)("/");return(0,o.jsx)("li",{className:"breadcrumbs__item",children:(0,o.jsx)(f.A,{"aria-label":(0,h.T)({id:"theme.docs.breadcrumbs.home",message:"Home page",description:"The ARIA label for the home page in the breadcrumbs"}),className:"breadcrumbs__link",href:e,children:(0,o.jsx)(Vt,{className:Rt})})})}function Dt(e){const n=function({breadcrumbs:e}){const{siteConfig:n}=(0,b.A)();return{"@context":"https://schema.org","@type":"BreadcrumbList",itemListElement:e.filter(e=>e.href).map((e,t)=>({"@type":"ListItem",position:t+1,name:e.label,item:`${n.url}${e.href}`}))}}({breadcrumbs:e.breadcrumbs});return(0,o.jsx)(be.A,{children:(0,o.jsx)("script",{type:"application/ld+json",children:JSON.stringify(n)})})}const zt="breadcrumbsContainer_Z125";function Pt({children:e,href:n,isLast:t}){const s="breadcrumbs__link";return t?(0,o.jsx)("span",{className:s,children:e}):n?(0,o.jsx)(f.A,{className:s,href:n,children:(0,o.jsx)("span",{children:e})}):(0,o.jsx)("span",{className:s,children:e})}function Ot({children:e,active:n}){return(0,o.jsx)("li",{className:(0,u.A)("breadcrumbs__item",{"breadcrumbs__item--active":n}),children:e})}function Wt(){const e=(0,It.OF)(),n=(0,St.Dt)();return e?(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(Dt,{breadcrumbs:e}),(0,o.jsx)("nav",{className:(0,u.A)(v.G.docs.docBreadcrumbs,zt),"aria-label":(0,h.T)({id:"theme.docs.breadcrumbs.navAriaLabel",message:"Breadcrumbs",description:"The ARIA label for the breadcrumbs"}),children:(0,o.jsxs)("ul",{className:"breadcrumbs",children:[n&&(0,o.jsx)($t,{}),e.map((n,t)=>{const s=t===e.length-1,a="category"===n.type&&n.linkUnlisted?void 0:n.href;return(0,o.jsx)(Ot,{active:s,children:(0,o.jsx)(Pt,{href:a,isLast:s,children:n.label})},t)})]})})]}):null}function Ft(){return(0,o.jsx)(h.A,{id:"theme.contentVisibility.unlistedBanner.title",description:"The unlisted content banner title",children:"Unlisted page"})}function Gt(){return(0,o.jsx)(h.A,{id:"theme.contentVisibility.unlistedBanner.message",description:"The unlisted content banner message",children:"This page is unlisted. Search engines will not index it, and only users having a direct link can access it."})}function qt(){return(0,o.jsx)(be.A,{children:(0,o.jsx)("meta",{name:"robots",content:"noindex, nofollow"})})}function Zt(){return(0,o.jsx)(h.A,{id:"theme.contentVisibility.draftBanner.title",description:"The draft content banner title",children:"Draft page"})}function Xt(){return(0,o.jsx)(h.A,{id:"theme.contentVisibility.draftBanner.message",description:"The draft content banner message",children:"This page is a draft. It will only be visible in dev and be excluded from the production build."})}function Jt({className:e}){return(0,o.jsx)(lt,{type:"caution",title:(0,o.jsx)(Zt,{}),className:(0,u.A)(e,v.G.common.draftBanner),children:(0,o.jsx)(Xt,{})})}function Kt({className:e}){return(0,o.jsx)(lt,{type:"caution",title:(0,o.jsx)(Ft,{}),className:(0,u.A)(e,v.G.common.unlistedBanner),children:(0,o.jsx)(Gt,{})})}function Qt(e){return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(qt,{}),(0,o.jsx)(Kt,{...e})]})}function Yt({metadata:e}){const{unlisted:n,frontMatter:t}=e;return(0,o.jsxs)(o.Fragment,{children:[(n||t.unlisted)&&(0,o.jsx)(Qt,{}),t.draft&&(0,o.jsx)(Jt,{})]})}const es="docItemContainer_Lld7",ns="docItemCol_nUXI";function ts({children:e}){const n=function(){const{frontMatter:e,toc:n}=l(),t=(0,m.l)(),s=e.hide_table_of_contents,a=!s&&n.length>0;return{hidden:s,mobile:a?(0,o.jsx)(me,{}):void 0,desktop:!a||"desktop"!==t&&"ssr"!==t?void 0:(0,o.jsx)(pe,{})}}(),{metadata:t}=l();return(0,o.jsxs)("div",{className:"row",children:[(0,o.jsxs)("div",{className:(0,u.A)("col",!n.hidden&&ns),children:[(0,o.jsx)(Yt,{metadata:t}),(0,o.jsx)(L,{}),(0,o.jsxs)("div",{className:es,children:[(0,o.jsxs)("article",{children:[(0,o.jsx)(Wt,{}),(0,o.jsx)(_,{}),n.mobile,(0,o.jsx)(Mt,{children:e}),(0,o.jsx)(G,{})]}),(0,o.jsx)(x,{})]})]}),n.desktop&&(0,o.jsx)("div",{className:"col col--3",children:n.desktop})]})}function ss(e){const n=`docs-doc-id-${e.content.metadata.id}`,t=e.content;return(0,o.jsx)(c,{content:e.content,children:(0,o.jsxs)(a.e3,{className:n,children:[(0,o.jsx)(d,{}),(0,o.jsx)(ts,{children:(0,o.jsx)(t,{})})]})})}},4809(e,n){function t(e){let n,t=[];for(let s of e.split(",").map(e=>e.trim()))if(/^-?\d+$/.test(s))t.push(parseInt(s,10));else if(n=s.match(/^(-?\d+)(-|\.\.\.?|\u2025|\u2026|\u22EF)(-?\d+)$/)){let[e,s,a,r]=n;if(s&&r){s=parseInt(s),r=parseInt(r);const e=s<r?1:-1;"-"!==a&&".."!==a&&"\u2025"!==a||(r+=e);for(let n=s;n!==r;n+=e)t.push(n)}}return t}n.default=t,e.exports=t},5589(e,n,t){"use strict";t.d(n,{R:()=>o,x:()=>i});var s=t(758);const a={},r=s.createContext(a);function o(e){const n=s.useContext(r);return s.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(a):e.components||a:o(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/1a5ba401.bdd09a56.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[7098],{1602(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(5589);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)}},5589(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.5c4d3ed7.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[124],{7198(e,r,n){n.r(r),n.d(r,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>l,metadata:()=>t,toc:()=>d});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(5589);const l={},c="decorators",a={},d=[{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}];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};\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"})})]})}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)}},5589(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.18a50af2.js

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

package/build/docs/assets/js/1dfec420.e8ed9238.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[200],{5206(e,o,n){n.r(o),n.d(o,{assets:()=>a,contentTitle:()=>i,default:()=>d,frontMatter:()=>r,metadata:()=>t,toc:()=>c});const t=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=n(6070),s=n(5589);const r={},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,s.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,s.R)(),...e.components};return o?(0,p.jsx)(o,{...e,children:(0,p.jsx)(l,{...e})}):l(e)}},5589(e,o,n){n.d(o,{R:()=>r,x:()=>i});var t=n(758);const p={},s=t.createContext(p);function r(e){const o=t.useContext(s);return t.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:r(e.components),t.createElement(s.Provider,{value:o},e.children)}}}]);

package/build/docs/assets/js/1fcf59a8.501bb96b.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[9592],{2479(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(5589);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)}},5589(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/2026.f4b8efbd.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[2026],{5876(e,t,i){i.d(t,{A:()=>l});i(758);var n=i(3526),a=i(8114),o=i(6445),s=i(6070);function l({className:e}){return(0,s.jsx)("main",{className:(0,n.A)("container margin-vert--xl",e),children:(0,s.jsx)("div",{className:"row",children:(0,s.jsxs)("div",{className:"col col--6 col--offset-3",children:[(0,s.jsx)(o.A,{as:"h1",className:"hero__title",children:(0,s.jsx)(a.A,{id:"theme.NotFound.title",description:"The title of the 404 page",children:"Page Not Found"})}),(0,s.jsx)("p",{children:(0,s.jsx)(a.A,{id:"theme.NotFound.p1",description:"The first paragraph of the 404 page",children:"We could not find what you were looking for."})}),(0,s.jsx)("p",{children:(0,s.jsx)(a.A,{id:"theme.NotFound.p2",description:"The 2nd paragraph of the 404 page",children:"Please contact the owner of the site that linked you to the original URL and let them know their link is broken."})})]})})})}},2026(e,t,i){i.r(t),i.d(t,{default:()=>r});i(758);var n=i(8114),a=i(6194),o=i(5024),s=i(5876),l=i(6070);function r(){const e=(0,n.T)({id:"theme.NotFound.title",message:"Page Not Found"});return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(a.be,{title:e}),(0,l.jsx)(o.A,{children:(0,l.jsx)(s.A,{})})]})}}}]);