@ui5/webcomponents-base 1.12.0-rc.1 → 1.12.0-rc.2

package/src/config/FormatSettings.ts

@@ -1,35 +0,0 @@
-import LegacyDateFormats from "../features/LegacyDateFormats.js";
-import type { LegacyDateCalendarCustomizing } from "../features/LegacyDateFormats.js";
-import { getFormatSettings } from "../InitialConfiguration.js";
-import { getFeature } from "../FeaturesRegistry.js";
-
-type FormatSettings = {
-	firstDayOfWeek?: number,
-	legacyDateCalendarCustomizing?: LegacyDateCalendarCustomizing,
-};
-
-let formatSettings: FormatSettings;
-
-/**
- * Returns the first day of the week from the configured format settings or based on the current locale.
- * @public
- * @returns {Number} 0 (Sunday) through 6 (Saturday)
- */
-const getFirstDayOfWeek = (): number | undefined => {
-	if (formatSettings === undefined) {
-		formatSettings = getFormatSettings();
-	}
-
-	return formatSettings.firstDayOfWeek;
-};
-
-const legacyDateFormats = getFeature<typeof LegacyDateFormats>("LegacyDateFormats");
-
-const getLegacyDateCalendarCustomizing = legacyDateFormats ? LegacyDateFormats.getLegacyDateCalendarCustomizing : () => { return []; };
-
-export {
-	getFirstDayOfWeek,
-	getLegacyDateCalendarCustomizing,
-};
-
-export type { FormatSettings };

package/src/config/Icons.ts

