@salesforcedevs/dx-components 0.26.1-alpha0.6 → 0.27.0

package/src/modules/helpers/slds/slds.css

@@ -0,0 +1,191 @@
+:host(.slds-form-element_stacked) .slds-form-element__label,
+:host(.slds-form-element_stacked) .slds-form-element__control {
+    border-bottom: 0;
+    padding-left: 0;
+}
+
+:host(.slds-form-element_stacked) .slds-form-element__control {
+    width: 100%;
+    -ms-flex-preferred-size: 100%;
+    flex-basis: 100%;
+    clear: left;
+}
+
+@media (min-width: 48em) {
+    :host(.slds-form-element_horizontal) .slds-form-element__control {
+        padding-left: 33%;
+        clear: none;
+    }
+}
+
+:host(.slds-has-error) .slds-select {
+    border-color: #ea001e;
+    -webkit-box-shadow: #ea001e 0 0 0 1px inset;
+    box-shadow: #ea001e 0 0 0 1px inset;
+    background-clip: padding-box;
+}
+
+:host(.slds-has-error) .slds-select:focus,
+:host(.slds-has-error) .slds-select:active {
+    -webkit-box-shadow: #ea001e 0 0 0 1px inset, 0 0 3px #0176d3;
+    box-shadow: #ea001e 0 0 0 1px inset, 0 0 3px #0176d3;
+}
+
+:host(.slds-has-error) .slds-form-element__help {
+    color: #ea001e;
+}
+
+abbr[title] {
+    border-bottom: 1px dotted;
+}
+
+abbr[title] {
+    text-decoration: none;
+}
+
+abbr[title],
+fieldset,
+hr {
+    border: 0;
+}
+
+abbr[title] {
+    cursor: help;
+}
+
+abbr[title]:after {
+    content: " (" attr(title) ")";
+}
+
+button,
+select {
+    text-transform: none;
+}
+
+.slds-form-element__label {
+    overflow-wrap: break-word;
+    word-wrap: break-word;
+    -webkit-hyphens: auto;
+    -ms-hyphens: auto;
+    hyphens: auto;
+    display: inline-block;
+    color: #3e3e3c;
+    font-size: 0.75rem;
+    padding-right: 0.5rem;
+    padding-top: 0.25rem;
+    margin-bottom: 0.125rem;
+}
+
+.slds-form-element__label:empty {
+    margin: 0;
+}
+
+.slds-assistive-text {
+    position: absolute !important;
+    margin: -1px !important;
+    border: 0 !important;
+    padding: 0 !important;
+    width: 1px !important;
+    height: 1px !important;
+    overflow: hidden !important;
+    clip: rect(0 0 0 0) !important;
+    text-transform: none !important;
+    white-space: nowrap !important;
+}
+
+.slds-required {
+    color: #ea001e;
+    margin: 0 0.125rem;
+}
+
+.slds-form-element__control {
+    clear: left;
+    position: relative;
+}
+
+.slds-select {
+    height: calc(1.875rem + (1px * 2));
+    width: 100%;
+    border: 1px solid var(--sds-c-select-color-border, #dddbda);
+    border-radius: var(--sds-c-select-radius-border, 0.25rem);
+    background-color: var(--sds-c-select-color-background, white);
+    color: var(--sds-c-select-text-color);
+    -webkit-box-shadow: var(--sds-c-select-shadow);
+    box-shadow: var(--sds-c-select-shadow);
+    -webkit-transition: border 0.1s linear, background-color 0.1s linear;
+    transition: border 0.1s linear, background-color 0.1s linear;
+}
+
+.slds-select:required {
+    -webkit-box-shadow: none;
+    box-shadow: none;
+}
+
+.slds-select:focus,
+.slds-select:active {
+    outline: 0;
+    border-color: var(--sds-c-select-color-border-focus, #1b96ff);
+    background-color: var(--sds-c-select-color-background-focus, white);
+    color: var(--sds-c-select-text-color-focus);
+    -webkit-box-shadow: var(--sds-c-select-shadow-focus, 0 0 3px #0176d3);
+    box-shadow: var(--sds-c-select-shadow-focus, 0 0 3px #0176d3);
+}
+
+.slds-select[disabled],
+.slds-select.slds-is-disabled {
+    background-color: #ecebea;
+    border-color: #c9c7c5;
+    color: #3e3e3c;
+    cursor: not-allowed;
+    -webkit-user-select: none;
+    -moz-user-select: none;
+    -ms-user-select: none;
+    user-select: none;
+    opacity: 1;
+}
+
+.slds-select[disabled]:focus,
+.slds-select[disabled]:active,
+.slds-select.slds-is-disabled:focus,
+.slds-select.slds-is-disabled:active {
+    -webkit-box-shadow: none;
+    box-shadow: none;
+}
+
+.slds-select[size],
+.slds-select[multiple] {
+    min-height: calc(1.875rem + (1px * 2));
+    height: inherit;
+}
+
+.slds-select[size] option,
+.slds-select[multiple] option {
+    padding: 0.5rem;
+}
+
+.slds-select_container {
+    position: relative;
+    color: var(--sds-c-select-text-color);
+}
+
+.slds-select_container .slds-select {
+    -moz-appearance: none;
+    -webkit-appearance: none;
+    padding-left: 0.5rem;
+    padding-right: 1.5rem;
+}
+.slds-select_container .slds-select::-ms-expand {
+    display: none;
+}
+
+.slds-select[size] option,
+.slds-select[multiple] option {
+    padding: 0.5rem;
+}
+
+.slds-form-element__help,
+.slds-form-element__helper {
+    font-size: 0.75rem;
+    margin-top: 0.125rem;
+    display: block;
+}

package/src/modules/helpers/table/table.css

@@ -0,0 +1,110 @@
+table {
+    --table-border-radius: 4px;
+    --table-cell-text-base: var(--dx-g-text-sm);
+    --table-cell-line-height: var(--dx-g-text-lg);
+
+    display: block;
+    overflow-x: auto;
+    border-collapse: separate;
+    border-spacing: 0;
+    margin-top: var(--dx-g-spacing-lg);
+    margin-bottom: var(--dx-g-spacing-sm);
+}
+
+table tr {
+    height: 50px;
+}
+
+th,
+td {
+    padding: var(--dx-g-spacing-md);
+    font-size: var(--table-cell-text-base);
+    line-height: var(--table-cell-line-height);
+}
+
+th {
+    background-color: var(--dx-g-indigo-vibrant-95);
+    font-weight: var(--dx-g-font-bold);
+    border-bottom: 3px solid var(--dx-g-indigo-vibrant-30);
+}
+
+td {
+    vertical-align: top;
+}
+
+tr th,
+tr td {
+    text-align: left;
+}
+
+table tbody tr td {
+    vertical-align: middle;
+    border-bottom: 1px solid var(--dx-g-gray-90);
+}
+
+tr th:first-of-type,
+td:first-of-type {
+    min-width: 110px;
+}
+
+tr td:first-of-type {
+    border-left: 1px solid var(--dx-g-gray-90);
+}
+
+tr td:last-of-type {
+    border-right: 1px solid var(--dx-g-gray-90);
+}
+
+tr:first-of-type th:first-of-type {
+    border-top-left-radius: var(--table-border-radius);
+}
+
+tr:first-of-type th:last-of-type {
+    border-top-right-radius: var(--table-border-radius);
+}
+
+table :not(thead + tbody) tr:first-of-type td {
+    border-top: 1px solid var(--dx-g-gray-90);
+}
+
+tr:last-of-type td:first-of-type {
+    border-bottom-left-radius: var(--table-border-radius);
+    border-bottom: 1px solid var(--dx-g-gray-90);
+    border-left: 1px solid var(--dx-g-gray-90);
+}
+
+tr:last-of-type td:last-of-type {
+    border-bottom-right-radius: var(--table-border-radius);
+    border-bottom: 1px solid var(--dx-g-gray-90);
+    border-right: 1px solid var(--dx-g-gray-90);
+}
+
+tr td[colspan]:not([colspan="1"]) {
+    text-align: center;
+}
+
+/**
+ * Inside of a <td>, we want font size not to increase as it otherwise would
+ * for standard inline/"prose-level" elements (e.g., <p>, <li>). But we *do*
+ * want to leave font size increases in place for *other* elements inside <td>,
+ * like callouts, headings (<h1>, <h2>, etc.), and so on. In order not to
+ * "stomp" on too much -- and because we don't control the markup, so can't
+ * easily add new CSS classes, etc. -- we try to pick out the specific
+ * structures only here. (See https://gus.lightning.force.com/lightning/r/ADM_Work__c/a07EE0000081MGTYA2/view)
+ */
+td :is(.li, p, .p, dd) {
+    font-size: var(--table-cell-text-base);
+}
+
+td doc-content-callout :is(.li, p, .p, dd) {
+    /* Override/reset for callouts -- see https://gus.lightning.force.com/lightning/r/ADM_Work__c/a07EE0000081MGTYA2/view */
+    font-size: var(--dx-g-text-base);
+}
+
+table :not(thead + tbody) tr:first-of-type td:first-of-type {
+    border-top-left-radius: var(--table-border-radius);
+}
+
+table :not(thead + tbody) tr:first-of-type td:last-of-type {
+    border-top-right-radius: var(--table-border-radius);
+}

package/src/modules/helpers/text/text.css

@@ -0,0 +1,163 @@
+.dx-text-heading-1 {
+    color: var(--dx-g-text-heading-color);
+    font-family: var(--dx-g-font-display);
+    font-size: 64px; /* not registered */
+    letter-spacing: -0.6px;
+    line-height: 64px;
+}
+
+.dx-text-heading-2 {
+    color: var(--dx-g-text-heading-color);
+    font-family: var(--dx-g-font-display);
+    font-size: var(--dx-g-text-5xl);
+    letter-spacing: -0.6px;
+    line-height: 60px;
+}
+
+.dx-text-heading-3 {
+    color: var(--dx-g-text-heading-color);
+    font-family: var(--dx-g-font-display);
+    font-size: var(--dx-g-text-3xl);
+    letter-spacing: -0.4px;
+    line-height: 40px;
+}
+
+.dx-text-heading-4 {
+    color: var(--dx-g-text-heading-color);
+    font-family: var(--dx-g-font-display);
+    font-size: var(--dx-g-text-xl);
+    letter-spacing: -0.1px;
+    line-height: 28px;
+}
+
+.dx-text-heading-5 {
+    color: var(--dx-g-text-heading-color);
+    font-family: var(--dx-g-font-display);
+    font-size: 18px; /* not registered */
+    letter-spacing: -0.1px;
+    line-height: 24px;
+}
+
+.dx-text-heading-6 {
+    color: var(--dx-g-text-heading-color);
+    font-family: var(--dx-g-font-display);
+    font-size: var(--dx-g-text-base);
+    letter-spacing: 0;
+    line-height: 20px;
+}
+
+.dx-text-heading-7 {
+    color: var(--dx-g-text-heading-color);
+    font-family: var(--dx-g-font-display);
+    font-size: var(--dx-g-text-sm);
+    letter-spacing: 0;
+    line-height: 18px;
+}
+
+.dx-text-heading-alt-1 {
+    color: var(--dx-g-text-label-color);
+    font-family: var(--dx-g-font-sans);
+    font-size: var(--slds-text-lg);
+    line-height: 25px;
+}
+
+.dx-text-body-1 {
+    color: var(--dx-g-text-body-color);
+    font-family: var(--dx-g-font-sans);
+    font-size: var(--dx-g-text-lg);
+    letter-spacing: 0;
+    line-height: 32px;
+}
+
+.dx-text-body-2 {
+    color: var(--dx-g-text-body-color);
+    font-family: var(--dx-g-font-sans);
+    font-size: var(--dx-g-text-base);
+    letter-spacing: 0;
+    line-height: 24px;
+}
+
+.dx-text-body-3 {
+    color: var(--dx-g-text-body-color);
+    font-family: var(--dx-g-font-sans);
+    font-size: var(--dx-g-text-sm);
+    letter-spacing: 0;
+    line-height: 20px;
+}
+
+.dx-text-body-4 {
+    color: var(--dx-g-text-body-color);
+    font-family: var(--dx-g-font-sans);
+    font-size: var(--dx-g-text-xs);
+    letter-spacing: 0;
+    line-height: 18px;
+}
+
+.dx-text-button-brand {
+    color: var(--dx-g-text-button-color);
+    font-family: var(--dx-g-font-display);
+    font-size: var(--dx-g-text-sm);
+    letter-spacing: 0;
+    line-height: 20px;
+}
+
+.dx-text-button-light {
+    color: var(--dx-g-text-button-light-color);
+    font-family: var(--dx-g-font-display);
+    font-size: var(--dx-g-text-sm);
+    letter-spacing: 0;
+    line-height: 20px;
+}
+
+.dx-text-label-1 {
+    color: var(--dx-g-text-heading-color);
+    font-family: var(--dx-g-font-display);
+    font-size: var(--dx-g-text-sm);
+    letter-spacing: 0.7px;
+    line-height: 16px;
+    text-align: center;
+    text-transform: uppercase;
+}
+
+.dx-text-label-1-dark {
+    color: var(--dx-g-text-label-color);
+    font-family: var(--dx-g-font-display);
+    font-size: var(--dx-g-text-sm);
+    letter-spacing: 0.7px;
+    line-height: 16px;
+    text-align: center;
+    text-transform: uppercase;
+}
+
+.dx-text-label-2 {
+    color: var(--dx-g-text-heading-color);
+    font-family: var(--dx-g-font-display);
+    font-size: var(--dx-g-text-xs);
+    letter-spacing: 0.7px;
+    line-height: 16px;
+    text-transform: uppercase;
+}
+
+.dx-text-label-3 {
+    color: var(--dx-g-text-label-color);
+    font-family: var(--dx-g-font-display);
+    font-size: var(--dx-g-text-xs);
+    font-weight: var(--dx-g-font-demi);
+    letter-spacing: 0.7px;
+    line-height: 16px;
+    text-transform: uppercase;
+}
+
+.dx-text-form-error-message {
+    font-family: var(--dx-g-font-sans);
+    color: var(--dx-g-red-vibrant-50);
+    font-size: var(--dx-g-text-xs);
+    line-height: 14px;
+}
+
+.dx-text-truncate {
+    display: -webkit-box;
+    -webkit-line-clamp: var(--dx-c-max-lines, 6);
+    -webkit-box-orient: vertical;
+    overflow: hidden;
+}

package/src/modules/utils/coveo/coveo.ts

@@ -0,0 +1,70 @@
+import {
+    buildSearchEngine as _buildSearchEngine,
+    SearchAppState,
+    SearchEngineOptions
+} from "@coveo/headless";
+
+export const buildSearchEngine = ({
+    organizationId,
+    preloadedState,
+    publicAccessToken,
+    searchHub,
+    searchPipeline
+}: {
+    organizationId: string;
+    publicAccessToken: string;
+    searchPipeline?: string;
+    searchHub: string;
+    preloadedState?: SearchAppState;
+}) => {
+    const search = searchPipeline
+        ? { pipeline: searchPipeline, searchHub }
+        : { searchHub };
+
+    const configuration = {
+        accessToken: publicAccessToken,
+        organizationId,
+        search
+    };
+
+    const engineConfiguration: SearchEngineOptions = preloadedState
+        ? { configuration, preloadedState }
+        : { configuration };
+
+    return _buildSearchEngine(engineConfiguration);
+};
+
+export const getSidebarSearchParams = () =>
+    new URLSearchParams(window.location.search).get("q");
+
+const coveoOrganizationId = "coveosalesforcetestakshatha";
+const coveoPublicAccessToken = "xxfeb39525-e402-4e41-a870-7132441f7875";
+
+export const coveoHeaderConfig = {
+    coveoOrganizationId,
+    coveoPublicAccessToken,
+    coveoSearchPipeline: "salesforcedevdoc",
+    coveoSearchHub: "salesforcedevdoc"
+};
+
+export const coveoXMLDocsConfig = {
+    coveoOrganizationId,
+    coveoPublicAccessToken,
+    coveoSearchHub: "Developer_Docs_SS",
+    coveoAdvancedQueryConfig: JSON.stringify({
+        objecttype: "HTDeveloperDocumentsC",
+        sflocale__c: "en_US",
+        sfrelease__c: "232.0",
+        sfdelivarable__c: "apexcode"
+    })
+};
+
+export const coveoSFDocsConfig = {
+    coveoOrganizationId,
+    coveoPublicAccessToken,
+    coveoSearchHub: "Developer_MdDocs_SS",
+    coveoAdvancedQueryConfig: JSON.stringify({
+        source: "Sitemap - Developer Docs",
+        path_segment_3: "pardot"
+    })
+};

package/src/modules/utils/css/css.ts

@@ -0,0 +1,43 @@
+import { Color } from "typings/custom";
+
+const LABEL_TO_DX_VAR: { [key: string]: string } = {
+    blue: "blue-vibrant",
+    "cloud-blue": "cloud-blue-vibrant",
+    green: "green-vibrant",
+    "hot-orange": "hot-orange-vibrant",
+    indigo: "indigo-vibrant",
+    orange: "orange-vibrant",
+    pink: "pink-vibrant",
+    purple: "purple-vibrant",
+    red: "red-vibrant",
+    teal: "teal-natural",
+    violet: "violet-vibrant",
+    yellow: "yellow-natural"
+};
+
+const DEFAULT_BACKGROUND_LEVEL = 95;
+const DEFAULT_COLOR_LEVEL = 40;
+
+export const colorToDxColors = (
+    color?: Color
+): {
+    background: string;
+    color: string;
+} | null => {
+    if (!color) {
+        return null;
+    }
+
+    const dxVarColor = LABEL_TO_DX_VAR[color];
+    if (!dxVarColor) {
+        return null;
+    }
+
+    return {
+        background: `--dx-g-${dxVarColor}-${DEFAULT_BACKGROUND_LEVEL}`,
+        color: `--dx-g-${dxVarColor}-${DEFAULT_COLOR_LEVEL}`
+    };
+};
+
+export const toDxColor = (color: string) =>
+    ["white", "transparent"].includes(color) ? color : `var(--dx-g-${color})`;

package/src/modules/utils/devices/devices.ts

@@ -0,0 +1 @@
+export const isMac = () => navigator.userAgent.indexOf("Mac OS X") !== -1;

package/src/modules/utils/highlight/highlight.ts

@@ -0,0 +1,32 @@
+import { createSearchRegExp } from "utils/regexps";
+
+const MARK_TAGS = /<\/?mark>/gi;
+
+export const highlightTerms = (
+    // eslint-disable-next-line no-undef
+    elements: NodeListOf<Element>,
+    searchTerm: string
+): void => {
+    searchTerm = searchTerm.trim();
+    const searchExp = createSearchRegExp(searchTerm);
+    elements.forEach((element) => {
+        if (
+            element?.innerHTML.includes("<dx-") ||
+            element?.innerHTML.includes("<doc-")
+        ) {
+            return;
+        }
+
+        let innerHtml = element.innerHTML.replace(
+            // Remove previously added mark tags
+            MARK_TAGS,
+            ""
+        );
+
+        if (searchTerm) {
+            innerHtml = innerHtml.replace(searchExp, "<mark>$&</mark>");
+        }
+
+        element.innerHTML = innerHtml;
+    });
+};

package/src/modules/utils/normalizers/normalizers.ts

@@ -0,0 +1,91 @@
+import get from "lodash.get";
+
+export const toJson = (value: string | object | null) =>
+    typeof value === "string" ? JSON.parse(value) : value;
+
+export const normalizeToArray = (
+    value: string[] | string | null,
+    splitKey: string = ","
+): Array<string> => {
+    if (!value) {
+        return [];
+    }
+
+    if (typeof value === "string") {
+        try {
+            value = JSON.parse(value);
+        } catch (e) {
+            value = (value as string).split(splitKey);
+        }
+    }
+
+    return (Array.isArray(value) ? value : [value]) as Array<string>;
+};
+
+type WordpressPodcastEpisode = {
+    date: string;
+    description: string;
+    id: string;
+    originalUrl: string;
+    podcastDuration: string;
+    title: string;
+    url: string;
+};
+
+const getLength = (duration: string) => {
+    if (!duration || !duration.includes(":")) {
+        return undefined;
+    }
+    return `${get(duration.split(":"), "[1]")} min`;
+};
+
+export const normalizeEpisode = ({
+    url,
+    id,
+    title,
+    description,
+    date,
+    podcastDuration
+}: WordpressPodcastEpisode) => ({
+    body: description,
+    datetime: date,
+    href: url,
+    id,
+    length: getLength(podcastDuration),
+    title
+});
+
+type WordpressBlogPost = {
+    date: string;
+    description: string;
+    id: string;
+    originalUrl: string;
+    title: string;
+    url: string;
+    authors: any[];
+    featuredImage: string;
+};
+
+export const normalizePost = ({
+    authors = [],
+    date,
+    description,
+    featuredImage,
+    id,
+    title,
+    url
+}: WordpressBlogPost) => ({
+    body: description,
+    datetime: date,
+    href: url,
+    authorHref: get(authors, "[0].link"),
+    authorImgSrc: get(authors, "[0].avatar_urls.48"),
+    authorName: get(authors, "[0].name"),
+    imgAlt: "Blogpost image",
+    imgSrc: featuredImage,
+    id,
+    title
+});
+
+export const normalizeBoolean = (value: string | boolean | number): boolean =>
+    typeof value === "string" ? value === "true" : !!value;