@sapui5/ts-types 1.106.0 → 1.107.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.
Files changed (65) hide show
  1. package/README.md +6 -2
  2. package/package.json +1 -1
  3. package/types/sap.apf.d.ts +1 -1
  4. package/types/sap.ca.ui.d.ts +1 -1
  5. package/types/sap.chart.d.ts +1 -1
  6. package/types/sap.collaboration.d.ts +1 -1
  7. package/types/sap.esh.search.ui.d.ts +63 -25
  8. package/types/sap.f.d.ts +810 -163
  9. package/types/sap.fe.common.d.ts +1 -1
  10. package/types/sap.fe.core.d.ts +47 -47
  11. package/types/sap.fe.macros.d.ts +82 -6
  12. package/types/sap.fe.navigation.d.ts +1 -1
  13. package/types/sap.fe.templates.d.ts +51 -4
  14. package/types/sap.fe.test.d.ts +1 -1
  15. package/types/sap.feedback.ui.d.ts +1 -1
  16. package/types/sap.gantt.d.ts +9 -1
  17. package/types/sap.insights.d.ts +1 -1
  18. package/types/sap.landvisz.d.ts +1 -1
  19. package/types/sap.m.d.ts +149 -99
  20. package/types/sap.makit.d.ts +1 -1
  21. package/types/sap.me.d.ts +1 -1
  22. package/types/sap.ndc.d.ts +1 -1
  23. package/types/sap.ovp.d.ts +1 -1
  24. package/types/sap.rules.ui.d.ts +1 -1
  25. package/types/sap.sac.df.d.ts +301 -1
  26. package/types/sap.sac.grid.d.ts +1 -1
  27. package/types/sap.suite.ui.commons.d.ts +2 -37
  28. package/types/sap.suite.ui.generic.template.d.ts +15 -2
  29. package/types/sap.suite.ui.microchart.d.ts +1 -1
  30. package/types/sap.tnt.d.ts +1 -1
  31. package/types/sap.ui.codeeditor.d.ts +1 -1
  32. package/types/sap.ui.commons.d.ts +1 -1
  33. package/types/sap.ui.comp.d.ts +61 -1
  34. package/types/sap.ui.core.d.ts +443 -147
  35. package/types/sap.ui.dt.d.ts +1 -1
  36. package/types/sap.ui.export.d.ts +1 -1
  37. package/types/sap.ui.fl.d.ts +3 -1
  38. package/types/sap.ui.generic.app.d.ts +1 -1
  39. package/types/sap.ui.generic.template.d.ts +1 -1
  40. package/types/sap.ui.integration.d.ts +195 -19
  41. package/types/sap.ui.layout.d.ts +1 -1
  42. package/types/sap.ui.mdc.d.ts +5 -1
  43. package/types/sap.ui.richtexteditor.d.ts +36 -17
  44. package/types/sap.ui.rta.d.ts +1 -1
  45. package/types/sap.ui.suite.d.ts +1 -1
  46. package/types/sap.ui.support.d.ts +1 -1
  47. package/types/sap.ui.table.d.ts +7 -7
  48. package/types/sap.ui.testrecorder.d.ts +1 -1
  49. package/types/sap.ui.unified.d.ts +1 -1
  50. package/types/sap.ui.ux3.d.ts +1 -1
  51. package/types/sap.ui.vbm.d.ts +1 -1
  52. package/types/sap.ui.vk.d.ts +1 -1
  53. package/types/sap.ui.vtm.d.ts +1 -1
  54. package/types/sap.ui.webc.common.d.ts +1 -1
  55. package/types/sap.ui.webc.fiori.d.ts +1 -1
  56. package/types/sap.ui.webc.main.d.ts +1 -1
  57. package/types/sap.uiext.inbox.d.ts +1 -1
  58. package/types/sap.ushell.d.ts +1 -1
  59. package/types/sap.ushell_abap.d.ts +1 -1
  60. package/types/sap.uxap.d.ts +36 -1
  61. package/types/sap.viz.d.ts +1 -1
  62. package/types/sap.webanalytics.core.d.ts +1 -1
  63. package/types/sap.zen.commons.d.ts +1 -1
  64. package/types/sap.zen.crosstab.d.ts +1 -1
  65. package/types/sap.zen.dsh.d.ts +1 -1
package/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # @sapui5/ts-types
4
4
 
5
- This npm package contains the types signatures (based on globals) for all the SAPUI5 libraries.
5
+ This npm package contains the types signatures (based on deprecated globals, see below) for all the SAPUI5 libraries.
6
6
 
7
7
  These signatures can be used to:
8
8
 
@@ -11,12 +11,16 @@ These signatures can be used to:
11
11
 
12
12
  These two capabilities are available both for SAPUI5 apps written in TypeScript **and** in JavaScript.
13
13
 
