@ui5/webcomponents-base 0.0.0-e55c2cec6 → 0.0.0-e5b03d3e8

package/dist/UI5Element.d.ts

@@ -1,8 +1,12 @@
-import UI5ElementMetadata, { Slot, SlotValue, State, PropertyValue, Metadata } from "./UI5ElementMetadata.js";
+import "@ui5/webcomponents-base/dist/ssr-dom.js";
+import type { JSX } from "./jsx-runtime.js";
+import UI5ElementMetadata from "./UI5ElementMetadata.js";
+import type { Slot, SlotValue, State, PropertyValue, Metadata } from "./UI5ElementMetadata.js";
 import EventProvider from "./EventProvider.js";
-import StaticAreaItem from "./StaticAreaItem.js";
-import { TemplateFunction, TemplateFunctionResult } from "./renderer/executeTemplate.js";
-import { PromiseResolve, ComponentStylesData, ClassMap } from "./types.js";
+import type { TemplateFunction } from "./renderer/executeTemplate.js";
+import type { AccessibilityInfo, PromiseResolve, ComponentStylesData, ClassMap } from "./types.js";
+import type I18nBundle from "./i18nBundle.js";
+type Renderer = (instance: UI5Element, container: HTMLElement | DocumentFragment) => void;
 type ChangeInfo = {
     type: "property" | "slot";
     name: string;
@@ -17,40 +21,67 @@ type InvalidationInfo = ChangeInfo & {
 };
 type ChildChangeListener = (param: InvalidationInfo) => void;
 type SlotChangeListener = (this: HTMLSlotElement, ev: Event) => void;
+type SlottedChild = Record<string, any>;
+type NotEqual<X, Y> = true extends Equal<X, Y> ? false : true;
+type Equal<X, Y> = (<T>() => T extends X ? 1 : 2) extends (<T>() => T extends Y ? 1 : 2) ? true : false;
+type IsAny<T, Y, N> = 0 extends (1 & T) ? Y : N;
+type KebabToCamel<T extends string> = T extends `${infer H}-${infer J}${infer K}` ? `${Uncapitalize<H>}${Capitalize<J>}${KebabToCamel<K>}` : T;
+type KebabToPascal<T extends string> = Capitalize<KebabToCamel<T>>;
+type GlobalHTMLAttributeNames = "accesskey" | "autocapitalize" | "autofocus" | "autocomplete" | "contenteditable" | "contextmenu" | "class" | "dir" | "draggable" | "enterkeyhint" | "hidden" | "id" | "inputmode" | "lang" | "nonce" | "part" | "exportparts" | "pattern" | "slot" | "spellcheck" | "style" | "tabIndex" | "tabindex" | "title" | "translate" | "ref" | "inert";
+type ElementProps<I> = Partial<Omit<I, keyof HTMLElement>>;
+type TargetedCustomEvent<D, T> = Omit<CustomEvent<D>, "currentTarget"> & {
+    currentTarget: T;
+};
+type TargetedEventHandler<D, T> = {
+    asMethod(e: TargetedCustomEvent<D, T>): void;
+}["asMethod"];
+type Convert<T, K extends UI5Element> = {
+    [Property in keyof T as `on${KebabToPascal<string & Property>}`]: IsAny<T[Property], any, TargetedEventHandler<T[Property], K>>;
+};
 /**
+ * @class
  * Base class for all UI5 Web Components
  *
- * @class
- * @constructor
- * @author SAP SE
- * @alias sap.ui.webc.base.UI5Element
  * @extends HTMLElement
  * @public
  */
 declare abstract class UI5Element extends HTMLElement {
+    eventDetails: NotEqual<this, UI5Element> extends true ? object : {
+        [k: string]: any;
+    };
+    _jsxEvents: Omit<JSX.DOMAttributes<this>, keyof Convert<this["eventDetails"], this> | "onClose" | "onToggle" | "onChange" | "onSelect" | "onInput"> & Convert<this["eventDetails"], this>;
+    _jsxProps: Pick<JSX.AllHTMLAttributes<HTMLElement>, GlobalHTMLAttributeNames> & ElementProps<this> & Partial<this["_jsxEvents"]> & {
+        key?: any;
+    };
     __id?: string;
     _suppressInvalidation: boolean;
     _changedState: Array<ChangeInfo>;
-    _eventProvider: EventProvider<InvalidationInfo, void>;
+    _invalidationEventProvider: EventProvider<InvalidationInfo, void>;
+    _componentStateFinalizedEventProvider: EventProvider<void, void>;
     _inDOM: boolean;
     _fullyConnected: boolean;
     _childChangeListeners: Map<string, ChildChangeListener>;
+    _slotsAssignedNodes: WeakMap<HTMLSlotElement, Array<SlotValue>>;
     _slotChangeListeners: Map<string, SlotChangeListener>;
     _domRefReadyPromise: Promise<void> & {
         _deferredResolve?: PromiseResolve;
     };
     _doNotSyncAttributes: Set<string>;
     _state: State;
-    _onComponentStateFinalized?: () => void;
+    _internals: ElementInternals;
+    _individualSlot?: string;
     _getRealDomRef?: () => HTMLElement;
-    staticAreaItem?: StaticAreaItem;
     static template?: TemplateFunction;
-    static staticAreaTemplate?: TemplateFunction;
     static _metadata: UI5ElementMetadata;
-    static render: (templateFunctionResult: TemplateFunctionResult, container: HTMLElement | DocumentFragment, styleStrOrHrefsArr: string | Array<string> | undefined, forStaticArea: boolean, options: {
-        host: HTMLElement;
-    }) => void;
+    static renderer: Renderer;
+    initializedProperties: Map<string, unknown>;
+    _rendered: boolean;
     constructor();
+    _initShadowRoot(): void;
+    /**
+     * Note: this "slotchange" listener is for slots, rendered in the component's shadow root
+     */
+    _onShadowRootSlotChange(e: Event): void;
     /**
      * Returns a unique ID for this UI5 Element
      *
@@ -58,6 +89,7 @@ declare abstract class UI5Element extends HTMLElement {
      * @protected
      */
     get _id(): string;
+    render(): object;
     /**
      * Do not call this method from derivatives of UI5Element, use "onEnterDOM" only
      * @private
@@ -113,22 +145,22 @@ declare abstract class UI5Element extends HTMLElement {
     /**
      * Attach a callback that will be executed whenever the component is invalidated
      *
-     * @param {InvalidationInfo} callback
+     * @param callback
      * @public
      */
     attachInvalidate(callback: (param: InvalidationInfo) => void): void;
     /**
      * Detach the callback that is executed whenever the component is invalidated
      *
-     * @param {InvalidationInfo} callback
+     * @param callback
      * @public
      */
     detachInvalidate(callback: (param: InvalidationInfo) => void): void;
     /**
      * Callback that is executed whenever a monitored child changes its state
      *
-     * @param {sting} slotName the slot in which a child was invalidated
-     * @param { ChangeInfo } childChangeInfo the changeInfo object for the child in the given slot
+     * @param slotName the slot in which a child was invalidated
+     * @param childChangeInfo the changeInfo object for the child in the given slot
      * @private
      */
     _onChildChange(slotName: string, childChangeInfo: ChangeInfo): void;
@@ -137,44 +169,37 @@ declare abstract class UI5Element extends HTMLElement {
      * @private
      */
     attributeChangedCallback(name: string, oldValue: string | null, newValue: string | null): void;
+    formAssociatedCallback(): void;
+    static get formAssociated(): boolean;
     /**
      * @private
      */
     _updateAttribute(name: string, newValue: PropertyValue): void;
-    /**
-     * @private
-     */
-    _upgradeProperty(this: Record<string, any>, propertyName: string): void;
-    /**
-     * @private
-     */
-    _upgradeAllProperties(): void;
     /**
      * Returns a singleton event listener for the "change" event of a child in a given slot
      *
      * @param slotName the name of the slot, where the child is
-     * @returns {ChildChangeListener}
      * @private
      */
-    _getChildChangeListener(slotName: string): ChildChangeListener | undefined;
+    _getChildChangeListener(slotName: string): ChildChangeListener;
     /**
      * Returns a singleton slotchange event listener that invalidates the component due to changes in the given slot
      *
      * @param slotName the name of the slot, where the slot element (whose slotchange event we're listening to) is
-     * @returns {SlotChangeListener}
      * @private
      */
     _getSlotChangeListener(slotName: string): SlotChangeListener;
     /**
      * @private
      */
-    _attachSlotChange(child: HTMLSlotElement, slotName: string): void;
+    _attachSlotChange(slot: HTMLSlotElement, slotName: string, invalidateOnChildChange: boolean): void;
     /**
      * @private
      */
     _detachSlotChange(child: HTMLSlotElement, slotName: string): void;
     /**
      * Whenever a slot element is slotted inside a UI5 Web Component, its slotchange event invalidates the component
+     * Note: this "slotchange" listener is for slots that are children of the component (in the light dom, as opposed to slots rendered by the component in the shadow root)
      *
      * @param slotName the name of the slot, where the slot element (whose slotchange event we're listening to) is
      * @private
@@ -195,9 +220,9 @@ declare abstract class UI5Element extends HTMLElement {
      *   1) children: immediate children (HTML elements or text nodes) were added, removed or reordered in the slot
      *   2) textcontent: text nodes in the slot changed value (or nested text nodes were added or changed value). Can only trigger for slots of "type: Node"
      *   3) slotchange: a slot element, slotted inside that slot had its "slotchange" event listener called. This practically means that transitively slotted children changed.
-     *      Can only trigger if the child of a slot is a slot element itself.
+     *	  Can only trigger if the child of a slot is a slot element itself.
      *   4) childchange: indicates that a UI5Element child in that slot was invalidated and in turn invalidated the component.
-     *      Can only trigger for slots with "invalidateOnChildChange" metadata descriptor
+     *	  Can only trigger for slots with "invalidateOnChildChange" metadata descriptor
      *
      *  - newValue: the new value of the property (for type="property" only)
      *
@@ -208,6 +233,7 @@ declare abstract class UI5Element extends HTMLElement {
      * @public
      */
     onInvalidation(changeInfo: ChangeInfo): void;
+    updateAttributes(): void;
     /**
      * Do not call this method directly, only intended to be called by js
      * @protected
@@ -221,7 +247,7 @@ declare abstract class UI5Element extends HTMLElement {
      * @private
      */
     _waitForDomRef(): Promise<void> & {
-        _deferredResolve?: PromiseResolve | undefined;
+        _deferredResolve?: PromiseResolve;
     };
     /**
      * Returns the DOM Element inside the Shadow Root that corresponds to the opening tag in the UI5 Web Component's template
@@ -245,9 +271,10 @@ declare abstract class UI5Element extends HTMLElement {
     getFocusDomRefAsync(): Promise<HTMLElement | undefined>;
     /**
      * Set the focus to the element, returned by "getFocusDomRef()" (marked by "data-sap-focus-ref")
+     * @param focusOptions additional options for the focus
      * @public
      */
-    focus(): Promise<void>;
+    focus(focusOptions?: FocusOptions): Promise<void>;
     /**
      *
      * @public
@@ -255,48 +282,80 @@ declare abstract class UI5Element extends HTMLElement {
      * @param data - additional data for the event
      * @param cancelable - true, if the user can call preventDefault on the event object
      * @param bubbles - true, if the event bubbles
-     * @returns {boolean} false, if the event was cancelled (preventDefault called), true otherwise
+     * @returns false, if the event was cancelled (preventDefault called), true otherwise
+     * @deprecated use fireDecoratorEvent instead
      */
     fireEvent<T>(name: string, data?: T, cancelable?: boolean, bubbles?: boolean): boolean;
+    /**
+     * Fires a custom event, configured via the "event" decorator.
+     * @public
+     * @param name - name of the event
+     * @param data - additional data for the event
+     * @returns false, if the event was cancelled (preventDefault called), true otherwise
+     */
+    fireDecoratorEvent<N extends keyof this["eventDetails"]>(name: N, data?: this["eventDetails"][N] | undefined): boolean;
     _fireEvent<T>(name: string, data?: T, cancelable?: boolean, bubbles?: boolean): boolean;
+    getEventData(name: string): {
+        detail?: Record<string, object>;
+        cancelable?: boolean;
+        bubbles?: boolean;
+    };
     /**
      * Returns the actual children, associated with a slot.
      * Useful when there are transitive slots in nested component scenarios and you don't want to get a list of the slots, but rather of their content.
      * @public
      */
-    getSlottedNodes(slotName: string): Node[];
+    getSlottedNodes<T = Node>(slotName: string): Array<T>;
+    /**
+     * Attach a callback that will be executed whenever the component's state is finalized
+     *
+     * @param callback
+     * @public
+     */
+    attachComponentStateFinalized(callback: () => void): void;
+    /**
+     * Detach the callback that is executed whenever the component's state is finalized
+     *
+     * @param callback
+     * @public
+     */
+    detachComponentStateFinalized(callback: () => void): void;
     /**
      * Determines whether the component should be rendered in RTL mode or not.
      * Returns: "rtl", "ltr" or undefined
      *
      * @public
-     * @returns {String|undefined}
+     * @default undefined
      */
     get effectiveDir(): string | undefined;
     /**
      * Used to duck-type UI5 elements without using instanceof
-     * @returns {boolean}
      * @public
+     * @default true
      */
     get isUI5Element(): boolean;
+    get isUI5AbstractElement(): boolean;
     get classes(): ClassMap;
     /**
-     * Do not override this method in derivatives of UI5Element, use metadata properties instead
+     * Returns the component accessibility info.
      * @private
      */
-    static get observedAttributes(): string[];
+    get accessibilityInfo(): AccessibilityInfo;
     /**
+     * Do not override this method in derivatives of UI5Element, use metadata properties instead
      * @private
      */
-    static _needsShadowDOM(): boolean;
+    static get observedAttributes(): string[];
     /**
+     * Returns all tags, used inside component's template subject to scoping.
+     * returns {Array[]} // TODO add @
      * @private
      */
-    static _needsStaticArea(): boolean;
+    static get tagsToScope(): Array<string>;
     /**
-     * @public
+     * @private
      */
-    getStaticAreaItemDomRef(): Promise<ShadowRoot | null>;
+    static _needsShadowDOM(): boolean;
     /**
      * @private
      */
@@ -305,69 +364,61 @@ declare abstract class UI5Element extends HTMLElement {
      * Returns the metadata object for this UI5 Web Component Class
      * @protected
      */
-    static get metadata(): Metadata;
-    /**
-     * Sets a new metadata object for this UI5 Web Component Class
-     * @protected
-     */
-    static set metadata(newMetadata: Metadata);
+    static metadata: Metadata;
     /**
      * Returns the CSS for this UI5 Web Component Class
      * @protected
      */
-    static get styles(): ComponentStylesData;
-    /**
-     * Returns the Static Area CSS for this UI5 Web Component Class
-     * @protected
-     */
-    static get staticAreaStyles(): ComponentStylesData;
+    static styles: ComponentStylesData;
     /**
      * Returns an array with the dependencies for this UI5 Web Component, which could be:
-     *  - composed components (used in its shadow root or static area item)
+     *  - composed components (used in its shadow root)
      *  - slotted components that the component may need to communicate with
      *
+     * @deprecated no longer necessary for jsxRenderer-enabled components
      * @protected
      */
     static get dependencies(): Array<typeof UI5Element>;
+    static cacheUniqueDependencies(this: typeof UI5Element): void;
     /**
      * Returns a list of the unique dependencies for this UI5 Web Component
      *
      * @public
      */
-    static getUniqueDependencies(this: typeof UI5Element): (typeof UI5Element)[];
-    /**
-     * Returns a promise that resolves whenever all dependencies for this UI5 Web Component have resolved
-     *
-     * @returns {Promise}
-     */
-    static whenDependenciesDefined(): Promise<Array<typeof UI5Element>>;
+    static getUniqueDependencies(this: typeof UI5Element): Array<typeof UI5Element>;
     /**
      * Hook that will be called upon custom element definition
      *
      * @protected
-     * @returns {Promise<void>}
+     * @deprecated use the "i18n" decorator for fetching message bundles and the "cldr" option in the "customElements" decorator for fetching CLDR
      */
     static onDefine(): Promise<void>;
+    static fetchI18nBundles(): Promise<I18nBundle[]>;
+    static fetchCLDR(): Promise<void>;
+    static asyncFinished: boolean;
+    static definePromise: Promise<void> | undefined;
+    static i18nBundleStorage: Record<string, I18nBundle>;
+    static get i18nBundles(): Record<string, I18nBundle>;
     /**
      * Registers a UI5 Web Component in the browser window object
      * @public
-     * @returns {Promise<UI5Element>}
      */
-    static define(): Promise<typeof UI5Element>;
+    static define(): typeof UI5Element;
     /**
      * Returns an instance of UI5ElementMetadata.js representing this UI5 Web Component's full metadata (its and its parents')
      * Note: not to be confused with the "get metadata()" method, which returns an object for this class's metadata only
      * @public
-     * @returns {UI5ElementMetadata}
      */
     static getMetadata(): UI5ElementMetadata;
-    static decoratorMetadata: Metadata;
+    get validity(): ValidityState;
+    get validationMessage(): string;
+    checkValidity(): boolean;
+    reportValidity(): boolean;
 }
 /**
  * Always use duck-typing to cover all runtimes on the page.
- * @returns {boolean}
  */
 declare const instanceOfUI5Element: (object: any) => object is UI5Element;
 export default UI5Element;
-export { instanceOfUI5Element };
-export type { ChangeInfo };
+export { instanceOfUI5Element, };
+export type { ChangeInfo, InvalidationInfo, Renderer, SlottedChild, };