@signalwire/sdk 2.0.0 → 2.0.2

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 (612) 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/dist/index.d.ts +146 -0
  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 +1019 -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/{src/rest/index.ts → dist/rest/index.d.ts} +53 -122
  149. package/dist/rest/index.js +195 -0
  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/dist/rest/pagination.d.ts +39 -0
  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 -2489
  416. package/src/AgentServer.ts +0 -415
  417. package/src/AuthHandler.ts +0 -256
  418. package/src/ConfigLoader.ts +0 -447
  419. package/src/ContextBuilder.ts +0 -1150
  420. package/src/DataMap.ts +0 -449
  421. package/src/FunctionResult.ts +0 -866
  422. package/src/Logger.ts +0 -337
  423. package/src/PomBuilder.ts +0 -439
  424. package/src/PromptManager.ts +0 -133
  425. package/src/SWMLHandler.ts +0 -298
  426. package/src/SWMLService.ts +0 -717
  427. package/src/SchemaUtils.ts +0 -361
  428. package/src/ServerlessAdapter.ts +0 -221
  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 -258
  433. package/src/SwmlVerbMethods.generated.ts +0 -234
  434. package/src/TypeInference.ts +0 -181
  435. package/src/WebService.ts +0 -619
  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/index.ts +0 -167
  441. package/src/livewire/index.ts +0 -950
  442. package/src/prefabs/ConciergeAgent.ts +0 -287
  443. package/src/prefabs/FAQBotAgent.ts +0 -384
  444. package/src/prefabs/InfoGathererAgent.ts +0 -339
  445. package/src/prefabs/ReceptionistAgent.ts +0 -366
  446. package/src/prefabs/SurveyAgent.ts +0 -646
  447. package/src/relay/Action.ts +0 -314
  448. package/src/relay/Call.ts +0 -854
  449. package/src/relay/Deferred.ts +0 -71
  450. package/src/relay/Message.ts +0 -148
  451. package/src/relay/RelayClient.ts +0 -1036
  452. package/src/relay/RelayError.ts +0 -14
  453. package/src/relay/RelayEvent.ts +0 -892
  454. package/src/relay/index.ts +0 -123
  455. package/src/relay/types.ts +0 -149
  456. package/src/rest/HttpClient.ts +0 -103
  457. package/src/rest/RestError.ts +0 -31
  458. package/src/rest/base/BaseResource.ts +0 -19
  459. package/src/rest/base/CrudResource.ts +0 -51
  460. package/src/rest/base/CrudWithAddresses.ts +0 -26
  461. package/src/rest/namespaces/addresses.ts +0 -32
  462. package/src/rest/namespaces/calling.ts +0 -187
  463. package/src/rest/namespaces/chat.ts +0 -20
  464. package/src/rest/namespaces/compat.ts +0 -352
  465. package/src/rest/namespaces/datasphere.ts +0 -45
  466. package/src/rest/namespaces/fabric.ts +0 -222
  467. package/src/rest/namespaces/imported-numbers.ts +0 -20
  468. package/src/rest/namespaces/logs.ts +0 -84
  469. package/src/rest/namespaces/lookup.ts +0 -21
  470. package/src/rest/namespaces/mfa.ts +0 -30
  471. package/src/rest/namespaces/number-groups.ts +0 -38
  472. package/src/rest/namespaces/phone-numbers.ts +0 -44
  473. package/src/rest/namespaces/project.ts +0 -36
  474. package/src/rest/namespaces/pubsub.ts +0 -20
  475. package/src/rest/namespaces/queues.ts +0 -33
  476. package/src/rest/namespaces/recordings.ts +0 -28
  477. package/src/rest/namespaces/registry.ts +0 -101
  478. package/src/rest/namespaces/short-codes.ts +0 -28
  479. package/src/rest/namespaces/sip-profile.ts +0 -25
  480. package/src/rest/namespaces/verified-callers.ts +0 -27
  481. package/src/rest/namespaces/video.ts +0 -165
  482. package/src/rest/pagination.ts +0 -84
  483. package/src/rest/types.ts +0 -61
  484. package/src/skills/SkillBase.ts +0 -547
  485. package/src/skills/SkillManager.ts +0 -415
  486. package/src/skills/SkillRegistry.ts +0 -367
  487. package/src/skills/builtin/api_ninjas_trivia.ts +0 -280
  488. package/src/skills/builtin/ask_claude.ts +0 -241
  489. package/src/skills/builtin/claude_skills.ts +0 -978
  490. package/src/skills/builtin/custom_skills.ts +0 -312
  491. package/src/skills/builtin/datasphere.ts +0 -438
  492. package/src/skills/builtin/datasphere_serverless.ts +0 -339
  493. package/src/skills/builtin/datetime.ts +0 -130
  494. package/src/skills/builtin/google_maps.ts +0 -651
  495. package/src/skills/builtin/info_gatherer.ts +0 -405
  496. package/src/skills/builtin/joke.ts +0 -191
  497. package/src/skills/builtin/math.ts +0 -142
  498. package/src/skills/builtin/mcp_gateway.ts +0 -677
  499. package/src/skills/builtin/native_vector_search.ts +0 -901
  500. package/src/skills/builtin/play_background_file.ts +0 -358
  501. package/src/skills/builtin/spider.ts +0 -869
  502. package/src/skills/builtin/swml_transfer.ts +0 -635
  503. package/src/skills/builtin/weather_api.ts +0 -248
  504. package/src/skills/builtin/web_search.ts +0 -1074
  505. package/src/skills/builtin/wikipedia_search.ts +0 -299
  506. package/src/types.ts +0 -132
  507. package/tests/AgentBase.test.ts +0 -1093
  508. package/tests/AgentServer.test.ts +0 -126
  509. package/tests/AuthHandler.test.ts +0 -133
  510. package/tests/ConfigLoader.test.ts +0 -151
  511. package/tests/ContextBuilder.test.ts +0 -108
  512. package/tests/DataMap.test.ts +0 -367
  513. package/tests/EphemeralSkillCopy.test.ts +0 -107
  514. package/tests/FunctionResult.test.ts +0 -298
  515. package/tests/GracefulShutdown.test.ts +0 -46
  516. package/tests/Logger.test.ts +0 -420
  517. package/tests/PomBuilder.test.ts +0 -228
  518. package/tests/ProxyDetection.test.ts +0 -228
  519. package/tests/SWMLService.test.ts +0 -320
  520. package/tests/SWMLVerbHandler.test.ts +0 -523
  521. package/tests/SchemaUtils.test.ts +0 -106
  522. package/tests/SchemaUtils.verb.test.ts +0 -206
  523. package/tests/SecurityUtils.test.ts +0 -192
  524. package/tests/ServerlessAdapter.test.ts +0 -222
  525. package/tests/SessionManager.test.ts +0 -257
  526. package/tests/SkillBaseFeatures.test.ts +0 -130
  527. package/tests/SkillMultiInstance.test.ts +0 -102
  528. package/tests/SkillParameterSchemas.test.ts +0 -134
  529. package/tests/SkillRegistrySchema.test.ts +0 -84
  530. package/tests/SslConfig.test.ts +0 -97
  531. package/tests/SwmlBuilder.test.ts +0 -400
  532. package/tests/TypeInference.test.ts +0 -165
  533. package/tests/VerbHandlerRegistry.test.ts +0 -128
  534. package/tests/cli/mock-data.test.ts +0 -113
  535. package/tests/cli/swaig-test.test.ts +0 -108
  536. package/tests/examples.test.ts +0 -194
  537. package/tests/fixtures/scrape-parity/README.md +0 -53
  538. package/tests/fixtures/scrape-parity/expected/01_simple_article.json +0 -5
  539. package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +0 -5
  540. package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +0 -5
  541. package/tests/fixtures/scrape-parity/expected/04_bare_body.json +0 -5
  542. package/tests/fixtures/scrape-parity/expected/05_malformed.json +0 -5
  543. package/tests/fixtures/scrape-parity/expected/06_multi_class.json +0 -5
  544. package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +0 -5
  545. package/tests/fixtures/scrape-parity/expected/08_inline_script.json +0 -5
  546. package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +0 -5
  547. package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +0 -5
  548. package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +0 -5
  549. package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +0 -5
  550. package/tests/fixtures/scrape-parity/html/01_simple_article.html +0 -18
  551. package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +0 -18
  552. package/tests/fixtures/scrape-parity/html/03_nested_containers.html +0 -13
  553. package/tests/fixtures/scrape-parity/html/04_bare_body.html +0 -9
  554. package/tests/fixtures/scrape-parity/html/05_malformed.html +0 -11
  555. package/tests/fixtures/scrape-parity/html/06_multi_class.html +0 -18
  556. package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +0 -12
  557. package/tests/fixtures/scrape-parity/html/08_inline_script.html +0 -17
  558. package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +0 -21
  559. package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +0 -10
  560. package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +0 -13
  561. package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +0 -24
  562. package/tests/fixtures/scrape-parity/python_extract.py +0 -109
  563. package/tests/livewire/livewire.test.ts +0 -780
  564. package/tests/mcp.test.ts +0 -221
  565. package/tests/prefabs/prefabs.test.ts +0 -1093
  566. package/tests/relay/Action.test.ts +0 -392
  567. package/tests/relay/Call.test.ts +0 -535
  568. package/tests/relay/Deferred.test.ts +0 -71
  569. package/tests/relay/Message.test.ts +0 -164
  570. package/tests/relay/RelayClient.test.ts +0 -779
  571. package/tests/relay/RelayEvent.test.ts +0 -463
  572. package/tests/relay/helpers.ts +0 -79
  573. package/tests/rest/HttpClient.test.ts +0 -274
  574. package/tests/rest/RestError.test.ts +0 -53
  575. package/tests/rest/calling.test.ts +0 -156
  576. package/tests/rest/client.test.ts +0 -197
  577. package/tests/rest/compat.test.ts +0 -335
  578. package/tests/rest/datasphere.test.ts +0 -71
  579. package/tests/rest/fabric.test.ts +0 -186
  580. package/tests/rest/helpers.ts +0 -95
  581. package/tests/rest/logs.test.ts +0 -68
  582. package/tests/rest/pagination.test.ts +0 -133
  583. package/tests/rest/registry.test.ts +0 -94
  584. package/tests/rest/relay-rest.test.ts +0 -290
  585. package/tests/rest/video.test.ts +0 -173
  586. package/tests/setup.ts +0 -6
  587. package/tests/skills/SkillBase.test.ts +0 -108
  588. package/tests/skills/SkillManager.test.ts +0 -268
  589. package/tests/skills/SkillRegistry.test.ts +0 -176
  590. package/tests/skills/builtin.test.ts +0 -1472
  591. package/tests/skills/claude-skills.test.ts +0 -54
  592. package/tests/skills/custom-skills.test.ts +0 -53
  593. package/tests/skills/datasphere-serverless.test.ts +0 -70
  594. package/tests/skills/datasphere.test.ts +0 -107
  595. package/tests/skills/datetime.test.ts +0 -101
  596. package/tests/skills/google-maps.test.ts +0 -78
  597. package/tests/skills/info-gatherer.test.ts +0 -411
  598. package/tests/skills/joke.test.ts +0 -81
  599. package/tests/skills/math.test.ts +0 -68
  600. package/tests/skills/mcp-gateway.test.ts +0 -101
  601. package/tests/skills/play-background.test.ts +0 -54
  602. package/tests/skills/spider.test.ts +0 -108
  603. package/tests/skills/swml-transfer.test.ts +0 -178
  604. package/tests/skills/trivia.test.ts +0 -54
  605. package/tests/skills/vector-search.test.ts +0 -135
  606. package/tests/skills/weather-api.test.ts +0 -77
  607. package/tests/skills/web-search-parity.test.ts +0 -59
  608. package/tests/skills/web-search.test.ts +0 -103
  609. package/tests/skills/wikipedia.test.ts +0 -63
  610. package/tsconfig.json +0 -18
  611. package/vitest.config.ts +0 -9
  612. /package/{src → dist}/schema.json +0 -0
