@futdevpro/nts-dynamo 1.15.52 → 1.15.54

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 (331) 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/_ag_backend-structure.mdc +85 -85
  5. package/.cursor/rules/_ag_backend.mdc +16 -16
  6. package/.cursor/rules/_ag_frontend-structure.mdc +86 -86
  7. package/.cursor/rules/_ag_frontend.mdc +39 -39
  8. package/.cursor/rules/_ag_import-rules.mdc +44 -44
  9. package/.cursor/rules/_ag_naming.mdc +115 -115
  10. package/.cursor/rules/_ag_should-be.mdc +6 -6
  11. package/.cursor/rules/ai_development_guide.md +60 -60
  12. package/.cursor/rules/cursor-rules.md +160 -160
  13. package/.cursor/rules/default-command.mdc +464 -464
  14. package/.cursor/rules/error_code_pattern.md +39 -39
  15. package/.cursor/rules/saved rule mcp server use.md +15 -15
  16. package/.dynamo/pipeline.cicd.config.json +19 -1
  17. package/.github/workflows/main.yml +432 -432
  18. package/.vscode/settings.json +10 -10
  19. package/HOWTO.md +15 -15
  20. package/LICENSE +21 -21
  21. package/__documentations/nts-integration-tests-2026-03-17.md +26 -26
  22. package/_specifications/BACKLOG.md +92 -92
  23. package/_specifications/TODO.md +15 -15
  24. package/_specifications/agent.md +138 -138
  25. package/build/_modules/server/server-status/server-status.controller.d.ts.map +1 -1
  26. package/build/_modules/server/server-status/server-status.controller.js +14 -6
  27. package/build/_modules/server/server-status/server-status.controller.js.map +1 -1
  28. package/build/_services/server/app.server.d.ts +16 -0
  29. package/build/_services/server/app.server.d.ts.map +1 -1
  30. package/build/_services/server/app.server.js +24 -0
  31. package/build/_services/server/app.server.js.map +1 -1
  32. package/eslint.config.js +3 -3
  33. package/nodemon.json +24 -24
  34. package/package.json +1 -1
  35. package/pnpm-workspace.yaml +4 -4
  36. package/scripts/run-coverage-tests.js +28 -28
  37. package/spec/support/helpers/spec-reporter-loader.js +359 -359
  38. package/spec/support/helpers/ts-node-helper.js +93 -93
  39. package/spec/support/jasmine.coverage.json +24 -24
  40. package/spec/support/jasmine.json +24 -24
  41. package/src/_collections/archive.util.spec.ts +57 -57
  42. package/src/_collections/archive.util.ts +18 -18
  43. package/src/_collections/atlas-default-db-options.const.ts +9 -9
  44. package/src/_collections/default-fallback-cache-max-age.const.spec.ts +11 -11
  45. package/src/_collections/default-fallback-cache-max-age.const.ts +2 -2
  46. package/src/_collections/default-not-found-page.const.spec.ts +19 -19
  47. package/src/_collections/default-not-found-page.const.ts +22 -22
  48. package/src/_collections/default-socket-path.const.spec.ts +12 -12
  49. package/src/_collections/default-socket-path.const.ts +2 -2
  50. package/src/_collections/get-environment-settings.util.spec.ts +210 -210
  51. package/src/_collections/get-environment-settings.util.ts +48 -48
  52. package/src/_collections/global-settings.const.ts +70 -70
  53. package/src/_collections/sample.env +21 -21
  54. package/src/_collections/star.controller.spec.ts +224 -224
  55. package/src/_collections/star.controller.ts +129 -129
  56. package/src/_enums/data-model-type.enum.ts +14 -14
  57. package/src/_enums/data-service-function.enum.ts +24 -24
  58. package/src/_enums/predefined-data-types.enum.ts +16 -16
  59. package/src/_enums/route-security.enum.ts +12 -12
  60. package/src/_models/control-models/api-call-params.control-model.spec.ts +152 -152
  61. package/src/_models/control-models/api-call-params.control-model.ts +142 -142
  62. package/src/_models/control-models/app-ext-system-controls.control-model.spec.ts +52 -52
  63. package/src/_models/control-models/app-ext-system-controls.control-model.ts +9 -9
  64. package/src/_models/control-models/app-params.control-model.spec.ts +225 -225
  65. package/src/_models/control-models/app-params.control-model.ts +136 -136
  66. package/src/_models/control-models/app-system-controls.control-model.spec.ts +31 -31
  67. package/src/_models/control-models/app-system-controls.control-model.ts +9 -9
  68. package/src/_models/control-models/endpoint-params.control-model.spec.ts +627 -627
  69. package/src/_models/control-models/endpoint-params.control-model.ts +627 -627
  70. package/src/_models/control-models/http-settings.control-model.spec.ts +77 -77
  71. package/src/_models/control-models/http-settings.control-model.ts +37 -37
  72. package/src/_models/control-models/system-control.control-model.spec.ts +27 -27
  73. package/src/_models/control-models/system-control.control-model.ts +12 -12
  74. package/src/_models/interfaces/certification-settings.interface.ts +7 -7
  75. package/src/_models/interfaces/environment-settings.interface.ts +59 -59
  76. package/src/_models/interfaces/global-log-settings.interface.ts +144 -144
  77. package/src/_models/interfaces/global-service-settings.interface.ts +47 -47
  78. package/src/_models/interfaces/routing-module-settings.interface.ts +21 -21
  79. package/src/_models/interfaces/static-client-settings.interface.spec.ts +29 -29
  80. package/src/_models/interfaces/static-client-settings.interface.ts +28 -28
  81. package/src/_models/types/db-update.type.ts +100 -100
  82. package/src/_modules/ai/_models/ai-input-interfaces.ts +117 -117
  83. package/src/_modules/ai/_models/ai-test-generation-result.interface.ts +16 -16
  84. package/src/_modules/ai/_modules/anthropic/_services/aai-user-key.control-service.ts +138 -138
  85. package/src/_modules/ai/_modules/anthropic/index.ts +5 -5
  86. package/src/_modules/ai/_modules/document-ai/_collections/dai-chunking.util.spec.ts +242 -242
  87. package/src/_modules/ai/_modules/document-ai/_collections/dai-chunking.util.ts +639 -639
  88. package/src/_modules/ai/_modules/document-ai/_collections/dai-document.util.spec.ts +209 -209
  89. package/src/_modules/ai/_modules/document-ai/_collections/dai-document.util.ts +85 -85
  90. package/src/_modules/ai/_modules/document-ai/_enums/dai-compare-result-type.enum.ts +7 -7
  91. package/src/_modules/ai/_modules/document-ai/_models/data-models/dai-doc-chunk.data-model.ts +146 -146
  92. package/src/_modules/ai/_modules/document-ai/_models/data-models/dai-doc-page.data-model.ts +162 -162
  93. package/src/_modules/ai/_modules/document-ai/_models/data-models/dai-document.data-model.ts +99 -99
  94. package/src/_modules/ai/_modules/document-ai/_models/interfaces/dai-doc-chunk-compare-result.interface.ts +18 -18
  95. package/src/_modules/ai/_modules/document-ai/_models/interfaces/dai-doc-page-compare-result.interface.ts +19 -19
  96. package/src/_modules/ai/_modules/document-ai/_models/interfaces/dai-document-compare-result.interface.ts +25 -25
  97. package/src/_modules/ai/_modules/document-ai/index.ts +28 -28
  98. package/src/_modules/ai/_modules/fdp-ai/_services/fdpai-user-key.control-service.ts +189 -189
  99. package/src/_modules/ai/_modules/fdp-ai/index.ts +5 -5
  100. package/src/_modules/ai/_modules/open-ai/_collections/oai-global-settings.const.ts +9 -9
  101. package/src/_modules/ai/_modules/open-ai/_collections/oai-llm-predefined-requests-hu.conts.ts +82 -82
  102. package/src/_modules/ai/_modules/open-ai/_collections/oai-llm-predefined-requests.conts.ts +75 -75
  103. package/src/_modules/ai/_modules/open-ai/_enums/oai-gpt-message-role.enum.ts +45 -45
  104. package/src/_modules/ai/_modules/open-ai/_models/interfaces/oai-global-settings.interface.ts +7 -7
  105. package/src/_modules/ai/_modules/open-ai/_models/interfaces/oai-gpt-message.interface.ts +7 -7
  106. package/src/_modules/ai/_modules/open-ai/_models/interfaces/oai-llm-predefined-requests.interface.ts +57 -57
  107. package/src/_modules/ai/_modules/open-ai/_services/data-services/oai-doc-chunk-data.service.ts +292 -292
  108. package/src/_modules/ai/_modules/open-ai/_services/data-services/oai-document.data-service.spec.ts +342 -342
  109. package/src/_modules/ai/_modules/open-ai/_services/data-services/oai-vector-data.service.spec.ts +550 -550
  110. package/src/_modules/ai/_modules/open-ai/_services/data-services/oai-vector-data.service.ts +630 -630
  111. package/src/_modules/ai/_modules/open-ai/_services/oai-embedding.control-service.spec.ts +332 -332
  112. package/src/_modules/ai/_modules/open-ai/_services/oai-llm-chat.service-base.spec.ts +462 -462
  113. package/src/_modules/ai/_modules/open-ai/_services/oai-llm-chat.service-base.ts +634 -634
  114. package/src/_modules/ai/_modules/open-ai/_services/oai-llm.service-base.spec.ts +489 -489
  115. package/src/_modules/ai/_modules/open-ai/_services/oai-llm.service-base.tools.spec.ts +173 -173
  116. package/src/_modules/ai/_modules/open-ai/_services/oai-llm.service-base.ts +1033 -1033
  117. package/src/_modules/ai/_modules/open-ai/_services/oai-user-key.control-service.ts +157 -157
  118. package/src/_modules/ai/_services/ai-embedding.service-base.spec.ts +98 -98
  119. package/src/_modules/ai/_services/ai-embedding.service-base.ts +48 -48
  120. package/src/_modules/ai/_services/ai-llm-chat.service-base.spec.ts +229 -229
  121. package/src/_modules/ai/_services/ai-llm-chat.service-base.ts +68 -68
  122. package/src/_modules/ai/_services/ai-llm.service-base.spec.ts +250 -250
  123. package/src/_modules/ai/_services/ai-llm.service-base.ts +519 -519
  124. package/src/_modules/ai/_services/ai-provider.service-base.spec.ts +158 -158
  125. package/src/_modules/ai/_services/ai-user-key.service-base.ts +59 -59
  126. package/src/_modules/ai/index.ts +13 -13
  127. package/src/_modules/assistant/_collections/ass-global-settings.const.ts +13 -13
  128. package/src/_modules/assistant/_collections/ass.util.spec.ts +176 -176
  129. package/src/_modules/assistant/_collections/ass.util.ts +50 -50
  130. package/src/_modules/assistant/_models/ass-global-settings.interface.ts +15 -15
  131. package/src/_modules/assistant/_services/ass-io.control-service.spec.ts +140 -140
  132. package/src/_modules/assistant/_services/ass-main.control-service.spec.ts +192 -192
  133. package/src/_modules/assistant/_services/ass-main.control-service.ts +107 -107
  134. package/src/_modules/bot/_collections/bot-default-commands.const.ts +12 -12
  135. package/src/_modules/bot/_collections/bot-global-settings.const.ts +39 -39
  136. package/src/_modules/bot/_models/bot-channel-wrapper.interface.ts +62 -62
  137. package/src/_modules/bot/_models/bot-command.interface.ts +8 -8
  138. package/src/_modules/bot/_models/bot-global-settings.interface.ts +96 -96
  139. package/src/_modules/bot/_models/bot-last-mention-date.interface.ts +6 -6
  140. package/src/_modules/bot/_models/bot-last-message-date.interface.ts +5 -5
  141. package/src/_modules/bot/_models/bot-user-wrapper.interface.ts +41 -41
  142. package/src/_modules/bot/_modules/discord-bot/_models/dib-platform.types.ts +9 -9
  143. package/src/_modules/bot/_modules/discord-bot/_services/dib-messaging-provider.control-service.spec.ts +431 -431
  144. package/src/_modules/bot/_modules/dynamo-bot/_collections/dyb-operations.util.spec.ts +160 -160
  145. package/src/_modules/bot/_modules/dynamo-bot/_collections/dyb-operations.util.ts +55 -55
  146. package/src/_modules/bot/_modules/dynamo-bot/_models/dyb-platform.types.ts +15 -15
  147. package/src/_modules/bot/_modules/dynamo-bot/_services/dyb-messaging-provider.control-service.spec.ts +374 -374
  148. package/src/_modules/bot/_modules/dynamo-bot/_services/dyb-messaging-provider.control-service.ts +447 -447
  149. package/src/_modules/bot/_modules/dynamo-bot/index.ts +15 -15
  150. package/src/_modules/bot/_modules/slack-bot/_models/slb-platform.types.ts +9 -9
  151. package/src/_modules/bot/_modules/slack-bot/_services/slb-messaging-provider.control-service.spec.ts +344 -344
  152. package/src/_modules/bot/_modules/slack-bot/_services/slb-messaging-provider.control-service.ts +197 -197
  153. package/src/_modules/bot/_modules/teams-bot/_models/teb-platform.types.ts +9 -9
  154. package/src/_modules/bot/_modules/teams-bot/_services/teb-messaging-provider.control-service.spec.ts +345 -345
  155. package/src/_modules/bot/_modules/teams-bot/_services/teb-messaging-provider.control-service.ts +197 -197
  156. package/src/_modules/bot/_services/bot-commands.control-service.spec.ts +116 -116
  157. package/src/_modules/bot/_services/bot-io.control-service.spec.ts +285 -285
  158. package/src/_modules/bot/_services/bot-main.control-service.spec.ts +208 -208
  159. package/src/_modules/bot/_services/bot-messaging-provider.service-base.spec.ts +349 -349
  160. package/src/_modules/bot/_services/bot-routines.control-service.spec.ts +111 -111
  161. package/src/_modules/custom-data/custom-data.controller.spec.ts +49 -49
  162. package/src/_modules/custom-data/custom-data.controller.ts +67 -67
  163. package/src/_modules/custom-data/custom-data.data-service.spec.ts +54 -54
  164. package/src/_modules/custom-data/custom-data.data-service.ts +21 -21
  165. package/src/_modules/custom-data/get-custom-data-routing-module.util.spec.ts +28 -28
  166. package/src/_modules/custom-data/get-custom-data-routing-module.util.ts +24 -24
  167. package/src/_modules/custom-data/index.ts +9 -9
  168. package/src/_modules/defaults/_collections/default-endpoints.util.ts +487 -487
  169. package/src/_modules/defaults/_models/default-user.data-model.ts +72 -72
  170. package/src/_modules/defaults/_services/default-auth.service.spec.ts +269 -269
  171. package/src/_modules/defaults/_services/default-auth.service.ts +177 -177
  172. package/src/_modules/defaults/_services/default-socket-events.service.spec.ts +42 -42
  173. package/src/_modules/defaults/_services/default-socket-events.service.ts +61 -61
  174. package/src/_modules/defaults/_services/default-user.data-service.spec.ts +187 -187
  175. package/src/_modules/defaults/_services/default-user.data-service.ts +98 -98
  176. package/src/_modules/defaults/index.ts +17 -17
  177. package/src/_modules/discord-assistant/_collections/dias-global-settings.const.ts +19 -19
  178. package/src/_modules/discord-assistant/_collections/dias.util.spec.ts +366 -366
  179. package/src/_modules/discord-assistant/_collections/dias.util.ts +132 -132
  180. package/src/_modules/discord-assistant/_models/dias-global-settings.interface.ts +19 -19
  181. package/src/_modules/discord-assistant/_models/dias-knowledge.data-model.ts +52 -52
  182. package/src/_modules/discord-assistant/_services/dias-chunk.data-service.ts +177 -177
  183. package/src/_modules/discord-assistant/_services/dias-io.control-service.spec.ts +108 -108
  184. package/src/_modules/discord-assistant/_services/dias-io.control-service.ts +69 -69
  185. package/src/_modules/discord-assistant/_services/dias-main.control-service.spec.ts +22 -22
  186. package/src/_modules/discord-assistant/_services/dias-main.control-service.ts +27 -27
  187. package/src/_modules/discord-assistant/_services/dias.service-base.spec.ts +195 -195
  188. package/src/_modules/discord-assistant/_services/dias.service-base.ts +76 -76
  189. package/src/_modules/discord-assistant/index.ts +38 -38
  190. package/src/_modules/discord-assistant-voiced/_services/dias-discord-bot.control-service.spec.ts +34 -34
  191. package/src/_modules/discord-assistant-voiced/_services/dias-discord-bot.control-service.ts +11 -11
  192. package/src/_modules/discord-assistant-voiced/index.ts +36 -36
  193. package/src/_modules/discord-bot/_collections/dibo-default-commands.const.ts +16 -16
  194. package/src/_modules/discord-bot/_collections/dibo-global-settings.conts.ts +55 -55
  195. package/src/_modules/discord-bot/_collections/dibo-operations.util.spec.ts +214 -214
  196. package/src/_modules/discord-bot/_collections/dibo-operations.util.ts +387 -387
  197. package/src/_modules/discord-bot/_models/dibo-command.interface.ts +12 -12
  198. package/src/_modules/discord-bot/_models/dibo-global-settings.interface.ts +98 -98
  199. package/src/_modules/discord-bot/_models/dibo-last-mention-date.inteface.ts +7 -7
  200. package/src/_modules/discord-bot/_models/dibo-last-message-date.interface.ts +6 -6
  201. package/src/_modules/discord-bot/_services/dibo-commands.control-service.spec.ts +154 -154
  202. package/src/_modules/discord-bot/_services/dibo-commands.control-service.ts +153 -153
  203. package/src/_modules/discord-bot/_services/dibo-io.control-service.spec.ts +264 -264
  204. package/src/_modules/discord-bot/_services/dibo-io.control-service.ts +306 -306
  205. package/src/_modules/discord-bot/_services/dibo-main.control-service.spec.ts +408 -408
  206. package/src/_modules/discord-bot/_services/dibo-main.control-service.ts +487 -487
  207. package/src/_modules/discord-bot/_services/dibo-routines.control-service.spec.ts +105 -105
  208. package/src/_modules/discord-bot/index.ts +36 -36
  209. package/src/_modules/local-vector-search/_enums/lvs-search-mode.enum.ts +35 -35
  210. package/src/_modules/local-vector-search/_models/lvs-search-result.interface.ts +17 -17
  211. package/src/_modules/local-vector-search/_services/lvs-doc-chunk-data.service.spec.ts +418 -418
  212. package/src/_modules/local-vector-search/_services/lvs-doc-chunk-data.service.ts +276 -276
  213. package/src/_modules/local-vector-search/_services/lvs-local-vector-search.data-service.spec.ts +480 -480
  214. package/src/_modules/local-vector-search/_services/lvs-local-vector-search.data-service.ts +416 -416
  215. package/src/_modules/local-vector-search/_services/lvs-vector-pool.control-service.spec.ts +393 -393
  216. package/src/_modules/local-vector-search/_services/lvs-vector-pool.control-service.ts +220 -220
  217. package/src/_modules/local-vector-search/index.ts +11 -11
  218. package/src/_modules/logs/index.ts +11 -11
  219. package/src/_modules/messaging/README.md +354 -354
  220. package/src/_modules/messaging/_collections/get-messaging-routing-module.util.ts +26 -26
  221. package/src/_modules/messaging/_collections/msg-global-settings.const.ts +22 -22
  222. package/src/_modules/messaging/_collections/msg.util.spec.ts +226 -226
  223. package/src/_modules/messaging/_models/msg-global-settings.interface.ts +37 -37
  224. package/src/_modules/messaging/_services/msg-conversation.data-service.ts +146 -146
  225. package/src/_modules/messaging/_services/msg-events.service.spec.ts +219 -219
  226. package/src/_modules/messaging/_services/msg-events.service.ts +267 -267
  227. package/src/_modules/messaging/_services/msg-integration.control-service.ts +179 -179
  228. package/src/_modules/messaging/_services/msg-main.control-service.spec.ts +147 -147
  229. package/src/_modules/messaging/_services/msg-main.control-service.ts +571 -571
  230. package/src/_modules/messaging/_services/msg-message.data-service.ts +129 -129
  231. package/src/_modules/messaging/_services/msg.controller.spec.ts +201 -201
  232. package/src/_modules/messaging/index.ts +30 -30
  233. package/src/_modules/mock/app-extended-server.mock.ts +201 -201
  234. package/src/_modules/mock/app-integration-test.mock.ts +51 -51
  235. package/src/_modules/mock/app-params.mock.spec.ts +21 -21
  236. package/src/_modules/mock/app-params.mock.ts +9 -9
  237. package/src/_modules/mock/app-server.mock.ts +188 -188
  238. package/src/_modules/mock/auth-service.mock.spec.ts +47 -47
  239. package/src/_modules/mock/auth-service.mock.ts +28 -28
  240. package/src/_modules/mock/controller.mock.spec.ts +26 -26
  241. package/src/_modules/mock/controller.mock.ts +16 -16
  242. package/src/_modules/mock/data-model.mock.spec.ts +111 -111
  243. package/src/_modules/mock/data-model.mock.ts +82 -82
  244. package/src/_modules/mock/email-service-collection.mock.spec.ts +24 -24
  245. package/src/_modules/mock/email-service-collection.mock.ts +15 -15
  246. package/src/_modules/mock/email-service.mock.spec.ts +17 -17
  247. package/src/_modules/mock/email-service.mock.ts +20 -20
  248. package/src/_modules/mock/email-template.mock.html +14 -14
  249. package/src/_modules/mock/endpoint.mock.ts +91 -91
  250. package/src/_modules/mock/socket-client.mock.spec.ts +40 -40
  251. package/src/_modules/mock/socket-client.mock.ts +45 -45
  252. package/src/_modules/mock/socket-server.mock.spec.ts +44 -44
  253. package/src/_modules/mock/socket-server.mock.ts +46 -46
  254. package/src/_modules/oauth2/_routes/oauth2.controller.spec.ts +107 -107
  255. package/src/_modules/oauth2/_routes/oauth2.controller.ts +98 -98
  256. package/src/_modules/oauth2/_services/oauth2.auth-service.spec.ts +254 -254
  257. package/src/_modules/oauth2/_services/oauth2.auth-service.ts +232 -232
  258. package/src/_modules/oauth2/_services/oauth2.control-service.spec.ts +585 -585
  259. package/src/_modules/oauth2/_services/oauth2.control-service.ts +653 -653
  260. package/src/_modules/oauth2/index.ts +17 -17
  261. package/src/_modules/server/errors/errors.control-service.spec.ts +238 -238
  262. package/src/_modules/server/errors/errors.control-service.ts +85 -85
  263. package/src/_modules/server/errors/errors.controller.spec.ts +241 -241
  264. package/src/_modules/server/errors/errors.controller.ts +431 -431
  265. package/src/_modules/server/errors/errors.data-service.spec.ts +361 -361
  266. package/src/_modules/server/index.ts +30 -30
  267. package/src/_modules/server/server-status/server-status-snapshot.control-service.spec.ts +70 -70
  268. package/src/_modules/server/server-status/server-status-snapshot.control-service.ts +17 -17
  269. package/src/_modules/server/server-status/server-status-snapshot.data-service.spec.ts +77 -77
  270. package/src/_modules/server/server-status/server-status-snapshot.data-service.ts +37 -37
  271. package/src/_modules/server/server-status/server-status.control-service.spec.ts +576 -576
  272. package/src/_modules/server/server-status/server-status.control-service.ts +396 -396
  273. package/src/_modules/server/server-status/server-status.controller.spec.ts +240 -239
  274. package/src/_modules/server/server-status/server-status.controller.ts +253 -245
  275. package/src/_modules/socket/_enums/socket-security.enum.ts +11 -11
  276. package/src/_modules/socket/_models/socket-client-service-params.control-model.spec.ts +32 -32
  277. package/src/_modules/socket/_models/socket-client-service-params.control-model.ts +22 -22
  278. package/src/_modules/socket/_models/socket-presence.control-model.spec.ts +164 -164
  279. package/src/_modules/socket/_models/socket-presence.control-model.ts +210 -210
  280. package/src/_modules/socket/_models/socket-server-service-params.control-model.spec.ts +46 -46
  281. package/src/_modules/socket/_models/socket-server-service-params.control-model.ts +22 -22
  282. package/src/_modules/socket/_services/socket-client.service.spec.ts +15 -15
  283. package/src/_modules/socket/_services/socket-client.service.ts +260 -260
  284. package/src/_modules/socket/_services/socket-server.service.spec.ts +11 -11
  285. package/src/_modules/socket/app-extended.integration.spec.ts +85 -85
  286. package/src/_modules/socket/app-extended.server.ts +630 -630
  287. package/src/_modules/socket/index.ts +42 -42
  288. package/src/_modules/test/get-test-routing-module.util.spec.ts +28 -28
  289. package/src/_modules/test/get-test-routing-module.util.ts +23 -23
  290. package/src/_modules/test/index.ts +11 -11
  291. package/src/_modules/test/test.controller.spec.ts +72 -72
  292. package/src/_modules/test/test.controller.ts +115 -115
  293. package/src/_modules/usage/get-usage-routing-module.util.ts +22 -22
  294. package/src/_modules/usage/index.ts +15 -15
  295. package/src/_modules/usage/usage.controller.spec.ts +81 -81
  296. package/src/_modules/usage/usage.controller.ts +126 -126
  297. package/src/_modules/usage/usage.data-service.spec.ts +332 -332
  298. package/src/_modules/usage/usage.data-service.ts +185 -185
  299. package/src/_services/base/api.service-base.spec.ts +125 -125
  300. package/src/_services/base/api.service-base.ts +74 -74
  301. package/src/_services/base/archive-data.service.spec.ts +196 -196
  302. package/src/_services/base/archive-data.service.ts +216 -216
  303. package/src/_services/base/data.service.spec.ts +674 -674
  304. package/src/_services/base/data.service.ts +2719 -2719
  305. package/src/_services/base/db.service.spec.ts +73 -73
  306. package/src/_services/base/db.service.ts +1575 -1575
  307. package/src/_services/base/singleton.service-base.spec.ts +28 -28
  308. package/src/_services/base/singleton.service-base.ts +24 -24
  309. package/src/_services/base/singleton.service.spec.ts +114 -114
  310. package/src/_services/base/singleton.service.ts +38 -38
  311. package/src/_services/core/api.service.spec.ts +140 -140
  312. package/src/_services/core/auth.service.spec.ts +159 -159
  313. package/src/_services/core/auth.service.ts +174 -174
  314. package/src/_services/core/email.service.spec.ts +85 -85
  315. package/src/_services/core/email.service.ts +742 -742
  316. package/src/_services/core/global.service.spec.ts +275 -275
  317. package/src/_services/core/global.service.ts +461 -461
  318. package/src/_services/core/service-collection.service.spec.ts +46 -46
  319. package/src/_services/core/service-collection.service.ts +6 -6
  320. package/src/_services/route/controller.service.spec.ts +53 -53
  321. package/src/_services/route/controller.service.ts +148 -148
  322. package/src/_services/route/routing-module.service.spec.ts +98 -98
  323. package/src/_services/route/routing-module.service.ts +330 -330
  324. package/src/_services/server/app.server.ts +1713 -1672
  325. package/src/_services/shared.static-service.spec.ts +99 -99
  326. package/src/_services/shared.static-service.ts +78 -78
  327. package/src/index.ts +95 -95
  328. package/tsconfig.app.json +12 -12
  329. package/tsconfig.json +42 -42
  330. package/.dynamo/logs/cicd-pipeline/output.log +0 -2688
  331. package/.dynamo/logs/cicd-pipeline/status.json +0 -351
