@venizia/ignis-helpers 0.4.0 → 0.4.2

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 (273) hide show
  1. package/dist/cjs/common/constants/duration.d.ts +4 -1
  2. package/dist/cjs/common/constants/duration.d.ts.map +1 -1
  3. package/dist/cjs/common/constants/duration.js +13 -8
  4. package/dist/cjs/common/constants/duration.js.map +1 -1
  5. package/dist/cjs/common/redact.js +1 -1
  6. package/dist/cjs/common/redact.js.map +1 -1
  7. package/dist/cjs/modules/base.js +1 -1
  8. package/dist/cjs/modules/base.js.map +1 -1
  9. package/dist/cjs/modules/crypto/algorithms/aes.algorithm.js +1 -1
  10. package/dist/cjs/modules/crypto/algorithms/aes.algorithm.js.map +1 -1
  11. package/dist/cjs/modules/env/app-env.d.ts.map +1 -1
  12. package/dist/cjs/modules/env/app-env.js +1 -1
  13. package/dist/cjs/modules/env/app-env.js.map +1 -1
  14. package/dist/cjs/modules/logger/common/constants.js +1 -1
  15. package/dist/cjs/modules/logger/common/constants.js.map +1 -1
  16. package/dist/cjs/modules/logger/factory.js +1 -1
  17. package/dist/cjs/modules/logger/factory.js.map +1 -1
  18. package/dist/cjs/modules/logger/formatting/deep-splat.js +1 -1
  19. package/dist/cjs/modules/logger/formatting/deep-splat.js.map +1 -1
  20. package/dist/cjs/modules/logger/formatting/error-prettier.js +4 -4
  21. package/dist/cjs/modules/logger/formatting/error-prettier.js.map +1 -1
  22. package/dist/cjs/modules/logger/hf/flusher.js +3 -3
  23. package/dist/cjs/modules/logger/hf/flusher.js.map +1 -1
  24. package/dist/cjs/modules/logger/hf/logger.d.ts.map +1 -1
  25. package/dist/cjs/modules/logger/hf/logger.js +3 -1
  26. package/dist/cjs/modules/logger/hf/logger.js.map +1 -1
  27. package/dist/cjs/modules/logger/resolver.js +3 -3
  28. package/dist/cjs/modules/logger/resolver.js.map +1 -1
  29. package/dist/cjs/modules/logger/winston/formatters/deep-splat.js +1 -1
  30. package/dist/cjs/modules/logger/winston/formatters/deep-splat.js.map +1 -1
  31. package/dist/cjs/modules/logger/winston/logger-factory.js +1 -1
  32. package/dist/cjs/modules/logger/winston/logger-factory.js.map +1 -1
  33. package/dist/cjs/modules/logger/winston/transports/dgram.transport.js +2 -2
  34. package/dist/cjs/modules/logger/winston/transports/dgram.transport.js.map +1 -1
  35. package/dist/cjs/modules/network/http-request/fetcher/axios-fetcher.js +1 -1
  36. package/dist/cjs/modules/network/http-request/fetcher/axios-fetcher.js.map +1 -1
  37. package/dist/cjs/modules/network/http-request/fetcher/base-fetcher.d.ts +17 -14
  38. package/dist/cjs/modules/network/http-request/fetcher/base-fetcher.d.ts.map +1 -1
  39. package/dist/cjs/modules/network/http-request/fetcher/base-fetcher.js +3 -0
  40. package/dist/cjs/modules/network/http-request/fetcher/base-fetcher.js.map +1 -1
  41. package/dist/cjs/modules/network/http-request/fetcher/node-fetcher.d.ts +13 -4
  42. package/dist/cjs/modules/network/http-request/fetcher/node-fetcher.d.ts.map +1 -1
  43. package/dist/cjs/modules/network/http-request/fetcher/node-fetcher.js +34 -11
  44. package/dist/cjs/modules/network/http-request/fetcher/node-fetcher.js.map +1 -1
  45. package/dist/cjs/modules/network/tcp-socket/base-tcp-client.helper.js +1 -1
  46. package/dist/cjs/modules/network/tcp-socket/base-tcp-client.helper.js.map +1 -1
  47. package/dist/cjs/modules/network/tcp-socket/base-tcp-server.helper.d.ts.map +1 -1
  48. package/dist/cjs/modules/network/tcp-socket/base-tcp-server.helper.js +7 -6
  49. package/dist/cjs/modules/network/tcp-socket/base-tcp-server.helper.js.map +1 -1
  50. package/dist/cjs/modules/network/udp-socket/network-udp-client.helper.js +1 -1
  51. package/dist/cjs/modules/network/udp-socket/network-udp-client.helper.js.map +1 -1
  52. package/dist/cjs/modules/network/utilities/query-string.d.ts +27 -2
  53. package/dist/cjs/modules/network/utilities/query-string.d.ts.map +1 -1
  54. package/dist/cjs/modules/network/utilities/query-string.js +34 -2
  55. package/dist/cjs/modules/network/utilities/query-string.js.map +1 -1
  56. package/dist/cjs/modules/network/utilities/url-safety/ingest.js +1 -1
  57. package/dist/cjs/modules/network/utilities/url-safety/ingest.js.map +1 -1
  58. package/dist/cjs/modules/network/utilities/url-safety/policy.js +1 -1
  59. package/dist/cjs/modules/network/utilities/url-safety/policy.js.map +1 -1
  60. package/dist/cjs/modules/pool/abstract.js +4 -4
  61. package/dist/cjs/modules/pool/abstract.js.map +1 -1
  62. package/dist/cjs/modules/queue/bullmq/helper.js +2 -2
  63. package/dist/cjs/modules/queue/bullmq/helper.js.map +1 -1
  64. package/dist/cjs/modules/queue/kafka/bundler/platformatic-require.plugin.js.map +1 -1
  65. package/dist/cjs/modules/queue/kafka/bundler/platformatic-wasm.plugin.js +1 -1
  66. package/dist/cjs/modules/queue/kafka/bundler/platformatic-wasm.plugin.js.map +1 -1
  67. package/dist/cjs/modules/queue/kafka/consumer.js +2 -2
  68. package/dist/cjs/modules/queue/kafka/consumer.js.map +1 -1
  69. package/dist/cjs/modules/queue/mqtt/helper.js +4 -4
  70. package/dist/cjs/modules/queue/mqtt/helper.js.map +1 -1
  71. package/dist/cjs/modules/redis/base/abstract.helper.js +4 -4
  72. package/dist/cjs/modules/redis/base/abstract.helper.js.map +1 -1
  73. package/dist/cjs/modules/redis/cluster/cluster.helper.js +1 -1
  74. package/dist/cjs/modules/redis/cluster/cluster.helper.js.map +1 -1
  75. package/dist/cjs/modules/redis/sentinel/sentinel.helper.js +1 -1
  76. package/dist/cjs/modules/redis/sentinel/sentinel.helper.js.map +1 -1
  77. package/dist/cjs/modules/secrets/base/abstract.helper.d.ts.map +1 -1
  78. package/dist/cjs/modules/secrets/base/abstract.helper.js +7 -3
  79. package/dist/cjs/modules/secrets/base/abstract.helper.js.map +1 -1
  80. package/dist/cjs/modules/secrets/hashicorp/hashicorp.helper.js +2 -2
  81. package/dist/cjs/modules/secrets/hashicorp/hashicorp.helper.js.map +1 -1
  82. package/dist/cjs/modules/socket/socket-io/browser.d.ts +5 -0
  83. package/dist/cjs/modules/socket/socket-io/browser.d.ts.map +1 -0
  84. package/dist/cjs/modules/socket/socket-io/browser.js +21 -0
  85. package/dist/cjs/modules/socket/socket-io/browser.js.map +1 -0
  86. package/dist/cjs/modules/socket/socket-io/client/browser-helper.d.ts +61 -0
  87. package/dist/cjs/modules/socket/socket-io/client/browser-helper.d.ts.map +1 -0
  88. package/dist/cjs/modules/socket/socket-io/client/browser-helper.js +250 -0
  89. package/dist/cjs/modules/socket/socket-io/client/browser-helper.js.map +1 -0
  90. package/dist/cjs/modules/socket/socket-io/client/helper.d.ts +8 -51
  91. package/dist/cjs/modules/socket/socket-io/client/helper.d.ts.map +1 -1
  92. package/dist/cjs/modules/socket/socket-io/client/helper.js +12 -230
  93. package/dist/cjs/modules/socket/socket-io/client/helper.js.map +1 -1
  94. package/dist/cjs/modules/socket/socket-io/server/helper.js +5 -5
  95. package/dist/cjs/modules/socket/socket-io/server/helper.js.map +1 -1
  96. package/dist/cjs/modules/socket/websocket/server/delivery.js +2 -2
  97. package/dist/cjs/modules/socket/websocket/server/delivery.js.map +1 -1
  98. package/dist/cjs/modules/socket/websocket/server/helper.js +4 -4
  99. package/dist/cjs/modules/socket/websocket/server/helper.js.map +1 -1
  100. package/dist/cjs/modules/storage/base.js +3 -3
  101. package/dist/cjs/modules/storage/base.js.map +1 -1
  102. package/dist/cjs/modules/storage/bun-s3/helper.js +1 -1
  103. package/dist/cjs/modules/storage/bun-s3/helper.js.map +1 -1
  104. package/dist/cjs/modules/storage/bun-s3/utility.js +6 -6
  105. package/dist/cjs/modules/storage/bun-s3/utility.js.map +1 -1
  106. package/dist/cjs/modules/storage/common/errors.js +1 -1
  107. package/dist/cjs/modules/storage/common/errors.js.map +1 -1
  108. package/dist/cjs/modules/storage/minio/helper.js +4 -4
  109. package/dist/cjs/modules/storage/minio/helper.js.map +1 -1
  110. package/dist/cjs/modules/temporal/abstract.js +5 -5
  111. package/dist/cjs/modules/temporal/abstract.js.map +1 -1
  112. package/dist/cjs/modules/temporal/adapters/intl.d.ts.map +1 -1
  113. package/dist/cjs/modules/temporal/adapters/intl.js +3 -1
  114. package/dist/cjs/modules/temporal/adapters/intl.js.map +1 -1
  115. package/dist/cjs/modules/temporal/locale/locale.js +4 -4
  116. package/dist/cjs/modules/temporal/locale/locale.js.map +1 -1
  117. package/dist/cjs/modules/tree/builder.js +2 -2
  118. package/dist/cjs/modules/tree/builder.js.map +1 -1
  119. package/dist/cjs/modules/uid/opaque.js +2 -2
  120. package/dist/cjs/modules/uid/opaque.js.map +1 -1
  121. package/dist/cjs/modules/uid/uuid/v5.js +1 -1
  122. package/dist/cjs/modules/uid/uuid/v5.js.map +1 -1
  123. package/dist/cjs/modules/worker-thread/bus/base.js +4 -4
  124. package/dist/cjs/modules/worker-thread/bus/base.js.map +1 -1
  125. package/dist/cjs/modules/worker-thread/thread/base.js +2 -2
  126. package/dist/cjs/modules/worker-thread/thread/base.js.map +1 -1
  127. package/dist/cjs/modules/worker-thread/worker/base.js +4 -4
  128. package/dist/cjs/modules/worker-thread/worker/base.js.map +1 -1
  129. package/dist/cjs/utilities/parse.utility.js +4 -4
  130. package/dist/cjs/utilities/parse.utility.js.map +1 -1
  131. package/dist/cjs/utilities/promise.utility.js +1 -1
  132. package/dist/cjs/utilities/promise.utility.js.map +1 -1
  133. package/dist/cjs/utilities/request.utility.js +1 -1
  134. package/dist/cjs/utilities/request.utility.js.map +1 -1
  135. package/dist/cjs/utilities/sleep.utility.js +1 -1
  136. package/dist/cjs/utilities/sleep.utility.js.map +1 -1
  137. package/dist/esm/common/constants/duration.d.ts +4 -1
  138. package/dist/esm/common/constants/duration.d.ts.map +1 -1
  139. package/dist/esm/common/constants/duration.js +13 -8
  140. package/dist/esm/common/constants/duration.js.map +1 -1
  141. package/dist/esm/common/redact.js +1 -1
  142. package/dist/esm/common/redact.js.map +1 -1
  143. package/dist/esm/modules/base.js +1 -1
  144. package/dist/esm/modules/base.js.map +1 -1
  145. package/dist/esm/modules/crypto/algorithms/aes.algorithm.js +1 -1
  146. package/dist/esm/modules/crypto/algorithms/aes.algorithm.js.map +1 -1
  147. package/dist/esm/modules/env/app-env.d.ts.map +1 -1
  148. package/dist/esm/modules/env/app-env.js +1 -1
  149. package/dist/esm/modules/env/app-env.js.map +1 -1
  150. package/dist/esm/modules/logger/common/constants.js +1 -1
  151. package/dist/esm/modules/logger/common/constants.js.map +1 -1
  152. package/dist/esm/modules/logger/factory.js +1 -1
  153. package/dist/esm/modules/logger/factory.js.map +1 -1
  154. package/dist/esm/modules/logger/formatting/deep-splat.js +1 -1
  155. package/dist/esm/modules/logger/formatting/deep-splat.js.map +1 -1
  156. package/dist/esm/modules/logger/formatting/error-prettier.js +4 -4
  157. package/dist/esm/modules/logger/formatting/error-prettier.js.map +1 -1
  158. package/dist/esm/modules/logger/hf/flusher.js +3 -3
  159. package/dist/esm/modules/logger/hf/flusher.js.map +1 -1
  160. package/dist/esm/modules/logger/hf/logger.d.ts.map +1 -1
  161. package/dist/esm/modules/logger/hf/logger.js +3 -1
  162. package/dist/esm/modules/logger/hf/logger.js.map +1 -1
  163. package/dist/esm/modules/logger/resolver.js +3 -3
  164. package/dist/esm/modules/logger/resolver.js.map +1 -1
  165. package/dist/esm/modules/logger/winston/formatters/deep-splat.js +1 -1
  166. package/dist/esm/modules/logger/winston/formatters/deep-splat.js.map +1 -1
  167. package/dist/esm/modules/logger/winston/logger-factory.js +1 -1
  168. package/dist/esm/modules/logger/winston/logger-factory.js.map +1 -1
  169. package/dist/esm/modules/logger/winston/transports/dgram.transport.js +2 -2
  170. package/dist/esm/modules/logger/winston/transports/dgram.transport.js.map +1 -1
  171. package/dist/esm/modules/network/http-request/fetcher/axios-fetcher.js +1 -1
  172. package/dist/esm/modules/network/http-request/fetcher/axios-fetcher.js.map +1 -1
  173. package/dist/esm/modules/network/http-request/fetcher/base-fetcher.d.ts +17 -14
  174. package/dist/esm/modules/network/http-request/fetcher/base-fetcher.d.ts.map +1 -1
  175. package/dist/esm/modules/network/http-request/fetcher/base-fetcher.js +3 -0
  176. package/dist/esm/modules/network/http-request/fetcher/base-fetcher.js.map +1 -1
  177. package/dist/esm/modules/network/http-request/fetcher/node-fetcher.d.ts +13 -4
  178. package/dist/esm/modules/network/http-request/fetcher/node-fetcher.d.ts.map +1 -1
  179. package/dist/esm/modules/network/http-request/fetcher/node-fetcher.js +36 -13
  180. package/dist/esm/modules/network/http-request/fetcher/node-fetcher.js.map +1 -1
  181. package/dist/esm/modules/network/tcp-socket/base-tcp-client.helper.js +1 -1
  182. package/dist/esm/modules/network/tcp-socket/base-tcp-client.helper.js.map +1 -1
  183. package/dist/esm/modules/network/tcp-socket/base-tcp-server.helper.d.ts.map +1 -1
  184. package/dist/esm/modules/network/tcp-socket/base-tcp-server.helper.js +7 -6
  185. package/dist/esm/modules/network/tcp-socket/base-tcp-server.helper.js.map +1 -1
  186. package/dist/esm/modules/network/udp-socket/network-udp-client.helper.js +1 -1
  187. package/dist/esm/modules/network/udp-socket/network-udp-client.helper.js.map +1 -1
  188. package/dist/esm/modules/network/utilities/query-string.d.ts +27 -2
  189. package/dist/esm/modules/network/utilities/query-string.d.ts.map +1 -1
  190. package/dist/esm/modules/network/utilities/query-string.js +31 -1
  191. package/dist/esm/modules/network/utilities/query-string.js.map +1 -1
  192. package/dist/esm/modules/network/utilities/url-safety/ingest.js +1 -1
  193. package/dist/esm/modules/network/utilities/url-safety/ingest.js.map +1 -1
  194. package/dist/esm/modules/network/utilities/url-safety/policy.js +1 -1
  195. package/dist/esm/modules/network/utilities/url-safety/policy.js.map +1 -1
  196. package/dist/esm/modules/pool/abstract.js +4 -4
  197. package/dist/esm/modules/pool/abstract.js.map +1 -1
  198. package/dist/esm/modules/queue/bullmq/helper.js +2 -2
  199. package/dist/esm/modules/queue/bullmq/helper.js.map +1 -1
  200. package/dist/esm/modules/queue/kafka/bundler/platformatic-require.plugin.js.map +1 -1
  201. package/dist/esm/modules/queue/kafka/bundler/platformatic-wasm.plugin.js +1 -1
  202. package/dist/esm/modules/queue/kafka/bundler/platformatic-wasm.plugin.js.map +1 -1
  203. package/dist/esm/modules/queue/kafka/consumer.js +2 -2
  204. package/dist/esm/modules/queue/kafka/consumer.js.map +1 -1
  205. package/dist/esm/modules/queue/mqtt/helper.js +4 -4
  206. package/dist/esm/modules/queue/mqtt/helper.js.map +1 -1
  207. package/dist/esm/modules/redis/base/abstract.helper.js +4 -4
  208. package/dist/esm/modules/redis/base/abstract.helper.js.map +1 -1
  209. package/dist/esm/modules/redis/cluster/cluster.helper.js +1 -1
  210. package/dist/esm/modules/redis/cluster/cluster.helper.js.map +1 -1
  211. package/dist/esm/modules/redis/sentinel/sentinel.helper.js +1 -1
  212. package/dist/esm/modules/redis/sentinel/sentinel.helper.js.map +1 -1
  213. package/dist/esm/modules/secrets/base/abstract.helper.d.ts.map +1 -1
  214. package/dist/esm/modules/secrets/base/abstract.helper.js +7 -3
  215. package/dist/esm/modules/secrets/base/abstract.helper.js.map +1 -1
  216. package/dist/esm/modules/secrets/hashicorp/hashicorp.helper.js +2 -2
  217. package/dist/esm/modules/secrets/hashicorp/hashicorp.helper.js.map +1 -1
  218. package/dist/esm/modules/socket/socket-io/browser.d.ts +5 -0
  219. package/dist/esm/modules/socket/socket-io/browser.d.ts.map +1 -0
  220. package/dist/esm/modules/socket/socket-io/browser.js +5 -0
  221. package/dist/esm/modules/socket/socket-io/browser.js.map +1 -0
  222. package/dist/esm/modules/socket/socket-io/client/browser-helper.d.ts +61 -0
  223. package/dist/esm/modules/socket/socket-io/client/browser-helper.d.ts.map +1 -0
  224. package/dist/esm/modules/socket/socket-io/client/browser-helper.js +246 -0
  225. package/dist/esm/modules/socket/socket-io/client/browser-helper.js.map +1 -0
  226. package/dist/esm/modules/socket/socket-io/client/helper.d.ts +8 -51
  227. package/dist/esm/modules/socket/socket-io/client/helper.d.ts.map +1 -1
  228. package/dist/esm/modules/socket/socket-io/client/helper.js +12 -230
  229. package/dist/esm/modules/socket/socket-io/client/helper.js.map +1 -1
  230. package/dist/esm/modules/socket/socket-io/server/helper.js +5 -5
  231. package/dist/esm/modules/socket/socket-io/server/helper.js.map +1 -1
  232. package/dist/esm/modules/socket/websocket/server/delivery.js +2 -2
  233. package/dist/esm/modules/socket/websocket/server/delivery.js.map +1 -1
  234. package/dist/esm/modules/socket/websocket/server/helper.js +4 -4
  235. package/dist/esm/modules/socket/websocket/server/helper.js.map +1 -1
  236. package/dist/esm/modules/storage/base.js +3 -3
  237. package/dist/esm/modules/storage/base.js.map +1 -1
  238. package/dist/esm/modules/storage/bun-s3/helper.js +1 -1
  239. package/dist/esm/modules/storage/bun-s3/helper.js.map +1 -1
  240. package/dist/esm/modules/storage/bun-s3/utility.js +6 -6
  241. package/dist/esm/modules/storage/bun-s3/utility.js.map +1 -1
  242. package/dist/esm/modules/storage/common/errors.js +1 -1
  243. package/dist/esm/modules/storage/common/errors.js.map +1 -1
  244. package/dist/esm/modules/storage/minio/helper.js +4 -4
  245. package/dist/esm/modules/storage/minio/helper.js.map +1 -1
  246. package/dist/esm/modules/temporal/abstract.js +5 -5
  247. package/dist/esm/modules/temporal/abstract.js.map +1 -1
  248. package/dist/esm/modules/temporal/adapters/intl.d.ts.map +1 -1
  249. package/dist/esm/modules/temporal/adapters/intl.js +3 -1
  250. package/dist/esm/modules/temporal/adapters/intl.js.map +1 -1
  251. package/dist/esm/modules/temporal/locale/locale.js +4 -4
  252. package/dist/esm/modules/temporal/locale/locale.js.map +1 -1
  253. package/dist/esm/modules/tree/builder.js +2 -2
  254. package/dist/esm/modules/tree/builder.js.map +1 -1
  255. package/dist/esm/modules/uid/opaque.js +2 -2
  256. package/dist/esm/modules/uid/opaque.js.map +1 -1
  257. package/dist/esm/modules/uid/uuid/v5.js +1 -1
  258. package/dist/esm/modules/uid/uuid/v5.js.map +1 -1
  259. package/dist/esm/modules/worker-thread/bus/base.js +4 -4
  260. package/dist/esm/modules/worker-thread/bus/base.js.map +1 -1
  261. package/dist/esm/modules/worker-thread/thread/base.js +2 -2
  262. package/dist/esm/modules/worker-thread/thread/base.js.map +1 -1
  263. package/dist/esm/modules/worker-thread/worker/base.js +4 -4
  264. package/dist/esm/modules/worker-thread/worker/base.js.map +1 -1
  265. package/dist/esm/utilities/parse.utility.js +4 -4
  266. package/dist/esm/utilities/parse.utility.js.map +1 -1
  267. package/dist/esm/utilities/promise.utility.js +1 -1
  268. package/dist/esm/utilities/promise.utility.js.map +1 -1
  269. package/dist/esm/utilities/request.utility.js +1 -1
  270. package/dist/esm/utilities/request.utility.js.map +1 -1
  271. package/dist/esm/utilities/sleep.utility.js +1 -1
  272. package/dist/esm/utilities/sleep.utility.js.map +1 -1
  273. package/package.json +10 -4
