@salesforcedevs/docs-components 1.3.175 → 1.3.178-canary.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "1.3.175",
+    "version": "1.3.178-canary.0",
     "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": "5417c0fa28a39ac5c1cade341f447a38a9d7da54"
+    "gitHead": "4629fdd9ca18a13480044ad43515b91945d16aad"
 }

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

@@ -12,12 +12,11 @@ import {
     PageReference,
     TocMap
 } from "./types";
-import { LightningElementWithState } from "docBaseElements/lightningElementWithState";
+import { SearchSyncer } from "docUtils/searchSyncer";
+import { LightningElementWithState } from "dxBaseElements/lightningElementWithState";
 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.
 const handleContentError = (error: any): void => console.log(error);
@@ -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
         });

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.

package/src/modules/docBaseElements/lightningElementWithState/lightningElementWithState.ts

@@ -1,93 +0,0 @@
-import { LightningElement, track } from "lwc";
-
-/**
- * This is a helper class for when you want your LWC component to have state
- * that is automatically tracked _along with_ its previous state, in a React-
- * like fashion, so that you can compare current state with previous state
- * after a render (like React's `commponentDidUpdate`). One benefit of doing
- * things this way is that you can put all of your reactions to state changes
- * in one place, in `renderedCallback`, rather than having them in various
- * places throughout the component.
- *
- * The API consists in `this.prevState`, `this.state`, and `this.setState`.
- *
- * Usage:
- *
- * ```
- * type MyState = {
- *     isFetchingContent: boolean;
- * };
- *
- * class MyFetchingComponent extends LightningElementWithState<MyState> {
- *     constructor() {
- *         // `this.state` can only be initialized once
- *         this.state = {
- *             isFetchingContent: false
- *         };
- *     }
- *
- *     // Queued for execution whenever a `setState` call completes
- *     renderedCallback() {
- *         if (this.prevState.isFetchingContent && !this.state.isFetchingContent) {
- *             // Do something knowing that we just finished fetching.
- *             notifyFetchSuccessful();
- *         }
- *     }
- *
- *     fetchSomething() {
- *         this.setState({
- *             isFetchingContent: true
- *         });
- *
- *         fetch(whatever).then(() => {
- *             this.setState({
- *                 isFetching: false
- *             }
- *         });
- *     }
- * }
- * ```
- */
-export abstract class LightningElementWithState<
-    T extends { [key: string]: unknown }
-> extends LightningElement {
-    private _prevState = {} as T;
-    @track private _state = {} as T;
-
-    private _didInitializeState = false;
-
-    protected get prevState(): T {
-        return Object.freeze({
-            ...this._prevState
-        });
-    }
-
-    protected get state(): T {
-        return Object.freeze({
-            ...this._state
-        });
-    }
-
-    protected set state(initialState: T) {
-        if (!this._didInitializeState) {
-            this._state = {
-                ...initialState
-            };
-            this._didInitializeState = true;
-        } else {
-            throw new Error(
-                "To mutate state after initialization, use `this.setState`."
-            );
-        }
-    }
-
-    protected setState = (state: Partial<T>): void => {
-        this._prevState = {
-            ...this._state
-        };
-        this._state = {
-            ...this._state,
-            ...state
-        };
-    };
-}