@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
@@ -5,10 +5,18 @@
5
5
  * pure SWML call-flow documents: IVR menus, voicemail, call recording, etc.
6
6
  * Uses SwmlBuilder for verb methods and Hono for HTTP serving.
7
7
  */
8
+ import type { AgentBase } from './AgentBase.js';
8
9
  import { Hono } from 'hono';
10
+ import type { HostAppRouter } from './web.js';
9
11
  import { SwmlBuilder } from './SwmlBuilder.js';
10
12
  import { SchemaUtils } from './SchemaUtils.js';
11
13
  import { Logger } from './Logger.js';
14
+ import { SwaigFunction, type SwaigFunctionOptions } from './SwaigFunction.js';
15
+ import type { ToolParameters, ToolArgs } from './ParameterSchema.js';
16
+ import { FunctionResult } from './FunctionResult.js';
17
+ import type { SwmlRequestData } from './PlatformContracts.js';
18
+ import type { SwaigRequest } from './SwaigContracts.js';
19
+ import type { Server } from 'node:http';
12
20
  /**
13
21
  * Interface for custom SWML verb handlers.
14
22
  * Mirrors Python SDK's `SWMLVerbHandler` abstract base class.
@@ -51,20 +59,80 @@ export declare class SecurityConfig {
51
59
  basicAuthUser: string | null;
52
60
  /** Basic auth password from config, or null. */
53
61
  basicAuthPassword: string | null;
62
+ /**
63
+ * Where {@link basicAuthPassword} came from: `'environment'`
64
+ * (`SWML_BASIC_AUTH_PASSWORD`), `'config file'` (which takes precedence), or
65
+ * `null` when neither set one.
66
+ */
67
+ basicAuthSource: 'environment' | 'config file' | null;
68
+ /** Allowed request hosts (`['*']` = allow all). */
69
+ allowedHosts: string[];
70
+ /** Allowed CORS origins. */
71
+ corsOrigins: string[];
72
+ /** Whether to emit an HSTS header on HTTPS responses. */
73
+ useHsts: boolean;
74
+ /** HSTS `max-age` in seconds. */
75
+ hstsMaxAge: number;
54
76
  private sslConfig;
55
77
  constructor(opts?: {
56
78
  configFile?: string;
57
79
  serviceName?: string;
58
80
  });
81
+ /** Split a comma-separated env value into a trimmed, non-empty list. */
82
+ private static parseList;
83
+ /**
84
+ * (Re)load host/CORS/HSTS settings from environment variables. Mirrors Python
85
+ * SDK's `SecurityConfig.load_from_env()`. SSL/auth are loaded in the constructor
86
+ * from their own env vars; this refreshes the network-policy fields.
87
+ */
88
+ loadFromEnv(): void;
59
89
  private loadFromConfigFile;
60
- /** Get basic auth credentials from security config, or null if not configured. */
90
+ /**
91
+ * Get basic auth credentials from the config file or environment, or null
92
+ * when no password is configured. The user defaults to `signalwire`.
93
+ */
61
94
  getBasicAuth(): [string, string] | null;
62
95
  /** Validate that SSL cert and key files are present when SSL is enabled. */
63
96
  validateSslConfig(): [boolean, string | null];
97
+ /**
98
+ * Build the SSL parameters for the HTTPS server, as a plain dictionary of
99
+ * primitive filesystem paths. Mirrors Python's
100
+ * `SecurityConfig.get_ssl_context_kwargs()` verbatim: the reference targets
101
+ * uvicorn's `ssl_certfile`/`ssl_keyfile` kwargs, and this returns the exact
102
+ * same primitive path pair (the TS HTTPS server passes them to
103
+ * `node:https.createServer` / `readFileSync`). Returns an empty object when
104
+ * SSL is disabled or the cert/key files fail validation.
105
+ * @returns `{ ssl_certfile, ssl_keyfile }` path strings, or `{}` when unavailable.
106
+ */
107
+ getSslContextKwargs(): Record<string, string>;
108
+ /** Get the URL scheme based on SSL configuration. Mirrors Python's `get_url_scheme()`. */
109
+ getUrlScheme(): string;
110
+ /**
111
+ * Check whether a host is allowed. Mirrors Python's `should_allow_host()`:
112
+ * a wildcard `*` in the allow-list permits any host.
113
+ */
114
+ shouldAllowHost(host: string): boolean;
115
+ /**
116
+ * Get CORS configuration. Mirrors Python's `get_cors_config()`.
117
+ * @returns An object of CORS settings (origins, credentials, methods, headers).
118
+ */
119
+ getCorsConfig(): Record<string, unknown>;
120
+ /**
121
+ * Get the security headers to add to responses. Mirrors Python's
122
+ * `get_security_headers()`; adds an HSTS header when the request is HTTPS and
123
+ * HSTS is enabled.
124
+ * @param isHttps - Whether the connection is over HTTPS.
125
+ */
126
+ getSecurityHeaders(isHttps?: boolean): Record<string, string>;
127
+ /**
128
+ * Log the current security configuration. Mirrors Python's `log_config()`.
129
+ * @param serviceName - The service name to tag the log line with.
130
+ */
131
+ logConfig(serviceName: string): void;
64
132
  }
