@salesforcedevs/docs-components 1.3.221 → 1.3.227

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "1.3.221",
+    "version": "1.3.227",
     "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": "eca6f0494621686d4b7c408a316e8b230b09b6dc"
+    "gitHead": "ca4d2f11924db69bc1e872fb61587af9bb78cdde"
 }

package/src/modules/doc/amfReference/amfReference.html

@@ -1,5 +1,6 @@
 <template>
     <doc-content-layout
+        if:true={isVersionFetched}
         use-old-sidebar={useOldSidebar}
         class="content-type content-type-reference"
         coveo-organization-id={coveoOrganizationId}

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 "doc/amfModelParser";
-import { normalizeBoolean } from "dxUtils/normalizers";
+import { normalizeBoolean, toJson } from "dxUtils/normalizers";
 import type {
     AmfConfig,
     AmfMetadataTopic,
@@ -43,7 +43,6 @@ export default class AmfReference extends LightningElement {
     @api coveoOrganizationId!: string;
     @api coveoPublicAccessToken!: string;
     @api coveoAnalyticsToken!: string;
-    @api coveoAdvancedQueryConfig!: string;
     @api coveoSearchHub!: string;
     @api useOldSidebar: boolean = false;
     @api tocTitle?: string;
@@ -51,6 +50,7 @@ export default class AmfReference extends LightningElement {
     @track navigation = [] as NavigationItem[];
     @track versions: Array<ReferenceVersion> = [];
     @track showVersionBanner = false;
+    @track _coveoAdvancedQueryConfig!: { [key: string]: any };
 
     // Update this to update what component gets rendered in the content block
     @track
@@ -114,12 +114,14 @@ export default class AmfReference extends LightningElement {
                 this.versions = this.getVersions();
             }
             this.selectedVersion = selectedVersion;
-            if (
-                this.isSpecBasedReference(this._currentReferenceId) &&
-                this.oldVersionInfo
-            ) {
-                this.showVersionBanner = true;
+            if (this.isSpecBasedReference(this._currentReferenceId)) {
+                this.isVersionFetched = true;
+                if (this.oldVersionInfo) {
+                    this.showVersionBanner = true;
+                }
             }
+        } else {
+            this.isVersionFetched = true;
         }
 
         // This is to check if the url is hash based and redirect if needed
@@ -152,6 +154,31 @@ export default class AmfReference extends LightningElement {
         this._expandChildren = normalizeBoolean(value);
     }
 
+    /*
+     * The get coveoAdvancedQueryConfig() method returns this._coveoAdvancedQueryConfig,
+     * but before returning it, it checks if there are multiple versions (this.versions.length > 1)
+     * and if a version is selected (this.selectedVersion). If both conditions are met,
+     * it updates the version property of this._coveoAdvancedQueryConfig with the selected version.
+     */
+    @api
+    get coveoAdvancedQueryConfig(): { [key: string]: any } {
+        const coveoConfig = this._coveoAdvancedQueryConfig;
+        if (this.versions.length > 1 && this.selectedVersion) {
+            const currentGAVersionRef = this.versions[0];
+            if (this.selectedVersion.id !== currentGAVersionRef.id) {
+                // Currently Coveo only supports query without "v"
+                const version = this.selectedVersion.id.replace("v", "");
+                coveoConfig.version = version;
+                this._coveoAdvancedQueryConfig = coveoConfig;
+            }
+        }
+        return this._coveoAdvancedQueryConfig;
+    }
+
+    set coveoAdvancedQueryConfig(config) {
+        this._coveoAdvancedQueryConfig = toJson(config);
+    }
+
     // model
     protected _amfConfigList: AmfConfig[] = [];
     protected _amfConfigMap: Map<string, AmfConfig> = new Map();
@@ -172,6 +199,7 @@ export default class AmfReference extends LightningElement {
     private isParentLevelDocPhaseEnabled = false;
     private selectedReferenceDocPhase?: string | null = null;
     private _expandChildren?: boolean = false;
+    private isVersionFetched = false;
 
     /**
      * Key for storing the currently selected reference url. This will be used to save the
@@ -1284,6 +1312,7 @@ export default class AmfReference extends LightningElement {
                 this.showVersionBanner = true;
             }
 
+            this.isVersionFetched = true;
             this.updateDocPhase();
             this.selectedSidebarValue = window.location.pathname;
         }