@salesforcedevs/docs-components 1.3.194-search1-alpha → 1.3.194-search2-alpha

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "1.3.194-search1-alpha",
+    "version": "1.3.194-search2-alpha",
     "description": "Docs Lightning web components for DSC",
     "license": "MIT",
     "main": "index.js",

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

@@ -185,12 +185,10 @@ export default class AmfReference extends LightningElement {
     constructor() {
         super();
 
-        this._boundOnApiNavigationChanged = this.onApiNavigationChanged.bind(
-            this
-        );
-        this._boundUpdateSelectedItemFromUrlQuery = this.updateSelectedItemFromUrlQuery.bind(
-            this
-        );
+        this._boundOnApiNavigationChanged =
+            this.onApiNavigationChanged.bind(this);
+        this._boundUpdateSelectedItemFromUrlQuery =
+            this.updateSelectedItemFromUrlQuery.bind(this);
     }
 
     connectedCallback(): void {
@@ -246,9 +244,8 @@ export default class AmfReference extends LightningElement {
                 const updatedReferenceId =
                     oldReferenceIdNewReferenceIdMap[referenceId];
                 const newReferenceId = updatedReferenceId || referenceId;
-                const referenceItemConfig = this.getAmfConfigWithId(
-                    newReferenceId
-                );
+                const referenceItemConfig =
+                    this.getAmfConfigWithId(newReferenceId);
                 if (referenceItemConfig) {
                     hashBasedRedirectUrl = `${referenceItemConfig.href}?meta=${encodedMeta}`;
                 }
@@ -328,9 +325,8 @@ export default class AmfReference extends LightningElement {
                 for (let i = 0; i < allVersions.length; i++) {
                     const versionItem = allVersions[i];
                     const referenceLink = versionItem.link.href;
-                    const referenceId = this.getReferenceIdFromUrl(
-                        referenceLink
-                    );
+                    const referenceId =
+                        this.getReferenceIdFromUrl(referenceLink);
                     if (this._currentReferenceId === referenceId) {
                         // This is to navigate to respective topic in the changed version
                         versionItem.link.href = `${referenceLink}/${currentRefMeta}`;
@@ -844,9 +840,8 @@ export default class AmfReference extends LightningElement {
             this._currentReferenceId
         );
         if (specBasedReference) {
-            const currentMeta:
-                | RouteMeta
-                | undefined = this.getReferenceMetaInfo(window.location.href);
+            const currentMeta: RouteMeta | undefined =
+                this.getReferenceMetaInfo(window.location.href);
             const metadata =
                 currentMeta && this.getMetadataByUrlQuery(currentMeta);
             if (metadata) {
@@ -1272,12 +1267,10 @@ export default class AmfReference extends LightningElement {
         }
         if (!isRedirecting) {
             const currentReferenceUrl = window.location.href;
-            const referenceMeta = this.getMarkdownReferenceMeta(
-                currentReferenceUrl
-            );
-            const selectedItemRefId = this.getReferenceIdFromUrl(
-                currentReferenceUrl
-            );
+            const referenceMeta =
+                this.getMarkdownReferenceMeta(currentReferenceUrl);
+            const selectedItemRefId =
+                this.getReferenceIdFromUrl(currentReferenceUrl);
             const referenceDetails = this.getRefDetailsForGivenTopicMeta(
                 selectedItemRefId,
                 referenceMeta
@@ -1321,6 +1314,8 @@ export default class AmfReference extends LightningElement {
         const metaNavTitle = document.querySelector('meta[name="nav-title"]');
         // eslint-disable-next-line @lwc/lwc/no-document-query
         const titleTag = document.querySelector("title");
+        const TITLE_SEPARATOR = " | ";
+
         if (metaNavTitle) {
             metaNavTitle.setAttribute("content", navTitle);
         }
@@ -1332,16 +1327,32 @@ export default class AmfReference extends LightningElement {
          * If a Ref spec is chosen, we add the value of the <selected topic> to the title.
          * If a subsection is selected, we update the first part of the current
          * title with the new <selected topic>.
+         * Example: Following is a sample project structure.
+         * - Project Name
+         *  - Ref Spec1
+         *      - Summary
+         *      - Endpoints
+         *          - E1
+         *          - E2
+         *  - Ref Spec2
+         *      - Summary
+         *      - Endpoints
+         *          - E1 (Selected)
+         *          - E2
+         * Previous Title: Ref Spec2 | Project Name | Salesforce Developer
+         * New Title: E1 | Ref Spec2 | Project Name | Salesforce Developer
+         *
          */
         if (titleTag) {
             let titleTagValue = titleTag.textContent;
-            const titleTagSectionValues: string[] = titleTagValue?.split(" | ");
+            const titleTagSectionValues: string[] =
+                titleTagValue?.split(TITLE_SEPARATOR);
             if (titleTagSectionValues) {
                 if (titleTagSectionValues.length <= 3) {
-                    titleTagValue = navTitle + " | " + titleTagValue;
+                    titleTagValue = navTitle + TITLE_SEPARATOR + titleTagValue;
                 } else {
                     titleTagSectionValues[0] = navTitle;
-                    titleTagValue = titleTagSectionValues.join(" | ");
+                    titleTagValue = titleTagSectionValues.join(TITLE_SEPARATOR);
                 }
             }
             titleTag.textContent = titleTagValue;
@@ -1352,9 +1363,8 @@ export default class AmfReference extends LightningElement {
         const name = event.detail.name;
         if (name) {
             const urlReferenceId = this.getReferenceIdFromUrl(name);
-            const specBasedReference = this.isSpecBasedReference(
-                urlReferenceId
-            );
+            const specBasedReference =
+                this.isSpecBasedReference(urlReferenceId);
             if (specBasedReference) {
                 const metaVal = this.getMetaFromUrl(name);
                 const currentSelectedMeta = this.selectedTopic
@@ -1409,9 +1419,8 @@ export default class AmfReference extends LightningElement {
             const currentReferenceId = this.getReferenceIdFromUrl(currentUrl);
             //No need to do anything if user is expanding currently selected reference
             if (referenceId !== currentReferenceId) {
-                const isSpecBasedReference = this.isSpecBasedReference(
-                    referenceId
-                );
+                const isSpecBasedReference =
+                    this.isSpecBasedReference(referenceId);
                 if (isSpecBasedReference) {
                     // Perform functionality same as item selection
                     this.onNavSelect(event);