@signalwire/sdk 2.0.0

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 (325) hide show
  1. package/.github/workflows/publish.yml +27 -0
  2. package/.github/workflows/test.yml +17 -0
  3. package/CLAUDE.md +112 -0
  4. package/README.md +254 -0
  5. package/docs/MIGRATION-2.0.md +81 -0
  6. package/docs/agent-guide.md +869 -0
  7. package/docs/agent_guide.md +1026 -0
  8. package/docs/api-reference.md +2420 -0
  9. package/docs/api_reference.md +1301 -0
  10. package/docs/architecture.md +843 -0
  11. package/docs/cli-guide.md +579 -0
  12. package/docs/cli_guide.md +448 -0
  13. package/docs/cloud_functions_guide.md +474 -0
  14. package/docs/configuration.md +422 -0
  15. package/docs/contexts-guide.md +787 -0
  16. package/docs/contexts_guide.md +511 -0
  17. package/docs/datamap-guide.md +1141 -0
  18. package/docs/datamap_guide.md +595 -0
  19. package/docs/llm_parameters.md +239 -0
  20. package/docs/mcp_gateway_reference.md +648 -0
  21. package/docs/mcp_integration.md +108 -0
  22. package/docs/prefabs-guide.md +800 -0
  23. package/docs/sdk_features.md +477 -0
  24. package/docs/security.md +436 -0
  25. package/docs/serverless-guide.md +513 -0
  26. package/docs/skills-guide.md +857 -0
  27. package/docs/skills-system.md +301 -0
  28. package/docs/skills_parameter_schema.md +392 -0
  29. package/docs/skills_system.md +467 -0
  30. package/docs/swaig-reference.md +1627 -0
  31. package/docs/swaig_reference.md +910 -0
  32. package/docs/swml_service_guide.md +600 -0
  33. package/docs/third_party_skills.md +533 -0
  34. package/docs/web_service.md +677 -0
  35. package/examples/README.md +131 -0
  36. package/examples/advanced-datamap.ts +100 -0
  37. package/examples/advanced-dynamic-config.ts +70 -0
  38. package/examples/auto-vivified.ts +94 -0
  39. package/examples/call-flow.ts +63 -0
  40. package/examples/comprehensive-dynamic.ts +125 -0
  41. package/examples/contexts-steps.ts +65 -0
  42. package/examples/custom-path.ts +45 -0
  43. package/examples/datamap-tools.ts +55 -0
  44. package/examples/datasphere-multi-instance.ts +63 -0
  45. package/examples/datasphere-serverless-env.ts +68 -0
  46. package/examples/datasphere-webhook-env.ts +66 -0
  47. package/examples/datasphere.ts +37 -0
  48. package/examples/declarative.ts +100 -0
  49. package/examples/dynamic-config.ts +54 -0
  50. package/examples/dynamic-info-gatherer.ts +69 -0
  51. package/examples/dynamic-swml-service.ts +67 -0
  52. package/examples/gather-info.ts +71 -0
  53. package/examples/gather-per-question-functions-demo.ts +140 -0
  54. package/examples/joke-agent.ts +34 -0
  55. package/examples/kubernetes-agent.ts +45 -0
  56. package/examples/llm-params.ts +69 -0
  57. package/examples/mcp-agent.ts +84 -0
  58. package/examples/mcp-gateway.ts +35 -0
  59. package/examples/multi-agent.ts +73 -0
  60. package/examples/multi-endpoint.ts +79 -0
  61. package/examples/pom-prompt.ts +71 -0
  62. package/examples/prefab-concierge.ts +47 -0
  63. package/examples/prefab-faq.ts +54 -0
  64. package/examples/prefab-info-gatherer.ts +33 -0
  65. package/examples/prefab-receptionist.ts +36 -0
  66. package/examples/prefab-survey.ts +68 -0
  67. package/examples/record-call.ts +67 -0
  68. package/examples/relay-demo.ts +33 -0
  69. package/examples/room-and-sip.ts +94 -0
  70. package/examples/serverless-lambda.ts +35 -0
  71. package/examples/session-state.ts +83 -0
  72. package/examples/simple-agent.ts +36 -0
  73. package/examples/simple-static.ts +29 -0
  74. package/examples/skills-demo.ts +38 -0
  75. package/examples/step-function-inheritance-demo.ts +124 -0
  76. package/examples/swaig-features.ts +187 -0
  77. package/examples/swml-service-routing.ts +66 -0
  78. package/examples/swml-service.ts +38 -0
  79. package/examples/tap.ts +68 -0
  80. package/examples/verb-methods.ts +45 -0
  81. package/examples/web-search-multi-instance.ts +72 -0
  82. package/examples/web-search.ts +38 -0
  83. package/examples/wikipedia.ts +36 -0
  84. package/livewire/README.md +140 -0
  85. package/livewire/docs/migration-guide.md +228 -0
  86. package/livewire/examples/livewire-basic-agent.ts +74 -0
  87. package/livewire/examples/livewire-handoff.ts +197 -0
  88. package/livewire/examples/livewire-multi-tool.ts +117 -0
  89. package/package.json +38 -0
  90. package/relay/README.md +70 -0
  91. package/relay/RELAY_IMPLEMENTATION_GUIDE.md +1257 -0
  92. package/relay/docs/call-methods.md +474 -0
  93. package/relay/docs/client-reference.md +142 -0
  94. package/relay/docs/events.md +134 -0
  95. package/relay/docs/getting-started.md +134 -0
  96. package/relay/docs/guide.md +306 -0
  97. package/relay/docs/messaging.md +182 -0
  98. package/relay/examples/relay-inbound.ts +66 -0
  99. package/relay/examples/relay-messaging.ts +71 -0
  100. package/relay/examples/relay-outbound.ts +76 -0
  101. package/rest/README.md +95 -0
  102. package/rest/docs/calling.md +273 -0
  103. package/rest/docs/client-reference.md +107 -0
  104. package/rest/docs/compat.md +204 -0
  105. package/rest/docs/fabric.md +183 -0
  106. package/rest/docs/getting-started.md +110 -0
  107. package/rest/docs/guide.md +351 -0
  108. package/rest/docs/namespaces.md +285 -0
  109. package/rest/examples/rest-10dlc-registration.ts +161 -0
  110. package/rest/examples/rest-calling-ivr-and-ai.ts +102 -0
  111. package/rest/examples/rest-calling-play-and-record.ts +91 -0
  112. package/rest/examples/rest-client.ts +65 -0
  113. package/rest/examples/rest-compat-laml.ts +210 -0
  114. package/rest/examples/rest-datasphere-search.ts +82 -0
  115. package/rest/examples/rest-fabric-conferences-and-routing.ts +144 -0
  116. package/rest/examples/rest-fabric-subscribers-and-sip.ts +108 -0
  117. package/rest/examples/rest-fabric-swml-and-callflows.ts +99 -0
  118. package/rest/examples/rest-manage-resources.ts +65 -0
  119. package/rest/examples/rest-phone-number-management.ts +197 -0
  120. package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
  121. package/rest/examples/rest-video-rooms.ts +186 -0
  122. package/src/AgentBase.ts +2489 -0
  123. package/src/AgentServer.ts +415 -0
  124. package/src/AuthHandler.ts +256 -0
  125. package/src/ConfigLoader.ts +447 -0
  126. package/src/ContextBuilder.ts +1150 -0
  127. package/src/DataMap.ts +449 -0
  128. package/src/FunctionResult.ts +866 -0
  129. package/src/Logger.ts +337 -0
  130. package/src/PomBuilder.ts +439 -0
  131. package/src/PromptManager.ts +133 -0
  132. package/src/SWMLHandler.ts +298 -0
  133. package/src/SWMLService.ts +717 -0
  134. package/src/SchemaUtils.ts +361 -0
  135. package/src/SecurityUtils.ts +153 -0
  136. package/src/ServerlessAdapter.ts +221 -0
  137. package/src/SessionManager.ts +311 -0
  138. package/src/SslConfig.ts +118 -0
  139. package/src/SwaigFunction.ts +276 -0
  140. package/src/SwmlBuilder.ts +258 -0
  141. package/src/SwmlVerbMethods.generated.ts +234 -0
  142. package/src/TypeInference.ts +181 -0
  143. package/src/WebService.ts +619 -0
  144. package/src/cli/agent-loader.ts +166 -0
  145. package/src/cli/mock-data.ts +111 -0
  146. package/src/cli/swaig-test.ts +452 -0
  147. package/src/generateVerbTypes.ts +322 -0
  148. package/src/index.ts +167 -0
  149. package/src/livewire/index.ts +950 -0
  150. package/src/prefabs/ConciergeAgent.ts +287 -0
  151. package/src/prefabs/FAQBotAgent.ts +384 -0
  152. package/src/prefabs/InfoGathererAgent.ts +339 -0
  153. package/src/prefabs/ReceptionistAgent.ts +366 -0
  154. package/src/prefabs/SurveyAgent.ts +646 -0
  155. package/src/prefabs/index.ts +27 -0
  156. package/src/relay/Action.ts +314 -0
  157. package/src/relay/Call.ts +854 -0
  158. package/src/relay/Deferred.ts +71 -0
  159. package/src/relay/Message.ts +148 -0
  160. package/src/relay/RelayClient.ts +1036 -0
  161. package/src/relay/RelayError.ts +14 -0
  162. package/src/relay/RelayEvent.ts +892 -0
  163. package/src/relay/constants.ts +132 -0
  164. package/src/relay/index.ts +123 -0
  165. package/src/relay/types.ts +149 -0
  166. package/src/rest/HttpClient.ts +103 -0
  167. package/src/rest/RestError.ts +31 -0
  168. package/src/rest/base/BaseResource.ts +19 -0
  169. package/src/rest/base/CrudResource.ts +51 -0
  170. package/src/rest/base/CrudWithAddresses.ts +26 -0
  171. package/src/rest/index.ts +200 -0
  172. package/src/rest/namespaces/addresses.ts +32 -0
  173. package/src/rest/namespaces/calling.ts +187 -0
  174. package/src/rest/namespaces/chat.ts +20 -0
  175. package/src/rest/namespaces/compat.ts +352 -0
  176. package/src/rest/namespaces/datasphere.ts +45 -0
  177. package/src/rest/namespaces/fabric.ts +222 -0
  178. package/src/rest/namespaces/imported-numbers.ts +20 -0
  179. package/src/rest/namespaces/logs.ts +84 -0
  180. package/src/rest/namespaces/lookup.ts +21 -0
  181. package/src/rest/namespaces/mfa.ts +30 -0
  182. package/src/rest/namespaces/number-groups.ts +38 -0
  183. package/src/rest/namespaces/phone-numbers.ts +44 -0
  184. package/src/rest/namespaces/project.ts +36 -0
  185. package/src/rest/namespaces/pubsub.ts +20 -0
  186. package/src/rest/namespaces/queues.ts +33 -0
  187. package/src/rest/namespaces/recordings.ts +28 -0
  188. package/src/rest/namespaces/registry.ts +101 -0
  189. package/src/rest/namespaces/short-codes.ts +28 -0
  190. package/src/rest/namespaces/sip-profile.ts +25 -0
  191. package/src/rest/namespaces/verified-callers.ts +27 -0
  192. package/src/rest/namespaces/video.ts +165 -0
  193. package/src/rest/pagination.ts +84 -0
  194. package/src/rest/types.ts +61 -0
  195. package/src/schema.json +12250 -0
  196. package/src/skills/SkillBase.ts +547 -0
  197. package/src/skills/SkillManager.ts +415 -0
  198. package/src/skills/SkillRegistry.ts +367 -0
  199. package/src/skills/builtin/api_ninjas_trivia.ts +280 -0
  200. package/src/skills/builtin/ask_claude.ts +241 -0
  201. package/src/skills/builtin/claude_skills.ts +978 -0
  202. package/src/skills/builtin/custom_skills.ts +312 -0
  203. package/src/skills/builtin/datasphere.ts +438 -0
  204. package/src/skills/builtin/datasphere_serverless.ts +339 -0
  205. package/src/skills/builtin/datetime.ts +130 -0
  206. package/src/skills/builtin/google_maps.ts +651 -0
  207. package/src/skills/builtin/index.ts +88 -0
  208. package/src/skills/builtin/info_gatherer.ts +405 -0
  209. package/src/skills/builtin/joke.ts +191 -0
  210. package/src/skills/builtin/math.ts +142 -0
  211. package/src/skills/builtin/mcp_gateway.ts +677 -0
  212. package/src/skills/builtin/native_vector_search.ts +901 -0
  213. package/src/skills/builtin/play_background_file.ts +358 -0
  214. package/src/skills/builtin/spider.ts +869 -0
  215. package/src/skills/builtin/swml_transfer.ts +635 -0
  216. package/src/skills/builtin/weather_api.ts +248 -0
  217. package/src/skills/builtin/web_search.ts +1074 -0
  218. package/src/skills/builtin/wikipedia_search.ts +299 -0
  219. package/src/skills/index.ts +12 -0
  220. package/src/types.ts +132 -0
  221. package/tests/AgentBase.test.ts +1093 -0
  222. package/tests/AgentServer.test.ts +126 -0
  223. package/tests/AuthHandler.test.ts +133 -0
  224. package/tests/ConfigLoader.test.ts +151 -0
  225. package/tests/ContextBuilder.test.ts +108 -0
  226. package/tests/DataMap.test.ts +367 -0
  227. package/tests/EphemeralSkillCopy.test.ts +107 -0
  228. package/tests/FunctionResult.test.ts +298 -0
  229. package/tests/GracefulShutdown.test.ts +46 -0
  230. package/tests/Logger.test.ts +420 -0
  231. package/tests/PomBuilder.test.ts +228 -0
  232. package/tests/ProxyDetection.test.ts +228 -0
  233. package/tests/SWMLService.test.ts +320 -0
  234. package/tests/SWMLVerbHandler.test.ts +523 -0
  235. package/tests/SchemaUtils.test.ts +106 -0
  236. package/tests/SchemaUtils.verb.test.ts +206 -0
  237. package/tests/SecurityUtils.test.ts +192 -0
  238. package/tests/ServerlessAdapter.test.ts +222 -0
  239. package/tests/SessionManager.test.ts +257 -0
  240. package/tests/SkillBaseFeatures.test.ts +130 -0
  241. package/tests/SkillMultiInstance.test.ts +102 -0
  242. package/tests/SkillParameterSchemas.test.ts +134 -0
  243. package/tests/SkillRegistrySchema.test.ts +84 -0
  244. package/tests/SslConfig.test.ts +97 -0
  245. package/tests/SwmlBuilder.test.ts +400 -0
  246. package/tests/TypeInference.test.ts +165 -0
  247. package/tests/VerbHandlerRegistry.test.ts +128 -0
  248. package/tests/cli/mock-data.test.ts +113 -0
  249. package/tests/cli/swaig-test.test.ts +108 -0
  250. package/tests/examples.test.ts +194 -0
  251. package/tests/fixtures/scrape-parity/README.md +53 -0
  252. package/tests/fixtures/scrape-parity/expected/01_simple_article.json +5 -0
  253. package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +5 -0
  254. package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +5 -0
  255. package/tests/fixtures/scrape-parity/expected/04_bare_body.json +5 -0
  256. package/tests/fixtures/scrape-parity/expected/05_malformed.json +5 -0
  257. package/tests/fixtures/scrape-parity/expected/06_multi_class.json +5 -0
  258. package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +5 -0
  259. package/tests/fixtures/scrape-parity/expected/08_inline_script.json +5 -0
  260. package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +5 -0
  261. package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +5 -0
  262. package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +5 -0
  263. package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +5 -0
  264. package/tests/fixtures/scrape-parity/html/01_simple_article.html +18 -0
  265. package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +18 -0
  266. package/tests/fixtures/scrape-parity/html/03_nested_containers.html +13 -0
  267. package/tests/fixtures/scrape-parity/html/04_bare_body.html +9 -0
  268. package/tests/fixtures/scrape-parity/html/05_malformed.html +11 -0
  269. package/tests/fixtures/scrape-parity/html/06_multi_class.html +18 -0
  270. package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +12 -0
  271. package/tests/fixtures/scrape-parity/html/08_inline_script.html +17 -0
  272. package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +21 -0
  273. package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +10 -0
  274. package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +13 -0
  275. package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +24 -0
  276. package/tests/fixtures/scrape-parity/python_extract.py +109 -0
  277. package/tests/livewire/livewire.test.ts +780 -0
  278. package/tests/mcp.test.ts +221 -0
  279. package/tests/prefabs/prefabs.test.ts +1093 -0
  280. package/tests/relay/Action.test.ts +392 -0
  281. package/tests/relay/Call.test.ts +535 -0
  282. package/tests/relay/Deferred.test.ts +71 -0
  283. package/tests/relay/Message.test.ts +164 -0
  284. package/tests/relay/RelayClient.test.ts +779 -0
  285. package/tests/relay/RelayEvent.test.ts +463 -0
  286. package/tests/relay/helpers.ts +79 -0
  287. package/tests/rest/HttpClient.test.ts +274 -0
  288. package/tests/rest/RestError.test.ts +53 -0
  289. package/tests/rest/calling.test.ts +156 -0
  290. package/tests/rest/client.test.ts +197 -0
  291. package/tests/rest/compat.test.ts +335 -0
  292. package/tests/rest/datasphere.test.ts +71 -0
  293. package/tests/rest/fabric.test.ts +186 -0
  294. package/tests/rest/helpers.ts +95 -0
  295. package/tests/rest/logs.test.ts +68 -0
  296. package/tests/rest/pagination.test.ts +133 -0
  297. package/tests/rest/registry.test.ts +94 -0
  298. package/tests/rest/relay-rest.test.ts +290 -0
  299. package/tests/rest/video.test.ts +173 -0
  300. package/tests/setup.ts +6 -0
  301. package/tests/skills/SkillBase.test.ts +108 -0
  302. package/tests/skills/SkillManager.test.ts +268 -0
  303. package/tests/skills/SkillRegistry.test.ts +176 -0
  304. package/tests/skills/builtin.test.ts +1472 -0
  305. package/tests/skills/claude-skills.test.ts +54 -0
  306. package/tests/skills/custom-skills.test.ts +53 -0
  307. package/tests/skills/datasphere-serverless.test.ts +70 -0
  308. package/tests/skills/datasphere.test.ts +107 -0
  309. package/tests/skills/datetime.test.ts +101 -0
  310. package/tests/skills/google-maps.test.ts +78 -0
  311. package/tests/skills/info-gatherer.test.ts +411 -0
  312. package/tests/skills/joke.test.ts +81 -0
  313. package/tests/skills/math.test.ts +68 -0
  314. package/tests/skills/mcp-gateway.test.ts +101 -0
  315. package/tests/skills/play-background.test.ts +54 -0
  316. package/tests/skills/spider.test.ts +108 -0
  317. package/tests/skills/swml-transfer.test.ts +178 -0
  318. package/tests/skills/trivia.test.ts +54 -0
  319. package/tests/skills/vector-search.test.ts +135 -0
  320. package/tests/skills/weather-api.test.ts +77 -0
  321. package/tests/skills/web-search-parity.test.ts +59 -0
  322. package/tests/skills/web-search.test.ts +103 -0
  323. package/tests/skills/wikipedia.test.ts +63 -0
  324. package/tsconfig.json +18 -0
  325. package/vitest.config.ts +9 -0
