@salesforcedevs/docs-components 0.0.7 → 0.0.9-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/landing/__tests__/landing.test.ts

@@ -1,32 +0,0 @@
-/* eslint-disable jest/no-mocks-import */
-import Landing from "../landing";
-import { createRenderComponent } from "utils/tests";
-const mockFetchResponse = require("../__tests__/mockFetch.json");
-
-const TAG = "dx-doc-landing";
-const render = createRenderComponent(TAG, Landing);
-
-function mockFetch() {
-    return jest.fn().mockImplementation(() => {
-        const data = mockFetchResponse;
-        return Promise.resolve({
-            ok: true,
-            json: () => data
-        });
-    });
-}
-
-describe(TAG, () => {
-    describe("doc-landing", () => {
-        it("renders the landing page", async () => {
-            global.fetch = mockFetch();
-            const element = render();
-            const els = [
-                ".docs-results-container",
-                ".docs-search-row"
-            ].map((query) => element.shadowRoot.querySelector(query));
-            expect(els).not.toContain(null);
-            await expect(element).toBeAccessible();
-        });
-    });
-});

package/src/modules/doc/landing/__tests__/mockFetch.json

@@ -1,370 +0,0 @@
-{
-    "content": [
-        {
-            "id": "atlas.en-us.230.0.apexcode.meta",
-            "key": "en-us",
-            "value": {
-                "_id": "atlas.en-us.apexcode.meta",
-                "_rev": "8-7d28d415d7759c3040ad3a6874daffb0",
-                "default_topic": "apexcode/apex_dev_guide.htm",
-                "title": "Apex Developer Guide",
-                "subtitle": "",
-                "tagline": "",
-                "shortdesc": "Learn about Salesforce Apex, the strongly typed, object-oriented, multitenant-aware programming language. Use Apex code to run flow and transaction control statements on the Salesforce platform. Apex syntax looks like Java and acts like database stored procedures. Developers can add business logic to most system events, including button clicks, related record updates, and Visualforce pages.",
-                "type": "Developer Guide",
-                "locale": "en-us",
-                "pdf_url": "https://resources.docs.salesforce.com/230/latest/en-us/sfdc/pdf/salesforce_apex_language_reference.pdf",
-                "service": "Force.com",
-                "topic": "App Logic",
-                "version": {
-                    "doc_version": "230.0",
-                    "release_name": "Spring '21",
-                    "api_version": "51.0"
-                },
-                "deliverable": "apexcode",
-                "prerelease": false,
-                "version_label": "",
-                "major": "230",
-                "minor": null,
-                "content_hash": "x4GMUSx37NfN7UMk/XkmFw==",
-                "updated": "2021-01-22",
-                "deliverable_content_hash": "/6BuE/I2HcZgwBXqCaImbg=="
-            }
-        },
-        {
-            "id": "atlas.en-us.230.0.formula_date_time_tipsheet.meta",
-            "key": "en-us",
-            "value": {
-                "_id": "atlas.en-us.formula_date_time_tipsheet.meta",
-                "_rev": "8-87b208db1d03cb2fccad9ad6585947c9",
-                "default_topic": "formula_date_time_tipsheet/formula_using_date_datetime.htm",
-                "title": "Using Date and Date/Time in Formulas",
-                "subtitle": "",
-                "tagline": "",
-                "shortdesc": "Learn how to use formulas to convert between date-related data types, how to work best with timezones, and how the TODAY(), NOW(), and DATE() functions work. We’ve included several useful examples to get you started.",
-                "type": "Tip Sheet",
-                "locale": "en-us",
-                "pdf_url": "https://resources.docs.salesforce.com/latest/latest/en-us/sfdc/pdf/formula_date_time_tipsheet.pdf",
-                "service": "Force.com",
-                "topic": "App Logic",
-                "version": {
-                    "doc_version": "230.0",
-                    "release_name": "Spring '21",
-                    "api_version": "51.0"
-                },
-                "deliverable": "formula_date_time_tipsheet",
-                "prerelease": false,
-                "version_label": "",
-                "major": "main",
-                "minor": null,
-                "content_hash": "HjgPe4OGWJc6WnIfAmrp3Q==",
-                "updated": "2021-01-22",
-                "deliverable_content_hash": "QfPjchQpQayxRT/YqtkKIw=="
-            }
-        },
-        {
-            "id": "atlas.en-us.230.0.salesforce_useful_approval_processes.meta",
-            "key": "en-us",
-            "value": {
-                "_id": "atlas.en-us.salesforce_useful_approval_processes.meta",
-                "_rev": "8-9d8f6a83dc3aaded9cbca02771573e8a",
-                "default_topic": "salesforce_useful_approval_processes/approvals_useful_approval_processes.htm",
-                "title": "Sample Approval Processes",
-                "subtitle": "",
-                "tagline": "",
-                "shortdesc": "Review samples of common approval processes to help you get started creating your own.",
-                "type": "Tip Sheet",
-                "locale": "en-us",
-                "pdf_url": "https://resources.docs.salesforce.com/latest/latest/en-us/sfdc/pdf/salesforce_useful_approval_processes.pdf",
-                "service": "Force.com",
-                "topic": "App Logic",
-                "version": {
-                    "doc_version": "230.0",
-                    "release_name": "Spring '21",
-                    "api_version": "51.0"
-                },
-                "deliverable": "salesforce_useful_approval_processes",
-                "prerelease": false,
-                "version_label": "",
-                "major": "main",
-                "minor": null,
-                "content_hash": "a110M2UlXnOCSw+zzlOPSw==",
-                "updated": "2021-01-22",
-                "deliverable_content_hash": "041j7LM6HuCoT7HXPWgOCw=="
-            }
-        },
-        {
-            "id": "atlas.en-us.230.0.usefulFormulaFields.meta",
-            "key": "en-us",
-            "value": {
-                "_id": "atlas.en-us.usefulFormulaFields.meta",
-                "_rev": "8-4458e886ce849aa438202e3ebaca266e",
-                "default_topic": "usefulFormulaFields/useful_advanced_formulas.htm",
-                "title": "Examples of Advanced Formula Fields",
-                "subtitle": "",
-                "tagline": "",
-                "shortdesc": "Review examples of formula fields for various types of apps that you can use and modify for your own purposes.",
-                "type": "Tip Sheet",
-                "locale": "en-us",
-                "pdf_url": "https://resources.docs.salesforce.com/230/latest/en-us/sfdc/pdf/salesforce_useful_formula_fields.pdf",
-                "service": "Force.com",
-                "topic": "App Logic",
-                "version": {
-                    "doc_version": "230.0",
-                    "release_name": "Spring '21",
-                    "api_version": "51.0"
-                },
-                "deliverable": "usefulFormulaFields",
-                "prerelease": false,
-                "version_label": "",
-                "major": "230",
-                "minor": null,
-                "content_hash": "kyUnV5iBJ04/Z6l+NrRWrA==",
-                "updated": "2021-01-22",
-                "deliverable_content_hash": "YhRlVP0AMJxO2lzz+gC1lg=="
-            }
-        },
-        {
-            "id": "atlas.en-us.230.0.usefulValidationRules.meta",
-            "key": "en-us",
-            "value": {
-                "_id": "atlas.en-us.usefulValidationRules.meta",
-                "_rev": "8-c9d1713fbd8ec5f9ca8f9a85e555d711",
-                "default_topic": "usefulValidationRules/fields_useful_field_validation_formulas.htm",
-                "title": "Examples of Validation Rules",
-                "subtitle": "",
-                "tagline": "",
-                "shortdesc": "Review examples of validation rules for various types of apps that you can use and modify for your own purposes. Validation rules verify that the data a user enters in a record meets the standards you specify before the user can save the record.",
-                "type": "Tip Sheet",
-                "locale": "en-us",
-                "pdf_url": "https://resources.docs.salesforce.com/230/latest/en-us/sfdc/pdf/salesforce_useful_validation_formulas.pdf",
-                "service": "Force.com",
-                "topic": "App Logic",
-                "version": {
-                    "doc_version": "230.0",
-                    "release_name": "Spring '21",
-                    "api_version": "51.0"
-                },
-                "deliverable": "usefulValidationRules",
-                "prerelease": false,
-                "version_label": "",
-                "major": "230",
-                "minor": null,
-                "content_hash": "BcNt5kcGnKyWLE9goSUe1w==",
-                "updated": "2021-01-22",
-                "deliverable_content_hash": "CurMAro4iwOB3hd/X34jzA=="
-            }
-        },
-        {
-            "id": "atlas.en-us.230.0.usefulWorkflowRules.meta",
-            "key": "en-us",
-            "value": {
-                "_id": "atlas.en-us.usefulWorkflowRules.meta",
-                "_rev": "8-455569315ee796cb695b24ca02ba18fd",
-                "default_topic": "usefulWorkflowRules/workflow_examples.htm",
-                "title": "Examples of Workflow Rules",
-                "subtitle": "",
-                "tagline": "",
-                "shortdesc": "Looking for ideas on how workflow rules can help streamline your business? Check out these examples.",
-                "type": "Tip Sheet",
-                "locale": "en-us",
-                "pdf_url": "https://resources.docs.salesforce.com/230/latest/en-us/sfdc/pdf/salesforce_useful_workflow_rules.pdf",
-                "service": "Force.com",
-                "topic": "App Logic",
-                "version": {
-                    "doc_version": "230.0",
-                    "release_name": "Spring '21",
-                    "api_version": "51.0"
-                },
-                "deliverable": "usefulWorkflowRules",
-                "prerelease": false,
-                "version_label": "",
-                "major": "230",
-                "minor": null,
-                "content_hash": "6IxVnuOWhxnQwc/SErCbHw==",
-                "updated": "2021-01-22",
-                "deliverable_content_hash": "82T/3e2Ily1whCD4gXPuyw=="
-            }
-        }
-    ],
-    "locale": "en-us",
-    "version": {
-        "doc_version": "230.0",
-        "release_name": "Spring '21",
-        "api_version": "51.0"
-    },
-    "available_languages": [
-        { "label": "ENGLISH", "locale": "en-us" },
-        { "label": "JAPANESE", "locale": "ja-jp" }
-    ],
-    "available_versions": [
-        {
-            "version_text": "Spring '21 (API version 51.0)",
-            "release_version": "51.0",
-            "doc_version": "230.0"
-        },
-        {
-            "version_text": "Winter '21 (API version 50.0)",
-            "release_version": "50.0",
-            "doc_version": "228.0"
-        },
-        {
-            "version_text": "Summer '20 (API version 49.0)",
-            "release_version": "49.0",
-            "doc_version": "226.0"
-        },
-        {
-            "version_text": "Spring '20 (API version 48.0)",
-            "release_version": "48.0",
-            "doc_version": "224.0"
-        },
-        {
-            "version_text": "Winter '20 (API version 47.0)",
-            "release_version": "47.0",
-            "doc_version": "222.0"
-        },
-        {
-            "version_text": "Summer '19 (API version 46.0)",
-            "release_version": "46.0",
-            "doc_version": "220.0"
-        },
-        {
-            "version_text": "Spring '19 (API version 45.0)",
-            "release_version": "45.0",
-            "doc_version": "218.0"
-        },
-        {
-            "version_text": "Winter '19 (API version 44.0)",
-            "release_version": "44.0",
-            "doc_version": "216.0"
-        },
-        {
-            "version_text": "Summer '18 (API version 43.0)",
-            "release_version": "43.0",
-            "doc_version": "214.0"
-        },
-        {
-            "version_text": "Spring '18 (API version 42.0)",
-            "release_version": "42.0",
-            "doc_version": "212.0"
-        },
-        {
-            "version_text": "Winter '18 (API version 41.0)",
-            "release_version": "41.0",
-            "doc_version": "210.0"
-        },
-        {
-            "version_text": "Summer '17 (API version 40.0)",
-            "release_version": "40.0",
-            "doc_version": "208.0"
-        },
-        {
-            "version_text": "Spring '17 (API version 39.0)",
-            "release_version": "39.0",
-            "doc_version": "206.0"
-        },
-        {
-            "version_text": "Winter '17 (API version 38.0)",
-            "release_version": "38.0",
-            "doc_version": "204.0"
-        },
-        {
-            "version_text": "Summer '16 (API version 37.0)",
-            "release_version": "37.0",
-            "doc_version": "202.0"
-        },
-        {
-            "version_text": "Spring '16 (API version 36.0)",
-            "release_version": "36.0",
-            "doc_version": "200.0"
-        },
-        {
-            "version_text": "Winter '16 (API version 35.0)",
-            "release_version": "35.0",
-            "doc_version": "198.0"
-        },
-        {
-            "version_text": "Summer '15 (API version 34.0)",
-            "release_version": "34.0",
-            "doc_version": "196.0"
-        },
-        {
-            "version_text": "Spring '15 (API version 33.0)",
-            "release_version": "33.0",
-            "doc_version": "194.0"
-        },
-        {
-            "version_text": "Winter '15 (API version 32.0)",
-            "release_version": "32.0",
-            "doc_version": "192.0"
-        },
-        {
-            "version_text": "Summer '14 (API version 31.0)",
-            "release_version": "31.0",
-            "doc_version": "190.0"
-        },
-        {
-            "version_text": "Spring '14 (API version 30.0)",
-            "release_version": "30.0",
-            "doc_version": "188.0"
-        },
-        {
-            "version_text": "Earlier Reference Docs",
-            "release_version": "",
-            "doc_version": "earlier"
-        }
-    ],
-    "available_services": [
-        {
-            "name": "All Services",
-            "icon": "/resource/images/docs/icons/allServices.png"
-        },
-        {
-            "name": "Force.com",
-            "icon": "/resource/images/docs/icons/forceDotCom.png"
-        },
-        {
-            "name": "Data.com",
-            "icon": "/resource/images/docs/icons/forceDotCom.png"
-        },
-        {
-            "name": "Salesforce1",
-            "icon": "/resource/images/docs/icons/salesforce1.png"
-        },
-        {
-            "name": "Einstein",
-            "icon": "/resource/images/docs/icons/einstein.png"
-        },
-        {
-            "name": "Einstein Analytics",
-            "icon": "/resource/images/docs/icons/wave.png"
-        },
-        {
-            "name": "Marketing Cloud",
-            "icon": "/resource/images/docs/icons/forceDotCom.png"
-        },
-        { "name": "Quip", "icon": "/resource/images/docs/icons/quip.png" }
-    ],
-    "available_topics": [
-        "Analytics",
-        "App Distribution",
-        "App Logic",
-        "Commerce",
-        "Database, Objects, Query, and Search",
-        "Financial Services Cloud, Industries",
-        "General Development",
-        "Health Cloud, Industries",
-        "Industries",
-        "Integration",
-        "Mobile",
-        "Platform Events, Integration",
-        "Salesforce IoT REST API, Integration",
-        "Security",
-        "Security, Encryption",
-        "Service Cloud",
-        "Tools",
-        "User Interface",
-        "Web Sites"
-    ],
-    "content_message": null
-}

