@sapui5/ts-types 1.136.3 → 1.138.1

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.136.2
+// For Library Version: 1.138.0
 
 declare namespace sap {
   namespace ui {
@@ -564,87 +564,6 @@ declare namespace sap {
          * 	 - Suppress worker and run the document generation process in a main thread.
          * 	 - Configure the exported file name.
          *
-         * Export settings object: Export settings should be provided in the constructor as an `mSettings` property
-         * map with the following fields:
-         * 	 - `workbook` - Spreadsheet properties object
-         * 	`workbook.columns` - Array of column configurations. Each column configuration is an object with the
-         * following fields:
-         * 	`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.
-         * 	 - `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.
-         * 	 - `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.
-         * 	 - `scale` (number) - Number of digits after decimal point for numeric values
-         * 	 - `autoScale` (boolean) - Allows automatic scale assignment based on unit of measure
-         * 	 - `delimiter` (boolean) - Set to `true` to display thousands separators in numeric values. The default
-         *     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.
-         * 	 - `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`.
-         * 	 - `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
-         *
-         * 	 - `format` (string) - Output format for columns of type Date/DateTime/Time
-         * 	 - `inputFormat` (string) - Formatting template for string formatted dates
-         * 	 - `utc` (boolean) - Defines whether the `DateTime` is displayed as UTC or local time
-         * 	 - `timezone` (string) - Defines a fixed IANA time zone
-         * 	 - `timezoneProperty` (string) - References an OData property that contains the specific IANA time zone
-         *
-         * 	 - `displayTimezone` (boolean) - Defines whether the IANA time zone is displayed within a cell
-         * 	 - `valueMap` (string) - Mapping object or Map containing the values that should be mapped to a particular
-         *     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:
-         * 	 - `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
-         * 	 - `metainfo` (Array) - An Array of metadata groups. Each group has a name property and an items Array
-         *     which contains key/value pairs
-         * 	 - `workbook.hierarchyLevel` - Name of the property that contains the hierarchy level information of
-         *     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:
-         * 	`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
-         * 	 - `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.
-         * 	 - `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.
-         * 	 - `sizeLimit` (number) - Maximum allowed number of records that can be obtained from the service in
-         *     a single request
-         * 	 - `downloadLimit` (number) - Maximum allowed number of rows that can be exported. If not specified,
-         *     all rows are exported.
-         * 	 - `count` (number) - The maximal number of records to export. If not specified, all data from the data
-         *     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.
-         *  **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`.
-         * 	 - `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.
          * Column configuration, data source, and export settings must be provided in the constructor. The `build`
          * method opens a progress dialog and starts an asynchronous export process. The export process fetches
@@ -765,91 +684,7 @@ declare namespace sap {
           /**
            * Export settings
            */
-          mSettings: {
-            /**
-             * Spreadsheet properties
-             */
-            workbook: {
-              /**
-               * Column configuration
-               */
-              columns: any[];
-              /**
-               * Export context that will be applied to the exported file
-               */
-              context?: {
-                /**
-                 * Application that created this XLSX
-                 */
-                application?: string;
-                /**
-                 * Application version that was used to create this XLSX
-                 */
-                version?: string;
-                /**
-                 * Title of the XLSX document (NOT the file name)
-                 */
-                title?: string;
-                /**
-                 * User context for the exported document
-                 */
-                modifiedBy?: string;
-                /**
-                 * The name of the data sheet that will be shown in Excel
-                 */
-                sheetName?: string;
-                /**
-                 * The name of the metadata sheet that will be shown in Excel
-                 */
-                metaSheetName?: string;
-                /**
-                 * Optional Metadata that will be displayed in the additional Metadata Sheet
-                 */
-                metainfo?: any[];
-              };
-              /**
-               * Optional name of the property that contains hierarchy level information
-               */
-              hierarchyLevel?: string;
-            };
-            /**
-             * Source of spreadsheet data. A JSON array, data source properties map, `sap.ui.model.ListBinding`, `sap.ui.model.TreeBinding`
-             * or URL to an OData source can be provided. For example, `"someUrl"` is an equivalent to `{dataUrl:"someUrl",
-             * type:"OData"}`. An instance of `sap.ui.model.ListBinding` or `sap.ui.model.TreeBinding` either has to
-             * implement a `#getDownloadUrl` function or needs to be a ClientListBinding. **Note:** `sap.ui.model.ClientTreeBinding`
-             * is not supported.
-             */
-            dataSource:
-              | string
-              | {
-                  /**
-                   * Maximal allowed number of records that can be obtained from the service in a single request
-                   */
-                  sizeLimit: int;
-                }
-              | any[]
-              | sap.ui.model.ListBinding
-              | sap.ui.model.TreeBinding;
-            /**
-             * The maximal number of records to export
-             */
-            count?: int;
-            /**
-             * 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.
-             *  **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.
-             */
-            worker?: boolean;
-            /**
-             * Optional file name for the exported file
-             */
-            fileName?: string;
-            /**
-             * Set to `false` to suppress the progress dialog
-             */
-            showProgress?: boolean;
-          }
+          mSettings: sap.ui.export.SpreadsheetSettings
         );
 
         /**
@@ -1035,6 +870,220 @@ declare namespace sap {
          */
         XLSX = "XLSX",
       }
+
+      type Column = {
+        /**
+         * Column header text.
+         */
+        label?: string;
+        /**
+         * Field name or array of field names in the data source feed.
+         */
+        property?: string | string[];
+        /**
+         * Data type of the field.
+         */
+        type?: sap.ui.export.EdmType;
+        /**
+         * 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.
+         */
+        width?: number;
+        /**
+         * Horizontal alignment of cell contents. Accepted values: `left`, `right`, `center`, `begin`, `end`. If
+         * not specified, the columns are aligned based on the type.
+         */
+        textAlign?: string;
+        /**
+         * Number of digits after the decimal point for numeric values.
+         */
+        scale?: number;
+        /**
+         * Allows automatic scale assignment based on unit of measure.
+         */
+        autoScale?: boolean;
+        /**
+         * Whether to display thousands separators in numeric values.
+         */
+        delimiter?: boolean;
+        /**
+         * 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.
+         */
+        unit?: string;
+        /**
+         * Name of the data source field that contains the unit/currency text.
+         */
+        unitProperty?: string;
+        /**
+         * Defines if the currency is shown in the column (applies to currency values only).
+         */
+        displayUnit?: boolean;
+        /**
+         * Textual representation of a boolean type that has the value `true`.
+         */
+        trueValue?: string;
+        /**
+         * Textual representation of a boolean type that has the value `false`.
+         */
+        falseValue?: string;
+        /**
+         * Formatting template that supports indexed placeholders within curly brackets.
+         */
+        template?: string;
+        /**
+         * Output format for columns of type Date/DateTime/Time.
+         */
+        format?: string;
+        /**
+         * Formatting template for string-formatted dates.
+         */
+        inputFormat?: string;
+        /**
+         * Whether the `DateTime` is displayed as UTC or local time.
+         */
+        utc?: boolean;
+        /**
+         * Defines a fixed IANA time zone.
+         */
+        timezone?: string;
+        /**
+         * References an OData property that contains the specific IANA time zone.
+         */
+        timezoneProperty?: string;
+        /**
+         * Whether the IANA time zone is displayed within a cell.
+         */
+        displayTimezone?: boolean;
+        /**
+         * Mapping object or Map containing the values that should be mapped to a particular key.
+         */
+        valueMap?: object;
+        /**
+         * Indicates if wrapping is enabled for this particular column.
+         */
+        wrap?: boolean;
+      };
+
+      type SpreadsheetSettings = {
+        /**
+         * Spreadsheet properties object.
+         */
+        workbook: {
+          /**
+           * Column configurations.
+           */
+          columns: sap.ui.export.Column[];
+          /**
+           * Export context that will be applied to the exported file.
+           */
+          context?: {
+            /**
+             * The application that creates the XLSX document.
+             */
+            application?: string;
+            /**
+             * Application version that creates the XLSX document.
+             */
+            version?: string;
+            /**
+             * Title of the XLSX document (NOT the file name).
+             */
+            title?: string;
+            /**
+             * User context for the XLSX document.
+             */
+            modifiedBy?: string;
+            /**
+             * The label of the data sheet.
+             */
+            sheetName?: string;
+            /**
+             * The label of the metadata sheet. The sheet will not be shown unless metadata entries are provided
+             */
+            metaSheetName?: string;
+            /**
+             * Metadata groups with key/value pairs.
+             */
+            metainfo?: Array<{
+              name: string;
+
+              items: Array<{
+                key: string;
+
+                value: string;
+              }>;
+            }>;
+          };
+          /**
+           * Name of the property that contains hierarchy level information.
+           */
+          hierarchyLevel?: string;
+        };
+        /**
+         * Source of spreadsheet data. Can be an array with row data, an URL, a binding instance, or an OData properties
+         * object.
+         */
+        dataSource:
+          | string
+          | {
+              /**
+               * Type of the data source. Currently, only OData is supported and the value has to be set to "odata".
+               */
+              type: "odata";
+              /**
+               * URL to table data on the server, including all select, filter, and search query parameters.
+               */
+              dataUrl: string;
+              /**
+               * URL to the OData service. Required for OData batch requests.
+               */
+              serviceUrl?: string;
+              /**
+               * Count of available records on the server.
+               */
+              count?: number;
+              /**
+               * Whether batch requests are used to fetch the spreadsheet data. In this case, `serviceUrl` and `headers`
+               * have to be specified, too.
+               */
+              useBatch?: boolean;
+              /**
+               * Map of HTTP request header properties.
+               */
+              headers?: Record<string, string>;
+              /**
+               * Maximum allowed number of records that can be obtained from the service in a single request.
+               */
+              sizeLimit?: number;
+              /**
+               * Maximum allowed number of rows that can be exported. If not specified, all rows are exported.
+               */
+              downloadLimit?: number;
+            }
+          | any[]
+          | sap.ui.model.ListBinding
+          | sap.ui.model.TreeBinding;
+        /**
+         * The maximal number of records to export. If not specified, all data from the data source is fetched.
+         */
+        count?: number;
+        /**
+         * Whether to run the export process in a worker or the main thread.
+         */
+        worker?: boolean;
+        /**
+         * File name for the exported file.
+         */
+        fileName?: string;
+        /**
+         * Whether to show the progress dialog.
+         */
+        showProgress?: boolean;
+      };
+
       /**
        * Event object of the ExportBase#beforeExport event.
        */

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.136.2
+// For Library Version: 1.138.0
 
 declare namespace sap {
   namespace ui {
@@ -1456,8 +1456,6 @@ declare namespace sap {
 
     "sap/ui/fl/changeHandler/BaseRename": undefined;
 
-    "sap/ui/fl/ChangePersistenceFactory": undefined;
-
     "sap/ui/fl/descriptorRelated/api/DescriptorChange": undefined;
 
     "sap/ui/fl/descriptorRelated/api/DescriptorChangeFactory": undefined;
@@ -1466,8 +1464,6 @@ declare namespace sap {
 
     "sap/ui/fl/descriptorRelated/api/DescriptorVariantFactory": undefined;
 
-    "sap/ui/fl/FlexControllerFactory": undefined;
-
     "sap/ui/fl/initial/_internal/connectors/BackendConnector": undefined;
 
     "sap/ui/fl/initial/_internal/connectors/BtpServiceConnector": undefined;
@@ -1484,6 +1480,8 @@ declare namespace sap {
 
     "sap/ui/fl/initial/_internal/connectors/Utils": undefined;
 
+    "sap/ui/fl/initial/_internal/Settings": undefined;
+
     "sap/ui/fl/initial/_internal/Storage": undefined;
 
     "sap/ui/fl/initial/_internal/StorageUtils": undefined;
@@ -1496,8 +1494,6 @@ declare namespace sap {
 
     "sap/ui/fl/library": undefined;
 
-    "sap/ui/fl/registry/Settings": undefined;
-
     "sap/ui/fl/support/_internal/getAllUIChanges": undefined;
 
     "sap/ui/fl/support/_internal/getChangeDependencies": undefined;

package/types/sap.ui.generic.app.d.ts

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

package/types/sap.ui.generic.template.d.ts

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.136.2
+// For Library Version: 1.138.0
 
 declare namespace sap {
   namespace ui {
@@ -495,12 +495,11 @@ declare namespace sap {
           /**
            * Gets translated text from the i18n properties files configured for this card.
            *
-           * For more details see {@link module:sap/base/i18n/ResourceBundle#getText}.
+           * This method uses `ResourceBundle.getText()`. For more details see {@link module:sap/base/i18n/ResourceBundle#getText}.
            *
-           * @experimental As of version 1.83. The API might change.
            *
-           * @returns The value belonging to the key, if found; otherwise the key itself or `undefined` depending
-           * on `bIgnoreKeyFallback`.
+           * @returns The value belonging to the key, if found; otherwise, it returns the key itself or `undefined`
+           * depending on `bIgnoreKeyFallback`.
            */
           getTranslatedText(
             /**
@@ -519,7 +518,7 @@ declare namespace sap {
              * fallback bundle.
              */
             bIgnoreKeyFallback?: boolean
-          ): string;
+          ): string | undefined;
           /**
            * Hide the blocking message that is shown in the card by `showBlockingMessage` call.
            *
@@ -634,15 +633,26 @@ declare namespace sap {
                */
               method?: string;
               /**
-               * The request parameters. If the HTTP method is "POST", "PUT", "PATCH", or "DELETE" the parameters will
-               * be put into the body of the request.
+               * The request parameters to be sent to the server. They are sent as follows:
+               * 	 -  When the HTTP method is "GET" or "HEAD", and parameters are set as:
+               * 	object - Sent as part of the URL, appended as key/value pairs in the query string
+               * 	 - FormData - Not sent
+               * 	 - string - Not sent
+               * 	 -  When the HTTP method is "POST", "PUT", "PATCH", or "DELETE", the parameters will be sent in the
+               *     request body, encoded based on the `Content-Type` header and parameters type:
+               * 	 object - Supports the following encodings, decided based on the Content-Type header of the request:
                *
-               * **Note:** If parameters are of type "FormData", the "FormData" will not be resolved for bindings, destinations
-               * and others. It will be sent as it is.
+               * 	`application/x-www-form-urlencoded` - Default
+               * 	 - `application/json`
+               * 	 -  FormData - Encoded as `multipart/form-data`. The `Content-Type` header on the request must not be
+               *     set explicitly. **Note:** FormData will not be resolved for bindings, destinations and others. It will
+               *     be sent as it is. Added since version 1.130
+               * 	 - string - Must be used in combination with `Content-Type: text/plain`. Will be sent as is. Added since
+               *     version 1.138
                */
-              parameters?: object | FormData;
+              parameters?: object | FormData | string;
               /**
-               * Deprecated. Use the correct Accept headers and correct Content-Type header in the response.
+               * Deprecated. Use the correct `Accept` headers and set correct `Content-Type` header in the response.
                */
               dataType?: string;
               /**
@@ -1779,12 +1789,11 @@ declare namespace sap {
           /**
            * Gets translated text from the i18n properties files configured for this card.
            *
-           * For more details see {@link module:sap/base/i18n/ResourceBundle#getText}.
+           * This method uses `ResourceBundle.getText()`. For more details see {@link module:sap/base/i18n/ResourceBundle#getText}.
            *
-           * @experimental As of version 1.83. The API might change.
            *
-           * @returns The value belonging to the key, if found; otherwise the key itself or `undefined` depending
-           * on `bIgnoreKeyFallback`.
+           * @returns The value belonging to the key, if found; otherwise, it returns the key itself or `undefined`
+           * depending on `bIgnoreKeyFallback`.
            */
           getTranslatedText(
             /**
@@ -1803,7 +1812,7 @@ declare namespace sap {
              * fallback bundle.
              */
             bIgnoreKeyFallback?: boolean
-          ): string;
+          ): string | undefined;
           /**
            * Gets current value of property {@link #getUseProgressiveDisclosure useProgressiveDisclosure}.
            *
@@ -1963,15 +1972,26 @@ declare namespace sap {
                */
               method?: string;
               /**
-               * The request parameters. If the HTTP method is "POST", "PUT", "PATCH", or "DELETE" the parameters will
-               * be put into the body of the request.
+               * The request parameters to be sent to the server. They are sent as follows:
+               * 	 -  When the HTTP method is "GET" or "HEAD", and parameters are set as:
+               * 	object - Sent as part of the URL, appended as key/value pairs in the query string
+               * 	 - FormData - Not sent
+               * 	 - string - Not sent
+               * 	 -  When the HTTP method is "POST", "PUT", "PATCH", or "DELETE", the parameters will be sent in the
+               *     request body, encoded based on the `Content-Type` header and parameters type:
+               * 	 object - Supports the following encodings, decided based on the Content-Type header of the request:
                *
-               * **Note:** If parameters are of type "FormData", the "FormData" will not be resolved for bindings, destinations
-               * and others. It will be sent as it is.
+               * 	`application/x-www-form-urlencoded` - Default
+               * 	 - `application/json`
+               * 	 -  FormData - Encoded as `multipart/form-data`. The `Content-Type` header on the request must not be
+               *     set explicitly. **Note:** FormData will not be resolved for bindings, destinations and others. It will
+               *     be sent as it is. Added since version 1.130
+               * 	 - string - Must be used in combination with `Content-Type: text/plain`. Will be sent as is. Added since
+               *     version 1.138
                */
-              parameters?: object | FormData;
+              parameters?: object | FormData | string;
               /**
-               * Deprecated. Use the correct Accept headers and correct Content-Type header in the response.
+               * Deprecated. Use the correct `Accept` headers and set correct `Content-Type` header in the response.
                */
               dataType?: string;
               /**
@@ -3513,7 +3533,7 @@ declare namespace sap {
          *
          * @returns Value of property `formatters`
          */
-        getFormatters(): Record<string, () => void> | undefined;
+        getFormatters(): Record<string, Function> | undefined;
         /**
          * Override this method to lazy load dependencies for the extension.
          *

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

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