@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,202 @@
1
+ # Examples
2
+
3
+ These TypeScript examples use the SignalWire AI Agents SDK. Run any of them with `npx tsx examples/<file>`.
4
+
5
+ ## Quickstarts
6
+
7
+ These three files hold the code blocks of the repository README's quickstarts, which are included from them:
8
+
9
+ | File | Description |
10
+ |------|-------------|
11
+ | [quickstart-agent.ts](quickstart-agent.ts) | The README agent quickstart: an agent at `/agent` with a prompt section and a `get_time` tool |
12
+ | [quickstart-relay.ts](quickstart-relay.ts) | The README RELAY quickstart: answer an inbound call, play text-to-speech and hang up |
13
+ | [quickstart-rest.ts](quickstart-rest.ts) | The README REST quickstart: create an AI agent resource, play text-to-speech on a call and search phone numbers. Its credentials are placeholders, so it doesn't run as it is. |
14
+
15
+ ## Agent Examples
16
+
17
+ | File | Description |
18
+ |------|-------------|
19
+ | [simple-agent.ts](simple-agent.ts) | Minimal agent with a prompt, hints, a language and a `get_time` tool |
20
+ | [typed-tools.ts](typed-tools.ts) | Tool handlers whose `args` type is inferred from `parameters`: an `enum` becomes a union, and `required` decides which keys are optional |
21
+ | [simple-static.ts](simple-static.ts) | Agent with a prompt and a voice, and no tools or dynamic config |
22
+ | [dynamic-config.ts](dynamic-config.ts) | Dynamic config callback that sets the language and the caller's name from the query string |
23
+ | [advanced-dynamic-config.ts](advanced-dynamic-config.ts) | Dynamic config callback with VIP detection from the caller's number, and department and language from the query string |
24
+ | [comprehensive-dynamic.ts](comprehensive-dynamic.ts) | Tier-based dynamic config with industry prompts, voice selection, LLM parameters and A/B testing |
25
+ | [declarative.ts](declarative.ts) | Agent subclass with `PROMPT_SECTIONS`, tools in `defineTools()`, and a post-prompt |
26
+ | [custom-path.ts](custom-path.ts) | Agent on a custom HTTP path, `/my-custom-agent`, with an optional proxy URL from `SWML_PROXY_URL_BASE` |
27
+ | [multi-agent.ts](multi-agent.ts) | Two agents on one `AgentServer`, at `/support` and `/sales` |
28
+ | [multi-endpoint.ts](multi-endpoint.ts) | Two agents on one `AgentServer`, at `/billing` and `/tech-support`, each with its own tool and voice |
29
+ | [pom-prompt.ts](pom-prompt.ts) | Prompt Object Model sections, bullets and subsections |
30
+
31
+ ## Contexts, Steps, and Gather Info
32
+
33
+ | File | Description |
34
+ |------|-------------|
35
+ | [contexts-steps.ts](contexts-steps.ts) | A quiz as a multi-step workflow, with contexts, steps and per-step tools |
36
+ | [gather-info.ts](gather-info.ts) | A patient intake flow: two gather info steps (`setGatherInfo`, `addGatherQuestion`) collect the answers, and a last step confirms them and calls a `submit_intake` tool |
37
+ | [gather-per-question-functions-demo.ts](gather-per-question-functions-demo.ts) | While a step's gather questions run, only `gather_submit` and the tools a question lists in `functions` are callable |
38
+ | [step-function-inheritance-demo.ts](step-function-inheritance-demo.ts) | A step without `setFunctions()` keeps the previous step's tools; four steps show inherit, replace and disable |
39
+
40
+ ## DataMap (Server-Side Tools)
41
+
42
+ | File | Description |
43
+ |------|-------------|
44
+ | [datamap-tools.ts](datamap-tools.ts) | Two DataMap tools: a weather lookup built with `DataMap`, and a joke API built with `createSimpleApiTool()` |
45
+ | [advanced-datamap.ts](advanced-datamap.ts) | DataMap expressions, a `nomatch` output, error keys, `foreach`, and `${ENV.*}` expansion with a prefix allowlist |
46
+
47
+ ## Skills
48
+
49
+ | File | Description |
50
+ |------|-------------|
51
+ | [skills-demo.ts](skills-demo.ts) | Built-in skills: datetime and math |
52
+ | [web-search.ts](web-search.ts) | Web search skill through the Google Custom Search API |
53
+ | [web-search-multi-instance.ts](web-search-multi-instance.ts) | Three web search instances (general, news, quick), with the Wikipedia, datetime and math skills |
54
+ | [wikipedia.ts](wikipedia.ts) | Wikipedia search skill, with no API key |
55
+ | [datasphere.ts](datasphere.ts) | DataSphere skill for knowledge base search |
56
+ | [datasphere-multi-instance.ts](datasphere-multi-instance.ts) | DataSphere skill loaded several times, one per document, with custom tool names |
57
+ | [datasphere-serverless-env.ts](datasphere-serverless-env.ts) | DataSphere serverless skill configured from environment variables |
58
+ | [datasphere-webhook-env.ts](datasphere-webhook-env.ts) | DataSphere webhook skill configured from environment variables |
59
+ | [mcp-agent.ts](mcp-agent.ts) | An MCP server endpoint (`/agent/mcp`) that exposes the agent's tools, and an MCP client that adds a remote server's tools |
60
+ | [mcp-gateway.ts](mcp-gateway.ts) | MCP gateway skill, which registers the tools of an MCP gateway's services. Reads the gateway from `MCP_GATEWAY_*` variables, and starts without MCP tools when they're unset |
61
+ | [joke-agent.ts](joke-agent.ts) | Joke skill (a built-in joke collection, no API key) with the datetime skill |
62
+
63
+ ## SWAIG Features and FunctionResult Actions
64
+
65
+ | File | Description |
66
+ |------|-------------|
67
+ | [swaig-features.ts](swaig-features.ts) | FunctionResult actions: hangup, hold, say, background audio, global data, metadata, context switch, SMS and toggling functions |
68
+ | [record-call.ts](record-call.ts) | Start and stop call recording with FunctionResult actions |
69
+ | [room-and-sip.ts](room-and-sip.ts) | Room joining, SIP REFER and conferences |
70
+ | [tap.ts](tap.ts) | TAP action that streams call audio to an external endpoint |
71
+
72
+ ## Call Flow and AI Configuration
73
+
74
+ | File | Description |
75
+ |------|-------------|
76
+ | [call-flow.ts](call-flow.ts) | Verbs before answer, after answer and after the AI, with call recording and a post-prompt |
77
+ | [llm-params.ts](llm-params.ts) | Prompt sampling settings (temperature, top_p, confidence), AI parameters (barge match string, timeouts), fillers, pronunciation and a post-prompt |
78
+ | [session-state.ts](session-state.ts) | Global data, a tool that updates it, and an `onSummary` handler for the post-prompt summary |
79
+ | [verb-methods.ts](verb-methods.ts) | Pre-answer, post-answer and post-AI verbs on an agent, and a standalone `SwmlBuilder` document |
80
+
81
+ ## Prefab Agents
82
+
83
+ | File | Description |
84
+ |------|-------------|
85
+ | [prefab-info-gatherer.ts](prefab-info-gatherer.ts) | InfoGatherer prefab that asks a fixed list of questions, confirming some answers |
86
+ | [dynamic-info-gatherer.ts](dynamic-info-gatherer.ts) | InfoGatherer prefab that picks its question set from the query string |
87
+ | [prefab-survey.ts](prefab-survey.ts) | Survey prefab with rating, yes/no, multiple-choice and open questions, and branching |
88
+ | [prefab-concierge.ts](prefab-concierge.ts) | Concierge prefab for a venue's services, amenities and hours |
89
+ | [prefab-faq.ts](prefab-faq.ts) | FAQ bot prefab with keyword matching |
90
+ | [prefab-receptionist.ts](prefab-receptionist.ts) | Receptionist prefab that transfers callers to departments by phone number, with visitor check-in |
91
+
92
+ ## SWML Service (Non-AI)
93
+
94
+ | File | Description |
95
+ |------|-------------|
96
+ | [swml-service.ts](swml-service.ts) | SWML service without an AI block: a greeting, a voicemail recording and a hangup |
97
+ | [dynamic-swml-service.ts](dynamic-swml-service.ts) | SWML service that builds a different document per request from the `action` query parameter |
98
+ | [swml-service-routing.ts](swml-service-routing.ts) | SWML service that routes to sales, support or a default IVR from the `dept` query parameter |
99
+ | [auto-vivified.ts](auto-vivified.ts) | Verb methods on `getBuilder()` and named sections, for voicemail, IVR and transfer services |
100
+ | [swmlservice_swaig_standalone.ts](swmlservice_swaig_standalone.ts) | `SWMLService` with no `AgentBase`, serving SWAIG functions on its own `/swaig` endpoint |
101
+ | [swmlservice_ai_sidecar.ts](swmlservice_ai_sidecar.ts) | `SWMLService` that emits the `ai_sidecar` verb and serves the tools the sidecar calls |
102
+
103
+ ## Deployment
104
+
105
+ | File | Description |
106
+ |------|-------------|
107
+ | [kubernetes-agent.ts](kubernetes-agent.ts) | Agent with graceful shutdown, for the built-in `/health` and `/ready` endpoints |
108
+ | [serverless-lambda.ts](serverless-lambda.ts) | Agent on AWS Lambda through `ServerlessAdapter` |
109
+
110
+ ## Client Examples
111
+
112
+ | File | Description |
113
+ |------|-------------|
114
+ | [relay-demo.ts](relay-demo.ts) | RELAY WebSocket client: answer calls and play text-to-speech |
115
+
116
+ ## PGI Reference Implementation
117
+
118
+ The `pgi/` directory holds a support-intake agent whose steps each list their own tools, and whose handlers, not the model, move the call between steps:
119
+
120
+ | File | Description |
121
+ |------|-------------|
122
+ | [pgi/case-domain.ts](pgi/case-domain.ts) | The application's rules for support cases: input validation, proposal revisions and idempotent submission, with no SDK import |
123
+ | [pgi/support-agent.ts](pgi/support-agent.ts) | The agent built on those rules. It has no side effects; `serve.ts` builds and serves it. |
124
+ | [pgi/serve.ts](pgi/serve.ts) | Serves the agent. It refuses to start unless `CASE_TENANT_ID`, the basic auth variables, `SIGNALWIRE_SIGNING_KEY` and `SIGNALWIRE_SWAIG_SECRET` are set. |
125
+
126
+ ## Test Harnesses
127
+
128
+ These files aren't usage examples. The porting-sdk audits run them against local test servers. They're in the repository but not in the npm package:
129
+
130
+ | File | Description |
131
+ |------|-------------|
132
+ | `relay_audit_harness.ts` | Drives a `RelayClient` through connect, subscribe and an event, for `audit_relay_handshake.py` |
133
+ | `rest_audit_harness.ts` | Runs one REST client operation against a test server, for `audit_rest_transport.py` |
134
+ | `skills_audit_harness.ts` | Runs one skill's handler against a test server, for `audit_skills_dispatch.py` |
135
+
136
+ ## Running Examples
137
+
138
+ These commands run an example, with the credentials the skill and RELAY examples need:
139
+
140
+ ```bash
141
+ # Run any example
142
+ npx tsx examples/simple-agent.ts
143
+
144
+ # Web search needs a Google Custom Search key and engine ID:
145
+ GOOGLE_SEARCH_API_KEY=your-key GOOGLE_SEARCH_ENGINE_ID=your-engine-id npx tsx examples/web-search.ts
146
+
147
+ # RELAY and DataSphere examples read the project credentials:
148
+ export SIGNALWIRE_PROJECT_ID=your-project-id
149
+ export SIGNALWIRE_API_TOKEN=your-api-token
150
+ export SIGNALWIRE_SPACE=your-space.signalwire.com
151
+ npx tsx examples/relay-demo.ts
152
+ ```
153
+
154
+ ## Environment Variables
155
+
156
+ The examples and the skills they load read these variables:
157
+
158
+ | Variable | Description | Default |
159
+ |----------|-------------|---------|
160
+ | `SWML_BASIC_AUTH_USER` | Basic auth user name | `user` |
161
+ | `SWML_BASIC_AUTH_PASSWORD` | Basic auth password | `pass` |
162
+ | `SIGNALWIRE_PROJECT_ID` | Project ID (RELAY, REST, DataSphere) | None |
163
+ | `SIGNALWIRE_API_TOKEN` | API token (RELAY, REST, DataSphere) | None |
164
+ | `SIGNALWIRE_SPACE` | Space host name | None |
165
+ | `GOOGLE_SEARCH_API_KEY` | Google Custom Search key (web search) | None |
166
+ | `GOOGLE_SEARCH_ENGINE_ID` | Google search engine ID (web search); `GOOGLE_SEARCH_CX` also works | None |
167
+ | `DATASPHERE_DOCUMENT_ID` | DataSphere document ID (`datasphere.ts` and the `-env` DataSphere examples) | None |
168
+ | `SW_NEWS_API_KEY` | NewsAPI key, expanded into the `get_news` URL in `advanced-datamap.ts` | None |
169
+ | `MCP_GATEWAY_URL` | MCP gateway URL for `mcp-gateway.ts`. A private or localhost URL also needs `SWML_ALLOW_PRIVATE_URLS=true` | None |
170
+ | `MCP_GATEWAY_AUTH_TOKEN` | MCP gateway bearer token, used instead of the user name and password | None |
171
+ | `MCP_GATEWAY_AUTH_USER` / `MCP_GATEWAY_AUTH_PASSWORD` | MCP gateway basic auth credentials | None |
172
+ | `MCP_GATEWAY_SERVICES` | Comma-separated MCP services for `mcp-gateway.ts` to expose | All services |
173
+
174
+ ## Conventions these examples follow
175
+
176
+ These examples are meant to be copied, so they model the SDK's typed, idiomatic
177
+ patterns. When you add or edit an example, follow the same rules. The LINT and FMT
178
+ gates enforce the mechanical ones, and review covers the rest:
179
+
180
+ - **Tools: let the schema type the handler.** Write `parameters` as an inline
181
+ flat map and list `required`; `defineTool<P,R>` infers `args` precisely
182
+ (`args.phone: string`, an `enum` prop narrows to its literal union, `required`
183
+ keys are present and the rest optional). Do **not** annotate the handler param
184
+ (`handler: (args: Record<string, unknown>) => ...`), which opts out of inference,
185
+ and do **not** cast or bracket-read args (`args['x'] as string`). Use
186
+ `args.x` directly. See [typed-tools.ts](typed-tools.ts).
187
+ - **Use the typed callback bodies, don't widen them.** The SDK types
188
+ `setDynamicConfigCallback`'s body as `SwmlRequestData`, `onSummary`'s `rawData`
189
+ as `PostPromptData`, and SWAIG handler `rawData` as `SwaigRequestData`. Read
190
+ fields directly (`bodyParams.call?.from`, `rawData.params.call_id`). Never
191
+ re-type one of these params looser in an override (e.g.
192
+ `onSummary(_, rawData: Record<string, unknown>)`). That drops the contract and
193
+ hides bugs. (Import the contract types from the package root.)
194
+ - **No `any`, no file-level `eslint-disable`.** Open/dynamic values are `unknown`
195
+ + narrowing; a justified one-off is a line-level `// eslint-disable-next-line`
196
+ with a reason. (Genuinely dynamic tree-walking by string key uses
197
+ `Record<string, unknown>` + indexing, which is correct.)
198
+ - **Drop dead casts the types made unnecessary.** If a value's static type
199
+ already has the field, read it directly, with no `as` and no `['key']`.
200
+ - **Generic error wrappers.** A `safe(label, fn)` helper must be generic
201
+ (`safe<T>(label, fn: () => Promise<T>): Promise<T | null>`) so results keep
202
+ their type at the call site.
@@ -0,0 +1,108 @@
1
+ /**
2
+ * Advanced DataMap Example
3
+ *
4
+ * Demonstrates advanced DataMap patterns: expression tools, a webhook with
5
+ * error keys and a fallback output, a foreach over a list in the response,
6
+ * `${ENV.*}` expansion with a prefix allowlist, and an expression with a
7
+ * nomatch output.
8
+ *
9
+ * Where a template reads the arguments depends on the stage: a webhook's
10
+ * URL and the expressions read `${args.word}`, while a webhook's output and
11
+ * foreach read the webhook's response, with the arguments under `input`
12
+ * (`${input.args.word}`).
13
+ * Run: npx tsx examples/advanced-datamap.ts
14
+ */
15
+
16
+ import { AgentBase, DataMap, FunctionResult, createExpressionTool } from '@signalwire/sdk';
17
+
18
+ export const agent = new AgentBase({
19
+ name: 'advanced-datamap-agent',
20
+ route: '/',
21
+ basicAuth: [
22
+ process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
23
+ process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
24
+ ],
25
+ });
26
+
27
+ agent.setPromptText(
28
+ 'You are a helpful assistant with tools for greeting detection, dictionary lookup, ' +
29
+ 'news headlines, and service status. Use the appropriate tool based on the user request.',
30
+ );
31
+
32
+ // Pattern 1: Expression-based tool (no HTTP call)
33
+ // Detects simple greetings and responds appropriately. The platform matches
34
+ // a pattern case-insensitively unless it is written '/pattern/'; the lc:
35
+ // helper also lowercases the text, so the pattern reads as lowercase.
36
+ const greetingTool = createExpressionTool({
37
+ name: 'detect_greeting',
38
+ patterns: {
39
+ '${lc:args.text}': [
40
+ '(hello|hi|hey|good morning|good afternoon)',
41
+ new FunctionResult('The user greeted with: ${args.text}. Respond warmly.'),
42
+ ],
43
+ },
44
+ parameters: {
45
+ text: { type: 'string', description: 'The text to analyze', required: true },
46
+ },
47
+ });
48
+ agent.registerSwaigFunction(greetingTool.toSwaigFunction());
49
+
50
+ // Pattern 2: GET webhook with error keys and a fallback output.
51
+ // The dictionary API returns an array for a word it knows, and an object
52
+ // with a "title" key when the word isn't found, so errorKeys(['title'])
53
+ // treats that response as a failure and the fallback output answers.
54
+ const definitionTool = new DataMap('lookup_definition')
55
+ .purpose('Look up the definition of a word in the dictionary')
56
+ .parameter('word', 'string', 'The word to look up', { required: true })
57
+ .webhook('GET', 'https://api.dictionaryapi.dev/api/v2/entries/en/${enc:args.word}')
58
+ .output(
59
+ new FunctionResult('Definition of ${input.args.word}: The word was found in the dictionary.'),
60
+ )
61
+ .errorKeys(['title'])
62
+ .fallbackOutput(new FunctionResult('Could not find a definition for that word.'));
63
+
64
+ agent.registerSwaigFunction(definitionTool.toSwaigFunction());
65
+
66
+ // Pattern 3: DataMap with foreach to iterate over list results.
67
+ // input_key is the path to the array in the response ("articles"), not a
68
+ // template.
69
+ const newsTool = new DataMap('get_news')
70
+ .purpose('Get the latest news headlines')
71
+ .parameter('topic', 'string', 'News topic to search for')
72
+ .webhook(
73
+ 'GET',
74
+ 'https://newsapi.org/v2/everything?q=${enc:args.topic}&pageSize=3&apiKey=${ENV.SW_NEWS_API_KEY}',
75
+ )
76
+ .foreach({
77
+ input_key: 'articles',
78
+ output_key: 'headlines',
79
+ append: '- ${this.title}: ${this.description}\n',
80
+ max: 5,
81
+ })
82
+ .output(new FunctionResult('Latest news on ${input.args.topic}:\n${headlines}'))
83
+ .fallbackOutput(new FunctionResult('No news found for that topic.'));
84
+
85
+ // Enable env expansion for the news API key
86
+ newsTool.enableEnvExpansion(true);
87
+ newsTool.setAllowedEnvPrefixes(['SW_']);
88
+
89
+ agent.registerSwaigFunction(newsTool.toSwaigFunction());
90
+
91
+ // Pattern 4: Expression with nomatch fallback
92
+ const statusChecker = new DataMap('check_status')
93
+ .purpose('Check the status of a service by name')
94
+ .parameter('service', 'string', 'Service name to check', { required: true })
95
+ .expression(
96
+ '${lc:args.service}',
97
+ '(api|web|database)',
98
+ new FunctionResult('The ${args.service} service is currently operational.'),
99
+ new FunctionResult(
100
+ 'Unknown service "${args.service}". Available services: api, web, database.',
101
+ ),
102
+ );
103
+
104
+ agent.registerSwaigFunction(statusChecker.toSwaigFunction());
105
+
106
+ agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
107
+
108
+ agent.serve();
@@ -0,0 +1,70 @@
1
+ /**
2
+ * Advanced Dynamic Config Example
3
+ *
4
+ * Per-request agent customization: VIP detection, department routing,
5
+ * language selection, and tiered service levels.
6
+ * Run: npx tsx examples/advanced-dynamic-config.ts
7
+ */
8
+
9
+ import { AgentBase, FunctionResult } from '@signalwire/sdk';
10
+
11
+ export const agent = new AgentBase({
12
+ name: 'smart-router',
13
+ route: '/',
14
+ basicAuth: [
15
+ process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
16
+ process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
17
+ ],
18
+ });
19
+
20
+ agent.setPromptText('You are a helpful customer service assistant.');
21
+ agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
22
+
23
+ agent.defineTool({
24
+ name: 'lookup_account',
25
+ description: 'Look up a customer account by phone number',
26
+ parameters: {
27
+ phone: { type: 'string', description: 'The customer phone number' },
28
+ },
29
+ handler: (args) => {
30
+ return new FunctionResult(`Account lookup for ${args.phone}: Active, Premium tier.`);
31
+ },
32
+ });
33
+
34
+ // VIP numbers get premium treatment
35
+ const VIP_NUMBERS = ['+15551234567', '+15559876543'];
36
+
37
+ agent.setDynamicConfigCallback(async (queryParams, bodyParams, _headers, agentCopy) => {
38
+ const copy = agentCopy as AgentBase;
39
+ const callerNumber = bodyParams.call?.from ?? '';
40
+
41
+ // VIP detection
42
+ if (VIP_NUMBERS.includes(callerNumber)) {
43
+ copy.setPromptText(
44
+ 'You are a premium concierge assistant. This is a VIP caller — provide priority service, ' +
45
+ 'be extra attentive, and offer to escalate any issues immediately.',
46
+ );
47
+ copy.setParam('temperature', 0.3);
48
+ copy.updateGlobalData({ tier: 'vip', caller: callerNumber });
49
+ }
50
+
51
+ // Department routing via query params
52
+ const dept = queryParams['department'];
53
+ if (dept === 'sales') {
54
+ copy.setPromptText('You are a sales assistant. Help the caller with product info and pricing.');
55
+ } else if (dept === 'support') {
56
+ copy.setPromptText('You are a technical support agent. Help diagnose and resolve issues.');
57
+ }
58
+
59
+ // Language selection
60
+ const lang = queryParams['lang'];
61
+ if (lang === 'es') {
62
+ copy.setPromptText('Eres un asistente de servicio al cliente. Responde siempre en espanol.');
63
+ copy.setLanguages([{ name: 'Spanish', code: 'es-ES', voice: 'polly.Lucia' }]);
64
+ } else if (lang === 'fr') {
65
+ copy.setPromptText('Vous etes un assistant du service client. Repondez toujours en francais.');
66
+ copy.setLanguages([{ name: 'French', code: 'fr-FR', voice: 'polly.Celine' }]);
67
+ }
68
+ });
69
+
70
+ agent.serve();
@@ -0,0 +1,95 @@
1
+ /**
2
+ * SWML Builder Example
3
+ *
4
+ * Demonstrates using SWMLService's underlying SwmlBuilder via `getBuilder()`
5
+ * for fluent verb chaining. Builds voicemail, IVR, and transfer services.
6
+ * Run: npx tsx examples/auto-vivified.ts
7
+ */
8
+
9
+ import { SWMLService } from '@signalwire/sdk';
10
+
11
+ // --- Voicemail Service ---
12
+ const voicemail = new SWMLService({
13
+ name: 'voicemail',
14
+ route: '/voicemail',
15
+ });
16
+
17
+ // Fluent chaining on the underlying SwmlBuilder for verb methods
18
+ voicemail
19
+ .getBuilder()
20
+ .answer()
21
+ .play({
22
+ url: 'say:Hello, you have reached the voicemail service. Please leave a message after the beep.',
23
+ })
24
+ .sleep(1000)
25
+ .play({ url: 'https://example.com/beep.wav' })
26
+ .record({
27
+ format: 'mp3',
28
+ stereo: false,
29
+ beep: false,
30
+ max_length: 120,
31
+ terminators: '#',
32
+ status_url: 'https://example.com/voicemail-status',
33
+ })
34
+ .play({ url: 'say:Thank you for your message. Goodbye!' })
35
+ .hangup();
36
+
37
+ // --- IVR Menu Service ---
38
+ const ivr = new SWMLService({
39
+ name: 'ivr',
40
+ route: '/ivr',
41
+ });
42
+
43
+ ivr.getBuilder().answer();
44
+
45
+ ivr.addSection('main_menu');
46
+ ivr.addVerbToSection('main_menu', 'prompt', {
47
+ play: 'say:Press 1 for sales, 2 for support, or 3 to leave a message.',
48
+ max_digits: 1,
49
+ terminators: '#',
50
+ digit_timeout: 5.0,
51
+ });
52
+
53
+ ivr.addVerbToSection('main_menu', 'switch', {
54
+ variable: 'prompt_digits',
55
+ case: {
56
+ '1': [{ transfer: { dest: 'sales' } }],
57
+ '2': [{ transfer: { dest: 'support' } }],
58
+ '3': [{ transfer: { dest: 'voicemail_section' } }],
59
+ },
60
+ default: [
61
+ { play: { url: "say:Sorry, I didn't understand." } },
62
+ { transfer: { dest: 'main_menu' } },
63
+ ],
64
+ });
65
+
66
+ ivr.addSection('sales');
67
+ ivr.addVerbToSection('sales', 'play', { url: 'say:Connecting you to sales.' });
68
+ ivr.addVerbToSection('sales', 'connect', { to: '+15551234567' });
69
+
70
+ ivr.addVerb('transfer', { dest: 'main_menu' });
71
+
72
+ // --- Call Transfer Service ---
73
+ const transfer = new SWMLService({
74
+ name: 'transfer',
75
+ route: '/transfer',
76
+ });
77
+
78
+ transfer.getBuilder().answer();
79
+ transfer.addVerb('play', { url: 'say:Connecting you with the next available agent.' });
80
+ transfer.addVerb('connect', {
81
+ from: '+15551234567',
82
+ timeout: 30,
83
+ answer_on_bridge: true,
84
+ ringback: ['ring:us'],
85
+ parallel: [{ to: '+15552223333' }, { to: '+15554445555' }],
86
+ });
87
+ transfer.addVerb('play', { url: 'say:All agents are busy. Please leave a message.' });
88
+ transfer.addVerb('record', { format: 'mp3', beep: true, max_length: 120, terminators: '#' });
89
+ transfer.getBuilder().hangup();
90
+
91
+ // Run the voicemail service by default (switch via --service flag)
92
+ const service =
93
+ process.argv[2] === 'ivr' ? ivr : process.argv[2] === 'transfer' ? transfer : voicemail;
94
+ console.log(`Starting ${service.name} service...`);
95
+ service.serve();
@@ -0,0 +1,65 @@
1
+ /**
2
+ * Call Flow Verbs Example
3
+ *
4
+ * Control what happens before, during, and after the AI conversation
5
+ * using SWML verbs in the 5-phase rendering pipeline.
6
+ * Run: npx tsx examples/call-flow.ts
7
+ */
8
+
9
+ import { AgentBase, FunctionResult } from '@signalwire/sdk';
10
+
11
+ export const agent = new AgentBase({
12
+ name: 'call-flow-agent',
13
+ route: '/',
14
+ basicAuth: [
15
+ process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
16
+ process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
17
+ ],
18
+ recordCall: true, // Record the call (Phase 3)
19
+ recordFormat: 'mp4',
20
+ recordStereo: true,
21
+ });
22
+
23
+ agent.setPromptText('You are a receptionist. Help callers schedule appointments.');
24
+
25
+ // Phase 1: Play ringing before answering
26
+ agent.addPreAnswerVerb('play', {
27
+ urls: ['ring:us'],
28
+ auto_answer: false,
29
+ });
30
+
31
+ // Phase 3: Play a welcome message after answering but before the AI takes over
32
+ agent.addPostAnswerVerb('play', {
33
+ url: 'say:Welcome to Acme Corp. Please hold while I connect you with our AI assistant.',
34
+ });
35
+
36
+ // Phase 5: Hangup after the AI conversation ends
37
+ agent.addPostAiVerb('hangup', {});
38
+
39
+ // AI config
40
+ agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
41
+ agent.addPronunciation({ replace: 'Acme', with: 'Ak-mee' });
42
+ agent.setParam('temperature', 0.7);
43
+
44
+ // Post-prompt for call summary
45
+ agent.setPostPrompt(
46
+ 'Provide a JSON summary with: caller_name, appointment_date, appointment_reason',
47
+ );
48
+
49
+ // Tool for scheduling
50
+ agent.defineTool({
51
+ name: 'schedule_appointment',
52
+ description: 'Schedule an appointment for the caller',
53
+ parameters: {
54
+ date: { type: 'string', description: 'Appointment date (YYYY-MM-DD)' },
55
+ time: { type: 'string', description: 'Appointment time (HH:MM)' },
56
+ reason: { type: 'string', description: 'Reason for the appointment' },
57
+ },
58
+ handler: (args) => {
59
+ return new FunctionResult(
60
+ `Appointment scheduled for ${args.date} at ${args.time}. Reason: ${args.reason}`,
61
+ );
62
+ },
63
+ });
64
+
65
+ agent.serve();
@@ -0,0 +1,125 @@
1
+ /**
2
+ * Comprehensive Dynamic Agent Example
3
+ *
4
+ * Tier-based dynamic config (standard/premium/enterprise) with industry-specific
5
+ * prompts, voice selection, LLM parameter tuning, and A/B testing.
6
+ * Run: npx tsx examples/comprehensive-dynamic.ts
7
+ * Test: curl "http://user:pass@localhost:3000/?tier=premium&industry=healthcare"
8
+ */
9
+
10
+ import { AgentBase, FunctionResult } from '@signalwire/sdk';
11
+
12
+ export const agent = new AgentBase({
13
+ name: 'comprehensive-dynamic',
14
+ route: '/',
15
+ basicAuth: [
16
+ process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
17
+ process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
18
+ ],
19
+ });
20
+
21
+ agent.setDynamicConfigCallback((queryParams, bodyParams, headers, ephemeral) => {
22
+ const tier = queryParams.tier ?? 'standard';
23
+ const industry = queryParams.industry ?? 'general';
24
+ const abGroup = Math.random() < 0.5 ? 'A' : 'B';
25
+
26
+ // Voice and language based on tier
27
+ const voiceMap: Record<string, string> = {
28
+ enterprise: 'alloy',
29
+ premium: 'nova',
30
+ standard: 'rachel',
31
+ };
32
+ ephemeral.addLanguage({
33
+ name: 'English',
34
+ code: 'en-US',
35
+ voice: voiceMap[tier] ?? 'rachel',
36
+ });
37
+
38
+ // LLM parameters by tier
39
+ const tempMap: Record<string, number> = { enterprise: 0.2, premium: 0.4, standard: 0.6 };
40
+ ephemeral.setParams({
41
+ temperature: tempMap[tier] ?? 0.5,
42
+ top_p: tier === 'enterprise' ? 0.85 : 0.95,
43
+ });
44
+
45
+ // Global data
46
+ ephemeral.setGlobalData({
47
+ tier,
48
+ industry,
49
+ ab_group: abGroup,
50
+ priority_queue: tier !== 'standard',
51
+ });
52
+
53
+ // Industry-specific prompts
54
+ const industryPrompts: Record<string, { title: string; body: string; bullets: string[] }> = {
55
+ healthcare: {
56
+ title: 'Healthcare Expertise',
57
+ body: 'You are a healthcare support specialist.',
58
+ bullets: [
59
+ 'Follow HIPAA guidelines for patient information',
60
+ 'Use proper medical terminology',
61
+ 'Escalate urgent medical concerns immediately',
62
+ ],
63
+ },
64
+ finance: {
65
+ title: 'Financial Services',
66
+ body: 'You are a financial services representative.',
67
+ bullets: [
68
+ 'Never provide specific investment advice',
69
+ 'Verify account identity before sharing details',
70
+ 'Offer to connect with a licensed advisor for complex questions',
71
+ ],
72
+ },
73
+ general: {
74
+ title: 'General Support',
75
+ body: 'You are a versatile customer service agent.',
76
+ bullets: [
77
+ 'Help with product questions and troubleshooting',
78
+ 'Process returns and exchanges',
79
+ 'Escalate complex issues to a specialist',
80
+ ],
81
+ },
82
+ };
83
+
84
+ const prompt = industryPrompts[industry] ?? industryPrompts.general!; // 'general' is a defined literal key
85
+ ephemeral.promptAddSection(prompt.title, { body: prompt.body, bullets: prompt.bullets });
86
+
87
+ // Tier-specific features
88
+ if (tier === 'enterprise' || tier === 'premium') {
89
+ ephemeral.defineTool({
90
+ name: 'schedule_callback',
91
+ description: 'Schedule a priority callback from a specialist',
92
+ parameters: {
93
+ time_slot: { type: 'string', description: 'Preferred callback time' },
94
+ },
95
+ handler: (args) => {
96
+ return new FunctionResult(
97
+ `Priority callback scheduled for ${args.time_slot}. A specialist will call you.`,
98
+ );
99
+ },
100
+ });
101
+ }
102
+
103
+ // A/B test: greeting style
104
+ if (abGroup === 'A') {
105
+ ephemeral.promptAddSection('Greeting', { body: 'Start with a warm, conversational greeting.' });
106
+ } else {
107
+ ephemeral.promptAddSection('Greeting', { body: 'Start with a brief, professional greeting.' });
108
+ }
109
+
110
+ // Tool available to all tiers
111
+ ephemeral.defineTool({
112
+ name: 'check_status',
113
+ description: 'Check the status of an order or ticket',
114
+ parameters: {
115
+ reference: { type: 'string', description: 'Order or ticket number' },
116
+ },
117
+ handler: (args) => {
118
+ return new FunctionResult(
119
+ `Reference ${args.reference} is being processed. Estimated completion: 2 business days.`,
120
+ );
121
+ },
122
+ });
123
+ });
124
+
125
+ agent.serve();