@sapui5/ts-types 1.104.2 → 1.106.0

package/types/sap.f.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.104.0
+// For Library Version: 1.106.0
 
 declare namespace sap {
   /**
@@ -7861,6 +7861,16 @@ declare namespace sap {
        */
       layoutXL?: sap.f.GridContainerSettings;
 
+      /**
+       * Association to controls / IDs which describe this control (see WAI-ARIA attribute aria-describedby).
+       */
+      ariaDescribedBy?: Array<sap.ui.core.Control | string>;
+
+      /**
+       * Association to controls / IDs which label this control (see WAI-ARIA attribute aria-labelledby).
+       */
+      ariaLabelledBy?: Array<sap.ui.core.Control | string>;
+
       /**
        * Fired when the currently active GridSettings change.
        */
@@ -11213,7 +11223,7 @@ declare namespace sap {
          * The ariaDescribedBy to be removed or its index or ID
          */
         vAriaDescribedBy: int | sap.ui.core.ID | sap.ui.core.Control
-      ): sap.ui.core.ID;
+      ): sap.ui.core.ID | null;
       /**
        * @SINCE 1.50
        *
@@ -14093,6 +14103,28 @@ declare namespace sap {
        * @returns Metadata object describing this class
        */
       static getMetadata(): sap.ui.core.ElementMetadata;
+      /**
+       * Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      addAriaDescribedBy(
+        /**
+         * The ariaDescribedBy to add; if empty, nothing is inserted
+         */
+        vAriaDescribedBy: sap.ui.core.ID | sap.ui.core.Control
+      ): this;
+      /**
+       * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      addAriaLabelledBy(
+        /**
+         * The ariaLabelledBy to add; if empty, nothing is inserted
+         */
+        vAriaLabelledBy: sap.ui.core.ID | sap.ui.core.Control
+      ): this;
       /**
        * Adds some item to the aggregation {@link #getItems items}.
        *
@@ -14458,6 +14490,16 @@ declare namespace sap {
        * @returns Value of property `allowDenseFill`
        */
       getAllowDenseFill(): boolean;
+      /**
+       * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy
+       * ariaDescribedBy}.
+       */
+      getAriaDescribedBy(): sap.ui.core.ID[];
+      /**
+       * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy
+       * ariaLabelledBy}.
+       */
+      getAriaLabelledBy(): sap.ui.core.ID[];
       /**
        * Gets current value of property {@link #getContainerQuery containerQuery}.
        *
@@ -14600,6 +14642,18 @@ declare namespace sap {
          */
         iIndex: int
       ): this;
+      /**
+       * Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
+       *
+       * @returns An array of the removed elements (might be empty)
+       */
+      removeAllAriaDescribedBy(): sap.ui.core.ID[];
+      /**
+       * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
+       *
+       * @returns An array of the removed elements (might be empty)
+       */
+      removeAllAriaLabelledBy(): sap.ui.core.ID[];
       /**
        * Removes all the controls from the aggregation {@link #getItems items}.
        *
@@ -14608,17 +14662,39 @@ declare namespace sap {
        * @returns An array of the removed elements (might be empty)
        */
       removeAllItems(): sap.ui.core.Control[];