@@ -1,126 +0,0 @@
-import { getTheme, isThemeFamily } from "./Theme.js";
-import { getIconCollectionByAlias } from "../assets-meta/IconCollectionsAlias.js";
-
-const IconCollectionConfiguration = new Map<string, string>();
-
-// All supported icon collections + unknown custom ones
-type IconCollection = "SAP-icons" | "SAP-icons-v4" | "SAP-icons-v5" | "horizon" | "tnt" | "tnt-v2" | "tnt-v3" | "business-suite" | "business-suite-v1" | "business-suite-v2" | string;
-
-// All registered icon collections - all icon collections resolves to these options at the end
-enum RegisteredIconCollection {
-	SAPIconsV4 = "SAP-icons-v4",
-	SAPIconsV5 = "SAP-icons-v5",
-	SAPIconsTNTV2 = "tnt-v2",
-	SAPIconsTNTV3 = "tnt-v3",
-	SAPBSIconsV1 = "business-suite-v1",
-	SAPBSIconsV2 = "business-suite-v2",
-}
-
-/**
- * Sets the default icon collection for a given theme.
- *
- * SAP Icons is the default icon collection (that resolves to SAP-icons version 5.x in Horizon theme family and SAP-icons version 4.x in all other themes)
- * and to display icons from other collections, you have to specify the icon collection in addition to the icon name, for example: "tnt/actor", "business-suite/1x2-grid-layout", etc.
- * This method allows setting another (built-in or custom) icon collection as default per theme.
- *
- * <b>Usage</b>
- * <b>For example</b>, to make "SAP-icons version 5.x" the default icon collection in "sap_fiori_3":
- *
- * <pre>
- * setDefaultIconCollection("sap_fiori_3", "SAP-icons-v5");
- *
- * <ui5-icon name="home"></ui5-icon>
- * </pre>
- *
- * <b>For example</b>, to make a custom icon collection (with name "my-custom-collection") the default icon collection in "sap_fiori_3":
- *
- * <pre>
- * setDefaultIconCollection("sap_fiori_3", "my-custom-collection");
- *
- * <ui5-icon name="custom-icon-name"></ui5-icon>
- * </pre>
- *
- * @public
- * @param { string } theme
- * @param { string } collectionName
- */
-const setDefaultIconCollection = (theme: string, collectionName: IconCollection) => {
-	IconCollectionConfiguration.set(theme, collectionName);
-};
-
-/**
- * Returns the configured default icon collection for a given theme.
- *
- * @param { string } theme
- * @public
- * @returns { string | undefined }
- */
-const getDefaultIconCollection = (theme: string): string | undefined => {
-	return IconCollectionConfiguration.get(theme);
-};
-
-/**
- * Returns the effective icon collection,
- * based on the default icon collection configuration and the current theme:
- * @param { IconCollection } collectionName
- * @returns { IconCollection } the effective collection name
- */
-const getEffectiveIconCollection = (collectionName?: IconCollection): IconCollection => {
-	const currentTheme = getTheme();
-	const currentThemeConfiguration = IconCollectionConfiguration.get(currentTheme);
-
-	// when no collection is set and default collection is configured - return the configured icon collection
-	if (!collectionName && currentThemeConfiguration) {
-		return getIconCollectionByAlias(currentThemeConfiguration);
-	}
-
-	// when collection is set - return the theme dependant icon collection
-	// when collection is not set and there is no default icon collection configured - return theme dependant icon collection
-	return getIconCollectionByTheme(collectionName);
-};
-
-/**
- * Returns the icon theme dependant collection, based on the collection name and current theme as follows:
- *
- * - "no collection" resolves to "SAP-icons-v4" in "Quartz" and "Belize", and to "SAP-icons-v5" in "Horizon" (or as confugred via setDefaultIconCollection)
- * - "SAP-icons-v4" (and its alias "SAP-icons") forces "SAP-icons v4" in any theme and resolves to itself "SAP-icons-v4"
- * - "SAP-icons-v5" (and its alias "horizon") forces  "SAP-icons v5" in any theme and resolves to itself "SAP-icons-v5"
- * - "tnt" (and its alias "SAP-icons-TNT") resolves to "tnt-v2" in "Quartz", "Belize", and resolves to "tnt-v3" in "Horizon"
- * - "tnt-v2" forces "TNT icons v2" in any theme and resolves to itself "tnt-v2"
- * - "tnt-v3" forces "TNT icons v3" in any theme and resolves to itself "tnt-v3"
- * - "business-suite" (and its alias "BusinessSuiteInAppSymbols") resolves to "business-suite-v1" in "Quartz", "Belize", and resolves to "business-suite-v2" in "Horizon"
- * - "business-suite-v1" forces "Business Suite icons v1" in any theme and resolves to itself "business-suite-v1"
- * - "business-suite-v2" forces "Business Suite icons v2" in any theme and resolves to itself "business-suite-v2"
- *
- * <b>Note:</b> "SAP-icons-v4", "SAP-icons-v5", "tnt-v2", "tnt-v3", "business-suite-v1" and "business-suite-v2" are just returned
- * @param { IconCollection } collectionName
- * @returns { RegisteredIconCollection } the registered collection name
- */
-const getIconCollectionByTheme = (collectionName?: IconCollection): RegisteredIconCollection => {
-	const horizonThemeFamily = isThemeFamily("sap_horizon");
-
-	if (!collectionName) {
-		return horizonThemeFamily ? RegisteredIconCollection.SAPIconsV5 : RegisteredIconCollection.SAPIconsV4;
-	}
-
-	if (collectionName === "tnt") {
-		return horizonThemeFamily ? RegisteredIconCollection.SAPIconsTNTV3 : RegisteredIconCollection.SAPIconsTNTV2;
-	}
-
-	if (collectionName === "business-suite") {
-		return horizonThemeFamily ? RegisteredIconCollection.SAPBSIconsV2 : RegisteredIconCollection.SAPBSIconsV1;
-	}
-
-	return collectionName as RegisteredIconCollection;
-};
-
-export {
-	setDefaultIconCollection,
-	getDefaultIconCollection,
-	getEffectiveIconCollection,
-	RegisteredIconCollection,
-};
-
-export type {
-	IconCollection,
-};

package/src/config/Language.ts

@@ -1,72 +0,0 @@
-import {
-	getLanguage as getConfiguredLanguage,
-	getFetchDefaultLanguage as getConfiguredFetchDefaultLanguage,
-} from "../InitialConfiguration.js";
-import { fireLanguageChange } from "../locale/languageChange.js";
-import { reRenderAllUI5Elements } from "../Render.js";
-
-let curLanguage: string | undefined;
-let fetchDefaultLanguage: boolean;
-
-/**
- * Returns the currently configured language, or the browser language as a fallback.
- * @public
- * @returns {string}
- */
-const getLanguage = (): string | undefined => {
-	if (curLanguage === undefined) {
-		curLanguage = getConfiguredLanguage();
-	}
-	return curLanguage;
-};
-
-/**
- * Changes the current language, re-fetches all message bundles, updates all language-aware components
- * and returns a promise that resolves when all rendering is done.
- *
- * @param {string} language
- * @public
- * @returns {Promise<void>}
- */
-const setLanguage = async (language: string): Promise<void> => {
-	if (curLanguage === language) {
-		return;
-	}
-
-	curLanguage = language;
-
-	await fireLanguageChange(language);
-	await reRenderAllUI5Elements({ languageAware: true });
-};
-
-/**
- * Defines if the default language, that is inlined, should be
- * fetched over the network instead of using the inlined one.
- * <b>Note:</b> By default the language will not be fetched.
- *
- * @public
- * @param {boolean} fetchDefaultLang
- */
-const setFetchDefaultLanguage = (fetchDefaultLang: boolean) => {
-	fetchDefaultLanguage = fetchDefaultLang;
-};
-
-/**
- * Returns if the default language, that is inlined, should be fetched over the network.
- * @public
- * @returns {boolean}
- */
-const getFetchDefaultLanguage = (): boolean => {
-	if (fetchDefaultLanguage === undefined) {
-		setFetchDefaultLanguage(getConfiguredFetchDefaultLanguage());
-	}
-
-	return fetchDefaultLanguage;
-};
-
-export {
-	getLanguage,
-	setLanguage,
-	setFetchDefaultLanguage,
-	getFetchDefaultLanguage,
-};

