@signalwire/sdk 2.0.5 → 3.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (656) hide show
  1. package/CHANGELOG.md +785 -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 +481 -126
  6. package/dist/AgentBase.js +1502 -438
  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 +158 -45
  21. package/dist/DataMap.js +167 -52
  22. package/dist/DataMap.js.map +1 -1
  23. package/dist/FunctionResult.d.ts +277 -83
  24. package/dist/FunctionResult.js +444 -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 +158 -58
  58. package/dist/SWMLService.js +435 -127
  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/ServerlessAdapter.d.ts +156 -7
  67. package/dist/ServerlessAdapter.js +399 -42
  68. package/dist/ServerlessAdapter.js.map +1 -1
  69. package/dist/SessionManager.d.ts +11 -2
  70. package/dist/SessionManager.js +50 -18
  71. package/dist/SessionManager.js.map +1 -1
  72. package/dist/SslConfig.d.ts +2 -1
  73. package/dist/SslConfig.js +4 -1
  74. package/dist/SslConfig.js.map +1 -1
  75. package/dist/SwaigActions.generated.d.ts +23 -0
  76. package/dist/SwaigActions.generated.js +8 -0
  77. package/dist/SwaigActions.generated.js.map +1 -0
  78. package/dist/SwaigContracts.d.ts +15 -0
  79. package/dist/SwaigContracts.generated.d.ts +264 -0
  80. package/dist/SwaigContracts.generated.js +12 -0
  81. package/dist/SwaigContracts.generated.js.map +1 -0
  82. package/dist/SwaigContracts.js +2 -0
  83. package/dist/SwaigContracts.js.map +1 -0
  84. package/dist/SwaigFunction.d.ts +110 -4
  85. package/dist/SwaigFunction.js +151 -19
  86. package/dist/SwaigFunction.js.map +1 -1
  87. package/dist/SwmlBuilder.d.ts +68 -19
  88. package/dist/SwmlBuilder.js +74 -38
  89. package/dist/SwmlBuilder.js.map +1 -1
  90. package/dist/SwmlVerbMethods.generated.d.ts +41 -4
  91. package/dist/SwmlVerbMethods.generated.js +1 -1
  92. package/dist/TypeInference.d.ts +39 -3
  93. package/dist/TypeInference.js +256 -16
  94. package/dist/TypeInference.js.map +1 -1
  95. package/dist/WebService.d.ts +79 -11
  96. package/dist/WebService.js +320 -109
  97. package/dist/WebService.js.map +1 -1
  98. package/dist/WebhookMiddleware.d.ts +119 -0
  99. package/dist/WebhookMiddleware.js +271 -0
  100. package/dist/WebhookMiddleware.js.map +1 -0
  101. package/dist/WebhookValidator.d.ts +92 -0
  102. package/dist/WebhookValidator.js +409 -0
  103. package/dist/WebhookValidator.js.map +1 -0
  104. package/dist/agents/BedrockAgent.d.ts +162 -0
  105. package/dist/agents/BedrockAgent.js +323 -0
  106. package/dist/agents/BedrockAgent.js.map +1 -0
  107. package/dist/ai-chat/AIChatClient.d.ts +316 -0
  108. package/dist/ai-chat/AIChatClient.js +535 -0
  109. package/dist/ai-chat/AIChatClient.js.map +1 -0
  110. package/dist/ai-chat/ChatGateway.d.ts +408 -0
  111. package/dist/ai-chat/ChatGateway.js +747 -0
  112. package/dist/ai-chat/ChatGateway.js.map +1 -0
  113. package/dist/ai-chat/HandoffRouter.d.ts +282 -0
  114. package/dist/ai-chat/HandoffRouter.js +518 -0
  115. package/dist/ai-chat/HandoffRouter.js.map +1 -0
  116. package/dist/ai-chat/index.d.ts +12 -0
  117. package/dist/ai-chat/index.js +10 -0
  118. package/dist/ai-chat/index.js.map +1 -0
  119. package/dist/capabilities.d.ts +64 -0
  120. package/dist/capabilities.js +95 -0
  121. package/dist/capabilities.js.map +1 -0
  122. package/dist/cli/agent-loader.d.ts +32 -6
  123. package/dist/cli/agent-loader.js +92 -33
  124. package/dist/cli/agent-loader.js.map +1 -1
  125. package/dist/cli/datamap-exec.d.ts +175 -0
  126. package/dist/cli/datamap-exec.js +1284 -0
  127. package/dist/cli/datamap-exec.js.map +1 -0
  128. package/dist/cli/function-args.d.ts +40 -0
  129. package/dist/cli/function-args.js +146 -0
  130. package/dist/cli/function-args.js.map +1 -0
  131. package/dist/cli/simulation.d.ts +99 -0
  132. package/dist/cli/simulation.js +490 -0
  133. package/dist/cli/simulation.js.map +1 -0
  134. package/dist/cli/swaig-test.d.ts +12 -25
  135. package/dist/cli/swaig-test.js +935 -371
  136. package/dist/cli/swaig-test.js.map +1 -1
  137. package/dist/cli/tsdocs/agentsNote.d.ts +30 -0
  138. package/dist/cli/tsdocs/agentsNote.js +92 -0
  139. package/dist/cli/tsdocs/agentsNote.js.map +1 -0
  140. package/dist/cli/tsdocs/api-index.json +1 -0
  141. package/dist/cli/tsdocs/api.d.ts +91 -0
  142. package/dist/cli/tsdocs/api.js +372 -0
  143. package/dist/cli/tsdocs/api.js.map +1 -0
  144. package/dist/cli/tsdocs/apiTypes.d.ts +64 -0
  145. package/dist/cli/tsdocs/apiTypes.js +7 -0
  146. package/dist/cli/tsdocs/apiTypes.js.map +1 -0
  147. package/dist/cli/tsdocs/bin.d.ts +6 -0
  148. package/dist/cli/tsdocs/bin.js +23 -0
  149. package/dist/cli/tsdocs/bin.js.map +1 -0
  150. package/dist/cli/tsdocs/files.d.ts +108 -0
  151. package/dist/cli/tsdocs/files.js +287 -0
  152. package/dist/cli/tsdocs/files.js.map +1 -0
  153. package/dist/cli/tsdocs/index.d.ts +28 -0
  154. package/dist/cli/tsdocs/index.js +307 -0
  155. package/dist/cli/tsdocs/index.js.map +1 -0
  156. package/dist/cli/tsdocs/live.d.ts +41 -0
  157. package/dist/cli/tsdocs/live.js +202 -0
  158. package/dist/cli/tsdocs/live.js.map +1 -0
  159. package/dist/cli/tsdocs/locate.d.ts +51 -0
  160. package/dist/cli/tsdocs/locate.js +75 -0
  161. package/dist/cli/tsdocs/locate.js.map +1 -0
  162. package/dist/cli/tsdocs/render.d.ts +75 -0
  163. package/dist/cli/tsdocs/render.js +323 -0
  164. package/dist/cli/tsdocs/render.js.map +1 -0
  165. package/dist/cli/tsdocs/topics.d.ts +43 -0
  166. package/dist/cli/tsdocs/topics.js +916 -0
  167. package/dist/cli/tsdocs/topics.js.map +1 -0
  168. package/dist/index.d.ts +47 -68
  169. package/dist/index.js +44 -73
  170. package/dist/index.js.map +1 -1
  171. package/dist/livewire/index.d.ts +229 -155
  172. package/dist/livewire/index.js +298 -195
  173. package/dist/livewire/index.js.map +1 -1
  174. package/dist/llms.txt +65 -0
  175. package/dist/prefabs/CallSessionStore.d.ts +52 -0
  176. package/dist/prefabs/CallSessionStore.js +72 -0
  177. package/dist/prefabs/CallSessionStore.js.map +1 -0
  178. package/dist/prefabs/ConciergeAgent.d.ts +13 -1
  179. package/dist/prefabs/ConciergeAgent.js +36 -31
  180. package/dist/prefabs/ConciergeAgent.js.map +1 -1
  181. package/dist/prefabs/FAQBotAgent.d.ts +9 -1
  182. package/dist/prefabs/FAQBotAgent.js +113 -47
  183. package/dist/prefabs/FAQBotAgent.js.map +1 -1
  184. package/dist/prefabs/InfoGathererAgent.d.ts +22 -3
  185. package/dist/prefabs/InfoGathererAgent.js +67 -58
  186. package/dist/prefabs/InfoGathererAgent.js.map +1 -1
  187. package/dist/prefabs/ReceptionistAgent.d.ts +16 -5
  188. package/dist/prefabs/ReceptionistAgent.js +39 -31
  189. package/dist/prefabs/ReceptionistAgent.js.map +1 -1
  190. package/dist/prefabs/SurveyAgent.d.ts +22 -4
  191. package/dist/prefabs/SurveyAgent.js +84 -68
  192. package/dist/prefabs/SurveyAgent.js.map +1 -1
  193. package/dist/relay/Action.d.ts +44 -21
  194. package/dist/relay/Action.js +75 -17
  195. package/dist/relay/Action.js.map +1 -1
  196. package/dist/relay/Call.d.ts +312 -47
  197. package/dist/relay/Call.js +369 -18
  198. package/dist/relay/Call.js.map +1 -1
  199. package/dist/relay/Deferred.js.map +1 -1
  200. package/dist/relay/Message.d.ts +26 -5
  201. package/dist/relay/Message.js +36 -6
  202. package/dist/relay/Message.js.map +1 -1
  203. package/dist/relay/RelayClient.d.ts +44 -17
  204. package/dist/relay/RelayClient.js +175 -65
  205. package/dist/relay/RelayClient.js.map +1 -1
  206. package/dist/relay/RelayError.d.ts +14 -0
  207. package/dist/relay/RelayError.js +15 -0
  208. package/dist/relay/RelayError.js.map +1 -1
  209. package/dist/relay/RelayEvent.d.ts +96 -65
  210. package/dist/relay/RelayEvent.js +85 -56
  211. package/dist/relay/RelayEvent.js.map +1 -1
  212. package/dist/relay/closedSets.d.ts +111 -0
  213. package/dist/relay/closedSets.js +83 -0
  214. package/dist/relay/closedSets.js.map +1 -0
  215. package/dist/relay/index.d.ts +3 -1
  216. package/dist/relay/index.js +1 -0
  217. package/dist/relay/index.js.map +1 -1
  218. package/dist/relay/normalize.js.map +1 -1
  219. package/dist/relay/protocol.types.generated.d.ts +1195 -0
  220. package/dist/relay/protocol.types.generated.js +8 -0
  221. package/dist/relay/protocol.types.generated.js.map +1 -0
  222. package/dist/relay/types.d.ts +73 -42
  223. package/dist/rest/HttpClient.d.ts +36 -8
  224. package/dist/rest/HttpClient.js +233 -40
  225. package/dist/rest/HttpClient.js.map +1 -1
  226. package/dist/rest/RequestOptions.d.ts +110 -0
  227. package/dist/rest/RequestOptions.js +113 -0
  228. package/dist/rest/RequestOptions.js.map +1 -0
  229. package/dist/rest/RestError.d.ts +52 -6
  230. package/dist/rest/RestError.js +89 -5
  231. package/dist/rest/RestError.js.map +1 -1
  232. package/dist/rest/base/CrudResource.d.ts +16 -26
  233. package/dist/rest/base/CrudResource.js +19 -33
  234. package/dist/rest/base/CrudResource.js.map +1 -1
  235. package/dist/rest/base/CrudWithAddresses.d.ts +3 -2
  236. package/dist/rest/base/CrudWithAddresses.js +2 -2
  237. package/dist/rest/base/CrudWithAddresses.js.map +1 -1
  238. package/dist/rest/base/FabricResource.d.ts +15 -0
  239. package/dist/rest/base/FabricResource.js +16 -0
  240. package/dist/rest/base/FabricResource.js.map +1 -0
  241. package/dist/rest/base/ReadResource.d.ts +62 -0
  242. package/dist/rest/base/ReadResource.js +69 -0
  243. package/dist/rest/base/ReadResource.js.map +1 -0
  244. package/dist/rest/callHandler.d.ts +5 -2
  245. package/dist/rest/callHandler.js +4 -1
  246. package/dist/rest/callHandler.js.map +1 -1
  247. package/dist/rest/index.d.ts +18 -77
  248. package/dist/rest/index.js +47 -120
  249. package/dist/rest/index.js.map +1 -1
  250. package/dist/rest/namespaces/_client_tree_generated.d.ts +103 -0
  251. package/dist/rest/namespaces/_client_tree_generated.js +171 -0
  252. package/dist/rest/namespaces/_client_tree_generated.js.map +1 -0
  253. package/dist/rest/namespaces/addresses.d.ts +3 -42
  254. package/dist/rest/namespaces/addresses.js +3 -50
  255. package/dist/rest/namespaces/addresses.js.map +1 -1
  256. package/dist/rest/namespaces/calling.d.ts +6 -378
  257. package/dist/rest/namespaces/calling.js +6 -473
  258. package/dist/rest/namespaces/calling.js.map +1 -1
  259. package/dist/rest/namespaces/calling.resources.generated.d.ts +165 -0
  260. package/dist/rest/namespaces/calling.resources.generated.js +477 -0
  261. package/dist/rest/namespaces/calling.resources.generated.js.map +1 -0
  262. package/dist/rest/namespaces/calling.types.generated.d.ts +2917 -0
  263. package/dist/rest/namespaces/calling.types.generated.js +8 -0
  264. package/dist/rest/namespaces/calling.types.generated.js.map +1 -0
  265. package/dist/rest/namespaces/chat.d.ts +4 -18
  266. package/dist/rest/namespaces/chat.js +4 -21
  267. package/dist/rest/namespaces/chat.js.map +1 -1
  268. package/dist/rest/namespaces/chat.resources.generated.d.ts +12 -0
  269. package/dist/rest/namespaces/chat.resources.generated.js +29 -0
  270. package/dist/rest/namespaces/chat.resources.generated.js.map +1 -0
  271. package/dist/rest/namespaces/chat.types.generated.d.ts +56 -0
  272. package/dist/rest/namespaces/chat.types.generated.js +8 -0
  273. package/dist/rest/namespaces/chat.types.generated.js.map +1 -0
  274. package/dist/rest/namespaces/datasphere.d.ts +6 -62
  275. package/dist/rest/namespaces/datasphere.js +6 -72
  276. package/dist/rest/namespaces/datasphere.js.map +1 -1
  277. package/dist/rest/namespaces/datasphere.resources.generated.d.ts +25 -0
  278. package/dist/rest/namespaces/datasphere.resources.generated.js +50 -0
  279. package/dist/rest/namespaces/datasphere.resources.generated.js.map +1 -0
  280. package/dist/rest/namespaces/datasphere.types.generated.d.ts +180 -0
  281. package/dist/rest/namespaces/datasphere.types.generated.js +8 -0
  282. package/dist/rest/namespaces/datasphere.types.generated.js.map +1 -0
  283. package/dist/rest/namespaces/fabric.d.ts +11 -327
  284. package/dist/rest/namespaces/fabric.js +14 -439
  285. package/dist/rest/namespaces/fabric.js.map +1 -1
  286. package/dist/rest/namespaces/fabric.resources.generated.d.ts +195 -0
  287. package/dist/rest/namespaces/fabric.resources.generated.js +399 -0
  288. package/dist/rest/namespaces/fabric.resources.generated.js.map +1 -0
  289. package/dist/rest/namespaces/fabric.types.generated.d.ts +4557 -0
  290. package/dist/rest/namespaces/fabric.types.generated.js +8 -0
  291. package/dist/rest/namespaces/fabric.types.generated.js.map +1 -0
  292. package/dist/rest/namespaces/fax.resources.generated.d.ts +6 -0
  293. package/dist/rest/namespaces/fax.resources.generated.js +14 -0
  294. package/dist/rest/namespaces/fax.resources.generated.js.map +1 -0
  295. package/dist/rest/namespaces/fax.types.generated.d.ts +131 -0
  296. package/dist/rest/namespaces/fax.types.generated.js +8 -0
  297. package/dist/rest/namespaces/fax.types.generated.js.map +1 -0
  298. package/dist/rest/namespaces/imported-numbers.d.ts +3 -18
  299. package/dist/rest/namespaces/imported-numbers.js +3 -21
  300. package/dist/rest/namespaces/imported-numbers.js.map +1 -1
  301. package/dist/rest/namespaces/logs.d.ts +10 -101
  302. package/dist/rest/namespaces/logs.js +10 -128
  303. package/dist/rest/namespaces/logs.js.map +1 -1
  304. package/dist/rest/namespaces/logs.resources.generated.d.ts +9 -0
  305. package/dist/rest/namespaces/logs.resources.generated.js +17 -0
  306. package/dist/rest/namespaces/logs.resources.generated.js.map +1 -0
  307. package/dist/rest/namespaces/logs.types.generated.d.ts +131 -0
  308. package/dist/rest/namespaces/logs.types.generated.js +8 -0
  309. package/dist/rest/namespaces/logs.types.generated.js.map +1 -0
  310. package/dist/rest/namespaces/lookup.d.ts +3 -25
  311. package/dist/rest/namespaces/lookup.js +3 -27
  312. package/dist/rest/namespaces/lookup.js.map +1 -1
  313. package/dist/rest/namespaces/message.resources.generated.d.ts +6 -0
  314. package/dist/rest/namespaces/message.resources.generated.js +14 -0
  315. package/dist/rest/namespaces/message.resources.generated.js.map +1 -0
  316. package/dist/rest/namespaces/message.types.generated.d.ts +122 -0
  317. package/dist/rest/namespaces/message.types.generated.js +8 -0
  318. package/dist/rest/namespaces/message.types.generated.js.map +1 -0
  319. package/dist/rest/namespaces/messages.resources.generated.d.ts +18 -0
  320. package/dist/rest/namespaces/messages.resources.generated.js +44 -0
  321. package/dist/rest/namespaces/messages.resources.generated.js.map +1 -0
  322. package/dist/rest/namespaces/messages.types.generated.d.ts +99 -0
  323. package/dist/rest/namespaces/messages.types.generated.js +8 -0
  324. package/dist/rest/namespaces/messages.types.generated.js.map +1 -0
  325. package/dist/rest/namespaces/mfa.d.ts +3 -42
  326. package/dist/rest/namespaces/mfa.js +3 -49
  327. package/dist/rest/namespaces/mfa.js.map +1 -1
  328. package/dist/rest/namespaces/number-groups.d.ts +3 -45
  329. package/dist/rest/namespaces/number-groups.js +3 -53
  330. package/dist/rest/namespaces/number-groups.js.map +1 -1
  331. package/dist/rest/namespaces/phone-numbers.d.ts +8 -196
  332. package/dist/rest/namespaces/phone-numbers.js +8 -230
  333. package/dist/rest/namespaces/phone-numbers.js.map +1 -1
  334. package/dist/rest/namespaces/project.d.ts +6 -42
  335. package/dist/rest/namespaces/project.js +6 -51
  336. package/dist/rest/namespaces/project.js.map +1 -1
  337. package/dist/rest/namespaces/project.resources.generated.d.ts +17 -0
  338. package/dist/rest/namespaces/project.resources.generated.js +44 -0
  339. package/dist/rest/namespaces/project.resources.generated.js.map +1 -0
  340. package/dist/rest/namespaces/project.types.generated.d.ts +58 -0
  341. package/dist/rest/namespaces/project.types.generated.js +8 -0
  342. package/dist/rest/namespaces/project.types.generated.js.map +1 -0
  343. package/dist/rest/namespaces/projects.resources.generated.d.ts +12 -0
  344. package/dist/rest/namespaces/projects.resources.generated.js +25 -0
  345. package/dist/rest/namespaces/projects.resources.generated.js.map +1 -0
  346. package/dist/rest/namespaces/projects.types.generated.d.ts +77 -0
  347. package/dist/rest/namespaces/projects.types.generated.js +8 -0
  348. package/dist/rest/namespaces/projects.types.generated.js.map +1 -0
  349. package/dist/rest/namespaces/pubsub.d.ts +4 -18
  350. package/dist/rest/namespaces/pubsub.js +4 -21
  351. package/dist/rest/namespaces/pubsub.js.map +1 -1
  352. package/dist/rest/namespaces/pubsub.resources.generated.d.ts +12 -0
  353. package/dist/rest/namespaces/pubsub.resources.generated.js +29 -0
  354. package/dist/rest/namespaces/pubsub.resources.generated.js.map +1 -0
  355. package/dist/rest/namespaces/pubsub.types.generated.d.ts +60 -0
  356. package/dist/rest/namespaces/pubsub.types.generated.js +8 -0
  357. package/dist/rest/namespaces/pubsub.types.generated.js.map +1 -0
  358. package/dist/rest/namespaces/queues.d.ts +3 -38
  359. package/dist/rest/namespaces/queues.js +3 -44
  360. package/dist/rest/namespaces/queues.js.map +1 -1
  361. package/dist/rest/namespaces/recordings.d.ts +3 -34
  362. package/dist/rest/namespaces/recordings.js +3 -40
  363. package/dist/rest/namespaces/recordings.js.map +1 -1
  364. package/dist/rest/namespaces/registry.d.ts +6 -137
  365. package/dist/rest/namespaces/registry.js +6 -173
  366. package/dist/rest/namespaces/registry.js.map +1 -1
  367. package/dist/rest/namespaces/relay-rest.resources.generated.d.ts +168 -0
  368. package/dist/rest/namespaces/relay-rest.resources.generated.js +430 -0
  369. package/dist/rest/namespaces/relay-rest.resources.generated.js.map +1 -0
  370. package/dist/rest/namespaces/relay-rest.types.generated.d.ts +1906 -0
  371. package/dist/rest/namespaces/relay-rest.types.generated.js +8 -0
  372. package/dist/rest/namespaces/relay-rest.types.generated.js.map +1 -0
  373. package/dist/rest/namespaces/short-codes.d.ts +3 -35
  374. package/dist/rest/namespaces/short-codes.js +3 -41
  375. package/dist/rest/namespaces/short-codes.js.map +1 -1
  376. package/dist/rest/namespaces/sip-profile.d.ts +3 -24
  377. package/dist/rest/namespaces/sip-profile.js +3 -29
  378. package/dist/rest/namespaces/sip-profile.js.map +1 -1
  379. package/dist/rest/namespaces/verified-callers.d.ts +3 -29
  380. package/dist/rest/namespaces/verified-callers.js +3 -34
  381. package/dist/rest/namespaces/verified-callers.js.map +1 -1
  382. package/dist/rest/namespaces/video.d.ts +10 -227
  383. package/dist/rest/namespaces/video.js +10 -288
  384. package/dist/rest/namespaces/video.js.map +1 -1
  385. package/dist/rest/namespaces/video.resources.generated.d.ts +81 -0
  386. package/dist/rest/namespaces/video.resources.generated.js +171 -0
  387. package/dist/rest/namespaces/video.resources.generated.js.map +1 -0
  388. package/dist/rest/namespaces/video.types.generated.d.ts +771 -0
  389. package/dist/rest/namespaces/video.types.generated.js +8 -0
  390. package/dist/rest/namespaces/video.types.generated.js.map +1 -0
  391. package/dist/rest/namespaces/voice.resources.generated.d.ts +9 -0
  392. package/dist/rest/namespaces/voice.resources.generated.js +17 -0
  393. package/dist/rest/namespaces/voice.resources.generated.js.map +1 -0
  394. package/dist/rest/namespaces/voice.types.generated.d.ts +214 -0
  395. package/dist/rest/namespaces/voice.types.generated.js +8 -0
  396. package/dist/rest/namespaces/voice.types.generated.js.map +1 -0
  397. package/dist/rest/pagination.d.ts +5 -1
  398. package/dist/rest/pagination.js +40 -20
  399. package/dist/rest/pagination.js.map +1 -1
  400. package/dist/rest/types.d.ts +21 -3
  401. package/dist/schema.json +299 -98
  402. package/dist/skills/SkillBase.d.ts +97 -20
  403. package/dist/skills/SkillBase.js +100 -17
  404. package/dist/skills/SkillBase.js.map +1 -1
  405. package/dist/skills/SkillManager.d.ts +66 -13
  406. package/dist/skills/SkillManager.js +101 -20
  407. package/dist/skills/SkillManager.js.map +1 -1
  408. package/dist/skills/SkillName.d.ts +44 -0
  409. package/dist/skills/SkillName.js +2 -0
  410. package/dist/skills/SkillName.js.map +1 -0
  411. package/dist/skills/SkillRegistry.d.ts +22 -11
  412. package/dist/skills/SkillRegistry.js +47 -17
  413. package/dist/skills/SkillRegistry.js.map +1 -1
  414. package/dist/skills/builtin/api_ninjas_trivia.d.ts +3 -1
  415. package/dist/skills/builtin/api_ninjas_trivia.js +18 -6
  416. package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -1
  417. package/dist/skills/builtin/ask_claude.d.ts +14 -4
  418. package/dist/skills/builtin/ask_claude.js +36 -14
  419. package/dist/skills/builtin/ask_claude.js.map +1 -1
  420. package/dist/skills/builtin/claude_skills.d.ts +3 -1
  421. package/dist/skills/builtin/claude_skills.js +19 -15
  422. package/dist/skills/builtin/claude_skills.js.map +1 -1
  423. package/dist/skills/builtin/custom_skills.d.ts +10 -3
  424. package/dist/skills/builtin/custom_skills.js +26 -9
  425. package/dist/skills/builtin/custom_skills.js.map +1 -1
  426. package/dist/skills/builtin/datasphere.d.ts +5 -3
  427. package/dist/skills/builtin/datasphere.js +21 -22
  428. package/dist/skills/builtin/datasphere.js.map +1 -1
  429. package/dist/skills/builtin/datasphere_serverless.d.ts +12 -1
  430. package/dist/skills/builtin/datasphere_serverless.js +17 -6
  431. package/dist/skills/builtin/datasphere_serverless.js.map +1 -1
  432. package/dist/skills/builtin/datetime.d.ts +3 -1
  433. package/dist/skills/builtin/datetime.js +11 -7
  434. package/dist/skills/builtin/datetime.js.map +1 -1
  435. package/dist/skills/builtin/google_maps.d.ts +29 -14
  436. package/dist/skills/builtin/google_maps.js +89 -269
  437. package/dist/skills/builtin/google_maps.js.map +1 -1
  438. package/dist/skills/builtin/index.d.ts +8 -6
  439. package/dist/skills/builtin/index.js +8 -6
  440. package/dist/skills/builtin/index.js.map +1 -1
  441. package/dist/skills/builtin/info_gatherer.d.ts +4 -2
  442. package/dist/skills/builtin/info_gatherer.js +20 -12
  443. package/dist/skills/builtin/info_gatherer.js.map +1 -1
  444. package/dist/skills/builtin/joke.d.ts +16 -6
  445. package/dist/skills/builtin/joke.js +54 -37
  446. package/dist/skills/builtin/joke.js.map +1 -1
  447. package/dist/skills/builtin/math.d.ts +3 -1
  448. package/dist/skills/builtin/math.js +14 -9
  449. package/dist/skills/builtin/math.js.map +1 -1
  450. package/dist/skills/builtin/mcp_gateway.d.ts +34 -5
  451. package/dist/skills/builtin/mcp_gateway.js +77 -46
  452. package/dist/skills/builtin/mcp_gateway.js.map +1 -1
  453. package/dist/skills/builtin/native_vector_search.d.ts +19 -5
  454. package/dist/skills/builtin/native_vector_search.js +179 -61
  455. package/dist/skills/builtin/native_vector_search.js.map +1 -1
  456. package/dist/skills/builtin/play_background_file.d.ts +21 -15
  457. package/dist/skills/builtin/play_background_file.js +43 -122
  458. package/dist/skills/builtin/play_background_file.js.map +1 -1
  459. package/dist/skills/builtin/spider.d.ts +42 -4
  460. package/dist/skills/builtin/spider.js +277 -104
  461. package/dist/skills/builtin/spider.js.map +1 -1
  462. package/dist/skills/builtin/swml_transfer.d.ts +14 -3
  463. package/dist/skills/builtin/swml_transfer.js +45 -24
  464. package/dist/skills/builtin/swml_transfer.js.map +1 -1
  465. package/dist/skills/builtin/weather_api.d.ts +24 -13
  466. package/dist/skills/builtin/weather_api.js +38 -30
  467. package/dist/skills/builtin/weather_api.js.map +1 -1
  468. package/dist/skills/builtin/web_search.d.ts +48 -10
  469. package/dist/skills/builtin/web_search.js +294 -100
  470. package/dist/skills/builtin/web_search.js.map +1 -1
  471. package/dist/skills/builtin/wikipedia_search.d.ts +4 -2
  472. package/dist/skills/builtin/wikipedia_search.js +14 -13
  473. package/dist/skills/builtin/wikipedia_search.js.map +1 -1
  474. package/dist/skills/index.d.ts +3 -2
  475. package/dist/skills/index.js +1 -1
  476. package/dist/skills/index.js.map +1 -1
  477. package/dist/swml_verbs_generated.d.ts +2824 -0
  478. package/dist/swml_verbs_generated.js +12 -0
  479. package/dist/swml_verbs_generated.js.map +1 -0
  480. package/dist/types.d.ts +59 -6
  481. package/dist/web.d.ts +27 -0
  482. package/dist/web.js +20 -0
  483. package/dist/web.js.map +1 -0
  484. package/docs/agent-guide.md +1034 -0
  485. package/docs/ai_chat.md +560 -0
  486. package/docs/api-reference.md +3534 -0
  487. package/docs/architecture.md +846 -0
  488. package/docs/bedrock_agent.md +411 -0
  489. package/docs/cli-guide.md +403 -0
  490. package/docs/cloud_functions_guide.md +399 -0
  491. package/docs/configuration.md +548 -0
  492. package/docs/contexts-guide.md +884 -0
  493. package/docs/datamap-guide.md +1160 -0
  494. package/docs/developer_pain_points.md +548 -0
  495. package/docs/llm_parameters.md +298 -0
  496. package/docs/mcp_gateway_reference.md +354 -0
  497. package/docs/mcp_integration.md +162 -0
  498. package/docs/pgi_agent_guide.md +1820 -0
  499. package/docs/prefabs-guide.md +815 -0
  500. package/docs/programmatically_governed_inference.md +301 -0
  501. package/docs/sdk_features.md +501 -0
  502. package/docs/security.md +559 -0
  503. package/docs/serverless-guide.md +520 -0
  504. package/docs/skills-guide.md +1223 -0
  505. package/docs/skills-system.md +405 -0
  506. package/docs/skills_parameter_schema.md +417 -0
  507. package/docs/swaig-reference.md +1938 -0
  508. package/docs/swml_service_guide.md +573 -0
  509. package/docs/third_party_skills.md +410 -0
  510. package/docs/web_service.md +666 -0
  511. package/examples/README.md +202 -0
  512. package/examples/advanced-datamap.ts +108 -0
  513. package/examples/advanced-dynamic-config.ts +70 -0
  514. package/examples/auto-vivified.ts +95 -0
  515. package/examples/call-flow.ts +65 -0
  516. package/examples/comprehensive-dynamic.ts +125 -0
  517. package/examples/contexts-steps.ts +65 -0
  518. package/examples/custom-path.ts +45 -0
  519. package/examples/datamap-tools.ts +51 -0
  520. package/examples/datasphere-multi-instance.ts +66 -0
  521. package/examples/datasphere-serverless-env.ts +87 -0
  522. package/examples/datasphere-webhook-env.ts +65 -0
  523. package/examples/datasphere.ts +56 -0
  524. package/examples/declarative.ts +100 -0
  525. package/examples/dynamic-config.ts +54 -0
  526. package/examples/dynamic-info-gatherer.ts +69 -0
  527. package/examples/dynamic-swml-service.ts +67 -0
  528. package/examples/gather-info.ts +95 -0
  529. package/examples/gather-per-question-functions-demo.ts +139 -0
  530. package/examples/joke-agent.ts +34 -0
  531. package/examples/kubernetes-agent.ts +45 -0
  532. package/examples/llm-params.ts +75 -0
  533. package/examples/mcp-agent.ts +89 -0
  534. package/examples/mcp-gateway.ts +81 -0
  535. package/examples/multi-agent.ts +80 -0
  536. package/examples/multi-endpoint.ts +79 -0
  537. package/examples/pgi/case-domain.ts +114 -0
  538. package/examples/pgi/serve.ts +16 -0
  539. package/examples/pgi/support-agent.ts +265 -0
  540. package/examples/pom-prompt.ts +70 -0
  541. package/examples/prefab-concierge.ts +42 -0
  542. package/examples/prefab-faq.ts +58 -0
  543. package/examples/prefab-info-gatherer.ts +33 -0
  544. package/examples/prefab-receptionist.ts +36 -0
  545. package/examples/prefab-survey.ts +69 -0
  546. package/examples/quickstart-agent.ts +29 -0
  547. package/examples/quickstart-relay.ts +25 -0
  548. package/examples/quickstart-rest.ts +25 -0
  549. package/examples/record-call.ts +65 -0
  550. package/examples/relay-demo.ts +33 -0
  551. package/examples/room-and-sip.ts +93 -0
  552. package/examples/serverless-lambda.ts +43 -0
  553. package/examples/session-state.ts +83 -0
  554. package/examples/simple-agent.ts +36 -0
  555. package/examples/simple-static.ts +29 -0
  556. package/examples/skills-demo.ts +41 -0
  557. package/examples/step-function-inheritance-demo.ts +124 -0
  558. package/examples/swaig-features.ts +193 -0
  559. package/examples/swml-service-routing.ts +66 -0
  560. package/examples/swml-service.ts +38 -0
  561. package/examples/swmlservice_ai_sidecar.ts +104 -0
  562. package/examples/swmlservice_swaig_standalone.ts +79 -0
  563. package/examples/tap.ts +67 -0
  564. package/examples/typed-tools.ts +68 -0
  565. package/examples/verb-methods.ts +45 -0
  566. package/examples/web-search-multi-instance.ts +75 -0
  567. package/examples/web-search.ts +38 -0
  568. package/examples/wikipedia.ts +36 -0
  569. package/livewire/README.md +164 -0
  570. package/livewire/docs/migration-guide.md +251 -0
  571. package/livewire/examples/livewire-basic-agent.ts +74 -0
  572. package/livewire/examples/livewire-handoff.ts +196 -0
  573. package/livewire/examples/livewire-multi-tool.ts +121 -0
  574. package/package.json +85 -13
  575. package/relay/README.md +101 -0
  576. package/relay/docs/call-methods.md +622 -0
  577. package/relay/docs/client-reference.md +281 -0
  578. package/relay/docs/events.md +193 -0
  579. package/relay/docs/getting-started.md +221 -0
  580. package/relay/docs/guide.md +386 -0
  581. package/relay/docs/messaging.md +246 -0
  582. package/relay/examples/relay-inbound.ts +66 -0
  583. package/relay/examples/relay-messaging.ts +74 -0
  584. package/relay/examples/relay-outbound.ts +76 -0
  585. package/rest/README.md +141 -0
  586. package/rest/docs/calling.md +313 -0
  587. package/rest/docs/client-reference.md +149 -0
  588. package/rest/docs/fabric.md +192 -0
  589. package/rest/docs/getting-started.md +138 -0
  590. package/rest/docs/guide.md +421 -0
  591. package/rest/docs/namespaces.md +367 -0
  592. package/rest/docs/phone-binding.md +116 -0
  593. package/rest/examples/rest-10dlc-registration.ts +177 -0
  594. package/rest/examples/rest-bind-phone-to-swml-webhook.ts +66 -0
  595. package/rest/examples/rest-calling-ivr-and-ai.ts +136 -0
  596. package/rest/examples/rest-calling-play-and-record.ts +98 -0
  597. package/rest/examples/rest-client.ts +59 -0
  598. package/rest/examples/rest-datasphere-search.ts +81 -0
  599. package/rest/examples/rest-fabric-conferences-and-routing.ts +147 -0
  600. package/rest/examples/rest-fabric-subscribers-and-sip.ts +106 -0
  601. package/rest/examples/rest-fabric-swml-and-callflows.ts +101 -0
  602. package/rest/examples/rest-manage-resources.ts +64 -0
  603. package/rest/examples/rest-phone-number-management.ts +200 -0
  604. package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
  605. package/rest/examples/rest-video-rooms.ts +186 -0
  606. package/tutorial/fred/fred.ts +218 -0
  607. package/tutorial/fred/tutorial/01-introduction.md +141 -0
  608. package/tutorial/fred/tutorial/02-setup.md +304 -0
  609. package/tutorial/fred/tutorial/03-basic-agent.md +284 -0
  610. package/tutorial/fred/tutorial/04-wikipedia-skill.md +298 -0
  611. package/tutorial/fred/tutorial/05-custom-functions.md +347 -0
  612. package/tutorial/fred/tutorial/06-running-testing.md +642 -0
  613. package/tutorial/fred/tutorial/README.md +56 -0
  614. package/tutorial/fred/tutorial/appendix-complete-code.md +632 -0
  615. package/tutorial/fred/tutorial/appendix-docker-deployment.md +504 -0
  616. package/tutorial/full-guardrails-agent/handlers.ts +436 -0
  617. package/tutorial/full-guardrails-agent/penny.ts +305 -0
  618. package/tutorial/full-guardrails-agent/reservations.ts +1109 -0
  619. package/tutorial/full-guardrails-agent/tutorial/01-why-guardrails.md +149 -0
  620. package/tutorial/full-guardrails-agent/tutorial/02-design-first.md +139 -0
  621. package/tutorial/full-guardrails-agent/tutorial/03-rules-first.md +422 -0
  622. package/tutorial/full-guardrails-agent/tutorial/04-the-shell.md +238 -0
  623. package/tutorial/full-guardrails-agent/tutorial/05-steps-and-scoping.md +247 -0
  624. package/tutorial/full-guardrails-agent/tutorial/06-tools-that-decide.md +467 -0
  625. package/tutorial/full-guardrails-agent/tutorial/07-gather-and-projection.md +160 -0
  626. package/tutorial/full-guardrails-agent/tutorial/08-the-verification-gate.md +333 -0
  627. package/tutorial/full-guardrails-agent/tutorial/09-people-and-endings.md +313 -0
  628. package/tutorial/full-guardrails-agent/tutorial/10-testing-and-running.md +387 -0
  629. package/tutorial/full-guardrails-agent/tutorial/README.md +106 -0
  630. package/tutorial/full-guardrails-agent/tutorial/appendix-complete-code.md +2207 -0
  631. package/tutorial/full-guardrails-agent/tutorial/appendix-deployment.md +191 -0
  632. package/tutorial/full-guardrails-agent/tutorial/appendix-technique-map.md +117 -0
  633. package/tutorial/full-guardrails-agent/workflow.ts +219 -0
  634. package/tutorial/multi_agents/README.md +175 -0
  635. package/tutorial/multi_agents/advanced_agent.ts +395 -0
  636. package/tutorial/multi_agents/extending_agents.ts +641 -0
  637. package/tutorial/multi_agents/knowledge.ts +59 -0
  638. package/tutorial/multi_agents/lesson1_first_agent.md +368 -0
  639. package/tutorial/multi_agents/lesson2_knowledge_bases.md +404 -0
  640. package/tutorial/multi_agents/lesson3_multi_agent_systems.md +621 -0
  641. package/tutorial/multi_agents/lesson4_advanced_features.md +805 -0
  642. package/tutorial/multi_agents/lesson5_extending_agents.md +856 -0
  643. package/tutorial/multi_agents/pc_builder.ts +529 -0
  644. package/tutorial/multi_agents/sales_agent.ts +88 -0
  645. package/tutorial/multi_agents/sales_agent_with_search.ts +116 -0
  646. package/tutorial/multi_agents/sales_knowledge.md +139 -0
  647. package/tutorial/multi_agents/support_knowledge.md +256 -0
  648. package/dist/cli/mock-data.d.ts +0 -37
  649. package/dist/cli/mock-data.js +0 -80
  650. package/dist/cli/mock-data.js.map +0 -1
  651. package/dist/generateVerbTypes.d.ts +0 -11
  652. package/dist/generateVerbTypes.js +0 -265
  653. package/dist/generateVerbTypes.js.map +0 -1
  654. package/dist/rest/namespaces/compat.d.ts +0 -585
  655. package/dist/rest/namespaces/compat.js +0 -735
  656. package/dist/rest/namespaces/compat.js.map +0 -1
