@salesforcedevs/docs-components 0.22.0 → 0.26.0-alpha.2

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

@@ -1,58 +0,0 @@
-import Nav from "doc/nav";
-import mockAvailableLanguages from "./mockAvailableLanguages";
-import mockAvailableVersions from "./mockAvailableVersions";
-import mockSelectedLanguage from "./mockSelectedLanguage";
-import mockSelectedVersion from "./mockSelectedVersion";
-import mockPdfUrl from "./mockPdfUrl";
-import mockToc from "./mockToc";
-import mockPageReference from "./mockPageReference";
-import { createRenderComponent } from "utils/tests";
-
-const MOCK_PARAMETERS = {
-    selectedLanguage: mockSelectedLanguage,
-    selectedVersion: mockSelectedVersion,
-    availableLanguages: mockAvailableLanguages,
-    availableVersions: mockAvailableVersions,
-    pdfUrl: mockPdfUrl,
-    toc: mockToc,
-    pageReference: mockPageReference
-};
-
-const TAG = "doc-nav";
-const render = createRenderComponent(TAG, Nav);
-
-describe("doc-nav", () => {
-    it("renders the content", () => {
-        const component = render(MOCK_PARAMETERS);
-
-        const tocEl = component.shadowRoot.querySelector("dx-sidebar");
-        expect(tocEl).not.toBeNull();
-    });
-
-    it("fires the event", () => {
-        const component = render(MOCK_PARAMETERS);
-
-        const tocEl: HTMLElement = component.shadowRoot.querySelector(
-            "dx-sidebar"
-        );
-        const mockNavClick = jest.fn();
-        component.addEventListener("navclick", mockNavClick);
-        tocEl.dispatchEvent(
-            new CustomEvent("select", {
-                detail: {
-                    name: "apex_dev_guide-hashtest"
-                },
-                bubbles: true,
-                composed: true
-            })
-        );
-        expect(mockNavClick).toHaveBeenCalledTimes(1);
-        expect(mockNavClick.mock.calls[0][0].detail).toEqual({
-            pageReference: {
-                ...mockPageReference,
-                contentDocumentId: "apex_dev_guide.htm",
-                hash: "hashtest"
-            }
-        });
-    });
-});

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

@@ -1,13 +0,0 @@
-export default {
-    phase: "dev-preview",
-    title: "Developer Preview",
-    body: `This feature is not generally available and is being piloted with 
-            certain Customers subject to additional terms and conditions. It 
-            is not part of your purchased Services. This feature is subject to 
-            change, may be discontinued with no notice at any time in SFDC’s 
-            available. Make your purchase decisions only on the basis of 
-            generally available products and features. This feature is made 
-            available on an AS IS basis and use of this feature is at your 
-            sole risk. Check <a href="https://developer.salesforce.com/">
-            Developers Website</a> for more information.`
-};

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

@@ -1,60 +0,0 @@
-import DocPhase from "doc/phase";
-import { createRenderComponent } from "utils/tests";
-import mockProps from "./mockProps";
-
-const TAG = "doc-phase";
-const render = createRenderComponent(TAG, DocPhase);
-
-describe(TAG, () => {
-    let element: any;
-
-    beforeEach(() => {
-        element = render({
-            docPhaseInfo: mockProps
-        });
-    });
-
-    it("renders the icon, title & body with the default phase", async () => {
-        const els = [
-            ".doc-phase-container",
-            ".doc-phase-icon",
-            ".doc-phase-title",
-            ".doc-phase-body"
-        ].map((query) => element.shadowRoot.querySelector(query));
-
-        expect(els).not.toContain(null);
-
-        await expect(element).toBeAccessible();
-    });
-
-    it("hides the body when clicking button on expand state", async () => {
-
-        const showOrHideButton = element.shadowRoot.querySelector("dx-button");
-
-        const docPhaseBody: HTMLSpanElement =
-            element.shadowRoot.querySelector(".doc-phase-body");
-
-        showOrHideButton.click();
-
-        return Promise.resolve().then(() => {
-            expect(docPhaseBody.classList).toContain("doc-phase-body-hidden");
-        });
-    });
-
-    it("shows the body when clicking button on collapse state", async () => {
-        
-        const showOrHideButton = element.shadowRoot.querySelector("dx-button");
-
-        const docPhaseBody: HTMLSpanElement =
-            element.shadowRoot.querySelector(".doc-phase-body");
-
-        showOrHideButton.click();
-        showOrHideButton.click();
-
-        return Promise.resolve().then(() => {
-            expect(docPhaseBody.classList).not.toContain(
-                "doc-phase-body-hidden"
-            );
-        });
-    });
-});

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

