@salesforcedevs/docs-components 1.3.49 → 1.3.50

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "1.3.49",
+    "version": "1.3.50",
     "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": "13454336d298fe5fad2971fd82e0da5760af2d85"
+    "gitHead": "4629fdd9ca18a13480044ad43515b91945d16aad"
 }

package/src/modules/doc/amfReference/amfReference.html

@@ -22,6 +22,7 @@
         <div slot="sidebar-header" class="version-picker">
             <template if:true={isVersionEnabled}>
                 <dx-dropdown
+                    suppress-gtm-nav-headings
                     onchange={handleVersionChange}
                     data-type="version"
                     options={versions}

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

@@ -1,6 +1,6 @@
 import { track } from "dxUtils/analytics";
 import { LightningElement, api } from "lwc";
-import { BreadcrumbItemVariant } from "typings/custom";
+import { AnalyticsPayload, BreadcrumbItemVariant } from "typings/custom";
 
 const BREADCRUMB_LONG = "breadcrumb_long";
 const BREADCRUMB_BACK_ARROW = "breadcrumb_back-arrow";
@@ -8,7 +8,8 @@ const BREADCRUMB_BACK_ARROW = "breadcrumb_back-arrow";
 const LONG_LABEL_NUMBER = 30;
 export default class BreadcrumbItem extends LightningElement {
     @api href?: string;
-    @api level?: string;
+    @api analyticsEvent!: string;
+    @api analyticsBasePayload!: AnalyticsPayload;
 
     @api
     get label() {
@@ -50,13 +51,14 @@ export default class BreadcrumbItem extends LightningElement {
     }
 
     private onLinkClick(event: Event): void {
-        track(event.target!, "custEv_breadcrumbClick", {
+        if (!this.analyticsEvent) {
+            return;
+        }
+
+        track(event.target!, this.analyticsEvent, {
+            ...this.analyticsBasePayload,
             clickText: this.label,
-            clickUrl: this.href,
-            elementType: "link",
-            navType: "breadcrumb",
-            navLevel: this.level ? this.level + 1 : 1,
-            navItem: this.label
+            clickUrl: this.href
         });
     }
 }

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

@@ -3,18 +3,21 @@
         <template if:true={displayCrumbs}>
             <template if:false={renderSmallVariant}>
                 <doc-breadcrumb-item
+                    analytics-event={analyticsEventName}
+                    analytics-base-payload={analyticsBasePayload}
                     href={firstCrumb.href}
                     label={firstCrumb.label}
                 ></doc-breadcrumb-item>
                 <span class="breadcrumb-item_slash">/</span>
                 <template if:true={renderDropdown}>
                     <dx-dropdown
-                        analytics-event="custEv_breadcrumbClick"
-                        analytics-payload={ANALYTICS_PAYLOAD}
                         if:true={renderDropdown}
+                        analytics-event={analyticsEventName}
+                        analytics-base-payload={analyticsBasePayload}
                         options={dropdownOptions}
                         open-on-hover
                         placement="bottom"
+                        suppress-gtm-nav-headings
                         variant="indented"
                         width="fit-content"
                     >
@@ -29,10 +32,11 @@
                 </template>
                 <template for:each={breadcrumbItems} for:item="breadcrumb">
                     <doc-breadcrumb-item
+                        analytics-event={analyticsEventName}
+                        analytics-base-payload={analyticsBasePayload}
                         href={breadcrumb.href}
                         key={breadcrumb.id}
                         label={breadcrumb.label}
-                        level={breadcrumb.level}
                     ></doc-breadcrumb-item>
                     <span class="breadcrumb-item_slash" key={breadcrumb.label}>
                         /
@@ -44,6 +48,8 @@
             </template>
             <template if:true={renderSmallVariant}>
                 <doc-breadcrumb-item
+                    analytics-event={analyticsEventName}
+                    analytics-base-payload={analyticsBasePayload}
                     href={lastLinkCrump.href}
                     label={lastLinkCrump.label}
                     variant="back-arrow"

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

@@ -17,6 +17,11 @@ const CONSTANTS = {
     dropdownWidth: 32
 };
 
+export const ANALYTICS_EVENT_NAME = "custEv_breadcrumbNavClick";
+export const ANALYTICS_BASE_PAYLOAD = {
+    navType: "breadcrumb"
+};
+
 export default class Breadcrumbs extends LightningElement {
     @api ariaLabel: string = "Documentation Breadcrumbs";
 
@@ -97,12 +102,14 @@ export default class Breadcrumbs extends LightningElement {
         return this.breadcrumbs[this.breadcrumbs.length - 1];
     }
 
-    // this payload is only used for breadcrumb dropdown
-    private get ANALYTICS_PAYLOAD() {
+    private get analyticsEventName() {
+        return ANALYTICS_EVENT_NAME;
+    }
+
+    private get analyticsBasePayload() {
         return {
-            elementType: "link",
-            navType: "breadcrumb",
-            navLevel: 1
+            ...ANALYTICS_BASE_PAYLOAD,
+            navItem: this.breadcrumbs.map((crumb) => crumb.label).join("/")
         };
     }
 
@@ -130,13 +137,10 @@ export default class Breadcrumbs extends LightningElement {
             return;
         }
 
-        this._breadcrumbs = toJson(breadcrumbs).map(
-            (crumb: Breadcrumb, index: number) => ({
-                ...crumb,
-                id: crumb.id || crumb.href,
-                level: index
-            })
-        );
+        this._breadcrumbs = toJson(breadcrumbs).map((crumb: Breadcrumb) => ({
+            ...crumb,
+            id: crumb.id || crumb.href
+        }));
     }
 
     private updateDropdownOptionAmount(): void {

package/src/modules/doc/xmlContent/xmlContent.html

@@ -14,8 +14,8 @@
         <div slot="sidebar-header" class="document-pickers">
             <dx-dropdown
                 data-type="version"
-                analytics-event="custEv_ctaLinkClick"
-                analytics-payload={ANALYTICS_PAYLOAD}
+                suppress-gtm-nav-headings
+                analytics-event={analyticsEvent}
                 options={versionOptions}
                 value={version.id}
                 width="290px"

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

@@ -63,6 +63,7 @@ export default class DocXmlContent extends LightningElementWithState<{
     private sidebarContent: Array<TreeNode> = null;
     private version: DocVersion = null;
     private docTitle = "";
+    private analyticsEvent = "custEv_ctaLinkClick";
     private _pathName = "";
     private _pageHeader?: Header;
     private listenerAttached = false;
@@ -280,13 +281,6 @@ export default class DocXmlContent extends LightningElementWithState<{
         );
     }
 
-    private get ANALYTICS_PAYLOAD() {
-        return {
-            elementTitle: "version picker",
-            contentCategory: "cta"
-        };
-    }
-
     private handlePopState = (): void =>
         this.updatePageReference(this.getReferenceFromUrl());
 

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.