@sap/ux-specification 1.90.10 → 1.90.14

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 (170) hide show
  1. package/CHANGELOG.md +88 -0
  2. package/README.md +4 -4
  3. package/dist/documentation/v2/v2-AnalyticalListPage.html +1 -1
  4. package/dist/documentation/v2/v2-ApplicationV2.html +1 -1
  5. package/dist/documentation/v2/v2-ListReport.html +1 -1
  6. package/dist/documentation/v2/v2-ObjectPage.html +1 -1
  7. package/dist/documentation/v2/v2-OverviewPage.html +1 -1
  8. package/dist/documentation/v4/v4-AnalyticalListPage.html +1 -1
  9. package/dist/documentation/v4/v4-ApplicationV4.html +1 -1
  10. package/dist/documentation/v4/v4-ListReport.html +1 -1
  11. package/dist/documentation/v4/v4-ObjectPage.html +1 -1
  12. package/dist/index-min.js +1 -1
  13. package/dist/schemas/v2/AnalyticalListPageConfig.json +87 -12
  14. package/dist/schemas/v2/ApplicationV2.json +2 -0
  15. package/dist/schemas/v2/ListReportConfig.json +86 -11
  16. package/dist/schemas/v2/ObjectPageConfig.json +319 -96
  17. package/dist/schemas/v2/OverviewPageConfig.json +14 -34
  18. package/dist/schemas/v4/ApplicationV4.json +2 -0
  19. package/dist/schemas/v4/ObjectPageConfig.json +35 -2
  20. package/dist/specification/v2/index-min.js +1 -1
  21. package/dist/src/apiTypes.d.ts +8 -0
  22. package/dist/src/specification/v2/ApplicationV2.d.ts +2 -0
  23. package/dist/src/specification/v2/controls/AnalyticalListPageChart.d.ts +1 -1
  24. package/dist/src/specification/v2/controls/Card.d.ts +9 -9
  25. package/dist/src/specification/v2/controls/Card.js.map +1 -1
  26. package/dist/src/specification/v2/controls/Field.d.ts +10 -0
  27. package/dist/src/specification/v2/controls/{DataField.js → Field.js} +1 -1
  28. package/dist/src/specification/v2/controls/Field.js.map +1 -0
  29. package/dist/src/specification/v2/controls/FormAction.d.ts +43 -0
  30. package/dist/src/specification/v2/controls/FormAction.js +20 -0
  31. package/dist/src/specification/v2/controls/FormAction.js.map +1 -0
  32. package/dist/src/specification/v2/controls/ObjectPageChart.d.ts +1 -1
  33. package/dist/src/specification/v2/controls/ObjectPageFooter.d.ts +11 -0
  34. package/dist/src/specification/v2/controls/ObjectPageFooter.js +3 -0
  35. package/dist/src/specification/v2/controls/ObjectPageFooter.js.map +1 -0
  36. package/dist/src/specification/v2/controls/ObjectPageForm.d.ts +4 -5
  37. package/dist/src/specification/v2/controls/ObjectPageHeaderAction.d.ts +21 -5
  38. package/dist/src/specification/v2/controls/ObjectPageHeaderAction.js +0 -5
  39. package/dist/src/specification/v2/controls/ObjectPageHeaderAction.js.map +1 -1
  40. package/dist/src/specification/v2/controls/ObjectPageSection.d.ts +25 -15
  41. package/dist/src/specification/v2/controls/ObjectPageSection.js.map +1 -1
  42. package/dist/src/specification/v2/controls/ObjectPageTable.d.ts +12 -5
  43. package/dist/src/specification/v2/controls/ObjectPageTable.js.map +1 -1
  44. package/dist/src/specification/v2/controls/Table.d.ts +4 -3
  45. package/dist/src/specification/v2/controls/ToolBar.d.ts +2 -6
  46. package/dist/src/specification/v2/controls/index.d.ts +4 -1
  47. package/dist/src/specification/v2/controls/index.js +1 -1
  48. package/dist/src/specification/v2/controls/index.js.map +1 -1
  49. package/dist/src/specification/v2/pages/ObjectPageConfig.d.ts +2 -1
  50. package/dist/src/specification/v4/ApplicationV4.d.ts +2 -0
  51. package/dist/src/specification/v4/controls/ObjectPageFooter.d.ts +11 -0
  52. package/dist/src/specification/v4/controls/ObjectPageFooter.js +3 -0
  53. package/dist/src/specification/v4/controls/ObjectPageFooter.js.map +1 -0
  54. package/dist/src/specification/v4/controls/ObjectPageHeader.d.ts +6 -1
  55. package/dist/src/specification/v4/controls/index.d.ts +1 -0
  56. package/dist/src/specification/v4/pages/ObjectPageConfig.d.ts +2 -1
  57. package/dist/src/specification/v4/webapp/manifest/sapUi5.d.ts +2 -1
  58. package/dist/src/specification/v4/webapp/manifest/sapUi5.js.map +1 -1
  59. package/dist/src/sync/common/decoration/control.d.ts +8 -1
  60. package/dist/src/sync/common/decoration/control.js +58 -17
  61. package/dist/src/sync/common/decoration/control.js.map +1 -1
  62. package/dist/src/sync/common/generate/objectPage.d.ts +41 -1
  63. package/dist/src/sync/common/generate/objectPage.js +214 -25
  64. package/dist/src/sync/common/generate/objectPage.js.map +1 -1
  65. package/dist/src/sync/common/import/utils.d.ts +6 -0
  66. package/dist/src/sync/common/import/utils.js +21 -0
  67. package/dist/src/sync/common/import/utils.js.map +1 -1
  68. package/dist/src/sync/common/importProject.js +64 -62
  69. package/dist/src/sync/common/importProject.js.map +1 -1
  70. package/dist/src/sync/common/types.d.ts +9 -2
  71. package/dist/src/sync/common/types.js +8 -0
  72. package/dist/src/sync/common/types.js.map +1 -1
  73. package/dist/src/sync/common/utils.d.ts +4 -3
  74. package/dist/src/sync/common/utils.js +86 -91
  75. package/dist/src/sync/common/utils.js.map +1 -1
  76. package/dist/src/sync/v2/application.d.ts +1 -0
  77. package/dist/src/sync/v2/application.js +3 -0
  78. package/dist/src/sync/v2/application.js.map +1 -1
  79. package/dist/src/sync/v2/export/controls/Card.d.ts +4 -3
  80. package/dist/src/sync/v2/export/controls/Card.js +16 -9
  81. package/dist/src/sync/v2/export/controls/Card.js.map +1 -1
  82. package/dist/src/sync/v2/export/controls/Field.d.ts +4 -0
  83. package/dist/src/sync/v2/export/controls/{DataField.js → Field.js} +7 -7
  84. package/dist/src/sync/v2/export/controls/Field.js.map +1 -0
  85. package/dist/src/sync/v2/export/controls/FilterBar.d.ts +1 -2
  86. package/dist/src/sync/v2/export/controls/FilterBar.js +7 -9
  87. package/dist/src/sync/v2/export/controls/FilterBar.js.map +1 -1
  88. package/dist/src/sync/v2/export/controls/FormAction.d.ts +15 -0
  89. package/dist/src/sync/v2/export/controls/FormAction.js +133 -0
  90. package/dist/src/sync/v2/export/controls/FormAction.js.map +1 -0
  91. package/dist/src/sync/v2/export/controls/Fragment.js +5 -6
  92. package/dist/src/sync/v2/export/controls/Fragment.js.map +1 -1
  93. package/dist/src/sync/v2/export/controls/ObjectPageChart.d.ts +4 -1
  94. package/dist/src/sync/v2/export/controls/ObjectPageChart.js +13 -0
  95. package/dist/src/sync/v2/export/controls/ObjectPageChart.js.map +1 -1
  96. package/dist/src/sync/v2/export/controls/ObjectPageHeader.js +1 -1
  97. package/dist/src/sync/v2/export/controls/ObjectPageHeader.js.map +1 -1
  98. package/dist/src/sync/v2/export/controls/ObjectPageHeaderAction.d.ts +6 -2
  99. package/dist/src/sync/v2/export/controls/ObjectPageHeaderAction.js +43 -4
  100. package/dist/src/sync/v2/export/controls/ObjectPageHeaderAction.js.map +1 -1
  101. package/dist/src/sync/v2/export/controls/ObjectPageSectionsV2.d.ts +32 -0
  102. package/dist/src/sync/v2/export/controls/ObjectPageSectionsV2.js +144 -0
  103. package/dist/src/sync/v2/export/controls/ObjectPageSectionsV2.js.map +1 -0
  104. package/dist/src/sync/v2/export/controls/ObjectPageTable.d.ts +5 -4
  105. package/dist/src/sync/v2/export/controls/ObjectPageTable.js +19 -7
  106. package/dist/src/sync/v2/export/controls/ObjectPageTable.js.map +1 -1
  107. package/dist/src/sync/v2/export/controls/Table.d.ts +12 -4
  108. package/dist/src/sync/v2/export/controls/Table.js +87 -40
  109. package/dist/src/sync/v2/export/controls/Table.js.map +1 -1
  110. package/dist/src/sync/v2/export/controls/TableColumn.js +1 -1
  111. package/dist/src/sync/v2/export/controls/TableColumn.js.map +1 -1
  112. package/dist/src/sync/v2/export/controls/index.d.ts +3 -1
  113. package/dist/src/sync/v2/export/controls/index.js +3 -1
  114. package/dist/src/sync/v2/export/controls/index.js.map +1 -1
  115. package/dist/src/sync/v2/export/export.js +129 -91
  116. package/dist/src/sync/v2/export/export.js.map +1 -1
  117. package/dist/src/sync/v2/generate/analyticalListReport.d.ts +3 -9
  118. package/dist/src/sync/v2/generate/analyticalListReport.js +15 -16
  119. package/dist/src/sync/v2/generate/analyticalListReport.js.map +1 -1
  120. package/dist/src/sync/v2/generate/generate.js +28 -6
  121. package/dist/src/sync/v2/generate/generate.js.map +1 -1
  122. package/dist/src/sync/v2/generate/listReport.d.ts +3 -10
  123. package/dist/src/sync/v2/generate/listReport.js +24 -30
  124. package/dist/src/sync/v2/generate/listReport.js.map +1 -1
  125. package/dist/src/sync/v2/generate/objectPage.d.ts +3 -10
  126. package/dist/src/sync/v2/generate/objectPage.js +210 -145
  127. package/dist/src/sync/v2/generate/objectPage.js.map +1 -1
  128. package/dist/src/sync/v2/generate/utils.d.ts +1 -2
  129. package/dist/src/sync/v2/generate/utils.js +7 -2
  130. package/dist/src/sync/v2/generate/utils.js.map +1 -1
  131. package/dist/src/sync/v2/import/pages/listReport.js +6 -5
  132. package/dist/src/sync/v2/import/pages/listReport.js.map +1 -1
  133. package/dist/src/sync/v2/import/pages/objectPage.js +163 -92
  134. package/dist/src/sync/v2/import/pages/objectPage.js.map +1 -1
  135. package/dist/src/sync/v2/import/pages/overviewPage.js +1 -0
  136. package/dist/src/sync/v2/import/pages/overviewPage.js.map +1 -1
  137. package/dist/src/sync/v2/types.d.ts +17 -0
  138. package/dist/src/sync/v2/types.js +16 -0
  139. package/dist/src/sync/v2/types.js.map +1 -1
  140. package/dist/src/sync/v4/application.js +10 -10
  141. package/dist/src/sync/v4/application.js.map +1 -1
  142. package/dist/src/sync/v4/export/controls/ObjectPageTable.js +4 -3
  143. package/dist/src/sync/v4/export/controls/ObjectPageTable.js.map +1 -1
  144. package/dist/src/sync/v4/export/controls/Table.js +4 -3
  145. package/dist/src/sync/v4/export/controls/Table.js.map +1 -1
  146. package/dist/src/sync/v4/export/export.js +156 -134
  147. package/dist/src/sync/v4/export/export.js.map +1 -1
  148. package/dist/src/sync/v4/export/manifest.js +96 -76
  149. package/dist/src/sync/v4/export/manifest.js.map +1 -1
  150. package/dist/src/sync/v4/generate/generate.js +10 -2
  151. package/dist/src/sync/v4/generate/generate.js.map +1 -1
  152. package/dist/src/sync/v4/generate/objectPage.d.ts +3 -6
  153. package/dist/src/sync/v4/generate/objectPage.js +92 -36
  154. package/dist/src/sync/v4/generate/objectPage.js.map +1 -1
  155. package/dist/src/sync/v4/import/app/appProvider.js +108 -80
  156. package/dist/src/sync/v4/import/app/appProvider.js.map +1 -1
  157. package/dist/src/sync/v4/import/fragment.js +41 -46
  158. package/dist/src/sync/v4/import/fragment.js.map +1 -1
  159. package/dist/src/sync/v4/import/pages/listReport.js +1 -1
  160. package/dist/src/sync/v4/import/pages/listReport.js.map +1 -1
  161. package/dist/src/sync/v4/utils/StableIdHelper.d.ts +0 -3
  162. package/dist/src/sync/v4/utils/StableIdHelper.js +9 -11
  163. package/dist/src/sync/v4/utils/StableIdHelper.js.map +1 -1
  164. package/dist/src/sync/v4/utils/utils.js +2 -2
  165. package/dist/src/sync/v4/utils/utils.js.map +1 -1
  166. package/package.json +4 -5
  167. package/dist/src/specification/v2/controls/DataField.d.ts +0 -7
  168. package/dist/src/specification/v2/controls/DataField.js.map +0 -1
  169. package/dist/src/sync/v2/export/controls/DataField.d.ts +0 -4
  170. package/dist/src/sync/v2/export/controls/DataField.js.map +0 -1