14
- <b>NOTE:</b> "based on globals" means that it supports the usage of the global "sap" object and the huge tree below this global object containing all modules and controls. But this usage is <b>no longer recommended</b>. In traditional JavaScript, UI5 application code should use the asynchronous sap.ui.define()/sap.ui.require() calls instead and for TypeScript code we recommend using ES6 module syntax provided by the [@sapui5/ts-types-esm](https://www.npmjs.com/package/@sapui5/ts-types-esm) package. So better use that one instead of this package.
14
+ <b>NOTE:</b> "based on globals" means that it supports the usage of the global "sap" object and the huge tree below this global object containing all modules and controls. But this usage is <b>no longer recommended</b>. In traditional JavaScript, UI5 application code should use the asynchronous `sap.ui.define()`/`sap.ui.require()` calls instead and for TypeScript code we recommend using ES6 module syntax provided by the [@sapui5/ts-types-esm](https://www.npmjs.com/package/@sapui5/ts-types-esm) package. So better use that one instead of this package.
15
15
 
16
16
  ## Status
17
17
 
18
18
  This project is in an experimental **_Beta State_**. Significant changes are likely to occur,
19
19
  including potential **breaking changes**.
20
20
 
21
+ For information on changes in the type definitions, in particular ones which require adaptation, please refer to the [Release Notes](https://sap.github.io/ui5-typescript/releasenotes.html).
22
+
23
+ The central entry point for all information about using UI5 with TypeScript (incl. sample apps and templates) is at https://sap.github.io/ui5-typescript.
24
+
21
25
  ## License
22
26
  This package is provided under the terms of the [SAP Developer License Agreement](https://tools.hana.ondemand.com/developer-license-3.1.txt).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sapui5/ts-types",
3
- "version": "1.106.0",
3
+ "version": "1.107.0",
4
4
  "description": "SAPUI5 TypeScript Definitions",
5
5
  "homepage": "https://ui5.sap.com",
6
6
  "author": "SAP SE (https://www.sap.com)",
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.106.0
1
+ // For Library Version: 1.107.0
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.106.0
1
+ // For Library Version: 1.107.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ca {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.106.0
1
+ // For Library Version: 1.107.1
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.106.0
1
+ // For Library Version: 1.107.0
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.106.0
1
+ // For Library Version: 1.107.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace esh {
@@ -68,14 +68,12 @@ declare namespace sap {
68
68
  * @SINCE 1.98.0
69
69
  *
70
70
  * Defines selectable search result view types. The value can be set/get in attach event "searchFinished".
71
- * Case 1, Search in Apps: result is displayed in a mandatory view type `["appSearchResult"]`, and it is
72
- * not switchable. Case 2.1, Search in All or other Category (configuration.isUshell !== true): result is
73
- * switchable between different view types. Possible values for the array items are `"searchResultList"`
74
- * and `"searchResultGrid"`. Case 2.2, Search in All or other Category (configuration.isUshell === true):
75
- * result is displayed in a mandatory view type `["searchResultList"]`. Case 3, Search in Business Object:
76
- * result is switchable between different view types. Possible values for the array items are `"searchResultList"`,
77
- * `"searchResultTable"` and `"searchResultGrid"`. Note: The value of `resultViewTypes` and `resultViewType`
78
- * must be compatible to each other.
71
+ * Case 1: Search in Apps: result is displayed in a mandatory view type `["appSearchResult"]`, and it is
72
+ * not switchable. Case 2: Search in All or other Category: result is switchable between different view
73
+ * types. Possible values for the array items are `"searchResultList"` and `"searchResultGrid"`. Case 3,
74
+ * Search in Business Object: result is switchable between different view types. Possible values for the
75
+ * array items are `"searchResultList"`, `"searchResultTable"` and `"searchResultGrid"`. Note: The value
76
+ * of `resultViewTypes` and `resultViewType` must be compatible to each other.
79
77
  */
80
78
  resultViewTypes?:
81
79
  | string[]
@@ -165,6 +163,17 @@ declare namespace sap {
165
163
  | sap.ui.base.ManagedObject.PropertyBindingInfo
166
164
  | `{${string}}`;
167
165
 
166
+ /**
167
+ * @SINCE 1.107.0
168
+ *
169
+ * Enables the query language for the hana_odata provider. With query language it is possible for the end
170
+ * user to enter complex search queries with logical operators.
171
+ */
172
+ enableQueryLanguage?:
173
+ | boolean
174
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
175
+ | `{${string}}`;
176
+
168
177
  /**
169
178
  * Control instances which are part of this composite control.
170
179
  */
@@ -477,6 +486,19 @@ declare namespace sap {
477
486
  * @returns Value of property `dataSource`
478
487
  */
479
488
  getDataSource(): string;
489
+ /**
490
+ * @SINCE 1.107.0
491
+ *
492
+ * Gets current value of property {@link #getEnableQueryLanguage enableQueryLanguage}.
493
+ *
494
+ * Enables the query language for the hana_odata provider. With query language it is possible for the end
495
+ * user to enter complex search queries with logical operators.
496
+ *
497
+ * Default value is `false`.
498
+ *
499
+ * @returns Value of property `enableQueryLanguage`
500
+ */
501
+ getEnableQueryLanguage(): boolean;
480
502
  /**
481
503
  * @SINCE 1.98.0
482
504
  *
@@ -554,14 +576,12 @@ declare namespace sap {
554
576
  * Gets current value of property {@link #getResultViewTypes resultViewTypes}.
555
577
  *
556
578
  * Defines selectable search result view types. The value can be set/get in attach event "searchFinished".
557
- * Case 1, Search in Apps: result is displayed in a mandatory view type `["appSearchResult"]`, and it is
558
- * not switchable. Case 2.1, Search in All or other Category (configuration.isUshell !== true): result is
559
- * switchable between different view types. Possible values for the array items are `"searchResultList"`
560
- * and `"searchResultGrid"`. Case 2.2, Search in All or other Category (configuration.isUshell === true):
561
- * result is displayed in a mandatory view type `["searchResultList"]`. Case 3, Search in Business Object:
562
- * result is switchable between different view types. Possible values for the array items are `"searchResultList"`,
563
- * `"searchResultTable"` and `"searchResultGrid"`. Note: The value of `resultViewTypes` and `resultViewType`
564
- * must be compatible to each other.
579
+ * Case 1: Search in Apps: result is displayed in a mandatory view type `["appSearchResult"]`, and it is
580
+ * not switchable. Case 2: Search in All or other Category: result is switchable between different view
581
+ * types. Possible values for the array items are `"searchResultList"` and `"searchResultGrid"`. Case 3,
582
+ * Search in Business Object: result is switchable between different view types. Possible values for the
583
+ * array items are `"searchResultList"`, `"searchResultTable"` and `"searchResultGrid"`. Note: The value
584
+ * of `resultViewTypes` and `resultViewType` must be compatible to each other.
565
585
  *
566
586
  * Default value is `["searchResultList", "searchResultTable"]`.
567
587
  *
@@ -734,6 +754,26 @@ declare namespace sap {
734
754
  */
735
755
  sDataSource: string
736
756
  ): this;
757
+ /**
758
+ * @SINCE 1.107.0
759
+ *
760
+ * Sets a new value for property {@link #getEnableQueryLanguage enableQueryLanguage}.
761
+ *
762
+ * Enables the query language for the hana_odata provider. With query language it is possible for the end
763
+ * user to enter complex search queries with logical operators.
764
+ *
765
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
766
+ *
767
+ * Default value is `false`.
768
+ *
769
+ * @returns Reference to `this` in order to allow method chaining
770
+ */
771
+ setEnableQueryLanguage(
772
+ /**
773
+ * New value for property `enableQueryLanguage`
774
+ */
775
+ bEnableQueryLanguage?: boolean
776
+ ): this;
737
777
  /**
738
778
  * @SINCE 1.98.0
739
779
  *
@@ -837,14 +877,12 @@ declare namespace sap {
837
877
  * Sets a new value for property {@link #getResultViewTypes resultViewTypes}.
838
878
  *
839
879
  * Defines selectable search result view types. The value can be set/get in attach event "searchFinished".
840
- * Case 1, Search in Apps: result is displayed in a mandatory view type `["appSearchResult"]`, and it is
841
- * not switchable. Case 2.1, Search in All or other Category (configuration.isUshell !== true): result is
842
- * switchable between different view types. Possible values for the array items are `"searchResultList"`
843
- * and `"searchResultGrid"`. Case 2.2, Search in All or other Category (configuration.isUshell === true):
844
- * result is displayed in a mandatory view type `["searchResultList"]`. Case 3, Search in Business Object:
845
- * result is switchable between different view types. Possible values for the array items are `"searchResultList"`,
846
- * `"searchResultTable"` and `"searchResultGrid"`. Note: The value of `resultViewTypes` and `resultViewType`
847
- * must be compatible to each other.
880
+ * Case 1: Search in Apps: result is displayed in a mandatory view type `["appSearchResult"]`, and it is
881
+ * not switchable. Case 2: Search in All or other Category: result is switchable between different view
882
+ * types. Possible values for the array items are `"searchResultList"` and `"searchResultGrid"`. Case 3,
883
+ * Search in Business Object: result is switchable between different view types. Possible values for the
884
+ * array items are `"searchResultList"`, `"searchResultTable"` and `"searchResultGrid"`. Note: The value
885
+ * of `resultViewTypes` and `resultViewType` must be compatible to each other.
848
886
  *
849
887
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
850
888
  *