@salesforcedevs/docs-components 1.20.9 → 1.20.13-redocly1

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.9",
+    "version": "1.20.13-redocly1",
     "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": "f059ed735a63a7da1639c89388548ff6ff351c8a",
+    "gitHead": "4629fdd9ca18a13480044ad43515b91945d16aad",
     "volta": {
         "node": "20.19.0",
         "yarn": "1.22.19"

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={title}
+        description={description}
+    ></dx-error-fallback>
+</template>

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

@@ -0,0 +1,280 @@
+/* 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[];
+};
+
+declare const Sprig: (eventType: string, eventNme: string) => void;
+
+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;
+    title: string = "API Documentation Unavailable";
+    description: string =
+        "This API reference is currently unavailable. Please try again later.";
+
+    @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.title = "Failed to parse reference configuration data";
+            this.description =
+                "An error occurred while reading/parsing the reference configuration. Please check the config file for syntax errors or invalid references and try again.";
+            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.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;
+                    console.error(
+                        "Failed to initialize Redoc, required params missing."
+                    );
+                }
+            }
+        } catch (error) {
+            this.title = "Failed to load API specification";
+            this.description =
+                "An error occurred while trying to initialize Redoc. This may be due to a missing or invalid source in the configuration file, or a network connectivity issue. Please verify the source path and your internet connection and try again.";
+            console.error("Failed to load API specification", error);
+            this.showError = true;
+        }
+    }
+
+    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
+                    );
+                }
+
+                if (typeof Sprig !== "undefined") {
+                    this.insertSprigSurvey(apiContentDiv as HTMLElement);
+                }
+
+                this.insertFooter(apiContentDiv as HTMLElement);
+            } catch (error) {
+                this.showError = true;
+                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
+        });
+
+        // targeting the last element of middle section of page
+        const targetElement =
+            container.lastElementChild?.firstElementChild?.firstElementChild;
+        if (targetElement) {
+            targetElement.appendChild(feedbackElement);
+        }
+    }
+}

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/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.