@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,403 @@
1
+ # swaig-test CLI Guide
2
+
3
+ `swaig-test` loads an agent file and lets you inspect its SWML, list its SWAIG functions, and call one, without a phone call or a deployment.
4
+
5
+ ---
6
+
7
+ ## Table of Contents
8
+
9
+ The guide has these sections:
10
+
11
+ - [Overview](#overview)
12
+ - [Running It](#running-it)
13
+ - [Finding the Agent](#finding-the-agent)
14
+ - [Actions](#actions)
15
+ - [--dump-swml](#--dump-swml)
16
+ - [--list-tools](#--list-tools)
17
+ - [--exec](#--exec)
18
+ - [--list-agents](#--list-agents)
19
+ - [Function Arguments](#function-arguments)
20
+ - [The Simulated Request](#the-simulated-request)
21
+ - [Dynamic Agents](#dynamic-agents)
22
+ - [DataMap Functions](#datamap-functions)
23
+ - [Environment Variables](#environment-variables)
24
+ - [Serverless Simulation](#serverless-simulation)
25
+ - [Output](#output)
26
+ - [sw-tsdocs: The SDK's Installed Documentation](#sw-tsdocs-the-sdks-installed-documentation)
27
+ - [Option Reference](#option-reference)
28
+
29
+ ---
30
+
31
+ ## Overview
32
+
33
+ `swaig-test` sends its requests through the agent's own HTTP app, as SignalWire would:
34
+
35
+ - The SWML is requested with a simulated call. Basic auth, signature checks, a dynamic config callback and the tokens in the webhook URLs all run as they do on a server.
36
+ - A function is called at the `web_hook_url` its SWML gives it, with that URL's token and query. A function that points at another server is called there.
37
+ - A DataMap function runs in a local simulator of the platform's DataMap processing.
38
+
39
+ The CLI's code is in these source files:
40
+
41
+ - `src/cli/swaig-test.ts`: the command and its options.
42
+ - `src/cli/agent-loader.ts`: finding the agent in a file.
43
+ - `src/cli/simulation.ts`: the simulated request data and serverless environments.
44
+ - `src/cli/function-args.ts`: function arguments.
45
+ - `src/cli/datamap-exec.ts`: the DataMap simulator.
46
+
47
+ ---
48
+
49
+ ## Running It
50
+
51
+ Run the CLI with `npx tsx` during development:
52
+
53
+ ```bash
54
+ npx tsx src/cli/swaig-test.ts <agent-file> [options]
55
+ ```
56
+
57
+ A built package runs the compiled file:
58
+
59
+ ```bash
60
+ node dist/cli/swaig-test.js <agent-file> [options]
61
+ ```
62
+
63
+ The agent file is a `.ts`, `.js`, `.mjs` or `.mts` file. Without a TypeScript loader, Node runs a `.ts` file by stripping its types, and it doesn't map an import of `./handlers.js` to `./handlers.ts`, so an agent split across several `.ts` files fails with `ERR_MODULE_NOT_FOUND`. Install `tsx` in the project and load it into the installed command:
64
+
65
+ <!-- snippet: no-run needs an installed package, tsx and a multi-file agent -->
66
+ ```bash
67
+ npm install -D tsx
68
+ NODE_OPTIONS='--import tsx' npx swaig-test penny.ts --list-tools
69
+ ```
70
+
71
+ These print the help, the serverless options and a set of examples:
72
+
73
+ ```bash
74
+ npx tsx src/cli/swaig-test.ts --help
75
+ npx tsx src/cli/swaig-test.ts --help-platforms
76
+ npx tsx src/cli/swaig-test.ts --help-examples
77
+ ```
78
+
79
+ `--parse-only` (or `--dry-run`) checks the arguments and exits without loading the agent. It prints `parse OK` on success:
80
+
81
+ ```bash
82
+ npx tsx src/cli/swaig-test.ts examples/simple-agent.ts --exec get_time --parse-only
83
+ ```
84
+
85
+ ---
86
+
87
+ ## Finding the Agent
88
+
89
+ The file is imported with `SWAIG_CLI_MODE=true`, so `serve()` and `run()` return without starting a server. The loader then takes, in order:
90
+
91
+ | Order | What it takes |
92
+ |---|---|
93
+ | 1 | With `--agent-class NAME`, that export: an instance, or a class it instantiates. |
94
+ | 2 | With `--route ROUTE`, the service with that route, exported or not. |
95
+ | 3 | The `agent` export, then the default export, then any exported agent instance. |
96
+ | 4 | An exported agent class, instantiated with `{ name: 'cli-agent' }`. |
97
+ | 5 | An exported `SWMLService`. |
98
+ | 6 | A service the file constructed without exporting it. |
99
+
100
+ The last case covers a file like the quickstart, which builds `const agent = new AgentBase(...)` and calls `agent.run()`. When a file constructs several services without exporting them, such as agents registered on an `AgentServer`, choose one with `--route`:
101
+
102
+ ```bash
103
+ npx tsx src/cli/swaig-test.ts examples/multi-agent.ts --list-agents
104
+ npx tsx src/cli/swaig-test.ts examples/multi-agent.ts --route /support --list-tools
105
+ ```
106
+
107
+ `--route` and `--agent-class` can't be used together.
108
+
109
+ ---
110
+
111
+ ## Actions
112
+
113
+ Each run takes one action. Without one, the CLI exits with an error, except with `--simulate-serverless`, where it prints the SWML.
114
+
115
+ ### --dump-swml
116
+
117
+ This prints the SWML document the agent serves for a simulated call:
118
+
119
+ ```bash
120
+ npx tsx src/cli/swaig-test.ts examples/simple-agent.ts --dump-swml
121
+ ```
122
+
123
+ The output is the JSON document alone, indented. `--raw` prints it on one line. SDK logging is off unless `--verbose` is given, so the output can be piped:
124
+
125
+ ```bash
126
+ npx tsx src/cli/swaig-test.ts examples/simple-agent.ts --dump-swml --raw | jq '.sections.main'
127
+ ```
128
+
129
+ ### --list-tools
130
+
131
+ This lists the functions in the agent's SWML, with their parameters. A function's type follows its name. `(LOCAL webhook)` marks a handler in the agent, and `(EXTERNAL webhook)` one on another server. A DataMap function has no marker.
132
+
133
+ ```bash
134
+ npx tsx src/cli/swaig-test.ts examples/datamap-tools.ts --list-tools
135
+ ```
136
+
137
+ The output lists both of the file's DataMap functions:
138
+
139
+ ```text
140
+ Available SWAIG functions:
141
+ get_weather - Get current weather for a city
142
+ Parameters:
143
+ city (string) (required): The city name
144
+ get_joke - Execute get_joke
145
+ Parameters: None
146
+ ```
147
+
148
+ `get_joke` has no description of its own, so the SDK's default, `Execute <name>`, appears.
149
+
150
+ With `--raw` or `--format-json` the list is JSON, one object per function with `name`, `description`, `parameters` and `type` (`local`, `external` or `datamap`).
151
+
152
+ ### --exec
153
+
154
+ This calls one function and prints its result. Everything after the function name is an argument for the function. See [Function Arguments](#function-arguments).
155
+
156
+ ```bash
157
+ npx tsx src/cli/swaig-test.ts examples/simple-agent.ts --exec get_time
158
+ ```
159
+
160
+ The output starts with `RESULT:`, then the response and any actions:
161
+
162
+ ```text
163
+ RESULT:
164
+ Response: The current date and time is 9/28/2026, 5:53:03 PM
165
+ ```
166
+
167
+ `--raw` or `--format-json` prints the SWAIG response as JSON instead. The exit status is 1 when the function isn't found, an argument doesn't fit, or the call fails.
168
+
169
+ ### --list-agents
170
+
171
+ This lists the agents and services in the file, exported or not:
172
+
173
+ ```bash
174
+ npx tsx src/cli/swaig-test.ts examples/multi-agent.ts --list-agents
175
+ ```
176
+
177
+ For each instance it prints its name and route.
178
+
179
+ ---
180
+
181
+ ## Function Arguments
182
+
183
+ Put the CLI's own options before `--exec`. After the function name, each `--name value` is an argument, typed by the function's parameter schema:
184
+
185
+ | Parameter type | Value |
186
+ |---|---|
187
+ | `integer` | Parsed as an integer; anything else is an error. |
188
+ | `number` | Parsed as a number; anything else is an error. |
189
+ | `boolean` | `true` or `false` after it, or nothing (the flag alone is `true`). |
190
+ | `array` | Split on commas. |
191
+ | other | The string. |
192
+
193
+ A dash in a name becomes an underscore, so `--max-results 5` sets `max_results`. `--arg name=value` also sets an argument, parsing the value as JSON when it can.
194
+
195
+ These commands call `book_appointment` in `examples/typed-tools.ts`, whose `party_size` parameter is an integer:
196
+
197
+ ```bash
198
+ npx tsx src/cli/swaig-test.ts examples/typed-tools.ts --exec book_appointment --service haircut --party-size 2 --notes "window seat"
199
+ npx tsx src/cli/swaig-test.ts examples/typed-tools.ts --exec book_appointment --arg service=massage --arg party_size=3
200
+ ```
201
+
202
+ The first command prints this result:
203
+
204
+ ```text
205
+ RESULT:
206
+ Response: Booked a haircut for 2 (window seat). See you soon!
207
+ ```
208
+
209
+ A value that doesn't fit its type stops the run. `--party-size two` prints `Error parsing arguments: Parameter --party-size must be an integer, got: two`.
210
+
211
+ An argument the function doesn't declare is still passed, with a warning on stderr. For `--foo bar`, the warning is `Warning: --foo isn't a parameter of this function; it was passed to the function anyway.`
212
+
213
+ When an undeclared argument has the name of a CLI option, such as `--raw`, the warning says to put it before `--exec`. When that option ends the line with no value after it, as in `--exec get_time --verbose`, the CLI stops instead. It prints `Error parsing arguments: CLI flag --verbose must come BEFORE --exec, not after.` and exits with status 1. A function can declare a parameter with an option's name. `check_status` in `examples/typed-tools.ts` has a `verbose` parameter, so `--exec check_status --verbose` sets it.
214
+
215
+ ---
216
+
217
+ ## The Simulated Request
218
+
219
+ `--dump-swml` and `--list-tools` send the SWML request SignalWire sends: a `call` object with the call's id, type, direction, state and addresses, `vars.userVariables`, and `envs`. `--exec` requests the SWML the same way, then calls the function. Its request has every key SignalWire may send (`call`, `vars`, `global_data`, `call_log`, `meta_data` and the rest). `--minimal` sends only the call id and the arguments.
220
+
221
+ These options set values in the request, for every action:
222
+
223
+ | Option | Sets |
224
+ |---|---|
225
+ | `--call-type sip\|webrtc` | The call type and matching addresses (default `webrtc`). |
226
+ | `--call-direction inbound\|outbound` | `call.direction` (default `inbound`). |
227
+ | `--call-state STATE` | `call.state` (default `created`). |
228
+ | `--call-id ID` | `call_id` and `call.call_id`. |
229
+ | `--project-id ID`, `--space-id ID` | `call.project_id`, `call.space_id`. |
230
+ | `--from-number NUMBER`, `--to-extension EXT` | `call.from`, `call.to`. |
231
+ | `--user-vars JSON` | `vars.userVariables`. |
232
+ | `--custom-data JSON` | Values merged into the function request. A DataMap function reads them as the call data the platform adds, such as `global_data`; without `global_data`, it reads the agent's global data. |
233
+
234
+ `--override PATH=VALUE` sets any value by its dotted path, and `--override-json PATH=JSON` sets one to parsed JSON. A value of `true`, `false`, `null` or a number is typed. Anything else is a string, or JSON when it parses. This command marks the call answered and sets a user variable:
235
+
236
+ ```bash
237
+ npx tsx src/cli/swaig-test.ts examples/simple-agent.ts --override call.state=answered --override-json 'vars.userVariables={"vip":true}' --dump-swml
238
+ ```
239
+
240
+ An override whose path isn't in the simulated request, such as a misspelled `call.stat`, still applies, with a warning on stderr.
241
+
242
+ ---
243
+
244
+ ## Dynamic Agents
245
+
246
+ An agent with a dynamic config callback gets the request's query parameters, headers and body, as on a server. These options set them:
247
+
248
+ | Option | Sets |
249
+ |---|---|
250
+ | `--query-params JSON` | The SWML request's query parameters (also merged into `vars.userVariables`). |
251
+ | `--header NAME=VALUE` | A request header (repeatable). |
252
+ | `--body JSON` | Extra fields in the SWML request body. |
253
+ | `--method POST\|GET` | The SWML request's method (default `POST`). |
254
+
255
+ The callback runs once per request, on a per-request copy of the agent, so it runs once for `--dump-swml`. A function call is a separate request: as on the platform, it carries only the query in its `web_hook_url`. A callback that needs a value from the SWML request when a function runs puts it there with `addSwaigQueryParams()`. The callback in `examples/dynamic-config.ts` reads `lang` and `name` from the query. This command sends both, and prints the prompt, languages and global data the callback set:
256
+
257
+ ```bash
258
+ npx tsx src/cli/swaig-test.ts examples/dynamic-config.ts --query-params '{"lang":"es","name":"Carlos"}' --dump-swml --raw | jq -c '.sections.main[] | select(.ai) | {prompt: .ai.prompt.text, lang: .ai.languages, gd: .ai.global_data}'
259
+ ```
260
+
261
+ The output shows the Spanish voice and the caller's name:
262
+
263
+ ```json
264
+ {"prompt":"You are a helpful assistant. The caller's name is Carlos. Greet them by name.","lang":[{"name":"Spanish","code":"es-ES","voice":"polly.Lucia"}],"gd":{"caller_name":"Carlos"}}
265
+ ```
266
+
267
+ ---
268
+
269
+ ## DataMap Functions
270
+
271
+ `--exec` runs a DataMap function in a local simulator that follows the platform's processing. It tries the top-level expressions, then the webhooks in order, skipping one when none of its `require_args` is set or it has neither `output` nor `expressions`. The first webhook it requests ends the webhook stage: it runs that webhook's `foreach`, its `expressions` against the response, and its `output`. The DataMap's own `output` is the result when that webhook failed, when none was requested, or when its expressions didn't match and it has no `output`. When nothing produces a result, the result is the platform's generic error, `{"response": "There was an error processing this request."}`, and `swaig-test` says so on stderr. It exits with status 0, since that is a valid result on the platform, not a failure of the tool.
272
+
273
+ The simulator follows the platform's template rules:
274
+
275
+ - The top-level expressions and output, and a webhook's `url` and `params`, read the call data: the function's name, `meta_data`, the arguments under `args` (`${args.city}`), and an empty `input`. The top-level output also has `prompt_vars`. `--custom-data` gives the call data the platform adds, at its root: `--custom-data '{"global_data": {"tenant": "acme"}}'` makes `${global_data.tenant}` read `acme`. Without `global_data` in `--custom-data`, `global_data` is the agent's global data, as a call starts with it. The `prompt_vars` in `--custom-data` are merged into the root too, so `{"prompt_vars": {"time_of_day": "morning"}}` gives `${time_of_day}`.
276
+ - `meta_data` is the function's `meta_data` merged key by key over `global_data`, as the platform merges them when it loads the function, so `${meta_data.tenant}` reads a `global_data` key the function's `meta_data` doesn't set. A `meta_data` key in `--custom-data` isn't used.
277
+ - A webhook's `foreach`, `expressions` and `output` read its response. A JSON object response is read from the root (`${current.temp_f}`), and a JSON array response is under `array` (`${array[0].joke}`). `prompt_vars`, `global_data` and `input`, a copy of the call data, are added, so the arguments are `${input.args.city}` there.
278
+ - Names match without regard to case, as on the platform: `${ARGS.City}` reads `args.city`. A path that doesn't resolve expands to an empty string, as on the platform, and the simulator says so on stderr. The note adds a hint for a common mistake: `${response.<field>}`, `${args.<name>}` in a webhook's `foreach`, `expressions` or `output`, and `${input.<name>}` before a webhook responds.
279
+ - Templates take the platform's `lc`, `enc` and `fmt_ph` helpers. As on the platform, they apply in a fixed order, `fmt_ph`, then `lc`, then `enc`, whatever order they are written in, so `${lc:enc:args.city}` and `${enc:lc:args.city}` both lowercase the city, then URL-encode it. `enc` encodes the characters the platform encodes, so `/`, `,` and `$` stay as they are. `fmt_ph` formats a number with libphonenumber on the platform. The simulator does the same with the optional `libphonenumber-js` package, a JavaScript port of libphonenumber, when it's installed (`npm install -D libphonenumber-js`): a valid number in its national format, reading one without a country code as a US number, so `+12025550143` is `(202) 555-0143` and `+442079460958` is `020 7946 0958`, and `INVALID NUMBER` for one that isn't valid. The port leaves out vanity numbers, so the simulator reads them first, as libphonenumber does: when a number has three or more letters, they are keypad digits, so `1-800-FLOWERS` is `(800) 356-9377`, and `412-535-2223 now` is `INVALID NUMBER`. The port's number data can differ from the platform's libphonenumber version, so a rare number can format differently. Without the package, the simulator formats only a North American number, vanity numbers included, and leaves another value as it is, saying so on stderr.
280
+ - Any other name before a colon is part of the path, as on the platform: `${enc:url:args.city}` reads the path `url:args.city`, which doesn't resolve. The simulator's note suggests `${enc:args.city}`.
281
+ - A template nested in a path expands first, one level deep: `${meta_data.contacts.${lc:args.dept}}`. A template expands once, so a value that holds text such as `${global_data.x}` is inserted as it is. The exception is a matched webhook expression's result, which the platform expands a second time.
282
+ - A value that isn't a string is inserted as the platform prints it: `72.5` as `72.500000`, and an object as JSON over several lines. An output is expanded as JSON text and parsed, as on the platform, so a template that inserts an object or array inside a string breaks the output. The simulator then returns an `error` that says so, and `swaig-test` prints it and exits with status 0.
283
+ - A webhook fails on an empty body, a body that isn't JSON, a request that doesn't complete, or one of its `error_keys` present in a JSON object response, whatever the value. A status outside 200-299 doesn't fail it; the output reads it as `${http_code}`. A request that doesn't complete gives `http_code` as curl reports it on the platform: the last status received, a redirect's included, or `0` when no response came back. An `error_keys` on the `data_map` itself is ignored, as on the platform.
284
+ - `params`, with the arguments merged in when `input_args_as_params` is set, is the request body. A webhook is sent as a `POST` when its method is `POST` or when it has `params`, whatever its method, and as a `GET` otherwise. A `POST` without `params` has no body. With `form_param`, the body is one form field holding the JSON. Header values are sent as written. Credentials in the `url`, as in `https://user:pass@host/`, are sent as basic authentication.
285
+ - `expressions` and `webhooks` can each be a single object instead of a list, as on the platform. A single expression runs as a one-element list. A single webhook's `require_args` and `error_keys` aren't checked, and a failed request doesn't fail it: its output reads the error response, such as `${parse_error}` and `${http_code}`.
286
+ - Redirects are followed as the platform's curl follows them: from any 3xx response with a `Location`, up to 15, and a `POST` is sent again, with its body, after any of them. Credentials go only to the origin they were given for. Every request, redirects included, refuses private and internal addresses, as the SDK's other URL fetches do. Set `SWML_ALLOW_PRIVATE_URLS=true` to test against a server on your own machine.
287
+
288
+ This command runs the weather tool against the real wttr.in API and prints each step:
289
+
290
+ ```bash
291
+ npx tsx src/cli/swaig-test.ts examples/datamap-tools.ts --verbose --exec get_weather --city London
292
+ ```
293
+
294
+ With `--verbose`, the output ends with the DataMap steps: the request, the response status and the result.
295
+
296
+ ```text
297
+ === DataMap Function Execution ===
298
+ Args: {"city":"London"}
299
+
300
+ === Webhook 1/1 ===
301
+ GET https://wttr.in/london?format=j1
302
+ Response status: 200
303
+ RESULT:
304
+ Response: Weather in London: 61°F, Overcast
305
+ ```
306
+
307
+ The simulator's differences from the platform are listed in [Testing a DataMap](datamap-guide.md#testing-a-datamap).
308
+
309
+ ---
310
+
311
+ ## Environment Variables
312
+
313
+ `--env KEY=VALUE` sets a variable before the agent file loads. `--env-file FILE` loads `KEY=VALUE` lines from a file, skipping `#` lines and removing quotes around a value. This command sets the basic auth user and loads the rest from `.env` in the current directory:
314
+
315
+ ```bash
316
+ npx tsx src/cli/swaig-test.ts examples/simple-agent.ts --env SWML_BASIC_AUTH_USER=admin --env-file .env --dump-swml
317
+ ```
318
+
319
+ Node.js checks every `--env-file` on its command line itself, even one after the script name. Node 22 and 24 both do, so it happens however you run the CLI: the installed `swaig-test`, `node dist/cli/swaig-test.js` and `npx tsx src/cli/swaig-test.ts` alike. When the file exists, Node doesn't load it and passes the option on, and `swaig-test` loads the file. When the file doesn't exist, Node stops before `swaig-test` runs, printing `node: .env: not found` with exit status 9. Check the path, or set the variables with `--env`.
320
+
321
+ ---
322
+
323
+ ## Serverless Simulation
324
+
325
+ `--simulate-serverless PLATFORM` loads and runs the agent with a serverless platform's environment, so its webhook URLs are the platform's. The platforms are `lambda`, `cgi`, `gcf` (or `cloud_function`) and `azure` (or `azure_function`). `SWML_PROXY_URL_BASE` is cleared for the run.
326
+
327
+ ```bash
328
+ npx tsx src/cli/swaig-test.ts examples/simple-agent.ts --simulate-serverless lambda --dump-swml
329
+ npx tsx src/cli/swaig-test.ts examples/simple-agent.ts --simulate-serverless lambda --aws-api-gateway-id abc123 --aws-stage prod --exec get_time
330
+ npx tsx src/cli/swaig-test.ts examples/simple-agent.ts --simulate-serverless cgi --cgi-host example.com --cgi-https --dump-swml
331
+ ```
332
+
333
+ Each platform's options set its variables:
334
+
335
+ | Platform | Options |
336
+ |---|---|
337
+ | `lambda` | `--aws-function-name`, `--aws-function-url`, `--aws-region`, `--aws-api-gateway-id` and `--aws-stage` (an API Gateway URL, `https://ID.execute-api.REGION.amazonaws.com/STAGE`) |
338
+ | `cgi` | `--cgi-host` (required), `--cgi-script-name`, `--cgi-https`, `--cgi-path-info` |
339
+ | `gcf` | `--gcp-project`, `--gcp-function-url`, `--gcp-region`, `--gcp-service` |
340
+ | `azure` | `--azure-env`, `--azure-function-url` |
341
+
342
+ Each platform starts from a preset environment with a sample function URL. When you give a part of the URL without the URL itself, the preset URL is dropped and the URL is built from the parts. A part can come from a flag, `--env` or `--env-file`. For Lambda, `--aws-function-name` or `--aws-region` (`AWS_LAMBDA_FUNCTION_NAME`, `AWS_REGION`) without `--aws-function-url` (`AWS_LAMBDA_FUNCTION_URL`) gives `https://NAME.lambda-url.REGION.on.aws`, with `test-agent-function` and `us-east-1` for the part you leave out. So `--env AWS_REGION=eu-west-1` gives a URL in `eu-west-1`. In the same way, `--gcp-project`, `--gcp-region` or `--gcp-service` without `--gcp-function-url` gives `https://REGION-PROJECT.cloudfunctions.net/SERVICE`. The Azure preset's URL is `https://my-function-app.azurewebsites.net/api/agent`; `--azure-function-url` replaces it.
343
+
344
+ The SDK reads some parts under two names, and prefers one: `GOOGLE_CLOUD_PROJECT` over `GCP_PROJECT`, `FUNCTION_REGION` over `GOOGLE_CLOUD_REGION`, `K_SERVICE` over `FUNCTION_TARGET`, and `WEBSITE_SITE_NAME` over `AZURE_FUNCTIONS_APP_NAME`. A part you give under the other name wins over the preset's value under the preferred one. So `--env GCP_PROJECT=production` gives a URL in the `production` project, and `--env AZURE_FUNCTIONS_APP_NAME=prod-app` one on `prod-app.azurewebsites.net`.
345
+
346
+ An unknown platform is an error, and the CLI exits with status 2. It never falls back to running as a server.
347
+
348
+ ---
349
+
350
+ ## Output
351
+
352
+ | Option | Effect |
353
+ |---|---|
354
+ | `--raw` | JSON only, with SDK logging off. |
355
+ | `--format-json` | JSON results, indented. |
356
+ | `-v`, `--verbose` | Each step, the requests sent, and debug logging. |
357
+
358
+ Warnings go to stderr, so they don't mix with JSON on stdout.
359
+
360
+ ---
361
+
362
+ ## sw-tsdocs: The SDK's Installed Documentation
363
+
364
+ `sw-tsdocs` prints the SDK's documentation for the installed version. It's written for people and for coding agents: the output is Markdown, with full paths to the docs and examples installed with the package. Run it with `npx` in a project that depends on `@signalwire/sdk` (`node dist/cli/tsdocs/bin.js` in a built clone):
365
+
366
+ ```bash
367
+ npx sw-tsdocs # the index: what the SDK does, where to start, every topic
368
+ npx sw-tsdocs agents # one topic: concepts, files to read, examples, API names
369
+ npx sw-tsdocs skills web_search # a built-in skill's parameters
370
+ npx sw-tsdocs api AgentBase # a signature, JSDoc and members, from the installed declarations
371
+ npx sw-tsdocs api FunctionResult.connect
372
+ npx sw-tsdocs examples contexts # the examples for a topic, or those matching a word
373
+ npx sw-tsdocs grep "setFunctions" # search the docs and examples; --code adds the SDK's code
374
+ npx sw-tsdocs show agent-guide --toc # a doc's headings; --section <heading> prints one section
375
+ npx sw-tsdocs path # where the package and its docs are installed
376
+ npx sw-tsdocs init # add a note about sw-tsdocs to this project's AGENTS.md
377
+ ```
378
+
379
+ The topics are short and hand-written: they describe concepts and known mistakes, and point to the installed docs for the rest. The facts come from the installed package: the version, the commands, the built-in skills and their parameters, the prefabs, the REST namespaces, the environment variables the code reads, and every signature and JSDoc comment. `api` reads an index of the package's `.d.ts` files that the build writes, so it works without the TypeScript source.
380
+
381
+ `sw-tsdocs init` adds a section to the project's `AGENTS.md` telling coding agents to use `sw-tsdocs`, and to `CLAUDE.md` if the project has one that doesn't import `AGENTS.md`. Run it again to update the section. `--skill` also writes an Agent Skills `SKILL.md` under `.agents/skills/` and `.claude/skills/`, `--dir` names the project, and `--print` prints the section without writing anything.
382
+
383
+ ---
384
+
385
+ ## Option Reference
386
+
387
+ | Option | Description |
388
+ |---|---|
389
+ | `--list-agents` | List the agents and services in the file. |
390
+ | `--list-tools` | List the SWAIG functions. |
391
+ | `--dump-swml` | Print the SWML document. |
392
+ | `--exec FUNCTION [args]` | Call a function; the rest of the line is its arguments. |
393
+ | `--agent-class NAME` | Use this export. |
394
+ | `--route ROUTE` | Use the service with this route. |
395
+ | `--raw`, `--format-json`, `-v`/`--verbose` | Output. |
396
+ | `--minimal`, `--fake-full-data`, `--custom-data JSON` | The function request. |
397
+ | `--call-type`, `--call-direction`, `--call-state`, `--call-id`, `--project-id`, `--space-id`, `--from-number`, `--to-extension`, `--user-vars` | Call data. |
398
+ | `--override PATH=VALUE`, `--override-json PATH=JSON` | Set values in the request (repeatable). |
399
+ | `--query-params JSON`, `--header NAME=VALUE`, `--body JSON`, `--method` | The SWML request. |
400
+ | `--env KEY=VALUE`, `--env-file FILE` | Environment variables. |
401
+ | `--simulate-serverless PLATFORM` and the platform options | Serverless simulation. |
402
+ | `--parse-only`, `--dry-run` | Check the arguments only. |
403
+ | `--help`, `--help-platforms`, `--help-examples` | Help. |