@salesforcedevs/docs-components 1.3.190-alpha → 1.3.192

package/LICENSE

@@ -0,0 +1,12 @@
+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/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "1.3.190-alpha",
+    "version": "1.3.192",
     "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": "4629fdd9ca18a13480044ad43515b91945d16aad"
+    "gitHead": "2f99b05c7c6a70442b1e373e3c41486a0b354ed8"
 }

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

@@ -27,7 +27,7 @@ import {
 } from "./constants";
 import { restoreScroll } from "dx/scrollManager";
 import { DocPhaseInfo } from "typings/custom";
-import { oldVersionDocInfo } from "docUtils/utils";
+import { logCoveoPageView, oldVersionDocInfo } from "docUtils/utils";
 
 type NavigationItem = {
     label: string;
@@ -822,6 +822,7 @@ export default class AmfReference extends LightningElement {
         if (meta) {
             // update the encoded url meta param
             const encodedMeta = this.getUrlEncoded(meta);
+
             window.history.replaceState(
                 window.history.state,
                 "",
@@ -1155,6 +1156,7 @@ export default class AmfReference extends LightningElement {
                         "",
                         selectedItemMetaData.meta
                     );
+
                     this.updateUrlWithSelected(
                         selectedItemMetaData.parentReferencePath,
                         selectedItemMetaData.meta
@@ -1198,6 +1200,9 @@ export default class AmfReference extends LightningElement {
      */
 
     private loadMarkdownBasedReference(referenceUrl?: string | null): void {
+        // MILES TODO: figure out if we ever need to log a coveo page view in here
+        // this would be the case if at some point we 'load' a new 'markdown based reference'
+        // without actually triggering a page load
         let referenceId = "";
         const currentUrl = window.location.href;
         if (this.isProjectRootPath()) {
@@ -1278,6 +1283,7 @@ export default class AmfReference extends LightningElement {
             if (this.oldVersionInfo) {
                 this.showVersionBanner = true;
             }
+
             this.updateDocPhase();
             this.selectedSidebarValue = window.location.pathname;
         }
@@ -1341,6 +1347,11 @@ export default class AmfReference extends LightningElement {
                         elementId,
                         metaVal
                     );
+
+                    logCoveoPageView(
+                        this.coveoOrganizationId,
+                        this.coveoAnalyticsToken
+                    );
                     this.updateUrlWithSelected(parentReferencePath, metaVal);
                     this.updateNavTitleMetaTag(metadata.navTitle);
                 } else {

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

@@ -4,7 +4,6 @@ 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 } };
 
@@ -37,7 +36,6 @@ export default class ContentLayout extends LightningElement {
     @api coveoSearchHub!: string;
     @api coveoAdvancedQueryConfig!: string;
     @api useOldSidebar?: boolean = false;
-    @api logCoveoPageViewOnlyOnConnect: boolean = false;
 
     @api
     get breadcrumbs() {
@@ -130,19 +128,6 @@ 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",
@@ -155,9 +140,6 @@ export default class ContentLayout extends LightningElement {
             );
             this.searchSyncer.init();
         }
-        if (this.logCoveoPageViewOnlyOnConnect) {
-            this.logCoveoPageView();
-        }
     }
 
     renderedCallback(): void {
@@ -178,8 +160,6 @@ export default class ContentLayout extends LightningElement {
         if (!this.hasRendered) {
             this.hasRendered = true;
             this.restoreScroll();
-        } else if (!this.logCoveoPageViewOnlyOnConnect) {
-            this.logCoveoPageView();
         }
     }
 

package/src/modules/doc/header/header.css

@@ -103,6 +103,6 @@ header:not(.has-brand) > .header_l2 {
     }
 
     .has-scoped-nav-items .header_l2_group-title {
-        border-bottom: 1px solid var(--dx-g-gray-90);
+        border-bottom: 1px solid var(--dx-g-brand-current-color-border-2);
     }
 }

package/src/modules/doc/header/header.html

@@ -1,6 +1,6 @@
 <template>
     <template if:true={shouldRender}>
-        <dx-brand-theme-provider>
+        <dx-brand-theme-provider brand={brand}>
             <header class={className}>
                 <dx-banner
                     if:true={showBanner}

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

@@ -14,7 +14,7 @@ import {
 } from "./types";
 import { SearchSyncer } from "docUtils/searchSyncer";
 import { LightningElementWithState } from "dxBaseElements/lightningElementWithState";
-import { oldVersionDocInfo } from "docUtils/utils";
+import { logCoveoPageView, oldVersionDocInfo } from "docUtils/utils";
 import { Breadcrumb, DocPhaseInfo, Language } from "typings/custom";
 import { track as trackGTM } from "dxUtils/analytics";
 
@@ -558,6 +558,7 @@ export default class DocXmlContent extends LightningElementWithState<{
     }
 
     updateUrl(method = HistoryState.PUSH_STATE): void {
+        logCoveoPageView(this.coveoOrganizationId, this.coveoAnalyticsToken);
         window.history[method](
             {},
             "docs",

package/src/modules/docUtils/utils/utils.ts

@@ -1,3 +1,5 @@
+import { CoveoAnalyticsClient } from "coveo.analytics";
+
 export const oldVersionDocInfo = (latestVersionLink: string) => {
     return {
         title: "Newer Version Available",
@@ -5,3 +7,26 @@ export const oldVersionDocInfo = (latestVersionLink: string) => {
         <a style="font-weight: bold;" href="${latestVersionLink}">View Latest</a>`
     };
 };
+
+export function logCoveoPageView(
+    coveoOrganizationId: string | undefined,
+    coveoAnalyticsToken: string | undefined
+) {
+    if (coveoOrganizationId && coveoAnalyticsToken) {
+        const ua = new CoveoAnalyticsClient({
+            token: coveoAnalyticsToken,
+            endpoint: `https://${coveoOrganizationId}.analytics.org.coveo.com`
+        });
+        const pathParts = window.location.pathname.split("/");
+        let contentType;
+        if (pathParts.length >= 2) {
+            contentType = pathParts[1];
+        }
+
+        ua.sendViewEvent({
+            contentIdKey: "@clickableuri",
+            contentType: contentType,
+            contentIdValue: window.location.href
+        });
+    }
+}