@signalwire/sdk 2.0.1 → 2.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (610) hide show
  1. package/dist/AgentBase.d.ts +1045 -0
  2. package/dist/AgentBase.js +2375 -0
  3. package/dist/AgentBase.js.map +1 -0
  4. package/dist/AgentServer.d.ts +146 -0
  5. package/dist/AgentServer.js +388 -0
  6. package/dist/AgentServer.js.map +1 -0
  7. package/dist/AuthHandler.d.ts +127 -0
  8. package/dist/AuthHandler.js +212 -0
  9. package/dist/AuthHandler.js.map +1 -0
  10. package/dist/ConfigLoader.d.ts +170 -0
  11. package/dist/ConfigLoader.js +393 -0
  12. package/dist/ConfigLoader.js.map +1 -0
  13. package/dist/ContextBuilder.d.ts +652 -0
  14. package/dist/ContextBuilder.js +1115 -0
  15. package/dist/ContextBuilder.js.map +1 -0
  16. package/dist/DataMap.d.ts +271 -0
  17. package/dist/DataMap.js +430 -0
  18. package/dist/DataMap.js.map +1 -0
  19. package/dist/FunctionResult.d.ts +481 -0
  20. package/dist/FunctionResult.js +775 -0
  21. package/dist/FunctionResult.js.map +1 -0
  22. package/dist/Logger.d.ts +113 -0
  23. package/dist/Logger.js +320 -0
  24. package/dist/Logger.js.map +1 -0
  25. package/dist/PomBuilder.d.ts +208 -0
  26. package/dist/PomBuilder.js +409 -0
  27. package/dist/PomBuilder.js.map +1 -0
  28. package/dist/PromptManager.d.ts +85 -0
  29. package/dist/PromptManager.js +108 -0
  30. package/dist/PromptManager.js.map +1 -0
  31. package/dist/SWMLHandler.d.ts +159 -0
  32. package/dist/SWMLHandler.js +229 -0
  33. package/dist/SWMLHandler.js.map +1 -0
  34. package/dist/SWMLService.d.ts +326 -0
  35. package/dist/SWMLService.js +610 -0
  36. package/dist/SWMLService.js.map +1 -0
  37. package/dist/SchemaUtils.d.ts +108 -0
  38. package/dist/SchemaUtils.js +317 -0
  39. package/dist/SchemaUtils.js.map +1 -0
  40. package/dist/SecurityUtils.d.ts +60 -0
  41. package/{src/SecurityUtils.ts → dist/SecurityUtils.js} +82 -83
  42. package/dist/SecurityUtils.js.map +1 -0
  43. package/dist/ServerlessAdapter.d.ts +119 -0
  44. package/dist/ServerlessAdapter.js +188 -0
  45. package/dist/ServerlessAdapter.js.map +1 -0
  46. package/dist/SessionManager.d.ts +142 -0
  47. package/dist/SessionManager.js +260 -0
  48. package/dist/SessionManager.js.map +1 -0
  49. package/dist/SslConfig.d.ts +77 -0
  50. package/dist/SslConfig.js +100 -0
  51. package/dist/SslConfig.js.map +1 -0
  52. package/dist/SwaigFunction.d.ts +159 -0
  53. package/dist/SwaigFunction.js +209 -0
  54. package/dist/SwaigFunction.js.map +1 -0
  55. package/dist/SwmlBuilder.d.ts +165 -0
  56. package/dist/SwmlBuilder.js +247 -0
  57. package/dist/SwmlBuilder.js.map +1 -0
  58. package/dist/SwmlVerbMethods.generated.d.ts +254 -0
  59. package/dist/SwmlVerbMethods.generated.js +9 -0
  60. package/dist/SwmlVerbMethods.generated.js.map +1 -0
  61. package/dist/TypeInference.d.ts +71 -0
  62. package/dist/TypeInference.js +164 -0
  63. package/dist/TypeInference.js.map +1 -0
  64. package/dist/WebService.d.ts +148 -0
  65. package/dist/WebService.js +532 -0
  66. package/dist/WebService.js.map +1 -0
  67. package/dist/cli/agent-loader.d.ts +22 -0
  68. package/dist/cli/agent-loader.js +144 -0
  69. package/dist/cli/agent-loader.js.map +1 -0
  70. package/dist/cli/mock-data.d.ts +37 -0
  71. package/dist/cli/mock-data.js +80 -0
  72. package/dist/cli/mock-data.js.map +1 -0
  73. package/dist/cli/swaig-test.d.ts +32 -0
  74. package/dist/cli/swaig-test.js +418 -0
  75. package/dist/cli/swaig-test.js.map +1 -0
  76. package/dist/generateVerbTypes.d.ts +11 -0
  77. package/dist/generateVerbTypes.js +265 -0
  78. package/dist/generateVerbTypes.js.map +1 -0
  79. package/{src/index.ts → dist/index.d.ts} +13 -100
  80. package/dist/index.js +152 -0
  81. package/dist/index.js.map +1 -0
  82. package/dist/livewire/index.d.ts +653 -0
  83. package/dist/livewire/index.js +992 -0
  84. package/dist/livewire/index.js.map +1 -0
  85. package/dist/prefabs/ConciergeAgent.d.ts +89 -0
  86. package/dist/prefabs/ConciergeAgent.js +245 -0
  87. package/dist/prefabs/ConciergeAgent.js.map +1 -0
  88. package/dist/prefabs/FAQBotAgent.d.ts +113 -0
  89. package/dist/prefabs/FAQBotAgent.js +329 -0
  90. package/dist/prefabs/FAQBotAgent.js.map +1 -0
  91. package/dist/prefabs/InfoGathererAgent.d.ts +126 -0
  92. package/dist/prefabs/InfoGathererAgent.js +287 -0
  93. package/dist/prefabs/InfoGathererAgent.js.map +1 -0
  94. package/dist/prefabs/ReceptionistAgent.d.ts +104 -0
  95. package/dist/prefabs/ReceptionistAgent.js +303 -0
  96. package/dist/prefabs/ReceptionistAgent.js.map +1 -0
  97. package/dist/prefabs/SurveyAgent.d.ts +148 -0
  98. package/dist/prefabs/SurveyAgent.js +540 -0
  99. package/dist/prefabs/SurveyAgent.js.map +1 -0
  100. package/{src/prefabs/index.ts → dist/prefabs/index.d.ts} +1 -15
  101. package/dist/prefabs/index.js +14 -0
  102. package/dist/prefabs/index.js.map +1 -0
  103. package/dist/relay/Action.d.ts +258 -0
  104. package/dist/relay/Action.js +402 -0
  105. package/dist/relay/Action.js.map +1 -0
  106. package/dist/relay/Call.d.ts +697 -0
  107. package/dist/relay/Call.js +1062 -0
  108. package/dist/relay/Call.js.map +1 -0
  109. package/dist/relay/Deferred.d.ts +44 -0
  110. package/dist/relay/Deferred.js +69 -0
  111. package/dist/relay/Deferred.js.map +1 -0
  112. package/dist/relay/Message.d.ts +103 -0
  113. package/dist/relay/Message.js +169 -0
  114. package/dist/relay/Message.js.map +1 -0
  115. package/dist/relay/RelayClient.d.ts +302 -0
  116. package/dist/relay/RelayClient.js +1026 -0
  117. package/dist/relay/RelayClient.js.map +1 -0
  118. package/dist/relay/RelayError.d.ts +15 -0
  119. package/dist/relay/RelayError.js +20 -0
  120. package/dist/relay/RelayError.js.map +1 -0
  121. package/dist/relay/RelayEvent.d.ts +254 -0
  122. package/dist/relay/RelayEvent.js +509 -0
  123. package/dist/relay/RelayEvent.js.map +1 -0
  124. package/dist/relay/constants.d.ts +90 -0
  125. package/{src/relay/constants.ts → dist/relay/constants.js} +11 -29
  126. package/dist/relay/constants.js.map +1 -0
  127. package/dist/relay/index.d.ts +16 -0
  128. package/dist/relay/index.js +18 -0
  129. package/dist/relay/index.js.map +1 -0
  130. package/dist/relay/types.d.ts +142 -0
  131. package/dist/relay/types.js +5 -0
  132. package/dist/relay/types.js.map +1 -0
  133. package/dist/rest/HttpClient.d.ts +80 -0
  134. package/dist/rest/HttpClient.js +148 -0
  135. package/dist/rest/HttpClient.js.map +1 -0
  136. package/dist/rest/RestError.d.ts +30 -0
  137. package/dist/rest/RestError.js +39 -0
  138. package/dist/rest/RestError.js.map +1 -0
  139. package/dist/rest/base/BaseResource.d.ts +24 -0
  140. package/dist/rest/base/BaseResource.js +29 -0
  141. package/dist/rest/base/BaseResource.js.map +1 -0
  142. package/dist/rest/base/CrudResource.d.ts +68 -0
  143. package/dist/rest/base/CrudResource.js +82 -0
  144. package/dist/rest/base/CrudResource.js.map +1 -0
  145. package/dist/rest/base/CrudWithAddresses.d.ts +22 -0
  146. package/dist/rest/base/CrudWithAddresses.js +25 -0
  147. package/dist/rest/base/CrudWithAddresses.js.map +1 -0
  148. package/dist/rest/index.d.ts +131 -0
  149. package/{src/rest/index.ts → dist/rest/index.js} +101 -136
  150. package/dist/rest/index.js.map +1 -0
  151. package/dist/rest/namespaces/addresses.d.ts +46 -0
  152. package/dist/rest/namespaces/addresses.js +55 -0
  153. package/dist/rest/namespaces/addresses.js.map +1 -0
  154. package/dist/rest/namespaces/calling.d.ts +382 -0
  155. package/dist/rest/namespaces/calling.js +478 -0
  156. package/dist/rest/namespaces/calling.js.map +1 -0
  157. package/dist/rest/namespaces/chat.d.ts +22 -0
  158. package/dist/rest/namespaces/chat.js +26 -0
  159. package/dist/rest/namespaces/chat.js.map +1 -0
  160. package/dist/rest/namespaces/compat.d.ts +585 -0
  161. package/dist/rest/namespaces/compat.js +735 -0
  162. package/dist/rest/namespaces/compat.js.map +1 -0
  163. package/dist/rest/namespaces/datasphere.d.ts +66 -0
  164. package/dist/rest/namespaces/datasphere.js +77 -0
  165. package/dist/rest/namespaces/datasphere.js.map +1 -0
  166. package/dist/rest/namespaces/fabric.d.ts +282 -0
  167. package/dist/rest/namespaces/fabric.js +373 -0
  168. package/dist/rest/namespaces/fabric.js.map +1 -0
  169. package/dist/rest/namespaces/imported-numbers.d.ts +22 -0
  170. package/dist/rest/namespaces/imported-numbers.js +26 -0
  171. package/dist/rest/namespaces/imported-numbers.js.map +1 -0
  172. package/dist/rest/namespaces/logs.d.ts +105 -0
  173. package/dist/rest/namespaces/logs.js +133 -0
  174. package/dist/rest/namespaces/logs.js.map +1 -0
  175. package/dist/rest/namespaces/lookup.d.ts +29 -0
  176. package/dist/rest/namespaces/lookup.js +32 -0
  177. package/dist/rest/namespaces/lookup.js.map +1 -0
  178. package/dist/rest/namespaces/mfa.d.ts +46 -0
  179. package/dist/rest/namespaces/mfa.js +54 -0
  180. package/dist/rest/namespaces/mfa.js.map +1 -0
  181. package/dist/rest/namespaces/number-groups.d.ts +49 -0
  182. package/dist/rest/namespaces/number-groups.js +58 -0
  183. package/dist/rest/namespaces/number-groups.js.map +1 -0
  184. package/dist/rest/namespaces/phone-numbers.d.ts +60 -0
  185. package/dist/rest/namespaces/phone-numbers.js +67 -0
  186. package/dist/rest/namespaces/phone-numbers.js.map +1 -0
  187. package/dist/rest/namespaces/project.d.ts +46 -0
  188. package/dist/rest/namespaces/project.js +56 -0
  189. package/dist/rest/namespaces/project.js.map +1 -0
  190. package/dist/rest/namespaces/pubsub.d.ts +22 -0
  191. package/dist/rest/namespaces/pubsub.js +26 -0
  192. package/dist/rest/namespaces/pubsub.js.map +1 -0
  193. package/dist/rest/namespaces/queues.d.ts +42 -0
  194. package/dist/rest/namespaces/queues.js +49 -0
  195. package/dist/rest/namespaces/queues.js.map +1 -0
  196. package/dist/rest/namespaces/recordings.d.ts +38 -0
  197. package/dist/rest/namespaces/recordings.js +45 -0
  198. package/dist/rest/namespaces/recordings.js.map +1 -0
  199. package/dist/rest/namespaces/registry.d.ts +141 -0
  200. package/dist/rest/namespaces/registry.js +178 -0
  201. package/dist/rest/namespaces/registry.js.map +1 -0
  202. package/dist/rest/namespaces/short-codes.d.ts +39 -0
  203. package/dist/rest/namespaces/short-codes.js +46 -0
  204. package/dist/rest/namespaces/short-codes.js.map +1 -0
  205. package/dist/rest/namespaces/sip-profile.d.ts +28 -0
  206. package/dist/rest/namespaces/sip-profile.js +34 -0
  207. package/dist/rest/namespaces/sip-profile.js.map +1 -0
  208. package/dist/rest/namespaces/verified-callers.d.ts +33 -0
  209. package/dist/rest/namespaces/verified-callers.js +39 -0
  210. package/dist/rest/namespaces/verified-callers.js.map +1 -0
  211. package/dist/rest/namespaces/video.d.ts +235 -0
  212. package/dist/rest/namespaces/video.js +297 -0
  213. package/dist/rest/namespaces/video.js.map +1 -0
  214. package/{src/rest/pagination.ts → dist/rest/pagination.d.ts} +2 -61
  215. package/dist/rest/pagination.js +78 -0
  216. package/dist/rest/pagination.js.map +1 -0
  217. package/dist/rest/types.d.ts +54 -0
  218. package/dist/rest/types.js +5 -0
  219. package/dist/rest/types.js.map +1 -0
  220. package/dist/skills/SkillBase.d.ts +404 -0
  221. package/dist/skills/SkillBase.js +471 -0
  222. package/dist/skills/SkillBase.js.map +1 -0
  223. package/dist/skills/SkillManager.d.ts +195 -0
  224. package/dist/skills/SkillManager.js +378 -0
  225. package/dist/skills/SkillManager.js.map +1 -0
  226. package/dist/skills/SkillRegistry.d.ts +176 -0
  227. package/dist/skills/SkillRegistry.js +310 -0
  228. package/dist/skills/SkillRegistry.js.map +1 -0
  229. package/dist/skills/builtin/api_ninjas_trivia.d.ts +47 -0
  230. package/dist/skills/builtin/api_ninjas_trivia.js +211 -0
  231. package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -0
  232. package/dist/skills/builtin/ask_claude.d.ts +37 -0
  233. package/dist/skills/builtin/ask_claude.js +162 -0
  234. package/dist/skills/builtin/ask_claude.js.map +1 -0
  235. package/dist/skills/builtin/claude_skills.d.ts +75 -0
  236. package/dist/skills/builtin/claude_skills.js +753 -0
  237. package/dist/skills/builtin/claude_skills.js.map +1 -0
  238. package/dist/skills/builtin/custom_skills.d.ts +79 -0
  239. package/dist/skills/builtin/custom_skills.js +227 -0
  240. package/dist/skills/builtin/custom_skills.js.map +1 -0
  241. package/dist/skills/builtin/datasphere.d.ts +73 -0
  242. package/dist/skills/builtin/datasphere.js +350 -0
  243. package/dist/skills/builtin/datasphere.js.map +1 -0
  244. package/dist/skills/builtin/datasphere_serverless.d.ts +89 -0
  245. package/dist/skills/builtin/datasphere_serverless.js +291 -0
  246. package/dist/skills/builtin/datasphere_serverless.js.map +1 -0
  247. package/dist/skills/builtin/datetime.d.ts +40 -0
  248. package/dist/skills/builtin/datetime.js +118 -0
  249. package/dist/skills/builtin/datetime.js.map +1 -0
  250. package/dist/skills/builtin/google_maps.d.ts +48 -0
  251. package/dist/skills/builtin/google_maps.js +470 -0
  252. package/dist/skills/builtin/google_maps.js.map +1 -0
  253. package/dist/skills/builtin/index.d.ts +31 -0
  254. package/{src/skills/builtin/index.ts → dist/skills/builtin/index.js} +30 -36
  255. package/dist/skills/builtin/index.js.map +1 -0
  256. package/dist/skills/builtin/info_gatherer.d.ts +115 -0
  257. package/dist/skills/builtin/info_gatherer.js +328 -0
  258. package/dist/skills/builtin/info_gatherer.js.map +1 -0
  259. package/dist/skills/builtin/joke.d.ts +41 -0
  260. package/dist/skills/builtin/joke.js +156 -0
  261. package/dist/skills/builtin/joke.js.map +1 -0
  262. package/dist/skills/builtin/math.d.ts +39 -0
  263. package/dist/skills/builtin/math.js +119 -0
  264. package/dist/skills/builtin/math.js.map +1 -0
  265. package/dist/skills/builtin/mcp_gateway.d.ts +82 -0
  266. package/dist/skills/builtin/mcp_gateway.js +574 -0
  267. package/dist/skills/builtin/mcp_gateway.js.map +1 -0
  268. package/dist/skills/builtin/native_vector_search.d.ts +128 -0
  269. package/dist/skills/builtin/native_vector_search.js +752 -0
  270. package/dist/skills/builtin/native_vector_search.js.map +1 -0
  271. package/dist/skills/builtin/play_background_file.d.ts +59 -0
  272. package/dist/skills/builtin/play_background_file.js +274 -0
  273. package/dist/skills/builtin/play_background_file.js.map +1 -0
  274. package/dist/skills/builtin/spider.d.ts +91 -0
  275. package/dist/skills/builtin/spider.js +758 -0
  276. package/dist/skills/builtin/spider.js.map +1 -0
  277. package/dist/skills/builtin/swml_transfer.d.ts +66 -0
  278. package/dist/skills/builtin/swml_transfer.js +475 -0
  279. package/dist/skills/builtin/swml_transfer.js.map +1 -0
  280. package/dist/skills/builtin/weather_api.d.ts +59 -0
  281. package/dist/skills/builtin/weather_api.js +196 -0
  282. package/dist/skills/builtin/weather_api.js.map +1 -0
  283. package/dist/skills/builtin/web_search.d.ts +160 -0
  284. package/dist/skills/builtin/web_search.js +894 -0
  285. package/dist/skills/builtin/web_search.js.map +1 -0
  286. package/dist/skills/builtin/wikipedia_search.d.ts +77 -0
  287. package/dist/skills/builtin/wikipedia_search.js +241 -0
  288. package/dist/skills/builtin/wikipedia_search.js.map +1 -0
  289. package/{src/skills/index.ts → dist/skills/index.d.ts} +0 -1
  290. package/dist/skills/index.js +10 -0
  291. package/dist/skills/index.js.map +1 -0
  292. package/dist/types.d.ts +118 -0
  293. package/dist/types.js +5 -0
  294. package/dist/types.js.map +1 -0
  295. package/package.json +7 -1
  296. package/.github/workflows/publish.yml +0 -27
  297. package/.github/workflows/test.yml +0 -17
  298. package/CLAUDE.md +0 -112
  299. package/docs/MIGRATION-2.0.md +0 -81
  300. package/docs/agent-guide.md +0 -869
  301. package/docs/agent_guide.md +0 -1026
  302. package/docs/api-reference.md +0 -2420
  303. package/docs/api_reference.md +0 -1301
  304. package/docs/architecture.md +0 -843
  305. package/docs/cli-guide.md +0 -579
  306. package/docs/cli_guide.md +0 -448
  307. package/docs/cloud_functions_guide.md +0 -474
  308. package/docs/configuration.md +0 -422
  309. package/docs/contexts-guide.md +0 -787
  310. package/docs/contexts_guide.md +0 -511
  311. package/docs/datamap-guide.md +0 -1141
  312. package/docs/datamap_guide.md +0 -595
  313. package/docs/llm_parameters.md +0 -239
  314. package/docs/mcp_gateway_reference.md +0 -648
  315. package/docs/mcp_integration.md +0 -108
  316. package/docs/prefabs-guide.md +0 -800
  317. package/docs/sdk_features.md +0 -477
  318. package/docs/security.md +0 -436
  319. package/docs/serverless-guide.md +0 -513
  320. package/docs/skills-guide.md +0 -857
  321. package/docs/skills-system.md +0 -301
  322. package/docs/skills_parameter_schema.md +0 -392
  323. package/docs/skills_system.md +0 -467
  324. package/docs/swaig-reference.md +0 -1627
  325. package/docs/swaig_reference.md +0 -910
  326. package/docs/swml_service_guide.md +0 -600
  327. package/docs/third_party_skills.md +0 -533
  328. package/docs/web_service.md +0 -677
  329. package/examples/README.md +0 -131
  330. package/examples/advanced-datamap.ts +0 -100
  331. package/examples/advanced-dynamic-config.ts +0 -70
  332. package/examples/auto-vivified.ts +0 -94
  333. package/examples/call-flow.ts +0 -63
  334. package/examples/comprehensive-dynamic.ts +0 -125
  335. package/examples/contexts-steps.ts +0 -65
  336. package/examples/custom-path.ts +0 -45
  337. package/examples/datamap-tools.ts +0 -55
  338. package/examples/datasphere-multi-instance.ts +0 -63
  339. package/examples/datasphere-serverless-env.ts +0 -68
  340. package/examples/datasphere-webhook-env.ts +0 -66
  341. package/examples/datasphere.ts +0 -37
  342. package/examples/declarative.ts +0 -100
  343. package/examples/dynamic-config.ts +0 -54
  344. package/examples/dynamic-info-gatherer.ts +0 -69
  345. package/examples/dynamic-swml-service.ts +0 -67
  346. package/examples/gather-info.ts +0 -71
  347. package/examples/gather-per-question-functions-demo.ts +0 -140
  348. package/examples/joke-agent.ts +0 -34
  349. package/examples/kubernetes-agent.ts +0 -45
  350. package/examples/llm-params.ts +0 -69
  351. package/examples/mcp-agent.ts +0 -84
  352. package/examples/mcp-gateway.ts +0 -35
  353. package/examples/multi-agent.ts +0 -73
  354. package/examples/multi-endpoint.ts +0 -79
  355. package/examples/pom-prompt.ts +0 -71
  356. package/examples/prefab-concierge.ts +0 -47
  357. package/examples/prefab-faq.ts +0 -54
  358. package/examples/prefab-info-gatherer.ts +0 -33
  359. package/examples/prefab-receptionist.ts +0 -36
  360. package/examples/prefab-survey.ts +0 -68
  361. package/examples/record-call.ts +0 -67
  362. package/examples/relay-demo.ts +0 -33
  363. package/examples/room-and-sip.ts +0 -94
  364. package/examples/serverless-lambda.ts +0 -35
  365. package/examples/session-state.ts +0 -83
  366. package/examples/simple-agent.ts +0 -36
  367. package/examples/simple-static.ts +0 -29
  368. package/examples/skills-demo.ts +0 -38
  369. package/examples/step-function-inheritance-demo.ts +0 -124
  370. package/examples/swaig-features.ts +0 -187
  371. package/examples/swml-service-routing.ts +0 -66
  372. package/examples/swml-service.ts +0 -38
  373. package/examples/tap.ts +0 -68
  374. package/examples/verb-methods.ts +0 -45
  375. package/examples/web-search-multi-instance.ts +0 -72
  376. package/examples/web-search.ts +0 -38
  377. package/examples/wikipedia.ts +0 -36
  378. package/livewire/README.md +0 -140
  379. package/livewire/docs/migration-guide.md +0 -228
  380. package/livewire/examples/livewire-basic-agent.ts +0 -74
  381. package/livewire/examples/livewire-handoff.ts +0 -197
  382. package/livewire/examples/livewire-multi-tool.ts +0 -117
  383. package/relay/README.md +0 -70
  384. package/relay/RELAY_IMPLEMENTATION_GUIDE.md +0 -1257
  385. package/relay/docs/call-methods.md +0 -474
  386. package/relay/docs/client-reference.md +0 -142
  387. package/relay/docs/events.md +0 -134
  388. package/relay/docs/getting-started.md +0 -134
  389. package/relay/docs/guide.md +0 -306
  390. package/relay/docs/messaging.md +0 -182
  391. package/relay/examples/relay-inbound.ts +0 -66
  392. package/relay/examples/relay-messaging.ts +0 -71
  393. package/relay/examples/relay-outbound.ts +0 -76
  394. package/rest/README.md +0 -95
  395. package/rest/docs/calling.md +0 -273
  396. package/rest/docs/client-reference.md +0 -107
  397. package/rest/docs/compat.md +0 -204
  398. package/rest/docs/fabric.md +0 -183
  399. package/rest/docs/getting-started.md +0 -110
  400. package/rest/docs/guide.md +0 -351
  401. package/rest/docs/namespaces.md +0 -285
  402. package/rest/examples/rest-10dlc-registration.ts +0 -161
  403. package/rest/examples/rest-calling-ivr-and-ai.ts +0 -102
  404. package/rest/examples/rest-calling-play-and-record.ts +0 -91
  405. package/rest/examples/rest-client.ts +0 -65
  406. package/rest/examples/rest-compat-laml.ts +0 -210
  407. package/rest/examples/rest-datasphere-search.ts +0 -82
  408. package/rest/examples/rest-fabric-conferences-and-routing.ts +0 -144
  409. package/rest/examples/rest-fabric-subscribers-and-sip.ts +0 -108
  410. package/rest/examples/rest-fabric-swml-and-callflows.ts +0 -99
  411. package/rest/examples/rest-manage-resources.ts +0 -65
  412. package/rest/examples/rest-phone-number-management.ts +0 -197
  413. package/rest/examples/rest-queues-mfa-and-recordings.ts +0 -143
  414. package/rest/examples/rest-video-rooms.ts +0 -186
  415. package/src/AgentBase.ts +0 -2598
  416. package/src/AgentServer.ts +0 -442
  417. package/src/AuthHandler.ts +0 -256
  418. package/src/ConfigLoader.ts +0 -447
  419. package/src/ContextBuilder.ts +0 -1181
  420. package/src/DataMap.ts +0 -477
  421. package/src/FunctionResult.ts +0 -903
  422. package/src/Logger.ts +0 -337
  423. package/src/PomBuilder.ts +0 -467
  424. package/src/PromptManager.ts +0 -133
  425. package/src/SWMLHandler.ts +0 -298
  426. package/src/SWMLService.ts +0 -749
  427. package/src/SchemaUtils.ts +0 -361
  428. package/src/ServerlessAdapter.ts +0 -240
  429. package/src/SessionManager.ts +0 -311
  430. package/src/SslConfig.ts +0 -118
  431. package/src/SwaigFunction.ts +0 -276
  432. package/src/SwmlBuilder.ts +0 -283
  433. package/src/SwmlVerbMethods.generated.ts +0 -234
  434. package/src/TypeInference.ts +0 -199
  435. package/src/WebService.ts +0 -641
  436. package/src/cli/agent-loader.ts +0 -166
  437. package/src/cli/mock-data.ts +0 -111
  438. package/src/cli/swaig-test.ts +0 -452
  439. package/src/generateVerbTypes.ts +0 -322
  440. package/src/livewire/index.ts +0 -1252
  441. package/src/prefabs/ConciergeAgent.ts +0 -309
  442. package/src/prefabs/FAQBotAgent.ts +0 -415
  443. package/src/prefabs/InfoGathererAgent.ts +0 -379
  444. package/src/prefabs/ReceptionistAgent.ts +0 -395
  445. package/src/prefabs/SurveyAgent.ts +0 -671
  446. package/src/relay/Action.ts +0 -482
  447. package/src/relay/Call.ts +0 -1270
  448. package/src/relay/Deferred.ts +0 -94
  449. package/src/relay/Message.ts +0 -199
  450. package/src/relay/RelayClient.ts +0 -1185
  451. package/src/relay/RelayError.ts +0 -20
  452. package/src/relay/RelayEvent.ts +0 -944
  453. package/src/relay/index.ts +0 -123
  454. package/src/relay/types.ts +0 -149
  455. package/src/rest/HttpClient.ts +0 -164
  456. package/src/rest/RestError.ts +0 -45
  457. package/src/rest/base/BaseResource.ts +0 -32
  458. package/src/rest/base/CrudResource.ts +0 -98
  459. package/src/rest/base/CrudWithAddresses.ts +0 -37
  460. package/src/rest/namespaces/addresses.ts +0 -64
  461. package/src/rest/namespaces/calling.ts +0 -534
  462. package/src/rest/namespaces/chat.ts +0 -31
  463. package/src/rest/namespaces/compat.ts +0 -812
  464. package/src/rest/namespaces/datasphere.ts +0 -88
  465. package/src/rest/namespaces/fabric.ts +0 -417
  466. package/src/rest/namespaces/imported-numbers.ts +0 -31
  467. package/src/rest/namespaces/logs.ts +0 -151
  468. package/src/rest/namespaces/lookup.ts +0 -38
  469. package/src/rest/namespaces/mfa.ts +0 -61
  470. package/src/rest/namespaces/number-groups.ts +0 -68
  471. package/src/rest/namespaces/phone-numbers.ts +0 -76
  472. package/src/rest/namespaces/project.ts +0 -65
  473. package/src/rest/namespaces/pubsub.ts +0 -31
  474. package/src/rest/namespaces/queues.ts +0 -58
  475. package/src/rest/namespaces/recordings.ts +0 -53
  476. package/src/rest/namespaces/registry.ts +0 -200
  477. package/src/rest/namespaces/short-codes.ts +0 -54
  478. package/src/rest/namespaces/sip-profile.ts +0 -40
  479. package/src/rest/namespaces/verified-callers.ts +0 -46
  480. package/src/rest/namespaces/video.ts +0 -332
  481. package/src/rest/types.ts +0 -61
  482. package/src/skills/SkillBase.ts +0 -582
  483. package/src/skills/SkillManager.ts +0 -419
  484. package/src/skills/SkillRegistry.ts +0 -367
  485. package/src/skills/builtin/api_ninjas_trivia.ts +0 -285
  486. package/src/skills/builtin/ask_claude.ts +0 -246
  487. package/src/skills/builtin/claude_skills.ts +0 -983
  488. package/src/skills/builtin/custom_skills.ts +0 -327
  489. package/src/skills/builtin/datasphere.ts +0 -447
  490. package/src/skills/builtin/datasphere_serverless.ts +0 -347
  491. package/src/skills/builtin/datetime.ts +0 -137
  492. package/src/skills/builtin/google_maps.ts +0 -656
  493. package/src/skills/builtin/info_gatherer.ts +0 -415
  494. package/src/skills/builtin/joke.ts +0 -196
  495. package/src/skills/builtin/math.ts +0 -149
  496. package/src/skills/builtin/mcp_gateway.ts +0 -685
  497. package/src/skills/builtin/native_vector_search.ts +0 -910
  498. package/src/skills/builtin/play_background_file.ts +0 -367
  499. package/src/skills/builtin/spider.ts +0 -874
  500. package/src/skills/builtin/swml_transfer.ts +0 -645
  501. package/src/skills/builtin/weather_api.ts +0 -255
  502. package/src/skills/builtin/web_search.ts +0 -1083
  503. package/src/skills/builtin/wikipedia_search.ts +0 -304
  504. package/src/types.ts +0 -132
  505. package/tests/AgentBase.test.ts +0 -1093
  506. package/tests/AgentServer.test.ts +0 -126
  507. package/tests/AuthHandler.test.ts +0 -133
  508. package/tests/ConfigLoader.test.ts +0 -151
  509. package/tests/ContextBuilder.test.ts +0 -108
  510. package/tests/DataMap.test.ts +0 -367
  511. package/tests/EphemeralSkillCopy.test.ts +0 -107
  512. package/tests/FunctionResult.test.ts +0 -298
  513. package/tests/GracefulShutdown.test.ts +0 -46
  514. package/tests/Logger.test.ts +0 -420
  515. package/tests/PomBuilder.test.ts +0 -228
  516. package/tests/ProxyDetection.test.ts +0 -228
  517. package/tests/SWMLService.test.ts +0 -320
  518. package/tests/SWMLVerbHandler.test.ts +0 -523
  519. package/tests/SchemaUtils.test.ts +0 -106
  520. package/tests/SchemaUtils.verb.test.ts +0 -206
  521. package/tests/SecurityUtils.test.ts +0 -192
  522. package/tests/ServerlessAdapter.test.ts +0 -222
  523. package/tests/SessionManager.test.ts +0 -257
  524. package/tests/SkillBaseFeatures.test.ts +0 -130
  525. package/tests/SkillMultiInstance.test.ts +0 -102
  526. package/tests/SkillParameterSchemas.test.ts +0 -134
  527. package/tests/SkillRegistrySchema.test.ts +0 -84
  528. package/tests/SslConfig.test.ts +0 -97
  529. package/tests/SwmlBuilder.test.ts +0 -400
  530. package/tests/TypeInference.test.ts +0 -165
  531. package/tests/VerbHandlerRegistry.test.ts +0 -128
  532. package/tests/cli/mock-data.test.ts +0 -113
  533. package/tests/cli/swaig-test.test.ts +0 -108
  534. package/tests/examples.test.ts +0 -194
  535. package/tests/fixtures/scrape-parity/README.md +0 -53
  536. package/tests/fixtures/scrape-parity/expected/01_simple_article.json +0 -5
  537. package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +0 -5
  538. package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +0 -5
  539. package/tests/fixtures/scrape-parity/expected/04_bare_body.json +0 -5
  540. package/tests/fixtures/scrape-parity/expected/05_malformed.json +0 -5
  541. package/tests/fixtures/scrape-parity/expected/06_multi_class.json +0 -5
  542. package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +0 -5
  543. package/tests/fixtures/scrape-parity/expected/08_inline_script.json +0 -5
  544. package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +0 -5
  545. package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +0 -5
  546. package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +0 -5
  547. package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +0 -5
  548. package/tests/fixtures/scrape-parity/html/01_simple_article.html +0 -18
  549. package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +0 -18
  550. package/tests/fixtures/scrape-parity/html/03_nested_containers.html +0 -13
  551. package/tests/fixtures/scrape-parity/html/04_bare_body.html +0 -9
  552. package/tests/fixtures/scrape-parity/html/05_malformed.html +0 -11
  553. package/tests/fixtures/scrape-parity/html/06_multi_class.html +0 -18
  554. package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +0 -12
  555. package/tests/fixtures/scrape-parity/html/08_inline_script.html +0 -17
  556. package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +0 -21
  557. package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +0 -10
  558. package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +0 -13
  559. package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +0 -24
  560. package/tests/fixtures/scrape-parity/python_extract.py +0 -109
  561. package/tests/livewire/livewire.test.ts +0 -780
  562. package/tests/mcp.test.ts +0 -221
  563. package/tests/prefabs/prefabs.test.ts +0 -1093
  564. package/tests/relay/Action.test.ts +0 -392
  565. package/tests/relay/Call.test.ts +0 -535
  566. package/tests/relay/Deferred.test.ts +0 -71
  567. package/tests/relay/Message.test.ts +0 -164
  568. package/tests/relay/RelayClient.test.ts +0 -779
  569. package/tests/relay/RelayEvent.test.ts +0 -463
  570. package/tests/relay/helpers.ts +0 -79
  571. package/tests/rest/HttpClient.test.ts +0 -274
  572. package/tests/rest/RestError.test.ts +0 -53
  573. package/tests/rest/calling.test.ts +0 -156
  574. package/tests/rest/client.test.ts +0 -197
  575. package/tests/rest/compat.test.ts +0 -335
  576. package/tests/rest/datasphere.test.ts +0 -71
  577. package/tests/rest/fabric.test.ts +0 -186
  578. package/tests/rest/helpers.ts +0 -95
  579. package/tests/rest/logs.test.ts +0 -68
  580. package/tests/rest/pagination.test.ts +0 -133
  581. package/tests/rest/registry.test.ts +0 -94
  582. package/tests/rest/relay-rest.test.ts +0 -290
  583. package/tests/rest/video.test.ts +0 -173
  584. package/tests/setup.ts +0 -6
  585. package/tests/skills/SkillBase.test.ts +0 -108
  586. package/tests/skills/SkillManager.test.ts +0 -268
  587. package/tests/skills/SkillRegistry.test.ts +0 -176
  588. package/tests/skills/builtin.test.ts +0 -1472
  589. package/tests/skills/claude-skills.test.ts +0 -54
  590. package/tests/skills/custom-skills.test.ts +0 -53
  591. package/tests/skills/datasphere-serverless.test.ts +0 -70
  592. package/tests/skills/datasphere.test.ts +0 -107
  593. package/tests/skills/datetime.test.ts +0 -101
  594. package/tests/skills/google-maps.test.ts +0 -78
  595. package/tests/skills/info-gatherer.test.ts +0 -411
  596. package/tests/skills/joke.test.ts +0 -81
  597. package/tests/skills/math.test.ts +0 -68
  598. package/tests/skills/mcp-gateway.test.ts +0 -101
  599. package/tests/skills/play-background.test.ts +0 -54
  600. package/tests/skills/spider.test.ts +0 -108
  601. package/tests/skills/swml-transfer.test.ts +0 -178
  602. package/tests/skills/trivia.test.ts +0 -54
  603. package/tests/skills/vector-search.test.ts +0 -135
  604. package/tests/skills/weather-api.test.ts +0 -77
  605. package/tests/skills/web-search-parity.test.ts +0 -59
  606. package/tests/skills/web-search.test.ts +0 -103
  607. package/tests/skills/wikipedia.test.ts +0 -63
  608. package/tsconfig.json +0 -18
  609. package/vitest.config.ts +0 -9
  610. /package/{src → dist}/schema.json +0 -0
