@salesforcedevs/docs-components 1.3.131 → 1.3.138-coveo-alpha1

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "1.3.131",
+    "version": "1.3.138-coveo-alpha1",
     "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": "b685c8d1d050c0fa402922a7435c43ec37a91a0c"
+    "gitHead": "4629fdd9ca18a13480044ad43515b91945d16aad"
 }

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

@@ -3,7 +3,7 @@ import { noCase } from "no-case";
 import { sentenceCase } from "sentence-case";
 import qs from "query-string";
 import { AmfModelParser } from "./utils";
-import { normalizeBoolean } from "dxUtils/normalizers";
+import { normalizeBoolean, toJson } from "dxUtils/normalizers";
 import type {
     AmfConfig,
     AmfMetadataTopic,
@@ -16,7 +16,8 @@ import type {
     ReferenceSetConfig,
     AmfMetaTopicType,
     RouteMeta,
-    ParsedMarkdownTopic
+    ParsedMarkdownTopic,
+    CoveoAdvancedQueryXMLConfig
 } from "./types";
 
 import {
@@ -34,7 +35,6 @@ export default class AmfReference extends LightningElement {
     @api sidebarHeader!: string;
     @api coveoOrganizationId!: string;
     @api coveoPublicAccessToken!: string;
-    @api coveoAdvancedQueryConfig!: string;
     @api coveoSearchHub!: string;
     @api useOldSidebar?: boolean = false;
     @api tocTitle?: string;
@@ -143,6 +143,25 @@ export default class AmfReference extends LightningElement {
         this._expandChildren = normalizeBoolean(value);
     }
 
+    @api
+    set coveoAdvancedQueryConfig(config) {
+        const coveoConfig = toJson(config);
+        if (this.versions.length > 1 && this.selectedVersion) {
+            const currentGAVersionRef = this.versions[0];
+            if (this.selectedVersion.id !== currentGAVersionRef.id) {
+                coveoConfig.version = this.selectedVersion.id;
+            }
+        }
+        this._coveoAdvancedQueryConfig = coveoConfig;
+    }
+
+    get coveoAdvancedQueryConfig(): CoveoAdvancedQueryXMLConfig {
+        console.log(
+            "AMFReference: " + JSON.stringify(this._coveoAdvancedQueryConfig)
+        );
+        return this._coveoAdvancedQueryConfig;
+    }
+
     // model
     protected _amfConfigList: AmfConfig[] = [];
     protected _amfConfigMap: Map<string, AmfConfig> = new Map();
@@ -164,6 +183,8 @@ export default class AmfReference extends LightningElement {
     private selectedReferenceDocPhase?: string | null = null;
     private _expandChildren?: boolean = false;
 
+    protected _coveoAdvancedQueryConfig!: CoveoAdvancedQueryXMLConfig;
+
     /**
      * Key for storing the currently selected reference url. This will be used to save the
      * previously selected reference url and restoring it when changing between reference versions.

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

@@ -8,6 +8,12 @@ export interface AmfTopicType {
     type: string;
 }
 
+export type CoveoAdvancedQueryXMLConfig = {
+    locale?: string;
+    version?: string;
+    topicid?: string;
+};
+
 export interface AmfMetadataTopic extends AmfTopicType {
     meta: string;
     identifier: string;

package/src/modules/doc/breadcrumbItem/breadcrumbItem.ts

@@ -53,7 +53,7 @@ export default class BreadcrumbItem extends LightningElement {
     private onLinkClick(event: Event): void {
         track(event.target!, "custEv_breadcrumbClick", {
             click_text: this.label,
-            click_url: this.href,
+            click_url: `${window.location.origin}${this.href}`,
             element_type: "link",
             nav_type: "breadcrumb",
             nav_level: this.level ? this.level + 1 : 1,
@@ -62,7 +62,7 @@ export default class BreadcrumbItem extends LightningElement {
 
         track(event.target!, "custEv_linkClick", {
             click_text: this.label,
-            click_url: this.href,
+            click_url: `${window.location.origin}${this.href}`,
             element_title: this.label,
             element_type: "link",
             content_category: "cta"

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

@@ -214,13 +214,16 @@ export default class ContentLayout extends LightningElement {
 
         // sync with the browser to account for any reflows that may have happened
         requestAnimationFrame(() => {
+            // ternary is a temporary fix for the global nav height reporting incorrectly on some browsers
             const globalNavHeight =
-                globalNavEl.offsetHeight + contextNavEl.offsetHeight;
-            const docHeaderHeight = docHeaderEl.offsetHeight;
+                (globalNavEl.getBoundingClientRect().height !== 72 ? 0 : 72) +
+                contextNavEl.getBoundingClientRect().height;
+            const docHeaderHeight = docHeaderEl.getBoundingClientRect().height;
             sidebarEl.style.setProperty(
                 "--dx-c-content-sidebar-sticky-top",
                 `${globalNavHeight + docHeaderHeight}px`
             );
+
             docHeaderEl.style.setProperty(
                 "--dx-g-global-header-height",
                 `${globalNavHeight}px`
@@ -234,7 +237,7 @@ export default class ContentLayout extends LightningElement {
                         window.innerWidth < 769
                             ? globalNavHeight +
                               docHeaderHeight +
-                              sidebarEl.offsetHeight
+                              sidebarEl.getBoundingClientRect().height
                             : globalNavHeight + docHeaderHeight
                     }px`
                 );
@@ -247,7 +250,7 @@ export default class ContentLayout extends LightningElement {
                     docHeadingEl.style.scrollMarginTop = `${
                         globalNavHeight +
                         docHeaderHeight +
-                        docPhaseEl.offsetHeight
+                        docPhaseEl.getBoundingClientRect().height
                     }px`;
                 });
 
@@ -259,7 +262,7 @@ export default class ContentLayout extends LightningElement {
                     rightNavBarEl.style.top = `${
                         globalNavHeight +
                         docHeaderHeight +
-                        docPhaseEl.offsetHeight
+                        docPhaseEl.getBoundingClientRect().height
                     }px`;
                 }
             }

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

@@ -40,8 +40,8 @@ header:not(.has-brand) > .header_l2 {
 }
 
 .header_lang-dropdown {
-    --button-primary-color: var(--dx-g-blue-vibrant-50);
-    --button-primary-color-hover: var(--dx-g-blue-vibrant-40);
+    --button-primary-color: var(--dx-g-blue-vibrant-40);
+    --button-primary-color-hover: var(--dx-g-blue-vibrant-30);
 }
 
 .header_lang-dropdown > dx-button {

package/src/modules/doc/header/header.ts

@@ -133,6 +133,7 @@ export default class Header extends HeaderBase {
     private onLangChange(event: CustomEvent<string>): void {
         const { detail } = event;
         this._language = detail;
+
         this.dispatchEvent(new CustomEvent("langchange", { detail }));
     }
 

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

@@ -16,6 +16,7 @@ import { SearchSyncer } from "docUtils/SearchSyncer";
 import { LightningElementWithState } from "docBaseElements/lightningElementWithState";
 import { oldVersionDocInfo } from "docUtils/utils";
 import { Breadcrumb, DocPhaseInfo, Language } from "typings/custom";
+import { track as trackGTM } from "dxUtils/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);
@@ -364,6 +365,17 @@ export default class DocXmlContent extends LightningElementWithState<{
             ({ id }) => id === event.detail
         );
         this.pageReference.docId = this.language.url;
+
+        trackGTM(event.target!, "custEv_ctaLinkClick", {
+            click_text: event.detail,
+            element_title: "language selector",
+            click_url: `${window.location.origin}${this.pageReferenceToString(
+                this.pageReference
+            )}`,
+            element_type: "link",
+            content_category: "cta"
+        });
+
         this.updateUrl();
         this.fetchDocument();
     };

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.