@sapui5/ts-types 1.148.1 → 1.149.0

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.148.0
+// For Library Version: 1.149.0
 
 declare namespace sap {
   namespace ui {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.148.0
+// For Library Version: 1.149.0
 
 declare namespace sap {
   namespace ui {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.148.0
+// For Library Version: 1.149.0
 
 declare namespace sap {
   namespace ui {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.148.0
+// For Library Version: 1.149.0
 
 declare namespace sap {
   namespace ui {

package/types/sap.uiext.inbox.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.148.0
+// For Library Version: 1.149.0
 
 declare namespace sap {
   namespace uiext {

package/types/sap.ushell.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.148.1
+// For Library Version: 1.149.0
 
 declare namespace sap {
   /**
@@ -8167,6 +8167,338 @@ declare namespace sap {
       }
     }
 
+    namespace base {
+      namespace UrlParsing {
+        /**
+         * Type for HashComparison
+         *
+         * @since 1.128.0
+         * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+         */
+        type HashComparison = {
+          /**
+           * The intent is the semantic object, action and contextRaw of the hash
+           *
+           * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+           */
+          sameIntent: boolean;
+          /**
+           * The intent parameters are the parameters of the hash that are not technical parameters
+           *
+           * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+           */
+          sameParameters: boolean;
+          /**
+           * The app specific route is the part of the hash after the shell part
+           *
+           * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+           */
+          sameAppSpecificRoute: boolean;
+        };
+      }
+      /**
+       * This class provides methods to enable the integration with the SAP Business Client (NWBC for Desktop).
+       *
+       * @since 1.147.0
+       * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+       */
+      interface SAPBusinessClientEnablement {
+        /**
+         * Triggers a logout in SAP Business Client.
+         *
+         * @since 1.147.0
+         * @ui5-protected Do not call from applications (only from related classes in the framework)
+         */
+        doLogout(
+          /**
+           * The URL to navigate to after logout.
+           */
+          sLogOffUrl: string
+        ): void;
+        /**
+         * Determine the shell type considering NWBC Version 6.0+ client case.
+         *
+         * @since 1.147.0
+         * @ui5-protected Do not call from applications (only from related classes in the framework)
+         *
+         * @returns the shell type ("NWBC" or "FLP"), based on whether NWBC v6.0+ Client is detected.
+         */
+        getShellType(): string;
+        /**
+         * Detects whether NWBC can logout natively.
+         *
+         * NWBC exposes a feature bit vector via the "getNwbcFeatureBits" method of the private "epcm" object. This
+         * is expected to be a string in hex format representing 4 bits, where the second least significant bit
+         * represents native logout capability.
+         *
+         * For example: "B" = 1011, second last bit is 1, therefore native logout capability is enabled.
+         *
+         * @since 1.147.0
+         * @ui5-protected Do not call from applications (only from related classes in the framework)
+         *
+         * @returns Whether the browser can logout natively.
+         */
+        hasNativeLogoutCapability(): boolean;
+      }
+
+      /**
+       * The Unified Shell's internal URL parsing utils (platform independent)
+       *
+       * Methods in this class allow to break down a shell compliant hash into it's respective parts (SemanticObject,Action,Context,
+       * Parameters, appSpecificHash) or (ShellPart,appSpecificHash) respectively or construct a hash from its
+       * constituents.
+       *
+       * All methods deal with the *internal* shellHash format.
+       *
+       * Most of the parse methods are robust w.r.t. a leading "#".
+       *
+       * Note: The functions were designed with a "truthy" behaviour for not present values, Thus a client should
+       * not rely on the difference between null, "undefined", "" when testing for the result of a parse action.
+       *
+       * The parsing functions are deliberately restrictive and fragile, only shell compliant hashes are parsed
+       * correctly, behaviour for non-compliant hashes is undefined and subject to change, notably we do not aim
+       * do "degrade" nicefully or support partial parsing of corrupted urls.
+       *
+       * @since 1.94.0
+       * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+       */
+      interface UrlParsing {
+        /**
+         * Calculates the similarities of the hashes
+         *
+         * @since 1.128.0
+         * @ui5-protected Do not call from applications (only from related classes in the framework)
+         *
+         * @returns A object describing the similarities
+         */
+        compareHashes(
+          /**
+           * The first hash
+           */
+          sHash1: sap.ushell.services.Navigation.TargetIntent,
+          /**
+           * The second hash
+           */
+          sHash2: sap.ushell.services.Navigation.TargetIntent
+        ): sap.ushell.base.UrlParsing.HashComparison;
+        /**
+         * Calculates the similarities of the hashes
+         *
+         * @since 1.142.0
+         * @ui5-protected Do not call from applications (only from related classes in the framework)
+         *
+         * @returns A object describing the similarities
+         */
+        compareParsedHashes(
+          /**
+           * The first hash
+           */
+          oHash1: sap.ushell.services.URLParsing.DecomposedHash,
+          /**
+           * The second hash
+           */
+          oHash2: sap.ushell.services.URLParsing.DecomposedHash
+        ): sap.ushell.base.UrlParsing.HashComparison;
+        /**
+         * compose a shell Hash from it's respective parts Note that it also may append an app specific route !
+         *
+         * ```javascript
+         *
+         *   {
+         *     target: {
+         *       semanticObject: string,
+         *       action: string,
+         *       contextRaw: string
+         *     },
+         *     params: MapObject,
+         *     appStateKey: string
+         *     appSpecificRoute: string
+         *   }
+         * ```
+         *  `{ target: { shellHash } }` Note: in general it is preferred to add an appStateKey directly to the params
+         * object
+         *
+         * @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
+         * "" for an `undefined` object
+         */
+        constructShellHash(
+          /**
+           * The action must be a valid action, it may not contain "?" or directly a parameter string
+           */
+          oShellHash: /* was: sap.ushell.services.URLParsing.ShellHash */ any,
+          /**
+           * if true, the result is prefixed with a leading #
+           */
+          bPrefixWithHash?: boolean
+        ): string;
+        /**
+         * Ensures a leading # in a hash.
+         *
+         * @since 1.129.0
+         * @ui5-protected Do not call from applications (only from related classes in the framework)
+         *
+         * @returns the string with a leading #.
+         */
+        ensureLeadingHash(
+          /**
+           * Shell hash.
+           */
+          sHash: string
+        ): string;
+        /**
+         * Extract the Shell hash# part from an URL The application specific route part is removed See {@link #getHash }
+         * for a function which retains the app specific route.
+         *
+         * Shell services shall use this service to extract relevant parts of an URL from an actual URL string (which
+         * 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"
+         *
+         * 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.
+         *
+         * @since 1.94.0
+         * @ui5-protected Do not call from applications (only from related classes in the framework)
+         *
+         * @returns the parsed result
+         */
+        getShellHash(
+          /**
+           * a valid (Shell) url, e.g.
+           *  `http://xx.b.c#Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH`
+           */
+          sShellHashString: string
+        ): object;
+        /**
+         * Determines whether two hash fragments have the same intent during an app-to-app navigation.
+         *
+         * @since 1.128.0
+         * @ui5-protected Do not call from applications (only from related classes in the framework)
+         *
+         * @returns Whether two hash fragments have the same semantic object and action during an app-to-app navigation.
+         */
+        haveSameIntent(
+          /**
+           * The first hash split by parseShellHash
+           */
+          oParsedHash1: sap.ushell.services.URLParsing.DecomposedHash,
+          /**
+           * The second hash split by parseShellHash
+           */
+          oParsedHash2: sap.ushell.services.URLParsing.DecomposedHash
+        ): boolean;
+        /**
+         * Check if a URL has an intent based navigation part which can be parsed into a semantic object and action
+         * part. Accepts only a relative URL (must contain #) or fully qualified Urls for which origin and filename
+         * must correspond to the running launchpad.
+         *
+         * Given actual url `http://www.mycorp.com/sap/fiori/FioriLaunchpad.html?sap-language=DE#SO-action?P1=value1`,
+         * the following parts `http://www.mycorp.com/sap/fiori/FioriLaunchpad.html` must match.
+         *
+         * This function *only* tests whether the hash part can be parsed and contains a semantic object and action.
+         * It does not test whether the intent or its parameters are valid for a given user
+         *
+         * @since 1.94.0
+         * @ui5-protected Do not call from applications (only from related classes in the framework)
+         *
+         * @returns true if the conditions are fulfilled.
+         */
+        isIntentUrlAsync(
+          /**
+           * the URL to test. Note: this url must be in internal format.
+           */
+          sUrl: string
+        ): Promise<boolean>;
+        /**
+         * 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
+         * @ui5-protected Do not call from applications (only from related classes in the framework)
+         *
+         * @returns `ABC=1&ABC=1%202DEF=4` Note that the result is *not* prefixed with a "?", parameter values are
+         * encodeURIComponent encoded.
+         */
+        paramsToString(
+          /**
+           * any value { ABC : [1,"1 2"], DEF : ["4"]}
+           */
+          oParams: object
+        ): string;
+        /**
+         * Parses parameters from a URI query string (starting with "?") into a parameter object. Keys are decoded
+         * twice. This assumes that literal "%" characters are not used on keys, otherwise parsing will fail.
+         *
+         * @since 1.94.0
+         * @ui5-protected Do not call from applications (only from related classes in the framework)
+         *
+         * @returns Any value, e.g. `{ ABC: ["1", "1 2DEF=4"] }`
+         */
+        parseParameters(
+          /**
+           * Parameter string, e.g. `?ABC=1&ABC=1%202DEF=4`
+           */
+          sParams: string
+        ): object;
+        /**
+         * 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)
+         *
+         * @returns `undefined` if not a parseable hash
+         *
+         * ```javascript
+         *
+         *   {
+         *     semanticObject : string,
+         *
+         *     action : string,
+         *
+         *     contextRaw : string,
+         *
+         *     params :  MapObject,
+         *
+         *     appSpecificRoute : string
+         *
+         *   }
+         * ```
+         *  Note that params always has an Array for each parameter value!
+         */
+        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`
+           */
+          sHash: string,
+          /**
+           * Return an empty parsed hash object instead of undefined
+           */
+          bReturnEmpty?: boolean
+        ): object;
+        /**
+         * Internal function
+         *
+         * @since 1.94.0
+         * @ui5-protected Do not call from applications (only from related classes in the framework)
+         *
+         * @returns the string without a leading #
+         */
+        stripLeadingHash(
+          /**
+           * Shell hash
+           */
+          sHash: string
+        ): string;
+      }
+    }
+
     namespace components {
       namespace factsheet {
         namespace controls {
@@ -14345,6 +14677,10 @@ declare namespace sap {
 
     "sap/ushell/api/workpage/Runtime": undefined;
 
+    "sap/ushell/base/SAPBusinessClientEnablement": undefined;
+
+    "sap/ushell/base/UrlParsing": undefined;
+
     "sap/ushell/bootstrap/Config": undefined;
 
     "sap/ushell/components/factsheet/controls/PictureTile": undefined;

package/types/sap.ushell_abap.d.ts

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

package/types/sap.uxap.d.ts

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

package/types/sap.viz.d.ts

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

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

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

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

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

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

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

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

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