package/src/config/NoConflict.ts

@@ -1,67 +0,0 @@
-import { getNoConflict as getConfiguredNoConflict } from "../InitialConfiguration.js";
-
-// Fire these events even with noConflict: true
-const excludeList = [
-	"value-changed",
-];
-
-type NoConflictData = boolean | { events: Array<string>};
-
-let noConflict: NoConflictData;
-
-const shouldFireOriginalEvent = (eventName: string) => {
-	return excludeList.includes(eventName);
-};
-
-const shouldNotFireOriginalEvent = (eventName: string) => {
-	const nc = getNoConflict();
-	// return !(nc.events && nc.events.includes && nc.events.includes(eventName));
-	return !(typeof nc !== "boolean" && nc.events && nc.events.includes && nc.events.includes(eventName));
-};
-
-/**
- * Returns if the "noConflict" configuration is set.
- * @public
- * @returns { NoConflictData }
- */
-const getNoConflict = (): NoConflictData => {
-	if (noConflict === undefined) {
-		noConflict = getConfiguredNoConflict();
-	}
-
-	return noConflict;
-};
-
-/**
- * Sets the "noConflict" mode.
- * - When "false" (default value), all custom events are fired with and without the "ui5-" prefix.
- * - When "true", all custom events are fired with the "ui5-" prefix only.
- * - When an object is supplied, just the specified events will be fired with the "ui5-" prefix.
- * @public
- * @param { NoConflictData } noConflictData
- */
-const setNoConflict = (noConflictData: NoConflictData) => {
-	noConflict = noConflictData;
-};
-
-const skipOriginalEvent = (eventName: string) => {
-	const nc = getNoConflict();
-
-	// Always fire these events
-	if (shouldFireOriginalEvent(eventName)) {
-		return false;
-	}
-
-	// Read from the configuration
-	if (nc === true) {
-		return true;
-	}
-
-	return !shouldNotFireOriginalEvent(eventName);
-};
-
-export {
-	getNoConflict,
-	setNoConflict,
-	skipOriginalEvent,
-};

package/src/config/RTL.ts

@@ -1,45 +0,0 @@
-import { getRTL as getConfiguredRTL } from "../InitialConfiguration.js";
-import { getLanguage } from "./Language.js";
-import getDesigntimePropertyAsArray from "../util/getDesigntimePropertyAsArray.js";
-import detectNavigatorLanguage from "../util/detectNavigatorLanguage.js";
-
-const M_ISO639_OLD_TO_NEW = {
-	"iw": "he",
-	"ji": "yi",
-	"in": "id",
-	"sh": "sr",
-};
-
-const A_RTL_LOCALES = getDesigntimePropertyAsArray("$cldr-rtl-locales:ar,fa,he$") || [];
-
-/**
- * Checks whether the language is using RTL
- * @param {string} language
- * @returns {boolean} whether the language is using RTL
- */
-const impliesRTL = (language: string) => {
-	language = (language && M_ISO639_OLD_TO_NEW[language as keyof typeof M_ISO639_OLD_TO_NEW]) || language;
-
-	return A_RTL_LOCALES.indexOf(language) >= 0;
-};
-
-/**
- * Gets the effective RTL setting by first checking the configuration
- * and if not set using the currently set language or the navigator language if the language is not explicitly set.
- * @returns {boolean} whether RTL should be used
- */
-const getRTL = (): boolean => {
-	if (typeof document === "undefined") {
-		return false;
-	}
-
-	const configurationRTL = getConfiguredRTL();
-
-	if (configurationRTL !== undefined) {
-		return !!configurationRTL;
-	}
-
-	return impliesRTL(getLanguage() || detectNavigatorLanguage());
-};
-
-export { getRTL }; // eslint-disable-line