@@ -0,0 +1,65 @@
1
+ /**
2
+ * Contexts & Steps Example
3
+ *
4
+ * Multi-step conversation workflows where the AI follows a structured
5
+ * sequence of steps, each with its own prompt, criteria, and allowed tools.
6
+ * Run: npx tsx examples/contexts-steps.ts
7
+ */
8
+
9
+ import { AgentBase, FunctionResult } from '@signalwire/sdk';
10
+
11
+ export const agent = new AgentBase({
12
+ name: 'quiz-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('You are a fun quiz host named Quizzy.');
21
+
22
+ // Define tools
23
+ agent.defineTool({
24
+ name: 'get_score',
25
+ description: 'Get the current score for the player',
26
+ parameters: {},
27
+ handler: () => new FunctionResult('The player has 3 out of 5 correct.'),
28
+ });
29
+
30
+ agent.defineTool({
31
+ name: 'submit_answer',
32
+ description: 'Submit an answer to the current question',
33
+ parameters: {
34
+ answer: { type: 'string', description: 'The answer to check' },
35
+ },
36
+ handler: (args) => {
37
+ return new FunctionResult(`The answer "${args.answer}" has been recorded.`);
38
+ },
39
+ });
40
+
41
+ // Define the conversation flow
42
+ const ctx = agent.defineContexts();
43
+ const quiz = ctx.addContext('default');
44
+
45
+ // Step 1: Greet the player
46
+ quiz
47
+ .addStep('greeting', { task: 'Welcome the player and explain the quiz rules.' })
48
+ .setStepCriteria('Player has acknowledged the rules and is ready to start')
49
+ .setFunctions('none') // No tools needed for greeting
50
+ .setValidSteps(['question']);
51
+
52
+ // Step 2: Ask questions
53
+ quiz
54
+ .addStep('question', { task: 'Ask the player a trivia question and evaluate their answer.' })
55
+ .setStepCriteria('Player has answered the question')
56
+ .setFunctions(['submit_answer'])
57
+ .setValidSteps(['question', 'results']);
58
+
59
+ // Step 3: Show results
60
+ quiz
61
+ .addStep('results', { task: 'Show the final score and thank the player for playing.' })
62
+ .setFunctions(['get_score'])
63
+ .setEnd(true);
64
+
65
+ agent.serve();
@@ -0,0 +1,45 @@
1
+ /**
2
+ * Custom Path Example
3
+ *
4
+ * Agent running on a custom HTTP path instead of the default '/'.
5
+ * Useful for hosting agents at specific URL paths behind a reverse proxy.
6
+ * Run: npx tsx examples/custom-path.ts
7
+ * Test: curl http://user:pass@localhost:3000/my-custom-agent
8
+ */
9
+
10
+ import { AgentBase, FunctionResult } from '@signalwire/sdk';
11
+
12
+ export const agent = new AgentBase({
13
+ name: 'custom-path-agent',
14
+ route: '/my-custom-agent',
15
+ port: 3000,
16
+ basicAuth: [
17
+ process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
18
+ process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
19
+ ],
20
+ });
21
+
22
+ agent.setPromptText(
23
+ 'You are a helpful assistant hosted at a custom URL path. ' +
24
+ 'Tell the caller your name and offer to help.',
25
+ );
26
+
27
+ agent.defineTool({
28
+ name: 'get_agent_info',
29
+ description: 'Get information about this agent including its URL path',
30
+ parameters: {},
31
+ handler: () => {
32
+ return new FunctionResult(
33
+ `This agent is running at the custom path /my-custom-agent on port 3000.`,
34
+ );
35
+ },
36
+ });
37
+
38
+ agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
39
+
40
+ // When using a proxy, set the external URL so webhooks resolve correctly
41
+ if (process.env['SWML_PROXY_URL_BASE']) {
42
+ agent.manualSetProxyUrl(process.env['SWML_PROXY_URL_BASE']);
43
+ }
44
+
45
+ agent.serve();
@@ -0,0 +1,51 @@
1
+ /**
2
+ * DataMap Tools Example
3
+ *
4
+ * Two tools that call external APIs without a webhook endpoint of your own.
5
+ * The SignalWire platform makes each request and expands the output
6
+ * template from the data_map definition. In a webhook's output, the JSON
7
+ * response is read from the root of the template data
8
+ * (`${current_condition[0].temp_F}`), with no `response.` prefix, and the
9
+ * arguments are under `input` (`${input.args.city}`). The URL reads the
10
+ * arguments as `${args.city}`.
11
+ * Run: npx tsx examples/datamap-tools.ts
12
+ * Test: npx tsx src/cli/swaig-test.ts examples/datamap-tools.ts --exec get_weather --city London
13
+ */
14
+
15
+ import { AgentBase, DataMap, FunctionResult, createSimpleApiTool } from '@signalwire/sdk';
16
+
17
+ export const agent = new AgentBase({
18
+ name: 'weather-agent',
19
+ route: '/',
20
+ basicAuth: [
21
+ process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
22
+ process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
23
+ ],
24
+ });
25
+
26
+ agent.setPromptText('You are a weather assistant. Help users check the weather in any city.');
27
+
28
+ // Method 1: build a DataMap with the builder methods
29
+ const weatherTool = new DataMap('get_weather')
30
+ .purpose('Get current weather for a city')
31
+ .parameter('city', 'string', 'The city name', { required: true })
32
+ .webhook('GET', 'https://wttr.in/${lc:enc:args.city}?format=j1')
33
+ .output(
34
+ new FunctionResult(
35
+ 'Weather in ${input.args.city}: ${current_condition[0].temp_F}°F, ${current_condition[0].weatherDesc[0].value}',
36
+ ),
37
+ )
38
+ .fallbackOutput(new FunctionResult('Sorry, I could not fetch the weather for that city.'));
39
+
40
+ agent.registerSwaigFunction(weatherTool.toSwaigFunction());
41
+
42
+ // Method 2: the createSimpleApiTool helper, for one GET request and one output
43
+ const jokeTool = createSimpleApiTool({
44
+ name: 'get_joke',
45
+ url: 'https://official-joke-api.appspot.com/random_joke',
46
+ responseTemplate: 'Here is a joke: ${setup} ... ${punchline}',
47
+ });
48
+
49
+ agent.registerSwaigFunction(jokeTool.toSwaigFunction());
50
+
51
+ agent.serve();
@@ -0,0 +1,66 @@
1
+ /**
2
+ * DataSphere Multiple Instance Demo
3
+ *
4
+ * Loads the DataSphere skill multiple times with different knowledge bases
5
+ * and custom tool names. Each instance searches a different document.
6
+ * Run: npx tsx examples/datasphere-multi-instance.ts
7
+ */
8
+
9
+ import { AgentBase, DataSphereSkill, DateTimeSkill, MathSkill } from '@signalwire/sdk';
10
+
11
+ export const agent = new AgentBase({
12
+ name: 'multi-datasphere',
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 an assistant with access to multiple knowledge bases. ' +
22
+ 'Use the appropriate search tool depending on the topic.',
23
+ );
24
+
25
+ agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
26
+
27
+ // Add utility skills
28
+ await agent.addSkill(new DateTimeSkill());
29
+ await agent.addSkill(new MathSkill());
30
+
31
+ // Instance 1: Drinks knowledge base
32
+ await agent.addSkill(
33
+ new DataSphereSkill({
34
+ document_id: 'drinks-doc-123',
35
+ tool_name: 'search_drinks_knowledge',
36
+ count: 2,
37
+ distance: 5.0,
38
+ }),
39
+ );
40
+
41
+ // Instance 2: Food knowledge base
42
+ await agent.addSkill(
43
+ new DataSphereSkill({
44
+ document_id: 'food-doc-456',
45
+ tool_name: 'search_food_knowledge',
46
+ count: 3,
47
+ distance: 4.0,
48
+ }),
49
+ );
50
+
51
+ // Instance 3: General knowledge (default tool name)
52
+ await agent.addSkill(
53
+ new DataSphereSkill({
54
+ document_id: 'general-doc-789',
55
+ count: 1,
56
+ distance: 3.0,
57
+ }),
58
+ );
59
+
60
+ console.log(
61
+ 'Loaded skills:',
62
+ agent.listSkills().map((s) => s.name),
63
+ );
64
+ console.log('Note: Replace document IDs with your actual DataSphere documents.');
65
+
66
+ agent.serve();
@@ -0,0 +1,87 @@
1
+ /**
2
+ * DataSphere Serverless Environment Demo
3
+ *
4
+ * Loads the DataSphere Serverless skill with configuration from environment
5
+ * variables, showing best practices for production deployment.
6
+ *
7
+ * Required env vars:
8
+ * SIGNALWIRE_SPACE, SIGNALWIRE_PROJECT_ID, SIGNALWIRE_API_TOKEN,
9
+ * DATASPHERE_DOCUMENT_ID
10
+ *
11
+ * Optional env vars:
12
+ * DATASPHERE_COUNT, DATASPHERE_DISTANCE, DATASPHERE_TAGS, DATASPHERE_LANGUAGE
13
+ *
14
+ * Run: npx tsx examples/datasphere-serverless-env.ts
15
+ */
16
+
17
+ import { AgentBase, DataSphereServerlessSkill, DateTimeSkill, MathSkill } from '@signalwire/sdk';
18
+
19
+ function requireEnv(name: string): string {
20
+ const value = process.env[name];
21
+ if (!value) {
22
+ console.error(`Error: Required environment variable ${name} is not set.`);
23
+ console.error(
24
+ 'Required: SIGNALWIRE_SPACE, SIGNALWIRE_PROJECT_ID, SIGNALWIRE_API_TOKEN, DATASPHERE_DOCUMENT_ID',
25
+ );
26
+ process.exit(1);
27
+ }
28
+ return value;
29
+ }
30
+
31
+ // The serverless skill builds https://<space_name>.signalwire.com itself, so
32
+ // it takes the space name, not the host.
33
+ const spaceName = requireEnv('SIGNALWIRE_SPACE').replace(/\.signalwire\.com$/, '');
34
+ const projectId = requireEnv('SIGNALWIRE_PROJECT_ID');
35
+ const token = requireEnv('SIGNALWIRE_API_TOKEN');
36
+ const documentId = requireEnv('DATASPHERE_DOCUMENT_ID');
37
+ const count = parseInt(process.env['DATASPHERE_COUNT'] ?? '3', 10);
38
+ const distance = parseFloat(process.env['DATASPHERE_DISTANCE'] ?? '4.0');
39
+ const tags = process.env['DATASPHERE_TAGS']
40
+ ?.split(',')
41
+ .map((t) => t.trim())
42
+ .filter(Boolean);
43
+ const language = process.env['DATASPHERE_LANGUAGE'];
44
+
45
+ export const agent = new AgentBase({
46
+ name: 'datasphere-env',
47
+ route: '/',
48
+ basicAuth: [
49
+ process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
50
+ process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
51
+ ],
52
+ });
53
+
54
+ agent.setPromptText(
55
+ 'You are a knowledge assistant with access to a document library. ' +
56
+ 'Search the knowledge base to answer user questions. Always cite the source.',
57
+ );
58
+
59
+ agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
60
+
61
+ await agent.addSkill(new DateTimeSkill());
62
+ await agent.addSkill(new MathSkill());
63
+
64
+ // The serverless skill renders the search as a DataMap tool, which the
65
+ // SignalWire platform runs without a webhook to this agent. It reads its
66
+ // credentials from these parameters only, not from the environment.
67
+ await agent.addSkill(
68
+ new DataSphereServerlessSkill({
69
+ space_name: spaceName,
70
+ project_id: projectId,
71
+ token,
72
+ document_id: documentId,
73
+ count,
74
+ distance,
75
+ ...(tags ? { tags } : {}),
76
+ ...(language ? { language } : {}),
77
+ }),
78
+ );
79
+
80
+ console.log(`DataSphere Serverless Environment Demo`);
81
+ console.log(` Document: ${documentId}`);
82
+ console.log(` Max results: ${count}`);
83
+ console.log(` Distance threshold: ${distance}`);
84
+ if (tags) console.log(` Tags: ${tags.join(', ')}`);
85
+ if (language) console.log(` Language: ${language}`);
86
+
87
+ agent.serve();
@@ -0,0 +1,65 @@
1
+ /**
2
+ * DataSphere Webhook Environment Demo
3
+ *
4
+ * Loads the traditional webhook-based DataSphere skill with environment variable
5
+ * configuration. Compare with datasphere-serverless-env.ts for the serverless approach.
6
+ *
7
+ * Required env vars:
8
+ * SIGNALWIRE_SPACE, SIGNALWIRE_PROJECT_ID, SIGNALWIRE_API_TOKEN,
9
+ * DATASPHERE_DOCUMENT_ID
10
+ *
11
+ * Run: npx tsx examples/datasphere-webhook-env.ts
12
+ */
13
+
14
+ import { AgentBase, DataSphereSkill, DateTimeSkill, MathSkill } from '@signalwire/sdk';
15
+
16
+ function requireEnv(name: string): string {
17
+ const value = process.env[name];
18
+ if (!value) {
19
+ console.error(`Error: Required environment variable ${name} is not set.`);
20
+ process.exit(1);
21
+ }
22
+ return value;
23
+ }
24
+
25
+ const documentId = requireEnv('DATASPHERE_DOCUMENT_ID');
26
+ const count = parseInt(process.env['DATASPHERE_COUNT'] ?? '3', 10);
27
+ const distance = parseFloat(process.env['DATASPHERE_DISTANCE'] ?? '4.0');
28
+
29
+ export const agent = new AgentBase({
30
+ name: 'datasphere-webhook',
31
+ route: '/',
32
+ basicAuth: [
33
+ process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
34
+ process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
35
+ ],
36
+ });
37
+
38
+ agent.setPromptText(
39
+ 'You are a knowledge assistant with access to a document library via webhook. ' +
40
+ 'Use the search tool to find answers from the knowledge base.',
41
+ );
42
+
43
+ agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
44
+
45
+ await agent.addSkill(new DateTimeSkill());
46
+ await agent.addSkill(new MathSkill());
47
+
48
+ // Webhook-based DataSphere skill (traditional approach)
49
+ await agent.addSkill(
50
+ new DataSphereSkill({
51
+ document_id: documentId,
52
+ count,
53
+ distance,
54
+ }),
55
+ );
56
+
57
+ console.log('DataSphere Webhook Environment Demo');
58
+ console.log(` Document: ${documentId}`);
59
+ console.log(` Execution: Webhook-based (traditional)`);
60
+ console.log('');
61
+ console.log('WEBHOOK vs SERVERLESS:');
62
+ console.log(' Webhook: Full control over request/response, custom error handling');
63
+ console.log(' Serverless: No webhook infrastructure, lower latency, executes on SignalWire');
64
+
65
+ agent.serve();
@@ -0,0 +1,56 @@
1
+ /**
2
+ * DataSphere Skill Example
3
+ *
4
+ * Uses the DataSphere skill to search a document in a SignalWire DataSphere
5
+ * knowledge base. Set DATASPHERE_DOCUMENT_ID to the document to search, and
6
+ * SIGNALWIRE_SPACE, SIGNALWIRE_PROJECT_ID and SIGNALWIRE_API_TOKEN to the
7
+ * credentials the skill uses. Without them the agent starts with no search
8
+ * tool and prints what to set.
9
+ * Run: npx tsx examples/datasphere.ts
10
+ */
11
+
12
+ import { AgentBase, DataSphereSkill } from '@signalwire/sdk';
13
+
14
+ export const agent = new AgentBase({
15
+ name: 'knowledge-agent',
16
+ route: '/',
17
+ basicAuth: [
18
+ process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
19
+ process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
20
+ ],
21
+ });
22
+
23
+ agent.setPromptText(
24
+ 'You are a knowledge assistant with access to a document library. ' +
25
+ 'Use the search tool to find answers to user questions from the knowledge base. ' +
26
+ 'Always cite the source when providing information from the knowledge base.',
27
+ );
28
+
29
+ const documentId = process.env['DATASPHERE_DOCUMENT_ID'];
30
+ const missing = [
31
+ 'DATASPHERE_DOCUMENT_ID',
32
+ 'SIGNALWIRE_SPACE',
33
+ 'SIGNALWIRE_PROJECT_ID',
34
+ 'SIGNALWIRE_API_TOKEN',
35
+ ].filter((name) => !process.env[name]);
36
+
37
+ if (documentId && missing.length === 0) {
38
+ // count is the number of results to return, and distance the largest
39
+ // distance a result may have (lower is more relevant).
40
+ await agent.addSkill(
41
+ new DataSphereSkill({
42
+ document_id: documentId,
43
+ count: 3,
44
+ distance: 4.0,
45
+ }),
46
+ );
47
+ } else {
48
+ console.error(
49
+ `DataSphere not configured, so the agent starts without the search tool. Set ${missing.join(', ')}.`,
50
+ );
51
+ }
52
+
53
+ agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
54
+ agent.addHints(['DataSphere', 'knowledge base', 'documentation']);
55
+
56
+ agent.serve();
@@ -0,0 +1,100 @@
1
+ /**
2
+ * Declarative Agent Example
3
+ *
4
+ * Demonstrates creating an agent using class inheritance with static
5
+ * PROMPT_SECTIONS and the defineTools() lifecycle method, instead of
6
+ * the imperative new AgentBase() + method-chaining approach.
7
+ * Run: npx tsx examples/declarative.ts
8
+ */
9
+
10
+ import { AgentBase, FunctionResult } from '@signalwire/sdk';
11
+ import type { AgentOptions } from '@signalwire/sdk';
12
+
13
+ class HelpDeskAgent extends AgentBase {
14
+ // Declarative prompt sections — applied automatically in the constructor
15
+ static override PROMPT_SECTIONS = [
16
+ {
17
+ title: 'Role',
18
+ body: 'You are a help desk agent for Acme Software Inc.',
19
+ },
20
+ {
21
+ title: 'Personality',
22
+ body: 'You are professional, patient, and solution-oriented.',
23
+ bullets: [
24
+ 'Always greet the user warmly.',
25
+ 'Ask clarifying questions before troubleshooting.',
26
+ 'Summarize the solution at the end of each interaction.',
27
+ ],
28
+ },
29
+ {
30
+ title: 'Knowledge',
31
+ bullets: [
32
+ 'Acme Software sells a project management tool called AcmePM.',
33
+ 'Common issues: login problems, slow performance, missing data.',
34
+ 'Tier 1 support can reset passwords and clear caches.',
35
+ 'Tier 2 issues should be escalated to a supervisor.',
36
+ ],
37
+ },
38
+ ];
39
+
40
+ constructor(opts: AgentOptions) {
41
+ super(opts);
42
+ this.defineTools();
43
+ }
44
+
45
+ protected override defineTools(): void {
46
+ this.defineTool({
47
+ name: 'reset_password',
48
+ description: 'Reset a user password by their email address',
49
+ parameters: {
50
+ email: { type: 'string', description: 'User email address' },
51
+ },
52
+ handler: (args) => {
53
+ return new FunctionResult(
54
+ `Password reset email sent to ${args.email}. It will arrive within 5 minutes.`,
55
+ );
56
+ },
57
+ });
58
+
59
+ this.defineTool({
60
+ name: 'check_system_status',
61
+ description: 'Check the current system status of AcmePM',
62
+ parameters: {},
63
+ handler: () => {
64
+ return new FunctionResult(
65
+ 'AcmePM system status: All services operational. No known outages.',
66
+ );
67
+ },
68
+ });
69
+
70
+ this.defineTool({
71
+ name: 'escalate_ticket',
72
+ description: 'Escalate an issue to Tier 2 support',
73
+ parameters: {
74
+ issue: { type: 'string', description: 'Description of the issue' },
75
+ },
76
+ handler: (args) => {
77
+ const result = new FunctionResult(
78
+ `Issue escalated to Tier 2: "${args.issue}". A specialist will follow up within 2 hours.`,
79
+ );
80
+ return result;
81
+ },
82
+ });
83
+ }
84
+ }
85
+
86
+ export const agent = new HelpDeskAgent({
87
+ name: 'help-desk',
88
+ route: '/',
89
+ basicAuth: [
90
+ process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
91
+ process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
92
+ ],
93
+ });
94
+
95
+ agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
96
+ agent.setPostPrompt(
97
+ 'Summarize this support call as JSON: { issue_type, resolution, escalated, follow_up_needed }',
98
+ );
99
+
100
+ agent.serve();
@@ -0,0 +1,54 @@
1
+ /**
2
+ * Dynamic Configuration Example
3
+ *
4
+ * Customize agent behavior per-request based on query parameters,
5
+ * headers, or request body. Each request gets an ephemeral copy
6
+ * of the agent, so modifications don't affect other callers.
7
+ * Run: npx tsx examples/dynamic-config.ts
8
+ */
9
+
10
+ import { AgentBase, FunctionResult } from '@signalwire/sdk';
11
+
12
+ export const agent = new AgentBase({
13
+ name: 'dynamic-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('You are a helpful assistant.');
22
+
23
+ agent.defineTool({
24
+ name: 'greet',
25
+ description: 'Greet the user by name',
26
+ parameters: {},
27
+ handler: () => new FunctionResult('Hello!'),
28
+ });
29
+
30
+ // Customize the agent per-request
31
+ agent.setDynamicConfigCallback(async (queryParams, bodyParams, headers, agentCopy) => {
32
+ const copy = agentCopy as AgentBase;
33
+
34
+ // Customize based on query params (e.g., ?lang=es&name=Carlos)
35
+ const lang = queryParams['lang'];
36
+ if (lang === 'es') {
37
+ copy.setPromptText('Eres un asistente amigable. Responde siempre en español.');
38
+ copy.setLanguages([{ name: 'Spanish', code: 'es-ES', voice: 'polly.Lucia' }]);
39
+ } else if (lang === 'fr') {
40
+ copy.setPromptText('Vous êtes un assistant sympathique. Répondez toujours en français.');
41
+ copy.setLanguages([{ name: 'French', code: 'fr-FR', voice: 'polly.Celine' }]);
42
+ }
43
+
44
+ // Customize based on caller info from the request body
45
+ const callerName = queryParams['name'] ?? (bodyParams['caller_name'] as string);
46
+ if (callerName) {
47
+ copy.setGlobalData({ caller_name: callerName });
48
+ copy.setPromptText(
49
+ `You are a helpful assistant. The caller's name is ${callerName}. Greet them by name.`,
50
+ );
51
+ }
52
+ });
53
+
54
+ agent.serve();
@@ -0,0 +1,69 @@
1
+ /**
2
+ * Dynamic InfoGatherer Example
3
+ *
4
+ * Shows how to use InfoGathererAgent in dynamic mode with a callback
5
+ * function that chooses the question set based on the request's query
6
+ * string.
7
+ *
8
+ * Run: npx tsx examples/dynamic-info-gatherer.ts
9
+ * Test:
10
+ * curl http://user:pass@localhost:3000/?set=support
11
+ * curl http://user:pass@localhost:3000/?set=medical
12
+ */
13
+
14
+ import { InfoGathererAgent } from '@signalwire/sdk';
15
+ import type { InfoGathererQuestion } from '@signalwire/sdk';
16
+
17
+ const questionSets: Record<string, InfoGathererQuestion[]> = {
18
+ default: [
19
+ { key_name: 'name', question_text: 'What is your full name?' },
20
+ { key_name: 'phone', question_text: 'What is a good callback number?' },
21
+ { key_name: 'reason', question_text: 'How can I help you today?' },
22
+ ],
23
+ support: [
24
+ { key_name: 'customer_name', question_text: 'What is your name?' },
25
+ { key_name: 'account_number', question_text: 'What is your account number?', confirm: true },
26
+ { key_name: 'issue', question_text: 'Describe the issue you are experiencing.' },
27
+ { key_name: 'priority', question_text: 'Is this low, medium, or high priority?' },
28
+ ],
29
+ medical: [
30
+ { key_name: 'patient_name', question_text: "What is the patient's full name?" },
31
+ { key_name: 'symptoms', question_text: 'What are the current symptoms?' },
32
+ { key_name: 'duration', question_text: 'How long have these symptoms been present?' },
33
+ { key_name: 'medications', question_text: 'Is the patient taking any medications?' },
34
+ ],
35
+ onboarding: [
36
+ { key_name: 'full_name', question_text: 'What is your full name?' },
37
+ { key_name: 'email', question_text: 'What is your email address?', confirm: true },
38
+ { key_name: 'company', question_text: 'What company do you work for?' },
39
+ { key_name: 'department', question_text: 'What department will you be working in?' },
40
+ { key_name: 'start_date', question_text: 'What is your start date?' },
41
+ ],
42
+ };
43
+
44
+ export const agent = new InfoGathererAgent({
45
+ name: 'dynamic-intake',
46
+ // No `questions` → dynamic mode. Callback resolves them per request.
47
+ questionCallback: (queryParams) => {
48
+ const set = queryParams['set'] ?? 'default';
49
+ console.log(`Dynamic question set: ${set}`);
50
+ return questionSets[set] ?? questionSets['default']!; // 'default' is a defined literal key
51
+ },
52
+ agentOptions: {
53
+ route: '/',
54
+ basicAuth: [
55
+ process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
56
+ process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
57
+ ],
58
+ },
59
+ });
60
+
61
+ agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
62
+
63
+ console.log('Dynamic InfoGatherer Agent');
64
+ console.log(' /?set=default (name, phone, reason)');
65
+ console.log(' /?set=support (customer support intake)');
66
+ console.log(' /?set=medical (medical intake)');
67
+ console.log(' /?set=onboarding (employee onboarding)');
68
+
69
+ agent.serve();