@signalwire/sdk 2.0.4 → 3.5.0
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/CHANGELOG.md +785 -0
- package/LICENSE +21 -0
- package/README.md +163 -68
- package/dist/AGENTS.md +13 -0
- package/dist/AgentBase.d.ts +550 -163
- package/dist/AgentBase.js +1640 -514
- package/dist/AgentBase.js.map +1 -1
- package/dist/AgentServer.d.ts +21 -0
- package/dist/AgentServer.js +154 -47
- package/dist/AgentServer.js.map +1 -1
- package/dist/AuthHandler.d.ts +14 -2
- package/dist/AuthHandler.js +7 -2
- package/dist/AuthHandler.js.map +1 -1
- package/dist/ConfigLoader.d.ts +5 -13
- package/dist/ConfigLoader.js +15 -29
- package/dist/ConfigLoader.js.map +1 -1
- package/dist/ContextBuilder.d.ts +202 -9
- package/dist/ContextBuilder.js +219 -36
- package/dist/ContextBuilder.js.map +1 -1
- package/dist/DataMap.d.ts +158 -45
- package/dist/DataMap.js +167 -52
- package/dist/DataMap.js.map +1 -1
- package/dist/FunctionResult.d.ts +277 -83
- package/dist/FunctionResult.js +444 -116
- package/dist/FunctionResult.js.map +1 -1
- package/dist/Logger.d.ts +30 -5
- package/dist/Logger.js +77 -19
- package/dist/Logger.js.map +1 -1
- package/dist/POM/PromptObjectModel.d.ts +163 -0
- package/dist/POM/PromptObjectModel.js +481 -0
- package/dist/POM/PromptObjectModel.js.map +1 -0
- package/dist/ParameterSchema.d.ts +306 -0
- package/dist/ParameterSchema.js +251 -0
- package/dist/ParameterSchema.js.map +1 -0
- package/dist/PlatformContracts.d.ts +21 -0
- package/dist/PlatformContracts.generated.d.ts +109 -0
- package/dist/PlatformContracts.generated.js +8 -0
- package/dist/PlatformContracts.generated.js.map +1 -0
- package/dist/PlatformContracts.js +2 -0
- package/dist/PlatformContracts.js.map +1 -0
- package/dist/PomBuilder.d.ts +28 -0
- package/dist/PomBuilder.js +81 -3
- package/dist/PomBuilder.js.map +1 -1
- package/dist/PostPrompt.d.ts +110 -0
- package/dist/PostPrompt.js +204 -0
- package/dist/PostPrompt.js.map +1 -0
- package/dist/PromptManager.d.ts +29 -1
- package/dist/PromptManager.js +37 -1
- package/dist/PromptManager.js.map +1 -1
- package/dist/PublicFetch.d.ts +132 -0
- package/dist/PublicFetch.js +311 -0
- package/dist/PublicFetch.js.map +1 -0
- package/dist/RobotsTxt.d.ts +41 -0
- package/dist/RobotsTxt.js +152 -0
- package/dist/RobotsTxt.js.map +1 -0
- package/dist/SWMLHandler.js.map +1 -1
- package/dist/SWMLService.d.ts +265 -66
- package/dist/SWMLService.js +652 -112
- package/dist/SWMLService.js.map +1 -1
- package/dist/SchemaUtils.d.ts +115 -2
- package/dist/SchemaUtils.js +444 -12
- package/dist/SchemaUtils.js.map +1 -1
- package/dist/SecurityUtils.d.ts +55 -8
- package/dist/SecurityUtils.js +162 -49
- package/dist/SecurityUtils.js.map +1 -1
- package/dist/ServerlessAdapter.d.ts +156 -7
- package/dist/ServerlessAdapter.js +399 -42
- package/dist/ServerlessAdapter.js.map +1 -1
- package/dist/SessionManager.d.ts +11 -2
- package/dist/SessionManager.js +50 -18
- package/dist/SessionManager.js.map +1 -1
- package/dist/SslConfig.d.ts +2 -1
- package/dist/SslConfig.js +4 -1
- package/dist/SslConfig.js.map +1 -1
- package/dist/SwaigActions.generated.d.ts +23 -0
- package/dist/SwaigActions.generated.js +8 -0
- package/dist/SwaigActions.generated.js.map +1 -0
- package/dist/SwaigContracts.d.ts +15 -0
- package/dist/SwaigContracts.generated.d.ts +264 -0
- package/dist/SwaigContracts.generated.js +12 -0
- package/dist/SwaigContracts.generated.js.map +1 -0
- package/dist/SwaigContracts.js +2 -0
- package/dist/SwaigContracts.js.map +1 -0
- package/dist/SwaigFunction.d.ts +110 -4
- package/dist/SwaigFunction.js +151 -19
- package/dist/SwaigFunction.js.map +1 -1
- package/dist/SwmlBuilder.d.ts +68 -19
- package/dist/SwmlBuilder.js +74 -38
- package/dist/SwmlBuilder.js.map +1 -1
- package/dist/SwmlVerbMethods.generated.d.ts +41 -4
- package/dist/SwmlVerbMethods.generated.js +1 -1
- package/dist/TypeInference.d.ts +39 -3
- package/dist/TypeInference.js +256 -16
- package/dist/TypeInference.js.map +1 -1
- package/dist/WebService.d.ts +79 -11
- package/dist/WebService.js +320 -109
- package/dist/WebService.js.map +1 -1
- package/dist/WebhookMiddleware.d.ts +119 -0
- package/dist/WebhookMiddleware.js +271 -0
- package/dist/WebhookMiddleware.js.map +1 -0
- package/dist/WebhookValidator.d.ts +92 -0
- package/dist/WebhookValidator.js +409 -0
- package/dist/WebhookValidator.js.map +1 -0
- package/dist/agents/BedrockAgent.d.ts +162 -0
- package/dist/agents/BedrockAgent.js +323 -0
- package/dist/agents/BedrockAgent.js.map +1 -0
- package/dist/ai-chat/AIChatClient.d.ts +316 -0
- package/dist/ai-chat/AIChatClient.js +535 -0
- package/dist/ai-chat/AIChatClient.js.map +1 -0
- package/dist/ai-chat/ChatGateway.d.ts +408 -0
- package/dist/ai-chat/ChatGateway.js +747 -0
- package/dist/ai-chat/ChatGateway.js.map +1 -0
- package/dist/ai-chat/HandoffRouter.d.ts +282 -0
- package/dist/ai-chat/HandoffRouter.js +518 -0
- package/dist/ai-chat/HandoffRouter.js.map +1 -0
- package/dist/ai-chat/index.d.ts +12 -0
- package/dist/ai-chat/index.js +10 -0
- package/dist/ai-chat/index.js.map +1 -0
- package/dist/capabilities.d.ts +64 -0
- package/dist/capabilities.js +95 -0
- package/dist/capabilities.js.map +1 -0
- package/dist/cli/agent-loader.d.ts +32 -6
- package/dist/cli/agent-loader.js +95 -34
- package/dist/cli/agent-loader.js.map +1 -1
- package/dist/cli/datamap-exec.d.ts +175 -0
- package/dist/cli/datamap-exec.js +1284 -0
- package/dist/cli/datamap-exec.js.map +1 -0
- package/dist/cli/function-args.d.ts +40 -0
- package/dist/cli/function-args.js +146 -0
- package/dist/cli/function-args.js.map +1 -0
- package/dist/cli/simulation.d.ts +99 -0
- package/dist/cli/simulation.js +490 -0
- package/dist/cli/simulation.js.map +1 -0
- package/dist/cli/swaig-test.d.ts +12 -25
- package/dist/cli/swaig-test.js +935 -367
- package/dist/cli/swaig-test.js.map +1 -1
- package/dist/cli/tsdocs/agentsNote.d.ts +30 -0
- package/dist/cli/tsdocs/agentsNote.js +92 -0
- package/dist/cli/tsdocs/agentsNote.js.map +1 -0
- package/dist/cli/tsdocs/api-index.json +1 -0
- package/dist/cli/tsdocs/api.d.ts +91 -0
- package/dist/cli/tsdocs/api.js +372 -0
- package/dist/cli/tsdocs/api.js.map +1 -0
- package/dist/cli/tsdocs/apiTypes.d.ts +64 -0
- package/dist/cli/tsdocs/apiTypes.js +7 -0
- package/dist/cli/tsdocs/apiTypes.js.map +1 -0
- package/dist/cli/tsdocs/bin.d.ts +6 -0
- package/dist/cli/tsdocs/bin.js +23 -0
- package/dist/cli/tsdocs/bin.js.map +1 -0
- package/dist/cli/tsdocs/files.d.ts +108 -0
- package/dist/cli/tsdocs/files.js +287 -0
- package/dist/cli/tsdocs/files.js.map +1 -0
- package/dist/cli/tsdocs/index.d.ts +28 -0
- package/dist/cli/tsdocs/index.js +307 -0
- package/dist/cli/tsdocs/index.js.map +1 -0
- package/dist/cli/tsdocs/live.d.ts +41 -0
- package/dist/cli/tsdocs/live.js +202 -0
- package/dist/cli/tsdocs/live.js.map +1 -0
- package/dist/cli/tsdocs/locate.d.ts +51 -0
- package/dist/cli/tsdocs/locate.js +75 -0
- package/dist/cli/tsdocs/locate.js.map +1 -0
- package/dist/cli/tsdocs/render.d.ts +75 -0
- package/dist/cli/tsdocs/render.js +323 -0
- package/dist/cli/tsdocs/render.js.map +1 -0
- package/dist/cli/tsdocs/topics.d.ts +43 -0
- package/dist/cli/tsdocs/topics.js +916 -0
- package/dist/cli/tsdocs/topics.js.map +1 -0
- package/dist/index.d.ts +102 -39
- package/dist/index.js +107 -30
- package/dist/index.js.map +1 -1
- package/dist/livewire/index.d.ts +229 -155
- package/dist/livewire/index.js +298 -195
- package/dist/livewire/index.js.map +1 -1
- package/dist/llms.txt +65 -0
- package/dist/prefabs/CallSessionStore.d.ts +52 -0
- package/dist/prefabs/CallSessionStore.js +72 -0
- package/dist/prefabs/CallSessionStore.js.map +1 -0
- package/dist/prefabs/ConciergeAgent.d.ts +13 -1
- package/dist/prefabs/ConciergeAgent.js +36 -31
- package/dist/prefabs/ConciergeAgent.js.map +1 -1
- package/dist/prefabs/FAQBotAgent.d.ts +9 -1
- package/dist/prefabs/FAQBotAgent.js +113 -47
- package/dist/prefabs/FAQBotAgent.js.map +1 -1
- package/dist/prefabs/InfoGathererAgent.d.ts +22 -3
- package/dist/prefabs/InfoGathererAgent.js +67 -58
- package/dist/prefabs/InfoGathererAgent.js.map +1 -1
- package/dist/prefabs/ReceptionistAgent.d.ts +16 -5
- package/dist/prefabs/ReceptionistAgent.js +39 -31
- package/dist/prefabs/ReceptionistAgent.js.map +1 -1
- package/dist/prefabs/SurveyAgent.d.ts +22 -4
- package/dist/prefabs/SurveyAgent.js +84 -68
- package/dist/prefabs/SurveyAgent.js.map +1 -1
- package/dist/relay/Action.d.ts +44 -21
- package/dist/relay/Action.js +75 -17
- package/dist/relay/Action.js.map +1 -1
- package/dist/relay/Call.d.ts +312 -47
- package/dist/relay/Call.js +369 -18
- package/dist/relay/Call.js.map +1 -1
- package/dist/relay/Deferred.js.map +1 -1
- package/dist/relay/Message.d.ts +26 -5
- package/dist/relay/Message.js +36 -6
- package/dist/relay/Message.js.map +1 -1
- package/dist/relay/RelayClient.d.ts +79 -14
- package/dist/relay/RelayClient.js +268 -61
- package/dist/relay/RelayClient.js.map +1 -1
- package/dist/relay/RelayError.d.ts +14 -0
- package/dist/relay/RelayError.js +15 -0
- package/dist/relay/RelayError.js.map +1 -1
- package/dist/relay/RelayEvent.d.ts +96 -65
- package/dist/relay/RelayEvent.js +85 -56
- package/dist/relay/RelayEvent.js.map +1 -1
- package/dist/relay/closedSets.d.ts +111 -0
- package/dist/relay/closedSets.js +83 -0
- package/dist/relay/closedSets.js.map +1 -0
- package/dist/relay/index.d.ts +3 -1
- package/dist/relay/index.js +1 -0
- package/dist/relay/index.js.map +1 -1
- package/dist/relay/normalize.js.map +1 -1
- package/dist/relay/protocol.types.generated.d.ts +1195 -0
- package/dist/relay/protocol.types.generated.js +8 -0
- package/dist/relay/protocol.types.generated.js.map +1 -0
- package/dist/relay/types.d.ts +81 -39
- package/dist/rest/HttpClient.d.ts +36 -8
- package/dist/rest/HttpClient.js +233 -40
- package/dist/rest/HttpClient.js.map +1 -1
- package/dist/rest/RequestOptions.d.ts +110 -0
- package/dist/rest/RequestOptions.js +113 -0
- package/dist/rest/RequestOptions.js.map +1 -0
- package/dist/rest/RestError.d.ts +52 -6
- package/dist/rest/RestError.js +89 -5
- package/dist/rest/RestError.js.map +1 -1
- package/dist/rest/base/CrudResource.d.ts +16 -26
- package/dist/rest/base/CrudResource.js +19 -33
- package/dist/rest/base/CrudResource.js.map +1 -1
- package/dist/rest/base/CrudWithAddresses.d.ts +3 -2
- package/dist/rest/base/CrudWithAddresses.js +2 -2
- package/dist/rest/base/CrudWithAddresses.js.map +1 -1
- package/dist/rest/base/FabricResource.d.ts +15 -0
- package/dist/rest/base/FabricResource.js +16 -0
- package/dist/rest/base/FabricResource.js.map +1 -0
- package/dist/rest/base/ReadResource.d.ts +62 -0
- package/dist/rest/base/ReadResource.js +69 -0
- package/dist/rest/base/ReadResource.js.map +1 -0
- package/dist/rest/callHandler.d.ts +63 -0
- package/dist/rest/callHandler.js +62 -0
- package/dist/rest/callHandler.js.map +1 -0
- package/dist/rest/index.d.ts +19 -76
- package/dist/rest/index.js +49 -120
- package/dist/rest/index.js.map +1 -1
- package/dist/rest/namespaces/_client_tree_generated.d.ts +103 -0
- package/dist/rest/namespaces/_client_tree_generated.js +171 -0
- package/dist/rest/namespaces/_client_tree_generated.js.map +1 -0
- package/dist/rest/namespaces/addresses.d.ts +3 -42
- package/dist/rest/namespaces/addresses.js +3 -50
- package/dist/rest/namespaces/addresses.js.map +1 -1
- package/dist/rest/namespaces/calling.d.ts +6 -378
- package/dist/rest/namespaces/calling.js +6 -473
- package/dist/rest/namespaces/calling.js.map +1 -1
- package/dist/rest/namespaces/calling.resources.generated.d.ts +165 -0
- package/dist/rest/namespaces/calling.resources.generated.js +477 -0
- package/dist/rest/namespaces/calling.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/calling.types.generated.d.ts +2917 -0
- package/dist/rest/namespaces/calling.types.generated.js +8 -0
- package/dist/rest/namespaces/calling.types.generated.js.map +1 -0
- package/dist/rest/namespaces/chat.d.ts +4 -18
- package/dist/rest/namespaces/chat.js +4 -21
- package/dist/rest/namespaces/chat.js.map +1 -1
- package/dist/rest/namespaces/chat.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/chat.resources.generated.js +29 -0
- package/dist/rest/namespaces/chat.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/chat.types.generated.d.ts +56 -0
- package/dist/rest/namespaces/chat.types.generated.js +8 -0
- package/dist/rest/namespaces/chat.types.generated.js.map +1 -0
- package/dist/rest/namespaces/datasphere.d.ts +6 -62
- package/dist/rest/namespaces/datasphere.js +6 -72
- package/dist/rest/namespaces/datasphere.js.map +1 -1
- package/dist/rest/namespaces/datasphere.resources.generated.d.ts +25 -0
- package/dist/rest/namespaces/datasphere.resources.generated.js +50 -0
- package/dist/rest/namespaces/datasphere.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/datasphere.types.generated.d.ts +180 -0
- package/dist/rest/namespaces/datasphere.types.generated.js +8 -0
- package/dist/rest/namespaces/datasphere.types.generated.js.map +1 -0
- package/dist/rest/namespaces/fabric.d.ts +11 -273
- package/dist/rest/namespaces/fabric.js +14 -363
- package/dist/rest/namespaces/fabric.js.map +1 -1
- package/dist/rest/namespaces/fabric.resources.generated.d.ts +195 -0
- package/dist/rest/namespaces/fabric.resources.generated.js +399 -0
- package/dist/rest/namespaces/fabric.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/fabric.types.generated.d.ts +4557 -0
- package/dist/rest/namespaces/fabric.types.generated.js +8 -0
- package/dist/rest/namespaces/fabric.types.generated.js.map +1 -0
- package/dist/rest/namespaces/fax.resources.generated.d.ts +6 -0
- package/dist/rest/namespaces/fax.resources.generated.js +14 -0
- package/dist/rest/namespaces/fax.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/fax.types.generated.d.ts +131 -0
- package/dist/rest/namespaces/fax.types.generated.js +8 -0
- package/dist/rest/namespaces/fax.types.generated.js.map +1 -0
- package/dist/rest/namespaces/imported-numbers.d.ts +3 -18
- package/dist/rest/namespaces/imported-numbers.js +3 -21
- package/dist/rest/namespaces/imported-numbers.js.map +1 -1
- package/dist/rest/namespaces/logs.d.ts +10 -101
- package/dist/rest/namespaces/logs.js +10 -128
- package/dist/rest/namespaces/logs.js.map +1 -1
- package/dist/rest/namespaces/logs.resources.generated.d.ts +9 -0
- package/dist/rest/namespaces/logs.resources.generated.js +17 -0
- package/dist/rest/namespaces/logs.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/logs.types.generated.d.ts +131 -0
- package/dist/rest/namespaces/logs.types.generated.js +8 -0
- package/dist/rest/namespaces/logs.types.generated.js.map +1 -0
- package/dist/rest/namespaces/lookup.d.ts +3 -25
- package/dist/rest/namespaces/lookup.js +3 -27
- package/dist/rest/namespaces/lookup.js.map +1 -1
- package/dist/rest/namespaces/message.resources.generated.d.ts +6 -0
- package/dist/rest/namespaces/message.resources.generated.js +14 -0
- package/dist/rest/namespaces/message.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/message.types.generated.d.ts +122 -0
- package/dist/rest/namespaces/message.types.generated.js +8 -0
- package/dist/rest/namespaces/message.types.generated.js.map +1 -0
- package/dist/rest/namespaces/messages.resources.generated.d.ts +18 -0
- package/dist/rest/namespaces/messages.resources.generated.js +44 -0
- package/dist/rest/namespaces/messages.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/messages.types.generated.d.ts +99 -0
- package/dist/rest/namespaces/messages.types.generated.js +8 -0
- package/dist/rest/namespaces/messages.types.generated.js.map +1 -0
- package/dist/rest/namespaces/mfa.d.ts +3 -42
- package/dist/rest/namespaces/mfa.js +3 -49
- package/dist/rest/namespaces/mfa.js.map +1 -1
- package/dist/rest/namespaces/number-groups.d.ts +3 -45
- package/dist/rest/namespaces/number-groups.js +3 -53
- package/dist/rest/namespaces/number-groups.js.map +1 -1
- package/dist/rest/namespaces/phone-numbers.d.ts +9 -57
- package/dist/rest/namespaces/phone-numbers.js +9 -63
- package/dist/rest/namespaces/phone-numbers.js.map +1 -1
- package/dist/rest/namespaces/project.d.ts +6 -42
- package/dist/rest/namespaces/project.js +6 -51
- package/dist/rest/namespaces/project.js.map +1 -1
- package/dist/rest/namespaces/project.resources.generated.d.ts +17 -0
- package/dist/rest/namespaces/project.resources.generated.js +44 -0
- package/dist/rest/namespaces/project.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/project.types.generated.d.ts +58 -0
- package/dist/rest/namespaces/project.types.generated.js +8 -0
- package/dist/rest/namespaces/project.types.generated.js.map +1 -0
- package/dist/rest/namespaces/projects.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/projects.resources.generated.js +25 -0
- package/dist/rest/namespaces/projects.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/projects.types.generated.d.ts +77 -0
- package/dist/rest/namespaces/projects.types.generated.js +8 -0
- package/dist/rest/namespaces/projects.types.generated.js.map +1 -0
- package/dist/rest/namespaces/pubsub.d.ts +4 -18
- package/dist/rest/namespaces/pubsub.js +4 -21
- package/dist/rest/namespaces/pubsub.js.map +1 -1
- package/dist/rest/namespaces/pubsub.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/pubsub.resources.generated.js +29 -0
- package/dist/rest/namespaces/pubsub.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/pubsub.types.generated.d.ts +60 -0
- package/dist/rest/namespaces/pubsub.types.generated.js +8 -0
- package/dist/rest/namespaces/pubsub.types.generated.js.map +1 -0
- package/dist/rest/namespaces/queues.d.ts +3 -38
- package/dist/rest/namespaces/queues.js +3 -44
- package/dist/rest/namespaces/queues.js.map +1 -1
- package/dist/rest/namespaces/recordings.d.ts +3 -34
- package/dist/rest/namespaces/recordings.js +3 -40
- package/dist/rest/namespaces/recordings.js.map +1 -1
- package/dist/rest/namespaces/registry.d.ts +6 -137
- package/dist/rest/namespaces/registry.js +6 -173
- package/dist/rest/namespaces/registry.js.map +1 -1
- package/dist/rest/namespaces/relay-rest.resources.generated.d.ts +168 -0
- package/dist/rest/namespaces/relay-rest.resources.generated.js +430 -0
- package/dist/rest/namespaces/relay-rest.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/relay-rest.types.generated.d.ts +1906 -0
- package/dist/rest/namespaces/relay-rest.types.generated.js +8 -0
- package/dist/rest/namespaces/relay-rest.types.generated.js.map +1 -0
- package/dist/rest/namespaces/short-codes.d.ts +3 -35
- package/dist/rest/namespaces/short-codes.js +3 -41
- package/dist/rest/namespaces/short-codes.js.map +1 -1
- package/dist/rest/namespaces/sip-profile.d.ts +3 -24
- package/dist/rest/namespaces/sip-profile.js +3 -29
- package/dist/rest/namespaces/sip-profile.js.map +1 -1
- package/dist/rest/namespaces/verified-callers.d.ts +3 -29
- package/dist/rest/namespaces/verified-callers.js +3 -34
- package/dist/rest/namespaces/verified-callers.js.map +1 -1
- package/dist/rest/namespaces/video.d.ts +10 -227
- package/dist/rest/namespaces/video.js +10 -288
- package/dist/rest/namespaces/video.js.map +1 -1
- package/dist/rest/namespaces/video.resources.generated.d.ts +81 -0
- package/dist/rest/namespaces/video.resources.generated.js +171 -0
- package/dist/rest/namespaces/video.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/video.types.generated.d.ts +771 -0
- package/dist/rest/namespaces/video.types.generated.js +8 -0
- package/dist/rest/namespaces/video.types.generated.js.map +1 -0
- package/dist/rest/namespaces/voice.resources.generated.d.ts +9 -0
- package/dist/rest/namespaces/voice.resources.generated.js +17 -0
- package/dist/rest/namespaces/voice.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/voice.types.generated.d.ts +214 -0
- package/dist/rest/namespaces/voice.types.generated.js +8 -0
- package/dist/rest/namespaces/voice.types.generated.js.map +1 -0
- package/dist/rest/pagination.d.ts +5 -1
- package/dist/rest/pagination.js +40 -20
- package/dist/rest/pagination.js.map +1 -1
- package/dist/rest/types.d.ts +21 -3
- package/dist/schema.json +299 -98
- package/dist/skills/SkillBase.d.ts +97 -20
- package/dist/skills/SkillBase.js +100 -17
- package/dist/skills/SkillBase.js.map +1 -1
- package/dist/skills/SkillManager.d.ts +66 -13
- package/dist/skills/SkillManager.js +101 -20
- package/dist/skills/SkillManager.js.map +1 -1
- package/dist/skills/SkillName.d.ts +44 -0
- package/dist/skills/SkillName.js +2 -0
- package/dist/skills/SkillName.js.map +1 -0
- package/dist/skills/SkillRegistry.d.ts +47 -7
- package/dist/skills/SkillRegistry.js +85 -13
- package/dist/skills/SkillRegistry.js.map +1 -1
- package/dist/skills/builtin/api_ninjas_trivia.d.ts +3 -1
- package/dist/skills/builtin/api_ninjas_trivia.js +24 -8
- package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -1
- package/dist/skills/builtin/ask_claude.d.ts +14 -4
- package/dist/skills/builtin/ask_claude.js +36 -14
- package/dist/skills/builtin/ask_claude.js.map +1 -1
- package/dist/skills/builtin/claude_skills.d.ts +3 -1
- package/dist/skills/builtin/claude_skills.js +19 -15
- package/dist/skills/builtin/claude_skills.js.map +1 -1
- package/dist/skills/builtin/custom_skills.d.ts +10 -3
- package/dist/skills/builtin/custom_skills.js +26 -9
- package/dist/skills/builtin/custom_skills.js.map +1 -1
- package/dist/skills/builtin/datasphere.d.ts +5 -3
- package/dist/skills/builtin/datasphere.js +34 -25
- package/dist/skills/builtin/datasphere.js.map +1 -1
- package/dist/skills/builtin/datasphere_serverless.d.ts +12 -1
- package/dist/skills/builtin/datasphere_serverless.js +17 -6
- package/dist/skills/builtin/datasphere_serverless.js.map +1 -1
- package/dist/skills/builtin/datetime.d.ts +3 -1
- package/dist/skills/builtin/datetime.js +11 -7
- package/dist/skills/builtin/datetime.js.map +1 -1
- package/dist/skills/builtin/google_maps.d.ts +29 -14
- package/dist/skills/builtin/google_maps.js +89 -269
- package/dist/skills/builtin/google_maps.js.map +1 -1
- package/dist/skills/builtin/index.d.ts +8 -6
- package/dist/skills/builtin/index.js +8 -6
- package/dist/skills/builtin/index.js.map +1 -1
- package/dist/skills/builtin/info_gatherer.d.ts +4 -2
- package/dist/skills/builtin/info_gatherer.js +20 -12
- package/dist/skills/builtin/info_gatherer.js.map +1 -1
- package/dist/skills/builtin/joke.d.ts +16 -6
- package/dist/skills/builtin/joke.js +54 -37
- package/dist/skills/builtin/joke.js.map +1 -1
- package/dist/skills/builtin/math.d.ts +3 -1
- package/dist/skills/builtin/math.js +14 -9
- package/dist/skills/builtin/math.js.map +1 -1
- package/dist/skills/builtin/mcp_gateway.d.ts +34 -5
- package/dist/skills/builtin/mcp_gateway.js +77 -46
- package/dist/skills/builtin/mcp_gateway.js.map +1 -1
- package/dist/skills/builtin/native_vector_search.d.ts +19 -5
- package/dist/skills/builtin/native_vector_search.js +179 -61
- package/dist/skills/builtin/native_vector_search.js.map +1 -1
- package/dist/skills/builtin/play_background_file.d.ts +21 -15
- package/dist/skills/builtin/play_background_file.js +43 -122
- package/dist/skills/builtin/play_background_file.js.map +1 -1
- package/dist/skills/builtin/spider.d.ts +46 -1
- package/dist/skills/builtin/spider.js +317 -101
- package/dist/skills/builtin/spider.js.map +1 -1
- package/dist/skills/builtin/swml_transfer.d.ts +14 -3
- package/dist/skills/builtin/swml_transfer.js +45 -24
- package/dist/skills/builtin/swml_transfer.js.map +1 -1
- package/dist/skills/builtin/weather_api.d.ts +24 -13
- package/dist/skills/builtin/weather_api.js +57 -31
- package/dist/skills/builtin/weather_api.js.map +1 -1
- package/dist/skills/builtin/web_search.d.ts +48 -10
- package/dist/skills/builtin/web_search.js +301 -84
- package/dist/skills/builtin/web_search.js.map +1 -1
- package/dist/skills/builtin/wikipedia_search.d.ts +4 -2
- package/dist/skills/builtin/wikipedia_search.js +32 -14
- package/dist/skills/builtin/wikipedia_search.js.map +1 -1
- package/dist/skills/index.d.ts +3 -2
- package/dist/skills/index.js +1 -1
- package/dist/skills/index.js.map +1 -1
- package/dist/swml_verbs_generated.d.ts +2824 -0
- package/dist/swml_verbs_generated.js +12 -0
- package/dist/swml_verbs_generated.js.map +1 -0
- package/dist/types.d.ts +65 -6
- package/dist/web.d.ts +27 -0
- package/dist/web.js +20 -0
- package/dist/web.js.map +1 -0
- package/docs/agent-guide.md +1034 -0
- package/docs/ai_chat.md +560 -0
- package/docs/api-reference.md +3534 -0
- package/docs/architecture.md +846 -0
- package/docs/bedrock_agent.md +411 -0
- package/docs/cli-guide.md +403 -0
- package/docs/cloud_functions_guide.md +399 -0
- package/docs/configuration.md +548 -0
- package/docs/contexts-guide.md +884 -0
- package/docs/datamap-guide.md +1160 -0
- package/docs/developer_pain_points.md +548 -0
- package/docs/llm_parameters.md +298 -0
- package/docs/mcp_gateway_reference.md +354 -0
- package/docs/mcp_integration.md +162 -0
- package/docs/pgi_agent_guide.md +1820 -0
- package/docs/prefabs-guide.md +815 -0
- package/docs/programmatically_governed_inference.md +301 -0
- package/docs/sdk_features.md +501 -0
- package/docs/security.md +559 -0
- package/docs/serverless-guide.md +520 -0
- package/docs/skills-guide.md +1223 -0
- package/docs/skills-system.md +405 -0
- package/docs/skills_parameter_schema.md +417 -0
- package/docs/swaig-reference.md +1938 -0
- package/docs/swml_service_guide.md +573 -0
- package/docs/third_party_skills.md +410 -0
- package/docs/web_service.md +666 -0
- package/examples/README.md +202 -0
- package/examples/advanced-datamap.ts +108 -0
- package/examples/advanced-dynamic-config.ts +70 -0
- package/examples/auto-vivified.ts +95 -0
- package/examples/call-flow.ts +65 -0
- package/examples/comprehensive-dynamic.ts +125 -0
- package/examples/contexts-steps.ts +65 -0
- package/examples/custom-path.ts +45 -0
- package/examples/datamap-tools.ts +51 -0
- package/examples/datasphere-multi-instance.ts +66 -0
- package/examples/datasphere-serverless-env.ts +87 -0
- package/examples/datasphere-webhook-env.ts +65 -0
- package/examples/datasphere.ts +56 -0
- package/examples/declarative.ts +100 -0
- package/examples/dynamic-config.ts +54 -0
- package/examples/dynamic-info-gatherer.ts +69 -0
- package/examples/dynamic-swml-service.ts +67 -0
- package/examples/gather-info.ts +95 -0
- package/examples/gather-per-question-functions-demo.ts +139 -0
- package/examples/joke-agent.ts +34 -0
- package/examples/kubernetes-agent.ts +45 -0
- package/examples/llm-params.ts +75 -0
- package/examples/mcp-agent.ts +89 -0
- package/examples/mcp-gateway.ts +81 -0
- package/examples/multi-agent.ts +80 -0
- package/examples/multi-endpoint.ts +79 -0
- package/examples/pgi/case-domain.ts +114 -0
- package/examples/pgi/serve.ts +16 -0
- package/examples/pgi/support-agent.ts +265 -0
- package/examples/pom-prompt.ts +70 -0
- package/examples/prefab-concierge.ts +42 -0
- package/examples/prefab-faq.ts +58 -0
- package/examples/prefab-info-gatherer.ts +33 -0
- package/examples/prefab-receptionist.ts +36 -0
- package/examples/prefab-survey.ts +69 -0
- package/examples/quickstart-agent.ts +29 -0
- package/examples/quickstart-relay.ts +25 -0
- package/examples/quickstart-rest.ts +25 -0
- package/examples/record-call.ts +65 -0
- package/examples/relay-demo.ts +33 -0
- package/examples/room-and-sip.ts +93 -0
- package/examples/serverless-lambda.ts +43 -0
- package/examples/session-state.ts +83 -0
- package/examples/simple-agent.ts +36 -0
- package/examples/simple-static.ts +29 -0
- package/examples/skills-demo.ts +41 -0
- package/examples/step-function-inheritance-demo.ts +124 -0
- package/examples/swaig-features.ts +193 -0
- package/examples/swml-service-routing.ts +66 -0
- package/examples/swml-service.ts +38 -0
- package/examples/swmlservice_ai_sidecar.ts +104 -0
- package/examples/swmlservice_swaig_standalone.ts +79 -0
- package/examples/tap.ts +67 -0
- package/examples/typed-tools.ts +68 -0
- package/examples/verb-methods.ts +45 -0
- package/examples/web-search-multi-instance.ts +75 -0
- package/examples/web-search.ts +38 -0
- package/examples/wikipedia.ts +36 -0
- package/livewire/README.md +164 -0
- package/livewire/docs/migration-guide.md +251 -0
- package/livewire/examples/livewire-basic-agent.ts +74 -0
- package/livewire/examples/livewire-handoff.ts +196 -0
- package/livewire/examples/livewire-multi-tool.ts +121 -0
- package/package.json +88 -13
- package/relay/README.md +101 -0
- package/relay/docs/call-methods.md +622 -0
- package/relay/docs/client-reference.md +281 -0
- package/relay/docs/events.md +193 -0
- package/relay/docs/getting-started.md +221 -0
- package/relay/docs/guide.md +386 -0
- package/relay/docs/messaging.md +246 -0
- package/relay/examples/relay-inbound.ts +66 -0
- package/relay/examples/relay-messaging.ts +74 -0
- package/relay/examples/relay-outbound.ts +76 -0
- package/rest/README.md +141 -0
- package/rest/docs/calling.md +313 -0
- package/rest/docs/client-reference.md +149 -0
- package/rest/docs/fabric.md +192 -0
- package/rest/docs/getting-started.md +138 -0
- package/rest/docs/guide.md +421 -0
- package/rest/docs/namespaces.md +367 -0
- package/rest/docs/phone-binding.md +116 -0
- package/rest/examples/rest-10dlc-registration.ts +177 -0
- package/rest/examples/rest-bind-phone-to-swml-webhook.ts +66 -0
- package/rest/examples/rest-calling-ivr-and-ai.ts +136 -0
- package/rest/examples/rest-calling-play-and-record.ts +98 -0
- package/rest/examples/rest-client.ts +59 -0
- package/rest/examples/rest-datasphere-search.ts +81 -0
- package/rest/examples/rest-fabric-conferences-and-routing.ts +147 -0
- package/rest/examples/rest-fabric-subscribers-and-sip.ts +106 -0
- package/rest/examples/rest-fabric-swml-and-callflows.ts +101 -0
- package/rest/examples/rest-manage-resources.ts +64 -0
- package/rest/examples/rest-phone-number-management.ts +200 -0
- package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
- package/rest/examples/rest-video-rooms.ts +186 -0
- package/tutorial/fred/fred.ts +218 -0
- package/tutorial/fred/tutorial/01-introduction.md +141 -0
- package/tutorial/fred/tutorial/02-setup.md +304 -0
- package/tutorial/fred/tutorial/03-basic-agent.md +284 -0
- package/tutorial/fred/tutorial/04-wikipedia-skill.md +298 -0
- package/tutorial/fred/tutorial/05-custom-functions.md +347 -0
- package/tutorial/fred/tutorial/06-running-testing.md +642 -0
- package/tutorial/fred/tutorial/README.md +56 -0
- package/tutorial/fred/tutorial/appendix-complete-code.md +632 -0
- package/tutorial/fred/tutorial/appendix-docker-deployment.md +504 -0
- package/tutorial/full-guardrails-agent/handlers.ts +436 -0
- package/tutorial/full-guardrails-agent/penny.ts +305 -0
- package/tutorial/full-guardrails-agent/reservations.ts +1109 -0
- package/tutorial/full-guardrails-agent/tutorial/01-why-guardrails.md +149 -0
- package/tutorial/full-guardrails-agent/tutorial/02-design-first.md +139 -0
- package/tutorial/full-guardrails-agent/tutorial/03-rules-first.md +422 -0
- package/tutorial/full-guardrails-agent/tutorial/04-the-shell.md +238 -0
- package/tutorial/full-guardrails-agent/tutorial/05-steps-and-scoping.md +247 -0
- package/tutorial/full-guardrails-agent/tutorial/06-tools-that-decide.md +467 -0
- package/tutorial/full-guardrails-agent/tutorial/07-gather-and-projection.md +160 -0
- package/tutorial/full-guardrails-agent/tutorial/08-the-verification-gate.md +333 -0
- package/tutorial/full-guardrails-agent/tutorial/09-people-and-endings.md +313 -0
- package/tutorial/full-guardrails-agent/tutorial/10-testing-and-running.md +387 -0
- package/tutorial/full-guardrails-agent/tutorial/README.md +106 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-complete-code.md +2207 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-deployment.md +191 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-technique-map.md +117 -0
- package/tutorial/full-guardrails-agent/workflow.ts +219 -0
- package/tutorial/multi_agents/README.md +175 -0
- package/tutorial/multi_agents/advanced_agent.ts +395 -0
- package/tutorial/multi_agents/extending_agents.ts +641 -0
- package/tutorial/multi_agents/knowledge.ts +59 -0
- package/tutorial/multi_agents/lesson1_first_agent.md +368 -0
- package/tutorial/multi_agents/lesson2_knowledge_bases.md +404 -0
- package/tutorial/multi_agents/lesson3_multi_agent_systems.md +621 -0
- package/tutorial/multi_agents/lesson4_advanced_features.md +805 -0
- package/tutorial/multi_agents/lesson5_extending_agents.md +856 -0
- package/tutorial/multi_agents/pc_builder.ts +529 -0
- package/tutorial/multi_agents/sales_agent.ts +88 -0
- package/tutorial/multi_agents/sales_agent_with_search.ts +116 -0
- package/tutorial/multi_agents/sales_knowledge.md +139 -0
- package/tutorial/multi_agents/support_knowledge.md +256 -0
- package/dist/cli/mock-data.d.ts +0 -37
- package/dist/cli/mock-data.js +0 -80
- package/dist/cli/mock-data.js.map +0 -1
- package/dist/generateVerbTypes.d.ts +0 -11
- package/dist/generateVerbTypes.js +0 -265
- package/dist/generateVerbTypes.js.map +0 -1
- package/dist/rest/namespaces/compat.d.ts +0 -585
- package/dist/rest/namespaces/compat.js +0 -735
- package/dist/rest/namespaces/compat.js.map +0 -1
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 SignalWire
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# SignalWire SDK for TypeScript
|
|
8
8
|
|
|
9
|
-
_Build AI voice agents, control live calls over WebSocket, and manage every SignalWire resource over REST
|
|
9
|
+
_Build AI voice agents, control live calls over WebSocket, and manage every SignalWire resource over REST, all from one package._
|
|
10
10
|
|
|
11
11
|
<p align="center">
|
|
12
12
|
<a href="https://developer.signalwire.com/sdks/agents-sdk" target="_blank">Documentation</a> ·
|
|
@@ -22,24 +22,48 @@ _Build AI voice agents, control live calls over WebSocket, and manage every Sign
|
|
|
22
22
|
|
|
23
23
|
---
|
|
24
24
|
|
|
25
|
+
<!-- snippet-setup -->
|
|
26
|
+
```ts
|
|
27
|
+
export {}; // treat each example as a module (top-level await)
|
|
28
|
+
declare global {
|
|
29
|
+
const callId: string;
|
|
30
|
+
const signingKey: string;
|
|
31
|
+
const signatureHeader: string;
|
|
32
|
+
const fullUrl: string;
|
|
33
|
+
const rawBodyString: string;
|
|
34
|
+
const requestParams: Record<string, string>;
|
|
35
|
+
}
|
|
36
|
+
```
|
|
37
|
+
|
|
25
38
|
## What's in this SDK
|
|
26
39
|
|
|
27
40
|
| Capability | What it does | Quick link |
|
|
28
41
|
|-----------|-------------|------------|
|
|
29
|
-
| **AI Agents** | Build voice agents that handle calls
|
|
30
|
-
| **RELAY Client** | Control live calls and SMS/MMS in real time over WebSocket
|
|
31
|
-
| **REST Client** | Manage SignalWire resources over HTTP
|
|
42
|
+
| **AI Agents** | Build voice agents that handle calls on their own. The platform runs the AI pipeline, and your code defines the persona, tools, and call flow. | [Agent Guide](#ai-agents) |
|
|
43
|
+
| **RELAY Client** | Control live calls and SMS/MMS in real time over WebSocket: answer, play, record, collect DTMF, conference, transfer, and more | [RELAY docs](relay/README.md) |
|
|
44
|
+
| **REST Client** | Manage SignalWire resources over HTTP: phone numbers, SIP endpoints, Fabric AI agents, video rooms, messaging, and the other REST API namespaces | [REST docs](rest/README.md) |
|
|
45
|
+
|
|
46
|
+
Install the SDK from npm:
|
|
32
47
|
|
|
33
48
|
```bash
|
|
34
49
|
npm install @signalwire/sdk
|
|
35
50
|
```
|
|
36
51
|
|
|
52
|
+
The package installs its own documentation. `npx sw-tsdocs` prints a map of the SDK for the installed version, with the docs and examples on disk, and `npx sw-tsdocs api <name>` reads signatures and JSDoc from the installed declarations. If you're a coding agent working with the SDK, start there:
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
npx sw-tsdocs # the map: what the SDK does and where to start
|
|
56
|
+
npx sw-tsdocs agents # one topic: concepts, files to read, examples, API
|
|
57
|
+
npx sw-tsdocs api AgentBase # a signature, JSDoc and members
|
|
58
|
+
```
|
|
59
|
+
|
|
37
60
|
---
|
|
38
61
|
|
|
39
62
|
## AI Agents
|
|
40
63
|
|
|
41
|
-
Each agent is a self-contained microservice that generates [SWML](docs/swml_service_guide.md) (SignalWire Markup Language) and handles [SWAIG](docs/swaig-reference.md) (SignalWire AI Gateway) tool calls. The SignalWire platform runs the entire AI pipeline (STT, LLM, TTS)
|
|
64
|
+
Each agent is a self-contained microservice that generates [SWML](docs/swml_service_guide.md) (SignalWire Markup Language) and handles [SWAIG](docs/swaig-reference.md) (SignalWire AI Gateway) tool calls. The SignalWire platform runs the entire AI pipeline (STT, LLM, TTS), and your agent defines the behavior.
|
|
42
65
|
|
|
66
|
+
<!-- include: examples/quickstart-agent.ts#construct -->
|
|
43
67
|
```typescript
|
|
44
68
|
import { AgentBase, FunctionResult } from '@signalwire/sdk';
|
|
45
69
|
|
|
@@ -61,33 +85,35 @@ agent.defineTool({
|
|
|
61
85
|
agent.run(); // Starts HTTP server on port 3000
|
|
62
86
|
```
|
|
63
87
|
|
|
64
|
-
|
|
88
|
+
In a clone of this repository, `swaig-test` checks an agent without running a server. These commands list the example agent's tools, print its SWML, and call its `get_time` tool:
|
|
65
89
|
|
|
66
90
|
```bash
|
|
67
|
-
swaig-test examples/simple-agent.ts --list-tools
|
|
68
|
-
swaig-test examples/simple-agent.ts --dump-swml
|
|
69
|
-
swaig-test examples/simple-agent.ts --exec get_time
|
|
91
|
+
npx tsx src/cli/swaig-test.ts examples/simple-agent.ts --list-tools
|
|
92
|
+
npx tsx src/cli/swaig-test.ts examples/simple-agent.ts --dump-swml
|
|
93
|
+
npx tsx src/cli/swaig-test.ts examples/simple-agent.ts --exec get_time
|
|
70
94
|
```
|
|
71
95
|
|
|
72
96
|
### Agent Features
|
|
73
97
|
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
- **
|
|
77
|
-
- **
|
|
78
|
-
- **
|
|
79
|
-
- **
|
|
80
|
-
- **
|
|
81
|
-
- **
|
|
82
|
-
- **
|
|
83
|
-
- **
|
|
84
|
-
- **
|
|
85
|
-
- **
|
|
86
|
-
- **
|
|
98
|
+
An agent built on `AgentBase` gets these features:
|
|
99
|
+
|
|
100
|
+
- **Prompt Object Model (POM)**: structured prompt composition with `promptAddSection()`
|
|
101
|
+
- **SWAIG tools**: functions defined with `defineTool()` that the AI calls mid-conversation. A tool's result is context for the model, and its actions can control the call.
|
|
102
|
+
- **Skills system**: capabilities added in one line, such as `await agent.addSkill(new DateTimeSkill())`
|
|
103
|
+
- **Contexts and steps**: structured multi-step workflows with navigation control
|
|
104
|
+
- **DataMap tools**: tools that run on SignalWire's servers, calling REST APIs without your own webhook
|
|
105
|
+
- **Dynamic configuration**: a per-request copy of the agent, configured for each call, for multi-tenant deployments
|
|
106
|
+
- **Call flow control**: pre-answer, post-answer, and post-AI verb insertion
|
|
107
|
+
- **Prefab agents**: ready-to-use archetypes (InfoGatherer, Survey, FAQ, Receptionist, Concierge)
|
|
108
|
+
- **Multi-agent hosting**: multiple agents on a single server with `AgentServer`
|
|
109
|
+
- **SIP routing**: SIP calls routed to agents by username
|
|
110
|
+
- **Session state**: global data for the call, and post-prompt summaries when it ends
|
|
111
|
+
- **Security**: auto-generated basic auth, per-call tool tokens, webhook signature validation, and TLS support
|
|
112
|
+
- **Serverless**: automatic detection of Lambda, CGI, Google Cloud Functions, and Azure Functions
|
|
87
113
|
|
|
88
114
|
### Agent Examples
|
|
89
115
|
|
|
90
|
-
The [`examples/`](examples/) directory contains
|
|
116
|
+
The [`examples/`](examples/) directory contains more than 50 working examples. These show the main features:
|
|
91
117
|
|
|
92
118
|
| Example | What it demonstrates |
|
|
93
119
|
|---------|---------------------|
|
|
@@ -101,12 +127,17 @@ The [`examples/`](examples/) directory contains 35+ working examples:
|
|
|
101
127
|
| [serverless-lambda.ts](examples/serverless-lambda.ts) | AWS Lambda deployment |
|
|
102
128
|
| [dynamic-config.ts](examples/dynamic-config.ts) | Per-request dynamic configuration, multi-tenant routing |
|
|
103
129
|
|
|
130
|
+
See [examples/README.md](examples/README.md) for the full list organized by category.
|
|
131
|
+
|
|
104
132
|
---
|
|
105
133
|
|
|
106
134
|
## RELAY Client
|
|
107
135
|
|
|
108
136
|
Real-time call control and messaging over WebSocket. The RELAY client connects to SignalWire via the Blade protocol and gives you imperative, async control over live phone calls and SMS/MMS.
|
|
109
137
|
|
|
138
|
+
The RELAY client connects with `SIGNALWIRE_PROJECT_ID`, `SIGNALWIRE_API_TOKEN` and `SIGNALWIRE_SPACE` from the environment. This client answers each call on the `default` context, plays a greeting, and hangs up:
|
|
139
|
+
|
|
140
|
+
<!-- include: examples/quickstart-relay.ts#construct -->
|
|
110
141
|
```typescript
|
|
111
142
|
import { RelayClient, Call } from '@signalwire/sdk';
|
|
112
143
|
|
|
@@ -116,9 +147,7 @@ const client = new RelayClient({
|
|
|
116
147
|
|
|
117
148
|
client.onCall(async (call: Call) => {
|
|
118
149
|
await call.answer();
|
|
119
|
-
const action = await call.play([
|
|
120
|
-
{ type: 'tts', text: 'Welcome to SignalWire!' },
|
|
121
|
-
]);
|
|
150
|
+
const action = await call.play([{ type: 'tts', text: 'Welcome to SignalWire!' }]);
|
|
122
151
|
await action.wait();
|
|
123
152
|
await call.hangup();
|
|
124
153
|
});
|
|
@@ -126,7 +155,9 @@ client.onCall(async (call: Call) => {
|
|
|
126
155
|
client.run();
|
|
127
156
|
```
|
|
128
157
|
|
|
129
|
-
|
|
158
|
+
The RELAY client provides:
|
|
159
|
+
|
|
160
|
+
- Calling methods for play, record, collect, detect, tap, stream, AI, conferencing, and more
|
|
130
161
|
- SMS/MMS messaging with delivery tracking
|
|
131
162
|
- Action objects with `wait()`, `stop()`, `pause()`, `resume()`
|
|
132
163
|
- Auto-reconnect with exponential backoff
|
|
@@ -137,8 +168,11 @@ See the **[RELAY documentation](relay/README.md)** for the full guide, API refer
|
|
|
137
168
|
|
|
138
169
|
## REST Client
|
|
139
170
|
|
|
140
|
-
Typed HTTP client for managing SignalWire resources and controlling calls over HTTP.
|
|
171
|
+
Typed HTTP client for managing SignalWire resources and controlling calls over HTTP. It sends standard `fetch` requests, with no WebSocket.
|
|
172
|
+
|
|
173
|
+
This client creates a Fabric AI agent, plays text on a live call, searches for phone numbers and searches Datasphere documents:
|
|
141
174
|
|
|
175
|
+
<!-- include: examples/quickstart-rest.ts#construct -->
|
|
142
176
|
```typescript
|
|
143
177
|
import { RestClient } from '@signalwire/sdk';
|
|
144
178
|
|
|
@@ -149,70 +183,115 @@ const client = new RestClient({
|
|
|
149
183
|
});
|
|
150
184
|
|
|
151
185
|
await client.fabric.aiAgents.create({ name: 'Support Bot', prompt: { text: 'You are helpful.' } });
|
|
152
|
-
await client.calling.play(callId,
|
|
153
|
-
await client.phoneNumbers.search({
|
|
154
|
-
await client.datasphere.documents.search(
|
|
186
|
+
await client.calling.play(callId, [{ type: 'tts', params: { text: 'Hello!' } }]);
|
|
187
|
+
await client.phoneNumbers.search({ areacode: '512' });
|
|
188
|
+
await client.datasphere.documents.search('billing policy');
|
|
155
189
|
```
|
|
156
190
|
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
-
|
|
191
|
+
The REST client provides:
|
|
192
|
+
|
|
193
|
+
- Namespaced API surfaces: Fabric, Calling, Video, Datasphere, Phone Numbers, SIP, Queues, Recordings, and more
|
|
194
|
+
- Node's built-in `fetch`, with no HTTP client dependency
|
|
195
|
+
- Plain object returns: the raw JSON, with no wrapper objects
|
|
160
196
|
|
|
161
197
|
See the **[REST documentation](rest/README.md)** for the full guide, API reference, and examples.
|
|
162
198
|
|
|
163
199
|
---
|
|
164
200
|
|
|
201
|
+
## Webhook Verification
|
|
202
|
+
|
|
203
|
+
Your Signing Key verifies that an inbound webhook (a status callback, a
|
|
204
|
+
messaging callback, or a SWML or SWAIG request) came from SignalWire.
|
|
205
|
+
`validateRequest` replaces the Compatibility API's `RestClient.validateRequest()`
|
|
206
|
+
and `validateRequestWithBody()`. It's a top-level export of `@signalwire/sdk`, so
|
|
207
|
+
you don't need the separate `@signalwire/compatibility-api` package.
|
|
208
|
+
|
|
209
|
+
This fragment checks a form-encoded webhook, then a JSON one:
|
|
210
|
+
|
|
211
|
+
<!-- snippet: no-run illustrative fragment: references the assumed `signingKey` from the page prelude (declared type-only in the shared snippet-setup), not a standalone program -->
|
|
212
|
+
```typescript
|
|
213
|
+
import { validateRequest } from '@signalwire/sdk';
|
|
214
|
+
|
|
215
|
+
// Parsed form params, from a cXML (Compatibility API) webhook.
|
|
216
|
+
const ok = validateRequest(signingKey, signatureHeader, fullUrl, requestParams);
|
|
217
|
+
|
|
218
|
+
// The raw request body, for JSON and SWML webhooks, or a cXML body that
|
|
219
|
+
// carries bodySHA256.
|
|
220
|
+
const okBody = validateRequest(signingKey, signatureHeader, fullUrl, rawBodyString);
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
`validateRequest` folds both Compatibility API methods into one call: pass a
|
|
224
|
+
**parsed params object / `Map` / array of tuples** for form-encoded webhooks, or
|
|
225
|
+
the **raw body string** to additionally verify the `bodySHA256` the platform
|
|
226
|
+
includes for JSON/SWML payloads. It returns `true` on a match, `false`
|
|
227
|
+
otherwise, and throws if the Signing Key is missing.
|
|
228
|
+
|
|
229
|
+
`validateWebhookSignature(signingKey, signature, url, rawBody)` is the
|
|
230
|
+
lower-level check of one signature over a raw body.
|
|
231
|
+
|
|
232
|
+
SignalWire also sends an HMAC-SHA256 signature in the
|
|
233
|
+
`X-SignalWire-Sha256-Signature` header on JSON and SWML webhooks. It signs the
|
|
234
|
+
same message, the URL followed by the raw body, and you can check it with
|
|
235
|
+
`validateWebhookSignatureSha256(signingKey, signature, url, rawBody)`. An
|
|
236
|
+
agent's built-in validation, and `webhookValidationMiddleware`, check that
|
|
237
|
+
header first when it's present and fall back to `X-SignalWire-Signature`.
|
|
238
|
+
|
|
239
|
+
---
|
|
240
|
+
|
|
165
241
|
## Installation
|
|
166
242
|
|
|
243
|
+
One package covers agents, RELAY and REST. It requires Node.js 22 or later:
|
|
244
|
+
|
|
167
245
|
```bash
|
|
168
|
-
# Core SDK (agents, RELAY, REST)
|
|
169
246
|
npm install @signalwire/sdk
|
|
170
247
|
```
|
|
171
248
|
|
|
172
|
-
Requires Node.js >= 18.
|
|
173
|
-
|
|
174
249
|
## Documentation
|
|
175
250
|
|
|
176
|
-
|
|
251
|
+
The reference documentation is at **[developer.signalwire.com/sdks/agents-sdk](https://developer.signalwire.com/sdks/agents-sdk)**.
|
|
177
252
|
|
|
178
|
-
|
|
253
|
+
The [`docs/`](docs/) directory has these guides. They're installed with the package, with the examples: `npx sw-tsdocs path` prints where.
|
|
179
254
|
|
|
180
255
|
### Getting Started
|
|
181
256
|
|
|
182
|
-
- [Agent Guide](docs/agent-guide.md)
|
|
183
|
-
- [Architecture](docs/architecture.md)
|
|
184
|
-
- [SDK Features](docs/sdk_features.md)
|
|
257
|
+
- [Agent Guide](docs/agent-guide.md): creating agents, prompt configuration, dynamic setup
|
|
258
|
+
- [Architecture](docs/architecture.md): SDK architecture and core concepts
|
|
259
|
+
- [SDK Features](docs/sdk_features.md): feature overview, SDK vs raw SWML comparison
|
|
260
|
+
- [Programmatically Governed Inference](docs/programmatically_governed_inference.md): why code, not the model, owns the rules of a call
|
|
261
|
+
- [PGI Implementation Guide](docs/pgi_agent_guide.md): building a governed agent, with a tested reference implementation
|
|
262
|
+
- [Developer Pain Points](docs/developer_pain_points.md): common problems in voice AI, and the SDK features that address them
|
|
185
263
|
|
|
186
264
|
### Core Features
|
|
187
265
|
|
|
188
|
-
- [SWAIG Reference](docs/swaig-reference.md)
|
|
189
|
-
- [Contexts and Steps](docs/contexts-guide.md)
|
|
190
|
-
- [DataMap Guide](docs/datamap-guide.md)
|
|
191
|
-
- [LLM Parameters](docs/llm_parameters.md)
|
|
192
|
-
- [SWML Service Guide](docs/swml_service_guide.md)
|
|
266
|
+
- [SWAIG Reference](docs/swaig-reference.md): function results, actions, post_data lifecycle
|
|
267
|
+
- [Contexts and Steps](docs/contexts-guide.md): structured workflows, navigation, gather mode
|
|
268
|
+
- [DataMap Guide](docs/datamap-guide.md): serverless API tools without webhooks
|
|
269
|
+
- [LLM Parameters](docs/llm_parameters.md): temperature, top_p, barge settings
|
|
270
|
+
- [SWML Service Guide](docs/swml_service_guide.md): low-level construction of SWML documents
|
|
193
271
|
|
|
194
272
|
### Skills and Extensions
|
|
195
273
|
|
|
196
|
-
- [Skills System](docs/skills-guide.md)
|
|
197
|
-
- [Third-Party Skills](docs/third_party_skills.md)
|
|
198
|
-
- [MCP Gateway](docs/mcp_gateway_reference.md)
|
|
199
|
-
- [MCP Integration](docs/mcp_integration.md)
|
|
274
|
+
- [Skills System](docs/skills-guide.md): built-in skills and the modular framework
|
|
275
|
+
- [Third-Party Skills](docs/third_party_skills.md): creating and publishing custom skills
|
|
276
|
+
- [MCP Gateway](docs/mcp_gateway_reference.md): Model Context Protocol integration
|
|
277
|
+
- [MCP Integration](docs/mcp_integration.md): MCP agent setup and configuration
|
|
278
|
+
- [AI Chat](docs/ai_chat.md): the AI Chat client, and the gateway and handoff routes for a browser chat widget
|
|
200
279
|
|
|
201
280
|
### Deployment
|
|
202
281
|
|
|
203
|
-
- [CLI Guide](docs/cli-guide.md)
|
|
204
|
-
- [Cloud Functions](docs/cloud_functions_guide.md)
|
|
205
|
-
- [Serverless Guide](docs/serverless-guide.md)
|
|
206
|
-
- [Configuration](docs/configuration.md)
|
|
207
|
-
- [Security](docs/security.md)
|
|
282
|
+
- [CLI Guide](docs/cli-guide.md): `swaig-test` command reference
|
|
283
|
+
- [Cloud Functions](docs/cloud_functions_guide.md): Lambda, Cloud Functions, Azure deployment
|
|
284
|
+
- [Serverless Guide](docs/serverless-guide.md): deploy to AWS Lambda, Google Cloud Functions, Azure Functions, CGI
|
|
285
|
+
- [Configuration](docs/configuration.md): environment variables, SSL, proxy setup
|
|
286
|
+
- [Security](docs/security.md): authentication and security model
|
|
208
287
|
|
|
209
288
|
### Reference
|
|
210
289
|
|
|
211
|
-
- [API Reference](docs/api-reference.md)
|
|
212
|
-
- [Web Service](docs/web_service.md)
|
|
213
|
-
- [Skills Parameter Schema](docs/skills_parameter_schema.md)
|
|
214
|
-
- [Prefabs Guide](docs/prefabs-guide.md)
|
|
215
|
-
- [
|
|
290
|
+
- [API Reference](docs/api-reference.md): complete class and method reference
|
|
291
|
+
- [Web Service](docs/web_service.md): HTTP server and endpoint details
|
|
292
|
+
- [Skills Parameter Schema](docs/skills_parameter_schema.md): skill parameter definitions
|
|
293
|
+
- [Prefabs Guide](docs/prefabs-guide.md): pre-built agents: InfoGatherer, Survey, FAQ, Concierge, Receptionist
|
|
294
|
+
- [Bedrock Agent](docs/bedrock_agent.md): an agent that runs on Amazon Bedrock through the `amazon_bedrock` verb
|
|
216
295
|
|
|
217
296
|
## Environment Variables
|
|
218
297
|
|
|
@@ -221,6 +300,10 @@ Guides are also available in the [`docs/`](docs/) directory:
|
|
|
221
300
|
| `SIGNALWIRE_PROJECT_ID` | RELAY, REST | Project identifier |
|
|
222
301
|
| `SIGNALWIRE_API_TOKEN` | RELAY, REST | API token |
|
|
223
302
|
| `SIGNALWIRE_SPACE` | RELAY, REST | Space hostname (e.g. `example.signalwire.com`) |
|
|
303
|
+
| `SIGNALWIRE_REST_BASE_URL` | REST | Override the REST base URL with a full `http(s)://` URL (local mock / private space / proxy). Precedence: `host` option > `SIGNALWIRE_REST_BASE_URL` > `SIGNALWIRE_SPACE`. |
|
|
304
|
+
| `SIGNALWIRE_REST_CA_FILE` | REST | Path to a PEM CA bundle to trust for HTTPS REST requests (private/self-signed certificates). |
|
|
305
|
+
| `SIGNALWIRE_RELAY_HOST` | RELAY | Override the RELAY WebSocket host (advanced/testing). Precedence: `host` option > `SIGNALWIRE_RELAY_HOST` > `SIGNALWIRE_SPACE` > built-in default. |
|
|
306
|
+
| `SIGNALWIRE_RELAY_SCHEME` | RELAY | Override the RELAY WebSocket scheme (`ws`/`wss`; default `wss`). Precedence: `scheme` option > `SIGNALWIRE_RELAY_SCHEME` > `wss`; any value other than `ws`/`wss` falls back to `wss`. |
|
|
224
307
|
| `SWML_BASIC_AUTH_USER` | Agents | Basic auth username (default: auto-generated) |
|
|
225
308
|
| `SWML_BASIC_AUTH_PASSWORD` | Agents | Basic auth password (default: auto-generated) |
|
|
226
309
|
| `SWML_PROXY_URL_BASE` | Agents | Base URL when behind a reverse proxy |
|
|
@@ -232,23 +315,35 @@ Guides are also available in the [`docs/`](docs/) directory:
|
|
|
232
315
|
|
|
233
316
|
## Testing
|
|
234
317
|
|
|
318
|
+
The scripts under `scripts/` lint, format and test the SDK. They install their
|
|
319
|
+
dependencies on first run and work from any directory:
|
|
320
|
+
|
|
235
321
|
```bash
|
|
236
|
-
#
|
|
237
|
-
|
|
322
|
+
# Run the test suite (optional filter passed through to vitest)
|
|
323
|
+
bash scripts/run-tests.sh
|
|
324
|
+
bash scripts/run-tests.sh AgentBase
|
|
238
325
|
|
|
239
|
-
#
|
|
240
|
-
|
|
326
|
+
# Format the tree (or --check to verify without writing)
|
|
327
|
+
bash scripts/run-format.sh
|
|
328
|
+
bash scripts/run-format.sh --check
|
|
241
329
|
|
|
242
|
-
#
|
|
243
|
-
|
|
330
|
+
# Lint (tsc + eslint; --fix to autofix)
|
|
331
|
+
bash scripts/run-lint.sh
|
|
332
|
+
```
|
|
244
333
|
|
|
334
|
+
These npm scripts build the SDK and watch for changes:
|
|
335
|
+
|
|
336
|
+
```bash
|
|
245
337
|
# Build
|
|
246
338
|
npm run build
|
|
247
339
|
|
|
248
340
|
# Dev mode (watch + rebuild)
|
|
249
341
|
npm run dev
|
|
342
|
+
|
|
343
|
+
# Watch-mode tests
|
|
344
|
+
npm run test:watch
|
|
250
345
|
```
|
|
251
346
|
|
|
252
347
|
## License
|
|
253
348
|
|
|
254
|
-
MIT
|
|
349
|
+
MIT. See [LICENSE](LICENSE) for details.
|
package/dist/AGENTS.md
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# The @signalwire/sdk package
|
|
2
|
+
|
|
3
|
+
This directory holds the code of the SignalWire SDK for TypeScript
|
|
4
|
+
(`@signalwire/sdk` on npm). In an installed package it's
|
|
5
|
+
`node_modules/@signalwire/sdk/dist/`, beside the docs and examples the package
|
|
6
|
+
ships at its root (`docs/`, `examples/`, `relay/`, `rest/`, `livewire/`).
|
|
7
|
+
|
|
8
|
+
To learn or use the SDK, run `npx sw-tsdocs`. It maps the SDK and lists the
|
|
9
|
+
docs and examples installed with it, and `npx sw-tsdocs api <name>` shows
|
|
10
|
+
signatures and JSDoc from this package's declarations. `llms.txt` in this
|
|
11
|
+
directory lists the same docs.
|
|
12
|
+
|
|
13
|
+
To change the SDK itself, see the AGENTS.md at the root of its repository.
|