@signalwire/sdk 2.0.1 → 2.0.3

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 (610) hide show
  1. package/dist/AgentBase.d.ts +1045 -0
  2. package/dist/AgentBase.js +2375 -0
  3. package/dist/AgentBase.js.map +1 -0
  4. package/dist/AgentServer.d.ts +146 -0
  5. package/dist/AgentServer.js +388 -0
  6. package/dist/AgentServer.js.map +1 -0
  7. package/dist/AuthHandler.d.ts +127 -0
  8. package/dist/AuthHandler.js +212 -0
  9. package/dist/AuthHandler.js.map +1 -0
  10. package/dist/ConfigLoader.d.ts +170 -0
  11. package/dist/ConfigLoader.js +393 -0
  12. package/dist/ConfigLoader.js.map +1 -0
  13. package/dist/ContextBuilder.d.ts +652 -0
  14. package/dist/ContextBuilder.js +1115 -0
  15. package/dist/ContextBuilder.js.map +1 -0
  16. package/dist/DataMap.d.ts +271 -0
  17. package/dist/DataMap.js +430 -0
  18. package/dist/DataMap.js.map +1 -0
  19. package/dist/FunctionResult.d.ts +481 -0
  20. package/dist/FunctionResult.js +775 -0
  21. package/dist/FunctionResult.js.map +1 -0
  22. package/dist/Logger.d.ts +113 -0
  23. package/dist/Logger.js +320 -0
  24. package/dist/Logger.js.map +1 -0
  25. package/dist/PomBuilder.d.ts +208 -0
  26. package/dist/PomBuilder.js +409 -0
  27. package/dist/PomBuilder.js.map +1 -0
  28. package/dist/PromptManager.d.ts +85 -0
  29. package/dist/PromptManager.js +108 -0
  30. package/dist/PromptManager.js.map +1 -0
  31. package/dist/SWMLHandler.d.ts +159 -0
  32. package/dist/SWMLHandler.js +229 -0
  33. package/dist/SWMLHandler.js.map +1 -0
  34. package/dist/SWMLService.d.ts +326 -0
  35. package/dist/SWMLService.js +610 -0
  36. package/dist/SWMLService.js.map +1 -0
  37. package/dist/SchemaUtils.d.ts +108 -0
  38. package/dist/SchemaUtils.js +317 -0
  39. package/dist/SchemaUtils.js.map +1 -0
  40. package/dist/SecurityUtils.d.ts +60 -0
  41. package/{src/SecurityUtils.ts → dist/SecurityUtils.js} +82 -83
  42. package/dist/SecurityUtils.js.map +1 -0
  43. package/dist/ServerlessAdapter.d.ts +119 -0
  44. package/dist/ServerlessAdapter.js +188 -0
  45. package/dist/ServerlessAdapter.js.map +1 -0
  46. package/dist/SessionManager.d.ts +142 -0
  47. package/dist/SessionManager.js +260 -0
  48. package/dist/SessionManager.js.map +1 -0
  49. package/dist/SslConfig.d.ts +77 -0
  50. package/dist/SslConfig.js +100 -0
  51. package/dist/SslConfig.js.map +1 -0
  52. package/dist/SwaigFunction.d.ts +159 -0
  53. package/dist/SwaigFunction.js +209 -0
  54. package/dist/SwaigFunction.js.map +1 -0
  55. package/dist/SwmlBuilder.d.ts +165 -0
  56. package/dist/SwmlBuilder.js +247 -0
  57. package/dist/SwmlBuilder.js.map +1 -0
  58. package/dist/SwmlVerbMethods.generated.d.ts +254 -0
  59. package/dist/SwmlVerbMethods.generated.js +9 -0
  60. package/dist/SwmlVerbMethods.generated.js.map +1 -0
  61. package/dist/TypeInference.d.ts +71 -0
  62. package/dist/TypeInference.js +164 -0
  63. package/dist/TypeInference.js.map +1 -0
  64. package/dist/WebService.d.ts +148 -0
  65. package/dist/WebService.js +532 -0
  66. package/dist/WebService.js.map +1 -0
  67. package/dist/cli/agent-loader.d.ts +22 -0
  68. package/dist/cli/agent-loader.js +144 -0
  69. package/dist/cli/agent-loader.js.map +1 -0
  70. package/dist/cli/mock-data.d.ts +37 -0
  71. package/dist/cli/mock-data.js +80 -0
  72. package/dist/cli/mock-data.js.map +1 -0
  73. package/dist/cli/swaig-test.d.ts +32 -0
  74. package/dist/cli/swaig-test.js +418 -0
  75. package/dist/cli/swaig-test.js.map +1 -0
  76. package/dist/generateVerbTypes.d.ts +11 -0
  77. package/dist/generateVerbTypes.js +265 -0
  78. package/dist/generateVerbTypes.js.map +1 -0
  79. package/{src/index.ts → dist/index.d.ts} +13 -100
  80. package/dist/index.js +152 -0
  81. package/dist/index.js.map +1 -0
  82. package/dist/livewire/index.d.ts +653 -0
  83. package/dist/livewire/index.js +992 -0
  84. package/dist/livewire/index.js.map +1 -0
  85. package/dist/prefabs/ConciergeAgent.d.ts +89 -0
  86. package/dist/prefabs/ConciergeAgent.js +245 -0
  87. package/dist/prefabs/ConciergeAgent.js.map +1 -0
  88. package/dist/prefabs/FAQBotAgent.d.ts +113 -0
  89. package/dist/prefabs/FAQBotAgent.js +329 -0
  90. package/dist/prefabs/FAQBotAgent.js.map +1 -0
  91. package/dist/prefabs/InfoGathererAgent.d.ts +126 -0
  92. package/dist/prefabs/InfoGathererAgent.js +287 -0
  93. package/dist/prefabs/InfoGathererAgent.js.map +1 -0
  94. package/dist/prefabs/ReceptionistAgent.d.ts +104 -0
  95. package/dist/prefabs/ReceptionistAgent.js +303 -0
  96. package/dist/prefabs/ReceptionistAgent.js.map +1 -0
  97. package/dist/prefabs/SurveyAgent.d.ts +148 -0
  98. package/dist/prefabs/SurveyAgent.js +540 -0
  99. package/dist/prefabs/SurveyAgent.js.map +1 -0
  100. package/{src/prefabs/index.ts → dist/prefabs/index.d.ts} +1 -15
  101. package/dist/prefabs/index.js +14 -0
  102. package/dist/prefabs/index.js.map +1 -0
  103. package/dist/relay/Action.d.ts +258 -0
  104. package/dist/relay/Action.js +402 -0
  105. package/dist/relay/Action.js.map +1 -0
  106. package/dist/relay/Call.d.ts +697 -0
  107. package/dist/relay/Call.js +1062 -0
  108. package/dist/relay/Call.js.map +1 -0
  109. package/dist/relay/Deferred.d.ts +44 -0
  110. package/dist/relay/Deferred.js +69 -0
  111. package/dist/relay/Deferred.js.map +1 -0
  112. package/dist/relay/Message.d.ts +103 -0
  113. package/dist/relay/Message.js +169 -0
  114. package/dist/relay/Message.js.map +1 -0
  115. package/dist/relay/RelayClient.d.ts +302 -0
  116. package/dist/relay/RelayClient.js +1026 -0
  117. package/dist/relay/RelayClient.js.map +1 -0
  118. package/dist/relay/RelayError.d.ts +15 -0
  119. package/dist/relay/RelayError.js +20 -0
  120. package/dist/relay/RelayError.js.map +1 -0
  121. package/dist/relay/RelayEvent.d.ts +254 -0
  122. package/dist/relay/RelayEvent.js +509 -0
  123. package/dist/relay/RelayEvent.js.map +1 -0
  124. package/dist/relay/constants.d.ts +90 -0
  125. package/{src/relay/constants.ts → dist/relay/constants.js} +11 -29
  126. package/dist/relay/constants.js.map +1 -0
  127. package/dist/relay/index.d.ts +16 -0
  128. package/dist/relay/index.js +18 -0
  129. package/dist/relay/index.js.map +1 -0
  130. package/dist/relay/types.d.ts +142 -0
  131. package/dist/relay/types.js +5 -0
  132. package/dist/relay/types.js.map +1 -0
  133. package/dist/rest/HttpClient.d.ts +80 -0
  134. package/dist/rest/HttpClient.js +148 -0
  135. package/dist/rest/HttpClient.js.map +1 -0
  136. package/dist/rest/RestError.d.ts +30 -0
  137. package/dist/rest/RestError.js +39 -0
  138. package/dist/rest/RestError.js.map +1 -0
  139. package/dist/rest/base/BaseResource.d.ts +24 -0
  140. package/dist/rest/base/BaseResource.js +29 -0
  141. package/dist/rest/base/BaseResource.js.map +1 -0
  142. package/dist/rest/base/CrudResource.d.ts +68 -0
  143. package/dist/rest/base/CrudResource.js +82 -0
  144. package/dist/rest/base/CrudResource.js.map +1 -0
  145. package/dist/rest/base/CrudWithAddresses.d.ts +22 -0
  146. package/dist/rest/base/CrudWithAddresses.js +25 -0
  147. package/dist/rest/base/CrudWithAddresses.js.map +1 -0
  148. package/dist/rest/index.d.ts +131 -0
  149. package/{src/rest/index.ts → dist/rest/index.js} +101 -136
  150. package/dist/rest/index.js.map +1 -0
  151. package/dist/rest/namespaces/addresses.d.ts +46 -0
  152. package/dist/rest/namespaces/addresses.js +55 -0
  153. package/dist/rest/namespaces/addresses.js.map +1 -0
  154. package/dist/rest/namespaces/calling.d.ts +382 -0
  155. package/dist/rest/namespaces/calling.js +478 -0
  156. package/dist/rest/namespaces/calling.js.map +1 -0
  157. package/dist/rest/namespaces/chat.d.ts +22 -0
  158. package/dist/rest/namespaces/chat.js +26 -0
  159. package/dist/rest/namespaces/chat.js.map +1 -0
  160. package/dist/rest/namespaces/compat.d.ts +585 -0
  161. package/dist/rest/namespaces/compat.js +735 -0
  162. package/dist/rest/namespaces/compat.js.map +1 -0
  163. package/dist/rest/namespaces/datasphere.d.ts +66 -0
  164. package/dist/rest/namespaces/datasphere.js +77 -0
  165. package/dist/rest/namespaces/datasphere.js.map +1 -0
  166. package/dist/rest/namespaces/fabric.d.ts +282 -0
  167. package/dist/rest/namespaces/fabric.js +373 -0
  168. package/dist/rest/namespaces/fabric.js.map +1 -0
  169. package/dist/rest/namespaces/imported-numbers.d.ts +22 -0
  170. package/dist/rest/namespaces/imported-numbers.js +26 -0
  171. package/dist/rest/namespaces/imported-numbers.js.map +1 -0
  172. package/dist/rest/namespaces/logs.d.ts +105 -0
  173. package/dist/rest/namespaces/logs.js +133 -0
  174. package/dist/rest/namespaces/logs.js.map +1 -0
  175. package/dist/rest/namespaces/lookup.d.ts +29 -0
  176. package/dist/rest/namespaces/lookup.js +32 -0
  177. package/dist/rest/namespaces/lookup.js.map +1 -0
  178. package/dist/rest/namespaces/mfa.d.ts +46 -0
  179. package/dist/rest/namespaces/mfa.js +54 -0
  180. package/dist/rest/namespaces/mfa.js.map +1 -0
  181. package/dist/rest/namespaces/number-groups.d.ts +49 -0
  182. package/dist/rest/namespaces/number-groups.js +58 -0
  183. package/dist/rest/namespaces/number-groups.js.map +1 -0
  184. package/dist/rest/namespaces/phone-numbers.d.ts +60 -0
  185. package/dist/rest/namespaces/phone-numbers.js +67 -0
  186. package/dist/rest/namespaces/phone-numbers.js.map +1 -0
  187. package/dist/rest/namespaces/project.d.ts +46 -0
  188. package/dist/rest/namespaces/project.js +56 -0
  189. package/dist/rest/namespaces/project.js.map +1 -0
  190. package/dist/rest/namespaces/pubsub.d.ts +22 -0
  191. package/dist/rest/namespaces/pubsub.js +26 -0
  192. package/dist/rest/namespaces/pubsub.js.map +1 -0
  193. package/dist/rest/namespaces/queues.d.ts +42 -0
  194. package/dist/rest/namespaces/queues.js +49 -0
  195. package/dist/rest/namespaces/queues.js.map +1 -0
  196. package/dist/rest/namespaces/recordings.d.ts +38 -0
  197. package/dist/rest/namespaces/recordings.js +45 -0
  198. package/dist/rest/namespaces/recordings.js.map +1 -0
  199. package/dist/rest/namespaces/registry.d.ts +141 -0
  200. package/dist/rest/namespaces/registry.js +178 -0
  201. package/dist/rest/namespaces/registry.js.map +1 -0
  202. package/dist/rest/namespaces/short-codes.d.ts +39 -0
  203. package/dist/rest/namespaces/short-codes.js +46 -0
  204. package/dist/rest/namespaces/short-codes.js.map +1 -0
  205. package/dist/rest/namespaces/sip-profile.d.ts +28 -0
  206. package/dist/rest/namespaces/sip-profile.js +34 -0
  207. package/dist/rest/namespaces/sip-profile.js.map +1 -0
  208. package/dist/rest/namespaces/verified-callers.d.ts +33 -0
  209. package/dist/rest/namespaces/verified-callers.js +39 -0
  210. package/dist/rest/namespaces/verified-callers.js.map +1 -0
  211. package/dist/rest/namespaces/video.d.ts +235 -0
  212. package/dist/rest/namespaces/video.js +297 -0
  213. package/dist/rest/namespaces/video.js.map +1 -0
  214. package/{src/rest/pagination.ts → dist/rest/pagination.d.ts} +2 -61
  215. package/dist/rest/pagination.js +78 -0
  216. package/dist/rest/pagination.js.map +1 -0
  217. package/dist/rest/types.d.ts +54 -0
  218. package/dist/rest/types.js +5 -0
  219. package/dist/rest/types.js.map +1 -0
  220. package/dist/skills/SkillBase.d.ts +404 -0
  221. package/dist/skills/SkillBase.js +471 -0
  222. package/dist/skills/SkillBase.js.map +1 -0
  223. package/dist/skills/SkillManager.d.ts +195 -0
  224. package/dist/skills/SkillManager.js +378 -0
  225. package/dist/skills/SkillManager.js.map +1 -0
  226. package/dist/skills/SkillRegistry.d.ts +176 -0
  227. package/dist/skills/SkillRegistry.js +310 -0
  228. package/dist/skills/SkillRegistry.js.map +1 -0
  229. package/dist/skills/builtin/api_ninjas_trivia.d.ts +47 -0
  230. package/dist/skills/builtin/api_ninjas_trivia.js +211 -0
  231. package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -0
  232. package/dist/skills/builtin/ask_claude.d.ts +37 -0
  233. package/dist/skills/builtin/ask_claude.js +162 -0
  234. package/dist/skills/builtin/ask_claude.js.map +1 -0
  235. package/dist/skills/builtin/claude_skills.d.ts +75 -0
  236. package/dist/skills/builtin/claude_skills.js +753 -0
  237. package/dist/skills/builtin/claude_skills.js.map +1 -0
  238. package/dist/skills/builtin/custom_skills.d.ts +79 -0
  239. package/dist/skills/builtin/custom_skills.js +227 -0
  240. package/dist/skills/builtin/custom_skills.js.map +1 -0
  241. package/dist/skills/builtin/datasphere.d.ts +73 -0
  242. package/dist/skills/builtin/datasphere.js +350 -0
  243. package/dist/skills/builtin/datasphere.js.map +1 -0
  244. package/dist/skills/builtin/datasphere_serverless.d.ts +89 -0
  245. package/dist/skills/builtin/datasphere_serverless.js +291 -0
  246. package/dist/skills/builtin/datasphere_serverless.js.map +1 -0
  247. package/dist/skills/builtin/datetime.d.ts +40 -0
  248. package/dist/skills/builtin/datetime.js +118 -0
  249. package/dist/skills/builtin/datetime.js.map +1 -0
  250. package/dist/skills/builtin/google_maps.d.ts +48 -0
  251. package/dist/skills/builtin/google_maps.js +470 -0
  252. package/dist/skills/builtin/google_maps.js.map +1 -0
  253. package/dist/skills/builtin/index.d.ts +31 -0
  254. package/{src/skills/builtin/index.ts → dist/skills/builtin/index.js} +30 -36
  255. package/dist/skills/builtin/index.js.map +1 -0
  256. package/dist/skills/builtin/info_gatherer.d.ts +115 -0
  257. package/dist/skills/builtin/info_gatherer.js +328 -0
  258. package/dist/skills/builtin/info_gatherer.js.map +1 -0
  259. package/dist/skills/builtin/joke.d.ts +41 -0
  260. package/dist/skills/builtin/joke.js +156 -0
  261. package/dist/skills/builtin/joke.js.map +1 -0
  262. package/dist/skills/builtin/math.d.ts +39 -0
  263. package/dist/skills/builtin/math.js +119 -0
  264. package/dist/skills/builtin/math.js.map +1 -0
  265. package/dist/skills/builtin/mcp_gateway.d.ts +82 -0
  266. package/dist/skills/builtin/mcp_gateway.js +574 -0
  267. package/dist/skills/builtin/mcp_gateway.js.map +1 -0
  268. package/dist/skills/builtin/native_vector_search.d.ts +128 -0
  269. package/dist/skills/builtin/native_vector_search.js +752 -0
  270. package/dist/skills/builtin/native_vector_search.js.map +1 -0
  271. package/dist/skills/builtin/play_background_file.d.ts +59 -0
  272. package/dist/skills/builtin/play_background_file.js +274 -0
  273. package/dist/skills/builtin/play_background_file.js.map +1 -0
  274. package/dist/skills/builtin/spider.d.ts +91 -0
  275. package/dist/skills/builtin/spider.js +758 -0
  276. package/dist/skills/builtin/spider.js.map +1 -0
  277. package/dist/skills/builtin/swml_transfer.d.ts +66 -0
  278. package/dist/skills/builtin/swml_transfer.js +475 -0
  279. package/dist/skills/builtin/swml_transfer.js.map +1 -0
  280. package/dist/skills/builtin/weather_api.d.ts +59 -0
  281. package/dist/skills/builtin/weather_api.js +196 -0
  282. package/dist/skills/builtin/weather_api.js.map +1 -0
  283. package/dist/skills/builtin/web_search.d.ts +160 -0
  284. package/dist/skills/builtin/web_search.js +894 -0
  285. package/dist/skills/builtin/web_search.js.map +1 -0
  286. package/dist/skills/builtin/wikipedia_search.d.ts +77 -0
  287. package/dist/skills/builtin/wikipedia_search.js +241 -0
  288. package/dist/skills/builtin/wikipedia_search.js.map +1 -0
  289. package/{src/skills/index.ts → dist/skills/index.d.ts} +0 -1
  290. package/dist/skills/index.js +10 -0
  291. package/dist/skills/index.js.map +1 -0
  292. package/dist/types.d.ts +118 -0
  293. package/dist/types.js +5 -0
  294. package/dist/types.js.map +1 -0
  295. package/package.json +7 -1
  296. package/.github/workflows/publish.yml +0 -27
  297. package/.github/workflows/test.yml +0 -17
  298. package/CLAUDE.md +0 -112
  299. package/docs/MIGRATION-2.0.md +0 -81
  300. package/docs/agent-guide.md +0 -869
  301. package/docs/agent_guide.md +0 -1026
  302. package/docs/api-reference.md +0 -2420
  303. package/docs/api_reference.md +0 -1301
  304. package/docs/architecture.md +0 -843
  305. package/docs/cli-guide.md +0 -579
  306. package/docs/cli_guide.md +0 -448
  307. package/docs/cloud_functions_guide.md +0 -474
  308. package/docs/configuration.md +0 -422
  309. package/docs/contexts-guide.md +0 -787
  310. package/docs/contexts_guide.md +0 -511
  311. package/docs/datamap-guide.md +0 -1141
  312. package/docs/datamap_guide.md +0 -595
  313. package/docs/llm_parameters.md +0 -239
  314. package/docs/mcp_gateway_reference.md +0 -648
  315. package/docs/mcp_integration.md +0 -108
  316. package/docs/prefabs-guide.md +0 -800
  317. package/docs/sdk_features.md +0 -477
  318. package/docs/security.md +0 -436
  319. package/docs/serverless-guide.md +0 -513
  320. package/docs/skills-guide.md +0 -857
  321. package/docs/skills-system.md +0 -301
  322. package/docs/skills_parameter_schema.md +0 -392
  323. package/docs/skills_system.md +0 -467
  324. package/docs/swaig-reference.md +0 -1627
  325. package/docs/swaig_reference.md +0 -910
  326. package/docs/swml_service_guide.md +0 -600
  327. package/docs/third_party_skills.md +0 -533
  328. package/docs/web_service.md +0 -677
  329. package/examples/README.md +0 -131
  330. package/examples/advanced-datamap.ts +0 -100
  331. package/examples/advanced-dynamic-config.ts +0 -70
  332. package/examples/auto-vivified.ts +0 -94
  333. package/examples/call-flow.ts +0 -63
  334. package/examples/comprehensive-dynamic.ts +0 -125
  335. package/examples/contexts-steps.ts +0 -65
  336. package/examples/custom-path.ts +0 -45
  337. package/examples/datamap-tools.ts +0 -55
  338. package/examples/datasphere-multi-instance.ts +0 -63
  339. package/examples/datasphere-serverless-env.ts +0 -68
  340. package/examples/datasphere-webhook-env.ts +0 -66
  341. package/examples/datasphere.ts +0 -37
  342. package/examples/declarative.ts +0 -100
  343. package/examples/dynamic-config.ts +0 -54
  344. package/examples/dynamic-info-gatherer.ts +0 -69
  345. package/examples/dynamic-swml-service.ts +0 -67
  346. package/examples/gather-info.ts +0 -71
  347. package/examples/gather-per-question-functions-demo.ts +0 -140
  348. package/examples/joke-agent.ts +0 -34
  349. package/examples/kubernetes-agent.ts +0 -45
  350. package/examples/llm-params.ts +0 -69
  351. package/examples/mcp-agent.ts +0 -84
  352. package/examples/mcp-gateway.ts +0 -35
  353. package/examples/multi-agent.ts +0 -73
  354. package/examples/multi-endpoint.ts +0 -79
  355. package/examples/pom-prompt.ts +0 -71
  356. package/examples/prefab-concierge.ts +0 -47
  357. package/examples/prefab-faq.ts +0 -54
  358. package/examples/prefab-info-gatherer.ts +0 -33
  359. package/examples/prefab-receptionist.ts +0 -36
  360. package/examples/prefab-survey.ts +0 -68
  361. package/examples/record-call.ts +0 -67
  362. package/examples/relay-demo.ts +0 -33
  363. package/examples/room-and-sip.ts +0 -94
  364. package/examples/serverless-lambda.ts +0 -35
  365. package/examples/session-state.ts +0 -83
  366. package/examples/simple-agent.ts +0 -36
  367. package/examples/simple-static.ts +0 -29
  368. package/examples/skills-demo.ts +0 -38
  369. package/examples/step-function-inheritance-demo.ts +0 -124
  370. package/examples/swaig-features.ts +0 -187
  371. package/examples/swml-service-routing.ts +0 -66
  372. package/examples/swml-service.ts +0 -38
  373. package/examples/tap.ts +0 -68
  374. package/examples/verb-methods.ts +0 -45
  375. package/examples/web-search-multi-instance.ts +0 -72
  376. package/examples/web-search.ts +0 -38
  377. package/examples/wikipedia.ts +0 -36
  378. package/livewire/README.md +0 -140
  379. package/livewire/docs/migration-guide.md +0 -228
  380. package/livewire/examples/livewire-basic-agent.ts +0 -74
  381. package/livewire/examples/livewire-handoff.ts +0 -197
  382. package/livewire/examples/livewire-multi-tool.ts +0 -117
  383. package/relay/README.md +0 -70
  384. package/relay/RELAY_IMPLEMENTATION_GUIDE.md +0 -1257
  385. package/relay/docs/call-methods.md +0 -474
  386. package/relay/docs/client-reference.md +0 -142
  387. package/relay/docs/events.md +0 -134
  388. package/relay/docs/getting-started.md +0 -134
  389. package/relay/docs/guide.md +0 -306
  390. package/relay/docs/messaging.md +0 -182
  391. package/relay/examples/relay-inbound.ts +0 -66
  392. package/relay/examples/relay-messaging.ts +0 -71
  393. package/relay/examples/relay-outbound.ts +0 -76
  394. package/rest/README.md +0 -95
  395. package/rest/docs/calling.md +0 -273
  396. package/rest/docs/client-reference.md +0 -107
  397. package/rest/docs/compat.md +0 -204
  398. package/rest/docs/fabric.md +0 -183
  399. package/rest/docs/getting-started.md +0 -110
  400. package/rest/docs/guide.md +0 -351
  401. package/rest/docs/namespaces.md +0 -285
  402. package/rest/examples/rest-10dlc-registration.ts +0 -161
  403. package/rest/examples/rest-calling-ivr-and-ai.ts +0 -102
  404. package/rest/examples/rest-calling-play-and-record.ts +0 -91
  405. package/rest/examples/rest-client.ts +0 -65
  406. package/rest/examples/rest-compat-laml.ts +0 -210
  407. package/rest/examples/rest-datasphere-search.ts +0 -82
  408. package/rest/examples/rest-fabric-conferences-and-routing.ts +0 -144
  409. package/rest/examples/rest-fabric-subscribers-and-sip.ts +0 -108
  410. package/rest/examples/rest-fabric-swml-and-callflows.ts +0 -99
  411. package/rest/examples/rest-manage-resources.ts +0 -65
  412. package/rest/examples/rest-phone-number-management.ts +0 -197
  413. package/rest/examples/rest-queues-mfa-and-recordings.ts +0 -143
  414. package/rest/examples/rest-video-rooms.ts +0 -186
  415. package/src/AgentBase.ts +0 -2598
  416. package/src/AgentServer.ts +0 -442
  417. package/src/AuthHandler.ts +0 -256
  418. package/src/ConfigLoader.ts +0 -447
  419. package/src/ContextBuilder.ts +0 -1181
  420. package/src/DataMap.ts +0 -477
  421. package/src/FunctionResult.ts +0 -903
  422. package/src/Logger.ts +0 -337
  423. package/src/PomBuilder.ts +0 -467
  424. package/src/PromptManager.ts +0 -133
  425. package/src/SWMLHandler.ts +0 -298
  426. package/src/SWMLService.ts +0 -749
  427. package/src/SchemaUtils.ts +0 -361
  428. package/src/ServerlessAdapter.ts +0 -240
  429. package/src/SessionManager.ts +0 -311
  430. package/src/SslConfig.ts +0 -118
  431. package/src/SwaigFunction.ts +0 -276
  432. package/src/SwmlBuilder.ts +0 -283
  433. package/src/SwmlVerbMethods.generated.ts +0 -234
  434. package/src/TypeInference.ts +0 -199
  435. package/src/WebService.ts +0 -641
  436. package/src/cli/agent-loader.ts +0 -166
  437. package/src/cli/mock-data.ts +0 -111
  438. package/src/cli/swaig-test.ts +0 -452
  439. package/src/generateVerbTypes.ts +0 -322
  440. package/src/livewire/index.ts +0 -1252
  441. package/src/prefabs/ConciergeAgent.ts +0 -309
  442. package/src/prefabs/FAQBotAgent.ts +0 -415
  443. package/src/prefabs/InfoGathererAgent.ts +0 -379
  444. package/src/prefabs/ReceptionistAgent.ts +0 -395
  445. package/src/prefabs/SurveyAgent.ts +0 -671
  446. package/src/relay/Action.ts +0 -482
  447. package/src/relay/Call.ts +0 -1270
  448. package/src/relay/Deferred.ts +0 -94
  449. package/src/relay/Message.ts +0 -199
  450. package/src/relay/RelayClient.ts +0 -1185
  451. package/src/relay/RelayError.ts +0 -20
  452. package/src/relay/RelayEvent.ts +0 -944
  453. package/src/relay/index.ts +0 -123
  454. package/src/relay/types.ts +0 -149
  455. package/src/rest/HttpClient.ts +0 -164
  456. package/src/rest/RestError.ts +0 -45
  457. package/src/rest/base/BaseResource.ts +0 -32
  458. package/src/rest/base/CrudResource.ts +0 -98
  459. package/src/rest/base/CrudWithAddresses.ts +0 -37
  460. package/src/rest/namespaces/addresses.ts +0 -64
  461. package/src/rest/namespaces/calling.ts +0 -534
  462. package/src/rest/namespaces/chat.ts +0 -31
  463. package/src/rest/namespaces/compat.ts +0 -812
  464. package/src/rest/namespaces/datasphere.ts +0 -88
  465. package/src/rest/namespaces/fabric.ts +0 -417
  466. package/src/rest/namespaces/imported-numbers.ts +0 -31
  467. package/src/rest/namespaces/logs.ts +0 -151
  468. package/src/rest/namespaces/lookup.ts +0 -38
  469. package/src/rest/namespaces/mfa.ts +0 -61
  470. package/src/rest/namespaces/number-groups.ts +0 -68
  471. package/src/rest/namespaces/phone-numbers.ts +0 -76
  472. package/src/rest/namespaces/project.ts +0 -65
  473. package/src/rest/namespaces/pubsub.ts +0 -31
  474. package/src/rest/namespaces/queues.ts +0 -58
  475. package/src/rest/namespaces/recordings.ts +0 -53
  476. package/src/rest/namespaces/registry.ts +0 -200
  477. package/src/rest/namespaces/short-codes.ts +0 -54
  478. package/src/rest/namespaces/sip-profile.ts +0 -40
  479. package/src/rest/namespaces/verified-callers.ts +0 -46
  480. package/src/rest/namespaces/video.ts +0 -332
  481. package/src/rest/types.ts +0 -61
  482. package/src/skills/SkillBase.ts +0 -582
  483. package/src/skills/SkillManager.ts +0 -419
  484. package/src/skills/SkillRegistry.ts +0 -367
  485. package/src/skills/builtin/api_ninjas_trivia.ts +0 -285
  486. package/src/skills/builtin/ask_claude.ts +0 -246
  487. package/src/skills/builtin/claude_skills.ts +0 -983
  488. package/src/skills/builtin/custom_skills.ts +0 -327
  489. package/src/skills/builtin/datasphere.ts +0 -447
  490. package/src/skills/builtin/datasphere_serverless.ts +0 -347
  491. package/src/skills/builtin/datetime.ts +0 -137
  492. package/src/skills/builtin/google_maps.ts +0 -656
  493. package/src/skills/builtin/info_gatherer.ts +0 -415
  494. package/src/skills/builtin/joke.ts +0 -196
  495. package/src/skills/builtin/math.ts +0 -149
  496. package/src/skills/builtin/mcp_gateway.ts +0 -685
  497. package/src/skills/builtin/native_vector_search.ts +0 -910
  498. package/src/skills/builtin/play_background_file.ts +0 -367
  499. package/src/skills/builtin/spider.ts +0 -874
  500. package/src/skills/builtin/swml_transfer.ts +0 -645
  501. package/src/skills/builtin/weather_api.ts +0 -255
  502. package/src/skills/builtin/web_search.ts +0 -1083
  503. package/src/skills/builtin/wikipedia_search.ts +0 -304
  504. package/src/types.ts +0 -132
  505. package/tests/AgentBase.test.ts +0 -1093
  506. package/tests/AgentServer.test.ts +0 -126
  507. package/tests/AuthHandler.test.ts +0 -133
  508. package/tests/ConfigLoader.test.ts +0 -151
  509. package/tests/ContextBuilder.test.ts +0 -108
  510. package/tests/DataMap.test.ts +0 -367
  511. package/tests/EphemeralSkillCopy.test.ts +0 -107
  512. package/tests/FunctionResult.test.ts +0 -298
  513. package/tests/GracefulShutdown.test.ts +0 -46
  514. package/tests/Logger.test.ts +0 -420
  515. package/tests/PomBuilder.test.ts +0 -228
  516. package/tests/ProxyDetection.test.ts +0 -228
  517. package/tests/SWMLService.test.ts +0 -320
  518. package/tests/SWMLVerbHandler.test.ts +0 -523
  519. package/tests/SchemaUtils.test.ts +0 -106
  520. package/tests/SchemaUtils.verb.test.ts +0 -206
  521. package/tests/SecurityUtils.test.ts +0 -192
  522. package/tests/ServerlessAdapter.test.ts +0 -222
  523. package/tests/SessionManager.test.ts +0 -257
  524. package/tests/SkillBaseFeatures.test.ts +0 -130
  525. package/tests/SkillMultiInstance.test.ts +0 -102
  526. package/tests/SkillParameterSchemas.test.ts +0 -134
  527. package/tests/SkillRegistrySchema.test.ts +0 -84
  528. package/tests/SslConfig.test.ts +0 -97
  529. package/tests/SwmlBuilder.test.ts +0 -400
  530. package/tests/TypeInference.test.ts +0 -165
  531. package/tests/VerbHandlerRegistry.test.ts +0 -128
  532. package/tests/cli/mock-data.test.ts +0 -113
  533. package/tests/cli/swaig-test.test.ts +0 -108
  534. package/tests/examples.test.ts +0 -194
  535. package/tests/fixtures/scrape-parity/README.md +0 -53
  536. package/tests/fixtures/scrape-parity/expected/01_simple_article.json +0 -5
  537. package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +0 -5
  538. package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +0 -5
  539. package/tests/fixtures/scrape-parity/expected/04_bare_body.json +0 -5
  540. package/tests/fixtures/scrape-parity/expected/05_malformed.json +0 -5
  541. package/tests/fixtures/scrape-parity/expected/06_multi_class.json +0 -5
  542. package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +0 -5
  543. package/tests/fixtures/scrape-parity/expected/08_inline_script.json +0 -5
  544. package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +0 -5
  545. package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +0 -5
  546. package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +0 -5
  547. package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +0 -5
  548. package/tests/fixtures/scrape-parity/html/01_simple_article.html +0 -18
  549. package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +0 -18
  550. package/tests/fixtures/scrape-parity/html/03_nested_containers.html +0 -13
  551. package/tests/fixtures/scrape-parity/html/04_bare_body.html +0 -9
  552. package/tests/fixtures/scrape-parity/html/05_malformed.html +0 -11
  553. package/tests/fixtures/scrape-parity/html/06_multi_class.html +0 -18
  554. package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +0 -12
  555. package/tests/fixtures/scrape-parity/html/08_inline_script.html +0 -17
  556. package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +0 -21
  557. package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +0 -10
  558. package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +0 -13
  559. package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +0 -24
  560. package/tests/fixtures/scrape-parity/python_extract.py +0 -109
  561. package/tests/livewire/livewire.test.ts +0 -780
  562. package/tests/mcp.test.ts +0 -221
  563. package/tests/prefabs/prefabs.test.ts +0 -1093
  564. package/tests/relay/Action.test.ts +0 -392
  565. package/tests/relay/Call.test.ts +0 -535
  566. package/tests/relay/Deferred.test.ts +0 -71
  567. package/tests/relay/Message.test.ts +0 -164
  568. package/tests/relay/RelayClient.test.ts +0 -779
  569. package/tests/relay/RelayEvent.test.ts +0 -463
  570. package/tests/relay/helpers.ts +0 -79
  571. package/tests/rest/HttpClient.test.ts +0 -274
  572. package/tests/rest/RestError.test.ts +0 -53
  573. package/tests/rest/calling.test.ts +0 -156
  574. package/tests/rest/client.test.ts +0 -197
  575. package/tests/rest/compat.test.ts +0 -335
  576. package/tests/rest/datasphere.test.ts +0 -71
  577. package/tests/rest/fabric.test.ts +0 -186
  578. package/tests/rest/helpers.ts +0 -95
  579. package/tests/rest/logs.test.ts +0 -68
  580. package/tests/rest/pagination.test.ts +0 -133
  581. package/tests/rest/registry.test.ts +0 -94
  582. package/tests/rest/relay-rest.test.ts +0 -290
  583. package/tests/rest/video.test.ts +0 -173
  584. package/tests/setup.ts +0 -6
  585. package/tests/skills/SkillBase.test.ts +0 -108
  586. package/tests/skills/SkillManager.test.ts +0 -268
  587. package/tests/skills/SkillRegistry.test.ts +0 -176
  588. package/tests/skills/builtin.test.ts +0 -1472
  589. package/tests/skills/claude-skills.test.ts +0 -54
  590. package/tests/skills/custom-skills.test.ts +0 -53
  591. package/tests/skills/datasphere-serverless.test.ts +0 -70
  592. package/tests/skills/datasphere.test.ts +0 -107
  593. package/tests/skills/datetime.test.ts +0 -101
  594. package/tests/skills/google-maps.test.ts +0 -78
  595. package/tests/skills/info-gatherer.test.ts +0 -411
  596. package/tests/skills/joke.test.ts +0 -81
  597. package/tests/skills/math.test.ts +0 -68
  598. package/tests/skills/mcp-gateway.test.ts +0 -101
  599. package/tests/skills/play-background.test.ts +0 -54
  600. package/tests/skills/spider.test.ts +0 -108
  601. package/tests/skills/swml-transfer.test.ts +0 -178
  602. package/tests/skills/trivia.test.ts +0 -54
  603. package/tests/skills/vector-search.test.ts +0 -135
  604. package/tests/skills/weather-api.test.ts +0 -77
  605. package/tests/skills/web-search-parity.test.ts +0 -59
  606. package/tests/skills/web-search.test.ts +0 -103
  607. package/tests/skills/wikipedia.test.ts +0 -63
  608. package/tsconfig.json +0 -18
  609. package/vitest.config.ts +0 -9
  610. /package/{src → dist}/schema.json +0 -0
