@elliemae/pui-logrocket 1.2.5-beta.1 → 1.2.5

package/build/docs/assets/js/7fcbe1af.5999b9e8.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_logrocket=globalThis.webpackChunk_elliemae_pui_logrocket||[]).push([[4804],{7309(e,n,i){i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>l});const t=JSON.parse('{"id":"api/functions/initLogRocket","title":"initLogRocket()","description":"Initialize LogRocket with optional OneTrust integration","source":"@site/docs/api/functions/initLogRocket.md","sourceDirName":"api/functions","slug":"/api/functions/initLogRocket","permalink":"/logrocket/api/functions/initLogRocket","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-logrocket.git/docs/api/functions/initLogRocket.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"hasUserConsentedToSessionRecording()","permalink":"/logrocket/api/functions/hasUserConsentedToSessionRecording"},"next":{"title":"LROptions","permalink":"/logrocket/api/type-aliases/LROptions"}}');var s=i(6070),o=i(116);const r={},a="initLogRocket()",c={},l=[{value:"Parameters",id:"parameters",level:2},{value:"options?",id:"options",level:3},{value:"Returns",id:"returns",level:2},{value:"Examples",id:"examples",level:2}];function d(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",p:"p",pre:"pre",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"initlogrocket",children:"initLogRocket()"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"function initLogRocket(options?: IOptions & {\n  appId?: string;\n  isReact?: boolean;\n}): void;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Initialize LogRocket with optional OneTrust integration"}),"\n",(0,s.jsxs)(n.p,{children:["This function handles LogRocket initialization with support for OneTrust consent management.\nThe initialization behavior depends on the ",(0,s.jsx)(n.code,{children:"window.hasOneTrust"})," flag and consent banner state:"]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["If ",(0,s.jsx)(n.code,{children:"window.hasOneTrust"})," is true and the consent banner hasn't been seen, waits for 'OTConsentApplied' event (until user interacts with banner)"]}),"\n",(0,s.jsxs)(n.li,{children:["If ",(0,s.jsx)(n.code,{children:"window.hasOneTrust"})," is true and the banner was already seen, initializes immediately"]}),"\n",(0,s.jsxs)(n.li,{children:["If ",(0,s.jsx)(n.code,{children:"window.hasOneTrust"})," is false or undefined, LogRocket initializes immediately"]}),"\n",(0,s.jsxs)(n.li,{children:["Prevents duplicate initialization by checking ",(0,s.jsx)(n.code,{children:"window.emui.isLogRocketInitialized"})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsx)(n.h3,{id:"options",children:"options?"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"IOptions"})," & {\n",(0,s.jsx)(n.code,{children:"appId?"}),": ",(0,s.jsx)(n.code,{children:"string"}),";\n",(0,s.jsx)(n.code,{children:"isReact?"}),": ",(0,s.jsx)(n.code,{children:"boolean"}),";\n}"]}),"\n",(0,s.jsx)(n.p,{children:"LogRocket initialization options"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h2,{id:"examples",children:"Examples"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"// With OneTrust (when window.hasOneTrust is true)\ninitLogRocket({\n  appId: 'your-project/your-app',\n  isReact: true,\n  rootHostname: '.ice.com',\n  childDomains: ['https://your-child-domain.com'],\n  parentDomain: 'https://your-parent-domain.com',\n});\n"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"// Without OneTrust (when window.hasOneTrust is false/undefined)\ninitLogRocket({\n  appId: 'your-project/your-app',\n});\n"})})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}}}]);

package/build/docs/assets/js/a7bd4aaa.ad524078.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_logrocket=globalThis.webpackChunk_elliemae_pui_logrocket||[]).push([[7098],{998(e,n,s){s.r(n),s.d(n,{default:()=>d});s(758);var r=s(3135);function o(e,n){return`docs-${e}-${n}`}var i=s(1102),t=s(1977),l=s(2770),c=s(6070);function a(e){const{version:n}=e;return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(l.A,{version:n.version,tag:o(n.pluginId,n.version)}),(0,c.jsx)(r.be,{children:n.noIndex&&(0,c.jsx)("meta",{name:"robots",content:"noindex, nofollow"})})]})}function u(e){const{version:n,route:s}=e;return(0,c.jsx)(r.e3,{className:n.className,children:(0,c.jsx)(i.n,{version:n,children:(0,t.v)(s.routes)})})}function d(e){return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(a,{...e}),(0,c.jsx)(u,{...e})]})}}}]);

