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

package/src/modules/doc/landing/landing.html

@@ -1,122 +0,0 @@
-<template>
-    <div class="docs-results-container">
-        <div class="docs-filter-column">
-            <div class="docs-search-row">
-                <template if:true={availableLanguages}>
-                    <dx-dropdown
-                        onchange={handleFilterChange}
-                        data-type="language"
-                        offset="medium"
-                        options={availableLanguages}
-                    >
-                        <dx-button
-                            variant="secondary"
-                            icon-symbol="chevrondown"
-                        >
-                            {selectedLanguageLabel}
-                        </dx-button>
-                    </dx-dropdown>
-                </template>
-            </div>
-            <div class="docs-search-row">
-                <template if:true={availableVersions}>
-                    <dx-dropdown
-                        onchange={handleFilterChange}
-                        data-type="version"
-                        options={availableVersions}
-                    >
-                        <dx-button
-                            variant="secondary"
-                            icon-symbol="chevrondown"
-                        >
-                            {selectedVersionLabel}
-                        </dx-button>
-                    </dx-dropdown>
-                </template>
-            </div>
-            <div class="docs-search-row">
-                <template if:true={availableServices}>
-                    <dx-dropdown
-                        onchange={handleFilterChange}
-                        data-type="service"
-                        options={availableServices}
-                    >
-                        <dx-button
-                            variant="secondary"
-                            icon-symbol="chevrondown"
-                        >
-                            {selectedService}
-                        </dx-button>
-                    </dx-dropdown>
-                </template>
-            </div>
-            <div class="docs-search-row">
-                <template if:true={availableTopics}>
-                    <dx-dropdown
-                        onchange={handleFilterChange}
-                        data-type="topic"
-                        options={availableTopics}
-                    >
-                        <dx-button
-                            variant="secondary"
-                            icon-symbol="chevrondown"
-                        >
-                            {selectedTopic}
-                        </dx-button>
-                    </dx-dropdown>
-                </template>
-            </div>
-        </div>
-        <div class="docs-results-column">
-            <div class="docs-search-row">
-                <dx-input
-                    class="docs-search-input"
-                    icon-symbol="search"
-                    onchange={handleSearchChange}
-                    placeholder="Search..."
-                    size="large"
-                    submit-label="Submit"
-                ></dx-input>
-            </div>
-            <div class="docs-search-row">
-                <template if:true={content}>
-                    <template
-                        for:each={contentResults}
-                        for:item="item"
-                        for:index="i"
-                    >
-                        <a
-                            class="card-doc dx-card-base"
-                            href={item.href}
-                            target="_self"
-                            key={item.i}
-                        >
-                            <div class="dx-card-base_section-vertical">
-                                <h4 class="dx-text-heading-4 title">
-                                    {item.value.title}
-                                </h4>
-                                <span
-                                    class="card-doc_detail-section dx-text-body-3"
-                                >
-                                    {item.value.shortdesc}
-                                </span>
-                                <span
-                                    class="dx-text-body-3 card-doc_detail-metadata-row"
-                                >
-                                    API Version {item.value.version.api_version}
-                                    | {item.value.locale} |
-                                    <dx-formatted-date-time
-                                        year="numeric"
-                                        day="numeric"
-                                        month="numeric"
-                                        value={item.value.updated}
-                                    ></dx-formatted-date-time>
-                                </span>
-                            </div>
-                        </a>
-                    </template>
-                </template>
-            </div>
-        </div>
-    </div>
-</template>

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

@@ -1,21 +0,0 @@
-export default {
-    title: "docs/doc-landing",
-    component: "doc-landing"
-};
-
-export const Base = () => {
-    return `
-    <doc-landing></doc-landing>
-`;
-};
-
-export const DefaultUrl = (args: any) => {
-    return `
-    <doc-landing default-url='${args.defaultUrl}'></doc-landing>
-`;
-};
-
-DefaultUrl.args = {
-    defaultUrl:
-        "https://staging.developer.salesforce.com/docs/get_index/en-us/000.0/false/All%20Services/all"
-};

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

