@coframe/sdk 1.1.11 → 1.1.13

package/README.md

@@ -49,9 +49,10 @@ installations:
 - `coframe_variant_id` previews one or more comma-separated variant IDs.
 - `coframe_should_send_events=true` allows events during preview for testing.
 
-When `enableDebug: true` is set for the project, open the Launcher with
-`cf_debug=true` and use **Keep across navigation** in the Preview Session
-tool to keep the selected variants active for the current tab.
+Debug tools are allowed by default. Open the Launcher with `cf_preview=true` and
+use **Keep across navigation** in the Preview Session tool to keep the selected
+variants active for the current tab. Set `enableDebug: false` to prevent URL or
+saved session state from loading the Launcher.
 
 For SSR, pass the complete request URL, including its query string, as
 `currentUrl`. This is required for query-sensitive targeting and allows

package/dist/pkg/cf.cjs.js

@@ -900,7 +900,16 @@ function getUrlSearchParams(url) {
     return createURLSearchParams(search);
 }
 
-const COFRAME_DEBUG_QUERY_PARAM = 'cf_debug';
+const COFRAME_TOOL_QUERY_PARAM = 'cf_tool';
+const COFRAME_DEV_TOOL_QUERY_PARAM = 'cf_devtool';
+const COFRAME_ANNOTATION_QUERY_PARAM = 'cf_annotation';
+const COFRAME_PREVIEW_QUERY_PARAM = 'cf_preview';
+const COFRAME_TOOL_QUERY_PARAMS = [
+    COFRAME_TOOL_QUERY_PARAM,
+    COFRAME_DEV_TOOL_QUERY_PARAM,
+    COFRAME_ANNOTATION_QUERY_PARAM,
+    COFRAME_PREVIEW_QUERY_PARAM,
+];
 const COFRAME_TOOL_INTERACTION_ATTRIBUTE = 'data-cf-t';
 const COFRAME_DEBUG_TOOLS_SESSION_STORAGE_KEY = 'cf.tools.enabled';
 const COFRAME_DEBUG_TOOLS_STATE_STORAGE_KEY = 'cf.tools.session';
@@ -920,13 +929,56 @@ function clearDebugToolsSession() {
     catch (_a) {
     }
 }
