@signalwire/sdk 2.0.1 → 2.0.3
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 +1026 -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,302 @@
|
|
|
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
|
+
import { Call } from './Call.js';
|
|
15
|
+
import { Message } from './Message.js';
|
|
16
|
+
import type { CallHandler, MessageHandler, RelayClientOptions } from './types.js';
|
|
17
|
+
type WsLike = {
|
|
18
|
+
send(data: string): void;
|
|
19
|
+
close(code?: number, reason?: string): void;
|
|
20
|
+
on(event: string, listener: (...args: any[]) => void): void;
|
|
21
|
+
removeAllListeners(): void;
|
|
22
|
+
readyState: number;
|
|
23
|
+
ping?(data?: any, mask?: boolean, cb?: (err: Error) => void): void;
|
|
24
|
+
};
|
|
25
|
+
/**
|
|
26
|
+
* Real-time WebSocket client for SignalWire RELAY.
|
|
27
|
+
*
|
|
28
|
+
* One instance = one persistent JSON-RPC 2.0 WebSocket connection. Lets you
|
|
29
|
+
* place / receive calls and SMS, play/record media, run TTS, conference calls
|
|
30
|
+
* together, and subscribe to platform events — all without HTTP polling.
|
|
31
|
+
*
|
|
32
|
+
* Authentication supports either a project/token pair or a JWT.
|
|
33
|
+
*
|
|
34
|
+
* @example Inbound-call handler
|
|
35
|
+
* ```ts
|
|
36
|
+
* import { RelayClient } from '@signalwire/sdk';
|
|
37
|
+
*
|
|
38
|
+
* const client = new RelayClient({
|
|
39
|
+
* project: process.env.SIGNALWIRE_PROJECT_ID!,
|
|
40
|
+
* token: process.env.SIGNALWIRE_API_TOKEN!,
|
|
41
|
+
* host: 'example.signalwire.com',
|
|
42
|
+
* contexts: ['office'],
|
|
43
|
+
* });
|
|
44
|
+
*
|
|
45
|
+
* client.onCall(async (call) => {
|
|
46
|
+
* await call.answer();
|
|
47
|
+
* await call.playTTS({ text: 'Thanks for calling!' });
|
|
48
|
+
* await call.hangup();
|
|
49
|
+
* });
|
|
50
|
+
*
|
|
51
|
+
* await client.connect();
|
|
52
|
+
* ```
|
|
53
|
+
*
|
|
54
|
+
* @example Outbound dial + SMS
|
|
55
|
+
* ```ts
|
|
56
|
+
* await client.connect();
|
|
57
|
+
* const call = await client.dial({
|
|
58
|
+
* devices: [[{ type: 'phone', to: '+15551234567', from: '+15557654321' }]],
|
|
59
|
+
* });
|
|
60
|
+
* await client.sendMessage({ to: '+15551234567', from: '+15557654321', body: 'Hi!' });
|
|
61
|
+
* ```
|
|
62
|
+
*
|
|
63
|
+
* @see {@link Call}
|
|
64
|
+
* @see {@link Message}
|
|
65
|
+
*/
|
|
66
|
+
export declare class RelayClient {
|
|
67
|
+
/** Project ID used for Basic Auth. */
|
|
68
|
+
readonly project: string;
|
|
69
|
+
/** API token used for Basic Auth. */
|
|
70
|
+
readonly token: string;
|
|
71
|
+
/** JWT used instead of project/token if provided. */
|
|
72
|
+
readonly jwtToken: string;
|
|
73
|
+
/** Hostname of the RELAY endpoint (e.g. `example.signalwire.com`). */
|
|
74
|
+
readonly host: string;
|
|
75
|
+
/** Contexts this client subscribes to for inbound events. */
|
|
76
|
+
readonly contexts: string[];
|
|
77
|
+
private _ws;
|
|
78
|
+
private _pending;
|
|
79
|
+
private _pendingMethods;
|
|
80
|
+
private _calls;
|
|
81
|
+
private _messages;
|
|
82
|
+
private _pendingDials;
|
|
83
|
+
private _dialCallsByTag;
|
|
84
|
+
private _executeQueue;
|
|
85
|
+
private _onCallHandler;
|
|
86
|
+
private _onMessageHandler;
|
|
87
|
+
private _connected;
|
|
88
|
+
private _closing;
|
|
89
|
+
private _reconnectDelay;
|
|
90
|
+
private _relayProtocol;
|
|
91
|
+
private _identity;
|
|
92
|
+
private _authorizationState;
|
|
93
|
+
private _pingInterval;
|
|
94
|
+
private _pingFailures;
|
|
95
|
+
private _serverPingTimeout;
|
|
96
|
+
private _maxActiveCalls;
|
|
97
|
+
private _shutdownDeferred;
|
|
98
|
+
private _signalHandlers;
|
|
99
|
+
/**
|
|
100
|
+
* WebSocket constructor override for testing.
|
|
101
|
+
* @internal
|
|
102
|
+
*/
|
|
103
|
+
_wsFactory: ((url: string) => WsLike) | null;
|
|
104
|
+
/**
|
|
105
|
+
* Create a new RELAY client.
|
|
106
|
+
* Credentials fall back to the `SIGNALWIRE_PROJECT_ID`, `SIGNALWIRE_API_TOKEN`,
|
|
107
|
+
* `SIGNALWIRE_JWT_TOKEN`, and `SIGNALWIRE_SPACE` env vars when omitted.
|
|
108
|
+
* @param options - Optional client configuration.
|
|
109
|
+
*/
|
|
110
|
+
constructor(options?: RelayClientOptions);
|
|
111
|
+
/** The protocol name the server assigned to this client after `connect()`. */
|
|
112
|
+
get relayProtocol(): string;
|
|
113
|
+
/**
|
|
114
|
+
* Async disposable support — equivalent to Python's `__aexit__`.
|
|
115
|
+
*
|
|
116
|
+
* Enables usage with `await using`:
|
|
117
|
+
* ```ts
|
|
118
|
+
* await using client = new RelayClient({ ... });
|
|
119
|
+
* await client.connect();
|
|
120
|
+
* // ... automatically disconnects when scope exits
|
|
121
|
+
* ```
|
|
122
|
+
*
|
|
123
|
+
* For environments without `await using`, use try/finally:
|
|
124
|
+
* ```ts
|
|
125
|
+
* const client = new RelayClient({ ... });
|
|
126
|
+
* try { await client.connect(); ... }
|
|
127
|
+
* finally { await client.disconnect(); }
|
|
128
|
+
* ```
|
|
129
|
+
*/
|
|
130
|
+
[Symbol.asyncDispose](): Promise<void>;
|
|
131
|
+
/**
|
|
132
|
+
* Register the inbound call handler.
|
|
133
|
+
*
|
|
134
|
+
* The handler is invoked once per inbound call, with a fully-formed
|
|
135
|
+
* {@link Call} already in state `"created"`. Answer, reject, or forward
|
|
136
|
+
* the call from inside the handler.
|
|
137
|
+
*
|
|
138
|
+
* @param handler - Callback invoked for each inbound call. May return a
|
|
139
|
+
* promise; errors are logged but do not tear down the client.
|
|
140
|
+
* @returns The same handler, to support decorator-style usage.
|
|
141
|
+
*/
|
|
142
|
+
onCall(handler: CallHandler): CallHandler;
|
|
143
|
+
/**
|
|
144
|
+
* Register the inbound message handler.
|
|
145
|
+
*
|
|
146
|
+
* The handler is invoked once per inbound SMS/MMS delivered to a subscribed
|
|
147
|
+
* context, with a {@link Message} already in state `"received"`.
|
|
148
|
+
*
|
|
149
|
+
* @param handler - Callback invoked for each inbound message. May return a
|
|
150
|
+
* promise; errors are logged but do not tear down the client.
|
|
151
|
+
* @returns The same handler, to support decorator-style usage.
|
|
152
|
+
*/
|
|
153
|
+
onMessage(handler: MessageHandler): MessageHandler;
|
|
154
|
+
/**
|
|
155
|
+
* Connect to RELAY and authenticate.
|
|
156
|
+
*
|
|
157
|
+
* Opens the WebSocket, runs the JSON-RPC `signalwire.connect` handshake,
|
|
158
|
+
* and starts the client-side ping loop. Safe to call again after a
|
|
159
|
+
* `disconnect()` to reconnect; the process-wide concurrent-connection limit
|
|
160
|
+
* is enforced here.
|
|
161
|
+
*
|
|
162
|
+
* @returns Resolves once the client is connected and authenticated.
|
|
163
|
+
* @throws {Error} When the process-wide connection limit is reached,
|
|
164
|
+
* authentication fails, or the WebSocket cannot be opened.
|
|
165
|
+
*/
|
|
166
|
+
connect(): Promise<void>;
|
|
167
|
+
/** Create a real WebSocket (uses dynamic import for ws). */
|
|
168
|
+
private _createWebSocket;
|
|
169
|
+
private _setupWsListeners;
|
|
170
|
+
/** Send signalwire.connect and wait for the response. */
|
|
171
|
+
private _authenticate;
|
|
172
|
+
/**
|
|
173
|
+
* Cleanly close the connection.
|
|
174
|
+
*
|
|
175
|
+
* Stops the ping loop, drops the WebSocket, rejects every pending request
|
|
176
|
+
* and dial with a `Connection closed` {@link RelayError}, and removes the
|
|
177
|
+
* client from the process-wide active set. Safe to call repeatedly.
|
|
178
|
+
*
|
|
179
|
+
* @returns Resolves once all resources have been released.
|
|
180
|
+
*/
|
|
181
|
+
disconnect(): Promise<void>;
|
|
182
|
+
/**
|
|
183
|
+
* Send a JSON-RPC request and await the response.
|
|
184
|
+
*
|
|
185
|
+
* This is the low-level escape hatch for calling RELAY methods that don't
|
|
186
|
+
* yet have a higher-level helper on this class. Queued if the client is
|
|
187
|
+
* currently disconnected; sent immediately otherwise.
|
|
188
|
+
*
|
|
189
|
+
* @param method - Fully-qualified JSON-RPC method name (e.g. `"calling.play"`).
|
|
190
|
+
* @param params - Method-specific params object.
|
|
191
|
+
* @returns The `result` field of the JSON-RPC response.
|
|
192
|
+
* @throws {RelayError} When the server returns a non-2xx code.
|
|
193
|
+
*/
|
|
194
|
+
execute(method: string, params: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
195
|
+
/**
|
|
196
|
+
* Initiate an outbound call.
|
|
197
|
+
*
|
|
198
|
+
* Accepts a "dial plan" — an outer array of serial groups, each containing
|
|
199
|
+
* an inner array of devices dialled in parallel. Resolves when any device
|
|
200
|
+
* answers; rejects if no device answers within `dialTimeout`.
|
|
201
|
+
*
|
|
202
|
+
* @param devices - Serial/parallel dial plan. `[[A], [B, C]]` dials A first,
|
|
203
|
+
* then B and C in parallel.
|
|
204
|
+
* @param options - Optional dial behaviour overrides.
|
|
205
|
+
* @param options.tag - Client-provided tag for event correlation.
|
|
206
|
+
* Auto-generated (UUID) when omitted.
|
|
207
|
+
* @param options.maxDuration - Maximum call duration in minutes.
|
|
208
|
+
* @param options.dialTimeout - Seconds to wait for the dial to complete.
|
|
209
|
+
* Defaults to `120`.
|
|
210
|
+
* @returns A {@link Call} representing the answered leg.
|
|
211
|
+
* @throws {Error} When the dial times out.
|
|
212
|
+
* @throws {RelayError} When the server rejects the dial request.
|
|
213
|
+
*/
|
|
214
|
+
dial(devices: Record<string, unknown>[][], options?: {
|
|
215
|
+
tag?: string;
|
|
216
|
+
maxDuration?: number;
|
|
217
|
+
/** Dial timeout in seconds (default 120). */
|
|
218
|
+
dialTimeout?: number;
|
|
219
|
+
}): Promise<Call>;
|
|
220
|
+
/**
|
|
221
|
+
* Send an outbound SMS / MMS message.
|
|
222
|
+
*
|
|
223
|
+
* The method returns as soon as the server has accepted the send; track the
|
|
224
|
+
* message's terminal state with {@link Message.wait} or the `onCompleted`
|
|
225
|
+
* callback.
|
|
226
|
+
*
|
|
227
|
+
* @param options - Send parameters.
|
|
228
|
+
* @param options.toNumber - Destination phone number in E.164 format.
|
|
229
|
+
* @param options.fromNumber - Sender phone number in E.164 format.
|
|
230
|
+
* @param options.context - Context for receiving state events. Defaults to
|
|
231
|
+
* the negotiated relay protocol.
|
|
232
|
+
* @param options.body - Text body of the message.
|
|
233
|
+
* @param options.media - List of media URLs for MMS.
|
|
234
|
+
* @param options.tags - Tags attached to the message for correlation.
|
|
235
|
+
* @param options.region - Origination region override.
|
|
236
|
+
* @param options.onCompleted - Optional callback fired when the message
|
|
237
|
+
* reaches a terminal state (delivered / failed / undelivered).
|
|
238
|
+
* @returns A {@link Message} tracking the outbound send.
|
|
239
|
+
* @throws {RelayError} When the server rejects the send request.
|
|
240
|
+
*/
|
|
241
|
+
sendMessage(options: {
|
|
242
|
+
toNumber: string;
|
|
243
|
+
fromNumber: string;
|
|
244
|
+
context?: string;
|
|
245
|
+
body?: string;
|
|
246
|
+
media?: string[];
|
|
247
|
+
tags?: string[];
|
|
248
|
+
region?: string;
|
|
249
|
+
onCompleted?: (event: any) => void | Promise<void>;
|
|
250
|
+
}): Promise<Message>;
|
|
251
|
+
/**
|
|
252
|
+
* Subscribe to additional RELAY contexts on an already-connected client.
|
|
253
|
+
*
|
|
254
|
+
* Inbound calls and messages on any of the listed contexts will be delivered
|
|
255
|
+
* to the `onCall` / `onMessage` handlers. A no-op when `contexts` is empty.
|
|
256
|
+
*
|
|
257
|
+
* @param contexts - Context names to subscribe to.
|
|
258
|
+
* @returns Resolves once the server has confirmed the subscription.
|
|
259
|
+
* @throws {RelayError} When the server rejects the subscribe request.
|
|
260
|
+
*/
|
|
261
|
+
receive(contexts: string[]): Promise<void>;
|
|
262
|
+
/**
|
|
263
|
+
* Unsubscribe from contexts previously passed to {@link receive} (or the
|
|
264
|
+
* constructor). A no-op when `contexts` is empty.
|
|
265
|
+
*
|
|
266
|
+
* @param contexts - Context names to unsubscribe from.
|
|
267
|
+
* @returns Resolves once the server has confirmed the unsubscribe.
|
|
268
|
+
* @throws {RelayError} When the server rejects the unsubscribe request.
|
|
269
|
+
*/
|
|
270
|
+
unreceive(contexts: string[]): Promise<void>;
|
|
271
|
+
/**
|
|
272
|
+
* Blocking entry point — connects and maintains the connection with
|
|
273
|
+
* auto-reconnect, returning only after a clean shutdown (Ctrl+C, SIGTERM,
|
|
274
|
+
* or {@link disconnect} from another scope).
|
|
275
|
+
*
|
|
276
|
+
* Installs `SIGINT` / `SIGTERM` handlers, so typically only one `RelayClient`
|
|
277
|
+
* per process should call `run()`.
|
|
278
|
+
*
|
|
279
|
+
* @returns Resolves once a shutdown has been requested and cleanup completes.
|
|
280
|
+
* @throws {Error} Only on unrecoverable startup failures — normal
|
|
281
|
+
* disconnects are handled internally by the reconnect loop.
|
|
282
|
+
*/
|
|
283
|
+
run(): Promise<void>;
|
|
284
|
+
private _sendRequest;
|
|
285
|
+
private _flushExecuteQueue;
|
|
286
|
+
private _clearPendingRequests;
|
|
287
|
+
private _handleMessage;
|
|
288
|
+
private _handleEvent;
|
|
289
|
+
private _handleInboundCall;
|
|
290
|
+
private _handleInboundMessage;
|
|
291
|
+
private _handleMessageState;
|
|
292
|
+
private _registerDialLeg;
|
|
293
|
+
private _handleDialEvent;
|
|
294
|
+
private _sendPong;
|
|
295
|
+
private _sendEventAck;
|
|
296
|
+
private _startPingLoop;
|
|
297
|
+
private _stopPingLoop;
|
|
298
|
+
private _resetServerPingTimeout;
|
|
299
|
+
private _cancelServerPingTimeout;
|
|
300
|
+
private _forceClose;
|
|
301
|
+
}
|
|
302
|
+
export {};
|