@salesforcedevs/docs-components 1.29.0-alpha1 → 1.29.0-docspec-alpha

package/src/modules/doc/lwcContentLayout/lwcContentLayout.html

@@ -41,7 +41,7 @@
                                 ></path>
                             </g>
                         </svg>
-                        {readingTime} minute read
+                        {readingTimeLabel}
                     </div>
                     <slot onslotchange={onSlotChange}></slot>
                     <doc-sprig-survey
@@ -57,7 +57,10 @@
                 </div>
             </div>
             <div lwc:if={showFooter} class="footer-container">
-                <dx-footer variant="no-signup" mfe-config-origin={effectiveFooterOrigin}></dx-footer>
+                <dx-footer
+                    variant="no-signup"
+                    mfe-config-origin={effectiveFooterOrigin}
+                ></dx-footer>
             </div>
         </div>
     </div>

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

@@ -2,12 +2,11 @@
 import { createElement, LightningElement, api } from "lwc";
 import DocPhase from "doc/phase";
 import DxFooter from "dx/footer";
+import DxIcon from "dx/icon";
 import SprigSurvey from "doc/sprigSurvey";
-import ApiPlayground from "doc/apiPlayground";
 import { throttle } from "throttle-debounce";
 import { pollUntil } from "dxUtils/async";
