@signalwire/sdk 2.0.0 → 2.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (612) hide show
  1. package/dist/AgentBase.d.ts +1045 -0
  2. package/dist/AgentBase.js +2375 -0
  3. package/dist/AgentBase.js.map +1 -0
  4. package/dist/AgentServer.d.ts +146 -0
  5. package/dist/AgentServer.js +388 -0
  6. package/dist/AgentServer.js.map +1 -0
  7. package/dist/AuthHandler.d.ts +127 -0
  8. package/dist/AuthHandler.js +212 -0
  9. package/dist/AuthHandler.js.map +1 -0
  10. package/dist/ConfigLoader.d.ts +170 -0
  11. package/dist/ConfigLoader.js +393 -0
  12. package/dist/ConfigLoader.js.map +1 -0
  13. package/dist/ContextBuilder.d.ts +652 -0
  14. package/dist/ContextBuilder.js +1115 -0
  15. package/dist/ContextBuilder.js.map +1 -0
  16. package/dist/DataMap.d.ts +271 -0
  17. package/dist/DataMap.js +430 -0
  18. package/dist/DataMap.js.map +1 -0
  19. package/dist/FunctionResult.d.ts +481 -0
  20. package/dist/FunctionResult.js +775 -0
  21. package/dist/FunctionResult.js.map +1 -0
  22. package/dist/Logger.d.ts +113 -0
  23. package/dist/Logger.js +320 -0
  24. package/dist/Logger.js.map +1 -0
  25. package/dist/PomBuilder.d.ts +208 -0
  26. package/dist/PomBuilder.js +409 -0
  27. package/dist/PomBuilder.js.map +1 -0
  28. package/dist/PromptManager.d.ts +85 -0
  29. package/dist/PromptManager.js +108 -0
  30. package/dist/PromptManager.js.map +1 -0
  31. package/dist/SWMLHandler.d.ts +159 -0
  32. package/dist/SWMLHandler.js +229 -0
  33. package/dist/SWMLHandler.js.map +1 -0
  34. package/dist/SWMLService.d.ts +326 -0
  35. package/dist/SWMLService.js +610 -0
  36. package/dist/SWMLService.js.map +1 -0
  37. package/dist/SchemaUtils.d.ts +108 -0
  38. package/dist/SchemaUtils.js +317 -0
  39. package/dist/SchemaUtils.js.map +1 -0
  40. package/dist/SecurityUtils.d.ts +60 -0
  41. package/{src/SecurityUtils.ts → dist/SecurityUtils.js} +82 -83
  42. package/dist/SecurityUtils.js.map +1 -0
  43. package/dist/ServerlessAdapter.d.ts +119 -0
  44. package/dist/ServerlessAdapter.js +188 -0
  45. package/dist/ServerlessAdapter.js.map +1 -0
  46. package/dist/SessionManager.d.ts +142 -0
  47. package/dist/SessionManager.js +260 -0
  48. package/dist/SessionManager.js.map +1 -0
  49. package/dist/SslConfig.d.ts +77 -0
  50. package/dist/SslConfig.js +100 -0
  51. package/dist/SslConfig.js.map +1 -0
  52. package/dist/SwaigFunction.d.ts +159 -0
  53. package/dist/SwaigFunction.js +209 -0
  54. package/dist/SwaigFunction.js.map +1 -0
  55. package/dist/SwmlBuilder.d.ts +165 -0
  56. package/dist/SwmlBuilder.js +247 -0
  57. package/dist/SwmlBuilder.js.map +1 -0
  58. package/dist/SwmlVerbMethods.generated.d.ts +254 -0
  59. package/dist/SwmlVerbMethods.generated.js +9 -0
  60. package/dist/SwmlVerbMethods.generated.js.map +1 -0
  61. package/dist/TypeInference.d.ts +71 -0
  62. package/dist/TypeInference.js +164 -0
  63. package/dist/TypeInference.js.map +1 -0
  64. package/dist/WebService.d.ts +148 -0
  65. package/dist/WebService.js +532 -0
  66. package/dist/WebService.js.map +1 -0
  67. package/dist/cli/agent-loader.d.ts +22 -0
  68. package/dist/cli/agent-loader.js +144 -0
  69. package/dist/cli/agent-loader.js.map +1 -0
  70. package/dist/cli/mock-data.d.ts +37 -0
  71. package/dist/cli/mock-data.js +80 -0
  72. package/dist/cli/mock-data.js.map +1 -0
  73. package/dist/cli/swaig-test.d.ts +32 -0
  74. package/dist/cli/swaig-test.js +418 -0
  75. package/dist/cli/swaig-test.js.map +1 -0
  76. package/dist/generateVerbTypes.d.ts +11 -0
  77. package/dist/generateVerbTypes.js +265 -0
  78. package/dist/generateVerbTypes.js.map +1 -0
  79. package/dist/index.d.ts +146 -0
  80. package/dist/index.js +152 -0
  81. package/dist/index.js.map +1 -0
  82. package/dist/livewire/index.d.ts +653 -0
  83. package/dist/livewire/index.js +992 -0
  84. package/dist/livewire/index.js.map +1 -0
  85. package/dist/prefabs/ConciergeAgent.d.ts +89 -0
  86. package/dist/prefabs/ConciergeAgent.js +245 -0
  87. package/dist/prefabs/ConciergeAgent.js.map +1 -0
  88. package/dist/prefabs/FAQBotAgent.d.ts +113 -0
  89. package/dist/prefabs/FAQBotAgent.js +329 -0
  90. package/dist/prefabs/FAQBotAgent.js.map +1 -0
  91. package/dist/prefabs/InfoGathererAgent.d.ts +126 -0
  92. package/dist/prefabs/InfoGathererAgent.js +287 -0
  93. package/dist/prefabs/InfoGathererAgent.js.map +1 -0
  94. package/dist/prefabs/ReceptionistAgent.d.ts +104 -0
  95. package/dist/prefabs/ReceptionistAgent.js +303 -0
  96. package/dist/prefabs/ReceptionistAgent.js.map +1 -0
  97. package/dist/prefabs/SurveyAgent.d.ts +148 -0
  98. package/dist/prefabs/SurveyAgent.js +540 -0
  99. package/dist/prefabs/SurveyAgent.js.map +1 -0
  100. package/{src/prefabs/index.ts → dist/prefabs/index.d.ts} +1 -15
  101. package/dist/prefabs/index.js +14 -0
  102. package/dist/prefabs/index.js.map +1 -0
  103. package/dist/relay/Action.d.ts +258 -0
  104. package/dist/relay/Action.js +402 -0
  105. package/dist/relay/Action.js.map +1 -0
  106. package/dist/relay/Call.d.ts +697 -0
  107. package/dist/relay/Call.js +1062 -0
  108. package/dist/relay/Call.js.map +1 -0
  109. package/dist/relay/Deferred.d.ts +44 -0
  110. package/dist/relay/Deferred.js +69 -0
  111. package/dist/relay/Deferred.js.map +1 -0
  112. package/dist/relay/Message.d.ts +103 -0
  113. package/dist/relay/Message.js +169 -0
  114. package/dist/relay/Message.js.map +1 -0
  115. package/dist/relay/RelayClient.d.ts +302 -0
  116. package/dist/relay/RelayClient.js +1019 -0
  117. package/dist/relay/RelayClient.js.map +1 -0
  118. package/dist/relay/RelayError.d.ts +15 -0
  119. package/dist/relay/RelayError.js +20 -0
  120. package/dist/relay/RelayError.js.map +1 -0
  121. package/dist/relay/RelayEvent.d.ts +254 -0
  122. package/dist/relay/RelayEvent.js +509 -0
  123. package/dist/relay/RelayEvent.js.map +1 -0
  124. package/dist/relay/constants.d.ts +90 -0
  125. package/{src/relay/constants.ts → dist/relay/constants.js} +11 -29
  126. package/dist/relay/constants.js.map +1 -0
  127. package/dist/relay/index.d.ts +16 -0
  128. package/dist/relay/index.js +18 -0
  129. package/dist/relay/index.js.map +1 -0
  130. package/dist/relay/types.d.ts +142 -0
  131. package/dist/relay/types.js +5 -0
  132. package/dist/relay/types.js.map +1 -0
  133. package/dist/rest/HttpClient.d.ts +80 -0
  134. package/dist/rest/HttpClient.js +148 -0
  135. package/dist/rest/HttpClient.js.map +1 -0
  136. package/dist/rest/RestError.d.ts +30 -0
  137. package/dist/rest/RestError.js +39 -0
  138. package/dist/rest/RestError.js.map +1 -0
  139. package/dist/rest/base/BaseResource.d.ts +24 -0
  140. package/dist/rest/base/BaseResource.js +29 -0
  141. package/dist/rest/base/BaseResource.js.map +1 -0
  142. package/dist/rest/base/CrudResource.d.ts +68 -0
  143. package/dist/rest/base/CrudResource.js +82 -0
  144. package/dist/rest/base/CrudResource.js.map +1 -0
  145. package/dist/rest/base/CrudWithAddresses.d.ts +22 -0
  146. package/dist/rest/base/CrudWithAddresses.js +25 -0
  147. package/dist/rest/base/CrudWithAddresses.js.map +1 -0
  148. package/{src/rest/index.ts → dist/rest/index.d.ts} +53 -122
  149. package/dist/rest/index.js +195 -0
  150. package/dist/rest/index.js.map +1 -0
  151. package/dist/rest/namespaces/addresses.d.ts +46 -0
  152. package/dist/rest/namespaces/addresses.js +55 -0
  153. package/dist/rest/namespaces/addresses.js.map +1 -0
  154. package/dist/rest/namespaces/calling.d.ts +382 -0
  155. package/dist/rest/namespaces/calling.js +478 -0
  156. package/dist/rest/namespaces/calling.js.map +1 -0
  157. package/dist/rest/namespaces/chat.d.ts +22 -0
  158. package/dist/rest/namespaces/chat.js +26 -0
  159. package/dist/rest/namespaces/chat.js.map +1 -0
  160. package/dist/rest/namespaces/compat.d.ts +585 -0
  161. package/dist/rest/namespaces/compat.js +735 -0
  162. package/dist/rest/namespaces/compat.js.map +1 -0
  163. package/dist/rest/namespaces/datasphere.d.ts +66 -0
  164. package/dist/rest/namespaces/datasphere.js +77 -0
  165. package/dist/rest/namespaces/datasphere.js.map +1 -0
  166. package/dist/rest/namespaces/fabric.d.ts +282 -0
  167. package/dist/rest/namespaces/fabric.js +373 -0
  168. package/dist/rest/namespaces/fabric.js.map +1 -0
  169. package/dist/rest/namespaces/imported-numbers.d.ts +22 -0
  170. package/dist/rest/namespaces/imported-numbers.js +26 -0
  171. package/dist/rest/namespaces/imported-numbers.js.map +1 -0
  172. package/dist/rest/namespaces/logs.d.ts +105 -0
  173. package/dist/rest/namespaces/logs.js +133 -0
  174. package/dist/rest/namespaces/logs.js.map +1 -0
  175. package/dist/rest/namespaces/lookup.d.ts +29 -0
  176. package/dist/rest/namespaces/lookup.js +32 -0
  177. package/dist/rest/namespaces/lookup.js.map +1 -0
  178. package/dist/rest/namespaces/mfa.d.ts +46 -0
  179. package/dist/rest/namespaces/mfa.js +54 -0
  180. package/dist/rest/namespaces/mfa.js.map +1 -0
  181. package/dist/rest/namespaces/number-groups.d.ts +49 -0
  182. package/dist/rest/namespaces/number-groups.js +58 -0
  183. package/dist/rest/namespaces/number-groups.js.map +1 -0
  184. package/dist/rest/namespaces/phone-numbers.d.ts +60 -0
  185. package/dist/rest/namespaces/phone-numbers.js +67 -0
  186. package/dist/rest/namespaces/phone-numbers.js.map +1 -0
  187. package/dist/rest/namespaces/project.d.ts +46 -0
  188. package/dist/rest/namespaces/project.js +56 -0
  189. package/dist/rest/namespaces/project.js.map +1 -0
  190. package/dist/rest/namespaces/pubsub.d.ts +22 -0
  191. package/dist/rest/namespaces/pubsub.js +26 -0
  192. package/dist/rest/namespaces/pubsub.js.map +1 -0
  193. package/dist/rest/namespaces/queues.d.ts +42 -0
  194. package/dist/rest/namespaces/queues.js +49 -0
  195. package/dist/rest/namespaces/queues.js.map +1 -0
  196. package/dist/rest/namespaces/recordings.d.ts +38 -0
  197. package/dist/rest/namespaces/recordings.js +45 -0
  198. package/dist/rest/namespaces/recordings.js.map +1 -0
  199. package/dist/rest/namespaces/registry.d.ts +141 -0
  200. package/dist/rest/namespaces/registry.js +178 -0
  201. package/dist/rest/namespaces/registry.js.map +1 -0
  202. package/dist/rest/namespaces/short-codes.d.ts +39 -0
  203. package/dist/rest/namespaces/short-codes.js +46 -0
  204. package/dist/rest/namespaces/short-codes.js.map +1 -0
  205. package/dist/rest/namespaces/sip-profile.d.ts +28 -0
  206. package/dist/rest/namespaces/sip-profile.js +34 -0
  207. package/dist/rest/namespaces/sip-profile.js.map +1 -0
  208. package/dist/rest/namespaces/verified-callers.d.ts +33 -0
  209. package/dist/rest/namespaces/verified-callers.js +39 -0
  210. package/dist/rest/namespaces/verified-callers.js.map +1 -0
  211. package/dist/rest/namespaces/video.d.ts +235 -0
  212. package/dist/rest/namespaces/video.js +297 -0
  213. package/dist/rest/namespaces/video.js.map +1 -0
  214. package/dist/rest/pagination.d.ts +39 -0
  215. package/dist/rest/pagination.js +78 -0
  216. package/dist/rest/pagination.js.map +1 -0
  217. package/dist/rest/types.d.ts +54 -0
  218. package/dist/rest/types.js +5 -0
  219. package/dist/rest/types.js.map +1 -0
  220. package/dist/skills/SkillBase.d.ts +404 -0
  221. package/dist/skills/SkillBase.js +471 -0
  222. package/dist/skills/SkillBase.js.map +1 -0
  223. package/dist/skills/SkillManager.d.ts +195 -0
  224. package/dist/skills/SkillManager.js +378 -0
  225. package/dist/skills/SkillManager.js.map +1 -0
  226. package/dist/skills/SkillRegistry.d.ts +176 -0
  227. package/dist/skills/SkillRegistry.js +310 -0
  228. package/dist/skills/SkillRegistry.js.map +1 -0
  229. package/dist/skills/builtin/api_ninjas_trivia.d.ts +47 -0
  230. package/dist/skills/builtin/api_ninjas_trivia.js +211 -0
  231. package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -0
  232. package/dist/skills/builtin/ask_claude.d.ts +37 -0
  233. package/dist/skills/builtin/ask_claude.js +162 -0
  234. package/dist/skills/builtin/ask_claude.js.map +1 -0
  235. package/dist/skills/builtin/claude_skills.d.ts +75 -0
  236. package/dist/skills/builtin/claude_skills.js +753 -0
  237. package/dist/skills/builtin/claude_skills.js.map +1 -0
  238. package/dist/skills/builtin/custom_skills.d.ts +79 -0
  239. package/dist/skills/builtin/custom_skills.js +227 -0
  240. package/dist/skills/builtin/custom_skills.js.map +1 -0
  241. package/dist/skills/builtin/datasphere.d.ts +73 -0
  242. package/dist/skills/builtin/datasphere.js +350 -0
  243. package/dist/skills/builtin/datasphere.js.map +1 -0
  244. package/dist/skills/builtin/datasphere_serverless.d.ts +89 -0
  245. package/dist/skills/builtin/datasphere_serverless.js +291 -0
  246. package/dist/skills/builtin/datasphere_serverless.js.map +1 -0
  247. package/dist/skills/builtin/datetime.d.ts +40 -0
  248. package/dist/skills/builtin/datetime.js +118 -0
  249. package/dist/skills/builtin/datetime.js.map +1 -0
  250. package/dist/skills/builtin/google_maps.d.ts +48 -0
  251. package/dist/skills/builtin/google_maps.js +470 -0
  252. package/dist/skills/builtin/google_maps.js.map +1 -0
  253. package/dist/skills/builtin/index.d.ts +31 -0
  254. package/{src/skills/builtin/index.ts → dist/skills/builtin/index.js} +30 -36
  255. package/dist/skills/builtin/index.js.map +1 -0
  256. package/dist/skills/builtin/info_gatherer.d.ts +115 -0
  257. package/dist/skills/builtin/info_gatherer.js +328 -0
  258. package/dist/skills/builtin/info_gatherer.js.map +1 -0
  259. package/dist/skills/builtin/joke.d.ts +41 -0
  260. package/dist/skills/builtin/joke.js +156 -0
  261. package/dist/skills/builtin/joke.js.map +1 -0
  262. package/dist/skills/builtin/math.d.ts +39 -0
  263. package/dist/skills/builtin/math.js +119 -0
  264. package/dist/skills/builtin/math.js.map +1 -0
  265. package/dist/skills/builtin/mcp_gateway.d.ts +82 -0
  266. package/dist/skills/builtin/mcp_gateway.js +574 -0
  267. package/dist/skills/builtin/mcp_gateway.js.map +1 -0
  268. package/dist/skills/builtin/native_vector_search.d.ts +128 -0
  269. package/dist/skills/builtin/native_vector_search.js +752 -0
  270. package/dist/skills/builtin/native_vector_search.js.map +1 -0
  271. package/dist/skills/builtin/play_background_file.d.ts +59 -0
  272. package/dist/skills/builtin/play_background_file.js +274 -0
  273. package/dist/skills/builtin/play_background_file.js.map +1 -0
  274. package/dist/skills/builtin/spider.d.ts +91 -0
  275. package/dist/skills/builtin/spider.js +758 -0
  276. package/dist/skills/builtin/spider.js.map +1 -0
  277. package/dist/skills/builtin/swml_transfer.d.ts +66 -0
  278. package/dist/skills/builtin/swml_transfer.js +475 -0
  279. package/dist/skills/builtin/swml_transfer.js.map +1 -0
  280. package/dist/skills/builtin/weather_api.d.ts +59 -0
  281. package/dist/skills/builtin/weather_api.js +196 -0
  282. package/dist/skills/builtin/weather_api.js.map +1 -0
  283. package/dist/skills/builtin/web_search.d.ts +160 -0
  284. package/dist/skills/builtin/web_search.js +894 -0
  285. package/dist/skills/builtin/web_search.js.map +1 -0
  286. package/dist/skills/builtin/wikipedia_search.d.ts +77 -0
  287. package/dist/skills/builtin/wikipedia_search.js +241 -0
  288. package/dist/skills/builtin/wikipedia_search.js.map +1 -0
  289. package/{src/skills/index.ts → dist/skills/index.d.ts} +0 -1
  290. package/dist/skills/index.js +10 -0
  291. package/dist/skills/index.js.map +1 -0
  292. package/dist/types.d.ts +118 -0
  293. package/dist/types.js +5 -0
  294. package/dist/types.js.map +1 -0
  295. package/package.json +7 -1
  296. package/.github/workflows/publish.yml +0 -27
  297. package/.github/workflows/test.yml +0 -17
  298. package/CLAUDE.md +0 -112
  299. package/docs/MIGRATION-2.0.md +0 -81
  300. package/docs/agent-guide.md +0 -869
  301. package/docs/agent_guide.md +0 -1026
  302. package/docs/api-reference.md +0 -2420
  303. package/docs/api_reference.md +0 -1301
  304. package/docs/architecture.md +0 -843
  305. package/docs/cli-guide.md +0 -579
  306. package/docs/cli_guide.md +0 -448
  307. package/docs/cloud_functions_guide.md +0 -474
  308. package/docs/configuration.md +0 -422
  309. package/docs/contexts-guide.md +0 -787
  310. package/docs/contexts_guide.md +0 -511
  311. package/docs/datamap-guide.md +0 -1141
  312. package/docs/datamap_guide.md +0 -595
  313. package/docs/llm_parameters.md +0 -239
  314. package/docs/mcp_gateway_reference.md +0 -648
  315. package/docs/mcp_integration.md +0 -108
  316. package/docs/prefabs-guide.md +0 -800
  317. package/docs/sdk_features.md +0 -477
  318. package/docs/security.md +0 -436
  319. package/docs/serverless-guide.md +0 -513
  320. package/docs/skills-guide.md +0 -857
  321. package/docs/skills-system.md +0 -301
  322. package/docs/skills_parameter_schema.md +0 -392
  323. package/docs/skills_system.md +0 -467
  324. package/docs/swaig-reference.md +0 -1627
  325. package/docs/swaig_reference.md +0 -910
  326. package/docs/swml_service_guide.md +0 -600
  327. package/docs/third_party_skills.md +0 -533
  328. package/docs/web_service.md +0 -677
  329. package/examples/README.md +0 -131
  330. package/examples/advanced-datamap.ts +0 -100
  331. package/examples/advanced-dynamic-config.ts +0 -70
  332. package/examples/auto-vivified.ts +0 -94
  333. package/examples/call-flow.ts +0 -63
  334. package/examples/comprehensive-dynamic.ts +0 -125
  335. package/examples/contexts-steps.ts +0 -65
  336. package/examples/custom-path.ts +0 -45
  337. package/examples/datamap-tools.ts +0 -55
  338. package/examples/datasphere-multi-instance.ts +0 -63
  339. package/examples/datasphere-serverless-env.ts +0 -68
  340. package/examples/datasphere-webhook-env.ts +0 -66
  341. package/examples/datasphere.ts +0 -37
  342. package/examples/declarative.ts +0 -100
  343. package/examples/dynamic-config.ts +0 -54
  344. package/examples/dynamic-info-gatherer.ts +0 -69
  345. package/examples/dynamic-swml-service.ts +0 -67
  346. package/examples/gather-info.ts +0 -71
  347. package/examples/gather-per-question-functions-demo.ts +0 -140
  348. package/examples/joke-agent.ts +0 -34
  349. package/examples/kubernetes-agent.ts +0 -45
  350. package/examples/llm-params.ts +0 -69
  351. package/examples/mcp-agent.ts +0 -84
  352. package/examples/mcp-gateway.ts +0 -35
  353. package/examples/multi-agent.ts +0 -73
  354. package/examples/multi-endpoint.ts +0 -79
  355. package/examples/pom-prompt.ts +0 -71
  356. package/examples/prefab-concierge.ts +0 -47
  357. package/examples/prefab-faq.ts +0 -54
  358. package/examples/prefab-info-gatherer.ts +0 -33
  359. package/examples/prefab-receptionist.ts +0 -36
  360. package/examples/prefab-survey.ts +0 -68
  361. package/examples/record-call.ts +0 -67
  362. package/examples/relay-demo.ts +0 -33
  363. package/examples/room-and-sip.ts +0 -94
  364. package/examples/serverless-lambda.ts +0 -35
  365. package/examples/session-state.ts +0 -83
  366. package/examples/simple-agent.ts +0 -36
  367. package/examples/simple-static.ts +0 -29
  368. package/examples/skills-demo.ts +0 -38
  369. package/examples/step-function-inheritance-demo.ts +0 -124
  370. package/examples/swaig-features.ts +0 -187
  371. package/examples/swml-service-routing.ts +0 -66
  372. package/examples/swml-service.ts +0 -38
  373. package/examples/tap.ts +0 -68
  374. package/examples/verb-methods.ts +0 -45
  375. package/examples/web-search-multi-instance.ts +0 -72
  376. package/examples/web-search.ts +0 -38
  377. package/examples/wikipedia.ts +0 -36
  378. package/livewire/README.md +0 -140
  379. package/livewire/docs/migration-guide.md +0 -228
  380. package/livewire/examples/livewire-basic-agent.ts +0 -74
  381. package/livewire/examples/livewire-handoff.ts +0 -197
  382. package/livewire/examples/livewire-multi-tool.ts +0 -117
  383. package/relay/README.md +0 -70
  384. package/relay/RELAY_IMPLEMENTATION_GUIDE.md +0 -1257
  385. package/relay/docs/call-methods.md +0 -474
  386. package/relay/docs/client-reference.md +0 -142
  387. package/relay/docs/events.md +0 -134
  388. package/relay/docs/getting-started.md +0 -134
  389. package/relay/docs/guide.md +0 -306
  390. package/relay/docs/messaging.md +0 -182
  391. package/relay/examples/relay-inbound.ts +0 -66
  392. package/relay/examples/relay-messaging.ts +0 -71
  393. package/relay/examples/relay-outbound.ts +0 -76
  394. package/rest/README.md +0 -95
  395. package/rest/docs/calling.md +0 -273
  396. package/rest/docs/client-reference.md +0 -107
  397. package/rest/docs/compat.md +0 -204
  398. package/rest/docs/fabric.md +0 -183
  399. package/rest/docs/getting-started.md +0 -110
  400. package/rest/docs/guide.md +0 -351
  401. package/rest/docs/namespaces.md +0 -285
  402. package/rest/examples/rest-10dlc-registration.ts +0 -161
  403. package/rest/examples/rest-calling-ivr-and-ai.ts +0 -102
  404. package/rest/examples/rest-calling-play-and-record.ts +0 -91
  405. package/rest/examples/rest-client.ts +0 -65
  406. package/rest/examples/rest-compat-laml.ts +0 -210
  407. package/rest/examples/rest-datasphere-search.ts +0 -82
  408. package/rest/examples/rest-fabric-conferences-and-routing.ts +0 -144
  409. package/rest/examples/rest-fabric-subscribers-and-sip.ts +0 -108
  410. package/rest/examples/rest-fabric-swml-and-callflows.ts +0 -99
  411. package/rest/examples/rest-manage-resources.ts +0 -65
  412. package/rest/examples/rest-phone-number-management.ts +0 -197
  413. package/rest/examples/rest-queues-mfa-and-recordings.ts +0 -143
  414. package/rest/examples/rest-video-rooms.ts +0 -186
  415. package/src/AgentBase.ts +0 -2489
  416. package/src/AgentServer.ts +0 -415
  417. package/src/AuthHandler.ts +0 -256
  418. package/src/ConfigLoader.ts +0 -447
  419. package/src/ContextBuilder.ts +0 -1150
  420. package/src/DataMap.ts +0 -449
  421. package/src/FunctionResult.ts +0 -866
  422. package/src/Logger.ts +0 -337
  423. package/src/PomBuilder.ts +0 -439
  424. package/src/PromptManager.ts +0 -133
  425. package/src/SWMLHandler.ts +0 -298
  426. package/src/SWMLService.ts +0 -717
  427. package/src/SchemaUtils.ts +0 -361
  428. package/src/ServerlessAdapter.ts +0 -221
  429. package/src/SessionManager.ts +0 -311
  430. package/src/SslConfig.ts +0 -118
  431. package/src/SwaigFunction.ts +0 -276
  432. package/src/SwmlBuilder.ts +0 -258
  433. package/src/SwmlVerbMethods.generated.ts +0 -234
  434. package/src/TypeInference.ts +0 -181
  435. package/src/WebService.ts +0 -619
  436. package/src/cli/agent-loader.ts +0 -166
  437. package/src/cli/mock-data.ts +0 -111
  438. package/src/cli/swaig-test.ts +0 -452
  439. package/src/generateVerbTypes.ts +0 -322
  440. package/src/index.ts +0 -167
  441. package/src/livewire/index.ts +0 -950
  442. package/src/prefabs/ConciergeAgent.ts +0 -287
  443. package/src/prefabs/FAQBotAgent.ts +0 -384
  444. package/src/prefabs/InfoGathererAgent.ts +0 -339
  445. package/src/prefabs/ReceptionistAgent.ts +0 -366
  446. package/src/prefabs/SurveyAgent.ts +0 -646
  447. package/src/relay/Action.ts +0 -314
  448. package/src/relay/Call.ts +0 -854
  449. package/src/relay/Deferred.ts +0 -71
  450. package/src/relay/Message.ts +0 -148
  451. package/src/relay/RelayClient.ts +0 -1036
  452. package/src/relay/RelayError.ts +0 -14
  453. package/src/relay/RelayEvent.ts +0 -892
  454. package/src/relay/index.ts +0 -123
  455. package/src/relay/types.ts +0 -149
  456. package/src/rest/HttpClient.ts +0 -103
  457. package/src/rest/RestError.ts +0 -31
  458. package/src/rest/base/BaseResource.ts +0 -19
  459. package/src/rest/base/CrudResource.ts +0 -51
  460. package/src/rest/base/CrudWithAddresses.ts +0 -26
  461. package/src/rest/namespaces/addresses.ts +0 -32
  462. package/src/rest/namespaces/calling.ts +0 -187
  463. package/src/rest/namespaces/chat.ts +0 -20
  464. package/src/rest/namespaces/compat.ts +0 -352
  465. package/src/rest/namespaces/datasphere.ts +0 -45
  466. package/src/rest/namespaces/fabric.ts +0 -222
  467. package/src/rest/namespaces/imported-numbers.ts +0 -20
  468. package/src/rest/namespaces/logs.ts +0 -84
  469. package/src/rest/namespaces/lookup.ts +0 -21
  470. package/src/rest/namespaces/mfa.ts +0 -30
  471. package/src/rest/namespaces/number-groups.ts +0 -38
  472. package/src/rest/namespaces/phone-numbers.ts +0 -44
  473. package/src/rest/namespaces/project.ts +0 -36
  474. package/src/rest/namespaces/pubsub.ts +0 -20
  475. package/src/rest/namespaces/queues.ts +0 -33
  476. package/src/rest/namespaces/recordings.ts +0 -28
  477. package/src/rest/namespaces/registry.ts +0 -101
  478. package/src/rest/namespaces/short-codes.ts +0 -28
  479. package/src/rest/namespaces/sip-profile.ts +0 -25
  480. package/src/rest/namespaces/verified-callers.ts +0 -27
  481. package/src/rest/namespaces/video.ts +0 -165
  482. package/src/rest/pagination.ts +0 -84
  483. package/src/rest/types.ts +0 -61
  484. package/src/skills/SkillBase.ts +0 -547
  485. package/src/skills/SkillManager.ts +0 -415
  486. package/src/skills/SkillRegistry.ts +0 -367
  487. package/src/skills/builtin/api_ninjas_trivia.ts +0 -280
  488. package/src/skills/builtin/ask_claude.ts +0 -241
  489. package/src/skills/builtin/claude_skills.ts +0 -978
  490. package/src/skills/builtin/custom_skills.ts +0 -312
  491. package/src/skills/builtin/datasphere.ts +0 -438
  492. package/src/skills/builtin/datasphere_serverless.ts +0 -339
  493. package/src/skills/builtin/datetime.ts +0 -130
  494. package/src/skills/builtin/google_maps.ts +0 -651
  495. package/src/skills/builtin/info_gatherer.ts +0 -405
  496. package/src/skills/builtin/joke.ts +0 -191
  497. package/src/skills/builtin/math.ts +0 -142
  498. package/src/skills/builtin/mcp_gateway.ts +0 -677
  499. package/src/skills/builtin/native_vector_search.ts +0 -901
  500. package/src/skills/builtin/play_background_file.ts +0 -358
  501. package/src/skills/builtin/spider.ts +0 -869
  502. package/src/skills/builtin/swml_transfer.ts +0 -635
  503. package/src/skills/builtin/weather_api.ts +0 -248
  504. package/src/skills/builtin/web_search.ts +0 -1074
  505. package/src/skills/builtin/wikipedia_search.ts +0 -299
  506. package/src/types.ts +0 -132
  507. package/tests/AgentBase.test.ts +0 -1093
  508. package/tests/AgentServer.test.ts +0 -126
  509. package/tests/AuthHandler.test.ts +0 -133
  510. package/tests/ConfigLoader.test.ts +0 -151
  511. package/tests/ContextBuilder.test.ts +0 -108
  512. package/tests/DataMap.test.ts +0 -367
  513. package/tests/EphemeralSkillCopy.test.ts +0 -107
  514. package/tests/FunctionResult.test.ts +0 -298
  515. package/tests/GracefulShutdown.test.ts +0 -46
  516. package/tests/Logger.test.ts +0 -420
  517. package/tests/PomBuilder.test.ts +0 -228
  518. package/tests/ProxyDetection.test.ts +0 -228
  519. package/tests/SWMLService.test.ts +0 -320
  520. package/tests/SWMLVerbHandler.test.ts +0 -523
  521. package/tests/SchemaUtils.test.ts +0 -106
  522. package/tests/SchemaUtils.verb.test.ts +0 -206
  523. package/tests/SecurityUtils.test.ts +0 -192
  524. package/tests/ServerlessAdapter.test.ts +0 -222
  525. package/tests/SessionManager.test.ts +0 -257
  526. package/tests/SkillBaseFeatures.test.ts +0 -130
  527. package/tests/SkillMultiInstance.test.ts +0 -102
  528. package/tests/SkillParameterSchemas.test.ts +0 -134
  529. package/tests/SkillRegistrySchema.test.ts +0 -84
  530. package/tests/SslConfig.test.ts +0 -97
  531. package/tests/SwmlBuilder.test.ts +0 -400
  532. package/tests/TypeInference.test.ts +0 -165
  533. package/tests/VerbHandlerRegistry.test.ts +0 -128
  534. package/tests/cli/mock-data.test.ts +0 -113
  535. package/tests/cli/swaig-test.test.ts +0 -108
  536. package/tests/examples.test.ts +0 -194
  537. package/tests/fixtures/scrape-parity/README.md +0 -53
  538. package/tests/fixtures/scrape-parity/expected/01_simple_article.json +0 -5
  539. package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +0 -5
  540. package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +0 -5
  541. package/tests/fixtures/scrape-parity/expected/04_bare_body.json +0 -5
  542. package/tests/fixtures/scrape-parity/expected/05_malformed.json +0 -5
  543. package/tests/fixtures/scrape-parity/expected/06_multi_class.json +0 -5
  544. package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +0 -5
  545. package/tests/fixtures/scrape-parity/expected/08_inline_script.json +0 -5
  546. package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +0 -5
  547. package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +0 -5
  548. package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +0 -5
  549. package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +0 -5
  550. package/tests/fixtures/scrape-parity/html/01_simple_article.html +0 -18
  551. package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +0 -18
  552. package/tests/fixtures/scrape-parity/html/03_nested_containers.html +0 -13
  553. package/tests/fixtures/scrape-parity/html/04_bare_body.html +0 -9
  554. package/tests/fixtures/scrape-parity/html/05_malformed.html +0 -11
  555. package/tests/fixtures/scrape-parity/html/06_multi_class.html +0 -18
  556. package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +0 -12
  557. package/tests/fixtures/scrape-parity/html/08_inline_script.html +0 -17
  558. package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +0 -21
  559. package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +0 -10
  560. package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +0 -13
  561. package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +0 -24
  562. package/tests/fixtures/scrape-parity/python_extract.py +0 -109
  563. package/tests/livewire/livewire.test.ts +0 -780
  564. package/tests/mcp.test.ts +0 -221
  565. package/tests/prefabs/prefabs.test.ts +0 -1093
  566. package/tests/relay/Action.test.ts +0 -392
  567. package/tests/relay/Call.test.ts +0 -535
  568. package/tests/relay/Deferred.test.ts +0 -71
  569. package/tests/relay/Message.test.ts +0 -164
  570. package/tests/relay/RelayClient.test.ts +0 -779
  571. package/tests/relay/RelayEvent.test.ts +0 -463
  572. package/tests/relay/helpers.ts +0 -79
  573. package/tests/rest/HttpClient.test.ts +0 -274
  574. package/tests/rest/RestError.test.ts +0 -53
  575. package/tests/rest/calling.test.ts +0 -156
  576. package/tests/rest/client.test.ts +0 -197
  577. package/tests/rest/compat.test.ts +0 -335
  578. package/tests/rest/datasphere.test.ts +0 -71
  579. package/tests/rest/fabric.test.ts +0 -186
  580. package/tests/rest/helpers.ts +0 -95
  581. package/tests/rest/logs.test.ts +0 -68
  582. package/tests/rest/pagination.test.ts +0 -133
  583. package/tests/rest/registry.test.ts +0 -94
  584. package/tests/rest/relay-rest.test.ts +0 -290
  585. package/tests/rest/video.test.ts +0 -173
  586. package/tests/setup.ts +0 -6
  587. package/tests/skills/SkillBase.test.ts +0 -108
  588. package/tests/skills/SkillManager.test.ts +0 -268
  589. package/tests/skills/SkillRegistry.test.ts +0 -176
  590. package/tests/skills/builtin.test.ts +0 -1472
  591. package/tests/skills/claude-skills.test.ts +0 -54
  592. package/tests/skills/custom-skills.test.ts +0 -53
  593. package/tests/skills/datasphere-serverless.test.ts +0 -70
  594. package/tests/skills/datasphere.test.ts +0 -107
  595. package/tests/skills/datetime.test.ts +0 -101
  596. package/tests/skills/google-maps.test.ts +0 -78
  597. package/tests/skills/info-gatherer.test.ts +0 -411
  598. package/tests/skills/joke.test.ts +0 -81
  599. package/tests/skills/math.test.ts +0 -68
  600. package/tests/skills/mcp-gateway.test.ts +0 -101
  601. package/tests/skills/play-background.test.ts +0 -54
  602. package/tests/skills/spider.test.ts +0 -108
  603. package/tests/skills/swml-transfer.test.ts +0 -178
  604. package/tests/skills/trivia.test.ts +0 -54
  605. package/tests/skills/vector-search.test.ts +0 -135
  606. package/tests/skills/weather-api.test.ts +0 -77
  607. package/tests/skills/web-search-parity.test.ts +0 -59
  608. package/tests/skills/web-search.test.ts +0 -103
  609. package/tests/skills/wikipedia.test.ts +0 -63
  610. package/tsconfig.json +0 -18
  611. package/vitest.config.ts +0 -9
  612. /package/{src → dist}/schema.json +0 -0
