@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,504 +1,504 @@
1
- import { Request, Response } from 'express';
2
-
3
- import { DyFM_Error } from '@futdevpro/fsm-dynamo';
4
-
5
- import { DyNTS_global_settings } from '../../_collections/global-settings.const';
6
- import { DyNTS_SingletonServiceBase } from '../../_services/base/singleton.service-base';
7
- import { DyNTS_RateLimitStoreKind_Type } from './_enums/rate-limit-store-kind.type-enum';
8
- import { DyNTS_RateLimit_Config } from './_models/rate-limit-config.interface';
9
- import { DyNTS_RateLimit_ConsumeResult_Interface } from './_models/rate-limit-consume-result.interface';
10
- import { DyNTS_RateLimit_Policy } from './_models/rate-limit-policy.interface';
11
- import { DyNTS_RateLimit_Store_Interface } from './_models/rate-limit-store.interface';
12
- import { DyNTS_RateLimit_InMemoryStore } from './rate-limit-in-memory.store';
13
-
14
- const DEFAULT_LIMIT: number = 100;
15
- const DEFAULT_WINDOW_MS: number = 60_000;
16
- const DEFAULT_RESPONSE_HEADERS: boolean = true;
17
- const MAX_LIMIT: number = 1_000_000;
18
- const MAX_WINDOW_MS: number = 7 * 24 * 60 * 60 * 1_000;
19
- const MAX_BUCKET_PART_LENGTH: number = 240;
20
- const SERVICE_NAME: string = 'DyNTS_RateLimit_Middleware';
21
-
22
- interface DyNTS_RateLimit_ErrorContext_Interface {
23
- status: number;
24
- subcode: string;
25
- message: string;
26
- userMessage: string;
27
- }
28
-
29
- interface DyNTS_RateLimit_HeaderContext_Interface {
30
- policy: DyNTS_RateLimit_Policy;
31
- result: DyNTS_RateLimit_ConsumeResult_Interface;
32
- now: number;
33
- }
34
-
35
- interface DyNTS_RateLimit_ConfigSnapshot_Interface {
36
- defaultLimit: number;
37
- defaultWindowMs: number;
38
- isResponseHeadersEnabled: boolean;
39
- isSharedStoreRequired: boolean;
40
- keyExtractor: (req: Request) => string;
41
- endpointGrouper: (req: Request) => string;
42
- costExtractor: (req: Request) => number;
43
- clock: () => number;
44
- store: DyNTS_RateLimit_Store_Interface;
45
- isKeyExtractorExplicit: boolean;
46
- isEndpointGrouperExplicit: boolean;
47
- keyPolicies: Map<string, DyNTS_RateLimit_Policy>;
48
- endpointPolicies: Map<string, DyNTS_RateLimit_Policy>;
49
- }
50
-
51
- /** Atomic HTTP rate-limit boundary with an explicit shared-store production gate. */
52
- export class DyNTS_RateLimit_Middleware extends DyNTS_SingletonServiceBase {
53
- private defaultLimit: number = DEFAULT_LIMIT;
54
- private defaultWindowMs: number = DEFAULT_WINDOW_MS;
55
- private isResponseHeadersEnabled: boolean = DEFAULT_RESPONSE_HEADERS;
56
- private isSharedStoreRequired: boolean = false;
57
- private isKeyExtractorExplicit: boolean = false;
58
- private isEndpointGrouperExplicit: boolean = false;
59
- private keyExtractor: (req: Request) => string = (req: Request): string => req.ip ?? 'unknown';
60
- private endpointGrouper: (req: Request) => string = (req: Request): string => req.path;
61
- private costExtractor: (req: Request) => number = (req: Request): number => {
62
- void req;
63
-
64
- return 1;
65
- };
66
- private clock: () => number = (): number => Date.now();
67
- private store: DyNTS_RateLimit_Store_Interface = new DyNTS_RateLimit_InMemoryStore();
68
- private keyPolicies: Map<string, DyNTS_RateLimit_Policy> = new Map();
69
- private endpointPolicies: Map<string, DyNTS_RateLimit_Policy> = new Map();
70
-
71
- /** Returns the process-wide rate-limit middleware. */
72
- public static getInstance(): DyNTS_RateLimit_Middleware {
73
- return DyNTS_RateLimit_Middleware.getSingletonInstance();
74
- }
75
-
76
- /** Applies a validated configuration atomically; invalid settings do not partially mutate the service. */
77
- public configure(config: DyNTS_RateLimit_Config): void {
78
- const snapshot: DyNTS_RateLimit_ConfigSnapshot_Interface = this.buildConfigSnapshot(config);
79
-
80
- this.defaultLimit = snapshot.defaultLimit;
81
- this.defaultWindowMs = snapshot.defaultWindowMs;
82
- this.isResponseHeadersEnabled = snapshot.isResponseHeadersEnabled;
83
- this.isSharedStoreRequired = snapshot.isSharedStoreRequired;
84
- this.keyExtractor = snapshot.keyExtractor;
85
- this.endpointGrouper = snapshot.endpointGrouper;
86
- this.costExtractor = snapshot.costExtractor;
87
- this.clock = snapshot.clock;
88
- this.store = snapshot.store;
89
- this.isKeyExtractorExplicit = snapshot.isKeyExtractorExplicit;
90
- this.isEndpointGrouperExplicit = snapshot.isEndpointGrouperExplicit;
91
- this.keyPolicies = snapshot.keyPolicies;
92
- this.endpointPolicies = snapshot.endpointPolicies;
93
- }
94
-
95
- /** Returns content-free configuration diagnostics. */
96
- public getConfig(): {
97
- defaultLimit: number;
98
- defaultWindowMs: number;
99
- responseHeaders: boolean;
100
- activeKeyPolicies: number;
101
- activeEndpointPolicies: number;
102
- trackedStorageKeys: number;
103
- storeKind: DyNTS_RateLimitStoreKind_Type;
104
- requireSharedStore: boolean;
105
- } {
106
- return {
107
- defaultLimit: this.defaultLimit,
108
- defaultWindowMs: this.defaultWindowMs,
109
- responseHeaders: this.isResponseHeadersEnabled,
110
- activeKeyPolicies: this.keyPolicies.size,
111
- activeEndpointPolicies: this.endpointPolicies.size,
112
- trackedStorageKeys: this.store instanceof DyNTS_RateLimit_InMemoryStore
113
- ? this.store.getTrackedBucketCount()
114
- : 0,
115
- storeKind: this.store.storeKind,
116
- requireSharedStore: this.isSharedStoreRequired,
117
- };
118
- }
119
-
120
- /** Sets one validated subject policy. */
121
- public setPolicyForKey(key: string, policy: DyNTS_RateLimit_Policy): void {
122
- this.assertBucketPart(key);
123
- this.assertPolicy(policy);
124
- this.keyPolicies.set(key, { ...policy });
125
- }
126
-
127
- /** Removes one subject policy. */
128
- public clearPolicyForKey(key: string): void {
129
- this.keyPolicies.delete(key);
130
- }
131
-
132
- /** Sets one validated endpoint-group policy. */
133
- public setPolicyForEndpoint(endpoint: string, policy: DyNTS_RateLimit_Policy): void {
134
- this.assertBucketPart(endpoint);
135
- this.assertPolicy(policy);
136
- this.endpointPolicies.set(endpoint, { ...policy });
137
- }
138
-
139
- /** Removes one endpoint-group policy. */
140
- public clearPolicyForEndpoint(endpoint: string): void {
141
- this.endpointPolicies.delete(endpoint);
142
- }
143
-
144
- /** Atomically consumes one request permit or raises a stable content-free error. */
145
- public readonly check = async (req: Request, res: Response): Promise<void> => {
146
- const subject: string = this.extractBucketPart(this.keyExtractor, req);
147
- const endpoint: string = this.extractBucketPart(this.endpointGrouper, req);
148
- const cost: number = this.extractCost(req);
149
-
150
- const policy: DyNTS_RateLimit_Policy = this.keyPolicies.get(subject)
151
- ?? this.endpointPolicies.get(endpoint)
152
- ?? { limit: this.defaultLimit, windowMs: this.defaultWindowMs };
153
-
154
- this.assertPolicy(policy);
155
- this.assertCost(cost, policy);
156
-
157
- const now: number = this.getNow();
158
- let result: unknown;
159
-
160
- try {
161
- result = await this.store.consume({
162
- bucketKey: this.buildBucketKey(subject, endpoint),
163
- policy: policy,
164
- cost: cost,
165
- now: now,
166
- });
167
- } catch {
168
- this.throwRateLimitError({
169
- status: 503,
170
- subcode: 'STORE_UNAVAILABLE',
171
- message: 'The configured rate-limit store could not commit a permit decision.',
172
- userMessage: 'Request protection is temporarily unavailable. Please try again later.',
173
- });
174
- }
175
-
176
- this.assertStoreResult(result, policy, now);
177
- this.setResponseHeaders(res, {
178
- policy: policy,
179
- result: result,
180
- now: now,
181
- });
182
-
183
- if (!result.allowed) {
184
- const retryAfterSeconds: number = this.getRetryAfterSeconds(result.resetAt, now);
185
-
186
- this.throwRateLimitError({
187
- status: 429,
188
- subcode: 'LIMIT',
189
- message: 'The rate-limit policy rejected a request.',
190
- userMessage: `Too many requests. Retry after ${retryAfterSeconds} seconds.`,
191
- });
192
- }
193
- };
194
-
195
- /** Performs explicit opportunistic cleanup only for the local test/development store. */
196
- public runGc(): void {
197
- if (this.store instanceof DyNTS_RateLimit_InMemoryStore) {
198
- this.store.cleanup(this.clock());
199
- }
200
- }
201
-
202
- /** Backward-compatible no-op: this implementation never starts a timer. */
203
- public stopGcTimer(): void {}
204
-
205
- /** Resets all state to deterministic local defaults for tests. */
206
- public _resetForTesting(): void {
207
- this.defaultLimit = DEFAULT_LIMIT;
208
- this.defaultWindowMs = DEFAULT_WINDOW_MS;
209
- this.isResponseHeadersEnabled = DEFAULT_RESPONSE_HEADERS;
210
- this.isSharedStoreRequired = false;
211
- this.isKeyExtractorExplicit = false;
212
- this.isEndpointGrouperExplicit = false;
213
- this.keyExtractor = (req: Request): string => req.ip ?? 'unknown';
214
- this.endpointGrouper = (req: Request): string => req.path;
215
- this.costExtractor = (req: Request): number => {
216
- void req;
217
-
218
- return 1;
219
- };
220
- this.clock = (): number => Date.now();
221
- this.store = new DyNTS_RateLimit_InMemoryStore();
222
- this.keyPolicies.clear();
223
- this.endpointPolicies.clear();
224
- }
225
-
226
- private buildConfigSnapshot(config: DyNTS_RateLimit_Config): DyNTS_RateLimit_ConfigSnapshot_Interface {
227
- const defaultLimit: number = config.defaultLimit ?? this.defaultLimit;
228
- const defaultWindowMs: number = config.defaultWindowMs ?? this.defaultWindowMs;
229
- const store: DyNTS_RateLimit_Store_Interface = config.store ?? this.store;
230
- const isSharedStoreRequired: boolean = config.requireSharedStore ?? this.isSharedStoreRequired;
231
- const isKeyExtractorExplicit: boolean = config.keyExtractor !== undefined || this.isKeyExtractorExplicit;
232
- const isEndpointGrouperExplicit: boolean = config.endpointGrouper !== undefined
233
- || this.isEndpointGrouperExplicit;
234
- const keyPolicies: Map<string, DyNTS_RateLimit_Policy> = new Map(this.keyPolicies);
235
- const endpointPolicies: Map<string, DyNTS_RateLimit_Policy> = new Map(this.endpointPolicies);
236
-
237
- this.assertPolicy({ limit: defaultLimit, windowMs: defaultWindowMs });
238
- this.assertConfigurationFunctions(config);
239
- this.assertStore(store);
240
- this.addInitialPolicies(keyPolicies, config.initialKeyPolicies);
241
- this.addInitialPolicies(endpointPolicies, config.initialEndpointPolicies);
242
-
243
- if (
244
- isSharedStoreRequired
245
- && (
246
- store.storeKind !== DyNTS_RateLimitStoreKind_Type.shared
247
- || !isKeyExtractorExplicit
248
- || !isEndpointGrouperExplicit
249
- )
250
- ) {
251
- this.throwRateLimitError({
252
- status: 500,
253
- subcode: 'SHARED_STORE_REQUIRED',
254
- message: 'Production rate limiting requires a shared store and explicit opaque bucket extractors.',
255
- userMessage: 'Request protection is not configured.',
256
- });
257
- }
258
-
259
- return {
260
- defaultLimit: defaultLimit,
261
- defaultWindowMs: defaultWindowMs,
262
- isResponseHeadersEnabled: config.responseHeaders ?? this.isResponseHeadersEnabled,
263
- isSharedStoreRequired: isSharedStoreRequired,
264
- keyExtractor: config.keyExtractor ?? this.keyExtractor,
265
- endpointGrouper: config.endpointGrouper ?? this.endpointGrouper,
266
- costExtractor: config.costExtractor ?? this.costExtractor,
267
- clock: config.clock ?? this.clock,
268
- store: store,
269
- isKeyExtractorExplicit: isKeyExtractorExplicit,
270
- isEndpointGrouperExplicit: isEndpointGrouperExplicit,
271
- keyPolicies: keyPolicies,
272
- endpointPolicies: endpointPolicies,
273
- };
274
- }
275
-
276
- private addInitialPolicies(
277
- target: Map<string, DyNTS_RateLimit_Policy>,
278
- policies?: Record<string, DyNTS_RateLimit_Policy>
279
- ): void {
280
- if (!policies) {
281
- return;
282
- }
283
-
284
- for (const entry of Object.entries(policies)) {
285
- const key: string = entry[0];
286
- const policy: DyNTS_RateLimit_Policy = entry[1];
287
-
288
- this.assertBucketPart(key);
289
- this.assertPolicy(policy);
290
- target.set(key, { ...policy });
291
- }
292
- }
293
-
294
- private assertPolicy(policy: DyNTS_RateLimit_Policy): void {
295
- if (
296
- !Number.isSafeInteger(policy.limit)
297
- || policy.limit <= 0
298
- || policy.limit > MAX_LIMIT
299
- || !Number.isSafeInteger(policy.windowMs)
300
- || policy.windowMs <= 0
301
- || policy.windowMs > MAX_WINDOW_MS
302
- ) {
303
- this.throwRateLimitError({
304
- status: 500,
305
- subcode: 'POLICY_INVALID',
306
- message: 'A rate-limit policy is outside the supported safety bounds.',
307
- userMessage: 'Request protection is not configured.',
308
- });
309
- }
310
- }
311
-
312
- private assertCost(cost: number, policy: DyNTS_RateLimit_Policy): void {
313
- if (!Number.isSafeInteger(cost) || cost <= 0 || cost > policy.limit) {
314
- this.throwRateLimitError({
315
- status: 500,
316
- subcode: 'COST_INVALID',
317
- message: 'A rate-limit request cost is outside the active policy.',
318
- userMessage: 'Request protection is not configured.',
319
- });
320
- }
321
- }
322
-
323
- private assertConfigurationFunctions(config: DyNTS_RateLimit_Config): void {
324
- const hasInvalidFunction: boolean = (
325
- config.keyExtractor !== undefined && typeof config.keyExtractor !== 'function'
326
- ) || (
327
- config.endpointGrouper !== undefined && typeof config.endpointGrouper !== 'function'
328
- ) || (
329
- config.costExtractor !== undefined && typeof config.costExtractor !== 'function'
330
- ) || (
331
- config.clock !== undefined && typeof config.clock !== 'function'
332
- );
333
-
334
- if (hasInvalidFunction) {
335
- this.throwRateLimitError({
336
- status: 500,
337
- subcode: 'CONFIG_INVALID',
338
- message: 'A rate-limit configuration callback is invalid.',
339
- userMessage: 'Request protection is not configured.',
340
- });
341
- }
342
- }
343
-
344
- private assertStore(store: DyNTS_RateLimit_Store_Interface): void {
345
- const hasKnownKind: boolean = store?.storeKind === DyNTS_RateLimitStoreKind_Type.inMemory
346
- || store?.storeKind === DyNTS_RateLimitStoreKind_Type.shared;
347
-
348
- if (!hasKnownKind || typeof store.consume !== 'function') {
349
- this.throwRateLimitError({
350
- status: 500,
351
- subcode: 'STORE_INVALID',
352
- message: 'The configured rate-limit store does not satisfy the Bedrock contract.',
353
- userMessage: 'Request protection is not configured.',
354
- });
355
- }
356
- }
357
-
358
- private extractBucketPart(extractor: (req: Request) => string, req: Request): string {
359
- let value: unknown;
360
-
361
- try {
362
- value = extractor(req);
363
- } catch {
364
- value = undefined;
365
- }
366
-
367
- if (typeof value !== 'string') {
368
- this.throwBucketKeyInvalid();
369
- }
370
-
371
- const normalized: string = value.trim();
372
-
373
- this.assertBucketPart(normalized);
374
-
375
- return normalized;
376
- }
377
-
378
- private extractCost(req: Request): number {
379
- try {
380
- return this.costExtractor(req);
381
- } catch {
382
- this.throwRateLimitError({
383
- status: 500,
384
- subcode: 'COST_INVALID',
385
- message: 'The rate-limit request cost could not be derived.',
386
- userMessage: 'Request protection is not configured.',
387
- });
388
- }
389
- }
390
-
391
- private buildBucketKey(subject: string, endpoint: string): string {
392
- return `${subject.length}:${subject}${endpoint.length}:${endpoint}`;
393
- }
394
-
395
- private getNow(): number {
396
- let now: unknown;
397
-
398
- try {
399
- now = this.clock();
400
- } catch {
401
- now = undefined;
402
- }
403
-
404
- if (!Number.isSafeInteger(now) || typeof now !== 'number' || now < 0) {
405
- this.throwRateLimitError({
406
- status: 503,
407
- subcode: 'CLOCK_INVALID',
408
- message: 'The rate-limit clock returned an invalid timestamp.',
409
- userMessage: 'Request protection is temporarily unavailable. Please try again later.',
410
- });
411
- }
412
-
413
- return now;
414
- }
415
-
416
- private assertBucketPart(value: string): void {
417
- if (!value || value.length > MAX_BUCKET_PART_LENGTH) {
418
- this.throwBucketKeyInvalid();
419
- }
420
- }
421
-
422
- private throwBucketKeyInvalid(): never {
423
- this.throwRateLimitError({
424
- status: 500,
425
- subcode: 'BUCKET_KEY_INVALID',
426
- message: 'A rate-limit bucket component is missing, invalid or too large.',
427
- userMessage: 'Request protection is not configured.',
428
- });
429
- }
430
-
431
- private assertStoreResult(
432
- result: unknown,
433
- policy: DyNTS_RateLimit_Policy,
434
- now: number
435
- ): asserts result is DyNTS_RateLimit_ConsumeResult_Interface {
436
- const isValid: boolean = typeof result === 'object'
437
- && result !== null
438
- && 'allowed' in result
439
- && 'remaining' in result
440
- && 'resetAt' in result
441
- && typeof result.allowed === 'boolean'
442
- && typeof result.remaining === 'number'
443
- && Number.isSafeInteger(result.remaining)
444
- && result.remaining >= 0
445
- && result.remaining <= policy.limit
446
- && typeof result.resetAt === 'number'
447
- && Number.isSafeInteger(result.resetAt)
448
- && result.resetAt >= now;
449
-
450
- if (!isValid) {
451
- this.throwRateLimitError({
452
- status: 503,
453
- subcode: 'STORE_RESULT_INVALID',
454
- message: 'The rate-limit store returned an invalid permit decision.',
455
- userMessage: 'Request protection is temporarily unavailable. Please try again later.',
456
- });
457
- }
458
- }
459
-
460
- private setResponseHeaders(
461
- res: Response,
462
- context: DyNTS_RateLimit_HeaderContext_Interface
463
- ): void {
464
- if (!this.isResponseHeadersEnabled) {
465
- return;
466
- }
467
-
468
- const resetSeconds: string = Math.ceil(context.result.resetAt / 1_000).toString();
469
-
470
- res.setHeader('X-RateLimit-Limit', context.policy.limit.toString());
471
- res.setHeader('X-RateLimit-Remaining', context.result.remaining.toString());
472
- res.setHeader('X-RateLimit-Reset', resetSeconds);
473
- res.setHeader('RateLimit-Limit', context.policy.limit.toString());
474
- res.setHeader('RateLimit-Remaining', context.result.remaining.toString());
475
- res.setHeader(
476
- 'RateLimit-Reset',
477
- Math.max(0, Math.ceil((context.result.resetAt - context.now) / 1_000)).toString()
478
- );
479
-
480
- if (!context.result.allowed) {
481
- res.setHeader(
482
- 'Retry-After',
483
- this.getRetryAfterSeconds(context.result.resetAt, context.now).toString()
484
- );
485
- }
486
- }
487
-
488
- private getRetryAfterSeconds(resetAt: number, now: number): number {
489
- return Math.max(1, Math.ceil((resetAt - now) / 1_000));
490
- }
491
-
492
- private throwRateLimitError(context: DyNTS_RateLimit_ErrorContext_Interface): never {
493
- const systemShortCode: string = DyNTS_global_settings.systemShortCodeName ?? 'DyNTS';
494
-
495
- throw new DyFM_Error({
496
- status: context.status,
497
- errorCode: `${systemShortCode}|DyNTS-RL-${context.subcode}`,
498
- addECToUserMsg: true,
499
- message: context.message,
500
- userMessage: context.userMessage,
501
- issuerService: SERVICE_NAME,
502
- });
503
- }
504
- }
1
+ import { Request, Response } from 'express';
2
+
3
+ import { DyFM_Error } from '@futdevpro/fsm-dynamo';
4
+
5
+ import { DyNTS_global_settings } from '../../_collections/global-settings.const';
6
+ import { DyNTS_SingletonServiceBase } from '../../_services/base/singleton.service-base';
7
+ import { DyNTS_RateLimitStoreKind_Type } from './_enums/rate-limit-store-kind.type-enum';
8
+ import { DyNTS_RateLimit_Config } from './_models/rate-limit-config.interface';
9
+ import { DyNTS_RateLimit_ConsumeResult_Interface } from './_models/rate-limit-consume-result.interface';
10
+ import { DyNTS_RateLimit_Policy } from './_models/rate-limit-policy.interface';
11
+ import { DyNTS_RateLimit_Store_Interface } from './_models/rate-limit-store.interface';
12
+ import { DyNTS_RateLimit_InMemoryStore } from './rate-limit-in-memory.store';
13
+
14
+ const DEFAULT_LIMIT: number = 100;
15
+ const DEFAULT_WINDOW_MS: number = 60_000;
16
+ const DEFAULT_RESPONSE_HEADERS: boolean = true;
17
+ const MAX_LIMIT: number = 1_000_000;
18
+ const MAX_WINDOW_MS: number = 7 * 24 * 60 * 60 * 1_000;
19
+ const MAX_BUCKET_PART_LENGTH: number = 240;
20
+ const SERVICE_NAME: string = 'DyNTS_RateLimit_Middleware';
21
+
22
+ interface DyNTS_RateLimit_ErrorContext_Interface {
23
+ status: number;
24
+ subcode: string;
25
+ message: string;
26
+ userMessage: string;
27
+ }
28
+
29
+ interface DyNTS_RateLimit_HeaderContext_Interface {
30
+ policy: DyNTS_RateLimit_Policy;
31
+ result: DyNTS_RateLimit_ConsumeResult_Interface;
32
+ now: number;
33
+ }
34
+
35
+ interface DyNTS_RateLimit_ConfigSnapshot_Interface {
36
+ defaultLimit: number;
37
+ defaultWindowMs: number;
38
+ isResponseHeadersEnabled: boolean;
39
+ isSharedStoreRequired: boolean;
40
+ keyExtractor: (req: Request) => string;
41
+ endpointGrouper: (req: Request) => string;
42
+ costExtractor: (req: Request) => number;
43
+ clock: () => number;
44
+ store: DyNTS_RateLimit_Store_Interface;
45
+ isKeyExtractorExplicit: boolean;
46
+ isEndpointGrouperExplicit: boolean;
47
+ keyPolicies: Map<string, DyNTS_RateLimit_Policy>;
48
+ endpointPolicies: Map<string, DyNTS_RateLimit_Policy>;
49
+ }
50
+
51
+ /** Atomic HTTP rate-limit boundary with an explicit shared-store production gate. */
52
+ export class DyNTS_RateLimit_Middleware extends DyNTS_SingletonServiceBase {
53
+ private defaultLimit: number = DEFAULT_LIMIT;
54
+ private defaultWindowMs: number = DEFAULT_WINDOW_MS;
55
+ private isResponseHeadersEnabled: boolean = DEFAULT_RESPONSE_HEADERS;
56
+ private isSharedStoreRequired: boolean = false;
57
+ private isKeyExtractorExplicit: boolean = false;
58
+ private isEndpointGrouperExplicit: boolean = false;
59
+ private keyExtractor: (req: Request) => string = (req: Request): string => req.ip ?? 'unknown';
60
+ private endpointGrouper: (req: Request) => string = (req: Request): string => req.path;
61
+ private costExtractor: (req: Request) => number = (req: Request): number => {
62
+ void req;
63
+
64
+ return 1;
65
+ };
66
+ private clock: () => number = (): number => Date.now();
67
+ private store: DyNTS_RateLimit_Store_Interface = new DyNTS_RateLimit_InMemoryStore();
68
+ private keyPolicies: Map<string, DyNTS_RateLimit_Policy> = new Map();
69
+ private endpointPolicies: Map<string, DyNTS_RateLimit_Policy> = new Map();
70
+
71
+ /** Returns the process-wide rate-limit middleware. */
72
+ public static getInstance(): DyNTS_RateLimit_Middleware {
73
+ return DyNTS_RateLimit_Middleware.getSingletonInstance();
74
+ }
75
+
76
+ /** Applies a validated configuration atomically; invalid settings do not partially mutate the service. */
77
+ public configure(config: DyNTS_RateLimit_Config): void {
78
+ const snapshot: DyNTS_RateLimit_ConfigSnapshot_Interface = this.buildConfigSnapshot(config);
79
+
80
+ this.defaultLimit = snapshot.defaultLimit;
81
+ this.defaultWindowMs = snapshot.defaultWindowMs;
82
+ this.isResponseHeadersEnabled = snapshot.isResponseHeadersEnabled;
83
+ this.isSharedStoreRequired = snapshot.isSharedStoreRequired;
84
+ this.keyExtractor = snapshot.keyExtractor;
85
+ this.endpointGrouper = snapshot.endpointGrouper;
86
+ this.costExtractor = snapshot.costExtractor;
87
+ this.clock = snapshot.clock;
88
+ this.store = snapshot.store;
89
+ this.isKeyExtractorExplicit = snapshot.isKeyExtractorExplicit;
90
+ this.isEndpointGrouperExplicit = snapshot.isEndpointGrouperExplicit;
91
+ this.keyPolicies = snapshot.keyPolicies;
92
+ this.endpointPolicies = snapshot.endpointPolicies;
93
+ }
94
+
95
+ /** Returns content-free configuration diagnostics. */
96
+ public getConfig(): {
97
+ defaultLimit: number;
98
+ defaultWindowMs: number;
99
+ responseHeaders: boolean;
100
+ activeKeyPolicies: number;
101
+ activeEndpointPolicies: number;
102
+ trackedStorageKeys: number;
103
+ storeKind: DyNTS_RateLimitStoreKind_Type;
104
+ requireSharedStore: boolean;
105
+ } {
106
+ return {
107
+ defaultLimit: this.defaultLimit,
108
+ defaultWindowMs: this.defaultWindowMs,
109
+ responseHeaders: this.isResponseHeadersEnabled,
110
+ activeKeyPolicies: this.keyPolicies.size,
111
+ activeEndpointPolicies: this.endpointPolicies.size,
112
+ trackedStorageKeys: this.store instanceof DyNTS_RateLimit_InMemoryStore
113
+ ? this.store.getTrackedBucketCount()
114
+ : 0,
115
+ storeKind: this.store.storeKind,
116
+ requireSharedStore: this.isSharedStoreRequired,
117
+ };
118
+ }
119
+
120
+ /** Sets one validated subject policy. */
121
+ public setPolicyForKey(key: string, policy: DyNTS_RateLimit_Policy): void {
122
+ this.assertBucketPart(key);
123
+ this.assertPolicy(policy);
124
+ this.keyPolicies.set(key, { ...policy });
125
+ }
126
+
127
+ /** Removes one subject policy. */
128
+ public clearPolicyForKey(key: string): void {
129
+ this.keyPolicies.delete(key);
130
+ }
131
+
132
+ /** Sets one validated endpoint-group policy. */
133
+ public setPolicyForEndpoint(endpoint: string, policy: DyNTS_RateLimit_Policy): void {
134
+ this.assertBucketPart(endpoint);
135
+ this.assertPolicy(policy);
136
+ this.endpointPolicies.set(endpoint, { ...policy });
137
+ }
138
+
139
+ /** Removes one endpoint-group policy. */
140
+ public clearPolicyForEndpoint(endpoint: string): void {
141
+ this.endpointPolicies.delete(endpoint);
142
+ }
143
+
144
+ /** Atomically consumes one request permit or raises a stable content-free error. */
145
+ public readonly check = async (req: Request, res: Response): Promise<void> => {
146
+ const subject: string = this.extractBucketPart(this.keyExtractor, req);
147
+ const endpoint: string = this.extractBucketPart(this.endpointGrouper, req);
148
+ const cost: number = this.extractCost(req);
149
+
150
+ const policy: DyNTS_RateLimit_Policy = this.keyPolicies.get(subject)
151
+ ?? this.endpointPolicies.get(endpoint)
152
+ ?? { limit: this.defaultLimit, windowMs: this.defaultWindowMs };
153
+
154
+ this.assertPolicy(policy);
155
+ this.assertCost(cost, policy);
156
+
157
+ const now: number = this.getNow();
158
+ let result: unknown;
159
+
160
+ try {
161
+ result = await this.store.consume({
162
+ bucketKey: this.buildBucketKey(subject, endpoint),
163
+ policy: policy,
164
+ cost: cost,
165
+ now: now,
166
+ });
167
+ } catch {
168
+ this.throwRateLimitError({
169
+ status: 503,
170
+ subcode: 'STORE_UNAVAILABLE',
171
+ message: 'The configured rate-limit store could not commit a permit decision.',
172
+ userMessage: 'Request protection is temporarily unavailable. Please try again later.',
173
+ });
174
+ }
175
+
176
+ this.assertStoreResult(result, policy, now);
177
+ this.setResponseHeaders(res, {
178
+ policy: policy,
179
+ result: result,
180
+ now: now,
181
+ });
182
+
183
+ if (!result.allowed) {
184
+ const retryAfterSeconds: number = this.getRetryAfterSeconds(result.resetAt, now);
185
+
186
+ this.throwRateLimitError({
187
+ status: 429,
188
+ subcode: 'LIMIT',
189
+ message: 'The rate-limit policy rejected a request.',
190
+ userMessage: `Too many requests. Retry after ${retryAfterSeconds} seconds.`,
191
+ });
192
+ }
193
+ };
194
+
195
+ /** Performs explicit opportunistic cleanup only for the local test/development store. */
196
+ public runGc(): void {
197
+ if (this.store instanceof DyNTS_RateLimit_InMemoryStore) {
198
+ this.store.cleanup(this.clock());
199
+ }
200
+ }
201
+
202
+ /** Backward-compatible no-op: this implementation never starts a timer. */
203
+ public stopGcTimer(): void {}
204
+
205
+ /** Resets all state to deterministic local defaults for tests. */
206
+ public _resetForTesting(): void {
207
+ this.defaultLimit = DEFAULT_LIMIT;
208
+ this.defaultWindowMs = DEFAULT_WINDOW_MS;
209
+ this.isResponseHeadersEnabled = DEFAULT_RESPONSE_HEADERS;
210
+ this.isSharedStoreRequired = false;
211
+ this.isKeyExtractorExplicit = false;
212
+ this.isEndpointGrouperExplicit = false;
213
+ this.keyExtractor = (req: Request): string => req.ip ?? 'unknown';
214
+ this.endpointGrouper = (req: Request): string => req.path;
215
+ this.costExtractor = (req: Request): number => {
216
+ void req;
217
+
218
+ return 1;
219
+ };
220
+ this.clock = (): number => Date.now();
221
+ this.store = new DyNTS_RateLimit_InMemoryStore();
222
+ this.keyPolicies.clear();
223
+ this.endpointPolicies.clear();
224
+ }
225
+
226
+ private buildConfigSnapshot(config: DyNTS_RateLimit_Config): DyNTS_RateLimit_ConfigSnapshot_Interface {
227
+ const defaultLimit: number = config.defaultLimit ?? this.defaultLimit;
228
+ const defaultWindowMs: number = config.defaultWindowMs ?? this.defaultWindowMs;
229
+ const store: DyNTS_RateLimit_Store_Interface = config.store ?? this.store;
230
+ const isSharedStoreRequired: boolean = config.requireSharedStore ?? this.isSharedStoreRequired;
231
+ const isKeyExtractorExplicit: boolean = config.keyExtractor !== undefined || this.isKeyExtractorExplicit;
232
+ const isEndpointGrouperExplicit: boolean = config.endpointGrouper !== undefined
233
+ || this.isEndpointGrouperExplicit;
234
+ const keyPolicies: Map<string, DyNTS_RateLimit_Policy> = new Map(this.keyPolicies);
235
+ const endpointPolicies: Map<string, DyNTS_RateLimit_Policy> = new Map(this.endpointPolicies);
236
+
237
+ this.assertPolicy({ limit: defaultLimit, windowMs: defaultWindowMs });
238
+ this.assertConfigurationFunctions(config);
239
+ this.assertStore(store);
240
+ this.addInitialPolicies(keyPolicies, config.initialKeyPolicies);
241
+ this.addInitialPolicies(endpointPolicies, config.initialEndpointPolicies);
242
+
243
+ if (
244
+ isSharedStoreRequired
245
+ && (
246
+ store.storeKind !== DyNTS_RateLimitStoreKind_Type.shared
247
+ || !isKeyExtractorExplicit
248
+ || !isEndpointGrouperExplicit
249
+ )
250
+ ) {
251
+ this.throwRateLimitError({
252
+ status: 500,
253
+ subcode: 'SHARED_STORE_REQUIRED',
254
+ message: 'Production rate limiting requires a shared store and explicit opaque bucket extractors.',
255
+ userMessage: 'Request protection is not configured.',
256
+ });
257
+ }
258
+
259
+ return {
260
+ defaultLimit: defaultLimit,
261
+ defaultWindowMs: defaultWindowMs,
262
+ isResponseHeadersEnabled: config.responseHeaders ?? this.isResponseHeadersEnabled,
263
+ isSharedStoreRequired: isSharedStoreRequired,
264
+ keyExtractor: config.keyExtractor ?? this.keyExtractor,
265
+ endpointGrouper: config.endpointGrouper ?? this.endpointGrouper,
266
+ costExtractor: config.costExtractor ?? this.costExtractor,
267
+ clock: config.clock ?? this.clock,
268
+ store: store,
269
+ isKeyExtractorExplicit: isKeyExtractorExplicit,
270
+ isEndpointGrouperExplicit: isEndpointGrouperExplicit,
271
+ keyPolicies: keyPolicies,
272
+ endpointPolicies: endpointPolicies,
273
+ };
274
+ }
275
+
276
+ private addInitialPolicies(
277
+ target: Map<string, DyNTS_RateLimit_Policy>,
278
+ policies?: Record<string, DyNTS_RateLimit_Policy>
279
+ ): void {
280
+ if (!policies) {
281
+ return;
282
+ }
283
+
284
+ for (const entry of Object.entries(policies)) {
285
+ const key: string = entry[0];
286
+ const policy: DyNTS_RateLimit_Policy = entry[1];
287
+
288
+ this.assertBucketPart(key);
289
+ this.assertPolicy(policy);
290
+ target.set(key, { ...policy });
291
+ }
292
+ }
293
+
294
+ private assertPolicy(policy: DyNTS_RateLimit_Policy): void {
295
+ if (
296
+ !Number.isSafeInteger(policy.limit)
297
+ || policy.limit <= 0
298
+ || policy.limit > MAX_LIMIT
299
+ || !Number.isSafeInteger(policy.windowMs)
300
+ || policy.windowMs <= 0
301
+ || policy.windowMs > MAX_WINDOW_MS
302
+ ) {
303
+ this.throwRateLimitError({
304
+ status: 500,
305
+ subcode: 'POLICY_INVALID',
306
+ message: 'A rate-limit policy is outside the supported safety bounds.',
307
+ userMessage: 'Request protection is not configured.',
308
+ });
309
+ }
310
+ }
311
+
312
+ private assertCost(cost: number, policy: DyNTS_RateLimit_Policy): void {
313
+ if (!Number.isSafeInteger(cost) || cost <= 0 || cost > policy.limit) {
314
+ this.throwRateLimitError({
315
+ status: 500,
316
+ subcode: 'COST_INVALID',
317
+ message: 'A rate-limit request cost is outside the active policy.',
318
+ userMessage: 'Request protection is not configured.',
319
+ });
320
+ }
321
+ }
322
+
323
+ private assertConfigurationFunctions(config: DyNTS_RateLimit_Config): void {
324
+ const hasInvalidFunction: boolean = (
325
+ config.keyExtractor !== undefined && typeof config.keyExtractor !== 'function'
326
+ ) || (
327
+ config.endpointGrouper !== undefined && typeof config.endpointGrouper !== 'function'
328
+ ) || (
329
+ config.costExtractor !== undefined && typeof config.costExtractor !== 'function'
330
+ ) || (
331
+ config.clock !== undefined && typeof config.clock !== 'function'
332
+ );
333
+
334
+ if (hasInvalidFunction) {
335
+ this.throwRateLimitError({
336
+ status: 500,
337
+ subcode: 'CONFIG_INVALID',
338
+ message: 'A rate-limit configuration callback is invalid.',
339
+ userMessage: 'Request protection is not configured.',
340
+ });
341
+ }
342
+ }
343
+
344
+ private assertStore(store: DyNTS_RateLimit_Store_Interface): void {
345
+ const hasKnownKind: boolean = store?.storeKind === DyNTS_RateLimitStoreKind_Type.inMemory
346
+ || store?.storeKind === DyNTS_RateLimitStoreKind_Type.shared;
347
+
348
+ if (!hasKnownKind || typeof store.consume !== 'function') {
349
+ this.throwRateLimitError({
350
+ status: 500,
351
+ subcode: 'STORE_INVALID',
352
+ message: 'The configured rate-limit store does not satisfy the Bedrock contract.',
353
+ userMessage: 'Request protection is not configured.',
354
+ });
355
+ }
356
+ }
357
+
358
+ private extractBucketPart(extractor: (req: Request) => string, req: Request): string {
359
+ let value: unknown;
360
+
361
+ try {
362
+ value = extractor(req);
363
+ } catch {
364
+ value = undefined;
365
+ }
366
+
367
+ if (typeof value !== 'string') {
368
+ this.throwBucketKeyInvalid();
369
+ }
370
+
371
+ const normalized: string = value.trim();
372
+
373
+ this.assertBucketPart(normalized);
374
+
375
+ return normalized;
376
+ }
377
+
378
+ private extractCost(req: Request): number {
379
+ try {
380
+ return this.costExtractor(req);
381
+ } catch {
382
+ this.throwRateLimitError({
383
+ status: 500,
384
+ subcode: 'COST_INVALID',
385
+ message: 'The rate-limit request cost could not be derived.',
386
+ userMessage: 'Request protection is not configured.',
387
+ });
388
+ }
389
+ }
390
+
391
+ private buildBucketKey(subject: string, endpoint: string): string {
392
+ return `${subject.length}:${subject}${endpoint.length}:${endpoint}`;
393
+ }
394
+
395
+ private getNow(): number {
396
+ let now: unknown;
397
+
398
+ try {
399
+ now = this.clock();
400
+ } catch {
401
+ now = undefined;
402
+ }
403
+
404
+ if (!Number.isSafeInteger(now) || typeof now !== 'number' || now < 0) {
405
+ this.throwRateLimitError({
406
+ status: 503,
407
+ subcode: 'CLOCK_INVALID',
408
+ message: 'The rate-limit clock returned an invalid timestamp.',
409
+ userMessage: 'Request protection is temporarily unavailable. Please try again later.',
410
+ });
411
+ }
412
+
413
+ return now;
414
+ }
415
+
416
+ private assertBucketPart(value: string): void {
417
+ if (!value || value.length > MAX_BUCKET_PART_LENGTH) {
418
+ this.throwBucketKeyInvalid();
419
+ }
420
+ }
421
+
422
+ private throwBucketKeyInvalid(): never {
423
+ this.throwRateLimitError({
424
+ status: 500,
425
+ subcode: 'BUCKET_KEY_INVALID',
426
+ message: 'A rate-limit bucket component is missing, invalid or too large.',
427
+ userMessage: 'Request protection is not configured.',
428
+ });
429
+ }
430
+
431
+ private assertStoreResult(
432
+ result: unknown,
433
+ policy: DyNTS_RateLimit_Policy,
434
+ now: number
435
+ ): asserts result is DyNTS_RateLimit_ConsumeResult_Interface {
436
+ const isValid: boolean = typeof result === 'object'
437
+ && result !== null
438
+ && 'allowed' in result
439
+ && 'remaining' in result
440
+ && 'resetAt' in result
441
+ && typeof result.allowed === 'boolean'
442
+ && typeof result.remaining === 'number'
443
+ && Number.isSafeInteger(result.remaining)
444
+ && result.remaining >= 0
445
+ && result.remaining <= policy.limit
446
+ && typeof result.resetAt === 'number'
447
+ && Number.isSafeInteger(result.resetAt)
448
+ && result.resetAt >= now;
449
+
450
+ if (!isValid) {
451
+ this.throwRateLimitError({
452
+ status: 503,
453
+ subcode: 'STORE_RESULT_INVALID',
454
+ message: 'The rate-limit store returned an invalid permit decision.',
455
+ userMessage: 'Request protection is temporarily unavailable. Please try again later.',
456
+ });
457
+ }
458
+ }
459
+
460
+ private setResponseHeaders(
461
+ res: Response,
462
+ context: DyNTS_RateLimit_HeaderContext_Interface
463
+ ): void {
464
+ if (!this.isResponseHeadersEnabled) {
465
+ return;
466
+ }
467
+
468
+ const resetSeconds: string = Math.ceil(context.result.resetAt / 1_000).toString();
469
+
470
+ res.setHeader('X-RateLimit-Limit', context.policy.limit.toString());
471
+ res.setHeader('X-RateLimit-Remaining', context.result.remaining.toString());
472
+ res.setHeader('X-RateLimit-Reset', resetSeconds);
473
+ res.setHeader('RateLimit-Limit', context.policy.limit.toString());
474
+ res.setHeader('RateLimit-Remaining', context.result.remaining.toString());
475
+ res.setHeader(
476
+ 'RateLimit-Reset',
477
+ Math.max(0, Math.ceil((context.result.resetAt - context.now) / 1_000)).toString()
478
+ );
479
+
480
+ if (!context.result.allowed) {
481
+ res.setHeader(
482
+ 'Retry-After',
483
+ this.getRetryAfterSeconds(context.result.resetAt, context.now).toString()
484
+ );
485
+ }
486
+ }
487
+
488
+ private getRetryAfterSeconds(resetAt: number, now: number): number {
489
+ return Math.max(1, Math.ceil((resetAt - now) / 1_000));
490
+ }
491
+
492
+ private throwRateLimitError(context: DyNTS_RateLimit_ErrorContext_Interface): never {
493
+ const systemShortCode: string = DyNTS_global_settings.systemShortCodeName ?? 'DyNTS';
494
+
495
+ throw new DyFM_Error({
496
+ status: context.status,
497
+ errorCode: `${systemShortCode}|DyNTS-RL-${context.subcode}`,
498
+ addECToUserMsg: true,
499
+ message: context.message,
500
+ userMessage: context.userMessage,
501
+ issuerService: SERVICE_NAME,
502
+ });
503
+ }
504
+ }