@decaf-ts/for-angular 0.0.100 → 0.1.1

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 (374) hide show
  1. package/package.json +15 -86
  2. package/.editorconfig +0 -31
  3. package/.gitlab-ci.yml +0 -197
  4. package/.hintrc +0 -19
  5. package/.prettierrc +0 -49
  6. package/.snyk +0 -13
  7. package/LICENSE.md +0 -260
  8. package/angular.json +0 -274
  9. package/bs-config.json +0 -5
  10. package/cli-module.js.map +0 -1
  11. package/dist/for-angular/cli/cli-module.d.ts +0 -22
  12. package/dist/for-angular/cli/cli-module.d.ts.map +0 -1
  13. package/dist/for-angular/cli/cli-module.js +0 -131
  14. package/dist/for-angular/cli/cli-module.js.map +0 -1
  15. package/dist/lib/README.md +0 -117
  16. package/eslint.config.mjs +0 -101
  17. package/ionic.config.json +0 -14
  18. package/jest.config.ts +0 -52
  19. package/jest.setup.ts +0 -50
  20. package/karma.conf.js +0 -50
  21. package/ng-package.json +0 -17
  22. package/ngsw-config.json +0 -30
  23. package/playwright.config.ts +0 -80
  24. package/resources/favicon.png +0 -0
  25. package/resources/favicon.svg +0 -29
  26. package/resources/icon-background.png +0 -0
  27. package/resources/icon-foreground.png +0 -0
  28. package/resources/icon-only.png +0 -0
  29. package/resources/icon-only.svg +0 -29
  30. package/resources/splash-dark.png +0 -0
  31. package/resources/splash-dark2.png +0 -0
  32. package/resources/splash.png +0 -0
  33. package/resources/splash2.png +0 -0
  34. package/resources/touch-icon.svg +0 -29
  35. package/schematics/README.md +0 -28
  36. package/schematics/collection.json +0 -20
  37. package/schematics/package-lock.json +0 -1501
  38. package/schematics/package.json +0 -37
  39. package/schematics/src/component/files/__name@dasherize@if-flat__/__name@dasherize__.__type@dasherize__.__style__.template +0 -0
  40. package/schematics/src/component/files/__name@dasherize@if-flat__/__name@dasherize__.__type@dasherize__.html.template +0 -3
  41. package/schematics/src/component/files/__name@dasherize@if-flat__/__name@dasherize__.__type@dasherize__.spec.ts.template +0 -40
  42. package/schematics/src/component/files/__name@dasherize@if-flat__/__name@dasherize__.__type@dasherize__.ts.template +0 -37
  43. package/schematics/src/component/files/__name@dasherize@if-flat__/__name@dasherize__.module.ts.template +0 -14
  44. package/schematics/src/component/index.js +0 -146
  45. package/schematics/src/component/schema.js +0 -2
  46. package/schematics/src/component/schema.json +0 -101
  47. package/schematics/src/page/files/__name@dasherize__.page.html.template +0 -15
  48. package/schematics/src/page/files/__name@dasherize__.page.scss.template +0 -0
  49. package/schematics/src/page/files/__name@dasherize__.page.ts.template +0 -19
  50. package/schematics/src/page/index.js +0 -71
  51. package/schematics/src/page/schema.json +0 -87
  52. package/schematics/src/schematics/index.js +0 -11
  53. package/schematics/src/schematics/index_spec.js +0 -13
  54. package/schematics/src/util/ast-util.js +0 -517
  55. package/schematics/src/util/change.js +0 -96
  56. package/schematics/src/util/index.js +0 -14
  57. package/settings.json +0 -112
  58. package/tsconfig.app.json +0 -22
  59. package/tsconfig.cli.json +0 -82
  60. package/tsconfig.lib.json +0 -14
  61. package/tsconfig.lib.prod.json +0 -10
  62. package/tsconfig.spec.json +0 -22
  63. package/webpack.config.js +0 -10
  64. package/workdocs/1-Header.md +0 -5
  65. package/workdocs/2-Badges.md +0 -30
  66. package/workdocs/4-Description.md +0 -4
  67. package/workdocs/5-HowToUse.md +0 -27
  68. package/workdocs/6-Related.md +0 -7
  69. package/workdocs/7-Social.md +0 -5
  70. package/workdocs/99-Footer.md +0 -28
  71. package/workdocs/Readme.md +0 -12
  72. package/workdocs/assets/apple-touch-icon.png +0 -0
  73. package/workdocs/assets/decaf-logo.svg +0 -54
  74. package/workdocs/assets/favicon.png +0 -0
  75. package/workdocs/assets/slogans.json +0 -182
  76. package/workdocs/confluence/.markdown-confluence.template.json +0 -6
  77. package/workdocs/confluence/Angular Module.md +0 -5
  78. package/workdocs/drawings/diagram.drawio +0 -24
  79. package/workdocs/prompts/bulk.md +0 -122
  80. package/workdocs/prompts/code.md +0 -47
  81. package/workdocs/prompts/documentation.md +0 -146
  82. package/workdocs/prompts/uml.md +0 -11
  83. package/workdocs/readme-md.json +0 -6
  84. package/workdocs/reports/CHANGELOG.md +0 -12
  85. package/workdocs/reports/DEPENDENCIES.md +0 -213
  86. package/workdocs/reports/RELEASE_NOTES.md +0 -24
  87. package/workdocs/reports/coverage/.gitkeep +0 -0
  88. package/workdocs/reports/coverage/clover.xml +0 -4107
  89. package/workdocs/reports/coverage/coverage-final.json +0 -76
  90. package/workdocs/reports/coverage/lcov-report/base.css +0 -224
  91. package/workdocs/reports/coverage/lcov-report/block-navigation.js +0 -87
  92. package/workdocs/reports/coverage/lcov-report/favicon.png +0 -0
  93. package/workdocs/reports/coverage/lcov-report/index.html +0 -551
  94. package/workdocs/reports/coverage/lcov-report/prettify.css +0 -1
  95. package/workdocs/reports/coverage/lcov-report/prettify.js +0 -2
  96. package/workdocs/reports/coverage/lcov-report/sort-arrow-sprite.png +0 -0
  97. package/workdocs/reports/coverage/lcov-report/sorter.js +0 -210
  98. package/workdocs/reports/coverage/lcov-report/src/app/models/CategoryModel.ts.html +0 -277
  99. package/workdocs/reports/coverage/lcov-report/src/app/models/DemoModel.ts.html +0 -427
  100. package/workdocs/reports/coverage/lcov-report/src/app/models/UserModel.ts.html +0 -226
  101. package/workdocs/reports/coverage/lcov-report/src/app/models/index.html +0 -146
  102. package/workdocs/reports/coverage/lcov-report/src/cli-module.ts.html +0 -502
  103. package/workdocs/reports/coverage/lcov-report/src/environments/environment.ts.html +0 -166
  104. package/workdocs/reports/coverage/lcov-report/src/environments/index.html +0 -116
  105. package/workdocs/reports/coverage/lcov-report/src/index.html +0 -191
  106. package/workdocs/reports/coverage/lcov-report/src/karma-test.ts.html +0 -121
  107. package/workdocs/reports/coverage/lcov-report/src/lib/components/card/card.component.ts.html +0 -625
  108. package/workdocs/reports/coverage/lcov-report/src/lib/components/card/index.html +0 -116
  109. package/workdocs/reports/coverage/lcov-report/src/lib/components/component-renderer/component-renderer.component.ts.html +0 -772
  110. package/workdocs/reports/coverage/lcov-report/src/lib/components/component-renderer/index.html +0 -116
  111. package/workdocs/reports/coverage/lcov-report/src/lib/components/crud-field/crud-field.component.ts.html +0 -2698
  112. package/workdocs/reports/coverage/lcov-report/src/lib/components/crud-field/index.html +0 -116
  113. package/workdocs/reports/coverage/lcov-report/src/lib/components/crud-form/constants.ts.html +0 -133
  114. package/workdocs/reports/coverage/lcov-report/src/lib/components/crud-form/crud-form.component.ts.html +0 -346
  115. package/workdocs/reports/coverage/lcov-report/src/lib/components/crud-form/index.html +0 -116
  116. package/workdocs/reports/coverage/lcov-report/src/lib/components/empty-state/empty-state.component.ts.html +0 -1264
  117. package/workdocs/reports/coverage/lcov-report/src/lib/components/empty-state/index.html +0 -116
  118. package/workdocs/reports/coverage/lcov-report/src/lib/components/fieldset/fieldset.component.ts.html +0 -2965
  119. package/workdocs/reports/coverage/lcov-report/src/lib/components/fieldset/index.html +0 -116
  120. package/workdocs/reports/coverage/lcov-report/src/lib/components/file-upload/file-upload.component.ts.html +0 -2263
  121. package/workdocs/reports/coverage/lcov-report/src/lib/components/file-upload/index.html +0 -116
  122. package/workdocs/reports/coverage/lcov-report/src/lib/components/filter/filter.component.ts.html +0 -2485
  123. package/workdocs/reports/coverage/lcov-report/src/lib/components/filter/index.html +0 -116
  124. package/workdocs/reports/coverage/lcov-report/src/lib/components/for-angular-components.module.ts.html +0 -259
  125. package/workdocs/reports/coverage/lcov-report/src/lib/components/icon/icon.component.ts.html +0 -358
  126. package/workdocs/reports/coverage/lcov-report/src/lib/components/icon/index.html +0 -116
  127. package/workdocs/reports/coverage/lcov-report/src/lib/components/index.html +0 -131
  128. package/workdocs/reports/coverage/lcov-report/src/lib/components/index.ts.html +0 -181
  129. package/workdocs/reports/coverage/lcov-report/src/lib/components/layout/index.html +0 -116
  130. package/workdocs/reports/coverage/lcov-report/src/lib/components/layout/layout.component.ts.html +0 -943
  131. package/workdocs/reports/coverage/lcov-report/src/lib/components/list/index.html +0 -116
  132. package/workdocs/reports/coverage/lcov-report/src/lib/components/list/list.component.ts.html +0 -4420
  133. package/workdocs/reports/coverage/lcov-report/src/lib/components/list-item/index.html +0 -116
  134. package/workdocs/reports/coverage/lcov-report/src/lib/components/list-item/list-item.component.ts.html +0 -1741
  135. package/workdocs/reports/coverage/lcov-report/src/lib/components/modal/index.html +0 -116
  136. package/workdocs/reports/coverage/lcov-report/src/lib/components/modal/modal.component.ts.html +0 -1984
  137. package/workdocs/reports/coverage/lcov-report/src/lib/components/model-renderer/index.html +0 -116
  138. package/workdocs/reports/coverage/lcov-report/src/lib/components/model-renderer/model-renderer.component.ts.html +0 -373
  139. package/workdocs/reports/coverage/lcov-report/src/lib/components/pagination/index.html +0 -116
  140. package/workdocs/reports/coverage/lcov-report/src/lib/components/pagination/pagination.component.ts.html +0 -1165
  141. package/workdocs/reports/coverage/lcov-report/src/lib/components/searchbar/index.html +0 -116
  142. package/workdocs/reports/coverage/lcov-report/src/lib/components/searchbar/searchbar.component.ts.html +0 -1774
  143. package/workdocs/reports/coverage/lcov-report/src/lib/components/stepped-form/index.html +0 -116
  144. package/workdocs/reports/coverage/lcov-report/src/lib/components/stepped-form/stepped-form.component.ts.html +0 -1219
  145. package/workdocs/reports/coverage/lcov-report/src/lib/components/table/index.html +0 -116
  146. package/workdocs/reports/coverage/lcov-report/src/lib/components/table/table.component.ts.html +0 -1054
  147. package/workdocs/reports/coverage/lcov-report/src/lib/directives/NgxSvgDirective.ts.html +0 -163
  148. package/workdocs/reports/coverage/lcov-report/src/lib/directives/collapsable.directive.ts.html +0 -268
  149. package/workdocs/reports/coverage/lcov-report/src/lib/directives/index.html +0 -131
  150. package/workdocs/reports/coverage/lcov-report/src/lib/directives/index.ts.html +0 -91
  151. package/workdocs/reports/coverage/lcov-report/src/lib/engine/DynamicModule.ts.html +0 -133
  152. package/workdocs/reports/coverage/lcov-report/src/lib/engine/MediaService.ts.html +0 -142
  153. package/workdocs/reports/coverage/lcov-report/src/lib/engine/NgxBaseComponent.ts.html +0 -2194
  154. package/workdocs/reports/coverage/lcov-report/src/lib/engine/NgxComponentDirective.ts.html +0 -3430
  155. package/workdocs/reports/coverage/lcov-report/src/lib/engine/NgxCrudFormField.ts.html +0 -721
  156. package/workdocs/reports/coverage/lcov-report/src/lib/engine/NgxDecafComponentDirective.ts.html +0 -1864
  157. package/workdocs/reports/coverage/lcov-report/src/lib/engine/NgxDecafFormFieldDirective.ts.html +0 -952
  158. package/workdocs/reports/coverage/lcov-report/src/lib/engine/NgxDecafFormService.ts.html +0 -3211
  159. package/workdocs/reports/coverage/lcov-report/src/lib/engine/NgxEventHandler.ts.html +0 -307
  160. package/workdocs/reports/coverage/lcov-report/src/lib/engine/NgxFormDirective.ts.html +0 -1366
  161. package/workdocs/reports/coverage/lcov-report/src/lib/engine/NgxFormFieldDirective.ts.html +0 -1960
  162. package/workdocs/reports/coverage/lcov-report/src/lib/engine/NgxFormService.ts.html +0 -3004
  163. package/workdocs/reports/coverage/lcov-report/src/lib/engine/NgxModelPageDirective.ts.html +0 -1672
  164. package/workdocs/reports/coverage/lcov-report/src/lib/engine/NgxPageDirective.ts.html +0 -748
  165. package/workdocs/reports/coverage/lcov-report/src/lib/engine/NgxParentComponentDirective.ts.html +0 -775
  166. package/workdocs/reports/coverage/lcov-report/src/lib/engine/NgxRenderableComponentDirective.ts.html +0 -727
  167. package/workdocs/reports/coverage/lcov-report/src/lib/engine/NgxRenderingEngine.ts.html +0 -2005
  168. package/workdocs/reports/coverage/lcov-report/src/lib/engine/NgxRepositoryDirective.ts.html +0 -1546
  169. package/workdocs/reports/coverage/lcov-report/src/lib/engine/ValidatorFactory.ts.html +0 -817
  170. package/workdocs/reports/coverage/lcov-report/src/lib/engine/constants.ts.html +0 -1120
  171. package/workdocs/reports/coverage/lcov-report/src/lib/engine/decorators.ts.html +0 -376
  172. package/workdocs/reports/coverage/lcov-report/src/lib/engine/helpers.ts.html +0 -694
  173. package/workdocs/reports/coverage/lcov-report/src/lib/engine/index.html +0 -356
  174. package/workdocs/reports/coverage/lcov-report/src/lib/engine/index.ts.html +0 -160
  175. package/workdocs/reports/coverage/lcov-report/src/lib/engine/overrides.ts.html +0 -502
  176. package/workdocs/reports/coverage/lcov-report/src/lib/for-angular-common.module.ts.html +0 -298
  177. package/workdocs/reports/coverage/lcov-report/src/lib/helpers/index.html +0 -131
  178. package/workdocs/reports/coverage/lcov-report/src/lib/helpers/index.ts.html +0 -121
  179. package/workdocs/reports/coverage/lcov-report/src/lib/helpers/utils.ts.html +0 -1603
  180. package/workdocs/reports/coverage/lcov-report/src/lib/i18n/FakeLoader.ts.html +0 -157
  181. package/workdocs/reports/coverage/lcov-report/src/lib/i18n/Loader.ts.html +0 -826
  182. package/workdocs/reports/coverage/lcov-report/src/lib/i18n/index.html +0 -146
  183. package/workdocs/reports/coverage/lcov-report/src/lib/i18n/index.ts.html +0 -91
  184. package/workdocs/reports/coverage/lcov-report/src/lib/index.html +0 -131
  185. package/workdocs/reports/coverage/lcov-report/src/lib/public-apis.ts.html +0 -157
  186. package/workdocs/reports/coverage/lcov-report/src/lib/services/NgxFormService.ts.html +0 -3460
  187. package/workdocs/reports/coverage/lcov-report/src/lib/services/NgxMediaService.ts.html +0 -1420
  188. package/workdocs/reports/coverage/lcov-report/src/lib/services/NgxRouterService.ts.html +0 -1243
  189. package/workdocs/reports/coverage/lcov-report/src/lib/services/NgxTranslateService.ts.html +0 -214
  190. package/workdocs/reports/coverage/lcov-report/src/lib/services/index.html +0 -176
  191. package/workdocs/reports/coverage/lcov-report/src/lib/services/index.ts.html +0 -91
  192. package/workdocs/reports/coverage/lcov-report/src/lib/utils/DecafFakerRepository.ts.html +0 -571
  193. package/workdocs/reports/coverage/lcov-report/src/lib/utils/helpers.ts.html +0 -1711
  194. package/workdocs/reports/coverage/lcov-report/src/lib/utils/index.html +0 -146
  195. package/workdocs/reports/coverage/lcov-report/src/lib/utils/index.ts.html +0 -124
  196. package/workdocs/reports/coverage/lcov-report/src/main.ts.html +0 -100
  197. package/workdocs/reports/coverage/lcov-report/src/polyfills.ts.html +0 -271
  198. package/workdocs/reports/coverage/lcov-report/src/stories/Configure.stories.ts.html +0 -1156
  199. package/workdocs/reports/coverage/lcov-report/src/stories/button.component.ts.html +0 -229
  200. package/workdocs/reports/coverage/lcov-report/src/stories/button.stories.ts.html +0 -235
  201. package/workdocs/reports/coverage/lcov-report/src/stories/crud-field.stories.ts.html +0 -325
  202. package/workdocs/reports/coverage/lcov-report/src/stories/header.stories.ts.html +0 -181
  203. package/workdocs/reports/coverage/lcov-report/src/stories/index.html +0 -281
  204. package/workdocs/reports/coverage/lcov-report/src/stories/list.stories.ts.html +0 -289
  205. package/workdocs/reports/coverage/lcov-report/src/stories/login.page.stories.ts.html +0 -175
  206. package/workdocs/reports/coverage/lcov-report/src/stories/model-renderer.stories.ts.html +0 -259
  207. package/workdocs/reports/coverage/lcov-report/src/stories/page.component.ts.html +0 -331
  208. package/workdocs/reports/coverage/lcov-report/src/stories/page.stories.ts.html +0 -193
  209. package/workdocs/reports/coverage/lcov-report/src/stories/setup.ts.html +0 -127
  210. package/workdocs/reports/coverage/lcov-report/src/stories/utils.ts.html +0 -247
  211. package/workdocs/reports/coverage/lcov-report/src/tests/index.html +0 -116
  212. package/workdocs/reports/coverage/lcov-report/src/tests/karmaErrorParser.ts.html +0 -190
  213. package/workdocs/reports/coverage/lcov-report/src/typings.d.ts.html +0 -88
  214. package/workdocs/reports/coverage/lcov-report/src/zone-flags.ts.html +0 -103
  215. package/workdocs/reports/coverage/lcov.info +0 -7898
  216. package/workdocs/reports/data/.gitkeep +0 -1
  217. package/workdocs/reports/html/.gitkeep +0 -0
  218. package/workdocs/reports/html/jest-html-reporters-attach/test-report/index.js +0 -3
  219. package/workdocs/reports/html/jest-html-reporters-attach/test-report/result.js +0 -1
  220. package/workdocs/reports/html/test-report.html +0 -1
  221. package/workdocs/reports/images/.gitkeep +0 -1
  222. package/workdocs/reports/jest.coverage.config.ts +0 -43
  223. package/workdocs/reports/junit/junit-report.xml +0 -91
  224. package/workdocs/resources/.gitlock +0 -0
  225. package/workdocs/resources/diagram-Actor.png +0 -0
  226. package/workdocs/resources/diagram-banner.png +0 -0
  227. package/workdocs/resources/diagram.png +0 -0
  228. package/workdocs/tutorials/Contributing.md +0 -64
  229. package/workdocs/tutorials/Documentation.md +0 -340
  230. package/workdocs/tutorials/For Developers.md +0 -337
  231. package/workdocs/uml/diagram.puml +0 -11
  232. package/www/1049.10b030f0de36543b.js +0 -1
  233. package/www/1102.67cedfb3e29f0a05.js +0 -1
  234. package/www/1107.6b592a1672821270.js +0 -1
  235. package/www/1459.cabc18e941afa5d7.js +0 -1
  236. package/www/1577.5221deebe3501e43.js +0 -1
  237. package/www/2075.b6dc4fbb89dd6afc.js +0 -1
  238. package/www/2348.c4cc27dadbec70ec.js +0 -1
  239. package/www/2375.318d0b24ab346271.js +0 -1
  240. package/www/2415.618d6968ffda319c.js +0 -1
  241. package/www/2460.1d97c6f48b898ee2.js +0 -1
  242. package/www/2560.2e7000dcf80b6b2c.js +0 -1
  243. package/www/2585.274d59d52bafc7ed.js +0 -1
  244. package/www/2885.d99b86afd1ff7aa8.js +0 -1
  245. package/www/3162.bbc401f4a5f82460.js +0 -1
  246. package/www/323.f64c512be5c8d797.js +0 -1
  247. package/www/3238.a3e7e8004c6b6667.js +0 -1
  248. package/www/3506.8c03f5589b33a4a6.js +0 -1
  249. package/www/3511.56b7e49bb6c2c936.js +0 -1
  250. package/www/3519.84fbb67dc803f702.js +0 -1
  251. package/www/3675.7ebfdcf145052232.js +0 -1
  252. package/www/3814.765c1794e1be63de.js +0 -1
  253. package/www/3rdpartylicenses.txt +0 -1344
  254. package/www/4171.a974bdbf9c97e4e1.js +0 -1
  255. package/www/4183.41ef1def450a2cc0.js +0 -1
  256. package/www/4406.0b2dd3839b8c1417.js +0 -1
  257. package/www/441.e1031657c7e5f0ff.js +0 -1
  258. package/www/4463.6ad7b857e5f34009.js +0 -1
  259. package/www/4591.42f34534d38b9b31.js +0 -1
  260. package/www/4699.8df8ea9806163d4c.js +0 -1
  261. package/www/5100.ed6483c55a157d67.js +0 -1
  262. package/www/5193.15ea6938534eceb1.js +0 -1
  263. package/www/5197.6733853529768a45.js +0 -1
  264. package/www/5222.8439a641c2c4b1c1.js +0 -1
  265. package/www/5373.d7878f708309f038.js +0 -1
  266. package/www/5467.f0e21031db47308c.js +0 -1
  267. package/www/5712.b08cf436ee8145ce.js +0 -1
  268. package/www/5887.3d038f564e925abb.js +0 -1
  269. package/www/5949.37330f20e95dee79.js +0 -1
  270. package/www/6024.c10cc3d1b341c748.js +0 -1
  271. package/www/6433.360fcff952bde822.js +0 -1
  272. package/www/6499.60169da9869db697.js +0 -1
  273. package/www/6521.fab1f34bfe6b8200.js +0 -1
  274. package/www/6631.eaa711da6e0aeed9.js +0 -1
  275. package/www/6717.9d970c383bb0cf1c.js +0 -1
  276. package/www/6840.7317cd962ab23932.js +0 -1
  277. package/www/7030.d115d82ca7468a4e.js +0 -1
  278. package/www/7076.cce20ed5c79ff305.js +0 -1
  279. package/www/7179.c0545989ce869b3d.js +0 -1
  280. package/www/7240.69aeb484d78eb24d.js +0 -1
  281. package/www/7372.94c62459e34f7303.js +0 -1
  282. package/www/7402.983a5ecff61e9a5d.js +0 -1
  283. package/www/7428.527ac48035a2f915.js +0 -1
  284. package/www/7676.d7db23d350e4b096.js +0 -1
  285. package/www/770.80af87d5eb0075d3.js +0 -1
  286. package/www/7720.0701576cb9966779.js +0 -1
  287. package/www/7927.ee869d0dc478250a.js +0 -1
  288. package/www/8066.894688fbb2e5c832.js +0 -1
  289. package/www/8193.7f09ecd40b6d42c2.js +0 -1
  290. package/www/8255.158098a6302c91c2.js +0 -1
  291. package/www/8314.596c1ccf26b9c93a.js +0 -1
  292. package/www/8357.c5406b92e6933d7a.js +0 -1
  293. package/www/8477.a3ccc11c25a642d3.js +0 -1
  294. package/www/8487.93b6f7465ae1b7ac.js +0 -1
  295. package/www/8584.b77ad478a5a7ac2a.js +0 -1
  296. package/www/8805.a87413652185ff8f.js +0 -1
  297. package/www/8814.b489a78ae8e926c4.js +0 -1
  298. package/www/8970.234b3db1f97528fe.js +0 -1
  299. package/www/9013.c2e6ba17a915bdd6.js +0 -1
  300. package/www/9073.16c4e42482d55a3c.js +0 -1
  301. package/www/9344.7d2d24b194b794e2.js +0 -1
  302. package/www/9364.9a028036dd89e3e7.js +0 -1
  303. package/www/944.7e4317348c48d4f4.js +0 -1
  304. package/www/964.9a979e1c1aad0f5b.js +0 -1
  305. package/www/9657.fbb680ad1064e91a.js +0 -1
  306. package/www/9956.2d00a2153e9a7799.js +0 -1
  307. package/www/9977.068cd5561462bc99.js +0 -1
  308. package/www/assets/i18n/en.json +0 -210
  309. package/www/assets/i18n/ew/en.json +0 -346
  310. package/www/assets/i18n/pt.json +0 -186
  311. package/www/assets/icons/icon-128.webp +0 -0
  312. package/www/assets/icons/icon-192.webp +0 -0
  313. package/www/assets/icons/icon-256.webp +0 -0
  314. package/www/assets/icons/icon-48.webp +0 -0
  315. package/www/assets/icons/icon-512.webp +0 -0
  316. package/www/assets/icons/icon-72.webp +0 -0
  317. package/www/assets/icons/icon-96.webp +0 -0
  318. package/www/assets/images/angular-logo.svg +0 -45
  319. package/www/assets/images/apple-touch-icon.png +0 -0
  320. package/www/assets/images/decaf-logo-black.svg +0 -22
  321. package/www/assets/images/decaf-logo-contrast.svg +0 -54
  322. package/www/assets/images/decaf-logo-white.svg +0 -22
  323. package/www/assets/images/decaf-logo.svg +0 -54
  324. package/www/assets/images/ew/product.txt +0 -1
  325. package/www/assets/images/favicon-contrast.svg +0 -7
  326. package/www/assets/images/favicon.png +0 -0
  327. package/www/assets/images/favicon.svg +0 -29
  328. package/www/assets/images/icons/document.svg +0 -7
  329. package/www/assets/images/icons/edit.svg +0 -1
  330. package/www/assets/images/icons/logout.svg +0 -4
  331. package/www/assets/images/icons/menu-collapse.svg +0 -5
  332. package/www/assets/images/icons/menu.svg +0 -3
  333. package/www/assets/images/icons/moon-stars.svg +0 -5
  334. package/www/assets/images/icons/trash.svg +0 -1
  335. package/www/cli-module.ts +0 -139
  336. package/www/common.e50b5f8708aca9a5.js +0 -1
  337. package/www/index.html +0 -29
  338. package/www/main.7814262e404641fd.js +0 -1
  339. package/www/polyfills.4c1e087fffe784e8.js +0 -1
  340. package/www/runtime.e81aa7ecff7177cd.js +0 -1
  341. package/www/styles.5a3cd83eba16afc9.css +0 -4
  342. package/www/tabler-icons.bfabe54eef86ae62.woff +0 -0
  343. package/www/tabler-icons.d9f65ab9439b4ffc.ttf +0 -0
  344. package/www/tabler-icons.f17d2c3b34a5deaa.woff2 +0 -0
  345. /package/{dist/lib/assets → assets}/i18n/en.json +0 -0
  346. /package/{dist/lib/assets → assets}/i18n/ew/en.json +0 -0
  347. /package/{dist/lib/assets → assets}/i18n/pt.json +0 -0
  348. /package/{dist/lib/assets → assets}/icons/icon-128.webp +0 -0
  349. /package/{dist/lib/assets → assets}/icons/icon-192.webp +0 -0
  350. /package/{dist/lib/assets → assets}/icons/icon-256.webp +0 -0
  351. /package/{dist/lib/assets → assets}/icons/icon-48.webp +0 -0
  352. /package/{dist/lib/assets → assets}/icons/icon-512.webp +0 -0
  353. /package/{dist/lib/assets → assets}/icons/icon-72.webp +0 -0
  354. /package/{dist/lib/assets → assets}/icons/icon-96.webp +0 -0
  355. /package/{dist/lib/assets → assets}/images/angular-logo.svg +0 -0
  356. /package/{dist/lib/assets → assets}/images/apple-touch-icon.png +0 -0
  357. /package/{dist/lib/assets → assets}/images/decaf-logo-black.svg +0 -0
  358. /package/{dist/lib/assets → assets}/images/decaf-logo-contrast.svg +0 -0
  359. /package/{dist/lib/assets → assets}/images/decaf-logo-white.svg +0 -0
  360. /package/{dist/lib/assets → assets}/images/decaf-logo.svg +0 -0
  361. /package/{dist/lib/assets → assets}/images/ew/product.txt +0 -0
  362. /package/{dist/lib/assets → assets}/images/favicon-contrast.svg +0 -0
  363. /package/{dist/lib/assets → assets}/images/favicon.png +0 -0
  364. /package/{dist/lib/assets → assets}/images/favicon.svg +0 -0
  365. /package/{dist/lib/assets → assets}/images/icons/document.svg +0 -0
  366. /package/{dist/lib/assets → assets}/images/icons/edit.svg +0 -0
  367. /package/{dist/lib/assets → assets}/images/icons/logout.svg +0 -0
  368. /package/{dist/lib/assets → assets}/images/icons/menu-collapse.svg +0 -0
  369. /package/{dist/lib/assets → assets}/images/icons/menu.svg +0 -0
  370. /package/{dist/lib/assets → assets}/images/icons/moon-stars.svg +0 -0
  371. /package/{dist/lib/assets → assets}/images/icons/trash.svg +0 -0
  372. /package/{dist/lib/fesm2022 → fesm2022}/decaf-ts-for-angular.mjs +0 -0
  373. /package/{dist/lib/fesm2022 → fesm2022}/decaf-ts-for-angular.mjs.map +0 -0
  374. /package/{dist/lib/index.d.ts → index.d.ts} +0 -0
