@venizia/ignis-helpers 0.4.8-0 → 0.4.8-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.
- package/README.md +1 -0
- package/dist/esm/common/constants/app.d.ts +15 -0
- package/dist/esm/common/constants/app.js +14 -0
- package/dist/esm/common/constants/app.js.map +1 -1
- package/dist/esm/common/constants/duration.d.ts +2 -0
- package/dist/esm/common/constants/duration.js.map +1 -1
- package/dist/esm/common/constants/grpc.d.ts +3 -0
- package/dist/esm/common/constants/grpc.js +1 -0
- package/dist/esm/common/constants/grpc.js.map +1 -1
- package/dist/esm/common/constants/http.d.ts +4 -0
- package/dist/esm/common/constants/http.js +1 -0
- package/dist/esm/common/constants/http.js.map +1 -1
- package/dist/esm/common/constants/mime.d.ts +4 -0
- package/dist/esm/common/constants/mime.js +1 -0
- package/dist/esm/common/constants/mime.js.map +1 -1
- package/dist/esm/common/redact.d.ts +2 -0
- package/dist/esm/common/redact.js +2 -0
- package/dist/esm/common/redact.js.map +1 -1
- package/dist/esm/common/resolvers.d.ts +1 -0
- package/dist/esm/common/resolvers.js +1 -0
- package/dist/esm/common/resolvers.js.map +1 -1
- package/dist/esm/common/types/class.d.ts +6 -0
- package/dist/esm/common/types/class.js.map +1 -1
- package/dist/esm/common/types/const-value.d.ts +3 -0
- package/dist/esm/common/types/const-value.js.map +1 -1
- package/dist/esm/common/types/field-mapping.d.ts +3 -0
- package/dist/esm/common/types/field-mapping.js.map +1 -1
- package/dist/esm/common/types/injection.d.ts +2 -0
- package/dist/esm/common/types/injection.js.map +1 -1
- package/dist/esm/common/types/utility.d.ts +9 -0
- package/dist/esm/common/types/utility.js.map +1 -1
- package/dist/esm/modules/base.d.ts +1 -0
- package/dist/esm/modules/base.js +1 -0
- package/dist/esm/modules/base.js.map +1 -1
- package/dist/esm/modules/cron/helper.d.ts +7 -0
- package/dist/esm/modules/cron/helper.js +1 -0
- package/dist/esm/modules/cron/helper.js.map +1 -1
- package/dist/esm/modules/crypto/algorithms/aes.algorithm.d.ts +2 -0
- package/dist/esm/modules/crypto/algorithms/aes.algorithm.js.map +1 -1
- package/dist/esm/modules/crypto/algorithms/base.algorithm.d.ts +1 -0
- package/dist/esm/modules/crypto/algorithms/base.algorithm.js +1 -0
- package/dist/esm/modules/crypto/algorithms/base.algorithm.js.map +1 -1
- package/dist/esm/modules/crypto/algorithms/credential.algorithm.d.ts +12 -4
- package/dist/esm/modules/crypto/algorithms/credential.algorithm.js +4 -4
- package/dist/esm/modules/crypto/algorithms/credential.algorithm.js.map +1 -1
- package/dist/esm/modules/crypto/algorithms/ecdh.algorithm.d.ts +3 -0
- package/dist/esm/modules/crypto/algorithms/ecdh.algorithm.js.map +1 -1
- package/dist/esm/modules/crypto/algorithms/rsa.algorithm.d.ts +1 -0
- package/dist/esm/modules/crypto/algorithms/rsa.algorithm.js.map +1 -1
- package/dist/esm/modules/crypto/common/constants.d.ts +12 -1
- package/dist/esm/modules/crypto/common/constants.js +9 -1
- package/dist/esm/modules/crypto/common/constants.js.map +1 -1
- package/dist/esm/modules/crypto/common/types.d.ts +1 -0
- package/dist/esm/modules/crypto/common/types.js.map +1 -1
- package/dist/esm/modules/env/app-env.d.ts +3 -0
- package/dist/esm/modules/env/app-env.js +3 -0
- package/dist/esm/modules/env/app-env.js.map +1 -1
- package/dist/esm/modules/env/common/types.d.ts +1 -0
- package/dist/esm/modules/env/common/types.js.map +1 -1
- package/dist/esm/modules/logger/common/constants.d.ts +3 -0
- package/dist/esm/modules/logger/common/constants.js +2 -0
- package/dist/esm/modules/logger/common/constants.js.map +1 -1
- package/dist/esm/modules/logger/common/types.d.ts +2 -0
- package/dist/esm/modules/logger/common/types.js +1 -0
- package/dist/esm/modules/logger/common/types.js.map +1 -1
- package/dist/esm/modules/logger/formatting/deep-splat.d.ts +1 -0
- package/dist/esm/modules/logger/formatting/deep-splat.js +1 -0
- package/dist/esm/modules/logger/formatting/deep-splat.js.map +1 -1
- package/dist/esm/modules/logger/hf/common/types.d.ts +7 -2
- package/dist/esm/modules/logger/hf/common/types.js.map +1 -1
- package/dist/esm/modules/logger/winston/common/types.d.ts +31 -3
- package/dist/esm/modules/logger/winston/common/types.js.map +1 -1
- package/dist/esm/modules/logger/winston/define.d.ts +1 -0
- package/dist/esm/modules/logger/winston/define.js +1 -0
- package/dist/esm/modules/logger/winston/define.js.map +1 -1
- package/dist/esm/modules/logger/winston/logger.d.ts +1 -0
- package/dist/esm/modules/logger/winston/logger.js +1 -0
- package/dist/esm/modules/logger/winston/logger.js.map +1 -1
- package/dist/esm/modules/logger/winston/transports/dgram.transport.d.ts +1 -0
- package/dist/esm/modules/logger/winston/transports/dgram.transport.js +1 -0
- package/dist/esm/modules/logger/winston/transports/dgram.transport.js.map +1 -1
- package/dist/esm/modules/network/http-request/base-network-request.helper.d.ts +1 -0
- package/dist/esm/modules/network/http-request/base-network-request.helper.js +1 -0
- package/dist/esm/modules/network/http-request/base-network-request.helper.js.map +1 -1
- package/dist/esm/modules/network/http-request/fetcher/axios-fetcher.d.ts +8 -8
- package/dist/esm/modules/network/http-request/fetcher/axios-fetcher.js +2 -0
- package/dist/esm/modules/network/http-request/fetcher/axios-fetcher.js.map +1 -1
- package/dist/esm/modules/network/http-request/fetcher/base-fetcher.d.ts +2 -0
- package/dist/esm/modules/network/http-request/fetcher/base-fetcher.js.map +1 -1
- package/dist/esm/modules/network/http-request/fetcher/node-fetcher.d.ts +5 -1
- package/dist/esm/modules/network/http-request/fetcher/node-fetcher.js +2 -0
- package/dist/esm/modules/network/http-request/fetcher/node-fetcher.js.map +1 -1
- package/dist/esm/modules/network/tcp-socket/base-tcp-client.helper.d.ts +11 -0
- package/dist/esm/modules/network/tcp-socket/base-tcp-client.helper.js +1 -0
- package/dist/esm/modules/network/tcp-socket/base-tcp-client.helper.js.map +1 -1
- package/dist/esm/modules/network/tcp-socket/base-tcp-server.helper.d.ts +3 -0
- package/dist/esm/modules/network/tcp-socket/base-tcp-server.helper.js +1 -0
- package/dist/esm/modules/network/tcp-socket/base-tcp-server.helper.js.map +1 -1
- package/dist/esm/modules/network/tcp-socket/network-tcp-client.helper.d.ts +1 -0
- package/dist/esm/modules/network/tcp-socket/network-tcp-client.helper.js +1 -0
- package/dist/esm/modules/network/tcp-socket/network-tcp-client.helper.js.map +1 -1
- package/dist/esm/modules/network/tcp-socket/network-tcp-server.helper.d.ts +1 -0
- package/dist/esm/modules/network/tcp-socket/network-tcp-server.helper.js +1 -0
- package/dist/esm/modules/network/tcp-socket/network-tcp-server.helper.js.map +1 -1
- package/dist/esm/modules/network/tcp-socket/network-tls-tcp-client.helper.d.ts +1 -0
- package/dist/esm/modules/network/tcp-socket/network-tls-tcp-client.helper.js +1 -0
- package/dist/esm/modules/network/tcp-socket/network-tls-tcp-client.helper.js.map +1 -1
- package/dist/esm/modules/network/tcp-socket/network-tls-tcp-server.helper.d.ts +1 -0
- package/dist/esm/modules/network/tcp-socket/network-tls-tcp-server.helper.js +1 -0
- package/dist/esm/modules/network/tcp-socket/network-tls-tcp-server.helper.js.map +1 -1
- package/dist/esm/modules/network/udp-socket/network-udp-client.helper.d.ts +4 -0
- package/dist/esm/modules/network/udp-socket/network-udp-client.helper.js +4 -0
- package/dist/esm/modules/network/udp-socket/network-udp-client.helper.js.map +1 -1
- package/dist/esm/modules/network/utilities/query-string.d.ts +13 -2
- package/dist/esm/modules/network/utilities/query-string.js +2 -1
- package/dist/esm/modules/network/utilities/query-string.js.map +1 -1
- package/dist/esm/modules/network/utilities/url-safety/common/constants.d.ts +2 -1
- package/dist/esm/modules/network/utilities/url-safety/common/constants.js +1 -1
- package/dist/esm/modules/network/utilities/url-safety/common/constants.js.map +1 -1
- package/dist/esm/modules/network/utilities/url-safety/common/types.d.ts +18 -5
- package/dist/esm/modules/network/utilities/url-safety/common/types.js.map +1 -1
- package/dist/esm/modules/pool/common/types.d.ts +5 -1
- package/dist/esm/modules/pool/common/types.js.map +1 -1
- package/dist/esm/modules/queue/bullmq/helper.d.ts +13 -0
- package/dist/esm/modules/queue/bullmq/helper.js +4 -0
- package/dist/esm/modules/queue/bullmq/helper.js.map +1 -1
- package/dist/esm/modules/queue/common/hook.d.ts +1 -0
- package/dist/esm/modules/queue/common/hook.js +1 -0
- package/dist/esm/modules/queue/common/hook.js.map +1 -1
- package/dist/esm/modules/queue/internal/sequential/common/types.d.ts +8 -0
- package/dist/esm/modules/queue/internal/sequential/common/types.js +1 -0
- package/dist/esm/modules/queue/internal/sequential/common/types.js.map +1 -1
- package/dist/esm/modules/queue/internal/sequential/helper.d.ts +4 -0
- package/dist/esm/modules/queue/internal/sequential/helper.js +4 -0
- package/dist/esm/modules/queue/internal/sequential/helper.js.map +1 -1
- package/dist/esm/modules/queue/kafka/base.d.ts +5 -0
- package/dist/esm/modules/queue/kafka/base.js.map +1 -1
- package/dist/esm/modules/queue/kafka/bundler/common/constants.d.ts +3 -0
- package/dist/esm/modules/queue/kafka/bundler/common/constants.js +3 -0
- package/dist/esm/modules/queue/kafka/bundler/common/constants.js.map +1 -1
- package/dist/esm/modules/queue/kafka/common/constants.d.ts +8 -0
- package/dist/esm/modules/queue/kafka/common/constants.js +5 -0
- package/dist/esm/modules/queue/kafka/common/constants.js.map +1 -1
- package/dist/esm/modules/queue/kafka/common/types/admin.d.ts +1 -0
- package/dist/esm/modules/queue/kafka/common/types/admin.js.map +1 -1
- package/dist/esm/modules/queue/kafka/common/types/callbacks.d.ts +12 -0
- package/dist/esm/modules/queue/kafka/common/types/callbacks.js.map +1 -1
- package/dist/esm/modules/queue/kafka/common/types/connection.d.ts +2 -0
- package/dist/esm/modules/queue/kafka/common/types/connection.js.map +1 -1
- package/dist/esm/modules/queue/kafka/common/types/consumer.d.ts +62 -0
- package/dist/esm/modules/queue/kafka/common/types/consumer.js.map +1 -1
- package/dist/esm/modules/queue/kafka/common/types/producer.d.ts +1 -0
- package/dist/esm/modules/queue/kafka/common/types/producer.js.map +1 -1
- package/dist/esm/modules/queue/mqtt/helper.d.ts +2 -0
- package/dist/esm/modules/queue/mqtt/helper.js +1 -0
- package/dist/esm/modules/queue/mqtt/helper.js.map +1 -1
- package/dist/esm/modules/redis/base/abstract.helper.d.ts +2 -0
- package/dist/esm/modules/redis/base/abstract.helper.js +2 -0
- package/dist/esm/modules/redis/base/abstract.helper.js.map +1 -1
- package/dist/esm/modules/redis/cluster/cluster.helper.d.ts +1 -0
- package/dist/esm/modules/redis/cluster/cluster.helper.js +1 -0
- package/dist/esm/modules/redis/cluster/cluster.helper.js.map +1 -1
- package/dist/esm/modules/redis/common/constants.d.ts +4 -0
- package/dist/esm/modules/redis/common/constants.js +2 -0
- package/dist/esm/modules/redis/common/constants.js.map +1 -1
- package/dist/esm/modules/redis/common/interfaces.d.ts +12 -0
- package/dist/esm/modules/redis/common/interfaces.js.map +1 -1
- package/dist/esm/modules/redis/common/types.d.ts +21 -1
- package/dist/esm/modules/redis/common/types.js.map +1 -1
- package/dist/esm/modules/redis/factory.d.ts +2 -0
- package/dist/esm/modules/redis/factory.js +1 -0
- package/dist/esm/modules/redis/factory.js.map +1 -1
- package/dist/esm/modules/redis/sentinel/sentinel.helper.d.ts +1 -0
- package/dist/esm/modules/redis/sentinel/sentinel.helper.js +1 -0
- package/dist/esm/modules/redis/sentinel/sentinel.helper.js.map +1 -1
- package/dist/esm/modules/redis/single/single.helper.d.ts +1 -0
- package/dist/esm/modules/redis/single/single.helper.js +1 -0
- package/dist/esm/modules/redis/single/single.helper.js.map +1 -1
- package/dist/esm/modules/redis/utility.d.ts +1 -0
- package/dist/esm/modules/redis/utility.js +1 -0
- package/dist/esm/modules/redis/utility.js.map +1 -1
- package/dist/esm/modules/retry/common/constants.d.ts +4 -0
- package/dist/esm/modules/retry/common/constants.js +2 -0
- package/dist/esm/modules/retry/common/constants.js.map +1 -1
- package/dist/esm/modules/retry/common/types.d.ts +19 -5
- package/dist/esm/modules/retry/common/types.js.map +1 -1
- package/dist/esm/modules/retry/helper.d.ts +4 -4
- package/dist/esm/modules/retry/helper.js.map +1 -1
- package/dist/esm/modules/secrets/base/abstract.helper.d.ts +1 -0
- package/dist/esm/modules/secrets/base/abstract.helper.js +1 -0
- package/dist/esm/modules/secrets/base/abstract.helper.js.map +1 -1
- package/dist/esm/modules/secrets/common/constants.d.ts +4 -0
- package/dist/esm/modules/secrets/common/constants.js +2 -0
- package/dist/esm/modules/secrets/common/constants.js.map +1 -1
- package/dist/esm/modules/secrets/common/types/helper.d.ts +13 -0
- package/dist/esm/modules/secrets/common/types/helper.js.map +1 -1
- package/dist/esm/modules/secrets/common/types/lease.d.ts +2 -0
- package/dist/esm/modules/secrets/common/types/lease.js.map +1 -1
- package/dist/esm/modules/secrets/common/types/registration.d.ts +13 -2
- package/dist/esm/modules/secrets/common/types/registration.js.map +1 -1
- package/dist/esm/modules/secrets/common/types/timer.d.ts +1 -0
- package/dist/esm/modules/secrets/common/types/timer.js.map +1 -1
- package/dist/esm/modules/secrets/dotenv/dotenv.helper.d.ts +8 -0
- package/dist/esm/modules/secrets/dotenv/dotenv.helper.js +1 -0
- package/dist/esm/modules/secrets/dotenv/dotenv.helper.js.map +1 -1
- package/dist/esm/modules/secrets/factory.d.ts +1 -0
- package/dist/esm/modules/secrets/factory.js +1 -0
- package/dist/esm/modules/secrets/factory.js.map +1 -1
- package/dist/esm/modules/secrets/hashicorp/auth.d.ts +2 -0
- package/dist/esm/modules/secrets/hashicorp/auth.js +1 -0
- package/dist/esm/modules/secrets/hashicorp/auth.js.map +1 -1
- package/dist/esm/modules/secrets/hashicorp/hashicorp.helper.d.ts +2 -0
- package/dist/esm/modules/secrets/hashicorp/hashicorp.helper.js +1 -0
- package/dist/esm/modules/secrets/hashicorp/hashicorp.helper.js.map +1 -1
- package/dist/esm/modules/secrets/system-envs/system-envs.helper.d.ts +1 -0
- package/dist/esm/modules/secrets/system-envs/system-envs.helper.js +1 -0
- package/dist/esm/modules/secrets/system-envs/system-envs.helper.js.map +1 -1
- package/dist/esm/modules/slug/common/constants.d.ts +1 -0
- package/dist/esm/modules/slug/common/constants.js +1 -0
- package/dist/esm/modules/slug/common/constants.js.map +1 -1
- package/dist/esm/modules/socket/socket-io/common/constants.d.ts +2 -0
- package/dist/esm/modules/socket/socket-io/common/constants.js +2 -0
- package/dist/esm/modules/socket/socket-io/common/constants.js.map +1 -1
- package/dist/esm/modules/socket/socket-io/common/types/client.d.ts +5 -0
- package/dist/esm/modules/socket/socket-io/common/types/client.js.map +1 -1
- package/dist/esm/modules/socket/socket-io/common/types/hooks.d.ts +4 -0
- package/dist/esm/modules/socket/socket-io/common/types/hooks.js.map +1 -1
- package/dist/esm/modules/socket/socket-io/common/types/server.d.ts +6 -0
- package/dist/esm/modules/socket/socket-io/common/types/server.js.map +1 -1
- package/dist/esm/modules/socket/socket-io/server/helper.d.ts +1 -0
- package/dist/esm/modules/socket/socket-io/server/helper.js +1 -0
- package/dist/esm/modules/socket/socket-io/server/helper.js.map +1 -1
- package/dist/esm/modules/socket/websocket/common/constants.d.ts +7 -0
- package/dist/esm/modules/socket/websocket/common/constants.js +5 -0
- package/dist/esm/modules/socket/websocket/common/constants.js.map +1 -1
- package/dist/esm/modules/socket/websocket/common/types/client.d.ts +4 -0
- package/dist/esm/modules/socket/websocket/common/types/client.js.map +1 -1
- package/dist/esm/modules/socket/websocket/common/types/hooks.d.ts +7 -0
- package/dist/esm/modules/socket/websocket/common/types/hooks.js.map +1 -1
- package/dist/esm/modules/socket/websocket/common/types/server.d.ts +30 -0
- package/dist/esm/modules/socket/websocket/common/types/server.js.map +1 -1
- package/dist/esm/modules/socket/websocket/emitter/helper.d.ts +1 -0
- package/dist/esm/modules/socket/websocket/emitter/helper.js +1 -0
- package/dist/esm/modules/socket/websocket/emitter/helper.js.map +1 -1
- package/dist/esm/modules/socket/websocket/server/helper.d.ts +1 -0
- package/dist/esm/modules/socket/websocket/server/helper.js +1 -0
- package/dist/esm/modules/socket/websocket/server/helper.js.map +1 -1
- package/dist/esm/modules/storage/base.d.ts +6 -1
- package/dist/esm/modules/storage/base.js +1 -0
- package/dist/esm/modules/storage/base.js.map +1 -1
- package/dist/esm/modules/storage/bun-s3/helper.d.ts +9 -1
- package/dist/esm/modules/storage/bun-s3/helper.js +2 -1
- package/dist/esm/modules/storage/bun-s3/helper.js.map +1 -1
- package/dist/esm/modules/storage/common/constants.d.ts +1 -0
- package/dist/esm/modules/storage/common/constants.js.map +1 -1
- package/dist/esm/modules/storage/common/types.d.ts +17 -1
- package/dist/esm/modules/storage/common/types.js.map +1 -1
- package/dist/esm/modules/storage/common/utility.d.ts +1 -0
- package/dist/esm/modules/storage/common/utility.js +1 -0
- package/dist/esm/modules/storage/common/utility.js.map +1 -1
- package/dist/esm/modules/storage/disk/helper.d.ts +2 -0
- package/dist/esm/modules/storage/disk/helper.js +1 -0
- package/dist/esm/modules/storage/disk/helper.js.map +1 -1
- package/dist/esm/modules/temporal/abstract.d.ts +5 -0
- package/dist/esm/modules/temporal/abstract.js +2 -1
- package/dist/esm/modules/temporal/abstract.js.map +1 -1
- package/dist/esm/modules/temporal/common/constants.d.ts +3 -0
- package/dist/esm/modules/temporal/common/constants.js.map +1 -1
- package/dist/esm/modules/tree/common/types.d.ts +6 -0
- package/dist/esm/modules/tree/common/types.js.map +1 -1
- package/dist/esm/modules/uid/common/constants.d.ts +1 -0
- package/dist/esm/modules/uid/common/constants.js.map +1 -1
- package/dist/esm/modules/uid/common/types.d.ts +28 -7
- package/dist/esm/modules/uid/common/types.js.map +1 -1
- package/dist/esm/modules/uid/helper.d.ts +12 -0
- package/dist/esm/modules/uid/helper.js.map +1 -1
- package/dist/esm/modules/uid/uuid/v4.d.ts +1 -0
- package/dist/esm/modules/uid/uuid/v4.js +1 -0
- package/dist/esm/modules/uid/uuid/v4.js.map +1 -1
- package/dist/esm/modules/uid/uuid/v5.d.ts +1 -0
- package/dist/esm/modules/uid/uuid/v5.js +1 -0
- package/dist/esm/modules/uid/uuid/v5.js.map +1 -1
- package/dist/esm/modules/uid/uuid/v7.d.ts +1 -0
- package/dist/esm/modules/uid/uuid/v7.js +1 -0
- package/dist/esm/modules/uid/uuid/v7.js.map +1 -1
- package/dist/esm/modules/worker-thread/bus/abstract.d.ts +1 -0
- package/dist/esm/modules/worker-thread/bus/abstract.js +1 -0
- package/dist/esm/modules/worker-thread/bus/abstract.js.map +1 -1
- package/dist/esm/modules/worker-thread/bus/base.d.ts +1 -0
- package/dist/esm/modules/worker-thread/bus/base.js +1 -0
- package/dist/esm/modules/worker-thread/bus/base.js.map +1 -1
- package/dist/esm/modules/worker-thread/bus/handler/abstract.d.ts +1 -0
- package/dist/esm/modules/worker-thread/bus/handler/abstract.js +1 -0
- package/dist/esm/modules/worker-thread/bus/handler/abstract.js.map +1 -1
- package/dist/esm/modules/worker-thread/bus/handler/base.d.ts +1 -0
- package/dist/esm/modules/worker-thread/bus/handler/base.js +1 -0
- package/dist/esm/modules/worker-thread/bus/handler/base.js.map +1 -1
- package/dist/esm/modules/worker-thread/common/types.d.ts +4 -0
- package/dist/esm/modules/worker-thread/common/types.js.map +1 -1
- package/dist/esm/modules/worker-thread/thread/abstract.d.ts +1 -0
- package/dist/esm/modules/worker-thread/thread/abstract.js +1 -0
- package/dist/esm/modules/worker-thread/thread/abstract.js.map +1 -1
- package/dist/esm/modules/worker-thread/thread/base.d.ts +1 -0
- package/dist/esm/modules/worker-thread/thread/base.js +1 -0
- package/dist/esm/modules/worker-thread/thread/base.js.map +1 -1
- package/dist/esm/modules/worker-thread/worker/abstract.d.ts +1 -0
- package/dist/esm/modules/worker-thread/worker/abstract.js +1 -0
- package/dist/esm/modules/worker-thread/worker/abstract.js.map +1 -1
- package/dist/esm/modules/worker-thread/worker/base.d.ts +1 -0
- package/dist/esm/modules/worker-thread/worker/base.js +1 -0
- package/dist/esm/modules/worker-thread/worker/base.js.map +1 -1
- package/dist/esm/modules/worker-thread/worker-pool.d.ts +1 -0
- package/dist/esm/modules/worker-thread/worker-pool.js +1 -0
- package/dist/esm/modules/worker-thread/worker-pool.js.map +1 -1
- package/dist/esm/utilities/error.utility.d.ts +1 -0
- package/dist/esm/utilities/error.utility.js +1 -0
- package/dist/esm/utilities/error.utility.js.map +1 -1
- package/dist/esm/utilities/form-body.utility.d.ts +1 -0
- package/dist/esm/utilities/form-body.utility.js +1 -0
- package/dist/esm/utilities/form-body.utility.js.map +1 -1
- package/dist/esm/utilities/hr-time.utility.d.ts +1 -0
- package/dist/esm/utilities/hr-time.utility.js +1 -0
- package/dist/esm/utilities/hr-time.utility.js.map +1 -1
- package/dist/esm/utilities/performance.utility.d.ts +1 -0
- package/dist/esm/utilities/performance.utility.js +1 -0
- package/dist/esm/utilities/performance.utility.js.map +1 -1
- package/dist/esm/utilities/promise.utility.d.ts +1 -0
- package/dist/esm/utilities/promise.utility.js.map +1 -1
- package/dist/esm/utilities/request.utility.d.ts +2 -0
- package/dist/esm/utilities/request.utility.js +1 -0
- package/dist/esm/utilities/request.utility.js.map +1 -1
- package/package.json +3 -3
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"base-network-request.helper.js","sourceRoot":"","sources":["../../../../../src/modules/network/http-request/base-network-request.helper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,yBAAyB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAK3C,MAAM,OAAO,kBAA8C,SAAQ,UAAU;IAI3E,YAAY,IAIX;QACC,KAAK,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;QACnD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;QAClC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;IAC9B,CAAC;IAED,cAAc,CAAC,IAA8B;QAC3C,MAAM,KAAK,GAAG,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC;QAEhC,MAAM,EAAE,GAAG,KAAK;aACb,GAAG,CAAC,CAAC,IAAY,EAAE,EAAE;YACpB,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC1B,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;YACpB,CAAC;YAED,OAAO,IAAI,CAAC;QACd,CAAC,CAAC;aACD,IAAI,CAAC,EAAE,CAAC,CAAC;QAEZ,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,aAAa,CAAC,IAAgD;QAC5D,IAAI,OAAO,GAAG,IAAI,EAAE,OAAO,IAAI,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;QAClD,MAAM,KAAK,GAAG,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC;QAEhC,IAAI,CAAC,OAAO,IAAI,aAAa,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;YAC1D,MAAM,QAAQ,CAAC;gBACb,UAAU,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,mBAAmB;gBACrD,OAAO,EAAE,yEAAyE;aACnF,CAAC,CAAC;QACL,CAAC;QAED,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1B,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACjC,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;QAE9C,OAAO,GAAG,OAAO,IAAI,IAAI,CAAC,OAAO,GAAG,MAAM,EAAE,CAAC;IAC/C,CAAC;IAED,iBAAiB;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;IAClC,CAAC;CACF","sourcesContent":["import { HTTP } from '@/common/constants/http';\nimport { ObjectUtility } from '@venizia/ignis-inversion';\nimport { BaseHelper } from '@/modules/base';\nimport { getError } from '@/modules/error';\nimport { type TFetcherVariant } from './common';\nimport { type IFetchable, type IRequestOptions } from './fetcher/base-fetcher';\nimport { type TFetcherResponse, type TFetcherWorker } from './fetcher/common';\n\nexport class BaseNetworkRequest<T extends TFetcherVariant> extends BaseHelper {\n protected baseUrl: string;\n protected fetcher: IFetchable<T, IRequestOptions, TFetcherResponse<T>, TFetcherWorker<T>>;\n\n constructor(opts: {\n name: string;\n baseUrl?: string;\n fetcher: IFetchable<T, IRequestOptions, TFetcherResponse<T>, TFetcherWorker<T>>;\n }) {\n super({ scope: opts.name, identifier: opts.name });\n this.baseUrl = opts.baseUrl ?? '';\n this.fetcher = opts.fetcher;\n }\n\n getRequestPath(opts: { paths: Array<string> }) {\n const paths = opts?.paths ?? [];\n\n const rs = paths\n .map((path: string) => {\n if (!path.startsWith('/')) {\n path = `/${path}`;\n }\n\n return path;\n })\n .join('');\n\n return rs;\n }\n\n getRequestUrl(opts: { baseUrl?: string; paths: Array<string> }) {\n let baseUrl = opts?.baseUrl ?? this.baseUrl ?? '';\n const paths = opts?.paths ?? [];\n\n if (!baseUrl || ObjectUtility.isEmpty({ value: baseUrl })) {\n throw getError({\n statusCode: HTTP.ResultCodes.RS_5.InternalServerError,\n message: '[getRequestUrl] Invalid configuration for third party request base url!',\n });\n }\n\n if (baseUrl.endsWith('/')) {\n baseUrl = baseUrl.slice(0, -1);\n }\n\n const joined = this.getRequestPath({ paths });\n\n return `${baseUrl ?? this.baseUrl}${joined}`;\n }\n\n getNetworkService() {\n return this.fetcher;\n }\n\n getWorker(): TFetcherWorker<T> {\n return this.fetcher.getWorker();\n }\n}\n"]}
|
|
1
|
+
{"version":3,"file":"base-network-request.helper.js","sourceRoot":"","sources":["../../../../../src/modules/network/http-request/base-network-request.helper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,yBAAyB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAK3C,gMAAgM;AAChM,MAAM,OAAO,kBAA8C,SAAQ,UAAU;IAI3E,YAAY,IAIX;QACC,KAAK,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;QACnD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;QAClC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;IAC9B,CAAC;IAED,cAAc,CAAC,IAA8B;QAC3C,MAAM,KAAK,GAAG,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC;QAEhC,MAAM,EAAE,GAAG,KAAK;aACb,GAAG,CAAC,CAAC,IAAY,EAAE,EAAE;YACpB,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC1B,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;YACpB,CAAC;YAED,OAAO,IAAI,CAAC;QACd,CAAC,CAAC;aACD,IAAI,CAAC,EAAE,CAAC,CAAC;QAEZ,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,aAAa,CAAC,IAAgD;QAC5D,IAAI,OAAO,GAAG,IAAI,EAAE,OAAO,IAAI,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;QAClD,MAAM,KAAK,GAAG,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC;QAEhC,IAAI,CAAC,OAAO,IAAI,aAAa,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;YAC1D,MAAM,QAAQ,CAAC;gBACb,UAAU,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,mBAAmB;gBACrD,OAAO,EAAE,yEAAyE;aACnF,CAAC,CAAC;QACL,CAAC;QAED,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1B,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACjC,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;QAE9C,OAAO,GAAG,OAAO,IAAI,IAAI,CAAC,OAAO,GAAG,MAAM,EAAE,CAAC;IAC/C,CAAC;IAED,iBAAiB;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;IAClC,CAAC;CACF","sourcesContent":["import { HTTP } from '@/common/constants/http';\nimport { ObjectUtility } from '@venizia/ignis-inversion';\nimport { BaseHelper } from '@/modules/base';\nimport { getError } from '@/modules/error';\nimport { type TFetcherVariant } from './common';\nimport { type IFetchable, type IRequestOptions } from './fetcher/base-fetcher';\nimport { type TFetcherResponse, type TFetcherWorker } from './fetcher/common';\n\n/** Base of a client for one third-party HTTP API: holds the `baseUrl` and a fetcher, and builds request urls from path segments. `getRequestUrl` throws a 500 error when no base url is set. */\nexport class BaseNetworkRequest<T extends TFetcherVariant> extends BaseHelper {\n protected baseUrl: string;\n protected fetcher: IFetchable<T, IRequestOptions, TFetcherResponse<T>, TFetcherWorker<T>>;\n\n constructor(opts: {\n name: string;\n baseUrl?: string;\n fetcher: IFetchable<T, IRequestOptions, TFetcherResponse<T>, TFetcherWorker<T>>;\n }) {\n super({ scope: opts.name, identifier: opts.name });\n this.baseUrl = opts.baseUrl ?? '';\n this.fetcher = opts.fetcher;\n }\n\n getRequestPath(opts: { paths: Array<string> }) {\n const paths = opts?.paths ?? [];\n\n const rs = paths\n .map((path: string) => {\n if (!path.startsWith('/')) {\n path = `/${path}`;\n }\n\n return path;\n })\n .join('');\n\n return rs;\n }\n\n getRequestUrl(opts: { baseUrl?: string; paths: Array<string> }) {\n let baseUrl = opts?.baseUrl ?? this.baseUrl ?? '';\n const paths = opts?.paths ?? [];\n\n if (!baseUrl || ObjectUtility.isEmpty({ value: baseUrl })) {\n throw getError({\n statusCode: HTTP.ResultCodes.RS_5.InternalServerError,\n message: '[getRequestUrl] Invalid configuration for third party request base url!',\n });\n }\n\n if (baseUrl.endsWith('/')) {\n baseUrl = baseUrl.slice(0, -1);\n }\n\n const joined = this.getRequestPath({ paths });\n\n return `${baseUrl ?? this.baseUrl}${joined}`;\n }\n\n getNetworkService() {\n return this.fetcher;\n }\n\n getWorker(): TFetcherWorker<T> {\n return this.fetcher.getWorker();\n }\n}\n"]}
|
|
@@ -3,19 +3,17 @@ import { type AxiosInstance, type AxiosRequestConfig, type AxiosResponse } from
|
|
|
3
3
|
import { BaseNetworkRequest } from '../base-network-request.helper.js';
|
|
4
4
|
import type { ILogger } from '../../../logger/common/types.js';
|
|
5
5
|
import { AbstractNetworkFetchableHelper, type IRequestOptions } from './base-fetcher.js';
|
|
6
|
+
/** Request accepted by `AxiosFetcher`: an axios config where `body` is sent as the axios `data`. `rejectUnauthorized` set here overrides the instance setting for this call. */
|
|
6
7
|
export interface IAxiosRequestOptions extends AxiosRequestConfig, IRequestOptions {
|
|
7
8
|
url: string;
|
|
8
9
|
method?: THttpMethod;
|
|
9
10
|
params?: AnyObject;
|
|
10
11
|
body?: AnyObject;
|
|
11
12
|
headers?: AnyObject;
|
|
12
|
-
/**
|
|
13
|
-
* Declared so the opt-out is TYPED. It used to reach the agent only through the
|
|
14
|
-
* `[extra: string]: any` index signature on {@link IRequestOptions}, which meant nothing told a
|
|
15
|
-
* caller the option existed, and nothing stopped a typo from silently doing nothing.
|
|
16
|
-
*/
|
|
13
|
+
/** Whether this call rejects an HTTPS server whose certificate fails verification; `false` turns verification off for this call. */
|
|
17
14
|
rejectUnauthorized?: boolean;
|
|
18
15
|
}
|
|
16
|
+
/** Fetcher over an axios instance (`getWorker()`). HTTPS calls share one keep-alive agent that verifies certificates unless `rejectUnauthorized` is `false`; an `httpsAgent` passed in the request wins. */
|
|
19
17
|
export declare class AxiosFetcher extends AbstractNetworkFetchableHelper<'axios', IAxiosRequestOptions, AxiosResponse<any, any>['data'], AxiosInstance> {
|
|
20
18
|
/**
|
|
21
19
|
* One agent for the instance, not one per request. Built here so TLS verification is decided
|
|
@@ -29,20 +27,22 @@ export declare class AxiosFetcher extends AbstractNetworkFetchableHelper<'axios'
|
|
|
29
27
|
defaultConfigs: AxiosRequestConfig;
|
|
30
28
|
logger?: ILogger;
|
|
31
29
|
/**
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
30
|
+
* Whether this instance rejects an HTTPS server whose certificate fails verification.
|
|
31
|
+
* `false` turns verification off.
|
|
32
|
+
* @default true
|
|
35
33
|
*/
|
|
36
34
|
rejectUnauthorized?: boolean;
|
|
37
35
|
});
|
|
38
36
|
send<T = any>(opts: IAxiosRequestOptions, logger?: ILogger): Promise<AxiosResponse<T, any, {}, any>>;
|
|
39
37
|
}
|
|
38
|
+
/** Options of `AxiosNetworkRequest`: an axios config with `baseUrl` in place of `baseURL`. */
|
|
40
39
|
export interface IAxiosNetworkRequestOptions {
|
|
41
40
|
name: string;
|
|
42
41
|
networkOptions: Omit<AxiosRequestConfig, 'baseURL'> & {
|
|
43
42
|
baseUrl?: string;
|
|
44
43
|
};
|
|
45
44
|
}
|
|
45
|
+
/** `BaseNetworkRequest` over an `AxiosFetcher`. Defaults: JSON content type, 60000 ms `timeout`, and no rejection for status below 500 (`validateStatus`). */
|
|
46
46
|
export declare class AxiosNetworkRequest extends BaseNetworkRequest<'axios'> {
|
|
47
47
|
constructor(opts: IAxiosNetworkRequestOptions);
|
|
48
48
|
}
|
|
@@ -5,6 +5,7 @@ import https from 'node:https';
|
|
|
5
5
|
import { stringify } from 'node:querystring';
|
|
6
6
|
import { BaseNetworkRequest } from '../base-network-request.helper.js';
|
|
7
7
|
import { AbstractNetworkFetchableHelper } from './base-fetcher.js';
|
|
8
|
+
/** Fetcher over an axios instance (`getWorker()`). HTTPS calls share one keep-alive agent that verifies certificates unless `rejectUnauthorized` is `false`; an `httpsAgent` passed in the request wins. */
|
|
8
9
|
export class AxiosFetcher extends AbstractNetworkFetchableHelper {
|
|
9
10
|
constructor(opts) {
|
|
10
11
|
super({ name: opts.name, variant: 'axios' });
|
|
@@ -44,6 +45,7 @@ export class AxiosFetcher extends AbstractNetworkFetchableHelper {
|
|
|
44
45
|
return this.worker.request(props);
|
|
45
46
|
}
|
|
46
47
|
}
|
|
48
|
+
/** `BaseNetworkRequest` over an `AxiosFetcher`. Defaults: JSON content type, 60000 ms `timeout`, and no rejection for status below 500 (`validateStatus`). */
|
|
47
49
|
export class AxiosNetworkRequest extends BaseNetworkRequest {
|
|
48
50
|
constructor(opts) {
|
|
49
51
|
const { name, networkOptions } = opts;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"axios-fetcher.js","sourceRoot":"","sources":["../../../../../../src/modules/network/http-request/fetcher/axios-fetcher.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,IAAI,EAAoB,MAAM,UAAU,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAA0E,MAAM,OAAO,CAAC;AAC/F,OAAO,KAAK,MAAM,YAAY,CAAC;AAC/B,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAEpE,OAAO,EAAE,8BAA8B,EAAwB,MAAM,gBAAgB,CAAC;
|
|
1
|
+
{"version":3,"file":"axios-fetcher.js","sourceRoot":"","sources":["../../../../../../src/modules/network/http-request/fetcher/axios-fetcher.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,IAAI,EAAoB,MAAM,UAAU,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAA0E,MAAM,OAAO,CAAC;AAC/F,OAAO,KAAK,MAAM,YAAY,CAAC;AAC/B,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAEpE,OAAO,EAAE,8BAA8B,EAAwB,MAAM,gBAAgB,CAAC;AAatF,4MAA4M;AAC5M,MAAM,OAAO,YAAa,SAAQ,8BAOjC;IASC,YAAY,IAUX;QACC,KAAK,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;QAC7C,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC;QAChC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,wDAAwD,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAExF,IAAI,CAAC,UAAU,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC;YAChC,SAAS,EAAE,IAAI;YACf,kBAAkB,EAAE,IAAI,CAAC,kBAAkB,IAAI,IAAI;SACpD,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,cAAc,EAAE,CAAC,CAAC;IACpD,CAAC;IAEQ,IAAI,CAAU,IAA0B,EAAE,MAAgB;QACjE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;QAC3F,MAAM,KAAK,GAAuB;YAChC,GAAG;YACH,MAAM,EAAE,MAAM,CAAC,WAAW,EAAE;YAC5B,MAAM;YACN,IAAI;YACJ,OAAO;YACP,gBAAgB,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE;YACpD,GAAG,IAAI;SACR,CAAC;QAEF,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAEvC,IAAI,QAAQ,KAAK,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;YACtC,yFAAyF;YACzF,sFAAsF;YACtF,uCAAuC;YACvC,KAAK,CAAC,UAAU;gBACd,IAAI,CAAC,UAAU;oBACf,CAAC,IAAI,CAAC,kBAAkB,KAAK,SAAS;wBACpC,CAAC,CAAC,IAAI,CAAC,UAAU;wBACjB,CAAC,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,kBAAkB,EAAE,IAAI,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAC;QAC3F,CAAC;QAED,MAAM;YACJ,EAAE,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;aACpB,IAAI,CAAC,qBAAqB,EAAE,GAAG,EAAE,aAAa,CAAC,aAAa,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;QAEnF,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAI,KAAK,CAAC,CAAC;IACvC,CAAC;CACF;AAUD,8JAA8J;AAC9J,MAAM,OAAO,mBAAoB,SAAQ,kBAA2B;IAClE,YAAY,IAAiC;QAC3C,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC;QACtC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,cAAc,CAAC;QAE9D,MAAM,aAAa,GAAc;YAC/B,CAAC,cAAc,CAAC,EAAE,iCAAiC;YACnD,GAAG,OAAO;SACX,CAAC;QAEF,MAAM,cAAc,GAAuB;YACzC,eAAe,EAAE,IAAI;YACrB,cAAc,EAAE,CAAC,MAAc,EAAE,EAAE,CAAC,MAAM,GAAG,GAAG;YAChD,OAAO,EAAE,OAAO,IAAI,EAAE,GAAG,IAAI;YAC7B,GAAG,IAAI;YACP,OAAO,EAAE,OAAO;YAChB,OAAO,EAAE,aAAa;SACvB,CAAC;QAEF,KAAK,CAAC;YACJ,IAAI;YACJ,OAAO;YACP,OAAO,EAAE,IAAI,YAAY,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC;SACpD,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["import { type AnyObject, HTTP, type THttpMethod } from '@/common';\nimport { RedactUtility } from '@/common/redact';\nimport axios, { type AxiosInstance, type AxiosRequestConfig, type AxiosResponse } from 'axios';\nimport https from 'node:https';\nimport { stringify } from 'node:querystring';\nimport { BaseNetworkRequest } from '../base-network-request.helper';\nimport type { ILogger } from '@/modules/logger/common/types';\nimport { AbstractNetworkFetchableHelper, type IRequestOptions } from './base-fetcher';\n\n/** Request accepted by `AxiosFetcher`: an axios config where `body` is sent as the axios `data`. `rejectUnauthorized` set here overrides the instance setting for this call. */\nexport interface IAxiosRequestOptions extends AxiosRequestConfig, IRequestOptions {\n url: string;\n method?: THttpMethod;\n params?: AnyObject;\n body?: AnyObject;\n headers?: AnyObject;\n /** Whether this call rejects an HTTPS server whose certificate fails verification; `false` turns verification off for this call. */\n rejectUnauthorized?: boolean;\n}\n\n/** Fetcher over an axios instance (`getWorker()`). HTTPS calls share one keep-alive agent that verifies certificates unless `rejectUnauthorized` is `false`; an `httpsAgent` passed in the request wins. */\nexport class AxiosFetcher extends AbstractNetworkFetchableHelper<\n 'axios',\n IAxiosRequestOptions,\n // The named type, not the `axios.` NAMESPACE: the namespace form resolves only under node16\n // module resolution, and this package also emits an ESM build under `bundler` resolution.\n AxiosResponse<any, any>['data'],\n AxiosInstance\n> {\n /**\n * One agent for the instance, not one per request. Built here so TLS verification is decided\n * ONCE, at construction, rather than per call - and so connections are actually reused: a fresh\n * agent per request forces a new TCP and TLS handshake every time (measured: 10 handshakes for 10\n * requests, versus 1).\n */\n private readonly httpsAgent: https.Agent;\n\n constructor(opts: {\n name: string;\n defaultConfigs: AxiosRequestConfig;\n logger?: ILogger;\n /**\n * Whether this instance rejects an HTTPS server whose certificate fails verification.\n * `false` turns verification off.\n * @default true\n */\n rejectUnauthorized?: boolean;\n }) {\n super({ name: opts.name, variant: 'axios' });\n const { defaultConfigs } = opts;\n opts?.logger?.info('Creating new network request worker instance! Name: %s', this.name);\n\n this.httpsAgent = new https.Agent({\n keepAlive: true,\n rejectUnauthorized: opts.rejectUnauthorized ?? true,\n });\n\n this.worker = axios.create({ ...defaultConfigs });\n }\n\n override send<T = any>(opts: IAxiosRequestOptions, logger?: ILogger) {\n const { url, method = HTTP.Methods.GET, params = {}, body: data, headers, ...rest } = opts;\n const props: AxiosRequestConfig = {\n url,\n method: method.toUpperCase(),\n params,\n data,\n headers,\n paramsSerializer: { serialize: (p) => stringify(p) },\n ...rest,\n };\n\n const protocol = this.getProtocol(url);\n\n if (protocol === HTTP.Protocols.HTTPS) {\n // A caller's own agent WINS. The previous code assigned after the `...rest` spread, so a\n // hardened agent - custom CA, pinning, mTLS - was overwritten and the secure path was\n // unreachable through the public seam.\n props.httpsAgent =\n rest.httpsAgent ??\n (opts.rejectUnauthorized === undefined\n ? this.httpsAgent\n : new https.Agent({ keepAlive: true, rejectUnauthorized: opts.rejectUnauthorized }));\n }\n\n logger\n ?.for(this.send.name)\n .info('URL: %s | Props: %s', url, RedactUtility.redactSecrets({ value: props }));\n\n return this.worker.request<T>(props);\n }\n}\n\n/** Options of `AxiosNetworkRequest`: an axios config with `baseUrl` in place of `baseURL`. */\nexport interface IAxiosNetworkRequestOptions {\n name: string;\n networkOptions: Omit<AxiosRequestConfig, 'baseURL'> & {\n baseUrl?: string;\n };\n}\n\n/** `BaseNetworkRequest` over an `AxiosFetcher`. Defaults: JSON content type, 60000 ms `timeout`, and no rejection for status below 500 (`validateStatus`). */\nexport class AxiosNetworkRequest extends BaseNetworkRequest<'axios'> {\n constructor(opts: IAxiosNetworkRequestOptions) {\n const { name, networkOptions } = opts;\n const { headers, baseUrl, timeout, ...rest } = networkOptions;\n\n const mergedHeaders: AnyObject = {\n ['content-type']: 'application/json; charset=utf-8',\n ...headers,\n };\n\n const defaultConfigs: AxiosRequestConfig = {\n withCredentials: true,\n validateStatus: (status: number) => status < 500,\n timeout: timeout ?? 60 * 1000,\n ...rest,\n baseURL: baseUrl,\n headers: mergedHeaders,\n };\n\n super({\n name,\n baseUrl,\n fetcher: new AxiosFetcher({ name, defaultConfigs }),\n });\n }\n}\n"]}
|
|
@@ -4,6 +4,7 @@ import type { ILogger } from '../../../logger/common/types.js';
|
|
|
4
4
|
import { type TFetcherVariant } from '../common/index.js';
|
|
5
5
|
/** 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. */
|
|
6
6
|
export type TFetcherLogger = Pick<ILogger, 'debug' | 'info'>;
|
|
7
|
+
/** Options every fetcher accepts. `timeout` is in milliseconds; other keys pass through to the underlying client. */
|
|
7
8
|
export interface IRequestOptions {
|
|
8
9
|
url: string;
|
|
9
10
|
method?: THttpMethod;
|
|
@@ -11,6 +12,7 @@ export interface IRequestOptions {
|
|
|
11
12
|
timeout?: number;
|
|
12
13
|
[extra: symbol | string]: any;
|
|
13
14
|
}
|
|
15
|
+
/** Contract of an HTTP fetcher: `send` takes the method from the options, the verb methods fix it, and `getWorker` returns the underlying client (`W`). */
|
|
14
16
|
export interface IFetchable<V extends TFetcherVariant, RQ extends IRequestOptions, RS, W = unknown> {
|
|
15
17
|
send(opts: RQ, logger?: TFetcherLogger): Promise<RS>;
|
|
16
18
|
get(opts: RQ, logger?: TFetcherLogger): Promise<RS>;
|
|
@@ -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;
|
|
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;AAsCjE,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;QAEzB,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;QAEzB,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;QAEzB,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;QAEzB,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;QAEzB,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;QAEzB,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\n/** Options every fetcher accepts. `timeout` is in milliseconds; other keys pass through to the underlying client. */\nexport interface IRequestOptions {\n url: string;\n method?: THttpMethod;\n params?: AnyObject;\n timeout?: number;\n [extra: symbol | string]: any;\n}\n\n/** Contract of an HTTP fetcher: `send` takes the method from the options, the verb methods fix it, and `getWorker` returns the underlying client (`W`). */\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\n return this.send({ ...rest, method: HTTP.Methods.GET }, logger);\n }\n\n post(opts: RQ, logger?: TFetcherLogger) {\n const { ...rest } = opts;\n\n return this.send({ ...rest, method: HTTP.Methods.POST }, logger);\n }\n\n put(opts: RQ, logger?: TFetcherLogger) {\n const { ...rest } = opts;\n\n return this.send({ ...rest, method: HTTP.Methods.PUT }, logger);\n }\n\n patch(opts: RQ, logger?: TFetcherLogger) {\n const { ...rest } = opts;\n\n return this.send({ ...rest, method: HTTP.Methods.PATCH }, logger);\n }\n\n delete(opts: RQ, logger?: TFetcherLogger) {\n const { ...rest } = opts;\n\n return this.send({ ...rest, method: HTTP.Methods.DELETE }, logger);\n }\n\n query(opts: RQ, logger?: TFetcherLogger) {\n const { ...rest } = opts;\n\n return this.send({ ...rest, method: HTTP.Methods.QUERY }, logger);\n }\n}\n"]}
|
|
@@ -3,18 +3,20 @@ import { type AnyObject } from '../../../../common/types/index.js';
|
|
|
3
3
|
import { type IQueryStringOptions } from '../../utilities/query-string.js';
|
|
4
4
|
import { BaseNetworkRequest } from '../base-network-request.helper.js';
|
|
5
5
|
import { AbstractNetworkFetchableHelper, type IRequestOptions, type TFetcherLogger } from './base-fetcher.js';
|
|
6
|
+
/** Request accepted by `NodeFetcher`: `RequestInit` plus `url`; `params` are written into the url query. */
|
|
6
7
|
export interface INodeFetchRequestOptions extends RequestInit, IRequestOptions {
|
|
7
8
|
url: string;
|
|
8
9
|
method?: THttpMethod;
|
|
9
10
|
params?: AnyObject;
|
|
10
11
|
}
|
|
12
|
+
/** Fetcher over the global `fetch` (`getWorker()`). `timeout` (milliseconds) aborts the request and is combined with a `signal` the caller passes. */
|
|
11
13
|
export declare class NodeFetcher extends AbstractNetworkFetchableHelper<'node-fetch', INodeFetchRequestOptions, Awaited<ReturnType<typeof fetch>>, typeof fetch> {
|
|
12
14
|
private defaultConfigs;
|
|
13
15
|
private queryString;
|
|
14
16
|
constructor(opts: {
|
|
15
17
|
name: string;
|
|
16
18
|
defaultConfigs: RequestInit;
|
|
17
|
-
/** How `params` are written into the url;
|
|
19
|
+
/** How `params` are written into the url; unset fields behave as `node:querystring` does. */
|
|
18
20
|
queryString?: IQueryStringOptions;
|
|
19
21
|
logger?: TFetcherLogger;
|
|
20
22
|
});
|
|
@@ -24,6 +26,7 @@ export declare class NodeFetcher extends AbstractNetworkFetchableHelper<'node-fe
|
|
|
24
26
|
}): RequestInit['body'] | undefined;
|
|
25
27
|
send(opts: INodeFetchRequestOptions, logger?: TFetcherLogger): Promise<Response>;
|
|
26
28
|
}
|
|
29
|
+
/** Options of `NodeFetchNetworkRequest`: `RequestInit` plus `baseUrl` and `queryString`, which sets how `params` are written into every url. */
|
|
27
30
|
export interface INodeFetchNetworkRequestOptions {
|
|
28
31
|
name: string;
|
|
29
32
|
networkOptions: RequestInit & {
|
|
@@ -32,6 +35,7 @@ export interface INodeFetchNetworkRequestOptions {
|
|
|
32
35
|
queryString?: IQueryStringOptions;
|
|
33
36
|
};
|
|
34
37
|
}
|
|
38
|
+
/** `BaseNetworkRequest` over a `NodeFetcher`. Request headers default to a JSON content type, and the caller's headers win. */
|
|
35
39
|
export declare class NodeFetchNetworkRequest extends BaseNetworkRequest<'node-fetch'> {
|
|
36
40
|
constructor(opts: INodeFetchNetworkRequestOptions);
|
|
37
41
|
}
|
|
@@ -13,6 +13,7 @@ const isRawBody = (body) => {
|
|
|
13
13
|
return typeof ctor === 'function' && body instanceof ctor;
|
|
14
14
|
});
|
|
15
15
|
};
|
|
16
|
+
/** Fetcher over the global `fetch` (`getWorker()`). `timeout` (milliseconds) aborts the request and is combined with a `signal` the caller passes. */
|
|
16
17
|
export class NodeFetcher extends AbstractNetworkFetchableHelper {
|
|
17
18
|
constructor(opts) {
|
|
18
19
|
super({ name: opts.name, variant: 'node-fetch', worker: fetch });
|
|
@@ -87,6 +88,7 @@ export class NodeFetcher extends AbstractNetworkFetchableHelper {
|
|
|
87
88
|
}
|
|
88
89
|
}
|
|
89
90
|
}
|
|
91
|
+
/** `BaseNetworkRequest` over a `NodeFetcher`. Request headers default to a JSON content type, and the caller's headers win. */
|
|
90
92
|
export class NodeFetchNetworkRequest extends BaseNetworkRequest {
|
|
91
93
|
constructor(opts) {
|
|
92
94
|
const { name, networkOptions } = opts;
|
|
@@ -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,EAEL,qBAAqB,EACrB,kBAAkB,GACnB,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;QAE3C,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;YAC7B,CAAC,CAAC,kBAAkB,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;YACnE,CAAC,CAAC,EAAE,CAAC;QACP,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,aAAa,CAAC,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC,EACvD,OAAO,CACR,CAAC;QAEF,IAAI,CAAC;YACH,MAAM,EAAE,GAAG,MAAM,KAAK,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;YAEnD,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 { RedactUtility } from '@/common/redact';\nimport { HTTP, type THttpMethod } from '@/common/constants/http';\nimport { type AnyObject } from '@/common/types';\nimport {\n type IQueryStringOptions,\n QueryStringSeparators,\n QueryStringUtility,\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\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\n ? QueryStringUtility.toQueryString({ params, ...this.queryString })\n : '';\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 RedactUtility.redactSecrets({ value: loggableConfigs }),\n timeout,\n );\n\n try {\n const rs = await fetch(requestUrl, requestConfigs);\n\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"]}
|
|
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,kBAAkB,GACnB,MAAM,8BAA8B,CAAC;AAEtC,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EACL,8BAA8B,GAG/B,MAAM,gBAAgB,CAAC;AASxB,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;QAE3C,OAAO,OAAO,IAAI,KAAK,UAAU,IAAI,IAAI,YAAY,IAAI,CAAC;IAC5D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,sJAAsJ;AACtJ,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;YAC7B,CAAC,CAAC,kBAAkB,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;YACnE,CAAC,CAAC,EAAE,CAAC;QACP,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,aAAa,CAAC,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC,EACvD,OAAO,CACR,CAAC;QAEF,IAAI,CAAC;YACH,MAAM,EAAE,GAAG,MAAM,KAAK,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;YAEnD,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;AAYD,+HAA+H;AAC/H,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 { RedactUtility } from '@/common/redact';\nimport { HTTP, type THttpMethod } from '@/common/constants/http';\nimport { type AnyObject } from '@/common/types';\nimport {\n type IQueryStringOptions,\n QueryStringSeparators,\n QueryStringUtility,\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\n/** Request accepted by `NodeFetcher`: `RequestInit` plus `url`; `params` are written into the url query. */\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\n return typeof ctor === 'function' && body instanceof ctor;\n });\n};\n\n/** Fetcher over the global `fetch` (`getWorker()`). `timeout` (milliseconds) aborts the request and is combined with a `signal` the caller passes. */\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; unset fields behave as `node:querystring` does. */\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\n ? QueryStringUtility.toQueryString({ params, ...this.queryString })\n : '';\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 RedactUtility.redactSecrets({ value: loggableConfigs }),\n timeout,\n );\n\n try {\n const rs = await fetch(requestUrl, requestConfigs);\n\n return rs;\n } finally {\n if (timeoutId) {\n clearTimeout(timeoutId);\n }\n }\n }\n}\n\n/** Options of `NodeFetchNetworkRequest`: `RequestInit` plus `baseUrl` and `queryString`, which sets how `params` are written into every url. */\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\n/** `BaseNetworkRequest` over a `NodeFetcher`. Request headers default to a JSON content type, and the caller's headers win. */\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"]}
|
|
@@ -2,12 +2,22 @@ import { BaseHelper } from '../../base.js';
|
|
|
2
2
|
import { type ValueOrPromise } from '../../../common/index.js';
|
|
3
3
|
import { type TcpSocketConnectOpts as PlainConnectionOptions, type Socket as PlainSocketClient } from 'node:net';
|
|
4
4
|
import { type ConnectionOptions as TlsConnectionOptions, type TLSSocket as TlsSocketClient } from 'node:tls';
|
|
5
|
+
/** Options of a TCP client. `createClientFn` opens the socket, so one client type serves plain and TLS. */
|
|
5
6
|
export interface INetworkTcpClientProps<SocketClientOptions extends PlainConnectionOptions | TlsConnectionOptions, SocketClientType extends PlainSocketClient | TlsSocketClient> {
|
|
6
7
|
identifier: string;
|
|
7
8
|
scope?: string;
|
|
8
9
|
options: SocketClientOptions;
|
|
10
|
+
/**
|
|
11
|
+
* Retries after a close, up to `maxRetry` times.
|
|
12
|
+
* @default false
|
|
13
|
+
*/
|
|
9
14
|
reconnect?: boolean;
|
|
15
|
+
/**
|
|
16
|
+
* How many reconnects `reconnect` attempts.
|
|
17
|
+
* @default 5
|
|
18
|
+
*/
|
|
10
19
|
maxRetry?: number;
|
|
20
|
+
/** When set, `onData` receives strings in this encoding instead of buffers. */
|
|
11
21
|
encoding?: BufferEncoding;
|
|
12
22
|
createClientFn: (options: SocketClientOptions, connectionListener?: () => void) => SocketClientType;
|
|
13
23
|
onConnected?: (opts: {
|
|
@@ -22,6 +32,7 @@ export interface INetworkTcpClientProps<SocketClientOptions extends PlainConnect
|
|
|
22
32
|
}) => void;
|
|
23
33
|
onError?: (error: any) => void;
|
|
24
34
|
}
|
|
35
|
+
/** TCP or TLS client that opens its socket through `createClientFn`, reports connect, data, close and error to the `on*` callbacks, and reconnects when enabled. */
|
|
25
36
|
export declare class BaseNetworkTcpClient<SocketClientOptions extends PlainConnectionOptions | TlsConnectionOptions, SocketClientType extends PlainSocketClient | TlsSocketClient> extends BaseHelper {
|
|
26
37
|
protected client?: SocketClientType | null;
|
|
27
38
|
protected options: SocketClientOptions;
|
|
@@ -2,6 +2,7 @@ import { ObjectUtility } from '@venizia/ignis-inversion';
|
|
|
2
2
|
import { RedactUtility } from '../../../common/redact.js';
|
|
3
3
|
import { BaseHelper } from '../../base.js';
|
|
4
4
|
const DEFAULT_MAX_RETRY = 5;
|
|
5
|
+
/** TCP or TLS client that opens its socket through `createClientFn`, reports connect, data, close and error to the `on*` callbacks, and reconnects when enabled. */
|
|
5
6
|
export class BaseNetworkTcpClient extends BaseHelper {
|
|
6
7
|
constructor(opts) {
|
|
7
8
|
super({
|
|
@@ -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,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,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;IAuBlB,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;QAtBK,UAAK,GAAuD;YACpE,YAAY,EAAE,iBAAiB;YAC/B,gBAAgB,EAAE,CAAC;SACpB,CAAC;QAoBA,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,aAAa,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IAC9D,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;QAEtD,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;YAEJ,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;YAE1E,OAAO;QACT,CAAC;QAED,IAAI,aAAa,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC;YACnD,IAAI,CAAC,MAAM;iBACR,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;iBACtB,IAAI,CAAC,+CAA+C,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YAE1E,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;YAE1E,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;YAEnE,OAAO;QACT,CAAC;QAED,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QAEzB,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;YAEzE,OAAO;QACT,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC7B,CAAC;CACF","sourcesContent":["import { ObjectUtility } from '@venizia/ignis-inversion';\nimport { RedactUtility } 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\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 RedactUtility.redactSecrets({ value: 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\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\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\n return;\n }\n\n if (ObjectUtility.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\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\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\n return;\n }\n\n const { payload } = opts;\n\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\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,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAW5C,MAAM,iBAAiB,GAAG,CAAC,CAAC;AAmC5B,oKAAoK;AACpK,MAAM,OAAO,oBAGX,SAAQ,UAAU;IAuBlB,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;QAtBK,UAAK,GAAuD;YACpE,YAAY,EAAE,iBAAiB;YAC/B,gBAAgB,EAAE,CAAC;SACpB,CAAC;QAoBA,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,aAAa,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IAC9D,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;QAEtD,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;YAEJ,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;YAE1E,OAAO;QACT,CAAC;QAED,IAAI,aAAa,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC;YACnD,IAAI,CAAC,MAAM;iBACR,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;iBACtB,IAAI,CAAC,+CAA+C,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YAE1E,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;YAE1E,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;YAEnE,OAAO;QACT,CAAC;QAED,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QAEzB,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;YAEzE,OAAO;QACT,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC7B,CAAC;CACF","sourcesContent":["import { ObjectUtility } from '@venizia/ignis-inversion';\nimport { RedactUtility } 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\n/** Options of a TCP client. `createClientFn` opens the socket, so one client type serves plain and TLS. */\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 /**\n * Retries after a close, up to `maxRetry` times.\n * @default false\n */\n reconnect?: boolean;\n /**\n * How many reconnects `reconnect` attempts.\n * @default 5\n */\n maxRetry?: number;\n /** When set, `onData` receives strings in this encoding instead of buffers. */\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\n/** TCP or TLS client that opens its socket through `createClientFn`, reports connect, data, close and error to the `on*` callbacks, and reconnects when enabled. */\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\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 RedactUtility.redactSecrets({ value: 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\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\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\n return;\n }\n\n if (ObjectUtility.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\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\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\n return;\n }\n\n const { payload } = opts;\n\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\n return;\n }\n\n this.client.write(payload);\n }\n}\n"]}
|
|
@@ -12,6 +12,7 @@ export declare class TcpClientStates {
|
|
|
12
12
|
}
|
|
13
13
|
/** Valid TCP client state values. */
|
|
14
14
|
export type TTcpClientState = TConstValue<typeof TcpClientStates>;
|
|
15
|
+
/** A client connected to `BaseNetworkTcpServer`: its `id`, `socket`, authentication `state`, `subscriptions` and `storage` (connect and authenticate times, the pending authenticate timer). */
|
|
15
16
|
export interface ITcpSocketClient<SocketClientType> {
|
|
16
17
|
id: string;
|
|
17
18
|
socket: SocketClientType;
|
|
@@ -24,6 +25,7 @@ export interface ITcpSocketClient<SocketClientType> {
|
|
|
24
25
|
[additionField: symbol | string]: any;
|
|
25
26
|
};
|
|
26
27
|
}
|
|
28
|
+
/** Options of `BaseNetworkTcpServer`. With `authenticateOptions.required`, `duration` (milliseconds, greater than 0) is how long a client has to authenticate before its socket is ended; the constructor throws without it. `createServerFn` builds the server, so one class serves plain and TLS. */
|
|
27
29
|
export interface ITcpSocketServerOptions<SocketServerOptions extends ServerOpts = ServerOpts, SocketServerType extends SocketServer = SocketServer, SocketClientType extends SocketClient = SocketClient> {
|
|
28
30
|
scope?: string;
|
|
29
31
|
identifier: string;
|
|
@@ -65,6 +67,7 @@ export interface ITcpSocketServerOptions<SocketServerOptions extends ServerOpts
|
|
|
65
67
|
error: Error;
|
|
66
68
|
}) => void;
|
|
67
69
|
}
|
|
70
|
+
/** TCP or TLS server that tracks connected clients by id, with an optional authentication window, and reports connection events to the `onClient*` and `onServer*` callbacks. */
|
|
68
71
|
export declare class BaseNetworkTcpServer<SocketServerOptions extends ServerOpts = ServerOpts, SocketServerType extends SocketServer = SocketServer, SocketClientType extends SocketClient = SocketClient> extends BaseHelper {
|
|
69
72
|
protected serverOptions: Partial<SocketServerOptions>;
|
|
70
73
|
protected listenOptions: Partial<ListenOptions>;
|
|
@@ -16,6 +16,7 @@ export class TcpClientStates {
|
|
|
16
16
|
return this.SCHEME_SET.has(value);
|
|
17
17
|
}
|
|
18
18
|
}
|
|
19
|
+
/** TCP or TLS server that tracks connected clients by id, with an optional authentication window, and reports connection events to the `onClient*` and `onServer*` callbacks. */
|
|
19
20
|
export class BaseNetworkTcpServer extends BaseHelper {
|
|
20
21
|
constructor(opts) {
|
|
21
22
|
super({
|
|
@@ -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":"AAEA,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAQ7D,6DAA6D;AAC7D,MAAM,OAAO,eAAe;aACV,iBAAY,GAAG,cAAc,CAAC;aAC9B,mBAAc,GAAG,gBAAgB,CAAC;aAClC,kBAAa,GAAG,eAAe,CAAC;aAEhC,eAAU,GAAG,IAAI,GAAG,CAAS;QAC3C,IAAI,CAAC,YAAY;QACjB,IAAI,CAAC,cAAc;QACnB,IAAI,CAAC,aAAa;KACnB,CAAC,CAAC;IAEH,MAAM,CAAC,OAAO,CAAC,KAAa;QAC1B,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;;AAiDH,MAAM,OAAO,oBAIX,SAAQ,UAAU;IA8BlB,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;QAnCK,kBAAa,GAAiC,EAAE,CAAC;QACjD,kBAAa,GAA2B,EAAE,CAAC;QAoCnD,oFAAoF;QACpF,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAEnC,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,YAAY,CAAC,MAAM,EAAE,CAAC;QAEjC,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;YAEjF,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,cAAc,CAAC,aAAa,CAAC;oBAC3B,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;gBACtC,CAAC,CAAC,eAAe,CAAC,YAAY;gBAC9B,CAAC,CAAC,eAAe,CAAC,aAAa;YACjC,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;gBAEtC,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,CAAC,aAAa,EAAE,CAAC;oBACnD,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;YAEtC,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,YAAY,CAAC,mBAAmB,CAAC,CAAC;gBAElC,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;QAElD,KAAK,MAAM,MAAM,IAAI,aAAa,EAAE,CAAC;YACnC,MAAM,EAAE,mBAAmB,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC;YAE/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,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAEnC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAE3B,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,IAA4C;QACzD,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QAE3B,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAEtC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC,KAAK,CAAC,2BAA2B,EAAE,EAAE,CAAC,CAAC;YAE7E,OAAO;QACT,CAAC;QAED,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;QAErB,QAAQ,KAAK,EAAE,CAAC;YACd,KAAK,eAAe,CAAC,YAAY,CAAC;YAClC,KAAK,eAAe,CAAC,cAAc,CAAC,CAAC,CAAC;gBACpC,MAAM,CAAC,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;gBACtC,MAAM;YACR,CAAC;YACD,KAAK,eAAe,CAAC,aAAa,CAAC,CAAC,CAAC;gBACnC,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;gBAED,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;YAE7E,OAAO;QACT,CAAC;QAED,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAE1B,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;YAEhF,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;YAEJ,OAAO;QACT,CAAC;QAED,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACxB,CAAC;CACF","sourcesContent":["import type { TConstValue } from '@/common/types';\nimport { type ValueOrPromise } from '@/common/types';\nimport { BaseHelper } from '@/modules/base';\nimport { getError } from '@/modules/error';\nimport { ParseUtility } from '@/utilities/parse.utility';\nimport { PromiseUtility } 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\n/** Where a TCP client is in the authentication handshake. */\nexport class TcpClientStates {\n static readonly UNAUTHORIZED = 'unauthorized';\n static readonly AUTHENTICATING = 'authenticating';\n static readonly AUTHENTICATED = 'authenticated';\n\n static readonly SCHEME_SET = new Set<string>([\n this.UNAUTHORIZED,\n this.AUTHENTICATING,\n this.AUTHENTICATED,\n ]);\n\n static isValid(value: string): boolean {\n return this.SCHEME_SET.has(value);\n }\n}\n\n/** Valid TCP client state values. */\nexport type TTcpClientState = TConstValue<typeof TcpClientStates>;\n\nexport interface ITcpSocketClient<SocketClientType> {\n id: string;\n socket: SocketClientType;\n state: TTcpClientState;\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\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 // No prototype: `getClient({ id: 'constructor' })` must find nothing, not `Object`.\n this.clients = Object.create(null);\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 = ParseUtility.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\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 PromiseUtility.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\n ? TcpClientStates.UNAUTHORIZED\n : TcpClientStates.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\n if (!client) {\n return;\n }\n\n client.storage.authenticateTimeout = null;\n\n if (client.state === TcpClientStates.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\n if (!client) {\n clearTimeout(authenticateTimeout);\n\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\n for (const client of clientsValues) {\n const { authenticateTimeout } = client.storage;\n\n if (authenticateTimeout) {\n clearTimeout(authenticateTimeout);\n client.storage.authenticateTimeout = null;\n }\n\n client.socket.destroy();\n }\n\n this.clients = Object.create(null);\n\n const server = this.server;\n\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: TTcpClientState }) {\n const { id, state } = opts;\n\n const client = this.getClient({ id });\n\n if (!client) {\n this.logger.for('authenticateClient').error('Client NOT FOUND | ID: %s', id);\n\n return;\n }\n\n client.state = state;\n\n switch (state) {\n case TcpClientStates.UNAUTHORIZED:\n case TcpClientStates.AUTHENTICATING: {\n client.storage.authenticatedAt = null;\n break;\n }\n case TcpClientStates.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\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\n return;\n }\n\n const { socket } = client;\n\n if (!socket.writable) {\n this.logger.for(this.emit.name).error('Client NOT WRITABLE | ID: %s', clientId);\n\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\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":"AAEA,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAQ7D,6DAA6D;AAC7D,MAAM,OAAO,eAAe;aACV,iBAAY,GAAG,cAAc,CAAC;aAC9B,mBAAc,GAAG,gBAAgB,CAAC;aAClC,kBAAa,GAAG,eAAe,CAAC;aAEhC,eAAU,GAAG,IAAI,GAAG,CAAS;QAC3C,IAAI,CAAC,YAAY;QACjB,IAAI,CAAC,cAAc;QACnB,IAAI,CAAC,aAAa;KACnB,CAAC,CAAC;IAEH,MAAM,CAAC,OAAO,CAAC,KAAa;QAC1B,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;;AAmDH,iLAAiL;AACjL,MAAM,OAAO,oBAIX,SAAQ,UAAU;IA8BlB,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;QAnCK,kBAAa,GAAiC,EAAE,CAAC;QACjD,kBAAa,GAA2B,EAAE,CAAC;QAoCnD,oFAAoF;QACpF,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAEnC,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,YAAY,CAAC,MAAM,EAAE,CAAC;QAEjC,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;YAEjF,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,cAAc,CAAC,aAAa,CAAC;oBAC3B,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;gBACtC,CAAC,CAAC,eAAe,CAAC,YAAY;gBAC9B,CAAC,CAAC,eAAe,CAAC,aAAa;YACjC,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;gBAEtC,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,CAAC,aAAa,EAAE,CAAC;oBACnD,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;YAEtC,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,YAAY,CAAC,mBAAmB,CAAC,CAAC;gBAElC,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;QAElD,KAAK,MAAM,MAAM,IAAI,aAAa,EAAE,CAAC;YACnC,MAAM,EAAE,mBAAmB,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC;YAE/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,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAEnC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAE3B,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,IAA4C;QACzD,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QAE3B,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAEtC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC,KAAK,CAAC,2BAA2B,EAAE,EAAE,CAAC,CAAC;YAE7E,OAAO;QACT,CAAC;QAED,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;QAErB,QAAQ,KAAK,EAAE,CAAC;YACd,KAAK,eAAe,CAAC,YAAY,CAAC;YAClC,KAAK,eAAe,CAAC,cAAc,CAAC,CAAC,CAAC;gBACpC,MAAM,CAAC,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;gBACtC,MAAM;YACR,CAAC;YACD,KAAK,eAAe,CAAC,aAAa,CAAC,CAAC,CAAC;gBACnC,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;gBAED,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;YAE7E,OAAO;QACT,CAAC;QAED,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAE1B,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;YAEhF,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;YAEJ,OAAO;QACT,CAAC;QAED,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACxB,CAAC;CACF","sourcesContent":["import type { TConstValue } from '@/common/types';\nimport { type ValueOrPromise } from '@/common/types';\nimport { BaseHelper } from '@/modules/base';\nimport { getError } from '@/modules/error';\nimport { ParseUtility } from '@/utilities/parse.utility';\nimport { PromiseUtility } 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\n/** Where a TCP client is in the authentication handshake. */\nexport class TcpClientStates {\n static readonly UNAUTHORIZED = 'unauthorized';\n static readonly AUTHENTICATING = 'authenticating';\n static readonly AUTHENTICATED = 'authenticated';\n\n static readonly SCHEME_SET = new Set<string>([\n this.UNAUTHORIZED,\n this.AUTHENTICATING,\n this.AUTHENTICATED,\n ]);\n\n static isValid(value: string): boolean {\n return this.SCHEME_SET.has(value);\n }\n}\n\n/** Valid TCP client state values. */\nexport type TTcpClientState = TConstValue<typeof TcpClientStates>;\n\n/** A client connected to `BaseNetworkTcpServer`: its `id`, `socket`, authentication `state`, `subscriptions` and `storage` (connect and authenticate times, the pending authenticate timer). */\nexport interface ITcpSocketClient<SocketClientType> {\n id: string;\n socket: SocketClientType;\n state: TTcpClientState;\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\n/** Options of `BaseNetworkTcpServer`. With `authenticateOptions.required`, `duration` (milliseconds, greater than 0) is how long a client has to authenticate before its socket is ended; the constructor throws without it. `createServerFn` builds the server, so one class serves plain and TLS. */\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\n/** TCP or TLS server that tracks connected clients by id, with an optional authentication window, and reports connection events to the `onClient*` and `onServer*` callbacks. */\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\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 // No prototype: `getClient({ id: 'constructor' })` must find nothing, not `Object`.\n this.clients = Object.create(null);\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 = ParseUtility.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\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 PromiseUtility.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\n ? TcpClientStates.UNAUTHORIZED\n : TcpClientStates.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\n if (!client) {\n return;\n }\n\n client.storage.authenticateTimeout = null;\n\n if (client.state === TcpClientStates.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\n if (!client) {\n clearTimeout(authenticateTimeout);\n\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\n for (const client of clientsValues) {\n const { authenticateTimeout } = client.storage;\n\n if (authenticateTimeout) {\n clearTimeout(authenticateTimeout);\n client.storage.authenticateTimeout = null;\n }\n\n client.socket.destroy();\n }\n\n this.clients = Object.create(null);\n\n const server = this.server;\n\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: TTcpClientState }) {\n const { id, state } = opts;\n\n const client = this.getClient({ id });\n\n if (!client) {\n this.logger.for('authenticateClient').error('Client NOT FOUND | ID: %s', id);\n\n return;\n }\n\n client.state = state;\n\n switch (state) {\n case TcpClientStates.UNAUTHORIZED:\n case TcpClientStates.AUTHENTICATING: {\n client.storage.authenticatedAt = null;\n break;\n }\n case TcpClientStates.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\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\n return;\n }\n\n const { socket } = client;\n\n if (!socket.writable) {\n this.logger.for(this.emit.name).error('Client NOT WRITABLE | ID: %s', clientId);\n\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\n return;\n }\n\n socket.write(payload);\n }\n}\n"]}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { type Socket, type TcpSocketConnectOpts } from 'node:net';
|
|
2
2
|
import { BaseNetworkTcpClient, type INetworkTcpClientProps } from './base-tcp-client.helper.js';
|
|
3
|
+
/** `BaseNetworkTcpClient` over a plain `node:net` socket. */
|
|
3
4
|
export declare class NetworkTcpClient extends BaseNetworkTcpClient<TcpSocketConnectOpts, Socket> {
|
|
4
5
|
constructor(opts: Omit<INetworkTcpClientProps<TcpSocketConnectOpts, Socket>, 'createClientFn'>);
|
|
5
6
|
static newInstance(opts: Omit<INetworkTcpClientProps<TcpSocketConnectOpts, Socket>, 'createClientFn'>): NetworkTcpClient;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"network-tcp-client.helper.js","sourceRoot":"","sources":["../../../../../src/modules/network/tcp-socket/network-tcp-client.helper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAA0C,MAAM,UAAU,CAAC;AAC3E,OAAO,EAAE,oBAAoB,EAA+B,MAAM,0BAA0B,CAAC;AAE7F,MAAM,OAAO,gBAAiB,SAAQ,oBAAkD;IACtF,YAAY,IAAkF;QAC5F,KAAK,CAAC;YACJ,GAAG,IAAI;YACP,KAAK,EAAE,gBAAgB,CAAC,IAAI;YAC5B,cAAc,EAAE,OAAO;SACxB,CAAC,CAAC;QACH,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;IAC9B,CAAC;IAED,MAAM,CAAC,WAAW,CAChB,IAAkF;QAElF,OAAO,IAAI,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;CACF","sourcesContent":["import { connect, type Socket, type TcpSocketConnectOpts } from 'node:net';\nimport { BaseNetworkTcpClient, type INetworkTcpClientProps } from './base-tcp-client.helper';\n\nexport class NetworkTcpClient extends BaseNetworkTcpClient<TcpSocketConnectOpts, Socket> {\n constructor(opts: Omit<INetworkTcpClientProps<TcpSocketConnectOpts, Socket>, 'createClientFn'>) {\n super({\n ...opts,\n scope: NetworkTcpClient.name,\n createClientFn: connect,\n });\n this.options = opts.options;\n }\n\n static newInstance(\n opts: Omit<INetworkTcpClientProps<TcpSocketConnectOpts, Socket>, 'createClientFn'>,\n ) {\n return new NetworkTcpClient(opts);\n }\n}\n"]}
|
|
1
|
+
{"version":3,"file":"network-tcp-client.helper.js","sourceRoot":"","sources":["../../../../../src/modules/network/tcp-socket/network-tcp-client.helper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAA0C,MAAM,UAAU,CAAC;AAC3E,OAAO,EAAE,oBAAoB,EAA+B,MAAM,0BAA0B,CAAC;AAE7F,6DAA6D;AAC7D,MAAM,OAAO,gBAAiB,SAAQ,oBAAkD;IACtF,YAAY,IAAkF;QAC5F,KAAK,CAAC;YACJ,GAAG,IAAI;YACP,KAAK,EAAE,gBAAgB,CAAC,IAAI;YAC5B,cAAc,EAAE,OAAO;SACxB,CAAC,CAAC;QACH,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;IAC9B,CAAC;IAED,MAAM,CAAC,WAAW,CAChB,IAAkF;QAElF,OAAO,IAAI,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;CACF","sourcesContent":["import { connect, type Socket, type TcpSocketConnectOpts } from 'node:net';\nimport { BaseNetworkTcpClient, type INetworkTcpClientProps } from './base-tcp-client.helper';\n\n/** `BaseNetworkTcpClient` over a plain `node:net` socket. */\nexport class NetworkTcpClient extends BaseNetworkTcpClient<TcpSocketConnectOpts, Socket> {\n constructor(opts: Omit<INetworkTcpClientProps<TcpSocketConnectOpts, Socket>, 'createClientFn'>) {\n super({\n ...opts,\n scope: NetworkTcpClient.name,\n createClientFn: connect,\n });\n this.options = opts.options;\n }\n\n static newInstance(\n opts: Omit<INetworkTcpClientProps<TcpSocketConnectOpts, Socket>, 'createClientFn'>,\n ) {\n return new NetworkTcpClient(opts);\n }\n}\n"]}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { type ServerOpts, type Socket as SocketClient, type Server as SocketServer } from 'node:net';
|
|
2
2
|
import { BaseNetworkTcpServer, type ITcpSocketServerOptions } from './base-tcp-server.helper.js';
|
|
3
|
+
/** Plain TCP server (`node:net`) on top of the shared base server; adds no behavior of its own. */
|
|
3
4
|
export declare class NetworkTcpServer extends BaseNetworkTcpServer<ServerOpts, SocketServer, SocketClient> {
|
|
4
5
|
constructor(opts: Omit<ITcpSocketServerOptions, 'createServerFn'>);
|
|
5
6
|
static newInstance(opts: Omit<ITcpSocketServerOptions, 'createServerFn'>): NetworkTcpServer;
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { createServer, } from 'node:net';
|
|
2
2
|
import { BaseNetworkTcpServer } from './base-tcp-server.helper.js';
|
|
3
|
+
/** Plain TCP server (`node:net`) on top of the shared base server; adds no behavior of its own. */
|
|
3
4
|
export class NetworkTcpServer extends BaseNetworkTcpServer {
|
|
4
5
|
constructor(opts) {
|
|
5
6
|
super({
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"network-tcp-server.helper.js","sourceRoot":"","sources":["../../../../../src/modules/network/tcp-socket/network-tcp-server.helper.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,GAIb,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,oBAAoB,EAAgC,MAAM,0BAA0B,CAAC;AAE9F,MAAM,OAAO,gBAAiB,SAAQ,oBAA4D;IAChG,YAAY,IAAqD;QAC/D,KAAK,CAAC;YACJ,GAAG,IAAI;YACP,KAAK,EAAE,gBAAgB,CAAC,IAAI;YAC5B,cAAc,EAAE,YAAY;SAC7B,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,WAAW,CAAC,IAAqD;QACtE,OAAO,IAAI,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;CACF","sourcesContent":["import {\n createServer,\n type ServerOpts,\n type Socket as SocketClient,\n type Server as SocketServer,\n} from 'node:net';\nimport { BaseNetworkTcpServer, type ITcpSocketServerOptions } from './base-tcp-server.helper';\n\nexport class NetworkTcpServer extends BaseNetworkTcpServer<ServerOpts, SocketServer, SocketClient> {\n constructor(opts: Omit<ITcpSocketServerOptions, 'createServerFn'>) {\n super({\n ...opts,\n scope: NetworkTcpServer.name,\n createServerFn: createServer,\n });\n }\n\n static newInstance(opts: Omit<ITcpSocketServerOptions, 'createServerFn'>) {\n return new NetworkTcpServer(opts);\n }\n}\n"]}
|
|
1
|
+
{"version":3,"file":"network-tcp-server.helper.js","sourceRoot":"","sources":["../../../../../src/modules/network/tcp-socket/network-tcp-server.helper.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,GAIb,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,oBAAoB,EAAgC,MAAM,0BAA0B,CAAC;AAE9F,mGAAmG;AACnG,MAAM,OAAO,gBAAiB,SAAQ,oBAA4D;IAChG,YAAY,IAAqD;QAC/D,KAAK,CAAC;YACJ,GAAG,IAAI;YACP,KAAK,EAAE,gBAAgB,CAAC,IAAI;YAC5B,cAAc,EAAE,YAAY;SAC7B,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,WAAW,CAAC,IAAqD;QACtE,OAAO,IAAI,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;CACF","sourcesContent":["import {\n createServer,\n type ServerOpts,\n type Socket as SocketClient,\n type Server as SocketServer,\n} from 'node:net';\nimport { BaseNetworkTcpServer, type ITcpSocketServerOptions } from './base-tcp-server.helper';\n\n/** Plain TCP server (`node:net`) on top of the shared base server; adds no behavior of its own. */\nexport class NetworkTcpServer extends BaseNetworkTcpServer<ServerOpts, SocketServer, SocketClient> {\n constructor(opts: Omit<ITcpSocketServerOptions, 'createServerFn'>) {\n super({\n ...opts,\n scope: NetworkTcpServer.name,\n createServerFn: createServer,\n });\n }\n\n static newInstance(opts: Omit<ITcpSocketServerOptions, 'createServerFn'>) {\n return new NetworkTcpServer(opts);\n }\n}\n"]}
|