@salesforcedevs/docs-components 1.3.304-async-fix-alpha1 → 1.3.319-scroll-alpha

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "1.3.304-async-fix-alpha1",
+    "version": "1.3.319-scroll-alpha",
     "description": "Docs Lightning web components for DSC",
     "license": "MIT",
     "main": "index.js",
@@ -17,8 +17,7 @@
         "lodash.orderby": "^4.6.0",
         "lodash.uniqby": "^4.7.0",
         "query-string": "^7.1.3",
-        "sentence-case": "^3.0.4",
-        "yieldable-json": "^2.0.1"
+        "sentence-case": "^3.0.4"
     },
     "devDependencies": {
         "@types/classnames": "^2.2.10",

package/src/modules/doc/amfReference/amfReference.ts

@@ -1475,10 +1475,18 @@ export default class AmfReference extends LightningElement {
         // update topic view
         const { referenceId, amfId, type } = this.selectedTopic!;
 
+        // Adding stringify inside try/catch
+        let amfModelString = "";
+        try {
+            amfModelString = JSON.stringify(this.amfMap[referenceId].model);
+        } catch (error) {
+            console.error(`Error stringifying amf model: ${error}`);
+        }
+
         // This updates the component in the content section.
         this.topicModel = {
             type,
-            amf: this.amfMap[referenceId].model,
+            amf: amfModelString,
             parser: this.amfMap[referenceId].parser,
             id: amfId
         };

package/src/modules/doc/amfReference/types.ts

@@ -95,7 +95,7 @@ export interface ParsedTopicModel {
 export interface TopicModel {
     id: string;
     type: string;
-    amf: AmfModel;
+    amf: string;
     parser: AmfParser;
 }
 

package/src/modules/doc/amfTopic/amfTopic.ts

@@ -9,7 +9,6 @@ import {
 } from "./utils";
 import type { TopicModel } from "./types";
 import { Json } from "typings/custom";
-import { parse, stringify } from "yieldable-json";
 
 const TABLE_SIZE_MATCH = "769px";
 
@@ -28,13 +27,17 @@ export default class AmfTopic extends LightningElement {
             !this.amf ||
             (value && this._model && value.amf !== this._model?.amf)
         ) {
-            this.amf = value && clone(value.amf);
+            try {
+                this.amf = value && JSON.parse(value.amf);
+            } catch (error) {
+                console.error(`Error parsing amf model: ${error}`);
+            }
         }
         if (
             !this.type ||
             (value && this._model && value.type !== this._model?.type)
         ) {
-            this.type = value && clone(value.type);
+            this.type = value && value.type;
         }
 
         this._model = value;
@@ -106,14 +109,3 @@ export default class AmfTopic extends LightningElement {
         }
     }
 }
-
-/**
- * The underlying web components we use from api-console mutate their models we pass in.
- * Since LWC makes them Read Only, we need to copy them before passing to the Web Component.
- * @param value JSON Serializable object to clone.
- * @returns A copy of Value. One that has been serialized and parsed via JSON. (Functions, Regex, etc are not preserved.)
- */
-async function clone(value: any): any {
-    const parsedValue = await parse(stringify(value));
-    return parsedValue;
-}

package/src/modules/doc/amfTopic/types.ts

@@ -51,6 +51,6 @@ export type AmfModel = Json;
 export interface TopicModel {
     id: string;
     type: string;
-    amf: AmfModel;
+    amf: string;
     parser: AmfModelParser;
 }

package/src/modules/doc/content/content.css

@@ -385,6 +385,7 @@ mark {
 /* offset page jump link due to fixed header */
 [id] {
     scroll-margin-top: calc(
-        var(--dx-g-global-header-height) + var(--dx-g-doc-header-height)
+        var(--dx-g-global-header-height) + var(--dx-g-doc-header-height) +
+            var(--dx-g-spacing-2xl)
     );
 }

package/src/modules/doc/contentLayout/contentLayout.css

@@ -43,7 +43,8 @@ dx-toc {
 /* offset page jump link due to fixed header */
 ::slotted(doc-heading) {
     scroll-margin-top: calc(
-        var(--dx-g-global-header-height) + var(--dx-g-doc-header-height)
+        var(--dx-g-global-header-height) + var(--dx-g-doc-header-height) +
+            var(--dx-g-spacing-2xl)
     );
 }
 

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

@@ -215,10 +215,16 @@ export default class ContentLayout extends LightningElement {
             ".sticky-doc-header"
         ) as HTMLElement;
 
-        const docPhaseEl = (
+        let docPhaseEl = (
             this.template.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;
+        }
+
         if (!sidebarEl || !globalNavEl || !contextNavEl || !docHeaderEl) {
             console.warn("One or more required elements are missing.");
             return;
@@ -231,6 +237,14 @@ export default class ContentLayout extends LightningElement {
                 (globalNavEl.getBoundingClientRect().height !== 72 ? 0 : 72) +
                 contextNavEl.getBoundingClientRect().height;
             const docHeaderHeight = docHeaderEl.getBoundingClientRect().height;
+            const totalHeaderHeight = globalNavHeight + docHeaderHeight;
+
+            // Selecting the doc section heading and RNB here.
+            const docHeadingEls = Array.from(
+                document.querySelectorAll("doc-heading")
+            );
+            const rightNavBarEl = this.template.querySelector(".right-nav-bar");
+
             sidebarEl.style.setProperty(
                 "--dx-c-content-sidebar-sticky-top",
                 `${globalNavHeight + docHeaderHeight}px`
@@ -241,6 +255,27 @@ export default class ContentLayout extends LightningElement {
                 `${globalNavHeight}px`
             );
 
+            // 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`;
+            });
+
+            // Adjusting the right nav bar on scroll.
+            if (rightNavBarEl) {
+                rightNavBarEl.style.top = docPhaseEl
+                    ? `${
+                          totalHeaderHeight +
+                          docPhaseEl.getBoundingClientRect().height
+                      }px`
+                    : `${totalHeaderHeight}px`;
+            }
+
             // If doc phase element exists, we need to account for its sticky position. Mobile should include the sidebar height (since it becomes sticky aswell).
             if (docPhaseEl) {
                 docPhaseEl.style.setProperty(
@@ -253,30 +288,6 @@ export default class ContentLayout extends LightningElement {
                             : globalNavHeight + docHeaderHeight
                     }px`
                 );
-
-                // Adjust scroll margin for doc headings when doc phase is present
-                const docHeadingEls = Array.from(
-                    document.querySelectorAll("doc-heading")
-                );
-                docHeadingEls.forEach((docHeadingEl) => {
-                    (docHeadingEl as any).style.scrollMarginTop = `${
-                        globalNavHeight +
-                        docHeaderHeight +
-                        docPhaseEl.getBoundingClientRect().height
-                    }px`;
-                });
-
-                // Adjust right nav bar position when doc phase is present
-                const rightNavBarEl =
-                    this.template.querySelector(".right-nav-bar");
-
-                if (rightNavBarEl) {
-                    rightNavBarEl.style.top = `${
-                        globalNavHeight +
-                        docHeaderHeight +
-                        docPhaseEl.getBoundingClientRect().height
-                    }px`;
-                }
             }
         });
     };

package/src/modules/doc/amfTopic/worker.ts

@@ -1,3 +0,0 @@
-onmessage = function (event) {
-    postMessage(JSON.parse(JSON.stringify(event.data)));
-};