@sapui5/types 1.144.0 → 1.145.0

package/types/sap.fe.base.d.ts

@@ -1,28 +1,349 @@
-// For Library Version: 1.144.0
+// This is autogenerated, do not edit
+
+declare module "sap/fe/base/library" {
+	// Public Exports
+	/**
+	 * Library providing the base functionality of the runtime for SAP Fiori elements for OData V4.
+	 * @namespace
+	 * @public
+	 */
+	export const feBaseNamespace = "sap.fe.base";
+}
+
+declare module "sap/fe/base/ClassSupport" {
+	import type { $ControlSettings } from "sap/ui/core/Control";
+	import type ControllerExtension from "sap/ui/core/mvc/ControllerExtension";
+	import type OverrideExecution from "sap/ui/core/mvc/OverrideExecution";
+
+	type OverrideDefinition = Record<string, Function>;
+	type UI5ControllerMethodDefinition = {
+		overrideExecution?: OverrideExecution;
+		public?: boolean;
+		final?: boolean;
+	};
+
+	export type UI5ControlMetadataDefinition = {
+		defaultAggregation?: string;
+		controllerExtensions: Record<string, typeof ControllerExtension | Function>;
+		properties: Record<string, UI5PropertyMetadata>;
+		aggregations: Record<string, UI5AggregationMetadata>;
+		references: Record<string, boolean>;
+		associations: Record<string, UI5AssociationMetadata>;
+		methods: Record<string, UI5ControllerMethodDefinition>;
+		events: Record<string, {}>;
+		interfaces: string[];
+		library?: string;
+		designtime?: string;
+		config?: {
+			fullWidth?: boolean;
+		};
+		stateProperty?: string;
+		statePropertyDefaultValue?: unknown;
+		manifest?: string | unknown;
+		returnTypes?: string[];
+		buildingBlockMetadata?: unknown;
+	};
+
+	type ExtendWithObject<T, K> = T extends object ? K & { [TKey in keyof T]?: BindingInfoHolder<T[TKey]> } : K;
+
+	export type BindingInfoHolder<T> = T & {
+		__bindingInfo: {
+			path: string;
+			model: string;
+			type: T;
+		};
+	};
+
+	export type ControlPropertyNames<T> = {
+		// needed because of the TS compiler
+		// eslint-disable-next-line @typescript-eslint/no-explicit-any
+		[K in keyof T]: T[K] extends Function ? never : K;
+	}[keyof T];
+	// Public Type Definitions
+	/**
+	 * Definition of a UI5 property metadata.
+	 * @public
+	 * @ui5-experimental-since 1.145.0
+	 */
+	export type UI5PropertyMetadata = {
+		type: string;
+		bindable?: boolean;
+		required?: boolean;
+		group?: string;
+		defaultValue?: unknown;
+		byValue?: boolean;
+		isBindingInfo?: boolean;
+		bindToState?: boolean;
+		expectedAnnotations?: string[];
+		expectedTypes?: string[];
+		allowedValues?: string[];
+		visibility?: string;
+	};
+	/**
+	 * Definition of a UI5 aggregation metadata.
+	 * @public
+	 * @ui5-experimental-since 1.145.0
+	 */
+	export type UI5AggregationMetadata = {
+		type: string;
+		altTypes?: string[];
+		multiple?: boolean;
+		isDefault?: boolean;
+		defaultValue?: unknown;
+		defaultClass?: unknown;
+		singularName?: string;
+		visibility?: string;
+		forwarding?: object;
+	};
+	/**
+	 * Definition of a UI5 association metadata.
+	 * @public
+	 * @ui5-experimental-since 1.145.0
+	 */
+	export type UI5AssociationMetadata = {
+		type: string;
+		multiple?: boolean;
+		singularName?: string;
+	};
+	/**
+	 * Returns the properties of a control.
+	 * @public
+	 * @ui5-experimental-since 1.145.0
+	 */
+	export type PropertiesOf<T, K extends keyof T | undefined = undefined> = Partial<Pick<T, ControlPropertyNames<T>>> &
+		(K extends keyof T ? Partial<Pick<T, K>> : {}) &
+		$ControlSettings;
+	/**
+	 * Represents the state object of a building block.
+	 * @public
+	 * @ui5-experimental-since 1.145.0
+	 */
+	export type StateOf<T> = {
+		[K in keyof T]: T[K] extends Array<infer U> | ReadonlyArray<infer U> ? ExtendWithObject<U, ReadonlyArray<U>> : T[K];
+	};
+
+	// Public Exports
+	/**
+	 * Collection of decorators to support the creation of UI5 classes.
+	 * @namespace
+	 * @public
+	 */
+	export const classSupportNamespace = "sap.fe.base.ClassSupport";
+
+	/**
+	 * Allows to define a property that will hold the control state.
+	 *
+	 * Properties defined with this decorator will be automatically bound to the control state when used in JSX.
+	 * Arrays need to be bound using the `bindState` function.
+	 * @public
+	 * @ui5-experimental-since 1.145.0
+	 * @returns A property decorator
+	 */
+	export function defineState(): PropertyDecorator;
+
+	/* #endregion */
+
+	/* #region CONTROL */
+	/**
+	 * Indicates that the property shall be declared as an event on the control metadata.
+	 * @returns The decorated property
+	 * @public
+	 * @ui5-experimental-since 1.145.0
+	 */
+	export function event(): PropertyDecorator;
+
+	/**
+	 * Defines the following property as a managed object in the control metadata.
+	 * @param attributeDefinition The property definition
+	 * @returns The decorated property.
+	 * @public
+	 * @ui5-experimental-since 1.145.0
+	 */
+	export function property(attributeDefinition: UI5PropertyMetadata): PropertyDecorator;
+
+	/**
+	 * Defines and configures the following aggregation in the control metadata.
+	 * @param aggregationDefinition The aggregation definition
+	 * @returns The decorated property.
+	 * @public
+	 * @ui5-experimental-since 1.145.0
+	 */
+	export function aggregation(aggregationDefinition: UI5AggregationMetadata): PropertyDecorator;
+
+	/**
+	 * Defines and configures the following association in the control metadata.
+	 * @param ui5AssociationMetadata The definition of the association.
+	 * @returns The decorated property
+	 * @public
+	 * @ui5-experimental-since 1.145.0
+	 */
+	export function association(ui5AssociationMetadata: UI5AssociationMetadata): PropertyDecorator;
+
+	/**
+	 * Defines in the metadata that this control implements a specific interface.
+	 * @param interfaceName The name of the implemented interface
+	 * @returns The decorated method
+	 * @public
+	 * @ui5-experimental-since 1.144.0
+	 */
+	export function implementInterface(interfaceName: string): PropertyDecorator;
+
+	/**
+	 * Indicates that the following class should define a UI5 control of the specified name.
+	 * @param target The fully qualified name of the UI5 class
+	 * @param metadataDefinition Additional inline metadata definition
+	 * @returns A class decorator that will create a ui5 class out of the TS class
+	 * @public
+	 * @ui5-experimental-since 1.145.0
+	 */
+	export function defineUI5Class(target: string, metadataDefinition?: Partial<UI5ControlMetadataDefinition>): ClassDecorator;
+}
 
 declare module "sap/fe/base/BuildingBlockBase" {
-  import { default as Control, $ControlSettings } from "sap/ui/core/Control";
-
-  /**
-   * Base class for building blocks.
-   * This contains the low level functionality of having a content aggregation and handling the rendering
-   * of the content without an actual DOM element.
-   * The building block also defines a state object that can be used to store the state of the building block.
-   * Accessibility and classes information are forwarded to the content control.
-   */
-  export default class BuildingBlockBase extends Control {}
-  /**
-   * Describes the settings that can be provided to the BuildingBlockBase constructor.
-   */
-  export interface $BuildingBlockBaseSettings extends $ControlSettings {}
+	import type { BindingToolkitExpression, PrimitiveType } from "sap/fe/base/BindingToolkit";
+	import type { StateOf } from "sap/fe/base/ClassSupport";
+	import type { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
+	import type Control from "sap/ui/core/Control";
+	import { $ControlSettings } from "sap/ui/core/Control";
+	import type UI5Element from "sap/ui/core/Element";
+	import type { AccessibilityInfo } from "sap/ui/core/library";
+	import type RenderManager from "sap/ui/core/RenderManager";
+	import type Context from "sap/ui/model/Context";
+
+	/**
+	 * Describes the settings that can be provided to the BuildingBlockBase constructor.
+	 */
+	export interface $BuildingBlockBaseSettings<K = {}> extends $ControlSettings {
+		/**
+		 * The current state value of the component.
+		 * This property holds the state data managed by the component, with the type
+		 * determined by the generic parameter K.
+		 */
+		state?: StateOf<K> | PropertyBindingInfo | `{${string}}`;
+
+		/**
+		 * Optional content of generic type T.
+		 * This property holds the main data or payload for the containing object.
+		 * When undefined, it indicates that no content has been set or is available.
+		 * The specific type and structure of the content depends on the generic type parameter T.
+		 */
+		content?: UI5Element;
+
+		/**
+		 * Association to controls / IDs that label this control (see WAI-ARIA attribute aria-labelledby).
+		 */
+		ariaLabelledBy?: Control | string;
+	}
+
+	// Public Classes
+	/**
+	 * Base class for building blocks.
+	 * This contains the low-level functionality of having a content aggregation and handling the rendering of the content without an actual DOM element.<br/>
+	 * The building block also defines a state object that can be used to store the state of the building block.<br/>
+	 * Accessibility and classes information are forwarded to the content control.<br/>
+	 * This class is not meant to be used directly, it's there for internal use only (and documentation)
+	 * @public
+	 */
+	class BuildingBlockBase<T extends UI5Element = Control, K extends object = {}> extends Control {
+		/**
+		 * Optional content of generic type T.
+		 *
+		 * This property holds the main data or payload for the containing object.
+		 * When undefined, it indicates that no content has been set or is available.
+		 * The specific type and structure of the content depends on the generic type parameter T.
+		 * @public
+		 */
+		content?: T;
+
+		getContent(): T;
+
+		setContent(content: T): this;
+
+		destroyContent(): this;
+
+		/**
+		 * Association to controls / IDs that label this control (see WAI-ARIA attribute aria-labelledby).
+		 * @public
+		 */
+		ariaLabelledBy: string[];
+
+		getAriaLabelledBy(): string[];
+
+		setAriaLabelledBy(ariaLabelledBy: string[]): this;
+
+		/**
+		 * The current state value of the component.
+		 *
+		 * This property holds the state data managed by the component, with the type
+		 * determined by the generic parameter K.
+		 * @public
+		 */
+		state: StateOf<K>;
+
+		/**
+		 * Shorthand for the BindingToolkit.bindState function with the current state object.
+		 * @param path A property in the state object
+		 * @returns The binding toolkit expression for the state
+		 * @public
+		 * @ui5-experimental-since 1.145.0
+		 */
+		public bindState<ST extends PrimitiveType>(path: keyof K): BindingToolkitExpression<ST>;
+
+		/**
+		 * Synchronizes a state property with another building block's state property.
+		 * @param propName Name of the property in the current state object
+		 * @param source The source building block
+		 * @param property The property in the source building block's state object
+		 */
+		public syncStateProperty(propName: string, source: BuildingBlockBase, property: string): void;
+
+		onStateChange(_changedProps: string[]): void;
+	}
+
+	export default BuildingBlockBase;
 }
 
-declare module "sap/fe/base/library" {}
+declare module "sap/fe/base/BindingToolkit" {
+	// Public Exports
+	/**
+	 * Collection of functions to support the manipulation of ui5 bindings
+	 * @public
+	 * @namespace
+	 * @ui5-experimental-since 1.145.0
+	 */
+	export const bindingToolkitNamespace = "sap.fe.base.BindingToolkit";
+}
 
-declare namespace sap {
-  interface IUI5DefineDependencyNames {
-    "sap/fe/base/BuildingBlockBase": undefined;
+declare namespace JSX {
+	export type CommandProperties = `cmd:${string}|${string}`;
+	export type Ref<T> = {
+		current?: T;
+		setCurrent(oControlInstance: T): void;
+	};
+	interface IntrinsicElements {
+		div: { id?: string; class?: string; ref?: Ref<never>; tabindex?: number; role?: string };
+		span: { id?: string; class?: string; ref?: Ref<never>; role?: string };
+		slot: { name: string };
+	}
+	interface IntrinsicClassAttributes<T> {
+		id?: string;
+		class?: string;
+		binding?: string | Record<string, string>;
+		["xmlns:fl"]?: string;
+		["core:require"]?: string;
+		["log:sourcePath"]?: string;
+		["customData:entityType"]?: string;
+		["fl:delegate"]?: string | { name: string; delegateType: string };
+		["dt:designtime"]?: string | { name: string; delegateType: string };
+		["fl:flexibility"]?: string;
+		ref?: Ref<T>;
+		["jsx:command"]?: CommandProperties;
+	}
+}
 
-    "sap/fe/base/library": undefined;
-  }
+declare module "sap/fe/base/BindingToolkit" {
+	export type PathInModelExpression<K> = never;
+	export type ConstantExpression<K> = never;
+	export type BindingToolkitExpression<K> = never;
+	export type PrimitiveType = string | number | bigint | boolean | object | null | undefined;
 }

package/types/sap.fe.controls.d.ts

@@ -1,3 +1,3 @@
-// For Library Version: 1.144.0
+// For Library Version: 1.145.0
 
 declare namespace sap {}

package/types/sap.fe.core.d.ts

@@ -418,7 +418,7 @@ declare module "sap/fe/core/controllerextensions/BaseControllerExtension" {
 	}
 }
 
-// For Library Version: 1.144.0
+// For Library Version: 1.145.0
 
 declare module "sap/fe/core/AppComponent" {
   import {
@@ -800,6 +800,167 @@ declare module "sap/fe/core/PageController" {
   }
 }
 
+declare module "sap/fe/core/ReuseComponent" {
+  import {
+    default as Component,
+    $ComponentSettings,
+  } from "sap/fe/core/fpm/Component";
+
+  import Event from "sap/ui/base/Event";
+
+  import ExtensionAPI from "sap/fe/core/ExtensionAPI";
+
+  /**
+   * Base component for reuse compontents in SAP Fiori elements.
+   * By extending from this component you get access to the extension API of the page component
+   * and get native support for SAP Fiori elements building blocks.
+   *
+   *
+   * @since 1.145.0
+   */
+  export default class ReuseComponent extends Component {
+    /**
+     *
+     * @returns Reference to sap.fe.core.ReuseComponent
+     * to allow method chaining
+     */
+    attachInitialized(
+      /**
+       * An application-specific payload object that will be passed to the event handler along with the event
+       * object when firing the event
+       */
+      oData: object,
+      /**
+       * The function to be called when the event occurs
+       */
+      fnFunction: (p1: Event) => void,
+      /**
+       * The context object to call the event handler with. Defaults to this `this` control
+       */
+      oListener?: object
+    ): this;
+    /**
+     *
+     * @returns Reference to sap.fe.core.ReuseComponent
+     * to allow method chaining
+     */
+    attachInitialized(
+      /**
+       * The function to be called when the event occurs
+       */
+      fnFunction: (p1: Event) => void,
+      /**
+       * The context object to call the event handler with. Defaults to this `this` control
+       */
+      oListener?: object
+    ): this;
+    /**
+     *
+     * @returns Reference to sap.fe.core.ReuseComponent
+     * to allow method chaining
+     */
+    detachInitialized(
+      /**
+       * The function to be called when the event occurs
+       */
+      fnFunction: (p1: Event) => void,
+      /**
+       * The context object to call the event handler with. Defaults to this `this` control
+       */
+      oListener?: object
+    ): this;
+    /**
+     * Fires event initialized
+     * to attached listeners.
+     *
+     * @ui5-protected Do not call from applications (only from related classes in the framework)
+     *
+     * @returns Reference to sap.fe.core.ReuseComponent
+     * to allow method chaining
+     */
+    fireInitialized(
+      /**
+       * The parameters to pass along with the event.
+       * See {@link Function} for the set of parameters that are expected by the event handlers.
+       */
+      mParameters?: {}
+    ): this;
+    /**
+     * Returns the extension API of the page component that owns the reuse component.
+     *
+     *
+     * @returns The extension API
+     */
+    getExtensionAPI(): ExtensionAPI;
+  }
+  /**
+   * Describes the settings that can be provided to the ReuseComponent constructor.
+   */
+  export interface $ReuseComponentSettings extends $ComponentSettings {
+    /**
+     * Event that is fired once the component is initialized
+     */
+    initialized?: (oEvent: Event) => void;
+  }
+
+  /**
+   * Parameters of the ReuseComponent#initialized event.
+   */
+  export interface ReuseComponent$InitializedEventParameters {}
+
+  /**
+   * Event object of the ReuseComponent#initialized event.
+   */
+  export type ReuseComponent$InitializedEvent = Event<
+    ReuseComponent$InitializedEventParameters,
+    ReuseComponent
+  >;
+}
+
+declare module "sap/fe/core/TemplateComponent" {
+  import {
+    default as UIComponent,
+    $UIComponentSettings,
+  } from "sap/ui/core/UIComponent";
+
+  import { IAsyncContentCreation } from "sap/ui/core/library";
+
+  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
+
+  /**
+   * Base component for SAP Fiori elements floorplans.
+   * This component provides as foundation for all SAP Fiori elements page types, and shall not be used directly.
+   *
+   *
+   * @since 1.145.0
+   */
+  export default class TemplateComponent
+    extends UIComponent
+    implements
+      IAsyncContentCreation,
+      /* was: sap.fe.core.buildingBlocks.IBuildingBlockOwnerComponent.IBuildingBlockOwnerComponent */ Object
+  {
+    __implements__sap_ui_core_IAsyncContentCreation: boolean;
+    __implements__sap_fe_core_buildingBlocks_IBuildingBlockOwnerComponent_IBuildingBlockOwnerComponent: boolean;
+  }
+  /**
+   * Describes the settings that can be provided to the TemplateComponent constructor.
+   */
+  export interface $TemplateComponentSettings extends $UIComponentSettings {
+    /**
+     * Defines the path of the context used in the current page.
+     */
+    contextPath?: string | PropertyBindingInfo;
+
+    /**
+     * Enhance the i18n bundle used for this page with one or more app specific i18n resource bundles or resource
+     * models
+     * or a combination of both. The last resource bundle or model is given the highest priority.
+     */
+    enhanceI18n?: string[] | PropertyBindingInfo | `{${string}}`;
+  }
+}
+
 declare module "sap/fe/core/buildingBlocks/BuildingBlock" {
   import {
     default as BuildingBlockBase,
@@ -1148,6 +1309,10 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
          * provided
          */
         contexts?: Context | Context[];
+        /**
+         * Disables strict handling of action calls to turn off 412 confirmation popups
+         */
+        disableStrictHandling?: boolean;
         /**
          * Mode how actions are to be called: 'ChangeSet' to put all action calls into one changeset, 'Isolated'
          * to put them into separate changesets
@@ -2156,8 +2321,15 @@ declare module "sap/fe/core/converters/ManifestSettings" {
 }
 
 declare module "sap/fe/core/fpm/Component" {
+  import {
+    default as TemplateComponent,
+    $TemplateComponentSettings,
+  } from "sap/fe/core/TemplateComponent";
+
   import AppComponent from "sap/fe/core/AppComponent";
 
+  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
+
   /**
    * Component that can be used as a wrapper component for custom pages.
    * The component can be used in case you want to use SAP Fiori elements Building Blocks or XML template
@@ -2185,9 +2357,7 @@ declare module "sap/fe/core/fpm/Component" {
    *
    * @since 1.92.0
    */
-  export default class Component
-    extends /* was: sap.fe.core.TemplateComponent */ Object
-  {
+  export default class Component extends TemplateComponent {
     /**
      * Returns the current AppComponent.
      *
@@ -2196,6 +2366,16 @@ declare module "sap/fe/core/fpm/Component" {
      */
     getAppComponent(): AppComponent;
   }
+  /**
+   * Describes the settings that can be provided to the Component constructor.
+   */
+  export interface $ComponentSettings extends $TemplateComponentSettings {
+    /**
+     * Name of the XML view which is used for this page. The XML view can contain SAP Fiori elements Building
+     * Blocks and XML template constructions.
+     */
+    viewName?: string | PropertyBindingInfo;
+  }
 }
 
 declare module "sap/fe/core/rootView/Fcl.controller" {
@@ -2266,8 +2446,12 @@ declare namespace sap {
 
     "sap/fe/core/PageController": undefined;
 
+    "sap/fe/core/ReuseComponent": undefined;
+
     "sap/fe/core/rootView/Fcl.controller": undefined;
 
     "sap/fe/core/rootView/NavContainer.controller": undefined;
+
+    "sap/fe/core/TemplateComponent": undefined;
   }
 }

package/types/sap.fe.ina.d.ts

@@ -1,3 +1,3 @@
-// For Library Version: 1.144.0
+// For Library Version: 1.145.0
 
 declare namespace sap {}