@sapui5/ts-types-esm 1.133.0 → 1.134.0

package/package.json

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

package/types/sap.apf.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare module "sap/apf/library" {}
 

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare module "sap/ca/ui/library" {
   export namespace charts {

package/types/sap.chart.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare module "sap/chart/library" {
   import Dimension from "sap/chart/data/Dimension";

package/types/sap.collaboration.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare module "sap/collaboration/library" {
   /**

package/types/sap.cux.home.d.ts

@@ -819,13 +819,6 @@ declare module "sap/cux/home/NewsPanel" {
       settings?: /* was: sap.cux.home.BaseNewsPanel.$BaseNewsPanelSettings */ any
     );
 
-    /**
-     * Gets current value of property customFeedKey.
-     *
-     *
-     * @returns Value of property `customFeedKey`
-     */
-    getCustomFeedKey(): string;
     /**
      * Gets current value of property type.
      *
@@ -840,13 +833,6 @@ declare module "sap/cux/home/NewsPanel" {
      * @returns Value of property `url`
      */
     getUrl(): string;
-    /**
-     * Gets current value of property customFeedKey.
-     *
-     *
-     * @returns Value of property `customFeedKey`
-     */
-    setCustomFeedKey(): string;
     /**
      * Gets current value of property type.
      *

package/types/sap.esh.search.ui.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare module "sap/esh/search/ui/SearchCompositeControl" {
   import { default as Control, $ControlSettings } from "sap/ui/core/Control";
@@ -509,6 +509,8 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
      * Default value is `false`.
      *
      * @since 1.113.0
+     * @deprecated As of version 1.134.0. this setting is ignored and the visibility of the facet panel is controlled
+     * by the end user.
      *
      * @returns Value of property `displayFacetPanelInCaseOfNoResults`
      */
@@ -1073,6 +1075,8 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
      * Default value is `false`.
      *
      * @since 1.113.0
+     * @deprecated As of version 1.134.0. this setting is ignored and the visibility of the facet panel is controlled
+     * by the end user.
      *
      * @returns Reference to `this` in order to allow method chaining
      */
@@ -2020,6 +2024,8 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
      * When set to true the facet panel is displayed also in case there are no search results.
      *
      * @since 1.113.0
+     * @deprecated As of version 1.134.0. this setting is ignored and the visibility of the facet panel is controlled
+     * by the end user.
      */
     displayFacetPanelInCaseOfNoResults?:
       | boolean

package/types/sap.f.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare module "sap/tnt/library" {
   export interface IToolHeader {
@@ -167,6 +167,26 @@ declare module "sap/f/library" {
     __implements__sap_f_IDynamicPageStickyContent: boolean;
   }
 
+  /**
+   * Interface for controls suitable for the `items` aggregation of `{@link sap.f.GridContainer}`.
+   *
+   * Classes implementing this interface should use the accessibility role provided by the `sap.f.IGridContainerItem.getGridItemRole`
+   * method.
+   *
+   * @since 1.134
+   */
+  export interface IGridContainerItem {
+    __implements__sap_f_IGridContainerItem: boolean;
+
+    /**
+     * Returns the accessibility role for the `sap.f.GridContainer` item.
+     *
+     *
+     * @returns The accessibility role for the `sap.f.GridContainer` item
+     */
+    getGridItemRole(): string;
+  }
+
   /**
    * Available `Illustration` sizes for the {@link sap.f.IllustratedMessage} control.
    *
@@ -1459,7 +1479,7 @@ declare module "sap/f/Card" {
 declare module "sap/f/CardBase" {
   import { default as Control, $ControlSettings } from "sap/ui/core/Control";
 
-  import { ICard, cards } from "sap/f/library";
+  import { ICard, IGridContainerItem, cards } from "sap/f/library";
 
   import { IBadge } from "sap/m/library";
 
@@ -1474,9 +1494,13 @@ declare module "sap/f/CardBase" {
   /**
    * A base class for controls that represent a container with a predefined header and content.
    */
-  export default class CardBase extends Control implements ICard, IBadge {
+  export default class CardBase
+    extends Control
+    implements ICard, IBadge, IGridContainerItem
+  {
     __implements__sap_f_ICard: boolean;
     __implements__sap_m_IBadge: boolean;
+    __implements__sap_f_IGridContainerItem: boolean;
     /**
      * Constructor for a new `CardBase`.
      *
@@ -1545,7 +1569,8 @@ declare module "sap/f/CardBase" {
      * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
      * otherwise it will be bound to this `sap.f.CardBase` itself.
      *
-     * Fired when action is added on card level. Note: Can be used only if `semanticRole` is `sap.f.cards.SemanticRole.ListItem`.
+     * Fired when action is added on card level. *Note**: Can be used only if `semanticRole` is `sap.f.cards.SemanticRole.ListItem`
+     * or the control is placed inside a `sap.f.GridContainer`.
      *
      * @experimental As of version 1.131.
      *
@@ -1572,7 +1597,8 @@ declare module "sap/f/CardBase" {
      * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
      * otherwise it will be bound to this `sap.f.CardBase` itself.
      *
-     * Fired when action is added on card level. Note: Can be used only if `semanticRole` is `sap.f.cards.SemanticRole.ListItem`.
+     * Fired when action is added on card level. *Note**: Can be used only if `semanticRole` is `sap.f.cards.SemanticRole.ListItem`
+     * or the control is placed inside a `sap.f.GridContainer`.
      *
      * @experimental As of version 1.131.
      *
@@ -1629,6 +1655,13 @@ declare module "sap/f/CardBase" {
      * @returns Returns the DOM Element that should get the focus
      */
     getFocusDomRef(): Element;
+    /**
+     * Returns the accessibility role for the `sap.f.GridContainer` item.
+     *
+     *
+     * @returns The accessibility role for the `sap.f.GridContainer` item
+     */
+    getGridItemRole(): string;
     /**
      * Gets current value of property {@link #getHeight height}.
      *
@@ -1643,7 +1676,8 @@ declare module "sap/f/CardBase" {
     /**
      * Gets current value of property {@link #getSemanticRole semanticRole}.
      *
-     * Defines the role of the Card Header.
+     * Defines the accessibility role of the control. *Note:** When the control is placed inside a `sap.f.GridContainer`,
+     * its accessibility role is overridden by the accessibility role specified by the `sap.f.GridContainer`.
      *
      * Default value is `Region`.
      *
@@ -1684,7 +1718,8 @@ declare module "sap/f/CardBase" {
     /**
      * Sets a new value for property {@link #getSemanticRole semanticRole}.
      *
-     * Defines the role of the Card Header.
+     * Defines the accessibility role of the control. *Note:** When the control is placed inside a `sap.f.GridContainer`,
+     * its accessibility role is overridden by the accessibility role specified by the `sap.f.GridContainer`.
      *
      * When called with a value of `null` or `undefined`, the default value of the property will be restored.
      *
@@ -1734,7 +1769,10 @@ declare module "sap/f/CardBase" {
     height?: CSSSize | PropertyBindingInfo | `{${string}}`;
 
     /**
-     * Defines the role of the Card Header.
+     * Defines the accessibility role of the control.
+     *
+     * **Note:** When the control is placed inside a `sap.f.GridContainer`, its accessibility role is overridden
+     * by the accessibility role specified by the `sap.f.GridContainer`.
      *
      * @experimental As of version 1.131.
      */
@@ -1744,7 +1782,10 @@ declare module "sap/f/CardBase" {
       | `{${string}}`;
 
     /**
-     * Fired when action is added on card level. Note: Can be used only if `semanticRole` is `sap.f.cards.SemanticRole.ListItem`.
+     * Fired when action is added on card level.
+     *
+     * **Note**: Can be used only if `semanticRole` is `sap.f.cards.SemanticRole.ListItem` or the control is
+     * placed inside a `sap.f.GridContainer`.
      *
      * @experimental As of version 1.131.
      */
@@ -11815,6 +11856,9 @@ declare module "sap/f/GridContainer" {
    * All rows have the same height and all columns have the same width. Their sizes can be configured with
    * the use of the `layout` aggregation and `{@link sap.f.GridContainerSettings}`.
    *
+   * **Note:** To ensure better keyboard and accessibility support, child items should implement `sap.f.IGridContainerItem`
+   * interface.
+   *
    * Usage:
    *
    * When to use

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare module "sap/fe/base/BuildingBlockBase" {
   import { default as Control, $ControlSettings } from "sap/ui/core/Control";

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

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare module "sap/fe/core/AppComponent" {
   import {
@@ -139,6 +139,8 @@ declare module "sap/fe/core/ExtensionAPI" {
 
   import Context1 from "sap/ui/model/odata/v4/Context";
 
+  import { WatcherCallback } from "sap/fe/core/controls/DataWatcher";
+
   /**
    * Common Extension API for all pages of SAP Fiori elements for OData V4.
    * To correctly integrate your app extension coding with SAP Fiori elements, use only the extensionAPI of
@@ -297,6 +299,19 @@ declare module "sap/fe/core/ExtensionAPI" {
      * @returns A promise that resolves with the new app state object.
      */
     updateAppState(): Promise<object | void>;
+    /**
+     * Watch a property from the main page context and trigger a callback when the value changes.
+     */
+    watchProperty(
+      /**
+       * The name of the property to watch
+       */
+      propertyName: string,
+      /**
+       * The callback to trigger when the value changes
+       */
+      callback: WatcherCallback
+    ): void;
   }
 }
 
@@ -1483,8 +1498,6 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
     ): void;
     /**
      * Retrieve the view state of this extensions view.
-     * When this function is called more than once before finishing, all but the final response will resolve
-     * to `undefined`.
      *
      *
      * @returns A promise resolving the view state
@@ -1514,6 +1527,13 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
   };
 }
 
+declare module "sap/fe/core/controls/DataWatcher" {
+  /**
+   * A callback function that is called when the value of the watched property changes.
+   */
+  export type WatcherCallback = {};
+}
+
 declare module "sap/fe/core/fpm/Component" {
   import AppComponent from "sap/fe/core/AppComponent";
 
@@ -1610,6 +1630,8 @@ declare namespace sap {
 
     "sap/fe/core/controllerextensions/ViewState": undefined;
 
+    "sap/fe/core/controls/DataWatcher": undefined;
+
     "sap/fe/core/ExtensionAPI": undefined;
 
     "sap/fe/core/fpm/Component": undefined;

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

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare module "sap/fe/macros/Chart" {
   import {
@@ -670,6 +670,52 @@ declare module "sap/fe/macros/RichTextEditorWithMetadata" {
   }
 }
 
+declare module "sap/fe/macros/Share" {
+  import {
+    default as BuildingBlock,
+    $BuildingBlockSettings,
+  } from "sap/fe/core/buildingBlocks/BuildingBlock";
+
+  import ShareOptions from "sap/fe/macros/share/ShareOptions";
+
+  /**
+   * 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
+   *
+   * <macros:Share
+   * id="someID"
+   * visible="true"
+   * />
+   * ```
+   *
+   * {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/features/shareDefault Overview of Building Blocks}
+   *
+   *
+   * @since 1.93.0
+   */
+  export default class Share extends BuildingBlock {}
+  /**
+   * Describes the settings that can be provided to the Share constructor.
+   */
+  export interface $ShareSettings extends $BuildingBlockSettings {
+    /**
+     * Supported Share options {@link sap.fe.macros.share.ShareOptions }.
+     */
+    shareOptions?: ShareOptions;
+  }
+}
+
 declare module "sap/fe/macros/VariantManagement" {
   import {
     default as BuildingBlock,
@@ -863,7 +909,7 @@ declare module "sap/fe/macros/chart/Chart" {
    * usage.
    *
    *
-   * @deprecated As of version now. As of version 1.130, use {@link sap.fe.macros.Chart } instead
+   * @deprecated As of version 1.130. Use {@link sap.fe.macros.Chart } instead
    * @experimental
    */
   export default class Chart extends Control {
@@ -1053,7 +1099,7 @@ declare module "sap/fe/macros/chart/Chart" {
   /**
    * Describes the settings that can be provided to the Chart constructor.
    *
-   * @deprecated As of version now. As of version 1.130, use {@link sap.fe.macros.Chart } instead
+   * @deprecated As of version 1.130. Use {@link sap.fe.macros.Chart } instead
    * @experimental
    */
   export interface $ChartSettings extends $ControlSettings {
@@ -1298,7 +1344,7 @@ declare module "sap/fe/macros/field/Field" {
      *
      * @returns The current value of the field
      */
-    getValue(): boolean | string | undefined;
+    getValue(): boolean | float | string | undefined;
     /**
      * Removes a message from the field.
      */
@@ -1475,7 +1521,7 @@ declare module "sap/fe/macros/field/FieldAPI" {
      *
      * @returns The current value of the field
      */
-    getValue(): boolean | string | undefined;
+    getValue(): boolean | float | string | undefined;
     /**
      * Removes a message from the field.
      */
@@ -1996,13 +2042,7 @@ declare module "sap/fe/macros/filterBar/FilterBarAPI" {
    * <macros:FilterBar id="MyFilterBar" metaPath="@com.sap.vocabularies.UI.v1.SelectionFields" />
    * ```
    */
-  export default class FilterBar
-    extends MacroAPI
-    implements
-      /* was: sap.fe.core.controllerextensions.viewState.IViewStateContributor */ Object
-  {
-    __implements__sap_fe_core_controllerextensions_viewState_IViewStateContributor: boolean;
-
+  export default class FilterBar extends MacroAPI {
     /**
      * Get the Active Filters Text Summary for the filter bar.
      *
@@ -2554,57 +2594,21 @@ declare module "sap/fe/macros/richtexteditor/Plugin" {
   }
 }
 
-declare module "sap/fe/macros/share/Share.block" {
-  import { default as Control, $ControlSettings } from "sap/ui/core/Control";
-
-  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
+declare module "sap/fe/macros/share/ShareOptions" {
+  import {
+    default as BuildingBlockObjectProperty,
+    $BuildingBlockObjectPropertySettings,
+  } from "sap/fe/macros/controls/BuildingBlockObjectProperty";
 
-  /**
-   * 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
-   *
-   * <macros:Share
-   * id="someID"
-   * visible="true"
-   * />
-   * ```
-   *
-   * {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/features/shareDefault Overview of Building Blocks}
-   *
-   *
-   * @since 1.93.0
-   */
-  export default class Share extends Control {}
   /**
    * Share Options.
    */
-  export type ShareOptions = {};
-
+  export default class ShareOptions extends BuildingBlockObjectProperty {}
   /**
-   * Describes the settings that can be provided to the Share constructor.
+   * Describes the settings that can be provided to the ShareOptions constructor.
    */
-  export interface $ShareSettings extends $ControlSettings {
-    /**
-     * Supported Share options {@link sap.fe.macros.share.ShareOptions }.
-     */
-    shareOptions?: object | PropertyBindingInfo | `{${string}}`;
-
-    /**
-     * Whether the share control should be visible on the screen.
-     */
-    visible?: boolean | PropertyBindingInfo | `{${string}}`;
-  }
+  export interface $ShareOptionsSettings
+    extends $BuildingBlockObjectPropertySettings {}
 }
 
 declare module "sap/fe/macros/table/Action" {
@@ -5131,7 +5135,9 @@ declare namespace sap {
 
     "sap/fe/macros/RichTextEditorWithMetadata": undefined;
 
-    "sap/fe/macros/share/Share.block": undefined;
+    "sap/fe/macros/Share": undefined;
+
+    "sap/fe/macros/share/ShareOptions": undefined;
 
     "sap/fe/macros/table/Action": undefined;
 

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare module "sap/fe/navigation/library" {
   /**

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

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

package/types/sap.fe.plugins.managecache.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare module "sap/fe/plugins/managecache/library" {}
 

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare module "sap/fe/templates/library" {}
 

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.133.0
+// For Library Version: 1.134.0
 
 declare module "sap/fe/test/library" {}
 

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

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

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

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