@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,298 @@
1
+ import { describe, it, expect } from 'vitest';
2
+ import { FunctionResult } from '../src/FunctionResult.js';
3
+
4
+ describe('FunctionResult', () => {
5
+ it('returns default response when empty', () => {
6
+ const r = new FunctionResult();
7
+ expect(r.toDict()).toEqual({ response: 'Action completed.' });
8
+ });
9
+
10
+ it('stores response from constructor', () => {
11
+ const r = new FunctionResult('hello');
12
+ expect(r.toDict()).toEqual({ response: 'hello' });
13
+ });
14
+
15
+ it('supports setResponse', () => {
16
+ const r = new FunctionResult().setResponse('hi');
17
+ expect(r.toDict()).toEqual({ response: 'hi' });
18
+ });
19
+
20
+ it('supports addAction chaining', () => {
21
+ const r = new FunctionResult('ok')
22
+ .addAction('hangup', true)
23
+ .addAction('stop', true);
24
+ const d = r.toDict();
25
+ expect(d.response).toBe('ok');
26
+ expect(d.action).toEqual([{ hangup: true }, { stop: true }]);
27
+ });
28
+
29
+ it('supports addActions', () => {
30
+ const r = new FunctionResult('ok').addActions([
31
+ { set_global_data: { k: 'v' } },
32
+ { play: { url: 'music.mp3' } },
33
+ ]);
34
+ expect((r.toDict().action as unknown[]).length).toBe(2);
35
+ });
36
+
37
+ it('includes post_process only when true and actions present', () => {
38
+ const r1 = new FunctionResult('hi', true);
39
+ expect(r1.toDict()).toEqual({ response: 'hi' }); // no actions = no post_process
40
+
41
+ const r2 = new FunctionResult('hi', true).hangup();
42
+ expect(r2.toDict().post_process).toBe(true);
43
+
44
+ const r3 = new FunctionResult('hi', false).hangup();
45
+ expect(r3.toDict().post_process).toBeUndefined();
46
+ });
47
+
48
+ it('connect builds correct SWML', () => {
49
+ const r = new FunctionResult('transferring').connect('+15551234567');
50
+ const act = (r.toDict().action as Record<string, unknown>[])[0];
51
+ expect(act['transfer']).toBe('true');
52
+ const swml = act['SWML'] as Record<string, unknown>;
53
+ expect(swml['version']).toBe('1.0.0');
54
+ });
55
+
56
+ it('connect with from address', () => {
57
+ const r = new FunctionResult('t').connect('+1555', false, '+1666');
58
+ const act = (r.toDict().action as Record<string, unknown>[])[0];
59
+ expect(act['transfer']).toBe('false');
60
+ const swml = act['SWML'] as Record<string, unknown>;
61
+ const sections = swml['sections'] as Record<string, unknown[]>;
62
+ const main = sections['main'][0] as Record<string, Record<string, string>>;
63
+ expect(main['connect']['from']).toBe('+1666');
64
+ });
65
+
66
+ it('swmlTransfer', () => {
67
+ const r = new FunctionResult('ok').swmlTransfer('https://example.com', 'bye', false);
68
+ const act = (r.toDict().action as Record<string, unknown>[])[0];
69
+ expect(act['transfer']).toBe('false');
70
+ });
71
+
72
+ it('hangup / stop / hold', () => {
73
+ const r = new FunctionResult('bye').hangup().stop().hold(60);
74
+ const acts = r.toDict().action as Record<string, unknown>[];
75
+ expect(acts[0]).toEqual({ hangup: true });
76
+ expect(acts[1]).toEqual({ stop: true });
77
+ expect(acts[2]).toEqual({ hold: 60 });
78
+ });
79
+
80
+ it('hold clamps timeout', () => {
81
+ const r = new FunctionResult().hold(9999);
82
+ expect((r.toDict().action as Record<string, unknown>[])[0]).toEqual({ hold: 900 });
83
+ });
84
+
85
+ it('waitForUser variants', () => {
86
+ expect(new FunctionResult('w').waitForUser().toDict().action)
87
+ .toEqual([{ wait_for_user: true }]);
88
+ expect(new FunctionResult('w').waitForUser({ answerFirst: true }).toDict().action)
89
+ .toEqual([{ wait_for_user: 'answer_first' }]);
90
+ expect(new FunctionResult('w').waitForUser({ timeout: 10 }).toDict().action)
91
+ .toEqual([{ wait_for_user: 10 }]);
92
+ expect(new FunctionResult('w').waitForUser({ enabled: false }).toDict().action)
93
+ .toEqual([{ wait_for_user: false }]);
94
+ });
95
+
96
+ it('say / playBackgroundFile / stopBackgroundFile', () => {
97
+ const r = new FunctionResult('ok')
98
+ .say('hello')
99
+ .playBackgroundFile('music.mp3')
100
+ .playBackgroundFile('bg.mp3', true)
101
+ .stopBackgroundFile();
102
+ const acts = r.toDict().action as Record<string, unknown>[];
103
+ expect(acts[0]).toEqual({ say: 'hello' });
104
+ expect(acts[1]).toEqual({ playback_bg: 'music.mp3' });
105
+ expect(acts[2]).toEqual({ playback_bg: { file: 'bg.mp3', wait: true } });
106
+ expect(acts[3]).toEqual({ stop_playback_bg: true });
107
+ });
108
+
109
+ it('speech hints', () => {
110
+ const r = new FunctionResult('ok')
111
+ .addDynamicHints(['word1', { pattern: 'w', replace: 'W' }])
112
+ .clearDynamicHints()
113
+ .setEndOfSpeechTimeout(500)
114
+ .setSpeechEventTimeout(200);
115
+ const acts = r.toDict().action as Record<string, unknown>[];
116
+ expect(acts.length).toBe(4);
117
+ expect(acts[1]).toEqual({ clear_dynamic_hints: {} });
118
+ expect(acts[2]).toEqual({ end_of_speech_timeout: 500 });
119
+ expect(acts[3]).toEqual({ speech_event_timeout: 200 });
120
+ });
121
+
122
+ it('global data / metadata', () => {
123
+ const r = new FunctionResult('ok')
124
+ .updateGlobalData({ key: 'val' })
125
+ .removeGlobalData(['key'])
126
+ .setMetadata({ m: 1 })
127
+ .removeMetadata('m');
128
+ const acts = r.toDict().action as Record<string, unknown>[];
129
+ expect(acts[0]).toEqual({ set_global_data: { key: 'val' } });
130
+ expect(acts[1]).toEqual({ unset_global_data: ['key'] });
131
+ expect(acts[2]).toEqual({ set_meta_data: { m: 1 } });
132
+ expect(acts[3]).toEqual({ unset_meta_data: 'm' });
133
+ });
134
+
135
+ it('swmlChangeStep / swmlChangeContext', () => {
136
+ const r = new FunctionResult('ok').swmlChangeStep('step2').swmlChangeContext('ctx2');
137
+ const acts = r.toDict().action as Record<string, unknown>[];
138
+ expect(acts[0]).toEqual({ change_step: 'step2' });
139
+ expect(acts[1]).toEqual({ change_context: 'ctx2' });
140
+ });
141
+
142
+ it('swmlUserEvent', () => {
143
+ const r = new FunctionResult('ok').swmlUserEvent({ type: 'test', val: 1 });
144
+ const acts = r.toDict().action as Record<string, unknown>[];
145
+ expect(acts[0]).toEqual({
146
+ SWML: {
147
+ sections: { main: [{ user_event: { event: { type: 'test', val: 1 } } }] },
148
+ version: '1.0.0',
149
+ },
150
+ });
151
+ });
152
+
153
+ it('switchContext simple string', () => {
154
+ const r = new FunctionResult('ok').switchContext({ systemPrompt: 'new prompt' });
155
+ expect((r.toDict().action as Record<string, unknown>[])[0]).toEqual({
156
+ context_switch: 'new prompt',
157
+ });
158
+ });
159
+
160
+ it('switchContext advanced object', () => {
161
+ const r = new FunctionResult('ok').switchContext({
162
+ systemPrompt: 'sp',
163
+ userPrompt: 'up',
164
+ consolidate: true,
165
+ });
166
+ expect((r.toDict().action as Record<string, unknown>[])[0]).toEqual({
167
+ context_switch: { system_prompt: 'sp', user_prompt: 'up', consolidate: true },
168
+ });
169
+ });
170
+
171
+ it('toggleFunctions / enableFunctionsOnTimeout / updateSettings', () => {
172
+ const r = new FunctionResult('ok')
173
+ .toggleFunctions([{ function: 'fn1', active: false }])
174
+ .enableFunctionsOnTimeout()
175
+ .updateSettings({ temperature: 0.5 });
176
+ const acts = r.toDict().action as Record<string, unknown>[];
177
+ expect(acts[0]).toEqual({ toggle_functions: [{ function: 'fn1', active: false }] });
178
+ expect(acts[1]).toEqual({ functions_on_speaker_timeout: true });
179
+ expect(acts[2]).toEqual({ settings: { temperature: 0.5 } });
180
+ });
181
+
182
+ it('simulateUserInput / enableExtensiveData / replaceInHistory', () => {
183
+ const r = new FunctionResult('ok')
184
+ .simulateUserInput('hi')
185
+ .enableExtensiveData()
186
+ .replaceInHistory('replaced');
187
+ const acts = r.toDict().action as Record<string, unknown>[];
188
+ expect(acts[0]).toEqual({ user_input: 'hi' });
189
+ expect(acts[1]).toEqual({ extensive_data: true });
190
+ expect(acts[2]).toEqual({ replace_in_history: 'replaced' });
191
+ });
192
+
193
+ it('sendSms', () => {
194
+ const r = new FunctionResult('sent').sendSms({
195
+ toNumber: '+1555',
196
+ fromNumber: '+1666',
197
+ body: 'hi',
198
+ });
199
+ const acts = r.toDict().action as Record<string, unknown>[];
200
+ const swml = acts[0]['SWML'] as Record<string, unknown>;
201
+ expect(swml['version']).toBe('1.0.0');
202
+ });
203
+
204
+ it('sendSms throws without body or media', () => {
205
+ expect(() => {
206
+ new FunctionResult().sendSms({ toNumber: '+1', fromNumber: '+2' });
207
+ }).toThrow('Either body or media must be provided');
208
+ });
209
+
210
+ it('recordCall / stopRecordCall', () => {
211
+ const r = new FunctionResult('ok')
212
+ .recordCall({ format: 'mp3', stereo: true })
213
+ .stopRecordCall('ctrl1');
214
+ expect((r.toDict().action as unknown[]).length).toBe(2);
215
+ });
216
+
217
+ it('tap / stopTap', () => {
218
+ const r = new FunctionResult('ok')
219
+ .tap({ uri: 'wss://example.com' })
220
+ .stopTap();
221
+ expect((r.toDict().action as unknown[]).length).toBe(2);
222
+ });
223
+
224
+ it('joinRoom', () => {
225
+ const r = new FunctionResult('ok').joinRoom('room1');
226
+ const acts = r.toDict().action as Record<string, unknown>[];
227
+ const swml = acts[0]['SWML'] as Record<string, unknown>;
228
+ const sections = swml['sections'] as Record<string, unknown[]>;
229
+ expect((sections['main'][0] as Record<string, unknown>)['join_room']).toEqual({ name: 'room1' });
230
+ });
231
+
232
+ it('sipRefer', () => {
233
+ const r = new FunctionResult('ok').sipRefer('sip:user@example.com');
234
+ const acts = r.toDict().action as Record<string, unknown>[];
235
+ const swml = acts[0]['SWML'] as Record<string, unknown>;
236
+ const sections = swml['sections'] as Record<string, unknown[]>;
237
+ expect((sections['main'][0] as Record<string, unknown>)['sip_refer']).toEqual({ to_uri: 'sip:user@example.com' });
238
+ });
239
+
240
+ it('joinConference simple', () => {
241
+ const r = new FunctionResult('ok').joinConference('conf1');
242
+ const acts = r.toDict().action as Record<string, unknown>[];
243
+ const swml = acts[0]['SWML'] as Record<string, unknown>;
244
+ const sections = swml['sections'] as Record<string, unknown[]>;
245
+ expect((sections['main'][0] as Record<string, unknown>)['join_conference']).toBe('conf1');
246
+ });
247
+
248
+ it('joinConference with options', () => {
249
+ const r = new FunctionResult('ok').joinConference('conf1', { muted: true });
250
+ const acts = r.toDict().action as Record<string, unknown>[];
251
+ const swml = acts[0]['SWML'] as Record<string, unknown>;
252
+ const sections = swml['sections'] as Record<string, unknown[]>;
253
+ const params = (sections['main'][0] as Record<string, unknown>)['join_conference'] as Record<string, unknown>;
254
+ expect(params['name']).toBe('conf1');
255
+ expect(params['muted']).toBe(true);
256
+ });
257
+
258
+ it('executeRpc', () => {
259
+ const r = new FunctionResult('ok').executeRpc({
260
+ method: 'ai_message',
261
+ callId: 'call-1',
262
+ params: { role: 'system', message_text: 'hi' },
263
+ });
264
+ expect((r.toDict().action as unknown[]).length).toBe(1);
265
+ });
266
+
267
+ it('rpcDial / rpcAiMessage / rpcAiUnhold', () => {
268
+ const r = new FunctionResult('ok')
269
+ .rpcDial('+1555', '+1666', 'https://example.com/swml')
270
+ .rpcAiMessage('call-1', 'hello')
271
+ .rpcAiUnhold('call-1');
272
+ expect((r.toDict().action as unknown[]).length).toBe(3);
273
+ });
274
+
275
+ it('executeSwml with string', () => {
276
+ const swml = JSON.stringify({ version: '1.0.0', sections: { main: [] } });
277
+ const r = new FunctionResult('ok').executeSwml(swml, true);
278
+ const acts = r.toDict().action as Record<string, unknown>[];
279
+ const action = acts[0]['SWML'] as Record<string, unknown>;
280
+ expect(action['transfer']).toBe('true');
281
+ });
282
+
283
+ it('static payment helpers', () => {
284
+ const action = FunctionResult.createPaymentAction('Say', 'Enter card');
285
+ expect(action).toEqual({ type: 'Say', phrase: 'Enter card' });
286
+
287
+ const prompt = FunctionResult.createPaymentPrompt('payment-card-number', [action]);
288
+ expect(prompt['for']).toBe('payment-card-number');
289
+
290
+ const param = FunctionResult.createPaymentParameter('k', 'v');
291
+ expect(param).toEqual({ name: 'k', value: 'v' });
292
+ });
293
+
294
+ it('setPostProcess', () => {
295
+ const r = new FunctionResult('hi').setPostProcess(true).hangup();
296
+ expect(r.toDict().post_process).toBe(true);
297
+ });
298
+ });
@@ -0,0 +1,46 @@
1
+ /**
2
+ * Tests for AgentBase.setupGracefulShutdown().
3
+ */
4
+
5
+ import { AgentBase } from '../src/AgentBase.js';
6
+
7
+ describe('setupGracefulShutdown', () => {
8
+ const originalOn = process.on;
9
+ const registeredHandlers: { event: string; handler: Function }[] = [];
10
+
11
+ beforeEach(() => {
12
+ // Reset the static flag so tests are independent
13
+ (AgentBase as any)._shutdownRegistered = false;
14
+ registeredHandlers.length = 0;
15
+
16
+ // Mock process.on to capture registered handlers
17
+ process.on = vi.fn((event: string, handler: any) => {
18
+ registeredHandlers.push({ event, handler });
19
+ return process;
20
+ }) as any;
21
+ });
22
+
23
+ afterEach(() => {
24
+ process.on = originalOn;
25
+ });
26
+
27
+ it('registers SIGTERM and SIGINT handlers', () => {
28
+ AgentBase.setupGracefulShutdown();
29
+ const events = registeredHandlers.map((h) => h.event);
30
+ expect(events).toContain('SIGTERM');
31
+ expect(events).toContain('SIGINT');
32
+ });
33
+
34
+ it('does not register duplicate handlers on second call', () => {
35
+ AgentBase.setupGracefulShutdown();
36
+ const count1 = registeredHandlers.length;
37
+ AgentBase.setupGracefulShutdown();
38
+ expect(registeredHandlers.length).toBe(count1);
39
+ });
40
+
41
+ it('accepts custom timeout', () => {
42
+ // Just verifies it doesn't throw
43
+ AgentBase.setupGracefulShutdown({ timeout: 10000 });
44
+ expect(registeredHandlers.length).toBe(2);
45
+ });
46
+ });