@signalwire/sdk 2.0.1 → 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 (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 +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/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,1093 +0,0 @@
1
- import { describe, it, expect } from 'vitest';
2
- import { AgentBase } from '../src/AgentBase.js';
3
- import { FunctionResult } from '../src/FunctionResult.js';
4
- import { ContextBuilder } from '../src/ContextBuilder.js';
5
- import { DataMap } from '../src/DataMap.js';
6
- import { SkillBase, type SkillToolDefinition } from '../src/skills/SkillBase.js';
7
-
8
- describe('AgentBase', () => {
9
- function createAgent(opts?: Partial<Parameters<typeof AgentBase.prototype.setPromptText>[0]>) {
10
- return new AgentBase({ name: 'test-agent', route: '/test', ...opts } as any);
11
- }
12
-
13
- it('renders basic SWML with prompt', () => {
14
- const agent = createAgent();
15
- agent.setPromptText('You are a helpful assistant');
16
- const swml = JSON.parse(agent.renderSwml());
17
- expect(swml.version).toBe('1.0.0');
18
- const main = swml.sections.main;
19
- // Should have answer + ai verbs
20
- expect(main.length).toBe(2);
21
- expect(main[0]).toHaveProperty('answer');
22
- expect(main[1]).toHaveProperty('ai');
23
- expect(main[1].ai.prompt.text).toBe('You are a helpful assistant');
24
- });
25
-
26
- it('renders SWML without auto-answer', () => {
27
- const agent = new AgentBase({ name: 'test', route: '/test', autoAnswer: false });
28
- agent.setPromptText('hello');
29
- const swml = JSON.parse(agent.renderSwml());
30
- const main = swml.sections.main;
31
- // Should only have AI verb, no answer
32
- expect(main.length).toBe(1);
33
- expect(main[0]).toHaveProperty('ai');
34
- });
35
-
36
- it('renders SWML with recording enabled', () => {
37
- const agent = new AgentBase({ name: 'test', route: '/test', recordCall: true });
38
- agent.setPromptText('hello');
39
- const swml = JSON.parse(agent.renderSwml());
40
- const main = swml.sections.main;
41
- // answer + record_call + ai
42
- expect(main.length).toBe(3);
43
- expect(main[1]).toHaveProperty('record_call');
44
- expect(main[1].record_call.format).toBe('mp4');
45
- });
46
-
47
- it('includes tools in SWAIG', () => {
48
- const agent = createAgent();
49
- agent.setPromptText('hello');
50
- agent.defineTool({
51
- name: 'get_time',
52
- description: 'Get the current time',
53
- parameters: {},
54
- handler: () => new FunctionResult('The time is 12:00'),
55
- });
56
- const swml = JSON.parse(agent.renderSwml());
57
- const ai = swml.sections.main[1].ai;
58
- expect(ai.SWAIG).toBeDefined();
59
- expect(ai.SWAIG.functions.length).toBe(1);
60
- expect(ai.SWAIG.functions[0].function).toBe('get_time');
61
- expect(ai.SWAIG.defaults).toBeDefined();
62
- expect(ai.SWAIG.defaults.web_hook_url).toContain('/swaig');
63
- });
64
-
65
- it('includes DataMap tools in SWAIG', () => {
66
- const agent = createAgent();
67
- agent.setPromptText('hello');
68
- const dm = new DataMap('get_weather')
69
- .purpose('Get weather')
70
- .parameter('location', 'string', 'City', { required: true })
71
- .webhook('GET', 'https://api.weather.com?q=${location}')
72
- .output(new FunctionResult('Temp: ${response.temp}'));
73
-
74
- agent.registerSwaigFunction(dm.toSwaigFunction());
75
- const swml = JSON.parse(agent.renderSwml());
76
- const fns = swml.sections.main[1].ai.SWAIG.functions;
77
- expect(fns.length).toBe(1);
78
- expect(fns[0].function).toBe('get_weather');
79
- expect(fns[0].data_map).toBeDefined();
80
- });
81
-
82
- it('sets post prompt', () => {
83
- const agent = createAgent();
84
- agent.setPromptText('hello');
85
- agent.setPostPrompt('Summarize the call');
86
- const swml = JSON.parse(agent.renderSwml());
87
- const ai = swml.sections.main[1].ai;
88
- expect(ai.post_prompt.text).toBe('Summarize the call');
89
- expect(ai.post_prompt_url).toBeDefined();
90
- });
91
-
92
- it('adds hints, languages, pronunciation', () => {
93
- const agent = createAgent();
94
- agent.setPromptText('hello');
95
- agent.addHints(['Cabby', 'SignalWire']);
96
- agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
97
- agent.addPronunciation({ replace: 'SW', with: 'SignalWire' });
98
- const swml = JSON.parse(agent.renderSwml());
99
- const ai = swml.sections.main[1].ai;
100
- expect(ai.hints).toEqual(['Cabby', 'SignalWire']);
101
- expect(ai.languages.length).toBe(1);
102
- expect(ai.pronounce.length).toBe(1);
103
- });
104
-
105
- it('sets params and global data', () => {
106
- const agent = createAgent();
107
- agent.setPromptText('hello');
108
- agent.setParam('temperature', 0.5);
109
- agent.setGlobalData({ name: 'John' });
110
- const swml = JSON.parse(agent.renderSwml());
111
- const ai = swml.sections.main[1].ai;
112
- expect(ai.params.temperature).toBe(0.5);
113
- expect(ai.global_data.name).toBe('John');
114
- });
115
-
116
- it('setPromptLlmParams merges into prompt', () => {
117
- const agent = createAgent();
118
- agent.setPromptText('hello');
119
- agent.setPromptLlmParams({ temperature: 0.3, top_p: 0.9 });
120
- const swml = JSON.parse(agent.renderSwml());
121
- const prompt = swml.sections.main[1].ai.prompt;
122
- expect(prompt.temperature).toBe(0.3);
123
- expect(prompt.top_p).toBe(0.9);
124
- expect(prompt.text).toBe('hello');
125
- });
126
-
127
- it('pre-answer, post-answer, post-ai verbs', () => {
128
- const agent = createAgent();
129
- agent.setPromptText('hello');
130
- agent.addPreAnswerVerb('play', { urls: ['ring:us'], auto_answer: false });
131
- agent.addPostAnswerVerb('play', { url: 'say:Welcome!' });
132
- agent.addPostAiVerb('hangup', {});
133
- const swml = JSON.parse(agent.renderSwml());
134
- const main = swml.sections.main;
135
- // pre-answer play + answer + post-answer play + ai + post-ai hangup
136
- expect(main.length).toBe(5);
137
- expect(main[0]).toHaveProperty('play');
138
- expect(main[1]).toHaveProperty('answer');
139
- expect(main[2]).toHaveProperty('play');
140
- expect(main[3]).toHaveProperty('ai');
141
- expect(main[4]).toHaveProperty('hangup');
142
- });
143
-
144
- it('native functions included in SWAIG', () => {
145
- const agent = new AgentBase({ name: 'test', route: '/test', nativeFunctions: ['check_time'] });
146
- agent.setPromptText('hello');
147
- agent.defineTool({
148
- name: 'fn',
149
- description: 'd',
150
- parameters: {},
151
- handler: () => new FunctionResult('ok'),
152
- });
153
- const swml = JSON.parse(agent.renderSwml());
154
- expect(swml.sections.main[1].ai.SWAIG.native_functions).toEqual(['check_time']);
155
- });
156
-
157
- it('function includes', () => {
158
- const agent = createAgent();
159
- agent.setPromptText('hello');
160
- agent.addFunctionInclude('https://example.com/fns', ['fn1']);
161
- agent.defineTool({
162
- name: 'fn',
163
- description: 'd',
164
- parameters: {},
165
- handler: () => new FunctionResult('ok'),
166
- });
167
- const swml = JSON.parse(agent.renderSwml());
168
- expect(swml.sections.main[1].ai.SWAIG.includes).toHaveLength(1);
169
- });
170
-
171
- it('contexts system', () => {
172
- const agent = createAgent();
173
- agent.setPromptText('You are a quiz master');
174
- const ctx = agent.defineContexts();
175
- const def = ctx.addContext('default');
176
- def.addStep('greeting', { task: 'Greet the user' })
177
- .setStepCriteria('User has been greeted')
178
- .setValidSteps(['quiz']);
179
- def.addStep('quiz', { task: 'Ask a quiz question' });
180
- const swml = JSON.parse(agent.renderSwml());
181
- const ai = swml.sections.main[1].ai;
182
- expect(ai.contexts).toBeDefined();
183
- expect(ai.contexts.default.steps.length).toBe(2);
184
- });
185
-
186
- it('getFullUrl returns correct URL', () => {
187
- const agent = new AgentBase({ name: 'test', route: '/myagent', port: 5000 });
188
- const url = agent.getFullUrl();
189
- expect(url).toContain('localhost:5000/myagent');
190
- });
191
-
192
- it('getFullUrl with auth', () => {
193
- const agent = new AgentBase({ name: 'test', route: '/test', basicAuth: ['user', 'pass'] });
194
- const url = agent.getFullUrl(true);
195
- expect(url).toContain('user:pass@');
196
- });
197
-
198
- it('getBasicAuthCredentials', () => {
199
- const agent = new AgentBase({ name: 'test', route: '/test', basicAuth: ['u', 'p'] });
200
- expect(agent.getBasicAuthCredentials()).toEqual(['u', 'p']);
201
- });
202
-
203
- it('promptAddSection builds POM prompt', () => {
204
- const agent = createAgent();
205
- agent.promptAddSection('Role', { body: 'You are a helper' });
206
- agent.promptAddSection('Rules', { bullets: ['Be nice'] });
207
- const prompt = agent.getPrompt();
208
- expect(prompt).toContain('Role');
209
- expect(prompt).toContain('You are a helper');
210
- expect(prompt).toContain('- Be nice');
211
- });
212
-
213
- it('renders multiple calls independently', () => {
214
- const agent = createAgent();
215
- agent.setPromptText('hello');
216
- const swml1 = agent.renderSwml();
217
- const swml2 = agent.renderSwml();
218
- // Both should be valid JSON
219
- expect(JSON.parse(swml1).version).toBe('1.0.0');
220
- expect(JSON.parse(swml2).version).toBe('1.0.0');
221
- });
222
-
223
- // ── Auth source tracking ────────────────────────────────────────────
224
-
225
- it('getBasicAuthCredentials returns source=provided when given explicitly', () => {
226
- const agent = new AgentBase({ name: 'test', route: '/test', basicAuth: ['u', 'p'] });
227
- const [user, pass, source] = agent.getBasicAuthCredentials(true);
228
- expect(user).toBe('u');
229
- expect(pass).toBe('p');
230
- expect(source).toBe('provided');
231
- });
232
-
233
- it('getBasicAuthCredentials returns source=generated when auto-generated', () => {
234
- const savedUser = process.env['SWML_BASIC_AUTH_USER'];
235
- const savedPass = process.env['SWML_BASIC_AUTH_PASSWORD'];
236
- delete process.env['SWML_BASIC_AUTH_USER'];
237
- delete process.env['SWML_BASIC_AUTH_PASSWORD'];
238
- try {
239
- const agent = new AgentBase({ name: 'test', route: '/test' });
240
- const [user, , source] = agent.getBasicAuthCredentials(true);
241
- expect(user).toBe('test');
242
- expect(source).toBe('auto-generated');
243
- } finally {
244
- if (savedUser) process.env['SWML_BASIC_AUTH_USER'] = savedUser;
245
- if (savedPass) process.env['SWML_BASIC_AUTH_PASSWORD'] = savedPass;
246
- }
247
- });
248
-
249
- it('getBasicAuthCredentials without source returns tuple of 2', () => {
250
- const agent = new AgentBase({ name: 'test', route: '/test', basicAuth: ['u', 'p'] });
251
- const result = agent.getBasicAuthCredentials();
252
- expect(result).toHaveLength(2);
253
- expect(result).toEqual(['u', 'p']);
254
- });
255
-
256
- // ── Security headers ───────────────────────────────────────────────
257
-
258
- it('includes security headers in responses', async () => {
259
- const agent = new AgentBase({ name: 'test', route: '/', basicAuth: ['u', 'p'] });
260
- agent.setPromptText('hello');
261
- const app = agent.getApp();
262
- const res = await app.request('/health');
263
- expect(res.headers.get('X-Content-Type-Options')).toBe('nosniff');
264
- expect(res.headers.get('X-Frame-Options')).toBe('DENY');
265
- expect(res.headers.get('X-XSS-Protection')).toBe('1; mode=block');
266
- expect(res.headers.get('Referrer-Policy')).toBe('strict-origin-when-cross-origin');
267
- });
268
-
269
- // ── CORS ──────────────────────────────────────────────────────────
270
-
271
- it('responds to CORS preflight', async () => {
272
- const agent = new AgentBase({ name: 'test', route: '/', basicAuth: ['u', 'p'] });
273
- const app = agent.getApp();
274
- const res = await app.request('/health', {
275
- method: 'OPTIONS',
276
- headers: {
277
- 'Origin': 'https://example.com',
278
- 'Access-Control-Request-Method': 'POST',
279
- },
280
- });
281
- expect(res.headers.get('Access-Control-Allow-Origin')).toBe('*');
282
- });
283
-
284
- // ── Debug events ──────────────────────────────────────────────────
285
-
286
- it('enableDebugEvents injects debug_webhook_url in SWML', () => {
287
- const agent = createAgent();
288
- agent.setPromptText('hello');
289
- agent.enableDebugEvents(2);
290
- const swml = JSON.parse(agent.renderSwml());
291
- const ai = swml.sections.main[1].ai;
292
- expect(ai.debug_webhook_url).toBeDefined();
293
- expect(ai.debug_webhook_url).toContain('/debug_events');
294
- expect(ai.debug_webhook_level).toBe(2);
295
- });
296
-
297
- it('debug events endpoint responds to POST', async () => {
298
- const agent = new AgentBase({ name: 'test', route: '/', basicAuth: ['u', 'p'] });
299
- agent.enableDebugEvents();
300
- const app = agent.getApp();
301
- const res = await app.request('/debug_events', {
302
- method: 'POST',
303
- headers: {
304
- 'Authorization': 'Basic ' + btoa('u:p'),
305
- 'Content-Type': 'application/json',
306
- },
307
- body: JSON.stringify({ event: 'test' }),
308
- });
309
- expect(res.status).toBe(200);
310
- const body = await res.json();
311
- expect(body.ok).toBe(true);
312
- });
313
-
314
- it('no debug_webhook_url when debug events not enabled', () => {
315
- const agent = createAgent();
316
- agent.setPromptText('hello');
317
- const swml = JSON.parse(agent.renderSwml());
318
- const ai = swml.sections.main[1].ai;
319
- expect(ai.debug_webhook_url).toBeUndefined();
320
- expect(ai.debug_webhook_level).toBeUndefined();
321
- });
322
-
323
- // ── Tool introspection ──────────────────────────────────────────────
324
-
325
- it('getRegisteredTools lists all tools', () => {
326
- const agent = createAgent();
327
- agent.defineTool({
328
- name: 'fn1',
329
- description: 'Function 1',
330
- parameters: { x: { type: 'string' } },
331
- handler: () => new FunctionResult('ok'),
332
- });
333
- agent.defineTool({
334
- name: 'fn2',
335
- description: 'Function 2',
336
- parameters: {},
337
- handler: () => new FunctionResult('ok'),
338
- });
339
- const tools = agent.getRegisteredTools();
340
- expect(tools).toHaveLength(2);
341
- expect(tools[0].name).toBe('fn1');
342
- expect(tools[1].name).toBe('fn2');
343
- });
344
-
345
- it('getTool returns a SwaigFunction', () => {
346
- const agent = createAgent();
347
- agent.defineTool({
348
- name: 'my_fn',
349
- description: 'My function',
350
- parameters: {},
351
- handler: () => new FunctionResult('ok'),
352
- });
353
- const tool = agent.getTool('my_fn');
354
- expect(tool).toBeDefined();
355
- expect(tool!.name).toBe('my_fn');
356
- });
357
-
358
- it('getTool returns undefined for missing tool', () => {
359
- const agent = createAgent();
360
- expect(agent.getTool('nope')).toBeUndefined();
361
- });
362
-
363
- // ── Pass 1: Agent Enhancements ────────────────────────────────────
364
-
365
- it('getName returns the agent name', () => {
366
- const agent = new AgentBase({ name: 'my-agent', route: '/test' });
367
- expect(agent.getName()).toBe('my-agent');
368
- });
369
-
370
- it('agentId defaults to random hex', () => {
371
- const agent = createAgent();
372
- expect(agent.agentId).toBeDefined();
373
- expect(typeof agent.agentId).toBe('string');
374
- expect(agent.agentId.length).toBe(16); // 8 bytes hex
375
- });
376
-
377
- it('agentId can be provided via options', () => {
378
- const agent = new AgentBase({ name: 'test', route: '/test', agentId: 'custom-id-123' } as any);
379
- expect(agent.agentId).toBe('custom-id-123');
380
- });
381
-
382
- it('clearPreAnswerVerbs removes pre-answer verbs', () => {
383
- const agent = createAgent();
384
- agent.setPromptText('hello');
385
- agent.addPreAnswerVerb('play', { url: 'ring:us' });
386
- agent.addPreAnswerVerb('play', { url: 'ring:uk' });
387
- agent.clearPreAnswerVerbs();
388
- const swml = JSON.parse(agent.renderSwml());
389
- const main = swml.sections.main;
390
- // Should only have answer + ai, no pre-answer verbs
391
- expect(main.length).toBe(2);
392
- expect(main[0]).toHaveProperty('answer');
393
- });
394
-
395
- it('clearPostAnswerVerbs removes post-answer verbs', () => {
396
- const agent = createAgent();
397
- agent.setPromptText('hello');
398
- agent.addPostAnswerVerb('play', { url: 'say:Welcome' });
399
- agent.clearPostAnswerVerbs();
400
- const swml = JSON.parse(agent.renderSwml());
401
- const main = swml.sections.main;
402
- expect(main.length).toBe(2);
403
- });
404
-
405
- it('clearPostAiVerbs removes post-ai verbs', () => {
406
- const agent = createAgent();
407
- agent.setPromptText('hello');
408
- agent.addPostAiVerb('hangup', {});
409
- agent.clearPostAiVerbs();
410
- const swml = JSON.parse(agent.renderSwml());
411
- const main = swml.sections.main;
412
- expect(main.length).toBe(2);
413
- });
414
-
415
- it('clear*Verbs methods return this for chaining', () => {
416
- const agent = createAgent();
417
- const result = agent.clearPreAnswerVerbs().clearPostAnswerVerbs().clearPostAiVerbs();
418
- expect(result).toBe(agent);
419
- });
420
-
421
- it('suppressLogs option suppresses log output', async () => {
422
- // We test that no error is thrown; the actual suppression is tested in Logger tests
423
- const { suppressAllLogs: suppress } = await import('../src/Logger.js');
424
- suppress(false); // reset
425
- const agent = new AgentBase({ name: 'test', route: '/test', suppressLogs: true } as any);
426
- expect(agent).toBeDefined();
427
- suppress(false); // cleanup
428
- });
429
-
430
- // ── Security env vars ─────────────────────────────────────────────
431
-
432
- it('request size limit returns 413 for oversized requests', async () => {
433
- const saved = process.env['SWML_MAX_REQUEST_SIZE'];
434
- process.env['SWML_MAX_REQUEST_SIZE'] = '50'; // 50 bytes
435
- try {
436
- const agent = new AgentBase({ name: 'test', route: '/', basicAuth: ['u', 'p'] });
437
- agent.setPromptText('hello');
438
- const app = agent.getApp();
439
- const res = await app.request('/', {
440
- method: 'POST',
441
- headers: {
442
- 'Authorization': 'Basic ' + btoa('u:p'),
443
- 'Content-Type': 'application/json',
444
- 'Content-Length': '100000',
445
- },
446
- body: JSON.stringify({ data: 'x'.repeat(100000) }),
447
- });
448
- expect(res.status).toBe(413);
449
- } finally {
450
- if (saved) process.env['SWML_MAX_REQUEST_SIZE'] = saved;
451
- else delete process.env['SWML_MAX_REQUEST_SIZE'];
452
- }
453
- });
454
-
455
- it('SWML_ALLOWED_HOSTS blocks disallowed hosts', async () => {
456
- const saved = process.env['SWML_ALLOWED_HOSTS'];
457
- process.env['SWML_ALLOWED_HOSTS'] = 'allowed.example.com, other.test';
458
- try {
459
- const agent = new AgentBase({ name: 'test', route: '/', basicAuth: ['u', 'p'] });
460
- agent.setPromptText('hello');
461
- const app = agent.getApp();
462
-
463
- // Disallowed host
464
- const res = await app.request('http://evil.example.com/', {
465
- method: 'POST',
466
- headers: {
467
- 'Authorization': 'Basic ' + btoa('u:p'),
468
- 'Content-Type': 'application/json',
469
- 'Host': 'evil.example.com',
470
- },
471
- body: '{}',
472
- });
473
- expect(res.status).toBe(403);
474
- const body = await res.json();
475
- expect(body.error).toContain('host not allowed');
476
- } finally {
477
- if (saved) process.env['SWML_ALLOWED_HOSTS'] = saved;
478
- else delete process.env['SWML_ALLOWED_HOSTS'];
479
- }
480
- });
481
-
482
- it('SWML_ALLOWED_HOSTS allows matching hosts', async () => {
483
- const saved = process.env['SWML_ALLOWED_HOSTS'];
484
- process.env['SWML_ALLOWED_HOSTS'] = 'allowed.example.com, other.test';
485
- try {
486
- const agent = new AgentBase({ name: 'test', route: '/', basicAuth: ['u', 'p'] });
487
- agent.setPromptText('hello');
488
- const app = agent.getApp();
489
-
490
- // Allowed host
491
- const res = await app.request('http://allowed.example.com/', {
492
- method: 'POST',
493
- headers: {
494
- 'Authorization': 'Basic ' + btoa('u:p'),
495
- 'Content-Type': 'application/json',
496
- 'Host': 'allowed.example.com',
497
- },
498
- body: '{}',
499
- });
500
- expect(res.status).toBe(200);
501
- } finally {
502
- if (saved) process.env['SWML_ALLOWED_HOSTS'] = saved;
503
- else delete process.env['SWML_ALLOWED_HOSTS'];
504
- }
505
- });
506
-
507
- it('SWML_RATE_LIMIT returns 429 when exceeded', async () => {
508
- const saved = process.env['SWML_RATE_LIMIT'];
509
- process.env['SWML_RATE_LIMIT'] = '2'; // 2 requests per minute
510
- try {
511
- const agent = new AgentBase({ name: 'test', route: '/', basicAuth: ['u', 'p'] });
512
- agent.setPromptText('hello');
513
- const app = agent.getApp();
514
-
515
- const makeReq = () => app.request('/', {
516
- method: 'POST',
517
- headers: {
518
- 'Authorization': 'Basic ' + btoa('u:p'),
519
- 'Content-Type': 'application/json',
520
- 'X-Forwarded-For': '1.2.3.4',
521
- },
522
- body: '{}',
523
- });
524
-
525
- // First two should succeed
526
- const r1 = await makeReq();
527
- expect(r1.status).toBe(200);
528
- const r2 = await makeReq();
529
- expect(r2.status).toBe(200);
530
-
531
- // Third should be rate limited
532
- const r3 = await makeReq();
533
- expect(r3.status).toBe(429);
534
- const body = await r3.json();
535
- expect(body.error).toContain('Rate limit');
536
- } finally {
537
- if (saved) process.env['SWML_RATE_LIMIT'] = saved;
538
- else delete process.env['SWML_RATE_LIMIT'];
539
- }
540
- });
541
-
542
- // ── Pass 4: Tool lifecycle + defineTools + onFunctionCall ───────
543
-
544
- it('defineTools is not called automatically — subclass calls it explicitly', () => {
545
- let defineToolsCalled = false;
546
- class MyAgent extends AgentBase {
547
- constructor(opts: Parameters<typeof AgentBase.prototype.constructor>[0]) {
548
- super(opts as any);
549
- this.defineTools();
550
- }
551
- protected override defineTools(): void {
552
- defineToolsCalled = true;
553
- this.defineTool({
554
- name: 'auto_tool',
555
- description: 'Auto-registered tool',
556
- parameters: {},
557
- handler: () => new FunctionResult('auto'),
558
- });
559
- }
560
- }
561
- const agent = new MyAgent({ name: 'test', route: '/test' });
562
- expect(defineToolsCalled).toBe(true);
563
- expect(agent.getTool('auto_tool')).toBeDefined();
564
- });
565
-
566
- it('PROMPT_SECTIONS static property applies prompt sections', () => {
567
- class PromptAgent extends AgentBase {
568
- static PROMPT_SECTIONS = [
569
- { title: 'Role', body: 'You are a test agent' },
570
- { title: 'Rules', bullets: ['Be helpful', 'Be concise'] },
571
- ];
572
- }
573
- const agent = new PromptAgent({ name: 'test', route: '/test' });
574
- const prompt = agent.getPrompt();
575
- expect(prompt).toContain('Role');
576
- expect(prompt).toContain('You are a test agent');
577
- expect(prompt).toContain('Be helpful');
578
- });
579
-
580
- it('onFunctionCall hook is invoked when SWAIG function called', async () => {
581
- const calls: string[] = [];
582
- class HookAgent extends AgentBase {
583
- onFunctionCall(name: string, _args: Record<string, unknown>, _rawData: Record<string, unknown>): void {
584
- calls.push(name);
585
- }
586
- }
587
- const agent = new HookAgent({ name: 'test', route: '/', basicAuth: ['u', 'p'] });
588
- agent.defineTool({
589
- name: 'test_fn',
590
- description: 'Test',
591
- parameters: {},
592
- handler: () => new FunctionResult('ok'),
593
- });
594
- const app = agent.getApp();
595
- const res = await app.request('/swaig', {
596
- method: 'POST',
597
- headers: {
598
- 'Authorization': 'Basic ' + btoa('u:p'),
599
- 'Content-Type': 'application/json',
600
- },
601
- body: JSON.stringify({ function: 'test_fn', argument: {} }),
602
- });
603
- expect(res.status).toBe(200);
604
- expect(calls).toContain('test_fn');
605
- });
606
-
607
- it('validateBasicAuth hook default returns true', () => {
608
- const agent = createAgent();
609
- expect(agent.validateBasicAuth('any', 'pass')).toBe(true);
610
- });
611
-
612
- it('CORS origin defaults to *', async () => {
613
- const saved = process.env['SWML_CORS_ORIGINS'];
614
- delete process.env['SWML_CORS_ORIGINS'];
615
- try {
616
- const agent = new AgentBase({ name: 'test', route: '/', basicAuth: ['u', 'p'] });
617
- const app = agent.getApp();
618
- const res = await app.request('/health', {
619
- method: 'OPTIONS',
620
- headers: {
621
- 'Origin': 'https://example.com',
622
- 'Access-Control-Request-Method': 'POST',
623
- },
624
- });
625
- expect(res.headers.get('Access-Control-Allow-Origin')).toBe('*');
626
- } finally {
627
- if (saved) process.env['SWML_CORS_ORIGINS'] = saved;
628
- }
629
- });
630
-
631
- // ── Pass 5: Skills integration ──────────────────────────────────
632
-
633
- it('addSkill registers skill tools and prompt sections', async () => {
634
- class TestSkill extends SkillBase {
635
- static override SKILL_NAME = 'test_skill';
636
- static override SKILL_DESCRIPTION = 'Test';
637
- getTools(): SkillToolDefinition[] {
638
- return [{
639
- name: 'skill_tool',
640
- description: 'Skill tool',
641
- handler: () => new FunctionResult('skill result'),
642
- }];
643
- }
644
- getPromptSections() { return [{ title: 'Skill Info', body: 'From test skill' }]; }
645
- getHints() { return ['skill hint']; }
646
- }
647
-
648
- const agent = createAgent();
649
- agent.setPromptText('base prompt');
650
- await agent.addSkill(new TestSkill());
651
-
652
- expect(agent.getTool('skill_tool')).toBeDefined();
653
- expect(agent.hasSkill('test_skill')).toBe(true);
654
- expect(agent.listSkills()).toHaveLength(1);
655
- });
656
-
657
- it('removeSkill removes a skill', async () => {
658
- class RemoveSkill extends SkillBase {
659
- static override SKILL_NAME = 'removable';
660
- static override SKILL_DESCRIPTION = 'Test';
661
- getTools(): SkillToolDefinition[] { return []; }
662
- }
663
-
664
- const agent = createAgent();
665
- const skill = new RemoveSkill();
666
- await agent.addSkill(skill);
667
- expect(agent.hasSkill('removable')).toBe(true);
668
- await agent.removeSkill(skill.instanceId);
669
- expect(agent.hasSkill('removable')).toBe(false);
670
- });
671
-
672
- it('addSkill returns this for chaining', async () => {
673
- class ChainSkill extends SkillBase {
674
- static override SKILL_NAME = 'chain';
675
- static override SKILL_DESCRIPTION = 'Test';
676
- getTools(): SkillToolDefinition[] { return []; }
677
- }
678
-
679
- const agent = createAgent();
680
- const result = await agent.addSkill(new ChainSkill());
681
- expect(result).toBe(agent);
682
- });
683
-
684
- it('listSkills returns empty when no skills', () => {
685
- const agent = createAgent();
686
- expect(agent.listSkills()).toHaveLength(0);
687
- });
688
-
689
- it('hasSkill returns false when no skills', () => {
690
- const agent = createAgent();
691
- expect(agent.hasSkill('nope')).toBe(false);
692
- });
693
-
694
- // ── Security remediation tests ─────────────────────────────────────
695
-
696
- it('setParams with __proto__ key does NOT pollute Object prototype', () => {
697
- const agent = createAgent();
698
- agent.setParams({ __proto__: { polluted: true }, temperature: 0.7 });
699
- expect(({} as any).polluted).toBeUndefined();
700
- // Normal key should still work
701
- const swml = JSON.parse(agent.renderSwml());
702
- // params are in AI config
703
- const ai = swml.sections.main.find((v: any) => v.ai)?.ai;
704
- expect(ai?.params?.temperature).toBe(0.7);
705
- });
706
-
707
- it('CORS wildcard sets credentials: false', async () => {
708
- const saved = process.env['SWML_CORS_ORIGINS'];
709
- delete process.env['SWML_CORS_ORIGINS'];
710
- try {
711
- const agent = new AgentBase({ name: 'test', route: '/', basicAuth: ['u', 'p'] });
712
- const app = agent.getApp();
713
- const res = await app.request('/health', {
714
- method: 'GET',
715
- headers: { 'Origin': 'https://example.com' },
716
- });
717
- // When origin is *, credentials should not be included
718
- const credHeader = res.headers.get('Access-Control-Allow-Credentials');
719
- expect(credHeader).toBeNull();
720
- } finally {
721
- if (saved) process.env['SWML_CORS_ORIGINS'] = saved;
722
- }
723
- });
724
-
725
- it('invalid port throws', () => {
726
- expect(() => new AgentBase({ name: 'test', route: '/', port: 0 })).toThrow('Invalid port');
727
- expect(() => new AgentBase({ name: 'test', route: '/', port: 99999 })).toThrow('Invalid port');
728
- expect(() => new AgentBase({ name: 'test', route: '/', port: NaN })).toThrow('Invalid port');
729
- });
730
-
731
- it('NaN content-length returns 413', async () => {
732
- const agent = new AgentBase({ name: 'test', route: '/', basicAuth: ['u', 'p'] });
733
- agent.setPromptText('hello');
734
- const app = agent.getApp();
735
- const res = await app.request('/', {
736
- method: 'POST',
737
- headers: {
738
- 'Authorization': 'Basic ' + btoa('u:p'),
739
- 'Content-Type': 'application/json',
740
- 'Content-Length': 'not-a-number',
741
- },
742
- body: '{}',
743
- });
744
- expect(res.status).toBe(413);
745
- });
746
-
747
- it('SWAIG handler error returns friendly message without internal details', async () => {
748
- const agent = new AgentBase({ name: 'test', route: '/', basicAuth: ['u', 'p'] });
749
- agent.defineTool({
750
- name: 'crash_fn',
751
- description: 'Will crash',
752
- parameters: {},
753
- handler: () => { throw new Error('secret internal error details'); },
754
- });
755
- const app = agent.getApp();
756
- const res = await app.request('/swaig', {
757
- method: 'POST',
758
- headers: {
759
- 'Authorization': 'Basic ' + btoa('u:p'),
760
- 'Content-Type': 'application/json',
761
- },
762
- body: JSON.stringify({ function: 'crash_fn', argument: {} }),
763
- });
764
- expect(res.status).toBe(200);
765
- const body = await res.json();
766
- // SwaigFunction.execute catches errors and returns a friendly message
767
- expect(JSON.stringify(body)).not.toContain('secret internal error details');
768
- expect(body.response).toContain('try again');
769
- });
770
-
771
- it('CSP and Permissions-Policy headers are present', async () => {
772
- const agent = new AgentBase({ name: 'test', route: '/', basicAuth: ['u', 'p'] });
773
- agent.setPromptText('hello');
774
- const app = agent.getApp();
775
- const res = await app.request('/health');
776
- expect(res.headers.get('Content-Security-Policy')).toContain("default-src 'none'");
777
- expect(res.headers.get('Permissions-Policy')).toContain('camera=()');
778
- });
779
-
780
- it('rejects function names longer than 128 chars', async () => {
781
- const agent = new AgentBase({ name: 'test', route: '/', basicAuth: ['u', 'p'] });
782
- agent.setPromptText('hello');
783
- const app = agent.getApp();
784
- const longName = 'x'.repeat(129);
785
- const res = await app.request('/swaig', {
786
- method: 'POST',
787
- headers: {
788
- 'Authorization': 'Basic ' + btoa('u:p'),
789
- 'Content-Type': 'application/json',
790
- },
791
- body: JSON.stringify({ function: longName, argument: {} }),
792
- });
793
- expect(res.status).toBe(400);
794
- const body = await res.json();
795
- expect(body.error).toBe('Invalid function name');
796
- });
797
-
798
- it('function-not-found log does not expose available_functions', async () => {
799
- const agent = new AgentBase({ name: 'test', route: '/', basicAuth: ['u', 'p'] });
800
- agent.setPromptText('hello');
801
- agent.defineTool({
802
- name: 'real_tool',
803
- description: 'A tool',
804
- parameters: {},
805
- handler: () => new FunctionResult('ok'),
806
- });
807
- const app = agent.getApp();
808
- const res = await app.request('/swaig', {
809
- method: 'POST',
810
- headers: {
811
- 'Authorization': 'Basic ' + btoa('u:p'),
812
- 'Content-Type': 'application/json',
813
- },
814
- body: JSON.stringify({ function: 'nonexistent_fn', argument: {} }),
815
- });
816
- expect(res.status).toBe(404);
817
- // The response should not leak the list of available functions
818
- const text = await res.text();
819
- expect(text).not.toContain('real_tool');
820
- });
821
-
822
- it('invalid token returns 200 with FunctionResult (not 403)', async () => {
823
- const agent = new AgentBase({ name: 'test', route: '/', basicAuth: ['u', 'p'] });
824
- agent.defineTool({
825
- name: 'secure_fn',
826
- description: 'Secure function',
827
- parameters: {},
828
- handler: () => new FunctionResult('ok'),
829
- secure: true,
830
- });
831
- const app = agent.getApp();
832
-
833
- // Missing token
834
- const res1 = await app.request('/swaig', {
835
- method: 'POST',
836
- headers: {
837
- 'Authorization': 'Basic ' + btoa('u:p'),
838
- 'Content-Type': 'application/json',
839
- },
840
- body: JSON.stringify({ function: 'secure_fn', argument: {} }),
841
- });
842
- expect(res1.status).toBe(200);
843
- const body1 = await res1.json();
844
- expect(body1.response).toContain('security token');
845
-
846
- // Invalid token
847
- const res2 = await app.request('/swaig?__token=bogus_token', {
848
- method: 'POST',
849
- headers: {
850
- 'Authorization': 'Basic ' + btoa('u:p'),
851
- 'Content-Type': 'application/json',
852
- },
853
- body: JSON.stringify({ function: 'secure_fn', argument: {} }),
854
- });
855
- expect(res2.status).toBe(200);
856
- const body2 = await res2.json();
857
- expect(body2.response).toContain('security token');
858
- });
859
-
860
- it('rejects function names with invalid characters', async () => {
861
- const agent = new AgentBase({ name: 'test', route: '/', basicAuth: ['u', 'p'] });
862
- agent.setPromptText('hello');
863
- const app = agent.getApp();
864
-
865
- // SQL injection attempt
866
- const res1 = await app.request('/swaig', {
867
- method: 'POST',
868
- headers: {
869
- 'Authorization': 'Basic ' + btoa('u:p'),
870
- 'Content-Type': 'application/json',
871
- },
872
- body: JSON.stringify({ function: 'valid_fn; DROP TABLE', argument: {} }),
873
- });
874
- expect(res1.status).toBe(400);
875
-
876
- // Names starting with numbers
877
- const res2 = await app.request('/swaig', {
878
- method: 'POST',
879
- headers: {
880
- 'Authorization': 'Basic ' + btoa('u:p'),
881
- 'Content-Type': 'application/json',
882
- },
883
- body: JSON.stringify({ function: '123invalid', argument: {} }),
884
- });
885
- expect(res2.status).toBe(400);
886
-
887
- // Valid names should pass the format check (still 404 since not registered)
888
- const res3 = await app.request('/swaig', {
889
- method: 'POST',
890
- headers: {
891
- 'Authorization': 'Basic ' + btoa('u:p'),
892
- 'Content-Type': 'application/json',
893
- },
894
- body: JSON.stringify({ function: 'valid_fn_name', argument: {} }),
895
- });
896
- expect(res3.status).toBe(404); // not registered, but passed format validation
897
- });
898
-
899
- it('non-object argument is coerced to empty object', async () => {
900
- const captured: Record<string, unknown>[] = [];
901
- const agent = new AgentBase({ name: 'test', route: '/', basicAuth: ['u', 'p'] });
902
- agent.defineTool({
903
- name: 'arg_test',
904
- description: 'Test args',
905
- parameters: {},
906
- handler: (_args, _params, _body) => {
907
- captured.push(_args);
908
- return new FunctionResult('ok');
909
- },
910
- });
911
- const app = agent.getApp();
912
-
913
- // String argument
914
- const res1 = await app.request('/swaig', {
915
- method: 'POST',
916
- headers: {
917
- 'Authorization': 'Basic ' + btoa('u:p'),
918
- 'Content-Type': 'application/json',
919
- },
920
- body: JSON.stringify({ function: 'arg_test', argument: 'not-an-object' }),
921
- });
922
- expect(res1.status).toBe(200);
923
-
924
- // Array argument
925
- const res2 = await app.request('/swaig', {
926
- method: 'POST',
927
- headers: {
928
- 'Authorization': 'Basic ' + btoa('u:p'),
929
- 'Content-Type': 'application/json',
930
- },
931
- body: JSON.stringify({ function: 'arg_test', argument: [1, 2, 3] }),
932
- });
933
- expect(res2.status).toBe(200);
934
-
935
- // Null argument
936
- const res3 = await app.request('/swaig', {
937
- method: 'POST',
938
- headers: {
939
- 'Authorization': 'Basic ' + btoa('u:p'),
940
- 'Content-Type': 'application/json',
941
- },
942
- body: JSON.stringify({ function: 'arg_test', argument: null }),
943
- });
944
- expect(res3.status).toBe(200);
945
-
946
- // All non-object arguments should be coerced to {}
947
- expect(captured.length).toBe(3);
948
- for (const args of captured) {
949
- expect(args).toEqual({});
950
- }
951
- });
952
-
953
- // ── defineTypedTool ─────────────────────────────────────────────────
954
-
955
- it('defineTypedTool registers tool with inferred schema', () => {
956
- const agent = createAgent();
957
- agent.setPromptText('hello');
958
- agent.defineTypedTool({
959
- name: 'get_weather',
960
- description: 'Get weather for a city',
961
- handler: (city: string, days = 5) => new FunctionResult(`Weather for ${city}, ${days} days`),
962
- });
963
- const tool = agent.getTool('get_weather');
964
- expect(tool).toBeDefined();
965
- expect(tool!.isTypedHandler).toBe(true);
966
- expect(tool!.parameters['city']).toBeDefined();
967
- expect(tool!.parameters['city']).toEqual({ type: 'string', description: 'The city parameter' });
968
- expect(tool!.parameters['days']).toEqual({ type: 'integer', description: 'The days parameter' });
969
- expect(tool!.required).toEqual(['city']);
970
- });
971
-
972
- it('defineTypedTool handler receives named params', async () => {
973
- const agent = createAgent();
974
- const captured: unknown[] = [];
975
- agent.defineTypedTool({
976
- name: 'greet',
977
- description: 'Greet someone',
978
- handler: (name: string, excited = false) => {
979
- captured.push(name, excited);
980
- return new FunctionResult('hi');
981
- },
982
- });
983
- const tool = agent.getTool('greet');
984
- await tool!.execute({ name: 'Alice', excited: true });
985
- expect(captured).toEqual(['Alice', true]);
986
- });
987
-
988
- it('defineTypedTool explicit parameters override inference', () => {
989
- const agent = createAgent();
990
- agent.defineTypedTool({
991
- name: 'custom',
992
- description: 'Custom tool',
993
- parameters: { location: { type: 'string', description: 'Location' } },
994
- required: ['location'],
995
- handler: (location: string) => new FunctionResult(`Got ${location}`),
996
- });
997
- const tool = agent.getTool('custom');
998
- expect(tool).toBeDefined();
999
- expect(tool!.parameters['location']).toEqual({ type: 'string', description: 'Location' });
1000
- // Should not have inferred params
1001
- expect(tool!.parameters['city']).toBeUndefined();
1002
- });
1003
-
1004
- it('defineTypedTool SWML output includes tool', () => {
1005
- const agent = createAgent();
1006
- agent.setPromptText('hello');
1007
- agent.defineTypedTool({
1008
- name: 'lookup',
1009
- description: 'Look up info',
1010
- handler: (query: string) => new FunctionResult(`Found: ${query}`),
1011
- });
1012
- const swml = JSON.parse(agent.renderSwml());
1013
- const fns = swml.sections.main[1].ai.SWAIG.functions;
1014
- expect(fns.length).toBe(1);
1015
- expect(fns[0].function).toBe('lookup');
1016
- expect(fns[0].parameters.properties.query).toBeDefined();
1017
- });
1018
-
1019
- it('auto-generated password is 32 hex chars', () => {
1020
- const savedUser = process.env['SWML_BASIC_AUTH_USER'];
1021
- const savedPass = process.env['SWML_BASIC_AUTH_PASSWORD'];
1022
- delete process.env['SWML_BASIC_AUTH_USER'];
1023
- delete process.env['SWML_BASIC_AUTH_PASSWORD'];
1024
- try {
1025
- const agent = new AgentBase({ name: 'test-auto-pass', route: '/' });
1026
- const [, pass] = agent.getBasicAuthCredentials();
1027
- expect(pass.length).toBe(32);
1028
- expect(/^[0-9a-f]{32}$/.test(pass)).toBe(true);
1029
- } finally {
1030
- if (savedUser) process.env['SWML_BASIC_AUTH_USER'] = savedUser;
1031
- if (savedPass) process.env['SWML_BASIC_AUTH_PASSWORD'] = savedPass;
1032
- }
1033
- });
1034
-
1035
- describe('validateToolToken', () => {
1036
- it('returns false for an unknown function', () => {
1037
- const agent = createAgent();
1038
- expect(agent.validateToolToken('missing', 'tok', 'call-1')).toBe(false);
1039
- });
1040
-
1041
- it('returns true for a registered non-secure function without consulting SessionManager', () => {
1042
- const agent = createAgent();
1043
- agent.defineTool({
1044
- name: 'insecure_tool',
1045
- description: 'no auth needed',
1046
- parameters: {},
1047
- handler: () => new FunctionResult('ok'),
1048
- secure: false,
1049
- });
1050
-
1051
- // Fail loudly if SessionManager is consulted — non-secure tools must short-circuit.
1052
- const sm = (agent as any).sessionManager;
1053
- const orig = sm.validateToolToken.bind(sm);
1054
- sm.validateToolToken = () => {
1055
- throw new Error('SessionManager.validateToolToken must not be called for non-secure tools');
1056
- };
1057
- try {
1058
- expect(agent.validateToolToken('insecure_tool', '', '')).toBe(true);
1059
- } finally {
1060
- sm.validateToolToken = orig;
1061
- }
1062
- });
1063
-
1064
- it('returns true for a registered secure function with a valid token', () => {
1065
- const agent = createAgent();
1066
- agent.defineTool({
1067
- name: 'secure_tool',
1068
- description: 'auth required',
1069
- parameters: {},
1070
- handler: () => new FunctionResult('ok'),
1071
- secure: true,
1072
- });
1073
-
1074
- const sm = (agent as any).sessionManager;
1075
- const callId = 'call-abc';
1076
- const token = sm.createToolToken('secure_tool', callId);
1077
- expect(agent.validateToolToken('secure_tool', token, callId)).toBe(true);
1078
- });
1079
-
1080
- it('returns false for a registered secure function with an invalid token', () => {
1081
- const agent = createAgent();
1082
- agent.defineTool({
1083
- name: 'secure_tool',
1084
- description: 'auth required',
1085
- parameters: {},
1086
- handler: () => new FunctionResult('ok'),
1087
- secure: true,
1088
- });
1089
-
1090
- expect(agent.validateToolToken('secure_tool', 'bogus-token', 'call-xyz')).toBe(false);
1091
- });
1092
- });
1093
- });