@signalwire/sdk 2.0.5 → 3.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (656) hide show
  1. package/CHANGELOG.md +785 -0
  2. package/LICENSE +21 -0
  3. package/README.md +163 -68
  4. package/dist/AGENTS.md +13 -0
  5. package/dist/AgentBase.d.ts +481 -126
  6. package/dist/AgentBase.js +1502 -438
  7. package/dist/AgentBase.js.map +1 -1
  8. package/dist/AgentServer.d.ts +21 -0
  9. package/dist/AgentServer.js +154 -47
  10. package/dist/AgentServer.js.map +1 -1
  11. package/dist/AuthHandler.d.ts +14 -2
  12. package/dist/AuthHandler.js +7 -2
  13. package/dist/AuthHandler.js.map +1 -1
  14. package/dist/ConfigLoader.d.ts +5 -13
  15. package/dist/ConfigLoader.js +15 -29
  16. package/dist/ConfigLoader.js.map +1 -1
  17. package/dist/ContextBuilder.d.ts +202 -9
  18. package/dist/ContextBuilder.js +219 -36
  19. package/dist/ContextBuilder.js.map +1 -1
  20. package/dist/DataMap.d.ts +158 -45
  21. package/dist/DataMap.js +167 -52
  22. package/dist/DataMap.js.map +1 -1
  23. package/dist/FunctionResult.d.ts +277 -83
  24. package/dist/FunctionResult.js +444 -116
  25. package/dist/FunctionResult.js.map +1 -1
  26. package/dist/Logger.d.ts +30 -5
  27. package/dist/Logger.js +77 -19
  28. package/dist/Logger.js.map +1 -1
  29. package/dist/POM/PromptObjectModel.d.ts +12 -1
  30. package/dist/POM/PromptObjectModel.js +25 -9
  31. package/dist/POM/PromptObjectModel.js.map +1 -1
  32. package/dist/ParameterSchema.d.ts +306 -0
  33. package/dist/ParameterSchema.js +251 -0
  34. package/dist/ParameterSchema.js.map +1 -0
  35. package/dist/PlatformContracts.d.ts +21 -0
  36. package/dist/PlatformContracts.generated.d.ts +109 -0
  37. package/dist/PlatformContracts.generated.js +8 -0
  38. package/dist/PlatformContracts.generated.js.map +1 -0
  39. package/dist/PlatformContracts.js +2 -0
  40. package/dist/PlatformContracts.js.map +1 -0
  41. package/dist/PomBuilder.d.ts +18 -0
  42. package/dist/PomBuilder.js +53 -3
  43. package/dist/PomBuilder.js.map +1 -1
  44. package/dist/PostPrompt.d.ts +110 -0
  45. package/dist/PostPrompt.js +204 -0
  46. package/dist/PostPrompt.js.map +1 -0
  47. package/dist/PromptManager.d.ts +22 -1
  48. package/dist/PromptManager.js +28 -1
  49. package/dist/PromptManager.js.map +1 -1
  50. package/dist/PublicFetch.d.ts +132 -0
  51. package/dist/PublicFetch.js +311 -0
  52. package/dist/PublicFetch.js.map +1 -0
  53. package/dist/RobotsTxt.d.ts +41 -0
  54. package/dist/RobotsTxt.js +152 -0
  55. package/dist/RobotsTxt.js.map +1 -0
  56. package/dist/SWMLHandler.js.map +1 -1
  57. package/dist/SWMLService.d.ts +158 -58
  58. package/dist/SWMLService.js +435 -127
  59. package/dist/SWMLService.js.map +1 -1
  60. package/dist/SchemaUtils.d.ts +115 -2
  61. package/dist/SchemaUtils.js +444 -12
  62. package/dist/SchemaUtils.js.map +1 -1
  63. package/dist/SecurityUtils.d.ts +49 -9
  64. package/dist/SecurityUtils.js +153 -51
  65. package/dist/SecurityUtils.js.map +1 -1
  66. package/dist/ServerlessAdapter.d.ts +156 -7
  67. package/dist/ServerlessAdapter.js +399 -42
  68. package/dist/ServerlessAdapter.js.map +1 -1
  69. package/dist/SessionManager.d.ts +11 -2
  70. package/dist/SessionManager.js +50 -18
  71. package/dist/SessionManager.js.map +1 -1
  72. package/dist/SslConfig.d.ts +2 -1
  73. package/dist/SslConfig.js +4 -1
  74. package/dist/SslConfig.js.map +1 -1
  75. package/dist/SwaigActions.generated.d.ts +23 -0
  76. package/dist/SwaigActions.generated.js +8 -0
  77. package/dist/SwaigActions.generated.js.map +1 -0
  78. package/dist/SwaigContracts.d.ts +15 -0
  79. package/dist/SwaigContracts.generated.d.ts +264 -0
  80. package/dist/SwaigContracts.generated.js +12 -0
  81. package/dist/SwaigContracts.generated.js.map +1 -0
  82. package/dist/SwaigContracts.js +2 -0
  83. package/dist/SwaigContracts.js.map +1 -0
  84. package/dist/SwaigFunction.d.ts +110 -4
  85. package/dist/SwaigFunction.js +151 -19
  86. package/dist/SwaigFunction.js.map +1 -1
  87. package/dist/SwmlBuilder.d.ts +68 -19
  88. package/dist/SwmlBuilder.js +74 -38
  89. package/dist/SwmlBuilder.js.map +1 -1
  90. package/dist/SwmlVerbMethods.generated.d.ts +41 -4
  91. package/dist/SwmlVerbMethods.generated.js +1 -1
  92. package/dist/TypeInference.d.ts +39 -3
  93. package/dist/TypeInference.js +256 -16
  94. package/dist/TypeInference.js.map +1 -1
  95. package/dist/WebService.d.ts +79 -11
  96. package/dist/WebService.js +320 -109
  97. package/dist/WebService.js.map +1 -1
  98. package/dist/WebhookMiddleware.d.ts +119 -0
  99. package/dist/WebhookMiddleware.js +271 -0
  100. package/dist/WebhookMiddleware.js.map +1 -0
  101. package/dist/WebhookValidator.d.ts +92 -0
  102. package/dist/WebhookValidator.js +409 -0
  103. package/dist/WebhookValidator.js.map +1 -0
  104. package/dist/agents/BedrockAgent.d.ts +162 -0
  105. package/dist/agents/BedrockAgent.js +323 -0
  106. package/dist/agents/BedrockAgent.js.map +1 -0
  107. package/dist/ai-chat/AIChatClient.d.ts +316 -0
  108. package/dist/ai-chat/AIChatClient.js +535 -0
  109. package/dist/ai-chat/AIChatClient.js.map +1 -0
  110. package/dist/ai-chat/ChatGateway.d.ts +408 -0
  111. package/dist/ai-chat/ChatGateway.js +747 -0
  112. package/dist/ai-chat/ChatGateway.js.map +1 -0
  113. package/dist/ai-chat/HandoffRouter.d.ts +282 -0
  114. package/dist/ai-chat/HandoffRouter.js +518 -0
  115. package/dist/ai-chat/HandoffRouter.js.map +1 -0
  116. package/dist/ai-chat/index.d.ts +12 -0
  117. package/dist/ai-chat/index.js +10 -0
  118. package/dist/ai-chat/index.js.map +1 -0
  119. package/dist/capabilities.d.ts +64 -0
  120. package/dist/capabilities.js +95 -0
  121. package/dist/capabilities.js.map +1 -0
  122. package/dist/cli/agent-loader.d.ts +32 -6
  123. package/dist/cli/agent-loader.js +92 -33
  124. package/dist/cli/agent-loader.js.map +1 -1
  125. package/dist/cli/datamap-exec.d.ts +175 -0
  126. package/dist/cli/datamap-exec.js +1284 -0
  127. package/dist/cli/datamap-exec.js.map +1 -0
  128. package/dist/cli/function-args.d.ts +40 -0
  129. package/dist/cli/function-args.js +146 -0
  130. package/dist/cli/function-args.js.map +1 -0
  131. package/dist/cli/simulation.d.ts +99 -0
  132. package/dist/cli/simulation.js +490 -0
  133. package/dist/cli/simulation.js.map +1 -0
  134. package/dist/cli/swaig-test.d.ts +12 -25
  135. package/dist/cli/swaig-test.js +935 -371
  136. package/dist/cli/swaig-test.js.map +1 -1
  137. package/dist/cli/tsdocs/agentsNote.d.ts +30 -0
  138. package/dist/cli/tsdocs/agentsNote.js +92 -0
  139. package/dist/cli/tsdocs/agentsNote.js.map +1 -0
  140. package/dist/cli/tsdocs/api-index.json +1 -0
  141. package/dist/cli/tsdocs/api.d.ts +91 -0
  142. package/dist/cli/tsdocs/api.js +372 -0
  143. package/dist/cli/tsdocs/api.js.map +1 -0
  144. package/dist/cli/tsdocs/apiTypes.d.ts +64 -0
  145. package/dist/cli/tsdocs/apiTypes.js +7 -0
  146. package/dist/cli/tsdocs/apiTypes.js.map +1 -0
  147. package/dist/cli/tsdocs/bin.d.ts +6 -0
  148. package/dist/cli/tsdocs/bin.js +23 -0
  149. package/dist/cli/tsdocs/bin.js.map +1 -0
  150. package/dist/cli/tsdocs/files.d.ts +108 -0
  151. package/dist/cli/tsdocs/files.js +287 -0
  152. package/dist/cli/tsdocs/files.js.map +1 -0
  153. package/dist/cli/tsdocs/index.d.ts +28 -0
  154. package/dist/cli/tsdocs/index.js +307 -0
  155. package/dist/cli/tsdocs/index.js.map +1 -0
  156. package/dist/cli/tsdocs/live.d.ts +41 -0
  157. package/dist/cli/tsdocs/live.js +202 -0
  158. package/dist/cli/tsdocs/live.js.map +1 -0
  159. package/dist/cli/tsdocs/locate.d.ts +51 -0
  160. package/dist/cli/tsdocs/locate.js +75 -0
  161. package/dist/cli/tsdocs/locate.js.map +1 -0
  162. package/dist/cli/tsdocs/render.d.ts +75 -0
  163. package/dist/cli/tsdocs/render.js +323 -0
  164. package/dist/cli/tsdocs/render.js.map +1 -0
  165. package/dist/cli/tsdocs/topics.d.ts +43 -0
  166. package/dist/cli/tsdocs/topics.js +916 -0
  167. package/dist/cli/tsdocs/topics.js.map +1 -0
  168. package/dist/index.d.ts +47 -68
  169. package/dist/index.js +44 -73
  170. package/dist/index.js.map +1 -1
  171. package/dist/livewire/index.d.ts +229 -155
  172. package/dist/livewire/index.js +298 -195
  173. package/dist/livewire/index.js.map +1 -1
  174. package/dist/llms.txt +65 -0
  175. package/dist/prefabs/CallSessionStore.d.ts +52 -0
  176. package/dist/prefabs/CallSessionStore.js +72 -0
  177. package/dist/prefabs/CallSessionStore.js.map +1 -0
  178. package/dist/prefabs/ConciergeAgent.d.ts +13 -1
  179. package/dist/prefabs/ConciergeAgent.js +36 -31
  180. package/dist/prefabs/ConciergeAgent.js.map +1 -1
  181. package/dist/prefabs/FAQBotAgent.d.ts +9 -1
  182. package/dist/prefabs/FAQBotAgent.js +113 -47
  183. package/dist/prefabs/FAQBotAgent.js.map +1 -1
  184. package/dist/prefabs/InfoGathererAgent.d.ts +22 -3
  185. package/dist/prefabs/InfoGathererAgent.js +67 -58
  186. package/dist/prefabs/InfoGathererAgent.js.map +1 -1
  187. package/dist/prefabs/ReceptionistAgent.d.ts +16 -5
  188. package/dist/prefabs/ReceptionistAgent.js +39 -31
  189. package/dist/prefabs/ReceptionistAgent.js.map +1 -1
  190. package/dist/prefabs/SurveyAgent.d.ts +22 -4
  191. package/dist/prefabs/SurveyAgent.js +84 -68
  192. package/dist/prefabs/SurveyAgent.js.map +1 -1
  193. package/dist/relay/Action.d.ts +44 -21
  194. package/dist/relay/Action.js +75 -17
  195. package/dist/relay/Action.js.map +1 -1
  196. package/dist/relay/Call.d.ts +312 -47
  197. package/dist/relay/Call.js +369 -18
  198. package/dist/relay/Call.js.map +1 -1
  199. package/dist/relay/Deferred.js.map +1 -1
  200. package/dist/relay/Message.d.ts +26 -5
  201. package/dist/relay/Message.js +36 -6
  202. package/dist/relay/Message.js.map +1 -1
  203. package/dist/relay/RelayClient.d.ts +44 -17
  204. package/dist/relay/RelayClient.js +175 -65
  205. package/dist/relay/RelayClient.js.map +1 -1
  206. package/dist/relay/RelayError.d.ts +14 -0
  207. package/dist/relay/RelayError.js +15 -0
  208. package/dist/relay/RelayError.js.map +1 -1
  209. package/dist/relay/RelayEvent.d.ts +96 -65
  210. package/dist/relay/RelayEvent.js +85 -56
  211. package/dist/relay/RelayEvent.js.map +1 -1
  212. package/dist/relay/closedSets.d.ts +111 -0
  213. package/dist/relay/closedSets.js +83 -0
  214. package/dist/relay/closedSets.js.map +1 -0
  215. package/dist/relay/index.d.ts +3 -1
  216. package/dist/relay/index.js +1 -0
  217. package/dist/relay/index.js.map +1 -1
  218. package/dist/relay/normalize.js.map +1 -1
  219. package/dist/relay/protocol.types.generated.d.ts +1195 -0
  220. package/dist/relay/protocol.types.generated.js +8 -0
  221. package/dist/relay/protocol.types.generated.js.map +1 -0
  222. package/dist/relay/types.d.ts +73 -42
  223. package/dist/rest/HttpClient.d.ts +36 -8
  224. package/dist/rest/HttpClient.js +233 -40
  225. package/dist/rest/HttpClient.js.map +1 -1
  226. package/dist/rest/RequestOptions.d.ts +110 -0
  227. package/dist/rest/RequestOptions.js +113 -0
  228. package/dist/rest/RequestOptions.js.map +1 -0
  229. package/dist/rest/RestError.d.ts +52 -6
  230. package/dist/rest/RestError.js +89 -5
  231. package/dist/rest/RestError.js.map +1 -1
  232. package/dist/rest/base/CrudResource.d.ts +16 -26
  233. package/dist/rest/base/CrudResource.js +19 -33
  234. package/dist/rest/base/CrudResource.js.map +1 -1
  235. package/dist/rest/base/CrudWithAddresses.d.ts +3 -2
  236. package/dist/rest/base/CrudWithAddresses.js +2 -2
  237. package/dist/rest/base/CrudWithAddresses.js.map +1 -1
  238. package/dist/rest/base/FabricResource.d.ts +15 -0
  239. package/dist/rest/base/FabricResource.js +16 -0
  240. package/dist/rest/base/FabricResource.js.map +1 -0
  241. package/dist/rest/base/ReadResource.d.ts +62 -0
  242. package/dist/rest/base/ReadResource.js +69 -0
  243. package/dist/rest/base/ReadResource.js.map +1 -0
  244. package/dist/rest/callHandler.d.ts +5 -2
  245. package/dist/rest/callHandler.js +4 -1
  246. package/dist/rest/callHandler.js.map +1 -1
  247. package/dist/rest/index.d.ts +18 -77
  248. package/dist/rest/index.js +47 -120
  249. package/dist/rest/index.js.map +1 -1
  250. package/dist/rest/namespaces/_client_tree_generated.d.ts +103 -0
  251. package/dist/rest/namespaces/_client_tree_generated.js +171 -0
  252. package/dist/rest/namespaces/_client_tree_generated.js.map +1 -0
  253. package/dist/rest/namespaces/addresses.d.ts +3 -42
  254. package/dist/rest/namespaces/addresses.js +3 -50
  255. package/dist/rest/namespaces/addresses.js.map +1 -1
  256. package/dist/rest/namespaces/calling.d.ts +6 -378
  257. package/dist/rest/namespaces/calling.js +6 -473
  258. package/dist/rest/namespaces/calling.js.map +1 -1
  259. package/dist/rest/namespaces/calling.resources.generated.d.ts +165 -0
  260. package/dist/rest/namespaces/calling.resources.generated.js +477 -0
  261. package/dist/rest/namespaces/calling.resources.generated.js.map +1 -0
  262. package/dist/rest/namespaces/calling.types.generated.d.ts +2917 -0
  263. package/dist/rest/namespaces/calling.types.generated.js +8 -0
  264. package/dist/rest/namespaces/calling.types.generated.js.map +1 -0
  265. package/dist/rest/namespaces/chat.d.ts +4 -18
  266. package/dist/rest/namespaces/chat.js +4 -21
  267. package/dist/rest/namespaces/chat.js.map +1 -1
  268. package/dist/rest/namespaces/chat.resources.generated.d.ts +12 -0
  269. package/dist/rest/namespaces/chat.resources.generated.js +29 -0
  270. package/dist/rest/namespaces/chat.resources.generated.js.map +1 -0
  271. package/dist/rest/namespaces/chat.types.generated.d.ts +56 -0
  272. package/dist/rest/namespaces/chat.types.generated.js +8 -0
  273. package/dist/rest/namespaces/chat.types.generated.js.map +1 -0
  274. package/dist/rest/namespaces/datasphere.d.ts +6 -62
  275. package/dist/rest/namespaces/datasphere.js +6 -72
  276. package/dist/rest/namespaces/datasphere.js.map +1 -1
  277. package/dist/rest/namespaces/datasphere.resources.generated.d.ts +25 -0
  278. package/dist/rest/namespaces/datasphere.resources.generated.js +50 -0
  279. package/dist/rest/namespaces/datasphere.resources.generated.js.map +1 -0
  280. package/dist/rest/namespaces/datasphere.types.generated.d.ts +180 -0
  281. package/dist/rest/namespaces/datasphere.types.generated.js +8 -0
  282. package/dist/rest/namespaces/datasphere.types.generated.js.map +1 -0
  283. package/dist/rest/namespaces/fabric.d.ts +11 -327
  284. package/dist/rest/namespaces/fabric.js +14 -439
  285. package/dist/rest/namespaces/fabric.js.map +1 -1
  286. package/dist/rest/namespaces/fabric.resources.generated.d.ts +195 -0
  287. package/dist/rest/namespaces/fabric.resources.generated.js +399 -0
  288. package/dist/rest/namespaces/fabric.resources.generated.js.map +1 -0
  289. package/dist/rest/namespaces/fabric.types.generated.d.ts +4557 -0
  290. package/dist/rest/namespaces/fabric.types.generated.js +8 -0
  291. package/dist/rest/namespaces/fabric.types.generated.js.map +1 -0
  292. package/dist/rest/namespaces/fax.resources.generated.d.ts +6 -0
  293. package/dist/rest/namespaces/fax.resources.generated.js +14 -0
  294. package/dist/rest/namespaces/fax.resources.generated.js.map +1 -0
  295. package/dist/rest/namespaces/fax.types.generated.d.ts +131 -0
  296. package/dist/rest/namespaces/fax.types.generated.js +8 -0
  297. package/dist/rest/namespaces/fax.types.generated.js.map +1 -0
  298. package/dist/rest/namespaces/imported-numbers.d.ts +3 -18
  299. package/dist/rest/namespaces/imported-numbers.js +3 -21
  300. package/dist/rest/namespaces/imported-numbers.js.map +1 -1
  301. package/dist/rest/namespaces/logs.d.ts +10 -101
  302. package/dist/rest/namespaces/logs.js +10 -128
  303. package/dist/rest/namespaces/logs.js.map +1 -1
  304. package/dist/rest/namespaces/logs.resources.generated.d.ts +9 -0
  305. package/dist/rest/namespaces/logs.resources.generated.js +17 -0
  306. package/dist/rest/namespaces/logs.resources.generated.js.map +1 -0
  307. package/dist/rest/namespaces/logs.types.generated.d.ts +131 -0
  308. package/dist/rest/namespaces/logs.types.generated.js +8 -0
  309. package/dist/rest/namespaces/logs.types.generated.js.map +1 -0
  310. package/dist/rest/namespaces/lookup.d.ts +3 -25
  311. package/dist/rest/namespaces/lookup.js +3 -27
  312. package/dist/rest/namespaces/lookup.js.map +1 -1
  313. package/dist/rest/namespaces/message.resources.generated.d.ts +6 -0
  314. package/dist/rest/namespaces/message.resources.generated.js +14 -0
  315. package/dist/rest/namespaces/message.resources.generated.js.map +1 -0
  316. package/dist/rest/namespaces/message.types.generated.d.ts +122 -0
  317. package/dist/rest/namespaces/message.types.generated.js +8 -0
  318. package/dist/rest/namespaces/message.types.generated.js.map +1 -0
  319. package/dist/rest/namespaces/messages.resources.generated.d.ts +18 -0
  320. package/dist/rest/namespaces/messages.resources.generated.js +44 -0
  321. package/dist/rest/namespaces/messages.resources.generated.js.map +1 -0
  322. package/dist/rest/namespaces/messages.types.generated.d.ts +99 -0
  323. package/dist/rest/namespaces/messages.types.generated.js +8 -0
  324. package/dist/rest/namespaces/messages.types.generated.js.map +1 -0
  325. package/dist/rest/namespaces/mfa.d.ts +3 -42
  326. package/dist/rest/namespaces/mfa.js +3 -49
  327. package/dist/rest/namespaces/mfa.js.map +1 -1
  328. package/dist/rest/namespaces/number-groups.d.ts +3 -45
  329. package/dist/rest/namespaces/number-groups.js +3 -53
  330. package/dist/rest/namespaces/number-groups.js.map +1 -1
  331. package/dist/rest/namespaces/phone-numbers.d.ts +8 -196
  332. package/dist/rest/namespaces/phone-numbers.js +8 -230
  333. package/dist/rest/namespaces/phone-numbers.js.map +1 -1
  334. package/dist/rest/namespaces/project.d.ts +6 -42
  335. package/dist/rest/namespaces/project.js +6 -51
  336. package/dist/rest/namespaces/project.js.map +1 -1
  337. package/dist/rest/namespaces/project.resources.generated.d.ts +17 -0
  338. package/dist/rest/namespaces/project.resources.generated.js +44 -0
  339. package/dist/rest/namespaces/project.resources.generated.js.map +1 -0
  340. package/dist/rest/namespaces/project.types.generated.d.ts +58 -0
  341. package/dist/rest/namespaces/project.types.generated.js +8 -0
  342. package/dist/rest/namespaces/project.types.generated.js.map +1 -0
  343. package/dist/rest/namespaces/projects.resources.generated.d.ts +12 -0
  344. package/dist/rest/namespaces/projects.resources.generated.js +25 -0
  345. package/dist/rest/namespaces/projects.resources.generated.js.map +1 -0
  346. package/dist/rest/namespaces/projects.types.generated.d.ts +77 -0
  347. package/dist/rest/namespaces/projects.types.generated.js +8 -0
  348. package/dist/rest/namespaces/projects.types.generated.js.map +1 -0
  349. package/dist/rest/namespaces/pubsub.d.ts +4 -18
  350. package/dist/rest/namespaces/pubsub.js +4 -21
  351. package/dist/rest/namespaces/pubsub.js.map +1 -1
  352. package/dist/rest/namespaces/pubsub.resources.generated.d.ts +12 -0
  353. package/dist/rest/namespaces/pubsub.resources.generated.js +29 -0
  354. package/dist/rest/namespaces/pubsub.resources.generated.js.map +1 -0
  355. package/dist/rest/namespaces/pubsub.types.generated.d.ts +60 -0
  356. package/dist/rest/namespaces/pubsub.types.generated.js +8 -0
  357. package/dist/rest/namespaces/pubsub.types.generated.js.map +1 -0
  358. package/dist/rest/namespaces/queues.d.ts +3 -38
  359. package/dist/rest/namespaces/queues.js +3 -44
  360. package/dist/rest/namespaces/queues.js.map +1 -1
  361. package/dist/rest/namespaces/recordings.d.ts +3 -34
  362. package/dist/rest/namespaces/recordings.js +3 -40
  363. package/dist/rest/namespaces/recordings.js.map +1 -1
  364. package/dist/rest/namespaces/registry.d.ts +6 -137
  365. package/dist/rest/namespaces/registry.js +6 -173
  366. package/dist/rest/namespaces/registry.js.map +1 -1
  367. package/dist/rest/namespaces/relay-rest.resources.generated.d.ts +168 -0
  368. package/dist/rest/namespaces/relay-rest.resources.generated.js +430 -0
  369. package/dist/rest/namespaces/relay-rest.resources.generated.js.map +1 -0
  370. package/dist/rest/namespaces/relay-rest.types.generated.d.ts +1906 -0
  371. package/dist/rest/namespaces/relay-rest.types.generated.js +8 -0
  372. package/dist/rest/namespaces/relay-rest.types.generated.js.map +1 -0
  373. package/dist/rest/namespaces/short-codes.d.ts +3 -35
  374. package/dist/rest/namespaces/short-codes.js +3 -41
  375. package/dist/rest/namespaces/short-codes.js.map +1 -1
  376. package/dist/rest/namespaces/sip-profile.d.ts +3 -24
  377. package/dist/rest/namespaces/sip-profile.js +3 -29
  378. package/dist/rest/namespaces/sip-profile.js.map +1 -1
  379. package/dist/rest/namespaces/verified-callers.d.ts +3 -29
  380. package/dist/rest/namespaces/verified-callers.js +3 -34
  381. package/dist/rest/namespaces/verified-callers.js.map +1 -1
  382. package/dist/rest/namespaces/video.d.ts +10 -227
  383. package/dist/rest/namespaces/video.js +10 -288
  384. package/dist/rest/namespaces/video.js.map +1 -1
  385. package/dist/rest/namespaces/video.resources.generated.d.ts +81 -0
  386. package/dist/rest/namespaces/video.resources.generated.js +171 -0
  387. package/dist/rest/namespaces/video.resources.generated.js.map +1 -0
  388. package/dist/rest/namespaces/video.types.generated.d.ts +771 -0
  389. package/dist/rest/namespaces/video.types.generated.js +8 -0
  390. package/dist/rest/namespaces/video.types.generated.js.map +1 -0
  391. package/dist/rest/namespaces/voice.resources.generated.d.ts +9 -0
  392. package/dist/rest/namespaces/voice.resources.generated.js +17 -0
  393. package/dist/rest/namespaces/voice.resources.generated.js.map +1 -0
  394. package/dist/rest/namespaces/voice.types.generated.d.ts +214 -0
  395. package/dist/rest/namespaces/voice.types.generated.js +8 -0
  396. package/dist/rest/namespaces/voice.types.generated.js.map +1 -0
  397. package/dist/rest/pagination.d.ts +5 -1
  398. package/dist/rest/pagination.js +40 -20
  399. package/dist/rest/pagination.js.map +1 -1
  400. package/dist/rest/types.d.ts +21 -3
  401. package/dist/schema.json +299 -98
  402. package/dist/skills/SkillBase.d.ts +97 -20
  403. package/dist/skills/SkillBase.js +100 -17
  404. package/dist/skills/SkillBase.js.map +1 -1
  405. package/dist/skills/SkillManager.d.ts +66 -13
  406. package/dist/skills/SkillManager.js +101 -20
  407. package/dist/skills/SkillManager.js.map +1 -1
  408. package/dist/skills/SkillName.d.ts +44 -0
  409. package/dist/skills/SkillName.js +2 -0
  410. package/dist/skills/SkillName.js.map +1 -0
  411. package/dist/skills/SkillRegistry.d.ts +22 -11
  412. package/dist/skills/SkillRegistry.js +47 -17
  413. package/dist/skills/SkillRegistry.js.map +1 -1
  414. package/dist/skills/builtin/api_ninjas_trivia.d.ts +3 -1
  415. package/dist/skills/builtin/api_ninjas_trivia.js +18 -6
  416. package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -1
  417. package/dist/skills/builtin/ask_claude.d.ts +14 -4
  418. package/dist/skills/builtin/ask_claude.js +36 -14
  419. package/dist/skills/builtin/ask_claude.js.map +1 -1
  420. package/dist/skills/builtin/claude_skills.d.ts +3 -1
  421. package/dist/skills/builtin/claude_skills.js +19 -15
  422. package/dist/skills/builtin/claude_skills.js.map +1 -1
  423. package/dist/skills/builtin/custom_skills.d.ts +10 -3
  424. package/dist/skills/builtin/custom_skills.js +26 -9
  425. package/dist/skills/builtin/custom_skills.js.map +1 -1
  426. package/dist/skills/builtin/datasphere.d.ts +5 -3
  427. package/dist/skills/builtin/datasphere.js +21 -22
  428. package/dist/skills/builtin/datasphere.js.map +1 -1
  429. package/dist/skills/builtin/datasphere_serverless.d.ts +12 -1
  430. package/dist/skills/builtin/datasphere_serverless.js +17 -6
  431. package/dist/skills/builtin/datasphere_serverless.js.map +1 -1
  432. package/dist/skills/builtin/datetime.d.ts +3 -1
  433. package/dist/skills/builtin/datetime.js +11 -7
  434. package/dist/skills/builtin/datetime.js.map +1 -1
  435. package/dist/skills/builtin/google_maps.d.ts +29 -14
  436. package/dist/skills/builtin/google_maps.js +89 -269
  437. package/dist/skills/builtin/google_maps.js.map +1 -1
  438. package/dist/skills/builtin/index.d.ts +8 -6
  439. package/dist/skills/builtin/index.js +8 -6
  440. package/dist/skills/builtin/index.js.map +1 -1
  441. package/dist/skills/builtin/info_gatherer.d.ts +4 -2
  442. package/dist/skills/builtin/info_gatherer.js +20 -12
  443. package/dist/skills/builtin/info_gatherer.js.map +1 -1
  444. package/dist/skills/builtin/joke.d.ts +16 -6
  445. package/dist/skills/builtin/joke.js +54 -37
  446. package/dist/skills/builtin/joke.js.map +1 -1
  447. package/dist/skills/builtin/math.d.ts +3 -1
  448. package/dist/skills/builtin/math.js +14 -9
  449. package/dist/skills/builtin/math.js.map +1 -1
  450. package/dist/skills/builtin/mcp_gateway.d.ts +34 -5
  451. package/dist/skills/builtin/mcp_gateway.js +77 -46
  452. package/dist/skills/builtin/mcp_gateway.js.map +1 -1
  453. package/dist/skills/builtin/native_vector_search.d.ts +19 -5
  454. package/dist/skills/builtin/native_vector_search.js +179 -61
  455. package/dist/skills/builtin/native_vector_search.js.map +1 -1
  456. package/dist/skills/builtin/play_background_file.d.ts +21 -15
  457. package/dist/skills/builtin/play_background_file.js +43 -122
  458. package/dist/skills/builtin/play_background_file.js.map +1 -1
  459. package/dist/skills/builtin/spider.d.ts +42 -4
  460. package/dist/skills/builtin/spider.js +277 -104
  461. package/dist/skills/builtin/spider.js.map +1 -1
  462. package/dist/skills/builtin/swml_transfer.d.ts +14 -3
  463. package/dist/skills/builtin/swml_transfer.js +45 -24
  464. package/dist/skills/builtin/swml_transfer.js.map +1 -1
  465. package/dist/skills/builtin/weather_api.d.ts +24 -13
  466. package/dist/skills/builtin/weather_api.js +38 -30
  467. package/dist/skills/builtin/weather_api.js.map +1 -1
  468. package/dist/skills/builtin/web_search.d.ts +48 -10
  469. package/dist/skills/builtin/web_search.js +294 -100
  470. package/dist/skills/builtin/web_search.js.map +1 -1
  471. package/dist/skills/builtin/wikipedia_search.d.ts +4 -2
  472. package/dist/skills/builtin/wikipedia_search.js +14 -13
  473. package/dist/skills/builtin/wikipedia_search.js.map +1 -1
  474. package/dist/skills/index.d.ts +3 -2
  475. package/dist/skills/index.js +1 -1
  476. package/dist/skills/index.js.map +1 -1
  477. package/dist/swml_verbs_generated.d.ts +2824 -0
  478. package/dist/swml_verbs_generated.js +12 -0
  479. package/dist/swml_verbs_generated.js.map +1 -0
  480. package/dist/types.d.ts +59 -6
  481. package/dist/web.d.ts +27 -0
  482. package/dist/web.js +20 -0
  483. package/dist/web.js.map +1 -0
  484. package/docs/agent-guide.md +1034 -0
  485. package/docs/ai_chat.md +560 -0
  486. package/docs/api-reference.md +3534 -0
  487. package/docs/architecture.md +846 -0
  488. package/docs/bedrock_agent.md +411 -0
  489. package/docs/cli-guide.md +403 -0
  490. package/docs/cloud_functions_guide.md +399 -0
  491. package/docs/configuration.md +548 -0
  492. package/docs/contexts-guide.md +884 -0
  493. package/docs/datamap-guide.md +1160 -0
  494. package/docs/developer_pain_points.md +548 -0
  495. package/docs/llm_parameters.md +298 -0
  496. package/docs/mcp_gateway_reference.md +354 -0
  497. package/docs/mcp_integration.md +162 -0
  498. package/docs/pgi_agent_guide.md +1820 -0
  499. package/docs/prefabs-guide.md +815 -0
  500. package/docs/programmatically_governed_inference.md +301 -0
  501. package/docs/sdk_features.md +501 -0
  502. package/docs/security.md +559 -0
  503. package/docs/serverless-guide.md +520 -0
  504. package/docs/skills-guide.md +1223 -0
  505. package/docs/skills-system.md +405 -0
  506. package/docs/skills_parameter_schema.md +417 -0
  507. package/docs/swaig-reference.md +1938 -0
  508. package/docs/swml_service_guide.md +573 -0
  509. package/docs/third_party_skills.md +410 -0
  510. package/docs/web_service.md +666 -0
  511. package/examples/README.md +202 -0
  512. package/examples/advanced-datamap.ts +108 -0
  513. package/examples/advanced-dynamic-config.ts +70 -0
  514. package/examples/auto-vivified.ts +95 -0
  515. package/examples/call-flow.ts +65 -0
  516. package/examples/comprehensive-dynamic.ts +125 -0
  517. package/examples/contexts-steps.ts +65 -0
  518. package/examples/custom-path.ts +45 -0
  519. package/examples/datamap-tools.ts +51 -0
  520. package/examples/datasphere-multi-instance.ts +66 -0
  521. package/examples/datasphere-serverless-env.ts +87 -0
  522. package/examples/datasphere-webhook-env.ts +65 -0
  523. package/examples/datasphere.ts +56 -0
  524. package/examples/declarative.ts +100 -0
  525. package/examples/dynamic-config.ts +54 -0
  526. package/examples/dynamic-info-gatherer.ts +69 -0
  527. package/examples/dynamic-swml-service.ts +67 -0
  528. package/examples/gather-info.ts +95 -0
  529. package/examples/gather-per-question-functions-demo.ts +139 -0
  530. package/examples/joke-agent.ts +34 -0
  531. package/examples/kubernetes-agent.ts +45 -0
  532. package/examples/llm-params.ts +75 -0
  533. package/examples/mcp-agent.ts +89 -0
  534. package/examples/mcp-gateway.ts +81 -0
  535. package/examples/multi-agent.ts +80 -0
  536. package/examples/multi-endpoint.ts +79 -0
  537. package/examples/pgi/case-domain.ts +114 -0
  538. package/examples/pgi/serve.ts +16 -0
  539. package/examples/pgi/support-agent.ts +265 -0
  540. package/examples/pom-prompt.ts +70 -0
  541. package/examples/prefab-concierge.ts +42 -0
  542. package/examples/prefab-faq.ts +58 -0
  543. package/examples/prefab-info-gatherer.ts +33 -0
  544. package/examples/prefab-receptionist.ts +36 -0
  545. package/examples/prefab-survey.ts +69 -0
  546. package/examples/quickstart-agent.ts +29 -0
  547. package/examples/quickstart-relay.ts +25 -0
  548. package/examples/quickstart-rest.ts +25 -0
  549. package/examples/record-call.ts +65 -0
  550. package/examples/relay-demo.ts +33 -0
  551. package/examples/room-and-sip.ts +93 -0
  552. package/examples/serverless-lambda.ts +43 -0
  553. package/examples/session-state.ts +83 -0
  554. package/examples/simple-agent.ts +36 -0
  555. package/examples/simple-static.ts +29 -0
  556. package/examples/skills-demo.ts +41 -0
  557. package/examples/step-function-inheritance-demo.ts +124 -0
  558. package/examples/swaig-features.ts +193 -0
  559. package/examples/swml-service-routing.ts +66 -0
  560. package/examples/swml-service.ts +38 -0
  561. package/examples/swmlservice_ai_sidecar.ts +104 -0
  562. package/examples/swmlservice_swaig_standalone.ts +79 -0
  563. package/examples/tap.ts +67 -0
  564. package/examples/typed-tools.ts +68 -0
  565. package/examples/verb-methods.ts +45 -0
  566. package/examples/web-search-multi-instance.ts +75 -0
  567. package/examples/web-search.ts +38 -0
  568. package/examples/wikipedia.ts +36 -0
  569. package/livewire/README.md +164 -0
  570. package/livewire/docs/migration-guide.md +251 -0
  571. package/livewire/examples/livewire-basic-agent.ts +74 -0
  572. package/livewire/examples/livewire-handoff.ts +196 -0
  573. package/livewire/examples/livewire-multi-tool.ts +121 -0
  574. package/package.json +85 -13
  575. package/relay/README.md +101 -0
  576. package/relay/docs/call-methods.md +622 -0
  577. package/relay/docs/client-reference.md +281 -0
  578. package/relay/docs/events.md +193 -0
  579. package/relay/docs/getting-started.md +221 -0
  580. package/relay/docs/guide.md +386 -0
  581. package/relay/docs/messaging.md +246 -0
  582. package/relay/examples/relay-inbound.ts +66 -0
  583. package/relay/examples/relay-messaging.ts +74 -0
  584. package/relay/examples/relay-outbound.ts +76 -0
  585. package/rest/README.md +141 -0
  586. package/rest/docs/calling.md +313 -0
  587. package/rest/docs/client-reference.md +149 -0
  588. package/rest/docs/fabric.md +192 -0
  589. package/rest/docs/getting-started.md +138 -0
  590. package/rest/docs/guide.md +421 -0
  591. package/rest/docs/namespaces.md +367 -0
  592. package/rest/docs/phone-binding.md +116 -0
  593. package/rest/examples/rest-10dlc-registration.ts +177 -0
  594. package/rest/examples/rest-bind-phone-to-swml-webhook.ts +66 -0
  595. package/rest/examples/rest-calling-ivr-and-ai.ts +136 -0
  596. package/rest/examples/rest-calling-play-and-record.ts +98 -0
  597. package/rest/examples/rest-client.ts +59 -0
  598. package/rest/examples/rest-datasphere-search.ts +81 -0
  599. package/rest/examples/rest-fabric-conferences-and-routing.ts +147 -0
  600. package/rest/examples/rest-fabric-subscribers-and-sip.ts +106 -0
  601. package/rest/examples/rest-fabric-swml-and-callflows.ts +101 -0
  602. package/rest/examples/rest-manage-resources.ts +64 -0
  603. package/rest/examples/rest-phone-number-management.ts +200 -0
  604. package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
  605. package/rest/examples/rest-video-rooms.ts +186 -0
  606. package/tutorial/fred/fred.ts +218 -0
  607. package/tutorial/fred/tutorial/01-introduction.md +141 -0
  608. package/tutorial/fred/tutorial/02-setup.md +304 -0
  609. package/tutorial/fred/tutorial/03-basic-agent.md +284 -0
  610. package/tutorial/fred/tutorial/04-wikipedia-skill.md +298 -0
  611. package/tutorial/fred/tutorial/05-custom-functions.md +347 -0
  612. package/tutorial/fred/tutorial/06-running-testing.md +642 -0
  613. package/tutorial/fred/tutorial/README.md +56 -0
  614. package/tutorial/fred/tutorial/appendix-complete-code.md +632 -0
  615. package/tutorial/fred/tutorial/appendix-docker-deployment.md +504 -0
  616. package/tutorial/full-guardrails-agent/handlers.ts +436 -0
  617. package/tutorial/full-guardrails-agent/penny.ts +305 -0
  618. package/tutorial/full-guardrails-agent/reservations.ts +1109 -0
  619. package/tutorial/full-guardrails-agent/tutorial/01-why-guardrails.md +149 -0
  620. package/tutorial/full-guardrails-agent/tutorial/02-design-first.md +139 -0
  621. package/tutorial/full-guardrails-agent/tutorial/03-rules-first.md +422 -0
  622. package/tutorial/full-guardrails-agent/tutorial/04-the-shell.md +238 -0
  623. package/tutorial/full-guardrails-agent/tutorial/05-steps-and-scoping.md +247 -0
  624. package/tutorial/full-guardrails-agent/tutorial/06-tools-that-decide.md +467 -0
  625. package/tutorial/full-guardrails-agent/tutorial/07-gather-and-projection.md +160 -0
  626. package/tutorial/full-guardrails-agent/tutorial/08-the-verification-gate.md +333 -0
  627. package/tutorial/full-guardrails-agent/tutorial/09-people-and-endings.md +313 -0
  628. package/tutorial/full-guardrails-agent/tutorial/10-testing-and-running.md +387 -0
  629. package/tutorial/full-guardrails-agent/tutorial/README.md +106 -0
  630. package/tutorial/full-guardrails-agent/tutorial/appendix-complete-code.md +2207 -0
  631. package/tutorial/full-guardrails-agent/tutorial/appendix-deployment.md +191 -0
  632. package/tutorial/full-guardrails-agent/tutorial/appendix-technique-map.md +117 -0
  633. package/tutorial/full-guardrails-agent/workflow.ts +219 -0
  634. package/tutorial/multi_agents/README.md +175 -0
  635. package/tutorial/multi_agents/advanced_agent.ts +395 -0
  636. package/tutorial/multi_agents/extending_agents.ts +641 -0
  637. package/tutorial/multi_agents/knowledge.ts +59 -0
  638. package/tutorial/multi_agents/lesson1_first_agent.md +368 -0
  639. package/tutorial/multi_agents/lesson2_knowledge_bases.md +404 -0
  640. package/tutorial/multi_agents/lesson3_multi_agent_systems.md +621 -0
  641. package/tutorial/multi_agents/lesson4_advanced_features.md +805 -0
  642. package/tutorial/multi_agents/lesson5_extending_agents.md +856 -0
  643. package/tutorial/multi_agents/pc_builder.ts +529 -0
  644. package/tutorial/multi_agents/sales_agent.ts +88 -0
  645. package/tutorial/multi_agents/sales_agent_with_search.ts +116 -0
  646. package/tutorial/multi_agents/sales_knowledge.md +139 -0
  647. package/tutorial/multi_agents/support_knowledge.md +256 -0
  648. package/dist/cli/mock-data.d.ts +0 -37
  649. package/dist/cli/mock-data.js +0 -80
  650. package/dist/cli/mock-data.js.map +0 -1
  651. package/dist/generateVerbTypes.d.ts +0 -11
  652. package/dist/generateVerbTypes.js +0 -265
  653. package/dist/generateVerbTypes.js.map +0 -1
  654. package/dist/rest/namespaces/compat.d.ts +0 -585
  655. package/dist/rest/namespaces/compat.js +0 -735
  656. package/dist/rest/namespaces/compat.js.map +0 -1
