@sapui5/types 1.115.1 → 1.117.0

package/README.md

@@ -18,18 +18,20 @@ These capabilities are available not only for SAPUI5 apps written in TypeScript,
 
 The central entry point for all information about using UI5 with TypeScript (incl. sample apps and templates) is https://sap.github.io/ui5-typescript.
 
+The [UI5 TypeScript tutorial](https://github.com/SAP-samples/ui5-typescript-tutorial) gives the best end-to-end impression of UI5 application and control development in TypeScript. The above and below links lead to further details about certain aspects.
+
 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 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.
+For quick and easy scaffolding of a new UI5 app written in TypeScript, you can use the easy-ui5 tool with the [generator-ui5-ts-app](https://github.com/ui5-community/generator-ui5-ts-app) generator.
 
 
 ## Status
 
-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**.
+We encourage you to use SAPUI5 with TypeScript productively for an improved development efficiency and experience. TypeScript itself keeps evolving and we try to further improve the UI5 type definitions, so there could be potential incompatible changes between versions of the type definitions. However, such incompatibilities would only affect the compilation of your code but will not cause runtime issues in your application. Plus, there are various ways to easily deal with them: you can, for example, simply keep using the previous version of the UI5 type definitions together with an updated UI5 runtime.
 
-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).
+For news related to the type definitions, in particular ones which require adaptation, 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/types",
-  "version": "1.115.1",
+  "version": "1.117.0",
   "description": "SAPUI5 TypeScript Definitions",
   "homepage": "https://sap.github.io/ui5-typescript/",
   "author": "SAP SE (https://www.sap.com)",

package/types/index.d.ts

@@ -1,7 +1,13 @@
 /**
- * This is a Beta version of the SAPUI5 TypeScript signatures.
- * Significant changes may occur in future versions,
- * including potential breaking changes.
+ * We encourage you to use SAPUI5 with TypeScript productively for an
+ * improved development efficiency and experience. TypeScript itself keeps
+ * evolving and we try to further improve the UI5 type definitions, so there
+ * could be potential incompatible changes between versions of the type
+ * definitions. However, such incompatibilities would only affect the
+ * compilation of your code but will not cause runtime issues in your
+ * application. Plus, there are various ways to easily deal with them:
+ * you can, for example, simply keep using the previous version of the
+ * UI5 type definitions together with an updated UI5 runtime.
  */
 /// <reference path="./sap.apf.d.ts"/>
 /// <reference path="./sap.chart.d.ts"/>
@@ -38,6 +44,7 @@
 /// <reference path="./sap.fe.macros.d.ts"/>
 /// <reference path="./sap.fe.navigation.d.ts"/>
 /// <reference path="./sap.fe.placeholder.d.ts"/>
+/// <reference path="./sap.fe.plugins.optimisticBatch.d.ts"/>
 /// <reference path="./sap.fe.templates.d.ts"/>
 /// <reference path="./sap.fe.test.d.ts"/>
 /// <reference path="./sap.fe.tools.d.ts"/>

package/types/sap.apf.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.115.0
+// For Library Version: 1.117.0
 
 declare module "sap/apf/library" {
   /**
@@ -10,6 +10,8 @@ declare module "sap/apf/library" {
 }
 
 declare module "sap/apf/api" {
+  import Manifest from "sap/ui/core/Manifest";
+
   import MessageObject from "sap/apf/core/messageObject";
 
   import ReadRequest from "sap/apf/core/readRequest";
@@ -29,7 +31,7 @@ declare module "sap/apf/api" {
    * on API-level, such as e.g. {@link sap.apf.Api#createMessageObject} for {@link sap.apf.core.MessageObject }
    * or {@link sap.apf.Api#createFilter} for {@link sap.apf.utils.Filter}.
    */
-  class Api {
+  export default class Api {
     constructor(
       /**
        * A reference to the calling Component.js. The reference provides access to parameters and context.
@@ -44,7 +46,7 @@ declare module "sap/apf/api" {
       /**
        * manifests of the component and the base component itself
        */
-      manifests?: Object
+      manifests?: Object | Manifest
     );
     /**
      * Contains 'api'
@@ -52,7 +54,7 @@ declare module "sap/apf/api" {
     type: undefined;
 
     /**
-     * @EXPERIMENTAL - NOT FOR PRODUCTION USE
+     * @experimental - NOT FOR PRODUCTION USE
      *
      * The handling of the window.onerror by the message handler is either switched on or off. Per default the
      * handling is deactivated.
@@ -67,7 +69,7 @@ declare module "sap/apf/api" {
     ): undefined;
     /**
      * @deprecated (since 1.23.1) - Remains in api in order to maintain downward compatibility to 3 Wave 5 apps.
-     * @EXPERIMENTAL - NOT FOR PRODUCTION USE
+     * @experimental - NOT FOR PRODUCTION USE
      *
      * Adds an element to the footer area.
      */
@@ -156,9 +158,9 @@ declare module "sap/apf/api" {
      */
     getTextHtmlEncoded(
       /**
-       * || {string} Label object or text key
+       * object or text key
        */
-      oLabel: object,
+      oLabel: object | string,
       /**
        * Array with parameters to replace place holders in text.
        */
@@ -169,9 +171,9 @@ declare module "sap/apf/api" {
      */
     getTextNotHtmlEncoded(
       /**
-       * || {string} Label object or text key
+       * Label object or text key
        */
-      oLabel: object,
+      oLabel: object | string,
       /**
        * Array with parameters to replace place holders in text.
        */
@@ -179,7 +181,7 @@ declare module "sap/apf/api" {
     ): string;
     /**
      * @deprecated (since 1.23.1)
-     * @EXPERIMENTAL - NOT FOR PRODUCTION USE
+     * @experimental - NOT FOR PRODUCTION USE
      *
      * Loads a new application configuration in JSON format. When called many times, the file is loaded only
      * the first time.
@@ -204,7 +206,7 @@ declare module "sap/apf/api" {
       oMessage: MessageObject
     ): undefined;
     /**
-     * @EXPERIMENTAL - NOT FOR PRODUCTION USE
+     * @experimental - NOT FOR PRODUCTION USE
      *
      * Calls the sap.apf.core.instance#updatePath (also see {@link sap.apf.core.Path#update}) with proper callback
      * for UI. It also refreshes the steps either from the active step or all the steps depending on the boolean
@@ -232,7 +234,7 @@ declare module "sap/apf/api" {
       fnCallback: Function
     ): void;
     /**
-     * @EXPERIMENTAL - NOT FOR PRODUCTION USE
+     * @experimental - NOT FOR PRODUCTION USE
      *
      * Register the function callback to be executed on the given event type. fnCallback will be executed under
      * a context and will be passed with arguments depending on the event type.
@@ -273,7 +275,6 @@ declare module "sap/apf/api" {
       filter: sap.apf.utils.Filter
     ): void;
   }
-  export default Api;
 }
 
 declare module "sap/apf/core/messageObject" {
@@ -281,13 +282,13 @@ declare module "sap/apf/core/messageObject" {
    * The message object represents the APF specific message object for detailed evaluation. The message object
    * shall be created by method {@link sap.apf.Api#createMessageObject}.
    */
-  class MessageObject {
+  export default class MessageObject {
     constructor(oConfig: object);
 
     /**
      * Returns the calling object
      */
-    getCallingObject(): object;
+    getCallingObject(): object | string;
     /**
      * Returns the message code.
      */
@@ -370,15 +371,16 @@ declare module "sap/apf/core/messageObject" {
       severity: string
     ): undefined;
   }
-  export default MessageObject;
 }
 
 declare module "sap/apf/core/readRequest" {
+  import MessageObject from "sap/apf/core/messageObject";
+
   /**
    * Facade for sap.apf.core.Request for getting data via the OData protocol. This corresponds to a normal
    * HTTP GET method. Creation is done via APF API.
    */
-  class ReadRequest {
+  export default class ReadRequest {
     constructor(
       /**
        * Injection object.
@@ -387,7 +389,7 @@ declare module "sap/apf/core/readRequest" {
       /**
        * The object represents an OData GET request.
        */
-      oRequest: object,
+      oRequest: object | string,
       /**
        * Service defined by the analytical content configuration.
        */
@@ -419,15 +421,18 @@ declare module "sap/apf/core/readRequest" {
        * The first argument of the callback function is the received data (as Array). The second argument is {sap.apf.core.EntityTypeMetadata}.
        * The third argument is {sap.apf.core.MessageObject}.
        */
-      fnCallback: Function,
+      fnCallback: (
+        p1: any[],
+        p2: /* was: sap.apf.core.EntityTypeMetadata */ any,
+        p3: MessageObject
+      ) => void,
       /**
        * An optional object containing additional query string options Format: { orderby : [{ property : ,
        * order : }], top : , skip :  }
        */
-      oRequestOptions: Object
+      oRequestOptions: object | string
     ): undefined;
   }
-  export default ReadRequest;
 }
 
 declare module "sap/apf/ui/representations/representationInterface" {
@@ -436,12 +441,12 @@ declare module "sap/apf/ui/representations/representationInterface" {
   import ODataModel from "sap/ui/model/odata/v2/ODataModel";
 
   /**
-   * @EXPERIMENTAL - The complete interface is subject to ongoing work and not yet stable (as of Version 1.24.0).
+   * @experimental - The complete interface is subject to ongoing work and not yet stable (as of Version 1.24.0).
    *
    * This is not a runtime class, but it describes the interface that a representation (chart) has to implement
    * for to interact with the APF.
    */
-  class representationInterface {
+  export default class representationInterface {
     constructor(
       /**
        * specific interface proxy for communication between the representation and APF.
@@ -470,19 +475,19 @@ declare module "sap/apf/ui/representations/representationInterface" {
       /**
        * Source representation implementing the representationInterface.
        */
-      oSourceRepresentation: object
+      oSourceRepresentation: object | string
     ): void;
     /**
      * This method uses the serialization information from serialized data and sets the selection to representation
      * based on mode and selection string returned.
      */
-    deserialize(oSerializationInformation: object): void;
+    deserialize(oSerializationInformation: object | string): void;
     /**
      * Returns the alternate representation of current step (i.e. list representation for the charts)
      *
      * @returns oAlternateRepresentation
      */
-    getAlternateRepresentation(): object;
+    getAlternateRepresentation(): object | string;
     /**
      * Returns data for representation type
      *
@@ -502,7 +507,7 @@ declare module "sap/apf/ui/representations/representationInterface" {
      * @returns oUiObject The UI object that has to be shown in main representation area. Example: Line chart
      * instance for a line chart representation.
      */
-    getMainContent(): object;
+    getMainContent(): object | string;
     /**
      * Returns meta data for representation type
      *
@@ -514,14 +519,14 @@ declare module "sap/apf/ui/representations/representationInterface" {
      *
      * @returns oParameters
      */
-    getParameter(): object;
+    getParameter(): object | string;
     /**
      * This method holds the logic to draw the content to be printed.
      *
      * @returns oUiObject The UI object that has to be printed. Example: Line chart instance for a line chart
      * representation.
      */
-    getPrintContent(): object;
+    getPrintContent(): object | string;
     /**
      * Additionally to parameters being set in the request configuration and filter values that are derived
      * from the path logic, a request can be enriched with additional options such as **$top**, **$skip** and
@@ -578,7 +583,7 @@ declare module "sap/apf/ui/representations/representationInterface" {
      * @returns oUiObject The UI object that has to be shown in thumbnail area. Example: Line chart instance
      * for a line chart representation.
      */
-    getThumbnailContent(): object;
+    getThumbnailContent(): object | string;
     /**
      * This method holds the logic to draw the content to be shown as tooltip for a thumbnail. It will be shown
      * inside a tooltip Popup when the thumbnail content overflows the thumbnail container area with a gradient
@@ -587,7 +592,7 @@ declare module "sap/apf/ui/representations/representationInterface" {
      * @returns oUiObject The UI object that has to be shown as tooltip for a thumbnail. Example: Detailed content
      * of a form representation.
      */
-    getTooltipContent(): object;
+    getTooltipContent(): object | string;
     /**
      * This method holds the logic to remove all selection from the chart. It also updates the step.
      */
@@ -598,7 +603,7 @@ declare module "sap/apf/ui/representations/representationInterface" {
      *
      * @returns oSerializationInformation
      */
-    serialize(): object;
+    serialize(): object | string;
     /**
      * The binding sets the data (received from the request) that has to be visualized. The array aDataResponse
      * is shared between all representations of a step and the binding. When lines are moved, deleted or changed,
@@ -623,7 +628,7 @@ declare module "sap/apf/ui/representations/representationInterface" {
       /**
        * Contains filters and parameters for treetable request handling
        */
-      controlObject: object,
+      controlObject: object | string,
       /**
        * OData model for the service of treetable
        */
@@ -638,18 +643,17 @@ declare module "sap/apf/ui/representations/representationInterface" {
       entityTypeMetadata: /* was: sap.apf.core.EntityTypeMetadata */ any
     ): void;
   }
-  export default representationInterface;
 }
 
 declare module "sap/apf/ui/representations/RepresentationInterfaceProxy" {
   /**
-   * @EXPERIMENTAL - The complete interface is subject to ongoing work and not yet stable (as of Version 1.24.0).
+   * @experimental - The complete interface is subject to ongoing work and not yet stable (as of Version 1.24.0).
    *
    * The interface proxy passed to a representation which provides access to required APF methods. This constructor
    * is used by apf.api. It can be also used to build unit tests that need an interface proxy between APF
    * and representations.
    */
-  class RepresentationInterfaceProxy {
+  export default class RepresentationInterfaceProxy {
     constructor(
       oCoreApi: /* was: sap.apf.core.Instance */ any,
 
@@ -681,7 +685,6 @@ declare module "sap/apf/ui/representations/RepresentationInterfaceProxy" {
      */
     putMessage(): void;
   }
-  export default RepresentationInterfaceProxy;
 }
 
 declare namespace sap {
@@ -705,7 +708,7 @@ declare namespace sap {
           /**
            * The object represents an OData GET request.
            */
-          oRequest: object,
+          oRequest: object | string,
           /**
            * Service defined by the analytical content configuration.
            */
@@ -737,12 +740,16 @@ declare namespace sap {
            * The first argument of the callback function is the received data (as Array). The second argument is {sap.apf.core.EntityTypeMetadata}.
            * The third argument is {sap.apf.core.MessageObject}.
            */
-          fnCallback: Function,
+          fnCallback: (
+            p1: any[],
+            p2: /* was: sap.apf.core.EntityTypeMetadata */ any,
+            p3: import("sap/apf/core/messageObject").default
+          ) => void,
           /**
            * An optional object containing additional query string options Format: { orderby : [{ property : ,
            * order : }], top : , skip :  }
            */
-          oRequestOptions: Object
+          oRequestOptions: object | string
         ): undefined;
       }
     }