@signalwire/sdk 2.0.1 → 2.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/AgentBase.d.ts +1045 -0
- package/dist/AgentBase.js +2375 -0
- package/dist/AgentBase.js.map +1 -0
- package/dist/AgentServer.d.ts +146 -0
- package/dist/AgentServer.js +388 -0
- package/dist/AgentServer.js.map +1 -0
- package/dist/AuthHandler.d.ts +127 -0
- package/dist/AuthHandler.js +212 -0
- package/dist/AuthHandler.js.map +1 -0
- package/dist/ConfigLoader.d.ts +170 -0
- package/dist/ConfigLoader.js +393 -0
- package/dist/ConfigLoader.js.map +1 -0
- package/dist/ContextBuilder.d.ts +652 -0
- package/dist/ContextBuilder.js +1115 -0
- package/dist/ContextBuilder.js.map +1 -0
- package/dist/DataMap.d.ts +271 -0
- package/dist/DataMap.js +430 -0
- package/dist/DataMap.js.map +1 -0
- package/dist/FunctionResult.d.ts +481 -0
- package/dist/FunctionResult.js +775 -0
- package/dist/FunctionResult.js.map +1 -0
- package/dist/Logger.d.ts +113 -0
- package/dist/Logger.js +320 -0
- package/dist/Logger.js.map +1 -0
- package/dist/PomBuilder.d.ts +208 -0
- package/dist/PomBuilder.js +409 -0
- package/dist/PomBuilder.js.map +1 -0
- package/dist/PromptManager.d.ts +85 -0
- package/dist/PromptManager.js +108 -0
- package/dist/PromptManager.js.map +1 -0
- package/dist/SWMLHandler.d.ts +159 -0
- package/dist/SWMLHandler.js +229 -0
- package/dist/SWMLHandler.js.map +1 -0
- package/dist/SWMLService.d.ts +326 -0
- package/dist/SWMLService.js +610 -0
- package/dist/SWMLService.js.map +1 -0
- package/dist/SchemaUtils.d.ts +108 -0
- package/dist/SchemaUtils.js +317 -0
- package/dist/SchemaUtils.js.map +1 -0
- package/dist/SecurityUtils.d.ts +60 -0
- package/{src/SecurityUtils.ts → dist/SecurityUtils.js} +82 -83
- package/dist/SecurityUtils.js.map +1 -0
- package/dist/ServerlessAdapter.d.ts +119 -0
- package/dist/ServerlessAdapter.js +188 -0
- package/dist/ServerlessAdapter.js.map +1 -0
- package/dist/SessionManager.d.ts +142 -0
- package/dist/SessionManager.js +260 -0
- package/dist/SessionManager.js.map +1 -0
- package/dist/SslConfig.d.ts +77 -0
- package/dist/SslConfig.js +100 -0
- package/dist/SslConfig.js.map +1 -0
- package/dist/SwaigFunction.d.ts +159 -0
- package/dist/SwaigFunction.js +209 -0
- package/dist/SwaigFunction.js.map +1 -0
- package/dist/SwmlBuilder.d.ts +165 -0
- package/dist/SwmlBuilder.js +247 -0
- package/dist/SwmlBuilder.js.map +1 -0
- package/dist/SwmlVerbMethods.generated.d.ts +254 -0
- package/dist/SwmlVerbMethods.generated.js +9 -0
- package/dist/SwmlVerbMethods.generated.js.map +1 -0
- package/dist/TypeInference.d.ts +71 -0
- package/dist/TypeInference.js +164 -0
- package/dist/TypeInference.js.map +1 -0
- package/dist/WebService.d.ts +148 -0
- package/dist/WebService.js +532 -0
- package/dist/WebService.js.map +1 -0
- package/dist/cli/agent-loader.d.ts +22 -0
- package/dist/cli/agent-loader.js +144 -0
- package/dist/cli/agent-loader.js.map +1 -0
- package/dist/cli/mock-data.d.ts +37 -0
- package/dist/cli/mock-data.js +80 -0
- package/dist/cli/mock-data.js.map +1 -0
- package/dist/cli/swaig-test.d.ts +32 -0
- package/dist/cli/swaig-test.js +418 -0
- package/dist/cli/swaig-test.js.map +1 -0
- package/dist/generateVerbTypes.d.ts +11 -0
- package/dist/generateVerbTypes.js +265 -0
- package/dist/generateVerbTypes.js.map +1 -0
- package/{src/index.ts → dist/index.d.ts} +13 -100
- package/dist/index.js +152 -0
- package/dist/index.js.map +1 -0
- package/dist/livewire/index.d.ts +653 -0
- package/dist/livewire/index.js +992 -0
- package/dist/livewire/index.js.map +1 -0
- package/dist/prefabs/ConciergeAgent.d.ts +89 -0
- package/dist/prefabs/ConciergeAgent.js +245 -0
- package/dist/prefabs/ConciergeAgent.js.map +1 -0
- package/dist/prefabs/FAQBotAgent.d.ts +113 -0
- package/dist/prefabs/FAQBotAgent.js +329 -0
- package/dist/prefabs/FAQBotAgent.js.map +1 -0
- package/dist/prefabs/InfoGathererAgent.d.ts +126 -0
- package/dist/prefabs/InfoGathererAgent.js +287 -0
- package/dist/prefabs/InfoGathererAgent.js.map +1 -0
- package/dist/prefabs/ReceptionistAgent.d.ts +104 -0
- package/dist/prefabs/ReceptionistAgent.js +303 -0
- package/dist/prefabs/ReceptionistAgent.js.map +1 -0
- package/dist/prefabs/SurveyAgent.d.ts +148 -0
- package/dist/prefabs/SurveyAgent.js +540 -0
- package/dist/prefabs/SurveyAgent.js.map +1 -0
- package/{src/prefabs/index.ts → dist/prefabs/index.d.ts} +1 -15
- package/dist/prefabs/index.js +14 -0
- package/dist/prefabs/index.js.map +1 -0
- package/dist/relay/Action.d.ts +258 -0
- package/dist/relay/Action.js +402 -0
- package/dist/relay/Action.js.map +1 -0
- package/dist/relay/Call.d.ts +697 -0
- package/dist/relay/Call.js +1062 -0
- package/dist/relay/Call.js.map +1 -0
- package/dist/relay/Deferred.d.ts +44 -0
- package/dist/relay/Deferred.js +69 -0
- package/dist/relay/Deferred.js.map +1 -0
- package/dist/relay/Message.d.ts +103 -0
- package/dist/relay/Message.js +169 -0
- package/dist/relay/Message.js.map +1 -0
- package/dist/relay/RelayClient.d.ts +302 -0
- package/dist/relay/RelayClient.js +1019 -0
- package/dist/relay/RelayClient.js.map +1 -0
- package/dist/relay/RelayError.d.ts +15 -0
- package/dist/relay/RelayError.js +20 -0
- package/dist/relay/RelayError.js.map +1 -0
- package/dist/relay/RelayEvent.d.ts +254 -0
- package/dist/relay/RelayEvent.js +509 -0
- package/dist/relay/RelayEvent.js.map +1 -0
- package/dist/relay/constants.d.ts +90 -0
- package/{src/relay/constants.ts → dist/relay/constants.js} +11 -29
- package/dist/relay/constants.js.map +1 -0
- package/dist/relay/index.d.ts +16 -0
- package/dist/relay/index.js +18 -0
- package/dist/relay/index.js.map +1 -0
- package/dist/relay/types.d.ts +142 -0
- package/dist/relay/types.js +5 -0
- package/dist/relay/types.js.map +1 -0
- package/dist/rest/HttpClient.d.ts +80 -0
- package/dist/rest/HttpClient.js +148 -0
- package/dist/rest/HttpClient.js.map +1 -0
- package/dist/rest/RestError.d.ts +30 -0
- package/dist/rest/RestError.js +39 -0
- package/dist/rest/RestError.js.map +1 -0
- package/dist/rest/base/BaseResource.d.ts +24 -0
- package/dist/rest/base/BaseResource.js +29 -0
- package/dist/rest/base/BaseResource.js.map +1 -0
- package/dist/rest/base/CrudResource.d.ts +68 -0
- package/dist/rest/base/CrudResource.js +82 -0
- package/dist/rest/base/CrudResource.js.map +1 -0
- package/dist/rest/base/CrudWithAddresses.d.ts +22 -0
- package/dist/rest/base/CrudWithAddresses.js +25 -0
- package/dist/rest/base/CrudWithAddresses.js.map +1 -0
- package/dist/rest/index.d.ts +131 -0
- package/{src/rest/index.ts → dist/rest/index.js} +101 -136
- package/dist/rest/index.js.map +1 -0
- package/dist/rest/namespaces/addresses.d.ts +46 -0
- package/dist/rest/namespaces/addresses.js +55 -0
- package/dist/rest/namespaces/addresses.js.map +1 -0
- package/dist/rest/namespaces/calling.d.ts +382 -0
- package/dist/rest/namespaces/calling.js +478 -0
- package/dist/rest/namespaces/calling.js.map +1 -0
- package/dist/rest/namespaces/chat.d.ts +22 -0
- package/dist/rest/namespaces/chat.js +26 -0
- package/dist/rest/namespaces/chat.js.map +1 -0
- package/dist/rest/namespaces/compat.d.ts +585 -0
- package/dist/rest/namespaces/compat.js +735 -0
- package/dist/rest/namespaces/compat.js.map +1 -0
- package/dist/rest/namespaces/datasphere.d.ts +66 -0
- package/dist/rest/namespaces/datasphere.js +77 -0
- package/dist/rest/namespaces/datasphere.js.map +1 -0
- package/dist/rest/namespaces/fabric.d.ts +282 -0
- package/dist/rest/namespaces/fabric.js +373 -0
- package/dist/rest/namespaces/fabric.js.map +1 -0
- package/dist/rest/namespaces/imported-numbers.d.ts +22 -0
- package/dist/rest/namespaces/imported-numbers.js +26 -0
- package/dist/rest/namespaces/imported-numbers.js.map +1 -0
- package/dist/rest/namespaces/logs.d.ts +105 -0
- package/dist/rest/namespaces/logs.js +133 -0
- package/dist/rest/namespaces/logs.js.map +1 -0
- package/dist/rest/namespaces/lookup.d.ts +29 -0
- package/dist/rest/namespaces/lookup.js +32 -0
- package/dist/rest/namespaces/lookup.js.map +1 -0
- package/dist/rest/namespaces/mfa.d.ts +46 -0
- package/dist/rest/namespaces/mfa.js +54 -0
- package/dist/rest/namespaces/mfa.js.map +1 -0
- package/dist/rest/namespaces/number-groups.d.ts +49 -0
- package/dist/rest/namespaces/number-groups.js +58 -0
- package/dist/rest/namespaces/number-groups.js.map +1 -0
- package/dist/rest/namespaces/phone-numbers.d.ts +60 -0
- package/dist/rest/namespaces/phone-numbers.js +67 -0
- package/dist/rest/namespaces/phone-numbers.js.map +1 -0
- package/dist/rest/namespaces/project.d.ts +46 -0
- package/dist/rest/namespaces/project.js +56 -0
- package/dist/rest/namespaces/project.js.map +1 -0
- package/dist/rest/namespaces/pubsub.d.ts +22 -0
- package/dist/rest/namespaces/pubsub.js +26 -0
- package/dist/rest/namespaces/pubsub.js.map +1 -0
- package/dist/rest/namespaces/queues.d.ts +42 -0
- package/dist/rest/namespaces/queues.js +49 -0
- package/dist/rest/namespaces/queues.js.map +1 -0
- package/dist/rest/namespaces/recordings.d.ts +38 -0
- package/dist/rest/namespaces/recordings.js +45 -0
- package/dist/rest/namespaces/recordings.js.map +1 -0
- package/dist/rest/namespaces/registry.d.ts +141 -0
- package/dist/rest/namespaces/registry.js +178 -0
- package/dist/rest/namespaces/registry.js.map +1 -0
- package/dist/rest/namespaces/short-codes.d.ts +39 -0
- package/dist/rest/namespaces/short-codes.js +46 -0
- package/dist/rest/namespaces/short-codes.js.map +1 -0
- package/dist/rest/namespaces/sip-profile.d.ts +28 -0
- package/dist/rest/namespaces/sip-profile.js +34 -0
- package/dist/rest/namespaces/sip-profile.js.map +1 -0
- package/dist/rest/namespaces/verified-callers.d.ts +33 -0
- package/dist/rest/namespaces/verified-callers.js +39 -0
- package/dist/rest/namespaces/verified-callers.js.map +1 -0
- package/dist/rest/namespaces/video.d.ts +235 -0
- package/dist/rest/namespaces/video.js +297 -0
- package/dist/rest/namespaces/video.js.map +1 -0
- package/{src/rest/pagination.ts → dist/rest/pagination.d.ts} +2 -61
- package/dist/rest/pagination.js +78 -0
- package/dist/rest/pagination.js.map +1 -0
- package/dist/rest/types.d.ts +54 -0
- package/dist/rest/types.js +5 -0
- package/dist/rest/types.js.map +1 -0
- package/dist/skills/SkillBase.d.ts +404 -0
- package/dist/skills/SkillBase.js +471 -0
- package/dist/skills/SkillBase.js.map +1 -0
- package/dist/skills/SkillManager.d.ts +195 -0
- package/dist/skills/SkillManager.js +378 -0
- package/dist/skills/SkillManager.js.map +1 -0
- package/dist/skills/SkillRegistry.d.ts +176 -0
- package/dist/skills/SkillRegistry.js +310 -0
- package/dist/skills/SkillRegistry.js.map +1 -0
- package/dist/skills/builtin/api_ninjas_trivia.d.ts +47 -0
- package/dist/skills/builtin/api_ninjas_trivia.js +211 -0
- package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -0
- package/dist/skills/builtin/ask_claude.d.ts +37 -0
- package/dist/skills/builtin/ask_claude.js +162 -0
- package/dist/skills/builtin/ask_claude.js.map +1 -0
- package/dist/skills/builtin/claude_skills.d.ts +75 -0
- package/dist/skills/builtin/claude_skills.js +753 -0
- package/dist/skills/builtin/claude_skills.js.map +1 -0
- package/dist/skills/builtin/custom_skills.d.ts +79 -0
- package/dist/skills/builtin/custom_skills.js +227 -0
- package/dist/skills/builtin/custom_skills.js.map +1 -0
- package/dist/skills/builtin/datasphere.d.ts +73 -0
- package/dist/skills/builtin/datasphere.js +350 -0
- package/dist/skills/builtin/datasphere.js.map +1 -0
- package/dist/skills/builtin/datasphere_serverless.d.ts +89 -0
- package/dist/skills/builtin/datasphere_serverless.js +291 -0
- package/dist/skills/builtin/datasphere_serverless.js.map +1 -0
- package/dist/skills/builtin/datetime.d.ts +40 -0
- package/dist/skills/builtin/datetime.js +118 -0
- package/dist/skills/builtin/datetime.js.map +1 -0
- package/dist/skills/builtin/google_maps.d.ts +48 -0
- package/dist/skills/builtin/google_maps.js +470 -0
- package/dist/skills/builtin/google_maps.js.map +1 -0
- package/dist/skills/builtin/index.d.ts +31 -0
- package/{src/skills/builtin/index.ts → dist/skills/builtin/index.js} +30 -36
- package/dist/skills/builtin/index.js.map +1 -0
- package/dist/skills/builtin/info_gatherer.d.ts +115 -0
- package/dist/skills/builtin/info_gatherer.js +328 -0
- package/dist/skills/builtin/info_gatherer.js.map +1 -0
- package/dist/skills/builtin/joke.d.ts +41 -0
- package/dist/skills/builtin/joke.js +156 -0
- package/dist/skills/builtin/joke.js.map +1 -0
- package/dist/skills/builtin/math.d.ts +39 -0
- package/dist/skills/builtin/math.js +119 -0
- package/dist/skills/builtin/math.js.map +1 -0
- package/dist/skills/builtin/mcp_gateway.d.ts +82 -0
- package/dist/skills/builtin/mcp_gateway.js +574 -0
- package/dist/skills/builtin/mcp_gateway.js.map +1 -0
- package/dist/skills/builtin/native_vector_search.d.ts +128 -0
- package/dist/skills/builtin/native_vector_search.js +752 -0
- package/dist/skills/builtin/native_vector_search.js.map +1 -0
- package/dist/skills/builtin/play_background_file.d.ts +59 -0
- package/dist/skills/builtin/play_background_file.js +274 -0
- package/dist/skills/builtin/play_background_file.js.map +1 -0
- package/dist/skills/builtin/spider.d.ts +91 -0
- package/dist/skills/builtin/spider.js +758 -0
- package/dist/skills/builtin/spider.js.map +1 -0
- package/dist/skills/builtin/swml_transfer.d.ts +66 -0
- package/dist/skills/builtin/swml_transfer.js +475 -0
- package/dist/skills/builtin/swml_transfer.js.map +1 -0
- package/dist/skills/builtin/weather_api.d.ts +59 -0
- package/dist/skills/builtin/weather_api.js +196 -0
- package/dist/skills/builtin/weather_api.js.map +1 -0
- package/dist/skills/builtin/web_search.d.ts +160 -0
- package/dist/skills/builtin/web_search.js +894 -0
- package/dist/skills/builtin/web_search.js.map +1 -0
- package/dist/skills/builtin/wikipedia_search.d.ts +77 -0
- package/dist/skills/builtin/wikipedia_search.js +241 -0
- package/dist/skills/builtin/wikipedia_search.js.map +1 -0
- package/{src/skills/index.ts → dist/skills/index.d.ts} +0 -1
- package/dist/skills/index.js +10 -0
- package/dist/skills/index.js.map +1 -0
- package/dist/types.d.ts +118 -0
- package/dist/types.js +5 -0
- package/dist/types.js.map +1 -0
- package/package.json +7 -1
- package/.github/workflows/publish.yml +0 -27
- package/.github/workflows/test.yml +0 -17
- package/CLAUDE.md +0 -112
- package/docs/MIGRATION-2.0.md +0 -81
- package/docs/agent-guide.md +0 -869
- package/docs/agent_guide.md +0 -1026
- package/docs/api-reference.md +0 -2420
- package/docs/api_reference.md +0 -1301
- package/docs/architecture.md +0 -843
- package/docs/cli-guide.md +0 -579
- package/docs/cli_guide.md +0 -448
- package/docs/cloud_functions_guide.md +0 -474
- package/docs/configuration.md +0 -422
- package/docs/contexts-guide.md +0 -787
- package/docs/contexts_guide.md +0 -511
- package/docs/datamap-guide.md +0 -1141
- package/docs/datamap_guide.md +0 -595
- package/docs/llm_parameters.md +0 -239
- package/docs/mcp_gateway_reference.md +0 -648
- package/docs/mcp_integration.md +0 -108
- package/docs/prefabs-guide.md +0 -800
- package/docs/sdk_features.md +0 -477
- package/docs/security.md +0 -436
- package/docs/serverless-guide.md +0 -513
- package/docs/skills-guide.md +0 -857
- package/docs/skills-system.md +0 -301
- package/docs/skills_parameter_schema.md +0 -392
- package/docs/skills_system.md +0 -467
- package/docs/swaig-reference.md +0 -1627
- package/docs/swaig_reference.md +0 -910
- package/docs/swml_service_guide.md +0 -600
- package/docs/third_party_skills.md +0 -533
- package/docs/web_service.md +0 -677
- package/examples/README.md +0 -131
- package/examples/advanced-datamap.ts +0 -100
- package/examples/advanced-dynamic-config.ts +0 -70
- package/examples/auto-vivified.ts +0 -94
- package/examples/call-flow.ts +0 -63
- package/examples/comprehensive-dynamic.ts +0 -125
- package/examples/contexts-steps.ts +0 -65
- package/examples/custom-path.ts +0 -45
- package/examples/datamap-tools.ts +0 -55
- package/examples/datasphere-multi-instance.ts +0 -63
- package/examples/datasphere-serverless-env.ts +0 -68
- package/examples/datasphere-webhook-env.ts +0 -66
- package/examples/datasphere.ts +0 -37
- package/examples/declarative.ts +0 -100
- package/examples/dynamic-config.ts +0 -54
- package/examples/dynamic-info-gatherer.ts +0 -69
- package/examples/dynamic-swml-service.ts +0 -67
- package/examples/gather-info.ts +0 -71
- package/examples/gather-per-question-functions-demo.ts +0 -140
- package/examples/joke-agent.ts +0 -34
- package/examples/kubernetes-agent.ts +0 -45
- package/examples/llm-params.ts +0 -69
- package/examples/mcp-agent.ts +0 -84
- package/examples/mcp-gateway.ts +0 -35
- package/examples/multi-agent.ts +0 -73
- package/examples/multi-endpoint.ts +0 -79
- package/examples/pom-prompt.ts +0 -71
- package/examples/prefab-concierge.ts +0 -47
- package/examples/prefab-faq.ts +0 -54
- package/examples/prefab-info-gatherer.ts +0 -33
- package/examples/prefab-receptionist.ts +0 -36
- package/examples/prefab-survey.ts +0 -68
- package/examples/record-call.ts +0 -67
- package/examples/relay-demo.ts +0 -33
- package/examples/room-and-sip.ts +0 -94
- package/examples/serverless-lambda.ts +0 -35
- package/examples/session-state.ts +0 -83
- package/examples/simple-agent.ts +0 -36
- package/examples/simple-static.ts +0 -29
- package/examples/skills-demo.ts +0 -38
- package/examples/step-function-inheritance-demo.ts +0 -124
- package/examples/swaig-features.ts +0 -187
- package/examples/swml-service-routing.ts +0 -66
- package/examples/swml-service.ts +0 -38
- package/examples/tap.ts +0 -68
- package/examples/verb-methods.ts +0 -45
- package/examples/web-search-multi-instance.ts +0 -72
- package/examples/web-search.ts +0 -38
- package/examples/wikipedia.ts +0 -36
- package/livewire/README.md +0 -140
- package/livewire/docs/migration-guide.md +0 -228
- package/livewire/examples/livewire-basic-agent.ts +0 -74
- package/livewire/examples/livewire-handoff.ts +0 -197
- package/livewire/examples/livewire-multi-tool.ts +0 -117
- package/relay/README.md +0 -70
- package/relay/RELAY_IMPLEMENTATION_GUIDE.md +0 -1257
- package/relay/docs/call-methods.md +0 -474
- package/relay/docs/client-reference.md +0 -142
- package/relay/docs/events.md +0 -134
- package/relay/docs/getting-started.md +0 -134
- package/relay/docs/guide.md +0 -306
- package/relay/docs/messaging.md +0 -182
- package/relay/examples/relay-inbound.ts +0 -66
- package/relay/examples/relay-messaging.ts +0 -71
- package/relay/examples/relay-outbound.ts +0 -76
- package/rest/README.md +0 -95
- package/rest/docs/calling.md +0 -273
- package/rest/docs/client-reference.md +0 -107
- package/rest/docs/compat.md +0 -204
- package/rest/docs/fabric.md +0 -183
- package/rest/docs/getting-started.md +0 -110
- package/rest/docs/guide.md +0 -351
- package/rest/docs/namespaces.md +0 -285
- package/rest/examples/rest-10dlc-registration.ts +0 -161
- package/rest/examples/rest-calling-ivr-and-ai.ts +0 -102
- package/rest/examples/rest-calling-play-and-record.ts +0 -91
- package/rest/examples/rest-client.ts +0 -65
- package/rest/examples/rest-compat-laml.ts +0 -210
- package/rest/examples/rest-datasphere-search.ts +0 -82
- package/rest/examples/rest-fabric-conferences-and-routing.ts +0 -144
- package/rest/examples/rest-fabric-subscribers-and-sip.ts +0 -108
- package/rest/examples/rest-fabric-swml-and-callflows.ts +0 -99
- package/rest/examples/rest-manage-resources.ts +0 -65
- package/rest/examples/rest-phone-number-management.ts +0 -197
- package/rest/examples/rest-queues-mfa-and-recordings.ts +0 -143
- package/rest/examples/rest-video-rooms.ts +0 -186
- package/src/AgentBase.ts +0 -2598
- package/src/AgentServer.ts +0 -442
- package/src/AuthHandler.ts +0 -256
- package/src/ConfigLoader.ts +0 -447
- package/src/ContextBuilder.ts +0 -1181
- package/src/DataMap.ts +0 -477
- package/src/FunctionResult.ts +0 -903
- package/src/Logger.ts +0 -337
- package/src/PomBuilder.ts +0 -467
- package/src/PromptManager.ts +0 -133
- package/src/SWMLHandler.ts +0 -298
- package/src/SWMLService.ts +0 -749
- package/src/SchemaUtils.ts +0 -361
- package/src/ServerlessAdapter.ts +0 -240
- package/src/SessionManager.ts +0 -311
- package/src/SslConfig.ts +0 -118
- package/src/SwaigFunction.ts +0 -276
- package/src/SwmlBuilder.ts +0 -283
- package/src/SwmlVerbMethods.generated.ts +0 -234
- package/src/TypeInference.ts +0 -199
- package/src/WebService.ts +0 -641
- package/src/cli/agent-loader.ts +0 -166
- package/src/cli/mock-data.ts +0 -111
- package/src/cli/swaig-test.ts +0 -452
- package/src/generateVerbTypes.ts +0 -322
- package/src/livewire/index.ts +0 -1252
- package/src/prefabs/ConciergeAgent.ts +0 -309
- package/src/prefabs/FAQBotAgent.ts +0 -415
- package/src/prefabs/InfoGathererAgent.ts +0 -379
- package/src/prefabs/ReceptionistAgent.ts +0 -395
- package/src/prefabs/SurveyAgent.ts +0 -671
- package/src/relay/Action.ts +0 -482
- package/src/relay/Call.ts +0 -1270
- package/src/relay/Deferred.ts +0 -94
- package/src/relay/Message.ts +0 -199
- package/src/relay/RelayClient.ts +0 -1185
- package/src/relay/RelayError.ts +0 -20
- package/src/relay/RelayEvent.ts +0 -944
- package/src/relay/index.ts +0 -123
- package/src/relay/types.ts +0 -149
- package/src/rest/HttpClient.ts +0 -164
- package/src/rest/RestError.ts +0 -45
- package/src/rest/base/BaseResource.ts +0 -32
- package/src/rest/base/CrudResource.ts +0 -98
- package/src/rest/base/CrudWithAddresses.ts +0 -37
- package/src/rest/namespaces/addresses.ts +0 -64
- package/src/rest/namespaces/calling.ts +0 -534
- package/src/rest/namespaces/chat.ts +0 -31
- package/src/rest/namespaces/compat.ts +0 -812
- package/src/rest/namespaces/datasphere.ts +0 -88
- package/src/rest/namespaces/fabric.ts +0 -417
- package/src/rest/namespaces/imported-numbers.ts +0 -31
- package/src/rest/namespaces/logs.ts +0 -151
- package/src/rest/namespaces/lookup.ts +0 -38
- package/src/rest/namespaces/mfa.ts +0 -61
- package/src/rest/namespaces/number-groups.ts +0 -68
- package/src/rest/namespaces/phone-numbers.ts +0 -76
- package/src/rest/namespaces/project.ts +0 -65
- package/src/rest/namespaces/pubsub.ts +0 -31
- package/src/rest/namespaces/queues.ts +0 -58
- package/src/rest/namespaces/recordings.ts +0 -53
- package/src/rest/namespaces/registry.ts +0 -200
- package/src/rest/namespaces/short-codes.ts +0 -54
- package/src/rest/namespaces/sip-profile.ts +0 -40
- package/src/rest/namespaces/verified-callers.ts +0 -46
- package/src/rest/namespaces/video.ts +0 -332
- package/src/rest/types.ts +0 -61
- package/src/skills/SkillBase.ts +0 -582
- package/src/skills/SkillManager.ts +0 -419
- package/src/skills/SkillRegistry.ts +0 -367
- package/src/skills/builtin/api_ninjas_trivia.ts +0 -285
- package/src/skills/builtin/ask_claude.ts +0 -246
- package/src/skills/builtin/claude_skills.ts +0 -983
- package/src/skills/builtin/custom_skills.ts +0 -327
- package/src/skills/builtin/datasphere.ts +0 -447
- package/src/skills/builtin/datasphere_serverless.ts +0 -347
- package/src/skills/builtin/datetime.ts +0 -137
- package/src/skills/builtin/google_maps.ts +0 -656
- package/src/skills/builtin/info_gatherer.ts +0 -415
- package/src/skills/builtin/joke.ts +0 -196
- package/src/skills/builtin/math.ts +0 -149
- package/src/skills/builtin/mcp_gateway.ts +0 -685
- package/src/skills/builtin/native_vector_search.ts +0 -910
- package/src/skills/builtin/play_background_file.ts +0 -367
- package/src/skills/builtin/spider.ts +0 -874
- package/src/skills/builtin/swml_transfer.ts +0 -645
- package/src/skills/builtin/weather_api.ts +0 -255
- package/src/skills/builtin/web_search.ts +0 -1083
- package/src/skills/builtin/wikipedia_search.ts +0 -304
- package/src/types.ts +0 -132
- package/tests/AgentBase.test.ts +0 -1093
- package/tests/AgentServer.test.ts +0 -126
- package/tests/AuthHandler.test.ts +0 -133
- package/tests/ConfigLoader.test.ts +0 -151
- package/tests/ContextBuilder.test.ts +0 -108
- package/tests/DataMap.test.ts +0 -367
- package/tests/EphemeralSkillCopy.test.ts +0 -107
- package/tests/FunctionResult.test.ts +0 -298
- package/tests/GracefulShutdown.test.ts +0 -46
- package/tests/Logger.test.ts +0 -420
- package/tests/PomBuilder.test.ts +0 -228
- package/tests/ProxyDetection.test.ts +0 -228
- package/tests/SWMLService.test.ts +0 -320
- package/tests/SWMLVerbHandler.test.ts +0 -523
- package/tests/SchemaUtils.test.ts +0 -106
- package/tests/SchemaUtils.verb.test.ts +0 -206
- package/tests/SecurityUtils.test.ts +0 -192
- package/tests/ServerlessAdapter.test.ts +0 -222
- package/tests/SessionManager.test.ts +0 -257
- package/tests/SkillBaseFeatures.test.ts +0 -130
- package/tests/SkillMultiInstance.test.ts +0 -102
- package/tests/SkillParameterSchemas.test.ts +0 -134
- package/tests/SkillRegistrySchema.test.ts +0 -84
- package/tests/SslConfig.test.ts +0 -97
- package/tests/SwmlBuilder.test.ts +0 -400
- package/tests/TypeInference.test.ts +0 -165
- package/tests/VerbHandlerRegistry.test.ts +0 -128
- package/tests/cli/mock-data.test.ts +0 -113
- package/tests/cli/swaig-test.test.ts +0 -108
- package/tests/examples.test.ts +0 -194
- package/tests/fixtures/scrape-parity/README.md +0 -53
- package/tests/fixtures/scrape-parity/expected/01_simple_article.json +0 -5
- package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +0 -5
- package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +0 -5
- package/tests/fixtures/scrape-parity/expected/04_bare_body.json +0 -5
- package/tests/fixtures/scrape-parity/expected/05_malformed.json +0 -5
- package/tests/fixtures/scrape-parity/expected/06_multi_class.json +0 -5
- package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +0 -5
- package/tests/fixtures/scrape-parity/expected/08_inline_script.json +0 -5
- package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +0 -5
- package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +0 -5
- package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +0 -5
- package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +0 -5
- package/tests/fixtures/scrape-parity/html/01_simple_article.html +0 -18
- package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +0 -18
- package/tests/fixtures/scrape-parity/html/03_nested_containers.html +0 -13
- package/tests/fixtures/scrape-parity/html/04_bare_body.html +0 -9
- package/tests/fixtures/scrape-parity/html/05_malformed.html +0 -11
- package/tests/fixtures/scrape-parity/html/06_multi_class.html +0 -18
- package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +0 -12
- package/tests/fixtures/scrape-parity/html/08_inline_script.html +0 -17
- package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +0 -21
- package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +0 -10
- package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +0 -13
- package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +0 -24
- package/tests/fixtures/scrape-parity/python_extract.py +0 -109
- package/tests/livewire/livewire.test.ts +0 -780
- package/tests/mcp.test.ts +0 -221
- package/tests/prefabs/prefabs.test.ts +0 -1093
- package/tests/relay/Action.test.ts +0 -392
- package/tests/relay/Call.test.ts +0 -535
- package/tests/relay/Deferred.test.ts +0 -71
- package/tests/relay/Message.test.ts +0 -164
- package/tests/relay/RelayClient.test.ts +0 -779
- package/tests/relay/RelayEvent.test.ts +0 -463
- package/tests/relay/helpers.ts +0 -79
- package/tests/rest/HttpClient.test.ts +0 -274
- package/tests/rest/RestError.test.ts +0 -53
- package/tests/rest/calling.test.ts +0 -156
- package/tests/rest/client.test.ts +0 -197
- package/tests/rest/compat.test.ts +0 -335
- package/tests/rest/datasphere.test.ts +0 -71
- package/tests/rest/fabric.test.ts +0 -186
- package/tests/rest/helpers.ts +0 -95
- package/tests/rest/logs.test.ts +0 -68
- package/tests/rest/pagination.test.ts +0 -133
- package/tests/rest/registry.test.ts +0 -94
- package/tests/rest/relay-rest.test.ts +0 -290
- package/tests/rest/video.test.ts +0 -173
- package/tests/setup.ts +0 -6
- package/tests/skills/SkillBase.test.ts +0 -108
- package/tests/skills/SkillManager.test.ts +0 -268
- package/tests/skills/SkillRegistry.test.ts +0 -176
- package/tests/skills/builtin.test.ts +0 -1472
- package/tests/skills/claude-skills.test.ts +0 -54
- package/tests/skills/custom-skills.test.ts +0 -53
- package/tests/skills/datasphere-serverless.test.ts +0 -70
- package/tests/skills/datasphere.test.ts +0 -107
- package/tests/skills/datetime.test.ts +0 -101
- package/tests/skills/google-maps.test.ts +0 -78
- package/tests/skills/info-gatherer.test.ts +0 -411
- package/tests/skills/joke.test.ts +0 -81
- package/tests/skills/math.test.ts +0 -68
- package/tests/skills/mcp-gateway.test.ts +0 -101
- package/tests/skills/play-background.test.ts +0 -54
- package/tests/skills/spider.test.ts +0 -108
- package/tests/skills/swml-transfer.test.ts +0 -178
- package/tests/skills/trivia.test.ts +0 -54
- package/tests/skills/vector-search.test.ts +0 -135
- package/tests/skills/weather-api.test.ts +0 -77
- package/tests/skills/web-search-parity.test.ts +0 -59
- package/tests/skills/web-search.test.ts +0 -103
- package/tests/skills/wikipedia.test.ts +0 -63
- package/tsconfig.json +0 -18
- package/vitest.config.ts +0 -9
- /package/{src → dist}/schema.json +0 -0
|
@@ -0,0 +1,652 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* ContextBuilder - Contexts and Steps workflow system.
|
|
3
|
+
*
|
|
4
|
+
* Contexts contain ordered Steps, each with prompt text/POM sections,
|
|
5
|
+
* completion criteria, function restrictions, and navigation rules.
|
|
6
|
+
*/
|
|
7
|
+
/**
|
|
8
|
+
* Reserved tool names auto-injected by the runtime when contexts/steps are
|
|
9
|
+
* present. User-defined SWAIG tools must not collide with these names.
|
|
10
|
+
*
|
|
11
|
+
* - `next_step` / `change_context` are injected when valid_steps or
|
|
12
|
+
* valid_contexts is set so the model can navigate the flow.
|
|
13
|
+
* - `gather_submit` is injected while a step's gather_info is collecting
|
|
14
|
+
* answers.
|
|
15
|
+
*
|
|
16
|
+
* ContextBuilder.validate() rejects any agent that registers a user tool
|
|
17
|
+
* sharing one of these names — the runtime would never call the user tool
|
|
18
|
+
* because the native one wins.
|
|
19
|
+
*/
|
|
20
|
+
export declare const RESERVED_NATIVE_TOOL_NAMES: ReadonlySet<string>;
|
|
21
|
+
/** Represents a single question within a gather operation. */
|
|
22
|
+
export declare class GatherQuestion {
|
|
23
|
+
/** Unique key used to store the answer. */
|
|
24
|
+
key: string;
|
|
25
|
+
/** The question text presented to the user. */
|
|
26
|
+
question: string;
|
|
27
|
+
/** Expected answer type (e.g., "string", "number"). */
|
|
28
|
+
type: string;
|
|
29
|
+
/** Whether the answer requires user confirmation. */
|
|
30
|
+
confirm: boolean;
|
|
31
|
+
/** Optional additional prompt context for this question. */
|
|
32
|
+
prompt?: string;
|
|
33
|
+
/** Optional list of SWAIG function names available during this question. */
|
|
34
|
+
functions?: string[];
|
|
35
|
+
/**
|
|
36
|
+
* Creates a new GatherQuestion.
|
|
37
|
+
* @param opts - Question configuration including key, question text, and optional type/confirm/prompt/functions.
|
|
38
|
+
*/
|
|
39
|
+
constructor(opts: {
|
|
40
|
+
key: string;
|
|
41
|
+
question: string;
|
|
42
|
+
type?: string;
|
|
43
|
+
confirm?: boolean;
|
|
44
|
+
prompt?: string;
|
|
45
|
+
functions?: string[];
|
|
46
|
+
});
|
|
47
|
+
/**
|
|
48
|
+
* Serializes this question to a plain object for SWML output.
|
|
49
|
+
* @returns A dictionary representation of this question.
|
|
50
|
+
*/
|
|
51
|
+
toDict(): Record<string, unknown>;
|
|
52
|
+
}
|
|
53
|
+
/** Collects structured information from the user through a series of questions. */
|
|
54
|
+
export declare class GatherInfo {
|
|
55
|
+
private questions;
|
|
56
|
+
private outputKey?;
|
|
57
|
+
private completionAction?;
|
|
58
|
+
private prompt?;
|
|
59
|
+
/**
|
|
60
|
+
* Creates a new GatherInfo.
|
|
61
|
+
* @param opts - Optional output key, completion action, and prompt configuration.
|
|
62
|
+
*/
|
|
63
|
+
constructor(opts?: {
|
|
64
|
+
outputKey?: string;
|
|
65
|
+
completionAction?: string;
|
|
66
|
+
prompt?: string;
|
|
67
|
+
});
|
|
68
|
+
/**
|
|
69
|
+
* Adds a question to this gather operation.
|
|
70
|
+
* @param opts - Question configuration including key, question text, and optional type/confirm/prompt/functions.
|
|
71
|
+
* @returns This GatherInfo for chaining.
|
|
72
|
+
*/
|
|
73
|
+
addQuestion(opts: {
|
|
74
|
+
key: string;
|
|
75
|
+
question: string;
|
|
76
|
+
type?: string;
|
|
77
|
+
confirm?: boolean;
|
|
78
|
+
prompt?: string;
|
|
79
|
+
functions?: string[];
|
|
80
|
+
}): this;
|
|
81
|
+
/**
|
|
82
|
+
* Returns all questions in this gather operation.
|
|
83
|
+
* @returns The array of GatherQuestion instances.
|
|
84
|
+
*/
|
|
85
|
+
getQuestions(): GatherQuestion[];
|
|
86
|
+
/**
|
|
87
|
+
* Returns the completion action for this gather info.
|
|
88
|
+
* @internal
|
|
89
|
+
*/
|
|
90
|
+
getCompletionAction(): string | undefined;
|
|
91
|
+
/**
|
|
92
|
+
* Serializes this gather operation to a plain object for SWML output.
|
|
93
|
+
* @returns A dictionary representation of the gather info and its questions.
|
|
94
|
+
*/
|
|
95
|
+
toDict(): Record<string, unknown>;
|
|
96
|
+
}
|
|
97
|
+
/** A single step within a context, with prompt content, criteria, function restrictions, and navigation rules. */
|
|
98
|
+
export declare class Step {
|
|
99
|
+
/** The unique name identifying this step within its context. */
|
|
100
|
+
name: string;
|
|
101
|
+
private text;
|
|
102
|
+
private stepCriteria;
|
|
103
|
+
private functions;
|
|
104
|
+
private validSteps;
|
|
105
|
+
private validContexts;
|
|
106
|
+
private sections;
|
|
107
|
+
private gatherInfo;
|
|
108
|
+
private _end;
|
|
109
|
+
private skipUserTurn;
|
|
110
|
+
private _skipToNextStep;
|
|
111
|
+
private resetSystemPrompt;
|
|
112
|
+
private resetUserPrompt;
|
|
113
|
+
private resetConsolidate;
|
|
114
|
+
private resetFullReset;
|
|
115
|
+
/**
|
|
116
|
+
* Creates a new Step.
|
|
117
|
+
* @param name - The unique step name.
|
|
118
|
+
*/
|
|
119
|
+
constructor(name: string);
|
|
120
|
+
/**
|
|
121
|
+
* Sets raw text content for this step, mutually exclusive with POM sections.
|
|
122
|
+
* @param text - The raw prompt text.
|
|
123
|
+
* @returns This step for chaining.
|
|
124
|
+
*/
|
|
125
|
+
setText(text: string): this;
|
|
126
|
+
/**
|
|
127
|
+
* Adds a POM section with a body, mutually exclusive with raw text.
|
|
128
|
+
* @param title - The section heading.
|
|
129
|
+
* @param body - The section body text.
|
|
130
|
+
* @returns This step for chaining.
|
|
131
|
+
*/
|
|
132
|
+
addSection(title: string, body: string): this;
|
|
133
|
+
/**
|
|
134
|
+
* Adds a POM section with bullet points, mutually exclusive with raw text.
|
|
135
|
+
* @param title - The section heading.
|
|
136
|
+
* @param bullets - The list of bullet point strings.
|
|
137
|
+
* @returns This step for chaining.
|
|
138
|
+
*/
|
|
139
|
+
addBullets(title: string, bullets: string[]): this;
|
|
140
|
+
/**
|
|
141
|
+
* Sets the criteria that must be met before this step is considered complete.
|
|
142
|
+
* @param criteria - A description of the completion criteria.
|
|
143
|
+
* @returns This step for chaining.
|
|
144
|
+
*/
|
|
145
|
+
setStepCriteria(criteria: string): this;
|
|
146
|
+
/**
|
|
147
|
+
* Set which non-internal functions are callable while this step is active.
|
|
148
|
+
*
|
|
149
|
+
* IMPORTANT — inheritance behavior:
|
|
150
|
+
* If you do NOT call this method, the step inherits whichever function
|
|
151
|
+
* set was active on the previous step (or the previous context's last
|
|
152
|
+
* step). The server-side runtime only resets the active set when a
|
|
153
|
+
* step explicitly declares its `functions` field. This is by design,
|
|
154
|
+
* but it is the most common source of bugs in multi-step agents:
|
|
155
|
+
* forgetting setFunctions() on a later step lets the previous step's
|
|
156
|
+
* tools leak through.
|
|
157
|
+
*
|
|
158
|
+
* Best practice: call setFunctions() explicitly on every step that
|
|
159
|
+
* should have a different toolset than the previous one.
|
|
160
|
+
*
|
|
161
|
+
* Keep the per-step active set small: LLM tool selection accuracy
|
|
162
|
+
* degrades noticeably past ~7-8 simultaneously-active tools per call.
|
|
163
|
+
* Use per-step whitelisting to partition large tool collections.
|
|
164
|
+
*
|
|
165
|
+
* Internal functions (e.g. `startup_hook`, `hangup_hook`, `gather_submit`)
|
|
166
|
+
* are ALWAYS protected and cannot be deactivated by this whitelist. The
|
|
167
|
+
* native navigation tools `next_step` and `change_context` are injected
|
|
168
|
+
* automatically when validSteps/validContexts is set; they are not
|
|
169
|
+
* affected by this list and do not need to appear in it.
|
|
170
|
+
*
|
|
171
|
+
* @param functions - One of:
|
|
172
|
+
* - `string[]` — whitelist of function names allowed in this step.
|
|
173
|
+
* Functions not in the list become inactive.
|
|
174
|
+
* - `[]` — explicit disable-all (no user functions callable).
|
|
175
|
+
* - `"none"` — synonym for `[]`, same effect.
|
|
176
|
+
* @returns This step for chaining.
|
|
177
|
+
*
|
|
178
|
+
* @example
|
|
179
|
+
* step.setFunctions(['lookup_account', 'check_balance']); // whitelist
|
|
180
|
+
* step.setFunctions([]); // disable all
|
|
181
|
+
* step.setFunctions('none'); // disable all (alt)
|
|
182
|
+
*/
|
|
183
|
+
setFunctions(functions: string | string[]): this;
|
|
184
|
+
/**
|
|
185
|
+
* Sets which steps the AI may navigate to from this step.
|
|
186
|
+
* @param steps - List of allowed step names.
|
|
187
|
+
* @returns This step for chaining.
|
|
188
|
+
*/
|
|
189
|
+
setValidSteps(steps: string[]): this;
|
|
190
|
+
/**
|
|
191
|
+
* Sets which contexts the AI may navigate to from this step.
|
|
192
|
+
* @param contexts - List of allowed context names.
|
|
193
|
+
* @returns This step for chaining.
|
|
194
|
+
*/
|
|
195
|
+
setValidContexts(contexts: string[]): this;
|
|
196
|
+
/**
|
|
197
|
+
* Mark this step as terminal for the step flow.
|
|
198
|
+
*
|
|
199
|
+
* IMPORTANT: `end=true` does NOT end the conversation or hang up the
|
|
200
|
+
* call. It exits step mode entirely after this step executes — clearing
|
|
201
|
+
* the steps list, current step index, validSteps, and validContexts.
|
|
202
|
+
* The agent keeps running, but operates only under the base system
|
|
203
|
+
* prompt and the context-level prompt; no more step instructions are
|
|
204
|
+
* injected and no more `next_step` tool is offered.
|
|
205
|
+
*
|
|
206
|
+
* To actually end the call, call a hangup tool or define a hangup hook.
|
|
207
|
+
*
|
|
208
|
+
* @param end - True to exit step mode after this step.
|
|
209
|
+
* @returns This step for chaining.
|
|
210
|
+
*/
|
|
211
|
+
setEnd(end: boolean): this;
|
|
212
|
+
/**
|
|
213
|
+
* Sets whether to skip waiting for user input when entering this step.
|
|
214
|
+
* @param skip - Whether to skip the user turn.
|
|
215
|
+
* @returns This step for chaining.
|
|
216
|
+
*/
|
|
217
|
+
setSkipUserTurn(skip: boolean): this;
|
|
218
|
+
/**
|
|
219
|
+
* Sets whether to automatically advance to the next step after this one completes.
|
|
220
|
+
* @param skip - Whether to skip to the next step.
|
|
221
|
+
* @returns This step for chaining.
|
|
222
|
+
*/
|
|
223
|
+
setSkipToNextStep(skip: boolean): this;
|
|
224
|
+
/**
|
|
225
|
+
* Initializes a gather info operation on this step for collecting structured data.
|
|
226
|
+
* @param opts - Optional output key, completion action, and prompt configuration.
|
|
227
|
+
* @returns This step for chaining.
|
|
228
|
+
*/
|
|
229
|
+
setGatherInfo(opts?: {
|
|
230
|
+
outputKey?: string;
|
|
231
|
+
completionAction?: string;
|
|
232
|
+
prompt?: string;
|
|
233
|
+
}): this;
|
|
234
|
+
/**
|
|
235
|
+
* Add a question to this step's gather_info configuration.
|
|
236
|
+
* setGatherInfo() must be called before this method.
|
|
237
|
+
*
|
|
238
|
+
* IMPORTANT — gather mode locks function access:
|
|
239
|
+
* While the model is asking gather questions, the runtime forcibly
|
|
240
|
+
* deactivates ALL of the step's other functions. The only callable
|
|
241
|
+
* tools during a gather question are:
|
|
242
|
+
*
|
|
243
|
+
* - `gather_submit` (the native answer-submission tool)
|
|
244
|
+
* - Whatever names you list in this question's `functions` option
|
|
245
|
+
*
|
|
246
|
+
* `next_step` and `change_context` are also filtered out — the model
|
|
247
|
+
* cannot navigate away until the gather completes. This is by design:
|
|
248
|
+
* it forces a tight ask → submit → next-question loop.
|
|
249
|
+
*
|
|
250
|
+
* If a question needs to call out to a tool (e.g. validate an email,
|
|
251
|
+
* geocode a ZIP), list that tool name in this question's `functions`.
|
|
252
|
+
* Functions listed here are active ONLY for this question.
|
|
253
|
+
*
|
|
254
|
+
* @param opts - Question configuration including key, question text, and optional type/confirm/prompt/functions.
|
|
255
|
+
* @returns This step for chaining.
|
|
256
|
+
*/
|
|
257
|
+
addGatherQuestion(opts: {
|
|
258
|
+
key: string;
|
|
259
|
+
question: string;
|
|
260
|
+
type?: string;
|
|
261
|
+
confirm?: boolean;
|
|
262
|
+
prompt?: string;
|
|
263
|
+
functions?: string[];
|
|
264
|
+
}): this;
|
|
265
|
+
/**
|
|
266
|
+
* Returns the gather info for this step, if any.
|
|
267
|
+
* @internal
|
|
268
|
+
*/
|
|
269
|
+
getGatherInfo(): GatherInfo | null;
|
|
270
|
+
/**
|
|
271
|
+
* Returns the valid steps list for this step, if any.
|
|
272
|
+
* @internal
|
|
273
|
+
*/
|
|
274
|
+
getValidSteps(): string[] | null;
|
|
275
|
+
/**
|
|
276
|
+
* Returns the valid contexts list for this step, if any.
|
|
277
|
+
* @internal
|
|
278
|
+
*/
|
|
279
|
+
getStepValidContexts(): string[] | null;
|
|
280
|
+
/**
|
|
281
|
+
* Removes all POM sections and raw text from this step.
|
|
282
|
+
* @returns This step for chaining.
|
|
283
|
+
*/
|
|
284
|
+
clearSections(): this;
|
|
285
|
+
/**
|
|
286
|
+
* Sets the system prompt to use when resetting context at this step.
|
|
287
|
+
* @param systemPrompt - The replacement system prompt text.
|
|
288
|
+
* @returns This step for chaining.
|
|
289
|
+
*/
|
|
290
|
+
setResetSystemPrompt(systemPrompt: string): this;
|
|
291
|
+
/**
|
|
292
|
+
* Sets the user prompt to use when resetting context at this step.
|
|
293
|
+
* @param userPrompt - The replacement user prompt text.
|
|
294
|
+
* @returns This step for chaining.
|
|
295
|
+
*/
|
|
296
|
+
setResetUserPrompt(userPrompt: string): this;
|
|
297
|
+
/**
|
|
298
|
+
* Sets whether to consolidate conversation history when resetting at this step.
|
|
299
|
+
* @param consolidate - Whether to consolidate.
|
|
300
|
+
* @returns This step for chaining.
|
|
301
|
+
*/
|
|
302
|
+
setResetConsolidate(consolidate: boolean): this;
|
|
303
|
+
/**
|
|
304
|
+
* Sets whether to perform a full conversation reset at this step.
|
|
305
|
+
* @param fullReset - Whether to fully reset.
|
|
306
|
+
* @returns This step for chaining.
|
|
307
|
+
*/
|
|
308
|
+
setResetFullReset(fullReset: boolean): this;
|
|
309
|
+
private renderText;
|
|
310
|
+
/**
|
|
311
|
+
* Serializes this step to a plain object for SWML output.
|
|
312
|
+
* @returns A dictionary representation of this step.
|
|
313
|
+
*/
|
|
314
|
+
toDict(): Record<string, unknown>;
|
|
315
|
+
}
|
|
316
|
+
/** A named context containing ordered steps, prompt configuration, and navigation rules. */
|
|
317
|
+
export declare class Context {
|
|
318
|
+
/** The unique name identifying this context. */
|
|
319
|
+
name: string;
|
|
320
|
+
private steps;
|
|
321
|
+
private stepOrder;
|
|
322
|
+
private _validContexts;
|
|
323
|
+
private _validSteps;
|
|
324
|
+
private _postPrompt;
|
|
325
|
+
private _systemPrompt;
|
|
326
|
+
private systemPromptSections;
|
|
327
|
+
private _consolidate;
|
|
328
|
+
private _fullReset;
|
|
329
|
+
private _userPrompt;
|
|
330
|
+
private _isolated;
|
|
331
|
+
private promptText;
|
|
332
|
+
private promptSections;
|
|
333
|
+
private _initialStep;
|
|
334
|
+
private _enterFillers;
|
|
335
|
+
private _exitFillers;
|
|
336
|
+
/**
|
|
337
|
+
* Creates a new Context.
|
|
338
|
+
* @param name - The unique context name.
|
|
339
|
+
*/
|
|
340
|
+
constructor(name: string);
|
|
341
|
+
/**
|
|
342
|
+
* Adds a new step to this context.
|
|
343
|
+
* @param name - The unique step name within this context.
|
|
344
|
+
* @param opts - Optional shorthand for task text, bullets, criteria, functions, and valid steps.
|
|
345
|
+
* @returns The newly created Step for further configuration.
|
|
346
|
+
*/
|
|
347
|
+
addStep(name: string, opts?: {
|
|
348
|
+
task?: string;
|
|
349
|
+
bullets?: string[];
|
|
350
|
+
criteria?: string;
|
|
351
|
+
functions?: string | string[];
|
|
352
|
+
validSteps?: string[];
|
|
353
|
+
}): Step;
|
|
354
|
+
/**
|
|
355
|
+
* Returns a step by name.
|
|
356
|
+
* @param name - The step name to retrieve.
|
|
357
|
+
* @returns The matching Step, or undefined if not found.
|
|
358
|
+
*/
|
|
359
|
+
getStep(name: string): Step | undefined;
|
|
360
|
+
/**
|
|
361
|
+
* Removes a step from this context by name.
|
|
362
|
+
* @param name - The step name to remove.
|
|
363
|
+
* @returns This context for chaining.
|
|
364
|
+
*/
|
|
365
|
+
removeStep(name: string): this;
|
|
366
|
+
/**
|
|
367
|
+
* Moves a step to a new position in the step order.
|
|
368
|
+
* @param name - The step name to move.
|
|
369
|
+
* @param position - The zero-based index to insert at.
|
|
370
|
+
* @returns This context for chaining.
|
|
371
|
+
*/
|
|
372
|
+
moveStep(name: string, position: number): this;
|
|
373
|
+
/**
|
|
374
|
+
* Sets which contexts the AI may navigate to from this context.
|
|
375
|
+
* @param contexts - List of allowed context names.
|
|
376
|
+
* @returns This context for chaining.
|
|
377
|
+
*/
|
|
378
|
+
setValidContexts(contexts: string[]): this;
|
|
379
|
+
/**
|
|
380
|
+
* Sets which steps the AI may navigate to from this context.
|
|
381
|
+
* @param steps - List of allowed step names.
|
|
382
|
+
* @returns This context for chaining.
|
|
383
|
+
*/
|
|
384
|
+
setValidSteps(steps: string[]): this;
|
|
385
|
+
/**
|
|
386
|
+
* Sets the post-prompt text for this context.
|
|
387
|
+
* @param postPrompt - The post-prompt string.
|
|
388
|
+
* @returns This context for chaining.
|
|
389
|
+
*/
|
|
390
|
+
setPostPrompt(postPrompt: string): this;
|
|
391
|
+
/**
|
|
392
|
+
* Sets raw system prompt text, mutually exclusive with system POM sections.
|
|
393
|
+
* @param systemPrompt - The system prompt string.
|
|
394
|
+
* @returns This context for chaining.
|
|
395
|
+
*/
|
|
396
|
+
setSystemPrompt(systemPrompt: string): this;
|
|
397
|
+
/**
|
|
398
|
+
* Sets whether to consolidate conversation history when entering this context.
|
|
399
|
+
* @param consolidate - Whether to consolidate.
|
|
400
|
+
* @returns This context for chaining.
|
|
401
|
+
*/
|
|
402
|
+
setConsolidate(consolidate: boolean): this;
|
|
403
|
+
/**
|
|
404
|
+
* Sets whether to fully reset conversation history when entering this context.
|
|
405
|
+
* @param fullReset - Whether to fully reset.
|
|
406
|
+
* @returns This context for chaining.
|
|
407
|
+
*/
|
|
408
|
+
setFullReset(fullReset: boolean): this;
|
|
409
|
+
/**
|
|
410
|
+
* Sets the user prompt text for this context.
|
|
411
|
+
* @param userPrompt - The user prompt string.
|
|
412
|
+
* @returns This context for chaining.
|
|
413
|
+
*/
|
|
414
|
+
setUserPrompt(userPrompt: string): this;
|
|
415
|
+
/**
|
|
416
|
+
* Set which step the context starts on when entered.
|
|
417
|
+
*
|
|
418
|
+
* By default, a context starts on its first step (index 0). Use this to
|
|
419
|
+
* skip a preamble step on re-entry via `change_context`.
|
|
420
|
+
*
|
|
421
|
+
* @param stepName - Name of the step to start on. Must exist in this context (validated by ContextBuilder.validate()).
|
|
422
|
+
* @returns This context for chaining.
|
|
423
|
+
*/
|
|
424
|
+
setInitialStep(stepName: string): this;
|
|
425
|
+
/**
|
|
426
|
+
* Mark this context as isolated — entering it wipes conversation history.
|
|
427
|
+
*
|
|
428
|
+
* When `isolated=true` and the context is entered via change_context, the
|
|
429
|
+
* runtime wipes the conversation array. The model starts fresh with only
|
|
430
|
+
* the new context's systemPrompt + step instructions, with no memory of
|
|
431
|
+
* prior turns.
|
|
432
|
+
*
|
|
433
|
+
* EXCEPTION — `reset` overrides the wipe:
|
|
434
|
+
* If the context also has a `reset` configuration (via consolidate or
|
|
435
|
+
* full_reset), the wipe is skipped in favor of the reset behavior. Use
|
|
436
|
+
* reset with consolidate=true to summarize prior history into a single
|
|
437
|
+
* message instead of dropping it entirely.
|
|
438
|
+
*
|
|
439
|
+
* Use cases:
|
|
440
|
+
* - Switching to a sensitive billing flow that should not see prior
|
|
441
|
+
* small-talk
|
|
442
|
+
* - Handing off to a different agent persona
|
|
443
|
+
* - Resetting after a long off-topic detour
|
|
444
|
+
*
|
|
445
|
+
* @param isolated - True to wipe conversation history on context entry
|
|
446
|
+
* (subject to the reset exception above).
|
|
447
|
+
* @returns This context for chaining.
|
|
448
|
+
*/
|
|
449
|
+
setIsolated(isolated: boolean): this;
|
|
450
|
+
/**
|
|
451
|
+
* Adds a POM section to the system prompt, mutually exclusive with raw system prompt text.
|
|
452
|
+
* @param title - The section heading.
|
|
453
|
+
* @param body - The section body text.
|
|
454
|
+
* @returns This context for chaining.
|
|
455
|
+
*/
|
|
456
|
+
addSystemSection(title: string, body: string): this;
|
|
457
|
+
/**
|
|
458
|
+
* Adds a POM section with bullets to the system prompt, mutually exclusive with raw system prompt text.
|
|
459
|
+
* @param title - The section heading.
|
|
460
|
+
* @param bullets - The list of bullet point strings.
|
|
461
|
+
* @returns This context for chaining.
|
|
462
|
+
*/
|
|
463
|
+
addSystemBullets(title: string, bullets: string[]): this;
|
|
464
|
+
/**
|
|
465
|
+
* Sets raw prompt text for this context, mutually exclusive with POM prompt sections.
|
|
466
|
+
* @param prompt - The prompt string.
|
|
467
|
+
* @returns This context for chaining.
|
|
468
|
+
*/
|
|
469
|
+
setPrompt(prompt: string): this;
|
|
470
|
+
/**
|
|
471
|
+
* Adds a POM section with a body to the context prompt, mutually exclusive with raw prompt text.
|
|
472
|
+
* @param title - The section heading.
|
|
473
|
+
* @param body - The section body text.
|
|
474
|
+
* @returns This context for chaining.
|
|
475
|
+
*/
|
|
476
|
+
addSection(title: string, body: string): this;
|
|
477
|
+
/**
|
|
478
|
+
* Adds a POM section with bullets to the context prompt, mutually exclusive with raw prompt text.
|
|
479
|
+
* @param title - The section heading.
|
|
480
|
+
* @param bullets - The list of bullet point strings.
|
|
481
|
+
* @returns This context for chaining.
|
|
482
|
+
*/
|
|
483
|
+
addBullets(title: string, bullets: string[]): this;
|
|
484
|
+
/**
|
|
485
|
+
* Sets filler phrases spoken when entering this context, keyed by language code.
|
|
486
|
+
* @param fillers - Map of language codes to arrays of filler phrases.
|
|
487
|
+
* @returns This context for chaining.
|
|
488
|
+
*/
|
|
489
|
+
setEnterFillers(fillers: Record<string, string[]>): this;
|
|
490
|
+
/**
|
|
491
|
+
* Sets filler phrases spoken when exiting this context, keyed by language code.
|
|
492
|
+
* @param fillers - Map of language codes to arrays of filler phrases.
|
|
493
|
+
* @returns This context for chaining.
|
|
494
|
+
*/
|
|
495
|
+
setExitFillers(fillers: Record<string, string[]>): this;
|
|
496
|
+
/**
|
|
497
|
+
* Adds enter filler phrases for a specific language.
|
|
498
|
+
* @param languageCode - The language code (e.g., "en-US").
|
|
499
|
+
* @param fillers - Array of filler phrases.
|
|
500
|
+
* @returns This context for chaining.
|
|
501
|
+
*/
|
|
502
|
+
addEnterFiller(languageCode: string, fillers: string[]): this;
|
|
503
|
+
/**
|
|
504
|
+
* Adds exit filler phrases for a specific language.
|
|
505
|
+
* @param languageCode - The language code (e.g., "en-US").
|
|
506
|
+
* @param fillers - Array of filler phrases.
|
|
507
|
+
* @returns This context for chaining.
|
|
508
|
+
*/
|
|
509
|
+
addExitFiller(languageCode: string, fillers: string[]): this;
|
|
510
|
+
/** @internal */
|
|
511
|
+
getSteps(): Map<string, Step>;
|
|
512
|
+
/** @internal */
|
|
513
|
+
getStepOrder(): readonly string[];
|
|
514
|
+
/** @internal */
|
|
515
|
+
getInitialStep(): string | null;
|
|
516
|
+
/** @internal */
|
|
517
|
+
getValidContexts(): string[] | null;
|
|
518
|
+
private renderPrompt;
|
|
519
|
+
private renderSystemPrompt;
|
|
520
|
+
private renderSections;
|
|
521
|
+
/**
|
|
522
|
+
* Serializes this context and all its steps to a plain object for SWML output.
|
|
523
|
+
* @returns A dictionary representation of this context.
|
|
524
|
+
*/
|
|
525
|
+
toDict(): Record<string, unknown>;
|
|
526
|
+
}
|
|
527
|
+
/**
|
|
528
|
+
* Builder for multi-step, multi-context AI agent workflows.
|
|
529
|
+
*
|
|
530
|
+
* A ContextBuilder owns one or more Contexts; each Context owns an ordered
|
|
531
|
+
* list of Steps. Only one context and one step is active at a time. Per
|
|
532
|
+
* chat turn, the runtime injects the current step's instructions as a
|
|
533
|
+
* system message, then asks the LLM for a response.
|
|
534
|
+
*
|
|
535
|
+
* ## Native tools auto-injected by the runtime
|
|
536
|
+
*
|
|
537
|
+
* When a step (or its enclosing context) declares `validSteps` or
|
|
538
|
+
* `validContexts`, the runtime auto-injects two native tools so the model
|
|
539
|
+
* can navigate the flow:
|
|
540
|
+
*
|
|
541
|
+
* - `next_step(step: enum)` — present when validSteps is set
|
|
542
|
+
* - `change_context(context: enum)` — present when validContexts is set
|
|
543
|
+
*
|
|
544
|
+
* Their `enum` schemas are rewritten on every turn to match whatever
|
|
545
|
+
* validSteps / validContexts apply to the current step. You do NOT need
|
|
546
|
+
* to define these tools yourself; they appear automatically.
|
|
547
|
+
*
|
|
548
|
+
* A third native tool — `gather_submit` — is injected during gather_info
|
|
549
|
+
* questioning (see Step.setGatherInfo / addGatherQuestion).
|
|
550
|
+
*
|
|
551
|
+
* These three names — `next_step`, `change_context`, `gather_submit` —
|
|
552
|
+
* are reserved. ContextBuilder.validate() will reject any agent that
|
|
553
|
+
* defines a SWAIG tool with one of these names.
|
|
554
|
+
*
|
|
555
|
+
* ## Function whitelisting (Step.setFunctions)
|
|
556
|
+
*
|
|
557
|
+
* Each step may declare a `functions` whitelist. The whitelist is applied
|
|
558
|
+
* in-memory at the start of each LLM turn. CRITICALLY: if a step does NOT
|
|
559
|
+
* declare a `functions` field, it INHERITS the previous step's active set.
|
|
560
|
+
* See Step.setFunctions() for details and examples.
|
|
561
|
+
*
|
|
562
|
+
* ## Validation
|
|
563
|
+
*
|
|
564
|
+
* Call validate() (or toDict(), which calls it) to check that:
|
|
565
|
+
*
|
|
566
|
+
* - At least one context is defined
|
|
567
|
+
* - A single context must be named "default"
|
|
568
|
+
* - Every context has at least one step
|
|
569
|
+
* - validSteps references resolve to real step names (or "next")
|
|
570
|
+
* - validContexts references resolve to real context names
|
|
571
|
+
* - gather_info questions are non-empty and have unique keys
|
|
572
|
+
* - gather_info completion_action targets a reachable step
|
|
573
|
+
* - No user-defined SWAIG tool collides with a reserved native name
|
|
574
|
+
*
|
|
575
|
+
* @example Two-step support bot
|
|
576
|
+
* ```ts
|
|
577
|
+
* import { AgentBase, ContextBuilder } from '@signalwire/sdk';
|
|
578
|
+
*
|
|
579
|
+
* const agent = new AgentBase({ name: 'support', route: '/' });
|
|
580
|
+
*
|
|
581
|
+
* const contexts = new ContextBuilder();
|
|
582
|
+
* const flow = contexts.addContext('default');
|
|
583
|
+
*
|
|
584
|
+
* flow.addStep('greeting')
|
|
585
|
+
* .setText("Greet the caller and ask if they're an existing customer.")
|
|
586
|
+
* .setValidSteps(['existing', 'new']);
|
|
587
|
+
*
|
|
588
|
+
* flow.addStep('existing')
|
|
589
|
+
* .setText('Ask for the account number and read it back to confirm.');
|
|
590
|
+
*
|
|
591
|
+
* flow.addStep('new')
|
|
592
|
+
* .setText('Collect name, email, and reason for calling.');
|
|
593
|
+
*
|
|
594
|
+
* agent.defineContexts(contexts);
|
|
595
|
+
* ```
|
|
596
|
+
*
|
|
597
|
+
* @see {@link Context}
|
|
598
|
+
* @see {@link Step}
|
|
599
|
+
* @see {@link GatherInfo}
|
|
600
|
+
* @see {@link AgentBase.defineContexts}
|
|
601
|
+
*/
|
|
602
|
+
export declare class ContextBuilder {
|
|
603
|
+
private contexts;
|
|
604
|
+
private contextOrder;
|
|
605
|
+
private agent;
|
|
606
|
+
/**
|
|
607
|
+
* Attach an agent reference so validate() can check user tool names
|
|
608
|
+
* against reserved native tool names. Called internally by
|
|
609
|
+
* AgentBase.defineContexts().
|
|
610
|
+
* @internal
|
|
611
|
+
*/
|
|
612
|
+
attachAgent(agent: unknown): this;
|
|
613
|
+
/**
|
|
614
|
+
* Removes all contexts, returning the builder to its initial state.
|
|
615
|
+
* Use this in a dynamic config callback when you need to rebuild
|
|
616
|
+
* contexts from scratch for a specific request.
|
|
617
|
+
* @returns This builder for chaining.
|
|
618
|
+
*/
|
|
619
|
+
reset(): this;
|
|
620
|
+
/**
|
|
621
|
+
* Adds a new named context to the builder.
|
|
622
|
+
*
|
|
623
|
+
* @param name - The unique context name. A single-context flow must name
|
|
624
|
+
* its only context `"default"`.
|
|
625
|
+
* @returns The newly created {@link Context} for further configuration.
|
|
626
|
+
* @throws {Error} When the max-context limit is exceeded or a context with
|
|
627
|
+
* the same name already exists.
|
|
628
|
+
*/
|
|
629
|
+
addContext(name: string): Context;
|
|
630
|
+
/**
|
|
631
|
+
* Returns a context by name.
|
|
632
|
+
* @param name - The context name to retrieve.
|
|
633
|
+
* @returns The matching Context, or undefined if not found.
|
|
634
|
+
*/
|
|
635
|
+
getContext(name: string): Context | undefined;
|
|
636
|
+
/**
|
|
637
|
+
* Validates that all contexts have steps, naming constraints are met, and cross-context references are valid.
|
|
638
|
+
* @throws Error if validation fails.
|
|
639
|
+
*/
|
|
640
|
+
validate(): void;
|
|
641
|
+
/**
|
|
642
|
+
* Validates and serializes all contexts to a plain object for SWML output.
|
|
643
|
+
* @returns A dictionary mapping context names to their serialized representations.
|
|
644
|
+
*/
|
|
645
|
+
toDict(): Record<string, unknown>;
|
|
646
|
+
}
|
|
647
|
+
/**
|
|
648
|
+
* Creates a standalone Context instance without a ContextBuilder.
|
|
649
|
+
* @param name - The context name (defaults to "default").
|
|
650
|
+
* @returns A new Context instance.
|
|
651
|
+
*/
|
|
652
|
+
export declare function createSimpleContext(name?: string): Context;
|