@signalwire/sdk 2.0.5 → 3.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (659) hide show
  1. package/CHANGELOG.md +821 -0
  2. package/LICENSE +21 -0
  3. package/README.md +163 -68
  4. package/dist/AGENTS.md +13 -0
  5. package/dist/AgentBase.d.ts +510 -126
  6. package/dist/AgentBase.js +1581 -455
  7. package/dist/AgentBase.js.map +1 -1
  8. package/dist/AgentServer.d.ts +21 -0
  9. package/dist/AgentServer.js +154 -47
  10. package/dist/AgentServer.js.map +1 -1
  11. package/dist/AuthHandler.d.ts +14 -2
  12. package/dist/AuthHandler.js +7 -2
  13. package/dist/AuthHandler.js.map +1 -1
  14. package/dist/ConfigLoader.d.ts +5 -13
  15. package/dist/ConfigLoader.js +15 -29
  16. package/dist/ConfigLoader.js.map +1 -1
  17. package/dist/ContextBuilder.d.ts +202 -9
  18. package/dist/ContextBuilder.js +219 -36
  19. package/dist/ContextBuilder.js.map +1 -1
  20. package/dist/DataMap.d.ts +186 -45
  21. package/dist/DataMap.js +210 -52
  22. package/dist/DataMap.js.map +1 -1
  23. package/dist/FunctionResult.d.ts +309 -83
  24. package/dist/FunctionResult.js +483 -116
  25. package/dist/FunctionResult.js.map +1 -1
  26. package/dist/Logger.d.ts +30 -5
  27. package/dist/Logger.js +77 -19
  28. package/dist/Logger.js.map +1 -1
  29. package/dist/POM/PromptObjectModel.d.ts +12 -1
  30. package/dist/POM/PromptObjectModel.js +25 -9
  31. package/dist/POM/PromptObjectModel.js.map +1 -1
  32. package/dist/ParameterSchema.d.ts +306 -0
  33. package/dist/ParameterSchema.js +251 -0
  34. package/dist/ParameterSchema.js.map +1 -0
  35. package/dist/PlatformContracts.d.ts +21 -0
  36. package/dist/PlatformContracts.generated.d.ts +109 -0
  37. package/dist/PlatformContracts.generated.js +8 -0
  38. package/dist/PlatformContracts.generated.js.map +1 -0
  39. package/dist/PlatformContracts.js +2 -0
  40. package/dist/PlatformContracts.js.map +1 -0
  41. package/dist/PomBuilder.d.ts +18 -0
  42. package/dist/PomBuilder.js +53 -3
  43. package/dist/PomBuilder.js.map +1 -1
  44. package/dist/PostPrompt.d.ts +110 -0
  45. package/dist/PostPrompt.js +204 -0
  46. package/dist/PostPrompt.js.map +1 -0
  47. package/dist/PromptManager.d.ts +22 -1
  48. package/dist/PromptManager.js +28 -1
  49. package/dist/PromptManager.js.map +1 -1
  50. package/dist/PublicFetch.d.ts +132 -0
  51. package/dist/PublicFetch.js +311 -0
  52. package/dist/PublicFetch.js.map +1 -0
  53. package/dist/RobotsTxt.d.ts +41 -0
  54. package/dist/RobotsTxt.js +152 -0
  55. package/dist/RobotsTxt.js.map +1 -0
  56. package/dist/SWMLHandler.js.map +1 -1
  57. package/dist/SWMLService.d.ts +169 -59
  58. package/dist/SWMLService.js +456 -129
  59. package/dist/SWMLService.js.map +1 -1
  60. package/dist/SchemaUtils.d.ts +115 -2
  61. package/dist/SchemaUtils.js +444 -12
  62. package/dist/SchemaUtils.js.map +1 -1
  63. package/dist/SecurityUtils.d.ts +49 -9
  64. package/dist/SecurityUtils.js +153 -51
  65. package/dist/SecurityUtils.js.map +1 -1
  66. package/dist/SemanticGate.d.ts +183 -0
  67. package/dist/SemanticGate.js +533 -0
  68. package/dist/SemanticGate.js.map +1 -0
  69. package/dist/ServerlessAdapter.d.ts +156 -7
  70. package/dist/ServerlessAdapter.js +399 -42
  71. package/dist/ServerlessAdapter.js.map +1 -1
  72. package/dist/SessionManager.d.ts +11 -2
  73. package/dist/SessionManager.js +50 -18
  74. package/dist/SessionManager.js.map +1 -1
  75. package/dist/SslConfig.d.ts +2 -1
  76. package/dist/SslConfig.js +4 -1
  77. package/dist/SslConfig.js.map +1 -1
  78. package/dist/SwaigActions.generated.d.ts +23 -0
  79. package/dist/SwaigActions.generated.js +8 -0
  80. package/dist/SwaigActions.generated.js.map +1 -0
  81. package/dist/SwaigContracts.d.ts +15 -0
  82. package/dist/SwaigContracts.generated.d.ts +264 -0
  83. package/dist/SwaigContracts.generated.js +12 -0
  84. package/dist/SwaigContracts.generated.js.map +1 -0
  85. package/dist/SwaigContracts.js +2 -0
  86. package/dist/SwaigContracts.js.map +1 -0
  87. package/dist/SwaigFunction.d.ts +139 -7
  88. package/dist/SwaigFunction.js +170 -22
  89. package/dist/SwaigFunction.js.map +1 -1
  90. package/dist/SwmlBuilder.d.ts +68 -19
  91. package/dist/SwmlBuilder.js +74 -38
  92. package/dist/SwmlBuilder.js.map +1 -1
  93. package/dist/SwmlVerbMethods.generated.d.ts +41 -4
  94. package/dist/SwmlVerbMethods.generated.js +1 -1
  95. package/dist/TypeInference.d.ts +39 -3
  96. package/dist/TypeInference.js +256 -16
  97. package/dist/TypeInference.js.map +1 -1
  98. package/dist/WebService.d.ts +79 -11
  99. package/dist/WebService.js +320 -109
  100. package/dist/WebService.js.map +1 -1
  101. package/dist/WebhookMiddleware.d.ts +119 -0
  102. package/dist/WebhookMiddleware.js +271 -0
  103. package/dist/WebhookMiddleware.js.map +1 -0
  104. package/dist/WebhookValidator.d.ts +92 -0
  105. package/dist/WebhookValidator.js +409 -0
  106. package/dist/WebhookValidator.js.map +1 -0
  107. package/dist/agents/BedrockAgent.d.ts +162 -0
  108. package/dist/agents/BedrockAgent.js +323 -0
  109. package/dist/agents/BedrockAgent.js.map +1 -0
  110. package/dist/ai-chat/AIChatClient.d.ts +316 -0
  111. package/dist/ai-chat/AIChatClient.js +535 -0
  112. package/dist/ai-chat/AIChatClient.js.map +1 -0
  113. package/dist/ai-chat/ChatGateway.d.ts +408 -0
  114. package/dist/ai-chat/ChatGateway.js +747 -0
  115. package/dist/ai-chat/ChatGateway.js.map +1 -0
  116. package/dist/ai-chat/HandoffRouter.d.ts +282 -0
  117. package/dist/ai-chat/HandoffRouter.js +518 -0
  118. package/dist/ai-chat/HandoffRouter.js.map +1 -0
  119. package/dist/ai-chat/index.d.ts +12 -0
  120. package/dist/ai-chat/index.js +10 -0
  121. package/dist/ai-chat/index.js.map +1 -0
  122. package/dist/capabilities.d.ts +64 -0
  123. package/dist/capabilities.js +95 -0
  124. package/dist/capabilities.js.map +1 -0
  125. package/dist/cli/agent-loader.d.ts +32 -6
  126. package/dist/cli/agent-loader.js +92 -33
  127. package/dist/cli/agent-loader.js.map +1 -1
  128. package/dist/cli/datamap-exec.d.ts +175 -0
  129. package/dist/cli/datamap-exec.js +1284 -0
  130. package/dist/cli/datamap-exec.js.map +1 -0
  131. package/dist/cli/function-args.d.ts +40 -0
  132. package/dist/cli/function-args.js +146 -0
  133. package/dist/cli/function-args.js.map +1 -0
  134. package/dist/cli/simulation.d.ts +99 -0
  135. package/dist/cli/simulation.js +490 -0
  136. package/dist/cli/simulation.js.map +1 -0
  137. package/dist/cli/swaig-test.d.ts +12 -25
  138. package/dist/cli/swaig-test.js +935 -371
  139. package/dist/cli/swaig-test.js.map +1 -1
  140. package/dist/cli/tsdocs/agentsNote.d.ts +30 -0
  141. package/dist/cli/tsdocs/agentsNote.js +92 -0
  142. package/dist/cli/tsdocs/agentsNote.js.map +1 -0
  143. package/dist/cli/tsdocs/api-index.json +1 -0
  144. package/dist/cli/tsdocs/api.d.ts +91 -0
  145. package/dist/cli/tsdocs/api.js +372 -0
  146. package/dist/cli/tsdocs/api.js.map +1 -0
  147. package/dist/cli/tsdocs/apiTypes.d.ts +64 -0
  148. package/dist/cli/tsdocs/apiTypes.js +7 -0
  149. package/dist/cli/tsdocs/apiTypes.js.map +1 -0
  150. package/dist/cli/tsdocs/bin.d.ts +6 -0
  151. package/dist/cli/tsdocs/bin.js +23 -0
  152. package/dist/cli/tsdocs/bin.js.map +1 -0
  153. package/dist/cli/tsdocs/files.d.ts +108 -0
  154. package/dist/cli/tsdocs/files.js +287 -0
  155. package/dist/cli/tsdocs/files.js.map +1 -0
  156. package/dist/cli/tsdocs/index.d.ts +28 -0
  157. package/dist/cli/tsdocs/index.js +307 -0
  158. package/dist/cli/tsdocs/index.js.map +1 -0
  159. package/dist/cli/tsdocs/live.d.ts +41 -0
  160. package/dist/cli/tsdocs/live.js +202 -0
  161. package/dist/cli/tsdocs/live.js.map +1 -0
  162. package/dist/cli/tsdocs/locate.d.ts +51 -0
  163. package/dist/cli/tsdocs/locate.js +75 -0
  164. package/dist/cli/tsdocs/locate.js.map +1 -0
  165. package/dist/cli/tsdocs/render.d.ts +75 -0
  166. package/dist/cli/tsdocs/render.js +323 -0
  167. package/dist/cli/tsdocs/render.js.map +1 -0
  168. package/dist/cli/tsdocs/topics.d.ts +43 -0
  169. package/dist/cli/tsdocs/topics.js +920 -0
  170. package/dist/cli/tsdocs/topics.js.map +1 -0
  171. package/dist/index.d.ts +49 -68
  172. package/dist/index.js +45 -73
  173. package/dist/index.js.map +1 -1
  174. package/dist/livewire/index.d.ts +229 -155
  175. package/dist/livewire/index.js +298 -195
  176. package/dist/livewire/index.js.map +1 -1
  177. package/dist/llms.txt +65 -0
  178. package/dist/prefabs/CallSessionStore.d.ts +52 -0
  179. package/dist/prefabs/CallSessionStore.js +72 -0
  180. package/dist/prefabs/CallSessionStore.js.map +1 -0
  181. package/dist/prefabs/ConciergeAgent.d.ts +13 -1
  182. package/dist/prefabs/ConciergeAgent.js +36 -31
  183. package/dist/prefabs/ConciergeAgent.js.map +1 -1
  184. package/dist/prefabs/FAQBotAgent.d.ts +9 -1
  185. package/dist/prefabs/FAQBotAgent.js +113 -47
  186. package/dist/prefabs/FAQBotAgent.js.map +1 -1
  187. package/dist/prefabs/InfoGathererAgent.d.ts +22 -3
  188. package/dist/prefabs/InfoGathererAgent.js +67 -58
  189. package/dist/prefabs/InfoGathererAgent.js.map +1 -1
  190. package/dist/prefabs/ReceptionistAgent.d.ts +16 -5
  191. package/dist/prefabs/ReceptionistAgent.js +39 -31
  192. package/dist/prefabs/ReceptionistAgent.js.map +1 -1
  193. package/dist/prefabs/SurveyAgent.d.ts +22 -4
  194. package/dist/prefabs/SurveyAgent.js +84 -68
  195. package/dist/prefabs/SurveyAgent.js.map +1 -1
  196. package/dist/relay/Action.d.ts +44 -21
  197. package/dist/relay/Action.js +75 -17
  198. package/dist/relay/Action.js.map +1 -1
  199. package/dist/relay/Call.d.ts +312 -47
  200. package/dist/relay/Call.js +369 -18
  201. package/dist/relay/Call.js.map +1 -1
  202. package/dist/relay/Deferred.js.map +1 -1
  203. package/dist/relay/Message.d.ts +26 -5
  204. package/dist/relay/Message.js +36 -6
  205. package/dist/relay/Message.js.map +1 -1
  206. package/dist/relay/RelayClient.d.ts +44 -17
  207. package/dist/relay/RelayClient.js +175 -65
  208. package/dist/relay/RelayClient.js.map +1 -1
  209. package/dist/relay/RelayError.d.ts +14 -0
  210. package/dist/relay/RelayError.js +15 -0
  211. package/dist/relay/RelayError.js.map +1 -1
  212. package/dist/relay/RelayEvent.d.ts +96 -65
  213. package/dist/relay/RelayEvent.js +85 -56
  214. package/dist/relay/RelayEvent.js.map +1 -1
  215. package/dist/relay/closedSets.d.ts +111 -0
  216. package/dist/relay/closedSets.js +83 -0
  217. package/dist/relay/closedSets.js.map +1 -0
  218. package/dist/relay/index.d.ts +3 -1
  219. package/dist/relay/index.js +1 -0
  220. package/dist/relay/index.js.map +1 -1
  221. package/dist/relay/normalize.js.map +1 -1
  222. package/dist/relay/protocol.types.generated.d.ts +1195 -0
  223. package/dist/relay/protocol.types.generated.js +8 -0
  224. package/dist/relay/protocol.types.generated.js.map +1 -0
  225. package/dist/relay/types.d.ts +73 -42
  226. package/dist/rest/HttpClient.d.ts +36 -8
  227. package/dist/rest/HttpClient.js +233 -40
  228. package/dist/rest/HttpClient.js.map +1 -1
  229. package/dist/rest/RequestOptions.d.ts +110 -0
  230. package/dist/rest/RequestOptions.js +113 -0
  231. package/dist/rest/RequestOptions.js.map +1 -0
  232. package/dist/rest/RestError.d.ts +52 -6
  233. package/dist/rest/RestError.js +89 -5
  234. package/dist/rest/RestError.js.map +1 -1
  235. package/dist/rest/base/CrudResource.d.ts +16 -26
  236. package/dist/rest/base/CrudResource.js +19 -33
  237. package/dist/rest/base/CrudResource.js.map +1 -1
  238. package/dist/rest/base/CrudWithAddresses.d.ts +3 -2
  239. package/dist/rest/base/CrudWithAddresses.js +2 -2
  240. package/dist/rest/base/CrudWithAddresses.js.map +1 -1
  241. package/dist/rest/base/FabricResource.d.ts +15 -0
  242. package/dist/rest/base/FabricResource.js +16 -0
  243. package/dist/rest/base/FabricResource.js.map +1 -0
  244. package/dist/rest/base/ReadResource.d.ts +62 -0
  245. package/dist/rest/base/ReadResource.js +69 -0
  246. package/dist/rest/base/ReadResource.js.map +1 -0
  247. package/dist/rest/callHandler.d.ts +5 -2
  248. package/dist/rest/callHandler.js +4 -1
  249. package/dist/rest/callHandler.js.map +1 -1
  250. package/dist/rest/index.d.ts +18 -77
  251. package/dist/rest/index.js +47 -120
  252. package/dist/rest/index.js.map +1 -1
  253. package/dist/rest/namespaces/_client_tree_generated.d.ts +103 -0
  254. package/dist/rest/namespaces/_client_tree_generated.js +171 -0
  255. package/dist/rest/namespaces/_client_tree_generated.js.map +1 -0
  256. package/dist/rest/namespaces/addresses.d.ts +3 -42
  257. package/dist/rest/namespaces/addresses.js +3 -50
  258. package/dist/rest/namespaces/addresses.js.map +1 -1
  259. package/dist/rest/namespaces/calling.d.ts +6 -378
  260. package/dist/rest/namespaces/calling.js +6 -473
  261. package/dist/rest/namespaces/calling.js.map +1 -1
  262. package/dist/rest/namespaces/calling.resources.generated.d.ts +165 -0
  263. package/dist/rest/namespaces/calling.resources.generated.js +477 -0
  264. package/dist/rest/namespaces/calling.resources.generated.js.map +1 -0
  265. package/dist/rest/namespaces/calling.types.generated.d.ts +2917 -0
  266. package/dist/rest/namespaces/calling.types.generated.js +8 -0
  267. package/dist/rest/namespaces/calling.types.generated.js.map +1 -0
  268. package/dist/rest/namespaces/chat.d.ts +4 -18
  269. package/dist/rest/namespaces/chat.js +4 -21
  270. package/dist/rest/namespaces/chat.js.map +1 -1
  271. package/dist/rest/namespaces/chat.resources.generated.d.ts +12 -0
  272. package/dist/rest/namespaces/chat.resources.generated.js +29 -0
  273. package/dist/rest/namespaces/chat.resources.generated.js.map +1 -0
  274. package/dist/rest/namespaces/chat.types.generated.d.ts +56 -0
  275. package/dist/rest/namespaces/chat.types.generated.js +8 -0
  276. package/dist/rest/namespaces/chat.types.generated.js.map +1 -0
  277. package/dist/rest/namespaces/datasphere.d.ts +6 -62
  278. package/dist/rest/namespaces/datasphere.js +6 -72
  279. package/dist/rest/namespaces/datasphere.js.map +1 -1
  280. package/dist/rest/namespaces/datasphere.resources.generated.d.ts +25 -0
  281. package/dist/rest/namespaces/datasphere.resources.generated.js +50 -0
  282. package/dist/rest/namespaces/datasphere.resources.generated.js.map +1 -0
  283. package/dist/rest/namespaces/datasphere.types.generated.d.ts +180 -0
  284. package/dist/rest/namespaces/datasphere.types.generated.js +8 -0
  285. package/dist/rest/namespaces/datasphere.types.generated.js.map +1 -0
  286. package/dist/rest/namespaces/fabric.d.ts +11 -327
  287. package/dist/rest/namespaces/fabric.js +14 -439
  288. package/dist/rest/namespaces/fabric.js.map +1 -1
  289. package/dist/rest/namespaces/fabric.resources.generated.d.ts +195 -0
  290. package/dist/rest/namespaces/fabric.resources.generated.js +399 -0
  291. package/dist/rest/namespaces/fabric.resources.generated.js.map +1 -0
  292. package/dist/rest/namespaces/fabric.types.generated.d.ts +4557 -0
  293. package/dist/rest/namespaces/fabric.types.generated.js +8 -0
  294. package/dist/rest/namespaces/fabric.types.generated.js.map +1 -0
  295. package/dist/rest/namespaces/fax.resources.generated.d.ts +6 -0
  296. package/dist/rest/namespaces/fax.resources.generated.js +14 -0
  297. package/dist/rest/namespaces/fax.resources.generated.js.map +1 -0
  298. package/dist/rest/namespaces/fax.types.generated.d.ts +131 -0
  299. package/dist/rest/namespaces/fax.types.generated.js +8 -0
  300. package/dist/rest/namespaces/fax.types.generated.js.map +1 -0
  301. package/dist/rest/namespaces/imported-numbers.d.ts +3 -18
  302. package/dist/rest/namespaces/imported-numbers.js +3 -21
  303. package/dist/rest/namespaces/imported-numbers.js.map +1 -1
  304. package/dist/rest/namespaces/logs.d.ts +10 -101
  305. package/dist/rest/namespaces/logs.js +10 -128
  306. package/dist/rest/namespaces/logs.js.map +1 -1
  307. package/dist/rest/namespaces/logs.resources.generated.d.ts +9 -0
  308. package/dist/rest/namespaces/logs.resources.generated.js +17 -0
  309. package/dist/rest/namespaces/logs.resources.generated.js.map +1 -0
  310. package/dist/rest/namespaces/logs.types.generated.d.ts +131 -0
  311. package/dist/rest/namespaces/logs.types.generated.js +8 -0
  312. package/dist/rest/namespaces/logs.types.generated.js.map +1 -0
  313. package/dist/rest/namespaces/lookup.d.ts +3 -25
  314. package/dist/rest/namespaces/lookup.js +3 -27
  315. package/dist/rest/namespaces/lookup.js.map +1 -1
  316. package/dist/rest/namespaces/message.resources.generated.d.ts +6 -0
  317. package/dist/rest/namespaces/message.resources.generated.js +14 -0
  318. package/dist/rest/namespaces/message.resources.generated.js.map +1 -0
  319. package/dist/rest/namespaces/message.types.generated.d.ts +122 -0
  320. package/dist/rest/namespaces/message.types.generated.js +8 -0
  321. package/dist/rest/namespaces/message.types.generated.js.map +1 -0
  322. package/dist/rest/namespaces/messages.resources.generated.d.ts +18 -0
  323. package/dist/rest/namespaces/messages.resources.generated.js +44 -0
  324. package/dist/rest/namespaces/messages.resources.generated.js.map +1 -0
  325. package/dist/rest/namespaces/messages.types.generated.d.ts +99 -0
  326. package/dist/rest/namespaces/messages.types.generated.js +8 -0
  327. package/dist/rest/namespaces/messages.types.generated.js.map +1 -0
  328. package/dist/rest/namespaces/mfa.d.ts +3 -42
  329. package/dist/rest/namespaces/mfa.js +3 -49
  330. package/dist/rest/namespaces/mfa.js.map +1 -1
  331. package/dist/rest/namespaces/number-groups.d.ts +3 -45
  332. package/dist/rest/namespaces/number-groups.js +3 -53
  333. package/dist/rest/namespaces/number-groups.js.map +1 -1
  334. package/dist/rest/namespaces/phone-numbers.d.ts +8 -196
  335. package/dist/rest/namespaces/phone-numbers.js +8 -230
  336. package/dist/rest/namespaces/phone-numbers.js.map +1 -1
  337. package/dist/rest/namespaces/project.d.ts +6 -42
  338. package/dist/rest/namespaces/project.js +6 -51
  339. package/dist/rest/namespaces/project.js.map +1 -1
  340. package/dist/rest/namespaces/project.resources.generated.d.ts +17 -0
  341. package/dist/rest/namespaces/project.resources.generated.js +44 -0
  342. package/dist/rest/namespaces/project.resources.generated.js.map +1 -0
  343. package/dist/rest/namespaces/project.types.generated.d.ts +58 -0
  344. package/dist/rest/namespaces/project.types.generated.js +8 -0
  345. package/dist/rest/namespaces/project.types.generated.js.map +1 -0
  346. package/dist/rest/namespaces/projects.resources.generated.d.ts +12 -0
  347. package/dist/rest/namespaces/projects.resources.generated.js +25 -0
  348. package/dist/rest/namespaces/projects.resources.generated.js.map +1 -0
  349. package/dist/rest/namespaces/projects.types.generated.d.ts +77 -0
  350. package/dist/rest/namespaces/projects.types.generated.js +8 -0
  351. package/dist/rest/namespaces/projects.types.generated.js.map +1 -0
  352. package/dist/rest/namespaces/pubsub.d.ts +4 -18
  353. package/dist/rest/namespaces/pubsub.js +4 -21
  354. package/dist/rest/namespaces/pubsub.js.map +1 -1
  355. package/dist/rest/namespaces/pubsub.resources.generated.d.ts +12 -0
  356. package/dist/rest/namespaces/pubsub.resources.generated.js +29 -0
  357. package/dist/rest/namespaces/pubsub.resources.generated.js.map +1 -0
  358. package/dist/rest/namespaces/pubsub.types.generated.d.ts +60 -0
  359. package/dist/rest/namespaces/pubsub.types.generated.js +8 -0
  360. package/dist/rest/namespaces/pubsub.types.generated.js.map +1 -0
  361. package/dist/rest/namespaces/queues.d.ts +3 -38
  362. package/dist/rest/namespaces/queues.js +3 -44
  363. package/dist/rest/namespaces/queues.js.map +1 -1
  364. package/dist/rest/namespaces/recordings.d.ts +3 -34
  365. package/dist/rest/namespaces/recordings.js +3 -40
  366. package/dist/rest/namespaces/recordings.js.map +1 -1
  367. package/dist/rest/namespaces/registry.d.ts +6 -137
  368. package/dist/rest/namespaces/registry.js +6 -173
  369. package/dist/rest/namespaces/registry.js.map +1 -1
  370. package/dist/rest/namespaces/relay-rest.resources.generated.d.ts +168 -0
  371. package/dist/rest/namespaces/relay-rest.resources.generated.js +430 -0
  372. package/dist/rest/namespaces/relay-rest.resources.generated.js.map +1 -0
  373. package/dist/rest/namespaces/relay-rest.types.generated.d.ts +1906 -0
  374. package/dist/rest/namespaces/relay-rest.types.generated.js +8 -0
  375. package/dist/rest/namespaces/relay-rest.types.generated.js.map +1 -0
  376. package/dist/rest/namespaces/short-codes.d.ts +3 -35
  377. package/dist/rest/namespaces/short-codes.js +3 -41
  378. package/dist/rest/namespaces/short-codes.js.map +1 -1
  379. package/dist/rest/namespaces/sip-profile.d.ts +3 -24
  380. package/dist/rest/namespaces/sip-profile.js +3 -29
  381. package/dist/rest/namespaces/sip-profile.js.map +1 -1
  382. package/dist/rest/namespaces/verified-callers.d.ts +3 -29
  383. package/dist/rest/namespaces/verified-callers.js +3 -34
  384. package/dist/rest/namespaces/verified-callers.js.map +1 -1
  385. package/dist/rest/namespaces/video.d.ts +10 -227
  386. package/dist/rest/namespaces/video.js +10 -288
  387. package/dist/rest/namespaces/video.js.map +1 -1
  388. package/dist/rest/namespaces/video.resources.generated.d.ts +81 -0
  389. package/dist/rest/namespaces/video.resources.generated.js +171 -0
  390. package/dist/rest/namespaces/video.resources.generated.js.map +1 -0
  391. package/dist/rest/namespaces/video.types.generated.d.ts +771 -0
  392. package/dist/rest/namespaces/video.types.generated.js +8 -0
  393. package/dist/rest/namespaces/video.types.generated.js.map +1 -0
  394. package/dist/rest/namespaces/voice.resources.generated.d.ts +9 -0
  395. package/dist/rest/namespaces/voice.resources.generated.js +17 -0
  396. package/dist/rest/namespaces/voice.resources.generated.js.map +1 -0
  397. package/dist/rest/namespaces/voice.types.generated.d.ts +214 -0
  398. package/dist/rest/namespaces/voice.types.generated.js +8 -0
  399. package/dist/rest/namespaces/voice.types.generated.js.map +1 -0
  400. package/dist/rest/pagination.d.ts +5 -1
  401. package/dist/rest/pagination.js +40 -20
  402. package/dist/rest/pagination.js.map +1 -1
  403. package/dist/rest/types.d.ts +21 -3
  404. package/dist/schema.json +299 -98
  405. package/dist/skills/SkillBase.d.ts +111 -21
  406. package/dist/skills/SkillBase.js +100 -17
  407. package/dist/skills/SkillBase.js.map +1 -1
  408. package/dist/skills/SkillManager.d.ts +66 -13
  409. package/dist/skills/SkillManager.js +101 -20
  410. package/dist/skills/SkillManager.js.map +1 -1
  411. package/dist/skills/SkillName.d.ts +44 -0
  412. package/dist/skills/SkillName.js +2 -0
  413. package/dist/skills/SkillName.js.map +1 -0
  414. package/dist/skills/SkillRegistry.d.ts +22 -11
  415. package/dist/skills/SkillRegistry.js +47 -17
  416. package/dist/skills/SkillRegistry.js.map +1 -1
  417. package/dist/skills/builtin/api_ninjas_trivia.d.ts +3 -1
  418. package/dist/skills/builtin/api_ninjas_trivia.js +18 -6
  419. package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -1
  420. package/dist/skills/builtin/ask_claude.d.ts +14 -4
  421. package/dist/skills/builtin/ask_claude.js +36 -14
  422. package/dist/skills/builtin/ask_claude.js.map +1 -1
  423. package/dist/skills/builtin/claude_skills.d.ts +3 -1
  424. package/dist/skills/builtin/claude_skills.js +19 -15
  425. package/dist/skills/builtin/claude_skills.js.map +1 -1
  426. package/dist/skills/builtin/custom_skills.d.ts +10 -3
  427. package/dist/skills/builtin/custom_skills.js +26 -9
  428. package/dist/skills/builtin/custom_skills.js.map +1 -1
  429. package/dist/skills/builtin/datasphere.d.ts +5 -3
  430. package/dist/skills/builtin/datasphere.js +21 -22
  431. package/dist/skills/builtin/datasphere.js.map +1 -1
  432. package/dist/skills/builtin/datasphere_serverless.d.ts +12 -1
  433. package/dist/skills/builtin/datasphere_serverless.js +17 -6
  434. package/dist/skills/builtin/datasphere_serverless.js.map +1 -1
  435. package/dist/skills/builtin/datetime.d.ts +3 -1
  436. package/dist/skills/builtin/datetime.js +11 -7
  437. package/dist/skills/builtin/datetime.js.map +1 -1
  438. package/dist/skills/builtin/google_maps.d.ts +29 -14
  439. package/dist/skills/builtin/google_maps.js +89 -269
  440. package/dist/skills/builtin/google_maps.js.map +1 -1
  441. package/dist/skills/builtin/index.d.ts +8 -6
  442. package/dist/skills/builtin/index.js +8 -6
  443. package/dist/skills/builtin/index.js.map +1 -1
  444. package/dist/skills/builtin/info_gatherer.d.ts +4 -2
  445. package/dist/skills/builtin/info_gatherer.js +20 -12
  446. package/dist/skills/builtin/info_gatherer.js.map +1 -1
  447. package/dist/skills/builtin/joke.d.ts +16 -6
  448. package/dist/skills/builtin/joke.js +54 -37
  449. package/dist/skills/builtin/joke.js.map +1 -1
  450. package/dist/skills/builtin/math.d.ts +3 -1
  451. package/dist/skills/builtin/math.js +14 -9
  452. package/dist/skills/builtin/math.js.map +1 -1
  453. package/dist/skills/builtin/mcp_gateway.d.ts +34 -5
  454. package/dist/skills/builtin/mcp_gateway.js +77 -46
  455. package/dist/skills/builtin/mcp_gateway.js.map +1 -1
  456. package/dist/skills/builtin/native_vector_search.d.ts +19 -5
  457. package/dist/skills/builtin/native_vector_search.js +179 -61
  458. package/dist/skills/builtin/native_vector_search.js.map +1 -1
  459. package/dist/skills/builtin/play_background_file.d.ts +21 -15
  460. package/dist/skills/builtin/play_background_file.js +43 -122
  461. package/dist/skills/builtin/play_background_file.js.map +1 -1
  462. package/dist/skills/builtin/spider.d.ts +42 -4
  463. package/dist/skills/builtin/spider.js +277 -104
  464. package/dist/skills/builtin/spider.js.map +1 -1
  465. package/dist/skills/builtin/swml_transfer.d.ts +14 -3
  466. package/dist/skills/builtin/swml_transfer.js +45 -24
  467. package/dist/skills/builtin/swml_transfer.js.map +1 -1
  468. package/dist/skills/builtin/weather_api.d.ts +24 -13
  469. package/dist/skills/builtin/weather_api.js +38 -30
  470. package/dist/skills/builtin/weather_api.js.map +1 -1
  471. package/dist/skills/builtin/web_search.d.ts +48 -10
  472. package/dist/skills/builtin/web_search.js +294 -100
  473. package/dist/skills/builtin/web_search.js.map +1 -1
  474. package/dist/skills/builtin/wikipedia_search.d.ts +4 -2
  475. package/dist/skills/builtin/wikipedia_search.js +14 -13
  476. package/dist/skills/builtin/wikipedia_search.js.map +1 -1
  477. package/dist/skills/index.d.ts +3 -2
  478. package/dist/skills/index.js +1 -1
  479. package/dist/skills/index.js.map +1 -1
  480. package/dist/swml_verbs_generated.d.ts +2824 -0
  481. package/dist/swml_verbs_generated.js +12 -0
  482. package/dist/swml_verbs_generated.js.map +1 -0
  483. package/dist/types.d.ts +59 -6
  484. package/dist/web.d.ts +27 -0
  485. package/dist/web.js +20 -0
  486. package/dist/web.js.map +1 -0
  487. package/docs/agent-guide.md +1034 -0
  488. package/docs/ai_chat.md +560 -0
  489. package/docs/api-reference.md +3641 -0
  490. package/docs/architecture.md +846 -0
  491. package/docs/bedrock_agent.md +411 -0
  492. package/docs/cli-guide.md +403 -0
  493. package/docs/cloud_functions_guide.md +399 -0
  494. package/docs/configuration.md +548 -0
  495. package/docs/contexts-guide.md +884 -0
  496. package/docs/datamap-guide.md +1207 -0
  497. package/docs/developer_pain_points.md +548 -0
  498. package/docs/llm_parameters.md +298 -0
  499. package/docs/mcp_gateway_reference.md +354 -0
  500. package/docs/mcp_integration.md +162 -0
  501. package/docs/pgi_agent_guide.md +1820 -0
  502. package/docs/prefabs-guide.md +815 -0
  503. package/docs/programmatically_governed_inference.md +301 -0
  504. package/docs/sdk_features.md +501 -0
  505. package/docs/security.md +559 -0
  506. package/docs/serverless-guide.md +520 -0
  507. package/docs/skills-guide.md +1223 -0
  508. package/docs/skills-system.md +405 -0
  509. package/docs/skills_parameter_schema.md +417 -0
  510. package/docs/swaig-reference.md +1986 -0
  511. package/docs/swml_service_guide.md +573 -0
  512. package/docs/third_party_skills.md +410 -0
  513. package/docs/web_service.md +666 -0
  514. package/examples/README.md +202 -0
  515. package/examples/advanced-datamap.ts +108 -0
  516. package/examples/advanced-dynamic-config.ts +70 -0
  517. package/examples/auto-vivified.ts +95 -0
  518. package/examples/call-flow.ts +65 -0
  519. package/examples/comprehensive-dynamic.ts +125 -0
  520. package/examples/contexts-steps.ts +65 -0
  521. package/examples/custom-path.ts +45 -0
  522. package/examples/datamap-tools.ts +51 -0
  523. package/examples/datasphere-multi-instance.ts +66 -0
  524. package/examples/datasphere-serverless-env.ts +87 -0
  525. package/examples/datasphere-webhook-env.ts +65 -0
  526. package/examples/datasphere.ts +56 -0
  527. package/examples/declarative.ts +100 -0
  528. package/examples/dynamic-config.ts +54 -0
  529. package/examples/dynamic-info-gatherer.ts +69 -0
  530. package/examples/dynamic-swml-service.ts +67 -0
  531. package/examples/gather-info.ts +95 -0
  532. package/examples/gather-per-question-functions-demo.ts +139 -0
  533. package/examples/joke-agent.ts +34 -0
  534. package/examples/kubernetes-agent.ts +45 -0
  535. package/examples/llm-params.ts +75 -0
  536. package/examples/mcp-agent.ts +89 -0
  537. package/examples/mcp-gateway.ts +81 -0
  538. package/examples/multi-agent.ts +80 -0
  539. package/examples/multi-endpoint.ts +79 -0
  540. package/examples/pgi/case-domain.ts +114 -0
  541. package/examples/pgi/serve.ts +16 -0
  542. package/examples/pgi/support-agent.ts +265 -0
  543. package/examples/pom-prompt.ts +70 -0
  544. package/examples/prefab-concierge.ts +42 -0
  545. package/examples/prefab-faq.ts +58 -0
  546. package/examples/prefab-info-gatherer.ts +33 -0
  547. package/examples/prefab-receptionist.ts +36 -0
  548. package/examples/prefab-survey.ts +69 -0
  549. package/examples/quickstart-agent.ts +29 -0
  550. package/examples/quickstart-relay.ts +25 -0
  551. package/examples/quickstart-rest.ts +25 -0
  552. package/examples/record-call.ts +65 -0
  553. package/examples/relay-demo.ts +33 -0
  554. package/examples/room-and-sip.ts +93 -0
  555. package/examples/serverless-lambda.ts +43 -0
  556. package/examples/session-state.ts +83 -0
  557. package/examples/simple-agent.ts +36 -0
  558. package/examples/simple-static.ts +29 -0
  559. package/examples/skills-demo.ts +41 -0
  560. package/examples/step-function-inheritance-demo.ts +124 -0
  561. package/examples/swaig-features.ts +193 -0
  562. package/examples/swml-service-routing.ts +66 -0
  563. package/examples/swml-service.ts +38 -0
  564. package/examples/swmlservice_ai_sidecar.ts +104 -0
  565. package/examples/swmlservice_swaig_standalone.ts +79 -0
  566. package/examples/tap.ts +67 -0
  567. package/examples/typed-tools.ts +68 -0
  568. package/examples/verb-methods.ts +45 -0
  569. package/examples/web-search-multi-instance.ts +75 -0
  570. package/examples/web-search.ts +38 -0
  571. package/examples/wikipedia.ts +36 -0
  572. package/livewire/README.md +164 -0
  573. package/livewire/docs/migration-guide.md +251 -0
  574. package/livewire/examples/livewire-basic-agent.ts +74 -0
  575. package/livewire/examples/livewire-handoff.ts +196 -0
  576. package/livewire/examples/livewire-multi-tool.ts +121 -0
  577. package/package.json +85 -13
  578. package/relay/README.md +101 -0
  579. package/relay/docs/call-methods.md +622 -0
  580. package/relay/docs/client-reference.md +281 -0
  581. package/relay/docs/events.md +193 -0
  582. package/relay/docs/getting-started.md +221 -0
  583. package/relay/docs/guide.md +386 -0
  584. package/relay/docs/messaging.md +246 -0
  585. package/relay/examples/relay-inbound.ts +66 -0
  586. package/relay/examples/relay-messaging.ts +74 -0
  587. package/relay/examples/relay-outbound.ts +76 -0
  588. package/rest/README.md +141 -0
  589. package/rest/docs/calling.md +313 -0
  590. package/rest/docs/client-reference.md +149 -0
  591. package/rest/docs/fabric.md +192 -0
  592. package/rest/docs/getting-started.md +138 -0
  593. package/rest/docs/guide.md +421 -0
  594. package/rest/docs/namespaces.md +367 -0
  595. package/rest/docs/phone-binding.md +116 -0
  596. package/rest/examples/rest-10dlc-registration.ts +177 -0
  597. package/rest/examples/rest-bind-phone-to-swml-webhook.ts +66 -0
  598. package/rest/examples/rest-calling-ivr-and-ai.ts +136 -0
  599. package/rest/examples/rest-calling-play-and-record.ts +98 -0
  600. package/rest/examples/rest-client.ts +59 -0
  601. package/rest/examples/rest-datasphere-search.ts +81 -0
  602. package/rest/examples/rest-fabric-conferences-and-routing.ts +147 -0
  603. package/rest/examples/rest-fabric-subscribers-and-sip.ts +106 -0
  604. package/rest/examples/rest-fabric-swml-and-callflows.ts +101 -0
  605. package/rest/examples/rest-manage-resources.ts +64 -0
  606. package/rest/examples/rest-phone-number-management.ts +200 -0
  607. package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
  608. package/rest/examples/rest-video-rooms.ts +186 -0
  609. package/tutorial/fred/fred.ts +218 -0
  610. package/tutorial/fred/tutorial/01-introduction.md +141 -0
  611. package/tutorial/fred/tutorial/02-setup.md +304 -0
  612. package/tutorial/fred/tutorial/03-basic-agent.md +284 -0
  613. package/tutorial/fred/tutorial/04-wikipedia-skill.md +298 -0
  614. package/tutorial/fred/tutorial/05-custom-functions.md +347 -0
  615. package/tutorial/fred/tutorial/06-running-testing.md +642 -0
  616. package/tutorial/fred/tutorial/README.md +56 -0
  617. package/tutorial/fred/tutorial/appendix-complete-code.md +632 -0
  618. package/tutorial/fred/tutorial/appendix-docker-deployment.md +504 -0
  619. package/tutorial/full-guardrails-agent/handlers.ts +436 -0
  620. package/tutorial/full-guardrails-agent/penny.ts +305 -0
  621. package/tutorial/full-guardrails-agent/reservations.ts +1109 -0
  622. package/tutorial/full-guardrails-agent/tutorial/01-why-guardrails.md +149 -0
  623. package/tutorial/full-guardrails-agent/tutorial/02-design-first.md +139 -0
  624. package/tutorial/full-guardrails-agent/tutorial/03-rules-first.md +422 -0
  625. package/tutorial/full-guardrails-agent/tutorial/04-the-shell.md +238 -0
  626. package/tutorial/full-guardrails-agent/tutorial/05-steps-and-scoping.md +247 -0
  627. package/tutorial/full-guardrails-agent/tutorial/06-tools-that-decide.md +467 -0
  628. package/tutorial/full-guardrails-agent/tutorial/07-gather-and-projection.md +160 -0
  629. package/tutorial/full-guardrails-agent/tutorial/08-the-verification-gate.md +333 -0
  630. package/tutorial/full-guardrails-agent/tutorial/09-people-and-endings.md +313 -0
  631. package/tutorial/full-guardrails-agent/tutorial/10-testing-and-running.md +387 -0
  632. package/tutorial/full-guardrails-agent/tutorial/README.md +106 -0
  633. package/tutorial/full-guardrails-agent/tutorial/appendix-complete-code.md +2207 -0
  634. package/tutorial/full-guardrails-agent/tutorial/appendix-deployment.md +191 -0
  635. package/tutorial/full-guardrails-agent/tutorial/appendix-technique-map.md +117 -0
  636. package/tutorial/full-guardrails-agent/workflow.ts +219 -0
  637. package/tutorial/multi_agents/README.md +175 -0
  638. package/tutorial/multi_agents/advanced_agent.ts +395 -0
  639. package/tutorial/multi_agents/extending_agents.ts +641 -0
  640. package/tutorial/multi_agents/knowledge.ts +59 -0
  641. package/tutorial/multi_agents/lesson1_first_agent.md +368 -0
  642. package/tutorial/multi_agents/lesson2_knowledge_bases.md +404 -0
  643. package/tutorial/multi_agents/lesson3_multi_agent_systems.md +621 -0
  644. package/tutorial/multi_agents/lesson4_advanced_features.md +805 -0
  645. package/tutorial/multi_agents/lesson5_extending_agents.md +856 -0
  646. package/tutorial/multi_agents/pc_builder.ts +529 -0
  647. package/tutorial/multi_agents/sales_agent.ts +88 -0
  648. package/tutorial/multi_agents/sales_agent_with_search.ts +116 -0
  649. package/tutorial/multi_agents/sales_knowledge.md +139 -0
  650. package/tutorial/multi_agents/support_knowledge.md +256 -0
  651. package/dist/cli/mock-data.d.ts +0 -37
  652. package/dist/cli/mock-data.js +0 -80
  653. package/dist/cli/mock-data.js.map +0 -1
  654. package/dist/generateVerbTypes.d.ts +0 -11
  655. package/dist/generateVerbTypes.js +0 -265
  656. package/dist/generateVerbTypes.js.map +0 -1
  657. package/dist/rest/namespaces/compat.d.ts +0 -585
  658. package/dist/rest/namespaces/compat.js +0 -735
  659. package/dist/rest/namespaces/compat.js.map +0 -1
