@signalwire/sdk 2.0.4 → 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 +550 -163
  6. package/dist/AgentBase.js +1640 -514
  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 +163 -0
  30. package/dist/POM/PromptObjectModel.js +481 -0
  31. package/dist/POM/PromptObjectModel.js.map +1 -0
  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 +28 -0
  42. package/dist/PomBuilder.js +81 -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 +29 -1
  48. package/dist/PromptManager.js +37 -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 +265 -66
  58. package/dist/SWMLService.js +652 -112
  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 +55 -8
  64. package/dist/SecurityUtils.js +162 -49
  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 +95 -34
  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 -367
  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 +102 -39
  169. package/dist/index.js +107 -30
  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 +79 -14
  204. package/dist/relay/RelayClient.js +268 -61
  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 +81 -39
  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 +63 -0
  245. package/dist/rest/callHandler.js +62 -0
  246. package/dist/rest/callHandler.js.map +1 -0
  247. package/dist/rest/index.d.ts +19 -76
  248. package/dist/rest/index.js +49 -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 -273
  284. package/dist/rest/namespaces/fabric.js +14 -363
  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 +9 -57
  332. package/dist/rest/namespaces/phone-numbers.js +9 -63
  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 +47 -7
  412. package/dist/skills/SkillRegistry.js +85 -13
  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 +24 -8
  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 +34 -25
  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 +46 -1
  460. package/dist/skills/builtin/spider.js +317 -101
  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 +57 -31
  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 +301 -84
  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 +32 -14
  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 +65 -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 +88 -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,251 @@