@@ -1,71 +0,0 @@
1
- /**
2
- * POM (Prompt Object Model) Example
3
- *
4
- * Build structured prompts with sections, bullets, and subsections
5
- * instead of raw text strings.
6
- * Run: npx tsx examples/pom-prompt.ts
7
- */
8
-
9
- import { AgentBase, FunctionResult } from '../src/index.js';
10
-
11
- export const agent = new AgentBase({
12
- name: 'support-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
- // Build a structured prompt with POM
21
- agent.promptAddSection('Role', {
22
- body: 'You are a technical support agent for Acme Corp.',
23
- });
24
-
25
- agent.promptAddSection('Capabilities', {
26
- bullets: [
27
- 'Answer questions about our products',
28
- 'Help troubleshoot common issues',
29
- 'Escalate complex problems to human agents',
30
- ],
31
- });
32
-
33
- agent.promptAddSection('Guidelines', {
34
- body: 'Always follow these rules when assisting customers:',
35
- subsections: [
36
- {
37
- title: 'Tone',
38
- body: 'Be professional, empathetic, and patient.',
39
- },
40
- {
41
- title: 'Escalation',
42
- body: 'If you cannot resolve the issue in 3 attempts, offer to transfer to a human agent.',
43
- },
44
- ],
45
- });
46
-
47
- agent.promptAddSection('Product Info', {
48
- bullets: [
49
- 'Widget Pro - Our flagship product, $99/mo',
50
- 'Widget Lite - Basic tier, $29/mo',
51
- 'Widget Enterprise - Custom pricing',
52
- ],
53
- numbered: true,
54
- });
55
-
56
- // Add a tool for transferring calls
57
- agent.defineTool({
58
- name: 'transfer_to_human',
59
- description: 'Transfer the caller to a human support agent',
60
- parameters: {
61
- reason: { type: 'string', description: 'Reason for the transfer' },
62
- },
63
- handler: (_args) => {
64
- return new FunctionResult('Transferring you to a human agent now.')
65
- .connect('+15551234567');
66
- },
67
- });
68
-
69
- agent.setPostPrompt('Summarize the support interaction including the issue and resolution.');
70
-
71
- agent.run();
@@ -1,47 +0,0 @@
1
- /**
2
- * Concierge Prefab Example
3
- *
4
- * Virtual concierge for a venue. Answers questions about services,
5
- * amenities, and hours, and checks availability and directions.
6
- *
7
- * Run: npx tsx examples/prefab-concierge.ts
8
- */
9
-
10
- import { ConciergeAgent } from '../src/index.js';
11
-
12
- export const agent = new ConciergeAgent({
13
- name: 'hotel-concierge',
14
- venueName: 'Grand Plaza Hotel',
15
- services: [
16
- 'room service',
17
- 'spa bookings',
18
- 'restaurant reservations',
19
- 'airport shuttle',
20
- ],
21
- amenities: {
22
- pool: { hours: '7 AM - 10 PM', location: '2nd Floor (West Wing)' },
23
- gym: { hours: '24 hours', location: '3rd Floor' },
24
- spa: { hours: '9 AM - 8 PM', location: 'Ground Floor' },
25
- 'business center': { hours: '24 hours', location: 'Lobby Level' },
26
- },
27
- hoursOfOperation: {
28
- weekday: '6 AM - 11 PM',
29
- weekend: '7 AM - midnight',
30
- },
31
- specialInstructions: [
32
- 'Encourage guests to ask about our weekly wine tasting event.',
33
- 'Mention our partnership with local attractions when asked for recommendations.',
34
- ],
35
- welcomeMessage: 'Welcome to the Grand Plaza Hotel concierge! How may I assist you today?',
36
- agentOptions: {
37
- route: '/',
38
- basicAuth: [
39
- process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
40
- process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
41
- ],
42
- },
43
- });
44
-
45
- agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
46
-
47
- agent.run();
@@ -1,54 +0,0 @@
1
- /**
2
- * FAQ Bot Prefab Example
3
- *
4
- * Answers frequently asked questions using keyword matching.
5
- * Falls back to escalation if no match is found.
6
- * Run: npx tsx examples/prefab-faq.ts
7
- */
8
-
9
- import { FAQBotAgent } from '../src/index.js';
10
-
11
- export const agent = new FAQBotAgent({
12
- name: 'help-desk',
13
- faqs: [
14
- {
15
- question: 'What are your business hours?',
16
- answer: 'We are open Monday through Friday, 9 AM to 5 PM Eastern Time.',
17
- keywords: ['hours', 'open', 'close', 'schedule', 'when'],
18
- },
19
- {
20
- question: 'How do I reset my password?',
21
- answer: 'Go to the login page and click "Forgot Password". Enter your email and we\'ll send a reset link.',
22
- keywords: ['password', 'reset', 'forgot', 'login', 'access'],
23
- },
24
- {
25
- question: 'What is your return policy?',
26
- answer: 'We accept returns within 30 days of purchase with a valid receipt. Items must be in original condition.',
27
- keywords: ['return', 'refund', 'exchange', 'money back'],
28
- },
29
- {
30
- question: 'How can I track my order?',
31
- answer: 'Log into your account and go to Order History. Click on your order number to see tracking details.',
32
- keywords: ['track', 'order', 'shipping', 'delivery', 'where'],
33
- },
34
- {
35
- question: 'Do you offer international shipping?',
36
- answer: 'Yes, we ship to over 50 countries. International shipping rates are calculated at checkout.',
37
- keywords: ['international', 'shipping', 'overseas', 'global', 'country'],
38
- },
39
- ],
40
- threshold: 0.4,
41
- escalationMessage: 'I couldn\'t find an answer to that. Let me connect you with a team member.',
42
- escalationNumber: '+18005551234',
43
- agentOptions: {
44
- route: '/',
45
- basicAuth: [
46
- process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
47
- process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
48
- ],
49
- },
50
- });
51
-
52
- agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
53
-
54
- agent.run();
@@ -1,33 +0,0 @@
1
- /**
2
- * InfoGatherer Prefab Example
3
- *
4
- * Collects information from callers by asking a sequence of questions.
5
- * Each question has a `key_name` used to store the answer and a
6
- * `question_text` spoken to the caller. The `confirm` flag forces the AI
7
- * to verify the answer before submitting.
8
- *
9
- * Run: npx tsx examples/prefab-info-gatherer.ts
10
- */
11
-
12
- import { InfoGathererAgent } from '../src/index.js';
13
-
14
- export const agent = new InfoGathererAgent({
15
- name: 'intake-agent',
16
- questions: [
17
- { key_name: 'full_name', question_text: 'What is your full name?' },
18
- { key_name: 'email', question_text: 'What is your email address?', confirm: true },
19
- { key_name: 'phone', question_text: 'What is a good callback number?', confirm: true },
20
- { key_name: 'reason', question_text: 'How can we help you today?' },
21
- ],
22
- agentOptions: {
23
- route: '/',
24
- basicAuth: [
25
- process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
26
- process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
27
- ],
28
- },
29
- });
30
-
31
- agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
32
-
33
- agent.run();
@@ -1,36 +0,0 @@
1
- /**
2
- * Receptionist Prefab Example
3
- *
4
- * Front-desk agent that greets callers, collects their name + reason for
5
- * calling, and transfers them to the appropriate department by phone
6
- * number. Optionally supports visitor check-in.
7
- *
8
- * Run: npx tsx examples/prefab-receptionist.ts
9
- */
10
-
11
- import { ReceptionistAgent } from '../src/index.js';
12
-
13
- export const agent = new ReceptionistAgent({
14
- name: 'front-desk',
15
- companyName: 'Acme Technologies',
16
- departments: [
17
- { name: 'engineering', description: 'Software development team', number: '+15551001001' },
18
- { name: 'marketing', description: 'Marketing and communications', number: '+15551001002' },
19
- { name: 'hr', description: 'Hiring and benefits', number: '+15551001003' },
20
- { name: 'finance', description: 'Accounting and finance', number: '+15551001004' },
21
- ],
22
- greeting: 'Welcome to Acme Technologies! How can I help you today?',
23
- checkInEnabled: true,
24
- onVisitorCheckIn: (visitor) => {
25
- console.log('Visitor checked in:', visitor);
26
- },
27
- agentOptions: {
28
- route: '/',
29
- basicAuth: [
30
- process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
31
- process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
32
- ],
33
- },
34
- });
35
-
36
- agent.run();
@@ -1,68 +0,0 @@
1
- /**
2
- * Survey Prefab Example
3
- *
4
- * Conducts a customer satisfaction survey with branching logic.
5
- * Questions branch based on answers (satisfied → ask for details,
6
- * dissatisfied → ask for improvement areas).
7
- * Run: npx tsx examples/prefab-survey.ts
8
- */
9
-
10
- import { SurveyAgent } from '../src/index.js';
11
-
12
- export const agent = new SurveyAgent({
13
- name: 'csat-survey',
14
- surveyName: 'Customer Satisfaction Survey',
15
- questions: [
16
- {
17
- id: 'satisfaction',
18
- text: 'Overall, how satisfied are you with our service?',
19
- type: 'rating',
20
- scale: 10,
21
- points: { '9': 3, '10': 3, '7': 2, '8': 2 },
22
- },
23
- {
24
- id: 'recommend',
25
- text: 'Would you recommend us to a friend or colleague?',
26
- type: 'yes_no',
27
- nextQuestion: {
28
- yes: 'best_part',
29
- no: 'improve',
30
- },
31
- points: { yes: 2, no: 0 },
32
- },
33
- {
34
- id: 'best_part',
35
- text: 'What did you like most about our service?',
36
- type: 'open_ended',
37
- nextQuestion: 'final_comments',
38
- },
39
- {
40
- id: 'improve',
41
- text: 'What area would you most like to see improved?',
42
- type: 'multiple_choice',
43
- options: ['Response time', 'Product quality', 'Customer support', 'Pricing'],
44
- nextQuestion: 'final_comments',
45
- },
46
- {
47
- id: 'final_comments',
48
- text: 'Any other comments or feedback you\'d like to share?',
49
- type: 'open_ended',
50
- },
51
- ],
52
- introduction: 'Thank you for calling! We\'d love your feedback. This survey takes about 2 minutes.',
53
- conclusion: 'Thank you for your feedback! It helps us improve.',
54
- onComplete: (responses, score) => {
55
- console.log('Survey complete:', { responses, score });
56
- },
57
- agentOptions: {
58
- route: '/',
59
- basicAuth: [
60
- process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
61
- process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
62
- ],
63
- },
64
- });
65
-
66
- agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
67
-
68
- agent.run();
@@ -1,67 +0,0 @@
1
- /**
2
- * Record Call Example
3
- *
4
- * Demonstrates call recording with FunctionResult actions:
5
- * recordCall(), stopRecordCall(), and other call-control actions.
6
- * Run: npx tsx examples/record-call.ts
7
- */
8
-
9
- import { AgentBase, FunctionResult } from '../src/index.js';
10
-
11
- export const agent = new AgentBase({
12
- name: 'recording-agent',
13
- route: '/',
14
- basicAuth: [
15
- process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
16
- process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
17
- ],
18
- recordCall: true,
19
- recordFormat: 'mp4',
20
- recordStereo: true,
21
- });
22
-
23
- agent.setPromptText(
24
- 'You are a customer service agent. All calls are recorded for quality assurance. ' +
25
- 'If the caller asks, you can pause or stop the recording.',
26
- );
27
-
28
- agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
29
-
30
- agent.defineTool({
31
- name: 'start_recording',
32
- description: 'Start or resume call recording',
33
- parameters: {},
34
- handler: () => {
35
- const result = new FunctionResult('Recording has been started.');
36
- result.recordCall({ stereo: true, format: 'mp3' });
37
- return result;
38
- },
39
- });
40
-
41
- agent.defineTool({
42
- name: 'stop_recording',
43
- description: 'Stop call recording when the caller requests it',
44
- parameters: {},
45
- handler: () => {
46
- const result = new FunctionResult('Recording has been stopped.');
47
- result.stopRecordCall();
48
- return result;
49
- },
50
- });
51
-
52
- agent.defineTool({
53
- name: 'transfer_to_supervisor',
54
- description: 'Transfer the caller to a supervisor',
55
- parameters: {
56
- reason: { type: 'string', description: 'Reason for the transfer' },
57
- },
58
- handler: (args) => {
59
- const result = new FunctionResult(
60
- `Transferring you to a supervisor. Reason: ${args.reason}`,
61
- );
62
- result.connect('+18005551234');
63
- return result;
64
- },
65
- });
66
-
67
- agent.run();
@@ -1,33 +0,0 @@
1
- /**
2
- * RELAY Demo -- Answer and Welcome
3
- *
4
- * Demonstrates using the RELAY WebSocket client to answer an inbound call
5
- * and play a TTS greeting.
6
- *
7
- * Required env vars:
8
- * SIGNALWIRE_PROJECT_ID, SIGNALWIRE_API_TOKEN, SIGNALWIRE_SPACE
9
- *
10
- * Run: npx tsx examples/relay-demo.ts
11
- */
12
-
13
- import { RelayClient } from '../src/index.js';
14
-
15
- const client = new RelayClient({
16
- contexts: ['default'],
17
- });
18
-
19
- client.onCall(async (call) => {
20
- console.log(`Incoming call: ${call.id}`);
21
- await call.answer();
22
-
23
- const action = await call.play([
24
- { type: 'tts', params: { text: 'Welcome to SignalWire! This is a RELAY demo.' } },
25
- ]);
26
- await action.wait();
27
-
28
- await call.hangup();
29
- console.log(`Call ended: ${call.id}`);
30
- });
31
-
32
- console.log('Waiting for inbound calls on context "default" ...');
33
- client.run();
@@ -1,94 +0,0 @@
1
- /**
2
- * Room and SIP Actions Example
3
- *
4
- * Demonstrates FunctionResult actions for room joining,
5
- * SIP REFER transfers, and conference management.
6
- * Run: npx tsx examples/room-and-sip.ts
7
- */
8
-
9
- import { AgentBase, FunctionResult } from '../src/index.js';
10
-
11
- export const agent = new AgentBase({
12
- name: 'room-sip-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 meeting coordinator. You can help callers join rooms, ' +
22
- 'transfer calls via SIP, and manage conferences.',
23
- );
24
-
25
- // Join a SignalWire room
26
- agent.defineTool({
27
- name: 'join_meeting_room',
28
- description: 'Join a meeting room by name',
29
- parameters: {
30
- room_name: { type: 'string', description: 'Name of the meeting room' },
31
- },
32
- handler: (args) => {
33
- const result = new FunctionResult(
34
- `Connecting you to room "${args.room_name}" now.`,
35
- );
36
- result.joinRoom(args.room_name as string);
37
- return result;
38
- },
39
- });
40
-
41
- // Transfer via SIP REFER
42
- agent.defineTool({
43
- name: 'sip_transfer',
44
- description: 'Transfer the call to a SIP URI',
45
- parameters: {
46
- sip_uri: { type: 'string', description: 'SIP URI to transfer to (e.g., sip:user@domain.com)' },
47
- },
48
- handler: (args) => {
49
- const result = new FunctionResult(
50
- `Transferring your call to ${args.sip_uri}.`,
51
- );
52
- result.sipRefer(args.sip_uri as string);
53
- return result;
54
- },
55
- });
56
-
57
- // Join a conference call
58
- agent.defineTool({
59
- name: 'join_conference',
60
- description: 'Join a named conference call',
61
- parameters: {
62
- conference_name: { type: 'string', description: 'Conference name to join' },
63
- muted: { type: 'boolean', description: 'Whether to join muted (default: false)' },
64
- },
65
- handler: (args) => {
66
- const muted = args.muted === true;
67
- const result = new FunctionResult(
68
- `Joining conference "${args.conference_name}"${muted ? ' (muted)' : ''}.`,
69
- );
70
- result.joinConference(args.conference_name as string, { muted });
71
- return result;
72
- },
73
- });
74
-
75
- // Connect to a phone number
76
- agent.defineTool({
77
- name: 'connect_call',
78
- description: 'Connect the call to a phone number',
79
- parameters: {
80
- phone_number: { type: 'string', description: 'Phone number to connect to' },
81
- },
82
- handler: (args) => {
83
- const result = new FunctionResult(
84
- `Connecting you to ${args.phone_number}. Please hold.`,
85
- );
86
- result.connect(args.phone_number as string);
87
- return result;
88
- },
89
- });
90
-
91
- agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
92
- agent.addHints(['SIP', 'conference', 'meeting room', 'transfer']);
93
-
94
- agent.run();
@@ -1,35 +0,0 @@
1
- /**
2
- * Serverless Lambda Example
3
- *
4
- * Deploy an agent on AWS Lambda using ServerlessAdapter.
5
- * The adapter converts Lambda events to/from standard HTTP requests.
6
- * Run: npx tsx examples/serverless-lambda.ts
7
- */
8
-
9
- import { AgentBase, ServerlessAdapter, FunctionResult } from '../src/index.js';
10
-
11
- // Create the agent as usual
12
- export const agent = new AgentBase({
13
- name: 'lambda-agent',
14
- route: '/',
15
- basicAuth: [
16
- process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
17
- process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
18
- ],
19
- });
20
-
21
- agent.setPromptText('You are a helpful assistant deployed on AWS Lambda.');
22
- agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
23
-
24
- agent.defineTool({
25
- name: 'get_time',
26
- description: 'Get the current time',
27
- parameters: {},
28
- handler: () => new FunctionResult(`The time is ${new Date().toISOString()}`),
29
- });
30
-
31
- // Create a Lambda handler from the agent's Hono app
32
- export const handler = ServerlessAdapter.createLambdaHandler(agent.getApp());
33
-
34
- // For local development, run the agent normally
35
- agent.run();
@@ -1,83 +0,0 @@
1
- /**
2
- * Session State Example
3
- *
4
- * Demonstrates onSummary callback for post-call processing,
5
- * global data for per-call context, and post-prompt instructions.
6
- * Run: npx tsx examples/session-state.ts
7
- */
8
-
9
- import { AgentBase, FunctionResult } from '../src/index.js';
10
- import type { AgentOptions } from '../src/index.js';
11
-
12
- class OrderAgent extends AgentBase {
13
- static override PROMPT_SECTIONS = [
14
- {
15
- title: 'Role',
16
- body: 'You are an order status assistant. Help callers check the status of their orders and update shipping preferences.',
17
- },
18
- {
19
- title: 'Rules',
20
- bullets: [
21
- 'Always ask for the order number first.',
22
- 'Use the lookup_order tool to find order details.',
23
- 'Confirm changes before applying them.',
24
- ],
25
- },
26
- ];
27
-
28
- constructor(opts: AgentOptions) {
29
- super(opts);
30
- this.defineTools();
31
- }
32
-
33
- protected override defineTools(): void {
34
- this.defineTool({
35
- name: 'lookup_order',
36
- description: 'Look up an order by its order number',
37
- parameters: {
38
- order_number: { type: 'string', description: 'The order number (e.g., ORD-12345)' },
39
- },
40
- handler: (args, rawData) => {
41
- // Store the order number in global data for the post-prompt summary
42
- this.updateGlobalData({
43
- last_order_number: args.order_number,
44
- call_id: rawData['call_id'],
45
- });
46
- return new FunctionResult(
47
- `Order ${args.order_number}: Status: Shipped, ETA: 2 business days, Carrier: FedEx`,
48
- );
49
- },
50
- });
51
- }
52
-
53
- override async onSummary(
54
- summary: Record<string, unknown> | null,
55
- rawData: Record<string, unknown>,
56
- ): Promise<void> {
57
- console.log('=== Call Summary ===');
58
- console.log('Call ID:', rawData['call_id']);
59
- console.log('Summary:', JSON.stringify(summary, null, 2));
60
- console.log('===================');
61
- }
62
- }
63
-
64
- export const agent = new OrderAgent({
65
- name: 'order-agent',
66
- route: '/',
67
- basicAuth: [
68
- process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
69
- process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
70
- ],
71
- });
72
-
73
- // Global data available to the AI throughout the call
74
- agent.setGlobalData({ company: 'Acme Corp', support_hours: '9am-5pm EST' });
75
-
76
- // Post-prompt instructs the AI to generate a structured summary
77
- agent.setPostPrompt(
78
- 'Summarize this call as JSON: { caller_intent, order_numbers_discussed, actions_taken, follow_up_needed }',
79
- );
80
-
81
- agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
82
-
83
- agent.run();
@@ -1,36 +0,0 @@
1
- /**
2
- * Simple Agent Example
3
- *
4
- * A minimal AI voice agent that answers calls and responds to questions.
5
- * Run: npx tsx examples/simple-agent.ts
6
- * Test: curl http://user:pass@localhost:3000/
7
- */
8
-
9
- import { AgentBase, FunctionResult } from '../src/index.js';
10
-
11
- export const agent = new AgentBase({
12
- name: 'simple-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('You are a friendly assistant named Siggy. Help callers with their questions.');
21
-
22
- agent.addHints(['SignalWire', 'SWML', 'Siggy']);
23
- agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
24
-
25
- // Define a tool the AI can call
26
- agent.defineTool({
27
- name: 'get_time',
28
- description: 'Get the current date and time',
29
- parameters: {},
30
- handler: () => {
31
- const now = new Date().toLocaleString();
32
- return new FunctionResult(`The current date and time is ${now}`);
33
- },
34
- });
35
-
36
- agent.run();