npm - @elliemae/pui-logrocket - Versions diffs - 1.2.3 → 1.2.5-alpha.1 - Mend

@elliemae/pui-logrocket 1.2.3 → 1.2.5-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (39) hide show

package/build/docs/404.html CHANGED Viewed

@@ -4,8 +4,8 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.9.2">
 <title data-rh="true">LogRocket</title><meta data-rh="true" property="og:title" content="LogRocket"><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/logrocket/404.html"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><link data-rh="true" rel="icon" href="/logrocket/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/logrocket/404.html"><link data-rh="true" rel="alternate" href="https://pui.ice.com/logrocket/404.html" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/logrocket/404.html" hreflang="x-default"><link rel="stylesheet" href="/logrocket/assets/css/styles.48d5ef50.css">
-<script src="/logrocket/assets/js/runtime~main.5e481bc4.js" defer="defer"></script>
-<script src="/logrocket/assets/js/main.7d3be447.js" defer="defer"></script>
+<script src="/logrocket/assets/js/runtime~main.04858d8d.js" defer="defer"></script>
+<script src="/logrocket/assets/js/main.8e0561d2.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
 <svg style="display: none;"><defs>

package/build/docs/api/functions/buildLogRocketQueryParams/index.html CHANGED Viewed

@@ -4,8 +4,8 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.9.2">
 <title data-rh="true">buildLogRocketQueryParams() | LogRocket</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/logrocket/api/functions/buildLogRocketQueryParams"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="buildLogRocketQueryParams() | LogRocket"><meta data-rh="true" name="description" content="Builds a URL query string containing LogRocket-related parameters."><meta data-rh="true" property="og:description" content="Builds a URL query string containing LogRocket-related parameters."><link data-rh="true" rel="icon" href="/logrocket/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/logrocket/api/functions/buildLogRocketQueryParams"><link data-rh="true" rel="alternate" href="https://pui.ice.com/logrocket/api/functions/buildLogRocketQueryParams" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/logrocket/api/functions/buildLogRocketQueryParams" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"LogRocket API","item":"https://pui.ice.com/logrocket/api/"},{"@type":"ListItem","position":2,"name":"buildLogRocketQueryParams()","item":"https://pui.ice.com/logrocket/api/functions/buildLogRocketQueryParams"}]}</script><link rel="stylesheet" href="/logrocket/assets/css/styles.48d5ef50.css">
-<script src="/logrocket/assets/js/runtime~main.5e481bc4.js" defer="defer"></script>
-<script src="/logrocket/assets/js/main.7d3be447.js" defer="defer"></script>
+<script src="/logrocket/assets/js/runtime~main.04858d8d.js" defer="defer"></script>
+<script src="/logrocket/assets/js/main.8e0561d2.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
 <svg style="display: none;"><defs>

package/build/docs/api/functions/hasUserConsentedToSessionRecording/index.html CHANGED Viewed

@@ -4,8 +4,8 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.9.2">
 <title data-rh="true">hasUserConsentedToSessionRecording() | LogRocket</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/logrocket/api/functions/hasUserConsentedToSessionRecording"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="hasUserConsentedToSessionRecording() | LogRocket"><meta data-rh="true" name="description" content="Determines whether the user has consented to session recording based on OneTrust configuration and other signals."><meta data-rh="true" property="og:description" content="Determines whether the user has consented to session recording based on OneTrust configuration and other signals."><link data-rh="true" rel="icon" href="/logrocket/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/logrocket/api/functions/hasUserConsentedToSessionRecording"><link data-rh="true" rel="alternate" href="https://pui.ice.com/logrocket/api/functions/hasUserConsentedToSessionRecording" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/logrocket/api/functions/hasUserConsentedToSessionRecording" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"LogRocket API","item":"https://pui.ice.com/logrocket/api/"},{"@type":"ListItem","position":2,"name":"hasUserConsentedToSessionRecording()","item":"https://pui.ice.com/logrocket/api/functions/hasUserConsentedToSessionRecording"}]}</script><link rel="stylesheet" href="/logrocket/assets/css/styles.48d5ef50.css">
