lightning-base-components 1.27.5-alpha → 1.28.3-alpha

package/src/lightning/utilsPrivate/utilsPrivate.ts

@@ -1,454 +0,0 @@
-// eslint-disable-next-line @lwc/lwc/ssr-no-form-factor
-import formFactor from '@salesforce/client/formFactor';
-export * from './language';
-export { assert } from './assert';
-import { LightningElement } from 'lwc';
-
-export {
-    ARIA,
-    ARIA_TO_CAMEL,
-    isAriaDescriptionSupported,
-    updateAriaInvalidOnElement,
-    computeAriaInvalid,
-} from './aria';
-export { EventEmitter } from './eventEmitter';
-export { toNorthAmericanPhoneNumber } from './phonify';
-export { sanitizeURL, FALLBACK_URL } from './url';
-export { deepCopy, arraysEqual, ArraySlice } from './utility';
-export { guid } from './guid';
-export { classListMutation } from './classListMutation';
-export { classSetToString } from './classSet';
-export { makeEverythingExceptElementInert, restoreInertness } from './inert';
-export { hasAnimation } from './animation';
-export {
-    normalizeBoolean,
-    normalizeNumber,
-    normalizeString,
-    normalizeArray,
-    normalizeAriaAttribute,
-} from './normalize';
-export {
-    keyCodes,
-    runActionOnBufferedTypedCharacters,
-    normalizeKeyValue,
-    isShiftMetaOrControlKey,
-} from './keyboard';
-export { raf } from './scroll';
-export { isChrome, isIE11, isSafari } from './browser';
-export { observePosition } from './observers';
-export { hasOnlyAllowedVideoIframes } from './videoUtils';
-export {
-    parseToFormattedLinkifiedParts,
-    parseToFormattedParts,
-} from './linkify';
-export type { Part } from './linkify';
-export { isValidPageReference } from './pageReference';
-export { isMacOS, isWindowsOS, isiOS, isAndroidOS } from './os';
-export {
-    VALID_HEADING_LEVELS,
-    isHeadingLevelValid,
-} from './ariaLevelHeadingUtils';
-export {
-    toDateTimeFormatOptions,
-    toFormattedDate,
-    toFormattedLocation,
-    toFormattedNumber,
-} from './formatUtils';
-export { isTextIgnoreRTL } from './textUtils';
-export {
-    getActiveTooltip,
-    hasActiveTooltip,
-    setActiveTooltip,
-} from './tooltip';
-export {
-    isValidDate,
-    isValidLatitude,
-    isValidLongitude,
-    isValidPhone,
-} from './validationUtils';
-export type { SavedInertElement } from './inert';
-const LIGHTNING_TAG_REGEXP = /^LIGHTNING/i;
-const LIGHTNING_DASH_NAME_REGEXP = /-\w/g;
-function dashWordCharReplacement(dashWordCharMatch: string): string {
-    return dashWordCharMatch[1].toUpperCase();
-}
-
-// eslint-disable-next-line @lwc/lwc/ssr-no-node-env, @lwc/lwc-platform/no-process-env
-export const isProductionEnv = () => process.env.NODE_ENV === 'production';
-
-function synchronizeHTMLElementAttrs(
-    element: HTMLElement,
-    attrs: Record<string, string>
-): void {
-    const attrNames = Object.keys(attrs);
-    for (let i = 0, { length } = attrNames; i < length; i += 1) {
-        const attrName = attrNames[i];
-        const attrValue = attrs[attrName];
-        if (attrValue) {
-            element.setAttribute(attrName, attrValue);
-        } else {
-            element.removeAttribute(attrName);
-        }
-    }
-}
-function synchronizeLightningElementAttrs(
-    element: HTMLElement,
-    attrs: Record<string, string>
-): void {
-    const attrNames = Object.keys(attrs);
-    for (let i = 0, { length } = attrNames; i < length; i += 1) {
-        const attrName = attrNames[i];
-        const attrValue = attrs[attrName];
-        const normalizedName = attrName.replace(
-            LIGHTNING_DASH_NAME_REGEXP,
-            dashWordCharReplacement
-        );
-        element[normalizedName] = attrValue || null;
-    }
-}
-/**
- * @param {HTMLElement} element Element to act on
- * @param {Object} values values and attributes to set, if the value is
- *                        falsy it the attribute will be removed
- */
-export function synchronizeAttrs(
-    element: HTMLElement,
-    attrs: Record<string, string>
-): void {
-    if (element) {
-        if (LIGHTNING_TAG_REGEXP.test(element.tagName)) {
-            synchronizeLightningElementAttrs(element, attrs);
-        } else {
-            synchronizeHTMLElementAttrs(element, attrs);
-        }
-    }
-}
-/**
- * Update the element's attribute with given value.
- * If value is false, the attribute is removed from the element.
- *
- * @param {Object} element - Element
- * @param {string} attrName - Attribute name
- * @param {string | boolean} value - Attribute value
- */
-export function reflectAttribute(
-    element: LightningElement | Element,
-    attrName: string,
-    value?: string | boolean
-): void {
-    if (!element) {
-        return;
-    }
-    if (typeof value === 'string') {
-        element.setAttribute(attrName, value);
-    } else if (value === true) {
-        element.setAttribute(attrName, '');
-    } else if (!value) {
-        element.removeAttribute(attrName);
-    } else {
-        console.warn(`Invalid attribute value for "${attrName}": ${value}`); // eslint-disable-line no-console
-    }
-}
-/**
- * Sets the value of a specified element if it matches the given node name.
- *
- * @param {HTMLElement} element - The DOM element whose value will be set.
- * @param {Array<Function>} validNodeCtorArr - An array of valid node constructors to check against.
- * @param {string} value - The value to set for the element.
- *
- * @returns {void}
- *
- * @example
- * const inputElement = document.createElement('input');
- * valueSetter(inputElement, [HTMLInputElement], 'Hello, World!');
- * console.log(inputElement.value); // Outputs: 'Hello, World!'
- *
- * @throws {TypeError} Throws an error if the element is not a valid HTML element.
- */
-export function valueSetter(element, validNodeCtorArr = [], value) {
-    if (!element || typeof element.tagName !== 'string') {
-        return;
-    } // Early return if element is invalid
-
-    // we are not worried about custom elements here, they can either be ours or customers (sandboxed)
-    const isCustomElementTagName = (tagName) =>
-        /^[a-z][-_.\w]*-[-.0-9_a-z\xB7\xC0-\xD6\xD8-\xF6\xF8-\u37D0\u037F-\u1FFF\u200C-\u200D\u203F-\u2040\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD\u10000-\uEFFFF]*$/.test(
-            tagName
-        );
-
-    if (isCustomElementTagName(element.tagName.toLowerCase())) {
-        element.value = value;
-        return;
-    }
-
-    if (isCustomElementTagName(element.tagName.toLowerCase())) {
-        element.value = value;
-        return;
-    }
-    // at the time of writing Object.getOwnPropertyDescriptor was returning undefined
-    // when an object had overwritten their setter. May be a jsdom problem
-    function isSetterOverwritten(
-        obj: LightningElement,
-        prop: string
-    ): boolean | undefined {
-        const originalDescriptor = Object.getOwnPropertyDescriptor(
-            Object.getPrototypeOf(obj),
-            prop
-        );
-        const currentDescriptor = Object.getOwnPropertyDescriptor(obj, prop);
-        // Check if the current descriptor has a setter and if it's different from the original
-        return (
-            currentDescriptor &&
-            currentDescriptor.set !== originalDescriptor?.set
-        );
-    }
-    for (const validCtor of validNodeCtorArr) {
-        if (
-            element instanceof validCtor &&
-            prototypeMatches(element, validCtor) &&
-            !isSetterOverwritten(element, 'value')
-        ) {
-            element.value = value;
-            break;
-        }
-    }
-}
-/**
- * Use to determine if a given object's prototype
- * matches the prototype of the provided constructor
- *
- * @param {Object} obj - Object whose prototype you want to test
- * @param {Function} ctor - Constructor for expected prototype, e.g., "Object"
- * @returns {boolean}
- */
-export function prototypeMatches(
-    obj: object,
-    ctor: { new(...args: unknown[]): unknown; prototype: object }
-): boolean {
-    return Object.getPrototypeOf(obj) === ctor.prototype;
-}
-/**
- * Get the actual DOM id for an element
- * @param {HTMLElement | string} el The element to get the id for (string will just be returned)
- * @returns {String} The DOM id or null
- */
-export function getRealDOMId(el: HTMLElement | string): string | null {
-    if (typeof el === 'string') {
-        return el.length > 0 ? el : null;
-    }
-    return typeof el === 'object' && el !== null ? el.getAttribute('id') : null;
-}
-/**
- * Returns the active element traversing shadow roots
- * @returns {Element | null} Active Element inside shadow
- */
-export function getShadowActiveElement(): Element | null {
-    // eslint-disable-next-line @lwc/lwc/ssr-no-restricted-browser-globals
-    let activeElement = document.activeElement;
-    while (
-        activeElement?.shadowRoot &&
-        activeElement.shadowRoot.activeElement
-    ) {
-        activeElement = activeElement.shadowRoot.activeElement;
-    }
-    return activeElement;
-}
-/**
- * Returns the active elements at each shadow root level
- * @returns {Element[]} Active Elements at each shadow root level
- */
-export function getShadowActiveElements(): Element[] {
-    // eslint-disable-next-line @lwc/lwc/ssr-no-restricted-browser-globals
-    let activeElement = document.activeElement;
-    const shadowActiveElements: Element[] = [];
-    while (
-        activeElement &&
-        activeElement.shadowRoot &&
-        activeElement.shadowRoot.activeElement
-    ) {
-        shadowActiveElements.push(activeElement);
-        activeElement = activeElement.shadowRoot.activeElement;
-    }
-    if (activeElement) {
-        shadowActiveElements.push(activeElement);
-    }
-    return shadowActiveElements;
-}
-export function isRTL(): boolean {
-    // document does not exist on server and MRT does not support RTL below the root component (https://gus.lightning.force.com/lightning/r/ADM_Epic__c/a3QEE000000KEOb2AO/view)
-    // eslint-disable-next-line @lwc/lwc/ssr-no-restricted-browser-globals
-    return !import.meta.env.SSR && document.dir === 'rtl';
-}
-export function isUndefinedOrNull(value: unknown): boolean {
-    return value === null || value === undefined;
-}
-export function isNotUndefinedOrNull(value: unknown): boolean {
-    return !isUndefinedOrNull(value);
-}
-const DEFAULT_MODAL_ZINDEX = 9000;
-const DEFAULT_ZINDEX_OFFSET = 100;
-const DEFAULT_ZINDEX_BASELINE = DEFAULT_MODAL_ZINDEX + DEFAULT_ZINDEX_OFFSET;
-/**
- * Returns the zIndex baseline from slds zIndex variable --lwc-zIndexModal.
- * @returns {number} zIndex baseline
- */
-export function getZIndexBaseline(): number {
-    // When SLDS styles are present, typically on Core
-    // this currently resolves to: '9000' (string)
-    // If function is called in server context, use default as window and document are not available.
-    const modalZindexValueLwc = !import.meta.env.SSR
-        ? (
-            window.getComputedStyle(document.documentElement) ||
-            document.documentElement.style
-        ).getPropertyValue('--lwc-zIndexModal')
-        : DEFAULT_MODAL_ZINDEX.toString();
-    const baseZindexModalLwc = parseInt(modalZindexValueLwc, 10);
-    return isNaN(baseZindexModalLwc)
-        ? DEFAULT_ZINDEX_BASELINE
-        : baseZindexModalLwc + DEFAULT_ZINDEX_OFFSET;
-}
-export function timeout(interval: number): Promise<void> {
-    return new Promise((resolve) => {
-        // eslint-disable-next-line @lwc/lwc/no-async-operation
-        setTimeout(resolve, interval);
-    });
-}
-export function animationFrame(): Promise<void> {
-    return new Promise((resolve) => {
-        // eslint-disable-next-line @lwc/lwc/no-async-operation, @lwc/lwc/ssr-no-restricted-browser-globals
-        window.requestAnimationFrame(resolve as any);
-    });
-}
-/**
- * Decorates an input element to fire an "input"
- * event when the value is directly set.
- *
- * @param {HTMLElement} element The element to decorate.
- */
-export function decorateInputForDragon(element: HTMLElement) {
-    const valuePropertyDescriptor = getInputValuePropertyDescriptor(element);
-    Object.defineProperty(element, 'value', {
-        set(value) {
-            valuePropertyDescriptor?.set?.call(this, value);
-            this.dispatchEvent(new CustomEvent('input'));
-        },
-        // eslint-disable-next-line @typescript-eslint/unbound-method
-        get: valuePropertyDescriptor.get,
-        enumerable: true,
-        configurable: true,
-    });
-}
-function getInputValuePropertyDescriptor(
-    element: HTMLElement
-): PropertyDescriptor {
-    return Object.getOwnPropertyDescriptor(
-        Object.getPrototypeOf(element),
-        'value'
-    );
-}
-export function setDecoratedDragonInputValueWithoutEvent(
-    element: HTMLElement,
-    value: string
-): void {
-    const valuePropertyDescriptor = getInputValuePropertyDescriptor(element);
-    valuePropertyDescriptor.set.call(element, value);
-}
-/**
- * Escape HTML string
- * @param {string} html An html string
- * @returns {string} The escaped html string
- */
-export function escapeHTML(html: string): string {
-    return html
-        .replace(/&/g, '&amp;')
-        .replace(/</g, '&lt;')
-        .replace(/>/g, '&gt;')
-        .replace(/"/g, '&quot;')
-        .replace(/'/g, '&#039;');
-}
-export const BUTTON_GROUP_ORDER = {
-    FIRST: 'first',
-    MIDDLE: 'middle',
-    LAST: 'last',
-    ONLY: 'only',
-};
-/**
- * Returns the SLDS class for the given group order
- * @param {string} groupOrder
- * @returns {string}
- */
-export function buttonGroupOrderClass(groupOrder: string): string {
-    return {
-        [BUTTON_GROUP_ORDER.FIRST]: 'slds-button_first',
-        [BUTTON_GROUP_ORDER.MIDDLE]: 'slds-button_middle',
-        [BUTTON_GROUP_ORDER.LAST]: 'slds-button_last',
-        [BUTTON_GROUP_ORDER.ONLY]: 'single-button',
-    }[groupOrder];
-}
-/**
- * Checks if the given lightning component is native
- * @param {any} cmp LightningElement instance
- * @returns {boolean} Whether the lightning component is native
- */
-export function isNativeComponent(cmp: LightningElement): boolean {
-    return cmp?.template && !cmp.template.synthetic;
-}
-/**
- * Determine if event is of type FocusEvent (blur or focus). This is required
- * in some cases to prevent these events from bubbling to ensure parity between synthetic
- * and native shadow.
- *
- * 'focus' and 'blur' events that have been propagated manually via CustomEvents are not considered
- * FocusEvents.
- *
- * Corresponding LWC issue: https://github.com/salesforce/lwc/issues/1244
- * Corresponding LBC bug: @W-13236327
- *
- * @param {Event} event
- * @returns {boolean}
- */
-export function isBubblingFocusEvent(event: Event): boolean {
-    const focusEvents = ['focus', 'blur'];
-    // eslint-disable-next-line @lwc/lwc/ssr-no-restricted-browser-globals
-    return event instanceof FocusEvent && focusEvents.includes(event.type);
-}
-/**
- * Checks if a desktop browser is being used in the environment
- * @returns {boolean} is a desktop browser being used
- */
-export function isDesktopBrowser(): boolean {
-    return formFactor === 'Large';
-}
-const { hasOwn: ObjectHasOwn } = Object;
-// eslint-disable-next-line @typescript-eslint/unbound-method
-const { hasOwnProperty: ObjectProtoHasOwnProperty } = Object.prototype;
-/**
- * Determines if a given object has the specified key as a direct property.
- *
- * @param {Object} object The object to check
- * @param {string} key The property key
- * @returns {boolean} Whether the given key is a direct property of the object.
- */
-export const hasOwn =
-    typeof ObjectHasOwn === 'function'
-        ? ObjectHasOwn
-        : function hasOwn(object: object, key: string): boolean {
-            return ObjectProtoHasOwnProperty.call(object, key);
-        };
-/**
- * Determines if a given object has any direct properties.
- *
- * @param {Object} object The object to check
- * @returns {boolean} Whether the object has direct properties.
- */
-export function hasOwnProperties(object: object): boolean {
-    for (const key in object) {
-        if (hasOwn(object, key)) {
-            return true;
-        }
-    }
-    return false;
-}
-
-// observable that observers can subscribe and get notified when it changes
-export { default as Observable } from './observable';

package/src/lightning/utilsPrivate/validationUtils.ts

@@ -1,54 +0,0 @@
-import { isValidISODateTimeString } from 'lightning/iso8601Utils';
-const MAX_LONGITUDE = 180.0;
-const MAX_LATITUDE = 90.0;
-/**
- * Determine if a value is a valid date.
- *
- * @param {any} value - The value to validate.
- * @returns {boolean} - Whether the provided value is a valid date or not.
- */
-export function isValidDate(value: any): boolean {
-    if (value === null || value === undefined || value === '') {
-        return false;
-    }
-    return isFinite(value) || isValidISODateTimeString(value);
-}
-/**
- * Determine if a value is a valid latitude.
- *
- * @param {any} value - The value to validate.
- * @returns {boolean} - Whether the provided value is a valid latitude or not.
- */
-export function isValidLatitude(value: any): boolean {
-    return (
-        value !== null &&
-        value !== undefined &&
-        value !== '' &&
-        isFinite(value) &&
-        Math.abs(value) <= MAX_LATITUDE
-    );
-}
-/**
- * Determine if a value is a valid longitude.
- *
- * @param {any} value - The value to validate.
- * @returns {boolean} - Whether the provided value is a valid longitude or not.
- */
-export function isValidLongitude(value: any): boolean {
-    return (
-        value !== null &&
-        value !== undefined &&
-        value !== '' &&
-        isFinite(value) &&
-        Math.abs(value) <= MAX_LONGITUDE
-    );
-}
-/**
- * Determine if a value is a valid phone value.
- *
- * @param {any} value - The value to validate.
- * @returns {boolean} - Whether the provided value is a valid phone value or not.
- */
-export function isValidPhone(value: any): boolean {
-    return typeof value === 'string' && value !== '';
-}

package/src/lightning/utilsPrivate/videoUtils.ts

@@ -1,90 +0,0 @@
-const ALLOWED_DOMAINS = new Set([
-    'www.youtube.com',
-    'www.youtube-nocookie.com',
-    'www.youtube.ca',
-    'www.youtube.jp',
-    'www.youtube.com.br',
-    'www.youtube.co.uk',
-    'www.youtube.nl',
-    'www.youtube.pl',
-    'www.youtube.es',
-    'www.youtube.ie',
-    'www.youtube.fr',
-    'player.vimeo.com',
-    'play.vidyard.com',
-    'players.brightcove.net',
-    'bcove.video',
-    'player.cloudinary.com',
-    'fast.wistia.net',
-    'i1.adis.ws',
-    's1.adis.ws',
-    'scormanywhere.secure.force.com',
-    'appiniummastertrial.secure.force.com',
-    'embed.app.guidde.com',
-    'cdnapisec.kaltura.com',
-]);
-// In addition to:
-//   vimeo.com/showcase/*/embed
-//   *.my.site.com
-//   *.lightning.force.com
-//   *.my.salesforce-sites.com
-export function hasOnlyAllowedVideoIframes(htmlString: string): boolean {
-    if (htmlString && htmlString.indexOf('<iframe') > -1) {
-        const parsedHtml = new DOMParser().parseFromString(
-            htmlString,
-            'text/html'
-        );
-        const iframesList = Array.prototype.slice.call(
-            parsedHtml.querySelectorAll('iframe')
-        );
-        return (
-            iframesList.length > 0 &&
-            !iframesList.some(
-                (iframe: HTMLIFrameElement) => !isUrlAllowed(iframe.src)
-            )
-        );
-    }
-    return false;
-}
-
-function isUrlAllowed(url: string): boolean {
-    // eslint-disable-next-line @lwc/lwc/ssr-no-restricted-browser-globals
-    const anchor = document.createElement('a');
-    anchor.href = url;
-    if (anchor.protocol !== 'https:') {
-        return false;
-    }
-    if (anchor.hostname === 'vimeo.com') {
-        const path = anchor.pathname;
-        const regex = /^\/showcase\/\d+\/embed$/;
-        return path.match(regex) !== null;
-    }
-    if (anchor.hostname === 'www.my.salesforce-sites.com') {
-        return false;
-    }
-    if (anchor.hostname.match(/^[\w-]+\.my\.salesforce-sites\.com$/)) {
-        return true;
-    }
-    if (anchor.hostname.match(/^[\w-]+\.sandbox\.my\.salesforce-sites\.com$/)) {
-        return true;
-    }
-    if (anchor.hostname === 'www.lightning.force.com') {
-        return false;
-    }
-    if (anchor.hostname.match(/^[\w-]+\.lightning\.force\.com$/)) {
-        return true;
-    }
-    if (anchor.hostname.match(/^[\w-]+\.sandbox\.lightning\.force\.com$/)) {
-        return true;
-    }
-    if (anchor.hostname === 'www.my.site.com') {
-        return false;
-    }
-    if (anchor.hostname.match(/^[\w-]+\.my\.site\.com$/)) {
-        return true;
-    }
-    if (anchor.hostname.match(/^[\w-]+\.sandbox\.my\.site\.com$/)) {
-        return true;
-    }
-    return ALLOWED_DOMAINS.has(anchor.hostname);
-}