@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,463 @@
1
+ import { describe, it, expect } from 'vitest';
2
+ import {
3
+ RelayEvent,
4
+ CallStateEvent,
5
+ CallReceiveEvent,
6
+ PlayEvent,
7
+ RecordEvent,
8
+ CollectEvent,
9
+ ConnectEvent,
10
+ DetectEvent,
11
+ FaxEvent,
12
+ TapEvent,
13
+ StreamEvent,
14
+ SendDigitsEvent,
15
+ DialEvent,
16
+ ReferEvent,
17
+ DenoiseEvent,
18
+ PayEvent,
19
+ QueueEvent,
20
+ EchoEvent,
21
+ TranscribeEvent,
22
+ HoldEvent,
23
+ ConferenceEvent,
24
+ CallingErrorEvent,
25
+ MessageReceiveEvent,
26
+ MessageStateEvent,
27
+ parseEvent,
28
+ } from '../../src/relay/RelayEvent.js';
29
+
30
+ describe('RelayEvent', () => {
31
+ it('parses base event from payload', () => {
32
+ const e = RelayEvent.fromPayload({
33
+ event_type: 'test.event',
34
+ params: { call_id: 'c1', timestamp: 1234 },
35
+ });
36
+ expect(e.eventType).toBe('test.event');
37
+ expect(e.callId).toBe('c1');
38
+ expect(e.timestamp).toBe(1234);
39
+ expect(e.params.call_id).toBe('c1');
40
+ });
41
+
42
+ it('handles missing fields gracefully', () => {
43
+ const e = RelayEvent.fromPayload({});
44
+ expect(e.eventType).toBe('');
45
+ expect(e.callId).toBe('');
46
+ expect(e.timestamp).toBe(0);
47
+ });
48
+ });
49
+
50
+ describe('CallStateEvent', () => {
51
+ it('parses call state event', () => {
52
+ const e = CallStateEvent.fromPayload({
53
+ event_type: 'calling.call.state',
54
+ params: {
55
+ call_id: 'c1',
56
+ call_state: 'answered',
57
+ end_reason: '',
58
+ direction: 'inbound',
59
+ device: { type: 'phone', params: { to_number: '+1234' } },
60
+ },
61
+ });
62
+ expect(e).toBeInstanceOf(CallStateEvent);
63
+ expect(e.callState).toBe('answered');
64
+ expect(e.direction).toBe('inbound');
65
+ expect(e.device.type).toBe('phone');
66
+ expect(e.endReason).toBe('');
67
+ });
68
+ });
69
+
70
+ describe('CallReceiveEvent', () => {
71
+ it('parses call receive event with context fallback', () => {
72
+ const e = CallReceiveEvent.fromPayload({
73
+ event_type: 'calling.call.receive',
74
+ params: {
75
+ call_id: 'c1',
76
+ call_state: 'ringing',
77
+ direction: 'inbound',
78
+ node_id: 'n1',
79
+ project_id: 'p1',
80
+ protocol: 'office',
81
+ segment_id: 's1',
82
+ tag: 't1',
83
+ },
84
+ });
85
+ expect(e).toBeInstanceOf(CallReceiveEvent);
86
+ expect(e.context).toBe('office'); // falls back to protocol
87
+ expect(e.tag).toBe('t1');
88
+ expect(e.nodeId).toBe('n1');
89
+ });
90
+
91
+ it('prefers context over protocol', () => {
92
+ const e = CallReceiveEvent.fromPayload({
93
+ event_type: 'calling.call.receive',
94
+ params: { context: 'myctx', protocol: 'old' },
95
+ });
96
+ expect(e.context).toBe('myctx');
97
+ });
98
+ });
99
+
100
+ describe('PlayEvent', () => {
101
+ it('parses play event', () => {
102
+ const e = PlayEvent.fromPayload({
103
+ event_type: 'calling.call.play',
104
+ params: { call_id: 'c1', control_id: 'ctrl1', state: 'playing' },
105
+ });
106
+ expect(e).toBeInstanceOf(PlayEvent);
107
+ expect(e.controlId).toBe('ctrl1');
108
+ expect(e.state).toBe('playing');
109
+ });
110
+ });
111
+
112
+ describe('RecordEvent', () => {
113
+ it('parses record event with nested record obj', () => {
114
+ const e = RecordEvent.fromPayload({
115
+ event_type: 'calling.call.record',
116
+ params: {
117
+ call_id: 'c1',
118
+ control_id: 'ctrl1',
119
+ state: 'finished',
120
+ record: { url: 'https://example.com/rec.mp3', duration: 12.5, size: 100000 },
121
+ },
122
+ });
123
+ expect(e).toBeInstanceOf(RecordEvent);
124
+ expect(e.url).toBe('https://example.com/rec.mp3');
125
+ expect(e.duration).toBe(12.5);
126
+ expect(e.size).toBe(100000);
127
+ });
128
+
129
+ it('falls back to top-level url/duration/size', () => {
130
+ const e = RecordEvent.fromPayload({
131
+ event_type: 'calling.call.record',
132
+ params: {
133
+ call_id: 'c1',
134
+ control_id: 'ctrl1',
135
+ state: 'finished',
136
+ url: 'https://example.com/fallback.mp3',
137
+ duration: 5.0,
138
+ size: 5000,
139
+ },
140
+ });
141
+ expect(e.url).toBe('https://example.com/fallback.mp3');
142
+ expect(e.duration).toBe(5.0);
143
+ expect(e.size).toBe(5000);
144
+ });
145
+ });
146
+
147
+ describe('CollectEvent', () => {
148
+ it('parses collect event', () => {
149
+ const e = CollectEvent.fromPayload({
150
+ event_type: 'calling.call.collect',
151
+ params: {
152
+ call_id: 'c1',
153
+ control_id: 'ctrl1',
154
+ state: 'finished',
155
+ result: { type: 'digit', params: { digits: '1234', terminator: '#' } },
156
+ final: true,
157
+ },
158
+ });
159
+ expect(e).toBeInstanceOf(CollectEvent);
160
+ expect(e.result.type).toBe('digit');
161
+ expect(e.final).toBe(true);
162
+ });
163
+ });
164
+
165
+ describe('ConnectEvent', () => {
166
+ it('parses connect event', () => {
167
+ const e = ConnectEvent.fromPayload({
168
+ event_type: 'calling.call.connect',
169
+ params: { call_id: 'c1', connect_state: 'connected', peer: { call_id: 'c2' } },
170
+ });
171
+ expect(e).toBeInstanceOf(ConnectEvent);
172
+ expect(e.connectState).toBe('connected');
173
+ expect(e.peer.call_id).toBe('c2');
174
+ });
175
+ });
176
+
177
+ describe('DetectEvent', () => {
178
+ it('parses detect event', () => {
179
+ const e = DetectEvent.fromPayload({
180
+ event_type: 'calling.call.detect',
181
+ params: { call_id: 'c1', control_id: 'ctrl1', detect: { type: 'machine', params: { event: 'HUMAN' } } },
182
+ });
183
+ expect(e).toBeInstanceOf(DetectEvent);
184
+ expect(e.detect.type).toBe('machine');
185
+ });
186
+ });
187
+
188
+ describe('FaxEvent', () => {
189
+ it('parses fax event', () => {
190
+ const e = FaxEvent.fromPayload({
191
+ event_type: 'calling.call.fax',
192
+ params: { call_id: 'c1', control_id: 'ctrl1', fax: { type: 'send', pages: 3 } },
193
+ });
194
+ expect(e).toBeInstanceOf(FaxEvent);
195
+ expect(e.fax.pages).toBe(3);
196
+ });
197
+ });
198
+
199
+ describe('TapEvent', () => {
200
+ it('parses tap event', () => {
201
+ const e = TapEvent.fromPayload({
202
+ event_type: 'calling.call.tap',
203
+ params: { call_id: 'c1', control_id: 'ctrl1', state: 'tapping', tap: {}, device: { type: 'rtp' } },
204
+ });
205
+ expect(e).toBeInstanceOf(TapEvent);
206
+ expect(e.state).toBe('tapping');
207
+ expect(e.device.type).toBe('rtp');
208
+ });
209
+ });
210
+
211
+ describe('StreamEvent', () => {
212
+ it('parses stream event', () => {
213
+ const e = StreamEvent.fromPayload({
214
+ event_type: 'calling.call.stream',
215
+ params: { call_id: 'c1', control_id: 'ctrl1', state: 'streaming', url: 'wss://stream', name: 'mystream' },
216
+ });
217
+ expect(e).toBeInstanceOf(StreamEvent);
218
+ expect(e.url).toBe('wss://stream');
219
+ expect(e.name).toBe('mystream');
220
+ });
221
+ });
222
+
223
+ describe('SendDigitsEvent', () => {
224
+ it('parses send_digits event', () => {
225
+ const e = SendDigitsEvent.fromPayload({
226
+ event_type: 'calling.call.send_digits',
227
+ params: { call_id: 'c1', control_id: 'ctrl1', state: 'finished' },
228
+ });
229
+ expect(e).toBeInstanceOf(SendDigitsEvent);
230
+ expect(e.state).toBe('finished');
231
+ });
232
+ });
233
+
234
+ describe('DialEvent', () => {
235
+ it('parses dial event', () => {
236
+ const e = DialEvent.fromPayload({
237
+ event_type: 'calling.call.dial',
238
+ params: { tag: 'tag1', dial_state: 'answered', call: { call_id: 'c1', node_id: 'n1' } },
239
+ });
240
+ expect(e).toBeInstanceOf(DialEvent);
241
+ expect(e.tag).toBe('tag1');
242
+ expect(e.dialState).toBe('answered');
243
+ expect(e.call.call_id).toBe('c1');
244
+ });
245
+ });
246
+
247
+ describe('ReferEvent', () => {
248
+ it('parses refer event', () => {
249
+ const e = ReferEvent.fromPayload({
250
+ event_type: 'calling.call.refer',
251
+ params: {
252
+ call_id: 'c1',
253
+ state: 'completed',
254
+ sip_refer_to: 'sip:+1234@example.com',
255
+ sip_refer_response_code: '202',
256
+ sip_notify_response_code: '200',
257
+ },
258
+ });
259
+ expect(e).toBeInstanceOf(ReferEvent);
260
+ expect(e.sipReferTo).toBe('sip:+1234@example.com');
261
+ });
262
+ });
263
+
264
+ describe('DenoiseEvent', () => {
265
+ it('parses denoise event', () => {
266
+ const e = DenoiseEvent.fromPayload({
267
+ event_type: 'calling.call.denoise',
268
+ params: { call_id: 'c1', denoised: true },
269
+ });
270
+ expect(e).toBeInstanceOf(DenoiseEvent);
271
+ expect(e.denoised).toBe(true);
272
+ });
273
+ });
274
+
275
+ describe('PayEvent', () => {
276
+ it('parses pay event', () => {
277
+ const e = PayEvent.fromPayload({
278
+ event_type: 'calling.call.pay',
279
+ params: { call_id: 'c1', control_id: 'ctrl1', state: 'processing' },
280
+ });
281
+ expect(e).toBeInstanceOf(PayEvent);
282
+ expect(e.state).toBe('processing');
283
+ });
284
+ });
285
+
286
+ describe('QueueEvent', () => {
287
+ it('parses queue event', () => {
288
+ const e = QueueEvent.fromPayload({
289
+ event_type: 'calling.call.queue',
290
+ params: { call_id: 'c1', control_id: 'ctrl1', status: 'entered', id: 'q1', name: 'support', position: 3, size: 10 },
291
+ });
292
+ expect(e).toBeInstanceOf(QueueEvent);
293
+ expect(e.queueId).toBe('q1');
294
+ expect(e.queueName).toBe('support');
295
+ expect(e.position).toBe(3);
296
+ expect(e.size).toBe(10);
297
+ });
298
+ });
299
+
300
+ describe('EchoEvent', () => {
301
+ it('parses echo event', () => {
302
+ const e = EchoEvent.fromPayload({
303
+ event_type: 'calling.call.echo',
304
+ params: { call_id: 'c1', state: 'active' },
305
+ });
306
+ expect(e).toBeInstanceOf(EchoEvent);
307
+ expect(e.state).toBe('active');
308
+ });
309
+ });
310
+
311
+ describe('TranscribeEvent', () => {
312
+ it('parses transcribe event', () => {
313
+ const e = TranscribeEvent.fromPayload({
314
+ event_type: 'calling.call.transcribe',
315
+ params: { call_id: 'c1', control_id: 'ctrl1', state: 'finished', url: 'https://url', recording_id: 'r1', duration: 30.0, size: 500000 },
316
+ });
317
+ expect(e).toBeInstanceOf(TranscribeEvent);
318
+ expect(e.recordingId).toBe('r1');
319
+ expect(e.duration).toBe(30.0);
320
+ });
321
+ });
322
+
323
+ describe('HoldEvent', () => {
324
+ it('parses hold event', () => {
325
+ const e = HoldEvent.fromPayload({
326
+ event_type: 'calling.call.hold',
327
+ params: { call_id: 'c1', state: 'held' },
328
+ });
329
+ expect(e).toBeInstanceOf(HoldEvent);
330
+ expect(e.state).toBe('held');
331
+ });
332
+ });
333
+
334
+ describe('ConferenceEvent', () => {
335
+ it('parses conference event', () => {
336
+ const e = ConferenceEvent.fromPayload({
337
+ event_type: 'calling.conference',
338
+ params: { conference_id: 'conf1', name: 'standup', status: 'active' },
339
+ });
340
+ expect(e).toBeInstanceOf(ConferenceEvent);
341
+ expect(e.conferenceId).toBe('conf1');
342
+ });
343
+ });
344
+
345
+ describe('CallingErrorEvent', () => {
346
+ it('parses calling error event', () => {
347
+ const e = CallingErrorEvent.fromPayload({
348
+ event_type: 'calling.error',
349
+ params: { call_id: 'c1', code: '404', message: 'Not found' },
350
+ });
351
+ expect(e).toBeInstanceOf(CallingErrorEvent);
352
+ expect(e.code).toBe('404');
353
+ expect(e.message).toBe('Not found');
354
+ });
355
+ });
356
+
357
+ describe('MessageReceiveEvent', () => {
358
+ it('parses messaging receive event', () => {
359
+ const e = MessageReceiveEvent.fromPayload({
360
+ event_type: 'messaging.receive',
361
+ params: {
362
+ message_id: 'm1',
363
+ context: 'sms',
364
+ direction: 'inbound',
365
+ from_number: '+1111',
366
+ to_number: '+2222',
367
+ body: 'Hello',
368
+ media: ['https://img.com/a.jpg'],
369
+ segments: 1,
370
+ message_state: 'received',
371
+ tags: ['vip'],
372
+ },
373
+ });
374
+ expect(e).toBeInstanceOf(MessageReceiveEvent);
375
+ expect(e.messageId).toBe('m1');
376
+ expect(e.fromNumber).toBe('+1111');
377
+ expect(e.body).toBe('Hello');
378
+ expect(e.media).toEqual(['https://img.com/a.jpg']);
379
+ expect(e.tags).toEqual(['vip']);
380
+ });
381
+ });
382
+
383
+ describe('MessageStateEvent', () => {
384
+ it('parses messaging state event', () => {
385
+ const e = MessageStateEvent.fromPayload({
386
+ event_type: 'messaging.state',
387
+ params: {
388
+ message_id: 'm1',
389
+ context: 'sms',
390
+ direction: 'outbound',
391
+ from_number: '+2222',
392
+ to_number: '+1111',
393
+ body: 'Hey',
394
+ segments: 1,
395
+ message_state: 'delivered',
396
+ reason: '',
397
+ },
398
+ });
399
+ expect(e).toBeInstanceOf(MessageStateEvent);
400
+ expect(e.messageState).toBe('delivered');
401
+ expect(e.reason).toBe('');
402
+ });
403
+ });
404
+
405
+ describe('parseEvent', () => {
406
+ it('returns typed event for known types', () => {
407
+ const e = parseEvent({
408
+ event_type: 'calling.call.state',
409
+ params: { call_id: 'c1', call_state: 'ended', end_reason: 'hangup' },
410
+ });
411
+ expect(e).toBeInstanceOf(CallStateEvent);
412
+ expect((e as CallStateEvent).callState).toBe('ended');
413
+ });
414
+
415
+ it('returns base RelayEvent for unknown types', () => {
416
+ const e = parseEvent({
417
+ event_type: 'custom.unknown',
418
+ params: { foo: 'bar' },
419
+ });
420
+ expect(e).toBeInstanceOf(RelayEvent);
421
+ expect(e).not.toBeInstanceOf(CallStateEvent);
422
+ expect(e.eventType).toBe('custom.unknown');
423
+ });
424
+
425
+ it('handles empty payload', () => {
426
+ const e = parseEvent({});
427
+ expect(e).toBeInstanceOf(RelayEvent);
428
+ expect(e.eventType).toBe('');
429
+ });
430
+
431
+ it('parses all 22 event types', () => {
432
+ const types = [
433
+ ['calling.call.state', CallStateEvent],
434
+ ['calling.call.receive', CallReceiveEvent],
435
+ ['calling.call.play', PlayEvent],
436
+ ['calling.call.record', RecordEvent],
437
+ ['calling.call.collect', CollectEvent],
438
+ ['calling.call.connect', ConnectEvent],
439
+ ['calling.call.detect', DetectEvent],
440
+ ['calling.call.fax', FaxEvent],
441
+ ['calling.call.tap', TapEvent],
442
+ ['calling.call.stream', StreamEvent],
443
+ ['calling.call.send_digits', SendDigitsEvent],
444
+ ['calling.call.dial', DialEvent],
445
+ ['calling.call.refer', ReferEvent],
446
+ ['calling.call.denoise', DenoiseEvent],
447
+ ['calling.call.pay', PayEvent],
448
+ ['calling.call.queue', QueueEvent],
449
+ ['calling.call.echo', EchoEvent],
450
+ ['calling.call.transcribe', TranscribeEvent],
451
+ ['calling.call.hold', HoldEvent],
452
+ ['calling.conference', ConferenceEvent],
453
+ ['calling.error', CallingErrorEvent],
454
+ ['messaging.receive', MessageReceiveEvent],
455
+ ['messaging.state', MessageStateEvent],
456
+ ] as const;
457
+
458
+ for (const [eventType, expectedClass] of types) {
459
+ const e = parseEvent({ event_type: eventType, params: {} });
460
+ expect(e).toBeInstanceOf(expectedClass);
461
+ }
462
+ });
463
+ });
@@ -0,0 +1,79 @@
1
+ /**
2
+ * Mock WebSocket for testing RelayClient without a real connection.
3
+ */
4
+
5
+ import { EventEmitter } from 'node:events';
6
+
7
+ export class MockWebSocket extends EventEmitter {
8
+ sent: string[] = [];
9
+ readyState = 1; // OPEN
10
+ closed = false;
11
+
12
+ send(data: string): void {
13
+ this.sent.push(data);
14
+ }
15
+
16
+ close(_code?: number, _reason?: string): void {
17
+ this.closed = true;
18
+ // Emit close event asynchronously
19
+ setImmediate(() => this.emit('close'));
20
+ }
21
+
22
+ removeAllListeners(): this {
23
+ super.removeAllListeners();
24
+ return this;
25
+ }
26
+
27
+ /** Simulate receiving a JSON message from the server. */
28
+ receiveMessage(msg: Record<string, unknown>): void {
29
+ this.emit('message', JSON.stringify(msg));
30
+ }
31
+
32
+ /** Get the last sent JSON message. */
33
+ getLastSent(): Record<string, unknown> | null {
34
+ if (this.sent.length === 0) return null;
35
+ return JSON.parse(this.sent[this.sent.length - 1]);
36
+ }
37
+
38
+ /** Get all sent messages as parsed JSON. */
39
+ getAllSent(): Record<string, unknown>[] {
40
+ return this.sent.map((s) => JSON.parse(s));
41
+ }
42
+
43
+ /** Find a sent message by method. */
44
+ findSent(method: string): Record<string, unknown> | undefined {
45
+ return this.getAllSent().find((m) => m.method === method);
46
+ }
47
+
48
+ /**
49
+ * Auto-respond to the signalwire.connect auth request.
50
+ * Call this after setting up the WS factory on the client.
51
+ */
52
+ autoAuthenticate(protocol = 'test-protocol'): void {
53
+ // Listen for incoming messages and respond to signalwire.connect
54
+ const origSend = this.send.bind(this);
55
+ this.send = (data: string) => {
56
+ origSend(data);
57
+ const msg = JSON.parse(data);
58
+ if (msg.method === 'signalwire.connect') {
59
+ // Respond with success
60
+ setImmediate(() => {
61
+ this.receiveMessage({
62
+ jsonrpc: '2.0',
63
+ id: msg.id,
64
+ result: { protocol, identity: 'test-identity' },
65
+ });
66
+ });
67
+ } else if (msg.method === 'signalwire.ping') {
68
+ // Auto-respond to pings
69
+ setImmediate(() => {
70
+ this.receiveMessage({
71
+ jsonrpc: '2.0',
72
+ id: msg.id,
73
+ result: {},
74
+ });
75
+ });
76
+ }
77
+ };
78
+ }
79
+ }