@sapui5/ts-types 1.133.0 → 1.134.0

package/types/sap.suite.ui.generic.template.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.1
 
 declare namespace sap {
   namespace suite {
@@ -706,6 +706,22 @@ declare namespace sap {
                    */
                   fnFunction: Function
                 ): void;
+                /**
+                 * Returns a communication object for storing and accessing custom state information within the current
+                 * app.
+                 *
+                 * - If `iLevel` is `0`, it returns a global communication object shared across components. - If `iLevel`
+                 *     is `1`, it returns a local communication object specific to the current canvas component.
+                 *
+                 *
+                 * @returns The communication object.
+                 */
+                getCommunicationObject(
+                  /**
+                   * The scope level of the communication object (0 for global, 1 for local).
+                   */
+                  iLevel: number
+                ): object;
                 /**
                  * Get the Flexible Column Layout Action Buttons (Fullscreen, Exit Fullscreen and Close). Note that the
                  * usage of the Flexible Column Layout Action Buttons must have been switched on in the settings of the
@@ -1809,6 +1825,14 @@ declare namespace sap {
                    */
                   oControl: sap.ui.core.Control
                 ): void;
+                /**
+                 * Returns the global communication object for storing and accessing custom state information within the
+                 * current app. This object can be used across components to share state information.
+                 *
+                 *
+                 * @returns The communication object.
+                 */
+                getCommunicationObject(): object;
                 /**
                  * Get the navigation controller for navigation actions
                  *
@@ -1817,11 +1841,10 @@ declare namespace sap {
                  */
                 getNavigationController(): sap.suite.ui.generic.template.extensionAPI.NavigationController;
                 /**
-                 * If switching between different table views is enabled, this function returns the selected key.
+                 * If multi view table is enabled, this function returns the selected variant's key.
                  *
-                 * @experimental
                  *
-                 * @returns The key of the variant item that is currently selected.
+                 * @returns The currently selected variant key on the table.
                  */
                 getQuickVariantSelectionKey(): string;
                 /**
@@ -1996,13 +2019,11 @@ declare namespace sap {
                   onClose?: Function
                 ): void;
                 /**
-                 * If switching between different table views is enabled, this function sets the selected key.
-                 *
-                 * @experimental
+                 * If multi view table is enabled, this function switches the table's view to given variant key.
                  */
                 setQuickVariantSelectionKey(
                   /**
-                   * The key of the variant item that is currently selected.
+                   * The table variant key to be selected.
                    */
                   sKey: string
                 ): void;
@@ -2630,34 +2651,31 @@ declare namespace sap {
                   fnFunction: Function
                 ): void;
                 /**
-                 * Cancel the draft. Note that this method only works when you are on the root of a draft. The normal navigation
+                 * Cancels the draft. Note that this method only works when you are on the root of a draft. The normal navigation
                  * which follows the cancellation of a draft is executed. Moreover, note that executing this method will
                  * set the App to be busy. However, it does not ensure, that the method is only called, when the App is
                  * currently unbusy. If you want to ensure that, you have to use {@link sap.suite.ui.generic.template.ObjectPage.extensionAPI.ExtensionAPI#securedExecution}.
                  *
-                 * @experimental
                  *
-                 * @returns a promise that is resolved when the draft is cancelled, rejected when this is not possible.
+                 * @returns A promise that is resolved when the draft is cancelled, rejected when it is not possible.
                  */
-                discardDraft(): Function;
+                discardDraft(): Promise<void>;
                 /**
-                 * checks if side effects exist for the given properties or entities and executes them. if there are pending
-                 * changes in the model those pending changes are sent as a patch request with the side effect batch request.
-                 * If no source property and no source entity is passed a global side effect is executed
-                 *
-                 * @experimental
+                 * Checks if side effects exist for the given properties or entities and executes them. If there are pending
+                 * changes in the model, those pending changes are sent as a patch request with the side effect batch request.
+                 * If no source property and no source entity is passed, a global side effect is executed.
                  */
                 executeSideEffects(
                   /**
-                   * object containing any of the following properties:
+                   * Object containing any of the following properties:
                    */
                   oSideEffects?: {
                     /**
-                     * array with property paths
+                     * Array with property paths
                      */
                     sourceProperties: any[];
                     /**
-                     * array with navigation property paths
+                     * Array with navigation property paths
                      */
                     sourceEntities: any[];
                   }
@@ -2755,6 +2773,14 @@ declare namespace sap {
                    */
                   fnFunction: Function
                 ): void;
+                /**
+                 * Returns the global communication object for storing and accessing custom state information within the
+                 * current app. This object can be used across components to share state information.
+                 *
+                 *
+                 * @returns The communication object.
+                 */
+                getCommunicationObject(): object;
                 /**
                  * Get the navigation controller for navigation actions
                  *
@@ -2763,15 +2789,14 @@ declare namespace sap {
                  */
                 getNavigationController(): sap.suite.ui.generic.template.extensionAPI.NavigationController;
                 /**
-                 * This function returns the selected key of selected table of Object Page.
+                 * Returns the currently selected variant key on the table in the given object page section.
                  *
-                 * @experimental
                  *
-                 * @returns The key of variant item that is currently selected section.
+                 * @returns The currently selected variant key on the table.
                  */
                 getQuickVariantSelectionKey(
                   /**
-                   * id of the section in Object Page mentioned in manifest of the application
+                   * The object page section id in which the table is present.
                    */
                   sSectionKey: string
                 ): string;
@@ -3011,19 +3036,17 @@ declare namespace sap {
                   onClose?: Function
                 ): void;
                 /**
-                 * This function sets the key in the selected section of the table of Object Page.
-                 *
-                 * @experimental
+                 * Switches the table's view to the given variant key.
                  */
                 setQuickVariantSelectionKey(
                   /**
-                   * id of the section in Object Page mentioned in manifest of the application
+                   * The object page section id in which the table is present.
                    */
                   sSectionKey: string,
                   /**
-                   * The key of variant item that is currently need to be set.
+                   * The table variant key to be selected.
                    */
-                  sKey: string
+                  sVariantKey: string
                 ): void;
               }
 

package/types/sap.suite.ui.microchart.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare namespace sap {
   namespace suite {

package/types/sap.tnt.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare namespace sap {
   /**
@@ -185,8 +185,17 @@ declare namespace sap {
         | `{${string}}`;
 
       /**
-       * Specifies if the item can be selected. It is recommended to set this property to `false` when the property
-       * `href` is also used.
+       * Specifies if the item can be selected. By default all items are selectable.
+       *
+       * When a parent item's `selectable` property is set to `false`, selecting it will only expand or collapse
+       * its sub-items.
+       *
+       * To improve user experience do not mix selectable parent items with not selectable parent items within
+       * a single side navigation.
+       *
+       * **Guidelines:**
+       * 	 - External links should not be selectable.
+       * 	 - Items that trigger actions (with design "Action") should not be selectable.
        *
        * @since 1.116
        * @experimental As of version 1.116. Disclaimer: this property is in a beta state - incompatible API changes
@@ -332,6 +341,19 @@ declare namespace sap {
        */
       ariaLabel?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
+      /**
+       * Specifies whether the control should have own container styling, such as a box-shadow and border, or
+       * not. **Note:** This property has to be set to `Plain` when the control is used inside a `sap.m.ResponsivePopover`
+       * to achieve a Side Navigation Overlay Mode.
+       *
+       * @since 1.134
+       * @experimental
+       */
+      design?:
+        | sap.tnt.SideNavigationDesign
+        | sap.ui.base.ManagedObject.PropertyBindingInfo
+        | `{${string}}`;
+
       /**
        * Defines the content inside the flexible part.
        */
@@ -1561,8 +1583,17 @@ declare namespace sap {
       /**
        * Gets current value of property {@link #getSelectable selectable}.
        *
-       * Specifies if the item can be selected. It is recommended to set this property to `false` when the property
-       * `href` is also used.
+       * Specifies if the item can be selected. By default all items are selectable.
+       *
+       * When a parent item's `selectable` property is set to `false`, selecting it will only expand or collapse
+       * its sub-items.
+       *
+       * To improve user experience do not mix selectable parent items with not selectable parent items within
+       * a single side navigation.
+       *
+       * **Guidelines:**
+       * 	 - External links should not be selectable.
+       * 	 - Items that trigger actions (with design "Action") should not be selectable.
        *
        * Default value is `true`.
        *
@@ -1728,8 +1759,17 @@ declare namespace sap {
       /**
        * Sets a new value for property {@link #getSelectable selectable}.
        *
-       * Specifies if the item can be selected. It is recommended to set this property to `false` when the property
-       * `href` is also used.
+       * Specifies if the item can be selected. By default all items are selectable.
+       *
+       * When a parent item's `selectable` property is set to `false`, selecting it will only expand or collapse
+       * its sub-items.
+       *
+       * To improve user experience do not mix selectable parent items with not selectable parent items within
+       * a single side navigation.
+       *
+       * **Guidelines:**
+       * 	 - External links should not be selectable.
+       * 	 - Items that trigger actions (with design "Action") should not be selectable.
        *
        * When called with a value of `null` or `undefined`, the default value of the property will be restored.
        *
@@ -2044,6 +2084,9 @@ declare namespace sap {
      * 	 - The flexible part adapts its size to the fixed one.
      * 	 - The flexible part has a scrollbar when the content is larger than the available space.  **Note:**
      *     In order for the `SideNavigation` to stretch properly, its parent layout control should only be the `sap.tnt.ToolPage`.
+     *     **Note:** If used outside the intended parent layout `sap.tnt.ToolPage`, for example inside a `sap.m.ResponsivePopover`
+     *     to achieve a Side Navigation Overlay Mode, the application developer should set the `design` property
+     *     to `Plain`.
      *
      * @since 1.34
      */
@@ -2235,6 +2278,21 @@ declare namespace sap {
        * @returns Value of property `ariaLabel`
        */
       getAriaLabel(): string;
+      /**
+       * Gets current value of property {@link #getDesign design}.
+       *
+       * Specifies whether the control should have own container styling, such as a box-shadow and border, or
+       * not. **Note:** This property has to be set to `Plain` when the control is used inside a `sap.m.ResponsivePopover`
+       * to achieve a Side Navigation Overlay Mode.
+       *
+       * Default value is `Decorated`.
+       *
+       * @since 1.134
+       * @experimental
+       *
+       * @returns Value of property `design`
+       */
+      getDesign(): sap.tnt.SideNavigationDesign;
       /**
        * Gets current value of property {@link #getExpanded expanded}.
        *
@@ -2313,6 +2371,28 @@ declare namespace sap {
          */
         sAriaLabel?: string
       ): this;
+      /**
+       * Sets a new value for property {@link #getDesign design}.
+       *
+       * Specifies whether the control should have own container styling, such as a box-shadow and border, or
+       * not. **Note:** This property has to be set to `Plain` when the control is used inside a `sap.m.ResponsivePopover`
+       * to achieve a Side Navigation Overlay Mode.
+       *
+       * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+       *
+       * Default value is `Decorated`.
+       *
+       * @since 1.134
+       * @experimental
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      setDesign(
+        /**
+         * New value for property `design`
+         */
+        sDesign?: sap.tnt.SideNavigationDesign
+      ): this;
       /**
        * Sets if the control is in expanded or collapsed mode.
        *
@@ -3112,6 +3192,24 @@ declare namespace sap {
        */
       Narrow = "Narrow",
     }
+    /**
+     * Available options for the Side Navigation design.
+     *
+     * This enum is part of the 'sap/tnt/library' module export and must be accessed by the property 'SideNavigationDesign'.
+     *
+     * @since 1.134.0
+     * @experimental Behavior might change.
+     */
+    enum SideNavigationDesign {
+      /**
+       * Side Navigation has a shadow and border.
+       */
+      Decorated = "Decorated",
+      /**
+       * Side Navigation without any shadow or border.
+       */
+      Plain = "Plain",
+    }
     /**
      * Event object of the NavigationList#itemSelect event.
      */

package/types/sap.ui.codeeditor.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare namespace sap {
   namespace ui {
@@ -92,12 +92,13 @@ declare namespace sap {
         /**
          * Sets the editor color theme. Possible values are:
          * 	 - default: best fitting to the current UI5 theme
-         * 	 - any light theme from the list: chrome, clouds, crimson_editor, dawn, dreamweaver, eclipse, github,
-         *     iplastic, solarized_light, textmate, tomorrow, xcode, kuroir, katzenmilch, sqlserver
+         * 	 - any light theme from the list: chrome, clouds, crimson_editor, dawn, dreamweaver, eclipse, github_light_default,
+         *     github, iplastic, solarized_light, textmate, tomorrow, xcode, kuroir, katzenmilch, sqlserver, cloud_editor
+         *
          * 	 - any dark theme from the list: hcb, hcb_bright, hcb_blue, ambiance, chaos, clouds_midnight, dracula,
          *     cobalt, gruvbox, gob, idle_fingers, kr_theme, merbivore, merbivore_soft, mono_industrial, monokai, nord_dark,
          *     one_dark, pastel_on_dark, solarized_dark, terminal, tomorrow_night, tomorrow_night_blue, tomorrow_night_bright,
-         *     tomorrow_night_eighties, twilight, vibrant_ink, github_dark
+         *     tomorrow_night_eighties, twilight, vibrant_ink, github_dark, cloud_editor_dark
          */
         colorTheme?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
@@ -409,12 +410,13 @@ declare namespace sap {
          *
          * Sets the editor color theme. Possible values are:
          * 	 - default: best fitting to the current UI5 theme
-         * 	 - any light theme from the list: chrome, clouds, crimson_editor, dawn, dreamweaver, eclipse, github,
-         *     iplastic, solarized_light, textmate, tomorrow, xcode, kuroir, katzenmilch, sqlserver
+         * 	 - any light theme from the list: chrome, clouds, crimson_editor, dawn, dreamweaver, eclipse, github_light_default,
+         *     github, iplastic, solarized_light, textmate, tomorrow, xcode, kuroir, katzenmilch, sqlserver, cloud_editor
+         *
          * 	 - any dark theme from the list: hcb, hcb_bright, hcb_blue, ambiance, chaos, clouds_midnight, dracula,
          *     cobalt, gruvbox, gob, idle_fingers, kr_theme, merbivore, merbivore_soft, mono_industrial, monokai, nord_dark,
          *     one_dark, pastel_on_dark, solarized_dark, terminal, tomorrow_night, tomorrow_night_blue, tomorrow_night_bright,
-         *     tomorrow_night_eighties, twilight, vibrant_ink, github_dark
+         *     tomorrow_night_eighties, twilight, vibrant_ink, github_dark, cloud_editor_dark
          *
          * Default value is `"default"`.
          *

package/types/sap.ui.commons.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare namespace sap {
   namespace ui {

package/types/sap.ui.comp.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare namespace sap {
   namespace ui {
@@ -8423,29 +8423,6 @@ declare namespace sap {
              */
             fnNavigationTargetsObtainedCallback: Function
           ): this;
-          /**
-           * Sets a new value for property {@link #getPrefetchNavigationTargets prefetchNavigationTargets}.
-           *
-           * If set to `true`, the SemanticObjectController will retrieve all navigation targets once and will disable
-           * links for which no targets were found. Setting this value to `true` will trigger an additional roundtrip.
-           *
-           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
-           *
-           * Default value is `false`.
-           *
-           * @since 1.28.0
-           * @deprecated As of version 1.42.0. The property `prefetchNavigationTargets` is obsolete as navigation
-           * targets are determined automatically. The SmartLink controls are re-rendered as soon as the asynchronous
-           * determination of navigation targets has been completed.
-           *
-           * @returns Reference to `this` in order to allow method chaining
-           */
-          setPrefetchNavigationTargets(
-            /**
-             * New value for property `prefetchNavigationTargets`
-             */
-            bPrefetchNavigationTargets?: boolean
-          ): this;
           /**
            * Sets a new value for property {@link #getReplaceSmartLinkNavigationTargetsObtained replaceSmartLinkNavigationTargetsObtained}.
            *
@@ -33227,10 +33204,12 @@ declare namespace sap {
            * Returns the internally used table control. Depending on the concrete scenario, the return type is a `sap.m.Table`,
            * `sap.ui.table.Table`, `sap.ui.table.TreeTable`, or `sap.ui.table.AnalyticalTable`.
            *
+           * If the internal table has not been initialized, the function returns `undefined`.
            *
-           * @returns The table instance
+           *
+           * @returns The table instance or undefined
            */
-          getTable(): sap.ui.core.Control;
+          getTable(): sap.ui.core.Control | undefined;
           /**
            * Gets current value of property {@link #getTableBindingPath tableBindingPath}.
            *
@@ -35093,8 +35072,8 @@ declare namespace sap {
            * by the control and is populated via the SAP Flexibility service.
            */
           variantItems?:
-            | sap.ui.comp.variants.VariantItem[]
-            | sap.ui.comp.variants.VariantItem
+            | sap.m.VariantItem[]
+            | sap.m.VariantItem
             | sap.ui.base.ManagedObject.AggregationBindingInfo
             | `{${string}}`;
 
@@ -37086,7 +37065,7 @@ declare namespace sap {
            */
           getVariants(): any[];
           /**
-           * Checks for the provided `sap.ui.comp.variants.VariantItem` in the aggregation {@link #getVariantItems variantItems}.
+           * Checks for the provided `sap.m.VariantItem` in the aggregation {@link #getVariantItems variantItems}.
            * and returns its index if found or -1 otherwise.
            *
            *
@@ -37096,7 +37075,7 @@ declare namespace sap {
             /**
              * The variantItem whose index is looked for
              */
-            oVariantItem: sap.ui.comp.variants.VariantItem
+            oVariantItem: sap.m.VariantItem
           ): int;
           /**
            * Removes all the controls in the association named {@link #getFor for}.
@@ -42633,6 +42612,8 @@ declare namespace sap {
 
     "sap/ui/comp/config/FilterControlConfiguration": undefined;
 
+    "sap/ui/comp/delegates/FlexibilityDelegate": undefined;
+
     "sap/ui/comp/filterbar/FilterBar": undefined;
 
     "sap/ui/comp/filterbar/FilterGroupItem": undefined;