@salesforcedevs/docs-components 1.3.65 → 1.3.71

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "1.3.65",
+    "version": "1.3.71",
     "description": "Docs Lightning web components for DSC",
     "license": "MIT",
     "main": "index.js",
@@ -24,5 +24,5 @@
         "@types/lodash.orderby": "^4.6.7",
         "@types/lodash.uniqby": "^4.7.7"
     },
-    "gitHead": "130f19e91f47318f2ebcdc1d62b1d88e7a37b67a"
+    "gitHead": "2189b873b414cccf79905cf0b1401db76abbd9d0"
 }

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

@@ -167,10 +167,12 @@ export default class AmfReference extends LightningElement {
     constructor() {
         super();
 
-        this._boundOnApiNavigationChanged =
-            this.onApiNavigationChanged.bind(this);
-        this._boundUpdateSelectedItemFromUrlQuery =
-            this.updateSelectedItemFromUrlQuery.bind(this);
+        this._boundOnApiNavigationChanged = this.onApiNavigationChanged.bind(
+            this
+        );
+        this._boundUpdateSelectedItemFromUrlQuery = this.updateSelectedItemFromUrlQuery.bind(
+            this
+        );
     }
 
     connectedCallback(): void {
@@ -226,8 +228,9 @@ export default class AmfReference extends LightningElement {
                 const updatedReferenceId =
                     oldReferenceIdNewReferenceIdMap[referenceId];
                 const newReferenceId = updatedReferenceId || referenceId;
-                const referenceItemConfig =
-                    this.getAmfConfigWithId(newReferenceId);
+                const referenceItemConfig = this.getAmfConfigWithId(
+                    newReferenceId
+                );
                 if (referenceItemConfig) {
                     hashBasedRedirectUrl = `${referenceItemConfig.href}?meta=${encodedMeta}`;
                 }
@@ -296,8 +299,9 @@ export default class AmfReference extends LightningElement {
                 for (let i = 0; i < allVersions.length; i++) {
                     const versionItem = allVersions[i];
                     const referenceLink = versionItem.link.href;
-                    const referenceId =
-                        this.getReferenceIdFromUrl(referenceLink);
+                    const referenceId = this.getReferenceIdFromUrl(
+                        referenceLink
+                    );
                     if (this._currentReferenceId === referenceId) {
                         // This is to navigate to respective topic in the changed version
                         versionItem.link.href = `${referenceLink}/${currentRefMeta}`;
@@ -1222,10 +1226,12 @@ export default class AmfReference extends LightningElement {
         }
         if (!isRedirecting) {
             const currentReferenceUrl = window.location.href;
-            const referenceMeta =
-                this.getMarkdownReferenceMeta(currentReferenceUrl);
-            const selectedItemRefId =
-                this.getReferenceIdFromUrl(currentReferenceUrl);
+            const referenceMeta = this.getMarkdownReferenceMeta(
+                currentReferenceUrl
+            );
+            const selectedItemRefId = this.getReferenceIdFromUrl(
+                currentReferenceUrl
+            );
             const referenceDetails = this.getRefDetailsForGivenTopicMeta(
                 selectedItemRefId,
                 referenceMeta
@@ -1264,8 +1270,9 @@ export default class AmfReference extends LightningElement {
         const name = event.detail.name;
         if (name) {
             const urlReferenceId = this.getReferenceIdFromUrl(name);
-            const specBasedReference =
-                this.isSpecBasedReference(urlReferenceId);
+            const specBasedReference = this.isSpecBasedReference(
+                urlReferenceId
+            );
             if (specBasedReference) {
                 const metaVal = this.getMetaFromUrl(name);
                 const currentSelectedMeta = this.selectedTopic
@@ -1315,8 +1322,9 @@ export default class AmfReference extends LightningElement {
             const currentReferenceId = this.getReferenceIdFromUrl(currentUrl);
             //No need to do anything if user is expanding currently selected reference
             if (referenceId !== currentReferenceId) {
-                const isSpecBasedReference =
-                    this.isSpecBasedReference(referenceId);
+                const isSpecBasedReference = this.isSpecBasedReference(
+                    referenceId
+                );
                 if (isSpecBasedReference) {
                     // Perform functionality same as item selection
                     this.onNavSelect(event);

package/src/modules/doc/breadcrumbItem/breadcrumbItem.ts

@@ -9,6 +9,7 @@ const LONG_LABEL_NUMBER = 30;
 export default class BreadcrumbItem extends LightningElement {
     @api href?: string;
     @api level?: string;
+    @api breadcrumbLabels?: string;
 
     @api
     get label() {
@@ -56,13 +57,13 @@ export default class BreadcrumbItem extends LightningElement {
             element_type: "link",
             nav_type: "breadcrumb",
             nav_level: this.level ? this.level + 1 : 1,
-            nav_item: this.label
+            nav_item: this.breadcrumbLabels
         });
 
         track(event.target!, "custEv_linkClick", {
             click_text: this.label,
             click_url: this.href,
-            element_title: "a",
+            element_title: this.label,
             element_type: "link",
             content_category: "cta"
         });

package/src/modules/doc/breadcrumbs/breadcrumbs.html

@@ -5,6 +5,7 @@
                 <doc-breadcrumb-item
                     href={firstCrumb.href}
                     label={firstCrumb.label}
+                    breadcrumb-labels={breadcrumbLabels}
                 ></doc-breadcrumb-item>
                 <span class="breadcrumb-item_slash">/</span>
                 <template if:true={renderDropdown}>
@@ -33,6 +34,7 @@
                         key={breadcrumb.id}
                         label={breadcrumb.label}
                         level={breadcrumb.level}
+                        breadcrumb-labels={breadcrumbLabels}
                     ></doc-breadcrumb-item>
                     <span class="breadcrumb-item_slash" key={breadcrumb.label}>
                         /
@@ -40,12 +42,14 @@
                 </template>
                 <doc-breadcrumb-item
                     label={lastCrumb.label}
+                    breadcrumb-labels={breadcrumbLabels}
                 ></doc-breadcrumb-item>
             </template>
             <template if:true={renderSmallVariant}>
                 <doc-breadcrumb-item
                     href={lastLinkCrump.href}
                     label={lastLinkCrump.label}
+                    breadcrumb-labels={breadcrumbLabels}
                     variant="back-arrow"
                 ></doc-breadcrumb-item>
             </template>

package/src/modules/doc/breadcrumbs/breadcrumbs.ts

@@ -93,6 +93,10 @@ export default class Breadcrumbs extends LightningElement {
         return this.breadcrumbs[0];
     }
 
+    private get breadcrumbLabels(): string {
+        return this.breadcrumbs.map((crumb) => crumb.label).join(":");
+    }
+
     private get lastCrumb(): Breadcrumb {
         return this.breadcrumbs[this.breadcrumbs.length - 1];
     }

package/src/modules/doc/content/content.ts

@@ -324,8 +324,9 @@ export default class Content extends LightningElement {
         event.preventDefault();
         // eslint-disable-next-line no-use-before-define
         const target = event.currentTarget.dataset.id;
-        const [page, docId, deliverable, tempContentDocumentId] =
-            target.split("/");
+        const [page, docId, deliverable, tempContentDocumentId] = target.split(
+            "/"
+        );
         const [contentDocumentId, hash] = tempContentDocumentId.split("#");
         const newPageReference = {
             page: page,

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

@@ -6,7 +6,6 @@
                 trees={sidebarContent}
                 value={sidebarValue}
                 header={sidebarHeader}
-                onsidebarclick={onSidebarClick}
             >
                 <slot name="sidebar-header" slot="header"></slot>
             </dx-sidebar-old>
@@ -21,7 +20,6 @@
                 coveo-public-access-token={coveoPublicAccessToken}
                 coveo-search-hub={coveoSearchHub}
                 coveo-advanced-query-config={coveoAdvancedQueryConfig}
-                onsidebarclick={onSidebarClick}
             >
                 <slot name="sidebar-header" slot="header"></slot>
             </dx-sidebar>

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

@@ -3,7 +3,6 @@ import { closest } from "kagekiri";
 import { toJson } from "dxUtils/normalizers";
 import { highlightTerms } from "dxUtils/highlight";
 import { SearchSyncer } from "docUtils/SearchSyncer";
-import { track as sendGtm } from "dxUtils/analytics";
 
 type AnchorMap = { [key: string]: { intersect: boolean; id: string } };
 
@@ -109,12 +108,6 @@ export default class ContentLayout extends LightningElement {
     private observerTimerId = null;
     private didScrollToSelectedHash = false;
     private _scrollInterval = 0;
-    private scrollPosition = 0;
-
-    private scrolledTwentyFivePercent = false;
-    private scrolledFiftyPercent = false;
-    private scrolledSevenFivePercent = false;
-    private scrolledOneHundredPercent = false;
 
     get showToc(): boolean {
         return this.tocOptions && this.tocOptions.length > 0;
@@ -143,11 +136,6 @@ export default class ContentLayout extends LightningElement {
             );
             this.searchSyncer.init();
         }
-
-        document.body.addEventListener(
-            "scroll",
-            this.scrollThresholdHandler.bind(this)
-        );
     }
 
     renderedCallback(): void {
@@ -176,8 +164,6 @@ export default class ContentLayout extends LightningElement {
         this.clearRenderObserverTimer();
 
         window.clearInterval(this._scrollInterval);
-
-        document.removeEventListener("scroll", this.scrollThresholdHandler);
     }
 
     restoreScroll() {
@@ -233,82 +219,23 @@ export default class ContentLayout extends LightningElement {
         this.resetScrollThreshold();
     }
 
-    sendGtmScrollThresholdEvent(threshold: "25" | "50" | "75" | "100") {
-        sendGtm(document.body, "custEv_scroll", {
-            scrollDepth: threshold
-        });
-    }
-
-    resetScrollThreshold() {
-        this.scrolledTwentyFivePercent = false;
-        this.scrolledFiftyPercent = false;
-        this.scrolledSevenFivePercent = false;
-        this.scrolledOneHundredPercent = false;
-    }
-
-    scrollThresholdHandler() {
-        this.scrollPosition =
-            (document.body.scrollTop /
-                (document.body.scrollHeight - window.innerHeight)) *
-            100;
-
-        if (this.scrollPosition > 25 && !this.scrolledTwentyFivePercent) {
-            this.scrolledTwentyFivePercent = true;
-            this.sendGtmScrollThresholdEvent("25");
-        } else if (this.scrollPosition > 50 && !this.scrolledFiftyPercent) {
-            this.scrolledFiftyPercent = true;
-            this.sendGtmScrollThresholdEvent("50");
-        } else if (this.scrollPosition > 75 && !this.scrolledSevenFivePercent) {
-            this.scrolledSevenFivePercent = true;
-            this.sendGtmScrollThresholdEvent("75");
-        } else if (
-            this.scrollPosition === 100 &&
-            !this.scrolledOneHundredPercent
-        ) {
-            this.scrolledOneHundredPercent = true;
-            this.sendGtmScrollThresholdEvent("100");
-        }
-    }
-
     onSlotChange(event: Event): void {
-        const slotElements = (
-            event.target as HTMLSlotElement
-        ).assignedElements();
+        const slotElements = (event.target as HTMLSlotElement).assignedElements();
 
         if (slotElements.length) {
             this.contentLoaded = true;
             const slotContentElement = slotElements[0];
-            const headingElements =
-                slotContentElement.ownerDocument?.getElementsByTagName(
-                    TOC_HEADER_TAG
-                );
-
-            const docContentEl = slotElements.find(
-                (el) => el.tagName === "DOC-CONTENT"
+            const headingElements = slotContentElement.ownerDocument?.getElementsByTagName(
+                TOC_HEADER_TAG
             );
-            const topicTitleEl =
-                docContentEl?.shadowRoot?.getElementById("topic-title");
-            const anchorElements =
-                docContentEl?.shadowRoot?.querySelectorAll("a[href]");
-
-            // Attach click listeners to all anchor elements for analytics
-            anchorElements?.forEach((anchorElement) => {
-                anchorElement.addEventListener("click", () => {
-                    sendGtm(anchorElement, "custEv_docContentClick", {
-                        clickText: anchorElement.textContent,
-                        clickUrl: anchorElement.getAttribute("href"),
-                        elementType: "link",
-                        locationOnPage: "docContent",
-                        itemTitle: topicTitleEl?.textContent
-                    });
-                });
-            });
 
             for (const headingElement of headingElements) {
                 // Sometimes elements hash is not being set when slot content is wrapped with div
                 headingElement.hash = headingElement.attributes.hash?.nodeValue;
             }
+
             const tocOptions = [];
+
             for (const headingElement of headingElements) {
                 headingElement.id = headingElement.hash;
 

package/src/modules/doc/header/header.ts

@@ -149,7 +149,7 @@ export default class Header extends HeaderBase {
         const payload = {
             click_text: "pdf",
             click_url: this.bailHref,
-            element_title: "dx-button",
+            element_title: "pdf",
             element_type: "link",
             content_category: "download"
         };

package/src/modules/doc/phase/phase.ts

@@ -43,8 +43,9 @@ export default class Phase extends LightningElement {
     }
 
     renderedCallback() {
-        const phaseBodyContainer =
-            this.template.querySelector(".doc-phase-body");
+        const phaseBodyContainer = this.template.querySelector(
+            ".doc-phase-body"
+        );
         if (phaseBodyContainer && this.docPhaseInfo) {
             // eslint-disable-next-line @lwc/lwc/no-inner-html
             phaseBodyContainer.innerHTML = this.docPhaseInfo.body;

package/src/modules/doc/toc/toc.html

@@ -96,9 +96,7 @@
                                                                     <a
                                                                         href={child5.a_attr.href}
                                                                         data-id={child5.id}
-                                                                        class="
-                                                                            nav1
-                                                                        "
+                                                                        class="nav1"
                                                                         onclick={handleNavClick}
                                                                     >
                                                                         {child5.text}

package/src/modules/doc/toolbar/toolbar.ts

@@ -40,9 +40,9 @@ export default class Toolbar extends LightningElement {
             "select[name=languages]"
         ) as HTMLSelectElement;
         if (languageEl) {
-            const languageValue = (
-                languageEl[languageEl.selectedIndex] as HTMLOptionElement
-            ).value;
+            const languageValue = (languageEl[
+                languageEl.selectedIndex
+            ] as HTMLOptionElement).value;
             this.dispatchEvent(
                 new CustomEvent("languageselected", {
                     detail: {
@@ -61,9 +61,9 @@ export default class Toolbar extends LightningElement {
             "select[name=versions]"
         ) as HTMLSelectElement;
         if (versionEl) {
-            const versionValue = (
-                versionEl[versionEl.selectedIndex] as HTMLOptionElement
-            ).value;
+            const versionValue = (versionEl[
+                versionEl.selectedIndex
+            ] as HTMLOptionElement).value;
             this.dispatchEvent(
                 new CustomEvent("versionselected", {
                     detail: {

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

@@ -87,7 +87,9 @@ export class FetchContent {
         return json;
     }
 
-    private normalizeToc(apiToc: Array<ApiNavItem>): {
+    private normalizeToc(
+        apiToc: Array<ApiNavItem>
+    ): {
         tocMap: { [key: string]: TreeNode };
         normalizedToc: Array<TreeNode>;
     } {

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

@@ -355,8 +355,12 @@ export default class DocXmlContent extends LightningElementWithState<{
     }
 
     getReferenceFromUrl(): PageReference {
-        const [page, docId, deliverable, contentDocumentId] =
-            window.location.pathname.substr(1).split("/");
+        const [
+            page,
+            docId,
+            deliverable,
+            contentDocumentId
+        ] = window.location.pathname.substr(1).split("/");
 
         const { origin: domain, hash, search } = window.location;
 
@@ -523,8 +527,14 @@ export default class DocXmlContent extends LightningElementWithState<{
     }
 
     private pageReferenceToString(reference: PageReference): string {
-        const { page, docId, deliverable, contentDocumentId, hash, search } =
-            reference;
+        const {
+            page,
+            docId,
+            deliverable,
+            contentDocumentId,
+            hash,
+            search
+        } = reference;
         return `/${page}/${docId}/${deliverable}/${contentDocumentId}${this.normalizeSearch(
             search
         )}${this.normalizeHash(hash)}`;