65
133
  /** Callback invoked per-request to dynamically build SWML. */
66
- export type OnRequestCallback = (queryParams: Record<string, string>, bodyParams: Record<string, unknown>, headers: Record<string, string>) => SwmlBuilder | Promise<SwmlBuilder>;
67
- type RoutingCallback = (requestBody: Record<string, unknown>) => string | null | undefined | Promise<string | null | undefined>;
134
+ export type OnRequestCallback = (queryParams: Record<string, string>, bodyParams: SwmlRequestData, headers: Record<string, string>) => SwmlBuilder | Promise<SwmlBuilder>;
135
+ type RoutingCallback = (requestBody: SwmlRequestData, headers?: Record<string, string>) => string | null | undefined | Promise<string | null | undefined>;
68
136
  /** Configuration options for SWMLService. */
69
137
  export interface SWMLServiceOptions {
70
138
  /**
@@ -88,28 +156,11 @@ export interface SWMLServiceOptions {
88
156
  schemaValidation?: boolean;
89
157
  }
90
158
  /**
91
- * HTTP service that serves non-AI SWML documents built from verb methods.
92
- *
93
- * Use `SWMLService` when you need a SignalWire call flow but don't need AI —
94
- * plain call routing, IVR-style trees, recording workflows, static playback, etc.
95
- * For AI-powered voice agents, use {@link AgentBase} instead.
96
- *
97
- * @example Static greeting that plays a file and hangs up
98
- * ```ts
99
- * import { SWMLService } from '@signalwire/sdk';
100
- *
101
- * const service = new SWMLService({ name: 'greeter', route: '/', port: 3000 });
102
- * service.builder
103
- * .answer()
104
- * .play({ url: 'https://cdn.example.com/welcome.mp3' })
105
- * .hangup();
106
- *
107
- * await service.serve();
108
- * ```
109
- *
110
- * @see {@link SwmlBuilder} — the underlying SWML document builder
111
- * @see {@link AgentBase} — AI-powered alternative
159
+ * The services constructed since the last call, while swaig-test was
160
+ * importing a file, in construction order; clears the list. Internal to the
161
+ * CLI's loader.
112
162
  */
163
+ export declare function _takeCliLoadedServices(): SWMLService[];
113
164
  export declare class SWMLService {
114
165
  /** Service display name. */
115
166
  readonly name: string;
@@ -133,20 +184,115 @@ export declare class SWMLService {
133
184
  readonly sslKeyPath: string | undefined;
134
185
  /** Schema validation utilities. Mirrors Python's `self.schema_utils`. */
135
186
  readonly schemaUtils: SchemaUtils;
187
+ /** @internal The schema settings every SwmlBuilder this service creates uses. */
188
+ protected _builderSchemaOptions: {
189
+ enableValidation: boolean;
190
+ schemaPath?: string;
191
+ };
136
192
  /** Custom verb handler registry. Mirrors Python's `self.verb_registry`. */
137
193
  readonly verbRegistry: VerbHandlerRegistry;
138
- private swmlBuilder;
139
- private _app;
140
- private _server;
141
- private onRequestCallback?;
142
- private authCredentials?;
143
- private authSource;
144
- private _proxyUrlBase;
145
- private _proxyUrlBaseFromEnv;
146
- private _routingCallbacks;
194
+ protected swmlBuilder: SwmlBuilder;
195
+ protected _app: Hono;
196
+ protected _server: Server | null;
197
+ protected onRequestCallback?: OnRequestCallback;
198
+ protected authCredentials?: [string, string];
199
+ protected authSource: 'provided' | 'environment' | 'config file' | 'generated';
200
+ /** Validate provided basic-auth credentials against the configured ones
201
+ * using a constant-time comparison. (Python equivalent:
202
+ * ``AuthMixin.validate_basic_auth(username, password)``.) */
203
+ validateBasicAuth(username: string, password: string): boolean | Promise<boolean>;
204
+ private timingSafeEqual;
205
+ protected _proxyUrlBase: string | null;
206
+ protected _proxyUrlBaseFromEnv: boolean;
207
+ protected _routingCallbacks: Map<string, RoutingCallback>;
208
+ protected toolRegistry: Map<string, SwaigFunction | Record<string, unknown>>;
147
209
  constructor(opts: SWMLServiceOptions);
148
210
  /** @deprecated Prefer passing an options object with a required `name`. The no-arg form defaults name to 'swml-service'. */
149
211
  constructor(opts?: Partial<SWMLServiceOptions>);
212
+ /**
213
+ * Define a SWAIG function the AI can call. Tool descriptions and
214
+ * parameter descriptions are LLM-facing prompt engineering — see
215
+ * PORTING_GUIDE for guidance on writing them.
216
+ *
217
+ * Generic over the `parameters` schema (`P`) and `required` list (`R`): when
218
+ * `parameters` is written as a FLAT inline map (`{ name: { type, … } }`), the
219
+ * `const` type parameters capture its literals and the handler's `args` is
220
+ * inferred precisely — `args.phone` typed `string`, an `enum` prop narrowed to
221
+ * its literal union, `required` keys present and the rest optional (see
222
+ * {@link ToolArgs}/{@link InferArgs}). The WRAPPED JSON-Schema object
223
+ * (`{ type:'object', properties }`) and a pre-built `Record` are still
224
+ * accepted and keep the prior open-record `args` behavior. The args type is a
225
+ * compile-time authoring convenience — at runtime args is the JSON the model
226
+ * extracted, so the handler is the ordinary {@link SwaigHandler}.
227
+ */
228
+ defineTool<const P extends ToolParameters = ToolParameters, const R extends readonly PropertyKey[] = []>(opts: Omit<SwaigFunctionOptions, 'parameters' | 'required' | 'handler'> & {
229
+ parameters?: P;
230
+ required?: R;
231
+ handler: (args: ToolArgs<P, R>, rawData: SwaigRequest, agent?: AgentBase) => FunctionResult | Record<string, unknown> | string | Promise<FunctionResult | Record<string, unknown> | string>;
232
+ }): this;
233
+ /** Register a SwaigFunction instance or a raw function descriptor (DataMap). */
234
+ registerSwaigFunction(fn: SwaigFunction | Record<string, unknown>): this;
235
+ /**
236
+ * Dispatch a function call to the registered handler.
237
+ * Returns null when the function isn't registered or has no handler.
238
+ * Subclasses (AgentBase) override to add session-token validation
239
+ * and FunctionResult-shape normalization. Return type is wide enough
240
+ * to accommodate the agent override (which may also return void
241
+ * shapes for fire-and-forget tool calls).
242
+ */
243
+ onFunctionCall(name: string, args: Record<string, unknown>, rawData: SwaigRequest): FunctionResult | Record<string, unknown> | string | Promise<FunctionResult | Record<string, unknown> | string | void> | void | null | undefined;
244
+ /** Whether a tool with the given name is registered. */
245
+ hasTool(name: string): boolean;
246
+ /** Whether a SWAIG function with the given name is registered.
247
+ * (Python equivalent: ``ToolRegistry.has_function``.) */
248
+ hasFunction(name: string): boolean;
249
+ /** Get a registered SWAIG function entry, or undefined.
250
+ * (Python equivalent: ``ToolRegistry.get_function``.) */
251
+ getFunction(name: string): SwaigFunction | Record<string, unknown> | undefined;
252
+ /** Snapshot of all registered SWAIG functions keyed by name.
253
+ * (Python equivalent: ``ToolRegistry.get_all_functions``.) */
254
+ getAllFunctions(): Record<string, SwaigFunction | Record<string, unknown>>;
255
+ /** Remove a registered SWAIG function. Returns true when removed,
256
+ * false when not found. (Python equivalent:
257
+ * ``ToolRegistry.remove_function``.) */
258
+ removeFunction(name: string): boolean;
259
+ /** List registered tool names in insertion order (Map preserves it). */
260
+ listToolNames(): string[];
261
+ /**
262
+ * Get a summary of all registered tools with their names, descriptions, and
263
+ * parameter schemas. Lifted from AgentBase so the swaig-test CLI can list
264
+ * tools on a non-AgentBase SWMLService target (sidecar / standalone SWAIG
265
+ * host).
266
+ *
267
+ * @returns Array of tool descriptors.
268
+ */
269
+ getRegisteredTools(): {
270
+ name: string;
271
+ description: string;
272
+ parameters: Record<string, unknown>;
273
+ }[];
274
+ /**
275
+ * Look up a registered SwaigFunction by name. Lifted from AgentBase so
276
+ * `swaig-test --exec <name>` works against a non-AgentBase SWMLService
277
+ * target.
278
+ *
279
+ * @param name - The tool name to search for.
280
+ * @returns The SwaigFunction instance, or undefined if not found or not a SwaigFunction.
281
+ */
282
+ getTool(name: string): SwaigFunction | undefined;
283
+ /**
284
+ * Extension point: invoked between argument parsing and function dispatch
285
+ * on POST /swaig. Returns [target, shortCircuit]: when shortCircuit is
286
+ * non-null, it's returned directly without dispatching. AgentBase may
287
+ * override to add session-token validation or ephemeral dynamic-config.
288
+ */
289
+ protected swaigPreDispatch(_requestData: SwaigRequest, _funcName: string): [SWMLService, unknown];
290
+ /**
291
+ * Extension point: register additional Hono routes after SWMLService
292
+ * mounts /health, /ready, /swaig, and the main route. AgentBase uses
293
+ * this to add /post_prompt, /check_for_input, /debug_events, /mcp.
294
+ */
295
+ protected registerAdditionalRoutes(_app: Hono): void;
150
296
  /**
151
297
  * Check if full JSON Schema validation is enabled.
152
298
  * Mirrors Python's `@property full_validation_enabled`.
@@ -188,13 +334,18 @@ export declare class SWMLService {
188
334
  */
189
335
  resetDocument(): this;
190
336
  /**
191
- * Render the SWML document as a JSON object.
192
- * @returns The SWML document.
337
+ * Render the SWML document.
338
+ *
339
+ * Subclass-override-friendly signature: AgentBase overrides this with
340
+ * `(callId?: string, modifications?: Record<string, unknown>): string`
341
+ * to return a serialized JSON string built from prompts + dynamic config.
342
+ * Plain SWMLService returns the in-memory document object.
343
+ *
344
+ * @returns The SWML document (object) or its serialized form (subclass).
193
345
  */
194
- renderSwml(): Record<string, unknown>;
346
+ renderSwml(_callId?: string, _modifications?: Record<string, unknown>): Record<string, unknown> | string;
195
347
  /**
196
- * Get the SWML document as a dictionary.
197
- * Alias for `renderSwml()` that matches Python's `get_document()` name.
348
+ * Get the SWML document as a dictionary. Matches Python's `get_document()`.
198
349
  * @returns The SWML document.
199
350
  */
200
351
  getDocument(): Record<string, unknown>;
@@ -204,6 +355,39 @@ export declare class SWMLService {
204
355
  * @returns JSON-encoded SWML document.
205
356
  */
206
357
  renderDocument(): string;
358
+ /**
359
+ * Framework-free request-dispatch core.
360
+ *
361
+ * The primitive dispatch surface the SDK ports share (mirrors Python's
362
+ * `SWMLService.handle_request(method, url, headers, body)` and, e.g., the
363
+ * dotnet `(int, Dictionary, string) HandleRequest(...)`). It performs the
364
+ * routing-callback check, `on_request` modification, and basic-auth exactly as
365
+ * the Hono handler path does, but over plain primitives instead of Hono
366
+ * `Context`/`Response` objects — so both paths produce identical responses.
367
+ *
368
+ * @param method HTTP method, e.g. `"GET"` or `"POST"`.
369
+ * @param url The full request URL (used to derive the callback path).
370
+ * @param headers Request headers as a plain dict.
371
+ * @param body The already-parsed JSON body for POST requests, or `undefined`.
372
+ * @returns A `[status, responseHeaders, bodyString]` triple. For a routing
373
+ * redirect the status is 307 with a `Location` header and an empty body; an
374
+ * auth failure is 401 with `WWW-Authenticate: Basic`; otherwise 200 with the
375
+ * SWML document as the body string.
376
+ */
377
+ handleRequest(method: string, url: string, headers: Record<string, string>, body?: Record<string, unknown> | null): Promise<[number, Record<string, string>, string]>;
378
+ /**
379
+ * Derive the registered routing-callback path (if any) a URL targets. Mirrors
380
+ * Python's `_callback_path_for_url` — the primitive `handleRequest` recovers
381
+ * the equivalent of the router's `request.state.callback_path` by matching the
382
+ * URL's normalized path against the registered callbacks.
383
+ */
384
+ protected _callbackPathForUrl(url: string): string | null;
385
+ /**
386
+ * Validate HTTP basic-auth from a plain headers dict (the primitive analog of
387
+ * the Hono `basicAuth` middleware). Returns true when auth is not enforced or
388
+ * the provided credentials match.
389
+ */
390
+ protected _checkBasicAuthHeaders(headers: Record<string, string>): Promise<boolean>;
207
391
  /**
208
392
  * Register a custom verb handler.
209
393
  * Mirrors Python's `register_verb_handler()`.
@@ -221,22 +405,34 @@ export declare class SWMLService {
221
405
  * @param path - HTTP path for the callback (default '/sip').
222
406
  */
223
407
  registerRoutingCallback(callbackFn: RoutingCallback, path?: string): void;
408
+ /** The body (for a POST) and headers of a served request. */
409
+ private _readRequest;
410
+ /**
411
+ * The SWML document for a served request: buildSwmlForRequest(), then the
412
+ * setOnRequestCallback() callback, then the service's own document (as
413
+ * Python's _handle_request does).
414
+ */
415
+ private _documentForRequest;
224
416
  /**
225
417
  * Extract the SIP username from a request body's call.to field.
226
418
  * Mirrors Python's `@staticmethod extract_sip_username()`.
227
419
  * @param requestBody - The parsed request body containing call information.
228
420
  * @returns The extracted SIP username, or null if not found.
229
421
  */
230
- static extractSipUsername(requestBody: Record<string, unknown>): string | null;
422
+ static extractSipUsername(requestBody: SwmlRequestData): string | null;
231
423
  /**
232
- * Protected override hook called on every inbound SWML request.
233
- * Mirrors Python SDK's `on_request(request_data, callback_path)` subclass
234
- * override pattern. Subclasses return a `SwmlBuilder` to use for this
235
- * request, or `null` to fall through to `setOnRequestCallback` or the
236
- * static builder.
424
+ * Service-side SWML-builder hook. Subclasses return a `SwmlBuilder`
425
+ * to fully replace the document for this request, or `null` to fall
426
+ * through to `setOnRequestCallback` or the static builder.
427
+ *
428
+ * This is distinct from the WebMixin `onRequest(requestData,
429
+ * callbackPath)` hook on AgentBase (which mirrors Python's
430
+ * `on_request -> on_swml_request` modification-merge contract).
431
+ * Use this hook when you want to swap the entire SWML builder; use
432
+ * `onRequest` / `onSwmlRequest` on AgentBase when you want to merge
433
+ * targeted modifications into the rendered document.
237
434
  *
238
- * Default implementation returns `null` (no-op), preserving existing
239
- * behaviour for classes that do not override.
435
+ * Default implementation returns `null` (no-op).
240
436
  *
241
437
  * @param queryParams - URL query parameters from the request.
242
438
  * @param bodyParams - Parsed POST body (empty object for GET requests).
@@ -245,7 +441,7 @@ export declare class SWMLService {
245
441
  * @returns A `SwmlBuilder` whose document is sent as the response, or
246
442
  * `null` to delegate to the next handler in the chain.
247
443
  */
248
- protected onRequest(_queryParams: Record<string, string>, _bodyParams: Record<string, unknown>, _headers: Record<string, string>, _callbackPath?: string): SwmlBuilder | null;
444
+ protected buildSwmlForRequest(_queryParams: Record<string, string>, _bodyParams: Record<string, unknown>, _headers: Record<string, string>, _callbackPath?: string): SwmlBuilder | null;
249
445
  /**
250
446
  * Set a callback invoked per-request to dynamically build SWML.
251
447
  * When set, the static SwmlBuilder is ignored and the callback's
@@ -261,7 +457,7 @@ export declare class SWMLService {
261
457
  * @returns A tuple of [username, password] or [username, password, source].
262
458
  */
263
459
  getBasicAuthCredentials(includeSource?: false): [string, string];
264
- getBasicAuthCredentials(includeSource: true): [string, string, 'provided' | 'environment' | 'auto-generated'];
460
+ getBasicAuthCredentials(includeSource: true): [string, string, 'provided' | 'environment' | 'config file' | 'generated'];
265
461
  /**
266
462
  * Manually set the proxy base URL used for webhook URL generation.
267
463
  * Mirrors Python's `manual_set_proxy_url()`.
@@ -279,21 +475,26 @@ export declare class SWMLService {
279
475
  */
280
476
  getApp(): Hono;
281
477
  /**
282
- * Alias for `getApp()`. Provided for cross-SDK consistency with Python's
283
- * `as_router()` method — allows Python callers porting to TypeScript to use
284
- * the familiar name without changes.
285
- * @returns The configured Hono app.
478
+ * Get a router to embed this service's routes in a host web app.
479
+ *
480
+ * Returns the fully-wired Hono app as a mountable sub-app; the host mounts it
481
+ * with `hostApp.route(path, service.asRouter())`. This is the TypeScript
482
+ * realization of Python's `as_router()`; the named {@link HostAppRouter} type
483
+ * is the cross-port "embed my routes in a host app" contract.
484
+ *
485
+ * @returns A mountable Hono sub-app carrying this service's routes.
286
486
  */
287
- asRouter(): Hono;
487
+ asRouter(): HostAppRouter;
288
488
  /**
289
- * Start the HTTP server.
489
+ * Start the HTTP server. Canonical entrypoint, matching Python's
490
+ * `SWMLService.serve()`.
290
491
  *
291
492
  * Matches Python's `serve()` parameters including SSL options. When
292
493
  * `SWAIG_CLI_MODE=true` is set in the environment (e.g. while running the
293
494
  * `swaig-test` CLI) the call is a no-op.
294
495
  *
295
- * @param host - Hostname. Defaults to `this.host` (constructor value) or
296
- * `'0.0.0.0'`.
496
+ * @param hostOrOpts - Hostname, or an options object. Defaults to `this.host`
497
+ * (constructor value) or `'0.0.0.0'`.
297
498
  * @param port - Port. Defaults to `this.port` (constructor value) or `3000`.
298
499
  * @param opts - Optional SSL/TLS configuration overrides.
299
500
  * @param opts.sslCert - Path to the PEM certificate file.
@@ -302,21 +503,19 @@ export declare class SWMLService {
302
503
  * @param opts.domain - Domain used for HSTS header configuration.
303
504
  * @returns Resolves once the server has begun listening.
304
505
  */
305
- run(host?: string, port?: number, opts?: {
506
+ serve(hostOrOpts?: string | {
507
+ host?: string;
508
+ port?: number;
509
+ sslCert?: string;
510
+ sslKey?: string;
511
+ sslEnabled?: boolean;
512
+ domain?: string;
513
+ }, port?: number, opts?: {
306
514
  sslCert?: string;
307
515
  sslKey?: string;
308
516
  sslEnabled?: boolean;
309
517
  domain?: string;
310
518
  }): Promise<void>;
311
- /**
312
- * Start the HTTP server. Alias for {@link run} provided for cross-SDK
313
- * consistency with Python's `serve()` method — callers porting from
314
- * Python can use this name without changes.
315
- *
316
- * @param args - Forwarded unchanged to {@link run}.
317
- * @returns Resolves once the server has begun listening.
318
- */
319
- serve(...args: Parameters<SWMLService['run']>): Promise<void>;
320
519
  /**
321
520
  * Stop the HTTP server.
322
521
  * Mirrors Python's `stop()`.