@@ -1,415 +0,0 @@
1
- /**
2
- * AgentServer - Hosts multiple AgentBase instances under a single HTTP server.
3
- *
4
- * Each agent is mounted at its own route prefix. The root `/` lists all
5
- * registered agents, and `/health` + `/ready` are global health checks.
6
- */
7
-
8
- import { Hono } from 'hono';
9
- import { cors } from 'hono/cors';
10
- import { readFile, stat } from 'node:fs/promises';
11
- import { join, extname, normalize, resolve } from 'node:path';
12
- import { AgentBase, type RoutingCallback } from './AgentBase.js';
13
- import { getLogger, setGlobalLogLevel } from './Logger.js';
14
-
15
- /** Common MIME types for static file serving. */
16
- const MIME_TYPES: Record<string, string> = {
17
- '.html': 'text/html',
18
- '.htm': 'text/html',
19
- '.css': 'text/css',
20
- '.js': 'application/javascript',
21
- '.mjs': 'application/javascript',
22
- '.json': 'application/json',
23
- '.xml': 'application/xml',
24
- '.txt': 'text/plain',
25
- '.md': 'text/markdown',
26
- '.csv': 'text/csv',
27
- '.png': 'image/png',
28
- '.jpg': 'image/jpeg',
29
- '.jpeg': 'image/jpeg',
30
- '.gif': 'image/gif',
31
- '.svg': 'image/svg+xml',
32
- '.ico': 'image/x-icon',
33
- '.webp': 'image/webp',
34
- '.woff': 'font/woff',
35
- '.woff2': 'font/woff2',
36
- '.ttf': 'font/ttf',
37
- '.otf': 'font/otf',
38
- '.mp3': 'audio/mpeg',
39
- '.wav': 'audio/wav',
40
- '.mp4': 'video/mp4',
41
- '.webm': 'video/webm',
42
- '.pdf': 'application/pdf',
43
- '.zip': 'application/zip',
44
- '.gz': 'application/gzip',
45
- };
46
-
47
- /** Multi-agent HTTP server that hosts multiple AgentBase instances on distinct route prefixes. */
48
- export class AgentServer {
49
- /** Hostname the server binds to. */
50
- host: string;
51
- /** Port the server listens on. */
52
- port: number;
53
- /** Logging level (debug, info, warn, error). */
54
- readonly logLevel: string;
55
- /** Public logger for this server instance. */
56
- readonly log = getLogger('AgentServer');
57
- private agents: Map<string, AgentBase> = new Map();
58
- private _app: Hono;
59
-
60
- // SIP routing state
61
- private _sipRoutingEnabled = false;
62
- private _sipRoute: string | null = null;
63
- private _sipAutoMap = false;
64
- private _sipUsernameMapping: Map<string, string> = new Map();
65
- private _sipRoutingCallback: ((req: Request, body: Record<string, unknown>) => string | undefined) | null = null;
66
-
67
- // Global routing callbacks registered via registerGlobalRoutingCallback
68
- // Stored so they can be applied to agents registered after the call.
69
- private _globalRoutingCallbacks: Array<{ callbackFn: RoutingCallback; path: string }> = [];
70
-
71
- /**
72
- * Create an AgentServer.
73
- * @param opts - Optional host, port, and logLevel overrides; defaults to 0.0.0.0:3000, logLevel 'info'.
74
- */
75
- constructor(opts?: { host?: string; port?: number; logLevel?: string }) {
76
- this.host = opts?.host ?? '0.0.0.0';
77
- this.port = opts?.port ?? parseInt(process.env['PORT'] ?? '3000', 10);
78
- this.logLevel = (opts?.logLevel ?? 'info').toLowerCase();
79
- setGlobalLogLevel(this.logLevel as 'debug' | 'info' | 'warn' | 'error');
80
- this._app = new Hono();
81
-
82
- // Security headers
83
- this._app.use('*', async (c, next) => {
84
- await next();
85
- c.res.headers.set('X-Content-Type-Options', 'nosniff');
86
- c.res.headers.set('X-Frame-Options', 'DENY');
87
- c.res.headers.set('X-XSS-Protection', '1; mode=block');
88
- c.res.headers.set('Referrer-Policy', 'strict-origin-when-cross-origin');
89
- c.res.headers.set('Content-Security-Policy', "default-src 'none'; frame-ancestors 'none'");
90
- c.res.headers.set('Permissions-Policy', 'camera=(), microphone=(), geolocation=()');
91
- });
92
-
93
- // CORS (configurable via env)
94
- const corsOrigins = process.env['SWML_CORS_ORIGINS'];
95
- const corsOrigin = corsOrigins ? corsOrigins.split(',').map((o: string) => o.trim()) : '*';
96
- const corsCredentials = corsOrigin !== '*';
97
- this._app.use('*', cors({ origin: corsOrigin, credentials: corsCredentials }));
98
-
99
- // Global health endpoints
100
- this._app.get('/health', (c) => c.json({ status: 'ok' }));
101
- this._app.get('/ready', (c) => c.json({ status: 'ready' }));
102
- }
103
-
104
- /**
105
- * Register an agent at the given route prefix.
106
- * @param agent - The AgentBase instance to mount.
107
- * @param route - Route prefix; defaults to the agent's own route or '/'.
108
- * @throws If the route is already occupied by another agent.
109
- */
110
- register(agent: AgentBase, route?: string): void {
111
- let r = route ?? (agent as any).route ?? '/';
112
- if (!r.startsWith('/')) r = `/${r}`;
113
- r = r.replace(/\/+$/, '') || '/';
114
-
115
- if (this.agents.has(r)) {
116
- throw new Error(`Route '${r}' is already in use`);
117
- }
118
-
119
- this.agents.set(r, agent);
120
-
121
- // Mount the agent's Hono app at the route prefix
122
- const agentApp = agent.getApp();
123
- if (r === '/') {
124
- this._app.route('/', agentApp);
125
- } else {
126
- this._app.route(r, agentApp);
127
- }
128
-
129
- this.log.info(`Registered '${agent.name}' at ${r}`);
130
-
131
- // If SIP routing is enabled, configure the newly registered agent
132
- if (this._sipRoutingEnabled && this._sipRoute) {
133
- if (this._sipAutoMap) {
134
- this._autoMapAgentSipUsernames(agent, r);
135
- }
136
- agent.enableSipRouting(this._sipAutoMap, this._sipRoute);
137
- }
138
-
139
- // Apply any global routing callbacks registered before this agent was added
140
- for (const { callbackFn, path } of this._globalRoutingCallbacks) {
141
- agent.registerRoutingCallback(callbackFn, path);
142
- }
143
- }
144
-
145
- /**
146
- * Remove an agent registration by route.
147
- * @param route - The route prefix to unregister.
148
- * @returns True if the agent was found and removed, false if not found.
149
- */
150
- unregister(route: string): boolean {
151
- // Note: Hono doesn't support dynamic route removal,
152
- // but the agent won't be listed anymore
153
- return this.agents.delete(route);
154
- }
155
-
156
- /**
157
- * Get all registered agents keyed by their route prefix.
158
- * @returns A map of route prefixes to AgentBase instances.
159
- */
160
- getAgents(): Map<string, AgentBase> {
161
- return this.agents;
162
- }
163
-
164
- /**
165
- * Look up a registered agent by its route prefix.
166
- * @param route - The route prefix to look up.
167
- * @returns The agent at that route, or undefined if none is registered.
168
- */
169
- getAgent(route: string): AgentBase | undefined {
170
- return this.agents.get(route);
171
- }
172
-
173
- /**
174
- * Serve static files from a local directory under a given route prefix.
175
- * Includes path traversal protection (rejects `..`), MIME type detection,
176
- * and security headers (Cache-Control, X-Content-Type-Options).
177
- * @param directory - Absolute or relative path to the directory to serve.
178
- * @param route - Route prefix for static files (defaults to '/').
179
- */
180
- serveStaticFiles(directory: string, route = '/'): void {
181
- const baseDir = resolve(directory);
182
- const routePrefix = route.replace(/\/+$/, '') || '/';
183
-
184
- this._app.get(`${routePrefix}/*`, async (c) => {
185
- const requestedPath = c.req.path.slice(routePrefix.length);
186
-
187
- // Path traversal protection: reject any path containing ".."
188
- if (requestedPath.includes('..')) {
189
- return c.json({ error: 'Forbidden' }, 403);
190
- }
191
-
192
- const normalizedPath = normalize(requestedPath);
193
- // Double-check the resolved path is within the base directory
194
- const fullPath = resolve(join(baseDir, normalizedPath));
195
- if (!fullPath.startsWith(baseDir)) {
196
- return c.json({ error: 'Forbidden' }, 403);
197
- }
198
-
199
- try {
200
- const fileStat = await stat(fullPath);
201
- if (!fileStat.isFile()) {
202
- return c.json({ error: 'Not found' }, 404);
203
- }
204
-
205
- const content = await readFile(fullPath);
206
- const ext = extname(fullPath).toLowerCase();
207
- const contentType = MIME_TYPES[ext] ?? 'application/octet-stream';
208
-
209
- c.header('Content-Type', contentType);
210
- c.header('X-Content-Type-Options', 'nosniff');
211
- c.header('Cache-Control', 'public, max-age=3600');
212
-
213
- return c.body(content);
214
- } catch {
215
- return c.json({ error: 'Not found' }, 404);
216
- }
217
- });
218
-
219
- this.log.info(`Serving static files from ${baseDir} at ${routePrefix}/*`);
220
- }
221
-
222
- /**
223
- * Set up central SIP-based routing for the server.
224
- *
225
- * This configures all agents to handle SIP requests at the specified path,
226
- * using a coordinated routing system where each agent checks if it can
227
- * handle SIP requests for specific usernames.
228
- *
229
- * @param route - The path for SIP routing (default: '/sip').
230
- * @param autoMap - Whether to automatically map SIP usernames to agent routes (default: true).
231
- */
232
- setupSipRouting(route = '/sip', autoMap = true): void {
233
- if (this._sipRoutingEnabled) {
234
- this.log.warn('SIP routing is already enabled');
235
- return;
236
- }
237
-
238
- // Normalize the route
239
- let r = route;
240
- if (!r.startsWith('/')) r = `/${r}`;
241
- r = r.replace(/\/+$/, '') || '/sip';
242
-
243
- this._sipRoutingEnabled = true;
244
- this._sipRoute = r;
245
- this._sipAutoMap = autoMap;
246
-
247
- // Auto-map existing agents
248
- if (autoMap) {
249
- for (const [agentRoute, agent] of this.agents) {
250
- this._autoMapAgentSipUsernames(agent, agentRoute);
251
- }
252
- }
253
-
254
- // Create a unified routing callback
255
- const serverSipRoutingCallback = (_req: Request, body: Record<string, unknown>): string | undefined => {
256
- const sipUsername = AgentBase.extractSipUsername(body);
257
- if (sipUsername) {
258
- this.log.info(`Extracted SIP username: ${sipUsername}`);
259
- const targetRoute = this._sipUsernameMapping.get(sipUsername.toLowerCase());
260
- if (targetRoute) {
261
- this.log.info(`Routing SIP request to ${targetRoute}`);
262
- return targetRoute;
263
- }
264
- this.log.warn(`No route found for SIP username: ${sipUsername}`);
265
- }
266
- return undefined;
267
- };
268
-
269
- this._sipRoutingCallback = serverSipRoutingCallback;
270
-
271
- // Register this callback with each agent via enableSipRouting
272
- for (const agent of this.agents.values()) {
273
- agent.enableSipRouting(autoMap, r);
274
- }
275
-
276
- this.log.info(`SIP routing enabled at ${r} on all agents`);
277
- }
278
-
279
- /**
280
- * Register a mapping from a SIP username to an agent route at the server level.
281
- *
282
- * Allows callers to manually route an arbitrary SIP username to any already-registered
283
- * agent route, independent of the automatic mapping performed by `setupSipRouting`.
284
- *
285
- * @param username - The SIP username to map (stored lowercase).
286
- * @param route - The agent route to map the username to (leading `/` added if missing; trailing slashes stripped).
287
- */
288
- registerSipUsername(username: string, route: string): void {
289
- if (!this._sipRoutingEnabled) {
290
- this.log.warn('SIP routing is not enabled. Call setupSipRouting() first.');
291
- return;
292
- }
293
-
294
- // Normalize route: ensure leading slash, strip trailing slashes
295
- let r = route.startsWith('/') ? route : `/${route}`;
296
- r = r.replace(/\/+$/, '');
297
-
298
- // Warn if the target route has no registered agent
299
- if (!this.agents.has(r)) {
300
- this.log.warn(`Route '${r}' not found. SIP username will be registered but may not work.`);
301
- }
302
-
303
- this._sipUsernameMapping.set(username.toLowerCase(), r);
304
- this.log.info(`Registered SIP username '${username}' to route '${r}'`);
305
- }
306
-
307
- /**
308
- * Register a routing callback across all agents at the given path.
309
- *
310
- * This allows unified routing logic to be applied to all agents from
311
- * a central server-level coordinator.
312
- *
313
- * @param callbackFn - The callback function that receives a request and body, returning a route string or undefined.
314
- * @param path - The path to register the callback at.
315
- */
316
- registerGlobalRoutingCallback(
317
- callbackFn: RoutingCallback,
318
- path: string,
319
- ): void {
320
- // Normalize path: ensure leading slash, strip trailing slash
321
- let p = path;
322
- if (!p.startsWith('/')) p = `/${p}`;
323
- p = p.replace(/\/+$/, '') || '/';
324
-
325
- // Store so agents registered after this call also receive the callback
326
- this._globalRoutingCallbacks.push({ callbackFn, path: p });
327
-
328
- // Register with all currently registered agents
329
- for (const agent of this.agents.values()) {
330
- agent.registerRoutingCallback(callbackFn, p);
331
- }
332
-
333
- this.log.info(`Registered global routing callback at ${p} on all agents`);
334
- }
335
-
336
- /**
337
- * Auto-map SIP usernames for an agent based on name and route.
338
- */
339
- private _autoMapAgentSipUsernames(agent: AgentBase, route: string): void {
340
- const agentName = agent.name.toLowerCase();
341
- const cleanName = agentName.replace(/[^a-z0-9_]/g, '');
342
-
343
- if (cleanName) {
344
- this._sipUsernameMapping.set(cleanName, route);
345
- this.log.info(`Registered SIP username '${cleanName}' to route '${route}'`);
346
- }
347
-
348
- if (route) {
349
- const routePart = route.split('/').pop() ?? '';
350
- const cleanRoute = routePart.replace(/[^a-z0-9_]/g, '');
351
- if (cleanRoute && cleanRoute !== cleanName) {
352
- this._sipUsernameMapping.set(cleanRoute, route);
353
- this.log.info(`Registered SIP username '${cleanRoute}' to route '${route}'`);
354
- }
355
- }
356
- }
357
-
358
- /**
359
- * Build and return the Hono application with all registered agents and a root listing endpoint.
360
- * @returns The fully configured Hono app.
361
- */
362
- getApp(): Hono {
363
- // Add root listing (registered after agents so it doesn't shadow them)
364
- const listing = [...this.agents.entries()].map(([route, agent]) => ({
365
- name: agent.name,
366
- route,
367
- }));
368
-
369
- // We create a response for the root that lists agents
370
- // Only if no agent is mounted at /
371
- if (!this.agents.has('/')) {
372
- this._app.get('/', (c) =>
373
- c.json({
374
- service: 'SignalWire AI Agents',
375
- agents: listing,
376
- }),
377
- );
378
- }
379
-
380
- return this._app;
381
- }
382
-
383
- /**
384
- * Start the HTTP server and begin listening for requests.
385
- *
386
- * This method handles server mode only. For serverless deployments
387
- * (AWS Lambda, Google Cloud Functions, Azure Functions), use
388
- * {@link ServerlessAdapter} instead.
389
- *
390
- * @param host - Override the configured hostname.
391
- * @param port - Override the configured port.
392
- */
393
- async run(host?: string, port?: number): Promise<void> {
394
- // When loaded by the CLI tool, skip server startup — only the agent config is needed.
395
- if (process.env['SWAIG_CLI_MODE'] === 'true') return;
396
-
397
- const { serve } = await import('@hono/node-server');
398
- const h = host ?? this.host;
399
- const p = port ?? this.port;
400
-
401
- const app = this.getApp();
402
-
403
- if (this.agents.size === 0) {
404
- this.log.warn('starting_server_with_no_agents');
405
- }
406
-
407
- this.log.info(`Starting on http://${h}:${p}`);
408
- for (const [route, agent] of this.agents) {
409
- const [user] = agent.getBasicAuthCredentials();
410
- this.log.info(` ${route} -> ${agent.name} (auth: ${user}:****)`);
411
- }
412
-
413
- serve({ fetch: app.fetch, port: p, hostname: h });
414
- }
415
- }
@@ -1,256 +0,0 @@
1
- /**
2
- * AuthHandler - Multi-method authentication handler.
3
- *
4
- * Supports Bearer token, API key, and Basic auth with constant-time comparison.
5
- * Can be used as Hono middleware or standalone validator.
6
- */
7
-
8
- import { timingSafeEqual } from 'node:crypto';
9
- import { getLogger } from './Logger.js';
10
-
11
- const log = getLogger('AuthHandler');
12
-
13
- /** Configuration for one or more authentication methods checked by {@link AuthHandler}. */
14
- export interface AuthConfig {
15
- /** Bearer token matched against the Authorization header. */
16
- bearerToken?: string;
17
- /** API key matched against the X-Api-Key header. */
18
- apiKey?: string;
19
- /** Custom header name for API key lookup (default: 'X-Api-Key'). */
20
- apiKeyHeader?: string;
21
- /** Basic auth credentials as a [username, password] tuple. */
22
- basicAuth?: [string, string];
23
- /** Custom validator function; return true to allow the request. */
24
- customValidator?: (request: { headers: Record<string, string>; method: string; url: string }) => boolean | Promise<boolean>;
25
- /** When explicitly set to false, deny requests if no auth methods are configured. */
26
- allowUnauthenticated?: boolean;
27
- }
28
-
29
- /**
30
- * Constant-time string comparison to prevent timing attacks.
31
- */
32
- function safeCompare(a: string, b: string): boolean {
33
- const maxLen = Math.max(a.length, b.length);
34
- const result = timingSafeEqual(
35
- Buffer.from(a.padEnd(maxLen, '\0')),
36
- Buffer.from(b.padEnd(maxLen, '\0')),
37
- );
38
- return result && a.length === b.length;
39
- }
40
-
41
- /** Multi-method authentication handler with timing-safe credential comparison. */
42
- export class AuthHandler {
43
- /** The authentication configuration for this handler. */
44
- readonly config: AuthConfig;
45
-
46
- /**
47
- * Create a new AuthHandler.
48
- * @param config - Authentication configuration specifying one or more auth methods.
49
- */
50
- constructor(config: AuthConfig) {
51
- this.config = config;
52
- }
53
-
54
- /**
55
- * Validate request headers against configured auth methods (Bearer, API Key, Basic, Custom) in order.
56
- * @param headers - The request headers as a string-keyed record.
57
- * @returns True if any configured method accepts the request, or if no methods are configured.
58
- */
59
- async validate(headers: Record<string, string>): Promise<boolean> {
60
- // 1. Bearer token
61
- if (this.config.bearerToken) {
62
- const authHeader = headers['authorization'] || headers['Authorization'] || '';
63
- if (authHeader.startsWith('Bearer ')) {
64
- const token = authHeader.slice(7);
65
- if (safeCompare(token, this.config.bearerToken)) return true;
66
- }
67
- }
68
-
69
- // 2. API Key
70
- if (this.config.apiKey) {
71
- const headerName = this.config.apiKeyHeader ?? 'X-Api-Key';
72
- const headerLower = headerName.toLowerCase();
73
- const key = headers[headerLower] || headers[headerName] || '';
74
- if (key && safeCompare(key, this.config.apiKey)) return true;
75
- }
76
-
77
- // 3. Basic auth
78
- if (this.config.basicAuth) {
79
- const authHeader = headers['authorization'] || headers['Authorization'] || '';
80
- if (authHeader.startsWith('Basic ')) {
81
- const decoded = Buffer.from(authHeader.slice(6), 'base64').toString();
82
- const colonIdx = decoded.indexOf(':');
83
- if (colonIdx > 0) {
84
- const user = decoded.slice(0, colonIdx);
85
- const pass = decoded.slice(colonIdx + 1);
86
- const [expectedUser, expectedPass] = this.config.basicAuth;
87
- if (safeCompare(user, expectedUser) && safeCompare(pass, expectedPass)) return true;
88
- }
89
- }
90
- }
91
-
92
- // 4. Custom validator
93
- if (this.config.customValidator) {
94
- const result = await this.config.customValidator({
95
- headers,
96
- method: '',
97
- url: '',
98
- });
99
- if (result) return true;
100
- }
101
-
102
- // If no methods configured, check allowUnauthenticated flag
103
- if (!this.config.bearerToken && !this.config.apiKey && !this.config.basicAuth && !this.config.customValidator) {
104
- if (this.config.allowUnauthenticated === false) {
105
- return false;
106
- }
107
- log.warn('No auth methods configured; allowing unauthenticated access. Set allowUnauthenticated to false to deny.');
108
- return true;
109
- }
110
-
111
- return false;
112
- }
113
-
114
- /**
115
- * Verify a Basic Auth username/password pair against the configured credentials.
116
- *
117
- * Returns false immediately if Basic Auth is not configured.
118
- * Uses constant-time comparison to prevent timing attacks.
119
- *
120
- * @param username - The username to verify.
121
- * @param password - The password to verify.
122
- * @returns True if the credentials match the configured Basic Auth credentials.
123
- */
124
- verifyBasicAuth(username: string, password: string): boolean {
125
- if (!this.config.basicAuth) return false;
126
- const [expectedUser, expectedPass] = this.config.basicAuth;
127
- return safeCompare(username, expectedUser) && safeCompare(password, expectedPass);
128
- }
129
-
130
- /**
131
- * Verify a Bearer token against the configured token.
132
- *
133
- * Returns false immediately if Bearer token auth is not configured.
134
- * Uses constant-time comparison to prevent timing attacks.
135
- *
136
- * @param token - The Bearer token string to verify (without the "Bearer " prefix).
137
- * @returns True if the token matches the configured Bearer token.
138
- */
139
- verifyBearerToken(token: string): boolean {
140
- if (!this.config.bearerToken) return false;
141
- return safeCompare(token, this.config.bearerToken);
142
- }
143
-
144
- /**
145
- * Verify an API key against the configured key.
146
- *
147
- * Returns false immediately if API key auth is not configured.
148
- * Uses constant-time comparison to prevent timing attacks.
149
- *
150
- * @param key - The API key string to verify.
151
- * @returns True if the key matches the configured API key.
152
- */
153
- verifyApiKey(key: string): boolean {
154
- if (!this.config.apiKey) return false;
155
- return safeCompare(key, this.config.apiKey);
156
- }
157
-
158
- /**
159
- * Create a Hono-compatible middleware that rejects unauthorized requests with a 401 response.
160
- * @param optional - When true, unauthenticated requests are allowed through instead of being rejected (default: false).
161
- * @returns A middleware function suitable for use with Hono's `app.use()`.
162
- */
163
- middleware(optional = false): (c: any, next: () => Promise<void>) => Promise<Response | void> {
164
- return async (c: any, next: () => Promise<void>) => {
165
- const headers: Record<string, string> = {};
166
- c.req.raw.headers.forEach((v: string, k: string) => { headers[k] = v; });
167
-
168
- const valid = await this.validate(headers);
169
- if (!valid && !optional) {
170
- return c.json({ error: 'Unauthorized' }, 401);
171
- }
172
- await next();
173
- };
174
- }
175
-
176
- /**
177
- * Create an Express/Connect-compatible middleware adapter.
178
- *
179
- * This serves as the framework-agnostic equivalent of Python's
180
- * `get_fastapi_dependency`. For standalone validation without a
181
- * framework, use {@link validate} directly.
182
- *
183
- * @param optional - When true, unauthenticated requests are allowed through (default: false).
184
- * @returns An Express-compatible middleware function.
185
- */
186
- expressMiddleware(optional = false): (req: any, res: any, next: () => void) => Promise<void> {
187
- return async (req: any, res: any, next: () => void) => {
188
- const headers = req.headers as Record<string, string>;
189
- const valid = await this.validate(headers);
190
- if (!valid && !optional) {
191
- res.status(401).json({ error: 'Unauthorized' });
192
- return;
193
- }
194
- next();
195
- };
196
- }
197
-
198
- /**
199
- * Get information about configured authentication methods.
200
- *
201
- * Returns structured metadata describing each enabled auth method,
202
- * including usernames, header names, and usage hints.
203
- *
204
- * @returns An object describing the enabled auth methods and their configuration.
205
- */
206
- getAuthInfo(): {
207
- basic?: { enabled: true; username: string };
208
- bearer?: { enabled: true; hint: string };
209
- apiKey?: { enabled: true; header: string; hint: string };
210
- } {
211
- const info: {
212
- basic?: { enabled: true; username: string };
213
- bearer?: { enabled: true; hint: string };
214
- apiKey?: { enabled: true; header: string; hint: string };
215
- } = {};
216
-
217
- if (this.config.basicAuth) {
218
- info.basic = { enabled: true, username: this.config.basicAuth[0] };
219
- }
220
-
221
- if (this.config.bearerToken) {
222
- info.bearer = { enabled: true, hint: 'Use Authorization: Bearer <token>' };
223
- }
224
-
225
- if (this.config.apiKey) {
226
- const header = this.config.apiKeyHeader ?? 'X-Api-Key';
227
- info.apiKey = { enabled: true, header, hint: `Use ${header}: <key>` };
228
- }
229
-
230
- return info;
231
- }
232
-
233
- /**
234
- * Check whether Bearer token authentication is configured.
235
- * @returns True if a bearer token has been set.
236
- */
237
- hasBearerAuth(): boolean {
238
- return !!this.config.bearerToken;
239
- }
240
-
241
- /**
242
- * Check whether API key authentication is configured.
243
- * @returns True if an API key has been set.
244
- */
245
- hasApiKeyAuth(): boolean {
246
- return !!this.config.apiKey;
247
- }
248
-
249
- /**
250
- * Check whether Basic authentication is configured.
251
- * @returns True if basic auth credentials have been set.
252
- */
253
- hasBasicAuth(): boolean {
254
- return !!this.config.basicAuth;
255
- }
256
- }