@signalwire/sdk 2.0.1 → 2.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (610) hide show
  1. package/dist/AgentBase.d.ts +1045 -0
  2. package/dist/AgentBase.js +2375 -0
  3. package/dist/AgentBase.js.map +1 -0
  4. package/dist/AgentServer.d.ts +146 -0
  5. package/dist/AgentServer.js +388 -0
  6. package/dist/AgentServer.js.map +1 -0
  7. package/dist/AuthHandler.d.ts +127 -0
  8. package/dist/AuthHandler.js +212 -0
  9. package/dist/AuthHandler.js.map +1 -0
  10. package/dist/ConfigLoader.d.ts +170 -0
  11. package/dist/ConfigLoader.js +393 -0
  12. package/dist/ConfigLoader.js.map +1 -0
  13. package/dist/ContextBuilder.d.ts +652 -0
  14. package/dist/ContextBuilder.js +1115 -0
  15. package/dist/ContextBuilder.js.map +1 -0
  16. package/dist/DataMap.d.ts +271 -0
  17. package/dist/DataMap.js +430 -0
  18. package/dist/DataMap.js.map +1 -0
  19. package/dist/FunctionResult.d.ts +481 -0
  20. package/dist/FunctionResult.js +775 -0
  21. package/dist/FunctionResult.js.map +1 -0
  22. package/dist/Logger.d.ts +113 -0
  23. package/dist/Logger.js +320 -0
  24. package/dist/Logger.js.map +1 -0
  25. package/dist/PomBuilder.d.ts +208 -0
  26. package/dist/PomBuilder.js +409 -0
  27. package/dist/PomBuilder.js.map +1 -0
  28. package/dist/PromptManager.d.ts +85 -0
  29. package/dist/PromptManager.js +108 -0
  30. package/dist/PromptManager.js.map +1 -0
  31. package/dist/SWMLHandler.d.ts +159 -0
  32. package/dist/SWMLHandler.js +229 -0
  33. package/dist/SWMLHandler.js.map +1 -0
  34. package/dist/SWMLService.d.ts +326 -0
  35. package/dist/SWMLService.js +610 -0
  36. package/dist/SWMLService.js.map +1 -0
  37. package/dist/SchemaUtils.d.ts +108 -0
  38. package/dist/SchemaUtils.js +317 -0
  39. package/dist/SchemaUtils.js.map +1 -0
  40. package/dist/SecurityUtils.d.ts +60 -0
  41. package/{src/SecurityUtils.ts → dist/SecurityUtils.js} +82 -83
  42. package/dist/SecurityUtils.js.map +1 -0
  43. package/dist/ServerlessAdapter.d.ts +119 -0
  44. package/dist/ServerlessAdapter.js +188 -0
  45. package/dist/ServerlessAdapter.js.map +1 -0
  46. package/dist/SessionManager.d.ts +142 -0
  47. package/dist/SessionManager.js +260 -0
  48. package/dist/SessionManager.js.map +1 -0
  49. package/dist/SslConfig.d.ts +77 -0
  50. package/dist/SslConfig.js +100 -0
  51. package/dist/SslConfig.js.map +1 -0
  52. package/dist/SwaigFunction.d.ts +159 -0
  53. package/dist/SwaigFunction.js +209 -0
  54. package/dist/SwaigFunction.js.map +1 -0
  55. package/dist/SwmlBuilder.d.ts +165 -0
  56. package/dist/SwmlBuilder.js +247 -0
  57. package/dist/SwmlBuilder.js.map +1 -0
  58. package/dist/SwmlVerbMethods.generated.d.ts +254 -0
  59. package/dist/SwmlVerbMethods.generated.js +9 -0
  60. package/dist/SwmlVerbMethods.generated.js.map +1 -0
  61. package/dist/TypeInference.d.ts +71 -0
  62. package/dist/TypeInference.js +164 -0
  63. package/dist/TypeInference.js.map +1 -0
  64. package/dist/WebService.d.ts +148 -0
  65. package/dist/WebService.js +532 -0
  66. package/dist/WebService.js.map +1 -0
  67. package/dist/cli/agent-loader.d.ts +22 -0
  68. package/dist/cli/agent-loader.js +144 -0
  69. package/dist/cli/agent-loader.js.map +1 -0
  70. package/dist/cli/mock-data.d.ts +37 -0
  71. package/dist/cli/mock-data.js +80 -0
  72. package/dist/cli/mock-data.js.map +1 -0
  73. package/dist/cli/swaig-test.d.ts +32 -0
  74. package/dist/cli/swaig-test.js +418 -0
  75. package/dist/cli/swaig-test.js.map +1 -0
  76. package/dist/generateVerbTypes.d.ts +11 -0
  77. package/dist/generateVerbTypes.js +265 -0
  78. package/dist/generateVerbTypes.js.map +1 -0
  79. package/{src/index.ts → dist/index.d.ts} +13 -100
  80. package/dist/index.js +152 -0
  81. package/dist/index.js.map +1 -0
  82. package/dist/livewire/index.d.ts +653 -0
  83. package/dist/livewire/index.js +992 -0
  84. package/dist/livewire/index.js.map +1 -0
  85. package/dist/prefabs/ConciergeAgent.d.ts +89 -0
  86. package/dist/prefabs/ConciergeAgent.js +245 -0
  87. package/dist/prefabs/ConciergeAgent.js.map +1 -0
  88. package/dist/prefabs/FAQBotAgent.d.ts +113 -0
  89. package/dist/prefabs/FAQBotAgent.js +329 -0
  90. package/dist/prefabs/FAQBotAgent.js.map +1 -0
  91. package/dist/prefabs/InfoGathererAgent.d.ts +126 -0
  92. package/dist/prefabs/InfoGathererAgent.js +287 -0
  93. package/dist/prefabs/InfoGathererAgent.js.map +1 -0
  94. package/dist/prefabs/ReceptionistAgent.d.ts +104 -0
  95. package/dist/prefabs/ReceptionistAgent.js +303 -0
  96. package/dist/prefabs/ReceptionistAgent.js.map +1 -0
  97. package/dist/prefabs/SurveyAgent.d.ts +148 -0
  98. package/dist/prefabs/SurveyAgent.js +540 -0
  99. package/dist/prefabs/SurveyAgent.js.map +1 -0
  100. package/{src/prefabs/index.ts → dist/prefabs/index.d.ts} +1 -15
  101. package/dist/prefabs/index.js +14 -0
  102. package/dist/prefabs/index.js.map +1 -0
  103. package/dist/relay/Action.d.ts +258 -0
  104. package/dist/relay/Action.js +402 -0
  105. package/dist/relay/Action.js.map +1 -0
  106. package/dist/relay/Call.d.ts +697 -0
  107. package/dist/relay/Call.js +1062 -0
  108. package/dist/relay/Call.js.map +1 -0
  109. package/dist/relay/Deferred.d.ts +44 -0
  110. package/dist/relay/Deferred.js +69 -0
  111. package/dist/relay/Deferred.js.map +1 -0
  112. package/dist/relay/Message.d.ts +103 -0
  113. package/dist/relay/Message.js +169 -0
  114. package/dist/relay/Message.js.map +1 -0
  115. package/dist/relay/RelayClient.d.ts +302 -0
  116. package/dist/relay/RelayClient.js +1026 -0
  117. package/dist/relay/RelayClient.js.map +1 -0
  118. package/dist/relay/RelayError.d.ts +15 -0
  119. package/dist/relay/RelayError.js +20 -0
  120. package/dist/relay/RelayError.js.map +1 -0
  121. package/dist/relay/RelayEvent.d.ts +254 -0
  122. package/dist/relay/RelayEvent.js +509 -0
  123. package/dist/relay/RelayEvent.js.map +1 -0
  124. package/dist/relay/constants.d.ts +90 -0
  125. package/{src/relay/constants.ts → dist/relay/constants.js} +11 -29
  126. package/dist/relay/constants.js.map +1 -0
  127. package/dist/relay/index.d.ts +16 -0
  128. package/dist/relay/index.js +18 -0
  129. package/dist/relay/index.js.map +1 -0
  130. package/dist/relay/types.d.ts +142 -0
  131. package/dist/relay/types.js +5 -0
  132. package/dist/relay/types.js.map +1 -0
  133. package/dist/rest/HttpClient.d.ts +80 -0
  134. package/dist/rest/HttpClient.js +148 -0
  135. package/dist/rest/HttpClient.js.map +1 -0
  136. package/dist/rest/RestError.d.ts +30 -0
  137. package/dist/rest/RestError.js +39 -0
  138. package/dist/rest/RestError.js.map +1 -0
  139. package/dist/rest/base/BaseResource.d.ts +24 -0
  140. package/dist/rest/base/BaseResource.js +29 -0
  141. package/dist/rest/base/BaseResource.js.map +1 -0
  142. package/dist/rest/base/CrudResource.d.ts +68 -0
  143. package/dist/rest/base/CrudResource.js +82 -0
  144. package/dist/rest/base/CrudResource.js.map +1 -0
  145. package/dist/rest/base/CrudWithAddresses.d.ts +22 -0
  146. package/dist/rest/base/CrudWithAddresses.js +25 -0
  147. package/dist/rest/base/CrudWithAddresses.js.map +1 -0
  148. package/dist/rest/index.d.ts +131 -0
  149. package/{src/rest/index.ts → dist/rest/index.js} +101 -136
  150. package/dist/rest/index.js.map +1 -0
  151. package/dist/rest/namespaces/addresses.d.ts +46 -0
  152. package/dist/rest/namespaces/addresses.js +55 -0
  153. package/dist/rest/namespaces/addresses.js.map +1 -0
  154. package/dist/rest/namespaces/calling.d.ts +382 -0
  155. package/dist/rest/namespaces/calling.js +478 -0
  156. package/dist/rest/namespaces/calling.js.map +1 -0
  157. package/dist/rest/namespaces/chat.d.ts +22 -0
  158. package/dist/rest/namespaces/chat.js +26 -0
  159. package/dist/rest/namespaces/chat.js.map +1 -0
  160. package/dist/rest/namespaces/compat.d.ts +585 -0
  161. package/dist/rest/namespaces/compat.js +735 -0
  162. package/dist/rest/namespaces/compat.js.map +1 -0
  163. package/dist/rest/namespaces/datasphere.d.ts +66 -0
  164. package/dist/rest/namespaces/datasphere.js +77 -0
  165. package/dist/rest/namespaces/datasphere.js.map +1 -0
  166. package/dist/rest/namespaces/fabric.d.ts +282 -0
  167. package/dist/rest/namespaces/fabric.js +373 -0
  168. package/dist/rest/namespaces/fabric.js.map +1 -0
  169. package/dist/rest/namespaces/imported-numbers.d.ts +22 -0
  170. package/dist/rest/namespaces/imported-numbers.js +26 -0
  171. package/dist/rest/namespaces/imported-numbers.js.map +1 -0
  172. package/dist/rest/namespaces/logs.d.ts +105 -0
  173. package/dist/rest/namespaces/logs.js +133 -0
  174. package/dist/rest/namespaces/logs.js.map +1 -0
  175. package/dist/rest/namespaces/lookup.d.ts +29 -0
  176. package/dist/rest/namespaces/lookup.js +32 -0
  177. package/dist/rest/namespaces/lookup.js.map +1 -0
  178. package/dist/rest/namespaces/mfa.d.ts +46 -0
  179. package/dist/rest/namespaces/mfa.js +54 -0
  180. package/dist/rest/namespaces/mfa.js.map +1 -0
  181. package/dist/rest/namespaces/number-groups.d.ts +49 -0
  182. package/dist/rest/namespaces/number-groups.js +58 -0
  183. package/dist/rest/namespaces/number-groups.js.map +1 -0
  184. package/dist/rest/namespaces/phone-numbers.d.ts +60 -0
  185. package/dist/rest/namespaces/phone-numbers.js +67 -0
  186. package/dist/rest/namespaces/phone-numbers.js.map +1 -0
  187. package/dist/rest/namespaces/project.d.ts +46 -0
  188. package/dist/rest/namespaces/project.js +56 -0
  189. package/dist/rest/namespaces/project.js.map +1 -0
  190. package/dist/rest/namespaces/pubsub.d.ts +22 -0
  191. package/dist/rest/namespaces/pubsub.js +26 -0
  192. package/dist/rest/namespaces/pubsub.js.map +1 -0
  193. package/dist/rest/namespaces/queues.d.ts +42 -0
  194. package/dist/rest/namespaces/queues.js +49 -0
  195. package/dist/rest/namespaces/queues.js.map +1 -0
  196. package/dist/rest/namespaces/recordings.d.ts +38 -0
  197. package/dist/rest/namespaces/recordings.js +45 -0
  198. package/dist/rest/namespaces/recordings.js.map +1 -0
  199. package/dist/rest/namespaces/registry.d.ts +141 -0
  200. package/dist/rest/namespaces/registry.js +178 -0
  201. package/dist/rest/namespaces/registry.js.map +1 -0
  202. package/dist/rest/namespaces/short-codes.d.ts +39 -0
  203. package/dist/rest/namespaces/short-codes.js +46 -0
  204. package/dist/rest/namespaces/short-codes.js.map +1 -0
  205. package/dist/rest/namespaces/sip-profile.d.ts +28 -0
  206. package/dist/rest/namespaces/sip-profile.js +34 -0
  207. package/dist/rest/namespaces/sip-profile.js.map +1 -0
  208. package/dist/rest/namespaces/verified-callers.d.ts +33 -0
  209. package/dist/rest/namespaces/verified-callers.js +39 -0
  210. package/dist/rest/namespaces/verified-callers.js.map +1 -0
  211. package/dist/rest/namespaces/video.d.ts +235 -0
  212. package/dist/rest/namespaces/video.js +297 -0
  213. package/dist/rest/namespaces/video.js.map +1 -0
  214. package/{src/rest/pagination.ts → dist/rest/pagination.d.ts} +2 -61
  215. package/dist/rest/pagination.js +78 -0
  216. package/dist/rest/pagination.js.map +1 -0
  217. package/dist/rest/types.d.ts +54 -0
  218. package/dist/rest/types.js +5 -0
  219. package/dist/rest/types.js.map +1 -0
  220. package/dist/skills/SkillBase.d.ts +404 -0
  221. package/dist/skills/SkillBase.js +471 -0
  222. package/dist/skills/SkillBase.js.map +1 -0
  223. package/dist/skills/SkillManager.d.ts +195 -0
  224. package/dist/skills/SkillManager.js +378 -0
  225. package/dist/skills/SkillManager.js.map +1 -0
  226. package/dist/skills/SkillRegistry.d.ts +176 -0
  227. package/dist/skills/SkillRegistry.js +310 -0
  228. package/dist/skills/SkillRegistry.js.map +1 -0
  229. package/dist/skills/builtin/api_ninjas_trivia.d.ts +47 -0
  230. package/dist/skills/builtin/api_ninjas_trivia.js +211 -0
  231. package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -0
  232. package/dist/skills/builtin/ask_claude.d.ts +37 -0
  233. package/dist/skills/builtin/ask_claude.js +162 -0
  234. package/dist/skills/builtin/ask_claude.js.map +1 -0
  235. package/dist/skills/builtin/claude_skills.d.ts +75 -0
  236. package/dist/skills/builtin/claude_skills.js +753 -0
  237. package/dist/skills/builtin/claude_skills.js.map +1 -0
  238. package/dist/skills/builtin/custom_skills.d.ts +79 -0
  239. package/dist/skills/builtin/custom_skills.js +227 -0
  240. package/dist/skills/builtin/custom_skills.js.map +1 -0
  241. package/dist/skills/builtin/datasphere.d.ts +73 -0
  242. package/dist/skills/builtin/datasphere.js +350 -0
  243. package/dist/skills/builtin/datasphere.js.map +1 -0
  244. package/dist/skills/builtin/datasphere_serverless.d.ts +89 -0
  245. package/dist/skills/builtin/datasphere_serverless.js +291 -0
  246. package/dist/skills/builtin/datasphere_serverless.js.map +1 -0
  247. package/dist/skills/builtin/datetime.d.ts +40 -0
  248. package/dist/skills/builtin/datetime.js +118 -0
  249. package/dist/skills/builtin/datetime.js.map +1 -0
  250. package/dist/skills/builtin/google_maps.d.ts +48 -0
  251. package/dist/skills/builtin/google_maps.js +470 -0
  252. package/dist/skills/builtin/google_maps.js.map +1 -0
  253. package/dist/skills/builtin/index.d.ts +31 -0
  254. package/{src/skills/builtin/index.ts → dist/skills/builtin/index.js} +30 -36
  255. package/dist/skills/builtin/index.js.map +1 -0
  256. package/dist/skills/builtin/info_gatherer.d.ts +115 -0
  257. package/dist/skills/builtin/info_gatherer.js +328 -0
  258. package/dist/skills/builtin/info_gatherer.js.map +1 -0
  259. package/dist/skills/builtin/joke.d.ts +41 -0
  260. package/dist/skills/builtin/joke.js +156 -0
  261. package/dist/skills/builtin/joke.js.map +1 -0
  262. package/dist/skills/builtin/math.d.ts +39 -0
  263. package/dist/skills/builtin/math.js +119 -0
  264. package/dist/skills/builtin/math.js.map +1 -0
  265. package/dist/skills/builtin/mcp_gateway.d.ts +82 -0
  266. package/dist/skills/builtin/mcp_gateway.js +574 -0
  267. package/dist/skills/builtin/mcp_gateway.js.map +1 -0
  268. package/dist/skills/builtin/native_vector_search.d.ts +128 -0
  269. package/dist/skills/builtin/native_vector_search.js +752 -0
  270. package/dist/skills/builtin/native_vector_search.js.map +1 -0
  271. package/dist/skills/builtin/play_background_file.d.ts +59 -0
  272. package/dist/skills/builtin/play_background_file.js +274 -0
  273. package/dist/skills/builtin/play_background_file.js.map +1 -0
  274. package/dist/skills/builtin/spider.d.ts +91 -0
  275. package/dist/skills/builtin/spider.js +758 -0
  276. package/dist/skills/builtin/spider.js.map +1 -0
  277. package/dist/skills/builtin/swml_transfer.d.ts +66 -0
  278. package/dist/skills/builtin/swml_transfer.js +475 -0
  279. package/dist/skills/builtin/swml_transfer.js.map +1 -0
  280. package/dist/skills/builtin/weather_api.d.ts +59 -0
  281. package/dist/skills/builtin/weather_api.js +196 -0
  282. package/dist/skills/builtin/weather_api.js.map +1 -0
  283. package/dist/skills/builtin/web_search.d.ts +160 -0
  284. package/dist/skills/builtin/web_search.js +894 -0
  285. package/dist/skills/builtin/web_search.js.map +1 -0
  286. package/dist/skills/builtin/wikipedia_search.d.ts +77 -0
  287. package/dist/skills/builtin/wikipedia_search.js +241 -0
  288. package/dist/skills/builtin/wikipedia_search.js.map +1 -0
  289. package/{src/skills/index.ts → dist/skills/index.d.ts} +0 -1
  290. package/dist/skills/index.js +10 -0
  291. package/dist/skills/index.js.map +1 -0
  292. package/dist/types.d.ts +118 -0
  293. package/dist/types.js +5 -0
  294. package/dist/types.js.map +1 -0
  295. package/package.json +7 -1
  296. package/.github/workflows/publish.yml +0 -27
  297. package/.github/workflows/test.yml +0 -17
  298. package/CLAUDE.md +0 -112
  299. package/docs/MIGRATION-2.0.md +0 -81
  300. package/docs/agent-guide.md +0 -869
  301. package/docs/agent_guide.md +0 -1026
  302. package/docs/api-reference.md +0 -2420
  303. package/docs/api_reference.md +0 -1301
  304. package/docs/architecture.md +0 -843
  305. package/docs/cli-guide.md +0 -579
  306. package/docs/cli_guide.md +0 -448
  307. package/docs/cloud_functions_guide.md +0 -474
  308. package/docs/configuration.md +0 -422
  309. package/docs/contexts-guide.md +0 -787
  310. package/docs/contexts_guide.md +0 -511
  311. package/docs/datamap-guide.md +0 -1141
  312. package/docs/datamap_guide.md +0 -595
  313. package/docs/llm_parameters.md +0 -239
  314. package/docs/mcp_gateway_reference.md +0 -648
  315. package/docs/mcp_integration.md +0 -108
  316. package/docs/prefabs-guide.md +0 -800
  317. package/docs/sdk_features.md +0 -477
  318. package/docs/security.md +0 -436
  319. package/docs/serverless-guide.md +0 -513
  320. package/docs/skills-guide.md +0 -857
  321. package/docs/skills-system.md +0 -301
  322. package/docs/skills_parameter_schema.md +0 -392
  323. package/docs/skills_system.md +0 -467
  324. package/docs/swaig-reference.md +0 -1627
  325. package/docs/swaig_reference.md +0 -910
  326. package/docs/swml_service_guide.md +0 -600
  327. package/docs/third_party_skills.md +0 -533
  328. package/docs/web_service.md +0 -677
  329. package/examples/README.md +0 -131
  330. package/examples/advanced-datamap.ts +0 -100
  331. package/examples/advanced-dynamic-config.ts +0 -70
  332. package/examples/auto-vivified.ts +0 -94
  333. package/examples/call-flow.ts +0 -63
  334. package/examples/comprehensive-dynamic.ts +0 -125
  335. package/examples/contexts-steps.ts +0 -65
  336. package/examples/custom-path.ts +0 -45
  337. package/examples/datamap-tools.ts +0 -55
  338. package/examples/datasphere-multi-instance.ts +0 -63
  339. package/examples/datasphere-serverless-env.ts +0 -68
  340. package/examples/datasphere-webhook-env.ts +0 -66
  341. package/examples/datasphere.ts +0 -37
  342. package/examples/declarative.ts +0 -100
  343. package/examples/dynamic-config.ts +0 -54
  344. package/examples/dynamic-info-gatherer.ts +0 -69
  345. package/examples/dynamic-swml-service.ts +0 -67
  346. package/examples/gather-info.ts +0 -71
  347. package/examples/gather-per-question-functions-demo.ts +0 -140
  348. package/examples/joke-agent.ts +0 -34
  349. package/examples/kubernetes-agent.ts +0 -45
  350. package/examples/llm-params.ts +0 -69
  351. package/examples/mcp-agent.ts +0 -84
  352. package/examples/mcp-gateway.ts +0 -35
  353. package/examples/multi-agent.ts +0 -73
  354. package/examples/multi-endpoint.ts +0 -79
  355. package/examples/pom-prompt.ts +0 -71
  356. package/examples/prefab-concierge.ts +0 -47
  357. package/examples/prefab-faq.ts +0 -54
  358. package/examples/prefab-info-gatherer.ts +0 -33
  359. package/examples/prefab-receptionist.ts +0 -36
  360. package/examples/prefab-survey.ts +0 -68
  361. package/examples/record-call.ts +0 -67
  362. package/examples/relay-demo.ts +0 -33
  363. package/examples/room-and-sip.ts +0 -94
  364. package/examples/serverless-lambda.ts +0 -35
  365. package/examples/session-state.ts +0 -83
  366. package/examples/simple-agent.ts +0 -36
  367. package/examples/simple-static.ts +0 -29
  368. package/examples/skills-demo.ts +0 -38
  369. package/examples/step-function-inheritance-demo.ts +0 -124
  370. package/examples/swaig-features.ts +0 -187
  371. package/examples/swml-service-routing.ts +0 -66
  372. package/examples/swml-service.ts +0 -38
  373. package/examples/tap.ts +0 -68
  374. package/examples/verb-methods.ts +0 -45
  375. package/examples/web-search-multi-instance.ts +0 -72
  376. package/examples/web-search.ts +0 -38
  377. package/examples/wikipedia.ts +0 -36
  378. package/livewire/README.md +0 -140
  379. package/livewire/docs/migration-guide.md +0 -228
  380. package/livewire/examples/livewire-basic-agent.ts +0 -74
  381. package/livewire/examples/livewire-handoff.ts +0 -197
  382. package/livewire/examples/livewire-multi-tool.ts +0 -117
  383. package/relay/README.md +0 -70
  384. package/relay/RELAY_IMPLEMENTATION_GUIDE.md +0 -1257
  385. package/relay/docs/call-methods.md +0 -474
  386. package/relay/docs/client-reference.md +0 -142
  387. package/relay/docs/events.md +0 -134
  388. package/relay/docs/getting-started.md +0 -134
  389. package/relay/docs/guide.md +0 -306
  390. package/relay/docs/messaging.md +0 -182
  391. package/relay/examples/relay-inbound.ts +0 -66
  392. package/relay/examples/relay-messaging.ts +0 -71
  393. package/relay/examples/relay-outbound.ts +0 -76
  394. package/rest/README.md +0 -95
  395. package/rest/docs/calling.md +0 -273
  396. package/rest/docs/client-reference.md +0 -107
  397. package/rest/docs/compat.md +0 -204
  398. package/rest/docs/fabric.md +0 -183
  399. package/rest/docs/getting-started.md +0 -110
  400. package/rest/docs/guide.md +0 -351
  401. package/rest/docs/namespaces.md +0 -285
  402. package/rest/examples/rest-10dlc-registration.ts +0 -161
  403. package/rest/examples/rest-calling-ivr-and-ai.ts +0 -102
  404. package/rest/examples/rest-calling-play-and-record.ts +0 -91
  405. package/rest/examples/rest-client.ts +0 -65
  406. package/rest/examples/rest-compat-laml.ts +0 -210
  407. package/rest/examples/rest-datasphere-search.ts +0 -82
  408. package/rest/examples/rest-fabric-conferences-and-routing.ts +0 -144
  409. package/rest/examples/rest-fabric-subscribers-and-sip.ts +0 -108
  410. package/rest/examples/rest-fabric-swml-and-callflows.ts +0 -99
  411. package/rest/examples/rest-manage-resources.ts +0 -65
  412. package/rest/examples/rest-phone-number-management.ts +0 -197
  413. package/rest/examples/rest-queues-mfa-and-recordings.ts +0 -143
  414. package/rest/examples/rest-video-rooms.ts +0 -186
  415. package/src/AgentBase.ts +0 -2598
  416. package/src/AgentServer.ts +0 -442
  417. package/src/AuthHandler.ts +0 -256
  418. package/src/ConfigLoader.ts +0 -447
  419. package/src/ContextBuilder.ts +0 -1181
  420. package/src/DataMap.ts +0 -477
  421. package/src/FunctionResult.ts +0 -903
  422. package/src/Logger.ts +0 -337
  423. package/src/PomBuilder.ts +0 -467
  424. package/src/PromptManager.ts +0 -133
  425. package/src/SWMLHandler.ts +0 -298
  426. package/src/SWMLService.ts +0 -749
  427. package/src/SchemaUtils.ts +0 -361
  428. package/src/ServerlessAdapter.ts +0 -240
  429. package/src/SessionManager.ts +0 -311
  430. package/src/SslConfig.ts +0 -118
  431. package/src/SwaigFunction.ts +0 -276
  432. package/src/SwmlBuilder.ts +0 -283
  433. package/src/SwmlVerbMethods.generated.ts +0 -234
  434. package/src/TypeInference.ts +0 -199
  435. package/src/WebService.ts +0 -641
  436. package/src/cli/agent-loader.ts +0 -166
  437. package/src/cli/mock-data.ts +0 -111
  438. package/src/cli/swaig-test.ts +0 -452
  439. package/src/generateVerbTypes.ts +0 -322
  440. package/src/livewire/index.ts +0 -1252
  441. package/src/prefabs/ConciergeAgent.ts +0 -309
  442. package/src/prefabs/FAQBotAgent.ts +0 -415
  443. package/src/prefabs/InfoGathererAgent.ts +0 -379
  444. package/src/prefabs/ReceptionistAgent.ts +0 -395
  445. package/src/prefabs/SurveyAgent.ts +0 -671
  446. package/src/relay/Action.ts +0 -482
  447. package/src/relay/Call.ts +0 -1270
  448. package/src/relay/Deferred.ts +0 -94
  449. package/src/relay/Message.ts +0 -199
  450. package/src/relay/RelayClient.ts +0 -1185
  451. package/src/relay/RelayError.ts +0 -20
  452. package/src/relay/RelayEvent.ts +0 -944
  453. package/src/relay/index.ts +0 -123
  454. package/src/relay/types.ts +0 -149
  455. package/src/rest/HttpClient.ts +0 -164
  456. package/src/rest/RestError.ts +0 -45
  457. package/src/rest/base/BaseResource.ts +0 -32
  458. package/src/rest/base/CrudResource.ts +0 -98
  459. package/src/rest/base/CrudWithAddresses.ts +0 -37
  460. package/src/rest/namespaces/addresses.ts +0 -64
  461. package/src/rest/namespaces/calling.ts +0 -534
  462. package/src/rest/namespaces/chat.ts +0 -31
  463. package/src/rest/namespaces/compat.ts +0 -812
  464. package/src/rest/namespaces/datasphere.ts +0 -88
  465. package/src/rest/namespaces/fabric.ts +0 -417
  466. package/src/rest/namespaces/imported-numbers.ts +0 -31
  467. package/src/rest/namespaces/logs.ts +0 -151
  468. package/src/rest/namespaces/lookup.ts +0 -38
  469. package/src/rest/namespaces/mfa.ts +0 -61
  470. package/src/rest/namespaces/number-groups.ts +0 -68
  471. package/src/rest/namespaces/phone-numbers.ts +0 -76
  472. package/src/rest/namespaces/project.ts +0 -65
  473. package/src/rest/namespaces/pubsub.ts +0 -31
  474. package/src/rest/namespaces/queues.ts +0 -58
  475. package/src/rest/namespaces/recordings.ts +0 -53
  476. package/src/rest/namespaces/registry.ts +0 -200
  477. package/src/rest/namespaces/short-codes.ts +0 -54
  478. package/src/rest/namespaces/sip-profile.ts +0 -40
  479. package/src/rest/namespaces/verified-callers.ts +0 -46
  480. package/src/rest/namespaces/video.ts +0 -332
  481. package/src/rest/types.ts +0 -61
  482. package/src/skills/SkillBase.ts +0 -582
  483. package/src/skills/SkillManager.ts +0 -419
  484. package/src/skills/SkillRegistry.ts +0 -367
  485. package/src/skills/builtin/api_ninjas_trivia.ts +0 -285
  486. package/src/skills/builtin/ask_claude.ts +0 -246
  487. package/src/skills/builtin/claude_skills.ts +0 -983
  488. package/src/skills/builtin/custom_skills.ts +0 -327
  489. package/src/skills/builtin/datasphere.ts +0 -447
  490. package/src/skills/builtin/datasphere_serverless.ts +0 -347
  491. package/src/skills/builtin/datetime.ts +0 -137
  492. package/src/skills/builtin/google_maps.ts +0 -656
  493. package/src/skills/builtin/info_gatherer.ts +0 -415
  494. package/src/skills/builtin/joke.ts +0 -196
  495. package/src/skills/builtin/math.ts +0 -149
  496. package/src/skills/builtin/mcp_gateway.ts +0 -685
  497. package/src/skills/builtin/native_vector_search.ts +0 -910
  498. package/src/skills/builtin/play_background_file.ts +0 -367
  499. package/src/skills/builtin/spider.ts +0 -874
  500. package/src/skills/builtin/swml_transfer.ts +0 -645
  501. package/src/skills/builtin/weather_api.ts +0 -255
  502. package/src/skills/builtin/web_search.ts +0 -1083
  503. package/src/skills/builtin/wikipedia_search.ts +0 -304
  504. package/src/types.ts +0 -132
  505. package/tests/AgentBase.test.ts +0 -1093
  506. package/tests/AgentServer.test.ts +0 -126
  507. package/tests/AuthHandler.test.ts +0 -133
  508. package/tests/ConfigLoader.test.ts +0 -151
  509. package/tests/ContextBuilder.test.ts +0 -108
  510. package/tests/DataMap.test.ts +0 -367
  511. package/tests/EphemeralSkillCopy.test.ts +0 -107
  512. package/tests/FunctionResult.test.ts +0 -298
  513. package/tests/GracefulShutdown.test.ts +0 -46
  514. package/tests/Logger.test.ts +0 -420
  515. package/tests/PomBuilder.test.ts +0 -228
  516. package/tests/ProxyDetection.test.ts +0 -228
  517. package/tests/SWMLService.test.ts +0 -320
  518. package/tests/SWMLVerbHandler.test.ts +0 -523
  519. package/tests/SchemaUtils.test.ts +0 -106
  520. package/tests/SchemaUtils.verb.test.ts +0 -206
  521. package/tests/SecurityUtils.test.ts +0 -192
  522. package/tests/ServerlessAdapter.test.ts +0 -222
  523. package/tests/SessionManager.test.ts +0 -257
  524. package/tests/SkillBaseFeatures.test.ts +0 -130
  525. package/tests/SkillMultiInstance.test.ts +0 -102
  526. package/tests/SkillParameterSchemas.test.ts +0 -134
  527. package/tests/SkillRegistrySchema.test.ts +0 -84
  528. package/tests/SslConfig.test.ts +0 -97
  529. package/tests/SwmlBuilder.test.ts +0 -400
  530. package/tests/TypeInference.test.ts +0 -165
  531. package/tests/VerbHandlerRegistry.test.ts +0 -128
  532. package/tests/cli/mock-data.test.ts +0 -113
  533. package/tests/cli/swaig-test.test.ts +0 -108
  534. package/tests/examples.test.ts +0 -194
  535. package/tests/fixtures/scrape-parity/README.md +0 -53
  536. package/tests/fixtures/scrape-parity/expected/01_simple_article.json +0 -5
  537. package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +0 -5
  538. package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +0 -5
  539. package/tests/fixtures/scrape-parity/expected/04_bare_body.json +0 -5
  540. package/tests/fixtures/scrape-parity/expected/05_malformed.json +0 -5
  541. package/tests/fixtures/scrape-parity/expected/06_multi_class.json +0 -5
  542. package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +0 -5
  543. package/tests/fixtures/scrape-parity/expected/08_inline_script.json +0 -5
  544. package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +0 -5
  545. package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +0 -5
  546. package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +0 -5
  547. package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +0 -5
  548. package/tests/fixtures/scrape-parity/html/01_simple_article.html +0 -18
  549. package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +0 -18
  550. package/tests/fixtures/scrape-parity/html/03_nested_containers.html +0 -13
  551. package/tests/fixtures/scrape-parity/html/04_bare_body.html +0 -9
  552. package/tests/fixtures/scrape-parity/html/05_malformed.html +0 -11
  553. package/tests/fixtures/scrape-parity/html/06_multi_class.html +0 -18
  554. package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +0 -12
  555. package/tests/fixtures/scrape-parity/html/08_inline_script.html +0 -17
  556. package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +0 -21
  557. package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +0 -10
  558. package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +0 -13
  559. package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +0 -24
  560. package/tests/fixtures/scrape-parity/python_extract.py +0 -109
  561. package/tests/livewire/livewire.test.ts +0 -780
  562. package/tests/mcp.test.ts +0 -221
  563. package/tests/prefabs/prefabs.test.ts +0 -1093
  564. package/tests/relay/Action.test.ts +0 -392
  565. package/tests/relay/Call.test.ts +0 -535
  566. package/tests/relay/Deferred.test.ts +0 -71
  567. package/tests/relay/Message.test.ts +0 -164
  568. package/tests/relay/RelayClient.test.ts +0 -779
  569. package/tests/relay/RelayEvent.test.ts +0 -463
  570. package/tests/relay/helpers.ts +0 -79
  571. package/tests/rest/HttpClient.test.ts +0 -274
  572. package/tests/rest/RestError.test.ts +0 -53
  573. package/tests/rest/calling.test.ts +0 -156
  574. package/tests/rest/client.test.ts +0 -197
  575. package/tests/rest/compat.test.ts +0 -335
  576. package/tests/rest/datasphere.test.ts +0 -71
  577. package/tests/rest/fabric.test.ts +0 -186
  578. package/tests/rest/helpers.ts +0 -95
  579. package/tests/rest/logs.test.ts +0 -68
  580. package/tests/rest/pagination.test.ts +0 -133
  581. package/tests/rest/registry.test.ts +0 -94
  582. package/tests/rest/relay-rest.test.ts +0 -290
  583. package/tests/rest/video.test.ts +0 -173
  584. package/tests/setup.ts +0 -6
  585. package/tests/skills/SkillBase.test.ts +0 -108
  586. package/tests/skills/SkillManager.test.ts +0 -268
  587. package/tests/skills/SkillRegistry.test.ts +0 -176
  588. package/tests/skills/builtin.test.ts +0 -1472
  589. package/tests/skills/claude-skills.test.ts +0 -54
  590. package/tests/skills/custom-skills.test.ts +0 -53
  591. package/tests/skills/datasphere-serverless.test.ts +0 -70
  592. package/tests/skills/datasphere.test.ts +0 -107
  593. package/tests/skills/datetime.test.ts +0 -101
  594. package/tests/skills/google-maps.test.ts +0 -78
  595. package/tests/skills/info-gatherer.test.ts +0 -411
  596. package/tests/skills/joke.test.ts +0 -81
  597. package/tests/skills/math.test.ts +0 -68
  598. package/tests/skills/mcp-gateway.test.ts +0 -101
  599. package/tests/skills/play-background.test.ts +0 -54
  600. package/tests/skills/spider.test.ts +0 -108
  601. package/tests/skills/swml-transfer.test.ts +0 -178
  602. package/tests/skills/trivia.test.ts +0 -54
  603. package/tests/skills/vector-search.test.ts +0 -135
  604. package/tests/skills/weather-api.test.ts +0 -77
  605. package/tests/skills/web-search-parity.test.ts +0 -59
  606. package/tests/skills/web-search.test.ts +0 -103
  607. package/tests/skills/wikipedia.test.ts +0 -63
  608. package/tsconfig.json +0 -18
  609. package/vitest.config.ts +0 -9
  610. /package/{src → dist}/schema.json +0 -0
