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

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

@@ -1,113 +0,0 @@
-import { html } from "lit-html";
-
-export default {
-    title: "docs/doc-content-media",
-    component: "doc-content-media"
-};
-
-// prettier-ignore
-const styles = () => html `
-    <style>
-        .container-sm {
-            max-width: 540px;
-            margin: 0 auto;
-        }
-
-        .container-fw {
-            width: 100%;
-        }
-
-        h1 {
-            font-size: 36px;
-        }
-
-        h2 {
-            font-size: 24px;
-        }
-
-        h1, h2 {
-            font-weight: bold;
-        }
-    </style>
-`;
-
-// prettier-ignore
-export const Base = () => html`${styles()}
-    <div class="container-sm">
-        <h1>Small Container</h1>
-        <h2>Images</h2>
-        <doc-content-media
-            content-type="image"
-            content-src="https://placekitten.com/400/300"
-            media-title="A cute kitten"
-            caption="An incredibly cute kitten"
-        ></doc-content-media>
-        <doc-content-media
-            content-type="image"
-            content-src="https://placekitten.com/400/300"
-            media-title="A cute kitten"
-        ></doc-content-media>
-        <doc-content-media
-            content-type="image"
-            content-src="https://placekitten.com/400/300"
-            caption="An incredibly cute kitten"
-        ></doc-content-media>
-        <doc-content-media
-            content-type="image"
-            content-src="https://placekitten.com/400/300"
-        ></doc-content-media>
-
-        <h2>IFrames</h2>
-        <doc-content-media
-            content-type="iframe"
-            content-src="https://www.youtube.com/embed/DfV7WnyEPTE"
-            media-title="Master Lightning Web Components in 8 Easy Steps (1)"
-            caption="Lightning Web Components are a new development platform for Salesforce."
-        ></doc-content-media>
-        <doc-content-media
-            content-type="iframe"
-            content-src="https://play.vidyard.com/yThw736PBYf18ts1f8SKXa?disable_popouts=1&v=4.2.30&type=inline"
-            media-title="Non-YouTube Video"
-            caption="doc-content-media supports iframes from any origin."
-        ></doc-content-media>
-    </div>
-
-    <div class="container-fw">
-        <h1>Full-width Container</h1>
-        <h2>Images</h2>
-        <doc-content-media
-            content-type="image"
-            content-src="https://placekitten.com/400/300"
-            media-title="A cute kitten"
-            caption="An incredibly cute kitten"
-        ></doc-content-media>
-        <doc-content-media
-            content-type="image"
-            content-src="https://placekitten.com/400/300"
-            media-title="A cute kitten"
-        ></doc-content-media>
-        <doc-content-media
-            content-type="image"
-            content-src="https://placekitten.com/400/300"
-            caption="An incredibly cute kitten"
-        ></doc-content-media>
-        <doc-content-media
-            content-type="image"
-            content-src="https://placekitten.com/400/300"
-        ></doc-content-media>
-
-        <h2>IFrames</h2>
-        <doc-content-media
-            content-type="iframe"
-            content-src="https://www.youtube.com/embed/DfV7WnyEPTE"
-            media-title="Master Lightning Web Components in 8 Easy Steps (1)"
-            caption="Lightning Web Components are a new development platform for Salesforce."
-        ></doc-content-media>
-        <doc-content-media
-            content-type="iframe"
-            content-src="https://play.vidyard.com/yThw736PBYf18ts1f8SKXa?disable_popouts=1&v=4.2.30&type=inline"
-            media-title="Non-YouTube Video"
-            caption="doc-content-media supports iframes from any origin."
-        ></doc-content-media>
-    </div>
-`;

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

@@ -1,60 +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);
-const LANDING_DEFAULT_URL =
-    "https://developer.salesforce.com/docs/get_index/en-us/000.0/false/All%20Services/all";
-const LANDING_ALTERNATE_URL =
-    "https://staging.developer.salesforce.com/docs/get_index/en-us/000.0/false/All%20Services/all";
-
-function mockFetch() {
-    return jest.fn().mockImplementation(() => {
-        const data = mockFetchResponse;
-        return Promise.resolve({
-            ok: true,
-            json: () => data
-        });
-    });
-}
-
-describe(TAG, () => {
-    describe("doc-landing", () => {
-        afterEach(() => {
-            jest.resetAllMocks();
-        });
-
-        it("renders the landing page", async () => {
-            global.fetch = mockFetch();
-            const element = render();
-            expect(global.fetch).toHaveBeenCalledTimes(1);
-            expect(global.fetch).toHaveBeenCalledWith(LANDING_DEFAULT_URL);
-            const els = [
-                ".docs-results-container",
-                ".docs-search-row"
-            ].map((query) => element.shadowRoot.querySelector(query));
-            expect(els).not.toContain(null);
-            await expect(element).toBeAccessible();
-        });
-
-        it("binds the correct default value for defaultUrl", async () => {
-            global.fetch = mockFetch();
-            const element = render();
-            expect(global.fetch).toHaveBeenCalledTimes(1);
-            expect(global.fetch).toHaveBeenCalledWith(LANDING_DEFAULT_URL);
-            expect(element.defaultUrl).toBe(LANDING_DEFAULT_URL);
-            await expect(element).toBeAccessible();
-        });
-
-        it("binds the correct value for defaultUrl", async () => {
-            global.fetch = mockFetch();
-            const element = render({ defaultUrl: LANDING_ALTERNATE_URL });
-            expect(global.fetch).toHaveBeenCalledTimes(1);
-            expect(global.fetch).toHaveBeenCalledWith(LANDING_ALTERNATE_URL);
-            expect(element.defaultUrl).toBe(LANDING_ALTERNATE_URL);
-            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,63 +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 {
-    --dx-c-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;
-    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;
-}