@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,71 +0,0 @@
1
- /**
2
- * Gather Info with Steps Example
3
- *
4
- * Uses the ContextBuilder with GatherInfo to collect structured
5
- * information from the caller through a guided conversation flow.
6
- * Run: npx tsx examples/gather-info.ts
7
- */
8
-
9
- import { AgentBase, FunctionResult, GatherInfo, GatherQuestion } from '../src/index.js';
10
-
11
- export const agent = new AgentBase({
12
- name: 'intake-agent',
13
- route: '/',
14
- basicAuth: [
15
- process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
16
- process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
17
- ],
18
- });
19
-
20
- agent.setPromptText(
21
- 'You are a medical office intake assistant. Collect patient information ' +
22
- 'step by step. Be polite and professional.',
23
- );
24
-
25
- // Define a tool for final submission
26
- agent.defineTool({
27
- name: 'submit_intake',
28
- description: 'Submit the completed intake form',
29
- parameters: {
30
- patient_name: { type: 'string', description: 'Full name of the patient' },
31
- reason: { type: 'string', description: 'Reason for visit' },
32
- },
33
- handler: (args) => {
34
- return new FunctionResult(
35
- `Intake form submitted for ${args.patient_name}. Reason: ${args.reason}. ` +
36
- 'A nurse will be with you shortly.',
37
- );
38
- },
39
- });
40
-
41
- // Define structured conversation flow with steps
42
- const ctx = agent.defineContexts();
43
- const intake = ctx.addContext('default');
44
-
45
- // Step 1: Welcome and collect name
46
- intake
47
- .addStep('welcome', { task: 'Welcome the patient and ask for their full name.' })
48
- .setStepCriteria('Patient has provided their full name')
49
- .setFunctions('none')
50
- .setValidSteps(['reason']);
51
-
52
- // Step 2: Collect reason for visit
53
- intake
54
- .addStep('reason', {
55
- task: 'Ask the patient about their reason for visiting today.',
56
- })
57
- .setStepCriteria('Patient has described their reason for the visit')
58
- .setFunctions('none')
59
- .setValidSteps(['confirm']);
60
-
61
- // Step 3: Confirm and submit
62
- intake
63
- .addStep('confirm', {
64
- task: 'Confirm the collected information with the patient and submit the intake form.',
65
- })
66
- .setFunctions(['submit_intake'])
67
- .setEnd(true);
68
-
69
- agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
70
-
71
- agent.run();
@@ -1,140 +0,0 @@
1
- /**
2
- * Per-Question Function Whitelist Demo (gather_info)
3
- *
4
- * This example exists to teach one specific gotcha: while a step's gather_info
5
- * is asking questions, ALL of the step's other functions are forcibly
6
- * deactivated. The only callable tools during a gather question are:
7
- *
8
- * - `gather_submit` (the native answer-submission tool, always active)
9
- * - Whatever names you list in that question's `functions` option
10
- *
11
- * `next_step` and `change_context` are also filtered out — the model literally
12
- * cannot navigate away until the gather completes. This is by design: it
13
- * forces a tight ask → submit → next-question loop.
14
- *
15
- * If a question needs to call out to a tool — for example, to validate an
16
- * email format, geocode a ZIP, or look up something from an external service
17
- * — you must list that tool name in the question's `functions` option. The
18
- * function is active ONLY for that question.
19
- *
20
- * Below: a customer-onboarding gather flow where each question unlocks a
21
- * different validation tool, and where the step's own non-gather tools
22
- * (escalate_to_human, lookup_existing_account) are LOCKED OUT during gather
23
- * because they aren't whitelisted on any question.
24
- *
25
- * Run this file to see the resulting SWML.
26
- */
27
-
28
- import { AgentBase } from '../src/AgentBase.js';
29
- import { FunctionResult } from '../src/FunctionResult.js';
30
-
31
- class GatherPerQuestionFunctionsAgent extends AgentBase {
32
- constructor() {
33
- super({ name: 'gather_per_question_functions_demo', route: '/' });
34
-
35
- // Tools that the step would normally have available — but during
36
- // gather questioning, they're all locked out unless they appear in
37
- // a question's `functions` whitelist.
38
- this.defineTool({
39
- name: 'validate_email',
40
- description: 'Validate that an email address is well-formed and deliverable',
41
- parameters: { email: { type: 'string' } },
42
- handler: async () => new FunctionResult('valid'),
43
- });
44
- this.defineTool({
45
- name: 'geocode_zip',
46
- description: 'Look up the city/state for a US ZIP code',
47
- parameters: { zip: { type: 'string' } },
48
- handler: async () => new FunctionResult('{"city":"...","state":"..."}'),
49
- });
50
- this.defineTool({
51
- name: 'check_age_eligibility',
52
- description: 'Verify the customer is old enough for the product',
53
- parameters: { age: { type: 'integer' } },
54
- handler: async () => new FunctionResult('eligible'),
55
- });
56
- // These tools are NOT whitelisted on any gather question. They are
57
- // registered on the agent and active outside the gather, but during
58
- // the gather they cannot be called — gather mode locks them out.
59
- this.defineTool({
60
- name: 'escalate_to_human',
61
- description: 'Transfer the conversation to a live agent',
62
- parameters: {},
63
- handler: async () => new FunctionResult('transferred'),
64
- });
65
- this.defineTool({
66
- name: 'lookup_existing_account',
67
- description: 'Search for an existing account by email',
68
- parameters: { email: { type: 'string' } },
69
- handler: async () => new FunctionResult('not found'),
70
- });
71
-
72
- // Build a single-context agent with one onboarding step.
73
- const contexts = this.defineContexts();
74
- const ctx = contexts.addContext('default');
75
-
76
- ctx
77
- .addStep('onboard')
78
- .setText(
79
- 'Onboard a new customer by collecting their details. Use ' +
80
- 'gather_info to ask one question at a time. Each question ' +
81
- 'may unlock a specific validation tool — only that tool ' +
82
- 'and gather_submit are callable while answering it.',
83
- )
84
- .setFunctions([
85
- // Outside of the gather (which is the entire step here),
86
- // these would be available. During the gather they are
87
- // forcibly hidden in favor of the per-question whitelists.
88
- 'escalate_to_human',
89
- 'lookup_existing_account',
90
- ])
91
- .setGatherInfo({
92
- outputKey: 'customer',
93
- completionAction: 'next_step',
94
- prompt:
95
- "I'll need to collect a few details to set up your " +
96
- "account. I'll ask one question at a time.",
97
- })
98
- .addGatherQuestion({
99
- key: 'email',
100
- question: "What's your email address?",
101
- confirm: true,
102
- // Only validate_email + gather_submit are callable here.
103
- functions: ['validate_email'],
104
- })
105
- .addGatherQuestion({
106
- key: 'zip',
107
- question: "What's your ZIP code?",
108
- // Only geocode_zip + gather_submit are callable here.
109
- functions: ['geocode_zip'],
110
- })
111
- .addGatherQuestion({
112
- key: 'age',
113
- question: 'How old are you?',
114
- type: 'integer',
115
- // Only check_age_eligibility + gather_submit are callable here.
116
- functions: ['check_age_eligibility'],
117
- })
118
- .addGatherQuestion({
119
- key: 'referral_source',
120
- question: 'How did you hear about us?',
121
- // No functions option → only gather_submit is callable.
122
- // The model cannot validate, lookup, escalate — nothing.
123
- // This is the right pattern when a question needs no tools.
124
- });
125
-
126
- // A simple confirmation step the gather auto-advances into.
127
- ctx
128
- .addStep('confirm')
129
- .setText(
130
- 'Read the collected info back to the customer and ' +
131
- 'confirm everything is correct.',
132
- )
133
- .setFunctions([])
134
- .setEnd(true);
135
- }
136
- }
137
-
138
- const agent = new GatherPerQuestionFunctionsAgent();
139
- const swml = agent.renderSwml();
140
- console.log(JSON.stringify(JSON.parse(swml), null, 2));
@@ -1,34 +0,0 @@
1
- /**
2
- * Joke Agent Example
3
- *
4
- * A fun agent that uses the built-in Joke skill to tell jokes.
5
- * Run: npx tsx examples/joke-agent.ts
6
- */
7
-
8
- import { AgentBase, JokeSkill, DateTimeSkill } from '../src/index.js';
9
-
10
- export const agent = new AgentBase({
11
- name: 'joke-agent',
12
- route: '/',
13
- basicAuth: [
14
- process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
15
- process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
16
- ],
17
- });
18
-
19
- agent.setPromptText(
20
- 'You are a friendly comedian named Chuckles. Your job is to make people laugh! ' +
21
- 'Tell jokes when asked, and try to keep the mood light and fun. ' +
22
- 'You can also tell the time if someone asks.',
23
- );
24
-
25
- // Add the joke skill — injects the tell_joke tool, prompt sections, and hints
26
- await agent.addSkill(new JokeSkill());
27
-
28
- // Also add datetime so we can answer "what time is it?" questions
29
- await agent.addSkill(new DateTimeSkill());
30
-
31
- agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
32
- agent.addHints(['joke', 'funny', 'comedy', 'laugh', 'punchline']);
33
-
34
- agent.run();
@@ -1,45 +0,0 @@
1
- /**
2
- * Kubernetes-Ready Agent Example
3
- *
4
- * Agent with graceful shutdown for clean K8s/Docker stops,
5
- * health check endpoints, and structured logging.
6
- * Run: npx tsx examples/kubernetes-agent.ts
7
- */
8
-
9
- import { AgentBase, FunctionResult } from '../src/index.js';
10
-
11
- // Set up graceful shutdown before anything else
12
- AgentBase.setupGracefulShutdown({ timeout: 10000 });
13
-
14
- export const agent = new AgentBase({
15
- name: 'k8s-agent',
16
- route: '/',
17
- basicAuth: [
18
- process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
19
- process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
20
- ],
21
- });
22
-
23
- agent.setPromptText(
24
- 'You are a production-grade assistant running in Kubernetes. ' +
25
- 'Respond helpfully and professionally.',
26
- );
27
-
28
- agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
29
-
30
- agent.defineTool({
31
- name: 'get_status',
32
- description: 'Get the current service status',
33
- parameters: {},
34
- handler: () => {
35
- return new FunctionResult(
36
- `Service is healthy. Uptime: ${Math.floor(process.uptime())}s. Memory: ${Math.round(process.memoryUsage().heapUsed / 1024 / 1024)}MB.`,
37
- );
38
- },
39
- });
40
-
41
- // Health check is built into AgentBase at /health and /ready
42
- // K8s liveness probe: GET /health -> {"status":"ok"}
43
- // K8s readiness probe: GET /ready -> {"status":"ready"}
44
-
45
- agent.run();
@@ -1,69 +0,0 @@
1
- /**
2
- * LLM Parameters Example
3
- *
4
- * Fine-tune AI behavior: temperature, top_p, barge confidence,
5
- * speech recognition hints, fillers, and post-prompt instructions.
6
- * Run: npx tsx examples/llm-params.ts
7
- */
8
-
9
- import { AgentBase, FunctionResult } from '../src/index.js';
10
-
11
- export const agent = new AgentBase({
12
- name: 'tuned-agent',
13
- route: '/',
14
- basicAuth: [
15
- process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
16
- process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
17
- ],
18
- });
19
-
20
- agent.setPromptText(
21
- 'You are a precise, factual assistant for a medical office. ' +
22
- 'Always confirm information before proceeding. Never guess or speculate.',
23
- );
24
-
25
- // LLM parameters — low temperature for precision
26
- agent.setParams({
27
- temperature: 0.2,
28
- top_p: 0.9,
29
- confidence: 0.6,
30
- barge_confidence: 0.3,
31
- barge_match_string: 'stop,cancel,hold on',
32
- attention_timeout: 15000,
33
- inactivity_timeout: 20000,
34
- background_file_loops: -1,
35
- background_file_volume: 10,
36
- });
37
-
38
- // Language with function-level fillers
39
- agent.addLanguage({
40
- name: 'English',
41
- code: 'en-US',
42
- voice: 'rachel',
43
- fillers: ['one moment please', 'let me check that for you', 'just a second'],
44
- functionFillers: ['looking that up now', 'searching our records'],
45
- });
46
-
47
- // Post-prompt for structured call summary
48
- agent.setPostPrompt(
49
- 'Summarize this call as JSON with fields: patient_name, appointment_type, date_requested, special_instructions.',
50
- );
51
-
52
- // Speech recognition hints for medical terms
53
- agent.addHints(['appointment', 'prescription', 'referral', 'lab results', 'follow-up']);
54
- agent.addPronunciation({ replace: 'Dr.', with: 'Doctor' });
55
-
56
- agent.defineTool({
57
- name: 'check_availability',
58
- description: 'Check appointment availability for a given date',
59
- parameters: {
60
- date: { type: 'string', description: 'The requested date (YYYY-MM-DD)' },
61
- },
62
- handler: (args) => {
63
- return new FunctionResult(
64
- `Availability for ${args.date}: 9:00 AM, 11:30 AM, 2:00 PM slots open.`,
65
- );
66
- },
67
- });
68
-
69
- agent.run();
@@ -1,84 +0,0 @@
1
- /**
2
- * Example: MCP Integration -- Client and Server
3
- *
4
- * This agent demonstrates both MCP features:
5
- *
6
- * 1. MCP Server: Exposes tools at /mcp so external MCP clients
7
- * (Claude Desktop, other agents) can discover and invoke them.
8
- *
9
- * 2. MCP Client: Connects to an external MCP server to pull in additional
10
- * tools for voice calls.
11
- *
12
- * Run:
13
- * npx tsx examples/mcp-agent.ts
14
- *
15
- * Then:
16
- * - Point a SignalWire phone number at http://your-server:3000/agent
17
- * - Connect Claude Desktop to http://your-server:3000/agent/mcp
18
- */
19
-
20
- import { AgentBase, FunctionResult } from '../src/index.js';
21
-
22
- const agent = new AgentBase({
23
- name: 'mcp-agent',
24
- route: '/agent',
25
- basicAuth: [
26
- process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
27
- process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
28
- ],
29
- });
30
-
31
- // -- MCP Server --
32
- // Adds a /mcp endpoint that speaks JSON-RPC 2.0 (MCP protocol).
33
- agent.enableMcpServer();
34
-
35
- // -- MCP Client --
36
- // Connect to an external MCP server. Tools are discovered automatically.
37
- agent.addMcpServer('https://mcp.example.com/tools', {
38
- headers: { Authorization: 'Bearer sk-your-mcp-api-key' },
39
- });
40
-
41
- // -- MCP Client with Resources --
42
- agent.addMcpServer('https://mcp.example.com/crm', {
43
- headers: { Authorization: 'Bearer sk-your-crm-key' },
44
- resources: true,
45
- resourceVars: { caller_id: '${caller_id_number}', tenant: 'acme-corp' },
46
- });
47
-
48
- // -- Agent Configuration --
49
- agent.promptAddSection('Role', {
50
- body: 'You are a helpful customer support agent. '
51
- + 'You have access to the customer\'s profile via global_data.',
52
- });
53
- agent.promptAddSection('Customer Context', {
54
- body: 'Customer name: ${global_data.customer_name}\n'
55
- + 'Account status: ${global_data.account_status}',
56
- });
57
-
58
- agent.setParams({ attention_timeout: 15000 });
59
-
60
- // -- Local Tools --
61
- agent.defineTool({
62
- name: 'get_weather',
63
- description: 'Get the current weather for a location',
64
- parameters: { location: { type: 'string', description: 'City name or zip code' } },
65
- handler: (args: Record<string, unknown>) => {
66
- const location = (args['location'] as string) || 'unknown';
67
- return new FunctionResult(`Currently 72F and sunny in ${location}.`);
68
- },
69
- });
70
-
71
- agent.defineTool({
72
- name: 'create_ticket',
73
- description: 'Create a support ticket for the customer',
74
- parameters: {
75
- subject: { type: 'string', description: 'Ticket subject' },
76
- description: { type: 'string', description: 'Detailed description' },
77
- },
78
- handler: (args: Record<string, unknown>) => {
79
- const subject = (args['subject'] as string) || 'No subject';
80
- return new FunctionResult(`Ticket created: '${subject}'. Reference: TK-12345.`);
81
- },
82
- });
83
-
84
- agent.run();
@@ -1,35 +0,0 @@
1
- /**
2
- * MCP Gateway Skill Example
3
- *
4
- * Demonstrates the MCP (Model Context Protocol) gateway skill,
5
- * which is a placeholder for future MCP server integration.
6
- * Run: npx tsx examples/mcp-gateway.ts
7
- */
8
-
9
- import { AgentBase, McpGatewaySkill } from '../src/index.js';
10
-
11
- export const agent = new AgentBase({
12
- name: 'mcp-agent',
13
- route: '/',
14
- basicAuth: [
15
- process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
16
- process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
17
- ],
18
- });
19
-
20
- agent.setPromptText(
21
- 'You are an assistant with access to external tools via MCP (Model Context Protocol). ' +
22
- 'Use the available tools to help the caller with their requests.',
23
- );
24
-
25
- // Add MCP Gateway skill — currently a stub for future implementation
26
- await agent.addSkill(
27
- new McpGatewaySkill({
28
- gateway_url: 'http://localhost:8080/mcp',
29
- tool_prefix: 'ext',
30
- }),
31
- );
32
-
33
- agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
34
-
35
- agent.run();
@@ -1,73 +0,0 @@
1
- /**
2
- * Multi-Agent Server Example
3
- *
4
- * Host multiple agents under a single HTTP server, each at its own route.
5
- * Run: npx tsx examples/multi-agent.ts
6
- * Test:
7
- * curl http://user:pass@localhost:3000/support
8
- * curl http://user:pass@localhost:3000/sales
9
- * curl http://localhost:3000/ (agent listing)
10
- * curl http://localhost:3000/health
11
- */
12
-
13
- import { AgentBase, AgentServer, FunctionResult } from '../src/index.js';
14
-
15
- // --- Support Agent ---
16
- export const support = new AgentBase({
17
- name: 'support',
18
- route: '/support',
19
- basicAuth: [
20
- process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
21
- process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
22
- ],
23
- });
24
-
25
- support.setPromptText('You are a customer support agent. Help resolve issues quickly and politely.');
26
- support.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
27
-
28
- support.defineTool({
29
- name: 'lookup_ticket',
30
- description: 'Look up a support ticket by ID',
31
- parameters: {
32
- ticket_id: { type: 'string', description: 'The ticket ID' },
33
- },
34
- handler: (args) => {
35
- return new FunctionResult(`Ticket ${args.ticket_id}: Status is "In Progress", assigned to Team B.`);
36
- },
37
- });
38
-
39
- // --- Sales Agent ---
40
- export const sales = new AgentBase({
41
- name: 'sales',
42
- route: '/sales',
43
- basicAuth: [
44
- process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
45
- process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
46
- ],
47
- });
48
-
49
- sales.setPromptText('You are a sales agent. Help potential customers understand our products and pricing.');
50
- sales.addLanguage({ name: 'English', code: 'en-US', voice: 'dave' });
51
-
52
- sales.defineTool({
53
- name: 'get_pricing',
54
- description: 'Get pricing information for a product',
55
- parameters: {
56
- product: { type: 'string', description: 'Product name' },
57
- },
58
- handler: (args) => {
59
- const prices: Record<string, string> = {
60
- basic: '$29/mo',
61
- pro: '$99/mo',
62
- enterprise: 'Custom pricing - schedule a call',
63
- };
64
- const price = prices[args.product?.toLowerCase()] ?? 'Product not found';
65
- return new FunctionResult(`Pricing for ${args.product}: ${price}`);
66
- },
67
- });
68
-
69
- // --- Server ---
70
- const server = new AgentServer({ port: 3000 });
71
- server.register(support);
72
- server.register(sales);
73
- server.run();
@@ -1,79 +0,0 @@
1
- /**
2
- * Multi-Endpoint Example
3
- *
4
- * An AgentServer hosting multiple agents at different SWML routes,
5
- * with a shared static file directory and custom health endpoint.
6
- * Run: npx tsx examples/multi-endpoint.ts
7
- * Test:
8
- * curl http://user:pass@localhost:3000/billing
9
- * curl http://user:pass@localhost:3000/tech-support
10
- * curl http://localhost:3000/ (agent listing)
11
- * curl http://localhost:3000/health
12
- */
13
-
14
- import { AgentBase, AgentServer, FunctionResult } from '../src/index.js';
15
-
16
- // --- Billing Agent ---
17
- const billing = new AgentBase({
18
- name: 'billing',
19
- route: '/billing',
20
- basicAuth: [
21
- process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
22
- process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
23
- ],
24
- });
25
-
26
- billing.setPromptText(
27
- 'You are a billing specialist. Help callers with invoices, payments, and account balances.',
28
- );
29
-
30
- billing.defineTool({
31
- name: 'get_balance',
32
- description: 'Get the account balance for a customer',
33
- parameters: {
34
- account_id: { type: 'string', description: 'Customer account ID' },
35
- },
36
- handler: (args) => {
37
- return new FunctionResult(
38
- `Account ${args.account_id}: Balance is $142.50. Last payment: $50.00 on Jan 15.`,
39
- );
40
- },
41
- });
42
-
43
- billing.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
44
-
45
- // --- Tech Support Agent ---
46
- const techSupport = new AgentBase({
47
- name: 'tech-support',
48
- route: '/tech-support',
49
- basicAuth: [
50
- process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
51
- process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
52
- ],
53
- });
54
-
55
- techSupport.setPromptText(
56
- 'You are a technical support specialist. Help diagnose and resolve product issues.',
57
- );
58
-
59
- techSupport.defineTool({
60
- name: 'run_diagnostic',
61
- description: 'Run a remote diagnostic on the customer device',
62
- parameters: {
63
- device_id: { type: 'string', description: 'Device serial number' },
64
- },
65
- handler: (args) => {
66
- return new FunctionResult(
67
- `Diagnostic for device ${args.device_id}: All systems normal. Firmware: v2.3.1 (up to date).`,
68
- );
69
- },
70
- });
71
-
72
- techSupport.addLanguage({ name: 'English', code: 'en-US', voice: 'dave' });
73
- techSupport.setParam('temperature', 0.2);
74
-
75
- // --- Server ---
76
- const server = new AgentServer({ port: 3000 });
77
- server.register(billing);
78
- server.register(techSupport);
79
- server.run();