@ui5/webcomponents-base 0.0.0-bf8366eb6 → 0.0.0-c143e338b

package/dist/UI5Element.d.ts

@@ -1,16 +1,12 @@
 import "@ui5/webcomponents-base/dist/ssr-dom.js";
-import UI5ElementMetadata, { Slot, SlotValue, State, PropertyValue, Metadata } from "./UI5ElementMetadata.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 type { TemplateFunction, TemplateFunctionResult } from "./renderer/executeTemplate.js";
+import type { TemplateFunction } from "./renderer/executeTemplate.js";
 import type { AccessibilityInfo, PromiseResolve, ComponentStylesData, ClassMap } from "./types.js";
-type Renderer = (templateResult: TemplateFunctionResult, container: HTMLElement | DocumentFragment, options: RendererOptions) => void;
-type RendererOptions = {
-    /**
-     * An object to use as the `this` value for event listeners. It's often
-     * useful to set this to the host component rendering a template.
-     */
-    host?: object;
-};
+import type I18nBundle from "./i18nBundle.js";
+type Renderer = (instance: UI5Element, container: HTMLElement | DocumentFragment) => void;
 type ChangeInfo = {
     type: "property" | "slot";
     name: string;
@@ -25,6 +21,23 @@ 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" | "role";
+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
@@ -33,6 +46,13 @@ type SlotChangeListener = (this: HTMLSlotElement, ev: Event) => void;
  * @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>;
@@ -47,13 +67,22 @@ declare abstract class UI5Element extends HTMLElement {
         _deferredResolve?: PromiseResolve;
     };
     _doNotSyncAttributes: Set<string>;
+    __shouldHydrate: boolean;
     _state: State;
-    _internals?: ElementInternals;
+    _internals: ElementInternals;
+    _individualSlot?: string;
     _getRealDomRef?: () => HTMLElement;
     static template?: TemplateFunction;
     static _metadata: UI5ElementMetadata;
     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
      *
@@ -147,14 +176,6 @@ declare abstract class UI5Element extends HTMLElement {
      * @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
      *
@@ -179,6 +200,7 @@ declare abstract class UI5Element extends HTMLElement {
     _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
@@ -212,6 +234,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
@@ -225,7 +248,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
@@ -261,9 +284,23 @@ declare abstract class UI5Element extends HTMLElement {
      * @param cancelable - true, if the user can call preventDefault on the event object
      * @param bubbles - true, if the event bubbles
      * @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.
@@ -298,17 +335,24 @@ declare abstract class UI5Element extends HTMLElement {
      * @default true
      */
     get isUI5Element(): boolean;
+    get isUI5AbstractElement(): boolean;
     get classes(): ClassMap;
     /**
      * Returns the component accessibility info.
      * @private
      */
-    get accessibilityInfo(): AccessibilityInfo;
+    get accessibilityInfo(): AccessibilityInfo | undefined;
     /**
      * Do not override this method in derivatives of UI5Element, use metadata properties instead
      * @private
      */
     static get observedAttributes(): string[];
+    /**
+     * Returns all tags, used inside component's template subject to scoping.
+     * returns {Array[]} // TODO add @
+     * @private
+     */
+    static get tagsToScope(): Array<string>;
     /**
      * @private
      */
@@ -329,43 +373,48 @@ declare abstract class UI5Element extends HTMLElement {
     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): Array<typeof UI5Element>;
-    /**
-     * Returns a promise that resolves whenever all dependencies for this UI5 Web Component have resolved
-     */
-    static whenDependenciesDefined(): Promise<Array<typeof UI5Element>>;
     /**
      * Hook that will be called upon custom element definition
      *
      * @protected
+     * @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
      */
-    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
      */
     static getMetadata(): UI5ElementMetadata;
-    get validity(): ValidityState | undefined;
-    get validationMessage(): string | undefined;
-    checkValidity(): boolean | undefined;
-    reportValidity(): boolean | undefined;
+    get validity(): ValidityState;
+    get validationMessage(): string;
+    checkValidity(): boolean;
+    reportValidity(): boolean;
 }
 /**
  * Always use duck-typing to cover all runtimes on the page.
@@ -373,4 +422,4 @@ declare abstract class UI5Element extends HTMLElement {
 declare const instanceOfUI5Element: (object: any) => object is UI5Element;
 export default UI5Element;
 export { instanceOfUI5Element, };
-export type { ChangeInfo, Renderer, RendererOptions, };
+export type { ChangeInfo, InvalidationInfo, Renderer, SlottedChild, };