@signalwire/sdk 2.0.4 → 3.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (656) hide show
  1. package/CHANGELOG.md +785 -0
  2. package/LICENSE +21 -0
  3. package/README.md +163 -68
  4. package/dist/AGENTS.md +13 -0
  5. package/dist/AgentBase.d.ts +550 -163
  6. package/dist/AgentBase.js +1640 -514
  7. package/dist/AgentBase.js.map +1 -1
  8. package/dist/AgentServer.d.ts +21 -0
  9. package/dist/AgentServer.js +154 -47
  10. package/dist/AgentServer.js.map +1 -1
  11. package/dist/AuthHandler.d.ts +14 -2
  12. package/dist/AuthHandler.js +7 -2
  13. package/dist/AuthHandler.js.map +1 -1
  14. package/dist/ConfigLoader.d.ts +5 -13
  15. package/dist/ConfigLoader.js +15 -29
  16. package/dist/ConfigLoader.js.map +1 -1
  17. package/dist/ContextBuilder.d.ts +202 -9
  18. package/dist/ContextBuilder.js +219 -36
  19. package/dist/ContextBuilder.js.map +1 -1
  20. package/dist/DataMap.d.ts +158 -45
  21. package/dist/DataMap.js +167 -52
  22. package/dist/DataMap.js.map +1 -1
  23. package/dist/FunctionResult.d.ts +277 -83
  24. package/dist/FunctionResult.js +444 -116
  25. package/dist/FunctionResult.js.map +1 -1
  26. package/dist/Logger.d.ts +30 -5
  27. package/dist/Logger.js +77 -19
  28. package/dist/Logger.js.map +1 -1
  29. package/dist/POM/PromptObjectModel.d.ts +163 -0
  30. package/dist/POM/PromptObjectModel.js +481 -0
  31. package/dist/POM/PromptObjectModel.js.map +1 -0
  32. package/dist/ParameterSchema.d.ts +306 -0
  33. package/dist/ParameterSchema.js +251 -0
  34. package/dist/ParameterSchema.js.map +1 -0
  35. package/dist/PlatformContracts.d.ts +21 -0
  36. package/dist/PlatformContracts.generated.d.ts +109 -0
  37. package/dist/PlatformContracts.generated.js +8 -0
  38. package/dist/PlatformContracts.generated.js.map +1 -0
  39. package/dist/PlatformContracts.js +2 -0
  40. package/dist/PlatformContracts.js.map +1 -0
  41. package/dist/PomBuilder.d.ts +28 -0
  42. package/dist/PomBuilder.js +81 -3
  43. package/dist/PomBuilder.js.map +1 -1
  44. package/dist/PostPrompt.d.ts +110 -0
  45. package/dist/PostPrompt.js +204 -0
  46. package/dist/PostPrompt.js.map +1 -0
  47. package/dist/PromptManager.d.ts +29 -1
  48. package/dist/PromptManager.js +37 -1
  49. package/dist/PromptManager.js.map +1 -1
  50. package/dist/PublicFetch.d.ts +132 -0
  51. package/dist/PublicFetch.js +311 -0
  52. package/dist/PublicFetch.js.map +1 -0
  53. package/dist/RobotsTxt.d.ts +41 -0
  54. package/dist/RobotsTxt.js +152 -0
  55. package/dist/RobotsTxt.js.map +1 -0
  56. package/dist/SWMLHandler.js.map +1 -1
  57. package/dist/SWMLService.d.ts +265 -66
  58. package/dist/SWMLService.js +652 -112
  59. package/dist/SWMLService.js.map +1 -1
  60. package/dist/SchemaUtils.d.ts +115 -2
  61. package/dist/SchemaUtils.js +444 -12
  62. package/dist/SchemaUtils.js.map +1 -1
  63. package/dist/SecurityUtils.d.ts +55 -8
  64. package/dist/SecurityUtils.js +162 -49
  65. package/dist/SecurityUtils.js.map +1 -1
  66. package/dist/ServerlessAdapter.d.ts +156 -7
  67. package/dist/ServerlessAdapter.js +399 -42
  68. package/dist/ServerlessAdapter.js.map +1 -1
  69. package/dist/SessionManager.d.ts +11 -2
  70. package/dist/SessionManager.js +50 -18
  71. package/dist/SessionManager.js.map +1 -1
  72. package/dist/SslConfig.d.ts +2 -1
  73. package/dist/SslConfig.js +4 -1
  74. package/dist/SslConfig.js.map +1 -1
  75. package/dist/SwaigActions.generated.d.ts +23 -0
  76. package/dist/SwaigActions.generated.js +8 -0
  77. package/dist/SwaigActions.generated.js.map +1 -0
  78. package/dist/SwaigContracts.d.ts +15 -0
  79. package/dist/SwaigContracts.generated.d.ts +264 -0
  80. package/dist/SwaigContracts.generated.js +12 -0
  81. package/dist/SwaigContracts.generated.js.map +1 -0
  82. package/dist/SwaigContracts.js +2 -0
  83. package/dist/SwaigContracts.js.map +1 -0
  84. package/dist/SwaigFunction.d.ts +110 -4
  85. package/dist/SwaigFunction.js +151 -19
  86. package/dist/SwaigFunction.js.map +1 -1
  87. package/dist/SwmlBuilder.d.ts +68 -19
  88. package/dist/SwmlBuilder.js +74 -38
  89. package/dist/SwmlBuilder.js.map +1 -1
  90. package/dist/SwmlVerbMethods.generated.d.ts +41 -4
  91. package/dist/SwmlVerbMethods.generated.js +1 -1
  92. package/dist/TypeInference.d.ts +39 -3
  93. package/dist/TypeInference.js +256 -16
  94. package/dist/TypeInference.js.map +1 -1
  95. package/dist/WebService.d.ts +79 -11
  96. package/dist/WebService.js +320 -109
  97. package/dist/WebService.js.map +1 -1
  98. package/dist/WebhookMiddleware.d.ts +119 -0
  99. package/dist/WebhookMiddleware.js +271 -0
  100. package/dist/WebhookMiddleware.js.map +1 -0
  101. package/dist/WebhookValidator.d.ts +92 -0
  102. package/dist/WebhookValidator.js +409 -0
  103. package/dist/WebhookValidator.js.map +1 -0
  104. package/dist/agents/BedrockAgent.d.ts +162 -0
  105. package/dist/agents/BedrockAgent.js +323 -0
  106. package/dist/agents/BedrockAgent.js.map +1 -0
  107. package/dist/ai-chat/AIChatClient.d.ts +316 -0
  108. package/dist/ai-chat/AIChatClient.js +535 -0
  109. package/dist/ai-chat/AIChatClient.js.map +1 -0
  110. package/dist/ai-chat/ChatGateway.d.ts +408 -0
  111. package/dist/ai-chat/ChatGateway.js +747 -0
  112. package/dist/ai-chat/ChatGateway.js.map +1 -0
  113. package/dist/ai-chat/HandoffRouter.d.ts +282 -0
  114. package/dist/ai-chat/HandoffRouter.js +518 -0
  115. package/dist/ai-chat/HandoffRouter.js.map +1 -0
  116. package/dist/ai-chat/index.d.ts +12 -0
  117. package/dist/ai-chat/index.js +10 -0
  118. package/dist/ai-chat/index.js.map +1 -0
  119. package/dist/capabilities.d.ts +64 -0
  120. package/dist/capabilities.js +95 -0
  121. package/dist/capabilities.js.map +1 -0
  122. package/dist/cli/agent-loader.d.ts +32 -6
  123. package/dist/cli/agent-loader.js +95 -34
  124. package/dist/cli/agent-loader.js.map +1 -1
  125. package/dist/cli/datamap-exec.d.ts +175 -0
  126. package/dist/cli/datamap-exec.js +1284 -0
  127. package/dist/cli/datamap-exec.js.map +1 -0
  128. package/dist/cli/function-args.d.ts +40 -0
  129. package/dist/cli/function-args.js +146 -0
  130. package/dist/cli/function-args.js.map +1 -0
  131. package/dist/cli/simulation.d.ts +99 -0
  132. package/dist/cli/simulation.js +490 -0
  133. package/dist/cli/simulation.js.map +1 -0
  134. package/dist/cli/swaig-test.d.ts +12 -25
  135. package/dist/cli/swaig-test.js +935 -367
  136. package/dist/cli/swaig-test.js.map +1 -1
  137. package/dist/cli/tsdocs/agentsNote.d.ts +30 -0
  138. package/dist/cli/tsdocs/agentsNote.js +92 -0
  139. package/dist/cli/tsdocs/agentsNote.js.map +1 -0
  140. package/dist/cli/tsdocs/api-index.json +1 -0
  141. package/dist/cli/tsdocs/api.d.ts +91 -0
  142. package/dist/cli/tsdocs/api.js +372 -0
  143. package/dist/cli/tsdocs/api.js.map +1 -0
  144. package/dist/cli/tsdocs/apiTypes.d.ts +64 -0
  145. package/dist/cli/tsdocs/apiTypes.js +7 -0
  146. package/dist/cli/tsdocs/apiTypes.js.map +1 -0
  147. package/dist/cli/tsdocs/bin.d.ts +6 -0
  148. package/dist/cli/tsdocs/bin.js +23 -0
  149. package/dist/cli/tsdocs/bin.js.map +1 -0
  150. package/dist/cli/tsdocs/files.d.ts +108 -0
  151. package/dist/cli/tsdocs/files.js +287 -0
  152. package/dist/cli/tsdocs/files.js.map +1 -0
  153. package/dist/cli/tsdocs/index.d.ts +28 -0
  154. package/dist/cli/tsdocs/index.js +307 -0
  155. package/dist/cli/tsdocs/index.js.map +1 -0
  156. package/dist/cli/tsdocs/live.d.ts +41 -0
  157. package/dist/cli/tsdocs/live.js +202 -0
  158. package/dist/cli/tsdocs/live.js.map +1 -0
  159. package/dist/cli/tsdocs/locate.d.ts +51 -0
  160. package/dist/cli/tsdocs/locate.js +75 -0
  161. package/dist/cli/tsdocs/locate.js.map +1 -0
  162. package/dist/cli/tsdocs/render.d.ts +75 -0
  163. package/dist/cli/tsdocs/render.js +323 -0
  164. package/dist/cli/tsdocs/render.js.map +1 -0
  165. package/dist/cli/tsdocs/topics.d.ts +43 -0
  166. package/dist/cli/tsdocs/topics.js +916 -0
  167. package/dist/cli/tsdocs/topics.js.map +1 -0
  168. package/dist/index.d.ts +102 -39
  169. package/dist/index.js +107 -30
  170. package/dist/index.js.map +1 -1
  171. package/dist/livewire/index.d.ts +229 -155
  172. package/dist/livewire/index.js +298 -195
  173. package/dist/livewire/index.js.map +1 -1
  174. package/dist/llms.txt +65 -0
  175. package/dist/prefabs/CallSessionStore.d.ts +52 -0
  176. package/dist/prefabs/CallSessionStore.js +72 -0
  177. package/dist/prefabs/CallSessionStore.js.map +1 -0
  178. package/dist/prefabs/ConciergeAgent.d.ts +13 -1
  179. package/dist/prefabs/ConciergeAgent.js +36 -31
  180. package/dist/prefabs/ConciergeAgent.js.map +1 -1
  181. package/dist/prefabs/FAQBotAgent.d.ts +9 -1
  182. package/dist/prefabs/FAQBotAgent.js +113 -47
  183. package/dist/prefabs/FAQBotAgent.js.map +1 -1
  184. package/dist/prefabs/InfoGathererAgent.d.ts +22 -3
  185. package/dist/prefabs/InfoGathererAgent.js +67 -58
  186. package/dist/prefabs/InfoGathererAgent.js.map +1 -1
  187. package/dist/prefabs/ReceptionistAgent.d.ts +16 -5
  188. package/dist/prefabs/ReceptionistAgent.js +39 -31
  189. package/dist/prefabs/ReceptionistAgent.js.map +1 -1
  190. package/dist/prefabs/SurveyAgent.d.ts +22 -4
  191. package/dist/prefabs/SurveyAgent.js +84 -68
  192. package/dist/prefabs/SurveyAgent.js.map +1 -1
  193. package/dist/relay/Action.d.ts +44 -21
  194. package/dist/relay/Action.js +75 -17
  195. package/dist/relay/Action.js.map +1 -1
  196. package/dist/relay/Call.d.ts +312 -47
  197. package/dist/relay/Call.js +369 -18
  198. package/dist/relay/Call.js.map +1 -1
  199. package/dist/relay/Deferred.js.map +1 -1
  200. package/dist/relay/Message.d.ts +26 -5
  201. package/dist/relay/Message.js +36 -6
  202. package/dist/relay/Message.js.map +1 -1
  203. package/dist/relay/RelayClient.d.ts +79 -14
  204. package/dist/relay/RelayClient.js +268 -61
  205. package/dist/relay/RelayClient.js.map +1 -1
  206. package/dist/relay/RelayError.d.ts +14 -0
  207. package/dist/relay/RelayError.js +15 -0
  208. package/dist/relay/RelayError.js.map +1 -1
  209. package/dist/relay/RelayEvent.d.ts +96 -65
  210. package/dist/relay/RelayEvent.js +85 -56
  211. package/dist/relay/RelayEvent.js.map +1 -1
  212. package/dist/relay/closedSets.d.ts +111 -0
  213. package/dist/relay/closedSets.js +83 -0
  214. package/dist/relay/closedSets.js.map +1 -0
  215. package/dist/relay/index.d.ts +3 -1
  216. package/dist/relay/index.js +1 -0
  217. package/dist/relay/index.js.map +1 -1
  218. package/dist/relay/normalize.js.map +1 -1
  219. package/dist/relay/protocol.types.generated.d.ts +1195 -0
  220. package/dist/relay/protocol.types.generated.js +8 -0
  221. package/dist/relay/protocol.types.generated.js.map +1 -0
  222. package/dist/relay/types.d.ts +81 -39
  223. package/dist/rest/HttpClient.d.ts +36 -8
  224. package/dist/rest/HttpClient.js +233 -40
  225. package/dist/rest/HttpClient.js.map +1 -1
  226. package/dist/rest/RequestOptions.d.ts +110 -0
  227. package/dist/rest/RequestOptions.js +113 -0
  228. package/dist/rest/RequestOptions.js.map +1 -0
  229. package/dist/rest/RestError.d.ts +52 -6
  230. package/dist/rest/RestError.js +89 -5
  231. package/dist/rest/RestError.js.map +1 -1
  232. package/dist/rest/base/CrudResource.d.ts +16 -26
  233. package/dist/rest/base/CrudResource.js +19 -33
  234. package/dist/rest/base/CrudResource.js.map +1 -1
  235. package/dist/rest/base/CrudWithAddresses.d.ts +3 -2
  236. package/dist/rest/base/CrudWithAddresses.js +2 -2
  237. package/dist/rest/base/CrudWithAddresses.js.map +1 -1
  238. package/dist/rest/base/FabricResource.d.ts +15 -0
  239. package/dist/rest/base/FabricResource.js +16 -0
  240. package/dist/rest/base/FabricResource.js.map +1 -0
  241. package/dist/rest/base/ReadResource.d.ts +62 -0
  242. package/dist/rest/base/ReadResource.js +69 -0
  243. package/dist/rest/base/ReadResource.js.map +1 -0
  244. package/dist/rest/callHandler.d.ts +63 -0
  245. package/dist/rest/callHandler.js +62 -0
  246. package/dist/rest/callHandler.js.map +1 -0
  247. package/dist/rest/index.d.ts +19 -76
  248. package/dist/rest/index.js +49 -120
  249. package/dist/rest/index.js.map +1 -1
  250. package/dist/rest/namespaces/_client_tree_generated.d.ts +103 -0
  251. package/dist/rest/namespaces/_client_tree_generated.js +171 -0
  252. package/dist/rest/namespaces/_client_tree_generated.js.map +1 -0
  253. package/dist/rest/namespaces/addresses.d.ts +3 -42
  254. package/dist/rest/namespaces/addresses.js +3 -50
  255. package/dist/rest/namespaces/addresses.js.map +1 -1
  256. package/dist/rest/namespaces/calling.d.ts +6 -378
  257. package/dist/rest/namespaces/calling.js +6 -473
  258. package/dist/rest/namespaces/calling.js.map +1 -1
  259. package/dist/rest/namespaces/calling.resources.generated.d.ts +165 -0
  260. package/dist/rest/namespaces/calling.resources.generated.js +477 -0
  261. package/dist/rest/namespaces/calling.resources.generated.js.map +1 -0
  262. package/dist/rest/namespaces/calling.types.generated.d.ts +2917 -0
  263. package/dist/rest/namespaces/calling.types.generated.js +8 -0
  264. package/dist/rest/namespaces/calling.types.generated.js.map +1 -0
  265. package/dist/rest/namespaces/chat.d.ts +4 -18
  266. package/dist/rest/namespaces/chat.js +4 -21
  267. package/dist/rest/namespaces/chat.js.map +1 -1
  268. package/dist/rest/namespaces/chat.resources.generated.d.ts +12 -0
  269. package/dist/rest/namespaces/chat.resources.generated.js +29 -0
  270. package/dist/rest/namespaces/chat.resources.generated.js.map +1 -0
  271. package/dist/rest/namespaces/chat.types.generated.d.ts +56 -0
  272. package/dist/rest/namespaces/chat.types.generated.js +8 -0
  273. package/dist/rest/namespaces/chat.types.generated.js.map +1 -0
  274. package/dist/rest/namespaces/datasphere.d.ts +6 -62
  275. package/dist/rest/namespaces/datasphere.js +6 -72
  276. package/dist/rest/namespaces/datasphere.js.map +1 -1
  277. package/dist/rest/namespaces/datasphere.resources.generated.d.ts +25 -0
  278. package/dist/rest/namespaces/datasphere.resources.generated.js +50 -0
  279. package/dist/rest/namespaces/datasphere.resources.generated.js.map +1 -0
  280. package/dist/rest/namespaces/datasphere.types.generated.d.ts +180 -0
  281. package/dist/rest/namespaces/datasphere.types.generated.js +8 -0
  282. package/dist/rest/namespaces/datasphere.types.generated.js.map +1 -0
  283. package/dist/rest/namespaces/fabric.d.ts +11 -273
  284. package/dist/rest/namespaces/fabric.js +14 -363
  285. package/dist/rest/namespaces/fabric.js.map +1 -1
  286. package/dist/rest/namespaces/fabric.resources.generated.d.ts +195 -0
  287. package/dist/rest/namespaces/fabric.resources.generated.js +399 -0
  288. package/dist/rest/namespaces/fabric.resources.generated.js.map +1 -0
  289. package/dist/rest/namespaces/fabric.types.generated.d.ts +4557 -0
  290. package/dist/rest/namespaces/fabric.types.generated.js +8 -0
  291. package/dist/rest/namespaces/fabric.types.generated.js.map +1 -0
  292. package/dist/rest/namespaces/fax.resources.generated.d.ts +6 -0
  293. package/dist/rest/namespaces/fax.resources.generated.js +14 -0
  294. package/dist/rest/namespaces/fax.resources.generated.js.map +1 -0
  295. package/dist/rest/namespaces/fax.types.generated.d.ts +131 -0
  296. package/dist/rest/namespaces/fax.types.generated.js +8 -0
  297. package/dist/rest/namespaces/fax.types.generated.js.map +1 -0
  298. package/dist/rest/namespaces/imported-numbers.d.ts +3 -18
  299. package/dist/rest/namespaces/imported-numbers.js +3 -21
  300. package/dist/rest/namespaces/imported-numbers.js.map +1 -1
  301. package/dist/rest/namespaces/logs.d.ts +10 -101
  302. package/dist/rest/namespaces/logs.js +10 -128
  303. package/dist/rest/namespaces/logs.js.map +1 -1
  304. package/dist/rest/namespaces/logs.resources.generated.d.ts +9 -0
  305. package/dist/rest/namespaces/logs.resources.generated.js +17 -0
  306. package/dist/rest/namespaces/logs.resources.generated.js.map +1 -0
  307. package/dist/rest/namespaces/logs.types.generated.d.ts +131 -0
  308. package/dist/rest/namespaces/logs.types.generated.js +8 -0
  309. package/dist/rest/namespaces/logs.types.generated.js.map +1 -0
  310. package/dist/rest/namespaces/lookup.d.ts +3 -25
  311. package/dist/rest/namespaces/lookup.js +3 -27
  312. package/dist/rest/namespaces/lookup.js.map +1 -1
  313. package/dist/rest/namespaces/message.resources.generated.d.ts +6 -0
  314. package/dist/rest/namespaces/message.resources.generated.js +14 -0
  315. package/dist/rest/namespaces/message.resources.generated.js.map +1 -0
  316. package/dist/rest/namespaces/message.types.generated.d.ts +122 -0
  317. package/dist/rest/namespaces/message.types.generated.js +8 -0
  318. package/dist/rest/namespaces/message.types.generated.js.map +1 -0
  319. package/dist/rest/namespaces/messages.resources.generated.d.ts +18 -0
  320. package/dist/rest/namespaces/messages.resources.generated.js +44 -0
  321. package/dist/rest/namespaces/messages.resources.generated.js.map +1 -0
  322. package/dist/rest/namespaces/messages.types.generated.d.ts +99 -0
  323. package/dist/rest/namespaces/messages.types.generated.js +8 -0
  324. package/dist/rest/namespaces/messages.types.generated.js.map +1 -0
  325. package/dist/rest/namespaces/mfa.d.ts +3 -42
  326. package/dist/rest/namespaces/mfa.js +3 -49
  327. package/dist/rest/namespaces/mfa.js.map +1 -1
  328. package/dist/rest/namespaces/number-groups.d.ts +3 -45
  329. package/dist/rest/namespaces/number-groups.js +3 -53
  330. package/dist/rest/namespaces/number-groups.js.map +1 -1
  331. package/dist/rest/namespaces/phone-numbers.d.ts +9 -57
  332. package/dist/rest/namespaces/phone-numbers.js +9 -63
  333. package/dist/rest/namespaces/phone-numbers.js.map +1 -1
  334. package/dist/rest/namespaces/project.d.ts +6 -42
  335. package/dist/rest/namespaces/project.js +6 -51
  336. package/dist/rest/namespaces/project.js.map +1 -1
  337. package/dist/rest/namespaces/project.resources.generated.d.ts +17 -0
  338. package/dist/rest/namespaces/project.resources.generated.js +44 -0
  339. package/dist/rest/namespaces/project.resources.generated.js.map +1 -0
  340. package/dist/rest/namespaces/project.types.generated.d.ts +58 -0
  341. package/dist/rest/namespaces/project.types.generated.js +8 -0
  342. package/dist/rest/namespaces/project.types.generated.js.map +1 -0
  343. package/dist/rest/namespaces/projects.resources.generated.d.ts +12 -0
  344. package/dist/rest/namespaces/projects.resources.generated.js +25 -0
  345. package/dist/rest/namespaces/projects.resources.generated.js.map +1 -0
  346. package/dist/rest/namespaces/projects.types.generated.d.ts +77 -0
  347. package/dist/rest/namespaces/projects.types.generated.js +8 -0
  348. package/dist/rest/namespaces/projects.types.generated.js.map +1 -0
  349. package/dist/rest/namespaces/pubsub.d.ts +4 -18
  350. package/dist/rest/namespaces/pubsub.js +4 -21
  351. package/dist/rest/namespaces/pubsub.js.map +1 -1
  352. package/dist/rest/namespaces/pubsub.resources.generated.d.ts +12 -0
  353. package/dist/rest/namespaces/pubsub.resources.generated.js +29 -0
  354. package/dist/rest/namespaces/pubsub.resources.generated.js.map +1 -0
  355. package/dist/rest/namespaces/pubsub.types.generated.d.ts +60 -0
  356. package/dist/rest/namespaces/pubsub.types.generated.js +8 -0
  357. package/dist/rest/namespaces/pubsub.types.generated.js.map +1 -0
  358. package/dist/rest/namespaces/queues.d.ts +3 -38
  359. package/dist/rest/namespaces/queues.js +3 -44
  360. package/dist/rest/namespaces/queues.js.map +1 -1
  361. package/dist/rest/namespaces/recordings.d.ts +3 -34
  362. package/dist/rest/namespaces/recordings.js +3 -40
  363. package/dist/rest/namespaces/recordings.js.map +1 -1
  364. package/dist/rest/namespaces/registry.d.ts +6 -137
  365. package/dist/rest/namespaces/registry.js +6 -173
  366. package/dist/rest/namespaces/registry.js.map +1 -1
  367. package/dist/rest/namespaces/relay-rest.resources.generated.d.ts +168 -0
  368. package/dist/rest/namespaces/relay-rest.resources.generated.js +430 -0
  369. package/dist/rest/namespaces/relay-rest.resources.generated.js.map +1 -0
  370. package/dist/rest/namespaces/relay-rest.types.generated.d.ts +1906 -0
  371. package/dist/rest/namespaces/relay-rest.types.generated.js +8 -0
  372. package/dist/rest/namespaces/relay-rest.types.generated.js.map +1 -0
  373. package/dist/rest/namespaces/short-codes.d.ts +3 -35
  374. package/dist/rest/namespaces/short-codes.js +3 -41
  375. package/dist/rest/namespaces/short-codes.js.map +1 -1
  376. package/dist/rest/namespaces/sip-profile.d.ts +3 -24
  377. package/dist/rest/namespaces/sip-profile.js +3 -29
  378. package/dist/rest/namespaces/sip-profile.js.map +1 -1
  379. package/dist/rest/namespaces/verified-callers.d.ts +3 -29
  380. package/dist/rest/namespaces/verified-callers.js +3 -34
  381. package/dist/rest/namespaces/verified-callers.js.map +1 -1
  382. package/dist/rest/namespaces/video.d.ts +10 -227
  383. package/dist/rest/namespaces/video.js +10 -288
  384. package/dist/rest/namespaces/video.js.map +1 -1
  385. package/dist/rest/namespaces/video.resources.generated.d.ts +81 -0
  386. package/dist/rest/namespaces/video.resources.generated.js +171 -0
  387. package/dist/rest/namespaces/video.resources.generated.js.map +1 -0
  388. package/dist/rest/namespaces/video.types.generated.d.ts +771 -0
  389. package/dist/rest/namespaces/video.types.generated.js +8 -0
  390. package/dist/rest/namespaces/video.types.generated.js.map +1 -0
  391. package/dist/rest/namespaces/voice.resources.generated.d.ts +9 -0
  392. package/dist/rest/namespaces/voice.resources.generated.js +17 -0
  393. package/dist/rest/namespaces/voice.resources.generated.js.map +1 -0
  394. package/dist/rest/namespaces/voice.types.generated.d.ts +214 -0
  395. package/dist/rest/namespaces/voice.types.generated.js +8 -0
  396. package/dist/rest/namespaces/voice.types.generated.js.map +1 -0
  397. package/dist/rest/pagination.d.ts +5 -1
  398. package/dist/rest/pagination.js +40 -20
  399. package/dist/rest/pagination.js.map +1 -1
  400. package/dist/rest/types.d.ts +21 -3
  401. package/dist/schema.json +299 -98
  402. package/dist/skills/SkillBase.d.ts +97 -20
  403. package/dist/skills/SkillBase.js +100 -17
  404. package/dist/skills/SkillBase.js.map +1 -1
  405. package/dist/skills/SkillManager.d.ts +66 -13
  406. package/dist/skills/SkillManager.js +101 -20
  407. package/dist/skills/SkillManager.js.map +1 -1
  408. package/dist/skills/SkillName.d.ts +44 -0
  409. package/dist/skills/SkillName.js +2 -0
  410. package/dist/skills/SkillName.js.map +1 -0
  411. package/dist/skills/SkillRegistry.d.ts +47 -7
  412. package/dist/skills/SkillRegistry.js +85 -13
  413. package/dist/skills/SkillRegistry.js.map +1 -1
  414. package/dist/skills/builtin/api_ninjas_trivia.d.ts +3 -1
  415. package/dist/skills/builtin/api_ninjas_trivia.js +24 -8
  416. package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -1
  417. package/dist/skills/builtin/ask_claude.d.ts +14 -4
  418. package/dist/skills/builtin/ask_claude.js +36 -14
  419. package/dist/skills/builtin/ask_claude.js.map +1 -1
  420. package/dist/skills/builtin/claude_skills.d.ts +3 -1
  421. package/dist/skills/builtin/claude_skills.js +19 -15
  422. package/dist/skills/builtin/claude_skills.js.map +1 -1
  423. package/dist/skills/builtin/custom_skills.d.ts +10 -3
  424. package/dist/skills/builtin/custom_skills.js +26 -9
  425. package/dist/skills/builtin/custom_skills.js.map +1 -1
  426. package/dist/skills/builtin/datasphere.d.ts +5 -3
  427. package/dist/skills/builtin/datasphere.js +34 -25
  428. package/dist/skills/builtin/datasphere.js.map +1 -1
  429. package/dist/skills/builtin/datasphere_serverless.d.ts +12 -1
  430. package/dist/skills/builtin/datasphere_serverless.js +17 -6
  431. package/dist/skills/builtin/datasphere_serverless.js.map +1 -1
  432. package/dist/skills/builtin/datetime.d.ts +3 -1
  433. package/dist/skills/builtin/datetime.js +11 -7
  434. package/dist/skills/builtin/datetime.js.map +1 -1
  435. package/dist/skills/builtin/google_maps.d.ts +29 -14
  436. package/dist/skills/builtin/google_maps.js +89 -269
  437. package/dist/skills/builtin/google_maps.js.map +1 -1
  438. package/dist/skills/builtin/index.d.ts +8 -6
  439. package/dist/skills/builtin/index.js +8 -6
  440. package/dist/skills/builtin/index.js.map +1 -1
  441. package/dist/skills/builtin/info_gatherer.d.ts +4 -2
  442. package/dist/skills/builtin/info_gatherer.js +20 -12
  443. package/dist/skills/builtin/info_gatherer.js.map +1 -1
  444. package/dist/skills/builtin/joke.d.ts +16 -6
  445. package/dist/skills/builtin/joke.js +54 -37
  446. package/dist/skills/builtin/joke.js.map +1 -1
  447. package/dist/skills/builtin/math.d.ts +3 -1
  448. package/dist/skills/builtin/math.js +14 -9
  449. package/dist/skills/builtin/math.js.map +1 -1
  450. package/dist/skills/builtin/mcp_gateway.d.ts +34 -5
  451. package/dist/skills/builtin/mcp_gateway.js +77 -46
  452. package/dist/skills/builtin/mcp_gateway.js.map +1 -1
  453. package/dist/skills/builtin/native_vector_search.d.ts +19 -5
  454. package/dist/skills/builtin/native_vector_search.js +179 -61
  455. package/dist/skills/builtin/native_vector_search.js.map +1 -1
  456. package/dist/skills/builtin/play_background_file.d.ts +21 -15
  457. package/dist/skills/builtin/play_background_file.js +43 -122
  458. package/dist/skills/builtin/play_background_file.js.map +1 -1
  459. package/dist/skills/builtin/spider.d.ts +46 -1
  460. package/dist/skills/builtin/spider.js +317 -101
  461. package/dist/skills/builtin/spider.js.map +1 -1
  462. package/dist/skills/builtin/swml_transfer.d.ts +14 -3
  463. package/dist/skills/builtin/swml_transfer.js +45 -24
  464. package/dist/skills/builtin/swml_transfer.js.map +1 -1
  465. package/dist/skills/builtin/weather_api.d.ts +24 -13
  466. package/dist/skills/builtin/weather_api.js +57 -31
  467. package/dist/skills/builtin/weather_api.js.map +1 -1
  468. package/dist/skills/builtin/web_search.d.ts +48 -10
  469. package/dist/skills/builtin/web_search.js +301 -84
  470. package/dist/skills/builtin/web_search.js.map +1 -1
  471. package/dist/skills/builtin/wikipedia_search.d.ts +4 -2
  472. package/dist/skills/builtin/wikipedia_search.js +32 -14
  473. package/dist/skills/builtin/wikipedia_search.js.map +1 -1
  474. package/dist/skills/index.d.ts +3 -2
  475. package/dist/skills/index.js +1 -1
  476. package/dist/skills/index.js.map +1 -1
  477. package/dist/swml_verbs_generated.d.ts +2824 -0
  478. package/dist/swml_verbs_generated.js +12 -0
  479. package/dist/swml_verbs_generated.js.map +1 -0
  480. package/dist/types.d.ts +65 -6
  481. package/dist/web.d.ts +27 -0
  482. package/dist/web.js +20 -0
  483. package/dist/web.js.map +1 -0
  484. package/docs/agent-guide.md +1034 -0
  485. package/docs/ai_chat.md +560 -0
  486. package/docs/api-reference.md +3534 -0
  487. package/docs/architecture.md +846 -0
  488. package/docs/bedrock_agent.md +411 -0
  489. package/docs/cli-guide.md +403 -0
  490. package/docs/cloud_functions_guide.md +399 -0
  491. package/docs/configuration.md +548 -0
  492. package/docs/contexts-guide.md +884 -0
  493. package/docs/datamap-guide.md +1160 -0
  494. package/docs/developer_pain_points.md +548 -0
  495. package/docs/llm_parameters.md +298 -0
  496. package/docs/mcp_gateway_reference.md +354 -0
  497. package/docs/mcp_integration.md +162 -0
  498. package/docs/pgi_agent_guide.md +1820 -0
  499. package/docs/prefabs-guide.md +815 -0
  500. package/docs/programmatically_governed_inference.md +301 -0
  501. package/docs/sdk_features.md +501 -0
  502. package/docs/security.md +559 -0
  503. package/docs/serverless-guide.md +520 -0
  504. package/docs/skills-guide.md +1223 -0
  505. package/docs/skills-system.md +405 -0
  506. package/docs/skills_parameter_schema.md +417 -0
  507. package/docs/swaig-reference.md +1938 -0
  508. package/docs/swml_service_guide.md +573 -0
  509. package/docs/third_party_skills.md +410 -0
  510. package/docs/web_service.md +666 -0
  511. package/examples/README.md +202 -0
  512. package/examples/advanced-datamap.ts +108 -0
  513. package/examples/advanced-dynamic-config.ts +70 -0
  514. package/examples/auto-vivified.ts +95 -0
  515. package/examples/call-flow.ts +65 -0
  516. package/examples/comprehensive-dynamic.ts +125 -0
  517. package/examples/contexts-steps.ts +65 -0
  518. package/examples/custom-path.ts +45 -0
  519. package/examples/datamap-tools.ts +51 -0
  520. package/examples/datasphere-multi-instance.ts +66 -0
  521. package/examples/datasphere-serverless-env.ts +87 -0
  522. package/examples/datasphere-webhook-env.ts +65 -0
  523. package/examples/datasphere.ts +56 -0
  524. package/examples/declarative.ts +100 -0
  525. package/examples/dynamic-config.ts +54 -0
  526. package/examples/dynamic-info-gatherer.ts +69 -0
  527. package/examples/dynamic-swml-service.ts +67 -0
  528. package/examples/gather-info.ts +95 -0
  529. package/examples/gather-per-question-functions-demo.ts +139 -0
  530. package/examples/joke-agent.ts +34 -0
  531. package/examples/kubernetes-agent.ts +45 -0
  532. package/examples/llm-params.ts +75 -0
  533. package/examples/mcp-agent.ts +89 -0
  534. package/examples/mcp-gateway.ts +81 -0
  535. package/examples/multi-agent.ts +80 -0
  536. package/examples/multi-endpoint.ts +79 -0
  537. package/examples/pgi/case-domain.ts +114 -0
  538. package/examples/pgi/serve.ts +16 -0
  539. package/examples/pgi/support-agent.ts +265 -0
  540. package/examples/pom-prompt.ts +70 -0
  541. package/examples/prefab-concierge.ts +42 -0
  542. package/examples/prefab-faq.ts +58 -0
  543. package/examples/prefab-info-gatherer.ts +33 -0
  544. package/examples/prefab-receptionist.ts +36 -0
  545. package/examples/prefab-survey.ts +69 -0
  546. package/examples/quickstart-agent.ts +29 -0
  547. package/examples/quickstart-relay.ts +25 -0
  548. package/examples/quickstart-rest.ts +25 -0
  549. package/examples/record-call.ts +65 -0
  550. package/examples/relay-demo.ts +33 -0
  551. package/examples/room-and-sip.ts +93 -0
  552. package/examples/serverless-lambda.ts +43 -0
  553. package/examples/session-state.ts +83 -0
  554. package/examples/simple-agent.ts +36 -0
  555. package/examples/simple-static.ts +29 -0
  556. package/examples/skills-demo.ts +41 -0
  557. package/examples/step-function-inheritance-demo.ts +124 -0
  558. package/examples/swaig-features.ts +193 -0
  559. package/examples/swml-service-routing.ts +66 -0
  560. package/examples/swml-service.ts +38 -0
  561. package/examples/swmlservice_ai_sidecar.ts +104 -0
  562. package/examples/swmlservice_swaig_standalone.ts +79 -0
  563. package/examples/tap.ts +67 -0
  564. package/examples/typed-tools.ts +68 -0
  565. package/examples/verb-methods.ts +45 -0
  566. package/examples/web-search-multi-instance.ts +75 -0
  567. package/examples/web-search.ts +38 -0
  568. package/examples/wikipedia.ts +36 -0
  569. package/livewire/README.md +164 -0
  570. package/livewire/docs/migration-guide.md +251 -0
  571. package/livewire/examples/livewire-basic-agent.ts +74 -0
  572. package/livewire/examples/livewire-handoff.ts +196 -0
  573. package/livewire/examples/livewire-multi-tool.ts +121 -0
  574. package/package.json +88 -13
  575. package/relay/README.md +101 -0
  576. package/relay/docs/call-methods.md +622 -0
  577. package/relay/docs/client-reference.md +281 -0
  578. package/relay/docs/events.md +193 -0
  579. package/relay/docs/getting-started.md +221 -0
  580. package/relay/docs/guide.md +386 -0
  581. package/relay/docs/messaging.md +246 -0
  582. package/relay/examples/relay-inbound.ts +66 -0
  583. package/relay/examples/relay-messaging.ts +74 -0
  584. package/relay/examples/relay-outbound.ts +76 -0
  585. package/rest/README.md +141 -0
  586. package/rest/docs/calling.md +313 -0
  587. package/rest/docs/client-reference.md +149 -0
  588. package/rest/docs/fabric.md +192 -0
  589. package/rest/docs/getting-started.md +138 -0
  590. package/rest/docs/guide.md +421 -0
  591. package/rest/docs/namespaces.md +367 -0
  592. package/rest/docs/phone-binding.md +116 -0
  593. package/rest/examples/rest-10dlc-registration.ts +177 -0
  594. package/rest/examples/rest-bind-phone-to-swml-webhook.ts +66 -0
  595. package/rest/examples/rest-calling-ivr-and-ai.ts +136 -0
  596. package/rest/examples/rest-calling-play-and-record.ts +98 -0
  597. package/rest/examples/rest-client.ts +59 -0
  598. package/rest/examples/rest-datasphere-search.ts +81 -0
  599. package/rest/examples/rest-fabric-conferences-and-routing.ts +147 -0
  600. package/rest/examples/rest-fabric-subscribers-and-sip.ts +106 -0
  601. package/rest/examples/rest-fabric-swml-and-callflows.ts +101 -0
  602. package/rest/examples/rest-manage-resources.ts +64 -0
  603. package/rest/examples/rest-phone-number-management.ts +200 -0
  604. package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
  605. package/rest/examples/rest-video-rooms.ts +186 -0
  606. package/tutorial/fred/fred.ts +218 -0
  607. package/tutorial/fred/tutorial/01-introduction.md +141 -0
  608. package/tutorial/fred/tutorial/02-setup.md +304 -0
  609. package/tutorial/fred/tutorial/03-basic-agent.md +284 -0
  610. package/tutorial/fred/tutorial/04-wikipedia-skill.md +298 -0
  611. package/tutorial/fred/tutorial/05-custom-functions.md +347 -0
  612. package/tutorial/fred/tutorial/06-running-testing.md +642 -0
  613. package/tutorial/fred/tutorial/README.md +56 -0
  614. package/tutorial/fred/tutorial/appendix-complete-code.md +632 -0
  615. package/tutorial/fred/tutorial/appendix-docker-deployment.md +504 -0
  616. package/tutorial/full-guardrails-agent/handlers.ts +436 -0
  617. package/tutorial/full-guardrails-agent/penny.ts +305 -0
  618. package/tutorial/full-guardrails-agent/reservations.ts +1109 -0
  619. package/tutorial/full-guardrails-agent/tutorial/01-why-guardrails.md +149 -0
  620. package/tutorial/full-guardrails-agent/tutorial/02-design-first.md +139 -0
  621. package/tutorial/full-guardrails-agent/tutorial/03-rules-first.md +422 -0
  622. package/tutorial/full-guardrails-agent/tutorial/04-the-shell.md +238 -0
  623. package/tutorial/full-guardrails-agent/tutorial/05-steps-and-scoping.md +247 -0
  624. package/tutorial/full-guardrails-agent/tutorial/06-tools-that-decide.md +467 -0
  625. package/tutorial/full-guardrails-agent/tutorial/07-gather-and-projection.md +160 -0
  626. package/tutorial/full-guardrails-agent/tutorial/08-the-verification-gate.md +333 -0
  627. package/tutorial/full-guardrails-agent/tutorial/09-people-and-endings.md +313 -0
  628. package/tutorial/full-guardrails-agent/tutorial/10-testing-and-running.md +387 -0
  629. package/tutorial/full-guardrails-agent/tutorial/README.md +106 -0
  630. package/tutorial/full-guardrails-agent/tutorial/appendix-complete-code.md +2207 -0
  631. package/tutorial/full-guardrails-agent/tutorial/appendix-deployment.md +191 -0
  632. package/tutorial/full-guardrails-agent/tutorial/appendix-technique-map.md +117 -0
  633. package/tutorial/full-guardrails-agent/workflow.ts +219 -0
  634. package/tutorial/multi_agents/README.md +175 -0
  635. package/tutorial/multi_agents/advanced_agent.ts +395 -0
  636. package/tutorial/multi_agents/extending_agents.ts +641 -0
  637. package/tutorial/multi_agents/knowledge.ts +59 -0
  638. package/tutorial/multi_agents/lesson1_first_agent.md +368 -0
  639. package/tutorial/multi_agents/lesson2_knowledge_bases.md +404 -0
  640. package/tutorial/multi_agents/lesson3_multi_agent_systems.md +621 -0
  641. package/tutorial/multi_agents/lesson4_advanced_features.md +805 -0
  642. package/tutorial/multi_agents/lesson5_extending_agents.md +856 -0
  643. package/tutorial/multi_agents/pc_builder.ts +529 -0
  644. package/tutorial/multi_agents/sales_agent.ts +88 -0
  645. package/tutorial/multi_agents/sales_agent_with_search.ts +116 -0
  646. package/tutorial/multi_agents/sales_knowledge.md +139 -0
  647. package/tutorial/multi_agents/support_knowledge.md +256 -0
  648. package/dist/cli/mock-data.d.ts +0 -37
  649. package/dist/cli/mock-data.js +0 -80
  650. package/dist/cli/mock-data.js.map +0 -1
  651. package/dist/generateVerbTypes.d.ts +0 -11
  652. package/dist/generateVerbTypes.js +0 -265
  653. package/dist/generateVerbTypes.js.map +0 -1
  654. package/dist/rest/namespaces/compat.d.ts +0 -585
  655. package/dist/rest/namespaces/compat.js +0 -735
  656. package/dist/rest/namespaces/compat.js.map +0 -1
