@salesforcedevs/docs-components 0.17.1 → 0.17.12-search-alpha

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

@@ -1,8 +0,0 @@
-export default {
-    domain: "http://localhost:3000",
-    page: "docs",
-    docId: "atlas.en-us.apexcode.meta",
-    deliverable: "apexcode",
-    contentDocumentId: "apex_dev_guide.htm",
-    hash: ""
-};

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

@@ -1,81 +0,0 @@
-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.stories.ts

@@ -1,148 +0,0 @@
-import * as mockDocContent from "./__tests__/mockDocContent";
-import mockPageReference from "./__tests__/mockPageReference";
-import mockSidebar from "./__tests__/mockSidebar";
-import { html } from "lit-html";
-
-export default {
-    title: "docs/doc-content",
-    component: "doc-content",
-
-    argTypes: {
-        showPaginationButtons: {
-            defaultValue: false,
-            control: {
-                type: "boolean"
-            }
-        }
-    }
-};
-
-const defaultArgs = {
-    pageReference: mockPageReference,
-    isStorybook: true
-};
-
-export const Base = (args: any) => {
-    return `
-  <doc-content
-      is-storybook="${args.isStorybook}"
-      page-reference="${JSON.stringify(args.pageReference)}"
-      docs-data="${args.docsData}"
-  ></doc-content>`;
-};
-
-Base.args = {
-    ...defaultArgs,
-    docsData: mockDocContent.content
-};
-
-export const Images = (args: any) => {
-    return `
-<doc-content
-    is-storybook="${args.isStorybook}"
-    page-reference="${JSON.stringify(args.pageReference)}"
-    docs-data="${args.docsData}"
-></doc-content>`;
-};
-
-Images.args = {
-    ...defaultArgs,
-    docsData: mockDocContent.withImages
-};
-
-export const Table = (args: any) => html`
-    <doc-content
-        is-storybook="${args.isStorybook}"
-        page-reference="${JSON.stringify(args.pageReference)}"
-        docs-data="${args.docsData}"
-    >
-    </doc-content>
-`;
-
-Table.args = {
-    ...defaultArgs,
-    docsData: mockDocContent.withTable
-};
-
-export const Videos = (args: any) => {
-    return `
-<doc-content
-  is-storybook="${args.isStorybook}"
-  page-reference="${JSON.stringify(args.pageReference)}"
-  docs-data="${args.docsData}"
-></doc-content>`;
-};
-
-Videos.args = {
-    ...defaultArgs,
-    docsData: mockDocContent.withVideos
-};
-
-export const Notes = (args: any) => {
-    return `
-<doc-content
-  is-storybook="${args.isStorybook}"
-  page-reference="${JSON.stringify(args.pageReference)}"
-  docs-data="${args.docsData}"
-></doc-content>`;
-};
-
-Notes.args = {
-    ...defaultArgs,
-    docsData: mockDocContent.withNotes
-};
-
-export const PaginationButtons = (args: any) => {
-    return `
-    <doc-content
-        is-storybook="${args.isStorybook}"
-        page-reference="${JSON.stringify(args.pageReference)}"
-        docs-data="${args.docsData}"
-        ${args.showPaginationButtons ? `show-pagination-buttons=true` : ``}
-    ></doc-content>`;
-};
-
-PaginationButtons.args = {
-    ...defaultArgs,
-    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/contentCallout/__tests__/contentCallout.test.ts

@@ -1,80 +0,0 @@
-import ContentCallout from "../contentCallout";
-import { createRenderComponent } from "utils/tests";
-import mockProps from "./mockProps";
-
-const TAG = "dx-content-callout";
-const render = createRenderComponent(TAG, ContentCallout);
-
-describe(TAG, () => {
-    it("renders the icon, title & body with the tip variant", async () => {
-        const element = render({
-            title: mockProps.title,
-            variant: "tip"
-        });
-
-        const els = [
-            ".dx-callout-icon",
-            ".dx-callout-title",
-            ".dx-callout-body",
-            ".dx-callout-tip"
-        ].map((query) => element.shadowRoot.querySelector(query));
-
-        expect(els).not.toContain(null);
-
-        await expect(element).toBeAccessible();
-    });
-
-    it("renders the icon, title & body with the warning variant", async () => {
-        const element = render({
-            title: mockProps.title,
-            variant: "warning"
-        });
-
-        const els = [
-            ".dx-callout-icon",
-            ".dx-callout-title",
-            ".dx-callout-body",
-            ".dx-callout-warning"
-        ].map((query) => element.shadowRoot.querySelector(query));
-
-        expect(els).not.toContain(null);
-
-        await expect(element).toBeAccessible();
-    });
-
-    it("renders the icon, title & body with the note variant", async () => {
-        const element = render({
-            title: mockProps.title,
-            variant: "note"
-        });
-
-        const els = [
-            ".dx-callout-icon",
-            ".dx-callout-title",
-            ".dx-callout-body",
-            ".dx-callout-note"
-        ].map((query) => element.shadowRoot.querySelector(query));
-
-        expect(els).not.toContain(null);
-
-        await expect(element).toBeAccessible();
-    });
-
-    it("renders the icon, title & body with the caution variant", async () => {
-        const element = render({
-            title: mockProps.title,
-            variant: "caution"
-        });
-
-        const els = [
-            ".dx-callout-icon",
-            ".dx-callout-title",
-            ".dx-callout-body",
-            ".dx-callout-caution"
-        ].map((query) => element.shadowRoot.querySelector(query));
-
-        expect(els).not.toContain(null);
-
-        await expect(element).toBeAccessible();
-    });
-});

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

@@ -1,14 +0,0 @@
-export default {
-    body: `<ul class="ul bulletList">
-        <li class="li">Apex SOAP web services allow an external application to invoke Apex methods
-            through SOAP Web services. <a class="xref" href="docs/atlas.en-us.226.0.apexcode.meta/apexcode/apex_callouts.htm" data-id="docs/atlas.en-us.226.0.apexcode.meta/apexcode/apex_callouts.htm">Apex callouts</a> enable Apex to invoke external web or HTTP
-            services.</li>
-
-        <li class="li">Apex REST API exposes your Apex classes and methods as REST web services. See
-                <a class="xref" href="docs/atlas.en-us.226.0.apexcode.meta/apexcode/apex_rest.htm" title="You can expose your Apex classes and methods so that external applications can access your code and your application through the REST architecture." data-id="docs/atlas.en-us.226.0.apexcode.meta/apexcode/apex_rest.htm">Exposing Apex Classes as REST Web
-            Services</a>.</li>
-
-    </ul>`,
-    title: "Caution",
-    variant: "Caution"
-};

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

@@ -1,29 +0,0 @@
-import mockProps from "./__tests__/mockProps";
-
-export default {
-    title: "docs/doc-content-callout",
-    component: "doc-content-callout"
-};
-
-export const Base = (args: any) => `
-<style>
-doc-content-callout {
-  display:block;
-  margin-bottom:12px;
-  }
-</style>
-  <doc-content-callout title='Note'variant="note">
-  ${args.body}
-  </doc-content-callout>
-  <doc-content-callout title='Tip'variant="tip">
-  ${args.body}
-  </doc-content-callout>
-  <doc-content-callout title='Warning' variant="warning">
-  ${args.body}
-  </doc-content-callout>
-  <doc-content-callout title='Caution' variant="caution">
-  ${args.body}
-  </doc-content-callout>
-`;
-
-Base.args = mockProps;

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

@@ -1,97 +0,0 @@
-import ContentMedia from "doc/contentMedia";
-import { createRenderComponent } from "utils/tests";
-
-const TAG = "doc-content-media";
-const render = createRenderComponent(TAG, ContentMedia);
-
-describe(TAG, () => {
-    const originalConsole = global.console;
-
-    beforeAll(() => {
-        global.console = { ...global.console, error: jest.fn() };
-    });
-
-    afterEach(() => {
-        jest.clearAllMocks();
-    });
-
-    afterAll(() => {
-        global.console = originalConsole;
-    });
-
-    it("renders image with passed in props", () => {
-        const element = render({
-            mediaTitle: "test title",
-            contentType: "image",
-            contentSrc: "https://placekitten.com/400/300",
-            caption: "test caption"
-        });
-
-        const title = element.shadowRoot.querySelector(".content-media-title");
-        expect(title).not.toBeNull();
-        expect(title.textContent).toBe("test title");
-
-        const caption = element.shadowRoot.querySelector(
-            ".content-media-caption"
-        );
-        expect(caption).not.toBeNull();
-        expect(caption.textContent).toBe("test caption");
-
-        const image = element.shadowRoot.querySelector(
-            ".content-media-image img"
-        );
-        expect(image).not.toBeNull();
-        expect(image.src).toBe("https://placekitten.com/400/300");
-
-        return expect(element).toBeAccessible();
-    });
-
-    it("renders iframe with passed in props", () => {
-        const element = render({
-            mediaTitle: "test title",
-            contentType: "iframe",
-            contentSrc: "https://www.youtube.com/embed/DfV7WnyEPTE",
-            caption: "test caption"
-        });
-
-        const title = element.shadowRoot.querySelector(".content-media-title");
-        expect(title).not.toBeNull();
-        expect(title.textContent).toBe("test title");
-
-        const caption = element.shadowRoot.querySelector(
-            ".content-media-caption"
-        );
-        expect(caption).not.toBeNull();
-        expect(caption.textContent).toBe("test caption");
-
-        const iframe = element.shadowRoot.querySelector(
-            ".content-media-iframe iframe"
-        );
-        expect(iframe).not.toBeNull();
-        expect(iframe.src).toBe("https://www.youtube.com/embed/DfV7WnyEPTE");
-
-        return expect(element).toBeAccessible();
-    });
-
-    it("doesn't render title or caption when not provided", () => {
-        const element = render({
-            contentType: "iframe",
-            contentSrc: "https://www.youtube.com/embed/DfV7WnyEPTE"
-        });
-
-        const title = element.shadowRoot.querySelector(".content-media-title");
-        expect(title).toBeNull();
-
-        const caption = element.shadowRoot.querySelector(
-            ".content-media-caption"
-        );
-        expect(caption).toBeNull();
-
-        expect(global.console.error).toBeCalledTimes(1);
-        expect(global.console.error).toBeCalledWith(
-            "media-title must be specified when using iframe-src attribute."
-        );
-
-        return expect(element).toBeAccessible();
-    });
-});

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

@@ -1,113 +0,0 @@
-import { html } from "lit-html";
-
-export default {
-    title: "docs/doc-content-media",
-    component: "doc-content-media"
-};
-
-// prettier-ignore
-const styles = () => html `
-    <style>
-        .container-sm {
-            max-width: 540px;
-            margin: 0 auto;
-        }
-
-        .container-fw {
-            width: 100%;
-        }
-
-        h1 {
-            font-size: 36px;
-        }
-
-        h2 {
-            font-size: 24px;
-        }
-
-        h1, h2 {
-            font-weight: bold;
-        }
-    </style>
-`;
-
-// prettier-ignore
-export const Base = () => html`${styles()}
-    <div class="container-sm">
-        <h1>Small Container</h1>
-        <h2>Images</h2>
-        <doc-content-media
-            content-type="image"
-            content-src="https://placekitten.com/400/300"
-            media-title="A cute kitten"
-            caption="An incredibly cute kitten"
-        ></doc-content-media>
-        <doc-content-media
-            content-type="image"
-            content-src="https://placekitten.com/400/300"
-            media-title="A cute kitten"
-        ></doc-content-media>
-        <doc-content-media
-            content-type="image"
-            content-src="https://placekitten.com/400/300"
-            caption="An incredibly cute kitten"
-        ></doc-content-media>
-        <doc-content-media
-            content-type="image"
-            content-src="https://placekitten.com/400/300"
-        ></doc-content-media>
-
-        <h2>IFrames</h2>
-        <doc-content-media
-            content-type="iframe"
-            content-src="https://www.youtube.com/embed/DfV7WnyEPTE"
-            media-title="Master Lightning Web Components in 8 Easy Steps (1)"
-            caption="Lightning Web Components are a new development platform for Salesforce."
-        ></doc-content-media>
-        <doc-content-media
-            content-type="iframe"
-            content-src="https://play.vidyard.com/yThw736PBYf18ts1f8SKXa?disable_popouts=1&v=4.2.30&type=inline"
-            media-title="Non-YouTube Video"
-            caption="doc-content-media supports iframes from any origin."
-        ></doc-content-media>
-    </div>
-
-    <div class="container-fw">
-        <h1>Full-width Container</h1>
-        <h2>Images</h2>
-        <doc-content-media
-            content-type="image"
-            content-src="https://placekitten.com/400/300"
-            media-title="A cute kitten"
-            caption="An incredibly cute kitten"
-        ></doc-content-media>
-        <doc-content-media
-            content-type="image"
-            content-src="https://placekitten.com/400/300"
-            media-title="A cute kitten"
-        ></doc-content-media>
-        <doc-content-media
-            content-type="image"
-            content-src="https://placekitten.com/400/300"
-            caption="An incredibly cute kitten"
-        ></doc-content-media>
-        <doc-content-media
-            content-type="image"
-            content-src="https://placekitten.com/400/300"
-        ></doc-content-media>
-
-        <h2>IFrames</h2>
-        <doc-content-media
-            content-type="iframe"
-            content-src="https://www.youtube.com/embed/DfV7WnyEPTE"
-            media-title="Master Lightning Web Components in 8 Easy Steps (1)"
-            caption="Lightning Web Components are a new development platform for Salesforce."
-        ></doc-content-media>
-        <doc-content-media
-            content-type="iframe"
-            content-src="https://play.vidyard.com/yThw736PBYf18ts1f8SKXa?disable_popouts=1&v=4.2.30&type=inline"
-            media-title="Non-YouTube Video"
-            caption="doc-content-media supports iframes from any origin."
-        ></doc-content-media>
-    </div>
-`;

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

@@ -1,12 +0,0 @@
-// TODO: Move coveoConfig to a specific module to share it.
-export const coveoConfig = {
-    coveoOrganizationId: "coveosalesforcetestakshatha",
-    coveoPublicAccessToken: "xx8d9c92ef-1018-4d92-a3c7-647dff01c21c",
-    coveoSearchPipeline: "salesforcedevdoc",
-    coveoSearchHub: "salesforcedevdoc"
-};
-
-export default {
-    mobile: false,
-    ...coveoConfig
-};