@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,950 +0,0 @@
1
- /**
2
- * LiveWire -- LiveKit-compatible agents powered by SignalWire.
3
- *
4
- * Provides the same class/function names as @livekit/agents-js so that
5
- * developers can swap their import path and run on SignalWire's
6
- * infrastructure. STT, TTS, VAD, LLM orchestration, and call control
7
- * are all handled by SignalWire's control plane -- the noop'd options
8
- * are accepted silently (logged once) to keep existing code compiling.
9
- */
10
-
11
- import { AgentBase } from '../AgentBase.js';
12
- import { FunctionResult } from '../FunctionResult.js';
13
- import type { SwaigHandler } from '../SwaigFunction.js';
14
-
15
- // ---------------------------------------------------------------------------
16
- // Banner
17
- // ---------------------------------------------------------------------------
18
-
19
- const banner = `
20
- __ _ _ ___
21
- / / (_) _____ | | / (_)_______
22
- / / / / | / / _ \\ | | /| / / / ___/ _ \\
23
- / /___/ /| |/ / __/ | |/ |/ / / / / __/
24
- /_____/_/ |___/\\___/ |__/|__/_/_/ \\___/
25
-
26
- LiveKit-compatible agents powered by SignalWire
27
- `;
28
-
29
- /** Print the ASCII banner to stderr, using ANSI cyan when stderr is a TTY. */
30
- function printBanner(): void {
31
- if (process.stderr.isTTY) {
32
- process.stderr.write(`\x1b[36m${banner}\x1b[0m\n`);
33
- } else {
34
- process.stderr.write(`${banner}\n`);
35
- }
36
- }
37
-
38
- // ---------------------------------------------------------------------------
39
- // "Did You Know?" Tips
40
- // ---------------------------------------------------------------------------
41
-
42
- export const tips: string[] = [
43
- "SignalWire agents support DataMap tools that execute server-side — no webhook infrastructure needed. See: docs/datamap-guide.md",
44
- "SignalWire Contexts & Steps give you mechanical state control over conversations — no prompt engineering needed. See: docs/contexts-guide.md",
45
- "SignalWire agents can transfer calls between agents with a single SwmlTransfer() action",
46
- "SignalWire handles 18 built-in skills (datetime, math, web search, etc.) with one-liner integration via agent.addSkill()",
47
- "SignalWire agents support SMS, conferencing, call recording, and SIP — all from the same agent",
48
- "Your agent's entire AI pipeline (STT, LLM, TTS, VAD) runs in SignalWire's cloud — zero infrastructure to manage",
49
- "SignalWire prefab agents (Survey, Receptionist, FAQ, Concierge) give you production patterns in 10 lines of code",
50
- "SignalWire's RELAY client gives you real-time WebSocket call control with 57+ methods — play, record, detect, conference, and more",
51
- "SignalWire agents auto-generate SWML documents — the platform handles media, turn detection, and barge-in for you",
52
- "You can host multiple agents on one server with AgentServer — each with its own route, prompt, and tools",
53
- ];
54
-
55
- function printTip(): void {
56
- const tip = tips[Math.floor(Math.random() * tips.length)];
57
- process.stderr.write(`\n\u{1f4a1} Did you know? ${tip}\n\n`);
58
- }
59
-
60
- // ---------------------------------------------------------------------------
61
- // Noop logging helpers
62
- // ---------------------------------------------------------------------------
63
-
64
- /**
65
- * NoopTracker ensures each informational message is logged at most once,
66
- * preventing spam when the same noop path is exercised repeatedly.
67
- */
68
- class NoopTracker {
69
- private logged = new Set<string>();
70
-
71
- once(key: string, message: string): void {
72
- if (this.logged.has(key)) return;
73
- this.logged.add(key);
74
- process.stderr.write(`[LiveWire] ${message}\n`);
75
- }
76
-
77
- /** Expose whether a key has been logged (for testing). */
78
- hasLogged(key: string): boolean {
79
- return this.logged.has(key);
80
- }
81
-
82
- /** Reset all tracked keys (for testing). */
83
- reset(): void {
84
- this.logged.clear();
85
- }
86
- }
87
-
88
- const globalNoop = new NoopTracker();
89
-
90
- // Re-export for testing
91
- export { NoopTracker, globalNoop };
92
-
93
- // ---------------------------------------------------------------------------
94
- // VoiceOptions
95
- // ---------------------------------------------------------------------------
96
-
97
- /** Voice configuration options passed through to the SignalWire AI config. */
98
- export interface VoiceOptions {
99
- voice: string;
100
- engine: string;
101
- language: string;
102
- }
103
-
104
- // ---------------------------------------------------------------------------
105
- // FunctionTool
106
- // ---------------------------------------------------------------------------
107
-
108
- /** A tool definition that can be registered on an Agent. */
109
- export interface FunctionTool {
110
- name: string;
111
- description: string;
112
- parameters?: Record<string, unknown>;
113
- execute: (params: any, context: { ctx: RunContext }) => any;
114
- }
115
-
116
- // ---------------------------------------------------------------------------
117
- // Agent
118
- // ---------------------------------------------------------------------------
119
-
120
- /** Mirrors a LiveKit voice.Agent -- holds instructions and tool definitions. */
121
- export class Agent<UserData = any> {
122
- instructions: string;
123
- tools: Record<string, FunctionTool>;
124
- userData?: UserData;
125
-
126
- /** @internal Pipeline hint stored for AgentSession mapping. */
127
- _llmHint: unknown;
128
- /** @internal */
129
- _allowInterruptions: unknown;
130
- /** @internal */
131
- _minEndpointingDelay: unknown;
132
- /** @internal */
133
- _maxEndpointingDelay: unknown;
134
-
135
- private _session?: AgentSession<UserData>;
136
-
137
- constructor(options?: {
138
- instructions?: string;
139
- tools?: FunctionTool[];
140
- userData?: UserData;
141
- chatCtx?: unknown;
142
- stt?: unknown;
143
- tts?: unknown;
144
- llm?: unknown;
145
- vad?: unknown;
146
- turnDetection?: unknown;
147
- mcpServers?: unknown;
148
- allowInterruptions?: boolean;
149
- minEndpointingDelay?: number;
150
- maxEndpointingDelay?: number;
151
- }) {
152
- this.instructions = options?.instructions ?? '';
153
- // Mirror Python: tools is Optional[List[Any]], stored internally as a name-keyed map.
154
- // Build the record from the array using the same pattern as updateTools().
155
- if (options?.tools) {
156
- const record: Record<string, FunctionTool> = {};
157
- for (const t of options.tools) {
158
- record[t.name] = t;
159
- }
160
- this.tools = record;
161
- } else {
162
- this.tools = {};
163
- }
164
- this.userData = options?.userData;
165
-
166
- // Pipeline noop advisories (matching Python behavior)
167
- if (options?.stt != null) {
168
- globalNoop.once(
169
- 'agent_stt',
170
- "Agent(stt=...): SignalWire's control plane handles speech recognition at scale -- no configuration needed",
171
- );
172
- }
173
- if (options?.tts != null) {
174
- globalNoop.once(
175
- 'agent_tts',
176
- "Agent(tts=...): SignalWire's control plane handles text-to-speech at scale -- no configuration needed",
177
- );
178
- }
179
- if (options?.vad != null) {
180
- globalNoop.once(
181
- 'agent_vad',
182
- "Agent(vad=...): SignalWire's control plane handles voice activity detection at scale automatically",
183
- );
184
- }
185
- if (options?.turnDetection != null) {
186
- globalNoop.once(
187
- 'agent_turn_detection',
188
- "Agent(turnDetection=...): SignalWire's control plane handles turn detection at scale automatically",
189
- );
190
- }
191
- if (options?.mcpServers != null) {
192
- globalNoop.once(
193
- 'agent_mcp_servers',
194
- 'Agent(mcpServers=...): MCP servers are not yet supported in LiveWire -- tools should be registered via tool()',
195
- );
196
- }
197
-
198
- // Store pipeline hints for later mapping (used by AgentSession.start)
199
- this._llmHint = options?.llm;
200
- this._allowInterruptions = options?.allowInterruptions;
201
- this._minEndpointingDelay = options?.minEndpointingDelay;
202
- this._maxEndpointingDelay = options?.maxEndpointingDelay;
203
- }
204
-
205
- // ------------------------------------------------------------------
206
- // session property
207
- // ------------------------------------------------------------------
208
-
209
- get session(): AgentSession<UserData> | undefined {
210
- return this._session;
211
- }
212
-
213
- set session(value: AgentSession<UserData> | undefined) {
214
- this._session = value;
215
- }
216
-
217
- // ------------------------------------------------------------------
218
- // Lifecycle hooks (override in subclass)
219
- // ------------------------------------------------------------------
220
-
221
- /** Called when the agent enters. Override in subclass. */
222
- async onEnter(): Promise<void> {}
223
-
224
- /** Called when the agent exits. Override in subclass. */
225
- async onExit(): Promise<void> {}
226
-
227
- /** Called when the user finishes speaking. Override in subclass. */
228
- async onUserTurnCompleted(_turnCtx?: unknown, _newMessage?: unknown): Promise<void> {}
229
-
230
- // ------------------------------------------------------------------
231
- // Pipeline nodes -- all noop + log (SignalWire handles these)
232
- // ------------------------------------------------------------------
233
-
234
- /** Noop -- SignalWire handles STT in its control plane. */
235
- async sttNode(_audio?: unknown, _modelSettings?: unknown): Promise<void> {
236
- globalNoop.once(
237
- 'stt_node',
238
- "Agent.sttNode(): SignalWire's control plane handles speech recognition -- this node is a no-op",
239
- );
240
- }
241
-
242
- /** Noop -- SignalWire handles LLM in its control plane. */
243
- async llmNode(_chatCtx?: unknown, _tools?: unknown, _modelSettings?: unknown): Promise<void> {
244
- globalNoop.once(
245
- 'llm_node',
246
- "Agent.llmNode(): SignalWire's control plane handles LLM inference -- this node is a no-op",
247
- );
248
- }
249
-
250
- /** Noop -- SignalWire handles TTS in its control plane. */
251
- async ttsNode(_text?: unknown, _modelSettings?: unknown): Promise<void> {
252
- globalNoop.once(
253
- 'tts_node',
254
- "Agent.ttsNode(): SignalWire's control plane handles text-to-speech -- this node is a no-op",
255
- );
256
- }
257
-
258
- // ------------------------------------------------------------------
259
- // Dynamic updates
260
- // ------------------------------------------------------------------
261
-
262
- /** Update the agent's instructions mid-session. */
263
- async updateInstructions(instructions: string): Promise<void> {
264
- this.instructions = instructions;
265
- }
266
-
267
- /** Update the agent's tool list mid-session. */
268
- async updateTools(tools: FunctionTool[]): Promise<void> {
269
- const record: Record<string, FunctionTool> = {};
270
- for (const t of tools) {
271
- record[t.name] = t;
272
- }
273
- this.tools = record;
274
- }
275
- }
276
-
277
- // ---------------------------------------------------------------------------
278
- // RunContext
279
- // ---------------------------------------------------------------------------
280
-
281
- /** Mirrors a LiveKit RunContext -- available inside tool handlers. */
282
- export class RunContext<UserData = any> {
283
- session?: AgentSession<UserData>;
284
- speechHandle?: unknown;
285
- functionCall?: unknown;
286
-
287
- constructor(
288
- session?: AgentSession<UserData>,
289
- options?: { speechHandle?: unknown; functionCall?: unknown },
290
- ) {
291
- this.session = session;
292
- this.speechHandle = options?.speechHandle;
293
- this.functionCall = options?.functionCall;
294
- }
295
-
296
- get userData(): UserData {
297
- return (this.session?.userData ?? {}) as UserData;
298
- }
299
- }
300
-
301
- // ---------------------------------------------------------------------------
302
- // AgentSession
303
- // ---------------------------------------------------------------------------
304
-
305
- /** Mirrors a LiveKit AgentSession -- binds an Agent to SignalWire. */
306
- export class AgentSession<UserData = any> {
307
- private _llm: any;
308
- private _tools: FunctionTool[];
309
- private _userData: UserData;
310
- private _agent?: Agent<UserData>;
311
- private _swAgent?: AgentBase;
312
- private _allowInterruptions: boolean;
313
- private _minInterruptionDuration: number;
314
- private _minEndpointingDelay: number;
315
- private _maxEndpointingDelay: number;
316
- private _maxToolSteps: number;
317
- private _preemptiveGeneration: boolean;
318
- private _history: Array<Record<string, string>> = [];
319
- private _sayQueue: string[] = [];
320
- private noop = new NoopTracker();
321
-
322
- constructor(options?: {
323
- stt?: any;
324
- tts?: any;
325
- llm?: any;
326
- vad?: any;
327
- turnDetection?: any;
328
- tools?: FunctionTool[];
329
- mcpServers?: unknown;
330
- userData?: UserData;
331
- allowInterruptions?: boolean;
332
- minInterruptionDuration?: number;
333
- minEndpointingDelay?: number;
334
- maxEndpointingDelay?: number;
335
- maxToolSteps?: number;
336
- preemptiveGeneration?: boolean;
337
- }) {
338
- this._llm = options?.llm;
339
- this._tools = options?.tools ? [...options.tools] : [];
340
- this._userData = (options?.userData ?? {}) as UserData;
341
- this._allowInterruptions = options?.allowInterruptions ?? true;
342
- this._minInterruptionDuration = options?.minInterruptionDuration ?? 0.5;
343
- this._minEndpointingDelay = options?.minEndpointingDelay ?? 0.5;
344
- this._maxEndpointingDelay = options?.maxEndpointingDelay ?? 3.0;
345
- this._maxToolSteps = options?.maxToolSteps ?? 3;
346
- this._preemptiveGeneration = options?.preemptiveGeneration ?? false;
347
-
348
- if (options?.stt != null) {
349
- this.noop.once(
350
- 'stt',
351
- `WithSTT("${options.stt}"): SignalWire's control plane handles speech recognition at scale — no configuration needed`,
352
- );
353
- }
354
- if (options?.tts != null) {
355
- this.noop.once(
356
- 'tts',
357
- `WithTTS("${options.tts}"): SignalWire's control plane handles text-to-speech at scale — no configuration needed`,
358
- );
359
- }
360
- if (options?.vad != null) {
361
- this.noop.once(
362
- 'vad',
363
- "WithVAD(): SignalWire's control plane handles voice activity detection at scale automatically",
364
- );
365
- }
366
- if (options?.turnDetection != null) {
367
- this.noop.once(
368
- 'turn_detection',
369
- `WithTurnDetection("${options.turnDetection}"): SignalWire's control plane handles turn detection at scale automatically`,
370
- );
371
- }
372
- if (options?.mcpServers != null) {
373
- this.noop.once(
374
- 'mcp_servers',
375
- 'AgentSession(mcpServers=...): MCP servers are not yet supported in LiveWire -- tools should be registered via tool()',
376
- );
377
- }
378
- if (options?.maxToolSteps != null && options.maxToolSteps !== 3) {
379
- this.noop.once(
380
- 'max_tool_steps',
381
- `AgentSession(maxToolSteps=${options.maxToolSteps}): SignalWire's control plane handles tool execution depth at scale automatically`,
382
- );
383
- }
384
- }
385
-
386
- /** Start the session by binding the agent to a SignalWire AgentBase. */
387
- async start(params: { agent: Agent<UserData>; room?: any; record?: boolean }): Promise<void> {
388
- this._agent = params.agent;
389
- params.agent.session = this;
390
-
391
- // Mirrors Python _build_sw_agent(): alias self._agent for subsequent reads
392
- const agent = this._agent;
393
-
394
- // Build a real SignalWire AgentBase
395
- const swAgent = new AgentBase({
396
- name: 'LiveWireAgent',
397
- route: '/',
398
- });
399
-
400
- swAgent.setPromptText(agent.instructions);
401
-
402
- // Map LLM model if provided (session-level takes priority, then agent-level hint)
403
- const llmModel = this._llm ?? agent._llmHint;
404
- if (llmModel != null) {
405
- let model = String(llmModel);
406
- const slashIdx = model.indexOf('/');
407
- if (slashIdx >= 0) model = model.slice(slashIdx + 1);
408
- swAgent.setParam('model', model);
409
- }
410
-
411
- // Map interruption / barge settings
412
- let allowInterruptions = this._allowInterruptions;
413
- if (agent._allowInterruptions != null) {
414
- allowInterruptions = agent._allowInterruptions as boolean;
415
- }
416
- if (!allowInterruptions) {
417
- swAgent.setParam('barge_confidence', 1.0);
418
- }
419
-
420
- // Map endpointing delays
421
- let minEp: number = this._minEndpointingDelay;
422
- if (agent._minEndpointingDelay != null) {
423
- minEp = agent._minEndpointingDelay as number;
424
- }
425
- if (minEp > 0) {
426
- swAgent.setParam('end_of_speech_timeout', Math.round(minEp * 1000));
427
- }
428
-
429
- let maxEp: number = this._maxEndpointingDelay;
430
- if (agent._maxEndpointingDelay != null) {
431
- maxEp = agent._maxEndpointingDelay as number;
432
- }
433
- if (maxEp > 0) {
434
- swAgent.setParam('attention_timeout', Math.round(maxEp * 1000));
435
- }
436
-
437
- // Register all tools from the agent + session-level tools
438
- const allTools: [string, FunctionTool][] = [
439
- ...Object.entries(agent.tools),
440
- ...this._tools.map((t) => [t.name, t] as [string, FunctionTool]),
441
- ];
442
- for (const [name, toolDef] of allTools) {
443
- const handler: SwaigHandler = async (args, _rawData) => {
444
- const ctx = new RunContext<UserData>(this);
445
- const result = await toolDef.execute(args, { ctx });
446
- if (result instanceof FunctionResult) return result;
447
- if (typeof result === 'string') return new FunctionResult(result);
448
- return new FunctionResult(JSON.stringify(result));
449
- };
450
- swAgent.defineTool({
451
- name,
452
- description: toolDef.description,
453
- parameters: toolDef.parameters,
454
- handler,
455
- });
456
- }
457
-
458
- // Initial greeting (say queue)
459
- for (const text of this._sayQueue) {
460
- swAgent.promptAddSection('Initial Greeting', { body: text });
461
- }
462
-
463
- this._swAgent = swAgent;
464
- }
465
-
466
- /** Queue text to be spoken by the agent. */
467
- say(text: string): void {
468
- // If the session is already started, inject directly into the SWML flow.
469
- // Otherwise queue the text so it is replayed when start() is called.
470
- if (this._swAgent) {
471
- this._swAgent.promptAddSection('Say', { body: text });
472
- } else {
473
- this._sayQueue.push(text);
474
- }
475
- }
476
-
477
- /** Trigger the agent to generate a reply, optionally with extra instructions. */
478
- generateReply(options?: { instructions?: string }): void {
479
- if (options?.instructions && this._swAgent) {
480
- this._swAgent.promptAddSection('Initial Greeting', { body: options.instructions });
481
- }
482
- }
483
-
484
- /** Interrupt current speech -- noop on SignalWire (barge-in is automatic). */
485
- interrupt(): void {
486
- this.noop.once('interrupt', "Interrupt(): SignalWire handles barge-in automatically via its control plane");
487
- }
488
-
489
- /** Update the agent bound to this session. */
490
- updateAgent(agent: Agent<UserData>): void {
491
- this._agent = agent;
492
- agent.session = this;
493
- if (this._swAgent) {
494
- this._swAgent.setPromptText(agent.instructions);
495
- }
496
- }
497
-
498
- get userData(): UserData {
499
- return this._userData;
500
- }
501
-
502
- set userData(val: UserData) {
503
- this._userData = val;
504
- }
505
-
506
- /** Conversation history entries. */
507
- get history(): Array<Record<string, string>> {
508
- return this._history;
509
- }
510
-
511
- /** Return the underlying SignalWire AgentBase (for testing / advanced use). */
512
- getSwAgent(): AgentBase | undefined {
513
- return this._swAgent;
514
- }
515
- }
516
-
517
- // ---------------------------------------------------------------------------
518
- // tool()
519
- // ---------------------------------------------------------------------------
520
-
521
- /**
522
- * Create a tool definition -- mirrors llm.tool() from @livekit/agents-js.
523
- * Accepts a description, optional parameters (Zod or JSON schema), and an
524
- * execute function.
525
- */
526
- export function tool<P = any>(options: {
527
- description: string;
528
- parameters?: any;
529
- execute: (params: P, context: { ctx: RunContext }) => any;
530
- }): FunctionTool {
531
- // Extract JSON schema from parameters if provided
532
- let jsonSchema: Record<string, unknown> | undefined;
533
- if (options.parameters) {
534
- // If it looks like a Zod schema (has a .shape or ._def), try to extract
535
- if (typeof options.parameters === 'object' && options.parameters._def) {
536
- // Best-effort Zod extraction -- store as-is for now
537
- jsonSchema = options.parameters;
538
- } else {
539
- jsonSchema = options.parameters;
540
- }
541
- }
542
-
543
- return {
544
- name: '', // Filled in when assigned to agent.tools
545
- description: options.description,
546
- parameters: jsonSchema,
547
- execute: options.execute,
548
- };
549
- }
550
-
551
- // ---------------------------------------------------------------------------
552
- // handoff()
553
- // ---------------------------------------------------------------------------
554
-
555
- /** Create an AgentHandoff descriptor for multi-agent scenarios. */
556
- export function handoff(options: { agent: Agent; returns?: string }): AgentHandoff {
557
- const h = new AgentHandoff();
558
- h.agent = options.agent;
559
- h.returns = options.returns;
560
- return h;
561
- }
562
-
563
- // ---------------------------------------------------------------------------
564
- // AgentHandoff / StopResponse / ToolError
565
- // ---------------------------------------------------------------------------
566
-
567
- /** Signals a handoff to another agent in multi-agent scenarios. */
568
- export class AgentHandoff {
569
- agent!: Agent;
570
- returns?: string;
571
- }
572
-
573
- /** Signals that a tool should not trigger another LLM reply. */
574
- export class StopResponse extends Error {
575
- constructor(message?: string) {
576
- super(message ?? 'StopResponse');
577
- this.name = 'StopResponse';
578
- }
579
- }
580
-
581
- /** Error thrown from a tool to signal failure back to the LLM. */
582
- export class ToolError extends Error {
583
- constructor(message: string) {
584
- super(message);
585
- this.name = 'ToolError';
586
- }
587
- }
588
-
589
- // ---------------------------------------------------------------------------
590
- // JobProcess
591
- // ---------------------------------------------------------------------------
592
-
593
- /** Mirrors a LiveKit JobProcess -- used for prewarm/setup. */
594
- export class JobProcess {
595
- userData: Record<string, any> = {};
596
- }
597
-
598
- // ---------------------------------------------------------------------------
599
- // Room
600
- // ---------------------------------------------------------------------------
601
-
602
- /** Stub -- SignalWire doesn't use the LiveKit room abstraction. */
603
- export class Room {
604
- readonly name: string = 'livewire-room';
605
- }
606
-
607
- // ---------------------------------------------------------------------------
608
- // JobContext
609
- // ---------------------------------------------------------------------------
610
-
611
- /** Mirrors a LiveKit JobContext -- provides room and connection info. */
612
- export class JobContext {
613
- room: Room;
614
- proc: JobProcess;
615
- /** @internal */
616
- _swAgent?: AgentBase;
617
-
618
- constructor() {
619
- this.room = new Room();
620
- this.proc = new JobProcess();
621
- }
622
-
623
- /** Connect is a noop on SignalWire -- the platform handles connection lifecycle. */
624
- async connect(): Promise<void> {
625
- globalNoop.once(
626
- 'connect',
627
- "JobContext.connect(): SignalWire's control plane handles connection lifecycle at scale automatically",
628
- );
629
- }
630
-
631
- /** Wait for a participant -- noop on SignalWire. */
632
- async waitForParticipant(options?: { identity?: string }): Promise<any> {
633
- return { identity: options?.identity ?? 'caller' };
634
- }
635
- }
636
-
637
- // ---------------------------------------------------------------------------
638
- // defineAgent
639
- // ---------------------------------------------------------------------------
640
-
641
- /**
642
- * Mirrors @livekit/agents defineAgent().
643
- * Wraps an entry function (and optional prewarm) for later execution by runApp.
644
- */
645
- export function defineAgent(agent: {
646
- entry: (ctx: JobContext) => Promise<void>;
647
- prewarm?: (proc: JobProcess) => any;
648
- }): { entry: (ctx: JobContext) => Promise<void>; prewarm?: (proc: JobProcess) => any } {
649
- return agent;
650
- }
651
-
652
- // ---------------------------------------------------------------------------
653
- // runApp
654
- // ---------------------------------------------------------------------------
655
-
656
- /**
657
- * Mirrors cli.runApp() from @livekit/agents-js.
658
- *
659
- * 1. Prints the LiveWire banner
660
- * 2. Prints a random tip
661
- * 3. Creates a SignalWire AgentBase from the LiveKit-style config
662
- * 4. Calls the entry function with a fake JobContext
663
- * 5. Maps tools from llm.tool() format to SignalWire defineTool format
664
- * 6. Starts the agent with agent.run()
665
- */
666
- export function runApp(options: any): void {
667
- printBanner();
668
-
669
- // If passed an AgentServer instance, convert it to an agentDef-compatible object
670
- const agentDef = options instanceof AgentServer
671
- ? options._toAgentDef()
672
- : (options?.agent ?? options);
673
-
674
- // Run prewarm if registered
675
- if (agentDef?.prewarm) {
676
- const proc = new JobProcess();
677
- globalNoop.once(
678
- 'prewarm',
679
- "prewarm: Warm process pools not needed — SignalWire's control plane manages media infrastructure at scale",
680
- );
681
- agentDef.prewarm(proc);
682
- }
683
-
684
- // Create a JobContext
685
- const ctx = new JobContext();
686
-
687
- // Print a random tip
688
- printTip();
689
-
690
- // Call the entry function
691
- const entryFn = agentDef?.entry ?? agentDef;
692
- if (typeof entryFn === 'function') {
693
- Promise.resolve(entryFn(ctx)).then(() => {
694
- // After entry completes, the session should have bound a swAgent to ctx
695
- // If someone stored it on ctx, start it
696
- if (ctx._swAgent) {
697
- ctx._swAgent.run().catch((err: Error) => {
698
- process.stderr.write(`[LiveWire] agent error: ${err.message}\n`);
699
- });
700
- }
701
- }).catch((err: Error) => {
702
- process.stderr.write(`[LiveWire] entry function error: ${err.message}\n`);
703
- });
704
- }
705
- }
706
-
707
- // ---------------------------------------------------------------------------
708
- // WorkerOptions / ServerOptions
709
- // ---------------------------------------------------------------------------
710
-
711
- /** Stub for LiveKit WorkerOptions. */
712
- export class WorkerOptions {
713
- constructor(_opts?: any) {}
714
- }
715
-
716
- /** Stub for LiveKit ServerOptions. */
717
- export class ServerOptions {
718
- constructor(_opts?: any) {}
719
- }
720
-
721
- // ---------------------------------------------------------------------------
722
- // AgentServer
723
- // ---------------------------------------------------------------------------
724
-
725
- /**
726
- * Mirrors a LiveKit AgentServer -- registers entrypoints and starts.
727
- *
728
- * Usage:
729
- * const server = new AgentServer();
730
- * server.setupFnc = async (proc) => { ... };
731
- *
732
- * // Bare decorator usage:
733
- * server.rtcSession(myEntryFn);
734
- *
735
- * // Parameterized decorator usage:
736
- * server.rtcSession({ agentName: 'myAgent' })(myEntryFn);
737
- *
738
- * cli.runApp(server);
739
- */
740
- export class AgentServer {
741
- /** Optional prewarm hook called before the entrypoint. Mirrors Python's setup_fnc. */
742
- setupFnc?: (proc: JobProcess) => void;
743
-
744
- /** @internal Registered entrypoint function. */
745
- private _entryFn?: (ctx: JobContext) => Promise<void>;
746
-
747
- /** @internal Agent name hint registered via rtcSession(). */
748
- private _agentName: string = '';
749
-
750
- constructor(_opts?: any) {}
751
-
752
- /**
753
- * Decorator that registers the session entrypoint.
754
- *
755
- * Supports both bare and parameterized usage:
756
- * server.rtcSession(fn) // bare
757
- * server.rtcSession(fn, { agentName: 'x' }) // with opts, explicit fn
758
- * server.rtcSession({ agentName: 'x' })(fn) // parameterized decorator
759
- * @server.rtcSession // decorator (bare)
760
- * @server.rtcSession({ agentName: 'x' }) // decorator (parameterized)
761
- */
762
- rtcSession(
763
- fnOrOpts?:
764
- | ((ctx: JobContext) => Promise<void>)
765
- | {
766
- agentName?: string;
767
- type?: string;
768
- onRequest?: ((...args: any[]) => any) | null;
769
- onSessionEnd?: ((...args: any[]) => any) | null;
770
- },
771
- opts?: {
772
- agentName?: string;
773
- type?: string;
774
- onRequest?: ((...args: any[]) => any) | null;
775
- onSessionEnd?: ((...args: any[]) => any) | null;
776
- },
777
- ): ((fn: (ctx: JobContext) => Promise<void>) => (ctx: JobContext) => Promise<void>) | void {
778
- // Determine whether first arg is a function or an options object
779
- let fn: ((ctx: JobContext) => Promise<void>) | undefined;
780
- let resolvedOpts: typeof opts;
781
-
782
- if (typeof fnOrOpts === 'function') {
783
- fn = fnOrOpts;
784
- resolvedOpts = opts;
785
- } else {
786
- // fnOrOpts is an options object (or undefined) — parameterized decorator usage
787
- resolvedOpts = fnOrOpts;
788
- }
789
-
790
- if (resolvedOpts?.type && resolvedOpts.type !== 'room') {
791
- globalNoop.once(
792
- 'server_type',
793
- `AgentServer.rtcSession(type=${JSON.stringify(resolvedOpts.type)}): SignalWire's control plane handles server topology at scale automatically`,
794
- );
795
- }
796
-
797
- const register = (entryFn: (ctx: JobContext) => Promise<void>) => {
798
- this._entryFn = entryFn;
799
- if (resolvedOpts?.agentName) this._agentName = resolvedOpts.agentName;
800
- return entryFn;
801
- };
802
-
803
- if (fn) {
804
- register(fn);
805
- return;
806
- }
807
- return register;
808
- }
809
-
810
- /** @internal Extract agentDef-compatible shape for use by runApp. */
811
- _toAgentDef(): {
812
- entry: (ctx: JobContext) => Promise<void>;
813
- prewarm?: (proc: JobProcess) => void;
814
- } {
815
- return {
816
- entry: this._entryFn ?? (async (_ctx: JobContext) => {}),
817
- prewarm: this.setupFnc,
818
- };
819
- }
820
- }
821
-
822
- // ---------------------------------------------------------------------------
823
- // Plugin stubs
824
- // ---------------------------------------------------------------------------
825
-
826
- /** Stub providers matching common LiveKit plugin packages. */
827
- export namespace plugins {
828
- export class DeepgramSTT {
829
- constructor(_opts?: any) {
830
- globalNoop.once(
831
- 'stt_plugin',
832
- 'DeepgramSTT: SignalWire\'s control plane handles the full media pipeline at scale',
833
- );
834
- }
835
- }
836
-
837
- export class OpenAILLM {
838
- model: string;
839
- constructor(_opts?: any) {
840
- this.model = ((_opts as any)?.model as string) ?? '';
841
- globalNoop.once(
842
- 'openai_llm',
843
- 'OpenAILLM(): model selection is mapped to SignalWire AI params -- OpenAI plugin wrapper is a no-op',
844
- );
845
- }
846
- }
847
-
848
- export class CartesiaTTS {
849
- constructor(_opts?: any) {
850
- globalNoop.once(
851
- 'cartesia_tts',
852
- "CartesiaTTS: SignalWire's control plane handles the full media pipeline at scale",
853
- );
854
- }
855
- }
856
-
857
- export class ElevenLabsTTS {
858
- constructor(_opts?: any) {
859
- globalNoop.once(
860
- 'elevenlabs_tts',
861
- "ElevenLabsTTS: SignalWire's control plane handles the full media pipeline at scale",
862
- );
863
- }
864
- }
865
-
866
- export class SileroVAD {
867
- constructor(_opts?: Record<string, unknown>) {}
868
-
869
- static load(): SileroVAD {
870
- globalNoop.once(
871
- 'vad_plugin',
872
- "SileroVAD.load(): SignalWire's control plane handles voice activity detection at scale automatically",
873
- );
874
- return new SileroVAD();
875
- }
876
- }
877
- }
878
-
879
- // ---------------------------------------------------------------------------
880
- // Inference module stubs
881
- // ---------------------------------------------------------------------------
882
-
883
- /** Stub inference types matching LiveKit's inference namespace. */
884
- export namespace inference {
885
- export class STT {
886
- model: string;
887
- constructor(model: string = '', _opts?: any) {
888
- this.model = model;
889
- globalNoop.once(
890
- 'inference_stt',
891
- 'inference.STT: SignalWire\'s control plane handles speech recognition at scale',
892
- );
893
- }
894
- }
895
-
896
- export class LLM {
897
- model: string;
898
- constructor(model: string = '', _opts?: any) {
899
- this.model = model;
900
- }
901
- }
902
-
903
- export class TTS {
904
- model: string;
905
- constructor(model: string = '', _opts?: any) {
906
- this.model = model;
907
- globalNoop.once(
908
- 'inference_tts',
909
- 'inference.TTS: SignalWire\'s control plane handles text-to-speech at scale',
910
- );
911
- }
912
- }
913
- }
914
-
915
- // ---------------------------------------------------------------------------
916
- // Namespace re-exports matching @livekit/agents
917
- // ---------------------------------------------------------------------------
918
-
919
- /** LiveKit voice namespace equivalent. */
920
- export const voice = {
921
- Agent,
922
- AgentSession,
923
- AgentSessionEventTypes: {} as Record<string, string>,
924
- };
925
-
926
- /** Minimal ChatContext matching livekit ChatContext. */
927
- export class ChatContext {
928
- messages: Array<Record<string, string>> = [];
929
-
930
- append(options: { role?: string; text?: string }): this {
931
- this.messages.push({ role: options.role ?? 'user', content: options.text ?? '' });
932
- return this;
933
- }
934
- }
935
-
936
- /** LiveKit llm namespace equivalent. */
937
- export const llm = {
938
- tool,
939
- handoff,
940
- ToolError,
941
- ChatContext,
942
- };
943
-
944
- /** LiveKit cli namespace equivalent. */
945
- export const cli = {
946
- runApp,
947
- };
948
-
949
- // Re-export banner/tip functions for testing
950
- export { printBanner, printTip, banner };