@signalwire/sdk 2.0.5 → 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 +481 -126
- package/dist/AgentBase.js +1502 -438
- 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 +12 -1
- package/dist/POM/PromptObjectModel.js +25 -9
- package/dist/POM/PromptObjectModel.js.map +1 -1
- 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 +18 -0
- package/dist/PomBuilder.js +53 -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 +22 -1
- package/dist/PromptManager.js +28 -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 +158 -58
- package/dist/SWMLService.js +435 -127
- 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 +49 -9
- package/dist/SecurityUtils.js +153 -51
- 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 +92 -33
- 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 -371
- 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 +47 -68
- package/dist/index.js +44 -73
- 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 +44 -17
- package/dist/relay/RelayClient.js +175 -65
- 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 +73 -42
- 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 +5 -2
- package/dist/rest/callHandler.js +4 -1
- package/dist/rest/callHandler.js.map +1 -1
- package/dist/rest/index.d.ts +18 -77
- package/dist/rest/index.js +47 -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 -327
- package/dist/rest/namespaces/fabric.js +14 -439
- 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 +8 -196
- package/dist/rest/namespaces/phone-numbers.js +8 -230
- 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 +22 -11
- package/dist/skills/SkillRegistry.js +47 -17
- 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 +18 -6
- 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 +21 -22
- 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 +42 -4
- package/dist/skills/builtin/spider.js +277 -104
- 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 +38 -30
- 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 +294 -100
- 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 +14 -13
- 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 +59 -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 +85 -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/dist/SwmlBuilder.js
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
* at construction from the bundled schema.json. All verb methods support
|
|
8
8
|
* fluent chaining and call `addVerb()` internally.
|
|
9
9
|
*/
|
|
10
|
-
import { SchemaUtils } from './SchemaUtils.js';
|
|
10
|
+
import { SchemaUtils, SchemaValidationError } from './SchemaUtils.js';
|
|
11
11
|
// Ensure module augmentation from generated file is active
|
|
12
12
|
import './SwmlVerbMethods.generated.js';
|
|
13
13
|
/**
|
|
@@ -42,6 +42,18 @@ export class SwmlBuilder {
|
|
|
42
42
|
/** Per-instance SchemaUtils used when a custom `schemaPath` was supplied. */
|
|
43
43
|
_instanceSchemaUtils = null;
|
|
44
44
|
enableValidation;
|
|
45
|
+
/**
|
|
46
|
+
* The `SWMLService` this builder belongs to — the reference's public
|
|
47
|
+
* `self.service` (`core/swml_builder.py:57`) — or `undefined` for a standalone
|
|
48
|
+
* builder.
|
|
49
|
+
*
|
|
50
|
+
* In the reference the builder DELEGATES document construction to the service, so
|
|
51
|
+
* the service is a required constructor argument. TS inverts the ownership (the
|
|
52
|
+
* builder holds its own document and `SWMLService` holds the builder), which is why
|
|
53
|
+
* it is optional here. The read-back is the same: a caller holding the builder can
|
|
54
|
+
* reach the service that owns it.
|
|
55
|
+
*/
|
|
56
|
+
service;
|
|
45
57
|
/**
|
|
46
58
|
* Creates a new SwmlBuilder.
|
|
47
59
|
* @param opts - Optional configuration.
|
|
@@ -68,6 +80,7 @@ export class SwmlBuilder {
|
|
|
68
80
|
if (opts?.schemaPath) {
|
|
69
81
|
this._instanceSchemaUtils = new SchemaUtils({ schemaPath: opts.schemaPath });
|
|
70
82
|
}
|
|
83
|
+
this.service = opts?.service;
|
|
71
84
|
this._installVerbMethods();
|
|
72
85
|
}
|
|
73
86
|
/** Returns the SchemaUtils for this builder — per-instance if a custom
|
|
@@ -77,8 +90,10 @@ export class SwmlBuilder {
|
|
|
77
90
|
}
|
|
78
91
|
/**
|
|
79
92
|
* Public read-only accessor for the underlying SWML document.
|
|
80
|
-
*
|
|
81
|
-
* `service`
|
|
93
|
+
*
|
|
94
|
+
* (Not the reference's `service` — that is the SWMLService back-reference, exposed
|
|
95
|
+
* as {@link service}. This is the document the builder is assembling, which the
|
|
96
|
+
* reference reaches through `self.service`.)
|
|
82
97
|
*/
|
|
83
98
|
get document() {
|
|
84
99
|
return this._document;
|
|
@@ -118,15 +133,14 @@ export class SwmlBuilder {
|
|
|
118
133
|
continue;
|
|
119
134
|
// Special handling for sleep — accepts number directly or config object
|
|
120
135
|
if (verbName === 'sleep') {
|
|
121
|
-
|
|
122
|
-
this['sleep'] = function sleep(durationOrConfig) {
|
|
136
|
+
this['sleep'] = (durationOrConfig) => {
|
|
123
137
|
if (typeof durationOrConfig === 'number') {
|
|
124
|
-
|
|
138
|
+
this.addVerb('sleep', durationOrConfig);
|
|
125
139
|
}
|
|
126
140
|
else {
|
|
127
|
-
|
|
141
|
+
this.addVerb('sleep', durationOrConfig);
|
|
128
142
|
}
|
|
129
|
-
return
|
|
143
|
+
return this;
|
|
130
144
|
};
|
|
131
145
|
continue;
|
|
132
146
|
}
|
|
@@ -151,26 +165,56 @@ export class SwmlBuilder {
|
|
|
151
165
|
* Validates the verb config against the schema when validation is enabled.
|
|
152
166
|
* @param verbName - The SWML verb name (e.g., "answer", "ai").
|
|
153
167
|
* @param config - The verb's configuration payload.
|
|
168
|
+
* @param opts - When `opts.skipValidation` is true, the config is appended
|
|
169
|
+
* WITHOUT schema validation. Used by AgentBase for the internally-assembled
|
|
170
|
+
* `ai` verb, whose config is built from already-typed builder inputs and may
|
|
171
|
+
* carry real, server-accepted SWML that the bundled schema does not yet model
|
|
172
|
+
* (e.g. `multilingual`, `SWAIG.mcp_servers`, per-language engine/model/fillers,
|
|
173
|
+
* `debug_webhook_url`). Validating it against the closed schema would raise on
|
|
174
|
+
* those legitimate features — the strict-render contract is about rejecting
|
|
175
|
+
* MISSHAPEN direct `addVerb` input (unknown verb, misspelled/unknown key,
|
|
176
|
+
* wrong type), NOT about second-guessing trusted internal assembly. The
|
|
177
|
+
* direct/public `addVerb` path stays fully strict.
|
|
154
178
|
*/
|
|
155
|
-
addVerb(verbName, config) {
|
|
156
|
-
if (this.enableValidation) {
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
179
|
+
addVerb(verbName, config, opts) {
|
|
180
|
+
if (this.enableValidation && !opts?.skipValidation) {
|
|
181
|
+
// Validate unconditionally — an UNKNOWN verb must raise, not be appended
|
|
182
|
+
// silently (the strict-render contract). `validateVerb` returns
|
|
183
|
+
// "Unknown verb: '<name>'" for a name the schema doesn't define, matching
|
|
184
|
+
// the python reference's `add_verb`. (Previously this was gated on
|
|
185
|
+
// `hasVerb`, which let unknown verbs slip through.)
|
|
186
|
+
const result = this.getSchemaUtils().validateVerb(verbName, config);
|
|
187
|
+
if (!result.valid) {
|
|
188
|
+
throw new SchemaValidationError(verbName, result.errors);
|
|
163
189
|
}
|
|
164
190
|
}
|
|
191
|
+
// The default document factory always seeds a `main` section; preserve the
|
|
192
|
+
// existing assumption that it is present (assertion is type-only).
|
|
165
193
|
this._document.sections['main'].push({ [verbName]: config });
|
|
166
194
|
}
|
|
167
195
|
/**
|
|
168
196
|
* Appends a verb to a named section, creating the section if it does not exist.
|
|
197
|
+
*
|
|
198
|
+
* Validates exactly as {@link addVerb} does. The reference validates at BOTH
|
|
199
|
+
* add-verb sites (`core/swml_service.py:558` and `:635`, each raising
|
|
200
|
+
* `SchemaValidationError`); this path previously appended without validating, so a
|
|
201
|
+
* misshapen or unknown verb reached a non-main section silently.
|
|
202
|
+
*
|
|
169
203
|
* @param sectionName - The target section name.
|
|
170
204
|
* @param verbName - The SWML verb name.
|
|
171
205
|
* @param config - The verb's configuration payload.
|
|
206
|
+
* @param opts - When `opts.skipValidation` is true, append without validating
|
|
207
|
+
* (same trusted-internal-assembly escape hatch as {@link addVerb}).
|
|
208
|
+
* @throws {SchemaValidationError} When validation is enabled and the config does
|
|
209
|
+
* not satisfy the verb's schema (or the verb is unknown).
|
|
172
210
|
*/
|
|
173
|
-
addVerbToSection(sectionName, verbName, config) {
|
|
211
|
+
addVerbToSection(sectionName, verbName, config, opts) {
|
|
212
|
+
if (this.enableValidation && !opts?.skipValidation) {
|
|
213
|
+
const result = this.getSchemaUtils().validateVerb(verbName, config);
|
|
214
|
+
if (!result.valid) {
|
|
215
|
+
throw new SchemaValidationError(verbName, result.errors);
|
|
216
|
+
}
|
|
217
|
+
}
|
|
174
218
|
if (!this._document.sections[sectionName]) {
|
|
175
219
|
this._document.sections[sectionName] = [];
|
|
176
220
|
}
|
|
@@ -184,7 +228,13 @@ export class SwmlBuilder {
|
|
|
184
228
|
* @param opts - Optional TTS parameters (voice, language, gender, volume).
|
|
185
229
|
* @returns this for fluent chaining.
|
|
186
230
|
*/
|
|
187
|
-
say(text,
|
|
231
|
+
say(text,
|
|
232
|
+
// `gender` is typed `TtsGender` (`'male' | 'female'`) — the CLOSED literal
|
|
233
|
+
// union, consistent with the RELAY gender: autocomplete + typo-checking, an
|
|
234
|
+
// off-spec value a compile error. Types erase at runtime → the value on the
|
|
235
|
+
// wire is identical to a bare string (parity with Python's `gender: str`);
|
|
236
|
+
// closing the type changes what the compiler accepts, not a wire byte.
|
|
237
|
+
opts) {
|
|
188
238
|
const config = { url: `say:${text}` };
|
|
189
239
|
if (opts?.voice !== undefined)
|
|
190
240
|
config['say_voice'] = opts.voice;
|
|
@@ -212,36 +262,22 @@ export class SwmlBuilder {
|
|
|
212
262
|
return this;
|
|
213
263
|
}
|
|
214
264
|
/**
|
|
215
|
-
*
|
|
216
|
-
*
|
|
217
|
-
*/
|
|
218
|
-
getDocument() {
|
|
219
|
-
return this._document;
|
|
220
|
-
}
|
|
221
|
-
/**
|
|
222
|
-
* Alias for {@link getDocument}. Matches the Python SDK's `build()` method.
|
|
223
|
-
* Build and return the SWML document as a dictionary/object.
|
|
265
|
+
* Build and return the SWML document as a dictionary/object. Canonical name,
|
|
266
|
+
* matching Python's `SWMLBuilder.build()`.
|
|
224
267
|
*
|
|
225
268
|
* @returns The document with version and sections.
|
|
226
269
|
*/
|
|
227
270
|
build() {
|
|
228
|
-
return this.
|
|
229
|
-
}
|
|
230
|
-
/**
|
|
231
|
-
* Serializes the SWML document to a JSON string.
|
|
232
|
-
* @returns The JSON-encoded SWML document.
|
|
233
|
-
*/
|
|
234
|
-
renderDocument() {
|
|
235
|
-
return JSON.stringify(this._document);
|
|
271
|
+
return this._document;
|
|
236
272
|
}
|
|
237
273
|
/**
|
|
238
|
-
*
|
|
239
|
-
*
|
|
274
|
+
* Build and render the SWML document as a JSON string. Canonical name,
|
|
275
|
+
* matching Python's `SWMLBuilder.render()`.
|
|
240
276
|
*
|
|
241
277
|
* @returns The JSON-encoded SWML document.
|
|
242
278
|
*/
|
|
243
279
|
render() {
|
|
244
|
-
return this.
|
|
280
|
+
return JSON.stringify(this._document);
|
|
245
281
|
}
|
|
246
282
|
}
|
|
247
283
|
//# sourceMappingURL=SwmlBuilder.js.map
|
package/dist/SwmlBuilder.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SwmlBuilder.js","sourceRoot":"","sources":["../src/SwmlBuilder.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;
|
|
1
|
+
{"version":3,"file":"SwmlBuilder.js","sourceRoot":"","sources":["../src/SwmlBuilder.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,WAAW,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAItE,2DAA2D;AAC3D,OAAO,gCAAgC,CAAC;AAsCxC;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,OAAO,WAAW;IACd,SAAS,CAA2D;IACpE,MAAM,CAAC,YAAY,GAAuB,IAAI,CAAC;IACvD,6EAA6E;IACrE,oBAAoB,GAAuB,IAAI,CAAC;IAChD,gBAAgB,CAAU;IAClC;;;;;;;;;;OAUG;IACM,OAAO,CAAmB;IAEnC;;;;;;OAMG;IACH,YAAY,IAAyB;QACnC,IAAI,IAAI,EAAE,eAAe,EAAE,CAAC;YAC1B,IAAI,CAAC,SAAS,GAAG;gBACf,OAAO,EAAE,IAAI,CAAC,eAAe,CAAC,OAAO,IAAI,OAAO;gBAChD,QAAQ,EAAE,IAAI,CAAC,eAAe,CAAC,QAAQ,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE;aACxD,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QACtC,CAAC;QACD,IAAI,IAAI,EAAE,gBAAgB,KAAK,SAAS,EAAE,CAAC;YACzC,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAChD,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC,KAAK,MAAM,CAAC;QAChF,CAAC;QACD,IAAI,IAAI,EAAE,UAAU,EAAE,CAAC;YACrB,IAAI,CAAC,oBAAoB,GAAG,IAAI,WAAW,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;QAC/E,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,OAAO,CAAC;QAC7B,IAAI,CAAC,mBAAmB,EAAE,CAAC;IAC7B,CAAC;IAED;qEACiE;IACzD,cAAc;QACpB,OAAO,IAAI,CAAC,oBAAoB,IAAI,WAAW,CAAC,cAAc,EAAE,CAAC;IACnE,CAAC;IAED;;;;;;OAMG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACH,aAAa,CAAC,OAAgB;QAC5B,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC;IAClC,CAAC;IAEO,WAAW;QACjB,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,EAAe,EAAE,EAAE,CAAC;IACnE,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,cAAc;QACnB,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE,CAAC;YAC9B,WAAW,CAAC,YAAY,GAAG,IAAI,WAAW,EAAE,CAAC;QAC/C,CAAC;QACD,OAAO,WAAW,CAAC,YAAY,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACK,mBAAmB;QACzB,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAC1C,MAAM,SAAS,GAAG,WAAW,CAAC,YAAY,EAAE,CAAC;QAE7C,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,qEAAqE;YACrE,IAAI,QAAQ,IAAI,IAAI;gBAAE,SAAS;YAE/B,wEAAwE;YACxE,IAAI,QAAQ,KAAK,OAAO,EAAE,CAAC;gBACxB,IAAgC,CAAC,OAAO,CAAC,GAAG,CAC3C,gBAAkD,EACrC,EAAE;oBACf,IAAI,OAAO,gBAAgB,KAAK,QAAQ,EAAE,CAAC;wBACzC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;oBAC1C,CAAC;yBAAM,CAAC;wBACN,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;oBAC1C,CAAC;oBACD,OAAO,IAAI,CAAC;gBACd,CAAC,CAAC;gBACF,SAAS;YACX,CAAC;YAED,sCAAsC;YACtC,MAAM,UAAU,GACd,CAAC,IAAY,EAAE,EAAE,CACjB,CAAC,MAAgC,EAAe,EAAE;gBAChD,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,IAAI,EAAE,CAAC,CAAC;gBACjC,OAAO,IAAI,CAAC;YACd,CAAC,CAAC;YAEH,IAAgC,CAAC,QAAQ,CAAC,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC;QACrE,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK;QACH,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QACpC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,OAAO,CAAC,QAAgB,EAAE,MAAe,EAAE,IAAmC;QAC5E,IAAI,IAAI,CAAC,gBAAgB,IAAI,CAAC,IAAI,EAAE,cAAc,EAAE,CAAC;YACnD,yEAAyE;YACzE,gEAAgE;YAChE,0EAA0E;YAC1E,mEAAmE;YACnE,oDAAoD;YACpD,MAAM,MAAM,GAAqB,IAAI,CAAC,cAAc,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YACtF,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;gBAClB,MAAM,IAAI,qBAAqB,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;YAC3D,CAAC;QACH,CAAC;QACD,2EAA2E;QAC3E,mEAAmE;QACnE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAE,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,gBAAgB,CACd,WAAmB,EACnB,QAAgB,EAChB,MAAe,EACf,IAAmC;QAEnC,IAAI,IAAI,CAAC,gBAAgB,IAAI,CAAC,IAAI,EAAE,cAAc,EAAE,CAAC;YACnD,MAAM,MAAM,GAAqB,IAAI,CAAC,cAAc,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YACtF,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;gBAClB,MAAM,IAAI,qBAAqB,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;YAC3D,CAAC;QACH,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;YAC1C,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC;QAC5C,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CACD,IAAY;IACZ,2EAA2E;IAC3E,4EAA4E;IAC5E,4EAA4E;IAC5E,2EAA2E;IAC3E,uEAAuE;IACvE,IAAiF;QAEjF,MAAM,MAAM,GAA4B,EAAE,GAAG,EAAE,OAAO,IAAI,EAAE,EAAE,CAAC;QAC/D,IAAI,IAAI,EAAE,KAAK,KAAK,SAAS;YAAE,MAAM,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC;QAChE,IAAI,IAAI,EAAE,QAAQ,KAAK,SAAS;YAAE,MAAM,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;QACzE,IAAI,IAAI,EAAE,MAAM,KAAK,SAAS;YAAE,MAAM,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;QACnE,IAAI,IAAI,EAAE,MAAM,KAAK,SAAS;YAAE,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;QAC/D,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CAAC,WAAmB;QAC5B,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;YAC1C,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC;QAC5C,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,KAAK;QACH,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED;;;;;OAKG;IACH,MAAM;QACJ,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACxC,CAAC"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* AUTO-GENERATED FILE — do not edit manually.
|
|
3
|
-
* Generated by: npx tsx
|
|
3
|
+
* Generated by: npx tsx scripts/generate-swml-verbs.ts
|
|
4
4
|
*
|
|
5
5
|
* Provides TypeScript interface augmentation for all SWML verb methods
|
|
6
6
|
* auto-installed on SwmlBuilder from schema.json.
|
|
@@ -28,8 +28,8 @@ export interface PlayVerbConfig {
|
|
|
28
28
|
say_voice?: string;
|
|
29
29
|
/** Language code for text-to-speech (e.g. "en-US"). */
|
|
30
30
|
say_language?: string;
|
|
31
|
-
/** Gender for text-to-speech
|
|
32
|
-
say_gender?:
|
|
31
|
+
/** Gender for text-to-speech. The `"male" | "female"` literals are autocompleted and typo-checked; any other string value is also accepted. */
|
|
32
|
+
say_gender?: 'male' | 'female';
|
|
33
33
|
/** If true, auto-answer the call before playing audio. Default true. */
|
|
34
34
|
auto_answer?: boolean;
|
|
35
35
|
}
|
|
@@ -37,6 +37,7 @@ declare module './SwmlBuilder.js' {
|
|
|
37
37
|
interface SwmlBuilder {
|
|
38
38
|
/** Answer incoming call and set an optional maximum duration. */
|
|
39
39
|
answer(config?: {
|
|
40
|
+
/** Maximum duration in seconds for the call. Defaults to `14400` seconds (4 hours). */
|
|
40
41
|
max_duration?: number; /** Comma-separated string of codecs to offer. Valid codecs are: PCMU, PCMA, G722, G729, AMR-WB, OPUS, VP8, H264. */
|
|
41
42
|
codecs?: string; /** Username to use for SIP authentication. */
|
|
42
43
|
username?: string; /** Password to use for SIP authentication. */
|
|
@@ -56,6 +57,7 @@ declare module './SwmlBuilder.js' {
|
|
|
56
57
|
enter_queue(config?: unknown): this;
|
|
57
58
|
/** Execute a specified section or URL as a subroutine, and upon completion, return to the current document. Use the return statement to pass any return values or objects back to the current document. */
|
|
58
59
|
execute(config: {
|
|
60
|
+
/** Specifies what to execute. The value can be one of: - `<section_name>` - section in the current document to execute - A URL (http or https) that returns a SWML document - Sends HTTP POST - An inline SWML document (as a JSON string) */
|
|
59
61
|
dest: string; /** Named parameters to send to section or URL */
|
|
60
62
|
params?: Record<string, unknown>; /** User-defined metadata, ignored by SignalWire */
|
|
61
63
|
meta?: Record<string, unknown>; /** The list of SWML instructions to be executed when the executed section or URL returns */
|
|
@@ -64,6 +66,7 @@ declare module './SwmlBuilder.js' {
|
|
|
64
66
|
}): this;
|
|
65
67
|
/** Jump to a label within the current section, optionally based on a condition. The goto method will only navigate to a label within the same section. */
|
|
66
68
|
goto(config: {
|
|
69
|
+
/** Mark any point of the SWML section with a label so that goto can jump to it. */
|
|
67
70
|
label: string; /** A JavaScript condition that determines whether to perform the jump. If the condition evaluates to true, the jump is executed. If omitted, the jump is unconditional. */
|
|
68
71
|
when?: string; /** The maximum number of times to perform the jump. Must be a number between 1 and 100. Default `100`. */
|
|
69
72
|
max?: number;
|
|
@@ -72,10 +75,28 @@ declare module './SwmlBuilder.js' {
|
|
|
72
75
|
label(value: string): this;
|
|
73
76
|
/** Start live transcription of the call. The transcription will be sent to the specified webhook URL. */
|
|
74
77
|
live_transcribe(config: {
|
|
78
|
+
/** The action to perform during live transcription. */
|
|
75
79
|
action: unknown;
|
|
76
80
|
}): this;
|
|
81
|
+
/** Start ai_sidecar mode — live_transcribe with an LLM/SWAIG/MCP loop on top. */
|
|
82
|
+
ai_sidecar(config: {
|
|
83
|
+
/** Operator prompt — POM object, plain string, or {file: path}. */
|
|
84
|
+
prompt: Record<string, unknown>; /** BCP-47 conversation language. Required. */
|
|
85
|
+
lang: string; /** LLM model for sidecar tick + close-time summaries. */
|
|
86
|
+
model?: string; /** Both legs are required for sidecar mode. */
|
|
87
|
+
direction?: string[]; /** Which leg is the customer (turn-end trigger source). */
|
|
88
|
+
customer_role?: string; /** Webhook URL for transcribe events AND sidecar events. */
|
|
89
|
+
url?: string; /** SWAIG functions and MCP servers. */
|
|
90
|
+
SWAIG?: unknown; /** SWAIG permission overrides — pass-through to mod_openai. */
|
|
91
|
+
permissions?: Record<string, unknown>; /** Initial sidecar global_data. */
|
|
92
|
+
global_data?: Record<string, unknown>; /** Speech-recognition hints biasing ASR toward specific terms. */
|
|
93
|
+
hints?: string[]; /** Tunable knobs (idle_timeout_ms, ai_summary, etc.) — pass-through to mod_openai which validates them strictly. New tunables only land here. */
|
|
94
|
+
params?: Record<string, unknown>; /** Reserved for future runtime sub-actions. */
|
|
95
|
+
action?: unknown;
|
|
96
|
+
}): this;
|
|
77
97
|
/** Start live translation of the call. The translation will be sent to the specified webhook URL. */
|
|
78
98
|
live_translate(config: {
|
|
99
|
+
/** The action to perform during live translation. */
|
|
79
100
|
action: unknown;
|
|
80
101
|
}): this;
|
|
81
102
|
/** End the call with an optional reason. */
|
|
@@ -84,6 +105,7 @@ declare module './SwmlBuilder.js' {
|
|
|
84
105
|
}): this;
|
|
85
106
|
/** Join a RELAY room. If the room doesn't exist, it creates a new room. */
|
|
86
107
|
join_room(config: {
|
|
108
|
+
/** Name of the room to join. Allowed characters: A-Z, a-z, 0-9, underscore, and hyphen. */
|
|
87
109
|
name: string;
|
|
88
110
|
}): this;
|
|
89
111
|
/** Join an ad-hoc audio conference started on either the SignalWire or Compatibility API. This method allows you to connect the current call to a named conference where multiple participants can communicate simultaneously. */
|
|
@@ -92,11 +114,12 @@ declare module './SwmlBuilder.js' {
|
|
|
92
114
|
play(config?: PlayVerbConfig): this;
|
|
93
115
|
/** Play a prompt and wait for input. The input can be received either as digits from the keypad, or from speech, or both depending on what parameters are set. By default, only digit input is enabled. To enable speech input, set at least one speech parameter. To enable both digit and speech input, set at least one parameter for each. */
|
|
94
116
|
prompt(config: {
|
|
117
|
+
/** URL or array of URLs to play. Allowed URLs are: http:// or https:// - audio file to GET ring:[duration:]<country code> - ring tone to play. For example: ring:us to play single ring or ring:20.0:us to play ring for 20 seconds. say:<text to speak> - Sentence to say silence: <duration> - seconds of silence to play */
|
|
95
118
|
play: unknown[]; /** Volume level for the audio file. Default is `0`. Valid range is -40 to 40. */
|
|
96
119
|
volume?: number; /** The voice to use for the text to speech. */
|
|
97
120
|
say_voice?: string; /** The language to use for the text to speech. */
|
|
98
121
|
say_language?: string; /** The gender to use for the text to speech. */
|
|
99
|
-
say_gender?:
|
|
122
|
+
say_gender?: 'male' | 'female'; /** Number of digits to collect. Default is `1`. */
|
|
100
123
|
max_digits?: number; /** Digits that terminate digit collection. Default is not set. */
|
|
101
124
|
terminators?: string; /** Time in seconds to wait for next digit. Default is `5.0` seconds. */
|
|
102
125
|
digit_timeout?: number; /** Time in seconds to wait for start of input. Default is `5.0` seconds. */
|
|
@@ -110,10 +133,12 @@ declare module './SwmlBuilder.js' {
|
|
|
110
133
|
}): this;
|
|
111
134
|
/** Receive a fax being delivered to this call. */
|
|
112
135
|
receive_fax(config?: {
|
|
136
|
+
/** http or https URL to deliver receive_fax status events */
|
|
113
137
|
status_url?: string;
|
|
114
138
|
}): this;
|
|
115
139
|
/** Record the call audio in the foreground, pausing further SWML execution until recording ends. Use this, for example, to record voicemails. To record calls in the background in a non-blocking fashion, use the record_call method. */
|
|
116
140
|
record(config?: {
|
|
141
|
+
/** If true, record in stereo. Default is `false`. */
|
|
117
142
|
stereo?: boolean; /** The format to record in. Can be `wav`, `mp3`, or `mp4`. Default is `"wav"`. */
|
|
118
143
|
format?: 'wav' | 'mp3' | 'mp4'; /** Direction of the audio to record: "speak" for what party says, "listen" for what party hears. Default is `"speak"`. */
|
|
119
144
|
direction?: 'speak' | 'listen'; /** String of digits that will stop the recording when pressed. Default is `"#"`. */
|
|
@@ -127,6 +152,7 @@ declare module './SwmlBuilder.js' {
|
|
|
127
152
|
}): this;
|
|
128
153
|
/** Record call in the background. Unlike the record method, the record_call method will start the recording and continue executing the SWML script while allowing the recording to happen in the background. To stop call recordings started with record_call, use the stop_record_call method. */
|
|
129
154
|
record_call(config?: {
|
|
155
|
+
/** Identifier for this recording, to use with `stop_call_record`. */
|
|
130
156
|
control_id?: string; /** If `true`, record in stereo. Default is `false`. */
|
|
131
157
|
stereo?: boolean; /** The format to record in. It can be `wav`, `mp3`, or `mp4`. Default is `"wav"`. */
|
|
132
158
|
format?: 'wav' | 'mp3' | 'mp4'; /** Direction of the audio to record: "speak" for what party says, "listen" for what party hears, "both" for what the party hears and says. Default is `"both"`. */
|
|
@@ -141,6 +167,7 @@ declare module './SwmlBuilder.js' {
|
|
|
141
167
|
}): this;
|
|
142
168
|
/** Send a GET, POST, PUT, or DELETE request to a remote URL. */
|
|
143
169
|
request(config: {
|
|
170
|
+
/** URL to send the HTTPS request to. Authentication can also be set in the URL in the format of username:password@url. */
|
|
144
171
|
url: string; /** The HTTP method to be used for the request. Can be `GET`, `POST`, `PUT`, or `DELETE`. */
|
|
145
172
|
method: 'GET' | 'POST' | 'PUT' | 'DELETE'; /** Object containing HTTP headers to set. Valid header values are Accept, Authorization, Content-Type, Range, and custom X- headers. */
|
|
146
173
|
headers?: Record<string, unknown>; /** Request body. Content-Type header should be explicitly set, but if not set, the most likely type will be set based on the first non-whitespace character. */
|
|
@@ -153,10 +180,12 @@ declare module './SwmlBuilder.js' {
|
|
|
153
180
|
return(config?: unknown): this;
|
|
154
181
|
/** Send digit presses as DTMF tones. */
|
|
155
182
|
send_digits(config: {
|
|
183
|
+
/** The digits to send. Valid values are 0123456789*#ABCDWw. Character W is a 1 second delay, and w is a 500ms delay. */
|
|
156
184
|
digits: string;
|
|
157
185
|
}): this;
|
|
158
186
|
/** Send a fax. */
|
|
159
187
|
send_fax(config: {
|
|
188
|
+
/** URL to the PDF document to fax. */
|
|
160
189
|
document: string; /** Header text to include on the fax. */
|
|
161
190
|
header_info?: string; /** Station identity to report. Default is the calling party's caller ID number. */
|
|
162
191
|
identity?: string; /** http or https URL to deliver send_fax status events */
|
|
@@ -172,6 +201,7 @@ declare module './SwmlBuilder.js' {
|
|
|
172
201
|
}): this;
|
|
173
202
|
/** Send SIP REFER to a SIP call. */
|
|
174
203
|
sip_refer(config: {
|
|
204
|
+
/** The SIP URI to send the REFER to. */
|
|
175
205
|
to_uri: string; /** The HTTP or HTTPS URL to send status callback events to. */
|
|
176
206
|
status_url?: string; /** Username to use for SIP authentication. */
|
|
177
207
|
username?: string; /** Password to use for SIP authentication. */
|
|
@@ -181,20 +211,24 @@ declare module './SwmlBuilder.js' {
|
|
|
181
211
|
stop_denoise(config?: Record<string, unknown>): this;
|
|
182
212
|
/** Stop an active background recording. */
|
|
183
213
|
stop_record_call(config?: {
|
|
214
|
+
/** Identifier for the recording to stop. If not set, the last recording started will be stopped. */
|
|
184
215
|
control_id?: string;
|
|
185
216
|
}): this;
|
|
186
217
|
/** Stop an active tap stream. */
|
|
187
218
|
stop_tap(config?: {
|
|
219
|
+
/** ID of the tap to stop. If not set, it will shut off the most recent tap session. */
|
|
188
220
|
control_id?: string;
|
|
189
221
|
}): this;
|
|
190
222
|
/** Execute different instructions based on a variable's value. */
|
|
191
223
|
switch(config: {
|
|
224
|
+
/** Name of the variable whose value needs to be compared. */
|
|
192
225
|
variable: string; /** Object of key-mapped values to array of SWML methods to execute. */
|
|
193
226
|
case: Record<string, unknown>; /** Array of SWML methods to execute if no cases match. */
|
|
194
227
|
default?: unknown[];
|
|
195
228
|
}): this;
|
|
196
229
|
/** Start background call tap. Media is streamed over Websocket or RTP to customer controlled URI. */
|
|
197
230
|
tap(config: {
|
|
231
|
+
/** Destination of the tap media stream: rtp://IP:port, ws://example.com, or wss://example.com. */
|
|
198
232
|
uri: string; /** Identifier for this tap to use with `stop_tap`. */
|
|
199
233
|
control_id?: string; /** Direction of the audio to tap: `speak` for what party says, `listen` for what party hears, `both` for what party hears and says. Default is `"speak"`. */
|
|
200
234
|
direction?: 'speak' | 'listen' | 'both'; /** Codec to use for the tap media stream. Possible Values: [`PCMU`, `PCMA`] Default is `"PCMU"`. */
|
|
@@ -204,6 +238,7 @@ declare module './SwmlBuilder.js' {
|
|
|
204
238
|
}): this;
|
|
205
239
|
/** Transfer the execution of the script to a different SWML section, URL, or Relay application. Once the transfer is complete, the script will continue executing SWML from the new location. */
|
|
206
240
|
transfer(config: {
|
|
241
|
+
/** Specifies where to transfer to. The value can be one of: - <section_name> - section in the SWML document to jump to - A URL (http or https) - URL to fetch next document from. Sends HTTP POST. Authentication can also be set in the URL in the format of username:password@url. - An inline SWML document (as a JSON string) */
|
|
207
242
|
dest: string; /** Named parameters to send to transfer destination. Accepts an object mapping variable names to values. Default is not set. */
|
|
208
243
|
params?: Record<string, unknown>; /** User data, ignored by SignalWire. Accepts an object mapping variable names to values. Default is not set. */
|
|
209
244
|
meta?: Record<string, unknown>;
|
|
@@ -212,6 +247,7 @@ declare module './SwmlBuilder.js' {
|
|
|
212
247
|
unset(config: Record<string, unknown> | number): this;
|
|
213
248
|
/** Enables secure payment processing during voice calls. When implemented, it manages the entire payment flow including data collection, validation, and processing through your configured payment gateway. */
|
|
214
249
|
pay(config: {
|
|
250
|
+
/** The URL to make POST requests with all the gathered payment details. This URL is used to process the final payment transaction and return the results through the response. Visit https://developer.signalwire.com/swml/methods/pay/payment_connector_url for more important information. */
|
|
215
251
|
payment_connector_url: string; /** The amount to charge against payment method passed in the request. `Float` value with no currency prefix passed as string. */
|
|
216
252
|
charge_amount?: string; /** Uses the ISO 4217 currency code of the charge amount. */
|
|
217
253
|
currency?: string; /** Custom description of the payment provided in the request. */
|
|
@@ -233,6 +269,7 @@ declare module './SwmlBuilder.js' {
|
|
|
233
269
|
}): this;
|
|
234
270
|
/** A detection method that combines AMD (Answering Machine Detection) and fax detection. Detect whether the user on the other end of the call is a machine (fax, voicemail, etc.) or a human. The detection result(s) will be sent to the specified status_url as a POST request and will also be saved in the detect_result variable. */
|
|
235
271
|
detect_machine(config?: {
|
|
272
|
+
/** If `true`, stops detection on beep / end of voicemail greeting. Default `false`. */
|
|
236
273
|
detect_message_end?: boolean; /** Comma-separated string of detectors to enable. Valid values: `amd`, `fax`. */
|
|
237
274
|
detectors?: string; /** How long to wait for voice to finish. Default `1.0`. */
|
|
238
275
|
end_silence_timeout?: number; /** How long to wait for initial voice before giving up. Default `4.5`. */
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* AUTO-GENERATED FILE — do not edit manually.
|
|
3
|
-
* Generated by: npx tsx
|
|
3
|
+
* Generated by: npx tsx scripts/generate-swml-verbs.ts
|
|
4
4
|
*
|
|
5
5
|
* Provides TypeScript interface augmentation for all SWML verb methods
|
|
6
6
|
* auto-installed on SwmlBuilder from schema.json.
|
package/dist/TypeInference.d.ts
CHANGED
|
@@ -6,6 +6,40 @@
|
|
|
6
6
|
* that unpack args dicts into named positional parameters.
|
|
7
7
|
*/
|
|
8
8
|
import type { SwaigHandler } from './SwaigFunction.js';
|
|
9
|
+
import type { FunctionResult } from './FunctionResult.js';
|
|
10
|
+
/**
|
|
11
|
+
* A typed SWAIG tool handler: a function the SDK introspects and wraps so it
|
|
12
|
+
* receives the AI-extracted arguments as *named positional parameters* (any
|
|
13
|
+
* arity, optionally with a trailing `rawData` record) rather than the raw
|
|
14
|
+
* `(args, rawData)` pair of {@link SwaigHandler}.
|
|
15
|
+
*
|
|
16
|
+
* This is the precise replacement for the bare `Function` type at the
|
|
17
|
+
* typed-tool sites: it constrains the value to a *callable whose return is a
|
|
18
|
+
* valid SWAIG result* (a {@link FunctionResult}, a `{ response }`-style record,
|
|
19
|
+
* or a string — sync or async), which `Function` does not — so a non-callable,
|
|
20
|
+
* or a callable returning `void`/`boolean`/etc., is now a compile-time error.
|
|
21
|
+
*
|
|
22
|
+
* Parameters are `...args: never[]` rather than `...unknown[]`: the handler's
|
|
23
|
+
* real parameters are user-named with arbitrary types (`(city: string, days =
|
|
24
|
+
* 5) => …`) and are recovered from `fn.toString()` by {@link inferSchema}, so
|
|
25
|
+
* the type must accept *any* concrete positional list. Under
|
|
26
|
+
* `strictFunctionTypes`, `never[]` makes the parameter position accept any
|
|
27
|
+
* function (every param type is a supertype of `never`) while still pinning the
|
|
28
|
+
* return type — exactly "callable returning a SWAIG result, params don't
|
|
29
|
+
* matter". (`...unknown[]` would wrongly REJECT a `(city: string) => …` handler,
|
|
30
|
+
* defeating the purpose.)
|
|
31
|
+
*/
|
|
32
|
+
export type TypedToolHandler = (...args: never[]) => FunctionResult | Record<string, unknown> | string | Promise<FunctionResult | Record<string, unknown> | string>;
|
|
33
|
+
/**
|
|
34
|
+
* A function the SDK *introspects* (reads `fn.toString()` to recover parameter
|
|
35
|
+
* names/defaults) but whose return value it does not consume. `inferSchema`
|
|
36
|
+
* only inspects the parameter list, so — unlike {@link TypedToolHandler} — its
|
|
37
|
+
* input is return-agnostic. Still a precise improvement over the bare
|
|
38
|
+
* `Function`: it is a *callable* (rejecting non-functions) with an arbitrary
|
|
39
|
+
* concrete parameter list (`...args: never[]` accepts any), and any return.
|
|
40
|
+
* Every {@link TypedToolHandler} is assignable to it.
|
|
41
|
+
*/
|
|
42
|
+
export type IntrospectableFn = (...args: never[]) => unknown;
|
|
9
43
|
/** A parsed function parameter with optional default value. */
|
|
10
44
|
export interface ParsedParam {
|
|
11
45
|
name: string;
|
|
@@ -47,12 +81,14 @@ export declare function parseFunctionParams(source: string): ParsedParam[];
|
|
|
47
81
|
* - No default → `"string"` (and the parameter is marked required)
|
|
48
82
|
*
|
|
49
83
|
* @param fn - The function to inspect. Arrow functions, regular functions, and
|
|
50
|
-
* method shorthand all work.
|
|
84
|
+
* method shorthand all work. Typed as {@link IntrospectableFn} because only
|
|
85
|
+
* the parameter list is read — the handler's return is irrelevant to schema
|
|
86
|
+
* inference (a {@link TypedToolHandler} satisfies this).
|
|
51
87
|
* @returns An {@link InferredSchema} describing the parameters, or `null` when
|
|
52
88
|
* the function looks like an old-style `(args, rawData)` SWAIG handler (in
|
|
53
89
|
* which case no inference is attempted).
|
|
54
90
|
*/
|
|
55
|
-
export declare function inferSchema(fn:
|
|
91
|
+
export declare function inferSchema(fn: IntrospectableFn): InferredSchema | null;
|
|
56
92
|
/**
|
|
57
93
|
* Create a wrapper function that adapts a typed handler to the standard
|
|
58
94
|
* `(args, rawData) => result` SWAIG handler signature.
|
|
@@ -68,4 +104,4 @@ export declare function inferSchema(fn: Function): InferredSchema | null;
|
|
|
68
104
|
* @returns A {@link SwaigHandler} suitable for registration with
|
|
69
105
|
* {@link AgentBase.defineTool}.
|
|
70
106
|
*/
|
|
71
|
-
export declare function createTypedHandlerWrapper(fn:
|
|
107
|
+
export declare function createTypedHandlerWrapper(fn: TypedToolHandler, paramNames: string[], hasRawData: boolean): SwaigHandler;
|