@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/docs/datamap_guide.md
DELETED
|
@@ -1,595 +0,0 @@
|
|
|
1
|
-
# DataMap Guide
|
|
2
|
-
|
|
3
|
-
Comprehensive guide to the `DataMap` class in the SignalWire AI Agents TypeScript SDK.
|
|
4
|
-
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
## Table of Contents
|
|
8
|
-
|
|
9
|
-
- [Overview](#overview)
|
|
10
|
-
- [Creating a DataMap](#creating-a-datamap)
|
|
11
|
-
- [Configuration](#configuration)
|
|
12
|
-
- [purpose / description](#purpose--description)
|
|
13
|
-
- [parameter](#parameter)
|
|
14
|
-
- [Webhooks](#webhooks)
|
|
15
|
-
- [webhook](#webhook)
|
|
16
|
-
- [body](#body)
|
|
17
|
-
- [params](#params)
|
|
18
|
-
- [Webhook Headers](#webhook-headers)
|
|
19
|
-
- [Expressions](#expressions)
|
|
20
|
-
- [expression](#expression)
|
|
21
|
-
- [Response Processing](#response-processing)
|
|
22
|
-
- [output](#output)
|
|
23
|
-
- [webhookExpressions](#webhookexpressions)
|
|
24
|
-
- [Error Handling](#error-handling)
|
|
25
|
-
- [fallbackOutput](#fallbackoutput)
|
|
26
|
-
- [errorKeys](#errorkeys)
|
|
27
|
-
- [globalErrorKeys](#globalerrorkeys)
|
|
28
|
-
- [Iteration](#iteration)
|
|
29
|
-
- [foreach](#foreach)
|
|
30
|
-
- [Environment Variables](#environment-variables)
|
|
31
|
-
- [enableEnvExpansion](#enableenvexpansion)
|
|
32
|
-
- [Registration](#registration)
|
|
33
|
-
- [registerWithAgent](#registerwithagent)
|
|
34
|
-
- [toSwaigFunction](#toswaigfunction)
|
|
35
|
-
- [Helper Functions](#helper-functions)
|
|
36
|
-
- [createSimpleApiTool](#createsimpleapitool)
|
|
37
|
-
- [createExpressionTool](#createexpressiontool)
|
|
38
|
-
- [Template Variables Reference](#template-variables-reference)
|
|
39
|
-
- [Complete Examples](#complete-examples)
|
|
40
|
-
|
|
41
|
-
---
|
|
42
|
-
|
|
43
|
-
## Overview
|
|
44
|
-
|
|
45
|
-
`DataMap` creates server-side tool definitions that execute entirely on the SignalWire platform without requiring your own webhook endpoints for the tool handler. Instead of writing a handler function that runs on your server, you describe what HTTP call to make (or what expression to evaluate), how to process the response, and what to return to the AI -- all as configuration.
|
|
46
|
-
|
|
47
|
-
### When to use DataMap vs. defineTool
|
|
48
|
-
|
|
49
|
-
| Feature | `defineTool()` | `DataMap` |
|
|
50
|
-
|--------------------|--------------------------------------------|-------------------------------------------------|
|
|
51
|
-
| Execution location | Your server | SignalWire platform |
|
|
52
|
-
| Custom logic | Full TypeScript/JavaScript | Template variables and pattern matching |
|
|
53
|
-
| External API calls | You make them in your handler | SignalWire makes them for you |
|
|
54
|
-
| Webhook required | Yes (your agent server must be reachable) | No (the data_map config is embedded in SWML) |
|
|
55
|
-
| Best for | Complex logic, database access, auth flows | Simple API lookups, pattern matching, transforms |
|
|
56
|
-
|
|
57
|
-
### How it works
|
|
58
|
-
|
|
59
|
-
1. You define a `DataMap` with a name, parameters, and either webhooks or expressions.
|
|
60
|
-
2. You register it with an agent via `registerWithAgent()` or `toSwaigFunction()`.
|
|
61
|
-
3. When the AI decides to call this tool, SignalWire executes the data_map configuration directly:
|
|
62
|
-
- For **webhooks**: SignalWire makes the HTTP request, processes the response through your output template, and returns the result to the AI.
|
|
63
|
-
- For **expressions**: SignalWire evaluates the test value against the regex pattern and returns the matching output.
|
|
64
|
-
|
|
65
|
-
### Architecture
|
|
66
|
-
|
|
67
|
-
```
|
|
68
|
-
Caller <-> SignalWire AI <-> DataMap (runs on SignalWire)
|
|
69
|
-
|
|
|
70
|
-
+--> External API (optional webhook call)
|
|
71
|
-
```
|
|
72
|
-
|
|
73
|
-
No traffic flows to your server for DataMap tool invocations. Your server only serves the initial SWML document that contains the data_map configuration.
|
|
74
|
-
|
|
75
|
-
---
|
|
76
|
-
|
|
77
|
-
## Creating a DataMap
|
|
78
|
-
|
|
79
|
-
The `DataMap` constructor takes a single argument: the function name.
|
|
80
|
-
|
|
81
|
-
```typescript
|
|
82
|
-
import { DataMap, FunctionResult } from '@signalwire/sdk';
|
|
83
|
-
|
|
84
|
-
const tool = new DataMap('get_weather');
|
|
85
|
-
```
|
|
86
|
-
|
|
87
|
-
All subsequent configuration is done via fluent method chaining:
|
|
88
|
-
|
|
89
|
-
```typescript
|
|
90
|
-
const tool = new DataMap('get_weather')
|
|
91
|
-
.purpose('Get current weather for a city')
|
|
92
|
-
.parameter('city', 'string', 'The city name', { required: true })
|
|
93
|
-
.webhook('GET', 'https://wttr.in/${lc:args.city}?format=j1')
|
|
94
|
-
.output(new FunctionResult('Temperature: ${response.temp_F}F'))
|
|
95
|
-
.fallbackOutput(new FunctionResult('Weather data unavailable.'));
|
|
96
|
-
```
|
|
97
|
-
|
|
98
|
-
---
|
|
99
|
-
|
|
100
|
-
## Configuration
|
|
101
|
-
|
|
102
|
-
### purpose / description
|
|
103
|
-
|
|
104
|
-
Set the tool description shown to the AI. Both methods are aliases.
|
|
105
|
-
|
|
106
|
-
```typescript
|
|
107
|
-
purpose(desc: string): this
|
|
108
|
-
description(desc: string): this
|
|
109
|
-
```
|
|
110
|
-
|
|
111
|
-
```typescript
|
|
112
|
-
const tool = new DataMap('get_weather')
|
|
113
|
-
.purpose('Look up current weather conditions for a location');
|
|
114
|
-
```
|
|
115
|
-
|
|
116
|
-
---
|
|
117
|
-
|
|
118
|
-
### parameter
|
|
119
|
-
|
|
120
|
-
Add a parameter the AI should extract from the conversation.
|
|
121
|
-
|
|
122
|
-
```typescript
|
|
123
|
-
parameter(
|
|
124
|
-
name: string,
|
|
125
|
-
type: string,
|
|
126
|
-
description: string,
|
|
127
|
-
opts?: { required?: boolean; enum?: string[] },
|
|
128
|
-
): this
|
|
129
|
-
```
|
|
130
|
-
|
|
131
|
-
| Argument | Type | Description |
|
|
132
|
-
|----------|------|-------------|
|
|
133
|
-
| `name` | `string` | Parameter name. |
|
|
134
|
-
| `type` | `string` | JSON Schema type (`string`, `number`, `boolean`, etc.). |
|
|
135
|
-
| `description` | `string` | Description shown to the AI. |
|
|
136
|
-
| `opts.required` | `boolean` | Whether the parameter is required. |
|
|
137
|
-
| `opts.enum` | `string[]` | Allowed values. |
|
|
138
|
-
|
|
139
|
-
```typescript
|
|
140
|
-
const tool = new DataMap('classify_ticket')
|
|
141
|
-
.parameter('description', 'string', 'Ticket description', { required: true })
|
|
142
|
-
.parameter('priority', 'string', 'Priority level', {
|
|
143
|
-
enum: ['low', 'medium', 'high', 'critical'],
|
|
144
|
-
});
|
|
145
|
-
```
|
|
146
|
-
|
|
147
|
-
---
|
|
148
|
-
|
|
149
|
-
## Webhooks
|
|
150
|
-
|
|
151
|
-
### webhook
|
|
152
|
-
|
|
153
|
-
Configure an HTTP request that SignalWire will make when the tool is invoked.
|
|
154
|
-
|
|
155
|
-
```typescript
|
|
156
|
-
webhook(
|
|
157
|
-
method: string,
|
|
158
|
-
url: string,
|
|
159
|
-
opts?: { headers?: Record<string, string> },
|
|
160
|
-
): this
|
|
161
|
-
```
|
|
162
|
-
|
|
163
|
-
| Argument | Type | Description |
|
|
164
|
-
|----------|------|-------------|
|
|
165
|
-
| `method` | `string` | HTTP method (`GET`, `POST`, `PUT`, `PATCH`, `DELETE`). |
|
|
166
|
-
| `url` | `string` | URL with template variable expansion. |
|
|
167
|
-
| `opts.headers` | `Record<string, string>` | Request headers. |
|
|
168
|
-
|
|
169
|
-
```typescript
|
|
170
|
-
// Simple GET
|
|
171
|
-
const tool = new DataMap('lookup_order')
|
|
172
|
-
.webhook('GET', 'https://api.example.com/orders/${args.order_id}');
|
|
173
|
-
|
|
174
|
-
// POST with headers
|
|
175
|
-
const tool2 = new DataMap('create_ticket')
|
|
176
|
-
.webhook('POST', 'https://api.example.com/tickets', {
|
|
177
|
-
headers: {
|
|
178
|
-
'Content-Type': 'application/json',
|
|
179
|
-
'Authorization': 'Bearer ${ENV.API_TOKEN}',
|
|
180
|
-
},
|
|
181
|
-
});
|
|
182
|
-
```
|
|
183
|
-
|
|
184
|
-
---
|
|
185
|
-
|
|
186
|
-
### body
|
|
187
|
-
|
|
188
|
-
Set the request body for POST/PUT/PATCH webhooks.
|
|
189
|
-
|
|
190
|
-
```typescript
|
|
191
|
-
body(body: Record<string, unknown>): this
|
|
192
|
-
```
|
|
193
|
-
|
|
194
|
-
```typescript
|
|
195
|
-
const tool = new DataMap('create_ticket')
|
|
196
|
-
.webhook('POST', 'https://api.example.com/tickets')
|
|
197
|
-
.body({
|
|
198
|
-
title: '${args.title}',
|
|
199
|
-
description: '${args.description}',
|
|
200
|
-
priority: '${args.priority}',
|
|
201
|
-
});
|
|
202
|
-
```
|
|
203
|
-
|
|
204
|
-
---
|
|
205
|
-
|
|
206
|
-
### params
|
|
207
|
-
|
|
208
|
-
Set query parameters appended to the webhook URL.
|
|
209
|
-
|
|
210
|
-
```typescript
|
|
211
|
-
params(params: Record<string, string>): this
|
|
212
|
-
```
|
|
213
|
-
|
|
214
|
-
```typescript
|
|
215
|
-
const tool = new DataMap('search')
|
|
216
|
-
.webhook('GET', 'https://api.example.com/search')
|
|
217
|
-
.params({
|
|
218
|
-
q: '${args.query}',
|
|
219
|
-
limit: '10',
|
|
220
|
-
});
|
|
221
|
-
```
|
|
222
|
-
|
|
223
|
-
---
|
|
224
|
-
|
|
225
|
-
### Webhook Headers
|
|
226
|
-
|
|
227
|
-
Headers can include template variables:
|
|
228
|
-
|
|
229
|
-
```typescript
|
|
230
|
-
const tool = new DataMap('secure_lookup')
|
|
231
|
-
.webhook('GET', 'https://api.example.com/data/${args.id}', {
|
|
232
|
-
headers: {
|
|
233
|
-
'Authorization': 'Bearer ${ENV.API_KEY}',
|
|
234
|
-
'X-Request-ID': '${meta_data.call_id}',
|
|
235
|
-
},
|
|
236
|
-
})
|
|
237
|
-
.enableEnvExpansion();
|
|
238
|
-
```
|
|
239
|
-
|
|
240
|
-
---
|
|
241
|
-
|
|
242
|
-
## Expressions
|
|
243
|
-
|
|
244
|
-
### expression
|
|
245
|
-
|
|
246
|
-
Add a pattern-matching expression evaluated against template variables. Expressions are evaluated in order; the first match wins.
|
|
247
|
-
|
|
248
|
-
```typescript
|
|
249
|
-
expression(testValue: string, pattern: string, output: FunctionResult): this
|
|
250
|
-
```
|
|
251
|
-
|
|
252
|
-
| Argument | Type | Description |
|
|
253
|
-
|----------|------|-------------|
|
|
254
|
-
| `testValue` | `string` | Template string to evaluate (e.g., `${args.input}`). |
|
|
255
|
-
| `pattern` | `string` | Regular expression pattern to match against. |
|
|
256
|
-
| `output` | `FunctionResult` | Result to return when the pattern matches. |
|
|
257
|
-
|
|
258
|
-
```typescript
|
|
259
|
-
const tool = new DataMap('classify')
|
|
260
|
-
.parameter('sentiment', 'string', 'User sentiment')
|
|
261
|
-
.expression('${args.sentiment}', '(happy|satisfied|great)', new FunctionResult('Positive sentiment detected.'))
|
|
262
|
-
.expression('${args.sentiment}', '(angry|upset|frustrated)', new FunctionResult('Negative sentiment detected.'))
|
|
263
|
-
.expression('${args.sentiment}', '.*', new FunctionResult('Neutral sentiment.'));
|
|
264
|
-
```
|
|
265
|
-
|
|
266
|
-
---
|
|
267
|
-
|
|
268
|
-
## Response Processing
|
|
269
|
-
|
|
270
|
-
### output
|
|
271
|
-
|
|
272
|
-
Set the output template for successful webhook responses. Template variables like `${response.field}` are expanded from the webhook response JSON.
|
|
273
|
-
|
|
274
|
-
```typescript
|
|
275
|
-
output(result: FunctionResult): this
|
|
276
|
-
```
|
|
277
|
-
|
|
278
|
-
```typescript
|
|
279
|
-
const tool = new DataMap('get_weather')
|
|
280
|
-
.webhook('GET', 'https://api.weather.com/current?q=${args.city}')
|
|
281
|
-
.output(new FunctionResult(
|
|
282
|
-
'The weather in ${args.city} is ${response.temp}F and ${response.condition}.',
|
|
283
|
-
));
|
|
284
|
-
```
|
|
285
|
-
|
|
286
|
-
---
|
|
287
|
-
|
|
288
|
-
### webhookExpressions
|
|
289
|
-
|
|
290
|
-
Add pattern-matching expressions evaluated against the webhook response.
|
|
291
|
-
|
|
292
|
-
```typescript
|
|
293
|
-
webhookExpressions(
|
|
294
|
-
expressions: Array<{ pattern: string; output: FunctionResult }>,
|
|
295
|
-
): this
|
|
296
|
-
```
|
|
297
|
-
|
|
298
|
-
```typescript
|
|
299
|
-
const tool = new DataMap('check_status')
|
|
300
|
-
.webhook('GET', 'https://api.example.com/status/${args.id}')
|
|
301
|
-
.webhookExpressions([
|
|
302
|
-
{
|
|
303
|
-
pattern: 'shipped',
|
|
304
|
-
output: new FunctionResult('Your order has been shipped!'),
|
|
305
|
-
},
|
|
306
|
-
{
|
|
307
|
-
pattern: 'processing',
|
|
308
|
-
output: new FunctionResult('Your order is still being processed.'),
|
|
309
|
-
},
|
|
310
|
-
]);
|
|
311
|
-
```
|
|
312
|
-
|
|
313
|
-
---
|
|
314
|
-
|
|
315
|
-
## Error Handling
|
|
316
|
-
|
|
317
|
-
### fallbackOutput
|
|
318
|
-
|
|
319
|
-
Set the output to return when all webhooks fail or return errors.
|
|
320
|
-
|
|
321
|
-
```typescript
|
|
322
|
-
fallbackOutput(result: FunctionResult): this
|
|
323
|
-
```
|
|
324
|
-
|
|
325
|
-
```typescript
|
|
326
|
-
const tool = new DataMap('lookup')
|
|
327
|
-
.webhook('GET', 'https://api.example.com/data/${args.id}')
|
|
328
|
-
.output(new FunctionResult('Result: ${response.value}'))
|
|
329
|
-
.fallbackOutput(new FunctionResult('Sorry, I could not look that up right now.'));
|
|
330
|
-
```
|
|
331
|
-
|
|
332
|
-
---
|
|
333
|
-
|
|
334
|
-
### errorKeys
|
|
335
|
-
|
|
336
|
-
Specify keys in the response that indicate an error condition. If any of these keys are present and truthy, the fallback output is used.
|
|
337
|
-
|
|
338
|
-
```typescript
|
|
339
|
-
errorKeys(keys: string[]): this
|
|
340
|
-
```
|
|
341
|
-
|
|
342
|
-
```typescript
|
|
343
|
-
const tool = new DataMap('api_call')
|
|
344
|
-
.webhook('GET', 'https://api.example.com/data')
|
|
345
|
-
.errorKeys(['error', 'err_msg'])
|
|
346
|
-
.output(new FunctionResult('${response.data}'))
|
|
347
|
-
.fallbackOutput(new FunctionResult('API returned an error.'));
|
|
348
|
-
```
|
|
349
|
-
|
|
350
|
-
---
|
|
351
|
-
|
|
352
|
-
### globalErrorKeys
|
|
353
|
-
|
|
354
|
-
Specify global error keys checked across all webhook responses.
|
|
355
|
-
|
|
356
|
-
```typescript
|
|
357
|
-
globalErrorKeys(keys: string[]): this
|
|
358
|
-
```
|
|
359
|
-
|
|
360
|
-
---
|
|
361
|
-
|
|
362
|
-
## Iteration
|
|
363
|
-
|
|
364
|
-
### foreach
|
|
365
|
-
|
|
366
|
-
Iterate over an array in the webhook response and format each element.
|
|
367
|
-
|
|
368
|
-
```typescript
|
|
369
|
-
foreach(arrayPath: string, template: string): this
|
|
370
|
-
```
|
|
371
|
-
|
|
372
|
-
| Argument | Type | Description |
|
|
373
|
-
|----------|------|-------------|
|
|
374
|
-
| `arrayPath` | `string` | Dot-path to the array in the response (e.g., `response.items`). |
|
|
375
|
-
| `template` | `string` | Template string applied to each element. |
|
|
376
|
-
|
|
377
|
-
```typescript
|
|
378
|
-
const tool = new DataMap('list_orders')
|
|
379
|
-
.webhook('GET', 'https://api.example.com/orders?customer=${args.customer_id}')
|
|
380
|
-
.foreach('response.orders', 'Order ${this.id}: ${this.status} - $${this.total}')
|
|
381
|
-
.output(new FunctionResult('Your orders: ${foreach_output}'));
|
|
382
|
-
```
|
|
383
|
-
|
|
384
|
-
---
|
|
385
|
-
|
|
386
|
-
## Environment Variables
|
|
387
|
-
|
|
388
|
-
### enableEnvExpansion
|
|
389
|
-
|
|
390
|
-
Enable `${ENV.VAR_NAME}` expansion in template strings. This allows webhook URLs, headers, and body templates to reference server-side environment variables that are expanded at SWML rendering time.
|
|
391
|
-
|
|
392
|
-
```typescript
|
|
393
|
-
enableEnvExpansion(): this
|
|
394
|
-
```
|
|
395
|
-
|
|
396
|
-
```typescript
|
|
397
|
-
const tool = new DataMap('secure_api')
|
|
398
|
-
.webhook('GET', 'https://api.example.com/data', {
|
|
399
|
-
headers: { 'Authorization': 'Bearer ${ENV.API_KEY}' },
|
|
400
|
-
})
|
|
401
|
-
.enableEnvExpansion();
|
|
402
|
-
```
|
|
403
|
-
|
|
404
|
-
**Security:** Use `setAllowedEnvPrefixes()` to restrict which environment variable prefixes can be expanded:
|
|
405
|
-
|
|
406
|
-
```typescript
|
|
407
|
-
import { setAllowedEnvPrefixes } from '@signalwire/sdk';
|
|
408
|
-
|
|
409
|
-
// Only allow env vars starting with MY_APP_ or API_
|
|
410
|
-
setAllowedEnvPrefixes(['MY_APP_', 'API_']);
|
|
411
|
-
```
|
|
412
|
-
|
|
413
|
-
---
|
|
414
|
-
|
|
415
|
-
## Registration
|
|
416
|
-
|
|
417
|
-
### registerWithAgent
|
|
418
|
-
|
|
419
|
-
Register this DataMap tool with an `AgentBase` instance. The tool is serialized as a raw dictionary in the agent's tool registry.
|
|
420
|
-
|
|
421
|
-
```typescript
|
|
422
|
-
registerWithAgent(agent: AgentBase): void
|
|
423
|
-
```
|
|
424
|
-
|
|
425
|
-
```typescript
|
|
426
|
-
const tool = new DataMap('get_weather')
|
|
427
|
-
.purpose('Look up weather')
|
|
428
|
-
.parameter('city', 'string', 'City name')
|
|
429
|
-
.webhook('GET', 'https://api.weather.com/current?q=${args.city}')
|
|
430
|
-
.output(new FunctionResult('${response.temp}F'));
|
|
431
|
-
|
|
432
|
-
tool.registerWithAgent(agent);
|
|
433
|
-
```
|
|
434
|
-
|
|
435
|
-
---
|
|
436
|
-
|
|
437
|
-
### toSwaigFunction
|
|
438
|
-
|
|
439
|
-
Serialize the DataMap to the SWAIG wire format as a plain object. This is called internally by `registerWithAgent()` but can be used directly for custom registration.
|
|
440
|
-
|
|
441
|
-
```typescript
|
|
442
|
-
toSwaigFunction(): Record<string, unknown>
|
|
443
|
-
```
|
|
444
|
-
|
|
445
|
-
```typescript
|
|
446
|
-
const rawDef = tool.toSwaigFunction();
|
|
447
|
-
agent.registerSwaigFunction(rawDef);
|
|
448
|
-
```
|
|
449
|
-
|
|
450
|
-
---
|
|
451
|
-
|
|
452
|
-
## Helper Functions
|
|
453
|
-
|
|
454
|
-
### createSimpleApiTool
|
|
455
|
-
|
|
456
|
-
Create a DataMap tool that makes a single GET request and formats the response.
|
|
457
|
-
|
|
458
|
-
```typescript
|
|
459
|
-
import { createSimpleApiTool } from '@signalwire/sdk';
|
|
460
|
-
|
|
461
|
-
const tool = createSimpleApiTool({
|
|
462
|
-
name: 'get_joke',
|
|
463
|
-
description: 'Get a random joke',
|
|
464
|
-
url: 'https://api.example.com/joke',
|
|
465
|
-
responseTemplate: 'Here is a joke: ${joke}',
|
|
466
|
-
fallbackTemplate: 'Sorry, I could not find a joke.',
|
|
467
|
-
parameters: {
|
|
468
|
-
category: { type: 'string', description: 'Joke category' },
|
|
469
|
-
},
|
|
470
|
-
});
|
|
471
|
-
tool.registerWithAgent(agent);
|
|
472
|
-
```
|
|
473
|
-
|
|
474
|
-
---
|
|
475
|
-
|
|
476
|
-
### createExpressionTool
|
|
477
|
-
|
|
478
|
-
Create a DataMap tool that evaluates expressions without making any HTTP calls.
|
|
479
|
-
|
|
480
|
-
```typescript
|
|
481
|
-
import { createExpressionTool, FunctionResult } from '@signalwire/sdk';
|
|
482
|
-
|
|
483
|
-
const tool = createExpressionTool({
|
|
484
|
-
name: 'classify_priority',
|
|
485
|
-
description: 'Classify ticket priority',
|
|
486
|
-
testValue: '${args.description}',
|
|
487
|
-
parameters: {
|
|
488
|
-
description: { type: 'string', description: 'Issue description' },
|
|
489
|
-
},
|
|
490
|
-
expressions: [
|
|
491
|
-
{
|
|
492
|
-
pattern: '(crash|down|outage|emergency)',
|
|
493
|
-
output: new FunctionResult('Critical priority. Escalating immediately.'),
|
|
494
|
-
},
|
|
495
|
-
{
|
|
496
|
-
pattern: '(slow|delay|lag)',
|
|
497
|
-
output: new FunctionResult('Medium priority.'),
|
|
498
|
-
},
|
|
499
|
-
{
|
|
500
|
-
pattern: '.*',
|
|
501
|
-
output: new FunctionResult('Low priority.'),
|
|
502
|
-
},
|
|
503
|
-
],
|
|
504
|
-
});
|
|
505
|
-
tool.registerWithAgent(agent);
|
|
506
|
-
```
|
|
507
|
-
|
|
508
|
-
---
|
|
509
|
-
|
|
510
|
-
## Template Variables Reference
|
|
511
|
-
|
|
512
|
-
Template variables use `${...}` syntax and are expanded by the SignalWire platform at execution time.
|
|
513
|
-
|
|
514
|
-
| Variable | Description | Example |
|
|
515
|
-
|----------|-------------|---------|
|
|
516
|
-
| `${args.name}` | Tool argument value | `${args.city}` |
|
|
517
|
-
| `${lc:args.name}` | Lowercase argument | `${lc:args.city}` |
|
|
518
|
-
| `${uc:args.name}` | Uppercase argument | `${uc:args.city}` |
|
|
519
|
-
| `${response.field}` | Webhook response field | `${response.temp}` |
|
|
520
|
-
| `${response.array[0].field}` | Array element access | `${response.results[0].name}` |
|
|
521
|
-
| `${meta_data.field}` | Call metadata | `${meta_data.call_id}` |
|
|
522
|
-
| `${ENV.VAR}` | Environment variable (requires `enableEnvExpansion()`) | `${ENV.API_KEY}` |
|
|
523
|
-
| `${foreach_output}` | Concatenated foreach results | `${foreach_output}` |
|
|
524
|
-
| `${this.field}` | Current element in foreach | `${this.name}` |
|
|
525
|
-
|
|
526
|
-
---
|
|
527
|
-
|
|
528
|
-
## Complete Examples
|
|
529
|
-
|
|
530
|
-
### Weather Lookup API
|
|
531
|
-
|
|
532
|
-
```typescript
|
|
533
|
-
import { DataMap, FunctionResult } from '@signalwire/sdk';
|
|
534
|
-
|
|
535
|
-
const weather = new DataMap('get_weather')
|
|
536
|
-
.purpose('Get the current weather for any city')
|
|
537
|
-
.parameter('city', 'string', 'The city to look up', { required: true })
|
|
538
|
-
.parameter('units', 'string', 'Temperature units', { enum: ['fahrenheit', 'celsius'] })
|
|
539
|
-
.webhook('GET', 'https://api.weatherapi.com/v1/current.json?key=${ENV.WEATHER_API_KEY}&q=${args.city}')
|
|
540
|
-
.output(new FunctionResult(
|
|
541
|
-
'The weather in ${args.city} is ${response.current.temp_f}F (${response.current.condition.text}).',
|
|
542
|
-
))
|
|
543
|
-
.fallbackOutput(new FunctionResult('Sorry, I could not retrieve the weather data.'))
|
|
544
|
-
.enableEnvExpansion();
|
|
545
|
-
|
|
546
|
-
weather.registerWithAgent(agent);
|
|
547
|
-
```
|
|
548
|
-
|
|
549
|
-
### Order Status Checker
|
|
550
|
-
|
|
551
|
-
```typescript
|
|
552
|
-
const orderStatus = new DataMap('check_order')
|
|
553
|
-
.purpose('Check the status of a customer order')
|
|
554
|
-
.parameter('order_id', 'string', 'Order number', { required: true })
|
|
555
|
-
.webhook('GET', 'https://api.example.com/orders/${args.order_id}', {
|
|
556
|
-
headers: { 'Authorization': 'Bearer ${ENV.ORDERS_API_KEY}' },
|
|
557
|
-
})
|
|
558
|
-
.errorKeys(['error', 'not_found'])
|
|
559
|
-
.output(new FunctionResult(
|
|
560
|
-
'Order ${args.order_id}: Status is ${response.status}. ' +
|
|
561
|
-
'Estimated delivery: ${response.delivery_date}.',
|
|
562
|
-
))
|
|
563
|
-
.fallbackOutput(new FunctionResult('I could not find that order. Please verify the order number.'))
|
|
564
|
-
.enableEnvExpansion();
|
|
565
|
-
|
|
566
|
-
orderStatus.registerWithAgent(agent);
|
|
567
|
-
```
|
|
568
|
-
|
|
569
|
-
### Expression-Based Routing
|
|
570
|
-
|
|
571
|
-
```typescript
|
|
572
|
-
const router = new DataMap('route_department')
|
|
573
|
-
.purpose('Determine which department to route to')
|
|
574
|
-
.parameter('issue', 'string', 'Description of the issue', { required: true })
|
|
575
|
-
.expression('${args.issue}', '(bill|charge|payment|invoice)', new FunctionResult('Route to billing department.'))
|
|
576
|
-
.expression('${args.issue}', '(bug|error|crash|broken)', new FunctionResult('Route to technical support.'))
|
|
577
|
-
.expression('${args.issue}', '(cancel|return|refund)', new FunctionResult('Route to customer retention.'))
|
|
578
|
-
.expression('${args.issue}', '.*', new FunctionResult('Route to general support.'));
|
|
579
|
-
|
|
580
|
-
router.registerWithAgent(agent);
|
|
581
|
-
```
|
|
582
|
-
|
|
583
|
-
### List Processing with Foreach
|
|
584
|
-
|
|
585
|
-
```typescript
|
|
586
|
-
const listOrders = new DataMap('list_recent_orders')
|
|
587
|
-
.purpose('List recent orders for a customer')
|
|
588
|
-
.parameter('customer_id', 'string', 'Customer ID', { required: true })
|
|
589
|
-
.webhook('GET', 'https://api.example.com/customers/${args.customer_id}/orders?limit=5')
|
|
590
|
-
.foreach('response.orders', '- Order #${this.id}: ${this.status} ($${this.total})')
|
|
591
|
-
.output(new FunctionResult('Recent orders:\n${foreach_output}'))
|
|
592
|
-
.fallbackOutput(new FunctionResult('No orders found for this customer.'));
|
|
593
|
-
|
|
594
|
-
listOrders.registerWithAgent(agent);
|
|
595
|
-
```
|