package/src/config/Theme.ts

@@ -1,64 +0,0 @@
-import { getTheme as getConfiguredTheme } from "../InitialConfiguration.js";
-import { reRenderAllUI5Elements } from "../Render.js";
-import applyTheme from "../theming/applyTheme.js";
-
-let curTheme: string;
-
-/**
- * Returns the current theme.
- * @public
- * @returns {string} the current theme name
- */
-const getTheme = (): string => {
-	if (curTheme === undefined) {
-		curTheme = getConfiguredTheme();
-	}
-
-	return curTheme;
-};
-
-/**
- * Applies a new theme after fetching its assets from the network.
- * @public
- * @param {string} theme the name of the new theme
- * @returns {Promise<void>} a promise that is resolved when the new theme assets have been fetched and applied to the DOM
- */
-const setTheme = async (theme: string): Promise<void> => {
-	if (curTheme === theme) {
-		return;
-	}
-
-	curTheme = theme;
-
-	// Update CSS Custom Properties
-	await applyTheme(curTheme);
-	await reRenderAllUI5Elements({ themeAware: true });
-};
-
-/**
- * Returns if the given theme name is the one currently applied.
- * @private
- * @param {string} theme
- * @returns {boolean}
- */
-const isTheme = (theme: string) => {
-	const currentTheme = getTheme();
-	return currentTheme === theme || currentTheme === `${theme}_exp`;
-};
-
-/**
- * Returns if the current theme is part of given theme family.
- * @private
- * @param {string} theme the theme family
- * @returns {boolean}
- */
-const isThemeFamily = (theme: string) => {
-	return getTheme().startsWith(theme);
-};
-
-export {
-	getTheme,
-	setTheme,
-	isTheme,
-	isThemeFamily,
-};

package/src/config/ThemeRoots.ts

@@ -1,41 +0,0 @@
-import createLinkInHead from "../util/createLinkInHead.js";
-import validateThemeRoot from "../validateThemeRoot.js";
-import { getThemeRoot as getConfiguredThemeRoot } from "../InitialConfiguration.js";
-
-let themeRoot: string | undefined;
-
-const getThemeRoot = (): string | undefined => {
-	if (themeRoot === undefined) {
-		themeRoot = getConfiguredThemeRoot();
-	}
-
-	return themeRoot;
-};
-
-const setThemeRoot = (theme: string, newThemeRoot: string) => {
-	themeRoot = validateThemeRoot(newThemeRoot);
-
-	if (themeRoot) {
-		attachCustomThemeStylesToHead(theme);
-	}
-};
-
-const formatThemeLink = (theme: string) => {
-	return `${getThemeRoot()!}Base/baseLib/${theme}/css_variables.css`; // theme root is always set.
-};
-
-const attachCustomThemeStylesToHead = async (theme: string) => {
-	const link = document.querySelector(`[sap-ui-webcomponents-theme="${theme}"]`);
-
-	if (link) {
-		document.head.removeChild(link);
-	}
-
-	await createLinkInHead(formatThemeLink(theme), { "sap-ui-webcomponents-theme": theme });
-};
-
-export {
-	getThemeRoot,
-	setThemeRoot,
-	attachCustomThemeStylesToHead,
-};

package/src/decorators/customElement.ts

