@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,159 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* SwaigFunction - Wraps a handler function with metadata for SWAIG registration.
|
|
3
|
+
*/
|
|
4
|
+
import { FunctionResult } from './FunctionResult.js';
|
|
5
|
+
/**
|
|
6
|
+
* Handler function for a SWAIG tool invocation.
|
|
7
|
+
* @param args - Parsed arguments extracted by the AI from user speech.
|
|
8
|
+
* @param rawData - The full raw request payload from SignalWire.
|
|
9
|
+
* @returns A FunctionResult, a plain object with a response key, a string, or a Promise of any of these.
|
|
10
|
+
*/
|
|
11
|
+
export type SwaigHandler = (args: Record<string, unknown>, rawData: Record<string, unknown>) => FunctionResult | Record<string, unknown> | string | Promise<FunctionResult | Record<string, unknown> | string>;
|
|
12
|
+
/** Configuration options for creating a SwaigFunction. */
|
|
13
|
+
export interface SwaigFunctionOptions {
|
|
14
|
+
/** Unique name used to register and invoke this tool. */
|
|
15
|
+
name: string;
|
|
16
|
+
/** The handler function called when the tool is invoked. */
|
|
17
|
+
handler: SwaigHandler;
|
|
18
|
+
/** Human-readable description of what the tool does, shown to the AI. */
|
|
19
|
+
description: string;
|
|
20
|
+
/** JSON Schema properties describing the tool's parameters. */
|
|
21
|
+
parameters?: Record<string, unknown>;
|
|
22
|
+
/** Whether this tool requires session token authentication. */
|
|
23
|
+
secure?: boolean;
|
|
24
|
+
/** Language-keyed filler phrases spoken while the tool executes. */
|
|
25
|
+
fillers?: Record<string, string[]>;
|
|
26
|
+
/** Audio file URL to play while waiting for the tool to complete. */
|
|
27
|
+
waitFile?: string;
|
|
28
|
+
/** Number of times to loop the wait file. */
|
|
29
|
+
waitFileLoops?: number;
|
|
30
|
+
/** External webhook URL; makes this an externally-hosted tool. */
|
|
31
|
+
webhookUrl?: string;
|
|
32
|
+
/** List of required parameter names. */
|
|
33
|
+
required?: string[];
|
|
34
|
+
/**
|
|
35
|
+
* Additional fields to merge directly into the SWAIG function definition.
|
|
36
|
+
*
|
|
37
|
+
* **Python equivalent:** `**extra_swaig_fields` kwargs on the constructor.
|
|
38
|
+
* In Python these are passed as bare keyword arguments and merged directly
|
|
39
|
+
* into the output dict via `function_def.update(self.extra_swaig_fields)`.
|
|
40
|
+
* In TypeScript the same fields are collected under this single options key
|
|
41
|
+
* and merged identically in `toSwaig()` — the wire format is identical.
|
|
42
|
+
*
|
|
43
|
+
* @example
|
|
44
|
+
* ```typescript
|
|
45
|
+
* // Python: SWAIGFunction(..., meta_data_token="abc", web_hook_auth_user="u")
|
|
46
|
+
* new SwaigFunction({
|
|
47
|
+
* ...,
|
|
48
|
+
* extraFields: { meta_data_token: 'abc', web_hook_auth_user: 'u' },
|
|
49
|
+
* });
|
|
50
|
+
* ```
|
|
51
|
+
*/
|
|
52
|
+
extraFields?: Record<string, unknown>;
|
|
53
|
+
/** Whether this tool uses a typed handler with named parameters. */
|
|
54
|
+
isTypedHandler?: boolean;
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* A SWAIG function — exactly the same concept as a "tool" in native
|
|
58
|
+
* OpenAI / Anthropic tool calling.
|
|
59
|
+
*
|
|
60
|
+
* Each SwaigFunction is rendered, on every LLM turn, into the OpenAI
|
|
61
|
+
* tool schema:
|
|
62
|
+
*
|
|
63
|
+
* ```json
|
|
64
|
+
* {
|
|
65
|
+
* "type": "function",
|
|
66
|
+
* "function": {
|
|
67
|
+
* "name": "<this.name>",
|
|
68
|
+
* "description": "<this.description>",
|
|
69
|
+
* "parameters": { "type": "object", "properties": { ... } }
|
|
70
|
+
* }
|
|
71
|
+
* }
|
|
72
|
+
* ```
|
|
73
|
+
*
|
|
74
|
+
* The `name`, `description`, and every per-parameter `description` inside
|
|
75
|
+
* `parameters` are **read by the model** and directly determine whether
|
|
76
|
+
* the model picks this tool when a matching user request comes in.
|
|
77
|
+
* They are prompt engineering, not developer comments.
|
|
78
|
+
*/
|
|
79
|
+
export declare class SwaigFunction {
|
|
80
|
+
/** Unique name — read by the LLM; use snake_case verbs. */
|
|
81
|
+
name: string;
|
|
82
|
+
/** The handler function called when the tool is invoked. */
|
|
83
|
+
handler: SwaigHandler;
|
|
84
|
+
/**
|
|
85
|
+
* LLM-facing description. Tells the model WHEN to call this tool.
|
|
86
|
+
* A vague description is the #1 cause of "model has the tool but
|
|
87
|
+
* doesn't call it" failures.
|
|
88
|
+
*/
|
|
89
|
+
description: string;
|
|
90
|
+
/**
|
|
91
|
+
* JSON Schema properties describing the tool's parameters. Each
|
|
92
|
+
* property's `description` field is ALSO LLM-facing — it tells the
|
|
93
|
+
* model HOW to extract that argument from the user's utterance.
|
|
94
|
+
*/
|
|
95
|
+
parameters: Record<string, unknown>;
|
|
96
|
+
/** Whether this tool requires session token authentication. */
|
|
97
|
+
secure: boolean;
|
|
98
|
+
/** Language-keyed filler phrases spoken while the tool executes. */
|
|
99
|
+
fillers?: Record<string, string[]>;
|
|
100
|
+
/** Audio file URL to play while waiting for the tool to complete. */
|
|
101
|
+
waitFile?: string;
|
|
102
|
+
/** Number of times to loop the wait file. */
|
|
103
|
+
waitFileLoops?: number;
|
|
104
|
+
/** External webhook URL; set when the tool is externally hosted. */
|
|
105
|
+
webhookUrl?: string;
|
|
106
|
+
/** List of required parameter names. */
|
|
107
|
+
required: string[];
|
|
108
|
+
/** Additional fields included in the SWAIG definition output. */
|
|
109
|
+
extraFields: Record<string, unknown>;
|
|
110
|
+
/** Whether this tool uses a typed handler with named parameters. */
|
|
111
|
+
isTypedHandler: boolean;
|
|
112
|
+
/** Whether this tool is externally hosted (has a webhookUrl). */
|
|
113
|
+
isExternal: boolean;
|
|
114
|
+
/**
|
|
115
|
+
* Create a new SwaigFunction.
|
|
116
|
+
*
|
|
117
|
+
* @param opts - Configuration options for the SWAIG function.
|
|
118
|
+
* Use `opts.extraFields` to pass any additional SWAIG-only fields
|
|
119
|
+
* (e.g. `meta_data_token`, `web_hook_auth_user`, `web_hook_auth_password`).
|
|
120
|
+
* This mirrors the Python constructor's `**extra_swaig_fields` kwargs:
|
|
121
|
+
* both are merged directly into the serialized SWAIG definition, so the
|
|
122
|
+
* wire format is identical — only the call-site syntax differs.
|
|
123
|
+
*/
|
|
124
|
+
constructor(opts: SwaigFunctionOptions);
|
|
125
|
+
private ensureParameterStructure;
|
|
126
|
+
/**
|
|
127
|
+
* Validate arguments against the parameter JSON schema using full
|
|
128
|
+
* JSON Schema Draft-7 validation (via ajv).
|
|
129
|
+
*
|
|
130
|
+
* Mirrors Python's `validate_args` which tries `jsonschema_rs` (Rust-based
|
|
131
|
+
* Draft-7 validator) then falls back to `jsonschema` (pure Python Draft-7).
|
|
132
|
+
* All JSON Schema constraint keywords are honoured: `required`, `type`,
|
|
133
|
+
* `minLength`, `maxLength`, `pattern`, `format`, `minimum`, `maximum`,
|
|
134
|
+
* `enum`, `anyOf`, `oneOf`, `$ref`, nested object/array validation, etc.
|
|
135
|
+
*
|
|
136
|
+
* If the schema has no properties, validation is skipped and the args are
|
|
137
|
+
* considered valid — matching Python's early-return path.
|
|
138
|
+
*
|
|
139
|
+
* @param args - Arguments to validate.
|
|
140
|
+
* @returns A tuple of `[isValid, errors]`. When no validation is needed
|
|
141
|
+
* (empty schema), returns `[true, []]`.
|
|
142
|
+
*/
|
|
143
|
+
validateArgs(args: Record<string, unknown>): [boolean, string[]];
|
|
144
|
+
/**
|
|
145
|
+
* Invoke the handler with the given arguments and return a serialized result.
|
|
146
|
+
* @param args - Parsed arguments from the AI.
|
|
147
|
+
* @param rawData - The full raw request payload.
|
|
148
|
+
* @returns A serialized result dictionary suitable for the SWAIG response.
|
|
149
|
+
*/
|
|
150
|
+
execute(args: Record<string, unknown>, rawData?: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
151
|
+
/**
|
|
152
|
+
* Serialize this function to the SWAIG wire format for inclusion in SWML.
|
|
153
|
+
* @param baseUrl - The base URL of the agent server.
|
|
154
|
+
* @param token - Optional session token for secure functions.
|
|
155
|
+
* @param callId - Optional call ID for secure function URLs.
|
|
156
|
+
* @returns A SWAIG function definition object.
|
|
157
|
+
*/
|
|
158
|
+
toSwaig(baseUrl: string, token?: string, callId?: string): Record<string, unknown>;
|
|
159
|
+
}
|
|
@@ -0,0 +1,209 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* SwaigFunction - Wraps a handler function with metadata for SWAIG registration.
|
|
3
|
+
*/
|
|
4
|
+
import Ajv from 'ajv';
|
|
5
|
+
import { FunctionResult } from './FunctionResult.js';
|
|
6
|
+
import { getLogger } from './Logger.js';
|
|
7
|
+
const ajv = new Ajv({ allErrors: true });
|
|
8
|
+
const log = getLogger('SwaigFunction');
|
|
9
|
+
/**
|
|
10
|
+
* A SWAIG function — exactly the same concept as a "tool" in native
|
|
11
|
+
* OpenAI / Anthropic tool calling.
|
|
12
|
+
*
|
|
13
|
+
* Each SwaigFunction is rendered, on every LLM turn, into the OpenAI
|
|
14
|
+
* tool schema:
|
|
15
|
+
*
|
|
16
|
+
* ```json
|
|
17
|
+
* {
|
|
18
|
+
* "type": "function",
|
|
19
|
+
* "function": {
|
|
20
|
+
* "name": "<this.name>",
|
|
21
|
+
* "description": "<this.description>",
|
|
22
|
+
* "parameters": { "type": "object", "properties": { ... } }
|
|
23
|
+
* }
|
|
24
|
+
* }
|
|
25
|
+
* ```
|
|
26
|
+
*
|
|
27
|
+
* The `name`, `description`, and every per-parameter `description` inside
|
|
28
|
+
* `parameters` are **read by the model** and directly determine whether
|
|
29
|
+
* the model picks this tool when a matching user request comes in.
|
|
30
|
+
* They are prompt engineering, not developer comments.
|
|
31
|
+
*/
|
|
32
|
+
export class SwaigFunction {
|
|
33
|
+
/** Unique name — read by the LLM; use snake_case verbs. */
|
|
34
|
+
name;
|
|
35
|
+
/** The handler function called when the tool is invoked. */
|
|
36
|
+
handler;
|
|
37
|
+
/**
|
|
38
|
+
* LLM-facing description. Tells the model WHEN to call this tool.
|
|
39
|
+
* A vague description is the #1 cause of "model has the tool but
|
|
40
|
+
* doesn't call it" failures.
|
|
41
|
+
*/
|
|
42
|
+
description;
|
|
43
|
+
/**
|
|
44
|
+
* JSON Schema properties describing the tool's parameters. Each
|
|
45
|
+
* property's `description` field is ALSO LLM-facing — it tells the
|
|
46
|
+
* model HOW to extract that argument from the user's utterance.
|
|
47
|
+
*/
|
|
48
|
+
parameters;
|
|
49
|
+
/** Whether this tool requires session token authentication. */
|
|
50
|
+
secure;
|
|
51
|
+
/** Language-keyed filler phrases spoken while the tool executes. */
|
|
52
|
+
fillers;
|
|
53
|
+
/** Audio file URL to play while waiting for the tool to complete. */
|
|
54
|
+
waitFile;
|
|
55
|
+
/** Number of times to loop the wait file. */
|
|
56
|
+
waitFileLoops;
|
|
57
|
+
/** External webhook URL; set when the tool is externally hosted. */
|
|
58
|
+
webhookUrl;
|
|
59
|
+
/** List of required parameter names. */
|
|
60
|
+
required;
|
|
61
|
+
/** Additional fields included in the SWAIG definition output. */
|
|
62
|
+
extraFields;
|
|
63
|
+
/** Whether this tool uses a typed handler with named parameters. */
|
|
64
|
+
isTypedHandler;
|
|
65
|
+
/** Whether this tool is externally hosted (has a webhookUrl). */
|
|
66
|
+
isExternal;
|
|
67
|
+
/**
|
|
68
|
+
* Create a new SwaigFunction.
|
|
69
|
+
*
|
|
70
|
+
* @param opts - Configuration options for the SWAIG function.
|
|
71
|
+
* Use `opts.extraFields` to pass any additional SWAIG-only fields
|
|
72
|
+
* (e.g. `meta_data_token`, `web_hook_auth_user`, `web_hook_auth_password`).
|
|
73
|
+
* This mirrors the Python constructor's `**extra_swaig_fields` kwargs:
|
|
74
|
+
* both are merged directly into the serialized SWAIG definition, so the
|
|
75
|
+
* wire format is identical — only the call-site syntax differs.
|
|
76
|
+
*/
|
|
77
|
+
constructor(opts) {
|
|
78
|
+
this.name = opts.name;
|
|
79
|
+
this.handler = opts.handler;
|
|
80
|
+
this.description = opts.description;
|
|
81
|
+
this.parameters = opts.parameters ?? {};
|
|
82
|
+
this.secure = opts.secure ?? false;
|
|
83
|
+
this.fillers = opts.fillers;
|
|
84
|
+
this.waitFile = opts.waitFile;
|
|
85
|
+
this.waitFileLoops = opts.waitFileLoops;
|
|
86
|
+
this.webhookUrl = opts.webhookUrl;
|
|
87
|
+
this.required = opts.required ?? [];
|
|
88
|
+
this.extraFields = opts.extraFields ?? {};
|
|
89
|
+
this.isTypedHandler = opts.isTypedHandler ?? false;
|
|
90
|
+
this.isExternal = opts.webhookUrl !== undefined;
|
|
91
|
+
}
|
|
92
|
+
ensureParameterStructure() {
|
|
93
|
+
if (!this.parameters || Object.keys(this.parameters).length === 0) {
|
|
94
|
+
return { type: 'object', properties: {} };
|
|
95
|
+
}
|
|
96
|
+
if ('type' in this.parameters && 'properties' in this.parameters) {
|
|
97
|
+
return this.parameters;
|
|
98
|
+
}
|
|
99
|
+
const result = {
|
|
100
|
+
type: 'object',
|
|
101
|
+
properties: this.parameters,
|
|
102
|
+
};
|
|
103
|
+
if (this.required.length)
|
|
104
|
+
result['required'] = this.required;
|
|
105
|
+
return result;
|
|
106
|
+
}
|
|
107
|
+
/**
|
|
108
|
+
* Validate arguments against the parameter JSON schema using full
|
|
109
|
+
* JSON Schema Draft-7 validation (via ajv).
|
|
110
|
+
*
|
|
111
|
+
* Mirrors Python's `validate_args` which tries `jsonschema_rs` (Rust-based
|
|
112
|
+
* Draft-7 validator) then falls back to `jsonschema` (pure Python Draft-7).
|
|
113
|
+
* All JSON Schema constraint keywords are honoured: `required`, `type`,
|
|
114
|
+
* `minLength`, `maxLength`, `pattern`, `format`, `minimum`, `maximum`,
|
|
115
|
+
* `enum`, `anyOf`, `oneOf`, `$ref`, nested object/array validation, etc.
|
|
116
|
+
*
|
|
117
|
+
* If the schema has no properties, validation is skipped and the args are
|
|
118
|
+
* considered valid — matching Python's early-return path.
|
|
119
|
+
*
|
|
120
|
+
* @param args - Arguments to validate.
|
|
121
|
+
* @returns A tuple of `[isValid, errors]`. When no validation is needed
|
|
122
|
+
* (empty schema), returns `[true, []]`.
|
|
123
|
+
*/
|
|
124
|
+
validateArgs(args) {
|
|
125
|
+
const schema = this.ensureParameterStructure();
|
|
126
|
+
const properties = schema['properties'];
|
|
127
|
+
if (!properties || Object.keys(properties).length === 0) {
|
|
128
|
+
return [true, []];
|
|
129
|
+
}
|
|
130
|
+
const validate = ajv.compile(schema);
|
|
131
|
+
const valid = validate(args);
|
|
132
|
+
if (valid) {
|
|
133
|
+
return [true, []];
|
|
134
|
+
}
|
|
135
|
+
const errors = (validate.errors ?? []).map((e) => {
|
|
136
|
+
// Produce messages similar to Python's jsonschema:
|
|
137
|
+
// "instancePath message" or just "message" when path is empty.
|
|
138
|
+
const path = e.instancePath ? e.instancePath.replace(/^\//, '').replace(/\//g, '.') : '';
|
|
139
|
+
return path ? `'${path}' ${e.message}` : (e.message ?? String(e));
|
|
140
|
+
});
|
|
141
|
+
return [false, errors];
|
|
142
|
+
}
|
|
143
|
+
/**
|
|
144
|
+
* Invoke the handler with the given arguments and return a serialized result.
|
|
145
|
+
* @param args - Parsed arguments from the AI.
|
|
146
|
+
* @param rawData - The full raw request payload.
|
|
147
|
+
* @returns A serialized result dictionary suitable for the SWAIG response.
|
|
148
|
+
*/
|
|
149
|
+
async execute(args, rawData) {
|
|
150
|
+
try {
|
|
151
|
+
const result = await this.handler(args, rawData ?? {});
|
|
152
|
+
if (result instanceof FunctionResult) {
|
|
153
|
+
return result.toDict();
|
|
154
|
+
}
|
|
155
|
+
if (typeof result === 'object' && result !== null && !('response' in result)) {
|
|
156
|
+
// Plain object without a "response" key — matches Python's behavior:
|
|
157
|
+
// `elif isinstance(result, dict): return FunctionResult("Function completed successfully").to_dict()`
|
|
158
|
+
// Python replaces such dicts entirely; do the same here.
|
|
159
|
+
return new FunctionResult('Function completed successfully').toDict();
|
|
160
|
+
}
|
|
161
|
+
if (typeof result === 'object' && result !== null) {
|
|
162
|
+
return result;
|
|
163
|
+
}
|
|
164
|
+
// Neither a FunctionResult nor a dict — warn and fall back to
|
|
165
|
+
// wrapping the stringified value. See Python's web_mixin /
|
|
166
|
+
// serverless_mixin / tool_mixin for the equivalent check.
|
|
167
|
+
log.warn(`SWAIG function "${this.name}" returned a value of type "${typeof result}" ` +
|
|
168
|
+
`that is neither FunctionResult nor object; falling back to str(result). ` +
|
|
169
|
+
`The AI will see the stringified value as its tool response. Wrap your ` +
|
|
170
|
+
`return in new FunctionResult(...) or return an object with at least a ` +
|
|
171
|
+
`"response" key.`);
|
|
172
|
+
return new FunctionResult(String(result)).toDict();
|
|
173
|
+
}
|
|
174
|
+
catch (err) {
|
|
175
|
+
log.error(`Error executing SWAIG function ${this.name}: ${err}`);
|
|
176
|
+
return new FunctionResult("Sorry, I couldn't complete that action. Please try again or contact support if the issue persists.").toDict();
|
|
177
|
+
}
|
|
178
|
+
}
|
|
179
|
+
/**
|
|
180
|
+
* Serialize this function to the SWAIG wire format for inclusion in SWML.
|
|
181
|
+
* @param baseUrl - The base URL of the agent server.
|
|
182
|
+
* @param token - Optional session token for secure functions.
|
|
183
|
+
* @param callId - Optional call ID for secure function URLs.
|
|
184
|
+
* @returns A SWAIG function definition object.
|
|
185
|
+
*/
|
|
186
|
+
toSwaig(baseUrl, token, callId) {
|
|
187
|
+
let url = `${baseUrl}/swaig`;
|
|
188
|
+
if (token && callId) {
|
|
189
|
+
url = `${url}?token=${token}&call_id=${callId}`;
|
|
190
|
+
}
|
|
191
|
+
const def = {
|
|
192
|
+
function: this.name,
|
|
193
|
+
description: this.description,
|
|
194
|
+
parameters: this.ensureParameterStructure(),
|
|
195
|
+
};
|
|
196
|
+
if (url)
|
|
197
|
+
def['web_hook_url'] = url;
|
|
198
|
+
if (this.fillers && Object.keys(this.fillers).length > 0) {
|
|
199
|
+
def['fillers'] = this.fillers;
|
|
200
|
+
}
|
|
201
|
+
if (this.waitFile)
|
|
202
|
+
def['wait_file'] = this.waitFile;
|
|
203
|
+
if (this.waitFileLoops !== undefined)
|
|
204
|
+
def['wait_file_loops'] = this.waitFileLoops;
|
|
205
|
+
Object.assign(def, this.extraFields);
|
|
206
|
+
return def;
|
|
207
|
+
}
|
|
208
|
+
}
|
|
209
|
+
//# sourceMappingURL=SwaigFunction.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"SwaigFunction.js","sourceRoot":"","sources":["../src/SwaigFunction.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,GAAG,MAAM,KAAK,CAAC;AACtB,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;AAEzC,MAAM,GAAG,GAAG,SAAS,CAAC,eAAe,CAAC,CAAC;AA0DvC;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,OAAO,aAAa;IACxB,2DAA2D;IAC3D,IAAI,CAAS;IACb,4DAA4D;IAC5D,OAAO,CAAe;IACtB;;;;OAIG;IACH,WAAW,CAAS;IACpB;;;;OAIG;IACH,UAAU,CAA0B;IACpC,+DAA+D;IAC/D,MAAM,CAAU;IAChB,oEAAoE;IACpE,OAAO,CAA4B;IACnC,qEAAqE;IACrE,QAAQ,CAAU;IAClB,6CAA6C;IAC7C,aAAa,CAAU;IACvB,oEAAoE;IACpE,UAAU,CAAU;IACpB,wCAAwC;IACxC,QAAQ,CAAW;IACnB,iEAAiE;IACjE,WAAW,CAA0B;IACrC,oEAAoE;IACpE,cAAc,CAAU;IACxB,iEAAiE;IACjE,UAAU,CAAU;IAEpB;;;;;;;;;OASG;IACH,YAAY,IAA0B;QACpC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC5B,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACpC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,EAAE,CAAC;QACxC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,KAAK,CAAC;QACnC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC5B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC9B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QACxC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QAClC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAC;QACpC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC;QAC1C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,IAAI,KAAK,CAAC;QACnD,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC;IAClD,CAAC;IAEO,wBAAwB;QAC9B,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAClE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;QAC5C,CAAC;QACD,IAAI,MAAM,IAAI,IAAI,CAAC,UAAU,IAAI,YAAY,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACjE,OAAO,IAAI,CAAC,UAAU,CAAC;QACzB,CAAC;QACD,MAAM,MAAM,GAA4B;YACtC,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,IAAI,CAAC,UAAU;SAC5B,CAAC;QACF,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM;YAAE,MAAM,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC7D,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,CAAC,IAA6B;QACxC,MAAM,MAAM,GAAG,IAAI,CAAC,wBAAwB,EAAE,CAAC;QAC/C,MAAM,UAAU,GAAG,MAAM,CAAC,YAAY,CAAwC,CAAC;QAC/E,IAAI,CAAC,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACxD,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACpB,CAAC;QAED,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACrC,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC7B,IAAI,KAAK,EAAE,CAAC;YACV,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACpB,CAAC;QACD,MAAM,MAAM,GAAG,CAAC,QAAQ,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YAC/C,mDAAmD;YACnD,+DAA+D;YAC/D,MAAM,IAAI,GAAG,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACzF,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACpE,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACzB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO,CACX,IAA6B,EAC7B,OAAiC;QAEjC,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,IAAI,EAAE,CAAC,CAAC;YACvD,IAAI,MAAM,YAAY,cAAc,EAAE,CAAC;gBACrC,OAAO,MAAM,CAAC,MAAM,EAAE,CAAC;YACzB,CAAC;YACD,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,IAAI,CAAC,CAAC,UAAU,IAAI,MAAM,CAAC,EAAE,CAAC;gBAC7E,qEAAqE;gBACrE,sGAAsG;gBACtG,yDAAyD;gBACzD,OAAO,IAAI,cAAc,CAAC,iCAAiC,CAAC,CAAC,MAAM,EAAE,CAAC;YACxE,CAAC;YACD,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;gBAClD,OAAO,MAAiC,CAAC;YAC3C,CAAC;YACD,8DAA8D;YAC9D,2DAA2D;YAC3D,0DAA0D;YAC1D,GAAG,CAAC,IAAI,CACN,mBAAmB,IAAI,CAAC,IAAI,+BAA+B,OAAO,MAAM,IAAI;gBAC1E,0EAA0E;gBAC1E,wEAAwE;gBACxE,wEAAwE;gBACxE,iBAAiB,CACpB,CAAC;YACF,OAAO,IAAI,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;QACrD,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,GAAG,CAAC,KAAK,CAAC,kCAAkC,IAAI,CAAC,IAAI,KAAK,GAAG,EAAE,CAAC,CAAC;YACjE,OAAO,IAAI,cAAc,CACvB,oGAAoG,CACrG,CAAC,MAAM,EAAE,CAAC;QACb,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,OAAO,CAAC,OAAe,EAAE,KAAc,EAAE,MAAe;QACtD,IAAI,GAAG,GAAG,GAAG,OAAO,QAAQ,CAAC;QAC7B,IAAI,KAAK,IAAI,MAAM,EAAE,CAAC;YACpB,GAAG,GAAG,GAAG,GAAG,UAAU,KAAK,YAAY,MAAM,EAAE,CAAC;QAClD,CAAC;QACD,MAAM,GAAG,GAA4B;YACnC,QAAQ,EAAE,IAAI,CAAC,IAAI;YACnB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,UAAU,EAAE,IAAI,CAAC,wBAAwB,EAAE;SAC5C,CAAC;QACF,IAAI,GAAG;YAAE,GAAG,CAAC,cAAc,CAAC,GAAG,GAAG,CAAC;QACnC,IAAI,IAAI,CAAC,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzD,GAAG,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC;QAChC,CAAC;QACD,IAAI,IAAI,CAAC,QAAQ;YAAE,GAAG,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;QACpD,IAAI,IAAI,CAAC,aAAa,KAAK,SAAS;YAAE,GAAG,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC;QAClF,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACrC,OAAO,GAAG,CAAC;IACb,CAAC;CACF"}
|
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* SwmlBuilder - Builds SWML (SignalWire Markup Language) documents.
|
|
3
|
+
*
|
|
4
|
+
* Produces `{ version: "1.0.0", sections: { main: [...verbs] } }`.
|
|
5
|
+
*
|
|
6
|
+
* Verb methods (`.answer()`, `.hangup()`, `.play()`, etc.) are auto-installed
|
|
7
|
+
* at construction from the bundled schema.json. All verb methods support
|
|
8
|
+
* fluent chaining and call `addVerb()` internally.
|
|
9
|
+
*/
|
|
10
|
+
import { SchemaUtils } from './SchemaUtils.js';
|
|
11
|
+
import './SwmlVerbMethods.generated.js';
|
|
12
|
+
/** Options for constructing a SwmlBuilder. */
|
|
13
|
+
export interface SwmlBuilderOptions {
|
|
14
|
+
/** An initial SWML document to seed the builder with, enabling document injection.
|
|
15
|
+
* When provided, the builder uses this document instead of creating an empty one.
|
|
16
|
+
* This mirrors the Python SDK's pattern of injecting an SWMLService instance. */
|
|
17
|
+
initialDocument?: {
|
|
18
|
+
version?: string;
|
|
19
|
+
sections?: Record<string, unknown[]>;
|
|
20
|
+
};
|
|
21
|
+
/** When false, disables verb schema validation.
|
|
22
|
+
* Defaults to true unless `SWML_SKIP_SCHEMA_VALIDATION=true` is set in the environment. */
|
|
23
|
+
enableValidation?: boolean;
|
|
24
|
+
/** Optional path to a custom SWML schema JSON file. When set, the builder uses
|
|
25
|
+
* a per-instance SchemaUtils loaded from this path instead of the bundled schema.
|
|
26
|
+
* Mirrors Python's `schema_path` constructor parameter on `SWMLService`/`AgentBase`. */
|
|
27
|
+
schemaPath?: string;
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* Builds SWML documents composed of verb instructions organized into named sections.
|
|
31
|
+
*
|
|
32
|
+
* Verb methods (`.answer()`, `.play()`, `.hangup()`, `.transfer()`, etc.) are
|
|
33
|
+
* auto-installed from the bundled SWML schema and all return `this` for fluent chaining.
|
|
34
|
+
*
|
|
35
|
+
* Most users don't instantiate `SwmlBuilder` directly — `AgentBase` uses it internally
|
|
36
|
+
* and exposes higher-level helpers. Use this class directly for `SWMLService` (non-AI
|
|
37
|
+
* call flows) or to hand-craft SWML returned from a route handler.
|
|
38
|
+
*
|
|
39
|
+
* @example Simple SWML document
|
|
40
|
+
* ```ts
|
|
41
|
+
* import { SwmlBuilder } from '@signalwire/sdk';
|
|
42
|
+
*
|
|
43
|
+
* const swml = new SwmlBuilder()
|
|
44
|
+
* .answer()
|
|
45
|
+
* .play({ url: 'https://cdn.example.com/greeting.mp3' })
|
|
46
|
+
* .hangup()
|
|
47
|
+
* .build();
|
|
48
|
+
*
|
|
49
|
+
* // swml is JSON ready to return from a SignalWire webhook.
|
|
50
|
+
* ```
|
|
51
|
+
*
|
|
52
|
+
* @see {@link SWMLService} — HTTP service that serves a built SWML document
|
|
53
|
+
* @see {@link AgentBase} — for AI-driven call flows
|
|
54
|
+
*/
|
|
55
|
+
export declare class SwmlBuilder {
|
|
56
|
+
private _document;
|
|
57
|
+
private static _schemaUtils;
|
|
58
|
+
/** Per-instance SchemaUtils used when a custom `schemaPath` was supplied. */
|
|
59
|
+
private _instanceSchemaUtils;
|
|
60
|
+
private enableValidation;
|
|
61
|
+
/**
|
|
62
|
+
* Creates a new SwmlBuilder.
|
|
63
|
+
* @param opts - Optional configuration.
|
|
64
|
+
* - `initialDocument`: inject an existing document (mirrors Python SDK's `SWMLService` injection pattern).
|
|
65
|
+
* - `enableValidation`: explicit override for verb schema validation (falls back to env var).
|
|
66
|
+
* - `schemaPath`: load SWML schema from a custom JSON file instead of the bundled one.
|
|
67
|
+
*/
|
|
68
|
+
constructor(opts?: SwmlBuilderOptions);
|
|
69
|
+
/** Returns the SchemaUtils for this builder — per-instance if a custom
|
|
70
|
+
* `schemaPath` was supplied, otherwise the shared singleton. */
|
|
71
|
+
private getSchemaUtils;
|
|
72
|
+
/**
|
|
73
|
+
* Public read-only accessor for the underlying SWML document.
|
|
74
|
+
* Provides direct access to the document, equivalent to the Python SDK's
|
|
75
|
+
* `service` property on `SWMLBuilder`.
|
|
76
|
+
*/
|
|
77
|
+
get document(): {
|
|
78
|
+
version: string;
|
|
79
|
+
sections: Record<string, unknown[]>;
|
|
80
|
+
};
|
|
81
|
+
/**
|
|
82
|
+
* Enable or disable verb schema validation at runtime.
|
|
83
|
+
* Matches the Python `schema_validation` constructor parameter on AgentBase.
|
|
84
|
+
* @param enabled - True to enable validation, false to disable.
|
|
85
|
+
*/
|
|
86
|
+
setValidation(enabled: boolean): void;
|
|
87
|
+
private createEmpty;
|
|
88
|
+
/**
|
|
89
|
+
* Get or create the shared SchemaUtils singleton.
|
|
90
|
+
* Exposed for use by the type generator and tests.
|
|
91
|
+
*/
|
|
92
|
+
static getSchemaUtils(): SchemaUtils;
|
|
93
|
+
/**
|
|
94
|
+
* Install verb methods on this instance for every verb defined in the schema.
|
|
95
|
+
* Uses a closure factory so each method captures the correct verb name.
|
|
96
|
+
* Mirrors Python SDK's `_create_verb_methods()`.
|
|
97
|
+
*/
|
|
98
|
+
private _installVerbMethods;
|
|
99
|
+
/**
|
|
100
|
+
* Resets the document to an empty SWML structure.
|
|
101
|
+
* @returns this for fluent chaining.
|
|
102
|
+
*/
|
|
103
|
+
reset(): this;
|
|
104
|
+
/**
|
|
105
|
+
* Appends a verb to the main section.
|
|
106
|
+
* Validates the verb config against the schema when validation is enabled.
|
|
107
|
+
* @param verbName - The SWML verb name (e.g., "answer", "ai").
|
|
108
|
+
* @param config - The verb's configuration payload.
|
|
109
|
+
*/
|
|
110
|
+
addVerb(verbName: string, config: unknown): void;
|
|
111
|
+
/**
|
|
112
|
+
* Appends a verb to a named section, creating the section if it does not exist.
|
|
113
|
+
* @param sectionName - The target section name.
|
|
114
|
+
* @param verbName - The SWML verb name.
|
|
115
|
+
* @param config - The verb's configuration payload.
|
|
116
|
+
*/
|
|
117
|
+
addVerbToSection(sectionName: string, verbName: string, config: unknown): void;
|
|
118
|
+
/**
|
|
119
|
+
* Add a 'play' verb with say: prefix for text-to-speech.
|
|
120
|
+
* Convenience wrapper matching Python SDK's `say()` method.
|
|
121
|
+
*
|
|
122
|
+
* @param text - Text to speak.
|
|
123
|
+
* @param opts - Optional TTS parameters (voice, language, gender, volume).
|
|
124
|
+
* @returns this for fluent chaining.
|
|
125
|
+
*/
|
|
126
|
+
say(text: string, opts?: {
|
|
127
|
+
voice?: string;
|
|
128
|
+
language?: string;
|
|
129
|
+
gender?: string;
|
|
130
|
+
volume?: number;
|
|
131
|
+
}): this;
|
|
132
|
+
/**
|
|
133
|
+
* Creates a new empty named section in the document.
|
|
134
|
+
* If the section already exists, this is a no-op.
|
|
135
|
+
* Matches Python SDK's `add_section(section_name)`.
|
|
136
|
+
*
|
|
137
|
+
* @param sectionName - The name of the section to create.
|
|
138
|
+
* @returns this for fluent chaining.
|
|
139
|
+
*/
|
|
140
|
+
addSection(sectionName: string): this;
|
|
141
|
+
/**
|
|
142
|
+
* Returns the raw SWML document object.
|
|
143
|
+
* @returns The document with version and sections.
|
|
144
|
+
*/
|
|
145
|
+
getDocument(): Record<string, unknown>;
|
|
146
|
+
/**
|
|
147
|
+
* Alias for {@link getDocument}. Matches the Python SDK's `build()` method.
|
|
148
|
+
* Build and return the SWML document as a dictionary/object.
|
|
149
|
+
*
|
|
150
|
+
* @returns The document with version and sections.
|
|
151
|
+
*/
|
|
152
|
+
build(): Record<string, unknown>;
|
|
153
|
+
/**
|
|
154
|
+
* Serializes the SWML document to a JSON string.
|
|
155
|
+
* @returns The JSON-encoded SWML document.
|
|
156
|
+
*/
|
|
157
|
+
renderDocument(): string;
|
|
158
|
+
/**
|
|
159
|
+
* Alias for {@link renderDocument}. Matches the Python SDK's `render()` method.
|
|
160
|
+
* Build and render the SWML document as a JSON string.
|
|
161
|
+
*
|
|
162
|
+
* @returns The JSON-encoded SWML document.
|
|
163
|
+
*/
|
|
164
|
+
render(): string;
|
|
165
|
+
}
|