@sapui5/ts-types 1.115.0 → 1.116.0

package/README.md

@@ -2,25 +2,15 @@
 
 # @sapui5/ts-types
 
-This npm package contains the types signatures (based on deprecated globals, see below) for all the SAPUI5 libraries.
+This npm package contains the TypeScript type definitions (based on deprecated globals) for all the SAPUI5 libraries.
 
-These signatures can be used to:
+<b>NOTE:</b> "based on globals" means that it supports the usage of the global "sap" object and the huge tree below this global object containing all modules and controls. But this usage is <b>no longer recommended</b>. In traditional JavaScript, UI5 application code should use the asynchronous `sap.ui.define()`/`sap.ui.require()` calls instead and for TypeScript code we recommend using ES6 module syntax provided by the [@sapui5/types](https://www.npmjs.com/package/@sapui5/types) package. Better use that one instead of this package.
 
-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 globals" means that it supports the usage of the global "sap" object and the huge tree below this global object containing all modules and controls. But this usage is <b>no longer recommended</b>. In traditional JavaScript, UI5 application code should use the asynchronous `sap.ui.define()`/`sap.ui.require()` calls instead and for TypeScript code we recommend using ES6 module syntax provided by the [@sapui5/ts-types-esm](https://www.npmjs.com/package/@sapui5/ts-types-esm) package. So better use that one instead of this package.
+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.
 
 ## Status
 
-This project is in an experimental **_Beta State_**. Significant 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).
-
-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.
+This project **deprecated**. Please use [@sapui5/types](https://www.npmjs.com/package/@sapui5/types) instead.
 
 ## 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",
-  "version": "1.115.0",
+  "version": "1.116.0",
   "description": "SAPUI5 TypeScript Definitions",
   "homepage": "https://ui5.sap.com",
   "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"/>
@@ -37,8 +43,10 @@
 /// <reference path="./sap.fe.core.d.ts"/>
 /// <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.templates.d.ts"/>
 /// <reference path="./sap.fe.test.d.ts"/>
+/// <reference path="./sap.fe.tools.d.ts"/>
 /// <reference path="./sap.feedback.ui.d.ts"/>
 /// <reference path="./sap.landvisz.d.ts"/>
 /// <reference path="./sap.rules.ui.d.ts"/>

package/types/sap.apf.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.115.0
+// For Library Version: 1.116.0
 
 declare namespace sap {
   /**
@@ -23,7 +23,7 @@ declare namespace sap {
         /**
          * Returns the calling object
          */
-        getCallingObject(): object;
+        getCallingObject(): object | string;
         /**
          * Returns the message code.
          */
@@ -121,7 +121,7 @@ declare namespace sap {
           /**
            * The object represents an OData GET request.
            */
-          oRequest: object,
+          oRequest: object | string,
           /**
            * Service defined by the analytical content configuration.
            */
@@ -153,12 +153,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: sap.apf.core.MessageObject
+          ) => void,
           /**
            * An optional object containing additional query string options Format: { orderby : [{ property : ,
            * order : }], top : , skip :  }
            */
-          oRequestOptions: Object
+          oRequestOptions: object | string
         ): undefined;
       }
       /**
@@ -176,7 +180,7 @@ declare namespace sap {
           /**
            * The object represents an OData GET request.
            */
-          oRequest: object,
+          oRequest: object | string,
           /**
            * Service defined by the analytical content configuration.
            */
@@ -208,12 +212,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: sap.apf.core.MessageObject
+          ) => void,
           /**
            * An optional object containing additional query string options Format: { orderby : [{ property : ,
            * order : }], top : , skip :  }
            */
-          oRequestOptions: Object
+          oRequestOptions: object | string
         ): undefined;
       }
     }
@@ -221,7 +229,7 @@ declare namespace sap {
     namespace ui {
       namespace representations {
         /**
-         * @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.
@@ -255,19 +263,19 @@ declare namespace sap {
             /**
              * 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
            *
@@ -287,7 +295,7 @@ declare namespace sap {
            * @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
            *
@@ -299,14 +307,14 @@ declare namespace sap {
            *
            * @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
@@ -363,7 +371,7 @@ declare namespace sap {
            * @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
@@ -372,7 +380,7 @@ declare namespace sap {
            * @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.
            */
@@ -383,7 +391,7 @@ declare namespace sap {
            *
            * @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,
@@ -408,7 +416,7 @@ declare namespace sap {
             /**
              * Contains filters and parameters for treetable request handling
              */
-            controlObject: object,
+            controlObject: object | string,
             /**
              * OData model for the service of treetable
              */
@@ -424,7 +432,7 @@ declare namespace sap {
           ): void;
         }
         /**
-         * @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
@@ -765,7 +773,7 @@ declare namespace sap {
         /**
          * manifests of the component and the base component itself
          */
-        manifests?: Object
+        manifests?: Object | sap.ui.core.Manifest
       );
       /**
        * Contains 'api'
@@ -773,7 +781,7 @@ declare namespace sap {
       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.
@@ -788,7 +796,7 @@ declare namespace sap {
       ): 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.
        */
@@ -877,9 +885,9 @@ declare namespace sap {
        */
       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.
          */
@@ -890,9 +898,9 @@ declare namespace sap {
        */
       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.
          */
@@ -900,7 +908,7 @@ declare namespace sap {
       ): 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.
@@ -925,7 +933,7 @@ declare namespace sap {
         oMessage: sap.apf.core.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
@@ -953,7 +961,7 @@ declare namespace sap {
         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.