@salesforcedevs/docs-components 1.3.173 → 1.3.177

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "1.3.173",
+    "version": "1.3.177",
     "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": "85f6ef2fd7789804c470b862101492739432cc04"
+    "gitHead": "fd34f6d2447461ef0dd93045c8df04cf090b97f2"
 }

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

@@ -4,6 +4,7 @@
         class="content-type content-type-reference"
         coveo-organization-id={coveoOrganizationId}
         coveo-public-access-token={coveoPublicAccessToken}
+        coveo-analytics-token={coveoAnalyticsToken}
         coveo-search-hub={coveoSearchHub}
         coveo-advanced-query-config={coveoAdvancedQueryConfig}
         breadcrumbs={breadcrumbs}

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

@@ -4,7 +4,6 @@ import { sentenceCase } from "sentence-case";
 import qs from "query-string";
 import { AmfModelParser } from "doc/amfModelParser";
 import { normalizeBoolean } from "dxUtils/normalizers";
-import { CoveoAnalyticsClient } from "coveo.analytics";
 import type {
     AmfConfig,
     AmfMetadataTopic,
@@ -225,19 +224,6 @@ 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
@@ -941,8 +927,6 @@ export default class AmfReference extends LightningElement {
         this.handleSelectedItem();
 
         this.updateDocPhase();
-
-        this.logCoveoPageView();
     }
 
     /**
@@ -1204,8 +1188,6 @@ export default class AmfReference extends LightningElement {
         if (referenceItem) {
             window.location.href = referenceItem.href;
         }
-
-        this.logCoveoPageView();
     }
 
     /**
@@ -1298,8 +1280,6 @@ export default class AmfReference extends LightningElement {
             }
             this.updateDocPhase();
             this.selectedSidebarValue = window.location.pathname;
-
-            this.logCoveoPageView();
         }
     }
 

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

@@ -4,6 +4,7 @@ import { closest } from "kagekiri";
 import { toJson } from "dxUtils/normalizers";
 import { highlightTerms } from "dxUtils/highlight";
 import { SearchSyncer } from "docUtils/searchSyncer";
+import { CoveoAnalyticsClient } from "coveo.analytics";
 
 type AnchorMap = { [key: string]: { intersect: boolean; id: string } };
 
@@ -32,9 +33,11 @@ export default class ContentLayout extends LightningElement {
     @api enableSlotChange = false;
     @api coveoOrganizationId!: string;
     @api coveoPublicAccessToken!: string;
+    @api coveoAnalyticsToken!: string;
     @api coveoSearchHub!: string;
     @api coveoAdvancedQueryConfig!: string;
     @api useOldSidebar?: boolean = false;
+    @api logCoveoPageViewOnlyOnConnect: boolean = false;
 
     @api
     get breadcrumbs() {
@@ -127,6 +130,19 @@ export default class ContentLayout 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
+            });
+        }
+    }
+
     connectedCallback(): void {
         const hasParentHighlightListener = closest(
             "doc-xml-content",
@@ -139,6 +155,9 @@ export default class ContentLayout extends LightningElement {
             );
             this.searchSyncer.init();
         }
+        if (this.logCoveoPageViewOnlyOnConnect) {
+            this.logCoveoPageView();
+        }
     }
 
     renderedCallback(): void {
@@ -159,6 +178,8 @@ export default class ContentLayout extends LightningElement {
         if (!this.hasRendered) {
             this.hasRendered = true;
             this.restoreScroll();
+        } else if (!this.logCoveoPageViewOnlyOnConnect) {
+            this.logCoveoPageView();
         }
     }
 

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

@@ -3,6 +3,7 @@
         if:true={loaded}
         coveo-organization-id={coveoOrganizationId}
         coveo-public-access-token={coveoPublicAccessToken}
+        coveo-analytics-token={coveoAnalyticsToken}
         coveo-search-hub={coveoSearchHub}
         coveo-advanced-query-config={coveoAdvancedQueryConfig}
         sidebar-header="Pages"

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

@@ -16,7 +16,6 @@ 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";
 import { SearchSyncer } from "docUtils/searchSyncer";
 
 // TODO: Imitating from actual implementation as doc-content use it like this. We should refactor it later.
@@ -438,19 +437,6 @@ 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
@@ -515,7 +501,6 @@ export default class DocXmlContent extends LightningElementWithState<{
     }
 
     async fetchContent(): Promise<void> {
-        this.logCoveoPageView();
         this.setState({
             isFetchingContent: true
         });