@salesforcedevs/docs-components 0.0.4 → 0.0.5-edit

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

@@ -1,30 +0,0 @@
-import { createElement } from "lwc";
-import Content from "../content";
-import mockDocContent from "./mockDocContent";
-import mockPageReference from "./mockPageReference";
-
-const create = (props?: object) => {
-    const component = createElement("doc-content", {
-        is: Content
-    });
-
-    Object.assign(component, {
-        docsData: mockDocContent,
-        pageReference: mockPageReference,
-        _isStorybook: false,
-        ...(props || {})
-    });
-
-    return component;
-};
-
-describe("doc-content", () => {
-    it("renders the content", () => {
-        const component = create();
-        document.body.appendChild(component);
-        const contentEl = component.shadowRoot.querySelector(
-            '[data-name="content"]'
-        );
-        expect(contentEl).not.toBeNull();
-    });
-});

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

@@ -1,29 +0,0 @@
-export default `<a name="apex_dev_guide"><!-- --></a><h1 class="helpHead1">Apex Developer Guide</h1><div class="shortdesc">Salesforce has changed the way organizations do business by moving enterprise
-applications that were traditionally client-server-based into the Lightning Platform, an
-on-demand, multitenant Web environment. This environment enables you to run and customize
-applications, such as Salesforce Automation and Service &amp; Support, and build new custom
-applications based on particular business needs. </div><div id="sfdc:seealso" class="related-links">
-<ul class="ullinks">
-<li class="link ulchildlink">
-<strong><a href="atlas.en-us.apexcode.meta/apexcode/apex_intro_get_started.htm">Getting Started with Apex</a></strong><br>
-Apex is a strongly typed, object-oriented programming language that allows developers         to execute flow and transaction control statements on the Lightning Platform server, in         conjunction with calls to the API.</li>
-<li class="link ulchildlink">
-<strong><a href="atlas.en-us.apexcode.meta/apexcode/apex_writing.htm">Writing Apex</a></strong><br>
-Apex is like Java for Salesforce. It enables you to add and interact with data in the         Lightning Platform persistence layer. It uses classes, data types, variables, and if-else         statements. You can make it execute based on a condition, or have a block of code execute         repeatedly.</li>
-<li class="link ulchildlink">
-<strong><a href="atlas.en-us.apexcode.meta/apexcode/apex_running.htm">Running Apex</a></strong><br>
-You can access many features of the Salesforce user interface programmatically in         Apex, and you can integrate with external SOAP and REST Web services. You can run Apex code         using a variety of mechanisms. Apex code runs in atomic transactions. </li>
-<li class="link ulchildlink">
-<strong><a href="atlas.en-us.apexcode.meta/apexcode/apex_debug_test_deploy.htm">Debugging, Testing, and Deploying Apex</a></strong><br>
-Develop your Apex code in a sandbox and debug it with the Developer Console and debug         logs. Unit-test your code, then distribute it to customers using packages.</li>
-<li class="link ulchildlink">
-<strong><a href="atlas.en-us.apexcode.meta/apexcode/apex_reference.htm">Apex Language Reference</a></strong><br>
-This Apex reference goes into detail about DML statements and the built-in Apex         classes and interfaces.</li>
-<li class="link ulchildlink">
-<strong><a href="atlas.en-us.apexcode.meta/apexcode/apex_appendices.htm">Appendices</a></strong><br>
-</li>
-<li class="link ulchildlink">
-<strong><a href="atlas.en-us.apexcode.meta/apexcode/glossary_apex.htm">Glossary</a></strong><br>
-</li>
-</ul>
-</div><!--DRC 228.7-->`;

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/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-base"
-        ].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/nav/__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/nav/__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/nav/__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/nav/__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/nav/__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/nav/__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/nav/__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/nav/__tests__/nav.test.ts

@@ -1,66 +0,0 @@
-import { createElement } from "lwc";
-import Nav from "../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 navigation", () => {
-        const component = render(MOCK_PARAMETERS);
-        document.body.appendChild(component);
-        const toolbarEl = component.shadowRoot.querySelector("doc-toolbar");
-        expect(toolbarEl).not.toBeNull();
-    });
-
-    it("renders the content", () => {
-        const component = render(MOCK_PARAMETERS);
-
-        const tocEl = component.shadowRoot.querySelector("dx-tree");
-        expect(tocEl).not.toBeNull();
-    });
-
-    it("fires the event", () => {
-        const component = render(MOCK_PARAMETERS);
-
-        const tocEl: HTMLElement = component.shadowRoot.querySelector(
-            "dx-tree"
-        );
-        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"
-            }
-        });
-    });
-});