@@ -0,0 +1,323 @@
1
+ /**
2
+ * BedrockAgent - Amazon Bedrock voice-to-voice integration.
3
+ *
4
+ * Extends {@link AgentBase} to support Amazon Bedrock's voice-to-voice model
5
+ * while keeping full compatibility with the SignalWire agent ecosystem
6
+ * (skills, POM, SWAIG functions, post-prompt). The one behavioral difference
7
+ * from a standard agent is that the rendered SWML uses the `amazon_bedrock`
8
+ * verb instead of `ai`. Speech hints, languages, pronunciation rules,
9
+ * multilingual settings and contexts aren't part of that verb, so they're
10
+ * left out of the SWML, with one warning per agent for each.
11
+ *
12
+ * Ported from the Python SDK `signalwire.agents.bedrock.BedrockAgent`.
13
+ */
14
+ import { AgentBase } from '../AgentBase.js';
15
+ /** The `ai` verb keys the `amazon_bedrock` verb carries over; the rest are left out. */
16
+ const BEDROCK_VERB_KEYS = new Set([
17
+ 'prompt',
18
+ 'SWAIG',
19
+ 'params',
20
+ 'global_data',
21
+ 'post_prompt',
22
+ 'post_prompt_url',
23
+ ]);
24
+ /**
25
+ * The prompt keys copied from the `ai` verb's prompt. The platform's Bedrock
26
+ * session reads only these, `voice_id`, `temperature` and `top_p`; the last
27
+ * three are set from the agent's own settings, as is `max_tokens`.
28
+ */
29
+ const BEDROCK_PROMPT_KEYS = new Set(['text', 'pom']);
30
+ /** The prompt keys set from the agent's own settings. */
31
+ const AGENT_PROMPT_KEYS = new Set([
32
+ 'voice_id',
33
+ 'temperature',
34
+ 'top_p',
35
+ 'max_tokens',
36
+ ]);
37
+ /** What the `ai` verb keys that Bedrock leaves out are, for the warning. */
38
+ const FEATURE_NAMES = {
39
+ hints: "speech hints (addHint(), addHints(), addPatternHint() and skills' hints)",
40
+ languages: 'languages (addLanguage())',
41
+ pronounce: 'pronunciation rules (addPronunciation())',
42
+ multilingual: 'multilingual settings (setMultilingual())',
43
+ contexts: 'contexts and steps (defineContexts())',
44
+ };
45
+ /** A SWML variable reference, such as `${temperature}`, which the schema accepts for temperature and top_p. */
46
+ const SWML_VAR = /^[$%]\{.*\}$/;
47
+ /** A decimal number as a string, such as `0.7`, `-1`, `.5` or `1e3` (not `0x10` or `''`). */
48
+ const DECIMAL = /^[+-]?(\d+\.?\d*|\.\d+)(e[+-]?\d+)?$/i;
49
+ /** `"it's"` for one name and `"they're"` for more, for the warnings below. */
50
+ function itOrThey(names) {
51
+ return names.length === 1 ? "it's" : "they're";
52
+ }
53
+ /** A value as it appears in an error message. */
54
+ function describeValue(value) {
55
+ if (typeof value === 'string')
56
+ return JSON.stringify(value);
57
+ if (typeof value === 'object' && value !== null) {
58
+ try {
59
+ return JSON.stringify(value);
60
+ }
61
+ catch {
62
+ return String(value);
63
+ }
64
+ }
65
+ return String(value);
66
+ }
67
+ function toNumber(name, value, integer = false) {
68
+ if (!integer && typeof value === 'string' && SWML_VAR.test(value.trim()))
69
+ return value.trim();
70
+ const fail = () => {
71
+ throw new Error(`BedrockAgent ${name} must be ${integer ? 'an integer' : 'a number'}, got ${describeValue(value)}`);
72
+ };
73
+ let number;
74
+ if (typeof value === 'number')
75
+ number = value;
76
+ else if (typeof value === 'string' && DECIMAL.test(value.trim()))
77
+ number = Number(value.trim());
78
+ else
79
+ return fail();
80
+ if (!Number.isFinite(number))
81
+ return fail();
82
+ if (integer && !Number.isInteger(number))
83
+ return fail();
84
+ return number;
85
+ }
86
+ /**
87
+ * Agent implementation for the Amazon Bedrock voice-to-voice model.
88
+ *
89
+ * Supports all standard agent features (prompt building with text and POM,
90
+ * skills and SWAIG functions, post-prompt, dynamic configuration) but renders
91
+ * SWML with the `amazon_bedrock` verb rather than `ai`.
92
+ *
93
+ * @example
94
+ * ```ts
95
+ * import { BedrockAgent } from '@signalwire/sdk';
96
+ *
97
+ * const agent = new BedrockAgent({
98
+ * systemPrompt: 'You are a helpful voice assistant.',
99
+ * voiceId: 'tiffany',
100
+ * });
101
+ *
102
+ * agent.setInferenceParams(0.5, 0.95, 2048);
103
+ * await agent.serve({ port: 3000 });
104
+ * ```
105
+ */
106
+ export class BedrockAgent extends AgentBase {
107
+ _voiceId;
108
+ _temperature;
109
+ _topP;
110
+ _maxTokens;
111
+ /**
112
+ * Features already reported as left out of the `amazon_bedrock` verb, so
113
+ * each is reported once per agent. A per-request copy shares this set.
114
+ */
115
+ _bedrockDroppedWarned = new Set();
116
+ /**
117
+ * Create a BedrockAgent.
118
+ * @param config - Configuration including voice, inference params, and optional system prompt.
119
+ * @throws Error if `temperature` or `topP` isn't a number, or `maxTokens` isn't an integer.
120
+ */
121
+ constructor(config = {}) {
122
+ // Check the inference settings before building the agent.
123
+ const temperature = toNumber('temperature', config.temperature ?? 0.7);
124
+ const topP = toNumber('top_p', config.topP ?? 0.9);
125
+ const maxTokens = toNumber('max_tokens', config.maxTokens ?? 1024, true);
126
+ super({
127
+ name: config.name ?? 'bedrock_agent',
128
+ route: config.route ?? '/bedrock',
129
+ ...config.agentOptions,
130
+ });
131
+ // Store Bedrock-specific parameters.
132
+ this._voiceId = config.voiceId ?? 'matthew';
133
+ this._temperature = temperature;
134
+ this._topP = topP;
135
+ this._maxTokens = maxTokens;
136
+ // Set initial prompt if provided (after super init).
137
+ if (config.systemPrompt) {
138
+ this.setPromptText(config.systemPrompt);
139
+ }
140
+ this.log.info(`BedrockAgent initialized: ${this.name} on route ${this.route}`);
141
+ }
142
+ /**
143
+ * Render the SWML document, transforming the base `ai` verb into an
144
+ * `amazon_bedrock` verb with the same structure. Mirrors Python
145
+ * `BedrockAgent._render_swml`.
146
+ *
147
+ * Only `prompt`, `SWAIG`, `params`, `global_data`, `post_prompt` and
148
+ * `post_prompt_url` are carried over. Anything else on the `ai` verb, such
149
+ * as `hints`, `languages`, `pronounce`, `multilingual` or the debug webhook
150
+ * keys, is left out, as is anything in the prompt that the Bedrock prompt
151
+ * doesn't define, such as `contexts`. The agent logs one warning for each
152
+ * feature it leaves out, the first time it leaves it out.
153
+ */
154
+ renderSwml(callId, modifications) {
155
+ // Build the base SWML with the ai verb, then transform it.
156
+ const baseSwmlJson = super.renderSwml(callId, modifications);
157
+ const swml = JSON.parse(baseSwmlJson);
158
+ const sections = swml['sections'] ?? {};
159
+ const mainSection = sections['main'] ?? [];
160
+ for (let i = 0; i < mainSection.length; i++) {
161
+ const verb = mainSection[i];
162
+ if ('ai' in verb) {
163
+ const aiConfig = verb['ai'] ?? {};
164
+ // The ai verb's other keys (hints, languages, pronounce,
165
+ // multilingual) have no place in the amazon_bedrock verb.
166
+ this.warnDropped(Object.keys(aiConfig).filter((key) => !BEDROCK_VERB_KEYS.has(key)), 'the amazon_bedrock verb has no');
167
+ // Build the amazon_bedrock verb with the same structure. Voice and
168
+ // inference params live inside the prompt object for Bedrock.
169
+ const bedrockConfig = {
170
+ prompt: this.addVoiceToPrompt(aiConfig['prompt'] ?? {}),
171
+ SWAIG: aiConfig['SWAIG'] ?? {},
172
+ params: aiConfig['params'] ?? {},
173
+ global_data: aiConfig['global_data'] ?? {},
174
+ post_prompt: aiConfig['post_prompt'],
175
+ post_prompt_url: aiConfig['post_prompt_url'],
176
+ };
177
+ // Remove undefined/null values.
178
+ const cleaned = {};
179
+ for (const [k, v] of Object.entries(bedrockConfig)) {
180
+ if (v !== undefined && v !== null)
181
+ cleaned[k] = v;
182
+ }
183
+ mainSection[i] = { amazon_bedrock: cleaned };
184
+ break;
185
+ }
186
+ }
187
+ return JSON.stringify(swml);
188
+ }
189
+ /** Log a warning, once per agent, for each feature left out of the SWML. */
190
+ warnDropped(keys, reason) {
191
+ for (const key of keys) {
192
+ if (this._bedrockDroppedWarned.has(key))
193
+ continue;
194
+ this._bedrockDroppedWarned.add(key);
195
+ const what = key in FEATURE_NAMES ? `the agent's ${FEATURE_NAMES[key]} are` : "it's";
196
+ this.log.warn(`BedrockAgent: ${reason} ${key}, so ${what} left out of the SWML`);
197
+ }
198
+ }
199
+ /**
200
+ * Add voice configuration to the prompt object. In Bedrock, voice and
201
+ * inference params are part of the prompt object (not separate fields).
202
+ * Mirrors Python `_add_voice_to_prompt`.
203
+ */
204
+ addVoiceToPrompt(promptConfig) {
205
+ const filtered = {};
206
+ // Copy the prompt text. Anything else, such as confidence or contexts, is
207
+ // left out: the platform's Bedrock session doesn't read it.
208
+ for (const [key, value] of Object.entries(promptConfig)) {
209
+ if (BEDROCK_PROMPT_KEYS.has(key))
210
+ filtered[key] = value;
211
+ }
212
+ // voice_id and the inference settings are replaced below, so only the
213
+ // other keys are features the Bedrock prompt leaves out.
214
+ this.warnDropped(Object.keys(promptConfig).filter((key) => !BEDROCK_PROMPT_KEYS.has(key) && !AGENT_PROMPT_KEYS.has(key)), "Bedrock's prompt has no");
215
+ filtered['voice_id'] = this._voiceId;
216
+ filtered['temperature'] = this._temperature;
217
+ filtered['top_p'] = this._topP;
218
+ filtered['max_tokens'] = this._maxTokens;
219
+ return filtered;
220
+ }
221
+ /**
222
+ * Set the Bedrock voice: `tiffany`, `matthew`, `amy`, `lupe` or `carlos`.
223
+ * Mirrors Python `set_voice`.
224
+ */
225
+ setVoice(voiceId) {
226
+ this._voiceId = voiceId;
227
+ this.log.debug(`Voice set to: ${voiceId}`);
228
+ return this;
229
+ }
230
+ /**
231
+ * Update Bedrock inference parameters. Any argument left undefined (or
232
+ * null) is unchanged. Each value may be a number or a numeric string, which
233
+ * is converted. `temperature` and `topP` may also be a SWML variable
234
+ * reference such as `${temperature}`. The platform's Bedrock session applies
235
+ * `temperature` (0 to 2) and `topP` (0 to 1), and doesn't read `maxTokens`: it
236
+ * uses 1024. Mirrors Python `set_inference_params`.
237
+ *
238
+ * @throws Error if `temperature` or `topP` isn't a number, or `maxTokens`
239
+ * isn't an integer. Nothing is changed when a value is refused.
240
+ */
241
+ setInferenceParams(temperature, topP, maxTokens) {
242
+ // Convert all three before changing any, so a refused value leaves the
243
+ // settings as they were.
244
+ const newTemperature = temperature != null ? toNumber('temperature', temperature) : undefined;
245
+ const newTopP = topP != null ? toNumber('top_p', topP) : undefined;
246
+ const newMaxTokens = maxTokens != null ? toNumber('max_tokens', maxTokens, true) : undefined;
247
+ if (newTemperature !== undefined)
248
+ this._temperature = newTemperature;
249
+ if (newTopP !== undefined)
250
+ this._topP = newTopP;
251
+ if (newMaxTokens !== undefined)
252
+ this._maxTokens = newMaxTokens;
253
+ this.log.debug(`Inference params updated: temp=${this._temperature}, top_p=${this._topP}, max_tokens=${this._maxTokens}`);
254
+ return this;
255
+ }
256
+ /**
257
+ * Set the LLM model — not applicable for Bedrock, which uses a fixed
258
+ * voice-to-voice model. Logs a warning and does nothing.
259
+ * Mirrors Python `set_llm_model`.
260
+ */
261
+ setLlmModel(model) {
262
+ this.log.warn(`setLlmModel('${model}') called but Bedrock uses a fixed voice-to-voice model`);
263
+ return this;
264
+ }
265
+ /**
266
+ * Set the LLM temperature — redirects to {@link setInferenceParams}.
267
+ * Mirrors Python `set_llm_temperature`.
268
+ *
269
+ * @throws Error if `temperature` isn't a number or a SWML variable reference.
270
+ */
271
+ setLlmTemperature(temperature) {
272
+ return this.setInferenceParams(temperature);
273
+ }
274
+ /**
275
+ * Set post-prompt LLM parameters — not applicable for Bedrock (its
276
+ * post-prompt uses OpenAI configured in the engine). Logs a warning.
277
+ * Mirrors Python `set_post_prompt_llm_params`.
278
+ */
279
+ setPostPromptLlmParams(_params) {
280
+ this.log.warn('setPostPromptLlmParams() called but Bedrock post-prompt uses OpenAI configured in the engine');
281
+ return this;
282
+ }
283
+ /**
284
+ * Set the prompt's inference settings.
285
+ *
286
+ * `temperature`, `top_p` and `max_tokens` update the inference settings, as
287
+ * {@link setInferenceParams} does, which converts numeric strings and
288
+ * throws for other values. The platform's Bedrock session reads no other
289
+ * prompt setting, so anything else, such as `confidence`,
290
+ * `presence_penalty` or `barge_confidence`, is ignored with a warning.
291
+ * Mirrors Python `set_prompt_llm_params`.
292
+ *
293
+ * @param params - Prompt settings, with their SWML names.
294
+ * @returns This agent, for chaining.
295
+ * @throws Error if `temperature` or `top_p` isn't a number, or `max_tokens`
296
+ * isn't an integer. Nothing is changed when a value is refused.
297
+ */
298
+ setPromptLlmParams(params) {
299
+ const rest = { ...params };
300
+ const take = (key) => {
301
+ const value = rest[key];
302
+ delete rest[key];
303
+ // setInferenceParams() checks the value, and treats null as not given.
304
+ return value;
305
+ };
306
+ this.setInferenceParams(take('temperature'), take('top_p'), take('max_tokens'));
307
+ const ignored = Object.keys(rest).sort();
308
+ if (ignored.length > 0) {
309
+ this.log.warn(`setPromptLlmParams(): the platform's Bedrock session doesn't use ${ignored.join(', ')}, so ${itOrThey(ignored)} ignored`);
310
+ }
311
+ return this;
312
+ }
313
+ }
314
+ /**
315
+ * Factory function that creates and returns a new BedrockAgent.
316
+ * @param config - Configuration for the Bedrock agent.
317
+ * @returns A configured BedrockAgent instance.
318
+ */
319
+ export function createBedrockAgent(config = {}) {
320
+ return new BedrockAgent(config);
321
+ }
322
+ export default BedrockAgent;
323
+ //# sourceMappingURL=BedrockAgent.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"BedrockAgent.js","sourceRoot":"","sources":["../../src/agents/BedrockAgent.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAG5C,wFAAwF;AACxF,MAAM,iBAAiB,GAAwB,IAAI,GAAG,CAAC;IACrD,QAAQ;IACR,OAAO;IACP,QAAQ;IACR,aAAa;IACb,aAAa;IACb,iBAAiB;CAClB,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,mBAAmB,GAAwB,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;AAE1E,yDAAyD;AACzD,MAAM,iBAAiB,GAAwB,IAAI,GAAG,CAAC;IACrD,UAAU;IACV,aAAa;IACb,OAAO;IACP,YAAY;CACb,CAAC,CAAC;AAEH,4EAA4E;AAC5E,MAAM,aAAa,GAAqC;IACtD,KAAK,EAAE,0EAA0E;IACjF,SAAS,EAAE,2BAA2B;IACtC,SAAS,EAAE,0CAA0C;IACrD,YAAY,EAAE,2CAA2C;IACzD,QAAQ,EAAE,uCAAuC;CAClD,CAAC;AAEF,+GAA+G;AAC/G,MAAM,QAAQ,GAAG,cAAc,CAAC;AAEhC,6FAA6F;AAC7F,MAAM,OAAO,GAAG,uCAAuC,CAAC;AAExD,8EAA8E;AAC9E,SAAS,QAAQ,CAAC,KAAe;IAC/B,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;AACjD,CAAC;AAED,iDAAiD;AACjD,SAAS,aAAa,CAAC,KAAc;IACnC,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC5D,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAChD,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;AACvB,CAAC;AAaD,SAAS,QAAQ,CAAC,IAAY,EAAE,KAAc,EAAE,OAAO,GAAG,KAAK;IAC7D,IAAI,CAAC,OAAO,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;QAAE,OAAO,KAAK,CAAC,IAAI,EAAE,CAAC;IAC9F,MAAM,IAAI,GAAG,GAAU,EAAE;QACvB,MAAM,IAAI,KAAK,CACb,gBAAgB,IAAI,YAAY,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,UAAU,SAAS,aAAa,CAAC,KAAK,CAAC,EAAE,CACnG,CAAC;IACJ,CAAC,CAAC;IACF,IAAI,MAAc,CAAC;IACnB,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,MAAM,GAAG,KAAK,CAAC;SACzC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;QAAE,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;;QAC3F,OAAO,IAAI,EAAE,CAAC;IACnB,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC;QAAE,OAAO,IAAI,EAAE,CAAC;IAC5C,IAAI,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC;QAAE,OAAO,IAAI,EAAE,CAAC;IACxD,OAAO,MAAM,CAAC;AAChB,CAAC;AAiCD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,OAAO,YAAa,SAAQ,SAAS;IACjC,QAAQ,CAAS;IACjB,YAAY,CAAkB;IAC9B,KAAK,CAAkB;IACvB,UAAU,CAAS;IAC3B;;;OAGG;IACK,qBAAqB,GAAG,IAAI,GAAG,EAAU,CAAC;IAElD;;;;OAIG;IACH,YAAY,SAA6B,EAAE;QACzC,0DAA0D;QAC1D,MAAM,WAAW,GAAG,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC,WAAW,IAAI,GAAG,CAAC,CAAC;QACvE,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC;QACnD,MAAM,SAAS,GAAG,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC,SAAS,IAAI,IAAI,EAAE,IAAI,CAAC,CAAC;QAEzE,KAAK,CAAC;YACJ,IAAI,EAAE,MAAM,CAAC,IAAI,IAAI,eAAe;YACpC,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,UAAU;YACjC,GAAG,MAAM,CAAC,YAAY;SACvB,CAAC,CAAC;QAEH,qCAAqC;QACrC,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,OAAO,IAAI,SAAS,CAAC;QAC5C,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAE5B,qDAAqD;QACrD,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;YACxB,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAC1C,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,6BAA6B,IAAI,CAAC,IAAI,aAAa,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;OAWG;IACM,UAAU,CAAC,MAAe,EAAE,aAAuC;QAC1E,2DAA2D;QAC3D,MAAM,YAAY,GAAG,KAAK,CAAC,UAAU,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;QAC7D,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAA4B,CAAC;QAEjE,MAAM,QAAQ,GAAI,IAAI,CAAC,UAAU,CAA6B,IAAI,EAAE,CAAC;QACrE,MAAM,WAAW,GAAI,QAAQ,CAAC,MAAM,CAA+B,IAAI,EAAE,CAAC;QAE1E,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC5C,MAAM,IAAI,GAAG,WAAW,CAAC,CAAC,CAAE,CAAC;YAC7B,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;gBACjB,MAAM,QAAQ,GAAI,IAAI,CAAC,IAAI,CAA6B,IAAI,EAAE,CAAC;gBAC/D,yDAAyD;gBACzD,0DAA0D;gBAC1D,IAAI,CAAC,WAAW,CACd,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,iBAAiB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAClE,gCAAgC,CACjC,CAAC;gBAEF,mEAAmE;gBACnE,8DAA8D;gBAC9D,MAAM,aAAa,GAA4B;oBAC7C,MAAM,EAAE,IAAI,CAAC,gBAAgB,CAAE,QAAQ,CAAC,QAAQ,CAA6B,IAAI,EAAE,CAAC;oBACpF,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE;oBAC9B,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE;oBAChC,WAAW,EAAE,QAAQ,CAAC,aAAa,CAAC,IAAI,EAAE;oBAC1C,WAAW,EAAE,QAAQ,CAAC,aAAa,CAAC;oBACpC,eAAe,EAAE,QAAQ,CAAC,iBAAiB,CAAC;iBAC7C,CAAC;gBAEF,gCAAgC;gBAChC,MAAM,OAAO,GAA4B,EAAE,CAAC;gBAC5C,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;oBACnD,IAAI,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,IAAI;wBAAE,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;gBACpD,CAAC;gBAED,WAAW,CAAC,CAAC,CAAC,GAAG,EAAE,cAAc,EAAE,OAAO,EAAE,CAAC;gBAC7C,MAAM;YACR,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED,4EAA4E;IACpE,WAAW,CAAC,IAAc,EAAE,MAAc;QAChD,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,IAAI,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,GAAG,CAAC;gBAAE,SAAS;YAClD,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACpC,MAAM,IAAI,GAAG,GAAG,IAAI,aAAa,CAAC,CAAC,CAAC,eAAe,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC;YACrF,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,iBAAiB,MAAM,IAAI,GAAG,QAAQ,IAAI,uBAAuB,CAAC,CAAC;QACnF,CAAC;IACH,CAAC;IAED;;;;OAIG;IACK,gBAAgB,CAAC,YAAqC;QAC5D,MAAM,QAAQ,GAA4B,EAAE,CAAC;QAC7C,0EAA0E;QAC1E,4DAA4D;QAC5D,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;YACxD,IAAI,mBAAmB,CAAC,GAAG,CAAC,GAAG,CAAC;gBAAE,QAAQ,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QAC1D,CAAC;QACD,sEAAsE;QACtE,yDAAyD;QACzD,IAAI,CAAC,WAAW,CACd,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,MAAM,CAC9B,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,mBAAmB,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,GAAG,CAAC,CACtE,EACD,yBAAyB,CAC1B,CAAC;QACF,QAAQ,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;QACrC,QAAQ,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;QAC5C,QAAQ,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC;QAC/B,QAAQ,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC;QACzC,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,OAAe;QACtB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,iBAAiB,OAAO,EAAE,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;OAUG;IACH,kBAAkB,CAChB,WAAoC,EACpC,IAA6B,EAC7B,SAAkC;QAElC,uEAAuE;QACvE,yBAAyB;QACzB,MAAM,cAAc,GAAG,WAAW,IAAI,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC9F,MAAM,OAAO,GAAG,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACnE,MAAM,YAAY,GAAG,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,YAAY,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC7F,IAAI,cAAc,KAAK,SAAS;YAAE,IAAI,CAAC,YAAY,GAAG,cAAc,CAAC;QACrE,IAAI,OAAO,KAAK,SAAS;YAAE,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC;QAChD,IAAI,YAAY,KAAK,SAAS;YAAE,IAAI,CAAC,UAAU,GAAG,YAAY,CAAC;QAC/D,IAAI,CAAC,GAAG,CAAC,KAAK,CACZ,kCAAkC,IAAI,CAAC,YAAY,WAAW,IAAI,CAAC,KAAK,gBAAgB,IAAI,CAAC,UAAU,EAAE,CAC1G,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,WAAW,CAAC,KAAa;QACvB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,gBAAgB,KAAK,yDAAyD,CAAC,CAAC;QAC9F,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,iBAAiB,CAAC,WAA4B;QAC5C,OAAO,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACH,sBAAsB,CAAC,OAAgC;QACrD,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,8FAA8F,CAC/F,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACM,kBAAkB,CAAC,MAA+B;QACzD,MAAM,IAAI,GAAG,EAAE,GAAG,MAAM,EAAE,CAAC;QAC3B,MAAM,IAAI,GAAG,CAAC,GAAW,EAA+B,EAAE;YACxD,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;YACxB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;YACjB,uEAAuE;YACvE,OAAO,KAAoC,CAAC;QAC9C,CAAC,CAAC;QACF,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;QAChF,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;QACzC,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvB,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,oEAAoE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,QAAQ,CAAC,OAAO,CAAC,UAAU,CAC1H,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAAC,SAA6B,EAAE;IAChE,OAAO,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC;AAClC,CAAC;AAED,eAAe,YAAY,CAAC"}
@@ -0,0 +1,316 @@
1
+ /**
2
+ * AIChatClient — async client for the SignalWire AI Chat service.
3
+ *
4
+ * Speaks the standard SignalWire front-door protocol: HTTP Basic
5
+ * `project:api_token` with the space in the hostname —
6
+ * `POST https://{space}.signalwire.com/api/ai/chat` — carrying a JSON-RPC 2.0
7
+ * body whose params are pure payload (identity NEVER appears in the body; it
8
+ * rides the Basic-auth header only).
9
+ *
10
+ * Async by nature: a {@link AIChatClient.chat} call awaits a full LLM round trip
11
+ * (seconds, not milliseconds). The service streams keepalive whitespace ahead of
12
+ * a slow response body (proxy read-timeout protection), so liveness is byte-driven
13
+ * rather than wall-clock: there is no total-request timeout a slow turn could
14
+ * trip, only an idle timeout that restarts with every chunk received, as with
15
+ * the python reference's `aiohttp.ClientTimeout(total=None, sock_read=60)`.
16
+ * Leading whitespace is valid JSON, so parsing the buffered body is unaffected.
17
+ *
18
+ * URL resolution, in order:
19
+ *
20
+ * 1. The `url` option, used verbatim.
21
+ * 2. The `RAILS_DEV_MODE` environment variable, when it holds a URL rather than
22
+ * a boolean (point it at a dev chat service, e.g. `http://localhost:8080/`).
23
+ * 3. `https://{space}.signalwire.com/api/ai/chat`, from the `space` option or
24
+ * `SIGNALWIRE_SPACE`. A space hostname (`example.signalwire.com`), the form
25
+ * the REST client reads from the same variable, is accepted too.
26
+ *
27
+ * Mirrors the python reference `signalwire.ai_chat.AIChatClient`.
28
+ *
29
+ * @example
30
+ * ```ts
31
+ * import { AIChatClient } from '@signalwire/sdk';
32
+ *
33
+ * const client = new AIChatClient({ space: 'myspace' }); // env supplies creds
34
+ * await client.createConversation('conv-1', { configUrl: 'https://example.com/agent.yaml' });
35
+ * const reply = await client.chat('conv-1', 'hello');
36
+ * console.log(reply.text);
37
+ * ```
38
+ */
39
+ /**
40
+ * Base error for AI Chat service failures. Every typed subclass carries the
41
+ * JSON-RPC error `code` (or `null` when the failure rode the success envelope,
42
+ * as with {@link SummaryError}) and the server `message`.
43
+ *
44
+ * Callers catch this one family (`instanceof AIChatError`) for every AI-Chat
45
+ * failure and can branch on `code` or the subclass type.
46
+ */
47
+ export declare class AIChatError extends Error {
48
+ /** JSON-RPC error code, or `null` when the failure rode the success envelope. */
49
+ readonly code: number | null;
50
+ /** The server-provided error message (without the `[code]` prefix). */
51
+ readonly serverMessage: string;
52
+ /**
53
+ * @param code - JSON-RPC error code, or `null` (a success-envelope failure).
54
+ * @param message - The server-provided error message.
55
+ */
56
+ constructor(code: number | null, message: string);
57
+ }
58
+ /** Missing/rejected identity (HTTP 401 / JSON-RPC -32009). */
59
+ export declare class AuthenticationError extends AIChatError {
60
+ constructor(code: number | null, message: string);
61
+ }
62
+ /** The conversation does not exist in this project (-32001). */
63
+ export declare class ConversationNotFoundError extends AIChatError {
64
+ constructor(code: number | null, message: string);
65
+ }
66
+ /** Project or conversation rate limit hit (-32005 / -32006). */
67
+ export declare class RateLimitError extends AIChatError {
68
+ constructor(code: number | null, message: string);
69
+ }
70
+ /** Another message is being processed for this conversation (-32007). */
71
+ export declare class ChatInProgressError extends AIChatError {
72
+ constructor(code: number | null, message: string);
73
+ }
74
+ /**
75
+ * Summary generation failed. `summarize` returns EXACTLY ONE of `{summary}`
76
+ * (success) or `{error}` (generation failed), and the failure rides the JSON-RPC
77
+ * *success* envelope — not an `error` object — so it never reaches the error-code
78
+ * mapping. Surfaced here so a failed summary can't masquerade as an empty string.
79
+ * `code` is `null` (no JSON-RPC code).
80
+ */
81
+ export declare class SummaryError extends AIChatError {
82
+ constructor(code: number | null, message: string);
83
+ }
84
+ /** Result of {@link AIChatClient.createConversation}. */
85
+ export interface ConversationInfo {
86
+ /** The conversation id (echoed back — the caller's own input). */
87
+ id: string;
88
+ /** Lifecycle status the service reported (e.g. `"created"`). */
89
+ status: string;
90
+ /** The opening assistant message, if the config produced one. */
91
+ initialMessage: string | null;
92
+ }
93
+ /** Result of {@link AIChatClient.chat}. */
94
+ export interface ChatResponse {
95
+ /** The assistant's reply text (the wire `response` field). */
96
+ text: string;
97
+ /** The conversation id this reply belongs to. */
98
+ conversationId: string;
99
+ /** An optional structured event the turn emitted, else `null`. */
100
+ userEvent: Record<string, unknown> | null;
101
+ }
102
+ /** Result of {@link AIChatClient.log}. */
103
+ export interface ChatLog {
104
+ /** Full message history (the wire `chat_log` field). */
105
+ messages: Array<Record<string, unknown>>;
106
+ /** The call timeline (the wire `call_timeline` field). */
107
+ callTimeline: Array<Record<string, unknown>>;
108
+ }
109
+ /** Constructor options for {@link AIChatClient}. */
110
+ export interface AIChatClientOptions {
111
+ /** Project id (Basic-auth username). Falls back to `SIGNALWIRE_PROJECT_ID`. */
112
+ project?: string;
113
+ /** API token (Basic-auth password). Falls back to `SIGNALWIRE_API_TOKEN`. */
114
+ token?: string;
115
+ /** Space name; builds `https://{space}.signalwire.com/api/ai/chat`. Falls back to `SIGNALWIRE_SPACE`. */
116
+ space?: string;
117
+ /** Fully-qualified endpoint URL, used verbatim (highest precedence). */
118
+ url?: string;
119
+ /** Override the `fetch` implementation (dependency injection for tests). */
120
+ fetchImpl?: typeof globalThis.fetch;
121
+ /**
122
+ * Seconds without receiving any data (headers or body) before a request is
123
+ * abandoned. Not a limit on the whole turn: every chunk restarts it. Default
124
+ * 60. `0` disables.
125
+ */
126
+ readIdleTimeoutSeconds?: number;
127
+ }
128
+ /** Per-turn options common to {@link AIChatClient.createConversation} and {@link AIChatClient.chat}. */
129
+ export interface ConversationTurnOptions {
130
+ /** Config URL locating the agent config (required on create; auto-creates on chat). */
131
+ configUrl?: string;
132
+ /** Conversation inactivity timeout in seconds (wire `conversation_timeout`). */
133
+ timeout?: number;
134
+ /** Reinitialize an existing conversation. */
135
+ reinit?: boolean;
136
+ /** Arbitrary caller metadata (wire `user_meta_data`). */
137
+ userMetadata?: Record<string, unknown>;
138
+ }
139
+ /** Options for {@link AIChatClient.createConversation}. */
140
+ export interface CreateConversationOptions extends ConversationTurnOptions {
141
+ /** Config URL locating the agent config (required). */
142
+ configUrl: string;
143
+ /** The opening user message to send with the create (wire `user_message`). */
144
+ userMessage?: string;
145
+ }
146
+ /** Options for {@link AIChatClient.chat}. */
147
+ export interface ChatOptions extends ConversationTurnOptions {
148
+ /** Message role (`"user"` or `"system"`). Default `"user"`. */
149
+ role?: string;
150
+ }
151
+ /** Sampling / prompt options for {@link AIChatClient.summarize}. */
152
+ export interface SummarizeOptions {
153
+ /** Custom prompt steering the summary (wire `summary_prompt`). */
154
+ summaryPrompt?: string;
155
+ /** Sampling temperature. */
156
+ temperature?: number;
157
+ /** Nucleus-sampling top-p. */
158
+ topP?: number;
159
+ /** Frequency penalty. */
160
+ frequencyPenalty?: number;
161
+ /** Presence penalty. */
162
+ presencePenalty?: number;
163
+ /** Max tokens for the summary. */
164
+ maxTokens?: number;
165
+ }
166
+ type JsonRpcParams = Record<string, unknown>;
167
+ /** Async client for the SignalWire AI Chat service. */
168
+ export declare class AIChatClient {
169
+ /** Fully-qualified endpoint URL requests are POSTed to. */
170
+ readonly url: string;
171
+ private readonly _authHeader;
172
+ private readonly _fetch;
173
+ private readonly _readIdleTimeoutSeconds;
174
+ private _requestCounter;
175
+ /**
176
+ * @param options - Connection + credential options. Either `url` or `space`
177
+ * (or `SIGNALWIRE_SPACE`) must resolve a target; `project` is required (arg
178
+ * or `SIGNALWIRE_PROJECT_ID`).
179
+ * @throws {Error} When no project is available, or no URL can be resolved.
180
+ */
181
+ constructor(options?: AIChatClientOptions);
182
+ private static _resolveUrl;
183
+ /**
184
+ * POST one JSON-RPC call and return the response, its body not yet read.
185
+ *
186
+ * The idle timeout covers the wait for headers and every wait for the next
187
+ * body chunk, each measured separately: a turn the service keeps alive with
188
+ * keepalive whitespace runs as long as it needs, and a connection that goes
189
+ * silent is abandoned. Time the caller spends between reads doesn't count.
190
+ * An expired timeout aborts the connection and fails the read with an
191
+ * {@link AIChatError} whose code is `null`.
192
+ */
193
+ private _post;
194
+ /**
195
+ * POST one JSON-RPC call and return its decoded `result` object.
196
+ *
197
+ * Success/failure is decided by the JSON-RPC BODY, not the HTTP status: the
198
+ * service's keepalive heartbeat commits `200` before the turn's outcome is
199
+ * known, so a slow error can arrive as `200 + {"error": …}`. Never gate on
200
+ * `response.status` here (mirrors the python reference).
201
+ *
202
+ * @throws {AIChatError} (or a typed subclass) when the body carries `error`.
203
+ */
204
+ private _request;
205
+ /**
206
+ * POST one JSON-RPC call and return the response with its body unread.
207
+ *
208
+ * For a proxy that has to stream the body through rather than buffer it.
209
+ * The service pads a slow response with keepalive whitespace so that
210
+ * intermediaries don't close the connection mid-turn; a proxy that waits for
211
+ * the whole body holds back that padding and brings back the timeout it's
212
+ * there to prevent. Pass `response.body` on as it arrives.
213
+ *
214
+ * The caller interprets the result, including that a JSON-RPC error arrives
215
+ * under HTTP 200 (see the typed methods). Read the body to the end or cancel
216
+ * it, so the connection is released. The idle timeout applies to each read.
217
+ * Prefer the typed methods unless you are relaying bytes.
218
+ *
219
+ * @param method - JSON-RPC method, e.g. `chat`.
220
+ * @param params - JSON-RPC params, sent as they are.
221
+ * @returns The response, body unread.
222
+ *
223
+ * @example
224
+ * ```ts
225
+ * import { Hono } from 'hono';
226
+ * import { AIChatClient } from '@signalwire/sdk';
227
+ *
228
+ * const client = new AIChatClient({ space: 'myspace' });
229
+ * const app = new Hono();
230
+ *
231
+ * app.post('/chat', async (c) => {
232
+ * const { id, message } = await c.req.json<{ id: string; message: string }>();
233
+ * const upstream = await client.rawPost('chat', { id, message });
234
+ * return new Response(upstream.body, {
235
+ * status: upstream.status,
236
+ * headers: { 'Content-Type': 'application/json' },
237
+ * });
238
+ * });
239
+ * ```
240
+ */
241
+ rawPost(method: string, params: JsonRpcParams): Promise<Response>;
242
+ /**
243
+ * Create a conversation (or, with `reinit`, reinitialize an existing one) and
244
+ * optionally send its opening user message.
245
+ *
246
+ * @param conversationId - The conversation id to create.
247
+ * @param options - Must include `configUrl`; other fields are optional.
248
+ * @returns The created conversation's status + optional opening message.
249
+ */
250
+ createConversation(conversationId: string, options: CreateConversationOptions): Promise<ConversationInfo>;
251
+ /**
252
+ * Send a message and await a full LLM round trip.
253
+ *
254
+ * Passing `configUrl` auto-creates the conversation if it doesn't exist yet;
255
+ * `timeout` and `reinit` apply to that auto-create, with the same meaning as on
256
+ * {@link createConversation}. Expect seconds — the turn awaits the model.
257
+ *
258
+ * @param conversationId - The conversation to send into.
259
+ * @param message - The user (or system) message text.
260
+ * @param options - Optional role / auto-create / metadata fields.
261
+ * @returns The assistant reply text plus any structured user event.
262
+ */
263
+ chat(conversationId: string, message: string, options?: ChatOptions): Promise<ChatResponse>;
264
+ /**
265
+ * End a conversation (triggers server-side post-processing / archival).
266
+ *
267
+ * @param conversationId - The conversation to end.
268
+ * @returns `true` when the service reported the conversation ended.
269
+ */
270
+ end(conversationId: string): Promise<boolean>;
271
+ /**
272
+ * Permanently delete a conversation and its data. Idempotent.
273
+ *
274
+ * @param conversationId - The conversation to delete.
275
+ * @returns `true` when the service reported the conversation deleted.
276
+ */
277
+ delete(conversationId: string): Promise<boolean>;
278
+ /**
279
+ * Return the full message history plus the call timeline.
280
+ *
281
+ * @param conversationId - The conversation to read.
282
+ * @returns The message list and call timeline.
283
+ */
284
+ log(conversationId: string): Promise<ChatLog>;
285
+ /**
286
+ * Return an AI summary of the conversation (rate limited server-side).
287
+ *
288
+ * The service returns EXACTLY ONE of `{summary}` or `{error}` — BOTH on the
289
+ * success envelope — so a failed generation must surface as a thrown
290
+ * {@link SummaryError}, never as an empty string.
291
+ *
292
+ * @param conversationId - The conversation to summarize.
293
+ * @param options - Optional custom prompt + sampling parameters.
294
+ * @returns The summary text.
295
+ * @throws {SummaryError} When the service reports summary generation failed.
296
+ */
297
+ summarize(conversationId: string, options?: SummarizeOptions): Promise<string>;
298
+ /**
299
+ * Release any resources the client holds and complete its lifecycle.
300
+ *
301
+ * The client is stateless per request — it injects/uses `fetch` and holds no
302
+ * pooled socket or session of its own (unlike the python reference's owned
303
+ * `aiohttp.ClientSession`), so there is nothing to tear down; this is a no-op
304
+ * that fulfills the reference's `close()` lifecycle contract. Safe to call more
305
+ * than once. Prefer `await using` (below) where the runtime supports it.
306
+ */
307
+ close(): Promise<void>;
308
+ /**
309
+ * `Symbol.asyncDispose` — the TS/JS explicit-resource-management analogue of the
310
+ * python reference's `async with AIChatClient(...) as client:` context manager.
311
+ * `await using client = new AIChatClient(...)` calls this on scope exit,
312
+ * mirroring `__aenter__`/`__aexit__` → `close()`.
313
+ */
314
+ [Symbol.asyncDispose](): Promise<void>;
315
+ }
316
+ export {};