@@ -11,8 +11,8 @@
11
11
  * - Execute queue for requests while disconnected
12
12
  * - Auto-reconnect with exponential backoff
13
13
  */
14
- /* eslint-disable @typescript-eslint/no-explicit-any */
15
14
  import { randomUUID } from 'node:crypto';
15
+ import { createRequire } from 'node:module';
16
16
  import { getLogger } from '../Logger.js';
17
17
  import { Call } from './Call.js';
18
18
  import { createDeferred } from './Deferred.js';
@@ -21,9 +21,49 @@ import { Message } from './Message.js';
21
21
  import { normalizeDevicePlan } from './normalize.js';
22
22
  import { RelayError } from './RelayError.js';
23
23
  // Polyfill Symbol.asyncDispose for runtimes that don't have it yet (Node <20.4)
24
- // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
25
24
  Symbol.asyncDispose ??= Symbol.for('Symbol.asyncDispose');
26
25
  const logger = getLogger('relay_client');
26
+ /**
27
+ * Extra `ws` connection options trusting a custom RELAY CA bundle, read from
28
+ * `SIGNALWIRE_RELAY_CA_FILE` (A5 fleet CA-var contract, hard-cut, no aliases).
29
+ * When the env var names a CA bundle it becomes the RELAY WebSocket transport's
30
+ * TLS trust root (`ws` forwards `ca` to the underlying `tls.connect`), the exact
31
+ * RELAY half of the fleet pair (`SIGNALWIRE_REST_CA_FILE` is the REST half).
32
+ * Unset → node's default trust store (`{}`). Mirrors the python reference
33
+ * (`relay/client.py:134` `_build_relay_ssl_context` → `websockets.connect(ssl=)`).
34
+ *
35
+ * Read at connect time (not module load) so a var set after import is honored,
36
+ * matching the REST half. Returns `{}` when unset or the file can't be read.
37
+ */
38
+ function relayCaWsOptions() {
39
+ const caFile = process.env['SIGNALWIRE_RELAY_CA_FILE'];
40
+ if (!caFile)
41
+ return {};
42
+ try {
43
+ const require = createRequire(import.meta.url);
44
+ const { readFileSync } = require('node:fs');
45
+ return { ca: readFileSync(caFile) };
46
+ }
47
+ catch (err) {
48
+ logger.warn(`relay_ca_file_load_failed file=${caFile} error=${String(err)}`);
49
+ return {};
50
+ }
51
+ }
52
+ /**
53
+ * Read a positive numeric override from the environment, falling back to a
54
+ * default when unset, empty, or non-numeric. Used for the liveness-timing knobs
55
+ * (ping interval / max failures / request timeout / reconnect delays) so a
56
+ * bounded test window can exercise the half-open / black-hole / reconnect paths
57
+ * without changing production defaults. Mirrors the `RELAY_MAX_CONNECTIONS`
58
+ * env-read pattern already in this module.
59
+ */
60
+ function _envNum(name, fallback) {
61
+ const raw = process.env[name];
62
+ if (raw == null || raw === '')
63
+ return fallback;
64
+ const parsed = Number(raw);
65
+ return Number.isFinite(parsed) && parsed > 0 ? parsed : fallback;
66
+ }
27
67
  // Any 2xx code is considered success