package/build/docs/assets/js/a94703ab.5c63b074.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_logrocket=globalThis.webpackChunk_elliemae_pui_logrocket||[]).push([[9048],{7696(e,t,n){n.r(t),n.d(t,{default:()=>Se});var a=n(758),i=n(3526),s=n(3135),o=n(5660),l=n(9463),r=n(4718),c=n(3524),d=n(235),u=n(437);const m="backToTopButton_cO8Y",b="backToTopButtonShow_Pbbc";var h=n(6070);function p(){const{shown:e,scrollToTop:t}=function({threshold:e}){const[t,n]=(0,a.useState)(!1),i=(0,a.useRef)(!1),{startScroll:s,cancelScroll:o}=(0,d.gk)();return(0,d.Mq)(({scrollY:t},a)=>{const s=a?.scrollY;s&&(i.current?i.current=!1:t>=s?(o(),n(!1)):t<e?n(!1):t+window.innerHeight<document.documentElement.scrollHeight&&n(!0))}),(0,u.$)(e=>{e.location.hash&&(i.current=!0,n(!1))}),{shown:t,scrollToTop:()=>s(0)}}({threshold:300});return(0,h.jsx)("button",{"aria-label":(0,c.T)({id:"theme.BackToTopButton.buttonAriaLabel",message:"Scroll back to top",description:"The ARIA label for the back to top button"}),className:(0,i.A)("clean-btn",o.G.common.backToTopButton,m,e&&b),type:"button",onClick:t})}var x=n(5996),f=n(5557),j=n(7546),_=n(1643),g=n(5180);function v(e){return(0,h.jsx)("svg",{width:"20",height:"20","aria-hidden":"true",...e,children:(0,h.jsxs)("g",{fill:"#7a7a7a",children:[(0,h.jsx)("path",{d:"M9.992 10.023c0 .2-.062.399-.172.547l-4.996 7.492a.982.982 0 01-.828.454H1c-.55 0-1-.453-1-1 0-.2.059-.403.168-.551l4.629-6.942L.168 3.078A.939.939 0 010 2.528c0-.548.45-.997 1-.997h2.996c.352 0 .649.18.828.45L9.82 9.472c.11.148.172.347.172.55zm0 0"}),(0,h.jsx)("path",{d:"M19.98 10.023c0 .2-.058.399-.168.547l-4.996 7.492a.987.987 0 01-.828.454h-3c-.547 0-.996-.453-.996-1 0-.2.059-.403.168-.551l4.625-6.942-4.625-6.945a.939.939 0 01-.168-.55 1 1 0 01.996-.997h3c.348 0 .649.18.828.45l4.996 7.492c.11.148.168.347.168.55zm0 0"})]})})}const C="collapseSidebarButton_iy1w",A="collapseSidebarButtonIcon_Y9o8";function k({onClick:e}){return(0,h.jsx)("button",{type:"button",title:(0,c.T)({id:"theme.docs.sidebar.collapseButtonTitle",message:"Collapse sidebar",description:"The title attribute for collapse button of doc sidebar"}),"aria-label":(0,c.T)({id:"theme.docs.sidebar.collapseButtonAriaLabel",message:"Collapse sidebar",description:"The title attribute for collapse button of doc sidebar"}),className:(0,i.A)("button button--secondary button--outline",C),onClick:e,children:(0,h.jsx)(v,{className:A})})}var S=n(644),N=n(5969);const T=Symbol("EmptyContext"),y=a.createContext(T);function I({children:e}){const[t,n]=(0,a.useState)(null),i=(0,a.useMemo)(()=>({expandedItem:t,setExpandedItem:n}),[t]);return(0,h.jsx)(y.Provider,{value:i,children:e})}var L=n(1583),w=n(950),B=n(9307),M=n(8010),E=n(2217),H=n(3492);const P="menuExternalLink_YSWF",G="linkLabel_Knm1";function W({label:e}){return(0,h.jsx)("span",{title:e,className:G,children:e})}function D({item:e,onItemClick:t,activePath:n,level:a,index:s,...r}){const{href:c,label:d,className:u,autoAddBaseUrl:m}=e,b=(0,l.w8)(e,n),p=(0,E.A)(c);return(0,h.jsx)("li",{className:(0,i.A)(o.G.docs.docSidebarItemLink,o.G.docs.docSidebarItemLinkLevel(a),"menu__list-item",u),children:(0,h.jsxs)(B.A,{className:(0,i.A)("menu__link",!p&&P,{"menu__link--active":b}),autoAddBaseUrl:m,"aria-current":b?"page":void 0,to:c,...p&&{onClick:t?()=>t(e):void 0},...r,children:[(0,h.jsx)(W,{label:d}),!p&&(0,h.jsx)(H.A,{})]})},d)}const F="categoryLink_BCi1",R="categoryLinkLabel_I_MP";function Y({collapsed:e,categoryLabel:t,onClick:n}){return(0,h.jsx)("button",{"aria-label":e?(0,c.T)({id:"theme.DocSidebarItem.expandCategoryAriaLabel",message:"Expand sidebar category '{label}'",description:"The ARIA label to expand the sidebar category"},{label:t}):(0,c.T)({id:"theme.DocSidebarItem.collapseCategoryAriaLabel",message:"Collapse sidebar category '{label}'",description:"The ARIA label to collapse the sidebar category"},{label:t}),"aria-expanded":!e,type:"button",className:"clean-btn menu__caret",onClick:n})}function O({label:e}){return(0,h.jsx)("span",{title:e,className:R,children:e})}function U(e){return 0===(0,l.Y)(e.item.items,e.activePath).length?(0,h.jsx)(V,{...e}):(0,h.jsx)(Q,{...e})}function V({item:e,...t}){if("string"!=typeof e.href)return null;const{type:n,collapsed:a,collapsible:i,items:s,linkUnlisted:o,...l}=e,r={type:"link",...l};return(0,h.jsx)(D,{item:r,...t})}function Q({item:e,onItemClick:t,activePath:n,level:s,index:r,...c}){const{items:d,label:u,collapsible:m,className:b,href:p}=e,{docs:{sidebar:{autoCollapseCategories:x}}}=(0,_.p)(),f=function(e){const t=(0,M.A)();return(0,a.useMemo)(()=>e.href&&!e.linkUnlisted?e.href:!t&&e.collapsible?(0,l.Nr)(e):void 0,[e,t])}(e),j=(0,l.w8)(e,n),g=(0,w.ys)(p,n),{collapsed:v,setCollapsed:C}=(0,L.u)({initialState:()=>!!m&&(!j&&e.collapsed)}),{expandedItem:A,setExpandedItem:k}=function(){const e=(0,a.useContext)(y);if(e===T)throw new N.dV("DocSidebarItemsExpandedStateProvider");return e}(),S=(e=!v)=>{k(e?null:r),C(e)};!function({isActive:e,collapsed:t,updateCollapsed:n,activePath:i}){const s=(0,N.ZC)(e),o=(0,N.ZC)(i);(0,a.useEffect)(()=>{(e&&!s||e&&s&&i!==o)&&t&&n(!1)},[e,s,t,n,i,o])}({isActive:j,collapsed:v,updateCollapsed:S,activePath:n}),(0,a.useEffect)(()=>{m&&null!=A&&A!==r&&x&&C(!0)},[m,A,r,C,x]);return(0,h.jsxs)("li",{className:(0,i.A)(o.G.docs.docSidebarItemCategory,o.G.docs.docSidebarItemCategoryLevel(s),"menu__list-item",{"menu__list-item--collapsed":v},b),children:[(0,h.jsxs)("div",{className:(0,i.A)("menu__list-item-collapsible",{"menu__list-item-collapsible--active":g}),children:[(0,h.jsx)(B.A,{className:(0,i.A)(F,"menu__link",{"menu__link--sublist":m,"menu__link--sublist-caret":!p&&m,"menu__link--active":j}),onClick:n=>{t?.(e),m&&(p?g?(n.preventDefault(),S()):S(!1):(n.preventDefault(),S()))},"aria-current":g?"page":void 0,role:m&&!p?"button":void 0,"aria-expanded":m&&!p?!v:void 0,href:m?f??"#":f,...c,children:(0,h.jsx)(O,{label:u})}),p&&m&&(0,h.jsx)(Y,{collapsed:v,categoryLabel:u,onClick:e=>{e.preventDefault(),S()}})]}),(0,h.jsx)(L.N,{lazy:!0,as:"ul",className:"menu__list",collapsed:v,children:(0,h.jsx)(Z,{items:d,tabIndex:v?-1:0,onItemClick:t,activePath:n,level:s+1})})]})}const q="menuHtmlItem_UI7Q";function z({item:e,level:t,index:n}){const{value:a,defaultStyle:s,className:l}=e;return(0,h.jsx)("li",{className:(0,i.A)(o.G.docs.docSidebarItemLink,o.G.docs.docSidebarItemLinkLevel(t),s&&[q,"menu__list-item"],l),dangerouslySetInnerHTML:{__html:a}},n)}function X({item:e,...t}){switch(e.type){case"category":return(0,h.jsx)(U,{item:e,...t});case"html":return(0,h.jsx)(z,{item:e,...t});default:return(0,h.jsx)(D,{item:e,...t})}}function K({items:e,...t}){const n=(0,l.Y)(e,t.activePath);return(0,h.jsx)(I,{children:n.map((e,n)=>(0,h.jsx)(X,{item:e,index:n,...t},n))})}const Z=(0,a.memo)(K),$="menu_Qdup",J="menuWithAnnouncementBar_BIQ_";function ee({path:e,sidebar:t,className:n}){const s=function(){const{isActive:e}=(0,S.M)(),[t,n]=(0,a.useState)(e);return(0,d.Mq)(({scrollY:t})=>{e&&n(0===t)},[e]),e&&t}();return(0,h.jsx)("nav",{"aria-label":(0,c.T)({id:"theme.docs.sidebar.navAriaLabel",message:"Docs sidebar",description:"The ARIA label for the sidebar navigation"}),className:(0,i.A)("menu thin-scrollbar",$,s&&J,n),children:(0,h.jsx)("ul",{className:(0,i.A)(o.G.docs.docSidebarMenu,"menu__list"),children:(0,h.jsx)(Z,{items:t,activePath:e,level:1})})})}const te="sidebar_Xoux",ne="sidebarWithHideableNavbar_yeKa",ae="sidebarHidden_OWQS",ie="sidebarLogo_MlHT";function se({path:e,sidebar:t,onCollapse:n,isHidden:a}){const{navbar:{hideOnScroll:s},docs:{sidebar:{hideable:o}}}=(0,_.p)();return(0,h.jsxs)("div",{className:(0,i.A)(te,s&&ne,a&&ae),children:[s&&(0,h.jsx)(g.A,{tabIndex:-1,className:ie}),(0,h.jsx)(ee,{path:e,sidebar:t}),o&&(0,h.jsx)(k,{onClick:n})]})}const oe=a.memo(se);var le=n(665),re=n(6248);const ce=({sidebar:e,path:t})=>{const n=(0,re.M)();return(0,h.jsx)("ul",{className:(0,i.A)(o.G.docs.docSidebarMenu,"menu__list"),children:(0,h.jsx)(Z,{items:e,activePath:t,onItemClick:e=>{"category"===e.type&&e.href&&n.toggle(),"link"===e.type&&n.toggle()},level:1})})};function de(e){return(0,h.jsx)(le.GX,{component:ce,props:e})}const ue=a.memo(de);function me(e){const t=(0,j.l)(),n="desktop"===t||"ssr"===t,a="mobile"===t;return(0,h.jsxs)(h.Fragment,{children:[n&&(0,h.jsx)(oe,{...e}),a&&(0,h.jsx)(ue,{...e})]})}const be="expandButton_ZMhF",he="expandButtonIcon_XBOX";function pe({toggleSidebar:e}){return(0,h.jsx)("div",{className:be,title:(0,c.T)({id:"theme.docs.sidebar.expandButtonTitle",message:"Expand sidebar",description:"The ARIA label and title attribute for expand button of doc sidebar"}),"aria-label":(0,c.T)({id:"theme.docs.sidebar.expandButtonAriaLabel",message:"Expand sidebar",description:"The ARIA label and title attribute for expand button of doc sidebar"}),tabIndex:0,role:"button",onKeyDown:e,onClick:e,children:(0,h.jsx)(v,{className:he})})}const xe={docSidebarContainer:"docSidebarContainer_yHv_",docSidebarContainerHidden:"docSidebarContainerHidden_xQA4",sidebarViewport:"sidebarViewport_iaL1"};function fe({children:e}){const t=(0,r.t)();return(0,h.jsx)(a.Fragment,{children:e},t?.name??"noSidebar")}function je({sidebar:e,hiddenSidebarContainer:t,setHiddenSidebarContainer:n}){const{pathname:s}=(0,f.zy)(),[l,r]=(0,a.useState)(!1),c=(0,a.useCallback)(()=>{l&&r(!1),!l&&(0,x.O)()&&r(!0),n(e=>!e)},[n,l]);return(0,h.jsx)("aside",{className:(0,i.A)(o.G.docs.docSidebarContainer,xe.docSidebarContainer,t&&xe.docSidebarContainerHidden),onTransitionEnd:e=>{e.currentTarget.classList.contains(xe.docSidebarContainer)&&t&&r(!0)},children:(0,h.jsx)(fe,{children:(0,h.jsxs)("div",{className:(0,i.A)(xe.sidebarViewport,l&&xe.sidebarViewportHidden),children:[(0,h.jsx)(me,{sidebar:e,path:s,onCollapse:c,isHidden:l}),l&&(0,h.jsx)(pe,{toggleSidebar:c})]})})})}const _e={docMainContainer:"docMainContainer_qgvB",docMainContainerEnhanced:"docMainContainerEnhanced_nyBY",docItemWrapperEnhanced:"docItemWrapperEnhanced_OMFT"};function ge({hiddenSidebarContainer:e,children:t}){const n=(0,r.t)();return(0,h.jsx)("main",{className:(0,i.A)(_e.docMainContainer,(e||!n)&&_e.docMainContainerEnhanced),children:(0,h.jsx)("div",{className:(0,i.A)("container padding-top--md padding-bottom--lg",_e.docItemWrapper,e&&_e.docItemWrapperEnhanced),children:t})})}const ve="docRoot_cyW0",Ce="docsWrapper_es0q";function Ae({children:e}){const t=(0,r.t)(),[n,i]=(0,a.useState)(!1);return(0,h.jsxs)("div",{className:Ce,children:[(0,h.jsx)(p,{}),(0,h.jsxs)("div",{className:ve,children:[t&&(0,h.jsx)(je,{sidebar:t.items,hiddenSidebarContainer:n,setHiddenSidebarContainer:i}),(0,h.jsx)(ge,{hiddenSidebarContainer:n,children:e})]})]})}var ke=n(8942);function Se(e){const t=(0,l.B5)(e);if(!t)return(0,h.jsx)(ke.A,{});const{docElement:n,sidebarName:a,sidebarItems:c}=t;return(0,h.jsx)(s.e3,{className:(0,i.A)(o.G.page.docsDocPage),children:(0,h.jsx)(r.V,{name:a,items:c,children:(0,h.jsx)(Ae,{children:n})})})}},8942(e,t,n){n.d(t,{A:()=>l});n(758);var a=n(3526),i=n(3524),s=n(6971),o=n(6070);function l({className:e}){return(0,o.jsx)("main",{className:(0,a.A)("container margin-vert--xl",e),children:(0,o.jsx)("div",{className:"row",children:(0,o.jsxs)("div",{className:"col col--6 col--offset-3",children:[(0,o.jsx)(s.A,{as:"h1",className:"hero__title",children:(0,o.jsx)(i.A,{id:"theme.NotFound.title",description:"The title of the 404 page",children:"Page Not Found"})}),(0,o.jsx)("p",{children:(0,o.jsx)(i.A,{id:"theme.NotFound.p1",description:"The first paragraph of the 404 page",children:"We could not find what you were looking for."})}),(0,o.jsx)("p",{children:(0,o.jsx)(i.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."})})]})})})}}}]);

package/build/docs/assets/js/acaa8c75.70525e75.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_logrocket=globalThis.webpackChunk_elliemae_pui_logrocket||[]).push([[5754],{4874(e,i,a){a.r(i),a.d(i,{assets:()=>r,contentTitle:()=>o,default:()=>d,frontMatter:()=>s,metadata:()=>t,toc:()=>c});const t=JSON.parse('{"id":"api/type-aliases/LROptions","title":"LROptions","description":"LogRocket initialization options","source":"@site/docs/api/type-aliases/LROptions.md","sourceDirName":"api/type-aliases","slug":"/api/type-aliases/LROptions","permalink":"/logrocket/api/type-aliases/LROptions","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-logrocket.git/docs/api/type-aliases/LROptions.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"initLogRocket()","permalink":"/logrocket/api/functions/initLogRocket"}}');var n=a(6070),l=a(116);const s={},o="LROptions",r={},c=[{value:"Type Declaration",id:"type-declaration",level:2},{value:"appId?",id:"appid",level:3},{value:"Example",id:"example",level:4},{value:"Default",id:"default",level:4},{value:"isReact?",id:"isreact",level:3},{value:"Default",id:"default-1",level:4}];function p(e){const i={code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",pre:"pre",...(0,l.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.header,{children:(0,n.jsx)(i.h1,{id:"lroptions",children:"LROptions"})}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-ts",children:"type LROptions = Parameters<typeof LogRocket.init>[1] & {\n  appId?: string;\n  isReact?: boolean;\n};\n"})}),"\n",(0,n.jsx)(i.p,{children:"LogRocket initialization options"}),"\n",(0,n.jsx)(i.h2,{id:"type-declaration",children:"Type Declaration"}),"\n",(0,n.jsx)(i.h3,{id:"appid",children:"appId?"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-ts",children:"optional appId: string;\n"})}),"\n",(0,n.jsx)(i.p,{children:"unique identifier of the logrocket project"}),"\n",(0,n.jsx)(i.h4,{id:"example",children:"Example"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-ts",children:"'your-project/your-app'\n"})}),"\n",(0,n.jsx)(i.h4,{id:"default",children:"Default"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-ts",children:"window.emui.logRocketConfig.appId\n"})}),"\n",(0,n.jsx)(i.h3,{id:"isreact",children:"isReact?"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-ts",children:"optional isReact: boolean;\n"})}),"\n",(0,n.jsx)(i.p,{children:"indicates if the application is using react framework"}),"\n",(0,n.jsx)(i.h4,{id:"default-1",children:"Default"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-ts",children:"true\n"})})]})}function d(e={}){const{wrapper:i}={...(0,l.R)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(p,{...e})}):p(e)}}}]);

package/build/docs/assets/js/c377a04b.2361a76f.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_logrocket=globalThis.webpackChunk_elliemae_pui_logrocket||[]).push([[3361],{3461(e,i,n){n.r(i),n.d(i,{assets:()=>l,contentTitle:()=>a,default:()=>p,frontMatter:()=>o,metadata:()=>t,toc:()=>c});const t=JSON.parse('{"id":"index","title":"Getting Started","description":"UI Platform LogRocket library standardizes the way we integrate LogRocket into our applications.","source":"@site/docs/index.md","sourceDirName":".","slug":"/","permalink":"/logrocket/","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-logrocket.git/docs/index.md","tags":[],"version":"current","sidebarPosition":1,"frontMatter":{"sidebar_position":1},"sidebar":"docsSidebar","next":{"title":"Usage Guide","permalink":"/logrocket/usage-guide"}}');var r=n(6070),s=n(116);const o={sidebar_position:1},a="Getting Started",l={},c=[{value:"Features",id:"features",level:2},{value:"Installation",id:"installation",level:2},{value:"NodeJS",id:"nodejs",level:3},{value:"CDN",id:"cdn",level:3},{value:"Usage",id:"usage",level:2}];function d(e){const i={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",p:"p",pre:"pre",ul:"ul",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(i.header,{children:(0,r.jsx)(i.h1,{id:"getting-started",children:"Getting Started"})}),"\n",(0,r.jsx)(i.p,{children:"UI Platform LogRocket library standardizes the way we integrate LogRocket into our applications."}),"\n",(0,r.jsx)(i.p,{children:"LogRocket is an observability tool that helps us to understand problems affecting our users. It records everything users do on our site, including network requests, JavaScript errors, and browser metadata. This allows us to reproduce issues and fix them faster."}),"\n",(0,r.jsx)(i.p,{children:"It also provides product analytics, performance monitoring, and user feedback features, enabling us to improve the overall user experience."}),"\n",(0,r.jsx)(i.h2,{id:"features",children:"Features"}),"\n",(0,r.jsxs)(i.ul,{children:["\n",(0,r.jsx)(i.li,{children:"Easy initialization of LogRocket with a simple function call."}),"\n",(0,r.jsxs)(i.li,{children:["Consistent configuration across different applications.","\n",(0,r.jsxs)(i.ul,{children:["\n",(0,r.jsx)(i.li,{children:"Truncation of network requests & response body to ensure data privacy."}),"\n",(0,r.jsx)(i.li,{children:"Redaction of sensitive information from user inputs elements."}),"\n",(0,r.jsx)(i.li,{children:"Redaction of sensitive http request headers and url query parameters."}),"\n",(0,r.jsx)(i.li,{children:"Removes sensitive aria attributes to prevent capturing of PII information."}),"\n",(0,r.jsx)(i.li,{children:"Integration with UI Platform ecosystem (App SDK, React Boilerplate, pui-diagnostics)"}),"\n",(0,r.jsx)(i.li,{children:"Merging of session recording across multiple iframes."}),"\n",(0,r.jsx)(i.li,{children:"Support for react component names in session recordings."}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(i.li,{children:"Support for both NodeJS and CDN installations."}),"\n",(0,r.jsx)(i.li,{children:"TypeScript definitions for better developer experience."}),"\n",(0,r.jsx)(i.li,{children:"Built-in error tracking and performance monitoring."}),"\n"]}),"\n",(0,r.jsx)(i.h2,{id:"installation",children:"Installation"}),"\n",(0,r.jsx)(i.h3,{id:"nodejs",children:"NodeJS"}),"\n",(0,r.jsx)(i.p,{children:"Install the library using pnpm:"}),"\n",(0,r.jsx)(i.pre,{children:(0,r.jsx)(i.code,{className:"language-bash",children:"pnpm add @elliemae/pui-logrocket\n"})}),"\n",(0,r.jsx)(i.h3,{id:"cdn",children:"CDN"}),"\n",(0,r.jsx)(i.p,{children:"Include the library via a CDN (Recommended). Add the following script tag to your HTML:"}),"\n",(0,r.jsx)(i.pre,{children:(0,r.jsx)(i.code,{className:"language-html",children:'<script src="https://cdn.mortgagetech.ice.com/pui-logrocket@1"><\/script>\n'})}),"\n",(0,r.jsx)(i.p,{children:"UAT version:"}),"\n",(0,r.jsx)(i.pre,{children:(0,r.jsx)(i.code,{className:"language-html",children:'<script src="https://cdn.mortgagetech.uat1.ice.com/pui-logrocket@1"><\/script>\n'})}),"\n",(0,r.jsx)(i.p,{children:"Stage version:"}),"\n",(0,r.jsx)(i.pre,{children:(0,r.jsx)(i.code,{className:"language-html",children:'<script src="https://cdn.mortgagetech.s1.ice.com/pui-logrocket@1"><\/script>\n'})}),"\n",(0,r.jsx)(i.p,{children:"PEG version:"}),"\n",(0,r.jsx)(i.pre,{children:(0,r.jsx)(i.code,{className:"language-html",children:'<script src="https://cdn.mortgagetech.pl1.ice.com/pui-logrocket@1"><\/script>\n'})}),"\n",(0,r.jsx)(i.p,{children:"QA version:"}),"\n",(0,r.jsx)(i.pre,{children:(0,r.jsx)(i.code,{className:"language-html",children:'<script src="https://cdn.mortgagetech.q1.ice.com/pui-logrocket@1"><\/script>\n'})}),"\n",(0,r.jsx)(i.h2,{id:"usage",children:"Usage"}),"\n",(0,r.jsx)(i.p,{children:"Once installed you can initialize LogRocket in your application:"}),"\n",(0,r.jsx)(i.p,{children:"with NodeJS install:"}),"\n",(0,r.jsx)(i.pre,{children:(0,r.jsx)(i.code,{className:"language-javascript",children:"import { initLogRocket } from '@elliemae/pui-logrocket';\n\ninitLogRocket({ appId: 'logrocket-app-id' });\n"})}),"\n",(0,r.jsx)(i.p,{children:"with CDN install:"}),"\n",(0,r.jsx)(i.pre,{children:(0,r.jsx)(i.code,{className:"language-javascript",children:"window.emuiLogrocket.initLogRocket({ appId: 'logrocket-app-id' });\n"})}),"\n",(0,r.jsxs)(i.p,{children:["Replace ",(0,r.jsx)(i.code,{children:"logrocket-app-id"})," with your actual LogRocket app ID."]})]})}function p(e={}){const{wrapper:i}={...(0,s.R)(),...e.components};return i?(0,r.jsx)(i,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}}}]);