@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,41 @@
1
+ /**
2
+ * Skills Demo Example
3
+ *
4
+ * Shows how to add built-in skills (datetime, math) to an agent.
5
+ * Skills inject tools, prompt sections, and hints automatically.
6
+ * Run: npx tsx examples/skills-demo.ts
7
+ */
8
+
9
+ import { AgentBase, DateTimeSkill, MathSkill } from '@signalwire/sdk';
10
+
11
+ export const agent = new AgentBase({
12
+ name: 'skilled-agent',
13
+ route: '/',
14
+ basicAuth: [
15
+ process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
16
+ process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
17
+ ],
18
+ });
19
+
20
+ agent.setPromptText(
21
+ 'You are a helpful assistant with access to time and math tools. ' +
22
+ 'Use the available tools to answer questions about dates, times, and calculations.',
23
+ );
24
+
25
+ // Add skills — each injects its own tools, prompt sections, and hints
26
+ await agent.addSkill(new DateTimeSkill());
27
+ await agent.addSkill(new MathSkill());
28
+
29
+ // List what skills are loaded
30
+ console.log(
31
+ 'Loaded skills:',
32
+ agent.listSkills().map((s) => s.name),
33
+ );
34
+
35
+ // Query parameter schemas programmatically
36
+ console.log('DateTimeSkill parameters:', DateTimeSkill.getParameterSchema());
37
+ console.log('MathSkill parameters:', MathSkill.getParameterSchema());
38
+
39
+ agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
40
+
41
+ agent.serve();
@@ -0,0 +1,124 @@
1
+ /**
2
+ * Step Function Inheritance Demo
3
+ *
4
+ * This example exists to teach one specific gotcha: the per-step `functions`
5
+ * whitelist INHERITS from the previous step when omitted.
6
+ *
7
+ * Why this matters
8
+ * ----------------
9
+ * A common mistake when building multi-step agents is to assume each step
10
+ * starts with a fresh tool set. It does not. The runtime only resets the
11
+ * active set when a step explicitly declares its `functions` field. If you
12
+ * forget setFunctions() on a later step, the previous step's tools quietly
13
+ * remain available.
14
+ *
15
+ * This file shows four step-shaped patterns side by side:
16
+ *
17
+ * 1. step_lookup — explicitly whitelists `lookup_account`
18
+ * 2. step_inherit — has NO setFunctions() call. Inherits step_lookup's
19
+ * whitelist, so `lookup_account` is still callable here.
20
+ * This is rarely what you want.
21
+ * 3. step_explicit — explicitly whitelists `process_payment`. The previously
22
+ * inherited `lookup_account` is now disabled, and only
23
+ * `process_payment` is active.
24
+ * 4. step_disabled — explicitly disables ALL user functions with []
25
+ * (or 'none'). Internal tools like next_step still work.
26
+ *
27
+ * Best practice
28
+ * -------------
29
+ * Call setFunctions() on EVERY step that should differ from the previous one.
30
+ * Treat omission as an explicit decision to inherit, not a default.
31
+ *
32
+ * Run this file just to see the rendered SWML — there are no real webhook
33
+ * endpoints behind the tools, this is purely a documentation example.
34
+ */
35
+
36
+ import { AgentBase } from '@signalwire/sdk';
37
+ import { FunctionResult } from '@signalwire/sdk';
38
+
39
+ class StepFunctionInheritanceAgent extends AgentBase {
40
+ constructor() {
41
+ super({ name: 'step_function_inheritance_demo', route: '/' });
42
+
43
+ // Register three SWAIG tools so we have something to whitelist.
44
+ // In a real agent these would call out to webhooks; here they're stubs.
45
+ this.defineTool({
46
+ name: 'lookup_account',
47
+ description: 'Look up customer account details by account number',
48
+ parameters: { account_number: { type: 'string' } },
49
+ handler: async () => new FunctionResult('looked up'),
50
+ });
51
+ this.defineTool({
52
+ name: 'process_payment',
53
+ description: 'Process a payment for the current customer',
54
+ parameters: { amount: { type: 'number' } },
55
+ handler: async () => new FunctionResult('payment processed'),
56
+ });
57
+ this.defineTool({
58
+ name: 'send_receipt',
59
+ description: 'Email a receipt to the customer',
60
+ parameters: { email: { type: 'string' } },
61
+ handler: async () => new FunctionResult('sent'),
62
+ });
63
+
64
+ // Build the contexts.
65
+ const contexts = this.defineContexts();
66
+ const ctx = contexts.addContext('default');
67
+
68
+ // ── Step 1: explicit whitelist ─────────────────────────────────
69
+ // `lookup_account` is the only tool active in this step.
70
+ ctx
71
+ .addStep('step_lookup')
72
+ .setText(
73
+ 'Greet the customer and ask for their account number. ' +
74
+ 'Use lookup_account to fetch their details.',
75
+ )
76
+ .setFunctions(['lookup_account'])
77
+ .setValidSteps(['step_inherit']);
78
+
79
+ // ── Step 2: NO setFunctions() call → inheritance ──────────────
80
+ // Because we didn't call setFunctions(), this step inherits the
81
+ // active set from step_lookup. `lookup_account` is STILL callable
82
+ // here, even though we never asked for it. Most of the time this
83
+ // is a bug. To break the inheritance, call setFunctions() with an
84
+ // explicit list (even if it's empty).
85
+ ctx
86
+ .addStep('step_inherit')
87
+ .setText(
88
+ "Confirm the customer's identity. (No setFunctions() here, " +
89
+ 'so lookup_account is still active — this is the inheritance ' +
90
+ 'trap.)',
91
+ )
92
+ .setValidSteps(['step_explicit']);
93
+
94
+ // ── Step 3: explicit replacement ───────────────────────────────
95
+ // Whitelist replaces the inherited set. lookup_account is now
96
+ // inactive; only process_payment is active.
97
+ ctx
98
+ .addStep('step_explicit')
99
+ .setText(
100
+ "Take the customer's payment. Use process_payment. " +
101
+ 'lookup_account is no longer available.',
102
+ )
103
+ .setFunctions(['process_payment'])
104
+ .setValidSteps(['step_disabled']);
105
+
106
+ // ── Step 4: explicit disable-all ───────────────────────────────
107
+ // Pass [] (or 'none') to lock out every user-defined tool.
108
+ // Internal navigation tools (next_step) are unaffected.
109
+ ctx
110
+ .addStep('step_disabled')
111
+ .setText(
112
+ 'Thank the customer and wrap up. No tools are needed here, ' +
113
+ 'so we lock everything down with setFunctions([]).',
114
+ )
115
+ .setFunctions([])
116
+ .setEnd(true);
117
+ }
118
+ }
119
+
120
+ const agent = new StepFunctionInheritanceAgent();
121
+ // Render and pretty-print the resulting SWML so you can see exactly
122
+ // which steps have a `functions` key in the output and which don't.
123
+ const swml = agent.renderSwml();
124
+ console.log(JSON.stringify(JSON.parse(swml), null, 2));
@@ -0,0 +1,193 @@
1
+ /**
2
+ * SWAIG Features Showcase
3
+ *
4
+ * Demonstrates the full range of FunctionResult actions:
5
+ * hangup, hold, say, context switching, dynamic hints, global data,
6
+ * metadata, toggleFunctions, background audio, and more.
7
+ * Run: npx tsx examples/swaig-features.ts
8
+ */
9
+
10
+ import { AgentBase, FunctionResult } from '@signalwire/sdk';
11
+
12
+ export const agent = new AgentBase({
13
+ name: 'features-agent',
14
+ route: '/',
15
+ basicAuth: [
16
+ process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
17
+ process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
18
+ ],
19
+ });
20
+
21
+ agent.setPromptText(
22
+ 'You are a demo assistant showing off all SWAIG function result actions. ' +
23
+ 'The user can ask you to perform various call control actions.',
24
+ );
25
+
26
+ // Hang up the call
27
+ agent.defineTool({
28
+ name: 'end_call',
29
+ description: 'End the call when the user wants to hang up',
30
+ parameters: {},
31
+ handler: () => {
32
+ const result = new FunctionResult('Goodbye! Ending the call now.');
33
+ result.hangup();
34
+ return result;
35
+ },
36
+ });
37
+
38
+ // Place on hold
39
+ agent.defineTool({
40
+ name: 'hold_call',
41
+ description: 'Place the caller on hold',
42
+ parameters: {
43
+ seconds: { type: 'number', description: 'Hold duration in seconds (max 900)' },
44
+ },
45
+ handler: (args) => {
46
+ // args.seconds: number | undefined (optional → the ?? default handles it).
47
+ const secs = args.seconds ?? 60;
48
+ const result = new FunctionResult(`Placing you on hold for ${secs} seconds.`);
49
+ result.hold(secs);
50
+ return result;
51
+ },
52
+ });
53
+
54
+ // Say something via TTS
55
+ agent.defineTool({
56
+ name: 'announce',
57
+ description: 'Make an announcement to the caller',
58
+ parameters: {
59
+ message: { type: 'string', description: 'The announcement message' },
60
+ },
61
+ required: ['message'],
62
+ handler: (args) => {
63
+ const result = new FunctionResult('Making announcement.');
64
+ result.say(args.message);
65
+ return result;
66
+ },
67
+ });
68
+
69
+ // Play background music
70
+ agent.defineTool({
71
+ name: 'play_music',
72
+ description: 'Play background music during the call',
73
+ parameters: {
74
+ url: { type: 'string', description: 'URL of the audio file' },
75
+ },
76
+ required: ['url'],
77
+ handler: (args) => {
78
+ const result = new FunctionResult('Playing background music.');
79
+ result.playBackgroundFile(args.url);
80
+ return result;
81
+ },
82
+ });
83
+
84
+ // Stop background music
85
+ agent.defineTool({
86
+ name: 'stop_music',
87
+ description: 'Stop any playing background music',
88
+ parameters: {},
89
+ handler: () => {
90
+ const result = new FunctionResult('Stopping background music.');
91
+ result.stopBackgroundFile();
92
+ return result;
93
+ },
94
+ });
95
+
96
+ // Update global data
97
+ agent.defineTool({
98
+ name: 'save_preference',
99
+ description: 'Save a user preference to the call session',
100
+ parameters: {
101
+ key: { type: 'string', description: 'Preference key' },
102
+ value: { type: 'string', description: 'Preference value' },
103
+ },
104
+ required: ['key', 'value'],
105
+ handler: (args) => {
106
+ const result = new FunctionResult(`Saved preference: ${args.key} = ${args.value}`);
107
+ result.updateGlobalData({ [args.key]: args.value });
108
+ return result;
109
+ },
110
+ });
111
+
112
+ // Set call metadata
113
+ agent.defineTool({
114
+ name: 'tag_call',
115
+ description: 'Add a tag to the current call for tracking',
116
+ parameters: {
117
+ tag: { type: 'string', description: 'Tag to add to the call' },
118
+ },
119
+ required: ['tag'],
120
+ handler: (args) => {
121
+ const result = new FunctionResult(`Call tagged as "${args.tag}".`);
122
+ result.setMetadata({ tag: args.tag });
123
+ return result;
124
+ },
125
+ });
126
+
127
+ // Context switch
128
+ agent.defineTool({
129
+ name: 'switch_mode',
130
+ description: 'Switch the AI to a different mode or personality',
131
+ parameters: {
132
+ mode: {
133
+ type: 'string',
134
+ description: 'New mode: "formal" or "casual"',
135
+ enum: ['formal', 'casual'],
136
+ },
137
+ },
138
+ required: ['mode'],
139
+ handler: (args) => {
140
+ // args.mode narrows to 'formal' | 'casual' from the enum.
141
+ const prompt =
142
+ args.mode === 'formal'
143
+ ? 'You are now a formal, professional assistant. Use proper language.'
144
+ : 'You are now a casual, friendly assistant. Be relaxed and conversational.';
145
+ const result = new FunctionResult(`Switched to ${args.mode} mode.`);
146
+ result.switchContext({ systemPrompt: prompt });
147
+ return result;
148
+ },
149
+ });
150
+
151
+ // Send SMS
152
+ agent.defineTool({
153
+ name: 'send_sms',
154
+ description: 'Send an SMS message to a phone number',
155
+ parameters: {
156
+ to: { type: 'string', description: 'Recipient phone number' },
157
+ message: { type: 'string', description: 'SMS message text' },
158
+ },
159
+ required: ['to', 'message'],
160
+ handler: (args) => {
161
+ const result = new FunctionResult(`SMS sent to ${args.to}: "${args.message}"`);
162
+ result.sendSms({
163
+ toNumber: args.to,
164
+ fromNumber: '+15551234567',
165
+ body: args.message,
166
+ });
167
+ return result;
168
+ },
169
+ });
170
+
171
+ // Toggle functions dynamically
172
+ agent.defineTool({
173
+ name: 'lock_down',
174
+ description: 'Disable all tools except end_call for security',
175
+ parameters: {},
176
+ handler: () => {
177
+ const result = new FunctionResult(
178
+ 'Entering secure mode. Only the end call function is available.',
179
+ );
180
+ result.toggleFunctions([
181
+ { function: 'hold_call', active: false },
182
+ { function: 'announce', active: false },
183
+ { function: 'play_music', active: false },
184
+ { function: 'stop_music', active: false },
185
+ { function: 'send_sms', active: false },
186
+ ]);
187
+ return result;
188
+ },
189
+ });
190
+
191
+ agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
192
+
193
+ agent.serve();
@@ -0,0 +1,66 @@
1
+ /**
2
+ * SWML Service Routing Example
3
+ *
4
+ * Demonstrates dynamic SWML routing using SWMLService's onRequestCallback.
5
+ * Different SWML documents are generated based on query parameters,
6
+ * enabling a single endpoint to serve multiple call flows.
7
+ * Run: npx tsx examples/swml-service-routing.ts
8
+ * Test:
9
+ * curl http://user:pass@localhost:3000/?dept=sales
10
+ * curl http://user:pass@localhost:3000/?dept=support
11
+ * curl http://user:pass@localhost:3000/ (default IVR)
12
+ */
13
+
14
+ import { SWMLService, SwmlBuilder } from '@signalwire/sdk';
15
+
16
+ export const agent = new SWMLService({
17
+ name: 'ivr-router',
18
+ route: '/',
19
+ basicAuth: [
20
+ process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
21
+ process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
22
+ ],
23
+ });
24
+
25
+ // Dynamic routing: build different SWML based on request parameters
26
+ agent.setOnRequestCallback(async (queryParams, _bodyParams, _headers) => {
27
+ const builder = new SwmlBuilder();
28
+ const dept = queryParams['dept'];
29
+
30
+ builder.addVerb('answer', { max_duration: 300 });
31
+
32
+ if (dept === 'sales') {
33
+ builder.addVerb('play', {
34
+ url: 'say:Thank you for calling the sales department. Please hold while we connect you.',
35
+ });
36
+ builder.addVerb('connect', {
37
+ from: '+15551234567',
38
+ to: '+15559876543',
39
+ });
40
+ } else if (dept === 'support') {
41
+ builder.addVerb('play', {
42
+ url: 'say:Thank you for calling technical support. Your call is important to us.',
43
+ });
44
+ builder.addVerb('record', {
45
+ stereo: true,
46
+ format: 'mp3',
47
+ beep: true,
48
+ terminators: '#',
49
+ });
50
+ } else {
51
+ // Default IVR menu
52
+ builder.addVerb('play', {
53
+ url: 'say:Welcome to Acme Corp. Press 1 for sales, 2 for support, or stay on the line for the operator.',
54
+ });
55
+ builder.addVerb('sleep', 3);
56
+ builder.addVerb('play', {
57
+ url: 'say:Connecting you to an operator. Please hold.',
58
+ });
59
+ }
60
+
61
+ builder.addVerb('hangup', {});
62
+
63
+ return builder;
64
+ });
65
+
66
+ agent.serve();
@@ -0,0 +1,38 @@
1
+ /**
2
+ * SWML Service Example
3
+ *
4
+ * A non-AI SWML service that builds IVR call flows without an AI block.
5
+ * Uses SWMLService instead of AgentBase for pure call-flow control.
6
+ * Run: npx tsx examples/swml-service.ts
7
+ */
8
+
9
+ import { SWMLService } from '@signalwire/sdk';
10
+
11
+ export const agent = new SWMLService({
12
+ name: 'ivr-menu',
13
+ route: '/',
14
+ basicAuth: [
15
+ process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
16
+ process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
17
+ ],
18
+ });
19
+
20
+ // Build a simple IVR: answer → play greeting → record voicemail → hangup
21
+ agent.addVerb('answer', { max_duration: 300 });
22
+ agent.addVerb('play', {
23
+ url: 'say:Thank you for calling Acme Corp. All agents are currently busy. Please leave a message after the beep.',
24
+ });
25
+ agent.addVerb('record', {
26
+ stereo: true,
27
+ format: 'mp3',
28
+ direction: 'listen',
29
+ terminators: '#',
30
+ beep: true,
31
+ });
32
+ agent.addVerb('play', { url: 'say:Thank you. Goodbye!' });
33
+ agent.addVerb('hangup', {});
34
+
35
+ // Print the generated SWML
36
+ console.log('SWML Document:', JSON.stringify(agent.renderSwml(), null, 2));
37
+
38
+ agent.serve();
@@ -0,0 +1,104 @@
1
+ /**
2
+ * swmlservice_ai_sidecar.ts
3
+ *
4
+ * Proves that SWMLService can emit the `ai_sidecar` verb, register SWAIG
5
+ * tools the sidecar's LLM can call, and dispatch them end-to-end — without
6
+ * any AgentBase code path.
7
+ *
8
+ * The `ai_sidecar` verb runs an AI listener alongside an in-progress call
9
+ * (real-time copilot, transcription analyzer, compliance monitor, etc.). It
10
+ * is NOT an agent — it does not own the call. So the right host is
11
+ * SWMLService, not AgentBase.
12
+ *
13
+ * Run:
14
+ * npx tsx examples/swmlservice_ai_sidecar.ts
15
+ *
16
+ * What this serves:
17
+ * GET /sales-sidecar → SWML doc with the ai_sidecar verb
18
+ * POST /sales-sidecar/swaig → SWAIG tool dispatch (used by the sidecar's LLM)
19
+ * POST /sales-sidecar/events → optional sidecar lifecycle event sink
20
+ *
21
+ * Drive the SWAIG path through the SDK CLI:
22
+ * npx swaig-test examples/swmlservice_ai_sidecar.ts --list-tools
23
+ * npx swaig-test examples/swmlservice_ai_sidecar.ts \
24
+ * --exec lookup_competitor --arg competitor=ACME
25
+ */
26
+
27
+ import { SWMLService } from '@signalwire/sdk';
28
+
29
+ /** SWMLService that emits <ai_sidecar> and hosts the tools its LLM calls. */
30
+ class SalesSidecar extends SWMLService {
31
+ constructor(opts: { publicUrl?: string; host?: string; port?: number } = {}) {
32
+ const publicUrl = opts.publicUrl ?? 'https://your-host.example.com/sales-sidecar';
33
+ super({
34
+ name: 'sales-sidecar',
35
+ route: '/sales-sidecar',
36
+ host: opts.host ?? '0.0.0.0',
37
+ port: opts.port ?? 3000,
38
+ basicAuth: [
39
+ process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
40
+ process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
41
+ ],
42
+ });
43
+
44
+ // 1. Emit any SWML — including ai_sidecar. SWMLService's addVerb /
45
+ // addVerbToSection accept arbitrary verb dicts, so new platform
46
+ // verbs work without an SDK release.
47
+ this.addVerb('answer', {});
48
+ this.addVerbToSection('main', 'ai_sidecar', {
49
+ // Required by the sidecar schema: prompt + lang.
50
+ prompt:
51
+ 'You are a real-time sales copilot. Listen to the call and surface ' +
52
+ 'competitor pricing comparisons when relevant.',
53
+ lang: 'en-US',
54
+ // direction must list both legs the sidecar should listen to.
55
+ direction: ['remote-caller', 'local-caller'],
56
+ // Optional event sink — sidecar POSTs lifecycle/transcription here.
57
+ url: `${publicUrl}/events`,
58
+ // Webhook URL for SWAIG tool calls goes inside SWAIG.defaults
59
+ // (uppercase SWAIG to match the platform verb schema).
60
+ SWAIG: {
61
+ defaults: { web_hook_url: `${publicUrl}/swaig` },
62
+ },
63
+ });
64
+ this.addVerb('hangup', {});
65
+
66
+ // 2. Register tools the sidecar's LLM can call. Same `defineTool` you'd
67
+ // use on AgentBase — it lives on SWMLService.
68
+ this.defineTool({
69
+ name: 'lookup_competitor',
70
+ description:
71
+ 'Look up competitor pricing by company name. The sidecar should ' +
72
+ 'call this whenever the caller mentions a competitor.',
73
+ parameters: {
74
+ competitor: {
75
+ type: 'string',
76
+ description: "The competitor's company name, e.g. 'ACME'.",
77
+ },
78
+ },
79
+ handler: (args, _raw) => {
80
+ // args.competitor is inferred `string | undefined` from the schema.
81
+ const competitor = args.competitor ?? '<unknown>';
82
+ return {
83
+ response:
84
+ `Pricing for ${competitor}: $99/seat. Our equivalent plan is ` +
85
+ '$79/seat with the same SLA.',
86
+ };
87
+ },
88
+ });
89
+
90
+ // 3. (Optional) Mount an event sink for ai_sidecar lifecycle events at
91
+ // POST /sales-sidecar/events. Comment out if you don't need it. The
92
+ // callback returns null so SWMLService skips the redirect path and
93
+ // just acks with the current SWML document.
94
+ this.registerRoutingCallback((body) => {
95
+ const eventType = (body['type'] as string | undefined) ?? '<unknown>';
96
+ this.log.info(`[sidecar event] type=${eventType} body=${JSON.stringify(body)}`);
97
+ return null;
98
+ }, '/events');
99
+ }
100
+ }
101
+
102
+ // See the standalone example for why we instantiate at module top level.
103
+ export const agent = new SalesSidecar();
104
+ agent.serve();
@@ -0,0 +1,79 @@
1
+ /**
2
+ * swmlservice_swaig_standalone.ts
3
+ *
4
+ * Proves that SWMLService — by itself, with NO AgentBase — can host SWAIG
5
+ * functions and serve them on its own /swaig endpoint.
6
+ *
7
+ * This is the path you take when you want a SWAIG-callable HTTP service that
8
+ * isn't an `<ai>` agent: the SWAIG verb is a generic LLM-tool surface and
9
+ * SWMLService is the host. AgentBase is just a SWMLService subclass that
10
+ * *also* layers in prompts, AI config, dynamic config, and token validation.
11
+ *
12
+ * Run:
13
+ * npx tsx examples/swmlservice_swaig_standalone.ts
14
+ *
15
+ * Then exercise the endpoints:
16
+ * curl -u user:pass http://localhost:3000/standalone # GET SWML doc
17
+ * curl -u user:pass http://localhost:3000/standalone/swaig \
18
+ * -H 'Content-Type: application/json' \
19
+ * -d '{"function":"lookup_competitor","argument":{"parsed":[{"competitor":"ACME"}]}}'
20
+ *
21
+ * Or drive it through the SDK CLI without standing up the server:
22
+ * npx swaig-test examples/swmlservice_swaig_standalone.ts --list-tools
23
+ * npx swaig-test examples/swmlservice_swaig_standalone.ts \
24
+ * --exec lookup_competitor --arg competitor=ACME
25
+ */
26
+
27
+ import { SWMLService } from '@signalwire/sdk';
28
+
29
+ /** SWMLService that registers SWAIG tools and serves them on /swaig. */
30
+ class StandaloneSwaig extends SWMLService {
31
+ constructor(opts: { host?: string; port?: number } = {}) {
32
+ super({
33
+ name: 'standalone-swaig',
34
+ route: '/standalone',
35
+ host: opts.host ?? '0.0.0.0',
36
+ // Honor an explicit port; otherwise fall back to PORT env var (used by
37
+ // CI / the audit harness) and finally to 3000 for local interactive use.
38
+ port: opts.port ?? parseInt(process.env['PORT'] ?? '3000', 10),
39
+ // Hard-coded creds keep the example reproducible from the CLI / curl.
40
+ basicAuth: [
41
+ process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
42
+ process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
43
+ ],
44
+ });
45
+
46
+ // 1. Build a minimal SWML document. Any verbs are fine — the SWAIG HTTP
47
+ // surface is independent of what the document contains.
48
+ this.addVerb('answer', {});
49
+ this.addVerb('hangup', {});
50
+
51
+ // 2. Register a SWAIG function. `defineTool` lives on SWMLService — not
52
+ // just AgentBase. The handler receives parsed args plus the raw body.
53
+ this.defineTool({
54
+ name: 'lookup_competitor',
55
+ description:
56
+ 'Look up competitor pricing by company name. Use this when the user ' +
57
+ "asks how a competitor's price compares to ours.",
58
+ parameters: {
59
+ competitor: {
60
+ type: 'string',
61
+ description: "The competitor's company name, e.g. 'ACME'.",
62
+ },
63
+ },
64
+ handler: (args, _raw) => {
65
+ // args.competitor is inferred `string | undefined` from the schema.
66
+ const competitor = args.competitor ?? '<unknown>';
67
+ return {
68
+ response: `${competitor} pricing is $99/seat; we're $79/seat.`,
69
+ };
70
+ },
71
+ });
72
+ }
73
+ }
74
+
75
+ // Instantiate at module top-level so the swaig-test CLI can locate us via
76
+ // the exported `agent` symbol. `.serve()` is a no-op when SWAIG_CLI_MODE=true,
77
+ // so the same file works for both `npx tsx ...` (server mode) and CLI mode.
78
+ export const agent = new StandaloneSwaig();
79
+ agent.serve();