@salesforcedevs/docs-components 0.14.1 → 0.16.2

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "0.14.1",
+    "version": "0.16.2",
     "description": "Docs Lightning web components for DSC",
     "license": "MIT",
     "main": "index.js",
@@ -14,5 +14,5 @@
     "publishConfig": {
         "access": "public"
     },
-    "gitHead": "ad0c0d733107bdb9ddd5770e8f362105fdf32440"
+    "gitHead": "4695c8e7dc16a958beb7717cfe01e432c57f5872"
 }

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

@@ -1,3 +1,4 @@
+import CodeBlock from "dx/codeBlock";
 import { createRenderComponent } from "utils/tests";
 import Content from "../content";
 import * as mockContent from "./mockDocContent";
@@ -34,9 +35,8 @@ describe("doc-content", () => {
             pageReference: mockPageReference,
             _isStorybook: false
         });
-        const empty_dx_buttons = c_no_buttons.shadowRoot.querySelectorAll(
-            "dx-button"
-        );
+        const empty_dx_buttons =
+            c_no_buttons.shadowRoot.querySelectorAll("dx-button");
         expect(empty_dx_buttons.length).toEqual(0);
     });
 
@@ -52,9 +52,8 @@ describe("doc-content", () => {
         expect(contentEl).not.toBeNull();
         const images = component.shadowRoot.querySelectorAll("img");
         expect(images.length).toEqual(3);
-        const contentMediaEls = component.shadowRoot.querySelectorAll(
-            "doc-content-media"
-        );
+        const contentMediaEls =
+            component.shadowRoot.querySelectorAll("doc-content-media");
         expect(contentMediaEls.length).toEqual(0);
     });
 
