@salesforcedevs/dx-components 0.53.8 → 0.53.11-alpha

package/lwc.config.json

@@ -1,11 +1,13 @@
 {
     "modules": [{ "dir": "src/modules" }],
     "expose": [
+        "base-elements/headerBase",
+        "base-elements/matchMediaElement",
+        "dx/banner",
         "dx/brandThemeProvider",
         "dx/breadcrumbs",
         "dx/button",
         "dx/cardBlogPost",
-        "dx/cardBlogPostProvider",
         "dx/cardCallout",
         "dx/cardContent",
         "dx/cardDemo",
@@ -15,25 +17,21 @@
         "dx/cardMinimal",
         "dx/cardNews",
         "dx/cardPodcastEpisode",
-        "dx/cardPodcastEpisodeProvider",
         "dx/cardSmall",
         "dx/cardTrailheadModule",
         "dx/cardTrial",
         "dx/cardVideoPreview",
         "dx/checkbox",
-        "dx/checkboxNative",
         "dx/checkboxGroup",
+        "dx/checkboxNative",
         "dx/codeBlock",
-        "dx/contentArchive",
         "dx/dropdown",
         "dx/emptyState",
         "dx/feature",
         "dx/featuredContentHeader",
         "dx/featuresList",
         "dx/filterMenu",
-        "dx/banner",
         "dx/footer",
-        "dx/newsletterForm",
         "dx/formattedDateTime",
         "dx/grid",
         "dx/groupText",
@@ -47,17 +45,14 @@
         "dx/iconBadge",
         "dx/imageAndLabel",
         "dx/input",
-        "dx/instrumentation",
         "dx/logo",
         "dx/modalDrawer",
         "dx/pagination",
         "dx/podcastHost",
         "dx/podcastPlayer",
-        "dx/podcastSubscription",
         "dx/popover",
         "dx/radioGroup",
         "dx/relativeDateTime",
-        "dx/searchResults",
         "dx/section",
         "dx/sectionSignup",
         "dx/sectionSmall",
@@ -65,28 +60,31 @@
         "dx/sidebar",
         "dx/sidebarOld",
         "dx/skipNavLink",
-        "dx/slackCta",
         "dx/socials",
+        "dx/spinner",
+        "dx/toc",
         "dx/toc",
-        "dx/tree",
         "dx/tooltip",
+        "dx/tree",
         "dx/typeBadge",
         "dx/typeBadgeGroup",
-        "dx/toc",
         "dx/vimeoPlayer",
         "helpers/animations",
+        "helpers/button",
         "helpers/card",
         "helpers/code",
         "helpers/commonHeader",
         "helpers/reset",
         "helpers/table",
         "helpers/text",
-        "base-elements/headerBase",
-        "base-elements/matchMediaElement",
+        "utils/analytics",
         "utils/constants",
-        "utils/normalizers",
+        "utils/coveo",
+        "utils/dates",
         "utils/highlight",
-        "utils/contentArchive",
-        "utils/dates"
+        "utils/normalizers",
+        "utils/queryCoordinator",
+        "utils/recentSearches",
+        "utils/wordpress"
     ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/dx-components",
-    "version": "0.53.8",
+    "version": "0.53.11-alpha",
     "description": "DX Lightning web components",
     "license": "MIT",
     "engines": {
@@ -15,18 +15,15 @@
         "@sfdocs-internal/wires": "^0.6.3",
         "@vimeo/player": "^2.16.4",
         "classnames": "^2.2.6",
-        "coveo-search-ui": "^2.10082.5",
         "debounce": "^1.2.0",
         "lightning-base-components": "1.12.3-alpha",
         "lodash.get": "^4.4.2",
-        "microtip": "0.2.2",
-        "query-string": "^7.1.1"
+        "microtip": "0.2.2"
     },
     "devDependencies": {
         "@types/classnames": "^2.2.10",
         "@types/debounce": "^1.2.0",
         "@types/lodash.get": "^4.4.6",
         "@types/vimeo__player": "^2.16.2"
-    },
-    "gitHead": "d35b6323942b0428d630c6cb9544a0e169510f5a"
+    }
 }

