@salesforcedevs/dx-components 1.34.0 → 1.35.1

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/dx-components",
-    "version": "1.34.0",
+    "version": "1.35.1",
     "description": "DX Lightning web components",
     "license": "MIT",
     "engines": {
@@ -44,5 +44,5 @@
         "luxon": "3.4.4",
         "msw": "^2.12.4"
     },
-    "gitHead": "5d072e2fa81d7eccadcbfb4134ee007ce2b0c7c4"
+    "gitHead": "0112829c264018cab7536554f5984faa2fc5c4f5"
 }

package/src/modules/dx/agentMiawUi/agentMiawUi.ts

@@ -57,6 +57,24 @@ function loadMiawUiScript(): Promise<void> {
     return scriptLoaded;
 }
 
+function dropCookie(cookieDomain: string) {
+    const { hostname, protocol } = window.location;
+    const onCookieDomain =
+        !!cookieDomain &&
+        (hostname === cookieDomain || hostname.endsWith(`.${cookieDomain}`));
+
+    document.cookie = [
+        "show_agent=true",
+        "Path=/",
+        "Max-Age=2592000",
+        "SameSite=Lax",
+        protocol === "https:" ? "Secure" : null,
+        onCookieDomain ? `Domain=${cookieDomain}` : null
+    ]
+        .filter(Boolean)
+        .join("; ");
+}
+
 export default class AgentMiawUi extends LightningElement {
     private static readonly SIDEBAR_OPEN_ATTR = "data-xsf-agent-sidebar-open";
     private static readonly AGENT_ROOT_SELECTOR = '[data-testid="agent-root"]';
@@ -78,6 +96,38 @@ export default class AgentMiawUi extends LightningElement {
     /** When set, forwarded to the embed as `welcome-text` (greeting / headline copy). */
     @api welcomeText?: string;
     @api agentforceEnv?: string;
+    private _hideAgentConditionally = false;
+
+    /**
+     * When set, mounting of the agent is gated behind the `showAgent=true` query param
+     * or `show_agent=true` cookie opt-in; otherwise (and by default), gating is off.
+     *
+     * COERCION: this component is consumed as raw, server-rendered HTML on an LWR page —
+     * not inside another LWC's template — so LWC's presence→boolean attribute convention
+     * does NOT apply automatically. Native attribute reflection runs instead, and LWC's
+     * attributeChangedCallback assigns the raw attribute STRING to this property
+     * (`this[prop] = newValue`), so a bare `hide-agent-conditionally` arrives as `""`, not
+     * boolean `true`. This setter restores HTML boolean-attribute semantics by source:
+     *   - boolean (LWC property API / tests): honored as-is, so `false` turns gating off.
+     *   - string (native attribute reflection): PRESENCE means true regardless of value —
+     *     `""`, `"true"`, and even `"false"` all enable gating, exactly like `disabled="false"`
+     *     is still disabled. Only absence (null/undefined, i.e. the attribute removed) is false.
+     */
+    @api
+    get hideAgentConditionally(): boolean {
+        return this._hideAgentConditionally;
+    }
+    set hideAgentConditionally(value: boolean | string | null | undefined) {
+        this._hideAgentConditionally =
+            typeof value === "boolean"
+                ? value
+                : value !== null && value !== undefined;
+    }
+    /**
+     * Apex domain that the opt-in cookie targets (covers subdomains); applied only when the
+     * current host matches it, so local dev / preview hosts fall back to a host-only cookie.
+     */
+    @api cookieDomain?: string;
 
     /** After first mount attempt is scheduled, we do not run it again for this instance. */
     private hasRendered = false;
@@ -87,7 +137,9 @@ export default class AgentMiawUi extends LightningElement {
     renderedCallback(): void {
         if (!this.hasRendered) {
             this.hasRendered = true;
-            this.mountMiawHost();
+            if (this.shouldMount()) {
+                this.mountMiawHost();
+            }
         }
     }
 
@@ -96,6 +148,39 @@ export default class AgentMiawUi extends LightningElement {
         this.sidebarStateObserver = null;
     }
 
+    /**
+     * Decide whether the agent should mount. If conditional gating is off, always mount.
+     * If conditional gating of the agent is on, return `true` only when the user has opted in
+     * via the `showAgent=true` query param or the `show_agent=true` cookie. (When only the
+     * param is present, persists a sticky opt-in cookie (~30 days) as a side effect so the
+     * choice carries across pages and subdomains.)
+     *
+     * CROSS-SITE CONTRACT: the param key/value, cookie token, Max-Age, SameSite, Secure and
+     * Domain-scoping logic are MIRRORED in architect-sf, since both serve pages for Architect.
+     * Changing these values requires a coordinated change in all repos.
+     */
+    private shouldMount(): boolean {
+        if (!this.hideAgentConditionally) {
+            return true;
+        }
+
+        // When the agent should be conditionally hidden, we check for special query param or
+        // cookie required for actually mounting/rendering it.
+        const hasParam =
+            new URLSearchParams(window.location.search).get("showAgent") ===
+            "true";
+        const hasCookie = /(?:^|;\s*)show_agent=true(?:;|$)/.test(
+            document.cookie
+        );
+
+        // If the user doesn't have the cookie yet but does have the param, set the cookie
+        if (hasParam && !hasCookie) {
+            dropCookie(this.cookieDomain || "");
+        }
+
+        return hasParam || hasCookie;
+    }
+
     private async mountMiawHost(): Promise<void> {
         try {
             await loadMiawUiScript();
@@ -114,10 +199,7 @@ export default class AgentMiawUi extends LightningElement {
                 this.richComponentVersion
             );
             if (this.routingAttributes) {
-                el.setAttribute(
-                    "routing-attributes",
-                    this.routingAttributes
-                );
+                el.setAttribute("routing-attributes", this.routingAttributes);
             }
             if (this.prompts) {
                 el.setAttribute("prompts", this.prompts);
@@ -134,7 +216,9 @@ export default class AgentMiawUi extends LightningElement {
     }
 
     private setSidebarOpenState(isOpen: boolean): void {
-        const targets = document.querySelectorAll(this.sidebarStateTargetSelector);
+        const targets = document.querySelectorAll(
+            this.sidebarStateTargetSelector
+        );
         targets.forEach((target) => {
             target.setAttribute(
                 AgentMiawUi.SIDEBAR_OPEN_ATTR,