@futdevpro/nts-dynamo 1.15.151 → 1.15.154

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 (655) hide show
  1. package/.c8rc.json +26 -26
  2. package/.copilot/patterns.json +7 -7
  3. package/.cursor/rules/__assistant_guide.mdc +30 -30
  4. package/.cursor/rules/__main.mdc +64 -64
  5. package/.cursor/rules/_ag_backend-structure.mdc +85 -85
  6. package/.cursor/rules/_ag_backend.mdc +16 -16
  7. package/.cursor/rules/_ag_debug.mdc +7 -7
  8. package/.cursor/rules/_ag_documentation_writing_rules.mdc +372 -372
  9. package/.cursor/rules/_ag_file-refactoring.mdc +113 -113
  10. package/.cursor/rules/_ag_fixes_rules.mdc +5 -5
  11. package/.cursor/rules/_ag_frontend-structure.mdc +86 -86
  12. package/.cursor/rules/_ag_frontend.mdc +39 -39
  13. package/.cursor/rules/_ag_import-rules.mdc +44 -44
  14. package/.cursor/rules/_ag_naming.mdc +115 -115
  15. package/.cursor/rules/_ag_running_commands.mdc +4 -4
  16. package/.cursor/rules/_ag_server-controller.mdc +5 -5
  17. package/.cursor/rules/_ag_should-be.mdc +6 -6
  18. package/.cursor/rules/_ag_swearing.mdc +47 -47
  19. package/.cursor/rules/ai_development_guide.md +60 -60
  20. package/.cursor/rules/ai_directives.md +114 -114
  21. package/.cursor/rules/cursor-rules.md +160 -160
  22. package/.cursor/rules/default-command.mdc +464 -464
  23. package/.cursor/rules/error_code_pattern.md +39 -39
  24. package/.cursor/rules/saved rule mcp server use.md +15 -15
  25. package/.dynamo/pipeline.cicd.config.json +190 -190
  26. package/.dynamo/version-bump.config.json +5 -5
  27. package/.github/workflows/main.yml +438 -438
  28. package/.husky/pre-commit +3 -3
  29. package/.vscode/settings.json +10 -10
  30. package/HOWTO.md +15 -15
  31. package/LICENSE +21 -21
  32. package/README.md +790 -749
  33. package/__documentations/2026-04-28-logs-module.md +49 -49
  34. package/__documentations/2026-05-17-oai-compatible-providers.md +229 -229
  35. package/__documentations/2026-05-17-static-client-serving-howto.md +144 -144
  36. package/__documentations/2026-06-01-fr041-cors-middleware.md +96 -96
  37. package/__documentations/2026-06-01-fr047-p2p3-function-calling.md +81 -81
  38. package/__documentations/2026-06-15-fr193-memory-guard.md +73 -73
  39. package/__documentations/2026-08-08-fr292-app-version-header.md +38 -38
  40. package/__documentations/2026-08-14-field-encryption-mongoose-document-spread.md +124 -124
  41. package/__documentations/2026-08-18-artifact-compiler.md +46 -46
  42. package/__documentations/2026-08-18-mongo-transaction-control-service.md +82 -82
  43. package/__documentations/2026-08-18-standalone-account-security-and-privacy-bedrock.md +132 -132
  44. package/__documentations/2026-08-21-distributed-rate-limit-bfr-ctm-010.md +59 -59
  45. package/__documentations/2026-08-22-content-free-process-error-boundary.md +91 -0
  46. package/__documentations/2026-08-22-npm-token-state-classifier.md +92 -92
  47. package/__documentations/nts-integration-tests-2026-03-17.md +26 -26
  48. package/__documentations/plans/BEDROCK-HYPERPLAN.md +95 -95
  49. package/_specifications/BACKLOG.md +92 -92
  50. package/_specifications/TODO.md +15 -15
  51. package/_specifications/agent.md +138 -138
  52. package/build/_models/control-models/app-params.control-model.d.ts.map +1 -1
  53. package/build/_models/control-models/app-params.control-model.js +1 -2
  54. package/build/_models/control-models/app-params.control-model.js.map +1 -1
  55. package/build/_modules/server/index.d.ts +8 -0
  56. package/build/_modules/server/index.d.ts.map +1 -1
  57. package/build/_modules/server/index.js +9 -0
  58. package/build/_modules/server/index.js.map +1 -1
  59. package/build/_modules/server/safe-diagnostic/safe-diagnostic-cause.type-enum.d.ts +9 -0
  60. package/build/_modules/server/safe-diagnostic/safe-diagnostic-cause.type-enum.d.ts.map +1 -0
  61. package/build/_modules/server/safe-diagnostic/safe-diagnostic-cause.type-enum.js +13 -0
  62. package/build/_modules/server/safe-diagnostic/safe-diagnostic-cause.type-enum.js.map +1 -0
  63. package/build/_modules/server/safe-diagnostic/safe-diagnostic-stage.type-enum.d.ts +20 -0
  64. package/build/_modules/server/safe-diagnostic/safe-diagnostic-stage.type-enum.d.ts.map +1 -0
  65. package/build/_modules/server/safe-diagnostic/safe-diagnostic-stage.type-enum.js +24 -0
  66. package/build/_modules/server/safe-diagnostic/safe-diagnostic-stage.type-enum.js.map +1 -0
  67. package/build/_modules/server/safe-diagnostic/safe-diagnostic.control-service.d.ts +19 -0
  68. package/build/_modules/server/safe-diagnostic/safe-diagnostic.control-service.d.ts.map +1 -0
  69. package/build/_modules/server/safe-diagnostic/safe-diagnostic.control-service.js +83 -0
  70. package/build/_modules/server/safe-diagnostic/safe-diagnostic.control-service.js.map +1 -0
  71. package/build/_modules/server/safe-diagnostic/safe-diagnostic.interface.d.ts +19 -0
  72. package/build/_modules/server/safe-diagnostic/safe-diagnostic.interface.d.ts.map +1 -0
  73. package/build/_modules/server/safe-diagnostic/safe-diagnostic.interface.js +3 -0
  74. package/build/_modules/server/safe-diagnostic/safe-diagnostic.interface.js.map +1 -0
  75. package/build/_modules/server/server-status/db-readiness-probe-code.type-enum.d.ts +14 -0
  76. package/build/_modules/server/server-status/db-readiness-probe-code.type-enum.d.ts.map +1 -0
  77. package/build/_modules/server/server-status/db-readiness-probe-code.type-enum.js +18 -0
  78. package/build/_modules/server/server-status/db-readiness-probe-code.type-enum.js.map +1 -0
  79. package/build/_modules/server/server-status/db-readiness-probe-stage.type-enum.d.ts +8 -0
  80. package/build/_modules/server/server-status/db-readiness-probe-stage.type-enum.d.ts.map +1 -0
  81. package/build/_modules/server/server-status/db-readiness-probe-stage.type-enum.js +12 -0
  82. package/build/_modules/server/server-status/db-readiness-probe-stage.type-enum.js.map +1 -0
  83. package/build/_modules/server/server-status/db-readiness-probe.control-service.d.ts +14 -0
  84. package/build/_modules/server/server-status/db-readiness-probe.control-service.d.ts.map +1 -0
  85. package/build/_modules/server/server-status/db-readiness-probe.control-service.js +126 -0
  86. package/build/_modules/server/server-status/db-readiness-probe.control-service.js.map +1 -0
  87. package/build/_modules/server/server-status/db-readiness-probe.interface.d.ts +18 -0
  88. package/build/_modules/server/server-status/db-readiness-probe.interface.d.ts.map +1 -0
  89. package/build/_modules/server/server-status/db-readiness-probe.interface.js +3 -0
  90. package/build/_modules/server/server-status/db-readiness-probe.interface.js.map +1 -0
  91. package/build/_services/core/global.service.d.ts +3 -3
  92. package/build/_services/core/global.service.d.ts.map +1 -1
  93. package/build/_services/core/global.service.js +24 -18
  94. package/build/_services/core/global.service.js.map +1 -1
  95. package/build/_services/server/app.server.d.ts +2 -0
  96. package/build/_services/server/app.server.d.ts.map +1 -1
  97. package/build/_services/server/app.server.js +71 -199
  98. package/build/_services/server/app.server.js.map +1 -1
  99. package/eslint.config.js +3 -3
  100. package/nodemon.json +24 -24
  101. package/package.json +1 -1
  102. package/pnpm-workspace.yaml +6 -6
  103. package/scripts/_seed-out/aim-seed.fixtures.ts +161 -161
  104. package/scripts/_seed-out/llm-expand-raw.json +59 -59
  105. package/scripts/_seed-out/seed-raw.json +152 -152
  106. package/scripts/ai-fixture-seed.js +126 -126
  107. package/scripts/run-coverage-tests.js +28 -28
  108. package/spec/support/helpers/spec-reporter-loader.js +359 -359
  109. package/spec/support/helpers/ts-node-helper.js +93 -93
  110. package/spec/support/jasmine.coverage.json +24 -24
  111. package/spec/support/jasmine.json +24 -24
  112. package/src/_collections/app-version-header.util.spec.ts +108 -108
  113. package/src/_collections/app-version-header.util.ts +74 -74
  114. package/src/_collections/archive-service-registry.const.ts +21 -21
  115. package/src/_collections/archive.util.spec.ts +57 -57
  116. package/src/_collections/archive.util.ts +18 -18
  117. package/src/_collections/atlas-default-db-options.const.ts +9 -9
  118. package/src/_collections/client-safe-error.util.spec.ts +151 -151
  119. package/src/_collections/client-safe-error.util.ts +107 -107
  120. package/src/_collections/default-fallback-cache-max-age.const.spec.ts +11 -11
  121. package/src/_collections/default-fallback-cache-max-age.const.ts +2 -2
  122. package/src/_collections/default-not-found-page.const.spec.ts +19 -19
  123. package/src/_collections/default-not-found-page.const.ts +22 -22
  124. package/src/_collections/default-socket-path.const.spec.ts +12 -12
  125. package/src/_collections/default-socket-path.const.ts +2 -2
  126. package/src/_collections/field-encryption.util.spec.ts +195 -195
  127. package/src/_collections/field-encryption.util.ts +222 -222
  128. package/src/_collections/get-environment-settings.util.spec.ts +210 -210
  129. package/src/_collections/get-environment-settings.util.ts +48 -48
  130. package/src/_collections/global-settings.const.ts +126 -126
  131. package/src/_collections/load-shed.util.spec.ts +62 -62
  132. package/src/_collections/load-shed.util.ts +51 -51
  133. package/src/_collections/mongo-reconnect-guard.util.spec.ts +52 -52
  134. package/src/_collections/mongo-reconnect-guard.util.ts +172 -172
  135. package/src/_collections/npm-token-check.util.spec.ts +218 -218
  136. package/src/_collections/npm-token-check.util.ts +327 -327
  137. package/src/_collections/sample.env +21 -21
  138. package/src/_collections/security-headers.util.spec.ts +98 -98
  139. package/src/_collections/security-headers.util.ts +96 -96
  140. package/src/_collections/signed-url.util.spec.ts +198 -198
  141. package/src/_collections/signed-url.util.ts +170 -170
  142. package/src/_collections/star.controller.spec.ts +224 -224
  143. package/src/_collections/star.controller.ts +129 -129
  144. package/src/_collections/static-cache-control.util.spec.ts +47 -47
  145. package/src/_collections/static-cache-control.util.ts +25 -25
  146. package/src/_enums/data-model-type.enum.ts +14 -14
  147. package/src/_enums/data-service-function.enum.ts +24 -24
  148. package/src/_enums/predefined-data-types.enum.ts +16 -16
  149. package/src/_enums/route-security.enum.ts +12 -12
  150. package/src/_models/control-models/api-call-params.control-model.spec.ts +152 -152
  151. package/src/_models/control-models/api-call-params.control-model.ts +142 -142
  152. package/src/_models/control-models/app-ext-system-controls.control-model.spec.ts +52 -52
  153. package/src/_models/control-models/app-ext-system-controls.control-model.ts +9 -9
  154. package/src/_models/control-models/app-params.control-model.spec.ts +213 -209
  155. package/src/_models/control-models/app-params.control-model.ts +130 -129
  156. package/src/_models/control-models/app-system-controls.control-model.spec.ts +31 -31
  157. package/src/_models/control-models/app-system-controls.control-model.ts +9 -9
  158. package/src/_models/control-models/endpoint-params.control-model.spec.ts +669 -669
  159. package/src/_models/control-models/endpoint-params.control-model.ts +664 -664
  160. package/src/_models/control-models/http-settings.control-model.spec.ts +77 -77
  161. package/src/_models/control-models/http-settings.control-model.ts +37 -37
  162. package/src/_models/control-models/system-control.control-model.spec.ts +27 -27
  163. package/src/_models/control-models/system-control.control-model.ts +12 -12
  164. package/src/_models/data-models/schema-migration.data-model.ts +50 -50
  165. package/src/_models/interfaces/app-version-header-settings.interface.ts +17 -17
  166. package/src/_models/interfaces/certification-settings.interface.ts +7 -7
  167. package/src/_models/interfaces/compare-data-options.interface.ts +27 -27
  168. package/src/_models/interfaces/compare-data-result.interface.ts +12 -12
  169. package/src/_models/interfaces/cors-settings.interface.spec.ts +52 -52
  170. package/src/_models/interfaces/cors-settings.interface.ts +56 -56
  171. package/src/_models/interfaces/db-query-options.interface.ts +33 -33
  172. package/src/_models/interfaces/environment-settings.interface.ts +59 -59
  173. package/src/_models/interfaces/global-log-settings.interface.ts +171 -171
  174. package/src/_models/interfaces/global-service-settings.interface.ts +47 -47
  175. package/src/_models/interfaces/global-settings.interface.ts +294 -294
  176. package/src/_models/interfaces/migration-entry.interface.ts +19 -19
  177. package/src/_models/interfaces/mongo-transaction-settings.interface.ts +9 -9
  178. package/src/_models/interfaces/routing-module-settings.interface.ts +21 -21
  179. package/src/_models/interfaces/security-headers-settings.interface.ts +50 -50
  180. package/src/_models/interfaces/signed-url-verify-result.interface.ts +13 -13
  181. package/src/_models/interfaces/static-client-settings.interface.spec.ts +29 -29
  182. package/src/_models/interfaces/static-client-settings.interface.ts +36 -36
  183. package/src/_models/types/db-update.type.ts +100 -100
  184. package/src/_modules/account-security/_enums/account-challenge-purpose.type-enum.ts +5 -5
  185. package/src/_modules/account-security/_enums/account-refresh-token-state.type-enum.ts +6 -6
  186. package/src/_modules/account-security/_enums/account-session-state.type-enum.ts +6 -6
  187. package/src/_modules/account-security/_models/account-challenge-adapter.interface.ts +17 -17
  188. package/src/_modules/account-security/_models/account-challenge-issued.interface.ts +6 -6
  189. package/src/_modules/account-security/_models/account-challenge-record.interface.ts +13 -13
  190. package/src/_modules/account-security/_models/account-challenge-result.interface.ts +8 -8
  191. package/src/_modules/account-security/_models/account-challenge-settings.interface.ts +9 -9
  192. package/src/_modules/account-security/_models/account-password-policy.interface.ts +11 -11
  193. package/src/_modules/account-security/_models/account-password-verification.interface.ts +5 -5
  194. package/src/_modules/account-security/_models/account-refresh-token-record.interface.ts +13 -13
  195. package/src/_modules/account-security/_models/account-session-adapter.interface.ts +19 -19
  196. package/src/_modules/account-security/_models/account-session-claims.interface.ts +7 -7
  197. package/src/_modules/account-security/_models/account-session-context.interface.ts +6 -6
  198. package/src/_modules/account-security/_models/account-session-create.interface.ts +8 -8
  199. package/src/_modules/account-security/_models/account-session-record.interface.ts +21 -21
  200. package/src/_modules/account-security/_models/account-session-rotate.interface.ts +11 -11
  201. package/src/_modules/account-security/_models/account-session-settings.interface.ts +11 -11
  202. package/src/_modules/account-security/_models/account-session-token-pair.interface.ts +8 -8
  203. package/src/_modules/account-security/_models/account-session-view.interface.ts +13 -13
  204. package/src/_modules/account-security/account-challenge.control-service.spec.ts +195 -195
  205. package/src/_modules/account-security/account-challenge.control-service.ts +164 -164
  206. package/src/_modules/account-security/account-password.control-service.spec.ts +96 -96
  207. package/src/_modules/account-security/account-password.control-service.ts +288 -288
  208. package/src/_modules/account-security/account-session.control-service.spec.ts +294 -294
  209. package/src/_modules/account-security/account-session.control-service.ts +376 -376
  210. package/src/_modules/account-security/index.ts +31 -31
  211. package/src/_modules/admin-auth/_models/admin-api-key-config.interface.ts +33 -33
  212. package/src/_modules/admin-auth/admin-api-key.auth-service.spec.ts +200 -200
  213. package/src/_modules/admin-auth/admin-api-key.auth-service.ts +220 -220
  214. package/src/_modules/admin-auth/index.ts +2 -2
  215. package/src/_modules/ai/_collections/ai-model-config-validator.util.spec.ts +150 -150
  216. package/src/_modules/ai/_collections/ai-model-config-validator.util.ts +131 -131
  217. package/src/_modules/ai/_collections/ai-provider-error.util.ts +144 -144
  218. package/src/_modules/ai/_models/ai-input-interfaces.ts +117 -117
  219. package/src/_modules/ai/_models/ai-test-generation-result.interface.ts +16 -16
  220. package/src/_modules/ai/_models/interfaces/dynts-ai-cost-event-callback.interface.ts +14 -14
  221. package/src/_modules/ai/_models/interfaces/dynts-ai-cost-event.interface.ts +56 -56
  222. package/src/_modules/ai/_models/interfaces/dynts-ai-provider-error.interface.ts +16 -16
  223. package/src/_modules/ai/_modules/ai-mock/_collections/aim-default-collection.util.spec.ts +72 -72
  224. package/src/_modules/ai/_modules/ai-mock/_collections/aim-default-collection.util.ts +71 -71
  225. package/src/_modules/ai/_modules/ai-mock/_collections/aim-fixture-match.util.spec.ts +57 -57
  226. package/src/_modules/ai/_modules/ai-mock/_collections/aim-fixture-match.util.ts +60 -60
  227. package/src/_modules/ai/_modules/ai-mock/_collections/aim-fixture-serializer.util.spec.ts +56 -56
  228. package/src/_modules/ai/_modules/ai-mock/_collections/aim-fixture-serializer.util.ts +117 -117
  229. package/src/_modules/ai/_modules/ai-mock/_enums/aim-modality.enum.ts +28 -28
  230. package/src/_modules/ai/_modules/ai-mock/_models/interfaces/aim-call-input.interface.ts +14 -14
  231. package/src/_modules/ai/_modules/ai-mock/_models/interfaces/aim-error.interface.ts +11 -11
  232. package/src/_modules/ai/_modules/ai-mock/_models/interfaces/aim-fixture.interface.ts +30 -30
  233. package/src/_modules/ai/_modules/ai-mock/_models/interfaces/aim-request.interface.ts +19 -19
  234. package/src/_modules/ai/_modules/ai-mock/_models/interfaces/aim-service-collection.interface.ts +20 -20
  235. package/src/_modules/ai/_modules/ai-mock/_services/ai-embedding-mock.service.spec.ts +115 -115
  236. package/src/_modules/ai/_modules/ai-mock/_services/ai-embedding-mock.service.ts +233 -233
  237. package/src/_modules/ai/_modules/ai-mock/_services/aim-fixture-harness.service.spec.ts +134 -134
  238. package/src/_modules/ai/_modules/ai-mock/_services/aim-fixture-harness.service.ts +127 -127
  239. package/src/_modules/ai/_modules/ai-mock/_services/aim-fixture-pipeline.spec.ts +105 -105
  240. package/src/_modules/ai/_modules/ai-mock/_services/aim-fixture-store.service.spec.ts +50 -50
  241. package/src/_modules/ai/_modules/ai-mock/_services/aim-fixture-store.service.ts +65 -65
  242. package/src/_modules/ai/_modules/ai-mock/_services/aim-integration-proof.spec.ts +92 -92
  243. package/src/_modules/ai/_modules/ai-mock/_services/aim-mock.service.spec.ts +112 -112
  244. package/src/_modules/ai/_modules/ai-mock/_services/aim-mock.service.ts +155 -155
  245. package/src/_modules/ai/_modules/ai-mock/fixtures/aim-text.fixtures.ts +649 -649
  246. package/src/_modules/ai/_modules/ai-mock/index.ts +47 -47
  247. package/src/_modules/ai/_modules/anthropic/_services/aai-user-key.control-service.ts +138 -138
  248. package/src/_modules/ai/_modules/anthropic/index.ts +5 -5
  249. package/src/_modules/ai/_modules/document-ai/_collections/dai-chunking.util.spec.ts +242 -242
  250. package/src/_modules/ai/_modules/document-ai/_collections/dai-chunking.util.ts +639 -639
  251. package/src/_modules/ai/_modules/document-ai/_collections/dai-code-chunking.util.spec.ts +295 -295
  252. package/src/_modules/ai/_modules/document-ai/_collections/dai-code-chunking.util.ts +552 -552
  253. package/src/_modules/ai/_modules/document-ai/_collections/dai-document.util.spec.ts +209 -209
  254. package/src/_modules/ai/_modules/document-ai/_collections/dai-document.util.ts +85 -85
  255. package/src/_modules/ai/_modules/document-ai/_enums/dai-compare-result-type.enum.ts +7 -7
  256. package/src/_modules/ai/_modules/document-ai/_models/data-models/dai-doc-chunk.data-model.ts +146 -146
  257. package/src/_modules/ai/_modules/document-ai/_models/data-models/dai-doc-page.data-model.ts +162 -162
  258. package/src/_modules/ai/_modules/document-ai/_models/data-models/dai-document.data-model.ts +99 -99
  259. package/src/_modules/ai/_modules/document-ai/_models/interfaces/dai-code-chunk.interface.ts +68 -68
  260. package/src/_modules/ai/_modules/document-ai/_models/interfaces/dai-doc-chunk-compare-result.interface.ts +18 -18
  261. package/src/_modules/ai/_modules/document-ai/_models/interfaces/dai-doc-page-compare-result.interface.ts +19 -19
  262. package/src/_modules/ai/_modules/document-ai/_models/interfaces/dai-document-compare-result.interface.ts +25 -25
  263. package/src/_modules/ai/_modules/document-ai/index.ts +30 -30
  264. package/src/_modules/ai/_modules/fdp-ai/_services/fdpai-user-key.control-service.ts +189 -189
  265. package/src/_modules/ai/_modules/fdp-ai/index.ts +5 -5
  266. package/src/_modules/ai/_modules/open-ai/_collections/oai-global-settings.const.ts +9 -9
  267. package/src/_modules/ai/_modules/open-ai/_collections/oai-llm-predefined-requests-hu.conts.ts +82 -82
  268. package/src/_modules/ai/_modules/open-ai/_collections/oai-llm-predefined-requests.conts.ts +75 -75
  269. package/src/_modules/ai/_modules/open-ai/_enums/oai-gpt-message-role.enum.ts +45 -45
  270. package/src/_modules/ai/_modules/open-ai/_models/interfaces/oai-global-settings.interface.ts +7 -7
  271. package/src/_modules/ai/_modules/open-ai/_models/interfaces/oai-gpt-message.interface.ts +7 -7
  272. package/src/_modules/ai/_modules/open-ai/_models/interfaces/oai-llm-predefined-requests.interface.ts +57 -57
  273. package/src/_modules/ai/_modules/open-ai/_services/data-services/oai-doc-chunk-data.service.ts +292 -292
  274. package/src/_modules/ai/_modules/open-ai/_services/data-services/oai-doc-page.data-service.ts +572 -572
  275. package/src/_modules/ai/_modules/open-ai/_services/data-services/oai-document.data-service.spec.ts +342 -342
  276. package/src/_modules/ai/_modules/open-ai/_services/data-services/oai-document.data-service.ts +435 -435
  277. package/src/_modules/ai/_modules/open-ai/_services/data-services/oai-vector-data.service.spec.ts +550 -550
  278. package/src/_modules/ai/_modules/open-ai/_services/data-services/oai-vector-data.service.ts +630 -630
  279. package/src/_modules/ai/_modules/open-ai/_services/oai-embedding.control-service.spec.ts +332 -332
  280. package/src/_modules/ai/_modules/open-ai/_services/oai-embedding.control-service.ts +132 -132
  281. package/src/_modules/ai/_modules/open-ai/_services/oai-llm-chat.service-base.spec.ts +462 -462
  282. package/src/_modules/ai/_modules/open-ai/_services/oai-llm-chat.service-base.ts +634 -634
  283. package/src/_modules/ai/_modules/open-ai/_services/oai-llm.service-base.spec.ts +489 -489
  284. package/src/_modules/ai/_modules/open-ai/_services/oai-llm.service-base.tools.spec.ts +173 -173
  285. package/src/_modules/ai/_modules/open-ai/_services/oai-llm.service-base.ts +1085 -1085
  286. package/src/_modules/ai/_modules/open-ai/_services/oai-user-key.control-service.ts +157 -157
  287. package/src/_modules/ai/_modules/open-ai/index.ts +74 -74
  288. package/src/_modules/ai/_services/ai-embedding-provider.registry.spec.ts +110 -110
  289. package/src/_modules/ai/_services/ai-embedding-provider.registry.ts +114 -114
  290. package/src/_modules/ai/_services/ai-embedding.service-base.spec.ts +98 -98
  291. package/src/_modules/ai/_services/ai-embedding.service-base.ts +48 -48
  292. package/src/_modules/ai/_services/ai-llm-chat.service-base.spec.ts +229 -229
  293. package/src/_modules/ai/_services/ai-llm-chat.service-base.ts +68 -68
  294. package/src/_modules/ai/_services/ai-llm.service-base.reconciler.spec.ts +133 -133
  295. package/src/_modules/ai/_services/ai-llm.service-base.spec.ts +250 -250
  296. package/src/_modules/ai/_services/ai-llm.service-base.ts +599 -599
  297. package/src/_modules/ai/_services/ai-provider.service-base.spec.ts +158 -158
  298. package/src/_modules/ai/_services/ai-provider.service-base.ts +67 -67
  299. package/src/_modules/ai/_services/ai-user-key.service-base.ts +59 -59
  300. package/src/_modules/ai/_services/lmstudio-embedding.control-service.spec.ts +197 -197
  301. package/src/_modules/ai/_services/lmstudio-embedding.control-service.ts +399 -399
  302. package/src/_modules/ai/index.ts +33 -33
  303. package/src/_modules/artifact-compiler/_enums/artifact-compile-outcome.type-enum.ts +5 -5
  304. package/src/_modules/artifact-compiler/_enums/artifact-compile-stage.type-enum.ts +8 -8
  305. package/src/_modules/artifact-compiler/_enums/artifact-retry-class.type-enum.ts +6 -6
  306. package/src/_modules/artifact-compiler/_models/artifact-compile.interface.ts +35 -35
  307. package/src/_modules/artifact-compiler/artifact-compiler.control-service.spec.ts +151 -151
  308. package/src/_modules/artifact-compiler/artifact-compiler.control-service.ts +356 -356
  309. package/src/_modules/artifact-compiler/index.ts +9 -9
  310. package/src/_modules/assistant/_collections/ass-global-settings.const.ts +13 -13
  311. package/src/_modules/assistant/_collections/ass.util.spec.ts +176 -176
  312. package/src/_modules/assistant/_collections/ass.util.ts +50 -50
  313. package/src/_modules/assistant/_models/ass-global-settings.interface.ts +15 -15
  314. package/src/_modules/assistant/_services/ass-io.control-service.spec.ts +140 -140
  315. package/src/_modules/assistant/_services/ass-io.control-service.ts +74 -74
  316. package/src/_modules/assistant/_services/ass-main.control-service.spec.ts +192 -192
  317. package/src/_modules/assistant/_services/ass-main.control-service.ts +107 -107
  318. package/src/_modules/assistant/index.ts +19 -19
  319. package/src/_modules/bot/_collections/bot-default-commands.const.ts +12 -12
  320. package/src/_modules/bot/_collections/bot-global-settings.const.ts +39 -39
  321. package/src/_modules/bot/_models/bot-channel-wrapper.interface.ts +62 -62
  322. package/src/_modules/bot/_models/bot-command.interface.ts +8 -8
  323. package/src/_modules/bot/_models/bot-global-settings.interface.ts +96 -96
  324. package/src/_modules/bot/_models/bot-last-mention-date.interface.ts +6 -6
  325. package/src/_modules/bot/_models/bot-last-message-date.interface.ts +5 -5
  326. package/src/_modules/bot/_models/bot-message-wrapper.interface.ts +90 -90
  327. package/src/_modules/bot/_models/bot-user-wrapper.interface.ts +41 -41
  328. package/src/_modules/bot/_modules/discord-bot/_models/dib-platform.types.ts +9 -9
  329. package/src/_modules/bot/_modules/discord-bot/_services/dib-messaging-provider.control-service.spec.ts +431 -431
  330. package/src/_modules/bot/_modules/discord-bot/_services/dib-messaging-provider.control-service.ts +641 -641
  331. package/src/_modules/bot/_modules/discord-bot/index.ts +12 -12
  332. package/src/_modules/bot/_modules/dynamo-bot/_collections/dyb-operations.util.spec.ts +160 -160
  333. package/src/_modules/bot/_modules/dynamo-bot/_collections/dyb-operations.util.ts +55 -55
  334. package/src/_modules/bot/_modules/dynamo-bot/_models/dyb-platform.types.ts +15 -15
  335. package/src/_modules/bot/_modules/dynamo-bot/_services/dyb-messaging-provider.control-service.spec.ts +374 -374
  336. package/src/_modules/bot/_modules/dynamo-bot/_services/dyb-messaging-provider.control-service.ts +447 -447
  337. package/src/_modules/bot/_modules/dynamo-bot/index.ts +15 -15
  338. package/src/_modules/bot/_modules/slack-bot/_models/slb-platform.types.ts +9 -9
  339. package/src/_modules/bot/_modules/slack-bot/_services/slb-messaging-provider.control-service.spec.ts +344 -344
  340. package/src/_modules/bot/_modules/slack-bot/_services/slb-messaging-provider.control-service.ts +197 -197
  341. package/src/_modules/bot/_modules/slack-bot/index.ts +12 -12
  342. package/src/_modules/bot/_modules/teams-bot/_models/teb-platform.types.ts +9 -9
  343. package/src/_modules/bot/_modules/teams-bot/_services/teb-messaging-provider.control-service.spec.ts +345 -345
  344. package/src/_modules/bot/_modules/teams-bot/_services/teb-messaging-provider.control-service.ts +197 -197
  345. package/src/_modules/bot/_modules/teams-bot/index.ts +11 -11
  346. package/src/_modules/bot/_services/bot-commands.control-service.spec.ts +116 -116
  347. package/src/_modules/bot/_services/bot-commands.control-service.ts +158 -158
  348. package/src/_modules/bot/_services/bot-io.control-service.spec.ts +285 -285
  349. package/src/_modules/bot/_services/bot-io.control-service.ts +329 -329
  350. package/src/_modules/bot/_services/bot-main.control-service.spec.ts +208 -208
  351. package/src/_modules/bot/_services/bot-main.control-service.ts +489 -489
  352. package/src/_modules/bot/_services/bot-messaging-provider.service-base.spec.ts +349 -349
  353. package/src/_modules/bot/_services/bot-messaging-provider.service-base.ts +158 -158
  354. package/src/_modules/bot/_services/bot-routines.control-service.spec.ts +111 -111
  355. package/src/_modules/bot/_services/bot-routines.control-service.ts +78 -78
  356. package/src/_modules/bot/index.ts +37 -37
  357. package/src/_modules/custom-data/custom-data.controller.spec.ts +49 -49
  358. package/src/_modules/custom-data/custom-data.controller.ts +67 -67
  359. package/src/_modules/custom-data/custom-data.data-service.spec.ts +54 -54
  360. package/src/_modules/custom-data/custom-data.data-service.ts +21 -21
  361. package/src/_modules/custom-data/get-custom-data-routing-module.util.spec.ts +28 -28
  362. package/src/_modules/custom-data/get-custom-data-routing-module.util.ts +24 -24
  363. package/src/_modules/custom-data/index.ts +9 -9
  364. package/src/_modules/data-readers/_collections/dynts-sqlite-reader.util.spec.ts +176 -176
  365. package/src/_modules/data-readers/_collections/dynts-sqlite-reader.util.ts +203 -203
  366. package/src/_modules/data-readers/_models/interfaces/dynts-sqlite-reader.interface.ts +33 -33
  367. package/src/_modules/data-readers/index.ts +11 -11
  368. package/src/_modules/defaults/_collections/default-endpoints.util.ts +487 -487
  369. package/src/_modules/defaults/_models/default-user.data-model.ts +72 -72
  370. package/src/_modules/defaults/_services/default-auth.service.spec.ts +269 -269
  371. package/src/_modules/defaults/_services/default-auth.service.ts +177 -177
  372. package/src/_modules/defaults/_services/default-socket-events.service.spec.ts +42 -42
  373. package/src/_modules/defaults/_services/default-socket-events.service.ts +61 -61
  374. package/src/_modules/defaults/_services/default-user.data-service.spec.ts +187 -187
  375. package/src/_modules/defaults/_services/default-user.data-service.ts +98 -98
  376. package/src/_modules/defaults/index.ts +17 -17
  377. package/src/_modules/discord-assistant/_collections/dias-global-settings.const.ts +19 -19
  378. package/src/_modules/discord-assistant/_collections/dias.util.spec.ts +366 -366
  379. package/src/_modules/discord-assistant/_collections/dias.util.ts +132 -132
  380. package/src/_modules/discord-assistant/_models/dias-global-settings.interface.ts +19 -19
  381. package/src/_modules/discord-assistant/_models/dias-knowledge.data-model.ts +52 -52
  382. package/src/_modules/discord-assistant/_services/dias-chunk.data-service.ts +177 -177
  383. package/src/_modules/discord-assistant/_services/dias-io.control-service.spec.ts +108 -108
  384. package/src/_modules/discord-assistant/_services/dias-io.control-service.ts +69 -69
  385. package/src/_modules/discord-assistant/_services/dias-main.control-service.spec.ts +22 -22
  386. package/src/_modules/discord-assistant/_services/dias-main.control-service.ts +27 -27
  387. package/src/_modules/discord-assistant/_services/dias.service-base.spec.ts +195 -195
  388. package/src/_modules/discord-assistant/_services/dias.service-base.ts +76 -76
  389. package/src/_modules/discord-assistant/index.ts +38 -38
  390. package/src/_modules/discord-assistant-voiced/_services/dias-discord-bot.control-service.spec.ts +34 -34
  391. package/src/_modules/discord-assistant-voiced/_services/dias-discord-bot.control-service.ts +11 -11
  392. package/src/_modules/discord-assistant-voiced/index.ts +36 -36
  393. package/src/_modules/discord-bot/_collections/dibo-default-commands.const.ts +16 -16
  394. package/src/_modules/discord-bot/_collections/dibo-global-settings.conts.ts +55 -55
  395. package/src/_modules/discord-bot/_collections/dibo-operations.util.spec.ts +214 -214
  396. package/src/_modules/discord-bot/_collections/dibo-operations.util.ts +387 -387
  397. package/src/_modules/discord-bot/_models/dibo-command.interface.ts +12 -12
  398. package/src/_modules/discord-bot/_models/dibo-global-settings.interface.ts +98 -98
  399. package/src/_modules/discord-bot/_models/dibo-last-mention-date.inteface.ts +7 -7
  400. package/src/_modules/discord-bot/_models/dibo-last-message-date.interface.ts +6 -6
  401. package/src/_modules/discord-bot/_services/dibo-commands.control-service.spec.ts +154 -154
  402. package/src/_modules/discord-bot/_services/dibo-commands.control-service.ts +153 -153
  403. package/src/_modules/discord-bot/_services/dibo-io.control-service.spec.ts +264 -264
  404. package/src/_modules/discord-bot/_services/dibo-io.control-service.ts +306 -306
  405. package/src/_modules/discord-bot/_services/dibo-main.control-service.spec.ts +408 -408
  406. package/src/_modules/discord-bot/_services/dibo-main.control-service.ts +487 -487
  407. package/src/_modules/discord-bot/_services/dibo-routines.control-service.spec.ts +105 -105
  408. package/src/_modules/discord-bot/_services/dibo-routines.control-service.ts +97 -97
  409. package/src/_modules/discord-bot/index.ts +36 -36
  410. package/src/_modules/local-vector-search/_enums/lvs-search-mode.enum.ts +35 -35
  411. package/src/_modules/local-vector-search/_models/data-models/lvs-vector-persist.data-model.ts +60 -60
  412. package/src/_modules/local-vector-search/_models/lvs-search-result.interface.ts +17 -17
  413. package/src/_modules/local-vector-search/_services/lvs-bm25.util.spec.ts +159 -159
  414. package/src/_modules/local-vector-search/_services/lvs-bm25.util.ts +206 -206
  415. package/src/_modules/local-vector-search/_services/lvs-doc-chunk-data.service.spec.ts +418 -418
  416. package/src/_modules/local-vector-search/_services/lvs-doc-chunk-data.service.ts +276 -276
  417. package/src/_modules/local-vector-search/_services/lvs-local-vector-search.data-service.spec.ts +480 -480
  418. package/src/_modules/local-vector-search/_services/lvs-local-vector-search.data-service.ts +416 -416
  419. package/src/_modules/local-vector-search/_services/lvs-persistent-vector-pool.control-service.spec.ts +214 -214
  420. package/src/_modules/local-vector-search/_services/lvs-persistent-vector-pool.control-service.ts +186 -186
  421. package/src/_modules/local-vector-search/_services/lvs-vector-persist.data-service.spec.ts +167 -167
  422. package/src/_modules/local-vector-search/_services/lvs-vector-persist.data-service.ts +130 -130
  423. package/src/_modules/local-vector-search/_services/lvs-vector-pool.control-service.spec.ts +509 -509
  424. package/src/_modules/local-vector-search/_services/lvs-vector-pool.control-service.ts +323 -323
  425. package/src/_modules/local-vector-search/index.ts +16 -16
  426. package/src/_modules/logs/_models/file-log-entry.interface.ts +13 -13
  427. package/src/_modules/logs/_models/file-log-read-result.interface.ts +37 -37
  428. package/src/_modules/logs/file-log.service.spec.ts +341 -341
  429. package/src/_modules/logs/file-log.service.ts +466 -466
  430. package/src/_modules/logs/file-logs.controller.spec.ts +245 -245
  431. package/src/_modules/logs/file-logs.controller.ts +165 -165
  432. package/src/_modules/logs/get-file-logs-routing-module.util.ts +51 -51
  433. package/src/_modules/logs/get-logs-routing-module.util.ts +36 -36
  434. package/src/_modules/logs/index.ts +11 -11
  435. package/src/_modules/logs/log-buffer.service.ts +101 -101
  436. package/src/_modules/logs/logs.controller.ts +109 -109
  437. package/src/_modules/logs/logs.service.ts +100 -100
  438. package/src/_modules/mcp/_models/interfaces/dynts-mcp.interface.ts +111 -111
  439. package/src/_modules/mcp/_services/dynts-mcp-server.service-base.spec.ts +151 -151
  440. package/src/_modules/mcp/_services/dynts-mcp-server.service-base.ts +125 -125
  441. package/src/_modules/mcp/_services/dynts-mcp.adapter.ts +168 -168
  442. package/src/_modules/mcp/index.ts +13 -13
  443. package/src/_modules/messaging/README.md +354 -354
  444. package/src/_modules/messaging/_collections/get-messaging-routing-module.util.ts +26 -26
  445. package/src/_modules/messaging/_collections/msg-global-settings.const.ts +22 -22
  446. package/src/_modules/messaging/_collections/msg.util.spec.ts +226 -226
  447. package/src/_modules/messaging/_collections/msg.util.ts +83 -83
  448. package/src/_modules/messaging/_models/msg-global-settings.interface.ts +37 -37
  449. package/src/_modules/messaging/_services/msg-conversation.data-service.ts +146 -146
  450. package/src/_modules/messaging/_services/msg-events.service.spec.ts +219 -219
  451. package/src/_modules/messaging/_services/msg-events.service.ts +267 -267
  452. package/src/_modules/messaging/_services/msg-integration.control-service.ts +179 -179
  453. package/src/_modules/messaging/_services/msg-main.control-service.spec.ts +147 -147
  454. package/src/_modules/messaging/_services/msg-main.control-service.ts +571 -571
  455. package/src/_modules/messaging/_services/msg-message.data-service.ts +129 -129
  456. package/src/_modules/messaging/_services/msg.controller.spec.ts +201 -201
  457. package/src/_modules/messaging/_services/msg.controller.ts +370 -370
  458. package/src/_modules/messaging/index.ts +30 -30
  459. package/src/_modules/mock/app-extended-server.mock.ts +201 -201
  460. package/src/_modules/mock/app-integration-test.mock.ts +51 -51
  461. package/src/_modules/mock/app-params.mock.spec.ts +21 -21
  462. package/src/_modules/mock/app-params.mock.ts +9 -9
  463. package/src/_modules/mock/app-server.mock.ts +188 -188
  464. package/src/_modules/mock/auth-service.mock.spec.ts +47 -47
  465. package/src/_modules/mock/auth-service.mock.ts +28 -28
  466. package/src/_modules/mock/controller.mock.spec.ts +26 -26
  467. package/src/_modules/mock/controller.mock.ts +16 -16
  468. package/src/_modules/mock/data-model.mock.spec.ts +111 -111
  469. package/src/_modules/mock/data-model.mock.ts +82 -82
  470. package/src/_modules/mock/email-service-collection.mock.spec.ts +24 -24
  471. package/src/_modules/mock/email-service-collection.mock.ts +15 -15
  472. package/src/_modules/mock/email-service.mock.spec.ts +17 -17
  473. package/src/_modules/mock/email-service.mock.ts +20 -20
  474. package/src/_modules/mock/email-template.mock.html +14 -14
  475. package/src/_modules/mock/endpoint.mock.ts +91 -91
  476. package/src/_modules/mock/socket-client.mock.spec.ts +40 -40
  477. package/src/_modules/mock/socket-client.mock.ts +45 -45
  478. package/src/_modules/mock/socket-server.mock.spec.ts +44 -44
  479. package/src/_modules/mock/socket-server.mock.ts +46 -46
  480. package/src/_modules/oauth2/_routes/oauth2.controller.spec.ts +107 -107
  481. package/src/_modules/oauth2/_routes/oauth2.controller.ts +98 -98
  482. package/src/_modules/oauth2/_services/oauth2.auth-service.spec.ts +254 -254
  483. package/src/_modules/oauth2/_services/oauth2.auth-service.ts +232 -232
  484. package/src/_modules/oauth2/_services/oauth2.control-service.spec.ts +585 -585
  485. package/src/_modules/oauth2/_services/oauth2.control-service.ts +653 -653
  486. package/src/_modules/oauth2/index.ts +17 -17
  487. package/src/_modules/privacy-lifecycle/_enums/privacy-consent-decision.type-enum.ts +5 -5
  488. package/src/_modules/privacy-lifecycle/_enums/privacy-contributor-action.type-enum.ts +10 -10
  489. package/src/_modules/privacy-lifecycle/_enums/privacy-contributor-outcome.type-enum.ts +7 -7
  490. package/src/_modules/privacy-lifecycle/_enums/privacy-request-state.type-enum.ts +15 -15
  491. package/src/_modules/privacy-lifecycle/_enums/privacy-request.type-enum.ts +9 -9
  492. package/src/_modules/privacy-lifecycle/_models/privacy-consent-input.interface.ts +12 -12
  493. package/src/_modules/privacy-lifecycle/_models/privacy-consent-persistence-result.interface.ts +7 -7
  494. package/src/_modules/privacy-lifecycle/_models/privacy-consent-record.interface.ts +15 -15
  495. package/src/_modules/privacy-lifecycle/_models/privacy-consent-result.interface.ts +7 -7
  496. package/src/_modules/privacy-lifecycle/_models/privacy-consent-view.interface.ts +13 -13
  497. package/src/_modules/privacy-lifecycle/_models/privacy-contributor-context.interface.ts +9 -9
  498. package/src/_modules/privacy-lifecycle/_models/privacy-contributor-outcome.interface.ts +14 -14
  499. package/src/_modules/privacy-lifecycle/_models/privacy-contributor-plan.interface.ts +8 -8
  500. package/src/_modules/privacy-lifecycle/_models/privacy-contributor.interface.ts +17 -17
  501. package/src/_modules/privacy-lifecycle/_models/privacy-ledger-adapter.interface.ts +21 -21
  502. package/src/_modules/privacy-lifecycle/_models/privacy-ledger-result.interface.ts +9 -9
  503. package/src/_modules/privacy-lifecycle/_models/privacy-ledger-settings.interface.ts +7 -7
  504. package/src/_modules/privacy-lifecycle/_models/privacy-legal-acceptance-input.interface.ts +10 -10
  505. package/src/_modules/privacy-lifecycle/_models/privacy-legal-acceptance-persistence-result.interface.ts +7 -7
  506. package/src/_modules/privacy-lifecycle/_models/privacy-legal-acceptance-result.interface.ts +7 -7
  507. package/src/_modules/privacy-lifecycle/_models/privacy-legal-acceptance-view.interface.ts +11 -11
  508. package/src/_modules/privacy-lifecycle/_models/privacy-legal-acceptance.interface.ts +13 -13
  509. package/src/_modules/privacy-lifecycle/_models/privacy-lifecycle-adapter.interface.ts +19 -19
  510. package/src/_modules/privacy-lifecycle/_models/privacy-lifecycle-settings.interface.ts +9 -9
  511. package/src/_modules/privacy-lifecycle/_models/privacy-request-create-result.interface.ts +7 -7
  512. package/src/_modules/privacy-lifecycle/_models/privacy-request-open.interface.ts +10 -10
  513. package/src/_modules/privacy-lifecycle/_models/privacy-request-persistence-create-result.interface.ts +7 -7
  514. package/src/_modules/privacy-lifecycle/_models/privacy-request-record.interface.ts +21 -21
  515. package/src/_modules/privacy-lifecycle/_models/privacy-request-result.interface.ts +8 -8
  516. package/src/_modules/privacy-lifecycle/_models/privacy-request-view.interface.ts +20 -20
  517. package/src/_modules/privacy-lifecycle/index.ts +40 -40
  518. package/src/_modules/privacy-lifecycle/privacy-ledger.control-service.spec.ts +206 -206
  519. package/src/_modules/privacy-lifecycle/privacy-ledger.control-service.ts +253 -253
  520. package/src/_modules/privacy-lifecycle/privacy-lifecycle.control-service.spec.ts +353 -353
  521. package/src/_modules/privacy-lifecycle/privacy-lifecycle.control-service.ts +586 -586
  522. package/src/_modules/rate-limit/_enums/rate-limit-store-kind.type-enum.ts +5 -5
  523. package/src/_modules/rate-limit/_models/rate-limit-config.interface.ts +82 -82
  524. package/src/_modules/rate-limit/_models/rate-limit-consume-request.interface.ts +9 -9
  525. package/src/_modules/rate-limit/_models/rate-limit-consume-result.interface.ts +6 -6
  526. package/src/_modules/rate-limit/_models/rate-limit-policy.interface.ts +16 -16
  527. package/src/_modules/rate-limit/_models/rate-limit-store.interface.ts +9 -9
  528. package/src/_modules/rate-limit/index.ts +8 -8
  529. package/src/_modules/rate-limit/rate-limit-in-memory.store.ts +91 -91
  530. package/src/_modules/rate-limit/rate-limit.middleware.spec.ts +488 -488
  531. package/src/_modules/rate-limit/rate-limit.middleware.ts +504 -504
  532. package/src/_modules/scheduler/_models/scheduler-job.interface.ts +35 -35
  533. package/src/_modules/scheduler/get-scheduler-routing-module.util.ts +33 -33
  534. package/src/_modules/scheduler/index.ts +8 -8
  535. package/src/_modules/scheduler/scheduler.controller.spec.ts +42 -42
  536. package/src/_modules/scheduler/scheduler.controller.ts +69 -69
  537. package/src/_modules/scheduler/scheduler.service.spec.ts +141 -141
  538. package/src/_modules/scheduler/scheduler.service.ts +176 -176
  539. package/src/_modules/scoped-config/_enums/dynts-scoped-config-level.enum.ts +22 -22
  540. package/src/_modules/scoped-config/_models/data-models/dynts-scoped-config.data-model.ts +82 -82
  541. package/src/_modules/scoped-config/_models/interfaces/dynts-scoped-config.interface.ts +107 -107
  542. package/src/_modules/scoped-config/_services/dynts-scoped-config.control-service.spec.ts +312 -312
  543. package/src/_modules/scoped-config/_services/dynts-scoped-config.control-service.ts +311 -311
  544. package/src/_modules/scoped-config/_services/dynts-scoped-config.data-service.spec.ts +123 -123
  545. package/src/_modules/scoped-config/_services/dynts-scoped-config.data-service.ts +108 -108
  546. package/src/_modules/scoped-config/index.ts +17 -17
  547. package/src/_modules/server/errors/errors.control-service.spec.ts +246 -246
  548. package/src/_modules/server/errors/errors.control-service.ts +100 -100
  549. package/src/_modules/server/errors/errors.controller.spec.ts +340 -340
  550. package/src/_modules/server/errors/errors.controller.ts +559 -559
  551. package/src/_modules/server/errors/errors.data-service.spec.ts +480 -480
  552. package/src/_modules/server/errors/errors.data-service.ts +867 -867
  553. package/src/_modules/server/index.ts +37 -27
  554. package/src/_modules/server/safe-diagnostic/safe-diagnostic-cause.type-enum.ts +8 -0
  555. package/src/_modules/server/safe-diagnostic/safe-diagnostic-stage.type-enum.ts +19 -0
  556. package/src/_modules/server/safe-diagnostic/safe-diagnostic.control-service.spec.ts +124 -0
  557. package/src/_modules/server/safe-diagnostic/safe-diagnostic.control-service.ts +99 -0
  558. package/src/_modules/server/safe-diagnostic/safe-diagnostic.interface.ts +20 -0
  559. package/src/_modules/server/server-status/db-readiness-probe-code.type-enum.ts +13 -0
  560. package/src/_modules/server/server-status/db-readiness-probe-stage.type-enum.ts +7 -0
  561. package/src/_modules/server/server-status/db-readiness-probe.control-service.spec.ts +235 -0
  562. package/src/_modules/server/server-status/db-readiness-probe.control-service.ts +158 -0
  563. package/src/_modules/server/server-status/db-readiness-probe.interface.ts +20 -0
  564. package/src/_modules/server/server-status/server-status-snapshot.control-service.spec.ts +70 -70
  565. package/src/_modules/server/server-status/server-status-snapshot.control-service.ts +17 -17
  566. package/src/_modules/server/server-status/server-status-snapshot.data-service.spec.ts +77 -77
  567. package/src/_modules/server/server-status/server-status-snapshot.data-service.ts +37 -37
  568. package/src/_modules/server/server-status/server-status.control-service.spec.ts +672 -672
  569. package/src/_modules/server/server-status/server-status.control-service.ts +490 -490
  570. package/src/_modules/server/server-status/server-status.controller.spec.ts +276 -276
  571. package/src/_modules/server/server-status/server-status.controller.ts +336 -336
  572. package/src/_modules/socket/_enums/socket-security.enum.ts +11 -11
  573. package/src/_modules/socket/_models/socket-client-service-params.control-model.spec.ts +32 -32
  574. package/src/_modules/socket/_models/socket-client-service-params.control-model.ts +22 -22
  575. package/src/_modules/socket/_models/socket-presence.control-model.spec.ts +165 -165
  576. package/src/_modules/socket/_models/socket-presence.control-model.ts +211 -211
  577. package/src/_modules/socket/_models/socket-server-service-params.control-model.spec.ts +69 -69
  578. package/src/_modules/socket/_models/socket-server-service-params.control-model.ts +33 -33
  579. package/src/_modules/socket/_services/socket-client.service.spec.ts +15 -15
  580. package/src/_modules/socket/_services/socket-client.service.ts +260 -260
  581. package/src/_modules/socket/_services/socket-server.service.spec.ts +272 -272
  582. package/src/_modules/socket/_services/socket-server.service.ts +1037 -1037
  583. package/src/_modules/socket/app-extended.integration.spec.ts +85 -85
  584. package/src/_modules/socket/app-extended.server.ts +648 -648
  585. package/src/_modules/socket/index.ts +42 -42
  586. package/src/_modules/test/get-test-routing-module.util.spec.ts +28 -28
  587. package/src/_modules/test/get-test-routing-module.util.ts +23 -23
  588. package/src/_modules/test/index.ts +11 -11
  589. package/src/_modules/test/test.controller.spec.ts +72 -72
  590. package/src/_modules/test/test.controller.ts +115 -115
  591. package/src/_modules/test-email-sink/_collections/test-email-pattern.const.ts +10 -10
  592. package/src/_modules/test-email-sink/_models/data-models/dynts-sent-test-mail.data-model.ts +41 -41
  593. package/src/_modules/test-email-sink/_services/dynts-test-email-sink.service.spec.ts +112 -112
  594. package/src/_modules/test-email-sink/_services/dynts-test-email-sink.service.ts +141 -141
  595. package/src/_modules/test-email-sink/get-sent-mail-routing-module.util.ts +29 -29
  596. package/src/_modules/test-email-sink/index.ts +11 -11
  597. package/src/_modules/test-email-sink/test-email-sink.controller.ts +83 -83
  598. package/src/_modules/usage/get-usage-routing-module.util.ts +22 -22
  599. package/src/_modules/usage/index.ts +15 -15
  600. package/src/_modules/usage/usage.controller.spec.ts +106 -106
  601. package/src/_modules/usage/usage.controller.ts +140 -140
  602. package/src/_modules/usage/usage.data-service.spec.ts +332 -332
  603. package/src/_modules/usage/usage.data-service.ts +185 -185
  604. package/src/_services/base/api.service-base.spec.ts +125 -125
  605. package/src/_services/base/api.service-base.ts +74 -74
  606. package/src/_services/base/archive-data.service.spec.ts +209 -209
  607. package/src/_services/base/archive-data.service.ts +228 -228
  608. package/src/_services/base/data.service.spec.ts +784 -784
  609. package/src/_services/base/data.service.ts +2792 -2792
  610. package/src/_services/base/db.service.encryption.spec.ts +76 -76
  611. package/src/_services/base/db.service.spec.ts +160 -160
  612. package/src/_services/base/db.service.ts +1698 -1698
  613. package/src/_services/base/singleton.service-base.spec.ts +28 -28
  614. package/src/_services/base/singleton.service-base.ts +24 -24
  615. package/src/_services/base/singleton.service.spec.ts +114 -114
  616. package/src/_services/base/singleton.service.ts +38 -38
  617. package/src/_services/core/api.service.spec.ts +187 -187
  618. package/src/_services/core/api.service.ts +627 -627
  619. package/src/_services/core/auth.service.spec.ts +159 -159
  620. package/src/_services/core/auth.service.ts +174 -174
  621. package/src/_services/core/collection-growth-monitor.service.spec.ts +119 -119
  622. package/src/_services/core/collection-growth-monitor.service.ts +234 -234
  623. package/src/_services/core/db-stats.service.ts +104 -104
  624. package/src/_services/core/diagnostics.service.spec.ts +44 -44
  625. package/src/_services/core/diagnostics.service.ts +158 -158
  626. package/src/_services/core/email.service.spec.ts +85 -85
  627. package/src/_services/core/email.service.ts +757 -757
  628. package/src/_services/core/event-loop-diag.service.spec.ts +22 -22
  629. package/src/_services/core/event-loop-diag.service.ts +144 -144
  630. package/src/_services/core/global.service.spec.ts +292 -292
  631. package/src/_services/core/global.service.ts +466 -465
  632. package/src/_services/core/memory-guard.service.spec.ts +245 -245
  633. package/src/_services/core/memory-guard.service.ts +481 -481
  634. package/src/_services/core/migration-runner.service.spec.ts +91 -91
  635. package/src/_services/core/migration-runner.service.ts +106 -106
  636. package/src/_services/core/mongo-transaction.control-service.spec.ts +165 -165
  637. package/src/_services/core/mongo-transaction.control-service.ts +148 -148
  638. package/src/_services/core/request-hunter.service.spec.ts +124 -124
  639. package/src/_services/core/request-hunter.service.ts +157 -157
  640. package/src/_services/core/service-collection.service.spec.ts +46 -46
  641. package/src/_services/core/service-collection.service.ts +6 -6
  642. package/src/_services/route/controller.service.spec.ts +53 -53
  643. package/src/_services/route/controller.service.ts +148 -148
  644. package/src/_services/route/routing-module.service.spec.ts +98 -98
  645. package/src/_services/route/routing-module.service.ts +330 -330
  646. package/src/_services/server/app-safe-diagnostic.spec.ts +124 -0
  647. package/src/_services/server/app.server-retention.spec.ts +106 -106
  648. package/src/_services/server/app.server.ts +1865 -1918
  649. package/src/_services/shared.static-service.spec.ts +99 -99
  650. package/src/_services/shared.static-service.ts +78 -78
  651. package/src/index.ts +117 -117
  652. package/tsconfig.app.json +12 -12
  653. package/tsconfig.json +42 -42
  654. package/.dynamo/logs/cicd-pipeline/output.log +0 -2883
  655. package/.dynamo/logs/cicd-pipeline/status.json +0 -74
