@sapui5/types 1.120.7 → 1.121.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sapui5/types",
-  "version": "1.120.7",
+  "version": "1.121.0",
   "description": "SAPUI5 TypeScript Definitions",
   "homepage": "https://sap.github.io/ui5-typescript/",
   "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 module "sap/apf/library" {}
 
@@ -47,11 +47,11 @@ declare module "sap/apf/api" {
     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(
@@ -61,10 +61,10 @@ declare module "sap/apf/api" {
       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(
       /**
@@ -78,6 +78,7 @@ declare module "sap/apf/api" {
      * 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;
@@ -138,6 +139,7 @@ declare module "sap/apf/api" {
     /**
      * Gets a path filter fragment for the given identifier by fully replacing the existing one.
      *
+     *
      * @returns filter for id
      */
     getPathFilter(
@@ -173,11 +175,11 @@ declare module "sap/apf/api" {
       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(
       /**
@@ -190,6 +192,7 @@ declare module "sap/apf/api" {
      * 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(
@@ -199,11 +202,11 @@ declare module "sap/apf/api" {
       oMessage: 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;
     /**
@@ -227,11 +230,11 @@ declare module "sap/apf/api" {
       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(
@@ -250,6 +253,7 @@ declare module "sap/apf/api" {
      * true, when no fatal error occurred during startup phase. Startup phase includes the initialization +
      * startupApf
      *
+     *
      * @returns success of startup
      */
     startupSucceeded(): boolean;
@@ -301,6 +305,7 @@ declare module "sap/apf/core/messageObject" {
     /**
      * Gets the previous message object.
      *
+     *
      * @returns || undefined
      */
     getPrevious(): MessageObject;
@@ -335,12 +340,14 @@ declare module "sap/apf/core/messageObject" {
     /**
      * Sets the code, that classifies the message.
      *
+     *
      * @returns undefined
      */
     setCode(code: string): undefined;
     /**
      * Sets the message text.
      *
+     *
      * @returns undefined
      */
     setMessage(sTextMessage: string): undefined;
@@ -349,12 +356,14 @@ declare module "sap/apf/core/messageObject" {
      * a previous message. The message in the previous message object will also be displayed in the log (as
      * previous entry).
      *
+     *
      * @returns undefined
      */
     setPrevious(oPreviousMessageObject: MessageObject): undefined;
     /**
      * Sets the severity , which classifies the message.
      *
+     *
      * @returns undefined
      */
     setSeverity(
@@ -406,6 +415,7 @@ declare module "sap/apf/core/readRequest" {
     /**
      * Executes an OData request.
      *
+     *
      * @returns undefined
      */
     send(
@@ -434,10 +444,10 @@ 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).
-   *
    * 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).
    */
   export default class representationInterface {
     constructor(
@@ -478,12 +488,14 @@ declare module "sap/apf/ui/representations/representationInterface" {
     /**
      * 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[];
@@ -491,12 +503,14 @@ declare module "sap/apf/ui/representations/representationInterface" {
      * 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.
      */
@@ -504,18 +518,21 @@ declare module "sap/apf/ui/representations/representationInterface" {
     /**
      * 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.
      */
@@ -541,6 +558,7 @@ declare module "sap/apf/ui/representations/representationInterface" {
      * is applied.  **array** holding objects with properties 'property' and 'ascending' as described
      * above.
      *
+     *
      * @returns Example:
      * { paging : {
      * 		top : 10,
@@ -561,6 +579,7 @@ declare module "sap/apf/ui/representations/representationInterface" {
     /**
      * 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
@@ -573,6 +592,7 @@ declare module "sap/apf/ui/representations/representationInterface" {
     /**
      * 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.
      */
@@ -582,6 +602,7 @@ declare module "sap/apf/ui/representations/representationInterface" {
      * 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.
      */
@@ -594,6 +615,7 @@ declare module "sap/apf/ui/representations/representationInterface" {
      * 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;
@@ -640,11 +662,11 @@ declare module "sap/apf/ui/representations/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).
-   *
    * 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).
    */
   export default class RepresentationInterfaceProxy {
     constructor(
@@ -686,9 +708,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;
 
@@ -732,6 +754,7 @@ declare namespace sap {
         /**
          * Executes an OData request.
          *
+         *
          * @returns undefined
          */
         send(
@@ -795,6 +818,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[];
@@ -810,6 +834,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(
@@ -822,6 +847,7 @@ declare namespace sap {
         /**
          * Updates an expression.
          *
+         *
          * @returns undefined
          */
         updateExpression(
@@ -858,6 +884,7 @@ declare namespace sap {
         /**
          * Updates a value of an expression object.
          *
+         *
          * @returns undefined
          */
         updateValue(
@@ -888,6 +915,7 @@ declare namespace sap {
         /**
          * Adds an expression object to this filter.
          *
+         *
          * @returns this to allow method chaining
          */
         addExpression(
@@ -986,6 +1014,7 @@ declare namespace sap {
         /**
          * Adds an expression object to this filter.
          *
+         *
          * @returns this to allow method chaining
          */
         addExpression(
@@ -1014,6 +1043,7 @@ declare namespace sap {
         /**
          * Retrieves an ID of the term.
          *
+         *
          * @returns ID of the term.
          */
         getId(): string;
@@ -1034,6 +1064,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;