@signalwire/sdk 2.0.5 → 3.6.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 +821 -0
- package/LICENSE +21 -0
- package/README.md +163 -68
- package/dist/AGENTS.md +13 -0
- package/dist/AgentBase.d.ts +510 -126
- package/dist/AgentBase.js +1581 -455
- 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 +186 -45
- package/dist/DataMap.js +210 -52
- package/dist/DataMap.js.map +1 -1
- package/dist/FunctionResult.d.ts +309 -83
- package/dist/FunctionResult.js +483 -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 +169 -59
- package/dist/SWMLService.js +456 -129
- 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/SemanticGate.d.ts +183 -0
- package/dist/SemanticGate.js +533 -0
- package/dist/SemanticGate.js.map +1 -0
- 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 +139 -7
- package/dist/SwaigFunction.js +170 -22
- 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 +920 -0
- package/dist/cli/tsdocs/topics.js.map +1 -0
- package/dist/index.d.ts +49 -68
- package/dist/index.js +45 -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 +111 -21
- 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 +3641 -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 +1207 -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 +1986 -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/SwaigFunction.d.ts
CHANGED
|
@@ -1,14 +1,87 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* SwaigFunction - Wraps a handler function with metadata for SWAIG registration.
|
|
3
3
|
*/
|
|
4
|
-
import { FunctionResult } from './FunctionResult.js';
|
|
4
|
+
import { FunctionResult, type SwaigResultDict } from './FunctionResult.js';
|
|
5
|
+
import type { SwaigRequest } from './SwaigContracts.js';
|
|
6
|
+
import type { AgentBase } from './AgentBase.js';
|
|
7
|
+
import { type FillerPhrases, type SemanticGate } from './SemanticGate.js';
|
|
8
|
+
/** @internal How many argument validators have been compiled (for tests). */
|
|
9
|
+
export declare function _compiledValidatorCount(): number;
|
|
10
|
+
/**
|
|
11
|
+
* Decide whether a `parameters` value is already a full JSON Schema object
|
|
12
|
+
* (`{ type: 'object', properties: {...} }`) versus a bare map of property
|
|
13
|
+
* definitions that must be wrapped.
|
|
14
|
+
*
|
|
15
|
+
* Robust discriminator: a value is a full schema ONLY when its `type` is the
|
|
16
|
+
* string `'object'` AND its `properties` is itself an object. The old check
|
|
17
|
+
* (`'type' in p && 'properties' in p`) misclassified a tool whose parameters
|
|
18
|
+
* are literally NAMED `type` and `properties`: for such a bare map the value of
|
|
19
|
+
* `type` is a property-definition object (not the string `'object'`), so this
|
|
20
|
+
* check correctly treats it as a bare properties map.
|
|
21
|
+
*
|
|
22
|
+
* @param parameters - The raw `parameters` value to inspect.
|
|
23
|
+
* @returns `true` if it is already a full JSON Schema object.
|
|
24
|
+
*/
|
|
25
|
+
export declare function isFullParameterSchema(parameters: Record<string, unknown>): boolean;
|
|
26
|
+
/**
|
|
27
|
+
* Normalize a tool's `parameters` into a full JSON Schema object suitable for
|
|
28
|
+
* SWAIG / MCP output.
|
|
29
|
+
*
|
|
30
|
+
* - An empty/absent map becomes `{ type: 'object', properties: {} }`.
|
|
31
|
+
* - An already-full schema (see {@link isFullParameterSchema}) is returned
|
|
32
|
+
* unchanged.
|
|
33
|
+
* - A bare properties map is wrapped as
|
|
34
|
+
* `{ type: 'object', properties: <map>, required?: <required> }`.
|
|
35
|
+
*
|
|
36
|
+
* This is the single source of truth for the `parameters` shape sniff that used
|
|
37
|
+
* to be reimplemented in SwaigFunction, AgentBase MCP tool listing, and the
|
|
38
|
+
* AgentBase SWAIG function table.
|
|
39
|
+
*
|
|
40
|
+
* @param parameters - The raw `parameters` value (bare properties map or full schema).
|
|
41
|
+
* @param required - Required-parameter names, applied only when wrapping a bare map.
|
|
42
|
+
* @returns A full JSON Schema object.
|
|
43
|
+
*/
|
|
44
|
+
export declare function normalizeParameters(parameters: Record<string, unknown> | undefined, required?: string[]): Record<string, unknown>;
|
|
5
45
|
/**
|
|
6
46
|
* Handler function for a SWAIG tool invocation.
|
|
7
47
|
* @param args - Parsed arguments extracted by the AI from user speech.
|
|
8
48
|
* @param rawData - The full raw request payload from SignalWire.
|
|
49
|
+
* @param agent - The agent running the call. With a dynamic config callback
|
|
50
|
+
* set, this is the request's configured copy, so the handler sees what the
|
|
51
|
+
* callback configured (the reference passes it as `self`). Undefined when a
|
|
52
|
+
* caller runs {@link SwaigFunction.execute} directly.
|
|
9
53
|
* @returns A FunctionResult, a plain object with a response key, a string, or a Promise of any of these.
|
|
10
54
|
*/
|
|
11
|
-
export type SwaigHandler = (args: Record<string, unknown>, rawData:
|
|
55
|
+
export type SwaigHandler = (args: Record<string, unknown>, rawData: SwaigRequest, agent?: AgentBase) => FunctionResult | Record<string, unknown> | string | Promise<FunctionResult | Record<string, unknown> | string>;
|
|
56
|
+
/**
|
|
57
|
+
* Context passed to an {@link SwaigErrorHandler} when a tool handler throws.
|
|
58
|
+
*/
|
|
59
|
+
export interface SwaigErrorContext {
|
|
60
|
+
/** Name of the tool whose handler threw. */
|
|
61
|
+
functionName: string;
|
|
62
|
+
/** The parsed arguments the handler was invoked with. */
|
|
63
|
+
args: Record<string, unknown>;
|
|
64
|
+
/** The full raw request payload (if available). */
|
|
65
|
+
rawData?: SwaigRequest;
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* Hook invoked when a SWAIG tool handler throws. Lets authors observe the
|
|
69
|
+
* failure (report to Sentry/Datadog, log with full context) and optionally
|
|
70
|
+
* decide the user-facing response.
|
|
71
|
+
*
|
|
72
|
+
* - Return a {@link FunctionResult} to control exactly what the AI receives.
|
|
73
|
+
* - Return `void`/`undefined` to fall back to the default error response.
|
|
74
|
+
*
|
|
75
|
+
* The error is always contained — a thrown handler never propagates to the
|
|
76
|
+
* HTTP layer (that would break the live call). This hook makes the containment
|
|
77
|
+
* *observable and configurable* instead of opaque.
|
|
78
|
+
*/
|
|
79
|
+
export type SwaigErrorHandler = (error: unknown, context: SwaigErrorContext) => FunctionResult | void | Promise<FunctionResult | void>;
|
|
80
|
+
/**
|
|
81
|
+
* Default user-facing message returned when a tool handler throws and no
|
|
82
|
+
* {@link SwaigErrorHandler} supplies its own response.
|
|
83
|
+
*/
|
|
84
|
+
export declare const DEFAULT_SWAIG_ERROR_MESSAGE = "Sorry, I couldn't complete that action. Please try again or contact support if the issue persists.";
|
|
12
85
|
/** Configuration options for creating a SwaigFunction. */
|
|
13
86
|
export interface SwaigFunctionOptions {
|
|
14
87
|
/** Unique name used to register and invoke this tool. */
|
|
@@ -19,14 +92,47 @@ export interface SwaigFunctionOptions {
|
|
|
19
92
|
description: string;
|
|
20
93
|
/** JSON Schema properties describing the tool's parameters. */
|
|
21
94
|
parameters?: Record<string, unknown>;
|
|
22
|
-
/**
|
|
95
|
+
/**
|
|
96
|
+
* Whether this tool requires session token authentication.
|
|
97
|
+
*
|
|
98
|
+
* **Defaults to `true` — secure by default.** A tool registered without an
|
|
99
|
+
* explicit `secure` requires SWAIG token validation, and its rendered SWML
|
|
100
|
+
* webhook carries a per-tool `__token`. Pass `secure: false` only to
|
|
101
|
+
* deliberately expose a tool on the unauthenticated shared webhook URL.
|
|
102
|
+
*
|
|
103
|
+
* **Python equivalent:** `define_tool(..., secure: bool = True)` — every
|
|
104
|
+
* user-facing entry point in the reference (`ToolMixin.define_tool`,
|
|
105
|
+
* `ToolRegistry.define_tool`, the `@AgentBase.tool()` decorator) defaults
|
|
106
|
+
* `secure=True`.
|
|
107
|
+
*/
|
|
23
108
|
secure?: boolean;
|
|
24
|
-
/**
|
|
109
|
+
/**
|
|
110
|
+
* Phrases the AI says while the function runs, keyed by language code,
|
|
111
|
+
* `"auto"` (translated into the call's language on first use) or
|
|
112
|
+
* `"default"`. An entry may also be a list of phrases, a wait script, spoken
|
|
113
|
+
* one at a time while the call waits; the type predates wait scripts, so one needs a cast (the platform
|
|
114
|
+
* accepts it). {@link gateFillers} is typed for both.
|
|
115
|
+
*/
|
|
25
116
|
fillers?: Record<string, string[]>;
|
|
26
117
|
/** Audio file URL to play while waiting for the tool to complete. */
|
|
27
118
|
waitFile?: string;
|
|
28
119
|
/** Number of times to loop the wait file. */
|
|
29
120
|
waitFileLoops?: number;
|
|
121
|
+
/**
|
|
122
|
+
* Semantic gates, 1 to 8 {@link SemanticGate} objects or gate objects:
|
|
123
|
+
* yes/no preconditions a decision model checks right before the platform
|
|
124
|
+
* dispatches the function. When one fails, the function doesn't run and the
|
|
125
|
+
* model gets that gate's `on_fail` output. The fillers and wait file start
|
|
126
|
+
* only once the gates pass. Checked by the platform's rules when the tool is
|
|
127
|
+
* defined. A platform release without semantic gates runs the function
|
|
128
|
+
* ungated.
|
|
129
|
+
*/
|
|
130
|
+
gates?: ReadonlyArray<SemanticGate | Record<string, unknown>>;
|
|
131
|
+
/**
|
|
132
|
+
* Phrases the AI says while the gates are checked, shaped like
|
|
133
|
+
* {@link fillers}. Only with {@link gates}.
|
|
134
|
+
*/
|
|
135
|
+
gateFillers?: FillerPhrases;
|
|
30
136
|
/** External webhook URL; makes this an externally-hosted tool. */
|
|
31
137
|
webhookUrl?: string;
|
|
32
138
|
/** List of required parameter names. */
|
|
@@ -52,6 +158,17 @@ export interface SwaigFunctionOptions {
|
|
|
52
158
|
extraFields?: Record<string, unknown>;
|
|
53
159
|
/** Whether this tool uses a typed handler with named parameters. */
|
|
54
160
|
isTypedHandler?: boolean;
|
|
161
|
+
/**
|
|
162
|
+
* Per-tool error hook. Invoked when this tool's handler throws, before the
|
|
163
|
+
* default error response is produced. See {@link SwaigErrorHandler}.
|
|
164
|
+
*/
|
|
165
|
+
onError?: SwaigErrorHandler;
|
|
166
|
+
/**
|
|
167
|
+
* Per-tool override for the user-facing message returned when the handler
|
|
168
|
+
* throws and no {@link onError} hook supplies a response. Defaults to
|
|
169
|
+
* {@link DEFAULT_SWAIG_ERROR_MESSAGE}.
|
|
170
|
+
*/
|
|
171
|
+
errorMessage?: string;
|
|
55
172
|
}
|
|
56
173
|
/**
|
|
57
174
|
* A SWAIG function — exactly the same concept as a "tool" in native
|
|
@@ -95,7 +212,7 @@ export declare class SwaigFunction {
|
|
|
95
212
|
parameters: Record<string, unknown>;
|
|
96
213
|
/** Whether this tool requires session token authentication. */
|
|
97
214
|
secure: boolean;
|
|
98
|
-
/**
|
|
215
|
+
/** Phrases the AI says while the function runs (see {@link SwaigFunctionOptions.fillers}). */
|
|
99
216
|
fillers?: Record<string, string[]>;
|
|
100
217
|
/** Audio file URL to play while waiting for the tool to complete. */
|
|
101
218
|
waitFile?: string;
|
|
@@ -111,6 +228,10 @@ export declare class SwaigFunction {
|
|
|
111
228
|
isTypedHandler: boolean;
|
|
112
229
|
/** Whether this tool is externally hosted (has a webhookUrl). */
|
|
113
230
|
isExternal: boolean;
|
|
231
|
+
/** Per-tool error hook; see {@link SwaigErrorHandler}. */
|
|
232
|
+
onError?: SwaigErrorHandler;
|
|
233
|
+
/** Per-tool user-facing error message override. */
|
|
234
|
+
errorMessage?: string;
|
|
114
235
|
/**
|
|
115
236
|
* Create a new SwaigFunction.
|
|
116
237
|
*
|
|
@@ -119,7 +240,11 @@ export declare class SwaigFunction {
|
|
|
119
240
|
* (e.g. `meta_data_token`, `web_hook_auth_user`, `web_hook_auth_password`).
|
|
120
241
|
* This mirrors the Python constructor's `**extra_swaig_fields` kwargs:
|
|
121
242
|
* both are merged directly into the serialized SWAIG definition, so the
|
|
122
|
-
* wire format is identical — only the call-site syntax differs.
|
|
243
|
+
* wire format is identical — only the call-site syntax differs. `gates`
|
|
244
|
+
* and `gate_fillers` there are checked like `opts.gates` and
|
|
245
|
+
* `opts.gateFillers`.
|
|
246
|
+
* @throws {Error} For gates the platform would refuse, or gate fillers
|
|
247
|
+
* without gates.
|
|
123
248
|
*/
|
|
124
249
|
constructor(opts: SwaigFunctionOptions);
|
|
125
250
|
private ensureParameterStructure;
|
|
@@ -147,7 +272,14 @@ export declare class SwaigFunction {
|
|
|
147
272
|
* @param rawData - The full raw request payload.
|
|
148
273
|
* @returns A serialized result dictionary suitable for the SWAIG response.
|
|
149
274
|
*/
|
|
150
|
-
execute(args: Record<string, unknown>, rawData?:
|
|
275
|
+
execute(args: Record<string, unknown>, rawData?: SwaigRequest, agentOnError?: SwaigErrorHandler): Promise<SwaigResultDict>;
|
|
276
|
+
/**
|
|
277
|
+
* {@link execute}, passing `agent` to the handler as its third argument: the
|
|
278
|
+
* agent running the call, which with a dynamic config callback is the
|
|
279
|
+
* request's configured copy.
|
|
280
|
+
* @internal
|
|
281
|
+
*/
|
|
282
|
+
_executeAs(agent: AgentBase | undefined, args: Record<string, unknown>, rawData?: SwaigRequest, agentOnError?: SwaigErrorHandler): Promise<SwaigResultDict>;
|
|
151
283
|
/**
|
|
152
284
|
* Serialize this function to the SWAIG wire format for inclusion in SWML.
|
|
153
285
|
* @param baseUrl - The base URL of the agent server.
|
package/dist/SwaigFunction.js
CHANGED
|
@@ -4,8 +4,95 @@
|
|
|
4
4
|
import Ajv from 'ajv';
|
|
5
5
|
import { FunctionResult } from './FunctionResult.js';
|
|
6
6
|
import { getLogger } from './Logger.js';
|
|
7
|
+
import { applyGateFields, _checkGatedFunction, } from './SemanticGate.js';
|
|
7
8
|
const ajv = new Ajv({ allErrors: true });
|
|
9
|
+
/**
|
|
10
|
+
* Compiled argument validators, keyed by the schema's JSON, so every call of
|
|
11
|
+
* a tool (and of its per-request copies) reuses one. Bounded: the oldest
|
|
12
|
+
* entry goes when it's full. Each schema is removed from Ajv's own cache
|
|
13
|
+
* once compiled, so only this map holds it.
|
|
14
|
+
*/
|
|
15
|
+
const VALIDATOR_CACHE_LIMIT = 500;
|
|
16
|
+
const compiledValidators = new Map();
|
|
17
|
+
let compileCount = 0;
|
|
18
|
+
function validatorFor(schema) {
|
|
19
|
+
const key = JSON.stringify(schema);
|
|
20
|
+
const cached = compiledValidators.get(key);
|
|
21
|
+
if (cached)
|
|
22
|
+
return cached;
|
|
23
|
+
const validate = ajv.compile(schema);
|
|
24
|
+
ajv.removeSchema(schema);
|
|
25
|
+
compileCount += 1;
|
|
26
|
+
if (compiledValidators.size >= VALIDATOR_CACHE_LIMIT) {
|
|
27
|
+
compiledValidators.delete(compiledValidators.keys().next().value);
|
|
28
|
+
}
|
|
29
|
+
compiledValidators.set(key, validate);
|
|
30
|
+
return validate;
|
|
31
|
+
}
|
|
32
|
+
/** @internal How many argument validators have been compiled (for tests). */
|
|
33
|
+
export function _compiledValidatorCount() {
|
|
34
|
+
return compileCount;
|
|
35
|
+
}
|
|
8
36
|
const log = getLogger('SwaigFunction');
|
|
37
|
+
/**
|
|
38
|
+
* Decide whether a `parameters` value is already a full JSON Schema object
|
|
39
|
+
* (`{ type: 'object', properties: {...} }`) versus a bare map of property
|
|
40
|
+
* definitions that must be wrapped.
|
|
41
|
+
*
|
|
42
|
+
* Robust discriminator: a value is a full schema ONLY when its `type` is the
|
|
43
|
+
* string `'object'` AND its `properties` is itself an object. The old check
|
|
44
|
+
* (`'type' in p && 'properties' in p`) misclassified a tool whose parameters
|
|
45
|
+
* are literally NAMED `type` and `properties`: for such a bare map the value of
|
|
46
|
+
* `type` is a property-definition object (not the string `'object'`), so this
|
|
47
|
+
* check correctly treats it as a bare properties map.
|
|
48
|
+
*
|
|
49
|
+
* @param parameters - The raw `parameters` value to inspect.
|
|
50
|
+
* @returns `true` if it is already a full JSON Schema object.
|
|
51
|
+
*/
|
|
52
|
+
export function isFullParameterSchema(parameters) {
|
|
53
|
+
const props = parameters.properties;
|
|
54
|
+
return (parameters.type === 'object' &&
|
|
55
|
+
typeof props === 'object' &&
|
|
56
|
+
props !== null);
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* Normalize a tool's `parameters` into a full JSON Schema object suitable for
|
|
60
|
+
* SWAIG / MCP output.
|
|
61
|
+
*
|
|
62
|
+
* - An empty/absent map becomes `{ type: 'object', properties: {} }`.
|
|
63
|
+
* - An already-full schema (see {@link isFullParameterSchema}) is returned
|
|
64
|
+
* unchanged.
|
|
65
|
+
* - A bare properties map is wrapped as
|
|
66
|
+
* `{ type: 'object', properties: <map>, required?: <required> }`.
|
|
67
|
+
*
|
|
68
|
+
* This is the single source of truth for the `parameters` shape sniff that used
|
|
69
|
+
* to be reimplemented in SwaigFunction, AgentBase MCP tool listing, and the
|
|
70
|
+
* AgentBase SWAIG function table.
|
|
71
|
+
*
|
|
72
|
+
* @param parameters - The raw `parameters` value (bare properties map or full schema).
|
|
73
|
+
* @param required - Required-parameter names, applied only when wrapping a bare map.
|
|
74
|
+
* @returns A full JSON Schema object.
|
|
75
|
+
*/
|
|
76
|
+
export function normalizeParameters(parameters, required = []) {
|
|
77
|
+
if (!parameters || Object.keys(parameters).length === 0) {
|
|
78
|
+
return { type: 'object', properties: {} };
|
|
79
|
+
}
|
|
80
|
+
if (isFullParameterSchema(parameters)) {
|
|
81
|
+
return parameters;
|
|
82
|
+
}
|
|
83
|
+
const result = {
|
|
84
|
+
type: 'object',
|
|
85
|
+
properties: parameters,
|
|
86
|
+
};
|
|
87
|
+
if (required.length)
|
|
88
|
+
result['required'] = required;
|
|
89
|
+
return result;
|
|
90
|
+
}
|
|
91
|
+
/**
|
|
92
|
+
* Default user-facing message returned when a tool handler throws and no
|
|
93
|
+
* {@link SwaigErrorHandler} supplies its own response.
|
|
94
|
+
*/
|
|
95
|
+
export const DEFAULT_SWAIG_ERROR_MESSAGE = "Sorry, I couldn't complete that action. Please try again or contact support if the issue persists.";
|
|
9
96
|
/**
|
|
10
97
|
* A SWAIG function — exactly the same concept as a "tool" in native
|
|
11
98
|
* OpenAI / Anthropic tool calling.
|
|
@@ -48,7 +135,7 @@ export class SwaigFunction {
|
|
|
48
135
|
parameters;
|
|
49
136
|
/** Whether this tool requires session token authentication. */
|
|
50
137
|
secure;
|
|
51
|
-
/**
|
|
138
|
+
/** Phrases the AI says while the function runs (see {@link SwaigFunctionOptions.fillers}). */
|
|
52
139
|
fillers;
|
|
53
140
|
/** Audio file URL to play while waiting for the tool to complete. */
|
|
54
141
|
waitFile;
|
|
@@ -64,6 +151,10 @@ export class SwaigFunction {
|
|
|
64
151
|
isTypedHandler;
|
|
65
152
|
/** Whether this tool is externally hosted (has a webhookUrl). */
|
|
66
153
|
isExternal;
|
|
154
|
+
/** Per-tool error hook; see {@link SwaigErrorHandler}. */
|
|
155
|
+
onError;
|
|
156
|
+
/** Per-tool user-facing error message override. */
|
|
157
|
+
errorMessage;
|
|
67
158
|
/**
|
|
68
159
|
* Create a new SwaigFunction.
|
|
69
160
|
*
|
|
@@ -72,37 +163,45 @@ export class SwaigFunction {
|
|
|
72
163
|
* (e.g. `meta_data_token`, `web_hook_auth_user`, `web_hook_auth_password`).
|
|
73
164
|
* This mirrors the Python constructor's `**extra_swaig_fields` kwargs:
|
|
74
165
|
* both are merged directly into the serialized SWAIG definition, so the
|
|
75
|
-
* wire format is identical — only the call-site syntax differs.
|
|
166
|
+
* wire format is identical — only the call-site syntax differs. `gates`
|
|
167
|
+
* and `gate_fillers` there are checked like `opts.gates` and
|
|
168
|
+
* `opts.gateFillers`.
|
|
169
|
+
* @throws {Error} For gates the platform would refuse, or gate fillers
|
|
170
|
+
* without gates.
|
|
76
171
|
*/
|
|
77
172
|
constructor(opts) {
|
|
78
173
|
this.name = opts.name;
|
|
79
174
|
this.handler = opts.handler;
|
|
80
175
|
this.description = opts.description;
|
|
81
176
|
this.parameters = opts.parameters ?? {};
|
|
82
|
-
|
|
177
|
+
// SECURE BY DEFAULT (A1): a tool registered without an explicit `secure`
|
|
178
|
+
// requires token validation, and renderSwml mints its per-tool `__token`.
|
|
179
|
+
// Matches the reference's user-facing `define_tool(..., secure=True)`
|
|
180
|
+
// (tool_mixin.py:37 / tools/registry.py:42 / tools/decorator.py:95).
|
|
181
|
+
this.secure = opts.secure ?? true;
|
|
83
182
|
this.fillers = opts.fillers;
|
|
84
183
|
this.waitFile = opts.waitFile;
|
|
85
184
|
this.waitFileLoops = opts.waitFileLoops;
|
|
86
185
|
this.webhookUrl = opts.webhookUrl;
|
|
87
186
|
this.required = opts.required ?? [];
|
|
88
|
-
|
|
187
|
+
// Gates given as options, or among the extra fields, are checked by the
|
|
188
|
+
// platform's rules under the name the function is sent with.
|
|
189
|
+
this.extraFields = { ...(opts.extraFields ?? {}) };
|
|
190
|
+
if (opts.gates !== undefined)
|
|
191
|
+
this.extraFields['gates'] = opts.gates;
|
|
192
|
+
if (opts.gateFillers !== undefined)
|
|
193
|
+
this.extraFields['gate_fillers'] = opts.gateFillers;
|
|
194
|
+
if ('gates' in this.extraFields || 'gate_fillers' in this.extraFields) {
|
|
195
|
+
const sentName = this.extraFields['function'];
|
|
196
|
+
applyGateFields(this.extraFields, typeof sentName === 'string' ? sentName : this.name);
|
|
197
|
+
}
|
|
89
198
|
this.isTypedHandler = opts.isTypedHandler ?? false;
|
|
90
199
|
this.isExternal = opts.webhookUrl !== undefined;
|
|
200
|
+
this.onError = opts.onError;
|
|
201
|
+
this.errorMessage = opts.errorMessage;
|
|
91
202
|
}
|
|
92
203
|
ensureParameterStructure() {
|
|
93
|
-
|
|
94
|
-
return { type: 'object', properties: {} };
|
|
95
|
-
}
|
|
96
|
-
if ('type' in this.parameters && 'properties' in this.parameters) {
|
|
97
|
-
return this.parameters;
|
|
98
|
-
}
|
|
99
|
-
const result = {
|
|
100
|
-
type: 'object',
|
|
101
|
-
properties: this.parameters,
|
|
102
|
-
};
|
|
103
|
-
if (this.required.length)
|
|
104
|
-
result['required'] = this.required;
|
|
105
|
-
return result;
|
|
204
|
+
return normalizeParameters(this.parameters, this.required);
|
|
106
205
|
}
|
|
107
206
|
/**
|
|
108
207
|
* Validate arguments against the parameter JSON schema using full
|
|
@@ -127,7 +226,7 @@ export class SwaigFunction {
|
|
|
127
226
|
if (!properties || Object.keys(properties).length === 0) {
|
|
128
227
|
return [true, []];
|
|
129
228
|
}
|
|
130
|
-
const validate =
|
|
229
|
+
const validate = validatorFor(schema);
|
|
131
230
|
const valid = validate(args);
|
|
132
231
|
if (valid) {
|
|
133
232
|
return [true, []];
|
|
@@ -146,9 +245,34 @@ export class SwaigFunction {
|
|
|
146
245
|
* @param rawData - The full raw request payload.
|
|
147
246
|
* @returns A serialized result dictionary suitable for the SWAIG response.
|
|
148
247
|
*/
|
|
149
|
-
async execute(args, rawData) {
|
|
248
|
+
async execute(args, rawData, agentOnError) {
|
|
249
|
+
return this._executeAs(undefined, args, rawData, agentOnError);
|
|
250
|
+
}
|
|
251
|
+
/**
|
|
252
|
+
* {@link execute}, passing `agent` to the handler as its third argument: the
|
|
253
|
+
* agent running the call, which with a dynamic config callback is the
|
|
254
|
+
* request's configured copy.
|
|
255
|
+
* @internal
|
|
256
|
+
*/
|
|
257
|
+
async _executeAs(agent, args, rawData, agentOnError) {
|
|
258
|
+
// Soft validation, as the reference's tool_mixin does: arguments that
|
|
259
|
+
// don't match the schema are logged, and the handler still runs.
|
|
260
|
+
if (args && Object.keys(args).length > 0) {
|
|
261
|
+
try {
|
|
262
|
+
const [valid, errors] = this.validateArgs(args);
|
|
263
|
+
if (!valid) {
|
|
264
|
+
log.warn(`Argument validation failed for function '${this.name}': ${errors.join('; ')}`);
|
|
265
|
+
}
|
|
266
|
+
}
|
|
267
|
+
catch (err) {
|
|
268
|
+
log.debug(`Argument validation error for function '${this.name}': ${err instanceof Error ? err.message : String(err)}`);
|
|
269
|
+
}
|
|
270
|
+
}
|
|
150
271
|
try {
|
|
151
|
-
|
|
272
|
+
// Runtime fallback is the empty object (unchanged); the cast is
|
|
273
|
+
// compile-time only — the backend always sends the full payload, but
|
|
274
|
+
// `execute` allows callers to omit it (e.g. CLI/test harnesses).
|
|
275
|
+
const result = await this.handler(args, rawData ?? {}, agent);
|
|
152
276
|
if (result instanceof FunctionResult) {
|
|
153
277
|
return result.toDict();
|
|
154
278
|
}
|
|
@@ -159,6 +283,8 @@ export class SwaigFunction {
|
|
|
159
283
|
return new FunctionResult('Function completed successfully').toDict();
|
|
160
284
|
}
|
|
161
285
|
if (typeof result === 'object' && result !== null) {
|
|
286
|
+
// Handler returned a plain object that already carries a `response`
|
|
287
|
+
// key — it IS the SWAIG response dict; pass it through unchanged.
|
|
162
288
|
return result;
|
|
163
289
|
}
|
|
164
290
|
// Neither a FunctionResult nor a dict — warn and fall back to
|
|
@@ -172,8 +298,29 @@ export class SwaigFunction {
|
|
|
172
298
|
return new FunctionResult(String(result)).toDict();
|
|
173
299
|
}
|
|
174
300
|
catch (err) {
|
|
175
|
-
|
|
176
|
-
|
|
301
|
+
// Preserve the stack for Error instances (plain `${err}` discards it).
|
|
302
|
+
const detail = err instanceof Error ? (err.stack ?? `${err.name}: ${err.message}`) : String(err);
|
|
303
|
+
log.error(`Error executing SWAIG function ${this.name}: ${detail}`);
|
|
304
|
+
// Give authors a programmatic surface: per-tool hook first, then the
|
|
305
|
+
// agent-level hook. Either may return a FunctionResult to control what
|
|
306
|
+
// the AI sees; if a hook itself throws, that's logged and we continue to
|
|
307
|
+
// the next fallback (the error is always contained — a thrown handler
|
|
308
|
+
// must never break the live call).
|
|
309
|
+
const ctx = { functionName: this.name, args, rawData };
|
|
310
|
+
for (const hook of [this.onError, agentOnError]) {
|
|
311
|
+
if (!hook)
|
|
312
|
+
continue;
|
|
313
|
+
try {
|
|
314
|
+
const handled = await hook(err, ctx);
|
|
315
|
+
if (handled instanceof FunctionResult) {
|
|
316
|
+
return handled.toDict();
|
|
317
|
+
}
|
|
318
|
+
}
|
|
319
|
+
catch (hookErr) {
|
|
320
|
+
log.error(`onError hook for SWAIG function ${this.name} threw: ${hookErr}`);
|
|
321
|
+
}
|
|
322
|
+
}
|
|
323
|
+
return new FunctionResult(this.errorMessage ?? DEFAULT_SWAIG_ERROR_MESSAGE).toDict();
|
|
177
324
|
}
|
|
178
325
|
}
|
|
179
326
|
/**
|
|
@@ -203,6 +350,7 @@ export class SwaigFunction {
|
|
|
203
350
|
if (this.waitFileLoops !== undefined)
|
|
204
351
|
def['wait_file_loops'] = this.waitFileLoops;
|
|
205
352
|
Object.assign(def, this.extraFields);
|
|
353
|
+
_checkGatedFunction(def);
|
|
206
354
|
return def;
|
|
207
355
|
}
|
|
208
356
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SwaigFunction.js","sourceRoot":"","sources":["../src/SwaigFunction.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,GAAG,MAAM,KAAK,CAAC;AACtB,OAAO,EAAE,cAAc,
|
|
1
|
+
{"version":3,"file":"SwaigFunction.js","sourceRoot":"","sources":["../src/SwaigFunction.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,GAAG,MAAM,KAAK,CAAC;AACtB,OAAO,EAAE,cAAc,EAAwB,MAAM,qBAAqB,CAAC;AAC3E,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC,OAAO,EACL,eAAe,EACf,mBAAmB,GAGpB,MAAM,mBAAmB,CAAC;AAE3B,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;AAEzC;;;;;GAKG;AACH,MAAM,qBAAqB,GAAG,GAAG,CAAC;AAClC,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAA0C,CAAC;AAC7E,IAAI,YAAY,GAAG,CAAC,CAAC;AAErB,SAAS,YAAY,CAAC,MAA+B;IACnD,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IACnC,MAAM,MAAM,GAAG,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC3C,IAAI,MAAM;QAAE,OAAO,MAAM,CAAC;IAC1B,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACrC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IACzB,YAAY,IAAI,CAAC,CAAC;IAClB,IAAI,kBAAkB,CAAC,IAAI,IAAI,qBAAqB,EAAE,CAAC;QACrD,kBAAkB,CAAC,MAAM,CAAC,kBAAkB,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,KAAM,CAAC,CAAC;IACrE,CAAC;IACD,kBAAkB,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IACtC,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,6EAA6E;AAC7E,MAAM,UAAU,uBAAuB;IACrC,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,MAAM,GAAG,GAAG,SAAS,CAAC,eAAe,CAAC,CAAC;AAEvC;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,qBAAqB,CAAC,UAAmC;IACvE,MAAM,KAAK,GAAI,UAAuC,CAAC,UAAU,CAAC;IAClE,OAAO,CACJ,UAAiC,CAAC,IAAI,KAAK,QAAQ;QACpD,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI,CACf,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,mBAAmB,CACjC,UAA+C,EAC/C,WAAqB,EAAE;IAEvB,IAAI,CAAC,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;IAC5C,CAAC;IACD,IAAI,qBAAqB,CAAC,UAAU,CAAC,EAAE,CAAC;QACtC,OAAO,UAAU,CAAC;IACpB,CAAC;IACD,MAAM,MAAM,GAA4B;QACtC,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE,UAAU;KACvB,CAAC;IACF,IAAI,QAAQ,CAAC,MAAM;QAAE,MAAM,CAAC,UAAU,CAAC,GAAG,QAAQ,CAAC;IACnD,OAAO,MAAM,CAAC;AAChB,CAAC;AAmDD;;;GAGG;AACH,MAAM,CAAC,MAAM,2BAA2B,GACtC,oGAAoG,CAAC;AA2FvG;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,OAAO,aAAa;IACxB,2DAA2D;IAC3D,IAAI,CAAS;IACb,4DAA4D;IAC5D,OAAO,CAAe;IACtB;;;;OAIG;IACH,WAAW,CAAS;IACpB;;;;OAIG;IACH,UAAU,CAA0B;IACpC,+DAA+D;IAC/D,MAAM,CAAU;IAChB,8FAA8F;IAC9F,OAAO,CAA4B;IACnC,qEAAqE;IACrE,QAAQ,CAAU;IAClB,6CAA6C;IAC7C,aAAa,CAAU;IACvB,oEAAoE;IACpE,UAAU,CAAU;IACpB,wCAAwC;IACxC,QAAQ,CAAW;IACnB,iEAAiE;IACjE,WAAW,CAA0B;IACrC,oEAAoE;IACpE,cAAc,CAAU;IACxB,iEAAiE;IACjE,UAAU,CAAU;IACpB,0DAA0D;IAC1D,OAAO,CAAqB;IAC5B,mDAAmD;IACnD,YAAY,CAAU;IAEtB;;;;;;;;;;;;;OAaG;IACH,YAAY,IAA0B;QACpC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC5B,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACpC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,EAAE,CAAC;QACxC,yEAAyE;QACzE,0EAA0E;QAC1E,sEAAsE;QACtE,qEAAqE;QACrE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC;QAClC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC5B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC9B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QACxC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QAClC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAC;QACpC,wEAAwE;QACxE,6DAA6D;QAC7D,IAAI,CAAC,WAAW,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC,EAAE,CAAC;QACnD,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS;YAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC;QACrE,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS;YAAE,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC;QACxF,IAAI,OAAO,IAAI,IAAI,CAAC,WAAW,IAAI,cAAc,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACtE,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;YAC9C,eAAe,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzF,CAAC;QACD,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,IAAI,KAAK,CAAC;QACnD,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC;QAChD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC5B,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;IACxC,CAAC;IAEO,wBAAwB;QAC9B,OAAO,mBAAmB,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,CAAC,IAA6B;QACxC,MAAM,MAAM,GAAG,IAAI,CAAC,wBAAwB,EAAE,CAAC;QAC/C,MAAM,UAAU,GAAG,MAAM,CAAC,YAAY,CAAwC,CAAC;QAC/E,IAAI,CAAC,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACxD,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACpB,CAAC;QAED,MAAM,QAAQ,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;QACtC,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC7B,IAAI,KAAK,EAAE,CAAC;YACV,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACpB,CAAC;QACD,MAAM,MAAM,GAAG,CAAC,QAAQ,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YAC/C,mDAAmD;YACnD,+DAA+D;YAC/D,MAAM,IAAI,GAAG,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACzF,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACpE,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACzB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO,CACX,IAA6B,EAC7B,OAAsB,EACtB,YAAgC;QAEhC,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC;IACjE,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAU,CACd,KAA4B,EAC5B,IAA6B,EAC7B,OAAsB,EACtB,YAAgC;QAEhC,sEAAsE;QACtE,iEAAiE;QACjE,IAAI,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzC,IAAI,CAAC;gBACH,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;gBAChD,IAAI,CAAC,KAAK,EAAE,CAAC;oBACX,GAAG,CAAC,IAAI,CAAC,4CAA4C,IAAI,CAAC,IAAI,MAAM,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBAC3F,CAAC;YACH,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,GAAG,CAAC,KAAK,CACP,2CAA2C,IAAI,CAAC,IAAI,MAAM,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAC7G,CAAC;YACJ,CAAC;QACH,CAAC;QACD,IAAI,CAAC;YACH,gEAAgE;YAChE,qEAAqE;YACrE,iEAAiE;YACjE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,IAAK,EAAmB,EAAE,KAAK,CAAC,CAAC;YAChF,IAAI,MAAM,YAAY,cAAc,EAAE,CAAC;gBACrC,OAAO,MAAM,CAAC,MAAM,EAAE,CAAC;YACzB,CAAC;YACD,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,IAAI,CAAC,CAAC,UAAU,IAAI,MAAM,CAAC,EAAE,CAAC;gBAC7E,qEAAqE;gBACrE,sGAAsG;gBACtG,yDAAyD;gBACzD,OAAO,IAAI,cAAc,CAAC,iCAAiC,CAAC,CAAC,MAAM,EAAE,CAAC;YACxE,CAAC;YACD,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;gBAClD,oEAAoE;gBACpE,kEAAkE;gBAClE,OAAO,MAAyB,CAAC;YACnC,CAAC;YACD,8DAA8D;YAC9D,2DAA2D;YAC3D,0DAA0D;YAC1D,GAAG,CAAC,IAAI,CACN,mBAAmB,IAAI,CAAC,IAAI,+BAA+B,OAAO,MAAM,IAAI;gBAC1E,0EAA0E;gBAC1E,wEAAwE;gBACxE,wEAAwE;gBACxE,iBAAiB,CACpB,CAAC;YACF,OAAO,IAAI,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;QACrD,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,uEAAuE;YACvE,MAAM,MAAM,GACV,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,IAAI,GAAG,GAAG,CAAC,IAAI,KAAK,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACpF,GAAG,CAAC,KAAK,CAAC,kCAAkC,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC,CAAC;YAEpE,qEAAqE;YACrE,uEAAuE;YACvE,yEAAyE;YACzE,sEAAsE;YACtE,mCAAmC;YACnC,MAAM,GAAG,GAAsB,EAAE,YAAY,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;YAC1E,KAAK,MAAM,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,YAAY,CAAC,EAAE,CAAC;gBAChD,IAAI,CAAC,IAAI;oBAAE,SAAS;gBACpB,IAAI,CAAC;oBACH,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;oBACrC,IAAI,OAAO,YAAY,cAAc,EAAE,CAAC;wBACtC,OAAO,OAAO,CAAC,MAAM,EAAE,CAAC;oBAC1B,CAAC;gBACH,CAAC;gBAAC,OAAO,OAAO,EAAE,CAAC;oBACjB,GAAG,CAAC,KAAK,CAAC,mCAAmC,IAAI,CAAC,IAAI,WAAW,OAAO,EAAE,CAAC,CAAC;gBAC9E,CAAC;YACH,CAAC;YAED,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,YAAY,IAAI,2BAA2B,CAAC,CAAC,MAAM,EAAE,CAAC;QACvF,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,OAAO,CAAC,OAAe,EAAE,KAAc,EAAE,MAAe;QACtD,IAAI,GAAG,GAAG,GAAG,OAAO,QAAQ,CAAC;QAC7B,IAAI,KAAK,IAAI,MAAM,EAAE,CAAC;YACpB,GAAG,GAAG,GAAG,GAAG,UAAU,KAAK,YAAY,MAAM,EAAE,CAAC;QAClD,CAAC;QACD,MAAM,GAAG,GAA4B;YACnC,QAAQ,EAAE,IAAI,CAAC,IAAI;YACnB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,UAAU,EAAE,IAAI,CAAC,wBAAwB,EAAE;SAC5C,CAAC;QACF,IAAI,GAAG;YAAE,GAAG,CAAC,cAAc,CAAC,GAAG,GAAG,CAAC;QACnC,IAAI,IAAI,CAAC,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzD,GAAG,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC;QAChC,CAAC;QACD,IAAI,IAAI,CAAC,QAAQ;YAAE,GAAG,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;QACpD,IAAI,IAAI,CAAC,aAAa,KAAK,SAAS;YAAE,GAAG,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC;QAClF,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACrC,mBAAmB,CAAC,GAAG,CAAC,CAAC;QACzB,OAAO,GAAG,CAAC;IACb,CAAC;CACF"}
|
package/dist/SwmlBuilder.d.ts
CHANGED
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
* fluent chaining and call `addVerb()` internally.
|
|
9
9
|
*/
|
|
10
10
|
import { SchemaUtils } from './SchemaUtils.js';
|
|
11
|
+
import type { TtsGender } from './relay/closedSets.js';
|
|
11
12
|
import './SwmlVerbMethods.generated.js';
|
|
12
13
|
/** Options for constructing a SwmlBuilder. */
|
|
13
14
|
export interface SwmlBuilderOptions {
|
|
@@ -25,6 +26,26 @@ export interface SwmlBuilderOptions {
|
|
|
25
26
|
* a per-instance SchemaUtils loaded from this path instead of the bundled schema.
|
|
26
27
|
* Mirrors Python's `schema_path` constructor parameter on `SWMLService`/`AgentBase`. */
|
|
27
28
|
schemaPath?: string;
|
|
29
|
+
/** The `SWMLService` this builder belongs to, kept as a public back-reference
|
|
30
|
+
* ({@link SwmlBuilder.service}). The reference's `SWMLBuilder(service)` takes it as
|
|
31
|
+
* its sole constructor argument and keeps it as public `self.service`. Omit for a
|
|
32
|
+
* standalone builder (the common case — a builder used to hand-craft SWML has no
|
|
33
|
+
* service). */
|
|
34
|
+
service?: SWMLServiceLike;
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* The `SWMLService` shape a builder holds a back-reference to.
|
|
38
|
+
*
|
|
39
|
+
* Structural (rather than a direct `SWMLService` import) because `SWMLService`
|
|
40
|
+
* constructs a `SwmlBuilder`; a value import here would close an initialization
|
|
41
|
+
* cycle. Only the identity of the service matters to the back-reference, so the
|
|
42
|
+
* members named are the ones a holder of the reference can rely on.
|
|
43
|
+
*/
|
|
44
|
+
export interface SWMLServiceLike {
|
|
45
|
+
/** The service's name. */
|
|
46
|
+
readonly name: string;
|
|
47
|
+
/** The route the service is mounted at. */
|
|
48
|
+
readonly route: string;
|
|
28
49
|
}
|
|
29
50
|
/**
|
|
30
51
|
* Builds SWML documents composed of verb instructions organized into named sections.
|
|
@@ -58,6 +79,18 @@ export declare class SwmlBuilder {
|
|
|
58
79
|
/** Per-instance SchemaUtils used when a custom `schemaPath` was supplied. */
|
|
59
80
|
private _instanceSchemaUtils;
|
|
60
81
|
private enableValidation;
|
|
82
|
+
/**
|
|
83
|
+
* The `SWMLService` this builder belongs to — the reference's public
|
|
84
|
+
* `self.service` (`core/swml_builder.py:57`) — or `undefined` for a standalone
|
|
85
|
+
* builder.
|
|
86
|
+
*
|
|
87
|
+
* In the reference the builder DELEGATES document construction to the service, so
|
|
88
|
+
* the service is a required constructor argument. TS inverts the ownership (the
|
|
89
|
+
* builder holds its own document and `SWMLService` holds the builder), which is why
|
|
90
|
+
* it is optional here. The read-back is the same: a caller holding the builder can
|
|
91
|
+
* reach the service that owns it.
|
|
92
|
+
*/
|
|
93
|
+
readonly service?: SWMLServiceLike;
|
|
61
94
|
/**
|
|
62
95
|
* Creates a new SwmlBuilder.
|
|
63
96
|
* @param opts - Optional configuration.
|
|
@@ -71,8 +104,10 @@ export declare class SwmlBuilder {
|
|
|
71
104
|
private getSchemaUtils;
|
|
72
105
|
/**
|
|
73
106
|
* Public read-only accessor for the underlying SWML document.
|
|
74
|
-
*
|
|
75
|
-
* `service`
|
|
107
|
+
*
|
|
108
|
+
* (Not the reference's `service` — that is the SWMLService back-reference, exposed
|
|
109
|
+
* as {@link service}. This is the document the builder is assembling, which the
|
|
110
|
+
* reference reaches through `self.service`.)
|
|
76
111
|
*/
|
|
77
112
|
get document(): {
|
|
78
113
|
version: string;
|
|
@@ -106,15 +141,39 @@ export declare class SwmlBuilder {
|
|
|
106
141
|
* Validates the verb config against the schema when validation is enabled.
|
|
107
142
|
* @param verbName - The SWML verb name (e.g., "answer", "ai").
|
|
108
143
|
* @param config - The verb's configuration payload.
|
|
144
|
+
* @param opts - When `opts.skipValidation` is true, the config is appended
|
|
145
|
+
* WITHOUT schema validation. Used by AgentBase for the internally-assembled
|
|
146
|
+
* `ai` verb, whose config is built from already-typed builder inputs and may
|
|
147
|
+
* carry real, server-accepted SWML that the bundled schema does not yet model
|
|
148
|
+
* (e.g. `multilingual`, `SWAIG.mcp_servers`, per-language engine/model/fillers,
|
|
149
|
+
* `debug_webhook_url`). Validating it against the closed schema would raise on
|
|
150
|
+
* those legitimate features — the strict-render contract is about rejecting
|
|
151
|
+
* MISSHAPEN direct `addVerb` input (unknown verb, misspelled/unknown key,
|
|
152
|
+
* wrong type), NOT about second-guessing trusted internal assembly. The
|
|
153
|
+
* direct/public `addVerb` path stays fully strict.
|
|
109
154
|
*/
|
|
110
|
-
addVerb(verbName: string, config: unknown
|
|
155
|
+
addVerb(verbName: string, config: unknown, opts?: {
|
|
156
|
+
skipValidation?: boolean;
|
|
157
|
+
}): void;
|
|
111
158
|
/**
|
|
112
159
|
* Appends a verb to a named section, creating the section if it does not exist.
|
|
160
|
+
*
|
|
161
|
+
* Validates exactly as {@link addVerb} does. The reference validates at BOTH
|
|
162
|
+
* add-verb sites (`core/swml_service.py:558` and `:635`, each raising
|
|
163
|
+
* `SchemaValidationError`); this path previously appended without validating, so a
|
|
164
|
+
* misshapen or unknown verb reached a non-main section silently.
|
|
165
|
+
*
|
|
113
166
|
* @param sectionName - The target section name.
|
|
114
167
|
* @param verbName - The SWML verb name.
|
|
115
168
|
* @param config - The verb's configuration payload.
|
|
169
|
+
* @param opts - When `opts.skipValidation` is true, append without validating
|
|
170
|
+
* (same trusted-internal-assembly escape hatch as {@link addVerb}).
|
|
171
|
+
* @throws {SchemaValidationError} When validation is enabled and the config does
|
|
172
|
+
* not satisfy the verb's schema (or the verb is unknown).
|
|
116
173
|
*/
|
|
117
|
-
addVerbToSection(sectionName: string, verbName: string, config: unknown
|
|
174
|
+
addVerbToSection(sectionName: string, verbName: string, config: unknown, opts?: {
|
|
175
|
+
skipValidation?: boolean;
|
|
176
|
+
}): void;
|
|
118
177
|
/**
|
|
119
178
|
* Add a 'play' verb with say: prefix for text-to-speech.
|
|
120
179
|
* Convenience wrapper matching Python SDK's `say()` method.
|
|
@@ -126,7 +185,7 @@ export declare class SwmlBuilder {
|
|
|
126
185
|
say(text: string, opts?: {
|
|
127
186
|
voice?: string;
|
|
128
187
|
language?: string;
|
|
129
|
-
gender?:
|
|
188
|
+
gender?: TtsGender;
|
|
130
189
|
volume?: number;
|
|
131
190
|
}): this;
|
|
132
191
|
/**
|
|
@@ -139,25 +198,15 @@ export declare class SwmlBuilder {
|
|
|
139
198
|
*/
|
|
140
199
|
addSection(sectionName: string): this;
|
|
141
200
|
/**
|
|
142
|
-
*
|
|
143
|
-
*
|
|
144
|
-
*/
|
|
145
|
-
getDocument(): Record<string, unknown>;
|
|
146
|
-
/**
|
|
147
|
-
* Alias for {@link getDocument}. Matches the Python SDK's `build()` method.
|
|
148
|
-
* Build and return the SWML document as a dictionary/object.
|
|
201
|
+
* Build and return the SWML document as a dictionary/object. Canonical name,
|
|
202
|
+
* matching Python's `SWMLBuilder.build()`.
|
|
149
203
|
*
|
|
150
204
|
* @returns The document with version and sections.
|
|
151
205
|
*/
|
|
152
206
|
build(): Record<string, unknown>;
|
|
153
207
|
/**
|
|
154
|
-
*
|
|
155
|
-
*
|
|
156
|
-
*/
|
|
157
|
-
renderDocument(): string;
|
|
158
|
-
/**
|
|
159
|
-
* Alias for {@link renderDocument}. Matches the Python SDK's `render()` method.
|
|
160
|
-
* Build and render the SWML document as a JSON string.
|
|
208
|
+
* Build and render the SWML document as a JSON string. Canonical name,
|
|
209
|
+
* matching Python's `SWMLBuilder.render()`.
|
|
161
210
|
*
|
|
162
211
|
* @returns The JSON-encoded SWML document.
|
|
163
212
|
*/
|