@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,749 +0,0 @@
1
- /**
2
- * SWMLService - Lightweight HTTP service for non-AI SWML documents.
3
- *
4
- * Unlike AgentBase (which always produces an AI block), SWMLService generates
5
- * pure SWML call-flow documents: IVR menus, voicemail, call recording, etc.
6
- * Uses SwmlBuilder for verb methods and Hono for HTTP serving.
7
- */
8
-
9
- import { Hono } from 'hono';
10
- import { cors } from 'hono/cors';
11
- import { basicAuth } from 'hono/basic-auth';
12
- import { randomBytes } from 'node:crypto';
13
- import { SwmlBuilder } from './SwmlBuilder.js';
14
- import { SchemaUtils } from './SchemaUtils.js';
15
- import { SslConfig } from './SslConfig.js';
16
- import { ConfigLoader } from './ConfigLoader.js';
17
- import { getLogger, Logger } from './Logger.js';
18
- import type { Server } from 'node:http';
19
-
20
- // ── Verb handler interfaces ────────────────────────────────────────────
21
-
22
- /**
23
- * Interface for custom SWML verb handlers.
24
- * Mirrors Python SDK's `SWMLVerbHandler` abstract base class.
25
- */
26
- export interface SWMLVerbHandler {
27
- /** Return the verb name this handler manages. */
28
- getVerbName(): string;
29
- /** Validate a verb configuration. Returns [isValid, errorMessages]. */
30
- validateConfig(config: Record<string, unknown>): [boolean, string[]];
31
- /** Build a verb configuration from keyword arguments. */
32
- buildConfig(kwargs: Record<string, unknown>): Record<string, unknown>;
33
- }
34
-
35
- /**
36
- * Registry for custom SWML verb handlers.
37
- * Mirrors Python SDK's `VerbHandlerRegistry`.
38
- */
39
- export class VerbHandlerRegistry {
40
- private handlers = new Map<string, SWMLVerbHandler>();
41
-
42
- /** Register a custom verb handler. */
43
- registerHandler(handler: SWMLVerbHandler): void {
44
- this.handlers.set(handler.getVerbName(), handler);
45
- }
46
-
47
- /** Get the handler for a specific verb, or undefined if none registered. */
48
- getHandler(verbName: string): SWMLVerbHandler | undefined {
49
- return this.handlers.get(verbName);
50
- }
51
-
52
- /** Check whether a handler exists for the given verb. */
53
- hasHandler(verbName: string): boolean {
54
- return this.handlers.has(verbName);
55
- }
56
- }
57
-
58
- // ── Security config ────────────────────────────────────────────────────
59
-
60
- /**
61
- * Unified security configuration.
62
- * Mirrors Python SDK's `SecurityConfig` — reads from env vars and optional config file.
63
- */
64
- export class SecurityConfig {
65
- /** Whether SSL is enabled. */
66
- sslEnabled: boolean;
67
- /** Filesystem path to the PEM certificate. */
68
- sslCertPath: string | null;
69
- /** Filesystem path to the PEM private key. */
70
- sslKeyPath: string | null;
71
- /** Domain name for SSL. */
72
- domain: string | null;
73
- /** Basic auth username from config, or null. */
74
- basicAuthUser: string | null;
75
- /** Basic auth password from config, or null. */
76
- basicAuthPassword: string | null;
77
-
78
- private sslConfig: SslConfig;
79
-
80
- constructor(opts?: { configFile?: string; serviceName?: string }) {
81
- // Load SSL config from env vars / options
82
- this.sslConfig = new SslConfig();
83
- this.sslEnabled = this.sslConfig.enabled;
84
- this.sslCertPath = this.sslConfig.certPath;
85
- this.sslKeyPath = this.sslConfig.keyPath;
86
- this.domain = this.sslConfig.domain;
87
-
88
- // Auth defaults from env vars
89
- this.basicAuthUser = process.env['SWML_BASIC_AUTH_USER'] ?? null;
90
- this.basicAuthPassword = process.env['SWML_BASIC_AUTH_PASSWORD'] ?? null;
91
-
92
- // Load from config file if available
93
- if (opts?.configFile) {
94
- this.loadFromConfigFile(opts.configFile);
95
- }
96
- }
97
-
98
- private loadFromConfigFile(filePath: string): void {
99
- try {
100
- const loader = new ConfigLoader(filePath);
101
- const ssl = loader.get('security.ssl') as Record<string, unknown> | undefined;
102
- if (ssl) {
103
- if (ssl['enabled'] !== undefined) this.sslEnabled = !!ssl['enabled'];
104
- if (typeof ssl['certPath'] === 'string') this.sslCertPath = ssl['certPath'];
105
- if (typeof ssl['keyPath'] === 'string') this.sslKeyPath = ssl['keyPath'];
106
- if (typeof ssl['domain'] === 'string') this.domain = ssl['domain'];
107
- }
108
- const auth = loader.get('security.basicAuth') as Record<string, unknown> | undefined;
109
- if (auth) {
110
- if (typeof auth['user'] === 'string') this.basicAuthUser = auth['user'];
111
- if (typeof auth['password'] === 'string') this.basicAuthPassword = auth['password'];
112
- }
113
- } catch {
114
- // Config file load failures are non-fatal
115
- }
116
- }
117
-
118
- /** Get basic auth credentials from security config, or null if not configured. */
119
- getBasicAuth(): [string, string] | null {
120
- if (this.basicAuthUser && this.basicAuthPassword) {
121
- return [this.basicAuthUser, this.basicAuthPassword];
122
- }
123
- return null;
124
- }
125
-
126
- /** Validate that SSL cert and key files are present when SSL is enabled. */
127
- validateSslConfig(): [boolean, string | null] {
128
- if (!this.sslEnabled) return [true, null];
129
- if (!this.sslCertPath) return [false, 'SSL cert path not configured'];
130
- if (!this.sslKeyPath) return [false, 'SSL key path not configured'];
131
- return this.sslConfig.isConfigured() ? [true, null] : [false, 'SSL cert or key file not found'];
132
- }
133
- }
134
-
135
- // ── Callback type ──────────────────────────────────────────────────────
136
-
137
- /** Callback invoked per-request to dynamically build SWML. */
138
- export type OnRequestCallback = (
139
- queryParams: Record<string, string>,
140
- bodyParams: Record<string, unknown>,
141
- headers: Record<string, string>,
142
- ) => SwmlBuilder | Promise<SwmlBuilder>;
143
-
144
- // RoutingCallback is owned by AgentBase.ts; SWMLService uses a structurally
145
- // compatible local alias to avoid an import cycle and stay independent.
146
- type RoutingCallback = (
147
- requestBody: Record<string, unknown>,
148
- ) => string | null | undefined | Promise<string | null | undefined>;
149
-
150
- // ── Options ────────────────────────────────────────────────────────────
151
-
152
- /** Configuration options for SWMLService. */
153
- export interface SWMLServiceOptions {
154
- /**
155
- * Service display name.
156
- * Required to match Python SDK where `name` is a positional required parameter.
157
- */
158
- name: string;
159
- /** HTTP route path (default '/'). */
160
- route?: string;
161
- /** Host to bind the web server to (default '0.0.0.0'). */
162
- host?: string;
163
- /** Port to bind the web server to (default PORT env var or 3000). */
164
- port?: number;
165
- /** Basic auth credentials as [username, password]. */
166
- basicAuth?: [string, string];
167
- /** Path to a JSON Schema file for verb validation. */
168
- schemaPath?: string;
169
- /** Path to a security configuration file. */
170
- configFile?: string;
171
- /** Enable schema validation (default true). Can also be disabled via SWML_SKIP_SCHEMA_VALIDATION=true. */
172
- schemaValidation?: boolean;
173
- }
174
-
175
- // ── SWMLService class ──────────────────────────────────────────────────
176
-
177
- /**
178
- * HTTP service that serves non-AI SWML documents built from verb methods.
179
- *
180
- * Use `SWMLService` when you need a SignalWire call flow but don't need AI —
181
- * plain call routing, IVR-style trees, recording workflows, static playback, etc.
182
- * For AI-powered voice agents, use {@link AgentBase} instead.
183
- *
184
- * @example Static greeting that plays a file and hangs up
185
- * ```ts
186
- * import { SWMLService } from '@signalwire/sdk';
187
- *
188
- * const service = new SWMLService({ name: 'greeter', route: '/', port: 3000 });
189
- * service.builder
190
- * .answer()
191
- * .play({ url: 'https://cdn.example.com/welcome.mp3' })
192
- * .hangup();
193
- *
194
- * await service.serve();
195
- * ```
196
- *
197
- * @see {@link SwmlBuilder} — the underlying SWML document builder
198
- * @see {@link AgentBase} — AI-powered alternative
199
- */
200
- export class SWMLService {
201
- /** Service display name. */
202
- readonly name: string;
203
- /** HTTP route path. */
204
- readonly route: string;
205
- /** Host the server binds to. */
206
- readonly host: string;
207
- /** Port the server binds to. */
208
- readonly port: number;
209
-
210
- /** Structured logger, exposed for subclass access. Mirrors Python's public `self.log`. */
211
- readonly log: Logger;
212
-
213
- /** Unified security configuration. Mirrors Python's `self.security`. */
214
- readonly security: SecurityConfig;
215
- /** Whether SSL is enabled. Mirrors Python's `self.ssl_enabled`. */
216
- readonly sslEnabled: boolean;
217
- /** Domain name for SSL. Mirrors Python's `self.domain`. */
218
- readonly domain: string | undefined;
219
- /** Path to SSL certificate. Mirrors Python's `self.ssl_cert_path`. */
220
- readonly sslCertPath: string | undefined;
221
- /** Path to SSL private key. Mirrors Python's `self.ssl_key_path`. */
222
- readonly sslKeyPath: string | undefined;
223
-
224
- /** Schema validation utilities. Mirrors Python's `self.schema_utils`. */
225
- readonly schemaUtils: SchemaUtils;
226
- /** Custom verb handler registry. Mirrors Python's `self.verb_registry`. */
227
- readonly verbRegistry: VerbHandlerRegistry;
228
-
229
- private swmlBuilder: SwmlBuilder;
230
- private _app: Hono;
231
- private _server: Server | null = null;
232
- private onRequestCallback?: OnRequestCallback;
233
- private authCredentials?: [string, string];
234
- private authSource: 'provided' | 'environment' | 'auto-generated' = 'auto-generated';
235
- private _proxyUrlBase: string | null = process.env['SWML_PROXY_URL_BASE'] ?? null;
236
- private _proxyUrlBaseFromEnv = !!process.env['SWML_PROXY_URL_BASE'];
237
- private _routingCallbacks = new Map<string, RoutingCallback>();
238
-
239
- constructor(opts: SWMLServiceOptions);
240
- /** @deprecated Prefer passing an options object with a required `name`. The no-arg form defaults name to 'swml-service'. */
241
- constructor(opts?: Partial<SWMLServiceOptions>);
242
- constructor(opts?: Partial<SWMLServiceOptions>) {
243
- this.name = opts?.name ?? 'swml-service';
244
- this.route = opts?.route ?? '/';
245
- this.host = opts?.host ?? '0.0.0.0';
246
- this.port = opts?.port ?? parseInt(process.env['PORT'] ?? '3000', 10);
247
-
248
- // Logger — public to match Python's `self.log`
249
- this.log = getLogger('SWMLService');
250
-
251
- // Security configuration
252
- this.security = new SecurityConfig({
253
- configFile: opts?.configFile,
254
- serviceName: this.name,
255
- });
256
- this.sslEnabled = this.security.sslEnabled;
257
- this.domain = this.security.domain ?? undefined;
258
- this.sslCertPath = this.security.sslCertPath ?? undefined;
259
- this.sslKeyPath = this.security.sslKeyPath ?? undefined;
260
-
261
- // Schema utils — pass through schemaPath so callers can supply a custom schema file.
262
- // Mirrors Python's SchemaUtils(schema_path, schema_validation=...) call in SWMLService.__init__.
263
- const skipValidation = opts?.schemaValidation === false || process.env['SWML_SKIP_SCHEMA_VALIDATION'] === 'true';
264
- this.schemaUtils = new SchemaUtils({
265
- skipValidation,
266
- ...(opts?.schemaPath !== undefined ? { schemaPath: opts.schemaPath } : {}),
267
- });
268
-
269
- // Verb handler registry
270
- this.verbRegistry = new VerbHandlerRegistry();
271
-
272
- // Auth resolution: provided > env > security config > generated
273
- // Track whether auth was explicitly provided (enforced on HTTP) vs auto-generated (available but not enforced)
274
- let enforceAuth = false;
275
- if (opts?.basicAuth) {
276
- this.authCredentials = opts.basicAuth;
277
- this.authSource = 'provided';
278
- enforceAuth = true;
279
- } else {
280
- const envUser = process.env['SWML_BASIC_AUTH_USER'];
281
- const envPass = process.env['SWML_BASIC_AUTH_PASSWORD'];
282
- if (envUser && envPass) {
283
- this.authCredentials = [envUser, envPass];
284
- this.authSource = 'environment';
285
- enforceAuth = true;
286
- } else {
287
- const fromConfig = this.security.getBasicAuth();
288
- if (fromConfig) {
289
- this.authCredentials = fromConfig;
290
- this.authSource = 'environment';
291
- enforceAuth = true;
292
- } else {
293
- // Auto-generate credentials like AgentBase does
294
- const username = this.name.replace(/[^a-zA-Z0-9_-]/g, '_');
295
- this.authCredentials = [username, randomBytes(16).toString('hex')];
296
- this.authSource = 'auto-generated';
297
- // Not enforced on HTTP — available via getBasicAuthCredentials()
298
- }
299
- }
300
- }
301
-
302
- this.swmlBuilder = new SwmlBuilder();
303
- this._app = new Hono();
304
-
305
- // Security headers
306
- this._app.use('*', async (c, next) => {
307
- await next();
308
- c.res.headers.set('X-Content-Type-Options', 'nosniff');
309
- c.res.headers.set('X-Frame-Options', 'DENY');
310
- c.res.headers.set('X-XSS-Protection', '1; mode=block');
311
- c.res.headers.set('Referrer-Policy', 'strict-origin-when-cross-origin');
312
- c.res.headers.set('Content-Security-Policy', "default-src 'none'; frame-ancestors 'none'");
313
- c.res.headers.set('Permissions-Policy', 'camera=(), microphone=(), geolocation=()');
314
- });
315
-
316
- // CORS — credentials only when origin is explicitly configured (wildcard + credentials violates spec)
317
- const corsOrigins = process.env['SWML_CORS_ORIGINS'];
318
- const corsOrigin = corsOrigins ? corsOrigins.split(',').map((o: string) => o.trim()) : '*';
319
- const corsCredentials = corsOrigin !== '*';
320
- this._app.use('*', cors({ origin: corsOrigin, credentials: corsCredentials }));
321
-
322
- // Basic auth — only enforced when explicitly provided or from env, not auto-generated
323
- if (enforceAuth && this.authCredentials) {
324
- const [user, pass] = this.authCredentials;
325
- this._app.use('*', basicAuth({ username: user, password: pass }));
326
- }
327
-
328
- // Health endpoints
329
- this._app.get('/health', (c) => c.json({ status: 'ok' }));
330
- this._app.get('/ready', (c) => c.json({ status: 'ready' }));
331
-
332
- // Main SWML endpoint — serves on both GET and POST
333
- const handler = async (c: any) => {
334
- let doc: Record<string, unknown>;
335
-
336
- // Always parse request params so onRequest() hook and onRequestCallback
337
- // can both receive them (mirrors Python's _handle_request param extraction).
338
- const url = new URL(c.req.url);
339
- const queryParams: Record<string, string> = {};
340
- url.searchParams.forEach((v, k) => { queryParams[k] = v; });
341
-
342
- let bodyParams: Record<string, unknown> = {};
343
- if (c.req.method === 'POST') {
344
- try {
345
- bodyParams = await c.req.json();
346
- } catch {
347
- // empty body is fine
348
- }
349
- }
350
-
351
- const headers: Record<string, string> = {};
352
- c.req.raw.headers.forEach((v: string, k: string) => { headers[k] = v; });
353
-
354
- // Protected override hook (mirrors Python's on_request subclass pattern).
355
- // Try onRequest() first; if it returns a SwmlBuilder use that document.
356
- const hookResult = this.onRequest(queryParams, bodyParams, headers);
357
- if (hookResult !== null) {
358
- doc = hookResult.getDocument();
359
- } else if (this.onRequestCallback) {
360
- const builder = await this.onRequestCallback(queryParams, bodyParams, headers);
361
- doc = builder.getDocument();
362
- } else {
363
- doc = this.swmlBuilder.getDocument();
364
- }
365
-
366
- return c.json(doc);
367
- };
368
-
369
- const routePath = this.route === '/' ? '/' : this.route;
370
- this._app.get(routePath, handler);
371
- this._app.post(routePath, handler);
372
-
373
- // Register routing callback endpoints dynamically in getApp/run
374
- }
375
-
376
- // ── Properties (getters) ─────────────────────────────────────────────
377
-
378
- /**
379
- * Check if full JSON Schema validation is enabled.
380
- * Mirrors Python's `@property full_validation_enabled`.
381
- * @returns True if schema-based verb validation is active.
382
- */
383
- get fullValidationEnabled(): boolean {
384
- // SchemaUtils in TS doesn't expose a direct 'full_validation_available' flag,
385
- // but if the schema was loaded and validation is not skipped, it's available.
386
- // We check by attempting to see if schema has verbs loaded.
387
- try {
388
- return this.schemaUtils.getVerbNames().length > 0;
389
- } catch {
390
- return false;
391
- }
392
- }
393
-
394
- // ── SwmlBuilder delegation ────────────────────────────────────────
395
-
396
- /**
397
- * Get the underlying SwmlBuilder for direct manipulation.
398
- * @returns The SwmlBuilder instance.
399
- */
400
- getBuilder(): SwmlBuilder {
401
- return this.swmlBuilder;
402
- }
403
-
404
- /**
405
- * Add a verb to the SWML document.
406
- * @param name - Verb name (e.g., 'answer', 'play', 'hangup').
407
- * @param config - Verb configuration.
408
- * @returns This service for chaining.
409
- */
410
- addVerb(name: string, config: unknown): this {
411
- this.swmlBuilder.addVerb(name, config);
412
- return this;
413
- }
414
-
415
- /**
416
- * Add a new named section to the SWML document.
417
- * Mirrors Python's `add_section()`.
418
- * @param sectionName - Name of the section to create.
419
- * @returns This service for chaining.
420
- */
421
- addSection(sectionName: string): this {
422
- const doc = this.swmlBuilder.getDocument() as { sections: Record<string, unknown[]> };
423
- if (!(sectionName in doc.sections)) {
424
- doc.sections[sectionName] = [];
425
- }
426
- return this;
427
- }
428
-
429
- /**
430
- * Add a verb to a specific named section.
431
- * Mirrors Python's `add_verb_to_section()`.
432
- * @param sectionName - Target section name (auto-created if missing).
433
- * @param verbName - Verb name.
434
- * @param config - Verb configuration.
435
- * @returns This service for chaining.
436
- */
437
- addVerbToSection(sectionName: string, verbName: string, config: unknown): this {
438
- this.swmlBuilder.addVerbToSection(sectionName, verbName, config);
439
- return this;
440
- }
441
-
442
- /**
443
- * Reset the SWML document to an empty state.
444
- * Mirrors Python's `reset_document()`.
445
- * @returns This service for chaining.
446
- */
447
- resetDocument(): this {
448
- this.swmlBuilder.reset();
449
- return this;
450
- }
451
-
452
- /**
453
- * Render the SWML document as a JSON object.
454
- * @returns The SWML document.
455
- */
456
- renderSwml(): Record<string, unknown> {
457
- return this.swmlBuilder.getDocument();
458
- }
459
-
460
- /**
461
- * Get the SWML document as a dictionary.
462
- * Alias for `renderSwml()` that matches Python's `get_document()` name.
463
- * @returns The SWML document.
464
- */
465
- getDocument(): Record<string, unknown> {
466
- return this.swmlBuilder.getDocument();
467
- }
468
-
469
- /**
470
- * Render the SWML document as a JSON string.
471
- * Mirrors Python's `render_document()`.
472
- * @returns JSON-encoded SWML document.
473
- */
474
- renderDocument(): string {
475
- return this.swmlBuilder.renderDocument();
476
- }
477
-
478
- // ── Verb handler registration ────────────────────────────────────────
479
-
480
- /**
481
- * Register a custom verb handler.
482
- * Mirrors Python's `register_verb_handler()`.
483
- * @param handler - The verb handler to register.
484
- */
485
- registerVerbHandler(handler: SWMLVerbHandler): void {
486
- this.verbRegistry.registerHandler(handler);
487
- }
488
-
489
- // ── Routing callbacks ────────────────────────────────────────────────
490
-
491
- /**
492
- * Register a routing callback at a given path.
493
- * When a POST request arrives at `path`, the callback is invoked with the
494
- * parsed request body. If it returns a string, the response is a 307 redirect
495
- * to that route; if it returns null, normal SWML serving continues.
496
- * Mirrors Python's `register_routing_callback()`.
497
- *
498
- * @param callbackFn - Callback receiving the request body and returning a route or null.
499
- * @param path - HTTP path for the callback (default '/sip').
500
- */
501
- registerRoutingCallback(
502
- callbackFn: RoutingCallback,
503
- path: string = '/sip',
504
- ): void {
505
- // Normalize: ensure leading /, strip trailing /
506
- let normalized = path.replace(/\/+$/, '');
507
- if (!normalized.startsWith('/')) {
508
- normalized = `/${normalized}`;
509
- }
510
- this.log.info(`Registering routing callback at ${normalized}`);
511
- this._routingCallbacks.set(normalized, callbackFn);
512
-
513
- // Install an endpoint on the Hono app for this callback path
514
- const routeHandler = async (c: any) => {
515
- let body: Record<string, unknown> = {};
516
- if (c.req.method === 'POST') {
517
- try {
518
- body = await c.req.json();
519
- } catch {
520
- // empty body
521
- }
522
- }
523
-
524
- const route = callbackFn(body);
525
- if (route !== null) {
526
- return c.redirect(route, 307);
527
- }
528
-
529
- // No redirect — serve normal SWML
530
- const doc = this.swmlBuilder.getDocument();
531
- return c.json(doc);
532
- };
533
-
534
- this._app.get(normalized, routeHandler);
535
- this._app.post(normalized, routeHandler);
536
- }
537
-
538
- // ── Static utilities ─────────────────────────────────────────────────
539
-
540
- /**
541
- * Extract the SIP username from a request body's call.to field.
542
- * Mirrors Python's `@staticmethod extract_sip_username()`.
543
- * @param requestBody - The parsed request body containing call information.
544
- * @returns The extracted SIP username, or null if not found.
545
- */
546
- static extractSipUsername(requestBody: Record<string, unknown>): string | null {
547
- try {
548
- const call = requestBody?.['call'] as Record<string, unknown> | undefined;
549
- const toField = call?.['to'] as string | undefined;
550
- if (!toField) return null;
551
-
552
- // Handle SIP URIs like "sip:username@domain" or "sips:username@domain"
553
- if (toField.startsWith('sip:') || toField.startsWith('sips:')) {
554
- let uri = toField.replace(/^sips?:/, '');
555
- const atIdx = uri.indexOf('@');
556
- if (atIdx > 0) return uri.substring(0, atIdx);
557
- return uri;
558
- }
559
- // Handle TEL URIs like "tel:+1234567890"
560
- if (toField.startsWith('tel:')) {
561
- return toField.substring(4);
562
- }
563
- // Otherwise return the whole 'to' field
564
- return toField;
565
- } catch {
566
- return null;
567
- }
568
- }
569
-
570
- // ── Dynamic request callback ──────────────────────────────────────
571
-
572
- /**
573
- * Protected override hook called on every inbound SWML request.
574
- * Mirrors Python SDK's `on_request(request_data, callback_path)` subclass
575
- * override pattern. Subclasses return a `SwmlBuilder` to use for this
576
- * request, or `null` to fall through to `setOnRequestCallback` or the
577
- * static builder.
578
- *
579
- * Default implementation returns `null` (no-op), preserving existing
580
- * behaviour for classes that do not override.
581
- *
582
- * @param queryParams - URL query parameters from the request.
583
- * @param bodyParams - Parsed POST body (empty object for GET requests).
584
- * @param headers - HTTP request headers.
585
- * @param callbackPath - The callback sub-path being handled, if any.
586
- * @returns A `SwmlBuilder` whose document is sent as the response, or
587
- * `null` to delegate to the next handler in the chain.
588
- */
589
- protected onRequest(
590
- _queryParams: Record<string, string>,
591
- _bodyParams: Record<string, unknown>,
592
- _headers: Record<string, string>,
593
- _callbackPath?: string,
594
- ): SwmlBuilder | null {
595
- return null;
596
- }
597
-
598
- /**
599
- * Set a callback invoked per-request to dynamically build SWML.
600
- * When set, the static SwmlBuilder is ignored and the callback's
601
- * returned SwmlBuilder is used instead.
602
- * @param cb - Callback receiving query params, body params, and headers.
603
- * @returns This service for chaining.
604
- */
605
- setOnRequestCallback(cb: OnRequestCallback): this {
606
- this.onRequestCallback = cb;
607
- return this;
608
- }
609
-
610
- // ── Auth ──────────────────────────────────────────────────────────
611
-
612
- /**
613
- * Get the basic-auth credentials used by this service.
614
- * Mirrors Python's `get_basic_auth_credentials()`.
615
- * @param includeSource - When true, a third element indicating the credential source is appended.
616
- * @returns A tuple of [username, password] or [username, password, source].
617
- */
618
- getBasicAuthCredentials(includeSource?: false): [string, string];
619
- getBasicAuthCredentials(includeSource: true): [string, string, 'provided' | 'environment' | 'auto-generated'];
620
- getBasicAuthCredentials(includeSource?: boolean): [string, string] | [string, string, 'provided' | 'environment' | 'auto-generated'] {
621
- const creds = this.authCredentials ?? ['', ''];
622
- if (includeSource) return [...creds, this.authSource];
623
- return creds;
624
- }
625
-
626
- // ── Proxy ─────────────────────────────────────────────────────────
627
-
628
- /**
629
- * Manually set the proxy base URL used for webhook URL generation.
630
- * Mirrors Python's `manual_set_proxy_url()`.
631
- * @param url - The external-facing base URL (trailing slashes are stripped).
632
- * @returns This service for chaining.
633
- */
634
- manualSetProxyUrl(url: string): this {
635
- if (url) {
636
- this._proxyUrlBase = url.replace(/\/+$/, '');
637
- this._proxyUrlBaseFromEnv = false;
638
- this.log.info(`Proxy URL manually set to ${this._proxyUrlBase}`);
639
- }
640
- return this;
641
- }
642
-
643
- // ── HTTP ──────────────────────────────────────────────────────────
644
-
645
- /**
646
- * Get the Hono application for mounting or testing.
647
- * This is the TypeScript equivalent of Python's `as_router()`, which returns
648
- * a FastAPI `APIRouter`. Both expose the underlying app/router so callers can
649
- * mount it into a larger framework. Use `asRouter()` when porting Python code
650
- * that calls `as_router()` directly.
651
- * @returns The configured Hono app.
652
- */
653
- getApp(): Hono {
654
- return this._app;
655
- }
656
-
657
- /**
658
- * Alias for `getApp()`. Provided for cross-SDK consistency with Python's
659
- * `as_router()` method — allows Python callers porting to TypeScript to use
660
- * the familiar name without changes.
661
- * @returns The configured Hono app.
662
- */
663
- asRouter(): Hono {
664
- return this.getApp();
665
- }
666
-
667
- /**
668
- * Start the HTTP server.
669
- *
670
- * Matches Python's `serve()` parameters including SSL options. When
671
- * `SWAIG_CLI_MODE=true` is set in the environment (e.g. while running the
672
- * `swaig-test` CLI) the call is a no-op.
673
- *
674
- * @param host - Hostname. Defaults to `this.host` (constructor value) or
675
- * `'0.0.0.0'`.
676
- * @param port - Port. Defaults to `this.port` (constructor value) or `3000`.
677
- * @param opts - Optional SSL/TLS configuration overrides.
678
- * @param opts.sslCert - Path to the PEM certificate file.
679
- * @param opts.sslKey - Path to the PEM private key file.
680
- * @param opts.sslEnabled - When `true`, serve over HTTPS.
681
- * @param opts.domain - Domain used for HSTS header configuration.
682
- * @returns Resolves once the server has begun listening.
683
- */
684
- async run(
685
- host?: string,
686
- port?: number,
687
- opts?: {
688
- sslCert?: string;
689
- sslKey?: string;
690
- sslEnabled?: boolean;
691
- domain?: string;
692
- },
693
- ): Promise<void> {
694
- if (process.env['SWAIG_CLI_MODE'] === 'true') return;
695
-
696
- const h = host ?? this.host;
697
- const p = port ?? this.port;
698
-
699
- // Determine effective SSL state (param > instance > env)
700
- const effectiveSslEnabled = opts?.sslEnabled ?? this.sslEnabled;
701
- const effectiveSslCert = opts?.sslCert ?? this.sslCertPath;
702
- const effectiveSslKey = opts?.sslKey ?? this.sslKeyPath;
703
-
704
- if (effectiveSslEnabled && effectiveSslCert && effectiveSslKey) {
705
- // HTTPS mode
706
- const { readFileSync } = await import('node:fs');
707
- const { createServer } = await import('node:https');
708
- const { getRequestListener } = await import('@hono/node-server');
709
-
710
- const serverOpts = {
711
- cert: readFileSync(effectiveSslCert, 'utf-8'),
712
- key: readFileSync(effectiveSslKey, 'utf-8'),
713
- };
714
-
715
- this.log.info(`${this.name} starting on https://${h}:${p}${this.route} (SSL enabled)`);
716
- const listener = getRequestListener(this._app.fetch);
717
- this._server = createServer(serverOpts, listener) as unknown as Server;
718
- this._server.listen(p, h);
719
- } else {
720
- // HTTP mode
721
- const { serve } = await import('@hono/node-server');
722
- this.log.info(`${this.name} starting on http://${h}:${p}${this.route}`);
723
- this._server = serve({ fetch: this._app.fetch, port: p, hostname: h }) as unknown as Server;
724
- }
725
- }
726
-
727
- /**
728
- * Start the HTTP server. Alias for {@link run} provided for cross-SDK
729
- * consistency with Python's `serve()` method — callers porting from
730
- * Python can use this name without changes.
731
- *
732
- * @param args - Forwarded unchanged to {@link run}.
733
- * @returns Resolves once the server has begun listening.
734
- */
735
- async serve(...args: Parameters<SWMLService['run']>): Promise<void> {
736
- return this.run(...args);
737
- }
738
-
739
- /**
740
- * Stop the HTTP server.
741
- * Mirrors Python's `stop()`.
742
- */
743
- stop(): void {
744
- if (this._server) {
745
- this._server.close();
746
- this._server = null;
747
- }
748
- }
749
- }