@openui5/types 1.136.3 → 1.139.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.136.3
1
+ // For Library Version: 1.139.0
2
2
 
3
3
  declare module "sap/ui/fl/library" {}
4
4
 
@@ -1647,8 +1647,6 @@ declare namespace sap {
1647
1647
 
1648
1648
  "sap/ui/fl/changeHandler/BaseRename": undefined;
1649
1649
 
1650
- "sap/ui/fl/ChangePersistenceFactory": undefined;
1651
-
1652
1650
  "sap/ui/fl/descriptorRelated/api/DescriptorChange": undefined;
1653
1651
 
1654
1652
  "sap/ui/fl/descriptorRelated/api/DescriptorChangeFactory": undefined;
@@ -1657,8 +1655,6 @@ declare namespace sap {
1657
1655
 
1658
1656
  "sap/ui/fl/descriptorRelated/api/DescriptorVariantFactory": undefined;
1659
1657
 
1660
- "sap/ui/fl/FlexControllerFactory": undefined;
1661
-
1662
1658
  "sap/ui/fl/initial/_internal/connectors/BackendConnector": undefined;
1663
1659
 
1664
1660
  "sap/ui/fl/initial/_internal/connectors/BtpServiceConnector": undefined;
@@ -1675,6 +1671,8 @@ declare namespace sap {
1675
1671
 
1676
1672
  "sap/ui/fl/initial/_internal/connectors/Utils": undefined;
1677
1673
 
1674
+ "sap/ui/fl/initial/_internal/Settings": undefined;
1675
+
1678
1676
  "sap/ui/fl/initial/_internal/Storage": undefined;
1679
1677
 
1680
1678
  "sap/ui/fl/initial/_internal/StorageUtils": undefined;
@@ -1687,8 +1685,6 @@ declare namespace sap {
1687
1685
 
1688
1686
  "sap/ui/fl/library": undefined;
1689
1687
 
1690
- "sap/ui/fl/registry/Settings": undefined;
1691
-
1692
1688
  "sap/ui/fl/support/_internal/getAllUIChanges": undefined;
1693
1689
 
1694
1690
  "sap/ui/fl/support/_internal/getChangeDependencies": undefined;
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.136.3
1
+ // For Library Version: 1.139.0
2
2
 
3
3
  declare module "sap/ui/integration/library" {
4
4
  import { URI } from "sap/ui/core/library";
@@ -956,7 +956,7 @@ declare module "sap/ui/integration/widgets/Card" {
956
956
  } from "sap/ui/base/ManagedObject";
957
957
 
958
958
  /**
959
- * Settings for blocking message that ocurred in a {@link sap.ui.integration.widgets.Card}
959
+ * Settings for blocking message that occurred in a {@link sap.ui.integration.widgets.Card}
960
960
  *
961
961
  * @experimental As of version 1.114.
962
962
  */
@@ -998,6 +998,29 @@ declare module "sap/ui/integration/widgets/Card" {
998
998
  additionalContent?: any[];
999
999
  };
1000
1000
 
1001
+ /**
1002
+ * Settings for card request error.
1003
+ *
1004
+ * **Note:** For backward compatibility, the object can also be accessed as an array with the properties
1005
+ * in the order - message, response, and responseText.
1006
+ *
1007
+ * @experimental As of version 1.139.
1008
+ */
1009
+ export type CardRequestError = {
1010
+ /**
1011
+ * The error message
1012
+ */
1013
+ message: string;
1014
+ /**
1015
+ * The response object
1016
+ */
1017
+ response: object;
1018
+ /**
1019
+ * The response text
1020
+ */
1021
+ responseText: string;
1022
+ };
1023
+
1001
1024
  /**
1002
1025
  * A control that represents a container with a header and content.
1003
1026
  *
@@ -1718,12 +1741,11 @@ declare module "sap/ui/integration/widgets/Card" {
1718
1741
  /**
1719
1742
  * Gets translated text from the i18n properties files configured for this card.
1720
1743
  *
1721
- * For more details see {@link module:sap/base/i18n/ResourceBundle#getText}.
1744
+ * This method uses `ResourceBundle.getText()`. For more details see {@link module:sap/base/i18n/ResourceBundle#getText}.
1722
1745
  *
1723
- * @experimental As of version 1.83. The API might change.
1724
1746
  *
1725
- * @returns The value belonging to the key, if found; otherwise the key itself or `undefined` depending
1726
- * on `bIgnoreKeyFallback`.
1747
+ * @returns The value belonging to the key, if found; otherwise, it returns the key itself or `undefined`
1748
+ * depending on `bIgnoreKeyFallback`.
1727
1749
  */
1728
1750
  getTranslatedText(
1729
1751
  /**
@@ -1742,7 +1764,7 @@ declare module "sap/ui/integration/widgets/Card" {
1742
1764
  * fallback bundle.
1743
1765
  */
1744
1766
  bIgnoreKeyFallback?: boolean
1745
- ): string;
1767
+ ): string | undefined;
1746
1768
  /**
1747
1769
  * Gets current value of property {@link #getUseProgressiveDisclosure useProgressiveDisclosure}.
1748
1770
  *
@@ -1875,9 +1897,15 @@ declare module "sap/ui/integration/widgets/Card" {
1875
1897
  */
1876
1898
  removeAllActionDefinitions(): ActionDefinition[];
1877
1899
  /**
1878
- * Performs an HTTP request using the given configuration.
1900
+ * Performs an asynchronous network request using the specified request settings, enabling dynamic bindings
1901
+ * to card configurations, such as CSRF tokens, destinations, and parameters. If the request is successful,
1902
+ * it returns a Promise that resolves with the response data.
1879
1903
  *
1880
- * @experimental As of version 1.79.
1904
+ * If an error occurs during the request, the Promise will reject with a {@link sap.ui.integration.CardRequestError}.
1905
+ *
1906
+ * For more details on card data handling and request settings see [Card Explorer Data Section]{@link https://ui5.sap.com/test-resources/sap/ui/integration/demokit/cardExplorer/webapp/index.html#/learn/features/data}.
1907
+ *
1908
+ * @since 1.79
1881
1909
  *
1882
1910
  * @returns Resolves when the request is successful, rejects otherwise.
1883
1911
  */
@@ -1899,15 +1927,26 @@ declare module "sap/ui/integration/widgets/Card" {
1899
1927
  */
1900
1928
  method?: string;
1901
1929
  /**
1902
- * The request parameters. If the HTTP method is "POST", "PUT", "PATCH", or "DELETE" the parameters will
1903
- * be put into the body of the request.
1930
+ * The request parameters to be sent to the server. They are sent as follows:
1931
+ * - When the HTTP method is "GET" or "HEAD", and parameters are set as:
1932
+ * object - Sent as part of the URL, appended as key/value pairs in the query string
1933
+ * - FormData - Not sent
1934
+ * - string - Not sent
1935
+ * - When the HTTP method is "POST", "PUT", "PATCH", or "DELETE", the parameters will be sent in the
1936
+ * request body, encoded based on the `Content-Type` header and parameters type:
1937
+ * object - Supports the following encodings, decided based on the Content-Type header of the request:
1904
1938
  *
1905
- * **Note:** If parameters are of type "FormData", the "FormData" will not be resolved for bindings, destinations
1906
- * and others. It will be sent as it is.
1939
+ * `application/x-www-form-urlencoded` - Default
1940
+ * - `application/json`
1941
+ * - FormData - Encoded as `multipart/form-data`. The `Content-Type` header on the request must not be
1942
+ * set explicitly. **Note:** FormData will not be resolved for bindings, destinations and others. It will
1943
+ * be sent as it is. Added since version 1.130
1944
+ * - string - Must be used in combination with `Content-Type: text/plain`. Will be sent as is. Added since
1945
+ * version 1.138
1907
1946
  */
1908
- parameters?: object | FormData;
1947
+ parameters?: object | FormData | string;
1909
1948
  /**
1910
- * Deprecated. Use the correct Accept headers and correct Content-Type header in the response.
1949
+ * Deprecated. Use the correct `Accept` headers and set correct `Content-Type` header in the response.
1911
1950
  */
1912
1951
  dataType?: string;
1913
1952
  /**
@@ -1915,7 +1954,8 @@ declare module "sap/ui/integration/widgets/Card" {
1915
1954
  */
1916
1955
  headers?: object;
1917
1956
  /**
1918
- * Indicates whether cross-site requests should be made using credentials.
1957
+ * Indicates whether cross-site requests should be made using credentials. Same-origin requests are always
1958
+ * made using credentials.
1919
1959
  */
1920
1960
  withCredentials?: boolean;
1921
1961
  }
@@ -2358,12 +2398,11 @@ declare module "sap/ui/integration/widgets/Card" {
2358
2398
  /**
2359
2399
  * Gets translated text from the i18n properties files configured for this card.
2360
2400
  *
2361
- * For more details see {@link module:sap/base/i18n/ResourceBundle#getText}.
2401
+ * This method uses `ResourceBundle.getText()`. For more details see {@link module:sap/base/i18n/ResourceBundle#getText}.
2362
2402
  *
2363
- * @experimental As of version 1.83. The API might change.
2364
2403
  *
2365
- * @returns The value belonging to the key, if found; otherwise the key itself or `undefined` depending
2366
- * on `bIgnoreKeyFallback`.
2404
+ * @returns The value belonging to the key, if found; otherwise, it returns the key itself or `undefined`
2405
+ * depending on `bIgnoreKeyFallback`.
2367
2406
  */
2368
2407
  getTranslatedText(
2369
2408
  /**
@@ -2382,7 +2421,7 @@ declare module "sap/ui/integration/widgets/Card" {
2382
2421
  * fallback bundle.
2383
2422
  */
2384
2423
  bIgnoreKeyFallback?: boolean
2385
- ): string;
2424
+ ): string | undefined;
2386
2425
  /**
2387
2426
  * Hide the blocking message that is shown in the card by `showBlockingMessage` call.
2388
2427
  *
@@ -2470,9 +2509,15 @@ declare module "sap/ui/integration/widgets/Card" {
2470
2509
  vActionDefinition: int | string | ActionDefinition
2471
2510
  ): ActionDefinition | null;
2472
2511
  /**
2473
- * Performs an HTTP request using the given configuration.
2512
+ * Performs an asynchronous network request using the specified request settings, enabling dynamic bindings
2513
+ * to card configurations, such as CSRF tokens, destinations, and parameters. If the request is successful,
2514
+ * it returns a Promise that resolves with the response data.
2474
2515
  *
2475
- * @experimental As of version 1.79.
2516
+ * If an error occurs during the request, the Promise will reject with a {@link sap.ui.integration.CardRequestError}.
2517
+ *
2518
+ * For more details on card data handling and request settings see [Card Explorer Data Section]{@link https://ui5.sap.com/test-resources/sap/ui/integration/demokit/cardExplorer/webapp/index.html#/learn/features/data}.
2519
+ *
2520
+ * @since 1.79
2476
2521
  *
2477
2522
  * @returns Resolves when the request is successful, rejects otherwise.
2478
2523
  */
@@ -2494,15 +2539,26 @@ declare module "sap/ui/integration/widgets/Card" {
2494
2539
  */
2495
2540
  method?: string;
2496
2541
  /**
2497
- * The request parameters. If the HTTP method is "POST", "PUT", "PATCH", or "DELETE" the parameters will
2498
- * be put into the body of the request.
2542
+ * The request parameters to be sent to the server. They are sent as follows:
2543
+ * - When the HTTP method is "GET" or "HEAD", and parameters are set as:
2544
+ * object - Sent as part of the URL, appended as key/value pairs in the query string
2545
+ * - FormData - Not sent
2546
+ * - string - Not sent
2547
+ * - When the HTTP method is "POST", "PUT", "PATCH", or "DELETE", the parameters will be sent in the
2548
+ * request body, encoded based on the `Content-Type` header and parameters type:
2549
+ * object - Supports the following encodings, decided based on the Content-Type header of the request:
2499
2550
  *
2500
- * **Note:** If parameters are of type "FormData", the "FormData" will not be resolved for bindings, destinations
2501
- * and others. It will be sent as it is.
2551
+ * `application/x-www-form-urlencoded` - Default
2552
+ * - `application/json`
2553
+ * - FormData - Encoded as `multipart/form-data`. The `Content-Type` header on the request must not be
2554
+ * set explicitly. **Note:** FormData will not be resolved for bindings, destinations and others. It will
2555
+ * be sent as it is. Added since version 1.130
2556
+ * - string - Must be used in combination with `Content-Type: text/plain`. Will be sent as is. Added since
2557
+ * version 1.138
2502
2558
  */
2503
- parameters?: object | FormData;
2559
+ parameters?: object | FormData | string;
2504
2560
  /**
2505
- * Deprecated. Use the correct Accept headers and correct Content-Type header in the response.
2561
+ * Deprecated. Use the correct `Accept` headers and set correct `Content-Type` header in the response.
2506
2562
  */
2507
2563
  dataType?: string;
2508
2564
  /**
@@ -2510,7 +2566,8 @@ declare module "sap/ui/integration/widgets/Card" {
2510
2566
  */
2511
2567
  headers?: object;
2512
2568
  /**
2513
- * Indicates whether cross-site requests should be made using credentials.
2569
+ * Indicates whether cross-site requests should be made using credentials. Same-origin requests are always
2570
+ * made using credentials.
2514
2571
  */
2515
2572
  withCredentials?: boolean;
2516
2573
  }
@@ -3706,7 +3763,7 @@ declare module "sap/ui/integration/Extension" {
3706
3763
  *
3707
3764
  * @returns Value of property `formatters`
3708
3765
  */
3709
- getFormatters(): Record<string, () => void> | undefined;
3766
+ getFormatters(): Record<string, Function> | undefined;
3710
3767
  /**
3711
3768
  * Override this method to lazy load dependencies for the extension.
3712
3769
  *
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.136.3
1
+ // For Library Version: 1.139.0
2
2
 
3
3
  declare module "sap/ui/layout/library" {
4
4
  import Control from "sap/ui/core/Control";