@@ -1,57 +0,0 @@
-import type UI5Element from "../UI5Element.js";
-import type { Renderer } from "../UI5Element.js";
-import type { TemplateFunction as Template } from "../renderer/executeTemplate.js";
-import type { ComponentStylesData as Styles } from "../types.js";
-
-/**
- * Returns a custom element class decorator.
- *
- * @param { string | object } tagNameOrComponentSettings
- * @returns { ClassDecorator }
- */
-const customElement = (tagNameOrComponentSettings: string | {
-	tag?: string,
-	renderer?: Renderer,
-	styles?: Styles,
-	template?: Template,
-	dependencies?: Array<typeof UI5Element>,
-	staticAreaStyles?: Styles,
-	staticAreaTemplate?: Template,
-	languageAware?: boolean,
-	themeAware?: boolean,
-	fastNavigation?: boolean,
-}): ClassDecorator => {
-	return (target: any) => {
-		if (!Object.prototype.hasOwnProperty.call(target, "metadata")) {
-			target.metadata = {};
-		}
-
-		if (typeof tagNameOrComponentSettings === "string") {
-			target.metadata.tag = tagNameOrComponentSettings;
-			return;
-		}
-
-		const {
-			tag,
-			languageAware = false,
-			themeAware = false,
-			fastNavigation = false,
-		 } = tagNameOrComponentSettings;
-
-		target.metadata.tag = tag;
-		target.metadata.languageAware = languageAware;
-		target.metadata.themeAware = themeAware;
-		target.metadata.fastNavigation = fastNavigation;
-
-		["render", "renderer", "template", "staticAreaTemplate", "styles", "staticAreaStyles", "dependencies"].forEach((customElementEntity: string) => {
-			const _customElementEntity = customElementEntity === "render" ? "renderer" : customElementEntity;
-			const customElementEntityValue = tagNameOrComponentSettings[_customElementEntity as keyof typeof tag];
-
-			customElementEntityValue && Object.defineProperty(target, customElementEntity, {
-				get: () => customElementEntityValue,
-			});
-		});
-	};
-};
-
-export default customElement;

package/src/decorators/event.ts

@@ -1,28 +0,0 @@
-import { EventData } from "../UI5ElementMetadata.js";
-
-/**
- * Returns an event class decorator.
- *
- * @param { string } name the event name
- * @param { EventData } data the event data
- * @returns { ClassDecorator }
- */
-const event = (name: string, data: EventData = {}): ClassDecorator => {
-	return (target: any) => {
-		if (!Object.prototype.hasOwnProperty.call(target, "metadata")) {
-			target.metadata = {};
-		}
-
-		const metadata = target.metadata;
-		if (!metadata.events) {
-			metadata.events = {};
-		}
-
-		const eventsMetadata = metadata.events;
-		if (!eventsMetadata[name]) {
-			eventsMetadata[name] = data;
-		}
-	};
-};
-
-export default event;

package/src/decorators/property.ts

@@ -1,30 +0,0 @@
-import type UI5Element from "../UI5Element.js";
-import { Property } from "../UI5ElementMetadata.js";
-
-/**
- * Returns a property decorator.
- *
- * @param { Property } propData
- * @returns { PropertyDecorator }
- */
-const property = (propData?: Property): PropertyDecorator => {
-	return (target: any, propertyKey: string | symbol) => {
-		const ctor = target.constructor as typeof UI5Element;
-
-		if (!Object.prototype.hasOwnProperty.call(ctor, "metadata")) {
-			ctor.metadata = {};
-		}
-
-		const metadata = ctor.metadata;
-		if (!metadata.properties) {
-			metadata.properties = {};
-		}
-
-		const propsMetadata = metadata.properties;
-		if (!propsMetadata[propertyKey as string]) {
-			propsMetadata[propertyKey as string] = propData || { type: String };
-		}
-	};
-};
-
-export default property;

package/src/decorators/slot.ts

@@ -1,49 +0,0 @@
-import type UI5Element from "../UI5Element.js";
-import { Slot } from "../UI5ElementMetadata.js";
-
-/**
- * Returns a slot decorator.
- *
- * @param { Slot } slotData
- * @returns { PropertyDecorator }
- */
-const slot = (slotData?: Slot): PropertyDecorator => {
-	return (target: any, slotKey: string | symbol) => {
-		const ctor = target.constructor as typeof UI5Element;
-
-		if (!Object.prototype.hasOwnProperty.call(ctor, "metadata")) {
-			ctor.metadata = {};
-		}
-
-		const metadata = ctor.metadata;
-		if (!metadata.slots) {
-			metadata.slots = {};
-		}
-
-		const slotMetadata = metadata.slots;
-
-		if (slotData?.default && slotMetadata.default) {
-			throw new Error("Only one slot can be the default slot.");
-		}
-
-		const key = slotData?.default ? "default" : slotKey as string;
-		slotData = slotData || { type: HTMLElement };
-
-		if (!slotData.type) {
-			slotData.type = HTMLElement;
-		}
-
-		if (!slotMetadata[key]) {
-			slotMetadata[key] = slotData;
-		}
-
-		if (slotData.default) {
-			delete slotMetadata.default.default;
-			slotMetadata.default.propertyName = slotKey as string;
-		}
-
-		ctor.metadata.managedSlots = true;
-	};
-};
-
-export default slot;