-import { parseOpenApiSpec } from "docUtils/openApiParser";
-import type { OperationDefinition } from "docUtils/openApiParser";
+import { normalizeBoolean } from "dxUtils/normalizers";
 
 declare global {
     interface Window {
@@ -17,11 +16,19 @@ declare global {
 
 declare const Sprig: (eventType: string, eventName: string) => void;
 
+type ReferenceTopic = {
+    link?: { href?: string };
+    children?: ReferenceTopic[];
+};
+
 type ReferenceItem = {
     source: string;
     href: string;
+    title?: string;
     isSelected?: boolean;
     docPhase?: string | null;
+    referenceType?: string;
+    topic?: ReferenceTopic;
 };
 
 type ReferenceConfig = {
@@ -31,6 +38,7 @@ type ReferenceConfig = {
 const SCROLL_THROTTLE_DELAY = 50;
 const ELEMENT_TIMEOUT = 10000;
 const ELEMENT_CHECK_INTERVAL = 100;
+const REFERENCES_SEGMENT = "/references/";
 
 export default class RedocReference extends LightningElement {
     private _referenceConfig: ReferenceConfig = { refList: [] };
@@ -41,11 +49,13 @@ export default class RedocReference extends LightningElement {
     private docPhaseWrapperElement: Element | null = null;
     private lastSidebarTop = 0;
 
-    showError = false;
+    /**
+     * History length captured at mount (pre-Redoc), used by `onBackClick` to
+     * distinguish in-tab navigation (> 1) from a fresh entry (=== 1).
+     */
+    private initialHistoryLength = 0;
 
-    private parsedOperations: OperationDefinition[] = [];
-    private openApiSpec: any = null;
-    private playgroundInstances: Map<string, HTMLElement> = new Map();
+    showError = false;
 
     @api
     get referenceConfig(): ReferenceConfig {
@@ -78,6 +88,100 @@ export default class RedocReference extends LightningElement {
     /** Optional origin URL for the footer MFE (e.g. wp-json endpoint). Passed through to dx-footer. */
     @api origin: string | null = null;
 
+    /**
+     * Project title (same value passed to `<doc-header>` as `subtitle`). Used
+     * inside the Redoc-rendered UI to label the parent project.
+     */
+    @api projectTitle: string | null = "All Reference";
+
+    /**
+     * Href to navigate to when the back link is clicked AND there is no
+     * usable referrer (e.g. the user opened the page directly in a fresh
+     * tab).
+     */
+    @api headerHref: string | null = null;
+
+    @api
+    get docContentType(): boolean {
+        return this._docContentType;
+    }
+    set docContentType(value: boolean | string) {
+        this._docContentType = normalizeBoolean(value);
+    }
+    private _docContentType = false;
+
+    get specTitle(): string | null {
+        return this.getSelectedReference()?.title ?? null;
+    }
+
+    /**
+     * Whether to show the project header. Shown for multi-spec reference
+     * sets, and for any docs-content spec topic so it always has a back
+     * link.
+     */
+    get showRedocHeader(): boolean {
+        const refCount = this._referenceConfig?.refList?.length ?? 0;
+        const isMultiSpecSet = refCount > 1;
+        return (
+            (isMultiSpecSet || this._docContentType) &&
+            !!(this.projectTitle || this.specTitle)
+        );
+    }
+
+    /**
+     * Navigates back to reference doc.
+     */
+    private onBackClick = (event: Event): void => {
+        event.preventDefault();
+        const referrerHref = this.getSameOriginReferrerHref();
+        if (referrerHref) {
+            window.location.href = referrerHref;
+            return;
+        }
+        if (this._docContentType && this.headerHref) {
+            window.location.href = this.headerHref;
+            return;
+        }
+        const fallbackHref = this.getReferencesRootHref();
+        if (fallbackHref) {
+            window.location.href = fallbackHref;
+        }
+    };
+
+    /**
+     * Returns the referrer URL when the page was reached via in-tab navigation
+     * from a same-origin page; otherwise `null`. Both `initialHistoryLength`
+     * and `document.referrer` are checked since neither signal is reliable on
+     * its own.
+     */
+    private getSameOriginReferrerHref(): string | null {
+        if (this.initialHistoryLength <= 1 || !document.referrer) {
+            return null;
+        }
+        try {
+            const referrerUrl = new URL(document.referrer);
+            if (referrerUrl.origin !== window.location.origin) {
+                return null;
+            }
+            return referrerUrl.href;
+        } catch {
+            return null;
+        }
+    }
+
+    /**
+     * Derives the project's `.../references` root from the current URL by
+     * trimming any trailing reference id (and deeper segments). Returns null
+     * when the URL doesn't contain a `/references` segment.
+     */
+    private getReferencesRootHref(): string | null {
+        const { pathname } = window.location;
+        const idx = pathname.lastIndexOf(REFERENCES_SEGMENT);
+        return idx === -1
+            ? null
+            : pathname.slice(0, idx + REFERENCES_SEGMENT.length);
+    }
+
     /** When origin is provided, pass it to the footer; otherwise use dx-footer's default. */
     get effectiveFooterOrigin(): string {
         return (
@@ -86,6 +190,10 @@ export default class RedocReference extends LightningElement {
     }
 
     connectedCallback(): void {
+        // Snapshot history length before Redoc pushes its own hash entries,
+        // so it reflects real in-tab navigation rather than Redoc's churn.
+        this.initialHistoryLength = window.history.length;
+
         window.addEventListener("scroll", this.handleScrollAndResize);
         window.addEventListener("resize", this.handleScrollAndResize);
     }
@@ -106,7 +214,6 @@ export default class RedocReference extends LightningElement {
         // Clean up cached DOM element references to prevent memory leaks
         this.docHeaderElement = null;
         this.docPhaseWrapperElement = null;
-        this.playgroundInstances.clear();
     }
 
     // Displays error UI and logs error message for debugging
@@ -220,7 +327,8 @@ export default class RedocReference extends LightningElement {
             const currentUrl = window.location;
             const existingParams = currentUrl.search + currentUrl.hash;
 
-            window.history.pushState(
+            // Use replaceState to avoid creating a new history entry when the user visits /references without any reference ID
+            window.history.replaceState(
                 {},
                 "",
                 `${parentReferencePath}${existingParams}`
@@ -254,8 +362,6 @@ export default class RedocReference extends LightningElement {
                     return;
                 }
 
-                this.fetchAndParseSpec(specUrl);
-
                 window.Redoc.init(
                     specUrl,
                     {
@@ -313,10 +419,12 @@ export default class RedocReference extends LightningElement {
 
             this.appendFooterItems(apiContentDiv);
 
+            // Inject the multi-spec project header into Redoc's left menu only.
+            this.insertProjectHeaderInMenu(redocContainer);
+
             // Wait for footer to be rendered before updating styles
             requestAnimationFrame(() => {
                 this.updateRedocThirdColumnStyle(redocContainer);
-                this.injectTryItButtons();
 
                 // Fix initial hash scroll after doc phase insertion
                 this.handleInitialHashScrollFix();
@@ -326,6 +434,65 @@ export default class RedocReference extends LightningElement {
         }
     }
 
+    /**
+     * Inserts the project header into Redoc for multi-spec reference sets.
+     */
+    private insertProjectHeaderInMenu(redocContainer: HTMLElement): void {
+        if (!this.showRedocHeader) {
+            return;
+        }
+
+        // Select the LNB and content area of Redoc and insert the requried header.
+        redocContainer
+            .querySelectorAll<HTMLElement>(".menu-content, .api-content")
+            .forEach((target) => {
+                target.insertBefore(
+                    this.buildProjectHeaderDom(),
+                    target.firstChild
+                );
+            });
+    }
+
+    /**
+     * Builds a fresh project-title/spec-title header DOM node.
+     */
+    private buildProjectHeaderDom(): HTMLElement {
+        const wrapper = document.createElement("div");
+        wrapper.className = "redoc-project-header";
+
+        if (this.projectTitle) {
+            const backLink = document.createElement("a");
+            backLink.className = "redoc-project-back";
+            backLink.href = "#";
+            backLink.addEventListener("click", this.onBackClick);
+
+            const icon = createElement("dx-icon", { is: DxIcon });
+            Object.assign(icon, {
+                sprite: "utility",
+                symbol: "back",
+                size: "medium"
+            });
+            icon.classList.add("redoc-project-back-arrow");
+
+            const label = document.createElement("span");
+            label.className = "redoc-project-title";
+            label.textContent = this.projectTitle;
+
+            backLink.appendChild(icon);
+            backLink.appendChild(label);
+            wrapper.appendChild(backLink);
+        }
+
+        if (this.specTitle) {
+            const specEl = document.createElement("h2");
+            specEl.className = "redoc-spec-title dx-text-display-7";
+            specEl.textContent = this.specTitle;
+            wrapper.appendChild(specEl);
+        }
+
+        return wrapper;
+    }
+
     // Waits for Redoc's API content element to be rendered
     private async waitForApiContent(
         container: HTMLElement
@@ -359,7 +526,10 @@ export default class RedocReference extends LightningElement {
     // Appends footer component to container
     private insertFooter(container: HTMLElement): void {
         const footerElement = createElement("dx-footer", { is: DxFooter });
-        Object.assign(footerElement, { variant: "no-signup", mfeConfigOrigin: this.effectiveFooterOrigin });
+        Object.assign(footerElement, {
+            variant: "no-signup",
+            mfeConfigOrigin: this.effectiveFooterOrigin
+        });
         container.appendChild(footerElement);
     }
 
@@ -421,114 +591,6 @@ export default class RedocReference extends LightningElement {
         );
     }
 
-    // Fetches and parses the OpenAPI spec for Try It playground
-    private async fetchAndParseSpec(specUrl: string): Promise<void> {
-        try {
-            const response = await fetch(specUrl);
-            if (!response.ok) {
-                return;
-            }
-            this.openApiSpec = await response.json();
-            this.parsedOperations = parseOpenApiSpec(this.openApiSpec);
-        } catch {
-            // Non-fatal: playground simply won't be available
-        }
-    }
-
-    // Injects "Try It" toggle buttons into Redoc operation sections
-    private injectTryItButtons(): void {
-        if (this.parsedOperations.length === 0) {
-            return;
-        }
-
-        const redocContainer = this.getRedocContainer();
-        if (!redocContainer) {
-            return;
-        }
-
-        for (const operation of this.parsedOperations) {
-            const sectionId = `operation/${operation.operationId}`;
-            const section = redocContainer.querySelector(
-                `[data-section-id="${sectionId}"]`
-            );
-            if (!section) {
-                continue;
-            }
-
-            // Skip if button already injected
-            if (section.querySelector(".try-it-toggle")) {
-                continue;
-            }
-
-            const button = document.createElement("button");
-            button.className = "try-it-toggle";
-            button.textContent = "Try It";
-            button.setAttribute("type", "button");
-            button.setAttribute("aria-expanded", "false");
-            button.style.cssText =
-                "display:inline-flex;align-items:center;gap:4px;padding:4px 12px;" +
-                "border:1px solid #0070d2;border-radius:4px;background:#fff;color:#0070d2;" +
-                "font-size:12px;font-weight:600;cursor:pointer;margin-left:12px;vertical-align:middle;";
-            button.addEventListener("click", () => {
-                this.togglePlayground(operation, section as HTMLElement);
-            });
-
-            // Insert button after the first heading or at the start
-            const heading = section.querySelector("h1, h2, h3");
-            if (heading?.parentElement) {
-                heading.parentElement.insertBefore(
-                    button,
-                    heading.nextSibling
-                );
-            } else {
-                section.insertBefore(button, section.firstChild);
-            }
-        }
-    }
-
-    // Toggles the playground panel for an operation section
-    private togglePlayground(
-        operation: OperationDefinition,
-        section: HTMLElement
-    ): void {
-        const operationId = operation.operationId;
-        const existingWrapper = this.playgroundInstances.get(operationId);
-
-        if (existingWrapper) {
-            const isHidden = existingWrapper.style.display === "none";
-            existingWrapper.style.display = isHidden ? "block" : "none";
-
-            const button = section.querySelector(".try-it-toggle");
-            if (button) {
-                button.setAttribute(
-                    "aria-expanded",
-                    isHidden ? "true" : "false"
-                );
-            }
-            return;
-        }
-
-        const wrapper = document.createElement("div");
-        wrapper.className = "try-it-playground-wrapper";
-
-        const playgroundElement = createElement("doc-api-playground", {
-            is: ApiPlayground
-        });
-        Object.assign(playgroundElement, {
-            operation,
-            spec: this.openApiSpec
-        });
-
-        wrapper.appendChild(playgroundElement);
-        section.appendChild(wrapper);
-        this.playgroundInstances.set(operationId, wrapper);
-
-        const button = section.querySelector(".try-it-toggle");
-        if (button) {
-            button.setAttribute("aria-expanded", "true");
-        }
-    }
-
     // Fixes initial hash scroll positioning after doc phase insertion
     private handleInitialHashScrollFix(): void {
         const hash = window.location.hash;

package/src/modules/doc/unifiedContentLayout/unifiedContentLayout.css

@@ -0,0 +1,19 @@
+:host {
+    display: block;
+}
+
+.content-type-docs doc-phase {
+    --doc-c-phase-top: calc(
+        var(--dx-g-global-header-height) + var(--dx-g-doc-header-height) +
+            var(--dx-g-spacing-xl)
+    );
+}
+
+@media screen and (max-width: 768px) {
+    .content-type-docs doc-phase {
+        --doc-c-phase-top: calc(
+            var(--dx-g-global-header-height) + var(--dx-g-doc-header-height) +
+                40px
+        );
+    }
+}

package/src/modules/doc/unifiedContentLayout/unifiedContentLayout.html

@@ -0,0 +1,26 @@
+<template>
+    <doc-content-layout
+        class="content-type content-type-markdown content-type-docs"
+        breadcrumbs={breadcrumbs}
+        share-title={shareTitle}
+        share-twitter-via={twitterVia}
+        sidebar-header={sidebarHeader}
+        sidebar-value={sidebarValue}
+        sidebar-content={sidebarContent}
+        toc-title={tocTitle}
+        toc-options={tocOptions}
+        toc-aria-level={tocAriaLevel}
+        enable-slot-change="true"
+        languages={languages}
+        language={language}
+        show-footer={enableFooter}
+        origin={origin}
+    >
+        <doc-phase
+            slot="doc-phase"
+            lwc:if={docPhaseInfo}
+            doc-phase-info={docPhaseInfo}
+        ></doc-phase>
+        <slot></slot>
+    </doc-content-layout>
+</template>

package/src/modules/doc/unifiedContentLayout/unifiedContentLayout.ts

@@ -0,0 +1,85 @@
+import { LightningElement, api } from "lwc";
+import { toJson } from "dxUtils/normalizers";
+import type { OptionWithLink, TreeNode } from "typings/custom";
+
+/**
+ * Per-topic type emitted by the docs content-type parser
+ * (see @salesforcedevs/sfdocs-doc-framework: `TopicTypeEnum`). Only `spec`
+ * is meaningful inside this component; everything else renders as a plain
+ * markdown-style tile.
+ */
+const TOPIC_TYPE_SPEC = "spec";
+
+/**
+ * Translates per-topic `topicType` into the generic `showForwardArrow` flag
+ * that `dx-tree-tile` reads (spec topics get the forward arrow icon for Redoc).
+ */
+function decorateTopicsWithForwardArrow(
+    topics: Array<TreeNode & { topicType?: string }> | undefined
+): TreeNode[] | undefined {
+    return topics?.map((topic) => {
+        const { topicType, ...decorated } = topic;
+        if (topicType === TOPIC_TYPE_SPEC) {
+            decorated.showForwardArrow = true;
+        }
+        if (decorated.children) {
+            decorated.children = decorateTopicsWithForwardArrow(
+                decorated.children
+            );
+        }
+        return decorated;
+    });
+}
+
+/**
+ * Wrapper around `doc-content-layout` for the "docs" content type emitted by
+ * the `DocsContentTypeParser`.
+ */
+export default class UnifiedContentLayout extends LightningElement {
+    @api breadcrumbs: string | null = null;
+    @api sidebarHeader?: string;
+    @api sidebarValue?: string;
+    @api tocTitle?: string;
+    @api tocOptions?: string;
+    @api tocAriaLevel?: string;
+    @api languages?: OptionWithLink[];
+    @api language?: string;
+
+    /** Optional origin URL for the footer MFE (e.g. wp-json endpoint). */
+    @api origin: string | null = null;
+
+    /** Article name from breadcrumbs, used as share title (e.g. for social share). */
+    @api shareTitle: string | null = null;
+
+    /** Optional Twitter "via" handle (e.g. SalesforceDevs) for social share. */
+    @api twitterVia: string | null = null;
+
+    @api hideFooter = false;
+
+    private _docPhaseInfo: string | null = null;
+    private _sidebarContent: unknown = null;
+
+    @api
+    get docPhaseInfo(): string | null {
+        return this._docPhaseInfo;
+    }
+
+    set docPhaseInfo(value: string | null) {
+        this._docPhaseInfo = value || null;
+    }
+
+    @api
+    get sidebarContent(): unknown {
+        return this._sidebarContent;
+    }
+
+    set sidebarContent(value: string) {
+        this._sidebarContent = decorateTopicsWithForwardArrow(
+            toJson(value)?.topics
+        );
+    }
+
+    private get enableFooter(): boolean {
+        return !this.hideFooter;
+    }
+}

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

@@ -53,7 +53,7 @@
     </doc-content-layout>
     <div lwc:if={display404}>
         <dx-error
-            image="https://a.sfdcstatic.com/developer-website/prod/images/404.svg"
+            image="https://developer.salesforce.com/ns-assets/404.svg"
             code="404"
             header="Beep boop. That did not compute."
             subtitle="The document you're looking for doesn't seem to exist."

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

@@ -322,8 +322,10 @@ export default class DocXmlContent extends LightningElementWithState<{
         };
     }
 
-    private handlePopState = (event: PopStateEvent): void =>
+    private handlePopState = (event: PopStateEvent): void => {
         this.updatePageReference(this.getReferenceFromUrl(), event);
+        this.handleLocaleReload();
+    };
 
     handleDismissVersionBanner() {
         this.showVersionBanner = false;
@@ -598,6 +600,31 @@ export default class DocXmlContent extends LightningElementWithState<{
             "docs",
             this.pageReferenceToString(this.pageReference)
         );
+        this.handleLocaleReload();
+    }
+
+    /* This method reloads the page as locale banner context is not available in developer-website. */
+    private handleLocaleReload(): void {
+        const targetLocale = this.language?.id;
+        if (!targetLocale) {
+            return;
+        }
+
+        const currentPath = window.location.pathname;
+        const localePattern = /atlas\.[a-z]{2}-[a-z]{2}\./;
+
+        if (localePattern.test(currentPath)) {
+            const newPath = currentPath.replace(
+                localePattern,
+                `atlas.${targetLocale}.`
+            );
+            const newUrl =
+                window.location.origin +
+                newPath +
+                window.location.search +
+                window.location.hash;
+            window.location.href = newUrl;
+        }
     }
 
     private updateHighlighting(searchParam: string): void {