@salesforcedevs/docs-components 1.3.150 → 1.3.155-lnb-expand1

package/lwc.config.json

@@ -15,6 +15,7 @@
         "doc/header",
         "doc/heading",
         "doc/headingAnchor",
+        "doc/lwcReferenceLayout",
         "doc/overview",
         "doc/phase",
         "doc/xmlContent"

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "1.3.150",
+    "version": "1.3.155-lnb-expand1",
     "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": "ca1041e6f13585f85b24a5ca48804f20e040d405"
+    "gitHead": "4629fdd9ca18a13480044ad43515b91945d16aad"
 }

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

@@ -4,6 +4,7 @@ import { sentenceCase } from "sentence-case";
 import qs from "query-string";
 import { AmfModelParser } from "./utils";
 import { normalizeBoolean } from "dxUtils/normalizers";
+import { CoveoAnalyticsClient } from "coveo.analytics";
 import type {
     AmfConfig,
     AmfMetadataTopic,
@@ -34,6 +35,7 @@ export default class AmfReference extends LightningElement {
     @api sidebarHeader!: string;
     @api coveoOrganizationId!: string;
     @api coveoPublicAccessToken!: string;
+    @api coveoAnalyticsToken!: string;
     @api coveoAdvancedQueryConfig!: string;
     @api coveoSearchHub!: string;
     @api useOldSidebar?: boolean = false;
@@ -215,6 +217,19 @@ export default class AmfReference extends LightningElement {
         }
     }
 
+    private logCoveoPageView() {
+        if (this.coveoOrganizationId && this.coveoAnalyticsToken) {
+            const ua = new CoveoAnalyticsClient({
+                token: this.coveoAnalyticsToken,
+                endpoint: `https://${this.coveoOrganizationId}.analytics.org.coveo.com`
+            });
+            ua.sendViewEvent({
+                contentIdKey: "@clickableuri",
+                contentIdValue: window.location.href
+            });
+        }
+    }
+
     /**
      * Check if the URL hash to see whether this is one we want to redirect
      * See GUS W-10718771 for references where we want hash-based redirects
@@ -907,6 +922,8 @@ export default class AmfReference extends LightningElement {
         this.handleSelectedItem();
 
         this.updateDocPhase();
+
+        this.logCoveoPageView();
     }
 
     /**
@@ -1168,6 +1185,8 @@ export default class AmfReference extends LightningElement {
         if (referenceItem) {
             window.location.href = referenceItem.href;
         }
+
+        this.logCoveoPageView();
     }
 
     /**
@@ -1260,6 +1279,8 @@ export default class AmfReference extends LightningElement {
             }
             this.updateDocPhase();
             this.selectedSidebarValue = window.location.pathname;
+
+            this.logCoveoPageView();
         }
     }
 

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

@@ -35,6 +35,7 @@ export default class ContentLayout extends LightningElement {
     @api coveoSearchHub!: string;
     @api coveoAdvancedQueryConfig!: string;
     @api useOldSidebar?: boolean = false;
+    @api rnbByTabId?: string = "lwc-doc-tab";
 
     @api
     get breadcrumbs() {
@@ -118,6 +119,10 @@ export default class ContentLayout extends LightningElement {
         return window.location.pathname;
     }
 
+    get showTabBasedRNB() {
+        return this.rnbByTabId ? true : false;
+    }
+
     get showBreadcrumbs(): boolean {
         return (
             this.breadcrumbs != null && (this.breadcrumbs as any[]).length > 1
@@ -136,8 +141,24 @@ export default class ContentLayout extends LightningElement {
             );
             this.searchSyncer.init();
         }
+
+        if (this.showTabBasedRNB) {
+            window.addEventListener("tabchanged", this.onTabChanged);
+        }
     }
 
+    onTabChanged = () => {
+        this.updateRNB();
+    };
+
+    updateRNB = () => {
+        const headingElements = this.getHeadingElements();
+        headingElements.forEach((headingElement) => {
+            headingElement.hash = headingElement.attributes.hash?.nodeValue;
+        });
+        this.updateTocItems(headingElements);
+    };
+
     renderedCallback(): void {
         /**
          * Note: We are adding timeout because chrome is optimizing and not triggering recent renderedCallback though elements reference is changed
@@ -165,6 +186,10 @@ export default class ContentLayout extends LightningElement {
             "highlightedtermchange",
             this.updateHighlighted
         );
+
+        if (this.showTabBasedRNB) {
+            window.removeEventListener("tabchanged", this.onTabChanged);
+        }
         window.removeEventListener("scroll", this.adjustNavPosition);
         window.removeEventListener("resize", this.adjustNavPosition);
         this.searchSyncer.dispose();
@@ -184,6 +209,29 @@ export default class ContentLayout extends LightningElement {
         }
     };
 
+    private getHeadingElements() {
+        let headingElements = document.querySelectorAll(TOC_HEADER_TAG);
+        if (this.showTabBasedRNB) {
+            const tabPanelListItems =
+                document.querySelectorAll("dx-tab-panel-list");
+            for (const tabPanelListItem of tabPanelListItems) {
+                if (tabPanelListItem.id === this.rnbByTabId) {
+                    const tabPanelItems =
+                        tabPanelListItem.querySelectorAll("dx-tab-panel");
+                    for (const tabPanelItem of tabPanelItems) {
+                        if (tabPanelItem.active) {
+                            headingElements =
+                                tabPanelItem.querySelectorAll(TOC_HEADER_TAG);
+                            break;
+                        }
+                    }
+                    break;
+                }
+            }
+        }
+        return headingElements;
+    }
+
     /*
         This is a workaround for the global nav sticky header being decoupled from the doc header & doc phase.
         We have to account for the global nav changing height due to animations.
@@ -243,9 +291,7 @@ export default class ContentLayout extends LightningElement {
                 );
 
                 // Adjust scroll margin for doc headings when doc phase is present
-                const docHeadingEls = Array.from(
-                    document.querySelectorAll("doc-heading")
-                );
+                const docHeadingEls = this.getHeadingElements();
                 docHeadingEls.forEach((docHeadingEl) => {
                     docHeadingEl.style.scrollMarginTop = `${
                         globalNavHeight +
@@ -301,7 +347,7 @@ export default class ContentLayout extends LightningElement {
         );
 
         // Note: We are doing document.querySelectorAll as a quick fix as we are not getting heading elements reference this.querySelectorAll
-        const headingElements = document.querySelectorAll(TOC_HEADER_TAG);
+        const headingElements = this.getHeadingElements();
         for (const headingElement of headingElements) {
             // Add headingElements to intersectionObserver for highlighting respective RNB item when user scroll
             const id = headingElement.getAttribute("id");
@@ -317,47 +363,34 @@ export default class ContentLayout extends LightningElement {
         }
     };
 
-    onSlotChange(event: Event): void {
-        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
-                );
-
-            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;
-            }
+    onSlotChange(): void {
+        this.updateRNB();
+    }
 
-            const tocOptions = [];
+    // eslint-disable-next-line no-undef
+    private updateTocItems(headingElements: NodeListOf<Element>): void {
+        const tocOptions = [];
 
-            for (const headingElement of headingElements) {
-                headingElement.id = headingElement.hash;
-
-                // Update tocOptions from anchorTags only for H2, consider default as 2 as per component
-                const headingAriaLevel =
-                    headingElement.attributes["aria-level"]?.nodeValue || "2";
-                const isH2 = headingAriaLevel === "2";
-
-                if (isH2) {
-                    const tocItem = {
-                        anchor: `#${headingElement.hash}`,
-                        id: headingElement.id,
-                        label: headingElement.title
-                    };
-                    tocOptions.push(tocItem);
-                    this.tocOptionIdsSet.add(headingElement.id);
-                }
+        for (const headingElement of headingElements) {
+            headingElement.id = headingElement.hash;
+
+            // Update tocOptions from anchorTags only for H2, consider default as 2 as per component
+            const headingAriaLevel =
+                headingElement.attributes["aria-level"]?.nodeValue || "2";
+            const isH2 = headingAriaLevel === "2";
+
+            if (isH2) {
+                const tocItem = {
+                    anchor: `#${headingElement.hash}`,
+                    id: headingElement.id,
+                    label: headingElement.title
+                };
+                tocOptions.push(tocItem);
+                this.tocOptionIdsSet.add(headingElement.id);
             }
-
-            this._tocOptions = tocOptions;
         }
+
+        this._tocOptions = tocOptions;
     }
 
     private disconnectObserver(): void {

package/src/modules/doc/lwcReferenceLayout/lwcReferenceLayout.css

@@ -0,0 +1 @@
+@import "doc/contentLayout/contentLayout.css";

package/src/modules/doc/lwcReferenceLayout/lwcReferenceLayout.html

@@ -0,0 +1 @@
+<template></template>

package/src/modules/doc/lwcReferenceLayout/lwcReferenceLayout.ts

@@ -0,0 +1,8 @@
+import ContentLayout from "doc/contentLayout";
+import contentLayoutHTML from 'doc/contentLayout/contentLayout.html'
+
+export default class LWCReferenceLayout extends ContentLayout {
+    render(){
+        return contentLayoutHTML
+    }
+}

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

@@ -17,6 +17,7 @@ import { LightningElementWithState } from "docBaseElements/lightningElementWithS
 import { oldVersionDocInfo } from "docUtils/utils";
 import { Breadcrumb, DocPhaseInfo, Language } from "typings/custom";
 import { track as trackGTM } from "dxUtils/analytics";
+import { CoveoAnalyticsClient } from "coveo.analytics";
 
 // TODO: Imitating from actual implementation as doc-content use it like this. We should refactor it later.
 const handleContentError = (error): void => console.log(error);
@@ -34,6 +35,7 @@ export default class DocXmlContent extends LightningElementWithState<{
     @api apiDomain = "https://developer.salesforce.com";
     @api coveoOrganizationId!: string;
     @api coveoPublicAccessToken!: string;
+    @api coveoAnalyticsToken!: string;
     @api coveoSearchHub!: string;
 
     @api
@@ -434,6 +436,19 @@ export default class DocXmlContent extends LightningElementWithState<{
         );
     }
 
+    async logCoveoPageView() {
+        if (this.coveoOrganizationId && this.coveoAnalyticsToken) {
+            const ua = new CoveoAnalyticsClient({
+                token: this.coveoAnalyticsToken,
+                endpoint: `https://${this.coveoOrganizationId}.analytics.org.coveo.com`
+            }); // MILES TODO: replace 'fullsalesforce' with coveo organizationid
+            ua.sendViewEvent({
+                contentIdKey: "@clickableuri",
+                contentIdValue: window.location.href
+            });
+        }
+    }
+
     async fetchDocument(): Promise<void> {
         this.setState({
             isFetchingDocument: true
@@ -498,6 +513,7 @@ export default class DocXmlContent extends LightningElementWithState<{
     }
 
     async fetchContent(): Promise<void> {
+        this.logCoveoPageView();
         this.setState({
             isFetchingContent: true
         });

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.