@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
|
@@ -0,0 +1,265 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
/**
|
|
3
|
+
* generateVerbTypes.ts
|
|
4
|
+
*
|
|
5
|
+
* Build-time script that reads schema.json and generates SwmlVerbMethods.generated.ts.
|
|
6
|
+
* This provides TypeScript interface augmentation so IDE autocomplete works for all
|
|
7
|
+
* auto-vivified verb methods on SwmlBuilder.
|
|
8
|
+
*
|
|
9
|
+
* Usage: npx tsx src/generateVerbTypes.ts
|
|
10
|
+
*/
|
|
11
|
+
import { readFileSync, writeFileSync } from 'fs';
|
|
12
|
+
import { join, dirname } from 'path';
|
|
13
|
+
import { fileURLToPath } from 'url';
|
|
14
|
+
const __filename = fileURLToPath(import.meta.url);
|
|
15
|
+
const __dirname = dirname(__filename);
|
|
16
|
+
/**
|
|
17
|
+
* Map JSON Schema type to TypeScript type string.
|
|
18
|
+
* @param prop - The schema property to map.
|
|
19
|
+
* @param opts - Optional per-property overrides.
|
|
20
|
+
*/
|
|
21
|
+
function mapType(prop, opts) {
|
|
22
|
+
// Handle const values
|
|
23
|
+
if (prop.const !== undefined) {
|
|
24
|
+
// If the caller wants a widened string type, emit 'string' instead of the literal.
|
|
25
|
+
// Used for fields like hangup.reason where Python accepts any string.
|
|
26
|
+
if (opts?.widenStringEnum && typeof prop.const === 'string')
|
|
27
|
+
return 'string';
|
|
28
|
+
return typeof prop.const === 'string' ? `'${prop.const}'` : String(prop.const);
|
|
29
|
+
}
|
|
30
|
+
// Handle $ref
|
|
31
|
+
if (prop.$ref) {
|
|
32
|
+
return 'unknown';
|
|
33
|
+
}
|
|
34
|
+
// Handle anyOf
|
|
35
|
+
if (prop.anyOf) {
|
|
36
|
+
// If wideningStringEnum, and every branch is a string const, collapse to 'string'
|
|
37
|
+
if (opts?.widenStringEnum && prop.anyOf.every(p => p.const !== undefined && typeof p.const === 'string')) {
|
|
38
|
+
return 'string';
|
|
39
|
+
}
|
|
40
|
+
const types = prop.anyOf
|
|
41
|
+
.map(p => mapType(p, opts))
|
|
42
|
+
.filter((t, i, arr) => arr.indexOf(t) === i); // deduplicate
|
|
43
|
+
// Filter out 'unknown' from SWMLVar refs if there are concrete types
|
|
44
|
+
const concreteTypes = types.filter(t => t !== 'unknown');
|
|
45
|
+
if (concreteTypes.length > 0) {
|
|
46
|
+
return concreteTypes.join(' | ');
|
|
47
|
+
}
|
|
48
|
+
return types.join(' | ');
|
|
49
|
+
}
|
|
50
|
+
// Handle oneOf
|
|
51
|
+
if (prop.oneOf) {
|
|
52
|
+
return 'Record<string, unknown>';
|
|
53
|
+
}
|
|
54
|
+
// Handle basic types
|
|
55
|
+
switch (prop.type) {
|
|
56
|
+
case 'string':
|
|
57
|
+
return 'string';
|
|
58
|
+
case 'integer':
|
|
59
|
+
case 'number':
|
|
60
|
+
return 'number';
|
|
61
|
+
case 'boolean':
|
|
62
|
+
return 'boolean';
|
|
63
|
+
case 'array':
|
|
64
|
+
if (prop.items) {
|
|
65
|
+
const itemType = mapType(prop.items);
|
|
66
|
+
return `${itemType}[]`;
|
|
67
|
+
}
|
|
68
|
+
return 'unknown[]';
|
|
69
|
+
case 'object':
|
|
70
|
+
if (prop.properties) {
|
|
71
|
+
return 'Record<string, unknown>';
|
|
72
|
+
}
|
|
73
|
+
return 'Record<string, unknown>';
|
|
74
|
+
default:
|
|
75
|
+
return 'unknown';
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
* Properties that should be widened from a string-const enum to `string` in TypeScript.
|
|
80
|
+
* Python accepts any string for these; the schema's enum values are documentation-only hints.
|
|
81
|
+
* Keyed by verbName, value is the set of property names to widen.
|
|
82
|
+
*/
|
|
83
|
+
const WIDEN_TO_STRING = {
|
|
84
|
+
// Python's SWMLService accepts any string for hangup.reason; the three schema values
|
|
85
|
+
// ('hangup', 'busy', 'decline') are the common platform values, not an exhaustive set.
|
|
86
|
+
hangup: new Set(['reason']),
|
|
87
|
+
};
|
|
88
|
+
/**
|
|
89
|
+
* Custom typed interface definitions for verbs whose schema shape (e.g., $ref or oneOf)
|
|
90
|
+
* cannot be fully expressed by the generic generateVerbConfig() logic.
|
|
91
|
+
*
|
|
92
|
+
* These interfaces match the Python SDK's named parameters for each verb:
|
|
93
|
+
* - AiVerbConfig mirrors: prompt_text, prompt_pom, post_prompt, post_prompt_url, swaig, **kwargs
|
|
94
|
+
* - PlayVerbConfig mirrors: url, urls, volume, say_voice, say_language, say_gender, auto_answer
|
|
95
|
+
*
|
|
96
|
+
* Keyed by verbName. interfaceName is emitted as a top-level export in the generated file;
|
|
97
|
+
* configType references that name; isOptional=true because all Python params are optional.
|
|
98
|
+
*/
|
|
99
|
+
const CUSTOM_VERB_TYPES = {
|
|
100
|
+
ai: {
|
|
101
|
+
interfaceName: 'AiVerbConfig',
|
|
102
|
+
interfaceBody: [
|
|
103
|
+
' /** Text prompt for the AI agent (mutually exclusive with prompt when using POM). */',
|
|
104
|
+
' prompt?: string | Array<Record<string, unknown>>;',
|
|
105
|
+
' /** Optional post-prompt text sent to the LLM after the conversation ends. */',
|
|
106
|
+
' post_prompt?: string;',
|
|
107
|
+
' /** URL to receive post-prompt status callbacks. */',
|
|
108
|
+
' post_prompt_url?: string;',
|
|
109
|
+
' /** SignalWire AI Gateway (SWAIG) configuration for custom function/tool definitions. */',
|
|
110
|
+
' SWAIG?: Record<string, unknown>;',
|
|
111
|
+
' /** Additional AI parameters passed through to the platform. */',
|
|
112
|
+
' [key: string]: unknown;',
|
|
113
|
+
].join('\n'),
|
|
114
|
+
isOptional: true,
|
|
115
|
+
},
|
|
116
|
+
play: {
|
|
117
|
+
interfaceName: 'PlayVerbConfig',
|
|
118
|
+
interfaceBody: [
|
|
119
|
+
' /** Single URL to play (mutually exclusive with urls). */',
|
|
120
|
+
' url?: string;',
|
|
121
|
+
' /** Array of URLs to play (mutually exclusive with url). */',
|
|
122
|
+
' urls?: string[];',
|
|
123
|
+
' /** Volume level for audio playback. Valid range -40 to 40. Default 0. */',
|
|
124
|
+
' volume?: number;',
|
|
125
|
+
' /** Voice name to use for text-to-speech (e.g. "Polly.Joanna"). */',
|
|
126
|
+
' say_voice?: string;',
|
|
127
|
+
' /** Language code for text-to-speech (e.g. "en-US"). */',
|
|
128
|
+
' say_language?: string;',
|
|
129
|
+
' /** Gender for text-to-speech ("male" or "female"). */',
|
|
130
|
+
' say_gender?: string;',
|
|
131
|
+
' /** If true, auto-answer the call before playing audio. Default true. */',
|
|
132
|
+
' auto_answer?: boolean;',
|
|
133
|
+
].join('\n'),
|
|
134
|
+
isOptional: true,
|
|
135
|
+
},
|
|
136
|
+
};
|
|
137
|
+
/** Generate the interface for a verb's config parameter. */
|
|
138
|
+
function generateVerbConfig(verbName, innerSchema) {
|
|
139
|
+
// Some verbs have non-object inner types (e.g. "label" is a string, "sleep" is anyOf)
|
|
140
|
+
if (!innerSchema.type && !innerSchema.anyOf && !innerSchema.oneOf && !innerSchema.properties) {
|
|
141
|
+
// No type info at all (like "return") — accept any
|
|
142
|
+
return { configType: 'unknown', isOptional: true };
|
|
143
|
+
}
|
|
144
|
+
// String type (e.g. "label")
|
|
145
|
+
if (innerSchema.type === 'string') {
|
|
146
|
+
return { configType: 'string', isOptional: false };
|
|
147
|
+
}
|
|
148
|
+
// anyOf (e.g. "sleep" which accepts int or object)
|
|
149
|
+
if (innerSchema.anyOf && innerSchema.type !== 'object') {
|
|
150
|
+
return { configType: 'Record<string, unknown> | number', isOptional: false };
|
|
151
|
+
}
|
|
152
|
+
// oneOf with $ref (e.g. "play")
|
|
153
|
+
if (innerSchema.oneOf) {
|
|
154
|
+
return { configType: 'Record<string, unknown>', isOptional: false };
|
|
155
|
+
}
|
|
156
|
+
// Standard object with properties
|
|
157
|
+
if (innerSchema.type === 'object' && innerSchema.properties) {
|
|
158
|
+
const props = innerSchema.properties;
|
|
159
|
+
const required = new Set(innerSchema.required ?? []);
|
|
160
|
+
const widenProps = WIDEN_TO_STRING[verbName] ?? new Set();
|
|
161
|
+
const lines = [];
|
|
162
|
+
for (const [propName, propDef] of Object.entries(props)) {
|
|
163
|
+
const tsType = mapType(propDef, { widenStringEnum: widenProps.has(propName) });
|
|
164
|
+
const opt = required.has(propName) ? '' : '?';
|
|
165
|
+
const desc = propDef.description
|
|
166
|
+
? ` /** ${propDef.description.replace(/\n/g, ' ').replace(/\*\//g, '* /')} */\n `
|
|
167
|
+
: '';
|
|
168
|
+
lines.push(`${desc}${propName}${opt}: ${tsType}`);
|
|
169
|
+
}
|
|
170
|
+
if (lines.length === 0) {
|
|
171
|
+
// Object type but no props — accept empty config
|
|
172
|
+
return { configType: 'Record<string, unknown>', isOptional: true };
|
|
173
|
+
}
|
|
174
|
+
const hasRequired = required.size > 0;
|
|
175
|
+
const configType = `{ ${lines.join('; ')} }`;
|
|
176
|
+
return { configType, isOptional: !hasRequired };
|
|
177
|
+
}
|
|
178
|
+
// Object type with no properties defined
|
|
179
|
+
if (innerSchema.type === 'object') {
|
|
180
|
+
return { configType: 'Record<string, unknown>', isOptional: true };
|
|
181
|
+
}
|
|
182
|
+
// Fallback
|
|
183
|
+
return { configType: 'Record<string, unknown>', isOptional: true };
|
|
184
|
+
}
|
|
185
|
+
function generate() {
|
|
186
|
+
const schemaPath = join(__dirname, 'schema.json');
|
|
187
|
+
const outputPath = join(__dirname, 'SwmlVerbMethods.generated.ts');
|
|
188
|
+
const schema = JSON.parse(readFileSync(schemaPath, 'utf-8'));
|
|
189
|
+
const defs = schema.$defs;
|
|
190
|
+
const swmlMethod = defs['SWMLMethod'];
|
|
191
|
+
if (!swmlMethod?.anyOf) {
|
|
192
|
+
throw new Error('Schema missing $defs/SWMLMethod.anyOf');
|
|
193
|
+
}
|
|
194
|
+
const methods = [];
|
|
195
|
+
for (const ref of swmlMethod.anyOf) {
|
|
196
|
+
const refPath = ref.$ref;
|
|
197
|
+
if (!refPath)
|
|
198
|
+
continue;
|
|
199
|
+
const schemaName = refPath.split('/').pop();
|
|
200
|
+
const verbDef = defs[schemaName];
|
|
201
|
+
if (!verbDef?.properties)
|
|
202
|
+
continue;
|
|
203
|
+
const propNames = Object.keys(verbDef.properties);
|
|
204
|
+
if (propNames.length === 0)
|
|
205
|
+
continue;
|
|
206
|
+
const verbName = propNames[0];
|
|
207
|
+
const innerSchema = verbDef.properties[verbName];
|
|
208
|
+
// Get description
|
|
209
|
+
const desc = innerSchema.description ?? `Add the ${verbName} verb to the document.`;
|
|
210
|
+
const cleanDesc = desc.replace(/\n/g, ' ').replace(/\*\//g, '* /');
|
|
211
|
+
// Special handling for sleep
|
|
212
|
+
if (verbName === 'sleep') {
|
|
213
|
+
methods.push(` /** ${cleanDesc} */`);
|
|
214
|
+
methods.push(` sleep(durationOrConfig: number | { duration: number }): this;`);
|
|
215
|
+
continue;
|
|
216
|
+
}
|
|
217
|
+
// Special handling for label (takes a string directly)
|
|
218
|
+
if (innerSchema.type === 'string') {
|
|
219
|
+
methods.push(` /** ${cleanDesc} */`);
|
|
220
|
+
methods.push(` ${verbName}(value: string): this;`);
|
|
221
|
+
continue;
|
|
222
|
+
}
|
|
223
|
+
// Use custom typed interface if defined for this verb (e.g. ai, play)
|
|
224
|
+
if (CUSTOM_VERB_TYPES[verbName]) {
|
|
225
|
+
const { interfaceName, isOptional } = CUSTOM_VERB_TYPES[verbName];
|
|
226
|
+
const paramSig = isOptional ? `config?: ${interfaceName}` : `config: ${interfaceName}`;
|
|
227
|
+
methods.push(` /** ${cleanDesc} */`);
|
|
228
|
+
methods.push(` ${verbName}(${paramSig}): this;`);
|
|
229
|
+
continue;
|
|
230
|
+
}
|
|
231
|
+
const { configType, isOptional } = generateVerbConfig(verbName, innerSchema);
|
|
232
|
+
const paramSig = isOptional ? `config?: ${configType}` : `config: ${configType}`;
|
|
233
|
+
methods.push(` /** ${cleanDesc} */`);
|
|
234
|
+
methods.push(` ${verbName}(${paramSig}): this;`);
|
|
235
|
+
}
|
|
236
|
+
// Collect custom interface definitions to emit before the module augmentation
|
|
237
|
+
const customInterfaces = Object.values(CUSTOM_VERB_TYPES)
|
|
238
|
+
.map(({ interfaceName, interfaceBody }) => `export interface ${interfaceName} {\n${interfaceBody}\n}`)
|
|
239
|
+
.join('\n\n');
|
|
240
|
+
const output = `/**
|
|
241
|
+
* AUTO-GENERATED FILE — do not edit manually.
|
|
242
|
+
* Generated by: npx tsx src/generateVerbTypes.ts
|
|
243
|
+
*
|
|
244
|
+
* Provides TypeScript interface augmentation for all SWML verb methods
|
|
245
|
+
* auto-installed on SwmlBuilder from schema.json.
|
|
246
|
+
*/
|
|
247
|
+
|
|
248
|
+
/* eslint-disable @typescript-eslint/no-empty-interface */
|
|
249
|
+
|
|
250
|
+
${customInterfaces}
|
|
251
|
+
|
|
252
|
+
declare module './SwmlBuilder.js' {
|
|
253
|
+
interface SwmlBuilder {
|
|
254
|
+
${methods.join('\n')}
|
|
255
|
+
}
|
|
256
|
+
}
|
|
257
|
+
|
|
258
|
+
export {};
|
|
259
|
+
`;
|
|
260
|
+
writeFileSync(outputPath, output, 'utf-8');
|
|
261
|
+
const verbCount = methods.filter(l => l.includes('): this;')).length;
|
|
262
|
+
console.log(`Generated ${outputPath} with ${verbCount} verb methods.`);
|
|
263
|
+
}
|
|
264
|
+
generate();
|
|
265
|
+
//# sourceMappingURL=generateVerbTypes.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"generateVerbTypes.js","sourceRoot":"","sources":["../src/generateVerbTypes.ts"],"names":[],"mappings":";AACA;;;;;;;;GAQG;AAEH,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,IAAI,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AAEpC,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAClD,MAAM,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;AAuBtC;;;;GAIG;AACH,SAAS,OAAO,CAAC,IAAoB,EAAE,IAAoC;IACzE,sBAAsB;IACtB,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAC7B,mFAAmF;QACnF,sEAAsE;QACtE,IAAI,IAAI,EAAE,eAAe,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ;YAAE,OAAO,QAAQ,CAAC;QAC7E,OAAO,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACjF,CAAC;IAED,cAAc;IACd,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;QACd,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,eAAe;IACf,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,kFAAkF;QAClF,IAAI,IAAI,EAAE,eAAe,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,SAAS,IAAI,OAAO,CAAC,CAAC,KAAK,KAAK,QAAQ,CAAC,EAAE,CAAC;YACzG,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK;aACrB,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;aAC1B,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,cAAc;QAC9D,qEAAqE;QACrE,MAAM,aAAa,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC;QACzD,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC7B,OAAO,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACnC,CAAC;QACD,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAED,eAAe;IACf,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,OAAO,yBAAyB,CAAC;IACnC,CAAC;IAED,qBAAqB;IACrB,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,QAAQ;YACX,OAAO,QAAQ,CAAC;QAClB,KAAK,SAAS,CAAC;QACf,KAAK,QAAQ;YACX,OAAO,QAAQ,CAAC;QAClB,KAAK,SAAS;YACZ,OAAO,SAAS,CAAC;QACnB,KAAK,OAAO;YACV,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACf,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACrC,OAAO,GAAG,QAAQ,IAAI,CAAC;YACzB,CAAC;YACD,OAAO,WAAW,CAAC;QACrB,KAAK,QAAQ;YACX,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBACpB,OAAO,yBAAyB,CAAC;YACnC,CAAC;YACD,OAAO,yBAAyB,CAAC;QACnC;YACE,OAAO,SAAS,CAAC;IACrB,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,eAAe,GAAgC;IACnD,qFAAqF;IACrF,uFAAuF;IACvF,MAAM,EAAE,IAAI,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC;CAC5B,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,iBAAiB,GAA0F;IAC/G,EAAE,EAAE;QACF,aAAa,EAAE,cAAc;QAC7B,aAAa,EAAE;YACb,wFAAwF;YACxF,qDAAqD;YACrD,iFAAiF;YACjF,yBAAyB;YACzB,uDAAuD;YACvD,6BAA6B;YAC7B,4FAA4F;YAC5F,oCAAoC;YACpC,mEAAmE;YACnE,2BAA2B;SAC5B,CAAC,IAAI,CAAC,IAAI,CAAC;QACZ,UAAU,EAAE,IAAI;KACjB;IACD,IAAI,EAAE;QACJ,aAAa,EAAE,gBAAgB;QAC/B,aAAa,EAAE;YACb,6DAA6D;YAC7D,iBAAiB;YACjB,+DAA+D;YAC/D,oBAAoB;YACpB,6EAA6E;YAC7E,oBAAoB;YACpB,sEAAsE;YACtE,uBAAuB;YACvB,2DAA2D;YAC3D,0BAA0B;YAC1B,0DAA0D;YAC1D,wBAAwB;YACxB,4EAA4E;YAC5E,0BAA0B;SAC3B,CAAC,IAAI,CAAC,IAAI,CAAC;QACZ,UAAU,EAAE,IAAI;KACjB;CACF,CAAC;AAEF,4DAA4D;AAC5D,SAAS,kBAAkB,CACzB,QAAgB,EAChB,WAA2B;IAE3B,sFAAsF;IACtF,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;QAC7F,mDAAmD;QACnD,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;IACrD,CAAC;IAED,6BAA6B;IAC7B,IAAI,WAAW,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAClC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC;IACrD,CAAC;IAED,mDAAmD;IACnD,IAAI,WAAW,CAAC,KAAK,IAAI,WAAW,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QACvD,OAAO,EAAE,UAAU,EAAE,kCAAkC,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC;IAC/E,CAAC;IAED,gCAAgC;IAChC,IAAI,WAAW,CAAC,KAAK,EAAE,CAAC;QACtB,OAAO,EAAE,UAAU,EAAE,yBAAyB,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC;IACtE,CAAC;IAED,kCAAkC;IAClC,IAAI,WAAW,CAAC,IAAI,KAAK,QAAQ,IAAI,WAAW,CAAC,UAAU,EAAE,CAAC;QAC5D,MAAM,KAAK,GAAG,WAAW,CAAC,UAAU,CAAC;QACrC,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC;QACrD,MAAM,UAAU,GAAG,eAAe,CAAC,QAAQ,CAAC,IAAI,IAAI,GAAG,EAAU,CAAC;QAClE,MAAM,KAAK,GAAa,EAAE,CAAC;QAE3B,KAAK,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACxD,MAAM,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,EAAE,eAAe,EAAE,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YAC/E,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;YAC9C,MAAM,IAAI,GAAG,OAAO,CAAC,WAAW;gBAC9B,CAAC,CAAC,QAAQ,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,WAAW;gBACpF,CAAC,CAAC,EAAE,CAAC;YACP,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,QAAQ,GAAG,GAAG,KAAK,MAAM,EAAE,CAAC,CAAC;QACpD,CAAC;QAED,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvB,iDAAiD;YACjD,OAAO,EAAE,UAAU,EAAE,yBAAyB,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;QACrE,CAAC;QAED,MAAM,WAAW,GAAG,QAAQ,CAAC,IAAI,GAAG,CAAC,CAAC;QACtC,MAAM,UAAU,GAAG,KAAK,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;QAC7C,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,WAAW,EAAE,CAAC;IAClD,CAAC;IAED,yCAAyC;IACzC,IAAI,WAAW,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAClC,OAAO,EAAE,UAAU,EAAE,yBAAyB,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;IACrE,CAAC;IAED,WAAW;IACX,OAAO,EAAE,UAAU,EAAE,yBAAyB,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;AACrE,CAAC;AAED,SAAS,QAAQ;IACf,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;IAClD,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,EAAE,8BAA8B,CAAC,CAAC;IAEnE,MAAM,MAAM,GAAW,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;IACrE,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC;IAC1B,MAAM,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC;IAEtC,IAAI,CAAC,UAAU,EAAE,KAAK,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;IAC3D,CAAC;IAED,MAAM,OAAO,GAAa,EAAE,CAAC;IAE7B,KAAK,MAAM,GAAG,IAAI,UAAU,CAAC,KAAK,EAAE,CAAC;QACnC,MAAM,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC;QACzB,IAAI,CAAC,OAAO;YAAE,SAAS;QAEvB,MAAM,UAAU,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAG,CAAC;QAC7C,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC;QACjC,IAAI,CAAC,OAAO,EAAE,UAAU;YAAE,SAAS;QAEnC,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAClD,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC;YAAE,SAAS;QAErC,MAAM,QAAQ,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;QAC9B,MAAM,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAmB,CAAC;QAEnE,kBAAkB;QAClB,MAAM,IAAI,GAAG,WAAW,CAAC,WAAW,IAAI,WAAW,QAAQ,wBAAwB,CAAC;QACpF,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAEnE,6BAA6B;QAC7B,IAAI,QAAQ,KAAK,OAAO,EAAE,CAAC;YACzB,OAAO,CAAC,IAAI,CAAC,WAAW,SAAS,KAAK,CAAC,CAAC;YACxC,OAAO,CAAC,IAAI,CAAC,mEAAmE,CAAC,CAAC;YAClF,SAAS;QACX,CAAC;QAED,uDAAuD;QACvD,IAAI,WAAW,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAClC,OAAO,CAAC,IAAI,CAAC,WAAW,SAAS,KAAK,CAAC,CAAC;YACxC,OAAO,CAAC,IAAI,CAAC,OAAO,QAAQ,wBAAwB,CAAC,CAAC;YACtD,SAAS;QACX,CAAC;QAED,sEAAsE;QACtE,IAAI,iBAAiB,CAAC,QAAQ,CAAC,EAAE,CAAC;YAChC,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;YAClE,MAAM,QAAQ,GAAG,UAAU,CAAC,CAAC,CAAC,YAAY,aAAa,EAAE,CAAC,CAAC,CAAC,WAAW,aAAa,EAAE,CAAC;YACvF,OAAO,CAAC,IAAI,CAAC,WAAW,SAAS,KAAK,CAAC,CAAC;YACxC,OAAO,CAAC,IAAI,CAAC,OAAO,QAAQ,IAAI,QAAQ,UAAU,CAAC,CAAC;YACpD,SAAS;QACX,CAAC;QAED,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,GAAG,kBAAkB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAC7E,MAAM,QAAQ,GAAG,UAAU,CAAC,CAAC,CAAC,YAAY,UAAU,EAAE,CAAC,CAAC,CAAC,WAAW,UAAU,EAAE,CAAC;QAEjF,OAAO,CAAC,IAAI,CAAC,WAAW,SAAS,KAAK,CAAC,CAAC;QACxC,OAAO,CAAC,IAAI,CAAC,OAAO,QAAQ,IAAI,QAAQ,UAAU,CAAC,CAAC;IACtD,CAAC;IAED,8EAA8E;IAC9E,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC;SACtD,GAAG,CAAC,CAAC,EAAE,aAAa,EAAE,aAAa,EAAE,EAAE,EAAE,CACxC,oBAAoB,aAAa,OAAO,aAAa,KAAK,CAAC;SAC5D,IAAI,CAAC,MAAM,CAAC,CAAC;IAEhB,MAAM,MAAM,GAAG;;;;;;;;;;EAUf,gBAAgB;;;;EAIhB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;;;;;CAKnB,CAAC;IAEA,aAAa,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAC3C,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC;IACrE,OAAO,CAAC,GAAG,CAAC,aAAa,UAAU,SAAS,SAAS,gBAAgB,CAAC,CAAC;AACzE,CAAC;AAED,QAAQ,EAAE,CAAC"}
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* SignalWire AI Agents SDK for TypeScript / Node.js.
|
|
3
|
+
*
|
|
4
|
+
* Build AI voice agents as HTTP microservices that serve
|
|
5
|
+
* [SWML](https://developer.signalwire.com/sdks/reference/swml/) documents
|
|
6
|
+
* and handle SWAIG function callbacks from the SignalWire platform.
|
|
7
|
+
*
|
|
8
|
+
* @example Minimal agent
|
|
9
|
+
* ```ts
|
|
10
|
+
* import { AgentBase, FunctionResult } from '@signalwire/sdk';
|
|
11
|
+
*
|
|
12
|
+
* const agent = new AgentBase({ name: 'simple', route: '/' });
|
|
13
|
+
*
|
|
14
|
+
* agent.setPromptText("You are a helpful assistant.");
|
|
15
|
+
*
|
|
16
|
+
* agent.defineTool({
|
|
17
|
+
* name: 'get_time',
|
|
18
|
+
* description: 'Return the current server time.',
|
|
19
|
+
* parameters: { type: 'object', properties: {} },
|
|
20
|
+
* handler: () => new FunctionResult(`Time is ${new Date().toISOString()}`),
|
|
21
|
+
* });
|
|
22
|
+
*
|
|
23
|
+
* await agent.serve({ port: 3000 });
|
|
24
|
+
* ```
|
|
25
|
+
*
|
|
26
|
+
* @example Pre-built agent (prefab)
|
|
27
|
+
* ```ts
|
|
28
|
+
* import { ReceptionistAgent } from '@signalwire/sdk';
|
|
29
|
+
*
|
|
30
|
+
* const receptionist = new ReceptionistAgent({
|
|
31
|
+
* name: 'front-desk',
|
|
32
|
+
* departments: [
|
|
33
|
+
* { name: 'sales', description: 'New customers', number: '+15551112222' },
|
|
34
|
+
* { name: 'support', description: 'Existing customers', number: '+15553334444' },
|
|
35
|
+
* ],
|
|
36
|
+
* });
|
|
37
|
+
*
|
|
38
|
+
* await receptionist.serve({ port: 3000 });
|
|
39
|
+
* ```
|
|
40
|
+
*
|
|
41
|
+
* @example REST API client
|
|
42
|
+
* ```ts
|
|
43
|
+
* import { RestClient } from '@signalwire/sdk';
|
|
44
|
+
*
|
|
45
|
+
* const client = new RestClient(); // reads SIGNALWIRE_* env vars
|
|
46
|
+
* const calls = await client.compat.calls.list();
|
|
47
|
+
* ```
|
|
48
|
+
*
|
|
49
|
+
* @see {@link AgentBase} — core agent class
|
|
50
|
+
* @see {@link FunctionResult} — fluent builder for SWAIG tool responses
|
|
51
|
+
* @see {@link ContextBuilder} — multi-step conversation workflows
|
|
52
|
+
* @see {@link DataMap} — server-side tools (no webhook infrastructure required)
|
|
53
|
+
* @see {@link SkillBase} — base class for writing custom skills
|
|
54
|
+
* @see {@link RelayClient} — real-time WebSocket call/message control
|
|
55
|
+
* @see {@link RestClient} — typed HTTP access to SignalWire platform APIs
|
|
56
|
+
*
|
|
57
|
+
* @packageDocumentation
|
|
58
|
+
*/
|
|
59
|
+
export { AgentBase } from './AgentBase.js';
|
|
60
|
+
export type { RoutingCallback } from './AgentBase.js';
|
|
61
|
+
export { AgentServer } from './AgentServer.js';
|
|
62
|
+
export { SWMLService, SecurityConfig } from './SWMLService.js';
|
|
63
|
+
export type { OnRequestCallback, SWMLServiceOptions } from './SWMLService.js';
|
|
64
|
+
export { WebService } from './WebService.js';
|
|
65
|
+
export type { WebServiceOptions } from './WebService.js';
|
|
66
|
+
export { FunctionResult } from './FunctionResult.js';
|
|
67
|
+
/** @deprecated Use {@link FunctionResult} instead. */
|
|
68
|
+
export { FunctionResult as SwaigFunctionResult } from './FunctionResult.js';
|
|
69
|
+
export type { PaymentPrompt, PaymentAction, PaymentParameter } from './FunctionResult.js';
|
|
70
|
+
export { SwaigFunction } from './SwaigFunction.js';
|
|
71
|
+
export type { SwaigHandler, SwaigFunctionOptions } from './SwaigFunction.js';
|
|
72
|
+
export { DataMap, createSimpleApiTool, createExpressionTool, setAllowedEnvPrefixes, getAllowedEnvPrefixes } from './DataMap.js';
|
|
73
|
+
export { PomBuilder, PomSection } from './PomBuilder.js';
|
|
74
|
+
export type { PomSectionData } from './PomBuilder.js';
|
|
75
|
+
export { SwmlBuilder } from './SwmlBuilder.js';
|
|
76
|
+
export type { SwmlBuilderOptions } from './SwmlBuilder.js';
|
|
77
|
+
import './SwmlVerbMethods.generated.js';
|
|
78
|
+
export { SWMLVerbHandler, AIVerbHandler, VerbHandlerRegistry } from './SWMLHandler.js';
|
|
79
|
+
export type { AIVerbBuildOptions } from './SWMLHandler.js';
|
|
80
|
+
export { PromptManager } from './PromptManager.js';
|
|
81
|
+
export { ContextBuilder, Context, Step, GatherInfo, GatherQuestion, createSimpleContext, } from './ContextBuilder.js';
|
|
82
|
+
export { SessionManager } from './SessionManager.js';
|
|
83
|
+
export type { DebugTokenResult } from './SessionManager.js';
|
|
84
|
+
export { SslConfig } from './SslConfig.js';
|
|
85
|
+
export type { SslOptions } from './SslConfig.js';
|
|
86
|
+
export { SchemaUtils } from './SchemaUtils.js';
|
|
87
|
+
export type { ValidationResult } from './SchemaUtils.js';
|
|
88
|
+
export { AuthHandler } from './AuthHandler.js';
|
|
89
|
+
export type { AuthConfig } from './AuthHandler.js';
|
|
90
|
+
export { inferSchema, createTypedHandlerWrapper, parseFunctionParams } from './TypeInference.js';
|
|
91
|
+
export type { InferredSchema, ParsedParam } from './TypeInference.js';
|
|
92
|
+
export { safeAssign, filterSensitiveHeaders, redactUrl, MAX_SKILL_INPUT_LENGTH, validateUrl } from './SecurityUtils.js';
|
|
93
|
+
export { ConfigLoader } from './ConfigLoader.js';
|
|
94
|
+
export { Logger, getLogger, setGlobalLogLevel, suppressAllLogs, setGlobalLogFormat, setGlobalLogColor, setGlobalLogStream, resetLoggingConfiguration, getExecutionMode, stripControlChars } from './Logger.js';
|
|
95
|
+
export { ServerlessAdapter } from './ServerlessAdapter.js';
|
|
96
|
+
export type { ServerlessPlatform, ServerlessEvent, ServerlessResponse } from './ServerlessAdapter.js';
|
|
97
|
+
export { SkillBase, SkillManager, SkillRegistry } from './skills/index.js';
|
|
98
|
+
export type { SkillConfig, SkillToolDefinition, SkillPromptSection, ParameterSchemaEntry, SkillSchemaInfo } from './skills/index.js';
|
|
99
|
+
export { registerBuiltinSkills } from './skills/builtin/index.js';
|
|
100
|
+
export { DateTimeSkill, MathSkill, JokeSkill, WeatherApiSkill, PlayBackgroundFileSkill, SwmlTransferSkill, ApiNinjasTriviaSkill, InfoGathererSkill, CustomSkillsSkill, WebSearchSkill, WikipediaSearchSkill, GoogleMapsSkill, DataSphereSkill, DataSphereServerlessSkill, NativeVectorSearchSkill, SpiderSkill, ClaudeSkillsSkill, AskClaudeSkill, McpGatewaySkill, } from './skills/builtin/index.js';
|
|
101
|
+
export { InfoGathererAgent, SurveyAgent, FAQBotAgent, ConciergeAgent, ReceptionistAgent, } from './prefabs/index.js';
|
|
102
|
+
export type { InfoGathererConfig, SurveyConfig, FAQBotConfig, ConciergeConfig, ReceptionistConfig, } from './prefabs/index.js';
|
|
103
|
+
export type { AgentOptions, LanguageConfig, PronunciationRule, FunctionInclude, DynamicConfigCallback, SummaryCallback, } from './types.js';
|
|
104
|
+
export * from './relay/index.js';
|
|
105
|
+
export * from './rest/index.js';
|
|
106
|
+
export * as livewire from './livewire/index.js';
|
|
107
|
+
import type { AgentBase as _AgentBase } from './AgentBase.js';
|
|
108
|
+
/**
|
|
109
|
+
* Start an agent's HTTP server.
|
|
110
|
+
*
|
|
111
|
+
* Equivalent to Python's `start_agent(agent)`. Delegates to `agent.serve(options)`.
|
|
112
|
+
*
|
|
113
|
+
* @param agent - The {@link AgentBase} instance to start.
|
|
114
|
+
* @param options - Optional host / port overrides. When omitted, values come
|
|
115
|
+
* from the agent's constructor options or the `PORT` environment variable.
|
|
116
|
+
* @returns Resolves once the HTTP server has begun listening.
|
|
117
|
+
*
|
|
118
|
+
* @example
|
|
119
|
+
* ```ts
|
|
120
|
+
* import { AgentBase, startAgent } from '@signalwire/sdk';
|
|
121
|
+
*
|
|
122
|
+
* const agent = new AgentBase({ name: 'demo' });
|
|
123
|
+
* await startAgent(agent, { port: 3000 });
|
|
124
|
+
* ```
|
|
125
|
+
*/
|
|
126
|
+
export declare function startAgent(agent: _AgentBase, options?: {
|
|
127
|
+
port?: number;
|
|
128
|
+
host?: string;
|
|
129
|
+
}): Promise<void>;
|
|
130
|
+
/**
|
|
131
|
+
* Run an agent's HTTP server.
|
|
132
|
+
*
|
|
133
|
+
* Alias for {@link startAgent} — equivalent to Python's `run_agent(agent)`.
|
|
134
|
+
* Delegates to `agent.serve(options)`.
|
|
135
|
+
*
|
|
136
|
+
* @param agent - The {@link AgentBase} instance to run.
|
|
137
|
+
* @param options - Optional host / port overrides. When omitted, values come
|
|
138
|
+
* from the agent's constructor options or the `PORT` environment variable.
|
|
139
|
+
* @returns Resolves once the HTTP server has begun listening.
|
|
140
|
+
*
|
|
141
|
+
* @see {@link startAgent}
|
|
142
|
+
*/
|
|
143
|
+
export declare function runAgent(agent: _AgentBase, options?: {
|
|
144
|
+
port?: number;
|
|
145
|
+
host?: string;
|
|
146
|
+
}): Promise<void>;
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* SignalWire AI Agents SDK for TypeScript / Node.js.
|
|
3
|
+
*
|
|
4
|
+
* Build AI voice agents as HTTP microservices that serve
|
|
5
|
+
* [SWML](https://developer.signalwire.com/sdks/reference/swml/) documents
|
|
6
|
+
* and handle SWAIG function callbacks from the SignalWire platform.
|
|
7
|
+
*
|
|
8
|
+
* @example Minimal agent
|
|
9
|
+
* ```ts
|
|
10
|
+
* import { AgentBase, FunctionResult } from '@signalwire/sdk';
|
|
11
|
+
*
|
|
12
|
+
* const agent = new AgentBase({ name: 'simple', route: '/' });
|
|
13
|
+
*
|
|
14
|
+
* agent.setPromptText("You are a helpful assistant.");
|
|
15
|
+
*
|
|
16
|
+
* agent.defineTool({
|
|
17
|
+
* name: 'get_time',
|
|
18
|
+
* description: 'Return the current server time.',
|
|
19
|
+
* parameters: { type: 'object', properties: {} },
|
|
20
|
+
* handler: () => new FunctionResult(`Time is ${new Date().toISOString()}`),
|
|
21
|
+
* });
|
|
22
|
+
*
|
|
23
|
+
* await agent.serve({ port: 3000 });
|
|
24
|
+
* ```
|
|
25
|
+
*
|
|
26
|
+
* @example Pre-built agent (prefab)
|
|
27
|
+
* ```ts
|
|
28
|
+
* import { ReceptionistAgent } from '@signalwire/sdk';
|
|
29
|
+
*
|
|
30
|
+
* const receptionist = new ReceptionistAgent({
|
|
31
|
+
* name: 'front-desk',
|
|
32
|
+
* departments: [
|
|
33
|
+
* { name: 'sales', description: 'New customers', number: '+15551112222' },
|
|
34
|
+
* { name: 'support', description: 'Existing customers', number: '+15553334444' },
|
|
35
|
+
* ],
|
|
36
|
+
* });
|
|
37
|
+
*
|
|
38
|
+
* await receptionist.serve({ port: 3000 });
|
|
39
|
+
* ```
|
|
40
|
+
*
|
|
41
|
+
* @example REST API client
|
|
42
|
+
* ```ts
|
|
43
|
+
* import { RestClient } from '@signalwire/sdk';
|
|
44
|
+
*
|
|
45
|
+
* const client = new RestClient(); // reads SIGNALWIRE_* env vars
|
|
46
|
+
* const calls = await client.compat.calls.list();
|
|
47
|
+
* ```
|
|
48
|
+
*
|
|
49
|
+
* @see {@link AgentBase} — core agent class
|
|
50
|
+
* @see {@link FunctionResult} — fluent builder for SWAIG tool responses
|
|
51
|
+
* @see {@link ContextBuilder} — multi-step conversation workflows
|
|
52
|
+
* @see {@link DataMap} — server-side tools (no webhook infrastructure required)
|
|
53
|
+
* @see {@link SkillBase} — base class for writing custom skills
|
|
54
|
+
* @see {@link RelayClient} — real-time WebSocket call/message control
|
|
55
|
+
* @see {@link RestClient} — typed HTTP access to SignalWire platform APIs
|
|
56
|
+
*
|
|
57
|
+
* @packageDocumentation
|
|
58
|
+
*/
|
|
59
|
+
// Core agent
|
|
60
|
+
export { AgentBase } from './AgentBase.js';
|
|
61
|
+
export { AgentServer } from './AgentServer.js';
|
|
62
|
+
// SWML Service (non-AI call flows)
|
|
63
|
+
export { SWMLService, SecurityConfig } from './SWMLService.js';
|
|
64
|
+
// Web Service (static file serving)
|
|
65
|
+
export { WebService } from './WebService.js';
|
|
66
|
+
// Tool results & functions
|
|
67
|
+
export { FunctionResult } from './FunctionResult.js';
|
|
68
|
+
/** @deprecated Use {@link FunctionResult} instead. */
|
|
69
|
+
export { FunctionResult as SwaigFunctionResult } from './FunctionResult.js';
|
|
70
|
+
export { SwaigFunction } from './SwaigFunction.js';
|
|
71
|
+
// DataMap (server-side tools)
|
|
72
|
+
export { DataMap, createSimpleApiTool, createExpressionTool, setAllowedEnvPrefixes, getAllowedEnvPrefixes } from './DataMap.js';
|
|
73
|
+
// Prompt Object Model
|
|
74
|
+
export { PomBuilder, PomSection } from './PomBuilder.js';
|
|
75
|
+
// SWML builder
|
|
76
|
+
export { SwmlBuilder } from './SwmlBuilder.js';
|
|
77
|
+
import './SwmlVerbMethods.generated.js';
|
|
78
|
+
// SWML Verb Handlers
|
|
79
|
+
export { SWMLVerbHandler, AIVerbHandler, VerbHandlerRegistry } from './SWMLHandler.js';
|
|
80
|
+
// Prompt management
|
|
81
|
+
export { PromptManager } from './PromptManager.js';
|
|
82
|
+
// Contexts & Steps
|
|
83
|
+
export { ContextBuilder, Context, Step, GatherInfo, GatherQuestion, createSimpleContext, } from './ContextBuilder.js';
|
|
84
|
+
// Security
|
|
85
|
+
export { SessionManager } from './SessionManager.js';
|
|
86
|
+
// SSL
|
|
87
|
+
export { SslConfig } from './SslConfig.js';
|
|
88
|
+
// Schema Validation
|
|
89
|
+
export { SchemaUtils } from './SchemaUtils.js';
|
|
90
|
+
// Auth
|
|
91
|
+
export { AuthHandler } from './AuthHandler.js';
|
|
92
|
+
// Type inference for typed tool handlers
|
|
93
|
+
export { inferSchema, createTypedHandlerWrapper, parseFunctionParams } from './TypeInference.js';
|
|
94
|
+
// Security utilities
|
|
95
|
+
export { safeAssign, filterSensitiveHeaders, redactUrl, MAX_SKILL_INPUT_LENGTH, validateUrl } from './SecurityUtils.js';
|
|
96
|
+
// Config
|
|
97
|
+
export { ConfigLoader } from './ConfigLoader.js';
|
|
98
|
+
// Logging
|
|
99
|
+
export { Logger, getLogger, setGlobalLogLevel, suppressAllLogs, setGlobalLogFormat, setGlobalLogColor, setGlobalLogStream, resetLoggingConfiguration, getExecutionMode, stripControlChars } from './Logger.js';
|
|
100
|
+
// Serverless
|
|
101
|
+
export { ServerlessAdapter } from './ServerlessAdapter.js';
|
|
102
|
+
// Skills
|
|
103
|
+
export { SkillBase, SkillManager, SkillRegistry } from './skills/index.js';
|
|
104
|
+
// Built-in Skills
|
|
105
|
+
export { registerBuiltinSkills } from './skills/builtin/index.js';
|
|
106
|
+
export { DateTimeSkill, MathSkill, JokeSkill, WeatherApiSkill, PlayBackgroundFileSkill, SwmlTransferSkill, ApiNinjasTriviaSkill, InfoGathererSkill, CustomSkillsSkill, WebSearchSkill, WikipediaSearchSkill, GoogleMapsSkill, DataSphereSkill, DataSphereServerlessSkill, NativeVectorSearchSkill, SpiderSkill, ClaudeSkillsSkill, AskClaudeSkill, McpGatewaySkill, } from './skills/builtin/index.js';
|
|
107
|
+
// Prefab Agents
|
|
108
|
+
export { InfoGathererAgent, SurveyAgent, FAQBotAgent, ConciergeAgent, ReceptionistAgent, } from './prefabs/index.js';
|
|
109
|
+
// RELAY Client (real-time call/message control over WebSocket)
|
|
110
|
+
export * from './relay/index.js';
|
|
111
|
+
// REST Client (typed HTTP access to all SignalWire platform APIs)
|
|
112
|
+
export * from './rest/index.js';
|
|
113
|
+
// LiveWire (LiveKit-compatible agents powered by SignalWire)
|
|
114
|
+
export * as livewire from './livewire/index.js';
|
|
115
|
+
/**
|
|
116
|
+
* Start an agent's HTTP server.
|
|
117
|
+
*
|
|
118
|
+
* Equivalent to Python's `start_agent(agent)`. Delegates to `agent.serve(options)`.
|
|
119
|
+
*
|
|
120
|
+
* @param agent - The {@link AgentBase} instance to start.
|
|
121
|
+
* @param options - Optional host / port overrides. When omitted, values come
|
|
122
|
+
* from the agent's constructor options or the `PORT` environment variable.
|
|
123
|
+
* @returns Resolves once the HTTP server has begun listening.
|
|
124
|
+
*
|
|
125
|
+
* @example
|
|
126
|
+
* ```ts
|
|
127
|
+
* import { AgentBase, startAgent } from '@signalwire/sdk';
|
|
128
|
+
*
|
|
129
|
+
* const agent = new AgentBase({ name: 'demo' });
|
|
130
|
+
* await startAgent(agent, { port: 3000 });
|
|
131
|
+
* ```
|
|
132
|
+
*/
|
|
133
|
+
export async function startAgent(agent, options) {
|
|
134
|
+
return agent.serve(options);
|
|
135
|
+
}
|
|
136
|
+
/**
|
|
137
|
+
* Run an agent's HTTP server.
|
|
138
|
+
*
|
|
139
|
+
* Alias for {@link startAgent} — equivalent to Python's `run_agent(agent)`.
|
|
140
|
+
* Delegates to `agent.serve(options)`.
|
|
141
|
+
*
|
|
142
|
+
* @param agent - The {@link AgentBase} instance to run.
|
|
143
|
+
* @param options - Optional host / port overrides. When omitted, values come
|
|
144
|
+
* from the agent's constructor options or the `PORT` environment variable.
|
|
145
|
+
* @returns Resolves once the HTTP server has begun listening.
|
|
146
|
+
*
|
|
147
|
+
* @see {@link startAgent}
|
|
148
|
+
*/
|
|
149
|
+
export async function runAgent(agent, options) {
|
|
150
|
+
return agent.serve(options);
|
|
151
|
+
}
|
|
152
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyDG;AAEH,aAAa;AACb,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,mCAAmC;AACnC,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAG/D,oCAAoC;AACpC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAG7C,2BAA2B;AAC3B,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,sDAAsD;AACtD,OAAO,EAAE,cAAc,IAAI,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAE5E,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAGnD,8BAA8B;AAC9B,OAAO,EAAE,OAAO,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AAEhI,sBAAsB;AACtB,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAGzD,eAAe;AACf,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,OAAO,gCAAgC,CAAC;AAExC,qBAAqB;AACrB,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAGvF,oBAAoB;AACpB,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD,mBAAmB;AACnB,OAAO,EACL,cAAc,EACd,OAAO,EACP,IAAI,EACJ,UAAU,EACV,cAAc,EACd,mBAAmB,GACpB,MAAM,qBAAqB,CAAC;AAE7B,WAAW;AACX,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAGrD,MAAM;AACN,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAG3C,oBAAoB;AACpB,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAG/C,OAAO;AACP,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAG/C,yCAAyC;AACzC,OAAO,EAAE,WAAW,EAAE,yBAAyB,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAGjG,qBAAqB;AACrB,OAAO,EAAE,UAAU,EAAE,sBAAsB,EAAE,SAAS,EAAE,sBAAsB,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAExH,SAAS;AACT,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,UAAU;AACV,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,iBAAiB,EAAE,eAAe,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAE/M,aAAa;AACb,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAG3D,SAAS;AACT,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAG3E,kBAAkB;AAClB,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EACL,aAAa,EAAE,SAAS,EAAE,SAAS,EACnC,eAAe,EAAE,uBAAuB,EAAE,iBAAiB,EAC3D,oBAAoB,EAAE,iBAAiB,EAAE,iBAAiB,EAC1D,cAAc,EAAE,oBAAoB,EAAE,eAAe,EACrD,eAAe,EAAE,yBAAyB,EAAE,uBAAuB,EACnE,WAAW,EAAE,iBAAiB,EAAE,cAAc,EAAE,eAAe,GAChE,MAAM,2BAA2B,CAAC;AAEnC,gBAAgB;AAChB,OAAO,EACL,iBAAiB,EAAE,WAAW,EAAE,WAAW,EAC3C,cAAc,EAAE,iBAAiB,GAClC,MAAM,oBAAoB,CAAC;AAgB5B,+DAA+D;AAC/D,cAAc,kBAAkB,CAAC;AAEjC,kEAAkE;AAClE,cAAc,iBAAiB,CAAC;AAEhC,6DAA6D;AAC7D,OAAO,KAAK,QAAQ,MAAM,qBAAqB,CAAC;AAKhD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,KAAiB,EACjB,OAA0C;IAE1C,OAAO,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AAC9B,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC5B,KAAiB,EACjB,OAA0C;IAE1C,OAAO,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AAC9B,CAAC"}
|