+      /**
+       * Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
+       *
+       * @returns The removed ariaDescribedBy or `null`
+       */
+      removeAriaDescribedBy(
+        /**
+         * The ariaDescribedBy to be removed or its index or ID
+         */
+        vAriaDescribedBy: int | sap.ui.core.ID | sap.ui.core.Control
+      ): sap.ui.core.ID | null;
+      /**
+       * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
+       *
+       * @returns The removed ariaLabelledBy or `null`
+       */
+      removeAriaLabelledBy(
+        /**
+         * The ariaLabelledBy to be removed or its index or ID
+         */
+        vAriaLabelledBy: int | sap.ui.core.ID | sap.ui.core.Control
+      ): sap.ui.core.ID | null;
       /**
        * Removes an item from the aggregation named `items`.
        *
-       * @returns The removed item or null.
+       * @returns The removed item or `null`.
        */
       removeItem(
         /**
          * The item to remove or its index or ID.
          */
         vItem: int | string | sap.ui.core.Item
-      ): sap.ui.core.Control;
+      ): sap.ui.core.Control | null;
       /**
        * @EXPERIMENTAL (since 1.66)
        *

package/types/sap.fe.common.d.ts

@@ -1,3 +1,3 @@
-// For Library Version: 1.104.1
+// For Library Version: 1.106.0
 
 declare namespace sap {}

package/types/sap.fe.core.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.104.1
+// For Library Version: 1.106.0
 
 declare namespace sap {
   /**
@@ -148,7 +148,7 @@ declare namespace sap {
            * Invokes an action (bound or unbound) and tracks the changes so that other pages can be refreshed and
            * show the updated data upon navigation.
            *
-           * @returns A promise once the action has been invoked
+           * @returns A promise which resolves once the action has been executed, providing the response
            */
           invokeAction(
             /**
@@ -510,7 +510,7 @@ declare namespace sap {
             /**
              * Current context where the navigation is initiated
              */
-            oContext: sap.ui.model.odata.v4.Context
+            oContext?: sap.ui.model.odata.v4.Context
           ): void;
           /**
            * @SINCE 1.94.0
@@ -811,7 +811,7 @@ declare namespace sap {
            */
           applyInitialStateOnly(): boolean;
           /**
-           * Apply navigation parameters - is called only if navigation type is not iAppState.
+           * Apply navigation parameters is not called if the navigation type is iAppState
            * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
            * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
            */
