@salesforcedevs/docs-components 0.56.2-seo-test9 → 0.56.2-seo-test12

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "0.56.2-seo-test9",
+    "version": "0.56.2-seo-test12",
     "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}` : "";
     }
 
     /**
@@ -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(":");
@@ -1076,18 +1096,6 @@ export default class AmfReference extends LightningElement {
                     invalidTopicReferenceUrl = previousRefUrlInSession;
                 }
             }
-            if (!invalidTopicReferenceUrl) {
-                const referenceUrl = window.location.href;
-                const referenceMeta =
-                    this.getMarkdownReferenceMeta(referenceUrl);
-                const selectedItemRefId =
-                    this.getReferenceIdFromUrl(referenceUrl);
-                const referenceDetails = this.getRefDetailsForGivenTopicMeta(
-                    selectedItemRefId,
-                    referenceMeta
-                );
-                this.updateNavTitleMetaTag(referenceDetails.topicTitle);
-            }
             this.loadMarkdownBasedReference(invalidTopicReferenceUrl);
         }
     }
@@ -1149,6 +1157,7 @@ export default class AmfReference extends LightningElement {
             }
         }
 
+        let isRedirecting = false;
         if (referenceId) {
             const amfConfig = this.getAmfConfigWithId(referenceId);
             let redirectReferenceUrl = "";
@@ -1161,6 +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;
                     window.location.href = redirectReferenceUrl;
                 } else {
                     // This is for CASE 1,3 and 4 mentioned above, Where we need to update the browser history
@@ -1168,11 +1178,24 @@ export default class AmfReference extends LightningElement {
                 }
             }
         }
+        if (!isRedirecting) {
+            const currentReferenceUrl = window.location.href;
+            const referenceMeta =
+                this.getMarkdownReferenceMeta(currentReferenceUrl);
+            const selectedItemRefId =
+                this.getReferenceIdFromUrl(currentReferenceUrl);
+            const referenceDetails = this.getRefDetailsForGivenTopicMeta(
+                selectedItemRefId,
+                referenceMeta
+            );
+            if (referenceDetails) {
+                this.updateNavTitleMetaTag(referenceDetails.topicTitle);
+            }
 
-        this.versions = this.getVersions();
-
-        this.updateDocPhase();
-        this.selectedSidebarValue = window.location.pathname;
+            this.versions = this.getVersions();
+            this.updateDocPhase();
+            this.selectedSidebarValue = window.location.pathname;
+        }
     }
 
     /**

package/src/modules/doc/xmlContent/xmlContent.ts

@@ -13,7 +13,6 @@ import {
 import { SearchSyncer } from "docUtils/SearchSyncer";
 import { LightningElementWithState } from "docBaseElements/lightningElementWithState";
 import { Language } from "typings/custom";
-import { DEFAULT_LANGUAGES } from "dxUtils/constants";
 
 // TODO: Imitating from actual implementation as doc-content use it like this. We should refactor it later.
 const handleContentError = (error): void => console.log(error);
@@ -100,7 +99,7 @@ export default class DocXmlContent extends LightningElementWithState<{
         shouldStopPropagation: true,
         target: window
     });
-    private _allLanguages: Array<Language> = DEFAULT_LANGUAGES;
+    private _allLanguages: Array<Language> = [];
 
     @track private pageReference: PageReference = {};
 
@@ -584,5 +583,20 @@ export default class DocXmlContent extends LightningElementWithState<{
                 metadescription.setAttribute("content", docDescription);
             }
         }
+
+        if (this.pageReference) {
+            const metadescription = document.querySelector(
+                'link[rel="canonical"]'
+            );
+            if (metadescription) {
+                metadescription.setAttribute(
+                    "href",
+                    window.location.protocol +
+                        "//" +
+                        window.location.host +
+                        this.pageReferenceToString(this.pageReference)
+                );
+            }
+        }
     }
 }