@sapui5/ts-types-esm 1.112.1 → 1.113.0

package/README.md

@@ -2,34 +2,15 @@
 
 # @sapui5/ts-types-esm
 
-This npm package contains the types signatures based on ES modules for all the SAPUI5 libraries.
+<span style="color: red; font-size: 150%; font-weight: bold;">The package `@sapui5/ts-types-esm` is deprecated, please use the (identical) types in `@sapui5/types` instead.</span>
 
-These signatures can be used to:
-
-1. Enable advanced content assist in IDEs, e.g: (VSCode / IntelliJ / Webstorm) for SAPUI5.
-1. Integrate type checking for SAPUI5 applications using the TypeScript compiler.
-
-These two capabilities are available both for SAPUI5 apps written in TypeScript **and** in JavaScript.
-
-<b>NOTE:</b> "based on ES modules" means that the code needs to load UI5 modules using the ES6 modules syntax and then needs to be transformed to standard UI5 require/define syntax. Nevertheless, this is the recommended approach!<br>
-See the "Usage" section below for links to detailed documentation about this setup.
-
-## Usage
-
-The central entry point for all information about using UI5 with TypeScript (incl. sample apps and templates) is at https://sap.github.io/ui5-typescript.
-
-To see the suggested project setup for TypeScript development, please check out the [TypeScript Hello World app](https://github.com/SAP-samples/ui5-typescript-helloworld). It not only can serve as copy template, but also includes a [detailed step-by-step guide](https://github.com/SAP-samples/ui5-typescript-helloworld/blob/main/step-by-step.md) for creating this setup from scratch.
-
-The [TypeScript branch of the "UI5 CAP Event App"](https://github.com/SAP-samples/ui5-cap-event-app/tree/typescript) sample demonstrates a slightly more complex application, using the same setup. It comes with an [explanation](https://github.com/SAP-samples/ui5-cap-event-app/blob/typescript/docs/typescript.md) of what UI5 TypeScript code usually looks like and what to consider when writing such code.
-
-For quick and easy scaffolding of a new UI5 app written in TypeScript, you can also use the easy-ui5 tool with the [generator-ui5-ts-app](https://github.com/ui5-community/generator-ui5-ts-app) generator.
+This npm package contains the TypeScript type definitions based on ES modules for all the SAPUI5 libraries.
 
 ## Status
 
-This project is in an experimental **_Beta State_**. Significant changes are likely to occur,
-including potential **breaking changes**.
+The type definitions are in an experimental **_[Beta State](https://sap.github.io/ui5-typescript/beta-statement.html)_**. Changes are likely to occur, including potential **breaking changes**.
 
-For information on changes in the type definitions, in particular ones which require adaptation, please refer to the [Release Notes](https://sap.github.io/ui5-typescript/releasenotes.html).
+For information on changes in the type definitions, in particular ones which require adaptation (but also new enhancements), please refer to the [Release Notes](https://sap.github.io/ui5-typescript/releasenotes.html).
 
 ## License
 This package is provided under the terms of the [SAP Developer License Agreement](https://tools.hana.ondemand.com/developer-license-3.1.txt).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sapui5/ts-types-esm",
-  "version": "1.112.1",
+  "version": "1.113.0",
   "description": "SAPUI5 TypeScript Definitions - ES Modules",
   "homepage": "https://ui5.sap.com",
   "author": "SAP SE (https://www.sap.com)",

package/types/sap.apf.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.112.0
+// For Library Version: 1.113.0
 
 declare module "sap/apf/library" {
   /**

package/types/sap.ca.ui.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.112.0
+// For Library Version: 1.113.0
 
 declare module "sap/ca/ui/library" {
   export namespace charts {
@@ -578,6 +578,8 @@ declare module "sap/ca/ui/AddPicture" {
       oListener?: object
     ): this;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Fires event {@link #event:fileNotSupported fileNotSupported} to attached listeners.
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -594,6 +596,8 @@ declare module "sap/ca/ui/AddPicture" {
       }
     ): this;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Fires event {@link #event:imageUploadFailed imageUploadFailed} to attached listeners.
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -605,6 +609,8 @@ declare module "sap/ca/ui/AddPicture" {
       mParameters?: object
     ): this;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Fires event {@link #event:maxPictureLimitReached maxPictureLimitReached} to attached listeners.
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -616,6 +622,8 @@ declare module "sap/ca/ui/AddPicture" {
       mParameters?: object
     ): this;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Fires event {@link #event:pictureAdded pictureAdded} to attached listeners.
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -627,6 +635,8 @@ declare module "sap/ca/ui/AddPicture" {
       mParameters?: object
     ): this;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Fires event {@link #event:show show} to attached listeners.
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -2426,6 +2436,8 @@ declare module "sap/ca/ui/charts/Chart" {
       oListener?: object
     ): this;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Fires event {@link #event:popoverAfterOpen popoverAfterOpen} to attached listeners.
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -2437,6 +2449,8 @@ declare module "sap/ca/ui/charts/Chart" {
       mParameters?: object
     ): this;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Fires event {@link #event:popoverBeforeOpen popoverBeforeOpen} to attached listeners.
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -2448,6 +2462,8 @@ declare module "sap/ca/ui/charts/Chart" {
       mParameters?: object
     ): this;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Fires event {@link #event:selectDataPoint selectDataPoint} to attached listeners.
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -3818,6 +3834,8 @@ declare module "sap/ca/ui/charts/ChartToolBar" {
       oListener?: object
     ): this;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Fires event {@link #event:firstDimensionKeySelected firstDimensionKeySelected} to attached listeners.
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -3829,6 +3847,8 @@ declare module "sap/ca/ui/charts/ChartToolBar" {
       mParameters?: object
     ): this;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Fires event {@link #event:personalizationPressed personalizationPressed} to attached listeners.
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -3840,6 +3860,8 @@ declare module "sap/ca/ui/charts/ChartToolBar" {
       mParameters?: object
     ): this;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Fires event {@link #event:secondDimensionKeySelected secondDimensionKeySelected} to attached listeners.
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -5227,6 +5249,7 @@ declare module "sap/ca/ui/charts/LineChart" {
     ): this;
     /**
      * @deprecated (since 1.0.0) - Do not use as it will be removed in a future release.
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
      *
      * Fires event {@link #event:onDetailsSelected onDetailsSelected} to attached listeners.
      *
@@ -6943,6 +6966,8 @@ declare module "sap/ca/ui/CustomerContext" {
       oListener?: object
     ): this;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Fires event {@link #event:customerSelected customerSelected} to attached listeners.
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -8371,6 +8396,8 @@ declare module "sap/ca/ui/FileUpload" {
       oListener?: object
     ): this;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Fires event {@link #event:beforeUploadFile beforeUploadFile} to attached listeners.
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -8383,6 +8410,7 @@ declare module "sap/ca/ui/FileUpload" {
     ): this;
     /**
      * @deprecated (since 1.21.1) - This method is deprecated now
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
      *
      * Fires event {@link #event:cancelClicked cancelClicked} to attached listeners.
      *
@@ -8395,6 +8423,8 @@ declare module "sap/ca/ui/FileUpload" {
       mParameters?: object
     ): this;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Fires event {@link #event:deleteFile deleteFile} to attached listeners.
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -8406,6 +8436,8 @@ declare module "sap/ca/ui/FileUpload" {
       mParameters?: object
     ): this;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Fires event {@link #event:fileUploadFailed fileUploadFailed} to attached listeners.
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -8417,6 +8449,8 @@ declare module "sap/ca/ui/FileUpload" {
       mParameters?: object
     ): this;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Fires event {@link #event:renameFile renameFile} to attached listeners.
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -8430,6 +8464,7 @@ declare module "sap/ca/ui/FileUpload" {
     /**
      * @deprecated (since 1.21.1) - This method is deprecated now. The rename or delete event is enough and
      * should be use to commit the action immediatly
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
      *
      * Fires event {@link #event:saveClicked saveClicked} to attached listeners.
      *
@@ -8442,6 +8477,8 @@ declare module "sap/ca/ui/FileUpload" {
       mParameters?: object
     ): this;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Fires event {@link #event:uploadFile uploadFile} to attached listeners.
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -9467,6 +9504,8 @@ declare module "sap/ca/ui/HierarchicalSelectDialog" {
       oListener?: object
     ): this;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Fires event {@link #event:cancel cancel} to attached listeners.
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -9478,6 +9517,8 @@ declare module "sap/ca/ui/HierarchicalSelectDialog" {
       mParameters?: object
     ): this;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Fires event {@link #event:select select} to attached listeners.
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -10078,6 +10119,8 @@ declare module "sap/ca/ui/HierarchyItem" {
       oListener?: object
     ): this;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Fires event {@link #event:linkPress linkPress} to attached listeners.
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -10459,6 +10502,8 @@ declare module "sap/ca/ui/InPlaceEdit" {
       oListener?: object
     ): this;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Fires event {@link #event:change change} to attached listeners.
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -11143,7 +11188,9 @@ declare module "sap/ca/ui/model/type/Date" {
      * @returns Metadata object describing this class
      */
     static getMetadata(): Metadata;
-
+    /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     */
     getOutputPattern(): void;
   }
 }
@@ -11539,6 +11586,8 @@ declare module "sap/ca/ui/Notes" {
       oListener?: object
     ): this;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Fires event {@link #event:addNote addNote} to attached listeners.
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -12024,6 +12073,8 @@ declare module "sap/ca/ui/OverviewTile" {
       oListener?: object
     ): this;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Fires event {@link #event:contactPress contactPress} to attached listeners.
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -12559,6 +12610,8 @@ declare module "sap/ca/ui/PictureItem" {
       oListener?: object
     ): this;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Fires event {@link #event:loaded loaded} to attached listeners.
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -12889,6 +12942,8 @@ declare module "sap/ca/ui/PictureTile" {
       oListener?: object
     ): this;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Fires event {@link #event:pictureDelete pictureDelete} to attached listeners.
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -13177,6 +13232,8 @@ declare module "sap/ca/ui/PictureViewer" {
       oListener?: object
     ): this;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Fires event {@link #event:pictureDeleted pictureDeleted} to attached listeners.
      *
      * @returns Reference to `this` in order to allow method chaining

package/types/sap.chart.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.112.0
+// For Library Version: 1.113.0
 
 declare module "sap/chart/library" {
   import Dimension from "sap/chart/data/Dimension";
@@ -953,6 +953,8 @@ declare module "sap/chart/Chart" {
       option?: Object
     ): string;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Fires event {@link #event:deselectData deselectData} to attached listeners.
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -964,6 +966,8 @@ declare module "sap/chart/Chart" {
       mParameters?: object
     ): this;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Fires event {@link #event:drilledDown drilledDown} to attached listeners.
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -980,6 +984,8 @@ declare module "sap/chart/Chart" {
       }
     ): this;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Fires event {@link #event:drilledUp drilledUp} to attached listeners.
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -996,6 +1002,8 @@ declare module "sap/chart/Chart" {
       }
     ): this;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Fires event {@link #event:drillStackChanged drillStackChanged} to attached listeners.
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -1007,6 +1015,8 @@ declare module "sap/chart/Chart" {
       mParameters?: object
     ): this;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Fires event {@link #event:renderComplete renderComplete} to attached listeners.
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -1018,6 +1028,8 @@ declare module "sap/chart/Chart" {
       mParameters?: object
     ): this;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Fires event {@link #event:selectData selectData} to attached listeners.
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -1029,6 +1041,8 @@ declare module "sap/chart/Chart" {
       mParameters?: object
     ): this;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Fires event {@link #event:valueAxisFixedScaleTurnedOff valueAxisFixedScaleTurnedOff} to attached listeners.
      *
      * @returns Reference to `this` in order to allow method chaining

package/types/sap.collaboration.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.112.0
+// For Library Version: 1.113.0
 
 declare module "sap/collaboration/library" {
   /**
@@ -146,10 +146,14 @@ declare module "sap/collaboration/components/feed/Component" {
     );
 
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * The method to create the Content (UI Control Tree) of the Component.
      */
     static createContent(): void;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Cleans up the component instance before destruction.
      */
     static exit(): void;
@@ -189,14 +193,20 @@ declare module "sap/collaboration/components/feed/Component" {
      */
     static getSelectedGroup(): Record<string, any>;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Initializes the Component instance after creation.
      */
     static init(): void;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Function is called when the rendering of the Component Container is completed.
      */
     static onAfterRendering(): void;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Function is called when the rendering of the Component Container is started.
      */
     static onBeforeRendering(): void;
@@ -1992,6 +2002,8 @@ declare module "sap/collaboration/components/socialprofile/Component" {
     );
 
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Cleans up the component instance before destruction. [borrowed from sap.ui.core.Component]
      */
     static exit(): void;
@@ -2025,14 +2037,20 @@ declare module "sap/collaboration/components/socialprofile/Component" {
      */
     static getMetadata(): ComponentMetadata;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Initializes the Component instance after creation. [borrowed from sap.ui.core.UIComponent]
      */
     static init(): void;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Function is called when the rendering of the Component Container is completed. [borrowed from sap.ui.core.UIComponent]
      */
     static onAfterRendering(): void;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Function is called when the rendering of the Component Container is started. [borrowed from sap.ui.core.UIComponent]
      */
     static onBeforeRendering(): void;
@@ -2250,6 +2268,8 @@ declare module "sap/collaboration/components/socialtimeline/Component" {
     );
 
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * The method to create the Content (UI Control Tree) of the Component.
      */
     static createContent(): void;
@@ -2264,6 +2284,8 @@ declare module "sap/collaboration/components/socialtimeline/Component" {
       sId: string
     ): void;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Cleans up the component instance before destruction.
      */
     static exit(): void;
@@ -2297,14 +2319,20 @@ declare module "sap/collaboration/components/socialtimeline/Component" {
      */
     static getMetadata(): ComponentMetadata;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Initializes the Component instance after creation.
      */
     static init(): void;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Function is called when the rendering of the Component Container is completed.
      */
     static onAfterRendering(): void;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Function is called when the rendering of the Component Container is started.
      */
     static onBeforeRendering(): void;
@@ -2342,6 +2370,8 @@ declare module "sap/collaboration/components/socialtimeline/Component" {
       businessObjectMap: object
     ): void;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Set property of component
      */
     static setProperty(): void;
@@ -2433,6 +2463,8 @@ declare module "sap/collaboration/components/socialtimeline/Component" {
       oListener?: object
     ): this;
     /**
+     * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+     *
      * Fires event {@link #event:customActionPress customActionPress} to attached listeners.
      *
      * @returns Reference to `this` in order to allow method chaining