@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,410 @@
|
|
|
1
|
+
# Third-Party Skills Integration Guide
|
|
2
|
+
|
|
3
|
+
This guide explains how to write a skill outside the SDK and load it into a SignalWire AI Agents TypeScript agent. You can register the class in code, publish it as an npm package, or have the registry import it from a directory.
|
|
4
|
+
|
|
5
|
+
For the full skills reference (built-in skills, lifecycle, registry API), see the
|
|
6
|
+
[Skills System Guide](skills-guide.md).
|
|
7
|
+
|
|
8
|
+
The examples on this page assume this shared context:
|
|
9
|
+
|
|
10
|
+
<!-- snippet-setup -->
|
|
11
|
+
```ts
|
|
12
|
+
export {}; // treat each example as a module so top-level `await` is allowed
|
|
13
|
+
declare global {
|
|
14
|
+
// Shared context the fragments on this page assume.
|
|
15
|
+
const agent: import('@signalwire/sdk').AgentBase;
|
|
16
|
+
const SkillBase: typeof import('@signalwire/sdk').SkillBase;
|
|
17
|
+
const FunctionResult: typeof import('@signalwire/sdk').FunctionResult;
|
|
18
|
+
// Illustrative third-party skill class defined in the first example on this page.
|
|
19
|
+
const WeatherSkill: any;
|
|
20
|
+
}
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Overview
|
|
24
|
+
|
|
25
|
+
A third-party skill loads in one of three ways:
|
|
26
|
+
|
|
27
|
+
1. **Direct registration**: import the class and register it with `registerSkill()`, or pass an instance to `agent.addSkill()`.
|
|
28
|
+
2. **Directory discovery**: point the registry at a directory, and it imports the modules there and registers the skill classes they export.
|
|
29
|
+
3. **Environment variable**: list discovery directories in `SIGNALWIRE_SKILL_PATHS`.
|
|
30
|
+
|
|
31
|
+
Discovery (methods 2 and 3) runs the code of every module it imports, so it's off unless `SWML_SKILL_DISCOVERY_ENABLED` is `true`. A registered third-party skill appears in `listSkillsWithParams()` with its parameter schema, like a built-in one.
|
|
32
|
+
|
|
33
|
+
## Creating a Third-Party Skill
|
|
34
|
+
|
|
35
|
+
A third-party skill extends `SkillBase`, like the built-in skills. It sets its metadata as static fields, declares its parameters, implements `getTools()`, and can implement `setup()`, `_getPromptSections()`, `getHints()` and `getGlobalData()`. This skill reads its key from `api_key` or `WEATHER_API_KEY`:
|
|
36
|
+
|
|
37
|
+
```typescript
|
|
38
|
+
// my-weather-skill/skill.ts
|
|
39
|
+
import {
|
|
40
|
+
SkillBase,
|
|
41
|
+
FunctionResult,
|
|
42
|
+
type SkillToolDefinition,
|
|
43
|
+
type ParameterSchemaEntry,
|
|
44
|
+
} from '@signalwire/sdk';
|
|
45
|
+
|
|
46
|
+
export class WeatherSkill extends SkillBase {
|
|
47
|
+
static override SKILL_NAME = 'weather';
|
|
48
|
+
static override SKILL_DESCRIPTION = 'Get weather information for any location';
|
|
49
|
+
static override SKILL_VERSION = '1.0.0';
|
|
50
|
+
|
|
51
|
+
private apiKey?: string;
|
|
52
|
+
private units = 'celsius';
|
|
53
|
+
|
|
54
|
+
static override getParameterSchema(): Record<string, ParameterSchemaEntry> {
|
|
55
|
+
return {
|
|
56
|
+
...super.getParameterSchema(),
|
|
57
|
+
api_key: {
|
|
58
|
+
type: 'string',
|
|
59
|
+
description: 'Weather API key',
|
|
60
|
+
required: true,
|
|
61
|
+
hidden: true,
|
|
62
|
+
env_var: 'WEATHER_API_KEY',
|
|
63
|
+
},
|
|
64
|
+
units: {
|
|
65
|
+
type: 'string',
|
|
66
|
+
description: 'Temperature units',
|
|
67
|
+
default: 'celsius',
|
|
68
|
+
required: false,
|
|
69
|
+
enum: ['celsius', 'fahrenheit', 'kelvin'],
|
|
70
|
+
},
|
|
71
|
+
cache_timeout: {
|
|
72
|
+
type: 'integer',
|
|
73
|
+
description: 'Cache timeout in seconds',
|
|
74
|
+
default: 300,
|
|
75
|
+
required: false,
|
|
76
|
+
min: 0,
|
|
77
|
+
max: 3600,
|
|
78
|
+
},
|
|
79
|
+
};
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
// Runs when the skill is added. Returning false refuses the skill.
|
|
83
|
+
override async setup(): Promise<boolean> {
|
|
84
|
+
this.apiKey = this.getConfig<string | undefined>('api_key') ?? process.env['WEATHER_API_KEY'];
|
|
85
|
+
this.units = this.getConfig<string>('units', 'celsius');
|
|
86
|
+
if (!this.apiKey) {
|
|
87
|
+
this.logger.error('api_key or WEATHER_API_KEY is required');
|
|
88
|
+
return false;
|
|
89
|
+
}
|
|
90
|
+
return true;
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
override getTools(): SkillToolDefinition[] {
|
|
94
|
+
return [
|
|
95
|
+
{
|
|
96
|
+
name: 'get_weather',
|
|
97
|
+
description: 'Get current weather for a location.',
|
|
98
|
+
parameters: {
|
|
99
|
+
location: { type: 'string', description: 'City name or coordinates' },
|
|
100
|
+
},
|
|
101
|
+
required: ['location'],
|
|
102
|
+
handler: (args) => {
|
|
103
|
+
const location = String(args.location ?? '').trim();
|
|
104
|
+
if (!location) {
|
|
105
|
+
return new FunctionResult('Ask the caller which location they want the weather for.');
|
|
106
|
+
}
|
|
107
|
+
// Call the weather API with this.apiKey here.
|
|
108
|
+
const unit = this.units[0]!.toUpperCase();
|
|
109
|
+
return new FunctionResult(`The weather in ${location} is sunny and 22 degrees ${unit}.`);
|
|
110
|
+
},
|
|
111
|
+
},
|
|
112
|
+
];
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
The skill checks the key in `setup()` instead of listing `WEATHER_API_KEY` in `REQUIRED_ENV_VARS`. A variable in `REQUIRED_ENV_VARS` must be set even when the caller passes `api_key`, so the skill wouldn't load without it.
|
|
118
|
+
|
|
119
|
+
## Integration Methods
|
|
120
|
+
|
|
121
|
+
### Method 1: Direct Registration
|
|
122
|
+
|
|
123
|
+
Register the class with the global registry, then add it to any agent by name:
|
|
124
|
+
|
|
125
|
+
<!-- snippet: no-run illustrative fragment: references the assumed `WeatherSkill` class defined in the surrounding prose -->
|
|
126
|
+
```typescript
|
|
127
|
+
import { AgentBase, registerSkill } from '@signalwire/sdk';
|
|
128
|
+
// import { WeatherSkill } from './my-weather-skill/skill.js';
|
|
129
|
+
|
|
130
|
+
registerSkill(WeatherSkill);
|
|
131
|
+
|
|
132
|
+
const agent = new AgentBase({ name: 'my-agent' });
|
|
133
|
+
await agent.addSkillByName('weather', { api_key: 'your-api-key', units: 'fahrenheit' });
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
`registerSkill()` throws when the class has no `SKILL_NAME`, or when its schema is empty. When the name belongs to a built-in skill and `registerBuiltinSkills()` has run, the name is locked. The call then logs `Cannot overwrite locked skill` and keeps the built-in class, so choose a name no built-in skill uses.
|
|
137
|
+
|
|
138
|
+
You can also skip the registry and add an instance:
|
|
139
|
+
|
|
140
|
+
```typescript
|
|
141
|
+
await agent.addSkill(new WeatherSkill({ api_key: 'your-api-key', units: 'fahrenheit' }));
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
### Method 2: Directory Discovery
|
|
145
|
+
|
|
146
|
+
Discovery imports skill modules from a directory and registers the classes they export. Set `SWML_SKILL_DISCOVERY_ENABLED=true` before you use it, because without it, discovery logs a warning and registers nothing:
|
|
147
|
+
|
|
148
|
+
```bash
|
|
149
|
+
export SWML_SKILL_DISCOVERY_ENABLED=true
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
In the directory, discovery imports every `.ts` and `.js` file except `.d.ts` files, and the `skill.ts` file of each subdirectory, or its `skill.js` when there's no `skill.ts`. It registers every exported class that extends `SkillBase` and sets `SKILL_NAME`. A module that exports only a factory function registers nothing. This example discovers the skills in one directory:
|
|
153
|
+
|
|
154
|
+
<!-- snippet: no-run needs a real directory of skill modules and SWML_SKILL_DISCOVERY_ENABLED=true -->
|
|
155
|
+
```typescript
|
|
156
|
+
import { SkillRegistry } from '@signalwire/sdk';
|
|
157
|
+
|
|
158
|
+
// Directory layout:
|
|
159
|
+
// /opt/custom-skills/
|
|
160
|
+
// stock-market.js exports class StockMarketSkill (SKILL_NAME 'stock_market')
|
|
161
|
+
// weather/skill.ts exports class WeatherSkill (SKILL_NAME 'weather')
|
|
162
|
+
|
|
163
|
+
const registry = SkillRegistry.getInstance();
|
|
164
|
+
const discovered = await registry.discoverFromDirectory('/opt/custom-skills');
|
|
165
|
+
console.log(discovered); // the SKILL_NAME of each class it registered
|
|
166
|
+
|
|
167
|
+
await agent.addSkillByName('weather', { api_key: process.env['WEATHER_API_KEY'] });
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
A module that fails to import is skipped, with a debug-level log entry. The top-level `addSkillDirectory(path)`, and `addSkillDirectory(path)` on the registry, add a directory that `discoverAll()` scans. The registry method throws if the path isn't a directory.
|
|
171
|
+
|
|
172
|
+
Discovery runs each module's code with your process's permissions. Point it only at directories that nobody else can write to.
|
|
173
|
+
|
|
174
|
+
### Method 3: Environment Variable
|
|
175
|
+
|
|
176
|
+
`SIGNALWIRE_SKILL_PATHS` holds colon-separated directories. The registry reads it once, when it's first created, and adds them to its search paths:
|
|
177
|
+
|
|
178
|
+
```bash
|
|
179
|
+
export SWML_SKILL_DISCOVERY_ENABLED=true
|
|
180
|
+
|
|
181
|
+
# One directory
|
|
182
|
+
export SIGNALWIRE_SKILL_PATHS=/opt/my-skills
|
|
183
|
+
|
|
184
|
+
# Several directories, separated by colons
|
|
185
|
+
export SIGNALWIRE_SKILL_PATHS=/opt/my-skills:/home/user/custom-skills
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
Nothing scans the paths for you. Call `discoverAll()`, which runs `discoverFromDirectory()` on each search path:
|
|
189
|
+
|
|
190
|
+
<!-- snippet: no-run needs real skill directories and SWML_SKILL_DISCOVERY_ENABLED=true -->
|
|
191
|
+
```typescript
|
|
192
|
+
import { SkillRegistry } from '@signalwire/sdk';
|
|
193
|
+
|
|
194
|
+
await SkillRegistry.getInstance().discoverAll();
|
|
195
|
+
await agent.addSkillByName('weather', { api_key: process.env['WEATHER_API_KEY'] });
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
## Skill Discovery and Schema
|
|
199
|
+
|
|
200
|
+
The top-level helpers list every registered skill, third-party ones included:
|
|
201
|
+
|
|
202
|
+
<!-- snippet: no-run illustrative fragment: references the assumed `WeatherSkill` class defined in the surrounding prose -->
|
|
203
|
+
```typescript
|
|
204
|
+
import { listSkills, listSkillsWithParams, registerSkill } from '@signalwire/sdk';
|
|
205
|
+
|
|
206
|
+
registerSkill(WeatherSkill);
|
|
207
|
+
|
|
208
|
+
// Metadata and schema for every registered skill, as an array
|
|
209
|
+
const skills = listSkills();
|
|
210
|
+
|
|
211
|
+
// The same entries, keyed by skill name
|
|
212
|
+
const allSkills = listSkillsWithParams();
|
|
213
|
+
console.log(allSkills['weather']?.parameters['units']);
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
The last line prints the `units` entry from the skill's schema:
|
|
217
|
+
|
|
218
|
+
```text
|
|
219
|
+
{
|
|
220
|
+
type: 'string',
|
|
221
|
+
description: 'Temperature units',
|
|
222
|
+
default: 'celsius',
|
|
223
|
+
required: false,
|
|
224
|
+
enum: [ 'celsius', 'fahrenheit', 'kelvin' ]
|
|
225
|
+
}
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
Each entry also has `name`, `description`, `version`, `supportsMultipleInstances`, `requiredEnvVars` and `requiredPackages`.
|
|
229
|
+
|
|
230
|
+
## Best Practices
|
|
231
|
+
|
|
232
|
+
These practices help a skill work in other people's agents.
|
|
233
|
+
|
|
234
|
+
### 1. Skill Naming
|
|
235
|
+
|
|
236
|
+
Follow these rules for `SKILL_NAME`:
|
|
237
|
+
|
|
238
|
+
- Use lowercase words separated by underscores, such as `stock_market`.
|
|
239
|
+
- Choose a name no built-in skill uses. A locked built-in name can't be replaced.
|
|
240
|
+
- Keep tool names distinct too. When two skills register the same tool name, the one added later replaces the other's tool.
|
|
241
|
+
|
|
242
|
+
### 2. Parameter Design
|
|
243
|
+
|
|
244
|
+
Follow these rules for the parameter schema:
|
|
245
|
+
|
|
246
|
+
- Implement `getParameterSchema()` and spread `super.getParameterSchema()`.
|
|
247
|
+
- Mark keys and passwords as `hidden`.
|
|
248
|
+
- Give each optional parameter a default that works.
|
|
249
|
+
- Use `env_var` to name the environment variable a configuration tool can read a parameter from. The SDK doesn't read it, so read the variable in your code if the skill should fall back to it.
|
|
250
|
+
|
|
251
|
+
For the schema format, see [Skills Parameter Schema](skills_parameter_schema.md).
|
|
252
|
+
|
|
253
|
+
### 3. Error Handling
|
|
254
|
+
|
|
255
|
+
Check the configuration in `setup()`, and return `false` when the skill can't work. The agent then refuses the skill with an error, instead of offering the model a tool that fails:
|
|
256
|
+
|
|
257
|
+
<!-- snippet: no-compile illustrative bare method fragment (class body context) -->
|
|
258
|
+
```typescript
|
|
259
|
+
override async setup(): Promise<boolean> {
|
|
260
|
+
this.apiKey = this.getConfig<string | undefined>('api_key') ?? process.env['MY_API_KEY'];
|
|
261
|
+
if (!this.apiKey) {
|
|
262
|
+
this.logger.error('api_key or MY_API_KEY is required');
|
|
263
|
+
return false;
|
|
264
|
+
}
|
|
265
|
+
return true;
|
|
266
|
+
}
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
In a handler, return a result that tells the model what happened, instead of throwing:
|
|
270
|
+
|
|
271
|
+
<!-- snippet: no-compile illustrative tool-handler fragment (references skill instance `this`) -->
|
|
272
|
+
```typescript
|
|
273
|
+
// Inside a tool handler
|
|
274
|
+
handler: async (args) => {
|
|
275
|
+
const url = `https://weather.example.com/current?q=${encodeURIComponent(String(args.location))}`;
|
|
276
|
+
try {
|
|
277
|
+
const response = await fetch(url);
|
|
278
|
+
return new FunctionResult(await response.text());
|
|
279
|
+
} catch {
|
|
280
|
+
return new FunctionResult('The weather service is unavailable. Offer to try again later.');
|
|
281
|
+
}
|
|
282
|
+
}
|
|
283
|
+
```
|
|
284
|
+
|
|
285
|
+
## Advanced Features
|
|
286
|
+
|
|
287
|
+
### Dynamic Tool Names
|
|
288
|
+
|
|
289
|
+
Read the tool name from the configuration, so an agent can name the tool for its own prompt. This `getTools()` does that:
|
|
290
|
+
|
|
291
|
+
<!-- snippet: no-compile illustrative bare method fragment (class body context) -->
|
|
292
|
+
```typescript
|
|
293
|
+
override getTools(): SkillToolDefinition[] {
|
|
294
|
+
const toolName = this.getConfig<string>('tool_name', 'get_weather');
|
|
295
|
+
const service = this.getConfig<string>('service', 'default');
|
|
296
|
+
return [
|
|
297
|
+
{
|
|
298
|
+
name: toolName,
|
|
299
|
+
description: `Get weather using ${service}`,
|
|
300
|
+
parameters: {
|
|
301
|
+
location: { type: 'string', description: 'City name or coordinates' },
|
|
302
|
+
},
|
|
303
|
+
required: ['location'],
|
|
304
|
+
handler: (args) => this.handleWeather(args),
|
|
305
|
+
},
|
|
306
|
+
];
|
|
307
|
+
}
|
|
308
|
+
```
|
|
309
|
+
|
|
310
|
+
To add the skill more than once with different tool names, also set `static SUPPORTS_MULTIPLE_INSTANCES = true`. The default instance key then includes `tool_name`.
|
|
311
|
+
|
|
312
|
+
### Skill Dependencies
|
|
313
|
+
|
|
314
|
+
A skill's `agent` property is set before `setup()` runs, so `setup()` can check for another skill. The other skill must be added first:
|
|
315
|
+
|
|
316
|
+
<!-- snippet: no-compile illustrative bare method fragment (class body context) -->
|
|
317
|
+
```typescript
|
|
318
|
+
override async setup(): Promise<boolean> {
|
|
319
|
+
if (!this.agent?.hasSkill('translation')) {
|
|
320
|
+
this.logger.error('Add the translation skill before this one');
|
|
321
|
+
return false;
|
|
322
|
+
}
|
|
323
|
+
return true;
|
|
324
|
+
}
|
|
325
|
+
```
|
|
326
|
+
|
|
327
|
+
## Testing Third-Party Skills
|
|
328
|
+
|
|
329
|
+
Test a skill with [Vitest](https://vitest.dev/) before you publish it. This test registers the skill, adds it to an agent and checks its schema:
|
|
330
|
+
|
|
331
|
+
<!-- snippet: no-compile Vitest test file (imports a local skill module + uses vitest globals) -->
|
|
332
|
+
```typescript
|
|
333
|
+
// tests/weather-skill.test.ts
|
|
334
|
+
import { AgentBase, registerSkill } from '@signalwire/sdk';
|
|
335
|
+
import { WeatherSkill } from '../my-weather-skill/skill.js';
|
|
336
|
+
|
|
337
|
+
describe('WeatherSkill', () => {
|
|
338
|
+
it('registers and adds to an agent', async () => {
|
|
339
|
+
registerSkill(WeatherSkill);
|
|
340
|
+
const agent = new AgentBase({ name: 'test-agent' });
|
|
341
|
+
await agent.addSkillByName('weather', { api_key: 'test-key' });
|
|
342
|
+
expect(agent.hasSkill('weather')).toBe(true);
|
|
343
|
+
});
|
|
344
|
+
|
|
345
|
+
it('declares a parameter schema', () => {
|
|
346
|
+
const schema = WeatherSkill.getParameterSchema();
|
|
347
|
+
expect(schema['api_key']?.required).toBe(true);
|
|
348
|
+
expect(schema['api_key']?.hidden).toBe(true);
|
|
349
|
+
});
|
|
350
|
+
});
|
|
351
|
+
```
|
|
352
|
+
|
|
353
|
+
To call a tool without a server, run the `swaig-test` CLI on an agent file that adds the skill. These commands list the agent's tools, then call `get_weather`:
|
|
354
|
+
|
|
355
|
+
```bash
|
|
356
|
+
npx swaig-test my-agent.ts --list-tools
|
|
357
|
+
npx swaig-test my-agent.ts --exec get_weather --location "San Francisco"
|
|
358
|
+
```
|
|
359
|
+
|
|
360
|
+
Everything after `--exec get_weather` is an argument to the function, so put any of the CLI's own options before `--exec`. For the options, see the [CLI Guide](cli-guide.md).
|
|
361
|
+
|
|
362
|
+
## Troubleshooting
|
|
363
|
+
|
|
364
|
+
### Skill Not Found
|
|
365
|
+
|
|
366
|
+
`addSkillByName()` rejects with `skill not found in registry` when the name isn't registered. Check these causes in order:
|
|
367
|
+
|
|
368
|
+
1. For discovery, `SWML_SKILL_DISCOVERY_ENABLED` must be `true`. Without it, the registry logs `Skill directory discovery is disabled`.
|
|
369
|
+
2. Discovery must run: call `discoverFromDirectory()` or `discoverAll()`, or register the class with `registerSkill()`.
|
|
370
|
+
3. The module must export the class itself, not only a factory, and the class must set `SKILL_NAME`.
|
|
371
|
+
4. A class in a subdirectory must be in `skill.ts`, or in `skill.js` for a compiled package. Other files in a subdirectory aren't imported.
|
|
372
|
+
5. The name you pass to `addSkillByName()` must equal `SKILL_NAME`.
|
|
373
|
+
6. A module that fails to import is skipped with a debug-level log entry. Set `SIGNALWIRE_LOG_LEVEL=debug` to see it.
|
|
374
|
+
|
|
375
|
+
This check prints the search paths and the registered names:
|
|
376
|
+
|
|
377
|
+
```typescript
|
|
378
|
+
import { SkillRegistry } from '@signalwire/sdk';
|
|
379
|
+
|
|
380
|
+
const registry = SkillRegistry.getInstance();
|
|
381
|
+
console.log('Search paths:', registry.getSearchPaths());
|
|
382
|
+
console.log('Registered skills:', registry.listRegistered());
|
|
383
|
+
```
|
|
384
|
+
|
|
385
|
+
### Skill Not Loaded
|
|
386
|
+
|
|
387
|
+
When the name is registered but `addSkill()` or `addSkillByName()` still rejects, the error names the cause:
|
|
388
|
+
|
|
389
|
+
- `missing environment variables`: a variable in `REQUIRED_ENV_VARS` isn't set.
|
|
390
|
+
- `missing required packages`: a package in `REQUIRED_PACKAGES` doesn't import.
|
|
391
|
+
- `Failed to setup skill`: `setup()` returned `false`. The skill's own log entry says why.
|
|
392
|
+
- `already loaded and does not support multiple instances`: the skill was added twice.
|
|
393
|
+
|
|
394
|
+
## Distributing a Skill Package
|
|
395
|
+
|
|
396
|
+
Publish the skill as an npm package that exports the skill class. Consumers import it and register it:
|
|
397
|
+
|
|
398
|
+
<!-- snippet: no-compile imports an illustrative third-party npm package that is not installed -->
|
|
399
|
+
```typescript
|
|
400
|
+
import { AgentBase, registerSkill } from '@signalwire/sdk';
|
|
401
|
+
import { WeatherSkill } from 'my-signalwire-skills';
|
|
402
|
+
|
|
403
|
+
registerSkill(WeatherSkill);
|
|
404
|
+
|
|
405
|
+
const agent = new AgentBase({ name: 'my-agent' });
|
|
406
|
+
await agent.addSkillByName('weather', { api_key: process.env['WEATHER_API_KEY'] });
|
|
407
|
+
await agent.run();
|
|
408
|
+
```
|
|
409
|
+
|
|
410
|
+
Declare `@signalwire/sdk` as a peer dependency of the package, so the skill extends the same `SkillBase` class the consumer's agent uses. Directory discovery registers only a class that extends that `SkillBase`, and a copy of the SDK in the skill package's own `node_modules` is a different class.
|