@sapui5/ts-types 1.122.2 → 1.123.1

package/types/sap.fe.navigation.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.122.0
+// For Library Version: 1.123.0
 
 declare namespace sap {
   namespace fe {

package/types/sap.fe.placeholder.d.ts

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

package/types/sap.fe.plugins.managecache.d.ts

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

package/types/sap.fe.templates.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.122.0
+// For Library Version: 1.123.0
 
 declare namespace sap {
   namespace fe {
@@ -18,25 +18,27 @@ declare namespace sap {
          */
         class ExtensionAPI extends sap.fe.core.ExtensionAPI {
           /**
-           * This method converts filter conditions to filters.
+           * This method converts the filter conditions to filters.
            *
            *
-           * @returns Object containing the converted FilterBar filters.
+           * @returns Object containing the converted FilterBar filters or undefined.
            */
           createFiltersFromFilterConditions(
             /**
              * Map containing the filter conditions of the FilterBar.
              */
             mFilterConditions: object
-          ): object;
+          ): object | undefined;
           /**
            * Provides all the model filters from the filter bar that are currently active
            * along with the search expression.
            *
            *
-           * @returns An array of active filters and the search expression.
+           * @returns An array of active filters and the search expression or undefined.
            */
-          getFilters(): object;
+          getFilters(): /* was: sap.fe.macros.table.Utils.InternalBindingInfo */
+            | any
+            | undefined;
           /**
            * Gets the list entries currently selected for the displayed control.
            *

package/types/sap.fe.test.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.122.0
+// For Library Version: 1.123.0
 
 declare namespace sap {
   namespace fe {
@@ -3167,6 +3167,275 @@ declare namespace sap {
         }
       }
 
+      /**
+       * All common actions (`When`) for all Opa tests are defined here.
+       */
+      class BaseActions extends sap.ui.test.Opa5 {
+        /**
+         * Constructs a new {@link sap.fe.test.Opa5} instance.
+         */
+        constructor();
+
+        /**
+         * Creates a new subclass of class sap.fe.test.BaseActions 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.test.Opa5.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, sap.fe.test.BaseActions>,
+          /**
+           * 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.fe.test.BaseActions.
+         *
+         *
+         * @returns Metadata object describing this class
+         */
+        static getMetadata(): sap.ui.base.Metadata;
+        /**
+         * Closes the open popover via function.
+         *
+         * NOTE: This function ensures that a certain UI state is maintained in some exceptional cases. This function
+         * isn't usually called directly in a journey.
+         *
+         *
+         * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
+         */
+        iClosePopover(): /* was: sap.ui.test.OpaBuilder */ any;
+        /**
+         * Simulates the pressing of the Esc key for the element in focus.
+         *
+         *
+         * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
+         */
+        iPressEscape(): /* was: sap.ui.test.OpaBuilder */ any;
+      }
+      /**
+       * All common arrangements (`Given`) for all Opa tests are defined here.
+       */
+      class BaseArrangements extends sap.ui.test.Opa5 {
+        /**
+         * Constructs a new {@link sap.fe.test.Opa5} instance.
+         */
+        constructor(
+          /**
+           * The settings object required for launching the application
+           */
+          mSettings: {
+            /**
+             * The URL to the launching page (usually a FLP.html)
+             */
+            launchUrl: string;
+            /**
+             * The URL launch parameters
+             */
+            launchParameters: Record<string, string | boolean>;
+          }
+        );
+
+        /**
+         * Creates a new subclass of class sap.fe.test.BaseArrangements 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.test.Opa5.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, sap.fe.test.BaseArrangements>,
+          /**
+           * 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.fe.test.BaseArrangements.
+         *
+         *
+         * @returns Metadata object describing this class
+         */
+        static getMetadata(): sap.ui.base.Metadata;
+        /**
+         * Resets the mock data.
+         *
+         *
+         * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
+         */
+        iResetMockData(
+          /**
+           * The application id or a uri pointing to the service. One of the following properties needs to be provided
+           * within the parameter:
+           * ```javascript
+           *
+           * 	{
+           * 		:
+           * 		:
+           *  }
+           * ```
+           *  NOTE: When passing the AppId, the application needs to be running already. Calling the function
+           * before the application is started can be done by passing the ServiceUri.
+           */
+          oAppInfo?: object
+        ): /* was: sap.ui.test.OpaBuilder */ any;
+        /**
+         * Resets the test data.
+         *
+         *
+         * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
+         */
+        iResetTestData(): /* was: sap.ui.test.OpaBuilder */ any;
+        /**
+         * Simulates a refresh of the page by tearing it down and then restarting it with the very same hash.
+         *
+         *
+         * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
+         */
+        iRestartMyApp(): /* was: sap.ui.test.OpaBuilder */ any;
+        /**
+         * Starts the app in an IFrame, using the `launchUrl` and `launchParameters` provided via the settings object
+         * of the {@link sap.fe.test.BaseArrangements#constructor}.
+         *
+         *
+         * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
+         */
+        iStartMyApp(
+          /**
+           * The app hash
+           */
+          sAppHash?: string,
+          /**
+           * A map with additional URL parameters
+           */
+          mInUrlParameters?: object
+        ): /* was: sap.ui.test.OpaBuilder */ any;
+        /**
+         * Tears down the current application.
+         *
+         *
+         * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
+         */
+        iTearDownMyApp(): /* was: sap.ui.test.OpaBuilder */ any;
+        /**
+         * Clears the browser's local storage and session storage.
+         *
+         * NOTE: The function itself is not meant to be called directly within a journey. Instead, it can be overwritten
+         * to add custom clean-up functionality when calling {@link sap.fe.test.BaseArrangements#iResetTestData}.
+         *
+         * @ui5-protected Do not call from applications (only from related classes in the framework)
+         *
+         * @returns A `Promise` object
+         */
+        resetTestData(): Promise<any>;
+      }
+      /**
+       * All common assertions (`Then`) for all Opa tests are defined here.
+       */
+      class BaseAssertions extends sap.ui.test.Opa5 {
+        /**
+         * Constructs a new {@link sap.fe.test.Opa5} instance.
+         */
+        constructor();
+
+        /**
+         * Creates a new subclass of class sap.fe.test.BaseAssertions 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.test.Opa5.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, sap.fe.test.BaseAssertions>,
+          /**
+           * 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.fe.test.BaseAssertions.
+         *
+         *
+         * @returns Metadata object describing this class
+         */
+        static getMetadata(): sap.ui.base.Metadata;
+        /**
+         * Checks whether a {@link sap.m.IllustratedMessage} with given message is shown.
+         *
+         *
+         * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
+         */
+        iSeeIllustratedMessage(
+          /**
+           * The message shown on the page
+           */
+          sMessage: string
+        ): /* was: sap.ui.test.OpaBuilder */ any;
+        /**
+         * Checks whether a {@link sap.m.MessagePage} with given message is shown.
+         *
+         * @deprecated (since 1.118) - use iSeePage() && iSeeIllustratedMessage(sMessage) instead
+         *
+         * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
+         */
+        iSeeMessagePage(
+          /**
+           * The message shown on the message page
+           */
+          sMessage: string
+        ): /* was: sap.ui.test.OpaBuilder */ any;
+        /**
+         * Checks whether a {@link sap.m.MessageToast} with the given text is shown.
+         *
+         *
+         * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
+         */
+        iSeeMessageToast(
+          /**
+           * The text shown in the MessageToast
+           */
+          sText: string
+        ): /* was: sap.ui.test.OpaBuilder */ any;
+        /**
+         * Checks whether a {@link sap.m.Page} is shown.
+         *
+         *
+         * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
+         */
+        iSeePage(): /* was: sap.ui.test.OpaBuilder */ any;
+      }
       /**
        * A JourneyRunner for executing integration tests with given settings.
        */
@@ -3182,11 +3451,14 @@ declare namespace sap {
             /**
              * The available Opa pages
              */
-            pages?: object;
+            pages?: Record<
+              string,
+              sap.fe.test.ListReport | sap.fe.test.ObjectPage
+            >;
             /**
              * The Opa configuration applied via {@link sap.ui.test.Opa5#sap.ui.test.Opa5.extendConfig}
              */
-            opaConfig?: object;
+            opaConfig?: sap.ui.test.Opa5.Config;
             /**
              * The URL to the launching page (usually a FLP.html)
              */
@@ -3194,7 +3466,7 @@ declare namespace sap {
             /**
              * The URL launch parameters
              */
-            launchParameters?: object;
+            launchParameters?: Record<string, string | boolean>;
             /**
              * If false (default), only one JourneyRunner is executed at a time
              */
@@ -3319,11 +3591,14 @@ declare namespace sap {
             /**
              * The available Opa pages
              */
-            pages?: object;
+            pages?: Record<
+              string,
+              sap.fe.test.ListReport | sap.fe.test.ObjectPage
+            >;
             /**
              * The Opa configuration applied via {@link sap.ui.test.Opa5#sap.ui.test.Opa5.extendConfig}
              */
-            opaConfig?: object;
+            opaConfig?: sap.ui.test.Opa5.Config;
             /**
              * The URL to the launching page (usually a FLP.html)
              */
@@ -3331,7 +3606,7 @@ declare namespace sap {
             /**
              * The URL launch parameters
              */
-            launchParameters?: object;
+            launchParameters?: Record<string, string | boolean>;
             /**
              * If false (default), only one JourneyRunner is executed at a time
              */
@@ -3614,6 +3889,12 @@ declare namespace sap {
 
     "sap/fe/test/api/TableAssertions": undefined;
 
+    "sap/fe/test/BaseActions": undefined;
+
+    "sap/fe/test/BaseArrangements": undefined;
+
+    "sap/fe/test/BaseAssertions": undefined;
+
     "sap/fe/test/JourneyRunner": undefined;
 
     "sap/fe/test/library": undefined;

package/types/sap.fe.tools.d.ts

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

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

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