@coframe/sdk 1.1.38 → 1.1.40

package/dist/pkg/cf.cjs.js

@@ -3937,21 +3937,31 @@ async function modifyPage(Coframe, configResult, projectResult, analytics) {
 let startRequested = false;
 let replayScriptUrl;
 const COMPILED_REPLAY_SCRIPT_URL = `${"https://edge.cofra.me"}/replay/latest.js`;
+const CONSENT_POLL_MS = 100;
+const CONSENT_WAIT_MS = 5000;
 function configureReplayScriptUrl(url) {
     replayScriptUrl = (url === null || url === void 0 ? void 0 : url.trim()) || undefined;
 }
-function replayConsentAllowed() {
-    var _a;
+function readReplayConsent() {
     try {
-        const privacy = (_a = window.Shopify) === null || _a === void 0 ? void 0 : _a.customerPrivacy;
-        const analyticsAllowed = !privacy ||
-            typeof privacy.analyticsProcessingAllowed !== 'function' ||
-            privacy.analyticsProcessingAllowed() === true;
-        return (navigator
-            .globalPrivacyControl !== true && analyticsAllowed);
+        if (navigator
+            .globalPrivacyControl === true) {
+            return { state: 'denied', reason: 'gpc' };
+        }
+        const shopify = window.Shopify;
+        if (shopify === undefined)
+            return { state: 'allowed', source: 'none' };
+        const customerPrivacy = shopify.customerPrivacy;
+        const analyticsProcessingAllowed = customerPrivacy === null || customerPrivacy === void 0 ? void 0 : customerPrivacy.analyticsProcessingAllowed;
+        if (typeof analyticsProcessingAllowed === 'function') {
+            return analyticsProcessingAllowed.call(customerPrivacy) === true
+                ? { state: 'allowed', source: 'shopify' }
+                : { state: 'denied', reason: 'consent_denied' };
+        }
+        return { state: 'pending' };
     }
-    catch (_b) {
-        return false;
+    catch (_a) {
+        return { state: 'denied', reason: 'consent_unavailable' };
     }
 }
 function createMonitoringPayload(coframe, monitoringType, metadata) {
@@ -3972,16 +3982,23 @@ function reportStartFailure(coframe, reason) {
     }
     catch (_a) { }
 }
-function createStartContext(coframe, settings, forceSample) {
+function reportReplaySkipped(coframe, reason) {
+    try {
+        queueMonitoringEvent(coframe, createMonitoringPayload(coframe, 'replay_skipped', { reason }));
+    }
+    catch (_a) { }
+}
+function createStartContext(coframe, settings, forceSample, consentSource) {
     return {
         projectId: coframe.projectId,
         ingestUrl: resolveIngestUrl("https://ingest.app.coframe.com/ingest/v2"),
         settings,
         forceSample,
+        consentSource,
         getPageViewId: () => coframe.sessionId,
         getUserToken: () => coframe.userToken,
         getVariantIds: () => { var _a; return ((_a = coframe.experimentInfo) !== null && _a !== void 0 ? _a : []).map((experiment) => experiment.variant_id); },
-        canSend: () => shouldSendEvents() && replayConsentAllowed(),
+        canSend: () => shouldSendEvents() && readReplayConsent().state === 'allowed',
         onEventsFlushed: (callback) => {
             if (queuedEvents.length === 0 && queuedSessions.length === 0) {
                 callback();
@@ -3993,22 +4010,13 @@ function createStartContext(coframe, settings, forceSample) {
         report: (type, metadata) => queueMonitoringEvent(coframe, createMonitoringPayload(coframe, type, metadata)),
     };
 }
-function startReplayIfEnabled(coframe, project, nonce) {
-    var _a;
+function insertReplayScript(coframe, settings, consentSource, nonce) {
     try {
-        const settings = (_a = project.settings) === null || _a === void 0 ? void 0 : _a.session_replay;
-        if ((settings === null || settings === void 0 ? void 0 : settings.enabled) !== true ||
-            typeof CompressionStream !== 'function' ||
-            !shouldSendEvents() ||
-            !replayConsentAllowed() ||
-            startRequested) {
-            return;
-        }
         let forceSample = false;
         try {
             forceSample = localStorage.getItem('coframe.enableRecording') === 'true';
         }
-        catch (_b) { }
+        catch (_a) { }
         const script = document.createElement('script');
         script.id = 'coframe-replay-script';
         script.async = true;
@@ -4019,7 +4027,7 @@ function startReplayIfEnabled(coframe, project, nonce) {
             try {
                 const replay = window.CoframeReplay;
                 if ((replay === null || replay === void 0 ? void 0 : replay.protocolVersion) === 1) {
-                    replay.start(createStartContext(coframe, settings, forceSample));
+                    replay.start(createStartContext(coframe, settings, forceSample, consentSource));
                 }
                 else {
                     reportStartFailure(coframe, 'incompatible_protocol');
@@ -4032,13 +4040,56 @@ function startReplayIfEnabled(coframe, project, nonce) {
         script.onerror = () => {
             reportStartFailure(coframe, 'script_load_failed');
         };
-        startRequested = true;
         document.head.appendChild(script);
     }
     catch (error) {
         reportStartFailure(coframe, error instanceof Error ? error.message : String(error));
     }
 }
+function startReplayIfEnabled(coframe, project, nonce) {
+    var _a;
+    try {
+        const settings = (_a = project.settings) === null || _a === void 0 ? void 0 : _a.session_replay;
+        if ((settings === null || settings === void 0 ? void 0 : settings.enabled) !== true ||
+            typeof CompressionStream !== 'function' ||
+            !shouldSendEvents() ||
+            startRequested) {
+            return;
+        }
+        startRequested = true;
+        let waited = 0;
+        const decide = () => {
+            var _a;
+            const consent = readReplayConsent();
+            if (consent.state === 'allowed') {
+                insertReplayScript(coframe, settings, consent.source, nonce);
+            }
+            else if (consent.state === 'denied') {
+                reportReplaySkipped(coframe, consent.reason);
+            }
+            else if (waited >= CONSENT_WAIT_MS) {
+                reportReplaySkipped(coframe, 'consent_unavailable');
+            }
+            else {
+                if (waited === 0) {
+                    try {
+                        const loadFeatures = (_a = window.Shopify) === null || _a === void 0 ? void 0 : _a.loadFeatures;
+                        if (typeof loadFeatures === 'function') {
+                            loadFeatures.call(window.Shopify, [{ name: 'consent-tracking-api', version: '0.1' }], () => { });
+                        }
+                    }
+                    catch (_b) { }
+                }
+                waited += CONSENT_POLL_MS;
+                window.setTimeout(decide, CONSENT_POLL_MS);
+            }
+        };
+        decide();
+    }
+    catch (error) {
+        reportStartFailure(coframe, error instanceof Error ? error.message : String(error));
+    }
+}
 
 const TIMEOUT_MAX_MS = 5000;
 const MAX_NOT_RENDERED_REASON_CHARS = 200;

package/dist/pkg/cf.esm.mjs

@@ -3935,21 +3935,31 @@ async function modifyPage(Coframe, configResult, projectResult, analytics) {
 let startRequested = false;
 let replayScriptUrl;
 const COMPILED_REPLAY_SCRIPT_URL = `${"https://edge.cofra.me"}/replay/latest.js`;
+const CONSENT_POLL_MS = 100;
+const CONSENT_WAIT_MS = 5000;
 function configureReplayScriptUrl(url) {
     replayScriptUrl = (url === null || url === void 0 ? void 0 : url.trim()) || undefined;
 }
-function replayConsentAllowed() {
-    var _a;
+function readReplayConsent() {
     try {
-        const privacy = (_a = window.Shopify) === null || _a === void 0 ? void 0 : _a.customerPrivacy;
-        const analyticsAllowed = !privacy ||
-            typeof privacy.analyticsProcessingAllowed !== 'function' ||
-            privacy.analyticsProcessingAllowed() === true;
-        return (navigator
-            .globalPrivacyControl !== true && analyticsAllowed);
+        if (navigator
+            .globalPrivacyControl === true) {
+            return { state: 'denied', reason: 'gpc' };
+        }
+        const shopify = window.Shopify;
+        if (shopify === undefined)
+            return { state: 'allowed', source: 'none' };
+        const customerPrivacy = shopify.customerPrivacy;
+        const analyticsProcessingAllowed = customerPrivacy === null || customerPrivacy === void 0 ? void 0 : customerPrivacy.analyticsProcessingAllowed;
+        if (typeof analyticsProcessingAllowed === 'function') {
+            return analyticsProcessingAllowed.call(customerPrivacy) === true
+                ? { state: 'allowed', source: 'shopify' }
+                : { state: 'denied', reason: 'consent_denied' };
+        }
+        return { state: 'pending' };
     }
-    catch (_b) {
-        return false;
+    catch (_a) {
+        return { state: 'denied', reason: 'consent_unavailable' };
     }
 }
 function createMonitoringPayload(coframe, monitoringType, metadata) {
@@ -3970,16 +3980,23 @@ function reportStartFailure(coframe, reason) {
     }
     catch (_a) { }
 }
-function createStartContext(coframe, settings, forceSample) {
+function reportReplaySkipped(coframe, reason) {
+    try {
+        queueMonitoringEvent(coframe, createMonitoringPayload(coframe, 'replay_skipped', { reason }));
+    }
+    catch (_a) { }
+}
+function createStartContext(coframe, settings, forceSample, consentSource) {
     return {
         projectId: coframe.projectId,
         ingestUrl: resolveIngestUrl("https://ingest.app.coframe.com/ingest/v2"),
         settings,
         forceSample,
+        consentSource,
         getPageViewId: () => coframe.sessionId,
         getUserToken: () => coframe.userToken,
         getVariantIds: () => { var _a; return ((_a = coframe.experimentInfo) !== null && _a !== void 0 ? _a : []).map((experiment) => experiment.variant_id); },
-        canSend: () => shouldSendEvents() && replayConsentAllowed(),
+        canSend: () => shouldSendEvents() && readReplayConsent().state === 'allowed',
         onEventsFlushed: (callback) => {
             if (queuedEvents.length === 0 && queuedSessions.length === 0) {
                 callback();
@@ -3991,22 +4008,13 @@ function createStartContext(coframe, settings, forceSample) {
         report: (type, metadata) => queueMonitoringEvent(coframe, createMonitoringPayload(coframe, type, metadata)),
     };
 }
-function startReplayIfEnabled(coframe, project, nonce) {
-    var _a;
+function insertReplayScript(coframe, settings, consentSource, nonce) {
     try {
-        const settings = (_a = project.settings) === null || _a === void 0 ? void 0 : _a.session_replay;
-        if ((settings === null || settings === void 0 ? void 0 : settings.enabled) !== true ||
-            typeof CompressionStream !== 'function' ||
-            !shouldSendEvents() ||
-            !replayConsentAllowed() ||
-            startRequested) {
-            return;
-        }
         let forceSample = false;
         try {
             forceSample = localStorage.getItem('coframe.enableRecording') === 'true';
         }
-        catch (_b) { }
+        catch (_a) { }
         const script = document.createElement('script');
         script.id = 'coframe-replay-script';
         script.async = true;
@@ -4017,7 +4025,7 @@ function startReplayIfEnabled(coframe, project, nonce) {
             try {
                 const replay = window.CoframeReplay;
                 if ((replay === null || replay === void 0 ? void 0 : replay.protocolVersion) === 1) {
-                    replay.start(createStartContext(coframe, settings, forceSample));
+                    replay.start(createStartContext(coframe, settings, forceSample, consentSource));
                 }
                 else {
                     reportStartFailure(coframe, 'incompatible_protocol');
@@ -4030,13 +4038,56 @@ function startReplayIfEnabled(coframe, project, nonce) {
         script.onerror = () => {
             reportStartFailure(coframe, 'script_load_failed');
         };
-        startRequested = true;
         document.head.appendChild(script);
     }
     catch (error) {
         reportStartFailure(coframe, error instanceof Error ? error.message : String(error));
     }
 }
+function startReplayIfEnabled(coframe, project, nonce) {
+    var _a;
+    try {
+        const settings = (_a = project.settings) === null || _a === void 0 ? void 0 : _a.session_replay;
+        if ((settings === null || settings === void 0 ? void 0 : settings.enabled) !== true ||
+            typeof CompressionStream !== 'function' ||
+            !shouldSendEvents() ||
+            startRequested) {
+            return;
+        }
+        startRequested = true;
+        let waited = 0;
+        const decide = () => {
+            var _a;
+            const consent = readReplayConsent();
+            if (consent.state === 'allowed') {
+                insertReplayScript(coframe, settings, consent.source, nonce);
+            }
+            else if (consent.state === 'denied') {
+                reportReplaySkipped(coframe, consent.reason);
+            }
+            else if (waited >= CONSENT_WAIT_MS) {
+                reportReplaySkipped(coframe, 'consent_unavailable');
+            }
+            else {
+                if (waited === 0) {
+                    try {
+                        const loadFeatures = (_a = window.Shopify) === null || _a === void 0 ? void 0 : _a.loadFeatures;
+                        if (typeof loadFeatures === 'function') {
+                            loadFeatures.call(window.Shopify, [{ name: 'consent-tracking-api', version: '0.1' }], () => { });
+                        }
+                    }
+                    catch (_b) { }
+                }
+                waited += CONSENT_POLL_MS;
+                window.setTimeout(decide, CONSENT_POLL_MS);
+            }
+        };
+        decide();
+    }
+    catch (error) {
+        reportStartFailure(coframe, error instanceof Error ? error.message : String(error));
+    }
+}
 
 const TIMEOUT_MAX_MS = 5000;
 const MAX_NOT_RENDERED_REASON_CHARS = 200;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coframe/sdk",
-  "version": "1.1.38",
+  "version": "1.1.40",
   "description": "Coframe optimizes your website using generative AI to deliver maximum impact to your audience and allow your site to improve itself as you sleep. Learn more at coframe.com.",
   "main": "dist/pkg/cf.cjs.js",
   "module": "dist/pkg/cf.esm.mjs",