-<script src="/logrocket/assets/js/runtime~main.5e481bc4.js" defer="defer"></script>
-<script src="/logrocket/assets/js/main.7d3be447.js" defer="defer"></script>
+<script src="/logrocket/assets/js/runtime~main.04858d8d.js" defer="defer"></script>
+<script src="/logrocket/assets/js/main.8e0561d2.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
 <svg style="display: none;"><defs>
@@ -16,7 +16,7 @@
 <p>Determines whether the user has consented to session recording based on OneTrust configuration and other signals.</p>
 <p>This function checks for user consent using multiple strategies, in the following order:</p>
 <ol>
-<li class="">Checks for a manual override via <code>window.emui.dangerouslyOverrideSessionRecordingConsent</code>.</li>
+<li class="">If <code>window.emui.dangerouslyOverrideSessionRecordingConsent</code> is <code>true</code>, force consent ON (test/dev only). Any other value (<code>false</code>, <code>undefined</code>) defers to the normal sources below — <code>false</code> is <strong>not</strong> a force-disable.</li>
 <li class="">If OneTrust is loaded, checks if <code>window.OnetrustActiveGroups</code> contains the session recording group ID (&#x27;C0003&#x27;).</li>
 <li class="">If OneTrust is not loaded, checks the <code>analyticsConsent</code> query parameter in the current URL.</li>
 <li class="">If running in an iframe, checks the <code>analyticsConsent</code> query parameter in the iframe&#x27;s src URL.</li>

package/build/docs/api/functions/initLogRocket/index.html CHANGED Viewed

@@ -4,8 +4,8 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.9.2">
 <title data-rh="true">initLogRocket() | LogRocket</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/logrocket/api/functions/initLogRocket"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="initLogRocket() | LogRocket"><meta data-rh="true" name="description" content="Initialize LogRocket with optional OneTrust integration"><meta data-rh="true" property="og:description" content="Initialize LogRocket with optional OneTrust integration"><link data-rh="true" rel="icon" href="/logrocket/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/logrocket/api/functions/initLogRocket"><link data-rh="true" rel="alternate" href="https://pui.ice.com/logrocket/api/functions/initLogRocket" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/logrocket/api/functions/initLogRocket" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"LogRocket API","item":"https://pui.ice.com/logrocket/api/"},{"@type":"ListItem","position":2,"name":"initLogRocket()","item":"https://pui.ice.com/logrocket/api/functions/initLogRocket"}]}</script><link rel="stylesheet" href="/logrocket/assets/css/styles.48d5ef50.css">
-<script src="/logrocket/assets/js/runtime~main.5e481bc4.js" defer="defer"></script>
-<script src="/logrocket/assets/js/main.7d3be447.js" defer="defer"></script>
+<script src="/logrocket/assets/js/runtime~main.04858d8d.js" defer="defer"></script>
+<script src="/logrocket/assets/js/main.8e0561d2.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
 <svg style="display: none;"><defs>

package/build/docs/api/index.html CHANGED Viewed

@@ -4,8 +4,8 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.9.2">
 <title data-rh="true">LogRocket API | LogRocket</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/logrocket/api/"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="LogRocket API | LogRocket"><meta data-rh="true" name="description" content="Functions"><meta data-rh="true" property="og:description" content="Functions"><link data-rh="true" rel="icon" href="/logrocket/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/logrocket/api/"><link data-rh="true" rel="alternate" href="https://pui.ice.com/logrocket/api/" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/logrocket/api/" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"LogRocket API","item":"https://pui.ice.com/logrocket/api/"}]}</script><link rel="stylesheet" href="/logrocket/assets/css/styles.48d5ef50.css">
-<script src="/logrocket/assets/js/runtime~main.5e481bc4.js" defer="defer"></script>
-<script src="/logrocket/assets/js/main.7d3be447.js" defer="defer"></script>
+<script src="/logrocket/assets/js/runtime~main.04858d8d.js" defer="defer"></script>
+<script src="/logrocket/assets/js/main.8e0561d2.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
 <svg style="display: none;"><defs>

package/build/docs/api/type-aliases/LROptions/index.html CHANGED Viewed

@@ -4,8 +4,8 @@
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v3.9.2">
 <title data-rh="true">LROptions | LogRocket</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/logrocket/api/type-aliases/LROptions"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="LROptions | LogRocket"><meta data-rh="true" name="description" content="LogRocket initialization options"><meta data-rh="true" property="og:description" content="LogRocket initialization options"><link data-rh="true" rel="icon" href="/logrocket/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/logrocket/api/type-aliases/LROptions"><link data-rh="true" rel="alternate" href="https://pui.ice.com/logrocket/api/type-aliases/LROptions" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/logrocket/api/type-aliases/LROptions" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"LogRocket API","item":"https://pui.ice.com/logrocket/api/"},{"@type":"ListItem","position":2,"name":"LROptions","item":"https://pui.ice.com/logrocket/api/type-aliases/LROptions"}]}</script><link rel="stylesheet" href="/logrocket/assets/css/styles.48d5ef50.css">
-<script src="/logrocket/assets/js/runtime~main.5e481bc4.js" defer="defer"></script>
-<script src="/logrocket/assets/js/main.7d3be447.js" defer="defer"></script>
+<script src="/logrocket/assets/js/runtime~main.04858d8d.js" defer="defer"></script>
+<script src="/logrocket/assets/js/main.8e0561d2.js" defer="defer"></script>
 </head>
 <body class="navigation-with-keyboard">
 <svg style="display: none;"><defs>

package/build/docs/assets/js/04ee7372.c7af6b05.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(globalThis.webpackChunk_elliemae_pui_logrocket=globalThis.webpackChunk_elliemae_pui_logrocket||[]).push([[5908],{578(e,n,i){i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>l,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>c});const o=JSON.parse('{"id":"usage-guide","title":"Usage Guide","description":"UI Platform LogRocket library standardizes the way we integrate LogRocket into our applications.","source":"@site/docs/usage-guide.md","sourceDirName":".","slug":"/usage-guide","permalink":"/logrocket/usage-guide","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-logrocket.git/docs/usage-guide.md","tags":[],"version":"current","sidebarPosition":2,"frontMatter":{"sidebar_position":2},"sidebar":"docsSidebar","previous":{"title":"Getting Started","permalink":"/logrocket/"},"next":{"title":"Compliance Requirements","permalink":"/logrocket/compliance"}}');var t=i(6070),s=i(116);const r={sidebar_position:2},l="Usage Guide",a={},c=[{value:"Initialization",id:"initialization",level:2},{value:"Preventing Duplicate Initialization",id:"preventing-duplicate-initialization",level:3},{value:"Window Variables",id:"window-variables",level:3},{value:"Proxying LogRocket Calls Through CDN Domain",id:"proxying-logrocket-calls-through-cdn-domain",level:2},{value:"Setting CDN Domain for Bundled (npm) Usage",id:"setting-cdn-domain-for-bundled-npm-usage",level:3},{value:"Verifying Proxying in Browser DevTools",id:"verifying-proxying-in-browser-devtools",level:3},{value:"Testing LogRocket Integration from Localhost",id:"testing-logrocket-integration-from-localhost",level:2},{value:"Option 1: Environment Variable",id:"option-1-environment-variable",level:3},{value:"Option 2: Configuration Flag",id:"option-2-configuration-flag",level:3},{value:"Controlling Session Recording Based on User Consent",id:"controlling-session-recording-based-on-user-consent",level:2},{value:"Two-Level Consent Control",id:"two-level-consent-control",level:3},{value:"OneTrust Integration",id:"onetrust-integration",level:3},{value:"Overriding Session Recording Consent Check",id:"overriding-session-recording-consent-check",level:3},{value:"Sharing information with child micro applications",id:"sharing-information-with-child-micro-applications",level:2},{value:"Support for Legacy AngularJS Microapps in Iframes",id:"support-for-legacy-angularjs-microapps-in-iframes",level:3}];function d(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"usage-guide",children:"Usage Guide"})}),"\n",(0,t.jsx)(n.p,{children:"UI Platform LogRocket library standardizes the way we integrate LogRocket into our applications."}),"\n",(0,t.jsx)(n.h2,{id:"initialization",children:"Initialization"}),"\n",(0,t.jsxs)(n.p,{children:["To initialize LogRocket using the UI Platform LogRocket library, you can use the ",(0,t.jsx)(n.code,{children:"initLogRocket"})," function. This function accepts a configuration object where you can specify your LogRocket application ID and other optional settings."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"import { initLogRocket } from '@elliemae/pui-logrocket';\n\ninitLogRocket({ appId: 'logrocket-app-id' });\n"})}),"\n",(0,t.jsxs)(n.p,{children:["Replace ",(0,t.jsx)(n.code,{children:"logrocket-app-id"}),' with your actual LogRocket app ID. You can use window variables to configure LogRocket based on your environment (dev, stage, prod etc.,). See the "Window Variables" section below for more details.']}),"\n",(0,t.jsx)(n.h3,{id:"preventing-duplicate-initialization",children:"Preventing Duplicate Initialization"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"initLogRocket"})," is safe to call multiple times \u2014 only the first call initializes LogRocket; subsequent calls are no-ops. This lets each module in a micro-frontend call it without coordinating."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"import { initLogRocket } from '@elliemae/pui-logrocket';\n\ninitLogRocket({ appId: 'logrocket-app-id' }); // initializes\ninitLogRocket({ appId: 'logrocket-app-id' }); // no-op\n"})}),"\n",(0,t.jsx)(n.h3,{id:"window-variables",children:"Window Variables"}),"\n",(0,t.jsxs)(n.p,{children:["The UI Platform LogRocket library can be configured using global window variables below, which can be set before making the ",(0,t.jsx)(n.code,{children:"initLogRocket"})," call."]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"window.emui.logRocketConfig"})}),": The main LogRocket configuration object."]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"This object has following properties:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"appId"})," (string): LogRocket application ID allocated to the product."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"enable"})," (boolean): Flag to enable or disable LogRocket in the microapp. Defaults to ",(0,t.jsx)(n.code,{children:"true"}),". If set to ",(0,t.jsx)(n.code,{children:"false"}),", LogRocket will not be initialized even if ",(0,t.jsx)(n.code,{children:"initLogRocket"})," is called. This can be useful for disabling LogRocket in certain environments (e.g., development or staging)."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"localhostEnable"})," (boolean): Flag to enable LogRocket when running on localhost. Defaults to ",(0,t.jsx)(n.code,{children:"false"}),". When set to ",(0,t.jsx)(n.code,{children:"true"}),", LogRocket will be enabled on localhost even if the ",(0,t.jsx)(n.code,{children:"LOGROCKET_ENABLE_ON_LOCALHOST"})," environment variable is not set. This is useful for local development and testing."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"childDomains"})," (array of strings, optional): Cross-origin child app origins to link sessions with when the page embeds them as iframes.","\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Default:"})," same-origin children stitch automatically with no configuration."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Set this when:"})," the page is a parent that embeds ",(0,t.jsx)(n.strong,{children:"cross-origin"})," guest microapps (e.g. ",(0,t.jsx)(n.code,{children:"https://app.ice.com"})," embedding ",(0,t.jsx)(n.code,{children:"https://guest.example.com"}),"). List each cross-origin child origin."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Format:"})," array of full origins (e.g. ",(0,t.jsx)(n.code,{children:"['https://guest.example.com']"}),"). Bare hostnames, URLs with paths, and non-array values are dropped with a warning."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Note:"})," children themselves don't set this option \u2014 they need ",(0,t.jsx)(n.code,{children:"parentDomain"})," (normally auto-detected). Both sides must be configured for cross-origin linking to work."]}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"parentDomain"})," (string, optional): Origin of the page that embeds this one. Used by LogRocket to link the child's session to the parent's.","\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Default:"})," auto-detected when the parent uses ",(0,t.jsx)(n.code,{children:"buildLogRocketQueryParams"})," (covers cross-origin embeds reliably). Same-origin parents are also detected automatically."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Set this when:"})," the parent is cross-origin and does ",(0,t.jsx)(n.strong,{children:"not"})," call ",(0,t.jsx)(n.code,{children:"buildLogRocketQueryParams"}),". Otherwise leave unset."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Format:"})," a full origin (e.g. ",(0,t.jsx)(n.code,{children:"https://parent.example.com"}),"). Bare hostnames or URLs with paths are dropped with a warning."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Note:"})," do not set this on a top-level page (no parent) \u2014 it would tell LogRocket to wait on a parent that doesn't exist and stall session start."]}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"rootHostname"})," (string, optional): Cookie scope for stitching sessions across subdomains of the ",(0,t.jsx)(n.strong,{children:"same site"})," (see ",(0,t.jsx)(n.a,{href:"https://docs.logrocket.com/reference/roothostname",children:"LogRocket docs"}),").","\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Default:"})," auto-detected as ",(0,t.jsx)(n.code,{children:".<last two hostname segments>"})," (e.g. ",(0,t.jsx)(n.code,{children:"beta.encompass.ice.com"})," \u2192 ",(0,t.jsx)(n.code,{children:".ice.com"}),"). Same-site iframes converge on the same value automatically."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Set this when:"})," you want to ",(0,t.jsx)(n.strong,{children:"narrow"})," the cookie scope to a deeper subtree so sessions in that subtree don't merge with the rest of the site (e.g. set ",(0,t.jsx)(n.code,{children:".beta.ice.com"})," on ",(0,t.jsx)(n.code,{children:"app.beta.ice.com"})," to keep beta sessions isolated from prod)."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Format:"})," must start with ",(0,t.jsx)(n.code,{children:"."})," and end with the auto-detected value. A different site, a shallower scope, or a missing leading dot is rejected with a warning."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Note:"})," cross-",(0,t.jsx)(n.strong,{children:"site"})," frame linking is handled by ",(0,t.jsx)(n.code,{children:"parentDomain"}),"/",(0,t.jsx)(n.code,{children:"childDomains"}),", not this option."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"proxying-logrocket-calls-through-cdn-domain",children:"Proxying LogRocket Calls Through CDN Domain"}),"\n",(0,t.jsxs)(n.p,{children:["LogRocket script loading and data ingestion are proxied through the UI Platform CDN (",(0,t.jsx)(n.code,{children:"cdn.mortgagetech.*.ice.com"}),") instead of LogRocket's own servers. This improves ad-blocker resilience and complies with policies that restrict traffic to internal domains."]}),"\n",(0,t.jsxs)(n.p,{children:["The CDN domain is auto-detected when the library is loaded from a CDN URL or ",(0,t.jsx)(n.code,{children:"localhost"}),". No configuration is needed in that case."]}),"\n",(0,t.jsx)(n.h3,{id:"setting-cdn-domain-for-bundled-npm-usage",children:"Setting CDN Domain for Bundled (npm) Usage"}),"\n",(0,t.jsxs)(n.p,{children:["When the library is imported as an npm package, auto-detection cannot run. Set ",(0,t.jsx)(n.code,{children:"window.emui.cdnDomain"})," to the correct environment before the library loads:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"window.emui = window.emui || {};\nwindow.emui.cdnDomain = 'https://cdn.mortgagetech.q1.ice.com'; // d1, q1, etc.\n"})}),"\n",(0,t.jsx)(n.h3,{id:"verifying-proxying-in-browser-devtools",children:"Verifying Proxying in Browser DevTools"}),"\n",(0,t.jsxs)(n.p,{children:["In the ",(0,t.jsx)(n.strong,{children:"Network"})," tab, requests should go to ",(0,t.jsx)(n.code,{children:"https://cdn.mortgagetech.<env>.ice.com/..."})," rather than ",(0,t.jsx)(n.code,{children:"cdn.lr-in-prod.com"})," or ",(0,t.jsx)(n.code,{children:"r.lr-in-prod.com"}),". If they don't, set ",(0,t.jsx)(n.code,{children:"window.emui.cdnDomain"})," or load the library from the CDN."]}),"\n",(0,t.jsx)(n.h2,{id:"testing-logrocket-integration-from-localhost",children:"Testing LogRocket Integration from Localhost"}),"\n",(0,t.jsx)(n.p,{children:"When developing locally, you may want to test LogRocket integration. There are two ways to enable LogRocket on localhost:"}),"\n",(0,t.jsx)(n.h3,{id:"option-1-environment-variable",children:"Option 1: Environment Variable"}),"\n",(0,t.jsxs)(n.p,{children:["Set the environment variable ",(0,t.jsx)(n.code,{children:"LOGROCKET_ENABLE_ON_LOCALHOST"})," to ",(0,t.jsx)(n.code,{children:"true"}),". If you are using a ",(0,t.jsx)(n.code,{children:".env"})," file, add the following line:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-txt",children:"LOGROCKET_ENABLE_ON_LOCALHOST=true\n"})}),"\n",(0,t.jsx)(n.h3,{id:"option-2-configuration-flag",children:"Option 2: Configuration Flag"}),"\n",(0,t.jsxs)(n.p,{children:["Set the ",(0,t.jsx)(n.code,{children:"window.emui.logRocketConfig.localhostEnable"})," flag to ",(0,t.jsx)(n.code,{children:"true"})," before calling ",(0,t.jsx)(n.code,{children:"initLogRocket"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"window.emui = window.emui || {};\nwindow.emui.logRocketConfig = window.emui.logRocketConfig || {};\nwindow.emui.logRocketConfig.localhostEnable = true;\n\nimport { initLogRocket } from '@elliemae/pui-logrocket';\ninitLogRocket({ appId: 'logrocket-app-id' });\n"})}),"\n",(0,t.jsxs)(n.p,{children:["LogRocket will be enabled on localhost if ",(0,t.jsx)(n.strong,{children:"either"})," the environment variable ",(0,t.jsx)(n.strong,{children:"or"})," the configuration flag is set to ",(0,t.jsx)(n.code,{children:"true"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"controlling-session-recording-based-on-user-consent",children:"Controlling Session Recording Based on User Consent"}),"\n",(0,t.jsx)(n.p,{children:"OneTrust consent management platform is the tool used to manage user consent in ICE. When the root microapplication integrates with OneTrust, the UI Platform LogRocket library leverages OneTrust to control LogRocket initialization and session recording based on user consent."}),"\n",(0,t.jsx)(n.h3,{id:"two-level-consent-control",children:"Two-Level Consent Control"}),"\n",(0,t.jsx)(n.p,{children:"The library implements a two-level consent control system:"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"LogRocket Initialization (C0002 - Performance Cookies)"}),": Controls whether LogRocket is initialized at all"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"If C0002 is not granted, LogRocket will not initialize"}),"\n",(0,t.jsx)(n.li,{children:"When OneTrust is not loaded, LogRocket initializes by default"}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Session Recording (C0003 - Functional Cookies)"}),": Controls whether DOM recording is enabled"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"If C0003 is not granted, LogRocket still captures technical data but disables visual session recording"}),"\n",(0,t.jsx)(n.li,{children:"Technical data includes: network requests, console logs, JavaScript errors, performance metrics, and custom events"}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:'OneTrust should be integrated only in the root microapplication. Child microapplications (e.g., iframes) do not need to integrate with OneTrust directly, as they will inherit the consent status from the root microapplication via URL query parameters (see "Sharing LogRocket information with child micro applications" section below).'}),"\n",(0,t.jsx)(n.h3,{id:"onetrust-integration",children:"OneTrust Integration"}),"\n",(0,t.jsx)(n.p,{children:"When OneTrust is present, the library waits for the user's consent decision before initializing LogRocket. Both first-time visitors (waits for the consent banner) and returning visitors (uses cached consent) are handled automatically \u2014 there's nothing for the consuming app to wire up. If OneTrust signals don't arrive within 10 seconds, the library initializes with whatever consent state is available so LogRocket isn't blocked indefinitely."}),"\n",(0,t.jsxs)(n.p,{children:["The library also applies privacy-focused defaults (input/text sanitization, hidden ARIA attributes, network body redaction). See the ",(0,t.jsx)(n.a,{href:"/logrocket/compliance",children:"Compliance Guide"})," for details."]}),"\n",(0,t.jsx)(n.h3,{id:"overriding-session-recording-consent-check",children:"Overriding Session Recording Consent Check"}),"\n",(0,t.jsxs)(n.p,{children:["For local development, set ",(0,t.jsx)(n.code,{children:"window.emui.dangerouslyOverrideSessionRecordingConsent"})," to ",(0,t.jsx)(n.code,{children:"true"})," before calling ",(0,t.jsx)(n.code,{children:"initLogRocket"})," to force session recording on regardless of OneTrust consent. A console warning is logged whenever this override takes effect."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"window.emui = window.emui || {};\nwindow.emui.dangerouslyOverrideSessionRecordingConsent = true;\ninitLogRocket({ appId: 'logrocket-app-id' });\n"})}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsxs)(n.strong,{children:["Only ",(0,t.jsx)(n.code,{children:"true"})," overrides consent."]})," Any other value \u2014 including ",(0,t.jsx)(n.code,{children:"false"})," \u2014 is a no-op: the library falls through to the normal consent sources (OneTrust C0003, ",(0,t.jsx)(n.code,{children:"analyticsConsent"})," URL parameter, iframe ",(0,t.jsx)(n.code,{children:"src"})," parameter), which can still grant consent on their own."]}),"\n",(0,t.jsxs)(n.p,{children:["\u26a0\ufe0f ",(0,t.jsx)(n.strong,{children:"Use only for local development and testing."})," This bypasses compliance controls and must never be set in production."]}),"\n",(0,t.jsx)(n.h2,{id:"sharing-information-with-child-micro-applications",children:"Sharing information with child micro applications"}),"\n",(0,t.jsxs)(n.p,{children:["LogRocket is initialized in each micro application independently. The ",(0,t.jsx)(n.code,{children:"buildLogRocketQueryParams"})," utility lets a parent share its LogRocket configuration and consent state with child micro applications (e.g. iframes) via URL query parameters, so children inherit the right setup without hardcoding it. It also lets interoperable children work under different parents (Encompass, TPO, etc.) without changes."]}),"\n",(0,t.jsx)(n.p,{children:"The function returns the following query parameters for inclusion in the child's iframe URL:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"analyticsConsent"})}),": ",(0,t.jsx)(n.code,{children:"'true'"})," if the user consented to functional cookies, else ",(0,t.jsx)(n.code,{children:"'false'"}),"."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"lrEnabled"})}),": ",(0,t.jsx)(n.code,{children:"'true'"})," if LogRocket is enabled in the parent, else ",(0,t.jsx)(n.code,{children:"'false'"}),"."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"lrAppId"})}),": the LogRocket application ID used by the parent."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"lrParentOrigin"})}),": the parent's ",(0,t.jsx)(n.code,{children:"origin"})," (e.g. ",(0,t.jsx)(n.code,{children:"https://parent-app.example.com"}),"). The child reads this to populate ",(0,t.jsx)(n.code,{children:"parentDomain"})," for cross-origin session linking."]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Important"}),": call this after ",(0,t.jsx)(n.code,{children:"initLogRocket"})," so the returned values reflect the parent's actual init state (the parent's consent and enabled state are captured at init time and reused here, so they stay consistent even if the user changes consent later)."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"import { buildLogRocketQueryParams } from '@elliemae/pui-logrocket';\n\nconst urlParams = buildLogRocketQueryParams();\n// \"analyticsConsent=true&lrEnabled=true&lrAppId=your-app-id&lrParentOrigin=https%3A%2F%2Fparent-app.example.com\"\nconst childUrl = `https://child-app.example.com?${urlParams}`;\n// launch guest application with childUrl using SSF V2 / App SDK GuestMicroapp\n"})}),"\n",(0,t.jsx)(n.h3,{id:"support-for-legacy-angularjs-microapps-in-iframes",children:"Support for Legacy AngularJS Microapps in Iframes"}),"\n",(0,t.jsxs)(n.p,{children:["For legacy AngularJS microapps running inside iframes, the library reads ",(0,t.jsx)(n.code,{children:"analyticsConsent"})," from the iframe's ",(0,t.jsx)(n.code,{children:"src"})," URL as a fallback so they inherit consent without code changes."]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Consent Check Priority"})," (highest to lowest):"]}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"OneTrust consent groups"})," (when OneTrust is loaded)"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Current window URL"})," ",(0,t.jsx)(n.code,{children:"analyticsConsent"})," parameter"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Iframe src URL"})," ",(0,t.jsx)(n.code,{children:"analyticsConsent"})," parameter (legacy fallback)"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Default"}),": ",(0,t.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:'// No code change needed in the child microapp; the library reads it automatically.\n<iframe src="https://legacy-app.com/app?analyticsConsent=true&lrAppId=my-app"></iframe>\n'})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}}}]);

