@salesforcedevs/docs-components 0.57.1-callout-fix → 0.61.0

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

@@ -8,15 +8,26 @@ import {
     TreeNode,
     Header,
     HistoryState,
-    PageReference
+    PageReference,
+    TocMap
 } from "./types";
 import { SearchSyncer } from "docUtils/SearchSyncer";
 import { LightningElementWithState } from "docBaseElements/lightningElementWithState";
-import { Language } from "typings/custom";
+import { Breadcrumb, Language } from "typings/custom";
 
 // TODO: Imitating from actual implementation as doc-content use it like this. We should refactor it later.
 const handleContentError = (error): void => console.log(error);
 
+const FIRST_CRUMB = {
+    href: "/docs",
+    label: "Documentation"
+};
+
+const PIXEL_PER_CHARACTER_MAP: { [key: string]: number } = {
+    default: 7.7,
+    "ja-jp": 12.5
+};
+
 export default class DocXmlContent extends LightningElementWithState<{
     isFetchingDocument: boolean;
     isFetchingContent: boolean;
@@ -53,7 +64,7 @@ export default class DocXmlContent extends LightningElementWithState<{
     private language: DocLanguage = null;
     private loaded = false;
     private pdfUrl = "";
-    private tocMap = null;
+    private tocMap: TocMap = {};
     private sidebarContent: Array<TreeNode> = null;
     private version: DocVersion = null;
     private docTitle = "";
@@ -102,6 +113,7 @@ export default class DocXmlContent extends LightningElementWithState<{
     private _allLanguages: Array<Language> = [];
 
     @track private pageReference: PageReference = {};
+    @track breadcrumbs: Array<Breadcrumb> = [];
 
     constructor() {
         super();
@@ -267,6 +279,13 @@ export default class DocXmlContent extends LightningElementWithState<{
               }));
     }
 
+    private get breadcrumbPixelPerCharacter() {
+        return (
+            PIXEL_PER_CHARACTER_MAP[this.language.id] ||
+            PIXEL_PER_CHARACTER_MAP.default
+        );
+    }
+
     private handlePopState = (): void =>
         this.updatePageReference(this.getReferenceFromUrl());
 
@@ -280,15 +299,15 @@ export default class DocXmlContent extends LightningElementWithState<{
 
         if (name) {
             const hashIndex = name.indexOf("#");
-            this.pageReference.hash =
-                hashIndex > -1 ? name.slice(hashIndex) : "";
-
-            const contentId = hashIndex > -1 ? name.slice(0, hashIndex) : name;
-            if (this.pageReference.contentDocumentId !== contentId) {
-                this.pageReference.contentDocumentId = contentId;
-                this.fetchContent().catch(handleContentError);
-            }
-
+            const hash = hashIndex > -1 ? name.slice(hashIndex) : "";
+
+            const contentDocumentId =
+                hashIndex > -1 ? name.slice(0, hashIndex) : name;
+            this.updatePageReference({
+                ...this.pageReference,
+                contentDocumentId,
+                hash
+            });
             this.updateUrl();
         }
     }
@@ -321,15 +340,17 @@ export default class DocXmlContent extends LightningElementWithState<{
             return;
         }
 
-        const isSameDocId = this.pageReference.docId !== newPageReference.docId;
+        const isSameDocId = this.pageReference.docId === newPageReference.docId;
         this.pageReference = newPageReference;
 
-        if (isSameDocId) {
+        if (!isSameDocId) {
             this.fetchDocument();
             return;
         }
 
-        this.fetchContent().catch(handleContentError);
+        this.fetchContent()
+            .then(() => this.buildBreadcrumbs())
+            .catch(handleContentError);
     }
 
     getReferenceFromUrl(): PageReference {
@@ -386,6 +407,8 @@ export default class DocXmlContent extends LightningElementWithState<{
 
         this.updateHeader();
 
+        this.buildBreadcrumbs();
+
         if (this.pageReference.deliverable !== data.deliverable) {
             this.pageReference.deliverable = data.deliverable;
             this.updateUrl(HistoryState.REPLACE_STATE);
@@ -558,6 +581,32 @@ export default class DocXmlContent extends LightningElementWithState<{
         );
     }
 
+    private buildBreadcrumbs(): void {
+        const { contentDocumentId } = this.pageReference;
+        if (!contentDocumentId) {
+            return;
+        }
+
+        const currentNode = this.tocMap[contentDocumentId];
+        this.breadcrumbs = this.nodeToBreadcrumb(currentNode);
+    }
+
+    private nodeToBreadcrumb(node?: TreeNode): Breadcrumb[] {
+        if (!node) {
+            return [FIRST_CRUMB];
+        }
+        return [
+            ...this.nodeToBreadcrumb(node.parent),
+            {
+                href: this.pageReferenceToString({
+                    ...this.pageReference,
+                    contentDocumentId: node.name
+                }),
+                label: node.label
+            }
+        ];
+    }
+
     addMetatags(): void {
         const div = document.createElement("div");
         div.innerHTML = this.docContent;

package/src/modules/doc/amfReference/route-meta.ts

@@ -1,22 +0,0 @@
-/**
- * Represents the URL reference meta on Reference page.
- * Contains information on selected Reference ID, Topic ID, and Topic Type
- * separated by ":"
- */
-export class RouteMeta {
-    meta: string;
-    referenceId = "";
-    topicId = "";
-    type = "";
-
-    constructor(meta: string) {
-        this.meta = meta;
-
-        if (meta && meta.includes(":")) {
-            const [referenceId, type, topicId] = meta.split(":");
-            this.referenceId = referenceId;
-            this.topicId = topicId || type;
-            this.type = type;
-        }
-    }
-}