@@ -1,222 +0,0 @@
-import { LightningElement, track, api } from "lwc";
-import {
-    AvailableLanguages,
-    AvailableVersions,
-    Option,
-    SelectedVersion
-} from "typings/custom";
-
-export default class Landing extends LightningElement {
-    @api defaultUrl: string =
-        "https://developer.salesforce.com/docs/get_index/en-us/000.0/false/All%20Services/all";
-    @track content: any;
-    @track filteredContent: any;
-    selectedService: String = "All Services";
-    selectedTopic: String = "All Topics";
-    selectedLocale: String = "";
-    selectedVersion = {
-        doc_version: String,
-        release_name: String,
-        api_version: String
-    };
-    searchTerm: String = "";
-    availableServices: Option[];
-    availableTopics: Option[];
-    selectedLanguage: String;
-    availableLanguages: Option[];
-    availableVersions: Option[];
-
-    connectedCallback() {
-        this.fetchDocData("initial");
-    }
-
-    handleFilterChange(event: Event) {
-        const value = event.detail;
-        const type = event.currentTarget.dataset.type;
-        console.log(value, type);
-        switch (type) {
-            case "language":
-                this.selectedLanguage = event.detail;
-                break;
-            case "version":
-                this.selectedVersion.doc_version = value;
-                break;
-            case "topic":
-                this.selectedTopic = value;
-                break;
-            case "service":
-                this.selectedService = value;
-                break;
-            default:
-                break;
-        }
-        this.fetchDocData("");
-    }
-
-    handleSearchChange(event: Event) {
-        const value = event.detail;
-        console.log(value);
-        this.searchTerm = value.toLowerCase();
-        this.filteredContent = this.content.filter(
-            (contentItem) =>
-                contentItem.value.shortdesc
-                    .toLowerCase()
-                    .includes(this.searchTerm) ||
-                contentItem.value.title.toLowerCase().includes(this.searchTerm)
-        );
-    }
-
-    fetchDocData(searchType: string) {
-        const docRestUrl = this.generateCalloutURL(searchType);
-        fetch(docRestUrl)
-            .then((results) => {
-                return results.json();
-            })
-            .then((json) => {
-                const searchResults = json;
-                this.content = this.normalizeContent(searchResults.content);
-                console.log(JSON.stringify(this.content));
-                this.selectedLanguage = searchResults.locale;
-                this.selectedVersion = searchResults.version;
-                this.availableLanguages = this.normalizeLanguageOptions(
-                    searchResults.available_languages,
-                    this.selectedLanguage
-                );
-                this.availableVersions = this.normalizeVersionOptions(
-                    searchResults.available_versions,
-                    this.selectedVersion
-                );
-                this.availableServices = this.normalizeAvailableServices(
-                    searchResults.available_services,
-                    this.selectedService
-                );
-                this.availableTopics = this.normalizeAvailableTopics(
-                    searchResults.available_topics,
-                    this.selectedTopic
-                );
-            })
-            .catch((error) => console.log(error));
-    }
-
-    normalizeContent(content: String) {
-        for (const key in content) {
-            if (content[key]) {
-                const contentItem = content[key];
-                const origin = window.location.origin;
-                content[
-                    key
-                ].href = `${origin}/docs/${contentItem.value._id}/${contentItem.value.default_topic}`;
-            }
-        }
-        return content;
-    }
-
-    normalizeLanguageOptions(
-        languages: AvailableLanguages,
-        selectedLanguage: String
-    ) {
-        const availableLanguages = [];
-        for (const key in languages) {
-            if (languages[key]) {
-                const language = languages[key];
-                availableLanguages.push(
-                    this.normalizeOption(
-                        language.locale,
-                        language.label,
-                        selectedLanguage
-                    )
-                );
-            }
-        }
-        console.log(JSON.stringify(availableLanguages));
-        return availableLanguages;
-    }
-
-    normalizeVersionOptions(
-        versions: AvailableVersions,
-        selectedVersion: SelectedVersion
-    ) {
-        const availableVersions = [];
-        for (const key in versions) {
-            if (versions[key]) {
-                const version = versions[key];
-                availableVersions.push(
-                    this.normalizeOption(
-                        version.doc_version,
-                        version.version_text,
-                        selectedVersion.doc_version
-                    )
-                );
-            }
-        }
-        return availableVersions;
-    }
-
-    normalizeAvailableServices(services: any, selectedService: String) {
-        const availableServices = [];
-        for (const key in services) {
-            if (services[key]) {
-                const name = services[key].name;
-                availableServices.push(
-                    this.normalizeOption(name, name, selectedService)
-                );
-            }
-        }
-        return availableServices;
-    }
-
-    normalizeAvailableTopics(topics: any, selectedTopic: String) {
-        const availableTopics = [];
-        for (const key in topics) {
-            if (topics[key]) {
-                const name = topics[key];
-                availableTopics.push(
-                    this.normalizeOption(name, name, selectedTopic)
-                );
-            }
-        }
-        return availableTopics;
-    }
-
-    normalizeOption(id: String, label: String, activeOption: String) {
-        const option: Option = {};
-        option.id = id;
-        option.label = label;
-        option.isActive = id === activeOption;
-        return option;
-    }
-
-    generateCalloutURL(searchType: String) {
-        if (searchType === "initial") {
-            return this.defaultUrl;
-        }
-        const selected =
-            this.selectedTopic === "All Topics" ? "all" : this.selectedTopic;
-        return encodeURI(
-            `https://developer.salesforce.com/docs/get_index/${this.selectedLanguage}/${this.selectedVersion.doc_version}/false/${this.selectedService}/${selected}`
-        );
-    }
-
-    get selectedLanguageLabel() {
-        const selectedLanguage = this.availableLanguages.filter(
-            (language) => language.id === this.selectedLanguage
-        )[0];
-        return selectedLanguage.label;
-    }
-
-    get selectedVersionLabel() {
-        const selectedVersion = this.availableVersions.filter(
-            (version) => version.id === this.selectedVersion.doc_version
-        )[0];
-        return selectedVersion.label;
-    }
-
-    get contentResults() {
-        console.log(this.searchTerm.length);
-        if (this.searchTerm.length >= 1) {
-            console.log(this.filteredContent);
-            return this.filteredContent;
-        }
-        return this.content;
-    }
-}

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