@salesforcedevs/docs-components 1.27.22-banner6 → 1.27.22-banner9

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "1.27.22-banner6",
+    "version": "1.27.22-banner9",
     "description": "Docs Lightning web components for DSC",
     "license": "MIT",
     "main": "index.js",
@@ -25,5 +25,5 @@
         "@types/lodash.orderby": "4.6.9",
         "@types/lodash.uniqby": "4.7.9"
     },
-    "gitHead": "9e6a595bc97fb7be304852d8cf4d88d1afbb3f6b"
+    "gitHead": "6bfe41efab500f95128e0dd50057065992d724ad"
 }

package/src/modules/doc/banner/banner.ts

@@ -2,7 +2,6 @@ import { LightningElement, api, track } from "lwc";
 import { normalizeBoolean } from "dxUtils/normalizers";
 
 const LOCALE_BANNER_STORAGE_PREFIX = "dsc-doc-locale-banner-dismissed-";
-const BANNER_DEBUG_PREFIX = "[doc-banner]";
 
 export default class Banner extends LightningElement {
     @api messageText = "";
@@ -32,33 +31,15 @@ export default class Banner extends LightningElement {
     @track private _dismissed = false;
 
     connectedCallback() {
-        if (typeof window === "undefined") {
-            return;
-        }
-        const storageKey = this.dismissStorageKey
-            ? `${LOCALE_BANNER_STORAGE_PREFIX}${this.dismissStorageKey}`
-            : "";
-        if (this.dismissStorageKey && window.sessionStorage) {
-            const stored = window.sessionStorage.getItem(storageKey);
-            this._dismissed = stored === "true";
-            console.debug(BANNER_DEBUG_PREFIX, "visibility check", {
-                dismissStorageKey: this.dismissStorageKey,
-                storageKey,
-                sessionStorageValue: stored,
-                dismissed: this._dismissed,
-                bannerWillShow: !this._dismissed,
-                reason: this._dismissed
-                    ? "User dismissed in this session (Not Now / close)"
-                    : "Not dismissed; banner will show"
-            });
-        } else {
-            console.debug(BANNER_DEBUG_PREFIX, "visibility check", {
-                dismissStorageKey: this.dismissStorageKey || "(empty)",
-                bannerWillShow: true,
-                reason: !this.dismissStorageKey
-                    ? "No dismiss key: banner always shown by component (if theme rendered it)"
-                    : "sessionStorage not available"
-            });
+        if (
+            this.dismissStorageKey &&
+            typeof window !== "undefined" &&
+            window.sessionStorage
+        ) {
+            this._dismissed =
+                window.sessionStorage.getItem(
+                    `${LOCALE_BANNER_STORAGE_PREFIX}${this.dismissStorageKey}`
+                ) === "true";
         }
     }
 

package/src/modules/doc/xmlContent/xmlContent.html

@@ -17,7 +17,7 @@
     >
         <doc-banner
             slot="locale-banner"
-            lwc:if={showLocaleBanner}
+            lwc:if={showLocaleBannerInSlot}
             message-text="This text was translated using Salesforce's machine translation system. More details can be found "
             message-link-url="https://help.salesforce.com/s/articleView?id=sf.machine_translation.htm"
             message-link-text="here"

package/src/modules/doc/xmlContent/xmlContent.ts

@@ -80,6 +80,7 @@ export default class DocXmlContent extends LightningElementWithState<{
     private docTitle = "";
     private _pathName = "";
     private listenerAttached = false;
+    private _xmlLocaleBannerDispatched = false;
     private sidebarFooterContent: SiderbarFooter = { ...defaultSidebarFooter };
     private latestVersion = false;
     private previewVersion = false;
@@ -221,6 +222,16 @@ export default class DocXmlContent extends LightningElementWithState<{
             this.setState({ internalLinkClicked: false });
         }
 
+        if (
+            this.displayContent &&
+            !normalizeBoolean(this.localeBannerEnabled) &&
+            this.shouldShowLocaleBanner &&
+            !this._xmlLocaleBannerDispatched
+        ) {
+            this._xmlLocaleBannerDispatched = true;
+            this.injectLocaleBannerIntoThemeHost();
+        }
+
         if (
             (this.prevState.isFetchingContent &&
                 !this.state.isFetchingContent) ||
@@ -257,10 +268,14 @@ export default class DocXmlContent extends LightningElementWithState<{
         return this.pageReference.deliverable;
     }
 
-    private get showLocaleBanner(): boolean {
-        if (!normalizeBoolean(this.localeBannerEnabled)) {
-            return false;
-        }
+    private get showLocaleBannerInSlot(): boolean {
+        return (
+            normalizeBoolean(this.localeBannerEnabled) &&
+            this.shouldShowLocaleBanner
+        );
+    }
+
+    private get shouldShowLocaleBanner(): boolean {
         if (!this.pageReference?.deliverable) {
             return false;
         }
@@ -289,6 +304,45 @@ export default class DocXmlContent extends LightningElementWithState<{
         });
     }
 
+    private injectLocaleBannerIntoThemeHost(retry = false): void {
+        if (typeof document === "undefined") {
+            return;
+        }
+        const host = document.getElementById("doc-xml-locale-banner-host");
+        if (!host) {
+            if (!retry) {
+                setTimeout(
+                    () => this.injectLocaleBannerIntoThemeHost(true),
+                    100
+                );
+            }
+            return;
+        }
+        if (host.hasChildNodes()) {
+            return;
+        }
+        const banner = document.createElement("doc-banner");
+        banner.setAttribute(
+            "message-text",
+            "This text was translated using Salesforce's machine translation system. More details can be found "
+        );
+        banner.setAttribute(
+            "message-link-url",
+            "https://help.salesforce.com/s/articleView?id=sf.machine_translation.htm"
+        );
+        banner.setAttribute("message-link-text", "here");
+        banner.setAttribute("button-label", "Switch to English");
+        banner.setAttribute("button-href", this.localeBannerEnUsHref);
+        banner.setAttribute("secondary-label", "Not Now");
+        banner.setAttribute("show-close-button", "true");
+        banner.setAttribute(
+            "dismiss-storage-key",
+            this.deliverable || "default"
+        );
+        host.setAttribute("aria-hidden", "false");
+        host.appendChild(banner);
+    }
+
     private get useOldSidebar(): boolean {
         // Coveo is enabled and the version is greater than  51 (within the latest 3 versions)
         // TODO: we need a better fix for version number check