@sapui5/ts-types 1.120.7 → 1.121.0

package/package.json

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

package/types/index.d.ts

@@ -44,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.managecache.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.120.0
+// For Library Version: 1.121.0
 
 declare namespace sap {
   /**
@@ -6,9 +6,9 @@ declare namespace sap {
    */
   namespace apf {
     /**
-     * @deprecated (since 1.23.1) - Use sap.apf.core.constants instead.
-     *
      * Constants to be used by APF consumers.
+     *
+     * @deprecated (since 1.23.1) - Use sap.apf.core.constants instead.
      */
     export const constants: Object;
 
@@ -43,6 +43,7 @@ declare namespace sap {
         /**
          * Gets the previous message object.
          *
+         *
          * @returns || undefined
          */
         getPrevious(): sap.apf.core.MessageObject;
@@ -77,12 +78,14 @@ declare namespace sap {
         /**
          * Sets the code, that classifies the message.
          *
+         *
          * @returns undefined
          */
         setCode(code: string): undefined;
         /**
          * Sets the message text.
          *
+         *
          * @returns undefined
          */
         setMessage(sTextMessage: string): undefined;
@@ -91,6 +94,7 @@ declare namespace sap {
          * a previous message. The message in the previous message object will also be displayed in the log (as
          * previous entry).
          *
+         *
          * @returns undefined
          */
         setPrevious(
@@ -99,6 +103,7 @@ declare namespace sap {
         /**
          * Sets the severity , which classifies the message.
          *
+         *
          * @returns undefined
          */
         setSeverity(
@@ -145,6 +150,7 @@ declare namespace sap {
         /**
          * Executes an OData request.
          *
+         *
          * @returns undefined
          */
         send(
@@ -204,6 +210,7 @@ declare namespace sap {
         /**
          * Executes an OData request.
          *
+         *
          * @returns undefined
          */
         send(
@@ -229,10 +236,10 @@ 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).
-         *
          * This is not a runtime class, but it describes the interface that a representation (chart) has to implement
          * for to interact with the APF.
+         *
+         * @experimental - The complete interface is subject to ongoing work and not yet stable (as of Version 1.24.0).
          */
         class representationInterface {
           constructor(
@@ -273,12 +280,14 @@ declare namespace sap {
           /**
            * Returns the alternate representation of current step (i.e. list representation for the charts)
            *
+           *
            * @returns oAlternateRepresentation
            */
           getAlternateRepresentation(): object | string;
           /**
            * Returns data for representation type
            *
+           *
            * @returns aDataResponse
            */
           getData(): any[];
@@ -286,12 +295,14 @@ declare namespace sap {
            * This method has to be implemented so that binding can determine which method has to be used for the filter
            * retrieval from a representations.
            *
+           *
            * @returns The filter method type the representation supports
            */
           getFilterMethodType(): /* was: sap.apf.constants.filterMethodTypes */ any;
           /**
            * This method holds the logic to draw the content to be shown on main representation area.
            *
+           *
            * @returns oUiObject The UI object that has to be shown in main representation area. Example: Line chart
            * instance for a line chart representation.
            */
@@ -299,18 +310,21 @@ declare namespace sap {
           /**
            * Returns meta data for representation type
            *
+           *
            * @returns metadata
            */
           getMetaData(): /* was: sap.apf.core.EntityTypeMetadata */ any;
           /**
            * The method returns the constructor arguments which will be used to create toggle representation.
            *
+           *
            * @returns oParameters
            */
           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.
            */
@@ -336,6 +350,7 @@ declare namespace sap {
            * is applied.  **array** holding objects with properties 'property' and 'ascending' as described
            * above.
            *
+           *
            * @returns Example:
            * { paging : {
            * 		top : 10,
@@ -356,6 +371,7 @@ declare namespace sap {
           /**
            * This is the basic method with which the step can detect data selected in the chart.
            *
+           *
            * @returns An array with indices is returned.
            * E.g. if the first and the third line of the array aDataResponse have been selected, then aIndices = [0,
            * 2]. Counting of indices start from 0. If all data has been selected, and aDataResponse.length == 4, then
@@ -368,6 +384,7 @@ declare namespace sap {
           /**
            * This method holds the logic to draw the content to be shown on thumbnail area.
            *
+           *
            * @returns oUiObject The UI object that has to be shown in thumbnail area. Example: Line chart instance
            * for a line chart representation.
            */
@@ -377,6 +394,7 @@ declare namespace sap {
            * inside a tooltip Popup when the thumbnail content overflows the thumbnail container area with a gradient
            * effect to indicate that it is overflowing.
            *
+           *
            * @returns oUiObject The UI object that has to be shown as tooltip for a thumbnail. Example: Detailed content
            * of a form representation.
            */
@@ -389,6 +407,7 @@ declare namespace sap {
            * This method returns the selection for serialization. This is required for the Persisting selection of
            * current representation. It includes selection mode and selections.
            *
+           *
            * @returns oSerializationInformation
            */
           serialize(): object | string;
@@ -432,11 +451,11 @@ declare namespace sap {
           ): void;
         }
         /**
-         * @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.
+         *
+         * @experimental - The complete interface is subject to ongoing work and not yet stable (as of Version 1.24.0).
          */
         class RepresentationInterfaceProxy {
           constructor(
@@ -518,6 +537,7 @@ declare namespace sap {
          * object) or be a boolean expression (see the FilterExpression object). AND and OR terms are returned as
          * arrays; boolean expressions are returned as objects.
          *
+         *
          * @returns Array of AND terms, OR terms and expressions.
          */
         getExpressions(): object[];
@@ -533,6 +553,7 @@ declare namespace sap {
          * Build the intersection of the this filter object with the supplied filter(s). The method does not change
          * the "this"-instance.
          *
+         *
          * @returns new CoreFilter object {@link sap.apf.utils.Filter} for the intersected filters
          */
         intersectWith(
@@ -545,6 +566,7 @@ declare namespace sap {
         /**
          * Updates an expression.
          *
+         *
          * @returns undefined
          */
         updateExpression(
@@ -581,6 +603,7 @@ declare namespace sap {
         /**
          * Updates a value of an expression object.
          *
+         *
          * @returns undefined
          */
         updateValue(
@@ -611,6 +634,7 @@ declare namespace sap {
         /**
          * Adds an expression object to this filter.
          *
+         *
          * @returns this to allow method chaining
          */
         addExpression(
@@ -709,6 +733,7 @@ declare namespace sap {
         /**
          * Adds an expression object to this filter.
          *
+         *
          * @returns this to allow method chaining
          */
         addExpression(
@@ -737,6 +762,7 @@ declare namespace sap {
         /**
          * Retrieves an ID of the term.
          *
+         *
          * @returns ID of the term.
          */
         getId(): string;
@@ -781,11 +807,11 @@ declare namespace sap {
       type: undefined;
 
       /**
-       * @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.
        *
+       * @experimental - NOT FOR PRODUCTION USE
+       *
        * @returns undefined
        */
       activateOnErrorHandling(
@@ -795,10 +821,10 @@ declare namespace sap {
         bHandling: boolean
       ): undefined;
       /**
+       * Adds an element to the footer area.
+       *
        * @deprecated (since 1.23.1) - Remains in api in order to maintain downward compatibility to 3 Wave 5 apps.
        * @experimental - NOT FOR PRODUCTION USE
-       *
-       * Adds an element to the footer area.
        */
       addMasterFooterContent(
         /**
@@ -812,6 +838,7 @@ declare namespace sap {
        * is supported. Restriction: Only the operators EQ, LE (less equal than) and GE (greater equal than) are
        * supported.
        *
+       *
        * @returns ID to be provided for later updates of the same filter via method updatePathFilter.
        */
       addPathFilter(filter: sap.apf.utils.Filter): number;
@@ -872,6 +899,7 @@ declare namespace sap {
       /**
        * Gets a path filter fragment for the given identifier by fully replacing the existing one.
        *
+       *
        * @returns filter for id
        */
       getPathFilter(
@@ -907,11 +935,11 @@ declare namespace sap {
         aParameters: string[]
       ): string;
       /**
-       * @deprecated (since 1.23.1)
-       * @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.
+       *
+       * @deprecated (since 1.23.1)
+       * @experimental - NOT FOR PRODUCTION USE
        */
       loadApplicationConfig(
         /**
@@ -924,6 +952,7 @@ declare namespace sap {
        * A message is passed to the APF message handler for further processing. All message specific settings
        * (e.g. message code or severity) need to be passed within an APF message object instance.
        *
+       *
        * @returns undefined
        */
       putMessage(
@@ -933,11 +962,11 @@ declare namespace sap {
         oMessage: sap.apf.core.MessageObject
       ): undefined;
       /**
-       * @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
        * value passed.
+       *
+       * @experimental - NOT FOR PRODUCTION USE
        */
       selectionChanged(bRefreshAllSteps: boolean): void;
       /**
@@ -961,11 +990,11 @@ declare namespace sap {
         fnCallback: Function
       ): void;
       /**
-       * @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.
        *
+       * @experimental - NOT FOR PRODUCTION USE
+       *
        * @returns true or false based on success or failure of registering the listener.
        */
       setEventCallback(
@@ -984,6 +1013,7 @@ declare namespace sap {
        * true, when no fatal error occurred during startup phase. Startup phase includes the initialization +
        * startupApf
        *
+       *
        * @returns success of startup
        */
       startupSucceeded(): boolean;
@@ -1017,6 +1047,8 @@ declare namespace sap {
 
     "sap/apf/library": undefined;
 
+    "sap/apf/ui/instance": undefined;
+
     "sap/apf/ui/representations/representationInterface": undefined;
 
     "sap/apf/ui/representations/RepresentationInterfaceProxy": undefined;