@signalwire/sdk 2.0.1 → 2.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/AgentBase.d.ts +1045 -0
- package/dist/AgentBase.js +2375 -0
- package/dist/AgentBase.js.map +1 -0
- package/dist/AgentServer.d.ts +146 -0
- package/dist/AgentServer.js +388 -0
- package/dist/AgentServer.js.map +1 -0
- package/dist/AuthHandler.d.ts +127 -0
- package/dist/AuthHandler.js +212 -0
- package/dist/AuthHandler.js.map +1 -0
- package/dist/ConfigLoader.d.ts +170 -0
- package/dist/ConfigLoader.js +393 -0
- package/dist/ConfigLoader.js.map +1 -0
- package/dist/ContextBuilder.d.ts +652 -0
- package/dist/ContextBuilder.js +1115 -0
- package/dist/ContextBuilder.js.map +1 -0
- package/dist/DataMap.d.ts +271 -0
- package/dist/DataMap.js +430 -0
- package/dist/DataMap.js.map +1 -0
- package/dist/FunctionResult.d.ts +481 -0
- package/dist/FunctionResult.js +775 -0
- package/dist/FunctionResult.js.map +1 -0
- package/dist/Logger.d.ts +113 -0
- package/dist/Logger.js +320 -0
- package/dist/Logger.js.map +1 -0
- package/dist/PomBuilder.d.ts +208 -0
- package/dist/PomBuilder.js +409 -0
- package/dist/PomBuilder.js.map +1 -0
- package/dist/PromptManager.d.ts +85 -0
- package/dist/PromptManager.js +108 -0
- package/dist/PromptManager.js.map +1 -0
- package/dist/SWMLHandler.d.ts +159 -0
- package/dist/SWMLHandler.js +229 -0
- package/dist/SWMLHandler.js.map +1 -0
- package/dist/SWMLService.d.ts +326 -0
- package/dist/SWMLService.js +610 -0
- package/dist/SWMLService.js.map +1 -0
- package/dist/SchemaUtils.d.ts +108 -0
- package/dist/SchemaUtils.js +317 -0
- package/dist/SchemaUtils.js.map +1 -0
- package/dist/SecurityUtils.d.ts +60 -0
- package/{src/SecurityUtils.ts → dist/SecurityUtils.js} +82 -83
- package/dist/SecurityUtils.js.map +1 -0
- package/dist/ServerlessAdapter.d.ts +119 -0
- package/dist/ServerlessAdapter.js +188 -0
- package/dist/ServerlessAdapter.js.map +1 -0
- package/dist/SessionManager.d.ts +142 -0
- package/dist/SessionManager.js +260 -0
- package/dist/SessionManager.js.map +1 -0
- package/dist/SslConfig.d.ts +77 -0
- package/dist/SslConfig.js +100 -0
- package/dist/SslConfig.js.map +1 -0
- package/dist/SwaigFunction.d.ts +159 -0
- package/dist/SwaigFunction.js +209 -0
- package/dist/SwaigFunction.js.map +1 -0
- package/dist/SwmlBuilder.d.ts +165 -0
- package/dist/SwmlBuilder.js +247 -0
- package/dist/SwmlBuilder.js.map +1 -0
- package/dist/SwmlVerbMethods.generated.d.ts +254 -0
- package/dist/SwmlVerbMethods.generated.js +9 -0
- package/dist/SwmlVerbMethods.generated.js.map +1 -0
- package/dist/TypeInference.d.ts +71 -0
- package/dist/TypeInference.js +164 -0
- package/dist/TypeInference.js.map +1 -0
- package/dist/WebService.d.ts +148 -0
- package/dist/WebService.js +532 -0
- package/dist/WebService.js.map +1 -0
- package/dist/cli/agent-loader.d.ts +22 -0
- package/dist/cli/agent-loader.js +144 -0
- package/dist/cli/agent-loader.js.map +1 -0
- package/dist/cli/mock-data.d.ts +37 -0
- package/dist/cli/mock-data.js +80 -0
- package/dist/cli/mock-data.js.map +1 -0
- package/dist/cli/swaig-test.d.ts +32 -0
- package/dist/cli/swaig-test.js +418 -0
- package/dist/cli/swaig-test.js.map +1 -0
- package/dist/generateVerbTypes.d.ts +11 -0
- package/dist/generateVerbTypes.js +265 -0
- package/dist/generateVerbTypes.js.map +1 -0
- package/{src/index.ts → dist/index.d.ts} +13 -100
- package/dist/index.js +152 -0
- package/dist/index.js.map +1 -0
- package/dist/livewire/index.d.ts +653 -0
- package/dist/livewire/index.js +992 -0
- package/dist/livewire/index.js.map +1 -0
- package/dist/prefabs/ConciergeAgent.d.ts +89 -0
- package/dist/prefabs/ConciergeAgent.js +245 -0
- package/dist/prefabs/ConciergeAgent.js.map +1 -0
- package/dist/prefabs/FAQBotAgent.d.ts +113 -0
- package/dist/prefabs/FAQBotAgent.js +329 -0
- package/dist/prefabs/FAQBotAgent.js.map +1 -0
- package/dist/prefabs/InfoGathererAgent.d.ts +126 -0
- package/dist/prefabs/InfoGathererAgent.js +287 -0
- package/dist/prefabs/InfoGathererAgent.js.map +1 -0
- package/dist/prefabs/ReceptionistAgent.d.ts +104 -0
- package/dist/prefabs/ReceptionistAgent.js +303 -0
- package/dist/prefabs/ReceptionistAgent.js.map +1 -0
- package/dist/prefabs/SurveyAgent.d.ts +148 -0
- package/dist/prefabs/SurveyAgent.js +540 -0
- package/dist/prefabs/SurveyAgent.js.map +1 -0
- package/{src/prefabs/index.ts → dist/prefabs/index.d.ts} +1 -15
- package/dist/prefabs/index.js +14 -0
- package/dist/prefabs/index.js.map +1 -0
- package/dist/relay/Action.d.ts +258 -0
- package/dist/relay/Action.js +402 -0
- package/dist/relay/Action.js.map +1 -0
- package/dist/relay/Call.d.ts +697 -0
- package/dist/relay/Call.js +1062 -0
- package/dist/relay/Call.js.map +1 -0
- package/dist/relay/Deferred.d.ts +44 -0
- package/dist/relay/Deferred.js +69 -0
- package/dist/relay/Deferred.js.map +1 -0
- package/dist/relay/Message.d.ts +103 -0
- package/dist/relay/Message.js +169 -0
- package/dist/relay/Message.js.map +1 -0
- package/dist/relay/RelayClient.d.ts +302 -0
- package/dist/relay/RelayClient.js +1019 -0
- package/dist/relay/RelayClient.js.map +1 -0
- package/dist/relay/RelayError.d.ts +15 -0
- package/dist/relay/RelayError.js +20 -0
- package/dist/relay/RelayError.js.map +1 -0
- package/dist/relay/RelayEvent.d.ts +254 -0
- package/dist/relay/RelayEvent.js +509 -0
- package/dist/relay/RelayEvent.js.map +1 -0
- package/dist/relay/constants.d.ts +90 -0
- package/{src/relay/constants.ts → dist/relay/constants.js} +11 -29
- package/dist/relay/constants.js.map +1 -0
- package/dist/relay/index.d.ts +16 -0
- package/dist/relay/index.js +18 -0
- package/dist/relay/index.js.map +1 -0
- package/dist/relay/types.d.ts +142 -0
- package/dist/relay/types.js +5 -0
- package/dist/relay/types.js.map +1 -0
- package/dist/rest/HttpClient.d.ts +80 -0
- package/dist/rest/HttpClient.js +148 -0
- package/dist/rest/HttpClient.js.map +1 -0
- package/dist/rest/RestError.d.ts +30 -0
- package/dist/rest/RestError.js +39 -0
- package/dist/rest/RestError.js.map +1 -0
- package/dist/rest/base/BaseResource.d.ts +24 -0
- package/dist/rest/base/BaseResource.js +29 -0
- package/dist/rest/base/BaseResource.js.map +1 -0
- package/dist/rest/base/CrudResource.d.ts +68 -0
- package/dist/rest/base/CrudResource.js +82 -0
- package/dist/rest/base/CrudResource.js.map +1 -0
- package/dist/rest/base/CrudWithAddresses.d.ts +22 -0
- package/dist/rest/base/CrudWithAddresses.js +25 -0
- package/dist/rest/base/CrudWithAddresses.js.map +1 -0
- package/dist/rest/index.d.ts +131 -0
- package/{src/rest/index.ts → dist/rest/index.js} +101 -136
- package/dist/rest/index.js.map +1 -0
- package/dist/rest/namespaces/addresses.d.ts +46 -0
- package/dist/rest/namespaces/addresses.js +55 -0
- package/dist/rest/namespaces/addresses.js.map +1 -0
- package/dist/rest/namespaces/calling.d.ts +382 -0
- package/dist/rest/namespaces/calling.js +478 -0
- package/dist/rest/namespaces/calling.js.map +1 -0
- package/dist/rest/namespaces/chat.d.ts +22 -0
- package/dist/rest/namespaces/chat.js +26 -0
- package/dist/rest/namespaces/chat.js.map +1 -0
- package/dist/rest/namespaces/compat.d.ts +585 -0
- package/dist/rest/namespaces/compat.js +735 -0
- package/dist/rest/namespaces/compat.js.map +1 -0
- package/dist/rest/namespaces/datasphere.d.ts +66 -0
- package/dist/rest/namespaces/datasphere.js +77 -0
- package/dist/rest/namespaces/datasphere.js.map +1 -0
- package/dist/rest/namespaces/fabric.d.ts +282 -0
- package/dist/rest/namespaces/fabric.js +373 -0
- package/dist/rest/namespaces/fabric.js.map +1 -0
- package/dist/rest/namespaces/imported-numbers.d.ts +22 -0
- package/dist/rest/namespaces/imported-numbers.js +26 -0
- package/dist/rest/namespaces/imported-numbers.js.map +1 -0
- package/dist/rest/namespaces/logs.d.ts +105 -0
- package/dist/rest/namespaces/logs.js +133 -0
- package/dist/rest/namespaces/logs.js.map +1 -0
- package/dist/rest/namespaces/lookup.d.ts +29 -0
- package/dist/rest/namespaces/lookup.js +32 -0
- package/dist/rest/namespaces/lookup.js.map +1 -0
- package/dist/rest/namespaces/mfa.d.ts +46 -0
- package/dist/rest/namespaces/mfa.js +54 -0
- package/dist/rest/namespaces/mfa.js.map +1 -0
- package/dist/rest/namespaces/number-groups.d.ts +49 -0
- package/dist/rest/namespaces/number-groups.js +58 -0
- package/dist/rest/namespaces/number-groups.js.map +1 -0
- package/dist/rest/namespaces/phone-numbers.d.ts +60 -0
- package/dist/rest/namespaces/phone-numbers.js +67 -0
- package/dist/rest/namespaces/phone-numbers.js.map +1 -0
- package/dist/rest/namespaces/project.d.ts +46 -0
- package/dist/rest/namespaces/project.js +56 -0
- package/dist/rest/namespaces/project.js.map +1 -0
- package/dist/rest/namespaces/pubsub.d.ts +22 -0
- package/dist/rest/namespaces/pubsub.js +26 -0
- package/dist/rest/namespaces/pubsub.js.map +1 -0
- package/dist/rest/namespaces/queues.d.ts +42 -0
- package/dist/rest/namespaces/queues.js +49 -0
- package/dist/rest/namespaces/queues.js.map +1 -0
- package/dist/rest/namespaces/recordings.d.ts +38 -0
- package/dist/rest/namespaces/recordings.js +45 -0
- package/dist/rest/namespaces/recordings.js.map +1 -0
- package/dist/rest/namespaces/registry.d.ts +141 -0
- package/dist/rest/namespaces/registry.js +178 -0
- package/dist/rest/namespaces/registry.js.map +1 -0
- package/dist/rest/namespaces/short-codes.d.ts +39 -0
- package/dist/rest/namespaces/short-codes.js +46 -0
- package/dist/rest/namespaces/short-codes.js.map +1 -0
- package/dist/rest/namespaces/sip-profile.d.ts +28 -0
- package/dist/rest/namespaces/sip-profile.js +34 -0
- package/dist/rest/namespaces/sip-profile.js.map +1 -0
- package/dist/rest/namespaces/verified-callers.d.ts +33 -0
- package/dist/rest/namespaces/verified-callers.js +39 -0
- package/dist/rest/namespaces/verified-callers.js.map +1 -0
- package/dist/rest/namespaces/video.d.ts +235 -0
- package/dist/rest/namespaces/video.js +297 -0
- package/dist/rest/namespaces/video.js.map +1 -0
- package/{src/rest/pagination.ts → dist/rest/pagination.d.ts} +2 -61
- package/dist/rest/pagination.js +78 -0
- package/dist/rest/pagination.js.map +1 -0
- package/dist/rest/types.d.ts +54 -0
- package/dist/rest/types.js +5 -0
- package/dist/rest/types.js.map +1 -0
- package/dist/skills/SkillBase.d.ts +404 -0
- package/dist/skills/SkillBase.js +471 -0
- package/dist/skills/SkillBase.js.map +1 -0
- package/dist/skills/SkillManager.d.ts +195 -0
- package/dist/skills/SkillManager.js +378 -0
- package/dist/skills/SkillManager.js.map +1 -0
- package/dist/skills/SkillRegistry.d.ts +176 -0
- package/dist/skills/SkillRegistry.js +310 -0
- package/dist/skills/SkillRegistry.js.map +1 -0
- package/dist/skills/builtin/api_ninjas_trivia.d.ts +47 -0
- package/dist/skills/builtin/api_ninjas_trivia.js +211 -0
- package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -0
- package/dist/skills/builtin/ask_claude.d.ts +37 -0
- package/dist/skills/builtin/ask_claude.js +162 -0
- package/dist/skills/builtin/ask_claude.js.map +1 -0
- package/dist/skills/builtin/claude_skills.d.ts +75 -0
- package/dist/skills/builtin/claude_skills.js +753 -0
- package/dist/skills/builtin/claude_skills.js.map +1 -0
- package/dist/skills/builtin/custom_skills.d.ts +79 -0
- package/dist/skills/builtin/custom_skills.js +227 -0
- package/dist/skills/builtin/custom_skills.js.map +1 -0
- package/dist/skills/builtin/datasphere.d.ts +73 -0
- package/dist/skills/builtin/datasphere.js +350 -0
- package/dist/skills/builtin/datasphere.js.map +1 -0
- package/dist/skills/builtin/datasphere_serverless.d.ts +89 -0
- package/dist/skills/builtin/datasphere_serverless.js +291 -0
- package/dist/skills/builtin/datasphere_serverless.js.map +1 -0
- package/dist/skills/builtin/datetime.d.ts +40 -0
- package/dist/skills/builtin/datetime.js +118 -0
- package/dist/skills/builtin/datetime.js.map +1 -0
- package/dist/skills/builtin/google_maps.d.ts +48 -0
- package/dist/skills/builtin/google_maps.js +470 -0
- package/dist/skills/builtin/google_maps.js.map +1 -0
- package/dist/skills/builtin/index.d.ts +31 -0
- package/{src/skills/builtin/index.ts → dist/skills/builtin/index.js} +30 -36
- package/dist/skills/builtin/index.js.map +1 -0
- package/dist/skills/builtin/info_gatherer.d.ts +115 -0
- package/dist/skills/builtin/info_gatherer.js +328 -0
- package/dist/skills/builtin/info_gatherer.js.map +1 -0
- package/dist/skills/builtin/joke.d.ts +41 -0
- package/dist/skills/builtin/joke.js +156 -0
- package/dist/skills/builtin/joke.js.map +1 -0
- package/dist/skills/builtin/math.d.ts +39 -0
- package/dist/skills/builtin/math.js +119 -0
- package/dist/skills/builtin/math.js.map +1 -0
- package/dist/skills/builtin/mcp_gateway.d.ts +82 -0
- package/dist/skills/builtin/mcp_gateway.js +574 -0
- package/dist/skills/builtin/mcp_gateway.js.map +1 -0
- package/dist/skills/builtin/native_vector_search.d.ts +128 -0
- package/dist/skills/builtin/native_vector_search.js +752 -0
- package/dist/skills/builtin/native_vector_search.js.map +1 -0
- package/dist/skills/builtin/play_background_file.d.ts +59 -0
- package/dist/skills/builtin/play_background_file.js +274 -0
- package/dist/skills/builtin/play_background_file.js.map +1 -0
- package/dist/skills/builtin/spider.d.ts +91 -0
- package/dist/skills/builtin/spider.js +758 -0
- package/dist/skills/builtin/spider.js.map +1 -0
- package/dist/skills/builtin/swml_transfer.d.ts +66 -0
- package/dist/skills/builtin/swml_transfer.js +475 -0
- package/dist/skills/builtin/swml_transfer.js.map +1 -0
- package/dist/skills/builtin/weather_api.d.ts +59 -0
- package/dist/skills/builtin/weather_api.js +196 -0
- package/dist/skills/builtin/weather_api.js.map +1 -0
- package/dist/skills/builtin/web_search.d.ts +160 -0
- package/dist/skills/builtin/web_search.js +894 -0
- package/dist/skills/builtin/web_search.js.map +1 -0
- package/dist/skills/builtin/wikipedia_search.d.ts +77 -0
- package/dist/skills/builtin/wikipedia_search.js +241 -0
- package/dist/skills/builtin/wikipedia_search.js.map +1 -0
- package/{src/skills/index.ts → dist/skills/index.d.ts} +0 -1
- package/dist/skills/index.js +10 -0
- package/dist/skills/index.js.map +1 -0
- package/dist/types.d.ts +118 -0
- package/dist/types.js +5 -0
- package/dist/types.js.map +1 -0
- package/package.json +7 -1
- package/.github/workflows/publish.yml +0 -27
- package/.github/workflows/test.yml +0 -17
- package/CLAUDE.md +0 -112
- package/docs/MIGRATION-2.0.md +0 -81
- package/docs/agent-guide.md +0 -869
- package/docs/agent_guide.md +0 -1026
- package/docs/api-reference.md +0 -2420
- package/docs/api_reference.md +0 -1301
- package/docs/architecture.md +0 -843
- package/docs/cli-guide.md +0 -579
- package/docs/cli_guide.md +0 -448
- package/docs/cloud_functions_guide.md +0 -474
- package/docs/configuration.md +0 -422
- package/docs/contexts-guide.md +0 -787
- package/docs/contexts_guide.md +0 -511
- package/docs/datamap-guide.md +0 -1141
- package/docs/datamap_guide.md +0 -595
- package/docs/llm_parameters.md +0 -239
- package/docs/mcp_gateway_reference.md +0 -648
- package/docs/mcp_integration.md +0 -108
- package/docs/prefabs-guide.md +0 -800
- package/docs/sdk_features.md +0 -477
- package/docs/security.md +0 -436
- package/docs/serverless-guide.md +0 -513
- package/docs/skills-guide.md +0 -857
- package/docs/skills-system.md +0 -301
- package/docs/skills_parameter_schema.md +0 -392
- package/docs/skills_system.md +0 -467
- package/docs/swaig-reference.md +0 -1627
- package/docs/swaig_reference.md +0 -910
- package/docs/swml_service_guide.md +0 -600
- package/docs/third_party_skills.md +0 -533
- package/docs/web_service.md +0 -677
- package/examples/README.md +0 -131
- package/examples/advanced-datamap.ts +0 -100
- package/examples/advanced-dynamic-config.ts +0 -70
- package/examples/auto-vivified.ts +0 -94
- package/examples/call-flow.ts +0 -63
- package/examples/comprehensive-dynamic.ts +0 -125
- package/examples/contexts-steps.ts +0 -65
- package/examples/custom-path.ts +0 -45
- package/examples/datamap-tools.ts +0 -55
- package/examples/datasphere-multi-instance.ts +0 -63
- package/examples/datasphere-serverless-env.ts +0 -68
- package/examples/datasphere-webhook-env.ts +0 -66
- package/examples/datasphere.ts +0 -37
- package/examples/declarative.ts +0 -100
- package/examples/dynamic-config.ts +0 -54
- package/examples/dynamic-info-gatherer.ts +0 -69
- package/examples/dynamic-swml-service.ts +0 -67
- package/examples/gather-info.ts +0 -71
- package/examples/gather-per-question-functions-demo.ts +0 -140
- package/examples/joke-agent.ts +0 -34
- package/examples/kubernetes-agent.ts +0 -45
- package/examples/llm-params.ts +0 -69
- package/examples/mcp-agent.ts +0 -84
- package/examples/mcp-gateway.ts +0 -35
- package/examples/multi-agent.ts +0 -73
- package/examples/multi-endpoint.ts +0 -79
- package/examples/pom-prompt.ts +0 -71
- package/examples/prefab-concierge.ts +0 -47
- package/examples/prefab-faq.ts +0 -54
- package/examples/prefab-info-gatherer.ts +0 -33
- package/examples/prefab-receptionist.ts +0 -36
- package/examples/prefab-survey.ts +0 -68
- package/examples/record-call.ts +0 -67
- package/examples/relay-demo.ts +0 -33
- package/examples/room-and-sip.ts +0 -94
- package/examples/serverless-lambda.ts +0 -35
- package/examples/session-state.ts +0 -83
- package/examples/simple-agent.ts +0 -36
- package/examples/simple-static.ts +0 -29
- package/examples/skills-demo.ts +0 -38
- package/examples/step-function-inheritance-demo.ts +0 -124
- package/examples/swaig-features.ts +0 -187
- package/examples/swml-service-routing.ts +0 -66
- package/examples/swml-service.ts +0 -38
- package/examples/tap.ts +0 -68
- package/examples/verb-methods.ts +0 -45
- package/examples/web-search-multi-instance.ts +0 -72
- package/examples/web-search.ts +0 -38
- package/examples/wikipedia.ts +0 -36
- package/livewire/README.md +0 -140
- package/livewire/docs/migration-guide.md +0 -228
- package/livewire/examples/livewire-basic-agent.ts +0 -74
- package/livewire/examples/livewire-handoff.ts +0 -197
- package/livewire/examples/livewire-multi-tool.ts +0 -117
- package/relay/README.md +0 -70
- package/relay/RELAY_IMPLEMENTATION_GUIDE.md +0 -1257
- package/relay/docs/call-methods.md +0 -474
- package/relay/docs/client-reference.md +0 -142
- package/relay/docs/events.md +0 -134
- package/relay/docs/getting-started.md +0 -134
- package/relay/docs/guide.md +0 -306
- package/relay/docs/messaging.md +0 -182
- package/relay/examples/relay-inbound.ts +0 -66
- package/relay/examples/relay-messaging.ts +0 -71
- package/relay/examples/relay-outbound.ts +0 -76
- package/rest/README.md +0 -95
- package/rest/docs/calling.md +0 -273
- package/rest/docs/client-reference.md +0 -107
- package/rest/docs/compat.md +0 -204
- package/rest/docs/fabric.md +0 -183
- package/rest/docs/getting-started.md +0 -110
- package/rest/docs/guide.md +0 -351
- package/rest/docs/namespaces.md +0 -285
- package/rest/examples/rest-10dlc-registration.ts +0 -161
- package/rest/examples/rest-calling-ivr-and-ai.ts +0 -102
- package/rest/examples/rest-calling-play-and-record.ts +0 -91
- package/rest/examples/rest-client.ts +0 -65
- package/rest/examples/rest-compat-laml.ts +0 -210
- package/rest/examples/rest-datasphere-search.ts +0 -82
- package/rest/examples/rest-fabric-conferences-and-routing.ts +0 -144
- package/rest/examples/rest-fabric-subscribers-and-sip.ts +0 -108
- package/rest/examples/rest-fabric-swml-and-callflows.ts +0 -99
- package/rest/examples/rest-manage-resources.ts +0 -65
- package/rest/examples/rest-phone-number-management.ts +0 -197
- package/rest/examples/rest-queues-mfa-and-recordings.ts +0 -143
- package/rest/examples/rest-video-rooms.ts +0 -186
- package/src/AgentBase.ts +0 -2598
- package/src/AgentServer.ts +0 -442
- package/src/AuthHandler.ts +0 -256
- package/src/ConfigLoader.ts +0 -447
- package/src/ContextBuilder.ts +0 -1181
- package/src/DataMap.ts +0 -477
- package/src/FunctionResult.ts +0 -903
- package/src/Logger.ts +0 -337
- package/src/PomBuilder.ts +0 -467
- package/src/PromptManager.ts +0 -133
- package/src/SWMLHandler.ts +0 -298
- package/src/SWMLService.ts +0 -749
- package/src/SchemaUtils.ts +0 -361
- package/src/ServerlessAdapter.ts +0 -240
- package/src/SessionManager.ts +0 -311
- package/src/SslConfig.ts +0 -118
- package/src/SwaigFunction.ts +0 -276
- package/src/SwmlBuilder.ts +0 -283
- package/src/SwmlVerbMethods.generated.ts +0 -234
- package/src/TypeInference.ts +0 -199
- package/src/WebService.ts +0 -641
- package/src/cli/agent-loader.ts +0 -166
- package/src/cli/mock-data.ts +0 -111
- package/src/cli/swaig-test.ts +0 -452
- package/src/generateVerbTypes.ts +0 -322
- package/src/livewire/index.ts +0 -1252
- package/src/prefabs/ConciergeAgent.ts +0 -309
- package/src/prefabs/FAQBotAgent.ts +0 -415
- package/src/prefabs/InfoGathererAgent.ts +0 -379
- package/src/prefabs/ReceptionistAgent.ts +0 -395
- package/src/prefabs/SurveyAgent.ts +0 -671
- package/src/relay/Action.ts +0 -482
- package/src/relay/Call.ts +0 -1270
- package/src/relay/Deferred.ts +0 -94
- package/src/relay/Message.ts +0 -199
- package/src/relay/RelayClient.ts +0 -1185
- package/src/relay/RelayError.ts +0 -20
- package/src/relay/RelayEvent.ts +0 -944
- package/src/relay/index.ts +0 -123
- package/src/relay/types.ts +0 -149
- package/src/rest/HttpClient.ts +0 -164
- package/src/rest/RestError.ts +0 -45
- package/src/rest/base/BaseResource.ts +0 -32
- package/src/rest/base/CrudResource.ts +0 -98
- package/src/rest/base/CrudWithAddresses.ts +0 -37
- package/src/rest/namespaces/addresses.ts +0 -64
- package/src/rest/namespaces/calling.ts +0 -534
- package/src/rest/namespaces/chat.ts +0 -31
- package/src/rest/namespaces/compat.ts +0 -812
- package/src/rest/namespaces/datasphere.ts +0 -88
- package/src/rest/namespaces/fabric.ts +0 -417
- package/src/rest/namespaces/imported-numbers.ts +0 -31
- package/src/rest/namespaces/logs.ts +0 -151
- package/src/rest/namespaces/lookup.ts +0 -38
- package/src/rest/namespaces/mfa.ts +0 -61
- package/src/rest/namespaces/number-groups.ts +0 -68
- package/src/rest/namespaces/phone-numbers.ts +0 -76
- package/src/rest/namespaces/project.ts +0 -65
- package/src/rest/namespaces/pubsub.ts +0 -31
- package/src/rest/namespaces/queues.ts +0 -58
- package/src/rest/namespaces/recordings.ts +0 -53
- package/src/rest/namespaces/registry.ts +0 -200
- package/src/rest/namespaces/short-codes.ts +0 -54
- package/src/rest/namespaces/sip-profile.ts +0 -40
- package/src/rest/namespaces/verified-callers.ts +0 -46
- package/src/rest/namespaces/video.ts +0 -332
- package/src/rest/types.ts +0 -61
- package/src/skills/SkillBase.ts +0 -582
- package/src/skills/SkillManager.ts +0 -419
- package/src/skills/SkillRegistry.ts +0 -367
- package/src/skills/builtin/api_ninjas_trivia.ts +0 -285
- package/src/skills/builtin/ask_claude.ts +0 -246
- package/src/skills/builtin/claude_skills.ts +0 -983
- package/src/skills/builtin/custom_skills.ts +0 -327
- package/src/skills/builtin/datasphere.ts +0 -447
- package/src/skills/builtin/datasphere_serverless.ts +0 -347
- package/src/skills/builtin/datetime.ts +0 -137
- package/src/skills/builtin/google_maps.ts +0 -656
- package/src/skills/builtin/info_gatherer.ts +0 -415
- package/src/skills/builtin/joke.ts +0 -196
- package/src/skills/builtin/math.ts +0 -149
- package/src/skills/builtin/mcp_gateway.ts +0 -685
- package/src/skills/builtin/native_vector_search.ts +0 -910
- package/src/skills/builtin/play_background_file.ts +0 -367
- package/src/skills/builtin/spider.ts +0 -874
- package/src/skills/builtin/swml_transfer.ts +0 -645
- package/src/skills/builtin/weather_api.ts +0 -255
- package/src/skills/builtin/web_search.ts +0 -1083
- package/src/skills/builtin/wikipedia_search.ts +0 -304
- package/src/types.ts +0 -132
- package/tests/AgentBase.test.ts +0 -1093
- package/tests/AgentServer.test.ts +0 -126
- package/tests/AuthHandler.test.ts +0 -133
- package/tests/ConfigLoader.test.ts +0 -151
- package/tests/ContextBuilder.test.ts +0 -108
- package/tests/DataMap.test.ts +0 -367
- package/tests/EphemeralSkillCopy.test.ts +0 -107
- package/tests/FunctionResult.test.ts +0 -298
- package/tests/GracefulShutdown.test.ts +0 -46
- package/tests/Logger.test.ts +0 -420
- package/tests/PomBuilder.test.ts +0 -228
- package/tests/ProxyDetection.test.ts +0 -228
- package/tests/SWMLService.test.ts +0 -320
- package/tests/SWMLVerbHandler.test.ts +0 -523
- package/tests/SchemaUtils.test.ts +0 -106
- package/tests/SchemaUtils.verb.test.ts +0 -206
- package/tests/SecurityUtils.test.ts +0 -192
- package/tests/ServerlessAdapter.test.ts +0 -222
- package/tests/SessionManager.test.ts +0 -257
- package/tests/SkillBaseFeatures.test.ts +0 -130
- package/tests/SkillMultiInstance.test.ts +0 -102
- package/tests/SkillParameterSchemas.test.ts +0 -134
- package/tests/SkillRegistrySchema.test.ts +0 -84
- package/tests/SslConfig.test.ts +0 -97
- package/tests/SwmlBuilder.test.ts +0 -400
- package/tests/TypeInference.test.ts +0 -165
- package/tests/VerbHandlerRegistry.test.ts +0 -128
- package/tests/cli/mock-data.test.ts +0 -113
- package/tests/cli/swaig-test.test.ts +0 -108
- package/tests/examples.test.ts +0 -194
- package/tests/fixtures/scrape-parity/README.md +0 -53
- package/tests/fixtures/scrape-parity/expected/01_simple_article.json +0 -5
- package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +0 -5
- package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +0 -5
- package/tests/fixtures/scrape-parity/expected/04_bare_body.json +0 -5
- package/tests/fixtures/scrape-parity/expected/05_malformed.json +0 -5
- package/tests/fixtures/scrape-parity/expected/06_multi_class.json +0 -5
- package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +0 -5
- package/tests/fixtures/scrape-parity/expected/08_inline_script.json +0 -5
- package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +0 -5
- package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +0 -5
- package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +0 -5
- package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +0 -5
- package/tests/fixtures/scrape-parity/html/01_simple_article.html +0 -18
- package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +0 -18
- package/tests/fixtures/scrape-parity/html/03_nested_containers.html +0 -13
- package/tests/fixtures/scrape-parity/html/04_bare_body.html +0 -9
- package/tests/fixtures/scrape-parity/html/05_malformed.html +0 -11
- package/tests/fixtures/scrape-parity/html/06_multi_class.html +0 -18
- package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +0 -12
- package/tests/fixtures/scrape-parity/html/08_inline_script.html +0 -17
- package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +0 -21
- package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +0 -10
- package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +0 -13
- package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +0 -24
- package/tests/fixtures/scrape-parity/python_extract.py +0 -109
- package/tests/livewire/livewire.test.ts +0 -780
- package/tests/mcp.test.ts +0 -221
- package/tests/prefabs/prefabs.test.ts +0 -1093
- package/tests/relay/Action.test.ts +0 -392
- package/tests/relay/Call.test.ts +0 -535
- package/tests/relay/Deferred.test.ts +0 -71
- package/tests/relay/Message.test.ts +0 -164
- package/tests/relay/RelayClient.test.ts +0 -779
- package/tests/relay/RelayEvent.test.ts +0 -463
- package/tests/relay/helpers.ts +0 -79
- package/tests/rest/HttpClient.test.ts +0 -274
- package/tests/rest/RestError.test.ts +0 -53
- package/tests/rest/calling.test.ts +0 -156
- package/tests/rest/client.test.ts +0 -197
- package/tests/rest/compat.test.ts +0 -335
- package/tests/rest/datasphere.test.ts +0 -71
- package/tests/rest/fabric.test.ts +0 -186
- package/tests/rest/helpers.ts +0 -95
- package/tests/rest/logs.test.ts +0 -68
- package/tests/rest/pagination.test.ts +0 -133
- package/tests/rest/registry.test.ts +0 -94
- package/tests/rest/relay-rest.test.ts +0 -290
- package/tests/rest/video.test.ts +0 -173
- package/tests/setup.ts +0 -6
- package/tests/skills/SkillBase.test.ts +0 -108
- package/tests/skills/SkillManager.test.ts +0 -268
- package/tests/skills/SkillRegistry.test.ts +0 -176
- package/tests/skills/builtin.test.ts +0 -1472
- package/tests/skills/claude-skills.test.ts +0 -54
- package/tests/skills/custom-skills.test.ts +0 -53
- package/tests/skills/datasphere-serverless.test.ts +0 -70
- package/tests/skills/datasphere.test.ts +0 -107
- package/tests/skills/datetime.test.ts +0 -101
- package/tests/skills/google-maps.test.ts +0 -78
- package/tests/skills/info-gatherer.test.ts +0 -411
- package/tests/skills/joke.test.ts +0 -81
- package/tests/skills/math.test.ts +0 -68
- package/tests/skills/mcp-gateway.test.ts +0 -101
- package/tests/skills/play-background.test.ts +0 -54
- package/tests/skills/spider.test.ts +0 -108
- package/tests/skills/swml-transfer.test.ts +0 -178
- package/tests/skills/trivia.test.ts +0 -54
- package/tests/skills/vector-search.test.ts +0 -135
- package/tests/skills/weather-api.test.ts +0 -77
- package/tests/skills/web-search-parity.test.ts +0 -59
- package/tests/skills/web-search.test.ts +0 -103
- package/tests/skills/wikipedia.test.ts +0 -63
- package/tsconfig.json +0 -18
- package/vitest.config.ts +0 -9
- /package/{src → dist}/schema.json +0 -0
|
@@ -0,0 +1,326 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* SWMLService - Lightweight HTTP service for non-AI SWML documents.
|
|
3
|
+
*
|
|
4
|
+
* Unlike AgentBase (which always produces an AI block), SWMLService generates
|
|
5
|
+
* pure SWML call-flow documents: IVR menus, voicemail, call recording, etc.
|
|
6
|
+
* Uses SwmlBuilder for verb methods and Hono for HTTP serving.
|
|
7
|
+
*/
|
|
8
|
+
import { Hono } from 'hono';
|
|
9
|
+
import { SwmlBuilder } from './SwmlBuilder.js';
|
|
10
|
+
import { SchemaUtils } from './SchemaUtils.js';
|
|
11
|
+
import { Logger } from './Logger.js';
|
|
12
|
+
/**
|
|
13
|
+
* Interface for custom SWML verb handlers.
|
|
14
|
+
* Mirrors Python SDK's `SWMLVerbHandler` abstract base class.
|
|
15
|
+
*/
|
|
16
|
+
export interface SWMLVerbHandler {
|
|
17
|
+
/** Return the verb name this handler manages. */
|
|
18
|
+
getVerbName(): string;
|
|
19
|
+
/** Validate a verb configuration. Returns [isValid, errorMessages]. */
|
|
20
|
+
validateConfig(config: Record<string, unknown>): [boolean, string[]];
|
|
21
|
+
/** Build a verb configuration from keyword arguments. */
|
|
22
|
+
buildConfig(kwargs: Record<string, unknown>): Record<string, unknown>;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Registry for custom SWML verb handlers.
|
|
26
|
+
* Mirrors Python SDK's `VerbHandlerRegistry`.
|
|
27
|
+
*/
|
|
28
|
+
export declare class VerbHandlerRegistry {
|
|
29
|
+
private handlers;
|
|
30
|
+
/** Register a custom verb handler. */
|
|
31
|
+
registerHandler(handler: SWMLVerbHandler): void;
|
|
32
|
+
/** Get the handler for a specific verb, or undefined if none registered. */
|
|
33
|
+
getHandler(verbName: string): SWMLVerbHandler | undefined;
|
|
34
|
+
/** Check whether a handler exists for the given verb. */
|
|
35
|
+
hasHandler(verbName: string): boolean;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Unified security configuration.
|
|
39
|
+
* Mirrors Python SDK's `SecurityConfig` — reads from env vars and optional config file.
|
|
40
|
+
*/
|
|
41
|
+
export declare class SecurityConfig {
|
|
42
|
+
/** Whether SSL is enabled. */
|
|
43
|
+
sslEnabled: boolean;
|
|
44
|
+
/** Filesystem path to the PEM certificate. */
|
|
45
|
+
sslCertPath: string | null;
|
|
46
|
+
/** Filesystem path to the PEM private key. */
|
|
47
|
+
sslKeyPath: string | null;
|
|
48
|
+
/** Domain name for SSL. */
|
|
49
|
+
domain: string | null;
|
|
50
|
+
/** Basic auth username from config, or null. */
|
|
51
|
+
basicAuthUser: string | null;
|
|
52
|
+
/** Basic auth password from config, or null. */
|
|
53
|
+
basicAuthPassword: string | null;
|
|
54
|
+
private sslConfig;
|
|
55
|
+
constructor(opts?: {
|
|
56
|
+
configFile?: string;
|
|
57
|
+
serviceName?: string;
|
|
58
|
+
});
|
|
59
|
+
private loadFromConfigFile;
|
|
60
|
+
/** Get basic auth credentials from security config, or null if not configured. */
|
|
61
|
+
getBasicAuth(): [string, string] | null;
|
|
62
|
+
/** Validate that SSL cert and key files are present when SSL is enabled. */
|
|
63
|
+
validateSslConfig(): [boolean, string | null];
|
|
64
|
+
}
|
|
65
|
+
/** Callback invoked per-request to dynamically build SWML. */
|
|
66
|
+
export type OnRequestCallback = (queryParams: Record<string, string>, bodyParams: Record<string, unknown>, headers: Record<string, string>) => SwmlBuilder | Promise<SwmlBuilder>;
|
|
67
|
+
type RoutingCallback = (requestBody: Record<string, unknown>) => string | null | undefined | Promise<string | null | undefined>;
|
|
68
|
+
/** Configuration options for SWMLService. */
|
|
69
|
+
export interface SWMLServiceOptions {
|
|
70
|
+
/**
|
|
71
|
+
* Service display name.
|
|
72
|
+
* Required to match Python SDK where `name` is a positional required parameter.
|
|
73
|
+
*/
|
|
74
|
+
name: string;
|
|
75
|
+
/** HTTP route path (default '/'). */
|
|
76
|
+
route?: string;
|
|
77
|
+
/** Host to bind the web server to (default '0.0.0.0'). */
|
|
78
|
+
host?: string;
|
|
79
|
+
/** Port to bind the web server to (default PORT env var or 3000). */
|
|
80
|
+
port?: number;
|
|
81
|
+
/** Basic auth credentials as [username, password]. */
|
|
82
|
+
basicAuth?: [string, string];
|
|
83
|
+
/** Path to a JSON Schema file for verb validation. */
|
|
84
|
+
schemaPath?: string;
|
|
85
|
+
/** Path to a security configuration file. */
|
|
86
|
+
configFile?: string;
|
|
87
|
+
/** Enable schema validation (default true). Can also be disabled via SWML_SKIP_SCHEMA_VALIDATION=true. */
|
|
88
|
+
schemaValidation?: boolean;
|
|
89
|
+
}
|
|
90
|
+
/**
|
|
91
|
+
* HTTP service that serves non-AI SWML documents built from verb methods.
|
|
92
|
+
*
|
|
93
|
+
* Use `SWMLService` when you need a SignalWire call flow but don't need AI —
|
|
94
|
+
* plain call routing, IVR-style trees, recording workflows, static playback, etc.
|
|
95
|
+
* For AI-powered voice agents, use {@link AgentBase} instead.
|
|
96
|
+
*
|
|
97
|
+
* @example Static greeting that plays a file and hangs up
|
|
98
|
+
* ```ts
|
|
99
|
+
* import { SWMLService } from '@signalwire/sdk';
|
|
100
|
+
*
|
|
101
|
+
* const service = new SWMLService({ name: 'greeter', route: '/', port: 3000 });
|
|
102
|
+
* service.builder
|
|
103
|
+
* .answer()
|
|
104
|
+
* .play({ url: 'https://cdn.example.com/welcome.mp3' })
|
|
105
|
+
* .hangup();
|
|
106
|
+
*
|
|
107
|
+
* await service.serve();
|
|
108
|
+
* ```
|
|
109
|
+
*
|
|
110
|
+
* @see {@link SwmlBuilder} — the underlying SWML document builder
|
|
111
|
+
* @see {@link AgentBase} — AI-powered alternative
|
|
112
|
+
*/
|
|
113
|
+
export declare class SWMLService {
|
|
114
|
+
/** Service display name. */
|
|
115
|
+
readonly name: string;
|
|
116
|
+
/** HTTP route path. */
|
|
117
|
+
readonly route: string;
|
|
118
|
+
/** Host the server binds to. */
|
|
119
|
+
readonly host: string;
|
|
120
|
+
/** Port the server binds to. */
|
|
121
|
+
readonly port: number;
|
|
122
|
+
/** Structured logger, exposed for subclass access. Mirrors Python's public `self.log`. */
|
|
123
|
+
readonly log: Logger;
|
|
124
|
+
/** Unified security configuration. Mirrors Python's `self.security`. */
|
|
125
|
+
readonly security: SecurityConfig;
|
|
126
|
+
/** Whether SSL is enabled. Mirrors Python's `self.ssl_enabled`. */
|
|
127
|
+
readonly sslEnabled: boolean;
|
|
128
|
+
/** Domain name for SSL. Mirrors Python's `self.domain`. */
|
|
129
|
+
readonly domain: string | undefined;
|
|
130
|
+
/** Path to SSL certificate. Mirrors Python's `self.ssl_cert_path`. */
|
|
131
|
+
readonly sslCertPath: string | undefined;
|
|
132
|
+
/** Path to SSL private key. Mirrors Python's `self.ssl_key_path`. */
|
|
133
|
+
readonly sslKeyPath: string | undefined;
|
|
134
|
+
/** Schema validation utilities. Mirrors Python's `self.schema_utils`. */
|
|
135
|
+
readonly schemaUtils: SchemaUtils;
|
|
136
|
+
/** Custom verb handler registry. Mirrors Python's `self.verb_registry`. */
|
|
137
|
+
readonly verbRegistry: VerbHandlerRegistry;
|
|
138
|
+
private swmlBuilder;
|
|
139
|
+
private _app;
|
|
140
|
+
private _server;
|
|
141
|
+
private onRequestCallback?;
|
|
142
|
+
private authCredentials?;
|
|
143
|
+
private authSource;
|
|
144
|
+
private _proxyUrlBase;
|
|
145
|
+
private _proxyUrlBaseFromEnv;
|
|
146
|
+
private _routingCallbacks;
|
|
147
|
+
constructor(opts: SWMLServiceOptions);
|
|
148
|
+
/** @deprecated Prefer passing an options object with a required `name`. The no-arg form defaults name to 'swml-service'. */
|
|
149
|
+
constructor(opts?: Partial<SWMLServiceOptions>);
|
|
150
|
+
/**
|
|
151
|
+
* Check if full JSON Schema validation is enabled.
|
|
152
|
+
* Mirrors Python's `@property full_validation_enabled`.
|
|
153
|
+
* @returns True if schema-based verb validation is active.
|
|
154
|
+
*/
|
|
155
|
+
get fullValidationEnabled(): boolean;
|
|
156
|
+
/**
|
|
157
|
+
* Get the underlying SwmlBuilder for direct manipulation.
|
|
158
|
+
* @returns The SwmlBuilder instance.
|
|
159
|
+
*/
|
|
160
|
+
getBuilder(): SwmlBuilder;
|
|
161
|
+
/**
|
|
162
|
+
* Add a verb to the SWML document.
|
|
163
|
+
* @param name - Verb name (e.g., 'answer', 'play', 'hangup').
|
|
164
|
+
* @param config - Verb configuration.
|
|
165
|
+
* @returns This service for chaining.
|
|
166
|
+
*/
|
|
167
|
+
addVerb(name: string, config: unknown): this;
|
|
168
|
+
/**
|
|
169
|
+
* Add a new named section to the SWML document.
|
|
170
|
+
* Mirrors Python's `add_section()`.
|
|
171
|
+
* @param sectionName - Name of the section to create.
|
|
172
|
+
* @returns This service for chaining.
|
|
173
|
+
*/
|
|
174
|
+
addSection(sectionName: string): this;
|
|
175
|
+
/**
|
|
176
|
+
* Add a verb to a specific named section.
|
|
177
|
+
* Mirrors Python's `add_verb_to_section()`.
|
|
178
|
+
* @param sectionName - Target section name (auto-created if missing).
|
|
179
|
+
* @param verbName - Verb name.
|
|
180
|
+
* @param config - Verb configuration.
|
|
181
|
+
* @returns This service for chaining.
|
|
182
|
+
*/
|
|
183
|
+
addVerbToSection(sectionName: string, verbName: string, config: unknown): this;
|
|
184
|
+
/**
|
|
185
|
+
* Reset the SWML document to an empty state.
|
|
186
|
+
* Mirrors Python's `reset_document()`.
|
|
187
|
+
* @returns This service for chaining.
|
|
188
|
+
*/
|
|
189
|
+
resetDocument(): this;
|
|
190
|
+
/**
|
|
191
|
+
* Render the SWML document as a JSON object.
|
|
192
|
+
* @returns The SWML document.
|
|
193
|
+
*/
|
|
194
|
+
renderSwml(): Record<string, unknown>;
|
|
195
|
+
/**
|
|
196
|
+
* Get the SWML document as a dictionary.
|
|
197
|
+
* Alias for `renderSwml()` that matches Python's `get_document()` name.
|
|
198
|
+
* @returns The SWML document.
|
|
199
|
+
*/
|
|
200
|
+
getDocument(): Record<string, unknown>;
|
|
201
|
+
/**
|
|
202
|
+
* Render the SWML document as a JSON string.
|
|
203
|
+
* Mirrors Python's `render_document()`.
|
|
204
|
+
* @returns JSON-encoded SWML document.
|
|
205
|
+
*/
|
|
206
|
+
renderDocument(): string;
|
|
207
|
+
/**
|
|
208
|
+
* Register a custom verb handler.
|
|
209
|
+
* Mirrors Python's `register_verb_handler()`.
|
|
210
|
+
* @param handler - The verb handler to register.
|
|
211
|
+
*/
|
|
212
|
+
registerVerbHandler(handler: SWMLVerbHandler): void;
|
|
213
|
+
/**
|
|
214
|
+
* Register a routing callback at a given path.
|
|
215
|
+
* When a POST request arrives at `path`, the callback is invoked with the
|
|
216
|
+
* parsed request body. If it returns a string, the response is a 307 redirect
|
|
217
|
+
* to that route; if it returns null, normal SWML serving continues.
|
|
218
|
+
* Mirrors Python's `register_routing_callback()`.
|
|
219
|
+
*
|
|
220
|
+
* @param callbackFn - Callback receiving the request body and returning a route or null.
|
|
221
|
+
* @param path - HTTP path for the callback (default '/sip').
|
|
222
|
+
*/
|
|
223
|
+
registerRoutingCallback(callbackFn: RoutingCallback, path?: string): void;
|
|
224
|
+
/**
|
|
225
|
+
* Extract the SIP username from a request body's call.to field.
|
|
226
|
+
* Mirrors Python's `@staticmethod extract_sip_username()`.
|
|
227
|
+
* @param requestBody - The parsed request body containing call information.
|
|
228
|
+
* @returns The extracted SIP username, or null if not found.
|
|
229
|
+
*/
|
|
230
|
+
static extractSipUsername(requestBody: Record<string, unknown>): string | null;
|
|
231
|
+
/**
|
|
232
|
+
* Protected override hook called on every inbound SWML request.
|
|
233
|
+
* Mirrors Python SDK's `on_request(request_data, callback_path)` subclass
|
|
234
|
+
* override pattern. Subclasses return a `SwmlBuilder` to use for this
|
|
235
|
+
* request, or `null` to fall through to `setOnRequestCallback` or the
|
|
236
|
+
* static builder.
|
|
237
|
+
*
|
|
238
|
+
* Default implementation returns `null` (no-op), preserving existing
|
|
239
|
+
* behaviour for classes that do not override.
|
|
240
|
+
*
|
|
241
|
+
* @param queryParams - URL query parameters from the request.
|
|
242
|
+
* @param bodyParams - Parsed POST body (empty object for GET requests).
|
|
243
|
+
* @param headers - HTTP request headers.
|
|
244
|
+
* @param callbackPath - The callback sub-path being handled, if any.
|
|
245
|
+
* @returns A `SwmlBuilder` whose document is sent as the response, or
|
|
246
|
+
* `null` to delegate to the next handler in the chain.
|
|
247
|
+
*/
|
|
248
|
+
protected onRequest(_queryParams: Record<string, string>, _bodyParams: Record<string, unknown>, _headers: Record<string, string>, _callbackPath?: string): SwmlBuilder | null;
|
|
249
|
+
/**
|
|
250
|
+
* Set a callback invoked per-request to dynamically build SWML.
|
|
251
|
+
* When set, the static SwmlBuilder is ignored and the callback's
|
|
252
|
+
* returned SwmlBuilder is used instead.
|
|
253
|
+
* @param cb - Callback receiving query params, body params, and headers.
|
|
254
|
+
* @returns This service for chaining.
|
|
255
|
+
*/
|
|
256
|
+
setOnRequestCallback(cb: OnRequestCallback): this;
|
|
257
|
+
/**
|
|
258
|
+
* Get the basic-auth credentials used by this service.
|
|
259
|
+
* Mirrors Python's `get_basic_auth_credentials()`.
|
|
260
|
+
* @param includeSource - When true, a third element indicating the credential source is appended.
|
|
261
|
+
* @returns A tuple of [username, password] or [username, password, source].
|
|
262
|
+
*/
|
|
263
|
+
getBasicAuthCredentials(includeSource?: false): [string, string];
|
|
264
|
+
getBasicAuthCredentials(includeSource: true): [string, string, 'provided' | 'environment' | 'auto-generated'];
|
|
265
|
+
/**
|
|
266
|
+
* Manually set the proxy base URL used for webhook URL generation.
|
|
267
|
+
* Mirrors Python's `manual_set_proxy_url()`.
|
|
268
|
+
* @param url - The external-facing base URL (trailing slashes are stripped).
|
|
269
|
+
* @returns This service for chaining.
|
|
270
|
+
*/
|
|
271
|
+
manualSetProxyUrl(url: string): this;
|
|
272
|
+
/**
|
|
273
|
+
* Get the Hono application for mounting or testing.
|
|
274
|
+
* This is the TypeScript equivalent of Python's `as_router()`, which returns
|
|
275
|
+
* a FastAPI `APIRouter`. Both expose the underlying app/router so callers can
|
|
276
|
+
* mount it into a larger framework. Use `asRouter()` when porting Python code
|
|
277
|
+
* that calls `as_router()` directly.
|
|
278
|
+
* @returns The configured Hono app.
|
|
279
|
+
*/
|
|
280
|
+
getApp(): Hono;
|
|
281
|
+
/**
|
|
282
|
+
* Alias for `getApp()`. Provided for cross-SDK consistency with Python's
|
|
283
|
+
* `as_router()` method — allows Python callers porting to TypeScript to use
|
|
284
|
+
* the familiar name without changes.
|
|
285
|
+
* @returns The configured Hono app.
|
|
286
|
+
*/
|
|
287
|
+
asRouter(): Hono;
|
|
288
|
+
/**
|
|
289
|
+
* Start the HTTP server.
|
|
290
|
+
*
|
|
291
|
+
* Matches Python's `serve()` parameters including SSL options. When
|
|
292
|
+
* `SWAIG_CLI_MODE=true` is set in the environment (e.g. while running the
|
|
293
|
+
* `swaig-test` CLI) the call is a no-op.
|
|
294
|
+
*
|
|
295
|
+
* @param host - Hostname. Defaults to `this.host` (constructor value) or
|
|
296
|
+
* `'0.0.0.0'`.
|
|
297
|
+
* @param port - Port. Defaults to `this.port` (constructor value) or `3000`.
|
|
298
|
+
* @param opts - Optional SSL/TLS configuration overrides.
|
|
299
|
+
* @param opts.sslCert - Path to the PEM certificate file.
|
|
300
|
+
* @param opts.sslKey - Path to the PEM private key file.
|
|
301
|
+
* @param opts.sslEnabled - When `true`, serve over HTTPS.
|
|
302
|
+
* @param opts.domain - Domain used for HSTS header configuration.
|
|
303
|
+
* @returns Resolves once the server has begun listening.
|
|
304
|
+
*/
|
|
305
|
+
run(host?: string, port?: number, opts?: {
|
|
306
|
+
sslCert?: string;
|
|
307
|
+
sslKey?: string;
|
|
308
|
+
sslEnabled?: boolean;
|
|
309
|
+
domain?: string;
|
|
310
|
+
}): Promise<void>;
|
|
311
|
+
/**
|
|
312
|
+
* Start the HTTP server. Alias for {@link run} provided for cross-SDK
|
|
313
|
+
* consistency with Python's `serve()` method — callers porting from
|
|
314
|
+
* Python can use this name without changes.
|
|
315
|
+
*
|
|
316
|
+
* @param args - Forwarded unchanged to {@link run}.
|
|
317
|
+
* @returns Resolves once the server has begun listening.
|
|
318
|
+
*/
|
|
319
|
+
serve(...args: Parameters<SWMLService['run']>): Promise<void>;
|
|
320
|
+
/**
|
|
321
|
+
* Stop the HTTP server.
|
|
322
|
+
* Mirrors Python's `stop()`.
|
|
323
|
+
*/
|
|
324
|
+
stop(): void;
|
|
325
|
+
}
|
|
326
|
+
export {};
|