@ui5/mcp-server 0.1.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 (221) hide show
  1. package/CHANGELOG.md +9 -0
  2. package/LICENSE +201 -0
  3. package/LICENSES/Apache-2.0.txt +73 -0
  4. package/README.md +131 -0
  5. package/bin/ui5mcp.js +2 -0
  6. package/lib/Context.d.ts +28 -0
  7. package/lib/Context.js +71 -0
  8. package/lib/Context.js.map +1 -0
  9. package/lib/api.d.ts +3 -0
  10. package/lib/api.js +3 -0
  11. package/lib/api.js.map +1 -0
  12. package/lib/cli.d.ts +1 -0
  13. package/lib/cli.js +12 -0
  14. package/lib/cli.js.map +1 -0
  15. package/lib/registerTools.d.ts +133 -0
  16. package/lib/registerTools.js +59 -0
  17. package/lib/registerTools.js.map +1 -0
  18. package/lib/resources/documentation/getDocumentation.d.ts +18 -0
  19. package/lib/resources/documentation/getDocumentation.js +70 -0
  20. package/lib/resources/documentation/getDocumentation.js.map +1 -0
  21. package/lib/server.d.ts +10 -0
  22. package/lib/server.js +113 -0
  23. package/lib/server.js.map +1 -0
  24. package/lib/tools/create_ui5_app/ODataMetadata.d.ts +55 -0
  25. package/lib/tools/create_ui5_app/ODataMetadata.js +99 -0
  26. package/lib/tools/create_ui5_app/ODataMetadata.js.map +1 -0
  27. package/lib/tools/create_ui5_app/createSuccessMessage.d.ts +13 -0
  28. package/lib/tools/create_ui5_app/createSuccessMessage.js +45 -0
  29. package/lib/tools/create_ui5_app/createSuccessMessage.js.map +1 -0
  30. package/lib/tools/create_ui5_app/create_ui5_app.d.ts +8 -0
  31. package/lib/tools/create_ui5_app/create_ui5_app.js +273 -0
  32. package/lib/tools/create_ui5_app/create_ui5_app.js.map +1 -0
  33. package/lib/tools/create_ui5_app/index.d.ts +3 -0
  34. package/lib/tools/create_ui5_app/index.js +58 -0
  35. package/lib/tools/create_ui5_app/index.js.map +1 -0
  36. package/lib/tools/create_ui5_app/isValidUrl.d.ts +16 -0
  37. package/lib/tools/create_ui5_app/isValidUrl.js +59 -0
  38. package/lib/tools/create_ui5_app/isValidUrl.js.map +1 -0
  39. package/lib/tools/create_ui5_app/schema.d.ts +135 -0
  40. package/lib/tools/create_ui5_app/schema.js +67 -0
  41. package/lib/tools/create_ui5_app/schema.js.map +1 -0
  42. package/lib/tools/create_ui5_app/templateProcessor.d.ts +67 -0
  43. package/lib/tools/create_ui5_app/templateProcessor.js +59 -0
  44. package/lib/tools/create_ui5_app/templateProcessor.js.map +1 -0
  45. package/lib/tools/create_ui5_app/ui5Version.d.ts +2 -0
  46. package/lib/tools/create_ui5_app/ui5Version.js +6 -0
  47. package/lib/tools/create_ui5_app/ui5Version.js.map +1 -0
  48. package/lib/tools/get_api_reference/createUriForSymbol.d.ts +2 -0
  49. package/lib/tools/get_api_reference/createUriForSymbol.js +49 -0
  50. package/lib/tools/get_api_reference/createUriForSymbol.js.map +1 -0
  51. package/lib/tools/get_api_reference/getApiReference.d.ts +10 -0
  52. package/lib/tools/get_api_reference/getApiReference.js +51 -0
  53. package/lib/tools/get_api_reference/getApiReference.js.map +1 -0
  54. package/lib/tools/get_api_reference/index.d.ts +3 -0
  55. package/lib/tools/get_api_reference/index.js +38 -0
  56. package/lib/tools/get_api_reference/index.js.map +1 -0
  57. package/lib/tools/get_api_reference/lib/ApiReferenceProvider.d.ts +85 -0
  58. package/lib/tools/get_api_reference/lib/ApiReferenceProvider.js +452 -0
  59. package/lib/tools/get_api_reference/lib/ApiReferenceProvider.js.map +1 -0
  60. package/lib/tools/get_api_reference/lib/apiReferenceResources.d.ts +18 -0
  61. package/lib/tools/get_api_reference/lib/apiReferenceResources.js +138 -0
  62. package/lib/tools/get_api_reference/lib/apiReferenceResources.js.map +1 -0
  63. package/lib/tools/get_api_reference/lib/formatSymbol.d.ts +24 -0
  64. package/lib/tools/get_api_reference/lib/formatSymbol.js +109 -0
  65. package/lib/tools/get_api_reference/lib/formatSymbol.js.map +1 -0
  66. package/lib/tools/get_api_reference/schema.d.ts +16 -0
  67. package/lib/tools/get_api_reference/schema.js +12 -0
  68. package/lib/tools/get_api_reference/schema.js.map +1 -0
  69. package/lib/tools/get_guidelines/guidelines.d.ts +1 -0
  70. package/lib/tools/get_guidelines/guidelines.js +6 -0
  71. package/lib/tools/get_guidelines/guidelines.js.map +1 -0
  72. package/lib/tools/get_guidelines/index.d.ts +3 -0
  73. package/lib/tools/get_guidelines/index.js +30 -0
  74. package/lib/tools/get_guidelines/index.js.map +1 -0
  75. package/lib/tools/get_project_info/getProjectInfo.d.ts +2 -0
  76. package/lib/tools/get_project_info/getProjectInfo.js +205 -0
  77. package/lib/tools/get_project_info/getProjectInfo.js.map +1 -0
  78. package/lib/tools/get_project_info/index.d.ts +3 -0
  79. package/lib/tools/get_project_info/index.js +28 -0
  80. package/lib/tools/get_project_info/index.js.map +1 -0
  81. package/lib/tools/get_project_info/schema.d.ts +87 -0
  82. package/lib/tools/get_project_info/schema.js +28 -0
  83. package/lib/tools/get_project_info/schema.js.map +1 -0
  84. package/lib/tools/get_version_info/getVersionInfo.d.ts +8 -0
  85. package/lib/tools/get_version_info/getVersionInfo.js +41 -0
  86. package/lib/tools/get_version_info/getVersionInfo.js.map +1 -0
  87. package/lib/tools/get_version_info/index.d.ts +9 -0
  88. package/lib/tools/get_version_info/index.js +33 -0
  89. package/lib/tools/get_version_info/index.js.map +1 -0
  90. package/lib/tools/get_version_info/schema.d.ts +66 -0
  91. package/lib/tools/get_version_info/schema.js +16 -0
  92. package/lib/tools/get_version_info/schema.js.map +1 -0
  93. package/lib/tools/get_version_info/types.d.ts +5 -0
  94. package/lib/tools/get_version_info/types.js +2 -0
  95. package/lib/tools/get_version_info/types.js.map +1 -0
  96. package/lib/tools/run_ui5_linter/index.d.ts +3 -0
  97. package/lib/tools/run_ui5_linter/index.js +86 -0
  98. package/lib/tools/run_ui5_linter/index.js.map +1 -0
  99. package/lib/tools/run_ui5_linter/migrationGuides.d.ts +6 -0
  100. package/lib/tools/run_ui5_linter/migrationGuides.js +88 -0
  101. package/lib/tools/run_ui5_linter/migrationGuides.js.map +1 -0
  102. package/lib/tools/run_ui5_linter/resultContext.d.ts +3 -0
  103. package/lib/tools/run_ui5_linter/resultContext.js +236 -0
  104. package/lib/tools/run_ui5_linter/resultContext.js.map +1 -0
  105. package/lib/tools/run_ui5_linter/runUi5Linter.d.ts +2 -0
  106. package/lib/tools/run_ui5_linter/runUi5Linter.js +72 -0
  107. package/lib/tools/run_ui5_linter/runUi5Linter.js.map +1 -0
  108. package/lib/tools/run_ui5_linter/schema.d.ts +340 -0
  109. package/lib/tools/run_ui5_linter/schema.js +55 -0
  110. package/lib/tools/run_ui5_linter/schema.js.map +1 -0
  111. package/lib/utils/cdnHelper.d.ts +9 -0
  112. package/lib/utils/cdnHelper.js +50 -0
  113. package/lib/utils/cdnHelper.js.map +1 -0
  114. package/lib/utils/dataStorageHelper.d.ts +2 -0
  115. package/lib/utils/dataStorageHelper.js +65 -0
  116. package/lib/utils/dataStorageHelper.js.map +1 -0
  117. package/lib/utils/ui5Framework.d.ts +4 -0
  118. package/lib/utils/ui5Framework.js +6 -0
  119. package/lib/utils/ui5Framework.js.map +1 -0
  120. package/lib/utils.d.ts +10 -0
  121. package/lib/utils.js +87 -0
  122. package/lib/utils.js.map +1 -0
  123. package/npm-shrinkwrap.json +7880 -0
  124. package/package.json +121 -0
  125. package/resources/docs/1.136.7/00737d6c1b864dc3ab72ef56611491c4.md +155 -0
  126. package/resources/docs/1.136.7/0187ea5e2eff4166b0453b9dcc8fc64f.md +164 -0
  127. package/resources/docs/1.136.7/032be2cb2e1d4115af20862673bedcdb.md +12 -0
  128. package/resources/docs/1.136.7/28fcd55b04654977b63dacbee0552712.md +317 -0
  129. package/resources/docs/1.136.7/676b636446c94eada183b1218a824717.md +135 -0
  130. package/resources/docs/1.136.7/a87ca843bcee469f82a9072927a7dcdb.md +355 -0
  131. package/resources/docs/1.136.7/b0fb4de7364f4bcbb053a99aa645affe.md +126 -0
  132. package/resources/docs/1.136.7/fe1a6dba940e479fb7c3bc753f92b28c.md +670 -0
  133. package/resources/docs/1.136.7/index.json +58 -0
  134. package/resources/guidelines.md +104 -0
  135. package/resources/migrationGuides/deprecated-controller-factory.md +116 -0
  136. package/resources/migrationGuides/deprecated-getLibraryResourceBundle.md +62 -0
  137. package/resources/migrationGuides/deprecated-jquery-sap-require.md +141 -0
  138. package/resources/migrationGuides/deprecated-messagePage.md +162 -0
  139. package/resources/migrationGuides/deprecated-table-table-property.md +154 -0
  140. package/resources/template-js/LICENSE +201 -0
  141. package/resources/template-js/README.md +87 -0
  142. package/resources/template-js/_.editorconfig +22 -0
  143. package/resources/template-js/_.gitignore +17 -0
  144. package/resources/template-js/eslint.config.js +68 -0
  145. package/resources/template-js/karma-ci-cov.conf.js +20 -0
  146. package/resources/template-js/karma-ci.conf.js +9 -0
  147. package/resources/template-js/karma.conf.js +9 -0
  148. package/resources/template-js/package.json +34 -0
  149. package/resources/template-js/ui5-dist.yaml +18 -0
  150. package/resources/template-js/ui5.yaml +24 -0
  151. package/resources/template-js/webapp/Component.js +41 -0
  152. package/resources/template-js/webapp/controller/App.controller.js +10 -0
  153. package/resources/template-js/webapp/controller/BaseController.js +67 -0
  154. package/resources/template-js/webapp/controller/Main.controller.js +14 -0
  155. package/resources/template-js/webapp/i18n/i18n.properties +3 -0
  156. package/resources/template-js/webapp/i18n/i18n_en.properties +3 -0
  157. package/resources/template-js/webapp/index-cdn.html +34 -0
  158. package/resources/template-js/webapp/index.html +34 -0
  159. package/resources/template-js/webapp/manifest.json +103 -0
  160. package/resources/template-js/webapp/model/formatter.js +9 -0
  161. package/resources/template-js/webapp/model/models.js +11 -0
  162. package/resources/template-js/webapp/test/Test.qunit.html +16 -0
  163. package/resources/template-js/webapp/test/integration/HelloJourney.js +85 -0
  164. package/resources/template-js/webapp/test/integration/opaTests.qunit.js +1 -0
  165. package/resources/template-js/webapp/test/integration/pages/Main.js +112 -0
  166. package/resources/template-js/webapp/test/testsuite.qunit.html +18 -0
  167. package/resources/template-js/webapp/test/testsuite.qunit.js +37 -0
  168. package/resources/template-js/webapp/test/unit/controller/Main.qunit.js +11 -0
  169. package/resources/template-js/webapp/test/unit/unitTests.qunit.js +1 -0
  170. package/resources/template-js/webapp/test-lt1_124/integration/HelloJourney.js +85 -0
  171. package/resources/template-js/webapp/test-lt1_124/integration/opaTests.qunit.html +31 -0
  172. package/resources/template-js/webapp/test-lt1_124/integration/opaTests.qunit.js +11 -0
  173. package/resources/template-js/webapp/test-lt1_124/integration/pages/Main.js +112 -0
  174. package/resources/template-js/webapp/test-lt1_124/testsuite.qunit.html +13 -0
  175. package/resources/template-js/webapp/test-lt1_124/testsuite.qunit.js +9 -0
  176. package/resources/template-js/webapp/test-lt1_124/unit/controller/Main.qunit.js +11 -0
  177. package/resources/template-js/webapp/test-lt1_124/unit/unitTests.qunit.html +30 -0
  178. package/resources/template-js/webapp/test-lt1_124/unit/unitTests.qunit.js +12 -0
  179. package/resources/template-js/webapp/view/App.view.xml +9 -0
  180. package/resources/template-js/webapp/view/Main.view.xml +90 -0
  181. package/resources/template-ts/LICENSE +201 -0
  182. package/resources/template-ts/README.md +101 -0
  183. package/resources/template-ts/_.editorconfig +23 -0
  184. package/resources/template-ts/_.gitignore +18 -0
  185. package/resources/template-ts/_.nycrc.json +7 -0
  186. package/resources/template-ts/_tsconfig.json +21 -0
  187. package/resources/template-ts/eslint.config.mjs +27 -0
  188. package/resources/template-ts/package.json +40 -0
  189. package/resources/template-ts/ui5-coverage.yaml +40 -0
  190. package/resources/template-ts/ui5-dist.yaml +18 -0
  191. package/resources/template-ts/ui5.yaml +27 -0
  192. package/resources/template-ts/webapp/Component.ts +49 -0
  193. package/resources/template-ts/webapp/controller/App.controller.ts +11 -0
  194. package/resources/template-ts/webapp/controller/BaseController.ts +83 -0
  195. package/resources/template-ts/webapp/controller/Main.controller.ts +19 -0
  196. package/resources/template-ts/webapp/i18n/i18n.properties +3 -0
  197. package/resources/template-ts/webapp/i18n/i18n_en.properties +3 -0
  198. package/resources/template-ts/webapp/index-cdn.html +35 -0
  199. package/resources/template-ts/webapp/index.html +35 -0
  200. package/resources/template-ts/webapp/manifest.json +105 -0
  201. package/resources/template-ts/webapp/model/formatter.ts +5 -0
  202. package/resources/template-ts/webapp/model/models.ts +15 -0
  203. package/resources/template-ts/webapp/test/Test.qunit.html +16 -0
  204. package/resources/template-ts/webapp/test/integration/HelloJourney.ts +84 -0
  205. package/resources/template-ts/webapp/test/integration/opaTests.qunit.ts +2 -0
  206. package/resources/template-ts/webapp/test/integration/pages/MainPage.ts +112 -0
  207. package/resources/template-ts/webapp/test/testsuite.qunit.html +18 -0
  208. package/resources/template-ts/webapp/test/testsuite.qunit.ts +33 -0
  209. package/resources/template-ts/webapp/test/unit/controller/Main.qunit.ts +8 -0
  210. package/resources/template-ts/webapp/test/unit/unitTests.qunit.ts +2 -0
  211. package/resources/template-ts/webapp/test-lt1_124/integration/HelloJourney.ts +86 -0
  212. package/resources/template-ts/webapp/test-lt1_124/integration/opaTests.qunit.html +34 -0
  213. package/resources/template-ts/webapp/test-lt1_124/integration/opaTests.qunit.ts +8 -0
  214. package/resources/template-ts/webapp/test-lt1_124/integration/pages/MainPage.ts +112 -0
  215. package/resources/template-ts/webapp/test-lt1_124/testsuite.qunit.html +13 -0
  216. package/resources/template-ts/webapp/test-lt1_124/testsuite.qunit.ts +9 -0
  217. package/resources/template-ts/webapp/test-lt1_124/unit/controller/Main.qunit.ts +8 -0
  218. package/resources/template-ts/webapp/test-lt1_124/unit/unitTests.qunit.html +37 -0
  219. package/resources/template-ts/webapp/test-lt1_124/unit/unitTests.qunit.ts +8 -0
  220. package/resources/template-ts/webapp/view/App.view.xml +9 -0
  221. package/resources/template-ts/webapp/view/Main.view.xml +90 -0
