@signalwire/sdk 2.0.0 → 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/dist/index.d.ts +146 -0
- 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/{src/rest/index.ts → dist/rest/index.d.ts} +53 -122
- package/dist/rest/index.js +195 -0
- 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/dist/rest/pagination.d.ts +39 -0
- 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 -2489
- package/src/AgentServer.ts +0 -415
- package/src/AuthHandler.ts +0 -256
- package/src/ConfigLoader.ts +0 -447
- package/src/ContextBuilder.ts +0 -1150
- package/src/DataMap.ts +0 -449
- package/src/FunctionResult.ts +0 -866
- package/src/Logger.ts +0 -337
- package/src/PomBuilder.ts +0 -439
- package/src/PromptManager.ts +0 -133
- package/src/SWMLHandler.ts +0 -298
- package/src/SWMLService.ts +0 -717
- package/src/SchemaUtils.ts +0 -361
- package/src/ServerlessAdapter.ts +0 -221
- package/src/SessionManager.ts +0 -311
- package/src/SslConfig.ts +0 -118
- package/src/SwaigFunction.ts +0 -276
- package/src/SwmlBuilder.ts +0 -258
- package/src/SwmlVerbMethods.generated.ts +0 -234
- package/src/TypeInference.ts +0 -181
- package/src/WebService.ts +0 -619
- 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/index.ts +0 -167
- package/src/livewire/index.ts +0 -950
- package/src/prefabs/ConciergeAgent.ts +0 -287
- package/src/prefabs/FAQBotAgent.ts +0 -384
- package/src/prefabs/InfoGathererAgent.ts +0 -339
- package/src/prefabs/ReceptionistAgent.ts +0 -366
- package/src/prefabs/SurveyAgent.ts +0 -646
- package/src/relay/Action.ts +0 -314
- package/src/relay/Call.ts +0 -854
- package/src/relay/Deferred.ts +0 -71
- package/src/relay/Message.ts +0 -148
- package/src/relay/RelayClient.ts +0 -1036
- package/src/relay/RelayError.ts +0 -14
- package/src/relay/RelayEvent.ts +0 -892
- package/src/relay/index.ts +0 -123
- package/src/relay/types.ts +0 -149
- package/src/rest/HttpClient.ts +0 -103
- package/src/rest/RestError.ts +0 -31
- package/src/rest/base/BaseResource.ts +0 -19
- package/src/rest/base/CrudResource.ts +0 -51
- package/src/rest/base/CrudWithAddresses.ts +0 -26
- package/src/rest/namespaces/addresses.ts +0 -32
- package/src/rest/namespaces/calling.ts +0 -187
- package/src/rest/namespaces/chat.ts +0 -20
- package/src/rest/namespaces/compat.ts +0 -352
- package/src/rest/namespaces/datasphere.ts +0 -45
- package/src/rest/namespaces/fabric.ts +0 -222
- package/src/rest/namespaces/imported-numbers.ts +0 -20
- package/src/rest/namespaces/logs.ts +0 -84
- package/src/rest/namespaces/lookup.ts +0 -21
- package/src/rest/namespaces/mfa.ts +0 -30
- package/src/rest/namespaces/number-groups.ts +0 -38
- package/src/rest/namespaces/phone-numbers.ts +0 -44
- package/src/rest/namespaces/project.ts +0 -36
- package/src/rest/namespaces/pubsub.ts +0 -20
- package/src/rest/namespaces/queues.ts +0 -33
- package/src/rest/namespaces/recordings.ts +0 -28
- package/src/rest/namespaces/registry.ts +0 -101
- package/src/rest/namespaces/short-codes.ts +0 -28
- package/src/rest/namespaces/sip-profile.ts +0 -25
- package/src/rest/namespaces/verified-callers.ts +0 -27
- package/src/rest/namespaces/video.ts +0 -165
- package/src/rest/pagination.ts +0 -84
- package/src/rest/types.ts +0 -61
- package/src/skills/SkillBase.ts +0 -547
- package/src/skills/SkillManager.ts +0 -415
- package/src/skills/SkillRegistry.ts +0 -367
- package/src/skills/builtin/api_ninjas_trivia.ts +0 -280
- package/src/skills/builtin/ask_claude.ts +0 -241
- package/src/skills/builtin/claude_skills.ts +0 -978
- package/src/skills/builtin/custom_skills.ts +0 -312
- package/src/skills/builtin/datasphere.ts +0 -438
- package/src/skills/builtin/datasphere_serverless.ts +0 -339
- package/src/skills/builtin/datetime.ts +0 -130
- package/src/skills/builtin/google_maps.ts +0 -651
- package/src/skills/builtin/info_gatherer.ts +0 -405
- package/src/skills/builtin/joke.ts +0 -191
- package/src/skills/builtin/math.ts +0 -142
- package/src/skills/builtin/mcp_gateway.ts +0 -677
- package/src/skills/builtin/native_vector_search.ts +0 -901
- package/src/skills/builtin/play_background_file.ts +0 -358
- package/src/skills/builtin/spider.ts +0 -869
- package/src/skills/builtin/swml_transfer.ts +0 -635
- package/src/skills/builtin/weather_api.ts +0 -248
- package/src/skills/builtin/web_search.ts +0 -1074
- package/src/skills/builtin/wikipedia_search.ts +0 -299
- package/src/types.ts +0 -132
- package/tests/AgentBase.test.ts +0 -1093
- package/tests/AgentServer.test.ts +0 -126
- package/tests/AuthHandler.test.ts +0 -133
- package/tests/ConfigLoader.test.ts +0 -151
- package/tests/ContextBuilder.test.ts +0 -108
- package/tests/DataMap.test.ts +0 -367
- package/tests/EphemeralSkillCopy.test.ts +0 -107
- package/tests/FunctionResult.test.ts +0 -298
- package/tests/GracefulShutdown.test.ts +0 -46
- package/tests/Logger.test.ts +0 -420
- package/tests/PomBuilder.test.ts +0 -228
- package/tests/ProxyDetection.test.ts +0 -228
- package/tests/SWMLService.test.ts +0 -320
- package/tests/SWMLVerbHandler.test.ts +0 -523
- package/tests/SchemaUtils.test.ts +0 -106
- package/tests/SchemaUtils.verb.test.ts +0 -206
- package/tests/SecurityUtils.test.ts +0 -192
- package/tests/ServerlessAdapter.test.ts +0 -222
- package/tests/SessionManager.test.ts +0 -257
- package/tests/SkillBaseFeatures.test.ts +0 -130
- package/tests/SkillMultiInstance.test.ts +0 -102
- package/tests/SkillParameterSchemas.test.ts +0 -134
- package/tests/SkillRegistrySchema.test.ts +0 -84
- package/tests/SslConfig.test.ts +0 -97
- package/tests/SwmlBuilder.test.ts +0 -400
- package/tests/TypeInference.test.ts +0 -165
- package/tests/VerbHandlerRegistry.test.ts +0 -128
- package/tests/cli/mock-data.test.ts +0 -113
- package/tests/cli/swaig-test.test.ts +0 -108
- package/tests/examples.test.ts +0 -194
- package/tests/fixtures/scrape-parity/README.md +0 -53
- package/tests/fixtures/scrape-parity/expected/01_simple_article.json +0 -5
- package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +0 -5
- package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +0 -5
- package/tests/fixtures/scrape-parity/expected/04_bare_body.json +0 -5
- package/tests/fixtures/scrape-parity/expected/05_malformed.json +0 -5
- package/tests/fixtures/scrape-parity/expected/06_multi_class.json +0 -5
- package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +0 -5
- package/tests/fixtures/scrape-parity/expected/08_inline_script.json +0 -5
- package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +0 -5
- package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +0 -5
- package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +0 -5
- package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +0 -5
- package/tests/fixtures/scrape-parity/html/01_simple_article.html +0 -18
- package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +0 -18
- package/tests/fixtures/scrape-parity/html/03_nested_containers.html +0 -13
- package/tests/fixtures/scrape-parity/html/04_bare_body.html +0 -9
- package/tests/fixtures/scrape-parity/html/05_malformed.html +0 -11
- package/tests/fixtures/scrape-parity/html/06_multi_class.html +0 -18
- package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +0 -12
- package/tests/fixtures/scrape-parity/html/08_inline_script.html +0 -17
- package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +0 -21
- package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +0 -10
- package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +0 -13
- package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +0 -24
- package/tests/fixtures/scrape-parity/python_extract.py +0 -109
- package/tests/livewire/livewire.test.ts +0 -780
- package/tests/mcp.test.ts +0 -221
- package/tests/prefabs/prefabs.test.ts +0 -1093
- package/tests/relay/Action.test.ts +0 -392
- package/tests/relay/Call.test.ts +0 -535
- package/tests/relay/Deferred.test.ts +0 -71
- package/tests/relay/Message.test.ts +0 -164
- package/tests/relay/RelayClient.test.ts +0 -779
- package/tests/relay/RelayEvent.test.ts +0 -463
- package/tests/relay/helpers.ts +0 -79
- package/tests/rest/HttpClient.test.ts +0 -274
- package/tests/rest/RestError.test.ts +0 -53
- package/tests/rest/calling.test.ts +0 -156
- package/tests/rest/client.test.ts +0 -197
- package/tests/rest/compat.test.ts +0 -335
- package/tests/rest/datasphere.test.ts +0 -71
- package/tests/rest/fabric.test.ts +0 -186
- package/tests/rest/helpers.ts +0 -95
- package/tests/rest/logs.test.ts +0 -68
- package/tests/rest/pagination.test.ts +0 -133
- package/tests/rest/registry.test.ts +0 -94
- package/tests/rest/relay-rest.test.ts +0 -290
- package/tests/rest/video.test.ts +0 -173
- package/tests/setup.ts +0 -6
- package/tests/skills/SkillBase.test.ts +0 -108
- package/tests/skills/SkillManager.test.ts +0 -268
- package/tests/skills/SkillRegistry.test.ts +0 -176
- package/tests/skills/builtin.test.ts +0 -1472
- package/tests/skills/claude-skills.test.ts +0 -54
- package/tests/skills/custom-skills.test.ts +0 -53
- package/tests/skills/datasphere-serverless.test.ts +0 -70
- package/tests/skills/datasphere.test.ts +0 -107
- package/tests/skills/datetime.test.ts +0 -101
- package/tests/skills/google-maps.test.ts +0 -78
- package/tests/skills/info-gatherer.test.ts +0 -411
- package/tests/skills/joke.test.ts +0 -81
- package/tests/skills/math.test.ts +0 -68
- package/tests/skills/mcp-gateway.test.ts +0 -101
- package/tests/skills/play-background.test.ts +0 -54
- package/tests/skills/spider.test.ts +0 -108
- package/tests/skills/swml-transfer.test.ts +0 -178
- package/tests/skills/trivia.test.ts +0 -54
- package/tests/skills/vector-search.test.ts +0 -135
- package/tests/skills/weather-api.test.ts +0 -77
- package/tests/skills/web-search-parity.test.ts +0 -59
- package/tests/skills/web-search.test.ts +0 -103
- package/tests/skills/wikipedia.test.ts +0 -63
- package/tsconfig.json +0 -18
- package/vitest.config.ts +0 -9
- /package/{src → dist}/schema.json +0 -0
package/docs/cli_guide.md
DELETED
|
@@ -1,448 +0,0 @@
|
|
|
1
|
-
# CLI Guide
|
|
2
|
-
|
|
3
|
-
Complete guide to the `swaig-test` command-line tool for testing SignalWire AI agents locally without making a phone call.
|
|
4
|
-
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
## Table of Contents
|
|
8
|
-
|
|
9
|
-
- [Overview](#overview)
|
|
10
|
-
- [Installation and Usage](#installation-and-usage)
|
|
11
|
-
- [Agent Discovery](#agent-discovery)
|
|
12
|
-
- [Discovery Order](#discovery-order)
|
|
13
|
-
- [The --agent-class Flag](#the---agent-class-flag)
|
|
14
|
-
- [Commands](#commands)
|
|
15
|
-
- [--dump-swml](#--dump-swml)
|
|
16
|
-
- [--list-tools](#--list-tools)
|
|
17
|
-
- [--exec function_name](#--exec-function_name)
|
|
18
|
-
- [--list-agents](#--list-agents)
|
|
19
|
-
- [Execution Options](#execution-options)
|
|
20
|
-
- [Function Arguments (--arg)](#function-arguments---arg)
|
|
21
|
-
- [Call Metadata Overrides](#call-metadata-overrides)
|
|
22
|
-
- [Post Data Overrides (--override)](#post-data-overrides---override)
|
|
23
|
-
- [Mock Data](#mock-data)
|
|
24
|
-
- [Full Mock Post Data](#full-mock-post-data)
|
|
25
|
-
- [Minimal Mock Post Data](#minimal-mock-post-data)
|
|
26
|
-
- [MockCallOptions](#mockcalloptions)
|
|
27
|
-
- [Output Formatting](#output-formatting)
|
|
28
|
-
- [Route Override](#route-override)
|
|
29
|
-
- [Environment Variables](#environment-variables)
|
|
30
|
-
- [Serverless Simulation](#serverless-simulation)
|
|
31
|
-
- [Examples](#examples)
|
|
32
|
-
|
|
33
|
-
---
|
|
34
|
-
|
|
35
|
-
## Overview
|
|
36
|
-
|
|
37
|
-
`swaig-test` is a CLI tool for testing SignalWire AI agents locally. It dynamically imports your agent module, generates mock call data, and lets you:
|
|
38
|
-
|
|
39
|
-
- **Dump the SWML document** your agent produces, so you can inspect its full configuration.
|
|
40
|
-
- **List all registered tools** with their descriptions and parameter schemas.
|
|
41
|
-
- **Execute a specific tool** with custom arguments and inspect the result.
|
|
42
|
-
- **List all agents** exported from a module file.
|
|
43
|
-
|
|
44
|
-
This allows you to iterate on your agent's configuration, prompt, and tool handlers without setting up a phone number, making a call, or deploying to a server.
|
|
45
|
-
|
|
46
|
-
**Source files:**
|
|
47
|
-
|
|
48
|
-
- `src/cli/swaig-test.ts` -- CLI entry point and argument parser.
|
|
49
|
-
- `src/cli/agent-loader.ts` -- Agent discovery via dynamic import with duck-typing.
|
|
50
|
-
- `src/cli/mock-data.ts` -- Mock call data generation.
|
|
51
|
-
|
|
52
|
-
---
|
|
53
|
-
|
|
54
|
-
## Installation and Usage
|
|
55
|
-
|
|
56
|
-
Run the CLI via `npx tsx` during development:
|
|
57
|
-
|
|
58
|
-
```bash
|
|
59
|
-
npx tsx src/cli/swaig-test.ts <agent-path> [options]
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
If the project has been built, you can run the compiled JavaScript directly:
|
|
63
|
-
|
|
64
|
-
```bash
|
|
65
|
-
node dist/cli/swaig-test.js <agent-path> [options]
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
The `<agent-path>` is the path to your agent module file (TypeScript or JavaScript). It is the first positional argument and is required for all commands except `--help`.
|
|
69
|
-
|
|
70
|
-
Show help:
|
|
71
|
-
|
|
72
|
-
```bash
|
|
73
|
-
npx tsx src/cli/swaig-test.ts --help
|
|
74
|
-
```
|
|
75
|
-
|
|
76
|
-
---
|
|
77
|
-
|
|
78
|
-
## Agent Discovery
|
|
79
|
-
|
|
80
|
-
The CLI uses dynamic `import()` to load your agent module, then applies a series of duck-typing heuristics to find an `AgentBase` instance. An object is considered an agent instance if it has `renderSwml`, `defineTool`, and `getPrompt` methods. A constructor function is considered an agent class if its `prototype` has those same methods.
|
|
81
|
-
|
|
82
|
-
### Discovery Order
|
|
83
|
-
|
|
84
|
-
When no `--agent-class` flag is provided, the loader tries these strategies in order and uses the first match:
|
|
85
|
-
|
|
86
|
-
| Priority | Strategy | Description |
|
|
87
|
-
|---|---|---|
|
|
88
|
-
| 1 | Named export `agent` (instance) | Checks `module.agent` and verifies it is an agent instance via duck-typing. |
|
|
89
|
-
| 2 | Default export (instance) | Checks `module.default` and verifies it is an agent instance. |
|
|
90
|
-
| 3 | Any exported instance | Iterates over all exports; uses the first agent instance found. |
|
|
91
|
-
| 4 | Default export (class) | If `module.default` is an agent class, instantiates it with `{ name: 'cli-agent' }`. |
|
|
92
|
-
| 5 | Any exported class | Iterates over all exports; instantiates the first agent class found with `{ name: 'cli-agent' }`. |
|
|
93
|
-
|
|
94
|
-
### The --agent-class Flag
|
|
95
|
-
|
|
96
|
-
Force the CLI to instantiate a specific class by name:
|
|
97
|
-
|
|
98
|
-
```bash
|
|
99
|
-
npx tsx src/cli/swaig-test.ts my-agents.ts --agent-class SalesAgent --dump-swml
|
|
100
|
-
```
|
|
101
|
-
|
|
102
|
-
The loader looks for a named export matching the class name and instantiates it.
|
|
103
|
-
|
|
104
|
-
---
|
|
105
|
-
|
|
106
|
-
## Commands
|
|
107
|
-
|
|
108
|
-
### --dump-swml
|
|
109
|
-
|
|
110
|
-
Render and print the full SWML document the agent produces. This includes the complete 5-phase call flow, all tool definitions, the prompt, hints, languages, and all AI configuration.
|
|
111
|
-
|
|
112
|
-
```bash
|
|
113
|
-
npx tsx src/cli/swaig-test.ts examples/simple_agent.ts --dump-swml
|
|
114
|
-
```
|
|
115
|
-
|
|
116
|
-
Output is pretty-printed JSON.
|
|
117
|
-
|
|
118
|
-
### --list-tools
|
|
119
|
-
|
|
120
|
-
List all registered tools with their descriptions, parameter schemas, and metadata. Shows both handler-based tools (`defineTool()`) and DataMap tools.
|
|
121
|
-
|
|
122
|
-
```bash
|
|
123
|
-
npx tsx src/cli/swaig-test.ts examples/simple_agent.ts --list-tools
|
|
124
|
-
```
|
|
125
|
-
|
|
126
|
-
Example output:
|
|
127
|
-
|
|
128
|
-
```
|
|
129
|
-
Tools registered on agent 'my-agent':
|
|
130
|
-
|
|
131
|
-
1. get_weather
|
|
132
|
-
Description: Get the current weather for a city
|
|
133
|
-
Parameters:
|
|
134
|
-
city (string, required): City name
|
|
135
|
-
units (string, optional): Temperature units [celsius, fahrenheit]
|
|
136
|
-
|
|
137
|
-
2. check_order (DataMap)
|
|
138
|
-
Description: Check order status
|
|
139
|
-
Parameters:
|
|
140
|
-
order_id (string, required): Order number
|
|
141
|
-
```
|
|
142
|
-
|
|
143
|
-
### --exec function_name
|
|
144
|
-
|
|
145
|
-
Execute a specific tool handler with the provided arguments and display the result.
|
|
146
|
-
|
|
147
|
-
```bash
|
|
148
|
-
npx tsx src/cli/swaig-test.ts examples/simple_agent.ts \
|
|
149
|
-
--exec get_weather \
|
|
150
|
-
--arg city=Austin \
|
|
151
|
-
--arg units=fahrenheit
|
|
152
|
-
```
|
|
153
|
-
|
|
154
|
-
### --list-agents
|
|
155
|
-
|
|
156
|
-
List all agent classes and instances exported from a module.
|
|
157
|
-
|
|
158
|
-
```bash
|
|
159
|
-
npx tsx src/cli/swaig-test.ts examples/multi_agent_server.ts --list-agents
|
|
160
|
-
```
|
|
161
|
-
|
|
162
|
-
```bash
|
|
163
|
-
# With verbose details
|
|
164
|
-
npx tsx src/cli/swaig-test.ts examples/multi_agent_server.ts --list-agents --verbose
|
|
165
|
-
```
|
|
166
|
-
|
|
167
|
-
---
|
|
168
|
-
|
|
169
|
-
## Execution Options
|
|
170
|
-
|
|
171
|
-
### Function Arguments (--arg)
|
|
172
|
-
|
|
173
|
-
Pass arguments as `key=value` pairs:
|
|
174
|
-
|
|
175
|
-
```bash
|
|
176
|
-
--arg city=Austin --arg units=fahrenheit
|
|
177
|
-
```
|
|
178
|
-
|
|
179
|
-
For JSON values:
|
|
180
|
-
|
|
181
|
-
```bash
|
|
182
|
-
--arg data='{"nested":"value"}'
|
|
183
|
-
```
|
|
184
|
-
|
|
185
|
-
Arguments are parsed as strings by default. The CLI attempts JSON parsing for values that look like objects or arrays.
|
|
186
|
-
|
|
187
|
-
### Call Metadata Overrides
|
|
188
|
-
|
|
189
|
-
Override fields in the mock call data:
|
|
190
|
-
|
|
191
|
-
```bash
|
|
192
|
-
# Override the caller ID
|
|
193
|
-
--caller-id "+15551234567"
|
|
194
|
-
|
|
195
|
-
# Override the call direction
|
|
196
|
-
--direction inbound
|
|
197
|
-
|
|
198
|
-
# Override the SIP from address
|
|
199
|
-
--from-addr "sip:user@example.com"
|
|
200
|
-
```
|
|
201
|
-
|
|
202
|
-
### Post Data Overrides (--override)
|
|
203
|
-
|
|
204
|
-
Override specific fields in the mock post_data using dot notation:
|
|
205
|
-
|
|
206
|
-
```bash
|
|
207
|
-
--override "call.call_id=custom-call-123"
|
|
208
|
-
--override "call.from=+15559876543"
|
|
209
|
-
--override "metadata.tenant=acme"
|
|
210
|
-
```
|
|
211
|
-
|
|
212
|
-
---
|
|
213
|
-
|
|
214
|
-
## Mock Data
|
|
215
|
-
|
|
216
|
-
### Full Mock Post Data
|
|
217
|
-
|
|
218
|
-
By default, `swaig-test` generates a comprehensive mock post_data payload that simulates a real SignalWire SWAIG request:
|
|
219
|
-
|
|
220
|
-
```typescript
|
|
221
|
-
{
|
|
222
|
-
function: 'get_weather',
|
|
223
|
-
argument: { city: 'Austin' },
|
|
224
|
-
call_id: 'mock-call-uuid',
|
|
225
|
-
call: {
|
|
226
|
-
call_id: 'mock-call-uuid',
|
|
227
|
-
node_id: 'mock-node-uuid',
|
|
228
|
-
segment_id: 'mock-segment-uuid',
|
|
229
|
-
from: '+15551234567',
|
|
230
|
-
to: '+15559876543',
|
|
231
|
-
direction: 'inbound',
|
|
232
|
-
type: 'phone',
|
|
233
|
-
state: 'answered',
|
|
234
|
-
},
|
|
235
|
-
meta_data: {},
|
|
236
|
-
caller_id_name: 'Mock Caller',
|
|
237
|
-
caller_id_number: '+15551234567',
|
|
238
|
-
}
|
|
239
|
-
```
|
|
240
|
-
|
|
241
|
-
### Minimal Mock Post Data
|
|
242
|
-
|
|
243
|
-
Use `--minimal` to generate a stripped-down post_data with only the essential fields:
|
|
244
|
-
|
|
245
|
-
```bash
|
|
246
|
-
npx tsx src/cli/swaig-test.ts my-agent.ts --exec get_weather --arg city=Austin --minimal
|
|
247
|
-
```
|
|
248
|
-
|
|
249
|
-
### MockCallOptions
|
|
250
|
-
|
|
251
|
-
The mock data generator accepts options for customizing the simulated call:
|
|
252
|
-
|
|
253
|
-
| Option | Type | Description |
|
|
254
|
-
|--------|------|-------------|
|
|
255
|
-
| `callId` | `string` | Custom call ID. |
|
|
256
|
-
| `from` | `string` | Caller number. |
|
|
257
|
-
| `to` | `string` | Destination number. |
|
|
258
|
-
| `direction` | `string` | `"inbound"` or `"outbound"`. |
|
|
259
|
-
| `callerIdName` | `string` | Caller display name. |
|
|
260
|
-
| `sipFrom` | `string` | SIP From address. |
|
|
261
|
-
|
|
262
|
-
---
|
|
263
|
-
|
|
264
|
-
## Output Formatting
|
|
265
|
-
|
|
266
|
-
### Default (Human-Readable)
|
|
267
|
-
|
|
268
|
-
The default output is formatted for readability with section headers, colored output, and indented JSON.
|
|
269
|
-
|
|
270
|
-
### --json
|
|
271
|
-
|
|
272
|
-
Output raw JSON for machine processing:
|
|
273
|
-
|
|
274
|
-
```bash
|
|
275
|
-
npx tsx src/cli/swaig-test.ts my-agent.ts --exec get_weather --arg city=Austin --json
|
|
276
|
-
```
|
|
277
|
-
|
|
278
|
-
### --verbose
|
|
279
|
-
|
|
280
|
-
Enable detailed execution tracing. Shows the full request payload, handler execution details, and timing information. Also enables SDK logging output.
|
|
281
|
-
|
|
282
|
-
```bash
|
|
283
|
-
npx tsx src/cli/swaig-test.ts my-agent.ts --exec get_weather --arg city=Austin --verbose
|
|
284
|
-
```
|
|
285
|
-
|
|
286
|
-
---
|
|
287
|
-
|
|
288
|
-
## Route Override
|
|
289
|
-
|
|
290
|
-
When testing an agent that uses a non-root route, specify the route:
|
|
291
|
-
|
|
292
|
-
```bash
|
|
293
|
-
npx tsx src/cli/swaig-test.ts my-agents.ts --route /support --dump-swml
|
|
294
|
-
```
|
|
295
|
-
|
|
296
|
-
---
|
|
297
|
-
|
|
298
|
-
## Environment Variables
|
|
299
|
-
|
|
300
|
-
| Variable | Description |
|
|
301
|
-
|----------|-------------|
|
|
302
|
-
| `SIGNALWIRE_LOG_LEVEL` | Set log verbosity (`debug`, `info`, `warn`, `error`). Default: suppressed unless `--verbose`. |
|
|
303
|
-
| `SIGNALWIRE_LOG_MODE` | Set to `"off"` to fully suppress logs. Default: suppressed unless `--verbose`. |
|
|
304
|
-
|
|
305
|
-
The CLI automatically suppresses SDK logs unless `--verbose` is specified.
|
|
306
|
-
|
|
307
|
-
---
|
|
308
|
-
|
|
309
|
-
## Serverless Simulation
|
|
310
|
-
|
|
311
|
-
Test agents deployed as serverless functions by simulating the platform environment:
|
|
312
|
-
|
|
313
|
-
```bash
|
|
314
|
-
# Simulate AWS Lambda
|
|
315
|
-
npx tsx src/cli/swaig-test.ts my-agent.ts --serverless lambda --dump-swml
|
|
316
|
-
|
|
317
|
-
# Simulate Google Cloud Functions
|
|
318
|
-
npx tsx src/cli/swaig-test.ts my-agent.ts --serverless gcf --exec my_tool --arg key=val
|
|
319
|
-
|
|
320
|
-
# Simulate Azure Functions
|
|
321
|
-
npx tsx src/cli/swaig-test.ts my-agent.ts --serverless azure --dump-swml
|
|
322
|
-
|
|
323
|
-
# Simulate CGI
|
|
324
|
-
npx tsx src/cli/swaig-test.ts my-agent.ts --serverless cgi --list-tools
|
|
325
|
-
```
|
|
326
|
-
|
|
327
|
-
The serverless simulation sets up the appropriate environment variables and request format for each platform.
|
|
328
|
-
|
|
329
|
-
---
|
|
330
|
-
|
|
331
|
-
## Examples
|
|
332
|
-
|
|
333
|
-
### Dump the SWML Document
|
|
334
|
-
|
|
335
|
-
```bash
|
|
336
|
-
npx tsx src/cli/swaig-test.ts examples/simple_agent.ts --dump-swml
|
|
337
|
-
```
|
|
338
|
-
|
|
339
|
-
```json
|
|
340
|
-
{
|
|
341
|
-
"version": "1.0.0",
|
|
342
|
-
"sections": {
|
|
343
|
-
"main": [
|
|
344
|
-
{ "answer": {} },
|
|
345
|
-
{
|
|
346
|
-
"ai": {
|
|
347
|
-
"prompt": { "text": "You are a helpful assistant." },
|
|
348
|
-
"SWAIG": {
|
|
349
|
-
"functions": [
|
|
350
|
-
{
|
|
351
|
-
"function": "get_weather",
|
|
352
|
-
"description": "Get current weather",
|
|
353
|
-
"parameters": { ... }
|
|
354
|
-
}
|
|
355
|
-
]
|
|
356
|
-
}
|
|
357
|
-
}
|
|
358
|
-
}
|
|
359
|
-
]
|
|
360
|
-
}
|
|
361
|
-
}
|
|
362
|
-
```
|
|
363
|
-
|
|
364
|
-
### List Registered Tools
|
|
365
|
-
|
|
366
|
-
```bash
|
|
367
|
-
npx tsx src/cli/swaig-test.ts examples/skills_demo.ts --list-tools
|
|
368
|
-
```
|
|
369
|
-
|
|
370
|
-
### Execute a Tool
|
|
371
|
-
|
|
372
|
-
```bash
|
|
373
|
-
# Execute with named arguments
|
|
374
|
-
npx tsx src/cli/swaig-test.ts examples/simple_agent.ts \
|
|
375
|
-
--exec get_weather \
|
|
376
|
-
--arg city=Austin \
|
|
377
|
-
--arg units=fahrenheit
|
|
378
|
-
|
|
379
|
-
# Execute with verbose output
|
|
380
|
-
npx tsx src/cli/swaig-test.ts examples/simple_agent.ts \
|
|
381
|
-
--exec get_weather \
|
|
382
|
-
--arg city=Austin \
|
|
383
|
-
--verbose
|
|
384
|
-
```
|
|
385
|
-
|
|
386
|
-
### Test with Custom Caller Data
|
|
387
|
-
|
|
388
|
-
```bash
|
|
389
|
-
npx tsx src/cli/swaig-test.ts examples/simple_dynamic_agent.ts \
|
|
390
|
-
--dump-swml \
|
|
391
|
-
--caller-id "+15551234567" \
|
|
392
|
-
--override "call.direction=outbound"
|
|
393
|
-
```
|
|
394
|
-
|
|
395
|
-
### Simulate a SIP Call
|
|
396
|
-
|
|
397
|
-
```bash
|
|
398
|
-
npx tsx src/cli/swaig-test.ts examples/room_and_sip_example.ts \
|
|
399
|
-
--dump-swml \
|
|
400
|
-
--from-addr "sip:sales@company.com"
|
|
401
|
-
```
|
|
402
|
-
|
|
403
|
-
### Test with Environment Variables
|
|
404
|
-
|
|
405
|
-
```bash
|
|
406
|
-
WEATHER_API_KEY=abc123 npx tsx src/cli/swaig-test.ts \
|
|
407
|
-
examples/simple_agent.ts \
|
|
408
|
-
--exec get_weather \
|
|
409
|
-
--arg city=Austin
|
|
410
|
-
```
|
|
411
|
-
|
|
412
|
-
### Machine-Readable Output
|
|
413
|
-
|
|
414
|
-
```bash
|
|
415
|
-
npx tsx src/cli/swaig-test.ts examples/simple_agent.ts \
|
|
416
|
-
--exec get_weather \
|
|
417
|
-
--arg city=Austin \
|
|
418
|
-
--json
|
|
419
|
-
```
|
|
420
|
-
|
|
421
|
-
### Discover Agents in a File
|
|
422
|
-
|
|
423
|
-
```bash
|
|
424
|
-
# Just run the file with no other flags to discover agents
|
|
425
|
-
npx tsx src/cli/swaig-test.ts examples/multi_agent_server.ts
|
|
426
|
-
|
|
427
|
-
# Or explicitly list agents
|
|
428
|
-
npx tsx src/cli/swaig-test.ts examples/multi_agent_server.ts --list-agents
|
|
429
|
-
```
|
|
430
|
-
|
|
431
|
-
### Test a Specific Agent Class
|
|
432
|
-
|
|
433
|
-
```bash
|
|
434
|
-
npx tsx src/cli/swaig-test.ts examples/multi_agent_server.ts \
|
|
435
|
-
--agent-class SupportAgent \
|
|
436
|
-
--dump-swml
|
|
437
|
-
```
|
|
438
|
-
|
|
439
|
-
### Test a DataMap Tool
|
|
440
|
-
|
|
441
|
-
```bash
|
|
442
|
-
npx tsx src/cli/swaig-test.ts examples/data_map_demo.ts \
|
|
443
|
-
--exec get_weather \
|
|
444
|
-
--arg city=Austin \
|
|
445
|
-
--verbose
|
|
446
|
-
```
|
|
447
|
-
|
|
448
|
-
DataMap tools are automatically detected and simulated -- the CLI makes real HTTP requests using the DataMap's webhook configuration, processes the response through the output template, and displays the result.
|