package/src/modules/doc/landing/landing.css

@@ -1,66 +0,0 @@
-@import "helpers/reset";
-@import "helpers/card";
-@import "helpers/text";
-
-dx-button {
-    width: 100%;
-}
-
-.docs-results-container {
-    display: flex;
-    background-color: #fafaf9;
-}
-
-.docs-search-row {
-    display: flex;
-    flex-direction: column;
-    width: 100%;
-    padding-bottom: var(--dx-g-spacing-xs);
-}
-
-.docs-search-input {
-    width: 100%;
-}
-
-.docs-results-version-row {
-    display: flex;
-    align-items: center;
-    flex-wrap: wrap;
-}
-
-.docs-filter-column {
-    width: 30%;
-    margin: 10px;
-}
-
-.docs-results-column {
-    width: 70%;
-    margin: 10px;
-}
-
-.card-doc_detail-section {
-    display: flex;
-    flex-direction: column;
-    justify-content: center;
-    align-items: start;
-}
-
-.card-doc_detail-section {
-    padding-top: var(--dx-g-spacing-sm);
-}
-
-.card-doc_detail-metadata-row {
-    display: flex;
-    color: var(--dx-g-gray-10);
-    flex-wrap: wrap;
-    padding-top: var(--dx-g-spacing-sm);
-}
-
-.card-doc {
-    display: flex;
-    flex-direction: row;
-    padding-top: 10px;
-    padding-bottom: 10px;
-    margin-top: 10px;
-    margin-bottom: 10px;
-}