@@ -1,12 +0,0 @@
-import mockProps from "./__tests__/mockProps";
-
-export default {
-    title: "docs/doc-phase",
-    component: "doc-phase"
-};
-
-const docPhaseInfo = JSON.stringify(mockProps);
-
-export const Default = () => `
-  <doc-phase doc-phase-info='${docPhaseInfo}'></doc-phase>
-`;

package/src/modules/doc/toc/__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/toc/__tests__/mockToc.ts

@@ -1,146 +0,0 @@
-export default [
-    {
-        children: [
-            {
-                text: "Overview",
-                a_attr: {
-                    href: "actions_intro_overview.htm"
-                },
-                id: "actions_intro_overview"
-            },
-            {
-                text: "Invoking Actions",
-                a_attr: {
-                    href: "actions_intro_invoking.htm"
-                },
-                id: "actions_intro_invoking"
-            },
-            {
-                text: "Available Actions",
-                a_attr: {
-                    href: "actions_intro_list.htm"
-                },
-                id: "actions_intro_list"
-            }
-        ],
-        text: "Introducing Actions",
-        a_attr: {
-            href: "actions_intro.htm"
-        },
-        id: "actions_intro"
-    },
-    {
-        children: [
-            {
-                text: "Apex Actions",
-                a_attr: {
-                    href: "actions_obj_apex.htm"
-                },
-                id: "actions_obj_apex"
-            },
-            {
-                text: "Create Service Report Actions",
-                a_attr: {
-                    href: "actions_obj_create_service_report.htm"
-                },
-                id: "actions_obj_create_service_report"
-            },
-            {
-                text: "Custom Notification Actions",
-                a_attr: {
-                    href: "actions_obj_custom_notification.htm"
-                },
-                id: "actions_obj_custom_notification"
-            },
-            {
-                text: "Email Alert Actions",
-                a_attr: {
-                    href: "actions_obj_email_alert.htm"
-                },
-                id: "actions_obj_email_alert"
-            },
-            {
-                text: "Flow Actions",
-                a_attr: {
-                    href: "actions_obj_flow.htm"
-                },
-                id: "actions_obj_flow"
-            },
-            {
-                text: "Generate Work Orders Actions",
-                a_attr: {
-                    href: "actions_obj_generate_work_orders.htm"
-                },
-                id: "actions_obj_generate_work_orders"
-            },
-            {
-                text: "Knowledge Actions",
-                a_attr: {
-                    href: "actions_obj_knowledge.htm"
-                },
-                id: "actions_obj_knowledge"
-            },
-            {
-                text: "Omni-Channel Action",
-                a_attr: {
-                    href: "actions_obj_omni_channel.htm"
-                },
-                id: "actions_obj_omni_channel"
-            },
-            {
-                text: "PlatformAction",
-                a_attr: {
-                    href: "sforce_api_objects_platformaction.htm"
-                },
-                id: "sforce_api_objects_platformaction"
-            },
-            {
-                text: "Post to Chatter Actions",
-                a_attr: {
-                    href: "actions_obj_post_to_chatter.htm"
-                },
-                id: "actions_obj_post_to_chatter"
-            },
-            {
-                text: "Quick Actions",
-                a_attr: {
-                    href: "actions_obj_quick_action.htm"
-                },
-                id: "actions_obj_quick_action"
-            },
-            {
-                text: "Refresh Metric Actions",
-                a_attr: {
-                    href: "actions_obj_refresh_metric.htm"
-                },
-                id: "actions_obj_refresh_metric"
-            },
-            {
-                text: "Salesforce Order Management Actions",
-                a_attr: {
-                    href: "actions_obj_order_management.htm"
-                },
-                id: "actions_obj_order_management"
-            },
-            {
-                text: "Simple Email Actions",
-                a_attr: {
-                    href: "actions_obj_email_simple.htm"
-                },
-                id: "actions_obj_email_simple"
-            },
-            {
-                text: "Submit for Approval Actions",
-                a_attr: {
-                    href: "actions_obj_submit_for_approval.htm"
-                },
-                id: "actions_obj_submit_for_approval"
-            }
-        ],
-        text: "Action Objects",
-        a_attr: {
-            href: "actions_obj.htm"
-        },
-        id: "actions_obj"
-    }
-];

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

