@salesforcedevs/docs-components 0.56.2-seo-test11 → 0.56.2-seo-test15

package/package.json

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

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

@@ -220,13 +220,14 @@ export default class AmfReference extends LightningElement {
             if (strippedHashItems.length) {
                 const referenceId = strippedHashItems[0];
                 const meta = strippedHashItems[1];
+                const encodedMeta = this.getUrlEncoded(meta);
                 const updatedReferenceId =
                     oldReferenceIdNewReferenceIdMap[referenceId];
                 const newReferenceId = updatedReferenceId || referenceId;
                 const referenceItemConfig =
                     this.getAmfConfigWithId(newReferenceId);
                 if (referenceItemConfig) {
-                    hashBasedRedirectUrl = `${referenceItemConfig.href}?meta=${meta}`;
+                    hashBasedRedirectUrl = `${referenceItemConfig.href}?meta=${encodedMeta}`;
                 }
             }
         }
@@ -481,7 +482,8 @@ export default class AmfReference extends LightningElement {
         parentReferencePath: string,
         meta: string
     ): string {
-        return meta ? `${parentReferencePath}?meta=${meta}` : "";
+        const encodedMeta = meta ? this.getUrlEncoded(meta) : "";
+        return encodedMeta ? `${parentReferencePath}?meta=${encodedMeta}` : "";
     }
 
     /**
@@ -558,8 +560,8 @@ export default class AmfReference extends LightningElement {
                                 return typeALbl < typeBLbl
                                     ? -1
                                     : typeALbl > typeBLbl
-                                        ? 1
-                                        : 0;
+                                    ? 1
+                                    : 0;
                             });
                         }
                     // eslint-disable-next-line no-fallthrough
@@ -731,10 +733,11 @@ export default class AmfReference extends LightningElement {
         meta?: string
     ): void {
         if (meta) {
+            const encodedMeta = this.getUrlEncoded(meta);
             window.history.pushState(
                 {},
                 "",
-                `${parentReferencePath}?meta=${meta}`
+                `${parentReferencePath}?meta=${encodedMeta}`
             );
         }
     }
@@ -747,10 +750,11 @@ export default class AmfReference extends LightningElement {
         meta?: string
     ): void {
         if (meta) {
+            const encodedMeta = this.getUrlEncoded(meta);
             window.history.replaceState(
                 {},
                 "",
-                `${parentReferencePath}?meta=${meta}`
+                `${parentReferencePath}?meta=${encodedMeta}`
             );
         }
     }
@@ -902,6 +906,18 @@ export default class AmfReference extends LightningElement {
         return meta;
     }
 
+    /**
+     * Gets the encoded url.
+     */
+    getUrlEncoded(url: string) {
+        // if url matches, then return the encoded url.
+        if (decodeURIComponent(url) === url) {
+            return encodeURIComponent(url);
+        }
+        // return the encoded url.
+        return this.getUrlEncoded(decodeURIComponent(url));
+    }
+
     /**
      *
      * @returns RouteMeta object for given referenceUrl
@@ -918,6 +934,10 @@ export default class AmfReference extends LightningElement {
             let type = "";
             if (this.isSpecBasedReference(referenceId)) {
                 meta = this.getMetaFromUrl(referenceUrl);
+                // Always get the meta query param encoded and decode it and store it for internal use
+                // This has 2 advantages,
+                // 1. Supports backward compatible meta query param, so there is no need for redirects.
+                // 2. Supports Prerender and Coveo for their crawling.
                 if (meta) {
                     if (meta.includes(":")) {
                         const metaInfo = meta.split(":");
@@ -1137,7 +1157,7 @@ export default class AmfReference extends LightningElement {
             }
         }
 
-        let isRedirecting = false
+        let isRedirecting = false;
         if (referenceId) {
             const amfConfig = this.getAmfConfigWithId(referenceId);
             let redirectReferenceUrl = "";
@@ -1150,7 +1170,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
-                    isRedirecting = true
+                    isRedirecting = true;
                     window.location.href = redirectReferenceUrl;
                 } else {
                     // This is for CASE 1,3 and 4 mentioned above, Where we need to update the browser history
@@ -1206,16 +1226,18 @@ export default class AmfReference extends LightningElement {
                 this.isSpecBasedReference(urlReferenceId);
             if (specBasedReference) {
                 const metaVal = this.getMetaFromUrl(name);
+                const encodedMeta = this.getUrlEncoded(metaVal);
+                const decodedMeta = decodeURIComponent(encodedMeta);
                 const currentSelectedMeta = this.selectedTopic
                     ? this.selectedTopic.meta
                     : "";
 
-                if (metaVal && metaVal === currentSelectedMeta) {
+                if (decodedMeta && decodedMeta === currentSelectedMeta) {
                     // selecting the same nav item, skip update
                     return;
                 }
 
-                const metadata = this.metadata[metaVal];
+                const metadata = this.metadata[decodedMeta];
                 if (metadata) {
                     const {
                         parentReferencePath,
@@ -1230,9 +1252,12 @@ export default class AmfReference extends LightningElement {
                         amfId,
                         type,
                         elementId,
-                        metaVal
+                        decodedMeta
+                    );
+                    this.updateUrlWithSelected(
+                        parentReferencePath,
+                        decodedMeta
                     );
-                    this.updateUrlWithSelected(parentReferencePath, metaVal);
                     this.updateNavTitleMetaTag(metadata.navTitle);
                 } else {
                     if (this.isParentReferencePath(name)) {