package/build/docs/assets/js/211c08f1.c26e72ea.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(globalThis.webpackChunk_elliemae_pui_logrocket=globalThis.webpackChunk_elliemae_pui_logrocket||[]).push([[4319],{7661(e,n,s){s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>a});const o=JSON.parse('{"id":"api/functions/hasUserConsentedToSessionRecording","title":"hasUserConsentedToSessionRecording()","description":"Determines whether the user has consented to session recording based on OneTrust configuration and other signals.","source":"@site/docs/api/functions/hasUserConsentedToSessionRecording.md","sourceDirName":"api/functions","slug":"/api/functions/hasUserConsentedToSessionRecording","permalink":"/logrocket/api/functions/hasUserConsentedToSessionRecording","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-logrocket.git/docs/api/functions/hasUserConsentedToSessionRecording.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"buildLogRocketQueryParams()","permalink":"/logrocket/api/functions/buildLogRocketQueryParams"},"next":{"title":"initLogRocket()","permalink":"/logrocket/api/functions/initLogRocket"}}');var r=s(6070),i=s(116);const t={},c="hasUserConsentedToSessionRecording()",d={},a=[{value:"Returns",id:"returns",level:2}];function l(e){const n={code:"code",h1:"h1",h2:"h2",header:"header",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"hasuserconsentedtosessionrecording",children:"hasUserConsentedToSessionRecording()"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"function hasUserConsentedToSessionRecording(): boolean;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Determines whether the user has consented to session recording based on OneTrust configuration and other signals."}),"\n",(0,r.jsx)(n.p,{children:"This function checks for user consent using multiple strategies, in the following order:"}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsxs)(n.li,{children:["If ",(0,r.jsx)(n.code,{children:"window.emui.dangerouslyOverrideSessionRecordingConsent"})," is ",(0,r.jsx)(n.code,{children:"true"}),", force consent ON (test/dev only). Any other value (",(0,r.jsx)(n.code,{children:"false"}),", ",(0,r.jsx)(n.code,{children:"undefined"}),") defers to the normal sources below \u2014 ",(0,r.jsx)(n.code,{children:"false"})," is ",(0,r.jsx)(n.strong,{children:"not"})," a force-disable."]}),"\n",(0,r.jsxs)(n.li,{children:["If OneTrust is loaded, checks if ",(0,r.jsx)(n.code,{children:"window.OnetrustActiveGroups"})," contains the session recording group ID ('C0003')."]}),"\n",(0,r.jsxs)(n.li,{children:["If OneTrust is not loaded, checks the ",(0,r.jsx)(n.code,{children:"analyticsConsent"})," query parameter in the current URL."]}),"\n",(0,r.jsxs)(n.li,{children:["If running in an iframe, checks the ",(0,r.jsx)(n.code,{children:"analyticsConsent"})," query parameter in the iframe's src URL."]}),"\n",(0,r.jsxs)(n.li,{children:["Defaults to ",(0,r.jsx)(n.code,{children:"false"})," if no consent can be determined."]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["Note: When OneTrust is present, the OneTrust consent groups take precedence over URL parameters.\nThe ",(0,r.jsx)(n.code,{children:"analyticsConsent"})," URL parameter only applies when OneTrust is not loaded."]}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"boolean"})}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"true"})," if the user has consented to session recording, ",(0,r.jsx)(n.code,{children:"false"})," otherwise."]})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}}}]);