@salesforcedevs/docs-components 0.0.5 → 0.0.6-edit

package/src/modules/doc/content/content.ts

@@ -1,162 +1,277 @@
 /* eslint-disable @lwc/lwc/no-inner-html */
-import { LightningElement, api, track } from "lwc";
-import {
-    DocContent,
-    PageReference
-} from "../../../../../../../typings/custom-new";
+import { createElement, LightningElement, api, track } from "lwc";
+import { DocContent, PageReference } from "typings/custom";
+import CodeBlock from "dx/codeBlock";
+import Button from "dx/button";
+import { highlightTerms } from "dxUtils/highlight";
+import ContentCallout from "doc/contentCallout";
+import ContentMedia from "doc/contentMedia";
+
+const HIGHLIGHTABLE_SELECTOR = [
+    "p",
+    ".p",
+    ".shortdesc",
+    "h1",
+    "h2",
+    "h3",
+    "h4",
+    "h5",
+    "h6",
+    "li",
+    "dl",
+    "th",
+    "td"
+].join(",");
+
+const LANGUAGE_MAP: { [key: string]: string } = {
+    js: "javascript"
+};
 
 export default class Content extends LightningElement {
     @api isStorybook: boolean = false;
     @api pageReference!: PageReference;
     @api codeBlockType: string = "card";
+    @api showPaginationButtons: boolean = false;
+
     @api
     set docsData(value) {
         this._docRendered = false;
-        this.docContent = value;
+        this.docContent = (value && value.trim()) || "";
     }
+
     get docsData() {
         return this.docContent;
     }
-    _codeBlockTheme: string = "dark";
-    @api
-    set codeBlockTheme(value) {
-        this._codeBlockTheme = value;
-    }
-    get codeBlockTheme() {
-        return this._codeBlockTheme;
-    }
 
     @track docContent: DocContent = "";
     _docRendered: boolean = false;
-    originalCodeBlockThemeValue: String = "";
+
     connectedCallback() {
-        this.template.addEventListener(
-            "themechange",
-            this.updateTheme.bind(this) // eslint-disableline no-use-before-define
+        window.addEventListener(
+            "highlightedtermchange",
+            this.updateHighlighted
         );
     }
 
-    constructor() {
-        super();
-        this.template.addEventListener(
-            "themechange",
-            this.updateTheme.bind(this) // eslint-disableline no-use-before-define
+    disconnectedCallback(): void {
+        window.removeEventListener(
+            "highlightedtermchange",
+            this.updateHighlighted
         );
     }
 
-    updateTheme() {
-        this._codeBlockTheme =
-            this._codeBlockTheme === "dark" ? "light" : "dark";
-        const codeBlockEls = this.template.querySelectorAll("dx-code-block");
-        codeBlockEls.forEach((codeBlockEl) => {
-            codeBlockEl.setAttribute("theme", this._codeBlockTheme);
-        });
+    renderPaginationButton(anchorEl: HTMLElement) {
+        const isNext = anchorEl.textContent!.includes("Next →");
+        anchorEl.innerHTML = "";
+        const buttonEl = createElement("dx-button", { is: Button });
+        const params = isNext
+            ? { iconSymbol: "chevronright" }
+            : {
+                  iconPosition: "left",
+                  iconSymbol: "chevronleft",
+                  variant: "secondary"
+              };
+        Object.assign(buttonEl, params);
+        const textEl = document.createDocumentFragment();
+        textEl.textContent = isNext ? "Next" : "Previous";
+        buttonEl.appendChild(textEl);
+        anchorEl.appendChild(buttonEl);
     }
 
     // We don't use any tracked field here. The challenge is that
     // for security reasons you can't pass pure HTML via a class
     // field to the template. Hence we manipulate the DOM manually.
-    insertDocHtml() {
-        const divEl = this.template.querySelector("div");
+    insertDocHtml(docContent?: string) {
+        const divEl = this.getCleanContainer();
 
-        // Some simple data mutation to make Prism work on-the-fly with the existing datasource
-        const templateEl = document.createElement("template");
-        this.docContent = this.docContent.trim();
-        // eslint-disable-next-line no-use-before-define
-        templateEl.innerHTML = this.docContent;
+        if (divEl) {
+            divEl.innerHTML = docContent || this.docContent;
 
-        // Query the code blocks and create a dx-code-block component that contains the code
-        const codeBlockEls = templateEl.content.querySelectorAll(
-            ".codeSection"
-        );
-        codeBlockEls.forEach((codeBlockEl) => {
-            const blockEl = document.createElement("dx-code-block");
-            const classList = codeBlockEl.firstChild.classList;
-            let language = "";
-            for (const key in classList) {
-                if (typeof classList[key] === "string") {
-                    const className = classList[key];
-                    if (className.startsWith("brush:")) {
-                        language = className.split(":")[1];
+            // Query the code blocks and create a dx-code-block component that contains the code
+            const codeBlockEls = divEl.querySelectorAll(".codeSection");
+            codeBlockEls.forEach((codeBlockEl) => {
+                codeBlockEl.setAttribute("lwc:dom", "manual");
+                const classList = codeBlockEl.firstElementChild?.classList;
+                let language = "";
+                if (classList) {
+                    for (let i = 0; i < classList.length; i++) {
+                        const className = classList[i];
+                        if (className.startsWith("brush:")) {
+                            language = className.split(":")[1];
+                        }
                     }
                 }
-            }
-            blockEl.setAttribute("title", "Code Block Title");
-            blockEl.setAttribute("theme", this.codeBlockTheme);
-            blockEl.setAttribute("variant", this.codeBlockType);
-            blockEl.setAttribute("language", language);
-            // eslint-disable-next-line no-use-before-define
-            blockEl.setAttribute("code-block", codeBlockEl.innerHTML);
-            // eslint-disable-next-line no-use-before-define
-            codeBlockEl.innerHTML = "";
-            codeBlockEl.appendChild(blockEl);
-        });
-
-        // Modify links to work with any domain
-        const anchorEls = templateEl.content.querySelectorAll("a");
-        anchorEls.forEach((anchorEl) => {
-            const href = anchorEl.href.split("/");
-            if (
-                (href[3] === this.pageReference.docId && this.isStorybook) ||
-                href[4] === this.pageReference.docId ||
-                href[6] === this.pageReference.docId
-            ) {
-                let updatedURL;
-                switch (href.length) {
-                    case 8:
-                        updatedURL = href.splice(5).join("/");
-                        break;
-                    case 7:
-                        updatedURL = href.splice(4).join("/");
-                        break;
-                    case 6:
-                        updatedURL = href.splice(3).join("/");
-                        break;
-                    default:
-                        updatedURL = href.splice(6).join("/");
-                        break;
-                }
-                anchorEl.addEventListener(
-                    "click",
-                    // eslint-disable-next-line no-use-before-define
-                    this.handleNavClick.bind(this)
+                const blockCmp = createElement("dx-code-block", {
+                    is: CodeBlock
+                });
+                Object.assign(blockCmp, {
+                    codeBlock: codeBlockEl.innerHTML,
+                    // ! Hot fix for incoming html tags from couchdb for xml blocks, fix me soon please
+                    language: LANGUAGE_MAP[language] || language,
+                    header: "", // Default no title.
+                    variant: this.codeBlockType,
+                    isEncoded: true
+                });
+                // eslint-disable-next-line no-use-before-define
+                codeBlockEl.innerHTML = "";
+                codeBlockEl.appendChild(blockCmp);
+            });
+
+            // Query the callouts and create a doc-content-callout component that contains the code
+            const calloutEls = divEl.querySelectorAll(".message");
+            calloutEls.forEach((calloutEl) => {
+                const calloutCompEl = createElement("doc-content-callout", {
+                    is: ContentCallout
+                });
+                const detailEls = calloutEl.querySelectorAll(
+                    "p, .p, div.data, ol, ul, p+.codeSection, p~.codeSection, div >.codeSection, .mediaBd > span.ph"
                 );
-                anchorEl.setAttribute("href", "docs/" + updatedURL);
-                anchorEl.setAttribute("data-id", "docs/" + updatedURL);
-            } else if (href[2] === "developer.salesforce.com") {
-                let updatedURL = this.pageReference.domain;
-                if (href[3]) {
-                    updatedURL = updatedURL + `/${href[3]}`;
+                detailEls.forEach((detailEl) => {
+                    if (detailEl.innerHTML.trim() !== "") {
+                        calloutCompEl.appendChild(detailEl);
+                    }
+                });
+
+                // Set a flag to 1 (true) if and only if all detailEls have no content.
+                let flag = 1;
+                for (let i: number = 0; i < detailEls.length; i++) {
+                    flag &= (detailEls[i].innerHTML.trim() === "") as any; // Dark Magic TM
                 }
-                if (href[4]) {
-                    updatedURL = updatedURL + `/${href[4]}`;
+
+                if (flag) {
+                    const codeEls = calloutEl.querySelectorAll(".codeSection");
+                    codeEls.forEach((codeEl) => {
+                        calloutCompEl.appendChild(codeEl);
+                    });
                 }
-                if (href[5]) {
-                    updatedURL = updatedURL + `/${href[5]}`;
+
+                const type = calloutEl.querySelector("h4")!.textContent!;
+                const typeLower = type.toLowerCase();
+                Object.assign(calloutCompEl, {
+                    header: type,
+                    variant: typeLower
+                });
+                // eslint-disable-next-line no-use-before-define
+                calloutEl.innerHTML = "";
+                calloutEl.appendChild(calloutCompEl);
+            });
+
+            // Modify links to work with any domain, links that start with "#" are excluded
+            const anchorEls = divEl.querySelectorAll("a:not([href^='#'])");
+
+            anchorEls.forEach((anchorEl: any) => {
+                if (
+                    anchorEl.textContent!.includes("Next →") ||
+                    anchorEl.textContent!.includes("← Previous")
+                ) {
+                    if (this.showPaginationButtons) {
+                        this.renderPaginationButton(anchorEl);
+                    } else {
+                        anchorEl.remove();
+                    }
                 }
-                if (href[6]) {
-                    updatedURL = updatedURL + `/${href[6]}`;
+
+                // ! This is a hack
+                // Normalize urls in case it doesn't come complete.
+                if (anchorEl.href.startsWith("atlas.")) {
+                    anchorEl.href = "/docs/" + anchorEl.href;
                 }
-                anchorEl.setAttribute("href", updatedURL);
-                anchorEl.setAttribute("data-id", updatedURL);
-            }
-        });
-
-        // Modify image src to work with any domain
-        const imgEls = templateEl.content.querySelectorAll("img");
-        imgEls.forEach((imgEl) => {
-            const src = imgEl.src;
-            const updatedURL = src.replace(
-                this.pageReference.domain,
-                "https://developer.salesforce.com"
-            );
-            imgEl.setAttribute("src", updatedURL);
-        });
 
-        if (divEl) {
-            // eslint-disable-next-line no-use-before-define
-            divEl.innerHTML = "";
-            divEl.append(templateEl.content);
+                const href = anchorEl.href.split("/");
+                if (
+                    (href[3] === this.pageReference.docId &&
+                        this.isStorybook) ||
+                    href[4] === this.pageReference.docId ||
+                    href[6] === this.pageReference.docId
+                ) {
+                    let updatedURL;
+                    switch (href.length) {
+                        case 8:
+                            updatedURL = href.splice(5).join("/");
+                            break;
+                        case 7:
+                            updatedURL = href.splice(4).join("/");
+                            break;
+                        case 6:
+                            updatedURL = href.splice(3).join("/");
+                            break;
+                        default:
+                            updatedURL = href.splice(6).join("/");
+                            break;
+                    }
+                    anchorEl.addEventListener(
+                        "click",
+                        // eslint-disable-next-line no-use-before-define
+                        this.handleNavClick.bind(this)
+                    );
+                    // anchor href event is not propagated here as we want SPA nature.
+                    // But in prerender.io - as javascript is not executed, we want the anchor links are proper (absolute urls).
+                    anchorEl.setAttribute("href", "/docs/" + updatedURL);
+                    anchorEl.setAttribute("data-id", "docs/" + updatedURL);
+                    return;
+                }
+
+                anchorEl.setAttribute("data-id", anchorEl.href);
+            });
+
+            // Modify image src to work with any domain and replace images/iframes with doc-content-media
+            const imgEls = divEl.querySelectorAll("img, iframe");
+
+            imgEls.forEach((mediaEl) => {
+                const isImage = mediaEl.nodeName === "IMG";
+                let src = mediaEl.getAttribute("src");
+                if (!src) {
+                    return;
+                }
+                const alt = mediaEl.getAttribute("alt");
+                const title = mediaEl.getAttribute("title");
+                const label = mediaEl.getAttribute("label");
+                const width = mediaEl.getAttribute("width");
+                const height = mediaEl.getAttribute("height");
+                const className = mediaEl.getAttribute("class");
+
+                if (isImage) {
+                    src = src.startsWith("/")
+                        ? `https://developer.salesforce.com${src}`
+                        : src.replace(
+                              window.location.origin,
+                              "https://developer.salesforce.com"
+                          );
+
+                    const img: HTMLImageElement = document.createElement("img");
+                    img.src = src;
+                    img.alt = "";
+                    if (alt) {
+                        img.alt = alt;
+                    }
+                    if (title) {
+                        img.title = title;
+                    }
+                    if (height) {
+                        img.height = parseFloat(height);
+                    }
+                    if (width) {
+                        img.width = parseFloat(width);
+                    }
+                    if (className) {
+                        img.className = className;
+                    }
+
+                    img.className = `content-image ${img.className}`;
+                    mediaEl.parentNode!.insertBefore(img, mediaEl);
+                } else {
+                    const contentMediaEl = createElement("doc-content-media", {
+                        is: ContentMedia
+                    });
+                    Object.assign(contentMediaEl, {
+                        contentType: "iframe",
+                        contentSrc: src,
+                        mediaTitle: alt || title || label
+                    });
+                    mediaEl.parentNode!.insertBefore(contentMediaEl, mediaEl);
+                }
+                mediaEl.remove();
+            });
         }
 
         // Once the html has been corectly modified, naviage to the page reference on the page
@@ -165,13 +280,30 @@ export default class Content extends LightningElement {
         }
     }
 
+    private getCleanContainer(): HTMLElement | null {
+        const divEl = this.template.querySelector("div");
+        if (divEl?.hasChildNodes()) {
+            divEl.removeChild(divEl.firstChild!);
+        }
+
+        return divEl;
+    }
+
+    isSamePage(reference: PageReference): boolean {
+        return (
+            this.pageReference.contentDocumentId ===
+                reference.contentDocumentId &&
+            this.pageReference.docId === reference.docId &&
+            this.pageReference.page === reference.page &&
+            this.pageReference.deliverable === reference.deliverable
+        );
+    }
+
     handleNavClick(event: InputEvent) {
         event.preventDefault();
-        // eslint-disable-next-line no-use-before-define
-        const target = event.currentTarget.dataset.id;
-        const [page, docId, deliverable, tempContentDocumentId] = target.split(
-            "/"
-        );
+        const target = (event.currentTarget! as any).dataset.id;
+        const [page, docId, deliverable, tempContentDocumentId] =
+            target.split("/");
         const [contentDocumentId, hash] = tempContentDocumentId.split("#");
         const newPageReference = {
             page: page,
@@ -189,10 +321,20 @@ export default class Content extends LightningElement {
                 composed: true
             })
         );
+
+        if (this.isSamePage({ ...newPageReference, domain: "" })) {
+            this.navigateToHash(window.location.hash);
+        }
     }
 
+    updateHighlighted = (event: any) =>
+        highlightTerms(
+            this.template.querySelectorAll(HIGHLIGHTABLE_SELECTOR),
+            event.detail
+        );
+
     @api
-    public navigateToHash(hash: String) {
+    public navigateToHash = (hash: String) => {
         const splitHash = hash.split("#");
         if (splitHash.length === 2) {
             hash = splitHash[1];
@@ -203,7 +345,7 @@ export default class Content extends LightningElement {
         } else {
             window.scrollTo({ top: 0, behavior: "smooth" });
         }
-    }
+    };
 
     renderedCallback() {
         if (this._docRendered) {

package/src/modules/doc/contentCallout/contentCallout.css

@@ -1,60 +1,59 @@
-@import "helpers/reset";
-@import "helpers/text";
+@import "dxHelpers/reset";
+@import "dxHelpers/text";
+@import "docHelpers/status";
 
 .dx-callout {
     border-radius: 4px;
-    border-left: 4px solid;
 }
 
-.dx-callout-icon {
-    padding-right: var(--dx-g-spacing-md);
-}
-
-.dx-callout-base {
+.dx-callout-base,
+.dx-callout-plain {
     background-color: var(--dx-g-gray-95);
     border-color: var(--dx-g-gray-50);
 }
 
+.dx-callout-plain {
+    border: none;
+    margin-bottom: var(--dx-g-text-2xl);
+}
+
+.dx-callout-note {
+    background-color: var(--dx-g-blue-vibrant-95);
+    border-color: var(--dx-g-blue-vibrant-50);
+}
+
 .dx-callout-tip {
     background-color: var(--dx-g-green-natural-95);
     border-color: var(--dx-g-green-vibrant-60);
 }
 
-.dx-callout-warning {
-    background-color: rgb(254, 243, 217);
-    border-color: var(--dx-g-yellow-vibrant-80);
+.dx-callout-caution {
+    background-color: var(--dx-g-red-natural-95);
+    border-color: var(--dx-g-red-vibrant-50);
 }
 
-.dx-callout-caution {
+.dx-callout-warning {
     background-color: var(--dx-g-red-natural-95);
     border-color: var(--dx-g-red-vibrant-50);
 }
 
-.dx-callout-base__section {
+.dx-callout-base_section {
     width: 100%;
-    padding: var(--dx-g-spacing-md);
 }
 
-.dx-callout-base__section-large {
+.dx-callout-base_section-large {
     width: 100%;
     padding: var(--dx-g-spacing-xl);
 }
 
 /* callout column */
 
-.dx-callout-base__column {
+.dx-callout-base_column {
     display: flex;
     flex-direction: row;
 }
 
-.dx-callout-base__column > *:not(:last-child):not(dx-type-badge-group) {
-    margin-bottom: var(--dx-g-spacing-sm);
-}
-
-.dx-callout-base__column > dx-type-badge-group {
-    margin-bottom: var(--dx-g-spacing-sm);
-}
-
-.dx-callout-title {
-    font-weight: bold;
+.dx-callout-content {
+    flex: 1;
+    overflow: auto;
 }

package/src/modules/doc/contentCallout/contentCallout.html

@@ -1,10 +1,19 @@
 <template>
     <div class={className}>
-        <div class="dx-callout-icon">
-            <dx-icon symbol={iconName} size="large" color={iconColor}></dx-icon>
-        </div>
+        <template if:false={hideIcon}>
+            <div class="doc-status-icon dx-callout-icon">
+                <dx-icon
+                    symbol={iconName}
+                    size="large"
+                    color={iconColor}
+                ></dx-icon>
+            </div>
+        </template>
+
         <div class="dx-callout-content">
-            <p class="dx-callout-title dx-text-body-3">{title}</p>
+            <p class="doc-status-title dx-callout-title dx-text-body-3">
+                {header}
+            </p>
             <span class="dx-callout-body dx-text-body-3">
                 <slot onslotchange={onSlotChange}></slot>
             </span>

package/src/modules/doc/contentCallout/contentCallout.ts

@@ -3,8 +3,7 @@ import cx from "classnames";
 import { CalloutVariant, LightningSlotElement } from "typings/custom";
 
 export default class ContentCallout extends LightningElement {
-    @api overrideWidth?: boolean = false;
-    @api title!: string;
+    @api header!: string;
     @api variant!: CalloutVariant;
     cardVariant?: string;
     iconName?: string;
@@ -12,14 +11,17 @@ export default class ContentCallout extends LightningElement {
 
     connectedCallback() {
         switch (this.variant) {
+            case "plain":
+                this.cardVariant = "dx-callout-plain";
+                break;
             case "tip":
                 this.cardVariant = "dx-callout-tip";
                 this.iconColor = "green-vibrant-60";
                 this.iconName = "success";
                 break;
             case "warning":
-                this.cardVariant = "dx-callout-warning";
-                this.iconColor = "yellow-vibrant-80";
+                this.cardVariant = "doc-status-container dx-callout-warning";
+                this.iconColor = "red-vibrant-50";
                 this.iconName = "warning";
                 break;
             case "caution":
@@ -27,10 +29,15 @@ export default class ContentCallout extends LightningElement {
                 this.iconColor = "red-vibrant-50";
                 this.iconName = "alert";
                 break;
+            case "important":
+                this.cardVariant = "doc-status-container dx-callout-important";
+                this.iconColor = "gray-10";
+                this.iconName = "announcement";
+                break;
             case "note":
             default:
-                this.cardVariant = "dx-callout-base";
-                this.iconColor = "gray-50";
+                this.cardVariant = "dx-callout-note";
+                this.iconColor = "blue-vibrant-50";
                 this.iconName = "info";
         }
     }
@@ -38,13 +45,17 @@ export default class ContentCallout extends LightningElement {
     get className() {
         return cx(
             "dx-callout",
-            "dx-callout-base__section",
-            "dx-callout-base__column",
-            this.cardVariant,
-            this.overrideWidth && "dx-callout-base--override-width"
+            "doc-status-base",
+            "dx-callout-base_section",
+            "dx-callout-base_column",
+            this.cardVariant
         );
     }
 
+    get hideIcon() {
+        return this.variant === "plain";
+    }
+
     private isSlotEmpty: boolean = true;
     private onSlotChange(e: LightningSlotElement) {
         // @ts-ignore

package/src/modules/doc/contentLayout/contentLayout.css

@@ -0,0 +1 @@
+@import "docHelpers/contentLayoutStyle";