@@ -189,10 +189,7 @@
189
189
  "type": "object",
190
190
  "properties": {
191
191
  "fields": {
192
- "type": "object",
193
- "additionalProperties": {
194
- "$ref": "#/definitions/FieldPath"
195
- },
192
+ "$ref": "#/definitions/CreationFieldKeys",
196
193
  "artifactType": "Manifest"
197
194
  }
198
195
  },
@@ -201,11 +198,18 @@
201
198
  "fields"
202
199
  ]
203
200
  },
201
+ "CreationFieldKeys": {
202
+ "type": "object",
203
+ "additionalProperties": {
204
+ "$ref": "#/definitions/FieldPath"
205
+ }
206
+ },
204
207
  "FieldPath": {
205
208
  "type": "object",
206
209
  "properties": {
207
210
  "path": {
208
- "type": "string"
211
+ "type": "string",
212
+ "artifactType": "Manifest"
209
213
  }
210
214
  },
211
215
  "additionalProperties": false,
@@ -261,7 +265,8 @@
261
265
  "properties": {
262
266
  "enableAutoBinding": {
263
267
  "description": "When set to true, this enables automatic binding of the table with either the tableBindingPath (if it exists) or the entitySet property.",
264
- "type": "boolean"
268
+ "type": "boolean",
269
+ "artifactType": "Manifest"
265
270
  },
266
271
  "variants": {
267
272
  "description": "The variants section contains a set of entries that point to SelectionVariants or SelectionPresentationVariants defined in the annotations.",
@@ -271,11 +276,13 @@
271
276
  "^[0-9]+$": {
272
277
  "$ref": "#/definitions/QuickVariantX"
273
278
  }
274
- }
279
+ },
280
+ "artifactType": "Manifest"
275
281
  },