@@ -70,9 +69,8 @@ describe("doc-content", () => {
         expect(contentEl).not.toBeNull();
         const images = component.shadowRoot.querySelectorAll("iframe");
         expect(images.length).toEqual(0);
-        const contentMediaEls = component.shadowRoot.querySelectorAll(
-            "doc-content-media"
-        );
+        const contentMediaEls =
+            component.shadowRoot.querySelectorAll("doc-content-media");
         expect(contentMediaEls.length).toEqual(2);
         contentMediaEls.forEach((contentMedia) => {
             expect(contentMedia.contentType).toEqual("iframe");
@@ -117,4 +115,198 @@ describe("doc-content", () => {
         expect(notes[2].querySelector("ol")).not.toBeNull();
         expect(notes[3].querySelector("dx-code-block")).not.toBeNull();
     });
+
+    it("highlights text that matches search criteria", () => {
+        const component = render({
+            docsData: mockContent.content,
+            pageReference: mockPageReference,
+            isStorybook: true
+        });
+
+        const contentEl = component.shadowRoot.querySelector(
+            '[data-name="content"]'
+        );
+
+        expect(contentEl.querySelectorAll("mark")).toHaveLength(0);
+
+        contentEl.dispatchEvent(
+            new CustomEvent("highlightedtermchange", {
+                detail: "apex",
+                composed: true,
+                bubbles: true
+            })
+        );
+
+        expect(contentEl.querySelectorAll("mark")).toHaveLength(14);
+    });
+
+    it("doesn't highlight elements that contains dx/docs components", () => {
+        const searchTerm = "customreport";
+
+        const component = render({
+            docsData: mockContent.sampleCodeBlockAndNote,
+            pageReference: mockPageReference,
+            isStorybook: true
+        });
+
+        const contentEl = component.shadowRoot.querySelector(
+            '[data-name="content"]'
+        );
+
+        expect(contentEl.querySelectorAll("mark")).toHaveLength(0);
+
+        contentEl.dispatchEvent(
+            new CustomEvent("highlightedtermchange", {
+                detail: searchTerm,
+                composed: true,
+                bubbles: true
+            })
+        );
+
+        const marks: Array<HTMLElement> = contentEl.querySelectorAll("mark");
+
+        expect(marks).toHaveLength(0);
+
+        const code: CodeBlock = contentEl.querySelector("dx-code-block");
+        expect(code).not.toBeNull();
+        expect(code.codeBlock).toBeTruthy();
+        expect(contentEl.querySelector("doc-content-callout")).not.toBeNull();
+    });
+
+    it("doesn't highlight terms separated by html tags", () => {
+        const searchTerm = "loadData within";
+
+        const component = render({
+            docsData: mockContent.sampleCodeBlockAndNote,
+            pageReference: mockPageReference,
+            isStorybook: true
+        });
+
+        const contentEl = component.shadowRoot.querySelector(
+            '[data-name="content"]'
+        );
+
+        contentEl.dispatchEvent(
+            new CustomEvent("highlightedtermchange", {
+                detail: searchTerm,
+                composed: true,
+                bubbles: true
+            })
+        );
+
+        const marks: Array<HTMLElement> =
+            component.shadowRoot.querySelectorAll("mark");
+        expect(marks).toHaveLength(0);
+    });
+
+    it("escapes regex especial characters", () => {
+        const searchTerm = "used.+";
+
+        const component = render({
+            docsData: mockContent.sampleCodeBlockAndNote,
+            pageReference: mockPageReference,
+            isStorybook: true
+        });
+
+        const contentEl = component.shadowRoot.querySelector(
+            '[data-name="content"]'
+        );
+
+        contentEl.dispatchEvent(
+            new CustomEvent("highlightedtermchange", {
+                detail: searchTerm,
+                composed: true,
+                bubbles: true
+            })
+        );
+
+        const marks: Array<HTMLElement> =
+            component.shadowRoot.querySelectorAll("mark");
+        expect(marks).toHaveLength(0);
+    });
+
+    it("cleans previous search result before searching for a new term", () => {
+        const firstSearch = "verify";
+        const secondSearch = "sObject";
+
+        const component = render({
+            docsData: mockContent.sampleCodeBlockAndNote,
+            pageReference: mockPageReference,
+            isStorybook: true
+        });
+
+        const contentEl = component.shadowRoot.querySelector(
+            '[data-name="content"]'
+        );
+
+        contentEl.dispatchEvent(
+            new CustomEvent("highlightedtermchange", {
+                detail: firstSearch,
+                composed: true,
+                bubbles: true
+            })
+        );
+
+        const firstMarks: Array<HTMLElement> =
+            component.shadowRoot.querySelectorAll("mark");
+        expect(firstMarks).toHaveLength(2);
+        firstMarks.forEach(({ textContent }) =>
+            expect(textContent).toBe(firstSearch)
+        );
+
+        contentEl.dispatchEvent(
+            new CustomEvent("highlightedtermchange", {
+                detail: secondSearch,
+                composed: true,
+                bubbles: true
+            })
+        );
+
+        const secondMarks: Array<HTMLElement> =
+            component.shadowRoot.querySelectorAll("mark");
+        expect(secondMarks).toHaveLength(1);
+        secondMarks.forEach(({ textContent }) =>
+            expect(textContent).toBe(secondSearch)
+        );
+    });
+
+    it("cleans all marks if the search term is empty string", () => {
+        const firstSearch = "verify";
+        const secondSearch = "";
+
+        const component = render({
+            docsData: mockContent.sampleCodeBlockAndNote,
+            pageReference: mockPageReference,
+            isStorybook: true
+        });
+
+        const contentEl = component.shadowRoot.querySelector(
+            '[data-name="content"]'
+        );
+
+        contentEl.dispatchEvent(
+            new CustomEvent("highlightedtermchange", {
+                detail: firstSearch,
+                composed: true,
+                bubbles: true
+            })
+        );
+
+        const firstMarks: Array<HTMLElement> =
+            component.shadowRoot.querySelectorAll("mark");
+        expect(firstMarks).toHaveLength(2);
+        firstMarks.forEach(({ textContent }) =>
+            expect(textContent).toBe(firstSearch)
+        );
+
+        contentEl.dispatchEvent(
+            new CustomEvent("highlightedtermchange", {
+                detail: secondSearch,
+                composed: true,
+                bubbles: true
+            })
+        );
+
+        expect(component.shadowRoot.querySelectorAll("mark")).toHaveLength(0);
+    });
 });

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

@@ -173,6 +173,35 @@ export const withTable = `<table>
         <td>X</td>
         <td>The password of the SSO user account</td>
       </tr>
+      <tr>
+        <td><code>list</code></td>
+        <td>X</td>
+        <td class="with-list">
+            The items in this list should not have larger text than normal:
+            <ul>
+                <li class="li">Item one</li>
+                <li class="li">Item two</li>
+            </ul>
+        </td>
+      </tr>
+      <tr>
+        <td><a href="#">link</a></td>
+        <td>X</td>
+        <td class="with-link-and-p">
+          The link text should not be larger than normal.
+          <p>Paragraph text should not be larger either.</p>
+        </td>
+      </tr>
+      <tr>
+        <td><code>callout</code></td>
+        <td></td>
+        <td class="with-callout">
+          This callout should still have larger text:
+          <doc-content-callout title="Callout test" variant="note">
+            <p>The text here should *not* be the same size as other table text.</p>
+          </doc-content-callout>
+        </td>
+      </tr>
     </tbody>
   </table>`;
 
@@ -284,6 +313,33 @@ const noteWithCodeBlock = `<div class='box message info'>
     </div>
 </div>`;
 
+export const sampleCodeBlockAndNote = `
+    <h1 class='helpHead1'>Using the instanceof Keyword</h1>
+    <p class="p">If you need to verify at run time whether an object is actually an instance of a particular class, use the 
+        <samp class="codeph apex_code"><span class="statement">instanceof</span></samp> keyword.
+        The <samp class="codeph apex_code"><span class="statement">instanceof</span></samp> keyword can only be used to
+        verify if the target type in the expression on the right of the keyword is a viable
+        alternative for the declared type of the expression on the left. 
+    </p>
+    <div class="p">You could add the following check to the <samp class="codeph apex_code">Report</samp>class in the <a class="xref" href="atlas.en-us.apexcode.meta/apexcode/apex_classes_casting.htm" title="In general, all type information is available at run time. This means that Apex enables casting, that is, a data type of one class can be assigned to a data type of another class, but only if one class is a subclass of the other class. Use casting when you want to convert an object from one data type to another.">classes and casting example</a> before you cast the item back into a <samp class="codeph apex_code">CustomReport</samp> object.
+        <div class="codeSection apex_code">
+            <pre class="codeblock brush:apex">If (Reports.get(0) <span class="statement">instanceof</span> CustomReport) {\n    <span class="onelineComment">// Can safely cast it back to a custom report object</span>\n    CustomReport c = (CustomReport) Reports.get(0);\n} Else {\n    <span class="onelineComment">// Do something with the non-custom-report.</span>\n}</pre>
+        </div>
+    </div>
+    ${noteWithOrderedList}
+    <div class="p">
+        Follow these steps:
+        <ol class="ol enumList">
+            <li class="li">Add the data in a .csv file.</li>
+            <li class="li">Create a static resource for this file.</li>
+            <li class="li">
+                Call <samp class="codeph apex_code">Test.loadData</samp> within your test
+                method and passing it the sObject type token and the static resource name.
+            </li>
+        </ol>
+    </div>
+`;
+
 export const withNotes = `<div>
     ${noteWithTable}
     ${noteWithUnorderedList}

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

@@ -0,0 +1,81 @@
+export default [
+    {
+        label: "Getting started",
+        name: "started",
+        isExpanded: true,
+        children: [
+            {
+                label: "Introduction",
+                name: "introduction"
+            },
+            {
+                label: "Getting started",
+                name: "started-child"
+            },
+            {
+                label: "Authentication",
+                name: "authentication"
+            },
+            {
+                label: "Token",
+                name: "token"
+            },
+            {
+                label: "Error",
+                name: "error"
+            },
+            {
+                label: "Limits",
+                name: "limit"
+            },
+            {
+                label: "Release note",
+                name: "release-note"
+            }
+        ]
+    },
+    {
+        label: "Einstein Vision",
+        name: "einstein-vision",
+        children: [
+            {
+                label: "Introduction",
+                name: "einstein-introduction"
+            },
+            {
+                label: "Terminology",
+                name: "terminology"
+            },
+            {
+                label: "Object detection quickstart for beginner",
+                name: "object-quickstart",
+                isExpanded: true,
+                children: [
+                    {
+                        label: "Scenario: this block is intended to show how a large text looks like in the sidebar",
+                        name: "scenario",
+                        isExpanded: true,
+                        children: [
+                            {
+                                label: "Scenario A: this block is intended to show how a large text looks like in the sidebar",
+                                name: "scenario-a"
+                            },
+                            {
+                                label: "Scenario B",
+                                name: "scenario-b"
+                            }
+                        ]
+                    },
+                    {
+                        label: "Prerequisites",
+                        name: "prerequisites"
+                    }
+                ]
+            },
+            {
+                label: "Best Practices",
+                name: "best-practices"
+            }
+        ]
+    }
+];

package/src/modules/doc/content/content.css

@@ -368,3 +368,7 @@ samp,
     font-family: Menlo, monospace;
     font-size: 1em;
 }
+
+mark {
+    background-color: var(--dx-g-yellow-vibrant-90);
+}

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

@@ -1,5 +1,6 @@
 import * as mockDocContent from "./__tests__/mockDocContent";
 import mockPageReference from "./__tests__/mockPageReference";
+import mockSidebar from "./__tests__/mockSidebar";
 import { html } from "lit-html";
 
 export default {
@@ -106,3 +107,42 @@ PaginationButtons.args = {
     showPaginationButtons: false,
     docsData: mockDocContent.withButtons
 };
+
+export const HighlightedTerm = ({ docsData, trees }: any) => html`
+    <style>
+        .sb-show-main.sb-main-padded {
+            padding: 0;
+        }
+
+        .container {
+            display: flex;
+        }
+
+        dx-sidebar {
+            --dx-c-sidebar-min-height: 100vh;
+            margin-right: 16px;
+        }
+
+        doc-content {
+            margin: 16px 16px;
+        }
+    </style>
+
+    <div class="container">
+        <dx-sidebar
+            header="Guides"
+            trees="${JSON.stringify(trees)}"
+        ></dx-sidebar>
+        <doc-content
+            is-storybook="true"
+            page-reference="${JSON.stringify(mockPageReference)}"
+            docs-data="${docsData}"
+        ></doc-content>
+    </div>
+`;
+
+HighlightedTerm.args = {
+    ...defaultArgs,
+    docsData: mockDocContent.sampleCodeBlockAndNote,
+    trees: mockSidebar
+};

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

@@ -1,10 +1,27 @@
 /* eslint-disable @lwc/lwc/no-inner-html */
 import { createElement, LightningElement, api, track } from "lwc";
-import { DocContent, PageReference } from "../../../../../../../typings/custom";
+import { DocContent, PageReference } from "typings/custom";
 import ContentCallout from "doc/contentCallout";
 import CodeBlock from "dx/codeBlock";
 import ContentMedia from "doc/contentMedia";
 import Button from "dx/button";
+import { highlightTerms } from "utils/highlight";
+
+const ALLOWED_ELEMENTS = [
+    "p",
+    ".p",
+    ".shortdesc",
+    "h1",
+    "h2",
+    "h3",
+    "h4",
+    "h5",
+    "h6",
+    "li",
+    "dl",
+    "th",
+    "td"
+];
 
 const LANGUAGE_MAP: { [key: string]: string } = {
     js: "javascript"
@@ -15,31 +32,48 @@ export default class Content extends LightningElement {
     @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 = "";
+    _codeBlockTheme: string = "dark";
     _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
+        );
+    }
+
+    disconnectedCallback(): void {
+        window.removeEventListener(
+            "highlightedtermchange",
+            this.updateHighlighted
+        );
     }
 
     updateTheme() {
@@ -72,19 +106,17 @@ export default class Content extends LightningElement {
     // 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;
+        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"
-        );
+        const codeBlockEls =
+            templateEl.content.querySelectorAll(".codeSection");
         codeBlockEls.forEach((codeBlockEl) => {
             codeBlockEl.setAttribute("lwc:dom", "manual");
             const classList = codeBlockEl.firstChild.classList;
@@ -136,9 +168,8 @@ export default class Content extends LightningElement {
         });
 
         // Modify links to work with any domain, links that start with "#" are excluded
-        const anchorEls = templateEl.content.querySelectorAll(
-            "a:not([href^='#'])"
-        );
+        const anchorEls =
+            templateEl.content.querySelectorAll("a:not([href^='#'])");
         anchorEls.forEach((anchorEl) => {
             if (
                 anchorEl.textContent.includes("Next →") ||
@@ -253,6 +284,15 @@ 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 ===
@@ -267,9 +307,8 @@ export default class Content extends LightningElement {
         event.preventDefault();
         // eslint-disable-next-line no-use-before-define
         const target = event.currentTarget.dataset.id;
-        const [page, docId, deliverable, tempContentDocumentId] = target.split(
-            "/"
-        );
+        const [page, docId, deliverable, tempContentDocumentId] =
+            target.split("/");
         const [contentDocumentId, hash] = tempContentDocumentId.split("#");
         const newPageReference = {
             page: page,
@@ -293,6 +332,14 @@ export default class Content extends LightningElement {
         }
     }
 
+    updateHighlighted = (event: any) =>
+        highlightTerms(
+            Array.from(
+                this.template.querySelectorAll(ALLOWED_ELEMENTS.join(","))
+            ),
+            event.detail
+        );
+
     @api
     public navigateToHash(hash: String) {
         const splitHash = hash.split("#");

package/src/modules/doc/header/__tests__/header.test.ts

@@ -104,7 +104,7 @@ describe(TAG, () => {
             expect(headerEl).not.toBeNull();
             expect(headerEl.classList).toHaveLength(0);
 
-            expect(headerEl.querySelector("dx-feedback-banner")).not.toBeNull();
+            expect(headerEl.querySelector("dx-banner")).not.toBeNull();
 
             const logo = element.shadowRoot.querySelector("dx-logo");
             expect(logo).not.toBeNull();
@@ -307,6 +307,29 @@ describe(TAG, () => {
                 clickText: SIGN_UP_LABEL
             });
         });
+
+        it("hides signup button when signupLink property is empty", () => {
+            const updatedMockPropsDevelopers = {
+                ...mockPropsDevelopers,
+                signupLink:""
+            };
+            const element = render(updatedMockPropsDevelopers);
+            const signupButtonContainer: HTMLElement =
+                element.shadowRoot.querySelector(".header-login-signup");
+            expect(signupButtonContainer).toBeNull();
+        });
+
+        it("hides banner when banner markup is empty", () => {
+            const bannerMarkup = "";
+            const updatedMockPropsDevelopers = {
+                ...mockPropsDevelopers,
+                bannerMarkup
+            };
+            const element = render(updatedMockPropsDevelopers);
+            const bannerElement: HTMLElement =
+                element.shadowRoot.querySelector("dx-banner");
+            expect(bannerElement).toBeNull();
+        });
     });
 
     describe("tablet", () => {

package/src/modules/doc/header/__tests__/mockProps.ts

@@ -32,6 +32,9 @@ export const mockPropsDevelopers = {
     title: "Salesforce Developers",
     subtitle: "Apex Developer Guides",
     languages,
+    signupLink: "/sign-up",
+    bannerMarkup:
+        '<span><a href="https://forms.gle/TdSyKFPHXoBx7seM9" target="blank">Share your feedback</a>about our new site.</span>',
     ...coveoConfig
 };
 

package/src/modules/doc/header/header.html

@@ -1,7 +1,10 @@
 <template>
     <dx-brand-theme-provider brand={brand}>
         <header class={className}>
-            <dx-feedback-banner></dx-feedback-banner>
+            <dx-banner 
+                if:true={bannerMarkup}
+                banner-markup={bannerMarkup}
+            ></dx-banner>
             <div class="header_l1">
                 <div if:true={showMenuButton} class="nav_menu-ctas">
                     <dx-button

package/src/modules/doc/header/header.stories.ts

@@ -101,6 +101,8 @@ const headerStoryGenerator = (
         bail-label="${args.bailLabel}"
         brand="${brand}"
         onclick="headerClick(event)"
+        signup-link="${mockProps.signupLink}"
+        banner-markup="${mockProps.bannerMarkup}"
     ></doc-header>`;
 
 export const Base = (args: any) => html`
@@ -158,3 +160,31 @@ export const Service = (args: any) =>
 
 export const Analytics = (args: any) =>
     headerStoryGenerator(mockPropsAnalytics, "analytics", args);
+
+export const AnalyticsWithoutSignup = (args: any) =>
+    headerStoryGenerator(
+        { ...mockPropsAnalytics, signupLink:"" },
+        "analytics",
+        args
+    );
+
+export const AnalyticsWithCustomBannerText = (args: any) =>
+    headerStoryGenerator(
+        {
+            ...mockPropsMarketing,
+            bannerMarkup:
+                'Salesforce Subscription Management API ("the API") is available as a developer preview. The API is not generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. All components of the API including request names, parameters, objects, and fields are subject to change or deprecation at any time, with or without notice. Do not use the API with real data or in a production environment.'
+        },
+        "analytics",
+        args
+    );
+
+export const AnalyticsWithoutBanner = (args: any) =>
+    headerStoryGenerator(
+        {
+            ...mockPropsMarketing,
+            bannerMarkup: ""
+        },
+        "analytics",
+        args
+    );

package/src/modules/doc/header/header.ts

@@ -63,7 +63,9 @@ export default class Header extends HeaderBase {
     }
 
     private get showSignup(): boolean {
-        return (this.tablet && !this.isSearchOpen) || !this.tablet;
+        return this.signupLink
+            ? (this.tablet && !this.isSearchOpen) || !this.tablet
+            : false;
     }
 
     private get hasLanguages(): boolean {