@sap/ux-specification 1.96.87 → 1.96.89

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 (497) hide show
  1. package/CHANGELOG.md +44 -1
  2. package/dist/documentation/runDocu-min.js +1 -1
  3. package/dist/documentation/runDocu-min.js.map +2 -2
  4. package/dist/documentation/v2/v2-AnalyticalListPage.html +2 -2
  5. package/dist/documentation/v2/v2-ApplicationV2.html +2 -2
  6. package/dist/documentation/v2/v2-ListReport.html +2 -2
  7. package/dist/documentation/v2/v2-ObjectPage.html +2 -2
  8. package/dist/documentation/v2/v2-OverviewPage.html +2 -2
  9. package/dist/documentation/v4/v4-ApplicationV4.html +2 -2
  10. package/dist/documentation/v4/v4-BuildingBlocks.html +2 -2
  11. package/dist/documentation/v4/v4-FreestylePage.html +2 -2
  12. package/dist/documentation/v4/v4-ListReport.html +2 -2
  13. package/dist/documentation/v4/v4-ObjectPage.html +2 -2
  14. package/dist/index-min.js +83 -83
  15. package/dist/index-min.js.map +4 -4
  16. package/dist/schemas/v2/ApplicationV2.json +2 -1
  17. package/dist/schemas/v4/ApplicationV4.json +6 -1
  18. package/dist/specification/package.json +6 -6
  19. package/dist/specification/scripts/documentation/components/TreeDiagram.d.ts +21 -0
  20. package/dist/specification/scripts/documentation/components/TreeDiagram.d.ts.map +1 -1
  21. package/dist/specification/scripts/documentation/components/TreeDiagram.js +21 -0
  22. package/dist/specification/scripts/documentation/components/TreeDiagram.js.map +1 -1
  23. package/dist/specification/scripts/documentation/components/filter.d.ts +7 -0
  24. package/dist/specification/scripts/documentation/components/filter.d.ts.map +1 -1
  25. package/dist/specification/scripts/documentation/components/filter.js +30 -0
  26. package/dist/specification/scripts/documentation/components/filter.js.map +1 -1
  27. package/dist/specification/scripts/documentation/components/ui/TreeUI.d.ts +70 -0
  28. package/dist/specification/scripts/documentation/components/ui/TreeUI.d.ts.map +1 -1
  29. package/dist/specification/scripts/documentation/components/ui/TreeUI.js +70 -3
  30. package/dist/specification/scripts/documentation/components/ui/TreeUI.js.map +1 -1
  31. package/dist/specification/scripts/documentation/components/ui/keyboardNavigation.d.ts +17 -0
  32. package/dist/specification/scripts/documentation/components/ui/keyboardNavigation.d.ts.map +1 -1
  33. package/dist/specification/scripts/documentation/components/ui/keyboardNavigation.js +23 -0
  34. package/dist/specification/scripts/documentation/components/ui/keyboardNavigation.js.map +1 -1
  35. package/dist/specification/scripts/documentation/components/ui/search.d.ts +12 -0
  36. package/dist/specification/scripts/documentation/components/ui/search.d.ts.map +1 -1
  37. package/dist/specification/scripts/documentation/components/ui/search.js +78 -8
  38. package/dist/specification/scripts/documentation/components/ui/search.js.map +1 -1
  39. package/dist/specification/scripts/documentation/components/ui/toggle.d.ts +21 -0
  40. package/dist/specification/scripts/documentation/components/ui/toggle.d.ts.map +1 -1
  41. package/dist/specification/scripts/documentation/components/ui/toggle.js +23 -6
  42. package/dist/specification/scripts/documentation/components/ui/toggle.js.map +1 -1
  43. package/dist/specification/scripts/documentation/components/ui/tooltip.d.ts +24 -0
  44. package/dist/specification/scripts/documentation/components/ui/tooltip.d.ts.map +1 -1
  45. package/dist/specification/scripts/documentation/components/ui/tooltip.js +24 -3
  46. package/dist/specification/scripts/documentation/components/ui/tooltip.js.map +1 -1
  47. package/dist/specification/scripts/documentation/components/ui/utils.d.ts +36 -0
  48. package/dist/specification/scripts/documentation/components/ui/utils.d.ts.map +1 -1
  49. package/dist/specification/scripts/documentation/components/ui/utils.js +36 -4
  50. package/dist/specification/scripts/documentation/components/ui/utils.js.map +1 -1
  51. package/dist/specification/scripts/extractDocu.js +51 -7
  52. package/dist/specification/scripts/extractDocu.js.map +1 -1
  53. package/dist/specification/scripts/macros/api.d.ts +4 -1
  54. package/dist/specification/scripts/macros/api.d.ts.map +1 -1
  55. package/dist/specification/scripts/macros/api.js +9 -1
  56. package/dist/specification/scripts/macros/api.js.map +1 -1
  57. package/dist/specification/scripts/macros/cmd.d.ts +1 -0
  58. package/dist/specification/scripts/macros/cmd.d.ts.map +1 -1
  59. package/dist/specification/scripts/macros/cmd.js +1 -0
  60. package/dist/specification/scripts/macros/cmd.js.map +1 -1
  61. package/dist/specification/scripts/macros/corrections.d.ts +1 -0
  62. package/dist/specification/scripts/macros/corrections.d.ts.map +1 -1
  63. package/dist/specification/scripts/macros/corrections.js +4 -0
  64. package/dist/specification/scripts/macros/corrections.js.map +1 -1
  65. package/dist/specification/scripts/macros/i18n.d.ts +1 -0
  66. package/dist/specification/scripts/macros/i18n.d.ts.map +1 -1
  67. package/dist/specification/scripts/macros/i18n.js +1 -0
  68. package/dist/specification/scripts/macros/i18n.js.map +1 -1
  69. package/dist/specification/scripts/macros/schema.d.ts +1 -0
  70. package/dist/specification/scripts/macros/schema.d.ts.map +1 -1
  71. package/dist/specification/scripts/macros/schema.js +18 -5
  72. package/dist/specification/scripts/macros/schema.js.map +1 -1
  73. package/dist/specification/scripts/schema/to-json-schema.d.ts +9 -5
  74. package/dist/specification/scripts/schema/to-json-schema.d.ts.map +1 -1
  75. package/dist/specification/scripts/schema/to-json-schema.js +32 -5
  76. package/dist/specification/scripts/schema/to-json-schema.js.map +1 -1
  77. package/dist/specification/scripts/spec.js +19 -9
  78. package/dist/specification/scripts/spec.js.map +1 -1
  79. package/dist/specification/src/api.d.ts +20 -12
  80. package/dist/specification/src/api.d.ts.map +1 -1
  81. package/dist/specification/src/api.js +22 -14
  82. package/dist/specification/src/api.js.map +1 -1
  83. package/dist/specification/src/extensionLogger.d.ts +3 -2
  84. package/dist/specification/src/extensionLogger.d.ts.map +1 -1
  85. package/dist/specification/src/extensionLogger.js +3 -2
  86. package/dist/specification/src/extensionLogger.js.map +1 -1
  87. package/dist/specification/src/i18n/i18n.d.ts +5 -0
  88. package/dist/specification/src/i18n/i18n.d.ts.map +1 -1
  89. package/dist/specification/src/i18n/i18n.js +5 -0
  90. package/dist/specification/src/i18n/i18n.js.map +1 -1
  91. package/dist/specification/src/project.d.ts +3 -1
  92. package/dist/specification/src/project.d.ts.map +1 -1
  93. package/dist/specification/src/project.js +3 -1
  94. package/dist/specification/src/project.js.map +1 -1
  95. package/dist/specification/src/specification/schemaAccess.d.ts +6 -2
  96. package/dist/specification/src/specification/schemaAccess.d.ts.map +1 -1
  97. package/dist/specification/src/specification/schemaAccess.js +10 -4
  98. package/dist/specification/src/specification/schemaAccess.js.map +1 -1
  99. package/dist/specification/src/sync/common/appProvider.d.ts +17 -6
  100. package/dist/specification/src/sync/common/appProvider.d.ts.map +1 -1
  101. package/dist/specification/src/sync/common/appProvider.js +33 -17
  102. package/dist/specification/src/sync/common/appProvider.js.map +1 -1
  103. package/dist/specification/src/sync/common/decoration/control.d.ts +26 -10
  104. package/dist/specification/src/sync/common/decoration/control.d.ts.map +1 -1
  105. package/dist/specification/src/sync/common/decoration/control.js +32 -13
  106. package/dist/specification/src/sync/common/decoration/control.js.map +1 -1
  107. package/dist/specification/src/sync/common/decoration/decorators.d.ts +14 -0
  108. package/dist/specification/src/sync/common/decoration/decorators.d.ts.map +1 -1
  109. package/dist/specification/src/sync/common/decoration/decorators.js +14 -0
  110. package/dist/specification/src/sync/common/decoration/decorators.js.map +1 -1
  111. package/dist/specification/src/sync/common/decoration/factory.d.ts +12 -3
  112. package/dist/specification/src/sync/common/decoration/factory.d.ts.map +1 -1
  113. package/dist/specification/src/sync/common/decoration/factory.js +6 -3
  114. package/dist/specification/src/sync/common/decoration/factory.js.map +1 -1
  115. package/dist/specification/src/sync/common/decoration/flex.d.ts +7 -0
  116. package/dist/specification/src/sync/common/decoration/flex.d.ts.map +1 -1
  117. package/dist/specification/src/sync/common/decoration/flex.js +7 -0
  118. package/dist/specification/src/sync/common/decoration/flex.js.map +1 -1
  119. package/dist/specification/src/sync/common/distTagEvaluator.d.ts +6 -3
  120. package/dist/specification/src/sync/common/distTagEvaluator.d.ts.map +1 -1
  121. package/dist/specification/src/sync/common/distTagEvaluator.js +6 -3
  122. package/dist/specification/src/sync/common/distTagEvaluator.js.map +1 -1
  123. package/dist/specification/src/sync/common/flexUtils.d.ts +11 -10
  124. package/dist/specification/src/sync/common/flexUtils.d.ts.map +1 -1
  125. package/dist/specification/src/sync/common/flexUtils.js +11 -10
  126. package/dist/specification/src/sync/common/flexUtils.js.map +1 -1
  127. package/dist/specification/src/sync/common/generate/objectPage.d.ts +27 -18
  128. package/dist/specification/src/sync/common/generate/objectPage.d.ts.map +1 -1
  129. package/dist/specification/src/sync/common/generate/objectPage.js +54 -33
  130. package/dist/specification/src/sync/common/generate/objectPage.js.map +1 -1
  131. package/dist/specification/src/sync/common/generate/utils.d.ts +62 -35
  132. package/dist/specification/src/sync/common/generate/utils.d.ts.map +1 -1
  133. package/dist/specification/src/sync/common/generate/utils.js +64 -35
  134. package/dist/specification/src/sync/common/generate/utils.js.map +1 -1
  135. package/dist/specification/src/sync/common/import/utils.d.ts +9 -3
  136. package/dist/specification/src/sync/common/import/utils.d.ts.map +1 -1
  137. package/dist/specification/src/sync/common/import/utils.js +9 -3
  138. package/dist/specification/src/sync/common/import/utils.js.map +1 -1
  139. package/dist/specification/src/sync/common/importProject.d.ts +17 -6
  140. package/dist/specification/src/sync/common/importProject.d.ts.map +1 -1
  141. package/dist/specification/src/sync/common/importProject.js +60 -30
  142. package/dist/specification/src/sync/common/importProject.js.map +1 -1
  143. package/dist/specification/src/sync/common/utils.d.ts +129 -53
  144. package/dist/specification/src/sync/common/utils.d.ts.map +1 -1
  145. package/dist/specification/src/sync/common/utils.js +237 -88
  146. package/dist/specification/src/sync/common/utils.js.map +1 -1
  147. package/dist/specification/src/sync/i18n.d.ts +5 -0
  148. package/dist/specification/src/sync/i18n.d.ts.map +1 -1
  149. package/dist/specification/src/sync/i18n.js +5 -0
  150. package/dist/specification/src/sync/i18n.js.map +1 -1
  151. package/dist/specification/src/sync/v2/export/controls/Action.d.ts +3 -3
  152. package/dist/specification/src/sync/v2/export/controls/Action.js +15 -15
  153. package/dist/specification/src/sync/v2/export/controls/Card.d.ts +14 -0
  154. package/dist/specification/src/sync/v2/export/controls/Card.d.ts.map +1 -1
  155. package/dist/specification/src/sync/v2/export/controls/Card.js +20 -0
  156. package/dist/specification/src/sync/v2/export/controls/Card.js.map +1 -1
  157. package/dist/specification/src/sync/v2/export/controls/Field.js +5 -5
  158. package/dist/specification/src/sync/v2/export/controls/FilterBar.d.ts +20 -0
  159. package/dist/specification/src/sync/v2/export/controls/FilterBar.d.ts.map +1 -1
  160. package/dist/specification/src/sync/v2/export/controls/FilterBar.js +28 -0
  161. package/dist/specification/src/sync/v2/export/controls/FilterBar.js.map +1 -1
  162. package/dist/specification/src/sync/v2/export/controls/FormAction.js +4 -4
  163. package/dist/specification/src/sync/v2/export/controls/Fragment.d.ts +10 -5
  164. package/dist/specification/src/sync/v2/export/controls/Fragment.d.ts.map +1 -1
  165. package/dist/specification/src/sync/v2/export/controls/Fragment.js +62 -25
  166. package/dist/specification/src/sync/v2/export/controls/Fragment.js.map +1 -1
  167. package/dist/specification/src/sync/v2/export/controls/ObjectPageFooterAction.js +6 -6
  168. package/dist/specification/src/sync/v2/export/controls/ObjectPageHeaderAction.js +6 -6
  169. package/dist/specification/src/sync/v2/export/controls/ObjectPageHeaderSection.d.ts.map +1 -1
  170. package/dist/specification/src/sync/v2/export/controls/ObjectPageHeaderSection.js +20 -16
  171. package/dist/specification/src/sync/v2/export/controls/ObjectPageHeaderSection.js.map +1 -1
  172. package/dist/specification/src/sync/v2/export/controls/ObjectPageSection.d.ts.map +1 -1
  173. package/dist/specification/src/sync/v2/export/controls/ObjectPageSection.js.map +1 -1
  174. package/dist/specification/src/sync/v2/export/controls/ObjectPageToolBarAction.js +6 -6
  175. package/dist/specification/src/sync/v2/export/controls/Table.d.ts +24 -0
  176. package/dist/specification/src/sync/v2/export/controls/Table.d.ts.map +1 -1
  177. package/dist/specification/src/sync/v2/export/controls/Table.js +42 -3
  178. package/dist/specification/src/sync/v2/export/controls/Table.js.map +1 -1
  179. package/dist/specification/src/sync/v2/export/controls/TableColumn.js +10 -10
  180. package/dist/specification/src/sync/v2/export/export.d.ts +7 -3
  181. package/dist/specification/src/sync/v2/export/export.d.ts.map +1 -1
  182. package/dist/specification/src/sync/v2/export/export.js +133 -44
  183. package/dist/specification/src/sync/v2/export/export.js.map +1 -1
  184. package/dist/specification/src/sync/v2/export/exportPage.d.ts +18 -10
  185. package/dist/specification/src/sync/v2/export/exportPage.d.ts.map +1 -1
  186. package/dist/specification/src/sync/v2/export/exportPage.js +34 -20
  187. package/dist/specification/src/sync/v2/export/exportPage.js.map +1 -1
  188. package/dist/specification/src/sync/v2/export/exportPageGeneric.d.ts +6 -3
  189. package/dist/specification/src/sync/v2/export/exportPageGeneric.d.ts.map +1 -1
  190. package/dist/specification/src/sync/v2/export/exportPageGeneric.js +27 -17
  191. package/dist/specification/src/sync/v2/export/exportPageGeneric.js.map +1 -1
  192. package/dist/specification/src/sync/v2/export/manifest.d.ts +5 -2
  193. package/dist/specification/src/sync/v2/export/manifest.d.ts.map +1 -1
  194. package/dist/specification/src/sync/v2/export/manifest.js +30 -6
  195. package/dist/specification/src/sync/v2/export/manifest.js.map +1 -1
  196. package/dist/specification/src/sync/v2/export/pages/OverviewPage.d.ts +21 -0
  197. package/dist/specification/src/sync/v2/export/pages/OverviewPage.d.ts.map +1 -1
  198. package/dist/specification/src/sync/v2/export/pages/OverviewPage.js +36 -2
  199. package/dist/specification/src/sync/v2/export/pages/OverviewPage.js.map +1 -1
  200. package/dist/specification/src/sync/v2/export/view-controller-generator.d.ts +25 -15
  201. package/dist/specification/src/sync/v2/export/view-controller-generator.d.ts.map +1 -1
  202. package/dist/specification/src/sync/v2/export/view-controller-generator.js +27 -16
  203. package/dist/specification/src/sync/v2/export/view-controller-generator.js.map +1 -1
  204. package/dist/specification/src/sync/v2/generate/analyticalListReport.d.ts +2 -0
  205. package/dist/specification/src/sync/v2/generate/analyticalListReport.d.ts.map +1 -1
  206. package/dist/specification/src/sync/v2/generate/analyticalListReport.js +8 -1
  207. package/dist/specification/src/sync/v2/generate/analyticalListReport.js.map +1 -1
  208. package/dist/specification/src/sync/v2/generate/generate.d.ts +5 -9
  209. package/dist/specification/src/sync/v2/generate/generate.d.ts.map +1 -1
  210. package/dist/specification/src/sync/v2/generate/generate.js +9 -12
  211. package/dist/specification/src/sync/v2/generate/generate.js.map +1 -1
  212. package/dist/specification/src/sync/v2/generate/listReport.d.ts +4 -2
  213. package/dist/specification/src/sync/v2/generate/listReport.d.ts.map +1 -1
  214. package/dist/specification/src/sync/v2/generate/listReport.js +26 -8
  215. package/dist/specification/src/sync/v2/generate/listReport.js.map +1 -1
  216. package/dist/specification/src/sync/v2/generate/manifestPropertyUtils.d.ts +118 -0
  217. package/dist/specification/src/sync/v2/generate/manifestPropertyUtils.d.ts.map +1 -0
  218. package/dist/specification/src/sync/v2/generate/manifestPropertyUtils.js +151 -0
  219. package/dist/specification/src/sync/v2/generate/manifestPropertyUtils.js.map +1 -0
  220. package/dist/specification/src/sync/v2/generate/objectPage.d.ts +2 -2
  221. package/dist/specification/src/sync/v2/generate/objectPage.d.ts.map +1 -1
  222. package/dist/specification/src/sync/v2/generate/objectPage.js +75 -43
  223. package/dist/specification/src/sync/v2/generate/objectPage.js.map +1 -1
  224. package/dist/specification/src/sync/v2/generate/overviewPage.d.ts +2 -2
  225. package/dist/specification/src/sync/v2/generate/overviewPage.d.ts.map +1 -1
  226. package/dist/specification/src/sync/v2/generate/overviewPage.js +2 -2
  227. package/dist/specification/src/sync/v2/generate/overviewPage.js.map +1 -1
  228. package/dist/specification/src/sync/v2/generate/schemaAdaptation.d.ts +1 -1
  229. package/dist/specification/src/sync/v2/generate/schemaAdaptation.js +8 -8
  230. package/dist/specification/src/sync/v2/generate/schemaAdaptation.js.map +1 -1
  231. package/dist/specification/src/sync/v2/generate/utils.d.ts +47 -36
  232. package/dist/specification/src/sync/v2/generate/utils.d.ts.map +1 -1
  233. package/dist/specification/src/sync/v2/generate/utils.js +92 -71
  234. package/dist/specification/src/sync/v2/generate/utils.js.map +1 -1
  235. package/dist/specification/src/sync/v2/import/app/appProvider.d.ts +7 -0
  236. package/dist/specification/src/sync/v2/import/app/appProvider.d.ts.map +1 -1
  237. package/dist/specification/src/sync/v2/import/app/appProvider.js +20 -4
  238. package/dist/specification/src/sync/v2/import/app/appProvider.js.map +1 -1
  239. package/dist/specification/src/sync/v2/import/app/ovpProvider.d.ts +4 -0
  240. package/dist/specification/src/sync/v2/import/app/ovpProvider.d.ts.map +1 -1
  241. package/dist/specification/src/sync/v2/import/app/ovpProvider.js +4 -0
  242. package/dist/specification/src/sync/v2/import/app/ovpProvider.js.map +1 -1
  243. package/dist/specification/src/sync/v2/import/common/index.d.ts +28 -15
  244. package/dist/specification/src/sync/v2/import/common/index.d.ts.map +1 -1
  245. package/dist/specification/src/sync/v2/import/common/index.js +91 -35
  246. package/dist/specification/src/sync/v2/import/common/index.js.map +1 -1
  247. package/dist/specification/src/sync/v2/import/controls/table.d.ts +6 -2
  248. package/dist/specification/src/sync/v2/import/controls/table.d.ts.map +1 -1
  249. package/dist/specification/src/sync/v2/import/controls/table.js +6 -2
  250. package/dist/specification/src/sync/v2/import/controls/table.js.map +1 -1
  251. package/dist/specification/src/sync/v2/import/importPage.d.ts +3 -2
  252. package/dist/specification/src/sync/v2/import/importPage.d.ts.map +1 -1
  253. package/dist/specification/src/sync/v2/import/importPage.js +4 -5
  254. package/dist/specification/src/sync/v2/import/importPage.js.map +1 -1
  255. package/dist/specification/src/sync/v2/import/pages/analyticalListPage.d.ts +3 -3
  256. package/dist/specification/src/sync/v2/import/pages/analyticalListPage.d.ts.map +1 -1
  257. package/dist/specification/src/sync/v2/import/pages/analyticalListPage.js +9 -10
  258. package/dist/specification/src/sync/v2/import/pages/analyticalListPage.js.map +1 -1
  259. package/dist/specification/src/sync/v2/import/pages/listReport.d.ts +8 -7
  260. package/dist/specification/src/sync/v2/import/pages/listReport.d.ts.map +1 -1
  261. package/dist/specification/src/sync/v2/import/pages/listReport.js +28 -24
  262. package/dist/specification/src/sync/v2/import/pages/listReport.js.map +1 -1
  263. package/dist/specification/src/sync/v2/import/pages/objectPage.d.ts +3 -3
  264. package/dist/specification/src/sync/v2/import/pages/objectPage.d.ts.map +1 -1
  265. package/dist/specification/src/sync/v2/import/pages/objectPage.js +107 -76
  266. package/dist/specification/src/sync/v2/import/pages/objectPage.js.map +1 -1
  267. package/dist/specification/src/sync/v2/import/pages/overviewPage.d.ts +2 -1
  268. package/dist/specification/src/sync/v2/import/pages/overviewPage.d.ts.map +1 -1
  269. package/dist/specification/src/sync/v2/import/pages/overviewPage.js +27 -12
  270. package/dist/specification/src/sync/v2/import/pages/overviewPage.js.map +1 -1
  271. package/dist/specification/src/sync/v2/import/utils.d.ts +18 -9
  272. package/dist/specification/src/sync/v2/import/utils.d.ts.map +1 -1
  273. package/dist/specification/src/sync/v2/import/utils.js +27 -15
  274. package/dist/specification/src/sync/v2/import/utils.js.map +1 -1
  275. package/dist/specification/src/sync/v2/utils.d.ts +26 -1
  276. package/dist/specification/src/sync/v2/utils.d.ts.map +1 -1
  277. package/dist/specification/src/sync/v2/utils.js +47 -1
  278. package/dist/specification/src/sync/v2/utils.js.map +1 -1
  279. package/dist/specification/src/sync/v4/application.d.ts +7 -5
  280. package/dist/specification/src/sync/v4/application.d.ts.map +1 -1
  281. package/dist/specification/src/sync/v4/application.js +7 -5
  282. package/dist/specification/src/sync/v4/application.js.map +1 -1
  283. package/dist/specification/src/sync/v4/export/controls/FilterBar.d.ts.map +1 -1
  284. package/dist/specification/src/sync/v4/export/controls/FilterBar.js +8 -0
  285. package/dist/specification/src/sync/v4/export/controls/FilterBar.js.map +1 -1
  286. package/dist/specification/src/sync/v4/export/controls/ObjectPageFooter.d.ts.map +1 -1
  287. package/dist/specification/src/sync/v4/export/controls/ObjectPageFooter.js.map +1 -1
  288. package/dist/specification/src/sync/v4/export/controls/ObjectPageTableColumn.d.ts.map +1 -1
  289. package/dist/specification/src/sync/v4/export/controls/ObjectPageTableColumn.js.map +1 -1
  290. package/dist/specification/src/sync/v4/export/controls/Table.d.ts +18 -10
  291. package/dist/specification/src/sync/v4/export/controls/Table.d.ts.map +1 -1
  292. package/dist/specification/src/sync/v4/export/controls/Table.js +48 -18
  293. package/dist/specification/src/sync/v4/export/controls/Table.js.map +1 -1
  294. package/dist/specification/src/sync/v4/export/controls/TableColumn.d.ts.map +1 -1
  295. package/dist/specification/src/sync/v4/export/controls/TableColumn.js.map +1 -1
  296. package/dist/specification/src/sync/v4/export/export.d.ts +6 -4
  297. package/dist/specification/src/sync/v4/export/export.d.ts.map +1 -1
  298. package/dist/specification/src/sync/v4/export/export.js +136 -58
  299. package/dist/specification/src/sync/v4/export/export.js.map +1 -1
  300. package/dist/specification/src/sync/v4/export/exportCustomColumn.d.ts +6 -4
  301. package/dist/specification/src/sync/v4/export/exportCustomColumn.d.ts.map +1 -1
  302. package/dist/specification/src/sync/v4/export/exportCustomColumn.js +6 -4
  303. package/dist/specification/src/sync/v4/export/exportCustomColumn.js.map +1 -1
  304. package/dist/specification/src/sync/v4/export/flexibleColumnLayout.d.ts +3 -2
  305. package/dist/specification/src/sync/v4/export/flexibleColumnLayout.d.ts.map +1 -1
  306. package/dist/specification/src/sync/v4/export/flexibleColumnLayout.js +13 -9
  307. package/dist/specification/src/sync/v4/export/flexibleColumnLayout.js.map +1 -1
  308. package/dist/specification/src/sync/v4/export/fpmCustomPage.d.ts +6 -4
  309. package/dist/specification/src/sync/v4/export/fpmCustomPage.d.ts.map +1 -1
  310. package/dist/specification/src/sync/v4/export/fpmCustomPage.js +9 -4
  311. package/dist/specification/src/sync/v4/export/fpmCustomPage.js.map +1 -1
  312. package/dist/specification/src/sync/v4/export/manifest.d.ts +6 -2
  313. package/dist/specification/src/sync/v4/export/manifest.d.ts.map +1 -1
  314. package/dist/specification/src/sync/v4/export/manifest.js +46 -17
  315. package/dist/specification/src/sync/v4/export/manifest.js.map +1 -1
  316. package/dist/specification/src/sync/v4/export/pages/ListReport.d.ts.map +1 -1
  317. package/dist/specification/src/sync/v4/export/pages/ListReport.js +4 -3
  318. package/dist/specification/src/sync/v4/export/pages/ListReport.js.map +1 -1
  319. package/dist/specification/src/sync/v4/export/utils.d.ts +6 -4
  320. package/dist/specification/src/sync/v4/export/utils.d.ts.map +1 -1
  321. package/dist/specification/src/sync/v4/export/utils.js +6 -4
  322. package/dist/specification/src/sync/v4/export/utils.js.map +1 -1
  323. package/dist/specification/src/sync/v4/generate/fpm-custom-page/annotations.d.ts.map +1 -1
  324. package/dist/specification/src/sync/v4/generate/fpm-custom-page/annotations.js +4 -0
  325. package/dist/specification/src/sync/v4/generate/fpm-custom-page/annotations.js.map +1 -1
  326. package/dist/specification/src/sync/v4/generate/fpm-custom-page/extensions.d.ts +5 -3
  327. package/dist/specification/src/sync/v4/generate/fpm-custom-page/extensions.d.ts.map +1 -1
  328. package/dist/specification/src/sync/v4/generate/fpm-custom-page/extensions.js +14 -5
  329. package/dist/specification/src/sync/v4/generate/fpm-custom-page/extensions.js.map +1 -1
  330. package/dist/specification/src/sync/v4/generate/fpm-custom-page/generator.d.ts +1 -0
  331. package/dist/specification/src/sync/v4/generate/fpm-custom-page/generator.d.ts.map +1 -1
  332. package/dist/specification/src/sync/v4/generate/fpm-custom-page/generator.js +18 -0
  333. package/dist/specification/src/sync/v4/generate/fpm-custom-page/generator.js.map +1 -1
  334. package/dist/specification/src/sync/v4/generate/fpm-custom-page/pageExtensions.d.ts +1 -1
  335. package/dist/specification/src/sync/v4/generate/fpm-custom-page/pageExtensions.d.ts.map +1 -1
  336. package/dist/specification/src/sync/v4/generate/fpm-custom-page/pageExtensions.js +2 -1
  337. package/dist/specification/src/sync/v4/generate/fpm-custom-page/pageExtensions.js.map +1 -1
  338. package/dist/specification/src/sync/v4/generate/fpm-custom-page/utils.d.ts +2 -0
  339. package/dist/specification/src/sync/v4/generate/fpm-custom-page/utils.d.ts.map +1 -1
  340. package/dist/specification/src/sync/v4/generate/fpm-custom-page/utils.js +2 -0
  341. package/dist/specification/src/sync/v4/generate/fpm-custom-page/utils.js.map +1 -1
  342. package/dist/specification/src/sync/v4/generate/freestylePage.d.ts +2 -2
  343. package/dist/specification/src/sync/v4/generate/freestylePage.js +2 -2
  344. package/dist/specification/src/sync/v4/generate/generate.d.ts +13 -11
  345. package/dist/specification/src/sync/v4/generate/generate.d.ts.map +1 -1
  346. package/dist/specification/src/sync/v4/generate/generate.js +13 -11
  347. package/dist/specification/src/sync/v4/generate/generate.js.map +1 -1
  348. package/dist/specification/src/sync/v4/generate/listReport.d.ts +10 -7
  349. package/dist/specification/src/sync/v4/generate/listReport.d.ts.map +1 -1
  350. package/dist/specification/src/sync/v4/generate/listReport.js +122 -73
  351. package/dist/specification/src/sync/v4/generate/listReport.js.map +1 -1
  352. package/dist/specification/src/sync/v4/generate/objectPage.d.ts +1 -1
  353. package/dist/specification/src/sync/v4/generate/objectPage.d.ts.map +1 -1
  354. package/dist/specification/src/sync/v4/generate/objectPage.js +206 -154
  355. package/dist/specification/src/sync/v4/generate/objectPage.js.map +1 -1
  356. package/dist/specification/src/sync/v4/import/app/appProvider.d.ts +18 -4
  357. package/dist/specification/src/sync/v4/import/app/appProvider.d.ts.map +1 -1
  358. package/dist/specification/src/sync/v4/import/app/appProvider.js +56 -24
  359. package/dist/specification/src/sync/v4/import/app/appProvider.js.map +1 -1
  360. package/dist/specification/src/sync/v4/import/fragment.d.ts +29 -4
  361. package/dist/specification/src/sync/v4/import/fragment.d.ts.map +1 -1
  362. package/dist/specification/src/sync/v4/import/fragment.js +46 -7
  363. package/dist/specification/src/sync/v4/import/fragment.js.map +1 -1
  364. package/dist/specification/src/sync/v4/import/pages/fpmCustomPage.d.ts +3 -2
  365. package/dist/specification/src/sync/v4/import/pages/fpmCustomPage.d.ts.map +1 -1
  366. package/dist/specification/src/sync/v4/import/pages/fpmCustomPage.js +7 -2
  367. package/dist/specification/src/sync/v4/import/pages/fpmCustomPage.js.map +1 -1
  368. package/dist/specification/src/sync/v4/import/pages/listReport.d.ts +12 -10
  369. package/dist/specification/src/sync/v4/import/pages/listReport.d.ts.map +1 -1
  370. package/dist/specification/src/sync/v4/import/pages/listReport.js +69 -46
  371. package/dist/specification/src/sync/v4/import/pages/listReport.js.map +1 -1
  372. package/dist/specification/src/sync/v4/import/pages/objectPage.d.ts +7 -6
  373. package/dist/specification/src/sync/v4/import/pages/objectPage.d.ts.map +1 -1
  374. package/dist/specification/src/sync/v4/import/pages/objectPage.js +49 -36
  375. package/dist/specification/src/sync/v4/import/pages/objectPage.js.map +1 -1
  376. package/dist/specification/src/sync/v4/import/utils.d.ts +4 -2
  377. package/dist/specification/src/sync/v4/import/utils.d.ts.map +1 -1
  378. package/dist/specification/src/sync/v4/import/utils.js +4 -2
  379. package/dist/specification/src/sync/v4/import/utils.js.map +1 -1
  380. package/dist/specification/src/sync/v4/sync-rules/controllerExtensions.d.ts.map +1 -1
  381. package/dist/specification/src/sync/v4/sync-rules/controllerExtensions.js +5 -2
  382. package/dist/specification/src/sync/v4/sync-rules/controllerExtensions.js.map +1 -1
  383. package/dist/specification/src/sync/v4/utils/StableIdHelper.d.ts +12 -0
  384. package/dist/specification/src/sync/v4/utils/StableIdHelper.d.ts.map +1 -1
  385. package/dist/specification/src/sync/v4/utils/StableIdHelper.js +18 -0
  386. package/dist/specification/src/sync/v4/utils/StableIdHelper.js.map +1 -1
  387. package/dist/specification/src/sync/v4/utils/macros.d.ts +4 -0
  388. package/dist/specification/src/sync/v4/utils/macros.d.ts.map +1 -1
  389. package/dist/specification/src/sync/v4/utils/macros.js +17 -1
  390. package/dist/specification/src/sync/v4/utils/macros.js.map +1 -1
  391. package/dist/specification/src/sync/v4/utils/utils.d.ts +38 -20
  392. package/dist/specification/src/sync/v4/utils/utils.d.ts.map +1 -1
  393. package/dist/specification/src/sync/v4/utils/utils.js +99 -52
  394. package/dist/specification/src/sync/v4/utils/utils.js.map +1 -1
  395. package/dist/types/src/apiTypes.d.ts +13 -0
  396. package/dist/types/src/apiTypes.d.ts.map +1 -1
  397. package/dist/types/src/apiTypes.js +18 -1
  398. package/dist/types/src/apiTypes.js.map +1 -1
  399. package/dist/types/src/common/Application.d.ts +6 -0
  400. package/dist/types/src/common/Application.d.ts.map +1 -1
  401. package/dist/types/src/common/Application.js +4 -0
  402. package/dist/types/src/common/Application.js.map +1 -1
  403. package/dist/types/src/common/types.d.ts +51 -2
  404. package/dist/types/src/common/types.d.ts.map +1 -1
  405. package/dist/types/src/common/types.js +2 -1
  406. package/dist/types/src/common/types.js.map +1 -1
  407. package/dist/types/src/common/webapp/manifest/sapUi5.d.ts +3 -2
  408. package/dist/types/src/common/webapp/manifest/sapUi5.d.ts.map +1 -1
  409. package/dist/types/src/common/webapp/manifest/sapUi5.js +3 -2
  410. package/dist/types/src/common/webapp/manifest/sapUi5.js.map +1 -1
  411. package/dist/types/src/v2/application.d.ts +1 -1
  412. package/dist/types/src/v2/controls/Action.d.ts +12 -0
  413. package/dist/types/src/v2/controls/Action.d.ts.map +1 -1
  414. package/dist/types/src/v2/controls/AnalyticalListPageChart.d.ts +1 -0
  415. package/dist/types/src/v2/controls/AnalyticalListPageChart.d.ts.map +1 -1
  416. package/dist/types/src/v2/controls/AnalyticalListPageKPI.d.ts +1 -0
  417. package/dist/types/src/v2/controls/AnalyticalListPageKPI.d.ts.map +1 -1
  418. package/dist/types/src/v2/controls/Card.d.ts +13 -0
  419. package/dist/types/src/v2/controls/Card.d.ts.map +1 -1
  420. package/dist/types/src/v2/controls/Card.js.map +1 -1
  421. package/dist/types/src/v2/controls/Field.d.ts +1 -0
  422. package/dist/types/src/v2/controls/Field.d.ts.map +1 -1
  423. package/dist/types/src/v2/controls/FilterBar.d.ts +6 -0
  424. package/dist/types/src/v2/controls/FilterBar.d.ts.map +1 -1
  425. package/dist/types/src/v2/controls/FilterBar.js.map +1 -1
  426. package/dist/types/src/v2/controls/Header.d.ts +1 -0
  427. package/dist/types/src/v2/controls/Header.d.ts.map +1 -1
  428. package/dist/types/src/v2/controls/ObjectPageChart.d.ts +1 -0
  429. package/dist/types/src/v2/controls/ObjectPageChart.d.ts.map +1 -1
  430. package/dist/types/src/v2/controls/ObjectPageFooter.d.ts +2 -0
  431. package/dist/types/src/v2/controls/ObjectPageFooter.d.ts.map +1 -1
  432. package/dist/types/src/v2/controls/ObjectPageForm.d.ts +1 -0
  433. package/dist/types/src/v2/controls/ObjectPageForm.d.ts.map +1 -1
  434. package/dist/types/src/v2/controls/ObjectPageHeader.d.ts +1 -0
  435. package/dist/types/src/v2/controls/ObjectPageHeader.d.ts.map +1 -1
  436. package/dist/types/src/v2/controls/ObjectPageHeaderSection.d.ts +3 -0
  437. package/dist/types/src/v2/controls/ObjectPageHeaderSection.d.ts.map +1 -1
  438. package/dist/types/src/v2/controls/ObjectPageLayout.d.ts +1 -0
  439. package/dist/types/src/v2/controls/ObjectPageLayout.d.ts.map +1 -1
  440. package/dist/types/src/v2/controls/ObjectPageSection.d.ts +13 -0
  441. package/dist/types/src/v2/controls/ObjectPageSection.d.ts.map +1 -1
  442. package/dist/types/src/v2/controls/ObjectPageSection.js.map +1 -1
  443. package/dist/types/src/v2/controls/ObjectPageTable.d.ts +6 -0
  444. package/dist/types/src/v2/controls/ObjectPageTable.d.ts.map +1 -1
  445. package/dist/types/src/v2/controls/ObjectPageToolBar.d.ts +2 -0
  446. package/dist/types/src/v2/controls/ObjectPageToolBar.d.ts.map +1 -1
  447. package/dist/types/src/v2/controls/Table.d.ts +28 -0
  448. package/dist/types/src/v2/controls/Table.d.ts.map +1 -1
  449. package/dist/types/src/v2/controls/Table.js.map +1 -1
  450. package/dist/types/src/v2/controls/ToolBar.d.ts +1 -0
  451. package/dist/types/src/v2/controls/ToolBar.d.ts.map +1 -1
  452. package/dist/types/src/v2/pages/AnalyticalListPageConfigV2.d.ts +1 -0
  453. package/dist/types/src/v2/pages/AnalyticalListPageConfigV2.d.ts.map +1 -1
  454. package/dist/types/src/v2/pages/OverviewPageConfigV2.d.ts +4 -0
  455. package/dist/types/src/v2/pages/OverviewPageConfigV2.d.ts.map +1 -1
  456. package/dist/types/src/v4/application.d.ts +1 -1
  457. package/dist/types/src/v4/controls/CustomAction.d.ts +10 -0
  458. package/dist/types/src/v4/controls/CustomAction.d.ts.map +1 -1
  459. package/dist/types/src/v4/controls/FilterBar.d.ts +10 -0
  460. package/dist/types/src/v4/controls/FilterBar.d.ts.map +1 -1
  461. package/dist/types/src/v4/controls/FilterBar.js.map +1 -1
  462. package/dist/types/src/v4/controls/Header.d.ts +1 -0
  463. package/dist/types/src/v4/controls/Header.d.ts.map +1 -1
  464. package/dist/types/src/v4/controls/ObjectPageFooter.d.ts +1 -0
  465. package/dist/types/src/v4/controls/ObjectPageFooter.d.ts.map +1 -1
  466. package/dist/types/src/v4/controls/ObjectPageForm.d.ts +1 -0
  467. package/dist/types/src/v4/controls/ObjectPageForm.d.ts.map +1 -1
  468. package/dist/types/src/v4/controls/ObjectPageHeader.d.ts +2 -0
  469. package/dist/types/src/v4/controls/ObjectPageHeader.d.ts.map +1 -1
  470. package/dist/types/src/v4/controls/ObjectPageHeaderSection.d.ts +6 -0
  471. package/dist/types/src/v4/controls/ObjectPageHeaderSection.d.ts.map +1 -1
  472. package/dist/types/src/v4/controls/ObjectPageLayout.d.ts +1 -0
  473. package/dist/types/src/v4/controls/ObjectPageLayout.d.ts.map +1 -1
  474. package/dist/types/src/v4/controls/ObjectPageSection.d.ts +17 -0
  475. package/dist/types/src/v4/controls/ObjectPageSection.d.ts.map +1 -1
  476. package/dist/types/src/v4/controls/ObjectPageSection.js.map +1 -1
  477. package/dist/types/src/v4/controls/ObjectPageTable.d.ts +5 -0
  478. package/dist/types/src/v4/controls/ObjectPageTable.d.ts.map +1 -1
  479. package/dist/types/src/v4/controls/ObjectPageTable.js.map +1 -1
  480. package/dist/types/src/v4/controls/ObjectPageToolBar.d.ts +4 -0
  481. package/dist/types/src/v4/controls/ObjectPageToolBar.d.ts.map +1 -1
  482. package/dist/types/src/v4/controls/Table.d.ts +15 -0
  483. package/dist/types/src/v4/controls/Table.d.ts.map +1 -1
  484. package/dist/types/src/v4/controls/ToolBar.d.ts +9 -0
  485. package/dist/types/src/v4/controls/ToolBar.d.ts.map +1 -1
  486. package/dist/types/src/v4/page.d.ts +4 -0
  487. package/dist/types/src/v4/page.d.ts.map +1 -1
  488. package/dist/types/src/v4/webapp/manifest/ManifestSettings.d.ts +22 -0
  489. package/dist/types/src/v4/webapp/manifest/ManifestSettings.d.ts.map +1 -1
  490. package/dist/types/src/v4/webapp/manifest/sapUi5.d.ts +3 -0
  491. package/dist/types/src/v4/webapp/manifest/sapUi5.d.ts.map +1 -1
  492. package/dist/types/src/v4/webapp/manifest/sapUi5.js.map +1 -1
  493. package/dist/types/src/v4/webapp/manifest/sapUiPageV4.d.ts +1 -1
  494. package/dist/types/src/v4/webapp/manifest/sapUiPageV4.d.ts.map +1 -1
  495. package/dist/types/src/v4/webapp/manifest/sapUiPageV4.js +2 -2
  496. package/dist/types/src/v4/webapp/manifest/sapUiPageV4.js.map +1 -1
  497. package/package.json +7 -7
