@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
package/examples/pom-prompt.ts
DELETED
|
@@ -1,71 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* POM (Prompt Object Model) Example
|
|
3
|
-
*
|
|
4
|
-
* Build structured prompts with sections, bullets, and subsections
|
|
5
|
-
* instead of raw text strings.
|
|
6
|
-
* Run: npx tsx examples/pom-prompt.ts
|
|
7
|
-
*/
|
|
8
|
-
|
|
9
|
-
import { AgentBase, FunctionResult } from '../src/index.js';
|
|
10
|
-
|
|
11
|
-
export const agent = new AgentBase({
|
|
12
|
-
name: 'support-agent',
|
|
13
|
-
route: '/',
|
|
14
|
-
basicAuth: [
|
|
15
|
-
process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
|
|
16
|
-
process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
|
|
17
|
-
],
|
|
18
|
-
});
|
|
19
|
-
|
|
20
|
-
// Build a structured prompt with POM
|
|
21
|
-
agent.promptAddSection('Role', {
|
|
22
|
-
body: 'You are a technical support agent for Acme Corp.',
|
|
23
|
-
});
|
|
24
|
-
|
|
25
|
-
agent.promptAddSection('Capabilities', {
|
|
26
|
-
bullets: [
|
|
27
|
-
'Answer questions about our products',
|
|
28
|
-
'Help troubleshoot common issues',
|
|
29
|
-
'Escalate complex problems to human agents',
|
|
30
|
-
],
|
|
31
|
-
});
|
|
32
|
-
|
|
33
|
-
agent.promptAddSection('Guidelines', {
|
|
34
|
-
body: 'Always follow these rules when assisting customers:',
|
|
35
|
-
subsections: [
|
|
36
|
-
{
|
|
37
|
-
title: 'Tone',
|
|
38
|
-
body: 'Be professional, empathetic, and patient.',
|
|
39
|
-
},
|
|
40
|
-
{
|
|
41
|
-
title: 'Escalation',
|
|
42
|
-
body: 'If you cannot resolve the issue in 3 attempts, offer to transfer to a human agent.',
|
|
43
|
-
},
|
|
44
|
-
],
|
|
45
|
-
});
|
|
46
|
-
|
|
47
|
-
agent.promptAddSection('Product Info', {
|
|
48
|
-
bullets: [
|
|
49
|
-
'Widget Pro - Our flagship product, $99/mo',
|
|
50
|
-
'Widget Lite - Basic tier, $29/mo',
|
|
51
|
-
'Widget Enterprise - Custom pricing',
|
|
52
|
-
],
|
|
53
|
-
numbered: true,
|
|
54
|
-
});
|
|
55
|
-
|
|
56
|
-
// Add a tool for transferring calls
|
|
57
|
-
agent.defineTool({
|
|
58
|
-
name: 'transfer_to_human',
|
|
59
|
-
description: 'Transfer the caller to a human support agent',
|
|
60
|
-
parameters: {
|
|
61
|
-
reason: { type: 'string', description: 'Reason for the transfer' },
|
|
62
|
-
},
|
|
63
|
-
handler: (_args) => {
|
|
64
|
-
return new FunctionResult('Transferring you to a human agent now.')
|
|
65
|
-
.connect('+15551234567');
|
|
66
|
-
},
|
|
67
|
-
});
|
|
68
|
-
|
|
69
|
-
agent.setPostPrompt('Summarize the support interaction including the issue and resolution.');
|
|
70
|
-
|
|
71
|
-
agent.run();
|
|
@@ -1,47 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Concierge Prefab Example
|
|
3
|
-
*
|
|
4
|
-
* Virtual concierge for a venue. Answers questions about services,
|
|
5
|
-
* amenities, and hours, and checks availability and directions.
|
|
6
|
-
*
|
|
7
|
-
* Run: npx tsx examples/prefab-concierge.ts
|
|
8
|
-
*/
|
|
9
|
-
|
|
10
|
-
import { ConciergeAgent } from '../src/index.js';
|
|
11
|
-
|
|
12
|
-
export const agent = new ConciergeAgent({
|
|
13
|
-
name: 'hotel-concierge',
|
|
14
|
-
venueName: 'Grand Plaza Hotel',
|
|
15
|
-
services: [
|
|
16
|
-
'room service',
|
|
17
|
-
'spa bookings',
|
|
18
|
-
'restaurant reservations',
|
|
19
|
-
'airport shuttle',
|
|
20
|
-
],
|
|
21
|
-
amenities: {
|
|
22
|
-
pool: { hours: '7 AM - 10 PM', location: '2nd Floor (West Wing)' },
|
|
23
|
-
gym: { hours: '24 hours', location: '3rd Floor' },
|
|
24
|
-
spa: { hours: '9 AM - 8 PM', location: 'Ground Floor' },
|
|
25
|
-
'business center': { hours: '24 hours', location: 'Lobby Level' },
|
|
26
|
-
},
|
|
27
|
-
hoursOfOperation: {
|
|
28
|
-
weekday: '6 AM - 11 PM',
|
|
29
|
-
weekend: '7 AM - midnight',
|
|
30
|
-
},
|
|
31
|
-
specialInstructions: [
|
|
32
|
-
'Encourage guests to ask about our weekly wine tasting event.',
|
|
33
|
-
'Mention our partnership with local attractions when asked for recommendations.',
|
|
34
|
-
],
|
|
35
|
-
welcomeMessage: 'Welcome to the Grand Plaza Hotel concierge! How may I assist you today?',
|
|
36
|
-
agentOptions: {
|
|
37
|
-
route: '/',
|
|
38
|
-
basicAuth: [
|
|
39
|
-
process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
|
|
40
|
-
process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
|
|
41
|
-
],
|
|
42
|
-
},
|
|
43
|
-
});
|
|
44
|
-
|
|
45
|
-
agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
|
|
46
|
-
|
|
47
|
-
agent.run();
|
package/examples/prefab-faq.ts
DELETED
|
@@ -1,54 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* FAQ Bot Prefab Example
|
|
3
|
-
*
|
|
4
|
-
* Answers frequently asked questions using keyword matching.
|
|
5
|
-
* Falls back to escalation if no match is found.
|
|
6
|
-
* Run: npx tsx examples/prefab-faq.ts
|
|
7
|
-
*/
|
|
8
|
-
|
|
9
|
-
import { FAQBotAgent } from '../src/index.js';
|
|
10
|
-
|
|
11
|
-
export const agent = new FAQBotAgent({
|
|
12
|
-
name: 'help-desk',
|
|
13
|
-
faqs: [
|
|
14
|
-
{
|
|
15
|
-
question: 'What are your business hours?',
|
|
16
|
-
answer: 'We are open Monday through Friday, 9 AM to 5 PM Eastern Time.',
|
|
17
|
-
keywords: ['hours', 'open', 'close', 'schedule', 'when'],
|
|
18
|
-
},
|
|
19
|
-
{
|
|
20
|
-
question: 'How do I reset my password?',
|
|
21
|
-
answer: 'Go to the login page and click "Forgot Password". Enter your email and we\'ll send a reset link.',
|
|
22
|
-
keywords: ['password', 'reset', 'forgot', 'login', 'access'],
|
|
23
|
-
},
|
|
24
|
-
{
|
|
25
|
-
question: 'What is your return policy?',
|
|
26
|
-
answer: 'We accept returns within 30 days of purchase with a valid receipt. Items must be in original condition.',
|
|
27
|
-
keywords: ['return', 'refund', 'exchange', 'money back'],
|
|
28
|
-
},
|
|
29
|
-
{
|
|
30
|
-
question: 'How can I track my order?',
|
|
31
|
-
answer: 'Log into your account and go to Order History. Click on your order number to see tracking details.',
|
|
32
|
-
keywords: ['track', 'order', 'shipping', 'delivery', 'where'],
|
|
33
|
-
},
|
|
34
|
-
{
|
|
35
|
-
question: 'Do you offer international shipping?',
|
|
36
|
-
answer: 'Yes, we ship to over 50 countries. International shipping rates are calculated at checkout.',
|
|
37
|
-
keywords: ['international', 'shipping', 'overseas', 'global', 'country'],
|
|
38
|
-
},
|
|
39
|
-
],
|
|
40
|
-
threshold: 0.4,
|
|
41
|
-
escalationMessage: 'I couldn\'t find an answer to that. Let me connect you with a team member.',
|
|
42
|
-
escalationNumber: '+18005551234',
|
|
43
|
-
agentOptions: {
|
|
44
|
-
route: '/',
|
|
45
|
-
basicAuth: [
|
|
46
|
-
process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
|
|
47
|
-
process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
|
|
48
|
-
],
|
|
49
|
-
},
|
|
50
|
-
});
|
|
51
|
-
|
|
52
|
-
agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
|
|
53
|
-
|
|
54
|
-
agent.run();
|
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* InfoGatherer Prefab Example
|
|
3
|
-
*
|
|
4
|
-
* Collects information from callers by asking a sequence of questions.
|
|
5
|
-
* Each question has a `key_name` used to store the answer and a
|
|
6
|
-
* `question_text` spoken to the caller. The `confirm` flag forces the AI
|
|
7
|
-
* to verify the answer before submitting.
|
|
8
|
-
*
|
|
9
|
-
* Run: npx tsx examples/prefab-info-gatherer.ts
|
|
10
|
-
*/
|
|
11
|
-
|
|
12
|
-
import { InfoGathererAgent } from '../src/index.js';
|
|
13
|
-
|
|
14
|
-
export const agent = new InfoGathererAgent({
|
|
15
|
-
name: 'intake-agent',
|
|
16
|
-
questions: [
|
|
17
|
-
{ key_name: 'full_name', question_text: 'What is your full name?' },
|
|
18
|
-
{ key_name: 'email', question_text: 'What is your email address?', confirm: true },
|
|
19
|
-
{ key_name: 'phone', question_text: 'What is a good callback number?', confirm: true },
|
|
20
|
-
{ key_name: 'reason', question_text: 'How can we help you today?' },
|
|
21
|
-
],
|
|
22
|
-
agentOptions: {
|
|
23
|
-
route: '/',
|
|
24
|
-
basicAuth: [
|
|
25
|
-
process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
|
|
26
|
-
process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
|
|
27
|
-
],
|
|
28
|
-
},
|
|
29
|
-
});
|
|
30
|
-
|
|
31
|
-
agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
|
|
32
|
-
|
|
33
|
-
agent.run();
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Receptionist Prefab Example
|
|
3
|
-
*
|
|
4
|
-
* Front-desk agent that greets callers, collects their name + reason for
|
|
5
|
-
* calling, and transfers them to the appropriate department by phone
|
|
6
|
-
* number. Optionally supports visitor check-in.
|
|
7
|
-
*
|
|
8
|
-
* Run: npx tsx examples/prefab-receptionist.ts
|
|
9
|
-
*/
|
|
10
|
-
|
|
11
|
-
import { ReceptionistAgent } from '../src/index.js';
|
|
12
|
-
|
|
13
|
-
export const agent = new ReceptionistAgent({
|
|
14
|
-
name: 'front-desk',
|
|
15
|
-
companyName: 'Acme Technologies',
|
|
16
|
-
departments: [
|
|
17
|
-
{ name: 'engineering', description: 'Software development team', number: '+15551001001' },
|
|
18
|
-
{ name: 'marketing', description: 'Marketing and communications', number: '+15551001002' },
|
|
19
|
-
{ name: 'hr', description: 'Hiring and benefits', number: '+15551001003' },
|
|
20
|
-
{ name: 'finance', description: 'Accounting and finance', number: '+15551001004' },
|
|
21
|
-
],
|
|
22
|
-
greeting: 'Welcome to Acme Technologies! How can I help you today?',
|
|
23
|
-
checkInEnabled: true,
|
|
24
|
-
onVisitorCheckIn: (visitor) => {
|
|
25
|
-
console.log('Visitor checked in:', visitor);
|
|
26
|
-
},
|
|
27
|
-
agentOptions: {
|
|
28
|
-
route: '/',
|
|
29
|
-
basicAuth: [
|
|
30
|
-
process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
|
|
31
|
-
process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
|
|
32
|
-
],
|
|
33
|
-
},
|
|
34
|
-
});
|
|
35
|
-
|
|
36
|
-
agent.run();
|
|
@@ -1,68 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Survey Prefab Example
|
|
3
|
-
*
|
|
4
|
-
* Conducts a customer satisfaction survey with branching logic.
|
|
5
|
-
* Questions branch based on answers (satisfied → ask for details,
|
|
6
|
-
* dissatisfied → ask for improvement areas).
|
|
7
|
-
* Run: npx tsx examples/prefab-survey.ts
|
|
8
|
-
*/
|
|
9
|
-
|
|
10
|
-
import { SurveyAgent } from '../src/index.js';
|
|
11
|
-
|
|
12
|
-
export const agent = new SurveyAgent({
|
|
13
|
-
name: 'csat-survey',
|
|
14
|
-
surveyName: 'Customer Satisfaction Survey',
|
|
15
|
-
questions: [
|
|
16
|
-
{
|
|
17
|
-
id: 'satisfaction',
|
|
18
|
-
text: 'Overall, how satisfied are you with our service?',
|
|
19
|
-
type: 'rating',
|
|
20
|
-
scale: 10,
|
|
21
|
-
points: { '9': 3, '10': 3, '7': 2, '8': 2 },
|
|
22
|
-
},
|
|
23
|
-
{
|
|
24
|
-
id: 'recommend',
|
|
25
|
-
text: 'Would you recommend us to a friend or colleague?',
|
|
26
|
-
type: 'yes_no',
|
|
27
|
-
nextQuestion: {
|
|
28
|
-
yes: 'best_part',
|
|
29
|
-
no: 'improve',
|
|
30
|
-
},
|
|
31
|
-
points: { yes: 2, no: 0 },
|
|
32
|
-
},
|
|
33
|
-
{
|
|
34
|
-
id: 'best_part',
|
|
35
|
-
text: 'What did you like most about our service?',
|
|
36
|
-
type: 'open_ended',
|
|
37
|
-
nextQuestion: 'final_comments',
|
|
38
|
-
},
|
|
39
|
-
{
|
|
40
|
-
id: 'improve',
|
|
41
|
-
text: 'What area would you most like to see improved?',
|
|
42
|
-
type: 'multiple_choice',
|
|
43
|
-
options: ['Response time', 'Product quality', 'Customer support', 'Pricing'],
|
|
44
|
-
nextQuestion: 'final_comments',
|
|
45
|
-
},
|
|
46
|
-
{
|
|
47
|
-
id: 'final_comments',
|
|
48
|
-
text: 'Any other comments or feedback you\'d like to share?',
|
|
49
|
-
type: 'open_ended',
|
|
50
|
-
},
|
|
51
|
-
],
|
|
52
|
-
introduction: 'Thank you for calling! We\'d love your feedback. This survey takes about 2 minutes.',
|
|
53
|
-
conclusion: 'Thank you for your feedback! It helps us improve.',
|
|
54
|
-
onComplete: (responses, score) => {
|
|
55
|
-
console.log('Survey complete:', { responses, score });
|
|
56
|
-
},
|
|
57
|
-
agentOptions: {
|
|
58
|
-
route: '/',
|
|
59
|
-
basicAuth: [
|
|
60
|
-
process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
|
|
61
|
-
process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
|
|
62
|
-
],
|
|
63
|
-
},
|
|
64
|
-
});
|
|
65
|
-
|
|
66
|
-
agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
|
|
67
|
-
|
|
68
|
-
agent.run();
|
package/examples/record-call.ts
DELETED
|
@@ -1,67 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Record Call Example
|
|
3
|
-
*
|
|
4
|
-
* Demonstrates call recording with FunctionResult actions:
|
|
5
|
-
* recordCall(), stopRecordCall(), and other call-control actions.
|
|
6
|
-
* Run: npx tsx examples/record-call.ts
|
|
7
|
-
*/
|
|
8
|
-
|
|
9
|
-
import { AgentBase, FunctionResult } from '../src/index.js';
|
|
10
|
-
|
|
11
|
-
export const agent = new AgentBase({
|
|
12
|
-
name: 'recording-agent',
|
|
13
|
-
route: '/',
|
|
14
|
-
basicAuth: [
|
|
15
|
-
process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
|
|
16
|
-
process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
|
|
17
|
-
],
|
|
18
|
-
recordCall: true,
|
|
19
|
-
recordFormat: 'mp4',
|
|
20
|
-
recordStereo: true,
|
|
21
|
-
});
|
|
22
|
-
|
|
23
|
-
agent.setPromptText(
|
|
24
|
-
'You are a customer service agent. All calls are recorded for quality assurance. ' +
|
|
25
|
-
'If the caller asks, you can pause or stop the recording.',
|
|
26
|
-
);
|
|
27
|
-
|
|
28
|
-
agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
|
|
29
|
-
|
|
30
|
-
agent.defineTool({
|
|
31
|
-
name: 'start_recording',
|
|
32
|
-
description: 'Start or resume call recording',
|
|
33
|
-
parameters: {},
|
|
34
|
-
handler: () => {
|
|
35
|
-
const result = new FunctionResult('Recording has been started.');
|
|
36
|
-
result.recordCall({ stereo: true, format: 'mp3' });
|
|
37
|
-
return result;
|
|
38
|
-
},
|
|
39
|
-
});
|
|
40
|
-
|
|
41
|
-
agent.defineTool({
|
|
42
|
-
name: 'stop_recording',
|
|
43
|
-
description: 'Stop call recording when the caller requests it',
|
|
44
|
-
parameters: {},
|
|
45
|
-
handler: () => {
|
|
46
|
-
const result = new FunctionResult('Recording has been stopped.');
|
|
47
|
-
result.stopRecordCall();
|
|
48
|
-
return result;
|
|
49
|
-
},
|
|
50
|
-
});
|
|
51
|
-
|
|
52
|
-
agent.defineTool({
|
|
53
|
-
name: 'transfer_to_supervisor',
|
|
54
|
-
description: 'Transfer the caller to a supervisor',
|
|
55
|
-
parameters: {
|
|
56
|
-
reason: { type: 'string', description: 'Reason for the transfer' },
|
|
57
|
-
},
|
|
58
|
-
handler: (args) => {
|
|
59
|
-
const result = new FunctionResult(
|
|
60
|
-
`Transferring you to a supervisor. Reason: ${args.reason}`,
|
|
61
|
-
);
|
|
62
|
-
result.connect('+18005551234');
|
|
63
|
-
return result;
|
|
64
|
-
},
|
|
65
|
-
});
|
|
66
|
-
|
|
67
|
-
agent.run();
|
package/examples/relay-demo.ts
DELETED
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* RELAY Demo -- Answer and Welcome
|
|
3
|
-
*
|
|
4
|
-
* Demonstrates using the RELAY WebSocket client to answer an inbound call
|
|
5
|
-
* and play a TTS greeting.
|
|
6
|
-
*
|
|
7
|
-
* Required env vars:
|
|
8
|
-
* SIGNALWIRE_PROJECT_ID, SIGNALWIRE_API_TOKEN, SIGNALWIRE_SPACE
|
|
9
|
-
*
|
|
10
|
-
* Run: npx tsx examples/relay-demo.ts
|
|
11
|
-
*/
|
|
12
|
-
|
|
13
|
-
import { RelayClient } from '../src/index.js';
|
|
14
|
-
|
|
15
|
-
const client = new RelayClient({
|
|
16
|
-
contexts: ['default'],
|
|
17
|
-
});
|
|
18
|
-
|
|
19
|
-
client.onCall(async (call) => {
|
|
20
|
-
console.log(`Incoming call: ${call.id}`);
|
|
21
|
-
await call.answer();
|
|
22
|
-
|
|
23
|
-
const action = await call.play([
|
|
24
|
-
{ type: 'tts', params: { text: 'Welcome to SignalWire! This is a RELAY demo.' } },
|
|
25
|
-
]);
|
|
26
|
-
await action.wait();
|
|
27
|
-
|
|
28
|
-
await call.hangup();
|
|
29
|
-
console.log(`Call ended: ${call.id}`);
|
|
30
|
-
});
|
|
31
|
-
|
|
32
|
-
console.log('Waiting for inbound calls on context "default" ...');
|
|
33
|
-
client.run();
|
package/examples/room-and-sip.ts
DELETED
|
@@ -1,94 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Room and SIP Actions Example
|
|
3
|
-
*
|
|
4
|
-
* Demonstrates FunctionResult actions for room joining,
|
|
5
|
-
* SIP REFER transfers, and conference management.
|
|
6
|
-
* Run: npx tsx examples/room-and-sip.ts
|
|
7
|
-
*/
|
|
8
|
-
|
|
9
|
-
import { AgentBase, FunctionResult } from '../src/index.js';
|
|
10
|
-
|
|
11
|
-
export const agent = new AgentBase({
|
|
12
|
-
name: 'room-sip-agent',
|
|
13
|
-
route: '/',
|
|
14
|
-
basicAuth: [
|
|
15
|
-
process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
|
|
16
|
-
process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
|
|
17
|
-
],
|
|
18
|
-
});
|
|
19
|
-
|
|
20
|
-
agent.setPromptText(
|
|
21
|
-
'You are a meeting coordinator. You can help callers join rooms, ' +
|
|
22
|
-
'transfer calls via SIP, and manage conferences.',
|
|
23
|
-
);
|
|
24
|
-
|
|
25
|
-
// Join a SignalWire room
|
|
26
|
-
agent.defineTool({
|
|
27
|
-
name: 'join_meeting_room',
|
|
28
|
-
description: 'Join a meeting room by name',
|
|
29
|
-
parameters: {
|
|
30
|
-
room_name: { type: 'string', description: 'Name of the meeting room' },
|
|
31
|
-
},
|
|
32
|
-
handler: (args) => {
|
|
33
|
-
const result = new FunctionResult(
|
|
34
|
-
`Connecting you to room "${args.room_name}" now.`,
|
|
35
|
-
);
|
|
36
|
-
result.joinRoom(args.room_name as string);
|
|
37
|
-
return result;
|
|
38
|
-
},
|
|
39
|
-
});
|
|
40
|
-
|
|
41
|
-
// Transfer via SIP REFER
|
|
42
|
-
agent.defineTool({
|
|
43
|
-
name: 'sip_transfer',
|
|
44
|
-
description: 'Transfer the call to a SIP URI',
|
|
45
|
-
parameters: {
|
|
46
|
-
sip_uri: { type: 'string', description: 'SIP URI to transfer to (e.g., sip:user@domain.com)' },
|
|
47
|
-
},
|
|
48
|
-
handler: (args) => {
|
|
49
|
-
const result = new FunctionResult(
|
|
50
|
-
`Transferring your call to ${args.sip_uri}.`,
|
|
51
|
-
);
|
|
52
|
-
result.sipRefer(args.sip_uri as string);
|
|
53
|
-
return result;
|
|
54
|
-
},
|
|
55
|
-
});
|
|
56
|
-
|
|
57
|
-
// Join a conference call
|
|
58
|
-
agent.defineTool({
|
|
59
|
-
name: 'join_conference',
|
|
60
|
-
description: 'Join a named conference call',
|
|
61
|
-
parameters: {
|
|
62
|
-
conference_name: { type: 'string', description: 'Conference name to join' },
|
|
63
|
-
muted: { type: 'boolean', description: 'Whether to join muted (default: false)' },
|
|
64
|
-
},
|
|
65
|
-
handler: (args) => {
|
|
66
|
-
const muted = args.muted === true;
|
|
67
|
-
const result = new FunctionResult(
|
|
68
|
-
`Joining conference "${args.conference_name}"${muted ? ' (muted)' : ''}.`,
|
|
69
|
-
);
|
|
70
|
-
result.joinConference(args.conference_name as string, { muted });
|
|
71
|
-
return result;
|
|
72
|
-
},
|
|
73
|
-
});
|
|
74
|
-
|
|
75
|
-
// Connect to a phone number
|
|
76
|
-
agent.defineTool({
|
|
77
|
-
name: 'connect_call',
|
|
78
|
-
description: 'Connect the call to a phone number',
|
|
79
|
-
parameters: {
|
|
80
|
-
phone_number: { type: 'string', description: 'Phone number to connect to' },
|
|
81
|
-
},
|
|
82
|
-
handler: (args) => {
|
|
83
|
-
const result = new FunctionResult(
|
|
84
|
-
`Connecting you to ${args.phone_number}. Please hold.`,
|
|
85
|
-
);
|
|
86
|
-
result.connect(args.phone_number as string);
|
|
87
|
-
return result;
|
|
88
|
-
},
|
|
89
|
-
});
|
|
90
|
-
|
|
91
|
-
agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
|
|
92
|
-
agent.addHints(['SIP', 'conference', 'meeting room', 'transfer']);
|
|
93
|
-
|
|
94
|
-
agent.run();
|
|
@@ -1,35 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Serverless Lambda Example
|
|
3
|
-
*
|
|
4
|
-
* Deploy an agent on AWS Lambda using ServerlessAdapter.
|
|
5
|
-
* The adapter converts Lambda events to/from standard HTTP requests.
|
|
6
|
-
* Run: npx tsx examples/serverless-lambda.ts
|
|
7
|
-
*/
|
|
8
|
-
|
|
9
|
-
import { AgentBase, ServerlessAdapter, FunctionResult } from '../src/index.js';
|
|
10
|
-
|
|
11
|
-
// Create the agent as usual
|
|
12
|
-
export const agent = new AgentBase({
|
|
13
|
-
name: 'lambda-agent',
|
|
14
|
-
route: '/',
|
|
15
|
-
basicAuth: [
|
|
16
|
-
process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
|
|
17
|
-
process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
|
|
18
|
-
],
|
|
19
|
-
});
|
|
20
|
-
|
|
21
|
-
agent.setPromptText('You are a helpful assistant deployed on AWS Lambda.');
|
|
22
|
-
agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
|
|
23
|
-
|
|
24
|
-
agent.defineTool({
|
|
25
|
-
name: 'get_time',
|
|
26
|
-
description: 'Get the current time',
|
|
27
|
-
parameters: {},
|
|
28
|
-
handler: () => new FunctionResult(`The time is ${new Date().toISOString()}`),
|
|
29
|
-
});
|
|
30
|
-
|
|
31
|
-
// Create a Lambda handler from the agent's Hono app
|
|
32
|
-
export const handler = ServerlessAdapter.createLambdaHandler(agent.getApp());
|
|
33
|
-
|
|
34
|
-
// For local development, run the agent normally
|
|
35
|
-
agent.run();
|
|
@@ -1,83 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Session State Example
|
|
3
|
-
*
|
|
4
|
-
* Demonstrates onSummary callback for post-call processing,
|
|
5
|
-
* global data for per-call context, and post-prompt instructions.
|
|
6
|
-
* Run: npx tsx examples/session-state.ts
|
|
7
|
-
*/
|
|
8
|
-
|
|
9
|
-
import { AgentBase, FunctionResult } from '../src/index.js';
|
|
10
|
-
import type { AgentOptions } from '../src/index.js';
|
|
11
|
-
|
|
12
|
-
class OrderAgent extends AgentBase {
|
|
13
|
-
static override PROMPT_SECTIONS = [
|
|
14
|
-
{
|
|
15
|
-
title: 'Role',
|
|
16
|
-
body: 'You are an order status assistant. Help callers check the status of their orders and update shipping preferences.',
|
|
17
|
-
},
|
|
18
|
-
{
|
|
19
|
-
title: 'Rules',
|
|
20
|
-
bullets: [
|
|
21
|
-
'Always ask for the order number first.',
|
|
22
|
-
'Use the lookup_order tool to find order details.',
|
|
23
|
-
'Confirm changes before applying them.',
|
|
24
|
-
],
|
|
25
|
-
},
|
|
26
|
-
];
|
|
27
|
-
|
|
28
|
-
constructor(opts: AgentOptions) {
|
|
29
|
-
super(opts);
|
|
30
|
-
this.defineTools();
|
|
31
|
-
}
|
|
32
|
-
|
|
33
|
-
protected override defineTools(): void {
|
|
34
|
-
this.defineTool({
|
|
35
|
-
name: 'lookup_order',
|
|
36
|
-
description: 'Look up an order by its order number',
|
|
37
|
-
parameters: {
|
|
38
|
-
order_number: { type: 'string', description: 'The order number (e.g., ORD-12345)' },
|
|
39
|
-
},
|
|
40
|
-
handler: (args, rawData) => {
|
|
41
|
-
// Store the order number in global data for the post-prompt summary
|
|
42
|
-
this.updateGlobalData({
|
|
43
|
-
last_order_number: args.order_number,
|
|
44
|
-
call_id: rawData['call_id'],
|
|
45
|
-
});
|
|
46
|
-
return new FunctionResult(
|
|
47
|
-
`Order ${args.order_number}: Status: Shipped, ETA: 2 business days, Carrier: FedEx`,
|
|
48
|
-
);
|
|
49
|
-
},
|
|
50
|
-
});
|
|
51
|
-
}
|
|
52
|
-
|
|
53
|
-
override async onSummary(
|
|
54
|
-
summary: Record<string, unknown> | null,
|
|
55
|
-
rawData: Record<string, unknown>,
|
|
56
|
-
): Promise<void> {
|
|
57
|
-
console.log('=== Call Summary ===');
|
|
58
|
-
console.log('Call ID:', rawData['call_id']);
|
|
59
|
-
console.log('Summary:', JSON.stringify(summary, null, 2));
|
|
60
|
-
console.log('===================');
|
|
61
|
-
}
|
|
62
|
-
}
|
|
63
|
-
|
|
64
|
-
export const agent = new OrderAgent({
|
|
65
|
-
name: 'order-agent',
|
|
66
|
-
route: '/',
|
|
67
|
-
basicAuth: [
|
|
68
|
-
process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
|
|
69
|
-
process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
|
|
70
|
-
],
|
|
71
|
-
});
|
|
72
|
-
|
|
73
|
-
// Global data available to the AI throughout the call
|
|
74
|
-
agent.setGlobalData({ company: 'Acme Corp', support_hours: '9am-5pm EST' });
|
|
75
|
-
|
|
76
|
-
// Post-prompt instructs the AI to generate a structured summary
|
|
77
|
-
agent.setPostPrompt(
|
|
78
|
-
'Summarize this call as JSON: { caller_intent, order_numbers_discussed, actions_taken, follow_up_needed }',
|
|
79
|
-
);
|
|
80
|
-
|
|
81
|
-
agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
|
|
82
|
-
|
|
83
|
-
agent.run();
|
package/examples/simple-agent.ts
DELETED
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Simple Agent Example
|
|
3
|
-
*
|
|
4
|
-
* A minimal AI voice agent that answers calls and responds to questions.
|
|
5
|
-
* Run: npx tsx examples/simple-agent.ts
|
|
6
|
-
* Test: curl http://user:pass@localhost:3000/
|
|
7
|
-
*/
|
|
8
|
-
|
|
9
|
-
import { AgentBase, FunctionResult } from '../src/index.js';
|
|
10
|
-
|
|
11
|
-
export const agent = new AgentBase({
|
|
12
|
-
name: 'simple-agent',
|
|
13
|
-
route: '/',
|
|
14
|
-
basicAuth: [
|
|
15
|
-
process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
|
|
16
|
-
process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
|
|
17
|
-
],
|
|
18
|
-
});
|
|
19
|
-
|
|
20
|
-
agent.setPromptText('You are a friendly assistant named Siggy. Help callers with their questions.');
|
|
21
|
-
|
|
22
|
-
agent.addHints(['SignalWire', 'SWML', 'Siggy']);
|
|
23
|
-
agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
|
|
24
|
-
|
|
25
|
-
// Define a tool the AI can call
|
|
26
|
-
agent.defineTool({
|
|
27
|
-
name: 'get_time',
|
|
28
|
-
description: 'Get the current date and time',
|
|
29
|
-
parameters: {},
|
|
30
|
-
handler: () => {
|
|
31
|
-
const now = new Date().toLocaleString();
|
|
32
|
-
return new FunctionResult(`The current date and time is ${now}`);
|
|
33
|
-
},
|
|
34
|
-
});
|
|
35
|
-
|
|
36
|
-
agent.run();
|