@salesforcedevs/dx-components 0.54.1 → 0.54.6-alpha-1

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

@@ -1,8 +1,8 @@
 import { LightningElement, api } from "lwc";
-import { track } from "utils/analytics";
+import { track } from "dxUtils/analytics";
 import cx from "classnames";
 import { TabVariant } from "typings/custom";
-import { normalizeBoolean } from "utils/normalizers";
+import { normalizeBoolean } from "dxUtils/normalizers";
 
 export default class Tab extends LightningElement {
     @api label: string | null = null;

package/src/modules/dx/toc/toc.css

@@ -1,5 +1,5 @@
-@import "helpers/reset";
-@import "helpers/text";
+@import "dxHelpers/reset";
+@import "dxHelpers/text";
 
 :host {
     --dx-c-toc-width: 284px;

package/src/modules/dx/toc/toc.ts

@@ -1,7 +1,7 @@
 import { LightningElement, api, track } from "lwc";
 import cx from "classnames";
 import { ContentElement } from "typings/custom";
-import { toJson } from "utils/normalizers";
+import { toJson } from "dxUtils/normalizers";
 
 export default class Toc extends LightningElement {
     @api title!: string;

package/src/modules/dx/topics/topics.ts

@@ -1,5 +1,5 @@
 import { LightningElement, api } from "lwc";
-import { normalizeToArray } from "utils/normalizers";
+import { normalizeToArray } from "dxUtils/normalizers";
 
 export default class Topics extends LightningElement {
     private _topics: Array<string> = [];

package/src/modules/dx/tree/tree.css

@@ -1,4 +1,4 @@
-@import "helpers/reset";
+@import "dxHelpers/reset";
 
 :host {
     display: block;

package/src/modules/dx/tree/tree.ts

@@ -1,6 +1,6 @@
 import { LightningElement, api } from "lwc";
 import { TreeNode, InternalTreeNode } from "typings/custom";
-import { toJson } from "utils/normalizers";
+import { toJson } from "dxUtils/normalizers";
 import { TreeHandler } from "./treeHandler";
 
 export default class Tree extends LightningElement {

package/src/modules/dx/treeItem/treeItem.css

@@ -1,4 +1,4 @@
-@import "helpers/reset";
+@import "dxHelpers/reset";
 
 :host {
     display: block;

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

@@ -1,8 +1,8 @@
 import { LightningElement, api } from "lwc";
 import { InternalTreeNode } from "typings/custom";
-import { track } from "utils/analytics";
+import { track } from "dxUtils/analytics";
 import { SidebarGtmAction } from "typings/custom";
-import { isInViewport } from "utils/browser";
+import { isInViewport } from "dxUtils/browser";
 
 const DEFAULT_TARGET = "_self";
 

package/src/modules/dx/treeTile/treeTile.css

@@ -1,5 +1,5 @@
-@import "helpers/reset";
-@import "helpers/sidebar";
+@import "dxHelpers/reset";
+@import "dxHelpers/sidebar";
 
 :host {
     display: block;

package/src/modules/dx/typeBadge/typeBadge.css

@@ -1,4 +1,4 @@
-@import "helpers/reset";
+@import "dxHelpers/reset";
 
 .typebadge {
     align-items: center;

package/src/modules/dx/typeBadge/typeBadge.ts

@@ -7,7 +7,7 @@ import {
     BadgeType,
     Brand
 } from "typings/custom";
-import { colorToDxColors } from "utils/css";
+import { colorToDxColors } from "dxUtils/css";
 
 const DEFAULT_TYPE = "typebadge_metadata";
 const VALID_BRANDS: Array<Brand> = [

package/src/modules/dx/typeBadgeGroup/typeBadgeGroup.ts

@@ -1,5 +1,5 @@
 import { LightningElement, api } from "lwc";
-import { normalizeToArray } from "utils/normalizers";
+import { normalizeToArray } from "dxUtils/normalizers";
 import { TypeBadgeSize } from "typings/custom";
 
 export default class TypeBadgeGroup extends LightningElement {

package/src/modules/dx/vimeoPlayer/vimeoPlayer.css

@@ -1 +1 @@
-@import "helpers/reset";
+@import "dxHelpers/reset";

package/src/modules/{base-elements → dxBaseElements}/headerBase/headerBase.ts

@@ -1,8 +1,8 @@
 import { LightningElement, api } from "lwc";
 import cx from "classnames";
-import { Brand, Option } from "typings/custom";
-import { toJson } from "utils/normalizers";
-import { track } from "utils/analytics";
+import { Brand, OptionWithLink, OptionWithNested } from "typings/custom";
+import { toJson } from "dxUtils/normalizers";
+import { track } from "dxUtils/analytics";
 
 const VALID_BRANDS = [
     "analytics",
@@ -61,8 +61,8 @@ export abstract class HeaderBase extends LightningElement {
         this._versions = toJson(value);
     }
 
-    private _navItems!: Option[];
-    private _versions!: Option[];
+    private _navItems!: OptionWithNested[];
+    private _versions!: OptionWithLink[];
     private matchMedia!: MediaQueryList;
     protected mobile: boolean = false;
     private mobileNavMenuValue: string | null = null;

package/src/modules/{base-elements → dxBaseElements}/matchMediaElement/matchMediaElement.ts

@@ -5,7 +5,7 @@ import {
     DEVICE_DESKTOP,
     DEVICE_TABLET,
     DEVICE_MOBILE
-} from "utils/constants";
+} from "dxUtils/constants";
 
 const boilerplate = "screen and ";
 const BREAKPOINT_QUERY_MOBILE = `${boilerplate}(max-width: ${BREAKPOINT_MOBILE})`;

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

@@ -1,4 +1,4 @@
-@import "helpers/button";
+@import "dxHelpers/button";
 
 /* main card base */
 

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

@@ -1,5 +1,5 @@
-@import "helpers/reset";
-@import "helpers/text";
+@import "dxHelpers/reset";
+@import "dxHelpers/text";
 
 :host {
     z-index: var(--dx-g-z-index-500);

package/src/modules/{utils → dxUtils}/highlight/highlight.ts

@@ -1,4 +1,4 @@
-import { createSearchRegExp } from "utils/regexps";
+import { createSearchRegExp } from "dxUtils/regexps";
 
 const MARK_TAGS = /<\/?mark>/gi;
 

package/src/modules/{utils → dxUtils}/normalizers/normalizers.ts

@@ -1,4 +1,5 @@
 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;
@@ -22,16 +23,6 @@ export const normalizeToArray = (
     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;
@@ -55,17 +46,6 @@ export const normalizeEpisode = ({
     title
 });
 
-type WordpressBlogPost = {
-    date: string;
-    description: string;
-    id: string;
-    originalUrl: string;
-    title: string;
-    url: string;
-    authors: any[];
-    featuredImage: string;
-};
-
 export const normalizePost = ({
     authors = [],
     date,
@@ -89,3 +69,11 @@ export const normalizePost = ({
 
 export const normalizeBoolean = (value: string | boolean | number): 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/{utils → dxUtils}/options/options.ts

@@ -1,12 +1,12 @@
-import { Option } from "typings/custom";
+import { OptionWithNested } from "typings/custom";
 
 const deepmapper = (
-    _options: Option[],
-    _callback: (option: Option, lavel: number) => Option,
+    _options: OptionWithNested[],
+    _callback: (option: OptionWithNested, lavel: number) => OptionWithNested,
     level: number = 0
-): Option[] => {
+): OptionWithNested[] => {
     const _level = level + 1;
-    return _options?.map((option: Option) =>
+    return _options?.map((option: OptionWithNested) =>
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
         option.options
             ? {
@@ -18,9 +18,13 @@ const deepmapper = (
 };
 
 export const deepmapOptions = (
-    options: Option[],
-    callback: (option: Option, index: number, level: number) => Option
-): Option[] => {
+    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);
@@ -29,7 +33,7 @@ export const deepmapOptions = (
     });
 };
 
-export const getOptionsCount = (options: Option[]) => {
+export const getOptionsCount = (options: OptionWithNested[]) => {
     let count = 0;
     deepmapper(options, (option) => {
         count += 1;

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/helpers/slds/slds.css

@@ -1,191 +0,0 @@
-: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;
-}