@sapui5/types 1.125.0 → 1.126.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sapui5/types",
-  "version": "1.125.0",
+  "version": "1.126.0",
   "description": "SAPUI5 TypeScript Definitions",
   "homepage": "https://sap.github.io/ui5-typescript/",
   "author": "SAP SE (https://www.sap.com)",

package/types/index.d.ts

@@ -39,6 +39,7 @@
 /// <reference path="./sap.ovp.d.ts"/>
 /// <reference path="./sap.ui.richtexteditor.d.ts"/>
 /// <reference path="./sap.ui.rta.d.ts"/>
+/// <reference path="./sap.cux.home.d.ts"/>
 /// <reference path="./sap.esh.search.ui.d.ts"/>
 /// <reference path="./sap.fe.base.d.ts"/>
 /// <reference path="./sap.fe.core.d.ts"/>

package/types/sap.apf.d.ts

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

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

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

package/types/sap.chart.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.125.0
+// For Library Version: 1.126.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.125.0
+// For Library Version: 1.126.0
 
 declare module "sap/collaboration/library" {
   /**
@@ -102,6 +102,8 @@ declare module "sap/collaboration/components/feed/Component" {
 
   import { IAsyncContentCreation, ID } from "sap/ui/core/library";
 
+  import Control from "sap/ui/core/Control";
+
   import { TimelineAxisOrientation } from "sap/suite/ui/commons/library";
 
   import ComponentMetadata from "sap/ui/core/ComponentMetadata";
@@ -158,18 +160,6 @@ declare module "sap/collaboration/components/feed/Component" {
       mSettings?: $ComponentSettings
     );
 
-    /**
-     * The method to create the Content (UI Control Tree) of the Component.
-     *
-     * @ui5-protected Do not call from applications (only from related classes in the framework)
-     */
-    static createContent(): void;
-    /**
-     * Cleans up the component instance before destruction.
-     *
-     * @ui5-protected Do not call from applications (only from related classes in the framework)
-     */
-    static exit(): void;
     /**
      * Creates a new subclass of class sap.collaboration.components.feed.Component with name `sClassName` and
      * enriches it with the information contained in `oClassInfo`.
@@ -202,55 +192,17 @@ declare module "sap/collaboration/components/feed/Component" {
      */
     static getMetadata(): ComponentMetadata;
     /**
-     * Returns the selected Group.
-     *
-     *
-     * @returns a map containing information about the selected Group (e.g. Id, Name, etc...)
-     */
-    static getSelectedGroup(): Record<string, any>;
-    /**
-     * Initializes the Component instance after creation.
-     *
-     * @ui5-protected Do not call from applications (only from related classes in the framework)
-     */
-    static init(): void;
-    /**
-     * Function is called when the rendering of the Component Container is completed.
+     * The method to create the Content (UI Control Tree) of the Component.
      *
      * @ui5-protected Do not call from applications (only from related classes in the framework)
      */
-    static onAfterRendering(): void;
+    createContent(): Promise<Control>;
     /**
-     * Function is called when the rendering of the Component Container is started.
+     * Cleans up the component instance before destruction.
      *
      * @ui5-protected Do not call from applications (only from related classes in the framework)
      */
-    static onBeforeRendering(): void;
-    /**
-     * Set the axis orientation for the Timeline.
-     */
-    static setAxisOrientation(
-      axisOrientation:
-        | TimelineAxisOrientation
-        | keyof typeof TimelineAxisOrientation
-    ): void;
-    /**
-     * Sets the enableScroll property for the Timeline.
-     */
-    static setEnableScroll(enableScroll: boolean): void;
-    /**
-     * Sets the sources for the feed. Array of strings representing the Jam group IDs (e.g. ["groupid1", "groupid2"]).
-     */
-    static setFeedSources(feedSources: object): void;
-    /**
-     * Sets all the properties passed in oSettings.
-     */
-    static setSettings(
-      /**
-       * key/value map for settings
-       */
-      settings: Record<string, any>
-    ): void;
+    exit(): void;
     /**
      * Getter for property `axisOrientation`.
      *
@@ -276,6 +228,31 @@ declare module "sap/collaboration/components/feed/Component" {
      * @returns the value of property `feedSources`
      */
     getFeedSources(): Record<string, any> | string[];
+    /**
+     * Returns the selected Group.
+     *
+     *
+     * @returns a map containing information about the selected Group (e.g. Id, Name, etc...)
+     */
+    getSelectedGroup(): Record<string, any>;
+    /**
+     * Initializes the Component instance after creation.
+     *
+     * @ui5-protected Do not call from applications (only from related classes in the framework)
+     */
+    init(): void;
+    /**
+     * Function is called when the rendering of the Component Container is completed.
+     *
+     * @ui5-protected Do not call from applications (only from related classes in the framework)
+     */
+    onAfterRendering(): void;
+    /**
+     * Function is called when the rendering of the Component Container is started.
+     *
+     * @ui5-protected Do not call from applications (only from related classes in the framework)
+     */
+    onBeforeRendering(): void;
     /**
      * Setter for property `axisOrientation`.
      *
@@ -327,6 +304,15 @@ declare module "sap/collaboration/components/feed/Component" {
        */
       oFeedSources: Record<string, any> | string[]
     ): this;
