@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,274 @@
1
+ import { HttpClient } from '../../src/rest/HttpClient.js';
2
+ import { RestError } from '../../src/rest/RestError.js';
3
+ import { createMockFetch, mockClientOptions } from './helpers.js';
4
+
5
+ describe('HttpClient', () => {
6
+ it('sends Basic Auth header', async () => {
7
+ const { options, getRequests } = mockClientOptions([
8
+ { status: 200, body: { ok: true } },
9
+ ]);
10
+ const http = new HttpClient(options);
11
+
12
+ await http.get('/api/test');
13
+
14
+ const reqs = getRequests();
15
+ expect(reqs).toHaveLength(1);
16
+ const expected = 'Basic ' + Buffer.from('test-project:test-token').toString('base64');
17
+ expect(reqs[0].headers['Authorization']).toBe(expected);
18
+ });
19
+
20
+ it('sends Accept and User-Agent headers', async () => {
21
+ const { options, getRequests } = mockClientOptions([
22
+ { status: 200, body: {} },
23
+ ]);
24
+ const http = new HttpClient(options);
25
+
26
+ await http.get('/api/test');
27
+
28
+ const reqs = getRequests();
29
+ expect(reqs[0].headers['Accept']).toBe('application/json');
30
+ expect(reqs[0].headers['User-Agent']).toContain('@signalwire/sdk-ts');
31
+ });
32
+
33
+ it('sends Content-Type for POST with body', async () => {
34
+ const { options, getRequests } = mockClientOptions([
35
+ { status: 200, body: { id: '123' } },
36
+ ]);
37
+ const http = new HttpClient(options);
38
+
39
+ await http.post('/api/test', { name: 'foo' });
40
+
41
+ const reqs = getRequests();
42
+ expect(reqs[0].headers['Content-Type']).toBe('application/json');
43
+ expect(reqs[0].body).toEqual({ name: 'foo' });
44
+ });
45
+
46
+ it('does not send Content-Type for GET', async () => {
47
+ const { options, getRequests } = mockClientOptions([
48
+ { status: 200, body: {} },
49
+ ]);
50
+ const http = new HttpClient(options);
51
+
52
+ await http.get('/api/test');
53
+
54
+ const reqs = getRequests();
55
+ expect(reqs[0].headers['Content-Type']).toBeUndefined();
56
+ });
57
+
58
+ it('returns parsed JSON on success', async () => {
59
+ const { options } = mockClientOptions([
60
+ { status: 200, body: { data: [1, 2, 3] } },
61
+ ]);
62
+ const http = new HttpClient(options);
63
+
64
+ const result = await http.get('/api/test');
65
+ expect(result).toEqual({ data: [1, 2, 3] });
66
+ });
67
+
68
+ it('returns empty object on 204', async () => {
69
+ const { options } = mockClientOptions([
70
+ { status: 204, body: undefined },
71
+ ]);
72
+ const http = new HttpClient(options);
73
+
74
+ const result = await http.delete('/api/test/123');
75
+ expect(result).toEqual({});
76
+ });
77
+
78
+ it('throws RestError on non-2xx', async () => {
79
+ const { options } = mockClientOptions([
80
+ { status: 404, body: { error: 'not found' } },
81
+ ]);
82
+ const http = new HttpClient(options);
83
+
84
+ await expect(http.get('/api/test/bad')).rejects.toThrow(RestError);
85
+
86
+ try {
87
+ await http.get('/api/test/bad');
88
+ } catch (e) {
89
+ // Second request will get default 200 response from our mock
90
+ }
91
+ });
92
+
93
+ it('RestError contains status, body, url, method', async () => {
94
+ const { options } = mockClientOptions([
95
+ { status: 422, body: { errors: ['invalid'] } },
96
+ ]);
97
+ const http = new HttpClient(options);
98
+
99
+ try {
100
+ await http.post('/api/test', { bad: true });
101
+ throw new Error('Should have thrown');
102
+ } catch (e) {
103
+ expect(e).toBeInstanceOf(RestError);
104
+ const err = e as RestError;
105
+ expect(err.statusCode).toBe(422);
106
+ expect(err.url).toBe('https://test.signalwire.com/api/test');
107
+ expect(err.method).toBe('POST');
108
+ }
109
+ });
110
+
111
+ it('appends query params to URL', async () => {
112
+ const { options, getRequests } = mockClientOptions([
113
+ { status: 200, body: { data: [] } },
114
+ ]);
115
+ const http = new HttpClient(options);
116
+
117
+ await http.get('/api/test', { page: 2, limit: 10 });
118
+
119
+ const reqs = getRequests();
120
+ expect(reqs[0].url).toContain('page=2');
121
+ expect(reqs[0].url).toContain('limit=10');
122
+ });
123
+
124
+ it('skips undefined query params', async () => {
125
+ const { options, getRequests } = mockClientOptions([
126
+ { status: 200, body: {} },
127
+ ]);
128
+ const http = new HttpClient(options);
129
+
130
+ await http.get('/api/test', { page: 1, filter: undefined });
131
+
132
+ const reqs = getRequests();
133
+ expect(reqs[0].url).toContain('page=1');
134
+ expect(reqs[0].url).not.toContain('filter');
135
+ });
136
+
137
+ it('PUT sends body correctly', async () => {
138
+ const { options, getRequests } = mockClientOptions([
139
+ { status: 200, body: { updated: true } },
140
+ ]);
141
+ const http = new HttpClient(options);
142
+
143
+ const result = await http.put('/api/test/123', { name: 'bar' });
144
+
145
+ const reqs = getRequests();
146
+ expect(reqs[0].method).toBe('PUT');
147
+ expect(reqs[0].body).toEqual({ name: 'bar' });
148
+ expect(result).toEqual({ updated: true });
149
+ });
150
+
151
+ it('PATCH sends body correctly', async () => {
152
+ const { options, getRequests } = mockClientOptions([
153
+ { status: 200, body: { patched: true } },
154
+ ]);
155
+ const http = new HttpClient(options);
156
+
157
+ const result = await http.patch('/api/test/123', { name: 'baz' });
158
+
159
+ const reqs = getRequests();
160
+ expect(reqs[0].method).toBe('PATCH');
161
+ expect(reqs[0].body).toEqual({ name: 'baz' });
162
+ expect(result).toEqual({ patched: true });
163
+ });
164
+
165
+ it('strips trailing slashes from baseUrl', async () => {
166
+ const { options, getRequests } = mockClientOptions([
167
+ { status: 200, body: {} },
168
+ ]);
169
+ options.baseUrl = 'https://test.signalwire.com///';
170
+ const http = new HttpClient(options);
171
+
172
+ await http.get('/api/test');
173
+
174
+ const reqs = getRequests();
175
+ expect(reqs[0].url).toBe('https://test.signalwire.com/api/test');
176
+ });
177
+
178
+ it('handles absolute URLs (for pagination)', async () => {
179
+ const { options, getRequests } = mockClientOptions([
180
+ { status: 200, body: { data: [1] } },
181
+ ]);
182
+ const http = new HttpClient(options);
183
+
184
+ await http.get('https://other.signalwire.com/api/test?page=2');
185
+
186
+ const reqs = getRequests();
187
+ expect(reqs[0].url).toBe('https://other.signalwire.com/api/test?page=2');
188
+ });
189
+
190
+ it('accepts host option and prepends https://', async () => {
191
+ const [fetchImpl, getRequests] = createMockFetch([
192
+ { status: 200, body: { ok: true } },
193
+ ]);
194
+ const http = new HttpClient({
195
+ host: 'example.signalwire.com',
196
+ project: 'test-project',
197
+ token: 'test-token',
198
+ fetchImpl,
199
+ });
200
+
201
+ expect(http.baseUrl).toBe('https://example.signalwire.com');
202
+
203
+ await http.get('/api/test');
204
+
205
+ const reqs = getRequests();
206
+ expect(reqs[0].url).toBe('https://example.signalwire.com/api/test');
207
+ });
208
+
209
+ it('host takes precedence over baseUrl when both are provided', () => {
210
+ const [fetchImpl] = createMockFetch();
211
+ const http = new HttpClient({
212
+ host: 'from-host.signalwire.com',
213
+ baseUrl: 'https://from-baseurl.signalwire.com',
214
+ project: 'test-project',
215
+ token: 'test-token',
216
+ fetchImpl,
217
+ });
218
+
219
+ expect(http.baseUrl).toBe('https://from-host.signalwire.com');
220
+ });
221
+
222
+ it('throws when neither host nor baseUrl is provided', () => {
223
+ const [fetchImpl] = createMockFetch();
224
+ expect(() => new HttpClient({
225
+ project: 'test-project',
226
+ token: 'test-token',
227
+ fetchImpl,
228
+ })).toThrow('HttpClientOptions requires either "host" or "baseUrl".');
229
+ });
230
+
231
+ it('RestError body is parsed JSON object when server returns JSON error', async () => {
232
+ const { options } = mockClientOptions([
233
+ { status: 422, body: { errors: ['invalid'] } },
234
+ ]);
235
+ const http = new HttpClient(options);
236
+
237
+ try {
238
+ await http.post('/api/test', { bad: true });
239
+ throw new Error('Should have thrown');
240
+ } catch (e) {
241
+ expect(e).toBeInstanceOf(RestError);
242
+ const err = e as RestError;
243
+ expect(typeof err.body).toBe('object');
244
+ expect(err.body).toEqual({ errors: ['invalid'] });
245
+ }
246
+ });
247
+
248
+ it('RestError body is plain string when server returns non-JSON error', async () => {
249
+ const [fetchImpl] = createMockFetch();
250
+ // Override the mock to return a non-JSON text body
251
+ const http = new HttpClient({
252
+ baseUrl: 'https://test.signalwire.com',
253
+ project: 'test-project',
254
+ token: 'test-token',
255
+ fetchImpl: async (input, init) => {
256
+ return new Response('Internal Server Error', {
257
+ status: 500,
258
+ statusText: 'Internal Server Error',
259
+ headers: { 'Content-Type': 'text/plain' },
260
+ });
261
+ },
262
+ });
263
+
264
+ try {
265
+ await http.get('/api/test');
266
+ throw new Error('Should have thrown');
267
+ } catch (e) {
268
+ expect(e).toBeInstanceOf(RestError);
269
+ const err = e as RestError;
270
+ expect(typeof err.body).toBe('string');
271
+ expect(err.body).toBe('Internal Server Error');
272
+ }
273
+ });
274
+ });
@@ -0,0 +1,53 @@
1
+ import { RestError, SignalWireRestError } from '../../src/rest/RestError.js';
2
+
3
+ describe('RestError', () => {
4
+ it('formats error message from status, body, url, method', () => {
5
+ const err = new RestError(404, 'Not Found', 'https://x.signalwire.com/api/test', 'GET');
6
+ expect(err.message).toBe('GET https://x.signalwire.com/api/test returned 404: Not Found');
7
+ expect(err.statusCode).toBe(404);
8
+ expect(err.body).toBe('Not Found');
9
+ expect(err.url).toBe('https://x.signalwire.com/api/test');
10
+ expect(err.method).toBe('GET');
11
+ expect(err.name).toBe('RestError');
12
+ });
13
+
14
+ it('is an instance of Error', () => {
15
+ const err = new RestError(500, 'Internal', '/api/test', 'POST');
16
+ expect(err).toBeInstanceOf(Error);
17
+ expect(err).toBeInstanceOf(RestError);
18
+ });
19
+
20
+ it('captures stack trace', () => {
21
+ const err = new RestError(400, 'Bad Request', '/api/test', 'PUT');
22
+ expect(err.stack).toBeDefined();
23
+ expect(err.stack).toContain('RestError');
24
+ });
25
+
26
+ it('defaults method to GET when omitted', () => {
27
+ const err = new RestError(500, 'Server Error', '/api/test');
28
+ expect(err.method).toBe('GET');
29
+ expect(err.message).toBe('GET /api/test returned 500: Server Error');
30
+ });
31
+
32
+ it('accepts an object body and stringifies it in the message', () => {
33
+ const bodyObj = { errors: ['invalid field'] };
34
+ const err = new RestError(422, bodyObj, '/api/test', 'POST');
35
+ expect(err.body).toEqual(bodyObj);
36
+ expect(typeof err.body).toBe('object');
37
+ expect(err.message).toBe('POST /api/test returned 422: {"errors":["invalid field"]}');
38
+ });
39
+
40
+ it('preserves string body as-is', () => {
41
+ const err = new RestError(400, 'Bad Request', '/api/test', 'POST');
42
+ expect(err.body).toBe('Bad Request');
43
+ expect(typeof err.body).toBe('string');
44
+ });
45
+
46
+ it('SignalWireRestError is the same class as RestError', () => {
47
+ expect(SignalWireRestError).toBe(RestError);
48
+ const err = new SignalWireRestError(404, 'Not Found', '/api/test');
49
+ expect(err).toBeInstanceOf(RestError);
50
+ expect(err).toBeInstanceOf(SignalWireRestError);
51
+ expect(err.name).toBe('RestError');
52
+ });
53
+ });
@@ -0,0 +1,156 @@
1
+ import { HttpClient } from '../../src/rest/HttpClient.js';
2
+ import { CallingNamespace } from '../../src/rest/namespaces/calling.js';
3
+ import { mockClientOptions } from './helpers.js';
4
+
5
+ describe('CallingNamespace', () => {
6
+ function setup(responses: any[] = [{ status: 200, body: { result: 'ok' } }]) {
7
+ const { options, getRequests } = mockClientOptions(responses);
8
+ const http = new HttpClient(options);
9
+ const calling = new CallingNamespace(http);
10
+ return { calling, getRequests };
11
+ }
12
+
13
+ it('dial sends command without call_id', async () => {
14
+ const { calling, getRequests } = setup();
15
+ await calling.dial({ to: '+15551234567', from: '+15559876543' });
16
+ const req = getRequests()[0];
17
+ expect(req.method).toBe('POST');
18
+ expect(req.url).toContain('/api/calling/calls');
19
+ expect(req.body).toEqual({
20
+ command: 'dial',
21
+ params: { to: '+15551234567', from: '+15559876543' },
22
+ });
23
+ expect(req.body.id).toBeUndefined();
24
+ });
25
+
26
+ it('end sends command with call_id', async () => {
27
+ const { calling, getRequests } = setup();
28
+ await calling.end('call-123', { reason: 'hangup' });
29
+ const req = getRequests()[0];
30
+ expect(req.body).toEqual({
31
+ command: 'calling.end',
32
+ id: 'call-123',
33
+ params: { reason: 'hangup' },
34
+ });
35
+ });
36
+
37
+ it('play sends correct command', async () => {
38
+ const { calling, getRequests } = setup();
39
+ await calling.play('call-123', { url: 'http://example.com/audio.mp3' });
40
+ expect(getRequests()[0].body.command).toBe('calling.play');
41
+ });
42
+
43
+ it('playPause sends correct command', async () => {
44
+ const { calling, getRequests } = setup();
45
+ await calling.playPause('call-123');
46
+ expect(getRequests()[0].body.command).toBe('calling.play.pause');
47
+ });
48
+
49
+ it('record sends correct command', async () => {
50
+ const { calling, getRequests } = setup();
51
+ await calling.record('call-123', { beep: true });
52
+ expect(getRequests()[0].body.command).toBe('calling.record');
53
+ expect(getRequests()[0].body.params).toEqual({ beep: true });
54
+ });
55
+
56
+ it('collect sends correct command', async () => {
57
+ const { calling, getRequests } = setup();
58
+ await calling.collect('call-123', { digits: { max: 4 } });
59
+ expect(getRequests()[0].body.command).toBe('calling.collect');
60
+ });
61
+
62
+ it('detect sends correct command', async () => {
63
+ const { calling, getRequests } = setup();
64
+ await calling.detect('call-123');
65
+ expect(getRequests()[0].body.command).toBe('calling.detect');
66
+ });
67
+
68
+ it('tap sends correct command', async () => {
69
+ const { calling, getRequests } = setup();
70
+ await calling.tap('call-123');
71
+ expect(getRequests()[0].body.command).toBe('calling.tap');
72
+ });
73
+
74
+ it('stream sends correct command', async () => {
75
+ const { calling, getRequests } = setup();
76
+ await calling.stream('call-123');
77
+ expect(getRequests()[0].body.command).toBe('calling.stream');
78
+ });
79
+
80
+ it('denoise sends correct command', async () => {
81
+ const { calling, getRequests } = setup();
82
+ await calling.denoise('call-123');
83
+ expect(getRequests()[0].body.command).toBe('calling.denoise');
84
+ });
85
+
86
+ it('transcribe sends correct command', async () => {
87
+ const { calling, getRequests } = setup();
88
+ await calling.transcribe('call-123');
89
+ expect(getRequests()[0].body.command).toBe('calling.transcribe');
90
+ });
91
+
92
+ it('aiMessage sends correct command', async () => {
93
+ const { calling, getRequests } = setup();
94
+ await calling.aiMessage('call-123', { message: 'hello' });
95
+ expect(getRequests()[0].body.command).toBe('calling.ai_message');
96
+ });
97
+
98
+ it('aiStop sends correct command', async () => {
99
+ const { calling, getRequests } = setup();
100
+ await calling.aiStop('call-123');
101
+ expect(getRequests()[0].body.command).toBe('calling.ai.stop');
102
+ });
103
+
104
+ it('liveTranscribe sends correct command', async () => {
105
+ const { calling, getRequests } = setup();
106
+ await calling.liveTranscribe('call-123');
107
+ expect(getRequests()[0].body.command).toBe('calling.live_transcribe');
108
+ });
109
+
110
+ it('refer sends correct command', async () => {
111
+ const { calling, getRequests } = setup();
112
+ await calling.refer('call-123', { to: 'sip:user@example.com' });
113
+ expect(getRequests()[0].body.command).toBe('calling.refer');
114
+ });
115
+
116
+ it('userEvent sends correct command', async () => {
117
+ const { calling, getRequests } = setup();
118
+ await calling.userEvent('call-123', { event_name: 'custom' });
119
+ expect(getRequests()[0].body.command).toBe('calling.user_event');
120
+ });
121
+
122
+ it('all stop commands use correct format', async () => {
123
+ const { calling, getRequests } = setup([
124
+ { status: 200, body: {} },
125
+ { status: 200, body: {} },
126
+ { status: 200, body: {} },
127
+ { status: 200, body: {} },
128
+ { status: 200, body: {} },
129
+ { status: 200, body: {} },
130
+ { status: 200, body: {} },
131
+ { status: 200, body: {} },
132
+ { status: 200, body: {} },
133
+ ]);
134
+
135
+ await calling.playStop('c1');
136
+ await calling.recordStop('c1');
137
+ await calling.collectStop('c1');
138
+ await calling.detectStop('c1');
139
+ await calling.tapStop('c1');
140
+ await calling.streamStop('c1');
141
+ await calling.denoiseStop('c1');
142
+ await calling.transcribeStop('c1');
143
+ await calling.sendFaxStop('c1');
144
+
145
+ const reqs = getRequests();
146
+ expect(reqs[0].body.command).toBe('calling.play.stop');
147
+ expect(reqs[1].body.command).toBe('calling.record.stop');
148
+ expect(reqs[2].body.command).toBe('calling.collect.stop');
149
+ expect(reqs[3].body.command).toBe('calling.detect.stop');
150
+ expect(reqs[4].body.command).toBe('calling.tap.stop');
151
+ expect(reqs[5].body.command).toBe('calling.stream.stop');
152
+ expect(reqs[6].body.command).toBe('calling.denoise.stop');
153
+ expect(reqs[7].body.command).toBe('calling.transcribe.stop');
154
+ expect(reqs[8].body.command).toBe('calling.send_fax.stop');
155
+ });
156
+ });
@@ -0,0 +1,197 @@
1
+ import { RestClient } from '../../src/rest/index.js';
2
+ import { createMockFetch } from './helpers.js';
3
+
4
+ describe('RestClient', () => {
5
+ const savedEnv: Record<string, string | undefined> = {};
6
+
7
+ beforeEach(() => {
8
+ // Save and clear REST-related env vars to prevent leaking between tests
9
+ for (const key of ['SIGNALWIRE_PROJECT_ID', 'SIGNALWIRE_API_TOKEN', 'SIGNALWIRE_SPACE']) {
10
+ savedEnv[key] = process.env[key];
11
+ delete process.env[key];
12
+ }
13
+ });
14
+
15
+ afterEach(() => {
16
+ // Restore
17
+ for (const [key, val] of Object.entries(savedEnv)) {
18
+ if (val === undefined) delete process.env[key];
19
+ else process.env[key] = val;
20
+ }
21
+ });
22
+
23
+ it('constructs with explicit options', () => {
24
+ const [fetchImpl] = createMockFetch();
25
+ const client = new RestClient({
26
+ project: 'proj-123',
27
+ token: 'tok-456',
28
+ host: 'test.signalwire.com',
29
+ fetchImpl,
30
+ });
31
+
32
+ expect(client.fabric).toBeDefined();
33
+ expect(client.calling).toBeDefined();
34
+ expect(client.phoneNumbers).toBeDefined();
35
+ expect(client.addresses).toBeDefined();
36
+ expect(client.queues).toBeDefined();
37
+ expect(client.recordings).toBeDefined();
38
+ expect(client.numberGroups).toBeDefined();
39
+ expect(client.verifiedCallers).toBeDefined();
40
+ expect(client.sipProfile).toBeDefined();
41
+ expect(client.lookup).toBeDefined();
42
+ expect(client.shortCodes).toBeDefined();
43
+ expect(client.importedNumbers).toBeDefined();
44
+ expect(client.mfa).toBeDefined();
45
+ expect(client.registry).toBeDefined();
46
+ expect(client.datasphere).toBeDefined();
47
+ expect(client.video).toBeDefined();
48
+ expect(client.logs).toBeDefined();
49
+ expect(client.project).toBeDefined();
50
+ expect(client.pubsub).toBeDefined();
51
+ expect(client.chat).toBeDefined();
52
+ expect(client.compat).toBeDefined();
53
+ });
54
+
55
+ it('throws when project is missing', () => {
56
+ const [fetchImpl] = createMockFetch();
57
+ expect(() => new RestClient({
58
+ token: 'tok',
59
+ host: 'test.signalwire.com',
60
+ fetchImpl,
61
+ })).toThrow(/project, token, and host are required/);
62
+ });
63
+
64
+ it('throws when token is missing', () => {
65
+ const [fetchImpl] = createMockFetch();
66
+ expect(() => new RestClient({
67
+ project: 'proj',
68
+ host: 'test.signalwire.com',
69
+ fetchImpl,
70
+ })).toThrow(/project, token, and host are required/);
71
+ });
72
+
73
+ it('throws when host is missing', () => {
74
+ const [fetchImpl] = createMockFetch();
75
+ expect(() => new RestClient({
76
+ project: 'proj',
77
+ token: 'tok',
78
+ fetchImpl,
79
+ })).toThrow(/project, token, and host are required/);
80
+ });
81
+
82
+ it('reads from environment variables', () => {
83
+ const [fetchImpl] = createMockFetch();
84
+ process.env['SIGNALWIRE_PROJECT_ID'] = 'env-proj';
85
+ process.env['SIGNALWIRE_API_TOKEN'] = 'env-tok';
86
+ process.env['SIGNALWIRE_SPACE'] = 'env.signalwire.com';
87
+
88
+ const client = new RestClient({ fetchImpl });
89
+ expect(client.fabric).toBeDefined();
90
+ });
91
+
92
+ it('explicit options override env vars', () => {
93
+ const [fetchImpl, getRequests] = createMockFetch([
94
+ { status: 200, body: { data: [] } },
95
+ ]);
96
+ process.env['SIGNALWIRE_PROJECT_ID'] = 'env-proj';
97
+ process.env['SIGNALWIRE_API_TOKEN'] = 'env-tok';
98
+ process.env['SIGNALWIRE_SPACE'] = 'env.signalwire.com';
99
+
100
+ const client = new RestClient({
101
+ project: 'explicit-proj',
102
+ token: 'explicit-tok',
103
+ host: 'explicit.signalwire.com',
104
+ fetchImpl,
105
+ });
106
+
107
+ // Verify by making a request and checking the auth header + URL
108
+ client.phoneNumbers.list();
109
+ const reqs = getRequests();
110
+ // Auth header should use explicit creds
111
+ const expected = 'Basic ' + Buffer.from('explicit-proj:explicit-tok').toString('base64');
112
+ expect(reqs[0].headers['Authorization']).toBe(expected);
113
+ // URL should use explicit host
114
+ expect(reqs[0].url).toContain('explicit.signalwire.com');
115
+ });
116
+
117
+ it('normalizes host without https://', () => {
118
+ const [fetchImpl, getRequests] = createMockFetch([
119
+ { status: 200, body: { data: [] } },
120
+ ]);
121
+ const client = new RestClient({
122
+ project: 'proj',
123
+ token: 'tok',
124
+ host: 'my.signalwire.com',
125
+ fetchImpl,
126
+ });
127
+
128
+ client.phoneNumbers.list();
129
+ expect(getRequests()[0].url).toMatch(/^https:\/\/my\.signalwire\.com/);
130
+ });
131
+
132
+ it('preserves https:// if already present', () => {
133
+ const [fetchImpl, getRequests] = createMockFetch([
134
+ { status: 200, body: { data: [] } },
135
+ ]);
136
+ const client = new RestClient({
137
+ project: 'proj',
138
+ token: 'tok',
139
+ host: 'https://my.signalwire.com',
140
+ fetchImpl,
141
+ });
142
+
143
+ client.phoneNumbers.list();
144
+ expect(getRequests()[0].url).toMatch(/^https:\/\/my\.signalwire\.com/);
145
+ expect(getRequests()[0].url).not.toContain('https://https://');
146
+ });
147
+
148
+ it('compat namespace is scoped to project ID', async () => {
149
+ const [fetchImpl, getRequests] = createMockFetch([
150
+ { status: 200, body: { calls: [] } },
151
+ ]);
152
+ const client = new RestClient({
153
+ project: 'proj-abc',
154
+ token: 'tok',
155
+ host: 'test.signalwire.com',
156
+ fetchImpl,
157
+ });
158
+
159
+ await client.compat.calls.list();
160
+ expect(getRequests()[0].url).toContain('/api/laml/2010-04-01/Accounts/proj-abc/Calls');
161
+ });
162
+
163
+ it('all namespaces route through same HttpClient', async () => {
164
+ const [fetchImpl, getRequests] = createMockFetch([
165
+ { status: 200, body: { data: [] } }, // fabric
166
+ { status: 200, body: {} }, // calling
167
+ { status: 200, body: { data: [] } }, // phoneNumbers
168
+ { status: 200, body: { data: [] } }, // video
169
+ ]);
170
+ const client = new RestClient({
171
+ project: 'proj',
172
+ token: 'tok',
173
+ host: 'test.signalwire.com',
174
+ fetchImpl,
175
+ });
176
+
177
+ await client.fabric.aiAgents.list();
178
+ await client.calling.dial({ to: '+1' });
179
+ await client.phoneNumbers.list();
180
+ await client.video.rooms.list();
181
+
182
+ const reqs = getRequests();
183
+ expect(reqs).toHaveLength(4);
184
+
185
+ // All should use same auth
186
+ const auth = reqs[0].headers['Authorization'];
187
+ for (const req of reqs) {
188
+ expect(req.headers['Authorization']).toBe(auth);
189
+ }
190
+
191
+ // Verify different paths
192
+ expect(reqs[0].url).toContain('/api/fabric/resources/ai_agents');
193
+ expect(reqs[1].url).toContain('/api/calling/calls');
194
+ expect(reqs[2].url).toContain('/api/relay/rest/phone_numbers');
195
+ expect(reqs[3].url).toContain('/api/video/rooms');
196
+ });
197
+ });