@@ -1,843 +0,0 @@
1
- # SignalWire AI Agents TypeScript SDK -- Architecture
2
-
3
- ## Table of Contents
4
-
5
- - [Overview](#overview)
6
- - [Core Components](#core-components)
7
- - [AgentBase](#agentbase)
8
- - [PromptManager and PomBuilder](#promptmanager-and-pombuilder)
9
- - [SwmlBuilder](#swmlbuilder)
10
- - [SwaigFunction](#swaigfunction)
11
- - [FunctionResult](#swaigfunctionresult)
12
- - [SessionManager](#sessionmanager)
13
- - [ContextBuilder](#contextbuilder)
14
- - [DataMap](#datamap)
15
- - [Composition Architecture](#composition-architecture)
16
- - [SWML Rendering Pipeline](#swml-rendering-pipeline)
17
- - [Request Flow](#request-flow)
18
- - [SWML Request (GET/POST /)](#swml-request-getpost-)
19
- - [SWAIG Function Dispatch (POST /swaig)](#swaig-function-dispatch-post-swaig)
20
- - [Post-Prompt Handler (POST /post_prompt)](#post-prompt-handler-post-post_prompt)
21
- - [Tool System](#tool-system)
22
- - [SwaigFunction Wrapper](#swaigfunction-wrapper)
23
- - [Handler Signature](#handler-signature)
24
- - [Result Serialization](#result-serialization)
25
- - [DataMap Tools](#datamap-tools)
26
- - [Session Management](#session-management)
27
- - [Token Format](#token-format)
28
- - [Token Generation](#token-generation)
29
- - [Token Validation](#token-validation)
30
- - [Proxy Detection](#proxy-detection)
31
- - [Security Layers](#security-layers)
32
- - [Basic Authentication](#basic-authentication)
33
- - [CORS](#cors)
34
- - [Security Headers](#security-headers)
35
- - [Rate Limiting](#rate-limiting)
36
- - [Allowed Hosts](#allowed-hosts)
37
- - [Request Size Limits](#request-size-limits)
38
- - [Extension Points](#extension-points)
39
-
40
- ---
41
-
42
- ## Overview
43
-
44
- The SignalWire AI Agents TypeScript SDK implements an agent-as-microservice architecture. Each agent is an HTTP server that serves SWML documents and handles SWAIG tool callbacks. The SDK is built on the [Hono](https://hono.dev/) web framework and uses Node.js crypto for session management.
45
-
46
- ```
47
- +--------------------------------------------------+
48
- | AgentBase |
49
- | |
50
- | +----------------+ +---------------------+ |
51
- | | PromptManager | | SessionManager | |
52
- | | +----------+ | | (HMAC tokens, | |
53
- | | |PomBuilder| | | session metadata) | |
54
- | | +----------+ | +---------------------+ |
55
- | +----------------+ |
56
- | |
57
- | +----------------+ +---------------------+ |
58
- | | SwmlBuilder | | Tool Registry | |
59
- | | (5-phase SWML | | Map<string, | |
60
- | | document) | | SwaigFunction | | |
61
- | +----------------+ | Record<>> | | |
62
- | +---------------------+ |
63
- | |
64
- | +----------------+ +---------------------+ |
65
- | | ContextBuilder | | SkillManager | |
66
- | | (optional) | | (optional) | |
67
- | +----------------+ +---------------------+ |
68
- | |
69
- | +--------------------------------------------+ |
70
- | | Hono HTTP App | |
71
- | | GET/POST / -> renderSwml() | |
72
- | | POST /swaig -> tool dispatch | |
73
- | | POST /post_prompt -> onSummary() | |
74
- | | GET /health -> { status: ok } | |
75
- | | GET /ready -> { status: ready } | |
76
- | +--------------------------------------------+ |
77
- +--------------------------------------------------+
78
-
79
- Inbound Call
80
- |
81
- v
82
- SignalWire Platform --GET/POST--> AgentBase / (returns SWML)
83
- |
84
- v
85
- AI engine processes call using SWML config
86
- |
87
- v
88
- AI invokes tool --POST--> AgentBase /swaig (executes handler)
89
- |
90
- v
91
- Call ends --POST--> AgentBase /post_prompt (delivers summary)
92
- ```
93
-
94
- ### AgentServer (Multi-Agent)
95
-
96
- For hosting multiple agents on a single port, `AgentServer` mounts each agent's Hono app at its route prefix:
97
-
98
- ```
99
- AgentServer (Hono)
100
- |-- /sales -> SalesAgent.getApp()
101
- |-- /support -> SupportAgent.getApp()
102
- |-- /health -> global health check
103
- |-- /ready -> global readiness check
104
- |-- / -> agent listing (if no agent mounted at /)
105
- ```
106
-
107
- ---
108
-
109
- ## Core Components
110
-
111
- ### AgentBase
112
-
113
- **File**: `src/AgentBase.ts` (~1280 lines)
114
-
115
- The central class that composes all other components. It is responsible for:
116
-
117
- - **HTTP server lifecycle**: Creating and configuring the Hono app, binding middleware, registering routes, starting the server.
118
- - **SWML rendering**: Assembling the 5-phase SWML document from all configured verbs, prompts, tools, and AI parameters.
119
- - **Tool dispatch**: Routing incoming SWAIG function calls to the correct handler, validating secure tokens.
120
- - **Proxy detection**: Auto-detecting reverse proxy configurations from request headers.
121
- - **Dynamic configuration**: Creating ephemeral copies and invoking the dynamic config callback per-request.
122
- - **Lifecycle hooks**: Providing `onSummary`, `onFunctionCall`, `onSwmlRequest`, `onDebugEvent`, and `validateBasicAuth` for subclass customization.
123
-
124
- Key internal state:
125
-
126
- ```typescript
127
- // Managers (composition)
128
- private promptManager: PromptManager;
129
- private sessionManager: SessionManager;
130
- private swmlBuilder: SwmlBuilder;
131
- private toolRegistry: Map<string, SwaigFunction | Record<string, unknown>>;
132
-
133
- // AI configuration
134
- private hints: string[];
135
- private languages: LanguageConfig[];
136
- private pronounce: PronunciationRule[];
137
- private params: Record<string, unknown>;
138
- private globalData: Record<string, unknown>;
139
- private promptLlmParams: Record<string, unknown>;
140
- private postPromptLlmParams: Record<string, unknown>;
141
-
142
- // Call flow verbs (5 phases)
143
- private preAnswerVerbs: [string, Record<string, unknown>][];
144
- private answerConfig: Record<string, unknown>;
145
- private postAnswerVerbs: [string, Record<string, unknown>][];
146
- private postAiVerbs: [string, Record<string, unknown>][];
147
-
148
- // Dynamic config
149
- private dynamicConfigCallback: DynamicConfigCallback | null;
150
- ```
151
-
152
- ### PromptManager and PomBuilder
153
-
154
- **Files**: `src/PromptManager.ts`, `src/PomBuilder.ts`
155
-
156
- `PromptManager` is a facade that manages the agent's prompt text. It supports two modes:
157
-
158
- 1. **Raw text mode** -- A plain string set via `setPromptText()`. When set, it takes precedence over POM.
159
- 2. **POM mode** -- A `PomBuilder` instance that assembles structured sections into Markdown.
160
-
161
- `PomBuilder` maintains an ordered list of `PomSection` objects. Each section has:
162
-
163
- - `title` -- Rendered as a Markdown heading (e.g., `## Title`).
164
- - `body` -- Paragraph text below the heading.
165
- - `bullets` -- Rendered as `- item` or `1. item` (numbered).
166
- - `subsections` -- Nested `PomSection` instances rendered at a deeper heading level.
167
-
168
- The rendering pipeline:
169
-
170
- ```
171
- PomBuilder.renderMarkdown()
172
- -> for each PomSection:
173
- PomSection.renderMarkdown(level=2, sectionNumber=[])
174
- -> heading: "## [N.] Title"
175
- -> body paragraph
176
- -> bullet list (- or 1.)
177
- -> recurse into subsections at level+1
178
- ```
179
-
180
- `PromptManager.getPrompt()` returns:
181
- 1. `rawText` if set (bypasses POM).
182
- 2. `pom.renderMarkdown()` if POM sections exist.
183
- 3. Empty string otherwise.
184
-
185
- ### SwmlBuilder
186
-
187
- **File**: `src/SwmlBuilder.ts` (~62 lines)
188
-
189
- A minimal builder that assembles SWML documents. A SWML document has the structure:
190
-
191
- ```json
192
- {
193
- "version": "1.0.0",
194
- "sections": {
195
- "main": [
196
- { "answer": {} },
197
- { "ai": { ... } },
198
- { "hangup": {} }
199
- ]
200
- }
201
- }
202
- ```
203
-
204
- Key methods:
205
-
206
- | Method | Description |
207
- |--------|-------------|
208
- | `reset()` | Clears the document back to an empty `{ version, sections: { main: [] } }`. |
209
- | `addVerb(verbName, config)` | Appends `{ [verbName]: config }` to the `main` section. |
210
- | `addVerbToSection(section, verb, config)` | Appends to a named section (creates if absent). |
211
- | `renderDocument()` | Returns `JSON.stringify(document)`. |
212
-
213
- `SwmlBuilder` is stateless between render cycles. `AgentBase.renderSwml()` calls `reset()` at the start, builds the 5 phases by calling `addVerb()`, then calls `renderDocument()`.
214
-
215
- ### SwaigFunction
216
-
217
- **File**: `src/SwaigFunction.ts` (~168 lines)
218
-
219
- Wraps a tool handler with metadata for SWAIG registration:
220
-
221
- ```typescript
222
- class SwaigFunction {
223
- name: string; // Tool name
224
- handler: SwaigHandler; // The callback function
225
- description: string; // Shown to the AI
226
- parameters: Record; // JSON Schema for arguments
227
- secure: boolean; // Requires HMAC token
228
- fillers?: Record; // Per-language filler phrases
229
- waitFile?: string; // Audio to play while executing
230
- waitFileLoops?: number; // Loop count for wait file
231
- webhookUrl?: string; // External webhook (bypasses local handler)
232
- required: string[]; // Required parameter names
233
- extraFields: Record; // Additional SWAIG fields
234
- }
235
- ```
236
-
237
- Two primary operations:
238
-
239
- 1. **`execute(args, rawData)`** -- Invokes the handler and normalizes the result:
240
- - `FunctionResult` -> `result.toDict()`
241
- - Object with `response` key -> returned as-is
242
- - Plain object -> wrapped with "Function completed successfully" message
243
- - String -> wrapped in `FunctionResult`
244
- - Exception -> returns a generic error message
245
-
246
- 2. **`toSwaig(baseUrl, token?, callId?)`** -- Serializes to the SWAIG wire format for SWML.
247
-
248
- ### FunctionResult
249
-
250
- **File**: `src/FunctionResult.ts` (~864 lines)
251
-
252
- A fluent builder for SWAIG function responses. Carries:
253
-
254
- - `response: string` -- Text returned to the AI.
255
- - `action: Record<string, unknown>[]` -- Ordered list of actions.
256
- - `postProcess: boolean` -- Whether actions run after the AI responds.
257
-
258
- The `toDict()` serialization:
259
-
260
- ```typescript
261
- toDict(): Record<string, unknown> {
262
- const result: Record<string, unknown> = {};
263
- if (this.response) result['response'] = this.response;
264
- if (this.action.length > 0) result['action'] = this.action;
265
- if (this.postProcess && this.action.length > 0) result['post_process'] = true;
266
- if (Object.keys(result).length === 0) result['response'] = 'Action completed.';
267
- return result;
268
- }
269
- ```
270
-
271
- The fallback `"Action completed."` ensures the response is never empty.
272
-
273
- Action categories:
274
-
275
- | Category | Methods |
276
- |----------|---------|
277
- | Call control | `connect()`, `hangup()`, `hold()`, `stop()`, `waitForUser()` |
278
- | Audio | `say()`, `playBackgroundFile()`, `stopBackgroundFile()` |
279
- | Speech | `addDynamicHints()`, `clearDynamicHints()`, `setEndOfSpeechTimeout()` |
280
- | Data | `updateGlobalData()`, `removeGlobalData()`, `setMetadata()`, `removeMetadata()` |
281
- | SWML | `executeSwml()`, `swmlChangeStep()`, `swmlChangeContext()`, `swmlUserEvent()` |
282
- | Context | `switchContext()` |
283
- | Functions | `toggleFunctions()`, `enableFunctionsOnTimeout()`, `updateSettings()` |
284
- | Comms | `sendSms()`, `recordCall()`, `stopRecordCall()`, `tap()`, `stopTap()`, `sipRefer()` |
285
- | Rooms | `joinRoom()`, `joinConference()` |
286
- | RPC | `executeRpc()`, `rpcDial()`, `rpcAiMessage()`, `rpcAiUnhold()` |
287
- | Payments | `pay()` |
288
-
289
- ### SessionManager
290
-
291
- **File**: `src/SessionManager.ts` (~161 lines)
292
-
293
- Stateless HMAC-SHA256 token manager. See [Session Management](#session-management) for details.
294
-
295
- ### ContextBuilder
296
-
297
- **File**: `src/ContextBuilder.ts` (~797 lines)
298
-
299
- Builds multi-context, multi-step conversation workflows. A `ContextBuilder` contains named `Context` objects, each containing ordered `Step` objects. Steps have prompt content, completion criteria, function restrictions, and navigation rules.
300
-
301
- ```
302
- ContextBuilder
303
- |-- Context "greeting"
304
- | |-- Step "welcome" (text, criteria, functions)
305
- | |-- Step "identify" (gather_info questions)
306
- |
307
- |-- Context "support"
308
- |-- Step "diagnose" (POM sections, valid_steps)
309
- |-- Step "resolve" (end: true)
310
- ```
311
-
312
- Contexts are serialized into the `contexts` key of the `ai` verb in SWML.
313
-
314
- ### DataMap
315
-
316
- **File**: `src/DataMap.ts` (~365 lines)
317
-
318
- Fluent builder for server-side SWAIG tools that execute on SignalWire without webhook callbacks. A DataMap can include:
319
-
320
- - **Webhooks**: HTTP calls to external APIs with response template interpolation.
321
- - **Expressions**: Pattern-matching rules evaluated against template variables.
322
- - **Output templates**: `FunctionResult` instances serialized for response formatting.
323
-
324
- DataMap tools are registered as raw dictionary objects in the tool registry (not `SwaigFunction` instances).
325
-
326
- ---
327
-
328
- ## Composition Architecture
329
-
330
- The Python SDK uses 8 mixins to compose agent behavior. The TypeScript SDK replaces this with **internal composition** -- `AgentBase` holds manager instances as private fields:
331
-
332
- ```
333
- Python SDK (Mixins) TypeScript SDK (Composition)
334
- -------------------------- ---------------------------------
335
- AgentBase( class AgentBase {
336
- PromptMixin, private promptManager: PromptManager;
337
- SwaigMixin, private toolRegistry: Map<...>;
338
- SessionMixin, private sessionManager: SessionManager;
339
- SwmlMixin, private swmlBuilder: SwmlBuilder;
340
- HttpMixin, private _app: Hono;
341
- ConfigMixin, private dynamicConfigCallback: ...;
342
- HintsMixin, private hints: string[];
343
- LanguageMixin private languages: LanguageConfig[];
344
- ) }
345
- ```
346
-
347
- Design decisions:
348
-
349
- 1. **No multiple inheritance**: TypeScript does not natively support mixins in the same way Python does. Composition provides cleaner encapsulation.
350
- 2. **Private managers**: `PromptManager`, `SessionManager`, and `SwmlBuilder` are private. Public methods on `AgentBase` delegate to them (e.g., `setPromptText()` delegates to `promptManager.setPromptText()`).
351
- 3. **Tool registry is a Map**: Supports both `SwaigFunction` instances (handler-based tools) and plain `Record<string, unknown>` objects (DataMap/raw definitions).
352
- 4. **Single public surface**: All configuration happens through `AgentBase` methods. Users do not need to interact with internal managers directly.
353
- 5. **Ephemeral copies**: The `createEphemeralCopy()` method shallow-copies the agent, then deep-copies all mutable collections (hints, languages, params, verbs, tool registry, etc.) and creates fresh `PromptManager` and `SwmlBuilder` instances.
354
-
355
- ---
356
-
357
- ## SWML Rendering Pipeline
358
-
359
- The `renderSwml(callId?)` method on `AgentBase` assembles the complete SWML document in five sequential phases:
360
-
361
- ```
362
- renderSwml(callId?)
363
- |
364
- |-- 1. swmlBuilder.reset()
365
- |
366
- |-- 2. Build webhook URLs (swaig, post_prompt)
367
- | - Combine proxy base URL + route + endpoint
368
- | - Embed basic auth credentials in URL
369
- | - Append query params (swaigQueryParams, __token)
370
- |
371
- |-- 3. Build SWAIG object
372
- | - native_functions[]
373
- | - includes[]
374
- | - internal_fillers{}
375
- | - functions[] (iterate toolRegistry)
376
- | For each SwaigFunction:
377
- | - name, description, parameters (ensure schema structure)
378
- | - fillers, wait_file, wait_file_loops
379
- | - web_hook_url (with token for secure tools)
380
- | For each raw dict (DataMap):
381
- | - spread as-is with function name
382
- | - defaults.web_hook_url
383
- |
384
- |-- PHASE 1: Pre-Answer Verbs
385
- | for [verb, config] of preAnswerVerbs:
386
- | swmlBuilder.addVerb(verb, config)
387
- |
388
- |-- PHASE 2: Answer Verb
389
- | if autoAnswer:
390
- | swmlBuilder.addVerb('answer', answerConfig)
391
- |
392
- |-- PHASE 3: Post-Answer Verbs
393
- | if recordCall:
394
- | swmlBuilder.addVerb('record_call', { format, stereo })
395
- | for [verb, config] of postAnswerVerbs:
396
- | swmlBuilder.addVerb(verb, config)
397
- |
398
- |-- PHASE 4: AI Verb
399
- | Build aiConfig object:
400
- | prompt: { text: ..., ...promptLlmParams }
401
- | post_prompt: { text: ..., ...postPromptLlmParams }
402
- | post_prompt_url: ...
403
- | SWAIG: swaigObj
404
- | contexts: contextsBuilder.toDict() (if defined)
405
- | hints: [...]
406
- | languages: [...]
407
- | pronounce: [...]
408
- | params: {...}
409
- | global_data: {...}
410
- | debug_webhook_url / debug_webhook_level (if enabled)
411
- | swmlBuilder.addVerb('ai', aiConfig)
412
- |
413
- |-- PHASE 5: Post-AI Verbs
414
- | for [verb, config] of postAiVerbs:
415
- | swmlBuilder.addVerb(verb, config)
416
- |
417
- |-- Return swmlBuilder.renderDocument() (JSON string)
418
- ```
419
-
420
- The resulting SWML document structure:
421
-
422
- ```json
423
- {
424
- "version": "1.0.0",
425
- "sections": {
426
- "main": [
427
- { "play": { "url": "..." } },
428
- { "answer": {} },
429
- { "record_call": { "format": "mp4", "stereo": true } },
430
- {
431
- "ai": {
432
- "prompt": { "text": "..." },
433
- "post_prompt": { "text": "..." },
434
- "post_prompt_url": "https://...",
435
- "SWAIG": {
436
- "functions": [ ... ],
437
- "defaults": { "web_hook_url": "https://..." }
438
- },
439
- "hints": [ "SignalWire", "HIPAA" ],
440
- "params": { "temperature": 0.7 },
441
- "global_data": { "company": "Acme" }
442
- }
443
- },
444
- { "hangup": {} }
445
- ]
446
- }
447
- }
448
- ```
449
-
450
- ---
451
-
452
- ## Request Flow
453
-
454
- ### SWML Request (GET/POST /)
455
-
456
- ```
457
- Client Request
458
- |
459
- v
460
- Hono Middleware Stack:
461
- 1. Security headers (X-Content-Type-Options, X-Frame-Options, etc.)
462
- 2. Request size limit check (SWML_MAX_REQUEST_SIZE)
463
- 3. Allowed hosts check (SWML_ALLOWED_HOSTS)
464
- 4. Rate limiter (SWML_RATE_LIMIT)
465
- 5. CORS (SWML_CORS_ORIGINS)
466
- 6. Basic Auth (credential validation)
467
- |
468
- v
469
- handleSwml():
470
- 1. Parse request body (JSON, or empty for GET)
471
- 2. detectProxyFromRequest(c) -- inspect headers for proxy info
472
- 3. await onSwmlRequest(body) -- lifecycle hook
473
- 4. If dynamicConfigCallback is set:
474
- a. createEphemeralCopy() -- deep-copy mutable state
475
- b. Extract queryParams, headers from request
476
- c. await dynamicConfigCallback(queryParams, body, headers, copy)
477
- d. Use copy for rendering
478
- 5. Extract call_id from body (if present)
479
- 6. agentToUse.renderSwml(callId) -- 5-phase rendering
480
- 7. Return JSON response
481
- ```
482
-
483
- ### SWAIG Function Dispatch (POST /swaig)
484
-
485
- ```
486
- Client Request (from SignalWire platform)
487
- |
488
- v
489
- Middleware Stack (same as above)
490
- |
491
- v
492
- handleSwaig():
493
- 1. Parse request body
494
- 2. Extract function name from body["function"]
495
- 3. Look up in toolRegistry
496
- - Not found -> 404 { error: "Unknown function: ..." }
497
- - Not a SwaigFunction -> 404
498
- 4. If fn.secure:
499
- a. Extract __token from URL query params
500
- b. Extract call_id from body
501
- c. sessionManager.validateToken(callId, fnName, token)
502
- d. Invalid -> 403 { error: "Invalid or expired token" }
503
- 5. Extract args from body["argument"]
504
- 6. await onFunctionCall(fnName, args, body) -- lifecycle hook
505
- 7. result = await fn.execute(args, body)
506
- 8. Return JSON response (result dict)
507
- ```
508
-
509
- ### Post-Prompt Handler (POST /post_prompt)
510
-
511
- ```
512
- Client Request (from SignalWire platform, end of call)
513
- |
514
- v
515
- Middleware Stack
516
- |
517
- v
518
- handlePostPrompt():
519
- 1. Parse request body
520
- 2. findSummary(body):
521
- a. Check body["summary"]
522
- b. Check body["post_prompt_data"]["parsed"][0]
523
- c. Try JSON.parse(body["post_prompt_data"]["raw"])
524
- d. Return raw value as fallback
525
- e. Return null if nothing found
526
- 3. await onSummary(summary, body) -- lifecycle hook
527
- 4. Return { ok: true }
528
- ```
529
-
530
- ---
531
-
532
- ## Tool System
533
-
534
- ### SwaigFunction Wrapper
535
-
536
- Each tool registered via `defineTool()` creates a `SwaigFunction` instance stored in the `toolRegistry` Map. The registry also supports raw dictionary entries (DataMap tools registered via `registerSwaigFunction()`).
537
-
538
- ```typescript
539
- // Handler-based tool
540
- toolRegistry.set('get_weather', new SwaigFunction({ name, handler, description, ... }));
541
-
542
- // DataMap (raw dict)
543
- toolRegistry.set('lookup_zip', { function: 'lookup_zip', description: '...', data_map: {...} });
544
- ```
545
-
546
- During SWML rendering, the registry is iterated. `SwaigFunction` instances are serialized with their schema, webhook URLs, and optional tokens. Raw dicts are spread as-is.
547
-
548
- ### Handler Signature
549
-
550
- ```typescript
551
- type SwaigHandler = (
552
- args: Record<string, unknown>, // AI-extracted arguments
553
- rawData: Record<string, unknown>, // Full request payload
554
- ) => FunctionResult | Record<string, unknown> | string
555
- | Promise<FunctionResult | Record<string, unknown> | string>;
556
- ```
557
-
558
- The handler is intentionally flexible in its return type. The `execute()` method normalizes all return types into a consistent dict format.
559
-
560
- ### Result Serialization
561
-
562
- The `execute()` method in `SwaigFunction` handles all return type normalization:
563
-
564
- ```
565
- Handler returns:
566
- |
567
- |-- FunctionResult --> result.toDict()
568
- |-- { response: "..." } --> returned as-is
569
- |-- { ... } (no response) --> FunctionResult("Function completed successfully").toDict()
570
- |-- "string" --> FunctionResult(string).toDict()
571
- |-- throws Error --> FunctionResult("Sorry, I couldn't...").toDict()
572
- ```
573
-
574
- `FunctionResult.toDict()` produces:
575
-
576
- ```json
577
- {
578
- "response": "The weather is 72F and sunny.",
579
- "action": [
580
- { "set_global_data": { "last_city": "Austin" } }
581
- ],
582
- "post_process": false
583
- }
584
- ```
585
-
586
- If both `response` and `action` are empty, the fallback `"Action completed."` is used.
587
-
588
- ### DataMap Tools
589
-
590
- DataMap tools differ from handler-based tools in that they execute entirely on the SignalWire platform. They are serialized as raw dictionaries with a `data_map` key instead of a `web_hook_url`:
591
-
592
- ```json
593
- {
594
- "function": "check_status",
595
- "description": "Check order status",
596
- "parameters": { "type": "object", "properties": { ... } },
597
- "data_map": {
598
- "webhooks": [
599
- {
600
- "url": "https://api.example.com/orders/${args.order_id}",
601
- "method": "GET",
602
- "output": { "response": "Order status: ${status}" }
603
- }
604
- ]
605
- }
606
- }
607
- ```
608
-
609
- ---
610
-
611
- ## Session Management
612
-
613
- The `SessionManager` provides stateless HMAC-SHA256 token generation and validation. No server-side session state is stored for tokens -- all information is encoded within the token itself.
614
-
615
- ### Token Format
616
-
617
- Tokens are base64url-encoded strings containing five dot-separated fields:
618
-
619
- ```
620
- base64url( callId . functionName . expiry . nonce . hmacSignature )
621
- ```
622
-
623
- | Field | Description |
624
- |-------|-------------|
625
- | `callId` | The call ID this token is bound to. |
626
- | `functionName` | The SWAIG function name this token authorizes. |
627
- | `expiry` | Unix timestamp (seconds) when the token expires. |
628
- | `nonce` | Random 4-byte hex string for uniqueness. |
629
- | `hmacSignature` | First 16 hex chars of HMAC-SHA256 over `callId:functionName:expiry:nonce`. |
630
-
631
- ### Token Generation
632
-
633
- ```typescript
634
- generateToken(functionName: string, callId: string): string {
635
- const expiry = Math.floor(Date.now() / 1000) + this.tokenExpirySecs;
636
- const nonce = randomBytes(4).toString('hex');
637
- const message = `${callId}:${functionName}:${expiry}:${nonce}`;
638
- const signature = createHmac('sha256', this.secretKey)
639
- .update(message)
640
- .digest('hex')
641
- .slice(0, 16);
642
- const token = `${callId}.${functionName}.${expiry}.${nonce}.${signature}`;
643
- return Buffer.from(token).toString('base64url');
644
- }
645
- ```
646
-
647
- The secret key is a random 32-byte hex string generated at startup (per `SessionManager` instance). Tokens are generated during SWML rendering and embedded in the `__token` query parameter of each secure tool's webhook URL.
648
-
649
- ### Token Validation
650
-
651
- On each `/swaig` POST for a secure tool:
652
-
653
- 1. Decode the base64url token.
654
- 2. Split into 5 parts; reject if not exactly 5.
655
- 3. Verify `functionName` matches the requested function.
656
- 4. Verify `expiry` has not passed.
657
- 5. Recompute HMAC-SHA256 over the same message format.
658
- 6. Compare the first 16 hex chars of the computed signature to the token's signature.
659
- 7. Verify `callId` matches the request's call ID.
660
-
661
- All checks must pass. Any failure returns a `403 Forbidden` response.
662
-
663
- ### Session Metadata
664
-
665
- `SessionManager` also provides an in-memory metadata store keyed by session ID:
666
-
667
- ```typescript
668
- setSessionMetadata(sessionId: string, metadata: Record<string, unknown>): void;
669
- getSessionMetadata(sessionId: string): Record<string, unknown> | undefined;
670
- deleteSessionMetadata(sessionId: string): boolean;
671
- ```
672
-
673
- This is used for storing per-session state that persists across multiple tool invocations within the same call.
674
-
675
- ---
676
-
677
- ## Proxy Detection
678
-
679
- When running behind a reverse proxy (nginx, Cloudflare, AWS ALB, etc.), the agent needs to know its external URL to generate correct webhook URLs in SWML. The proxy detection system checks multiple sources in priority order:
680
-
681
- ### Detection Priority
682
-
683
- 1. **Environment variable** (`SWML_PROXY_URL_BASE`) -- Highest priority. Once set, header-based detection is disabled.
684
- 2. **Manual override** (`manualSetProxyUrl()`) -- Programmatic override.
685
- 3. **X-Forwarded-Host + X-Forwarded-Proto** headers.
686
- 4. **Forwarded** header (RFC 7239) -- Parses `host=` and `proto=` directives.
687
- 5. **X-Original-Host + X-Forwarded-Proto** headers.
688
- 6. **X-Forwarded-For** -- Detected but cannot determine host; logs a warning suggesting manual configuration.
689
- 7. **Fallback** -- Uses `http://localhost:{port}{route}`.
690
-
691
- The detection runs on every SWML request (`detectProxyFromRequest()`). Once the environment variable is set, it is never overridden by header detection.
692
-
693
- ### Webhook URL Building
694
-
695
- ```typescript
696
- buildWebhookUrl(endpoint: string, extraParams?: Record<string, string>): string
697
- ```
698
-
699
- This method:
700
-
701
- 1. Calls `getFullUrl(includeAuth=true)` to get the base URL with embedded basic auth credentials.
702
- 2. Appends the endpoint path (e.g., `/swaig`, `/post_prompt`).
703
- 3. Appends query parameters (SWAIG query params, `__token` for secure tools).
704
-
705
- Example generated URL:
706
- ```
707
- https://admin:s3cret@agents.example.com/support/swaig?__token=abc123&tenant=acme
708
- ```
709
-
710
- ---
711
-
712
- ## Security Layers
713
-
714
- The SDK implements multiple security layers, all configured through the Hono middleware stack.
715
-
716
- ### Basic Authentication
717
-
718
- All endpoints except `/health` and `/ready` require HTTP Basic Authentication. Credentials are resolved in priority order:
719
-
720
- 1. `basicAuth` constructor option.
721
- 2. `SWML_BASIC_AUTH_USER` / `SWML_BASIC_AUTH_PASSWORD` environment variables.
722
- 3. Auto-generated (agent name as username, random 8-byte hex as password).
723
-
724
- The `validateBasicAuth(username, password)` hook can be overridden in subclasses to add custom validation logic (e.g., checking against a database).
725
-
726
- Credentials are embedded in webhook URLs so that SignalWire can authenticate when calling back to the agent.
727
-
728
- ### CORS
729
-
730
- Controlled by `SWML_CORS_ORIGINS`:
731
-
732
- ```typescript
733
- // Default: allow all origins
734
- cors({ origin: '*', credentials: true })
735
-
736
- // Restricted: SWML_CORS_ORIGINS=https://app.example.com,https://admin.example.com
737
- cors({ origin: ['https://app.example.com', 'https://admin.example.com'], credentials: true })
738
- ```
739
-
740
- ### Security Headers
741
-
742
- Applied to all responses via middleware:
743
-
744
- | Header | Value |
745
- |--------|-------|
746
- | `X-Content-Type-Options` | `nosniff` |
747
- | `X-Frame-Options` | `DENY` |
748
- | `X-XSS-Protection` | `1; mode=block` |
749
- | `Referrer-Policy` | `strict-origin-when-cross-origin` |
750
-
751
- ### Rate Limiting
752
-
753
- When `SWML_RATE_LIMIT` is set (requests per minute per IP):
754
-
755
- - IP is extracted from `X-Forwarded-For` (first entry), `X-Real-IP`, or falls back to `"unknown"`.
756
- - An in-memory Map tracks `{ count, resetAt }` per IP.
757
- - The window resets every 60 seconds.
758
- - Exceeding the limit returns `429 Too Many Requests`.
759
-
760
- ### Allowed Hosts
761
-
762
- When `SWML_ALLOWED_HOSTS` is set (comma-separated hostnames):
763
-
764
- - The `Host` header is extracted (port stripped, lowercased).
765
- - If the host is not in the allowed set, returns `403 Forbidden`.
766
-
767
- ### Request Size Limits
768
-
769
- When `SWML_MAX_REQUEST_SIZE` is set (bytes, default 1 MB):
770
-
771
- - The `Content-Length` header is checked.
772
- - Requests exceeding the limit return `413 Request Too Large`.
773
-
774
- ---
775
-
776
- ## Extension Points
777
-
778
- The SDK provides multiple mechanisms for customizing agent behavior without modifying the core:
779
-
780
- ### Lifecycle Hooks (Override in Subclass)
781
-
782
- | Hook | Signature | When Called |
783
- |------|-----------|------------|
784
- | `defineTools()` | `protected defineTools(): void` | Called explicitly by the subclass constructor to register tools. |
785
- | `onSummary(summary, rawData)` | `void \| Promise<void>` | When a post-prompt summary is received at `/post_prompt`. |
786
- | `onFunctionCall(name, args, rawData)` | `void \| Promise<void>` | Before each SWAIG function handler executes at `/swaig`. |
787
- | `onSwmlRequest(rawData)` | `void \| Promise<void>` | On every SWML request at `/` before rendering. |
788
- | `onDebugEvent(event)` | `void \| Promise<void>` | When a debug event webhook is received at `/debug_events`. |
789
- | `validateBasicAuth(username, password)` | `boolean \| Promise<boolean>` | Called during auth middleware to add custom validation. |
790
-
791
- ### Dynamic Configuration Callback
792
-
793
- ```typescript
794
- agent.setDynamicConfigCallback(async (queryParams, bodyParams, headers, ephemeralAgent) => {
795
- // Mutate ephemeralAgent -- original agent is unaffected
796
- });
797
- ```
798
-
799
- The callback receives an ephemeral copy created by `createEphemeralCopy()`. This copy has:
800
-
801
- - Fresh `PromptManager` and `SwmlBuilder` instances.
802
- - Shallow copies of all mutable arrays and objects (hints, languages, params, globalData, verbs, toolRegistry).
803
- - The same prototype chain as the original (so subclass methods are available).
804
-
805
- ### Declarative PROMPT_SECTIONS
806
-
807
- ```typescript
808
- static PROMPT_SECTIONS?: {
809
- title: string;
810
- body?: string;
811
- bullets?: string[];
812
- numbered?: boolean;
813
- }[];
814
- ```
815
-
816
- Applied automatically in the `AgentBase` constructor via `promptAddSection()` for each entry.
817
-
818
- ### Skills System
819
-
820
- Skills are modular bundles of tools, prompt sections, hints, and global data:
821
-
822
- ```typescript
823
- await agent.addSkill(new WeatherSkill({ apiKey: '...' }));
824
- ```
825
-
826
- `addSkill()` iterates the skill's contributed tools, prompt sections, hints, and global data, registering each with the agent.
827
-
828
- ### Webhook URL Overrides
829
-
830
- ```typescript
831
- agent.setWebHookUrl('https://custom-swaig-endpoint.example.com/swaig');
832
- agent.setPostPromptUrl('https://custom-endpoint.example.com/post_prompt');
833
- ```
834
-
835
- These override the auto-generated webhook URLs in the rendered SWML document.
836
-
837
- ### Debug Events
838
-
839
- ```typescript
840
- agent.enableDebugEvents(2); // level 1-3
841
- ```
842
-
843
- When enabled, the SWML document includes `debug_webhook_url` and `debug_webhook_level` in the AI configuration. SignalWire posts debug events to `/debug_events`, which calls `onDebugEvent()`.