@@ -1,29 +0,0 @@
-import { createElement } from "lwc";
-import Toc from "../toc";
-import mockToc from "./mockToc";
-import mockPageReference from "./mockPageReference";
-
-const create = (props?: object) => {
-    const component = createElement("doc-toc", {
-        is: Toc
-    });
-
-    Object.assign(component, {
-        toc: mockToc,
-        pageReference: mockPageReference,
-        ...(props || {})
-    });
-
-    return component;
-};
-
-describe("doc-toc", () => {
-    it("renders the navigation", () => {
-        const component = create();
-        document.body.appendChild(component);
-        const containerEl = component.shadowRoot.querySelector(
-            ".doc-toc-container"
-        );
-        expect(containerEl).not.toBeNull();
-    });
-});

package/src/modules/doc/toolbar/__tests__/mockAvailableLanguages.ts

@@ -1,8 +0,0 @@
-export default [
-    {
-        label: "ENGLISH",
-        code: "EN",
-        locale: "en-us",
-        url: "atlas.en-us.228.0.apexcode.meta"
-    }
-];

package/src/modules/doc/toolbar/__tests__/mockAvailableVersions.ts

@@ -1,122 +0,0 @@
-export default [
-    {
-        version_text: "Winter '21 (API version 50.0)",
-        release_version: "50.0",
-        doc_version: "228.0",
-        version_url: "atlas.en-us.apexcode.meta"
-    },
-    {
-        version_text: "Summer '20 (API version 49.0)",
-        release_version: "49.0",
-        doc_version: "226.0",
-        version_url: "atlas.en-us.226.0.apexcode.meta"
-    },
-    {
-        version_text: "Spring '20 (API version 48.0)",
-        release_version: "48.0",
-        doc_version: "224.0",
-        version_url: "atlas.en-us.224.0.apexcode.meta"
-    },
-    {
-        version_text: "Winter '20 (API version 47.0)",
-        release_version: "47.0",
-        doc_version: "222.0",
-        version_url: "atlas.en-us.222.0.apexcode.meta"
-    },
-    {
-        version_text: "Summer '19 (API version 46.0)",
-        release_version: "46.0",
-        doc_version: "220.0",
-        version_url: "atlas.en-us.220.0.apexcode.meta"
-    },
-    {
-        version_text: "Spring '19 (API version 45.0)",
-        release_version: "45.0",
-        doc_version: "218.0",
-        version_url: "atlas.en-us.218.0.apexcode.meta"
-    },
-    {
-        version_text: "Winter '19 (API version 44.0)",
-        release_version: "44.0",
-        doc_version: "216.0",
-        version_url: "atlas.en-us.216.0.apexcode.meta"
-    },
-    {
-        version_text: "Summer '18 (API version 43.0)",
-        release_version: "43.0",
-        doc_version: "214.0",
-        version_url: "atlas.en-us.214.0.apexcode.meta"
-    },
-    {
-        version_text: "Spring '18 (API version 42.0)",
-        release_version: "42.0",
-        doc_version: "212.0",
-        version_url: "atlas.en-us.212.0.apexcode.meta"
-    },
-    {
-        version_text: "Winter '18 (API version 41.0)",
-        release_version: "41.0",
-        doc_version: "210.0",
-        version_url: "atlas.en-us.210.0.apexcode.meta"
-    },
-    {
-        version_text: "Summer '17 (API version 40.0)",
-        release_version: "40.0",
-        doc_version: "208.0",
-        version_url: "atlas.en-us.208.0.apexcode.meta"
-    },
-    {
-        version_text: "Spring '17 (API version 39.0)",
-        release_version: "39.0",
-        doc_version: "206.0",
-        version_url: "atlas.en-us.206.0.apexcode.meta"
-    },
-    {
-        version_text: "Winter '17 (API version 38.0)",
-        release_version: "38.0",
-        doc_version: "204.0",
-        version_url: "atlas.en-us.204.0.apexcode.meta"
-    },
-    {
-        version_text: "Summer '16 (API version 37.0)",
-        release_version: "37.0",
-        doc_version: "202.0",
-        version_url: "atlas.en-us.202.0.apexcode.meta"
-    },
-    {
-        version_text: "Spring '16 (API version 36.0)",
-        release_version: "36.0",
-        doc_version: "200.0",
-        version_url: "atlas.en-us.200.0.apexcode.meta"
-    },
-    {
-        version_text: "Winter '16 (API version 35.0)",
-        release_version: "35.0",
-        doc_version: "198.0",
-        version_url: "atlas.en-us.198.0.apexcode.meta"
-    },
-    {
-        version_text: "Summer '15 (API version 34.0)",
-        release_version: "34.0",
-        doc_version: "196.0",
-        version_url: "atlas.en-us.196.0.apexcode.meta"
-    },
-    {
-        version_text: "Spring '15 (API version 33.0)",
-        release_version: "33.0",
-        doc_version: "194.0",
-        version_url: "atlas.en-us.194.0.apexcode.meta"
-    },
-    {
-        version_text: "Winter '15 (API version 32.0)",
-        release_version: "32.0",
-        doc_version: "192.0",
-        version_url: "atlas.en-us.192.0.apexcode.meta"
-    },
-    {
-        version_text: "Spring '14 (API version 30.0)",
-        release_version: "30.0",
-        doc_version: "188.0",
-        version_url: "atlas.en-us.188.0.apexcode.meta"
-    }
-];