+    /**
+     * Sets all the properties passed in oSettings.
+     */
+    setSettings(
+      /**
+       * key/value map for settings
+       */
+      settings: Record<string, any>
+    ): void;
   }
   /**
    * Describes the settings that can be provided to the Component constructor.
@@ -2120,12 +2106,6 @@ declare module "sap/collaboration/components/socialprofile/Component" {
       mSettings?: $ComponentSettings
     );
 
-    /**
-     * Cleans up the component instance before destruction. [borrowed from sap.ui.core.Component]
-     *
-     * @ui5-protected Do not call from applications (only from related classes in the framework)
-     */
-    static exit(): void;
     /**
      * Creates a new subclass of class sap.collaboration.components.socialprofile.Component with name `sClassName`
      * and enriches it with the information contained in `oClassInfo`.
@@ -2158,37 +2138,11 @@ declare module "sap/collaboration/components/socialprofile/Component" {
      */
     static getMetadata(): ComponentMetadata;
     /**
-     * Initializes the Component instance after creation. [borrowed from sap.ui.core.UIComponent]
-     *
-     * @ui5-protected Do not call from applications (only from related classes in the framework)
-     */
-    static init(): void;
-    /**
-     * Function is called when the rendering of the Component Container is completed. [borrowed from sap.ui.core.UIComponent]
-     *
-     * @ui5-protected Do not call from applications (only from related classes in the framework)
-     */
-    static onAfterRendering(): void;
-    /**
-     * Function is called when the rendering of the Component Container is started. [borrowed from sap.ui.core.UIComponent]
+     * Cleans up the component instance before destruction. [borrowed from sap.ui.core.Component]
      *
      * @ui5-protected Do not call from applications (only from related classes in the framework)
      */
-    static onBeforeRendering(): void;
-    /**
-     * Opens the social profile component
-     */
-    static open(): void;
-    /**
-     * Setter for the Component settings
-     */
-    static setSettings(
-      /**
-       * A JSON object used to set the component settings, this object should contains the same properties used
-       * in the constructor
-       */
-      oSettings: object
-    ): void;
+    exit(): void;
     /**
      * Getter for property `height`. Gets the height of the Social Profile
      *
@@ -2237,6 +2191,28 @@ declare module "sap/collaboration/components/socialprofile/Component" {
      * @returns the value of property `width`
      */
     getWidth(): CSSSize;
+    /**
+     * Initializes the Component instance after creation. [borrowed from sap.ui.core.UIComponent]
+     *
+     * @ui5-protected Do not call from applications (only from related classes in the framework)
+     */
+    init(): void;
+    /**
+     * Function is called when the rendering of the Component Container is completed. [borrowed from sap.ui.core.UIComponent]
+     *
+     * @ui5-protected Do not call from applications (only from related classes in the framework)
+     */
+    onAfterRendering(): void;
+    /**
+     * Function is called when the rendering of the Component Container is started. [borrowed from sap.ui.core.UIComponent]
+     *
+     * @ui5-protected Do not call from applications (only from related classes in the framework)
+     */
+    onBeforeRendering(): void;
+    /**
+     * Opens the social profile component
+     */
+    open(): void;
     /**
      * Setter for property `height`. Sets the height of the Social Profile
      *
@@ -2301,6 +2277,16 @@ declare module "sap/collaboration/components/socialprofile/Component" {
        */
       sPlacement: PlacementType | keyof typeof PlacementType
     ): this;
