@coframe/sdk 1.1.7 → 1.1.9

package/dist/pkg/cf.cjs.js

@@ -181,6 +181,12 @@ function getBrowserPlatform() {
 function getBrowserReferrer() {
     return document.referrer;
 }
+function getScreenSize() {
+    return {
+        width: window.innerWidth,
+        height: window.innerHeight,
+    };
+}
 function getBrowserHostname() {
     return window.location.hostname;
 }
@@ -926,7 +932,7 @@ function warnEventsNotSent() {
     }
 }
 
-const SDK_VERSION = '2.5.0';
+const SDK_VERSION = '2.6.0';
 const queuedEvents = [];
 const queuedMonitoringEvents = [];
 const queuedSessions = [];
@@ -942,7 +948,7 @@ function queueEventForBatchedSending(coframe, data, flushImmediately = false) {
         flushQueuedEvents(coframe.projectId);
     }
 }
-function queueCreateSession(coframe, orgId, projectId, sessionId, userToken, experimentsInfo, startTime, referrer, platform, languages, userAgent, url, storageInfo, gaSessionInfo, cfId, personalizationHeaders) {
+function queueCreateSession(coframe, orgId, projectId, sessionId, userToken, experimentsInfo, startTime, referrer, platform, languages, userAgent, url, storageInfo, gaSessionInfo, cfId, personalizationHeaders, sessionContext) {
     queuedSessions.push({
         org_id: orgId,
         project_id: projectId,
@@ -960,6 +966,7 @@ function queueCreateSession(coframe, orgId, projectId, sessionId, userToken, exp
             session_metadata: JSON.stringify({
                 url,
                 storage_info: storageInfo,
+                ...sessionContext,
             }),
             ga_session_id: gaSessionInfo === null || gaSessionInfo === void 0 ? void 0 : gaSessionInfo.ga_session_id,
             ga_session_number: gaSessionInfo === null || gaSessionInfo === void 0 ? void 0 : gaSessionInfo.ga_session_number,
@@ -1028,20 +1035,9 @@ function queueVariantViewEvent(coframe, { projectId, sessionId, orgId, userToken
         user_token: userToken,
     });
 }
-function sendPageEngagementEvent(coframe, eventType, event, { isEngaged, projectId, sessionId, orgId, duration = 0, userToken, personalizationHeaders, }) {
+function sendPageEngagementEvent(coframe, eventType, event, { projectId, sessionId, duration = 0, userToken, personalizationHeaders, }) {
     var _a;
     const startTime = performance.now();
-    if (!isEngaged && eventType === 'click') {
-        isEngaged = true;
-        queueEvent(coframe, {
-            projectId,
-            sessionId,
-            eventType: 'session_start',
-            orgId,
-            userToken: userToken || '',
-            personalizationHeaders,
-        });
-    }
     const x = event.clientX + window.scrollX;
     const y = event.clientY + window.scrollY;
     const screenWidth = window.innerWidth;
@@ -2491,6 +2487,59 @@ async function getVariantsAndElements(personalizationHeaders, project, previewVa
     });
 }
 
+function buildSessionContext(isInitialApply) {
+    const context = {};
+    const viewport = getScreenSize();
+    if (isReportedSize(viewport.width) && isReportedSize(viewport.height)) {
+        context.viewport_width = viewport.width;
+        context.viewport_height = viewport.height;
+    }
+    const visitCount = getCookie(VISIT_COUNT_COOKIE_KEY);
+    if (/^[1-9]\d{0,14}$/.test(visitCount)) {
+        context.visit_count = Number(visitCount);
+    }
+    try {
+        context.navigation_type = getNavigationType(isInitialApply);
+    }
+    catch (_a) {
+    }
+    try {
+        const timezone = Intl.DateTimeFormat().resolvedOptions().timeZone;
+        if (timezone) {
+            context.timezone = timezone;
+        }
+    }
+    catch (_b) {
+    }
+    return context;
+}
+function isReportedSize(size) {
+    return (typeof size === 'number' && size > 0 && size !== Number.POSITIVE_INFINITY);
+}
+function getNavigationType(isInitialApply) {
+    var _a, _b;
+    if (!isInitialApply) {
+        return 'spa_navigation';
+    }
+    const nav = (_b = (_a = performance.getEntriesByType) === null || _a === void 0 ? void 0 : _a.call(performance, 'navigation')) === null || _b === void 0 ? void 0 : _b[0];
+    if (nav) {
+        if (nav.type === 'reload')
+            return 'reload';
+        if (nav.type === 'back_forward')
+            return 'back_forward';
+        return nav.type === 'navigate' ? 'initial_load' : undefined;
+    }
+    const legacy = performance.navigation;
+    if (legacy) {
+        if (legacy.type === 1)
+            return 'reload';
+        if (legacy.type === 2)
+            return 'back_forward';
+        return legacy.type === 0 ? 'initial_load' : undefined;
+    }
+    return undefined;
+}
+
 const CACHE_TTL_MS = 60 * 1000;
 const cache = new Map();
 function getCachedFrames(url) {
@@ -2831,7 +2880,7 @@ function observeUrlChanges(baseUrlMatch, onUrlChange) {
     patchHistoryMethod('replaceState');
 }
 
-function startSession(Coframe, cookiesEnabled, executionStartTime, personalizationHeaders) {
+function startSession(Coframe, cookiesEnabled, executionStartTime, personalizationHeaders, sessionContext) {
     const sessionPayload = [
         Coframe,
         Coframe.orgId,
@@ -2848,7 +2897,7 @@ function startSession(Coframe, cookiesEnabled, executionStartTime, personalizati
         getBrowserFignerprintInfo(),
     ];
     {
-        queueCreateSession(...sessionPayload, undefined, undefined, personalizationHeaders);
+        queueCreateSession(...sessionPayload, undefined, undefined, personalizationHeaders, sessionContext);
     }
     queueEvent(Coframe, {
         projectId: Coframe.projectId,
@@ -3026,22 +3075,39 @@ const ENGAGED_SESSION_THRESHOLD = 10000;
 function setupListeners(Coframe, executionStartTime) {
     const experiencedCoframeIds = new Set();
     let isEngaged = false;
-    function measureEngagement() {
-        const timeSpent = Date.now() - (executionStartTime ? executionStartTime.getTime() : 0);
-        if (!isEngaged && timeSpent >= ENGAGED_SESSION_THRESHOLD) {
-            isEngaged = true;
-            queueEvent(Coframe, {
-                projectId: Coframe.projectId,
-                sessionId: Coframe.sessionId,
-                eventType: 'session_start',
-                orgId: Coframe.orgId,
-                userToken: Coframe.userToken,
-                personalizationHeaders: Coframe.personalizationHeaders,
-            });
+    let engagementTimer = null;
+    function markEngaged() {
+        if (isEngaged)
+            return;
+        isEngaged = true;
+        if (engagementTimer !== null) {
+            clearTimeout(engagementTimer);
+            engagementTimer = null;
         }
-        else {
-            setTimeout(measureEngagement, ENGAGED_SESSION_THRESHOLD - timeSpent);
+        queueEvent(Coframe, {
+            projectId: Coframe.projectId,
+            sessionId: Coframe.sessionId,
+            eventType: 'session_start',
+            orgId: Coframe.orgId,
+            userToken: Coframe.userToken,
+            personalizationHeaders: Coframe.personalizationHeaders,
+        });
+    }
+    function scheduleEngagementMeasurement() {
+        if (isEngaged)
+            return;
+        const timeSpent = Date.now() - (executionStartTime ? executionStartTime.getTime() : 0);
+        const remaining = ENGAGED_SESSION_THRESHOLD - timeSpent;
+        if (remaining <= 0) {
+            markEngaged();
+            return;
         }
+        if (engagementTimer !== null)
+            return;
+        engagementTimer = setTimeout(() => {
+            engagementTimer = null;
+            scheduleEngagementMeasurement();
+        }, remaining);
     }
     function updateViewedVariants() {
         for (const variantElement of Coframe.variantsAndElements || []) {
@@ -3065,21 +3131,21 @@ function setupListeners(Coframe, executionStartTime) {
             }
         }
     }
-    document.addEventListener('visibilitychange', measureEngagement);
-    setTimeout(measureEngagement, ENGAGED_SESSION_THRESHOLD);
+    document.addEventListener('visibilitychange', scheduleEngagementMeasurement);
+    scheduleEngagementMeasurement();
     document.addEventListener('coframe:dom-renderer:complete', updateViewedVariants);
     document.addEventListener('scroll', updateViewedVariants);
     document.dispatchEvent(new CustomEvent('coframe:dom-renderer:complete', {}));
-    document.addEventListener('click', (event) => {
+    const handleClick = (event) => {
+        markEngaged();
         sendPageEngagementEvent(Coframe, 'click', event, {
             projectId: Coframe.projectId,
-            isEngaged,
             sessionId: Coframe.sessionId,
-            orgId: Coframe.orgId,
             userToken: Coframe.userToken,
             personalizationHeaders: Coframe.personalizationHeaders,
         });
-    }, true);
+    };
+    document.addEventListener('click', handleClick, true);
     const handleEventFlush = debounce((eventType) => {
         queueEvent(Coframe, {
             projectId: Coframe.projectId,
@@ -3278,6 +3344,7 @@ function createApplyVariants(Coframe, config, previewVariantId, isSessionVariant
     let isFirstApply = true;
     return async (pageUrl, pageProject) => {
         const sessionId = isFirstApply ? Coframe.sessionId : generateUUID();
+        const sessionContext = buildSessionContext(isFirstApply);
         isFirstApply = false;
         Coframe.sessionId = sessionId;
         const preview = resolvePreview(pageUrl, previewVariantId, isSessionVariant);
@@ -3301,7 +3368,7 @@ function createApplyVariants(Coframe, config, previewVariantId, isSessionVariant
         else {
             replaceVariants(variantsAndElements, Coframe.orgId, Coframe.logger, config.nonce);
         }
-        startSession(Coframe, isCookiesEnabled, executionStartTime, personalizationHeaders);
+        startSession(Coframe, isCookiesEnabled, executionStartTime, personalizationHeaders, sessionContext);
         analytics.resetBroadcasted();
         analytics.sendAnalytics();
     };

package/dist/pkg/cf.esm.mjs

@@ -179,6 +179,12 @@ function getBrowserPlatform() {
 function getBrowserReferrer() {
     return document.referrer;
 }
+function getScreenSize() {
+    return {
+        width: window.innerWidth,
+        height: window.innerHeight,
+    };
+}
 function getBrowserHostname() {
     return window.location.hostname;
 }
@@ -924,7 +930,7 @@ function warnEventsNotSent() {
     }
 }
 
-const SDK_VERSION = '2.5.0';
+const SDK_VERSION = '2.6.0';
 const queuedEvents = [];
 const queuedMonitoringEvents = [];
 const queuedSessions = [];
@@ -940,7 +946,7 @@ function queueEventForBatchedSending(coframe, data, flushImmediately = false) {
         flushQueuedEvents(coframe.projectId);
     }
 }
-function queueCreateSession(coframe, orgId, projectId, sessionId, userToken, experimentsInfo, startTime, referrer, platform, languages, userAgent, url, storageInfo, gaSessionInfo, cfId, personalizationHeaders) {
+function queueCreateSession(coframe, orgId, projectId, sessionId, userToken, experimentsInfo, startTime, referrer, platform, languages, userAgent, url, storageInfo, gaSessionInfo, cfId, personalizationHeaders, sessionContext) {
     queuedSessions.push({
         org_id: orgId,
         project_id: projectId,
@@ -958,6 +964,7 @@ function queueCreateSession(coframe, orgId, projectId, sessionId, userToken, exp
             session_metadata: JSON.stringify({
                 url,
                 storage_info: storageInfo,
+                ...sessionContext,
             }),
             ga_session_id: gaSessionInfo === null || gaSessionInfo === void 0 ? void 0 : gaSessionInfo.ga_session_id,
             ga_session_number: gaSessionInfo === null || gaSessionInfo === void 0 ? void 0 : gaSessionInfo.ga_session_number,
@@ -1026,20 +1033,9 @@ function queueVariantViewEvent(coframe, { projectId, sessionId, orgId, userToken
         user_token: userToken,
     });
 }
-function sendPageEngagementEvent(coframe, eventType, event, { isEngaged, projectId, sessionId, orgId, duration = 0, userToken, personalizationHeaders, }) {
+function sendPageEngagementEvent(coframe, eventType, event, { projectId, sessionId, duration = 0, userToken, personalizationHeaders, }) {
     var _a;
     const startTime = performance.now();
-    if (!isEngaged && eventType === 'click') {
-        isEngaged = true;
-        queueEvent(coframe, {
-            projectId,
-            sessionId,
-            eventType: 'session_start',
-            orgId,
-            userToken: userToken || '',
-            personalizationHeaders,
-        });
-    }
     const x = event.clientX + window.scrollX;
     const y = event.clientY + window.scrollY;
     const screenWidth = window.innerWidth;
@@ -2489,6 +2485,59 @@ async function getVariantsAndElements(personalizationHeaders, project, previewVa
     });
 }
 
+function buildSessionContext(isInitialApply) {
+    const context = {};
+    const viewport = getScreenSize();
+    if (isReportedSize(viewport.width) && isReportedSize(viewport.height)) {
+        context.viewport_width = viewport.width;
+        context.viewport_height = viewport.height;
+    }
+    const visitCount = getCookie(VISIT_COUNT_COOKIE_KEY);
+    if (/^[1-9]\d{0,14}$/.test(visitCount)) {
+        context.visit_count = Number(visitCount);
+    }
+    try {
+        context.navigation_type = getNavigationType(isInitialApply);
+    }
+    catch (_a) {
+    }
+    try {
+        const timezone = Intl.DateTimeFormat().resolvedOptions().timeZone;
+        if (timezone) {
+            context.timezone = timezone;
+        }
+    }
+    catch (_b) {
+    }
+    return context;
+}
+function isReportedSize(size) {
+    return (typeof size === 'number' && size > 0 && size !== Number.POSITIVE_INFINITY);
+}
+function getNavigationType(isInitialApply) {
+    var _a, _b;
+    if (!isInitialApply) {
+        return 'spa_navigation';
+    }
+    const nav = (_b = (_a = performance.getEntriesByType) === null || _a === void 0 ? void 0 : _a.call(performance, 'navigation')) === null || _b === void 0 ? void 0 : _b[0];
+    if (nav) {
+        if (nav.type === 'reload')
+            return 'reload';
+        if (nav.type === 'back_forward')
+            return 'back_forward';
+        return nav.type === 'navigate' ? 'initial_load' : undefined;
+    }
+    const legacy = performance.navigation;
+    if (legacy) {
+        if (legacy.type === 1)
+            return 'reload';
+        if (legacy.type === 2)
+            return 'back_forward';
+        return legacy.type === 0 ? 'initial_load' : undefined;
+    }
+    return undefined;
+}
+
 const CACHE_TTL_MS = 60 * 1000;
 const cache = new Map();
 function getCachedFrames(url) {
@@ -2829,7 +2878,7 @@ function observeUrlChanges(baseUrlMatch, onUrlChange) {
     patchHistoryMethod('replaceState');
 }
 
-function startSession(Coframe, cookiesEnabled, executionStartTime, personalizationHeaders) {
+function startSession(Coframe, cookiesEnabled, executionStartTime, personalizationHeaders, sessionContext) {
     const sessionPayload = [
         Coframe,
         Coframe.orgId,
@@ -2846,7 +2895,7 @@ function startSession(Coframe, cookiesEnabled, executionStartTime, personalizati
         getBrowserFignerprintInfo(),
     ];
     {
-        queueCreateSession(...sessionPayload, undefined, undefined, personalizationHeaders);
+        queueCreateSession(...sessionPayload, undefined, undefined, personalizationHeaders, sessionContext);
     }
     queueEvent(Coframe, {
         projectId: Coframe.projectId,
@@ -3024,22 +3073,39 @@ const ENGAGED_SESSION_THRESHOLD = 10000;
 function setupListeners(Coframe, executionStartTime) {
     const experiencedCoframeIds = new Set();
     let isEngaged = false;
-    function measureEngagement() {
-        const timeSpent = Date.now() - (executionStartTime ? executionStartTime.getTime() : 0);
-        if (!isEngaged && timeSpent >= ENGAGED_SESSION_THRESHOLD) {
-            isEngaged = true;
-            queueEvent(Coframe, {
-                projectId: Coframe.projectId,
-                sessionId: Coframe.sessionId,
-                eventType: 'session_start',
-                orgId: Coframe.orgId,
-                userToken: Coframe.userToken,
-                personalizationHeaders: Coframe.personalizationHeaders,
-            });
+    let engagementTimer = null;
+    function markEngaged() {
+        if (isEngaged)
+            return;
+        isEngaged = true;
+        if (engagementTimer !== null) {
+            clearTimeout(engagementTimer);
+            engagementTimer = null;
         }
-        else {
-            setTimeout(measureEngagement, ENGAGED_SESSION_THRESHOLD - timeSpent);
+        queueEvent(Coframe, {
+            projectId: Coframe.projectId,
+            sessionId: Coframe.sessionId,
+            eventType: 'session_start',
+            orgId: Coframe.orgId,
+            userToken: Coframe.userToken,
+            personalizationHeaders: Coframe.personalizationHeaders,
+        });
+    }
+    function scheduleEngagementMeasurement() {
+        if (isEngaged)
+            return;
+        const timeSpent = Date.now() - (executionStartTime ? executionStartTime.getTime() : 0);
+        const remaining = ENGAGED_SESSION_THRESHOLD - timeSpent;
+        if (remaining <= 0) {
+            markEngaged();
+            return;
         }
+        if (engagementTimer !== null)
+            return;
+        engagementTimer = setTimeout(() => {
+            engagementTimer = null;
+            scheduleEngagementMeasurement();
+        }, remaining);
     }
     function updateViewedVariants() {
         for (const variantElement of Coframe.variantsAndElements || []) {
@@ -3063,21 +3129,21 @@ function setupListeners(Coframe, executionStartTime) {
             }
         }
     }
-    document.addEventListener('visibilitychange', measureEngagement);
-    setTimeout(measureEngagement, ENGAGED_SESSION_THRESHOLD);
+    document.addEventListener('visibilitychange', scheduleEngagementMeasurement);
+    scheduleEngagementMeasurement();
     document.addEventListener('coframe:dom-renderer:complete', updateViewedVariants);
     document.addEventListener('scroll', updateViewedVariants);
     document.dispatchEvent(new CustomEvent('coframe:dom-renderer:complete', {}));
-    document.addEventListener('click', (event) => {
+    const handleClick = (event) => {
+        markEngaged();
         sendPageEngagementEvent(Coframe, 'click', event, {
             projectId: Coframe.projectId,
-            isEngaged,
             sessionId: Coframe.sessionId,
-            orgId: Coframe.orgId,
             userToken: Coframe.userToken,
             personalizationHeaders: Coframe.personalizationHeaders,
         });
-    }, true);
+    };
+    document.addEventListener('click', handleClick, true);
     const handleEventFlush = debounce((eventType) => {
         queueEvent(Coframe, {
             projectId: Coframe.projectId,
@@ -3276,6 +3342,7 @@ function createApplyVariants(Coframe, config, previewVariantId, isSessionVariant
     let isFirstApply = true;
     return async (pageUrl, pageProject) => {
         const sessionId = isFirstApply ? Coframe.sessionId : generateUUID();
+        const sessionContext = buildSessionContext(isFirstApply);
         isFirstApply = false;
         Coframe.sessionId = sessionId;
         const preview = resolvePreview(pageUrl, previewVariantId, isSessionVariant);
@@ -3299,7 +3366,7 @@ function createApplyVariants(Coframe, config, previewVariantId, isSessionVariant
         else {
             replaceVariants(variantsAndElements, Coframe.orgId, Coframe.logger, config.nonce);
         }
-        startSession(Coframe, isCookiesEnabled, executionStartTime, personalizationHeaders);
+        startSession(Coframe, isCookiesEnabled, executionStartTime, personalizationHeaders, sessionContext);
         analytics.resetBroadcasted();
         analytics.sendAnalytics();
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coframe/sdk",
-  "version": "1.1.7",
+  "version": "1.1.9",
   "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",
@@ -28,6 +28,7 @@
   "scripts": {
     "test:jest": "jest --maxWorkers=2",
     "test:playwright": "npx playwright test --retries=5 --reporter=list",
+    "test:package": "node ./tests/package/scripts/test-package.mjs",
     "test:browserstack:full": "jest --config jest.browserstack.config.js --suite=full",
     "test:browserstack:small": "jest --config jest.browserstack.config.js --suite=small",
     "test": "npm run test:jest && npm run test:playwright",