@sapui5/ts-types 1.125.0 → 1.126.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sapui5/ts-types",
-  "version": "1.125.0",
+  "version": "1.126.0",
   "description": "SAPUI5 TypeScript Definitions",
   "homepage": "https://ui5.sap.com",
   "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 namespace sap {
   /**

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.125.0
+// For Library Version: 1.126.0
 
 declare namespace sap {
   namespace ca {

package/types/sap.chart.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.125.0
+// For Library Version: 1.126.0
 
 declare namespace sap {
   /**

package/types/sap.collaboration.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.125.0
+// For Library Version: 1.126.0
 
 declare namespace sap {
   /**
@@ -78,18 +78,6 @@ declare namespace sap {
             mSettings?: sap.collaboration.components.feed.$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`.
@@ -125,53 +113,17 @@ declare namespace sap {
            */
           static getMetadata(): sap.ui.core.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.
+           * 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 init(): void;
+          createContent(): Promise<sap.ui.core.Control>;
           /**
-           * 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)
-           */
-          static onAfterRendering(): void;
-          /**
-           * 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: sap.suite.ui.commons.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`.
            *
@@ -195,6 +147,31 @@ declare namespace sap {
            * @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`.
            *
@@ -244,6 +221,15 @@ declare namespace sap {
              */
             oFeedSources: Record<string, any> | string[]
           ): this;
+          /**
+           * Sets all the properties passed in oSettings.
+           */
+          setSettings(
+            /**
+             * key/value map for settings
+             */
+            settings: Record<string, any>
+          ): void;
         }
       }
 
@@ -2084,12 +2070,6 @@ declare namespace sap {
             mSettings?: sap.collaboration.components.socialprofile.$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`.
@@ -2125,37 +2105,11 @@ declare namespace sap {
            */
           static getMetadata(): sap.ui.core.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
            *
@@ -2204,6 +2158,28 @@ declare namespace sap {
            * @returns the value of property `width`
            */
           getWidth(): sap.ui.core.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
            *
@@ -2268,6 +2244,16 @@ declare namespace sap {
              */
             sPlacement: sap.m.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,279 @@
+// For Library Version: 0.0.1
+
+declare namespace sap {
+  namespace cux {
+    namespace home {
+      /**
+       * Describes the settings that can be provided to the MenuItem constructor.
+       *
+       * @experimental (since 1.121)
+       */
+      interface $MenuItemSettings extends sap.ui.core.$ElementSettings {
+        /**
+         * Icon of the menu item.
+         */
+        icon?:
+          | sap.ui.core.URI
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
+
+        /**
+         * Title of the menu item.
+         */
+        title?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
+        /**
+         * Type of menu item visualization in the menu list
+         */
+        type?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
+      }
+
+      /**
+       * Parameters of the MenuItem#press event.
+       */
+      interface MenuItem$PressEventParameters {}
+
+      /**
+       * Container class for managing and storing Apps.
+       *
+       * @since 1.121
+       * @experimental (since 1.121)
+       */
+      class AppsContainer
+        extends /* was: sap.cux.home.BaseContainer */ Object {}
+      /**
+       * Panel class for managing and storing Cards.
+       *
+       * @since 1.122.0
+       * @experimental (since 1.122.0)
+       */
+      class CardsPanel extends /* was: sap.cux.home.BasePanel */ Object {}
+      /**
+       * Provides the class for managing frequent apps.
+       *
+       * @since 1.121.0
+       * @experimental (since 1.121.0)
+       */
+      class FrequentAppPanel
+        extends /* was: sap.cux.home.BaseAppPersPanel */ Object {}
+      /**
+       * Container class for managing and storing Insights tiles and cards.
+       *
+       * @since 1.121
+       * @experimental (since 1.121)
+       */
+      class InsightsContainer
+        extends /* was: sap.cux.home.BaseContainer */ Object {}
+      /**
+       * Layout class for My Home layout.
+       *
+       * @since 1.121
+       * @experimental (since 1.121)
+       */
+      class Layout extends /* was: sap.cux.home.BaseLayout */ Object {}
+      /**
+       * Class for managing and storing Menu items.
+       *
+       * @since 1.121
+       * @experimental (since 1.121)
+       */
+      class MenuItem extends sap.ui.core.Element {}
+      /**
+       * Container class for managing and storing News and Pages.
+       *
+       * @since 1.121
+       * @experimental (since 1.121)
+       */
+      class NewsAndPagesContainer
+        extends /* was: sap.cux.home.BaseContainer */ Object {}
+      /**
+       * Panel class for managing and storing News.
+       *
+       * @since 1.121
+       * @experimental (since 1.121)
+       */
+      class NewsPanel extends /* was: sap.cux.home.BaseNewsPanel */ Object {}
+      /**
+       * Panel class for managing and storing Pages.
+       *
+       * @since 1.122
+       * @experimental (since 1.122)
+       */
+      class PagePanel extends /* was: sap.cux.home.BasePagePanel */ Object {}
+      /**
+       * Provides class for managing Recent apps.
+       *
+       * @since 1.121.0
+       * @experimental (since 1.121.0)
+       */
+      class RecentAppPanel
+        extends /* was: sap.cux.home.BaseAppPersPanel */ Object {}
+      /**
+       * Panel class for managing and storing Situation cards.
+       *
+       * @since 1.121
+       * @experimental (since 1.121)
+       */
+      class SituationPanel
+        implements /* was: sap.cux.home.ToDoPanel.IToDoPanel */ Object
+      {
+        __implements__sap_cux_home_ToDoPanel_IToDoPanel: boolean;
+      }
+      /**
+       * Panel class for managing and storing Task cards.
+       *
+       * @since 1.121
+       * @experimental (since 1.121)
+       */
+      class TaskPanel
+        implements /* was: sap.cux.home.ToDoPanel.IToDoPanel */ Object
+      {
+        __implements__sap_cux_home_ToDoPanel_IToDoPanel: boolean;
+      }
+      /**
+       * Tiles Panel class for managing and storing Tiles.
+       *
+       * @since 1.122.0
+       * @experimental (since 1.122.0)
+       */
+      class TilesPanel extends /* was: sap.cux.home.BasePanel */ Object {}
+      /**
+       * Abstract Panel class for managing and storing To-Do cards.
+       *
+       * @since 1.121
+       * @experimental (since 1.121)
+       */
+      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: sap.ui.model.Context
+        ): sap.ui.core.Control;
+      }
+      /**
+       * Container class for managing and storing To-Do cards.
+       *
+       * @since 1.121
+       * @experimental (since 1.121)
+       */
+      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>;
+      }
+      /**
+       * Supported Layout Types for {@link sap.cux.home.BaseContainer }.
+       *
+       * @since 1.121
+       * @experimental (since 1.121)
+       */
+      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)
+       */
+      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",
+      }
+      /**
+       * Event object of the MenuItem#press event.
+       */
+      type MenuItem$PressEvent = sap.ui.base.Event<
+        MenuItem$PressEventParameters,
+        MenuItem
+      >;
+    }
+  }
+
+  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;
+  }
+}