@@ -861,7 +861,7 @@ declare namespace sap {
                */
               navigationType: any;
               /**
-               * Defines whether standard variant must be used in VM
+               * Defines whether the standard variant must be used in variant management
                */
               requiresStandardVariant?: boolean;
               /**

package/types/sap.fe.macros.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.104.1
+// For Library Version: 1.106.0
 
 declare namespace sap {
   namespace fe {
@@ -72,6 +72,19 @@ declare namespace sap {
         };
       }
 
+      interface $MacroAPISettings extends sap.ui.core.$ControlSettings {
+        /**
+         * Defines the path of the context used in the current page or block.
+         * This setting is defined by the framework.
+         */
+        contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
+        /**
+         * Defines the relative path of the property in the metamodel, based on the current contextPath.
+         */
+        metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
+      }
+
       interface $ChartSettings extends sap.fe.macros.$MacroAPISettings {
         /**
          * Metadata path to the entitySet or navigationProperty
@@ -159,7 +172,7 @@ declare namespace sap {
         contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
         /**
-         * The identifier of the filterbar control.
+         * The identifier of the FilterBar control.
          */
         id?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
@@ -192,19 +205,6 @@ declare namespace sap {
         title?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
       }
 
-      interface $MacroAPISettings extends sap.ui.core.$ControlSettings {
-        /**
-         * Defines the path of the context used in the current page or block.
-         * This setting is defined by the framework.
-         */
-        contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
-
-        /**
-         * Defines the relative path of the property in the metamodel, based on the current contextPath.
-         */
-        metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
-      }
-
       interface $TableSettings extends sap.fe.macros.$MacroAPISettings {
         /**
          * An expression that allows you to control the 'busy' state of the table.
@@ -354,76 +354,18 @@ declare namespace sap {
           | sap.ui.base.ManagedObject.PropertyBindingInfo;
       }
 
-      /**
-       * @SINCE 1.93.0
-       *
-       * Building block used specifically in an app using the flexible column layout to add the ‘expand’, ‘reduce’,
-       * and ‘close’ action buttons.
-       *
-       * Usage example:
-       * ```javascript
-       *
-       * <f:DynamicPageTitle id="incidentProcessFlowDynamicPageTitle">
-       * 	 <f:navigationActions>
-       * 	   <macros:FlexibleColumnLayoutActions />
-       * 	 </f:navigationActions>
-       * </f:DynamicPageTitle>
-       * <macro:FlexibleColumnLayoutActions />
-       * ```
-       */
-      class FlexibleColumnLayoutActions
-        /* was: sap.fe.macros.MacroMetadata */ extends Object {
-        constructor();
-      }
       /**
        * @SINCE 1.90.0
        *
        * Building block used to create a form element containing a label and a field.
        */
-      class FormElement /* was: sap.fe.macros.MacroMetadata */ extends Object {
+      class FormElement {
         constructor();
       }
       /**
-       * @SINCE 1.93.0
-       *
-       * Building block used to create a MicroChart based on the metadata provided by OData V4.
-       */
-      class MicroChart /* was: sap.fe.macros.MacroMetadata */ extends Object {
-        constructor();
-      }
-      /**
-       * @SINCE 1.94.0
-       *
-       * Building block used to create a paginator control.
-       *
-       * Usage example:
-       * ```javascript
-       *
-       * <macro:Paginator />
-       * ```
-       */
-      class Paginator /* was: sap.fe.macros.MacroMetadata */ extends Object {
-        constructor();
-      }
-      /**
-       * @SINCE 1.93.0
-       *
-       * Building block used to create the ‘Share’ functionality.
-       *  Please note that the 'Share in SAP Jam' option is only available on platforms that are integrated with
-       * SAP Jam.
-       *  If you are consuming this macro in an environment where the SAP Fiori launchpad is not available, then
-       * the 'Save as Tile' option is not visible.
-       *
-       * Usage example:
-       * ```javascript
-       *
-       * <macro:Share
-       * 	id="someID"
-       * 	visible="true"
-       * />
-       * ```
+       * Base API control for macros.
        */
-      class Share /* was: sap.fe.macros.MacroMetadata */ extends Object {
+      class MacroAPI extends sap.ui.core.Control {
         constructor();
       }
       /**
@@ -543,7 +485,7 @@ declare namespace sap {
             | string[]
             | number[]
             | boolean[]
-        ): void;
+        ): Promise<any>;
       }
       /**
        * Building block for creating a Form based on the metadata provided by OData V4.
@@ -561,12 +503,6 @@ declare namespace sap {
       class Form extends sap.fe.macros.MacroAPI {
         constructor();
       }
-      /**
-       * Base API control for macros.
-       */
-      class MacroAPI extends sap.ui.core.Control {
-        constructor();
-      }
       /**
        * Building block used to create a table based on the metadata provided by OData V4.
        *
@@ -684,7 +620,7 @@ declare namespace sap {
          */
         label: string;
         /**
-         * If set the search will be automatically triggered, when a filter value was changed.
+         * If set, the search is triggered automatically when a filter value is changed.
          */
         liveMode: boolean;
         /**
@@ -692,6 +628,10 @@ declare namespace sap {
          * Allowed values are `Before` and `After`
          */
         placement: string;
+        /**
+         * If set, possible errors that occur during the search will be displayed in a message box.
+         */
+        showMessages: boolean;
         /**
          * Parameter which sets the visibility of the FilterBar building block
          */
@@ -701,28 +641,20 @@ declare namespace sap {
   }
 
   interface IUI5DefineDependencyNames {
-    "sap/fe/macros/ChartAPI": undefined;
+    "sap/fe/macros/chart/ChartAPI": undefined;
 
-    "sap/fe/macros/FieldAPI": undefined;
+    "sap/fe/macros/field/FieldAPI": undefined;
 
-    "sap/fe/macros/FilterBarAPI": undefined;
+    "sap/fe/macros/filterBar/FilterBarAPI": undefined;
 
-    "sap/fe/macros/FlexibleColumnLayoutActions.metadata": undefined;
+    "sap/fe/macros/form/FormAPI": undefined;
 
-    "sap/fe/macros/FormAPI": undefined;
-
-    "sap/fe/macros/FormElement.metadata": undefined;
+    "sap/fe/macros/form/FormElement.metadata": undefined;
 
     "sap/fe/macros/library": undefined;
 
     "sap/fe/macros/MacroAPI": undefined;
 
-    "sap/fe/macros/MicroChart.metadata": undefined;
-
-    "sap/fe/macros/Paginator.metadata": undefined;
-
-    "sap/fe/macros/Share.metadata": undefined;
-
-    "sap/fe/macros/TableAPI": undefined;
+    "sap/fe/macros/table/TableAPI": undefined;
   }
 }

package/types/sap.fe.navigation.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.104.1
+// For Library Version: 1.106.0
 
 declare namespace sap {
   namespace fe {
@@ -757,8 +757,8 @@ declare namespace sap {
          * properties
          * 	 - `oAppData.tableVariantId`
          * 	 - `oAppData.customData`  which return the inner app data as stored in {@link #.navigate navigate}
-         * 			or {@link #.storeInnerAppState storeInnerAppState}. `oAppData.oDefaultedSelectionVariant` is an empty
-         * 			selection variant and `oAppData.bNavSelVarHasDefaultsOnly` is `false` in this case.
+         * 			or {@link #.storeInnerAppStateAsync storeInnerAppStateAsync}. `oAppData.oDefaultedSelectionVariant` is
+         * 			an empty selection variant and `oAppData.bNavSelVarHasDefaultsOnly` is `false` in this case.
          *  **Note:** If the navigation type is {@link sap.fe.navigation.NavType.initial} oAppData is an empty object!
          *  If an error occurs, an error object of type {@link sap.fe.navigation.NavError}, URL parameters (if available)
          * and the type of navigation are returned.
@@ -881,6 +881,9 @@ declare namespace sap {
           aTechnicalParameters: any[]
         ): void;
         /**
+         * @deprecated (since 1.104) - Use the {@link sap.fe.navigation.NavigationHandler.storeInnerAppStateAsync}
+         * instead.
+         *
          * Changes the URL according to the current app state and stores the app state for later retrieval.
          *
          * @returns A Promise object to monitor when all the actions of the function have been executed; if the
@@ -888,6 +891,50 @@ declare namespace sap {
          * sap.fe.navigation.NavError} is returned
          */
         storeInnerAppState(
+          /**
+           * Object containing the current state of the app
+           */
+          mInnerAppData: {
+            /**
+             * Stringified JSON object as returned, for example, from getDataSuiteFormat() of the SmartFilterBar control
+             */
+            selectionVariant: string;
+            /**
+             * ID of the SmartTable variant
+             */
+            tableVariantId?: string;
+            /**
+             * Object that can be used to store additional app-specific data
+             */
+            customData?: object;
+            /**
+             * Object containing the current ui state of the app
+             */
+            presentationVariant?: object;
+            /**
+             * Object containing value descriptions
+             */
+            valueTexts?: object;
+            /**
+             * Object containing semanticDates filter information
+             */
+            semanticDates?: object;
+          },
+          /**
+           * If set to false, the inner app hash will not be replaced until storing is successful; do not set to false
+           * if you cannot react to the resolution of the Promise, for example, when calling the beforeLinkPressed
+           * event
+           */
+          bImmediateHashReplace?: boolean
+        ): object;
+        /**
+         * Changes the URL according to the current app state and stores the app state for later retrieval.
+         *
+         * @returns A Promise object to monitor when all the actions of the function have been executed; if the
+         * execution is successful, the app state key is returned; if an error occurs, an object of type {@link
+         * sap.fe.navigation.NavError} is returned
+         */
+        storeInnerAppStateAsync(
           /**
            * Object containing the current state of the app
            */
@@ -924,13 +971,14 @@ declare namespace sap {
            */
           bImmediateHashReplace?: boolean,
           /**
-           * If set to true, the inner app hash will not be replaced in the storeInnerAppState. Also the bImmediateHashReplace
+           * If set to true, the inner app hash will not be replaced in the storeInnerAppStateAsync. Also the bImmediateHashReplace
            * will be ignored.
            */
           bSkipHashReplace?: boolean
         ): object;
         /**
-         * @deprecated (since 1.104) - Use the {@link sap.fe.navigation.NavigationHandler.storeInnerAppState} instead.
+         * @deprecated (since 1.104) - Use the {@link sap.fe.navigation.NavigationHandler.storeInnerAppStateAsync}
+         * instead.
          *
          * Changes the URL according to the current app state and stores the app state for later retrieval.
          *

package/types/sap.fe.templates.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.104.1
+// For Library Version: 1.106.0
 
 declare namespace sap {
   namespace fe {
@@ -161,6 +161,158 @@ declare namespace sap {
               | string[]
               | number[]
               | boolean[]
+          ): Promise<any>;
+          /**
+           * Triggers an update of the app state.
+           * Should be called if the state of a control, or any other state-relevant information, was changed.
+           *
+           * @returns A promise that resolves with the new app state object.
+           */
+          updateAppState(): undefined | Promise<any>;
+        }
+      }
+
+      namespace ObjectPage {
+        /**
+         * @SINCE 1.79.0
+         *
+         *
+         * Extension API for object pages on SAP Fiori elements for OData V4.
+         */
+        class ExtensionAPI
+          /* was: sap.fe.templates.ExtensionAPI */ extends Object {
+          constructor();
+
+          /**
+           * Add any control as a dependent control to this SAP Fiori elements page.
+           */
+          addDependent(
+            /**
+             * Control to be added as a dependent control
+             */
+            oControl: sap.ui.core.Control
+          ): void;
+          /**
+           * Gets the bound context of the current object page.
+           *
+           * @returns Context bound to the object page
+           */
+          getBindingContext(): undefined | object | sap.ui.model.Context;
+          /**
+           * Get access to models managed by SAP Fiori elements.
+           *
+           * The following models can be accessed:
+           *
+           *
+           * 	 - undefined: the undefined model returns the SAPUI5 OData V4 model bound to this page
+           *
+           * 	 - i18n / further data models defined in the manifest
+           * ui: returns a SAPUI5 JSON model containing UI information.
+           * Only the following properties are public and supported:
+           *
+           *
+           * 	 - isEditable: set to true if the application is in edit mode
+           *
+           *
+           * .
+           * editMode is deprecated and should not be used anymore. Use isEditable instead.
+           *
+           * @returns The required model
+           */
+          getModel(
+            /**
+             * Name of the model
+             */
+            sModelName?: string
+          ): undefined | sap.ui.model.Model;
+          /**
+           * Gets the list entries currently selected for the table.
+           *
+           * @returns Array containing the selected contexts
+           */
+          getSelectedContexts(
+            /**
+             * The ID identifying the table the selected context is requested for
+             */
+            sTableId: string
+          ): any;
+          /**
+           * Load a fragment and go through the template preprocessor with the current page context.
+           *
+           * @returns The fragment definition
+           */
+          loadFragment(
+            /**
+             * The settings object
+             */
+            mSettings: {
+              /**
+               * The contextPath to be used for the templating process
+               */
+              contextPath: string;
+              /**
+               * The controller to be attached to the fragment
+               */
+              controller: object;
+              /**
+               * The ID of the fragment itself
+               */
+              id: string;
+              /**
+               * The initial binding context
+               */
+              initialBindingContext: sap.ui.model.Context;
+              /**
+               * The name of the fragment to be loaded
+               */
+              name: string;
+            }
+          ): Promise<any>;
+          /**
+           * Navigate to another target.
+           */
+          navigateToTarget(
+            /**
+             * Name of the target route
+             */
+            sTarget: string,
+            /**
+             * undefined
+             */
+            oContext: sap.ui.model.Context
+          ): void;
+          /**
+           * Refreshes either the whole object page or only parts of it.
+           *
+           * @returns Resolved once the data is refreshed or rejected if the request failed
+           */
+          refresh(
+            /**
+             * undefined
+             */
+            vPath: undefined | string | string[]
+          ): Promise<any>;
+          /**
+           * Remove a dependent control from this SAP Fiori elements page.
+           */
+          removeDependent(
+            /**
+             * Control to be added as a dependent control
+             */
+            oControl: sap.ui.core.Control
+          ): void;
+          /**
+           * Displays or hides the side content of an object page block.
+           */
+          showSideContent(
+            /**
+             * Key of the side content fragment as defined in the manifest.json
+             */
+            sSubSectionKey: string,
+            /**
+             * undefined
+             */
+            bShow: undefined | boolean
           ): void;
           /**
            * Triggers an update of the app state.
@@ -178,5 +330,7 @@ declare namespace sap {
     "sap/fe/templates/library": undefined;
 
     "sap/fe/templates/ListReport/ExtensionAPI": undefined;
+
+    "sap/fe/templates/ObjectPage/ExtensionAPI": undefined;
   }
 }