@@ -16,8 +16,8 @@ const viewProperties = ['key', 'index', 'label', 'visible', 'showCounts', 'entit
16
16
  const doTransfer = [...viewProperties, 'views', 'initialLoad', 'template'];
17
17
  /**
18
18
  * Returns a fresh export results object with default values.
19
- * @param manifest - manifest to clone
20
19
  *
20
+ * @param manifest - manifest to clone
21
21
  * @returns New export results object with default values.
22
22
  */
23
23
  const prepareDefaultExportResult = (manifest) => {
@@ -27,6 +27,14 @@ const prepareDefaultExportResult = (manifest) => {
27
27
  exportResults.manifest = JSON.parse(JSON.stringify(manifest));
28
28
  return exportResults;
29
29
  };
30
+ /**
31
+ * Determines the target annotation of a table based on the provided IDs and transfer parameters.
32
+ *
33
+ * @param ids - List of IDs of parent elements.
34
+ * @param transferParameters - Parameters used for transferring data.
35
+ * @param configObject - The configuration object containing table details.
36
+ * @returns An object containing the encoded and decoded target annotation.
37
+ */
30
38
  function determineTargetAnnotationOfTable(ids, transferParameters, configObject) {
31
39
  let targetAnnotationEncoded = `@${"com.sap.vocabularies.UI.v1.LineItem" /* UIAnnotationTerms.LineItem */}`;
32
40
  let targetAnnotation = `@${"com.sap.vocabularies.UI.v1.LineItem" /* UIAnnotationTerms.LineItem */}`;
@@ -45,6 +53,14 @@ function determineTargetAnnotationOfTable(ids, transferParameters, configObject)
45
53
  }
46
54
  return { targetAnnotationEncoded, targetAnnotation };
47
55
  }
56
+ /**
57
+ * Determines the target annotation of a chart based on the provided IDs and transfer parameters.
58
+ *
59
+ * @param ids - List of IDs of parent elements.
60
+ * @param transferParameters - Parameters used for transferring data.
61
+ * @param configObject - The configuration object containing chart details.
62
+ * @returns An object containing the encoded and decoded target annotation.
63
+ */
48
64
  function determineTargetAnnotationOfChart(ids, transferParameters, configObject) {
49
65
  let targetAnnotationEncoded, targetAnnotation;
50
66
  if (ids.length > 1) {
@@ -57,6 +73,16 @@ function determineTargetAnnotationOfChart(ids, transferParameters, configObject)
57
73
  }
58
74
  return { targetAnnotationEncoded, targetAnnotation };
59
75
  }
76
+ /**
77
+ * Determines the target annotation based on the parent view.
78
+ *
79
+ * @param ids - List of IDs of parent elements.
80
+ * @param targetAnnotation - The target annotation to be determined.
81
+ * @param targetAnnotationEncoded - The encoded target annotation to be determined.
82
+ * @param parentDefinition - The parent definition containing annotation details.
83
+ * @param transferParameters - Parameters used for transferring data.
84
+ * @returns An object containing the updated targetAnnotation and targetAnnotationEncoded.
85
+ */
60
86
  function determineTargetAnnotationBasedOnParentView(ids, targetAnnotation, targetAnnotationEncoded, parentDefinition, transferParameters) {
61
87
  if (ids.length === 3) {
62
88
  //the parent definition comprises the annotation of the visualization of the (Selection)PresentationVariant.
@@ -77,10 +103,11 @@ function determineTargetAnnotationBasedOnParentView(ids, targetAnnotation, targe
77
103
  return { targetAnnotation, targetAnnotationEncoded };
78
104
  }
79
105
  /**
80
- * Determines the target annotation of a view
106
+ * Determines the target annotation of a view.
107
+ *
81
108
  * @param {TransferParameterTypeV4} transferParameters - list of parameters passed from API
82
109
  * @param {string[]} ids - list of ids of parent elements
83
- * @returns { targetAnnotationEncoded, targetAnnotation}
110
+ * @returns An object containing the target annotation and encoded target annotation.
84
111
  */
85
112
  function determineTargetAnnotationOfView(transferParameters, ids) {
86
113
  let targetAnnotation, targetAnnotationEncoded;
@@ -106,6 +133,14 @@ function determineTargetAnnotationOfView(transferParameters, ids) {
106
133
  delete transferParameters.appSchema.definitions.Table[ux_specification_types_1.SchemaTag.annotationPath];
107
134
  return { targetAnnotation, targetAnnotationEncoded };
108
135
  }
136
+ /**
137
+ * Determines the target annotation of header sections based on the provided IDs, custom flag, and optional title.
138
+ *
139
+ * @param ids - List of IDs of parent elements.
140
+ * @param custom - Flag indicating whether the section is custom.
141
+ * @param title - Optional title of the section.
142
+ * @returns An object containing the custom flag, encoded target annotation, and decoded target annotation.
143
+ */
109
144
  function determineTargetAnnotationOfHeaderSections(ids, custom, title) {
110
145
  let targetAnnotation, targetAnnotationEncoded;
111
146
  // check if id is in `@com.sap.vocabularies.UI.v1.DataPoint#FlightPrice` format
@@ -128,6 +163,13 @@ function determineTargetAnnotationOfHeaderSections(ids, custom, title) {
128
163
  }
129
164
  return { custom, targetAnnotationEncoded, targetAnnotation };
130
165
  }
166
+ /**
167
+ * Determines the target annotation of sections based on the provided IDs and custom flag.
168
+ *
169
+ * @param ids - List of IDs of parent elements.
170
+ * @param custom - Flag indicating whether the section is custom.
171
+ * @returns An object containing the custom flag, encoded target annotation, and decoded target annotation.
172
+ */
131
173
  function determineTargetAnnotationOfSections(ids, custom) {
132
174
  const isAnnotationBased = ids[1].split(`@${ux_specification_types_1.UIVOCABULARY}`)[1];
133
175
  let targetAnnotation, targetAnnotationEncoded;
@@ -144,11 +186,12 @@ function determineTargetAnnotationOfSections(ids, custom) {
144
186
  return { custom, targetAnnotationEncoded, targetAnnotation };
145
187
  }
146
188
  /**
147
- * Determines the target annotation that is relevant for the sync rule
148
- * @param {string[]} ids - list of ids of parent elements
149
- * @param {TransferParameterTypeV4} transferParameters - list of parameters passed from API
150
- * @param { [key: string]: any } configObject - the given section of config.json, to be exported
151
- * @returns { targetAnnotationEncoded, targetAnnotation, custom }
189
+ * Determines the target annotation that is relevant for the sync rule.
190
+ *
191
+ * @param ids - list of ids of parent elements
192
+ * @param transferParameters - list of parameters passed from API
193
+ * @param configObject - the given section of config.json, to be exported
194
+ * @returns an object containing the encoded target annotation, decoded target annotation, and custom flag
152
195
  */
153
196
  function determineTargetAnnotation(ids, transferParameters, configObject) {
154
197
  let targetAnnotation, targetAnnotationEncoded, custom = false;
@@ -171,7 +214,8 @@ function determineTargetAnnotation(ids, transferParameters, configObject) {
171
214
  return { targetAnnotationEncoded, targetAnnotation, custom };
172
215
  }
173
216
  /**
174
- * Calculates an additional key for the sync rule from the given ID's
217
+ * Calculates an additional key for the sync rule from the given ID's.
218
+ *
175
219
  * @param {string[]} ids - list of ids of parent elements
176
220
  * @returns the key for the sync rule
177
221
  */
@@ -193,7 +237,8 @@ function determineKeyForSyncRule(ids) {
193
237
  return idIndex > 0 ? ids[idIndex]?.replace(/\//gi, '??') : undefined;
194
238
  }
195
239
  /**
196
- * Creates a new object in manifest
240
+ * Creates a new object in manifest.
241
+ *
197
242
  * @param {ExportToManifestParams} params - list of parameters
198
243
  */
199
244
  function createNewObjectInManifest(params) {
@@ -205,7 +250,8 @@ function createNewObjectInManifest(params) {
205
250
  }
206
251
  }
207
252
  /**
208
- * Transfers a property value from config to manifest
253
+ * Transfers a property value from config to manifest.
254
+ *
209
255
  * @param {ExportToManifestParams} params - list of parameters
210
256
  * @param propertyDefinition - schema definition of a particular property
211
257
  * @param nextDefinition - schema definition referred by $ref
@@ -239,14 +285,15 @@ function transferPropertyToManifest(params, propertyDefinition, nextDefinition)
239
285
  return changed;
240
286
  }
241
287
  /**
242
- * Deletes a setting from manifest
288
+ * Deletes a setting from manifest.
289
+ *
243
290
  * @param {string[]} ids - list of parent & child ids
244
291
  * @param {ExportToManifestParams} params - special transfer structure for the export to manifest
245
292
  * @param {TransferParameterTypeV4} transferParameters - general transfer structure of the export
246
293
  * @param {object} manifestSection - the given section in manifest
247
294
  * @param {string} path - the xpath expression for the manifest section
248
- * @param {string} targetAnnotation
249
- * @param {string} targetAnnotationEncoded
295
+ * @param {string} targetAnnotation - The decoded target annotation.
296
+ * @param {string} targetAnnotationEncoded - The encoded target annotation.
250
297
  * @returns a boolean indicator if any change happened to the manifest
251
298
  */
252
299
  function deleteFromManifest(ids, params, transferParameters, manifestSection, path, targetAnnotation, targetAnnotationEncoded) {
@@ -281,14 +328,13 @@ function deleteFromManifest(ids, params, transferParameters, manifestSection, pa
281
328
  return changed;
282
329
  }
283
330
  /**
284
- * Transfers a change in config.json to manifest
285
- * @param {string[]} ids - list of parent & child ids
286
- * @param {SyncRule} syncRule - syncRule (metadata)
287
- * @param {TransferParameterTypeV4} transferParameters - list of parameters passed from API
288
- * @param {string} configPropertyKey - key of property in the config
289
- * @param { [key: string]: any } configObject - the given config.json, to be exported
290
- * @param propertyDefinition - schema definition of a particular property
331
+ * Transfers a change in config.json to manifest.
332
+ *
333
+ * @param ids - list of parent & child ids
334
+ * @param syncRule - syncRule (metadata)
335
+ * @param parameters - list of parameters passed from API
291
336
  * @param nextDefinition - schema definition referred by $ref
337
+ * @returns a boolean indicator if any change happened to the manifest
292
338
  */
293
339
  function exportManifestChange(ids, syncRule, parameters, nextDefinition) {
294
340
  let changed = false;
@@ -324,7 +370,8 @@ function exportManifestChange(ids, syncRule, parameters, nextDefinition) {
324
370
  return changed;
325
371
  }
326
372
  /**
327
- * Evaluates an export rule for a property or object, transfers to flex change or manifest setting
373
+ * Evaluates an export rule for a property or object, transfers to flex change or manifest setting.
374
+ *
328
375
  * @param {TransferEntryParameters} parameters - list of parameters
329
376
  * @param ids - list of parent & child ids
330
377
  * @param nextDefinition - schema definition referred by $ref
@@ -345,7 +392,8 @@ function evaluateExportRule(parameters, ids, nextDefinition) {
345
392
  }
346
393
  }
347
394
  /**
348
- * Processes an (object-like) sub-object of the app schema and transfer all connected config entries to manifest
395
+ * Processes an (object-like) sub-object of the app schema and transfer all connected config entries to manifest.
396
+ *
349
397
  * @param {TransferEntryParameters} parameters - list of parameters
350
398
  * @param {NextDefinition} nextDefinition - the next definition in app schema to be processed
351
399
  * @param currentConfigObject - current config object
@@ -376,12 +424,14 @@ function transferSubObject(parameters, nextDefinition, currentConfigObject, ids,
376
424
  /**
377
425
  * Creates an ALP 'views' entry in the resulting manifest if not yet existing.
378
426
  * Adds the secondary = table view if missing.
427
+ *
379
428
  * @param {TransferParameterTypeV4} transferParameters - list of parameters passed from API
380
429
  * @param configObject - current object in config.json
381
- * @returns
430
+ * @param key - The key representing the property name or identifier.
431
+ * @returns A boolean indicating whether the views entry got created or if processing should stop.
382
432
  * - a boolean indicating that the views entry got created.
383
433
  * - a boolean indicating if the processing of sub-objects shall be stopped
384
- **/
434
+ */
385
435
  function createALPTableView(transferParameters, configObject, key) {
386
436
  let newElementCreated = false;
387
437
  if (!configObject[key] || Object.keys(configObject[key]).length === 0 || !configObject.chart) {
@@ -414,8 +464,9 @@ function createALPTableView(transferParameters, configObject, key) {
414
464
  /**
415
465
  * Creates an ALP 'views' entry in the resulting manifest if not yet existing.
416
466
  * Adds the primary = chart view if missing.
467
+ *
417
468
  * @param {TransferEntryParameters} parameters - list of parameters
418
- * @returns
469
+ * @returns A boolean indicating whether the views entry got created or if processing should stop.
419
470
  * - a boolean indicating that the views entry got created.
420
471
  * - a boolean indicating if the processing of sub-objects shall be stopped
421
472
  */
@@ -459,6 +510,7 @@ function createALPChartView(parameters) {
459
510
  /**
460
511
  * Creates an controlConfiguration with filterFields in the resulting manifest if not yet existing.
461
512
  * Adds the current visual filters if missing.
513
+ *
462
514
  * @param {TransferParameterTypeV4} transferParameters - list of parameters passed from API
463
515
  * @param configObject - current object in config.json
464
516
  * @returns a boolean indicating that the filter fields entry got created.
@@ -505,7 +557,10 @@ function createVisualFilters(transferParameters, configObject) {
505
557
  /**
506
558
  * Creates an LR 'views' entry in the resulting manifest if not yet existing yet.
507
559
  * Adds the current table view if missing.
560
+ *
561
+ * @param index - The index of the current item in the list.
508
562
  * @param {TransferParameterTypeV4} transferParameters - list of parameters passed from API
563
+ * @param key - The key representing the property name or identifier.
509
564
  * @param configObject - current object in config.json
510
565
  * @returns a boolean indicating that the views entry got created.
511
566
  */
@@ -543,11 +598,12 @@ function createLRTableView(index, transferParameters, key, configObject) {
543
598
  return newElementCreated;
544
599
  }
545
600
  /**
546
- * Special logic to create new elements in manifest
601
+ * Special logic to create new elements in manifest.
602
+ *
547
603
  * @param {TransferEntryParameters} parameters - list of parameters
548
604
  * @param {string} definitionName - schema definition name of the current object
549
605
  * @param {boolean} preprocessed - indicates that the element was already processed
550
- * @returns
606
+ * @returns A boolean indicating whether the definition was processed.
551
607
  * - newElementCreated - indicates that a new element was created ==> no further sync rule on this level
552
608
  * - createNewElement - indicates that further processing shall be stopped
553
609
  */
@@ -582,8 +638,8 @@ function createNewElement(parameters, definitionName, preprocessed) {
582
638
  /**
583
639
  * Function checks if passed schema definition is traversable.
584
640
  * It checks if definition has reference or object properties defined directly in definition.
585
- * @param {Definition} definition Definition to check.
586
641
  *
642
+ * @param {Definition} definition Definition to check.
587
643
  * @returns True if passed schema definition is traversable.
588
644
  */
589
645
  function isDefinitionTraversable(definition) {
@@ -592,7 +648,8 @@ function isDefinitionTraversable(definition) {
592
648
  !!definition.anyOf);
593
649
  }
594
650
  /**
595
- * Transfers one entry of a list (aka one property of the config) to the manifest
651
+ * Transfers one entry of a list (aka one property of the config) to the manifest.
652
+ *
596
653
  * @param {TransferEntryParameters} parameters - list of parameters
597
654
  * @param {string[]} parentIds - array of collected parent ids
598
655
  * @param {string[]} stableIdParts - list of parts of the stable ID for flex changes
@@ -616,13 +673,14 @@ function transferSortedListEntry(parameters, parentIds, stableIdParts, preproces
616
673
  }
617
674
  }
618
675
  /**
619
- * Function for special handling of anyOf definitions during the export
620
- * @param {TransferEntryParameters} parameters - list of parameters
676
+ * Function for special handling of anyOf definitions during the export.
677
+ *
678
+ * @param transferEntryParameters - Parameters for transferring configuration entries with anyOf definitions.
621
679
  * @param anyOfDefinitions - the array of definitions from the anyOf (of additionalProperties)
622
680
  * @param schemaDefinition - parent definition, comprising properties as well as additionalProperties
623
681
  * @param parentIds - array of collected parent ids
624
682
  * @param stableIdParts - list of parts of the stable ID for flex changes
625
- * @returns
683
+ * @returns A boolean indicating whether the definition was processed.
626
684
  */
627
685
  function transferConfigEntriesWithAnyOfDefinitions(transferEntryParameters, anyOfDefinitions, schemaDefinition, parentIds, stableIdParts) {
628
686
  let preprocessed = false;
@@ -659,6 +717,7 @@ function transferConfigEntriesWithAnyOfDefinitions(transferEntryParameters, anyO
659
717
  }
660
718
  /**
661
719
  * Method updates list of definition entries from schema with entries for insertion based on `additionalProperties` entry.
720
+ *
662
721
  * @param {TransferParameterTypeV4} transferParameters - list of parameters passed from API.
663
722
  * @param {Definition} additionalProperties - allowed additional properties.
664
723
  * @param {[string, DefinitionOrBoolean][]} list - list with entries.
@@ -680,8 +739,9 @@ function mergeEntriesForInsert(transferParameters, additionalProperties, list, c
680
739
  }
681
740
  }
682
741
  /**
683
- * Sorts the properties of a schema definition, considering the propertyIndex
684
- * @param {[key: string]: DefinitionOrBoolean} properties
742
+ * Sorts the properties of a schema definition, considering the propertyIndex.
743
+ *
744
+ * @param properties - The properties of a schema definition to be sorted.
685
745
  * @returns a sorted list of properties, as object entries
686
746
  */
687
747
  function sortProperties(properties) {
@@ -693,12 +753,12 @@ function sortProperties(properties) {
693
753
  }
694
754
  /**
695
755
  *
696
- * @param {Definition} additionalProperties - additionalProperties definition at the given schema definition
697
- * @param {TransferParameterTypeV4} transferParameters - list of parameters passed from API
698
- * @param {TransferEntryParameters} parameters - list of parameters
699
- * @param {Definition} schemaDefinition - the current schema definition
700
- * @param {string[]} parentIds - array of collected parent ids
701
- * @param {string[]} stableIdParts - list of parts of the stable ID for flex changes
756
+ * @param additionalProperties - additionalProperties definition at the given schema definition
757
+ * @param transferParameters - list of parameters passed from API
758
+ * @param transferEntryParameters - Parameters for transferring configuration entries with anyOf definitions.
759
+ * @param schemaDefinition - the current schema definition
760
+ * @param parentIds - array of collected parent ids
761
+ * @param stableIdParts - list of parts of the stable ID for flex changes
702
762
  * @returns an indicator showing if the defintion was processed.
703
763
  */
704
764
  function checkIfAnyOfDefinition(additionalProperties, transferParameters, transferEntryParameters, schemaDefinition, parentIds, stableIdParts) {
@@ -716,7 +776,8 @@ function checkIfAnyOfDefinition(additionalProperties, transferParameters, transf
716
776
  return preprocessed;
717
777
  }
718
778
  /**
719
- * Recursive function that traverses the content of the current object. It reads decorators and fills exportResultManifest entries and flex changes
779
+ * Recursive function that traverses the content of the current object. It reads decorators and fills exportResultManifest entries and flex changes.
780
+ *
720
781
  * @param {TransferParameterTypeV4} transferParameters - list of parameters passed from API
721
782
  * @param {{ [key: string]: any }} configObject - current object to traverse
722
783
  * @param {string[]} parentIds - array of collected parent ids
@@ -766,9 +827,11 @@ function transferManifestEntriesAndFlexChange(transferParameters, configObject,
766
827
  }
767
828
  }
768
829
  /**
769
- * Instantiates the export classes for a single object page section
830
+ * Instantiates the export classes for a single object page section.
831
+ *
770
832
  * @param objectPageConfig - the given object page configuration
771
833
  * @param sectionId - section identificator to add class
834
+ * @param factory - The metadata factory used to create instances of export classes.
772
835
  */
773
836
  function getClassesForSingleSection(objectPageConfig, sectionId, factory) {
774
837
  const customSections = objectPageConfig.sections;
@@ -777,8 +840,10 @@ function getClassesForSingleSection(objectPageConfig, sectionId, factory) {
777
840
  }
778
841
  }
779
842
  /**
780
- * Recursive sub-function for handling subsections
843
+ * Recursive sub-function for handling subsections.
844
+ *
781
845
  * @param section - Object page section in config
846
+ * @param factory - The metadata factory used to create instances of export classes.
782
847
  */
783
848
  function getSubsectionClasses(section, factory) {
784
849
  if (section['subsections']) {
@@ -791,9 +856,11 @@ function getSubsectionClasses(section, factory) {
791
856
  }
792
857
  }
793
858
  /**
794
- * Instantiates the export classes for the object page section
859
+ * Instantiates the export classes for the object page section.
860
+ *
795
861
  * @param objectPageConfig - the given object page configuration
796
862
  * @param objectPage - the overall object page export class where the sections shall be included
863
+ * @param factory - The metadata factory used to create instances of export classes.
797
864
  */
798
865
  function getExportClassesForSections(objectPageConfig, objectPage, factory) {
799
866
  let section;
@@ -804,7 +871,8 @@ function getExportClassesForSections(objectPageConfig, objectPage, factory) {
804
871
  }
805
872
  }
806
873
  /**
807
- * Calculates the baseId
874
+ * Calculates the baseId.
875
+ *
808
876
  * @param {v4.ListReportConfigV4 | v4.ObjectPageConfigV4} config - content of the config file
809
877
  * @param {ExportListReportV4Parameters | ExportObjectPageV4Parameters} exportParameters - all API parameters needed for the export
810
878
  * @returns the baseId for changes
@@ -814,10 +882,12 @@ function calculateBaseId(config, exportParameters) {
814
882
  return `${exportParameters.appId}::${pageLayoutInformation.id}::${exportParameters.page.name}--`;
815
883
  }
816
884
  /**
817
- * Run through the given ObjectPage config and return respective exportResultManifest entry and flex changes
885
+ * Run through the given ObjectPage config and return respective exportResultManifest entry and flex changes.
886
+ *
818
887
  * @param {ExportObjectPageV4Parameters} exportParameters - all API parameters needed for the export
819
888
  * @param {UI5Version} ui5Version - SAP UI5 version
820
889
  * @param {boolean} deletionRequest - if set to true, any manifest setting specified by entityPath gets deleted even if it comprises any unknown property
890
+ * @returns ExportResults - The export result comprises the enhanced manifest as well as a list of flex changes.
821
891
  */
822
892
  const exportObjectPage = (exportParameters, ui5Version, deletionRequest = false) => {
823
893
  const exportResults = prepareDefaultExportResult(exportParameters.manifest);
@@ -852,14 +922,16 @@ const exportObjectPage = (exportParameters, ui5Version, deletionRequest = false)
852
922
  return exportResults;
853
923
  };
854
924
  /**
855
- * Run through the given List Page (LR or ALP) config and return respective exportResultManifest entry and flex changes
925
+ * Run through the given List Page (LR or ALP) config and return respective exportResultManifest entry and flex changes.
926
+ *
856
927
  * @param {ExportListReportV4Parameters} exportParameters - all API parameters needed for the export
857
928
  * @param {Factory} factory - metadata factory
858
929
  * @param {v4.ListReportConfigV4} config - content of the config file, filled into a factory class for metadata access
859
930
  * @param {PageTypeV4} pageType - Page type (enum value)
860
931
  * @param {UI5Version} ui5Version - SAP UI5 version
861
- * @param {boolean} deletionRequest - if set to true, any manifest setting specified by entityPath gets deleted even if it comprises any unknown property
862
932
  * @param {TemplateType} templateType - Template type (enum value)
933
+ * @param {boolean} deletionRequest - if set to true, any manifest setting specified by entityPath gets deleted even if it comprises any unknown property
934
+ * @returns ExportResults - The export result comprises the enhanced manifest as well as a list of flex changes.
863
935
  */
864
936
  const exportListPage = (exportParameters, factory, config, pageType, ui5Version, templateType, deletionRequest = false) => {
865
937
  const exportResults = prepareDefaultExportResult(exportParameters.manifest);
@@ -905,7 +977,8 @@ const exportListPage = (exportParameters, factory, config, pageType, ui5Version,
905
977
  return exportResults;
906
978
  };
907
979
  /**
908
- * Run through the given ListReport config and return respective exportResultManifest entry and flex changes
980
+ * Run through the given ListReport config and return respective exportResultManifest entry and flex changes.
981
+ *
909
982
  * @param {ExportListReportV4Parameters} exportParameters - all API parameters needed for the export
910
983
  * @param {UI5Version} ui5Version - SAP UI5 version
911
984
  * @param {TemplateType} templateType - Template type (enum value)
@@ -918,7 +991,8 @@ const exportListReportPage = (exportParameters, ui5Version, templateType, deleti
918
991
  return exportListPage(exportParameters, factory, listReport, ux_specification_types_1.PageTypeV4.ListReport, ui5Version, templateType, deletionRequest);
919
992
  };
920
993
  /**
921
- * Run through the given Analytical List Page config and return respective exportResultManifest entry and flex changes
994
+ * Run through the given Analytical List Page config and return respective exportResultManifest entry and flex changes.
995
+ *
922
996
  * @param {ExportAnalyticalListPageV4Parameters} exportParameters - all API parameters needed for the export
923
997
  * @param {UI5Version} ui5Version - SAP UI5 version
924
998
  * @param {boolean} deletionRequest - if set to true, any manifest setting specified by entityPath gets deleted even if it comprises any unknown property
@@ -929,6 +1003,7 @@ const exportAnalyticalListPage = (exportParameters, ui5Version, deletionRequest
929
1003
  };
930
1004
  /**
931
1005
  * Method applies passed export rule for passed property and path.
1006
+ *
932
1007
  * @param rule - sync rule to apply
933
1008
  * @param path - path in manifest which shold be updated by export
934
1009
  * @param key - property name/key
@@ -959,12 +1034,12 @@ const applyExportRule = (rule, path, key, application, manifest, appSchema) => {
959
1034
  }
960
1035
  };
961
1036
  /**
962
- * API for the export of a V4 app configuration
963
- * Export means the transfer of the properties and values of the given config to manifest entries or flex changes
1037
+ * API for the export of a V4 app configuration.
1038
+ * Export means the transfer of the properties and values of the given config to manifest entries or flex changes.
1039
+ *
964
1040
  * @param application - V4 application (app.json config file)
965
1041
  * @param manifest - Manifest of the given app
966
1042
  * @param appSchema - App schema
967
- *
968
1043
  * @returns ExportResults = object comprising the updated manifest and a list of flex changes
969
1044
  */
970
1045
  const exportApplicationV4 = (application, manifest, appSchema) => {
@@ -998,8 +1073,9 @@ const exportApplicationV4 = (application, manifest, appSchema) => {
998
1073
  return exportResults;
999
1074
  };
1000
1075
  /**
1001
- * General API for the export of a V4 config page
1002
- * Export means the transfer of the properties and values of the given config to manifest entries or flex changes
1076
+ * General API for the export of a V4 config page.
1077
+ * Export means the transfer of the properties and values of the given config to manifest entries or flex changes.
1078
+ *
1003
1079
  * @param exportParametersV4 - list of parameters for the export; the list varies for the different schema types
1004
1080
  * @param ui5Version - the minUi5Version of the app
1005
1081
  * @returns ExportResults = object comprising the updated manifest and a list of flex changes
@@ -1025,6 +1101,7 @@ const exportPageV4 = (exportParametersV4, ui5Version) => {
1025
1101
  exports.exportPageV4 = exportPageV4;
1026
1102
  /**
1027
1103
  * Run through the given CustomPage config and return respective export result.
1104
+ *
1028
1105
  * @param exportParameters - all API parameters needed for the export
1029
1106
  * @returns Export result.
1030
1107
  */
@@ -1041,8 +1118,9 @@ const exportCustomPage = (exportParameters) => {
1041
1118
  return exportResults;
1042
1119
  };
1043
1120
  /**
1044
- * Exports the config change of a single entity of the config, as indicated by an entityPath
1045
- * Export means the transfer of the properties and values of the given config to manifest entries or flex changes
1121
+ * Exports the config change of a single entity of the config, as indicated by an entityPath.
1122
+ * Export means the transfer of the properties and values of the given config to manifest entries or flex changes.
1123
+ *
1046
1124
  * @param exportParametersV4 - list of parameters for the export; the list varies for the different schema types
1047
1125
  * @param ui5Version - the minUi5Version of the app
1048
1126
  * @param deletionRequest - if set to true, any manifest setting specified by entityPath gets deleted even if it comprises any unknown property