@sapui5/ts-types 1.151.1 → 1.153.0

package/types/sap.ushell.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.151.1
+// For Library Version: 1.153.0
 
 declare namespace sap {
   /**
@@ -893,8 +893,8 @@ declare namespace sap {
         };
 
         /**
-         * A target describing the intent: #-~?&/
-         * **Note:** The intent shall not exceed 512 bytes when serialized as UTF-8.
+         * A target describing the intent: #-?&/ **Note:** The
+         * intent shall not exceed 512 bytes when serialized as UTF-8.
          */
         type Target = {
           /**
@@ -910,10 +910,6 @@ declare namespace sap {
              * The action part of the intent.
              */
             action?: string;
-            /**
-             * The contextRaw part of the intent without the '~' prefix.
-             */
-            contextRaw?: string;
             /**
              * The entire intent including parameters and appSpecificRoute.
              * **Note:** If set all other parameters are ignored.
@@ -2779,10 +2775,6 @@ declare namespace sap {
            * the action
            */
           action: string;
-          /**
-           * the raw context string
-           */
-          contextRaw: string;
           /**
            * the parameters
            */
@@ -2849,10 +2841,6 @@ declare namespace sap {
              * the action
              */
             action: string;
-            /**
-             * the raw context string
-             */
-            contextRaw: string;
           };
           /**
            * the parameters
@@ -6495,7 +6483,7 @@ declare namespace sap {
          * @deprecated As of version 1.119. Please use {@link sap.ushell.services.NotificationsV2#executeBulkAction }
          * instead.
          *
-         * @returns Promise object that on success resolves to undefined or it is rejected with failed notifications
+         * @returns Resolves to undefined on success or is rejected with failed notifications
          */
         executeBulkAction(
           /**
@@ -6506,7 +6494,7 @@ declare namespace sap {
            * The ID of the action that is being executed
            */
           sActionId: string
-        ): Promise<any>;
+        ): jQuery.Promise;
         /**
          * Returns the notifications of the user sorted by type include the group headers and the notifications
          *
@@ -7382,15 +7370,54 @@ declare namespace sap {
         getTransientPersonalizer(): Promise<sap.ushell.services.PersonalizationV2.TransientPersonalizer>;
       }
       /**
-       * Abstract base class for ushell services. For details, see {@link sap.ushell.Container#getServiceAsync}.
+       * Abstract base interface for ushell services. For details, see {@link sap.ushell.Container#getServiceAsync}.
        *
        * @since 1.121.0
        */
-      abstract class Service {
+      class Service {
+        /**
+         * See:
+         * 	sap.ushell.Container.getServiceAsync
+         */
+        constructor();
+      }
+      /**
+       * The Unified Shell's session handler service. Manages the timeout of an FLP session:
+       * 	 - Announces user activity to the platform (via the UShell container service).
+       * 	 - Maintains user activity data in local storage to support multi-browser-tab use cases.
+       * 	 - Notifies the user once the session is about to end, offering the option to extend the session.
+       *
+       * **Note:** To retrieve a valid instance of this service, it is necessary to call {@link sap.ushell.Container#getServiceAsync}.
+       *
+       * ```javascript
+       *
+       *   sap.ui.require(["sap/ushell/Container"], async function (Container) {
+       *     const SessionHandler = await Container.getServiceAsync("SessionHandler");
+       *     // do something with the SessionHandler service
+       *   });
+       * ```
+       *
+       *
+       * This service should be available in any FLP context (native, iframe, ...).
+       *
+       * @since 1.151.0
+       */
+      class SessionHandler extends sap.ushell.services.Service {
         /**
          * @ui5-protected Do not call from applications (only from related classes in the framework)
          */
         protected constructor();
+
+        /**
+         * Notifies the FLP that the user is currently active, so the FLP treats the session as active and defers
+         * idle warnings / automatic sign-out.
+         *
+         * Intended for apps whose user activity the FLP cannot observe directly (e.g. content embedded in an iframe).
+         * The app decides when the user is active and calls this to signal it.
+         *
+         * @since 1.151.0
+         */
+        notifyUserActivity(): void;
       }
       /**
        * The Unified Shell's internal navigation service (platform independent).
@@ -7480,7 +7507,7 @@ declare namespace sap {
            * whether an transient appstate is sufficient
            */
           bTransient?: boolean
-        ): Promise<any>;
+        ): jQuery.Promise;
         /**
          * Returns the current navigation context.
          *
@@ -7847,7 +7874,7 @@ declare namespace sap {
          *
          * @since 1.16.0
          *
-         * @returns the hash part of an URL, e.g. `"Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH` Returns
+         * @returns the hash part of an URL, e.g. `"Object-name?PV1=PV2&PV4=V5&/display/detail/7?UU=HH` Returns
          * an empty string in case no shell hash was provided.
          */
         constructShellHash(
@@ -7878,8 +7905,8 @@ declare namespace sap {
          * should be treated as opaque)  The URL has to comply with the Fiori-Wave 2 agreed upon format  This
          * service shall be used to extract a hash part from an url. The result can be further broken up by parseShellHash
          *
-         * Examples http://a.b.c?defhij#SemanticObject-Action~Context?PV1=A&PV2=B&/appspecific
-         *  returns : "#SemanticObject-Action~Context?PV1=A&PV2=B&/appspecific"
+         * Examples http://a.b.c?defhij#SemanticObject-Action?PV1=A&PV2=B&/appspecific
+         *  returns : "#SemanticObject-Action?PV1=A&PV2=B&/appspecific"
          *
          * Note: the results when passing an illegal (non-compliant) url are undefined and subject to change w.o.
          * notice. Notably further checks may added. The design is deliberately restrictive and non-robust.
@@ -7891,7 +7918,7 @@ declare namespace sap {
         getShellHash(
           /**
            * a valid (Shell) url, e.g.
-           *  `http://xx.b.c#Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH`
+           *  `http://xx.b.c#Object-name?PV1=PV2&PV4=V5&/display/detail/7?UU=HH`
            */
           sShellHashString: sap.ui.core.URI
         ): sap.ushell.services.Navigation.TargetIntent;
@@ -7977,9 +8004,8 @@ declare namespace sap {
          */
         parseShellHash(
           /**
-           * Hash part of a shell compliant URL `#SO-Action~Context?P1=a&P2=x&/route?RPV=1` the hash part of an URL,
-           *
-           *  e.g. `"#Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH`
+           * Hash part of a shell compliant URL `#SO-Action?P1=a&P2=x&/route?RPV=1` the hash part of an URL,
+           *  e.g. `"#Object-name?PV1=PV2&PV4=V5&/display/detail/7?UU=HH`
            */
           sHash: sap.ushell.services.Navigation.TargetIntent
         ): sap.ushell.services.URLParsing.DecomposedHash;
@@ -7994,7 +8020,7 @@ declare namespace sap {
          * ```javascript
          *
          *   {
-         *     shellPart : "Object-name~AFE2==?PV1=PV2&PV4=V5",
+         *     shellPart : "Object-name?PV1=PV2&PV4=V5",
          *     appSpecificRoute : "display/detail/7?UU=HH"
          *   }
          * ```
@@ -8002,8 +8028,8 @@ declare namespace sap {
          */
         splitHash(
           /**
-           * The hash part of a shell conformant URL. It has to have the following format: #SO-Action~Context?P1=a&P2=x&/route?RPV=1
-           * Here is an example for the hash part of an URL: "#Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH
+           * The hash part of a shell conformant URL. It has to have the following format: #SO-Action?P1=a&P2=x&/route?RPV=1
+           * Here is an example for the hash part of an URL: "#Object-name?PV1=PV2&PV4=V5&/display/detail/7?UU=HH
            */
           sHash: sap.ushell.services.Navigation.TargetIntent
         ): sap.ushell.services.URLParsing.SplitHash;
@@ -8183,6 +8209,85 @@ declare namespace sap {
          */
         getShellUserInfo(): Promise<sap.ushell.services.UserInfo.ShellUserInfo>;
       }
+
+      /**
+       * A helper type that maps service names to service types.
+       */
+      type ServiceTypes = {
+        AppLifeCycle: sap.ushell.services.AppLifeCycle;
+        /**
+         * @deprecated As of version 1.120. Please use {@link sap.ushell.services.BookmarkV2} instead.
+         */
+        Bookmark: sap.ushell.services.Bookmark;
+
+        BookmarkV2: sap.ushell.services.BookmarkV2;
+
+        Configuration: sap.ushell.services.Configuration;
+        /**
+         * @deprecated As of version 1.120. Deprecated without successor together with the classic homepage.
+         */
+        ContentExtensionAdapterFactory: sap.ushell.services.ContentExtensionAdapterFactory;
+        /**
+         * @deprecated As of version 1.120. Please use {@link sap.ushell.services.Navigation} instead.
+         */
+        CrossApplicationNavigation: sap.ushell.services.CrossApplicationNavigation;
+        /**
+         * @deprecated As of version 1.93. Deprecated without successor.
+         */
+        EndUserFeedback: sap.ushell.services.EndUserFeedback;
+
+        Extension: sap.ushell.services.Extension;
+
+        FrameBoundExtension: sap.ushell.services.FrameBoundExtension;
+        /**
+         * @deprecated As of version 1.99. Deprecated together with the classic homepage.
+         */
+        LaunchPage: sap.ushell.services.LaunchPage;
+        /**
+         * @deprecated As of version 1.120. Please use {@link sap.m.MessageToast}, {@link sap.m.MessageBox}, or
+         * {@link sap.m.Dialog} instead.
+         */
+        Message: sap.ushell.services.Message;
+        /**
+         * @deprecated As of version 1.120. Use {@link sap.ushell.services.Navigation} for Navigation instead.
+         */
+        NavTargetResolution: sap.ushell.services.NavTargetResolution;
+
+        Navigation: sap.ushell.services.Navigation;
+        /**
+         * @deprecated As of version 1.119. Please use {@link sap.ushell.services.NotificationsV2} instead.
+         */
+        Notifications: sap.ushell.services.Notifications;
+
+        NotificationsV2: sap.ushell.services.NotificationsV2;
+        /**
+         * @deprecated As of version 1.120. Please use {@link sap.ushell.services.PersonalizationV2} instead.
+         */
+        Personalization: sap.ushell.services.Personalization;
+
+        PersonalizationV2: sap.ushell.services.PersonalizationV2;
+
+        SessionHandler: sap.ushell.services.SessionHandler;
+        /**
+         * @deprecated As of version 1.120. Use {@link sap.ushell.services.Navigation} for Navigation instead.
+         */
+        ShellNavigation: sap.ushell.services.ShellNavigation;
+        /**
+         * @deprecated As of version 1.112. Please use the CrossApplicationNavigation service instead.
+         */
+        SmartNavigation: sap.ushell.services.SmartNavigation;
+
+        SupportTicket: sap.ushell.services.SupportTicket;
+
+        URLParsing: sap.ushell.services.URLParsing;
+        /**
+         * @deprecated As of version 1.120. The corresponding cloud service "SAP Web Analytics" has been retired,
+         * therefore this client-side service API cannot be used any longer.
+         */
+        UsageAnalytics: sap.ushell.services.UsageAnalytics;
+
+        UserInfo: sap.ushell.services.UserInfo;
+      };
     }
 
     namespace base {
@@ -8195,7 +8300,7 @@ declare namespace sap {
          */
         type HashComparison = {
           /**
-           * The intent is the semantic object, action and contextRaw of the hash
+           * The intent is the semantic object and action of the hash
            *
            * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
            */
@@ -8325,21 +8430,19 @@ declare namespace sap {
          *   {
          *     target: {
          *       semanticObject: string,
-         *       action: string,
-         *       contextRaw: string
+         *       action: string
          *     },
          *     params: MapObject,
          *     appStateKey: string
          *     appSpecificRoute: string
          *   }
          * ```
-         *  `{ target: { shellHash } }` Note: in general it is preferred to add an appStateKey directly to the params
-         * object
+         *  `{ target: { shellHash } }`
          *
          * @since 1.94.0
          * @ui5-protected Do not call from applications (only from related classes in the framework)
          *
-         * @returns the hash part of an URL, e.g. `"Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH` returns
+         * @returns the hash part of an URL, e.g. `"Object-name?PV1=PV2&PV4=V5&/display/detail/7?UU=HH` returns
          * "" for an `undefined` object
          */
         constructShellHash(
@@ -8374,8 +8477,8 @@ declare namespace sap {
          * should be treated as opaque)  The URL has to comply with the Fiori-Wave 2 agreed upon format  This
          * service shall be used to extract a hash part from an url. The result can be further broken up by parseShellHash
          *
-         * Examples http://a.b.c?defhij#SemanticObject-Action~Context?PV1=A&PV2=B&/appspecific
-         *  returns : "#SemanticObject-Action~Context?PV1=A&PV2=B&/appspecific"
+         * Examples http://a.b.c?defhij#SemanticObject-Action?PV1=A&PV2=B&/appspecific
+         *  returns : "#SemanticObject-Action?PV1=A&PV2=B&/appspecific"
          *
          * Note: the results when passing an illegal (non-compliant) url are undefined and subject to change w.o.
          * notice. Notably further checks may added. The design is deliberately restrictive and non-robust.
@@ -8388,7 +8491,7 @@ declare namespace sap {
         getShellHash(
           /**
            * a valid (Shell) url, e.g.
-           *  `http://xx.b.c#Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH`
+           *  `http://xx.b.c#Object-name?PV1=PV2&PV4=V5&/display/detail/7?UU=HH`
            */
           sShellHashString: string
         ): object;
@@ -8433,7 +8536,7 @@ declare namespace sap {
           sUrl: string
         ): Promise<boolean>;
         /**
-         * combine members of a javascript object into a parameter string, note that parameters are ordered in an
+         * Combine members of a javascript object into a parameter string, note that parameters are ordered in an
          * arbitrary manner which is subject to change
          *
          * @since 1.94.0
@@ -8464,7 +8567,7 @@ declare namespace sap {
           sParams: string
         ): object;
         /**
-         * Decompose a shell hash into the respective parts
+         * Decompose a shell hash into the respective parts.
          *
          * @since 1.94.0
          * @ui5-protected Do not call from applications (only from related classes in the framework)
@@ -8478,8 +8581,6 @@ declare namespace sap {
          *
          *     action : string,
          *
-         *     contextRaw : string,
-         *
          *     params :  MapObject,
          *
          *     appSpecificRoute : string
@@ -8490,9 +8591,8 @@ declare namespace sap {
          */
         parseShellHash(
           /**
-           * Hash part of a shell compliant URL `#SO-Action~Context?P1=a&P2=x&/route?RPV=1` the hash part of an URL,
-           *
-           *  e.g. `"#Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH`
+           * Hash part of a FLP-compliant URL `#SO-Action?P1=a&P2=x&/route?RPV=1`. At minimum, Semantic Object and
+           * Action need to be part of the hash. A single # is also accepted.
            */
           sHash: string,
           /**
@@ -8500,6 +8600,31 @@ declare namespace sap {
            */
           bReturnEmpty?: boolean
         ): object;
+        /**
+         * split a Unified Shell compliant hash into an Object containing a shell specific part and an app specific
+         * parts
+         *  for non compliant hash strings, the empty object {} is returned. An optional leading # is stripped.
+         *
+         * @since 1.94.0
+         * @ui5-protected Do not call from applications (only from related classes in the framework)
+         *
+         * @returns `{}`(empty object) if not a parseable hash
+         * ```javascript
+         *
+         *   {
+         *     shellPart : "Object-name?PV1=PV2&PV4=V5",
+         *     appSpecificRoute : "&/display/detail/7?UU=HH"
+         *   }
+         * ```
+         *  otherwise Note that params always has an Array for each parameter value!
+         */
+        splitHash(
+          /**
+           * Hash part of a shell conformant URL #SO-Action?P1=a&P2=x&/route?RPV=1 the hash part of an
+           * URL, e.g. "#Object-name?PV1=PV2&PV4=V5&/display/detail/7?UU=HH
+           */
+          sHash: string
+        ): object;
         /**
          * Internal function
          *
@@ -14463,11 +14588,14 @@ declare namespace sap {
        *
        * @returns the service or, in asynchronous mode, a Promise that returns the service
        */
-      getService<ServiceType extends sap.ushell.services.Service>(
+      getService<
+        ServiceType extends sap.ushell.services.Service,
+        ServiceName extends string = string,
+      >(
         /**
          * The service name, such as "Menu"
          */
-        sServiceName: string,
+        sServiceName: ServiceName,
         /**
          * A parameter which is passed to the service constructor and every adapter constructor. (since 1.15.0)
          */
@@ -14535,11 +14663,14 @@ declare namespace sap {
        *
        * @returns a Promise that returns the requested service
        */
-      getServiceAsync<ServiceType extends sap.ushell.services.Service>(
+      getServiceAsync<
+        ServiceType extends sap.ushell.services.Service,
+        ServiceName extends string = string,
+      >(
         /**
          * The service name, such as "Menu"
          */
-        sServiceName: string,
+        sServiceName: ServiceName,
         /**
          * A parameter which is passed to the service constructor and every adapter constructor.
          */
@@ -14733,12 +14864,6 @@ declare namespace sap {
 
     "sap/ushell/modules/Notifications/NotificationsProvider": undefined;
 
-    "sap/ushell/modules/ProductSwitch": undefined;
-
-    "sap/ushell/modules/ProductSwitch/ProductSwitchAPI": undefined;
-
-    "sap/ushell/modules/ProductSwitch/ProductSwitchProvider": undefined;
-
     "sap/ushell/modules/Search": undefined;
 
     "sap/ushell/modules/Search/SearchAPI": undefined;
@@ -14855,6 +14980,8 @@ declare namespace sap {
 
     "sap/ushell/services/SearchableContent": undefined;
 
+    "sap/ushell/services/SessionHandler": undefined;
+
     "sap/ushell/services/ShellNavigation": undefined;
 
     "sap/ushell/services/ShellNavigationInternal": undefined;

package/types/sap.ushell_abap.d.ts

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

package/types/sap.uxap.d.ts

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

package/types/sap.viz.d.ts

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

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

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.151.0
+// For Library Version: 1.153.0
 
 declare namespace sap {
   namespace zen {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.151.0
+// For Library Version: 1.153.0
 
 declare namespace sap {
   namespace zen {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.151.0
+// For Library Version: 1.153.0
 
 declare namespace sap {
   namespace zen {