package/src/modules/doc/toolbar/__tests__/mockPdfUrl.ts

@@ -1 +0,0 @@
-export default "https://resources.docs.salesforce.com/228/latest/en-us/sfdc/pdf/salesforce_apex_language_reference.pdf";

package/src/modules/doc/toolbar/__tests__/mockSelectedLanguage.ts

@@ -1,8 +0,0 @@
-export default [
-    {
-        label: "ENGLISH",
-        code: "EN",
-        locale: "en-us",
-        url: "atlas.en-us.228.0.apexcode.meta"
-    }
-];

package/src/modules/doc/toolbar/__tests__/mockSelectedVersion.ts

@@ -1,8 +0,0 @@
-export default [
-    {
-        version_text: "Winter '21 (API version 50.0)",
-        release_version: "50.0",
-        doc_version: "228.0",
-        version_url: "atlas.en-us.apexcode.meta"
-    }
-];

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

@@ -1,44 +0,0 @@
-import { createElement } from "lwc";
-import Toolbar from "../toolbar";
-import mockAvailableLanguages from "./mockAvailableLanguages";
-import mockAvailableVersions from "./mockAvailableVersions";
-import mockSelectedLanguage from "./mockSelectedLanguage";
-import mockSelectedVersion from "./mockSelectedVersion";
-import mockPdfUrl from "./mockPdfUrl";
-
-const create = (props?: object) => {
-    const component = createElement("doc-toolbar", {
-        is: Toolbar
-    });
-
-    Object.assign(component, {
-        selectedLanguage: mockSelectedLanguage,
-        selectedVersion: mockSelectedVersion,
-        availableLanguages: mockAvailableLanguages,
-        availableVersions: mockAvailableVersions,
-        pdfUrl: mockPdfUrl,
-        ...(props || {})
-    });
-
-    return component;
-};
-
-describe("doc-toolbar", () => {
-    it("renders the container div when created", () => {
-        const component = create();
-        document.body.appendChild(component);
-        const containerEl = component.shadowRoot.querySelector(
-            ".doc-toolbar-container"
-        );
-        expect(containerEl).not.toBeNull();
-    });
-
-    it("renders all selects", () => {
-        const component = create();
-        document.body.appendChild(component);
-        const selectEls = component.shadowRoot.querySelectorAll(
-            ".doc-toolbar-item"
-        );
-        expect(selectEls.length).toEqual(2);
-    });
-});