@salesforcedevs/docs-components 0.3.12 → 0.3.14-banner-alpha1

package/src/modules/doc/container/__mocks__/mockPageReference.js

@@ -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/container/__mocks__/mockPdfUrl.js

@@ -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/container/__mocks__/mockSelectedLanguage.js

@@ -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/container/__mocks__/mockSelectedVersion.js

@@ -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/container/__mocks__/mockToc.js

@@ -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/container/__tests__/container.test.ts

@@ -1,117 +0,0 @@
-/* eslint-disable jest/no-mocks-import */
-import { createElement } from "lwc";
-import Container from "../container";
-import mockAvailableLanguages from "../__mocks__/mockAvailableLanguages";
-import mockAvailableVersions from "../__mocks__/mockAvailableVersions";
-import mockSelectedLanguage from "../__mocks__/mockSelectedLanguage";
-import mockSelectedVersion from "../__mocks__/mockSelectedVersion";
-import mockPdfUrl from "../__mocks__/mockPdfUrl";
-import mockToc from "../__mocks__/mockToc";
-import mockDocContent from "../__mocks__/mockDocContent";
-import mockPageReference from "../__mocks__/mockPageReference";
-window.scrollTo = jest.fn();
-
-const mockContentFetchResponse = require("../__mocks__/mockContentFetchResponse.json");
-const mockNavigationFetchResponse = require("../__mocks__/mockNavigationFetchResponse.json");
-const DEFAULT_DOMAIN_API = "https://developer.salesforce.com/";
-const ALTERNATE_DOMAIN_API = "https://staging.developer.salesforce.com/";
-
-const create = (props?: object) => {
-    const component = createElement("doc-container", {
-        is: Container
-    });
-
-    Object.assign(component, {
-        selectedLanguage: mockSelectedLanguage,
-        selectedVersion: mockSelectedVersion,
-        availableLanguages: mockAvailableLanguages,
-        availableVersion: mockAvailableVersions,
-        pdfUrl: mockPdfUrl,
-        toc: mockToc,
-        docContent: mockDocContent,
-        pageReference: mockPageReference,
-        storybookDomain: "https://developer.salesforce.com",
-        storybookPage: "docs",
-        storybookDocId: "atlas.en-us.228.0.apexcode.meta",
-        storybookDeliverable: "apexcode",
-        storybookContentDocumentId: "apex_dev_guide.htm",
-        ...(props || {})
-    });
-
-    return component;
-};
-
-function mockFetch() {
-    return jest.fn().mockImplementation((url) => {
-        let data = mockContentFetchResponse;
-        switch (url) {
-            case "https://developer.salesforce.com/docs/get_document/atlas.en-us.228.0.apexcode.meta":
-                data = mockNavigationFetchResponse;
-                break;
-            default:
-                data = mockContentFetchResponse;
-        }
-        return Promise.resolve({
-            ok: true,
-            json: () => data
-        });
-    });
-}
-
-describe("doc-container", () => {
-    afterEach(() => {
-        jest.clearAllMocks();
-    });
-
-    it("renders the content", async () => {
-        global.fetch = mockFetch();
-        const component = create();
-        document.body.appendChild(component);
-        expect(global.fetch).toHaveBeenCalledTimes(1);
-        expect(global.fetch).toHaveBeenCalledWith(
-            `${DEFAULT_DOMAIN_API}docs/get_document/atlas.en-us.228.0.apexcode.meta`
-        );
-        return Promise.resolve(() => {
-            const contentEl = component.shadowRoot.querySelector(
-                ".doc-content"
-            );
-            expect(contentEl).not.toBeNull();
-        });
-    });
-
-    it("renders the navigation", async () => {
-        global.fetch = mockFetch();
-        const component = create();
-        document.body.appendChild(component);
-        expect(global.fetch).toHaveBeenCalledTimes(1);
-        expect(global.fetch).toHaveBeenCalledWith(
-            `${DEFAULT_DOMAIN_API}docs/get_document/atlas.en-us.228.0.apexcode.meta`
-        );
-        return Promise.resolve(() => {
-            const navEl = component.shadowRoot.querySelector(".doc-nav");
-            expect(navEl).not.toBeNull();
-        });
-    });
-
-    it("renders the correct default value domainApi", () => {
-        global.fetch = mockFetch();
-        const component = create();
-        document.body.appendChild(component);
-        expect(global.fetch).toHaveBeenCalledTimes(1);
-        expect(global.fetch).toHaveBeenCalledWith(
-            `${DEFAULT_DOMAIN_API}docs/get_document/atlas.en-us.228.0.apexcode.meta`
-        );
-        expect(component.domainApi).toBe(DEFAULT_DOMAIN_API);
-    });
-
-    it("renders the correct values for domainApi", () => {
-        global.fetch = mockFetch();
-        const component = create({ domainApi: ALTERNATE_DOMAIN_API });
-        document.body.appendChild(component);
-        expect(global.fetch).toHaveBeenCalledTimes(1);
-        expect(global.fetch).toHaveBeenCalledWith(
-            `${ALTERNATE_DOMAIN_API}docs/get_document/atlas.en-us.228.0.apexcode.meta`
-        );
-        expect(component.domainApi).toBe(ALTERNATE_DOMAIN_API);
-    });
-});

