@signalwire/sdk 2.0.1 → 2.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (610) hide show
  1. package/dist/AgentBase.d.ts +1045 -0
  2. package/dist/AgentBase.js +2375 -0
  3. package/dist/AgentBase.js.map +1 -0
  4. package/dist/AgentServer.d.ts +146 -0
  5. package/dist/AgentServer.js +388 -0
  6. package/dist/AgentServer.js.map +1 -0
  7. package/dist/AuthHandler.d.ts +127 -0
  8. package/dist/AuthHandler.js +212 -0
  9. package/dist/AuthHandler.js.map +1 -0
  10. package/dist/ConfigLoader.d.ts +170 -0
  11. package/dist/ConfigLoader.js +393 -0
  12. package/dist/ConfigLoader.js.map +1 -0
  13. package/dist/ContextBuilder.d.ts +652 -0
  14. package/dist/ContextBuilder.js +1115 -0
  15. package/dist/ContextBuilder.js.map +1 -0
  16. package/dist/DataMap.d.ts +271 -0
  17. package/dist/DataMap.js +430 -0
  18. package/dist/DataMap.js.map +1 -0
  19. package/dist/FunctionResult.d.ts +481 -0
  20. package/dist/FunctionResult.js +775 -0
  21. package/dist/FunctionResult.js.map +1 -0
  22. package/dist/Logger.d.ts +113 -0
  23. package/dist/Logger.js +320 -0
  24. package/dist/Logger.js.map +1 -0
  25. package/dist/PomBuilder.d.ts +208 -0
  26. package/dist/PomBuilder.js +409 -0
  27. package/dist/PomBuilder.js.map +1 -0
  28. package/dist/PromptManager.d.ts +85 -0
  29. package/dist/PromptManager.js +108 -0
  30. package/dist/PromptManager.js.map +1 -0
  31. package/dist/SWMLHandler.d.ts +159 -0
  32. package/dist/SWMLHandler.js +229 -0
  33. package/dist/SWMLHandler.js.map +1 -0
  34. package/dist/SWMLService.d.ts +326 -0
  35. package/dist/SWMLService.js +610 -0
  36. package/dist/SWMLService.js.map +1 -0
  37. package/dist/SchemaUtils.d.ts +108 -0
  38. package/dist/SchemaUtils.js +317 -0
  39. package/dist/SchemaUtils.js.map +1 -0
  40. package/dist/SecurityUtils.d.ts +60 -0
  41. package/{src/SecurityUtils.ts → dist/SecurityUtils.js} +82 -83
  42. package/dist/SecurityUtils.js.map +1 -0
  43. package/dist/ServerlessAdapter.d.ts +119 -0
  44. package/dist/ServerlessAdapter.js +188 -0
  45. package/dist/ServerlessAdapter.js.map +1 -0
  46. package/dist/SessionManager.d.ts +142 -0
  47. package/dist/SessionManager.js +260 -0
  48. package/dist/SessionManager.js.map +1 -0
  49. package/dist/SslConfig.d.ts +77 -0
  50. package/dist/SslConfig.js +100 -0
  51. package/dist/SslConfig.js.map +1 -0
  52. package/dist/SwaigFunction.d.ts +159 -0
  53. package/dist/SwaigFunction.js +209 -0
  54. package/dist/SwaigFunction.js.map +1 -0
  55. package/dist/SwmlBuilder.d.ts +165 -0
  56. package/dist/SwmlBuilder.js +247 -0
  57. package/dist/SwmlBuilder.js.map +1 -0
  58. package/dist/SwmlVerbMethods.generated.d.ts +254 -0
  59. package/dist/SwmlVerbMethods.generated.js +9 -0
  60. package/dist/SwmlVerbMethods.generated.js.map +1 -0
  61. package/dist/TypeInference.d.ts +71 -0
  62. package/dist/TypeInference.js +164 -0
  63. package/dist/TypeInference.js.map +1 -0
  64. package/dist/WebService.d.ts +148 -0
  65. package/dist/WebService.js +532 -0
  66. package/dist/WebService.js.map +1 -0
  67. package/dist/cli/agent-loader.d.ts +22 -0
  68. package/dist/cli/agent-loader.js +144 -0
  69. package/dist/cli/agent-loader.js.map +1 -0
  70. package/dist/cli/mock-data.d.ts +37 -0
  71. package/dist/cli/mock-data.js +80 -0
  72. package/dist/cli/mock-data.js.map +1 -0
  73. package/dist/cli/swaig-test.d.ts +32 -0
  74. package/dist/cli/swaig-test.js +418 -0
  75. package/dist/cli/swaig-test.js.map +1 -0
  76. package/dist/generateVerbTypes.d.ts +11 -0
  77. package/dist/generateVerbTypes.js +265 -0
  78. package/dist/generateVerbTypes.js.map +1 -0
  79. package/{src/index.ts → dist/index.d.ts} +13 -100
  80. package/dist/index.js +152 -0
  81. package/dist/index.js.map +1 -0
  82. package/dist/livewire/index.d.ts +653 -0
  83. package/dist/livewire/index.js +992 -0
  84. package/dist/livewire/index.js.map +1 -0
  85. package/dist/prefabs/ConciergeAgent.d.ts +89 -0
  86. package/dist/prefabs/ConciergeAgent.js +245 -0
  87. package/dist/prefabs/ConciergeAgent.js.map +1 -0
  88. package/dist/prefabs/FAQBotAgent.d.ts +113 -0
  89. package/dist/prefabs/FAQBotAgent.js +329 -0
  90. package/dist/prefabs/FAQBotAgent.js.map +1 -0
  91. package/dist/prefabs/InfoGathererAgent.d.ts +126 -0
  92. package/dist/prefabs/InfoGathererAgent.js +287 -0
  93. package/dist/prefabs/InfoGathererAgent.js.map +1 -0
  94. package/dist/prefabs/ReceptionistAgent.d.ts +104 -0
  95. package/dist/prefabs/ReceptionistAgent.js +303 -0
  96. package/dist/prefabs/ReceptionistAgent.js.map +1 -0
  97. package/dist/prefabs/SurveyAgent.d.ts +148 -0
  98. package/dist/prefabs/SurveyAgent.js +540 -0
  99. package/dist/prefabs/SurveyAgent.js.map +1 -0
  100. package/{src/prefabs/index.ts → dist/prefabs/index.d.ts} +1 -15
  101. package/dist/prefabs/index.js +14 -0
  102. package/dist/prefabs/index.js.map +1 -0
  103. package/dist/relay/Action.d.ts +258 -0
  104. package/dist/relay/Action.js +402 -0
  105. package/dist/relay/Action.js.map +1 -0
  106. package/dist/relay/Call.d.ts +697 -0
  107. package/dist/relay/Call.js +1062 -0
  108. package/dist/relay/Call.js.map +1 -0
  109. package/dist/relay/Deferred.d.ts +44 -0
  110. package/dist/relay/Deferred.js +69 -0
  111. package/dist/relay/Deferred.js.map +1 -0
  112. package/dist/relay/Message.d.ts +103 -0
  113. package/dist/relay/Message.js +169 -0
  114. package/dist/relay/Message.js.map +1 -0
  115. package/dist/relay/RelayClient.d.ts +302 -0
  116. package/dist/relay/RelayClient.js +1026 -0
  117. package/dist/relay/RelayClient.js.map +1 -0
  118. package/dist/relay/RelayError.d.ts +15 -0
  119. package/dist/relay/RelayError.js +20 -0
  120. package/dist/relay/RelayError.js.map +1 -0
  121. package/dist/relay/RelayEvent.d.ts +254 -0
  122. package/dist/relay/RelayEvent.js +509 -0
  123. package/dist/relay/RelayEvent.js.map +1 -0
  124. package/dist/relay/constants.d.ts +90 -0
  125. package/{src/relay/constants.ts → dist/relay/constants.js} +11 -29
  126. package/dist/relay/constants.js.map +1 -0
  127. package/dist/relay/index.d.ts +16 -0
  128. package/dist/relay/index.js +18 -0
  129. package/dist/relay/index.js.map +1 -0
  130. package/dist/relay/types.d.ts +142 -0
  131. package/dist/relay/types.js +5 -0
  132. package/dist/relay/types.js.map +1 -0
  133. package/dist/rest/HttpClient.d.ts +80 -0
  134. package/dist/rest/HttpClient.js +148 -0
  135. package/dist/rest/HttpClient.js.map +1 -0
  136. package/dist/rest/RestError.d.ts +30 -0
  137. package/dist/rest/RestError.js +39 -0
  138. package/dist/rest/RestError.js.map +1 -0
  139. package/dist/rest/base/BaseResource.d.ts +24 -0
  140. package/dist/rest/base/BaseResource.js +29 -0
  141. package/dist/rest/base/BaseResource.js.map +1 -0
  142. package/dist/rest/base/CrudResource.d.ts +68 -0
  143. package/dist/rest/base/CrudResource.js +82 -0
  144. package/dist/rest/base/CrudResource.js.map +1 -0
  145. package/dist/rest/base/CrudWithAddresses.d.ts +22 -0
  146. package/dist/rest/base/CrudWithAddresses.js +25 -0
  147. package/dist/rest/base/CrudWithAddresses.js.map +1 -0
  148. package/dist/rest/index.d.ts +131 -0
  149. package/{src/rest/index.ts → dist/rest/index.js} +101 -136
  150. package/dist/rest/index.js.map +1 -0
  151. package/dist/rest/namespaces/addresses.d.ts +46 -0
  152. package/dist/rest/namespaces/addresses.js +55 -0
  153. package/dist/rest/namespaces/addresses.js.map +1 -0
  154. package/dist/rest/namespaces/calling.d.ts +382 -0
  155. package/dist/rest/namespaces/calling.js +478 -0
  156. package/dist/rest/namespaces/calling.js.map +1 -0
  157. package/dist/rest/namespaces/chat.d.ts +22 -0
  158. package/dist/rest/namespaces/chat.js +26 -0
  159. package/dist/rest/namespaces/chat.js.map +1 -0
  160. package/dist/rest/namespaces/compat.d.ts +585 -0
  161. package/dist/rest/namespaces/compat.js +735 -0
  162. package/dist/rest/namespaces/compat.js.map +1 -0
  163. package/dist/rest/namespaces/datasphere.d.ts +66 -0
  164. package/dist/rest/namespaces/datasphere.js +77 -0
  165. package/dist/rest/namespaces/datasphere.js.map +1 -0
  166. package/dist/rest/namespaces/fabric.d.ts +282 -0
  167. package/dist/rest/namespaces/fabric.js +373 -0
  168. package/dist/rest/namespaces/fabric.js.map +1 -0
  169. package/dist/rest/namespaces/imported-numbers.d.ts +22 -0
  170. package/dist/rest/namespaces/imported-numbers.js +26 -0
  171. package/dist/rest/namespaces/imported-numbers.js.map +1 -0
  172. package/dist/rest/namespaces/logs.d.ts +105 -0
  173. package/dist/rest/namespaces/logs.js +133 -0
  174. package/dist/rest/namespaces/logs.js.map +1 -0
  175. package/dist/rest/namespaces/lookup.d.ts +29 -0
  176. package/dist/rest/namespaces/lookup.js +32 -0
  177. package/dist/rest/namespaces/lookup.js.map +1 -0
  178. package/dist/rest/namespaces/mfa.d.ts +46 -0
  179. package/dist/rest/namespaces/mfa.js +54 -0
  180. package/dist/rest/namespaces/mfa.js.map +1 -0
  181. package/dist/rest/namespaces/number-groups.d.ts +49 -0
  182. package/dist/rest/namespaces/number-groups.js +58 -0
  183. package/dist/rest/namespaces/number-groups.js.map +1 -0
  184. package/dist/rest/namespaces/phone-numbers.d.ts +60 -0
  185. package/dist/rest/namespaces/phone-numbers.js +67 -0
  186. package/dist/rest/namespaces/phone-numbers.js.map +1 -0
  187. package/dist/rest/namespaces/project.d.ts +46 -0
  188. package/dist/rest/namespaces/project.js +56 -0
  189. package/dist/rest/namespaces/project.js.map +1 -0
  190. package/dist/rest/namespaces/pubsub.d.ts +22 -0
  191. package/dist/rest/namespaces/pubsub.js +26 -0
  192. package/dist/rest/namespaces/pubsub.js.map +1 -0
  193. package/dist/rest/namespaces/queues.d.ts +42 -0
  194. package/dist/rest/namespaces/queues.js +49 -0
  195. package/dist/rest/namespaces/queues.js.map +1 -0
  196. package/dist/rest/namespaces/recordings.d.ts +38 -0
  197. package/dist/rest/namespaces/recordings.js +45 -0
  198. package/dist/rest/namespaces/recordings.js.map +1 -0
  199. package/dist/rest/namespaces/registry.d.ts +141 -0
  200. package/dist/rest/namespaces/registry.js +178 -0
  201. package/dist/rest/namespaces/registry.js.map +1 -0
  202. package/dist/rest/namespaces/short-codes.d.ts +39 -0
  203. package/dist/rest/namespaces/short-codes.js +46 -0
  204. package/dist/rest/namespaces/short-codes.js.map +1 -0
  205. package/dist/rest/namespaces/sip-profile.d.ts +28 -0
  206. package/dist/rest/namespaces/sip-profile.js +34 -0
  207. package/dist/rest/namespaces/sip-profile.js.map +1 -0
  208. package/dist/rest/namespaces/verified-callers.d.ts +33 -0
  209. package/dist/rest/namespaces/verified-callers.js +39 -0
  210. package/dist/rest/namespaces/verified-callers.js.map +1 -0
  211. package/dist/rest/namespaces/video.d.ts +235 -0
  212. package/dist/rest/namespaces/video.js +297 -0
  213. package/dist/rest/namespaces/video.js.map +1 -0
  214. package/{src/rest/pagination.ts → dist/rest/pagination.d.ts} +2 -61
  215. package/dist/rest/pagination.js +78 -0
  216. package/dist/rest/pagination.js.map +1 -0
  217. package/dist/rest/types.d.ts +54 -0
  218. package/dist/rest/types.js +5 -0
  219. package/dist/rest/types.js.map +1 -0
  220. package/dist/skills/SkillBase.d.ts +404 -0
  221. package/dist/skills/SkillBase.js +471 -0
  222. package/dist/skills/SkillBase.js.map +1 -0
  223. package/dist/skills/SkillManager.d.ts +195 -0
  224. package/dist/skills/SkillManager.js +378 -0
  225. package/dist/skills/SkillManager.js.map +1 -0
  226. package/dist/skills/SkillRegistry.d.ts +176 -0
  227. package/dist/skills/SkillRegistry.js +310 -0
  228. package/dist/skills/SkillRegistry.js.map +1 -0
  229. package/dist/skills/builtin/api_ninjas_trivia.d.ts +47 -0
  230. package/dist/skills/builtin/api_ninjas_trivia.js +211 -0
  231. package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -0
  232. package/dist/skills/builtin/ask_claude.d.ts +37 -0
  233. package/dist/skills/builtin/ask_claude.js +162 -0
  234. package/dist/skills/builtin/ask_claude.js.map +1 -0
  235. package/dist/skills/builtin/claude_skills.d.ts +75 -0
  236. package/dist/skills/builtin/claude_skills.js +753 -0
  237. package/dist/skills/builtin/claude_skills.js.map +1 -0
  238. package/dist/skills/builtin/custom_skills.d.ts +79 -0
  239. package/dist/skills/builtin/custom_skills.js +227 -0
  240. package/dist/skills/builtin/custom_skills.js.map +1 -0
  241. package/dist/skills/builtin/datasphere.d.ts +73 -0
  242. package/dist/skills/builtin/datasphere.js +350 -0
  243. package/dist/skills/builtin/datasphere.js.map +1 -0
  244. package/dist/skills/builtin/datasphere_serverless.d.ts +89 -0
  245. package/dist/skills/builtin/datasphere_serverless.js +291 -0
  246. package/dist/skills/builtin/datasphere_serverless.js.map +1 -0
  247. package/dist/skills/builtin/datetime.d.ts +40 -0
  248. package/dist/skills/builtin/datetime.js +118 -0
  249. package/dist/skills/builtin/datetime.js.map +1 -0
  250. package/dist/skills/builtin/google_maps.d.ts +48 -0
  251. package/dist/skills/builtin/google_maps.js +470 -0
  252. package/dist/skills/builtin/google_maps.js.map +1 -0
  253. package/dist/skills/builtin/index.d.ts +31 -0
  254. package/{src/skills/builtin/index.ts → dist/skills/builtin/index.js} +30 -36
  255. package/dist/skills/builtin/index.js.map +1 -0
  256. package/dist/skills/builtin/info_gatherer.d.ts +115 -0
  257. package/dist/skills/builtin/info_gatherer.js +328 -0
  258. package/dist/skills/builtin/info_gatherer.js.map +1 -0
  259. package/dist/skills/builtin/joke.d.ts +41 -0
  260. package/dist/skills/builtin/joke.js +156 -0
  261. package/dist/skills/builtin/joke.js.map +1 -0
  262. package/dist/skills/builtin/math.d.ts +39 -0
  263. package/dist/skills/builtin/math.js +119 -0
  264. package/dist/skills/builtin/math.js.map +1 -0
  265. package/dist/skills/builtin/mcp_gateway.d.ts +82 -0
  266. package/dist/skills/builtin/mcp_gateway.js +574 -0
  267. package/dist/skills/builtin/mcp_gateway.js.map +1 -0
  268. package/dist/skills/builtin/native_vector_search.d.ts +128 -0
  269. package/dist/skills/builtin/native_vector_search.js +752 -0
  270. package/dist/skills/builtin/native_vector_search.js.map +1 -0
  271. package/dist/skills/builtin/play_background_file.d.ts +59 -0
  272. package/dist/skills/builtin/play_background_file.js +274 -0
  273. package/dist/skills/builtin/play_background_file.js.map +1 -0
  274. package/dist/skills/builtin/spider.d.ts +91 -0
  275. package/dist/skills/builtin/spider.js +758 -0
  276. package/dist/skills/builtin/spider.js.map +1 -0
  277. package/dist/skills/builtin/swml_transfer.d.ts +66 -0
  278. package/dist/skills/builtin/swml_transfer.js +475 -0
  279. package/dist/skills/builtin/swml_transfer.js.map +1 -0
  280. package/dist/skills/builtin/weather_api.d.ts +59 -0
  281. package/dist/skills/builtin/weather_api.js +196 -0
  282. package/dist/skills/builtin/weather_api.js.map +1 -0
  283. package/dist/skills/builtin/web_search.d.ts +160 -0
  284. package/dist/skills/builtin/web_search.js +894 -0
  285. package/dist/skills/builtin/web_search.js.map +1 -0
  286. package/dist/skills/builtin/wikipedia_search.d.ts +77 -0
  287. package/dist/skills/builtin/wikipedia_search.js +241 -0
  288. package/dist/skills/builtin/wikipedia_search.js.map +1 -0
  289. package/{src/skills/index.ts → dist/skills/index.d.ts} +0 -1
  290. package/dist/skills/index.js +10 -0
  291. package/dist/skills/index.js.map +1 -0
  292. package/dist/types.d.ts +118 -0
  293. package/dist/types.js +5 -0
  294. package/dist/types.js.map +1 -0
  295. package/package.json +7 -1
  296. package/.github/workflows/publish.yml +0 -27
  297. package/.github/workflows/test.yml +0 -17
  298. package/CLAUDE.md +0 -112
  299. package/docs/MIGRATION-2.0.md +0 -81
  300. package/docs/agent-guide.md +0 -869
  301. package/docs/agent_guide.md +0 -1026
  302. package/docs/api-reference.md +0 -2420
  303. package/docs/api_reference.md +0 -1301
  304. package/docs/architecture.md +0 -843
  305. package/docs/cli-guide.md +0 -579
  306. package/docs/cli_guide.md +0 -448
  307. package/docs/cloud_functions_guide.md +0 -474
  308. package/docs/configuration.md +0 -422
  309. package/docs/contexts-guide.md +0 -787
  310. package/docs/contexts_guide.md +0 -511
  311. package/docs/datamap-guide.md +0 -1141
  312. package/docs/datamap_guide.md +0 -595
  313. package/docs/llm_parameters.md +0 -239
  314. package/docs/mcp_gateway_reference.md +0 -648
  315. package/docs/mcp_integration.md +0 -108
  316. package/docs/prefabs-guide.md +0 -800
  317. package/docs/sdk_features.md +0 -477
  318. package/docs/security.md +0 -436
  319. package/docs/serverless-guide.md +0 -513
  320. package/docs/skills-guide.md +0 -857
  321. package/docs/skills-system.md +0 -301
  322. package/docs/skills_parameter_schema.md +0 -392
  323. package/docs/skills_system.md +0 -467
  324. package/docs/swaig-reference.md +0 -1627
  325. package/docs/swaig_reference.md +0 -910
  326. package/docs/swml_service_guide.md +0 -600
  327. package/docs/third_party_skills.md +0 -533
  328. package/docs/web_service.md +0 -677
  329. package/examples/README.md +0 -131
  330. package/examples/advanced-datamap.ts +0 -100
  331. package/examples/advanced-dynamic-config.ts +0 -70
  332. package/examples/auto-vivified.ts +0 -94
  333. package/examples/call-flow.ts +0 -63
  334. package/examples/comprehensive-dynamic.ts +0 -125
  335. package/examples/contexts-steps.ts +0 -65
  336. package/examples/custom-path.ts +0 -45
  337. package/examples/datamap-tools.ts +0 -55
  338. package/examples/datasphere-multi-instance.ts +0 -63
  339. package/examples/datasphere-serverless-env.ts +0 -68
  340. package/examples/datasphere-webhook-env.ts +0 -66
  341. package/examples/datasphere.ts +0 -37
  342. package/examples/declarative.ts +0 -100
  343. package/examples/dynamic-config.ts +0 -54
  344. package/examples/dynamic-info-gatherer.ts +0 -69
  345. package/examples/dynamic-swml-service.ts +0 -67
  346. package/examples/gather-info.ts +0 -71
  347. package/examples/gather-per-question-functions-demo.ts +0 -140
  348. package/examples/joke-agent.ts +0 -34
  349. package/examples/kubernetes-agent.ts +0 -45
  350. package/examples/llm-params.ts +0 -69
  351. package/examples/mcp-agent.ts +0 -84
  352. package/examples/mcp-gateway.ts +0 -35
  353. package/examples/multi-agent.ts +0 -73
  354. package/examples/multi-endpoint.ts +0 -79
  355. package/examples/pom-prompt.ts +0 -71
  356. package/examples/prefab-concierge.ts +0 -47
  357. package/examples/prefab-faq.ts +0 -54
  358. package/examples/prefab-info-gatherer.ts +0 -33
  359. package/examples/prefab-receptionist.ts +0 -36
  360. package/examples/prefab-survey.ts +0 -68
  361. package/examples/record-call.ts +0 -67
  362. package/examples/relay-demo.ts +0 -33
  363. package/examples/room-and-sip.ts +0 -94
  364. package/examples/serverless-lambda.ts +0 -35
  365. package/examples/session-state.ts +0 -83
  366. package/examples/simple-agent.ts +0 -36
  367. package/examples/simple-static.ts +0 -29
  368. package/examples/skills-demo.ts +0 -38
  369. package/examples/step-function-inheritance-demo.ts +0 -124
  370. package/examples/swaig-features.ts +0 -187
  371. package/examples/swml-service-routing.ts +0 -66
  372. package/examples/swml-service.ts +0 -38
  373. package/examples/tap.ts +0 -68
  374. package/examples/verb-methods.ts +0 -45
  375. package/examples/web-search-multi-instance.ts +0 -72
  376. package/examples/web-search.ts +0 -38
  377. package/examples/wikipedia.ts +0 -36
  378. package/livewire/README.md +0 -140
  379. package/livewire/docs/migration-guide.md +0 -228
  380. package/livewire/examples/livewire-basic-agent.ts +0 -74
  381. package/livewire/examples/livewire-handoff.ts +0 -197
  382. package/livewire/examples/livewire-multi-tool.ts +0 -117
  383. package/relay/README.md +0 -70
  384. package/relay/RELAY_IMPLEMENTATION_GUIDE.md +0 -1257
  385. package/relay/docs/call-methods.md +0 -474
  386. package/relay/docs/client-reference.md +0 -142
  387. package/relay/docs/events.md +0 -134
  388. package/relay/docs/getting-started.md +0 -134
  389. package/relay/docs/guide.md +0 -306
  390. package/relay/docs/messaging.md +0 -182
  391. package/relay/examples/relay-inbound.ts +0 -66
  392. package/relay/examples/relay-messaging.ts +0 -71
  393. package/relay/examples/relay-outbound.ts +0 -76
  394. package/rest/README.md +0 -95
  395. package/rest/docs/calling.md +0 -273
  396. package/rest/docs/client-reference.md +0 -107
  397. package/rest/docs/compat.md +0 -204
  398. package/rest/docs/fabric.md +0 -183
  399. package/rest/docs/getting-started.md +0 -110
  400. package/rest/docs/guide.md +0 -351
  401. package/rest/docs/namespaces.md +0 -285
  402. package/rest/examples/rest-10dlc-registration.ts +0 -161
  403. package/rest/examples/rest-calling-ivr-and-ai.ts +0 -102
  404. package/rest/examples/rest-calling-play-and-record.ts +0 -91
  405. package/rest/examples/rest-client.ts +0 -65
  406. package/rest/examples/rest-compat-laml.ts +0 -210
  407. package/rest/examples/rest-datasphere-search.ts +0 -82
  408. package/rest/examples/rest-fabric-conferences-and-routing.ts +0 -144
  409. package/rest/examples/rest-fabric-subscribers-and-sip.ts +0 -108
  410. package/rest/examples/rest-fabric-swml-and-callflows.ts +0 -99
  411. package/rest/examples/rest-manage-resources.ts +0 -65
  412. package/rest/examples/rest-phone-number-management.ts +0 -197
  413. package/rest/examples/rest-queues-mfa-and-recordings.ts +0 -143
  414. package/rest/examples/rest-video-rooms.ts +0 -186
  415. package/src/AgentBase.ts +0 -2598
  416. package/src/AgentServer.ts +0 -442
  417. package/src/AuthHandler.ts +0 -256
  418. package/src/ConfigLoader.ts +0 -447
  419. package/src/ContextBuilder.ts +0 -1181
  420. package/src/DataMap.ts +0 -477
  421. package/src/FunctionResult.ts +0 -903
  422. package/src/Logger.ts +0 -337
  423. package/src/PomBuilder.ts +0 -467
  424. package/src/PromptManager.ts +0 -133
  425. package/src/SWMLHandler.ts +0 -298
  426. package/src/SWMLService.ts +0 -749
  427. package/src/SchemaUtils.ts +0 -361
  428. package/src/ServerlessAdapter.ts +0 -240
  429. package/src/SessionManager.ts +0 -311
  430. package/src/SslConfig.ts +0 -118
  431. package/src/SwaigFunction.ts +0 -276
  432. package/src/SwmlBuilder.ts +0 -283
  433. package/src/SwmlVerbMethods.generated.ts +0 -234
  434. package/src/TypeInference.ts +0 -199
  435. package/src/WebService.ts +0 -641
  436. package/src/cli/agent-loader.ts +0 -166
  437. package/src/cli/mock-data.ts +0 -111
  438. package/src/cli/swaig-test.ts +0 -452
  439. package/src/generateVerbTypes.ts +0 -322
  440. package/src/livewire/index.ts +0 -1252
  441. package/src/prefabs/ConciergeAgent.ts +0 -309
  442. package/src/prefabs/FAQBotAgent.ts +0 -415
  443. package/src/prefabs/InfoGathererAgent.ts +0 -379
  444. package/src/prefabs/ReceptionistAgent.ts +0 -395
  445. package/src/prefabs/SurveyAgent.ts +0 -671
  446. package/src/relay/Action.ts +0 -482
  447. package/src/relay/Call.ts +0 -1270
  448. package/src/relay/Deferred.ts +0 -94
  449. package/src/relay/Message.ts +0 -199
  450. package/src/relay/RelayClient.ts +0 -1185
  451. package/src/relay/RelayError.ts +0 -20
  452. package/src/relay/RelayEvent.ts +0 -944
  453. package/src/relay/index.ts +0 -123
  454. package/src/relay/types.ts +0 -149
  455. package/src/rest/HttpClient.ts +0 -164
  456. package/src/rest/RestError.ts +0 -45
  457. package/src/rest/base/BaseResource.ts +0 -32
  458. package/src/rest/base/CrudResource.ts +0 -98
  459. package/src/rest/base/CrudWithAddresses.ts +0 -37
  460. package/src/rest/namespaces/addresses.ts +0 -64
  461. package/src/rest/namespaces/calling.ts +0 -534
  462. package/src/rest/namespaces/chat.ts +0 -31
  463. package/src/rest/namespaces/compat.ts +0 -812
  464. package/src/rest/namespaces/datasphere.ts +0 -88
  465. package/src/rest/namespaces/fabric.ts +0 -417
  466. package/src/rest/namespaces/imported-numbers.ts +0 -31
  467. package/src/rest/namespaces/logs.ts +0 -151
  468. package/src/rest/namespaces/lookup.ts +0 -38
  469. package/src/rest/namespaces/mfa.ts +0 -61
  470. package/src/rest/namespaces/number-groups.ts +0 -68
  471. package/src/rest/namespaces/phone-numbers.ts +0 -76
  472. package/src/rest/namespaces/project.ts +0 -65
  473. package/src/rest/namespaces/pubsub.ts +0 -31
  474. package/src/rest/namespaces/queues.ts +0 -58
  475. package/src/rest/namespaces/recordings.ts +0 -53
  476. package/src/rest/namespaces/registry.ts +0 -200
  477. package/src/rest/namespaces/short-codes.ts +0 -54
  478. package/src/rest/namespaces/sip-profile.ts +0 -40
  479. package/src/rest/namespaces/verified-callers.ts +0 -46
  480. package/src/rest/namespaces/video.ts +0 -332
  481. package/src/rest/types.ts +0 -61
  482. package/src/skills/SkillBase.ts +0 -582
  483. package/src/skills/SkillManager.ts +0 -419
  484. package/src/skills/SkillRegistry.ts +0 -367
  485. package/src/skills/builtin/api_ninjas_trivia.ts +0 -285
  486. package/src/skills/builtin/ask_claude.ts +0 -246
  487. package/src/skills/builtin/claude_skills.ts +0 -983
  488. package/src/skills/builtin/custom_skills.ts +0 -327
  489. package/src/skills/builtin/datasphere.ts +0 -447
  490. package/src/skills/builtin/datasphere_serverless.ts +0 -347
  491. package/src/skills/builtin/datetime.ts +0 -137
  492. package/src/skills/builtin/google_maps.ts +0 -656
  493. package/src/skills/builtin/info_gatherer.ts +0 -415
  494. package/src/skills/builtin/joke.ts +0 -196
  495. package/src/skills/builtin/math.ts +0 -149
  496. package/src/skills/builtin/mcp_gateway.ts +0 -685
  497. package/src/skills/builtin/native_vector_search.ts +0 -910
  498. package/src/skills/builtin/play_background_file.ts +0 -367
  499. package/src/skills/builtin/spider.ts +0 -874
  500. package/src/skills/builtin/swml_transfer.ts +0 -645
  501. package/src/skills/builtin/weather_api.ts +0 -255
  502. package/src/skills/builtin/web_search.ts +0 -1083
  503. package/src/skills/builtin/wikipedia_search.ts +0 -304
  504. package/src/types.ts +0 -132
  505. package/tests/AgentBase.test.ts +0 -1093
  506. package/tests/AgentServer.test.ts +0 -126
  507. package/tests/AuthHandler.test.ts +0 -133
  508. package/tests/ConfigLoader.test.ts +0 -151
  509. package/tests/ContextBuilder.test.ts +0 -108
  510. package/tests/DataMap.test.ts +0 -367
  511. package/tests/EphemeralSkillCopy.test.ts +0 -107
  512. package/tests/FunctionResult.test.ts +0 -298
  513. package/tests/GracefulShutdown.test.ts +0 -46
  514. package/tests/Logger.test.ts +0 -420
  515. package/tests/PomBuilder.test.ts +0 -228
  516. package/tests/ProxyDetection.test.ts +0 -228
  517. package/tests/SWMLService.test.ts +0 -320
  518. package/tests/SWMLVerbHandler.test.ts +0 -523
  519. package/tests/SchemaUtils.test.ts +0 -106
  520. package/tests/SchemaUtils.verb.test.ts +0 -206
  521. package/tests/SecurityUtils.test.ts +0 -192
  522. package/tests/ServerlessAdapter.test.ts +0 -222
  523. package/tests/SessionManager.test.ts +0 -257
  524. package/tests/SkillBaseFeatures.test.ts +0 -130
  525. package/tests/SkillMultiInstance.test.ts +0 -102
  526. package/tests/SkillParameterSchemas.test.ts +0 -134
  527. package/tests/SkillRegistrySchema.test.ts +0 -84
  528. package/tests/SslConfig.test.ts +0 -97
  529. package/tests/SwmlBuilder.test.ts +0 -400
  530. package/tests/TypeInference.test.ts +0 -165
  531. package/tests/VerbHandlerRegistry.test.ts +0 -128
  532. package/tests/cli/mock-data.test.ts +0 -113
  533. package/tests/cli/swaig-test.test.ts +0 -108
  534. package/tests/examples.test.ts +0 -194
  535. package/tests/fixtures/scrape-parity/README.md +0 -53
  536. package/tests/fixtures/scrape-parity/expected/01_simple_article.json +0 -5
  537. package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +0 -5
  538. package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +0 -5
  539. package/tests/fixtures/scrape-parity/expected/04_bare_body.json +0 -5
  540. package/tests/fixtures/scrape-parity/expected/05_malformed.json +0 -5
  541. package/tests/fixtures/scrape-parity/expected/06_multi_class.json +0 -5
  542. package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +0 -5
  543. package/tests/fixtures/scrape-parity/expected/08_inline_script.json +0 -5
  544. package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +0 -5
  545. package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +0 -5
  546. package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +0 -5
  547. package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +0 -5
  548. package/tests/fixtures/scrape-parity/html/01_simple_article.html +0 -18
  549. package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +0 -18
  550. package/tests/fixtures/scrape-parity/html/03_nested_containers.html +0 -13
  551. package/tests/fixtures/scrape-parity/html/04_bare_body.html +0 -9
  552. package/tests/fixtures/scrape-parity/html/05_malformed.html +0 -11
  553. package/tests/fixtures/scrape-parity/html/06_multi_class.html +0 -18
  554. package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +0 -12
  555. package/tests/fixtures/scrape-parity/html/08_inline_script.html +0 -17
  556. package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +0 -21
  557. package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +0 -10
  558. package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +0 -13
  559. package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +0 -24
  560. package/tests/fixtures/scrape-parity/python_extract.py +0 -109
  561. package/tests/livewire/livewire.test.ts +0 -780
  562. package/tests/mcp.test.ts +0 -221
  563. package/tests/prefabs/prefabs.test.ts +0 -1093
  564. package/tests/relay/Action.test.ts +0 -392
  565. package/tests/relay/Call.test.ts +0 -535
  566. package/tests/relay/Deferred.test.ts +0 -71
  567. package/tests/relay/Message.test.ts +0 -164
  568. package/tests/relay/RelayClient.test.ts +0 -779
  569. package/tests/relay/RelayEvent.test.ts +0 -463
  570. package/tests/relay/helpers.ts +0 -79
  571. package/tests/rest/HttpClient.test.ts +0 -274
  572. package/tests/rest/RestError.test.ts +0 -53
  573. package/tests/rest/calling.test.ts +0 -156
  574. package/tests/rest/client.test.ts +0 -197
  575. package/tests/rest/compat.test.ts +0 -335
  576. package/tests/rest/datasphere.test.ts +0 -71
  577. package/tests/rest/fabric.test.ts +0 -186
  578. package/tests/rest/helpers.ts +0 -95
  579. package/tests/rest/logs.test.ts +0 -68
  580. package/tests/rest/pagination.test.ts +0 -133
  581. package/tests/rest/registry.test.ts +0 -94
  582. package/tests/rest/relay-rest.test.ts +0 -290
  583. package/tests/rest/video.test.ts +0 -173
  584. package/tests/setup.ts +0 -6
  585. package/tests/skills/SkillBase.test.ts +0 -108
  586. package/tests/skills/SkillManager.test.ts +0 -268
  587. package/tests/skills/SkillRegistry.test.ts +0 -176
  588. package/tests/skills/builtin.test.ts +0 -1472
  589. package/tests/skills/claude-skills.test.ts +0 -54
  590. package/tests/skills/custom-skills.test.ts +0 -53
  591. package/tests/skills/datasphere-serverless.test.ts +0 -70
  592. package/tests/skills/datasphere.test.ts +0 -107
  593. package/tests/skills/datetime.test.ts +0 -101
  594. package/tests/skills/google-maps.test.ts +0 -78
  595. package/tests/skills/info-gatherer.test.ts +0 -411
  596. package/tests/skills/joke.test.ts +0 -81
  597. package/tests/skills/math.test.ts +0 -68
  598. package/tests/skills/mcp-gateway.test.ts +0 -101
  599. package/tests/skills/play-background.test.ts +0 -54
  600. package/tests/skills/spider.test.ts +0 -108
  601. package/tests/skills/swml-transfer.test.ts +0 -178
  602. package/tests/skills/trivia.test.ts +0 -54
  603. package/tests/skills/vector-search.test.ts +0 -135
  604. package/tests/skills/weather-api.test.ts +0 -77
  605. package/tests/skills/web-search-parity.test.ts +0 -59
  606. package/tests/skills/web-search.test.ts +0 -103
  607. package/tests/skills/wikipedia.test.ts +0 -63
  608. package/tsconfig.json +0 -18
  609. package/vitest.config.ts +0 -9
  610. /package/{src → dist}/schema.json +0 -0
