@venizia/ignis-helpers 0.3.6 → 0.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (246) hide show
  1. package/LICENSE.md +1 -1
  2. package/dist/cjs/common/redact.js +1 -1
  3. package/dist/cjs/common/redact.js.map +1 -1
  4. package/dist/cjs/modules/base.js +1 -1
  5. package/dist/cjs/modules/base.js.map +1 -1
  6. package/dist/cjs/modules/crypto/algorithms/aes.algorithm.js +1 -1
  7. package/dist/cjs/modules/crypto/algorithms/aes.algorithm.js.map +1 -1
  8. package/dist/cjs/modules/logger/common/constants.js +1 -1
  9. package/dist/cjs/modules/logger/common/constants.js.map +1 -1
  10. package/dist/cjs/modules/logger/factory.js +1 -1
  11. package/dist/cjs/modules/logger/factory.js.map +1 -1
  12. package/dist/cjs/modules/logger/formatting/deep-splat.js +1 -1
  13. package/dist/cjs/modules/logger/formatting/deep-splat.js.map +1 -1
  14. package/dist/cjs/modules/logger/formatting/error-prettier.js +4 -4
  15. package/dist/cjs/modules/logger/formatting/error-prettier.js.map +1 -1
  16. package/dist/cjs/modules/logger/hf/flusher.js +3 -3
  17. package/dist/cjs/modules/logger/hf/flusher.js.map +1 -1
  18. package/dist/cjs/modules/logger/resolver.js +3 -3
  19. package/dist/cjs/modules/logger/resolver.js.map +1 -1
  20. package/dist/cjs/modules/logger/winston/formatters/deep-splat.js +1 -1
  21. package/dist/cjs/modules/logger/winston/formatters/deep-splat.js.map +1 -1
  22. package/dist/cjs/modules/logger/winston/logger-factory.js +1 -1
  23. package/dist/cjs/modules/logger/winston/logger-factory.js.map +1 -1
  24. package/dist/cjs/modules/logger/winston/transports/dgram.transport.js +2 -2
  25. package/dist/cjs/modules/logger/winston/transports/dgram.transport.js.map +1 -1
  26. package/dist/cjs/modules/network/http-request/fetcher/axios-fetcher.js +1 -1
  27. package/dist/cjs/modules/network/http-request/fetcher/axios-fetcher.js.map +1 -1
  28. package/dist/cjs/modules/network/http-request/fetcher/base-fetcher.d.ts +17 -14
  29. package/dist/cjs/modules/network/http-request/fetcher/base-fetcher.d.ts.map +1 -1
  30. package/dist/cjs/modules/network/http-request/fetcher/base-fetcher.js +3 -0
  31. package/dist/cjs/modules/network/http-request/fetcher/base-fetcher.js.map +1 -1
  32. package/dist/cjs/modules/network/http-request/fetcher/node-fetcher.d.ts +13 -4
  33. package/dist/cjs/modules/network/http-request/fetcher/node-fetcher.d.ts.map +1 -1
  34. package/dist/cjs/modules/network/http-request/fetcher/node-fetcher.js +34 -11
  35. package/dist/cjs/modules/network/http-request/fetcher/node-fetcher.js.map +1 -1
  36. package/dist/cjs/modules/network/tcp-socket/base-tcp-client.helper.js +1 -1
  37. package/dist/cjs/modules/network/tcp-socket/base-tcp-client.helper.js.map +1 -1
  38. package/dist/cjs/modules/network/tcp-socket/base-tcp-server.helper.js +4 -4
  39. package/dist/cjs/modules/network/tcp-socket/base-tcp-server.helper.js.map +1 -1
  40. package/dist/cjs/modules/network/udp-socket/network-udp-client.helper.js +1 -1
  41. package/dist/cjs/modules/network/udp-socket/network-udp-client.helper.js.map +1 -1
  42. package/dist/cjs/modules/network/utilities/query-string.d.ts +27 -2
  43. package/dist/cjs/modules/network/utilities/query-string.d.ts.map +1 -1
  44. package/dist/cjs/modules/network/utilities/query-string.js +34 -2
  45. package/dist/cjs/modules/network/utilities/query-string.js.map +1 -1
  46. package/dist/cjs/modules/network/utilities/url-safety/ingest.js +1 -1
  47. package/dist/cjs/modules/network/utilities/url-safety/ingest.js.map +1 -1
  48. package/dist/cjs/modules/network/utilities/url-safety/policy.js +1 -1
  49. package/dist/cjs/modules/network/utilities/url-safety/policy.js.map +1 -1
  50. package/dist/cjs/modules/pool/abstract.js +4 -4
  51. package/dist/cjs/modules/pool/abstract.js.map +1 -1
  52. package/dist/cjs/modules/queue/bullmq/helper.js +2 -2
  53. package/dist/cjs/modules/queue/bullmq/helper.js.map +1 -1
  54. package/dist/cjs/modules/queue/kafka/bundler/platformatic-require.plugin.js.map +1 -1
  55. package/dist/cjs/modules/queue/kafka/bundler/platformatic-wasm.plugin.js +1 -1
  56. package/dist/cjs/modules/queue/kafka/bundler/platformatic-wasm.plugin.js.map +1 -1
  57. package/dist/cjs/modules/queue/kafka/consumer.js +2 -2
  58. package/dist/cjs/modules/queue/kafka/consumer.js.map +1 -1
  59. package/dist/cjs/modules/queue/mqtt/helper.js +4 -4
  60. package/dist/cjs/modules/queue/mqtt/helper.js.map +1 -1
  61. package/dist/cjs/modules/redis/base/abstract.helper.js +4 -4
  62. package/dist/cjs/modules/redis/base/abstract.helper.js.map +1 -1
  63. package/dist/cjs/modules/redis/cluster/cluster.helper.js +1 -1
  64. package/dist/cjs/modules/redis/cluster/cluster.helper.js.map +1 -1
  65. package/dist/cjs/modules/redis/sentinel/sentinel.helper.js +1 -1
  66. package/dist/cjs/modules/redis/sentinel/sentinel.helper.js.map +1 -1
  67. package/dist/cjs/modules/secrets/base/abstract.helper.js +2 -2
  68. package/dist/cjs/modules/secrets/base/abstract.helper.js.map +1 -1
  69. package/dist/cjs/modules/secrets/hashicorp/hashicorp.helper.js +2 -2
  70. package/dist/cjs/modules/secrets/hashicorp/hashicorp.helper.js.map +1 -1
  71. package/dist/cjs/modules/socket/socket-io/browser.d.ts +5 -0
  72. package/dist/cjs/modules/socket/socket-io/browser.d.ts.map +1 -0
  73. package/dist/cjs/modules/socket/socket-io/browser.js +21 -0
  74. package/dist/cjs/modules/socket/socket-io/browser.js.map +1 -0
  75. package/dist/cjs/modules/socket/socket-io/client/browser-helper.d.ts +61 -0
  76. package/dist/cjs/modules/socket/socket-io/client/browser-helper.d.ts.map +1 -0
  77. package/dist/cjs/modules/socket/socket-io/client/browser-helper.js +250 -0
  78. package/dist/cjs/modules/socket/socket-io/client/browser-helper.js.map +1 -0
  79. package/dist/cjs/modules/socket/socket-io/client/helper.d.ts +8 -51
  80. package/dist/cjs/modules/socket/socket-io/client/helper.d.ts.map +1 -1
  81. package/dist/cjs/modules/socket/socket-io/client/helper.js +12 -230
  82. package/dist/cjs/modules/socket/socket-io/client/helper.js.map +1 -1
  83. package/dist/cjs/modules/socket/socket-io/server/helper.js +5 -5
  84. package/dist/cjs/modules/socket/socket-io/server/helper.js.map +1 -1
  85. package/dist/cjs/modules/socket/websocket/server/delivery.js +2 -2
  86. package/dist/cjs/modules/socket/websocket/server/delivery.js.map +1 -1
  87. package/dist/cjs/modules/socket/websocket/server/helper.js +4 -4
  88. package/dist/cjs/modules/socket/websocket/server/helper.js.map +1 -1
  89. package/dist/cjs/modules/storage/base.js +3 -3
  90. package/dist/cjs/modules/storage/base.js.map +1 -1
  91. package/dist/cjs/modules/storage/bun-s3/helper.js +1 -1
  92. package/dist/cjs/modules/storage/bun-s3/helper.js.map +1 -1
  93. package/dist/cjs/modules/storage/bun-s3/utility.js +6 -6
  94. package/dist/cjs/modules/storage/bun-s3/utility.js.map +1 -1
  95. package/dist/cjs/modules/storage/common/errors.js +1 -1
  96. package/dist/cjs/modules/storage/common/errors.js.map +1 -1
  97. package/dist/cjs/modules/storage/minio/helper.js +4 -4
  98. package/dist/cjs/modules/storage/minio/helper.js.map +1 -1
  99. package/dist/cjs/modules/temporal/abstract.js +5 -5
  100. package/dist/cjs/modules/temporal/abstract.js.map +1 -1
  101. package/dist/cjs/modules/temporal/adapters/intl.d.ts.map +1 -1
  102. package/dist/cjs/modules/temporal/adapters/intl.js +3 -1
  103. package/dist/cjs/modules/temporal/adapters/intl.js.map +1 -1
  104. package/dist/cjs/modules/temporal/locale/locale.js +4 -4
  105. package/dist/cjs/modules/temporal/locale/locale.js.map +1 -1
  106. package/dist/cjs/modules/tree/builder.js +2 -2
  107. package/dist/cjs/modules/tree/builder.js.map +1 -1
  108. package/dist/cjs/modules/uid/opaque.js +2 -2
  109. package/dist/cjs/modules/uid/opaque.js.map +1 -1
  110. package/dist/cjs/modules/uid/uuid/v5.js +1 -1
  111. package/dist/cjs/modules/uid/uuid/v5.js.map +1 -1
  112. package/dist/cjs/modules/worker-thread/bus/base.js +4 -4
  113. package/dist/cjs/modules/worker-thread/bus/base.js.map +1 -1
  114. package/dist/cjs/modules/worker-thread/worker/base.js +4 -4
  115. package/dist/cjs/modules/worker-thread/worker/base.js.map +1 -1
  116. package/dist/cjs/utilities/parse.utility.js +4 -4
  117. package/dist/cjs/utilities/parse.utility.js.map +1 -1
  118. package/dist/cjs/utilities/promise.utility.js +1 -1
  119. package/dist/cjs/utilities/promise.utility.js.map +1 -1
  120. package/dist/cjs/utilities/request.utility.js +1 -1
  121. package/dist/cjs/utilities/request.utility.js.map +1 -1
  122. package/dist/cjs/utilities/sleep.utility.js +1 -1
  123. package/dist/cjs/utilities/sleep.utility.js.map +1 -1
  124. package/dist/esm/common/redact.js +1 -1
  125. package/dist/esm/common/redact.js.map +1 -1
  126. package/dist/esm/modules/base.js +1 -1
  127. package/dist/esm/modules/base.js.map +1 -1
  128. package/dist/esm/modules/crypto/algorithms/aes.algorithm.js +1 -1
  129. package/dist/esm/modules/crypto/algorithms/aes.algorithm.js.map +1 -1
  130. package/dist/esm/modules/logger/common/constants.js +1 -1
  131. package/dist/esm/modules/logger/common/constants.js.map +1 -1
  132. package/dist/esm/modules/logger/factory.js +1 -1
  133. package/dist/esm/modules/logger/factory.js.map +1 -1
  134. package/dist/esm/modules/logger/formatting/deep-splat.js +1 -1
  135. package/dist/esm/modules/logger/formatting/deep-splat.js.map +1 -1
  136. package/dist/esm/modules/logger/formatting/error-prettier.js +4 -4
  137. package/dist/esm/modules/logger/formatting/error-prettier.js.map +1 -1
  138. package/dist/esm/modules/logger/hf/flusher.js +3 -3
  139. package/dist/esm/modules/logger/hf/flusher.js.map +1 -1
  140. package/dist/esm/modules/logger/resolver.js +3 -3
  141. package/dist/esm/modules/logger/resolver.js.map +1 -1
  142. package/dist/esm/modules/logger/winston/formatters/deep-splat.js +1 -1
  143. package/dist/esm/modules/logger/winston/formatters/deep-splat.js.map +1 -1
  144. package/dist/esm/modules/logger/winston/logger-factory.js +1 -1
  145. package/dist/esm/modules/logger/winston/logger-factory.js.map +1 -1
  146. package/dist/esm/modules/logger/winston/transports/dgram.transport.js +2 -2
  147. package/dist/esm/modules/logger/winston/transports/dgram.transport.js.map +1 -1
  148. package/dist/esm/modules/network/http-request/fetcher/axios-fetcher.js +1 -1
  149. package/dist/esm/modules/network/http-request/fetcher/axios-fetcher.js.map +1 -1
  150. package/dist/esm/modules/network/http-request/fetcher/base-fetcher.d.ts +17 -14
  151. package/dist/esm/modules/network/http-request/fetcher/base-fetcher.d.ts.map +1 -1
  152. package/dist/esm/modules/network/http-request/fetcher/base-fetcher.js +3 -0
  153. package/dist/esm/modules/network/http-request/fetcher/base-fetcher.js.map +1 -1
  154. package/dist/esm/modules/network/http-request/fetcher/node-fetcher.d.ts +13 -4
  155. package/dist/esm/modules/network/http-request/fetcher/node-fetcher.d.ts.map +1 -1
  156. package/dist/esm/modules/network/http-request/fetcher/node-fetcher.js +36 -13
  157. package/dist/esm/modules/network/http-request/fetcher/node-fetcher.js.map +1 -1
  158. package/dist/esm/modules/network/tcp-socket/base-tcp-client.helper.js +1 -1
  159. package/dist/esm/modules/network/tcp-socket/base-tcp-client.helper.js.map +1 -1
  160. package/dist/esm/modules/network/tcp-socket/base-tcp-server.helper.js +4 -4
  161. package/dist/esm/modules/network/tcp-socket/base-tcp-server.helper.js.map +1 -1
  162. package/dist/esm/modules/network/udp-socket/network-udp-client.helper.js +1 -1
  163. package/dist/esm/modules/network/udp-socket/network-udp-client.helper.js.map +1 -1
  164. package/dist/esm/modules/network/utilities/query-string.d.ts +27 -2
  165. package/dist/esm/modules/network/utilities/query-string.d.ts.map +1 -1
  166. package/dist/esm/modules/network/utilities/query-string.js +31 -1
  167. package/dist/esm/modules/network/utilities/query-string.js.map +1 -1
  168. package/dist/esm/modules/network/utilities/url-safety/ingest.js +1 -1
  169. package/dist/esm/modules/network/utilities/url-safety/ingest.js.map +1 -1
  170. package/dist/esm/modules/network/utilities/url-safety/policy.js +1 -1
  171. package/dist/esm/modules/network/utilities/url-safety/policy.js.map +1 -1
  172. package/dist/esm/modules/pool/abstract.js +4 -4
  173. package/dist/esm/modules/pool/abstract.js.map +1 -1
  174. package/dist/esm/modules/queue/bullmq/helper.js +2 -2
  175. package/dist/esm/modules/queue/bullmq/helper.js.map +1 -1
  176. package/dist/esm/modules/queue/kafka/bundler/platformatic-require.plugin.js.map +1 -1
  177. package/dist/esm/modules/queue/kafka/bundler/platformatic-wasm.plugin.js +1 -1
  178. package/dist/esm/modules/queue/kafka/bundler/platformatic-wasm.plugin.js.map +1 -1
  179. package/dist/esm/modules/queue/kafka/consumer.js +2 -2
  180. package/dist/esm/modules/queue/kafka/consumer.js.map +1 -1
  181. package/dist/esm/modules/queue/mqtt/helper.js +4 -4
  182. package/dist/esm/modules/queue/mqtt/helper.js.map +1 -1
  183. package/dist/esm/modules/redis/base/abstract.helper.js +4 -4
  184. package/dist/esm/modules/redis/base/abstract.helper.js.map +1 -1
  185. package/dist/esm/modules/redis/cluster/cluster.helper.js +1 -1
  186. package/dist/esm/modules/redis/cluster/cluster.helper.js.map +1 -1
  187. package/dist/esm/modules/redis/sentinel/sentinel.helper.js +1 -1
  188. package/dist/esm/modules/redis/sentinel/sentinel.helper.js.map +1 -1
  189. package/dist/esm/modules/secrets/base/abstract.helper.js +2 -2
  190. package/dist/esm/modules/secrets/base/abstract.helper.js.map +1 -1
  191. package/dist/esm/modules/secrets/hashicorp/hashicorp.helper.js +2 -2
  192. package/dist/esm/modules/secrets/hashicorp/hashicorp.helper.js.map +1 -1
  193. package/dist/esm/modules/socket/socket-io/browser.d.ts +5 -0
  194. package/dist/esm/modules/socket/socket-io/browser.d.ts.map +1 -0
  195. package/dist/esm/modules/socket/socket-io/browser.js +5 -0
  196. package/dist/esm/modules/socket/socket-io/browser.js.map +1 -0
  197. package/dist/esm/modules/socket/socket-io/client/browser-helper.d.ts +61 -0
  198. package/dist/esm/modules/socket/socket-io/client/browser-helper.d.ts.map +1 -0
  199. package/dist/esm/modules/socket/socket-io/client/browser-helper.js +246 -0
  200. package/dist/esm/modules/socket/socket-io/client/browser-helper.js.map +1 -0
  201. package/dist/esm/modules/socket/socket-io/client/helper.d.ts +8 -51
  202. package/dist/esm/modules/socket/socket-io/client/helper.d.ts.map +1 -1
  203. package/dist/esm/modules/socket/socket-io/client/helper.js +12 -230
  204. package/dist/esm/modules/socket/socket-io/client/helper.js.map +1 -1
  205. package/dist/esm/modules/socket/socket-io/server/helper.js +5 -5
  206. package/dist/esm/modules/socket/socket-io/server/helper.js.map +1 -1
  207. package/dist/esm/modules/socket/websocket/server/delivery.js +2 -2
  208. package/dist/esm/modules/socket/websocket/server/delivery.js.map +1 -1
  209. package/dist/esm/modules/socket/websocket/server/helper.js +4 -4
  210. package/dist/esm/modules/socket/websocket/server/helper.js.map +1 -1
  211. package/dist/esm/modules/storage/base.js +3 -3
  212. package/dist/esm/modules/storage/base.js.map +1 -1
  213. package/dist/esm/modules/storage/bun-s3/helper.js +1 -1
  214. package/dist/esm/modules/storage/bun-s3/helper.js.map +1 -1
  215. package/dist/esm/modules/storage/bun-s3/utility.js +6 -6
  216. package/dist/esm/modules/storage/bun-s3/utility.js.map +1 -1
  217. package/dist/esm/modules/storage/common/errors.js +1 -1
  218. package/dist/esm/modules/storage/common/errors.js.map +1 -1
  219. package/dist/esm/modules/storage/minio/helper.js +4 -4
  220. package/dist/esm/modules/storage/minio/helper.js.map +1 -1
  221. package/dist/esm/modules/temporal/abstract.js +5 -5
  222. package/dist/esm/modules/temporal/abstract.js.map +1 -1
  223. package/dist/esm/modules/temporal/adapters/intl.d.ts.map +1 -1
  224. package/dist/esm/modules/temporal/adapters/intl.js +3 -1
  225. package/dist/esm/modules/temporal/adapters/intl.js.map +1 -1
  226. package/dist/esm/modules/temporal/locale/locale.js +4 -4
  227. package/dist/esm/modules/temporal/locale/locale.js.map +1 -1
  228. package/dist/esm/modules/tree/builder.js +2 -2
  229. package/dist/esm/modules/tree/builder.js.map +1 -1
  230. package/dist/esm/modules/uid/opaque.js +2 -2
  231. package/dist/esm/modules/uid/opaque.js.map +1 -1
  232. package/dist/esm/modules/uid/uuid/v5.js +1 -1
  233. package/dist/esm/modules/uid/uuid/v5.js.map +1 -1
  234. package/dist/esm/modules/worker-thread/bus/base.js +4 -4
  235. package/dist/esm/modules/worker-thread/bus/base.js.map +1 -1
  236. package/dist/esm/modules/worker-thread/worker/base.js +4 -4
  237. package/dist/esm/modules/worker-thread/worker/base.js.map +1 -1
  238. package/dist/esm/utilities/parse.utility.js +4 -4
  239. package/dist/esm/utilities/parse.utility.js.map +1 -1
  240. package/dist/esm/utilities/promise.utility.js +1 -1
  241. package/dist/esm/utilities/promise.utility.js.map +1 -1
  242. package/dist/esm/utilities/request.utility.js +1 -1
  243. package/dist/esm/utilities/request.utility.js.map +1 -1
  244. package/dist/esm/utilities/sleep.utility.js +1 -1
  245. package/dist/esm/utilities/sleep.utility.js.map +1 -1
  246. package/package.json +69 -64