+    /**
+     * Setter for the Component settings
+     */
+    setSettings(
+      /**
+       * A JSON object used to set the component settings, this object should contains the same properties used
+       * in the constructor
+       */
+      oSettings: object
+    ): void;
     /**
      * Setter for property `width`. Sets the width of the Social Profile
      *

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

@@ -0,0 +1,336 @@
+// For Library Version: 0.0.1
+
+declare module "sap/cux/home/AppsContainer" {
+  /**
+   * Container class for managing and storing Apps.
+   *
+   * @since 1.121
+   * @experimental (since 1.121)
+   */
+  export default class AppsContainer
+    extends /* was: sap.cux.home.BaseContainer */ Object {}
+}
+
+declare module "sap/cux/home/CardsPanel" {
+  /**
+   * Panel class for managing and storing Cards.
+   *
+   * @since 1.122.0
+   * @experimental (since 1.122.0)
+   */
+  export default class CardsPanel
+    extends /* was: sap.cux.home.BasePanel */ Object {}
+}
+
+declare module "sap/cux/home/FrequentAppPanel" {
+  /**
+   * Provides the class for managing frequent apps.
+   *
+   * @since 1.121.0
+   * @experimental (since 1.121.0)
+   */
+  export default class FrequentAppPanel
+    extends /* was: sap.cux.home.BaseAppPersPanel */ Object {}
+}
+
+declare module "sap/cux/home/InsightsContainer" {
+  /**
+   * Container class for managing and storing Insights tiles and cards.
+   *
+   * @since 1.121
+   * @experimental (since 1.121)
+   */
+  export default class InsightsContainer
+    extends /* was: sap.cux.home.BaseContainer */ Object {}
+}
+
+declare module "sap/cux/home/Layout" {
+  /**
+   * Layout class for My Home layout.
+   *
+   * @since 1.121
+   * @experimental (since 1.121)
+   */
+  export default class Layout
+    extends /* was: sap.cux.home.BaseLayout */ Object {}
+}
+
+declare module "sap/cux/home/library" {
+  /**
+   * Supported Layout Types for {@link sap.cux.home.BaseContainer }.
+   *
+   * @since 1.121
+   * @experimental (since 1.121)
+   */
+  export enum LayoutType {
+    /**
+     * Panels are rendered horizontally example pages and news
+     */
+    Horizontal = "undefined",
+    /**
+     * Panels are rendered side by side example todos and situaions, fav, recent and frequent apps
+     */
+    SideBySide = "undefined",
+    /**
+     * Panels are rendered vertically example insights cards and tiles
+     */
+    Vertical = "undefined",
+  }
+  /**
+   * Supported News Types for {@link sap.cux.home.NewsPanel }.
+   *
+   * @since 1.121
+   * @experimental (since 1.121)
+   */
+  export enum NewsType {
+    /**
+     * News is of type Custom news feed
+     */
+    Custom = "undefined",
+    /**
+     * Url is of type feed
+     */
+    Feed = "undefined",
+    /**
+     * Url is of type RSS
+     */
+    RSS = "undefined",
+  }
+}
+
+declare module "sap/cux/home/MenuItem" {
+  import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
+
+  import { URI } from "sap/ui/core/library";
+
+  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
+
+  import Event from "sap/ui/base/Event";
+
+  /**
+   * Class for managing and storing Menu items.
+   *
+   * @since 1.121
+   * @experimental (since 1.121)
+   */
+  export default class MenuItem extends UI5Element {}
+  /**
+   * Describes the settings that can be provided to the MenuItem constructor.
+   *
+   * @experimental (since 1.121)
+   */
+  export interface $MenuItemSettings extends $ElementSettings {
+    /**
+     * Icon of the menu item.
+     */
+    icon?: URI | PropertyBindingInfo | `{${string}}`;
+
+    /**
+     * Title of the menu item.
+     */
+    title?: string | PropertyBindingInfo;
+
+    /**
+     * Type of menu item visualization in the menu list
+     */
+    type?: string | PropertyBindingInfo;
+  }
+
+  /**
+   * Parameters of the MenuItem#press event.
+   */
+  export interface MenuItem$PressEventParameters {}
+
+  /**
+   * Event object of the MenuItem#press event.
+   */
+  export type MenuItem$PressEvent = Event<
+    MenuItem$PressEventParameters,
+    MenuItem
+  >;
+}
+
+declare module "sap/cux/home/NewsAndPagesContainer" {
+  /**
+   * Container class for managing and storing News and Pages.
+   *
+   * @since 1.121
+   * @experimental (since 1.121)
+   */
+  export default class NewsAndPagesContainer
+    extends /* was: sap.cux.home.BaseContainer */ Object {}
+}
+
+declare module "sap/cux/home/NewsPanel" {
+  /**
+   * Panel class for managing and storing News.
+   *
+   * @since 1.121
+   * @experimental (since 1.121)
+   */
+  export default class NewsPanel
+    extends /* was: sap.cux.home.BaseNewsPanel */ Object {}
+}
+
+declare module "sap/cux/home/PagePanel" {
+  /**
+   * Panel class for managing and storing Pages.
+   *
+   * @since 1.122
+   * @experimental (since 1.122)
+   */
+  export default class PagePanel
+    extends /* was: sap.cux.home.BasePagePanel */ Object {}
+}
+
+declare module "sap/cux/home/RecentAppPanel" {
+  /**
+   * Provides class for managing Recent apps.
+   *
+   * @since 1.121.0
+   * @experimental (since 1.121.0)
+   */
+  export default class RecentAppPanel
+    extends /* was: sap.cux.home.BaseAppPersPanel */ Object {}
+}
+
+declare module "sap/cux/home/SituationPanel" {
+  /**
+   * Panel class for managing and storing Situation cards.
+   *
+   * @since 1.121
+   * @experimental (since 1.121)
+   */
+  export default class SituationPanel
+    implements /* was: sap.cux.home.ToDoPanel.IToDoPanel */ Object
+  {
+    __implements__sap_cux_home_ToDoPanel_IToDoPanel: boolean;
+  }
+}
+
+declare module "sap/cux/home/TaskPanel" {
+  /**
+   * Panel class for managing and storing Task cards.
+   *
+   * @since 1.121
+   * @experimental (since 1.121)
+   */
+  export default class TaskPanel
+    implements /* was: sap.cux.home.ToDoPanel.IToDoPanel */ Object
+  {
+    __implements__sap_cux_home_ToDoPanel_IToDoPanel: boolean;
+  }
+}
+
+declare module "sap/cux/home/TilesPanel" {
+  /**
+   * Tiles Panel class for managing and storing Tiles.
+   *
+   * @since 1.122.0
+   * @experimental (since 1.122.0)
+   */
+  export default class TilesPanel
+    extends /* was: sap.cux.home.BasePanel */ Object {}
+}
+
+declare module "sap/cux/home/ToDoPanel" {
+  import Context from "sap/ui/model/Context";
+
+  import Control from "sap/ui/core/Control";
+
+  /**
+   * Abstract Panel class for managing and storing To-Do cards.
+   *
+   * @since 1.121
+   * @experimental (since 1.121)
+   */
+  export default class ToDoPanel
+    extends /* was: sap.cux.home.BasePanel */ Object
+    implements /* was: sap.cux.home.ToDoPanel.IToDoPanel */ Object
+  {
+    __implements__sap_cux_home_ToDoPanel_IToDoPanel: boolean;
+
+    /**
+     * Generate a default card template for the Current Panel.
+     * An extended panel can have it's own template by overridding
+     * this method and providing a custom card template.
+     *
+     *
+     * @returns The generated card template.
+     */
+    generateCardTemplate(
+      /**
+       * The ID for the template.
+       */
+      id: string,
+      /**
+       * The context for the template.
+       */
+      context: Context
+    ): Control;
+  }
+}
+
+declare module "sap/cux/home/ToDosContainer" {
+  /**
+   * Container class for managing and storing To-Do cards.
+   *
+   * @since 1.121
+   * @experimental (since 1.121)
+   */
+  export default class ToDosContainer
+    extends /* was: sap.cux.home.BaseContainer */ Object
+  {
+    /**
+     * Gets the selected key of the ToDosContainer.
+     * If no selected key is set, it defaults to the first item.
+     *
+     *
+     * @returns The selected key.
+     */
+    getSelectedKey(): string;
+    /**
+     * Asynchronously refreshes the section by forcing all inner panels to be reloaded.
+     *
+     *
+     * @returns A promise that resolves when the section is successfully refreshed.
+     */
+    refreshData(): Promise<void>;
+  }
+}
+
+declare namespace sap {
+  interface IUI5DefineDependencyNames {
+    "sap/cux/home/AppsContainer": undefined;
+
+    "sap/cux/home/CardsPanel": undefined;
+
+    "sap/cux/home/FrequentAppPanel": undefined;
+
+    "sap/cux/home/InsightsContainer": undefined;
+
+    "sap/cux/home/Layout": undefined;
+
+    "sap/cux/home/library": undefined;
+
+    "sap/cux/home/MenuItem": undefined;
+
+    "sap/cux/home/NewsAndPagesContainer": undefined;
+
+    "sap/cux/home/NewsPanel": undefined;
+
+    "sap/cux/home/PagePanel": undefined;
+
+    "sap/cux/home/RecentAppPanel": undefined;
+
+    "sap/cux/home/SituationPanel": undefined;
+
+    "sap/cux/home/TaskPanel": undefined;
+
+    "sap/cux/home/TilesPanel": undefined;
+
+    "sap/cux/home/ToDoPanel": undefined;
+
+    "sap/cux/home/ToDosContainer": undefined;
+  }
+}