@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,45 +0,0 @@
1
- /**
2
- * Custom Path Example
3
- *
4
- * Agent running on a custom HTTP path instead of the default '/'.
5
- * Useful for hosting agents at specific URL paths behind a reverse proxy.
6
- * Run: npx tsx examples/custom-path.ts
7
- * Test: curl http://user:pass@localhost:3000/my-custom-agent
8
- */
9
-
10
- import { AgentBase, FunctionResult } from '../src/index.js';
11
-
12
- export const agent = new AgentBase({
13
- name: 'custom-path-agent',
14
- route: '/my-custom-agent',
15
- port: 3000,
16
- basicAuth: [
17
- process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
18
- process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
19
- ],
20
- });
21
-
22
- agent.setPromptText(
23
- 'You are a helpful assistant hosted at a custom URL path. ' +
24
- 'Tell the caller your name and offer to help.',
25
- );
26
-
27
- agent.defineTool({
28
- name: 'get_agent_info',
29
- description: 'Get information about this agent including its URL path',
30
- parameters: {},
31
- handler: () => {
32
- return new FunctionResult(
33
- `This agent is running at the custom path /my-custom-agent on port 3000.`,
34
- );
35
- },
36
- });
37
-
38
- agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
39
-
40
- // When using a proxy, set the external URL so webhooks resolve correctly
41
- if (process.env['SWML_PROXY_URL_BASE']) {
42
- agent.manualSetProxyUrl(process.env['SWML_PROXY_URL_BASE']);
43
- }
44
-
45
- agent.run();
@@ -1,55 +0,0 @@
1
- /**
2
- * DataMap Tools Example
3
- *
4
- * Server-side tools that call external APIs without requiring
5
- * your own webhook endpoints. The SignalWire platform executes
6
- * these directly based on the data_map configuration.
7
- * Run: npx tsx examples/datamap-tools.ts
8
- */
9
-
10
- import {
11
- AgentBase,
12
- DataMap,
13
- FunctionResult,
14
- createSimpleApiTool,
15
- } from '../src/index.js';
16
-
17
- export const agent = new AgentBase({
18
- name: 'weather-agent',
19
- route: '/',
20
- basicAuth: [
21
- process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
22
- process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
23
- ],
24
- });
25
-
26
- agent.setPromptText(
27
- 'You are a weather assistant. Help users check the weather in any city.',
28
- );
29
-
30
- // Method 1: Build a DataMap manually with full control
31
- const weatherTool = new DataMap('get_weather')
32
- .purpose('Get current weather for a city')
33
- .parameter('city', 'string', 'The city name', { required: true })
34
- .webhook('GET', 'https://wttr.in/${lc:args.city}?format=j1')
35
- .output(
36
- new FunctionResult(
37
- 'Weather in ${args.city}: ${response.current_condition[0].temp_F}°F, ${response.current_condition[0].weatherDesc[0].value}',
38
- ),
39
- )
40
- .fallbackOutput(
41
- new FunctionResult('Sorry, I could not fetch the weather for that city.'),
42
- );
43
-
44
- agent.registerSwaigFunction(weatherTool.toSwaigFunction());
45
-
46
- // Method 2: Use the createSimpleApiTool helper for quick API integrations
47
- const jokeTool = createSimpleApiTool({
48
- name: 'get_joke',
49
- url: 'https://official-joke-api.appspot.com/random_joke',
50
- responseTemplate: 'Here is a joke: ${response.setup} ... ${response.punchline}',
51
- });
52
-
53
- agent.registerSwaigFunction(jokeTool.toSwaigFunction());
54
-
55
- agent.run();
@@ -1,63 +0,0 @@
1
- /**
2
- * DataSphere Multiple Instance Demo
3
- *
4
- * Loads the DataSphere skill multiple times with different knowledge bases
5
- * and custom tool names. Each instance searches a different document.
6
- * Run: npx tsx examples/datasphere-multi-instance.ts
7
- */
8
-
9
- import { AgentBase, DataSphereSkill, DateTimeSkill, MathSkill } from '../src/index.js';
10
-
11
- export const agent = new AgentBase({
12
- name: 'multi-datasphere',
13
- route: '/',
14
- basicAuth: [
15
- process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
16
- process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
17
- ],
18
- });
19
-
20
- agent.setPromptText(
21
- 'You are an assistant with access to multiple knowledge bases. ' +
22
- 'Use the appropriate search tool depending on the topic.',
23
- );
24
-
25
- agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
26
-
27
- // Add utility skills
28
- await agent.addSkill(new DateTimeSkill());
29
- await agent.addSkill(new MathSkill());
30
-
31
- // Instance 1: Drinks knowledge base
32
- await agent.addSkill(
33
- new DataSphereSkill({
34
- document_id: 'drinks-doc-123',
35
- tool_name: 'search_drinks_knowledge',
36
- max_results: 2,
37
- distance_threshold: 5.0,
38
- }),
39
- );
40
-
41
- // Instance 2: Food knowledge base
42
- await agent.addSkill(
43
- new DataSphereSkill({
44
- document_id: 'food-doc-456',
45
- tool_name: 'search_food_knowledge',
46
- max_results: 3,
47
- distance_threshold: 4.0,
48
- }),
49
- );
50
-
51
- // Instance 3: General knowledge (default tool name)
52
- await agent.addSkill(
53
- new DataSphereSkill({
54
- document_id: 'general-doc-789',
55
- max_results: 1,
56
- distance_threshold: 3.0,
57
- }),
58
- );
59
-
60
- console.log('Loaded skills:', agent.listSkills().map(s => s.name));
61
- console.log('Note: Replace document IDs with your actual DataSphere documents.');
62
-
63
- agent.run();
@@ -1,68 +0,0 @@
1
- /**
2
- * DataSphere Serverless Environment Demo
3
- *
4
- * Loads the DataSphere Serverless skill with configuration from environment
5
- * variables, showing best practices for production deployment.
6
- *
7
- * Required env vars:
8
- * SIGNALWIRE_SPACE, SIGNALWIRE_PROJECT_ID, SIGNALWIRE_TOKEN,
9
- * DATASPHERE_DOCUMENT_ID
10
- *
11
- * Optional env vars:
12
- * DATASPHERE_COUNT, DATASPHERE_DISTANCE, DATASPHERE_TAGS, DATASPHERE_LANGUAGE
13
- *
14
- * Run: npx tsx examples/datasphere-serverless-env.ts
15
- */
16
-
17
- import { AgentBase, DataSphereSkill, DateTimeSkill, MathSkill } from '../src/index.js';
18
-
19
- function requireEnv(name: string): string {
20
- const value = process.env[name];
21
- if (!value) {
22
- console.error(`Error: Required environment variable ${name} is not set.`);
23
- console.error('Required: SIGNALWIRE_SPACE, SIGNALWIRE_PROJECT_ID, SIGNALWIRE_TOKEN, DATASPHERE_DOCUMENT_ID');
24
- process.exit(1);
25
- }
26
- return value;
27
- }
28
-
29
- const documentId = requireEnv('DATASPHERE_DOCUMENT_ID');
30
- const count = parseInt(process.env['DATASPHERE_COUNT'] ?? '3', 10);
31
- const distance = parseFloat(process.env['DATASPHERE_DISTANCE'] ?? '4.0');
32
- const tags = process.env['DATASPHERE_TAGS']?.split(',').map(t => t.trim()).filter(Boolean);
33
-
34
- export const agent = new AgentBase({
35
- name: 'datasphere-env',
36
- route: '/',
37
- basicAuth: [
38
- process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
39
- process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
40
- ],
41
- });
42
-
43
- agent.setPromptText(
44
- 'You are a knowledge assistant with access to a document library. ' +
45
- 'Search the knowledge base to answer user questions. Always cite the source.',
46
- );
47
-
48
- agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
49
-
50
- await agent.addSkill(new DateTimeSkill());
51
- await agent.addSkill(new MathSkill());
52
-
53
- await agent.addSkill(
54
- new DataSphereSkill({
55
- document_id: documentId,
56
- max_results: count,
57
- distance_threshold: distance,
58
- ...(tags ? { tags } : {}),
59
- }),
60
- );
61
-
62
- console.log(`DataSphere Serverless Environment Demo`);
63
- console.log(` Document: ${documentId}`);
64
- console.log(` Max results: ${count}`);
65
- console.log(` Distance threshold: ${distance}`);
66
- if (tags) console.log(` Tags: ${tags.join(', ')}`);
67
-
68
- agent.run();
@@ -1,66 +0,0 @@
1
- /**
2
- * DataSphere Webhook Environment Demo
3
- *
4
- * Loads the traditional webhook-based DataSphere skill with environment variable
5
- * configuration. Compare with datasphere-serverless-env.ts for the serverless approach.
6
- *
7
- * Required env vars:
8
- * SIGNALWIRE_SPACE, SIGNALWIRE_PROJECT_ID, SIGNALWIRE_TOKEN,
9
- * DATASPHERE_DOCUMENT_ID
10
- *
11
- * Run: npx tsx examples/datasphere-webhook-env.ts
12
- */
13
-
14
- import { AgentBase, DataSphereSkill, DateTimeSkill, MathSkill } from '../src/index.js';
15
-
16
- function requireEnv(name: string): string {
17
- const value = process.env[name];
18
- if (!value) {
19
- console.error(`Error: Required environment variable ${name} is not set.`);
20
- process.exit(1);
21
- }
22
- return value;
23
- }
24
-
25
- const documentId = requireEnv('DATASPHERE_DOCUMENT_ID');
26
- const count = parseInt(process.env['DATASPHERE_COUNT'] ?? '3', 10);
27
- const distance = parseFloat(process.env['DATASPHERE_DISTANCE'] ?? '4.0');
28
-
29
- export const agent = new AgentBase({
30
- name: 'datasphere-webhook',
31
- route: '/',
32
- basicAuth: [
33
- process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
34
- process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
35
- ],
36
- });
37
-
38
- agent.setPromptText(
39
- 'You are a knowledge assistant with access to a document library via webhook. ' +
40
- 'Use the search tool to find answers from the knowledge base.',
41
- );
42
-
43
- agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
44
-
45
- await agent.addSkill(new DateTimeSkill());
46
- await agent.addSkill(new MathSkill());
47
-
48
- // Webhook-based DataSphere skill (traditional approach)
49
- await agent.addSkill(
50
- new DataSphereSkill({
51
- document_id: documentId,
52
- max_results: count,
53
- distance_threshold: distance,
54
- mode: 'webhook',
55
- }),
56
- );
57
-
58
- console.log('DataSphere Webhook Environment Demo');
59
- console.log(` Document: ${documentId}`);
60
- console.log(` Execution: Webhook-based (traditional)`);
61
- console.log('');
62
- console.log('WEBHOOK vs SERVERLESS:');
63
- console.log(' Webhook: Full control over request/response, custom error handling');
64
- console.log(' Serverless: No webhook infrastructure, lower latency, executes on SignalWire');
65
-
66
- agent.run();
@@ -1,37 +0,0 @@
1
- /**
2
- * DataSphere Skill Example
3
- *
4
- * Uses the DataSphere skill to search a SignalWire knowledge base.
5
- * Requires SIGNALWIRE_PROJECT_ID, SIGNALWIRE_TOKEN, and SIGNALWIRE_SPACE env vars.
6
- * Run: npx tsx examples/datasphere.ts
7
- */
8
-
9
- import { AgentBase, DataSphereSkill } from '../src/index.js';
10
-
11
- export const agent = new AgentBase({
12
- name: 'knowledge-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 knowledge assistant with access to a document library. ' +
22
- 'Use the search tool to find answers to user questions from the knowledge base. ' +
23
- 'Always cite the source when providing information from the knowledge base.',
24
- );
25
-
26
- // Add DataSphere skill with custom configuration
27
- await agent.addSkill(
28
- new DataSphereSkill({
29
- max_results: 3,
30
- distance_threshold: 0.6,
31
- }),
32
- );
33
-
34
- agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
35
- agent.addHints(['DataSphere', 'knowledge base', 'documentation']);
36
-
37
- agent.run();
@@ -1,100 +0,0 @@
1
- /**
2
- * Declarative Agent Example
3
- *
4
- * Demonstrates creating an agent using class inheritance with static
5
- * PROMPT_SECTIONS and the defineTools() lifecycle method, instead of
6
- * the imperative new AgentBase() + method-chaining approach.
7
- * Run: npx tsx examples/declarative.ts
8
- */
9
-
10
- import { AgentBase, FunctionResult } from '../src/index.js';
11
- import type { AgentOptions } from '../src/index.js';
12
-
13
- class HelpDeskAgent extends AgentBase {
14
- // Declarative prompt sections — applied automatically in the constructor
15
- static override PROMPT_SECTIONS = [
16
- {
17
- title: 'Role',
18
- body: 'You are a help desk agent for Acme Software Inc.',
19
- },
20
- {
21
- title: 'Personality',
22
- body: 'You are professional, patient, and solution-oriented.',
23
- bullets: [
24
- 'Always greet the user warmly.',
25
- 'Ask clarifying questions before troubleshooting.',
26
- 'Summarize the solution at the end of each interaction.',
27
- ],
28
- },
29
- {
30
- title: 'Knowledge',
31
- bullets: [
32
- 'Acme Software sells a project management tool called AcmePM.',
33
- 'Common issues: login problems, slow performance, missing data.',
34
- 'Tier 1 support can reset passwords and clear caches.',
35
- 'Tier 2 issues should be escalated to a supervisor.',
36
- ],
37
- },
38
- ];
39
-
40
- constructor(opts: AgentOptions) {
41
- super(opts);
42
- this.defineTools();
43
- }
44
-
45
- protected override defineTools(): void {
46
- this.defineTool({
47
- name: 'reset_password',
48
- description: 'Reset a user password by their email address',
49
- parameters: {
50
- email: { type: 'string', description: 'User email address' },
51
- },
52
- handler: (args) => {
53
- return new FunctionResult(
54
- `Password reset email sent to ${args.email}. It will arrive within 5 minutes.`,
55
- );
56
- },
57
- });
58
-
59
- this.defineTool({
60
- name: 'check_system_status',
61
- description: 'Check the current system status of AcmePM',
62
- parameters: {},
63
- handler: () => {
64
- return new FunctionResult(
65
- 'AcmePM system status: All services operational. No known outages.',
66
- );
67
- },
68
- });
69
-
70
- this.defineTool({
71
- name: 'escalate_ticket',
72
- description: 'Escalate an issue to Tier 2 support',
73
- parameters: {
74
- issue: { type: 'string', description: 'Description of the issue' },
75
- },
76
- handler: (args) => {
77
- const result = new FunctionResult(
78
- `Issue escalated to Tier 2: "${args.issue}". A specialist will follow up within 2 hours.`,
79
- );
80
- return result;
81
- },
82
- });
83
- }
84
- }
85
-
86
- export const agent = new HelpDeskAgent({
87
- name: 'help-desk',
88
- route: '/',
89
- basicAuth: [
90
- process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
91
- process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
92
- ],
93
- });
94
-
95
- agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
96
- agent.setPostPrompt(
97
- 'Summarize this support call as JSON: { issue_type, resolution, escalated, follow_up_needed }',
98
- );
99
-
100
- agent.run();
@@ -1,54 +0,0 @@
1
- /**
2
- * Dynamic Configuration Example
3
- *
4
- * Customize agent behavior per-request based on query parameters,
5
- * headers, or request body. Each request gets an ephemeral copy
6
- * of the agent, so modifications don't affect other callers.
7
- * Run: npx tsx examples/dynamic-config.ts
8
- */
9
-
10
- import { AgentBase, FunctionResult } from '../src/index.js';
11
-
12
- export const agent = new AgentBase({
13
- name: 'dynamic-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.');
22
-
23
- agent.defineTool({
24
- name: 'greet',
25
- description: 'Greet the user by name',
26
- parameters: {},
27
- handler: () => new FunctionResult('Hello!'),
28
- });
29
-
30
- // Customize the agent per-request
31
- agent.setDynamicConfigCallback(async (queryParams, bodyParams, headers, agentCopy) => {
32
- const copy = agentCopy as AgentBase;
33
-
34
- // Customize based on query params (e.g., ?lang=es&name=Carlos)
35
- const lang = queryParams['lang'];
36
- if (lang === 'es') {
37
- copy.setPromptText('Eres un asistente amigable. Responde siempre en español.');
38
- copy.setLanguages([{ name: 'Spanish', code: 'es-ES', voice: 'polly.Lucia' }]);
39
- } else if (lang === 'fr') {
40
- copy.setPromptText('Vous êtes un assistant sympathique. Répondez toujours en français.');
41
- copy.setLanguages([{ name: 'French', code: 'fr-FR', voice: 'polly.Celine' }]);
42
- }
43
-
44
- // Customize based on caller info from the request body
45
- const callerName = queryParams['name'] ?? (bodyParams['caller_name'] as string);
46
- if (callerName) {
47
- copy.setGlobalData({ caller_name: callerName });
48
- copy.setPromptText(
49
- `You are a helpful assistant. The caller's name is ${callerName}. Greet them by name.`,
50
- );
51
- }
52
- });
53
-
54
- agent.run();
@@ -1,69 +0,0 @@
1
- /**
2
- * Dynamic InfoGatherer Example
3
- *
4
- * Shows how to use InfoGathererAgent in dynamic mode with a callback
5
- * function that chooses the question set based on the request's query
6
- * string.
7
- *
8
- * Run: npx tsx examples/dynamic-info-gatherer.ts
9
- * Test:
10
- * curl http://user:pass@localhost:3000/?set=support
11
- * curl http://user:pass@localhost:3000/?set=medical
12
- */
13
-
14
- import { InfoGathererAgent } from '../src/index.js';
15
- import type { InfoGathererQuestion } from '../src/index.js';
16
-
17
- const questionSets: Record<string, InfoGathererQuestion[]> = {
18
- default: [
19
- { key_name: 'name', question_text: 'What is your full name?' },
20
- { key_name: 'phone', question_text: 'What is a good callback number?' },
21
- { key_name: 'reason', question_text: 'How can I help you today?' },
22
- ],
23
- support: [
24
- { key_name: 'customer_name', question_text: 'What is your name?' },
25
- { key_name: 'account_number', question_text: 'What is your account number?', confirm: true },
26
- { key_name: 'issue', question_text: 'Describe the issue you are experiencing.' },
27
- { key_name: 'priority', question_text: 'Is this low, medium, or high priority?' },
28
- ],
29
- medical: [
30
- { key_name: 'patient_name', question_text: 'What is the patient\'s full name?' },
31
- { key_name: 'symptoms', question_text: 'What are the current symptoms?' },
32
- { key_name: 'duration', question_text: 'How long have these symptoms been present?' },
33
- { key_name: 'medications', question_text: 'Is the patient taking any medications?' },
34
- ],
35
- onboarding: [
36
- { key_name: 'full_name', question_text: 'What is your full name?' },
37
- { key_name: 'email', question_text: 'What is your email address?', confirm: true },
38
- { key_name: 'company', question_text: 'What company do you work for?' },
39
- { key_name: 'department', question_text: 'What department will you be working in?' },
40
- { key_name: 'start_date', question_text: 'What is your start date?' },
41
- ],
42
- };
43
-
44
- export const agent = new InfoGathererAgent({
45
- name: 'dynamic-intake',
46
- // No `questions` → dynamic mode. Callback resolves them per request.
47
- questionCallback: (queryParams) => {
48
- const set = queryParams['set'] ?? 'default';
49
- console.log(`Dynamic question set: ${set}`);
50
- return questionSets[set] ?? questionSets['default'];
51
- },
52
- agentOptions: {
53
- route: '/',
54
- basicAuth: [
55
- process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
56
- process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
57
- ],
58
- },
59
- });
60
-
61
- agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
62
-
63
- console.log('Dynamic InfoGatherer Agent');
64
- console.log(' /?set=default (name, phone, reason)');
65
- console.log(' /?set=support (customer support intake)');
66
- console.log(' /?set=medical (medical intake)');
67
- console.log(' /?set=onboarding (employee onboarding)');
68
-
69
- agent.run();
@@ -1,67 +0,0 @@
1
- /**
2
- * Dynamic SWML Service Example
3
- *
4
- * Uses SWMLService with an onRequest callback to generate different
5
- * SWML per request based on query parameters (e.g., ?action=voicemail).
6
- * Run: npx tsx examples/dynamic-swml-service.ts
7
- */
8
-
9
- import { SWMLService, SwmlBuilder } from '../src/index.js';
10
-
11
- export const agent = new SWMLService({
12
- name: 'dynamic-ivr',
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.setOnRequestCallback((queryParams, _bodyParams, _headers) => {
21
- const builder = new SwmlBuilder();
22
- const action = queryParams['action'] ?? 'greeting';
23
-
24
- builder.addVerb('answer', { max_duration: 300 });
25
-
26
- switch (action) {
27
- case 'voicemail':
28
- builder.addVerb('play', {
29
- url: 'say:Please leave your message after the beep. Press pound when finished.',
30
- });
31
- builder.addVerb('record', {
32
- stereo: true,
33
- format: 'mp3',
34
- terminators: '#',
35
- beep: true,
36
- });
37
- builder.addVerb('play', { url: 'say:Message recorded. Goodbye!' });
38
- break;
39
-
40
- case 'hours':
41
- builder.addVerb('play', {
42
- url: 'say:Our business hours are Monday through Friday, 9 AM to 5 PM Eastern Time. Thank you for calling!',
43
- });
44
- break;
45
-
46
- case 'transfer':
47
- builder.addVerb('play', {
48
- url: 'say:Please hold while we transfer your call.',
49
- });
50
- builder.addVerb('connect', {
51
- from: '+15551234567',
52
- to: '+18005551234',
53
- });
54
- break;
55
-
56
- default:
57
- builder.addVerb('play', {
58
- url: 'say:Thank you for calling Acme Corp. For voicemail, add action=voicemail to your request. For business hours, add action=hours.',
59
- });
60
- break;
61
- }
62
-
63
- builder.addVerb('hangup', {});
64
- return builder;
65
- });
66
-
67
- agent.run();