package/src/modules/base-elements/headerBase/headerBase.ts

@@ -2,7 +2,7 @@ import { LightningElement, api } from "lwc";
 import cx from "classnames";
 import { Brand, Option } from "typings/custom";
 import { toJson } from "utils/normalizers";
-import { track } from "dx/instrumentation";
+import { track } from "utils/analytics";
 
 const VALID_BRANDS = [
     "analytics",

package/src/modules/dx/cardCallout/cardCallout.ts

@@ -1,14 +1,14 @@
 import { LightningElement, api } from "lwc";
 import cx from "classnames";
 import { toDxColor } from "utils/css";
-import { track } from "dx/instrumentation";
+import { track } from "utils/analytics";
 
 export default class CardCallout extends LightningElement {
-    @api backgroundColor?: string = "indigo-vibrant-40";
-    @api color?: string = "white";
+    @api backgroundColor: string = "indigo-vibrant-40";
+    @api color: string = "white";
     @api href!: string;
     @api label: string = "";
-    @api target?: string | null = null;
+    @api target?: string;
     @api title!: string;
 
     private get style(): string {

package/src/modules/dx/cardNews/cardNews.ts

@@ -9,7 +9,7 @@ import {
     CardNewsSize,
     CardNewsTextContainerSize
 } from "typings/custom";
-import { track } from "dx/instrumentation";
+import { track } from "utils/analytics";
 
 export default class CardNews extends LightningElement {
     @api backgroundColor?: string = "indigo-vibrant-40";

package/src/modules/dx/codeBlock/codeBlock.ts

@@ -6,7 +6,7 @@ import {
     getLocalStorageData,
     setLocalStorageData
 } from "@sfdocs-internal/wires";
-import { track as gtmTrack } from "dx/instrumentation";
+import { track as gtmTrack } from "utils/analytics";
 
 // Used por remove enclosing <pre> tag's (if occurs)
 const preTagRegexp: RegExp = /^<pre.*?>(.*)<\/pre>$/is;

package/src/modules/dx/dropdownOption/dropdownOption.ts

@@ -1,7 +1,7 @@
 import { LightningElement, api } from "lwc";
 import cx from "classnames";
 import { Option } from "typings/custom";
-import { track } from "dx/instrumentation";
+import { track } from "utils/analytics";
 
 export default class DropdownOption extends LightningElement {
     @api option!: Option;

package/src/modules/dx/featuredContentHeader/featuredContentHeader.html

@@ -1,31 +1,42 @@
 <template>
     <div class={classname} part="container">
-        <div
-            if:true={label}
-            role={labelRole}
-            aria-level={labelAriaLevel}
-            class="label dx-text-heading-4"
-        >
-            {label}
-        </div>
+        <template if:true={labelAsPrimaryHeading}>
+            <h1 if:true={label} class="label dx-text-heading-4">{label}</h1>
+        </template>
+        <template if:false={labelAsPrimaryHeading}>
+            <p if:true={label} class="label dx-text-heading-4">{label}</p>
+        </template>
         <div class="featured-content-main-content">
-            <div
-                role="heading"
-                aria-level={titleAriaLevel}
-                class="title dx-text-heading-2"
-            >
-                <a
-                    class="title-link"
-                    if:true={href}
-                    href={href}
-                    target={target}
-                    onmouseenter={setLinkHovered}
-                    onmouseleave={setLinkInactive}
-                >
-                    {title}
-                </a>
-                <template if:false={href}>{title}</template>
-            </div>
+            <template if:false={labelAsPrimaryHeading}>
+                <h1 class="title dx-text-heading-2">
+                    <a
+                        class="title-link"
+                        if:true={href}
+                        href={href}
+                        target={target}
+                        onmouseenter={setLinkHovered}
+                        onmouseleave={setLinkInactive}
+                    >
+                        {title}
+                    </a>
+                    <template if:false={href}>{title}</template>
+                </h1>
+            </template>
+            <template if:true={labelAsPrimaryHeading}>
+                <h2 class="title dx-text-heading-2">
+                    <a
+                        class="title-link"
+                        if:true={href}
+                        href={href}
+                        target={target}
+                        onmouseenter={setLinkHovered}
+                        onmouseleave={setLinkInactive}
+                    >
+                        {title}
+                    </a>
+                    <template if:false={href}>{title}</template>
+                </h2>
+            </template>
             <div class="authors" if:true={authors}>
                 <template for:each={authors} for:item="author">
                     <dx-image-and-label

package/src/modules/dx/featuredContentHeader/featuredContentHeader.ts

@@ -73,18 +73,6 @@ export default class FeaturedContentHeader extends LightningElement {
         );
     }
 
-    private get labelRole(): string | null {
-        return this.labelAsPrimaryHeading ? "heading" : null;
-    }
-
-    private get labelAriaLevel(): string | null {
-        return this.labelAsPrimaryHeading ? "1" : null;
-    }
-
-    private get titleAriaLevel(): string {
-        return this.labelAsPrimaryHeading ? "2" : "1";
-    }
-
     private setLinkHovered() {
         this.isLinkHovered = true;
     }

package/src/modules/dx/footer/footer.ts

@@ -9,7 +9,7 @@ import {
     privacyHref,
     intellectualHref
 } from "./links";
-import { track } from "dx/instrumentation";
+import { track } from "utils/analytics";
 
 const PATH = "/newsletter";
 const createNewsletterSignupHref = (email: string): string =>

package/src/modules/dx/footerOption/footerOption.ts

@@ -1,5 +1,5 @@
 import { LightningElement, api } from "lwc";
-import { track } from "dx/instrumentation";
+import { track } from "utils/analytics";
 
 export default class FooterOption extends LightningElement {
     @api href: string | null = null;

package/src/modules/dx/groupText/groupText.ts

@@ -3,7 +3,7 @@ import cx from "classnames";
 import { LightningSlotElement, Link } from "typings/custom";
 import { isSlotEmpty } from "utils/slot";
 import { toJson } from "utils/normalizers";
-import { track } from "dx/instrumentation";
+import { track } from "utils/analytics";
 
 type OptionalLink = Link | null;
 

package/src/modules/dx/headerMobileNavMenuOption/headerMobileNavMenuOption.ts

@@ -1,5 +1,5 @@
 import { LightningElement, api } from "lwc";
-import { track } from "dx/instrumentation";
+import { track } from "utils/analytics";
 
 export default class HeaderMobileNavMenuOption extends LightningElement {
     @api href: string | null = null;

package/src/modules/dx/pagination/pagination.ts

@@ -1,6 +1,6 @@
 import classNames from "classnames";
 import { LightningElement, api } from "lwc";
-import { track } from "dx/instrumentation";
+import { track } from "utils/analytics";
 
 const ANALYTICS_INFO = {
     clickUrl: window.location.href,

package/src/modules/dx/sidebar/sidebar.ts

@@ -1,5 +1,5 @@
 import cx from "classnames";
-import { track as trackAnalytics } from "dx/instrumentation";
+import { track as trackAnalytics } from "utils/analytics";
 import { api, track } from "lwc";
 import {
     TreeNode,

package/src/modules/dx/sidebarOld/sidebarOld.ts

@@ -1,5 +1,5 @@
 import cx from "classnames";
-import { track } from "dx/instrumentation";
+import { track } from "utils/analytics";
 import { api } from "lwc";
 
 import { TreeNode, SidebarGtmAction } from "typings/custom";

package/src/modules/dx/tab/tab.ts

@@ -1,5 +1,5 @@
 import { LightningElement, api } from "lwc";
-import { track } from "dx/instrumentation";
+import { track } from "utils/analytics";
 import cx from "classnames";
 import { TabVariant } from "typings/custom";
 import { normalizeBoolean } from "utils/normalizers";

package/src/modules/dx/treeItem/treeItem.ts

@@ -1,6 +1,6 @@
 import { LightningElement, api } from "lwc";
 import { InternalTreeNode } from "typings/custom";
-import { track } from "dx/instrumentation";
+import { track } from "utils/analytics";
 import { SidebarGtmAction } from "typings/custom";
 import { isInViewport } from "utils/browser";
 

package/src/modules/utils/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/LICENSE

@@ -1,12 +0,0 @@
-Copyright (c) 2020, Salesforce.com, Inc.
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
-* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
-* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-
-* Neither the name of Salesforce.com nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/src/modules/dx/cardBlogPostProvider/cardBlogPostProvider.css

@@ -1,3 +0,0 @@
-:host {
-    display: contents;
-}

package/src/modules/dx/cardBlogPostProvider/cardBlogPostProvider.html

@@ -1,16 +0,0 @@
-<template>
-    <template for:each={posts} for:item="post">
-        <dx-card-blog-post
-            label="BLOG POST"
-            author-img-src={post.authorImgSrc}
-            author-label={post.authorName}
-            body={post.body}
-            datetime={post.datetime}
-            href={post.href}
-            img-alt={post.imgAlt}
-            img-src={post.imgSrc}
-            key={post.id}
-            title={post.title}
-        ></dx-card-blog-post>
-    </template>
-</template>

package/src/modules/dx/cardBlogPostProvider/cardBlogPostProvider.ts

@@ -1,29 +0,0 @@
-import { LightningElement, api, track } from "lwc";
-import { fetchWordpressPosts } from "utils/wordpress";
-import { normalizePost } from "utils/normalizers";
-
-type BlogPost = {
-    body: string;
-    datetime: string;
-    href: string;
-    id: string;
-    title: string;
-};
-
-export default class CardBlogPostProvider extends LightningElement {
-    @api count?: string;
-
-    @track posts: BlogPost[] = [];
-
-    private fetchPosts = async () => {
-        this.posts = await fetchWordpressPosts(
-            "/blogs/api",
-            normalizePost,
-            this.count
-        );
-    };
-
-    connectedCallback() {
-        this.fetchPosts();
-    }
-}

package/src/modules/dx/cardPodcastEpisodeProvider/cardPodcastEpisodeProvider.css

@@ -1,3 +0,0 @@
-:host {
-    display: contents;
-}

package/src/modules/dx/cardPodcastEpisodeProvider/cardPodcastEpisodeProvider.html

@@ -1,12 +0,0 @@
-<template>
-    <template for:each={episodes} for:item="episode">
-        <dx-card-podcast-episode
-            body={episode.body}
-            datetime={episode.datetime}
-            href={episode.href}
-            key={episode.id}
-            length={episode.length}
-            title={episode.title}
-        ></dx-card-podcast-episode>
-    </template>
-</template>

package/src/modules/dx/cardPodcastEpisodeProvider/cardPodcastEpisodeProvider.ts

@@ -1,29 +0,0 @@
-import { LightningElement, api, track } from "lwc";
-import { fetchWordpressPosts } from "utils/wordpress";
-import { normalizeEpisode } from "utils/normalizers";
-
-type PodcastEpisode = {
-    body: string;
-    datetime: string;
-    href: string;
-    id: string;
-    length: string;
-    title: string;
-};
-export default class CardPodcastEpisodeProvider extends LightningElement {
-    @api count?: string;
-
-    @track episodes: PodcastEpisode[] = [];
-
-    private fetchEpisodes = async () => {
-        this.episodes = await fetchWordpressPosts(
-            "/podcast/api",
-            normalizeEpisode,
-            this.count
-        );
-    };
-
-    connectedCallback() {
-        this.fetchEpisodes();
-    }
-}