@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
|
@@ -1,11 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Protocol constants for the SignalWire RELAY calling API.
|
|
3
3
|
*/
|
|
4
|
-
|
|
5
4
|
// Protocol version
|
|
6
5
|
export const PROTOCOL_VERSION = { major: 2, minor: 0, revision: 0 };
|
|
7
6
|
export const AGENT_STRING = '@signalwire/sdk-typescript/2.0';
|
|
8
|
-
|
|
9
7
|
// JSON-RPC methods
|
|
10
8
|
export const METHOD_SIGNALWIRE_CONNECT = 'signalwire.connect';
|
|
11
9
|
export const METHOD_SIGNALWIRE_EVENT = 'signalwire.event';
|
|
@@ -13,25 +11,21 @@ export const METHOD_SIGNALWIRE_PING = 'signalwire.ping';
|
|
|
13
11
|
export const METHOD_SIGNALWIRE_DISCONNECT = 'signalwire.disconnect';
|
|
14
12
|
export const METHOD_SIGNALWIRE_RECEIVE = 'signalwire.receive';
|
|
15
13
|
export const METHOD_SIGNALWIRE_UNRECEIVE = 'signalwire.unreceive';
|
|
16
|
-
|
|
17
14
|
// Authorization state event
|
|
18
15
|
export const EVENT_AUTHORIZATION_STATE = 'signalwire.authorization.state';
|
|
19
|
-
|
|
20
16
|
// Call states
|
|
21
17
|
export const CALL_STATE_CREATED = 'created';
|
|
22
18
|
export const CALL_STATE_RINGING = 'ringing';
|
|
23
19
|
export const CALL_STATE_ANSWERED = 'answered';
|
|
24
20
|
export const CALL_STATE_ENDING = 'ending';
|
|
25
21
|
export const CALL_STATE_ENDED = 'ended';
|
|
26
|
-
|
|
27
22
|
export const CALL_STATES = [
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
]
|
|
34
|
-
|
|
23
|
+
CALL_STATE_CREATED,
|
|
24
|
+
CALL_STATE_RINGING,
|
|
25
|
+
CALL_STATE_ANSWERED,
|
|
26
|
+
CALL_STATE_ENDING,
|
|
27
|
+
CALL_STATE_ENDED,
|
|
28
|
+
];
|
|
35
29
|
// End reasons
|
|
36
30
|
export const END_REASON_HANGUP = 'hangup';
|
|
37
31
|
export const END_REASON_CANCEL = 'cancel';
|
|
@@ -42,13 +36,11 @@ export const END_REASON_ERROR = 'error';
|
|
|
42
36
|
export const END_REASON_ABANDONED = 'abandoned';
|
|
43
37
|
export const END_REASON_MAX_DURATION = 'max_duration';
|
|
44
38
|
export const END_REASON_NOT_FOUND = 'not_found';
|
|
45
|
-
|
|
46
39
|
// Connect states
|
|
47
40
|
export const CONNECT_STATE_CONNECTING = 'connecting';
|
|
48
41
|
export const CONNECT_STATE_CONNECTED = 'connected';
|
|
49
42
|
export const CONNECT_STATE_DISCONNECTED = 'disconnected';
|
|
50
43
|
export const CONNECT_STATE_FAILED = 'failed';
|
|
51
|
-
|
|
52
44
|
// Event types
|
|
53
45
|
export const EVENT_CALL_STATE = 'calling.call.state';
|
|
54
46
|
export const EVENT_CALL_RECEIVE = 'calling.call.receive';
|
|
@@ -71,11 +63,9 @@ export const EVENT_CALL_TRANSCRIBE = 'calling.call.transcribe';
|
|
|
71
63
|
export const EVENT_CALL_HOLD = 'calling.call.hold';
|
|
72
64
|
export const EVENT_CONFERENCE = 'calling.conference';
|
|
73
65
|
export const EVENT_CALLING_ERROR = 'calling.error';
|
|
74
|
-
|
|
75
66
|
// Messaging event types
|
|
76
67
|
export const EVENT_MESSAGING_RECEIVE = 'messaging.receive';
|
|
77
68
|
export const EVENT_MESSAGING_STATE = 'messaging.state';
|
|
78
|
-
|
|
79
69
|
// Message states
|
|
80
70
|
export const MESSAGE_STATE_QUEUED = 'queued';
|
|
81
71
|
export const MESSAGE_STATE_INITIATED = 'initiated';
|
|
@@ -84,49 +74,41 @@ export const MESSAGE_STATE_DELIVERED = 'delivered';
|
|
|
84
74
|
export const MESSAGE_STATE_UNDELIVERED = 'undelivered';
|
|
85
75
|
export const MESSAGE_STATE_FAILED = 'failed';
|
|
86
76
|
export const MESSAGE_STATE_RECEIVED = 'received';
|
|
87
|
-
|
|
88
77
|
export const MESSAGE_TERMINAL_STATES = [
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
]
|
|
93
|
-
|
|
78
|
+
MESSAGE_STATE_DELIVERED,
|
|
79
|
+
MESSAGE_STATE_UNDELIVERED,
|
|
80
|
+
MESSAGE_STATE_FAILED,
|
|
81
|
+
];
|
|
94
82
|
// Play states
|
|
95
83
|
export const PLAY_STATE_PLAYING = 'playing';
|
|
96
84
|
export const PLAY_STATE_PAUSED = 'paused';
|
|
97
85
|
export const PLAY_STATE_FINISHED = 'finished';
|
|
98
86
|
export const PLAY_STATE_ERROR = 'error';
|
|
99
|
-
|
|
100
87
|
// Record states
|
|
101
88
|
export const RECORD_STATE_RECORDING = 'recording';
|
|
102
89
|
export const RECORD_STATE_PAUSED = 'paused';
|
|
103
90
|
export const RECORD_STATE_FINISHED = 'finished';
|
|
104
91
|
export const RECORD_STATE_NO_INPUT = 'no_input';
|
|
105
|
-
|
|
106
92
|
// Detect types
|
|
107
93
|
export const DETECT_TYPE_MACHINE = 'machine';
|
|
108
94
|
export const DETECT_TYPE_FAX = 'fax';
|
|
109
95
|
export const DETECT_TYPE_DIGIT = 'digit';
|
|
110
|
-
|
|
111
96
|
// Join room states
|
|
112
97
|
export const ROOM_STATE_JOINING = 'joining';
|
|
113
98
|
export const ROOM_STATE_JOIN = 'join';
|
|
114
99
|
export const ROOM_STATE_LEAVING = 'leaving';
|
|
115
100
|
export const ROOM_STATE_LEAVE = 'leave';
|
|
116
|
-
|
|
117
101
|
// Reconnect settings
|
|
118
102
|
export const RECONNECT_MIN_DELAY = 1.0;
|
|
119
103
|
export const RECONNECT_MAX_DELAY = 30.0;
|
|
120
104
|
export const RECONNECT_BACKOFF_FACTOR = 2.0;
|
|
121
|
-
|
|
122
105
|
// Ping settings
|
|
123
106
|
export const CLIENT_PING_INTERVAL = 30_000; // 30s
|
|
124
107
|
export const CLIENT_PING_MAX_FAILURES = 3;
|
|
125
108
|
export const SERVER_PING_TIMEOUT = 15_000; // 15s
|
|
126
|
-
|
|
127
109
|
// Request settings
|
|
128
110
|
export const REQUEST_TIMEOUT = 30_000; // 30s
|
|
129
111
|
export const EXECUTE_QUEUE_MAX = 500;
|
|
130
|
-
|
|
131
112
|
// Default host
|
|
132
113
|
export const DEFAULT_RELAY_HOST = 'relay.signalwire.com';
|
|
114
|
+
//# sourceMappingURL=constants.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/relay/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,mBAAmB;AACnB,MAAM,CAAC,MAAM,gBAAgB,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;AACpE,MAAM,CAAC,MAAM,YAAY,GAAG,gCAAgC,CAAC;AAE7D,mBAAmB;AACnB,MAAM,CAAC,MAAM,yBAAyB,GAAG,oBAAoB,CAAC;AAC9D,MAAM,CAAC,MAAM,uBAAuB,GAAG,kBAAkB,CAAC;AAC1D,MAAM,CAAC,MAAM,sBAAsB,GAAG,iBAAiB,CAAC;AACxD,MAAM,CAAC,MAAM,4BAA4B,GAAG,uBAAuB,CAAC;AACpE,MAAM,CAAC,MAAM,yBAAyB,GAAG,oBAAoB,CAAC;AAC9D,MAAM,CAAC,MAAM,2BAA2B,GAAG,sBAAsB,CAAC;AAElE,4BAA4B;AAC5B,MAAM,CAAC,MAAM,yBAAyB,GAAG,gCAAgC,CAAC;AAE1E,cAAc;AACd,MAAM,CAAC,MAAM,kBAAkB,GAAG,SAAS,CAAC;AAC5C,MAAM,CAAC,MAAM,kBAAkB,GAAG,SAAS,CAAC;AAC5C,MAAM,CAAC,MAAM,mBAAmB,GAAG,UAAU,CAAC;AAC9C,MAAM,CAAC,MAAM,iBAAiB,GAAG,QAAQ,CAAC;AAC1C,MAAM,CAAC,MAAM,gBAAgB,GAAG,OAAO,CAAC;AAExC,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,kBAAkB;IAClB,kBAAkB;IAClB,mBAAmB;IACnB,iBAAiB;IACjB,gBAAgB;CACR,CAAC;AAEX,cAAc;AACd,MAAM,CAAC,MAAM,iBAAiB,GAAG,QAAQ,CAAC;AAC1C,MAAM,CAAC,MAAM,iBAAiB,GAAG,QAAQ,CAAC;AAC1C,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC;AACtC,MAAM,CAAC,MAAM,oBAAoB,GAAG,UAAU,CAAC;AAC/C,MAAM,CAAC,MAAM,kBAAkB,GAAG,SAAS,CAAC;AAC5C,MAAM,CAAC,MAAM,gBAAgB,GAAG,OAAO,CAAC;AACxC,MAAM,CAAC,MAAM,oBAAoB,GAAG,WAAW,CAAC;AAChD,MAAM,CAAC,MAAM,uBAAuB,GAAG,cAAc,CAAC;AACtD,MAAM,CAAC,MAAM,oBAAoB,GAAG,WAAW,CAAC;AAEhD,iBAAiB;AACjB,MAAM,CAAC,MAAM,wBAAwB,GAAG,YAAY,CAAC;AACrD,MAAM,CAAC,MAAM,uBAAuB,GAAG,WAAW,CAAC;AACnD,MAAM,CAAC,MAAM,0BAA0B,GAAG,cAAc,CAAC;AACzD,MAAM,CAAC,MAAM,oBAAoB,GAAG,QAAQ,CAAC;AAE7C,cAAc;AACd,MAAM,CAAC,MAAM,gBAAgB,GAAG,oBAAoB,CAAC;AACrD,MAAM,CAAC,MAAM,kBAAkB,GAAG,sBAAsB,CAAC;AACzD,MAAM,CAAC,MAAM,kBAAkB,GAAG,sBAAsB,CAAC;AACzD,MAAM,CAAC,MAAM,eAAe,GAAG,mBAAmB,CAAC;AACnD,MAAM,CAAC,MAAM,kBAAkB,GAAG,sBAAsB,CAAC;AACzD,MAAM,CAAC,MAAM,iBAAiB,GAAG,qBAAqB,CAAC;AACvD,MAAM,CAAC,MAAM,iBAAiB,GAAG,qBAAqB,CAAC;AACvD,MAAM,CAAC,MAAM,cAAc,GAAG,kBAAkB,CAAC;AACjD,MAAM,CAAC,MAAM,cAAc,GAAG,kBAAkB,CAAC;AACjD,MAAM,CAAC,MAAM,sBAAsB,GAAG,0BAA0B,CAAC;AACjE,MAAM,CAAC,MAAM,eAAe,GAAG,mBAAmB,CAAC;AACnD,MAAM,CAAC,MAAM,gBAAgB,GAAG,oBAAoB,CAAC;AACrD,MAAM,CAAC,MAAM,kBAAkB,GAAG,sBAAsB,CAAC;AACzD,MAAM,CAAC,MAAM,cAAc,GAAG,kBAAkB,CAAC;AACjD,MAAM,CAAC,MAAM,gBAAgB,GAAG,oBAAoB,CAAC;AACrD,MAAM,CAAC,MAAM,iBAAiB,GAAG,qBAAqB,CAAC;AACvD,MAAM,CAAC,MAAM,eAAe,GAAG,mBAAmB,CAAC;AACnD,MAAM,CAAC,MAAM,qBAAqB,GAAG,yBAAyB,CAAC;AAC/D,MAAM,CAAC,MAAM,eAAe,GAAG,mBAAmB,CAAC;AACnD,MAAM,CAAC,MAAM,gBAAgB,GAAG,oBAAoB,CAAC;AACrD,MAAM,CAAC,MAAM,mBAAmB,GAAG,eAAe,CAAC;AAEnD,wBAAwB;AACxB,MAAM,CAAC,MAAM,uBAAuB,GAAG,mBAAmB,CAAC;AAC3D,MAAM,CAAC,MAAM,qBAAqB,GAAG,iBAAiB,CAAC;AAEvD,iBAAiB;AACjB,MAAM,CAAC,MAAM,oBAAoB,GAAG,QAAQ,CAAC;AAC7C,MAAM,CAAC,MAAM,uBAAuB,GAAG,WAAW,CAAC;AACnD,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC;AACzC,MAAM,CAAC,MAAM,uBAAuB,GAAG,WAAW,CAAC;AACnD,MAAM,CAAC,MAAM,yBAAyB,GAAG,aAAa,CAAC;AACvD,MAAM,CAAC,MAAM,oBAAoB,GAAG,QAAQ,CAAC;AAC7C,MAAM,CAAC,MAAM,sBAAsB,GAAG,UAAU,CAAC;AAEjD,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,uBAAuB;IACvB,yBAAyB;IACzB,oBAAoB;CACZ,CAAC;AAEX,cAAc;AACd,MAAM,CAAC,MAAM,kBAAkB,GAAG,SAAS,CAAC;AAC5C,MAAM,CAAC,MAAM,iBAAiB,GAAG,QAAQ,CAAC;AAC1C,MAAM,CAAC,MAAM,mBAAmB,GAAG,UAAU,CAAC;AAC9C,MAAM,CAAC,MAAM,gBAAgB,GAAG,OAAO,CAAC;AAExC,gBAAgB;AAChB,MAAM,CAAC,MAAM,sBAAsB,GAAG,WAAW,CAAC;AAClD,MAAM,CAAC,MAAM,mBAAmB,GAAG,QAAQ,CAAC;AAC5C,MAAM,CAAC,MAAM,qBAAqB,GAAG,UAAU,CAAC;AAChD,MAAM,CAAC,MAAM,qBAAqB,GAAG,UAAU,CAAC;AAEhD,eAAe;AACf,MAAM,CAAC,MAAM,mBAAmB,GAAG,SAAS,CAAC;AAC7C,MAAM,CAAC,MAAM,eAAe,GAAG,KAAK,CAAC;AACrC,MAAM,CAAC,MAAM,iBAAiB,GAAG,OAAO,CAAC;AAEzC,mBAAmB;AACnB,MAAM,CAAC,MAAM,kBAAkB,GAAG,SAAS,CAAC;AAC5C,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC;AACtC,MAAM,CAAC,MAAM,kBAAkB,GAAG,SAAS,CAAC;AAC5C,MAAM,CAAC,MAAM,gBAAgB,GAAG,OAAO,CAAC;AAExC,qBAAqB;AACrB,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAAG,CAAC;AACvC,MAAM,CAAC,MAAM,mBAAmB,GAAG,IAAI,CAAC;AACxC,MAAM,CAAC,MAAM,wBAAwB,GAAG,GAAG,CAAC;AAE5C,gBAAgB;AAChB,MAAM,CAAC,MAAM,oBAAoB,GAAG,MAAM,CAAC,CAAC,MAAM;AAClD,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC;AAC1C,MAAM,CAAC,MAAM,mBAAmB,GAAG,MAAM,CAAC,CAAC,MAAM;AAEjD,mBAAmB;AACnB,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC,CAAC,MAAM;AAC7C,MAAM,CAAC,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAErC,eAAe;AACf,MAAM,CAAC,MAAM,kBAAkB,GAAG,sBAAsB,CAAC"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* SignalWire RELAY client — real-time call control over WebSocket.
|
|
3
|
+
*/
|
|
4
|
+
export { RelayClient } from './RelayClient.js';
|
|
5
|
+
export { RelayError } from './RelayError.js';
|
|
6
|
+
export { Call } from './Call.js';
|
|
7
|
+
export type { RelayClientLike } from './Call.js';
|
|
8
|
+
export { Action, PlayAction, RecordAction, DetectAction, CollectAction, StandaloneCollectAction, FaxAction, TapAction, StreamAction, PayAction, TranscribeAction, AIAction, } from './Action.js';
|
|
9
|
+
export type { CallLike } from './Action.js';
|
|
10
|
+
export { Message } from './Message.js';
|
|
11
|
+
export { RelayEvent, CallStateEvent, CallReceiveEvent, PlayEvent, RecordEvent, CollectEvent, ConnectEvent, DetectEvent, FaxEvent, TapEvent, StreamEvent, SendDigitsEvent, DialEvent, ReferEvent, DenoiseEvent, PayEvent, QueueEvent, EchoEvent, TranscribeEvent, HoldEvent, ConferenceEvent, CallingErrorEvent, MessageReceiveEvent, MessageStateEvent, parseEvent, EVENT_CLASS_MAP, } from './RelayEvent.js';
|
|
12
|
+
export type { EventClass } from './RelayEvent.js';
|
|
13
|
+
export { createDeferred, withTimeout } from './Deferred.js';
|
|
14
|
+
export type { Deferred } from './Deferred.js';
|
|
15
|
+
export { CALL_STATE_CREATED, CALL_STATE_RINGING, CALL_STATE_ANSWERED, CALL_STATE_ENDING, CALL_STATE_ENDED, CONNECT_STATE_CONNECTING, CONNECT_STATE_CONNECTED, CONNECT_STATE_DISCONNECTED, CONNECT_STATE_FAILED, EVENT_CALL_STATE, EVENT_CALL_RECEIVE, EVENT_CALL_PLAY, EVENT_CALL_RECORD, EVENT_CALL_COLLECT, EVENT_CALL_CONNECT, EVENT_CALL_DETECT, EVENT_CALL_FAX, EVENT_CALL_TAP, EVENT_CALL_STREAM, EVENT_CALL_SEND_DIGITS, EVENT_CALL_DIAL, EVENT_CALL_REFER, EVENT_CALL_DENOISE, EVENT_CALL_PAY, EVENT_CALL_QUEUE, EVENT_CALL_ECHO, EVENT_CALL_TRANSCRIBE, EVENT_CALL_HOLD, EVENT_CONFERENCE, EVENT_CALLING_ERROR, EVENT_MESSAGING_RECEIVE, EVENT_MESSAGING_STATE, MESSAGE_STATE_QUEUED, MESSAGE_STATE_INITIATED, MESSAGE_STATE_SENT, MESSAGE_STATE_DELIVERED, MESSAGE_STATE_UNDELIVERED, MESSAGE_STATE_FAILED, MESSAGE_STATE_RECEIVED, } from './constants.js';
|
|
16
|
+
export type { RelayClientOptions, CallHandler, MessageHandler, EventHandler, CompletedCallback, Device, PhoneDevice, SipDevice, DialOptions, SendMessageOptions, PlayItem, CollectConfig, } from './types.js';
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* SignalWire RELAY client — real-time call control over WebSocket.
|
|
3
|
+
*/
|
|
4
|
+
// Client
|
|
5
|
+
export { RelayClient } from './RelayClient.js';
|
|
6
|
+
export { RelayError } from './RelayError.js';
|
|
7
|
+
// Call + Actions
|
|
8
|
+
export { Call } from './Call.js';
|
|
9
|
+
export { Action, PlayAction, RecordAction, DetectAction, CollectAction, StandaloneCollectAction, FaxAction, TapAction, StreamAction, PayAction, TranscribeAction, AIAction, } from './Action.js';
|
|
10
|
+
// Message
|
|
11
|
+
export { Message } from './Message.js';
|
|
12
|
+
// Events
|
|
13
|
+
export { RelayEvent, CallStateEvent, CallReceiveEvent, PlayEvent, RecordEvent, CollectEvent, ConnectEvent, DetectEvent, FaxEvent, TapEvent, StreamEvent, SendDigitsEvent, DialEvent, ReferEvent, DenoiseEvent, PayEvent, QueueEvent, EchoEvent, TranscribeEvent, HoldEvent, ConferenceEvent, CallingErrorEvent, MessageReceiveEvent, MessageStateEvent, parseEvent, EVENT_CLASS_MAP, } from './RelayEvent.js';
|
|
14
|
+
// Deferred utility
|
|
15
|
+
export { createDeferred, withTimeout } from './Deferred.js';
|
|
16
|
+
// Constants
|
|
17
|
+
export { CALL_STATE_CREATED, CALL_STATE_RINGING, CALL_STATE_ANSWERED, CALL_STATE_ENDING, CALL_STATE_ENDED, CONNECT_STATE_CONNECTING, CONNECT_STATE_CONNECTED, CONNECT_STATE_DISCONNECTED, CONNECT_STATE_FAILED, EVENT_CALL_STATE, EVENT_CALL_RECEIVE, EVENT_CALL_PLAY, EVENT_CALL_RECORD, EVENT_CALL_COLLECT, EVENT_CALL_CONNECT, EVENT_CALL_DETECT, EVENT_CALL_FAX, EVENT_CALL_TAP, EVENT_CALL_STREAM, EVENT_CALL_SEND_DIGITS, EVENT_CALL_DIAL, EVENT_CALL_REFER, EVENT_CALL_DENOISE, EVENT_CALL_PAY, EVENT_CALL_QUEUE, EVENT_CALL_ECHO, EVENT_CALL_TRANSCRIBE, EVENT_CALL_HOLD, EVENT_CONFERENCE, EVENT_CALLING_ERROR, EVENT_MESSAGING_RECEIVE, EVENT_MESSAGING_STATE, MESSAGE_STATE_QUEUED, MESSAGE_STATE_INITIATED, MESSAGE_STATE_SENT, MESSAGE_STATE_DELIVERED, MESSAGE_STATE_UNDELIVERED, MESSAGE_STATE_FAILED, MESSAGE_STATE_RECEIVED, } from './constants.js';
|
|
18
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/relay/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,SAAS;AACT,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,iBAAiB;AACjB,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,OAAO,EACL,MAAM,EACN,UAAU,EACV,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,uBAAuB,EACvB,SAAS,EACT,SAAS,EACT,YAAY,EACZ,SAAS,EACT,gBAAgB,EAChB,QAAQ,GACT,MAAM,aAAa,CAAC;AAGrB,UAAU;AACV,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC,SAAS;AACT,OAAO,EACL,UAAU,EACV,cAAc,EACd,gBAAgB,EAChB,SAAS,EACT,WAAW,EACX,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,QAAQ,EACR,QAAQ,EACR,WAAW,EACX,eAAe,EACf,SAAS,EACT,UAAU,EACV,YAAY,EACZ,QAAQ,EACR,UAAU,EACV,SAAS,EACT,eAAe,EACf,SAAS,EACT,eAAe,EACf,iBAAiB,EACjB,mBAAmB,EACnB,iBAAiB,EACjB,UAAU,EACV,eAAe,GAChB,MAAM,iBAAiB,CAAC;AAGzB,mBAAmB;AACnB,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAG5D,YAAY;AACZ,OAAO,EACL,kBAAkB,EAClB,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,EACjB,gBAAgB,EAChB,wBAAwB,EACxB,uBAAuB,EACvB,0BAA0B,EAC1B,oBAAoB,EACpB,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,cAAc,EACd,cAAc,EACd,iBAAiB,EACjB,sBAAsB,EACtB,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,gBAAgB,EAChB,eAAe,EACf,qBAAqB,EACrB,eAAe,EACf,gBAAgB,EAChB,mBAAmB,EACnB,uBAAuB,EACvB,qBAAqB,EACrB,oBAAoB,EACpB,uBAAuB,EACvB,kBAAkB,EAClB,uBAAuB,EACvB,yBAAyB,EACzB,oBAAoB,EACpB,sBAAsB,GACvB,MAAM,gBAAgB,CAAC"}
|
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Shared interfaces and type aliases for the RELAY client.
|
|
3
|
+
*/
|
|
4
|
+
import type { Call } from './Call.js';
|
|
5
|
+
import type { Message } from './Message.js';
|
|
6
|
+
import type { RelayEvent } from './RelayEvent.js';
|
|
7
|
+
/** Options for constructing a RelayClient. */
|
|
8
|
+
export interface RelayClientOptions {
|
|
9
|
+
/** SignalWire project ID. Defaults to env SIGNALWIRE_PROJECT_ID. */
|
|
10
|
+
project?: string;
|
|
11
|
+
/** SignalWire API token. Defaults to env SIGNALWIRE_API_TOKEN. */
|
|
12
|
+
token?: string;
|
|
13
|
+
/** JWT token for authentication. Defaults to env SIGNALWIRE_JWT_TOKEN. */
|
|
14
|
+
jwtToken?: string;
|
|
15
|
+
/** RELAY host. Defaults to relay.signalwire.com. */
|
|
16
|
+
host?: string;
|
|
17
|
+
/** Contexts (topics) to receive inbound calls/messages on. */
|
|
18
|
+
contexts?: string[];
|
|
19
|
+
/** Maximum number of concurrent active calls. Defaults to env RELAY_MAX_ACTIVE_CALLS or 1000. */
|
|
20
|
+
maxActiveCalls?: number;
|
|
21
|
+
}
|
|
22
|
+
/** JSON-RPC 2.0 request. */
|
|
23
|
+
export interface JsonRpcRequest {
|
|
24
|
+
jsonrpc: '2.0';
|
|
25
|
+
id: string;
|
|
26
|
+
method: string;
|
|
27
|
+
params: Record<string, unknown>;
|
|
28
|
+
}
|
|
29
|
+
/** JSON-RPC 2.0 response (success). */
|
|
30
|
+
export interface JsonRpcResponse {
|
|
31
|
+
jsonrpc: '2.0';
|
|
32
|
+
id: string;
|
|
33
|
+
result?: Record<string, unknown>;
|
|
34
|
+
error?: JsonRpcError;
|
|
35
|
+
}
|
|
36
|
+
/** JSON-RPC 2.0 error object. */
|
|
37
|
+
export interface JsonRpcError {
|
|
38
|
+
code: number;
|
|
39
|
+
message: string;
|
|
40
|
+
data?: unknown;
|
|
41
|
+
}
|
|
42
|
+
/** Handler for inbound calls. */
|
|
43
|
+
export type CallHandler = (call: Call) => void | Promise<void>;
|
|
44
|
+
/** Handler for inbound messages. */
|
|
45
|
+
export type MessageHandler = (message: Message) => void | Promise<void>;
|
|
46
|
+
/** Handler for relay events. */
|
|
47
|
+
export type EventHandler = (event: RelayEvent) => void | Promise<void>;
|
|
48
|
+
/** Callback when an action or message completes. */
|
|
49
|
+
export type CompletedCallback = (event: RelayEvent) => void | Promise<void>;
|
|
50
|
+
/** Phone device specification for dial/connect. */
|
|
51
|
+
export interface PhoneDevice {
|
|
52
|
+
type: 'phone';
|
|
53
|
+
to: string;
|
|
54
|
+
from: string;
|
|
55
|
+
timeout?: number;
|
|
56
|
+
max_duration?: number;
|
|
57
|
+
codecs?: string[];
|
|
58
|
+
headers?: Record<string, string>[];
|
|
59
|
+
}
|
|
60
|
+
/** SIP device specification for dial/connect. */
|
|
61
|
+
export interface SipDevice {
|
|
62
|
+
type: 'sip';
|
|
63
|
+
to: string;
|
|
64
|
+
from: string;
|
|
65
|
+
timeout?: number;
|
|
66
|
+
max_duration?: number;
|
|
67
|
+
codecs?: string[];
|
|
68
|
+
headers?: Record<string, string>[];
|
|
69
|
+
}
|
|
70
|
+
/** Any device specification. */
|
|
71
|
+
export type Device = PhoneDevice | SipDevice | Record<string, unknown>;
|
|
72
|
+
/** Options for the dial() method. */
|
|
73
|
+
export interface DialOptions {
|
|
74
|
+
/** Caller ID / from number. */
|
|
75
|
+
from?: string;
|
|
76
|
+
/** Timeout in seconds for the dial. */
|
|
77
|
+
timeout?: number;
|
|
78
|
+
/** Maximum call duration in seconds. */
|
|
79
|
+
maxDuration?: number;
|
|
80
|
+
}
|
|
81
|
+
/** Options for the sendMessage() method. */
|
|
82
|
+
export interface SendMessageOptions {
|
|
83
|
+
/** Destination phone number in E.164 format. */
|
|
84
|
+
toNumber: string;
|
|
85
|
+
/** Sender phone number in E.164 format. */
|
|
86
|
+
fromNumber: string;
|
|
87
|
+
/** Message body text. */
|
|
88
|
+
body?: string;
|
|
89
|
+
/** Media URLs for MMS. */
|
|
90
|
+
media?: string[];
|
|
91
|
+
/** Context for the message. */
|
|
92
|
+
context?: string;
|
|
93
|
+
/** Tags for the message. */
|
|
94
|
+
tags?: string[];
|
|
95
|
+
}
|
|
96
|
+
/** Play item: TTS, audio URL, ringtone, or silence. */
|
|
97
|
+
export type PlayItem = {
|
|
98
|
+
type: 'tts';
|
|
99
|
+
text: string;
|
|
100
|
+
language?: string;
|
|
101
|
+
gender?: string;
|
|
102
|
+
} | {
|
|
103
|
+
type: 'audio';
|
|
104
|
+
url: string;
|
|
105
|
+
} | {
|
|
106
|
+
type: 'ringtone';
|
|
107
|
+
name: string;
|
|
108
|
+
duration?: number;
|
|
109
|
+
} | {
|
|
110
|
+
type: 'silence';
|
|
111
|
+
duration: number;
|
|
112
|
+
} | Record<string, unknown>;
|
|
113
|
+
/** Collect input configuration. */
|
|
114
|
+
export interface CollectConfig {
|
|
115
|
+
/** Collect digits. */
|
|
116
|
+
digits?: {
|
|
117
|
+
max: number;
|
|
118
|
+
digit_timeout?: number;
|
|
119
|
+
terminators?: string;
|
|
120
|
+
};
|
|
121
|
+
/** Collect speech. */
|
|
122
|
+
speech?: {
|
|
123
|
+
end_silence_timeout?: number;
|
|
124
|
+
speech_timeout?: number;
|
|
125
|
+
language?: string;
|
|
126
|
+
hints?: string[];
|
|
127
|
+
model?: string;
|
|
128
|
+
};
|
|
129
|
+
/** Initial timeout in seconds. */
|
|
130
|
+
initial_timeout?: number;
|
|
131
|
+
/** Partial results? */
|
|
132
|
+
partial_results?: boolean;
|
|
133
|
+
/** Continuous mode? */
|
|
134
|
+
continuous?: boolean;
|
|
135
|
+
}
|
|
136
|
+
/** Queued request waiting for reconnection. */
|
|
137
|
+
export interface QueuedRequest {
|
|
138
|
+
method: string;
|
|
139
|
+
params: Record<string, unknown>;
|
|
140
|
+
resolve: (value: Record<string, unknown>) => void;
|
|
141
|
+
reject: (reason?: unknown) => void;
|
|
142
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/relay/types.ts"],"names":[],"mappings":"AAAA;;GAEG"}
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* HttpClient — fetch-based HTTP with Basic Auth.
|
|
3
|
+
*
|
|
4
|
+
* All methods return parsed JSON. Throws RestError on non-2xx responses.
|
|
5
|
+
* Returns {} on 204 No Content.
|
|
6
|
+
*/
|
|
7
|
+
import type { HttpClientOptions, QueryParams } from './types.js';
|
|
8
|
+
/**
|
|
9
|
+
* Low-level HTTP client used by every REST namespace resource.
|
|
10
|
+
*
|
|
11
|
+
* Handles Basic Auth, JSON encoding/decoding, and error normalisation
|
|
12
|
+
* ({@link RestError} on non-2xx). Normally you do not instantiate this
|
|
13
|
+
* directly — construct a {@link RestClient} instead.
|
|
14
|
+
*/
|
|
15
|
+
export declare class HttpClient {
|
|
16
|
+
/** Fully-qualified base URL (no trailing slash). */
|
|
17
|
+
readonly baseUrl: string;
|
|
18
|
+
private readonly _authHeader;
|
|
19
|
+
private readonly _fetch;
|
|
20
|
+
/**
|
|
21
|
+
* Build a new HTTP client.
|
|
22
|
+
*
|
|
23
|
+
* @param options - Connection options. Either `host` (bare hostname;
|
|
24
|
+
* `https://` is prepended automatically) or `baseUrl` (fully-qualified)
|
|
25
|
+
* must be provided along with `project` + `token`.
|
|
26
|
+
* @throws {Error} When neither `host` nor `baseUrl` is supplied.
|
|
27
|
+
*/
|
|
28
|
+
constructor(options: HttpClientOptions);
|
|
29
|
+
private _request;
|
|
30
|
+
/**
|
|
31
|
+
* Perform an authenticated HTTP GET and return the parsed JSON response.
|
|
32
|
+
*
|
|
33
|
+
* @typeParam T - Expected response body type.
|
|
34
|
+
* @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
|
|
35
|
+
* @param params - Optional query parameters; `undefined` values are skipped.
|
|
36
|
+
* @returns The parsed JSON body, or `{}` on `204 No Content`.
|
|
37
|
+
* @throws {RestError} On any non-2xx HTTP response.
|
|
38
|
+
*/
|
|
39
|
+
get<T = any>(path: string, params?: QueryParams): Promise<T>;
|
|
40
|
+
/**
|
|
41
|
+
* Perform an authenticated HTTP POST and return the parsed JSON response.
|
|
42
|
+
*
|
|
43
|
+
* @typeParam T - Expected response body type.
|
|
44
|
+
* @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
|
|
45
|
+
* @param body - JSON-serialisable request body. Omit to send no body.
|
|
46
|
+
* @param params - Optional query parameters appended to the URL.
|
|
47
|
+
* @returns The parsed JSON body, or `{}` on `204 No Content`.
|
|
48
|
+
* @throws {RestError} On any non-2xx HTTP response.
|
|
49
|
+
*/
|
|
50
|
+
post<T = any>(path: string, body?: any, params?: QueryParams): Promise<T>;
|
|
51
|
+
/**
|
|
52
|
+
* Perform an authenticated HTTP PUT and return the parsed JSON response.
|
|
53
|
+
*
|
|
54
|
+
* @typeParam T - Expected response body type.
|
|
55
|
+
* @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
|
|
56
|
+
* @param body - JSON-serialisable request body.
|
|
57
|
+
* @returns The parsed JSON body, or `{}` on `204 No Content`.
|
|
58
|
+
* @throws {RestError} On any non-2xx HTTP response.
|
|
59
|
+
*/
|
|
60
|
+
put<T = any>(path: string, body?: any): Promise<T>;
|
|
61
|
+
/**
|
|
62
|
+
* Perform an authenticated HTTP PATCH and return the parsed JSON response.
|
|
63
|
+
*
|
|
64
|
+
* @typeParam T - Expected response body type.
|
|
65
|
+
* @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
|
|
66
|
+
* @param body - JSON-serialisable partial request body.
|
|
67
|
+
* @returns The parsed JSON body, or `{}` on `204 No Content`.
|
|
68
|
+
* @throws {RestError} On any non-2xx HTTP response.
|
|
69
|
+
*/
|
|
70
|
+
patch<T = any>(path: string, body?: any): Promise<T>;
|
|
71
|
+
/**
|
|
72
|
+
* Perform an authenticated HTTP DELETE and return the parsed JSON response.
|
|
73
|
+
*
|
|
74
|
+
* @typeParam T - Expected response body type.
|
|
75
|
+
* @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
|
|
76
|
+
* @returns The parsed JSON body, or `{}` on `204 No Content`.
|
|
77
|
+
* @throws {RestError} On any non-2xx HTTP response.
|
|
78
|
+
*/
|
|
79
|
+
delete<T = any>(path: string): Promise<T>;
|
|
80
|
+
}
|
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* HttpClient — fetch-based HTTP with Basic Auth.
|
|
3
|
+
*
|
|
4
|
+
* All methods return parsed JSON. Throws RestError on non-2xx responses.
|
|
5
|
+
* Returns {} on 204 No Content.
|
|
6
|
+
*/
|
|
7
|
+
/* eslint-disable @typescript-eslint/no-explicit-any */
|
|
8
|
+
import { getLogger } from '../Logger.js';
|
|
9
|
+
import { RestError } from './RestError.js';
|
|
10
|
+
const logger = getLogger('rest_client');
|
|
11
|
+
/**
|
|
12
|
+
* Low-level HTTP client used by every REST namespace resource.
|
|
13
|
+
*
|
|
14
|
+
* Handles Basic Auth, JSON encoding/decoding, and error normalisation
|
|
15
|
+
* ({@link RestError} on non-2xx). Normally you do not instantiate this
|
|
16
|
+
* directly — construct a {@link RestClient} instead.
|
|
17
|
+
*/
|
|
18
|
+
export class HttpClient {
|
|
19
|
+
/** Fully-qualified base URL (no trailing slash). */
|
|
20
|
+
baseUrl;
|
|
21
|
+
_authHeader;
|
|
22
|
+
_fetch;
|
|
23
|
+
/**
|
|
24
|
+
* Build a new HTTP client.
|
|
25
|
+
*
|
|
26
|
+
* @param options - Connection options. Either `host` (bare hostname;
|
|
27
|
+
* `https://` is prepended automatically) or `baseUrl` (fully-qualified)
|
|
28
|
+
* must be provided along with `project` + `token`.
|
|
29
|
+
* @throws {Error} When neither `host` nor `baseUrl` is supplied.
|
|
30
|
+
*/
|
|
31
|
+
constructor(options) {
|
|
32
|
+
if (!options.host && !options.baseUrl) {
|
|
33
|
+
throw new Error('HttpClientOptions requires either "host" or "baseUrl".');
|
|
34
|
+
}
|
|
35
|
+
// host takes precedence (matches Python's HttpClient(project, token, host) convention
|
|
36
|
+
// where a bare hostname is expected and https:// is prepended automatically).
|
|
37
|
+
const rawUrl = options.host ? `https://${options.host}` : options.baseUrl;
|
|
38
|
+
this.baseUrl = rawUrl.replace(/\/+$/, '');
|
|
39
|
+
this._authHeader = 'Basic ' + Buffer.from(`${options.project}:${options.token}`).toString('base64');
|
|
40
|
+
this._fetch = options.fetchImpl ?? globalThis.fetch;
|
|
41
|
+
}
|
|
42
|
+
async _request(method, path, body, params) {
|
|
43
|
+
let url = path.startsWith('http') ? path : `${this.baseUrl}${path}`;
|
|
44
|
+
if (params) {
|
|
45
|
+
const qs = new URLSearchParams();
|
|
46
|
+
for (const [k, v] of Object.entries(params)) {
|
|
47
|
+
if (v !== undefined)
|
|
48
|
+
qs.set(k, String(v));
|
|
49
|
+
}
|
|
50
|
+
const qsStr = qs.toString();
|
|
51
|
+
if (qsStr)
|
|
52
|
+
url += (url.includes('?') ? '&' : '?') + qsStr;
|
|
53
|
+
}
|
|
54
|
+
logger.debug(`${method} ${url}`);
|
|
55
|
+
const headers = {
|
|
56
|
+
'Authorization': this._authHeader,
|
|
57
|
+
'Accept': 'application/json',
|
|
58
|
+
'User-Agent': '@signalwire/sdk-ts/2.0.0',
|
|
59
|
+
};
|
|
60
|
+
if (body !== undefined) {
|
|
61
|
+
headers['Content-Type'] = 'application/json';
|
|
62
|
+
}
|
|
63
|
+
const resp = await this._fetch(url, {
|
|
64
|
+
method,
|
|
65
|
+
headers,
|
|
66
|
+
body: body !== undefined ? JSON.stringify(body) : undefined,
|
|
67
|
+
});
|
|
68
|
+
if (!resp.ok) {
|
|
69
|
+
const text = await resp.text();
|
|
70
|
+
let errBody = text;
|
|
71
|
+
try {
|
|
72
|
+
errBody = JSON.parse(text);
|
|
73
|
+
}
|
|
74
|
+
catch {
|
|
75
|
+
// Response was not valid JSON — keep as plain string.
|
|
76
|
+
}
|
|
77
|
+
throw new RestError(resp.status, errBody, url, method);
|
|
78
|
+
}
|
|
79
|
+
if (resp.status === 204) {
|
|
80
|
+
return {};
|
|
81
|
+
}
|
|
82
|
+
const text = await resp.text();
|
|
83
|
+
if (!text)
|
|
84
|
+
return {};
|
|
85
|
+
return JSON.parse(text);
|
|
86
|
+
}
|
|
87
|
+
/**
|
|
88
|
+
* Perform an authenticated HTTP GET and return the parsed JSON response.
|
|
89
|
+
*
|
|
90
|
+
* @typeParam T - Expected response body type.
|
|
91
|
+
* @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
|
|
92
|
+
* @param params - Optional query parameters; `undefined` values are skipped.
|
|
93
|
+
* @returns The parsed JSON body, or `{}` on `204 No Content`.
|
|
94
|
+
* @throws {RestError} On any non-2xx HTTP response.
|
|
95
|
+
*/
|
|
96
|
+
async get(path, params) {
|
|
97
|
+
return this._request('GET', path, undefined, params);
|
|
98
|
+
}
|
|
99
|
+
/**
|
|
100
|
+
* Perform an authenticated HTTP POST and return the parsed JSON response.
|
|
101
|
+
*
|
|
102
|
+
* @typeParam T - Expected response body type.
|
|
103
|
+
* @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
|
|
104
|
+
* @param body - JSON-serialisable request body. Omit to send no body.
|
|
105
|
+
* @param params - Optional query parameters appended to the URL.
|
|
106
|
+
* @returns The parsed JSON body, or `{}` on `204 No Content`.
|
|
107
|
+
* @throws {RestError} On any non-2xx HTTP response.
|
|
108
|
+
*/
|
|
109
|
+
async post(path, body, params) {
|
|
110
|
+
return this._request('POST', path, body, params);
|
|
111
|
+
}
|
|
112
|
+
/**
|
|
113
|
+
* Perform an authenticated HTTP PUT and return the parsed JSON response.
|
|
114
|
+
*
|
|
115
|
+
* @typeParam T - Expected response body type.
|
|
116
|
+
* @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
|
|
117
|
+
* @param body - JSON-serialisable request body.
|
|
118
|
+
* @returns The parsed JSON body, or `{}` on `204 No Content`.
|
|
119
|
+
* @throws {RestError} On any non-2xx HTTP response.
|
|
120
|
+
*/
|
|
121
|
+
async put(path, body) {
|
|
122
|
+
return this._request('PUT', path, body);
|
|
123
|
+
}
|
|
124
|
+
/**
|
|
125
|
+
* Perform an authenticated HTTP PATCH and return the parsed JSON response.
|
|
126
|
+
*
|
|
127
|
+
* @typeParam T - Expected response body type.
|
|
128
|
+
* @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
|
|
129
|
+
* @param body - JSON-serialisable partial request body.
|
|
130
|
+
* @returns The parsed JSON body, or `{}` on `204 No Content`.
|
|
131
|
+
* @throws {RestError} On any non-2xx HTTP response.
|
|
132
|
+
*/
|
|
133
|
+
async patch(path, body) {
|
|
134
|
+
return this._request('PATCH', path, body);
|
|
135
|
+
}
|
|
136
|
+
/**
|
|
137
|
+
* Perform an authenticated HTTP DELETE and return the parsed JSON response.
|
|
138
|
+
*
|
|
139
|
+
* @typeParam T - Expected response body type.
|
|
140
|
+
* @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
|
|
141
|
+
* @returns The parsed JSON body, or `{}` on `204 No Content`.
|
|
142
|
+
* @throws {RestError} On any non-2xx HTTP response.
|
|
143
|
+
*/
|
|
144
|
+
async delete(path) {
|
|
145
|
+
return this._request('DELETE', path);
|
|
146
|
+
}
|
|
147
|
+
}
|
|
148
|
+
//# sourceMappingURL=HttpClient.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"HttpClient.js","sourceRoot":"","sources":["../../src/rest/HttpClient.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,uDAAuD;AAEvD,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAG3C,MAAM,MAAM,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC;AAExC;;;;;;GAMG;AACH,MAAM,OAAO,UAAU;IACrB,oDAAoD;IAC3C,OAAO,CAAS;IACR,WAAW,CAAS;IACpB,MAAM,CAA0B;IAEjD;;;;;;;OAOG;IACH,YAAY,OAA0B;QACpC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;QAC5E,CAAC;QAED,sFAAsF;QACtF,8EAA8E;QAC9E,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,OAAQ,CAAC;QAC3E,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAE1C,IAAI,CAAC,WAAW,GAAG,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACpG,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,SAAS,IAAI,UAAU,CAAC,KAAK,CAAC;IACtD,CAAC;IAEO,KAAK,CAAC,QAAQ,CAAU,MAAc,EAAE,IAAY,EAAE,IAAU,EAAE,MAAoB;QAC5F,IAAI,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,CAAC;QAEpE,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,EAAE,GAAG,IAAI,eAAe,EAAE,CAAC;YACjC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC5C,IAAI,CAAC,KAAK,SAAS;oBAAE,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;YAC5C,CAAC;YACD,MAAM,KAAK,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;YAC5B,IAAI,KAAK;gBAAE,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QAC5D,CAAC;QAED,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,IAAI,GAAG,EAAE,CAAC,CAAC;QAEjC,MAAM,OAAO,GAA2B;YACtC,eAAe,EAAE,IAAI,CAAC,WAAW;YACjC,QAAQ,EAAE,kBAAkB;YAC5B,YAAY,EAAE,0BAA0B;SACzC,CAAC;QACF,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAC/C,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;YAClC,MAAM;YACN,OAAO;YACP,IAAI,EAAE,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;SAC5D,CAAC,CAAC;QAEH,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;YACb,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;YAC/B,IAAI,OAAO,GAAqC,IAAI,CAAC;YACrD,IAAI,CAAC;gBACH,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAA4B,CAAC;YACxD,CAAC;YAAC,MAAM,CAAC;gBACP,sDAAsD;YACxD,CAAC;YACD,MAAM,IAAI,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;QACzD,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YACxB,OAAO,EAAO,CAAC;QACjB,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QAC/B,IAAI,CAAC,IAAI;YAAE,OAAO,EAAO,CAAC;QAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAM,CAAC;IAC/B,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,GAAG,CAAU,IAAY,EAAE,MAAoB;QACnD,OAAO,IAAI,CAAC,QAAQ,CAAI,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,IAAI,CAAU,IAAY,EAAE,IAAU,EAAE,MAAoB;QAChE,OAAO,IAAI,CAAC,QAAQ,CAAI,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,GAAG,CAAU,IAAY,EAAE,IAAU;QACzC,OAAO,IAAI,CAAC,QAAQ,CAAI,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,KAAK,CAAU,IAAY,EAAE,IAAU;QAC3C,OAAO,IAAI,CAAC,QAAQ,CAAI,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,MAAM,CAAU,IAAY;QAChC,OAAO,IAAI,CAAC,QAAQ,CAAI,QAAQ,EAAE,IAAI,CAAC,CAAC;IAC1C,CAAC;CACF"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Custom error class for REST API errors.
|
|
3
|
+
*
|
|
4
|
+
* `body` may be a parsed JSON object (when the server returned valid JSON)
|
|
5
|
+
* or a plain string (when JSON parsing failed), matching the Python SDK's
|
|
6
|
+
* `SignalWireRestError` behavior.
|
|
7
|
+
*/
|
|
8
|
+
export declare class RestError extends Error {
|
|
9
|
+
/** HTTP status code returned by the server (e.g. `404`, `500`). */
|
|
10
|
+
readonly statusCode: number;
|
|
11
|
+
/**
|
|
12
|
+
* Parsed response body. An object when the server returned valid JSON,
|
|
13
|
+
* otherwise the raw response text as a string.
|
|
14
|
+
*/
|
|
15
|
+
readonly body: string | Record<string, unknown>;
|
|
16
|
+
/** Fully-qualified URL that produced the error. */
|
|
17
|
+
readonly url: string;
|
|
18
|
+
/** HTTP method that produced the error (`GET`, `POST`, etc.). */
|
|
19
|
+
readonly method: string;
|
|
20
|
+
/**
|
|
21
|
+
* @param statusCode - HTTP status code returned by the server.
|
|
22
|
+
* @param body - Response body — an object if JSON-parseable, otherwise the
|
|
23
|
+
* raw response text.
|
|
24
|
+
* @param url - Fully-qualified URL that produced the error.
|
|
25
|
+
* @param method - HTTP method that produced the error. Defaults to `"GET"`.
|
|
26
|
+
*/
|
|
27
|
+
constructor(statusCode: number, body: string | Record<string, unknown>, url: string, method?: string);
|
|
28
|
+
}
|
|
29
|
+
/** Alias matching the Python SDK class name. */
|
|
30
|
+
export { RestError as SignalWireRestError };
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Custom error class for REST API errors.
|
|
3
|
+
*
|
|
4
|
+
* `body` may be a parsed JSON object (when the server returned valid JSON)
|
|
5
|
+
* or a plain string (when JSON parsing failed), matching the Python SDK's
|
|
6
|
+
* `SignalWireRestError` behavior.
|
|
7
|
+
*/
|
|
8
|
+
export class RestError extends Error {
|
|
9
|
+
/** HTTP status code returned by the server (e.g. `404`, `500`). */
|
|
10
|
+
statusCode;
|
|
11
|
+
/**
|
|
12
|
+
* Parsed response body. An object when the server returned valid JSON,
|
|
13
|
+
* otherwise the raw response text as a string.
|
|
14
|
+
*/
|
|
15
|
+
body;
|
|
16
|
+
/** Fully-qualified URL that produced the error. */
|
|
17
|
+
url;
|
|
18
|
+
/** HTTP method that produced the error (`GET`, `POST`, etc.). */
|
|
19
|
+
method;
|
|
20
|
+
/**
|
|
21
|
+
* @param statusCode - HTTP status code returned by the server.
|
|
22
|
+
* @param body - Response body — an object if JSON-parseable, otherwise the
|
|
23
|
+
* raw response text.
|
|
24
|
+
* @param url - Fully-qualified URL that produced the error.
|
|
25
|
+
* @param method - HTTP method that produced the error. Defaults to `"GET"`.
|
|
26
|
+
*/
|
|
27
|
+
constructor(statusCode, body, url, method = 'GET') {
|
|
28
|
+
const bodyStr = typeof body === 'string' ? body : JSON.stringify(body);
|
|
29
|
+
super(`${method} ${url} returned ${statusCode}: ${bodyStr}`);
|
|
30
|
+
this.name = 'RestError';
|
|
31
|
+
this.statusCode = statusCode;
|
|
32
|
+
this.body = body;
|
|
33
|
+
this.url = url;
|
|
34
|
+
this.method = method;
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
/** Alias matching the Python SDK class name. */
|
|
38
|
+
export { RestError as SignalWireRestError };
|
|
39
|
+
//# sourceMappingURL=RestError.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"RestError.js","sourceRoot":"","sources":["../../src/rest/RestError.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,OAAO,SAAU,SAAQ,KAAK;IAClC,mEAAmE;IAC1D,UAAU,CAAS;IAC5B;;;OAGG;IACM,IAAI,CAAmC;IAChD,mDAAmD;IAC1C,GAAG,CAAS;IACrB,iEAAiE;IACxD,MAAM,CAAS;IAExB;;;;;;OAMG;IACH,YACE,UAAkB,EAClB,IAAsC,EACtC,GAAW,EACX,SAAiB,KAAK;QAEtB,MAAM,OAAO,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACvE,KAAK,CAAC,GAAG,MAAM,IAAI,GAAG,aAAa,UAAU,KAAK,OAAO,EAAE,CAAC,CAAC;QAC7D,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;QACxB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF;AAED,gDAAgD;AAChD,OAAO,EAAE,SAAS,IAAI,mBAAmB,EAAE,CAAC"}
|