@@ -0,0 +1,775 @@
1
+ /**
2
+ * FunctionResult - Builder for SWAIG function responses.
3
+ *
4
+ * Carries response text and a list of structured actions (connect, hangup, SMS, etc.).
5
+ * Every mutating method returns `this` for fluent chaining.
6
+ */
7
+ /**
8
+ * Builder for SWAIG function responses.
9
+ *
10
+ * Carries response text (what the AI says to the caller) and a list of structured
11
+ * actions (connect, hangup, SMS, record, transfer, etc.) that the SignalWire platform
12
+ * executes after the AI speaks. Every mutating method returns `this` for fluent chaining.
13
+ *
14
+ * Return an instance (or a promise that resolves to one) from any SWAIG tool handler.
15
+ *
16
+ * @example Simple text response
17
+ * ```ts
18
+ * agent.defineTool({
19
+ * name: 'say_hi',
20
+ * description: 'Say hello.',
21
+ * parameters: { type: 'object', properties: {} },
22
+ * handler: () => new FunctionResult('Hello there!'),
23
+ * });
24
+ * ```
25
+ *
26
+ * @example Response plus a call-control action
27
+ * ```ts
28
+ * agent.defineTool({
29
+ * name: 'transfer_to_sales',
30
+ * description: 'Forward the caller to sales.',
31
+ * parameters: { type: 'object', properties: {} },
32
+ * handler: () =>
33
+ * new FunctionResult('Connecting you to sales now.').connect('+15551112222'),
34
+ * });
35
+ * ```
36
+ *
37
+ * @example Chained actions
38
+ * ```ts
39
+ * new FunctionResult("Thanks, you're all set.")
40
+ * .sendSms({ toNumber: '+15551234567', fromNumber: '+15559998888', body: 'Confirmation!' })
41
+ * .hangup();
42
+ * ```
43
+ *
44
+ * @see {@link AgentBase.defineTool} — where handlers return a `FunctionResult`
45
+ * @see {@link DataMap} — alternative for purely data-driven (no handler) tools
46
+ */
47
+ export class FunctionResult {
48
+ /** The text response returned to the AI agent. */
49
+ response;
50
+ /** Ordered list of actions to execute after the response. */
51
+ action;
52
+ /** Whether actions should be post-processed after the AI responds. */
53
+ postProcess;
54
+ /**
55
+ * @param response - Initial response text; defaults to empty string.
56
+ * @param postProcess - Whether to enable post-processing of actions.
57
+ */
58
+ constructor(response, postProcess = false) {
59
+ this.response = response ?? '';
60
+ this.action = [];
61
+ this.postProcess = postProcess;
62
+ }
63
+ // ── Core ────────────────────────────────────────────────────────────
64
+ /**
65
+ * Set the response text returned to the AI agent.
66
+ * @param response - The response text.
67
+ * @returns This instance for chaining.
68
+ */
69
+ setResponse(response) {
70
+ this.response = response;
71
+ return this;
72
+ }
73
+ /**
74
+ * Enable or disable post-processing of actions.
75
+ * @param postProcess - Whether to post-process actions.
76
+ * @returns This instance for chaining.
77
+ */
78
+ setPostProcess(postProcess) {
79
+ this.postProcess = postProcess;
80
+ return this;
81
+ }
82
+ /**
83
+ * Append a single named action to the action list.
84
+ * @param name - The action name (e.g., "hangup", "say").
85
+ * @param data - The action payload.
86
+ * @returns This instance for chaining.
87
+ */
88
+ addAction(name, data) {
89
+ this.action.push({ [name]: data });
90
+ return this;
91
+ }
92
+ /**
93
+ * Append multiple action objects to the action list.
94
+ * @param actions - Array of action objects to append.
95
+ * @returns This instance for chaining.
96
+ */
97
+ addActions(actions) {
98
+ this.action.push(...actions);
99
+ return this;
100
+ }
101
+ // ── Call control ────────────────────────────────────────────────────
102
+ /**
103
+ * Connect the call to another destination via SWML transfer.
104
+ * @param destination - The destination address (phone number or SIP URI).
105
+ * @param final - Whether this is a final transfer that ends the AI session.
106
+ * @param fromAddr - Optional caller ID to use for the outbound leg.
107
+ * @returns This instance for chaining.
108
+ */
109
+ connect(destination, final = true, fromAddr) {
110
+ const connectParams = { to: destination };
111
+ if (fromAddr !== undefined) {
112
+ connectParams['from'] = fromAddr;
113
+ }
114
+ this.action.push({
115
+ SWML: {
116
+ sections: { main: [{ connect: connectParams }] },
117
+ version: '1.0.0',
118
+ },
119
+ transfer: String(final),
120
+ });
121
+ return this;
122
+ }
123
+ /**
124
+ * Transfer the call to a SWML destination with a custom AI response.
125
+ * @param dest - The transfer destination.
126
+ * @param aiResponse - The AI response text to set before transferring.
127
+ * @param final - Whether this is a final transfer.
128
+ * @returns This instance for chaining.
129
+ */
130
+ swmlTransfer(dest, aiResponse, final = true) {
131
+ this.action.push({
132
+ SWML: {
133
+ version: '1.0.0',
134
+ sections: {
135
+ main: [
136
+ { set: { ai_response: aiResponse } },
137
+ { transfer: { dest } },
138
+ ],
139
+ },
140
+ },
141
+ transfer: String(final),
142
+ });
143
+ return this;
144
+ }
145
+ /**
146
+ * Hang up the call.
147
+ * @returns This instance for chaining.
148
+ */
149
+ hangup() {
150
+ return this.addAction('hangup', true);
151
+ }
152
+ /**
153
+ * Place the call on hold for a specified duration.
154
+ * @param timeout - Hold duration in seconds, clamped to 0-900.
155
+ * @returns This instance for chaining.
156
+ */
157
+ hold(timeout = 300) {
158
+ return this.addAction('hold', Math.max(0, Math.min(timeout, 900)));
159
+ }
160
+ /**
161
+ * Wait for user input before continuing.
162
+ * @param opts - Options controlling wait behavior: enable/disable, timeout, or answer-first mode.
163
+ * @returns This instance for chaining.
164
+ */
165
+ waitForUser(opts) {
166
+ let value = true;
167
+ if (opts?.answerFirst) {
168
+ value = 'answer_first';
169
+ }
170
+ else if (opts?.timeout !== undefined) {
171
+ value = opts.timeout;
172
+ }
173
+ else if (opts?.enabled !== undefined) {
174
+ value = opts.enabled;
175
+ }
176
+ return this.addAction('wait_for_user', value);
177
+ }
178
+ /**
179
+ * Stop the AI session.
180
+ * @returns This instance for chaining.
181
+ */
182
+ stop() {
183
+ return this.addAction('stop', true);
184
+ }
185
+ // ── Audio ───────────────────────────────────────────────────────────
186
+ /**
187
+ * Speak text to the caller via TTS.
188
+ * @param text - The text to speak.
189
+ * @returns This instance for chaining.
190
+ */
191
+ say(text) {
192
+ return this.addAction('say', text);
193
+ }
194
+ /**
195
+ * Play an audio file in the background during the call.
196
+ * @param filename - URL or path of the audio file.
197
+ * @param wait - Whether to wait for playback to complete before continuing.
198
+ * @returns This instance for chaining.
199
+ */
200
+ playBackgroundFile(filename, wait = false) {
201
+ if (wait) {
202
+ return this.addAction('playback_bg', { file: filename, wait: true });
203
+ }
204
+ return this.addAction('playback_bg', filename);
205
+ }
206
+ /**
207
+ * Stop any currently playing background audio file.
208
+ * @returns This instance for chaining.
209
+ */
210
+ stopBackgroundFile() {
211
+ return this.addAction('stop_playback_bg', true);
212
+ }
213
+ // ── Speech ──────────────────────────────────────────────────────────
214
+ /**
215
+ * Add dynamic speech recognition hints to improve transcription accuracy.
216
+ * @param hints - Array of hint strings or pattern-replacement objects.
217
+ * @returns This instance for chaining.
218
+ */
219
+ addDynamicHints(hints) {
220
+ return this.addAction('add_dynamic_hints', hints);
221
+ }
222
+ /**
223
+ * Remove all previously added dynamic speech hints.
224
+ * @returns This instance for chaining.
225
+ */
226
+ clearDynamicHints() {
227
+ this.action.push({ clear_dynamic_hints: {} });
228
+ return this;
229
+ }
230
+ /**
231
+ * Set the silence duration that marks the end of a user's speech.
232
+ * @param milliseconds - Timeout in milliseconds.
233
+ * @returns This instance for chaining.
234
+ */
235
+ setEndOfSpeechTimeout(milliseconds) {
236
+ return this.addAction('end_of_speech_timeout', milliseconds);
237
+ }
238
+ /**
239
+ * Set the timeout for speech event detection.
240
+ * @param milliseconds - Timeout in milliseconds.
241
+ * @returns This instance for chaining.
242
+ */
243
+ setSpeechEventTimeout(milliseconds) {
244
+ return this.addAction('speech_event_timeout', milliseconds);
245
+ }
246
+ // ── Data ────────────────────────────────────────────────────────────
247
+ /**
248
+ * Merge key-value pairs into the global data store shared across functions.
249
+ * @param data - Key-value pairs to set or update.
250
+ * @returns This instance for chaining.
251
+ */
252
+ updateGlobalData(data) {
253
+ return this.addAction('set_global_data', data);
254
+ }
255
+ /**
256
+ * Remove keys from the global data store.
257
+ * @param keys - A single key or array of keys to remove.
258
+ * @returns This instance for chaining.
259
+ */
260
+ removeGlobalData(keys) {
261
+ return this.addAction('unset_global_data', keys);
262
+ }
263
+ /**
264
+ * Set metadata key-value pairs on the current call.
265
+ * @param data - Metadata key-value pairs to set.
266
+ * @returns This instance for chaining.
267
+ */
268
+ setMetadata(data) {
269
+ return this.addAction('set_meta_data', data);
270
+ }
271
+ /**
272
+ * Remove metadata keys from the current call.
273
+ * @param keys - A single key or array of keys to remove.
274
+ * @returns This instance for chaining.
275
+ */
276
+ removeMetadata(keys) {
277
+ return this.addAction('unset_meta_data', keys);
278
+ }
279
+ // ── SWML helpers ────────────────────────────────────────────────────
280
+ /**
281
+ * Execute arbitrary SWML content as an action.
282
+ * @param swmlContent - SWML as a JSON string or object.
283
+ * @param transfer - Whether this SWML execution should transfer the call.
284
+ * @returns This instance for chaining.
285
+ */
286
+ executeSwml(swmlContent, transfer = false) {
287
+ let swmlData;
288
+ if (typeof swmlContent === 'string') {
289
+ try {
290
+ swmlData = JSON.parse(swmlContent);
291
+ }
292
+ catch {
293
+ swmlData = { raw_swml: swmlContent };
294
+ }
295
+ }
296
+ else if (typeof swmlContent.toDict === 'function') {
297
+ swmlData = swmlContent.toDict();
298
+ }
299
+ else {
300
+ swmlData = { ...swmlContent };
301
+ }
302
+ if (transfer) {
303
+ swmlData['transfer'] = 'true';
304
+ }
305
+ return this.addAction('SWML', swmlData);
306
+ }
307
+ /**
308
+ * Change the current SWML step.
309
+ * @param stepName - The name of the step to switch to.
310
+ * @returns This instance for chaining.
311
+ */
312
+ swmlChangeStep(stepName) {
313
+ return this.addAction('change_step', stepName);
314
+ }
315
+ /**
316
+ * Change the current SWML context.
317
+ * @param contextName - The name of the context to switch to.
318
+ * @returns This instance for chaining.
319
+ */
320
+ swmlChangeContext(contextName) {
321
+ return this.addAction('change_context', contextName);
322
+ }
323
+ /**
324
+ * Emit a custom user event via SWML.
325
+ * @param eventData - The event payload.
326
+ * @returns This instance for chaining.
327
+ */
328
+ swmlUserEvent(eventData) {
329
+ return this.addAction('SWML', {
330
+ sections: { main: [{ user_event: { event: eventData } }] },
331
+ version: '1.0.0',
332
+ });
333
+ }
334
+ /**
335
+ * Switch the AI context with optional new prompts and reset options.
336
+ * @param opts - Context switch options including system/user prompts and reset flags.
337
+ * @returns This instance for chaining.
338
+ */
339
+ switchContext(opts) {
340
+ const sp = opts?.systemPrompt;
341
+ const up = opts?.userPrompt;
342
+ const cons = opts?.consolidate;
343
+ const fr = opts?.fullReset;
344
+ if (sp && !up && !cons && !fr) {
345
+ return this.addAction('context_switch', sp);
346
+ }
347
+ const data = {};
348
+ if (sp)
349
+ data['system_prompt'] = sp;
350
+ if (up)
351
+ data['user_prompt'] = up;
352
+ if (cons)
353
+ data['consolidate'] = true;
354
+ if (fr)
355
+ data['full_reset'] = true;
356
+ return this.addAction('context_switch', data);
357
+ }
358
+ // ── Functions ───────────────────────────────────────────────────────
359
+ /**
360
+ * Enable or disable SWAIG functions by name.
361
+ * @param toggles - Array of function name and active state pairs.
362
+ * @returns This instance for chaining.
363
+ */
364
+ toggleFunctions(toggles) {
365
+ return this.addAction('toggle_functions', toggles);
366
+ }
367
+ /**
368
+ * Control whether functions fire on speaker timeout.
369
+ * @param enabled - Whether to enable function execution on timeout.
370
+ * @returns This instance for chaining.
371
+ */
372
+ enableFunctionsOnTimeout(enabled = true) {
373
+ return this.addAction('functions_on_speaker_timeout', enabled);
374
+ }
375
+ /**
376
+ * Update AI engine settings at runtime.
377
+ * @param settings - Key-value pairs of settings to update.
378
+ * @returns This instance for chaining.
379
+ */
380
+ updateSettings(settings) {
381
+ return this.addAction('settings', settings);
382
+ }
383
+ // ── User input / history ────────────────────────────────────────────
384
+ /**
385
+ * Inject text as if the user had spoken it.
386
+ * @param text - The simulated user input text.
387
+ * @returns This instance for chaining.
388
+ */
389
+ simulateUserInput(text) {
390
+ return this.addAction('user_input', text);
391
+ }
392
+ /**
393
+ * Enable or disable extensive data reporting in function calls.
394
+ * @param enabled - Whether to enable extensive data.
395
+ * @returns This instance for chaining.
396
+ */
397
+ enableExtensiveData(enabled = true) {
398
+ return this.addAction('extensive_data', enabled);
399
+ }
400
+ /**
401
+ * Replace the function call output in conversation history.
402
+ * @param text - Replacement text, or true to replace with the response.
403
+ * @returns This instance for chaining.
404
+ */
405
+ replaceInHistory(text = true) {
406
+ return this.addAction('replace_in_history', text);
407
+ }
408
+ // ── Comms ───────────────────────────────────────────────────────────
409
+ /**
410
+ * Send an SMS or MMS message from within the call flow.
411
+ *
412
+ * @param opts - SMS parameters. Must include either `body` (text SMS) or
413
+ * `media` (MMS) — supplying neither throws.
414
+ * @returns This instance for chaining.
415
+ * @throws {Error} When neither `body` nor `media` is provided.
416
+ */
417
+ sendSms(opts) {
418
+ if (!opts.body && !opts.media) {
419
+ throw new Error('Either body or media must be provided');
420
+ }
421
+ const smsParams = {
422
+ to_number: opts.toNumber,
423
+ from_number: opts.fromNumber,
424
+ };
425
+ if (opts.body)
426
+ smsParams['body'] = opts.body;
427
+ if (opts.media)
428
+ smsParams['media'] = opts.media;
429
+ if (opts.tags)
430
+ smsParams['tags'] = opts.tags;
431
+ if (opts.region)
432
+ smsParams['region'] = opts.region;
433
+ return this.executeSwml({
434
+ version: '1.0.0',
435
+ sections: { main: [{ send_sms: smsParams }] },
436
+ });
437
+ }
438
+ /**
439
+ * Start recording the call.
440
+ * @param opts - Recording options including format, direction, and timeouts.
441
+ * @returns This instance for chaining.
442
+ */
443
+ recordCall(opts) {
444
+ const format = opts?.format ?? 'wav';
445
+ const direction = opts?.direction ?? 'both';
446
+ const params = {
447
+ stereo: opts?.stereo ?? false,
448
+ format,
449
+ direction,
450
+ beep: opts?.beep ?? false,
451
+ input_sensitivity: opts?.inputSensitivity ?? 44.0,
452
+ };
453
+ if (opts?.controlId)
454
+ params['control_id'] = opts.controlId;
455
+ if (opts?.terminators)
456
+ params['terminators'] = opts.terminators;
457
+ if (opts?.initialTimeout !== undefined)
458
+ params['initial_timeout'] = opts.initialTimeout;
459
+ if (opts?.endSilenceTimeout !== undefined)
460
+ params['end_silence_timeout'] = opts.endSilenceTimeout;
461
+ if (opts?.maxLength !== undefined)
462
+ params['max_length'] = opts.maxLength;
463
+ if (opts?.statusUrl)
464
+ params['status_url'] = opts.statusUrl;
465
+ return this.executeSwml({
466
+ version: '1.0.0',
467
+ sections: { main: [{ record_call: params }] },
468
+ });
469
+ }
470
+ /**
471
+ * Stop an active call recording.
472
+ * @param controlId - Optional control ID of the recording to stop.
473
+ * @returns This instance for chaining.
474
+ */
475
+ stopRecordCall(controlId) {
476
+ const params = {};
477
+ if (controlId)
478
+ params['control_id'] = controlId;
479
+ return this.executeSwml({
480
+ version: '1.0.0',
481
+ sections: { main: [{ stop_record_call: params }] },
482
+ });
483
+ }
484
+ /**
485
+ * Start a media tap to stream audio to an external URI.
486
+ * @param opts - Tap parameters including URI, direction, and codec.
487
+ * @returns This instance for chaining.
488
+ */
489
+ tap(opts) {
490
+ const params = { uri: opts.uri };
491
+ if (opts.controlId)
492
+ params['control_id'] = opts.controlId;
493
+ if (opts.direction && opts.direction !== 'both')
494
+ params['direction'] = opts.direction;
495
+ if (opts.codec && opts.codec !== 'PCMU')
496
+ params['codec'] = opts.codec;
497
+ if (opts.rtpPtime && opts.rtpPtime !== 20)
498
+ params['rtp_ptime'] = opts.rtpPtime;
499
+ if (opts.statusUrl)
500
+ params['status_url'] = opts.statusUrl;
501
+ return this.executeSwml({
502
+ version: '1.0.0',
503
+ sections: { main: [{ tap: params }] },
504
+ });
505
+ }
506
+ /**
507
+ * Stop an active media tap.
508
+ * @param controlId - Optional control ID of the tap to stop.
509
+ * @returns This instance for chaining.
510
+ */
511
+ stopTap(controlId) {
512
+ const params = {};
513
+ if (controlId)
514
+ params['control_id'] = controlId;
515
+ return this.executeSwml({
516
+ version: '1.0.0',
517
+ sections: { main: [{ stop_tap: params }] },
518
+ });
519
+ }
520
+ // ── Rooms / Conferences ─────────────────────────────────────────────
521
+ /**
522
+ * Join a SignalWire room.
523
+ * @param name - The room name to join.
524
+ * @returns This instance for chaining.
525
+ */
526
+ joinRoom(name) {
527
+ return this.executeSwml({
528
+ version: '1.0.0',
529
+ sections: { main: [{ join_room: { name } }] },
530
+ });
531
+ }
532
+ /**
533
+ * Send a SIP REFER to transfer the call.
534
+ * @param toUri - The SIP URI to refer the call to.
535
+ * @returns This instance for chaining.
536
+ */
537
+ sipRefer(toUri) {
538
+ return this.executeSwml({
539
+ version: '1.0.0',
540
+ sections: { main: [{ sip_refer: { to_uri: toUri } }] },
541
+ });
542
+ }
543
+ /**
544
+ * Join a conference by name with optional configuration.
545
+ * @param name - The conference name to join.
546
+ * @param opts - Optional conference settings such as mute, recording, and callbacks.
547
+ * @returns This instance for chaining.
548
+ */
549
+ joinConference(name, opts) {
550
+ const hasNonDefaults = opts && (opts.muted || (opts.beep && opts.beep !== 'true') ||
551
+ opts.startOnEnter === false || opts.endOnExit ||
552
+ opts.waitUrl || (opts.maxParticipants && opts.maxParticipants !== 250) ||
553
+ (opts.record && opts.record !== 'do-not-record') || opts.region ||
554
+ (opts.trim && opts.trim !== 'trim-silence') || opts.coach ||
555
+ opts.statusCallbackEvent || opts.statusCallback ||
556
+ (opts.statusCallbackMethod && opts.statusCallbackMethod !== 'POST') ||
557
+ opts.recordingStatusCallback ||
558
+ (opts.recordingStatusCallbackMethod && opts.recordingStatusCallbackMethod !== 'POST') ||
559
+ (opts.recordingStatusCallbackEvent && opts.recordingStatusCallbackEvent !== 'completed') ||
560
+ opts.result !== undefined);
561
+ let joinParams;
562
+ if (!hasNonDefaults) {
563
+ joinParams = name;
564
+ }
565
+ else {
566
+ const p = { name };
567
+ if (opts.muted)
568
+ p['muted'] = opts.muted;
569
+ if (opts.beep && opts.beep !== 'true')
570
+ p['beep'] = opts.beep;
571
+ if (opts.startOnEnter === false)
572
+ p['start_on_enter'] = false;
573
+ if (opts.endOnExit)
574
+ p['end_on_exit'] = opts.endOnExit;
575
+ if (opts.waitUrl)
576
+ p['wait_url'] = opts.waitUrl;
577
+ if (opts.maxParticipants && opts.maxParticipants !== 250)
578
+ p['max_participants'] = opts.maxParticipants;
579
+ if (opts.record && opts.record !== 'do-not-record')
580
+ p['record'] = opts.record;
581
+ if (opts.region)
582
+ p['region'] = opts.region;
583
+ if (opts.trim && opts.trim !== 'trim-silence')
584
+ p['trim'] = opts.trim;
585
+ if (opts.coach)
586
+ p['coach'] = opts.coach;
587
+ if (opts.statusCallbackEvent)
588
+ p['status_callback_event'] = opts.statusCallbackEvent;
589
+ if (opts.statusCallback)
590
+ p['status_callback'] = opts.statusCallback;
591
+ if (opts.statusCallbackMethod && opts.statusCallbackMethod !== 'POST')
592
+ p['status_callback_method'] = opts.statusCallbackMethod;
593
+ if (opts.recordingStatusCallback)
594
+ p['recording_status_callback'] = opts.recordingStatusCallback;
595
+ if (opts.recordingStatusCallbackMethod && opts.recordingStatusCallbackMethod !== 'POST')
596
+ p['recording_status_callback_method'] = opts.recordingStatusCallbackMethod;
597
+ if (opts.recordingStatusCallbackEvent && opts.recordingStatusCallbackEvent !== 'completed')
598
+ p['recording_status_callback_event'] = opts.recordingStatusCallbackEvent;
599
+ if (opts.result !== undefined)
600
+ p['result'] = opts.result;
601
+ joinParams = p;
602
+ }
603
+ return this.executeSwml({
604
+ version: '1.0.0',
605
+ sections: { main: [{ join_conference: joinParams }] },
606
+ });
607
+ }
608
+ // ── RPC ─────────────────────────────────────────────────────────────
609
+ /**
610
+ * Execute a SignalWire RPC method via SWML.
611
+ * @param opts - RPC parameters including method name and optional call/node IDs.
612
+ * @returns This instance for chaining.
613
+ */
614
+ executeRpc(opts) {
615
+ const rpcParams = { method: opts.method };
616
+ if (opts.callId)
617
+ rpcParams['call_id'] = opts.callId;
618
+ if (opts.nodeId)
619
+ rpcParams['node_id'] = opts.nodeId;
620
+ if (opts.params)
621
+ rpcParams['params'] = opts.params;
622
+ return this.executeSwml({
623
+ version: '1.0.0',
624
+ sections: { main: [{ execute_rpc: rpcParams }] },
625
+ });
626
+ }
627
+ /**
628
+ * Dial a number via RPC, optionally specifying device type.
629
+ * @param toNumber - The destination phone number.
630
+ * @param fromNumber - The caller ID number.
631
+ * @param destSwml - The SWML destination for the dialed call.
632
+ * @param deviceType - The device type (defaults to "phone").
633
+ * @returns This instance for chaining.
634
+ */
635
+ rpcDial(toNumber, fromNumber, destSwml, deviceType = 'phone') {
636
+ return this.executeRpc({
637
+ method: 'dial',
638
+ params: {
639
+ devices: {
640
+ type: deviceType,
641
+ params: { to_number: toNumber, from_number: fromNumber },
642
+ },
643
+ dest_swml: destSwml,
644
+ },
645
+ });
646
+ }
647
+ /**
648
+ * Send an AI message to another call via RPC.
649
+ * @param callId - The target call ID.
650
+ * @param messageText - The message text to inject.
651
+ * @param role - The message role (defaults to "system").
652
+ * @returns This instance for chaining.
653
+ */
654
+ rpcAiMessage(callId, messageText, role = 'system') {
655
+ return this.executeRpc({
656
+ method: 'ai_message',
657
+ callId,
658
+ params: { role, message_text: messageText },
659
+ });
660
+ }
661
+ /**
662
+ * Unhold a call that was previously placed on hold via RPC.
663
+ * @param callId - The target call ID to unhold.
664
+ * @returns This instance for chaining.
665
+ */
666
+ rpcAiUnhold(callId) {
667
+ return this.executeRpc({
668
+ method: 'ai_unhold',
669
+ callId,
670
+ params: {},
671
+ });
672
+ }
673
+ // ── Payment ─────────────────────────────────────────────────────────
674
+ /**
675
+ * Initiate a payment collection flow on the call.
676
+ * @param opts - Payment configuration including connector URL, method, and prompt options.
677
+ * @returns This instance for chaining.
678
+ */
679
+ pay(opts) {
680
+ const payParams = {
681
+ payment_connector_url: opts.paymentConnectorUrl,
682
+ input: opts.inputMethod ?? 'dtmf',
683
+ payment_method: opts.paymentMethod ?? 'credit-card',
684
+ timeout: String(opts.timeout ?? 5),
685
+ max_attempts: String(opts.maxAttempts ?? 1),
686
+ security_code: String(opts.securityCode ?? true),
687
+ min_postal_code_length: String(opts.minPostalCodeLength ?? 0),
688
+ token_type: opts.tokenType ?? 'reusable',
689
+ currency: opts.currency ?? 'usd',
690
+ language: opts.language ?? 'en-US',
691
+ voice: opts.voice ?? 'woman',
692
+ valid_card_types: opts.validCardTypes ?? 'visa mastercard amex',
693
+ };
694
+ const postalCode = opts.postalCode ?? true;
695
+ payParams['postal_code'] = typeof postalCode === 'boolean' ? String(postalCode) : postalCode;
696
+ if (opts.statusUrl)
697
+ payParams['status_url'] = opts.statusUrl;
698
+ if (opts.chargeAmount)
699
+ payParams['charge_amount'] = opts.chargeAmount;
700
+ if (opts.description)
701
+ payParams['description'] = opts.description;
702
+ if (opts.parameters)
703
+ payParams['parameters'] = opts.parameters;
704
+ if (opts.prompts)
705
+ payParams['prompts'] = opts.prompts;
706
+ const aiResponse = opts.aiResponse ??
707
+ 'The payment status is ${pay_result}, do not mention anything else about collecting payment if successful.';
708
+ return this.executeSwml({
709
+ version: '1.0.0',
710
+ sections: {
711
+ main: [
712
+ { set: { ai_response: aiResponse } },
713
+ { pay: payParams },
714
+ ],
715
+ },
716
+ });
717
+ }
718
+ // ── Static payment helpers ──────────────────────────────────────────
719
+ /**
720
+ * Create a payment prompt configuration object.
721
+ * @param forSituation - The situation this prompt applies to.
722
+ * @param actions - Actions to perform for this prompt.
723
+ * @param cardType - Optional card type filter.
724
+ * @param errorType - Optional error type this prompt handles.
725
+ * @returns A new PaymentPrompt object.
726
+ */
727
+ static createPaymentPrompt(forSituation, actions, cardType, errorType) {
728
+ const prompt = { for: forSituation, actions };
729
+ if (cardType)
730
+ prompt.card_type = cardType;
731
+ if (errorType)
732
+ prompt.error_type = errorType;
733
+ return prompt;
734
+ }
735
+ /**
736
+ * Create a payment action for use within a payment prompt.
737
+ * @param actionType - The action type (e.g., "say", "play").
738
+ * @param phrase - The phrase or URL for this action.
739
+ * @returns A new PaymentAction object.
740
+ */
741
+ static createPaymentAction(actionType, phrase) {
742
+ return { type: actionType, phrase };
743
+ }
744
+ /**
745
+ * Create a custom payment parameter for the payment connector.
746
+ * @param name - The parameter name.
747
+ * @param value - The parameter value.
748
+ * @returns A new PaymentParameter object.
749
+ */
750
+ static createPaymentParameter(name, value) {
751
+ return { name, value };
752
+ }
753
+ // ── Serialization ───────────────────────────────────────────────────
754
+ /**
755
+ * Serialize this result to a plain object for the SWAIG response.
756
+ * @returns A dictionary with response, action, and post_process fields; falls back to "Action completed." if empty.
757
+ */
758
+ toDict() {
759
+ const result = {};
760
+ if (this.response) {
761
+ result['response'] = this.response;
762
+ }
763
+ if (this.action.length > 0) {
764
+ result['action'] = this.action;
765
+ }
766
+ if (this.postProcess && this.action.length > 0) {
767
+ result['post_process'] = true;
768
+ }
769
+ if (Object.keys(result).length === 0) {
770
+ result['response'] = 'Action completed.';
771
+ }
772
+ return result;
773
+ }
774
+ }
775
+ //# sourceMappingURL=FunctionResult.js.map