@salesforcedevs/dx-components 0.0.0

package/src/modules/dxHelpers/text/text.css

@@ -0,0 +1,197 @@
+.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-2b {
+    color: var(--dx-g-text-heading-color);
+    font-family: var(--dx-g-font-display);
+    font-size: var(--dx-g-text-4xl);
+    letter-spacing: -0.6px;
+    line-height: 56px;
+}
+
+.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-3b {
+    color: var(--dx-g-text-heading-color);
+    font-family: var(--dx-g-font-display);
+    font-size: var(--dx-g-text-2xl);
+    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-4b {
+    color: var(--dx-g-text-heading-color);
+    font-family: var(--dx-g-font-display);
+    font-size: var(--dx-g-text-lg);
+    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-label-4 {
+    color: var(--dx-g-text-label-color);
+    font-family: var(--dx-g-font-display);
+    font-size: var(--dx-g-text-base);
+    font-weight: var(--dx-g-font-demi);
+    letter-spacing: 0.5%;
+    line-height: 20px;
+    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/dxUtils/analytics/analytics.ts

@@ -0,0 +1,24 @@
+export const TRACKING_EVENT_NAME = "developerwebsite_track";
+export const LISTENER_QUEUE = "__DX_INSTRUMENTATION_QUEUE__";
+export const LISTENER_INDICATOR = "__DX_INSTRUMENTATION_IS_INITIALIZED__";
+
+export function track(
+    element: EventTarget,
+    event: string,
+    payload: Record<string, unknown>
+): void {
+    const detail = { event, payload };
+    // if window.LISTENER_INDICATOR is undefined, `dx-instrumentation` has not
+    // been mounted, and the listener hasn't been attached.
+    if ((window as any)[LISTENER_INDICATOR] === undefined) {
+        (window as any)[LISTENER_QUEUE] = (window as any)[LISTENER_QUEUE] || [];
+        (window as any)[LISTENER_QUEUE].push(detail);
+    } else {
+        const e = new CustomEvent(TRACKING_EVENT_NAME, {
+            bubbles: true,
+            composed: true,
+            detail
+        });
+        element.dispatchEvent(e);
+    }
+}

package/src/modules/dxUtils/browser/browser.ts

@@ -0,0 +1,17 @@
+/**
+ * Returns whether given element is in browser viewport or not
+ */
+function isInViewport(element: HTMLElement): boolean {
+    const rect = element?.getBoundingClientRect();
+    return (
+        rect &&
+        rect.top >= 0 &&
+        rect.left >= 0 &&
+        rect.bottom <=
+            (window.innerHeight || document.documentElement.clientHeight) &&
+        rect.right <=
+            (window.innerWidth || document.documentElement.clientWidth)
+    );
+}
+
+export { isInViewport };

package/src/modules/dxUtils/constants/breakpoints.ts

@@ -0,0 +1,9 @@
+// these breakpoints are written in terms of "max-width"
+export const BREAKPOINT_MOBILE_SMALL = "640px";
+export const BREAKPOINT_MOBILE = "768px";
+export const BREAKPOINT_TABLET = "1024px";
+export const BREAKPOINT_DESKTOP = "1280px";
+
+export const DEVICE_DESKTOP = "desktop";
+export const DEVICE_TABLET = "tablet";
+export const DEVICE_MOBILE = "mobile";

package/src/modules/dxUtils/constants/constants.ts

@@ -0,0 +1 @@
+export * from "./breakpoints";

package/src/modules/dxUtils/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/dxUtils/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/dxUtils/dates/dates.ts

@@ -0,0 +1,60 @@
+const MONTHS = {
+    January: 0,
+    February: 1,
+    March: 2,
+    April: 3,
+    May: 4,
+    June: 5,
+    July: 6,
+    August: 7,
+    September: 8,
+    October: 9,
+    November: 10,
+    December: 11
+};
+
+/*
+    sorts the months by their date heading, for example:
+    {
+        "February 2022": [ *array of dates for this month* ],
+        "January 2022": [ *array of dates for this month* ],
+    }
+*/
+
+export function sortSplittedPostsByMonth(postsByMonth: any) {
+    const sortedPostsByMonth: { [key: string]: Array<{}> } = {};
+
+    Object.keys(postsByMonth)
+        .sort((a, b) => {
+            const [aMonth, aYear] = a.split(" ");
+            const [bMonth, bYear] = b.split(" ");
+
+            if (aYear < bYear) {
+                return 1;
+            } else if (aYear > bYear) {
+                return -1;
+            } else if (MONTHS[aMonth] < MONTHS[bMonth]) {
+                return 1;
+            } else if (MONTHS[aMonth] > MONTHS[bMonth]) {
+                return -1;
+            }
+            return 0;
+        })
+        .forEach((key) => {
+            sortedPostsByMonth[key] = [
+                ...postsByMonth[key].sort((a, b) => {
+                    const aDate = new Date(a.date);
+                    const bDate = new Date(b.date);
+
+                    if (aDate < bDate) {
+                        return 1;
+                    } else if (aDate > bDate) {
+                        return -1;
+                    }
+                    return 0;
+                })
+            ];
+        });
+
+    return sortedPostsByMonth;
+}

package/src/modules/dxUtils/devices/devices.ts

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

package/src/modules/dxUtils/highlight/highlight.ts

@@ -0,0 +1,32 @@
+import { createSearchRegExp } from "dxUtils/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/dxUtils/language/language.ts

@@ -0,0 +1,21 @@
+import { Language } from "typings/custom";
+
+export const getLanguageDisplayTextById = (
+    languages: Language[],
+    languageId: string
+): string => {
+    const language = languages.find(
+        (languageItem) => languageItem.id === languageId
+    );
+    return language ? language.displayText : "";
+};
+
+export const isGivenLanguageSupported = (
+    languages: Language[],
+    languageId: string
+): boolean => {
+    const languageIndex = languages.findIndex(
+        (languageItem) => languageItem.id === languageId
+    );
+    return languageIndex >= 0;
+};

package/src/modules/dxUtils/lwc/lwc.ts

@@ -0,0 +1,9 @@
+export const setContainerInnerHtml = (
+    container: HTMLElement,
+    markup: string
+) => {
+    if (container && markup && markup !== "") {
+        // eslint-disable-next-line @lwc/lwc/no-inner-html
+        container.innerHTML = markup;
+    }
+};

package/src/modules/dxUtils/normalizers/normalizers.ts

@@ -0,0 +1,80 @@
+import get from "lodash.get";
+import { WordpressPodcastEpisode, WordpressBlogPost } from "typings/custom";
+
+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>;
+};
+
+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
+});
+
+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 | undefined
+): boolean => (typeof value === "string" ? value === "true" : !!value);
+
+/**
+ * Cleans characters that are invalid for DOM IDs
+ * @param {string} id id to normalize
+ */
+export const normalizeDomId = (id: string): string => {
+    return id.replace(/^[^a-z]+|[^\w.-]+/gi, "");
+};

