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

package/src/modules/dxHelpers/commonSidebar/commonSidebar.css

@@ -0,0 +1,145 @@
+@import "dxHelpers/reset";
+@import "dxHelpers/text";
+
+:host {
+    --dx-c-sidebar-width: 275px;
+    --dx-c-sidebar-button-color: var(--dx-g-blue-vibrant-50);
+    --dx-c-sidebar-button-background: white;
+    --dx-c-sidebar-button-border: white;
+    --dx-c-sidebar-button-color-hover: white;
+    --dx-c-sidebar-button-background-hover: var(--dx-g-blue-vibrant-50);
+    --dx-c-sidebar-button-border-hover: var(--dx-g-blue-vibrant-50);
+    --dx-c-sidebar-left-padding: var(--dx-g-page-padding-horizontal);
+    --dx-c-sidebar-vertical-padding: var(--dx-g-spacing-md);
+}
+
+dx-tree:not(:last-child) {
+    margin-bottom: var(--dx-g-spacing-sm);
+}
+
+.header {
+    box-sizing: content-box;
+    display: flex;
+    line-height: var(--dx-g-spacing-xl);
+    margin-bottom: 12px;
+}
+
+.padding-horizontal {
+    padding-left: var(--dx-g-spacing-md);
+    padding-right: var(--dx-g-spacing-md);
+}
+
+.header-title {
+    line-height: inherit;
+}
+
+.header-toggle-button {
+    position: absolute;
+    right: calc((-1 * (var(--dx-g-spacing-xl) / 2)) - 1px);
+
+    --dx-c-button-opacity: 0;
+    --dx-c-button-custom-color: var(--dx-c-sidebar-button-color);
+    --dx-c-button-custom-background: var(--dx-c-sidebar-button-background);
+    --dx-c-button-custom-border: var(--dx-c-sidebar-button-border);
+    --dx-c-button-custom-color-hover: var(--dx-c-sidebar-button-color-hover);
+    --dx-c-button-custom-background-hover: var(
+        --dx-c-sidebar-button-background-hover
+    );
+    --dx-c-button-custom-border-hover: var(--dx-c-sidebar-button-border-hover);
+}
+
+.header-toggle-icon {
+    margin: auto 0 auto auto;
+    color: var(--dx-g-blue-vibrant-30);
+}
+
+.header-toggle-icon dx-icon {
+    transition: var(--dx-g-transition-transform-2x);
+}
+
+.container.collapsed {
+    width: var(--dx-g-spacing-xl);
+}
+
+.container {
+    background-color: var(--dx-g-gray-95);
+    display: flex;
+    flex-direction: column;
+    height: var(--dx-c-sidebar-height);
+    width: calc(var(--dx-c-sidebar-width) + var(--left-spacing));
+}
+
+.container:not(.container-mobile) {
+    --border-color: transparent;
+    --left-spacing: calc(
+        var(--dx-c-sidebar-left-padding) - var(--dx-g-spacing-md)
+    );
+
+    box-shadow: 2px 0 0 0 var(--border-color);
+    min-height: var(--dx-c-sidebar-min-height);
+    padding: var(--dx-c-sidebar-vertical-padding) 0
+        var(--dx-c-sidebar-vertical-padding) var(--left-spacing);
+    position: relative;
+}
+
+.collapsed.container:not(.container-mobile) {
+    background-color: transparent;
+}
+
+.collapsed.container:not(.container-border-active) {
+    --border-color: transparent;
+}
+
+.container:hover .header-toggle-button {
+    --dx-c-button-opacity: 1;
+}
+
+.container.container-mobile {
+    width: 100%;
+}
+
+.container.container-mobile .header {
+    cursor: pointer;
+    line-height: var(--dx-g-spacing-2xl);
+}
+
+.container.container-mobile:not(.collapsed) .header {
+    background-color: #dddbda;
+}
+
+.container.container-mobile .header-title {
+    color: var(--dx-g-gray-10);
+    font-family: var(--dx-g-font-sans);
+    font-size: var(--dx-g-text-sm);
+}
+
+.container.container-mobile.collapsed {
+    height: unset;
+    padding-bottom: 0;
+}
+
+.container.container-mobile.collapsed .header {
+    margin-bottom: 0;
+}
+
+.container.container-mobile.collapsed .header-toggle-icon dx-icon {
+    transform: rotateZ(-90deg);
+}
+
+.container.container-border-active {
+    --border-color: var(--dx-c-sidebar-button-color);
+}
+
+.search {
+    padding-bottom: var(--dx-g-spacing-md);
+}
+
+.search-box {
+    --dx-c-input-width: 100%;
+}
+
+.truncate {
+    overflow: hidden;
+    text-overflow: ellipsis;
+    white-space: nowrap;
+}

package/src/modules/dxHelpers/commonTreeItem/commonTreeItem.css

