@ui5/webcomponents-base 1.9.3 → 1.10.0

package/src/{Render.js → Render.ts}

@@ -2,18 +2,22 @@ import EventProvider from "./EventProvider.js";
 import RenderQueue from "./RenderQueue.js";
 import { getAllRegisteredTags } from "./CustomElementsRegistry.js";
 import { isRtlAware } from "./locale/RTLAwareRegistry.js";
+import type UI5Element from "./UI5Element.js";
+import { PromiseResolve, Timeout } from "./types.js";
 
-const registeredElements = new Set();
-const eventProvider = new EventProvider();
+type BeforeComponentRenderCallback = (webComponent: UI5Element) => void;
+
+const registeredElements = new Set<UI5Element>();
+const eventProvider = new EventProvider<UI5Element, void>();
 
 const invalidatedWebComponents = new RenderQueue(); // Queue for invalidated web components
 
-let renderTaskPromise,
-	renderTaskPromiseResolve;
+let renderTaskPromise: Promise<void> | undefined,
+	renderTaskPromiseResolve: PromiseResolve | undefined;
 
-let mutationObserverTimer;
+let mutationObserverTimer: Timeout | undefined;
 
-let queuePromise;
+let queuePromise: Promise<void> | null;
 
 /**
  * Schedules a render task (if not already scheduled) to render the component
@@ -21,7 +25,7 @@ let queuePromise;
  * @param webComponent
  * @returns {Promise}
  */