package/src/modules/doc/container/container.css

@@ -1,37 +0,0 @@
-div {
-    display: flex;
-}
-
-.doc-nav {
-    margin: 10px;
-    min-width: 270px;
-    width: 20%;
-}
-
-.doc-content {
-    margin: 10px;
-    width: 100%;
-}
-
-doc-nav {
-    min-width: 100% !important;
-    max-width: 100% !important;
-}
-
-doc-content {
-    min-width: 100% !important;
-    max-width: 100% !important;
-}
-
-@media screen and (max-width: 768px) {
-    .container {
-        flex-direction: column;
-    }
-
-    .doc-nav {
-        margin-top: 0;
-        margin-right: 0;
-        margin-left: 0;
-        width: 100%;
-    }
-}

package/src/modules/doc/container/container.html

@@ -1,28 +0,0 @@
-<template>
-    <template if:false={showLandingPage}>
-        <div if:true={loaded} class="container">
-            <div class="doc-nav">
-                <doc-nav
-                    toc={toc}
-                    available-languages={availableLanguages}
-                    selected-language={selectedLanguage}
-                    pdf-url={pdfUrl}
-                    available-versions={availableVersions}
-                    selected-version={selectedVersion}
-                    page-reference={pageReference}
-                    selected-navigation-item={selectedNavigationItem}
-                ></doc-nav>
-            </div>
-            <div class="doc-content">
-                <doc-content
-                    docs-data={docContent}
-                    page-reference={pageReference}
-                    is-storybook={_isStorybook}
-                ></doc-content>
-            </div>
-        </div>
-    </template>
-    <template if:true={showLandingPage}>
-        <doc-landing></doc-landing>
-    </template>
-</template>

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

@@ -1,44 +0,0 @@
-export default {
-    title: "docs/doc-container",
-    component: "doc-container"
-};
-
-export const Base = (args: any) => {
-    return `
-    <doc-container
-        storybook-domain='${args.domain}'
-        storybook-page='${args.page}'
-        storybook-doc-id='${args.docId}'
-        storybook-deliverable='${args.deliverable}'
-        storybook-content-document-id='${args.contentDocumentId}'
-    ></doc-container>`;
-};
-
-Base.args = {
-    domain: "https://developer.salesforce.com",
-    page: "docs",
-    docId: "atlas.en-us.226.0.apexcode.meta",
-    deliverable: "apexcode",
-    contentDocumentId: "apex_dev_guide.htm"
-};
-
-export const DomainApi = (args: any) => {
-    return `
-    <doc-container
-        domain-api='${args.domainApi}'
-        storybook-domain='${args.domain}'
-        storybook-page='${args.page}'
-        storybook-doc-id='${args.docId}'
-        storybook-deliverable='${args.deliverable}'
-        storybook-content-document-id='${args.contentDocumentId}'
-    ></doc-container>`;
-};
-
-DomainApi.args = {
-    domain: "https://staging.developer.salesforce.com/",
-    page: "docs",
-    docId: "atlas.en-us.226.0.apexcode.meta",
-    deliverable: "apexcode",
-    contentDocumentId: "apex_dev_guide.htm",
-    domainApi: "https://staging.developer.salesforce.com/"
-};