@salesforcedevs/docs-components 0.56.2-seo-test3 → 0.56.2-seo-test6

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "0.56.2-seo-test3",
+    "version": "0.56.2-seo-test6",
     "description": "Docs Lightning web components for DSC",
     "license": "MIT",
     "main": "index.js",

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

@@ -3,6 +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 type {
     AmfConfig,
     AmfMetadataTopic,
@@ -37,7 +38,6 @@ export default class AmfReference extends LightningElement {
     @api tocOptions?: string;
     @track navigation = [];
     @track versions: Array<ReferenceVersion> = [];
-    @api expandChildren?: boolean = false;
 
     // Update this to update what component gets rendered in the content block
     @track
@@ -124,6 +124,15 @@ export default class AmfReference extends LightningElement {
         }
     }
 
+    @api
+    get expandChildren() {
+        return this._expandChildren;
+    }
+
+    set expandChildren(value) {
+        this._expandChildren = normalizeBoolean(value);
+    }
+
     // model
     protected _amfConfigList: AmfConfig[] = [];
     protected _amfConfigMap: Map<string, AmfConfig> = new Map();
@@ -143,6 +152,7 @@ export default class AmfReference extends LightningElement {
 
     private isParentLevelDocPhaseEnabled = false;
     private selectedReferenceDocPhase?: string | null = null;
+    private _expandChildren?: boolean = false;
 
     /**
      * Key for storing the currently selected reference url. This will be used to save the
@@ -441,11 +451,14 @@ export default class AmfReference extends LightningElement {
 
         items.forEach((item) => {
             item.methods?.forEach((method) => {
+                const title =
+                    this.getTitleForLabel(method.label) || method.method;
                 const meta = this.addToMetadata(
                     parentReferencePath,
                     referenceId,
                     "method",
-                    method
+                    method,
+                    title
                 );
                 methodList.push(
                     Object.assign(method, {
@@ -453,8 +466,7 @@ export default class AmfReference extends LightningElement {
                             parentReferencePath,
                             meta
                         ),
-                        label:
-                            this.getTitleForLabel(method.label) || method.method
+                        label: title
                     })
                 );
             });
@@ -499,7 +511,8 @@ export default class AmfReference extends LightningElement {
                             parentReferencePath,
                             referenceId,
                             type,
-                            summary
+                            summary,
+                            label
                         );
                         children.push({
                             label,
@@ -572,7 +585,8 @@ export default class AmfReference extends LightningElement {
                                             parentReferencePath,
                                             referenceId,
                                             type,
-                                            topic
+                                            topic,
+                                            label
                                         );
                                         return {
                                             label: topic.label,
@@ -601,7 +615,8 @@ export default class AmfReference extends LightningElement {
         parentReferencePath: string,
         referenceId: string,
         type: string,
-        topic: { id: string; domId: string }
+        topic: { id: string; domId: string },
+        navTitle: string
     ): string | undefined {
         const { urlIdentifer, prefix } = URL_CONFIG[type];
 
@@ -619,7 +634,8 @@ export default class AmfReference extends LightningElement {
                 amfId: topic.id,
                 elementId: topic.domId,
                 identifier,
-                type
+                type,
+                navTitle
             };
         }
         return meta;
@@ -925,46 +941,56 @@ export default class AmfReference extends LightningElement {
     }
 
     /**
-     * Finds and returns referenceUrl if given topic url matches
+     * Finds and returns referenceUrl and topicTitle if given topic url matches
      */
-    getReferenceUrlInGivenTopics(
+    getReferenceDetailsInGivenTopics(
         topics: ParsedMarkdownTopic[],
         topicMeta: string
-    ): string {
+    ): { referenceUrl: string; topicTitle: string } {
         let referenceUrl = "";
+        let topicTitle = "";
         for (let i = 0; i < topics.length; i++) {
             const topic = topics[i];
             const meta = this.getMarkdownReferenceMeta(topic.link.href);
             const childTopics = topic.children;
             if (meta === topicMeta) {
                 referenceUrl = topic.link.href;
+                topicTitle = topic.label;
             } else if (childTopics && childTopics.length) {
-                referenceUrl = this.getReferenceUrlInGivenTopics(
+                const referenceDetails = this.getReferenceDetailsInGivenTopics(
                     childTopics,
                     topicMeta
                 );
+                referenceUrl = referenceDetails.referenceUrl;
+                topicTitle = referenceDetails.topicTitle;
             }
-            if (referenceUrl) {
+            if (referenceUrl && topicTitle) {
                 break;
             }
         }
-        return referenceUrl;
+        return {
+            referenceUrl,
+            topicTitle
+        };
     }
 
     /**
-     * Gives referenceUrl for given markdown topic url
+     * Gives referenceUrl and topicTitle for given markdown topic url
      */
-    getRefLinkForGivenTopicMeta(
+    getRefDetailsForGivenTopicMeta(
         referenceId: string,
         topicMeta: string
-    ): string | undefined {
+    ): { referenceUrl: string; topicTitle: string } | undefined {
         const amfConfig = this.getAmfConfigWithId(referenceId);
-        let referenceUrl;
+        let referenceDetails;
         if (amfConfig) {
             const topics = amfConfig.topic?.children || [];
-            referenceUrl = this.getReferenceUrlInGivenTopics(topics, topicMeta);
+            referenceDetails = this.getReferenceDetailsInGivenTopics(
+                topics,
+                topicMeta
+            );
         }
-        return referenceUrl;
+        return referenceDetails;
     }
 
     /**
@@ -1020,6 +1046,7 @@ export default class AmfReference extends LightningElement {
                         referenceId,
                         "summary"
                     );
+                    this.updateNavTitleMetaTag(selectedItemMetaData.navTitle);
                 }
 
                 if (selectedItemMetaData) {
@@ -1035,15 +1062,17 @@ export default class AmfReference extends LightningElement {
                         selectedItemMetaData.parentReferencePath,
                         selectedItemMetaData.meta
                     );
+                    this.updateNavTitleMetaTag(selectedItemMetaData.navTitle);
                 }
             });
         } else {
             let invalidTopicReferenceUrl = "";
             if (topicId) {
-                const selectedItemUrl = this.getRefLinkForGivenTopicMeta(
+                const referenceDetails = this.getRefDetailsForGivenTopicMeta(
                     referenceId,
                     topicId
                 );
+                const selectedItemUrl = referenceDetails?.referenceUrl;
                 if (!selectedItemUrl) {
                     invalidTopicReferenceUrl = previousRefUrlInSession;
                 }
@@ -1073,6 +1102,7 @@ export default class AmfReference extends LightningElement {
 
     private loadMarkdownBasedReference(referenceUrl?: string): void {
         let referenceId = "";
+        let topicTitle;
         const currentUrl = window.location.href;
         if (this.isProjectRootPath()) {
             /**
@@ -1099,10 +1129,12 @@ export default class AmfReference extends LightningElement {
              */
             const referenceMeta = this.getMarkdownReferenceMeta(referenceUrl);
             const selectedItemRefId = this.getReferenceIdFromUrl(referenceUrl);
-            const selectedItemUrl = this.getRefLinkForGivenTopicMeta(
+            const referenceDetails = this.getRefDetailsForGivenTopicMeta(
                 selectedItemRefId,
                 referenceMeta
             );
+            const selectedItemUrl = referenceDetails?.referenceUrl;
+            topicTitle = referenceDetails?.topicTitle;
             if (!selectedItemUrl) {
                 referenceId = this.getReferenceIdFromUrl(referenceUrl);
             }
@@ -1115,6 +1147,7 @@ export default class AmfReference extends LightningElement {
                 const childrenItems = amfConfig.topic.children;
                 if (childrenItems.length > 0) {
                     redirectReferenceUrl = childrenItems[0].link.href;
+                    topicTitle = childrenItems[0].label;
                 }
             }
             if (redirectReferenceUrl) {
@@ -1128,6 +1161,7 @@ export default class AmfReference extends LightningElement {
             }
         }
 
+        this.updateNavTitleMetaTag(topicTitle);
         this.versions = this.getVersions();
 
         this.updateDocPhase();
@@ -1145,6 +1179,15 @@ export default class AmfReference extends LightningElement {
         );
     }
 
+    private updateNavTitleMetaTag(navTitle = ""): void {
+        // this is required to update the nav title meta tag.
+        // eslint-disable-next-line @lwc/lwc/no-document-query
+        const metaNavTitle = document.querySelector('meta[name="nav-title"]');
+        if (metaNavTitle && navTitle) {
+            metaNavTitle.setAttribute("content", navTitle);
+        }
+    }
+
     onNavSelect(event: CustomEvent): void {
         const name = event.detail.name;
         if (name) {
@@ -1180,6 +1223,7 @@ export default class AmfReference extends LightningElement {
                         metaVal
                     );
                     this.updateUrlWithSelected(parentReferencePath, metaVal);
+                    this.updateNavTitleMetaTag(metadata.navTitle);
                 } else {
                     if (this.isParentReferencePath(name)) {
                         this.loadNewReferenceItem(name);

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

@@ -11,6 +11,7 @@ export interface AmfTopicType {
 export interface AmfMetadataTopic extends AmfTopicType {
     meta: string;
     identifier: string;
+    navTitle?: string;
 }
 
 export interface AmfMetaTopicType extends AmfTopicType {