@salesforcedevs/docs-components 0.6.0 → 0.7.59-sppage-alpha1

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

@@ -1,160 +0,0 @@
-import { html } from "lit-html";
-import {
-    mockPropsDevelopers,
-    mockPropsEmployees,
-    mockPropsMarketing,
-    mockPropsPartners,
-    mockPropsCommerce,
-    mockPropsSales,
-    mockPropsSuccess,
-    mockPropsIntegration,
-    mockPropsPlatform,
-    mockPropsIndustries,
-    mockPropsLearning,
-    mockPropsService,
-    mockPropsAnalytics
-} from "./__tests__/mockProps";
-
-const controlLang = mockPropsDevelopers.languages.map(({ id }) => id);
-
-export default {
-    title: "docs/doc-header",
-    component: "doc-header",
-    argTypes: {
-        bailHref: {
-            defaultValue: "/quip-dev-center",
-            control: {
-                type: "text"
-            }
-        },
-        bailLabel: {
-            defaultValue: "PDF",
-            control: {
-                type: "text"
-            }
-        },
-        language: {
-            defaultValue: controlLang[0],
-            control: {
-                options: controlLang,
-                type: "select"
-            }
-        }
-    }
-};
-
-const styles = () => html` <style>
-    body {
-        padding: 0 !important;
-    }
-    .fake-url {
-        padding: 8px;
-        font-size: 12px;
-        color: white;
-        background: grey;
-        word-break: break-word;
-    }
-</style>`;
-
-const renderPreventNavScript = () => html` <script>
-    function headerClick(e) {
-        const link = e
-            .composedPath()
-            .find((el) =>
-                el
-                    ? el.tagName === "A" && el.getAttribute("target") === null
-                    : false
-            );
-        if (link) {
-            e.preventDefault();
-            const href = link.getAttribute("href");
-            const element = document.querySelector(".fake-url");
-            if (element) {
-                element.textContent = href;
-            }
-            if (href && !href.includes("http")) {
-                e.target.href = "https://localhost:6006" + href;
-            }
-        }
-    }
-</script>`;
-
-const headerStoryGenerator = (
-    mockProps: any,
-    brand: string,
-    args: any
-) => html` ${styles()} ${renderPreventNavScript()}
-    <div class="fake-url">/</div>
-    <doc-header
-        coveo-organization-id="${mockProps.coveoOrganizationId}"
-        coveo-public-access-token="${mockProps.coveoPublicAccessToken}"
-        coveo-search-pipeline="${mockProps.coveoSearchPipeline}"
-        coveo-search-hub="${mockProps.coveoSearchHub}"
-        signup-link="https://www.google.com"
-        title="${mockProps.title}"
-        subtitle="${mockProps.subtitle}"
-        nav-items="${JSON.stringify(mockProps.navItems)}"
-        languages="${JSON.stringify(mockProps.languages)}"
-        language="${args.language}"
-        scoped-nav-items="${JSON.stringify(mockProps.scopedNavItems)}"
-        bail-href="${args.bailHref}"
-        bail-label="${args.bailLabel}"
-        brand="${brand}"
-        onclick="headerClick(event)"
-    ></doc-header>`;
-
-export const Base = (args: any) => html`
-    ${styles()} ${renderPreventNavScript()}
-    <div class="fake-url">/</div>
-    <doc-header
-        title="${mockPropsDevelopers.title}"
-        bail-href="${args.bailHref}"
-        bail-label="${args.bailLabel}"
-        subtitle="${mockPropsDevelopers.subtitle}"
-        nav-items="${JSON.stringify(mockPropsDevelopers.navItems)}"
-        languages="${JSON.stringify(mockPropsDevelopers.languages)}"
-        language="${args.language}"
-        coveo-organization-id="${mockPropsDevelopers.coveoOrganizationId}"
-        coveo-public-access-token="${mockPropsDevelopers.coveoPublicAccessToken}"
-        coveo-search-pipeline="${mockPropsDevelopers.coveoSearchPipeline}"
-        coveo-search-hub="${mockPropsDevelopers.coveoSearchHub}"
-        onclick="headerClick(event)"
-    ></doc-header>
-`;
-
-// BRAND STORIES
-export const Employees = (args: any) =>
-    headerStoryGenerator(mockPropsEmployees, "employees", args);
-
-export const Marketing = (args: any) =>
-    headerStoryGenerator(mockPropsMarketing, "marketing", args);
-
-export const Partners = (args: any) =>
-    headerStoryGenerator(mockPropsPartners, "partners", args);
-
-export const Commerce = (args: any) =>
-    headerStoryGenerator(mockPropsCommerce, "commerce", args);
-
-export const Sales = (args: any) =>
-    headerStoryGenerator(mockPropsSales, "sales", args);
-
-export const Success = (args: any) =>
-    headerStoryGenerator(mockPropsSuccess, "success", args);
-
-export const Integration = (args: any) =>
-    headerStoryGenerator(mockPropsIntegration, "integration", args);
-
-export const Platform = (args: any) =>
-    headerStoryGenerator(mockPropsPlatform, "platform", args);
-
-export const Industries = (args: any) =>
-    headerStoryGenerator(mockPropsIndustries, "industries", args);
-
-export const Learning = (args: any) =>
-    headerStoryGenerator(mockPropsLearning, "learning", args);
-
-export const Service = (args: any) =>
-    headerStoryGenerator(mockPropsService, "service", args);
-
-export const Analytics = (args: any) =>
-    headerStoryGenerator(mockPropsAnalytics, "analytics", args);

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,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/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"
-    }
-];