@@ -1,742 +1,742 @@
1
-
2
- import * as FileSystem from 'fs';
3
- import * as NodeMailer from 'nodemailer';
4
-
5
- import { Attachment, Options as MailOptions } from 'nodemailer/lib/mailer';
6
-
7
- import {
8
- DyFM_AnyError, DyFM_Array, DyFM_Error, DyFM_Error_Settings, DyFM_Log
9
- } from '@futdevpro/fsm-dynamo';
10
- import { DyNTS_global_settings } from '../../_collections/global-settings.const';
11
-
12
- export interface DyNTS_EmailService_Settings {
13
- host: string,
14
- port: number,
15
- email: string,
16
- pass: string,
17
- senderName: string,
18
- rootPath: string,
19
- templateComponents?: DyNTS_EmailTemplateComponent[],
20
- }
21
-
22
- export class DyNTS_EmailTemplateComponent {
23
- name: string;
24
- selector: string;
25
-
26
- templatePath?: string;
27
- template?: string;
28
-
29
- stylePath?: string;
30
- styles?: string;
31
-
32
- headerLinks?: string = '';
33
-
34
- properties?: string[] = [];
35
- subComponentSelectors?: string[] = [];
36
-
37
- constructor(
38
- set?: DyNTS_EmailTemplateComponent
39
- ) {
40
- if (set) {
41
- Object.assign(this, set);
42
- }
43
- }
44
- }
45
-
46
- export interface DyNTS_SendEmail_Settings<T = { [propertyKey: string]: string; }> {
47
- to: string;
48
- subject: string;
49
- /** direct email content, if provided, this will be used */
50
- content?: string;
51
-
52
- templateComponentName?: string;
53
- templateProperties?: T;
54
-
55
- attachments?: Attachment[];
56
- }
57
-
58
- /**
59
- *
60
- */
61
- export class DyNTS_EmailService /* extends DyNTS_SingletonService */ {
62
- serviceName: string;
63
-
64
- private readonly nmTransporter: NodeMailer.Transporter;
65
- private readonly senderName: string;
66
- private readonly senderNEmail: string;
67
-
68
- private readonly components: DyNTS_EmailTemplateComponent[] = [];
69
- private readonly componentsBySelector: {
70
- [selector: string]: DyNTS_EmailTemplateComponent
71
- } = {};
72
- private readonly componentsByName: {
73
- [componentName: string]: DyNTS_EmailTemplateComponent
74
- } = {};
75
-
76
- private readonly styleLimitWarning: number = 16;
77
-
78
- readonly defaultErrorUserMsg =
79
- `We encountered an uncaught Email Service Error, ` +
80
- `\nplease contact the responsible development team.`;
81
-
82
- constructor (
83
- set: DyNTS_EmailService_Settings
84
- ) {
85
- this.serviceName = this.constructor?.name;
86
- this.senderName = set.senderName;
87
- this.senderNEmail = `${set.senderName} <${set.email}>`;
88
- this.nmTransporter = NodeMailer.createTransport({
89
- host: set.host,
90
- port: set.port,
91
- auth: {
92
- user: set.email,
93
- pass: set.pass,
94
- },
95
- });
96
-
97
- this.components = set.templateComponents ?? [];
98
- }
99
-
100
- async asyncPostConstruct(): Promise<void> {
101
- try {
102
- if (this.components) {
103
- await DyFM_Array.asyncForEach(
104
- this.components,
105
- async (component: DyNTS_EmailTemplateComponent): Promise<void> => {
106
- await this.loadEmailTemplateComponent(component);
107
- }
108
- );
109
-
110
- this.connectComponents();
111
- }
112
-
113
- DyFM_Log.success(`\nEmailService construction (${this.senderName}) Finished!`);
114
- } catch (error) {
115
- throw new DyFM_Error({
116
- ...this._getDefaultErrorSettings('asyncPostConstruct', error, 'SYSTEM'),
117
-
118
- errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-APC0`,
119
- });
120
- }
121
- }
122
-
123
- /**
124
- *
125
- * @param set
126
- */
127
- public async sendEmail<T>(
128
- set: DyNTS_SendEmail_Settings<T>,
129
- issuer: string
130
- ): Promise<void> {
131
- try {
132
- let content: string;
133
-
134
- if (set.content) {
135
- content = set.content;
136
-
137
- } else {
138
- if (!set.templateComponentName) {
139
- throw new DyFM_Error({
140
- ...this._getDefaultErrorSettings(
141
- 'sendEmail',
142
- new Error(`No email template component is given!`),
143
- issuer
144
- ),
145
-
146
- errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-SE1`,
147
- });
148
- }
149
-
150
- if (!this.componentsByName[set.templateComponentName]) {
151
- throw new DyFM_Error({
152
- ...this._getDefaultErrorSettings(
153
- 'sendEmail',
154
- new Error(
155
- `No email template component found with this name! (${set.templateComponentName})`
156
- ),
157
- issuer
158
- ),
159
-
160
- errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-SE2`,
161
- additionalContent: {
162
- availableComponenets: Object.keys(this.componentsByName),
163
- },
164
- });
165
- }
166
-
167
- content = await this.compileTemplateComponent(
168
- set.templateComponentName,
169
- set.templateProperties,
170
- issuer
171
- );
172
- }
173
-
174
- const mailOptions: MailOptions = {
175
- from: this.senderNEmail,
176
- to: set.to,
177
- subject: set.subject,
178
- html: content,
179
- attachments: set.attachments,
180
- };
181
-
182
- await new Promise<void>((resolve, reject): void => {
183
- this.nmTransporter.sendMail(mailOptions, (error): void => {
184
- if (error) {
185
- reject(error);
186
- } else {
187
- resolve();
188
- }
189
- });
190
- });
191
- } catch (error) {
192
- if ((error as Error).message?.includes?.('all recipients were rejected')) {
193
- throw new DyFM_Error({
194
- ...this._getDefaultErrorSettings('sendEmail', error, issuer),
195
-
196
- addECToUserMsg: false,
197
- errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-SE4`,
198
- userMessage: `Can't send mail to ${set.to}!`,
199
- message: `sendEmail failed to ${set.to}`,
200
- });
201
-
202
- } else {
203
- throw new DyFM_Error({
204
- ...this._getDefaultErrorSettings('sendEmail', error, issuer),
205
-
206
- errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-SE0`,
207
- message: `sendEmail failed to ${set.to}`,
208
- });
209
- }
210
- }
211
- }
212
-
213
- private async compileTemplateComponent<T>(
214
- componentName: string,
215
- componentProperties:T,
216
- issuer: string
217
- ): Promise<string> {
218
- try {
219
- if (!this.componentsByName[componentName]) {
220
- throw new DyFM_Error({
221
- ...this._getDefaultErrorSettings(
222
- 'setupComponent',
223
- new Error(`No email component found with this name! (${componentName})`),
224
- issuer
225
- ),
226
-
227
- errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-SC1`,
228
- additionalContent: {
229
- availableComponents: Object.keys(this.componentsByName),
230
- },
231
- });
232
- }
233
-
234
- const component: DyNTS_EmailTemplateComponent = this.componentsByName[componentName];
235
- let template: string = this.compileHTMLMainFrame(component);
236
-
237
- template = template.replace('<nts-content>', '');
238
- template = await this.compileComponentProperties<T>(
239
- component,
240
- componentProperties,
241
- template,
242
- issuer
243
- );
244
-
245
- await DyFM_Array.asyncForEach(
246
- component.subComponentSelectors,
247
- async (subComponentSelector: string): Promise<void> => {
248
- while (template.includes(`<nts-${subComponentSelector}`)) {
249
- template = await this.compileSubComponent<T>(
250
- subComponentSelector, componentProperties, template, issuer
251
- );
252
- }
253
- }
254
- );
255
-
256
- template = this.templateTrim(template);
257
-
258
- return template;
259
- } catch (error) {
260
- throw new DyFM_Error({
261
- ...this._getDefaultErrorSettings('setupComponent', error, issuer),
262
-
263
- errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-SC0`,
264
- message: `setupComponent failed! (${componentName})`,
265
- });
266
- }
267
- }
268
-
269
- private compileHTMLMainFrame(component: DyNTS_EmailTemplateComponent): string {
270
- const allLinks: string[] = [];
271
- const allStyles: string[] = [];
272
-
273
- if (component.headerLinks) {
274
- allLinks.push(component.headerLinks);
275
- }
276
-
277
- if (component.styles) {
278
- allStyles.push(component.styles);
279
- }
280
-
281
- component.subComponentSelectors.forEach((subComponentSelector: string): void => {
282
- const subComponent: DyNTS_EmailTemplateComponent =
283
- this.componentsBySelector[subComponentSelector];
284
-
285
- if (subComponent.headerLinks) {
286
- allLinks.push(subComponent.headerLinks.trim());
287
- }
288
-
289
- if (subComponent.styles) {
290
- allStyles.push(subComponent.styles.trim());
291
- }
292
- });
293
-
294
- const styles = this.styleTrim(allStyles.join(''));
295
- const styleSize = this.getStringKBSize(styles);
296
-
297
- if (this.styleLimitWarning < styleSize) {
298
- DyFM_Log.warn(
299
- `\nDynamoNTS EmailService WARNING (${this.serviceName}), ` +
300
- `\nEmail template styles are too big! (${styleSize}KB)` +
301
- `\ncomponent: ${component.name} (${component.selector})` +
302
- `\nSome email clients may not support this!` +
303
- `\nThe limit is ${this.styleLimitWarning}KB!`
304
- );
305
- }
306
-
307
- return `\n<!DOCTYPE html>` +
308
- `\n<html>` +
309
- `\n <head>` +
310
- `\n ${allLinks.join('')}` +
311
- `\n` +
312
- `\n <style>` +
313
- `\n ${styles}` +
314
- `\n </style>` +
315
- `\n </head>` +
316
- `\n <body>` +
317
- `\n ${component.template}` +
318
- `\n </body>` +
319
- `\n</html> `;
320
- }
321
-
322
- /** trims all rows and remove everything between /*...*\/ */
323
- private styleTrim(style: string): string {
324
- let result: string = style?.split('\n').map((row: string): string => row.trim()).join('');
325
-
326
- while (result?.includes('/*')) {
327
- const start = result.indexOf('/*');
328
- const end = result.indexOf('*/', start) + 2;
329
-
330
- result = result.substring(0, start) + result.substring(end);
331
- }
332
-
333
- return result;
334
- }
335
-
336
- /** removes HTML comments */
337
- private templateTrim(template: string): string {
338
- let result: string = template;
339
-
340
- while (result.includes('<!--')) {
341
- const start = result.indexOf('<!--');
342
- const end = result.indexOf('-->', start) + 3;
343
-
344
- result = result.substring(0, start) + result.substring(end);
345
- }
346
-
347
- return result;
348
- }
349
-
350
-
351
- private getStringKBSize(str: string): number {
352
- const b: number = str.length * 2;
353
-
354
- return b / 1024;
355
- }
356
-
357
- private async compileComponentProperties<T>(
358
- component: DyNTS_EmailTemplateComponent,
359
- componentProperties: T,
360
- template: string,
361
- issuer: string
362
- ): Promise<string> {
363
- try {
364
- component.properties.forEach((propertyKey: string): void => {
365
- if (!componentProperties[propertyKey]) {
366
- throw new DyFM_Error({
367
- ...this._getDefaultErrorSettings(
368
- 'setupComponent',
369
- new Error(
370
- `ComponentProperty missing from input! "${propertyKey}" for "${component.name}"`
371
- ),
372
- issuer
373
- ),
374
-
375
- errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-SC4`,
376
- additionalContent: {
377
- componentProperties: Object.keys(componentProperties),
378
- },
379
- });
380
- }
381
-
382
- const propReg = new RegExp(`{{${propertyKey}}}`, 'g');
383
-
384
- template = template.replace(propReg, componentProperties[propertyKey]);
385
- });
386
-
387
- return template;
388
- } catch (error) {
389
- throw new DyFM_Error({
390
- ...this._getDefaultErrorSettings('setupComponent', error, issuer),
391
-
392
- errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-SC3`,
393
- });
394
- }
395
- }
396
-
397
- private async compileSubComponent<T>(
398
- subComponentSelector: string,
399
- componentProperties: T,
400
- template: string,
401
- issuer: string
402
- ): Promise<string> {
403
-
404
- const subComponent: DyNTS_EmailTemplateComponent =
405
- this.componentsBySelector[subComponentSelector];
406
-
407
- if (!subComponent) {
408
- throw new DyFM_Error({
409
- ...this._getDefaultErrorSettings(
410
- 'setupComponent',
411
- new Error(`SubComponent missing from components! "${subComponentSelector}"`),
412
- issuer
413
- ),
414
-
415
- errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-SC2`,
416
- additionalContent: this.componentsBySelector,
417
- });
418
- }
419
-
420
- let subComponentTemplate: string = subComponent.template;
421
- const startTag = `<nts-${subComponent.selector}`;
422
- const endTag = `</nts-${subComponent.selector}>`;
423
- const tagHTMLProperties: string =
424
- template.split(startTag)[1].split('>')[0];
425
- let componentContent: string;
426
-
427
- if (!tagHTMLProperties) {
428
- componentContent = template.split(`${startTag}>`)[1].split(endTag)[0];
429
- } else {
430
- componentContent = template.split(startTag)[1].split('>')[1].split(endTag)[0];
431
- }
432
-
433
- const contentReg = new RegExp(`<nts-content>`, 'g');
434
-
435
- subComponentTemplate = subComponentTemplate.replace(contentReg, componentContent);
436
- subComponentTemplate = await this.compileComponentProperties<T>(
437
- subComponent,
438
- componentProperties,
439
- subComponentTemplate,
440
- issuer
441
- );
442
-
443
- const startTagReg = new RegExp(startTag, 'g');
444
- const endTagReg = new RegExp(endTag, 'g');
445
-
446
- template = template.replace(startTagReg, '<div');
447
- template = template.replace(componentContent, subComponentTemplate);
448
- template = template.replace(endTagReg, '</div>');
449
-
450
- /* while (template.includes(`<nts-${subComponent.selector}`)) {
451
- const replaceStartIndex = template.indexOf(`<nts-${subComponent.selector}`);
452
- const replaceEndIndex = template.indexOf(endTag, replaceStartIndex) + endTag.length;
453
-
454
- template =
455
- template.substring(0, replaceStartIndex) +
456
- subComponentCompiled +
457
- template.substring(replaceEndIndex);
458
- } */
459
-
460
- return template;
461
- }
462
-
463
- private async loadEmailTemplateComponent(component: DyNTS_EmailTemplateComponent): Promise<void> {
464
- try {
465
- if (this.componentsBySelector[component.selector]) {
466
- DyFM_Log.warn(
467
- `Email component already loaded! (it will be skipped) "${component.selector}"`
468
- );
469
-
470
- return;
471
- }
472
-
473
- if (!component.templatePath && !component.template) {
474
- throw new DyFM_Error({
475
- ...this._getDefaultErrorSettings(
476
- 'loadComponent',
477
- new Error(`Component missing template and templatePath! "${component.name}"`),
478
- 'SYSTEM'
479
- ),
480
-
481
- errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-LC2`,
482
- additionalContent: {
483
- component: component,
484
- },
485
- });
486
- }
487
-
488
- if (!component.template) {
489
- component.template = await this.readFile(component.templatePath, component.name).catch(
490
- async (error: DyFM_Error): Promise<string> => {
491
-
492
- if (DyNTS_global_settings.autoResearchIssues) {
493
- // read folder contents, read parent folder contents
494
- const folderContents = FileSystem.readdirSync(
495
- component.templatePath.split('/').slice(0, -1).join('/')
496
- );
497
- const parentFolderContents = FileSystem.readdirSync(
498
- component.templatePath.split('/').slice(0, -2).join('/')
499
- );
500
-
501
- DyFM_Log.testWarn(
502
- `DynamoNTS EmailService WARNING, couldn't load email component's template; ` +
503
- `\n(${component.name} from ${component.templatePath})` +
504
- `\n folder contents: \n ${folderContents.join(', \n ')}` +
505
- `\n parent folder contents: \n ${parentFolderContents.join(', \n ')}`
506
- );
507
- } else {
508
- DyFM_Log.error(
509
- `\nDynamoNTS EmailService ERROR, couldn't load email component's template; ` +
510
- `\n(${component.name} from ${component.templatePath})`
511
- );
512
- }
513
-
514
- throw error;
515
- }
516
- );
517
- }
518
-
519
- if (component.stylePath) {
520
- await new Promise<void>((resolve, reject): void => {
521
- FileSystem.readFile(component.stylePath, 'utf8' , (err, styles): void => {
522
- if (err || !styles) {
523
- if (!err) {
524
- err = new Error(
525
- `Couldn't load email component's styles; ${component.name} ` +
526
- `from ${component.stylePath}`
527
- );
528
- }
529
-
530
- reject(
531
- new DyFM_Error({
532
- ...this._getDefaultErrorSettings('loadTemplate', err, 'SYSTEM'),
533
-
534
- errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-LC4`,
535
- })
536
- );
537
-
538
- return;
539
- }
540
-
541
- component.styles = styles;
542
-
543
- resolve();
544
- });
545
- });
546
- }
547
-
548
- component.properties = this.getTemplatePropertyKeys(component.template);
549
- this.componentsBySelector[component.selector] = component;
550
- this.componentsByName[component.name] = component;
551
-
552
- component.properties.forEach((propertyKey: string): void => {
553
- if (!component.template.includes(`{{${propertyKey}}}`)) {
554
- throw new DyFM_Error({
555
- ...this._getDefaultErrorSettings(
556
- 'loadComponent',
557
- new Error(
558
- `TemplateProperty missing from template! (${propertyKey} for ${component.name})`
559
- ),
560
- 'SYSTEM'
561
- ),
562
-
563
- errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-LC5`,
564
- additionalContent: component.template,
565
- });
566
- }
567
- });
568
- } catch (error) {
569
- throw new DyFM_Error({
570
- ...this._getDefaultErrorSettings('loadComponent', error, 'SYSTEM'),
571
-
572
- errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-LC0`,
573
- message: `loadComponent failed! (${component.name})`,
574
- });
575
- }
576
- }
577
-
578
- private async readFile(path: string, nameOfTarget: string): Promise<string> {
579
- return await new Promise<string>((resolve, reject): void => {
580
- FileSystem.readFile(path, 'utf8' , (err, template): void => {
581
- if (err || !template) {
582
- err ??= new Error(
583
- `Couldn't load email component's template; \n ${nameOfTarget} ` +
584
- `\n from ${path}`
585
- );
586
-
587
- reject(
588
- new DyFM_Error({
589
- ...this._getDefaultErrorSettings('loadTemplate', err, 'SYSTEM'),
590
-
591
- errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-LC3`,
592
- })
593
- );
594
-
595
- return;
596
- }
597
-
598
- resolve(template);
599
- });
600
- });
601
- }
602
-
603
- private connectComponents(): void {
604
- try {
605
- for (const componentSelector in this.componentsBySelector) {
606
- this.componentsBySelector[componentSelector].subComponentSelectors = [];
607
-
608
- const innerTags: string[] =
609
- this.componentsBySelector[componentSelector].template.split('<nts-');
610
-
611
- innerTags.shift();
612
- innerTags.forEach(
613
- (subComponents: string): void => {
614
- const subComponentSelector = subComponents.split('>')[0].split(' ')[0];
615
-
616
- if (subComponentSelector !== 'content') {
617
- const fullSelector = 'nts-' + subComponentSelector;
618
-
619
- if (fullSelector) {
620
- if (!this.componentsBySelector[subComponentSelector]) {
621
- throw new DyFM_Error({
622
- ...this._getDefaultErrorSettings(
623
- 'connectComponents',
624
- new Error(`SubComponent missing from components! (${fullSelector})`),
625
- 'SYSTEM'
626
- ),
627
-
628
- errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-CC1`,
629
- additionalContent: {
630
- availableComponenets: Object.keys(this.componentsBySelector),
631
- },
632
- });
633
- }
634
-
635
- this.componentsBySelector[componentSelector].subComponentSelectors.push(
636
- subComponentSelector
637
- );
638
- }
639
- }
640
- }
641
- );
642
- }
643
- } catch (error) {
644
- throw new DyFM_Error({
645
- ...this._getDefaultErrorSettings('connectComponents', error, 'SYSTEM'),
646
-
647
- errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-CC0`,
648
- message: `connectComponents failed!`,
649
- });
650
- }
651
- }
652
-
653
- /**
654
- *
655
- * @param template
656
- * @returns
657
- */
658
- private getTemplatePropertyKeys(template: string): string[] {
659
- try {
660
- const propertyKeys: string[] = [];
661
- let propertyOpenTagIndex = template.indexOf('{{');
662
- let propertyCloseTagIndex = template.indexOf('}}', propertyOpenTagIndex + 2);
663
-
664
- while (propertyOpenTagIndex >= 0) {
665
- if (propertyCloseTagIndex === -1) {
666
- DyFM_Log.error(
667
- `\nDyNTS_EmailService ERROR, missing closing tag from email template! ` +
668
- `(${propertyOpenTagIndex} -)`,
669
- propertyKeys
670
- );
671
-
672
- throw new DyFM_Error({
673
- errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-200`,
674
- addECToUserMsg: true,
675
- message: `ERROR, missing closing tag from email template! (${propertyOpenTagIndex} -)`,
676
- userMessage: this.defaultErrorUserMsg,
677
- });
678
- }
679
-
680
- const newKey: string = template.substring(propertyOpenTagIndex + 2, propertyCloseTagIndex);
681
-
682
- if (!propertyKeys.includes(newKey)) {
683
- propertyKeys.push(newKey);
684
- }
685
-
686
- // KELLEZIDE?
687
- propertyOpenTagIndex = template.indexOf('{{', propertyOpenTagIndex + 2);
688
- propertyCloseTagIndex = template.indexOf('}}', propertyOpenTagIndex + 2);
689
- }
690
- // console.log('\n\n\nTEST propertyKeys: ', propertyKeys);
691
-
692
- return propertyKeys;
693
- } catch (error) {
694
- throw new DyFM_Error({
695
- ...this._getDefaultErrorSettings('getTemplatePropertyKeys', error, 'SYSTEM'),
696
-
697
- errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-GTPK0`,
698
- message: `getTemplatePropertyKeys failed!`,
699
- additionalContent: template,
700
- });
701
- }
702
- }
703
-
704
- private _getDefaultErrorSettings(
705
- fnName: string,
706
- error: DyFM_AnyError,
707
- issuer: string
708
- ): DyFM_Error_Settings {
709
- return {
710
- status: (error as DyFM_Error)?.___status ?? 500,
711
- message: (error as Error)?.message ??
712
- (error as DyFM_Error)?._message ??
713
- `${fnName} was UNSUCCESSFUL (NTS; ${this.serviceName})`,
714
- addECToUserMsg: !(error as DyFM_Error)?.__userMessage,
715
- userMessage: (error as DyFM_Error)?.__userMessage ?? this.defaultErrorUserMsg,
716
- issuer: issuer,
717
- issuerService: this.serviceName,
718
- error: error,
719
- };
720
- }
721
-
722
- protected getDefaultErrorSettings(
723
- fnName: string,
724
- error: DyFM_AnyError,
725
- issuer: string,
726
- /** @deprecated we wont support the separate user message in the future, use the message instead */
727
- useMessageAsUserMessage: boolean = true,
728
- ): DyFM_Error_Settings {
729
- return {
730
- status: (error as DyFM_Error)?.___status ?? 500,
731
- message: (error as Error)?.message ??
732
- (error as DyFM_Error)?._message ??
733
- `${fnName} was UNSUCCESSFUL (${DyNTS_global_settings.systemShortCodeName})`,
734
- addECToUserMsg: !(error as DyFM_Error)?.__userMessage,
735
- userMessage: (error as DyFM_Error)?.__userMessage ??
736
- (useMessageAsUserMessage ? (error as Error)?.message : this.defaultErrorUserMsg),
737
- issuer: issuer,
738
- issuerService: this.constructor?.name,
739
- error: error,
740
- };
741
- }
742
- }
1
+
2
+ import * as FileSystem from 'fs';
3
+ import * as NodeMailer from 'nodemailer';
4
+
5
+ import { Attachment, Options as MailOptions } from 'nodemailer/lib/mailer';
6
+
7
+ import {
8
+ DyFM_AnyError, DyFM_Array, DyFM_Error, DyFM_Error_Settings, DyFM_Log
9
+ } from '@futdevpro/fsm-dynamo';
10
+ import { DyNTS_global_settings } from '../../_collections/global-settings.const';
11
+
12
+ export interface DyNTS_EmailService_Settings {
13
+ host: string,
14
+ port: number,
15
+ email: string,
16
+ pass: string,
17
+ senderName: string,
18
+ rootPath: string,
19
+ templateComponents?: DyNTS_EmailTemplateComponent[],
20
+ }
21
+
22
+ export class DyNTS_EmailTemplateComponent {
23
+ name: string;
24
+ selector: string;
25
+
26
+ templatePath?: string;
27
+ template?: string;
28
+
29
+ stylePath?: string;
30
+ styles?: string;
31
+
32
+ headerLinks?: string = '';
33
+
34
+ properties?: string[] = [];
35
+ subComponentSelectors?: string[] = [];
36
+
37
+ constructor(
38
+ set?: DyNTS_EmailTemplateComponent
39
+ ) {
40
+ if (set) {
41
+ Object.assign(this, set);
42
+ }
43
+ }
44
+ }
45
+
46
+ export interface DyNTS_SendEmail_Settings<T = { [propertyKey: string]: string; }> {
47
+ to: string;
48
+ subject: string;
49
+ /** direct email content, if provided, this will be used */
50
+ content?: string;
51
+
52
+ templateComponentName?: string;
53
+ templateProperties?: T;
54
+
55
+ attachments?: Attachment[];
56
+ }
57
+
58
+ /**
59
+ *
60
+ */
61
+ export class DyNTS_EmailService /* extends DyNTS_SingletonService */ {
62
+ serviceName: string;
63
+
64
+ private readonly nmTransporter: NodeMailer.Transporter;
65
+ private readonly senderName: string;
66
+ private readonly senderNEmail: string;
67
+
68
+ private readonly components: DyNTS_EmailTemplateComponent[] = [];
69
+ private readonly componentsBySelector: {
70
+ [selector: string]: DyNTS_EmailTemplateComponent
71
+ } = {};
72
+ private readonly componentsByName: {
73
+ [componentName: string]: DyNTS_EmailTemplateComponent
74
+ } = {};
75
+
76
+ private readonly styleLimitWarning: number = 16;
77
+
78
+ readonly defaultErrorUserMsg =
79
+ `We encountered an uncaught Email Service Error, ` +
80
+ `\nplease contact the responsible development team.`;
81
+
82
+ constructor (
83
+ set: DyNTS_EmailService_Settings
84
+ ) {
85
+ this.serviceName = this.constructor?.name;
86
+ this.senderName = set.senderName;
87
+ this.senderNEmail = `${set.senderName} <${set.email}>`;
88
+ this.nmTransporter = NodeMailer.createTransport({
89
+ host: set.host,
90
+ port: set.port,
91
+ auth: {
92
+ user: set.email,
93
+ pass: set.pass,
94
+ },
95
+ });
96
+
97
+ this.components = set.templateComponents ?? [];
98
+ }
99
+
100
+ async asyncPostConstruct(): Promise<void> {
101
+ try {
102
+ if (this.components) {
103
+ await DyFM_Array.asyncForEach(
104
+ this.components,
105
+ async (component: DyNTS_EmailTemplateComponent): Promise<void> => {
106
+ await this.loadEmailTemplateComponent(component);
107
+ }
108
+ );
109
+
110
+ this.connectComponents();
111
+ }
112
+
113
+ DyFM_Log.success(`\nEmailService construction (${this.senderName}) Finished!`);
114
+ } catch (error) {
115
+ throw new DyFM_Error({
116
+ ...this._getDefaultErrorSettings('asyncPostConstruct', error, 'SYSTEM'),
117
+
118
+ errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-APC0`,
119
+ });
120
+ }
121
+ }
122
+
123
+ /**
124
+ *
125
+ * @param set
126
+ */
127
+ public async sendEmail<T>(
128
+ set: DyNTS_SendEmail_Settings<T>,
129
+ issuer: string
130
+ ): Promise<void> {
131
+ try {
132
+ let content: string;
133
+
134
+ if (set.content) {
135
+ content = set.content;
136
+
137
+ } else {
138
+ if (!set.templateComponentName) {
139
+ throw new DyFM_Error({
140
+ ...this._getDefaultErrorSettings(
141
+ 'sendEmail',
142
+ new Error(`No email template component is given!`),
143
+ issuer
144
+ ),
145
+
146
+ errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-SE1`,
147
+ });
148
+ }
149
+
150
+ if (!this.componentsByName[set.templateComponentName]) {
151
+ throw new DyFM_Error({
152
+ ...this._getDefaultErrorSettings(
153
+ 'sendEmail',
154
+ new Error(
155
+ `No email template component found with this name! (${set.templateComponentName})`
156
+ ),
157
+ issuer
158
+ ),
159
+
160
+ errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-SE2`,
161
+ additionalContent: {
162
+ availableComponenets: Object.keys(this.componentsByName),
163
+ },
164
+ });
165
+ }
166
+
167
+ content = await this.compileTemplateComponent(
168
+ set.templateComponentName,
169
+ set.templateProperties,
170
+ issuer
171
+ );
172
+ }
173
+
174
+ const mailOptions: MailOptions = {
175
+ from: this.senderNEmail,
176
+ to: set.to,
177
+ subject: set.subject,
178
+ html: content,
179
+ attachments: set.attachments,
180
+ };
181
+
182
+ await new Promise<void>((resolve, reject): void => {
183
+ this.nmTransporter.sendMail(mailOptions, (error): void => {
184
+ if (error) {
185
+ reject(error);
186
+ } else {
187
+ resolve();
188
+ }
189
+ });
190
+ });
191
+ } catch (error) {
192
+ if ((error as Error).message?.includes?.('all recipients were rejected')) {
193
+ throw new DyFM_Error({
194
+ ...this._getDefaultErrorSettings('sendEmail', error, issuer),
195
+
196
+ addECToUserMsg: false,
197
+ errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-SE4`,
198
+ userMessage: `Can't send mail to ${set.to}!`,
199
+ message: `sendEmail failed to ${set.to}`,
200
+ });
201
+
202
+ } else {
203
+ throw new DyFM_Error({
204
+ ...this._getDefaultErrorSettings('sendEmail', error, issuer),
205
+
206
+ errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-SE0`,
207
+ message: `sendEmail failed to ${set.to}`,
208
+ });
209
+ }
210
+ }
211
+ }
212
+
213
+ private async compileTemplateComponent<T>(
214
+ componentName: string,
215
+ componentProperties:T,
216
+ issuer: string
217
+ ): Promise<string> {
218
+ try {
219
+ if (!this.componentsByName[componentName]) {
220
+ throw new DyFM_Error({
221
+ ...this._getDefaultErrorSettings(
222
+ 'setupComponent',
223
+ new Error(`No email component found with this name! (${componentName})`),
224
+ issuer
225
+ ),
226
+
227
+ errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-SC1`,
228
+ additionalContent: {
229
+ availableComponents: Object.keys(this.componentsByName),
230
+ },
231
+ });
232
+ }
233
+
234
+ const component: DyNTS_EmailTemplateComponent = this.componentsByName[componentName];
235
+ let template: string = this.compileHTMLMainFrame(component);
236
+
237
+ template = template.replace('<nts-content>', '');
238
+ template = await this.compileComponentProperties<T>(
239
+ component,
240
+ componentProperties,
241
+ template,
242
+ issuer
243
+ );
244
+
245
+ await DyFM_Array.asyncForEach(
246
+ component.subComponentSelectors,
247
+ async (subComponentSelector: string): Promise<void> => {
248
+ while (template.includes(`<nts-${subComponentSelector}`)) {
249
+ template = await this.compileSubComponent<T>(
250
+ subComponentSelector, componentProperties, template, issuer
251
+ );
252
+ }
253
+ }
254
+ );
255
+
256
+ template = this.templateTrim(template);
257
+
258
+ return template;
259
+ } catch (error) {
260
+ throw new DyFM_Error({
261
+ ...this._getDefaultErrorSettings('setupComponent', error, issuer),
262
+
263
+ errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-SC0`,
264
+ message: `setupComponent failed! (${componentName})`,
265
+ });
266
+ }
267
+ }
268
+
269
+ private compileHTMLMainFrame(component: DyNTS_EmailTemplateComponent): string {
270
+ const allLinks: string[] = [];
271
+ const allStyles: string[] = [];
272
+
273
+ if (component.headerLinks) {
274
+ allLinks.push(component.headerLinks);
275
+ }
276
+
277
+ if (component.styles) {
278
+ allStyles.push(component.styles);
279
+ }
280
+
281
+ component.subComponentSelectors.forEach((subComponentSelector: string): void => {
282
+ const subComponent: DyNTS_EmailTemplateComponent =
283
+ this.componentsBySelector[subComponentSelector];
284
+
285
+ if (subComponent.headerLinks) {
286
+ allLinks.push(subComponent.headerLinks.trim());
287
+ }
288
+
289
+ if (subComponent.styles) {
290
+ allStyles.push(subComponent.styles.trim());
291
+ }
292
+ });
293
+
294
+ const styles = this.styleTrim(allStyles.join(''));
295
+ const styleSize = this.getStringKBSize(styles);
296
+
297
+ if (this.styleLimitWarning < styleSize) {
298
+ DyFM_Log.warn(
299
+ `\nDynamoNTS EmailService WARNING (${this.serviceName}), ` +
300
+ `\nEmail template styles are too big! (${styleSize}KB)` +
301
+ `\ncomponent: ${component.name} (${component.selector})` +
302
+ `\nSome email clients may not support this!` +
303
+ `\nThe limit is ${this.styleLimitWarning}KB!`
304
+ );
305
+ }
306
+
307
+ return `\n<!DOCTYPE html>` +
308
+ `\n<html>` +
309
+ `\n <head>` +
310
+ `\n ${allLinks.join('')}` +
311
+ `\n` +
312
+ `\n <style>` +
313
+ `\n ${styles}` +
314
+ `\n </style>` +
315
+ `\n </head>` +
316
+ `\n <body>` +
317
+ `\n ${component.template}` +
318
+ `\n </body>` +
319
+ `\n</html> `;
320
+ }
321
+
322
+ /** trims all rows and remove everything between /*...*\/ */
323
+ private styleTrim(style: string): string {
324
+ let result: string = style?.split('\n').map((row: string): string => row.trim()).join('');
325
+
326
+ while (result?.includes('/*')) {
327
+ const start = result.indexOf('/*');
328
+ const end = result.indexOf('*/', start) + 2;
329
+
330
+ result = result.substring(0, start) + result.substring(end);
331
+ }
332
+
333
+ return result;
334
+ }
335
+
336
+ /** removes HTML comments */
337
+ private templateTrim(template: string): string {
338
+ let result: string = template;
339
+
340
+ while (result.includes('<!--')) {
341
+ const start = result.indexOf('<!--');
342
+ const end = result.indexOf('-->', start) + 3;
343
+
344
+ result = result.substring(0, start) + result.substring(end);
345
+ }
346
+
347
+ return result;
348
+ }
349
+
350
+
351
+ private getStringKBSize(str: string): number {
352
+ const b: number = str.length * 2;
353
+
354
+ return b / 1024;
355
+ }
356
+
357
+ private async compileComponentProperties<T>(
358
+ component: DyNTS_EmailTemplateComponent,
359
+ componentProperties: T,
360
+ template: string,
361
+ issuer: string
362
+ ): Promise<string> {
363
+ try {
364
+ component.properties.forEach((propertyKey: string): void => {
365
+ if (!componentProperties[propertyKey]) {
366
+ throw new DyFM_Error({
367
+ ...this._getDefaultErrorSettings(
368
+ 'setupComponent',
369
+ new Error(
370
+ `ComponentProperty missing from input! "${propertyKey}" for "${component.name}"`
371
+ ),
372
+ issuer
373
+ ),
374
+
375
+ errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-SC4`,
376
+ additionalContent: {
377
+ componentProperties: Object.keys(componentProperties),
378
+ },
379
+ });
380
+ }
381
+
382
+ const propReg = new RegExp(`{{${propertyKey}}}`, 'g');
383
+
384
+ template = template.replace(propReg, componentProperties[propertyKey]);
385
+ });
386
+
387
+ return template;
388
+ } catch (error) {
389
+ throw new DyFM_Error({
390
+ ...this._getDefaultErrorSettings('setupComponent', error, issuer),
391
+
392
+ errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-SC3`,
393
+ });
394
+ }
395
+ }
396
+
397
+ private async compileSubComponent<T>(
398
+ subComponentSelector: string,
399
+ componentProperties: T,
400
+ template: string,
401
+ issuer: string
402
+ ): Promise<string> {
403
+
404
+ const subComponent: DyNTS_EmailTemplateComponent =
405
+ this.componentsBySelector[subComponentSelector];
406
+
407
+ if (!subComponent) {
408
+ throw new DyFM_Error({
409
+ ...this._getDefaultErrorSettings(
410
+ 'setupComponent',
411
+ new Error(`SubComponent missing from components! "${subComponentSelector}"`),
412
+ issuer
413
+ ),
414
+
415
+ errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-SC2`,
416
+ additionalContent: this.componentsBySelector,
417
+ });
418
+ }
419
+
420
+ let subComponentTemplate: string = subComponent.template;
421
+ const startTag = `<nts-${subComponent.selector}`;
422
+ const endTag = `</nts-${subComponent.selector}>`;
423
+ const tagHTMLProperties: string =
424
+ template.split(startTag)[1].split('>')[0];
425
+ let componentContent: string;
426
+
427
+ if (!tagHTMLProperties) {
428
+ componentContent = template.split(`${startTag}>`)[1].split(endTag)[0];
429
+ } else {
430
+ componentContent = template.split(startTag)[1].split('>')[1].split(endTag)[0];
431
+ }
432
+
433
+ const contentReg = new RegExp(`<nts-content>`, 'g');
434
+
435
+ subComponentTemplate = subComponentTemplate.replace(contentReg, componentContent);
436
+ subComponentTemplate = await this.compileComponentProperties<T>(
437
+ subComponent,
438
+ componentProperties,
439
+ subComponentTemplate,
440
+ issuer
441
+ );
442
+
443
+ const startTagReg = new RegExp(startTag, 'g');
444
+ const endTagReg = new RegExp(endTag, 'g');
445
+
446
+ template = template.replace(startTagReg, '<div');
447
+ template = template.replace(componentContent, subComponentTemplate);
448
+ template = template.replace(endTagReg, '</div>');
449
+
450
+ /* while (template.includes(`<nts-${subComponent.selector}`)) {
451
+ const replaceStartIndex = template.indexOf(`<nts-${subComponent.selector}`);
452
+ const replaceEndIndex = template.indexOf(endTag, replaceStartIndex) + endTag.length;
453
+
454
+ template =
455
+ template.substring(0, replaceStartIndex) +
456
+ subComponentCompiled +
457
+ template.substring(replaceEndIndex);
458
+ } */
459
+
460
+ return template;
461
+ }
462
+
463
+ private async loadEmailTemplateComponent(component: DyNTS_EmailTemplateComponent): Promise<void> {
464
+ try {
465
+ if (this.componentsBySelector[component.selector]) {
466
+ DyFM_Log.warn(
467
+ `Email component already loaded! (it will be skipped) "${component.selector}"`
468
+ );
469
+
470
+ return;
471
+ }
472
+
473
+ if (!component.templatePath && !component.template) {
474
+ throw new DyFM_Error({
475
+ ...this._getDefaultErrorSettings(
476
+ 'loadComponent',
477
+ new Error(`Component missing template and templatePath! "${component.name}"`),
478
+ 'SYSTEM'
479
+ ),
480
+
481
+ errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-LC2`,
482
+ additionalContent: {
483
+ component: component,
484
+ },
485
+ });
486
+ }
487
+
488
+ if (!component.template) {
489
+ component.template = await this.readFile(component.templatePath, component.name).catch(
490
+ async (error: DyFM_Error): Promise<string> => {
491
+
492
+ if (DyNTS_global_settings.autoResearchIssues) {
493
+ // read folder contents, read parent folder contents
494
+ const folderContents = FileSystem.readdirSync(
495
+ component.templatePath.split('/').slice(0, -1).join('/')
496
+ );
497
+ const parentFolderContents = FileSystem.readdirSync(
498
+ component.templatePath.split('/').slice(0, -2).join('/')
499
+ );
500
+
501
+ DyFM_Log.testWarn(
502
+ `DynamoNTS EmailService WARNING, couldn't load email component's template; ` +
503
+ `\n(${component.name} from ${component.templatePath})` +
504
+ `\n folder contents: \n ${folderContents.join(', \n ')}` +
505
+ `\n parent folder contents: \n ${parentFolderContents.join(', \n ')}`
506
+ );
507
+ } else {
508
+ DyFM_Log.error(
509
+ `\nDynamoNTS EmailService ERROR, couldn't load email component's template; ` +
510
+ `\n(${component.name} from ${component.templatePath})`
511
+ );
512
+ }
513
+
514
+ throw error;
515
+ }
516
+ );
517
+ }
518
+
519
+ if (component.stylePath) {
520
+ await new Promise<void>((resolve, reject): void => {
521
+ FileSystem.readFile(component.stylePath, 'utf8' , (err, styles): void => {
522
+ if (err || !styles) {
523
+ if (!err) {
524
+ err = new Error(
525
+ `Couldn't load email component's styles; ${component.name} ` +
526
+ `from ${component.stylePath}`
527
+ );
528
+ }
529
+
530
+ reject(
531
+ new DyFM_Error({
532
+ ...this._getDefaultErrorSettings('loadTemplate', err, 'SYSTEM'),
533
+
534
+ errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-LC4`,
535
+ })
536
+ );
537
+
538
+ return;
539
+ }
540
+
541
+ component.styles = styles;
542
+
543
+ resolve();
544
+ });
545
+ });
546
+ }
547
+
548
+ component.properties = this.getTemplatePropertyKeys(component.template);
549
+ this.componentsBySelector[component.selector] = component;
550
+ this.componentsByName[component.name] = component;
551
+
552
+ component.properties.forEach((propertyKey: string): void => {
553
+ if (!component.template.includes(`{{${propertyKey}}}`)) {
554
+ throw new DyFM_Error({
555
+ ...this._getDefaultErrorSettings(
556
+ 'loadComponent',
557
+ new Error(
558
+ `TemplateProperty missing from template! (${propertyKey} for ${component.name})`
559
+ ),
560
+ 'SYSTEM'
561
+ ),
562
+
563
+ errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-LC5`,
564
+ additionalContent: component.template,
565
+ });
566
+ }
567
+ });
568
+ } catch (error) {
569
+ throw new DyFM_Error({
570
+ ...this._getDefaultErrorSettings('loadComponent', error, 'SYSTEM'),
571
+
572
+ errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-LC0`,
573
+ message: `loadComponent failed! (${component.name})`,
574
+ });
575
+ }
576
+ }
577
+
578
+ private async readFile(path: string, nameOfTarget: string): Promise<string> {
579
+ return await new Promise<string>((resolve, reject): void => {
580
+ FileSystem.readFile(path, 'utf8' , (err, template): void => {
581
+ if (err || !template) {
582
+ err ??= new Error(
583
+ `Couldn't load email component's template; \n ${nameOfTarget} ` +
584
+ `\n from ${path}`
585
+ );
586
+
587
+ reject(
588
+ new DyFM_Error({
589
+ ...this._getDefaultErrorSettings('loadTemplate', err, 'SYSTEM'),
590
+
591
+ errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-LC3`,
592
+ })
593
+ );
594
+
595
+ return;
596
+ }
597
+
598
+ resolve(template);
599
+ });
600
+ });
601
+ }
602
+
603
+ private connectComponents(): void {
604
+ try {
605
+ for (const componentSelector in this.componentsBySelector) {
606
+ this.componentsBySelector[componentSelector].subComponentSelectors = [];
607
+
608
+ const innerTags: string[] =
609
+ this.componentsBySelector[componentSelector].template.split('<nts-');
610
+
611
+ innerTags.shift();
612
+ innerTags.forEach(
613
+ (subComponents: string): void => {
614
+ const subComponentSelector = subComponents.split('>')[0].split(' ')[0];
615
+
616
+ if (subComponentSelector !== 'content') {
617
+ const fullSelector = 'nts-' + subComponentSelector;
618
+
619
+ if (fullSelector) {
620
+ if (!this.componentsBySelector[subComponentSelector]) {
621
+ throw new DyFM_Error({
622
+ ...this._getDefaultErrorSettings(
623
+ 'connectComponents',
624
+ new Error(`SubComponent missing from components! (${fullSelector})`),
625
+ 'SYSTEM'
626
+ ),
627
+
628
+ errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-CC1`,
629
+ additionalContent: {
630
+ availableComponenets: Object.keys(this.componentsBySelector),
631
+ },
632
+ });
633
+ }
634
+
635
+ this.componentsBySelector[componentSelector].subComponentSelectors.push(
636
+ subComponentSelector
637
+ );
638
+ }
639
+ }
640
+ }
641
+ );
642
+ }
643
+ } catch (error) {
644
+ throw new DyFM_Error({
645
+ ...this._getDefaultErrorSettings('connectComponents', error, 'SYSTEM'),
646
+
647
+ errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-CC0`,
648
+ message: `connectComponents failed!`,
649
+ });
650
+ }
651
+ }
652
+
653
+ /**
654
+ *
655
+ * @param template
656
+ * @returns
657
+ */
658
+ private getTemplatePropertyKeys(template: string): string[] {
659
+ try {
660
+ const propertyKeys: string[] = [];
661
+ let propertyOpenTagIndex = template.indexOf('{{');
662
+ let propertyCloseTagIndex = template.indexOf('}}', propertyOpenTagIndex + 2);
663
+
664
+ while (propertyOpenTagIndex >= 0) {
665
+ if (propertyCloseTagIndex === -1) {
666
+ DyFM_Log.error(
667
+ `\nDyNTS_EmailService ERROR, missing closing tag from email template! ` +
668
+ `(${propertyOpenTagIndex} -)`,
669
+ propertyKeys
670
+ );
671
+
672
+ throw new DyFM_Error({
673
+ errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-200`,
674
+ addECToUserMsg: true,
675
+ message: `ERROR, missing closing tag from email template! (${propertyOpenTagIndex} -)`,
676
+ userMessage: this.defaultErrorUserMsg,
677
+ });
678
+ }
679
+
680
+ const newKey: string = template.substring(propertyOpenTagIndex + 2, propertyCloseTagIndex);
681
+
682
+ if (!propertyKeys.includes(newKey)) {
683
+ propertyKeys.push(newKey);
684
+ }
685
+
686
+ // KELLEZIDE?
687
+ propertyOpenTagIndex = template.indexOf('{{', propertyOpenTagIndex + 2);
688
+ propertyCloseTagIndex = template.indexOf('}}', propertyOpenTagIndex + 2);
689
+ }
690
+ // console.log('\n\n\nTEST propertyKeys: ', propertyKeys);
691
+
692
+ return propertyKeys;
693
+ } catch (error) {
694
+ throw new DyFM_Error({
695
+ ...this._getDefaultErrorSettings('getTemplatePropertyKeys', error, 'SYSTEM'),
696
+
697
+ errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-ES0-GTPK0`,
698
+ message: `getTemplatePropertyKeys failed!`,
699
+ additionalContent: template,
700
+ });
701
+ }
702
+ }
703
+
704
+ private _getDefaultErrorSettings(
705
+ fnName: string,
706
+ error: DyFM_AnyError,
707
+ issuer: string
708
+ ): DyFM_Error_Settings {
709
+ return {
710
+ status: (error as DyFM_Error)?.___status ?? 500,
711
+ message: (error as Error)?.message ??
712
+ (error as DyFM_Error)?._message ??
713
+ `${fnName} was UNSUCCESSFUL (NTS; ${this.serviceName})`,
714
+ addECToUserMsg: !(error as DyFM_Error)?.__userMessage,
715
+ userMessage: (error as DyFM_Error)?.__userMessage ?? this.defaultErrorUserMsg,
716
+ issuer: issuer,
717
+ issuerService: this.serviceName,
718
+ error: error,
719
+ };
720
+ }
721
+
722
+ protected getDefaultErrorSettings(
723
+ fnName: string,
724
+ error: DyFM_AnyError,
725
+ issuer: string,
726
+ /** @deprecated we wont support the separate user message in the future, use the message instead */
727
+ useMessageAsUserMessage: boolean = true,
728
+ ): DyFM_Error_Settings {
729
+ return {
730
+ status: (error as DyFM_Error)?.___status ?? 500,
731
+ message: (error as Error)?.message ??
732
+ (error as DyFM_Error)?._message ??
733
+ `${fnName} was UNSUCCESSFUL (${DyNTS_global_settings.systemShortCodeName})`,
734
+ addECToUserMsg: !(error as DyFM_Error)?.__userMessage,
735
+ userMessage: (error as DyFM_Error)?.__userMessage ??
736
+ (useMessageAsUserMessage ? (error as Error)?.message : this.defaultErrorUserMsg),
737
+ issuer: issuer,
738
+ issuerService: this.constructor?.name,
739
+ error: error,
740
+ };
741
+ }
742
+ }