@salesforcedevs/docs-components 0.56.2-comp-flex-ref-1 → 0.56.2-seo-test2

package/package.json

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

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

@@ -37,6 +37,7 @@ export default class AmfReference extends LightningElement {
     @api tocOptions?: string;
     @track navigation = [];
     @track versions: Array<ReferenceVersion> = [];
+    @api expandChildren?: string = null;
 
     // Update this to update what component gets rendered in the content block
     @track
@@ -105,7 +106,7 @@ export default class AmfReference extends LightningElement {
         // This is to check if the url is hash based and redirect if needed
         const redirectUrl = this.getHashBasedRedirectUrl();
         if (redirectUrl) {
-            location.href = redirectUrl;
+            window.location.href = redirectUrl;
         } else {
             this.updateAmfConfigInView();
         }
@@ -377,7 +378,9 @@ export default class AmfReference extends LightningElement {
             navAmfOrder[index] = {
                 label: amfConfig.title,
                 name: amfConfig.href,
-                isExpanded: amfConfig.isSelected,
+                isExpanded:
+                    amfConfig.isSelected ||
+                    this.isExpandChildrenEnabled(amfConfig.id),
                 children: navItemChildren,
                 isChildrenLoading
             };
@@ -386,6 +389,13 @@ export default class AmfReference extends LightningElement {
         this.navigation = navAmfOrder;
     }
 
+    /**
+     * Returns a boolean indicating whether the children should be expanded or not.
+     */
+    private isExpandChildrenEnabled(referenceId: string): boolean {
+        return this.expandChildren && this._currentReferenceId === referenceId;
+    }
+
     /**
      * Stores fetched AMF JSON value.
      * Creates and stores a new AmfModelParser instance for the AMF spec.
@@ -477,6 +487,7 @@ export default class AmfReference extends LightningElement {
         const model = this.amfMap[referenceId].parser.parsedModel;
 
         const children = [];
+        const expandChildren = this.isExpandChildrenEnabled(referenceId);
 
         NAVIGATION_ITEMS.forEach(
             ({ label, name, childrenPropertyName, type }) => {
@@ -519,7 +530,7 @@ export default class AmfReference extends LightningElement {
                                     parentReferencePath,
                                     this.metadata[amfTopicId]?.meta
                                 ),
-                                isExpanded: false,
+                                isExpanded: expandChildren,
                                 children: childTopics
                             });
                         }
@@ -554,7 +565,7 @@ export default class AmfReference extends LightningElement {
                                     parentReferencePath,
                                     this.metadata[amfTopicId]?.meta
                                 ),
-                                isExpanded: false,
+                                isExpanded: expandChildren,
                                 children: model[childrenPropertyName].map(
                                     (topic) => {
                                         const meta = this.addToMetadata(
@@ -591,16 +602,16 @@ export default class AmfReference extends LightningElement {
         referenceId: string,
         type: string,
         topic: { id: string; domId: string }
-    ): string {
+    ): string | undefined {
         const { urlIdentifer, prefix } = URL_CONFIG[type];
 
         // encodeURI to avoid special characters in the URL meta.
         const identifier =
             topic[urlIdentifer] && this.encodeIdentifier(topic[urlIdentifer]);
-
+        let meta;
         // Assuming that there will be an identifier always
         if (identifier) {
-            const meta = prefix ? `${prefix}${identifier}` : `${identifier}`;
+            meta = prefix ? `${prefix}${identifier}` : `${identifier}`;
             this.metadata[meta] = {
                 parentReferencePath,
                 meta,
@@ -610,8 +621,8 @@ export default class AmfReference extends LightningElement {
                 identifier,
                 type
             };
-            return meta;
         }
+        return meta;
     }
 
     /**
@@ -768,7 +779,7 @@ export default class AmfReference extends LightningElement {
      * The API Navigation event will always intend to navigate within the current reference
      * @param event
      */
-    protected onApiNavigationChanged(event: CustomEvent): void {
+    protected onApiNavigationChanged(): void {
         const specBasedReference = this.isSpecBasedReference(
             this._currentReferenceId
         );
@@ -854,7 +865,7 @@ export default class AmfReference extends LightningElement {
         const urlPath = referenceUrl.substring(
             indexOfQueryParam >= 0 ? indexOfQueryParam : referenceUrl.length
         );
-        return this.parseParams(urlPath)["meta"] as string;
+        return this.parseParams(urlPath).meta as string;
     }
 
     /**
@@ -883,6 +894,7 @@ export default class AmfReference extends LightningElement {
      * For markdown based references gets topicId as last html path in the name, meta & type will be empty
      */
     getReferenceMetaInfo(referenceUrl: string): RouteMeta | undefined {
+        let metaReferenceInfo;
         if (referenceUrl) {
             const referenceId = this.getReferenceIdFromUrl(referenceUrl);
             let meta = "";
@@ -902,13 +914,14 @@ export default class AmfReference extends LightningElement {
             } else {
                 topicId = this.getMarkdownReferenceMeta(referenceUrl);
             }
-            return {
+            metaReferenceInfo = {
                 referenceId,
                 meta,
                 topicId,
                 type
             };
         }
+        return metaReferenceInfo;
     }
 
     /**
@@ -946,10 +959,12 @@ export default class AmfReference extends LightningElement {
         topicMeta: string
     ): string | undefined {
         const amfConfig = this.getAmfConfigWithId(referenceId);
+        let referenceUrl;
         if (amfConfig) {
             const topics = amfConfig.topic?.children || [];
-            return this.getReferenceUrlInGivenTopics(topics, topicMeta);
+            referenceUrl = this.getReferenceUrlInGivenTopics(topics, topicMeta);
         }
+        return referenceUrl;
     }
 
     /**
@@ -1045,7 +1060,7 @@ export default class AmfReference extends LightningElement {
         const referenceId = this.getReferenceIdFromUrl(url);
         const referenceItem = this.getAmfConfigWithId(referenceId);
         if (referenceItem) {
-            location.href = referenceItem.href;
+            window.location.href = referenceItem.href;
         }
     }
 
@@ -1105,7 +1120,7 @@ export default class AmfReference extends LightningElement {
             if (redirectReferenceUrl) {
                 if (this.isParentReferencePath(referenceUrl)) {
                     // This is for CASE2 mentioned above, Where we need to navigate user to respective href
-                    location.href = redirectReferenceUrl;
+                    window.location.href = redirectReferenceUrl;
                 } else {
                     // This is for CASE 1,3 and 4 mentioned above, Where we need to update the browser history
                     window.history.replaceState({}, "", redirectReferenceUrl);
@@ -1133,8 +1148,9 @@ export default class AmfReference extends LightningElement {
     onNavSelect(event: CustomEvent): void {
         const name = event.detail.name;
         if (name) {
-            const referenceId = this.getReferenceIdFromUrl(name);
-            const specBasedReference = this.isSpecBasedReference(referenceId);
+            const urlReferenceId = this.getReferenceIdFromUrl(name);
+            const specBasedReference =
+                this.isSpecBasedReference(urlReferenceId);
             if (specBasedReference) {
                 const metaVal = this.getMetaFromUrl(name);
                 const currentSelectedMeta = this.selectedTopic

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

@@ -202,7 +202,7 @@ export default class ContentLayout extends LightningElement {
             for (const headingElement of headingElements) {
                 // Sometimes elements hash is not being set when slot content is wrapped with div
                 headingElement.hash =
-                    headingElement.attributes["hash"]?.nodeValue;
+                    headingElement.attributes.hash?.nodeValue;
             }
             const tocOptions = [];
             for (const headingElement of headingElements) {
@@ -228,6 +228,7 @@ export default class ContentLayout extends LightningElement {
         }
     }
 
+    // eslint-disable-next-line no-undef
     private scrollToHash(headingElements: NodeListOf<Element>): void {
         let { hash } = window.location;
         if (hash) {