@salesforcedevs/docs-components 1.3.150-lwf-ref-alpha4 → 1.3.151

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/lwc.config.json

@@ -11,14 +11,12 @@
         "doc/contentCallout",
         "doc/contentLayout",
         "doc/contentMedia",
-        "doc/component",
         "doc/docXmlContent",
         "doc/header",
         "doc/heading",
         "doc/headingAnchor",
         "doc/overview",
         "doc/phase",
-        "doc/styledOrderedList",
         "doc/xmlContent"
     ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "1.3.150-lwf-ref-alpha4",
+    "version": "1.3.151",
     "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": "a18da1e5151467020122ee365fef9f8f189768dd"
 }

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

package/src/modules/doc/component/component.css

@@ -1,32 +0,0 @@
-@import "dxHelpers/reset";
-
-h2 {
-    font-weight: bold;
-    font-size: 24px;
-    margin-top: 10px;
-    margin-bottom: 10px;
-}
-
-.component-image {
-    padding: 48px 40px;
-    display: flex;
-    justify-content: center;
-    align-items: center;
-    border: 1px solid var(--foundation-gray-neutral-95, #f3f3f3);
-    min-height: 140px;
-    max-height: 480px;
-    flex: 1;
-    margin-top: 16px;
-    margin-bottom: 16px;
-}
-
-.small {
-    font-size: 12px;
-}
-
-.item {
-    display: flex;
-    flex: 1;
-    flex-direction: column;
-    justify-content: center;
-}

package/src/modules/doc/component/component.html

@@ -1,11 +0,0 @@
-<template>
-    <div class="item">
-        <h2 if:true={title}>{title}</h2>
-        <p if:true={description}>{description}</p>
-        <p if:true={doDontLabel}>{doDontLabel}</p>
-        <div if:true={imageSrc} class="component-image">
-            <img src={imageSrc} />
-        </div>
-        <p if:true={note} class="small">{note}</p>
-    </div>
-</template>

package/src/modules/doc/component/component.ts

@@ -1,22 +0,0 @@
-import { LightningElement, api } from "lwc";
-
-class Component extends LightningElement {
-    @api title;
-    @api description;
-    @api imageSrc;
-    @api isDo;
-    @api note;
-
-    @api
-    get doDontLabel(): string {
-        //TODO: store a boolean value and refactor logic
-        if (this.isDo === "true") {
-            return "DO";
-        } else if (this.isDo === "false") {
-            return "DON'T";
-        }
-        return "";
-    }
-}
-
-export default Component;

package/src/modules/doc/styledOrderedList/styledOrderedList.css

@@ -1,35 +0,0 @@
-@import "dxHelpers/reset";
-
-.list {
-    display: flex;
-    flex: 1;
-    flex-direction: column;
-    justify-content: center;
-}
-
-
-.list-item{
-    display: flex;
-    flex-direction: row;
-    justify-content: center;
-    margin-bottom: 2px;
-}
-
-.circle{
-    background: var(--foundation-blue-blue-40, #0B5CAB);
-    height: 24px;
-    width: 24px;
-    border-radius: 50%;
-    justify-content: center;
-    align-items: center;
-    display: flex;
-    color: white;
-    font-size: 10px;
-}
-
-.list-item-content {
-    color: var(--text-default, #181818);
-    font-family: Open Sans;
-    font-size: 16px;
-    margin-left: 16px;
-}

package/src/modules/doc/styledOrderedList/styledOrderedList.html

@@ -1,10 +0,0 @@
-<template>
-    <div class="list">
-        <template for:each={list} for:item="item" for:index="index">
-            <div class="list-item" key={item}>
-                <div class="circle">{index}</div>
-                <p class="list-item-content">{item}</p>
-            </div>
-        </template>
-    </div>
-</template>

package/src/modules/doc/styledOrderedList/styledOrderedList.ts

@@ -1,18 +0,0 @@
-import { LightningElement, api } from "lwc";
-
-class StyledOrderedList extends LightningElement {
-    private _list: Array<string> = [];
-
-    set list(value: string) {
-        if (value) {
-            this._list = JSON.parse(value)
-        }
-    }
-
-    @api
-    get list(): Array<string> {
-        return this._list
-    }
-}
-
-export default StyledOrderedList;