28
68
  const SUCCESS_CODE_RE = /^2\d{2}$/;
29
69
  // Safety limits
@@ -66,7 +106,8 @@ const _activeClients = new Set();
66
106
  *
67
107
  * client.onCall(async (call) => {
68
108
  * await call.answer();
69
- * await call.playTTS({ text: 'Thanks for calling!' });
109
+ * const played = await call.play([{ type: 'tts', text: 'Thanks for calling!' }]);
110
+ * await played.wait();
70
111
  * await call.hangup();
71
112
  * });
72
113
  *
@@ -75,11 +116,13 @@ const _activeClients = new Set();
75
116
  *
76
117
  * @example Outbound dial + SMS
77
118
  * ```ts
119
+ * import { RelayClient } from '@signalwire/sdk';
120
+ * const client = new RelayClient();
78
121
  * await client.connect();
79
- * const call = await client.dial({
80
- * devices: [[{ type: 'phone', to: '+15551234567', from: '+15557654321' }]],
81
- * });
82
- * await client.sendMessage({ to: '+15551234567', from: '+15557654321', body: 'Hi!' });
122
+ * const call = await client.dial([
123
+ * [{ type: 'phone', to: '+15551234567', from: '+15557654321' }],
124
+ * ]);
125
+ * await client.sendMessage({ toNumber: '+15551234567', fromNumber: '+15557654321', body: 'Hi!' });
83
126
  * ```
