@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/SWMLService.js
CHANGED
|
@@ -8,13 +8,16 @@
|
|
|
8
8
|
import { Hono } from 'hono';
|
|
9
9
|
import { cors } from 'hono/cors';
|
|
10
10
|
import { basicAuth } from 'hono/basic-auth';
|
|
11
|
-
import { randomBytes } from 'node:crypto';
|
|
11
|
+
import { createHash, randomBytes, timingSafeEqual } from 'node:crypto';
|
|
12
|
+
import { corsOriginsFromEnv } from './SecurityUtils.js';
|
|
12
13
|
import { SwmlBuilder } from './SwmlBuilder.js';
|
|
13
14
|
import { SchemaUtils } from './SchemaUtils.js';
|
|
14
15
|
import { SslConfig } from './SslConfig.js';
|
|
15
16
|
import { ConfigLoader } from './ConfigLoader.js';
|
|
16
17
|
import { getLogger } from './Logger.js';
|
|
17
18
|
import { SwaigFunction } from './SwaigFunction.js';
|
|
19
|
+
import { applyGateFields, _hasGateFields } from './SemanticGate.js';
|
|
20
|
+
import { FunctionResult } from './FunctionResult.js';
|
|
18
21
|
/**
|
|
19
22
|
* Registry for custom SWML verb handlers.
|
|
20
23
|
* Mirrors Python SDK's `VerbHandlerRegistry`.
|
|
@@ -52,6 +55,20 @@ export class SecurityConfig {
|
|
|
52
55
|
basicAuthUser;
|
|
53
56
|
/** Basic auth password from config, or null. */
|
|
54
57
|
basicAuthPassword;
|
|
58
|
+
/**
|
|
59
|
+
* Where {@link basicAuthPassword} came from: `'environment'`
|
|
60
|
+
* (`SWML_BASIC_AUTH_PASSWORD`), `'config file'` (which takes precedence), or
|
|
61
|
+
* `null` when neither set one.
|
|
62
|
+
*/
|
|
63
|
+
basicAuthSource;
|
|
64
|
+
/** Allowed request hosts (`['*']` = allow all). */
|
|
65
|
+
allowedHosts;
|
|
66
|
+
/** Allowed CORS origins. */
|
|
67
|
+
corsOrigins;
|
|
68
|
+
/** Whether to emit an HSTS header on HTTPS responses. */
|
|
69
|
+
useHsts;
|
|
70
|
+
/** HSTS `max-age` in seconds. */
|
|
71
|
+
hstsMaxAge;
|
|
55
72
|
sslConfig;
|
|
56
73
|
constructor(opts) {
|
|
57
74
|
// Load SSL config from env vars / options
|
|
@@ -60,14 +77,50 @@ export class SecurityConfig {
|
|
|
60
77
|
this.sslCertPath = this.sslConfig.certPath;
|
|
61
78
|
this.sslKeyPath = this.sslConfig.keyPath;
|
|
62
79
|
this.domain = this.sslConfig.domain;
|
|
63
|
-
// Auth defaults from env vars
|
|
64
|
-
this.basicAuthUser = process.env['SWML_BASIC_AUTH_USER']
|
|
65
|
-
this.basicAuthPassword = process.env['SWML_BASIC_AUTH_PASSWORD']
|
|
80
|
+
// Auth + host/CORS/HSTS defaults from env vars
|
|
81
|
+
this.basicAuthUser = process.env['SWML_BASIC_AUTH_USER'] || null;
|
|
82
|
+
this.basicAuthPassword = process.env['SWML_BASIC_AUTH_PASSWORD'] || null;
|
|
83
|
+
this.basicAuthSource = this.basicAuthPassword ? 'environment' : null;
|
|
84
|
+
this.allowedHosts = ['*'];
|
|
85
|
+
this.corsOrigins = ['*'];
|
|
86
|
+
this.useHsts = true;
|
|
87
|
+
this.hstsMaxAge = 31536000;
|
|
88
|
+
this.loadFromEnv();
|
|
66
89
|
// Load from config file if available
|
|
67
90
|
if (opts?.configFile) {
|
|
68
91
|
this.loadFromConfigFile(opts.configFile);
|
|
69
92
|
}
|
|
70
93
|
}
|
|
94
|
+
/** Split a comma-separated env value into a trimmed, non-empty list. */
|
|
95
|
+
static parseList(value) {
|
|
96
|
+
if (value === undefined)
|
|
97
|
+
return null;
|
|
98
|
+
const items = value
|
|
99
|
+
.split(',')
|
|
100
|
+
.map((s) => s.trim())
|
|
101
|
+
.filter((s) => s.length > 0);
|
|
102
|
+
return items.length > 0 ? items : null;
|
|
103
|
+
}
|
|
104
|
+
/**
|
|
105
|
+
* (Re)load host/CORS/HSTS settings from environment variables. Mirrors Python
|
|
106
|
+
* SDK's `SecurityConfig.load_from_env()`. SSL/auth are loaded in the constructor
|
|
107
|
+
* from their own env vars; this refreshes the network-policy fields.
|
|
108
|
+
*/
|
|
109
|
+
loadFromEnv() {
|
|
110
|
+
const hosts = SecurityConfig.parseList(process.env['SWML_ALLOWED_HOSTS']);
|
|
111
|
+
if (hosts)
|
|
112
|
+
this.allowedHosts = hosts;
|
|
113
|
+
const cors = SecurityConfig.parseList(process.env['SWML_CORS_ORIGINS']);
|
|
114
|
+
if (cors)
|
|
115
|
+
this.corsOrigins = cors;
|
|
116
|
+
if (process.env['SWML_USE_HSTS'] !== undefined) {
|
|
117
|
+
this.useHsts = process.env['SWML_USE_HSTS'] === 'true';
|
|
118
|
+
}
|
|
119
|
+
const maxAge = process.env['SWML_HSTS_MAX_AGE'];
|
|
120
|
+
if (maxAge !== undefined && !Number.isNaN(Number(maxAge))) {
|
|
121
|
+
this.hstsMaxAge = Number(maxAge);
|
|
122
|
+
}
|
|
123
|
+
}
|
|
71
124
|
loadFromConfigFile(filePath) {
|
|
72
125
|
try {
|
|
73
126
|
const loader = new ConfigLoader(filePath);
|
|
@@ -82,22 +135,35 @@ export class SecurityConfig {
|
|
|
82
135
|
if (typeof ssl['domain'] === 'string')
|
|
83
136
|
this.domain = ssl['domain'];
|
|
84
137
|
}
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
138
|
+
// `security.auth.basic` is the reference's key; `security.basicAuth` is
|
|
139
|
+
// this SDK's earlier spelling, still read. The config file takes
|
|
140
|
+
// precedence over the environment.
|
|
141
|
+
for (const key of ['security.basicAuth', 'security.auth.basic']) {
|
|
142
|
+
const auth = loader.get(key);
|
|
143
|
+
if (!auth || typeof auth !== 'object')
|
|
144
|
+
continue;
|
|
145
|
+
// An empty value sets nothing: an empty password would otherwise
|
|
146
|
+
// erase a working one from the environment and leave the service
|
|
147
|
+
// with no configured credentials.
|
|
148
|
+
if (typeof auth['user'] === 'string' && auth['user'])
|
|
88
149
|
this.basicAuthUser = auth['user'];
|
|
89
|
-
if (typeof auth['password'] === 'string')
|
|
150
|
+
if (typeof auth['password'] === 'string' && auth['password']) {
|
|
90
151
|
this.basicAuthPassword = auth['password'];
|
|
152
|
+
this.basicAuthSource = 'config file';
|
|
153
|
+
}
|
|
91
154
|
}
|
|
92
155
|
}
|
|
93
156
|
catch {
|
|
94
157
|
// Config file load failures are non-fatal
|
|
95
158
|
}
|
|
96
159
|
}
|
|
97
|
-
/**
|
|
160
|
+
/**
|
|
161
|
+
* Get basic auth credentials from the config file or environment, or null
|
|
162
|
+
* when no password is configured. The user defaults to `signalwire`.
|
|
163
|
+
*/
|
|
98
164
|
getBasicAuth() {
|
|
99
|
-
if (this.
|
|
100
|
-
return [this.basicAuthUser, this.basicAuthPassword];
|
|
165
|
+
if (this.basicAuthPassword) {
|
|
166
|
+
return [this.basicAuthUser || 'signalwire', this.basicAuthPassword];
|
|
101
167
|
}
|
|
102
168
|
return null;
|
|
103
169
|
}
|
|
@@ -111,6 +177,85 @@ export class SecurityConfig {
|
|
|
111
177
|
return [false, 'SSL key path not configured'];
|
|
112
178
|
return this.sslConfig.isConfigured() ? [true, null] : [false, 'SSL cert or key file not found'];
|
|
113
179
|
}
|
|
180
|
+
/**
|
|
181
|
+
* Build the SSL parameters for the HTTPS server, as a plain dictionary of
|
|
182
|
+
* primitive filesystem paths. Mirrors Python's
|
|
183
|
+
* `SecurityConfig.get_ssl_context_kwargs()` verbatim: the reference targets
|
|
184
|
+
* uvicorn's `ssl_certfile`/`ssl_keyfile` kwargs, and this returns the exact
|
|
185
|
+
* same primitive path pair (the TS HTTPS server passes them to
|
|
186
|
+
* `node:https.createServer` / `readFileSync`). Returns an empty object when
|
|
187
|
+
* SSL is disabled or the cert/key files fail validation.
|
|
188
|
+
* @returns `{ ssl_certfile, ssl_keyfile }` path strings, or `{}` when unavailable.
|
|
189
|
+
*/
|
|
190
|
+
getSslContextKwargs() {
|
|
191
|
+
if (!this.sslEnabled)
|
|
192
|
+
return {};
|
|
193
|
+
const [isValid] = this.validateSslConfig();
|
|
194
|
+
if (!isValid)
|
|
195
|
+
return {};
|
|
196
|
+
return {
|
|
197
|
+
ssl_certfile: this.sslCertPath,
|
|
198
|
+
ssl_keyfile: this.sslKeyPath,
|
|
199
|
+
};
|
|
200
|
+
}
|
|
201
|
+
/** Get the URL scheme based on SSL configuration. Mirrors Python's `get_url_scheme()`. */
|
|
202
|
+
getUrlScheme() {
|
|
203
|
+
return this.sslEnabled ? 'https' : 'http';
|
|
204
|
+
}
|
|
205
|
+
/**
|
|
206
|
+
* Check whether a host is allowed. Mirrors Python's `should_allow_host()`:
|
|
207
|
+
* a wildcard `*` in the allow-list permits any host.
|
|
208
|
+
*/
|
|
209
|
+
shouldAllowHost(host) {
|
|
210
|
+
if (this.allowedHosts.includes('*'))
|
|
211
|
+
return true;
|
|
212
|
+
return this.allowedHosts.includes(host);
|
|
213
|
+
}
|
|
214
|
+
/**
|
|
215
|
+
* Get CORS configuration. Mirrors Python's `get_cors_config()`.
|
|
216
|
+
* @returns An object of CORS settings (origins, credentials, methods, headers).
|
|
217
|
+
*/
|
|
218
|
+
getCorsConfig() {
|
|
219
|
+
return {
|
|
220
|
+
allow_origins: this.corsOrigins,
|
|
221
|
+
allow_credentials: true,
|
|
222
|
+
allow_methods: ['*'],
|
|
223
|
+
allow_headers: ['*'],
|
|
224
|
+
};
|
|
225
|
+
}
|
|
226
|
+
/**
|
|
227
|
+
* Get the security headers to add to responses. Mirrors Python's
|
|
228
|
+
* `get_security_headers()`; adds an HSTS header when the request is HTTPS and
|
|
229
|
+
* HSTS is enabled.
|
|
230
|
+
* @param isHttps - Whether the connection is over HTTPS.
|
|
231
|
+
*/
|
|
232
|
+
getSecurityHeaders(isHttps = false) {
|
|
233
|
+
const headers = {
|
|
234
|
+
'X-Content-Type-Options': 'nosniff',
|
|
235
|
+
'X-Frame-Options': 'DENY',
|
|
236
|
+
'X-XSS-Protection': '1; mode=block',
|
|
237
|
+
'Referrer-Policy': 'strict-origin-when-cross-origin',
|
|
238
|
+
};
|
|
239
|
+
if (isHttps && this.useHsts) {
|
|
240
|
+
headers['Strict-Transport-Security'] = `max-age=${this.hstsMaxAge}; includeSubDomains`;
|
|
241
|
+
}
|
|
242
|
+
return headers;
|
|
243
|
+
}
|
|
244
|
+
/**
|
|
245
|
+
* Log the current security configuration. Mirrors Python's `log_config()`.
|
|
246
|
+
* @param serviceName - The service name to tag the log line with.
|
|
247
|
+
*/
|
|
248
|
+
logConfig(serviceName) {
|
|
249
|
+
getLogger('SecurityConfig').info('security_config_loaded', {
|
|
250
|
+
service: serviceName,
|
|
251
|
+
ssl_enabled: this.sslEnabled,
|
|
252
|
+
domain: this.domain,
|
|
253
|
+
allowed_hosts: this.allowedHosts,
|
|
254
|
+
cors_origins: this.corsOrigins,
|
|
255
|
+
use_hsts: this.useHsts,
|
|
256
|
+
has_basic_auth: !!(this.basicAuthUser && this.basicAuthPassword),
|
|
257
|
+
});
|
|
258
|
+
}
|
|
114
259
|
}
|
|
115
260
|
// ── SWMLService class ──────────────────────────────────────────────────
|
|
116
261
|
/**
|
|
@@ -136,6 +281,21 @@ export class SecurityConfig {
|
|
|
136
281
|
* @see {@link SwmlBuilder} — the underlying SWML document builder
|
|
137
282
|
* @see {@link AgentBase} — AI-powered alternative
|
|
138
283
|
*/
|
|
284
|
+
/**
|
|
285
|
+
* Services constructed while swaig-test imports a file (SWAIG_CLI_MODE). Kept
|
|
286
|
+
* on globalThis under a registered symbol, so it's one list even when the
|
|
287
|
+
* agent file loads its own copy of the SDK (a CommonJS file, or another
|
|
288
|
+
* build of the package) from the one swaig-test runs.
|
|
289
|
+
*/
|
|
290
|
+
const cliLoadedServices = (globalThis[Symbol.for('signalwire.swaigTest.loadedServices')] ??= []);
|
|
291
|
+
/**
|
|
292
|
+
* The services constructed since the last call, while swaig-test was
|
|
293
|
+
* importing a file, in construction order; clears the list. Internal to the
|
|
294
|
+
* CLI's loader.
|
|
295
|
+
*/
|
|
296
|
+
export function _takeCliLoadedServices() {
|
|
297
|
+
return cliLoadedServices.splice(0);
|
|
298
|
+
}
|
|
139
299
|
export class SWMLService {
|
|
140
300
|
/** Service display name. */
|
|
141
301
|
name;
|
|
@@ -159,6 +319,10 @@ export class SWMLService {
|
|
|
159
319
|
sslKeyPath;
|
|
160
320
|
/** Schema validation utilities. Mirrors Python's `self.schema_utils`. */
|
|
161
321
|
schemaUtils;
|
|
322
|
+
/** @internal The schema settings every SwmlBuilder this service creates uses. */
|
|
323
|
+
_builderSchemaOptions = {
|
|
324
|
+
enableValidation: true,
|
|
325
|
+
};
|
|
162
326
|
/** Custom verb handler registry. Mirrors Python's `self.verb_registry`. */
|
|
163
327
|
verbRegistry;
|
|
164
328
|
swmlBuilder;
|
|
@@ -168,7 +332,7 @@ export class SWMLService {
|
|
|
168
332
|
authCredentials;
|
|
169
333
|
authSource = 'generated';
|
|
170
334
|
/** Validate provided basic-auth credentials against the configured ones
|
|
171
|
-
* using a constant-time comparison. (Python
|
|
335
|
+
* using a constant-time comparison. (Python equivalent:
|
|
172
336
|
* ``AuthMixin.validate_basic_auth(username, password)``.) */
|
|
173
337
|
validateBasicAuth(username, password) {
|
|
174
338
|
const [u, p] = this.authCredentials ?? ['', ''];
|
|
@@ -177,12 +341,9 @@ export class SWMLService {
|
|
|
177
341
|
return this.timingSafeEqual(username, u) && this.timingSafeEqual(password, p);
|
|
178
342
|
}
|
|
179
343
|
timingSafeEqual(a, b) {
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
for (let i = 0; i < a.length; i++)
|
|
184
|
-
diff |= a.charCodeAt(i) ^ b.charCodeAt(i);
|
|
185
|
-
return diff === 0;
|
|
344
|
+
// Compare digests, so neither the content nor the length leaks.
|
|
345
|
+
const digest = (v) => createHash('sha256').update(v, 'utf8').digest();
|
|
346
|
+
return timingSafeEqual(digest(a), digest(b));
|
|
186
347
|
}
|
|
187
348
|
_proxyUrlBase = process.env['SWML_PROXY_URL_BASE'] ?? null;
|
|
188
349
|
_proxyUrlBaseFromEnv = !!process.env['SWML_PROXY_URL_BASE'];
|
|
@@ -193,6 +354,9 @@ export class SWMLService {
|
|
|
193
354
|
// for DataMap-style functions. AgentBase reads/writes this same registry.
|
|
194
355
|
toolRegistry = new Map();
|
|
195
356
|
constructor(opts) {
|
|
357
|
+
// swaig-test finds services a file constructs without exporting them.
|
|
358
|
+
if (process.env['SWAIG_CLI_MODE'] === 'true')
|
|
359
|
+
cliLoadedServices.push(this);
|
|
196
360
|
this.name = opts?.name ?? 'swml-service';
|
|
197
361
|
this.route = opts?.route ?? '/';
|
|
198
362
|
this.host = opts?.host ?? '0.0.0.0';
|
|
@@ -215,9 +379,14 @@ export class SWMLService {
|
|
|
215
379
|
skipValidation,
|
|
216
380
|
...(opts?.schemaPath !== undefined ? { schemaPath: opts.schemaPath } : {}),
|
|
217
381
|
});
|
|
382
|
+
// The builder that renders the SWML validates verbs with the same settings.
|
|
383
|
+
this._builderSchemaOptions = {
|
|
384
|
+
enableValidation: !skipValidation,
|
|
385
|
+
...(opts?.schemaPath !== undefined ? { schemaPath: opts.schemaPath } : {}),
|
|
386
|
+
};
|
|
218
387
|
// Verb handler registry
|
|
219
388
|
this.verbRegistry = new VerbHandlerRegistry();
|
|
220
|
-
// Auth resolution: provided >
|
|
389
|
+
// Auth resolution: provided > config file > environment > generated
|
|
221
390
|
// Track whether auth was explicitly provided (enforced on HTTP) vs auto-generated (available but not enforced)
|
|
222
391
|
let enforceAuth = false;
|
|
223
392
|
if (opts?.basicAuth) {
|
|
@@ -226,30 +395,25 @@ export class SWMLService {
|
|
|
226
395
|
enforceAuth = true;
|
|
227
396
|
}
|
|
228
397
|
else {
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
this.
|
|
398
|
+
// The config file, then the environment: SecurityConfig applies that
|
|
399
|
+
// precedence and records which one supplied the password.
|
|
400
|
+
const configured = this.security.getBasicAuth();
|
|
401
|
+
if (configured) {
|
|
402
|
+
this.authCredentials = configured;
|
|
403
|
+
this.authSource = this.security.basicAuthSource ?? 'environment';
|
|
234
404
|
enforceAuth = true;
|
|
235
405
|
}
|
|
236
406
|
else {
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
}
|
|
243
|
-
else {
|
|
244
|
-
// Auto-generate credentials like AgentBase does
|
|
245
|
-
const username = this.name.replace(/[^a-zA-Z0-9_-]/g, '_');
|
|
246
|
-
this.authCredentials = [username, randomBytes(16).toString('hex')];
|
|
247
|
-
this.authSource = 'generated';
|
|
248
|
-
// Not enforced on HTTP — available via getBasicAuthCredentials()
|
|
249
|
-
}
|
|
407
|
+
// Auto-generate credentials like AgentBase does
|
|
408
|
+
const username = this.name.replace(/[^a-zA-Z0-9_-]/g, '_');
|
|
409
|
+
this.authCredentials = [username, randomBytes(16).toString('hex')];
|
|
410
|
+
this.authSource = 'generated';
|
|
411
|
+
// Not enforced on HTTP — available via getBasicAuthCredentials()
|
|
250
412
|
}
|
|
251
413
|
}
|
|
252
|
-
this
|
|
414
|
+
// `service: this` is the builder's public back-reference (the reference's
|
|
415
|
+
// `SWMLBuilder(service)`), so a caller holding the builder can reach its service.
|
|
416
|
+
this.swmlBuilder = new SwmlBuilder({ service: this, ...this._builderSchemaOptions });
|
|
253
417
|
this._app = new Hono();
|
|
254
418
|
// Security headers
|
|
255
419
|
this._app.use('*', async (c, next) => {
|
|
@@ -263,53 +427,22 @@ export class SWMLService {
|
|
|
263
427
|
});
|
|
264
428
|
// CORS — credentials only when origin is explicitly configured (wildcard + credentials violates spec)
|
|
265
429
|
const corsOrigins = process.env['SWML_CORS_ORIGINS'];
|
|
266
|
-
const corsOrigin = corsOrigins
|
|
430
|
+
const corsOrigin = corsOriginsFromEnv(corsOrigins);
|
|
267
431
|
const corsCredentials = corsOrigin !== '*';
|
|
268
432
|
this._app.use('*', cors({ origin: corsOrigin, credentials: corsCredentials }));
|
|
269
433
|
// Basic auth — only enforced when explicitly provided or from env, not auto-generated
|
|
270
434
|
if (enforceAuth && this.authCredentials) {
|
|
271
|
-
|
|
272
|
-
|
|
435
|
+
this._app.use('*', basicAuth({
|
|
436
|
+
verifyUser: (username, password) => this.validateBasicAuth(username, password),
|
|
437
|
+
}));
|
|
273
438
|
}
|
|
274
439
|
// Health endpoints
|
|
275
440
|
this._app.get('/health', (c) => c.json({ status: 'ok' }));
|
|
276
441
|
this._app.get('/ready', (c) => c.json({ status: 'ready' }));
|
|
277
442
|
// Main SWML endpoint — serves on both GET and POST
|
|
278
443
|
const handler = async (c) => {
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
// can both receive them (mirrors Python's _handle_request param extraction).
|
|
282
|
-
const url = new URL(c.req.url);
|
|
283
|
-
const queryParams = {};
|
|
284
|
-
url.searchParams.forEach((v, k) => { queryParams[k] = v; });
|
|
285
|
-
let bodyParams = {};
|
|
286
|
-
if (c.req.method === 'POST') {
|
|
287
|
-
try {
|
|
288
|
-
bodyParams = await c.req.json();
|
|
289
|
-
}
|
|
290
|
-
catch {
|
|
291
|
-
// empty body is fine
|
|
292
|
-
}
|
|
293
|
-
}
|
|
294
|
-
const headers = {};
|
|
295
|
-
c.req.raw.headers.forEach((v, k) => { headers[k] = v; });
|
|
296
|
-
// Protected override hook (Service-side SWML builder dispatch).
|
|
297
|
-
// Try buildSwmlForRequest() first; if it returns a SwmlBuilder use
|
|
298
|
-
// that document. This is distinct from WebMixin's onRequest hook
|
|
299
|
-
// (a public 2-arg variant on AgentBase that mirrors Python's
|
|
300
|
-
// on_request → on_swml_request delegation chain).
|
|
301
|
-
const hookResult = this.buildSwmlForRequest(queryParams, bodyParams, headers);
|
|
302
|
-
if (hookResult !== null) {
|
|
303
|
-
doc = hookResult.getDocument();
|
|
304
|
-
}
|
|
305
|
-
else if (this.onRequestCallback) {
|
|
306
|
-
const builder = await this.onRequestCallback(queryParams, bodyParams, headers);
|
|
307
|
-
doc = builder.getDocument();
|
|
308
|
-
}
|
|
309
|
-
else {
|
|
310
|
-
doc = this.swmlBuilder.getDocument();
|
|
311
|
-
}
|
|
312
|
-
return c.json(doc);
|
|
444
|
+
const { bodyParams, headers } = await this._readRequest(c);
|
|
445
|
+
return c.json(await this._documentForRequest(c, bodyParams, headers));
|
|
313
446
|
};
|
|
314
447
|
const routePath = this.route === '/' ? '/' : this.route;
|
|
315
448
|
const swaigPath = this.route === '/' ? '/swaig' : `${this.route}/swaig`;
|
|
@@ -321,7 +454,7 @@ export class SWMLService {
|
|
|
321
454
|
if (c.req.method === 'GET') {
|
|
322
455
|
return handler(c);
|
|
323
456
|
}
|
|
324
|
-
let payload
|
|
457
|
+
let payload;
|
|
325
458
|
try {
|
|
326
459
|
payload = (await c.req.json());
|
|
327
460
|
}
|
|
@@ -338,7 +471,10 @@ export class SWMLService {
|
|
|
338
471
|
// Argument extraction: nested {argument:{parsed}} OR flat {arguments}
|
|
339
472
|
let args = {};
|
|
340
473
|
const argument = payload['argument'];
|
|
341
|
-
if (argument &&
|
|
474
|
+
if (argument &&
|
|
475
|
+
typeof argument === 'object' &&
|
|
476
|
+
Array.isArray(argument['parsed']) &&
|
|
477
|
+
argument['parsed'].length > 0) {
|
|
342
478
|
const first = argument['parsed'][0];
|
|
343
479
|
if (first && typeof first === 'object')
|
|
344
480
|
args = first;
|
|
@@ -352,10 +488,15 @@ export class SWMLService {
|
|
|
352
488
|
if (shortCircuit !== null && shortCircuit !== undefined) {
|
|
353
489
|
return c.json(shortCircuit);
|
|
354
490
|
}
|
|
355
|
-
|
|
491
|
+
// A handler may be async: await it, or its Promise serializes as {}.
|
|
492
|
+
const result = await target.onFunctionCall(fnName, args, payload);
|
|
356
493
|
if (result === null || result === undefined) {
|
|
357
494
|
return c.json({ error: `Unknown function: ${fnName}` }, 404);
|
|
358
495
|
}
|
|
496
|
+
if (result instanceof FunctionResult)
|
|
497
|
+
return c.json(result.toDict());
|
|
498
|
+
if (typeof result === 'string')
|
|
499
|
+
return c.json(new FunctionResult(result).toDict());
|
|
359
500
|
return c.json(result);
|
|
360
501
|
};
|
|
361
502
|
this._app.get(swaigPath, swaigHandler);
|
|
@@ -374,24 +515,57 @@ export class SWMLService {
|
|
|
374
515
|
* parameter descriptions are LLM-facing prompt engineering — see
|
|
375
516
|
* PORTING_GUIDE for guidance on writing them.
|
|
376
517
|
*
|
|
377
|
-
*
|
|
378
|
-
*
|
|
379
|
-
*
|
|
518
|
+
* Generic over the `parameters` schema (`P`) and `required` list (`R`): when
|
|
519
|
+
* `parameters` is written as a FLAT inline map (`{ name: { type, … } }`), the
|
|
520
|
+
* `const` type parameters capture its literals and the handler's `args` is
|
|
521
|
+
* inferred precisely — `args.phone` typed `string`, an `enum` prop narrowed to
|
|
522
|
+
* its literal union, `required` keys present and the rest optional (see
|
|
523
|
+
* {@link ToolArgs}/{@link InferArgs}). The WRAPPED JSON-Schema object
|
|
524
|
+
* (`{ type:'object', properties }`) and a pre-built `Record` are still
|
|
525
|
+
* accepted and keep the prior open-record `args` behavior. The args type is a
|
|
526
|
+
* compile-time authoring convenience — at runtime args is the JSON the model
|
|
527
|
+
* extracted, so the handler is the ordinary {@link SwaigHandler}.
|
|
380
528
|
*/
|
|
381
529
|
defineTool(opts) {
|
|
382
|
-
const fn = new SwaigFunction(
|
|
530
|
+
const fn = new SwaigFunction({
|
|
531
|
+
...opts,
|
|
532
|
+
parameters: opts.parameters,
|
|
533
|
+
required: opts.required,
|
|
534
|
+
// Single type-erasure boundary: at runtime the handler is the ordinary
|
|
535
|
+
// (args: Record<string,unknown>, rawData) SwaigHandler; the inferred-args
|
|
536
|
+
// view is compile-time only.
|
|
537
|
+
handler: opts.handler,
|
|
538
|
+
});
|
|
383
539
|
this.toolRegistry.set(opts.name, fn);
|
|
384
540
|
return this;
|
|
385
541
|
}
|
|
386
|
-
/**
|
|
542
|
+
/**
|
|
543
|
+
* Register a SwaigFunction instance or a raw function descriptor (DataMap).
|
|
544
|
+
*
|
|
545
|
+
* A raw descriptor with `gates` or `gate_fillers` is checked by the
|
|
546
|
+
* platform's rules, and a normalized copy is stored; the caller's object is
|
|
547
|
+
* left as it was.
|
|
548
|
+
* @param fn - The function, or its raw SWAIG definition.
|
|
549
|
+
* @returns This service, for chaining.
|
|
550
|
+
* @throws {Error} For gates the platform would refuse, or gate fillers
|
|
551
|
+
* without gates.
|
|
552
|
+
*/
|
|
387
553
|
registerSwaigFunction(fn) {
|
|
388
554
|
if (fn instanceof SwaigFunction) {
|
|
389
555
|
this.toolRegistry.set(fn.name, fn);
|
|
390
556
|
}
|
|
391
557
|
else {
|
|
392
558
|
const name = fn['function'];
|
|
559
|
+
let entry = fn;
|
|
560
|
+
if (_hasGateFields(fn)) {
|
|
561
|
+
// A shallow copy: applyGateFields replaces gates with fresh objects.
|
|
562
|
+
entry = { ...fn };
|
|
563
|
+
applyGateFields(entry, typeof name === 'string' && name ? name : '(unnamed)', {
|
|
564
|
+
definition: true,
|
|
565
|
+
});
|
|
566
|
+
}
|
|
393
567
|
if (name)
|
|
394
|
-
this.toolRegistry.set(name,
|
|
568
|
+
this.toolRegistry.set(name, entry);
|
|
395
569
|
}
|
|
396
570
|
return this;
|
|
397
571
|
}
|
|
@@ -417,17 +591,17 @@ export class SWMLService {
|
|
|
417
591
|
return this.toolRegistry.has(name);
|
|
418
592
|
}
|
|
419
593
|
/** Whether a SWAIG function with the given name is registered.
|
|
420
|
-
* (Python
|
|
594
|
+
* (Python equivalent: ``ToolRegistry.has_function``.) */
|
|
421
595
|
hasFunction(name) {
|
|
422
596
|
return this.toolRegistry.has(name);
|
|
423
597
|
}
|
|
424
598
|
/** Get a registered SWAIG function entry, or undefined.
|
|
425
|
-
* (Python
|
|
599
|
+
* (Python equivalent: ``ToolRegistry.get_function``.) */
|
|
426
600
|
getFunction(name) {
|
|
427
601
|
return this.toolRegistry.get(name);
|
|
428
602
|
}
|
|
429
603
|
/** Snapshot of all registered SWAIG functions keyed by name.
|
|
430
|
-
* (Python
|
|
604
|
+
* (Python equivalent: ``ToolRegistry.get_all_functions``.) */
|
|
431
605
|
getAllFunctions() {
|
|
432
606
|
const out = {};
|
|
433
607
|
for (const [name, fn] of this.toolRegistry) {
|
|
@@ -436,7 +610,7 @@ export class SWMLService {
|
|
|
436
610
|
return out;
|
|
437
611
|
}
|
|
438
612
|
/** Remove a registered SWAIG function. Returns true when removed,
|
|
439
|
-
* false when not found. (Python
|
|
613
|
+
* false when not found. (Python equivalent:
|
|
440
614
|
* ``ToolRegistry.remove_function``.) */
|
|
441
615
|
removeFunction(name) {
|
|
442
616
|
return this.toolRegistry.delete(name);
|
|
@@ -460,10 +634,12 @@ export class SWMLService {
|
|
|
460
634
|
tools.push({ name, description: fn.description, parameters: fn.parameters });
|
|
461
635
|
}
|
|
462
636
|
else {
|
|
637
|
+
// DataMap.toSwaigFunction() writes description/parameters; a hand-built
|
|
638
|
+
// SWAIG dict may use the older purpose/argument names.
|
|
463
639
|
tools.push({
|
|
464
640
|
name,
|
|
465
|
-
description: fn['purpose'] ?? '',
|
|
466
|
-
parameters: fn['argument'] ?? {},
|
|
641
|
+
description: (fn['description'] ?? fn['purpose']) ?? '',
|
|
642
|
+
parameters: (fn['parameters'] ?? fn['argument']) ?? {},
|
|
467
643
|
});
|
|
468
644
|
}
|
|
469
645
|
}
|
|
@@ -540,7 +716,7 @@ export class SWMLService {
|
|
|
540
716
|
* @returns This service for chaining.
|
|
541
717
|
*/
|
|
542
718
|
addSection(sectionName) {
|
|
543
|
-
const doc = this.swmlBuilder.
|
|
719
|
+
const doc = this.swmlBuilder.build();
|
|
544
720
|
if (!(sectionName in doc.sections)) {
|
|
545
721
|
doc.sections[sectionName] = [];
|
|
546
722
|
}
|
|
@@ -578,15 +754,14 @@ export class SWMLService {
|
|
|
578
754
|
* @returns The SWML document (object) or its serialized form (subclass).
|
|
579
755
|
*/
|
|
580
756
|
renderSwml(_callId, _modifications) {
|
|
581
|
-
return this.swmlBuilder.
|
|
757
|
+
return this.swmlBuilder.build();
|
|
582
758
|
}
|
|
583
759
|
/**
|
|
584
|
-
* Get the SWML document as a dictionary.
|
|
585
|
-
* Alias for `renderSwml()` that matches Python's `get_document()` name.
|
|
760
|
+
* Get the SWML document as a dictionary. Matches Python's `get_document()`.
|
|
586
761
|
* @returns The SWML document.
|
|
587
762
|
*/
|
|
588
763
|
getDocument() {
|
|
589
|
-
return this.swmlBuilder.
|
|
764
|
+
return this.swmlBuilder.build();
|
|
590
765
|
}
|
|
591
766
|
/**
|
|
592
767
|
* Render the SWML document as a JSON string.
|
|
@@ -594,7 +769,121 @@ export class SWMLService {
|
|
|
594
769
|
* @returns JSON-encoded SWML document.
|
|
595
770
|
*/
|
|
596
771
|
renderDocument() {
|
|
597
|
-
return this.swmlBuilder.
|
|
772
|
+
return this.swmlBuilder.render();
|
|
773
|
+
}
|
|
774
|
+
/**
|
|
775
|
+
* Framework-free request-dispatch core.
|
|
776
|
+
*
|
|
777
|
+
* The primitive dispatch surface the SDK ports share (mirrors Python's
|
|
778
|
+
* `SWMLService.handle_request(method, url, headers, body)` and, e.g., the
|
|
779
|
+
* dotnet `(int, Dictionary, string) HandleRequest(...)`). It performs the
|
|
780
|
+
* routing-callback check, `on_request` modification, and basic-auth exactly as
|
|
781
|
+
* the Hono handler path does, but over plain primitives instead of Hono
|
|
782
|
+
* `Context`/`Response` objects — so both paths produce identical responses.
|
|
783
|
+
*
|
|
784
|
+
* @param method HTTP method, e.g. `"GET"` or `"POST"`.
|
|
785
|
+
* @param url The full request URL (used to derive the callback path).
|
|
786
|
+
* @param headers Request headers as a plain dict.
|
|
787
|
+
* @param body The already-parsed JSON body for POST requests, or `undefined`.
|
|
788
|
+
* @returns A `[status, responseHeaders, bodyString]` triple. For a routing
|
|
789
|
+
* redirect the status is 307 with a `Location` header and an empty body; an
|
|
790
|
+
* auth failure is 401 with `WWW-Authenticate: Basic`; otherwise 200 with the
|
|
791
|
+
* SWML document as the body string.
|
|
792
|
+
*/
|
|
793
|
+
async handleRequest(method, url, headers, body) {
|
|
794
|
+
const parsedBody = body ?? {};
|
|
795
|
+
const callbackPath = this._callbackPathForUrl(url);
|
|
796
|
+
// Auth check over primitives.
|
|
797
|
+
if (!(await this._checkBasicAuthHeaders(headers))) {
|
|
798
|
+
return [401, { 'WWW-Authenticate': 'Basic' }, JSON.stringify({ error: 'Unauthorized' })];
|
|
799
|
+
}
|
|
800
|
+
// Routing callback: (body, headers) -> route | null. Only runs for a POST
|
|
801
|
+
// with a non-empty parsed body targeting a registered callback path.
|
|
802
|
+
if (method === 'POST' &&
|
|
803
|
+
Object.keys(parsedBody).length > 0 &&
|
|
804
|
+
callbackPath &&
|
|
805
|
+
this._routingCallbacks.has(callbackPath)) {
|
|
806
|
+
const callbackFn = this._routingCallbacks.get(callbackPath);
|
|
807
|
+
try {
|
|
808
|
+
const route = await callbackFn(parsedBody, headers);
|
|
809
|
+
if (route != null) {
|
|
810
|
+
this.log.info(`routing_request route=${route}`);
|
|
811
|
+
return [307, { Location: route }, ''];
|
|
812
|
+
}
|
|
813
|
+
}
|
|
814
|
+
catch (err) {
|
|
815
|
+
this.log.error(`error_in_routing_callback error=${err instanceof Error ? err.message : String(err)}`);
|
|
816
|
+
}
|
|
817
|
+
}
|
|
818
|
+
// Allow customized handling in subclasses (the SWML-builder hook analog of
|
|
819
|
+
// Python's on_request modification merge).
|
|
820
|
+
const queryParams = {};
|
|
821
|
+
try {
|
|
822
|
+
new URL(url).searchParams.forEach((v, k) => {
|
|
823
|
+
queryParams[k] = v;
|
|
824
|
+
});
|
|
825
|
+
}
|
|
826
|
+
catch {
|
|
827
|
+
/* url may be a bare path — no query params to extract */
|
|
828
|
+
}
|
|
829
|
+
const hookResult = this.buildSwmlForRequest(queryParams, parsedBody, headers, callbackPath ?? undefined);
|
|
830
|
+
if (hookResult !== null) {
|
|
831
|
+
return [200, {}, JSON.stringify(hookResult.build())];
|
|
832
|
+
}
|
|
833
|
+
return [200, {}, this.renderDocument()];
|
|
834
|
+
}
|
|
835
|
+
/**
|
|
836
|
+
* Derive the registered routing-callback path (if any) a URL targets. Mirrors
|
|
837
|
+
* Python's `_callback_path_for_url` — the primitive `handleRequest` recovers
|
|
838
|
+
* the equivalent of the router's `request.state.callback_path` by matching the
|
|
839
|
+
* URL's normalized path against the registered callbacks.
|
|
840
|
+
*/
|
|
841
|
+
_callbackPathForUrl(url) {
|
|
842
|
+
if (this._routingCallbacks.size === 0)
|
|
843
|
+
return null;
|
|
844
|
+
let path = url;
|
|
845
|
+
try {
|
|
846
|
+
path = new URL(url).pathname;
|
|
847
|
+
}
|
|
848
|
+
catch {
|
|
849
|
+
/* bare path — use as-is */
|
|
850
|
+
}
|
|
851
|
+
// Collapse repeated slashes, as the router does when it picks the route,
|
|
852
|
+
// so /agent/handoff//next finds the callback registered at /handoff/next.
|
|
853
|
+
const trimmed = path.replace(/\/{2,}/g, '/').replace(/^\/+|\/+$/g, '');
|
|
854
|
+
const normalized = trimmed ? `/${trimmed}` : path.replace(/\/+$/, '');
|
|
855
|
+
for (const cbPath of this._routingCallbacks.keys()) {
|
|
856
|
+
if (normalized === cbPath || normalized.endsWith(cbPath))
|
|
857
|
+
return cbPath;
|
|
858
|
+
}
|
|
859
|
+
return null;
|
|
860
|
+
}
|
|
861
|
+
/**
|
|
862
|
+
* Validate HTTP basic-auth from a plain headers dict (the primitive analog of
|
|
863
|
+
* the Hono `basicAuth` middleware). Returns true when auth is not enforced or
|
|
864
|
+
* the provided credentials match.
|
|
865
|
+
*/
|
|
866
|
+
async _checkBasicAuthHeaders(headers) {
|
|
867
|
+
// Auth is only enforced when credentials were explicitly provided or came
|
|
868
|
+
// from the environment; auto-generated credentials are not enforced.
|
|
869
|
+
if (!this.authCredentials || this.authSource === 'generated')
|
|
870
|
+
return true;
|
|
871
|
+
const authHeader = headers['authorization'] ?? headers['Authorization'];
|
|
872
|
+
if (!authHeader || !authHeader.startsWith('Basic '))
|
|
873
|
+
return false;
|
|
874
|
+
let decoded;
|
|
875
|
+
try {
|
|
876
|
+
decoded = Buffer.from(authHeader.slice(6), 'base64').toString('utf-8');
|
|
877
|
+
}
|
|
878
|
+
catch {
|
|
879
|
+
return false;
|
|
880
|
+
}
|
|
881
|
+
const idx = decoded.indexOf(':');
|
|
882
|
+
if (idx < 0)
|
|
883
|
+
return false;
|
|
884
|
+
const user = decoded.slice(0, idx);
|
|
885
|
+
const pass = decoded.slice(idx + 1);
|
|
886
|
+
return await this.validateBasicAuth(user, pass);
|
|
598
887
|
}
|
|
599
888
|
// ── Verb handler registration ────────────────────────────────────────
|
|
600
889
|
/**
|
|
@@ -624,28 +913,65 @@ export class SWMLService {
|
|
|
624
913
|
}
|
|
625
914
|
this.log.info(`Registering routing callback at ${normalized}`);
|
|
626
915
|
this._routingCallbacks.set(normalized, callbackFn);
|
|
627
|
-
// Install an endpoint on the Hono app for this callback path
|
|
916
|
+
// Install an endpoint on the Hono app for this callback path. It runs
|
|
917
|
+
// this callback (awaited) for a POST, redirects with 307 when it returns
|
|
918
|
+
// a route, and otherwise serves the SWML for the request as the main
|
|
919
|
+
// route does, as the reference does. Auth is the app's middleware.
|
|
628
920
|
const routeHandler = async (c) => {
|
|
629
|
-
|
|
630
|
-
if (c.req.method === 'POST') {
|
|
921
|
+
const { bodyParams, headers } = await this._readRequest(c);
|
|
922
|
+
if (c.req.method === 'POST' && Object.keys(bodyParams).length > 0) {
|
|
631
923
|
try {
|
|
632
|
-
|
|
924
|
+
const route = await callbackFn(bodyParams, headers);
|
|
925
|
+
if (route != null) {
|
|
926
|
+
this.log.info(`routing_request route=${route}`);
|
|
927
|
+
return c.redirect(route, 307);
|
|
928
|
+
}
|
|
633
929
|
}
|
|
634
|
-
catch {
|
|
635
|
-
|
|
930
|
+
catch (err) {
|
|
931
|
+
this.log.error(`error_in_routing_callback error=${err instanceof Error ? err.message : String(err)}`);
|
|
636
932
|
}
|
|
637
933
|
}
|
|
638
|
-
|
|
639
|
-
if (route !== null) {
|
|
640
|
-
return c.redirect(route, 307);
|
|
641
|
-
}
|
|
642
|
-
// No redirect — serve normal SWML
|
|
643
|
-
const doc = this.swmlBuilder.getDocument();
|
|
644
|
-
return c.json(doc);
|
|
934
|
+
return c.json(await this._documentForRequest(c, bodyParams, headers));
|
|
645
935
|
};
|
|
646
936
|
this._app.get(normalized, routeHandler);
|
|
647
937
|
this._app.post(normalized, routeHandler);
|
|
648
938
|
}
|
|
939
|
+
/** The body (for a POST) and headers of a served request. */
|
|
940
|
+
async _readRequest(c) {
|
|
941
|
+
let bodyParams = {};
|
|
942
|
+
if (c.req.method === 'POST') {
|
|
943
|
+
try {
|
|
944
|
+
bodyParams = await c.req.json();
|
|
945
|
+
}
|
|
946
|
+
catch {
|
|
947
|
+
// empty body is fine
|
|
948
|
+
}
|
|
949
|
+
}
|
|
950
|
+
const headers = {};
|
|
951
|
+
c.req.raw.headers.forEach((v, k) => {
|
|
952
|
+
headers[k] = v;
|
|
953
|
+
});
|
|
954
|
+
return { bodyParams, headers };
|
|
955
|
+
}
|
|
956
|
+
/**
|
|
957
|
+
* The SWML document for a served request: buildSwmlForRequest(), then the
|
|
958
|
+
* setOnRequestCallback() callback, then the service's own document (as
|
|
959
|
+
* Python's _handle_request does).
|
|
960
|
+
*/
|
|
961
|
+
async _documentForRequest(c, bodyParams, headers) {
|
|
962
|
+
const queryParams = {};
|
|
963
|
+
new URL(c.req.url).searchParams.forEach((v, k) => {
|
|
964
|
+
queryParams[k] = v;
|
|
965
|
+
});
|
|
966
|
+
const hookResult = this.buildSwmlForRequest(queryParams, bodyParams, headers);
|
|
967
|
+
if (hookResult !== null)
|
|
968
|
+
return hookResult.build();
|
|
969
|
+
if (this.onRequestCallback) {
|
|
970
|
+
const builder = await this.onRequestCallback(queryParams, bodyParams, headers);
|
|
971
|
+
return builder.build();
|
|
972
|
+
}
|
|
973
|
+
return this.swmlBuilder.build();
|
|
974
|
+
}
|
|
649
975
|
// ── Static utilities ─────────────────────────────────────────────────
|
|
650
976
|
/**
|
|
651
977
|
* Extract the SIP username from a request body's call.to field.
|
|
@@ -661,7 +987,7 @@ export class SWMLService {
|
|
|
661
987
|
return null;
|
|
662
988
|
// Handle SIP URIs like "sip:username@domain" or "sips:username@domain"
|
|
663
989
|
if (toField.startsWith('sip:') || toField.startsWith('sips:')) {
|
|
664
|
-
|
|
990
|
+
const uri = toField.replace(/^sips?:/, '');
|
|
665
991
|
const atIdx = uri.indexOf('@');
|
|
666
992
|
if (atIdx > 0)
|
|
667
993
|
return uri.substring(0, atIdx);
|
|
@@ -748,23 +1074,28 @@ export class SWMLService {
|
|
|
748
1074
|
return this._app;
|
|
749
1075
|
}
|
|
750
1076
|
/**
|
|
751
|
-
*
|
|
752
|
-
*
|
|
753
|
-
* the
|
|
754
|
-
*
|
|
1077
|
+
* Get a router to embed this service's routes in a host web app.
|
|
1078
|
+
*
|
|
1079
|
+
* Returns the fully-wired Hono app as a mountable sub-app; the host mounts it
|
|
1080
|
+
* with `hostApp.route(path, service.asRouter())`. This is the TypeScript
|
|
1081
|
+
* realization of Python's `as_router()`; the named {@link HostAppRouter} type
|
|
1082
|
+
* is the cross-port "embed my routes in a host app" contract.
|
|
1083
|
+
*
|
|
1084
|
+
* @returns A mountable Hono sub-app carrying this service's routes.
|
|
755
1085
|
*/
|
|
756
1086
|
asRouter() {
|
|
757
1087
|
return this.getApp();
|
|
758
1088
|
}
|
|
759
1089
|
/**
|
|
760
|
-
* Start the HTTP server.
|
|
1090
|
+
* Start the HTTP server. Canonical entrypoint, matching Python's
|
|
1091
|
+
* `SWMLService.serve()`.
|
|
761
1092
|
*
|
|
762
1093
|
* Matches Python's `serve()` parameters including SSL options. When
|
|
763
1094
|
* `SWAIG_CLI_MODE=true` is set in the environment (e.g. while running the
|
|
764
1095
|
* `swaig-test` CLI) the call is a no-op.
|
|
765
1096
|
*
|
|
766
|
-
* @param
|
|
767
|
-
* `'0.0.0.0'`.
|
|
1097
|
+
* @param hostOrOpts - Hostname, or an options object. Defaults to `this.host`
|
|
1098
|
+
* (constructor value) or `'0.0.0.0'`.
|
|
768
1099
|
* @param port - Port. Defaults to `this.port` (constructor value) or `3000`.
|
|
769
1100
|
* @param opts - Optional SSL/TLS configuration overrides.
|
|
770
1101
|
* @param opts.sslCert - Path to the PEM certificate file.
|
|
@@ -773,7 +1104,7 @@ export class SWMLService {
|
|
|
773
1104
|
* @param opts.domain - Domain used for HSTS header configuration.
|
|
774
1105
|
* @returns Resolves once the server has begun listening.
|
|
775
1106
|
*/
|
|
776
|
-
async
|
|
1107
|
+
async serve(hostOrOpts, port, opts) {
|
|
777
1108
|
if (process.env['SWAIG_CLI_MODE'] === 'true')
|
|
778
1109
|
return;
|
|
779
1110
|
// Normalize: accept either positional (host, port, opts) or single
|
|
@@ -792,6 +1123,13 @@ export class SWMLService {
|
|
|
792
1123
|
opts = resolvedOpts;
|
|
793
1124
|
const h = host ?? this.host;
|
|
794
1125
|
const p = port ?? this.port;
|
|
1126
|
+
// A service with generated credentials doesn't require them (a TypeScript
|
|
1127
|
+
// divergence from the reference, which always does: PORT_BEHAVIORAL_NOTES.md).
|
|
1128
|
+
if (this.authSource === 'generated') {
|
|
1129
|
+
this.log.warn(`${this.name} is serving without basic auth: its credentials were generated, and ` +
|
|
1130
|
+
'generated credentials are not enforced. Pass basicAuth, or set ' +
|
|
1131
|
+
'SWML_BASIC_AUTH_USER and SWML_BASIC_AUTH_PASSWORD, to require them.');
|
|
1132
|
+
}
|
|
795
1133
|
// Determine effective SSL state (param > instance > env)
|
|
796
1134
|
const effectiveSslEnabled = opts?.sslEnabled ?? this.sslEnabled;
|
|
797
1135
|
const effectiveSslCert = opts?.sslCert ?? this.sslCertPath;
|
|
@@ -817,17 +1155,6 @@ export class SWMLService {
|
|
|
817
1155
|
this._server = serve({ fetch: this._app.fetch, port: p, hostname: h });
|
|
818
1156
|
}
|
|
819
1157
|
}
|
|
820
|
-
/**
|
|
821
|
-
* Start the HTTP server. Alias for {@link run} provided for cross-SDK
|
|
822
|
-
* consistency with Python's `serve()` method — callers porting from
|
|
823
|
-
* Python can use this name without changes.
|
|
824
|
-
*
|
|
825
|
-
* @param args - Forwarded unchanged to {@link run}.
|
|
826
|
-
* @returns Resolves once the server has begun listening.
|
|
827
|
-
*/
|
|
828
|
-
async serve(...args) {
|
|
829
|
-
return this.run(...args);
|
|
830
|
-
}
|
|
831
1158
|
/**
|
|
832
1159
|
* Stop the HTTP server.
|
|
833
1160
|
* Mirrors Python's `stop()`.
|