@@ -1,131 +0,0 @@
1
- # Examples
2
-
3
- TypeScript examples demonstrating the SignalWire AI Agents SDK. Each example can be run with `npx tsx`.
4
-
5
- ## Agent Examples
6
-
7
- | File | Description |
8
- |------|-------------|
9
- | [simple-agent.ts](simple-agent.ts) | Minimal agent with prompt, hints, language, and a tool |
10
- | [simple-static.ts](simple-static.ts) | Static agent with voice, params, and structured prompts |
11
- | [dynamic-config.ts](dynamic-config.ts) | Per-request dynamic configuration callback |
12
- | [advanced-dynamic-config.ts](advanced-dynamic-config.ts) | Advanced dynamic config with tier selection |
13
- | [comprehensive-dynamic.ts](comprehensive-dynamic.ts) | Tier-based dynamic config with industry prompts, A/B testing |
14
- | [declarative.ts](declarative.ts) | Declarative prompt sections with tools and post-prompt |
15
- | [custom-path.ts](custom-path.ts) | Agent on a custom HTTP path with query-param personalization |
16
- | [multi-agent.ts](multi-agent.ts) | Multiple agents on different routes via AgentServer |
17
- | [multi-endpoint.ts](multi-endpoint.ts) | Single agent with multiple SWML routes alongside /health |
18
- | [pom-prompt.ts](pom-prompt.ts) | Prompt Object Model sections and structured prompts |
19
-
20
- ## Contexts, Steps, and Gather Info
21
-
22
- | File | Description |
23
- |------|-------------|
24
- | [contexts-steps.ts](contexts-steps.ts) | Multi-step workflows using contexts and steps |
25
- | [gather-info.ts](gather-info.ts) | GatherInfo with typed questions for data collection |
26
-
27
- ## DataMap (Server-Side Tools)
28
-
29
- | File | Description |
30
- |------|-------------|
31
- | [datamap-tools.ts](datamap-tools.ts) | Server-side DataMap tools (weather API, calculator) |
32
- | [advanced-datamap.ts](advanced-datamap.ts) | Advanced DataMap: expressions, webhooks, foreach |
33
-
34
- ## Skills
35
-
36
- | File | Description |
37
- |------|-------------|
38
- | [skills-demo.ts](skills-demo.ts) | Built-in skills: datetime, math |
39
- | [web-search.ts](web-search.ts) | Web search skill via Google Custom Search API |
40
- | [web-search-multi-instance.ts](web-search-multi-instance.ts) | Multiple web search instances (general, news, quick) |
41
- | [wikipedia.ts](wikipedia.ts) | Wikipedia search skill for factual retrieval |
42
- | [datasphere.ts](datasphere.ts) | DataSphere skill for knowledge base search |
43
- | [datasphere-multi-instance.ts](datasphere-multi-instance.ts) | Multiple DataSphere instances for separate knowledge bases |
44
- | [datasphere-serverless-env.ts](datasphere-serverless-env.ts) | DataSphere serverless from environment variables |
45
- | [datasphere-webhook-env.ts](datasphere-webhook-env.ts) | DataSphere webhook from environment variables |
46
- | [mcp-agent.ts](mcp-agent.ts) | MCP client integration for Model Context Protocol |
47
- | [mcp-gateway.ts](mcp-gateway.ts) | MCP gateway skill for bridging MCP server tools |
48
-
49
- ## SWAIG Features and FunctionResult Actions
50
-
51
- | File | Description |
52
- |------|-------------|
53
- | [swaig-features.ts](swaig-features.ts) | FunctionResult actions: connect, hangup, hold, say, metadata |
54
- | [joke-agent.ts](joke-agent.ts) | Raw data_map configuration (API Ninjas jokes) |
55
- | [record-call.ts](record-call.ts) | Start/stop call recording via FunctionResult |
56
- | [room-and-sip.ts](room-and-sip.ts) | Room joining, SIP REFER, and conferences |
57
- | [tap.ts](tap.ts) | TAP configuration for WebSocket/RTP media monitoring |
58
-
59
- ## Call Flow and AI Configuration
60
-
61
- | File | Description |
62
- |------|-------------|
63
- | [call-flow.ts](call-flow.ts) | 5-phase call flow with pre/post answer verbs |
64
- | [llm-params.ts](llm-params.ts) | LLM parameter tuning (precise, creative, customer service) |
65
- | [session-state.ts](session-state.ts) | Global data, session tracking, and on_summary callback |
66
- | [verb-methods.ts](verb-methods.ts) | SWML verb methods for building SWML documents |
67
-
68
- ## Prefab Agents
69
-
70
- | File | Description |
71
- |------|-------------|
72
- | [prefab-info-gatherer.ts](prefab-info-gatherer.ts) | InfoGatherer prefab for structured data collection |
73
- | [dynamic-info-gatherer.ts](dynamic-info-gatherer.ts) | Dynamic InfoGatherer with callback-based question selection |
74
- | [prefab-survey.ts](prefab-survey.ts) | Survey prefab with typed questions and validation |
75
- | [prefab-concierge.ts](prefab-concierge.ts) | Concierge prefab for venue amenities and services |
76
- | [prefab-faq.ts](prefab-faq.ts) | FAQ bot prefab with keyword-based lookup |
77
- | [prefab-receptionist.ts](prefab-receptionist.ts) | Receptionist prefab with department routing |
78
-
79
- ## SWML Service (Non-AI)
80
-
81
- | File | Description |
82
- |------|-------------|
83
- | [swml-service.ts](swml-service.ts) | Basic SWML service: voicemail, IVR, recording |
84
- | [dynamic-swml-service.ts](dynamic-swml-service.ts) | Dynamic SWML generation based on request data |
85
- | [swml-service-routing.ts](swml-service-routing.ts) | Path-based routing with multiple SWML sections |
86
- | [auto-vivified.ts](auto-vivified.ts) | Auto-vivified verb methods on SWMLService |
87
-
88
- ## Deployment
89
-
90
- | File | Description |
91
- |------|-------------|
92
- | [kubernetes-agent.ts](kubernetes-agent.ts) | K8s-ready agent with /health, /ready endpoints |
93
- | [serverless-lambda.ts](serverless-lambda.ts) | Serverless pattern for AWS Lambda deployment |
94
-
95
- ## Client Examples
96
-
97
- | File | Description |
98
- |------|-------------|
99
- | [relay-demo.ts](relay-demo.ts) | RELAY WebSocket client: answer calls, play TTS |
100
-
101
- ## Running Examples
102
-
103
- ```bash
104
- # Run any example
105
- npx tsx examples/simple-agent.ts
106
-
107
- # For skill examples that need API keys:
108
- GOOGLE_SEARCH_API_KEY=your-key GOOGLE_SEARCH_CX=your-cx npx tsx examples/web-search.ts
109
- API_NINJAS_KEY=your-key npx tsx examples/joke-agent.ts
110
-
111
- # For RELAY/DataSphere examples:
112
- export SIGNALWIRE_PROJECT_ID=your-project-id
113
- export SIGNALWIRE_API_TOKEN=your-api-token
114
- export SIGNALWIRE_SPACE=your-space.signalwire.com
115
- npx tsx examples/relay-demo.ts
116
- ```
117
-
118
- ## Environment Variables
119
-
120
- | Variable | Description | Default |
121
- |----------|-------------|---------|
122
- | `SWML_BASIC_AUTH_USER` | Override auth username | `user` |
123
- | `SWML_BASIC_AUTH_PASSWORD` | Override auth password | `pass` |
124
- | `SIGNALWIRE_PROJECT_ID` | Project ID (RELAY/DataSphere) | - |
125
- | `SIGNALWIRE_API_TOKEN` | API token (RELAY/DataSphere) | - |
126
- | `SIGNALWIRE_SPACE` | Space hostname | - |
127
- | `API_NINJAS_KEY` | API Ninjas key (joke agent) | - |
128
- | `GOOGLE_SEARCH_API_KEY` | Google Custom Search key | - |
129
- | `GOOGLE_SEARCH_CX` | Google Search Engine ID | - |
130
- | `DATASPHERE_DOCUMENT_ID` | DataSphere document ID | - |
131
- | `MCP_GATEWAY_URL` | MCP gateway service URL | - |
@@ -1,100 +0,0 @@
1
- /**
2
- * Advanced DataMap Example
3
- *
4
- * Demonstrates advanced DataMap patterns: expressions, foreach iteration,
5
- * POST webhooks with bodies, error keys, and chained data_map tools.
6
- * Run: npx tsx examples/advanced-datamap.ts
7
- */
8
-
9
- import {
10
- AgentBase,
11
- DataMap,
12
- FunctionResult,
13
- createExpressionTool,
14
- } from '../src/index.js';
15
-
16
- export const agent = new AgentBase({
17
- name: 'advanced-datamap-agent',
18
- route: '/',
19
- basicAuth: [
20
- process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
21
- process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
22
- ],
23
- });
24
-
25
- agent.setPromptText(
26
- 'You are a helpful assistant with tools for language detection, stock lookup, ' +
27
- 'and currency conversion. Use the appropriate tool based on the user request.',
28
- );
29
-
30
- // Pattern 1: Expression-based tool (no HTTP call)
31
- // Detects simple greetings and responds appropriately
32
- const greetingTool = createExpressionTool({
33
- name: 'detect_greeting',
34
- patterns: {
35
- '${args.text}': [
36
- '(?i)(hello|hi|hey|good morning|good afternoon)',
37
- new FunctionResult('The user greeted with: ${args.text}. Respond warmly.'),
38
- ],
39
- },
40
- parameters: {
41
- text: { type: 'string', description: 'The text to analyze', required: true },
42
- },
43
- });
44
- agent.registerSwaigFunction(greetingTool.toSwaigFunction());
45
-
46
- // Pattern 2: POST webhook with JSON body and error keys
47
- const translationTool = new DataMap('lookup_definition')
48
- .purpose('Look up the definition of a word in the dictionary')
49
- .parameter('word', 'string', 'The word to look up', { required: true })
50
- .webhook('GET', 'https://api.dictionaryapi.dev/api/v2/entries/en/${args.word}')
51
- .output(
52
- new FunctionResult(
53
- 'Definition of ${args.word}: The word was found in the dictionary.',
54
- ),
55
- )
56
- .errorKeys(['title'])
57
- .fallbackOutput(
58
- new FunctionResult('Could not find a definition for that word.'),
59
- );
60
-
61
- agent.registerSwaigFunction(translationTool.toSwaigFunction());
62
-
63
- // Pattern 3: DataMap with foreach to iterate over list results
64
- const newsTool = new DataMap('get_news')
65
- .purpose('Get the latest news headlines')
66
- .parameter('topic', 'string', 'News topic to search for')
67
- .webhook('GET', 'https://newsapi.org/v2/everything?q=${args.topic}&pageSize=3&apiKey=${ENV.SW_NEWS_API_KEY}')
68
- .foreach({
69
- input_key: 'response.articles',
70
- output_key: 'headlines',
71
- append: '- ${this.title}: ${this.description}',
72
- max: 5,
73
- })
74
- .output(new FunctionResult('Latest news on ${args.topic}:\n${headlines}'))
75
- .fallbackOutput(new FunctionResult('No news found for that topic.'));
76
-
77
- // Enable env expansion for the news API key
78
- newsTool.enableEnvExpansion(true);
79
- newsTool.setAllowedEnvPrefixes(['SW_']);
80
-
81
- agent.registerSwaigFunction(newsTool.toSwaigFunction());
82
-
83
- // Pattern 4: Expression with nomatch fallback
84
- const statusChecker = new DataMap('check_status')
85
- .purpose('Check the status of a service by name')
86
- .parameter('service', 'string', 'Service name to check', { required: true })
87
- .expression(
88
- '${args.service}',
89
- '(?i)(api|web|database)',
90
- new FunctionResult('The ${args.service} service is currently operational.'),
91
- new FunctionResult(
92
- 'Unknown service "${args.service}". Available services: api, web, database.',
93
- ),
94
- );
95
-
96
- agent.registerSwaigFunction(statusChecker.toSwaigFunction());
97
-
98
- agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
99
-
100
- agent.run();
@@ -1,70 +0,0 @@
1
- /**
2
- * Advanced Dynamic Config Example
3
- *
4
- * Per-request agent customization: VIP detection, department routing,
5
- * language selection, and tiered service levels.
6
- * Run: npx tsx examples/advanced-dynamic-config.ts
7
- */
8
-
9
- import { AgentBase, FunctionResult } from '../src/index.js';
10
-
11
- export const agent = new AgentBase({
12
- name: 'smart-router',
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 helpful customer service assistant.');
21
- agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
22
-
23
- agent.defineTool({
24
- name: 'lookup_account',
25
- description: 'Look up a customer account by phone number',
26
- parameters: {
27
- phone: { type: 'string', description: 'The customer phone number' },
28
- },
29
- handler: (args) => {
30
- return new FunctionResult(`Account lookup for ${args.phone}: Active, Premium tier.`);
31
- },
32
- });
33
-
34
- // VIP numbers get premium treatment
35
- const VIP_NUMBERS = ['+15551234567', '+15559876543'];
36
-
37
- agent.setDynamicConfigCallback(async (queryParams, bodyParams, _headers, agentCopy) => {
38
- const copy = agentCopy as AgentBase;
39
- const callerNumber = (bodyParams['call'] as Record<string, unknown>)?.['from'] as string ?? '';
40
-
41
- // VIP detection
42
- if (VIP_NUMBERS.includes(callerNumber)) {
43
- copy.setPromptText(
44
- 'You are a premium concierge assistant. This is a VIP caller — provide priority service, ' +
45
- 'be extra attentive, and offer to escalate any issues immediately.',
46
- );
47
- copy.setParam('temperature', 0.3);
48
- copy.updateGlobalData({ tier: 'vip', caller: callerNumber });
49
- }
50
-
51
- // Department routing via query params
52
- const dept = queryParams['department'];
53
- if (dept === 'sales') {
54
- copy.setPromptText('You are a sales assistant. Help the caller with product info and pricing.');
55
- } else if (dept === 'support') {
56
- copy.setPromptText('You are a technical support agent. Help diagnose and resolve issues.');
57
- }
58
-
59
- // Language selection
60
- const lang = queryParams['lang'];
61
- if (lang === 'es') {
62
- copy.setPromptText('Eres un asistente de servicio al cliente. Responde siempre en espanol.');
63
- copy.setLanguages([{ name: 'Spanish', code: 'es-ES', voice: 'polly.Lucia' }]);
64
- } else if (lang === 'fr') {
65
- copy.setPromptText('Vous etes un assistant du service client. Repondez toujours en francais.');
66
- copy.setLanguages([{ name: 'French', code: 'fr-FR', voice: 'polly.Celine' }]);
67
- }
68
- });
69
-
70
- agent.run();
@@ -1,94 +0,0 @@
1
- /**
2
- * Auto-Vivified SWML Service Example
3
- *
4
- * Demonstrates auto-vivification: calling verb methods directly on a SWMLService
5
- * instead of using addVerb(). Builds voicemail, IVR, and transfer services.
6
- * Run: npx tsx examples/auto-vivified.ts
7
- */
8
-
9
- import { SWMLService } from '../src/index.js';
10
-
11
- // --- Voicemail Service ---
12
- const voicemail = new SWMLService({
13
- name: 'voicemail',
14
- route: '/voicemail',
15
- });
16
-
17
- voicemail.addAnswerVerb();
18
-
19
- // Auto-vivified verb calls (direct method instead of addVerb)
20
- voicemail.play({ url: 'say:Hello, you have reached the voicemail service. Please leave a message after the beep.' });
21
- voicemail.sleep(1000);
22
- voicemail.play({ url: 'https://example.com/beep.wav' });
23
- voicemail.record({
24
- format: 'mp3',
25
- stereo: false,
26
- beep: false,
27
- max_length: 120,
28
- terminators: '#',
29
- status_url: 'https://example.com/voicemail-status',
30
- });
31
- voicemail.play({ url: 'say:Thank you for your message. Goodbye!' });
32
- voicemail.addHangupVerb();
33
-
34
- // --- IVR Menu Service ---
35
- const ivr = new SWMLService({
36
- name: 'ivr',
37
- route: '/ivr',
38
- });
39
-
40
- ivr.addAnswerVerb();
41
-
42
- ivr.addSection('main_menu');
43
- ivr.addVerbToSection('main_menu', 'prompt', {
44
- play: 'say:Press 1 for sales, 2 for support, or 3 to leave a message.',
45
- max_digits: 1,
46
- terminators: '#',
47
- digit_timeout: 5.0,
48
- });
49
-
50
- ivr.addVerbToSection('main_menu', 'switch', {
51
- variable: 'prompt_digits',
52
- case: {
53
- '1': [{ transfer: { dest: 'sales' } }],
54
- '2': [{ transfer: { dest: 'support' } }],
55
- '3': [{ transfer: { dest: 'voicemail_section' } }],
56
- },
57
- default: [
58
- { play: { url: "say:Sorry, I didn't understand." } },
59
- { transfer: { dest: 'main_menu' } },
60
- ],
61
- });
62
-
63
- ivr.addSection('sales');
64
- ivr.addVerbToSection('sales', 'play', { url: 'say:Connecting you to sales.' });
65
- ivr.addVerbToSection('sales', 'connect', { to: '+15551234567' });
66
-
67
- ivr.addVerb('transfer', { dest: 'main_menu' });
68
-
69
- // --- Call Transfer Service ---
70
- const transfer = new SWMLService({
71
- name: 'transfer',
72
- route: '/transfer',
73
- });
74
-
75
- transfer.addAnswerVerb();
76
- transfer.addVerb('play', { url: 'say:Connecting you with the next available agent.' });
77
- transfer.addVerb('connect', {
78
- from: '+15551234567',
79
- timeout: 30,
80
- answer_on_bridge: true,
81
- ringback: ['ring:us'],
82
- parallel: [
83
- { to: '+15552223333' },
84
- { to: '+15554445555' },
85
- ],
86
- });
87
- transfer.addVerb('play', { url: 'say:All agents are busy. Please leave a message.' });
88
- transfer.addVerb('record', { format: 'mp3', beep: true, max_length: 120, terminators: '#' });
89
- transfer.addHangupVerb();
90
-
91
- // Run the voicemail service by default (switch via --service flag)
92
- const service = process.argv[2] === 'ivr' ? ivr : process.argv[2] === 'transfer' ? transfer : voicemail;
93
- console.log(`Starting ${service.name} service...`);
94
- service.run();
@@ -1,63 +0,0 @@
1
- /**
2
- * Call Flow Verbs Example
3
- *
4
- * Control what happens before, during, and after the AI conversation
5
- * using SWML verbs in the 5-phase rendering pipeline.
6
- * Run: npx tsx examples/call-flow.ts
7
- */
8
-
9
- import { AgentBase, FunctionResult } from '../src/index.js';
10
-
11
- export const agent = new AgentBase({
12
- name: 'call-flow-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, // Record the call (Phase 3)
19
- recordFormat: 'mp4',
20
- recordStereo: true,
21
- });
22
-
23
- agent.setPromptText('You are a receptionist. Help callers schedule appointments.');
24
-
25
- // Phase 1: Play ringing before answering
26
- agent.addPreAnswerVerb('play', {
27
- urls: ['ring:us'],
28
- auto_answer: false,
29
- });
30
-
31
- // Phase 3: Play a welcome message after answering but before the AI takes over
32
- agent.addPostAnswerVerb('play', {
33
- url: 'say:Welcome to Acme Corp. Please hold while I connect you with our AI assistant.',
34
- });
35
-
36
- // Phase 5: Hangup after the AI conversation ends
37
- agent.addPostAiVerb('hangup', {});
38
-
39
- // AI config
40
- agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
41
- agent.addPronunciation({ replace: 'Acme', with: 'Ak-mee' });
42
- agent.setParam('temperature', 0.7);
43
-
44
- // Post-prompt for call summary
45
- agent.setPostPrompt('Provide a JSON summary with: caller_name, appointment_date, appointment_reason');
46
-
47
- // Tool for scheduling
48
- agent.defineTool({
49
- name: 'schedule_appointment',
50
- description: 'Schedule an appointment for the caller',
51
- parameters: {
52
- date: { type: 'string', description: 'Appointment date (YYYY-MM-DD)' },
53
- time: { type: 'string', description: 'Appointment time (HH:MM)' },
54
- reason: { type: 'string', description: 'Reason for the appointment' },
55
- },
56
- handler: (args) => {
57
- return new FunctionResult(
58
- `Appointment scheduled for ${args.date} at ${args.time}. Reason: ${args.reason}`,
59
- );
60
- },
61
- });
62
-
63
- agent.run();
@@ -1,125 +0,0 @@
1
- /**
2
- * Comprehensive Dynamic Agent Example
3
- *
4
- * Tier-based dynamic config (standard/premium/enterprise) with industry-specific
5
- * prompts, voice selection, LLM parameter tuning, and A/B testing.
6
- * Run: npx tsx examples/comprehensive-dynamic.ts
7
- * Test: curl "http://user:pass@localhost:3000/?tier=premium&industry=healthcare"
8
- */
9
-
10
- import { AgentBase, FunctionResult } from '../src/index.js';
11
-
12
- export const agent = new AgentBase({
13
- name: 'comprehensive-dynamic',
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.setDynamicConfigCallback((queryParams, bodyParams, headers, ephemeral) => {
22
- const tier = queryParams.tier ?? 'standard';
23
- const industry = queryParams.industry ?? 'general';
24
- const abGroup = Math.random() < 0.5 ? 'A' : 'B';
25
-
26
- // Voice and language based on tier
27
- const voiceMap: Record<string, string> = {
28
- enterprise: 'alloy',
29
- premium: 'nova',
30
- standard: 'rachel',
31
- };
32
- ephemeral.addLanguage({
33
- name: 'English',
34
- code: 'en-US',
35
- voice: voiceMap[tier] ?? 'rachel',
36
- });
37
-
38
- // LLM parameters by tier
39
- const tempMap: Record<string, number> = { enterprise: 0.2, premium: 0.4, standard: 0.6 };
40
- ephemeral.setParams({
41
- temperature: tempMap[tier] ?? 0.5,
42
- top_p: tier === 'enterprise' ? 0.85 : 0.95,
43
- });
44
-
45
- // Global data
46
- ephemeral.setGlobalData({
47
- tier,
48
- industry,
49
- ab_group: abGroup,
50
- priority_queue: tier !== 'standard',
51
- });
52
-
53
- // Industry-specific prompts
54
- const industryPrompts: Record<string, { title: string; body: string; bullets: string[] }> = {
55
- healthcare: {
56
- title: 'Healthcare Expertise',
57
- body: 'You are a healthcare support specialist.',
58
- bullets: [
59
- 'Follow HIPAA guidelines for patient information',
60
- 'Use proper medical terminology',
61
- 'Escalate urgent medical concerns immediately',
62
- ],
63
- },
64
- finance: {
65
- title: 'Financial Services',
66
- body: 'You are a financial services representative.',
67
- bullets: [
68
- 'Never provide specific investment advice',
69
- 'Verify account identity before sharing details',
70
- 'Offer to connect with a licensed advisor for complex questions',
71
- ],
72
- },
73
- general: {
74
- title: 'General Support',
75
- body: 'You are a versatile customer service agent.',
76
- bullets: [
77
- 'Help with product questions and troubleshooting',
78
- 'Process returns and exchanges',
79
- 'Escalate complex issues to a specialist',
80
- ],
81
- },
82
- };
83
-
84
- const prompt = industryPrompts[industry] ?? industryPrompts.general;
85
- ephemeral.promptAddSection(prompt.title, prompt.body, prompt.bullets);
86
-
87
- // Tier-specific features
88
- if (tier === 'enterprise' || tier === 'premium') {
89
- ephemeral.defineTool({
90
- name: 'schedule_callback',
91
- description: 'Schedule a priority callback from a specialist',
92
- parameters: {
93
- time_slot: { type: 'string', description: 'Preferred callback time' },
94
- },
95
- handler: (args) => {
96
- return new FunctionResult(
97
- `Priority callback scheduled for ${args.time_slot}. A specialist will call you.`,
98
- );
99
- },
100
- });
101
- }
102
-
103
- // A/B test: greeting style
104
- if (abGroup === 'A') {
105
- ephemeral.promptAddSection('Greeting', 'Start with a warm, conversational greeting.');
106
- } else {
107
- ephemeral.promptAddSection('Greeting', 'Start with a brief, professional greeting.');
108
- }
109
-
110
- // Tool available to all tiers
111
- ephemeral.defineTool({
112
- name: 'check_status',
113
- description: 'Check the status of an order or ticket',
114
- parameters: {
115
- reference: { type: 'string', description: 'Order or ticket number' },
116
- },
117
- handler: (args) => {
118
- return new FunctionResult(
119
- `Reference ${args.reference} is being processed. Estimated completion: 2 business days.`,
120
- );
121
- },
122
- });
123
- });
124
-
125
- agent.run();
@@ -1,65 +0,0 @@
1
- /**
2
- * Contexts & Steps Example
3
- *
4
- * Multi-step conversation workflows where the AI follows a structured
5
- * sequence of steps, each with its own prompt, criteria, and allowed tools.
6
- * Run: npx tsx examples/contexts-steps.ts
7
- */
8
-
9
- import { AgentBase, FunctionResult } from '../src/index.js';
10
-
11
- export const agent = new AgentBase({
12
- name: 'quiz-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 fun quiz host named Quizzy.');
21
-
22
- // Define tools
23
- agent.defineTool({
24
- name: 'get_score',
25
- description: 'Get the current score for the player',
26
- parameters: {},
27
- handler: () => new FunctionResult('The player has 3 out of 5 correct.'),
28
- });
29
-
30
- agent.defineTool({
31
- name: 'submit_answer',
32
- description: 'Submit an answer to the current question',
33
- parameters: {
34
- answer: { type: 'string', description: 'The answer to check' },
35
- },
36
- handler: (args) => {
37
- return new FunctionResult(`The answer "${args.answer}" has been recorded.`);
38
- },
39
- });
40
-
41
- // Define the conversation flow
42
- const ctx = agent.defineContexts();
43
- const quiz = ctx.addContext('default');
44
-
45
- // Step 1: Greet the player
46
- quiz
47
- .addStep('greeting', { task: 'Welcome the player and explain the quiz rules.' })
48
- .setStepCriteria('Player has acknowledged the rules and is ready to start')
49
- .setFunctions('none') // No tools needed for greeting
50
- .setValidSteps(['question']);
51
-
52
- // Step 2: Ask questions
53
- quiz
54
- .addStep('question', { task: 'Ask the player a trivia question and evaluate their answer.' })
55
- .setStepCriteria('Player has answered the question')
56
- .setFunctions(['submit_answer'])
57
- .setValidSteps(['question', 'results']);
58
-
59
- // Step 3: Show results
60
- quiz
61
- .addStep('results', { task: 'Show the final score and thank the player for playing.' })
62
- .setFunctions(['get_score'])
63
- .setEnd(true);
64
-
65
- agent.run();