@sap/ux-specification 1.120.18 → 1.124.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 (47) hide show
  1. package/CHANGELOG.md +6 -529
  2. package/dist/documentation/v2/v2-AnalyticalListPage.html +2 -2
  3. package/dist/documentation/v2/v2-ApplicationV2.html +2 -2
  4. package/dist/documentation/v2/v2-ListReport.html +2 -2
  5. package/dist/documentation/v2/v2-ObjectPage.html +2 -2
  6. package/dist/documentation/v2/v2-OverviewPage.html +2 -2
  7. package/dist/documentation/v4/v4-ApplicationV4.html +2 -2
  8. package/dist/documentation/v4/v4-BuildingBlocks.html +2 -2
  9. package/dist/documentation/v4/v4-FreestylePage.html +2 -2
  10. package/dist/documentation/v4/v4-ListReport.html +2 -2
  11. package/dist/documentation/v4/v4-ObjectPage.html +2 -2
  12. package/dist/index-min.js +87 -87
  13. package/dist/index-min.js.map +3 -3
  14. package/dist/schemas/v2/AnalyticalListPageConfig.json +13 -10
  15. package/dist/schemas/v2/ListReportConfig.json +20 -15
  16. package/dist/schemas/v2/ObjectPageConfig.json +22 -16
  17. package/dist/schemas/v4/BuildingBlocksConfig.json +294 -1715
  18. package/dist/schemas/v4/ListReportConfig.json +18 -0
  19. package/dist/schemas/v4/ObjectPageConfig.json +6 -0
  20. package/dist/specification/package.json +3 -3
  21. package/dist/specification/src/sync/common/dist_tag.json +8 -13
  22. package/dist/specification/src/sync/v2/export/controls/ObjectPageTable.d.ts.map +1 -1
  23. package/dist/specification/src/sync/v2/export/controls/ObjectPageTable.js +10 -5
  24. package/dist/specification/src/sync/v2/export/controls/ObjectPageTable.js.map +1 -1
  25. package/dist/specification/src/sync/v2/export/controls/Table.d.ts.map +1 -1
  26. package/dist/specification/src/sync/v2/export/controls/Table.js +10 -5
  27. package/dist/specification/src/sync/v2/export/controls/Table.js.map +1 -1
  28. package/dist/specification/src/sync/v4/export/controls/ObjectPageTable.d.ts +1 -0
  29. package/dist/specification/src/sync/v4/export/controls/ObjectPageTable.d.ts.map +1 -1
  30. package/dist/specification/src/sync/v4/export/controls/ObjectPageTable.js +11 -0
  31. package/dist/specification/src/sync/v4/export/controls/ObjectPageTable.js.map +1 -1
  32. package/dist/specification/src/sync/v4/export/controls/Table.d.ts +2 -0
  33. package/dist/specification/src/sync/v4/export/controls/Table.d.ts.map +1 -1
  34. package/dist/specification/src/sync/v4/export/controls/Table.js +22 -0
  35. package/dist/specification/src/sync/v4/export/controls/Table.js.map +1 -1
  36. package/dist/specification/src/sync/v4/generate/listReport.d.ts.map +1 -1
  37. package/dist/specification/src/sync/v4/generate/listReport.js +38 -36
  38. package/dist/specification/src/sync/v4/generate/listReport.js.map +1 -1
  39. package/dist/specification/src/sync/v4/utils/utils.d.ts +1 -1
  40. package/dist/specification/src/sync/v4/utils/utils.d.ts.map +1 -1
  41. package/dist/specification/src/sync/v4/utils/utils.js +4 -2
  42. package/dist/specification/src/sync/v4/utils/utils.js.map +1 -1
  43. package/dist/types/src/v2/controls/ObjectPageTable.d.ts +5 -5
  44. package/dist/types/src/v2/controls/Table.d.ts +9 -9
  45. package/dist/types/src/v4/controls/Table.d.ts +4 -0
  46. package/dist/types/src/v4/controls/Table.d.ts.map +1 -1
  47. package/package.json +3 -3