1
+ # Migrating a LiveKit Agent to LiveWire
2
+
3
+ This guide converts an existing LiveKit voice agent, written in TypeScript with `@livekit/agents`, to run on SignalWire with LiveWire. Most of the work is changing import paths, because LiveWire uses LiveKit's class and function names. A few LiveKit features behave differently or aren't implemented; [What LiveWire Ignores](../README.md#what-livewire-ignores) lists them.
4
+
5
+ ## Step 1: Change the Import Path
6
+
7
+ Replace all LiveKit agent imports with the LiveWire module:
8
+
9
+ <!-- snippet: no-compile before/after import comparison; the "Before" half imports the external `@livekit/*` packages that this SDK does not depend on -->
10
+ ```typescript
11
+ // Before (LiveKit)
12
+ import { defineAgent, type JobContext } from '@livekit/agents';
13
+ import { AgentSession } from '@livekit/agents/voice';
14
+ import { tool } from '@livekit/agents/llm';
15
+ import { DeepgramSTT } from '@livekit/agents-plugin-deepgram';
16
+ import { ElevenLabsTTS } from '@livekit/agents-plugin-elevenlabs';
17
+ import { SileroVAD } from '@livekit/agents-plugin-silero';
18
+
19
+ // After (LiveWire)
20
+ import {
21
+ defineAgent, JobContext, AgentSession, Agent, tool, RunContext,
22
+ plugins, runApp,
23
+ } from '@signalwire/sdk/livewire';
24
+ ```
25
+
26
+ Every LiveWire name comes from one module, so you don't install plugin packages.
27
+
28
+ ## Step 2: Update Type References
29
+
30
+ Replace LiveKit type names with their LiveWire equivalents. In most cases the names are identical:
31
+
32
+ <!-- snippet: no-compile before/after comparison fused in one fence; the "Before" half imports the external `@livekit/agents/voice` package and redeclares the same names as the "After" half -->
33
+ ```typescript
34
+ // Before (LiveKit)
35
+ import { Agent } from '@livekit/agents/voice';
36
+ const agent = new Agent({ instructions: 'Hello' });
37
+
38
+ // After (LiveWire)
39
+ import { Agent } from '@signalwire/sdk/livewire';
40
+ const agent = new Agent({ instructions: 'Hello' });
41
+ ```
42
+
43
+ ## Step 3: Update Session Options
44
+
45
+ LiveWire accepts the same session options. It ignores the STT, TTS and VAD options, because SignalWire's control plane runs the media pipeline. The `llm` option sets the `model` AI param. It takes a model name, from which LiveWire removes any `provider/` prefix, or an LLM plugin object such as `new plugins.OpenAILLM({ model: 'gpt-4o' })`, whose `model` it uses:
46
+
47
+ <!-- snippet: no-compile before/after comparison; the "Before" half uses LiveKit plugin classes (DeepgramSTT/ElevenLabsTTS/SileroVAD/OpenAILLM) from external packages and redeclares `session` -->
48
+ ```typescript
49
+ // Before (LiveKit)
50
+ const session = new AgentSession({
51
+ stt: new DeepgramSTT(),
52
+ tts: new ElevenLabsTTS(),
53
+ vad: SileroVAD.load(),
54
+ llm: new OpenAILLM({ model: 'gpt-4o' }),
55
+ });
56
+
57
+ // After (LiveWire)
58
+ const session = new AgentSession({
59
+ stt: 'deepgram', // ignored; the platform handles STT
60
+ tts: 'elevenlabs', // ignored; the platform handles TTS
61
+ vad: plugins.SileroVAD.load(), // ignored; the platform handles VAD
62
+ llm: 'openai/gpt-4o', // sets the model param to gpt-4o
63
+ });
64
+ ```
65
+
66
+ ## Step 4: Update Tool Definitions
67
+
68
+ LiveWire has the same `tool()` function. Its `parameters` must be a JSON Schema object:
69
+
70
+ <!-- snippet: no-compile before/after comparison; the "Before" half imports the external `@livekit/agents/llm` package plus Zod (`z`) and redeclares `getWeather` -->
71
+ ```typescript
72
+ // Before (LiveKit)
73
+ import { tool } from '@livekit/agents/llm';
74
+
75
+ const getWeather = tool({
76
+ description: 'Get weather for a location',
77
+ parameters: z.object({ location: z.string() }),
78
+ execute: async ({ location }) => `Sunny in ${location}`,
79
+ });
80
+
81
+ // After (LiveWire)
82
+ import { tool } from '@signalwire/sdk/livewire';
83
+
84
+ const getWeather = tool({
85
+ description: 'Get weather for a location',
86
+ parameters: {
87
+ type: 'object',
88
+ properties: {
89
+ location: { type: 'string', description: 'City name' },
90
+ },
91
+ },
92
+ execute: (params: { location: string }) => `Sunny in ${params.location}`,
93
+ });
94
+ ```
95
+
96
+ LiveWire doesn't convert a Zod schema to JSON Schema: it sends `parameters` to the platform as given. Rewrite Zod parameter schemas as JSON Schema objects. Pass tools to the agent as an object keyed by name, as in LiveKit (`tools: { getWeather }`); each key becomes the tool's name.
97
+
98
+ ## Step 5: Update the Entrypoint
99
+
100
+ The entry point keeps the LiveKit shape. `ctx.connect()` does nothing on SignalWire, and the `prewarm` callback still runs. Pass the definition to `runApp()`, which the complete example shows. When the entry function returns, `runApp()` serves the agent of the session it started:
101
+
102
+ <!-- snippet: no-compile before/after comparison fused in one fence; two default exports and `defineAgent` is only imported in prose elsewhere -->
103
+ ```typescript
104
+ // Before (LiveKit)
105
+ export default defineAgent({
106
+ prewarm: async (proc) => { /* warmup */ },
107
+ entry: async (ctx) => {
108
+ await ctx.connect();
109
+ // ... create session, agent, tools ...
110
+ },
111
+ });
112
+
113
+ // After (LiveWire)
114
+ export default defineAgent({
115
+ prewarm: (proc) => { /* runs; SignalWire has no worker processes to prewarm */ },
116
+ entry: async (ctx) => {
117
+ await ctx.connect(); // does nothing on SignalWire
118
+ // ... create session, agent, tools ...
119
+ },
120
+ });
121
+ ```
122
+
123
+ ## Step 6: Remove Infrastructure Configuration
124
+
125
+ A LiveKit agent often has configuration for these services:
126
+
127
+ - STT API keys and endpoints
128
+ - TTS API keys and endpoints
129
+ - VAD model paths
130
+ - LLM API keys
131
+ - WebRTC TURN/STUN servers
132
+ - Room service URLs
133
+
134
+ LiveWire doesn't use any of these settings, because SignalWire runs the media pipeline. You can remove them.
135
+
136
+ The agent's HTTP server reads its port and Basic Auth credentials from the environment:
137
+
138
+ ```bash
139
+ # HTTP server port (optional; the default is 3000)
140
+ export PORT=3000
141
+
142
+ # Basic Auth credentials SignalWire uses to fetch the agent's SWML
143
+ export SWML_BASIC_AUTH_USER=your-username
144
+ export SWML_BASIC_AUTH_PASSWORD=a-long-random-password
145
+
146
+ # Only if your code also uses the REST client
147
+ export SIGNALWIRE_PROJECT_ID=your-project-id
148
+ export SIGNALWIRE_API_TOKEN=your-api-token
149
+ export SIGNALWIRE_SPACE=example.signalwire.com
150
+ ```
151
+
152
+ ## Step 7: Deploy
153
+
154
+ A LiveWire agent runs as a Node.js HTTP server, which `runApp()` starts. Compile the agent with the TypeScript compiler, then run the output:
155
+
156
+ ```bash
157
+ # Build
158
+ npx tsc
159
+
160
+ # Run
161
+ node dist/my-agent.js
162
+ ```
163
+
164
+ Then point a SignalWire phone number at the agent's URL, with the Basic Auth credentials, so the platform requests its SWML for each call.
165
+
166
+ ## Complete Before/After Example
167
+
168
+ This section shows one agent written for LiveKit and the same agent converted to LiveWire.
169
+
170
+ ### Before (LiveKit)
171
+
172
+ The LiveKit version imports the plugin packages and a Zod schema:
173
+
174
+ <!-- snippet: no-compile the "Before" LiveKit reference example; imports the external `@livekit/*` packages this SDK does not depend on -->
175
+ ```typescript
176
+ import { defineAgent, type JobContext } from '@livekit/agents';
177
+ import { AgentSession } from '@livekit/agents/voice';
178
+ import { tool, Agent } from '@livekit/agents/llm';
179
+ import { DeepgramSTT } from '@livekit/agents-plugin-deepgram';
180
+ import { ElevenLabsTTS } from '@livekit/agents-plugin-elevenlabs';
181
+ import { SileroVAD } from '@livekit/agents-plugin-silero';
182
+
183
+ const greet = tool({
184
+ description: 'Greet someone by name',
185
+ parameters: z.object({ name: z.string() }),
186
+ execute: async ({ name }) => `Hello, ${name}!`,
187
+ });
188
+
189
+ export default defineAgent({
190
+ entry: async (ctx: JobContext) => {
191
+ await ctx.connect();
192
+ const session = new AgentSession({
193
+ stt: new DeepgramSTT(),
194
+ tts: new ElevenLabsTTS(),
195
+ vad: SileroVAD.load(),
196
+ });
197
+ const agent = new Agent({
198
+ instructions: 'You are a helpful assistant.',
199
+ tools: { greet },
200
+ });
201
+ await session.start({ agent, room: ctx.room });
202
+ },
203
+ });
204
+ ```
205
+
206
+ ### After (LiveWire)
207
+
208
+ The LiveWire version imports from one module and passes the provider names as strings:
209
+
210
+ <!-- snippet: no-run imports the @signalwire/sdk/livewire subpath which is not a resolvable package export standalone -->
211
+ ```typescript
212
+ import {
213
+ defineAgent, JobContext, AgentSession, Agent, tool,
214
+ plugins, runApp,
215
+ } from '@signalwire/sdk/livewire';
216
+
217
+ const greet = tool({
218
+ description: 'Greet someone by name',
219
+ parameters: {
220
+ type: 'object',
221
+ properties: { name: { type: 'string', description: 'Name to greet' } },
222
+ },
223
+ execute: (params: { name: string }) => `Hello, ${params.name}!`,
224
+ });
225
+
226
+ const agentDef = defineAgent({
227
+ entry: async (ctx: JobContext) => {
228
+ await ctx.connect();
229
+ const session = new AgentSession({
230
+ stt: 'deepgram',
231
+ tts: 'elevenlabs',
232
+ vad: plugins.SileroVAD.load(),
233
+ llm: 'openai/gpt-4o',
234
+ });
235
+ const agent = new Agent({
236
+ instructions: 'You are a helpful assistant.',
237
+ tools: { greet },
238
+ });
239
+ await session.start({ agent });
240
+ },
241
+ });
242
+
243
+ runApp(agentDef);
244
+ ```
245
+
246
+ The two versions differ in these ways:
247
+
248
+ 1. One import path instead of several plugin packages
249
+ 2. Provider names are strings instead of class instances
250
+ 3. The tool's `parameters` is a JSON Schema object instead of a Zod schema
251
+ 4. The definition is passed to `runApp()`, which serves the agent over HTTP
@@ -0,0 +1,74 @@
1
+ /**
2
+ * Example: Basic LiveWire agent with a single tool.
3
+ *
4
+ * Demonstrates the simplest possible LiveWire agent: an AI assistant
5
+ * with one function tool. This mirrors the standard @livekit/agents-js
6
+ * pattern -- just with a different import path.
7
+ *
8
+ * Run:
9
+ * npx tsx livewire/examples/livewire-basic-agent.ts
10
+ *
11
+ * Then point a SignalWire phone number at http://your-host:3000/
12
+ */
13
+
14
+ import {
15
+ Agent,
16
+ AgentSession,
17
+ tool,
18
+ defineAgent,
19
+ runApp,
20
+ type JobContext,
21
+ } from '@signalwire/sdk/livewire';
22
+
23
+ // Define a weather tool
24
+ const getWeather = tool({
25
+ description: 'Get current weather for a location',
26
+ parameters: {
27
+ type: 'object',
28
+ properties: {
29
+ location: { type: 'string', description: 'City name' },
30
+ },
31
+ required: ['location'],
32
+ },
33
+ execute: (params: { location: string }) => {
34
+ // In production, call a real weather API here
35
+ return `The weather in ${params.location} is sunny, 72F with clear skies.`;
36
+ },
37
+ });
38
+
39
+ // Define the agent using LiveKit-compatible API
40
+ const agentDef = defineAgent({
41
+ entry: async (ctx: JobContext) => {
42
+ // Connect is a noop on SignalWire -- the platform handles
43
+ // connection lifecycle automatically.
44
+ await ctx.connect();
45
+
46
+ // Configure the session. STT and TTS are noops -- SignalWire's
47
+ // control plane handles the media pipeline. LLM model selection
48
+ // is honored.
49
+ const session = new AgentSession({
50
+ stt: 'deepgram',
51
+ llm: 'openai/gpt-4',
52
+ tts: 'elevenlabs',
53
+ });
54
+
55
+ // Create an agent with instructions and a tool
56
+ const agent = new Agent({
57
+ instructions:
58
+ 'You are a helpful weather assistant. When asked about weather, use the get_weather tool.',
59
+ tools: { get_weather: getWeather },
60
+ });
61
+
62
+ // Start the session -- this binds the agent to SignalWire's
63
+ // AgentBase and registers all tools.
64
+ await session.start({ agent });
65
+
66
+ // Generate an initial greeting
67
+ session.generateReply({
68
+ instructions: 'Greet the user and ask how you can help with weather information.',
69
+ });
70
+ },
71
+ });
72
+
73
+ // Start the LiveWire agent
74
+ runApp(agentDef);
@@ -0,0 +1,196 @@
1
+ /**
2
+ * Example: Multi-agent with AgentHandoff.
3
+ *
4
+ * Demonstrates how to use AgentHandoff to switch between different
5
+ * agents within a single session. The triage agent determines the
6
+ * caller's intent and hands off to a specialized agent.
7
+ *
8
+ * Run:
9
+ * npx tsx livewire/examples/livewire-handoff.ts
10
+ *
11
+ * Then point a SignalWire phone number at http://your-host:3000/
12
+ */
13
+
14
+ import {
15
+ Agent,
16
+ AgentSession,
17
+ tool,
18
+ handoff,
19
+ defineAgent,
20
+ runApp,
21
+ type JobContext,
22
+ } from '@signalwire/sdk/livewire';
23
+
24
+ // ---------------------------------------------------------------------------
25
+ // Sales Agent
26
+ // ---------------------------------------------------------------------------
27
+
28
+ function createSalesAgent(): Agent {
29
+ const getPricing = tool({
30
+ description: 'Get pricing for a product',
31
+ parameters: {
32
+ type: 'object',
33
+ properties: {
34
+ product: { type: 'string', description: 'Product name' },
35
+ },
36
+ required: ['product'],
37
+ },
38
+ execute: (params: { product: string }) => {
39
+ console.log(`[sales] get_pricing called for: ${params.product}`);
40
+ return (
41
+ `The ${params.product} is available at $29.99/month or $299/year (save 17%). ` +
42
+ 'We also offer a 30-day free trial.'
43
+ );
44
+ },
45
+ });
46
+
47
+ const createOrder = tool({
48
+ description: 'Create an order for a product',
49
+ parameters: {
50
+ type: 'object',
51
+ properties: {
52
+ product: { type: 'string', description: 'Product name' },
53
+ plan: { type: 'string', description: 'Pricing plan (monthly or annual)' },
54
+ },
55
+ required: ['product', 'plan'],
56
+ },
57
+ execute: (params: { product: string; plan: string }) => {
58
+ console.log(`[sales] create_order: product=${params.product} plan=${params.plan}`);
59
+ return (
60
+ `Order created! You're now subscribed to ${params.product} on the ${params.plan} plan. ` +
61
+ 'A confirmation email will arrive shortly.'
62
+ );
63
+ },
64
+ });
65
+
66
+ return new Agent({
67
+ instructions:
68
+ 'You are a sales specialist at Acme Corp. You help customers ' +
69
+ 'find the right products and process orders. Be enthusiastic ' +
70
+ 'but not pushy. Always mention our satisfaction guarantee.',
71
+ tools: {
72
+ get_pricing: getPricing,
73
+ create_order: createOrder,
74
+ },
75
+ });
76
+ }
77
+
78
+ // ---------------------------------------------------------------------------
79
+ // Support Agent
80
+ // ---------------------------------------------------------------------------
81
+
82
+ function createSupportAgent(): Agent {
83
+ const checkSystemStatus = tool({
84
+ description: 'Check current system status',
85
+ execute: () => {
86
+ console.log('[support] check_system_status called');
87
+ return 'All systems operational. API uptime: 99.99%. No known issues.';
88
+ },
89
+ });
90
+
91
+ const resetPassword = tool({
92
+ description: 'Send a password reset email',
93
+ parameters: {
94
+ type: 'object',
95
+ properties: {
96
+ email: { type: 'string', description: 'User email address' },
97
+ },
98
+ required: ['email'],
99
+ },
100
+ execute: (params: { email: string }) => {
101
+ console.log(`[support] reset_password called for: ${params.email}`);
102
+ return `Password reset email sent to ${params.email}. The link expires in 30 minutes.`;
103
+ },
104
+ });
105
+
106
+ const createTicket = tool({
107
+ description: 'Create a support ticket',
108
+ parameters: {
109
+ type: 'object',
110
+ properties: {
111
+ issue: { type: 'string', description: 'Description of the issue' },
112
+ priority: { type: 'string', description: 'Priority level: low, medium, high' },
113
+ },
114
+ required: ['issue', 'priority'],
115
+ },
116
+ execute: (params: { issue: string; priority: string }) => {
117
+ console.log(`[support] create_ticket: issue=${params.issue} priority=${params.priority}`);
118
+ return (
119
+ `Support ticket #TKT-10042 created with ${params.priority} priority. ` +
120
+ 'Our team will respond within 4 hours.'
121
+ );
122
+ },
123
+ });
124
+
125
+ return new Agent({
126
+ instructions:
127
+ 'You are a technical support specialist at Acme Corp. You help ' +
128
+ 'customers troubleshoot issues, reset passwords, and resolve ' +
129
+ 'technical problems. Be patient and thorough.',
130
+ tools: {
131
+ check_system_status: checkSystemStatus,
132
+ reset_password: resetPassword,
133
+ create_ticket: createTicket,
134
+ },
135
+ });
136
+ }
137
+
138
+ // ---------------------------------------------------------------------------
139
+ // Triage Agent (entry point)
140
+ // ---------------------------------------------------------------------------
141
+
142
+ const agentDef = defineAgent({
143
+ entry: async (ctx: JobContext) => {
144
+ await ctx.connect();
145
+
146
+ // Pre-build the specialized agents
147
+ const salesAgent = createSalesAgent();
148
+ const supportAgent = createSupportAgent();
149
+
150
+ const session = new AgentSession({
151
+ llm: 'openai/gpt-4',
152
+ });
153
+
154
+ // Create handoff tools for the triage agent
155
+ const handoffToSales = tool({
156
+ description: 'Transfer the caller to the sales department',
157
+ execute: () => {
158
+ console.log('[triage] Handing off to sales agent');
159
+ session.say('Let me connect you to our sales team.');
160
+ // In a full implementation, handoff() would trigger a session swap
161
+ const _h = handoff({ agent: salesAgent });
162
+ return 'Connecting you to our sales team now.';
163
+ },
164
+ });
165
+
166
+ const handoffToSupport = tool({
167
+ description: 'Transfer the caller to technical support',
168
+ execute: () => {
169
+ console.log('[triage] Handing off to support agent');
170
+ session.say('Let me connect you to our technical support team.');
171
+ const _h = handoff({ agent: supportAgent });
172
+ return 'Connecting you to our technical support team now.';
173
+ },
174
+ });
175
+
176
+ const triageAgent = new Agent({
177
+ instructions:
178
+ 'You are the front-desk receptionist at Acme Corp. Your job is to ' +
179
+ 'understand what the caller needs and route them to the right department. ' +
180
+ 'Ask clarifying questions if needed, then use the appropriate handoff tool.',
181
+ tools: {
182
+ handoff_to_sales: handoffToSales,
183
+ handoff_to_support: handoffToSupport,
184
+ },
185
+ });
186
+
187
+ await session.start({ agent: triageAgent });
188
+ session.generateReply({
189
+ instructions:
190
+ 'Welcome the caller to Acme Corp. Ask whether they need help ' +
191
+ 'with sales, purchasing, or technical support.',
192
+ });
193
+ },
194
+ });
195
+
196
+ runApp(agentDef);
@@ -0,0 +1,121 @@
1
+ /**
2
+ * Example: LiveWire agent with multiple function tools and RunContext.
3
+ *
4
+ * Demonstrates registering several tools on an agent and using RunContext
5
+ * to access session state. Mirrors a typical @livekit/agents-js pattern.
6
+ *
7
+ * Run:
8
+ * npx tsx livewire/examples/livewire-multi-tool.ts
9
+ *
10
+ * Then point a SignalWire phone number at http://your-host:3000/
11
+ */
12
+
13
+ import {
14
+ Agent,
15
+ AgentSession,
16
+ tool,
17
+ defineAgent,
18
+ runApp,
19
+ type RunContext,
20
+ type JobContext,
21
+ } from '@signalwire/sdk/livewire';
22
+
23
+ // Tool 1: Check order status
24
+ const checkOrder = tool({
25
+ description: 'Check the status of a customer order',
26
+ parameters: {
27
+ type: 'object',
28
+ properties: {
29
+ order_id: { type: 'string', description: 'The order ID to check, e.g. ORD-12345' },
30
+ },
31
+ required: ['order_id'],
32
+ },
33
+ execute: (params: { order_id: string }, context: { ctx: RunContext }) => {
34
+ console.log(`[tool] check_order called with: ${params.order_id}`);
35
+ // RunContext gives the tool the session's userData, kept across tool calls.
36
+ const data = context.ctx.userData as { ordersChecked?: string[] };
37
+ data.ordersChecked = [...(data.ordersChecked ?? []), params.order_id];
38
+ console.log(`[tool] orders checked this session: ${data.ordersChecked.join(', ')}`);
39
+ const delivery = new Date(Date.now() + 48 * 60 * 60 * 1000).toLocaleDateString();
40
+ return `Order ${params.order_id} is currently in transit. Expected delivery: ${delivery}`;
41
+ },
42
+ });
43
+
44
+ // Tool 2: Product lookup
45
+ const lookupProduct = tool({
46
+ description: 'Search for product information',
47
+ parameters: {
48
+ type: 'object',
49
+ properties: {
50
+ query: { type: 'string', description: 'Product name or keyword to search for' },
51
+ },
52
+ required: ['query'],
53
+ },
54
+ execute: (params: { query: string }) => {
55
+ console.log(`[tool] lookup_product called with: ${params.query}`);
56
+ return (
57
+ `Found 3 products matching '${params.query}': ` +
58
+ '1) Acme Widget Pro ($29.99) ' +
59
+ '2) Acme Widget Lite ($14.99) ' +
60
+ '3) Acme Widget Bundle ($39.99)'
61
+ );
62
+ },
63
+ });
64
+
65
+ // Tool 3: Schedule callback
66
+ const scheduleCallback = tool({
67
+ description: 'Schedule a callback from a human agent',
68
+ execute: () => {
69
+ const callbackTime = new Date(Date.now() + 2 * 60 * 60 * 1000).toLocaleTimeString();
70
+ return `Callback scheduled for ${callbackTime}. An agent will call you back.`;
71
+ },
72
+ });
73
+
74
+ // Tool 4: Escalate to human
75
+ const escalate = tool({
76
+ description: 'Escalate the call to a human agent',
77
+ parameters: {
78
+ type: 'object',
79
+ properties: {
80
+ reason: { type: 'string', description: 'Reason for escalation' },
81
+ },
82
+ required: ['reason'],
83
+ },
84
+ execute: (params: { reason: string }) => {
85
+ const reason = params.reason.toLowerCase();
86
+ let department = 'general support';
87
+ if (reason.includes('billing')) department = 'billing';
88
+ else if (reason.includes('technical')) department = 'technical support';
89
+ return `Transferring you to ${department}. Please hold.`;
90
+ },
91
+ });
92
+
93
+ const agentDef = defineAgent({
94
+ entry: async (ctx: JobContext) => {
95
+ await ctx.connect();
96
+
97
+ const session = new AgentSession({
98
+ llm: 'openai/gpt-4',
99
+ });
100
+
101
+ const agent = new Agent({
102
+ instructions:
103
+ 'You are a helpful customer support agent for Acme Corp. ' +
104
+ 'You can check order status, look up product information, ' +
105
+ 'and schedule callbacks. Be concise and helpful.',
106
+ tools: {
107
+ check_order: checkOrder,
108
+ lookup_product: lookupProduct,
109
+ schedule_callback: scheduleCallback,
110
+ escalate: escalate,
111
+ },
112
+ });
113
+
114
+ await session.start({ agent });
115
+ session.generateReply({
116
+ instructions: 'Welcome the caller to Acme Corp support. Ask how you can help them today.',
117
+ });
118
+ },
119
+ });
120
+
121
+ runApp(agentDef);