@signalwire/sdk 2.0.1 → 2.0.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/dist/AgentBase.d.ts +1045 -0
- package/dist/AgentBase.js +2375 -0
- package/dist/AgentBase.js.map +1 -0
- package/dist/AgentServer.d.ts +146 -0
- package/dist/AgentServer.js +388 -0
- package/dist/AgentServer.js.map +1 -0
- package/dist/AuthHandler.d.ts +127 -0
- package/dist/AuthHandler.js +212 -0
- package/dist/AuthHandler.js.map +1 -0
- package/dist/ConfigLoader.d.ts +170 -0
- package/dist/ConfigLoader.js +393 -0
- package/dist/ConfigLoader.js.map +1 -0
- package/dist/ContextBuilder.d.ts +652 -0
- package/dist/ContextBuilder.js +1115 -0
- package/dist/ContextBuilder.js.map +1 -0
- package/dist/DataMap.d.ts +271 -0
- package/dist/DataMap.js +430 -0
- package/dist/DataMap.js.map +1 -0
- package/dist/FunctionResult.d.ts +481 -0
- package/dist/FunctionResult.js +775 -0
- package/dist/FunctionResult.js.map +1 -0
- package/dist/Logger.d.ts +113 -0
- package/dist/Logger.js +320 -0
- package/dist/Logger.js.map +1 -0
- package/dist/PomBuilder.d.ts +208 -0
- package/dist/PomBuilder.js +409 -0
- package/dist/PomBuilder.js.map +1 -0
- package/dist/PromptManager.d.ts +85 -0
- package/dist/PromptManager.js +108 -0
- package/dist/PromptManager.js.map +1 -0
- package/dist/SWMLHandler.d.ts +159 -0
- package/dist/SWMLHandler.js +229 -0
- package/dist/SWMLHandler.js.map +1 -0
- package/dist/SWMLService.d.ts +326 -0
- package/dist/SWMLService.js +610 -0
- package/dist/SWMLService.js.map +1 -0
- package/dist/SchemaUtils.d.ts +108 -0
- package/dist/SchemaUtils.js +317 -0
- package/dist/SchemaUtils.js.map +1 -0
- package/dist/SecurityUtils.d.ts +60 -0
- package/{src/SecurityUtils.ts → dist/SecurityUtils.js} +82 -83
- package/dist/SecurityUtils.js.map +1 -0
- package/dist/ServerlessAdapter.d.ts +119 -0
- package/dist/ServerlessAdapter.js +188 -0
- package/dist/ServerlessAdapter.js.map +1 -0
- package/dist/SessionManager.d.ts +142 -0
- package/dist/SessionManager.js +260 -0
- package/dist/SessionManager.js.map +1 -0
- package/dist/SslConfig.d.ts +77 -0
- package/dist/SslConfig.js +100 -0
- package/dist/SslConfig.js.map +1 -0
- package/dist/SwaigFunction.d.ts +159 -0
- package/dist/SwaigFunction.js +209 -0
- package/dist/SwaigFunction.js.map +1 -0
- package/dist/SwmlBuilder.d.ts +165 -0
- package/dist/SwmlBuilder.js +247 -0
- package/dist/SwmlBuilder.js.map +1 -0
- package/dist/SwmlVerbMethods.generated.d.ts +254 -0
- package/dist/SwmlVerbMethods.generated.js +9 -0
- package/dist/SwmlVerbMethods.generated.js.map +1 -0
- package/dist/TypeInference.d.ts +71 -0
- package/dist/TypeInference.js +164 -0
- package/dist/TypeInference.js.map +1 -0
- package/dist/WebService.d.ts +148 -0
- package/dist/WebService.js +532 -0
- package/dist/WebService.js.map +1 -0
- package/dist/cli/agent-loader.d.ts +22 -0
- package/dist/cli/agent-loader.js +144 -0
- package/dist/cli/agent-loader.js.map +1 -0
- package/dist/cli/mock-data.d.ts +37 -0
- package/dist/cli/mock-data.js +80 -0
- package/dist/cli/mock-data.js.map +1 -0
- package/dist/cli/swaig-test.d.ts +32 -0
- package/dist/cli/swaig-test.js +418 -0
- package/dist/cli/swaig-test.js.map +1 -0
- package/dist/generateVerbTypes.d.ts +11 -0
- package/dist/generateVerbTypes.js +265 -0
- package/dist/generateVerbTypes.js.map +1 -0
- package/{src/index.ts → dist/index.d.ts} +13 -100
- package/dist/index.js +152 -0
- package/dist/index.js.map +1 -0
- package/dist/livewire/index.d.ts +653 -0
- package/dist/livewire/index.js +992 -0
- package/dist/livewire/index.js.map +1 -0
- package/dist/prefabs/ConciergeAgent.d.ts +89 -0
- package/dist/prefabs/ConciergeAgent.js +245 -0
- package/dist/prefabs/ConciergeAgent.js.map +1 -0
- package/dist/prefabs/FAQBotAgent.d.ts +113 -0
- package/dist/prefabs/FAQBotAgent.js +329 -0
- package/dist/prefabs/FAQBotAgent.js.map +1 -0
- package/dist/prefabs/InfoGathererAgent.d.ts +126 -0
- package/dist/prefabs/InfoGathererAgent.js +287 -0
- package/dist/prefabs/InfoGathererAgent.js.map +1 -0
- package/dist/prefabs/ReceptionistAgent.d.ts +104 -0
- package/dist/prefabs/ReceptionistAgent.js +303 -0
- package/dist/prefabs/ReceptionistAgent.js.map +1 -0
- package/dist/prefabs/SurveyAgent.d.ts +148 -0
- package/dist/prefabs/SurveyAgent.js +540 -0
- package/dist/prefabs/SurveyAgent.js.map +1 -0
- package/{src/prefabs/index.ts → dist/prefabs/index.d.ts} +1 -15
- package/dist/prefabs/index.js +14 -0
- package/dist/prefabs/index.js.map +1 -0
- package/dist/relay/Action.d.ts +258 -0
- package/dist/relay/Action.js +402 -0
- package/dist/relay/Action.js.map +1 -0
- package/dist/relay/Call.d.ts +697 -0
- package/dist/relay/Call.js +1062 -0
- package/dist/relay/Call.js.map +1 -0
- package/dist/relay/Deferred.d.ts +44 -0
- package/dist/relay/Deferred.js +69 -0
- package/dist/relay/Deferred.js.map +1 -0
- package/dist/relay/Message.d.ts +103 -0
- package/dist/relay/Message.js +169 -0
- package/dist/relay/Message.js.map +1 -0
- package/dist/relay/RelayClient.d.ts +302 -0
- package/dist/relay/RelayClient.js +1019 -0
- package/dist/relay/RelayClient.js.map +1 -0
- package/dist/relay/RelayError.d.ts +15 -0
- package/dist/relay/RelayError.js +20 -0
- package/dist/relay/RelayError.js.map +1 -0
- package/dist/relay/RelayEvent.d.ts +254 -0
- package/dist/relay/RelayEvent.js +509 -0
- package/dist/relay/RelayEvent.js.map +1 -0
- package/dist/relay/constants.d.ts +90 -0
- package/{src/relay/constants.ts → dist/relay/constants.js} +11 -29
- package/dist/relay/constants.js.map +1 -0
- package/dist/relay/index.d.ts +16 -0
- package/dist/relay/index.js +18 -0
- package/dist/relay/index.js.map +1 -0
- package/dist/relay/types.d.ts +142 -0
- package/dist/relay/types.js +5 -0
- package/dist/relay/types.js.map +1 -0
- package/dist/rest/HttpClient.d.ts +80 -0
- package/dist/rest/HttpClient.js +148 -0
- package/dist/rest/HttpClient.js.map +1 -0
- package/dist/rest/RestError.d.ts +30 -0
- package/dist/rest/RestError.js +39 -0
- package/dist/rest/RestError.js.map +1 -0
- package/dist/rest/base/BaseResource.d.ts +24 -0
- package/dist/rest/base/BaseResource.js +29 -0
- package/dist/rest/base/BaseResource.js.map +1 -0
- package/dist/rest/base/CrudResource.d.ts +68 -0
- package/dist/rest/base/CrudResource.js +82 -0
- package/dist/rest/base/CrudResource.js.map +1 -0
- package/dist/rest/base/CrudWithAddresses.d.ts +22 -0
- package/dist/rest/base/CrudWithAddresses.js +25 -0
- package/dist/rest/base/CrudWithAddresses.js.map +1 -0
- package/dist/rest/index.d.ts +131 -0
- package/{src/rest/index.ts → dist/rest/index.js} +101 -136
- package/dist/rest/index.js.map +1 -0
- package/dist/rest/namespaces/addresses.d.ts +46 -0
- package/dist/rest/namespaces/addresses.js +55 -0
- package/dist/rest/namespaces/addresses.js.map +1 -0
- package/dist/rest/namespaces/calling.d.ts +382 -0
- package/dist/rest/namespaces/calling.js +478 -0
- package/dist/rest/namespaces/calling.js.map +1 -0
- package/dist/rest/namespaces/chat.d.ts +22 -0
- package/dist/rest/namespaces/chat.js +26 -0
- package/dist/rest/namespaces/chat.js.map +1 -0
- package/dist/rest/namespaces/compat.d.ts +585 -0
- package/dist/rest/namespaces/compat.js +735 -0
- package/dist/rest/namespaces/compat.js.map +1 -0
- package/dist/rest/namespaces/datasphere.d.ts +66 -0
- package/dist/rest/namespaces/datasphere.js +77 -0
- package/dist/rest/namespaces/datasphere.js.map +1 -0
- package/dist/rest/namespaces/fabric.d.ts +282 -0
- package/dist/rest/namespaces/fabric.js +373 -0
- package/dist/rest/namespaces/fabric.js.map +1 -0
- package/dist/rest/namespaces/imported-numbers.d.ts +22 -0
- package/dist/rest/namespaces/imported-numbers.js +26 -0
- package/dist/rest/namespaces/imported-numbers.js.map +1 -0
- package/dist/rest/namespaces/logs.d.ts +105 -0
- package/dist/rest/namespaces/logs.js +133 -0
- package/dist/rest/namespaces/logs.js.map +1 -0
- package/dist/rest/namespaces/lookup.d.ts +29 -0
- package/dist/rest/namespaces/lookup.js +32 -0
- package/dist/rest/namespaces/lookup.js.map +1 -0
- package/dist/rest/namespaces/mfa.d.ts +46 -0
- package/dist/rest/namespaces/mfa.js +54 -0
- package/dist/rest/namespaces/mfa.js.map +1 -0
- package/dist/rest/namespaces/number-groups.d.ts +49 -0
- package/dist/rest/namespaces/number-groups.js +58 -0
- package/dist/rest/namespaces/number-groups.js.map +1 -0
- package/dist/rest/namespaces/phone-numbers.d.ts +60 -0
- package/dist/rest/namespaces/phone-numbers.js +67 -0
- package/dist/rest/namespaces/phone-numbers.js.map +1 -0
- package/dist/rest/namespaces/project.d.ts +46 -0
- package/dist/rest/namespaces/project.js +56 -0
- package/dist/rest/namespaces/project.js.map +1 -0
- package/dist/rest/namespaces/pubsub.d.ts +22 -0
- package/dist/rest/namespaces/pubsub.js +26 -0
- package/dist/rest/namespaces/pubsub.js.map +1 -0
- package/dist/rest/namespaces/queues.d.ts +42 -0
- package/dist/rest/namespaces/queues.js +49 -0
- package/dist/rest/namespaces/queues.js.map +1 -0
- package/dist/rest/namespaces/recordings.d.ts +38 -0
- package/dist/rest/namespaces/recordings.js +45 -0
- package/dist/rest/namespaces/recordings.js.map +1 -0
- package/dist/rest/namespaces/registry.d.ts +141 -0
- package/dist/rest/namespaces/registry.js +178 -0
- package/dist/rest/namespaces/registry.js.map +1 -0
- package/dist/rest/namespaces/short-codes.d.ts +39 -0
- package/dist/rest/namespaces/short-codes.js +46 -0
- package/dist/rest/namespaces/short-codes.js.map +1 -0
- package/dist/rest/namespaces/sip-profile.d.ts +28 -0
- package/dist/rest/namespaces/sip-profile.js +34 -0
- package/dist/rest/namespaces/sip-profile.js.map +1 -0
- package/dist/rest/namespaces/verified-callers.d.ts +33 -0
- package/dist/rest/namespaces/verified-callers.js +39 -0
- package/dist/rest/namespaces/verified-callers.js.map +1 -0
- package/dist/rest/namespaces/video.d.ts +235 -0
- package/dist/rest/namespaces/video.js +297 -0
- package/dist/rest/namespaces/video.js.map +1 -0
- package/{src/rest/pagination.ts → dist/rest/pagination.d.ts} +2 -61
- package/dist/rest/pagination.js +78 -0
- package/dist/rest/pagination.js.map +1 -0
- package/dist/rest/types.d.ts +54 -0
- package/dist/rest/types.js +5 -0
- package/dist/rest/types.js.map +1 -0
- package/dist/skills/SkillBase.d.ts +404 -0
- package/dist/skills/SkillBase.js +471 -0
- package/dist/skills/SkillBase.js.map +1 -0
- package/dist/skills/SkillManager.d.ts +195 -0
- package/dist/skills/SkillManager.js +378 -0
- package/dist/skills/SkillManager.js.map +1 -0
- package/dist/skills/SkillRegistry.d.ts +176 -0
- package/dist/skills/SkillRegistry.js +310 -0
- package/dist/skills/SkillRegistry.js.map +1 -0
- package/dist/skills/builtin/api_ninjas_trivia.d.ts +47 -0
- package/dist/skills/builtin/api_ninjas_trivia.js +211 -0
- package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -0
- package/dist/skills/builtin/ask_claude.d.ts +37 -0
- package/dist/skills/builtin/ask_claude.js +162 -0
- package/dist/skills/builtin/ask_claude.js.map +1 -0
- package/dist/skills/builtin/claude_skills.d.ts +75 -0
- package/dist/skills/builtin/claude_skills.js +753 -0
- package/dist/skills/builtin/claude_skills.js.map +1 -0
- package/dist/skills/builtin/custom_skills.d.ts +79 -0
- package/dist/skills/builtin/custom_skills.js +227 -0
- package/dist/skills/builtin/custom_skills.js.map +1 -0
- package/dist/skills/builtin/datasphere.d.ts +73 -0
- package/dist/skills/builtin/datasphere.js +350 -0
- package/dist/skills/builtin/datasphere.js.map +1 -0
- package/dist/skills/builtin/datasphere_serverless.d.ts +89 -0
- package/dist/skills/builtin/datasphere_serverless.js +291 -0
- package/dist/skills/builtin/datasphere_serverless.js.map +1 -0
- package/dist/skills/builtin/datetime.d.ts +40 -0
- package/dist/skills/builtin/datetime.js +118 -0
- package/dist/skills/builtin/datetime.js.map +1 -0
- package/dist/skills/builtin/google_maps.d.ts +48 -0
- package/dist/skills/builtin/google_maps.js +470 -0
- package/dist/skills/builtin/google_maps.js.map +1 -0
- package/dist/skills/builtin/index.d.ts +31 -0
- package/{src/skills/builtin/index.ts → dist/skills/builtin/index.js} +30 -36
- package/dist/skills/builtin/index.js.map +1 -0
- package/dist/skills/builtin/info_gatherer.d.ts +115 -0
- package/dist/skills/builtin/info_gatherer.js +328 -0
- package/dist/skills/builtin/info_gatherer.js.map +1 -0
- package/dist/skills/builtin/joke.d.ts +41 -0
- package/dist/skills/builtin/joke.js +156 -0
- package/dist/skills/builtin/joke.js.map +1 -0
- package/dist/skills/builtin/math.d.ts +39 -0
- package/dist/skills/builtin/math.js +119 -0
- package/dist/skills/builtin/math.js.map +1 -0
- package/dist/skills/builtin/mcp_gateway.d.ts +82 -0
- package/dist/skills/builtin/mcp_gateway.js +574 -0
- package/dist/skills/builtin/mcp_gateway.js.map +1 -0
- package/dist/skills/builtin/native_vector_search.d.ts +128 -0
- package/dist/skills/builtin/native_vector_search.js +752 -0
- package/dist/skills/builtin/native_vector_search.js.map +1 -0
- package/dist/skills/builtin/play_background_file.d.ts +59 -0
- package/dist/skills/builtin/play_background_file.js +274 -0
- package/dist/skills/builtin/play_background_file.js.map +1 -0
- package/dist/skills/builtin/spider.d.ts +91 -0
- package/dist/skills/builtin/spider.js +758 -0
- package/dist/skills/builtin/spider.js.map +1 -0
- package/dist/skills/builtin/swml_transfer.d.ts +66 -0
- package/dist/skills/builtin/swml_transfer.js +475 -0
- package/dist/skills/builtin/swml_transfer.js.map +1 -0
- package/dist/skills/builtin/weather_api.d.ts +59 -0
- package/dist/skills/builtin/weather_api.js +196 -0
- package/dist/skills/builtin/weather_api.js.map +1 -0
- package/dist/skills/builtin/web_search.d.ts +160 -0
- package/dist/skills/builtin/web_search.js +894 -0
- package/dist/skills/builtin/web_search.js.map +1 -0
- package/dist/skills/builtin/wikipedia_search.d.ts +77 -0
- package/dist/skills/builtin/wikipedia_search.js +241 -0
- package/dist/skills/builtin/wikipedia_search.js.map +1 -0
- package/{src/skills/index.ts → dist/skills/index.d.ts} +0 -1
- package/dist/skills/index.js +10 -0
- package/dist/skills/index.js.map +1 -0
- package/dist/types.d.ts +118 -0
- package/dist/types.js +5 -0
- package/dist/types.js.map +1 -0
- package/package.json +7 -1
- package/.github/workflows/publish.yml +0 -27
- package/.github/workflows/test.yml +0 -17
- package/CLAUDE.md +0 -112
- package/docs/MIGRATION-2.0.md +0 -81
- package/docs/agent-guide.md +0 -869
- package/docs/agent_guide.md +0 -1026
- package/docs/api-reference.md +0 -2420
- package/docs/api_reference.md +0 -1301
- package/docs/architecture.md +0 -843
- package/docs/cli-guide.md +0 -579
- package/docs/cli_guide.md +0 -448
- package/docs/cloud_functions_guide.md +0 -474
- package/docs/configuration.md +0 -422
- package/docs/contexts-guide.md +0 -787
- package/docs/contexts_guide.md +0 -511
- package/docs/datamap-guide.md +0 -1141
- package/docs/datamap_guide.md +0 -595
- package/docs/llm_parameters.md +0 -239
- package/docs/mcp_gateway_reference.md +0 -648
- package/docs/mcp_integration.md +0 -108
- package/docs/prefabs-guide.md +0 -800
- package/docs/sdk_features.md +0 -477
- package/docs/security.md +0 -436
- package/docs/serverless-guide.md +0 -513
- package/docs/skills-guide.md +0 -857
- package/docs/skills-system.md +0 -301
- package/docs/skills_parameter_schema.md +0 -392
- package/docs/skills_system.md +0 -467
- package/docs/swaig-reference.md +0 -1627
- package/docs/swaig_reference.md +0 -910
- package/docs/swml_service_guide.md +0 -600
- package/docs/third_party_skills.md +0 -533
- package/docs/web_service.md +0 -677
- package/examples/README.md +0 -131
- package/examples/advanced-datamap.ts +0 -100
- package/examples/advanced-dynamic-config.ts +0 -70
- package/examples/auto-vivified.ts +0 -94
- package/examples/call-flow.ts +0 -63
- package/examples/comprehensive-dynamic.ts +0 -125
- package/examples/contexts-steps.ts +0 -65
- package/examples/custom-path.ts +0 -45
- package/examples/datamap-tools.ts +0 -55
- package/examples/datasphere-multi-instance.ts +0 -63
- package/examples/datasphere-serverless-env.ts +0 -68
- package/examples/datasphere-webhook-env.ts +0 -66
- package/examples/datasphere.ts +0 -37
- package/examples/declarative.ts +0 -100
- package/examples/dynamic-config.ts +0 -54
- package/examples/dynamic-info-gatherer.ts +0 -69
- package/examples/dynamic-swml-service.ts +0 -67
- package/examples/gather-info.ts +0 -71
- package/examples/gather-per-question-functions-demo.ts +0 -140
- package/examples/joke-agent.ts +0 -34
- package/examples/kubernetes-agent.ts +0 -45
- package/examples/llm-params.ts +0 -69
- package/examples/mcp-agent.ts +0 -84
- package/examples/mcp-gateway.ts +0 -35
- package/examples/multi-agent.ts +0 -73
- package/examples/multi-endpoint.ts +0 -79
- package/examples/pom-prompt.ts +0 -71
- package/examples/prefab-concierge.ts +0 -47
- package/examples/prefab-faq.ts +0 -54
- package/examples/prefab-info-gatherer.ts +0 -33
- package/examples/prefab-receptionist.ts +0 -36
- package/examples/prefab-survey.ts +0 -68
- package/examples/record-call.ts +0 -67
- package/examples/relay-demo.ts +0 -33
- package/examples/room-and-sip.ts +0 -94
- package/examples/serverless-lambda.ts +0 -35
- package/examples/session-state.ts +0 -83
- package/examples/simple-agent.ts +0 -36
- package/examples/simple-static.ts +0 -29
- package/examples/skills-demo.ts +0 -38
- package/examples/step-function-inheritance-demo.ts +0 -124
- package/examples/swaig-features.ts +0 -187
- package/examples/swml-service-routing.ts +0 -66
- package/examples/swml-service.ts +0 -38
- package/examples/tap.ts +0 -68
- package/examples/verb-methods.ts +0 -45
- package/examples/web-search-multi-instance.ts +0 -72
- package/examples/web-search.ts +0 -38
- package/examples/wikipedia.ts +0 -36
- package/livewire/README.md +0 -140
- package/livewire/docs/migration-guide.md +0 -228
- package/livewire/examples/livewire-basic-agent.ts +0 -74
- package/livewire/examples/livewire-handoff.ts +0 -197
- package/livewire/examples/livewire-multi-tool.ts +0 -117
- package/relay/README.md +0 -70
- package/relay/RELAY_IMPLEMENTATION_GUIDE.md +0 -1257
- package/relay/docs/call-methods.md +0 -474
- package/relay/docs/client-reference.md +0 -142
- package/relay/docs/events.md +0 -134
- package/relay/docs/getting-started.md +0 -134
- package/relay/docs/guide.md +0 -306
- package/relay/docs/messaging.md +0 -182
- package/relay/examples/relay-inbound.ts +0 -66
- package/relay/examples/relay-messaging.ts +0 -71
- package/relay/examples/relay-outbound.ts +0 -76
- package/rest/README.md +0 -95
- package/rest/docs/calling.md +0 -273
- package/rest/docs/client-reference.md +0 -107
- package/rest/docs/compat.md +0 -204
- package/rest/docs/fabric.md +0 -183
- package/rest/docs/getting-started.md +0 -110
- package/rest/docs/guide.md +0 -351
- package/rest/docs/namespaces.md +0 -285
- package/rest/examples/rest-10dlc-registration.ts +0 -161
- package/rest/examples/rest-calling-ivr-and-ai.ts +0 -102
- package/rest/examples/rest-calling-play-and-record.ts +0 -91
- package/rest/examples/rest-client.ts +0 -65
- package/rest/examples/rest-compat-laml.ts +0 -210
- package/rest/examples/rest-datasphere-search.ts +0 -82
- package/rest/examples/rest-fabric-conferences-and-routing.ts +0 -144
- package/rest/examples/rest-fabric-subscribers-and-sip.ts +0 -108
- package/rest/examples/rest-fabric-swml-and-callflows.ts +0 -99
- package/rest/examples/rest-manage-resources.ts +0 -65
- package/rest/examples/rest-phone-number-management.ts +0 -197
- package/rest/examples/rest-queues-mfa-and-recordings.ts +0 -143
- package/rest/examples/rest-video-rooms.ts +0 -186
- package/src/AgentBase.ts +0 -2598
- package/src/AgentServer.ts +0 -442
- package/src/AuthHandler.ts +0 -256
- package/src/ConfigLoader.ts +0 -447
- package/src/ContextBuilder.ts +0 -1181
- package/src/DataMap.ts +0 -477
- package/src/FunctionResult.ts +0 -903
- package/src/Logger.ts +0 -337
- package/src/PomBuilder.ts +0 -467
- package/src/PromptManager.ts +0 -133
- package/src/SWMLHandler.ts +0 -298
- package/src/SWMLService.ts +0 -749
- package/src/SchemaUtils.ts +0 -361
- package/src/ServerlessAdapter.ts +0 -240
- package/src/SessionManager.ts +0 -311
- package/src/SslConfig.ts +0 -118
- package/src/SwaigFunction.ts +0 -276
- package/src/SwmlBuilder.ts +0 -283
- package/src/SwmlVerbMethods.generated.ts +0 -234
- package/src/TypeInference.ts +0 -199
- package/src/WebService.ts +0 -641
- package/src/cli/agent-loader.ts +0 -166
- package/src/cli/mock-data.ts +0 -111
- package/src/cli/swaig-test.ts +0 -452
- package/src/generateVerbTypes.ts +0 -322
- package/src/livewire/index.ts +0 -1252
- package/src/prefabs/ConciergeAgent.ts +0 -309
- package/src/prefabs/FAQBotAgent.ts +0 -415
- package/src/prefabs/InfoGathererAgent.ts +0 -379
- package/src/prefabs/ReceptionistAgent.ts +0 -395
- package/src/prefabs/SurveyAgent.ts +0 -671
- package/src/relay/Action.ts +0 -482
- package/src/relay/Call.ts +0 -1270
- package/src/relay/Deferred.ts +0 -94
- package/src/relay/Message.ts +0 -199
- package/src/relay/RelayClient.ts +0 -1185
- package/src/relay/RelayError.ts +0 -20
- package/src/relay/RelayEvent.ts +0 -944
- package/src/relay/index.ts +0 -123
- package/src/relay/types.ts +0 -149
- package/src/rest/HttpClient.ts +0 -164
- package/src/rest/RestError.ts +0 -45
- package/src/rest/base/BaseResource.ts +0 -32
- package/src/rest/base/CrudResource.ts +0 -98
- package/src/rest/base/CrudWithAddresses.ts +0 -37
- package/src/rest/namespaces/addresses.ts +0 -64
- package/src/rest/namespaces/calling.ts +0 -534
- package/src/rest/namespaces/chat.ts +0 -31
- package/src/rest/namespaces/compat.ts +0 -812
- package/src/rest/namespaces/datasphere.ts +0 -88
- package/src/rest/namespaces/fabric.ts +0 -417
- package/src/rest/namespaces/imported-numbers.ts +0 -31
- package/src/rest/namespaces/logs.ts +0 -151
- package/src/rest/namespaces/lookup.ts +0 -38
- package/src/rest/namespaces/mfa.ts +0 -61
- package/src/rest/namespaces/number-groups.ts +0 -68
- package/src/rest/namespaces/phone-numbers.ts +0 -76
- package/src/rest/namespaces/project.ts +0 -65
- package/src/rest/namespaces/pubsub.ts +0 -31
- package/src/rest/namespaces/queues.ts +0 -58
- package/src/rest/namespaces/recordings.ts +0 -53
- package/src/rest/namespaces/registry.ts +0 -200
- package/src/rest/namespaces/short-codes.ts +0 -54
- package/src/rest/namespaces/sip-profile.ts +0 -40
- package/src/rest/namespaces/verified-callers.ts +0 -46
- package/src/rest/namespaces/video.ts +0 -332
- package/src/rest/types.ts +0 -61
- package/src/skills/SkillBase.ts +0 -582
- package/src/skills/SkillManager.ts +0 -419
- package/src/skills/SkillRegistry.ts +0 -367
- package/src/skills/builtin/api_ninjas_trivia.ts +0 -285
- package/src/skills/builtin/ask_claude.ts +0 -246
- package/src/skills/builtin/claude_skills.ts +0 -983
- package/src/skills/builtin/custom_skills.ts +0 -327
- package/src/skills/builtin/datasphere.ts +0 -447
- package/src/skills/builtin/datasphere_serverless.ts +0 -347
- package/src/skills/builtin/datetime.ts +0 -137
- package/src/skills/builtin/google_maps.ts +0 -656
- package/src/skills/builtin/info_gatherer.ts +0 -415
- package/src/skills/builtin/joke.ts +0 -196
- package/src/skills/builtin/math.ts +0 -149
- package/src/skills/builtin/mcp_gateway.ts +0 -685
- package/src/skills/builtin/native_vector_search.ts +0 -910
- package/src/skills/builtin/play_background_file.ts +0 -367
- package/src/skills/builtin/spider.ts +0 -874
- package/src/skills/builtin/swml_transfer.ts +0 -645
- package/src/skills/builtin/weather_api.ts +0 -255
- package/src/skills/builtin/web_search.ts +0 -1083
- package/src/skills/builtin/wikipedia_search.ts +0 -304
- package/src/types.ts +0 -132
- package/tests/AgentBase.test.ts +0 -1093
- package/tests/AgentServer.test.ts +0 -126
- package/tests/AuthHandler.test.ts +0 -133
- package/tests/ConfigLoader.test.ts +0 -151
- package/tests/ContextBuilder.test.ts +0 -108
- package/tests/DataMap.test.ts +0 -367
- package/tests/EphemeralSkillCopy.test.ts +0 -107
- package/tests/FunctionResult.test.ts +0 -298
- package/tests/GracefulShutdown.test.ts +0 -46
- package/tests/Logger.test.ts +0 -420
- package/tests/PomBuilder.test.ts +0 -228
- package/tests/ProxyDetection.test.ts +0 -228
- package/tests/SWMLService.test.ts +0 -320
- package/tests/SWMLVerbHandler.test.ts +0 -523
- package/tests/SchemaUtils.test.ts +0 -106
- package/tests/SchemaUtils.verb.test.ts +0 -206
- package/tests/SecurityUtils.test.ts +0 -192
- package/tests/ServerlessAdapter.test.ts +0 -222
- package/tests/SessionManager.test.ts +0 -257
- package/tests/SkillBaseFeatures.test.ts +0 -130
- package/tests/SkillMultiInstance.test.ts +0 -102
- package/tests/SkillParameterSchemas.test.ts +0 -134
- package/tests/SkillRegistrySchema.test.ts +0 -84
- package/tests/SslConfig.test.ts +0 -97
- package/tests/SwmlBuilder.test.ts +0 -400
- package/tests/TypeInference.test.ts +0 -165
- package/tests/VerbHandlerRegistry.test.ts +0 -128
- package/tests/cli/mock-data.test.ts +0 -113
- package/tests/cli/swaig-test.test.ts +0 -108
- package/tests/examples.test.ts +0 -194
- package/tests/fixtures/scrape-parity/README.md +0 -53
- package/tests/fixtures/scrape-parity/expected/01_simple_article.json +0 -5
- package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +0 -5
- package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +0 -5
- package/tests/fixtures/scrape-parity/expected/04_bare_body.json +0 -5
- package/tests/fixtures/scrape-parity/expected/05_malformed.json +0 -5
- package/tests/fixtures/scrape-parity/expected/06_multi_class.json +0 -5
- package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +0 -5
- package/tests/fixtures/scrape-parity/expected/08_inline_script.json +0 -5
- package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +0 -5
- package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +0 -5
- package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +0 -5
- package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +0 -5
- package/tests/fixtures/scrape-parity/html/01_simple_article.html +0 -18
- package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +0 -18
- package/tests/fixtures/scrape-parity/html/03_nested_containers.html +0 -13
- package/tests/fixtures/scrape-parity/html/04_bare_body.html +0 -9
- package/tests/fixtures/scrape-parity/html/05_malformed.html +0 -11
- package/tests/fixtures/scrape-parity/html/06_multi_class.html +0 -18
- package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +0 -12
- package/tests/fixtures/scrape-parity/html/08_inline_script.html +0 -17
- package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +0 -21
- package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +0 -10
- package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +0 -13
- package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +0 -24
- package/tests/fixtures/scrape-parity/python_extract.py +0 -109
- package/tests/livewire/livewire.test.ts +0 -780
- package/tests/mcp.test.ts +0 -221
- package/tests/prefabs/prefabs.test.ts +0 -1093
- package/tests/relay/Action.test.ts +0 -392
- package/tests/relay/Call.test.ts +0 -535
- package/tests/relay/Deferred.test.ts +0 -71
- package/tests/relay/Message.test.ts +0 -164
- package/tests/relay/RelayClient.test.ts +0 -779
- package/tests/relay/RelayEvent.test.ts +0 -463
- package/tests/relay/helpers.ts +0 -79
- package/tests/rest/HttpClient.test.ts +0 -274
- package/tests/rest/RestError.test.ts +0 -53
- package/tests/rest/calling.test.ts +0 -156
- package/tests/rest/client.test.ts +0 -197
- package/tests/rest/compat.test.ts +0 -335
- package/tests/rest/datasphere.test.ts +0 -71
- package/tests/rest/fabric.test.ts +0 -186
- package/tests/rest/helpers.ts +0 -95
- package/tests/rest/logs.test.ts +0 -68
- package/tests/rest/pagination.test.ts +0 -133
- package/tests/rest/registry.test.ts +0 -94
- package/tests/rest/relay-rest.test.ts +0 -290
- package/tests/rest/video.test.ts +0 -173
- package/tests/setup.ts +0 -6
- package/tests/skills/SkillBase.test.ts +0 -108
- package/tests/skills/SkillManager.test.ts +0 -268
- package/tests/skills/SkillRegistry.test.ts +0 -176
- package/tests/skills/builtin.test.ts +0 -1472
- package/tests/skills/claude-skills.test.ts +0 -54
- package/tests/skills/custom-skills.test.ts +0 -53
- package/tests/skills/datasphere-serverless.test.ts +0 -70
- package/tests/skills/datasphere.test.ts +0 -107
- package/tests/skills/datetime.test.ts +0 -101
- package/tests/skills/google-maps.test.ts +0 -78
- package/tests/skills/info-gatherer.test.ts +0 -411
- package/tests/skills/joke.test.ts +0 -81
- package/tests/skills/math.test.ts +0 -68
- package/tests/skills/mcp-gateway.test.ts +0 -101
- package/tests/skills/play-background.test.ts +0 -54
- package/tests/skills/spider.test.ts +0 -108
- package/tests/skills/swml-transfer.test.ts +0 -178
- package/tests/skills/trivia.test.ts +0 -54
- package/tests/skills/vector-search.test.ts +0 -135
- package/tests/skills/weather-api.test.ts +0 -77
- package/tests/skills/web-search-parity.test.ts +0 -59
- package/tests/skills/web-search.test.ts +0 -103
- package/tests/skills/wikipedia.test.ts +0 -63
- package/tsconfig.json +0 -18
- package/vitest.config.ts +0 -9
- /package/{src → dist}/schema.json +0 -0
|
@@ -0,0 +1,1019 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* RelayClient — WebSocket + JSON-RPC 2.0 protocol + event dispatch.
|
|
3
|
+
*
|
|
4
|
+
* One instance = one persistent WebSocket connection to SignalWire RELAY.
|
|
5
|
+
*
|
|
6
|
+
* Architecture:
|
|
7
|
+
* - JSON-RPC requests tracked by `id` in `_pending`; responses resolve deferreds
|
|
8
|
+
* - signalwire.event messages ACKed back to server, then dispatched to Call/Message
|
|
9
|
+
* - Result code checking accepts any 2xx (regex /^2\d{2}$/)
|
|
10
|
+
* - signalwire.connect responses skip code checking
|
|
11
|
+
* - Execute queue for requests while disconnected
|
|
12
|
+
* - Auto-reconnect with exponential backoff
|
|
13
|
+
*/
|
|
14
|
+
/* eslint-disable @typescript-eslint/no-explicit-any */
|
|
15
|
+
import { randomUUID } from 'node:crypto';
|
|
16
|
+
import { getLogger } from '../Logger.js';
|
|
17
|
+
import { Call } from './Call.js';
|
|
18
|
+
import { createDeferred } from './Deferred.js';
|
|
19
|
+
import { AGENT_STRING, PROTOCOL_VERSION, DEFAULT_RELAY_HOST, EVENT_AUTHORIZATION_STATE, EVENT_CALL_DIAL, EVENT_CALL_RECEIVE, EVENT_CALL_STATE, EVENT_MESSAGING_RECEIVE, EVENT_MESSAGING_STATE, METHOD_SIGNALWIRE_CONNECT, METHOD_SIGNALWIRE_DISCONNECT, METHOD_SIGNALWIRE_EVENT, METHOD_SIGNALWIRE_PING, METHOD_SIGNALWIRE_RECEIVE, METHOD_SIGNALWIRE_UNRECEIVE, RECONNECT_BACKOFF_FACTOR, RECONNECT_MAX_DELAY, RECONNECT_MIN_DELAY, CLIENT_PING_INTERVAL, CLIENT_PING_MAX_FAILURES, SERVER_PING_TIMEOUT, REQUEST_TIMEOUT, EXECUTE_QUEUE_MAX, } from './constants.js';
|
|
20
|
+
import { Message } from './Message.js';
|
|
21
|
+
import { RelayError } from './RelayError.js';
|
|
22
|
+
// Polyfill Symbol.asyncDispose for runtimes that don't have it yet (Node <20.4)
|
|
23
|
+
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
|
24
|
+
Symbol.asyncDispose ??= Symbol.for('Symbol.asyncDispose');
|
|
25
|
+
const logger = getLogger('relay_client');
|
|
26
|
+
// Any 2xx code is considered success
|
|
27
|
+
const SUCCESS_CODE_RE = /^2\d{2}$/;
|
|
28
|
+
// Safety limits
|
|
29
|
+
const DEFAULT_MAX_ACTIVE_CALLS = 1000;
|
|
30
|
+
// Max concurrent RelayClient connections per process (env: RELAY_MAX_CONNECTIONS)
|
|
31
|
+
// Mirrors Python _MAX_CONNECTIONS (relay/client.py:81-88). Default 1, min 1,
|
|
32
|
+
// invalid env values fall back to 1.
|
|
33
|
+
function _parseMaxConnections() {
|
|
34
|
+
const raw = process.env.RELAY_MAX_CONNECTIONS;
|
|
35
|
+
if (raw == null || raw === '')
|
|
36
|
+
return 1;
|
|
37
|
+
const parsed = parseInt(raw, 10);
|
|
38
|
+
if (isNaN(parsed))
|
|
39
|
+
return 1;
|
|
40
|
+
return Math.max(1, parsed);
|
|
41
|
+
}
|
|
42
|
+
const _MAX_CONNECTIONS = _parseMaxConnections();
|
|
43
|
+
// Process-wide tracking of active RelayClient instances. Python uses id(self);
|
|
44
|
+
// TS has no such helper, so we track instance refs — identity equality is fine.
|
|
45
|
+
const _activeClients = new Set();
|
|
46
|
+
/**
|
|
47
|
+
* Real-time WebSocket client for SignalWire RELAY.
|
|
48
|
+
*
|
|
49
|
+
* One instance = one persistent JSON-RPC 2.0 WebSocket connection. Lets you
|
|
50
|
+
* place / receive calls and SMS, play/record media, run TTS, conference calls
|
|
51
|
+
* together, and subscribe to platform events — all without HTTP polling.
|
|
52
|
+
*
|
|
53
|
+
* Authentication supports either a project/token pair or a JWT.
|
|
54
|
+
*
|
|
55
|
+
* @example Inbound-call handler
|
|
56
|
+
* ```ts
|
|
57
|
+
* import { RelayClient } from '@signalwire/sdk';
|
|
58
|
+
*
|
|
59
|
+
* const client = new RelayClient({
|
|
60
|
+
* project: process.env.SIGNALWIRE_PROJECT_ID!,
|
|
61
|
+
* token: process.env.SIGNALWIRE_API_TOKEN!,
|
|
62
|
+
* host: 'example.signalwire.com',
|
|
63
|
+
* contexts: ['office'],
|
|
64
|
+
* });
|
|
65
|
+
*
|
|
66
|
+
* client.onCall(async (call) => {
|
|
67
|
+
* await call.answer();
|
|
68
|
+
* await call.playTTS({ text: 'Thanks for calling!' });
|
|
69
|
+
* await call.hangup();
|
|
70
|
+
* });
|
|
71
|
+
*
|
|
72
|
+
* await client.connect();
|
|
73
|
+
* ```
|
|
74
|
+
*
|
|
75
|
+
* @example Outbound dial + SMS
|
|
76
|
+
* ```ts
|
|
77
|
+
* await client.connect();
|
|
78
|
+
* const call = await client.dial({
|
|
79
|
+
* devices: [[{ type: 'phone', to: '+15551234567', from: '+15557654321' }]],
|
|
80
|
+
* });
|
|
81
|
+
* await client.sendMessage({ to: '+15551234567', from: '+15557654321', body: 'Hi!' });
|
|
82
|
+
* ```
|
|
83
|
+
*
|
|
84
|
+
* @see {@link Call}
|
|
85
|
+
* @see {@link Message}
|
|
86
|
+
*/
|
|
87
|
+
export class RelayClient {
|
|
88
|
+
/** Project ID used for Basic Auth. */
|
|
89
|
+
project;
|
|
90
|
+
/** API token used for Basic Auth. */
|
|
91
|
+
token;
|
|
92
|
+
/** JWT used instead of project/token if provided. */
|
|
93
|
+
jwtToken;
|
|
94
|
+
/** Hostname of the RELAY endpoint (e.g. `example.signalwire.com`). */
|
|
95
|
+
host;
|
|
96
|
+
/** Contexts this client subscribes to for inbound events. */
|
|
97
|
+
contexts;
|
|
98
|
+
_ws = null;
|
|
99
|
+
_pending = new Map();
|
|
100
|
+
_pendingMethods = new Map();
|
|
101
|
+
_calls = new Map();
|
|
102
|
+
_messages = new Map();
|
|
103
|
+
_pendingDials = new Map();
|
|
104
|
+
_dialCallsByTag = new Map();
|
|
105
|
+
_executeQueue = [];
|
|
106
|
+
_onCallHandler = null;
|
|
107
|
+
_onMessageHandler = null;
|
|
108
|
+
_connected = false;
|
|
109
|
+
_closing = false;
|
|
110
|
+
_reconnectDelay = RECONNECT_MIN_DELAY;
|
|
111
|
+
_relayProtocol = '';
|
|
112
|
+
_identity = '';
|
|
113
|
+
_authorizationState = '';
|
|
114
|
+
_pingInterval = null;
|
|
115
|
+
_pingFailures = 0;
|
|
116
|
+
_serverPingTimeout = null;
|
|
117
|
+
_maxActiveCalls = DEFAULT_MAX_ACTIVE_CALLS;
|
|
118
|
+
// For run() — resolves when shutdown requested
|
|
119
|
+
_shutdownDeferred = null;
|
|
120
|
+
_signalHandlers = [];
|
|
121
|
+
/**
|
|
122
|
+
* WebSocket constructor override for testing.
|
|
123
|
+
* @internal
|
|
124
|
+
*/
|
|
125
|
+
_wsFactory = null;
|
|
126
|
+
/**
|
|
127
|
+
* Create a new RELAY client.
|
|
128
|
+
* Credentials fall back to the `SIGNALWIRE_PROJECT_ID`, `SIGNALWIRE_API_TOKEN`,
|
|
129
|
+
* `SIGNALWIRE_JWT_TOKEN`, and `SIGNALWIRE_SPACE` env vars when omitted.
|
|
130
|
+
* @param options - Optional client configuration.
|
|
131
|
+
*/
|
|
132
|
+
constructor(options = {}) {
|
|
133
|
+
this.project = options.project ?? process.env.SIGNALWIRE_PROJECT_ID ?? '';
|
|
134
|
+
this.token = options.token ?? process.env.SIGNALWIRE_API_TOKEN ?? '';
|
|
135
|
+
this.jwtToken = options.jwtToken ?? process.env.SIGNALWIRE_JWT_TOKEN ?? '';
|
|
136
|
+
this.host = options.host ?? process.env.SIGNALWIRE_SPACE ?? DEFAULT_RELAY_HOST;
|
|
137
|
+
this.contexts = options.contexts ?? [];
|
|
138
|
+
if (this.jwtToken) {
|
|
139
|
+
// JWT auth — project/token not required
|
|
140
|
+
}
|
|
141
|
+
else if (!this.project || !this.token) {
|
|
142
|
+
throw new Error('project and token are required (or provide jwt_token). ' +
|
|
143
|
+
'Pass them directly or set SIGNALWIRE_PROJECT_ID / SIGNALWIRE_API_TOKEN env vars.');
|
|
144
|
+
}
|
|
145
|
+
// Validate host
|
|
146
|
+
if (/[@/?#\r\n ]/.test(this.host)) {
|
|
147
|
+
throw new Error(`Invalid host: ${this.host}. Must be a hostname, not a URL.`);
|
|
148
|
+
}
|
|
149
|
+
// Max concurrent calls (constructor > env var > default)
|
|
150
|
+
if (options.maxActiveCalls != null) {
|
|
151
|
+
this._maxActiveCalls = Math.max(1, options.maxActiveCalls);
|
|
152
|
+
}
|
|
153
|
+
else {
|
|
154
|
+
const envVal = process.env.RELAY_MAX_ACTIVE_CALLS ?? '';
|
|
155
|
+
const parsed = parseInt(envVal, 10);
|
|
156
|
+
this._maxActiveCalls = envVal && !isNaN(parsed) ? Math.max(1, parsed) : DEFAULT_MAX_ACTIVE_CALLS;
|
|
157
|
+
}
|
|
158
|
+
}
|
|
159
|
+
/** The protocol name the server assigned to this client after `connect()`. */
|
|
160
|
+
get relayProtocol() {
|
|
161
|
+
return this._relayProtocol;
|
|
162
|
+
}
|
|
163
|
+
/**
|
|
164
|
+
* Async disposable support — equivalent to Python's `__aexit__`.
|
|
165
|
+
*
|
|
166
|
+
* Enables usage with `await using`:
|
|
167
|
+
* ```ts
|
|
168
|
+
* await using client = new RelayClient({ ... });
|
|
169
|
+
* await client.connect();
|
|
170
|
+
* // ... automatically disconnects when scope exits
|
|
171
|
+
* ```
|
|
172
|
+
*
|
|
173
|
+
* For environments without `await using`, use try/finally:
|
|
174
|
+
* ```ts
|
|
175
|
+
* const client = new RelayClient({ ... });
|
|
176
|
+
* try { await client.connect(); ... }
|
|
177
|
+
* finally { await client.disconnect(); }
|
|
178
|
+
* ```
|
|
179
|
+
*/
|
|
180
|
+
async [Symbol.asyncDispose]() {
|
|
181
|
+
await this.disconnect();
|
|
182
|
+
}
|
|
183
|
+
// ─── Handler Registration ──────────────────────────────────────
|
|
184
|
+
/**
|
|
185
|
+
* Register the inbound call handler.
|
|
186
|
+
*
|
|
187
|
+
* The handler is invoked once per inbound call, with a fully-formed
|
|
188
|
+
* {@link Call} already in state `"created"`. Answer, reject, or forward
|
|
189
|
+
* the call from inside the handler.
|
|
190
|
+
*
|
|
191
|
+
* @param handler - Callback invoked for each inbound call. May return a
|
|
192
|
+
* promise; errors are logged but do not tear down the client.
|
|
193
|
+
* @returns The same handler, to support decorator-style usage.
|
|
194
|
+
*/
|
|
195
|
+
onCall(handler) {
|
|
196
|
+
this._onCallHandler = handler;
|
|
197
|
+
return handler;
|
|
198
|
+
}
|
|
199
|
+
/**
|
|
200
|
+
* Register the inbound message handler.
|
|
201
|
+
*
|
|
202
|
+
* The handler is invoked once per inbound SMS/MMS delivered to a subscribed
|
|
203
|
+
* context, with a {@link Message} already in state `"received"`.
|
|
204
|
+
*
|
|
205
|
+
* @param handler - Callback invoked for each inbound message. May return a
|
|
206
|
+
* promise; errors are logged but do not tear down the client.
|
|
207
|
+
* @returns The same handler, to support decorator-style usage.
|
|
208
|
+
*/
|
|
209
|
+
onMessage(handler) {
|
|
210
|
+
this._onMessageHandler = handler;
|
|
211
|
+
return handler;
|
|
212
|
+
}
|
|
213
|
+
// ─── Connection Lifecycle ──────────────────────────────────────
|
|
214
|
+
/**
|
|
215
|
+
* Connect to RELAY and authenticate.
|
|
216
|
+
*
|
|
217
|
+
* Opens the WebSocket, runs the JSON-RPC `signalwire.connect` handshake,
|
|
218
|
+
* and starts the client-side ping loop. Safe to call again after a
|
|
219
|
+
* `disconnect()` to reconnect; the process-wide concurrent-connection limit
|
|
220
|
+
* is enforced here.
|
|
221
|
+
*
|
|
222
|
+
* @returns Resolves once the client is connected and authenticated.
|
|
223
|
+
* @throws {Error} When the process-wide connection limit is reached,
|
|
224
|
+
* authentication fails, or the WebSocket cannot be opened.
|
|
225
|
+
*/
|
|
226
|
+
async connect() {
|
|
227
|
+
// Guard against connection leaks — enforce per-process limit.
|
|
228
|
+
// Don't count ourselves (allows reconnect without double-counting).
|
|
229
|
+
// Mirrors Python relay/client.py:216-228.
|
|
230
|
+
let otherCount = 0;
|
|
231
|
+
for (const c of _activeClients) {
|
|
232
|
+
if (c !== this)
|
|
233
|
+
otherCount++;
|
|
234
|
+
}
|
|
235
|
+
if (otherCount >= _MAX_CONNECTIONS) {
|
|
236
|
+
throw new Error(`RelayClient connection limit reached (${_MAX_CONNECTIONS}). ` +
|
|
237
|
+
`There are already ${otherCount} active connection(s) in this process. ` +
|
|
238
|
+
`Call disconnect() on existing clients first, or set ` +
|
|
239
|
+
`RELAY_MAX_CONNECTIONS env var to allow more.`);
|
|
240
|
+
}
|
|
241
|
+
_activeClients.add(this);
|
|
242
|
+
const uri = `wss://${this.host}`;
|
|
243
|
+
logger.info(`Connecting to ${uri}`);
|
|
244
|
+
const ws = this._wsFactory
|
|
245
|
+
? this._wsFactory(uri)
|
|
246
|
+
: await this._createWebSocket(uri);
|
|
247
|
+
this._ws = ws;
|
|
248
|
+
this._connected = true;
|
|
249
|
+
this._reconnectDelay = RECONNECT_MIN_DELAY;
|
|
250
|
+
// Set up message handling
|
|
251
|
+
this._setupWsListeners(ws);
|
|
252
|
+
// Authenticate
|
|
253
|
+
await this._authenticate();
|
|
254
|
+
// Start client ping loop
|
|
255
|
+
this._pingFailures = 0;
|
|
256
|
+
this._startPingLoop();
|
|
257
|
+
// Flush queued requests
|
|
258
|
+
this._flushExecuteQueue();
|
|
259
|
+
logger.info('Connected and authenticated to RELAY');
|
|
260
|
+
}
|
|
261
|
+
/** Create a real WebSocket (uses dynamic import for ws). */
|
|
262
|
+
async _createWebSocket(uri) {
|
|
263
|
+
// eslint-disable-next-line @typescript-eslint/no-var-requires
|
|
264
|
+
const wsModule = await import('ws');
|
|
265
|
+
const WS = wsModule.default ?? wsModule;
|
|
266
|
+
return new WS(uri, { maxPayload: 10 * 1024 * 1024 });
|
|
267
|
+
}
|
|
268
|
+
_setupWsListeners(ws) {
|
|
269
|
+
ws.on('message', (data) => {
|
|
270
|
+
const raw = typeof data === 'string' ? data : data.toString();
|
|
271
|
+
let msg;
|
|
272
|
+
try {
|
|
273
|
+
msg = JSON.parse(raw);
|
|
274
|
+
}
|
|
275
|
+
catch {
|
|
276
|
+
logger.warn(`Invalid JSON received: ${raw}`);
|
|
277
|
+
return;
|
|
278
|
+
}
|
|
279
|
+
logger.debug(`<< ${raw}`);
|
|
280
|
+
this._handleMessage(msg).catch((err) => {
|
|
281
|
+
logger.error(`Error handling message: ${err}`);
|
|
282
|
+
});
|
|
283
|
+
});
|
|
284
|
+
ws.on('close', () => {
|
|
285
|
+
logger.info('WebSocket connection closed');
|
|
286
|
+
this._connected = false;
|
|
287
|
+
this._stopPingLoop();
|
|
288
|
+
this._cancelServerPingTimeout();
|
|
289
|
+
});
|
|
290
|
+
ws.on('error', (err) => {
|
|
291
|
+
logger.error(`WebSocket error: ${err}`);
|
|
292
|
+
});
|
|
293
|
+
// Server ping (if ws supports it)
|
|
294
|
+
ws.on('ping', () => {
|
|
295
|
+
this._resetServerPingTimeout();
|
|
296
|
+
});
|
|
297
|
+
}
|
|
298
|
+
/** Send signalwire.connect and wait for the response. */
|
|
299
|
+
async _authenticate() {
|
|
300
|
+
let authentication;
|
|
301
|
+
if (this.jwtToken) {
|
|
302
|
+
authentication = { jwt_token: this.jwtToken };
|
|
303
|
+
}
|
|
304
|
+
else {
|
|
305
|
+
authentication = { project: this.project, token: this.token };
|
|
306
|
+
}
|
|
307
|
+
const params = {
|
|
308
|
+
version: PROTOCOL_VERSION,
|
|
309
|
+
agent: AGENT_STRING,
|
|
310
|
+
event_acks: true,
|
|
311
|
+
authentication,
|
|
312
|
+
};
|
|
313
|
+
if (this.contexts.length > 0) {
|
|
314
|
+
params.contexts = this.contexts;
|
|
315
|
+
}
|
|
316
|
+
if (this._relayProtocol) {
|
|
317
|
+
params.protocol = this._relayProtocol;
|
|
318
|
+
}
|
|
319
|
+
if (this._authorizationState) {
|
|
320
|
+
params.authorization_state = this._authorizationState;
|
|
321
|
+
}
|
|
322
|
+
const result = await this._sendRequest(METHOD_SIGNALWIRE_CONNECT, params);
|
|
323
|
+
this._relayProtocol = result.protocol ?? this._relayProtocol;
|
|
324
|
+
this._identity = result.identity ?? this._identity;
|
|
325
|
+
logger.debug(`Auth response: protocol=${this._relayProtocol} identity=${this._identity}`);
|
|
326
|
+
}
|
|
327
|
+
/**
|
|
328
|
+
* Cleanly close the connection.
|
|
329
|
+
*
|
|
330
|
+
* Stops the ping loop, drops the WebSocket, rejects every pending request
|
|
331
|
+
* and dial with a `Connection closed` {@link RelayError}, and removes the
|
|
332
|
+
* client from the process-wide active set. Safe to call repeatedly.
|
|
333
|
+
*
|
|
334
|
+
* @returns Resolves once all resources have been released.
|
|
335
|
+
*/
|
|
336
|
+
async disconnect() {
|
|
337
|
+
this._closing = true;
|
|
338
|
+
this._connected = false;
|
|
339
|
+
// Mirrors Python relay/client.py:290 — remove from per-process active set.
|
|
340
|
+
// Safe to call even if we never connected (Set.delete is idempotent).
|
|
341
|
+
_activeClients.delete(this);
|
|
342
|
+
this._stopPingLoop();
|
|
343
|
+
this._cancelServerPingTimeout();
|
|
344
|
+
if (this._ws) {
|
|
345
|
+
this._ws.removeAllListeners();
|
|
346
|
+
this._ws.close();
|
|
347
|
+
this._ws = null;
|
|
348
|
+
}
|
|
349
|
+
// Reject all pending
|
|
350
|
+
this._clearPendingRequests();
|
|
351
|
+
// Cancel queued requests
|
|
352
|
+
for (const { deferred } of this._executeQueue) {
|
|
353
|
+
if (!deferred.settled) {
|
|
354
|
+
deferred.reject(new RelayError(-1, 'Connection closed'));
|
|
355
|
+
deferred.promise.catch(() => { });
|
|
356
|
+
}
|
|
357
|
+
}
|
|
358
|
+
this._executeQueue = [];
|
|
359
|
+
// Cancel pending dials
|
|
360
|
+
for (const deferred of Array.from(this._pendingDials.values())) {
|
|
361
|
+
if (!deferred.settled) {
|
|
362
|
+
deferred.reject(new RelayError(-1, 'Connection closed during dial'));
|
|
363
|
+
deferred.promise.catch(() => { });
|
|
364
|
+
}
|
|
365
|
+
}
|
|
366
|
+
this._pendingDials.clear();
|
|
367
|
+
this._dialCallsByTag.clear();
|
|
368
|
+
logger.info('Disconnected from RELAY');
|
|
369
|
+
}
|
|
370
|
+
// ─── Public RPC Interface ──────────────────────────────────────
|
|
371
|
+
/**
|
|
372
|
+
* Send a JSON-RPC request and await the response.
|
|
373
|
+
*
|
|
374
|
+
* This is the low-level escape hatch for calling RELAY methods that don't
|
|
375
|
+
* yet have a higher-level helper on this class. Queued if the client is
|
|
376
|
+
* currently disconnected; sent immediately otherwise.
|
|
377
|
+
*
|
|
378
|
+
* @param method - Fully-qualified JSON-RPC method name (e.g. `"calling.play"`).
|
|
379
|
+
* @param params - Method-specific params object.
|
|
380
|
+
* @returns The `result` field of the JSON-RPC response.
|
|
381
|
+
* @throws {RelayError} When the server returns a non-2xx code.
|
|
382
|
+
*/
|
|
383
|
+
async execute(method, params) {
|
|
384
|
+
return this._sendRequest(method, params);
|
|
385
|
+
}
|
|
386
|
+
/**
|
|
387
|
+
* Initiate an outbound call.
|
|
388
|
+
*
|
|
389
|
+
* Accepts a "dial plan" — an outer array of serial groups, each containing
|
|
390
|
+
* an inner array of devices dialled in parallel. Resolves when any device
|
|
391
|
+
* answers; rejects if no device answers within `dialTimeout`.
|
|
392
|
+
*
|
|
393
|
+
* @param devices - Serial/parallel dial plan. `[[A], [B, C]]` dials A first,
|
|
394
|
+
* then B and C in parallel.
|
|
395
|
+
* @param options - Optional dial behaviour overrides.
|
|
396
|
+
* @param options.tag - Client-provided tag for event correlation.
|
|
397
|
+
* Auto-generated (UUID) when omitted.
|
|
398
|
+
* @param options.maxDuration - Maximum call duration in minutes.
|
|
399
|
+
* @param options.dialTimeout - Seconds to wait for the dial to complete.
|
|
400
|
+
* Defaults to `120`.
|
|
401
|
+
* @returns A {@link Call} representing the answered leg.
|
|
402
|
+
* @throws {Error} When the dial times out.
|
|
403
|
+
* @throws {RelayError} When the server rejects the dial request.
|
|
404
|
+
*/
|
|
405
|
+
async dial(devices, options = {}) {
|
|
406
|
+
const dialTag = options.tag ?? randomUUID();
|
|
407
|
+
const params = {
|
|
408
|
+
tag: dialTag,
|
|
409
|
+
devices,
|
|
410
|
+
};
|
|
411
|
+
if (options.maxDuration != null)
|
|
412
|
+
params.max_duration = options.maxDuration;
|
|
413
|
+
// Register a deferred that _handleEvent will resolve
|
|
414
|
+
const dialDeferred = createDeferred();
|
|
415
|
+
this._pendingDials.set(dialTag, dialDeferred);
|
|
416
|
+
this._dialCallsByTag.set(dialTag, []);
|
|
417
|
+
try {
|
|
418
|
+
await this.execute('calling.dial', params);
|
|
419
|
+
const timeoutSec = options.dialTimeout ?? 120;
|
|
420
|
+
const timeoutMs = timeoutSec * 1000;
|
|
421
|
+
const call = await new Promise((resolve, reject) => {
|
|
422
|
+
const timer = setTimeout(() => {
|
|
423
|
+
reject(new RelayError(-1, `Dial timed out waiting for answer (tag=${dialTag})`));
|
|
424
|
+
}, timeoutMs);
|
|
425
|
+
dialDeferred.promise.then((v) => { clearTimeout(timer); resolve(v); }, (e) => { clearTimeout(timer); reject(e); });
|
|
426
|
+
});
|
|
427
|
+
return call;
|
|
428
|
+
}
|
|
429
|
+
catch (err) {
|
|
430
|
+
if (!dialDeferred.settled) {
|
|
431
|
+
dialDeferred.reject(err);
|
|
432
|
+
dialDeferred.promise.catch(() => { });
|
|
433
|
+
}
|
|
434
|
+
throw err;
|
|
435
|
+
}
|
|
436
|
+
finally {
|
|
437
|
+
this._pendingDials.delete(dialTag);
|
|
438
|
+
this._dialCallsByTag.delete(dialTag);
|
|
439
|
+
}
|
|
440
|
+
}
|
|
441
|
+
/**
|
|
442
|
+
* Send an outbound SMS / MMS message.
|
|
443
|
+
*
|
|
444
|
+
* The method returns as soon as the server has accepted the send; track the
|
|
445
|
+
* message's terminal state with {@link Message.wait} or the `onCompleted`
|
|
446
|
+
* callback.
|
|
447
|
+
*
|
|
448
|
+
* @param options - Send parameters.
|
|
449
|
+
* @param options.toNumber - Destination phone number in E.164 format.
|
|
450
|
+
* @param options.fromNumber - Sender phone number in E.164 format.
|
|
451
|
+
* @param options.context - Context for receiving state events. Defaults to
|
|
452
|
+
* the negotiated relay protocol.
|
|
453
|
+
* @param options.body - Text body of the message.
|
|
454
|
+
* @param options.media - List of media URLs for MMS.
|
|
455
|
+
* @param options.tags - Tags attached to the message for correlation.
|
|
456
|
+
* @param options.region - Origination region override.
|
|
457
|
+
* @param options.onCompleted - Optional callback fired when the message
|
|
458
|
+
* reaches a terminal state (delivered / failed / undelivered).
|
|
459
|
+
* @returns A {@link Message} tracking the outbound send.
|
|
460
|
+
* @throws {RelayError} When the server rejects the send request.
|
|
461
|
+
*/
|
|
462
|
+
async sendMessage(options) {
|
|
463
|
+
if (!options.body && (!options.media || options.media.length === 0)) {
|
|
464
|
+
throw new Error('At least one of body or media is required');
|
|
465
|
+
}
|
|
466
|
+
const msgContext = options.context ?? this._relayProtocol ?? 'default';
|
|
467
|
+
const params = {
|
|
468
|
+
context: msgContext,
|
|
469
|
+
to_number: options.toNumber,
|
|
470
|
+
from_number: options.fromNumber,
|
|
471
|
+
};
|
|
472
|
+
if (options.body)
|
|
473
|
+
params.body = options.body;
|
|
474
|
+
if (options.media)
|
|
475
|
+
params.media = options.media;
|
|
476
|
+
if (options.tags)
|
|
477
|
+
params.tags = options.tags;
|
|
478
|
+
if (options.region)
|
|
479
|
+
params.region = options.region;
|
|
480
|
+
const result = await this.execute('messaging.send', params);
|
|
481
|
+
const messageId = result.message_id ?? '';
|
|
482
|
+
const message = new Message({
|
|
483
|
+
messageId,
|
|
484
|
+
context: msgContext,
|
|
485
|
+
direction: 'outbound',
|
|
486
|
+
fromNumber: options.fromNumber,
|
|
487
|
+
toNumber: options.toNumber,
|
|
488
|
+
body: options.body ?? '',
|
|
489
|
+
media: options.media ?? [],
|
|
490
|
+
tags: options.tags ?? [],
|
|
491
|
+
state: 'queued',
|
|
492
|
+
});
|
|
493
|
+
if (options.onCompleted) {
|
|
494
|
+
message._onCompleted = options.onCompleted;
|
|
495
|
+
}
|
|
496
|
+
if (messageId) {
|
|
497
|
+
this._messages.set(messageId, message);
|
|
498
|
+
}
|
|
499
|
+
return message;
|
|
500
|
+
}
|
|
501
|
+
/**
|
|
502
|
+
* Subscribe to additional RELAY contexts on an already-connected client.
|
|
503
|
+
*
|
|
504
|
+
* Inbound calls and messages on any of the listed contexts will be delivered
|
|
505
|
+
* to the `onCall` / `onMessage` handlers. A no-op when `contexts` is empty.
|
|
506
|
+
*
|
|
507
|
+
* @param contexts - Context names to subscribe to.
|
|
508
|
+
* @returns Resolves once the server has confirmed the subscription.
|
|
509
|
+
* @throws {RelayError} When the server rejects the subscribe request.
|
|
510
|
+
*/
|
|
511
|
+
async receive(contexts) {
|
|
512
|
+
if (!contexts.length)
|
|
513
|
+
return;
|
|
514
|
+
await this._sendRequest(METHOD_SIGNALWIRE_RECEIVE, { contexts });
|
|
515
|
+
logger.info(`Subscribed to contexts: ${contexts}`);
|
|
516
|
+
}
|
|
517
|
+
/**
|
|
518
|
+
* Unsubscribe from contexts previously passed to {@link receive} (or the
|
|
519
|
+
* constructor). A no-op when `contexts` is empty.
|
|
520
|
+
*
|
|
521
|
+
* @param contexts - Context names to unsubscribe from.
|
|
522
|
+
* @returns Resolves once the server has confirmed the unsubscribe.
|
|
523
|
+
* @throws {RelayError} When the server rejects the unsubscribe request.
|
|
524
|
+
*/
|
|
525
|
+
async unreceive(contexts) {
|
|
526
|
+
if (!contexts.length)
|
|
527
|
+
return;
|
|
528
|
+
await this._sendRequest(METHOD_SIGNALWIRE_UNRECEIVE, { contexts });
|
|
529
|
+
logger.info(`Unsubscribed from contexts: ${contexts}`);
|
|
530
|
+
}
|
|
531
|
+
// ─── Run (auto-reconnect loop) ────────────────────────────────
|
|
532
|
+
/**
|
|
533
|
+
* Blocking entry point — connects and maintains the connection with
|
|
534
|
+
* auto-reconnect, returning only after a clean shutdown (Ctrl+C, SIGTERM,
|
|
535
|
+
* or {@link disconnect} from another scope).
|
|
536
|
+
*
|
|
537
|
+
* Installs `SIGINT` / `SIGTERM` handlers, so typically only one `RelayClient`
|
|
538
|
+
* per process should call `run()`.
|
|
539
|
+
*
|
|
540
|
+
* @returns Resolves once a shutdown has been requested and cleanup completes.
|
|
541
|
+
* @throws {Error} Only on unrecoverable startup failures — normal
|
|
542
|
+
* disconnects are handled internally by the reconnect loop.
|
|
543
|
+
*/
|
|
544
|
+
async run() {
|
|
545
|
+
this._closing = false;
|
|
546
|
+
this._shutdownDeferred = createDeferred();
|
|
547
|
+
// Handle SIGINT/SIGTERM
|
|
548
|
+
const shutdown = () => {
|
|
549
|
+
logger.info('Shutting down ...');
|
|
550
|
+
this._closing = true;
|
|
551
|
+
if (this._ws) {
|
|
552
|
+
this._ws.close();
|
|
553
|
+
}
|
|
554
|
+
this._shutdownDeferred?.resolve();
|
|
555
|
+
};
|
|
556
|
+
process.on('SIGINT', shutdown);
|
|
557
|
+
process.on('SIGTERM', shutdown);
|
|
558
|
+
this._signalHandlers = [
|
|
559
|
+
() => process.removeListener('SIGINT', shutdown),
|
|
560
|
+
() => process.removeListener('SIGTERM', shutdown),
|
|
561
|
+
];
|
|
562
|
+
try {
|
|
563
|
+
while (!this._closing) {
|
|
564
|
+
try {
|
|
565
|
+
await this.connect();
|
|
566
|
+
// Block until connection closes
|
|
567
|
+
await new Promise((resolve) => {
|
|
568
|
+
if (!this._ws) {
|
|
569
|
+
resolve();
|
|
570
|
+
return;
|
|
571
|
+
}
|
|
572
|
+
this._ws.on('close', () => resolve());
|
|
573
|
+
});
|
|
574
|
+
}
|
|
575
|
+
catch (err) {
|
|
576
|
+
if (this._closing)
|
|
577
|
+
break;
|
|
578
|
+
logger.error(`Connection error: ${err}`);
|
|
579
|
+
}
|
|
580
|
+
if (this._closing)
|
|
581
|
+
break;
|
|
582
|
+
this._stopPingLoop();
|
|
583
|
+
this._cancelServerPingTimeout();
|
|
584
|
+
this._clearPendingRequests();
|
|
585
|
+
// Auto-reconnect with exponential backoff
|
|
586
|
+
logger.info(`Reconnecting in ${this._reconnectDelay.toFixed(1)}s ...`);
|
|
587
|
+
await new Promise((resolve) => {
|
|
588
|
+
const timer = setTimeout(resolve, this._reconnectDelay * 1000);
|
|
589
|
+
// If shutdown requested during wait, resolve immediately
|
|
590
|
+
this._shutdownDeferred?.promise.then(() => {
|
|
591
|
+
clearTimeout(timer);
|
|
592
|
+
resolve();
|
|
593
|
+
});
|
|
594
|
+
});
|
|
595
|
+
if (this._closing)
|
|
596
|
+
break;
|
|
597
|
+
this._reconnectDelay = Math.min(this._reconnectDelay * RECONNECT_BACKOFF_FACTOR, RECONNECT_MAX_DELAY);
|
|
598
|
+
}
|
|
599
|
+
}
|
|
600
|
+
finally {
|
|
601
|
+
await this.disconnect();
|
|
602
|
+
// Cleanup signal handlers
|
|
603
|
+
for (const cleanup of this._signalHandlers)
|
|
604
|
+
cleanup();
|
|
605
|
+
this._signalHandlers = [];
|
|
606
|
+
logger.info('RELAY client stopped');
|
|
607
|
+
}
|
|
608
|
+
}
|
|
609
|
+
// ─── Internal: Send / Receive ──────────────────────────────────
|
|
610
|
+
async _sendRequest(method, params) {
|
|
611
|
+
const reqId = randomUUID();
|
|
612
|
+
const message = {
|
|
613
|
+
jsonrpc: '2.0',
|
|
614
|
+
id: reqId,
|
|
615
|
+
method,
|
|
616
|
+
params,
|
|
617
|
+
};
|
|
618
|
+
const deferred = createDeferred();
|
|
619
|
+
this._pending.set(reqId, deferred);
|
|
620
|
+
this._pendingMethods.set(reqId, method);
|
|
621
|
+
try {
|
|
622
|
+
if (!this._ws || !this._connected) {
|
|
623
|
+
if (this._executeQueue.length >= EXECUTE_QUEUE_MAX) {
|
|
624
|
+
throw new RelayError(-1, 'Execute queue full — too many requests while disconnected');
|
|
625
|
+
}
|
|
626
|
+
this._executeQueue.push({ message, deferred });
|
|
627
|
+
logger.debug(`Request queued (not connected): ${method}`);
|
|
628
|
+
}
|
|
629
|
+
else {
|
|
630
|
+
const raw = JSON.stringify(message);
|
|
631
|
+
logger.debug(`>> ${method} id=${reqId}`);
|
|
632
|
+
this._ws.send(raw);
|
|
633
|
+
}
|
|
634
|
+
// Timeout
|
|
635
|
+
return await new Promise((resolve, reject) => {
|
|
636
|
+
const timer = setTimeout(() => {
|
|
637
|
+
reject(new RelayError(-1, `Request timeout for ${method}`));
|
|
638
|
+
if (method !== METHOD_SIGNALWIRE_CONNECT) {
|
|
639
|
+
this._forceClose();
|
|
640
|
+
}
|
|
641
|
+
}, REQUEST_TIMEOUT);
|
|
642
|
+
deferred.promise.then((v) => { clearTimeout(timer); resolve(v); }, (e) => { clearTimeout(timer); reject(e); });
|
|
643
|
+
});
|
|
644
|
+
}
|
|
645
|
+
finally {
|
|
646
|
+
this._pending.delete(reqId);
|
|
647
|
+
this._pendingMethods.delete(reqId);
|
|
648
|
+
}
|
|
649
|
+
}
|
|
650
|
+
_flushExecuteQueue() {
|
|
651
|
+
if (!this._executeQueue.length || !this._ws)
|
|
652
|
+
return;
|
|
653
|
+
const queued = [...this._executeQueue];
|
|
654
|
+
this._executeQueue = [];
|
|
655
|
+
logger.debug(`Flushing ${queued.length} queued requests`);
|
|
656
|
+
for (const { message, deferred } of queued) {
|
|
657
|
+
if (deferred.settled)
|
|
658
|
+
continue;
|
|
659
|
+
const raw = JSON.stringify(message);
|
|
660
|
+
logger.debug(`>> (queued) ${message.method ?? '?'} id=${message.id ?? '?'}`);
|
|
661
|
+
try {
|
|
662
|
+
this._ws.send(raw);
|
|
663
|
+
}
|
|
664
|
+
catch (err) {
|
|
665
|
+
if (!deferred.settled) {
|
|
666
|
+
deferred.reject(new RelayError(-1, `Failed to send queued request: ${err}`));
|
|
667
|
+
deferred.promise.catch(() => { });
|
|
668
|
+
}
|
|
669
|
+
}
|
|
670
|
+
}
|
|
671
|
+
}
|
|
672
|
+
_clearPendingRequests() {
|
|
673
|
+
for (const deferred of Array.from(this._pending.values())) {
|
|
674
|
+
if (!deferred.settled) {
|
|
675
|
+
deferred.reject(new RelayError(-1, 'Connection closed'));
|
|
676
|
+
deferred.promise.catch(() => { });
|
|
677
|
+
}
|
|
678
|
+
}
|
|
679
|
+
this._pending.clear();
|
|
680
|
+
this._pendingMethods.clear();
|
|
681
|
+
for (const deferred of Array.from(this._pendingDials.values())) {
|
|
682
|
+
if (!deferred.settled) {
|
|
683
|
+
deferred.reject(new RelayError(-1, 'Connection closed during dial'));
|
|
684
|
+
deferred.promise.catch(() => { });
|
|
685
|
+
}
|
|
686
|
+
}
|
|
687
|
+
this._pendingDials.clear();
|
|
688
|
+
this._dialCallsByTag.clear();
|
|
689
|
+
}
|
|
690
|
+
// ─── Message Handling ──────────────────────────────────────────
|
|
691
|
+
async _handleMessage(msg) {
|
|
692
|
+
if (typeof msg !== 'object' || msg === null) {
|
|
693
|
+
logger.warn('Ignoring non-object message');
|
|
694
|
+
return;
|
|
695
|
+
}
|
|
696
|
+
// JSON-RPC error response
|
|
697
|
+
if ('id' in msg && 'error' in msg) {
|
|
698
|
+
const reqId = msg.id;
|
|
699
|
+
const deferred = this._pending.get(reqId);
|
|
700
|
+
if (deferred && !deferred.settled) {
|
|
701
|
+
const error = typeof msg.error === 'object' ? msg.error : { code: -1, message: String(msg.error) };
|
|
702
|
+
deferred.reject(new RelayError(error.code ?? -1, String(error.message ?? 'Unknown error')));
|
|
703
|
+
}
|
|
704
|
+
return;
|
|
705
|
+
}
|
|
706
|
+
// JSON-RPC success response
|
|
707
|
+
if ('id' in msg && 'result' in msg) {
|
|
708
|
+
const reqId = msg.id;
|
|
709
|
+
const deferred = this._pending.get(reqId);
|
|
710
|
+
if (deferred && !deferred.settled) {
|
|
711
|
+
const result = msg.result;
|
|
712
|
+
if (typeof result !== 'object' || result === null) {
|
|
713
|
+
deferred.resolve({ raw: result });
|
|
714
|
+
return;
|
|
715
|
+
}
|
|
716
|
+
const requestMethod = this._pendingMethods.get(reqId) ?? '';
|
|
717
|
+
if (requestMethod === METHOD_SIGNALWIRE_CONNECT) {
|
|
718
|
+
deferred.resolve(result);
|
|
719
|
+
}
|
|
720
|
+
else {
|
|
721
|
+
const code = result.code;
|
|
722
|
+
const codeStr = code != null ? String(code) : null;
|
|
723
|
+
if (codeStr != null && !SUCCESS_CODE_RE.test(codeStr)) {
|
|
724
|
+
let intCode;
|
|
725
|
+
try {
|
|
726
|
+
intCode = parseInt(codeStr, 10);
|
|
727
|
+
}
|
|
728
|
+
catch {
|
|
729
|
+
intCode = -1;
|
|
730
|
+
}
|
|
731
|
+
if (isNaN(intCode))
|
|
732
|
+
intCode = -1;
|
|
733
|
+
deferred.reject(new RelayError(intCode, String(result.message ?? 'Unknown error')));
|
|
734
|
+
}
|
|
735
|
+
else {
|
|
736
|
+
deferred.resolve(result);
|
|
737
|
+
}
|
|
738
|
+
}
|
|
739
|
+
}
|
|
740
|
+
return;
|
|
741
|
+
}
|
|
742
|
+
// Server-initiated method call
|
|
743
|
+
const method = (msg.method ?? '');
|
|
744
|
+
const params = (msg.params ?? {});
|
|
745
|
+
if (typeof params !== 'object') {
|
|
746
|
+
logger.warn('Ignoring message with non-object params');
|
|
747
|
+
return;
|
|
748
|
+
}
|
|
749
|
+
if (method === METHOD_SIGNALWIRE_EVENT) {
|
|
750
|
+
if ('id' in msg) {
|
|
751
|
+
this._sendEventAck(msg.id);
|
|
752
|
+
}
|
|
753
|
+
await this._handleEvent(params);
|
|
754
|
+
}
|
|
755
|
+
else if (method === METHOD_SIGNALWIRE_PING) {
|
|
756
|
+
this._resetServerPingTimeout();
|
|
757
|
+
if ('id' in msg) {
|
|
758
|
+
this._sendPong(msg.id);
|
|
759
|
+
}
|
|
760
|
+
}
|
|
761
|
+
else if (method === METHOD_SIGNALWIRE_DISCONNECT) {
|
|
762
|
+
const restart = params.restart ?? false;
|
|
763
|
+
logger.info(`Received signalwire.disconnect from server (restart=${restart})`);
|
|
764
|
+
if ('id' in msg) {
|
|
765
|
+
this._sendEventAck(msg.id);
|
|
766
|
+
}
|
|
767
|
+
if (restart) {
|
|
768
|
+
this._relayProtocol = '';
|
|
769
|
+
this._authorizationState = '';
|
|
770
|
+
}
|
|
771
|
+
}
|
|
772
|
+
}
|
|
773
|
+
// ─── Event Dispatch ────────────────────────────────────────────
|
|
774
|
+
async _handleEvent(payload) {
|
|
775
|
+
const eventType = (payload.event_type ?? '');
|
|
776
|
+
const eventParams = (payload.params ?? {});
|
|
777
|
+
const callId = (eventParams.call_id ?? '');
|
|
778
|
+
if (!eventType) {
|
|
779
|
+
logger.warn(`Received event with empty event_type: ${JSON.stringify(payload)}`);
|
|
780
|
+
return;
|
|
781
|
+
}
|
|
782
|
+
logger.debug(`Event: ${eventType} call_id=${callId}`);
|
|
783
|
+
// Authorization state update
|
|
784
|
+
if (eventType === EVENT_AUTHORIZATION_STATE) {
|
|
785
|
+
const authState = (eventParams.authorization_state ?? '');
|
|
786
|
+
if (authState) {
|
|
787
|
+
this._authorizationState = authState;
|
|
788
|
+
logger.debug('Updated authorization_state for reconnection');
|
|
789
|
+
}
|
|
790
|
+
return;
|
|
791
|
+
}
|
|
792
|
+
// Inbound message
|
|
793
|
+
if (eventType === EVENT_MESSAGING_RECEIVE) {
|
|
794
|
+
this._handleInboundMessage(payload);
|
|
795
|
+
return;
|
|
796
|
+
}
|
|
797
|
+
// Outbound message state change
|
|
798
|
+
if (eventType === EVENT_MESSAGING_STATE) {
|
|
799
|
+
this._handleMessageState(payload);
|
|
800
|
+
return;
|
|
801
|
+
}
|
|
802
|
+
// Inbound call
|
|
803
|
+
if (eventType === EVENT_CALL_RECEIVE) {
|
|
804
|
+
this._handleInboundCall(payload);
|
|
805
|
+
return;
|
|
806
|
+
}
|
|
807
|
+
// Outbound dial progress
|
|
808
|
+
if (eventType === EVENT_CALL_DIAL) {
|
|
809
|
+
await this._handleDialEvent(payload);
|
|
810
|
+
return;
|
|
811
|
+
}
|
|
812
|
+
// State events during pending dial
|
|
813
|
+
if (eventType === EVENT_CALL_STATE) {
|
|
814
|
+
const tag = (eventParams.tag ?? '');
|
|
815
|
+
if (tag && this._pendingDials.has(tag) && callId) {
|
|
816
|
+
if (!this._calls.has(callId)) {
|
|
817
|
+
this._registerDialLeg(tag, eventParams);
|
|
818
|
+
}
|
|
819
|
+
// Fall through to normal routing
|
|
820
|
+
}
|
|
821
|
+
}
|
|
822
|
+
// Route to existing Call by call_id
|
|
823
|
+
if (callId) {
|
|
824
|
+
const call = this._calls.get(callId);
|
|
825
|
+
if (call) {
|
|
826
|
+
await call._dispatchEvent(payload);
|
|
827
|
+
if (call.state === 'ended') {
|
|
828
|
+
this._calls.delete(callId);
|
|
829
|
+
}
|
|
830
|
+
}
|
|
831
|
+
}
|
|
832
|
+
}
|
|
833
|
+
_handleInboundCall(payload) {
|
|
834
|
+
if (this._calls.size >= this._maxActiveCalls) {
|
|
835
|
+
logger.error(`Max active calls (${this._maxActiveCalls}) reached, dropping inbound call`);
|
|
836
|
+
return;
|
|
837
|
+
}
|
|
838
|
+
const params = (payload.params ?? {});
|
|
839
|
+
const callId = (params.call_id ?? '');
|
|
840
|
+
const call = new Call(this, callId, params.node_id ?? '', params.project_id ?? this.project, this._relayProtocol || params.context || params.protocol || '', {
|
|
841
|
+
tag: params.tag ?? '',
|
|
842
|
+
direction: params.direction ?? 'inbound',
|
|
843
|
+
device: params.device,
|
|
844
|
+
state: params.call_state ?? 'created',
|
|
845
|
+
segmentId: params.segment_id ?? '',
|
|
846
|
+
});
|
|
847
|
+
this._calls.set(callId, call);
|
|
848
|
+
if (this._onCallHandler) {
|
|
849
|
+
Promise.resolve(this._onCallHandler(call)).catch((err) => {
|
|
850
|
+
logger.error(`Error in on_call handler for ${callId}: ${err}`);
|
|
851
|
+
});
|
|
852
|
+
}
|
|
853
|
+
else {
|
|
854
|
+
logger.warn(`Inbound call ${callId} but no on_call handler registered`);
|
|
855
|
+
}
|
|
856
|
+
}
|
|
857
|
+
_handleInboundMessage(payload) {
|
|
858
|
+
const params = (payload.params ?? {});
|
|
859
|
+
const message = new Message({
|
|
860
|
+
messageId: params.message_id ?? '',
|
|
861
|
+
context: params.context ?? '',
|
|
862
|
+
direction: params.direction ?? 'inbound',
|
|
863
|
+
fromNumber: params.from_number ?? '',
|
|
864
|
+
toNumber: params.to_number ?? '',
|
|
865
|
+
body: params.body ?? '',
|
|
866
|
+
media: params.media ?? [],
|
|
867
|
+
segments: params.segments ?? 0,
|
|
868
|
+
state: params.message_state ?? 'received',
|
|
869
|
+
tags: params.tags ?? [],
|
|
870
|
+
});
|
|
871
|
+
if (this._onMessageHandler) {
|
|
872
|
+
Promise.resolve(this._onMessageHandler(message)).catch((err) => {
|
|
873
|
+
logger.error(`Error in on_message handler for ${message.messageId}: ${err}`);
|
|
874
|
+
});
|
|
875
|
+
}
|
|
876
|
+
else {
|
|
877
|
+
logger.warn(`Inbound message ${message.messageId} but no on_message handler registered`);
|
|
878
|
+
}
|
|
879
|
+
}
|
|
880
|
+
_handleMessageState(payload) {
|
|
881
|
+
const params = (payload.params ?? {});
|
|
882
|
+
const messageId = (params.message_id ?? '');
|
|
883
|
+
const message = this._messages.get(messageId);
|
|
884
|
+
if (message) {
|
|
885
|
+
message._dispatchEvent(payload).catch((err) => {
|
|
886
|
+
logger.error(`Error dispatching message state for ${messageId}: ${err}`);
|
|
887
|
+
});
|
|
888
|
+
if (message.isDone) {
|
|
889
|
+
this._messages.delete(messageId);
|
|
890
|
+
}
|
|
891
|
+
}
|
|
892
|
+
else {
|
|
893
|
+
logger.debug(`State event for unknown message ${messageId}`);
|
|
894
|
+
}
|
|
895
|
+
}
|
|
896
|
+
_registerDialLeg(tag, eventParams) {
|
|
897
|
+
const callId = (eventParams.call_id ?? '');
|
|
898
|
+
const nodeId = (eventParams.node_id ?? '');
|
|
899
|
+
const call = new Call(this, callId, nodeId, eventParams.project_id ?? this.project, this._relayProtocol, {
|
|
900
|
+
tag,
|
|
901
|
+
direction: 'outbound',
|
|
902
|
+
device: eventParams.device,
|
|
903
|
+
state: eventParams.call_state ?? 'created',
|
|
904
|
+
});
|
|
905
|
+
this._calls.set(callId, call);
|
|
906
|
+
const legs = this._dialCallsByTag.get(tag) ?? [];
|
|
907
|
+
legs.push(call);
|
|
908
|
+
this._dialCallsByTag.set(tag, legs);
|
|
909
|
+
logger.debug(`Registered dial leg: call_id=${callId} tag=${tag}`);
|
|
910
|
+
return call;
|
|
911
|
+
}
|
|
912
|
+
async _handleDialEvent(payload) {
|
|
913
|
+
const eventParams = (payload.params ?? {});
|
|
914
|
+
const tag = (eventParams.tag ?? '');
|
|
915
|
+
const dialState = (eventParams.dial_state ?? '');
|
|
916
|
+
const callInfo = (eventParams.call ?? {});
|
|
917
|
+
logger.debug(`Dial event: tag=${tag} state=${dialState}`);
|
|
918
|
+
const dialDeferred = this._pendingDials.get(tag);
|
|
919
|
+
if (!dialDeferred || dialDeferred.settled) {
|
|
920
|
+
// Stale or progress event after resolution — dispatch to call if exists
|
|
921
|
+
if (callInfo) {
|
|
922
|
+
const cid = (callInfo.call_id ?? '');
|
|
923
|
+
const call = this._calls.get(cid);
|
|
924
|
+
if (call) {
|
|
925
|
+
await call._dispatchEvent(payload);
|
|
926
|
+
}
|
|
927
|
+
}
|
|
928
|
+
return;
|
|
929
|
+
}
|
|
930
|
+
if (dialState === 'answered') {
|
|
931
|
+
const winnerCallId = (callInfo.call_id ?? '');
|
|
932
|
+
const winnerNodeId = (callInfo.node_id ?? '');
|
|
933
|
+
let call = this._calls.get(winnerCallId);
|
|
934
|
+
if (!call) {
|
|
935
|
+
call = new Call(this, winnerCallId, winnerNodeId, this.project, this._relayProtocol, {
|
|
936
|
+
tag,
|
|
937
|
+
direction: 'outbound',
|
|
938
|
+
device: callInfo.device,
|
|
939
|
+
state: 'answered',
|
|
940
|
+
});
|
|
941
|
+
this._calls.set(winnerCallId, call);
|
|
942
|
+
}
|
|
943
|
+
else {
|
|
944
|
+
if (winnerNodeId && !call.nodeId) {
|
|
945
|
+
call.nodeId = winnerNodeId;
|
|
946
|
+
}
|
|
947
|
+
}
|
|
948
|
+
dialDeferred.resolve(call);
|
|
949
|
+
}
|
|
950
|
+
else if (dialState === 'failed') {
|
|
951
|
+
dialDeferred.reject(new RelayError(-1, `Dial failed (tag=${tag})`));
|
|
952
|
+
dialDeferred.promise.catch(() => { });
|
|
953
|
+
}
|
|
954
|
+
// "dialing" events are progress — don't resolve
|
|
955
|
+
}
|
|
956
|
+
// ─── Pong / ACK ───────────────────────────────────────────────
|
|
957
|
+
_sendPong(reqId) {
|
|
958
|
+
if (!this._ws)
|
|
959
|
+
return;
|
|
960
|
+
const msg = JSON.stringify({ jsonrpc: '2.0', id: reqId, result: {} });
|
|
961
|
+
this._ws.send(msg);
|
|
962
|
+
}
|
|
963
|
+
_sendEventAck(reqId) {
|
|
964
|
+
if (!this._ws)
|
|
965
|
+
return;
|
|
966
|
+
const msg = JSON.stringify({ jsonrpc: '2.0', id: reqId, result: {} });
|
|
967
|
+
this._ws.send(msg);
|
|
968
|
+
}
|
|
969
|
+
// ─── Client Ping Loop ─────────────────────────────────────────
|
|
970
|
+
_startPingLoop() {
|
|
971
|
+
this._stopPingLoop();
|
|
972
|
+
this._pingInterval = setInterval(async () => {
|
|
973
|
+
if (!this._connected || !this._ws)
|
|
974
|
+
return;
|
|
975
|
+
try {
|
|
976
|
+
await this._sendRequest(METHOD_SIGNALWIRE_PING, {});
|
|
977
|
+
this._pingFailures = 0;
|
|
978
|
+
}
|
|
979
|
+
catch {
|
|
980
|
+
this._pingFailures++;
|
|
981
|
+
const backoff = Math.min(RECONNECT_MIN_DELAY * (RECONNECT_BACKOFF_FACTOR ** this._pingFailures), RECONNECT_MAX_DELAY);
|
|
982
|
+
logger.warn(`Client ping failed (${this._pingFailures}/${CLIENT_PING_MAX_FAILURES}), backoff ${backoff.toFixed(1)}s`);
|
|
983
|
+
if (this._pingFailures >= CLIENT_PING_MAX_FAILURES) {
|
|
984
|
+
logger.error('Max ping failures reached, forcing reconnect');
|
|
985
|
+
this._forceClose();
|
|
986
|
+
}
|
|
987
|
+
}
|
|
988
|
+
}, CLIENT_PING_INTERVAL);
|
|
989
|
+
}
|
|
990
|
+
_stopPingLoop() {
|
|
991
|
+
if (this._pingInterval) {
|
|
992
|
+
clearInterval(this._pingInterval);
|
|
993
|
+
this._pingInterval = null;
|
|
994
|
+
}
|
|
995
|
+
}
|
|
996
|
+
// ─── Server Ping Watchdog ─────────────────────────────────────
|
|
997
|
+
_resetServerPingTimeout() {
|
|
998
|
+
this._pingFailures = 0;
|
|
999
|
+
this._cancelServerPingTimeout();
|
|
1000
|
+
this._serverPingTimeout = setTimeout(() => {
|
|
1001
|
+
logger.debug(`No server ping received in ${SERVER_PING_TIMEOUT}ms, client pings will probe`);
|
|
1002
|
+
}, SERVER_PING_TIMEOUT);
|
|
1003
|
+
}
|
|
1004
|
+
_cancelServerPingTimeout() {
|
|
1005
|
+
if (this._serverPingTimeout) {
|
|
1006
|
+
clearTimeout(this._serverPingTimeout);
|
|
1007
|
+
this._serverPingTimeout = null;
|
|
1008
|
+
}
|
|
1009
|
+
}
|
|
1010
|
+
_forceClose() {
|
|
1011
|
+
this._stopPingLoop();
|
|
1012
|
+
this._cancelServerPingTimeout();
|
|
1013
|
+
this._connected = false;
|
|
1014
|
+
if (this._ws) {
|
|
1015
|
+
this._ws.close();
|
|
1016
|
+
}
|
|
1017
|
+
}
|
|
1018
|
+
}
|
|
1019
|
+
//# sourceMappingURL=RelayClient.js.map
|