@@ -1,182 +0,0 @@
1
- [
2
- {
3
- "Slogan": "Decaf‑TS for Angular: build components, not caffeine panic.",
4
- "Tags": "Angular, Coffee‑themed, Frontend"
5
- },
6
- {
7
- "Slogan": "Templates that flow smoother than your decaf espresso.",
8
- "Tags": "Templates, Chill, Coffee‑themed"
9
- },
10
- {
11
- "Slogan": "Modules, components and services—all served decaffeinated.",
12
- "Tags": "Modules, Coffee‑themed, Technical"
13
- },
14
- {
15
- "Slogan": "When change detection relaxes, so does your heart rate.",
16
- "Tags": "ChangeDetection, Calm, Frontend"
17
- },
18
- {
19
- "Slogan": "Angular + Decaf‑TS = UI that won’t keep you up at night.",
20
- "Tags": "Angular, Calm, Branding"
21
- },
22
- {
23
- "Slogan": "Lazy‑loaded routes, fully awake developers (without the caffeine).",
24
- "Tags": "Routing, LazyLoad, Humor"
25
- },
26
- {
27
- "Slogan": "Components that stay composed—even when your data doesn’t.",
28
- "Tags": "Components, Chill, Developer"
29
- },
30
- {
31
- "Slogan": "No jittery animations, just smooth transitions and smooth devs.",
32
- "Tags": "Animations, Calm, Coffee‑themed"
33
- },
34
- {
35
- "Slogan": "Services that inject calm instead of adrenaline.",
36
- "Tags": "Services, Calm, Angular"
37
- },
38
- {
39
- "Slogan": "Write directives like you write your morning brew—full of flavor, zero crash.",
40
- "Tags": "Directives, Coffee‑themed, Fun"
41
- },
42
- {
43
- "Slogan": "Angular forms that keep your UI steady and your caffeine intake low.",
44
- "Tags": "Forms, Calm, Frontend"
45
- },
46
- {
47
- "Slogan": "State management? More like state‑relaxation management.",
48
- "Tags": "State, Chill, Frontend"
49
- },
50
- {
51
- "Slogan": "Build your SPA while sipping decaf—framework won’t outpace you.",
52
- "Tags": "SPA, Coffee‑themed, Developer"
53
- },
54
- {
55
- "Slogan": "Pipes that filter chaos from your code.",
56
- "Tags": "Pipes, Calm, Humor"
57
- },
58
- {
59
- "Slogan": "Components with metadata that feel like latte art.",
60
- "Tags": "Metadata, Coffee‑themed, Tech"
61
- },
62
- {
63
- "Slogan": "When your change bags are quiet, your users don’t panic.",
64
- "Tags": "ChangeDetection, Calm, UX"
65
- },
66
- {
67
- "Slogan": "Decaf‑TS for Angular: where UI code relaxes and features deploy fast.",
68
- "Tags": "UI, Calm, Productivity"
69
- },
70
- {
71
- "Slogan": "Bindings that don’t bind you to adrenaline.",
72
- "Tags": "Bindings, Calm, Frontend"
73
- },
74
- {
75
- "Slogan": "Animations that ease in like a steaming cup of decaf.",
76
- "Tags": "Animations, Coffee‑themed, UI"
77
- },
78
- {
79
- "Slogan": "RxJS observables that observe your calm, not your heart rate.",
80
- "Tags": "RxJS, Chill, Humor"
81
- },
82
- {
83
- "Slogan": "You write the logic; the framework writes the latte foam.",
84
- "Tags": "Developer, Coffee‑themed, Frontend"
85
- },
86
- {
87
- "Slogan": "When the UI adapts, you relax.",
88
- "Tags": "UI, Calm, Adaptation"
89
- },
90
- {
91
- "Slogan": "Angular modules that feel like a restful Sunday morning.",
92
- "Tags": "Modules, Calm, Metaphor"
93
- },
94
- {
95
- "Slogan": "Directive your stress to zero.",
96
- "Tags": "Directives, Humor, Calm"
97
- },
98
- {
99
- "Slogan": "Decaf mode: code components, sip coffee, deploy features.",
100
- "Tags": "Coffee‑themed, Workflow, Frontend"
101
- },
102
- {
103
- "Slogan": "Your UI stack’s decaf shot—strong features, gentle developer experience.",
104
- "Tags": "UI Stack, Branding, Calm"
105
- },
106
- {
107
- "Slogan": "Forms that validate so smoothly you forget about the coffee break.",
108
- "Tags": "Forms, Smooth, Developer"
109
- },
110
- {
111
- "Slogan": "When your UI layer relaxes, your backend gets jealous.",
112
- "Tags": "UI, Humor, Fullstack"
113
- },
114
- {
115
- "Slogan": "Angular routes that don’t dig into your veins.",
116
- "Tags": "Routing, Humor, Calm"
117
- },
118
- {
119
- "Slogan": "Change detection strategy: OnPush your heart‑rate too.",
120
- "Tags": "ChangeDetection, Humor, Angular"
121
- },
122
- {
123
- "Slogan": "Components that serve features, not caffeine bursts.",
124
- "Tags": "Components, Coffee‑themed, Developer"
125
- },
126
- {
127
- "Slogan": "Templates that load like your server: calm and measured.",
128
- "Tags": "Templates, Chill, Tech"
129
- },
130
- {
131
- "Slogan": "Services that whisper requests rather than shout them.",
132
- "Tags": "Services, Calm, Frontend"
133
- },
134
- {
135
- "Slogan": "When your UI feels like a café lounge, not a roller‑coaster.",
136
- "Tags": "UI, Metaphor, Calm"
137
- },
138
- {
139
- "Slogan": "Build your Angular app while your code stays decaf‑serene.",
140
- "Tags": "Build, Calm, Branding"
141
- },
142
- {
143
- "Slogan": "No caffeine crash in your UI stack, just smooth user experience.",
144
- "Tags": "UX, Calm, Coffee‑themed"
145
- },
146
- {
147
- "Slogan": "Directives that make your code shine… without shining your pupils.",
148
- "Tags": "Directives, Humor, Frontend"
149
- },
150
- {
151
- "Slogan": "Keep calm and compile Angular.",
152
- "Tags": "Compile, Playful, Calm"
153
- },
154
- {
155
- "Slogan": "Decaf‑TS for Angular: sip your coffee, ship your UI.",
156
- "Tags": "UI, Coffee‑themed, Productivity"
157
- },
158
- {
159
- "Slogan": "Your components deserve the decaf treatment.",
160
- "Tags": "Components, Branding, Coffee‑themed"
161
- },
162
- {
163
- "Slogan": "Services with calm APIs, not caffeine APIs.",
164
- "Tags": "Services, Calm, Technical"
165
- },
166
- {
167
- "Slogan": "Modules that plug in seamlessly… like your decaf plug in the morning.",
168
- "Tags": "Modules, Humor, Coffee‑themed"
169
- },
170
- {
171
- "Slogan": "Templates that keep your DOM awake—and your nerves asleep.",
172
- "Tags": "DOM, Humor, Calm"
173
- },
174
- {
175
- "Slogan": "When the UI updates quietly, the product gets spotlighted.",
176
- "Tags": "UI, DevX, Calm"
177
- },
178
- {
179
- "Slogan": "Build with Angular. Brew with Decaf‑TS.",
180
- "Tags": "Angular, Coffee‑themed, Branding"
181
- }
182
- ]
@@ -1,6 +0,0 @@
1
- {
2
- "confluenceBaseUrl": "https://${org_name}.atlassian.net",
3
- "confluenceParentId": "${parent_folder_id}",
4
- "atlassianUserName": "${atlassian_user_name}",
5
- "folderToPublish": "."
6
- }
@@ -1,5 +0,0 @@
1
- ## Decaf-ts' Reflection Module
2
-
3
- ### Design Specifications
4
-
5
- > add design spec here
@@ -1,24 +0,0 @@
1
- <mxfile host="Electron" modified="2024-03-09T04:35:50.502Z" agent="Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/23.1.5 Chrome/120.0.6099.109 Electron/28.1.0 Safari/537.36" etag="N1EO2Ae_HK81A13fh9sG" version="23.1.5" type="device" pages="2">
2
- <diagram name="banner" id="YSmI_IRiB9JPhWhTJ_M6">
3
- <mxGraphModel dx="1050" dy="639" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
4
- <root>
5
- <mxCell id="0" />
6
- <mxCell id="1" parent="0" />
7
- <mxCell id="1IUq52-lKtW0vFbKEjnJ-1" value="&lt;h1&gt;I am a drawIO Diagram&lt;/h1&gt;&lt;p&gt;Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.&lt;/p&gt;" style="text;html=1;spacing=5;spacingTop=-20;whiteSpace=wrap;overflow=hidden;rounded=0;" parent="1" vertex="1">
8
- <mxGeometry x="230" y="230" width="190" height="120" as="geometry" />
9
- </mxCell>
10
- </root>
11
- </mxGraphModel>
12
- </diagram>
13
- <diagram id="6UFowTpk1v24f48qAjIY" name="Actor">
14
- <mxGraphModel dx="1050" dy="639" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
15
- <root>
16
- <mxCell id="0" />
17
- <mxCell id="1" parent="0" />
18
- <mxCell id="SNubH1uuLD6a0vhFL_yV-1" value="Actor" style="shape=umlActor;verticalLabelPosition=bottom;verticalAlign=top;html=1;outlineConnect=0;" vertex="1" parent="1">
19
- <mxGeometry x="230" y="240" width="30" height="60" as="geometry" />
20
- </mxCell>
21
- </root>
22
- </mxGraphModel>
23
- </diagram>
24
- </mxfile>
@@ -1,122 +0,0 @@
1
- ## Prompts to generate bulk actions
2
-
3
- - Bulk JSDoc
4
- ```
5
- Act as a seasoned typescript developer.
6
- - find all code files using `find ./src -type f -name '*.ts'`
7
- - Document all files globbed according to:
8
- - classes: document the entire class and each of its functions including always including the @description tag with a short description of the target, and a@summary tag with a more detailed one.
9
- Include @class tags when applicable.
10
- include @param tags in the class documentation and its type definitions
11
- Include detailed @description for all properties.
12
- Include @template tags when necessary.
13
- Do NOT document the constructor, but include the constructor arguments as @param in the class documentation
14
- For methods and functions:
15
- - include @description and @summary tags as defined for the target. also document every argument, including its type definition, and return type, referencing @template tags when necessary.
16
- - create a usage example under the @example tag on the class documentation
17
- - create mermaid sequence diagrams under the @mermaid tag;
18
-
19
- The order of tags (when applicable) should be as follows:
20
- 1 - @description;
21
- 2 - @summary;
22
- 3 - @template;
23
- 4 - @param;
24
- 5 - @return;
25
- 6 - @class
26
- 7 - @example
27
- 8 - @mermaid;
28
-
29
- ignore @mermaid for methods with less that 15 lines and constructors.
30
- Respond only with the full JSDoc comment block for the class and its methods.
31
- NEVER user @memberOf in the class or any of it's methods
32
- if the element is already documented, only restructure, correct, or add to the documentation. NEVER remove existing information
33
- never omit or change any code, including the constructor
34
-
35
- - interfaces and types: document the target code, always including the @description tag with a short description of the target, and a@summary tag with a more detailed one.
36
- Include @interface and @typeDef an @template tags when appropriate.
37
- Include detailed @description for all properties.
38
- For methods, include @description and @summary tags as defined for the target. also document every argument, including its type definition, and return type, referencing @template tags when necessary.
39
-
40
- The order of tags (when applicable) should be as follows:
41
- 1 - @description;
42
- 2 - @summary;
43
- 3 - @template;
44
- 4 - @param;
45
- 5 - @return;
46
- 6 - @interface or @typeDef followed by the interface or type name;
47
- 8 - @memberOf referencing the appropriate module using the appropriate syntax
48
-
49
- Output only the completed JSDoc comment block for the type or interface.
50
- refer to the module it belongs with @memberOf this the `@memberOf module:<module_name>` syntax
51
- never omit or change any code
52
- if the element is already documented, only restructure, correct, or add to the documentation. NEVER remove existing information
53
-
54
- - functions: document the target code, always including the @description tag with a short description of the target, and a@summary tag with a more detailed one.
55
- Include @function an @template tags when appropriate.
56
- Include detailed @description for all properties.
57
- For methods, include @description and @summary tags as defined for the target. also document every argument, including its type definition, and return type, referencing @template tags when necessary.
58
- create mermaid sequence diagrams under the @mermaid tag;
59
-
60
- The order of tags (when applicable) should be as follows:
61
- 1 - @description;
62
- 2 - @summary;
63
- 3 - @template;
64
- 4 - @param including type definitions;
65
- 5 - @return;
66
- 6 - @function followed by the interface or type name;
67
- 7 - @mermaid with the sequence diagram for the function if ithas over 10 lines
68
- 8 - @memberOf referencing the appropriate module using the appropriate syntax
69
-
70
- Output only the full JSDoc comment block for the function.
71
- refer to the module it belongs with @memberOf this the `@memberOf module:<module_name>` syntax
72
- never omit or change any code
73
- if the element is already documented, only restructure, correct, or add to the documentation. NEVER remove existing information
74
-
75
- - document the target code, always including the @description tag with a short description of the target, and a@summary tag with a more detailed one.
76
- Include @const and @typeDef tags when appropriate.
77
- Include detailed @description for all properties.
78
- - For enums, include @enum and @readonly, and add inline documentation for each member
79
- - For object-like constants:
80
- - Create a @typedef with @property for each key
81
- - Reference it in the constant using @type
82
- - Alternatively, document each key inline if small
83
-
84
- The order of tags (when applicable) should be as follows:
85
- 1 - @description;
86
- 2 - @summary;
87
- 3 - @template;
88
- 4 - @property;
89
- 6 - @const followed by the const or enum name;
90
- 8 - @memberOf referencing the appropriate module using the appropriate syntax
91
-
92
- Respond with the JSDoc comment block(s) for both the typedef and the constant or enum.
93
- refer to the module it belongs with @memberOf this the `@memberOf module:<module_name>` syntax
94
- never omit or change any code
95
- if the element is already documented, only restructure, correct, or add to the documentation. NEVER remove existing information
96
-
97
- if the file is `src/index.ts`: Generate a JSDoc comment block for a TypeScript module file using better-docs formatting:
98
- - Add @module with the name of the module
99
- - Add @description and @summary
100
- - Do NOT document individual exports
101
- - The summary should explain the role of the module and what it exposes (classes, utils, etc.)
102
- - Include references to key exported objects using @link where appropriate
103
-
104
- Respond with only the JSDoc block for the module file.
105
- never omit or change any code
106
- if the element is already documented, only restructure, correct, or add to the documentation. NEVER remove existing information
107
-
108
- respond upon completion without additional input
109
- ```
110
-
111
- - Bulk Examples
112
- ```
113
- - find all code files using `find ./src -type f -name '*.ts'``
114
- - for each file, identify all classes and functions;
115
- - from the identified elements, elaborate a short summary of the intent of the library and write in `workdocs/1-Header.md` under the banner and title
116
- - from the identified elements, elaborate a detailed description of the intent of the library and write in `workdocs/4-Description.md` under the title
117
- - write examples in the `workdocs/5-HowToUse.md` file for all the identified elements
118
- - each exaple MUST contain:
119
- - Description of the use case;
120
- - typescript example using the appropriate typescript code notation in md format
121
- stop only when the task is done
122
- ```
@@ -1,47 +0,0 @@
1
- ### 'Self' Builder design pattern
2
-
3
- - Select all attributes and:
4
- ```
5
- generate setters for all selected attributes where all of them return the instance itself.
6
- ```
7
- ### Builder design pattern
8
-
9
- - Select all attributes and:
10
- ```
11
- generate setters for all selected attributes where all of them return the instance itself.
12
- also create a `build` method
13
- ```
14
-
15
-
16
- ### Port JS to TS
17
-
18
- ```
19
- you are:
20
- - a seasoned typescript developer with a background in javascript.
21
- you have:
22
- - delivered numerous javascript and typescript projects.
23
- you are:
24
- - detail oriented: you will review your results 2 times until you are sure everything is perfect;
25
- - optimized: you will optimize your work in te best posible manner, eg making shallow clones of repos when the whole history is not required;
26
- - professional: you will take your time to ensure the best possible results
27
- your task:
28
- - porting the entire pskcrypto library to typescript (located at https://github.com/OpenDSU/pskcrypto).
29
- include:
30
- - file extension conversion;
31
- - including types in variable declaratios;
32
- - update module imports exports to typescript convention;
33
- - handle all commonJS to ESM transitions;
34
- - ensure all code is valid typescript;
35
- - include documentation for all classes, methods, functions, interfaces, constants and types.
36
-
37
- please do the whole module in one go
38
-
39
- Do not bother explaining.
40
-
41
- Make sure to output only the full content of every javascript code file in the repository, transformed to typescript.
42
-
43
- Please estimate the time you will take in this task and confirm with me before starting.
44
-
45
- Do not bother explaining your process. i just want the results.
46
-
47
- ```
@@ -1,146 +0,0 @@
1
- ## Prompts to generate decent documentation
2
-
3
- ### Root index file /ts-doc-root
4
- - scopes: file, workspace
5
- ```
6
- You're a senior TypeScript developer writing JSDoc documentation for a class to be used with better-docs. Given the module code:
7
- Generate a JSDoc comment block for a TypeScript module file using better-docs formatting:
8
- - Add @module with the name of the module
9
- - Add @description and @summary
10
- - Do NOT document individual exports
11
- - The summary should explain the role of the module and what it exposes (classes, utils, etc.)
12
- - Include references to key exported objects using @link where appropriate
13
-
14
- Respond with only the JSDoc block for the module file.
15
- never omit or change any code
16
- if the element is already documented, only restructure, correct, or add to the documentation. NEVER remove existing information
17
- respond upon completion without additional input
18
- ```
19
-
20
-
21
- ### Classes /ts-doc-classes
22
-
23
- ```
24
- Act as a seasoned typescript developer.
25
- document the entire class and each of its functions including always including the @description tag with a short description of the target, and a@summary tag with a more detailed one.
26
- Include @class tags when applicable.
27
- include @param tags in the class documentation and its type definitions
28
- Include detailed @description for all properties.
29
- Include @template tags when necessary.
30
- Do NOT document the constructor, but include the constructor arguments as @param in the class documentation
31
- For methods and functions:
32
- - include @description and @summary tags as defined for the target. also document every argument, including its type definition, and return type, referencing @template tags when necessary.
33
- - create a usage example under the @example tag on the class documentation
34
- - create mermaid sequence diagrams under the @mermaid tag;
35
-
36
- The order of tags (when applicable) should be as follows:
37
- 1 - @description;
38
- 2 - @summary;
39
- 3 - @template;
40
- 4 - @param;
41
- 5 - @return;
42
- 6 - @class
43
- 7 - @example
44
- 8 - @mermaid;
45
-
46
- ignore @mermaid for methods with less that 15 lines and constructors.
47
- Respond only with the full JSDoc comment block for the class and its methods.
48
- NEVER user @memberOf in the class or any of it's methods
49
- if the element is already documented, only restructure, correct, or add to the documentation. NEVER remove existing information
50
- never omit or change any code, including the constructor
51
- ```
52
-
53
- ### Interfaces and Types /ts-doc-types
54
-
55
- ```
56
- Act as a seasoned typescript developer.
57
- document the target code, always including the @description tag with a short description of the target, and a@summary tag with a more detailed one.
58
- Include @interface and @typeDef an @template tags when appropriate.
59
- Include detailed @description for all properties.
60
- For methods, include @description and @summary tags as defined for the target. also document every argument, including its type definition, and return type, referencing @template tags when necessary.
61
-
62
- The order of tags (when applicable) should be as follows:
63
- 1 - @description;
64
- 2 - @summary;
65
- 3 - @template;
66
- 4 - @param;
67
- 5 - @return;
68
- 6 - @interface or @typeDef followed by the interface or type name;
69
- 8 - @memberOf referencing the appropriate module using the appropriate syntax
70
-
71
- Output only the completed JSDoc comment block for the type or interface.
72
- refer to the module it belongs with @memberOf this the `@memberOf module:<module_name>` syntax
73
- never omit or change any code
74
- if the element is already documented, only restructure, correct, or add to the documentation. NEVER remove existing information
75
- ```
76
-
77
- ### Functions /ts-doc-functions
78
-
79
- ```
80
- Act as a seasoned typescript developer.
81
- document the target code, always including the @description tag with a short description of the target, and a@summary tag with a more detailed one.
82
- Include @function an @template tags when appropriate.
83
- Include detailed @description for all properties.
84
- For methods, include @description and @summary tags as defined for the target. also document every argument, including its type definition, and return type, referencing @template tags when necessary.
85
- create mermaid sequence diagrams under the @mermaid tag;
86
-
87
- The order of tags (when applicable) should be as follows:
88
- 1 - @description;
89
- 2 - @summary;
90
- 3 - @template;
91
- 4 - @param including type definitions;
92
- 5 - @return;
93
- 6 - @function followed by the interface or type name;
94
- 7 - @mermaid with the sequence diagram for the function if ithas over 10 lines
95
- 8 - @memberOf referencing the appropriate module using the appropriate syntax
96
-
97
- Output only the full JSDoc comment block for the function.
98
- refer to the module it belongs with @memberOf this the `@memberOf module:<module_name>` syntax
99
- never omit or change any code
100
- if the element is already documented, only restructure, correct, or add to the documentation. NEVER remove existing information
101
-
102
- ```
103
-
104
-
105
- ### Constants and Enums /ts-doc-const
106
-
107
- ```
108
- Act as a seasoned typescript developer.
109
- document the target code, always including the @description tag with a short description of the target, and a@summary tag with a more detailed one.
110
- Include @const and @typeDef tags when appropriate.
111
- Include detailed @description for all properties.
112
- - For enums, include @enum and @readonly, and add inline documentation for each member
113
- - For object-like constants:
114
- - Create a @typedef with @property for each key
115
- - Reference it in the constant using @type
116
- - Alternatively, document each key inline if small
117
-
118
- The order of tags (when applicable) should be as follows:
119
- 1 - @description;
120
- 2 - @summary;
121
- 3 - @template;
122
- 4 - @property;
123
- 6 - @const followed by the const or enum name;
124
- 8 - @memberOf referencing the appropriate module using the appropriate syntax
125
-
126
- Respond with the JSDoc comment block(s) for both the typedef and the constant or enum.
127
- refer to the module it belongs with @memberOf this the `@memberOf module:<module_name>` syntax
128
- never omit or change any code
129
- if the element is already documented, only restructure, correct, or add to the documentation. NEVER remove existing information
130
- ```
131
-
132
- ### Scripts /ts-doc-scripts
133
-
134
- ```
135
- You're a senior TypeScript developer writing JSDoc documentation for a command line script to be used with better-docs:
136
- document the target script, always including the @description tag with a short description of its purpose, and a@summary tag with a more detailed one.
137
- Include descriptions for the various arguments it acceppts
138
- Include detailed @description for all functions.
139
- Include @mermaid with the sequence diagram for the function if ithas over 10 lines
140
- Use @link for references to other objects or types
141
-
142
- Output only the full JSDoc comment block for the function.
143
- refer to the module it belongs with @memberOf this the `@memberOf module:<module_name>` syntax
144
- never omit or change any code
145
- if the element is already documented, only restructure, correct, or add to the documentation. NEVER remove existing information
146
- ```
@@ -1,11 +0,0 @@
1
- ### UML coloring
2
-
3
- - Select uml and:
4
- ```
5
- colorize this uml chart:
6
- - use pastel colors;
7
- - all colors should be defined inline;
8
- - use the colour name or hex value;
9
- - repeated elements must have the same color
10
- - ensure a pleasing aesthetic
11
- ```
@@ -1,6 +0,0 @@
1
- {
2
- "build": "./README.md",
3
- "files": [
4
- "./workdocs/Readme.md"
5
- ]
6
- }
@@ -1,12 +0,0 @@
1
- # Changelog
2
-
3
- ## v0.0.47 → next (2025-11-26)
4
-
5
- ### New Features
6
- No DECAF tickets were merged for new features since the last tag.
7
-
8
- ### Fixed Bugs
9
- No DECAF tickets were merged for bug fixes since the last tag.
10
-
11
- ### Breaking Changes
12
- - DECAF-178: remove unused test files and refactor imports to clean up test suite | Merge branch 'refs/heads/' into 2 | update | Merge branch 'master' into 2