@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
package/src/relay/index.ts
DELETED
|
@@ -1,123 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* SignalWire RELAY client — real-time call control over WebSocket.
|
|
3
|
-
*/
|
|
4
|
-
|
|
5
|
-
// Client
|
|
6
|
-
export { RelayClient } from './RelayClient.js';
|
|
7
|
-
export { RelayError } from './RelayError.js';
|
|
8
|
-
|
|
9
|
-
// Call + Actions
|
|
10
|
-
export { Call } from './Call.js';
|
|
11
|
-
export type { RelayClientLike } from './Call.js';
|
|
12
|
-
export {
|
|
13
|
-
Action,
|
|
14
|
-
PlayAction,
|
|
15
|
-
RecordAction,
|
|
16
|
-
DetectAction,
|
|
17
|
-
CollectAction,
|
|
18
|
-
StandaloneCollectAction,
|
|
19
|
-
FaxAction,
|
|
20
|
-
TapAction,
|
|
21
|
-
StreamAction,
|
|
22
|
-
PayAction,
|
|
23
|
-
TranscribeAction,
|
|
24
|
-
AIAction,
|
|
25
|
-
} from './Action.js';
|
|
26
|
-
export type { CallLike } from './Action.js';
|
|
27
|
-
|
|
28
|
-
// Message
|
|
29
|
-
export { Message } from './Message.js';
|
|
30
|
-
|
|
31
|
-
// Events
|
|
32
|
-
export {
|
|
33
|
-
RelayEvent,
|
|
34
|
-
CallStateEvent,
|
|
35
|
-
CallReceiveEvent,
|
|
36
|
-
PlayEvent,
|
|
37
|
-
RecordEvent,
|
|
38
|
-
CollectEvent,
|
|
39
|
-
ConnectEvent,
|
|
40
|
-
DetectEvent,
|
|
41
|
-
FaxEvent,
|
|
42
|
-
TapEvent,
|
|
43
|
-
StreamEvent,
|
|
44
|
-
SendDigitsEvent,
|
|
45
|
-
DialEvent,
|
|
46
|
-
ReferEvent,
|
|
47
|
-
DenoiseEvent,
|
|
48
|
-
PayEvent,
|
|
49
|
-
QueueEvent,
|
|
50
|
-
EchoEvent,
|
|
51
|
-
TranscribeEvent,
|
|
52
|
-
HoldEvent,
|
|
53
|
-
ConferenceEvent,
|
|
54
|
-
CallingErrorEvent,
|
|
55
|
-
MessageReceiveEvent,
|
|
56
|
-
MessageStateEvent,
|
|
57
|
-
parseEvent,
|
|
58
|
-
EVENT_CLASS_MAP,
|
|
59
|
-
} from './RelayEvent.js';
|
|
60
|
-
export type { EventClass } from './RelayEvent.js';
|
|
61
|
-
|
|
62
|
-
// Deferred utility
|
|
63
|
-
export { createDeferred, withTimeout } from './Deferred.js';
|
|
64
|
-
export type { Deferred } from './Deferred.js';
|
|
65
|
-
|
|
66
|
-
// Constants
|
|
67
|
-
export {
|
|
68
|
-
CALL_STATE_CREATED,
|
|
69
|
-
CALL_STATE_RINGING,
|
|
70
|
-
CALL_STATE_ANSWERED,
|
|
71
|
-
CALL_STATE_ENDING,
|
|
72
|
-
CALL_STATE_ENDED,
|
|
73
|
-
CONNECT_STATE_CONNECTING,
|
|
74
|
-
CONNECT_STATE_CONNECTED,
|
|
75
|
-
CONNECT_STATE_DISCONNECTED,
|
|
76
|
-
CONNECT_STATE_FAILED,
|
|
77
|
-
EVENT_CALL_STATE,
|
|
78
|
-
EVENT_CALL_RECEIVE,
|
|
79
|
-
EVENT_CALL_PLAY,
|
|
80
|
-
EVENT_CALL_RECORD,
|
|
81
|
-
EVENT_CALL_COLLECT,
|
|
82
|
-
EVENT_CALL_CONNECT,
|
|
83
|
-
EVENT_CALL_DETECT,
|
|
84
|
-
EVENT_CALL_FAX,
|
|
85
|
-
EVENT_CALL_TAP,
|
|
86
|
-
EVENT_CALL_STREAM,
|
|
87
|
-
EVENT_CALL_SEND_DIGITS,
|
|
88
|
-
EVENT_CALL_DIAL,
|
|
89
|
-
EVENT_CALL_REFER,
|
|
90
|
-
EVENT_CALL_DENOISE,
|
|
91
|
-
EVENT_CALL_PAY,
|
|
92
|
-
EVENT_CALL_QUEUE,
|
|
93
|
-
EVENT_CALL_ECHO,
|
|
94
|
-
EVENT_CALL_TRANSCRIBE,
|
|
95
|
-
EVENT_CALL_HOLD,
|
|
96
|
-
EVENT_CONFERENCE,
|
|
97
|
-
EVENT_CALLING_ERROR,
|
|
98
|
-
EVENT_MESSAGING_RECEIVE,
|
|
99
|
-
EVENT_MESSAGING_STATE,
|
|
100
|
-
MESSAGE_STATE_QUEUED,
|
|
101
|
-
MESSAGE_STATE_INITIATED,
|
|
102
|
-
MESSAGE_STATE_SENT,
|
|
103
|
-
MESSAGE_STATE_DELIVERED,
|
|
104
|
-
MESSAGE_STATE_UNDELIVERED,
|
|
105
|
-
MESSAGE_STATE_FAILED,
|
|
106
|
-
MESSAGE_STATE_RECEIVED,
|
|
107
|
-
} from './constants.js';
|
|
108
|
-
|
|
109
|
-
// Types
|
|
110
|
-
export type {
|
|
111
|
-
RelayClientOptions,
|
|
112
|
-
CallHandler,
|
|
113
|
-
MessageHandler,
|
|
114
|
-
EventHandler,
|
|
115
|
-
CompletedCallback,
|
|
116
|
-
Device,
|
|
117
|
-
PhoneDevice,
|
|
118
|
-
SipDevice,
|
|
119
|
-
DialOptions,
|
|
120
|
-
SendMessageOptions,
|
|
121
|
-
PlayItem,
|
|
122
|
-
CollectConfig,
|
|
123
|
-
} from './types.js';
|
package/src/relay/types.ts
DELETED
|
@@ -1,149 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Shared interfaces and type aliases for the RELAY client.
|
|
3
|
-
*/
|
|
4
|
-
|
|
5
|
-
import type { Call } from './Call.js';
|
|
6
|
-
import type { Message } from './Message.js';
|
|
7
|
-
import type { RelayEvent } from './RelayEvent.js';
|
|
8
|
-
|
|
9
|
-
/** Options for constructing a RelayClient. */
|
|
10
|
-
export interface RelayClientOptions {
|
|
11
|
-
/** SignalWire project ID. Defaults to env SIGNALWIRE_PROJECT_ID. */
|
|
12
|
-
project?: string;
|
|
13
|
-
/** SignalWire API token. Defaults to env SIGNALWIRE_API_TOKEN. */
|
|
14
|
-
token?: string;
|
|
15
|
-
/** JWT token for authentication. Defaults to env SIGNALWIRE_JWT_TOKEN. */
|
|
16
|
-
jwtToken?: string;
|
|
17
|
-
/** RELAY host. Defaults to relay.signalwire.com. */
|
|
18
|
-
host?: string;
|
|
19
|
-
/** Contexts (topics) to receive inbound calls/messages on. */
|
|
20
|
-
contexts?: string[];
|
|
21
|
-
/** Maximum number of concurrent active calls. Defaults to env RELAY_MAX_ACTIVE_CALLS or 1000. */
|
|
22
|
-
maxActiveCalls?: number;
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
/** JSON-RPC 2.0 request. */
|
|
26
|
-
export interface JsonRpcRequest {
|
|
27
|
-
jsonrpc: '2.0';
|
|
28
|
-
id: string;
|
|
29
|
-
method: string;
|
|
30
|
-
params: Record<string, unknown>;
|
|
31
|
-
}
|
|
32
|
-
|
|
33
|
-
/** JSON-RPC 2.0 response (success). */
|
|
34
|
-
export interface JsonRpcResponse {
|
|
35
|
-
jsonrpc: '2.0';
|
|
36
|
-
id: string;
|
|
37
|
-
result?: Record<string, unknown>;
|
|
38
|
-
error?: JsonRpcError;
|
|
39
|
-
}
|
|
40
|
-
|
|
41
|
-
/** JSON-RPC 2.0 error object. */
|
|
42
|
-
export interface JsonRpcError {
|
|
43
|
-
code: number;
|
|
44
|
-
message: string;
|
|
45
|
-
data?: unknown;
|
|
46
|
-
}
|
|
47
|
-
|
|
48
|
-
/** Handler for inbound calls. */
|
|
49
|
-
export type CallHandler = (call: Call) => void | Promise<void>;
|
|
50
|
-
|
|
51
|
-
/** Handler for inbound messages. */
|
|
52
|
-
export type MessageHandler = (message: Message) => void | Promise<void>;
|
|
53
|
-
|
|
54
|
-
/** Handler for relay events. */
|
|
55
|
-
export type EventHandler = (event: RelayEvent) => void | Promise<void>;
|
|
56
|
-
|
|
57
|
-
/** Callback when an action or message completes. */
|
|
58
|
-
export type CompletedCallback = (event: RelayEvent) => void | Promise<void>;
|
|
59
|
-
|
|
60
|
-
/** Phone device specification for dial/connect. */
|
|
61
|
-
export interface PhoneDevice {
|
|
62
|
-
type: 'phone';
|
|
63
|
-
to: string;
|
|
64
|
-
from: string;
|
|
65
|
-
timeout?: number;
|
|
66
|
-
max_duration?: number;
|
|
67
|
-
codecs?: string[];
|
|
68
|
-
headers?: Record<string, string>[];
|
|
69
|
-
}
|
|
70
|
-
|
|
71
|
-
/** SIP device specification for dial/connect. */
|
|
72
|
-
export interface SipDevice {
|
|
73
|
-
type: 'sip';
|
|
74
|
-
to: string;
|
|
75
|
-
from: string;
|
|
76
|
-
timeout?: number;
|
|
77
|
-
max_duration?: number;
|
|
78
|
-
codecs?: string[];
|
|
79
|
-
headers?: Record<string, string>[];
|
|
80
|
-
}
|
|
81
|
-
|
|
82
|
-
/** Any device specification. */
|
|
83
|
-
export type Device = PhoneDevice | SipDevice | Record<string, unknown>;
|
|
84
|
-
|
|
85
|
-
/** Options for the dial() method. */
|
|
86
|
-
export interface DialOptions {
|
|
87
|
-
/** Caller ID / from number. */
|
|
88
|
-
from?: string;
|
|
89
|
-
/** Timeout in seconds for the dial. */
|
|
90
|
-
timeout?: number;
|
|
91
|
-
/** Maximum call duration in seconds. */
|
|
92
|
-
maxDuration?: number;
|
|
93
|
-
}
|
|
94
|
-
|
|
95
|
-
/** Options for the sendMessage() method. */
|
|
96
|
-
export interface SendMessageOptions {
|
|
97
|
-
/** Destination phone number in E.164 format. */
|
|
98
|
-
toNumber: string;
|
|
99
|
-
/** Sender phone number in E.164 format. */
|
|
100
|
-
fromNumber: string;
|
|
101
|
-
/** Message body text. */
|
|
102
|
-
body?: string;
|
|
103
|
-
/** Media URLs for MMS. */
|
|
104
|
-
media?: string[];
|
|
105
|
-
/** Context for the message. */
|
|
106
|
-
context?: string;
|
|
107
|
-
/** Tags for the message. */
|
|
108
|
-
tags?: string[];
|
|
109
|
-
}
|
|
110
|
-
|
|
111
|
-
/** Play item: TTS, audio URL, ringtone, or silence. */
|
|
112
|
-
export type PlayItem =
|
|
113
|
-
| { type: 'tts'; text: string; language?: string; gender?: string }
|
|
114
|
-
| { type: 'audio'; url: string }
|
|
115
|
-
| { type: 'ringtone'; name: string; duration?: number }
|
|
116
|
-
| { type: 'silence'; duration: number }
|
|
117
|
-
| Record<string, unknown>;
|
|
118
|
-
|
|
119
|
-
/** Collect input configuration. */
|
|
120
|
-
export interface CollectConfig {
|
|
121
|
-
/** Collect digits. */
|
|
122
|
-
digits?: {
|
|
123
|
-
max: number;
|
|
124
|
-
digit_timeout?: number;
|
|
125
|
-
terminators?: string;
|
|
126
|
-
};
|
|
127
|
-
/** Collect speech. */
|
|
128
|
-
speech?: {
|
|
129
|
-
end_silence_timeout?: number;
|
|
130
|
-
speech_timeout?: number;
|
|
131
|
-
language?: string;
|
|
132
|
-
hints?: string[];
|
|
133
|
-
model?: string;
|
|
134
|
-
};
|
|
135
|
-
/** Initial timeout in seconds. */
|
|
136
|
-
initial_timeout?: number;
|
|
137
|
-
/** Partial results? */
|
|
138
|
-
partial_results?: boolean;
|
|
139
|
-
/** Continuous mode? */
|
|
140
|
-
continuous?: boolean;
|
|
141
|
-
}
|
|
142
|
-
|
|
143
|
-
/** Queued request waiting for reconnection. */
|
|
144
|
-
export interface QueuedRequest {
|
|
145
|
-
method: string;
|
|
146
|
-
params: Record<string, unknown>;
|
|
147
|
-
resolve: (value: Record<string, unknown>) => void;
|
|
148
|
-
reject: (reason?: unknown) => void;
|
|
149
|
-
}
|
package/src/rest/HttpClient.ts
DELETED
|
@@ -1,164 +0,0 @@
|
|
|
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
|
-
|
|
8
|
-
/* eslint-disable @typescript-eslint/no-explicit-any */
|
|
9
|
-
|
|
10
|
-
import { getLogger } from '../Logger.js';
|
|
11
|
-
import { RestError } from './RestError.js';
|
|
12
|
-
import type { HttpClientOptions, QueryParams } from './types.js';
|
|
13
|
-
|
|
14
|
-
const logger = getLogger('rest_client');
|
|
15
|
-
|
|
16
|
-
/**
|
|
17
|
-
* Low-level HTTP client used by every REST namespace resource.
|
|
18
|
-
*
|
|
19
|
-
* Handles Basic Auth, JSON encoding/decoding, and error normalisation
|
|
20
|
-
* ({@link RestError} on non-2xx). Normally you do not instantiate this
|
|
21
|
-
* directly — construct a {@link RestClient} instead.
|
|
22
|
-
*/
|
|
23
|
-
export class HttpClient {
|
|
24
|
-
/** Fully-qualified base URL (no trailing slash). */
|
|
25
|
-
readonly baseUrl: string;
|
|
26
|
-
private readonly _authHeader: string;
|
|
27
|
-
private readonly _fetch: typeof globalThis.fetch;
|
|
28
|
-
|
|
29
|
-
/**
|
|
30
|
-
* Build a new HTTP client.
|
|
31
|
-
*
|
|
32
|
-
* @param options - Connection options. Either `host` (bare hostname;
|
|
33
|
-
* `https://` is prepended automatically) or `baseUrl` (fully-qualified)
|
|
34
|
-
* must be provided along with `project` + `token`.
|
|
35
|
-
* @throws {Error} When neither `host` nor `baseUrl` is supplied.
|
|
36
|
-
*/
|
|
37
|
-
constructor(options: HttpClientOptions) {
|
|
38
|
-
if (!options.host && !options.baseUrl) {
|
|
39
|
-
throw new Error('HttpClientOptions requires either "host" or "baseUrl".');
|
|
40
|
-
}
|
|
41
|
-
|
|
42
|
-
// host takes precedence (matches Python's HttpClient(project, token, host) convention
|
|
43
|
-
// where a bare hostname is expected and https:// is prepended automatically).
|
|
44
|
-
const rawUrl = options.host ? `https://${options.host}` : options.baseUrl!;
|
|
45
|
-
this.baseUrl = rawUrl.replace(/\/+$/, '');
|
|
46
|
-
|
|
47
|
-
this._authHeader = 'Basic ' + Buffer.from(`${options.project}:${options.token}`).toString('base64');
|
|
48
|
-
this._fetch = options.fetchImpl ?? globalThis.fetch;
|
|
49
|
-
}
|
|
50
|
-
|
|
51
|
-
private async _request<T = any>(method: string, path: string, body?: any, params?: QueryParams): Promise<T> {
|
|
52
|
-
let url = path.startsWith('http') ? path : `${this.baseUrl}${path}`;
|
|
53
|
-
|
|
54
|
-
if (params) {
|
|
55
|
-
const qs = new URLSearchParams();
|
|
56
|
-
for (const [k, v] of Object.entries(params)) {
|
|
57
|
-
if (v !== undefined) qs.set(k, String(v));
|
|
58
|
-
}
|
|
59
|
-
const qsStr = qs.toString();
|
|
60
|
-
if (qsStr) url += (url.includes('?') ? '&' : '?') + qsStr;
|
|
61
|
-
}
|
|
62
|
-
|
|
63
|
-
logger.debug(`${method} ${url}`);
|
|
64
|
-
|
|
65
|
-
const headers: Record<string, string> = {
|
|
66
|
-
'Authorization': this._authHeader,
|
|
67
|
-
'Accept': 'application/json',
|
|
68
|
-
'User-Agent': '@signalwire/sdk-ts/2.0.0',
|
|
69
|
-
};
|
|
70
|
-
if (body !== undefined) {
|
|
71
|
-
headers['Content-Type'] = 'application/json';
|
|
72
|
-
}
|
|
73
|
-
|
|
74
|
-
const resp = await this._fetch(url, {
|
|
75
|
-
method,
|
|
76
|
-
headers,
|
|
77
|
-
body: body !== undefined ? JSON.stringify(body) : undefined,
|
|
78
|
-
});
|
|
79
|
-
|
|
80
|
-
if (!resp.ok) {
|
|
81
|
-
const text = await resp.text();
|
|
82
|
-
let errBody: string | Record<string, unknown> = text;
|
|
83
|
-
try {
|
|
84
|
-
errBody = JSON.parse(text) as Record<string, unknown>;
|
|
85
|
-
} catch {
|
|
86
|
-
// Response was not valid JSON — keep as plain string.
|
|
87
|
-
}
|
|
88
|
-
throw new RestError(resp.status, errBody, url, method);
|
|
89
|
-
}
|
|
90
|
-
|
|
91
|
-
if (resp.status === 204) {
|
|
92
|
-
return {} as T;
|
|
93
|
-
}
|
|
94
|
-
|
|
95
|
-
const text = await resp.text();
|
|
96
|
-
if (!text) return {} as T;
|
|
97
|
-
return JSON.parse(text) as T;
|
|
98
|
-
}
|
|
99
|
-
|
|
100
|
-
/**
|
|
101
|
-
* Perform an authenticated HTTP GET and return the parsed JSON response.
|
|
102
|
-
*
|
|
103
|
-
* @typeParam T - Expected response body type.
|
|
104
|
-
* @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
|
|
105
|
-
* @param params - Optional query parameters; `undefined` values are skipped.
|
|
106
|
-
* @returns The parsed JSON body, or `{}` on `204 No Content`.
|
|
107
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
108
|
-
*/
|
|
109
|
-
async get<T = any>(path: string, params?: QueryParams): Promise<T> {
|
|
110
|
-
return this._request<T>('GET', path, undefined, params);
|
|
111
|
-
}
|
|
112
|
-
|
|
113
|
-
/**
|
|
114
|
-
* Perform an authenticated HTTP POST and return the parsed JSON response.
|
|
115
|
-
*
|
|
116
|
-
* @typeParam T - Expected response body type.
|
|
117
|
-
* @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
|
|
118
|
-
* @param body - JSON-serialisable request body. Omit to send no body.
|
|
119
|
-
* @param params - Optional query parameters appended to the URL.
|
|
120
|
-
* @returns The parsed JSON body, or `{}` on `204 No Content`.
|
|
121
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
122
|
-
*/
|
|
123
|
-
async post<T = any>(path: string, body?: any, params?: QueryParams): Promise<T> {
|
|
124
|
-
return this._request<T>('POST', path, body, params);
|
|
125
|
-
}
|
|
126
|
-
|
|
127
|
-
/**
|
|
128
|
-
* Perform an authenticated HTTP PUT and return the parsed JSON response.
|
|
129
|
-
*
|
|
130
|
-
* @typeParam T - Expected response body type.
|
|
131
|
-
* @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
|
|
132
|
-
* @param body - JSON-serialisable request body.
|
|
133
|
-
* @returns The parsed JSON body, or `{}` on `204 No Content`.
|
|
134
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
135
|
-
*/
|
|
136
|
-
async put<T = any>(path: string, body?: any): Promise<T> {
|
|
137
|
-
return this._request<T>('PUT', path, body);
|
|
138
|
-
}
|
|
139
|
-
|
|
140
|
-
/**
|
|
141
|
-
* Perform an authenticated HTTP PATCH and return the parsed JSON response.
|
|
142
|
-
*
|
|
143
|
-
* @typeParam T - Expected response body type.
|
|
144
|
-
* @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
|
|
145
|
-
* @param body - JSON-serialisable partial request body.
|
|
146
|
-
* @returns The parsed JSON body, or `{}` on `204 No Content`.
|
|
147
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
148
|
-
*/
|
|
149
|
-
async patch<T = any>(path: string, body?: any): Promise<T> {
|
|
150
|
-
return this._request<T>('PATCH', path, body);
|
|
151
|
-
}
|
|
152
|
-
|
|
153
|
-
/**
|
|
154
|
-
* Perform an authenticated HTTP DELETE and return the parsed JSON response.
|
|
155
|
-
*
|
|
156
|
-
* @typeParam T - Expected response body type.
|
|
157
|
-
* @param path - Absolute URL or path relative to {@link HttpClient.baseUrl}.
|
|
158
|
-
* @returns The parsed JSON body, or `{}` on `204 No Content`.
|
|
159
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
160
|
-
*/
|
|
161
|
-
async delete<T = any>(path: string): Promise<T> {
|
|
162
|
-
return this._request<T>('DELETE', path);
|
|
163
|
-
}
|
|
164
|
-
}
|
package/src/rest/RestError.ts
DELETED
|
@@ -1,45 +0,0 @@
|
|
|
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
|
-
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
|
-
/**
|
|
22
|
-
* @param statusCode - HTTP status code returned by the server.
|
|
23
|
-
* @param body - Response body — an object if JSON-parseable, otherwise the
|
|
24
|
-
* raw response text.
|
|
25
|
-
* @param url - Fully-qualified URL that produced the error.
|
|
26
|
-
* @param method - HTTP method that produced the error. Defaults to `"GET"`.
|
|
27
|
-
*/
|
|
28
|
-
constructor(
|
|
29
|
-
statusCode: number,
|
|
30
|
-
body: string | Record<string, unknown>,
|
|
31
|
-
url: string,
|
|
32
|
-
method: string = 'GET',
|
|
33
|
-
) {
|
|
34
|
-
const bodyStr = typeof body === 'string' ? body : JSON.stringify(body);
|
|
35
|
-
super(`${method} ${url} returned ${statusCode}: ${bodyStr}`);
|
|
36
|
-
this.name = 'RestError';
|
|
37
|
-
this.statusCode = statusCode;
|
|
38
|
-
this.body = body;
|
|
39
|
-
this.url = url;
|
|
40
|
-
this.method = method;
|
|
41
|
-
}
|
|
42
|
-
}
|
|
43
|
-
|
|
44
|
-
/** Alias matching the Python SDK class name. */
|
|
45
|
-
export { RestError as SignalWireRestError };
|
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
import type { HttpClient } from '../HttpClient.js';
|
|
2
|
-
|
|
3
|
-
/**
|
|
4
|
-
* Abstract base class for all REST resources.
|
|
5
|
-
*
|
|
6
|
-
* Every namespace resource (e.g. {@link PhoneNumbersResource}, {@link VideoRooms})
|
|
7
|
-
* extends this class to get a typed reference to the shared {@link HttpClient}
|
|
8
|
-
* and a small path-building helper. Not exported for direct use — subclass it.
|
|
9
|
-
*/
|
|
10
|
-
export abstract class BaseResource {
|
|
11
|
-
protected readonly _http: HttpClient;
|
|
12
|
-
protected readonly _basePath: string;
|
|
13
|
-
|
|
14
|
-
/**
|
|
15
|
-
* @param http - Shared HTTP client to issue requests through.
|
|
16
|
-
* @param basePath - Absolute path prefix (e.g. `'/api/relay/rest/phone_numbers'`).
|
|
17
|
-
*/
|
|
18
|
-
constructor(http: HttpClient, basePath: string) {
|
|
19
|
-
this._http = http;
|
|
20
|
-
this._basePath = basePath;
|
|
21
|
-
}
|
|
22
|
-
|
|
23
|
-
/**
|
|
24
|
-
* Build a sub-resource path by joining parts onto the base path.
|
|
25
|
-
*
|
|
26
|
-
* @param parts - String or numeric path segments to append.
|
|
27
|
-
* @returns The joined path (no trailing slash).
|
|
28
|
-
*/
|
|
29
|
-
protected _path(...parts: (string | number)[]): string {
|
|
30
|
-
return [this._basePath, ...parts.map(String)].join('/');
|
|
31
|
-
}
|
|
32
|
-
}
|
|
@@ -1,98 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Generic CRUD resource with configurable update method.
|
|
3
|
-
*/
|
|
4
|
-
|
|
5
|
-
/* eslint-disable @typescript-eslint/no-explicit-any */
|
|
6
|
-
|
|
7
|
-
import type { HttpClient } from '../HttpClient.js';
|
|
8
|
-
import type { QueryParams } from '../types.js';
|
|
9
|
-
import { BaseResource } from './BaseResource.js';
|
|
10
|
-
|
|
11
|
-
/**
|
|
12
|
-
* Generic CRUD resource with configurable update method.
|
|
13
|
-
*
|
|
14
|
-
* Provides `list()`, `create()`, `get()`, `update()`, and `delete()` out of the
|
|
15
|
-
* box — most namespace resources extend this and narrow the generic types.
|
|
16
|
-
* `_updateMethod` may be overridden to `'PUT'` for APIs that replace instead
|
|
17
|
-
* of patch.
|
|
18
|
-
*
|
|
19
|
-
* @typeParam TList - Type of the paginated list response.
|
|
20
|
-
* @typeParam TItem - Type of a single resource item.
|
|
21
|
-
* @typeParam TCreate - Request body type for `create()`.
|
|
22
|
-
* @typeParam TUpdate - Request body type for `update()`.
|
|
23
|
-
*/
|
|
24
|
-
export class CrudResource<
|
|
25
|
-
TList = any,
|
|
26
|
-
TItem = any,
|
|
27
|
-
TCreate = any,
|
|
28
|
-
TUpdate = any,
|
|
29
|
-
> extends BaseResource {
|
|
30
|
-
/** Override to 'PUT' for resources that use PUT instead of PATCH. */
|
|
31
|
-
protected _updateMethod: 'PATCH' | 'PUT' = 'PATCH';
|
|
32
|
-
|
|
33
|
-
constructor(http: HttpClient, basePath: string) {
|
|
34
|
-
super(http, basePath);
|
|
35
|
-
}
|
|
36
|
-
|
|
37
|
-
/**
|
|
38
|
-
* List resources with optional query parameters.
|
|
39
|
-
*
|
|
40
|
-
* @param params - Optional filter / pagination query parameters.
|
|
41
|
-
* @returns The paginated list response.
|
|
42
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
43
|
-
*/
|
|
44
|
-
async list(params?: QueryParams): Promise<TList> {
|
|
45
|
-
return this._http.get<TList>(this._basePath, params);
|
|
46
|
-
}
|
|
47
|
-
|
|
48
|
-
/**
|
|
49
|
-
* Create a new resource.
|
|
50
|
-
*
|
|
51
|
-
* @param body - Request body describing the resource to create.
|
|
52
|
-
* @returns The newly-created resource.
|
|
53
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
54
|
-
*/
|
|
55
|
-
async create(body: TCreate): Promise<TItem> {
|
|
56
|
-
return this._http.post<TItem>(this._basePath, body);
|
|
57
|
-
}
|
|
58
|
-
|
|
59
|
-
/**
|
|
60
|
-
* Fetch a single resource by ID.
|
|
61
|
-
*
|
|
62
|
-
* @param resourceId - Unique identifier of the resource.
|
|
63
|
-
* @returns The resource record.
|
|
64
|
-
* @throws {RestError} On any non-2xx HTTP response (including `404`).
|
|
65
|
-
*/
|
|
66
|
-
async get(resourceId: string): Promise<TItem> {
|
|
67
|
-
return this._http.get<TItem>(this._path(resourceId));
|
|
68
|
-
}
|
|
69
|
-
|
|
70
|
-
/**
|
|
71
|
-
* Update a resource by ID.
|
|
72
|
-
*
|
|
73
|
-
* Uses HTTP `PATCH` by default; subclasses may set `_updateMethod = 'PUT'`
|
|
74
|
-
* when the remote API requires a full-replacement semantics.
|
|
75
|
-
*
|
|
76
|
-
* @param resourceId - Unique identifier of the resource.
|
|
77
|
-
* @param body - Request body with updated fields.
|
|
78
|
-
* @returns The updated resource.
|
|
79
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
80
|
-
*/
|
|
81
|
-
async update(resourceId: string, body: TUpdate): Promise<TItem> {
|
|
82
|
-
if (this._updateMethod === 'PUT') {
|
|
83
|
-
return this._http.put<TItem>(this._path(resourceId), body);
|
|
84
|
-
}
|
|
85
|
-
return this._http.patch<TItem>(this._path(resourceId), body);
|
|
86
|
-
}
|
|
87
|
-
|
|
88
|
-
/**
|
|
89
|
-
* Delete a resource by ID.
|
|
90
|
-
*
|
|
91
|
-
* @param resourceId - Unique identifier of the resource.
|
|
92
|
-
* @returns The platform's delete response (often an empty body on success).
|
|
93
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
94
|
-
*/
|
|
95
|
-
async delete(resourceId: string): Promise<any> {
|
|
96
|
-
return this._http.delete(this._path(resourceId));
|
|
97
|
-
}
|
|
98
|
-
}
|
|
@@ -1,37 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* CrudResource extended with address listing.
|
|
3
|
-
*/
|
|
4
|
-
|
|
5
|
-
/* eslint-disable @typescript-eslint/no-explicit-any */
|
|
6
|
-
|
|
7
|
-
import type { HttpClient } from '../HttpClient.js';
|
|
8
|
-
import type { QueryParams } from '../types.js';
|
|
9
|
-
import { CrudResource } from './CrudResource.js';
|
|
10
|
-
|
|
11
|
-
/**
|
|
12
|
-
* {@link CrudResource} extended with a `listAddresses()` helper for resources that
|
|
13
|
-
* have associated Address records (e.g. fabric resources).
|
|
14
|
-
*/
|
|
15
|
-
export class CrudWithAddresses<
|
|
16
|
-
TList = any,
|
|
17
|
-
TItem = any,
|
|
18
|
-
TCreate = any,
|
|
19
|
-
TUpdate = any,
|
|
20
|
-
> extends CrudResource<TList, TItem, TCreate, TUpdate> {
|
|
21
|
-
|
|
22
|
-
constructor(http: HttpClient, basePath: string) {
|
|
23
|
-
super(http, basePath);
|
|
24
|
-
}
|
|
25
|
-
|
|
26
|
-
/**
|
|
27
|
-
* List addresses associated with a specific resource instance.
|
|
28
|
-
*
|
|
29
|
-
* @param resourceId - Unique identifier of the owning resource.
|
|
30
|
-
* @param params - Optional filter / pagination query parameters.
|
|
31
|
-
* @returns A paginated list of addresses.
|
|
32
|
-
* @throws {RestError} On any non-2xx HTTP response.
|
|
33
|
-
*/
|
|
34
|
-
async listAddresses(resourceId: string, params?: QueryParams): Promise<any> {
|
|
35
|
-
return this._http.get(this._path(resourceId, 'addresses'), params);
|
|
36
|
-
}
|
|
37
|
-
}
|