@salesforcedevs/docs-components 0.46.1 → 0.49.1-alpha.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "0.46.1",
+    "version": "0.49.1-alpha.0",
     "description": "Docs Lightning web components for DSC",
     "license": "MIT",
     "main": "index.js",
@@ -10,5 +10,5 @@
     "publishConfig": {
         "access": "public"
     },
-    "gitHead": "9d6112f99bee139b17929e838f6ba8ac199dea2a"
+    "gitHead": "4629fdd9ca18a13480044ad43515b91945d16aad"
 }

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

@@ -109,180 +109,174 @@ export default class Content extends LightningElement {
     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");
-        // eslint-disable-next-line no-use-before-define
-        templateEl.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) => {
-            codeBlockEl.setAttribute("lwc:dom", "manual");
-            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];
+        if (divEl) {
+            divEl.innerHTML = docContent || this.docContent;
+
+            // 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.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];
+                        }
                     }
                 }
-            }
-            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,
-                theme: this.codeBlockTheme,
-                title: "", // Default no title.
-                variant: this.codeBlockType,
-                isEncoded: true
+                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,
+                    theme: this.codeBlockTheme,
+                    title: "", // Default no title.
+                    variant: this.codeBlockType,
+                    isEncoded: true
+                });
+                // eslint-disable-next-line no-use-before-define
+                codeBlockEl.innerHTML = "";
+                codeBlockEl.appendChild(blockCmp);
             });
-            // 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 = templateEl.content.querySelectorAll(".message");
-        calloutEls.forEach((calloutEl) => {
-            const calloutCompEl = createElement("doc-content-callout", {
-                is: ContentCallout
-            });
-            const detailEls = calloutEl.querySelectorAll(
-                "p, div.data, ol, ul, .codeSection, .mediaBd > span.ph"
-            );
-            detailEls.forEach((detailEl) => {
-                calloutCompEl.appendChild(detailEl);
-            });
-            const type = calloutEl.querySelector("h4").textContent;
-            const typeLower = type.toLowerCase();
-            Object.assign(calloutCompEl, {
-                title: type,
-                variant: typeLower
+            // 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, div.data, ol, ul, .codeSection, .mediaBd > span.ph"
+                );
+                detailEls.forEach((detailEl) => {
+                    calloutCompEl.appendChild(detailEl);
+                });
+                const type = calloutEl.querySelector("h4").textContent;
+                const typeLower = type.toLowerCase();
+                Object.assign(calloutCompEl, {
+                    title: type,
+                    variant: typeLower
+                });
+                // eslint-disable-next-line no-use-before-define
+                calloutEl.innerHTML = "";
+                calloutEl.appendChild(calloutCompEl);
             });
-            // 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 =
-            templateEl.content.querySelectorAll("a:not([href^='#'])");
-
-        anchorEls.forEach((anchorEl) => {
-            if (
-                anchorEl.textContent.includes("Next →") ||
-                anchorEl.textContent.includes("← Previous")
-            ) {
-                if (this.showPaginationButtons) {
-                    this.renderPaginationButton(anchorEl);
-                } else {
-                    anchorEl.remove();
-                }
-            }
-
-            // ! This is a hack
-            // Normalize urls in case it doesn't come complete.
-            if (anchorEl.href.startsWith("atlas.")) {
-                anchorEl.href = "/docs/" + anchorEl.href;
-            }
-
-            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;
+            // Modify links to work with any domain, links that start with "#" are excluded
+            const anchorEls = divEl.querySelectorAll("a:not([href^='#'])");
+
+            anchorEls.forEach((anchorEl) => {
+                if (
+                    anchorEl.textContent.includes("Next →") ||
+                    anchorEl.textContent.includes("← Previous")
+                ) {
+                    if (this.showPaginationButtons) {
+                        this.renderPaginationButton(anchorEl);
+                    } else {
+                        anchorEl.remove();
+                    }
                 }
-                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 = templateEl.content.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");
-
-            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;
-                if (alt) {
-                    img.alt = alt;
+                // ! This is a hack
+                // Normalize urls in case it doesn't come complete.
+                if (anchorEl.href.startsWith("atlas.")) {
+                    anchorEl.href = "/docs/" + anchorEl.href;
                 }
-                if (title) {
-                    img.title = title;
-                }
-                if (height) {
-                    img.height = parseFloat(height);
-                }
-                if (width) {
-                    img.width = parseFloat(width);
+
+                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;
                 }
 
-                img.className = "content-image";
-                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();
-        });
+                anchorEl.setAttribute("data-id", anchorEl.href);
+            });
 
-        if (divEl) {
-            // eslint-disable-next-line no-use-before-define
-            divEl.innerHTML = "";
-            divEl.append(templateEl.content);
+            // 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");
+
+                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;
+                    if (alt) {
+                        img.alt = alt;
+                    }
+                    if (title) {
+                        img.title = title;
+                    }
+                    if (height) {
+                        img.height = parseFloat(height);
+                    }
+                    if (width) {
+                        img.width = parseFloat(width);
+                    }
+
+                    img.className = "content-image";
+                    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

package/LICENSE

@@ -1,12 +0,0 @@
-Copyright (c) 2020, Salesforce.com, Inc.
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
-* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
-* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-
-* Neither the name of Salesforce.com nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.