@sapui5/ts-types-esm 1.128.1 → 1.129.0

package/types/sap.ushell.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.128.1
+// For Library Version: 1.129.0
 
 declare module "sap/ushell/library" {
   /**
@@ -13481,7 +13481,178 @@ declare module "sap/ushell/ui/tile/StaticTile" {
   }
 }
 
-declare module "sap/ushell/ui5service/_ShellUIService/shelluiservice.class.factory" {
+declare module "sap/ushell/ui5service/ShellUIService" {
+  import Metadata from "sap/ui/base/Metadata";
+
+  /**
+   * The ShellUIService for the unified shell can be used to modify the app title or the app hierarchy.
+   *
+   * Usage:
+   *
+   * Allows apps to interact with the SAP Fiori launchpad UI. A defined service is injected in the app components
+   * by the FLP before the corresponding apps start. To consume the service, app components should declare
+   * it in their "manifest.json" as follows:
+   *
+   *
+   * ```javascript
+   *
+   * {
+   *    ...
+   *    "sap.ui5": {
+   *       "services" : {
+   *          "ShellUIService": {
+   *              "factoryName": "sap.ushell.ui5service.ShellUIService"
+   *          }
+   *       }
+   *    }
+   *    ...
+   * }
+   * ```
+   *
+   *
+   * The service can then be retrieved and consumed by the app component as in the following example:
+   *
+   *
+   * ```javascript
+   *
+   * // Component.js (the app component)
+   * ...
+   * this.getService("ShellUIService") // promise is returned
+   *     .then(function (oService) {
+   *         oService.setTitle("Application Title");
+   *     })
+   *     .catch(function (oError) {
+   *         Log.error("Cannot get ShellUIService", oError, "my.app.Component");
+   *     });
+   * ...
+   * ```
+   *
+   *
+   * The ShellUIService can also be used within nested components. Every component receives a separate instance
+   * of the service. All service instances are independent and do not share any state. With this they can
+   * also overwrite each other's settings. Nested components have to define the service in their own manifest
+   * as well.
+   *
+   * **Note:** The ShellUIService is intended for use by applications only and should not be used by plugins.
+   *
+   * Auto Title and Hierarchy:
+   *
+   * The ShellUIService can work together with the routing defined in a UI5 app to set title and hierarchy
+   * automatically, as the navigation within the app occurs. This can be achieved by enabling the ShellUIService
+   * to load instantly and configuring one or both `setTitle` and `setHierarchy` options to `auto` in the
+   * app manifest. Using this mechanism disables the API to manually set the title or hierarchy via `setTitle`
+   * and `setHierarchy`.
+   *
+   *
+   * ```javascript
+   *
+   * {
+   *    "sap.ui5": {
+   *       "services" : {
+   *          "ShellUIService": {
+   *              "lazy": false,
+   *              "factoryName": "sap.ushell.ui5service.ShellUIService",
+   *              "settings": {
+   *                  "setHierarchy": "auto",
+   *                  "setTitle": "auto"
+   *              }
+   *          }
+   *       }
+   *    }
+   * }
+   * ```
+   *
+   *
+   * **Note:** Please be aware that the sapFiori2Adaptation configuration of the application may cause the
+   * ShellUIService service to work incorrectly. We recommend to disable the sapFiori2Adaptation configuration
+   * for the new applications if you use the ShellUIService.
+   *
+   * @since 1.38.0
+   */
+  export default class ShellUIService
+    extends /* was: sap.ui.core.service.Service */ Object
+  {
+    /**
+     * @ui5-protected Do not call from applications (only from related classes in the framework)
+     */
+    protected constructor();
+
+    /**
+     * Creates a new subclass of class sap.ushell.ui5service.ShellUIService with name `sClassName` and enriches
+     * it with the information contained in `oClassInfo`.
+     *
+     * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.service.Service.extend}.
+     *
+     *
+     * @returns Created class / constructor function
+     */
+    static extend<T extends Record<string, unknown>>(
+      /**
+       * Name of the class being created
+       */
+      sClassName: string,
+      /**
+       * Object literal with information about the class
+       */
+      oClassInfo?: sap.ClassInfo<T, ShellUIService>,
+      /**
+       * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
+       * used by this class
+       */
+      FNMetaImpl?: Function
+    ): Function;
+    /**
+     * Returns a metadata object for class sap.ushell.ui5service.ShellUIService.
+     *
+     *
+     * @returns Metadata object describing this class
+     */
+    static getMetadata(): Metadata;
+    /**
+     * Returns the current title shown in the header. This might differ from the title set by the via {@link #setTitle}.
+     *
+     * @since 1.38.0
+     *
+     * @returns The current title.
+     */
+    getTitle(): string;
+    /**
+     * Displays the given hierarchy in the shell header. The default app hierarchy is applied if no parameter
+     * is given.
+     *
+     * @since 1.38.0
+     */
+    setHierarchy(
+      /**
+       * An array representing hierarchies of the currently displayed app.
+       */
+      aHierarchyLevels?: AppInfo[]
+    ): void;
+    /**
+     * Used by apps to set related apps. This setting is propagated towards the Shell Header via corresponding
+     * events.
+     *
+     * @since 1.40.0
+     */
+    setRelatedApps(
+      /**
+       * An array of related apps.
+       */
+      aRelatedApps?: AppInfo[]
+    ): void;
+    /**
+     * Displays the given title in the shell header. This method should not be called if the app calling the
+     * method is not currently displayed in the Fiori Launchpad.
+     *
+     * @since 1.38.0
+     */
+    setTitle(
+      /**
+       * The new title. The default title is set if this argument is not given.
+       */
+      sTitle?: string
+    ): void;
+  }
   /**
    * Defines essential information about an app.
    *
@@ -13734,181 +13905,19 @@ declare namespace sap {
         protected constructor();
       }
     }
-
-    namespace ui5service {
-      /**
-       * The Unified Shell's ShellUIService service.
-       *
-       * Allows apps to interact with the Fiori Launchpad UI. The service is injected in the app components by
-       * the FLP renderer before the corresponding apps start. To consume the service, app components should declare
-       * it in their "manifest.json" as follows:
-       * ```javascript
-       *
-       * {
-       *    ...
-       *    "sap.ui5": {
-       *       "services" : {
-       *          "ShellUIService": {
-       *              "factoryName": "sap.ushell.ui5service.ShellUIService"
-       *          }
-       *       }
-       *    }
-       *    ...
-       * }
-       * ```
-       *
-       *
-       * The service can be then retrieved and consumed from the app root component as in the following example:
-       *
-       * ```javascript
-       *
-       * // Component.js (the app root component)
-       * ...
-       * this.getService("ShellUIService").then( // promise is returned
-       *    function (oService) {
-       *       oService.setTitle("Application Title");
-       *    },
-       *    function (oError) {
-       *       Log.error("Cannot get ShellUIService", oError, "my.app.Component");
-       *    }
-       * );
-       * ...
-       * ```
-       *
-       *
-       * The ShellUIService can work together with the routing defined in a UI5 app to set title and hierarchy
-       * automatically, as the navigation within the app occurs. This can be achieved by enabling the ShellUIService
-       * to load instantly and configuring one or both `setTitle` and `setHierarchy` options to `auto` in the
-       * app manifest, as shown in the example below:
-       *
-       *
-       * ```javascript
-       *
-       * {
-       *    "sap.ui5": {
-       *       "services" : {
-       *          "ShellUIService": {
-       *              "lazy": false,
-       *              "factoryName": "sap.ushell.ui5service.ShellUIService",
-       *              "settings": {
-       *                  "setHierarchy": "auto",
-       *                  "setTitle": "auto"
-       *              }
-       *          }
-       *       }
-       *    }
-       * }
-       * ```
-       *
-       *
-       * Note that the `setHierarchy` or `setTitle` methods should not be actively called by the application when
-       * title and hierarchy are set automatically.
-       *
-       * **Note:** Please be aware that the sapFiori2Adaptation configuration of the application may cause the
-       * ShellUIService service to work incorrectly. We recommend to disable the sapFiori2Adaptation configuration
-       * for the new applications if you use ShellUIService.
-       *
-       * @since 1.38.0
-       */
-      class ShellUIService
-        extends /* was: sap.ui.core.service.Service */ Object
-      {
-        /**
-         * @ui5-protected Do not call from applications (only from related classes in the framework)
-         */
-        protected constructor();
-
-        /**
-         * Creates a new subclass of class sap.ushell.ui5service.ShellUIService with name `sClassName` and enriches
-         * it with the information contained in `oClassInfo`.
-         *
-         * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.service.Service.extend}.
-         *
-         *
-         * @returns Created class / constructor function
-         */
-        static extend<T extends Record<string, unknown>>(
-          /**
-           * Name of the class being created
-           */
-          sClassName: string,
-          /**
-           * Object literal with information about the class
-           */
-          oClassInfo?: ClassInfo<T, ShellUIService>,
-          /**
-           * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
-           * used by this class
-           */
-          FNMetaImpl?: Function
-        ): Function;
-        /**
-         * Returns a metadata object for class sap.ushell.ui5service.ShellUIService.
-         *
-         *
-         * @returns Metadata object describing this class
-         */
-        static getMetadata(): import("sap/ui/base/Metadata").default;
-        /**
-         * Returns the title that was last set via {@link setTitle}.
-         *
-         * @since 1.38.0
-         *
-         * @returns The title that was last set via {@link setTitle}.
-         */
-        getTitle(): string;
-        /**
-         * Displays the given hierarchy in the shell header.
-         *
-         * @since 1.38.0
-         */
-        setHierarchy(
-          /**
-           * An array representing hierarchies of the currently displayed app.
-           *
-           * The default app hierarchy is applied if no parameter is given.
-           */
-          aHierarchyLevels?: Array<
-            import("sap/ushell/ui5service/_ShellUIService/shelluiservice.class.factory").AppInfo
-          >
-        ): void;
-        /**
-         * Used by apps to set related apps. This setting is propagated towards the Shell Header via corresponding
-         * events.
-         *
-         * @since 1.40.0
-         */
-        setRelatedApps(
-          /**
-           * An array of related apps.
-           */
-          aRelatedApps?: Array<
-            import("sap/ushell/ui5service/_ShellUIService/shelluiservice.class.factory").AppInfo
-          >
-        ): void;
-        /**
-         * Displays the given title in the shell header. This method should not be called if the app calling the
-         * method is not currently displayed in the Fiori Launchpad.
-         *
-         * @since 1.38.0
-         */
-        setTitle(
-          /**
-           * The new title. The default title is set if this argument is not given.
-           */
-          sTitle?: string
-        ): void;
-      }
-    }
   }
 
   interface IUI5DefineDependencyNames {
+    "sap/ushell/api/Copilot": undefined;
+
     "sap/ushell/api/Inbox": undefined;
 
     "sap/ushell/api/NewExperience": undefined;
 
     "sap/ushell/api/RTA": undefined;
 
+    "sap/ushell/api/S4MyHome": undefined;
+
     "sap/ushell/api/workpage/Designtime": undefined;
 
     "sap/ushell/api/workpage/Runtime": undefined;
@@ -14025,6 +14034,8 @@ declare namespace sap {
 
     "sap/ushell/services/UsageAnalytics": undefined;
 
+    "sap/ushell/services/UserDefaultParameters": undefined;
+
     "sap/ushell/services/UserInfo": undefined;
 
     "sap/ushell/services/UserRecents": undefined;
@@ -14053,7 +14064,9 @@ declare namespace sap {
 
     "sap/ushell/ui/tile/StaticTile": undefined;
 
-    "sap/ushell/ui5service/_ShellUIService/shelluiservice.class.factory": undefined;
+    "sap/ushell/ui5service/ShellUIService": undefined;
+
+    "sap/ushell/ui5service/ShellUIServiceFactory": undefined;
 
     "sap/ushell/ui5service/UserStatus": undefined;
 

package/types/sap.ushell_abap.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.128.1
+// For Library Version: 1.129.0
 
 declare namespace sap {
   interface IUI5DefineDependencyNames {

package/types/sap.uxap.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.128.0
+// For Library Version: 1.129.0
 
 declare module "sap/uxap/library" {
   /**

package/types/sap.viz.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.128.0
+// For Library Version: 1.129.0
 
 declare module "sap/viz/library" {
   export namespace ui5 {

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

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.128.0
+// For Library Version: 1.129.0
 
 declare module "sap/zen/commons/library" {}
 

package/types/sap.zen.crosstab.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.128.0
+// For Library Version: 1.129.0
 
 declare module "sap/zen/crosstab/library" {}
 

package/types/sap.zen.dsh.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.128.0
+// For Library Version: 1.129.0
 
 declare module "sap/zen/dsh/library" {}