@@ -1,1252 +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
- /**
43
- * Rotating "Did you know?" tips printed to stderr by the LiveWire banner.
44
- * Exported for tests; reorder or extend to change what's displayed.
45
- */
46
- export const tips: string[] = [
47
- "SignalWire agents support DataMap tools that execute server-side — no webhook infrastructure needed. See: docs/datamap-guide.md",
48
- "SignalWire Contexts & Steps give you mechanical state control over conversations — no prompt engineering needed. See: docs/contexts-guide.md",
49
- "SignalWire agents can transfer calls between agents with a single SwmlTransfer() action",
50
- "SignalWire handles 18 built-in skills (datetime, math, web search, etc.) with one-liner integration via agent.addSkill()",
51
- "SignalWire agents support SMS, conferencing, call recording, and SIP — all from the same agent",
52
- "Your agent's entire AI pipeline (STT, LLM, TTS, VAD) runs in SignalWire's cloud — zero infrastructure to manage",
53
- "SignalWire prefab agents (Survey, Receptionist, FAQ, Concierge) give you production patterns in 10 lines of code",
54
- "SignalWire's RELAY client gives you real-time WebSocket call control with 57+ methods — play, record, detect, conference, and more",
55
- "SignalWire agents auto-generate SWML documents — the platform handles media, turn detection, and barge-in for you",
56
- "You can host multiple agents on one server with AgentServer — each with its own route, prompt, and tools",
57
- ];
58
-
59
- function printTip(): void {
60
- const tip = tips[Math.floor(Math.random() * tips.length)];
61
- process.stderr.write(`\n\u{1f4a1} Did you know? ${tip}\n\n`);
62
- }
63
-
64
- // ---------------------------------------------------------------------------
65
- // Noop logging helpers
66
- // ---------------------------------------------------------------------------
67
-
68
- /**
69
- * NoopTracker ensures each informational message is logged at most once,
70
- * preventing spam when the same noop path is exercised repeatedly.
71
- */
72
- class NoopTracker {
73
- private logged = new Set<string>();
74
-
75
- /**
76
- * Log the given message the first time this key is seen.
77
- *
78
- * @param key - Dedup key. Subsequent calls with the same key are silent.
79
- * @param message - Message to write to stderr on first occurrence.
80
- */
81
- once(key: string, message: string): void {
82
- if (this.logged.has(key)) return;
83
- this.logged.add(key);
84
- process.stderr.write(`[LiveWire] ${message}\n`);
85
- }
86
-
87
- /** Expose whether a key has been logged (for testing). */
88
- hasLogged(key: string): boolean {
89
- return this.logged.has(key);
90
- }
91
-
92
- /** Reset all tracked keys (for testing). */
93
- reset(): void {
94
- this.logged.clear();
95
- }
96
- }
97
-
98
- const globalNoop = new NoopTracker();
99
-
100
- // Re-export for testing
101
- export { NoopTracker, globalNoop };
102
-
103
- // ---------------------------------------------------------------------------
104
- // VoiceOptions
105
- // ---------------------------------------------------------------------------
106
-
107
- /** Voice configuration options passed through to the SignalWire AI config. */
108
- export interface VoiceOptions {
109
- /** TTS voice identifier (e.g. `"en-US-Standard-A"`). */
110
- voice: string;
111
- /** TTS engine identifier (e.g. `"google"`, `"elevenlabs"`). */
112
- engine: string;
113
- /** BCP-47 language code (e.g. `"en-US"`). */
114
- language: string;
115
- }
116
-
117
- // ---------------------------------------------------------------------------
118
- // FunctionTool
119
- // ---------------------------------------------------------------------------
120
-
121
- /** A tool definition that can be registered on an {@link Agent}. */
122
- export interface FunctionTool {
123
- /** Tool name. Populated when the tool is attached to an `Agent.tools` map. */
124
- name: string;
125
- /** Human-readable description shown to the LLM. */
126
- description: string;
127
- /** JSON schema (or Zod schema passthrough) for the tool's parameters. */
128
- parameters?: Record<string, unknown>;
129
- /** Handler invoked by the platform when the LLM calls this tool. */
130
- execute: (params: any, context: { ctx: RunContext }) => any;
131
- }
132
-
133
- // ---------------------------------------------------------------------------
134
- // Agent
135
- // ---------------------------------------------------------------------------
136
-
137
- /**
138
- * Mirrors a LiveKit `voice.Agent` — holds instructions and tool definitions.
139
- *
140
- * Pipeline options (`stt`, `tts`, `vad`, `llm`, `turnDetection`) are accepted
141
- * for API parity but are **no-ops** — SignalWire's control plane handles the
142
- * entire AI pipeline server-side. Set instructions and tools; everything else
143
- * just logs once and continues.
144
- *
145
- * @example Minimal LiveKit-compatible agent
146
- * ```ts
147
- * import { livewire } from '@signalwire/sdk';
148
- *
149
- * const timeTool = livewire.tool({
150
- * description: 'Return the current time.',
151
- * execute: () => new Date().toISOString(),
152
- * });
153
- *
154
- * const agent = new livewire.Agent({
155
- * instructions: 'You are a friendly helper.',
156
- * tools: [{ ...timeTool, name: 'time' }],
157
- * });
158
- *
159
- * const session = new livewire.AgentSession();
160
- * await session.start({ agent });
161
- * ```
162
- */
163
- export class Agent<UserData = any> {
164
- /** System instructions passed through to the SignalWire AI prompt. */
165
- instructions: string;
166
- /** Registered tools keyed by name. Mutated by {@link updateTools}. */
167
- tools: Record<string, FunctionTool>;
168
- /** Arbitrary per-session user data passed to tool handlers via {@link RunContext.userData}. */
169
- userData?: UserData;
170
-
171
- /** @internal Pipeline hint stored for AgentSession mapping. */
172
- _llmHint: unknown;
173
- /** @internal */
174
- _allowInterruptions: unknown;
175
- /** @internal */
176
- _minEndpointingDelay: unknown;
177
- /** @internal */
178
- _maxEndpointingDelay: unknown;
179
-
180
- private _session?: AgentSession<UserData>;
181
-
182
- constructor(options?: {
183
- instructions?: string;
184
- tools?: FunctionTool[];
185
- userData?: UserData;
186
- chatCtx?: unknown;
187
- stt?: unknown;
188
- tts?: unknown;
189
- llm?: unknown;
190
- vad?: unknown;
191
- turnDetection?: unknown;
192
- mcpServers?: unknown;
193
- allowInterruptions?: boolean;
194
- minEndpointingDelay?: number;
195
- maxEndpointingDelay?: number;
196
- }) {
197
- this.instructions = options?.instructions ?? '';
198
- // Mirror Python: tools is Optional[List[Any]], stored internally as a name-keyed map.
199
- // Build the record from the array using the same pattern as updateTools().
200
- if (options?.tools) {
201
- const record: Record<string, FunctionTool> = {};
202
- for (const t of options.tools) {
203
- record[t.name] = t;
204
- }
205
- this.tools = record;
206
- } else {
207
- this.tools = {};
208
- }
209
- this.userData = options?.userData;
210
-
211
- // Pipeline noop advisories (matching Python behavior)
212
- if (options?.stt != null) {
213
- globalNoop.once(
214
- 'agent_stt',
215
- "Agent(stt=...): SignalWire's control plane handles speech recognition at scale -- no configuration needed",
216
- );
217
- }
218
- if (options?.tts != null) {
219
- globalNoop.once(
220
- 'agent_tts',
221
- "Agent(tts=...): SignalWire's control plane handles text-to-speech at scale -- no configuration needed",
222
- );
223
- }
224
- if (options?.vad != null) {
225
- globalNoop.once(
226
- 'agent_vad',
227
- "Agent(vad=...): SignalWire's control plane handles voice activity detection at scale automatically",
228
- );
229
- }
230
- if (options?.turnDetection != null) {
231
- globalNoop.once(
232
- 'agent_turn_detection',
233
- "Agent(turnDetection=...): SignalWire's control plane handles turn detection at scale automatically",
234
- );
235
- }
236
- if (options?.mcpServers != null) {
237
- globalNoop.once(
238
- 'agent_mcp_servers',
239
- 'Agent(mcpServers=...): MCP servers are not yet supported in LiveWire -- tools should be registered via tool()',
240
- );
241
- }
242
-
243
- // Store pipeline hints for later mapping (used by AgentSession.start)
244
- this._llmHint = options?.llm;
245
- this._allowInterruptions = options?.allowInterruptions;
246
- this._minEndpointingDelay = options?.minEndpointingDelay;
247
- this._maxEndpointingDelay = options?.maxEndpointingDelay;
248
- }
249
-
250
- // ------------------------------------------------------------------
251
- // session property
252
- // ------------------------------------------------------------------
253
-
254
- /** The currently-bound {@link AgentSession}, or `undefined` until {@link AgentSession.start} is called. */
255
- get session(): AgentSession<UserData> | undefined {
256
- return this._session;
257
- }
258
-
259
- set session(value: AgentSession<UserData> | undefined) {
260
- this._session = value;
261
- }
262
-
263
- // ------------------------------------------------------------------
264
- // Lifecycle hooks (override in subclass)
265
- // ------------------------------------------------------------------
266
-
267
- /**
268
- * Lifecycle hook called when the agent enters an active call.
269
- * Override in a subclass to run setup logic — the default is a no-op.
270
- */
271
- async onEnter(): Promise<void> {}
272
-
273
- /**
274
- * Lifecycle hook called when the agent exits (call ended or handoff).
275
- * Override in a subclass to run teardown logic — the default is a no-op.
276
- */
277
- async onExit(): Promise<void> {}
278
-
279
- /**
280
- * Lifecycle hook called when the user finishes speaking.
281
- * Override in a subclass to inspect / mutate the turn context before the
282
- * LLM responds — the default is a no-op.
283
- *
284
- * @param _turnCtx - Turn context (LiveKit shape; passed through opaquely).
285
- * @param _newMessage - Newly-captured user message.
286
- */
287
- async onUserTurnCompleted(_turnCtx?: unknown, _newMessage?: unknown): Promise<void> {}
288
-
289
- // ------------------------------------------------------------------
290
- // Pipeline nodes -- all noop + log (SignalWire handles these)
291
- // ------------------------------------------------------------------
292
-
293
- /**
294
- * LiveKit-compatible STT node. **No-op** on SignalWire — the control plane
295
- * handles speech recognition server-side.
296
- *
297
- * @param _audio - Audio input (ignored).
298
- * @param _modelSettings - Model settings (ignored).
299
- */
300
- async sttNode(_audio?: unknown, _modelSettings?: unknown): Promise<void> {
301
- globalNoop.once(
302
- 'stt_node',
303
- "Agent.sttNode(): SignalWire's control plane handles speech recognition -- this node is a no-op",
304
- );
305
- }
306
-
307
- /**
308
- * LiveKit-compatible LLM node. **No-op** on SignalWire — the control plane
309
- * handles LLM inference server-side.
310
- *
311
- * @param _chatCtx - Chat context (ignored).
312
- * @param _tools - Tool list (ignored).
313
- * @param _modelSettings - Model settings (ignored).
314
- */
315
- async llmNode(_chatCtx?: unknown, _tools?: unknown, _modelSettings?: unknown): Promise<void> {
316
- globalNoop.once(
317
- 'llm_node',
318
- "Agent.llmNode(): SignalWire's control plane handles LLM inference -- this node is a no-op",
319
- );
320
- }
321
-
322
- /**
323
- * LiveKit-compatible TTS node. **No-op** on SignalWire — the control plane
324
- * handles text-to-speech server-side.
325
- *
326
- * @param _text - Text to synthesise (ignored).
327
- * @param _modelSettings - Model settings (ignored).
328
- */
329
- async ttsNode(_text?: unknown, _modelSettings?: unknown): Promise<void> {
330
- globalNoop.once(
331
- 'tts_node',
332
- "Agent.ttsNode(): SignalWire's control plane handles text-to-speech -- this node is a no-op",
333
- );
334
- }
335
-
336
- // ------------------------------------------------------------------
337
- // Dynamic updates
338
- // ------------------------------------------------------------------
339
-
340
- /**
341
- * Update the agent's instructions mid-session.
342
- *
343
- * @param instructions - New system-instructions string for the agent.
344
- */
345
- async updateInstructions(instructions: string): Promise<void> {
346
- this.instructions = instructions;
347
- }
348
-
349
- /**
350
- * Update the agent's tool list mid-session.
351
- *
352
- * Replaces the current tool record with one built from the given array,
353
- * keyed by `tool.name`. Useful for dynamic tool injection based on
354
- * conversation state.
355
- *
356
- * @param tools - Ordered array of {@link FunctionTool} definitions. Each
357
- * tool's `name` is used as its map key.
358
- */
359
- async updateTools(tools: FunctionTool[]): Promise<void> {
360
- const record: Record<string, FunctionTool> = {};
361
- for (const t of tools) {
362
- record[t.name] = t;
363
- }
364
- this.tools = record;
365
- }
366
- }
367
-
368
- // ---------------------------------------------------------------------------
369
- // RunContext
370
- // ---------------------------------------------------------------------------
371
-
372
- /**
373
- * Mirrors a LiveKit `RunContext` — passed to tool handlers so they can
374
- * read the current session, call handle, and user data.
375
- */
376
- export class RunContext<UserData = any> {
377
- /** The owning {@link AgentSession}, when one is bound. */
378
- session?: AgentSession<UserData>;
379
- /** Opaque speech-turn handle (LiveKit shape; passed through untouched). */
380
- speechHandle?: unknown;
381
- /** Opaque function-call descriptor (LiveKit shape; passed through untouched). */
382
- functionCall?: unknown;
383
-
384
- /**
385
- * @param session - Owning session, when available.
386
- * @param options - Optional pass-through values.
387
- * @param options.speechHandle - Opaque LiveKit speech handle.
388
- * @param options.functionCall - Opaque LiveKit function-call descriptor.
389
- */
390
- constructor(
391
- session?: AgentSession<UserData>,
392
- options?: { speechHandle?: unknown; functionCall?: unknown },
393
- ) {
394
- this.session = session;
395
- this.speechHandle = options?.speechHandle;
396
- this.functionCall = options?.functionCall;
397
- }
398
-
399
- /**
400
- * Per-session user data, or an empty object when no session is bound.
401
- *
402
- * @returns The {@link AgentSession.userData} payload cast to `UserData`.
403
- */
404
- get userData(): UserData {
405
- return (this.session?.userData ?? {}) as UserData;
406
- }
407
- }
408
-
409
- // ---------------------------------------------------------------------------
410
- // AgentSession
411
- // ---------------------------------------------------------------------------
412
-
413
- /**
414
- * Mirrors a LiveKit `AgentSession` — binds an {@link Agent} to SignalWire.
415
- *
416
- * Call {@link AgentSession.start} with an `Agent` to construct an internal
417
- * {@link AgentBase} and begin serving SWML. Pipeline-related options are
418
- * accepted for API parity but are no-ops server-side.
419
- */
420
- export class AgentSession<UserData = any> {
421
- private _llm: any;
422
- private _tools: FunctionTool[];
423
- private _userData: UserData;
424
- private _agent?: Agent<UserData>;
425
- private _swAgent?: AgentBase;
426
- private _allowInterruptions: boolean;
427
- private _minInterruptionDuration: number;
428
- private _minEndpointingDelay: number;
429
- private _maxEndpointingDelay: number;
430
- private _maxToolSteps: number;
431
- private _preemptiveGeneration: boolean;
432
- private _history: Array<Record<string, string>> = [];
433
- private _sayQueue: string[] = [];
434
- private noop = new NoopTracker();
435
-
436
- constructor(options?: {
437
- stt?: any;
438
- tts?: any;
439
- llm?: any;
440
- vad?: any;
441
- turnDetection?: any;
442
- tools?: FunctionTool[];
443
- mcpServers?: unknown;
444
- userData?: UserData;
445
- allowInterruptions?: boolean;
446
- minInterruptionDuration?: number;
447
- minEndpointingDelay?: number;
448
- maxEndpointingDelay?: number;
449
- maxToolSteps?: number;
450
- preemptiveGeneration?: boolean;
451
- }) {
452
- this._llm = options?.llm;
453
- this._tools = options?.tools ? [...options.tools] : [];
454
- this._userData = (options?.userData ?? {}) as UserData;
455
- this._allowInterruptions = options?.allowInterruptions ?? true;
456
- this._minInterruptionDuration = options?.minInterruptionDuration ?? 0.5;
457
- this._minEndpointingDelay = options?.minEndpointingDelay ?? 0.5;
458
- this._maxEndpointingDelay = options?.maxEndpointingDelay ?? 3.0;
459
- this._maxToolSteps = options?.maxToolSteps ?? 3;
460
- this._preemptiveGeneration = options?.preemptiveGeneration ?? false;
461
-
462
- if (options?.stt != null) {
463
- this.noop.once(
464
- 'stt',
465
- `WithSTT("${options.stt}"): SignalWire's control plane handles speech recognition at scale — no configuration needed`,
466
- );
467
- }
468
- if (options?.tts != null) {
469
- this.noop.once(
470
- 'tts',
471
- `WithTTS("${options.tts}"): SignalWire's control plane handles text-to-speech at scale — no configuration needed`,
472
- );
473
- }
474
- if (options?.vad != null) {
475
- this.noop.once(
476
- 'vad',
477
- "WithVAD(): SignalWire's control plane handles voice activity detection at scale automatically",
478
- );
479
- }
480
- if (options?.turnDetection != null) {
481
- this.noop.once(
482
- 'turn_detection',
483
- `WithTurnDetection("${options.turnDetection}"): SignalWire's control plane handles turn detection at scale automatically`,
484
- );
485
- }
486
- if (options?.mcpServers != null) {
487
- this.noop.once(
488
- 'mcp_servers',
489
- 'AgentSession(mcpServers=...): MCP servers are not yet supported in LiveWire -- tools should be registered via tool()',
490
- );
491
- }
492
- if (options?.maxToolSteps != null && options.maxToolSteps !== 3) {
493
- this.noop.once(
494
- 'max_tool_steps',
495
- `AgentSession(maxToolSteps=${options.maxToolSteps}): SignalWire's control plane handles tool execution depth at scale automatically`,
496
- );
497
- }
498
- }
499
-
500
- /**
501
- * Start the session by binding the agent to a freshly-constructed
502
- * {@link AgentBase}, mapping LiveKit-style options onto SignalWire AI params.
503
- *
504
- * Must be called before any other method on this session. The underlying
505
- * `AgentBase` is not started here — use {@link runApp} or an `AgentServer`
506
- * to serve it.
507
- *
508
- * @param params - Start parameters.
509
- * @param params.agent - The {@link Agent} to bind.
510
- * @param params.room - LiveKit room placeholder; ignored on SignalWire.
511
- * @param params.record - Call-recording flag placeholder; ignored on SignalWire.
512
- * @returns Resolves once the underlying `AgentBase` has been built.
513
- */
514
- async start(params: { agent: Agent<UserData>; room?: any; record?: boolean }): Promise<void> {
515
- this._agent = params.agent;
516
- params.agent.session = this;
517
-
518
- // Mirrors Python _build_sw_agent(): alias self._agent for subsequent reads
519
- const agent = this._agent;
520
-
521
- // Build a real SignalWire AgentBase
522
- const swAgent = new AgentBase({
523
- name: 'LiveWireAgent',
524
- route: '/',
525
- });
526
-
527
- swAgent.setPromptText(agent.instructions);
528
-
529
- // Map LLM model if provided (session-level takes priority, then agent-level hint)
530
- const llmModel = this._llm ?? agent._llmHint;
531
- if (llmModel != null) {
532
- let model = String(llmModel);
533
- const slashIdx = model.indexOf('/');
534
- if (slashIdx >= 0) model = model.slice(slashIdx + 1);
535
- swAgent.setParam('model', model);
536
- }
537
-
538
- // Map interruption / barge settings
539
- let allowInterruptions = this._allowInterruptions;
540
- if (agent._allowInterruptions != null) {
541
- allowInterruptions = agent._allowInterruptions as boolean;
542
- }
543
- if (!allowInterruptions) {
544
- swAgent.setParam('barge_confidence', 1.0);
545
- }
546
-
547
- // Map endpointing delays
548
- let minEp: number = this._minEndpointingDelay;
549
- if (agent._minEndpointingDelay != null) {
550
- minEp = agent._minEndpointingDelay as number;
551
- }
552
- if (minEp > 0) {
553
- swAgent.setParam('end_of_speech_timeout', Math.round(minEp * 1000));
554
- }
555
-
556
- let maxEp: number = this._maxEndpointingDelay;
557
- if (agent._maxEndpointingDelay != null) {
558
- maxEp = agent._maxEndpointingDelay as number;
559
- }
560
- if (maxEp > 0) {
561
- swAgent.setParam('attention_timeout', Math.round(maxEp * 1000));
562
- }
563
-
564
- // Register all tools from the agent + session-level tools
565
- const allTools: [string, FunctionTool][] = [
566
- ...Object.entries(agent.tools),
567
- ...this._tools.map((t) => [t.name, t] as [string, FunctionTool]),
568
- ];
569
- for (const [name, toolDef] of allTools) {
570
- const handler: SwaigHandler = async (args, _rawData) => {
571
- const ctx = new RunContext<UserData>(this);
572
- const result = await toolDef.execute(args, { ctx });
573
- if (result instanceof FunctionResult) return result;
574
- if (typeof result === 'string') return new FunctionResult(result);
575
- return new FunctionResult(JSON.stringify(result));
576
- };
577
- swAgent.defineTool({
578
- name,
579
- description: toolDef.description,
580
- parameters: toolDef.parameters,
581
- handler,
582
- });
583
- }
584
-
585
- // Initial greeting (say queue)
586
- for (const text of this._sayQueue) {
587
- swAgent.promptAddSection('Initial Greeting', { body: text });
588
- }
589
-
590
- this._swAgent = swAgent;
591
- }
592
-
593
- /**
594
- * Queue text to be spoken by the agent.
595
- *
596
- * Before {@link start} is called, text is buffered and injected at start
597
- * time as the agent's initial greeting. After start, text is added as an
598
- * additional prompt section.
599
- *
600
- * @param text - Line for the agent to speak.
601
- */
602
- say(text: string): void {
603
- // If the session is already started, inject directly into the SWML flow.
604
- // Otherwise queue the text so it is replayed when start() is called.
605
- if (this._swAgent) {
606
- this._swAgent.promptAddSection('Say', { body: text });
607
- } else {
608
- this._sayQueue.push(text);
609
- }
610
- }
611
-
612
- /**
613
- * Trigger the agent to generate a reply, optionally with extra instructions.
614
- *
615
- * @param options - Generation options.
616
- * @param options.instructions - Extra instructions injected as a new prompt
617
- * section before the next LLM turn.
618
- */
619
- generateReply(options?: { instructions?: string }): void {
620
- if (options?.instructions && this._swAgent) {
621
- this._swAgent.promptAddSection('Initial Greeting', { body: options.instructions });
622
- }
623
- }
624
-
625
- /**
626
- * Interrupt current speech. **No-op** on SignalWire — barge-in is handled
627
- * automatically by the control plane.
628
- */
629
- interrupt(): void {
630
- this.noop.once('interrupt', "Interrupt(): SignalWire handles barge-in automatically via its control plane");
631
- }
632
-
633
- /**
634
- * Swap the {@link Agent} bound to this session.
635
- *
636
- * Preserves the underlying `AgentBase` but replaces its prompt with the new
637
- * agent's instructions.
638
- *
639
- * @param agent - Replacement agent.
640
- */
641
- updateAgent(agent: Agent<UserData>): void {
642
- this._agent = agent;
643
- agent.session = this;
644
- if (this._swAgent) {
645
- this._swAgent.setPromptText(agent.instructions);
646
- }
647
- }
648
-
649
- /** Current per-session user data. Set by the constructor or via the setter. */
650
- get userData(): UserData {
651
- return this._userData;
652
- }
653
-
654
- set userData(val: UserData) {
655
- this._userData = val;
656
- }
657
-
658
- /** Conversation history entries captured over the session's lifetime. */
659
- get history(): Array<Record<string, string>> {
660
- return this._history;
661
- }
662
-
663
- /**
664
- * Return the underlying SignalWire {@link AgentBase}. Useful for tests and
665
- * advanced use cases that need to reach past the LiveKit facade.
666
- *
667
- * @returns The wrapped `AgentBase`, or `undefined` before {@link start}.
668
- */
669
- getSwAgent(): AgentBase | undefined {
670
- return this._swAgent;
671
- }
672
- }
673
-
674
- // ---------------------------------------------------------------------------
675
- // tool()
676
- // ---------------------------------------------------------------------------
677
-
678
- /**
679
- * Create a tool definition — mirrors `llm.tool()` from `@livekit/agents-js`.
680
- *
681
- * The returned tool has an empty `name` — the caller assigns it when the tool
682
- * is attached to an agent's tools map (see the {@link Agent} example).
683
- *
684
- * @typeParam P - Parameter type passed into `execute`.
685
- * @param options - Tool configuration.
686
- * @param options.description - Human-readable tool description exposed to the LLM.
687
- * @param options.parameters - JSON Schema or Zod schema describing the tool's inputs.
688
- * @param options.execute - Handler invoked when the LLM calls the tool.
689
- * @returns A {@link FunctionTool} ready to be attached to an agent.
690
- */
691
- export function tool<P = any>(options: {
692
- description: string;
693
- parameters?: any;
694
- execute: (params: P, context: { ctx: RunContext }) => any;
695
- }): FunctionTool {
696
- // Extract JSON schema from parameters if provided
697
- let jsonSchema: Record<string, unknown> | undefined;
698
- if (options.parameters) {
699
- // If it looks like a Zod schema (has a .shape or ._def), try to extract
700
- if (typeof options.parameters === 'object' && options.parameters._def) {
701
- // Best-effort Zod extraction -- store as-is for now
702
- jsonSchema = options.parameters;
703
- } else {
704
- jsonSchema = options.parameters;
705
- }
706
- }
707
-
708
- return {
709
- name: '', // Filled in when assigned to agent.tools
710
- description: options.description,
711
- parameters: jsonSchema,
712
- execute: options.execute,
713
- };
714
- }
715
-
716
- // ---------------------------------------------------------------------------
717
- // handoff()
718
- // ---------------------------------------------------------------------------
719
-
720
- /**
721
- * Create an {@link AgentHandoff} descriptor for multi-agent scenarios.
722
- *
723
- * @param options - Handoff parameters.
724
- * @param options.agent - Agent to transfer control to.
725
- * @param options.returns - Optional string returned to the current agent when
726
- * the handoff completes.
727
- * @returns A handoff descriptor that can be returned from a tool handler.
728
- */
729
- export function handoff(options: { agent: Agent; returns?: string }): AgentHandoff {
730
- const h = new AgentHandoff();
731
- h.agent = options.agent;
732
- h.returns = options.returns;
733
- return h;
734
- }
735
-
736
- // ---------------------------------------------------------------------------
737
- // AgentHandoff / StopResponse / ToolError
738
- // ---------------------------------------------------------------------------
739
-
740
- /** Signals a handoff to another agent in multi-agent scenarios. */
741
- export class AgentHandoff {
742
- /** Target agent that should take over the conversation. */
743
- agent!: Agent;
744
- /** Optional return value surfaced when the handoff completes. */
745
- returns?: string;
746
- }
747
-
748
- /** Signals that a tool should not trigger another LLM reply. */
749
- export class StopResponse extends Error {
750
- /**
751
- * @param message - Optional error message. Defaults to `"StopResponse"`.
752
- */
753
- constructor(message?: string) {
754
- super(message ?? 'StopResponse');
755
- this.name = 'StopResponse';
756
- }
757
- }
758
-
759
- /** Error thrown from a tool to signal failure back to the LLM. */
760
- export class ToolError extends Error {
761
- /**
762
- * @param message - Error message surfaced to the LLM.
763
- */
764
- constructor(message: string) {
765
- super(message);
766
- this.name = 'ToolError';
767
- }
768
- }
769
-
770
- // ---------------------------------------------------------------------------
771
- // JobProcess
772
- // ---------------------------------------------------------------------------
773
-
774
- /**
775
- * Mirrors a LiveKit `JobProcess` — placeholder for prewarm / setup hooks.
776
- *
777
- * On SignalWire the control plane pre-warms infrastructure at scale, so this
778
- * class carries no real state beyond the LiveKit-compatible `userData` bag.
779
- */
780
- export class JobProcess {
781
- /** Mutable bag shared across prewarm and entry-point callbacks. */
782
- userData: Record<string, any> = {};
783
- }
784
-
785
- // ---------------------------------------------------------------------------
786
- // Room
787
- // ---------------------------------------------------------------------------
788
-
789
- /**
790
- * Stub `Room` — SignalWire does not use the LiveKit room abstraction.
791
- *
792
- * Present purely for API parity so LiveKit-shaped code compiles; its only
793
- * meaningful attribute is the constant name.
794
- */
795
- export class Room {
796
- /** Always `"livewire-room"` — SignalWire has no per-call room identity. */
797
- readonly name: string = 'livewire-room';
798
- }
799
-
800
- // ---------------------------------------------------------------------------
801
- // JobContext
802
- // ---------------------------------------------------------------------------
803
-
804
- /**
805
- * Mirrors a LiveKit `JobContext` — provides room and connection info to the
806
- * entry-point callback registered via {@link defineAgent}.
807
- */
808
- export class JobContext {
809
- /** Placeholder {@link Room} (see class docs). */
810
- room: Room;
811
- /** Shared {@link JobProcess} instance for prewarm-to-entry data passing. */
812
- proc: JobProcess;
813
- /** @internal */
814
- _swAgent?: AgentBase;
815
-
816
- constructor() {
817
- this.room = new Room();
818
- this.proc = new JobProcess();
819
- }
820
-
821
- /**
822
- * Connect to the platform. **No-op** on SignalWire — the control plane
823
- * manages connection lifecycle automatically.
824
- *
825
- * @returns Resolves immediately.
826
- */
827
- async connect(): Promise<void> {
828
- globalNoop.once(
829
- 'connect',
830
- "JobContext.connect(): SignalWire's control plane handles connection lifecycle at scale automatically",
831
- );
832
- }
833
-
834
- /**
835
- * Wait for a participant to join. **No-op** on SignalWire — returns an
836
- * immediate stub participant.
837
- *
838
- * @param options - Participant match options.
839
- * @param options.identity - Requested identity; echoed back in the stub.
840
- * Defaults to `"caller"`.
841
- * @returns A stub participant `{ identity }` record.
842
- */
843
- async waitForParticipant(options?: { identity?: string }): Promise<any> {
844
- return { identity: options?.identity ?? 'caller' };
845
- }
846
- }
847
-
848
- // ---------------------------------------------------------------------------
849
- // defineAgent
850
- // ---------------------------------------------------------------------------
851
-
852
- /**
853
- * Mirrors `@livekit/agents.defineAgent()`.
854
- *
855
- * Packages an entry function (plus an optional prewarm hook) for later
856
- * execution by {@link runApp}. Pass-through — no side effects.
857
- *
858
- * @param agent - Entry and (optional) prewarm functions.
859
- * @param agent.entry - Main callback invoked with a {@link JobContext} when
860
- * the agent runs.
861
- * @param agent.prewarm - Optional prewarm callback invoked with a
862
- * {@link JobProcess} before `entry`.
863
- * @returns The same record (pass-through), typed consistently.
864
- */
865
- export function defineAgent(agent: {
866
- entry: (ctx: JobContext) => Promise<void>;
867
- prewarm?: (proc: JobProcess) => any;
868
- }): { entry: (ctx: JobContext) => Promise<void>; prewarm?: (proc: JobProcess) => any } {
869
- return agent;
870
- }
871
-
872
- // ---------------------------------------------------------------------------
873
- // runApp
874
- // ---------------------------------------------------------------------------
875
-
876
- /**
877
- * Mirrors `cli.runApp()` from `@livekit/agents-js`.
878
- *
879
- * 1. Prints the LiveWire banner
880
- * 2. Runs the registered prewarm callback (if any) with a fresh {@link JobProcess}
881
- * 3. Creates a fresh {@link JobContext}
882
- * 4. Prints a random tip
883
- * 5. Invokes the entry function with the context
884
- * 6. Starts the underlying SignalWire `AgentBase` once the entry function
885
- * binds one (via an `AgentSession.start()` call)
886
- *
887
- * Accepts either an object `{ entry, prewarm? }`, a bare entry function, or
888
- * an {@link AgentServer} instance.
889
- *
890
- * @param options - Agent descriptor, entry function, or `AgentServer`.
891
- */
892
- export function runApp(options: any): void {
893
- printBanner();
894
-
895
- // If passed an AgentServer instance, convert it to an agentDef-compatible object
896
- const agentDef = options instanceof AgentServer
897
- ? options._toAgentDef()
898
- : (options?.agent ?? options);
899
-
900
- // Run prewarm if registered
901
- if (agentDef?.prewarm) {
902
- const proc = new JobProcess();
903
- globalNoop.once(
904
- 'prewarm',
905
- "prewarm: Warm process pools not needed — SignalWire's control plane manages media infrastructure at scale",
906
- );
907
- agentDef.prewarm(proc);
908
- }
909
-
910
- // Create a JobContext
911
- const ctx = new JobContext();
912
-
913
- // Print a random tip
914
- printTip();
915
-
916
- // Call the entry function
917
- const entryFn = agentDef?.entry ?? agentDef;
918
- if (typeof entryFn === 'function') {
919
- Promise.resolve(entryFn(ctx)).then(() => {
920
- // After entry completes, the session should have bound a swAgent to ctx
921
- // If someone stored it on ctx, start it
922
- if (ctx._swAgent) {
923
- ctx._swAgent.run().catch((err: Error) => {
924
- process.stderr.write(`[LiveWire] agent error: ${err.message}\n`);
925
- });
926
- }
927
- }).catch((err: Error) => {
928
- process.stderr.write(`[LiveWire] entry function error: ${err.message}\n`);
929
- });
930
- }
931
- }
932
-
933
- // ---------------------------------------------------------------------------
934
- // WorkerOptions / ServerOptions
935
- // ---------------------------------------------------------------------------
936
-
937
- /**
938
- * Stub class mirroring LiveKit's `WorkerOptions`.
939
- *
940
- * Accepts any configuration for source-compatibility with LiveKit code;
941
- * SignalWire ignores these settings.
942
- */
943
- export class WorkerOptions {
944
- /** @param _opts - LiveKit-shaped worker options (ignored). */
945
- constructor(_opts?: any) {}
946
- }
947
-
948
- /**
949
- * Stub class mirroring LiveKit's `ServerOptions`.
950
- *
951
- * Accepts any configuration for source-compatibility with LiveKit code;
952
- * SignalWire ignores these settings.
953
- */
954
- export class ServerOptions {
955
- /** @param _opts - LiveKit-shaped server options (ignored). */
956
- constructor(_opts?: any) {}
957
- }
958
-
959
- // ---------------------------------------------------------------------------
960
- // AgentServer
961
- // ---------------------------------------------------------------------------
962
-
963
- /**
964
- * Mirrors a LiveKit AgentServer -- registers entrypoints and starts.
965
- *
966
- * Usage:
967
- * const server = new AgentServer();
968
- * server.setupFnc = async (proc) => { ... };
969
- *
970
- * // Bare decorator usage:
971
- * server.rtcSession(myEntryFn);
972
- *
973
- * // Parameterized decorator usage:
974
- * server.rtcSession({ agentName: 'myAgent' })(myEntryFn);
975
- *
976
- * cli.runApp(server);
977
- */
978
- export class AgentServer {
979
- /** Optional prewarm hook called before the entrypoint. Mirrors Python's setup_fnc. */
980
- setupFnc?: (proc: JobProcess) => void;
981
-
982
- /** @internal Registered entrypoint function. */
983
- private _entryFn?: (ctx: JobContext) => Promise<void>;
984
-
985
- /** @internal Agent name hint registered via rtcSession(). */
986
- private _agentName: string = '';
987
-
988
- constructor(_opts?: any) {}
989
-
990
- /**
991
- * Decorator that registers the session entrypoint.
992
- *
993
- * Supports both bare and parameterized usage:
994
- * server.rtcSession(fn) // bare
995
- * server.rtcSession(fn, { agentName: 'x' }) // with opts, explicit fn
996
- * server.rtcSession({ agentName: 'x' })(fn) // parameterized decorator
997
- * @server.rtcSession // decorator (bare)
998
- * @server.rtcSession({ agentName: 'x' }) // decorator (parameterized)
999
- */
1000
- rtcSession(
1001
- fnOrOpts?:
1002
- | ((ctx: JobContext) => Promise<void>)
1003
- | {
1004
- agentName?: string;
1005
- type?: string;
1006
- onRequest?: ((...args: any[]) => any) | null;
1007
- onSessionEnd?: ((...args: any[]) => any) | null;
1008
- },
1009
- opts?: {
1010
- agentName?: string;
1011
- type?: string;
1012
- onRequest?: ((...args: any[]) => any) | null;
1013
- onSessionEnd?: ((...args: any[]) => any) | null;
1014
- },
1015
- ): ((fn: (ctx: JobContext) => Promise<void>) => (ctx: JobContext) => Promise<void>) | void {
1016
- // Determine whether first arg is a function or an options object
1017
- let fn: ((ctx: JobContext) => Promise<void>) | undefined;
1018
- let resolvedOpts: typeof opts;
1019
-
1020
- if (typeof fnOrOpts === 'function') {
1021
- fn = fnOrOpts;
1022
- resolvedOpts = opts;
1023
- } else {
1024
- // fnOrOpts is an options object (or undefined) — parameterized decorator usage
1025
- resolvedOpts = fnOrOpts;
1026
- }
1027
-
1028
- if (resolvedOpts?.type && resolvedOpts.type !== 'room') {
1029
- globalNoop.once(
1030
- 'server_type',
1031
- `AgentServer.rtcSession(type=${JSON.stringify(resolvedOpts.type)}): SignalWire's control plane handles server topology at scale automatically`,
1032
- );
1033
- }
1034
-
1035
- const register = (entryFn: (ctx: JobContext) => Promise<void>) => {
1036
- this._entryFn = entryFn;
1037
- if (resolvedOpts?.agentName) this._agentName = resolvedOpts.agentName;
1038
- return entryFn;
1039
- };
1040
-
1041
- if (fn) {
1042
- register(fn);
1043
- return;
1044
- }
1045
- return register;
1046
- }
1047
-
1048
- /** @internal Extract agentDef-compatible shape for use by runApp. */
1049
- _toAgentDef(): {
1050
- entry: (ctx: JobContext) => Promise<void>;
1051
- prewarm?: (proc: JobProcess) => void;
1052
- } {
1053
- return {
1054
- entry: this._entryFn ?? (async (_ctx: JobContext) => {}),
1055
- prewarm: this.setupFnc,
1056
- };
1057
- }
1058
- }
1059
-
1060
- // ---------------------------------------------------------------------------
1061
- // Plugin stubs
1062
- // ---------------------------------------------------------------------------
1063
-
1064
- /**
1065
- * Stub providers matching common LiveKit plugin packages.
1066
- *
1067
- * None of these do anything — they exist so LiveKit code that imports and
1068
- * constructs these classes still compiles and runs under SignalWire. The
1069
- * first construction of each logs an advisory to stderr.
1070
- */
1071
- export namespace plugins {
1072
- /** LiveKit Deepgram-STT plugin stub. No-op on SignalWire. */
1073
- export class DeepgramSTT {
1074
- /** @param _opts - Deepgram options (ignored). */
1075
- constructor(_opts?: any) {
1076
- globalNoop.once(
1077
- 'stt_plugin',
1078
- 'DeepgramSTT: SignalWire\'s control plane handles the full media pipeline at scale',
1079
- );
1080
- }
1081
- }
1082
-
1083
- /**
1084
- * LiveKit OpenAI-LLM plugin stub.
1085
- *
1086
- * The `model` string is captured and mapped to the SignalWire AI `model`
1087
- * param by {@link AgentSession.start}. Other options are ignored.
1088
- */
1089
- export class OpenAILLM {
1090
- /** Model identifier captured from the constructor options. */
1091
- model: string;
1092
- /** @param _opts - OpenAI options. `_opts.model` is captured; everything else ignored. */
1093
- constructor(_opts?: any) {
1094
- this.model = ((_opts as any)?.model as string) ?? '';
1095
- globalNoop.once(
1096
- 'openai_llm',
1097
- 'OpenAILLM(): model selection is mapped to SignalWire AI params -- OpenAI plugin wrapper is a no-op',
1098
- );
1099
- }
1100
- }
1101
-
1102
- /** LiveKit Cartesia-TTS plugin stub. No-op on SignalWire. */
1103
- export class CartesiaTTS {
1104
- /** @param _opts - Cartesia options (ignored). */
1105
- constructor(_opts?: any) {
1106
- globalNoop.once(
1107
- 'cartesia_tts',
1108
- "CartesiaTTS: SignalWire's control plane handles the full media pipeline at scale",
1109
- );
1110
- }
1111
- }
1112
-
1113
- /** LiveKit ElevenLabs-TTS plugin stub. No-op on SignalWire. */
1114
- export class ElevenLabsTTS {
1115
- /** @param _opts - ElevenLabs options (ignored). */
1116
- constructor(_opts?: any) {
1117
- globalNoop.once(
1118
- 'elevenlabs_tts',
1119
- "ElevenLabsTTS: SignalWire's control plane handles the full media pipeline at scale",
1120
- );
1121
- }
1122
- }
1123
-
1124
- /** LiveKit Silero-VAD plugin stub. No-op on SignalWire. */
1125
- export class SileroVAD {
1126
- /** @param _opts - Silero VAD options (ignored). */
1127
- constructor(_opts?: Record<string, unknown>) {}
1128
-
1129
- /**
1130
- * Load a Silero VAD model.
1131
- *
1132
- * **No-op** on SignalWire — returns a fresh stub instance and emits a
1133
- * one-time advisory to stderr.
1134
- *
1135
- * @returns A new `SileroVAD` stub.
1136
- */
1137
- static load(): SileroVAD {
1138
- globalNoop.once(
1139
- 'vad_plugin',
1140
- "SileroVAD.load(): SignalWire's control plane handles voice activity detection at scale automatically",
1141
- );
1142
- return new SileroVAD();
1143
- }
1144
- }
1145
- }
1146
-
1147
- // ---------------------------------------------------------------------------
1148
- // Inference module stubs
1149
- // ---------------------------------------------------------------------------
1150
-
1151
- /**
1152
- * Stub inference types matching LiveKit's `inference` namespace.
1153
- *
1154
- * None of these run inference on the client — SignalWire performs STT / LLM /
1155
- * TTS in its control plane. These classes exist so LiveKit code that imports
1156
- * and instantiates them still compiles.
1157
- */
1158
- export namespace inference {
1159
- /** LiveKit inference-STT stub. Captures the model name; runs no inference locally. */
1160
- export class STT {
1161
- /** Model identifier captured from the constructor. */
1162
- model: string;
1163
- /**
1164
- * @param model - Model identifier (captured).
1165
- * @param _opts - Additional options (ignored).
1166
- */
1167
- constructor(model: string = '', _opts?: any) {
1168
- this.model = model;
1169
- globalNoop.once(
1170
- 'inference_stt',
1171
- 'inference.STT: SignalWire\'s control plane handles speech recognition at scale',
1172
- );
1173
- }
1174
- }
1175
-
1176
- /** LiveKit inference-LLM stub. Captures the model name; runs no inference locally. */
1177
- export class LLM {
1178
- /** Model identifier captured from the constructor. */
1179
- model: string;
1180
- /**
1181
- * @param model - Model identifier (captured).
1182
- * @param _opts - Additional options (ignored).
1183
- */
1184
- constructor(model: string = '', _opts?: any) {
1185
- this.model = model;
1186
- }
1187
- }
1188
-
1189
- /** LiveKit inference-TTS stub. Captures the model name; runs no inference locally. */
1190
- export class TTS {
1191
- /** Model identifier captured from the constructor. */
1192
- model: string;
1193
- /**
1194
- * @param model - Model identifier (captured).
1195
- * @param _opts - Additional options (ignored).
1196
- */
1197
- constructor(model: string = '', _opts?: any) {
1198
- this.model = model;
1199
- globalNoop.once(
1200
- 'inference_tts',
1201
- 'inference.TTS: SignalWire\'s control plane handles text-to-speech at scale',
1202
- );
1203
- }
1204
- }
1205
- }
1206
-
1207
- // ---------------------------------------------------------------------------
1208
- // Namespace re-exports matching @livekit/agents
1209
- // ---------------------------------------------------------------------------
1210
-
1211
- /** LiveKit voice namespace equivalent. */
1212
- export const voice = {
1213
- Agent,
1214
- AgentSession,
1215
- AgentSessionEventTypes: {} as Record<string, string>,
1216
- };
1217
-
1218
- /** Minimal `ChatContext` matching LiveKit's `ChatContext`. */
1219
- export class ChatContext {
1220
- /** Ordered chat messages, each `{ role, content }`. */
1221
- messages: Array<Record<string, string>> = [];
1222
-
1223
- /**
1224
- * Append a chat message.
1225
- *
1226
- * @param options - Message content.
1227
- * @param options.role - Speaker role (`"user"`, `"assistant"`, or `"system"`).
1228
- * Defaults to `"user"`.
1229
- * @param options.text - Message text. Defaults to `""`.
1230
- * @returns This instance for chaining.
1231
- */
1232
- append(options: { role?: string; text?: string }): this {
1233
- this.messages.push({ role: options.role ?? 'user', content: options.text ?? '' });
1234
- return this;
1235
- }
1236
- }
1237
-
1238
- /** LiveKit llm namespace equivalent. */
1239
- export const llm = {
1240
- tool,
1241
- handoff,
1242
- ToolError,
1243
- ChatContext,
1244
- };
1245
-
1246
- /** LiveKit cli namespace equivalent. */
1247
- export const cli = {
1248
- runApp,
1249
- };
1250
-
1251
- // Re-export banner/tip functions for testing
1252
- export { printBanner, printTip, banner };