@signalwire/sdk 2.0.1 → 2.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/AgentBase.d.ts +1045 -0
- package/dist/AgentBase.js +2375 -0
- package/dist/AgentBase.js.map +1 -0
- package/dist/AgentServer.d.ts +146 -0
- package/dist/AgentServer.js +388 -0
- package/dist/AgentServer.js.map +1 -0
- package/dist/AuthHandler.d.ts +127 -0
- package/dist/AuthHandler.js +212 -0
- package/dist/AuthHandler.js.map +1 -0
- package/dist/ConfigLoader.d.ts +170 -0
- package/dist/ConfigLoader.js +393 -0
- package/dist/ConfigLoader.js.map +1 -0
- package/dist/ContextBuilder.d.ts +652 -0
- package/dist/ContextBuilder.js +1115 -0
- package/dist/ContextBuilder.js.map +1 -0
- package/dist/DataMap.d.ts +271 -0
- package/dist/DataMap.js +430 -0
- package/dist/DataMap.js.map +1 -0
- package/dist/FunctionResult.d.ts +481 -0
- package/dist/FunctionResult.js +775 -0
- package/dist/FunctionResult.js.map +1 -0
- package/dist/Logger.d.ts +113 -0
- package/dist/Logger.js +320 -0
- package/dist/Logger.js.map +1 -0
- package/dist/PomBuilder.d.ts +208 -0
- package/dist/PomBuilder.js +409 -0
- package/dist/PomBuilder.js.map +1 -0
- package/dist/PromptManager.d.ts +85 -0
- package/dist/PromptManager.js +108 -0
- package/dist/PromptManager.js.map +1 -0
- package/dist/SWMLHandler.d.ts +159 -0
- package/dist/SWMLHandler.js +229 -0
- package/dist/SWMLHandler.js.map +1 -0
- package/dist/SWMLService.d.ts +326 -0
- package/dist/SWMLService.js +610 -0
- package/dist/SWMLService.js.map +1 -0
- package/dist/SchemaUtils.d.ts +108 -0
- package/dist/SchemaUtils.js +317 -0
- package/dist/SchemaUtils.js.map +1 -0
- package/dist/SecurityUtils.d.ts +60 -0
- package/{src/SecurityUtils.ts → dist/SecurityUtils.js} +82 -83
- package/dist/SecurityUtils.js.map +1 -0
- package/dist/ServerlessAdapter.d.ts +119 -0
- package/dist/ServerlessAdapter.js +188 -0
- package/dist/ServerlessAdapter.js.map +1 -0
- package/dist/SessionManager.d.ts +142 -0
- package/dist/SessionManager.js +260 -0
- package/dist/SessionManager.js.map +1 -0
- package/dist/SslConfig.d.ts +77 -0
- package/dist/SslConfig.js +100 -0
- package/dist/SslConfig.js.map +1 -0
- package/dist/SwaigFunction.d.ts +159 -0
- package/dist/SwaigFunction.js +209 -0
- package/dist/SwaigFunction.js.map +1 -0
- package/dist/SwmlBuilder.d.ts +165 -0
- package/dist/SwmlBuilder.js +247 -0
- package/dist/SwmlBuilder.js.map +1 -0
- package/dist/SwmlVerbMethods.generated.d.ts +254 -0
- package/dist/SwmlVerbMethods.generated.js +9 -0
- package/dist/SwmlVerbMethods.generated.js.map +1 -0
- package/dist/TypeInference.d.ts +71 -0
- package/dist/TypeInference.js +164 -0
- package/dist/TypeInference.js.map +1 -0
- package/dist/WebService.d.ts +148 -0
- package/dist/WebService.js +532 -0
- package/dist/WebService.js.map +1 -0
- package/dist/cli/agent-loader.d.ts +22 -0
- package/dist/cli/agent-loader.js +144 -0
- package/dist/cli/agent-loader.js.map +1 -0
- package/dist/cli/mock-data.d.ts +37 -0
- package/dist/cli/mock-data.js +80 -0
- package/dist/cli/mock-data.js.map +1 -0
- package/dist/cli/swaig-test.d.ts +32 -0
- package/dist/cli/swaig-test.js +418 -0
- package/dist/cli/swaig-test.js.map +1 -0
- package/dist/generateVerbTypes.d.ts +11 -0
- package/dist/generateVerbTypes.js +265 -0
- package/dist/generateVerbTypes.js.map +1 -0
- package/{src/index.ts → dist/index.d.ts} +13 -100
- package/dist/index.js +152 -0
- package/dist/index.js.map +1 -0
- package/dist/livewire/index.d.ts +653 -0
- package/dist/livewire/index.js +992 -0
- package/dist/livewire/index.js.map +1 -0
- package/dist/prefabs/ConciergeAgent.d.ts +89 -0
- package/dist/prefabs/ConciergeAgent.js +245 -0
- package/dist/prefabs/ConciergeAgent.js.map +1 -0
- package/dist/prefabs/FAQBotAgent.d.ts +113 -0
- package/dist/prefabs/FAQBotAgent.js +329 -0
- package/dist/prefabs/FAQBotAgent.js.map +1 -0
- package/dist/prefabs/InfoGathererAgent.d.ts +126 -0
- package/dist/prefabs/InfoGathererAgent.js +287 -0
- package/dist/prefabs/InfoGathererAgent.js.map +1 -0
- package/dist/prefabs/ReceptionistAgent.d.ts +104 -0
- package/dist/prefabs/ReceptionistAgent.js +303 -0
- package/dist/prefabs/ReceptionistAgent.js.map +1 -0
- package/dist/prefabs/SurveyAgent.d.ts +148 -0
- package/dist/prefabs/SurveyAgent.js +540 -0
- package/dist/prefabs/SurveyAgent.js.map +1 -0
- package/{src/prefabs/index.ts → dist/prefabs/index.d.ts} +1 -15
- package/dist/prefabs/index.js +14 -0
- package/dist/prefabs/index.js.map +1 -0
- package/dist/relay/Action.d.ts +258 -0
- package/dist/relay/Action.js +402 -0
- package/dist/relay/Action.js.map +1 -0
- package/dist/relay/Call.d.ts +697 -0
- package/dist/relay/Call.js +1062 -0
- package/dist/relay/Call.js.map +1 -0
- package/dist/relay/Deferred.d.ts +44 -0
- package/dist/relay/Deferred.js +69 -0
- package/dist/relay/Deferred.js.map +1 -0
- package/dist/relay/Message.d.ts +103 -0
- package/dist/relay/Message.js +169 -0
- package/dist/relay/Message.js.map +1 -0
- package/dist/relay/RelayClient.d.ts +302 -0
- package/dist/relay/RelayClient.js +1026 -0
- package/dist/relay/RelayClient.js.map +1 -0
- package/dist/relay/RelayError.d.ts +15 -0
- package/dist/relay/RelayError.js +20 -0
- package/dist/relay/RelayError.js.map +1 -0
- package/dist/relay/RelayEvent.d.ts +254 -0
- package/dist/relay/RelayEvent.js +509 -0
- package/dist/relay/RelayEvent.js.map +1 -0
- package/dist/relay/constants.d.ts +90 -0
- package/{src/relay/constants.ts → dist/relay/constants.js} +11 -29
- package/dist/relay/constants.js.map +1 -0
- package/dist/relay/index.d.ts +16 -0
- package/dist/relay/index.js +18 -0
- package/dist/relay/index.js.map +1 -0
- package/dist/relay/types.d.ts +142 -0
- package/dist/relay/types.js +5 -0
- package/dist/relay/types.js.map +1 -0
- package/dist/rest/HttpClient.d.ts +80 -0
- package/dist/rest/HttpClient.js +148 -0
- package/dist/rest/HttpClient.js.map +1 -0
- package/dist/rest/RestError.d.ts +30 -0
- package/dist/rest/RestError.js +39 -0
- package/dist/rest/RestError.js.map +1 -0
- package/dist/rest/base/BaseResource.d.ts +24 -0
- package/dist/rest/base/BaseResource.js +29 -0
- package/dist/rest/base/BaseResource.js.map +1 -0
- package/dist/rest/base/CrudResource.d.ts +68 -0
- package/dist/rest/base/CrudResource.js +82 -0
- package/dist/rest/base/CrudResource.js.map +1 -0
- package/dist/rest/base/CrudWithAddresses.d.ts +22 -0
- package/dist/rest/base/CrudWithAddresses.js +25 -0
- package/dist/rest/base/CrudWithAddresses.js.map +1 -0
- package/dist/rest/index.d.ts +131 -0
- package/{src/rest/index.ts → dist/rest/index.js} +101 -136
- package/dist/rest/index.js.map +1 -0
- package/dist/rest/namespaces/addresses.d.ts +46 -0
- package/dist/rest/namespaces/addresses.js +55 -0
- package/dist/rest/namespaces/addresses.js.map +1 -0
- package/dist/rest/namespaces/calling.d.ts +382 -0
- package/dist/rest/namespaces/calling.js +478 -0
- package/dist/rest/namespaces/calling.js.map +1 -0
- package/dist/rest/namespaces/chat.d.ts +22 -0
- package/dist/rest/namespaces/chat.js +26 -0
- package/dist/rest/namespaces/chat.js.map +1 -0
- package/dist/rest/namespaces/compat.d.ts +585 -0
- package/dist/rest/namespaces/compat.js +735 -0
- package/dist/rest/namespaces/compat.js.map +1 -0
- package/dist/rest/namespaces/datasphere.d.ts +66 -0
- package/dist/rest/namespaces/datasphere.js +77 -0
- package/dist/rest/namespaces/datasphere.js.map +1 -0
- package/dist/rest/namespaces/fabric.d.ts +282 -0
- package/dist/rest/namespaces/fabric.js +373 -0
- package/dist/rest/namespaces/fabric.js.map +1 -0
- package/dist/rest/namespaces/imported-numbers.d.ts +22 -0
- package/dist/rest/namespaces/imported-numbers.js +26 -0
- package/dist/rest/namespaces/imported-numbers.js.map +1 -0
- package/dist/rest/namespaces/logs.d.ts +105 -0
- package/dist/rest/namespaces/logs.js +133 -0
- package/dist/rest/namespaces/logs.js.map +1 -0
- package/dist/rest/namespaces/lookup.d.ts +29 -0
- package/dist/rest/namespaces/lookup.js +32 -0
- package/dist/rest/namespaces/lookup.js.map +1 -0
- package/dist/rest/namespaces/mfa.d.ts +46 -0
- package/dist/rest/namespaces/mfa.js +54 -0
- package/dist/rest/namespaces/mfa.js.map +1 -0
- package/dist/rest/namespaces/number-groups.d.ts +49 -0
- package/dist/rest/namespaces/number-groups.js +58 -0
- package/dist/rest/namespaces/number-groups.js.map +1 -0
- package/dist/rest/namespaces/phone-numbers.d.ts +60 -0
- package/dist/rest/namespaces/phone-numbers.js +67 -0
- package/dist/rest/namespaces/phone-numbers.js.map +1 -0
- package/dist/rest/namespaces/project.d.ts +46 -0
- package/dist/rest/namespaces/project.js +56 -0
- package/dist/rest/namespaces/project.js.map +1 -0
- package/dist/rest/namespaces/pubsub.d.ts +22 -0
- package/dist/rest/namespaces/pubsub.js +26 -0
- package/dist/rest/namespaces/pubsub.js.map +1 -0
- package/dist/rest/namespaces/queues.d.ts +42 -0
- package/dist/rest/namespaces/queues.js +49 -0
- package/dist/rest/namespaces/queues.js.map +1 -0
- package/dist/rest/namespaces/recordings.d.ts +38 -0
- package/dist/rest/namespaces/recordings.js +45 -0
- package/dist/rest/namespaces/recordings.js.map +1 -0
- package/dist/rest/namespaces/registry.d.ts +141 -0
- package/dist/rest/namespaces/registry.js +178 -0
- package/dist/rest/namespaces/registry.js.map +1 -0
- package/dist/rest/namespaces/short-codes.d.ts +39 -0
- package/dist/rest/namespaces/short-codes.js +46 -0
- package/dist/rest/namespaces/short-codes.js.map +1 -0
- package/dist/rest/namespaces/sip-profile.d.ts +28 -0
- package/dist/rest/namespaces/sip-profile.js +34 -0
- package/dist/rest/namespaces/sip-profile.js.map +1 -0
- package/dist/rest/namespaces/verified-callers.d.ts +33 -0
- package/dist/rest/namespaces/verified-callers.js +39 -0
- package/dist/rest/namespaces/verified-callers.js.map +1 -0
- package/dist/rest/namespaces/video.d.ts +235 -0
- package/dist/rest/namespaces/video.js +297 -0
- package/dist/rest/namespaces/video.js.map +1 -0
- package/{src/rest/pagination.ts → dist/rest/pagination.d.ts} +2 -61
- package/dist/rest/pagination.js +78 -0
- package/dist/rest/pagination.js.map +1 -0
- package/dist/rest/types.d.ts +54 -0
- package/dist/rest/types.js +5 -0
- package/dist/rest/types.js.map +1 -0
- package/dist/skills/SkillBase.d.ts +404 -0
- package/dist/skills/SkillBase.js +471 -0
- package/dist/skills/SkillBase.js.map +1 -0
- package/dist/skills/SkillManager.d.ts +195 -0
- package/dist/skills/SkillManager.js +378 -0
- package/dist/skills/SkillManager.js.map +1 -0
- package/dist/skills/SkillRegistry.d.ts +176 -0
- package/dist/skills/SkillRegistry.js +310 -0
- package/dist/skills/SkillRegistry.js.map +1 -0
- package/dist/skills/builtin/api_ninjas_trivia.d.ts +47 -0
- package/dist/skills/builtin/api_ninjas_trivia.js +211 -0
- package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -0
- package/dist/skills/builtin/ask_claude.d.ts +37 -0
- package/dist/skills/builtin/ask_claude.js +162 -0
- package/dist/skills/builtin/ask_claude.js.map +1 -0
- package/dist/skills/builtin/claude_skills.d.ts +75 -0
- package/dist/skills/builtin/claude_skills.js +753 -0
- package/dist/skills/builtin/claude_skills.js.map +1 -0
- package/dist/skills/builtin/custom_skills.d.ts +79 -0
- package/dist/skills/builtin/custom_skills.js +227 -0
- package/dist/skills/builtin/custom_skills.js.map +1 -0
- package/dist/skills/builtin/datasphere.d.ts +73 -0
- package/dist/skills/builtin/datasphere.js +350 -0
- package/dist/skills/builtin/datasphere.js.map +1 -0
- package/dist/skills/builtin/datasphere_serverless.d.ts +89 -0
- package/dist/skills/builtin/datasphere_serverless.js +291 -0
- package/dist/skills/builtin/datasphere_serverless.js.map +1 -0
- package/dist/skills/builtin/datetime.d.ts +40 -0
- package/dist/skills/builtin/datetime.js +118 -0
- package/dist/skills/builtin/datetime.js.map +1 -0
- package/dist/skills/builtin/google_maps.d.ts +48 -0
- package/dist/skills/builtin/google_maps.js +470 -0
- package/dist/skills/builtin/google_maps.js.map +1 -0
- package/dist/skills/builtin/index.d.ts +31 -0
- package/{src/skills/builtin/index.ts → dist/skills/builtin/index.js} +30 -36
- package/dist/skills/builtin/index.js.map +1 -0
- package/dist/skills/builtin/info_gatherer.d.ts +115 -0
- package/dist/skills/builtin/info_gatherer.js +328 -0
- package/dist/skills/builtin/info_gatherer.js.map +1 -0
- package/dist/skills/builtin/joke.d.ts +41 -0
- package/dist/skills/builtin/joke.js +156 -0
- package/dist/skills/builtin/joke.js.map +1 -0
- package/dist/skills/builtin/math.d.ts +39 -0
- package/dist/skills/builtin/math.js +119 -0
- package/dist/skills/builtin/math.js.map +1 -0
- package/dist/skills/builtin/mcp_gateway.d.ts +82 -0
- package/dist/skills/builtin/mcp_gateway.js +574 -0
- package/dist/skills/builtin/mcp_gateway.js.map +1 -0
- package/dist/skills/builtin/native_vector_search.d.ts +128 -0
- package/dist/skills/builtin/native_vector_search.js +752 -0
- package/dist/skills/builtin/native_vector_search.js.map +1 -0
- package/dist/skills/builtin/play_background_file.d.ts +59 -0
- package/dist/skills/builtin/play_background_file.js +274 -0
- package/dist/skills/builtin/play_background_file.js.map +1 -0
- package/dist/skills/builtin/spider.d.ts +91 -0
- package/dist/skills/builtin/spider.js +758 -0
- package/dist/skills/builtin/spider.js.map +1 -0
- package/dist/skills/builtin/swml_transfer.d.ts +66 -0
- package/dist/skills/builtin/swml_transfer.js +475 -0
- package/dist/skills/builtin/swml_transfer.js.map +1 -0
- package/dist/skills/builtin/weather_api.d.ts +59 -0
- package/dist/skills/builtin/weather_api.js +196 -0
- package/dist/skills/builtin/weather_api.js.map +1 -0
- package/dist/skills/builtin/web_search.d.ts +160 -0
- package/dist/skills/builtin/web_search.js +894 -0
- package/dist/skills/builtin/web_search.js.map +1 -0
- package/dist/skills/builtin/wikipedia_search.d.ts +77 -0
- package/dist/skills/builtin/wikipedia_search.js +241 -0
- package/dist/skills/builtin/wikipedia_search.js.map +1 -0
- package/{src/skills/index.ts → dist/skills/index.d.ts} +0 -1
- package/dist/skills/index.js +10 -0
- package/dist/skills/index.js.map +1 -0
- package/dist/types.d.ts +118 -0
- package/dist/types.js +5 -0
- package/dist/types.js.map +1 -0
- package/package.json +7 -1
- package/.github/workflows/publish.yml +0 -27
- package/.github/workflows/test.yml +0 -17
- package/CLAUDE.md +0 -112
- package/docs/MIGRATION-2.0.md +0 -81
- package/docs/agent-guide.md +0 -869
- package/docs/agent_guide.md +0 -1026
- package/docs/api-reference.md +0 -2420
- package/docs/api_reference.md +0 -1301
- package/docs/architecture.md +0 -843
- package/docs/cli-guide.md +0 -579
- package/docs/cli_guide.md +0 -448
- package/docs/cloud_functions_guide.md +0 -474
- package/docs/configuration.md +0 -422
- package/docs/contexts-guide.md +0 -787
- package/docs/contexts_guide.md +0 -511
- package/docs/datamap-guide.md +0 -1141
- package/docs/datamap_guide.md +0 -595
- package/docs/llm_parameters.md +0 -239
- package/docs/mcp_gateway_reference.md +0 -648
- package/docs/mcp_integration.md +0 -108
- package/docs/prefabs-guide.md +0 -800
- package/docs/sdk_features.md +0 -477
- package/docs/security.md +0 -436
- package/docs/serverless-guide.md +0 -513
- package/docs/skills-guide.md +0 -857
- package/docs/skills-system.md +0 -301
- package/docs/skills_parameter_schema.md +0 -392
- package/docs/skills_system.md +0 -467
- package/docs/swaig-reference.md +0 -1627
- package/docs/swaig_reference.md +0 -910
- package/docs/swml_service_guide.md +0 -600
- package/docs/third_party_skills.md +0 -533
- package/docs/web_service.md +0 -677
- package/examples/README.md +0 -131
- package/examples/advanced-datamap.ts +0 -100
- package/examples/advanced-dynamic-config.ts +0 -70
- package/examples/auto-vivified.ts +0 -94
- package/examples/call-flow.ts +0 -63
- package/examples/comprehensive-dynamic.ts +0 -125
- package/examples/contexts-steps.ts +0 -65
- package/examples/custom-path.ts +0 -45
- package/examples/datamap-tools.ts +0 -55
- package/examples/datasphere-multi-instance.ts +0 -63
- package/examples/datasphere-serverless-env.ts +0 -68
- package/examples/datasphere-webhook-env.ts +0 -66
- package/examples/datasphere.ts +0 -37
- package/examples/declarative.ts +0 -100
- package/examples/dynamic-config.ts +0 -54
- package/examples/dynamic-info-gatherer.ts +0 -69
- package/examples/dynamic-swml-service.ts +0 -67
- package/examples/gather-info.ts +0 -71
- package/examples/gather-per-question-functions-demo.ts +0 -140
- package/examples/joke-agent.ts +0 -34
- package/examples/kubernetes-agent.ts +0 -45
- package/examples/llm-params.ts +0 -69
- package/examples/mcp-agent.ts +0 -84
- package/examples/mcp-gateway.ts +0 -35
- package/examples/multi-agent.ts +0 -73
- package/examples/multi-endpoint.ts +0 -79
- package/examples/pom-prompt.ts +0 -71
- package/examples/prefab-concierge.ts +0 -47
- package/examples/prefab-faq.ts +0 -54
- package/examples/prefab-info-gatherer.ts +0 -33
- package/examples/prefab-receptionist.ts +0 -36
- package/examples/prefab-survey.ts +0 -68
- package/examples/record-call.ts +0 -67
- package/examples/relay-demo.ts +0 -33
- package/examples/room-and-sip.ts +0 -94
- package/examples/serverless-lambda.ts +0 -35
- package/examples/session-state.ts +0 -83
- package/examples/simple-agent.ts +0 -36
- package/examples/simple-static.ts +0 -29
- package/examples/skills-demo.ts +0 -38
- package/examples/step-function-inheritance-demo.ts +0 -124
- package/examples/swaig-features.ts +0 -187
- package/examples/swml-service-routing.ts +0 -66
- package/examples/swml-service.ts +0 -38
- package/examples/tap.ts +0 -68
- package/examples/verb-methods.ts +0 -45
- package/examples/web-search-multi-instance.ts +0 -72
- package/examples/web-search.ts +0 -38
- package/examples/wikipedia.ts +0 -36
- package/livewire/README.md +0 -140
- package/livewire/docs/migration-guide.md +0 -228
- package/livewire/examples/livewire-basic-agent.ts +0 -74
- package/livewire/examples/livewire-handoff.ts +0 -197
- package/livewire/examples/livewire-multi-tool.ts +0 -117
- package/relay/README.md +0 -70
- package/relay/RELAY_IMPLEMENTATION_GUIDE.md +0 -1257
- package/relay/docs/call-methods.md +0 -474
- package/relay/docs/client-reference.md +0 -142
- package/relay/docs/events.md +0 -134
- package/relay/docs/getting-started.md +0 -134
- package/relay/docs/guide.md +0 -306
- package/relay/docs/messaging.md +0 -182
- package/relay/examples/relay-inbound.ts +0 -66
- package/relay/examples/relay-messaging.ts +0 -71
- package/relay/examples/relay-outbound.ts +0 -76
- package/rest/README.md +0 -95
- package/rest/docs/calling.md +0 -273
- package/rest/docs/client-reference.md +0 -107
- package/rest/docs/compat.md +0 -204
- package/rest/docs/fabric.md +0 -183
- package/rest/docs/getting-started.md +0 -110
- package/rest/docs/guide.md +0 -351
- package/rest/docs/namespaces.md +0 -285
- package/rest/examples/rest-10dlc-registration.ts +0 -161
- package/rest/examples/rest-calling-ivr-and-ai.ts +0 -102
- package/rest/examples/rest-calling-play-and-record.ts +0 -91
- package/rest/examples/rest-client.ts +0 -65
- package/rest/examples/rest-compat-laml.ts +0 -210
- package/rest/examples/rest-datasphere-search.ts +0 -82
- package/rest/examples/rest-fabric-conferences-and-routing.ts +0 -144
- package/rest/examples/rest-fabric-subscribers-and-sip.ts +0 -108
- package/rest/examples/rest-fabric-swml-and-callflows.ts +0 -99
- package/rest/examples/rest-manage-resources.ts +0 -65
- package/rest/examples/rest-phone-number-management.ts +0 -197
- package/rest/examples/rest-queues-mfa-and-recordings.ts +0 -143
- package/rest/examples/rest-video-rooms.ts +0 -186
- package/src/AgentBase.ts +0 -2598
- package/src/AgentServer.ts +0 -442
- package/src/AuthHandler.ts +0 -256
- package/src/ConfigLoader.ts +0 -447
- package/src/ContextBuilder.ts +0 -1181
- package/src/DataMap.ts +0 -477
- package/src/FunctionResult.ts +0 -903
- package/src/Logger.ts +0 -337
- package/src/PomBuilder.ts +0 -467
- package/src/PromptManager.ts +0 -133
- package/src/SWMLHandler.ts +0 -298
- package/src/SWMLService.ts +0 -749
- package/src/SchemaUtils.ts +0 -361
- package/src/ServerlessAdapter.ts +0 -240
- package/src/SessionManager.ts +0 -311
- package/src/SslConfig.ts +0 -118
- package/src/SwaigFunction.ts +0 -276
- package/src/SwmlBuilder.ts +0 -283
- package/src/SwmlVerbMethods.generated.ts +0 -234
- package/src/TypeInference.ts +0 -199
- package/src/WebService.ts +0 -641
- package/src/cli/agent-loader.ts +0 -166
- package/src/cli/mock-data.ts +0 -111
- package/src/cli/swaig-test.ts +0 -452
- package/src/generateVerbTypes.ts +0 -322
- package/src/livewire/index.ts +0 -1252
- package/src/prefabs/ConciergeAgent.ts +0 -309
- package/src/prefabs/FAQBotAgent.ts +0 -415
- package/src/prefabs/InfoGathererAgent.ts +0 -379
- package/src/prefabs/ReceptionistAgent.ts +0 -395
- package/src/prefabs/SurveyAgent.ts +0 -671
- package/src/relay/Action.ts +0 -482
- package/src/relay/Call.ts +0 -1270
- package/src/relay/Deferred.ts +0 -94
- package/src/relay/Message.ts +0 -199
- package/src/relay/RelayClient.ts +0 -1185
- package/src/relay/RelayError.ts +0 -20
- package/src/relay/RelayEvent.ts +0 -944
- package/src/relay/index.ts +0 -123
- package/src/relay/types.ts +0 -149
- package/src/rest/HttpClient.ts +0 -164
- package/src/rest/RestError.ts +0 -45
- package/src/rest/base/BaseResource.ts +0 -32
- package/src/rest/base/CrudResource.ts +0 -98
- package/src/rest/base/CrudWithAddresses.ts +0 -37
- package/src/rest/namespaces/addresses.ts +0 -64
- package/src/rest/namespaces/calling.ts +0 -534
- package/src/rest/namespaces/chat.ts +0 -31
- package/src/rest/namespaces/compat.ts +0 -812
- package/src/rest/namespaces/datasphere.ts +0 -88
- package/src/rest/namespaces/fabric.ts +0 -417
- package/src/rest/namespaces/imported-numbers.ts +0 -31
- package/src/rest/namespaces/logs.ts +0 -151
- package/src/rest/namespaces/lookup.ts +0 -38
- package/src/rest/namespaces/mfa.ts +0 -61
- package/src/rest/namespaces/number-groups.ts +0 -68
- package/src/rest/namespaces/phone-numbers.ts +0 -76
- package/src/rest/namespaces/project.ts +0 -65
- package/src/rest/namespaces/pubsub.ts +0 -31
- package/src/rest/namespaces/queues.ts +0 -58
- package/src/rest/namespaces/recordings.ts +0 -53
- package/src/rest/namespaces/registry.ts +0 -200
- package/src/rest/namespaces/short-codes.ts +0 -54
- package/src/rest/namespaces/sip-profile.ts +0 -40
- package/src/rest/namespaces/verified-callers.ts +0 -46
- package/src/rest/namespaces/video.ts +0 -332
- package/src/rest/types.ts +0 -61
- package/src/skills/SkillBase.ts +0 -582
- package/src/skills/SkillManager.ts +0 -419
- package/src/skills/SkillRegistry.ts +0 -367
- package/src/skills/builtin/api_ninjas_trivia.ts +0 -285
- package/src/skills/builtin/ask_claude.ts +0 -246
- package/src/skills/builtin/claude_skills.ts +0 -983
- package/src/skills/builtin/custom_skills.ts +0 -327
- package/src/skills/builtin/datasphere.ts +0 -447
- package/src/skills/builtin/datasphere_serverless.ts +0 -347
- package/src/skills/builtin/datetime.ts +0 -137
- package/src/skills/builtin/google_maps.ts +0 -656
- package/src/skills/builtin/info_gatherer.ts +0 -415
- package/src/skills/builtin/joke.ts +0 -196
- package/src/skills/builtin/math.ts +0 -149
- package/src/skills/builtin/mcp_gateway.ts +0 -685
- package/src/skills/builtin/native_vector_search.ts +0 -910
- package/src/skills/builtin/play_background_file.ts +0 -367
- package/src/skills/builtin/spider.ts +0 -874
- package/src/skills/builtin/swml_transfer.ts +0 -645
- package/src/skills/builtin/weather_api.ts +0 -255
- package/src/skills/builtin/web_search.ts +0 -1083
- package/src/skills/builtin/wikipedia_search.ts +0 -304
- package/src/types.ts +0 -132
- package/tests/AgentBase.test.ts +0 -1093
- package/tests/AgentServer.test.ts +0 -126
- package/tests/AuthHandler.test.ts +0 -133
- package/tests/ConfigLoader.test.ts +0 -151
- package/tests/ContextBuilder.test.ts +0 -108
- package/tests/DataMap.test.ts +0 -367
- package/tests/EphemeralSkillCopy.test.ts +0 -107
- package/tests/FunctionResult.test.ts +0 -298
- package/tests/GracefulShutdown.test.ts +0 -46
- package/tests/Logger.test.ts +0 -420
- package/tests/PomBuilder.test.ts +0 -228
- package/tests/ProxyDetection.test.ts +0 -228
- package/tests/SWMLService.test.ts +0 -320
- package/tests/SWMLVerbHandler.test.ts +0 -523
- package/tests/SchemaUtils.test.ts +0 -106
- package/tests/SchemaUtils.verb.test.ts +0 -206
- package/tests/SecurityUtils.test.ts +0 -192
- package/tests/ServerlessAdapter.test.ts +0 -222
- package/tests/SessionManager.test.ts +0 -257
- package/tests/SkillBaseFeatures.test.ts +0 -130
- package/tests/SkillMultiInstance.test.ts +0 -102
- package/tests/SkillParameterSchemas.test.ts +0 -134
- package/tests/SkillRegistrySchema.test.ts +0 -84
- package/tests/SslConfig.test.ts +0 -97
- package/tests/SwmlBuilder.test.ts +0 -400
- package/tests/TypeInference.test.ts +0 -165
- package/tests/VerbHandlerRegistry.test.ts +0 -128
- package/tests/cli/mock-data.test.ts +0 -113
- package/tests/cli/swaig-test.test.ts +0 -108
- package/tests/examples.test.ts +0 -194
- package/tests/fixtures/scrape-parity/README.md +0 -53
- package/tests/fixtures/scrape-parity/expected/01_simple_article.json +0 -5
- package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +0 -5
- package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +0 -5
- package/tests/fixtures/scrape-parity/expected/04_bare_body.json +0 -5
- package/tests/fixtures/scrape-parity/expected/05_malformed.json +0 -5
- package/tests/fixtures/scrape-parity/expected/06_multi_class.json +0 -5
- package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +0 -5
- package/tests/fixtures/scrape-parity/expected/08_inline_script.json +0 -5
- package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +0 -5
- package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +0 -5
- package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +0 -5
- package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +0 -5
- package/tests/fixtures/scrape-parity/html/01_simple_article.html +0 -18
- package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +0 -18
- package/tests/fixtures/scrape-parity/html/03_nested_containers.html +0 -13
- package/tests/fixtures/scrape-parity/html/04_bare_body.html +0 -9
- package/tests/fixtures/scrape-parity/html/05_malformed.html +0 -11
- package/tests/fixtures/scrape-parity/html/06_multi_class.html +0 -18
- package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +0 -12
- package/tests/fixtures/scrape-parity/html/08_inline_script.html +0 -17
- package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +0 -21
- package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +0 -10
- package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +0 -13
- package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +0 -24
- package/tests/fixtures/scrape-parity/python_extract.py +0 -109
- package/tests/livewire/livewire.test.ts +0 -780
- package/tests/mcp.test.ts +0 -221
- package/tests/prefabs/prefabs.test.ts +0 -1093
- package/tests/relay/Action.test.ts +0 -392
- package/tests/relay/Call.test.ts +0 -535
- package/tests/relay/Deferred.test.ts +0 -71
- package/tests/relay/Message.test.ts +0 -164
- package/tests/relay/RelayClient.test.ts +0 -779
- package/tests/relay/RelayEvent.test.ts +0 -463
- package/tests/relay/helpers.ts +0 -79
- package/tests/rest/HttpClient.test.ts +0 -274
- package/tests/rest/RestError.test.ts +0 -53
- package/tests/rest/calling.test.ts +0 -156
- package/tests/rest/client.test.ts +0 -197
- package/tests/rest/compat.test.ts +0 -335
- package/tests/rest/datasphere.test.ts +0 -71
- package/tests/rest/fabric.test.ts +0 -186
- package/tests/rest/helpers.ts +0 -95
- package/tests/rest/logs.test.ts +0 -68
- package/tests/rest/pagination.test.ts +0 -133
- package/tests/rest/registry.test.ts +0 -94
- package/tests/rest/relay-rest.test.ts +0 -290
- package/tests/rest/video.test.ts +0 -173
- package/tests/setup.ts +0 -6
- package/tests/skills/SkillBase.test.ts +0 -108
- package/tests/skills/SkillManager.test.ts +0 -268
- package/tests/skills/SkillRegistry.test.ts +0 -176
- package/tests/skills/builtin.test.ts +0 -1472
- package/tests/skills/claude-skills.test.ts +0 -54
- package/tests/skills/custom-skills.test.ts +0 -53
- package/tests/skills/datasphere-serverless.test.ts +0 -70
- package/tests/skills/datasphere.test.ts +0 -107
- package/tests/skills/datetime.test.ts +0 -101
- package/tests/skills/google-maps.test.ts +0 -78
- package/tests/skills/info-gatherer.test.ts +0 -411
- package/tests/skills/joke.test.ts +0 -81
- package/tests/skills/math.test.ts +0 -68
- package/tests/skills/mcp-gateway.test.ts +0 -101
- package/tests/skills/play-background.test.ts +0 -54
- package/tests/skills/spider.test.ts +0 -108
- package/tests/skills/swml-transfer.test.ts +0 -178
- package/tests/skills/trivia.test.ts +0 -54
- package/tests/skills/vector-search.test.ts +0 -135
- package/tests/skills/weather-api.test.ts +0 -77
- package/tests/skills/web-search-parity.test.ts +0 -59
- package/tests/skills/web-search.test.ts +0 -103
- package/tests/skills/wikipedia.test.ts +0 -63
- package/tsconfig.json +0 -18
- package/vitest.config.ts +0 -9
- /package/{src → dist}/schema.json +0 -0
|
@@ -0,0 +1,653 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* LiveWire -- LiveKit-compatible agents powered by SignalWire.
|
|
3
|
+
*
|
|
4
|
+
* Provides the same class/function names as @livekit/agents-js so that
|
|
5
|
+
* developers can swap their import path and run on SignalWire's
|
|
6
|
+
* infrastructure. STT, TTS, VAD, LLM orchestration, and call control
|
|
7
|
+
* are all handled by SignalWire's control plane -- the noop'd options
|
|
8
|
+
* are accepted silently (logged once) to keep existing code compiling.
|
|
9
|
+
*/
|
|
10
|
+
import { AgentBase } from '../AgentBase.js';
|
|
11
|
+
declare const banner = "\n __ _ _ ___\n / / (_) _____ | | / (_)_______\n / / / / | / / _ \\ | | /| / / / ___/ _ \\\n / /___/ /| |/ / __/ | |/ |/ / / / / __/\n/_____/_/ |___/\\___/ |__/|__/_/_/ \\___/\n\n LiveKit-compatible agents powered by SignalWire\n";
|
|
12
|
+
/** Print the ASCII banner to stderr, using ANSI cyan when stderr is a TTY. */
|
|
13
|
+
declare function printBanner(): void;
|
|
14
|
+
/**
|
|
15
|
+
* Rotating "Did you know?" tips printed to stderr by the LiveWire banner.
|
|
16
|
+
* Exported for tests; reorder or extend to change what's displayed.
|
|
17
|
+
*/
|
|
18
|
+
export declare const tips: string[];
|
|
19
|
+
declare function printTip(): void;
|
|
20
|
+
/**
|
|
21
|
+
* NoopTracker ensures each informational message is logged at most once,
|
|
22
|
+
* preventing spam when the same noop path is exercised repeatedly.
|
|
23
|
+
*/
|
|
24
|
+
declare class NoopTracker {
|
|
25
|
+
private logged;
|
|
26
|
+
/**
|
|
27
|
+
* Log the given message the first time this key is seen.
|
|
28
|
+
*
|
|
29
|
+
* @param key - Dedup key. Subsequent calls with the same key are silent.
|
|
30
|
+
* @param message - Message to write to stderr on first occurrence.
|
|
31
|
+
*/
|
|
32
|
+
once(key: string, message: string): void;
|
|
33
|
+
/** Expose whether a key has been logged (for testing). */
|
|
34
|
+
hasLogged(key: string): boolean;
|
|
35
|
+
/** Reset all tracked keys (for testing). */
|
|
36
|
+
reset(): void;
|
|
37
|
+
}
|
|
38
|
+
declare const globalNoop: NoopTracker;
|
|
39
|
+
export { NoopTracker, globalNoop };
|
|
40
|
+
/** Voice configuration options passed through to the SignalWire AI config. */
|
|
41
|
+
export interface VoiceOptions {
|
|
42
|
+
/** TTS voice identifier (e.g. `"en-US-Standard-A"`). */
|
|
43
|
+
voice: string;
|
|
44
|
+
/** TTS engine identifier (e.g. `"google"`, `"elevenlabs"`). */
|
|
45
|
+
engine: string;
|
|
46
|
+
/** BCP-47 language code (e.g. `"en-US"`). */
|
|
47
|
+
language: string;
|
|
48
|
+
}
|
|
49
|
+
/** A tool definition that can be registered on an {@link Agent}. */
|
|
50
|
+
export interface FunctionTool {
|
|
51
|
+
/** Tool name. Populated when the tool is attached to an `Agent.tools` map. */
|
|
52
|
+
name: string;
|
|
53
|
+
/** Human-readable description shown to the LLM. */
|
|
54
|
+
description: string;
|
|
55
|
+
/** JSON schema (or Zod schema passthrough) for the tool's parameters. */
|
|
56
|
+
parameters?: Record<string, unknown>;
|
|
57
|
+
/** Handler invoked by the platform when the LLM calls this tool. */
|
|
58
|
+
execute: (params: any, context: {
|
|
59
|
+
ctx: RunContext;
|
|
60
|
+
}) => any;
|
|
61
|
+
}
|
|
62
|
+
/**
|
|
63
|
+
* Mirrors a LiveKit `voice.Agent` — holds instructions and tool definitions.
|
|
64
|
+
*
|
|
65
|
+
* Pipeline options (`stt`, `tts`, `vad`, `llm`, `turnDetection`) are accepted
|
|
66
|
+
* for API parity but are **no-ops** — SignalWire's control plane handles the
|
|
67
|
+
* entire AI pipeline server-side. Set instructions and tools; everything else
|
|
68
|
+
* just logs once and continues.
|
|
69
|
+
*
|
|
70
|
+
* @example Minimal LiveKit-compatible agent
|
|
71
|
+
* ```ts
|
|
72
|
+
* import { livewire } from '@signalwire/sdk';
|
|
73
|
+
*
|
|
74
|
+
* const timeTool = livewire.tool({
|
|
75
|
+
* description: 'Return the current time.',
|
|
76
|
+
* execute: () => new Date().toISOString(),
|
|
77
|
+
* });
|
|
78
|
+
*
|
|
79
|
+
* const agent = new livewire.Agent({
|
|
80
|
+
* instructions: 'You are a friendly helper.',
|
|
81
|
+
* tools: [{ ...timeTool, name: 'time' }],
|
|
82
|
+
* });
|
|
83
|
+
*
|
|
84
|
+
* const session = new livewire.AgentSession();
|
|
85
|
+
* await session.start({ agent });
|
|
86
|
+
* ```
|
|
87
|
+
*/
|
|
88
|
+
export declare class Agent<UserData = any> {
|
|
89
|
+
/** System instructions passed through to the SignalWire AI prompt. */
|
|
90
|
+
instructions: string;
|
|
91
|
+
/** Registered tools keyed by name. Mutated by {@link updateTools}. */
|
|
92
|
+
tools: Record<string, FunctionTool>;
|
|
93
|
+
/** Arbitrary per-session user data passed to tool handlers via {@link RunContext.userData}. */
|
|
94
|
+
userData?: UserData;
|
|
95
|
+
/** @internal Pipeline hint stored for AgentSession mapping. */
|
|
96
|
+
_llmHint: unknown;
|
|
97
|
+
/** @internal */
|
|
98
|
+
_allowInterruptions: unknown;
|
|
99
|
+
/** @internal */
|
|
100
|
+
_minEndpointingDelay: unknown;
|
|
101
|
+
/** @internal */
|
|
102
|
+
_maxEndpointingDelay: unknown;
|
|
103
|
+
private _session?;
|
|
104
|
+
constructor(options?: {
|
|
105
|
+
instructions?: string;
|
|
106
|
+
tools?: FunctionTool[];
|
|
107
|
+
userData?: UserData;
|
|
108
|
+
chatCtx?: unknown;
|
|
109
|
+
stt?: unknown;
|
|
110
|
+
tts?: unknown;
|
|
111
|
+
llm?: unknown;
|
|
112
|
+
vad?: unknown;
|
|
113
|
+
turnDetection?: unknown;
|
|
114
|
+
mcpServers?: unknown;
|
|
115
|
+
allowInterruptions?: boolean;
|
|
116
|
+
minEndpointingDelay?: number;
|
|
117
|
+
maxEndpointingDelay?: number;
|
|
118
|
+
});
|
|
119
|
+
/** The currently-bound {@link AgentSession}, or `undefined` until {@link AgentSession.start} is called. */
|
|
120
|
+
get session(): AgentSession<UserData> | undefined;
|
|
121
|
+
set session(value: AgentSession<UserData> | undefined);
|
|
122
|
+
/**
|
|
123
|
+
* Lifecycle hook called when the agent enters an active call.
|
|
124
|
+
* Override in a subclass to run setup logic — the default is a no-op.
|
|
125
|
+
*/
|
|
126
|
+
onEnter(): Promise<void>;
|
|
127
|
+
/**
|
|
128
|
+
* Lifecycle hook called when the agent exits (call ended or handoff).
|
|
129
|
+
* Override in a subclass to run teardown logic — the default is a no-op.
|
|
130
|
+
*/
|
|
131
|
+
onExit(): Promise<void>;
|
|
132
|
+
/**
|
|
133
|
+
* Lifecycle hook called when the user finishes speaking.
|
|
134
|
+
* Override in a subclass to inspect / mutate the turn context before the
|
|
135
|
+
* LLM responds — the default is a no-op.
|
|
136
|
+
*
|
|
137
|
+
* @param _turnCtx - Turn context (LiveKit shape; passed through opaquely).
|
|
138
|
+
* @param _newMessage - Newly-captured user message.
|
|
139
|
+
*/
|
|
140
|
+
onUserTurnCompleted(_turnCtx?: unknown, _newMessage?: unknown): Promise<void>;
|
|
141
|
+
/**
|
|
142
|
+
* LiveKit-compatible STT node. **No-op** on SignalWire — the control plane
|
|
143
|
+
* handles speech recognition server-side.
|
|
144
|
+
*
|
|
145
|
+
* @param _audio - Audio input (ignored).
|
|
146
|
+
* @param _modelSettings - Model settings (ignored).
|
|
147
|
+
*/
|
|
148
|
+
sttNode(_audio?: unknown, _modelSettings?: unknown): Promise<void>;
|
|
149
|
+
/**
|
|
150
|
+
* LiveKit-compatible LLM node. **No-op** on SignalWire — the control plane
|
|
151
|
+
* handles LLM inference server-side.
|
|
152
|
+
*
|
|
153
|
+
* @param _chatCtx - Chat context (ignored).
|
|
154
|
+
* @param _tools - Tool list (ignored).
|
|
155
|
+
* @param _modelSettings - Model settings (ignored).
|
|
156
|
+
*/
|
|
157
|
+
llmNode(_chatCtx?: unknown, _tools?: unknown, _modelSettings?: unknown): Promise<void>;
|
|
158
|
+
/**
|
|
159
|
+
* LiveKit-compatible TTS node. **No-op** on SignalWire — the control plane
|
|
160
|
+
* handles text-to-speech server-side.
|
|
161
|
+
*
|
|
162
|
+
* @param _text - Text to synthesise (ignored).
|
|
163
|
+
* @param _modelSettings - Model settings (ignored).
|
|
164
|
+
*/
|
|
165
|
+
ttsNode(_text?: unknown, _modelSettings?: unknown): Promise<void>;
|
|
166
|
+
/**
|
|
167
|
+
* Update the agent's instructions mid-session.
|
|
168
|
+
*
|
|
169
|
+
* @param instructions - New system-instructions string for the agent.
|
|
170
|
+
*/
|
|
171
|
+
updateInstructions(instructions: string): Promise<void>;
|
|
172
|
+
/**
|
|
173
|
+
* Update the agent's tool list mid-session.
|
|
174
|
+
*
|
|
175
|
+
* Replaces the current tool record with one built from the given array,
|
|
176
|
+
* keyed by `tool.name`. Useful for dynamic tool injection based on
|
|
177
|
+
* conversation state.
|
|
178
|
+
*
|
|
179
|
+
* @param tools - Ordered array of {@link FunctionTool} definitions. Each
|
|
180
|
+
* tool's `name` is used as its map key.
|
|
181
|
+
*/
|
|
182
|
+
updateTools(tools: FunctionTool[]): Promise<void>;
|
|
183
|
+
}
|
|
184
|
+
/**
|
|
185
|
+
* Mirrors a LiveKit `RunContext` — passed to tool handlers so they can
|
|
186
|
+
* read the current session, call handle, and user data.
|
|
187
|
+
*/
|
|
188
|
+
export declare class RunContext<UserData = any> {
|
|
189
|
+
/** The owning {@link AgentSession}, when one is bound. */
|
|
190
|
+
session?: AgentSession<UserData>;
|
|
191
|
+
/** Opaque speech-turn handle (LiveKit shape; passed through untouched). */
|
|
192
|
+
speechHandle?: unknown;
|
|
193
|
+
/** Opaque function-call descriptor (LiveKit shape; passed through untouched). */
|
|
194
|
+
functionCall?: unknown;
|
|
195
|
+
/**
|
|
196
|
+
* @param session - Owning session, when available.
|
|
197
|
+
* @param options - Optional pass-through values.
|
|
198
|
+
* @param options.speechHandle - Opaque LiveKit speech handle.
|
|
199
|
+
* @param options.functionCall - Opaque LiveKit function-call descriptor.
|
|
200
|
+
*/
|
|
201
|
+
constructor(session?: AgentSession<UserData>, options?: {
|
|
202
|
+
speechHandle?: unknown;
|
|
203
|
+
functionCall?: unknown;
|
|
204
|
+
});
|
|
205
|
+
/**
|
|
206
|
+
* Per-session user data, or an empty object when no session is bound.
|
|
207
|
+
*
|
|
208
|
+
* @returns The {@link AgentSession.userData} payload cast to `UserData`.
|
|
209
|
+
*/
|
|
210
|
+
get userData(): UserData;
|
|
211
|
+
}
|
|
212
|
+
/**
|
|
213
|
+
* Mirrors a LiveKit `AgentSession` — binds an {@link Agent} to SignalWire.
|
|
214
|
+
*
|
|
215
|
+
* Call {@link AgentSession.start} with an `Agent` to construct an internal
|
|
216
|
+
* {@link AgentBase} and begin serving SWML. Pipeline-related options are
|
|
217
|
+
* accepted for API parity but are no-ops server-side.
|
|
218
|
+
*/
|
|
219
|
+
export declare class AgentSession<UserData = any> {
|
|
220
|
+
private _llm;
|
|
221
|
+
private _tools;
|
|
222
|
+
private _userData;
|
|
223
|
+
private _agent?;
|
|
224
|
+
private _swAgent?;
|
|
225
|
+
private _allowInterruptions;
|
|
226
|
+
private _minInterruptionDuration;
|
|
227
|
+
private _minEndpointingDelay;
|
|
228
|
+
private _maxEndpointingDelay;
|
|
229
|
+
private _maxToolSteps;
|
|
230
|
+
private _preemptiveGeneration;
|
|
231
|
+
private _history;
|
|
232
|
+
private _sayQueue;
|
|
233
|
+
private noop;
|
|
234
|
+
constructor(options?: {
|
|
235
|
+
stt?: any;
|
|
236
|
+
tts?: any;
|
|
237
|
+
llm?: any;
|
|
238
|
+
vad?: any;
|
|
239
|
+
turnDetection?: any;
|
|
240
|
+
tools?: FunctionTool[];
|
|
241
|
+
mcpServers?: unknown;
|
|
242
|
+
userData?: UserData;
|
|
243
|
+
allowInterruptions?: boolean;
|
|
244
|
+
minInterruptionDuration?: number;
|
|
245
|
+
minEndpointingDelay?: number;
|
|
246
|
+
maxEndpointingDelay?: number;
|
|
247
|
+
maxToolSteps?: number;
|
|
248
|
+
preemptiveGeneration?: boolean;
|
|
249
|
+
});
|
|
250
|
+
/**
|
|
251
|
+
* Start the session by binding the agent to a freshly-constructed
|
|
252
|
+
* {@link AgentBase}, mapping LiveKit-style options onto SignalWire AI params.
|
|
253
|
+
*
|
|
254
|
+
* Must be called before any other method on this session. The underlying
|
|
255
|
+
* `AgentBase` is not started here — use {@link runApp} or an `AgentServer`
|
|
256
|
+
* to serve it.
|
|
257
|
+
*
|
|
258
|
+
* @param params - Start parameters.
|
|
259
|
+
* @param params.agent - The {@link Agent} to bind.
|
|
260
|
+
* @param params.room - LiveKit room placeholder; ignored on SignalWire.
|
|
261
|
+
* @param params.record - Call-recording flag placeholder; ignored on SignalWire.
|
|
262
|
+
* @returns Resolves once the underlying `AgentBase` has been built.
|
|
263
|
+
*/
|
|
264
|
+
start(params: {
|
|
265
|
+
agent: Agent<UserData>;
|
|
266
|
+
room?: any;
|
|
267
|
+
record?: boolean;
|
|
268
|
+
}): Promise<void>;
|
|
269
|
+
/**
|
|
270
|
+
* Queue text to be spoken by the agent.
|
|
271
|
+
*
|
|
272
|
+
* Before {@link start} is called, text is buffered and injected at start
|
|
273
|
+
* time as the agent's initial greeting. After start, text is added as an
|
|
274
|
+
* additional prompt section.
|
|
275
|
+
*
|
|
276
|
+
* @param text - Line for the agent to speak.
|
|
277
|
+
*/
|
|
278
|
+
say(text: string): void;
|
|
279
|
+
/**
|
|
280
|
+
* Trigger the agent to generate a reply, optionally with extra instructions.
|
|
281
|
+
*
|
|
282
|
+
* @param options - Generation options.
|
|
283
|
+
* @param options.instructions - Extra instructions injected as a new prompt
|
|
284
|
+
* section before the next LLM turn.
|
|
285
|
+
*/
|
|
286
|
+
generateReply(options?: {
|
|
287
|
+
instructions?: string;
|
|
288
|
+
}): void;
|
|
289
|
+
/**
|
|
290
|
+
* Interrupt current speech. **No-op** on SignalWire — barge-in is handled
|
|
291
|
+
* automatically by the control plane.
|
|
292
|
+
*/
|
|
293
|
+
interrupt(): void;
|
|
294
|
+
/**
|
|
295
|
+
* Swap the {@link Agent} bound to this session.
|
|
296
|
+
*
|
|
297
|
+
* Preserves the underlying `AgentBase` but replaces its prompt with the new
|
|
298
|
+
* agent's instructions.
|
|
299
|
+
*
|
|
300
|
+
* @param agent - Replacement agent.
|
|
301
|
+
*/
|
|
302
|
+
updateAgent(agent: Agent<UserData>): void;
|
|
303
|
+
/** Current per-session user data. Set by the constructor or via the setter. */
|
|
304
|
+
get userData(): UserData;
|
|
305
|
+
set userData(val: UserData);
|
|
306
|
+
/** Conversation history entries captured over the session's lifetime. */
|
|
307
|
+
get history(): Array<Record<string, string>>;
|
|
308
|
+
/**
|
|
309
|
+
* Return the underlying SignalWire {@link AgentBase}. Useful for tests and
|
|
310
|
+
* advanced use cases that need to reach past the LiveKit facade.
|
|
311
|
+
*
|
|
312
|
+
* @returns The wrapped `AgentBase`, or `undefined` before {@link start}.
|
|
313
|
+
*/
|
|
314
|
+
getSwAgent(): AgentBase | undefined;
|
|
315
|
+
}
|
|
316
|
+
/**
|
|
317
|
+
* Create a tool definition — mirrors `llm.tool()` from `@livekit/agents-js`.
|
|
318
|
+
*
|
|
319
|
+
* The returned tool has an empty `name` — the caller assigns it when the tool
|
|
320
|
+
* is attached to an agent's tools map (see the {@link Agent} example).
|
|
321
|
+
*
|
|
322
|
+
* @typeParam P - Parameter type passed into `execute`.
|
|
323
|
+
* @param options - Tool configuration.
|
|
324
|
+
* @param options.description - Human-readable tool description exposed to the LLM.
|
|
325
|
+
* @param options.parameters - JSON Schema or Zod schema describing the tool's inputs.
|
|
326
|
+
* @param options.execute - Handler invoked when the LLM calls the tool.
|
|
327
|
+
* @returns A {@link FunctionTool} ready to be attached to an agent.
|
|
328
|
+
*/
|
|
329
|
+
export declare function tool<P = any>(options: {
|
|
330
|
+
description: string;
|
|
331
|
+
parameters?: any;
|
|
332
|
+
execute: (params: P, context: {
|
|
333
|
+
ctx: RunContext;
|
|
334
|
+
}) => any;
|
|
335
|
+
}): FunctionTool;
|
|
336
|
+
/**
|
|
337
|
+
* Create an {@link AgentHandoff} descriptor for multi-agent scenarios.
|
|
338
|
+
*
|
|
339
|
+
* @param options - Handoff parameters.
|
|
340
|
+
* @param options.agent - Agent to transfer control to.
|
|
341
|
+
* @param options.returns - Optional string returned to the current agent when
|
|
342
|
+
* the handoff completes.
|
|
343
|
+
* @returns A handoff descriptor that can be returned from a tool handler.
|
|
344
|
+
*/
|
|
345
|
+
export declare function handoff(options: {
|
|
346
|
+
agent: Agent;
|
|
347
|
+
returns?: string;
|
|
348
|
+
}): AgentHandoff;
|
|
349
|
+
/** Signals a handoff to another agent in multi-agent scenarios. */
|
|
350
|
+
export declare class AgentHandoff {
|
|
351
|
+
/** Target agent that should take over the conversation. */
|
|
352
|
+
agent: Agent;
|
|
353
|
+
/** Optional return value surfaced when the handoff completes. */
|
|
354
|
+
returns?: string;
|
|
355
|
+
}
|
|
356
|
+
/** Signals that a tool should not trigger another LLM reply. */
|
|
357
|
+
export declare class StopResponse extends Error {
|
|
358
|
+
/**
|
|
359
|
+
* @param message - Optional error message. Defaults to `"StopResponse"`.
|
|
360
|
+
*/
|
|
361
|
+
constructor(message?: string);
|
|
362
|
+
}
|
|
363
|
+
/** Error thrown from a tool to signal failure back to the LLM. */
|
|
364
|
+
export declare class ToolError extends Error {
|
|
365
|
+
/**
|
|
366
|
+
* @param message - Error message surfaced to the LLM.
|
|
367
|
+
*/
|
|
368
|
+
constructor(message: string);
|
|
369
|
+
}
|
|
370
|
+
/**
|
|
371
|
+
* Mirrors a LiveKit `JobProcess` — placeholder for prewarm / setup hooks.
|
|
372
|
+
*
|
|
373
|
+
* On SignalWire the control plane pre-warms infrastructure at scale, so this
|
|
374
|
+
* class carries no real state beyond the LiveKit-compatible `userData` bag.
|
|
375
|
+
*/
|
|
376
|
+
export declare class JobProcess {
|
|
377
|
+
/** Mutable bag shared across prewarm and entry-point callbacks. */
|
|
378
|
+
userData: Record<string, any>;
|
|
379
|
+
}
|
|
380
|
+
/**
|
|
381
|
+
* Stub `Room` — SignalWire does not use the LiveKit room abstraction.
|
|
382
|
+
*
|
|
383
|
+
* Present purely for API parity so LiveKit-shaped code compiles; its only
|
|
384
|
+
* meaningful attribute is the constant name.
|
|
385
|
+
*/
|
|
386
|
+
export declare class Room {
|
|
387
|
+
/** Always `"livewire-room"` — SignalWire has no per-call room identity. */
|
|
388
|
+
readonly name: string;
|
|
389
|
+
}
|
|
390
|
+
/**
|
|
391
|
+
* Mirrors a LiveKit `JobContext` — provides room and connection info to the
|
|
392
|
+
* entry-point callback registered via {@link defineAgent}.
|
|
393
|
+
*/
|
|
394
|
+
export declare class JobContext {
|
|
395
|
+
/** Placeholder {@link Room} (see class docs). */
|
|
396
|
+
room: Room;
|
|
397
|
+
/** Shared {@link JobProcess} instance for prewarm-to-entry data passing. */
|
|
398
|
+
proc: JobProcess;
|
|
399
|
+
/** @internal */
|
|
400
|
+
_swAgent?: AgentBase;
|
|
401
|
+
constructor();
|
|
402
|
+
/**
|
|
403
|
+
* Connect to the platform. **No-op** on SignalWire — the control plane
|
|
404
|
+
* manages connection lifecycle automatically.
|
|
405
|
+
*
|
|
406
|
+
* @returns Resolves immediately.
|
|
407
|
+
*/
|
|
408
|
+
connect(): Promise<void>;
|
|
409
|
+
/**
|
|
410
|
+
* Wait for a participant to join. **No-op** on SignalWire — returns an
|
|
411
|
+
* immediate stub participant.
|
|
412
|
+
*
|
|
413
|
+
* @param options - Participant match options.
|
|
414
|
+
* @param options.identity - Requested identity; echoed back in the stub.
|
|
415
|
+
* Defaults to `"caller"`.
|
|
416
|
+
* @returns A stub participant `{ identity }` record.
|
|
417
|
+
*/
|
|
418
|
+
waitForParticipant(options?: {
|
|
419
|
+
identity?: string;
|
|
420
|
+
}): Promise<any>;
|
|
421
|
+
}
|
|
422
|
+
/**
|
|
423
|
+
* Mirrors `@livekit/agents.defineAgent()`.
|
|
424
|
+
*
|
|
425
|
+
* Packages an entry function (plus an optional prewarm hook) for later
|
|
426
|
+
* execution by {@link runApp}. Pass-through — no side effects.
|
|
427
|
+
*
|
|
428
|
+
* @param agent - Entry and (optional) prewarm functions.
|
|
429
|
+
* @param agent.entry - Main callback invoked with a {@link JobContext} when
|
|
430
|
+
* the agent runs.
|
|
431
|
+
* @param agent.prewarm - Optional prewarm callback invoked with a
|
|
432
|
+
* {@link JobProcess} before `entry`.
|
|
433
|
+
* @returns The same record (pass-through), typed consistently.
|
|
434
|
+
*/
|
|
435
|
+
export declare function defineAgent(agent: {
|
|
436
|
+
entry: (ctx: JobContext) => Promise<void>;
|
|
437
|
+
prewarm?: (proc: JobProcess) => any;
|
|
438
|
+
}): {
|
|
439
|
+
entry: (ctx: JobContext) => Promise<void>;
|
|
440
|
+
prewarm?: (proc: JobProcess) => any;
|
|
441
|
+
};
|
|
442
|
+
/**
|
|
443
|
+
* Mirrors `cli.runApp()` from `@livekit/agents-js`.
|
|
444
|
+
*
|
|
445
|
+
* 1. Prints the LiveWire banner
|
|
446
|
+
* 2. Runs the registered prewarm callback (if any) with a fresh {@link JobProcess}
|
|
447
|
+
* 3. Creates a fresh {@link JobContext}
|
|
448
|
+
* 4. Prints a random tip
|
|
449
|
+
* 5. Invokes the entry function with the context
|
|
450
|
+
* 6. Starts the underlying SignalWire `AgentBase` once the entry function
|
|
451
|
+
* binds one (via an `AgentSession.start()` call)
|
|
452
|
+
*
|
|
453
|
+
* Accepts either an object `{ entry, prewarm? }`, a bare entry function, or
|
|
454
|
+
* an {@link AgentServer} instance.
|
|
455
|
+
*
|
|
456
|
+
* @param options - Agent descriptor, entry function, or `AgentServer`.
|
|
457
|
+
*/
|
|
458
|
+
export declare function runApp(options: any): void;
|
|
459
|
+
/**
|
|
460
|
+
* Stub class mirroring LiveKit's `WorkerOptions`.
|
|
461
|
+
*
|
|
462
|
+
* Accepts any configuration for source-compatibility with LiveKit code;
|
|
463
|
+
* SignalWire ignores these settings.
|
|
464
|
+
*/
|
|
465
|
+
export declare class WorkerOptions {
|
|
466
|
+
/** @param _opts - LiveKit-shaped worker options (ignored). */
|
|
467
|
+
constructor(_opts?: any);
|
|
468
|
+
}
|
|
469
|
+
/**
|
|
470
|
+
* Stub class mirroring LiveKit's `ServerOptions`.
|
|
471
|
+
*
|
|
472
|
+
* Accepts any configuration for source-compatibility with LiveKit code;
|
|
473
|
+
* SignalWire ignores these settings.
|
|
474
|
+
*/
|
|
475
|
+
export declare class ServerOptions {
|
|
476
|
+
/** @param _opts - LiveKit-shaped server options (ignored). */
|
|
477
|
+
constructor(_opts?: any);
|
|
478
|
+
}
|
|
479
|
+
/**
|
|
480
|
+
* Mirrors a LiveKit AgentServer -- registers entrypoints and starts.
|
|
481
|
+
*
|
|
482
|
+
* Usage:
|
|
483
|
+
* const server = new AgentServer();
|
|
484
|
+
* server.setupFnc = async (proc) => { ... };
|
|
485
|
+
*
|
|
486
|
+
* // Bare decorator usage:
|
|
487
|
+
* server.rtcSession(myEntryFn);
|
|
488
|
+
*
|
|
489
|
+
* // Parameterized decorator usage:
|
|
490
|
+
* server.rtcSession({ agentName: 'myAgent' })(myEntryFn);
|
|
491
|
+
*
|
|
492
|
+
* cli.runApp(server);
|
|
493
|
+
*/
|
|
494
|
+
export declare class AgentServer {
|
|
495
|
+
/** Optional prewarm hook called before the entrypoint. Mirrors Python's setup_fnc. */
|
|
496
|
+
setupFnc?: (proc: JobProcess) => void;
|
|
497
|
+
/** @internal Registered entrypoint function. */
|
|
498
|
+
private _entryFn?;
|
|
499
|
+
/** @internal Agent name hint registered via rtcSession(). */
|
|
500
|
+
private _agentName;
|
|
501
|
+
constructor(_opts?: any);
|
|
502
|
+
/**
|
|
503
|
+
* Decorator that registers the session entrypoint.
|
|
504
|
+
*
|
|
505
|
+
* Supports both bare and parameterized usage:
|
|
506
|
+
* server.rtcSession(fn) // bare
|
|
507
|
+
* server.rtcSession(fn, { agentName: 'x' }) // with opts, explicit fn
|
|
508
|
+
* server.rtcSession({ agentName: 'x' })(fn) // parameterized decorator
|
|
509
|
+
* @server.rtcSession // decorator (bare)
|
|
510
|
+
* @server.rtcSession({ agentName: 'x' }) // decorator (parameterized)
|
|
511
|
+
*/
|
|
512
|
+
rtcSession(fnOrOpts?: ((ctx: JobContext) => Promise<void>) | {
|
|
513
|
+
agentName?: string;
|
|
514
|
+
type?: string;
|
|
515
|
+
onRequest?: ((...args: any[]) => any) | null;
|
|
516
|
+
onSessionEnd?: ((...args: any[]) => any) | null;
|
|
517
|
+
}, opts?: {
|
|
518
|
+
agentName?: string;
|
|
519
|
+
type?: string;
|
|
520
|
+
onRequest?: ((...args: any[]) => any) | null;
|
|
521
|
+
onSessionEnd?: ((...args: any[]) => any) | null;
|
|
522
|
+
}): ((fn: (ctx: JobContext) => Promise<void>) => (ctx: JobContext) => Promise<void>) | void;
|
|
523
|
+
/** @internal Extract agentDef-compatible shape for use by runApp. */
|
|
524
|
+
_toAgentDef(): {
|
|
525
|
+
entry: (ctx: JobContext) => Promise<void>;
|
|
526
|
+
prewarm?: (proc: JobProcess) => void;
|
|
527
|
+
};
|
|
528
|
+
}
|
|
529
|
+
/**
|
|
530
|
+
* Stub providers matching common LiveKit plugin packages.
|
|
531
|
+
*
|
|
532
|
+
* None of these do anything — they exist so LiveKit code that imports and
|
|
533
|
+
* constructs these classes still compiles and runs under SignalWire. The
|
|
534
|
+
* first construction of each logs an advisory to stderr.
|
|
535
|
+
*/
|
|
536
|
+
export declare namespace plugins {
|
|
537
|
+
/** LiveKit Deepgram-STT plugin stub. No-op on SignalWire. */
|
|
538
|
+
class DeepgramSTT {
|
|
539
|
+
/** @param _opts - Deepgram options (ignored). */
|
|
540
|
+
constructor(_opts?: any);
|
|
541
|
+
}
|
|
542
|
+
/**
|
|
543
|
+
* LiveKit OpenAI-LLM plugin stub.
|
|
544
|
+
*
|
|
545
|
+
* The `model` string is captured and mapped to the SignalWire AI `model`
|
|
546
|
+
* param by {@link AgentSession.start}. Other options are ignored.
|
|
547
|
+
*/
|
|
548
|
+
class OpenAILLM {
|
|
549
|
+
/** Model identifier captured from the constructor options. */
|
|
550
|
+
model: string;
|
|
551
|
+
/** @param _opts - OpenAI options. `_opts.model` is captured; everything else ignored. */
|
|
552
|
+
constructor(_opts?: any);
|
|
553
|
+
}
|
|
554
|
+
/** LiveKit Cartesia-TTS plugin stub. No-op on SignalWire. */
|
|
555
|
+
class CartesiaTTS {
|
|
556
|
+
/** @param _opts - Cartesia options (ignored). */
|
|
557
|
+
constructor(_opts?: any);
|
|
558
|
+
}
|
|
559
|
+
/** LiveKit ElevenLabs-TTS plugin stub. No-op on SignalWire. */
|
|
560
|
+
class ElevenLabsTTS {
|
|
561
|
+
/** @param _opts - ElevenLabs options (ignored). */
|
|
562
|
+
constructor(_opts?: any);
|
|
563
|
+
}
|
|
564
|
+
/** LiveKit Silero-VAD plugin stub. No-op on SignalWire. */
|
|
565
|
+
class SileroVAD {
|
|
566
|
+
/** @param _opts - Silero VAD options (ignored). */
|
|
567
|
+
constructor(_opts?: Record<string, unknown>);
|
|
568
|
+
/**
|
|
569
|
+
* Load a Silero VAD model.
|
|
570
|
+
*
|
|
571
|
+
* **No-op** on SignalWire — returns a fresh stub instance and emits a
|
|
572
|
+
* one-time advisory to stderr.
|
|
573
|
+
*
|
|
574
|
+
* @returns A new `SileroVAD` stub.
|
|
575
|
+
*/
|
|
576
|
+
static load(): SileroVAD;
|
|
577
|
+
}
|
|
578
|
+
}
|
|
579
|
+
/**
|
|
580
|
+
* Stub inference types matching LiveKit's `inference` namespace.
|
|
581
|
+
*
|
|
582
|
+
* None of these run inference on the client — SignalWire performs STT / LLM /
|
|
583
|
+
* TTS in its control plane. These classes exist so LiveKit code that imports
|
|
584
|
+
* and instantiates them still compiles.
|
|
585
|
+
*/
|
|
586
|
+
export declare namespace inference {
|
|
587
|
+
/** LiveKit inference-STT stub. Captures the model name; runs no inference locally. */
|
|
588
|
+
class STT {
|
|
589
|
+
/** Model identifier captured from the constructor. */
|
|
590
|
+
model: string;
|
|
591
|
+
/**
|
|
592
|
+
* @param model - Model identifier (captured).
|
|
593
|
+
* @param _opts - Additional options (ignored).
|
|
594
|
+
*/
|
|
595
|
+
constructor(model?: string, _opts?: any);
|
|
596
|
+
}
|
|
597
|
+
/** LiveKit inference-LLM stub. Captures the model name; runs no inference locally. */
|
|
598
|
+
class LLM {
|
|
599
|
+
/** Model identifier captured from the constructor. */
|
|
600
|
+
model: string;
|
|
601
|
+
/**
|
|
602
|
+
* @param model - Model identifier (captured).
|
|
603
|
+
* @param _opts - Additional options (ignored).
|
|
604
|
+
*/
|
|
605
|
+
constructor(model?: string, _opts?: any);
|
|
606
|
+
}
|
|
607
|
+
/** LiveKit inference-TTS stub. Captures the model name; runs no inference locally. */
|
|
608
|
+
class TTS {
|
|
609
|
+
/** Model identifier captured from the constructor. */
|
|
610
|
+
model: string;
|
|
611
|
+
/**
|
|
612
|
+
* @param model - Model identifier (captured).
|
|
613
|
+
* @param _opts - Additional options (ignored).
|
|
614
|
+
*/
|
|
615
|
+
constructor(model?: string, _opts?: any);
|
|
616
|
+
}
|
|
617
|
+
}
|
|
618
|
+
/** LiveKit voice namespace equivalent. */
|
|
619
|
+
export declare const voice: {
|
|
620
|
+
Agent: typeof Agent;
|
|
621
|
+
AgentSession: typeof AgentSession;
|
|
622
|
+
AgentSessionEventTypes: Record<string, string>;
|
|
623
|
+
};
|
|
624
|
+
/** Minimal `ChatContext` matching LiveKit's `ChatContext`. */
|
|
625
|
+
export declare class ChatContext {
|
|
626
|
+
/** Ordered chat messages, each `{ role, content }`. */
|
|
627
|
+
messages: Array<Record<string, string>>;
|
|
628
|
+
/**
|
|
629
|
+
* Append a chat message.
|
|
630
|
+
*
|
|
631
|
+
* @param options - Message content.
|
|
632
|
+
* @param options.role - Speaker role (`"user"`, `"assistant"`, or `"system"`).
|
|
633
|
+
* Defaults to `"user"`.
|
|
634
|
+
* @param options.text - Message text. Defaults to `""`.
|
|
635
|
+
* @returns This instance for chaining.
|
|
636
|
+
*/
|
|
637
|
+
append(options: {
|
|
638
|
+
role?: string;
|
|
639
|
+
text?: string;
|
|
640
|
+
}): this;
|
|
641
|
+
}
|
|
642
|
+
/** LiveKit llm namespace equivalent. */
|
|
643
|
+
export declare const llm: {
|
|
644
|
+
tool: typeof tool;
|
|
645
|
+
handoff: typeof handoff;
|
|
646
|
+
ToolError: typeof ToolError;
|
|
647
|
+
ChatContext: typeof ChatContext;
|
|
648
|
+
};
|
|
649
|
+
/** LiveKit cli namespace equivalent. */
|
|
650
|
+
export declare const cli: {
|
|
651
|
+
runApp: typeof runApp;
|
|
652
|
+
};
|
|
653
|
+
export { printBanner, printTip, banner };
|