@@ -0,0 +1,38 @@
1
+ /**
2
+ * Web Search Skill Example
3
+ *
4
+ * Agent with the web search skill for looking up current information.
5
+ * Requires GOOGLE_SEARCH_API_KEY and GOOGLE_SEARCH_CX environment variables.
6
+ * Run: npx tsx examples/web-search.ts
7
+ */
8
+
9
+ import { AgentBase, WebSearchSkill } from '../src/index.js';
10
+
11
+ export const agent = new AgentBase({
12
+ name: 'search-agent',
13
+ route: '/',
14
+ basicAuth: [
15
+ process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
16
+ process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
17
+ ],
18
+ });
19
+
20
+ agent.setPromptText(
21
+ 'You are a research assistant with access to web search. ' +
22
+ 'When the user asks about current events, facts, or anything you are not sure about, ' +
23
+ 'use the web_search tool to find up-to-date information. ' +
24
+ 'Summarize search results concisely.',
25
+ );
26
+
27
+ // Add web search skill with custom configuration
28
+ await agent.addSkill(
29
+ new WebSearchSkill({
30
+ max_results: 5,
31
+ safe_search: 'medium',
32
+ }),
33
+ );
34
+
35
+ agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
36
+ agent.addHints(['search', 'look up', 'find out', 'Google']);
37
+
38
+ agent.run();
@@ -0,0 +1,36 @@
1
+ /**
2
+ * Wikipedia Skill Example
3
+ *
4
+ * Agent with the Wikipedia search skill for encyclopedic knowledge.
5
+ * No API key required — uses the public Wikipedia REST API.
6
+ * Run: npx tsx examples/wikipedia.ts
7
+ */
8
+
9
+ import { AgentBase, WikipediaSearchSkill, DateTimeSkill } from '../src/index.js';
10
+
11
+ export const agent = new AgentBase({
12
+ name: 'wiki-agent',
13
+ route: '/',
14
+ basicAuth: [
15
+ process.env['SWML_BASIC_AUTH_USER'] ?? 'user',
16
+ process.env['SWML_BASIC_AUTH_PASSWORD'] ?? 'pass',
17
+ ],
18
+ });
19
+
20
+ agent.setPromptText(
21
+ 'You are a knowledgeable assistant with access to Wikipedia. ' +
22
+ 'When the user asks about a topic, person, place, or concept, ' +
23
+ 'search Wikipedia to provide accurate encyclopedic information. ' +
24
+ 'Summarize the information naturally rather than reading it verbatim.',
25
+ );
26
+
27
+ // Add Wikipedia search skill — no API key needed
28
+ await agent.addSkill(new WikipediaSearchSkill());
29
+
30
+ // Also add datetime for general utility
31
+ await agent.addSkill(new DateTimeSkill());
32
+
33
+ agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rachel' });
34
+ agent.addHints(['Wikipedia', 'encyclopedia', 'article']);
35
+
36
+ agent.run();
@@ -0,0 +1,140 @@
1
+ # LiveWire -- LiveKit-Compatible Agents on SignalWire
2
+
3
+ ```
4
+ __ _ _ ___
5
+ / / (_) _____ | | / (_)_______
6
+ / / / / | / / _ \ | | /| / / / ___/ _ \
7
+ / /___/ /| |/ / __/ | |/ |/ / / / / __/
8
+ /_____/_/ |___/\___/ |__/|__/_/_/ \___/
9
+
10
+ LiveKit-compatible agents powered by SignalWire
11
+ ```
12
+
13
+ LiveWire lets you run LiveKit-style voice agents on SignalWire's infrastructure with zero changes to your application logic. Just swap the import path -- SignalWire handles STT, TTS, VAD, LLM orchestration, and call control at scale.
14
+
15
+ ## Quick Start
16
+
17
+ ```typescript
18
+ import {
19
+ Agent, AgentSession, tool, RunContext,
20
+ defineAgent, JobContext, runApp,
21
+ } from '@signalwire/sdk/livewire';
22
+
23
+ const getWeather = tool({
24
+ description: 'Get weather for a location',
25
+ parameters: {
26
+ type: 'object',
27
+ properties: {
28
+ location: { type: 'string', description: 'City name' },
29
+ },
30
+ },
31
+ execute: (params: { location: string }) => {
32
+ return `The weather in ${params.location} is sunny, 72F with clear skies.`;
33
+ },
34
+ });
35
+
36
+ export default defineAgent({
37
+ entry: async (ctx: JobContext) => {
38
+ await ctx.connect();
39
+
40
+ const session = new AgentSession({
41
+ stt: 'deepgram',
42
+ llm: 'openai/gpt-4',
43
+ tts: 'elevenlabs',
44
+ });
45
+
46
+ const agent = new Agent({
47
+ instructions: 'You are a helpful weather assistant.',
48
+ tools: { get_weather: { ...getWeather, name: 'get_weather' } },
49
+ });
50
+
51
+ await session.start({ agent });
52
+ session.generateReply({ instructions: 'Greet the user and ask how you can help.' });
53
+ },
54
+ });
55
+ ```
56
+
57
+ ## Why LiveWire?
58
+
59
+ LiveKit agents require you to manage your own STT, TTS, VAD, and LLM infrastructure. Each component is a separate service you configure, deploy, and scale independently. LiveWire provides the same developer-facing API, but SignalWire's control plane handles the entire media pipeline:
60
+
61
+ - **STT** -- speech recognition runs in SignalWire's cloud at scale
62
+ - **TTS** -- text-to-speech runs in SignalWire's cloud at scale
63
+ - **VAD** -- voice activity detection is automatic, no configuration needed
64
+ - **LLM** -- model orchestration is handled by the platform
65
+ - **Call control** -- barge-in, hold, transfer, conferencing all built in
66
+
67
+ You write the same agent code. SignalWire runs it.
68
+
69
+ ## Feature Mapping
70
+
71
+ | LiveKit Concept | SignalWire Equivalent | Notes |
72
+ |---|---|---|
73
+ | `voice.Agent` | `Agent` | Identical API |
74
+ | `voice.AgentSession` | `AgentSession` | Maps to `AgentBase` internally |
75
+ | `llm.tool()` | `tool()` | Registers SWAIG functions |
76
+ | `llm.handoff()` | `handoff()` | Multi-agent handoff |
77
+ | `RunContext` | `RunContext` | Available in tool handlers |
78
+ | `defineAgent()` | `defineAgent()` | Wraps entry/prewarm |
79
+ | `cli.runApp()` | `runApp()` | Starts the agent |
80
+ | `stt: 'deepgram'` | Noop (logged once) | Platform handles STT |
81
+ | `tts: 'elevenlabs'` | Noop (logged once) | Platform handles TTS |
82
+ | `vad: silero` | Noop (logged once) | Platform handles VAD |
83
+ | `llm: 'openai/gpt-4'` | Maps to model param | Model selection works |
84
+ | `AgentSession.interrupt()` | Noop (logged once) | Barge-in is automatic |
85
+ | `JobContext.connect()` | Noop (logged once) | Platform connects automatically |
86
+ | `prewarm` | Noop (logged once) | No warm pools needed |
87
+ | `AgentHandoff` | `AgentHandoff` | Multi-agent handoff |
88
+ | `StopResponse` | `StopResponse` | Suppress LLM reply |
89
+
90
+ ## What's Noop'd and Why
91
+
92
+ Several LiveKit concepts are no-ops on SignalWire because the platform handles them automatically:
93
+
94
+ - **STT/TTS/VAD providers**: SignalWire's control plane runs the entire speech pipeline. Specifying `stt: 'deepgram'` is accepted but ignored -- the platform selects optimal providers automatically.
95
+ - **JobContext.connect()**: SignalWire agents connect when the platform invokes the SWML endpoint. There is no manual connection step.
96
+ - **prewarm / warm pools**: SignalWire manages media infrastructure scaling. No process prewarming is needed.
97
+ - **interrupt()**: Barge-in (caller interrupting the agent) is automatic on SignalWire.
98
+
99
+ Each noop logs an informational message once so you know it was received but is not needed.
100
+
101
+ ## Plugin Stubs
102
+
103
+ LiveWire includes stub types for common LiveKit plugin providers:
104
+
105
+ - `plugins.DeepgramSTT` -- STT stub
106
+ - `plugins.ElevenLabsTTS` -- TTS stub
107
+ - `plugins.CartesiaTTS` -- TTS stub
108
+ - `plugins.OpenAILLM` -- LLM stub
109
+ - `plugins.SileroVAD` -- VAD stub
110
+
111
+ These exist so that LiveKit code that creates provider instances continues to compile. They have no effect at runtime.
112
+
113
+ ## Inference Stubs
114
+
115
+ - `inference.STT` -- STT model stub
116
+ - `inference.LLM` -- LLM model stub
117
+ - `inference.TTS` -- TTS model stub
118
+
119
+ ## Documentation
120
+
121
+ - [Migration Guide](docs/migration-guide.md) -- step-by-step guide for migrating a LiveKit agent to LiveWire
122
+ - [LiveWire source code](../src/livewire/) -- the full TypeScript implementation
123
+
124
+ ## Examples
125
+
126
+ - [livewire-basic-agent.ts](examples/livewire-basic-agent.ts) -- simple agent with a single tool
127
+ - [livewire-multi-tool.ts](examples/livewire-multi-tool.ts) -- agent with multiple function tools and RunContext
128
+ - [livewire-handoff.ts](examples/livewire-handoff.ts) -- multi-agent with AgentHandoff
129
+
130
+ ## Environment Variables
131
+
132
+ LiveWire agents use the same environment variables as standard SignalWire agents:
133
+
134
+ | Variable | Description |
135
+ |----------|-------------|
136
+ | `SIGNALWIRE_PROJECT_ID` | Project ID (if using RELAY features) |
137
+ | `SIGNALWIRE_API_TOKEN` | API token (if using RELAY features) |
138
+ | `SWML_BASIC_AUTH_USER` | HTTP Basic Auth username (auto-generated if not set) |
139
+ | `SWML_BASIC_AUTH_PASSWORD` | HTTP Basic Auth password (auto-generated if not set) |
140
+ | `PORT` | HTTP server port (default: 3000) |
@@ -0,0 +1,228 @@
1
+ # Migrating a LiveKit Agent to LiveWire
2
+
3
+ This guide walks through converting an existing LiveKit voice agent (TypeScript / @livekit/agents-js) to run on SignalWire's platform using LiveWire. The process is mechanical -- mostly import path changes -- because LiveWire mirrors LiveKit's API surface.
4
+
5
+ ## Step 1: Change the Import Path
6
+
7
+ Replace all LiveKit agent imports with the LiveWire module:
8
+
9
+ ```typescript
10
+ // Before (LiveKit)
11
+ import { defineAgent, type JobContext } from '@livekit/agents';
12
+ import { AgentSession } from '@livekit/agents/voice';
13
+ import { tool } from '@livekit/agents/llm';
14
+ import { DeepgramSTT } from '@livekit/agents-plugin-deepgram';
15
+ import { ElevenLabsTTS } from '@livekit/agents-plugin-elevenlabs';
16
+ import { SileroVAD } from '@livekit/agents-plugin-silero';
17
+
18
+ // After (LiveWire)
19
+ import {
20
+ defineAgent, JobContext, AgentSession, Agent, tool, RunContext,
21
+ plugins, runApp,
22
+ } from '@signalwire/sdk/livewire';
23
+ ```
24
+
25
+ All types are in a single module. No separate plugin packages needed.
26
+
27
+ ## Step 2: Update Type References
28
+
29
+ Replace LiveKit type names with their LiveWire equivalents. In most cases the names are identical:
30
+
31
+ ```typescript
32
+ // Before (LiveKit)
33
+ import { Agent } from '@livekit/agents/voice';
34
+ const agent = new Agent({ instructions: 'Hello' });
35
+
36
+ // After (LiveWire)
37
+ import { Agent } from '@signalwire/sdk/livewire';
38
+ const agent = new Agent({ instructions: 'Hello' });
39
+ ```
40
+
41
+ ## Step 3: Update Session Options
42
+
43
+ LiveWire provides the same session options. STT, TTS, and VAD are accepted but are noops -- SignalWire's control plane handles the media pipeline. LLM model selection is honored.
44
+
45
+ ```typescript
46
+ // Before (LiveKit)
47
+ const session = new AgentSession({
48
+ stt: new DeepgramSTT(),
49
+ tts: new ElevenLabsTTS(),
50
+ vad: SileroVAD.load(),
51
+ llm: new OpenAILLM({ model: 'gpt-4' }),
52
+ });
53
+
54
+ // After (LiveWire)
55
+ const session = new AgentSession({
56
+ stt: 'deepgram', // noop -- platform handles STT
57
+ tts: 'elevenlabs', // noop -- platform handles TTS
58
+ vad: plugins.SileroVAD.load(), // noop -- platform handles VAD
59
+ llm: 'openai/gpt-4', // model selection is honored
60
+ });
61
+ ```
62
+
63
+ ## Step 4: Update Tool Definitions
64
+
65
+ LiveWire uses the same `tool()` function:
66
+
67
+ ```typescript
68
+ // Before (LiveKit)
69
+ import { tool } from '@livekit/agents/llm';
70
+
71
+ const getWeather = tool({
72
+ description: 'Get weather for a location',
73
+ parameters: z.object({ location: z.string() }),
74
+ execute: async ({ location }) => `Sunny in ${location}`,
75
+ });
76
+
77
+ // After (LiveWire)
78
+ import { tool } from '@signalwire/sdk/livewire';
79
+
80
+ const getWeather = tool({
81
+ description: 'Get weather for a location',
82
+ parameters: {
83
+ type: 'object',
84
+ properties: {
85
+ location: { type: 'string', description: 'City name' },
86
+ },
87
+ },
88
+ execute: (params: { location: string }) => `Sunny in ${params.location}`,
89
+ });
90
+ ```
91
+
92
+ Note: LiveWire accepts both Zod schemas and plain JSON Schema objects for parameters.
93
+
94
+ ## Step 5: Update the Entrypoint
95
+
96
+ ```typescript
97
+ // Before (LiveKit)
98
+ export default defineAgent({
99
+ prewarm: async (proc) => { /* warmup */ },
100
+ entry: async (ctx) => {
101
+ await ctx.connect();
102
+ // ... create session, agent, tools ...
103
+ },
104
+ });
105
+
106
+ // After (LiveWire)
107
+ export default defineAgent({
108
+ prewarm: (proc) => { /* warmup -- noop on SignalWire */ },
109
+ entry: async (ctx) => {
110
+ await ctx.connect(); // noop on SignalWire
111
+ // ... create session, agent, tools ...
112
+ },
113
+ });
114
+ ```
115
+
116
+ ## Step 6: Remove Infrastructure Configuration
117
+
118
+ LiveKit agents typically have configuration for:
119
+
120
+ - STT API keys and endpoints
121
+ - TTS API keys and endpoints
122
+ - VAD model paths
123
+ - LLM API keys
124
+ - WebRTC TURN/STUN servers
125
+ - Room service URLs
126
+
127
+ With LiveWire, none of this is needed. SignalWire's platform manages the entire media pipeline. You can delete all infrastructure configuration.
128
+
129
+ The only configuration you need:
130
+
131
+ ```bash
132
+ # For the agent HTTP server
133
+ export PORT=3000 # optional, defaults to 3000
134
+
135
+ # If using RELAY or REST features
136
+ export SIGNALWIRE_PROJECT_ID=your-project-id
137
+ export SIGNALWIRE_API_TOKEN=your-api-token
138
+ ```
139
+
140
+ ## Step 7: Deploy
141
+
142
+ LiveWire agents are standard HTTP servers. Deploy them anywhere:
143
+
144
+ ```bash
145
+ # Build
146
+ npx tsc
147
+
148
+ # Run
149
+ node dist/my-agent.js
150
+ ```
151
+
152
+ Point your SignalWire phone number at the agent's URL and calls will flow through automatically.
153
+
154
+ ## Complete Before/After Example
155
+
156
+ ### Before (LiveKit)
157
+
158
+ ```typescript
159
+ import { defineAgent, type JobContext } from '@livekit/agents';
160
+ import { AgentSession } from '@livekit/agents/voice';
161
+ import { tool, Agent } from '@livekit/agents/llm';
162
+ import { DeepgramSTT } from '@livekit/agents-plugin-deepgram';
163
+ import { ElevenLabsTTS } from '@livekit/agents-plugin-elevenlabs';
164
+ import { SileroVAD } from '@livekit/agents-plugin-silero';
165
+
166
+ const greet = tool({
167
+ description: 'Greet someone by name',
168
+ parameters: z.object({ name: z.string() }),
169
+ execute: async ({ name }) => `Hello, ${name}!`,
170
+ });
171
+
172
+ export default defineAgent({
173
+ entry: async (ctx: JobContext) => {
174
+ await ctx.connect();
175
+ const session = new AgentSession({
176
+ stt: new DeepgramSTT(),
177
+ tts: new ElevenLabsTTS(),
178
+ vad: SileroVAD.load(),
179
+ });
180
+ const agent = new Agent({
181
+ instructions: 'You are a helpful assistant.',
182
+ tools: { greet },
183
+ });
184
+ await session.start({ agent, room: ctx.room });
185
+ },
186
+ });
187
+ ```
188
+
189
+ ### After (LiveWire)
190
+
191
+ ```typescript
192
+ import {
193
+ defineAgent, JobContext, AgentSession, Agent, tool,
194
+ plugins, runApp,
195
+ } from '@signalwire/sdk/livewire';
196
+
197
+ const greet = tool({
198
+ description: 'Greet someone by name',
199
+ parameters: {
200
+ type: 'object',
201
+ properties: { name: { type: 'string', description: 'Name to greet' } },
202
+ },
203
+ execute: (params: { name: string }) => `Hello, ${params.name}!`,
204
+ });
205
+
206
+ export default defineAgent({
207
+ entry: async (ctx: JobContext) => {
208
+ await ctx.connect();
209
+ const session = new AgentSession({
210
+ stt: 'deepgram',
211
+ tts: 'elevenlabs',
212
+ vad: plugins.SileroVAD.load(),
213
+ llm: 'openai/gpt-4',
214
+ });
215
+ const agent = new Agent({
216
+ instructions: 'You are a helpful assistant.',
217
+ tools: { greet: { ...greet, name: 'greet' } },
218
+ });
219
+ await session.start({ agent });
220
+ },
221
+ });
222
+ ```
223
+
224
+ The code is nearly identical. The differences are:
225
+
226
+ 1. Single import path instead of multiple plugin packages
227
+ 2. Provider names are strings instead of class instances
228
+ 3. Everything runs on SignalWire's infrastructure -- no STT/TTS/VAD services to manage
@@ -0,0 +1,74 @@
1
+ /**
2
+ * Example: Basic LiveWire agent with a single tool.
3
+ *
4
+ * Demonstrates the simplest possible LiveWire agent: an AI assistant
5
+ * with one function tool. This mirrors the standard @livekit/agents-js
6
+ * pattern -- just with a different import path.
7
+ *
8
+ * Run:
9
+ * npx tsx livewire/examples/livewire-basic-agent.ts
10
+ *
11
+ * Then point a SignalWire phone number at http://your-host:3000/
12
+ */
13
+
14
+ import {
15
+ Agent,
16
+ AgentSession,
17
+ tool,
18
+ defineAgent,
19
+ runApp,
20
+ type JobContext,
21
+ } from '../../src/livewire/index.js';
22
+
23
+ // Define a weather tool
24
+ const getWeather = tool({
25
+ description: 'Get current weather for a location',
26
+ parameters: {
27
+ type: 'object',
28
+ properties: {
29
+ location: { type: 'string', description: 'City name' },
30
+ },
31
+ required: ['location'],
32
+ },
33
+ execute: (params: { location: string }) => {
34
+ // In production, call a real weather API here
35
+ return `The weather in ${params.location} is sunny, 72F with clear skies.`;
36
+ },
37
+ });
38
+
39
+ // Define the agent using LiveKit-compatible API
40
+ const agentDef = defineAgent({
41
+ entry: async (ctx: JobContext) => {
42
+ // Connect is a noop on SignalWire -- the platform handles
43
+ // connection lifecycle automatically.
44
+ await ctx.connect();
45
+
46
+ // Configure the session. STT and TTS are noops -- SignalWire's
47
+ // control plane handles the media pipeline. LLM model selection
48
+ // is honored.
49
+ const session = new AgentSession({
50
+ stt: 'deepgram',
51
+ llm: 'openai/gpt-4',
52
+ tts: 'elevenlabs',
53
+ });
54
+
55
+ // Create an agent with instructions and a tool
56
+ const agent = new Agent({
57
+ instructions:
58
+ 'You are a helpful weather assistant. When asked about weather, use the get_weather tool.',
59
+ tools: { get_weather: { ...getWeather, name: 'get_weather' } },
60
+ });
61
+
62
+ // Start the session -- this binds the agent to SignalWire's
63
+ // AgentBase and registers all tools.
64
+ await session.start({ agent });
65
+
66
+ // Generate an initial greeting
67
+ session.generateReply({
68
+ instructions: 'Greet the user and ask how you can help with weather information.',
69
+ });
70
+ },
71
+ });
72
+
73
+ // Start the LiveWire agent
74
+ runApp(agentDef);