+function resolveDebugToolsEntry(url = getCurrentPageUrl()) {
+    const params = getUrlSearchParams(url);
+    const directTools = [];
+    if (params.get(COFRAME_DEV_TOOL_QUERY_PARAM) === ENABLED_VALUE) {
+        directTools.push('dev-tool');
+    }
+    if (params.get(COFRAME_PREVIEW_QUERY_PARAM) === ENABLED_VALUE) {
+        directTools.push('preview-ui');
+    }
+    if (params.get(COFRAME_ANNOTATION_QUERY_PARAM) === ENABLED_VALUE) {
+        directTools.push('annotations');
+    }
+    if (directTools.length > 1) {
+        return { kind: 'conflict', toolIds: directTools };
+    }
+    if (directTools.length === 1) {
+        return { kind: 'tool', toolId: directTools[0] };
+    }
+    if (params.get(COFRAME_TOOL_QUERY_PARAM) === ENABLED_VALUE) {
+        return { kind: 'launcher' };
+    }
+    return { kind: 'none' };
+}
+function removeDebugToolsEntryParams(url) {
+    const hashIndex = url.indexOf('#');
+    const hash = hashIndex === -1 ? '' : url.slice(hashIndex);
+    const withoutHash = hashIndex === -1 ? url : url.slice(0, hashIndex);
+    const queryIndex = withoutHash.indexOf('?');
+    if (queryIndex === -1)
+        return url;
+    const base = withoutHash.slice(0, queryIndex);
+    const query = withoutHash.slice(queryIndex + 1);
+    const filtered = query.split('&').filter((pair) => {
+        const rawKey = pair.split('=', 1)[0];
+        let key = rawKey;
+        try {
+            key = decodeURIComponent(rawKey);
+        }
+        catch (_a) {
+        }
+        return !COFRAME_TOOL_QUERY_PARAMS.includes(key);
+    });
+    return `${base}${filtered.length ? `?${filtered.join('&')}` : ''}${hash}`;
+}
 function isDebugToolsSessionEnabled(allowed) {
     if (!allowed) {
         clearDebugToolsSession();
         return false;
     }
-    const enabledByUrl = getUrlSearchParams(getCurrentPageUrl()).get(COFRAME_DEBUG_QUERY_PARAM) ===
-        ENABLED_VALUE;
+    const enabledByUrl = resolveDebugToolsEntry().kind !== 'none';
     if (enabledByUrl) {
         enableDebugToolsSession();
         return true;
@@ -3464,9 +3516,7 @@ function getLauncher() {
 }
 function exitDebugSession() {
     clearDebugToolsSession();
-    const url = new URL(window.location.href);
-    url.searchParams.delete(COFRAME_DEBUG_QUERY_PARAM);
-    window.history.replaceState(window.history.state, '', url);
+    window.history.replaceState(window.history.state, '', removeDebugToolsEntryParams(window.location.href));
 }
 function mountLauncher(nonce) {
     const launcher = getLauncher();
@@ -3475,7 +3525,7 @@ function mountLauncher(nonce) {
     launcher.mount({ nonce, onExitDebugSession: exitDebugSession });
     return true;
 }
-function loadLauncherIfEnabled(enabled, nonce) {
+function loadLauncherIfEnabled(enabled = true, nonce) {
     if (typeof window === 'undefined')
         return;
     let sessionEnabled = false;
@@ -3592,7 +3642,7 @@ async function init(options) {
     const configResult = await resolveConfig(Coframe, revealPage);
     if (!configResult)
         return;
-    loadLauncherIfEnabled(configResult.config.enableDebug === true, configResult.config.nonce);
+    loadLauncherIfEnabled(configResult.config.enableDebug, configResult.config.nonce);
     const projectResult = await resolveProject(Coframe, configResult.previewVariantId, configResult.isSessionVariant, configResult.config);
     if (!projectResult)
         return;

package/dist/pkg/cf.esm.mjs

@@ -898,7 +898,16 @@ function getUrlSearchParams(url) {
     return createURLSearchParams(search);
 }
 
-const COFRAME_DEBUG_QUERY_PARAM = 'cf_debug';
+const COFRAME_TOOL_QUERY_PARAM = 'cf_tool';
+const COFRAME_DEV_TOOL_QUERY_PARAM = 'cf_devtool';
+const COFRAME_ANNOTATION_QUERY_PARAM = 'cf_annotation';
+const COFRAME_PREVIEW_QUERY_PARAM = 'cf_preview';
+const COFRAME_TOOL_QUERY_PARAMS = [
+    COFRAME_TOOL_QUERY_PARAM,
+    COFRAME_DEV_TOOL_QUERY_PARAM,
+    COFRAME_ANNOTATION_QUERY_PARAM,
+    COFRAME_PREVIEW_QUERY_PARAM,
+];
 const COFRAME_TOOL_INTERACTION_ATTRIBUTE = 'data-cf-t';
 const COFRAME_DEBUG_TOOLS_SESSION_STORAGE_KEY = 'cf.tools.enabled';
 const COFRAME_DEBUG_TOOLS_STATE_STORAGE_KEY = 'cf.tools.session';
@@ -918,13 +927,56 @@ function clearDebugToolsSession() {
     catch (_a) {
     }
 }
+function resolveDebugToolsEntry(url = getCurrentPageUrl()) {
+    const params = getUrlSearchParams(url);
+    const directTools = [];
+    if (params.get(COFRAME_DEV_TOOL_QUERY_PARAM) === ENABLED_VALUE) {
+        directTools.push('dev-tool');
+    }
+    if (params.get(COFRAME_PREVIEW_QUERY_PARAM) === ENABLED_VALUE) {
+        directTools.push('preview-ui');
+    }
+    if (params.get(COFRAME_ANNOTATION_QUERY_PARAM) === ENABLED_VALUE) {
+        directTools.push('annotations');
+    }
+    if (directTools.length > 1) {
+        return { kind: 'conflict', toolIds: directTools };
+    }
+    if (directTools.length === 1) {
+        return { kind: 'tool', toolId: directTools[0] };
+    }
+    if (params.get(COFRAME_TOOL_QUERY_PARAM) === ENABLED_VALUE) {
+        return { kind: 'launcher' };
+    }
+    return { kind: 'none' };
+}
+function removeDebugToolsEntryParams(url) {
+    const hashIndex = url.indexOf('#');
+    const hash = hashIndex === -1 ? '' : url.slice(hashIndex);
+    const withoutHash = hashIndex === -1 ? url : url.slice(0, hashIndex);
+    const queryIndex = withoutHash.indexOf('?');
+    if (queryIndex === -1)
+        return url;
+    const base = withoutHash.slice(0, queryIndex);
+    const query = withoutHash.slice(queryIndex + 1);
+    const filtered = query.split('&').filter((pair) => {
+        const rawKey = pair.split('=', 1)[0];
+        let key = rawKey;
+        try {
+            key = decodeURIComponent(rawKey);
+        }
+        catch (_a) {
+        }
+        return !COFRAME_TOOL_QUERY_PARAMS.includes(key);
+    });
+    return `${base}${filtered.length ? `?${filtered.join('&')}` : ''}${hash}`;
+}
 function isDebugToolsSessionEnabled(allowed) {
     if (!allowed) {
         clearDebugToolsSession();
         return false;
     }
-    const enabledByUrl = getUrlSearchParams(getCurrentPageUrl()).get(COFRAME_DEBUG_QUERY_PARAM) ===
-        ENABLED_VALUE;
+    const enabledByUrl = resolveDebugToolsEntry().kind !== 'none';
     if (enabledByUrl) {
         enableDebugToolsSession();
         return true;
@@ -3462,9 +3514,7 @@ function getLauncher() {
 }
 function exitDebugSession() {
     clearDebugToolsSession();
-    const url = new URL(window.location.href);
-    url.searchParams.delete(COFRAME_DEBUG_QUERY_PARAM);
-    window.history.replaceState(window.history.state, '', url);
+    window.history.replaceState(window.history.state, '', removeDebugToolsEntryParams(window.location.href));
 }
 function mountLauncher(nonce) {
     const launcher = getLauncher();
@@ -3473,7 +3523,7 @@ function mountLauncher(nonce) {
     launcher.mount({ nonce, onExitDebugSession: exitDebugSession });
     return true;
 }
-function loadLauncherIfEnabled(enabled, nonce) {
+function loadLauncherIfEnabled(enabled = true, nonce) {
     if (typeof window === 'undefined')
         return;
     let sessionEnabled = false;
@@ -3590,7 +3640,7 @@ async function init(options) {
     const configResult = await resolveConfig(Coframe, revealPage);
     if (!configResult)
         return;
-    loadLauncherIfEnabled(configResult.config.enableDebug === true, configResult.config.nonce);
+    loadLauncherIfEnabled(configResult.config.enableDebug, configResult.config.nonce);
     const projectResult = await resolveProject(Coframe, configResult.previewVariantId, configResult.isSessionVariant, configResult.config);
     if (!projectResult)
         return;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coframe/sdk",
-  "version": "1.1.11",
+  "version": "1.1.13",
   "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",