@@ -0,0 +1,405 @@
1
+ # Skills System Reference
2
+
3
+ This page describes how the skills system in the SignalWire AI Agents TypeScript SDK is put together. It covers the classes, the order in which they run, and the security controls around loading code.
4
+
5
+ > **See also:** [skills-guide.md](skills-guide.md) for usage, the built-in skills and their parameters.
6
+
7
+ The examples on this page assume this shared context:
8
+
9
+ <!-- snippet-setup -->
10
+ ```ts
11
+ export {}; // treat each example as a module so top-level `await` is allowed
12
+ declare global {
13
+ // Shared context the fragments on this page assume.
14
+ const agent: import('@signalwire/sdk').AgentBase;
15
+ const SkillBase: typeof import('@signalwire/sdk').SkillBase;
16
+ const SkillRegistry: typeof import('@signalwire/sdk').SkillRegistry;
17
+ const FunctionResult: typeof import('@signalwire/sdk').FunctionResult;
18
+ // Illustrative custom skill classes referenced by the registry and usage examples.
19
+ // `any` because they are used both as a value to `register(...)` and constructed
20
+ // with `new`; the concrete subclass is defined in the examples on this page.
21
+ const MySkill: any;
22
+ const StockPriceSkill: any;
23
+ // Real built-in skill classes referenced by the multi-instance and schema examples.
24
+ const DataSphereSkill: typeof import('@signalwire/sdk').DataSphereSkill;
25
+ const WebSearchSkill: typeof import('@signalwire/sdk').WebSearchSkill;
26
+ }
27
+ ```
28
+
29
+ ---
30
+
31
+ ## Table of Contents
32
+
33
+ 1. [Architecture](#architecture)
34
+ 2. [SkillBase](#skillbase)
35
+ 3. [SkillManager](#skillmanager)
36
+ 4. [SkillRegistry](#skillregistry)
37
+ 5. [Tool Registration Flow](#tool-registration-flow)
38
+ 6. [Creating a Custom Skill](#creating-a-custom-skill)
39
+ 7. [Multi-Instance Skills](#multi-instance-skills)
40
+ 8. [Environment Validation](#environment-validation)
41
+ 9. [Parameter Schema Discovery](#parameter-schema-discovery)
42
+ 10. [Lifecycle Hooks](#lifecycle-hooks)
43
+ 11. [Security Controls](#security-controls)
44
+
45
+ ---
46
+
47
+ ## Architecture
48
+
49
+ Three classes make up the skills system. The registry is shared by the whole process, and each agent has its own manager:
50
+
51
+ ```text
52
+ SkillRegistry (one per process)
53
+ |
54
+ +-- maps skill names to SkillBase subclasses
55
+ |
56
+ +-- create(name, config) --> SkillBase instance
57
+ |
58
+ AgentBase.addSkill(instance) ------+
59
+ |
60
+ +-- SkillManager (one per agent): checks the skill, runs setup()
61
+ |
62
+ +-- AgentBase: registers the skill's tools, prompt sections, hints and global data
63
+ ```
64
+
65
+ Each class has one job:
66
+
67
+ | Component | Responsibility |
68
+ |---|---|
69
+ | **SkillBase** | Abstract base class every skill extends. Declares tools, prompt sections, hints, global data and the parameter schema. |
70
+ | **SkillManager** | One per `AgentBase`. Checks a skill, runs its `setup()`, and tracks the loaded instances. |
71
+ | **SkillRegistry** | Process-wide singleton. Maps skill names to skill classes for `agent.addSkillByName()`. |
72
+
73
+ ---
74
+
75
+ ## SkillBase
76
+
77
+ Every skill extends `SkillBase`. A skill sets `SKILL_NAME` and `SKILL_DESCRIPTION`, and the constructor throws when either is empty. This skill uses the main hooks:
78
+
79
+ ```typescript
80
+ import {
81
+ SkillBase,
82
+ FunctionResult,
83
+ type SkillToolDefinition,
84
+ type SkillPromptSection,
85
+ } from '@signalwire/sdk';
86
+
87
+ class MySkill extends SkillBase {
88
+ static override SKILL_NAME = 'my_skill';
89
+ static override SKILL_VERSION = '1.0.0';
90
+ static override SKILL_DESCRIPTION = 'Looks up account balances';
91
+ static override REQUIRED_ENV_VARS = ['MY_API_KEY'] as const;
92
+ static override SUPPORTS_MULTIPLE_INSTANCES = false;
93
+
94
+ override getTools(): SkillToolDefinition[] {
95
+ return [
96
+ {
97
+ name: 'get_balance',
98
+ description: 'Get the balance of an account',
99
+ parameters: { account: { type: 'string', description: 'Account number' } },
100
+ handler: (args: Record<string, unknown>) => {
101
+ return new FunctionResult(`Balance for account ${String(args.account)}: 42.00 USD`);
102
+ },
103
+ },
104
+ ];
105
+ }
106
+
107
+ override getHints(): string[] {
108
+ return ['balance', 'account'];
109
+ }
110
+
111
+ protected override _getPromptSections(): SkillPromptSection[] {
112
+ return [
113
+ {
114
+ title: 'Account Balances',
115
+ body: 'Use get_balance when the caller asks for an account balance.',
116
+ },
117
+ ];
118
+ }
119
+
120
+ override getGlobalData(): Record<string, unknown> {
121
+ return { balances_enabled: true };
122
+ }
123
+ }
124
+ ```
125
+
126
+ ### Key Methods
127
+
128
+ A skill overrides these methods:
129
+
130
+ | Method | Returns | Purpose |
131
+ |---|---|---|
132
+ | `getTools()` | `SkillToolDefinition[]` | The SWAIG tools the skill provides. The default returns the tools added with the protected `defineTool()`. |
133
+ | `getDataMapTools()` | `Record<string, unknown>[]` | Complete SWAIG function objects, such as the output of `DataMap.toSwaigFunction()` |
134
+ | `getHints()` | `string[]` | Speech recognition hints |
135
+ | `_getPromptSections()` | `SkillPromptSection[]` | Prompt sections. The public `getPromptSections()` returns them unless `skip_prompt` is `true`. |
136
+ | `getGlobalData()` | `Record<string, unknown>` | Keys merged into the agent's global data |
137
+ | `setup()` | `Promise<boolean>` | Async initialization. Return `false` to refuse the skill. |
138
+ | `cleanup()` | `Promise<void>` | Async teardown when the skill is removed |
139
+ | `getInstanceKey()` | `string` | Key that tells instances apart on one agent |
140
+
141
+ For the full list of members and helpers, see [SkillBase Members Reference](skills-guide.md#skillbase-members-reference).
142
+
143
+ ---
144
+
145
+ ## SkillManager
146
+
147
+ Each `AgentBase` has a `SkillManager`, available as `agent.skillManager`. When you call `agent.addSkill()`, the agent sets the skill's `agent` property and passes the skill to the manager. The manager checks it in this order, and throws at the first failure:
148
+
149
+ 1. A single-instance skill whose instance key is already loaded is refused. A multi-instance skill with a duplicate key is skipped with a warning.
150
+ 2. Every variable in `REQUIRED_ENV_VARS` must be set.
151
+ 3. `getParameterSchema()` must return a non-empty object.
152
+ 4. Every package in `REQUIRED_PACKAGES` must import.
153
+ 5. `setup()` must return `true`.
154
+
155
+ The manager then marks the skill initialized and records it. `AgentBase.addSkill()` registers the skill's tools, prompt sections, hints and global data on the agent.
156
+
157
+ These `SkillManager` methods are public:
158
+
159
+ | Method | Description |
160
+ |---|---|
161
+ | `addSkill(skill)` | Runs the checks and `setup()`, and records the skill. Throws on failure. |
162
+ | `loadSkill(SkillClass, config?)` | Constructs and adds a skill. On `agent.skillManager`, it also registers the skill on the agent, as `agent.addSkill()` does. Resolves to `[true, '']`, or `[false, message]` instead of throwing. |
163
+ | `loadSkillByName(name, config?)` | The same, looking the class up in the registry |
164
+ | `removeSkill(keyOrId)` | Calls `cleanup()` and removes one skill, by instance key or `instanceId` |
165
+ | `removeSkillByName(name)` | Removes every instance with that name, and resolves to how many it removed |
166
+ | `hasSkill(name)` / `hasSkillByKey(key)` | Whether a skill with that name, or that instance key, is loaded |
167
+ | `getSkill(keyOrId)` | The loaded instance, or `undefined` |
168
+ | `listSkills()` | Name, `instanceId` and initialization state of each loaded skill |
169
+ | `listSkillKeys()` | Instance keys of the loaded skills |
170
+ | `loadedSkills` | Read-only map of instance key to skill |
171
+ | `clear()` | Calls `cleanup()` on every loaded skill and removes them all |
172
+
173
+ `loadSkill()` and `loadSkillByName()` on `agent.skillManager` go through `agent.addSkill()`, so the skill's tools, prompt sections, hints and global data reach the agent, as with Python's `load_skill()`. `addSkill()` on the manager only checks, sets up and records the skill, and a standalone `new SkillManager()` has no agent to register on. This example lists what's loaded:
174
+
175
+ ```typescript
176
+ const skills = agent.listSkills(); // same as agent.skillManager.listSkills()
177
+ ```
178
+
179
+ A per-request copy of the agent, made for a dynamic config callback or `addPerCallConfig()`, starts with the skills the agent has loaded. It shares the instances without running `setup()` again. Adding one of those instances to the copy does nothing, and removing it from the copy doesn't call `cleanup()`.
180
+
181
+ ---
182
+
183
+ ## SkillRegistry
184
+
185
+ The registry is a process-wide singleton that maps each skill's `SKILL_NAME` to its class. This example reads what's registered:
186
+
187
+ ```typescript
188
+ import { SkillRegistry } from '@signalwire/sdk';
189
+
190
+ const registry = SkillRegistry.getInstance();
191
+
192
+ // Metadata and parameter schema for every registered skill
193
+ const available = registry.listSkills();
194
+
195
+ // One skill's metadata and schema, or undefined
196
+ const schema = registry.getSkillSchema('web_search');
197
+ ```
198
+
199
+ The registry starts empty. `registerBuiltinSkills()` registers the built-in skills. A custom class is registered with `register()`, or with the top-level `registerSkill()`, which calls it:
200
+
201
+ <!-- snippet: no-run illustrative fragment: references the assumed `SkillRegistry` from the page prelude (declared type-only in the shared snippet-setup), not a standalone program -->
202
+ ```typescript
203
+ SkillRegistry.getInstance().register(MySkill);
204
+ ```
205
+
206
+ `register()` throws when the class has no `SKILL_NAME`, or when its `getParameterSchema()` throws or returns an empty object. When the name is locked, it logs a warning and keeps the registered class. When the name is registered but not locked, it replaces the class and logs a warning.
207
+
208
+ These registry methods are public:
209
+
210
+ | Method | Description |
211
+ |---|---|
212
+ | `getInstance()` / `resetInstance()` | Get the singleton, or drop it (for tests) |
213
+ | `register(SkillClass)` | Register a class under its `SKILL_NAME` |
214
+ | `lock(names?)` | Stop `register()`, `unregister()` and `clear()` from replacing or removing these names, or every registered name when called with none |
215
+ | `unregister(name)` / `clear()` | Remove one registration, or all of them. A locked name stays registered, and `unregister()` returns `false` for it. |
216
+ | `create(name, config?)` | Construct a registered skill, or return `null` |
217
+ | `getSkillClass(name)` / `has(name)` | Look up a class, or check that a name is registered |
218
+ | `listRegistered()` | Registered names |
219
+ | `listSkills()` / `getSkillSchema(name)` / `getAllSkillsSchema()` | Metadata and parameter schemas |
220
+ | `addSearchPath(path)` / `getSearchPaths()` | Directories for `discoverAll()` |
221
+ | `discoverFromDirectory(path)` / `discoverAll()` | Import skill modules and register their classes. Off unless `SWML_SKILL_DISCOVERY_ENABLED` is `true`. |
222
+ | `size` | Number of registered skills |
223
+
224
+ `addSkillDirectory(path)` on the registry checks that the path is a directory, throws if it isn't, and records it in `getExternalPaths()`. `discoverAll()` scans those directories as well as the search paths. The top-level `addSkillDirectory()` function calls `addSearchPath()`, which doesn't check the path.
225
+
226
+ The top-level functions `listSkills()`, `listSkillsWithParams()`, `registerSkill()` and `addSkillDirectory()` call the singleton.
227
+
228
+ ---
229
+
230
+ ## Tool Registration Flow
231
+
232
+ This is what happens for one `addSkill()` call:
233
+
234
+ ```text
235
+ agent.addSkill(new WebSearchSkill({ num_results: 5 }))
236
+ |
237
+ +-- skill.setAgent(agent)
238
+ +-- SkillManager.addSkill(skill)
239
+ | +-- instance key check
240
+ | +-- REQUIRED_ENV_VARS check
241
+ | +-- parameter schema check
242
+ | +-- REQUIRED_PACKAGES check (cheerio)
243
+ | +-- await skill.setup() // web_search: are the credentials present?
244
+ | +-- skill.markInitialized()
245
+ |
246
+ +-- agent.defineTool(...) // each tool from getTools(), plus swaig_fields
247
+ +-- agent.registerSwaigFunction(...) // each object from getDataMapTools()
248
+ +-- agent.promptAddSection(...) // each section from getPromptSections()
249
+ +-- agent.addHints(...) // getHints()
250
+ +-- agent.updateGlobalData(...) // getGlobalData()
251
+ ```
252
+
253
+ ---
254
+
255
+ ## Creating a Custom Skill
256
+
257
+ Follow these steps to write, register and use a skill:
258
+
259
+ 1. **Extend `SkillBase`** and set the static metadata fields:
260
+
261
+ ```typescript
262
+ import {
263
+ SkillBase,
264
+ FunctionResult,
265
+ type SkillToolDefinition,
266
+ type SkillPromptSection,
267
+ } from '@signalwire/sdk';
268
+
269
+ export class StockPriceSkill extends SkillBase {
270
+ static override SKILL_NAME = 'stock_price';
271
+ static override SKILL_VERSION = '1.0.0';
272
+ static override SKILL_DESCRIPTION = 'Look up current stock prices';
273
+ static override REQUIRED_ENV_VARS = ['STOCK_API_KEY'] as const;
274
+
275
+ override getTools(): SkillToolDefinition[] {
276
+ return [
277
+ {
278
+ name: 'get_stock_price',
279
+ description: 'Get the current price of a stock by ticker symbol',
280
+ parameters: {
281
+ ticker: { type: 'string', description: 'Stock ticker symbol, such as AAPL' },
282
+ },
283
+ required: ['ticker'],
284
+ handler: async (args: Record<string, unknown>) => {
285
+ const ticker = String(args.ticker ?? '').toUpperCase();
286
+ // Call your market data API with process.env['STOCK_API_KEY'] here.
287
+ const price = '150.25';
288
+ return new FunctionResult(`${ticker} last traded at ${price} USD.`);
289
+ },
290
+ },
291
+ ];
292
+ }
293
+
294
+ override getHints(): string[] {
295
+ return ['stock', 'ticker', 'price', 'shares'];
296
+ }
297
+
298
+ protected override _getPromptSections(): SkillPromptSection[] {
299
+ return [
300
+ {
301
+ title: 'Stock Price Lookup',
302
+ body:
303
+ 'Use get_stock_price to look up a stock price. ' +
304
+ 'Ask the caller for a ticker symbol if they don\'t give one.',
305
+ },
306
+ ];
307
+ }
308
+ }
309
+ ```
310
+
311
+ 2. **Register** the class, if you want to add it by name:
312
+
313
+ <!-- snippet: no-run illustrative fragment: references the assumed `StockPriceSkill` from the page prelude (declared type-only in the shared snippet-setup), not a standalone program -->
314
+ ```typescript
315
+ import { SkillRegistry } from '@signalwire/sdk';
316
+ SkillRegistry.getInstance().register(StockPriceSkill);
317
+ ```
318
+
319
+ 3. **Add** the skill to an agent:
320
+
321
+ ```typescript
322
+ await agent.addSkill(new StockPriceSkill());
323
+ ```
324
+
325
+ With `STOCK_API_KEY` unset, the call in step 3 rejects and the skill isn't added.
326
+
327
+ ---
328
+
329
+ ## Multi-Instance Skills
330
+
331
+ A skill class that sets `static SUPPORTS_MULTIPLE_INSTANCES = true` can be added more than once. The base schema then includes `tool_name`, and the default instance key is `<SKILL_NAME>_<tool_name>`. This example adds two DataSphere searches, each with its own tool:
332
+
333
+ <!-- snippet: no-run needs SignalWire credentials to load -->
334
+ ```typescript
335
+ await agent.addSkill(new DataSphereSkill({ document_id: 'drinks-doc', tool_name: 'search_drinks' }));
336
+ await agent.addSkill(new DataSphereSkill({ document_id: 'food-doc', tool_name: 'search_food' }));
337
+ ```
338
+
339
+ Each instance registers its tool under its `tool_name`, so the two don't collide. A skill whose tool names come from other settings overrides `getInstanceKey()`. For example, `info_gatherer` keys instances by `prefix`, and `web_search` by search engine ID and tool name.
340
+
341
+ ---
342
+
343
+ ## Environment Validation
344
+
345
+ A skill lists the environment variables it needs in the static `REQUIRED_ENV_VARS`. The manager checks them before it calls `setup()`:
346
+
347
+ ```typescript
348
+ import { SkillBase, type SkillToolDefinition } from '@signalwire/sdk';
349
+
350
+ export class MySearchSkill extends SkillBase {
351
+ static override SKILL_NAME = 'my_search';
352
+ static override SKILL_DESCRIPTION = 'Example skill with required env vars.';
353
+ static override REQUIRED_ENV_VARS = ['SEARCH_API_KEY', 'SEARCH_ENGINE_ID'] as const;
354
+
355
+ override getTools(): SkillToolDefinition[] {
356
+ return [];
357
+ }
358
+ }
359
+ ```
360
+
361
+ When a variable is missing, `addSkill()` rejects with `Cannot load skill '<name>': missing environment variables: <names>`, and the skill isn't added. `skill.validateEnvVars()` returns the missing names without loading anything.
362
+
363
+ ---
364
+
365
+ ## Parameter Schema Discovery
366
+
367
+ Every skill class exposes its parameters through the static `getParameterSchema()`:
368
+
369
+ ```typescript
370
+ const schema = WebSearchSkill.getParameterSchema();
371
+ console.log(schema['num_results']);
372
+ // { type: 'integer', description: 'Number of high-quality results to return',
373
+ // default: 3, required: false, min: 1, max: 10 }
374
+ ```
375
+
376
+ A tool can use the schema to build a configuration form or check a configuration before it constructs the skill. The SDK itself doesn't check a configuration against the schema. For the format, see [Skills Parameter Schema](skills_parameter_schema.md).
377
+
378
+ ---
379
+
380
+ ## Lifecycle Hooks
381
+
382
+ The hooks run in this order:
383
+
384
+ | Hook | When | Use Case |
385
+ |---|---|---|
386
+ | `constructor(config)` | You construct the skill | Store the configuration. The base constructor moves `swaig_fields` out of it. |
387
+ | `setup()` | During `addSkill()`, after the checks | Async initialization: connect to APIs, load data, check settings |
388
+ | `getTools()`, `getDataMapTools()`, `getPromptSections()`, `getHints()`, `getGlobalData()` | During `addSkill()`, after `setup()` | Return what the agent registers |
389
+ | `cleanup()` | During `removeSkill()` or `SkillManager.clear()` | Close connections, release resources |
390
+
391
+ The agent doesn't call `cleanup()` when it shuts down. Removing a skill doesn't unregister the tools, prompt sections, hints or global data it already added.
392
+
393
+ ---
394
+
395
+ ## Security Controls
396
+
397
+ Three settings control whether the skills system runs code you didn't write in your agent.
398
+
399
+ - **Directory discovery** (`SWML_SKILL_DISCOVERY_ENABLED`): `discoverFromDirectory()` and `discoverAll()` import every `.ts` and `.js` module in a directory, which runs that module's code with your process's permissions. They do nothing, and log a warning, unless the variable is `true`. When you enable it, only point discovery at directories that nobody else can write to.
400
+ - **Registry lock** (`lock()`): `registerBuiltinSkills()` locks every registered name when it finishes. A later `register()` for a locked name, from your code or from a discovered module, logs `Cannot overwrite locked skill` and changes nothing. `unregister()` and `clear()` leave a locked name registered too, so a built-in can't be removed and replaced. The lock doesn't stop a discovered module from running code when it's imported.
401
+ - **Custom handler code** (`SWML_ALLOW_CUSTOM_HANDLER_CODE`): the `custom_skills` skill compiles each tool's `handler_code` string with the `Function` constructor only when the variable is `true`. The code isn't sandboxed. Without the variable, the tools register but return an error message instead of running the code.
402
+
403
+ Two built-in skills have their own switches. `claude_skills` runs shell commands from SKILL.md files only with `allow_shell_injection: true`. `mcp_gateway` skips TLS certificate checks only with both `verify_ssl: false` and `allow_insecure_tls: true`.
404
+
405
+ `spider` and `web_search` fetch URLs that a caller or the model supplied. They refuse private and internal addresses, check every redirect, and connect only to an address they checked. `native_vector_search` and `mcp_gateway` check their configured server URL once, at setup. `SWML_ALLOW_PRIVATE_URLS` turns these address checks off. For the related settings, see [Configuration](configuration.md) and [Security](security.md).