@@ -1 +1 @@
1
- {"version":3,"file":"base-fetcher.d.ts","sourceRoot":"","sources":["../../../../../../src/modules/network/http-request/fetcher/base-fetcher.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,KAAK,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACjE,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,+BAA+B,CAAC;AAC7D,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,WAAW,CAAC;AAEjD,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,GAAG,CAAC;CAC/B;AAED,MAAM,WAAW,UAAU,CACzB,CAAC,SAAS,eAAe,EACzB,EAAE,SAAS,eAAe,EAC1B,EAAE,EACF,CAAC,GAAG,OAAO;IAEX,IAAI,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC;IAC9C,GAAG,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC;IAC7C,IAAI,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC;IAC9C,GAAG,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC;IAC7C,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC;IAC/C,MAAM,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC;IAChD,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC;IAE/C,UAAU,IAAI,CAAC,CAAC;IAChB,SAAS,IAAI,CAAC,CAAC;CAChB;AAED,yNAAyN;AACzN,8BAAsB,8BAA8B,CAClD,CAAC,SAAS,eAAe,EACzB,EAAE,SAAS,eAAe,EAC1B,EAAE,EACF,CAAC,GAAG,OAAO,CACX,YAAW,UAAU,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IACnC,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,OAAO,EAAE,CAAC,CAAC;IACrB,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC;gBAER,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,CAAC,CAAA;KAAE;IAK9C,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,EAAE,CAAC;IAEtD,WAAW,CAAC,GAAG,EAAE,MAAM;IAIvB,UAAU;IAIV,SAAS,IAAI,CAAC;IAId,GAAG,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,OAAO;IAK9B,IAAI,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,OAAO;IAK/B,GAAG,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,OAAO;IAK9B,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,OAAO;IAKhC,MAAM,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,OAAO;IAKjC,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,OAAO;CAIjC"}
1
+ {"version":3,"file":"base-fetcher.d.ts","sourceRoot":"","sources":["../../../../../../src/modules/network/http-request/fetcher/base-fetcher.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,KAAK,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACjE,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,+BAA+B,CAAC;AAC7D,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,WAAW,CAAC;AAEjD,iIAAiI;AACjI,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAAC,CAAC;AAE7D,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,GAAG,CAAC;CAC/B;AAED,MAAM,WAAW,UAAU,CACzB,CAAC,SAAS,eAAe,EACzB,EAAE,SAAS,eAAe,EAC1B,EAAE,EACF,CAAC,GAAG,OAAO;IAEX,IAAI,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC;IACrD,GAAG,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC;IACpD,IAAI,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC;IACrD,GAAG,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC;IACpD,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC;IACtD,MAAM,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC;IACvD,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC;IAEtD,UAAU,IAAI,CAAC,CAAC;IAChB,SAAS,IAAI,CAAC,CAAC;CAChB;AAED,yNAAyN;AACzN,8BAAsB,8BAA8B,CAClD,CAAC,SAAS,eAAe,EACzB,EAAE,SAAS,eAAe,EAC1B,EAAE,EACF,CAAC,GAAG,OAAO,CACX,YAAW,UAAU,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IACnC,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,OAAO,EAAE,CAAC,CAAC;IACrB,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC;gBAER,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,CAAC,CAAC;QAAC,MAAM,CAAC,EAAE,CAAC,CAAA;KAAE;IAS1D,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,EAAE,CAAC;IAE7D,WAAW,CAAC,GAAG,EAAE,MAAM;IAIvB,UAAU;IAIV,SAAS,IAAI,CAAC;IAId,GAAG,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,cAAc;IAKrC,IAAI,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,cAAc;IAKtC,GAAG,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,cAAc;IAKrC,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,cAAc;IAKvC,MAAM,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,cAAc;IAKxC,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,cAAc;CAIxC"}
@@ -4,6 +4,9 @@ export class AbstractNetworkFetchableHelper {
4
4
  constructor(opts) {
5
5
  this.name = opts.name;
6
6
  this.variant = opts.variant;
7
+ if (opts.worker !== undefined) {
8
+ this.worker = opts.worker;
9
+ }
7
10
  }
8
11
  getProtocol(url) {
9
12
  return url.startsWith('http:') ? HTTP.Protocols.HTTP : HTTP.Protocols.HTTPS;
@@ -1 +1 @@
1
- {"version":3,"file":"base-fetcher.js","sourceRoot":"","sources":["../../../../../../src/modules/network/http-request/fetcher/base-fetcher.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAoB,MAAM,yBAAyB,CAAC;AAiCjE,yNAAyN;AACzN,MAAM,OAAgB,8BAA8B;IAUlD,YAAY,IAAkC;QAC5C,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;IAC9B,CAAC;IAID,WAAW,CAAC,GAAW;QACrB,OAAO,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;IAC9E,CAAC;IAED,UAAU;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,GAAG,CAAC,IAAQ,EAAE,MAAgB;QAC5B,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;QACzB,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;IAED,IAAI,CAAC,IAAQ,EAAE,MAAgB;QAC7B,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;QACzB,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,MAAM,CAAC,CAAC;IACnE,CAAC;IAED,GAAG,CAAC,IAAQ,EAAE,MAAgB;QAC5B,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;QACzB,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;IAED,KAAK,CAAC,IAAQ,EAAE,MAAgB;QAC9B,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;QACzB,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;IAED,MAAM,CAAC,IAAQ,EAAE,MAAgB;QAC/B,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;QACzB,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,CAAC,CAAC;IACrE,CAAC;IAED,KAAK,CAAC,IAAQ,EAAE,MAAgB;QAC9B,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;QACzB,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;CACF","sourcesContent":["import { HTTP, type THttpMethod } from '@/common/constants/http';\nimport { type AnyObject } from '@/common/types';\n// The leaf file, never the logger BARREL: that barrel reaches `node:module` and would drag this\n// browser-pure fetcher contract with it.\nimport type { ILogger } from '@/modules/logger/common/types';\nimport { type TFetcherVariant } from '../common';\n\nexport interface IRequestOptions {\n url: string;\n method?: THttpMethod;\n params?: AnyObject;\n timeout?: number;\n [extra: symbol | string]: any;\n}\n\nexport interface IFetchable<\n V extends TFetcherVariant,\n RQ extends IRequestOptions,\n RS,\n W = unknown,\n> {\n send(opts: RQ, logger?: ILogger): Promise<RS>;\n get(opts: RQ, logger?: ILogger): Promise<RS>;\n post(opts: RQ, logger?: ILogger): Promise<RS>;\n put(opts: RQ, logger?: ILogger): Promise<RS>;\n patch(opts: RQ, logger?: ILogger): Promise<RS>;\n delete(opts: RQ, logger?: ILogger): Promise<RS>;\n query(opts: RQ, logger?: ILogger): Promise<RS>;\n\n getVariant(): V;\n getWorker(): W;\n}\n\n/** `W` defaults to `unknown` so this stays free of `axios` - a concrete fetcher binds it to its real worker type (`AxiosInstance`, `typeof fetch`), which is then inherited on `this.worker` with no override needed. */\nexport abstract class AbstractNetworkFetchableHelper<\n V extends TFetcherVariant,\n RQ extends IRequestOptions,\n RS,\n W = unknown,\n> implements IFetchable<V, RQ, RS, W> {\n protected name: string;\n protected variant: V;\n protected worker: W;\n\n constructor(opts: { name: string; variant: V }) {\n this.name = opts.name;\n this.variant = opts.variant;\n }\n\n abstract send(opts: RQ, logger?: ILogger): Promise<RS>;\n\n getProtocol(url: string) {\n return url.startsWith('http:') ? HTTP.Protocols.HTTP : HTTP.Protocols.HTTPS;\n }\n\n getVariant() {\n return this.variant;\n }\n\n getWorker(): W {\n return this.worker;\n }\n\n get(opts: RQ, logger?: ILogger) {\n const { ...rest } = opts;\n return this.send({ ...rest, method: HTTP.Methods.GET }, logger);\n }\n\n post(opts: RQ, logger?: ILogger) {\n const { ...rest } = opts;\n return this.send({ ...rest, method: HTTP.Methods.POST }, logger);\n }\n\n put(opts: RQ, logger?: ILogger) {\n const { ...rest } = opts;\n return this.send({ ...rest, method: HTTP.Methods.PUT }, logger);\n }\n\n patch(opts: RQ, logger?: ILogger) {\n const { ...rest } = opts;\n return this.send({ ...rest, method: HTTP.Methods.PATCH }, logger);\n }\n\n delete(opts: RQ, logger?: ILogger) {\n const { ...rest } = opts;\n return this.send({ ...rest, method: HTTP.Methods.DELETE }, logger);\n }\n\n query(opts: RQ, logger?: ILogger) {\n const { ...rest } = opts;\n return this.send({ ...rest, method: HTTP.Methods.QUERY }, logger);\n }\n}\n"]}
1
+ {"version":3,"file":"base-fetcher.js","sourceRoot":"","sources":["../../../../../../src/modules/network/http-request/fetcher/base-fetcher.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAoB,MAAM,yBAAyB,CAAC;AAoCjE,yNAAyN;AACzN,MAAM,OAAgB,8BAA8B;IAUlD,YAAY,IAA8C;QACxD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAE5B,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC9B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC5B,CAAC;IACH,CAAC;IAID,WAAW,CAAC,GAAW;QACrB,OAAO,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;IAC9E,CAAC;IAED,UAAU;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,GAAG,CAAC,IAAQ,EAAE,MAAuB;QACnC,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;QACzB,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;IAED,IAAI,CAAC,IAAQ,EAAE,MAAuB;QACpC,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;QACzB,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,MAAM,CAAC,CAAC;IACnE,CAAC;IAED,GAAG,CAAC,IAAQ,EAAE,MAAuB;QACnC,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;QACzB,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;IAED,KAAK,CAAC,IAAQ,EAAE,MAAuB;QACrC,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;QACzB,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;IAED,MAAM,CAAC,IAAQ,EAAE,MAAuB;QACtC,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;QACzB,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,CAAC,CAAC;IACrE,CAAC;IAED,KAAK,CAAC,IAAQ,EAAE,MAAuB;QACrC,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;QACzB,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;CACF","sourcesContent":["import { HTTP, type THttpMethod } from '@/common/constants/http';\nimport { type AnyObject } from '@/common/types';\n// The leaf file, never the logger BARREL: that barrel reaches `node:module` and would drag this\n// browser-pure fetcher contract with it.\nimport type { ILogger } from '@/modules/logger/common/types';\nimport { type TFetcherVariant } from '../common';\n\n/** What a fetcher calls on the logger it is handed, so a host logger with only these two (a browser app's) is accepted as is. */\nexport type TFetcherLogger = Pick<ILogger, 'debug' | 'info'>;\n\nexport interface IRequestOptions {\n url: string;\n method?: THttpMethod;\n params?: AnyObject;\n timeout?: number;\n [extra: symbol | string]: any;\n}\n\nexport interface IFetchable<\n V extends TFetcherVariant,\n RQ extends IRequestOptions,\n RS,\n W = unknown,\n> {\n send(opts: RQ, logger?: TFetcherLogger): Promise<RS>;\n get(opts: RQ, logger?: TFetcherLogger): Promise<RS>;\n post(opts: RQ, logger?: TFetcherLogger): Promise<RS>;\n put(opts: RQ, logger?: TFetcherLogger): Promise<RS>;\n patch(opts: RQ, logger?: TFetcherLogger): Promise<RS>;\n delete(opts: RQ, logger?: TFetcherLogger): Promise<RS>;\n query(opts: RQ, logger?: TFetcherLogger): Promise<RS>;\n\n getVariant(): V;\n getWorker(): W;\n}\n\n/** `W` defaults to `unknown` so this stays free of `axios` - a concrete fetcher binds it to its real worker type (`AxiosInstance`, `typeof fetch`), which is then inherited on `this.worker` with no override needed. */\nexport abstract class AbstractNetworkFetchableHelper<\n V extends TFetcherVariant,\n RQ extends IRequestOptions,\n RS,\n W = unknown,\n> implements IFetchable<V, RQ, RS, W> {\n protected name: string;\n protected variant: V;\n protected worker: W;\n\n constructor(opts: { name: string; variant: V; worker?: W }) {\n this.name = opts.name;\n this.variant = opts.variant;\n\n if (opts.worker !== undefined) {\n this.worker = opts.worker;\n }\n }\n\n abstract send(opts: RQ, logger?: TFetcherLogger): Promise<RS>;\n\n getProtocol(url: string) {\n return url.startsWith('http:') ? HTTP.Protocols.HTTP : HTTP.Protocols.HTTPS;\n }\n\n getVariant() {\n return this.variant;\n }\n\n getWorker(): W {\n return this.worker;\n }\n\n get(opts: RQ, logger?: TFetcherLogger) {\n const { ...rest } = opts;\n return this.send({ ...rest, method: HTTP.Methods.GET }, logger);\n }\n\n post(opts: RQ, logger?: TFetcherLogger) {\n const { ...rest } = opts;\n return this.send({ ...rest, method: HTTP.Methods.POST }, logger);\n }\n\n put(opts: RQ, logger?: TFetcherLogger) {\n const { ...rest } = opts;\n return this.send({ ...rest, method: HTTP.Methods.PUT }, logger);\n }\n\n patch(opts: RQ, logger?: TFetcherLogger) {\n const { ...rest } = opts;\n return this.send({ ...rest, method: HTTP.Methods.PATCH }, logger);\n }\n\n delete(opts: RQ, logger?: TFetcherLogger) {\n const { ...rest } = opts;\n return this.send({ ...rest, method: HTTP.Methods.DELETE }, logger);\n }\n\n query(opts: RQ, logger?: TFetcherLogger) {\n const { ...rest } = opts;\n return this.send({ ...rest, method: HTTP.Methods.QUERY }, logger);\n }\n}\n"]}
@@ -1,8 +1,8 @@
1
1
  import { type THttpMethod } from '../../../../common/constants/http.js';
2
2
  import { type AnyObject } from '../../../../common/types/index.js';
3
+ import { type IQueryStringOptions } from '../../utilities/query-string.js';
3
4
  import { BaseNetworkRequest } from '../base-network-request.helper.js';
4
- import type { ILogger } from '../../../logger/common/types.js';
5
- import { AbstractNetworkFetchableHelper, type IRequestOptions } from './base-fetcher.js';
5
+ import { AbstractNetworkFetchableHelper, type IRequestOptions, type TFetcherLogger } from './base-fetcher.js';
6
6
  export interface INodeFetchRequestOptions extends RequestInit, IRequestOptions {
7
7
  url: string;
8
8
  method?: THttpMethod;
@@ -10,17 +10,26 @@ export interface INodeFetchRequestOptions extends RequestInit, IRequestOptions {
10
10
  }
11
11
  export declare class NodeFetcher extends AbstractNetworkFetchableHelper<'node-fetch', INodeFetchRequestOptions, Awaited<ReturnType<typeof fetch>>, typeof fetch> {
12
12
  private defaultConfigs;
13
+ private queryString;
13
14
  constructor(opts: {
14
15
  name: string;
15
16
  defaultConfigs: RequestInit;
16
- logger?: ILogger;
17
+ /** How `params` are written into the url; the defaults are `node:querystring`'s. */
18
+ queryString?: IQueryStringOptions;
19
+ logger?: TFetcherLogger;
17
20
  });
18
- send(opts: INodeFetchRequestOptions, logger?: ILogger): Promise<Response>;
21
+ /** A raw body passes through; a plain object or an array is JSON-encoded; no body stays no body. */
22
+ protected serializeBody(opts: {
23
+ body: unknown;
24
+ }): RequestInit['body'] | undefined;
25
+ send(opts: INodeFetchRequestOptions, logger?: TFetcherLogger): Promise<Response>;
19
26
  }
20
27
  export interface INodeFetchNetworkRequestOptions {
21
28
  name: string;
22
29
  networkOptions: RequestInit & {
23
30
  baseUrl?: string;
31
+ /** How `params` are written into every url this request sends; see {@link IQueryStringOptions}. */
32
+ queryString?: IQueryStringOptions;
24
33
  };
25
34
  }
26
35
  export declare class NodeFetchNetworkRequest extends BaseNetworkRequest<'node-fetch'> {
@@ -1 +1 @@
1
- {"version":3,"file":"node-fetcher.d.ts","sourceRoot":"","sources":["../../../../../../src/modules/network/http-request/fetcher/node-fetcher.ts"],"names":[],"mappings":"AACA,OAAO,EAAQ,KAAK,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACjE,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,+BAA+B,CAAC;AAC7D,OAAO,EAAE,8BAA8B,EAAE,KAAK,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEtF,MAAM,WAAW,wBAAyB,SAAQ,WAAW,EAAE,eAAe;IAC5E,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,MAAM,CAAC,EAAE,SAAS,CAAC;CACpB;AAED,qBAAa,WAAY,SAAQ,8BAA8B,CAC7D,YAAY,EACZ,wBAAwB,EACxB,OAAO,CAAC,UAAU,CAAC,OAAO,KAAK,CAAC,CAAC,EACjC,OAAO,KAAK,CACb;IACC,OAAO,CAAC,cAAc,CAAc;gBAExB,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,cAAc,EAAE,WAAW,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE;IASlE,IAAI,CAAC,IAAI,EAAE,wBAAwB,EAAE,MAAM,CAAC,EAAE,OAAO;CAkErE;AAED,MAAM,WAAW,+BAA+B;IAC9C,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,WAAW,GAAG;QAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;CACH;AAED,qBAAa,uBAAwB,SAAQ,kBAAkB,CAAC,YAAY,CAAC;gBAC/D,IAAI,EAAE,+BAA+B;CAsBlD"}
1
+ {"version":3,"file":"node-fetcher.d.ts","sourceRoot":"","sources":["../../../../../../src/modules/network/http-request/fetcher/node-fetcher.ts"],"names":[],"mappings":"AACA,OAAO,EAAQ,KAAK,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACjE,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EACL,KAAK,mBAAmB,EAGzB,MAAM,8BAA8B,CAAC;AAEtC,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EACL,8BAA8B,EAC9B,KAAK,eAAe,EACpB,KAAK,cAAc,EACpB,MAAM,gBAAgB,CAAC;AAExB,MAAM,WAAW,wBAAyB,SAAQ,WAAW,EAAE,eAAe;IAC5E,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,MAAM,CAAC,EAAE,SAAS,CAAC;CACpB;AAcD,qBAAa,WAAY,SAAQ,8BAA8B,CAC7D,YAAY,EACZ,wBAAwB,EACxB,OAAO,CAAC,UAAU,CAAC,OAAO,KAAK,CAAC,CAAC,EACjC,OAAO,KAAK,CACb;IACC,OAAO,CAAC,cAAc,CAAc;IACpC,OAAO,CAAC,WAAW,CAAsB;gBAE7B,IAAI,EAAE;QAChB,IAAI,EAAE,MAAM,CAAC;QACb,cAAc,EAAE,WAAW,CAAC;QAC5B,oFAAoF;QACpF,WAAW,CAAC,EAAE,mBAAmB,CAAC;QAClC,MAAM,CAAC,EAAE,cAAc,CAAC;KACzB;IAUD,oGAAoG;IACpG,SAAS,CAAC,aAAa,CAAC,IAAI,EAAE;QAAE,IAAI,EAAE,OAAO,CAAA;KAAE,GAAG,WAAW,CAAC,MAAM,CAAC,GAAG,SAAS;IAUlE,IAAI,CAAC,IAAI,EAAE,wBAAwB,EAAE,MAAM,CAAC,EAAE,cAAc;CA6E5E;AAED,MAAM,WAAW,+BAA+B;IAC9C,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,WAAW,GAAG;QAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,mGAAmG;QACnG,WAAW,CAAC,EAAE,mBAAmB,CAAC;KACnC,CAAC;CACH;AAED,qBAAa,uBAAwB,SAAQ,kBAAkB,CAAC,YAAY,CAAC;gBAC/D,IAAI,EAAE,+BAA+B;CAsBlD"}
@@ -1,15 +1,34 @@
1
1
  import { redactSecrets } from '../../../../common/redact.js';
2
2
  import { HTTP } from '../../../../common/constants/http.js';
3
- import { QueryStringSeparators, toQueryString } from '../../utilities/query-string.js';
3
+ import { QueryStringSeparators, toQueryString, } from '../../utilities/query-string.js';
4
4
  import { BaseNetworkRequest } from '../base-network-request.helper.js';
5
- import { AbstractNetworkFetchableHelper } from './base-fetcher.js';
5
+ import { AbstractNetworkFetchableHelper, } from './base-fetcher.js';
6
+ /** What `fetch` takes as a body as it is: encoding any of these again would change the bytes sent. A constructor is looked up on `globalThis` so a runtime without one (no `FormData`) just never matches it. */
7
+ const isRawBody = (body) => {
8
+ if (typeof body === 'string' || ArrayBuffer.isView(body) || body instanceof ArrayBuffer) {
9
+ return true;
10
+ }
11
+ return ['Blob', 'FormData', 'URLSearchParams', 'ReadableStream'].some((name) => {
12
+ const ctor = Reflect.get(globalThis, name);
13
+ return typeof ctor === 'function' && body instanceof ctor;
14
+ });
15
+ };
6
16
  export class NodeFetcher extends AbstractNetworkFetchableHelper {
7
17
  constructor(opts) {
8
- super({ name: opts.name, variant: 'node-fetch' });
18
+ super({ name: opts.name, variant: 'node-fetch', worker: fetch });
9
19
  const { name, defaultConfigs } = opts;
10
20
  this.name = name;
11
21
  opts?.logger?.info('Creating new network request worker instance! Name: %s', this.name);
12
22
  this.defaultConfigs = defaultConfigs;
23
+ this.queryString = opts.queryString ?? {};
24
+ }
25
+ /** A raw body passes through; a plain object or an array is JSON-encoded; no body stays no body. */
26
+ serializeBody(opts) {
27
+ const { body } = opts;
28
+ if (body === undefined || body === null) {
29
+ return undefined;
30
+ }
31
+ return isRawBody(body) ? body : JSON.stringify(body);
13
32
  }
14
33
  async send(opts, logger) {
15
34
  const { url, method = HTTP.Methods.GET, params, body, headers, timeout, signal, ...rest } = opts;
@@ -30,12 +49,13 @@ export class NodeFetcher extends AbstractNetworkFetchableHelper {
30
49
  ...this.defaultConfigs,
31
50
  ...rest,
32
51
  method: method.toUpperCase(),
33
- body,
34
- headers,
52
+ body: this.serializeBody({ body }),
53
+ // The call's headers REPLACE the defaults (a caller that sends a multipart body leaves the content type out so `fetch` can write the boundary); a call with none keeps them. Spreading an absent `headers` over the config used to erase the defaults.
54
+ headers: headers ?? this.defaultConfigs.headers,
35
55
  signal: effectiveSignal,
36
56
  };
37
57
  // `?` only when the url carries no query string of its own - a second `?` is not a separator, so the server would read the previous parameter's value as `1?extra=2`.
38
- const serializedParams = params ? toQueryString({ params }) : '';
58
+ const serializedParams = params ? toQueryString({ params, ...this.queryString }) : '';
39
59
  const requestUrl = serializedParams
40
60
  ? `${url}${url.includes(QueryStringSeparators.START) ? QueryStringSeparators.PAIR : QueryStringSeparators.START}${serializedParams}`
41
61
  : url;
@@ -45,12 +65,15 @@ export class NodeFetcher extends AbstractNetworkFetchableHelper {
45
65
  // because the `string[][]` form is a list of tuples, which key matching cannot see either.
46
66
  const loggableConfigs = {
47
67
  ...requestConfigs,
48
- body: typeof body === 'string' ? `[body ${body.length} chars]` : body ? '[body]' : undefined,
49
- headers: headers ? Object.fromEntries(new Headers(headers)) : undefined,
68
+ body: typeof requestConfigs.body === 'string'
69
+ ? `[body ${requestConfigs.body.length} chars]`
70
+ : requestConfigs.body
71
+ ? '[body]'
72
+ : undefined,
73
+ headers: requestConfigs.headers,
50
74
  };
51
- logger
52
- ?.for(this.send.name)
53
- .info('URL: %s | Props: %s | Timeout: %s', url, redactSecrets(loggableConfigs), timeout);
75
+ // Straight on the logger it was handed, never `logger.for(...)`: a host logger may carry only `debug` and `info`. With none handed, nothing is logged - no default logger is built, so a browser never reaches the node-only provider.
76
+ logger?.debug('[%s] URL: %s | Props: %s | Timeout: %s', this.send.name, url, redactSecrets(loggableConfigs), timeout);
54
77
  try {
55
78
  const rs = await fetch(requestUrl, requestConfigs);
56
79
  return rs;
@@ -65,7 +88,7 @@ export class NodeFetcher extends AbstractNetworkFetchableHelper {
65
88
  export class NodeFetchNetworkRequest extends BaseNetworkRequest {
66
89
  constructor(opts) {
67
90
  const { name, networkOptions } = opts;
68
- const { headers, baseUrl, ...rest } = networkOptions;
91
+ const { headers, baseUrl, queryString, ...rest } = networkOptions;
69
92
  const userHeaders = headers instanceof Headers ? Object.fromEntries(headers.entries()) : headers;
70
93
  const mergedHeaders = {
71
94
  ['content-type']: 'application/json; charset=utf-8',
@@ -78,7 +101,7 @@ export class NodeFetchNetworkRequest extends BaseNetworkRequest {
78
101
  super({
79
102
  name,
80
103
  baseUrl,
81
- fetcher: new NodeFetcher({ name, defaultConfigs }),
104
+ fetcher: new NodeFetcher({ name, defaultConfigs, queryString }),
82
105
  });
83
106
  }
84
107
  }
@@ -1 +1 @@
1
- {"version":3,"file":"node-fetcher.js","sourceRoot":"","sources":["../../../../../../src/modules/network/http-request/fetcher/node-fetcher.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,IAAI,EAAoB,MAAM,yBAAyB,CAAC;AAEjE,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAEpF,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAEpE,OAAO,EAAE,8BAA8B,EAAwB,MAAM,gBAAgB,CAAC;AAQtF,MAAM,OAAO,WAAY,SAAQ,8BAKhC;IAGC,YAAY,IAAqE;QAC/E,KAAK,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC;QAClD,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC;QACtC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,wDAAwD,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAExF,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;IACvC,CAAC;IAEQ,KAAK,CAAC,IAAI,CAAC,IAA8B,EAAE,MAAgB;QAClE,MAAM,EACJ,GAAG,EACH,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EACzB,MAAM,EACN,IAAI,EACJ,OAAO,EACP,OAAO,EACP,MAAM,EACN,GAAG,IAAI,EACR,GAAG,IAAI,CAAC;QAET,IAAI,SAAqC,CAAC;QAC1C,IAAI,iBAA8C,CAAC;QACnD,IAAI,eAAe,GAAG,MAAM,CAAC;QAE7B,IAAI,OAAO,EAAE,CAAC;YACZ,iBAAiB,GAAG,IAAI,eAAe,EAAE,CAAC;YAC1C,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC1B,iBAAiB,EAAE,KAAK,EAAE,CAAC;YAC7B,CAAC,EAAE,OAAO,CAAC,CAAC;YAEZ,iQAAiQ;YACjQ,eAAe,GAAG,MAAM;gBACtB,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,iBAAiB,CAAC,MAAM,CAAC,CAAC;gBACrD,CAAC,CAAC,iBAAiB,CAAC,MAAM,CAAC;QAC/B,CAAC;QAED,MAAM,cAAc,GAAgB;YAClC,GAAG,IAAI,CAAC,cAAc;YACtB,GAAG,IAAI;YACP,MAAM,EAAE,MAAM,CAAC,WAAW,EAAE;YAC5B,IAAI;YACJ,OAAO;YACP,MAAM,EAAE,eAAe;SACxB,CAAC;QAEF,sKAAsK;QACtK,MAAM,gBAAgB,GAAG,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACjE,MAAM,UAAU,GAAG,gBAAgB;YACjC,CAAC,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,QAAQ,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAAC,qBAAqB,CAAC,KAAK,GAAG,gBAAgB,EAAE;YACpI,CAAC,CAAC,GAAG,CAAC;QAER,iGAAiG;QACjG,gGAAgG;QAChG,iGAAiG;QACjG,2FAA2F;QAC3F,MAAM,eAAe,GAAG;YACtB,GAAG,cAAc;YACjB,IAAI,EAAE,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,IAAI,CAAC,MAAM,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS;YAC5F,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;SACxE,CAAC;QAEF,MAAM;YACJ,EAAE,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;aACpB,IAAI,CAAC,mCAAmC,EAAE,GAAG,EAAE,aAAa,CAAC,eAAe,CAAC,EAAE,OAAO,CAAC,CAAC;QAE3F,IAAI,CAAC;YACH,MAAM,EAAE,GAAG,MAAM,KAAK,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;YACnD,OAAO,EAAE,CAAC;QACZ,CAAC;gBAAS,CAAC;YACT,IAAI,SAAS,EAAE,CAAC;gBACd,YAAY,CAAC,SAAS,CAAC,CAAC;YAC1B,CAAC;QACH,CAAC;IACH,CAAC;CACF;AASD,MAAM,OAAO,uBAAwB,SAAQ,kBAAgC;IAC3E,YAAY,IAAqC;QAC/C,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC;QACtC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,cAAc,CAAC;QAErD,MAAM,WAAW,GACf,OAAO,YAAY,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;QAC/E,MAAM,aAAa,GAAc;YAC/B,CAAC,cAAc,CAAC,EAAE,iCAAiC;YACnD,GAAG,WAAW;SACf,CAAC;QAEF,MAAM,cAAc,GAAyB;YAC3C,GAAG,IAAI;YACP,OAAO,EAAE,aAAa;SACvB,CAAC;QAEF,KAAK,CAAC;YACJ,IAAI;YACJ,OAAO;YACP,OAAO,EAAE,IAAI,WAAW,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC;SACnD,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["import { redactSecrets } from '@/common/redact';\nimport { HTTP, type THttpMethod } from '@/common/constants/http';\nimport { type AnyObject } from '@/common/types';\nimport { QueryStringSeparators, toQueryString } from '../../utilities/query-string';\n\nimport { BaseNetworkRequest } from '../base-network-request.helper';\nimport type { ILogger } from '@/modules/logger/common/types';\nimport { AbstractNetworkFetchableHelper, type IRequestOptions } from './base-fetcher';\n\nexport interface INodeFetchRequestOptions extends RequestInit, IRequestOptions {\n url: string;\n method?: THttpMethod;\n params?: AnyObject;\n}\n\nexport class NodeFetcher extends AbstractNetworkFetchableHelper<\n 'node-fetch',\n INodeFetchRequestOptions,\n Awaited<ReturnType<typeof fetch>>,\n typeof fetch\n> {\n private defaultConfigs: RequestInit;\n\n constructor(opts: { name: string; defaultConfigs: RequestInit; logger?: ILogger }) {\n super({ name: opts.name, variant: 'node-fetch' });\n const { name, defaultConfigs } = opts;\n this.name = name;\n opts?.logger?.info('Creating new network request worker instance! Name: %s', this.name);\n\n this.defaultConfigs = defaultConfigs;\n }\n\n override async send(opts: INodeFetchRequestOptions, logger?: ILogger) {\n const {\n url,\n method = HTTP.Methods.GET,\n params,\n body,\n headers,\n timeout,\n signal,\n ...rest\n } = opts;\n\n let timeoutId: NodeJS.Timeout | undefined;\n let timeoutController: AbortController | undefined;\n let effectiveSignal = signal;\n\n if (timeout) {\n timeoutController = new AbortController();\n timeoutId = setTimeout(() => {\n timeoutController?.abort();\n }, timeout);\n\n // Composed, never substituted: a timeout must not silently swallow the caller's own signal, or the caller would believe it cancelled a request that is in fact still running. Either source - and a signal already aborted before the call - aborts the request.\n effectiveSignal = signal\n ? AbortSignal.any([signal, timeoutController.signal])\n : timeoutController.signal;\n }\n\n const requestConfigs: RequestInit = {\n ...this.defaultConfigs,\n ...rest,\n method: method.toUpperCase(),\n body,\n headers,\n signal: effectiveSignal,\n };\n\n // `?` only when the url carries no query string of its own - a second `?` is not a separator, so the server would read the previous parameter's value as `1?extra=2`.\n const serializedParams = params ? toQueryString({ params }) : '';\n const requestUrl = serializedParams\n ? `${url}${url.includes(QueryStringSeparators.START) ? QueryStringSeparators.PAIR : QueryStringSeparators.START}${serializedParams}`\n : url;\n\n // The body is NEVER logged, only its size. `fetch` bodies are strings, and `redactSecrets` walks\n // object keys - so a JSON credential payload passed straight through as a string was printed in\n // full, with no key for the redactor to match on. Headers are normalised through `Headers` first\n // because the `string[][]` form is a list of tuples, which key matching cannot see either.\n const loggableConfigs = {\n ...requestConfigs,\n body: typeof body === 'string' ? `[body ${body.length} chars]` : body ? '[body]' : undefined,\n headers: headers ? Object.fromEntries(new Headers(headers)) : undefined,\n };\n\n logger\n ?.for(this.send.name)\n .info('URL: %s | Props: %s | Timeout: %s', url, redactSecrets(loggableConfigs), timeout);\n\n try {\n const rs = await fetch(requestUrl, requestConfigs);\n return rs;\n } finally {\n if (timeoutId) {\n clearTimeout(timeoutId);\n }\n }\n }\n}\n\nexport interface INodeFetchNetworkRequestOptions {\n name: string;\n networkOptions: RequestInit & {\n baseUrl?: string;\n };\n}\n\nexport class NodeFetchNetworkRequest extends BaseNetworkRequest<'node-fetch'> {\n constructor(opts: INodeFetchNetworkRequestOptions) {\n const { name, networkOptions } = opts;\n const { headers, baseUrl, ...rest } = networkOptions;\n\n const userHeaders =\n headers instanceof Headers ? Object.fromEntries(headers.entries()) : headers;\n const mergedHeaders: AnyObject = {\n ['content-type']: 'application/json; charset=utf-8',\n ...userHeaders,\n };\n\n const defaultConfigs: Partial<RequestInit> = {\n ...rest,\n headers: mergedHeaders,\n };\n\n super({\n name,\n baseUrl,\n fetcher: new NodeFetcher({ name, defaultConfigs }),\n });\n }\n}\n"]}
1
+ {"version":3,"file":"node-fetcher.js","sourceRoot":"","sources":["../../../../../../src/modules/network/http-request/fetcher/node-fetcher.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,IAAI,EAAoB,MAAM,yBAAyB,CAAC;AAEjE,OAAO,EAEL,qBAAqB,EACrB,aAAa,GACd,MAAM,8BAA8B,CAAC;AAEtC,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EACL,8BAA8B,GAG/B,MAAM,gBAAgB,CAAC;AAQxB,iNAAiN;AACjN,MAAM,SAAS,GAAG,CAAC,IAAa,EAAW,EAAE;IAC3C,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,IAAI,YAAY,WAAW,EAAE,CAAC;QACxF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,CAAC,MAAM,EAAE,UAAU,EAAE,iBAAiB,EAAE,gBAAgB,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;QAC7E,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QAC3C,OAAO,OAAO,IAAI,KAAK,UAAU,IAAI,IAAI,YAAY,IAAI,CAAC;IAC5D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,OAAO,WAAY,SAAQ,8BAKhC;IAIC,YAAY,IAMX;QACC,KAAK,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;QACjE,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC;QACtC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,wDAAwD,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAExF,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC;IAC5C,CAAC;IAED,oGAAoG;IAC1F,aAAa,CAAC,IAAuB;QAC7C,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;QAEtB,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YACxC,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAE,IAA4B,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAChF,CAAC;IAEQ,KAAK,CAAC,IAAI,CAAC,IAA8B,EAAE,MAAuB;QACzE,MAAM,EACJ,GAAG,EACH,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EACzB,MAAM,EACN,IAAI,EACJ,OAAO,EACP,OAAO,EACP,MAAM,EACN,GAAG,IAAI,EACR,GAAG,IAAI,CAAC;QAET,IAAI,SAAoD,CAAC;QACzD,IAAI,iBAA8C,CAAC;QACnD,IAAI,eAAe,GAAG,MAAM,CAAC;QAE7B,IAAI,OAAO,EAAE,CAAC;YACZ,iBAAiB,GAAG,IAAI,eAAe,EAAE,CAAC;YAC1C,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC1B,iBAAiB,EAAE,KAAK,EAAE,CAAC;YAC7B,CAAC,EAAE,OAAO,CAAC,CAAC;YAEZ,iQAAiQ;YACjQ,eAAe,GAAG,MAAM;gBACtB,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,iBAAiB,CAAC,MAAM,CAAC,CAAC;gBACrD,CAAC,CAAC,iBAAiB,CAAC,MAAM,CAAC;QAC/B,CAAC;QAED,MAAM,cAAc,GAAgB;YAClC,GAAG,IAAI,CAAC,cAAc;YACtB,GAAG,IAAI;YACP,MAAM,EAAE,MAAM,CAAC,WAAW,EAAE;YAC5B,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,CAAC;YAClC,uPAAuP;YACvP,OAAO,EAAE,OAAO,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO;YAC/C,MAAM,EAAE,eAAe;SACxB,CAAC;QAEF,sKAAsK;QACtK,MAAM,gBAAgB,GAAG,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACtF,MAAM,UAAU,GAAG,gBAAgB;YACjC,CAAC,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,QAAQ,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAAC,qBAAqB,CAAC,KAAK,GAAG,gBAAgB,EAAE;YACpI,CAAC,CAAC,GAAG,CAAC;QAER,iGAAiG;QACjG,gGAAgG;QAChG,iGAAiG;QACjG,2FAA2F;QAC3F,MAAM,eAAe,GAAG;YACtB,GAAG,cAAc;YACjB,IAAI,EACF,OAAO,cAAc,CAAC,IAAI,KAAK,QAAQ;gBACrC,CAAC,CAAC,SAAS,cAAc,CAAC,IAAI,CAAC,MAAM,SAAS;gBAC9C,CAAC,CAAC,cAAc,CAAC,IAAI;oBACnB,CAAC,CAAC,QAAQ;oBACV,CAAC,CAAC,SAAS;YACjB,OAAO,EAAE,cAAc,CAAC,OAAO;SAChC,CAAC;QAEF,uOAAuO;QACvO,MAAM,EAAE,KAAK,CACX,wCAAwC,EACxC,IAAI,CAAC,IAAI,CAAC,IAAI,EACd,GAAG,EACH,aAAa,CAAC,eAAe,CAAC,EAC9B,OAAO,CACR,CAAC;QAEF,IAAI,CAAC;YACH,MAAM,EAAE,GAAG,MAAM,KAAK,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;YACnD,OAAO,EAAE,CAAC;QACZ,CAAC;gBAAS,CAAC;YACT,IAAI,SAAS,EAAE,CAAC;gBACd,YAAY,CAAC,SAAS,CAAC,CAAC;YAC1B,CAAC;QACH,CAAC;IACH,CAAC;CACF;AAWD,MAAM,OAAO,uBAAwB,SAAQ,kBAAgC;IAC3E,YAAY,IAAqC;QAC/C,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC;QACtC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,cAAc,CAAC;QAElE,MAAM,WAAW,GACf,OAAO,YAAY,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;QAC/E,MAAM,aAAa,GAAc;YAC/B,CAAC,cAAc,CAAC,EAAE,iCAAiC;YACnD,GAAG,WAAW;SACf,CAAC;QAEF,MAAM,cAAc,GAAyB;YAC3C,GAAG,IAAI;YACP,OAAO,EAAE,aAAa;SACvB,CAAC;QAEF,KAAK,CAAC;YACJ,IAAI;YACJ,OAAO;YACP,OAAO,EAAE,IAAI,WAAW,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,WAAW,EAAE,CAAC;SAChE,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["import { redactSecrets } from '@/common/redact';\nimport { HTTP, type THttpMethod } from '@/common/constants/http';\nimport { type AnyObject } from '@/common/types';\nimport {\n type IQueryStringOptions,\n QueryStringSeparators,\n toQueryString,\n} from '../../utilities/query-string';\n\nimport { BaseNetworkRequest } from '../base-network-request.helper';\nimport {\n AbstractNetworkFetchableHelper,\n type IRequestOptions,\n type TFetcherLogger,\n} from './base-fetcher';\n\nexport interface INodeFetchRequestOptions extends RequestInit, IRequestOptions {\n url: string;\n method?: THttpMethod;\n params?: AnyObject;\n}\n\n/** What `fetch` takes as a body as it is: encoding any of these again would change the bytes sent. A constructor is looked up on `globalThis` so a runtime without one (no `FormData`) just never matches it. */\nconst isRawBody = (body: unknown): boolean => {\n if (typeof body === 'string' || ArrayBuffer.isView(body) || body instanceof ArrayBuffer) {\n return true;\n }\n\n return ['Blob', 'FormData', 'URLSearchParams', 'ReadableStream'].some((name) => {\n const ctor = Reflect.get(globalThis, name);\n return typeof ctor === 'function' && body instanceof ctor;\n });\n};\n\nexport class NodeFetcher extends AbstractNetworkFetchableHelper<\n 'node-fetch',\n INodeFetchRequestOptions,\n Awaited<ReturnType<typeof fetch>>,\n typeof fetch\n> {\n private defaultConfigs: RequestInit;\n private queryString: IQueryStringOptions;\n\n constructor(opts: {\n name: string;\n defaultConfigs: RequestInit;\n /** How `params` are written into the url; the defaults are `node:querystring`'s. */\n queryString?: IQueryStringOptions;\n logger?: TFetcherLogger;\n }) {\n super({ name: opts.name, variant: 'node-fetch', worker: fetch });\n const { name, defaultConfigs } = opts;\n this.name = name;\n opts?.logger?.info('Creating new network request worker instance! Name: %s', this.name);\n\n this.defaultConfigs = defaultConfigs;\n this.queryString = opts.queryString ?? {};\n }\n\n /** A raw body passes through; a plain object or an array is JSON-encoded; no body stays no body. */\n protected serializeBody(opts: { body: unknown }): RequestInit['body'] | undefined {\n const { body } = opts;\n\n if (body === undefined || body === null) {\n return undefined;\n }\n\n return isRawBody(body) ? (body as RequestInit['body']) : JSON.stringify(body);\n }\n\n override async send(opts: INodeFetchRequestOptions, logger?: TFetcherLogger) {\n const {\n url,\n method = HTTP.Methods.GET,\n params,\n body,\n headers,\n timeout,\n signal,\n ...rest\n } = opts;\n\n let timeoutId: ReturnType<typeof setTimeout> | undefined;\n let timeoutController: AbortController | undefined;\n let effectiveSignal = signal;\n\n if (timeout) {\n timeoutController = new AbortController();\n timeoutId = setTimeout(() => {\n timeoutController?.abort();\n }, timeout);\n\n // Composed, never substituted: a timeout must not silently swallow the caller's own signal, or the caller would believe it cancelled a request that is in fact still running. Either source - and a signal already aborted before the call - aborts the request.\n effectiveSignal = signal\n ? AbortSignal.any([signal, timeoutController.signal])\n : timeoutController.signal;\n }\n\n const requestConfigs: RequestInit = {\n ...this.defaultConfigs,\n ...rest,\n method: method.toUpperCase(),\n body: this.serializeBody({ body }),\n // The call's headers REPLACE the defaults (a caller that sends a multipart body leaves the content type out so `fetch` can write the boundary); a call with none keeps them. Spreading an absent `headers` over the config used to erase the defaults.\n headers: headers ?? this.defaultConfigs.headers,\n signal: effectiveSignal,\n };\n\n // `?` only when the url carries no query string of its own - a second `?` is not a separator, so the server would read the previous parameter's value as `1?extra=2`.\n const serializedParams = params ? toQueryString({ params, ...this.queryString }) : '';\n const requestUrl = serializedParams\n ? `${url}${url.includes(QueryStringSeparators.START) ? QueryStringSeparators.PAIR : QueryStringSeparators.START}${serializedParams}`\n : url;\n\n // The body is NEVER logged, only its size. `fetch` bodies are strings, and `redactSecrets` walks\n // object keys - so a JSON credential payload passed straight through as a string was printed in\n // full, with no key for the redactor to match on. Headers are normalised through `Headers` first\n // because the `string[][]` form is a list of tuples, which key matching cannot see either.\n const loggableConfigs = {\n ...requestConfigs,\n body:\n typeof requestConfigs.body === 'string'\n ? `[body ${requestConfigs.body.length} chars]`\n : requestConfigs.body\n ? '[body]'\n : undefined,\n headers: requestConfigs.headers,\n };\n\n // Straight on the logger it was handed, never `logger.for(...)`: a host logger may carry only `debug` and `info`. With none handed, nothing is logged - no default logger is built, so a browser never reaches the node-only provider.\n logger?.debug(\n '[%s] URL: %s | Props: %s | Timeout: %s',\n this.send.name,\n url,\n redactSecrets(loggableConfigs),\n timeout,\n );\n\n try {\n const rs = await fetch(requestUrl, requestConfigs);\n return rs;\n } finally {\n if (timeoutId) {\n clearTimeout(timeoutId);\n }\n }\n }\n}\n\nexport interface INodeFetchNetworkRequestOptions {\n name: string;\n networkOptions: RequestInit & {\n baseUrl?: string;\n /** How `params` are written into every url this request sends; see {@link IQueryStringOptions}. */\n queryString?: IQueryStringOptions;\n };\n}\n\nexport class NodeFetchNetworkRequest extends BaseNetworkRequest<'node-fetch'> {\n constructor(opts: INodeFetchNetworkRequestOptions) {\n const { name, networkOptions } = opts;\n const { headers, baseUrl, queryString, ...rest } = networkOptions;\n\n const userHeaders =\n headers instanceof Headers ? Object.fromEntries(headers.entries()) : headers;\n const mergedHeaders: AnyObject = {\n ['content-type']: 'application/json; charset=utf-8',\n ...userHeaders,\n };\n\n const defaultConfigs: Partial<RequestInit> = {\n ...rest,\n headers: mergedHeaders,\n };\n\n super({\n name,\n baseUrl,\n fetcher: new NodeFetcher({ name, defaultConfigs, queryString }),\n });\n }\n}\n"]}
@@ -105,7 +105,7 @@ export class BaseNetworkTcpClient extends BaseHelper {
105
105
  client.on('close', () => {
106
106
  this.onClosed?.({ client });
107
107
  });
108
- client.on('error', error => {
108
+ client.on('error', (error) => {
109
109
  this.onError?.(error);
110
110
  });
111
111
  }
@@ -1 +1 @@
1
- {"version":3,"file":"base-tcp-client.helper.js","sourceRoot":"","sources":["../../../../../src/modules/network/tcp-socket/base-tcp-client.helper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAW5C,MAAM,iBAAiB,GAAG,CAAC,CAAC;AAyB5B,MAAM,OAAO,oBAGX,SAAQ,UAAU;IAsBlB,YAAY,IAAmE;QAC7E,KAAK,CAAC;YACJ,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,UAAU,IAAI,oBAAoB,CAAC,IAAI;YACjE,UAAU,EAAE,IAAI,CAAC,UAAU;SAC5B,CAAC,CAAC;QArBK,UAAK,GAAuD;YACpE,YAAY,EAAE,iBAAiB;YAC/B,gBAAgB,EAAE,CAAC;SACpB,CAAC;QAmBA,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAE5B,IAAI,CAAC,KAAK,GAAG;YACX,YAAY,EAAE,IAAI,CAAC,QAAQ,IAAI,iBAAiB;YAChD,gBAAgB,EAAE,CAAC;SACpB,CAAC;QAEF,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAE1C,IAAI,CAAC,WAAW,GAAG,IAAI,EAAE,WAAW,IAAI,IAAI,CAAC,eAAe,CAAC;QAC7D,IAAI,CAAC,MAAM,GAAG,IAAI,EAAE,MAAM,IAAI,IAAI,CAAC,UAAU,CAAC;QAC9C,IAAI,CAAC,QAAQ,GAAG,IAAI,EAAE,QAAQ,IAAI,IAAI,CAAC,YAAY,CAAC;QACpD,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,OAAO,IAAI,IAAI,CAAC,WAAW,CAAC;QACjD,IAAI,CAAC,SAAS,GAAG,IAAI,EAAE,SAAS,IAAI,KAAK,CAAC;QAC1C,IAAI,CAAC,QAAQ,GAAG,IAAI,EAAE,QAAQ,CAAC;IACjC,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,uGAAuG;IAC7F,kBAAkB;QAC1B,OAAO,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC;IAED,eAAe;QACb,IAAI,CAAC,MAAM;aACR,GAAG,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC;aAC9B,IAAI,CACH,4CAA4C,EAC5C,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,kBAAkB,EAAE,CAC1B,CAAC;QACJ,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,CAAC,CAAC;IAClC,CAAC;IAED,UAAU,CAAC,KAAuD,IAAG,CAAC;IAEtE,YAAY;QACV,IAAI,CAAC,MAAM;aACR,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;aAC3B,IAAI,CACH,iDAAiD,EACjD,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,kBAAkB,EAAE,CAC1B,CAAC;IACN,CAAC;IAED,WAAW,CAAC,KAAU;QACpB,IAAI,CAAC,MAAM;aACR,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;aAC1B,KAAK,CACJ,iDAAiD,EACjD,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,kBAAkB,EAAE,EACzB,KAAK,CACN,CAAC;QAEJ,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,KAAK,CAAC,gBAAgB,IAAI,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;YAC9E,OAAO;QACT,CAAC;QAED,MAAM,EAAE,gBAAgB,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACtD,IAAI,YAAY,GAAG,CAAC,CAAC,IAAI,gBAAgB,IAAI,YAAY,EAAE,CAAC;YAC1D,IAAI,CAAC,MAAM;iBACR,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;iBACzB,IAAI,CACH,wDAAwD,EACxD,YAAY,EACZ,gBAAgB,CACjB,CAAC;YACJ,OAAO;QACT,CAAC;QAED,IAAI,CAAC,gBAAgB,GAAG,UAAU,CAAC,GAAG,EAAE;YACtC,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC;YACvB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;YAEnB,IAAI,CAAC,MAAM;iBACR,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;iBAC3B,IAAI,CACH,yDAAyD,EACzD,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,kBAAkB,EAAE,CAC1B,CAAC;YAEJ,IAAI,CAAC,OAAO,CAAC,EAAE,qBAAqB,EAAE,KAAK,EAAE,CAAC,CAAC;YAC/C,IAAI,CAAC,KAAK,CAAC,gBAAgB,EAAE,CAAC;QAChC,CAAC,EAAE,IAAI,CAAC,CAAC;IACX,CAAC;IAED,OAAO,CAAC,IAAwC;QAC9C,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACvB,IAAI,CAAC,MAAM;iBACR,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;iBACtB,IAAI,CAAC,+CAA+C,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YAC1E,OAAO;QACT,CAAC;QAED,IAAI,OAAO,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC;YACrC,IAAI,CAAC,MAAM;iBACR,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;iBACtB,IAAI,CAAC,+CAA+C,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YAC1E,OAAO;QACT,CAAC;QAED,IAAI,CAAC,MAAM;aACR,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;aACtB,IAAI,CACH,2CAA2C,EAC3C,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,kBAAkB,EAAE,CAC1B,CAAC;QAEJ,IAAI,IAAI,EAAE,qBAAqB,EAAE,CAAC;YAChC,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,CAAC,CAAC;QAClC,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACtD,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC;YACvB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACrB,CAAC;QAED,wLAAwL;QACxL,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE;YACpD,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAErB,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpC,CAAC;QAED,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,OAAwB,EAAE,EAAE;YAC7C,IAAI,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,OAAO,EAAE,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YACtB,IAAI,CAAC,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE;YACzB,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC;QACxB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,UAAU;QACR,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,IAAI,CAAC,MAAM;iBACR,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;iBACzB,IAAI,CAAC,+CAA+C,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YAC1E,OAAO;QACT,CAAC;QAED,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QAEnB,YAAY,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACpC,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAC7B,IAAI,CAAC,MAAM;aACR,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;aACzB,IAAI,CAAC,qCAAqC,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IAClE,CAAC;IAED,cAAc;QACZ,IAAI,CAAC,UAAU,EAAE,CAAC;QAClB,IAAI,CAAC,OAAO,CAAC,EAAE,qBAAqB,EAAE,IAAI,EAAE,CAAC,CAAC;IAChD,CAAC;IAED,WAAW;QACT,OAAO,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,KAAK,QAAQ,CAAC;IAC5D,CAAC;IAED,IAAI,CAAC,IAAkC;QACrC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,IAAI,CAAC,MAAM;iBACR,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;iBACnB,IAAI,CAAC,wCAAwC,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YACnE,OAAO;QACT,CAAC;QAED,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QACzB,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;YACrB,IAAI,CAAC,MAAM;iBACR,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;iBACnB,IAAI,CAAC,8CAA8C,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YACzE,OAAO;QACT,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC7B,CAAC;CACF","sourcesContent":["import { isEmpty } from '@venizia/ignis-inversion';\nimport { redactSecrets } from '@/common/redact';\nimport { BaseHelper } from '@/modules/base';\nimport { type ValueOrPromise } from '@/common';\nimport {\n type TcpSocketConnectOpts as PlainConnectionOptions,\n type Socket as PlainSocketClient,\n} from 'node:net';\nimport {\n type ConnectionOptions as TlsConnectionOptions,\n type TLSSocket as TlsSocketClient,\n} from 'node:tls';\n\nconst DEFAULT_MAX_RETRY = 5;\n\nexport interface INetworkTcpClientProps<\n SocketClientOptions extends PlainConnectionOptions | TlsConnectionOptions,\n SocketClientType extends PlainSocketClient | TlsSocketClient,\n> {\n identifier: string;\n scope?: string;\n\n options: SocketClientOptions;\n reconnect?: boolean;\n maxRetry?: number;\n encoding?: BufferEncoding;\n\n createClientFn: (\n options: SocketClientOptions,\n connectionListener?: () => void,\n ) => SocketClientType;\n\n onConnected?: (opts: { client: SocketClientType }) => ValueOrPromise<void>;\n onData?: (opts: { identifier: string; message: string | Buffer }) => ValueOrPromise<void>;\n onClosed?: (opts: { client: SocketClientType }) => void;\n onError?: (error: any) => void;\n}\n\nexport class BaseNetworkTcpClient<\n SocketClientOptions extends PlainConnectionOptions | TlsConnectionOptions,\n SocketClientType extends PlainSocketClient | TlsSocketClient,\n> extends BaseHelper {\n protected client?: SocketClientType | null;\n\n protected options: SocketClientOptions;\n protected reconnect?: boolean;\n protected retry: { maxReconnect: number; currentReconnect: number } = {\n maxReconnect: DEFAULT_MAX_RETRY,\n currentReconnect: 0,\n };\n protected reconnectTimeout: any;\n protected encoding?: BufferEncoding;\n\n protected createClientFn: (\n options: SocketClientOptions,\n connectionListener?: () => void,\n ) => SocketClientType;\n\n protected onConnected: (opts: { client: SocketClientType }) => void;\n protected onData: (opts: { identifier: string; message: string | Buffer }) => void;\n protected onClosed?: (opts: { client: SocketClientType }) => void;\n protected onError?: (error: any) => void;\n\n constructor(opts: INetworkTcpClientProps<SocketClientOptions, SocketClientType>) {\n super({\n scope: opts.scope ?? opts.identifier ?? BaseNetworkTcpClient.name,\n identifier: opts.identifier,\n });\n this.options = opts.options;\n\n this.retry = {\n maxReconnect: opts.maxRetry ?? DEFAULT_MAX_RETRY,\n currentReconnect: 0,\n };\n\n this.createClientFn = opts.createClientFn;\n\n this.onConnected = opts?.onConnected ?? this.handleConnected;\n this.onData = opts?.onData ?? this.handleData;\n this.onClosed = opts?.onClosed ?? this.handleClosed;\n this.onError = opts?.onError ?? this.handleError;\n this.reconnect = opts?.reconnect ?? false;\n this.encoding = opts?.encoding;\n }\n\n getClient() {\n return this.client;\n }\n\n /** Redacts before logging - a TLS client's options ARE its private key (`key`/`cert`/`passphrase`). */\n protected getLoggableOptions(): unknown {\n return redactSecrets(this.options);\n }\n\n handleConnected() {\n this.logger\n .for(this.handleConnected.name)\n .info(\n '[%s] Connected to TCP Server | Options: %j',\n this.identifier,\n this.getLoggableOptions(),\n );\n this.retry.currentReconnect = 0;\n }\n\n handleData(_opts: { identifier: string; message: string | Buffer }) {}\n\n handleClosed() {\n this.logger\n .for(this.handleClosed.name)\n .info(\n '[%s] Closed connection TCP Server | Options: %j',\n this.identifier,\n this.getLoggableOptions(),\n );\n }\n\n handleError(error: any) {\n this.logger\n .for(this.handleError.name)\n .error(\n '[%s] Connection error | Options: %j | Error: %s',\n this.identifier,\n this.getLoggableOptions(),\n error,\n );\n\n if (!this.reconnect || this.retry.currentReconnect >= this.retry.maxReconnect) {\n return;\n }\n\n const { currentReconnect, maxReconnect } = this.retry;\n if (maxReconnect > -1 && currentReconnect >= maxReconnect) {\n this.logger\n .for(this.handleData.name)\n .info(\n 'Exceeded max retry to reconnect! Max: %d | Current: %d',\n maxReconnect,\n currentReconnect,\n );\n return;\n }\n\n this.reconnectTimeout = setTimeout(() => {\n this.client?.destroy();\n this.client = null;\n\n this.logger\n .for(this.handleClosed.name)\n .info(\n '[%s] Retrying to establish TCP Connection | Options: %j',\n this.identifier,\n this.getLoggableOptions(),\n );\n\n this.connect({ resetReconnectCounter: false });\n this.retry.currentReconnect++;\n }, 5000);\n }\n\n connect(opts: { resetReconnectCounter: boolean }) {\n if (this.isConnected()) {\n this.logger\n .for(this.connect.name)\n .info('[%s] NetworkTcpClient is already initialized!', this.identifier);\n return;\n }\n\n if (isEmpty({ value: this.options })) {\n this.logger\n .for(this.connect.name)\n .info('[%s] Cannot init TCP Client with null options', this.identifier);\n return;\n }\n\n this.logger\n .for(this.connect.name)\n .info(\n '[%s] New network tcp client | Options: %j',\n this.identifier,\n this.getLoggableOptions(),\n );\n\n if (opts?.resetReconnectCounter) {\n this.retry.currentReconnect = 0;\n }\n\n if (this.client !== null && this.client !== undefined) {\n this.client?.destroy();\n this.client = null;\n }\n\n // The listeners close over THIS socket: `this.client` is nulled by disconnect() and swapped by a reconnect, so reading it back would drop the close hook - or hand it the wrong socket.\n const client = this.createClientFn(this.options, () => {\n this.onConnected?.({ client });\n });\n\n this.client = client;\n\n if (this.encoding) {\n client.setEncoding(this.encoding);\n }\n\n client.on('data', (message: string | Buffer) => {\n this.onData({ identifier: this.identifier, message });\n });\n\n client.on('close', () => {\n this.onClosed?.({ client });\n });\n\n client.on('error', error => {\n this.onError?.(error);\n });\n }\n\n disconnect() {\n if (!this.client) {\n this.logger\n .for(this.disconnect.name)\n .info('[%s] NetworkTcpClient is not initialized yet!', this.identifier);\n return;\n }\n\n this.client?.destroy();\n this.client = null;\n\n clearTimeout(this.reconnectTimeout);\n this.reconnectTimeout = null;\n this.logger\n .for(this.disconnect.name)\n .info('[%s] NetworkTcpClient is destroyed!', this.identifier);\n }\n\n forceReconnect() {\n this.disconnect();\n this.connect({ resetReconnectCounter: true });\n }\n\n isConnected() {\n return this.client && this.client.readyState !== 'closed';\n }\n\n emit(opts: { payload: Buffer | string }) {\n if (!this.client) {\n this.logger\n .for(this.emit.name)\n .info('[%s] TPC Client is not configured yet!', this.identifier);\n return;\n }\n\n const { payload } = opts;\n if (!payload?.length) {\n this.logger\n .for(this.emit.name)\n .info('[%s] Invalid payload to write to TCP Socket!', this.identifier);\n return;\n }\n\n this.client.write(payload);\n }\n}\n"]}
1
+ {"version":3,"file":"base-tcp-client.helper.js","sourceRoot":"","sources":["../../../../../src/modules/network/tcp-socket/base-tcp-client.helper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAW5C,MAAM,iBAAiB,GAAG,CAAC,CAAC;AAyB5B,MAAM,OAAO,oBAGX,SAAQ,UAAU;IAsBlB,YAAY,IAAmE;QAC7E,KAAK,CAAC;YACJ,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,UAAU,IAAI,oBAAoB,CAAC,IAAI;YACjE,UAAU,EAAE,IAAI,CAAC,UAAU;SAC5B,CAAC,CAAC;QArBK,UAAK,GAAuD;YACpE,YAAY,EAAE,iBAAiB;YAC/B,gBAAgB,EAAE,CAAC;SACpB,CAAC;QAmBA,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAE5B,IAAI,CAAC,KAAK,GAAG;YACX,YAAY,EAAE,IAAI,CAAC,QAAQ,IAAI,iBAAiB;YAChD,gBAAgB,EAAE,CAAC;SACpB,CAAC;QAEF,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAE1C,IAAI,CAAC,WAAW,GAAG,IAAI,EAAE,WAAW,IAAI,IAAI,CAAC,eAAe,CAAC;QAC7D,IAAI,CAAC,MAAM,GAAG,IAAI,EAAE,MAAM,IAAI,IAAI,CAAC,UAAU,CAAC;QAC9C,IAAI,CAAC,QAAQ,GAAG,IAAI,EAAE,QAAQ,IAAI,IAAI,CAAC,YAAY,CAAC;QACpD,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,OAAO,IAAI,IAAI,CAAC,WAAW,CAAC;QACjD,IAAI,CAAC,SAAS,GAAG,IAAI,EAAE,SAAS,IAAI,KAAK,CAAC;QAC1C,IAAI,CAAC,QAAQ,GAAG,IAAI,EAAE,QAAQ,CAAC;IACjC,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,uGAAuG;IAC7F,kBAAkB;QAC1B,OAAO,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC;IAED,eAAe;QACb,IAAI,CAAC,MAAM;aACR,GAAG,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC;aAC9B,IAAI,CACH,4CAA4C,EAC5C,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,kBAAkB,EAAE,CAC1B,CAAC;QACJ,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,CAAC,CAAC;IAClC,CAAC;IAED,UAAU,CAAC,KAAuD,IAAG,CAAC;IAEtE,YAAY;QACV,IAAI,CAAC,MAAM;aACR,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;aAC3B,IAAI,CACH,iDAAiD,EACjD,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,kBAAkB,EAAE,CAC1B,CAAC;IACN,CAAC;IAED,WAAW,CAAC,KAAU;QACpB,IAAI,CAAC,MAAM;aACR,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;aAC1B,KAAK,CACJ,iDAAiD,EACjD,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,kBAAkB,EAAE,EACzB,KAAK,CACN,CAAC;QAEJ,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,KAAK,CAAC,gBAAgB,IAAI,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;YAC9E,OAAO;QACT,CAAC;QAED,MAAM,EAAE,gBAAgB,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACtD,IAAI,YAAY,GAAG,CAAC,CAAC,IAAI,gBAAgB,IAAI,YAAY,EAAE,CAAC;YAC1D,IAAI,CAAC,MAAM;iBACR,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;iBACzB,IAAI,CACH,wDAAwD,EACxD,YAAY,EACZ,gBAAgB,CACjB,CAAC;YACJ,OAAO;QACT,CAAC;QAED,IAAI,CAAC,gBAAgB,GAAG,UAAU,CAAC,GAAG,EAAE;YACtC,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC;YACvB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;YAEnB,IAAI,CAAC,MAAM;iBACR,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;iBAC3B,IAAI,CACH,yDAAyD,EACzD,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,kBAAkB,EAAE,CAC1B,CAAC;YAEJ,IAAI,CAAC,OAAO,CAAC,EAAE,qBAAqB,EAAE,KAAK,EAAE,CAAC,CAAC;YAC/C,IAAI,CAAC,KAAK,CAAC,gBAAgB,EAAE,CAAC;QAChC,CAAC,EAAE,IAAI,CAAC,CAAC;IACX,CAAC;IAED,OAAO,CAAC,IAAwC;QAC9C,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACvB,IAAI,CAAC,MAAM;iBACR,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;iBACtB,IAAI,CAAC,+CAA+C,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YAC1E,OAAO;QACT,CAAC;QAED,IAAI,OAAO,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC;YACrC,IAAI,CAAC,MAAM;iBACR,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;iBACtB,IAAI,CAAC,+CAA+C,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YAC1E,OAAO;QACT,CAAC;QAED,IAAI,CAAC,MAAM;aACR,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;aACtB,IAAI,CACH,2CAA2C,EAC3C,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,kBAAkB,EAAE,CAC1B,CAAC;QAEJ,IAAI,IAAI,EAAE,qBAAqB,EAAE,CAAC;YAChC,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,CAAC,CAAC;QAClC,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACtD,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC;YACvB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACrB,CAAC;QAED,wLAAwL;QACxL,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE;YACpD,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAErB,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpC,CAAC;QAED,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,OAAwB,EAAE,EAAE;YAC7C,IAAI,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,OAAO,EAAE,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YACtB,IAAI,CAAC,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAC3B,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC;QACxB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,UAAU;QACR,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,IAAI,CAAC,MAAM;iBACR,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;iBACzB,IAAI,CAAC,+CAA+C,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YAC1E,OAAO;QACT,CAAC;QAED,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QAEnB,YAAY,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACpC,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAC7B,IAAI,CAAC,MAAM;aACR,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;aACzB,IAAI,CAAC,qCAAqC,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IAClE,CAAC;IAED,cAAc;QACZ,IAAI,CAAC,UAAU,EAAE,CAAC;QAClB,IAAI,CAAC,OAAO,CAAC,EAAE,qBAAqB,EAAE,IAAI,EAAE,CAAC,CAAC;IAChD,CAAC;IAED,WAAW;QACT,OAAO,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,KAAK,QAAQ,CAAC;IAC5D,CAAC;IAED,IAAI,CAAC,IAAkC;QACrC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,IAAI,CAAC,MAAM;iBACR,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;iBACnB,IAAI,CAAC,wCAAwC,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YACnE,OAAO;QACT,CAAC;QAED,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QACzB,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;YACrB,IAAI,CAAC,MAAM;iBACR,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;iBACnB,IAAI,CAAC,8CAA8C,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YACzE,OAAO;QACT,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC7B,CAAC;CACF","sourcesContent":["import { isEmpty } from '@venizia/ignis-inversion';\nimport { redactSecrets } from '@/common/redact';\nimport { BaseHelper } from '@/modules/base';\nimport { type ValueOrPromise } from '@/common';\nimport {\n type TcpSocketConnectOpts as PlainConnectionOptions,\n type Socket as PlainSocketClient,\n} from 'node:net';\nimport {\n type ConnectionOptions as TlsConnectionOptions,\n type TLSSocket as TlsSocketClient,\n} from 'node:tls';\n\nconst DEFAULT_MAX_RETRY = 5;\n\nexport interface INetworkTcpClientProps<\n SocketClientOptions extends PlainConnectionOptions | TlsConnectionOptions,\n SocketClientType extends PlainSocketClient | TlsSocketClient,\n> {\n identifier: string;\n scope?: string;\n\n options: SocketClientOptions;\n reconnect?: boolean;\n maxRetry?: number;\n encoding?: BufferEncoding;\n\n createClientFn: (\n options: SocketClientOptions,\n connectionListener?: () => void,\n ) => SocketClientType;\n\n onConnected?: (opts: { client: SocketClientType }) => ValueOrPromise<void>;\n onData?: (opts: { identifier: string; message: string | Buffer }) => ValueOrPromise<void>;\n onClosed?: (opts: { client: SocketClientType }) => void;\n onError?: (error: any) => void;\n}\n\nexport class BaseNetworkTcpClient<\n SocketClientOptions extends PlainConnectionOptions | TlsConnectionOptions,\n SocketClientType extends PlainSocketClient | TlsSocketClient,\n> extends BaseHelper {\n protected client?: SocketClientType | null;\n\n protected options: SocketClientOptions;\n protected reconnect?: boolean;\n protected retry: { maxReconnect: number; currentReconnect: number } = {\n maxReconnect: DEFAULT_MAX_RETRY,\n currentReconnect: 0,\n };\n protected reconnectTimeout: any;\n protected encoding?: BufferEncoding;\n\n protected createClientFn: (\n options: SocketClientOptions,\n connectionListener?: () => void,\n ) => SocketClientType;\n\n protected onConnected: (opts: { client: SocketClientType }) => void;\n protected onData: (opts: { identifier: string; message: string | Buffer }) => void;\n protected onClosed?: (opts: { client: SocketClientType }) => void;\n protected onError?: (error: any) => void;\n\n constructor(opts: INetworkTcpClientProps<SocketClientOptions, SocketClientType>) {\n super({\n scope: opts.scope ?? opts.identifier ?? BaseNetworkTcpClient.name,\n identifier: opts.identifier,\n });\n this.options = opts.options;\n\n this.retry = {\n maxReconnect: opts.maxRetry ?? DEFAULT_MAX_RETRY,\n currentReconnect: 0,\n };\n\n this.createClientFn = opts.createClientFn;\n\n this.onConnected = opts?.onConnected ?? this.handleConnected;\n this.onData = opts?.onData ?? this.handleData;\n this.onClosed = opts?.onClosed ?? this.handleClosed;\n this.onError = opts?.onError ?? this.handleError;\n this.reconnect = opts?.reconnect ?? false;\n this.encoding = opts?.encoding;\n }\n\n getClient() {\n return this.client;\n }\n\n /** Redacts before logging - a TLS client's options ARE its private key (`key`/`cert`/`passphrase`). */\n protected getLoggableOptions(): unknown {\n return redactSecrets(this.options);\n }\n\n handleConnected() {\n this.logger\n .for(this.handleConnected.name)\n .info(\n '[%s] Connected to TCP Server | Options: %j',\n this.identifier,\n this.getLoggableOptions(),\n );\n this.retry.currentReconnect = 0;\n }\n\n handleData(_opts: { identifier: string; message: string | Buffer }) {}\n\n handleClosed() {\n this.logger\n .for(this.handleClosed.name)\n .info(\n '[%s] Closed connection TCP Server | Options: %j',\n this.identifier,\n this.getLoggableOptions(),\n );\n }\n\n handleError(error: any) {\n this.logger\n .for(this.handleError.name)\n .error(\n '[%s] Connection error | Options: %j | Error: %s',\n this.identifier,\n this.getLoggableOptions(),\n error,\n );\n\n if (!this.reconnect || this.retry.currentReconnect >= this.retry.maxReconnect) {\n return;\n }\n\n const { currentReconnect, maxReconnect } = this.retry;\n if (maxReconnect > -1 && currentReconnect >= maxReconnect) {\n this.logger\n .for(this.handleData.name)\n .info(\n 'Exceeded max retry to reconnect! Max: %d | Current: %d',\n maxReconnect,\n currentReconnect,\n );\n return;\n }\n\n this.reconnectTimeout = setTimeout(() => {\n this.client?.destroy();\n this.client = null;\n\n this.logger\n .for(this.handleClosed.name)\n .info(\n '[%s] Retrying to establish TCP Connection | Options: %j',\n this.identifier,\n this.getLoggableOptions(),\n );\n\n this.connect({ resetReconnectCounter: false });\n this.retry.currentReconnect++;\n }, 5000);\n }\n\n connect(opts: { resetReconnectCounter: boolean }) {\n if (this.isConnected()) {\n this.logger\n .for(this.connect.name)\n .info('[%s] NetworkTcpClient is already initialized!', this.identifier);\n return;\n }\n\n if (isEmpty({ value: this.options })) {\n this.logger\n .for(this.connect.name)\n .info('[%s] Cannot init TCP Client with null options', this.identifier);\n return;\n }\n\n this.logger\n .for(this.connect.name)\n .info(\n '[%s] New network tcp client | Options: %j',\n this.identifier,\n this.getLoggableOptions(),\n );\n\n if (opts?.resetReconnectCounter) {\n this.retry.currentReconnect = 0;\n }\n\n if (this.client !== null && this.client !== undefined) {\n this.client?.destroy();\n this.client = null;\n }\n\n // The listeners close over THIS socket: `this.client` is nulled by disconnect() and swapped by a reconnect, so reading it back would drop the close hook - or hand it the wrong socket.\n const client = this.createClientFn(this.options, () => {\n this.onConnected?.({ client });\n });\n\n this.client = client;\n\n if (this.encoding) {\n client.setEncoding(this.encoding);\n }\n\n client.on('data', (message: string | Buffer) => {\n this.onData({ identifier: this.identifier, message });\n });\n\n client.on('close', () => {\n this.onClosed?.({ client });\n });\n\n client.on('error', (error) => {\n this.onError?.(error);\n });\n }\n\n disconnect() {\n if (!this.client) {\n this.logger\n .for(this.disconnect.name)\n .info('[%s] NetworkTcpClient is not initialized yet!', this.identifier);\n return;\n }\n\n this.client?.destroy();\n this.client = null;\n\n clearTimeout(this.reconnectTimeout);\n this.reconnectTimeout = null;\n this.logger\n .for(this.disconnect.name)\n .info('[%s] NetworkTcpClient is destroyed!', this.identifier);\n }\n\n forceReconnect() {\n this.disconnect();\n this.connect({ resetReconnectCounter: true });\n }\n\n isConnected() {\n return this.client && this.client.readyState !== 'closed';\n }\n\n emit(opts: { payload: Buffer | string }) {\n if (!this.client) {\n this.logger\n .for(this.emit.name)\n .info('[%s] TPC Client is not configured yet!', this.identifier);\n return;\n }\n\n const { payload } = opts;\n if (!payload?.length) {\n this.logger\n .for(this.emit.name)\n .info('[%s] Invalid payload to write to TCP Socket!', this.identifier);\n return;\n }\n\n this.client.write(payload);\n }\n}\n"]}
@@ -41,7 +41,7 @@ export class BaseNetworkTcpServer extends BaseHelper {
41
41
  }
42
42
  }
43
43
  configure() {
44
- this.server = this.createServerFn(this.serverOptions, socket => {
44
+ this.server = this.createServerFn(this.serverOptions, (socket) => {
45
45
  this.onNewConnection({ socket });
46
46
  });
47
47
  // Without this listener a failed listen - a port already in use is the commonest boot failure there is - emits an unhandled 'error' event, which takes the whole process down with it.
@@ -108,7 +108,7 @@ export class BaseNetworkTcpServer extends BaseHelper {
108
108
  delete this.clients[id];
109
109
  });
110
110
  for (const extraEvent in this.extraEvents) {
111
- socket.on(extraEvent, args => {
111
+ socket.on(extraEvent, (args) => {
112
112
  voidExecution({
113
113
  logger: this.logger,
114
114
  scope: 'onClientConnect',
@@ -185,8 +185,8 @@ export class BaseNetworkTcpServer extends BaseHelper {
185
185
  return;
186
186
  }
187
187
  // Not guarded on `listening`: listen() is async (DNS lookup), so a shutdown() racing startup could skip close() and leave the server bound forever; close() on a never-listened server just logs ERR_SERVER_NOT_RUNNING below.
188
- await new Promise(resolve => {
189
- server.close(error => {
188
+ await new Promise((resolve) => {
189
+ server.close((error) => {
190
190
  if (error) {
191
191
  this.logger.for(this.shutdown.name).error('Failed to close server | Error: %s', error);
192
192
  }
@@ -1 +1 @@
1
- {"version":3,"file":"base-tcp-server.helper.js","sourceRoot":"","sources":["../../../../../src/modules/network/tcp-socket/base-tcp-server.helper.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAmD5D,MAAM,OAAO,oBAIX,SAAQ,UAAU;IA6BlB,YACE,IAAsF;QAEtF,KAAK,CAAC;YACJ,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,UAAU,IAAI,oBAAoB,CAAC,IAAI;YACjE,UAAU,EAAE,IAAI,CAAC,UAAU;SAC5B,CAAC,CAAC;QAlCK,kBAAa,GAAiC,EAAE,CAAC;QACjD,kBAAa,GAA2B,EAAE,CAAC;QAmCnD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAEjC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QACxC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QACxC,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,mBAAmB,CAAC;QAEpD,IACE,IAAI,CAAC,mBAAmB,CAAC,QAAQ;YACjC,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,QAAQ,IAAI,IAAI,CAAC,mBAAmB,CAAC,QAAQ,GAAG,CAAC,CAAC,EAC7E,CAAC;YACD,MAAM,QAAQ,CAAC;gBACb,OAAO,EACL,wFAAwF;aAC3F,CAAC,CAAC;QACL,CAAC;QAED,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC;QAE1C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAE1C,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QACxC,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC;QAChD,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QACtC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QACxC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QACxC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QAExC,IAAI,CAAC,SAAS,EAAE,CAAC;IACnB,CAAC;IAED,4KAA4K;IAClK,UAAU,CAAC,IAA8C;QACjE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;QAElC,IAAI,CAAC;YACH,SAAS,EAAE,CAAC;QACd,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,mCAAmC,EAAE,KAAK,CAAC,CAAC;QAC3E,CAAC;IACH,CAAC;IAED,SAAS;QACP,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,EAAE;YAC7D,IAAI,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;QAEH,uLAAuL;QACvL,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAY,EAAE,EAAE;YACvC,IAAI,CAAC,MAAM;iBACR,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;iBACxB,KAAK,CAAC,mDAAmD,EAAE,IAAI,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;YAEzF,IAAI,CAAC,UAAU,CAAC;gBACd,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI;gBAC1B,SAAS,EAAE,GAAG,EAAE;oBACd,IAAI,CAAC,aAAa,EAAE,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;gBACvD,CAAC;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,EAAE,GAAG,EAAE;YAC1C,IAAI,CAAC,MAAM;iBACR,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;iBACxB,IAAI,CAAC,kDAAkD,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;YAEhF,IAAI,CAAC,UAAU,CAAC;gBACd,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI;gBAC1B,SAAS,EAAE,GAAG,EAAE;oBACd,IAAI,CAAC,aAAa,EAAE,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;gBAChD,CAAC;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED,eAAe,CAAC,IAAkC;QAChD,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QAExB,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;QAEpB,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAqB,EAAE,EAAE;YAC1C,IAAI,CAAC,UAAU,CAAC;gBACd,KAAK,EAAE,cAAc;gBACrB,SAAS,EAAE,GAAG,EAAE;oBACd,IAAI,CAAC,YAAY,EAAE,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC5C,CAAC;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAY,EAAE,EAAE;YAClC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,KAAK,CAAC,mCAAmC,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;YAEzF,IAAI,CAAC,UAAU,CAAC;gBACd,KAAK,EAAE,eAAe;gBACtB,SAAS,EAAE,GAAG,EAAE;oBACd,IAAI,CAAC,aAAa,EAAE,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;gBAC9C,CAAC;aACF,CAAC,CAAC;YAEH,MAAM,CAAC,GAAG,EAAE,CAAC;QACf,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,QAAiB,EAAE,EAAE;YACvC,IAAI,CAAC,MAAM;iBACR,GAAG,CAAC,iBAAiB,CAAC;iBACtB,IAAI,CAAC,uCAAuC,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAC;YAE/D,IAAI,CAAC,UAAU,CAAC;gBACd,KAAK,EAAE,eAAe;gBACtB,SAAS,EAAE,GAAG,EAAE;oBACd,IAAI,CAAC,aAAa,EAAE,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;gBACvC,CAAC;aACF,CAAC,CAAC;YAEH,MAAM,mBAAmB,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,OAAO,EAAE,mBAAmB,CAAC;YACjF,IAAI,mBAAmB,EAAE,CAAC;gBACxB,YAAY,CAAC,mBAAmB,CAAC,CAAC;YACpC,CAAC;YAED,yFAAyF;YACzF,0FAA0F;YAC1F,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;QAEH,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YAC1C,MAAM,CAAC,EAAE,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE;gBAC3B,aAAa,CAAC;oBACZ,MAAM,EAAE,IAAI,CAAC,MAAM;oBACnB,KAAK,EAAE,iBAAiB;oBACxB,4JAA4J;oBAC5J,SAAS,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE;iBAC9E,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG;YACjB,EAAE;YACF,MAAM;YACN,KAAK,EAAE,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,eAAe;YAC3E,aAAa,EAAE,IAAI,GAAG,CAAC,EAAE,CAAC;YAC1B,OAAO,EAAE;gBACP,WAAW,EAAE,IAAI,IAAI,EAAE;gBACvB,eAAe,EAAE,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE;aACvE;SACF,CAAC;QAEF,IAAI,CAAC,MAAM;aACR,GAAG,CAAC,iBAAiB,CAAC;aACtB,IAAI,CACH,gEAAgE,EAChE,GAAG,EAAE,MAAM,MAAM,CAAC,aAAa,MAAM,MAAM,CAAC,UAAU,MAAM,MAAM,CAAC,YAAY,EAAE,EACjF,IAAI,CAAC,mBAAmB,CAAC,QAAQ,EACjC,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAClC,CAAC;QAEJ,IAAI,CAAC,UAAU,CAAC;YACd,KAAK,EAAE,mBAAmB;YAC1B,SAAS,EAAE,GAAG,EAAE;gBACd,IAAI,CAAC,iBAAiB,EAAE,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;YAC3C,CAAC;SACF,CAAC,CAAC;QAEH,IACE,IAAI,CAAC,mBAAmB,CAAC,QAAQ;YACjC,IAAI,CAAC,mBAAmB,CAAC,QAAQ;YACjC,IAAI,CAAC,mBAAmB,CAAC,QAAQ,GAAG,CAAC,EACrC,CAAC;YACD,MAAM,mBAAmB,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC1C,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;gBACtC,IAAI,CAAC,MAAM,EAAE,CAAC;oBACZ,OAAO;gBACT,CAAC;gBAED,MAAM,CAAC,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC;gBAE1C,IAAI,MAAM,CAAC,KAAK,KAAK,eAAe,EAAE,CAAC;oBACrC,OAAO;gBACT,CAAC;gBAED,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,OAAO,EAAE,qBAAqB,EAAE,CAAC,CAAC;gBAC5D,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;YACtB,CAAC,EAAE,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;YAEtC,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;YACtC,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,YAAY,CAAC,mBAAmB,CAAC,CAAC;gBAClC,OAAO;YACT,CAAC;YAED,MAAM,CAAC,OAAO,CAAC,mBAAmB,GAAG,mBAAmB,CAAC;QAC3D,CAAC;IACH,CAAC;IAED,UAAU;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,SAAS,CAAC,IAAoB;QAC5B,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjC,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,0LAA0L;IAC1L,KAAK,CAAC,QAAQ;QACZ,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClD,KAAK,MAAM,MAAM,IAAI,aAAa,EAAE,CAAC;YACnC,MAAM,EAAE,mBAAmB,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC;YAC/C,IAAI,mBAAmB,EAAE,CAAC;gBACxB,YAAY,CAAC,mBAAmB,CAAC,CAAC;gBAClC,MAAM,CAAC,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC;YAC5C,CAAC;YAED,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QAC1B,CAAC;QAED,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAElB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO;QACT,CAAC;QAED,+NAA+N;QAE/N,MAAM,IAAI,OAAO,CAAO,OAAO,CAAC,EAAE;YAChC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE;gBACnB,IAAI,KAAK,EAAE,CAAC;oBACV,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,oCAAoC,EAAE,KAAK,CAAC,CAAC;gBACzF,CAAC;gBAED,OAAO,EAAE,CAAC;YACZ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,gCAAgC,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IAC9F,CAAC;IAED,cAAc,CAAC,IAAgF;QAC7F,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QAE3B,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QACtC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC,KAAK,CAAC,2BAA2B,EAAE,EAAE,CAAC,CAAC;YAC7E,OAAO;QACT,CAAC;QAED,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;QAErB,QAAQ,KAAK,EAAE,CAAC;YACd,KAAK,cAAc,CAAC;YACpB,KAAK,gBAAgB,CAAC,CAAC,CAAC;gBACtB,MAAM,CAAC,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;gBACtC,MAAM;YACR,CAAC;YACD,KAAK,eAAe,CAAC,CAAC,CAAC;gBACrB,MAAM,CAAC,OAAO,CAAC,eAAe,GAAG,IAAI,IAAI,EAAE,CAAC;gBAE5C,IAAI,MAAM,CAAC,OAAO,CAAC,mBAAmB,EAAE,CAAC;oBACvC,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;oBACjD,MAAM,CAAC,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC;gBAC5C,CAAC;gBACD,MAAM;YACR,CAAC;YACD,OAAO,CAAC,CAAC,CAAC;gBACR,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,CAAC,IAAoD;QACvD,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QACnC,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;QAEhD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,2BAA2B,EAAE,QAAQ,CAAC,CAAC;YAC7E,OAAO;QACT,CAAC;QAED,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAC1B,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;YACrB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,8BAA8B,EAAE,QAAQ,CAAC,CAAC;YAChF,OAAO;QACT,CAAC;QAED,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;YACrB,IAAI,CAAC,MAAM;iBACR,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;iBACnB,IAAI,CACH,0DAA0D,EAC1D,IAAI,CAAC,UAAU,EACf,QAAQ,CACT,CAAC;YACJ,OAAO;QACT,CAAC;QAED,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACxB,CAAC;CACF","sourcesContent":["import { type ValueOrPromise } from '@/common/types';\nimport { BaseHelper } from '@/modules/base';\nimport { getError } from '@/modules/error';\nimport { getUID } from '@/utilities/parse.utility';\nimport { voidExecution } from '@/utilities/promise.utility';\nimport {\n type ListenOptions,\n type ServerOpts,\n type Socket as SocketClient,\n type Server as SocketServer,\n} from 'node:net';\n\nexport interface ITcpSocketClient<SocketClientType> {\n id: string;\n socket: SocketClientType;\n state: 'unauthorized' | 'authenticating' | 'authenticated';\n subscriptions: Set<string>;\n storage: {\n connectedAt: Date;\n authenticatedAt: Date | null;\n authenticateTimeout?: ReturnType<typeof setTimeout> | null;\n [additionField: symbol | string]: any;\n };\n}\n\nexport interface ITcpSocketServerOptions<\n SocketServerOptions extends ServerOpts = ServerOpts,\n SocketServerType extends SocketServer = SocketServer,\n SocketClientType extends SocketClient = SocketClient,\n> {\n scope?: string;\n identifier: string;\n\n serverOptions: Partial<SocketServerOptions>;\n listenOptions: Partial<ListenOptions>;\n authenticateOptions: { required: boolean; duration?: number };\n\n extraEvents?: Record<\n string,\n (opts: { id: string; socket: SocketClientType; args: any }) => ValueOrPromise<void>\n >;\n\n createServerFn: (\n options: Partial<SocketServerOptions>,\n connectionListener: (socket: SocketClientType) => void,\n ) => SocketServerType;\n\n onServerReady?: (opts: { server: SocketServerType }) => void;\n onClientConnected?: (opts: { id: string; socket: SocketClientType }) => void;\n onClientData?: (opts: { id: string; socket: SocketClientType; data: Buffer | string }) => void;\n onClientClose?: (opts: { id: string; socket: SocketClientType }) => void;\n onClientError?: (opts: { id: string; socket: SocketClientType; error: Error }) => void;\n onServerError?: (opts: { server: SocketServerType; error: Error }) => void;\n}\n\nexport class BaseNetworkTcpServer<\n SocketServerOptions extends ServerOpts = ServerOpts,\n SocketServerType extends SocketServer = SocketServer,\n SocketClientType extends SocketClient = SocketClient,\n> extends BaseHelper {\n protected serverOptions: Partial<SocketServerOptions> = {};\n protected listenOptions: Partial<ListenOptions> = {};\n protected authenticateOptions: { required: boolean; duration?: number };\n\n protected clients: Record<string, ITcpSocketClient<SocketClientType>>;\n protected server: SocketServerType;\n\n protected extraEvents: Record<\n string,\n (opts: { id: string; socket: SocketClientType; args: any }) => ValueOrPromise<void>\n >;\n\n protected createServerFn: (\n options: Partial<SocketServerOptions>,\n connectionListener: (socket: SocketClientType) => void,\n ) => SocketServerType;\n\n protected onServerReady?: (opts: { server: SocketServerType }) => void;\n protected onClientConnected?: (opts: { id: string; socket: SocketClientType }) => void;\n protected onClientData?: (opts: {\n id: string;\n socket: SocketClientType;\n data: Buffer | string;\n }) => void;\n protected onClientClose?: (opts: { id: string; socket: SocketClientType }) => void;\n protected onClientError?: (opts: { id: string; socket: SocketClientType; error: Error }) => void;\n protected onServerError?: (opts: { server: SocketServerType; error: Error }) => void;\n\n constructor(\n opts: ITcpSocketServerOptions<SocketServerOptions, SocketServerType, SocketClientType>,\n ) {\n super({\n scope: opts.scope ?? opts.identifier ?? BaseNetworkTcpServer.name,\n identifier: opts.identifier,\n });\n\n this.clients = Object.assign({});\n\n this.serverOptions = opts.serverOptions;\n this.listenOptions = opts.listenOptions;\n this.authenticateOptions = opts.authenticateOptions;\n\n if (\n this.authenticateOptions.required &&\n (!this.authenticateOptions.duration || this.authenticateOptions.duration < 0)\n ) {\n throw getError({\n message:\n 'TCP Server | Invalid authenticate duration | Required duration for authenticateOptions',\n });\n }\n\n this.extraEvents = opts.extraEvents ?? {};\n\n this.createServerFn = opts.createServerFn;\n\n this.onServerReady = opts.onServerReady;\n this.onClientConnected = opts.onClientConnected;\n this.onClientData = opts.onClientData;\n this.onClientClose = opts.onClientClose;\n this.onClientError = opts.onClientError;\n this.onServerError = opts.onServerError;\n\n this.configure();\n }\n\n // Hooks run inside socket event listeners: a synchronous throw there is an uncaught exception that kills the process and skips the client-registry cleanup that follows it.\n protected invokeHook(opts: { scope: string; execution: () => void }) {\n const { scope, execution } = opts;\n\n try {\n execution();\n } catch (error) {\n this.logger.for(scope).error('Hook execution FAILED | Error: %s', error);\n }\n }\n\n configure() {\n this.server = this.createServerFn(this.serverOptions, socket => {\n this.onNewConnection({ socket });\n });\n\n // Without this listener a failed listen - a port already in use is the commonest boot failure there is - emits an unhandled 'error' event, which takes the whole process down with it.\n this.server.on('error', (error: Error) => {\n this.logger\n .for(this.configure.name)\n .error('TCP Socket Server error | Options: %j | Error: %s', this.listenOptions, error);\n\n this.invokeHook({\n scope: this.configure.name,\n execution: () => {\n this.onServerError?.({ server: this.server, error });\n },\n });\n });\n\n this.server.listen(this.listenOptions, () => {\n this.logger\n .for(this.configure.name)\n .info('TCP Socket Server is now listening | Options: %j', this.listenOptions);\n\n this.invokeHook({\n scope: this.configure.name,\n execution: () => {\n this.onServerReady?.({ server: this.server });\n },\n });\n });\n }\n\n onNewConnection(opts: { socket: SocketClientType }) {\n const { socket } = opts;\n\n const id = getUID();\n\n socket.on('data', (data: Buffer | string) => {\n this.invokeHook({\n scope: 'onClientData',\n execution: () => {\n this.onClientData?.({ id, socket, data });\n },\n });\n });\n\n socket.on('error', (error: Error) => {\n this.logger.for('onClientConnect').error('Socket Error | ID: %s | Error: %s', id, error);\n\n this.invokeHook({\n scope: 'onClientError',\n execution: () => {\n this.onClientError?.({ id, socket, error });\n },\n });\n\n socket.end();\n });\n\n socket.on('close', (hasError: boolean) => {\n this.logger\n .for('onClientConnect')\n .info('Socket Closed | ID: %s | hasError: %s', id, hasError);\n\n this.invokeHook({\n scope: 'onClientClose',\n execution: () => {\n this.onClientClose?.({ id, socket });\n },\n });\n\n const authenticateTimeout = this.getClient({ id })?.storage?.authenticateTimeout;\n if (authenticateTimeout) {\n clearTimeout(authenticateTimeout);\n }\n\n // `delete`, not `omit`: omit rebuilds the WHOLE registry per disconnect, so a disconnect\n // storm is O(n^2) - measured at 5000 clients, 2.3s of drain with a 2.2s worst-case stall.\n delete this.clients[id];\n });\n\n for (const extraEvent in this.extraEvents) {\n socket.on(extraEvent, args => {\n voidExecution({\n logger: this.logger,\n scope: 'onClientConnect',\n // The async wrapper turns a SYNCHRONOUS throw from the handler into a rejection; calling it bare would throw out of this listener as an uncaught exception.\n execution: (async () => this.extraEvents[extraEvent]({ id, socket, args }))(),\n });\n });\n }\n\n this.clients[id] = {\n id,\n socket,\n state: this.authenticateOptions.required ? 'unauthorized' : 'authenticated',\n subscriptions: new Set([]),\n storage: {\n connectedAt: new Date(),\n authenticatedAt: this.authenticateOptions.required ? null : new Date(),\n },\n };\n\n this.logger\n .for('onClientConnect')\n .info(\n 'New TCP SocketClient | Client: %s | authenticateOptions: %s %s',\n `${id} - ${socket.remoteAddress} - ${socket.remotePort} - ${socket.remoteFamily}`,\n this.authenticateOptions.required,\n this.authenticateOptions.duration,\n );\n\n this.invokeHook({\n scope: 'onClientConnected',\n execution: () => {\n this.onClientConnected?.({ id, socket });\n },\n });\n\n if (\n this.authenticateOptions.required &&\n this.authenticateOptions.duration &&\n this.authenticateOptions.duration > 0\n ) {\n const authenticateTimeout = setTimeout(() => {\n const client = this.getClient({ id });\n if (!client) {\n return;\n }\n\n client.storage.authenticateTimeout = null;\n\n if (client.state === 'authenticated') {\n return;\n }\n\n this.emit({ clientId: id, payload: 'Unauthorized Client' });\n client.socket.end();\n }, this.authenticateOptions.duration);\n\n const client = this.getClient({ id });\n if (!client) {\n clearTimeout(authenticateTimeout);\n return;\n }\n\n client.storage.authenticateTimeout = authenticateTimeout;\n }\n }\n\n getClients() {\n return this.clients;\n }\n\n getClient(opts: { id: string }) {\n return this.clients?.[opts.id];\n }\n\n getServer() {\n return this.server;\n }\n\n /** Clears timers and destroys all client sockets before closing the listener - `server.close()` alone never settles while a socket stays attached. Idempotent; safe if never listened. */\n async shutdown(): Promise<void> {\n const clientsValues = Object.values(this.clients);\n for (const client of clientsValues) {\n const { authenticateTimeout } = client.storage;\n if (authenticateTimeout) {\n clearTimeout(authenticateTimeout);\n client.storage.authenticateTimeout = null;\n }\n\n client.socket.destroy();\n }\n\n this.clients = {};\n\n const server = this.server;\n if (!server) {\n return;\n }\n\n // Not guarded on `listening`: listen() is async (DNS lookup), so a shutdown() racing startup could skip close() and leave the server bound forever; close() on a never-listened server just logs ERR_SERVER_NOT_RUNNING below.\n\n await new Promise<void>(resolve => {\n server.close(error => {\n if (error) {\n this.logger.for(this.shutdown.name).error('Failed to close server | Error: %s', error);\n }\n\n resolve();\n });\n });\n\n this.logger.for(this.shutdown.name).info('Server closed | Identifier: %s', this.identifier);\n }\n\n doAuthenticate(opts: { id: string; state: 'unauthorized' | 'authenticating' | 'authenticated' }) {\n const { id, state } = opts;\n\n const client = this.getClient({ id });\n if (!client) {\n this.logger.for('authenticateClient').error('Client NOT FOUND | ID: %s', id);\n return;\n }\n\n client.state = state;\n\n switch (state) {\n case 'unauthorized':\n case 'authenticating': {\n client.storage.authenticatedAt = null;\n break;\n }\n case 'authenticated': {\n client.storage.authenticatedAt = new Date();\n\n if (client.storage.authenticateTimeout) {\n clearTimeout(client.storage.authenticateTimeout);\n client.storage.authenticateTimeout = null;\n }\n break;\n }\n default: {\n break;\n }\n }\n }\n\n emit(opts: { clientId: string; payload: Buffer | string }) {\n const { clientId, payload } = opts;\n const client = this.getClient({ id: clientId });\n\n if (!client) {\n this.logger.for(this.emit.name).error('Client NOT FOUND | ID: %s', clientId);\n return;\n }\n\n const { socket } = client;\n if (!socket.writable) {\n this.logger.for(this.emit.name).error('Client NOT WRITABLE | ID: %s', clientId);\n return;\n }\n\n if (!payload?.length) {\n this.logger\n .for(this.emit.name)\n .info(\n '[%s] Client %s | Invalid payload to write to TCP Socket!',\n this.identifier,\n clientId,\n );\n return;\n }\n\n socket.write(payload);\n }\n}\n"]}
1
+ {"version":3,"file":"base-tcp-server.helper.js","sourceRoot":"","sources":["../../../../../src/modules/network/tcp-socket/base-tcp-server.helper.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAmD5D,MAAM,OAAO,oBAIX,SAAQ,UAAU;IA6BlB,YACE,IAAsF;QAEtF,KAAK,CAAC;YACJ,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,UAAU,IAAI,oBAAoB,CAAC,IAAI;YACjE,UAAU,EAAE,IAAI,CAAC,UAAU;SAC5B,CAAC,CAAC;QAlCK,kBAAa,GAAiC,EAAE,CAAC;QACjD,kBAAa,GAA2B,EAAE,CAAC;QAmCnD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAEjC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QACxC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QACxC,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,mBAAmB,CAAC;QAEpD,IACE,IAAI,CAAC,mBAAmB,CAAC,QAAQ;YACjC,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,QAAQ,IAAI,IAAI,CAAC,mBAAmB,CAAC,QAAQ,GAAG,CAAC,CAAC,EAC7E,CAAC;YACD,MAAM,QAAQ,CAAC;gBACb,OAAO,EACL,wFAAwF;aAC3F,CAAC,CAAC;QACL,CAAC;QAED,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC;QAE1C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAE1C,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QACxC,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC;QAChD,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QACtC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QACxC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QACxC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QAExC,IAAI,CAAC,SAAS,EAAE,CAAC;IACnB,CAAC;IAED,4KAA4K;IAClK,UAAU,CAAC,IAA8C;QACjE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;QAElC,IAAI,CAAC;YACH,SAAS,EAAE,CAAC;QACd,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,mCAAmC,EAAE,KAAK,CAAC,CAAC;QAC3E,CAAC;IACH,CAAC;IAED,SAAS;QACP,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,MAAM,EAAE,EAAE;YAC/D,IAAI,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;QAEH,uLAAuL;QACvL,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAY,EAAE,EAAE;YACvC,IAAI,CAAC,MAAM;iBACR,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;iBACxB,KAAK,CAAC,mDAAmD,EAAE,IAAI,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;YAEzF,IAAI,CAAC,UAAU,CAAC;gBACd,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI;gBAC1B,SAAS,EAAE,GAAG,EAAE;oBACd,IAAI,CAAC,aAAa,EAAE,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;gBACvD,CAAC;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,EAAE,GAAG,EAAE;YAC1C,IAAI,CAAC,MAAM;iBACR,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;iBACxB,IAAI,CAAC,kDAAkD,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;YAEhF,IAAI,CAAC,UAAU,CAAC;gBACd,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI;gBAC1B,SAAS,EAAE,GAAG,EAAE;oBACd,IAAI,CAAC,aAAa,EAAE,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;gBAChD,CAAC;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED,eAAe,CAAC,IAAkC;QAChD,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QAExB,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;QAEpB,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAqB,EAAE,EAAE;YAC1C,IAAI,CAAC,UAAU,CAAC;gBACd,KAAK,EAAE,cAAc;gBACrB,SAAS,EAAE,GAAG,EAAE;oBACd,IAAI,CAAC,YAAY,EAAE,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC5C,CAAC;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAY,EAAE,EAAE;YAClC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,KAAK,CAAC,mCAAmC,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;YAEzF,IAAI,CAAC,UAAU,CAAC;gBACd,KAAK,EAAE,eAAe;gBACtB,SAAS,EAAE,GAAG,EAAE;oBACd,IAAI,CAAC,aAAa,EAAE,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;gBAC9C,CAAC;aACF,CAAC,CAAC;YAEH,MAAM,CAAC,GAAG,EAAE,CAAC;QACf,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,QAAiB,EAAE,EAAE;YACvC,IAAI,CAAC,MAAM;iBACR,GAAG,CAAC,iBAAiB,CAAC;iBACtB,IAAI,CAAC,uCAAuC,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAC;YAE/D,IAAI,CAAC,UAAU,CAAC;gBACd,KAAK,EAAE,eAAe;gBACtB,SAAS,EAAE,GAAG,EAAE;oBACd,IAAI,CAAC,aAAa,EAAE,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;gBACvC,CAAC;aACF,CAAC,CAAC;YAEH,MAAM,mBAAmB,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,OAAO,EAAE,mBAAmB,CAAC;YACjF,IAAI,mBAAmB,EAAE,CAAC;gBACxB,YAAY,CAAC,mBAAmB,CAAC,CAAC;YACpC,CAAC;YAED,yFAAyF;YACzF,0FAA0F;YAC1F,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;QAEH,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YAC1C,MAAM,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC,IAAI,EAAE,EAAE;gBAC7B,aAAa,CAAC;oBACZ,MAAM,EAAE,IAAI,CAAC,MAAM;oBACnB,KAAK,EAAE,iBAAiB;oBACxB,4JAA4J;oBAC5J,SAAS,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE;iBAC9E,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG;YACjB,EAAE;YACF,MAAM;YACN,KAAK,EAAE,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,eAAe;YAC3E,aAAa,EAAE,IAAI,GAAG,CAAC,EAAE,CAAC;YAC1B,OAAO,EAAE;gBACP,WAAW,EAAE,IAAI,IAAI,EAAE;gBACvB,eAAe,EAAE,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE;aACvE;SACF,CAAC;QAEF,IAAI,CAAC,MAAM;aACR,GAAG,CAAC,iBAAiB,CAAC;aACtB,IAAI,CACH,gEAAgE,EAChE,GAAG,EAAE,MAAM,MAAM,CAAC,aAAa,MAAM,MAAM,CAAC,UAAU,MAAM,MAAM,CAAC,YAAY,EAAE,EACjF,IAAI,CAAC,mBAAmB,CAAC,QAAQ,EACjC,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAClC,CAAC;QAEJ,IAAI,CAAC,UAAU,CAAC;YACd,KAAK,EAAE,mBAAmB;YAC1B,SAAS,EAAE,GAAG,EAAE;gBACd,IAAI,CAAC,iBAAiB,EAAE,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;YAC3C,CAAC;SACF,CAAC,CAAC;QAEH,IACE,IAAI,CAAC,mBAAmB,CAAC,QAAQ;YACjC,IAAI,CAAC,mBAAmB,CAAC,QAAQ;YACjC,IAAI,CAAC,mBAAmB,CAAC,QAAQ,GAAG,CAAC,EACrC,CAAC;YACD,MAAM,mBAAmB,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC1C,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;gBACtC,IAAI,CAAC,MAAM,EAAE,CAAC;oBACZ,OAAO;gBACT,CAAC;gBAED,MAAM,CAAC,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC;gBAE1C,IAAI,MAAM,CAAC,KAAK,KAAK,eAAe,EAAE,CAAC;oBACrC,OAAO;gBACT,CAAC;gBAED,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,OAAO,EAAE,qBAAqB,EAAE,CAAC,CAAC;gBAC5D,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;YACtB,CAAC,EAAE,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;YAEtC,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;YACtC,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,YAAY,CAAC,mBAAmB,CAAC,CAAC;gBAClC,OAAO;YACT,CAAC;YAED,MAAM,CAAC,OAAO,CAAC,mBAAmB,GAAG,mBAAmB,CAAC;QAC3D,CAAC;IACH,CAAC;IAED,UAAU;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,SAAS,CAAC,IAAoB;QAC5B,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjC,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,0LAA0L;IAC1L,KAAK,CAAC,QAAQ;QACZ,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClD,KAAK,MAAM,MAAM,IAAI,aAAa,EAAE,CAAC;YACnC,MAAM,EAAE,mBAAmB,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC;YAC/C,IAAI,mBAAmB,EAAE,CAAC;gBACxB,YAAY,CAAC,mBAAmB,CAAC,CAAC;gBAClC,MAAM,CAAC,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC;YAC5C,CAAC;YAED,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QAC1B,CAAC;QAED,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAElB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO;QACT,CAAC;QAED,+NAA+N;QAE/N,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;YAClC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACrB,IAAI,KAAK,EAAE,CAAC;oBACV,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,oCAAoC,EAAE,KAAK,CAAC,CAAC;gBACzF,CAAC;gBAED,OAAO,EAAE,CAAC;YACZ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,gCAAgC,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IAC9F,CAAC;IAED,cAAc,CAAC,IAAgF;QAC7F,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QAE3B,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QACtC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC,KAAK,CAAC,2BAA2B,EAAE,EAAE,CAAC,CAAC;YAC7E,OAAO;QACT,CAAC;QAED,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;QAErB,QAAQ,KAAK,EAAE,CAAC;YACd,KAAK,cAAc,CAAC;YACpB,KAAK,gBAAgB,CAAC,CAAC,CAAC;gBACtB,MAAM,CAAC,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;gBACtC,MAAM;YACR,CAAC;YACD,KAAK,eAAe,CAAC,CAAC,CAAC;gBACrB,MAAM,CAAC,OAAO,CAAC,eAAe,GAAG,IAAI,IAAI,EAAE,CAAC;gBAE5C,IAAI,MAAM,CAAC,OAAO,CAAC,mBAAmB,EAAE,CAAC;oBACvC,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;oBACjD,MAAM,CAAC,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC;gBAC5C,CAAC;gBACD,MAAM;YACR,CAAC;YACD,OAAO,CAAC,CAAC,CAAC;gBACR,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,CAAC,IAAoD;QACvD,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QACnC,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;QAEhD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,2BAA2B,EAAE,QAAQ,CAAC,CAAC;YAC7E,OAAO;QACT,CAAC;QAED,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAC1B,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;YACrB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,8BAA8B,EAAE,QAAQ,CAAC,CAAC;YAChF,OAAO;QACT,CAAC;QAED,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;YACrB,IAAI,CAAC,MAAM;iBACR,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;iBACnB,IAAI,CACH,0DAA0D,EAC1D,IAAI,CAAC,UAAU,EACf,QAAQ,CACT,CAAC;YACJ,OAAO;QACT,CAAC;QAED,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACxB,CAAC;CACF","sourcesContent":["import { type ValueOrPromise } from '@/common/types';\nimport { BaseHelper } from '@/modules/base';\nimport { getError } from '@/modules/error';\nimport { getUID } from '@/utilities/parse.utility';\nimport { voidExecution } from '@/utilities/promise.utility';\nimport {\n type ListenOptions,\n type ServerOpts,\n type Socket as SocketClient,\n type Server as SocketServer,\n} from 'node:net';\n\nexport interface ITcpSocketClient<SocketClientType> {\n id: string;\n socket: SocketClientType;\n state: 'unauthorized' | 'authenticating' | 'authenticated';\n subscriptions: Set<string>;\n storage: {\n connectedAt: Date;\n authenticatedAt: Date | null;\n authenticateTimeout?: ReturnType<typeof setTimeout> | null;\n [additionField: symbol | string]: any;\n };\n}\n\nexport interface ITcpSocketServerOptions<\n SocketServerOptions extends ServerOpts = ServerOpts,\n SocketServerType extends SocketServer = SocketServer,\n SocketClientType extends SocketClient = SocketClient,\n> {\n scope?: string;\n identifier: string;\n\n serverOptions: Partial<SocketServerOptions>;\n listenOptions: Partial<ListenOptions>;\n authenticateOptions: { required: boolean; duration?: number };\n\n extraEvents?: Record<\n string,\n (opts: { id: string; socket: SocketClientType; args: any }) => ValueOrPromise<void>\n >;\n\n createServerFn: (\n options: Partial<SocketServerOptions>,\n connectionListener: (socket: SocketClientType) => void,\n ) => SocketServerType;\n\n onServerReady?: (opts: { server: SocketServerType }) => void;\n onClientConnected?: (opts: { id: string; socket: SocketClientType }) => void;\n onClientData?: (opts: { id: string; socket: SocketClientType; data: Buffer | string }) => void;\n onClientClose?: (opts: { id: string; socket: SocketClientType }) => void;\n onClientError?: (opts: { id: string; socket: SocketClientType; error: Error }) => void;\n onServerError?: (opts: { server: SocketServerType; error: Error }) => void;\n}\n\nexport class BaseNetworkTcpServer<\n SocketServerOptions extends ServerOpts = ServerOpts,\n SocketServerType extends SocketServer = SocketServer,\n SocketClientType extends SocketClient = SocketClient,\n> extends BaseHelper {\n protected serverOptions: Partial<SocketServerOptions> = {};\n protected listenOptions: Partial<ListenOptions> = {};\n protected authenticateOptions: { required: boolean; duration?: number };\n\n protected clients: Record<string, ITcpSocketClient<SocketClientType>>;\n protected server: SocketServerType;\n\n protected extraEvents: Record<\n string,\n (opts: { id: string; socket: SocketClientType; args: any }) => ValueOrPromise<void>\n >;\n\n protected createServerFn: (\n options: Partial<SocketServerOptions>,\n connectionListener: (socket: SocketClientType) => void,\n ) => SocketServerType;\n\n protected onServerReady?: (opts: { server: SocketServerType }) => void;\n protected onClientConnected?: (opts: { id: string; socket: SocketClientType }) => void;\n protected onClientData?: (opts: {\n id: string;\n socket: SocketClientType;\n data: Buffer | string;\n }) => void;\n protected onClientClose?: (opts: { id: string; socket: SocketClientType }) => void;\n protected onClientError?: (opts: { id: string; socket: SocketClientType; error: Error }) => void;\n protected onServerError?: (opts: { server: SocketServerType; error: Error }) => void;\n\n constructor(\n opts: ITcpSocketServerOptions<SocketServerOptions, SocketServerType, SocketClientType>,\n ) {\n super({\n scope: opts.scope ?? opts.identifier ?? BaseNetworkTcpServer.name,\n identifier: opts.identifier,\n });\n\n this.clients = Object.assign({});\n\n this.serverOptions = opts.serverOptions;\n this.listenOptions = opts.listenOptions;\n this.authenticateOptions = opts.authenticateOptions;\n\n if (\n this.authenticateOptions.required &&\n (!this.authenticateOptions.duration || this.authenticateOptions.duration < 0)\n ) {\n throw getError({\n message:\n 'TCP Server | Invalid authenticate duration | Required duration for authenticateOptions',\n });\n }\n\n this.extraEvents = opts.extraEvents ?? {};\n\n this.createServerFn = opts.createServerFn;\n\n this.onServerReady = opts.onServerReady;\n this.onClientConnected = opts.onClientConnected;\n this.onClientData = opts.onClientData;\n this.onClientClose = opts.onClientClose;\n this.onClientError = opts.onClientError;\n this.onServerError = opts.onServerError;\n\n this.configure();\n }\n\n // Hooks run inside socket event listeners: a synchronous throw there is an uncaught exception that kills the process and skips the client-registry cleanup that follows it.\n protected invokeHook(opts: { scope: string; execution: () => void }) {\n const { scope, execution } = opts;\n\n try {\n execution();\n } catch (error) {\n this.logger.for(scope).error('Hook execution FAILED | Error: %s', error);\n }\n }\n\n configure() {\n this.server = this.createServerFn(this.serverOptions, (socket) => {\n this.onNewConnection({ socket });\n });\n\n // Without this listener a failed listen - a port already in use is the commonest boot failure there is - emits an unhandled 'error' event, which takes the whole process down with it.\n this.server.on('error', (error: Error) => {\n this.logger\n .for(this.configure.name)\n .error('TCP Socket Server error | Options: %j | Error: %s', this.listenOptions, error);\n\n this.invokeHook({\n scope: this.configure.name,\n execution: () => {\n this.onServerError?.({ server: this.server, error });\n },\n });\n });\n\n this.server.listen(this.listenOptions, () => {\n this.logger\n .for(this.configure.name)\n .info('TCP Socket Server is now listening | Options: %j', this.listenOptions);\n\n this.invokeHook({\n scope: this.configure.name,\n execution: () => {\n this.onServerReady?.({ server: this.server });\n },\n });\n });\n }\n\n onNewConnection(opts: { socket: SocketClientType }) {\n const { socket } = opts;\n\n const id = getUID();\n\n socket.on('data', (data: Buffer | string) => {\n this.invokeHook({\n scope: 'onClientData',\n execution: () => {\n this.onClientData?.({ id, socket, data });\n },\n });\n });\n\n socket.on('error', (error: Error) => {\n this.logger.for('onClientConnect').error('Socket Error | ID: %s | Error: %s', id, error);\n\n this.invokeHook({\n scope: 'onClientError',\n execution: () => {\n this.onClientError?.({ id, socket, error });\n },\n });\n\n socket.end();\n });\n\n socket.on('close', (hasError: boolean) => {\n this.logger\n .for('onClientConnect')\n .info('Socket Closed | ID: %s | hasError: %s', id, hasError);\n\n this.invokeHook({\n scope: 'onClientClose',\n execution: () => {\n this.onClientClose?.({ id, socket });\n },\n });\n\n const authenticateTimeout = this.getClient({ id })?.storage?.authenticateTimeout;\n if (authenticateTimeout) {\n clearTimeout(authenticateTimeout);\n }\n\n // `delete`, not `omit`: omit rebuilds the WHOLE registry per disconnect, so a disconnect\n // storm is O(n^2) - measured at 5000 clients, 2.3s of drain with a 2.2s worst-case stall.\n delete this.clients[id];\n });\n\n for (const extraEvent in this.extraEvents) {\n socket.on(extraEvent, (args) => {\n voidExecution({\n logger: this.logger,\n scope: 'onClientConnect',\n // The async wrapper turns a SYNCHRONOUS throw from the handler into a rejection; calling it bare would throw out of this listener as an uncaught exception.\n execution: (async () => this.extraEvents[extraEvent]({ id, socket, args }))(),\n });\n });\n }\n\n this.clients[id] = {\n id,\n socket,\n state: this.authenticateOptions.required ? 'unauthorized' : 'authenticated',\n subscriptions: new Set([]),\n storage: {\n connectedAt: new Date(),\n authenticatedAt: this.authenticateOptions.required ? null : new Date(),\n },\n };\n\n this.logger\n .for('onClientConnect')\n .info(\n 'New TCP SocketClient | Client: %s | authenticateOptions: %s %s',\n `${id} - ${socket.remoteAddress} - ${socket.remotePort} - ${socket.remoteFamily}`,\n this.authenticateOptions.required,\n this.authenticateOptions.duration,\n );\n\n this.invokeHook({\n scope: 'onClientConnected',\n execution: () => {\n this.onClientConnected?.({ id, socket });\n },\n });\n\n if (\n this.authenticateOptions.required &&\n this.authenticateOptions.duration &&\n this.authenticateOptions.duration > 0\n ) {\n const authenticateTimeout = setTimeout(() => {\n const client = this.getClient({ id });\n if (!client) {\n return;\n }\n\n client.storage.authenticateTimeout = null;\n\n if (client.state === 'authenticated') {\n return;\n }\n\n this.emit({ clientId: id, payload: 'Unauthorized Client' });\n client.socket.end();\n }, this.authenticateOptions.duration);\n\n const client = this.getClient({ id });\n if (!client) {\n clearTimeout(authenticateTimeout);\n return;\n }\n\n client.storage.authenticateTimeout = authenticateTimeout;\n }\n }\n\n getClients() {\n return this.clients;\n }\n\n getClient(opts: { id: string }) {\n return this.clients?.[opts.id];\n }\n\n getServer() {\n return this.server;\n }\n\n /** Clears timers and destroys all client sockets before closing the listener - `server.close()` alone never settles while a socket stays attached. Idempotent; safe if never listened. */\n async shutdown(): Promise<void> {\n const clientsValues = Object.values(this.clients);\n for (const client of clientsValues) {\n const { authenticateTimeout } = client.storage;\n if (authenticateTimeout) {\n clearTimeout(authenticateTimeout);\n client.storage.authenticateTimeout = null;\n }\n\n client.socket.destroy();\n }\n\n this.clients = {};\n\n const server = this.server;\n if (!server) {\n return;\n }\n\n // Not guarded on `listening`: listen() is async (DNS lookup), so a shutdown() racing startup could skip close() and leave the server bound forever; close() on a never-listened server just logs ERR_SERVER_NOT_RUNNING below.\n\n await new Promise<void>((resolve) => {\n server.close((error) => {\n if (error) {\n this.logger.for(this.shutdown.name).error('Failed to close server | Error: %s', error);\n }\n\n resolve();\n });\n });\n\n this.logger.for(this.shutdown.name).info('Server closed | Identifier: %s', this.identifier);\n }\n\n doAuthenticate(opts: { id: string; state: 'unauthorized' | 'authenticating' | 'authenticated' }) {\n const { id, state } = opts;\n\n const client = this.getClient({ id });\n if (!client) {\n this.logger.for('authenticateClient').error('Client NOT FOUND | ID: %s', id);\n return;\n }\n\n client.state = state;\n\n switch (state) {\n case 'unauthorized':\n case 'authenticating': {\n client.storage.authenticatedAt = null;\n break;\n }\n case 'authenticated': {\n client.storage.authenticatedAt = new Date();\n\n if (client.storage.authenticateTimeout) {\n clearTimeout(client.storage.authenticateTimeout);\n client.storage.authenticateTimeout = null;\n }\n break;\n }\n default: {\n break;\n }\n }\n }\n\n emit(opts: { clientId: string; payload: Buffer | string }) {\n const { clientId, payload } = opts;\n const client = this.getClient({ id: clientId });\n\n if (!client) {\n this.logger.for(this.emit.name).error('Client NOT FOUND | ID: %s', clientId);\n return;\n }\n\n const { socket } = client;\n if (!socket.writable) {\n this.logger.for(this.emit.name).error('Client NOT WRITABLE | ID: %s', clientId);\n return;\n }\n\n if (!payload?.length) {\n this.logger\n .for(this.emit.name)\n .info(\n '[%s] Client %s | Invalid payload to write to TCP Socket!',\n this.identifier,\n clientId,\n );\n return;\n }\n\n socket.write(payload);\n }\n}\n"]}
@@ -78,7 +78,7 @@ export class NetworkUdpClient extends BaseHelper {
78
78
  },
79
79
  });
80
80
  });
81
- this.client.on('error', error => {
81
+ this.client.on('error', (error) => {
82
82
  this.invokeHook({
83
83
  scope: this.handleError.name,
84
84
  execution: () => {
@@ -1 +1 @@
1
- {"version":3,"file":"network-udp-client.helper.js","sourceRoot":"","sources":["../../../../../src/modules/network/udp-socket/network-udp-client.helper.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,KAAK,MAAM,YAAY,CAAC;AAgC/B,MAAM,OAAO,gBAAiB,SAAQ,UAAU;IAkC9C,YAAY,IAA4B;QACtC,KAAK,CAAC,EAAE,KAAK,EAAE,gBAAgB,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;QAErE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACtB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACtB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAChC,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAE9C,IAAI,CAAC,WAAW,GAAG,IAAI,EAAE,WAAW,IAAI,IAAI,CAAC,eAAe,CAAC;QAC7D,IAAI,CAAC,MAAM,GAAG,IAAI,EAAE,MAAM,IAAI,IAAI,CAAC,UAAU,CAAC;QAC9C,IAAI,CAAC,QAAQ,GAAG,IAAI,EAAE,QAAQ,IAAI,IAAI,CAAC,YAAY,CAAC;QACpD,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,OAAO,IAAI,IAAI,CAAC,WAAW,CAAC;QACjD,IAAI,CAAC,MAAM,GAAG,IAAI,EAAE,MAAM,CAAC;IAC7B,CAAC;IAED,MAAM,CAAC,WAAW,CAAC,IAA4B;QAC7C,OAAO,IAAI,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,eAAe;QACb,IAAI,CAAC,MAAM;aACR,GAAG,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC;aAC9B,IAAI,CAAC,iDAAiD,EAAE,IAAI,CAAC,UAAU,EAAE;YACxE,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;SACxC,CAAC,CAAC;IACP,CAAC;IAED,UAAU,CAAC,IAAoF;QAC7F,IAAI,CAAC,MAAM;aACR,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;aACzB,IAAI,CAAC,0BAA0B,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE;YACvE,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,UAAU,EAAE,IAAI,CAAC,UAAU;SAC5B,CAAC,CAAC;IACP,CAAC;IAED,YAAY;QACV,IAAI,CAAC,MAAM;aACR,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;aAC3B,IAAI,CAAC,iDAAiD,EAAE,IAAI,CAAC,UAAU,EAAE;YACxE,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;SACxC,CAAC,CAAC;IACP,CAAC;IAED,WAAW,CAAC,IAA0C;QACpD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,CAC1C,iDAAiD,EACjD,IAAI,CAAC,UAAU,EACf;YACE,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,EACD,IAAI,CAAC,KAAK,CACX,CAAC;IACJ,CAAC;IAED,OAAO;QACL,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,IAAI,CAAC,MAAM;iBACR,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;iBACtB,IAAI,CAAC,wCAAwC,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YACnE,OAAO;QACT,CAAC;QAED,iGAAiG;QACjG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;YAClD,IAAI,CAAC,MAAM;iBACR,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;iBACtB,IAAI,CACH,0DAA0D,EAC1D,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,IAAI,CACV,CAAC;YACJ,OAAO;QACT,CAAC;QAED,IAAI,CAAC,MAAM;aACR,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;aACtB,IAAI,CACH,0EAA0E,EAC1E,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,gBAAgB,CACtB,CAAC;QAEJ,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;QAC9E,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YAC3B,IAAI,CAAC,UAAU,CAAC;gBACd,KAAK,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI;gBAC7B,SAAS,EAAE,GAAG,EAAE;oBACd,IAAI,CAAC,QAAQ,EAAE,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;gBACrF,CAAC;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE;YAC9B,IAAI,CAAC,UAAU,CAAC;gBACd,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI;gBAC5B,SAAS,EAAE,GAAG,EAAE;oBACd,IAAI,CAAC,OAAO,EAAE,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;gBAC3F,CAAC;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,GAAG,EAAE;YAC/B,IAAI,CAAC,UAAU,CAAC;gBACd,KAAK,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI;gBAChC,SAAS,EAAE,GAAG,EAAE;oBACd,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;gBACxF,CAAC;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,OAAwB,EAAE,UAA4B,EAAE,EAAE;YACnF,IAAI,CAAC,UAAU,CAAC;gBACd,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI;gBAC3B,SAAS,EAAE,GAAG,EAAE;oBACd,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;gBACtE,CAAC;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,IAAI,EAAE,EAAE,GAAG,EAAE;YAC7D,aAAa,CAAC;gBACZ,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,KAAK,EAAE,MAAM;gBACb,sKAAsK;gBACtK,SAAS,EAAE,CAAC,KAAK,IAAI,EAAE,CACrB,IAAI,CAAC,MAAM,EAAE,CAAC;oBACZ,UAAU,EAAE,IAAI,CAAC,UAAU;oBAC3B,MAAM,EAAE,IAAI,CAAC,MAAO;oBACpB,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,SAAS,EAAE,IAAI,CAAC,SAAS;oBACzB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;iBACxC,CAAC,CAAC,EAAE;aACR,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED,8FAA8F;IACtF,UAAU,CAAC,IAA8C;QAC/D,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;QAElC,IAAI,CAAC;YACH,SAAS,EAAE,CAAC;QACd,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,mCAAmC,EAAE,KAAK,CAAC,CAAC;QAC3E,CAAC;IACH,CAAC;IAED,UAAU;QACR,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,IAAI,CAAC,MAAM;iBACR,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;iBACzB,IAAI,CAAC,wCAAwC,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YACnE,OAAO;QACT,CAAC;QAED,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC;QAErB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACnB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,kCAAkC,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IAClG,CAAC;IAED,WAAW;QACT,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;CACF","sourcesContent":["import { type ValueOrPromise } from '@/common';\nimport { BaseHelper } from '@/modules/base';\nimport { voidExecution } from '@/utilities/promise.utility';\nimport dgram from 'node:dgram';\n\ninterface INetworkUdpClientProps {\n identifier: string;\n\n host?: string;\n port: number;\n reuseAddr?: boolean;\n\n multicastAddress?: {\n groups?: Array<string>;\n interface?: string;\n };\n\n onConnected?: (opts: { identifier: string; host?: string; port: number }) => void;\n onData?: (opts: {\n identifier: string;\n message: string | Buffer;\n remoteInfo: dgram.RemoteInfo;\n }) => void;\n onClosed?: (opts: { identifier: string; host?: string; port: number }) => void;\n onError?: (opts: { identifier: string; host?: string; port: number; error: Error }) => void;\n onBind?: (opts: {\n identifier: string;\n socket: dgram.Socket;\n host?: string;\n port: number;\n reuseAddr?: boolean;\n multicastAddress?: { groups?: Array<string>; interface?: string };\n }) => ValueOrPromise<void>;\n}\n\nexport class NetworkUdpClient extends BaseHelper {\n private host?: string;\n private port: number;\n private reuseAddr?: boolean;\n\n private multicastAddress?: {\n groups?: Array<string>;\n interface?: string;\n };\n\n private onConnected: (opts: { identifier: string; host?: string; port: number }) => void;\n private onData: (opts: {\n identifier: string;\n message: string | Buffer;\n remoteInfo: dgram.RemoteInfo;\n }) => void;\n private onClosed?: (opts: { identifier: string; host?: string; port: number }) => void;\n private onError?: (opts: {\n identifier: string;\n host?: string;\n port: number;\n error: Error;\n }) => void;\n private onBind?: (opts: {\n identifier: string;\n socket: dgram.Socket;\n host?: string;\n port: number;\n reuseAddr?: boolean;\n multicastAddress?: { groups?: Array<string>; interface?: string };\n }) => ValueOrPromise<void>;\n\n private client?: dgram.Socket | null;\n\n constructor(opts: INetworkUdpClientProps) {\n super({ scope: NetworkUdpClient.name, identifier: opts.identifier });\n\n this.host = opts.host;\n this.port = opts.port;\n this.reuseAddr = opts.reuseAddr;\n this.multicastAddress = opts.multicastAddress;\n\n this.onConnected = opts?.onConnected ?? this.handleConnected;\n this.onData = opts?.onData ?? this.handleData;\n this.onClosed = opts?.onClosed ?? this.handleClosed;\n this.onError = opts?.onError ?? this.handleError;\n this.onBind = opts?.onBind;\n }\n\n static newInstance(opts: INetworkUdpClientProps) {\n return new NetworkUdpClient(opts);\n }\n\n getClient() {\n return this.client;\n }\n\n handleConnected() {\n this.logger\n .for(this.handleConnected.name)\n .info('[%s] Successfully bind connection | Options: %j', this.identifier, {\n host: this.host,\n port: this.port,\n multicastAddress: this.multicastAddress,\n });\n }\n\n handleData(opts: { identifier: string; message: string | Buffer; remoteInfo: dgram.RemoteInfo }) {\n this.logger\n .for(this.handleData.name)\n .info('[%s][%s:%d][<==] Raw: %s', this.identifier, this.host, this.port, {\n message: opts.message,\n remoteInfo: opts.remoteInfo,\n });\n }\n\n handleClosed() {\n this.logger\n .for(this.handleClosed.name)\n .info('[%s] Closed connection UDP Server | Options: %j', this.identifier, {\n host: this.host,\n port: this.port,\n multicastAddress: this.multicastAddress,\n });\n }\n\n handleError(opts: { identifier: string; error: Error }) {\n this.logger.for(this.handleError.name).error(\n '[%s] Connection error | Options: %j | Error: %s',\n this.identifier,\n {\n host: this.host,\n port: this.port,\n },\n opts.error,\n );\n }\n\n connect() {\n if (this.client) {\n this.logger\n .for(this.connect.name)\n .info('[%s] UdpClient is already initialized!', this.identifier);\n return;\n }\n\n // Port 0 is a VALID request for an OS assigned port - only a missing / negative port is invalid.\n if (!Number.isInteger(this.port) || this.port < 0) {\n this.logger\n .for(this.connect.name)\n .info(\n '[%s] Cannot init UDP Client with invalid port | Port: %s',\n this.identifier,\n this.port,\n );\n return;\n }\n\n this.logger\n .for(this.connect.name)\n .info(\n '[%s] New network udp client | Host: %s | Port: %s | multicastAddress: %j',\n this.identifier,\n this.host,\n this.port,\n this.multicastAddress,\n );\n\n this.client = dgram.createSocket({ type: 'udp4', reuseAddr: this.reuseAddr });\n this.client.on('close', () => {\n this.invokeHook({\n scope: this.handleClosed.name,\n execution: () => {\n this.onClosed?.({ identifier: this.identifier, host: this.host, port: this.port });\n },\n });\n });\n\n this.client.on('error', error => {\n this.invokeHook({\n scope: this.handleError.name,\n execution: () => {\n this.onError?.({ identifier: this.identifier, host: this.host, port: this.port, error });\n },\n });\n });\n\n this.client.on('listening', () => {\n this.invokeHook({\n scope: this.handleConnected.name,\n execution: () => {\n this.onConnected?.({ identifier: this.identifier, host: this.host, port: this.port });\n },\n });\n });\n\n this.client.on('message', (message: string | Buffer, remoteInfo: dgram.RemoteInfo) => {\n this.invokeHook({\n scope: this.handleData.name,\n execution: () => {\n this.onData?.({ identifier: this.identifier, message, remoteInfo });\n },\n });\n });\n\n this.client.bind({ port: this.port, address: this.host }, () => {\n voidExecution({\n logger: this.logger,\n scope: 'bind',\n // The async wrapper turns a SYNCHRONOUS throw from onBind into a rejection; calling it bare would throw out of the dgram listening listener as an uncaught exception.\n execution: (async () =>\n this.onBind?.({\n identifier: this.identifier,\n socket: this.client!,\n host: this.host,\n port: this.port,\n reuseAddr: this.reuseAddr,\n multicastAddress: this.multicastAddress,\n }))(),\n });\n });\n }\n\n // Hooks run inside dgram event listeners: a synchronous throw there is an uncaught exception.\n private invokeHook(opts: { scope: string; execution: () => void }) {\n const { scope, execution } = opts;\n\n try {\n execution();\n } catch (error) {\n this.logger.for(scope).error('Hook execution FAILED | Error: %s', error);\n }\n }\n\n disconnect() {\n if (!this.client) {\n this.logger\n .for(this.disconnect.name)\n .info('[%s] UdpClient is not initialized yet!', this.identifier);\n return;\n }\n\n this.client?.close();\n\n this.client = null;\n this.logger.for(this.disconnect.name).info('UdpClient is destroyed! | ID: %s', this.identifier);\n }\n\n isConnected() {\n return this.client;\n }\n}\n"]}
1
+ {"version":3,"file":"network-udp-client.helper.js","sourceRoot":"","sources":["../../../../../src/modules/network/udp-socket/network-udp-client.helper.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,KAAK,MAAM,YAAY,CAAC;AAgC/B,MAAM,OAAO,gBAAiB,SAAQ,UAAU;IAkC9C,YAAY,IAA4B;QACtC,KAAK,CAAC,EAAE,KAAK,EAAE,gBAAgB,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;QAErE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACtB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACtB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAChC,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAE9C,IAAI,CAAC,WAAW,GAAG,IAAI,EAAE,WAAW,IAAI,IAAI,CAAC,eAAe,CAAC;QAC7D,IAAI,CAAC,MAAM,GAAG,IAAI,EAAE,MAAM,IAAI,IAAI,CAAC,UAAU,CAAC;QAC9C,IAAI,CAAC,QAAQ,GAAG,IAAI,EAAE,QAAQ,IAAI,IAAI,CAAC,YAAY,CAAC;QACpD,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,OAAO,IAAI,IAAI,CAAC,WAAW,CAAC;QACjD,IAAI,CAAC,MAAM,GAAG,IAAI,EAAE,MAAM,CAAC;IAC7B,CAAC;IAED,MAAM,CAAC,WAAW,CAAC,IAA4B;QAC7C,OAAO,IAAI,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,eAAe;QACb,IAAI,CAAC,MAAM;aACR,GAAG,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC;aAC9B,IAAI,CAAC,iDAAiD,EAAE,IAAI,CAAC,UAAU,EAAE;YACxE,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;SACxC,CAAC,CAAC;IACP,CAAC;IAED,UAAU,CAAC,IAAoF;QAC7F,IAAI,CAAC,MAAM;aACR,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;aACzB,IAAI,CAAC,0BAA0B,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE;YACvE,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,UAAU,EAAE,IAAI,CAAC,UAAU;SAC5B,CAAC,CAAC;IACP,CAAC;IAED,YAAY;QACV,IAAI,CAAC,MAAM;aACR,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;aAC3B,IAAI,CAAC,iDAAiD,EAAE,IAAI,CAAC,UAAU,EAAE;YACxE,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;SACxC,CAAC,CAAC;IACP,CAAC;IAED,WAAW,CAAC,IAA0C;QACpD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,CAC1C,iDAAiD,EACjD,IAAI,CAAC,UAAU,EACf;YACE,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,EACD,IAAI,CAAC,KAAK,CACX,CAAC;IACJ,CAAC;IAED,OAAO;QACL,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,IAAI,CAAC,MAAM;iBACR,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;iBACtB,IAAI,CAAC,wCAAwC,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YACnE,OAAO;QACT,CAAC;QAED,iGAAiG;QACjG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;YAClD,IAAI,CAAC,MAAM;iBACR,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;iBACtB,IAAI,CACH,0DAA0D,EAC1D,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,IAAI,CACV,CAAC;YACJ,OAAO;QACT,CAAC;QAED,IAAI,CAAC,MAAM;aACR,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;aACtB,IAAI,CACH,0EAA0E,EAC1E,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,gBAAgB,CACtB,CAAC;QAEJ,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;QAC9E,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YAC3B,IAAI,CAAC,UAAU,CAAC;gBACd,KAAK,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI;gBAC7B,SAAS,EAAE,GAAG,EAAE;oBACd,IAAI,CAAC,QAAQ,EAAE,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;gBACrF,CAAC;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAChC,IAAI,CAAC,UAAU,CAAC;gBACd,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI;gBAC5B,SAAS,EAAE,GAAG,EAAE;oBACd,IAAI,CAAC,OAAO,EAAE,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;gBAC3F,CAAC;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,GAAG,EAAE;YAC/B,IAAI,CAAC,UAAU,CAAC;gBACd,KAAK,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI;gBAChC,SAAS,EAAE,GAAG,EAAE;oBACd,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;gBACxF,CAAC;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,OAAwB,EAAE,UAA4B,EAAE,EAAE;YACnF,IAAI,CAAC,UAAU,CAAC;gBACd,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI;gBAC3B,SAAS,EAAE,GAAG,EAAE;oBACd,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;gBACtE,CAAC;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,IAAI,EAAE,EAAE,GAAG,EAAE;YAC7D,aAAa,CAAC;gBACZ,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,KAAK,EAAE,MAAM;gBACb,sKAAsK;gBACtK,SAAS,EAAE,CAAC,KAAK,IAAI,EAAE,CACrB,IAAI,CAAC,MAAM,EAAE,CAAC;oBACZ,UAAU,EAAE,IAAI,CAAC,UAAU;oBAC3B,MAAM,EAAE,IAAI,CAAC,MAAO;oBACpB,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,SAAS,EAAE,IAAI,CAAC,SAAS;oBACzB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;iBACxC,CAAC,CAAC,EAAE;aACR,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED,8FAA8F;IACtF,UAAU,CAAC,IAA8C;QAC/D,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;QAElC,IAAI,CAAC;YACH,SAAS,EAAE,CAAC;QACd,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,mCAAmC,EAAE,KAAK,CAAC,CAAC;QAC3E,CAAC;IACH,CAAC;IAED,UAAU;QACR,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,IAAI,CAAC,MAAM;iBACR,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;iBACzB,IAAI,CAAC,wCAAwC,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YACnE,OAAO;QACT,CAAC;QAED,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC;QAErB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACnB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,kCAAkC,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IAClG,CAAC;IAED,WAAW;QACT,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;CACF","sourcesContent":["import { type ValueOrPromise } from '@/common';\nimport { BaseHelper } from '@/modules/base';\nimport { voidExecution } from '@/utilities/promise.utility';\nimport dgram from 'node:dgram';\n\ninterface INetworkUdpClientProps {\n identifier: string;\n\n host?: string;\n port: number;\n reuseAddr?: boolean;\n\n multicastAddress?: {\n groups?: Array<string>;\n interface?: string;\n };\n\n onConnected?: (opts: { identifier: string; host?: string; port: number }) => void;\n onData?: (opts: {\n identifier: string;\n message: string | Buffer;\n remoteInfo: dgram.RemoteInfo;\n }) => void;\n onClosed?: (opts: { identifier: string; host?: string; port: number }) => void;\n onError?: (opts: { identifier: string; host?: string; port: number; error: Error }) => void;\n onBind?: (opts: {\n identifier: string;\n socket: dgram.Socket;\n host?: string;\n port: number;\n reuseAddr?: boolean;\n multicastAddress?: { groups?: Array<string>; interface?: string };\n }) => ValueOrPromise<void>;\n}\n\nexport class NetworkUdpClient extends BaseHelper {\n private host?: string;\n private port: number;\n private reuseAddr?: boolean;\n\n private multicastAddress?: {\n groups?: Array<string>;\n interface?: string;\n };\n\n private onConnected: (opts: { identifier: string; host?: string; port: number }) => void;\n private onData: (opts: {\n identifier: string;\n message: string | Buffer;\n remoteInfo: dgram.RemoteInfo;\n }) => void;\n private onClosed?: (opts: { identifier: string; host?: string; port: number }) => void;\n private onError?: (opts: {\n identifier: string;\n host?: string;\n port: number;\n error: Error;\n }) => void;\n private onBind?: (opts: {\n identifier: string;\n socket: dgram.Socket;\n host?: string;\n port: number;\n reuseAddr?: boolean;\n multicastAddress?: { groups?: Array<string>; interface?: string };\n }) => ValueOrPromise<void>;\n\n private client?: dgram.Socket | null;\n\n constructor(opts: INetworkUdpClientProps) {\n super({ scope: NetworkUdpClient.name, identifier: opts.identifier });\n\n this.host = opts.host;\n this.port = opts.port;\n this.reuseAddr = opts.reuseAddr;\n this.multicastAddress = opts.multicastAddress;\n\n this.onConnected = opts?.onConnected ?? this.handleConnected;\n this.onData = opts?.onData ?? this.handleData;\n this.onClosed = opts?.onClosed ?? this.handleClosed;\n this.onError = opts?.onError ?? this.handleError;\n this.onBind = opts?.onBind;\n }\n\n static newInstance(opts: INetworkUdpClientProps) {\n return new NetworkUdpClient(opts);\n }\n\n getClient() {\n return this.client;\n }\n\n handleConnected() {\n this.logger\n .for(this.handleConnected.name)\n .info('[%s] Successfully bind connection | Options: %j', this.identifier, {\n host: this.host,\n port: this.port,\n multicastAddress: this.multicastAddress,\n });\n }\n\n handleData(opts: { identifier: string; message: string | Buffer; remoteInfo: dgram.RemoteInfo }) {\n this.logger\n .for(this.handleData.name)\n .info('[%s][%s:%d][<==] Raw: %s', this.identifier, this.host, this.port, {\n message: opts.message,\n remoteInfo: opts.remoteInfo,\n });\n }\n\n handleClosed() {\n this.logger\n .for(this.handleClosed.name)\n .info('[%s] Closed connection UDP Server | Options: %j', this.identifier, {\n host: this.host,\n port: this.port,\n multicastAddress: this.multicastAddress,\n });\n }\n\n handleError(opts: { identifier: string; error: Error }) {\n this.logger.for(this.handleError.name).error(\n '[%s] Connection error | Options: %j | Error: %s',\n this.identifier,\n {\n host: this.host,\n port: this.port,\n },\n opts.error,\n );\n }\n\n connect() {\n if (this.client) {\n this.logger\n .for(this.connect.name)\n .info('[%s] UdpClient is already initialized!', this.identifier);\n return;\n }\n\n // Port 0 is a VALID request for an OS assigned port - only a missing / negative port is invalid.\n if (!Number.isInteger(this.port) || this.port < 0) {\n this.logger\n .for(this.connect.name)\n .info(\n '[%s] Cannot init UDP Client with invalid port | Port: %s',\n this.identifier,\n this.port,\n );\n return;\n }\n\n this.logger\n .for(this.connect.name)\n .info(\n '[%s] New network udp client | Host: %s | Port: %s | multicastAddress: %j',\n this.identifier,\n this.host,\n this.port,\n this.multicastAddress,\n );\n\n this.client = dgram.createSocket({ type: 'udp4', reuseAddr: this.reuseAddr });\n this.client.on('close', () => {\n this.invokeHook({\n scope: this.handleClosed.name,\n execution: () => {\n this.onClosed?.({ identifier: this.identifier, host: this.host, port: this.port });\n },\n });\n });\n\n this.client.on('error', (error) => {\n this.invokeHook({\n scope: this.handleError.name,\n execution: () => {\n this.onError?.({ identifier: this.identifier, host: this.host, port: this.port, error });\n },\n });\n });\n\n this.client.on('listening', () => {\n this.invokeHook({\n scope: this.handleConnected.name,\n execution: () => {\n this.onConnected?.({ identifier: this.identifier, host: this.host, port: this.port });\n },\n });\n });\n\n this.client.on('message', (message: string | Buffer, remoteInfo: dgram.RemoteInfo) => {\n this.invokeHook({\n scope: this.handleData.name,\n execution: () => {\n this.onData?.({ identifier: this.identifier, message, remoteInfo });\n },\n });\n });\n\n this.client.bind({ port: this.port, address: this.host }, () => {\n voidExecution({\n logger: this.logger,\n scope: 'bind',\n // The async wrapper turns a SYNCHRONOUS throw from onBind into a rejection; calling it bare would throw out of the dgram listening listener as an uncaught exception.\n execution: (async () =>\n this.onBind?.({\n identifier: this.identifier,\n socket: this.client!,\n host: this.host,\n port: this.port,\n reuseAddr: this.reuseAddr,\n multicastAddress: this.multicastAddress,\n }))(),\n });\n });\n }\n\n // Hooks run inside dgram event listeners: a synchronous throw there is an uncaught exception.\n private invokeHook(opts: { scope: string; execution: () => void }) {\n const { scope, execution } = opts;\n\n try {\n execution();\n } catch (error) {\n this.logger.for(scope).error('Hook execution FAILED | Error: %s', error);\n }\n }\n\n disconnect() {\n if (!this.client) {\n this.logger\n .for(this.disconnect.name)\n .info('[%s] UdpClient is not initialized yet!', this.identifier);\n return;\n }\n\n this.client?.close();\n\n this.client = null;\n this.logger.for(this.disconnect.name).info('UdpClient is destroyed! | ID: %s', this.identifier);\n }\n\n isConnected() {\n return this.client;\n }\n}\n"]}
@@ -1,4 +1,4 @@
1
- import { type AnyObject } from '../../../common/types/index.js';
1
+ import { type AnyObject, type TConstValue } from '../../../common/types/index.js';
2
2
  /** The punctuation of a query string, named so a reader sees the role rather than the character. */
3
3
  export declare class QueryStringSeparators {
4
4
  /** Between the path and the first pair. */
@@ -8,6 +8,27 @@ export declare class QueryStringSeparators {
8
8
  /** Between a name and its value. */
9
9
  static readonly ASSIGN = "=";
10
10
  }
11
+ /** What a `null` or `undefined` value becomes. */
12
+ export declare class QueryStringNullishModes {
13
+ /** An empty value (`a=`): what `node:querystring` does. */
14
+ static readonly EMPTY = "empty";
15
+ /** The pair is left out. */
16
+ static readonly SKIP = "skip";
17
+ }
18
+ export type TQueryStringNullishMode = TConstValue<typeof QueryStringNullishModes>;
19
+ /** What an object or an array value becomes. */
20
+ export declare class QueryStringNestedModes {
21
+ /** An empty value (an array repeats its key instead): what `node:querystring` does. */
22
+ static readonly DROP = "drop";
23
+ /** One JSON-encoded parameter (`ids=[1,2]`, `filter={"where":{}}`), the shape a JSON filter travels in. */
24
+ static readonly JSON = "json";
25
+ }
26
+ export type TQueryStringNestedMode = TConstValue<typeof QueryStringNestedModes>;
27
+ /** How {@link toQueryString} treats the values `node:querystring` has no answer for. Both default to its behavior. */
28
+ export interface IQueryStringOptions {
29
+ nullish?: TQueryStringNullishMode;
30
+ nested?: TQueryStringNestedMode;
31
+ }
11
32
  /**
12
33
  * `node:querystring`'s `stringify`, written out so nothing on the HTTP path carries a node builtin -
13
34
  * that one import is what kept the whole network layer out of a browser bundle.
@@ -19,8 +40,12 @@ export declare class QueryStringSeparators {
19
40
  * reading "undefined".
20
41
  *
21
42
  * Diffed against `node:querystring` across 22 shapes with zero mismatches.
43
+ *
44
+ * `nullish: 'skip'` leaves a null or undefined pair out. `nested: 'json'` sends an object or an
45
+ * array as ONE JSON parameter instead (an array does not repeat its key), so a filter object survives
46
+ * the trip. The defaults keep the behavior above.
22
47
  */
23
48
  export declare const toQueryString: (opts: {
24
49
  params: AnyObject;
25
- }) => string;
50
+ } & IQueryStringOptions) => string;
26
51
  //# sourceMappingURL=query-string.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"query-string.d.ts","sourceRoot":"","sources":["../../../../../src/modules/network/utilities/query-string.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD,oGAAoG;AACpG,qBAAa,qBAAqB;IAChC,2CAA2C;IAC3C,MAAM,CAAC,QAAQ,CAAC,KAAK,OAAO;IAC5B,yBAAyB;IACzB,MAAM,CAAC,QAAQ,CAAC,IAAI,OAAO;IAC3B,oCAAoC;IACpC,MAAM,CAAC,QAAQ,CAAC,MAAM,OAAO;CAC9B;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,aAAa,GAAI,MAAM;IAAE,MAAM,EAAE,SAAS,CAAA;CAAE,KAAG,MA4B3D,CAAC"}
1
+ {"version":3,"file":"query-string.d.ts","sourceRoot":"","sources":["../../../../../src/modules/network/utilities/query-string.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,SAAS,EAAE,KAAK,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAElE,oGAAoG;AACpG,qBAAa,qBAAqB;IAChC,2CAA2C;IAC3C,MAAM,CAAC,QAAQ,CAAC,KAAK,OAAO;IAC5B,yBAAyB;IACzB,MAAM,CAAC,QAAQ,CAAC,IAAI,OAAO;IAC3B,oCAAoC;IACpC,MAAM,CAAC,QAAQ,CAAC,MAAM,OAAO;CAC9B;AAED,kDAAkD;AAClD,qBAAa,uBAAuB;IAClC,2DAA2D;IAC3D,MAAM,CAAC,QAAQ,CAAC,KAAK,WAAW;IAChC,4BAA4B;IAC5B,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAU;CAC/B;AACD,MAAM,MAAM,uBAAuB,GAAG,WAAW,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAElF,gDAAgD;AAChD,qBAAa,sBAAsB;IACjC,uFAAuF;IACvF,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAU;IAC9B,2GAA2G;IAC3G,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAU;CAC/B;AACD,MAAM,MAAM,sBAAsB,GAAG,WAAW,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEhF,sHAAsH;AACtH,MAAM,WAAW,mBAAmB;IAClC,OAAO,CAAC,EAAE,uBAAuB,CAAC;IAClC,MAAM,CAAC,EAAE,sBAAsB,CAAC;CACjC;AAED;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,aAAa,GAAI,MAAM;IAAE,MAAM,EAAE,SAAS,CAAA;CAAE,GAAG,mBAAmB,KAAG,MAkDjF,CAAC"}