-const renderDeferred = async webComponent => {
+const renderDeferred = async (webComponent: UI5Element) => {
 	// Enqueue the web component
 	invalidatedWebComponents.add(webComponent);
 
@@ -34,7 +38,7 @@ const renderDeferred = async webComponent => {
  *
  * @param webComponent
  */
-const renderImmediately = webComponent => {
+const renderImmediately = (webComponent: UI5Element) => {
 	eventProvider.fireEvent("beforeComponentRender", webComponent);
 	registeredElements.add(webComponent);
 	webComponent._render();
@@ -45,7 +49,7 @@ const renderImmediately = webComponent => {
  *
  * @param webComponent
  */
-const cancelRender = webComponent => {
+const cancelRender = (webComponent: UI5Element) => {
 	invalidatedWebComponents.remove(webComponent);
 	registeredElements.delete(webComponent);
 };
@@ -55,7 +59,7 @@ const cancelRender = webComponent => {
  */
 const scheduleRenderTask = async () => {
 	if (!queuePromise) {
-		queuePromise = new Promise(resolve => {
+		queuePromise = new Promise<void>(resolve => {
 			window.requestAnimationFrame(() => {
 				// Render all components in the queue
 
@@ -91,7 +95,7 @@ const whenDOMUpdated = () => {
 		return renderTaskPromise;
 	}
 
-	renderTaskPromise = new Promise(resolve => {
+	renderTaskPromise = new Promise<void>(resolve => {
 		renderTaskPromiseResolve = resolve;
 		window.requestAnimationFrame(() => {
 			if (invalidatedWebComponents.isEmpty()) {
@@ -140,15 +144,16 @@ const _resolveTaskPromise = () => {
  * etc...
  *
  * @public
- * @param {Object|undefined} filters - Object with keys that can be "rtlAware" or "languageAware"
+ * @param {object|undefined} filters - Object with keys that can be "rtlAware" or "languageAware"
  * @returns {Promise<void>}
  */
-const reRenderAllUI5Elements = async filters => {
-	registeredElements.forEach(element => {
-		const tag = element.constructor.getMetadata().getTag();
-		const rtlAware = isRtlAware(element.constructor);
-		const languageAware = element.constructor.getMetadata().isLanguageAware();
-		const themeAware = element.constructor.getMetadata().isThemeAware();
+const reRenderAllUI5Elements = async (filters?: {tag?: string, rtlAware?: boolean, languageAware?: boolean, themeAware?: boolean}) => {
+	registeredElements.forEach((element: UI5Element) => {
+		const ctor = element.constructor as typeof UI5Element;
+		const tag = ctor.getMetadata().getTag();
+		const rtlAware = isRtlAware(ctor);
+		const languageAware = ctor.getMetadata().isLanguageAware();
+		const themeAware = ctor.getMetadata().isThemeAware();
 		if (!filters || (filters.tag === tag) || (filters.rtlAware && rtlAware) || (filters.languageAware && languageAware) || (filters.themeAware && themeAware)) {
 			renderDeferred(element);
 		}
@@ -156,11 +161,11 @@ const reRenderAllUI5Elements = async filters => {
 	await renderFinished();
 };
 
-const attachBeforeComponentRender = listener => {
+const attachBeforeComponentRender = (listener: BeforeComponentRenderCallback) => {
 	eventProvider.attachEvent("beforeComponentRender", listener);
 };
 
-const detachBeforeComponentRender = listener => {
+const detachBeforeComponentRender = (listener: BeforeComponentRenderCallback) => {
 	eventProvider.detachEvent("beforeComponentRender", listener);
 };
 

package/src/{RenderQueue.js → RenderQueue.ts}

@@ -1,12 +1,17 @@
+import type UI5Element from "./UI5Element.js";
+
 const MAX_PROCESS_COUNT = 10;
 
 class RenderQueue {
+	list: Array<UI5Element>;
+	lookup: Set<UI5Element>;
+
 	constructor() {
 		this.list = []; // Used to store the web components in order
 		this.lookup = new Set(); // Used for faster search
 	}
 
-	add(webComponent) {
+	add(webComponent: UI5Element) {
 		if (this.lookup.has(webComponent)) {
 			return;
 		}
@@ -15,7 +20,7 @@ class RenderQueue {
 		this.lookup.add(webComponent);
 	}
 
-	remove(webComponent) {
+	remove(webComponent: UI5Element) {
 		if (!this.lookup.has(webComponent)) {
 			return;
 		}
@@ -36,7 +41,7 @@ class RenderQueue {
 		return this.list.length === 0;
 	}
 
-	isAdded(webComponent) {
+	isAdded(webComponent: UI5Element) {
 		return this.lookup.has(webComponent);
 	}
 
@@ -46,9 +51,9 @@ class RenderQueue {
 	 *
 	 * @param callback - function with one argument (the web component to be processed)
 	 */
-	process(callback) {
+	process(callback: (el: UI5Element) => void) {
 		let webComponent;
-		const stats = new Map();
+		const stats = new Map<UI5Element, number>();
 
 		webComponent = this.shift();
 		while (webComponent) {

package/src/{Runtimes.js → Runtimes.ts}

@@ -1,17 +1,22 @@
 import VersionInfo from "./generated/VersionInfo.js";
 import getSharedResource from "./getSharedResource.js";
 
-let currentRuntimeIndex;
+type RuntimeData = VersionInfo & {
+	alias: string,
+	description: string,
+};
+
+let currentRuntimeIndex: number;
 let currentRuntimeAlias = "";
 
-const compareCache = new Map();
+const compareCache = new Map<string, number>();
 
 /**
  * Central registry where all runtimes register themselves by pushing an object.
  * The index in the registry servers as an ID for the runtime.
  * @type {*}
  */
-const Runtimes = getSharedResource("Runtimes", []);
+const Runtimes = getSharedResource<Array<RuntimeData>>("Runtimes", []);
 
 /**
  * Registers the current runtime in the shared runtimes resource registry
@@ -19,10 +24,12 @@ const Runtimes = getSharedResource("Runtimes", []);
 const registerCurrentRuntime = () => {
 	if (currentRuntimeIndex === undefined) {
 		currentRuntimeIndex = Runtimes.length;
+		const versionInfo = VersionInfo;
+
 		Runtimes.push({
-			...VersionInfo,
+			...versionInfo,
 			alias: currentRuntimeAlias,
-			description: `Runtime ${currentRuntimeIndex} - ver ${VersionInfo.version}${currentRuntimeAlias ? ` (${currentRuntimeAlias})` : ""}`,
+			description: `Runtime ${currentRuntimeIndex} - ver ${versionInfo.version}${currentRuntimeAlias ? ` (${currentRuntimeAlias})` : ""}`,
 		});
 	}
 };
@@ -41,10 +48,10 @@ const getCurrentRuntimeIndex = () => {
  * @param index2 The index of the second runtime to compare
  * @returns {number}
  */
-const compareRuntimes = (index1, index2) => {
+const compareRuntimes = (index1: number, index2: number) => {
 	const cacheIndex = `${index1},${index2}`;
 	if (compareCache.has(cacheIndex)) {
-		return compareCache.get(cacheIndex);
+		return compareCache.get(cacheIndex)!;
 	}
 
 	const runtime1 = Runtimes[index1];
@@ -90,7 +97,7 @@ const compareRuntimes = (index1, index2) => {
  * Set an alias for the the current app/library/microfrontend which will appear in debug messages and console warnings
  * @param alias
  */
-const setRuntimeAlias = alias => {
+const setRuntimeAlias = (alias: string) => {
 	currentRuntimeAlias = alias;
 };
 

package/src/{StaticAreaItem.js → StaticAreaItem.ts}

@@ -4,6 +4,10 @@ import { renderFinished } from "./Render.js";
 import getEffectiveContentDensity from "./util/getEffectiveContentDensity.js";
 import { getEffectiveScopingSuffixForTag } from "./CustomElementsScopeUtils.js";
 import getEffectiveDir from "./locale/getEffectiveDir.js";
+import type UI5Element from "./UI5Element.js";
+
+const pureTagName = "ui5-static-area-item";
+const popupIntegrationAttr = "data-sap-ui-integration-popup-content";
 
 /**
  *
@@ -12,36 +16,35 @@ import getEffectiveDir from "./locale/getEffectiveDir.js";
  * @private
  */
 class StaticAreaItem extends HTMLElement {
+	_rendered: boolean;
+	ownerElement?: UI5Element;
+
 	constructor() {
 		super();
 		this._rendered = false;
 		this.attachShadow({ mode: "open" });
-		this.pureTagName = "ui5-static-area-item";
-		this.popupIntegrationAttr = "data-sap-ui-integration-popup-content";
 	}
 
 	/**
-	 * @protected
-	 * @param ownerElement The UI5Element instance that owns this static area item
+	 * @param {UI5Element} ownerElement the UI5Element instance that owns this static area item
 	 */
-	setOwnerElement(ownerElement) {
+	setOwnerElement(ownerElement: UI5Element) {
 		this.ownerElement = ownerElement;
 		this.classList.add(this.ownerElement._id); // used for getting the popover in the tests
 		if (this.ownerElement.hasAttribute("data-ui5-static-stable")) {
-			this.setAttribute("data-ui5-stable", this.ownerElement.getAttribute("data-ui5-static-stable")); // stable selector
+			this.setAttribute("data-ui5-stable", this.ownerElement.getAttribute("data-ui5-static-stable")!); // stable selector
 		}
 	}
 
 	/**
 	 * Updates the shadow root of the static area item with the latest state, if rendered
-	 * @protected
 	 */
 	update() {
 		if (this._rendered) {
 			this._updateAdditionalAttrs();
 			this._updateContentDensity();
 			this._updateDirection();
-			updateShadowRoot(this.ownerElement, true);
+			updateShadowRoot(this.ownerElement!, true);
 		}
 	}
 
@@ -50,7 +53,7 @@ class StaticAreaItem extends HTMLElement {
 	 * @private
 	 */
 	_updateContentDensity() {
-		if (getEffectiveContentDensity(this.ownerElement) === "compact") {
+		if (getEffectiveContentDensity(this.ownerElement!) === "compact") {
 			this.classList.add("sapUiSizeCompact");
 			this.classList.add("ui5-content-density-compact");
 		} else {
@@ -60,17 +63,19 @@ class StaticAreaItem extends HTMLElement {
 	}
 
 	_updateDirection() {
-		const dir = getEffectiveDir(this.ownerElement);
-		if (dir) {
-			this.setAttribute("dir", dir);
-		} else {
-			this.removeAttribute("dir");
+		if (this.ownerElement) {
+			const dir = getEffectiveDir(this.ownerElement);
+			if (dir) {
+				this.setAttribute("dir", dir);
+			} else {
+				this.removeAttribute("dir");
+			}
 		}
 	}
 
 	_updateAdditionalAttrs() {
-		this.setAttribute(this.pureTagName, "");
-		this.setAttribute(this.popupIntegrationAttr, "");
+		this.setAttribute(pureTagName, "");
+		this.setAttribute(popupIntegrationAttr, "");
 	}
 
 	/**
@@ -81,20 +86,19 @@ class StaticAreaItem extends HTMLElement {
 		this._updateContentDensity();
 		if (!this._rendered) {
 			this._rendered = true;
-			updateShadowRoot(this.ownerElement, true);
+			updateShadowRoot(this.ownerElement!, true);
 		}
 		await renderFinished(); // Wait for the content of the ui5-static-area-item to be rendered
 		return this.shadowRoot;
 	}
 
 	static getTag() {
-		const pureTag = "ui5-static-area-item";
-		const suffix = getEffectiveScopingSuffixForTag(pureTag);
+		const suffix = getEffectiveScopingSuffixForTag(pureTagName);
 		if (!suffix) {
-			return pureTag;
+			return pureTagName;
 		}
 
-		return `${pureTag}-${suffix}`;
+		return `${pureTagName}-${suffix}`;
 	}
 
 	static createInstance() {
@@ -102,7 +106,7 @@ class StaticAreaItem extends HTMLElement {
 			customElements.define(StaticAreaItem.getTag(), StaticAreaItem);
 		}
 
-		return document.createElement(this.getTag());
+		return document.createElement(this.getTag()) as StaticAreaItem;
 	}
 }