@signalwire/sdk 2.0.5 → 3.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +785 -0
- package/LICENSE +21 -0
- package/README.md +163 -68
- package/dist/AGENTS.md +13 -0
- package/dist/AgentBase.d.ts +481 -126
- package/dist/AgentBase.js +1502 -438
- package/dist/AgentBase.js.map +1 -1
- package/dist/AgentServer.d.ts +21 -0
- package/dist/AgentServer.js +154 -47
- package/dist/AgentServer.js.map +1 -1
- package/dist/AuthHandler.d.ts +14 -2
- package/dist/AuthHandler.js +7 -2
- package/dist/AuthHandler.js.map +1 -1
- package/dist/ConfigLoader.d.ts +5 -13
- package/dist/ConfigLoader.js +15 -29
- package/dist/ConfigLoader.js.map +1 -1
- package/dist/ContextBuilder.d.ts +202 -9
- package/dist/ContextBuilder.js +219 -36
- package/dist/ContextBuilder.js.map +1 -1
- package/dist/DataMap.d.ts +158 -45
- package/dist/DataMap.js +167 -52
- package/dist/DataMap.js.map +1 -1
- package/dist/FunctionResult.d.ts +277 -83
- package/dist/FunctionResult.js +444 -116
- package/dist/FunctionResult.js.map +1 -1
- package/dist/Logger.d.ts +30 -5
- package/dist/Logger.js +77 -19
- package/dist/Logger.js.map +1 -1
- package/dist/POM/PromptObjectModel.d.ts +12 -1
- package/dist/POM/PromptObjectModel.js +25 -9
- package/dist/POM/PromptObjectModel.js.map +1 -1
- package/dist/ParameterSchema.d.ts +306 -0
- package/dist/ParameterSchema.js +251 -0
- package/dist/ParameterSchema.js.map +1 -0
- package/dist/PlatformContracts.d.ts +21 -0
- package/dist/PlatformContracts.generated.d.ts +109 -0
- package/dist/PlatformContracts.generated.js +8 -0
- package/dist/PlatformContracts.generated.js.map +1 -0
- package/dist/PlatformContracts.js +2 -0
- package/dist/PlatformContracts.js.map +1 -0
- package/dist/PomBuilder.d.ts +18 -0
- package/dist/PomBuilder.js +53 -3
- package/dist/PomBuilder.js.map +1 -1
- package/dist/PostPrompt.d.ts +110 -0
- package/dist/PostPrompt.js +204 -0
- package/dist/PostPrompt.js.map +1 -0
- package/dist/PromptManager.d.ts +22 -1
- package/dist/PromptManager.js +28 -1
- package/dist/PromptManager.js.map +1 -1
- package/dist/PublicFetch.d.ts +132 -0
- package/dist/PublicFetch.js +311 -0
- package/dist/PublicFetch.js.map +1 -0
- package/dist/RobotsTxt.d.ts +41 -0
- package/dist/RobotsTxt.js +152 -0
- package/dist/RobotsTxt.js.map +1 -0
- package/dist/SWMLHandler.js.map +1 -1
- package/dist/SWMLService.d.ts +158 -58
- package/dist/SWMLService.js +435 -127
- package/dist/SWMLService.js.map +1 -1
- package/dist/SchemaUtils.d.ts +115 -2
- package/dist/SchemaUtils.js +444 -12
- package/dist/SchemaUtils.js.map +1 -1
- package/dist/SecurityUtils.d.ts +49 -9
- package/dist/SecurityUtils.js +153 -51
- package/dist/SecurityUtils.js.map +1 -1
- package/dist/ServerlessAdapter.d.ts +156 -7
- package/dist/ServerlessAdapter.js +399 -42
- package/dist/ServerlessAdapter.js.map +1 -1
- package/dist/SessionManager.d.ts +11 -2
- package/dist/SessionManager.js +50 -18
- package/dist/SessionManager.js.map +1 -1
- package/dist/SslConfig.d.ts +2 -1
- package/dist/SslConfig.js +4 -1
- package/dist/SslConfig.js.map +1 -1
- package/dist/SwaigActions.generated.d.ts +23 -0
- package/dist/SwaigActions.generated.js +8 -0
- package/dist/SwaigActions.generated.js.map +1 -0
- package/dist/SwaigContracts.d.ts +15 -0
- package/dist/SwaigContracts.generated.d.ts +264 -0
- package/dist/SwaigContracts.generated.js +12 -0
- package/dist/SwaigContracts.generated.js.map +1 -0
- package/dist/SwaigContracts.js +2 -0
- package/dist/SwaigContracts.js.map +1 -0
- package/dist/SwaigFunction.d.ts +110 -4
- package/dist/SwaigFunction.js +151 -19
- package/dist/SwaigFunction.js.map +1 -1
- package/dist/SwmlBuilder.d.ts +68 -19
- package/dist/SwmlBuilder.js +74 -38
- package/dist/SwmlBuilder.js.map +1 -1
- package/dist/SwmlVerbMethods.generated.d.ts +41 -4
- package/dist/SwmlVerbMethods.generated.js +1 -1
- package/dist/TypeInference.d.ts +39 -3
- package/dist/TypeInference.js +256 -16
- package/dist/TypeInference.js.map +1 -1
- package/dist/WebService.d.ts +79 -11
- package/dist/WebService.js +320 -109
- package/dist/WebService.js.map +1 -1
- package/dist/WebhookMiddleware.d.ts +119 -0
- package/dist/WebhookMiddleware.js +271 -0
- package/dist/WebhookMiddleware.js.map +1 -0
- package/dist/WebhookValidator.d.ts +92 -0
- package/dist/WebhookValidator.js +409 -0
- package/dist/WebhookValidator.js.map +1 -0
- package/dist/agents/BedrockAgent.d.ts +162 -0
- package/dist/agents/BedrockAgent.js +323 -0
- package/dist/agents/BedrockAgent.js.map +1 -0
- package/dist/ai-chat/AIChatClient.d.ts +316 -0
- package/dist/ai-chat/AIChatClient.js +535 -0
- package/dist/ai-chat/AIChatClient.js.map +1 -0
- package/dist/ai-chat/ChatGateway.d.ts +408 -0
- package/dist/ai-chat/ChatGateway.js +747 -0
- package/dist/ai-chat/ChatGateway.js.map +1 -0
- package/dist/ai-chat/HandoffRouter.d.ts +282 -0
- package/dist/ai-chat/HandoffRouter.js +518 -0
- package/dist/ai-chat/HandoffRouter.js.map +1 -0
- package/dist/ai-chat/index.d.ts +12 -0
- package/dist/ai-chat/index.js +10 -0
- package/dist/ai-chat/index.js.map +1 -0
- package/dist/capabilities.d.ts +64 -0
- package/dist/capabilities.js +95 -0
- package/dist/capabilities.js.map +1 -0
- package/dist/cli/agent-loader.d.ts +32 -6
- package/dist/cli/agent-loader.js +92 -33
- package/dist/cli/agent-loader.js.map +1 -1
- package/dist/cli/datamap-exec.d.ts +175 -0
- package/dist/cli/datamap-exec.js +1284 -0
- package/dist/cli/datamap-exec.js.map +1 -0
- package/dist/cli/function-args.d.ts +40 -0
- package/dist/cli/function-args.js +146 -0
- package/dist/cli/function-args.js.map +1 -0
- package/dist/cli/simulation.d.ts +99 -0
- package/dist/cli/simulation.js +490 -0
- package/dist/cli/simulation.js.map +1 -0
- package/dist/cli/swaig-test.d.ts +12 -25
- package/dist/cli/swaig-test.js +935 -371
- package/dist/cli/swaig-test.js.map +1 -1
- package/dist/cli/tsdocs/agentsNote.d.ts +30 -0
- package/dist/cli/tsdocs/agentsNote.js +92 -0
- package/dist/cli/tsdocs/agentsNote.js.map +1 -0
- package/dist/cli/tsdocs/api-index.json +1 -0
- package/dist/cli/tsdocs/api.d.ts +91 -0
- package/dist/cli/tsdocs/api.js +372 -0
- package/dist/cli/tsdocs/api.js.map +1 -0
- package/dist/cli/tsdocs/apiTypes.d.ts +64 -0
- package/dist/cli/tsdocs/apiTypes.js +7 -0
- package/dist/cli/tsdocs/apiTypes.js.map +1 -0
- package/dist/cli/tsdocs/bin.d.ts +6 -0
- package/dist/cli/tsdocs/bin.js +23 -0
- package/dist/cli/tsdocs/bin.js.map +1 -0
- package/dist/cli/tsdocs/files.d.ts +108 -0
- package/dist/cli/tsdocs/files.js +287 -0
- package/dist/cli/tsdocs/files.js.map +1 -0
- package/dist/cli/tsdocs/index.d.ts +28 -0
- package/dist/cli/tsdocs/index.js +307 -0
- package/dist/cli/tsdocs/index.js.map +1 -0
- package/dist/cli/tsdocs/live.d.ts +41 -0
- package/dist/cli/tsdocs/live.js +202 -0
- package/dist/cli/tsdocs/live.js.map +1 -0
- package/dist/cli/tsdocs/locate.d.ts +51 -0
- package/dist/cli/tsdocs/locate.js +75 -0
- package/dist/cli/tsdocs/locate.js.map +1 -0
- package/dist/cli/tsdocs/render.d.ts +75 -0
- package/dist/cli/tsdocs/render.js +323 -0
- package/dist/cli/tsdocs/render.js.map +1 -0
- package/dist/cli/tsdocs/topics.d.ts +43 -0
- package/dist/cli/tsdocs/topics.js +916 -0
- package/dist/cli/tsdocs/topics.js.map +1 -0
- package/dist/index.d.ts +47 -68
- package/dist/index.js +44 -73
- package/dist/index.js.map +1 -1
- package/dist/livewire/index.d.ts +229 -155
- package/dist/livewire/index.js +298 -195
- package/dist/livewire/index.js.map +1 -1
- package/dist/llms.txt +65 -0
- package/dist/prefabs/CallSessionStore.d.ts +52 -0
- package/dist/prefabs/CallSessionStore.js +72 -0
- package/dist/prefabs/CallSessionStore.js.map +1 -0
- package/dist/prefabs/ConciergeAgent.d.ts +13 -1
- package/dist/prefabs/ConciergeAgent.js +36 -31
- package/dist/prefabs/ConciergeAgent.js.map +1 -1
- package/dist/prefabs/FAQBotAgent.d.ts +9 -1
- package/dist/prefabs/FAQBotAgent.js +113 -47
- package/dist/prefabs/FAQBotAgent.js.map +1 -1
- package/dist/prefabs/InfoGathererAgent.d.ts +22 -3
- package/dist/prefabs/InfoGathererAgent.js +67 -58
- package/dist/prefabs/InfoGathererAgent.js.map +1 -1
- package/dist/prefabs/ReceptionistAgent.d.ts +16 -5
- package/dist/prefabs/ReceptionistAgent.js +39 -31
- package/dist/prefabs/ReceptionistAgent.js.map +1 -1
- package/dist/prefabs/SurveyAgent.d.ts +22 -4
- package/dist/prefabs/SurveyAgent.js +84 -68
- package/dist/prefabs/SurveyAgent.js.map +1 -1
- package/dist/relay/Action.d.ts +44 -21
- package/dist/relay/Action.js +75 -17
- package/dist/relay/Action.js.map +1 -1
- package/dist/relay/Call.d.ts +312 -47
- package/dist/relay/Call.js +369 -18
- package/dist/relay/Call.js.map +1 -1
- package/dist/relay/Deferred.js.map +1 -1
- package/dist/relay/Message.d.ts +26 -5
- package/dist/relay/Message.js +36 -6
- package/dist/relay/Message.js.map +1 -1
- package/dist/relay/RelayClient.d.ts +44 -17
- package/dist/relay/RelayClient.js +175 -65
- package/dist/relay/RelayClient.js.map +1 -1
- package/dist/relay/RelayError.d.ts +14 -0
- package/dist/relay/RelayError.js +15 -0
- package/dist/relay/RelayError.js.map +1 -1
- package/dist/relay/RelayEvent.d.ts +96 -65
- package/dist/relay/RelayEvent.js +85 -56
- package/dist/relay/RelayEvent.js.map +1 -1
- package/dist/relay/closedSets.d.ts +111 -0
- package/dist/relay/closedSets.js +83 -0
- package/dist/relay/closedSets.js.map +1 -0
- package/dist/relay/index.d.ts +3 -1
- package/dist/relay/index.js +1 -0
- package/dist/relay/index.js.map +1 -1
- package/dist/relay/normalize.js.map +1 -1
- package/dist/relay/protocol.types.generated.d.ts +1195 -0
- package/dist/relay/protocol.types.generated.js +8 -0
- package/dist/relay/protocol.types.generated.js.map +1 -0
- package/dist/relay/types.d.ts +73 -42
- package/dist/rest/HttpClient.d.ts +36 -8
- package/dist/rest/HttpClient.js +233 -40
- package/dist/rest/HttpClient.js.map +1 -1
- package/dist/rest/RequestOptions.d.ts +110 -0
- package/dist/rest/RequestOptions.js +113 -0
- package/dist/rest/RequestOptions.js.map +1 -0
- package/dist/rest/RestError.d.ts +52 -6
- package/dist/rest/RestError.js +89 -5
- package/dist/rest/RestError.js.map +1 -1
- package/dist/rest/base/CrudResource.d.ts +16 -26
- package/dist/rest/base/CrudResource.js +19 -33
- package/dist/rest/base/CrudResource.js.map +1 -1
- package/dist/rest/base/CrudWithAddresses.d.ts +3 -2
- package/dist/rest/base/CrudWithAddresses.js +2 -2
- package/dist/rest/base/CrudWithAddresses.js.map +1 -1
- package/dist/rest/base/FabricResource.d.ts +15 -0
- package/dist/rest/base/FabricResource.js +16 -0
- package/dist/rest/base/FabricResource.js.map +1 -0
- package/dist/rest/base/ReadResource.d.ts +62 -0
- package/dist/rest/base/ReadResource.js +69 -0
- package/dist/rest/base/ReadResource.js.map +1 -0
- package/dist/rest/callHandler.d.ts +5 -2
- package/dist/rest/callHandler.js +4 -1
- package/dist/rest/callHandler.js.map +1 -1
- package/dist/rest/index.d.ts +18 -77
- package/dist/rest/index.js +47 -120
- package/dist/rest/index.js.map +1 -1
- package/dist/rest/namespaces/_client_tree_generated.d.ts +103 -0
- package/dist/rest/namespaces/_client_tree_generated.js +171 -0
- package/dist/rest/namespaces/_client_tree_generated.js.map +1 -0
- package/dist/rest/namespaces/addresses.d.ts +3 -42
- package/dist/rest/namespaces/addresses.js +3 -50
- package/dist/rest/namespaces/addresses.js.map +1 -1
- package/dist/rest/namespaces/calling.d.ts +6 -378
- package/dist/rest/namespaces/calling.js +6 -473
- package/dist/rest/namespaces/calling.js.map +1 -1
- package/dist/rest/namespaces/calling.resources.generated.d.ts +165 -0
- package/dist/rest/namespaces/calling.resources.generated.js +477 -0
- package/dist/rest/namespaces/calling.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/calling.types.generated.d.ts +2917 -0
- package/dist/rest/namespaces/calling.types.generated.js +8 -0
- package/dist/rest/namespaces/calling.types.generated.js.map +1 -0
- package/dist/rest/namespaces/chat.d.ts +4 -18
- package/dist/rest/namespaces/chat.js +4 -21
- package/dist/rest/namespaces/chat.js.map +1 -1
- package/dist/rest/namespaces/chat.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/chat.resources.generated.js +29 -0
- package/dist/rest/namespaces/chat.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/chat.types.generated.d.ts +56 -0
- package/dist/rest/namespaces/chat.types.generated.js +8 -0
- package/dist/rest/namespaces/chat.types.generated.js.map +1 -0
- package/dist/rest/namespaces/datasphere.d.ts +6 -62
- package/dist/rest/namespaces/datasphere.js +6 -72
- package/dist/rest/namespaces/datasphere.js.map +1 -1
- package/dist/rest/namespaces/datasphere.resources.generated.d.ts +25 -0
- package/dist/rest/namespaces/datasphere.resources.generated.js +50 -0
- package/dist/rest/namespaces/datasphere.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/datasphere.types.generated.d.ts +180 -0
- package/dist/rest/namespaces/datasphere.types.generated.js +8 -0
- package/dist/rest/namespaces/datasphere.types.generated.js.map +1 -0
- package/dist/rest/namespaces/fabric.d.ts +11 -327
- package/dist/rest/namespaces/fabric.js +14 -439
- package/dist/rest/namespaces/fabric.js.map +1 -1
- package/dist/rest/namespaces/fabric.resources.generated.d.ts +195 -0
- package/dist/rest/namespaces/fabric.resources.generated.js +399 -0
- package/dist/rest/namespaces/fabric.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/fabric.types.generated.d.ts +4557 -0
- package/dist/rest/namespaces/fabric.types.generated.js +8 -0
- package/dist/rest/namespaces/fabric.types.generated.js.map +1 -0
- package/dist/rest/namespaces/fax.resources.generated.d.ts +6 -0
- package/dist/rest/namespaces/fax.resources.generated.js +14 -0
- package/dist/rest/namespaces/fax.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/fax.types.generated.d.ts +131 -0
- package/dist/rest/namespaces/fax.types.generated.js +8 -0
- package/dist/rest/namespaces/fax.types.generated.js.map +1 -0
- package/dist/rest/namespaces/imported-numbers.d.ts +3 -18
- package/dist/rest/namespaces/imported-numbers.js +3 -21
- package/dist/rest/namespaces/imported-numbers.js.map +1 -1
- package/dist/rest/namespaces/logs.d.ts +10 -101
- package/dist/rest/namespaces/logs.js +10 -128
- package/dist/rest/namespaces/logs.js.map +1 -1
- package/dist/rest/namespaces/logs.resources.generated.d.ts +9 -0
- package/dist/rest/namespaces/logs.resources.generated.js +17 -0
- package/dist/rest/namespaces/logs.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/logs.types.generated.d.ts +131 -0
- package/dist/rest/namespaces/logs.types.generated.js +8 -0
- package/dist/rest/namespaces/logs.types.generated.js.map +1 -0
- package/dist/rest/namespaces/lookup.d.ts +3 -25
- package/dist/rest/namespaces/lookup.js +3 -27
- package/dist/rest/namespaces/lookup.js.map +1 -1
- package/dist/rest/namespaces/message.resources.generated.d.ts +6 -0
- package/dist/rest/namespaces/message.resources.generated.js +14 -0
- package/dist/rest/namespaces/message.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/message.types.generated.d.ts +122 -0
- package/dist/rest/namespaces/message.types.generated.js +8 -0
- package/dist/rest/namespaces/message.types.generated.js.map +1 -0
- package/dist/rest/namespaces/messages.resources.generated.d.ts +18 -0
- package/dist/rest/namespaces/messages.resources.generated.js +44 -0
- package/dist/rest/namespaces/messages.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/messages.types.generated.d.ts +99 -0
- package/dist/rest/namespaces/messages.types.generated.js +8 -0
- package/dist/rest/namespaces/messages.types.generated.js.map +1 -0
- package/dist/rest/namespaces/mfa.d.ts +3 -42
- package/dist/rest/namespaces/mfa.js +3 -49
- package/dist/rest/namespaces/mfa.js.map +1 -1
- package/dist/rest/namespaces/number-groups.d.ts +3 -45
- package/dist/rest/namespaces/number-groups.js +3 -53
- package/dist/rest/namespaces/number-groups.js.map +1 -1
- package/dist/rest/namespaces/phone-numbers.d.ts +8 -196
- package/dist/rest/namespaces/phone-numbers.js +8 -230
- package/dist/rest/namespaces/phone-numbers.js.map +1 -1
- package/dist/rest/namespaces/project.d.ts +6 -42
- package/dist/rest/namespaces/project.js +6 -51
- package/dist/rest/namespaces/project.js.map +1 -1
- package/dist/rest/namespaces/project.resources.generated.d.ts +17 -0
- package/dist/rest/namespaces/project.resources.generated.js +44 -0
- package/dist/rest/namespaces/project.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/project.types.generated.d.ts +58 -0
- package/dist/rest/namespaces/project.types.generated.js +8 -0
- package/dist/rest/namespaces/project.types.generated.js.map +1 -0
- package/dist/rest/namespaces/projects.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/projects.resources.generated.js +25 -0
- package/dist/rest/namespaces/projects.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/projects.types.generated.d.ts +77 -0
- package/dist/rest/namespaces/projects.types.generated.js +8 -0
- package/dist/rest/namespaces/projects.types.generated.js.map +1 -0
- package/dist/rest/namespaces/pubsub.d.ts +4 -18
- package/dist/rest/namespaces/pubsub.js +4 -21
- package/dist/rest/namespaces/pubsub.js.map +1 -1
- package/dist/rest/namespaces/pubsub.resources.generated.d.ts +12 -0
- package/dist/rest/namespaces/pubsub.resources.generated.js +29 -0
- package/dist/rest/namespaces/pubsub.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/pubsub.types.generated.d.ts +60 -0
- package/dist/rest/namespaces/pubsub.types.generated.js +8 -0
- package/dist/rest/namespaces/pubsub.types.generated.js.map +1 -0
- package/dist/rest/namespaces/queues.d.ts +3 -38
- package/dist/rest/namespaces/queues.js +3 -44
- package/dist/rest/namespaces/queues.js.map +1 -1
- package/dist/rest/namespaces/recordings.d.ts +3 -34
- package/dist/rest/namespaces/recordings.js +3 -40
- package/dist/rest/namespaces/recordings.js.map +1 -1
- package/dist/rest/namespaces/registry.d.ts +6 -137
- package/dist/rest/namespaces/registry.js +6 -173
- package/dist/rest/namespaces/registry.js.map +1 -1
- package/dist/rest/namespaces/relay-rest.resources.generated.d.ts +168 -0
- package/dist/rest/namespaces/relay-rest.resources.generated.js +430 -0
- package/dist/rest/namespaces/relay-rest.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/relay-rest.types.generated.d.ts +1906 -0
- package/dist/rest/namespaces/relay-rest.types.generated.js +8 -0
- package/dist/rest/namespaces/relay-rest.types.generated.js.map +1 -0
- package/dist/rest/namespaces/short-codes.d.ts +3 -35
- package/dist/rest/namespaces/short-codes.js +3 -41
- package/dist/rest/namespaces/short-codes.js.map +1 -1
- package/dist/rest/namespaces/sip-profile.d.ts +3 -24
- package/dist/rest/namespaces/sip-profile.js +3 -29
- package/dist/rest/namespaces/sip-profile.js.map +1 -1
- package/dist/rest/namespaces/verified-callers.d.ts +3 -29
- package/dist/rest/namespaces/verified-callers.js +3 -34
- package/dist/rest/namespaces/verified-callers.js.map +1 -1
- package/dist/rest/namespaces/video.d.ts +10 -227
- package/dist/rest/namespaces/video.js +10 -288
- package/dist/rest/namespaces/video.js.map +1 -1
- package/dist/rest/namespaces/video.resources.generated.d.ts +81 -0
- package/dist/rest/namespaces/video.resources.generated.js +171 -0
- package/dist/rest/namespaces/video.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/video.types.generated.d.ts +771 -0
- package/dist/rest/namespaces/video.types.generated.js +8 -0
- package/dist/rest/namespaces/video.types.generated.js.map +1 -0
- package/dist/rest/namespaces/voice.resources.generated.d.ts +9 -0
- package/dist/rest/namespaces/voice.resources.generated.js +17 -0
- package/dist/rest/namespaces/voice.resources.generated.js.map +1 -0
- package/dist/rest/namespaces/voice.types.generated.d.ts +214 -0
- package/dist/rest/namespaces/voice.types.generated.js +8 -0
- package/dist/rest/namespaces/voice.types.generated.js.map +1 -0
- package/dist/rest/pagination.d.ts +5 -1
- package/dist/rest/pagination.js +40 -20
- package/dist/rest/pagination.js.map +1 -1
- package/dist/rest/types.d.ts +21 -3
- package/dist/schema.json +299 -98
- package/dist/skills/SkillBase.d.ts +97 -20
- package/dist/skills/SkillBase.js +100 -17
- package/dist/skills/SkillBase.js.map +1 -1
- package/dist/skills/SkillManager.d.ts +66 -13
- package/dist/skills/SkillManager.js +101 -20
- package/dist/skills/SkillManager.js.map +1 -1
- package/dist/skills/SkillName.d.ts +44 -0
- package/dist/skills/SkillName.js +2 -0
- package/dist/skills/SkillName.js.map +1 -0
- package/dist/skills/SkillRegistry.d.ts +22 -11
- package/dist/skills/SkillRegistry.js +47 -17
- package/dist/skills/SkillRegistry.js.map +1 -1
- package/dist/skills/builtin/api_ninjas_trivia.d.ts +3 -1
- package/dist/skills/builtin/api_ninjas_trivia.js +18 -6
- package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -1
- package/dist/skills/builtin/ask_claude.d.ts +14 -4
- package/dist/skills/builtin/ask_claude.js +36 -14
- package/dist/skills/builtin/ask_claude.js.map +1 -1
- package/dist/skills/builtin/claude_skills.d.ts +3 -1
- package/dist/skills/builtin/claude_skills.js +19 -15
- package/dist/skills/builtin/claude_skills.js.map +1 -1
- package/dist/skills/builtin/custom_skills.d.ts +10 -3
- package/dist/skills/builtin/custom_skills.js +26 -9
- package/dist/skills/builtin/custom_skills.js.map +1 -1
- package/dist/skills/builtin/datasphere.d.ts +5 -3
- package/dist/skills/builtin/datasphere.js +21 -22
- package/dist/skills/builtin/datasphere.js.map +1 -1
- package/dist/skills/builtin/datasphere_serverless.d.ts +12 -1
- package/dist/skills/builtin/datasphere_serverless.js +17 -6
- package/dist/skills/builtin/datasphere_serverless.js.map +1 -1
- package/dist/skills/builtin/datetime.d.ts +3 -1
- package/dist/skills/builtin/datetime.js +11 -7
- package/dist/skills/builtin/datetime.js.map +1 -1
- package/dist/skills/builtin/google_maps.d.ts +29 -14
- package/dist/skills/builtin/google_maps.js +89 -269
- package/dist/skills/builtin/google_maps.js.map +1 -1
- package/dist/skills/builtin/index.d.ts +8 -6
- package/dist/skills/builtin/index.js +8 -6
- package/dist/skills/builtin/index.js.map +1 -1
- package/dist/skills/builtin/info_gatherer.d.ts +4 -2
- package/dist/skills/builtin/info_gatherer.js +20 -12
- package/dist/skills/builtin/info_gatherer.js.map +1 -1
- package/dist/skills/builtin/joke.d.ts +16 -6
- package/dist/skills/builtin/joke.js +54 -37
- package/dist/skills/builtin/joke.js.map +1 -1
- package/dist/skills/builtin/math.d.ts +3 -1
- package/dist/skills/builtin/math.js +14 -9
- package/dist/skills/builtin/math.js.map +1 -1
- package/dist/skills/builtin/mcp_gateway.d.ts +34 -5
- package/dist/skills/builtin/mcp_gateway.js +77 -46
- package/dist/skills/builtin/mcp_gateway.js.map +1 -1
- package/dist/skills/builtin/native_vector_search.d.ts +19 -5
- package/dist/skills/builtin/native_vector_search.js +179 -61
- package/dist/skills/builtin/native_vector_search.js.map +1 -1
- package/dist/skills/builtin/play_background_file.d.ts +21 -15
- package/dist/skills/builtin/play_background_file.js +43 -122
- package/dist/skills/builtin/play_background_file.js.map +1 -1
- package/dist/skills/builtin/spider.d.ts +42 -4
- package/dist/skills/builtin/spider.js +277 -104
- package/dist/skills/builtin/spider.js.map +1 -1
- package/dist/skills/builtin/swml_transfer.d.ts +14 -3
- package/dist/skills/builtin/swml_transfer.js +45 -24
- package/dist/skills/builtin/swml_transfer.js.map +1 -1
- package/dist/skills/builtin/weather_api.d.ts +24 -13
- package/dist/skills/builtin/weather_api.js +38 -30
- package/dist/skills/builtin/weather_api.js.map +1 -1
- package/dist/skills/builtin/web_search.d.ts +48 -10
- package/dist/skills/builtin/web_search.js +294 -100
- package/dist/skills/builtin/web_search.js.map +1 -1
- package/dist/skills/builtin/wikipedia_search.d.ts +4 -2
- package/dist/skills/builtin/wikipedia_search.js +14 -13
- package/dist/skills/builtin/wikipedia_search.js.map +1 -1
- package/dist/skills/index.d.ts +3 -2
- package/dist/skills/index.js +1 -1
- package/dist/skills/index.js.map +1 -1
- package/dist/swml_verbs_generated.d.ts +2824 -0
- package/dist/swml_verbs_generated.js +12 -0
- package/dist/swml_verbs_generated.js.map +1 -0
- package/dist/types.d.ts +59 -6
- package/dist/web.d.ts +27 -0
- package/dist/web.js +20 -0
- package/dist/web.js.map +1 -0
- package/docs/agent-guide.md +1034 -0
- package/docs/ai_chat.md +560 -0
- package/docs/api-reference.md +3534 -0
- package/docs/architecture.md +846 -0
- package/docs/bedrock_agent.md +411 -0
- package/docs/cli-guide.md +403 -0
- package/docs/cloud_functions_guide.md +399 -0
- package/docs/configuration.md +548 -0
- package/docs/contexts-guide.md +884 -0
- package/docs/datamap-guide.md +1160 -0
- package/docs/developer_pain_points.md +548 -0
- package/docs/llm_parameters.md +298 -0
- package/docs/mcp_gateway_reference.md +354 -0
- package/docs/mcp_integration.md +162 -0
- package/docs/pgi_agent_guide.md +1820 -0
- package/docs/prefabs-guide.md +815 -0
- package/docs/programmatically_governed_inference.md +301 -0
- package/docs/sdk_features.md +501 -0
- package/docs/security.md +559 -0
- package/docs/serverless-guide.md +520 -0
- package/docs/skills-guide.md +1223 -0
- package/docs/skills-system.md +405 -0
- package/docs/skills_parameter_schema.md +417 -0
- package/docs/swaig-reference.md +1938 -0
- package/docs/swml_service_guide.md +573 -0
- package/docs/third_party_skills.md +410 -0
- package/docs/web_service.md +666 -0
- package/examples/README.md +202 -0
- package/examples/advanced-datamap.ts +108 -0
- package/examples/advanced-dynamic-config.ts +70 -0
- package/examples/auto-vivified.ts +95 -0
- package/examples/call-flow.ts +65 -0
- package/examples/comprehensive-dynamic.ts +125 -0
- package/examples/contexts-steps.ts +65 -0
- package/examples/custom-path.ts +45 -0
- package/examples/datamap-tools.ts +51 -0
- package/examples/datasphere-multi-instance.ts +66 -0
- package/examples/datasphere-serverless-env.ts +87 -0
- package/examples/datasphere-webhook-env.ts +65 -0
- package/examples/datasphere.ts +56 -0
- package/examples/declarative.ts +100 -0
- package/examples/dynamic-config.ts +54 -0
- package/examples/dynamic-info-gatherer.ts +69 -0
- package/examples/dynamic-swml-service.ts +67 -0
- package/examples/gather-info.ts +95 -0
- package/examples/gather-per-question-functions-demo.ts +139 -0
- package/examples/joke-agent.ts +34 -0
- package/examples/kubernetes-agent.ts +45 -0
- package/examples/llm-params.ts +75 -0
- package/examples/mcp-agent.ts +89 -0
- package/examples/mcp-gateway.ts +81 -0
- package/examples/multi-agent.ts +80 -0
- package/examples/multi-endpoint.ts +79 -0
- package/examples/pgi/case-domain.ts +114 -0
- package/examples/pgi/serve.ts +16 -0
- package/examples/pgi/support-agent.ts +265 -0
- package/examples/pom-prompt.ts +70 -0
- package/examples/prefab-concierge.ts +42 -0
- package/examples/prefab-faq.ts +58 -0
- package/examples/prefab-info-gatherer.ts +33 -0
- package/examples/prefab-receptionist.ts +36 -0
- package/examples/prefab-survey.ts +69 -0
- package/examples/quickstart-agent.ts +29 -0
- package/examples/quickstart-relay.ts +25 -0
- package/examples/quickstart-rest.ts +25 -0
- package/examples/record-call.ts +65 -0
- package/examples/relay-demo.ts +33 -0
- package/examples/room-and-sip.ts +93 -0
- package/examples/serverless-lambda.ts +43 -0
- package/examples/session-state.ts +83 -0
- package/examples/simple-agent.ts +36 -0
- package/examples/simple-static.ts +29 -0
- package/examples/skills-demo.ts +41 -0
- package/examples/step-function-inheritance-demo.ts +124 -0
- package/examples/swaig-features.ts +193 -0
- package/examples/swml-service-routing.ts +66 -0
- package/examples/swml-service.ts +38 -0
- package/examples/swmlservice_ai_sidecar.ts +104 -0
- package/examples/swmlservice_swaig_standalone.ts +79 -0
- package/examples/tap.ts +67 -0
- package/examples/typed-tools.ts +68 -0
- package/examples/verb-methods.ts +45 -0
- package/examples/web-search-multi-instance.ts +75 -0
- package/examples/web-search.ts +38 -0
- package/examples/wikipedia.ts +36 -0
- package/livewire/README.md +164 -0
- package/livewire/docs/migration-guide.md +251 -0
- package/livewire/examples/livewire-basic-agent.ts +74 -0
- package/livewire/examples/livewire-handoff.ts +196 -0
- package/livewire/examples/livewire-multi-tool.ts +121 -0
- package/package.json +85 -13
- package/relay/README.md +101 -0
- package/relay/docs/call-methods.md +622 -0
- package/relay/docs/client-reference.md +281 -0
- package/relay/docs/events.md +193 -0
- package/relay/docs/getting-started.md +221 -0
- package/relay/docs/guide.md +386 -0
- package/relay/docs/messaging.md +246 -0
- package/relay/examples/relay-inbound.ts +66 -0
- package/relay/examples/relay-messaging.ts +74 -0
- package/relay/examples/relay-outbound.ts +76 -0
- package/rest/README.md +141 -0
- package/rest/docs/calling.md +313 -0
- package/rest/docs/client-reference.md +149 -0
- package/rest/docs/fabric.md +192 -0
- package/rest/docs/getting-started.md +138 -0
- package/rest/docs/guide.md +421 -0
- package/rest/docs/namespaces.md +367 -0
- package/rest/docs/phone-binding.md +116 -0
- package/rest/examples/rest-10dlc-registration.ts +177 -0
- package/rest/examples/rest-bind-phone-to-swml-webhook.ts +66 -0
- package/rest/examples/rest-calling-ivr-and-ai.ts +136 -0
- package/rest/examples/rest-calling-play-and-record.ts +98 -0
- package/rest/examples/rest-client.ts +59 -0
- package/rest/examples/rest-datasphere-search.ts +81 -0
- package/rest/examples/rest-fabric-conferences-and-routing.ts +147 -0
- package/rest/examples/rest-fabric-subscribers-and-sip.ts +106 -0
- package/rest/examples/rest-fabric-swml-and-callflows.ts +101 -0
- package/rest/examples/rest-manage-resources.ts +64 -0
- package/rest/examples/rest-phone-number-management.ts +200 -0
- package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
- package/rest/examples/rest-video-rooms.ts +186 -0
- package/tutorial/fred/fred.ts +218 -0
- package/tutorial/fred/tutorial/01-introduction.md +141 -0
- package/tutorial/fred/tutorial/02-setup.md +304 -0
- package/tutorial/fred/tutorial/03-basic-agent.md +284 -0
- package/tutorial/fred/tutorial/04-wikipedia-skill.md +298 -0
- package/tutorial/fred/tutorial/05-custom-functions.md +347 -0
- package/tutorial/fred/tutorial/06-running-testing.md +642 -0
- package/tutorial/fred/tutorial/README.md +56 -0
- package/tutorial/fred/tutorial/appendix-complete-code.md +632 -0
- package/tutorial/fred/tutorial/appendix-docker-deployment.md +504 -0
- package/tutorial/full-guardrails-agent/handlers.ts +436 -0
- package/tutorial/full-guardrails-agent/penny.ts +305 -0
- package/tutorial/full-guardrails-agent/reservations.ts +1109 -0
- package/tutorial/full-guardrails-agent/tutorial/01-why-guardrails.md +149 -0
- package/tutorial/full-guardrails-agent/tutorial/02-design-first.md +139 -0
- package/tutorial/full-guardrails-agent/tutorial/03-rules-first.md +422 -0
- package/tutorial/full-guardrails-agent/tutorial/04-the-shell.md +238 -0
- package/tutorial/full-guardrails-agent/tutorial/05-steps-and-scoping.md +247 -0
- package/tutorial/full-guardrails-agent/tutorial/06-tools-that-decide.md +467 -0
- package/tutorial/full-guardrails-agent/tutorial/07-gather-and-projection.md +160 -0
- package/tutorial/full-guardrails-agent/tutorial/08-the-verification-gate.md +333 -0
- package/tutorial/full-guardrails-agent/tutorial/09-people-and-endings.md +313 -0
- package/tutorial/full-guardrails-agent/tutorial/10-testing-and-running.md +387 -0
- package/tutorial/full-guardrails-agent/tutorial/README.md +106 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-complete-code.md +2207 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-deployment.md +191 -0
- package/tutorial/full-guardrails-agent/tutorial/appendix-technique-map.md +117 -0
- package/tutorial/full-guardrails-agent/workflow.ts +219 -0
- package/tutorial/multi_agents/README.md +175 -0
- package/tutorial/multi_agents/advanced_agent.ts +395 -0
- package/tutorial/multi_agents/extending_agents.ts +641 -0
- package/tutorial/multi_agents/knowledge.ts +59 -0
- package/tutorial/multi_agents/lesson1_first_agent.md +368 -0
- package/tutorial/multi_agents/lesson2_knowledge_bases.md +404 -0
- package/tutorial/multi_agents/lesson3_multi_agent_systems.md +621 -0
- package/tutorial/multi_agents/lesson4_advanced_features.md +805 -0
- package/tutorial/multi_agents/lesson5_extending_agents.md +856 -0
- package/tutorial/multi_agents/pc_builder.ts +529 -0
- package/tutorial/multi_agents/sales_agent.ts +88 -0
- package/tutorial/multi_agents/sales_agent_with_search.ts +116 -0
- package/tutorial/multi_agents/sales_knowledge.md +139 -0
- package/tutorial/multi_agents/support_knowledge.md +256 -0
- package/dist/cli/mock-data.d.ts +0 -37
- package/dist/cli/mock-data.js +0 -80
- package/dist/cli/mock-data.js.map +0 -1
- package/dist/generateVerbTypes.d.ts +0 -11
- package/dist/generateVerbTypes.js +0 -265
- package/dist/generateVerbTypes.js.map +0 -1
- package/dist/rest/namespaces/compat.d.ts +0 -585
- package/dist/rest/namespaces/compat.js +0 -735
- package/dist/rest/namespaces/compat.js.map +0 -1
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Capabilities - reading what a client says it can do.
|
|
3
|
+
*
|
|
4
|
+
* A browser client (the SignalWire address widget, or anything speaking the
|
|
5
|
+
* same convention) declares its rendering capabilities in the user variables
|
|
6
|
+
* it sends at dial time:
|
|
7
|
+
*
|
|
8
|
+
* ```json
|
|
9
|
+
* { "vars": { "userVariables": {
|
|
10
|
+
* "capabilities": { "display_content": true, "transcript": true, "chat_handoff": false },
|
|
11
|
+
* "metadata": { "page": {}, "client": {}, "widget": {} } } } }
|
|
12
|
+
* ```
|
|
13
|
+
*
|
|
14
|
+
* These are declarations of what the client can RENDER, not grants of
|
|
15
|
+
* authority. Treat them as hints for deciding what to offer (whether to push
|
|
16
|
+
* content to a screen, whether to advertise a text-handoff tool), never as
|
|
17
|
+
* permission to do anything privileged: a caller controls its own user
|
|
18
|
+
* variables.
|
|
19
|
+
*
|
|
20
|
+
* Absence means no. Every function here resolves errors and missing data to
|
|
21
|
+
* "not declared", because offering a caller something they can't reach is
|
|
22
|
+
* worse than never mentioning it: a phone caller has no screen.
|
|
23
|
+
*
|
|
24
|
+
* There's deliberately no list of known capability names: a client can declare
|
|
25
|
+
* one this SDK has never heard of, and an application can act on it today.
|
|
26
|
+
* Mirrors signalwire-python's `signalwire.core.capabilities`.
|
|
27
|
+
*/
|
|
28
|
+
function isPlainObject(value) {
|
|
29
|
+
return typeof value === 'object' && value !== null && !Array.isArray(value);
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* The user variables from a SWML request body (`vars.userVariables`), or `{}`.
|
|
33
|
+
*
|
|
34
|
+
* They're nested two levels down, which is easy to get wrong silently: a
|
|
35
|
+
* missing level yields an empty object, and every later check reports "not
|
|
36
|
+
* declared".
|
|
37
|
+
*
|
|
38
|
+
* @param bodyParams - The SWML request body.
|
|
39
|
+
* @returns The user variables, or an empty object.
|
|
40
|
+
*/
|
|
41
|
+
export function userVariables(bodyParams) {
|
|
42
|
+
if (!isPlainObject(bodyParams))
|
|
43
|
+
return {};
|
|
44
|
+
const vars = bodyParams['vars'];
|
|
45
|
+
if (!isPlainObject(vars))
|
|
46
|
+
return {};
|
|
47
|
+
const variables = vars['userVariables'];
|
|
48
|
+
return isPlainObject(variables) ? variables : {};
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* The capability names the client declared as truthy.
|
|
52
|
+
*
|
|
53
|
+
* Accepts either a whole SWML request body or already-extracted user
|
|
54
|
+
* variables, so it works from a dynamic config callback and from a tool
|
|
55
|
+
* handler alike.
|
|
56
|
+
*
|
|
57
|
+
* @param bodyParams - A SWML request body, or a user variables object.
|
|
58
|
+
* @returns The declared names; empty when nothing was declared, the payload
|
|
59
|
+
* was malformed, or the client isn't a browser at all.
|
|
60
|
+
*
|
|
61
|
+
* @example
|
|
62
|
+
* ```ts
|
|
63
|
+
* if (declaredCapabilities(body).has('display_content')) {
|
|
64
|
+
* agent.promptAddSection('Screen', { body: 'You can show the caller content.' });
|
|
65
|
+
* }
|
|
66
|
+
* ```
|
|
67
|
+
*/
|
|
68
|
+
export function declaredCapabilities(bodyParams) {
|
|
69
|
+
let variables = userVariables(bodyParams);
|
|
70
|
+
if (Object.keys(variables).length === 0 && isPlainObject(bodyParams)) {
|
|
71
|
+
// Already-extracted user variables were passed directly.
|
|
72
|
+
variables = bodyParams;
|
|
73
|
+
}
|
|
74
|
+
const capabilities = variables['capabilities'];
|
|
75
|
+
if (!isPlainObject(capabilities))
|
|
76
|
+
return new Set();
|
|
77
|
+
return new Set(Object.entries(capabilities)
|
|
78
|
+
// Truthy as the reference means it: an empty list or object is no.
|
|
79
|
+
.filter(([, value]) => Array.isArray(value)
|
|
80
|
+
? value.length > 0
|
|
81
|
+
: isPlainObject(value)
|
|
82
|
+
? Object.keys(value).length > 0
|
|
83
|
+
: Boolean(value))
|
|
84
|
+
.map(([name]) => name));
|
|
85
|
+
}
|
|
86
|
+
/**
|
|
87
|
+
* Whether the client declared `name` as truthy.
|
|
88
|
+
* @param bodyParams - A SWML request body, or a user variables object.
|
|
89
|
+
* @param name - Capability name, e.g. `display_content`.
|
|
90
|
+
* @returns True only when explicitly declared truthy.
|
|
91
|
+
*/
|
|
92
|
+
export function hasCapability(bodyParams, name) {
|
|
93
|
+
return declaredCapabilities(bodyParams).has(name);
|
|
94
|
+
}
|
|
95
|
+
//# sourceMappingURL=capabilities.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"capabilities.js","sourceRoot":"","sources":["../src/capabilities.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,SAAS,aAAa,CAAC,KAAc;IACnC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,aAAa,CAAC,UAAmB;IAC/C,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC;QAAE,OAAO,EAAE,CAAC;IAC1C,MAAM,IAAI,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;IAChC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;QAAE,OAAO,EAAE,CAAC;IACpC,MAAM,SAAS,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC;IACxC,OAAO,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;AACnD,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,oBAAoB,CAAC,UAAmB;IACtD,IAAI,SAAS,GAAG,aAAa,CAAC,UAAU,CAAC,CAAC;IAC1C,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,aAAa,CAAC,UAAU,CAAC,EAAE,CAAC;QACrE,yDAAyD;QACzD,SAAS,GAAG,UAAU,CAAC;IACzB,CAAC;IACD,MAAM,YAAY,GAAG,SAAS,CAAC,cAAc,CAAC,CAAC;IAC/C,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC;QAAE,OAAO,IAAI,GAAG,EAAE,CAAC;IACnD,OAAO,IAAI,GAAG,CACZ,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC;QAC1B,mEAAmE;SAClE,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CACpB,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAClB,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;QAClB,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC;YACpB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,GAAG,CAAC;YAC/B,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CACrB;SACA,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CACzB,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,UAAmB,EAAE,IAAY;IAC7D,OAAO,oBAAoB,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AACpD,CAAC"}
|
|
@@ -1,19 +1,45 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Agent discovery via dynamic import for swaig-test CLI.
|
|
3
3
|
*
|
|
4
|
-
*
|
|
5
|
-
* 1.
|
|
6
|
-
* 2.
|
|
7
|
-
* 3.
|
|
8
|
-
*
|
|
4
|
+
* Finds the AgentBase or SWMLService to test, in this order:
|
|
5
|
+
* 1. The export named by `--agent-class` (an instance, or a class to instantiate).
|
|
6
|
+
* 2. With `--route`, the service whose route it is.
|
|
7
|
+
* 3. Named export `agent`, then the default export, then any exported
|
|
8
|
+
* instance, then an exported class (instantiated).
|
|
9
|
+
* 4. A service the file constructed without exporting it (the quickstart's
|
|
10
|
+
* `const agent = new AgentBase(...)`; `agent.run()`), found because
|
|
11
|
+
* SWMLService records itself while the CLI imports a file.
|
|
9
12
|
*/
|
|
13
|
+
/** Options for {@link loadAgent}. */
|
|
14
|
+
export interface LoadAgentOptions {
|
|
15
|
+
/** The route of the service to use, when the file has several. */
|
|
16
|
+
route?: string;
|
|
17
|
+
}
|
|
10
18
|
/**
|
|
11
19
|
* Dynamically import an agent file and resolve an AgentBase instance using duck-typing heuristics.
|
|
12
20
|
* @param agentPath - Path to the agent module file.
|
|
13
21
|
* @param agentClass - Optional name of a specific exported class or instance to use.
|
|
22
|
+
* @param opts - `route`: pick the service with this route.
|
|
14
23
|
* @returns The resolved AgentBase instance.
|
|
15
24
|
*/
|
|
16
|
-
export declare function loadAgent(agentPath: string, agentClass?: string): Promise<unknown>;
|
|
25
|
+
export declare function loadAgent(agentPath: string, agentClass?: string, opts?: LoadAgentOptions): Promise<unknown>;
|
|
26
|
+
/** One service a file has, as {@link describeAgents} reports it. */
|
|
27
|
+
export interface AgentDescription {
|
|
28
|
+
/** The export name, or the service's own name when it isn't exported. */
|
|
29
|
+
name: string;
|
|
30
|
+
/** Whether it's an instance or a class. */
|
|
31
|
+
kind: 'instance' | 'class';
|
|
32
|
+
/** The service's name, for an instance. */
|
|
33
|
+
agentName?: string;
|
|
34
|
+
/** The service's route, for an instance. */
|
|
35
|
+
route?: string;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Describe every service a file has: exported instances and classes, and
|
|
39
|
+
* instances it constructed without exporting.
|
|
40
|
+
* @param agentPath - Path to the agent module file.
|
|
41
|
+
*/
|
|
42
|
+
export declare function describeAgents(agentPath: string): Promise<AgentDescription[]>;
|
|
17
43
|
/**
|
|
18
44
|
* List all exported agent instances and classes in a module.
|
|
19
45
|
* @param agentPath - Path to the agent module file.
|
package/dist/cli/agent-loader.js
CHANGED
|
@@ -1,14 +1,18 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Agent discovery via dynamic import for swaig-test CLI.
|
|
3
3
|
*
|
|
4
|
-
*
|
|
5
|
-
* 1.
|
|
6
|
-
* 2.
|
|
7
|
-
* 3.
|
|
8
|
-
*
|
|
4
|
+
* Finds the AgentBase or SWMLService to test, in this order:
|
|
5
|
+
* 1. The export named by `--agent-class` (an instance, or a class to instantiate).
|
|
6
|
+
* 2. With `--route`, the service whose route it is.
|
|
7
|
+
* 3. Named export `agent`, then the default export, then any exported
|
|
8
|
+
* instance, then an exported class (instantiated).
|
|
9
|
+
* 4. A service the file constructed without exporting it (the quickstart's
|
|
10
|
+
* `const agent = new AgentBase(...)`; `agent.run()`), found because
|
|
11
|
+
* SWMLService records itself while the CLI imports a file.
|
|
9
12
|
*/
|
|
10
13
|
import { resolve, extname } from 'node:path';
|
|
11
14
|
import { pathToFileURL } from 'node:url';
|
|
15
|
+
import { _takeCliLoadedServices } from '../SWMLService.js';
|
|
12
16
|
/** Allowed file extensions for agent loading. */
|
|
13
17
|
const ALLOWED_EXTENSIONS = new Set(['.ts', '.js', '.mjs', '.mts']);
|
|
14
18
|
function isAgentInstance(obj) {
|
|
@@ -40,6 +44,7 @@ function isSWMLServiceInstance(obj) {
|
|
|
40
44
|
typeof a['addVerb'] === 'function' &&
|
|
41
45
|
typeof a['getPrompt'] !== 'function');
|
|
42
46
|
}
|
|
47
|
+
const isService = (obj) => isAgentInstance(obj) || isSWMLServiceInstance(obj);
|
|
43
48
|
/**
|
|
44
49
|
* Import a module by path after validating the file extension.
|
|
45
50
|
*
|
|
@@ -54,34 +59,45 @@ async function importModule(agentPath) {
|
|
|
54
59
|
`Only ${[...ALLOWED_EXTENSIONS].join(', ')} files are allowed.`);
|
|
55
60
|
}
|
|
56
61
|
const fileUrl = pathToFileURL(absPath).href;
|
|
57
|
-
// Suppress server startup: agent files call .
|
|
62
|
+
// Suppress server startup: agent files call .serve() at module scope,
|
|
58
63
|
// but the CLI only needs the configured agent instance, not a running server.
|
|
64
|
+
// In this mode, every SWMLService constructed also records itself.
|
|
65
|
+
const previousMode = process.env['SWAIG_CLI_MODE'];
|
|
59
66
|
process.env['SWAIG_CLI_MODE'] = 'true';
|
|
67
|
+
_takeCliLoadedServices();
|
|
60
68
|
try {
|
|
61
|
-
|
|
69
|
+
const exports = (await import(fileUrl));
|
|
70
|
+
return { exports, constructed: _takeCliLoadedServices() };
|
|
62
71
|
}
|
|
63
72
|
catch (err) {
|
|
64
|
-
throw new Error(`Failed to import agent file: ${absPath}\n${err}
|
|
73
|
+
throw new Error(`Failed to import agent file: ${absPath}\n${err}`, { cause: err });
|
|
65
74
|
}
|
|
66
75
|
finally {
|
|
67
|
-
|
|
76
|
+
if (previousMode === undefined)
|
|
77
|
+
delete process.env['SWAIG_CLI_MODE'];
|
|
78
|
+
else
|
|
79
|
+
process.env['SWAIG_CLI_MODE'] = previousMode;
|
|
68
80
|
}
|
|
69
81
|
}
|
|
82
|
+
const routeOf = (obj) => obj?.route;
|
|
83
|
+
/** Routes compare without a trailing slash. */
|
|
84
|
+
const sameRoute = (a, b) => a !== undefined && (a.replace(/\/+$/, '') || '/') === (b.replace(/\/+$/, '') || '/');
|
|
70
85
|
/**
|
|
71
86
|
* Dynamically import an agent file and resolve an AgentBase instance using duck-typing heuristics.
|
|
72
87
|
* @param agentPath - Path to the agent module file.
|
|
73
88
|
* @param agentClass - Optional name of a specific exported class or instance to use.
|
|
89
|
+
* @param opts - `route`: pick the service with this route.
|
|
74
90
|
* @returns The resolved AgentBase instance.
|
|
75
91
|
*/
|
|
76
|
-
export async function loadAgent(agentPath, agentClass) {
|
|
77
|
-
const mod = await importModule(agentPath);
|
|
92
|
+
export async function loadAgent(agentPath, agentClass, opts = {}) {
|
|
93
|
+
const { exports: mod, constructed } = await importModule(agentPath);
|
|
78
94
|
// If a specific class name is requested
|
|
79
95
|
if (agentClass) {
|
|
80
96
|
const target = mod[agentClass];
|
|
81
97
|
if (!target) {
|
|
82
98
|
throw new Error(`Export '${agentClass}' not found in ${agentPath}`);
|
|
83
99
|
}
|
|
84
|
-
if (
|
|
100
|
+
if (isService(target))
|
|
85
101
|
return target;
|
|
86
102
|
if (isAgentClass(target)) {
|
|
87
103
|
const Cls = target;
|
|
@@ -89,22 +105,40 @@ export async function loadAgent(agentPath, agentClass) {
|
|
|
89
105
|
}
|
|
90
106
|
throw new Error(`Export '${agentClass}' is not an AgentBase instance or class`);
|
|
91
107
|
}
|
|
108
|
+
// Every service the file has, exported or only constructed.
|
|
109
|
+
const candidates = [];
|
|
110
|
+
for (const value of [...Object.values(mod), ...constructed]) {
|
|
111
|
+
if (isService(value) && !candidates.includes(value))
|
|
112
|
+
candidates.push(value);
|
|
113
|
+
}
|
|
114
|
+
if (opts.route) {
|
|
115
|
+
const match = candidates.find((s) => sameRoute(routeOf(s), opts.route));
|
|
116
|
+
if (match)
|
|
117
|
+
return match;
|
|
118
|
+
for (const value of Object.values(mod)) {
|
|
119
|
+
if (!isAgentClass(value))
|
|
120
|
+
continue;
|
|
121
|
+
const instance = new value({ name: 'cli-agent' });
|
|
122
|
+
if (sameRoute(routeOf(instance), opts.route))
|
|
123
|
+
return instance;
|
|
124
|
+
}
|
|
125
|
+
const routes = candidates.map(routeOf).filter(Boolean);
|
|
126
|
+
throw new Error(`No service found with route '${opts.route}'` +
|
|
127
|
+
(routes.length ? `. Available routes: ${routes.join(', ')}` : ''));
|
|
128
|
+
}
|
|
92
129
|
// 1. Named export `agent`
|
|
93
|
-
if (
|
|
130
|
+
if (isAgentInstance(mod['agent']))
|
|
94
131
|
return mod['agent'];
|
|
95
|
-
}
|
|
96
132
|
// 2. Default export (instance)
|
|
97
|
-
if (
|
|
133
|
+
if (isAgentInstance(mod['default']))
|
|
98
134
|
return mod['default'];
|
|
99
|
-
}
|
|
100
135
|
// 3. Any exported AgentBase instance
|
|
101
136
|
for (const key of Object.keys(mod)) {
|
|
102
|
-
if (isAgentInstance(mod[key]))
|
|
137
|
+
if (isAgentInstance(mod[key]))
|
|
103
138
|
return mod[key];
|
|
104
|
-
}
|
|
105
139
|
}
|
|
106
140
|
// 4. Default export (class) - instantiate
|
|
107
|
-
if (
|
|
141
|
+
if (isAgentClass(mod['default'])) {
|
|
108
142
|
const Cls = mod['default'];
|
|
109
143
|
return new Cls({ name: 'cli-agent' });
|
|
110
144
|
}
|
|
@@ -115,32 +149,57 @@ export async function loadAgent(agentPath, agentClass) {
|
|
|
115
149
|
return new Cls({ name: 'cli-agent' });
|
|
116
150
|
}
|
|
117
151
|
}
|
|
118
|
-
// 6.
|
|
119
|
-
if (
|
|
152
|
+
// 6. An exported SWMLService
|
|
153
|
+
if (isSWMLServiceInstance(mod['agent']))
|
|
120
154
|
return mod['agent'];
|
|
121
|
-
}
|
|
122
|
-
// 7. Any exported SWMLService instance
|
|
123
155
|
for (const key of Object.keys(mod)) {
|
|
124
|
-
if (isSWMLServiceInstance(mod[key]))
|
|
156
|
+
if (isSWMLServiceInstance(mod[key]))
|
|
125
157
|
return mod[key];
|
|
126
|
-
|
|
158
|
+
}
|
|
159
|
+
// 7. A service the file constructed without exporting it
|
|
160
|
+
const unexported = constructed.filter(isService);
|
|
161
|
+
if (unexported.length === 1)
|
|
162
|
+
return unexported[0];
|
|
163
|
+
if (unexported.length > 1) {
|
|
164
|
+
throw new Error(`Multiple services found in ${resolve(agentPath)}; choose one with --route.\n` +
|
|
165
|
+
`Available routes: ${unexported.map(routeOf).join(', ')}`);
|
|
127
166
|
}
|
|
128
167
|
throw new Error(`Could not find an AgentBase or SWMLService instance in ${resolve(agentPath)}.\n` +
|
|
129
168
|
'Export your agent as `export const agent = new AgentBase(...)` or as default export.');
|
|
130
169
|
}
|
|
170
|
+
/**
|
|
171
|
+
* Describe every service a file has: exported instances and classes, and
|
|
172
|
+
* instances it constructed without exporting.
|
|
173
|
+
* @param agentPath - Path to the agent module file.
|
|
174
|
+
*/
|
|
175
|
+
export async function describeAgents(agentPath) {
|
|
176
|
+
const { exports: mod, constructed } = await importModule(agentPath);
|
|
177
|
+
const out = [];
|
|
178
|
+
const seen = new Set();
|
|
179
|
+
const describe = (name, value) => {
|
|
180
|
+
const { name: agentName, route } = value;
|
|
181
|
+
out.push({ name, kind: 'instance', agentName, route });
|
|
182
|
+
seen.add(value);
|
|
183
|
+
};
|
|
184
|
+
for (const [key, value] of Object.entries(mod)) {
|
|
185
|
+
if (isService(value))
|
|
186
|
+
describe(key, value);
|
|
187
|
+
else if (isAgentClass(value))
|
|
188
|
+
out.push({ name: key, kind: 'class' });
|
|
189
|
+
}
|
|
190
|
+
for (const value of constructed) {
|
|
191
|
+
if (isService(value) && !seen.has(value)) {
|
|
192
|
+
describe(value.name ?? 'service', value);
|
|
193
|
+
}
|
|
194
|
+
}
|
|
195
|
+
return out;
|
|
196
|
+
}
|
|
131
197
|
/**
|
|
132
198
|
* List all exported agent instances and classes in a module.
|
|
133
199
|
* @param agentPath - Path to the agent module file.
|
|
134
200
|
* @returns Array of export names that are AgentBase instances or subclasses.
|
|
135
201
|
*/
|
|
136
202
|
export async function listAgents(agentPath) {
|
|
137
|
-
|
|
138
|
-
const agents = [];
|
|
139
|
-
for (const key of Object.keys(mod)) {
|
|
140
|
-
if (isAgentInstance(mod[key]) || isAgentClass(mod[key]) || isSWMLServiceInstance(mod[key])) {
|
|
141
|
-
agents.push(key);
|
|
142
|
-
}
|
|
143
|
-
}
|
|
144
|
-
return agents;
|
|
203
|
+
return (await describeAgents(agentPath)).map((a) => a.name);
|
|
145
204
|
}
|
|
146
205
|
//# sourceMappingURL=agent-loader.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"agent-loader.js","sourceRoot":"","sources":["../../src/cli/agent-loader.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"agent-loader.js","sourceRoot":"","sources":["../../src/cli/agent-loader.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAE3D,iDAAiD;AACjD,MAAM,kBAAkB,GAAG,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAEnE,SAAS,eAAe,CAAC,GAAY;IACnC,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAClD,MAAM,CAAC,GAAG,GAA8B,CAAC;IACzC,OAAO,CACL,OAAO,CAAC,CAAC,YAAY,CAAC,KAAK,UAAU;QACrC,OAAO,CAAC,CAAC,YAAY,CAAC,KAAK,UAAU;QACrC,OAAO,CAAC,CAAC,WAAW,CAAC,KAAK,UAAU,CACrC,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,GAAY;IAChC,IAAI,OAAO,GAAG,KAAK,UAAU;QAAE,OAAO,KAAK,CAAC;IAC5C,MAAM,KAAK,GAAI,GAA+C,CAAC,SAAS,CAAC;IACzE,IAAI,CAAC,KAAK;QAAE,OAAO,KAAK,CAAC;IACzB,OAAO,CACL,OAAO,KAAK,CAAC,YAAY,CAAC,KAAK,UAAU;QACzC,OAAO,KAAK,CAAC,YAAY,CAAC,KAAK,UAAU;QACzC,OAAO,KAAK,CAAC,WAAW,CAAC,KAAK,UAAU,CACzC,CAAC;AACJ,CAAC;AAED,SAAS,qBAAqB,CAAC,GAAY;IACzC,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAClD,MAAM,CAAC,GAAG,GAA8B,CAAC;IACzC,kEAAkE;IAClE,yDAAyD;IACzD,OAAO,CACL,OAAO,CAAC,CAAC,YAAY,CAAC,KAAK,UAAU;QACrC,OAAO,CAAC,CAAC,QAAQ,CAAC,KAAK,UAAU;QACjC,OAAO,CAAC,CAAC,SAAS,CAAC,KAAK,UAAU;QAClC,OAAO,CAAC,CAAC,WAAW,CAAC,KAAK,UAAU,CACrC,CAAC;AACJ,CAAC;AAED,MAAM,SAAS,GAAG,CAAC,GAAY,EAAE,EAAE,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,qBAAqB,CAAC,GAAG,CAAC,CAAC;AAQvF;;;;;GAKG;AACH,KAAK,UAAU,YAAY,CAAC,SAAiB;IAC3C,MAAM,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IACnC,MAAM,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,CAAC;IAC3C,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;QACjC,MAAM,IAAI,KAAK,CACb,+BAA+B,GAAG,qBAAqB,OAAO,IAAI;YAChE,QAAQ,CAAC,GAAG,kBAAkB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAClE,CAAC;IACJ,CAAC;IACD,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC;IAE5C,sEAAsE;IACtE,8EAA8E;IAC9E,mEAAmE;IACnE,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IACnD,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,GAAG,MAAM,CAAC;IACvC,sBAAsB,EAAE,CAAC;IACzB,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,CAAC,MAAM,MAAM,CAAC,OAAO,CAAC,CAA4B,CAAC;QACnE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,sBAAsB,EAAE,EAAE,CAAC;IAC5D,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,gCAAgC,OAAO,KAAK,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;IACrF,CAAC;YAAS,CAAC;QACT,IAAI,YAAY,KAAK,SAAS;YAAE,OAAO,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;;YAChE,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,GAAG,YAAY,CAAC;IACpD,CAAC;AACH,CAAC;AAQD,MAAM,OAAO,GAAG,CAAC,GAAY,EAAsB,EAAE,CAAE,GAAiC,EAAE,KAAK,CAAC;AAEhG,+CAA+C;AAC/C,MAAM,SAAS,GAAG,CAAC,CAAqB,EAAE,CAAS,EAAE,EAAE,CACrD,CAAC,KAAK,SAAS,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,CAAC;AAEvF;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,SAAiB,EACjB,UAAmB,EACnB,OAAyB,EAAE;IAE3B,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,MAAM,YAAY,CAAC,SAAS,CAAC,CAAC;IAEpE,wCAAwC;IACxC,IAAI,UAAU,EAAE,CAAC;QACf,MAAM,MAAM,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC;QAC/B,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,WAAW,UAAU,kBAAkB,SAAS,EAAE,CAAC,CAAC;QACtE,CAAC;QACD,IAAI,SAAS,CAAC,MAAM,CAAC;YAAE,OAAO,MAAM,CAAC;QACrC,IAAI,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC;YACzB,MAAM,GAAG,GAAG,MAAiD,CAAC;YAC9D,OAAO,IAAI,GAAG,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QACrD,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,WAAW,UAAU,yCAAyC,CAAC,CAAC;IAClF,CAAC;IAED,4DAA4D;IAC5D,MAAM,UAAU,GAAc,EAAE,CAAC;IACjC,KAAK,MAAM,KAAK,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,GAAG,WAAW,CAAC,EAAE,CAAC;QAC5D,IAAI,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC;YAAE,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC9E,CAAC;IAED,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,KAAM,CAAC,CAAC,CAAC;QACzE,IAAI,KAAK;YAAE,OAAO,KAAK,CAAC;QACxB,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;YACvC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC;gBAAE,SAAS;YACnC,MAAM,QAAQ,GAAG,IAAK,KAA8C,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;YAC5F,IAAI,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC;gBAAE,OAAO,QAAQ,CAAC;QAChE,CAAC;QACD,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACvD,MAAM,IAAI,KAAK,CACb,gCAAgC,IAAI,CAAC,KAAK,GAAG;YAC3C,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,uBAAuB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CACpE,CAAC;IACJ,CAAC;IAED,0BAA0B;IAC1B,IAAI,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAAE,OAAO,GAAG,CAAC,OAAO,CAAC,CAAC;IAEvD,+BAA+B;IAC/B,IAAI,eAAe,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAAE,OAAO,GAAG,CAAC,SAAS,CAAC,CAAC;IAE3D,qCAAqC;IACrC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACnC,IAAI,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAAE,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC;IACjD,CAAC;IAED,0CAA0C;IAC1C,IAAI,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;QACjC,MAAM,GAAG,GAAG,GAAG,CAAC,SAAS,CAA4C,CAAC;QACtE,OAAO,IAAI,GAAG,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;IACxC,CAAC;IAED,qCAAqC;IACrC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACnC,IAAI,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;YAC3B,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAA4C,CAAC;YAChE,OAAO,IAAI,GAAG,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;QACxC,CAAC;IACH,CAAC;IAED,6BAA6B;IAC7B,IAAI,qBAAqB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAAE,OAAO,GAAG,CAAC,OAAO,CAAC,CAAC;IAC7D,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACnC,IAAI,qBAAqB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAAE,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC;IACvD,CAAC;IAED,yDAAyD;IACzD,MAAM,UAAU,GAAG,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACjD,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC;IAClD,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CACb,8BAA8B,OAAO,CAAC,SAAS,CAAC,8BAA8B;YAC5E,qBAAqB,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC5D,CAAC;IACJ,CAAC;IAED,MAAM,IAAI,KAAK,CACb,0DAA0D,OAAO,CAAC,SAAS,CAAC,KAAK;QAC/E,sFAAsF,CACzF,CAAC;AACJ,CAAC;AAcD;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,SAAiB;IACpD,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,MAAM,YAAY,CAAC,SAAS,CAAC,CAAC;IACpE,MAAM,GAAG,GAAuB,EAAE,CAAC;IACnC,MAAM,IAAI,GAAG,IAAI,GAAG,EAAW,CAAC;IAChC,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAE,KAAc,EAAE,EAAE;QAChD,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,KAA0C,CAAC;QAC9E,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;QACvD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAClB,CAAC,CAAC;IACF,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/C,IAAI,SAAS,CAAC,KAAK,CAAC;YAAE,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;aACtC,IAAI,YAAY,CAAC,KAAK,CAAC;YAAE,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IACD,KAAK,MAAM,KAAK,IAAI,WAAW,EAAE,CAAC;QAChC,IAAI,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YACzC,QAAQ,CAAE,KAA2B,CAAC,IAAI,IAAI,SAAS,EAAE,KAAK,CAAC,CAAC;QAClE,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,SAAiB;IAChD,OAAO,CAAC,MAAM,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AAC9D,CAAC"}
|
|
@@ -0,0 +1,175 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* DataMap execution for swaig-test: runs a DataMap function locally the way
|
|
3
|
+
* the platform runs it (mod_openai's actions.c and swaig.c), so
|
|
4
|
+
* `swaig-test --exec` can test one without a call.
|
|
5
|
+
*
|
|
6
|
+
* The pipeline, as the platform processes a data_map:
|
|
7
|
+
*
|
|
8
|
+
* 1. The top-level `expressions`, against the call data. The first one that
|
|
9
|
+
* produces an output ends the function.
|
|
10
|
+
* 2. The first webhook it requests. A webhook in a list is skipped, without a
|
|
11
|
+
* request, when none of its `require_args` is among the arguments, when it
|
|
12
|
+
* has neither `output` nor `expressions`, or when it has no `url`. Once one
|
|
13
|
+
* is requested, no later webhook runs. It fails when the response has
|
|
14
|
+
* `parse_error` or `protocol_error` (a body that is empty or isn't JSON, a
|
|
15
|
+
* request that doesn't complete) or one of its `error_keys`, whatever the
|
|
16
|
+
* key's value. A status outside 200-299 doesn't fail it by itself; the
|
|
17
|
+
* status is then in the response as `http_code`. If it succeeds, its
|
|
18
|
+
* `foreach`, then its `expressions`, then its `output` build the result
|
|
19
|
+
* from the response. A matched webhook expression's result is expanded a
|
|
20
|
+
* second time, against the same data.
|
|
21
|
+
* 3. The data_map's own `output`, when nothing above produced a result.
|
|
22
|
+
* 4. Otherwise the platform's generic error,
|
|
23
|
+
* `{ response: "There was an error processing this request." }`.
|
|
24
|
+
*
|
|
25
|
+
* `expressions` can be one expression object instead of a list. `webhooks`
|
|
26
|
+
* can be one webhook object, which the platform runs without checking its
|
|
27
|
+
* `require_args` or its errors, so its `foreach`, `expressions` and `output`
|
|
28
|
+
* read an error response (`${parse_error}`, `${raw_response}`,
|
|
29
|
+
* `${http_code}`).
|
|
30
|
+
*
|
|
31
|
+
* The request is a POST when the webhook has `params` (its JSON body, with
|
|
32
|
+
* the arguments merged in by `input_args_as_params`) or its method is POST,
|
|
33
|
+
* and a GET otherwise. Header values are sent as written. Credentials in the
|
|
34
|
+
* url become basic authentication. Redirects are followed as the platform's
|
|
35
|
+
* curl follows them, and every request, redirects included, refuses private
|
|
36
|
+
* and internal addresses.
|
|
37
|
+
*
|
|
38
|
+
* Template data, per stage:
|
|
39
|
+
*
|
|
40
|
+
* - The call data: the `callData` option (the platform's call details, such
|
|
41
|
+
* as `global_data` or `caller_id_num`) at the root, `meta_data` (the
|
|
42
|
+
* function's `meta_data` merged key by key over `global_data`, as the
|
|
43
|
+
* platform merges them when it loads the function), the `prompt_vars`
|
|
44
|
+
* merged into the root, `args` (the arguments) and an empty `input`. The
|
|
45
|
+
* top-level expressions, a webhook's `url` and `params`, and the data_map's
|
|
46
|
+
* own `output` read it, so they write an argument as `${args.city}`. The
|
|
47
|
+
* data_map's own `output` also has `prompt_vars`.
|
|
48
|
+
* - A webhook's `foreach`, `expressions` and `output` read its response: a
|
|
49
|
+
* JSON object's fields at the root (`${current.temp_f}`), a JSON array under
|
|
50
|
+
* `array`, with `prompt_vars`, `global_data` and `input` (a copy of the call
|
|
51
|
+
* data) added. The arguments are `${input.args.city}` there.
|
|
52
|
+
*
|
|
53
|
+
* Templates: `${path}` and `%{path}` read a path of dotted names, matched
|
|
54
|
+
* without regard to ASCII case, each with at most one `[n]` index (negative
|
|
55
|
+
* from the end). The helpers `lc:`, `enc:` and `fmt_ph:` come first, in any
|
|
56
|
+
* case, and apply in a fixed order: `fmt_ph`, then `lc`, then `enc`. Any other
|
|
57
|
+
* name before a colon is part of the path. A template nested in the path
|
|
58
|
+
* expands first, one level deep. A value that isn't a string is inserted as
|
|
59
|
+
* cJSON prints it (72.5 as `72.500000`). A path that doesn't resolve expands
|
|
60
|
+
* to an empty string, and the simulator says so on stderr. An output is
|
|
61
|
+
* expanded as JSON text and parsed, as on the platform, so a template that
|
|
62
|
+
* inserts an object into a string breaks it.
|
|
63
|
+
*
|
|
64
|
+
* Where the simulator can't do what the platform does:
|
|
65
|
+
*
|
|
66
|
+
* - Without the optional libphonenumber-js package, `fmt_ph` formats only a
|
|
67
|
+
* North American number, as `(NPA) NXX-XXXX`, and leaves any other value as
|
|
68
|
+
* it is, saying so on stderr. The platform formats any valid number, and
|
|
69
|
+
* writes `INVALID NUMBER` for one that isn't; with libphonenumber-js
|
|
70
|
+
* installed, so does the simulator. Either way, it reads a vanity number's
|
|
71
|
+
* letters as keypad digits, as the platform's libphonenumber does.
|
|
72
|
+
* - `@{...}` functions are left as they are.
|
|
73
|
+
* - An expression's `expr` isn't evaluated: only its `pattern` is tried.
|
|
74
|
+
* - Patterns are JavaScript regular expressions, where the platform uses PCRE.
|
|
75
|
+
* - The platform follows no redirect for a request it signs; the simulator
|
|
76
|
+
* doesn't sign requests.
|
|
77
|
+
*
|
|
78
|
+
* Mirrors signalwire-python's `signalwire.cli.execution.datamap_exec`.
|
|
79
|
+
*/
|
|
80
|
+
/** The result the platform returns when nothing produced an output. */
|
|
81
|
+
export declare const PLATFORM_ERROR_RESPONSE = "There was an error processing this request.";
|
|
82
|
+
type Data = Record<string, unknown>;
|
|
83
|
+
/** The part of libphonenumber-js that `fmt_ph` uses. */
|
|
84
|
+
export interface _PhoneNumbers {
|
|
85
|
+
parsePhoneNumberFromString(text: string, defaultCountry: string): {
|
|
86
|
+
isValid(): boolean;
|
|
87
|
+
formatNational(): string;
|
|
88
|
+
} | undefined;
|
|
89
|
+
}
|
|
90
|
+
/**
|
|
91
|
+
* Replace the libphonenumber-js that `fmt_ph` uses, for tests: null simulates
|
|
92
|
+
* a project without it.
|
|
93
|
+
*
|
|
94
|
+
* @param lib - The library, or null for none.
|
|
95
|
+
* @returns The one it replaced.
|
|
96
|
+
* @internal
|
|
97
|
+
*/
|
|
98
|
+
export declare function _setPhoneNumbers(lib: _PhoneNumbers | null): _PhoneNumbers | null;
|
|
99
|
+
/**
|
|
100
|
+
* Expand DataMap templates in a string as the platform does: `${path}` and
|
|
101
|
+
* `%{path}` read a value from `data`, names matched without regard to case,
|
|
102
|
+
* with the `lc:`, `enc:` and `fmt_ph:` helpers. A path that doesn't resolve
|
|
103
|
+
* expands to an empty string. A template nested in a path expands first, one
|
|
104
|
+
* level deep, and a value that isn't a string is inserted as cJSON prints it.
|
|
105
|
+
* `@{...}` functions are left as they are.
|
|
106
|
+
*
|
|
107
|
+
* @param template - Text with `${...}` or `%{...}` templates.
|
|
108
|
+
* @param data - The template data.
|
|
109
|
+
* @returns The expanded text.
|
|
110
|
+
*/
|
|
111
|
+
export declare function expandTemplate(template: string, data: Data): string;
|
|
112
|
+
/**
|
|
113
|
+
* Expand the templates in a value (an output object, say) as the platform
|
|
114
|
+
* does: printed as JSON text, expanded with `"` and `\` in string values
|
|
115
|
+
* escaped, and parsed again. A template that inserts an object or array
|
|
116
|
+
* into a string breaks the JSON.
|
|
117
|
+
*
|
|
118
|
+
* @param value - The value to expand.
|
|
119
|
+
* @param data - The template data.
|
|
120
|
+
* @returns The expanded value, or undefined when the expanded text isn't JSON.
|
|
121
|
+
*/
|
|
122
|
+
export declare function expandValue(value: unknown, data: Data): unknown;
|
|
123
|
+
/** The fetch {@link executeDataMap} sends a webhook request with. */
|
|
124
|
+
export type DataMapFetch = (url: string, init: {
|
|
125
|
+
method: string;
|
|
126
|
+
headers: Record<string, string>;
|
|
127
|
+
body?: string;
|
|
128
|
+
signal?: AbortSignal;
|
|
129
|
+
/**
|
|
130
|
+
* Report each response's status as it arrives, redirects included, so a
|
|
131
|
+
* request that fails after a redirect reports the last status received
|
|
132
|
+
* as `http_code`, as the platform's curl does.
|
|
133
|
+
*/
|
|
134
|
+
onStatus?: (status: number) => void;
|
|
135
|
+
}) => Promise<Response>;
|
|
136
|
+
/** Options for {@link executeDataMap}. */
|
|
137
|
+
export interface DataMapExecOptions {
|
|
138
|
+
/** Print each step to `log`. */
|
|
139
|
+
verbose?: boolean;
|
|
140
|
+
/** Seconds to wait for each webhook, body included (default 120, the platform's). */
|
|
141
|
+
timeoutSeconds?: number;
|
|
142
|
+
/** Where verbose output and notes go (default: stderr). */
|
|
143
|
+
log?: (line: string) => void;
|
|
144
|
+
/**
|
|
145
|
+
* The call data the platform adds, merged into the root of the template
|
|
146
|
+
* data: `global_data`, `caller_id_num`, `call_id` and so on. Its
|
|
147
|
+
* `prompt_vars` are merged into the root too, and are also
|
|
148
|
+
* `${prompt_vars.x}` in a webhook's stages and the data_map's own output.
|
|
149
|
+
* Its `global_data` is also the base of `meta_data`, which the function's
|
|
150
|
+
* `meta_data` is merged over; a `meta_data` key here isn't used, since the
|
|
151
|
+
* platform doesn't take one from the call. swaig-test passes
|
|
152
|
+
* `--custom-data`, with the agent's global data when it has no
|
|
153
|
+
* `global_data`.
|
|
154
|
+
*/
|
|
155
|
+
callData?: Data;
|
|
156
|
+
/**
|
|
157
|
+
* Fetch implementation; defaults to the SDK's SSRF-guarded fetch, which
|
|
158
|
+
* follows redirects as the platform's curl does and checks every hop.
|
|
159
|
+
*/
|
|
160
|
+
fetchImpl?: DataMapFetch;
|
|
161
|
+
}
|
|
162
|
+
/**
|
|
163
|
+
* Run a DataMap function locally, as the platform runs it.
|
|
164
|
+
*
|
|
165
|
+
* @param fn - The function's SWAIG entry (`{ function, data_map, meta_data, ... }`)
|
|
166
|
+
* or its `data_map` alone.
|
|
167
|
+
* @param args - The function's arguments.
|
|
168
|
+
* @param opts - Verbose output, the call data, and the fetch to use.
|
|
169
|
+
* @returns The function's result: the expanded output (an object or a
|
|
170
|
+
* string), `{ response: PLATFORM_ERROR_RESPONSE }` when nothing produced a
|
|
171
|
+
* result, as on the platform, or an `{ error }` object when the expanded
|
|
172
|
+
* output isn't JSON, where the platform gets no result.
|
|
173
|
+
*/
|
|
174
|
+
export declare function executeDataMap(fn: Data, args: Data, opts?: DataMapExecOptions): Promise<unknown>;
|
|
175
|
+
export {};
|