@@ -0,0 +1,246 @@
1
+ import { HTTP } from '../../../../common/constants/http.js';
2
+ import { BaseHelper } from '../../../base.js';
3
+ import { getError } from '../../../error/index.js';
4
+ // The leaf files, never the `../common` barrel: it reaches the server types, which name node modules.
5
+ import { SocketIOClientStates, SocketIOConstants } from '../common/constants.js';
6
+ /**
7
+ * The socket.io client with nothing node in its graph, so a browser bundle can hold it: `socket.io-client`
8
+ * is handed in as `module` (`{ io }` from the app's own `import`) instead of being found on disk.
9
+ * `@venizia/ignis-helpers/socket-io` extends it and finds the module itself when none is handed in.
10
+ */
11
+ export class SocketIOClientHelper extends BaseHelper {
12
+ constructor(opts) {
13
+ super({ scope: opts.identifier });
14
+ this.state = SocketIOClientStates.UNAUTHORIZED;
15
+ // subscribe() registers a wrapper, never the caller handler: without this map unsubscribe() has nothing to hand to socket.off() and the listener stays bound forever
16
+ this.wrappedHandlers = new Map();
17
+ this.identifier = opts.identifier;
18
+ this.host = opts.host;
19
+ this.options = opts.options;
20
+ this.clientModule = opts.module;
21
+ this.onConnected = opts.onConnected;
22
+ this.onDisconnected = opts.onDisconnected;
23
+ this.onError = opts.onError;
24
+ this.onAuthenticated = opts.onAuthenticated;
25
+ this.onUnauthenticated = opts.onUnauthenticated;
26
+ this.configure();
27
+ }
28
+ /** The `socket.io-client` module to connect with. Here only the one handed in; a subclass may find one. */
29
+ resolveModule() {
30
+ if (!this.clientModule) {
31
+ throw getError({
32
+ statusCode: HTTP.ResultCodes.RS_5.InternalServerError,
33
+ message: `[SocketIOClientHelper][${this.identifier}] option 'module' is required: pass { io } from 'socket.io-client'`,
34
+ });
35
+ }
36
+ return this.clientModule;
37
+ }
38
+ getState() {
39
+ return this.state;
40
+ }
41
+ configure() {
42
+ const logger = this.logger.for(this.configure.name);
43
+ if (this.client) {
44
+ logger.info('SocketIO Client already established | id: %s', this.identifier);
45
+ return;
46
+ }
47
+ const { io } = this.resolveModule();
48
+ this.client = io(this.host, this.options);
49
+ // Socket.IO client fires 'connect', NOT 'connection' (server-side only)
50
+ this.client.on('connect', () => {
51
+ logger.info('Connected | id: %s', this.identifier);
52
+ Promise.resolve(this.onConnected?.()).catch((error) => {
53
+ logger.error('onConnected callback error | error: %s', error);
54
+ });
55
+ });
56
+ this.client.on(SocketIOConstants.EVENT_DISCONNECT, (reason) => {
57
+ logger.info('Disconnected | id: %s | reason: %s', this.identifier, reason);
58
+ this.state = SocketIOClientStates.UNAUTHORIZED;
59
+ Promise.resolve(this.onDisconnected?.(reason)).catch((error) => {
60
+ logger.error('onDisconnected callback error | error: %s', error);
61
+ });
62
+ });
63
+ this.client.on('connect_error', (error) => {
64
+ logger.error('Connection error | id: %s | error: %s', this.identifier, error);
65
+ Promise.resolve(this.onError?.(error)).catch((err) => {
66
+ logger.error('onError callback error | error: %s', err);
67
+ });
68
+ });
69
+ this.client.on(SocketIOConstants.EVENT_AUTHENTICATED, (data) => {
70
+ logger.info('Authenticated | id: %s | data: %j', this.identifier, data);
71
+ this.state = SocketIOClientStates.AUTHENTICATED;
72
+ Promise.resolve(this.onAuthenticated?.()).catch((error) => {
73
+ logger.error('onAuthenticated callback error | error: %s', error);
74
+ });
75
+ });
76
+ this.client.on(SocketIOConstants.EVENT_UNAUTHENTICATE, (data) => {
77
+ logger.warn('Unauthenticated | id: %s | data: %j', this.identifier, data);
78
+ this.state = SocketIOClientStates.UNAUTHORIZED;
79
+ Promise.resolve(this.onUnauthenticated?.(data?.message ?? '')).catch((error) => {
80
+ logger.error('onUnauthenticated callback error | error: %s', error);
81
+ });
82
+ });
83
+ this.client.on(SocketIOConstants.EVENT_PING, () => {
84
+ logger.debug('Ping received | id: %s', this.identifier);
85
+ });
86
+ }
87
+ getSocketClient() {
88
+ return this.client;
89
+ }
90
+ authenticate() {
91
+ const logger = this.logger.for(this.authenticate.name);
92
+ if (!this.client?.connected) {
93
+ logger.warn('Cannot authenticate | id: %s | reason: not connected', this.identifier);
94
+ return;
95
+ }
96
+ if (this.state !== SocketIOClientStates.UNAUTHORIZED) {
97
+ logger.warn('Cannot authenticate | id: %s | currentState: %s', this.identifier, this.state);
98
+ return;
99
+ }
100
+ this.state = SocketIOClientStates.AUTHENTICATING;
101
+ this.client.emit(SocketIOConstants.EVENT_AUTHENTICATE);
102
+ logger.info('Authentication requested | id: %s', this.identifier);
103
+ }
104
+ subscribe(opts) {
105
+ const logger = this.logger.for(this.subscribe.name);
106
+ const { event, handler, ignoreDuplicate = true } = opts;
107
+ if (!handler) {
108
+ logger.warn('No handler provided | event: %s', event);
109
+ return;
110
+ }
111
+ if (ignoreDuplicate && this.client.hasListeners(event)) {
112
+ logger.info('Handler already exists | event: %s', event);
113
+ return;
114
+ }
115
+ // Wrap handler in try-catch for error safety (catches both sync throws and async rejections)
116
+ const wrappedHandler = (data) => {
117
+ try {
118
+ Promise.resolve(handler(data)).catch((error) => {
119
+ logger.error('Handler error | event: %s | error: %s', event, error);
120
+ });
121
+ }
122
+ catch (error) {
123
+ logger.error('Handler error | event: %s | error: %s', event, error);
124
+ }
125
+ };
126
+ if (!this.wrappedHandlers.has(event)) {
127
+ this.wrappedHandlers.set(event, new Map());
128
+ }
129
+ this.wrappedHandlers.get(event).set(handler, wrappedHandler);
130
+ this.client.on(event, wrappedHandler);
131
+ logger.info('Subscribed | event: %s', event);
132
+ }
133
+ subscribeMany(opts) {
134
+ const { events, ignoreDuplicate } = opts;
135
+ for (const event in events) {
136
+ this.subscribe({
137
+ event,
138
+ handler: events[event],
139
+ ignoreDuplicate,
140
+ });
141
+ }
142
+ }
143
+ unsubscribe(opts) {
144
+ const logger = this.logger.for(this.unsubscribe.name);
145
+ const { event, handler } = opts;
146
+ if (!this.client?.hasListeners(event)) {
147
+ logger.info('No listeners to remove | event: %s', event);
148
+ return;
149
+ }
150
+ if (handler) {
151
+ const wrappedHandler = this.wrappedHandlers.get(event)?.get(handler);
152
+ if (!wrappedHandler) {
153
+ logger.info('Handler was not subscribed through this helper | event: %s', event);
154
+ return;
155
+ }
156
+ this.client.off(event, wrappedHandler);
157
+ this.wrappedHandlers.get(event)?.delete(handler);
158
+ if (!this.wrappedHandlers.get(event)?.size) {
159
+ this.wrappedHandlers.delete(event);
160
+ }
161
+ logger.info('Removed specific handler | event: %s', event);
162
+ return;
163
+ }
164
+ this.client.off(event);
165
+ this.wrappedHandlers.delete(event);
166
+ logger.info('Removed all handlers | event: %s', event);
167
+ }
168
+ unsubscribeMany(opts) {
169
+ for (const event of opts.events) {
170
+ this.unsubscribe({ event });
171
+ }
172
+ }
173
+ connect() {
174
+ const logger = this.logger.for(this.connect.name);
175
+ if (!this.client) {
176
+ logger.info('Invalid client to connect | id: %s', this.identifier);
177
+ return;
178
+ }
179
+ this.client.connect();
180
+ }
181
+ disconnect() {
182
+ const logger = this.logger.for(this.disconnect.name);
183
+ if (!this.client) {
184
+ logger.info('Invalid client to disconnect | id: %s', this.identifier);
185
+ return;
186
+ }
187
+ this.client.disconnect();
188
+ }
189
+ emit(opts) {
190
+ const logger = this.logger.for(this.emit.name);
191
+ const { topic, data, doLog = false, callback } = opts;
192
+ if (!this.client?.connected) {
193
+ throw getError({
194
+ statusCode: HTTP.ResultCodes.RS_4.BadRequest,
195
+ message: 'Invalid socket client state to emit',
196
+ });
197
+ }
198
+ if (!topic) {
199
+ throw getError({
200
+ statusCode: HTTP.ResultCodes.RS_4.BadRequest,
201
+ message: 'Topic is required to emit',
202
+ });
203
+ }
204
+ this.client.emit(topic, data);
205
+ if (callback) {
206
+ setImmediate(callback);
207
+ }
208
+ if (doLog) {
209
+ logger.info('Emitted | topic: %s | data: %j', topic, data);
210
+ }
211
+ }
212
+ joinRooms(opts) {
213
+ const logger = this.logger.for(this.joinRooms.name);
214
+ const { rooms } = opts;
215
+ if (!this.client?.connected) {
216
+ logger.warn('Cannot join rooms | id: %s | reason: not connected', this.identifier);
217
+ return;
218
+ }
219
+ this.client.emit(SocketIOConstants.EVENT_JOIN, { rooms });
220
+ logger.info('Join rooms requested | id: %s | rooms: %j', this.identifier, rooms);
221
+ }
222
+ leaveRooms(opts) {
223
+ const logger = this.logger.for(this.leaveRooms.name);
224
+ const { rooms } = opts;
225
+ if (!this.client?.connected) {
226
+ logger.warn('Cannot leave rooms | id: %s | reason: not connected', this.identifier);
227
+ return;
228
+ }
229
+ this.client.emit(SocketIOConstants.EVENT_LEAVE, { rooms });
230
+ logger.info('Leave rooms requested | id: %s | rooms: %j', this.identifier, rooms);
231
+ }
232
+ shutdown() {
233
+ const logger = this.logger.for(this.shutdown.name);
234
+ logger.info('Shutting down SocketIO client | id: %s', this.identifier);
235
+ if (this.client) {
236
+ this.client.removeAllListeners();
237
+ if (this.client.connected) {
238
+ this.client.disconnect();
239
+ }
240
+ }
241
+ this.wrappedHandlers.clear();
242
+ this.state = SocketIOClientStates.UNAUTHORIZED;
243
+ logger.info('SocketIO client shutdown complete | id: %s', this.identifier);
244
+ }
245
+ }
246
+ //# sourceMappingURL=browser-helper.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"browser-helper.js","sourceRoot":"","sources":["../../../../../../src/modules/socket/socket-io/client/browser-helper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,yBAAyB,CAAC;AAE/C,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAE3C,sGAAsG;AACtG,OAAO,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAQ9E;;;;GAIG;AACH,MAAM,OAAO,oBAAqB,SAAQ,UAAU;IAkBlD,YAAY,IAA4B;QACtC,KAAK,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;QAf5B,UAAK,GAAyB,oBAAoB,CAAC,YAAY,CAAC;QAExE,qKAAqK;QAC7J,oBAAe,GACrB,IAAI,GAAG,EAAE,CAAC;QAaV,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QAClC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC5B,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC;QAEhC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACpC,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAC1C,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC5B,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;QAC5C,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC;QAEhD,IAAI,CAAC,SAAS,EAAE,CAAC;IACnB,CAAC;IAED,2GAA2G;IACjG,aAAa;QACrB,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;YACvB,MAAM,QAAQ,CAAC;gBACb,UAAU,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,mBAAmB;gBACrD,OAAO,EAAE,0BAA0B,IAAI,CAAC,UAAU,oEAAoE;aACvH,CAAC,CAAC;QACL,CAAC;QAED,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,SAAS;QACP,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAEpD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,CAAC,IAAI,CAAC,8CAA8C,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YAC7E,OAAO;QACT,CAAC;QAED,MAAM,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QACpC,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAE1C,wEAAwE;QACxE,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE;YAC7B,MAAM,CAAC,IAAI,CAAC,oBAAoB,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YAEnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpD,MAAM,CAAC,KAAK,CAAC,wCAAwC,EAAE,KAAK,CAAC,CAAC;YAChE,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,iBAAiB,CAAC,gBAAgB,EAAE,CAAC,MAAc,EAAE,EAAE;YACpE,MAAM,CAAC,IAAI,CAAC,oCAAoC,EAAE,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;YAC3E,IAAI,CAAC,KAAK,GAAG,oBAAoB,CAAC,YAAY,CAAC;YAE/C,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC7D,MAAM,CAAC,KAAK,CAAC,2CAA2C,EAAE,KAAK,CAAC,CAAC;YACnE,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,eAAe,EAAE,CAAC,KAAY,EAAE,EAAE;YAC/C,MAAM,CAAC,KAAK,CAAC,uCAAuC,EAAE,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;YAE9E,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;gBACnD,MAAM,CAAC,KAAK,CAAC,oCAAoC,EAAE,GAAG,CAAC,CAAC;YAC1D,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,iBAAiB,CAAC,mBAAmB,EAAE,CAAC,IAAa,EAAE,EAAE;YACtE,MAAM,CAAC,IAAI,CAAC,mCAAmC,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YACxE,IAAI,CAAC,KAAK,GAAG,oBAAoB,CAAC,aAAa,CAAC;YAEhD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACxD,MAAM,CAAC,KAAK,CAAC,4CAA4C,EAAE,KAAK,CAAC,CAAC;YACpE,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,iBAAiB,CAAC,oBAAoB,EAAE,CAAC,IAA0B,EAAE,EAAE;YACpF,MAAM,CAAC,IAAI,CAAC,qCAAqC,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YAC1E,IAAI,CAAC,KAAK,GAAG,oBAAoB,CAAC,YAAY,CAAC;YAE/C,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,IAAI,EAAE,OAAO,IAAI,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC7E,MAAM,CAAC,KAAK,CAAC,8CAA8C,EAAE,KAAK,CAAC,CAAC;YACtE,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,iBAAiB,CAAC,UAAU,EAAE,GAAG,EAAE;YAChD,MAAM,CAAC,KAAK,CAAC,wBAAwB,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAC1D,CAAC,CAAC,CAAC;IACL,CAAC;IAED,eAAe;QACb,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,YAAY;QACV,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAEvD,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,CAAC;YAC5B,MAAM,CAAC,IAAI,CAAC,sDAAsD,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YACrF,OAAO;QACT,CAAC;QAED,IAAI,IAAI,CAAC,KAAK,KAAK,oBAAoB,CAAC,YAAY,EAAE,CAAC;YACrD,MAAM,CAAC,IAAI,CAAC,iDAAiD,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;YAC5F,OAAO;QACT,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,oBAAoB,CAAC,cAAc,CAAC;QACjD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;QACvD,MAAM,CAAC,IAAI,CAAC,mCAAmC,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IACpE,CAAC;IAED,SAAS,CAAc,IAItB;QACC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACpD,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;QAExD,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,CAAC,IAAI,CAAC,iCAAiC,EAAE,KAAK,CAAC,CAAC;YACtD,OAAO;QACT,CAAC;QAED,IAAI,eAAe,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;YACvD,MAAM,CAAC,IAAI,CAAC,oCAAoC,EAAE,KAAK,CAAC,CAAC;YACzD,OAAO;QACT,CAAC;QAED,6FAA6F;QAC7F,MAAM,cAAc,GAAG,CAAC,IAAO,EAAE,EAAE;YACjC,IAAI,CAAC;gBACH,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;oBAC7C,MAAM,CAAC,KAAK,CAAC,uCAAuC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;gBACtE,CAAC,CAAC,CAAC;YACL,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,CAAC,KAAK,CAAC,uCAAuC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;YACtE,CAAC;QACH,CAAC,CAAC;QAEF,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YACrC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;QAC7C,CAAC;QACD,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,KAAK,CAAE,CAAC,GAAG,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;QAE9D,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;QACtC,MAAM,CAAC,IAAI,CAAC,wBAAwB,EAAE,KAAK,CAAC,CAAC;IAC/C,CAAC;IAED,aAAa,CAAC,IAGb;QACC,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,GAAG,IAAI,CAAC;QAEzC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,IAAI,CAAC,SAAS,CAAC;gBACb,KAAK;gBACL,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC;gBACtB,eAAe;aAChB,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,WAAW,CAAC,IAAwD;QAClE,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACtD,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QAEhC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;YACtC,MAAM,CAAC,IAAI,CAAC,oCAAoC,EAAE,KAAK,CAAC,CAAC;YACzD,OAAO;QACT,CAAC;QAED,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,cAAc,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;YACrE,IAAI,CAAC,cAAc,EAAE,CAAC;gBACpB,MAAM,CAAC,IAAI,CAAC,4DAA4D,EAAE,KAAK,CAAC,CAAC;gBACjF,OAAO;YACT,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;YACvC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;YAEjD,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC;gBAC3C,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACrC,CAAC;YAED,MAAM,CAAC,IAAI,CAAC,sCAAsC,EAAE,KAAK,CAAC,CAAC;YAC3D,OAAO;QACT,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACvB,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACnC,MAAM,CAAC,IAAI,CAAC,kCAAkC,EAAE,KAAK,CAAC,CAAC;IACzD,CAAC;IAED,eAAe,CAAC,IAA0B;QACxC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChC,IAAI,CAAC,WAAW,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAED,OAAO;QACL,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAElD,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,MAAM,CAAC,IAAI,CAAC,oCAAoC,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YACnE,OAAO;QACT,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;IACxB,CAAC;IAED,UAAU;QACR,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAErD,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,MAAM,CAAC,IAAI,CAAC,uCAAuC,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YACtE,OAAO;QACT,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;IAC3B,CAAC;IAED,IAAI,CAAc,IAAwE;QACxF,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/C,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,GAAG,KAAK,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;QAEtD,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,CAAC;YAC5B,MAAM,QAAQ,CAAC;gBACb,UAAU,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU;gBAC5C,OAAO,EAAE,qCAAqC;aAC/C,CAAC,CAAC;QACL,CAAC;QAED,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,QAAQ,CAAC;gBACb,UAAU,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU;gBAC5C,OAAO,EAAE,2BAA2B;aACrC,CAAC,CAAC;QACL,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAE9B,IAAI,QAAQ,EAAE,CAAC;YACb,YAAY,CAAC,QAAQ,CAAC,CAAC;QACzB,CAAC;QAED,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,CAAC,IAAI,CAAC,gCAAgC,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;QAC7D,CAAC;IACH,CAAC;IAED,SAAS,CAAC,IAAyB;QACjC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACpD,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QAEvB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,CAAC;YAC5B,MAAM,CAAC,IAAI,CAAC,oDAAoD,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YACnF,OAAO;QACT,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC1D,MAAM,CAAC,IAAI,CAAC,2CAA2C,EAAE,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IACnF,CAAC;IAED,UAAU,CAAC,IAAyB;QAClC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACrD,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QAEvB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,CAAC;YAC5B,MAAM,CAAC,IAAI,CAAC,qDAAqD,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YACpF,OAAO;QACT,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,WAAW,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC3D,MAAM,CAAC,IAAI,CAAC,4CAA4C,EAAE,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IACpF,CAAC;IAED,QAAQ;QACN,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACnD,MAAM,CAAC,IAAI,CAAC,wCAAwC,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAEvE,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,IAAI,CAAC,MAAM,CAAC,kBAAkB,EAAE,CAAC;YAEjC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;gBAC1B,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;YAC3B,CAAC;QACH,CAAC;QAED,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;QAC7B,IAAI,CAAC,KAAK,GAAG,oBAAoB,CAAC,YAAY,CAAC;QAC/C,MAAM,CAAC,IAAI,CAAC,4CAA4C,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IAC7E,CAAC;CACF","sourcesContent":["import { HTTP } from '@/common/constants/http';\nimport { type ValueOrPromise } from '@/common/types';\nimport { BaseHelper } from '@/modules/base';\nimport { getError } from '@/modules/error';\nimport type { Socket } from 'socket.io-client';\n// The leaf files, never the `../common` barrel: it reaches the server types, which name node modules.\nimport { SocketIOClientStates, SocketIOConstants } from '../common/constants';\nimport type {\n IOptions,\n ISocketIOClientOptions,\n TSocketIOClientState,\n} from '../common/types/client';\nimport type { TSocketIOEventHandler } from '../common/types/hooks';\n\n/**\n * The socket.io client with nothing node in its graph, so a browser bundle can hold it: `socket.io-client`\n * is handed in as `module` (`{ io }` from the app's own `import`) instead of being found on disk.\n * `@venizia/ignis-helpers/socket-io` extends it and finds the module itself when none is handed in.\n */\nexport class SocketIOClientHelper extends BaseHelper {\n private host: string;\n private options: IOptions;\n private client: Socket;\n private state: TSocketIOClientState = SocketIOClientStates.UNAUTHORIZED;\n\n // subscribe() registers a wrapper, never the caller handler: without this map unsubscribe() has nothing to hand to socket.off() and the listener stays bound forever\n private wrappedHandlers: Map<string, Map<TSocketIOEventHandler<any>, (data: any) => void>> =\n new Map();\n\n private onConnected?: () => ValueOrPromise<void>;\n private onDisconnected?: (reason: string) => ValueOrPromise<void>;\n private onError?: (error: Error) => ValueOrPromise<void>;\n private onAuthenticated?: () => ValueOrPromise<void>;\n private onUnauthenticated?: (message: string) => ValueOrPromise<void>;\n\n protected readonly clientModule?: typeof import('socket.io-client');\n\n constructor(opts: ISocketIOClientOptions) {\n super({ scope: opts.identifier });\n\n this.identifier = opts.identifier;\n this.host = opts.host;\n this.options = opts.options;\n this.clientModule = opts.module;\n\n this.onConnected = opts.onConnected;\n this.onDisconnected = opts.onDisconnected;\n this.onError = opts.onError;\n this.onAuthenticated = opts.onAuthenticated;\n this.onUnauthenticated = opts.onUnauthenticated;\n\n this.configure();\n }\n\n /** The `socket.io-client` module to connect with. Here only the one handed in; a subclass may find one. */\n protected resolveModule(): typeof import('socket.io-client') {\n if (!this.clientModule) {\n throw getError({\n statusCode: HTTP.ResultCodes.RS_5.InternalServerError,\n message: `[SocketIOClientHelper][${this.identifier}] option 'module' is required: pass { io } from 'socket.io-client'`,\n });\n }\n\n return this.clientModule;\n }\n\n getState(): TSocketIOClientState {\n return this.state;\n }\n\n configure() {\n const logger = this.logger.for(this.configure.name);\n\n if (this.client) {\n logger.info('SocketIO Client already established | id: %s', this.identifier);\n return;\n }\n\n const { io } = this.resolveModule();\n this.client = io(this.host, this.options);\n\n // Socket.IO client fires 'connect', NOT 'connection' (server-side only)\n this.client.on('connect', () => {\n logger.info('Connected | id: %s', this.identifier);\n\n Promise.resolve(this.onConnected?.()).catch((error) => {\n logger.error('onConnected callback error | error: %s', error);\n });\n });\n\n this.client.on(SocketIOConstants.EVENT_DISCONNECT, (reason: string) => {\n logger.info('Disconnected | id: %s | reason: %s', this.identifier, reason);\n this.state = SocketIOClientStates.UNAUTHORIZED;\n\n Promise.resolve(this.onDisconnected?.(reason)).catch((error) => {\n logger.error('onDisconnected callback error | error: %s', error);\n });\n });\n\n this.client.on('connect_error', (error: Error) => {\n logger.error('Connection error | id: %s | error: %s', this.identifier, error);\n\n Promise.resolve(this.onError?.(error)).catch((err) => {\n logger.error('onError callback error | error: %s', err);\n });\n });\n\n this.client.on(SocketIOConstants.EVENT_AUTHENTICATED, (data: unknown) => {\n logger.info('Authenticated | id: %s | data: %j', this.identifier, data);\n this.state = SocketIOClientStates.AUTHENTICATED;\n\n Promise.resolve(this.onAuthenticated?.()).catch((error) => {\n logger.error('onAuthenticated callback error | error: %s', error);\n });\n });\n\n this.client.on(SocketIOConstants.EVENT_UNAUTHENTICATE, (data: { message?: string }) => {\n logger.warn('Unauthenticated | id: %s | data: %j', this.identifier, data);\n this.state = SocketIOClientStates.UNAUTHORIZED;\n\n Promise.resolve(this.onUnauthenticated?.(data?.message ?? '')).catch((error) => {\n logger.error('onUnauthenticated callback error | error: %s', error);\n });\n });\n\n this.client.on(SocketIOConstants.EVENT_PING, () => {\n logger.debug('Ping received | id: %s', this.identifier);\n });\n }\n\n getSocketClient(): Socket {\n return this.client;\n }\n\n authenticate() {\n const logger = this.logger.for(this.authenticate.name);\n\n if (!this.client?.connected) {\n logger.warn('Cannot authenticate | id: %s | reason: not connected', this.identifier);\n return;\n }\n\n if (this.state !== SocketIOClientStates.UNAUTHORIZED) {\n logger.warn('Cannot authenticate | id: %s | currentState: %s', this.identifier, this.state);\n return;\n }\n\n this.state = SocketIOClientStates.AUTHENTICATING;\n this.client.emit(SocketIOConstants.EVENT_AUTHENTICATE);\n logger.info('Authentication requested | id: %s', this.identifier);\n }\n\n subscribe<T = unknown>(opts: {\n event: string;\n handler: TSocketIOEventHandler<T>;\n ignoreDuplicate?: boolean;\n }) {\n const logger = this.logger.for(this.subscribe.name);\n const { event, handler, ignoreDuplicate = true } = opts;\n\n if (!handler) {\n logger.warn('No handler provided | event: %s', event);\n return;\n }\n\n if (ignoreDuplicate && this.client.hasListeners(event)) {\n logger.info('Handler already exists | event: %s', event);\n return;\n }\n\n // Wrap handler in try-catch for error safety (catches both sync throws and async rejections)\n const wrappedHandler = (data: T) => {\n try {\n Promise.resolve(handler(data)).catch((error) => {\n logger.error('Handler error | event: %s | error: %s', event, error);\n });\n } catch (error) {\n logger.error('Handler error | event: %s | error: %s', event, error);\n }\n };\n\n if (!this.wrappedHandlers.has(event)) {\n this.wrappedHandlers.set(event, new Map());\n }\n this.wrappedHandlers.get(event)!.set(handler, wrappedHandler);\n\n this.client.on(event, wrappedHandler);\n logger.info('Subscribed | event: %s', event);\n }\n\n subscribeMany(opts: {\n events: Record<string, TSocketIOEventHandler>;\n ignoreDuplicate?: boolean;\n }) {\n const { events, ignoreDuplicate } = opts;\n\n for (const event in events) {\n this.subscribe({\n event,\n handler: events[event],\n ignoreDuplicate,\n });\n }\n }\n\n unsubscribe(opts: { event: string; handler?: TSocketIOEventHandler }) {\n const logger = this.logger.for(this.unsubscribe.name);\n const { event, handler } = opts;\n\n if (!this.client?.hasListeners(event)) {\n logger.info('No listeners to remove | event: %s', event);\n return;\n }\n\n if (handler) {\n const wrappedHandler = this.wrappedHandlers.get(event)?.get(handler);\n if (!wrappedHandler) {\n logger.info('Handler was not subscribed through this helper | event: %s', event);\n return;\n }\n\n this.client.off(event, wrappedHandler);\n this.wrappedHandlers.get(event)?.delete(handler);\n\n if (!this.wrappedHandlers.get(event)?.size) {\n this.wrappedHandlers.delete(event);\n }\n\n logger.info('Removed specific handler | event: %s', event);\n return;\n }\n\n this.client.off(event);\n this.wrappedHandlers.delete(event);\n logger.info('Removed all handlers | event: %s', event);\n }\n\n unsubscribeMany(opts: { events: string[] }) {\n for (const event of opts.events) {\n this.unsubscribe({ event });\n }\n }\n\n connect() {\n const logger = this.logger.for(this.connect.name);\n\n if (!this.client) {\n logger.info('Invalid client to connect | id: %s', this.identifier);\n return;\n }\n\n this.client.connect();\n }\n\n disconnect() {\n const logger = this.logger.for(this.disconnect.name);\n\n if (!this.client) {\n logger.info('Invalid client to disconnect | id: %s', this.identifier);\n return;\n }\n\n this.client.disconnect();\n }\n\n emit<T = unknown>(opts: { topic: string; data: T; doLog?: boolean; callback?: () => void }) {\n const logger = this.logger.for(this.emit.name);\n const { topic, data, doLog = false, callback } = opts;\n\n if (!this.client?.connected) {\n throw getError({\n statusCode: HTTP.ResultCodes.RS_4.BadRequest,\n message: 'Invalid socket client state to emit',\n });\n }\n\n if (!topic) {\n throw getError({\n statusCode: HTTP.ResultCodes.RS_4.BadRequest,\n message: 'Topic is required to emit',\n });\n }\n\n this.client.emit(topic, data);\n\n if (callback) {\n setImmediate(callback);\n }\n\n if (doLog) {\n logger.info('Emitted | topic: %s | data: %j', topic, data);\n }\n }\n\n joinRooms(opts: { rooms: string[] }) {\n const logger = this.logger.for(this.joinRooms.name);\n const { rooms } = opts;\n\n if (!this.client?.connected) {\n logger.warn('Cannot join rooms | id: %s | reason: not connected', this.identifier);\n return;\n }\n\n this.client.emit(SocketIOConstants.EVENT_JOIN, { rooms });\n logger.info('Join rooms requested | id: %s | rooms: %j', this.identifier, rooms);\n }\n\n leaveRooms(opts: { rooms: string[] }) {\n const logger = this.logger.for(this.leaveRooms.name);\n const { rooms } = opts;\n\n if (!this.client?.connected) {\n logger.warn('Cannot leave rooms | id: %s | reason: not connected', this.identifier);\n return;\n }\n\n this.client.emit(SocketIOConstants.EVENT_LEAVE, { rooms });\n logger.info('Leave rooms requested | id: %s | rooms: %j', this.identifier, rooms);\n }\n\n shutdown() {\n const logger = this.logger.for(this.shutdown.name);\n logger.info('Shutting down SocketIO client | id: %s', this.identifier);\n\n if (this.client) {\n this.client.removeAllListeners();\n\n if (this.client.connected) {\n this.client.disconnect();\n }\n }\n\n this.wrappedHandlers.clear();\n this.state = SocketIOClientStates.UNAUTHORIZED;\n logger.info('SocketIO client shutdown complete | id: %s', this.identifier);\n }\n}\n"]}
@@ -1,53 +1,10 @@
1
- import { BaseHelper } from '../../../base.js';
2
- import type { Socket } from 'socket.io-client';
3
- import { type ISocketIOClientOptions, type TSocketIOEventHandler, type TSocketIOClientState } from '../common/index.js';
4
- export declare class SocketIOClientHelper extends BaseHelper {
5
- private host;
6
- private options;
7
- private client;
8
- private state;
9
- private wrappedHandlers;
10
- private onConnected?;
11
- private onDisconnected?;
12
- private onError?;
13
- private onAuthenticated?;
14
- private onUnauthenticated?;
15
- private readonly clientModule?;
16
- constructor(opts: ISocketIOClientOptions);
17
- getState(): TSocketIOClientState;
18
- configure(): void;
19
- getSocketClient(): Socket;
20
- authenticate(): void;
21
- subscribe<T = unknown>(opts: {
22
- event: string;
23
- handler: TSocketIOEventHandler<T>;
24
- ignoreDuplicate?: boolean;
25
- }): void;
26
- subscribeMany(opts: {
27
- events: Record<string, TSocketIOEventHandler>;
28
- ignoreDuplicate?: boolean;
29
- }): void;
30
- unsubscribe(opts: {
31
- event: string;
32
- handler?: TSocketIOEventHandler;
33
- }): void;
34
- unsubscribeMany(opts: {
35
- events: string[];
36
- }): void;
37
- connect(): void;
38
- disconnect(): void;
39
- emit<T = unknown>(opts: {
40
- topic: string;
41
- data: T;
42
- doLog?: boolean;
43
- callback?: () => void;
44
- }): void;
45
- joinRooms(opts: {
46
- rooms: string[];
47
- }): void;
48
- leaveRooms(opts: {
49
- rooms: string[];
50
- }): void;
51
- shutdown(): void;
1
+ import { SocketIOClientHelper as BrowserSocketIOClientHelper } from './browser-helper.js';
2
+ /**
3
+ * The socket.io client for a server or a CLI: the browser-pure helper, plus a `socket.io-client`
4
+ * found in the app's `node_modules` when no `module` is handed in. A browser bundle imports
5
+ * `@venizia/ignis-helpers/socket-io/client` instead, which has no node dependency.
6
+ */
7
+ export declare class SocketIOClientHelper extends BrowserSocketIOClientHelper {
8
+ protected resolveModule(): typeof import('socket.io-client');
52
9
  }
53
10
  //# sourceMappingURL=helper.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"helper.d.ts","sourceRoot":"","sources":["../../../../../../src/modules/socket/socket-io/client/helper.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAG5C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAEL,KAAK,sBAAsB,EAG3B,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EAC1B,MAAM,WAAW,CAAC;AAEnB,qBAAa,oBAAqB,SAAQ,UAAU;IAClD,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,OAAO,CAAW;IAC1B,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,KAAK,CAA2D;IAGxE,OAAO,CAAC,eAAe,CACX;IAEZ,OAAO,CAAC,WAAW,CAAC,CAA6B;IACjD,OAAO,CAAC,cAAc,CAAC,CAA2C;IAClE,OAAO,CAAC,OAAO,CAAC,CAAyC;IACzD,OAAO,CAAC,eAAe,CAAC,CAA6B;IACrD,OAAO,CAAC,iBAAiB,CAAC,CAA4C;IAEtE,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAoC;gBAEtD,IAAI,EAAE,sBAAsB;IAiBxC,QAAQ,IAAI,oBAAoB;IAIhC,SAAS;IAgET,eAAe,IAAI,MAAM;IAIzB,YAAY;IAkBZ,SAAS,CAAC,CAAC,GAAG,OAAO,EAAE,IAAI,EAAE;QAC3B,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAClC,eAAe,CAAC,EAAE,OAAO,CAAC;KAC3B;IAkCD,aAAa,CAAC,IAAI,EAAE;QAClB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;QAC9C,eAAe,CAAC,EAAE,OAAO,CAAC;KAC3B;IAYD,WAAW,CAAC,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,qBAAqB,CAAA;KAAE;IAgCpE,eAAe,CAAC,IAAI,EAAE;QAAE,MAAM,EAAE,MAAM,EAAE,CAAA;KAAE;IAM1C,OAAO;IAWP,UAAU;IAWV,IAAI,CAAC,CAAC,GAAG,OAAO,EAAE,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,CAAC,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAA;KAAE;IA6B1F,SAAS,CAAC,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,EAAE,CAAA;KAAE;IAanC,UAAU,CAAC,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,EAAE,CAAA;KAAE;IAapC,QAAQ;CAgBT"}
1
+ {"version":3,"file":"helper.d.ts","sourceRoot":"","sources":["../../../../../../src/modules/socket/socket-io/client/helper.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,IAAI,2BAA2B,EAAE,MAAM,kBAAkB,CAAC;AAEvF;;;;GAIG;AACH,qBAAa,oBAAqB,SAAQ,2BAA2B;cAGhD,aAAa,IAAI,cAAc,kBAAkB,CAAC;CAMtE"}
@@ -1,234 +1,16 @@
1
- import { HTTP } from '../../../../common/constants/http.js';
2
- import { BaseHelper } from '../../../base.js';
3
- import { getError } from '../../../error/index.js';
4
1
  import { ModuleUtility } from '../../../../utilities/module.utility.js';
5
- import { SocketIOClientStates, SocketIOConstants, } from '../common/index.js';
6
- export class SocketIOClientHelper extends BaseHelper {
7
- constructor(opts) {
8
- super({ scope: opts.identifier });
9
- this.state = SocketIOClientStates.UNAUTHORIZED;
10
- // subscribe() registers a wrapper, never the caller handler: without this map unsubscribe() has nothing to hand to socket.off() and the listener stays bound forever
11
- this.wrappedHandlers = new Map();
12
- this.identifier = opts.identifier;
13
- this.host = opts.host;
14
- this.options = opts.options;
15
- this.clientModule = opts.module;
16
- this.onConnected = opts.onConnected;
17
- this.onDisconnected = opts.onDisconnected;
18
- this.onError = opts.onError;
19
- this.onAuthenticated = opts.onAuthenticated;
20
- this.onUnauthenticated = opts.onUnauthenticated;
21
- this.configure();
22
- }
23
- getState() {
24
- return this.state;
25
- }
26
- configure() {
27
- const logger = this.logger.for(this.configure.name);
28
- if (this.client) {
29
- logger.info('SocketIO Client already established | id: %s', this.identifier);
30
- return;
31
- }
32
- // `socket.io-client` is an optional peer: loaded on connect, so a server that only imports the
33
- // server helper from this entry never needs it installed.
34
- const { io } = this.clientModule ??
35
- ModuleUtility.loadSync({ module: 'socket.io-client' });
36
- this.client = io(this.host, this.options);
37
- // Socket.IO client fires 'connect', NOT 'connection' (server-side only)
38
- this.client.on('connect', () => {
39
- logger.info('Connected | id: %s', this.identifier);
40
- Promise.resolve(this.onConnected?.()).catch(error => {
41
- logger.error('onConnected callback error | error: %s', error);
42
- });
43
- });
44
- this.client.on(SocketIOConstants.EVENT_DISCONNECT, (reason) => {
45
- logger.info('Disconnected | id: %s | reason: %s', this.identifier, reason);
46
- this.state = SocketIOClientStates.UNAUTHORIZED;
47
- Promise.resolve(this.onDisconnected?.(reason)).catch(error => {
48
- logger.error('onDisconnected callback error | error: %s', error);
49
- });
50
- });
51
- this.client.on('connect_error', (error) => {
52
- logger.error('Connection error | id: %s | error: %s', this.identifier, error);
53
- Promise.resolve(this.onError?.(error)).catch(err => {
54
- logger.error('onError callback error | error: %s', err);
55
- });
56
- });
57
- this.client.on(SocketIOConstants.EVENT_AUTHENTICATED, (data) => {
58
- logger.info('Authenticated | id: %s | data: %j', this.identifier, data);
59
- this.state = SocketIOClientStates.AUTHENTICATED;
60
- Promise.resolve(this.onAuthenticated?.()).catch(error => {
61
- logger.error('onAuthenticated callback error | error: %s', error);
62
- });
63
- });
64
- this.client.on(SocketIOConstants.EVENT_UNAUTHENTICATE, (data) => {
65
- logger.warn('Unauthenticated | id: %s | data: %j', this.identifier, data);
66
- this.state = SocketIOClientStates.UNAUTHORIZED;
67
- Promise.resolve(this.onUnauthenticated?.(data?.message ?? '')).catch(error => {
68
- logger.error('onUnauthenticated callback error | error: %s', error);
69
- });
70
- });
71
- this.client.on(SocketIOConstants.EVENT_PING, () => {
72
- logger.debug('Ping received | id: %s', this.identifier);
73
- });
74
- }
75
- getSocketClient() {
76
- return this.client;
77
- }
78
- authenticate() {
79
- const logger = this.logger.for(this.authenticate.name);
80
- if (!this.client?.connected) {
81
- logger.warn('Cannot authenticate | id: %s | reason: not connected', this.identifier);
82
- return;
83
- }
84
- if (this.state !== SocketIOClientStates.UNAUTHORIZED) {
85
- logger.warn('Cannot authenticate | id: %s | currentState: %s', this.identifier, this.state);
86
- return;
87
- }
88
- this.state = SocketIOClientStates.AUTHENTICATING;
89
- this.client.emit(SocketIOConstants.EVENT_AUTHENTICATE);
90
- logger.info('Authentication requested | id: %s', this.identifier);
91
- }
92
- subscribe(opts) {
93
- const logger = this.logger.for(this.subscribe.name);
94
- const { event, handler, ignoreDuplicate = true } = opts;
95
- if (!handler) {
96
- logger.warn('No handler provided | event: %s', event);
97
- return;
98
- }
99
- if (ignoreDuplicate && this.client.hasListeners(event)) {
100
- logger.info('Handler already exists | event: %s', event);
101
- return;
102
- }
103
- // Wrap handler in try-catch for error safety (catches both sync throws and async rejections)
104
- const wrappedHandler = (data) => {
105
- try {
106
- Promise.resolve(handler(data)).catch(error => {
107
- logger.error('Handler error | event: %s | error: %s', event, error);
108
- });
109
- }
110
- catch (error) {
111
- logger.error('Handler error | event: %s | error: %s', event, error);
112
- }
113
- };
114
- if (!this.wrappedHandlers.has(event)) {
115
- this.wrappedHandlers.set(event, new Map());
116
- }
117
- this.wrappedHandlers.get(event).set(handler, wrappedHandler);
118
- this.client.on(event, wrappedHandler);
119
- logger.info('Subscribed | event: %s', event);
120
- }
121
- subscribeMany(opts) {
122
- const { events, ignoreDuplicate } = opts;
123
- for (const event in events) {
124
- this.subscribe({
125
- event,
126
- handler: events[event],
127
- ignoreDuplicate,
128
- });
129
- }
130
- }
131
- unsubscribe(opts) {
132
- const logger = this.logger.for(this.unsubscribe.name);
133
- const { event, handler } = opts;
134
- if (!this.client?.hasListeners(event)) {
135
- logger.info('No listeners to remove | event: %s', event);
136
- return;
137
- }
138
- if (handler) {
139
- const wrappedHandler = this.wrappedHandlers.get(event)?.get(handler);
140
- if (!wrappedHandler) {
141
- logger.info('Handler was not subscribed through this helper | event: %s', event);
142
- return;
143
- }
144
- this.client.off(event, wrappedHandler);
145
- this.wrappedHandlers.get(event)?.delete(handler);
146
- if (!this.wrappedHandlers.get(event)?.size) {
147
- this.wrappedHandlers.delete(event);
148
- }
149
- logger.info('Removed specific handler | event: %s', event);
150
- return;
151
- }
152
- this.client.off(event);
153
- this.wrappedHandlers.delete(event);
154
- logger.info('Removed all handlers | event: %s', event);
155
- }
156
- unsubscribeMany(opts) {
157
- for (const event of opts.events) {
158
- this.unsubscribe({ event });
159
- }
160
- }
161
- connect() {
162
- const logger = this.logger.for(this.connect.name);
163
- if (!this.client) {
164
- logger.info('Invalid client to connect | id: %s', this.identifier);
165
- return;
166
- }
167
- this.client.connect();
168
- }
169
- disconnect() {
170
- const logger = this.logger.for(this.disconnect.name);
171
- if (!this.client) {
172
- logger.info('Invalid client to disconnect | id: %s', this.identifier);
173
- return;
174
- }
175
- this.client.disconnect();
176
- }
177
- emit(opts) {
178
- const logger = this.logger.for(this.emit.name);
179
- const { topic, data, doLog = false, callback } = opts;
180
- if (!this.client?.connected) {
181
- throw getError({
182
- statusCode: HTTP.ResultCodes.RS_4.BadRequest,
183
- message: 'Invalid socket client state to emit',
184
- });
185
- }
186
- if (!topic) {
187
- throw getError({
188
- statusCode: HTTP.ResultCodes.RS_4.BadRequest,
189
- message: 'Topic is required to emit',
190
- });
191
- }
192
- this.client.emit(topic, data);
193
- if (callback) {
194
- setImmediate(callback);
195
- }
196
- if (doLog) {
197
- logger.info('Emitted | topic: %s | data: %j', topic, data);
198
- }
199
- }
200
- joinRooms(opts) {
201
- const logger = this.logger.for(this.joinRooms.name);
202
- const { rooms } = opts;
203
- if (!this.client?.connected) {
204
- logger.warn('Cannot join rooms | id: %s | reason: not connected', this.identifier);
205
- return;
206
- }
207
- this.client.emit(SocketIOConstants.EVENT_JOIN, { rooms });
208
- logger.info('Join rooms requested | id: %s | rooms: %j', this.identifier, rooms);
209
- }
210
- leaveRooms(opts) {
211
- const logger = this.logger.for(this.leaveRooms.name);
212
- const { rooms } = opts;
213
- if (!this.client?.connected) {
214
- logger.warn('Cannot leave rooms | id: %s | reason: not connected', this.identifier);
215
- return;
216
- }
217
- this.client.emit(SocketIOConstants.EVENT_LEAVE, { rooms });
218
- logger.info('Leave rooms requested | id: %s | rooms: %j', this.identifier, rooms);
219
- }
220
- shutdown() {
221
- const logger = this.logger.for(this.shutdown.name);
222
- logger.info('Shutting down SocketIO client | id: %s', this.identifier);
223
- if (this.client) {
224
- this.client.removeAllListeners();
225
- if (this.client.connected) {
226
- this.client.disconnect();
227
- }
228
- }
229
- this.wrappedHandlers.clear();
230
- this.state = SocketIOClientStates.UNAUTHORIZED;
231
- logger.info('SocketIO client shutdown complete | id: %s', this.identifier);
2
+ import { SocketIOClientHelper as BrowserSocketIOClientHelper } from './browser-helper.js';
3
+ /**
4
+ * The socket.io client for a server or a CLI: the browser-pure helper, plus a `socket.io-client`
5
+ * found in the app's `node_modules` when no `module` is handed in. A browser bundle imports
6
+ * `@venizia/ignis-helpers/socket-io/client` instead, which has no node dependency.
7
+ */
8
+ export class SocketIOClientHelper extends BrowserSocketIOClientHelper {
9
+ // `socket.io-client` is an optional peer: loaded on connect, so a server that only imports the
10
+ // server helper from this entry never needs it installed.
11
+ resolveModule() {
12
+ return (this.clientModule ??
13
+ ModuleUtility.loadSync({ module: 'socket.io-client' }));
232
14
  }
233
15
  }
234
16
  //# sourceMappingURL=helper.js.map