@salesforcedevs/docs-components 1.3.150 → 1.3.155

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "1.3.150",
+    "version": "1.3.155",
     "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": "49e14e97f56c7c2978f7dc7e8609ec921344e939"
 }

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/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
         });