@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
@@ -1,944 +0,0 @@
1
- /**
2
- * Typed event wrappers for RELAY calling events.
3
- *
4
- * These are convenience classes over raw event dicts. All Call event handlers
5
- * also accept the raw dict, so these are optional.
6
- */
7
-
8
- /* eslint-disable @typescript-eslint/no-explicit-any */
9
-
10
- // ─── Base Event ──────────────────────────────────────────────────────
11
-
12
- /**
13
- * Base class for all typed RELAY events.
14
- *
15
- * Raw events arrive as `signalwire.event` JSON-RPC notifications; the client
16
- * looks up the correct subclass in {@link EVENT_CLASS_MAP} and invokes
17
- * {@link RelayEvent.fromPayload} to build a typed wrapper. Handlers receive
18
- * this wrapper; they can always read the original dict from `params`.
19
- */
20
- export class RelayEvent {
21
- /** Fully-qualified event type (e.g. `"calling.call.state"`). */
22
- readonly eventType: string;
23
- /** Raw params dict from the RELAY notification. */
24
- readonly params: Record<string, any>;
25
- /** Call ID associated with the event, or `""` for non-call events. */
26
- readonly callId: string;
27
- /** Server timestamp (epoch seconds) at which the event was emitted. */
28
- readonly timestamp: number;
29
-
30
- /**
31
- * @param eventType - Fully-qualified event type.
32
- * @param params - Raw event params dict.
33
- * @param callId - Call ID (if applicable).
34
- * @param timestamp - Server-side event timestamp.
35
- */
36
- constructor(
37
- eventType: string,
38
- params: Record<string, any>,
39
- callId = '',
40
- timestamp = 0,
41
- ) {
42
- this.eventType = eventType;
43
- this.params = params;
44
- this.callId = callId;
45
- this.timestamp = timestamp;
46
- }
47
-
48
- /**
49
- * Factory that builds a typed event from a raw `signalwire.event` payload.
50
- * Subclasses override this to populate their specialised fields; the base
51
- * implementation returns a minimal `RelayEvent` used as the fallback for
52
- * unrecognised event types.
53
- */
54
- static fromPayload(payload: Record<string, any>): RelayEvent {
55
- const eventType = payload.event_type ?? '';
56
- const params = payload.params ?? {};
57
- return new RelayEvent(
58
- eventType,
59
- params,
60
- params.call_id ?? '',
61
- params.timestamp ?? 0,
62
- );
63
- }
64
- }
65
-
66
- // ─── Helper ──────────────────────────────────────────────────────────
67
-
68
- function baseFields(payload: Record<string, any>) {
69
- const eventType = payload.event_type ?? '';
70
- const params = payload.params ?? {};
71
- return {
72
- eventType,
73
- params,
74
- callId: (params.call_id ?? '') as string,
75
- timestamp: (params.timestamp ?? 0) as number,
76
- };
77
- }
78
-
79
- // ─── Call Events ─────────────────────────────────────────────────────
80
-
81
- /** `calling.call.state` — fires on every lifecycle transition (created, ringing, answered, ending, ended). */
82
- export class CallStateEvent extends RelayEvent {
83
- readonly callState: string;
84
- readonly endReason: string;
85
- readonly direction: string;
86
- readonly device: Record<string, any>;
87
-
88
- constructor(
89
- eventType: string,
90
- params: Record<string, any>,
91
- callId: string,
92
- timestamp: number,
93
- callState: string,
94
- endReason: string,
95
- direction: string,
96
- device: Record<string, any>,
97
- ) {
98
- super(eventType, params, callId, timestamp);
99
- this.callState = callState;
100
- this.endReason = endReason;
101
- this.direction = direction;
102
- this.device = device;
103
- }
104
-
105
- static override fromPayload(payload: Record<string, any>): CallStateEvent {
106
- const b = baseFields(payload);
107
- return new CallStateEvent(
108
- b.eventType, b.params, b.callId, b.timestamp,
109
- b.params.call_state ?? '',
110
- b.params.end_reason ?? '',
111
- b.params.direction ?? '',
112
- b.params.device ?? {},
113
- );
114
- }
115
- }
116
-
117
- /** `calling.call.receive` — fires when an inbound call arrives on a subscribed context. */
118
- export class CallReceiveEvent extends RelayEvent {
119
- readonly callState: string;
120
- readonly direction: string;
121
- readonly device: Record<string, any>;
122
- readonly nodeId: string;
123
- readonly projectId: string;
124
- readonly context: string;
125
- readonly segmentId: string;
126
- readonly tag: string;
127
-
128
- constructor(
129
- eventType: string,
130
- params: Record<string, any>,
131
- callId: string,
132
- timestamp: number,
133
- callState: string,
134
- direction: string,
135
- device: Record<string, any>,
136
- nodeId: string,
137
- projectId: string,
138
- context: string,
139
- segmentId: string,
140
- tag: string,
141
- ) {
142
- super(eventType, params, callId, timestamp);
143
- this.callState = callState;
144
- this.direction = direction;
145
- this.device = device;
146
- this.nodeId = nodeId;
147
- this.projectId = projectId;
148
- this.context = context;
149
- this.segmentId = segmentId;
150
- this.tag = tag;
151
- }
152
-
153
- static override fromPayload(payload: Record<string, any>): CallReceiveEvent {
154
- const b = baseFields(payload);
155
- return new CallReceiveEvent(
156
- b.eventType, b.params, b.callId, b.timestamp,
157
- b.params.call_state ?? '',
158
- b.params.direction ?? '',
159
- b.params.device ?? {},
160
- b.params.node_id ?? '',
161
- b.params.project_id ?? '',
162
- b.params.context ?? b.params.protocol ?? '',
163
- b.params.segment_id ?? '',
164
- b.params.tag ?? '',
165
- );
166
- }
167
- }
168
-
169
- /** `calling.call.play` — play-media action state change (`playing`, `paused`, `finished`, `error`). */
170
- export class PlayEvent extends RelayEvent {
171
- readonly controlId: string;
172
- readonly state: string;
173
-
174
- constructor(
175
- eventType: string,
176
- params: Record<string, any>,
177
- callId: string,
178
- timestamp: number,
179
- controlId: string,
180
- state: string,
181
- ) {
182
- super(eventType, params, callId, timestamp);
183
- this.controlId = controlId;
184
- this.state = state;
185
- }
186
-
187
- static override fromPayload(payload: Record<string, any>): PlayEvent {
188
- const b = baseFields(payload);
189
- return new PlayEvent(
190
- b.eventType, b.params, b.callId, b.timestamp,
191
- b.params.control_id ?? '',
192
- b.params.state ?? '',
193
- );
194
- }
195
- }
196
-
197
- /** `calling.call.record` — recording state change with final URL, duration, and size when finished. */
198
- export class RecordEvent extends RelayEvent {
199
- readonly controlId: string;
200
- readonly state: string;
201
- readonly url: string;
202
- readonly duration: number;
203
- readonly size: number;
204
- readonly record: Record<string, any>;
205
-
206
- constructor(
207
- eventType: string,
208
- params: Record<string, any>,
209
- callId: string,
210
- timestamp: number,
211
- controlId: string,
212
- state: string,
213
- url: string,
214
- duration: number,
215
- size: number,
216
- record: Record<string, any>,
217
- ) {
218
- super(eventType, params, callId, timestamp);
219
- this.controlId = controlId;
220
- this.state = state;
221
- this.url = url;
222
- this.duration = duration;
223
- this.size = size;
224
- this.record = record;
225
- }
226
-
227
- static override fromPayload(payload: Record<string, any>): RecordEvent {
228
- const b = baseFields(payload);
229
- const rec = b.params.record ?? {};
230
- return new RecordEvent(
231
- b.eventType, b.params, b.callId, b.timestamp,
232
- b.params.control_id ?? '',
233
- b.params.state ?? '',
234
- rec.url ?? b.params.url ?? '',
235
- rec.duration ?? b.params.duration ?? 0,
236
- rec.size ?? b.params.size ?? 0,
237
- rec,
238
- );
239
- }
240
- }
241
-
242
- /** `calling.call.collect` — caller input (DTMF or speech) collected by a collect action. */
243
- export class CollectEvent extends RelayEvent {
244
- readonly controlId: string;
245
- readonly state: string;
246
- readonly result: Record<string, any>;
247
- readonly final: boolean | undefined;
248
-
249
- constructor(
250
- eventType: string,
251
- params: Record<string, any>,
252
- callId: string,
253
- timestamp: number,
254
- controlId: string = '',
255
- state: string = '',
256
- result: Record<string, any> = {},
257
- final_: boolean | undefined = undefined,
258
- ) {
259
- super(eventType, params, callId, timestamp);
260
- this.controlId = controlId;
261
- this.state = state;
262
- this.result = result;
263
- this.final = final_;
264
- }
265
-
266
- static override fromPayload(payload: Record<string, any>): CollectEvent {
267
- const b = baseFields(payload);
268
- return new CollectEvent(
269
- b.eventType, b.params, b.callId, b.timestamp,
270
- b.params.control_id ?? '',
271
- b.params.state ?? '',
272
- b.params.result ?? {},
273
- b.params.final,
274
- );
275
- }
276
- }
277
-
278
- /** `calling.call.connect` — state transition when one call connects to another (dialplan/bridge). */
279
- export class ConnectEvent extends RelayEvent {
280
- readonly connectState: string;
281
- readonly peer: Record<string, any>;
282
-
283
- constructor(
284
- eventType: string,
285
- params: Record<string, any>,
286
- callId: string,
287
- timestamp: number,
288
- connectState: string,
289
- peer: Record<string, any>,
290
- ) {
291
- super(eventType, params, callId, timestamp);
292
- this.connectState = connectState;
293
- this.peer = peer;
294
- }
295
-
296
- static override fromPayload(payload: Record<string, any>): ConnectEvent {
297
- const b = baseFields(payload);
298
- return new ConnectEvent(
299
- b.eventType, b.params, b.callId, b.timestamp,
300
- b.params.connect_state ?? '',
301
- b.params.peer ?? {},
302
- );
303
- }
304
- }
305
-
306
- /** `calling.call.detect` — answering-machine / fax / DTMF detection result. */
307
- export class DetectEvent extends RelayEvent {
308
- readonly controlId: string;
309
- readonly detect: Record<string, any>;
310
-
311
- constructor(
312
- eventType: string,
313
- params: Record<string, any>,
314
- callId: string,
315
- timestamp: number,
316
- controlId: string,
317
- detect: Record<string, any>,
318
- ) {
319
- super(eventType, params, callId, timestamp);
320
- this.controlId = controlId;
321
- this.detect = detect;
322
- }
323
-
324
- static override fromPayload(payload: Record<string, any>): DetectEvent {
325
- const b = baseFields(payload);
326
- return new DetectEvent(
327
- b.eventType, b.params, b.callId, b.timestamp,
328
- b.params.control_id ?? '',
329
- b.params.detect ?? {},
330
- );
331
- }
332
- }
333
-
334
- /** `calling.call.fax` — fax send/receive progress update. */
335
- export class FaxEvent extends RelayEvent {
336
- readonly controlId: string;
337
- readonly fax: Record<string, any>;
338
-
339
- constructor(
340
- eventType: string,
341
- params: Record<string, any>,
342
- callId: string,
343
- timestamp: number,
344
- controlId: string,
345
- fax: Record<string, any>,
346
- ) {
347
- super(eventType, params, callId, timestamp);
348
- this.controlId = controlId;
349
- this.fax = fax;
350
- }
351
-
352
- static override fromPayload(payload: Record<string, any>): FaxEvent {
353
- const b = baseFields(payload);
354
- return new FaxEvent(
355
- b.eventType, b.params, b.callId, b.timestamp,
356
- b.params.control_id ?? '',
357
- b.params.fax ?? {},
358
- );
359
- }
360
- }
361
-
362
- /** `calling.call.tap` — media tap state change (audio mirror to an external endpoint). */
363
- export class TapEvent extends RelayEvent {
364
- readonly controlId: string;
365
- readonly state: string;
366
- readonly tap: Record<string, any>;
367
- readonly device: Record<string, any>;
368
-
369
- constructor(
370
- eventType: string,
371
- params: Record<string, any>,
372
- callId: string,
373
- timestamp: number,
374
- controlId: string,
375
- state: string,
376
- tap: Record<string, any>,
377
- device: Record<string, any>,
378
- ) {
379
- super(eventType, params, callId, timestamp);
380
- this.controlId = controlId;
381
- this.state = state;
382
- this.tap = tap;
383
- this.device = device;
384
- }
385
-
386
- static override fromPayload(payload: Record<string, any>): TapEvent {
387
- const b = baseFields(payload);
388
- return new TapEvent(
389
- b.eventType, b.params, b.callId, b.timestamp,
390
- b.params.control_id ?? '',
391
- b.params.state ?? '',
392
- b.params.tap ?? {},
393
- b.params.device ?? {},
394
- );
395
- }
396
- }
397
-
398
- /** `calling.call.stream` — outbound media stream state change (e.g. RTMP/WebSocket streaming). */
399
- export class StreamEvent extends RelayEvent {
400
- readonly controlId: string;
401
- readonly state: string;
402
- readonly url: string;
403
- readonly name: string;
404
-
405
- constructor(
406
- eventType: string,
407
- params: Record<string, any>,
408
- callId: string,
409
- timestamp: number,
410
- controlId: string,
411
- state: string,
412
- url: string,
413
- name: string,
414
- ) {
415
- super(eventType, params, callId, timestamp);
416
- this.controlId = controlId;
417
- this.state = state;
418
- this.url = url;
419
- this.name = name;
420
- }
421
-
422
- static override fromPayload(payload: Record<string, any>): StreamEvent {
423
- const b = baseFields(payload);
424
- return new StreamEvent(
425
- b.eventType, b.params, b.callId, b.timestamp,
426
- b.params.control_id ?? '',
427
- b.params.state ?? '',
428
- b.params.url ?? '',
429
- b.params.name ?? '',
430
- );
431
- }
432
- }
433
-
434
- /** `calling.call.send_digits` — progress update for DTMF digits sent out on a call. */
435
- export class SendDigitsEvent extends RelayEvent {
436
- readonly controlId: string;
437
- readonly state: string;
438
-
439
- constructor(
440
- eventType: string,
441
- params: Record<string, any>,
442
- callId: string,
443
- timestamp: number,
444
- controlId: string,
445
- state: string,
446
- ) {
447
- super(eventType, params, callId, timestamp);
448
- this.controlId = controlId;
449
- this.state = state;
450
- }
451
-
452
- static override fromPayload(payload: Record<string, any>): SendDigitsEvent {
453
- const b = baseFields(payload);
454
- return new SendDigitsEvent(
455
- b.eventType, b.params, b.callId, b.timestamp,
456
- b.params.control_id ?? '',
457
- b.params.state ?? '',
458
- );
459
- }
460
- }
461
-
462
- /** `calling.call.dial` — outbound dial progress (answered, failed, no-answer, etc.). */
463
- export class DialEvent extends RelayEvent {
464
- readonly tag: string;
465
- readonly dialState: string;
466
- readonly call: Record<string, any>;
467
-
468
- constructor(
469
- eventType: string,
470
- params: Record<string, any>,
471
- callId: string,
472
- timestamp: number,
473
- tag: string,
474
- dialState: string,
475
- call: Record<string, any>,
476
- ) {
477
- super(eventType, params, callId, timestamp);
478
- this.tag = tag;
479
- this.dialState = dialState;
480
- this.call = call;
481
- }
482
-
483
- static override fromPayload(payload: Record<string, any>): DialEvent {
484
- const b = baseFields(payload);
485
- return new DialEvent(
486
- b.eventType, b.params, b.callId, b.timestamp,
487
- b.params.tag ?? '',
488
- b.params.dial_state ?? '',
489
- b.params.call ?? {},
490
- );
491
- }
492
- }
493
-
494
- /** `calling.call.refer` — SIP REFER result (off-platform transfer response codes). */
495
- export class ReferEvent extends RelayEvent {
496
- readonly state: string;
497
- readonly sipReferTo: string;
498
- readonly sipReferResponseCode: string;
499
- readonly sipNotifyResponseCode: string;
500
-
501
- constructor(
502
- eventType: string,
503
- params: Record<string, any>,
504
- callId: string,
505
- timestamp: number,
506
- state: string,
507
- sipReferTo: string,
508
- sipReferResponseCode: string,
509
- sipNotifyResponseCode: string,
510
- ) {
511
- super(eventType, params, callId, timestamp);
512
- this.state = state;
513
- this.sipReferTo = sipReferTo;
514
- this.sipReferResponseCode = sipReferResponseCode;
515
- this.sipNotifyResponseCode = sipNotifyResponseCode;
516
- }
517
-
518
- static override fromPayload(payload: Record<string, any>): ReferEvent {
519
- const b = baseFields(payload);
520
- return new ReferEvent(
521
- b.eventType, b.params, b.callId, b.timestamp,
522
- b.params.state ?? '',
523
- b.params.sip_refer_to ?? '',
524
- b.params.sip_refer_response_code ?? '',
525
- b.params.sip_notify_response_code ?? '',
526
- );
527
- }
528
- }
529
-
530
- /** `calling.call.denoise` — noise-reduction on/off confirmation. */
531
- export class DenoiseEvent extends RelayEvent {
532
- readonly denoised: boolean;
533
-
534
- constructor(
535
- eventType: string,
536
- params: Record<string, any>,
537
- callId: string,
538
- timestamp: number,
539
- denoised: boolean,
540
- ) {
541
- super(eventType, params, callId, timestamp);
542
- this.denoised = denoised;
543
- }
544
-
545
- static override fromPayload(payload: Record<string, any>): DenoiseEvent {
546
- const b = baseFields(payload);
547
- return new DenoiseEvent(
548
- b.eventType, b.params, b.callId, b.timestamp,
549
- b.params.denoised ?? false,
550
- );
551
- }
552
- }
553
-
554
- /** `calling.call.pay` — PCI-compliant payment collection progress update. */
555
- export class PayEvent extends RelayEvent {
556
- readonly controlId: string;
557
- readonly state: string;
558
-
559
- constructor(
560
- eventType: string,
561
- params: Record<string, any>,
562
- callId: string,
563
- timestamp: number,
564
- controlId: string,
565
- state: string,
566
- ) {
567
- super(eventType, params, callId, timestamp);
568
- this.controlId = controlId;
569
- this.state = state;
570
- }
571
-
572
- static override fromPayload(payload: Record<string, any>): PayEvent {
573
- const b = baseFields(payload);
574
- return new PayEvent(
575
- b.eventType, b.params, b.callId, b.timestamp,
576
- b.params.control_id ?? '',
577
- b.params.state ?? '',
578
- );
579
- }
580
- }
581
-
582
- /** `calling.call.queue` — call-queue position update (queued, waiting, member answered, timed out). */
583
- export class QueueEvent extends RelayEvent {
584
- readonly controlId: string;
585
- readonly status: string;
586
- readonly queueId: string;
587
- readonly queueName: string;
588
- readonly position: number;
589
- readonly size: number;
590
-
591
- constructor(
592
- eventType: string,
593
- params: Record<string, any>,
594
- callId: string,
595
- timestamp: number,
596
- controlId: string,
597
- status: string,
598
- queueId: string,
599
- queueName: string,
600
- position: number,
601
- size: number,
602
- ) {
603
- super(eventType, params, callId, timestamp);
604
- this.controlId = controlId;
605
- this.status = status;
606
- this.queueId = queueId;
607
- this.queueName = queueName;
608
- this.position = position;
609
- this.size = size;
610
- }
611
-
612
- static override fromPayload(payload: Record<string, any>): QueueEvent {
613
- const b = baseFields(payload);
614
- return new QueueEvent(
615
- b.eventType, b.params, b.callId, b.timestamp,
616
- b.params.control_id ?? '',
617
- b.params.status ?? '',
618
- b.params.id ?? '',
619
- b.params.name ?? '',
620
- b.params.position ?? 0,
621
- b.params.size ?? 0,
622
- );
623
- }
624
- }
625
-
626
- /** `calling.call.echo` — test/diagnostic echo reflection from the server. */
627
- export class EchoEvent extends RelayEvent {
628
- readonly state: string;
629
-
630
- constructor(
631
- eventType: string,
632
- params: Record<string, any>,
633
- callId: string,
634
- timestamp: number,
635
- state: string,
636
- ) {
637
- super(eventType, params, callId, timestamp);
638
- this.state = state;
639
- }
640
-
641
- static override fromPayload(payload: Record<string, any>): EchoEvent {
642
- const b = baseFields(payload);
643
- return new EchoEvent(
644
- b.eventType, b.params, b.callId, b.timestamp,
645
- b.params.state ?? '',
646
- );
647
- }
648
- }
649
-
650
- /** `calling.call.transcribe` — transcription state change and final URL/duration when finished. */
651
- export class TranscribeEvent extends RelayEvent {
652
- readonly controlId: string;
653
- readonly state: string;
654
- readonly url: string;
655
- readonly recordingId: string;
656
- readonly duration: number;
657
- readonly size: number;
658
-
659
- constructor(
660
- eventType: string,
661
- params: Record<string, any>,
662
- callId: string,
663
- timestamp: number,
664
- controlId: string,
665
- state: string,
666
- url: string,
667
- recordingId: string,
668
- duration: number,
669
- size: number,
670
- ) {
671
- super(eventType, params, callId, timestamp);
672
- this.controlId = controlId;
673
- this.state = state;
674
- this.url = url;
675
- this.recordingId = recordingId;
676
- this.duration = duration;
677
- this.size = size;
678
- }
679
-
680
- static override fromPayload(payload: Record<string, any>): TranscribeEvent {
681
- const b = baseFields(payload);
682
- return new TranscribeEvent(
683
- b.eventType, b.params, b.callId, b.timestamp,
684
- b.params.control_id ?? '',
685
- b.params.state ?? '',
686
- b.params.url ?? '',
687
- b.params.recording_id ?? '',
688
- b.params.duration ?? 0,
689
- b.params.size ?? 0,
690
- );
691
- }
692
- }
693
-
694
- /** `calling.call.hold` — hold/unhold state change on the call. */
695
- export class HoldEvent extends RelayEvent {
696
- readonly state: string;
697
-
698
- constructor(
699
- eventType: string,
700
- params: Record<string, any>,
701
- callId: string,
702
- timestamp: number,
703
- state: string,
704
- ) {
705
- super(eventType, params, callId, timestamp);
706
- this.state = state;
707
- }
708
-
709
- static override fromPayload(payload: Record<string, any>): HoldEvent {
710
- const b = baseFields(payload);
711
- return new HoldEvent(
712
- b.eventType, b.params, b.callId, b.timestamp,
713
- b.params.state ?? '',
714
- );
715
- }
716
- }
717
-
718
- /** `calling.conference` — conference lifecycle change (created, active, ended). */
719
- export class ConferenceEvent extends RelayEvent {
720
- readonly conferenceId: string;
721
- readonly name: string;
722
- readonly status: string;
723
-
724
- constructor(
725
- eventType: string,
726
- params: Record<string, any>,
727
- callId: string,
728
- timestamp: number,
729
- conferenceId: string,
730
- name: string,
731
- status: string,
732
- ) {
733
- super(eventType, params, callId, timestamp);
734
- this.conferenceId = conferenceId;
735
- this.name = name;
736
- this.status = status;
737
- }
738
-
739
- static override fromPayload(payload: Record<string, any>): ConferenceEvent {
740
- const b = baseFields(payload);
741
- return new ConferenceEvent(
742
- b.eventType, b.params, b.callId, b.timestamp,
743
- b.params.conference_id ?? '',
744
- b.params.name ?? '',
745
- b.params.status ?? '',
746
- );
747
- }
748
- }
749
-
750
- /** `calling.error` — platform-emitted error against the calling namespace. */
751
- export class CallingErrorEvent extends RelayEvent {
752
- readonly code: string;
753
- readonly message: string;
754
-
755
- constructor(
756
- eventType: string,
757
- params: Record<string, any>,
758
- callId: string,
759
- timestamp: number,
760
- code: string,
761
- message: string,
762
- ) {
763
- super(eventType, params, callId, timestamp);
764
- this.code = code;
765
- this.message = message;
766
- }
767
-
768
- static override fromPayload(payload: Record<string, any>): CallingErrorEvent {
769
- const b = baseFields(payload);
770
- return new CallingErrorEvent(
771
- b.eventType, b.params, b.callId, b.timestamp,
772
- b.params.code ?? '',
773
- b.params.message ?? '',
774
- );
775
- }
776
- }
777
-
778
- // ─── Messaging Events ────────────────────────────────────────────────
779
-
780
- /** `messaging.receive` — inbound SMS/MMS received on a subscribed context. */
781
- export class MessageReceiveEvent extends RelayEvent {
782
- readonly messageId: string;
783
- readonly context: string;
784
- readonly direction: string;
785
- readonly fromNumber: string;
786
- readonly toNumber: string;
787
- readonly body: string;
788
- readonly media: string[];
789
- readonly segments: number;
790
- readonly messageState: string;
791
- readonly tags: string[];
792
-
793
- constructor(
794
- eventType: string,
795
- params: Record<string, any>,
796
- callId: string,
797
- timestamp: number,
798
- messageId: string,
799
- context: string,
800
- direction: string,
801
- fromNumber: string,
802
- toNumber: string,
803
- body: string,
804
- media: string[],
805
- segments: number,
806
- messageState: string,
807
- tags: string[],
808
- ) {
809
- super(eventType, params, callId, timestamp);
810
- this.messageId = messageId;
811
- this.context = context;
812
- this.direction = direction;
813
- this.fromNumber = fromNumber;
814
- this.toNumber = toNumber;
815
- this.body = body;
816
- this.media = media;
817
- this.segments = segments;
818
- this.messageState = messageState;
819
- this.tags = tags;
820
- }
821
-
822
- static override fromPayload(payload: Record<string, any>): MessageReceiveEvent {
823
- const b = baseFields(payload);
824
- return new MessageReceiveEvent(
825
- b.eventType, b.params, b.callId, b.timestamp,
826
- b.params.message_id ?? '',
827
- b.params.context ?? '',
828
- b.params.direction ?? '',
829
- b.params.from_number ?? '',
830
- b.params.to_number ?? '',
831
- b.params.body ?? '',
832
- b.params.media ?? [],
833
- b.params.segments ?? 0,
834
- b.params.message_state ?? '',
835
- b.params.tags ?? [],
836
- );
837
- }
838
- }
839
-
840
- /** `messaging.state` — state change for an outbound message (queued → sent → delivered/failed). */
841
- export class MessageStateEvent extends RelayEvent {
842
- readonly messageId: string;
843
- readonly context: string;
844
- readonly direction: string;
845
- readonly fromNumber: string;
846
- readonly toNumber: string;
847
- readonly body: string;
848
- readonly media: string[];
849
- readonly segments: number;
850
- readonly messageState: string;
851
- readonly reason: string;
852
- readonly tags: string[];
853
-
854
- constructor(
855
- eventType: string,
856
- params: Record<string, any>,
857
- callId: string,
858
- timestamp: number,
859
- messageId: string,
860
- context: string,
861
- direction: string,
862
- fromNumber: string,
863
- toNumber: string,
864
- body: string,
865
- media: string[],
866
- segments: number,
867
- messageState: string,
868
- reason: string,
869
- tags: string[],
870
- ) {
871
- super(eventType, params, callId, timestamp);
872
- this.messageId = messageId;
873
- this.context = context;
874
- this.direction = direction;
875
- this.fromNumber = fromNumber;
876
- this.toNumber = toNumber;
877
- this.body = body;
878
- this.media = media;
879
- this.segments = segments;
880
- this.messageState = messageState;
881
- this.reason = reason;
882
- this.tags = tags;
883
- }
884
-
885
- static override fromPayload(payload: Record<string, any>): MessageStateEvent {
886
- const b = baseFields(payload);
887
- return new MessageStateEvent(
888
- b.eventType, b.params, b.callId, b.timestamp,
889
- b.params.message_id ?? '',
890
- b.params.context ?? '',
891
- b.params.direction ?? '',
892
- b.params.from_number ?? '',
893
- b.params.to_number ?? '',
894
- b.params.body ?? '',
895
- b.params.media ?? [],
896
- b.params.segments ?? 0,
897
- b.params.message_state ?? '',
898
- b.params.reason ?? '',
899
- b.params.tags ?? [],
900
- );
901
- }
902
- }
903
-
904
- // ─── Event Class Map & Parser ────────────────────────────────────────
905
-
906
- /** Structural type for an event class that exposes a `fromPayload` factory. */
907
- export type EventClass = { fromPayload(payload: Record<string, any>): RelayEvent };
908
-
909
- /**
910
- * Maps RELAY `event_type` strings to the typed event subclass that builds
911
- * its wrapper. Used by {@link parseEvent} to dispatch raw payloads.
912
- */
913
- export const EVENT_CLASS_MAP: Record<string, EventClass> = {
914
- 'calling.call.state': CallStateEvent,
915
- 'calling.call.receive': CallReceiveEvent,
916
- 'calling.call.play': PlayEvent,
917
- 'calling.call.record': RecordEvent,
918
- 'calling.call.collect': CollectEvent,
919
- 'calling.call.connect': ConnectEvent,
920
- 'calling.call.detect': DetectEvent,
921
- 'calling.call.fax': FaxEvent,
922
- 'calling.call.tap': TapEvent,
923
- 'calling.call.stream': StreamEvent,
924
- 'calling.call.send_digits': SendDigitsEvent,
925
- 'calling.call.dial': DialEvent,
926
- 'calling.call.refer': ReferEvent,
927
- 'calling.call.denoise': DenoiseEvent,
928
- 'calling.call.pay': PayEvent,
929
- 'calling.call.queue': QueueEvent,
930
- 'calling.call.echo': EchoEvent,
931
- 'calling.call.transcribe': TranscribeEvent,
932
- 'calling.call.hold': HoldEvent,
933
- 'calling.conference': ConferenceEvent,
934
- 'calling.error': CallingErrorEvent,
935
- 'messaging.receive': MessageReceiveEvent,
936
- 'messaging.state': MessageStateEvent,
937
- };
938
-
939
- /** Parse a raw signalwire.event params dict into a typed event object. */
940
- export function parseEvent(payload: Record<string, any>): RelayEvent {
941
- const eventType = payload.event_type ?? '';
942
- const cls = EVENT_CLASS_MAP[eventType] ?? RelayEvent;
943
- return cls.fromPayload(payload);
944
- }