@@ -0,0 +1,21 @@
+.sidebar-item-truncate-text {
+    display: -webkit-box;
+    overflow: hidden;
+    word-break: break-word;
+    -webkit-box-orient: vertical;
+    -webkit-line-clamp: 2;
+}
+
+.sidebar-item-selected {
+    background: var(--dx-g-cloud-blue-vibrant-95);
+    box-shadow: inset var(--dx-g-spacing-xs) 0 0 0 var(--dx-g-blue-vibrant-60);
+    border-radius: 0;
+}
+
+.sidebar-item {
+    padding: 6px var(--dx-g-spacing-md);
+}
+
+.sidebar-item:not(.sidebar-item-selected):hover {
+    background-color: var(--dx-g-gray-90);
+}

package/src/modules/dxHelpers/scrollbar/scrollbar.css

@@ -0,0 +1,31 @@
+/* a truly always visible scrollbar is only possible on webkit --
+on firefox we are only able to sync the styling
+but cannot force the scrollbar to appear for users */
+
+/* mozilla styles */
+.always-visible-scrollbar {
+    scrollbar-color: #757575 transparent;
+    scrollbar-width: thin;
+}
+
+/* webkit styles */
+.always-visible-scrollbar::-webkit-scrollbar {
+    width: 14px;
+}
+
+.always-visible-scrollbar::-webkit-scrollbar-thumb {
+    background-clip: content-box;
+    border: 5px solid transparent;
+    border-radius: 10px;
+    box-shadow: #757575 inset 0 0 0 10px;
+}
+
+.always-visible-scrollbar::-webkit-scrollbar-corner {
+    background-color: transparent;
+}
+
+.always-visible-scrollbar::-webkit-scrollbar-button {
+    width: 0;
+    height: 0;
+    display: none;
+}

package/src/modules/{helpers → dxHelpers}/table/table.css

@@ -1,8 +1,10 @@
 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: scroll;
+    overflow-x: auto;
     border-collapse: separate;
     border-spacing: 0;
     margin-top: var(--dx-g-spacing-lg);
@@ -16,13 +18,13 @@ table tr {
 th,
 td {
     padding: var(--dx-g-spacing-md);
-    font-size: var(--dx-g-text-sm);
-    line-height: var(--dx-g-text-lg);
+    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: inherit;
+    font-weight: var(--dx-g-font-bold);
     border-bottom: 3px solid var(--dx-g-indigo-vibrant-30);
 }
 
@@ -40,10 +42,6 @@ table tbody tr td {
     border-bottom: 1px solid var(--dx-g-gray-90);
 }
 
-th:first-of-type {
-    font-weight: var(--dx-g-font-bold);
-}
-
 tr th:first-of-type,
 td:first-of-type {
     min-width: 110px;
@@ -85,6 +83,24 @@ 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);
 }

package/src/modules/{helpers → dxHelpers}/text/text.css

@@ -14,6 +14,14 @@
     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);
@@ -22,6 +30,14 @@
     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);
@@ -30,6 +46,14 @@
     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);
@@ -147,3 +171,27 @@
     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/async/async.ts

@@ -0,0 +1,45 @@
+/**
+ * Checks whether a condition is satisfied at a specified interval, stopping after a maximum amount
+ * of time (if specified). Returns a Promise that resolves with `true` if the condition was
+ * satisfied during polling (if a maximum time is specified, it can resolve with false if the
+ * condition was not satisfied within the maximum time).
+ *
+ * Usage:
+ *  await pollUntil(() => something.is.true, 200, 1000);
+ *
+ * @param {Function} condition the "check" callback that will be called to determine whether the
+ *  condition has been satisfied (satisfied === callback returns truthy value)
+ * @param {number} atIntervalMs value in milliseconds specifying how often to poll
+ * @param {number} [forMaximumMs] value in milliseconds specifying the maximum time to poll
+ * @returns {Promise}
+ */
+export function pollUntil(
+    condition: () => boolean,
+    atIntervalMs: number,
+    forMaximumMs?: number
+) {
+    return new Promise<boolean>((resolve) => {
+        let timeoutId: ReturnType<typeof setTimeout>;
+        const intervalId = setInterval(() => {
+            if (condition()) {
+                resolveWithCleanup(true);
+            }
+        }, atIntervalMs);
+        if (typeof forMaximumMs === "number") {
+            timeoutId = setTimeout(() => {
+                // One last check in case the condition was satisfied right before the end:
+                resolveWithCleanup(condition() || false);
+            }, forMaximumMs);
+        }
+        if (condition()) {
+            // Condition already fulfilled before intervals, no need to keep waiting!
+            resolveWithCleanup(true);
+        }
+
+        function resolveWithCleanup(success: boolean) {
+            clearInterval(intervalId);
+            clearTimeout(timeoutId);
+            resolve(success);
+        }
+    });
+}

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,53 @@
+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})`;
+
+export const buildStyleColorVariables = ({
+    background,
+    color
+}: {
+    background: string;
+    color: string;
+}): string => {
+    return `--color: var(${color}); --background: var(${background})`;
+};

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/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;
+    }
+};