package/src/modules/dxUtils/options/options.ts

@@ -0,0 +1,43 @@
+import { OptionWithNested } from "typings/custom";
+
+const deepmapper = (
+    _options: OptionWithNested[],
+    _callback: (option: OptionWithNested, lavel: number) => OptionWithNested,
+    level: number = 0
+): OptionWithNested[] => {
+    const _level = level + 1;
+    return _options?.map((option: OptionWithNested) =>
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        option.options
+            ? {
+                  ...option,
+                  options: deepmapper(option.options, _callback, _level)
+              }
+            : _callback(option, _level)
+    );
+};
+
+export const deepmapOptions = (
+    options: OptionWithNested[],
+    callback: (
+        option: OptionWithNested,
+        index: number,
+        level: number
+    ) => OptionWithNested
+): OptionWithNested[] => {
+    let index = 0;
+    return deepmapper(options, (option, level) => {
+        const newOption = callback(option, index, level);
+        index += 1;
+        return newOption;
+    });
+};
+
+export const getOptionsCount = (options: OptionWithNested[]) => {
+    let count = 0;
+    deepmapper(options, (option) => {
+        count += 1;
+        return option;
+    });
+    return count;
+};

package/src/modules/dxUtils/prismjs/prismjs.html

@@ -0,0 +1,3 @@
+<template>
+    <!-- TODO: We don't need this file and have to figure why it's required by the build process. 🤷🏼‍♂️ -->
+</template>