@salesforcedevs/docs-components 1.30.1-locale-picker → 1.30.1-locale-picker-2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforcedevs/docs-components",
-  "version": "1.30.1-locale-picker",
+  "version": "1.30.1-locale-picker-2",
   "description": "Docs Lightning web components for DSC",
   "license": "MIT",
   "main": "index.js",

package/src/modules/doc/redocReference/redocReference.ts

@@ -41,6 +41,7 @@ const SCROLL_THROTTLE_DELAY = 50;
 const ELEMENT_TIMEOUT = 10000;
 const ELEMENT_CHECK_INTERVAL = 100;
 const DEFAULT_PROJECT_TITLE = "All Reference";
+const BACK_TARGET_STORAGE_KEY = "redoc-back-target";
 
 export default class RedocReference extends LightningElement {
     private _referenceConfig: ReferenceConfig = { refList: [] };
@@ -51,7 +52,6 @@ export default class RedocReference extends LightningElement {
     private docPhaseWrapperElement: Element | null = null;
     private lastSidebarTop = 0;
     private _languages: OptionWithLink[] = [];
-    private langValuePath: string = "id";
 
     /**
      * History length captured at mount (pre-Redoc), used by `onBackClick` to
@@ -131,7 +131,6 @@ export default class RedocReference extends LightningElement {
         this._languages = toJson(value) || [];
     }
 
-    /** Currently selected locale, matched against `langValuePath`. */
     @api language: string | null = null;
 
     get specTitle(): string | null {
@@ -151,12 +150,20 @@ export default class RedocReference extends LightningElement {
         return refCount > 1;
     }
 
+    // Reads stored back target
+    private getBackTargetFromSession(): string | null {
+        return sessionStorage.getItem(BACK_TARGET_STORAGE_KEY);
+    }
+
+    private setBackTargetInSession(href: string): void {
+        sessionStorage.setItem(BACK_TARGET_STORAGE_KEY, href);
+    }
+
     /**
-     * Only for the docs content type and when more than one localized
-     * spec is available
+     * when more than one localized spec is available
      */
     get hasLocalePicker(): boolean {
-        return this.isDocContentType && this.languages.length > 1;
+        return this.languages.length > 1;
     }
 
     /**
@@ -176,14 +183,66 @@ export default class RedocReference extends LightningElement {
      */
     private onBackClick = (event: Event): void => {
         event.preventDefault();
-        const referrerHref = this.getSameOriginReferrerHref();
-        if (referrerHref) {
-            window.location.href = referrerHref;
-        } else if (this.headerHref) {
-            window.location.href = this.headerHref;
+
+        const target = this.getTranslatedBackTarget() ?? this.headerHref;
+
+        if (target) {
+            window.location.assign(target);
         }
     };
 
+    private getTranslatedBackTarget(): string | null {
+        const stored = this.getBackTargetFromSession();
+        if (stored) {
+            return this.language
+                ? this.translateToCurrentLocale(stored)
+                : stored;
+        }
+
+        const referrer = this.getSameOriginReferrerHref();
+        return referrer && !this.isLocaleHref(new URL(referrer).pathname)
+            ? referrer
+            : null;
+    }
+
+    /* Rewrites the stored URL's locale to the current one. Paths are
+     * /docs/locale/.., except the default en-us which has no locale segment.
+     */
+    private translateToCurrentLocale(storedHref: string): string {
+        const url = new URL(storedHref, window.location.origin);
+        const localeIds = this.languages.map((loc) => loc.id);
+        const segments = url.pathname.split("/").filter(Boolean);
+
+        if (segments[0] === "docs") {
+            // Drop the existing locale segment, if any
+            if (localeIds.includes(segments[1])) {
+                segments.splice(1, 1);
+            }
+            // Add the current locale
+            if (this.language && this.language !== "en-us") {
+                segments.splice(1, 0, this.language);
+            }
+        }
+
+        url.pathname = "/" + segments.join("/");
+        return url.href;
+    }
+
+    // Preserves target across locale switches, updates on normal navigation
+    private trackBackTarget(): void {
+        const referrerHref = this.getSameOriginReferrerHref();
+        if (!referrerHref) {
+            return;
+        }
+
+        const referrerUrl = new URL(referrerHref);
+        if (this.isLocaleHref(referrerUrl.pathname)) {
+            return;
+        }
+
+        this.setBackTargetInSession(referrerHref);
+    }
+
     /**
      * Returns the referrer URL when the page was reached via in-tab navigation
      * from a same-origin page; otherwise `null`. Both `initialHistoryLength`
@@ -205,6 +264,19 @@ export default class RedocReference extends LightningElement {
         }
     }
 
+    /**
+     * switching locale on this same page.
+     */
+    private isLocaleHref(pathname: string): boolean {
+        return this.languages.some((locale) => {
+            const href = locale?.link?.href;
+            return (
+                !!href &&
+                new URL(href, window.location.origin).pathname === pathname
+            );
+        });
+    }
+
     /** When origin is provided, pass it to the footer; otherwise use dx-footer's default. */
     get effectiveFooterOrigin(): string {
         return (
@@ -217,6 +289,9 @@ export default class RedocReference extends LightningElement {
         // so it reflects real in-tab navigation rather than Redoc's churn.
         this.initialHistoryLength = window.history.length;
 
+        // Track the back target, preserving it across locale switches
+        this.trackBackTarget();
+
         window.addEventListener("scroll", this.handleScrollAndResize);
         window.addEventListener("resize", this.handleScrollAndResize);
     }
@@ -443,7 +518,7 @@ export default class RedocReference extends LightningElement {
             this.appendFooterItems(apiContentDiv);
 
             // Inject the multi-spec project header into Redoc's left menu only.
-            this.insertProjectHeaderInMenu(redocContainer);
+            this.insertSidebarNav(redocContainer);
 
             // Wait for footer to be rendered before updating styles
             requestAnimationFrame(() => {
@@ -460,7 +535,7 @@ export default class RedocReference extends LightningElement {
     /**
      * Inserts the project header into Redoc for multi-spec reference sets.
      */
-    private insertProjectHeaderInMenu(redocContainer: HTMLElement): void {
+    private insertSidebarNav(redocContainer: HTMLElement): void {
         if (!this.showRedocHeader) {
             return;
         }
@@ -495,8 +570,7 @@ export default class RedocReference extends LightningElement {
 
         Object.assign(picker, {
             languages: this.languages,
-            language: this.language,
-            langValuePath: this.langValuePath
+            language: this.language
         });
         wrapper.appendChild(picker);