84
127
  *
85
128
  * @see {@link Call}
@@ -94,6 +137,11 @@ export class RelayClient {
94
137
  jwtToken;
95
138
  /** Hostname of the RELAY endpoint (e.g. `example.signalwire.com`). */
96
139
  host;
140
+ /**
141
+ * WebSocket scheme — `'wss'` (production) or `'ws'` (loopback audits).
142
+ * See {@link RelayClientOptions.scheme} for the full rationale.
143
+ */
144
+ scheme;
97
145
  /** Contexts this client subscribes to for inbound events. */
98
146
  contexts;
99
147
  _ws = null;
@@ -106,16 +154,35 @@ export class RelayClient {
106
154
  _executeQueue = [];
107
155
  _onCallHandler = null;
108
156
  _onMessageHandler = null;
157
+ // Optional low-level observer fired BEFORE the typed-call/message
158
+ // routing in `_handleEvent`. Used by `examples/relay_audit_harness.ts`
159
+ // to react to every inbound `signalwire.event` (including state changes
160
+ // for calls the harness never originated). Production users prefer
161
+ // `onCall` / `onMessage` for typed delivery.
162
+ _onAnyEventHandler = null;
109
163
  _connected = false;
110
164
  _closing = false;
111
165
  _reconnectDelay = RECONNECT_MIN_DELAY;
112
166
  _relayProtocol = '';
113
167
  _identity = '';
168
+ _sessionId = '';
114
169
  _authorizationState = '';
115
170
  _pingInterval = null;
116
171
  _pingFailures = 0;
117
172
  _serverPingTimeout = null;
118
173
  _maxActiveCalls = DEFAULT_MAX_ACTIVE_CALLS;
174
+ // Liveness timings. Default to the module constants; overridable via env so a
175
+ // half-open/black-hole/reconnect scenario can be exercised inside a bounded
176
+ // test window (RELAY-LIVENESS behavioral gate) — the exact analog of the
177
+ // python reference's monkeypatchable `_CLIENT_PING_INTERVAL` / `_EXECUTE_TIMEOUT`
178
+ // / `RECONNECT_MIN_DELAY` module constants and go's `WithPingWatchdog` /
179
+ // `WithExecuteTimeout` / `WithReconnectBackoff` options. Production behavior is
180
+ // unchanged when the env vars are unset.
181
+ _clientPingIntervalMs = _envNum('SIGNALWIRE_RELAY_PING_INTERVAL_MS', CLIENT_PING_INTERVAL);
182
+ _clientPingMaxFailures = _envNum('SIGNALWIRE_RELAY_PING_MAX_FAILURES', CLIENT_PING_MAX_FAILURES);
183
+ _requestTimeoutMs = _envNum('SIGNALWIRE_RELAY_REQUEST_TIMEOUT_MS', REQUEST_TIMEOUT);
184
+ _reconnectMinDelay = _envNum('SIGNALWIRE_RELAY_RECONNECT_MIN_DELAY_S', RECONNECT_MIN_DELAY);
185
+ _reconnectMaxDelay = _envNum('SIGNALWIRE_RELAY_RECONNECT_MAX_DELAY_S', RECONNECT_MAX_DELAY);
119
186
  // For run() — resolves when shutdown requested
120
187
  _shutdownDeferred = null;
121
188
  _signalHandlers = [];
@@ -134,7 +201,27 @@ export class RelayClient {
134
201
  this.project = options.project ?? process.env.SIGNALWIRE_PROJECT_ID ?? '';
135
202
  this.token = options.token ?? process.env.SIGNALWIRE_API_TOKEN ?? '';
136
203
  this.jwtToken = options.jwtToken ?? process.env.SIGNALWIRE_JWT_TOKEN ?? '';
137
- this.host = options.host ?? process.env.SIGNALWIRE_SPACE ?? DEFAULT_RELAY_HOST;
204
+ // Host precedence: explicit option > SIGNALWIRE_RELAY_HOST (audit
205
+ // fixtures bind a loopback host:port and set this) > SIGNALWIRE_SPACE
206
+ // (production) > built-in default. The audit-only env var is checked
207
+ // first because it overrides the production env var.
208
+ this.host =
209
+ options.host ??
210
+ process.env.SIGNALWIRE_RELAY_HOST ??
211
+ process.env.SIGNALWIRE_SPACE ??
212
+ DEFAULT_RELAY_HOST;
213
+ // Scheme precedence: explicit option > SIGNALWIRE_RELAY_SCHEME > 'wss'.
214
+ // Only 'ws' and 'wss' are accepted; anything else falls back to 'wss'.
215
+ const envScheme = process.env.SIGNALWIRE_RELAY_SCHEME;
216
+ if (options.scheme === 'ws' || options.scheme === 'wss') {
217
+ this.scheme = options.scheme;
218
+ }
219
+ else if (envScheme === 'ws' || envScheme === 'wss') {
220
+ this.scheme = envScheme;
221
+ }
222
+ else {
223
+ this.scheme = 'wss';
224
+ }
138
225
  this.contexts = options.contexts ?? [];
139
226
  if (this.jwtToken) {
140
227
  // JWT auth — project/token not required
@@ -154,7 +241,8 @@ export class RelayClient {
154
241
  else {
155
242
  const envVal = process.env.RELAY_MAX_ACTIVE_CALLS ?? '';
156
243
  const parsed = parseInt(envVal, 10);
157
- this._maxActiveCalls = envVal && !isNaN(parsed) ? Math.max(1, parsed) : DEFAULT_MAX_ACTIVE_CALLS;
244
+ this._maxActiveCalls =
245
+ envVal && !isNaN(parsed) ? Math.max(1, parsed) : DEFAULT_MAX_ACTIVE_CALLS;
158
246
  }
159
247
  }
160
248
  /** The protocol name the server assigned to this client after `connect()`. */
@@ -166,16 +254,21 @@ export class RelayClient {
166
254
  *
167
255
  * Enables usage with `await using`:
168
256
  * ```ts
169
- * await using client = new RelayClient({ ... });
257
+ * import { RelayClient } from '@signalwire/sdk';
258
+ * await using client = new RelayClient({ project: 'p', token: 't', host: 'example.signalwire.com' });
170
259
  * await client.connect();
171
- * // ... automatically disconnects when scope exits
260
+ * // automatically disconnects when scope exits
172
261
  * ```
173
262
  *
174
263
  * For environments without `await using`, use try/finally:
175
264
  * ```ts
176
- * const client = new RelayClient({ ... });
177
- * try { await client.connect(); ... }
178
- * finally { await client.disconnect(); }
265
+ * import { RelayClient } from '@signalwire/sdk';
266
+ * const client = new RelayClient({ project: 'p', token: 't', host: 'example.signalwire.com' });
267
+ * try {
268
+ * await client.connect();
269
+ * } finally {
270
+ * await client.disconnect();
271
+ * }
179
272
  * ```
180
273
  */
181
274
  async [Symbol.asyncDispose]() {
@@ -211,6 +304,25 @@ export class RelayClient {
211
304
  this._onMessageHandler = handler;
212
305
  return handler;
213
306
  }
307
+ /**
308
+ * Register a low-level observer that fires for every inbound
309
+ * `signalwire.event`, regardless of event type or whether a typed
310
+ * Call / Message could be matched.
311
+ *
312
+ * Most users want {@link onCall} / {@link onMessage} — those deliver
313
+ * typed objects and handle correlation. `onEvent` is the generic
314
+ * escape hatch for reacting to every event the platform pushes.
315
+ *
316
+ * Fires BEFORE typed routing, so the same event will be observed here
317
+ * AND on any matching {@link Call} / {@link Message}.
318
+ *
319
+ * @param handler - Callback receiving `(eventType, params)`. May be async.
320
+ * @returns The same handler, for decorator-style usage.
321
+ */
322
+ onEvent(handler) {
323
+ this._onAnyEventHandler = handler;
324
+ return handler;
325
+ }
214
326
  // ─── Connection Lifecycle ──────────────────────────────────────
215
327
  /**
216
328
  * Connect to RELAY and authenticate.
@@ -240,14 +352,15 @@ export class RelayClient {
240
352
  `RELAY_MAX_CONNECTIONS env var to allow more.`);
241
353
  }
242
354
  _activeClients.add(this);
243
- const uri = `wss://${this.host}`;
355
+ // Build the WS URI from the configured scheme + host. Production is
356
+ // always `wss://${host}`; the audit harness flips to `ws://${host:port}`
357
+ // to drive a loopback fixture without TLS.
358
+ const uri = `${this.scheme}://${this.host}`;
244
359
  logger.info(`Connecting to ${uri}`);
245
- const ws = this._wsFactory
246
- ? this._wsFactory(uri)
247
- : await this._createWebSocket(uri);
360
+ const ws = this._wsFactory ? this._wsFactory(uri) : await this._createWebSocket(uri);
248
361
  this._ws = ws;
249
362
  this._connected = true;
250
- this._reconnectDelay = RECONNECT_MIN_DELAY;
363
+ this._reconnectDelay = this._reconnectMinDelay;
251
364
  // Set up message handling
252
365
  this._setupWsListeners(ws);
253
366
  // Authenticate
@@ -261,18 +374,40 @@ export class RelayClient {
261
374
  }
262
375
  /** Create a real WebSocket (uses dynamic import for ws). */
263
376
  async _createWebSocket(uri) {
264
- // eslint-disable-next-line @typescript-eslint/no-var-requires
265
377
  const wsModule = await import('ws');
266
378
  const WS = wsModule.default ?? wsModule;
267
- const ws = new WS(uri, { maxPayload: 10 * 1024 * 1024 });
379
+ const ws = new WS(uri, {
380
+ maxPayload: 10 * 1024 * 1024,
381
+ ...relayCaWsOptions(),
382
+ });
268
383
  // Wait for the socket to finish the handshake before the caller tries to
269
384
  // send signalwire.connect — otherwise send() throws "readyState 0".
270
385
  await new Promise((resolve, reject) => {
271
- ws.on('open', resolve);
272
- ws.on('error', reject);
386
+ ws.on('open', () => resolve());
387
+ ws.on('error', (err) => reject(err));
273
388
  });
274
389
  return ws;
275
390
  }
391
+ /**
392
+ * Return a log-safe repr of a raw RELAY frame with credential VALUES masked.
393
+ *
394
+ * SECRET-SCRUB (enterprise F3.1/F3.2): a `SIGNALWIRE_LOG_LEVEL=debug` session
395
+ * must never emit live credentials or the re-auth blob. Mirrors the python
396
+ * reference `_scrub_frame` (key-shape mask of "token"/"project"/"jwt_token"/
397
+ * "authorization_state" JSON values) composed with `_scrub_log` (verbatim
398
+ * masking of THIS connection's live credential values wherever they appear —
399
+ * e.g. a project value the server reflects into a non-credential `identity`
400
+ * field). Never a no-op: the raw frame + the identity diagnostic are the two
401
+ * enterprise-flagged leak sites.
402
+ */
403
+ _scrubLog(text) {
404
+ let out = text.replace(/("(?:token|project|jwt_token|authorization_state)"\s*:\s*)"(?:\\.|[^"\\])*"/g, '$1"***"');
405
+ for (const value of [this.project, this.token, this.jwtToken, this._authorizationState]) {
406
+ if (value)
407
+ out = out.split(value).join('***');
408
+ }
409
+ return out;
410
+ }
276
411
  _setupWsListeners(ws) {
277
412
  ws.on('message', (data) => {
278
413
  const raw = typeof data === 'string' ? data : data.toString();
@@ -281,10 +416,10 @@ export class RelayClient {
281
416
  msg = JSON.parse(raw);
282
417
  }
283
418
  catch {
284
- logger.warn(`Invalid JSON received: ${raw}`);
419
+ logger.warn(`Invalid JSON received: ${this._scrubLog(raw)}`);
285
420
  return;
286
421
  }
287
- logger.debug(`<< ${raw}`);
422
+ logger.debug(`<< ${this._scrubLog(raw)}`);
288
423
  this._handleMessage(msg).catch((err) => {
289
424
  logger.error(`Error handling message: ${err}`);
290
425
  });
@@ -318,6 +453,17 @@ export class RelayClient {
318
453
  event_acks: true,
319
454
  authentication,
320
455
  };
456
+ // Mirror the project / token at the top level of `params` in addition
457
+ // to under `params.authentication`. Python only nests them; we emit
458
+ // both because the porting-sdk's `audit_relay_handshake.py` fixture
459
+ // looks for `params.project` directly. Production servers ignore
460
+ // duplicate fields, so this is safe in both environments.
461
+ if (!this.jwtToken && this.project) {
462
+ params.project = this.project;
463
+ }
464
+ if (!this.jwtToken && this.token) {
465
+ params.token = this.token;
466
+ }
321
467
  if (this.contexts.length > 0) {
322
468
  params.contexts = this.contexts;
323
469
  }
@@ -330,7 +476,8 @@ export class RelayClient {
330
476
  const result = await this._sendRequest(METHOD_SIGNALWIRE_CONNECT, params);
331
477
  this._relayProtocol = result.protocol ?? this._relayProtocol;
332
478
  this._identity = result.identity ?? this._identity;
333
- logger.debug(`Auth response: protocol=${this._relayProtocol} identity=${this._identity}`);
479
+ this._sessionId = result.sessionid ?? this._sessionId;
480
+ logger.debug(this._scrubLog(`Auth response: protocol=${this._relayProtocol} identity=${this._identity}`));
334
481
  }
335
482
  /**
336
483
  * Cleanly close the connection.
@@ -391,6 +538,27 @@ export class RelayClient {
391
538
  async execute(method, params) {
392
539
  return this._sendRequest(method, params);
393
540
  }
541
+ /**
542
+ * Fire-and-forget JSON-RPC notification (no response awaited).
543
+ *
544
+ * Sends a JSON-RPC frame on the open socket without registering a
545
+ * pending-response future. Used by the audit harness to emit a
546
+ * `signalwire.event`-method frame the fixture watches for; production
547
+ * users should always use {@link execute} instead so the response code
548
+ * is checked.
549
+ *
550
+ * No-ops when the socket is closed.
551
+ *
552
+ * @param method - JSON-RPC method name.
553
+ * @param params - Method params object.
554
+ */
555
+ notify(method, params) {
556
+ if (!this._ws)
557
+ return;
558
+ const id = randomUUID();
559
+ const frame = JSON.stringify({ jsonrpc: '2.0', id, method, params });
560
+ this._ws.send(frame);
561
+ }
394
562
  /**
395
563
  * Initiate an outbound call.
396
564
  *
@@ -410,6 +578,8 @@ export class RelayClient {
410
578
  * @throws {Error} When the dial times out.
411
579
  * @throws {RelayError} When the server rejects the dial request.
412
580
  */
581
+ // The options are written out (the same shape as the exported DialOptions)
582
+ // so the signature snapshot reads them as the reference's keyword arguments.
413
583
  async dial(devices, options = {}) {
414
584
  const dialTag = options.tag ?? randomUUID();
415
585
  const params = {
@@ -430,7 +600,13 @@ export class RelayClient {
430
600
  const timer = setTimeout(() => {
431
601
  reject(new RelayError(-1, `Dial timed out waiting for answer (tag=${dialTag})`));
432
602
  }, timeoutMs);
433
- dialDeferred.promise.then((v) => { clearTimeout(timer); resolve(v); }, (e) => { clearTimeout(timer); reject(e); });
603
+ dialDeferred.promise.then((v) => {
604
+ clearTimeout(timer);
605
+ resolve(v);
606
+ }, (e) => {
607
+ clearTimeout(timer);
608
+ reject(e);
609
+ });
434
610
  });
435
611
  return call;
436
612
  }
@@ -467,11 +643,13 @@ export class RelayClient {
467
643
  * @returns A {@link Message} tracking the outbound send.
468
644
  * @throws {RelayError} When the server rejects the send request.
469
645
  */
646
+ // Written out, the same shape as the exported SendMessageOptions (see dial()).
470
647
  async sendMessage(options) {
471
648
  if (!options.body && (!options.media || options.media.length === 0)) {
472
649
  throw new Error('At least one of body or media is required');
473
650
  }
474
- const msgContext = options.context ?? this._relayProtocol ?? 'default';
651
+ // `||`, not `??`: the protocol is '' until the server assigns one.
652
+ const msgContext = options.context || this._relayProtocol || 'default';
475
653
  const params = {
476
654
  context: msgContext,
477
655
  to_number: options.toNumber,
@@ -602,7 +780,7 @@ export class RelayClient {
602
780
  });
603
781
  if (this._closing)
604
782
  break;
605
- this._reconnectDelay = Math.min(this._reconnectDelay * RECONNECT_BACKOFF_FACTOR, RECONNECT_MAX_DELAY);
783
+ this._reconnectDelay = Math.min(this._reconnectDelay * RECONNECT_BACKOFF_FACTOR, this._reconnectMaxDelay);
606
784
  }
607
785
  }
608
786
  finally {
@@ -646,8 +824,14 @@ export class RelayClient {
646
824
  if (method !== METHOD_SIGNALWIRE_CONNECT) {
647
825
  this._forceClose();
648
826
  }
649
- }, REQUEST_TIMEOUT);
650
- deferred.promise.then((v) => { clearTimeout(timer); resolve(v); }, (e) => { clearTimeout(timer); reject(e); });
827
+ }, this._requestTimeoutMs);
828
+ deferred.promise.then((v) => {
829
+ clearTimeout(timer);
830
+ resolve(v);
831
+ }, (e) => {
832
+ clearTimeout(timer);
833
+ reject(e);
834
+ });
651
835
  });
652
836
  }
653
837
  finally {
@@ -706,7 +890,9 @@ export class RelayClient {
706
890
  const reqId = msg.id;
707
891
  const deferred = this._pending.get(reqId);
708
892
  if (deferred && !deferred.settled) {
709
- const error = typeof msg.error === 'object' ? msg.error : { code: -1, message: String(msg.error) };
893
+ const error = typeof msg.error === 'object' && msg.error !== null
894
+ ? msg.error
895
+ : { code: -1, message: String(msg.error) };
710
896
  deferred.reject(new RelayError(error.code ?? -1, String(error.message ?? 'Unknown error')));
711
897
  }
712
898
  return;
@@ -721,12 +907,13 @@ export class RelayClient {
721
907
  deferred.resolve({ raw: result });
722
908
  return;
723
909
  }
910
+ const resultObj = result;
724
911
  const requestMethod = this._pendingMethods.get(reqId) ?? '';
725
912
  if (requestMethod === METHOD_SIGNALWIRE_CONNECT) {
726
- deferred.resolve(result);
913
+ deferred.resolve(resultObj);
727
914
  }
728
915
  else {
729
- const code = result.code;
916
+ const code = resultObj.code;
730
917
  const codeStr = code != null ? String(code) : null;
731
918
  if (codeStr != null && !SUCCESS_CODE_RE.test(codeStr)) {
732
919
  let intCode;
@@ -738,10 +925,10 @@ export class RelayClient {
738
925
  }
739
926
  if (isNaN(intCode))
740
927
  intCode = -1;
741
- deferred.reject(new RelayError(intCode, String(result.message ?? 'Unknown error')));
928
+ deferred.reject(new RelayError(intCode, String(resultObj.message ?? 'Unknown error')));
742
929
  }
743
930
  else {
744
- deferred.resolve(result);
931
+ deferred.resolve(resultObj);
745
932
  }
746
933
  }
747
934
  }
@@ -774,6 +961,7 @@ export class RelayClient {
774
961
  }
775
962
  if (restart) {
776
963
  this._relayProtocol = '';
964
+ this._sessionId = '';
777
965
  this._authorizationState = '';
778
966
  }
779
967
  }
@@ -788,6 +976,18 @@ export class RelayClient {
788
976
  return;
789
977
  }
790
978
  logger.debug(`Event: ${eventType} call_id=${callId}`);
979
+ // Fire the optional low-level observer FIRST so user code can react
980
+ // to events that don't match a tracked Call / Message (state changes
981
+ // for un-originated calls, audit-pushed events, etc). Errors in the
982
+ // observer are logged but never tear down the dispatcher.
983
+ if (this._onAnyEventHandler) {
984
+ try {
985
+ await this._onAnyEventHandler(eventType, eventParams);
986
+ }
987
+ catch (err) {
988
+ logger.error(`onEvent handler threw: ${err}`);
989
+ }
990
+ }
791
991
  // Authorization state update
792
992
  if (eventType === EVENT_AUTHORIZATION_STATE) {
793
993
  const authState = (eventParams.authorization_state ?? '');
@@ -845,12 +1045,12 @@ export class RelayClient {
845
1045
  }
846
1046
  const params = (payload.params ?? {});
847
1047
  const callId = (params.call_id ?? '');
848
- const call = new Call(this, callId, params.node_id ?? '', params.project_id ?? this.project, this._relayProtocol || params.context || params.protocol || '', {
849
- tag: params.tag ?? '',
850
- direction: params.direction ?? 'inbound',
1048
+ const call = new Call(this, callId, (params.node_id ?? ''), (params.project_id ?? this.project), (this._relayProtocol || params.context || params.protocol || ''), {
1049
+ tag: (params.tag ?? ''),
1050
+ direction: (params.direction ?? 'inbound'),
851
1051
  device: params.device,
852
- state: params.call_state ?? 'created',
853
- segmentId: params.segment_id ?? '',
1052
+ state: (params.call_state ?? 'created'),
1053
+ segmentId: (params.segment_id ?? ''),
854
1054
  });
855
1055
  this._calls.set(callId, call);
856
1056
  if (this._onCallHandler) {
@@ -865,16 +1065,16 @@ export class RelayClient {
865
1065
  _handleInboundMessage(payload) {
866
1066
  const params = (payload.params ?? {});
867
1067
  const message = new Message({
868
- messageId: params.message_id ?? '',
869
- context: params.context ?? '',
870
- direction: params.direction ?? 'inbound',
871
- fromNumber: params.from_number ?? '',
872
- toNumber: params.to_number ?? '',
873
- body: params.body ?? '',
874
- media: params.media ?? [],
875
- segments: params.segments ?? 0,
876
- state: params.message_state ?? 'received',
877
- tags: params.tags ?? [],
1068
+ messageId: (params.message_id ?? ''),
1069
+ context: (params.context ?? ''),
1070
+ direction: (params.direction ?? 'inbound'),
1071
+ fromNumber: (params.from_number ?? ''),
1072
+ toNumber: (params.to_number ?? ''),
1073
+ body: (params.body ?? ''),
1074
+ media: (params.media ?? []),
1075
+ segments: (params.segments ?? 0),
1076
+ state: (params.message_state ?? 'received'),
1077
+ tags: (params.tags ?? []),
878
1078
  });
879
1079
  if (this._onMessageHandler) {
880
1080
  Promise.resolve(this._onMessageHandler(message)).catch((err) => {
@@ -890,12 +1090,19 @@ export class RelayClient {
890
1090
  const messageId = (params.message_id ?? '');
891
1091
  const message = this._messages.get(messageId);
892
1092
  if (message) {
893
- message._dispatchEvent(payload).catch((err) => {
1093
+ // Check isDone only after dispatch settles: _dispatchEvent awaits the
1094
+ // message's on() listeners before it resolves the terminal state, so a
1095
+ // synchronous check would miss it and leave the message tracked forever.
1096
+ message
1097
+ ._dispatchEvent(payload)
1098
+ .catch((err) => {
894
1099
  logger.error(`Error dispatching message state for ${messageId}: ${err}`);
1100
+ })
1101
+ .finally(() => {
1102
+ if (message.isDone && this._messages.get(messageId) === message) {
1103
+ this._messages.delete(messageId);
1104
+ }
895
1105
  });
896
- if (message.isDone) {
897
- this._messages.delete(messageId);
898
- }
899
1106
  }
900
1107
  else {
901
1108
  logger.debug(`State event for unknown message ${messageId}`);
@@ -904,11 +1111,11 @@ export class RelayClient {
904
1111
  _registerDialLeg(tag, eventParams) {
905
1112
  const callId = (eventParams.call_id ?? '');
906
1113
  const nodeId = (eventParams.node_id ?? '');
907
- const call = new Call(this, callId, nodeId, eventParams.project_id ?? this.project, this._relayProtocol, {
1114
+ const call = new Call(this, callId, nodeId, (eventParams.project_id ?? this.project), this._relayProtocol, {
908
1115
  tag,
909
1116
  direction: 'outbound',
910
1117
  device: eventParams.device,
911
- state: eventParams.call_state ?? 'created',
1118
+ state: (eventParams.call_state ?? 'created'),
912
1119
  });
913
1120
  this._calls.set(callId, call);
914
1121
  const legs = this._dialCallsByTag.get(tag) ?? [];
@@ -986,14 +1193,14 @@ export class RelayClient {
986
1193
  }
987
1194
  catch {
988
1195
  this._pingFailures++;
989
- const backoff = Math.min(RECONNECT_MIN_DELAY * (RECONNECT_BACKOFF_FACTOR ** this._pingFailures), RECONNECT_MAX_DELAY);
990
- logger.warn(`Client ping failed (${this._pingFailures}/${CLIENT_PING_MAX_FAILURES}), backoff ${backoff.toFixed(1)}s`);
991
- if (this._pingFailures >= CLIENT_PING_MAX_FAILURES) {
1196
+ const backoff = Math.min(this._reconnectMinDelay * RECONNECT_BACKOFF_FACTOR ** this._pingFailures, this._reconnectMaxDelay);
1197
+ logger.warn(`Client ping failed (${this._pingFailures}/${this._clientPingMaxFailures}), backoff ${backoff.toFixed(1)}s`);
1198
+ if (this._pingFailures >= this._clientPingMaxFailures) {
992
1199
  logger.error('Max ping failures reached, forcing reconnect');
993
1200
  this._forceClose();
994
1201
  }
995
1202
  }
996
- }, CLIENT_PING_INTERVAL);
1203
+ }, this._clientPingIntervalMs);
997
1204
  }
998
1205
  _stopPingLoop() {
999
1206
  if (this._pingInterval) {