@salesforcedevs/docs-components 1.20.7 → 1.20.13-redocly

package/lwc.config.json

@@ -20,6 +20,7 @@
         "doc/headingAnchor",
         "doc/overview",
         "doc/phase",
+        "doc/redocReference",
         "doc/specificationContent",
         "doc/versionPicker",
         "doc/xmlContent",

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "1.20.7",
+    "version": "1.20.13-redocly",
     "description": "Docs Lightning web components for DSC",
     "license": "MIT",
     "main": "index.js",
@@ -25,7 +25,7 @@
         "@types/lodash.orderby": "4.6.9",
         "@types/lodash.uniqby": "4.7.9"
     },
-    "gitHead": "fffbef4d7b536a321824457c6a987e53830a78f1",
+    "gitHead": "4629fdd9ca18a13480044ad43515b91945d16aad",
     "volta": {
         "node": "20.19.0",
         "yarn": "1.22.19"

package/src/modules/doc/amfReference/amfReference.css

@@ -1,10 +1,3 @@
-doc-phase {
-    --doc-c-phase-top: calc(
-        var(--dx-g-global-header-height) + var(--dx-g-doc-header-height) +
-            var(--dx-g-spacing-xl)
-    );
-}
-
 /* We need to apply some borders when there are two doc phases */
 doc-phase:not(:only-of-type)::part(container) {
     border-top: 1px solid var(--dx-g-yellow-vibrant-90);
@@ -15,11 +8,6 @@ doc-phase:nth-child(2)::part(container) {
     border-bottom: 1px solid var(--dx-g-yellow-vibrant-90);
 }
 
-/* We don't want second component to sticky as we need to handle different cases like position */
-doc-phase:nth-child(2) {
-    position: static;
-}
-
 .api-documentation {
     margin-top: 48px;
 }

package/src/modules/doc/contentLayout/contentLayout.html

@@ -17,8 +17,12 @@
             <slot name="sidebar-header" slot="version-picker"></slot>
         </dx-sidebar-old>
         <div class="content-body-doc-phase-container">
-            <slot name="doc-phase"></slot>
-            <slot name="version-banner"></slot>
+            <div class="doc-phase-wrapper">
+                <slot name="doc-phase"></slot>
+            </div>
+            <div class="version-wrapper">
+                <slot name="version-banner"></slot>
+            </div>
             <div class="content-body-container">
                 <div class="content-body">
                     <doc-breadcrumbs

package/src/modules/doc/contentLayout/contentLayout.ts

@@ -223,15 +223,20 @@ export default class ContentLayout extends LightningElement {
             ".sticky-doc-header"
         ) as HTMLElement;
 
-        let docPhaseEl = (
-            this.template.querySelector("[name=doc-phase]")! as any
+        const docPhaseWrapper = this.template.querySelector(
+            ".doc-phase-wrapper"
+        ) as HTMLElement;
+        const versionWrapper = this.template.querySelector(
+            ".version-wrapper"
+        ) as HTMLElement;
+
+        const docPhaseEl = (
+            docPhaseWrapper.querySelector("[name=doc-phase]")! as any
         ).assignedElements()[0] as HTMLSlotElement;
 
-        if (!docPhaseEl) {
-            docPhaseEl = (
-                this.template.querySelector("[name=version-banner]")! as any
-            ).assignedElements()[0] as HTMLSlotElement;
-        }
+        const verBannerEl = (
+            versionWrapper.querySelector("[name=version-banner]")! as any
+        ).assignedElements()[0] as HTMLSlotElement;
 
         if (!sidebarEl || !globalNavEl || !contextNavEl || !docHeaderEl) {
             console.warn("One or more required elements are missing.");
@@ -263,23 +268,21 @@ export default class ContentLayout extends LightningElement {
                 `${globalNavHeight}px`
             );
 
+            const docPhaseElHeight =
+                docPhaseEl || verBannerEl
+                    ? (docPhaseEl || verBannerEl).getBoundingClientRect().height
+                    : 0;
+
             // Adjusting the doc section heading on scroll.
             docHeadingEls.forEach((docHeadingEl) => {
-                (docHeadingEl as any).style.scrollMarginTop = docPhaseEl
-                    ? `${
-                          totalHeaderHeight +
-                          docPhaseEl.getBoundingClientRect().height +
-                          40
-                      }px`
-                    : `${totalHeaderHeight + 40}px`;
+                (docHeadingEl as any).style.scrollMarginTop = `${
+                    totalHeaderHeight + docPhaseElHeight + 40
+                }px`;
             });
 
             // Adjusting the right nav bar on scroll.
             // setting maxheight to make the RNB scrollable based on different parent elements
             if (rightNavBarEl) {
-                const docPhaseElHeight = docPhaseEl
-                    ? docPhaseEl.getBoundingClientRect().height
-                    : 0;
                 const viewportHeight = window.innerHeight;
                 const maxHeight =
                     viewportHeight -
@@ -299,18 +302,20 @@ export default class ContentLayout extends LightningElement {
                 }
             }
 
+            const docPhaseTop =
+                window.innerWidth < 769
+                    ? globalNavHeight +
+                      docHeaderHeight +
+                      sidebarEl.getBoundingClientRect().height
+                    : globalNavHeight + docHeaderHeight;
+
             // If doc phase element exists, we need to account for its sticky position. Mobile should include the sidebar height (since it becomes sticky aswell).
+            // To handle sticky position for safari browser, position sticky given to wrapper class
             if (docPhaseEl) {
-                docPhaseEl.style.setProperty(
-                    "--doc-c-phase-top",
-                    `${
-                        window.innerWidth < 769
-                            ? globalNavHeight +
-                              docHeaderHeight +
-                              sidebarEl.getBoundingClientRect().height
-                            : globalNavHeight + docHeaderHeight
-                    }px`
-                );
+                docPhaseWrapper.style.top = `${docPhaseTop}px`;
+            } else if (verBannerEl) {
+                versionWrapper.style.position = "sticky";
+                versionWrapper.style.top = `${docPhaseTop}px`;
             }
         });
     };

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

@@ -16,8 +16,12 @@
             <slot name="sidebar-header" slot="version-picker"></slot>
         </dx-sidebar-old>
         <div class="content-body-doc-phase-container">
-            <slot name="doc-phase"></slot>
-            <slot name="version-banner"></slot>
+            <div class="doc-phase-wrapper">
+                <slot name="doc-phase"></slot>
+            </div>
+            <div class="version-wrapper">
+                <slot name="version-banner"></slot>
+            </div>
             <div class="content-body-container">
                 <div class={contentBodyClasses}>
                     <doc-breadcrumbs

package/src/modules/doc/phase/phase.css

@@ -3,14 +3,7 @@
 @import "docHelpers/status";
 
 :host {
-    --doc-c-phase-top: 0;
     --doc-c-phase-container-align-items: flex-start;
-
-    position: sticky;
-    top: var(--doc-c-phase-top);
-
-    /* NOTE: If you are changing z-index value here, ensure it's less than z-index of dx-sidebar in contentLayout.css */
-    z-index: var(--dx-g-z-index-100);
 }
 
 .doc-phase-container {

package/src/modules/doc/redocReference/redocReference.css

@@ -0,0 +1,6 @@
+:host {
+    --doc-c-redoc-sidebar-top: calc(
+        var(--dx-g-global-header-height) + var(--dx-g-doc-header-height) +
+            var(--dx-g-spacing-xl)
+    );
+}

package/src/modules/doc/redocReference/redocReference.html

@@ -0,0 +1,8 @@
+<template>
+    <slot></slot>
+    <dx-error-fallback
+        if:true={showError}
+        title="API Documentation Unavailable"
+        description="This API reference is currently unavailable. Please try again later."
+    ></dx-error-fallback>
+</template>

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

@@ -0,0 +1,256 @@
+/* eslint-disable @lwc/lwc/no-document-query */
+import { createElement, LightningElement, api } from "lwc";
+import DocPhase from "doc/phase";
+import DxFooter from "dx/footer";
+import SprigSurvey from "doc/sprigSurvey";
+
+declare global {
+    interface Window {
+        Redoc: any;
+    }
+}
+
+type ReferenceItem = {
+    source: string;
+    href: string;
+    isSelected?: boolean;
+    docPhase?: any;
+};
+
+type ReferenceConfig = {
+    refList: ReferenceItem[];
+};
+
+export default class RedocReference extends LightningElement {
+    private _referenceConfig: ReferenceConfig = { refList: [] };
+    private _parentDocPhaseInfo: string | null = null;
+
+    private layoutTimeoutId: number | null = null;
+    private isScrolling: boolean = false;
+    private previousTopValue = "";
+    private redocInitialized = false;
+
+    showError = false;
+
+    @api
+    get referenceConfig(): ReferenceConfig {
+        return this._referenceConfig;
+    }
+
+    set referenceConfig(value: string | ReferenceConfig) {
+        try {
+            const refConfig =
+                typeof value === "string" ? JSON.parse(value) : value;
+            this._referenceConfig = refConfig;
+        } catch (e) {
+            this._referenceConfig = { refList: [] };
+        }
+    }
+
+    @api
+    get docPhaseInfo(): string | null {
+        return this._parentDocPhaseInfo;
+    }
+
+    set docPhaseInfo(value: string) {
+        this._parentDocPhaseInfo = value;
+    }
+
+    connectedCallback(): void {
+        window.addEventListener("scroll", this.handleScrollWithThrottle);
+        window.addEventListener("resize", this.handleScrollWithThrottle);
+    }
+
+    renderedCallback(): void {
+        if (!this.redocInitialized && window.Redoc) {
+            this.initializeRedoc();
+        }
+    }
+
+    disconnectedCallback(): void {
+        if (this.layoutTimeoutId) {
+            clearTimeout(this.layoutTimeoutId);
+            this.layoutTimeoutId = null;
+        }
+
+        window.removeEventListener("scroll", this.handleScrollWithThrottle);
+        window.removeEventListener("resize", this.handleScrollWithThrottle);
+    }
+
+    @api
+    setDocPhaseInfo(docPhaseInfo: string): void {
+        this._parentDocPhaseInfo = docPhaseInfo;
+    }
+
+    private handleScrollWithThrottle = () => {
+        if (!this.isScrolling) {
+            this.isScrolling = true;
+
+            setTimeout(() => {
+                this.adjustPosition();
+            }, 200);
+
+            this.isScrolling = false;
+        }
+    };
+
+    private adjustPosition = () => {
+        const redocContainer = this.getRedocContainer();
+        const sidebarMenuElement = redocContainer?.querySelector(
+            ".redoc-wrap .menu-content"
+        ) as HTMLElement;
+
+        requestAnimationFrame(() => {
+            const globalNavElement = document.querySelector("hgf-c360nav");
+            const contextNavElement =
+                document.querySelector("hgf-c360contextnav");
+            const docHeaderElement =
+                document.querySelector(".sticky-doc-header");
+
+            if (sidebarMenuElement) {
+                const globalNavHeight =
+                    globalNavElement?.getBoundingClientRect().height || 0;
+                const contextNavHeight =
+                    contextNavElement?.getBoundingClientRect().height || 0;
+                const docHeaderHeight =
+                    docHeaderElement?.getBoundingClientRect().height || 0;
+
+                const calculatedTopValue = `${
+                    globalNavHeight + contextNavHeight + docHeaderHeight
+                }px`;
+
+                if (calculatedTopValue !== this.previousTopValue) {
+                    sidebarMenuElement.style.setProperty(
+                        "--doc-c-redoc-sidebar-top",
+                        calculatedTopValue
+                    );
+                    this.previousTopValue = calculatedTopValue;
+                }
+            }
+        });
+    };
+
+    private getDocPhaseInfo(): string | null {
+        if (this._parentDocPhaseInfo) {
+            return this._parentDocPhaseInfo;
+        }
+        const selectedRef = this.getSelectedReference();
+        return selectedRef?.docPhase
+            ? JSON.stringify(selectedRef.docPhase)
+            : null;
+    }
+
+    private getSelectedReference(): ReferenceItem | null {
+        return this._referenceConfig?.refList?.length
+            ? this._referenceConfig.refList.find((ref) => ref.isSelected) ||
+                  this._referenceConfig.refList[0]
+            : null;
+    }
+
+    private getRedocContainer(): HTMLElement | null {
+        return document.querySelector(".redoc-container");
+    }
+
+    private updateUrlWithReference(selectedRef: ReferenceItem): void {
+        if (selectedRef?.href) {
+            const parentReferencePath = selectedRef.href;
+            const currentUrl = window.location;
+            const existingParams = currentUrl.search + currentUrl.hash;
+
+            window.history.pushState(
+                {},
+                "",
+                `${parentReferencePath}${existingParams}`
+            );
+        }
+    }
+
+    private initializeRedoc(): void {
+        try {
+            const selectedRef = this.getSelectedReference();
+            if (selectedRef) {
+                this.updateUrlWithReference(selectedRef);
+
+                const specUrl = selectedRef.source;
+                const redocContainer = this.getRedocContainer();
+                if (specUrl && redocContainer) {
+                    this.redocInitialized = true;
+                    window.Redoc.init(
+                        specUrl,
+                        {
+                            expandResponses: "200,400"
+                        },
+                        redocContainer,
+                        () => {
+                            this.insertCustomLayoutElements();
+                        }
+                    );
+                } else {
+                    this.showError = true;
+                }
+            }
+        } catch (error) {
+            this.showError = true;
+            console.error("Failed to load data:", error);
+        }
+    }
+
+    private insertCustomLayoutElements(): void {
+        const redocContainer = this.getRedocContainer();
+        const apiContentDiv = redocContainer?.querySelector(".api-content");
+        if (apiContentDiv) {
+            (apiContentDiv as HTMLElement).setAttribute("lwc:dom", "manual");
+
+            try {
+                const docPhaseInfo = this.getDocPhaseInfo();
+                if (docPhaseInfo) {
+                    this.insertDocPhase(
+                        apiContentDiv as HTMLElement,
+                        docPhaseInfo
+                    );
+                }
+                this.insertSprigSurvey(apiContentDiv as HTMLElement);
+                this.insertFooter(apiContentDiv as HTMLElement);
+            } catch (error) {
+                console.error(
+                    "Error showing banner and footer elements",
+                    error
+                );
+            }
+        } else {
+            this.layoutTimeoutId = window.setTimeout(
+                () => this.insertCustomLayoutElements(),
+                100
+            );
+        }
+    }
+
+    private insertDocPhase(container: HTMLElement, docPhaseInfo: string): void {
+        const docPhaseElement = createElement("doc-phase", { is: DocPhase });
+        Object.assign(docPhaseElement, { docPhaseInfo });
+
+        const wrapper = document.createElement("div");
+        wrapper.className = "doc-phase-wrapper";
+        wrapper.appendChild(docPhaseElement);
+
+        container.insertBefore(wrapper, container.firstChild);
+    }
+
+    private insertFooter(container: HTMLElement): void {
+        const footerElement = createElement("dx-footer", { is: DxFooter });
+        Object.assign(footerElement, { variant: "no-signup" });
+        container.appendChild(footerElement);
+    }
+
+    private insertSprigSurvey(container: HTMLElement): void {
+        const feedbackElement = createElement("doc-sprig-survey", {
+            is: SprigSurvey
+        });
+
+        const wrapper = document.createElement("div");
+        wrapper.className = "feedback-wrapper";
+        wrapper.appendChild(feedbackElement);
+
+        container.appendChild(wrapper);
+    }
+}

package/src/modules/doc/xmlContent/xmlContent.css

@@ -31,10 +31,6 @@ dx-dropdown > dx-button:hover {
     --border-color: var(--button-primary-color-hover);
 }
 
-doc-phase {
-    --doc-c-phase-top: var(--dx-g-global-header-height);
-}
-
 @media screen and (max-width: 768px) {
     doc-content-layout {
         --dx-g-doc-header-main-nav-height: 41px;
@@ -45,10 +41,4 @@ doc-phase {
             var(--dx-g-global-header-height) + var(--dx-g-doc-header-height)
         );
     }
-
-    doc-phase {
-        --doc-c-phase-top: calc(
-            var(--dx-g-global-header-height) + var(--dx-g-doc-header-height)
-        );
-    }
 }

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

@@ -24,7 +24,7 @@
         <div lwc:if={showVersionPicker} slot="sidebar-header">
             <doc-version-picker
                 data-type="version"
-                analytics-event="custEv_ctaLinkClick"
+                analytics-event="custEv_linkClick"
                 analytics-payload={ANALYTICS_PAYLOAD}
                 versions={versionOptions}
                 selected-version={version}

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

@@ -355,7 +355,7 @@ export default class DocXmlContent extends LightningElementWithState<{
         );
         this.pageReference.docId = this.language!.url;
 
-        trackGTM(event.target!, "custEv_ctaLinkClick", {
+        trackGTM(event.target!, "custEv_linkClick", {
             click_text: event.detail,
             element_title: "language selector",
             click_url: `${window.location.origin}${this.pageReferenceToString(

package/src/modules/docHelpers/contentLayoutStyle/contentLayoutStyle.css

@@ -59,6 +59,21 @@ dx-toc {
     border-left: 1px solid var(--dx-g-gray-90);
 }
 
+.doc-phase-wrapper,
+.version-wrapper {
+    /* NOTE: If you are changing z-index value here, ensure it's less than z-index of dx-sidebar in contentLayout.css */
+    z-index: var(--dx-g-z-index-100);
+}
+
+.doc-phase-wrapper {
+    position: sticky;
+}
+
+/* We don't want second component to sticky */
+.version-wrapper {
+    position: static;
+}
+
 .content-body-container {
     display: flex;
     flex-direction: row;

package/LICENSE

@@ -1,12 +0,0 @@
-Copyright (c) 2020, Salesforce.com, Inc.
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
-* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
-* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-
-* Neither the name of Salesforce.com nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.