@sapui5/ts-types 1.114.0 → 1.115.0

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

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.114.0
+// For Library Version: 1.115.0
 
 declare namespace sap {
   namespace ui {
@@ -161,6 +161,10 @@ declare namespace sap {
         }
       }
 
+      interface $ExportBaseBeforeExportEventParameters {}
+
+      interface $SpreadsheetBeforeSaveEventParameters {}
+
       /**
        * @SINCE 1.96
        *
@@ -353,7 +357,7 @@ declare namespace sap {
          * thread of the browser. The status of the process is visually presented to the user in a progress dialog
          * that can be suppressed. The user can cancel the process with the Cancel button of the dialog.
          *
-         * This class provides a low level API for spreadsheet export. The {@link sap.ui.comp.smarttable.SmartTable}
+         * This class provides a low level API for spreadsheet export. The {@link sap.ui.comp.smarttable.SmartTable }
          * control implements it internally and provides the export functionality out of the box. For special cases,
          * please refer to details below.
          *
@@ -370,23 +374,23 @@ declare namespace sap {
          * 	`label` (string) - Column header text
          * 	 - `property` (string) - Field name or Array of field names in the data source feed
          * 	 - `type` (string) - Optional data type of the field. See {@link sap.ui.export.EdmType} for the list
-         * 			of supported types. If this property is omitted, the property is processed as a string field.
+         *     of supported types. If this property is omitted, the property is processed as a string field.
          * 	 - `width` (number) - Optional width of the column in characters. There is no 1:1 correspondence between
-         * 			character widths in the exported spreadsheet and CSS units.The width of one character is approximately
-         * 			0.5em in CSS units, depending on the fonts that are used in the table and in the resulting spreadsheet.
-         * 			The default value is 10 characters.
+         *     character widths in the exported spreadsheet and CSS units.The width of one character is approximately
+         *     0.5em in CSS units, depending on the fonts that are used in the table and in the resulting spreadsheet.
+         *     The default value is 10 characters.
          * 	 - `textAlign` (string) - Horizontal alignment of cell contents. The following values of the CSS `text-align`
-         * 			property are accepted: `[left, right, center, begin, end]`. If not specified, the columns are horizontally
-         * 			aligned based on the property type.
+         *     property are accepted: `[left, right, center, begin, end]`. If not specified, the columns are horizontally
+         *     aligned based on the property type.
          * 	 - `scale` (number) - Number of digits after decimal point for numeric values
          * 	 - `delimiter` (boolean) - Set to `true` to display thousands separators in numeric values. The default
-         * 			value is `false`.
+         *     value is `false`.
          * 	 - `unit` (string) - Text to display as the unit of measurement or currency next to the numeric value.
-         * 			It is treated as a string and has no influence on the value itself. For example, a value of 150 with
-         * 			the unit "%" is still 150 and not 1.5, as a user may expect.
+         *     It is treated as a string and has no influence on the value itself. For example, a value of 150 with
+         *     the unit "%" is still 150 and not 1.5, as a user may expect.
          * 	 - `unitProperty` (string) - Name of the data source field that contains the unit/currency text
          * 	 - `displayUnit` (boolean) - The property applies to currency values only and defines if the currency
-         * 			is shown in the column. The default value is `true`.
+         *     is shown in the column. The default value is `true`.
          * 	 - `trueValue` (string) - Textual representation of a boolean type that has the value `true`
          * 	 - `falseValue` (string) - Textual representation of a boolean type that has the value `false`
          * 	 - `template` (string) - Formatting template that supports indexed placeholders within curly brackets
@@ -394,45 +398,45 @@ declare namespace sap {
          * 	 - `inputFormat` (string) - Formatting template for string formatted dates
          * 	 - `utc` (boolean) - Defines whether the `DateTime` is displayed as UTC or local time
          * 	 - `valueMap` (string) - Mapping object or Map containing the values that should be mapped to a particular
-         * 			key
+         *     key
          * 	 - `wrap` (boolean) - Indicates if wrapping is enabled for this particular column
          * 	 - `workbook.context` - Context object that will be applied to the generated file. It may contain the
-         * 			following fields:
+         *     following fields:
          * 	 - `application` (string) - The application that creates the XLSX document (default: "SAP UI5")
          * 	 - `version` (string) - Application version that creates the XLSX document (default: "${version}")
          * 	 - `title` (string) - Title of the XLSX document (NOT the filename)
          * 	 - `modifiedBy` (string) - User context for the XLSX document
          * 	 - `sheetName` (string) - The label of the data sheet
          * 	 - `metaSheetName` (string) - The label of the metadata sheet. The sheet will not be shown unless metadata
-         * 			entries are provided
+         *     entries are provided
          * 	 - `metainfo` (Array) - An Array of metadata groups. Each group has a name property and an items Array
-         * 			which contains key/value pairs
+         *     which contains key/value pairs
          * 	 - `workbook.hierarchyLevel` - Name of the property that contains the hierarchy level information of
-         * 			each line item
+         *     each line item
          * 	 - `dataSource` - Source of spreadsheet data. It can be a JSON array with row data, an URL or an OData
-         * 			properties object with the following fields:
+         *     properties object with the following fields:
          * 	`type` (string) - Type of the data source. Currently, only OData is supported and the value have to
          * be set to `"odata"`.
          * 	 - `dataUrl` (string) - URL to table data on the server, including all select, filter, and search query
-         * 			parameters
+         *     parameters
          * 	 - `serviceUrl` (string) - URL to the OData service. The parameter is required for OData batch requests.
          *
          * 	 - `count` (number) - Count of available records on the server
          * 	 - `useBatch` (boolean) - Set to `true` if OData batch requests are used to fetch the spreadsheet data.
-         * 			In this case, `serviceUrl` and `headers` have to be specified, too.
+         *     In this case, `serviceUrl` and `headers` have to be specified, too.
          * 	 - `headers` (object) - Map of HTTP request header properties. They should correspond to the HTTP request
-         * 			headers that are used to obtain table data for display in the browser.
+         *     headers that are used to obtain table data for display in the browser.
          * 	 - `sizeLimit` (number) - Maximal allowed number of records that can be obtained from the service in
-         * 			a single request
+         *     a single request
          * 	 - `count` (number) - The maximal number of records to export. If not specified, all data from the data
-         * 			source is fetched.
+         *     source is fetched.
          * 	 - `worker` (boolean) - Run export process in a worker thread. Set to `false` to disable worker and
-         * 			run export in a main thread. This is needed, for example, if a mock server is used to provide spreadsheet
-         * 			data.
+         *     run export in a main thread. This is needed, for example, if a mock server is used to provide spreadsheet
+         *     data.
          *  **Note:** In case of a strict content security policy, it is not always possible to create an export
          * worker. In this case, export runs in a main thread disregarding the `worker` value.
          * 	 - `fileName` (string) - Optional file name for the exported file. If not specified, the spreadsheet
-         * 			is exported as `export.xlsx`.
+         *     is exported as `export.xlsx`.
          * 	 - `showProgress` (boolean) - Set to `false` to suppress the progress dialog
          *
          * Usage: To start export, create a new `sap.ui.export.Spreadsheet` object and call the `build` method.
@@ -518,8 +522,7 @@ declare namespace sap {
          * ```
          *
          *
-         * Restrictions: For a complete list of restrictions, see: {@link topic:2c641481649f44de9c1c22c9c3c49d13
-         * Spreadsheet Export Restrictions}
+         * Restrictions: For a complete list of restrictions, see: {@link https://ui5.sap.com/#/topic/2c641481649f44de9c1c22c9c3c49d13 Spreadsheet Export Restrictions}
          *
          * You can export only the primitive cell data types that are listed in {@link sap.ui.export.EdmType}. Icons,
          * images, check boxes, and complex controls in UI5 table cells are not supported.
@@ -550,7 +553,7 @@ declare namespace sap {
          * The properties sheetName and metaSheetName on the workbook.context object are limited to 31 characters
          * each. If their value exceeds this maximum length, the value will be truncated.
          * See:
-         * 	{@link topic:2691788a08fc43f7bf269ea7c6336caf Spreadsheet}
+         * 	{@link https://ui5.sap.com/#/topic/2691788a08fc43f7bf269ea7c6336caf Spreadsheet}
          */
         constructor(
           /**

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

@@ -1,11 +1,11 @@
-// For Library Version: 1.114.0
+// For Library Version: 1.115.0
 
 declare namespace sap {
   namespace ui {
     /**
      * This is the library for SAPUI5 flexibility. It includes the handling of changes made on applications,
      * such as descriptor changes, app variants, UI changes, control variants (a.k.a. views), and personalization,
-     * as well as APIs for consumers. In addition, it provides the {@link sap.ui.fl.variants.VariantManagement}
+     * as well as APIs for consumers. In addition, it provides the {@link sap.ui.fl.variants.VariantManagement }
      * control, which enables applications to use control variants (views).
      */
     namespace fl {
@@ -136,7 +136,9 @@ declare namespace sap {
            * This event is fired when the Save View dialog or the Save As dialog is closed with the
            * save button.
            */
-          save?: (oEvent: sap.ui.base.Event) => void;
+          save?: (
+            oEvent: sap.ui.base.Event<sap.ui.fl.variants.$VariantManagementSaveEventParameters>
+          ) => void;
 
           /**
            * This event is fired when users presses the cancel button inside Save As dialog.
@@ -146,12 +148,89 @@ declare namespace sap {
           /**
            * This event is fired when users apply changes to variants in the Manage Views dialog.
            */
-          manage?: (oEvent: sap.ui.base.Event) => void;
+          manage?: (
+            oEvent: sap.ui.base.Event<sap.ui.fl.variants.$VariantManagementManageEventParameters>
+          ) => void;
 
           /**
            * This event is fired when a new variant is selected.
            */
-          select?: (oEvent: sap.ui.base.Event) => void;
+          select?: (
+            oEvent: sap.ui.base.Event<sap.ui.fl.variants.$VariantManagementSelectEventParameters>
+          ) => void;
+        }
+
+        interface $VariantManagementCancelEventParameters {}
+
+        interface $VariantManagementInitializedEventParameters {}
+
+        interface $VariantManagementManageEventParameters {
+          /**
+           * List of changed variants. Each entry contains a 'key' - the variant key and a 'name' - the new title
+           * of the variant
+           */
+          renamed?: object[];
+
+          /**
+           * List of deleted variant keys
+           */
+          deleted?: string[];
+
+          /**
+           * List of variant keys and the associated Execute on Selection indicator
+           */
+          exe?: object[];
+
+          /**
+           * The default variant key
+           */
+          def?: string;
+        }
+
+        interface $VariantManagementSaveEventParameters {
+          /**
+           * Variant title
+           */
+          name?: string;
+
+          /**
+           * Indicates if an existing variant is overwritten or if a new variant is created.
+           */
+          overwrite?: boolean;
+
+          /**
+           * Variant key
+           */
+          key?: string;
+
+          /**
+           * Apply Automatically indicator
+           */
+          execute?: boolean;
+
+          /**
+           * Indicates the check box state for 'Public'.
+           */
+          public?: boolean;
+
+          /**
+           * The default variant indicator
+           */
+          def?: boolean;
+
+          /**
+           * Indicates the check box state for 'Create Tile'.
+           * Note:
+           * This event parameter is used only internally.
+           */
+          tile?: boolean;
+        }
+
+        interface $VariantManagementSelectEventParameters {
+          /**
+           * Variant key
+           */
+          key?: string;
         }
 
         /**
@@ -177,7 +256,7 @@ declare namespace sap {
            * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
            * of the syntax of the settings object.
            * See:
-           * 	{@link topic:f1430c0337534d469da3a56307ff76af Key User Adaptation: Enable Your App}
+           * 	{@link https://ui5.sap.com/#/topic/f1430c0337534d469da3a56307ff76af Key User Adaptation: Enable Your App}
            */
           constructor(
             /**
@@ -192,7 +271,7 @@ declare namespace sap {
            * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
            * of the syntax of the settings object.
            * See:
-           * 	{@link topic:f1430c0337534d469da3a56307ff76af Key User Adaptation: Enable Your App}
+           * 	{@link https://ui5.sap.com/#/topic/f1430c0337534d469da3a56307ff76af Key User Adaptation: Enable Your App}
            */
           constructor(
             /**
@@ -358,7 +437,9 @@ declare namespace sap {
             /**
              * The function to be called when the event occurs
              */
-            fnFunction: (p1: sap.ui.base.Event) => void,
+            fnFunction: (
+              p1: sap.ui.base.Event<sap.ui.fl.variants.$VariantManagementManageEventParameters>
+            ) => void,
             /**
              * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
              * itself
@@ -379,7 +460,9 @@ declare namespace sap {
             /**
              * The function to be called when the event occurs
              */
-            fnFunction: (p1: sap.ui.base.Event) => void,
+            fnFunction: (
+              p1: sap.ui.base.Event<sap.ui.fl.variants.$VariantManagementManageEventParameters>
+            ) => void,
             /**
              * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
              * itself
@@ -406,7 +489,9 @@ declare namespace sap {
             /**
              * The function to be called when the event occurs
              */
-            fnFunction: (p1: sap.ui.base.Event) => void,
+            fnFunction: (
+              p1: sap.ui.base.Event<sap.ui.fl.variants.$VariantManagementSaveEventParameters>
+            ) => void,
             /**
              * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
              * itself
@@ -428,7 +513,9 @@ declare namespace sap {
             /**
              * The function to be called when the event occurs
              */
-            fnFunction: (p1: sap.ui.base.Event) => void,
+            fnFunction: (
+              p1: sap.ui.base.Event<sap.ui.fl.variants.$VariantManagementSaveEventParameters>
+            ) => void,
             /**
              * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
              * itself
@@ -454,7 +541,9 @@ declare namespace sap {
             /**
              * The function to be called when the event occurs
              */
-            fnFunction: (p1: sap.ui.base.Event) => void,
+            fnFunction: (
+              p1: sap.ui.base.Event<sap.ui.fl.variants.$VariantManagementSelectEventParameters>
+            ) => void,
             /**
              * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
              * itself
@@ -475,7 +564,9 @@ declare namespace sap {
             /**
              * The function to be called when the event occurs
              */
-            fnFunction: (p1: sap.ui.base.Event) => void,
+            fnFunction: (
+              p1: sap.ui.base.Event<sap.ui.fl.variants.$VariantManagementSelectEventParameters>
+            ) => void,
             /**
              * Context object to call the event handler with. Defaults to this `sap.ui.fl.variants.VariantManagement`
              * itself
@@ -527,7 +618,9 @@ declare namespace sap {
             /**
              * The function to be called, when the event occurs
              */
-            fnFunction: (p1: sap.ui.base.Event) => void,
+            fnFunction: (
+              p1: sap.ui.base.Event<sap.ui.fl.variants.$VariantManagementManageEventParameters>
+            ) => void,
             /**
              * Context object on which the given function had to be called
              */
@@ -544,7 +637,9 @@ declare namespace sap {
             /**
              * The function to be called, when the event occurs
              */
-            fnFunction: (p1: sap.ui.base.Event) => void,
+            fnFunction: (
+              p1: sap.ui.base.Event<sap.ui.fl.variants.$VariantManagementSaveEventParameters>
+            ) => void,
             /**
              * Context object on which the given function had to be called
              */
@@ -561,7 +656,9 @@ declare namespace sap {
             /**
              * The function to be called, when the event occurs
              */
-            fnFunction: (p1: sap.ui.base.Event) => void,
+            fnFunction: (
+              p1: sap.ui.base.Event<sap.ui.fl.variants.$VariantManagementSelectEventParameters>
+            ) => void,
             /**
              * Context object on which the given function had to be called
              */
@@ -604,25 +701,7 @@ declare namespace sap {
             /**
              * Parameters to pass along with the event
              */
-            mParameters?: {
-              /**
-               * List of changed variants. Each entry contains a 'key' - the variant key and a 'name' - the new title
-               * of the variant
-               */
-              renamed?: object[];
-              /**
-               * List of deleted variant keys
-               */
-              deleted?: string[];
-              /**
-               * List of variant keys and the associated Execute on Selection indicator
-               */
-              exe?: object[];
-              /**
-               * The default variant key
-               */
-              def?: string;
-            }
+            mParameters?: sap.ui.fl.variants.$VariantManagementManageEventParameters
           ): this;
           /**
            * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
@@ -635,38 +714,7 @@ declare namespace sap {
             /**
              * Parameters to pass along with the event
              */
-            mParameters?: {
-              /**
-               * Variant title
-               */
-              name?: string;
-              /**
-               * Indicates if an existing variant is overwritten or if a new variant is created.
-               */
-              overwrite?: boolean;
-              /**
-               * Variant key
-               */
-              key?: string;
-              /**
-               * Apply Automatically indicator
-               */
-              execute?: boolean;
-              /**
-               * Indicates the check box state for 'Public'.
-               */
-              public?: boolean;
-              /**
-               * The default variant indicator
-               */
-              def?: boolean;
-              /**
-               * Indicates the check box state for 'Create Tile'.
-               * Note:
-               * This event parameter is used only internally.
-               */
-              tile?: boolean;
-            }
+            mParameters?: sap.ui.fl.variants.$VariantManagementSaveEventParameters
           ): this;
           /**
            * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
@@ -679,12 +727,7 @@ declare namespace sap {
             /**
              * Parameters to pass along with the event
              */
-            mParameters?: {
-              /**
-               * Variant key
-               */
-              key?: string;
-            }
+            mParameters?: sap.ui.fl.variants.$VariantManagementSelectEventParameters
           ): this;
           /**
            * Gets the currently selected variant key.
@@ -725,8 +768,7 @@ declare namespace sap {
            */
           getExecuteOnSelectionForStandardDefault(): boolean;
           /**
-           * Returns array of IDs of the elements which are the current targets of the association {@link #getFor
-           * for}.
+           * Returns array of IDs of the elements which are the current targets of the association {@link #getFor for}.
            */
           getFor(): sap.ui.core.ID[];
           /**
@@ -1127,7 +1169,6 @@ declare namespace sap {
              */
             isKeyUser(): Promise<boolean>;
           }
-          const FeaturesAPI: FeaturesAPI;
         }
       }
 
@@ -1150,8 +1191,8 @@ declare namespace sap {
            * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
            * of the syntax of the settings object.
            *
-           * This class does not have its own settings, but all settings applicable to the base type {@link sap.m.Dialog#constructor
-           * sap.m.Dialog} can be used.
+           * This class does not have its own settings, but all settings applicable to the base type {@link sap.m.Dialog#constructor sap.m.Dialog }
+           * can be used.
            */
           constructor(
             /**
@@ -1166,8 +1207,8 @@ declare namespace sap {
            * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
            * of the syntax of the settings object.
            *
-           * This class does not have its own settings, but all settings applicable to the base type {@link sap.m.Dialog#constructor
-           * sap.m.Dialog} can be used.
+           * This class does not have its own settings, but all settings applicable to the base type {@link sap.m.Dialog#constructor sap.m.Dialog }
+           * can be used.
            */
           constructor(
             /**
@@ -1299,6 +1340,8 @@ declare namespace sap {
 
     "sap/ui/fl/apply/_internal/flexState/UI2Personalization/UI2PersonalizationState": undefined;
 
+    "sap/ui/fl/apply/_internal/preprocessors/ComponentLifecycleHooks": undefined;
+
     "sap/ui/fl/apply/_internal/preprocessors/ControllerExtension": undefined;
 
     "sap/ui/fl/apply/_internal/preprocessors/EventHistory": undefined;