@salesforcedevs/docs-components 1.20.17 → 1.20.18-redocly2

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.17",
+    "version": "1.20.18-redocly2",
     "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": "22c9cf5daf39dab3832c98616c2b557c69395105",
+    "gitHead": "4629fdd9ca18a13480044ad43515b91945d16aad",
     "volta": {
         "node": "20.19.0",
         "yarn": "1.22.19"

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

@@ -0,0 +1,7 @@
+:host {
+    --dx-footer-margin-top: 142px;
+    --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,13 @@
+<template>
+    <template lwc:if={showError}>
+        <dx-error
+            header="We lost communication with the space station."
+            subtitle="We encountered a server-related issue. (Don't worry, we're on it.) Refresh your browser or try again later."
+            image=""
+            code="500"
+        ></dx-error>
+    </template>
+    <template lwc:else>
+        <slot></slot>
+    </template>
+</template>

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

@@ -0,0 +1,326 @@
+/* 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";
+import { throttle } from "throttle-debounce";
+
+declare global {
+    interface Window {
+        Redoc: any;
+    }
+}
+
+type ReferenceItem = {
+    source: string;
+    href: string;
+    isSelected?: boolean;
+    docPhase?: string | null;
+};
+
+type ReferenceConfig = {
+    refList: ReferenceItem[];
+};
+
+declare const Sprig: (eventType: string, eventName: string) => void;
+const SCROLL_THROTTLE_DELAY = 200;
+const ELEMENT_TIMEOUT = 10000;
+const ELEMENT_CHECK_INTERVAL = 100;
+
+export default class RedocReference extends LightningElement {
+    private _referenceConfig: ReferenceConfig = { refList: [] };
+    private _parentDocPhaseInfo: string | null = null;
+    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 (error) {
+            this.showError = true;
+            console.error(
+                "Failed to parse reference configuration data",
+                error
+            );
+            this._referenceConfig = { refList: [] };
+        }
+    }
+
+    @api
+    get docPhaseInfo(): string | null {
+        return this._parentDocPhaseInfo;
+    }
+
+    set docPhaseInfo(value: string) {
+        this._parentDocPhaseInfo = value;
+    }
+
+    connectedCallback(): void {
+        window.addEventListener("scroll", this.handleScrollAndResize);
+        window.addEventListener("resize", this.handleScrollAndResize);
+    }
+
+    renderedCallback(): void {
+        if (!this.redocInitialized) {
+            this.initializeRedoc();
+        }
+    }
+
+    disconnectedCallback(): void {
+        window.removeEventListener("scroll", this.handleScrollAndResize);
+        window.removeEventListener("resize", this.handleScrollAndResize);
+    }
+
+    @api
+    setDocPhaseInfo(docPhaseInfo: string): void {
+        this._parentDocPhaseInfo = docPhaseInfo;
+    }
+
+    private handleLayoutChange = () => {
+        requestAnimationFrame(() => {
+            const redocContainer = this.getRedocContainer();
+            if (!redocContainer) {
+                return;
+            }
+
+            const globalNavElement = document.querySelector("hgf-c360nav");
+            const contextNavElement =
+                document.querySelector("hgf-c360contextnav");
+            const docHeaderElement =
+                document.querySelector(".sticky-doc-header");
+
+            const globalNavHeight =
+                globalNavElement?.getBoundingClientRect().height || 0;
+            const contextNavHeight =
+                contextNavElement?.getBoundingClientRect().height || 0;
+            const docHeaderHeight =
+                docHeaderElement?.getBoundingClientRect().height || 0;
+
+            const calculatedTopValue = `${
+                globalNavHeight + contextNavHeight + docHeaderHeight
+            }px`;
+
+            // Set updated top value for the sidebar and doc phase
+            this.template.host.style.setProperty(
+                "--doc-c-redoc-sidebar-top",
+                calculatedTopValue
+            );
+
+            // Update thirdColumnContainer bottom positioning
+            const footer = redocContainer.querySelector(
+                ".redoc-wrap .api-content dx-footer"
+            ) as HTMLElement;
+            const thirdColumnContainer = redocContainer.querySelector(
+                ".redoc-wrap > div:last-child"
+            ) as HTMLElement;
+
+            if (thirdColumnContainer && footer) {
+                const footerHeight = footer.getBoundingClientRect().height || 0;
+                const footerMarginTop = parseInt(
+                    getComputedStyle(this.template.host).getPropertyValue(
+                        "--dx-footer-margin-top"
+                    ) || "142",
+                    10
+                );
+                thirdColumnContainer.style.setProperty(
+                    "bottom",
+                    `${footerHeight + footerMarginTop}px`
+                );
+            }
+        });
+    };
+
+    private handleScrollAndResize = throttle(
+        SCROLL_THROTTLE_DELAY,
+        () => !this.showError && this.handleLayoutChange()
+    );
+
+    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 async initializeRedoc(): Promise<void> {
+        try {
+            this.redocInitialized = true;
+
+            await this.waitForRedoc();
+            const selectedRef = this.getSelectedReference();
+            if (selectedRef) {
+                this.updateUrlWithReference(selectedRef);
+
+                const specUrl = selectedRef.source;
+                const redocContainer = this.getRedocContainer();
+                if (specUrl && redocContainer) {
+                    try {
+                        window.Redoc.init(
+                            specUrl,
+                            {
+                                expandResponses: "200,400"
+                            },
+                            redocContainer,
+                            () => {
+                                this.insertCustomLayoutElements();
+                            }
+                        );
+                    } catch (error) {
+                        this.showError = true;
+                        console.error(
+                            "Failed to show Reference UI using Redoc:",
+                            error
+                        );
+                    }
+                } else {
+                    this.showError = true;
+                }
+            }
+        } catch (error) {
+            this.showError = true;
+            console.error("Failed to load Redoc library:", error);
+        }
+    }
+
+    /**
+     * Waits until a condition is ready/satisfied within a timeout period
+     * @param readinessCheck - Function that returns truthy when condition is satisfied
+     * @param timeoutErrorMessage - Error message if timeout occurs
+     * @param maxWaitTime - Maximum time to wait in milliseconds
+     */
+    private waitUntilReady(
+        readinessCheck: () => boolean | HTMLElement | null,
+        timeoutErrorMessage: string,
+        maxWaitTime = ELEMENT_TIMEOUT
+    ): Promise<void> {
+        return new Promise((resolve, reject) => {
+            const pollingStartTime = Date.now();
+
+            const performReadinessCheck = () => {
+                if (readinessCheck()) {
+                    resolve();
+                    return;
+                }
+
+                const elapsedTime = Date.now() - pollingStartTime;
+                if (elapsedTime > maxWaitTime) {
+                    reject(new Error(timeoutErrorMessage));
+                    return;
+                }
+
+                setTimeout(performReadinessCheck, ELEMENT_CHECK_INTERVAL);
+            };
+
+            performReadinessCheck();
+        });
+    }
+
+    private waitForRedoc(timeout = ELEMENT_TIMEOUT): Promise<void> {
+        return this.waitUntilReady(
+            () => !!window.Redoc,
+            "Redoc library failed to load within timeout period",
+            timeout
+        );
+    }
+
+    private async insertCustomLayoutElements(): Promise<void> {
+        try {
+            const redocContainer = this.getRedocContainer();
+
+            if (redocContainer) {
+                const apiContentDiv = await this.waitForApiContent(
+                    redocContainer
+                );
+                apiContentDiv.setAttribute("lwc:dom", "manual");
+
+                const docPhaseInfo = this.getDocPhaseInfo();
+                if (docPhaseInfo) {
+                    this.insertDocPhase(apiContentDiv, docPhaseInfo);
+                }
+
+                if (typeof Sprig !== "undefined") {
+                    this.insertSprigSurvey(apiContentDiv);
+                }
+
+                this.insertFooter(apiContentDiv);
+            }
+        } catch (error) {
+            this.showError = true;
+            console.error("Failed to insert layout elements:", error);
+        }
+    }
+
+    private async waitForApiContent(
+        container: HTMLElement
+    ): Promise<HTMLElement> {
+        await this.waitUntilReady(
+            () => container.querySelector<HTMLElement>(".api-content"),
+            "Redoc API content element not found within timeout period"
+        );
+        return container.querySelector<HTMLElement>(".api-content")!;
+    }
+
+    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 = "sprig-survey-wrapper";
+        wrapper.appendChild(feedbackElement);
+        container.appendChild(wrapper);
+    }
+}

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.