@signalwire/sdk 2.0.4 → 3.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +785 -0
- package/LICENSE +21 -0
- package/README.md +163 -68
- package/dist/AGENTS.md +13 -0
- package/dist/AgentBase.d.ts +550 -163
- package/dist/AgentBase.js +1640 -514
- package/dist/AgentBase.js.map +1 -1
- package/dist/AgentServer.d.ts +21 -0
- package/dist/AgentServer.js +154 -47
- package/dist/AgentServer.js.map +1 -1
- package/dist/AuthHandler.d.ts +14 -2
- package/dist/AuthHandler.js +7 -2
- package/dist/AuthHandler.js.map +1 -1
- package/dist/ConfigLoader.d.ts +5 -13
- package/dist/ConfigLoader.js +15 -29
- package/dist/ConfigLoader.js.map +1 -1
- package/dist/ContextBuilder.d.ts +202 -9
- package/dist/ContextBuilder.js +219 -36
- package/dist/ContextBuilder.js.map +1 -1
- package/dist/DataMap.d.ts +158 -45
- package/dist/DataMap.js +167 -52
- package/dist/DataMap.js.map +1 -1
- package/dist/FunctionResult.d.ts +277 -83
- package/dist/FunctionResult.js +444 -116
- package/dist/FunctionResult.js.map +1 -1
- package/dist/Logger.d.ts +30 -5
- package/dist/Logger.js +77 -19
- package/dist/Logger.js.map +1 -1
- package/dist/POM/PromptObjectModel.d.ts +163 -0
- package/dist/POM/PromptObjectModel.js +481 -0
- package/dist/POM/PromptObjectModel.js.map +1 -0
- package/dist/ParameterSchema.d.ts +306 -0
- package/dist/ParameterSchema.js +251 -0
- package/dist/ParameterSchema.js.map +1 -0
- package/dist/PlatformContracts.d.ts +21 -0
- package/dist/PlatformContracts.generated.d.ts +109 -0
- package/dist/PlatformContracts.generated.js +8 -0
- package/dist/PlatformContracts.generated.js.map +1 -0
- package/dist/PlatformContracts.js +2 -0
- package/dist/PlatformContracts.js.map +1 -0
- package/dist/PomBuilder.d.ts +28 -0
- package/dist/PomBuilder.js +81 -3
- package/dist/PomBuilder.js.map +1 -1
- package/dist/PostPrompt.d.ts +110 -0
- package/dist/PostPrompt.js +204 -0
- package/dist/PostPrompt.js.map +1 -0
- package/dist/PromptManager.d.ts +29 -1
- package/dist/PromptManager.js +37 -1
- package/dist/PromptManager.js.map +1 -1
- package/dist/PublicFetch.d.ts +132 -0
- package/dist/PublicFetch.js +311 -0
- package/dist/PublicFetch.js.map +1 -0
- package/dist/RobotsTxt.d.ts +41 -0
- package/dist/RobotsTxt.js +152 -0
- package/dist/RobotsTxt.js.map +1 -0
- package/dist/SWMLHandler.js.map +1 -1
- package/dist/SWMLService.d.ts +265 -66
- package/dist/SWMLService.js +652 -112
- package/dist/SWMLService.js.map +1 -1
- package/dist/SchemaUtils.d.ts +115 -2
- package/dist/SchemaUtils.js +444 -12
- package/dist/SchemaUtils.js.map +1 -1
- package/dist/SecurityUtils.d.ts +55 -8
- package/dist/SecurityUtils.js +162 -49
- package/dist/SecurityUtils.js.map +1 -1
- package/dist/ServerlessAdapter.d.ts +156 -7
- package/dist/ServerlessAdapter.js +399 -42
- package/dist/ServerlessAdapter.js.map +1 -1
- package/dist/SessionManager.d.ts +11 -2
- package/dist/SessionManager.js +50 -18
- package/dist/SessionManager.js.map +1 -1
- package/dist/SslConfig.d.ts +2 -1
- package/dist/SslConfig.js +4 -1
- package/dist/SslConfig.js.map +1 -1
- package/dist/SwaigActions.generated.d.ts +23 -0
- package/dist/SwaigActions.generated.js +8 -0
- package/dist/SwaigActions.generated.js.map +1 -0
- package/dist/SwaigContracts.d.ts +15 -0
- package/dist/SwaigContracts.generated.d.ts +264 -0
- package/dist/SwaigContracts.generated.js +12 -0
- package/dist/SwaigContracts.generated.js.map +1 -0
- package/dist/SwaigContracts.js +2 -0
- package/dist/SwaigContracts.js.map +1 -0
- package/dist/SwaigFunction.d.ts +110 -4
- package/dist/SwaigFunction.js +151 -19
- package/dist/SwaigFunction.js.map +1 -1
- package/dist/SwmlBuilder.d.ts +68 -19
- package/dist/SwmlBuilder.js +74 -38
- package/dist/SwmlBuilder.js.map +1 -1
- package/dist/SwmlVerbMethods.generated.d.ts +41 -4
- package/dist/SwmlVerbMethods.generated.js +1 -1
- package/dist/TypeInference.d.ts +39 -3
- package/dist/TypeInference.js +256 -16
- package/dist/TypeInference.js.map +1 -1
- package/dist/WebService.d.ts +79 -11
- package/dist/WebService.js +320 -109
- package/dist/WebService.js.map +1 -1
- package/dist/WebhookMiddleware.d.ts +119 -0
- package/dist/WebhookMiddleware.js +271 -0
- package/dist/WebhookMiddleware.js.map +1 -0
- package/dist/WebhookValidator.d.ts +92 -0
- package/dist/WebhookValidator.js +409 -0
- package/dist/WebhookValidator.js.map +1 -0
- package/dist/agents/BedrockAgent.d.ts +162 -0
- package/dist/agents/BedrockAgent.js +323 -0
- package/dist/agents/BedrockAgent.js.map +1 -0
- package/dist/ai-chat/AIChatClient.d.ts +316 -0
- package/dist/ai-chat/AIChatClient.js +535 -0
- package/dist/ai-chat/AIChatClient.js.map +1 -0
- package/dist/ai-chat/ChatGateway.d.ts +408 -0
- package/dist/ai-chat/ChatGateway.js +747 -0
- package/dist/ai-chat/ChatGateway.js.map +1 -0
- package/dist/ai-chat/HandoffRouter.d.ts +282 -0
- package/dist/ai-chat/HandoffRouter.js +518 -0
- package/dist/ai-chat/HandoffRouter.js.map +1 -0
- package/dist/ai-chat/index.d.ts +12 -0
- package/dist/ai-chat/index.js +10 -0
- package/dist/ai-chat/index.js.map +1 -0
- package/dist/capabilities.d.ts +64 -0
- package/dist/capabilities.js +95 -0
- package/dist/capabilities.js.map +1 -0
- package/dist/cli/agent-loader.d.ts +32 -6
- package/dist/cli/agent-loader.js +95 -34
- package/dist/cli/agent-loader.js.map +1 -1
- package/dist/cli/datamap-exec.d.ts +175 -0
- package/dist/cli/datamap-exec.js +1284 -0
- package/dist/cli/datamap-exec.js.map +1 -0
- package/dist/cli/function-args.d.ts +40 -0
- package/dist/cli/function-args.js +146 -0
- package/dist/cli/function-args.js.map +1 -0
- package/dist/cli/simulation.d.ts +99 -0
- package/dist/cli/simulation.js +490 -0
- package/dist/cli/simulation.js.map +1 -0
- package/dist/cli/swaig-test.d.ts +12 -25
- package/dist/cli/swaig-test.js +935 -367
- package/dist/cli/swaig-test.js.map +1 -1
- package/dist/cli/tsdocs/agentsNote.d.ts +30 -0
- package/dist/cli/tsdocs/agentsNote.js +92 -0
- package/dist/cli/tsdocs/agentsNote.js.map +1 -0
- package/dist/cli/tsdocs/api-index.json +1 -0
- package/dist/cli/tsdocs/api.d.ts +91 -0
- package/dist/cli/tsdocs/api.js +372 -0
- package/dist/cli/tsdocs/api.js.map +1 -0
- package/dist/cli/tsdocs/apiTypes.d.ts +64 -0
- package/dist/cli/tsdocs/apiTypes.js +7 -0
- package/dist/cli/tsdocs/apiTypes.js.map +1 -0
- package/dist/cli/tsdocs/bin.d.ts +6 -0
- package/dist/cli/tsdocs/bin.js +23 -0
- package/dist/cli/tsdocs/bin.js.map +1 -0
- package/dist/cli/tsdocs/files.d.ts +108 -0
- package/dist/cli/tsdocs/files.js +287 -0
- package/dist/cli/tsdocs/files.js.map +1 -0
- package/dist/cli/tsdocs/index.d.ts +28 -0
- package/dist/cli/tsdocs/index.js +307 -0
- package/dist/cli/tsdocs/index.js.map +1 -0
- package/dist/cli/tsdocs/live.d.ts +41 -0
- package/dist/cli/tsdocs/live.js +202 -0
- package/dist/cli/tsdocs/live.js.map +1 -0
- package/dist/cli/tsdocs/locate.d.ts +51 -0
- package/dist/cli/tsdocs/locate.js +75 -0
- package/dist/cli/tsdocs/locate.js.map +1 -0
- package/dist/cli/tsdocs/render.d.ts +75 -0
- package/dist/cli/tsdocs/render.js +323 -0
- package/dist/cli/tsdocs/render.js.map +1 -0
- package/dist/cli/tsdocs/topics.d.ts +43 -0
- package/dist/cli/tsdocs/topics.js +916 -0
- package/dist/cli/tsdocs/topics.js.map +1 -0
- package/dist/index.d.ts +102 -39
- package/dist/index.js +107 -30
- package/dist/index.js.map +1 -1
- package/dist/livewire/index.d.ts +229 -155
- package/dist/livewire/index.js +298 -195
- package/dist/livewire/index.js.map +1 -1
- package/dist/llms.txt +65 -0
- package/dist/prefabs/CallSessionStore.d.ts +52 -0
- package/dist/prefabs/CallSessionStore.js +72 -0
- package/dist/prefabs/CallSessionStore.js.map +1 -0
- package/dist/prefabs/ConciergeAgent.d.ts +13 -1
- package/dist/prefabs/ConciergeAgent.js +36 -31
- package/dist/prefabs/ConciergeAgent.js.map +1 -1
- package/dist/prefabs/FAQBotAgent.d.ts +9 -1
- package/dist/prefabs/FAQBotAgent.js +113 -47
- package/dist/prefabs/FAQBotAgent.js.map +1 -1
- package/dist/prefabs/InfoGathererAgent.d.ts +22 -3
- package/dist/prefabs/InfoGathererAgent.js +67 -58
- package/dist/prefabs/InfoGathererAgent.js.map +1 -1
- package/dist/prefabs/ReceptionistAgent.d.ts +16 -5
- package/dist/prefabs/ReceptionistAgent.js +39 -31
- package/dist/prefabs/ReceptionistAgent.js.map +1 -1
- package/dist/prefabs/SurveyAgent.d.ts +22 -4
- package/dist/prefabs/SurveyAgent.js +84 -68
- package/dist/prefabs/SurveyAgent.js.map +1 -1
- package/dist/relay/Action.d.ts +44 -21
- package/dist/relay/Action.js +75 -17
- package/dist/relay/Action.js.map +1 -1
- package/dist/relay/Call.d.ts +312 -47
- package/dist/relay/Call.js +369 -18
- package/dist/relay/Call.js.map +1 -1
- package/dist/relay/Deferred.js.map +1 -1
- package/dist/relay/Message.d.ts +26 -5
- package/dist/relay/Message.js +36 -6
- package/dist/relay/Message.js.map +1 -1
- package/dist/relay/RelayClient.d.ts +79 -14
- package/dist/relay/RelayClient.js +268 -61
- package/dist/relay/RelayClient.js.map +1 -1
- package/dist/relay/RelayError.d.ts +14 -0
- package/dist/relay/RelayError.js +15 -0
- package/dist/relay/RelayError.js.map +1 -1
- package/dist/relay/RelayEvent.d.ts +96 -65
- package/dist/relay/RelayEvent.js +85 -56
- package/dist/relay/RelayEvent.js.map +1 -1
- package/dist/relay/closedSets.d.ts +111 -0
- package/dist/relay/closedSets.js +83 -0
- package/dist/relay/closedSets.js.map +1 -0
- package/dist/relay/index.d.ts +3 -1
- package/dist/relay/index.js +1 -0
- package/dist/relay/index.js.map +1 -1
- package/dist/relay/normalize.js.map +1 -1
- package/dist/relay/protocol.types.generated.d.ts +1195 -0
- package/dist/relay/protocol.types.generated.js +8 -0
- package/dist/relay/protocol.types.generated.js.map +1 -0
- package/dist/relay/types.d.ts +81 -39
- package/dist/rest/HttpClient.d.ts +36 -8
- package/dist/rest/HttpClient.js +233 -40
- package/dist/rest/HttpClient.js.map +1 -1
- package/dist/rest/RequestOptions.d.ts +110 -0
- package/dist/rest/RequestOptions.js +113 -0
- package/dist/rest/RequestOptions.js.map +1 -0
- package/dist/rest/RestError.d.ts +52 -6
- package/dist/rest/RestError.js +89 -5
- package/dist/rest/RestError.js.map +1 -1
- package/dist/rest/base/CrudResource.d.ts +16 -26
- package/dist/rest/base/CrudResource.js +19 -33
- package/dist/rest/base/CrudResource.js.map +1 -1
- package/dist/rest/base/CrudWithAddresses.d.ts +3 -2
- package/dist/rest/base/CrudWithAddresses.js +2 -2
- package/dist/rest/base/CrudWithAddresses.js.map +1 -1
- package/dist/rest/base/FabricResource.d.ts +15 -0
- package/dist/rest/base/FabricResource.js +16 -0
- package/dist/rest/base/FabricResource.js.map +1 -0
- package/dist/rest/base/ReadResource.d.ts +62 -0
- package/dist/rest/base/ReadResource.js +69 -0
- package/dist/rest/base/ReadResource.js.map +1 -0
- package/dist/rest/callHandler.d.ts +63 -0
- package/dist/rest/callHandler.js +62 -0
- package/dist/rest/callHandler.js.map +1 -0
- package/dist/rest/index.d.ts +19 -76
- package/dist/rest/index.js +49 -120
- package/dist/rest/index.js.map +1 -1
- package/dist/rest/namespaces/_client_tree_generated.d.ts +103 -0
- package/dist/rest/namespaces/_client_tree_generated.js +171 -0
- package/dist/rest/namespaces/_client_tree_generated.js.map +1 -0
- package/dist/rest/namespaces/addresses.d.ts +3 -42
- package/dist/rest/namespaces/addresses.js +3 -50
- package/dist/rest/namespaces/addresses.js.map +1 -1
- package/dist/rest/namespaces/calling.d.ts +6 -378
- package/dist/rest/namespaces/calling.js +6 -473
- package/dist/rest/namespaces/calling.js.map +1 -1
- package/dist/rest/namespaces/calling.resources.generated.d.ts +165 -0
- package/dist/rest/namespaces/calling.resources.generated.js +477 -0
- package/dist/rest/namespaces/calling.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/calling.types.generated.d.ts +2917 -0
- package/dist/rest/namespaces/calling.types.generated.js +8 -0
- package/dist/rest/namespaces/calling.types.generated.js.map +1 -0
- package/dist/rest/namespaces/chat.d.ts +4 -18
- package/dist/rest/namespaces/chat.js +4 -21
- package/dist/rest/namespaces/chat.js.map +1 -1
- package/dist/rest/namespaces/chat.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/chat.resources.generated.js +29 -0
- package/dist/rest/namespaces/chat.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/chat.types.generated.d.ts +56 -0
- package/dist/rest/namespaces/chat.types.generated.js +8 -0
- package/dist/rest/namespaces/chat.types.generated.js.map +1 -0
- package/dist/rest/namespaces/datasphere.d.ts +6 -62
- package/dist/rest/namespaces/datasphere.js +6 -72
- package/dist/rest/namespaces/datasphere.js.map +1 -1
- package/dist/rest/namespaces/datasphere.resources.generated.d.ts +25 -0
- package/dist/rest/namespaces/datasphere.resources.generated.js +50 -0
- package/dist/rest/namespaces/datasphere.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/datasphere.types.generated.d.ts +180 -0
- package/dist/rest/namespaces/datasphere.types.generated.js +8 -0
- package/dist/rest/namespaces/datasphere.types.generated.js.map +1 -0
- package/dist/rest/namespaces/fabric.d.ts +11 -273
- package/dist/rest/namespaces/fabric.js +14 -363
- package/dist/rest/namespaces/fabric.js.map +1 -1
- package/dist/rest/namespaces/fabric.resources.generated.d.ts +195 -0
- package/dist/rest/namespaces/fabric.resources.generated.js +399 -0
- package/dist/rest/namespaces/fabric.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/fabric.types.generated.d.ts +4557 -0
- package/dist/rest/namespaces/fabric.types.generated.js +8 -0
- package/dist/rest/namespaces/fabric.types.generated.js.map +1 -0
- package/dist/rest/namespaces/fax.resources.generated.d.ts +6 -0
- package/dist/rest/namespaces/fax.resources.generated.js +14 -0
- package/dist/rest/namespaces/fax.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/fax.types.generated.d.ts +131 -0
- package/dist/rest/namespaces/fax.types.generated.js +8 -0
- package/dist/rest/namespaces/fax.types.generated.js.map +1 -0
- package/dist/rest/namespaces/imported-numbers.d.ts +3 -18
- package/dist/rest/namespaces/imported-numbers.js +3 -21
- package/dist/rest/namespaces/imported-numbers.js.map +1 -1
- package/dist/rest/namespaces/logs.d.ts +10 -101
- package/dist/rest/namespaces/logs.js +10 -128
- package/dist/rest/namespaces/logs.js.map +1 -1
- package/dist/rest/namespaces/logs.resources.generated.d.ts +9 -0
- package/dist/rest/namespaces/logs.resources.generated.js +17 -0
- package/dist/rest/namespaces/logs.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/logs.types.generated.d.ts +131 -0
- package/dist/rest/namespaces/logs.types.generated.js +8 -0
- package/dist/rest/namespaces/logs.types.generated.js.map +1 -0
- package/dist/rest/namespaces/lookup.d.ts +3 -25
- package/dist/rest/namespaces/lookup.js +3 -27
- package/dist/rest/namespaces/lookup.js.map +1 -1
- package/dist/rest/namespaces/message.resources.generated.d.ts +6 -0
- package/dist/rest/namespaces/message.resources.generated.js +14 -0
- package/dist/rest/namespaces/message.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/message.types.generated.d.ts +122 -0
- package/dist/rest/namespaces/message.types.generated.js +8 -0
- package/dist/rest/namespaces/message.types.generated.js.map +1 -0
- package/dist/rest/namespaces/messages.resources.generated.d.ts +18 -0
- package/dist/rest/namespaces/messages.resources.generated.js +44 -0
- package/dist/rest/namespaces/messages.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/messages.types.generated.d.ts +99 -0
- package/dist/rest/namespaces/messages.types.generated.js +8 -0
- package/dist/rest/namespaces/messages.types.generated.js.map +1 -0
- package/dist/rest/namespaces/mfa.d.ts +3 -42
- package/dist/rest/namespaces/mfa.js +3 -49
- package/dist/rest/namespaces/mfa.js.map +1 -1
- package/dist/rest/namespaces/number-groups.d.ts +3 -45
- package/dist/rest/namespaces/number-groups.js +3 -53
- package/dist/rest/namespaces/number-groups.js.map +1 -1
- package/dist/rest/namespaces/phone-numbers.d.ts +9 -57
- package/dist/rest/namespaces/phone-numbers.js +9 -63
- package/dist/rest/namespaces/phone-numbers.js.map +1 -1
- package/dist/rest/namespaces/project.d.ts +6 -42
- package/dist/rest/namespaces/project.js +6 -51
- package/dist/rest/namespaces/project.js.map +1 -1
- package/dist/rest/namespaces/project.resources.generated.d.ts +17 -0
- package/dist/rest/namespaces/project.resources.generated.js +44 -0
- package/dist/rest/namespaces/project.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/project.types.generated.d.ts +58 -0
- package/dist/rest/namespaces/project.types.generated.js +8 -0
- package/dist/rest/namespaces/project.types.generated.js.map +1 -0
- package/dist/rest/namespaces/projects.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/projects.resources.generated.js +25 -0
- package/dist/rest/namespaces/projects.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/projects.types.generated.d.ts +77 -0
- package/dist/rest/namespaces/projects.types.generated.js +8 -0
- package/dist/rest/namespaces/projects.types.generated.js.map +1 -0
- package/dist/rest/namespaces/pubsub.d.ts +4 -18
- package/dist/rest/namespaces/pubsub.js +4 -21
- package/dist/rest/namespaces/pubsub.js.map +1 -1
- package/dist/rest/namespaces/pubsub.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/pubsub.resources.generated.js +29 -0
- package/dist/rest/namespaces/pubsub.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/pubsub.types.generated.d.ts +60 -0
- package/dist/rest/namespaces/pubsub.types.generated.js +8 -0
- package/dist/rest/namespaces/pubsub.types.generated.js.map +1 -0
- package/dist/rest/namespaces/queues.d.ts +3 -38
- package/dist/rest/namespaces/queues.js +3 -44
- package/dist/rest/namespaces/queues.js.map +1 -1
- package/dist/rest/namespaces/recordings.d.ts +3 -34
- package/dist/rest/namespaces/recordings.js +3 -40
- package/dist/rest/namespaces/recordings.js.map +1 -1
- package/dist/rest/namespaces/registry.d.ts +6 -137
- package/dist/rest/namespaces/registry.js +6 -173
- package/dist/rest/namespaces/registry.js.map +1 -1
- package/dist/rest/namespaces/relay-rest.resources.generated.d.ts +168 -0
- package/dist/rest/namespaces/relay-rest.resources.generated.js +430 -0
- package/dist/rest/namespaces/relay-rest.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/relay-rest.types.generated.d.ts +1906 -0
- package/dist/rest/namespaces/relay-rest.types.generated.js +8 -0
- package/dist/rest/namespaces/relay-rest.types.generated.js.map +1 -0
- package/dist/rest/namespaces/short-codes.d.ts +3 -35
- package/dist/rest/namespaces/short-codes.js +3 -41
- package/dist/rest/namespaces/short-codes.js.map +1 -1
- package/dist/rest/namespaces/sip-profile.d.ts +3 -24
- package/dist/rest/namespaces/sip-profile.js +3 -29
- package/dist/rest/namespaces/sip-profile.js.map +1 -1
- package/dist/rest/namespaces/verified-callers.d.ts +3 -29
- package/dist/rest/namespaces/verified-callers.js +3 -34
- package/dist/rest/namespaces/verified-callers.js.map +1 -1
- package/dist/rest/namespaces/video.d.ts +10 -227
- package/dist/rest/namespaces/video.js +10 -288
- package/dist/rest/namespaces/video.js.map +1 -1
- package/dist/rest/namespaces/video.resources.generated.d.ts +81 -0
- package/dist/rest/namespaces/video.resources.generated.js +171 -0
- package/dist/rest/namespaces/video.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/video.types.generated.d.ts +771 -0
- package/dist/rest/namespaces/video.types.generated.js +8 -0
- package/dist/rest/namespaces/video.types.generated.js.map +1 -0
- package/dist/rest/namespaces/voice.resources.generated.d.ts +9 -0
- package/dist/rest/namespaces/voice.resources.generated.js +17 -0
- package/dist/rest/namespaces/voice.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/voice.types.generated.d.ts +214 -0
- package/dist/rest/namespaces/voice.types.generated.js +8 -0
- package/dist/rest/namespaces/voice.types.generated.js.map +1 -0
- package/dist/rest/pagination.d.ts +5 -1
- package/dist/rest/pagination.js +40 -20
- package/dist/rest/pagination.js.map +1 -1
- package/dist/rest/types.d.ts +21 -3
- package/dist/schema.json +299 -98
- package/dist/skills/SkillBase.d.ts +97 -20
- package/dist/skills/SkillBase.js +100 -17
- package/dist/skills/SkillBase.js.map +1 -1
- package/dist/skills/SkillManager.d.ts +66 -13
- package/dist/skills/SkillManager.js +101 -20
- package/dist/skills/SkillManager.js.map +1 -1
- package/dist/skills/SkillName.d.ts +44 -0
- package/dist/skills/SkillName.js +2 -0
- package/dist/skills/SkillName.js.map +1 -0
- package/dist/skills/SkillRegistry.d.ts +47 -7
- package/dist/skills/SkillRegistry.js +85 -13
- package/dist/skills/SkillRegistry.js.map +1 -1
- package/dist/skills/builtin/api_ninjas_trivia.d.ts +3 -1
- package/dist/skills/builtin/api_ninjas_trivia.js +24 -8
- package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -1
- package/dist/skills/builtin/ask_claude.d.ts +14 -4
- package/dist/skills/builtin/ask_claude.js +36 -14
- package/dist/skills/builtin/ask_claude.js.map +1 -1
- package/dist/skills/builtin/claude_skills.d.ts +3 -1
- package/dist/skills/builtin/claude_skills.js +19 -15
- package/dist/skills/builtin/claude_skills.js.map +1 -1
- package/dist/skills/builtin/custom_skills.d.ts +10 -3
- package/dist/skills/builtin/custom_skills.js +26 -9
- package/dist/skills/builtin/custom_skills.js.map +1 -1
- package/dist/skills/builtin/datasphere.d.ts +5 -3
- package/dist/skills/builtin/datasphere.js +34 -25
- package/dist/skills/builtin/datasphere.js.map +1 -1
- package/dist/skills/builtin/datasphere_serverless.d.ts +12 -1
- package/dist/skills/builtin/datasphere_serverless.js +17 -6
- package/dist/skills/builtin/datasphere_serverless.js.map +1 -1
- package/dist/skills/builtin/datetime.d.ts +3 -1
- package/dist/skills/builtin/datetime.js +11 -7
- package/dist/skills/builtin/datetime.js.map +1 -1
- package/dist/skills/builtin/google_maps.d.ts +29 -14
- package/dist/skills/builtin/google_maps.js +89 -269
- package/dist/skills/builtin/google_maps.js.map +1 -1
- package/dist/skills/builtin/index.d.ts +8 -6
- package/dist/skills/builtin/index.js +8 -6
- package/dist/skills/builtin/index.js.map +1 -1
- package/dist/skills/builtin/info_gatherer.d.ts +4 -2
- package/dist/skills/builtin/info_gatherer.js +20 -12
- package/dist/skills/builtin/info_gatherer.js.map +1 -1
- package/dist/skills/builtin/joke.d.ts +16 -6
- package/dist/skills/builtin/joke.js +54 -37
- package/dist/skills/builtin/joke.js.map +1 -1
- package/dist/skills/builtin/math.d.ts +3 -1
- package/dist/skills/builtin/math.js +14 -9
- package/dist/skills/builtin/math.js.map +1 -1
- package/dist/skills/builtin/mcp_gateway.d.ts +34 -5
- package/dist/skills/builtin/mcp_gateway.js +77 -46
- package/dist/skills/builtin/mcp_gateway.js.map +1 -1
- package/dist/skills/builtin/native_vector_search.d.ts +19 -5
- package/dist/skills/builtin/native_vector_search.js +179 -61
- package/dist/skills/builtin/native_vector_search.js.map +1 -1
- package/dist/skills/builtin/play_background_file.d.ts +21 -15
- package/dist/skills/builtin/play_background_file.js +43 -122
- package/dist/skills/builtin/play_background_file.js.map +1 -1
- package/dist/skills/builtin/spider.d.ts +46 -1
- package/dist/skills/builtin/spider.js +317 -101
- package/dist/skills/builtin/spider.js.map +1 -1
- package/dist/skills/builtin/swml_transfer.d.ts +14 -3
- package/dist/skills/builtin/swml_transfer.js +45 -24
- package/dist/skills/builtin/swml_transfer.js.map +1 -1
- package/dist/skills/builtin/weather_api.d.ts +24 -13
- package/dist/skills/builtin/weather_api.js +57 -31
- package/dist/skills/builtin/weather_api.js.map +1 -1
- package/dist/skills/builtin/web_search.d.ts +48 -10
- package/dist/skills/builtin/web_search.js +301 -84
- package/dist/skills/builtin/web_search.js.map +1 -1
- package/dist/skills/builtin/wikipedia_search.d.ts +4 -2
- package/dist/skills/builtin/wikipedia_search.js +32 -14
- package/dist/skills/builtin/wikipedia_search.js.map +1 -1
- package/dist/skills/index.d.ts +3 -2
- package/dist/skills/index.js +1 -1
- package/dist/skills/index.js.map +1 -1
- package/dist/swml_verbs_generated.d.ts +2824 -0
- package/dist/swml_verbs_generated.js +12 -0
- package/dist/swml_verbs_generated.js.map +1 -0
- package/dist/types.d.ts +65 -6
- package/dist/web.d.ts +27 -0
- package/dist/web.js +20 -0
- package/dist/web.js.map +1 -0
- package/docs/agent-guide.md +1034 -0
- package/docs/ai_chat.md +560 -0
- package/docs/api-reference.md +3534 -0
- package/docs/architecture.md +846 -0
- package/docs/bedrock_agent.md +411 -0
- package/docs/cli-guide.md +403 -0
- package/docs/cloud_functions_guide.md +399 -0
- package/docs/configuration.md +548 -0
- package/docs/contexts-guide.md +884 -0
- package/docs/datamap-guide.md +1160 -0
- package/docs/developer_pain_points.md +548 -0
- package/docs/llm_parameters.md +298 -0
- package/docs/mcp_gateway_reference.md +354 -0
- package/docs/mcp_integration.md +162 -0
- package/docs/pgi_agent_guide.md +1820 -0
- package/docs/prefabs-guide.md +815 -0
- package/docs/programmatically_governed_inference.md +301 -0
- package/docs/sdk_features.md +501 -0
- package/docs/security.md +559 -0
- package/docs/serverless-guide.md +520 -0
- package/docs/skills-guide.md +1223 -0
- package/docs/skills-system.md +405 -0
- package/docs/skills_parameter_schema.md +417 -0
- package/docs/swaig-reference.md +1938 -0
- package/docs/swml_service_guide.md +573 -0
- package/docs/third_party_skills.md +410 -0
- package/docs/web_service.md +666 -0
- package/examples/README.md +202 -0
- package/examples/advanced-datamap.ts +108 -0
- package/examples/advanced-dynamic-config.ts +70 -0
- package/examples/auto-vivified.ts +95 -0
- package/examples/call-flow.ts +65 -0
- package/examples/comprehensive-dynamic.ts +125 -0
- package/examples/contexts-steps.ts +65 -0
- package/examples/custom-path.ts +45 -0
- package/examples/datamap-tools.ts +51 -0
- package/examples/datasphere-multi-instance.ts +66 -0
- package/examples/datasphere-serverless-env.ts +87 -0
- package/examples/datasphere-webhook-env.ts +65 -0
- package/examples/datasphere.ts +56 -0
- package/examples/declarative.ts +100 -0
- package/examples/dynamic-config.ts +54 -0
- package/examples/dynamic-info-gatherer.ts +69 -0
- package/examples/dynamic-swml-service.ts +67 -0
- package/examples/gather-info.ts +95 -0
- package/examples/gather-per-question-functions-demo.ts +139 -0
- package/examples/joke-agent.ts +34 -0
- package/examples/kubernetes-agent.ts +45 -0
- package/examples/llm-params.ts +75 -0
- package/examples/mcp-agent.ts +89 -0
- package/examples/mcp-gateway.ts +81 -0
- package/examples/multi-agent.ts +80 -0
- package/examples/multi-endpoint.ts +79 -0
- package/examples/pgi/case-domain.ts +114 -0
- package/examples/pgi/serve.ts +16 -0
- package/examples/pgi/support-agent.ts +265 -0
- package/examples/pom-prompt.ts +70 -0
- package/examples/prefab-concierge.ts +42 -0
- package/examples/prefab-faq.ts +58 -0
- package/examples/prefab-info-gatherer.ts +33 -0
- package/examples/prefab-receptionist.ts +36 -0
- package/examples/prefab-survey.ts +69 -0
- package/examples/quickstart-agent.ts +29 -0
- package/examples/quickstart-relay.ts +25 -0
- package/examples/quickstart-rest.ts +25 -0
- package/examples/record-call.ts +65 -0
- package/examples/relay-demo.ts +33 -0
- package/examples/room-and-sip.ts +93 -0
- package/examples/serverless-lambda.ts +43 -0
- package/examples/session-state.ts +83 -0
- package/examples/simple-agent.ts +36 -0
- package/examples/simple-static.ts +29 -0
- package/examples/skills-demo.ts +41 -0
- package/examples/step-function-inheritance-demo.ts +124 -0
- package/examples/swaig-features.ts +193 -0
- package/examples/swml-service-routing.ts +66 -0
- package/examples/swml-service.ts +38 -0
- package/examples/swmlservice_ai_sidecar.ts +104 -0
- package/examples/swmlservice_swaig_standalone.ts +79 -0
- package/examples/tap.ts +67 -0
- package/examples/typed-tools.ts +68 -0
- package/examples/verb-methods.ts +45 -0
- package/examples/web-search-multi-instance.ts +75 -0
- package/examples/web-search.ts +38 -0
- package/examples/wikipedia.ts +36 -0
- package/livewire/README.md +164 -0
- package/livewire/docs/migration-guide.md +251 -0
- package/livewire/examples/livewire-basic-agent.ts +74 -0
- package/livewire/examples/livewire-handoff.ts +196 -0
- package/livewire/examples/livewire-multi-tool.ts +121 -0
- package/package.json +88 -13
- package/relay/README.md +101 -0
- package/relay/docs/call-methods.md +622 -0
- package/relay/docs/client-reference.md +281 -0
- package/relay/docs/events.md +193 -0
- package/relay/docs/getting-started.md +221 -0
- package/relay/docs/guide.md +386 -0
- package/relay/docs/messaging.md +246 -0
- package/relay/examples/relay-inbound.ts +66 -0
- package/relay/examples/relay-messaging.ts +74 -0
- package/relay/examples/relay-outbound.ts +76 -0
- package/rest/README.md +141 -0
- package/rest/docs/calling.md +313 -0
- package/rest/docs/client-reference.md +149 -0
- package/rest/docs/fabric.md +192 -0
- package/rest/docs/getting-started.md +138 -0
- package/rest/docs/guide.md +421 -0
- package/rest/docs/namespaces.md +367 -0
- package/rest/docs/phone-binding.md +116 -0
- package/rest/examples/rest-10dlc-registration.ts +177 -0
- package/rest/examples/rest-bind-phone-to-swml-webhook.ts +66 -0
- package/rest/examples/rest-calling-ivr-and-ai.ts +136 -0
- package/rest/examples/rest-calling-play-and-record.ts +98 -0
- package/rest/examples/rest-client.ts +59 -0
- package/rest/examples/rest-datasphere-search.ts +81 -0
- package/rest/examples/rest-fabric-conferences-and-routing.ts +147 -0
- package/rest/examples/rest-fabric-subscribers-and-sip.ts +106 -0
- package/rest/examples/rest-fabric-swml-and-callflows.ts +101 -0
- package/rest/examples/rest-manage-resources.ts +64 -0
- package/rest/examples/rest-phone-number-management.ts +200 -0
- package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
- package/rest/examples/rest-video-rooms.ts +186 -0
- package/tutorial/fred/fred.ts +218 -0
- package/tutorial/fred/tutorial/01-introduction.md +141 -0
- package/tutorial/fred/tutorial/02-setup.md +304 -0
- package/tutorial/fred/tutorial/03-basic-agent.md +284 -0
- package/tutorial/fred/tutorial/04-wikipedia-skill.md +298 -0
- package/tutorial/fred/tutorial/05-custom-functions.md +347 -0
- package/tutorial/fred/tutorial/06-running-testing.md +642 -0
- package/tutorial/fred/tutorial/README.md +56 -0
- package/tutorial/fred/tutorial/appendix-complete-code.md +632 -0
- package/tutorial/fred/tutorial/appendix-docker-deployment.md +504 -0
- package/tutorial/full-guardrails-agent/handlers.ts +436 -0
- package/tutorial/full-guardrails-agent/penny.ts +305 -0
- package/tutorial/full-guardrails-agent/reservations.ts +1109 -0
- package/tutorial/full-guardrails-agent/tutorial/01-why-guardrails.md +149 -0
- package/tutorial/full-guardrails-agent/tutorial/02-design-first.md +139 -0
- package/tutorial/full-guardrails-agent/tutorial/03-rules-first.md +422 -0
- package/tutorial/full-guardrails-agent/tutorial/04-the-shell.md +238 -0
- package/tutorial/full-guardrails-agent/tutorial/05-steps-and-scoping.md +247 -0
- package/tutorial/full-guardrails-agent/tutorial/06-tools-that-decide.md +467 -0
- package/tutorial/full-guardrails-agent/tutorial/07-gather-and-projection.md +160 -0
- package/tutorial/full-guardrails-agent/tutorial/08-the-verification-gate.md +333 -0
- package/tutorial/full-guardrails-agent/tutorial/09-people-and-endings.md +313 -0
- package/tutorial/full-guardrails-agent/tutorial/10-testing-and-running.md +387 -0
- package/tutorial/full-guardrails-agent/tutorial/README.md +106 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-complete-code.md +2207 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-deployment.md +191 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-technique-map.md +117 -0
- package/tutorial/full-guardrails-agent/workflow.ts +219 -0
- package/tutorial/multi_agents/README.md +175 -0
- package/tutorial/multi_agents/advanced_agent.ts +395 -0
- package/tutorial/multi_agents/extending_agents.ts +641 -0
- package/tutorial/multi_agents/knowledge.ts +59 -0
- package/tutorial/multi_agents/lesson1_first_agent.md +368 -0
- package/tutorial/multi_agents/lesson2_knowledge_bases.md +404 -0
- package/tutorial/multi_agents/lesson3_multi_agent_systems.md +621 -0
- package/tutorial/multi_agents/lesson4_advanced_features.md +805 -0
- package/tutorial/multi_agents/lesson5_extending_agents.md +856 -0
- package/tutorial/multi_agents/pc_builder.ts +529 -0
- package/tutorial/multi_agents/sales_agent.ts +88 -0
- package/tutorial/multi_agents/sales_agent_with_search.ts +116 -0
- package/tutorial/multi_agents/sales_knowledge.md +139 -0
- package/tutorial/multi_agents/support_knowledge.md +256 -0
- package/dist/cli/mock-data.d.ts +0 -37
- package/dist/cli/mock-data.js +0 -80
- package/dist/cli/mock-data.js.map +0 -1
- package/dist/generateVerbTypes.d.ts +0 -11
- package/dist/generateVerbTypes.js +0 -265
- package/dist/generateVerbTypes.js.map +0 -1
- package/dist/rest/namespaces/compat.d.ts +0 -585
- package/dist/rest/namespaces/compat.js +0 -735
- package/dist/rest/namespaces/compat.js.map +0 -1
|
@@ -0,0 +1,409 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Webhook signature validation for SignalWire-signed HTTP requests.
|
|
3
|
+
*
|
|
4
|
+
* Implements both of SignalWire's webhook signature schemes:
|
|
5
|
+
*
|
|
6
|
+
* - Scheme A (RELAY/SWML/JSON): hex(HMAC-SHA1(key, url + rawBody))
|
|
7
|
+
* - Scheme B (Compat/cXML form): base64(HMAC-SHA1(key, url + sortedFormParams))
|
|
8
|
+
* with optional bodySHA256 query-param fallback for JSON-on-compat-surface.
|
|
9
|
+
*
|
|
10
|
+
* Public API:
|
|
11
|
+
* validateWebhookSignature(signingKey, signature, url, rawBody) -> boolean
|
|
12
|
+
* validateRequest(signingKey, signature, url, paramsOrRawBody) -> boolean
|
|
13
|
+
*
|
|
14
|
+
* All comparisons use ``crypto.timingSafeEqual`` (constant-time) so the secret
|
|
15
|
+
* is not leaked over repeated requests.
|
|
16
|
+
*/
|
|
17
|
+
import { createHash, createHmac, timingSafeEqual } from 'node:crypto';
|
|
18
|
+
function hexHmacSha1(key, message) {
|
|
19
|
+
return createHmac('sha1', key).update(message, 'utf8').digest('hex');
|
|
20
|
+
}
|
|
21
|
+
function hexHmacSha256(key, message) {
|
|
22
|
+
return createHmac('sha256', key).update(message, 'utf8').digest('hex');
|
|
23
|
+
}
|
|
24
|
+
function b64HmacSha1(key, message) {
|
|
25
|
+
return createHmac('sha1', key).update(message, 'utf8').digest('base64');
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Constant-time compare two strings as utf-8 byte buffers.
|
|
29
|
+
* Returns false on length mismatch (which timingSafeEqual would otherwise
|
|
30
|
+
* throw on) — that mismatch by itself doesn't leak the secret because the
|
|
31
|
+
* length of the expected digest is a fixed constant per scheme.
|
|
32
|
+
*/
|
|
33
|
+
function safeEq(a, b) {
|
|
34
|
+
if (typeof a !== 'string' || typeof b !== 'string')
|
|
35
|
+
return false;
|
|
36
|
+
const aBuf = Buffer.from(a, 'utf8');
|
|
37
|
+
const bBuf = Buffer.from(b, 'utf8');
|
|
38
|
+
if (aBuf.length !== bBuf.length)
|
|
39
|
+
return false;
|
|
40
|
+
try {
|
|
41
|
+
return timingSafeEqual(aBuf, bBuf);
|
|
42
|
+
}
|
|
43
|
+
catch {
|
|
44
|
+
return false;
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
/** Stringify a single value the way the JS reference implementation does. */
|
|
48
|
+
function stringifyParamValue(v) {
|
|
49
|
+
if (v === null || v === undefined)
|
|
50
|
+
return '';
|
|
51
|
+
if (typeof v === 'string')
|
|
52
|
+
return v;
|
|
53
|
+
return String(v);
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* Concatenate form params per Scheme B rules:
|
|
57
|
+
*
|
|
58
|
+
* - Sort by key, ASCII ascending (stable).
|
|
59
|
+
* - For repeated keys: keep original submission order, emit ``key+value``
|
|
60
|
+
* once per occurrence.
|
|
61
|
+
*/
|
|
62
|
+
function sortedConcatParams(params) {
|
|
63
|
+
if (params === null || params === undefined)
|
|
64
|
+
return '';
|
|
65
|
+
// Normalize to an ordered list of [key, value] pairs.
|
|
66
|
+
const items = [];
|
|
67
|
+
if (params instanceof Map) {
|
|
68
|
+
for (const [k, v] of params) {
|
|
69
|
+
if (Array.isArray(v)) {
|
|
70
|
+
for (const vi of v)
|
|
71
|
+
items.push([k, vi]);
|
|
72
|
+
}
|
|
73
|
+
else {
|
|
74
|
+
items.push([k, v]);
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
else if (Array.isArray(params)) {
|
|
79
|
+
for (const [k, v] of params)
|
|
80
|
+
items.push([k, v]);
|
|
81
|
+
}
|
|
82
|
+
else {
|
|
83
|
+
for (const k of Object.keys(params)) {
|
|
84
|
+
const v = params[k];
|
|
85
|
+
if (Array.isArray(v)) {
|
|
86
|
+
for (const vi of v)
|
|
87
|
+
items.push([k, vi]);
|
|
88
|
+
}
|
|
89
|
+
else {
|
|
90
|
+
items.push([k, v]);
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
if (items.length === 0)
|
|
95
|
+
return '';
|
|
96
|
+
// Stable sort by key — preserves original order within repeated keys.
|
|
97
|
+
// Array.prototype.sort is stable in V8 since Node 12.
|
|
98
|
+
items.sort((a, b) => (a[0] < b[0] ? -1 : a[0] > b[0] ? 1 : 0));
|
|
99
|
+
let out = '';
|
|
100
|
+
for (const [k, v] of items)
|
|
101
|
+
out += k + stringifyParamValue(v);
|
|
102
|
+
return out;
|
|
103
|
+
}
|
|
104
|
+
/**
|
|
105
|
+
* Best-effort parse of an x-www-form-urlencoded body into ordered (k, v) pairs.
|
|
106
|
+
* Returns an empty list if the body doesn't look like form data; the caller
|
|
107
|
+
* then signs against ``url + ""``.
|
|
108
|
+
*/
|
|
109
|
+
function parseFormBody(rawBody) {
|
|
110
|
+
if (!rawBody)
|
|
111
|
+
return [];
|
|
112
|
+
// URLSearchParams preserves insertion order including repeats.
|
|
113
|
+
try {
|
|
114
|
+
const sp = new URLSearchParams(rawBody);
|
|
115
|
+
const out = [];
|
|
116
|
+
sp.forEach((v, k) => out.push([k, v]));
|
|
117
|
+
return out;
|
|
118
|
+
}
|
|
119
|
+
catch {
|
|
120
|
+
return [];
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
/**
|
|
124
|
+
* Split a URL into its parts without dropping anything. We avoid the
|
|
125
|
+
* ``URL`` class round-trip for assembly because that re-encodes characters,
|
|
126
|
+
* which would change the bytes the HMAC was computed over.
|
|
127
|
+
*/
|
|
128
|
+
function splitUrl(url) {
|
|
129
|
+
// Match RFC 3986-ish: scheme://[userinfo@]host[:port][/path][?query][#fragment]
|
|
130
|
+
const m = url.match(/^([a-zA-Z][a-zA-Z0-9+\-.]*):\/\/([^/?#]*)([^?#]*)(\?[^#]*)?(#.*)?$/);
|
|
131
|
+
if (!m) {
|
|
132
|
+
return {
|
|
133
|
+
scheme: '',
|
|
134
|
+
host: '',
|
|
135
|
+
port: '',
|
|
136
|
+
path: url,
|
|
137
|
+
query: '',
|
|
138
|
+
fragment: '',
|
|
139
|
+
hadAuth: false,
|
|
140
|
+
authority: '',
|
|
141
|
+
};
|
|
142
|
+
}
|
|
143
|
+
// Groups 1-3 are non-optional in the regex, so they are always present on a
|
|
144
|
+
// match; `?? ''` only satisfies the type checker (empty string is unreachable).
|
|
145
|
+
const scheme = m[1] ?? '';
|
|
146
|
+
const netloc = m[2] ?? '';
|
|
147
|
+
const path = m[3] ?? '';
|
|
148
|
+
const query = m[4] ? m[4].slice(1) : '';
|
|
149
|
+
const fragment = m[5] ? m[5].slice(1) : '';
|
|
150
|
+
// Split userinfo from host:port
|
|
151
|
+
let authority = '';
|
|
152
|
+
let hostPort = netloc;
|
|
153
|
+
const atIdx = netloc.lastIndexOf('@');
|
|
154
|
+
if (atIdx >= 0) {
|
|
155
|
+
authority = netloc.slice(0, atIdx + 1); // includes the trailing @
|
|
156
|
+
hostPort = netloc.slice(atIdx + 1);
|
|
157
|
+
}
|
|
158
|
+
let host = hostPort;
|
|
159
|
+
let port = '';
|
|
160
|
+
// IPv6 bracket form: [::1]:8080
|
|
161
|
+
if (hostPort.startsWith('[')) {
|
|
162
|
+
const close = hostPort.indexOf(']');
|
|
163
|
+
if (close >= 0) {
|
|
164
|
+
host = hostPort.slice(0, close + 1);
|
|
165
|
+
const rest = hostPort.slice(close + 1);
|
|
166
|
+
if (rest.startsWith(':'))
|
|
167
|
+
port = rest.slice(1);
|
|
168
|
+
}
|
|
169
|
+
}
|
|
170
|
+
else {
|
|
171
|
+
const colon = hostPort.lastIndexOf(':');
|
|
172
|
+
if (colon >= 0 && /^\d+$/.test(hostPort.slice(colon + 1))) {
|
|
173
|
+
host = hostPort.slice(0, colon);
|
|
174
|
+
port = hostPort.slice(colon + 1);
|
|
175
|
+
}
|
|
176
|
+
}
|
|
177
|
+
return {
|
|
178
|
+
scheme,
|
|
179
|
+
host,
|
|
180
|
+
port,
|
|
181
|
+
path,
|
|
182
|
+
query,
|
|
183
|
+
fragment,
|
|
184
|
+
hadAuth: authority.length > 0,
|
|
185
|
+
authority,
|
|
186
|
+
};
|
|
187
|
+
}
|
|
188
|
+
/** Reassemble a URL from its parts, replacing the port (or stripping it). */
|
|
189
|
+
function buildUrl(parts, port) {
|
|
190
|
+
if (!parts.scheme)
|
|
191
|
+
return parts.path;
|
|
192
|
+
const portPart = port ? `:${port}` : '';
|
|
193
|
+
const queryPart = parts.query ? `?${parts.query}` : '';
|
|
194
|
+
const fragPart = parts.fragment ? `#${parts.fragment}` : '';
|
|
195
|
+
return `${parts.scheme}://${parts.authority}${parts.host}${portPart}${parts.path}${queryPart}${fragPart}`;
|
|
196
|
+
}
|
|
197
|
+
/**
|
|
198
|
+
* Return the URL variants to try for Scheme B port normalization.
|
|
199
|
+
*
|
|
200
|
+
* - If the URL already has a non-standard port: just the input URL.
|
|
201
|
+
* - If https + no port: input URL AND url with ":443".
|
|
202
|
+
* - If http + no port: input URL AND url with ":80".
|
|
203
|
+
* - If https + ":443" / http + ":80": input URL AND url with port stripped.
|
|
204
|
+
* - Otherwise (any explicit non-standard port): just the input URL.
|
|
205
|
+
*/
|
|
206
|
+
function candidateUrls(url) {
|
|
207
|
+
const parts = splitUrl(url);
|
|
208
|
+
if (!parts.host)
|
|
209
|
+
return [url];
|
|
210
|
+
const standard = { http: '80', https: '443' };
|
|
211
|
+
const std = standard[parts.scheme.toLowerCase()] ?? '';
|
|
212
|
+
const out = [url];
|
|
213
|
+
if (!parts.port && std) {
|
|
214
|
+
const withPort = buildUrl(parts, std);
|
|
215
|
+
if (withPort !== url)
|
|
216
|
+
out.push(withPort);
|
|
217
|
+
}
|
|
218
|
+
else if (parts.port && std === parts.port) {
|
|
219
|
+
const withoutPort = buildUrl(parts, '');
|
|
220
|
+
if (withoutPort !== url)
|
|
221
|
+
out.push(withoutPort);
|
|
222
|
+
}
|
|
223
|
+
return out;
|
|
224
|
+
}
|
|
225
|
+
/** Pull a single query-param value out of the query string (no decoding magic). */
|
|
226
|
+
function queryParam(query, name) {
|
|
227
|
+
if (!query)
|
|
228
|
+
return undefined;
|
|
229
|
+
for (const piece of query.split('&')) {
|
|
230
|
+
if (!piece)
|
|
231
|
+
continue;
|
|
232
|
+
const eq = piece.indexOf('=');
|
|
233
|
+
const key = eq >= 0 ? piece.slice(0, eq) : piece;
|
|
234
|
+
const val = eq >= 0 ? piece.slice(eq + 1) : '';
|
|
235
|
+
if (decodeQueryComponent(key) === name)
|
|
236
|
+
return decodeQueryComponent(val);
|
|
237
|
+
}
|
|
238
|
+
return undefined;
|
|
239
|
+
}
|
|
240
|
+
function decodeQueryComponent(s) {
|
|
241
|
+
try {
|
|
242
|
+
return decodeURIComponent(s.replace(/\+/g, ' '));
|
|
243
|
+
}
|
|
244
|
+
catch {
|
|
245
|
+
return s;
|
|
246
|
+
}
|
|
247
|
+
}
|
|
248
|
+
/**
|
|
249
|
+
* If URL has ``?bodySHA256=<hex>``, verify ``sha256_hex(rawBody)`` matches.
|
|
250
|
+
* Returns true if the param is absent (no constraint) or present and matches.
|
|
251
|
+
*/
|
|
252
|
+
function checkBodySha256(url, rawBody) {
|
|
253
|
+
const parts = splitUrl(url);
|
|
254
|
+
const expected = queryParam(parts.query, 'bodySHA256');
|
|
255
|
+
if (expected === undefined)
|
|
256
|
+
return true;
|
|
257
|
+
const actual = createHash('sha256').update(rawBody, 'utf8').digest('hex');
|
|
258
|
+
return safeEq(actual, expected);
|
|
259
|
+
}
|
|
260
|
+
// ---------------------------------------------------------------------------
|
|
261
|
+
// Public API
|
|
262
|
+
// ---------------------------------------------------------------------------
|
|
263
|
+
/**
|
|
264
|
+
* Validate a SignalWire webhook signature against both schemes (A then B).
|
|
265
|
+
*
|
|
266
|
+
* @param signingKey The customer's Signing Key from the Dashboard. Empty / null
|
|
267
|
+
* throws ``Error`` — that's a programming error, not a validation failure.
|
|
268
|
+
* @param signature The ``X-SignalWire-Signature`` header value (or
|
|
269
|
+
* ``X-Twilio-Signature`` for cXML compat). Missing / empty returns ``false``
|
|
270
|
+
* without throwing.
|
|
271
|
+
* @param url The full URL SignalWire POSTed to (scheme, host, optional port,
|
|
272
|
+
* path, query). Must match what the platform saw — see the URL reconstruction
|
|
273
|
+
* rules in SignalWire's webhook signing documentation.
|
|
274
|
+
* @param rawBody The raw request body bytes as a UTF-8 string, BEFORE any
|
|
275
|
+
* JSON / form parsing. Must be a string — passing a parsed object throws
|
|
276
|
+
* ``TypeError``.
|
|
277
|
+
* @returns ``true`` if the signature matches either Scheme A (hex JSON) or
|
|
278
|
+
* Scheme B (base64 form, with port-normalization variants and optional
|
|
279
|
+
* bodySHA256 fallback). ``false`` otherwise.
|
|
280
|
+
* @throws Error when ``signingKey`` is missing / empty.
|
|
281
|
+
* @throws TypeError when ``rawBody`` is not a string.
|
|
282
|
+
*/
|
|
283
|
+
export function validateWebhookSignature(signingKey, signature, url, rawBody) {
|
|
284
|
+
if (!signingKey || typeof signingKey !== 'string') {
|
|
285
|
+
throw new Error('signingKey is required');
|
|
286
|
+
}
|
|
287
|
+
if (typeof rawBody !== 'string') {
|
|
288
|
+
throw new TypeError('rawBody must be a string; did you pass parsed JSON by mistake?');
|
|
289
|
+
}
|
|
290
|
+
if (signature === null || signature === undefined || signature === '') {
|
|
291
|
+
return false;
|
|
292
|
+
}
|
|
293
|
+
// ------------------------------------------------------------------
|
|
294
|
+
// Scheme A — RELAY/SWML/JSON: hex(HMAC-SHA1(key, url + rawBody))
|
|
295
|
+
// ------------------------------------------------------------------
|
|
296
|
+
const expectedA = hexHmacSha1(signingKey, url + rawBody);
|
|
297
|
+
if (safeEq(expectedA, signature)) {
|
|
298
|
+
return true;
|
|
299
|
+
}
|
|
300
|
+
// ------------------------------------------------------------------
|
|
301
|
+
// Scheme B — Compat/cXML form: base64(HMAC-SHA1(key, url + sortedConcat))
|
|
302
|
+
// Try with parsed form params; fall back to empty params for JSON-on-compat.
|
|
303
|
+
// Try both with-port and without-port URL variants.
|
|
304
|
+
// ------------------------------------------------------------------
|
|
305
|
+
const parsedParams = parseFormBody(rawBody);
|
|
306
|
+
const paramShapes = [parsedParams, []];
|
|
307
|
+
for (const candidateUrl of candidateUrls(url)) {
|
|
308
|
+
for (const shape of paramShapes) {
|
|
309
|
+
const concat = sortedConcatParams(shape);
|
|
310
|
+
const expectedB = b64HmacSha1(signingKey, candidateUrl + concat);
|
|
311
|
+
if (safeEq(expectedB, signature)) {
|
|
312
|
+
// If the URL carries bodySHA256, the body hash must match too.
|
|
313
|
+
if (checkBodySha256(candidateUrl, rawBody))
|
|
314
|
+
return true;
|
|
315
|
+
// bodySHA256 mismatched — keep trying other shapes/urls.
|
|
316
|
+
}
|
|
317
|
+
}
|
|
318
|
+
}
|
|
319
|
+
return false;
|
|
320
|
+
}
|
|
321
|
+
/**
|
|
322
|
+
* Validate the SHA-256 webhook signature (Scheme A with a stronger hash).
|
|
323
|
+
*
|
|
324
|
+
* SignalWire sends ``X-SignalWire-Sha256-Signature`` alongside the SHA-1
|
|
325
|
+
* ``X-SignalWire-Signature`` on signed webhooks. Its message is the same as
|
|
326
|
+
* Scheme A, hashed with SHA-256:
|
|
327
|
+
*
|
|
328
|
+
* hex(HMAC-SHA256(signingKey, url + rawBody))
|
|
329
|
+
*
|
|
330
|
+
* Only Scheme A (RELAY, SWML and JSON webhooks) is defined for this header; the
|
|
331
|
+
* cXML/form Scheme B stays on SHA-1 (see {@link validateWebhookSignature}).
|
|
332
|
+
*
|
|
333
|
+
* @param signingKey - The customer's Signing Key. Empty throws.
|
|
334
|
+
* @param signature - The ``X-SignalWire-Sha256-Signature`` header value
|
|
335
|
+
* (64-character lowercase hex). Missing or empty returns ``false``.
|
|
336
|
+
* @param url - The full public URL SignalWire POSTed to, exactly as the
|
|
337
|
+
* platform saw it when it computed the signature.
|
|
338
|
+
* @param rawBody - The raw request body, before any parsing.
|
|
339
|
+
* @returns ``true`` if the SHA-256 signature matches.
|
|
340
|
+
* @throws Error when ``signingKey`` is missing / empty.
|
|
341
|
+
* @throws TypeError when ``rawBody`` is not a string.
|
|
342
|
+
*/
|
|
343
|
+
export function validateWebhookSignatureSha256(signingKey, signature, url, rawBody) {
|
|
344
|
+
if (!signingKey || typeof signingKey !== 'string') {
|
|
345
|
+
throw new Error('signingKey is required');
|
|
346
|
+
}
|
|
347
|
+
if (typeof rawBody !== 'string') {
|
|
348
|
+
throw new TypeError('rawBody must be a string; did you pass parsed JSON by mistake?');
|
|
349
|
+
}
|
|
350
|
+
if (signature === null || signature === undefined || signature === '') {
|
|
351
|
+
return false;
|
|
352
|
+
}
|
|
353
|
+
return safeEq(hexHmacSha256(signingKey, url + rawBody), signature);
|
|
354
|
+
}
|
|
355
|
+
/**
|
|
356
|
+
* Legacy ``@signalwire/compatibility-api`` drop-in entry point.
|
|
357
|
+
*
|
|
358
|
+
* If ``paramsOrRawBody`` is a string, delegates to
|
|
359
|
+
* {@link validateWebhookSignature} (Scheme A then Scheme B with parsed form).
|
|
360
|
+
*
|
|
361
|
+
* If it's a record, Map, or list of [key, value] tuples, treats it as
|
|
362
|
+
* pre-parsed form params and runs Scheme B directly (with URL port
|
|
363
|
+
* normalization and optional bodySHA256 fallback).
|
|
364
|
+
*
|
|
365
|
+
* The parameter type matches Python's
|
|
366
|
+
* ``Union[str, Mapping[str, Any], List[Tuple[str, Any]], None]`` for
|
|
367
|
+
* a consistent cross-SDK signature. ``Map<string, unknown>`` is also
|
|
368
|
+
* accepted at runtime for ergonomic TS usage.
|
|
369
|
+
*
|
|
370
|
+
* @param signingKey Customer's Signing Key. Empty / null throws Error.
|
|
371
|
+
* @param signature Header value. Missing / empty returns false.
|
|
372
|
+
* @param url Full URL SignalWire POSTed to.
|
|
373
|
+
* @param paramsOrRawBody String raw body OR pre-parsed form params.
|
|
374
|
+
* @returns true on match, false otherwise.
|
|
375
|
+
* @throws Error when ``signingKey`` is missing.
|
|
376
|
+
* @throws TypeError when ``paramsOrRawBody`` is neither a string nor a
|
|
377
|
+
* record/Map/array of tuples (e.g. a plain number).
|
|
378
|
+
*/
|
|
379
|
+
export function validateRequest(signingKey, signature, url, paramsOrRawBody) {
|
|
380
|
+
if (!signingKey || typeof signingKey !== 'string') {
|
|
381
|
+
throw new Error('signingKey is required');
|
|
382
|
+
}
|
|
383
|
+
if (signature === null || signature === undefined || signature === '') {
|
|
384
|
+
return false;
|
|
385
|
+
}
|
|
386
|
+
if (typeof paramsOrRawBody === 'string') {
|
|
387
|
+
return validateWebhookSignature(signingKey, signature, url, paramsOrRawBody);
|
|
388
|
+
}
|
|
389
|
+
if (paramsOrRawBody === null || paramsOrRawBody === undefined) {
|
|
390
|
+
paramsOrRawBody = [];
|
|
391
|
+
}
|
|
392
|
+
const isMap = paramsOrRawBody instanceof Map;
|
|
393
|
+
const isArray = Array.isArray(paramsOrRawBody);
|
|
394
|
+
const isPlainObj = !isMap && !isArray && typeof paramsOrRawBody === 'object';
|
|
395
|
+
if (!isMap && !isArray && !isPlainObj) {
|
|
396
|
+
throw new TypeError('paramsOrRawBody must be a string (raw body) or a record/Map/array of form params');
|
|
397
|
+
}
|
|
398
|
+
// Pre-parsed form params → Scheme B only.
|
|
399
|
+
const concat = sortedConcatParams(paramsOrRawBody);
|
|
400
|
+
for (const candidateUrl of candidateUrls(url)) {
|
|
401
|
+
const expectedB = b64HmacSha1(signingKey, candidateUrl + concat);
|
|
402
|
+
if (safeEq(expectedB, signature)) {
|
|
403
|
+
// bodySHA256 has no raw body to verify here — skip that check.
|
|
404
|
+
return true;
|
|
405
|
+
}
|
|
406
|
+
}
|
|
407
|
+
return false;
|
|
408
|
+
}
|
|
409
|
+
//# sourceMappingURL=WebhookValidator.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"WebhookValidator.js","sourceRoot":"","sources":["../src/WebhookValidator.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAiBtE,SAAS,WAAW,CAAC,GAAW,EAAE,OAAe;IAC/C,OAAO,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AACvE,CAAC;AAED,SAAS,aAAa,CAAC,GAAW,EAAE,OAAe;IACjD,OAAO,UAAU,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AACzE,CAAC;AAED,SAAS,WAAW,CAAC,GAAW,EAAE,OAAe;IAC/C,OAAO,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;AAC1E,CAAC;AAED;;;;;GAKG;AACH,SAAS,MAAM,CAAC,CAAS,EAAE,CAAS;IAClC,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IACjE,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IACpC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IACpC,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM;QAAE,OAAO,KAAK,CAAC;IAC9C,IAAI,CAAC;QACH,OAAO,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACrC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,6EAA6E;AAC7E,SAAS,mBAAmB,CAAC,CAAiB;IAC5C,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,SAAS;QAAE,OAAO,EAAE,CAAC;IAC7C,IAAI,OAAO,CAAC,KAAK,QAAQ;QAAE,OAAO,CAAC,CAAC;IACpC,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC;AACnB,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CAAC,MAAqC;IAC/D,IAAI,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,EAAE,CAAC;IAEvD,sDAAsD;IACtD,MAAM,KAAK,GAAoC,EAAE,CAAC;IAClD,IAAI,MAAM,YAAY,GAAG,EAAE,CAAC;QAC1B,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,EAAE,CAAC;YAC5B,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;gBACrB,KAAK,MAAM,EAAE,IAAI,CAAC;oBAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;YAC1C,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YACrB,CAAC;QACH,CAAC;IACH,CAAC;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACjC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM;YAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAClD,CAAC;SAAM,CAAC;QACN,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACpC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;YACpB,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;gBACrB,KAAK,MAAM,EAAE,IAAI,CAAC;oBAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;YAC1C,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YACrB,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IAElC,sEAAsE;IACtE,sDAAsD;IACtD,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAE/D,IAAI,GAAG,GAAG,EAAE,CAAC;IACb,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,KAAK;QAAE,GAAG,IAAI,CAAC,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAAC;IAC9D,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;GAIG;AACH,SAAS,aAAa,CAAC,OAAe;IACpC,IAAI,CAAC,OAAO;QAAE,OAAO,EAAE,CAAC;IACxB,+DAA+D;IAC/D,IAAI,CAAC;QACH,MAAM,EAAE,GAAG,IAAI,eAAe,CAAC,OAAO,CAAC,CAAC;QACxC,MAAM,GAAG,GAA4B,EAAE,CAAC;QACxC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QACvC,OAAO,GAAG,CAAC;IACb,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC;AAaD;;;;GAIG;AACH,SAAS,QAAQ,CAAC,GAAW;IAC3B,gFAAgF;IAChF,MAAM,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,oEAAoE,CAAC,CAAC;IAC1F,IAAI,CAAC,CAAC,EAAE,CAAC;QACP,OAAO;YACL,MAAM,EAAE,EAAE;YACV,IAAI,EAAE,EAAE;YACR,IAAI,EAAE,EAAE;YACR,IAAI,EAAE,GAAG;YACT,KAAK,EAAE,EAAE;YACT,QAAQ,EAAE,EAAE;YACZ,OAAO,EAAE,KAAK;YACd,SAAS,EAAE,EAAE;SACd,CAAC;IACJ,CAAC;IACD,4EAA4E;IAC5E,gFAAgF;IAChF,MAAM,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAC1B,MAAM,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAC1B,MAAM,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACxB,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACxC,MAAM,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAE3C,gCAAgC;IAChC,IAAI,SAAS,GAAG,EAAE,CAAC;IACnB,IAAI,QAAQ,GAAG,MAAM,CAAC;IACtB,MAAM,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IACtC,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;QACf,SAAS,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,0BAA0B;QAClE,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;IACrC,CAAC;IAED,IAAI,IAAI,GAAG,QAAQ,CAAC;IACpB,IAAI,IAAI,GAAG,EAAE,CAAC;IACd,gCAAgC;IAChC,IAAI,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QAC7B,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;YACf,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;YACpC,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;YACvC,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;gBAAE,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACjD,CAAC;IACH,CAAC;SAAM,CAAC;QACN,MAAM,KAAK,GAAG,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACxC,IAAI,KAAK,IAAI,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;YAC1D,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAChC,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;IAED,OAAO;QACL,MAAM;QACN,IAAI;QACJ,IAAI;QACJ,IAAI;QACJ,KAAK;QACL,QAAQ;QACR,OAAO,EAAE,SAAS,CAAC,MAAM,GAAG,CAAC;QAC7B,SAAS;KACV,CAAC;AACJ,CAAC;AAED,6EAA6E;AAC7E,SAAS,QAAQ,CAAC,KAAe,EAAE,IAAY;IAC7C,IAAI,CAAC,KAAK,CAAC,MAAM;QAAE,OAAO,KAAK,CAAC,IAAI,CAAC;IACrC,MAAM,QAAQ,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACxC,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACvD,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5D,OAAO,GAAG,KAAK,CAAC,MAAM,MAAM,KAAK,CAAC,SAAS,GAAG,KAAK,CAAC,IAAI,GAAG,QAAQ,GAAG,KAAK,CAAC,IAAI,GAAG,SAAS,GAAG,QAAQ,EAAE,CAAC;AAC5G,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,aAAa,CAAC,GAAW;IAChC,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC5B,IAAI,CAAC,KAAK,CAAC,IAAI;QAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IAE9B,MAAM,QAAQ,GAA2B,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;IACtE,MAAM,GAAG,GAAG,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC;IAEvD,MAAM,GAAG,GAAa,CAAC,GAAG,CAAC,CAAC;IAE5B,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,GAAG,EAAE,CAAC;QACvB,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QACtC,IAAI,QAAQ,KAAK,GAAG;YAAE,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC;SAAM,IAAI,KAAK,CAAC,IAAI,IAAI,GAAG,KAAK,KAAK,CAAC,IAAI,EAAE,CAAC;QAC5C,MAAM,WAAW,GAAG,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACxC,IAAI,WAAW,KAAK,GAAG;YAAE,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACjD,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,mFAAmF;AACnF,SAAS,UAAU,CAAC,KAAa,EAAE,IAAY;IAC7C,IAAI,CAAC,KAAK;QAAE,OAAO,SAAS,CAAC;IAC7B,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;QACrC,IAAI,CAAC,KAAK;YAAE,SAAS;QACrB,MAAM,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC9B,MAAM,GAAG,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QACjD,MAAM,GAAG,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/C,IAAI,oBAAoB,CAAC,GAAG,CAAC,KAAK,IAAI;YAAE,OAAO,oBAAoB,CAAC,GAAG,CAAC,CAAC;IAC3E,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,oBAAoB,CAAC,CAAS;IACrC,IAAI,CAAC;QACH,OAAO,kBAAkB,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;IACnD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,CAAC,CAAC;IACX,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,SAAS,eAAe,CAAC,GAAW,EAAE,OAAe;IACnD,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC5B,MAAM,QAAQ,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;IACvD,IAAI,QAAQ,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IACxC,MAAM,MAAM,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC1E,OAAO,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AAClC,CAAC;AAED,8EAA8E;AAC9E,aAAa;AACb,8EAA8E;AAE9E;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,wBAAwB,CACtC,UAAkB,EAClB,SAAiB,EACjB,GAAW,EACX,OAAe;IAEf,IAAI,CAAC,UAAU,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;QAClD,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC5C,CAAC;IACD,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAChC,MAAM,IAAI,SAAS,CAAC,gEAAgE,CAAC,CAAC;IACxF,CAAC;IACD,IAAI,SAAS,KAAK,IAAI,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,KAAK,EAAE,EAAE,CAAC;QACtE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,qEAAqE;IACrE,iEAAiE;IACjE,qEAAqE;IACrE,MAAM,SAAS,GAAG,WAAW,CAAC,UAAU,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC;IACzD,IAAI,MAAM,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,qEAAqE;IACrE,0EAA0E;IAC1E,6EAA6E;IAC7E,oDAAoD;IACpD,qEAAqE;IACrE,MAAM,YAAY,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;IAC5C,MAAM,WAAW,GAA2C,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;IAE/E,KAAK,MAAM,YAAY,IAAI,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;QAC9C,KAAK,MAAM,KAAK,IAAI,WAAW,EAAE,CAAC;YAChC,MAAM,MAAM,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;YACzC,MAAM,SAAS,GAAG,WAAW,CAAC,UAAU,EAAE,YAAY,GAAG,MAAM,CAAC,CAAC;YACjE,IAAI,MAAM,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,CAAC;gBACjC,+DAA+D;gBAC/D,IAAI,eAAe,CAAC,YAAY,EAAE,OAAO,CAAC;oBAAE,OAAO,IAAI,CAAC;gBACxD,yDAAyD;YAC3D,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,8BAA8B,CAC5C,UAAkB,EAClB,SAAiB,EACjB,GAAW,EACX,OAAe;IAEf,IAAI,CAAC,UAAU,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;QAClD,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC5C,CAAC;IACD,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAChC,MAAM,IAAI,SAAS,CAAC,gEAAgE,CAAC,CAAC;IACxF,CAAC;IACD,IAAI,SAAS,KAAK,IAAI,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,KAAK,EAAE,EAAE,CAAC;QACtE,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,MAAM,CAAC,aAAa,CAAC,UAAU,EAAE,GAAG,GAAG,OAAO,CAAC,EAAE,SAAS,CAAC,CAAC;AACrE,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,UAAU,eAAe,CAC7B,UAAkB,EAClB,SAAiB,EACjB,GAAW,EACX,eAA+F;IAE/F,IAAI,CAAC,UAAU,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;QAClD,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC5C,CAAC;IACD,IAAI,SAAS,KAAK,IAAI,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,KAAK,EAAE,EAAE,CAAC;QACtE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,OAAO,eAAe,KAAK,QAAQ,EAAE,CAAC;QACxC,OAAO,wBAAwB,CAAC,UAAU,EAAE,SAAS,EAAE,GAAG,EAAE,eAAe,CAAC,CAAC;IAC/E,CAAC;IAED,IAAI,eAAe,KAAK,IAAI,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;QAC9D,eAAe,GAAG,EAAE,CAAC;IACvB,CAAC;IAED,MAAM,KAAK,GAAG,eAAe,YAAY,GAAG,CAAC;IAC7C,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;IAC/C,MAAM,UAAU,GAAG,CAAC,KAAK,IAAI,CAAC,OAAO,IAAI,OAAO,eAAe,KAAK,QAAQ,CAAC;IAE7E,IAAI,CAAC,KAAK,IAAI,CAAC,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC;QACtC,MAAM,IAAI,SAAS,CACjB,kFAAkF,CACnF,CAAC;IACJ,CAAC;IAED,0CAA0C;IAC1C,MAAM,MAAM,GAAG,kBAAkB,CAAC,eAA6B,CAAC,CAAC;IACjE,KAAK,MAAM,YAAY,IAAI,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;QAC9C,MAAM,SAAS,GAAG,WAAW,CAAC,UAAU,EAAE,YAAY,GAAG,MAAM,CAAC,CAAC;QACjE,IAAI,MAAM,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,CAAC;YACjC,+DAA+D;YAC/D,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}
|
|
@@ -0,0 +1,162 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* BedrockAgent - Amazon Bedrock voice-to-voice integration.
|
|
3
|
+
*
|
|
4
|
+
* Extends {@link AgentBase} to support Amazon Bedrock's voice-to-voice model
|
|
5
|
+
* while keeping full compatibility with the SignalWire agent ecosystem
|
|
6
|
+
* (skills, POM, SWAIG functions, post-prompt). The one behavioral difference
|
|
7
|
+
* from a standard agent is that the rendered SWML uses the `amazon_bedrock`
|
|
8
|
+
* verb instead of `ai`. Speech hints, languages, pronunciation rules,
|
|
9
|
+
* multilingual settings and contexts aren't part of that verb, so they're
|
|
10
|
+
* left out of the SWML, with one warning per agent for each.
|
|
11
|
+
*
|
|
12
|
+
* Ported from the Python SDK `signalwire.agents.bedrock.BedrockAgent`.
|
|
13
|
+
*/
|
|
14
|
+
import { AgentBase } from '../AgentBase.js';
|
|
15
|
+
import type { AgentOptions } from '../types.js';
|
|
16
|
+
/** Configuration for the {@link BedrockAgent}. */
|
|
17
|
+
export interface BedrockAgentConfig {
|
|
18
|
+
/** Agent display name (defaults to `"bedrock_agent"`). */
|
|
19
|
+
name?: string;
|
|
20
|
+
/** HTTP route for this agent (defaults to `"/bedrock"`). */
|
|
21
|
+
route?: string;
|
|
22
|
+
/** Initial system prompt (can be overridden later with `setPromptText`). */
|
|
23
|
+
systemPrompt?: string;
|
|
24
|
+
/** Bedrock voice: `tiffany`, `matthew`, `amy`, `lupe` or `carlos` (defaults to `"matthew"`). */
|
|
25
|
+
voiceId?: string;
|
|
26
|
+
/**
|
|
27
|
+
* Generation temperature (0-2). Defaults to 0.7. A numeric string is
|
|
28
|
+
* converted, and a SWML variable reference such as `${temperature}` is
|
|
29
|
+
* passed through.
|
|
30
|
+
*/
|
|
31
|
+
temperature?: number | string;
|
|
32
|
+
/**
|
|
33
|
+
* Nucleus sampling parameter (0-1). Defaults to 0.9. A numeric string is
|
|
34
|
+
* converted, and a SWML variable reference such as `${top_p}` is passed
|
|
35
|
+
* through.
|
|
36
|
+
*/
|
|
37
|
+
topP?: number | string;
|
|
38
|
+
/**
|
|
39
|
+
* Maximum tokens to generate. Defaults to 1024. A numeric string is
|
|
40
|
+
* converted. The platform's Bedrock session doesn't read it; it uses 1024.
|
|
41
|
+
*/
|
|
42
|
+
maxTokens?: number | string;
|
|
43
|
+
/** Additional AgentBase options forwarded to `super()`. */
|
|
44
|
+
agentOptions?: Partial<AgentOptions>;
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* Agent implementation for the Amazon Bedrock voice-to-voice model.
|
|
48
|
+
*
|
|
49
|
+
* Supports all standard agent features (prompt building with text and POM,
|
|
50
|
+
* skills and SWAIG functions, post-prompt, dynamic configuration) but renders
|
|
51
|
+
* SWML with the `amazon_bedrock` verb rather than `ai`.
|
|
52
|
+
*
|
|
53
|
+
* @example
|
|
54
|
+
* ```ts
|
|
55
|
+
* import { BedrockAgent } from '@signalwire/sdk';
|
|
56
|
+
*
|
|
57
|
+
* const agent = new BedrockAgent({
|
|
58
|
+
* systemPrompt: 'You are a helpful voice assistant.',
|
|
59
|
+
* voiceId: 'tiffany',
|
|
60
|
+
* });
|
|
61
|
+
*
|
|
62
|
+
* agent.setInferenceParams(0.5, 0.95, 2048);
|
|
63
|
+
* await agent.serve({ port: 3000 });
|
|
64
|
+
* ```
|
|
65
|
+
*/
|
|
66
|
+
export declare class BedrockAgent extends AgentBase {
|
|
67
|
+
private _voiceId;
|
|
68
|
+
private _temperature;
|
|
69
|
+
private _topP;
|
|
70
|
+
private _maxTokens;
|
|
71
|
+
/**
|
|
72
|
+
* Features already reported as left out of the `amazon_bedrock` verb, so
|
|
73
|
+
* each is reported once per agent. A per-request copy shares this set.
|
|
74
|
+
*/
|
|
75
|
+
private _bedrockDroppedWarned;
|
|
76
|
+
/**
|
|
77
|
+
* Create a BedrockAgent.
|
|
78
|
+
* @param config - Configuration including voice, inference params, and optional system prompt.
|
|
79
|
+
* @throws Error if `temperature` or `topP` isn't a number, or `maxTokens` isn't an integer.
|
|
80
|
+
*/
|
|
81
|
+
constructor(config?: BedrockAgentConfig);
|
|
82
|
+
/**
|
|
83
|
+
* Render the SWML document, transforming the base `ai` verb into an
|
|
84
|
+
* `amazon_bedrock` verb with the same structure. Mirrors Python
|
|
85
|
+
* `BedrockAgent._render_swml`.
|
|
86
|
+
*
|
|
87
|
+
* Only `prompt`, `SWAIG`, `params`, `global_data`, `post_prompt` and
|
|
88
|
+
* `post_prompt_url` are carried over. Anything else on the `ai` verb, such
|
|
89
|
+
* as `hints`, `languages`, `pronounce`, `multilingual` or the debug webhook
|
|
90
|
+
* keys, is left out, as is anything in the prompt that the Bedrock prompt
|
|
91
|
+
* doesn't define, such as `contexts`. The agent logs one warning for each
|
|
92
|
+
* feature it leaves out, the first time it leaves it out.
|
|
93
|
+
*/
|
|
94
|
+
renderSwml(callId?: string, modifications?: Record<string, unknown>): string;
|
|
95
|
+
/** Log a warning, once per agent, for each feature left out of the SWML. */
|
|
96
|
+
private warnDropped;
|
|
97
|
+
/**
|
|
98
|
+
* Add voice configuration to the prompt object. In Bedrock, voice and
|
|
99
|
+
* inference params are part of the prompt object (not separate fields).
|
|
100
|
+
* Mirrors Python `_add_voice_to_prompt`.
|
|
101
|
+
*/
|
|
102
|
+
private addVoiceToPrompt;
|
|
103
|
+
/**
|
|
104
|
+
* Set the Bedrock voice: `tiffany`, `matthew`, `amy`, `lupe` or `carlos`.
|
|
105
|
+
* Mirrors Python `set_voice`.
|
|
106
|
+
*/
|
|
107
|
+
setVoice(voiceId: string): this;
|
|
108
|
+
/**
|
|
109
|
+
* Update Bedrock inference parameters. Any argument left undefined (or
|
|
110
|
+
* null) is unchanged. Each value may be a number or a numeric string, which
|
|
111
|
+
* is converted. `temperature` and `topP` may also be a SWML variable
|
|
112
|
+
* reference such as `${temperature}`. The platform's Bedrock session applies
|
|
113
|
+
* `temperature` (0 to 2) and `topP` (0 to 1), and doesn't read `maxTokens`: it
|
|
114
|
+
* uses 1024. Mirrors Python `set_inference_params`.
|
|
115
|
+
*
|
|
116
|
+
* @throws Error if `temperature` or `topP` isn't a number, or `maxTokens`
|
|
117
|
+
* isn't an integer. Nothing is changed when a value is refused.
|
|
118
|
+
*/
|
|
119
|
+
setInferenceParams(temperature?: number | string | null, topP?: number | string | null, maxTokens?: number | string | null): this;
|
|
120
|
+
/**
|
|
121
|
+
* Set the LLM model — not applicable for Bedrock, which uses a fixed
|
|
122
|
+
* voice-to-voice model. Logs a warning and does nothing.
|
|
123
|
+
* Mirrors Python `set_llm_model`.
|
|
124
|
+
*/
|
|
125
|
+
setLlmModel(model: string): this;
|
|
126
|
+
/**
|
|
127
|
+
* Set the LLM temperature — redirects to {@link setInferenceParams}.
|
|
128
|
+
* Mirrors Python `set_llm_temperature`.
|
|
129
|
+
*
|
|
130
|
+
* @throws Error if `temperature` isn't a number or a SWML variable reference.
|
|
131
|
+
*/
|
|
132
|
+
setLlmTemperature(temperature: number | string): this;
|
|
133
|
+
/**
|
|
134
|
+
* Set post-prompt LLM parameters — not applicable for Bedrock (its
|
|
135
|
+
* post-prompt uses OpenAI configured in the engine). Logs a warning.
|
|
136
|
+
* Mirrors Python `set_post_prompt_llm_params`.
|
|
137
|
+
*/
|
|
138
|
+
setPostPromptLlmParams(_params: Record<string, unknown>): this;
|
|
139
|
+
/**
|
|
140
|
+
* Set the prompt's inference settings.
|
|
141
|
+
*
|
|
142
|
+
* `temperature`, `top_p` and `max_tokens` update the inference settings, as
|
|
143
|
+
* {@link setInferenceParams} does, which converts numeric strings and
|
|
144
|
+
* throws for other values. The platform's Bedrock session reads no other
|
|
145
|
+
* prompt setting, so anything else, such as `confidence`,
|
|
146
|
+
* `presence_penalty` or `barge_confidence`, is ignored with a warning.
|
|
147
|
+
* Mirrors Python `set_prompt_llm_params`.
|
|
148
|
+
*
|
|
149
|
+
* @param params - Prompt settings, with their SWML names.
|
|
150
|
+
* @returns This agent, for chaining.
|
|
151
|
+
* @throws Error if `temperature` or `top_p` isn't a number, or `max_tokens`
|
|
152
|
+
* isn't an integer. Nothing is changed when a value is refused.
|
|
153
|
+
*/
|
|
154
|
+
setPromptLlmParams(params: Record<string, unknown>): this;
|
|
155
|
+
}
|
|
156
|
+
/**
|
|
157
|
+
* Factory function that creates and returns a new BedrockAgent.
|
|
158
|
+
* @param config - Configuration for the Bedrock agent.
|
|
159
|
+
* @returns A configured BedrockAgent instance.
|
|
160
|
+
*/
|
|
161
|
+
export declare function createBedrockAgent(config?: BedrockAgentConfig): BedrockAgent;
|
|
162
|
+
export default BedrockAgent;
|