@@ -0,0 +1,154 @@
1
+ # Guide for Migrating Deprecated `sap/ui/table/Table` Row Properties
2
+
3
+ > *This guide provides instructions for AI-based development tools to refactor the deprecated row-related properties of the `sap.ui.table.Table` control. The migration involves replacing these properties with the modern `rowMode` aggregation.*
4
+
5
+ ## 1. Core Concept: From Properties to an Aggregation
6
+
7
+ The legacy approach used a flat list of properties on the `sap.ui.table.Table` control itself (e.g., `visibleRowCount`, `visibleRowCountMode`, `rowHeight`). This is deprecated in favor of a more structured and powerful `rowMode` aggregation.
8
+
9
+ The migration involves two main actions:
10
+ 1. **Removing** the set of old, deprecated properties.
11
+ 2. **Adding** a single `<rowMode>` aggregation that contains a specific `RowMode` object (`Fixed`, `Interactive`, or `Auto`). The properties that were previously on the table are now set on this new `RowMode` object.
12
+
13
+ Important: **do not attempt to migrate `sap.ui.table.Table` to the newer `sap.m.Table` control**, as this is not a direct replacement and might break existing functionality and extensions within the application.
14
+
15
+ ## 2. Pre-Migration Analysis & Rules
16
+
17
+ To ensure a safe and accurate migration, the agent **must** perform these checks before modifying any code.
18
+
19
+ 1. Detect Dynamic Property Setting (Critical Safety Check)
20
+ * **Condition:** One of the properties set in the source does not exist on the picked RowMode class. This might be an indicator for dynamic switching of the row mode at runtime, e.g. in the relevant controller class.
21
+ * **Action:** **Abort migration for this table instance.** Migrating this automatically is unsafe. Instead inform the developer about the inconsistency and suggest a manual review of the view and controller code.
22
+
23
+ ## 3. Property Mapping
24
+
25
+ The following table maps the deprecated table properties to their new counterparts on the `RowMode` object.
26
+
27
+ | Deprecated Property on `Table` | New Property on `RowMode` Object | Notes |
28
+ | ------------------------------- | -------------------------------- | -------------------------------------- |
29
+ | `visibleRowCountMode` | (Determines the `RowMode` class) | `Fixed` -> `rowmodes.Fixed`, etc. |
30
+ | `visibleRowCount` | `rowCount` | Used only in `Fixed` and `Interactive` mode |
31
+ | `minAutoRowCount` | `minRowCount` | Used only in `Auto` mode |
32
+ | `rowHeight` | `rowContentHeight` | Name change for clarity |
33
+ | `fixedRowCount` | `fixedTopRowCount` | Name change (`Top` added) |
34
+ | `fixedBottomRowCount` | `fixedBottomRowCount` | No change |
35
+
36
+
37
+ ## 4. Migration Scenario 1: XML Views
38
+
39
+ This is the most common scenario, where the table is defined declaratively.
40
+
41
+ ### Migration Steps
42
+
43
+ 1. **Add XML Namespace:** In the root `mvc:View` tag, ensure the namespace for table row modes is declared. If it doesn't exist, add `xmlns:rowmodes="sap.ui.table.rowmodes"`.
44
+ 2. **Remove Deprecated Properties:** Delete all properties from the `<Table>` element that are listed in the mapping table above (e.g., `visibleRowCountMode`, `visibleRowCount`, `rowHeight`, etc.).
45
+ 3. **Create `<rowMode>` Aggregation:** Inside the `<Table>` element, add a `<rowMode>` aggregation tag.
46
+ 4. **Instantiate Correct `RowMode`:** Inside `<rowMode>`, add the `RowMode` element that corresponds to the old `visibleRowCountMode` value:
47
+ * `"Fixed"` becomes `<rowmodes:Fixed />`
48
+ * `"Interactive"` becomes `<rowmodes:Interactive />`
49
+ * `"Auto"` becomes `<rowmodes:Auto />`
50
+ 5. **Apply Migrated Properties:** Add the new properties to the `RowMode` element (`<rowmodes:Fixed>`, etc.) according to the mapping table.
51
+
52
+ ### Example (RowMode: Fixed)
53
+
54
+ **Before:**
55
+
56
+ ```xml
57
+ <Table
58
+ selectionMode="MultiToggle"
59
+ rows="{/ProductCollection}"
60
+ visibleRowCountMode="Fixed"
61
+ visibleRowCount="5"
62
+ fixedRowCount="1"
63
+ fixedBottomRowCount="2"
64
+ rowHeight="30">
65
+ ...
66
+ </Table>
67
+ ```
68
+
69
+ **After:**
70
+
71
+ ```xml
72
+ <!-- In mvc:View -->
73
+ xmlns:rowmodes="sap.ui.table.rowmodes"
74
+
75
+ <!-- ... -->
76
+
77
+ <Table
78
+ selectionMode="MultiToggle"
79
+ rows="{/ProductCollection}">
80
+ <rowMode>
81
+ <rowmodes:Fixed rowCount="5" fixedTopRowCount="1" fixedBottomRowCount="2" rowContentHeight="30"/>
82
+ </rowMode>
83
+ ...
84
+ </Table>
85
+ ```
86
+
87
+ ---
88
+
89
+ ## 5. Migration Scenario 2: JavaScript Instantiation
90
+
91
+ This scenario applies if the table is created programmatically in a controller or other JavaScript module.
92
+
93
+ ### Migration Steps
94
+
95
+ 1. **Identify Dependencies:** The agent must add the required `RowMode` class to the `sap.ui.define` dependency array. For example, if migrating to `Fixed` mode, add `"sap/ui/table/rowmodes/Fixed"`.
96
+ 2. **Remove Deprecated Setters:** Find and delete any calls that set the deprecated properties (e.g., `oTable.setVisibleRowCount(...)`, `oTable.setRowHeight(...)`).
97
+ 3. **Instantiate `RowMode` Object:** Create a new instance of the appropriate `RowMode` class, passing the migrated properties to its constructor.
98
+ 4. **Set `rowMode` Aggregation:** Set the newly created `RowMode` object in the constructor call of the table. Alternatively use the `setRowMode` method to apply the object after the table instance has been created.
99
+
100
+ ### Example (RowMode: Interactive)
101
+
102
+ **Before:**
103
+
104
+ ```javascript
105
+ sap.ui.define([
106
+ "sap/ui/core/mvc/Controller",
107
+ "sap/ui/table/Table",
108
+ "sap/ui/table/Column"
109
+ ], (Controller, Table, Column) => {
110
+ "use strict";
111
+ return Controller.extend("my.app.Controller", {
112
+ onInit() {
113
+ const oTable = new Table({
114
+ visibleRowCountMode: "Interactive", // Deprecated
115
+ visibleRowCount: 10, // Deprecated
116
+ rowHeight: 25 // Deprecated
117
+ });
118
+ // ... more table setup
119
+ this.getView().addContent(oTable);
120
+ }
121
+ });
122
+ });
123
+ ```
124
+
125
+ **After:**
126
+
127
+ ```javascript
128
+ sap.ui.define([
129
+ "sap/ui/core/mvc/Controller",
130
+ "sap/ui/table/Table",
131
+ "sap/ui/table/Column",
132
+ "sap/ui/table/rowmodes/Interactive" // <-- 1. Add dependency
133
+ ], (Controller, Table, Column, InteractiveRowMode) => { // <-- Pass as argument
134
+ "use strict";
135
+ return Controller.extend("my.app.Controller", {
136
+ onInit() {
137
+ // 3. Instantiate RowMode object with new properties
138
+ const oRowMode = new InteractiveRowMode({
139
+ rowCount: 10,
140
+ rowContentHeight: 25
141
+ });
142
+
143
+ const oTable = new Table({
144
+ // 2. Deprecated properties are removed
145
+ rowMode: oRowMode, // <-- 4. Set the aggregation
146
+ });
147
+
148
+
149
+ // ... more table setup
150
+ this.getView().addContent(oTable);
151
+ }
152
+ });
153
+ });
154
+ ```
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,87 @@
1
+ # UI5 Application <%= namespace %>
2
+
3
+ Insert the purpose of this project and some interesting info here...
4
+
5
+ ## Description
6
+
7
+ This app demonstrates a setup for developing UI5 applications.
8
+
9
+ ## Requirements
10
+
11
+ Either [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/) for dependency management.
12
+
13
+ ## Preparation
14
+
15
+ Use `npm` (or `yarn`) to install the dependencies:
16
+
17
+ ```sh
18
+ npm install
19
+ ```
20
+
21
+ (To use yarn, just do `yarn` instead.)
22
+
23
+ ## Run the App
24
+
25
+ Execute the following command to run the app locally for development in watch mode (the browser reloads the app automatically when there are changes in the source code):
26
+
27
+ ```sh
28
+ npm start
29
+ ```
30
+
31
+ As shown in the terminal after executing this command, the app is then running on http://localhost:8080/index.html. A browser window with this URL should automatically open.
32
+
33
+ (When using yarn, do `yarn start` instead.)
34
+
35
+ ## Build the App
36
+
37
+ ### Unoptimized (but quick)
38
+
39
+ Execute the following command to build the project and get an app that can be deployed:
40
+
41
+ ```sh
42
+ npm run build
43
+ ```
44
+
45
+ The result is placed into the `dist` folder. To start the generated package, just run
46
+
47
+ ```sh
48
+ npm run start:dist
49
+ ```
50
+
51
+ Note that `index.html` still loads the UI5 framework from the relative URL `resources/...`, which does not physically exist, but is only provided dynamically by the UI5 tooling. So for an actual deployment you should change this URL to either [the CDN](https://sdk.openui5.org/#/topic/2d3eb2f322ea4a82983c1c62a33ec4ae) or your local deployment of UI5.
52
+
53
+ (When using yarn, do `yarn build` and `yarn start:dist` instead.)
54
+
55
+ ### Optimized
56
+
57
+ For an optimized self-contained build (takes longer because the UI5 resources are built, too), do:
58
+
59
+ ```sh
60
+ npm run build:opt
61
+ ```
62
+
63
+ To start the generated package, again just run:
64
+
65
+ ```sh
66
+ npm run start:dist
67
+ ```
68
+
69
+ In this case, all UI5 framework resources are also available within the `dist` folder, so the folder can be deployed as-is to any static web server, without changing the bootstrap URL.
70
+
71
+ With the self-contained build, the bootstrap URL in `index.html` has already been modified to load the newly created `sap-ui-custom.js` for bootstrapping, which contains all app resources as well as all needed UI5 JavaScript resources. Most UI5 resources inside the `dist` folder are for this reason actually **not** needed to run the app. Only the non-JS-files, like translation texts and CSS files, are used and must also be deployed. (Only when for some reason JS files are missing from the optimized self-contained bundle, they are also loaded separately.)
72
+
73
+ (When using yarn, do `yarn build:opt` and `yarn start:dist` instead.)
74
+
75
+ ## Check the Code
76
+
77
+ To lint the code, do:
78
+
79
+ ```sh
80
+ npm run lint
81
+ ```
82
+
83
+ (Again, when using yarn, do `yarn lint` instead.)
84
+
85
+ ## License
86
+
87
+ This project is licensed under the Apache Software License, version 2.0 except as noted otherwise in the [LICENSE](LICENSE) file.
@@ -0,0 +1,22 @@
1
+ # EditorConfig helps developers define and maintain consistent
2
+ # coding styles between different editors and IDEs
3
+ # editorconfig.org
4
+
5
+ root = true
6
+
7
+ [*]
8
+ # We recommend you to keep these unchanged
9
+ end_of_line = lf
10
+ charset = utf-8
11
+ trim_trailing_whitespace = true
12
+ insert_final_newline = true
13
+
14
+ # Change these settings to your own preference
15
+ indent_style = tab
16
+
17
+ [*.{yaml,yml,md,json,xml,properties}]
18
+ indent_size = 2
19
+ indent_style = space
20
+
21
+ [*.md]
22
+ trim_trailing_whitespace = false
@@ -0,0 +1,17 @@
1
+ # build results
2
+ dist
3
+ coverage
4
+
5
+ # Logs
6
+ logs
7
+ *.log
8
+ npm-debug.log*
9
+ yarn-debug.log*
10
+ yarn-error.log*
11
+
12
+ # Dependency directories
13
+ node_modules/
14
+
15
+ .DS_Store
16
+ .env
17
+ tmp/
@@ -0,0 +1,68 @@
1
+ const globals = require("globals");
2
+ const js = require("@eslint/js");
3
+ const jsdoc = require("eslint-plugin-jsdoc");
4
+
5
+ module.exports = [
6
+ js.configs.recommended,
7
+ jsdoc.configs["flat/recommended"],
8
+ {
9
+ languageOptions: {
10
+ globals: {
11
+ ...globals.browser,
12
+ sap: "readonly"
13
+ },
14
+ ecmaVersion: 2023,
15
+ sourceType: "script"
16
+ },
17
+ rules: {
18
+ "brace-style": [
19
+ 2,
20
+ "1tbs",
21
+ {
22
+ allowSingleLine: true
23
+ }
24
+ ],
25
+ "consistent-this": 2,
26
+ "no-div-regex": 2,
27
+ "no-floating-decimal": 2,
28
+ "no-self-compare": 2,
29
+ "no-mixed-spaces-and-tabs": [2, true],
30
+ "no-nested-ternary": 2,
31
+ radix: 2,
32
+ "keyword-spacing": 2,
33
+ "space-unary-ops": 2,
34
+ "wrap-iife": [2, "any"],
35
+ camelcase: 1,
36
+ "consistent-return": 1,
37
+ "max-nested-callbacks": [1, 3],
38
+ "new-cap": 1,
39
+ "no-extra-boolean-cast": 1,
40
+ "no-lonely-if": 1,
41
+ "no-new": 1,
42
+ "no-new-wrappers": 1,
43
+ "no-redeclare": 1,
44
+ "no-unused-expressions": 1,
45
+ "no-use-before-define": [1, "nofunc"],
46
+ "no-warning-comments": 1,
47
+ strict: 1,
48
+ "default-case": 1,
49
+ "dot-notation": 0,
50
+ "eol-last": 0,
51
+ eqeqeq: 0,
52
+ "no-trailing-spaces": 0,
53
+ "no-underscore-dangle": 0,
54
+ quotes: 0,
55
+ "key-spacing": 0,
56
+ "comma-spacing": 0,
57
+ "no-multi-spaces": 0,
58
+ "no-shadow": 0,
59
+ "no-irregular-whitespace": 0,
60
+ "no-var": 2,
61
+ "no-const-assign": 2,
62
+ "prefer-const": 2
63
+ }
64
+ },
65
+ {
66
+ ignores: ["eslint.config.js", "webapp/test/e2e/**"]
67
+ }
68
+ ];
@@ -0,0 +1,20 @@
1
+ module.exports = function (config) {
2
+ "use strict";
3
+
4
+ require("./karma-ci.conf")(config);
5
+ config.set({
6
+ reporters: ["progress", "coverage"],
7
+ preprocessors: {
8
+ "webapp/**/*.js": ["coverage"]
9
+ },
10
+ coverageReporter: {
11
+ dir: "coverage",
12
+ reporters: [
13
+ { type: "html", subdir: "report-html" },
14
+ { type: "cobertura", subdir: ".", file: "cobertura.txt" },
15
+ { type: "lcovonly", subdir: ".", file: "report-lcovonly.txt" },
16
+ { type: "text-summary" }
17
+ ]
18
+ }
19
+ });
20
+ };
@@ -0,0 +1,9 @@
1
+ module.exports = function (config) {
2
+ "use strict";
3
+
4
+ require("./karma.conf")(config);
5
+ config.set({
6
+ browsers: ["ChromeHeadless"],
7
+ singleRun: true
8
+ });
9
+ };
@@ -0,0 +1,9 @@
1
+ // karma-ui5 usage: https://github.com/SAP/karma-ui5
2
+ module.exports = function (config) {
3
+ "use strict";
4
+
5
+ config.set({
6
+ frameworks: ["ui5"],
7
+ browsers: ["Chrome"]
8
+ });
9
+ };
@@ -0,0 +1,34 @@
1
+ {
2
+ "name": "<%= namespace %>",
3
+ "version": "1.0.0",
4
+ "description": "UI5 Application: <%= namespace %>",
5
+ "author": "<%= author %>",
6
+ "license": "Apache-2.0",
7
+ "scripts": {
8
+ "clean": "rimraf dist coverage",
9
+ "build": "ui5 build --clean-dest",
10
+ "build:opt": "ui5 build self-contained --clean-dest --all",
11
+ "start": "ui5 serve --port 8080 -o index.html",
12
+ "start-cdn": "ui5 serve --port 8080 -o index-cdn.html",
13
+ "start:dist": "npm start -- --config ui5-dist.yaml",
14
+ "start:dist-cdn": "npm run start-cdn -- --config ui5-dist.yaml",
15
+ "lint": "eslint webapp",
16
+ "karma": "karma start",
17
+ "karma-ci": "karma start karma-ci.conf.js",
18
+ "karma-ci-cov": "karma start karma-ci-cov.conf.js",
19
+ "test": "npm run lint && npm run karma-ci-cov"
20
+ },
21
+ "devDependencies": {
22
+ "@ui5/cli": "^4.0.23",
23
+ "@ui5/middleware-code-coverage": "^2.0.1",
24
+ "eslint": "^9.34.0",
25
+ "eslint-plugin-jsdoc": "^54.1.1",
26
+ "globals": "^16.3.0",
27
+ "karma": "^6.4.4",
28
+ "karma-chrome-launcher": "^3.2.0",
29
+ "karma-coverage": "^2.2.1",
30
+ "karma-ui5": "^4.1.0",
31
+ "rimraf": "^6.0.1",
32
+ "ui5-middleware-livereload": "^3.1.2"
33
+ }
34
+ }
@@ -0,0 +1,18 @@
1
+ specVersion: "4.0"
2
+ metadata:
3
+ name: <%= appId %>
4
+ type: application
5
+ resources:
6
+ configuration:
7
+ paths:
8
+ webapp: dist
9
+ framework:
10
+ name: <%= framework %>
11
+ version: "<%= frameworkVersion %>"
12
+ libraries:
13
+ - name: sap.m<%if (oDataEntitySet) { %>
14
+ - name: sap.f
15
+ - name: sap.ui.layout
16
+ - name: sap.ui.table<% } %>
17
+ - name: sap.ui.core
18
+ - name: themelib_<%= defaultTheme %>
@@ -0,0 +1,24 @@
1
+ specVersion: "4.0"
2
+ metadata:
3
+ name: <%= appId %>
4
+ type: application
5
+ framework:
6
+ name: <%= framework %>
7
+ version: "<%= frameworkVersion %>"
8
+ libraries:
9
+ - name: sap.m<%if (oDataEntitySet) { %>
10
+ - name: sap.f
11
+ - name: sap.ui.layout
12
+ - name: sap.ui.table<% } %>
13
+ - name: sap.ui.core
14
+ - name: themelib_<%= defaultTheme %>
15
+ builder:
16
+ resources:
17
+ excludes:
18
+ - "test/e2e/**"
19
+ server:
20
+ customMiddleware:
21
+ - name: "@ui5/middleware-code-coverage"
22
+ afterMiddleware: compression
23
+ - name: ui5-middleware-livereload
24
+ afterMiddleware: compression