@@ -1,372 +1,372 @@
1
- ---
2
- description: When creating documentations
3
- alwaysApply: false
4
- ---
5
- # Documentation Writing Rules
6
-
7
- ## Core Rules
8
- 1. Documentation language:
9
- - For FDP documentations: write the documentation in Hungarian
10
- - In Hungarian documentation, use English words for technical terms and programming concepts to maintain clarity and consistency with code implementation
11
- - For Dynamo documentations: write the documentation in English
12
- 2. Focus on behavior, not implementation
13
- 3. Write from user's perspective
14
- - In FDP: the user is the webSite/webApp user
15
- - In Dynamo: the user is the developer
16
- 4. Keep language clear and simple
17
- - Use active voice
18
- - Avoid technical jargon unless necessary
19
- 5. Follow the template structure
20
- 6. Keep it short and informative
21
- 7. Documentation Validation Process:
22
- - Before adding new content to the documentation:
23
- 1. Locate the implementation file
24
- 2. Verify the new information matches the implementation
25
- 3. Add the verified information to documentation
26
- - Before removing content from the documentation:
27
- 1. Locate the implementation file
28
- 2. Confirm the information is no longer valid
29
- 3. Remove the outdated information from documentation
30
- 8. Don't add sections that is not reqiured, requested, or specially needed
31
- 9. **Always** read linked implementation files before
32
- 10. AI-Specific Considerations:
33
- - Use explicit file paths and references
34
- - Include clear context markers
35
- - Maintain consistent ID patterns
36
- - Document tool-specific requirements
37
- - Use proper markdown formatting for better AI parsing
38
- - Include clear section boundaries
39
- - Use explicit type annotations where possible
40
- 11. **Never** change paths
41
-
42
- ## Documentation IDs
43
- - All documentation IDs follow a hierarchical structure from system-level to feature-level documentation.
44
- - Never use in reference documentation or higher-level documentation
45
- - Only use at the exact detailed documentation and where the feature is implemented
46
- - Never change existing IDs, only highlight it if its incorrect
47
-
48
- ### System IDs
49
- - Used ONLY for system/project-level documentation
50
- - Format: [System]
51
- - System: Usually three-letter, code of the project/package
52
- - Must be unique at the system level
53
- - [Prefix] = [System]
54
- - Parent is:
55
- - For System: FDP or Dynamo
56
- - For Module: a System
57
- - For Section_Group: a Module
58
- - For Section: a Module
59
-
60
- ### Module IDs
61
- - Used ONLY for module-level documentation
62
- - Format: [System]-[Module]
63
- - System: Inherits from System ID
64
- - Module: Usually three-letter, code of the module
65
- - Must be unique at the module level
66
-
67
- ### Feature IDs
68
- - Used ONLY for low-level design documentation
69
- - But never on Sections or Section Groups
70
- - Format: [System]-[Module]-[SHORTCUT]
71
- - System: Inherits from System ID
72
- - Module: Inherits from Module ID
73
- - SHORTCUT: First letters of the function/class/ect extended to make it unique
74
- - Examples: DMS (DataManagementSystem), UIF (UserInterfaceFactory)
75
- - Must be unique at the feature level
76
-
77
- ### Section IDs
78
- - Used ONLY for sections
79
- - Format: [Section] OR [Section-Group]
80
- - Sections should never have ID other than [Section] OR [Section-Group]
81
- - Sections should always have the [Section] flag
82
- - Section Groups should always have the [Section-Group] flag
83
-
84
- ## Quick Checklist
85
- - [ ] Written in the required language (Hungarian for FDP, English for Dynamo) [REQUIRED]
86
- - [ ] Written from correct user perspective (end-user for FDP, developer for Dynamo) [REQUIRED]
87
- - [ ] Uses clear and simple language [REQUIRED]
88
- - [ ] Follows template structure [REQUIRED]
89
- - [ ] Has valid Documentation ID [REQUIRED]
90
- - [ ] Focuses on behavior, not implementation details [RECOMMENDED]
91
- - [ ] All content has been validated against implementation [REQUIRED]
92
- - [ ] Uses proper {File Main_Name} format (not filenames with extensions) [REQUIRED]
93
- - [ ] Table of contents uses proper component names, not filenames [REQUIRED]
94
- - [ ] Markdown links should work in ToC, dont miss "_"s and "pefix_"s
95
-
96
- ## Basic Template
97
- - If there is a specific Documentation Template for your type use that, otherwise use this:
98
- ```markdown
99
- #{Name of the Documentation} [{ID(optional)}]
100
- (Use System-ID [SYSTEM] for system-level documentation)
101
- (Use Module-ID [SYSTEM]-[MODULE] for module-level documentation)
102
- (Use Section/SectionGroup-ID [SYSTEM]-[MODULE]-[SHORTCUT] for low-level design documentation ONLY)
103
-
104
- ## Overview (Required)
105
- (
106
- - Purpose: Brief description of what this documentation covers
107
- - Main Features: List of key features or capabilities in this documentation
108
- - Brief summary, focused on usability/tools based on the content
109
- - Only create overview when the content is ready to be summarized (use: "[TODO]" while its not filled)
110
- )
111
-
112
- ### Key Features
113
- [TODO] (List key features, focused on usability/tools)
114
-
115
- ## Table of Contents (Required)
116
- (Links for each section, member and children)
117
-
118
- ## {Contents} (Required)
119
- (Detailed informations about the subjects)
120
-
121
- (link back)
122
- ```
123
-
124
- ## Documentation File Hierarchy
125
-
126
- ### For Project/Package Documentation Structure
127
- - Use the following hierarchy template:
128
- - {system-code}.md
129
- - {module1}
130
- - {Prefix}-{module1}_{section1}.md
131
- - {Prefix}-{module1}_{section2}.md
132
- - {Prefix}-{module1}-module.md
133
- - {module2}
134
- - {Prefix}-{module2}_{section1}.md
135
- - {Prefix}-{module2}_{section2}.md
136
- - {Prefix}-{module2}-module.md
137
- - {Prefix}-{module2}_{section-group1}
138
- - {Prefix}-{module2}-{section-group1}_{section1}.md
139
- - {Prefix}-{module2}-{section-group1}_{section2}.md
140
- - {Prefix}-{module2}-{section-group1}.md
141
- ...
142
- - RULES:
143
- 1. Low-level elements should contain only title and Overview section with [TODO]
144
- 2. Keep file names lowercase but use proper capitalization in titles and content
145
- 3. File naming patterns:
146
- - Package files: {package-name}.md
147
- - Module files: {Prefix}-{module-name}-module.md
148
- - Section files: {Prefix}-{module-name}_{section}.md
149
- - Code prefixes: {CODE_Prefix}_{MODULE}_
150
- - Import paths: {IMPORT_PATH}/{module}
151
-
152
- #### Creating Project/Package Documentation File Hierarchy
153
- - Use the following template for each new section element:
154
- ```markdown
155
- # {SYSTEM_NAME} {Module Name} {Section}
156
-
157
- ## Overview
158
- [TODO]
159
- ```
160
-
161
- ## Documentation Read
162
- - You can define the Documentation type using the [Documentation IDs](#Documentation-IDs)
163
-
164
- ## Documentation Templates
165
- - RELATIVE_PATH: path to the local implementation file, using relative path from the md file
166
- - AI Agents won't be able to use this, but the IDE will be
167
- - ABSOLUTE_PATH: path to the local implementation file, using absolute path from root
168
- - The IDE won't be able to use this, but the AI Agents will be
169
-
170
- ### For Project/Package
171
- - Use the following template for creating a Package Documentation:
172
- ```markdown
173
- # {System_Name} [{System-ID}]
174
- **Package:** `{package-code}`
175
- **Code prefix:** {CODE_Prefix_}
176
- **Import:** `{IMPORT_PATH}`
177
- **Dependencies:** {List of dependencies in FDP hierarchy}
178
- **Link:** [package.json]({RELATIVE_PATH})
179
- **Base location** {ABSOLUTE_PATH}
180
-
181
- ## Overview
182
- (Base templates for System_Name Projects.)
183
-
184
- ### Key Features
185
- [TODO] (List key features, focused on usability/tools)
186
-
187
- ## Description
188
- [TODO] (Base templates for System_Name Systems providing modular architecture for various project types.)
189
-
190
- ## Table of Contents
191
- 1. [Main Module](#{main-module})
192
- 2. [{Module1 Name}](#{module1-name}-module)
193
- 3. [{Module2 Name}](#{module2-name}-module)
194
-
195
- ## Modules
196
-
197
- ### [Main Module](main/{Prefix}-main-module.md)
198
- [TODO] (Exported members)
199
-
200
- ### [{Module1 Name}]({module1-name}/{Prefix}-module1-name-module.md)
201
- [TODO] (Exported members)
202
-
203
- ## Exported Members
204
-
205
- ### {Section1 Name}
206
- - [`{Exported_Member1}`]({module1-name}/{Prefix}-module1-name-module.md/#Exported_Member1) short description
207
-
208
- [Back to {Parent Name}](../{parent-documentation-name}.md)
209
- ```
210
-
211
- ### For Module
212
- - Use the following template for creating a Module Documentation:
213
- ```markdown
214
- # {System_Name} {Module_Name} Module Documentation [{Module-ID}]
215
- **Import:** `{IMPORT_PATH}/{module-path}`
216
- **Link:** [index]({RELATIVE_PATH to the index})
217
- **Base location** {ABSOLUTE_PATH to the index}
218
-
219
- ## Overview
220
- [TODO] (Module description)
221
-
222
- ### Key Features
223
- [TODO] (List key features)
224
-
225
- ## Table of Contents (ONLY if the Sections are in different files)
226
- 1. [{Section1_Name}]({Prefix}-{module-name}_{section1}.md)
227
- 2. [{Section2_Name}]({Prefix}-{module-name}_{section2}.md)
228
- 3. [{Section_Group1}]({Prefix}-{module-name}_{section1-group}/[{Prefix}-{module-name}_{section1-group}.md)
229
- - [{Section1_Name}]({Prefix}-{module-name}_{section1-group}/{Prefix}-{module-name}-{section1-group}_{section1}.md)
230
- - [{Section2_Name}]({Prefix}-{module-name}_{section1-group}/{Prefix}-{module-name}-{section1-group}_{section2}.md)
231
-
232
- ## Table of Contents (ONLY if the Files/Features are here in this file)
233
- 1. [{Section_Group1}](#{Section-Group1-Name})
234
- - [{File1 Main_Name}](#{file1-main_name})
235
- - [{File2 Main_Name}](#{file2-main_name})
236
-
237
- ## Detailed Documentation (ONLY if the Sections are in different files)
238
- [TODO] (Exported members)
239
-
240
- ## {Section Group1 Name} (ONLY if the Files/Features are here in this file)
241
-
242
- ### [{File1 Main_Name}]({path to the implementation file1})
243
- {Package Project File1/Feature}
244
-
245
- ### [{File2 Main_Name}]({path to the implementation file2})
246
- {Package Project File2/Feature}
247
-
248
- ...
249
-
250
- [Back to {System_Name}](../{package-code}.md)
251
- ```
252
-
253
- ### For Section Group
254
- - Use the following template for creating a Documentation Section Group:
255
- ```markdown
256
- # {System_Name} {Module_Name} {Section_Group_Name} Documentations [Section-Group]
257
-
258
- ## Overview
259
- [TODO] Section Group description
260
-
261
- ### Key Features
262
- [TODO] (List key features)
263
-
264
- ## Table of Contents
265
- 1. [{Section1_Name}]({Prefix}-{module-name}_{section1}.md)
266
- 2. [{Section2_Name}]({Prefix}-{module-name}_{section2}.md)
267
-
268
- ## Detailed Documentation
269
- [TODO] (Exported members)
270
-
271
- [Back to {Module_Name}](../{Prefix}-{module-name}-module.md)
272
- ```
273
-
274
- ### For Section
275
- - Use the following template for creating a Documentation Section:
276
- ```markdown
277
- # {System_Name} {Module_Name} {Section_Name} Documentation [Section]
278
-
279
- ## Overview
280
- [TODO] {Section description}
281
-
282
- ### Key Features
283
- [TODO] List key features
284
-
285
- ## Table of Contents
286
- 1. [{Sub Section1 Name}](#{Sub-Section1-Name})
287
- - [{File1 Main_Name}](#{File1-Main_Name})
288
- - [{File2 Main_Name}](#{File2-Main_Name})
289
- 2. [{Sub Section2 Name}](#{Sub-Section1-Name})
290
- - [{File1 Main_Name}](#{File3-Main_Name})
291
- - [{File2 Main_Name}](#{File4-Main_Name})
292
-
293
- ## {Sub Section1 Name} (required and based on File Types)
294
-
295
- ### [{File1 Main_Name}]({path to the implementation file1})
296
- [Package Project File1]
297
-
298
- ### [{File2 Main_Name}]({path to the implementation file2})
299
- [Package Project File2]
300
-
301
- ...
302
-
303
- [Back to {Module_Name or Section_Group_Name}]({Prefix}-{module-name}-module.md)
304
- ```
305
- - Sub Sections generated based on the file types: somehting.{file-type}.ts
306
- - E.g.:
307
- - Enums for *.enum.ts
308
- - Constants for *.const.ts
309
-
310
- ### For Package Project File/Feature
311
- - Use the following template for each file/feature documented:
312
- ```markdown
313
- ### [`{Main_Name}`]({RELATIVE_PATH to the implementation file})
314
- - **Code:** [{Feature-ID}]
315
- - **Base Location:** `{ABSOLUTE_PATH}`
316
- - **Description(only for multiple Exported Members):** {short description about the main concept of the members}
317
- - **Exported Members(required):**
318
- - `{exportedMember}`: {short description}
319
- - **Aliases(optional):** `{exportedMember1Alias1}`, `{exportedMember1Alias2}`
320
- - **Extending(optional):** [{ExtendedMemberName}]({RELATIVE_PATH to extending type documentation or "MISSING LINK"}
321
- - **Properties(optional):**
322
- - `{property}`: {short description}
323
- - **Methods(optional):**
324
- - `{method}`: {short description}
325
- - **Type(optional: CONST ONLY):** {type and link if it is available in documentation}
326
- - **Values(optional: ENUM ONLY):**
327
- - `{value}`: {short description}
328
- - **Features(optional):**
329
- - {feature}
330
- ```
331
- - File/Feature Documentations should be on level3:###
332
-
333
- #### STRICT RULES for {Main_Name}:
334
- - **NEVER** use the actual filename with extensions (e.g., do not use "token.control-model.ts")
335
- - **ALWAYS** Read the linked file and then:
336
- - For files with a single exported member:
337
- - Use the **exact same name** of the exported member (e.g., FDP_Token)
338
- - For files with multiple exported members:
339
- - If there is a significant exported member, use its **exact same name**
340
- - If there is no significant exported member, use a short, descriptive name that clearly represents the file's content (e.g., Token Control Models)
341
- - These rules apply to both the Table of Contents section and the headers for each file
342
-
343
- #### STRICT RULES for {route in the local project hierarchy to the implementation file}:
344
- - **NEVER CHANGE** "route in the local project hierarchy to the implementation file"
345
-
346
- #### STRICT RULES for Aliases and Exported members:
347
- - Never add aliases as exported members, but always add them as Aliases
348
-
349
- #### RULES for extensions
350
- - Extension Links:
351
- - Always gather the extensions
352
- - Link to the parent documentation when available
353
- - Use "MISSING LINK" when parent documentation is not found
354
-
355
- ## Formatting Rules
356
- - Use backticks (`) for:
357
- - Code references
358
- - File names
359
- - Function names
360
- - Class names
361
- - Property names
362
- - Method names
363
- - Enum values
364
- - Use bold (**) for:
365
- - Section headers
366
- - Important terms
367
- - Required fields
368
- - Use italics (*) for:
369
- - Optional fields
370
- - Notes
371
- - Warnings
372
-
1
+ ---
2
+ description: When creating documentations
3
+ alwaysApply: false
4
+ ---
5
+ # Documentation Writing Rules
6
+
7
+ ## Core Rules
8
+ 1. Documentation language:
9
+ - For FDP documentations: write the documentation in Hungarian
10
+ - In Hungarian documentation, use English words for technical terms and programming concepts to maintain clarity and consistency with code implementation
11
+ - For Dynamo documentations: write the documentation in English
12
+ 2. Focus on behavior, not implementation
13
+ 3. Write from user's perspective
14
+ - In FDP: the user is the webSite/webApp user
15
+ - In Dynamo: the user is the developer
16
+ 4. Keep language clear and simple
17
+ - Use active voice
18
+ - Avoid technical jargon unless necessary
19
+ 5. Follow the template structure
20
+ 6. Keep it short and informative
21
+ 7. Documentation Validation Process:
22
+ - Before adding new content to the documentation:
23
+ 1. Locate the implementation file
24
+ 2. Verify the new information matches the implementation
25
+ 3. Add the verified information to documentation
26
+ - Before removing content from the documentation:
27
+ 1. Locate the implementation file
28
+ 2. Confirm the information is no longer valid
29
+ 3. Remove the outdated information from documentation
30
+ 8. Don't add sections that is not reqiured, requested, or specially needed
31
+ 9. **Always** read linked implementation files before
32
+ 10. AI-Specific Considerations:
33
+ - Use explicit file paths and references
34
+ - Include clear context markers
35
+ - Maintain consistent ID patterns
36
+ - Document tool-specific requirements
37
+ - Use proper markdown formatting for better AI parsing
38
+ - Include clear section boundaries
39
+ - Use explicit type annotations where possible
40
+ 11. **Never** change paths
41
+
42
+ ## Documentation IDs
43
+ - All documentation IDs follow a hierarchical structure from system-level to feature-level documentation.
44
+ - Never use in reference documentation or higher-level documentation
45
+ - Only use at the exact detailed documentation and where the feature is implemented
46
+ - Never change existing IDs, only highlight it if its incorrect
47
+
48
+ ### System IDs
49
+ - Used ONLY for system/project-level documentation
50
+ - Format: [System]
51
+ - System: Usually three-letter, code of the project/package
52
+ - Must be unique at the system level
53
+ - [Prefix] = [System]
54
+ - Parent is:
55
+ - For System: FDP or Dynamo
56
+ - For Module: a System
57
+ - For Section_Group: a Module
58
+ - For Section: a Module
59
+
60
+ ### Module IDs
61
+ - Used ONLY for module-level documentation
62
+ - Format: [System]-[Module]
63
+ - System: Inherits from System ID
64
+ - Module: Usually three-letter, code of the module
65
+ - Must be unique at the module level
66
+
67
+ ### Feature IDs
68
+ - Used ONLY for low-level design documentation
69
+ - But never on Sections or Section Groups
70
+ - Format: [System]-[Module]-[SHORTCUT]
71
+ - System: Inherits from System ID
72
+ - Module: Inherits from Module ID
73
+ - SHORTCUT: First letters of the function/class/ect extended to make it unique
74
+ - Examples: DMS (DataManagementSystem), UIF (UserInterfaceFactory)
75
+ - Must be unique at the feature level
76
+
77
+ ### Section IDs
78
+ - Used ONLY for sections
79
+ - Format: [Section] OR [Section-Group]
80
+ - Sections should never have ID other than [Section] OR [Section-Group]
81
+ - Sections should always have the [Section] flag
82
+ - Section Groups should always have the [Section-Group] flag
83
+
84
+ ## Quick Checklist
85
+ - [ ] Written in the required language (Hungarian for FDP, English for Dynamo) [REQUIRED]
86
+ - [ ] Written from correct user perspective (end-user for FDP, developer for Dynamo) [REQUIRED]
87
+ - [ ] Uses clear and simple language [REQUIRED]
88
+ - [ ] Follows template structure [REQUIRED]
89
+ - [ ] Has valid Documentation ID [REQUIRED]
90
+ - [ ] Focuses on behavior, not implementation details [RECOMMENDED]
91
+ - [ ] All content has been validated against implementation [REQUIRED]
92
+ - [ ] Uses proper {File Main_Name} format (not filenames with extensions) [REQUIRED]
93
+ - [ ] Table of contents uses proper component names, not filenames [REQUIRED]
94
+ - [ ] Markdown links should work in ToC, dont miss "_"s and "pefix_"s
95
+
96
+ ## Basic Template
97
+ - If there is a specific Documentation Template for your type use that, otherwise use this:
98
+ ```markdown
99
+ #{Name of the Documentation} [{ID(optional)}]
100
+ (Use System-ID [SYSTEM] for system-level documentation)
101
+ (Use Module-ID [SYSTEM]-[MODULE] for module-level documentation)
102
+ (Use Section/SectionGroup-ID [SYSTEM]-[MODULE]-[SHORTCUT] for low-level design documentation ONLY)
103
+
104
+ ## Overview (Required)
105
+ (
106
+ - Purpose: Brief description of what this documentation covers
107
+ - Main Features: List of key features or capabilities in this documentation
108
+ - Brief summary, focused on usability/tools based on the content
109
+ - Only create overview when the content is ready to be summarized (use: "[TODO]" while its not filled)
110
+ )
111
+
112
+ ### Key Features
113
+ [TODO] (List key features, focused on usability/tools)
114
+
115
+ ## Table of Contents (Required)
116
+ (Links for each section, member and children)
117
+
118
+ ## {Contents} (Required)
119
+ (Detailed informations about the subjects)
120
+
121
+ (link back)
122
+ ```
123
+
124
+ ## Documentation File Hierarchy
125
+
126
+ ### For Project/Package Documentation Structure
127
+ - Use the following hierarchy template:
128
+ - {system-code}.md
129
+ - {module1}
130
+ - {Prefix}-{module1}_{section1}.md
131
+ - {Prefix}-{module1}_{section2}.md
132
+ - {Prefix}-{module1}-module.md
133
+ - {module2}
134
+ - {Prefix}-{module2}_{section1}.md
135
+ - {Prefix}-{module2}_{section2}.md
136
+ - {Prefix}-{module2}-module.md
137
+ - {Prefix}-{module2}_{section-group1}
138
+ - {Prefix}-{module2}-{section-group1}_{section1}.md
139
+ - {Prefix}-{module2}-{section-group1}_{section2}.md
140
+ - {Prefix}-{module2}-{section-group1}.md
141
+ ...
142
+ - RULES:
143
+ 1. Low-level elements should contain only title and Overview section with [TODO]
144
+ 2. Keep file names lowercase but use proper capitalization in titles and content
145
+ 3. File naming patterns:
146
+ - Package files: {package-name}.md
147
+ - Module files: {Prefix}-{module-name}-module.md
148
+ - Section files: {Prefix}-{module-name}_{section}.md
149
+ - Code prefixes: {CODE_Prefix}_{MODULE}_
150
+ - Import paths: {IMPORT_PATH}/{module}
151
+
152
+ #### Creating Project/Package Documentation File Hierarchy
153
+ - Use the following template for each new section element:
154
+ ```markdown
155
+ # {SYSTEM_NAME} {Module Name} {Section}
156
+
157
+ ## Overview
158
+ [TODO]
159
+ ```
160
+
161
+ ## Documentation Read
162
+ - You can define the Documentation type using the [Documentation IDs](#Documentation-IDs)
163
+
164
+ ## Documentation Templates
165
+ - RELATIVE_PATH: path to the local implementation file, using relative path from the md file
166
+ - AI Agents won't be able to use this, but the IDE will be
167
+ - ABSOLUTE_PATH: path to the local implementation file, using absolute path from root
168
+ - The IDE won't be able to use this, but the AI Agents will be
169
+
170
+ ### For Project/Package
171
+ - Use the following template for creating a Package Documentation:
172
+ ```markdown
173
+ # {System_Name} [{System-ID}]
174
+ **Package:** `{package-code}`
175
+ **Code prefix:** {CODE_Prefix_}
176
+ **Import:** `{IMPORT_PATH}`
177
+ **Dependencies:** {List of dependencies in FDP hierarchy}
178
+ **Link:** [package.json]({RELATIVE_PATH})
179
+ **Base location** {ABSOLUTE_PATH}
180
+
181
+ ## Overview
182
+ (Base templates for System_Name Projects.)
183
+
184
+ ### Key Features
185
+ [TODO] (List key features, focused on usability/tools)
186
+
187
+ ## Description
188
+ [TODO] (Base templates for System_Name Systems providing modular architecture for various project types.)
189
+
190
+ ## Table of Contents
191
+ 1. [Main Module](#{main-module})
192
+ 2. [{Module1 Name}](#{module1-name}-module)
193
+ 3. [{Module2 Name}](#{module2-name}-module)
194
+
195
+ ## Modules
196
+
197
+ ### [Main Module](main/{Prefix}-main-module.md)
198
+ [TODO] (Exported members)
199
+
200
+ ### [{Module1 Name}]({module1-name}/{Prefix}-module1-name-module.md)
201
+ [TODO] (Exported members)
202
+
203
+ ## Exported Members
204
+
205
+ ### {Section1 Name}
206
+ - [`{Exported_Member1}`]({module1-name}/{Prefix}-module1-name-module.md/#Exported_Member1) short description
207
+
208
+ [Back to {Parent Name}](../{parent-documentation-name}.md)
209
+ ```
210
+
211
+ ### For Module
212
+ - Use the following template for creating a Module Documentation:
213
+ ```markdown
214
+ # {System_Name} {Module_Name} Module Documentation [{Module-ID}]
215
+ **Import:** `{IMPORT_PATH}/{module-path}`
216
+ **Link:** [index]({RELATIVE_PATH to the index})
217
+ **Base location** {ABSOLUTE_PATH to the index}
218
+
219
+ ## Overview
220
+ [TODO] (Module description)
221
+
222
+ ### Key Features
223
+ [TODO] (List key features)
224
+
225
+ ## Table of Contents (ONLY if the Sections are in different files)
226
+ 1. [{Section1_Name}]({Prefix}-{module-name}_{section1}.md)
227
+ 2. [{Section2_Name}]({Prefix}-{module-name}_{section2}.md)
228
+ 3. [{Section_Group1}]({Prefix}-{module-name}_{section1-group}/[{Prefix}-{module-name}_{section1-group}.md)
229
+ - [{Section1_Name}]({Prefix}-{module-name}_{section1-group}/{Prefix}-{module-name}-{section1-group}_{section1}.md)
230
+ - [{Section2_Name}]({Prefix}-{module-name}_{section1-group}/{Prefix}-{module-name}-{section1-group}_{section2}.md)
231
+
232
+ ## Table of Contents (ONLY if the Files/Features are here in this file)
233
+ 1. [{Section_Group1}](#{Section-Group1-Name})
234
+ - [{File1 Main_Name}](#{file1-main_name})
235
+ - [{File2 Main_Name}](#{file2-main_name})
236
+
237
+ ## Detailed Documentation (ONLY if the Sections are in different files)
238
+ [TODO] (Exported members)
239
+
240
+ ## {Section Group1 Name} (ONLY if the Files/Features are here in this file)
241
+
242
+ ### [{File1 Main_Name}]({path to the implementation file1})
243
+ {Package Project File1/Feature}
244
+
245
+ ### [{File2 Main_Name}]({path to the implementation file2})
246
+ {Package Project File2/Feature}
247
+
248
+ ...
249
+
250
+ [Back to {System_Name}](../{package-code}.md)
251
+ ```
252
+
253
+ ### For Section Group
254
+ - Use the following template for creating a Documentation Section Group:
255
+ ```markdown
256
+ # {System_Name} {Module_Name} {Section_Group_Name} Documentations [Section-Group]
257
+
258
+ ## Overview
259
+ [TODO] Section Group description
260
+
261
+ ### Key Features
262
+ [TODO] (List key features)
263
+
264
+ ## Table of Contents
265
+ 1. [{Section1_Name}]({Prefix}-{module-name}_{section1}.md)
266
+ 2. [{Section2_Name}]({Prefix}-{module-name}_{section2}.md)
267
+
268
+ ## Detailed Documentation
269
+ [TODO] (Exported members)
270
+
271
+ [Back to {Module_Name}](../{Prefix}-{module-name}-module.md)
272
+ ```
273
+
274
+ ### For Section
275
+ - Use the following template for creating a Documentation Section:
276
+ ```markdown
277
+ # {System_Name} {Module_Name} {Section_Name} Documentation [Section]
278
+
279
+ ## Overview
280
+ [TODO] {Section description}
281
+
282
+ ### Key Features
283
+ [TODO] List key features
284
+
285
+ ## Table of Contents
286
+ 1. [{Sub Section1 Name}](#{Sub-Section1-Name})
287
+ - [{File1 Main_Name}](#{File1-Main_Name})
288
+ - [{File2 Main_Name}](#{File2-Main_Name})
289
+ 2. [{Sub Section2 Name}](#{Sub-Section1-Name})
290
+ - [{File1 Main_Name}](#{File3-Main_Name})
291
+ - [{File2 Main_Name}](#{File4-Main_Name})
292
+
293
+ ## {Sub Section1 Name} (required and based on File Types)
294
+
295
+ ### [{File1 Main_Name}]({path to the implementation file1})
296
+ [Package Project File1]
297
+
298
+ ### [{File2 Main_Name}]({path to the implementation file2})
299
+ [Package Project File2]
300
+
301
+ ...
302
+
303
+ [Back to {Module_Name or Section_Group_Name}]({Prefix}-{module-name}-module.md)
304
+ ```
305
+ - Sub Sections generated based on the file types: somehting.{file-type}.ts
306
+ - E.g.:
307
+ - Enums for *.enum.ts
308
+ - Constants for *.const.ts
309
+
310
+ ### For Package Project File/Feature
311
+ - Use the following template for each file/feature documented:
312
+ ```markdown
313
+ ### [`{Main_Name}`]({RELATIVE_PATH to the implementation file})
314
+ - **Code:** [{Feature-ID}]
315
+ - **Base Location:** `{ABSOLUTE_PATH}`
316
+ - **Description(only for multiple Exported Members):** {short description about the main concept of the members}
317
+ - **Exported Members(required):**
318
+ - `{exportedMember}`: {short description}
319
+ - **Aliases(optional):** `{exportedMember1Alias1}`, `{exportedMember1Alias2}`
320
+ - **Extending(optional):** [{ExtendedMemberName}]({RELATIVE_PATH to extending type documentation or "MISSING LINK"}
321
+ - **Properties(optional):**
322
+ - `{property}`: {short description}
323
+ - **Methods(optional):**
324
+ - `{method}`: {short description}
325
+ - **Type(optional: CONST ONLY):** {type and link if it is available in documentation}
326
+ - **Values(optional: ENUM ONLY):**
327
+ - `{value}`: {short description}
328
+ - **Features(optional):**
329
+ - {feature}
330
+ ```
331
+ - File/Feature Documentations should be on level3:###
332
+
333
+ #### STRICT RULES for {Main_Name}:
334
+ - **NEVER** use the actual filename with extensions (e.g., do not use "token.control-model.ts")
335
+ - **ALWAYS** Read the linked file and then:
336
+ - For files with a single exported member:
337
+ - Use the **exact same name** of the exported member (e.g., FDP_Token)
338
+ - For files with multiple exported members:
339
+ - If there is a significant exported member, use its **exact same name**
340
+ - If there is no significant exported member, use a short, descriptive name that clearly represents the file's content (e.g., Token Control Models)
341
+ - These rules apply to both the Table of Contents section and the headers for each file
342
+
343
+ #### STRICT RULES for {route in the local project hierarchy to the implementation file}:
344
+ - **NEVER CHANGE** "route in the local project hierarchy to the implementation file"
345
+
346
+ #### STRICT RULES for Aliases and Exported members:
347
+ - Never add aliases as exported members, but always add them as Aliases
348
+
349
+ #### RULES for extensions
350
+ - Extension Links:
351
+ - Always gather the extensions
352
+ - Link to the parent documentation when available
353
+ - Use "MISSING LINK" when parent documentation is not found
354
+
355
+ ## Formatting Rules
356
+ - Use backticks (`) for:
357
+ - Code references
358
+ - File names
359
+ - Function names
360
+ - Class names
361
+ - Property names
362
+ - Method names
363
+ - Enum values
364
+ - Use bold (**) for:
365
+ - Section headers
366
+ - Important terms
367
+ - Required fields
368
+ - Use italics (*) for:
369
+ - Optional fields
370
+ - Notes
371
+ - Warnings
372
+