package/CHANGELOG.md CHANGED
@@ -8,11 +8,15 @@ This project adheres to [Semantic Versioning](http://semver.org/) and the change
8
8
 
9
9
  [NodeJS](https://nodejs.org/en/download/) Version `18.18.0` or higher
10
10
 
11
- ## [1.120.18] - 2024-08-21
11
+ ## [1.124.0] - 2024-08-21
12
12
 
13
13
  ### Added
14
14
 
15
- A newer version 1.124.0 gets introduced for SAP UI5 versions >= 1.124; ux-specification 1.124.0 (or higher min version) will be retrieved by defining 'latest' in package.json.
15
+ First version for SAP UI5 1.124 and higher
16
+
17
+ OData V4:
18
+
19
+ - Support of `disableCopyToClipboard` table property
16
20
 
17
21
  ### Changed
18
22
 
@@ -28,530 +32,3 @@ A newer version 1.124.0 gets introduced for SAP UI5 versions >= 1.124; ux-specif
28
32
  - OData V4 and freestyle: If routing name and target name had been different for an entry in manifest.json, the export had falsified the routing information.
29
33
 
30
34
  ### Quality
31
-
32
- Upgrades:
33
-
34
- - eslint-plugin-prettier to 5.2.1
35
- - rimraf to 5.0.10
36
- - @sapui5/types to 1.127.0
37
- - i18next to 23.14.0
38
- - esbuild to 0.23.1
39
- - @sap-ux/fe-fpm-writer to 0.27.5
40
-
41
- ## [1.120.17] - 2024-08-07
42
-
43
- ### Added
44
-
45
- OData V4:
46
-
47
- - Specification API - support 'prompts' api using class "PromptsAPI" from "@sap-ux/fe-fpm-writer"
48
- - Adds required `sap.fe.*` libraries to manifest.json on page creation
49
-
50
- ### Quality
51
-
52
- Upgrades:
53
-
54
- - "@sap-ux/fe-fpm-writer" to "0.26.4"
55
- - "axios" to "1.7.4"
56
- - "esbuild" to "0.23.0"
57
- - "i18next" to "23.12.2"
58
-
59
- ## [1.120.16] - 2024-07-24
60
-
61
- ### Quality
62
-
63
- Upgrades:
64
-
65
- - @sap-ux/annotation-converter to 0.8.15
66
- - @sap-ux/vocabularies-types to 0.10.14
67
- - prettier to 3.3.3
68
- - rimraf to 5.0.9
69
- - semver to 7.6.3
70
- - jsdom to 24.1.1
71
-
72
- ## [1.120.15] - 2024-07-11
73
-
74
- ### Changed
75
-
76
- - The API function getApiVersion now also returns the module version of the given ux-specification module.
77
-
78
- ### Fixed
79
-
80
- - An error message "UI.Lineitem annotation has not been defined" was incorrectly returned in cases where the app uses views with (Selection)PresentationVariants leading to valid Lineitem annotations with a qualifier.
81
-
82
- ### Quality
83
-
84
- Upgrades:
85
-
86
- - @sap-ux/fe-fpm-writer to 0.25.0
87
- - @ui5/manifest to 1.66.0
88
- - npm-run-all2 to 6.2.2
89
- - rimraf to 5.0.8
90
- - @sapui5/types to 1.125.1
91
-
92
- ## [1.120.14] - 2024-06-26
93
-
94
- ### Fixed
95
-
96
- - Property fitContainer is no longer provided for change in v2 LR and ALP apps.
97
- - v4. Route pattern is not used during export which leads to different key generation after undo in page map
98
-
99
- ### Quality
100
-
101
- Upgrades:
102
-
103
- - esbuild to 0.21.5
104
- - npm-run-all2 to 6.2.0
105
- - prettier to 3.3.2
106
- - ts-jest to 29.1.5
107
- - resolution for ws 8.17.1
108
- - @sap-ux/annotation-converter to 0.8.14
109
- - @sap-ux/vocabularies-types to 0.10.13
110
-
111
- ## [1.120.13] - 2024-06-13
112
-
113
- ### Added
114
-
115
- OData V4:
116
-
117
- - Custom actions support within custom sections
118
-
119
- ### Fixed
120
-
121
- OData V4:
122
-
123
- - FilterBar macro with SelectionField annotation with qualifier is not resolved(annotationPath is missing)
124
- - Exception in case of line item annotations having an ID starting with "LineItems"
125
-
126
- ### Quality
127
-
128
- Upgrades:
129
-
130
- - rimraf to 5.0.7
131
- - ts-jest to 29.1.4
132
- - @sap-ux/fe-fpm-writer to v0.24.15
133
- - jsdom to 24.1.0
134
- - axios to 1.7.2
135
- - @sapui5/types to 1.125.0
136
-
137
- ## [1.120.12] - 2024-05-31
138
-
139
- ### Added
140
-
141
- - OData V4: Related Apps button and its manifest settings
142
- - General: support array-like definition of minUI5Version in manifest
143
-
144
- ### Changed
145
-
146
- OData V4:
147
-
148
- - Updated custom sections storage from array to object in schema
149
- - The showRelatedApps property is moved from the Object Page Header to the new Related Apps button.
150
-
151
- ### Fixed
152
-
153
- - List Report V2: LineItem should be taken from PV without qualifier when annotationPath points to a SV
154
-
155
- ### Quality
156
-
157
- Upgrades:
158
-
159
- - @sap-ux/annotation-converter to 0.8.13
160
- - @sap-ux/vocabularies-types to 0.10.12
161
- - semver to 7.6.2
162
- - i18next to 23.11.5
163
- - ini to 4.1.3
164
- - @ui5/manifest to 1.65.1
165
- - new resolution: micromatch ^4.0.6
166
- - new resolution: braces ^3.0.3
167
-
168
- ## [1.120.11] - 2024-05-16
169
-
170
- ### Added
171
-
172
- - The new API functions exportConfigEntityByPath and deleteConfigEntityByPath from 1.120.6 are now published in the external interface.
173
-
174
- ### Changed
175
-
176
- - The logic for defining the keys of V2 sections in the app schema has been adapted, so that the facet ID is now representing the facet in the key, if defined, instead of the target annotation path.
177
-
178
- ### Removed
179
-
180
- - Properties disableInlineCreateSort and selectionLimit were removed from the global table settings of OData V2, as they are not supported yet by the run-time.
181
-
182
- ### Fixed
183
-
184
- - V4. Schema generation for object page. Section label is not resolved within target definition and id was presented in "description"
185
- - V4. Schema generation for building block macros. AnnotationPath was not resolved for macros when absolute path was used in "metaPath" attribute
186
-
187
- ### Quality
188
-
189
- Upgrades:
190
-
191
- - @ui5/manifest to 1.65.0
192
- - @sap-ux/annotation-converter to 0.8.12
193
- - @sap-ux/vocabularies-types to 0.10.11
194
- - @sap-ux/fe-fpm-writer to 0.24.11
195
- - @types/jquery to 3.5.30
196
- - i18next to 23.11.4
197
-
198
- ## [1.120.10] - 2024-05-02
199
-
200
- ### Added
201
-
202
- - OData V4:
203
- - property widthIncludingColumnHeader on table and column level
204
-
205
- ### Changed
206
-
207
- - In a previous version, the tag `descriptionSrcUrl` (link to the UI5 documentation) was added in form of a JSDoc annotation. It became evident that this annotation was not transferred correctly in all cases to the JSON schema by the to-json-schema generator.
208
- To overcome this problem, `descriptionSrcUrl` is now placed in form of reflect metadata at all sync classes, and added to the schema by an own post-processing routine `processMetadata` that evaluates the reflect metadata.
209
-
210
- ### Removed
211
-
212
- - Property createMode was removed from the global table settings of OData V2, as it is not supported yet by the run-time.
213
-
214
- ### Deprecated
215
-
216
- ### Fixed
217
-
218
- OData V4:
219
-
220
- - view properties like custom columns or table settings had not been exported, as the anyOf definition of additionalProperties had not been considered during the export.
221
- - sync rule was missing for ViewToolBarAction.afterExecution
222
- - partially an invalid annotationPath was added for views, comprising '@@'
223
- - toolbar actions had partially not been considered during the import
224
- - the export of table properties had overwritten the export from views
225
- - the export now supports two different constellations for anyOf definitions in schema:
226
- - anyOf directly defined as additionalProperties (of MultiTableMode)
227
- - anyOf reachable via $ref, properties defined there.
228
- - Custom section fragments with event handler. `core:require` attribute is moved from `Button` to wrapper `VBox`
229
- - Default 'empty' `manifest.json` is returned after export of FPM Custom Page
230
- - The generation of config files failed with exception if a custom header action was defined with an invalid type, like string.
231
- - empty `sap.ui5/routing/config` object removed from `manifest.json` during export
232
-
233
- OData V2:
234
-
235
- - The logic that determines the LineItem and the Chart annotation to be used by ALP was not in sync with the logic implemented in Fiori Elements v2. The logic has been adapted accordingly.
236
-
237
- ### Quality
238
-
239
- - Code comments added in types package that explain the interfaces and refer to their implementation classes
240
-
241
- Upgrades:
242
-
243
- - @ui5/manifest to 1.64.0
244
-
245
- ## [1.120.9] - 2024-04-17
246
-
247
- ### Added
248
-
249
- - Odata V4: Support of SelectionPresentationVariants at Object Page tables
250
-
251
- ### Changed
252
-
253
- - OData V2:
254
- - Documentation for property createMode of OP table adapted
255
- - Fragment templates for custom column extensions for AnalyticalTable, GridTable, TreeTable, ResponsiveTable
256
-
257
- ### Removed
258
-
259
- ### Deprecated
260
-
261
- ### Fixed
262
-
263
- - V4 Macros. Property 'personalization' exported as XML element instead of attribute into xml file
264
-
265
- ### Quality
266
-
267
- - Update transitive dependencies
268
- - cpy-cli replaced by copyfiles
269
-
270
- Upgrades
271
-
272
- - @sap-ux/annotation-converter to 0.8.10
273
- - @sap-ux/vocabularies-types to 0.10.9
274
- - ejs to 3.1.10
275
- - i18next to 23.11.2
276
- - new resolution for tar 6.2.1
277
-
278
- ## [1.120.8] - 2024-04-04
279
-
280
- ### Quality
281
-
282
- - Update transitive dependencies
283
-
284
- Upgrades
285
-
286
- - axios to 1.6.8
287
- - esbuild to 0.20.2
288
- - semver to 7.6.0
289
- - yarn to 1.22.22
290
- - d3 to 7.9.0
291
- - reflect-metadata to 0.2.2
292
- - jest to 29.7.0
293
- - ts-jest to 29.1.2
294
-
295
- ## [1.120.7] - 2024-03-20
296
-
297
- ### Added
298
-
299
- - OData V4:
300
- - String type to bindable number type properties in macros schema
301
- - Overview Pages: support three different ways of defining the colors of cards
302
-
303
- ### Quality
304
-
305
- - Update transitive dependencies
306
-
307
- Upgrades
308
-
309
- - @sap-ux/vocabularies-types to 0.10.8
310
- - @sap-ux/annotation-converter to 0.8.9
311
- - @sap-ux/edmx-parser to 0.7.1
312
- - @typescript-eslint/eslint-plugin to 7.1.1
313
- - @typescript-eslint/parser to 7.1.1
314
- - @types/jest to 29.5.12
315
- - @ui5/manifest to v1.63.0
316
- - cpy-cli to 5.0.0
317
- - eslint-config-prettier to 9.1.0
318
- - eslint-plugin-prettier to 5.1.3
319
- - i18next to 23.10.1
320
- - jest to 29.5.0,
321
- - jsdom to 24.0.0
322
- - patch-package to 8.0.0
323
- - npm-run-all2 to 6.1.2
324
- - prettier to 3.2.5
325
- - ts-jest to 29.1.1
326
- - ts-node to 10.9.2
327
- - typescript to 5.3.2
328
- - uuid to 9.0.1
329
- - switch from sapui5/ts-types-esm to sapui5/types 1.120.9
330
- - resolution of ini to 4.0.0
331
- - resolution of parse-url to 9.0.0
332
- - cleanup of other resolutions
333
-
334
- ## [1.120.6] - 2024-03-07
335
-
336
- ### Added
337
-
338
- - New API functions exportConfigEntityByPath and deleteConfigEntityByPath have been added that allow a selective export or deletion of a single property or section from a config.json. The additional parameter entityPath must be applied. The new functions are released for List Report, Object Page and Analytical List Page of OData V2 and V4.
339
- - In the API result a change indicator is added that shows if the manifest was changed. In case of the new functions exportConfigEntityByPath and deleteConfigEntityByPath, only updated fragment files are returned (V2 flexibility changes are still returned completely due to compatibility, deletion is indicated by newValue = null).
340
-
341
- ### Changed
342
-
343
- - Increased `fe-fpm-writer` api version to include fix for controller extension namespace
344
- - Actualization of the README file.
345
-
346
- ### Fixed
347
-
348
- - An invalid app schema had been generated before, in case of table custom columns
349
-
350
- ### Quality
351
-
352
- - Update transitive dependencies
353
-
354
- Upgrades
355
-
356
- - eslint to v8.57.0
357
- - @types/semver: obsolete dependency deleted
358
- - esbuild to v0.20.1
359
-
360
- ## [1.120.5] - 2024-02-21
361
-
362
- ### Added
363
-
364
- - OData V2:
365
- - Support of Header facets on Object Page
366
- - UX adjustments of inplace documentation:
367
- - Support for Screen Readers and Arrow Navigation
368
-
369
- ### Changed
370
-
371
- - Increased `fe-fpm-writer` api version
372
-
373
- ### Quality
374
-
375
- - Update transitive dependencies
376
-
377
- Upgrades
378
-
379
- - @sapui5/ts-types-esm to v1.120.6
380
- - @sap-ux/fe-fpm-writer to v0.24.7
381
- - @sap-ux/vocabularies-types to 0.10.5
382
- - @sap-ux/annotation-converter to 0.8.6
383
- - @types/semver to v7.5.7
384
- - @ui5/manifest to v1.62.1
385
-
386
- ## [1.120.4] - 2024-02-08
387
-
388
- ### Added
389
-
390
- OData V2:
391
-
392
- - Support of "copy" setting for tables in List Report, Analytical List Page and Object Page
393
-
394
- ### Fixed
395
-
396
- - Invalid object-like descriptions and keys had been generated into the app-specific schemas if DataFieldForIntentBasedNavigation was defined with a path reference
397
- - An exception happened during app schema generation if a NavigationProperty pointed to an invalid target annotation
398
- - OData V4:
399
- - Enum for macros table `variantManagement` property
400
- - Wrong resolution of contextPath in case of containment as target for a page, leading to an exception during the schema generation
401
- - Invalid '/' in app schema definition names replaced by '::'
402
-
403
- ### Quality
404
-
405
- - Update transitive dependencies
406
-
407
- Upgrades
408
-
409
- - esbuild to 0.20.0
410
- - axios to 1.6.7
411
- - switch from npm-run-all 4.1.5 to npm-run-all2 5.0.2
412
- - @sap-ux/fe-fpm-writer to 0.24.4
413
- - @sap-ux/vocabularies-types to 0.10.4
414
-
415
- ## [1.120.3] - 2024-01-25
416
-
417
- ### Added
418
-
419
- - OData V4:
420
- - View columns set as view nodes
421
-
422
- ### Fixed
423
-
424
- - OData V4:
425
- - Schema is not generated for custom page when namespaces are not defined in view file
426
-
427
- ### Quality
428
-
429
- - Update transitive dependencies
430
-
431
- Upgrades
432
-
433
- - @sap-ux/annotation-converter to 0.8.2
434
- - @sap-ux/vocabularies-types to 0.10.2
435
- - @sap-ux/vocabularies-types to 0.10.2
436
-
437
- ## [1.120.2] - 2024-01-11
438
-
439
- ### Added
440
-
441
- - UX adjustments of inplace documentation:
442
- - Support of Keyboard Navigation
443
- - OData V2: Support of global table settings for object pages
444
- - OData V4:
445
- - OP: Added support for `Edit` and `Delete` standard actions considering draft support and capabilities annotation
446
- - OP: Sequence of actions is now based on criticality annotation
447
- - TBD
448
-
449
- ### Changed
450
-
451
- - Alignment of settings for sap.ovp:
452
- The global settings and card specific settings have been compared with the actual status of the documentation and the subschema as available at <https://www.npmjs.com/package/@ui5/manifest>. Missing settings have been added, obsolete settings have been eliminated.
453
- The assignment of settings to the specific card types has been revised and adjusted.
454
- - Increased `fe-fpm-writer` api version
455
- - Increased api version
456
- - OData V2: ALP root properties order
457
-
458
- ### Fixed
459
-
460
- - OData V4: Empty visualization throws unhandled error during sync
461
- - Prevent exception in case of illegal annotationPath references of fields or columns
462
- - OData V2: ALP not displaying chart and properties
463
- - OVP:
464
- - In case of unknown properties, other card settings like listFlavor or listFlavor could get deleted.
465
- - Property "Category" was shown with an initial value as object, although being of type string.
466
- - Properties enableAddToInsights, imageSupported, showLineItemDetail, valueSelectionInfo might not have been exported correctly to the manifest.
467
-
468
- ### Quality
469
-
470
- - Update transitive dependencies
471
-
472
- Upgrades
473
-
474
- - eslint to 8.56.0
475
- - esbuild to 0.19.11
476
- - reflect-metadata to 0.2.1
477
- - axios to 1.6.5
478
- - @sapui5/ts-types-esm to 1.120.4
479
-
480
- ## [1.120.1] - 2023-11-30
481
-
482
- ### Added
483
-
484
- - OData V2: Added missing `annotationPath` property for table definitions in schema
485
-
486
- ### Changed
487
-
488
- - OVP card settings:
489
- - Added missing properties
490
- - Removed irrelevant settings from custom card settings
491
- - Assignment of settings to card types has been generally aligned with the given capabilities of SAP Fiori elements
492
-
493
- - If problems had been posted to the log with regards to annotations, they normally ended with the information `location: webapp/localService/metadata.xml`. This location information might be misleading for edmx projects, as annotation may reside in a different file. It was always wrong for CAP projects.
494
- Thus the location information is removed for annotation problems
495
-
496
- - If no line item annotation is present, no `annotationPath` property gets added to the schemas of OData V2 and V4
497
-
498
- ### Fixed
499
-
500
- - The check of minUI5Version against the dist tags raised wrong warnings in case of minUI5Version using the pattern 'UI5-xxx'
501
- - OData V4: Inconsistencies in the JSON schema for macros led to exceptions when generating the overall page schemas. Such exceptions are now caught and indicated in the error log
502
-
503
- ### Quality
504
-
505
- - Update transitive dependencies
506
-
507
- Upgrades
508
-
509
- - axios to 1.6.2
510
- - yarn to 1.22.21
511
- - esbuild to 0.19.7
512
- - eslint to 8.54.0
513
- - @sap-ux/fe-fpm-writer to 0.24.2
514
- - @sap-ux/annotation-converter to 0.8.1
515
- - @sap-ux/vocabularies-types to 0.10.1
516
- - @types/mem-fs-editor to 7.0.7
517
- - @types/semver to 7.5.6
518
- - @types/jquery to 3.5.29
519
-
520
- ## [1.120.0] - 2023-11-16
521
-
522
- ### Added
523
-
524
- - OData V4:
525
- - Added support for TreeTable
526
-
527
- ### Changed
528
-
529
- ### Removed
530
-
531
- ### Deprecated
532
-
533
- ### Fixed
534
-
535
- - Fixed an exception "Cannot read properties of undefined (reading 'includes')" when generating the app schemas
536
-
537
- - OData V4:
538
- - If multiple facets refer to target annotations without an ID but with identical labels, only one of the facets was shown in the page editor
539
- - An error message was added to the logger if the ID was missing for a reference facet. This was wrong, the ID is optional for reference facets. Instead, the error message is now added for missing IDs of collection facets
540
- - Building blocks:
541
- - The number of new lines that get created from the description of building block properties was decreased
542
- - Missing 'enum' for multiple building block properties
543
-
544
- ### Quality
545
-
546
- - Update transitive dependencies
547
-
548
- Upgrades
549
-
550
- - eslint to 8.53.0
551
- - axios to 1.6.0
552
- - @sap-ux/fe-fpm-writer to v0.24.1
553
- - @types/jquery to v3.5.27
554
- - @types/semver to v7.5.5
555
- - @types/d3 to v7.4.3
556
- - @types/mem-fs-editor to v7.0.6
557
- - @sapui5/ts-types-esm to 1.120.1