276
282
  "showCounts": {
277
283
  "description": "To show the number of records available, set showCounts to true.",
278
- "type": "boolean"
284
+ "type": "boolean",
285
+ "artifactType": "Manifest"
279
286
  }
280
287
  },
281
288
  "additionalProperties": false,
@@ -377,11 +384,79 @@
377
384
  "isViewNode": true,
378
385
  "type": "object",
379
386
  "additionalProperties": {
380
- "type": "object",
381
- "properties": {},
382
- "additionalProperties": true
387
+ "$ref": "#/definitions/FormAction"
383
388
  }
384
389
  },
390
+ "FormAction": {
391
+ "description": "Action",
392
+ "isViewNode": true,
393
+ "type": "object",
394
+ "properties": {
395
+ "tooltip": {
396
+ "description": "Text for tooltip of button",
397
+ "type": "string",
398
+ "artifactType": "FlexChange",
399
+ "controlType": "sap.m.Button"
400
+ },
401
+ "icon": {
402
+ "description": "Icon to be displayed as graphical element within the Button. Can be an image or icon from the icon font, represented as RFC 3986 conformant URI.",
403
+ "type": "string",
404
+ "artifactType": "FlexChange",
405
+ "controlType": "sap.m.Button"
406
+ },
407
+ "activeIcon": {
408
+ "description": "Alternative icon for the active (depressed) state of the button, represented as RFC 3986 conformant URI.",
409
+ "type": "string",
410
+ "artifactType": "FlexChange",
411
+ "controlType": "sap.m.Button"
412
+ },
413
+ "type": {
414
+ "$ref": "#/definitions/ButtonType",
415
+ "description": "Defines the Button type.",
416
+ "artifactType": "FlexChange",
417
+ "controlType": "sap.m.Button"
418
+ },
419
+ "visible": {
420
+ "pattern": "^(false|true)$|^{[A-Za-z0-9{}&$!@#? _|,<>'()[\\]\\/:=.]+}$",
421
+ "anyOf": [
422
+ {
423
+ "enum": [
424
+ false,
425
+ true,
426
+ "{ui>/editable}",
427
+ "{= !${ui>/editable}}"
428
+ ]
429
+ },
430
+ {
431
+ "type": "string"
432
+ }
433
+ ],
434
+ "description": "Whether the button should be visible on the screen.",
435
+ "artifactType": "FlexChange",
436
+ "controlType": "sap.m.Button"
437
+ }
438
+ },
439
+ "additionalProperties": false
440
+ },
441
+ "ButtonType": {
442
+ "enum": [
443
+ "Accept",
444
+ "Attention",
445
+ "Back",
446
+ "Critical",
447
+ "Default",
448
+ "Emphasized",
449
+ "Ghost",
450
+ "Negative",
451
+ "Neutral",
452
+ "Reject",
453
+ "Success",
454
+ "Transparent",
455
+ "Unstyled",
456
+ "Up"
457
+ ],
458
+ "type": "string"
459
+ },
385
460
  "GenericColumns": {
386
461
  "type": "object",
387
462
  "additionalProperties": {
@@ -1136,7 +1211,7 @@
1136
1211
  "additionalProperties": false
1137
1212
  },
1138
1213
  "ChartSettings": {
1139
- "description": "Chart Settings",
1214
+ "description": "Chart",
1140
1215
  "isViewNode": true,
1141
1216
  "type": "object",
1142
1217
  "properties": {
@@ -27,10 +27,12 @@
27
27
  "properties": {
28
28
  "title": {
29
29
  "description": "To change the application header, in your project artifacts, change the i18n property file for your app under webapp/i18n/i18n.properties ->appTitle. Then, refer to the title as {{appTitle}} in the sap.app section of the manifest file.",
30
+ "i18nClassification": "TIT: Title of the application",
30
31
  "type": "string"
31
32
  },
32
33
  "description": {
33
34
  "description": "To change the application header, in your project artifacts, change i18n property file for your app under webapp/i18n/i18n.properties ->appDescription. Then, refer to the description as {{appDescription}} in the sap.app section of the manifest file.",
35
+ "i18nClassification": "TIT: Description of the application",
34
36
  "type": "string"
35
37
  },
36
38
  "forceGlobalRefresh": {
@@ -188,10 +188,7 @@
188
188
  "type": "object",
189
189
  "properties": {
190
190
  "fields": {
191
- "type": "object",
192
- "additionalProperties": {
193
- "$ref": "#/definitions/FieldPath"
194
- },
191
+ "$ref": "#/definitions/CreationFieldKeys",
195
192
  "artifactType": "Manifest"
196
193
  }
197
194
  },
@@ -200,11 +197,18 @@
200
197
  "fields"
201
198
  ]
202
199
  },
200
+ "CreationFieldKeys": {
201
+ "type": "object",
202
+ "additionalProperties": {
203
+ "$ref": "#/definitions/FieldPath"
204
+ }
205
+ },
203
206
  "FieldPath": {
204
207
  "type": "object",
205
208
  "properties": {
206
209
  "path": {
207
- "type": "string"
210
+ "type": "string",
211
+ "artifactType": "Manifest"
208
212
  }
209
213
  },
210
214
  "additionalProperties": false,
@@ -260,7 +264,8 @@
260
264
  "properties": {
261
265
  "enableAutoBinding": {
262
266
  "description": "When set to true, this enables automatic binding of the table with either the tableBindingPath (if it exists) or the entitySet property.",
263
- "type": "boolean"
267
+ "type": "boolean",
268
+ "artifactType": "Manifest"
264
269
  },
265
270
  "variants": {
266
271
  "description": "The variants section contains a set of entries that point to SelectionVariants or SelectionPresentationVariants defined in the annotations.",
@@ -270,11 +275,13 @@
270
275
  "^[0-9]+$": {
271
276
  "$ref": "#/definitions/QuickVariantX"
272
277
  }
273
- }
278
+ },
279
+ "artifactType": "Manifest"
274
280
  },
275
281
  "showCounts": {
276
282
  "description": "To show the number of records available, set showCounts to true.",
277
- "type": "boolean"
283
+ "type": "boolean",
284
+ "artifactType": "Manifest"
278
285
  }
279
286
  },
280
287
  "additionalProperties": false,
@@ -376,11 +383,79 @@
376
383
  "isViewNode": true,
377
384
  "type": "object",
378
385
  "additionalProperties": {
379
- "type": "object",
380
- "properties": {},
381
- "additionalProperties": true
386
+ "$ref": "#/definitions/FormAction"
382
387
  }
383
388
  },
389
+ "FormAction": {
390
+ "description": "Action",
391
+ "isViewNode": true,
392
+ "type": "object",
393
+ "properties": {
394
+ "tooltip": {
395
+ "description": "Text for tooltip of button",
396
+ "type": "string",
397
+ "artifactType": "FlexChange",
398
+ "controlType": "sap.m.Button"
399
+ },
400
+ "icon": {
401
+ "description": "Icon to be displayed as graphical element within the Button. Can be an image or icon from the icon font, represented as RFC 3986 conformant URI.",
402
+ "type": "string",
403
+ "artifactType": "FlexChange",
404
+ "controlType": "sap.m.Button"
405
+ },
406
+ "activeIcon": {
407
+ "description": "Alternative icon for the active (depressed) state of the button, represented as RFC 3986 conformant URI.",
408
+ "type": "string",
409
+ "artifactType": "FlexChange",
410
+ "controlType": "sap.m.Button"
411
+ },
412
+ "type": {
413
+ "$ref": "#/definitions/ButtonType",
414
+ "description": "Defines the Button type.",
415
+ "artifactType": "FlexChange",
416
+ "controlType": "sap.m.Button"
417
+ },
418
+ "visible": {
419
+ "pattern": "^(false|true)$|^{[A-Za-z0-9{}&$!@#? _|,<>'()[\\]\\/:=.]+}$",
420
+ "anyOf": [
421
+ {
422
+ "enum": [
423
+ false,
424
+ true,
425
+ "{ui>/editable}",
426
+ "{= !${ui>/editable}}"
427
+ ]
428
+ },
429
+ {
430
+ "type": "string"
431
+ }
432
+ ],
433
+ "description": "Whether the button should be visible on the screen.",
434
+ "artifactType": "FlexChange",
435
+ "controlType": "sap.m.Button"
436
+ }
437
+ },
438
+ "additionalProperties": false
439
+ },
440
+ "ButtonType": {
441
+ "enum": [
442
+ "Accept",
443
+ "Attention",
444
+ "Back",
445
+ "Critical",
446
+ "Default",
447
+ "Emphasized",
448
+ "Ghost",
449
+ "Negative",
450
+ "Neutral",
451
+ "Reject",
452
+ "Success",
453
+ "Transparent",
454
+ "Unstyled",
455
+ "Up"
456
+ ],
457
+ "type": "string"
458
+ },
384
459
  "GenericColumns": {
385
460
  "type": "object",
386
461
  "additionalProperties": {