@signalwire/sdk 2.0.0 → 2.0.2

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 (612) 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/dist/index.d.ts +146 -0
  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 +1019 -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/{src/rest/index.ts → dist/rest/index.d.ts} +53 -122
  149. package/dist/rest/index.js +195 -0
  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/dist/rest/pagination.d.ts +39 -0
  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 -2489
  416. package/src/AgentServer.ts +0 -415
  417. package/src/AuthHandler.ts +0 -256
  418. package/src/ConfigLoader.ts +0 -447
  419. package/src/ContextBuilder.ts +0 -1150
  420. package/src/DataMap.ts +0 -449
  421. package/src/FunctionResult.ts +0 -866
  422. package/src/Logger.ts +0 -337
  423. package/src/PomBuilder.ts +0 -439
  424. package/src/PromptManager.ts +0 -133
  425. package/src/SWMLHandler.ts +0 -298
  426. package/src/SWMLService.ts +0 -717
  427. package/src/SchemaUtils.ts +0 -361
  428. package/src/ServerlessAdapter.ts +0 -221
  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 -258
  433. package/src/SwmlVerbMethods.generated.ts +0 -234
  434. package/src/TypeInference.ts +0 -181
  435. package/src/WebService.ts +0 -619
  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/index.ts +0 -167
  441. package/src/livewire/index.ts +0 -950
  442. package/src/prefabs/ConciergeAgent.ts +0 -287
  443. package/src/prefabs/FAQBotAgent.ts +0 -384
  444. package/src/prefabs/InfoGathererAgent.ts +0 -339
  445. package/src/prefabs/ReceptionistAgent.ts +0 -366
  446. package/src/prefabs/SurveyAgent.ts +0 -646
  447. package/src/relay/Action.ts +0 -314
  448. package/src/relay/Call.ts +0 -854
  449. package/src/relay/Deferred.ts +0 -71
  450. package/src/relay/Message.ts +0 -148
  451. package/src/relay/RelayClient.ts +0 -1036
  452. package/src/relay/RelayError.ts +0 -14
  453. package/src/relay/RelayEvent.ts +0 -892
  454. package/src/relay/index.ts +0 -123
  455. package/src/relay/types.ts +0 -149
  456. package/src/rest/HttpClient.ts +0 -103
  457. package/src/rest/RestError.ts +0 -31
  458. package/src/rest/base/BaseResource.ts +0 -19
  459. package/src/rest/base/CrudResource.ts +0 -51
  460. package/src/rest/base/CrudWithAddresses.ts +0 -26
  461. package/src/rest/namespaces/addresses.ts +0 -32
  462. package/src/rest/namespaces/calling.ts +0 -187
  463. package/src/rest/namespaces/chat.ts +0 -20
  464. package/src/rest/namespaces/compat.ts +0 -352
  465. package/src/rest/namespaces/datasphere.ts +0 -45
  466. package/src/rest/namespaces/fabric.ts +0 -222
  467. package/src/rest/namespaces/imported-numbers.ts +0 -20
  468. package/src/rest/namespaces/logs.ts +0 -84
  469. package/src/rest/namespaces/lookup.ts +0 -21
  470. package/src/rest/namespaces/mfa.ts +0 -30
  471. package/src/rest/namespaces/number-groups.ts +0 -38
  472. package/src/rest/namespaces/phone-numbers.ts +0 -44
  473. package/src/rest/namespaces/project.ts +0 -36
  474. package/src/rest/namespaces/pubsub.ts +0 -20
  475. package/src/rest/namespaces/queues.ts +0 -33
  476. package/src/rest/namespaces/recordings.ts +0 -28
  477. package/src/rest/namespaces/registry.ts +0 -101
  478. package/src/rest/namespaces/short-codes.ts +0 -28
  479. package/src/rest/namespaces/sip-profile.ts +0 -25
  480. package/src/rest/namespaces/verified-callers.ts +0 -27
  481. package/src/rest/namespaces/video.ts +0 -165
  482. package/src/rest/pagination.ts +0 -84
  483. package/src/rest/types.ts +0 -61
  484. package/src/skills/SkillBase.ts +0 -547
  485. package/src/skills/SkillManager.ts +0 -415
  486. package/src/skills/SkillRegistry.ts +0 -367
  487. package/src/skills/builtin/api_ninjas_trivia.ts +0 -280
  488. package/src/skills/builtin/ask_claude.ts +0 -241
  489. package/src/skills/builtin/claude_skills.ts +0 -978
  490. package/src/skills/builtin/custom_skills.ts +0 -312
  491. package/src/skills/builtin/datasphere.ts +0 -438
  492. package/src/skills/builtin/datasphere_serverless.ts +0 -339
  493. package/src/skills/builtin/datetime.ts +0 -130
  494. package/src/skills/builtin/google_maps.ts +0 -651
  495. package/src/skills/builtin/info_gatherer.ts +0 -405
  496. package/src/skills/builtin/joke.ts +0 -191
  497. package/src/skills/builtin/math.ts +0 -142
  498. package/src/skills/builtin/mcp_gateway.ts +0 -677
  499. package/src/skills/builtin/native_vector_search.ts +0 -901
  500. package/src/skills/builtin/play_background_file.ts +0 -358
  501. package/src/skills/builtin/spider.ts +0 -869
  502. package/src/skills/builtin/swml_transfer.ts +0 -635
  503. package/src/skills/builtin/weather_api.ts +0 -248
  504. package/src/skills/builtin/web_search.ts +0 -1074
  505. package/src/skills/builtin/wikipedia_search.ts +0 -299
  506. package/src/types.ts +0 -132
  507. package/tests/AgentBase.test.ts +0 -1093
  508. package/tests/AgentServer.test.ts +0 -126
  509. package/tests/AuthHandler.test.ts +0 -133
  510. package/tests/ConfigLoader.test.ts +0 -151
  511. package/tests/ContextBuilder.test.ts +0 -108
  512. package/tests/DataMap.test.ts +0 -367
  513. package/tests/EphemeralSkillCopy.test.ts +0 -107
  514. package/tests/FunctionResult.test.ts +0 -298
  515. package/tests/GracefulShutdown.test.ts +0 -46
  516. package/tests/Logger.test.ts +0 -420
  517. package/tests/PomBuilder.test.ts +0 -228
  518. package/tests/ProxyDetection.test.ts +0 -228
  519. package/tests/SWMLService.test.ts +0 -320
  520. package/tests/SWMLVerbHandler.test.ts +0 -523
  521. package/tests/SchemaUtils.test.ts +0 -106
  522. package/tests/SchemaUtils.verb.test.ts +0 -206
  523. package/tests/SecurityUtils.test.ts +0 -192
  524. package/tests/ServerlessAdapter.test.ts +0 -222
  525. package/tests/SessionManager.test.ts +0 -257
  526. package/tests/SkillBaseFeatures.test.ts +0 -130
  527. package/tests/SkillMultiInstance.test.ts +0 -102
  528. package/tests/SkillParameterSchemas.test.ts +0 -134
  529. package/tests/SkillRegistrySchema.test.ts +0 -84
  530. package/tests/SslConfig.test.ts +0 -97
  531. package/tests/SwmlBuilder.test.ts +0 -400
  532. package/tests/TypeInference.test.ts +0 -165
  533. package/tests/VerbHandlerRegistry.test.ts +0 -128
  534. package/tests/cli/mock-data.test.ts +0 -113
  535. package/tests/cli/swaig-test.test.ts +0 -108
  536. package/tests/examples.test.ts +0 -194
  537. package/tests/fixtures/scrape-parity/README.md +0 -53
  538. package/tests/fixtures/scrape-parity/expected/01_simple_article.json +0 -5
  539. package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +0 -5
  540. package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +0 -5
  541. package/tests/fixtures/scrape-parity/expected/04_bare_body.json +0 -5
  542. package/tests/fixtures/scrape-parity/expected/05_malformed.json +0 -5
  543. package/tests/fixtures/scrape-parity/expected/06_multi_class.json +0 -5
  544. package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +0 -5
  545. package/tests/fixtures/scrape-parity/expected/08_inline_script.json +0 -5
  546. package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +0 -5
  547. package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +0 -5
  548. package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +0 -5
  549. package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +0 -5
  550. package/tests/fixtures/scrape-parity/html/01_simple_article.html +0 -18
  551. package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +0 -18
  552. package/tests/fixtures/scrape-parity/html/03_nested_containers.html +0 -13
  553. package/tests/fixtures/scrape-parity/html/04_bare_body.html +0 -9
  554. package/tests/fixtures/scrape-parity/html/05_malformed.html +0 -11
  555. package/tests/fixtures/scrape-parity/html/06_multi_class.html +0 -18
  556. package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +0 -12
  557. package/tests/fixtures/scrape-parity/html/08_inline_script.html +0 -17
  558. package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +0 -21
  559. package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +0 -10
  560. package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +0 -13
  561. package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +0 -24
  562. package/tests/fixtures/scrape-parity/python_extract.py +0 -109
  563. package/tests/livewire/livewire.test.ts +0 -780
  564. package/tests/mcp.test.ts +0 -221
  565. package/tests/prefabs/prefabs.test.ts +0 -1093
  566. package/tests/relay/Action.test.ts +0 -392
  567. package/tests/relay/Call.test.ts +0 -535
  568. package/tests/relay/Deferred.test.ts +0 -71
  569. package/tests/relay/Message.test.ts +0 -164
  570. package/tests/relay/RelayClient.test.ts +0 -779
  571. package/tests/relay/RelayEvent.test.ts +0 -463
  572. package/tests/relay/helpers.ts +0 -79
  573. package/tests/rest/HttpClient.test.ts +0 -274
  574. package/tests/rest/RestError.test.ts +0 -53
  575. package/tests/rest/calling.test.ts +0 -156
  576. package/tests/rest/client.test.ts +0 -197
  577. package/tests/rest/compat.test.ts +0 -335
  578. package/tests/rest/datasphere.test.ts +0 -71
  579. package/tests/rest/fabric.test.ts +0 -186
  580. package/tests/rest/helpers.ts +0 -95
  581. package/tests/rest/logs.test.ts +0 -68
  582. package/tests/rest/pagination.test.ts +0 -133
  583. package/tests/rest/registry.test.ts +0 -94
  584. package/tests/rest/relay-rest.test.ts +0 -290
  585. package/tests/rest/video.test.ts +0 -173
  586. package/tests/setup.ts +0 -6
  587. package/tests/skills/SkillBase.test.ts +0 -108
  588. package/tests/skills/SkillManager.test.ts +0 -268
  589. package/tests/skills/SkillRegistry.test.ts +0 -176
  590. package/tests/skills/builtin.test.ts +0 -1472
  591. package/tests/skills/claude-skills.test.ts +0 -54
  592. package/tests/skills/custom-skills.test.ts +0 -53
  593. package/tests/skills/datasphere-serverless.test.ts +0 -70
  594. package/tests/skills/datasphere.test.ts +0 -107
  595. package/tests/skills/datetime.test.ts +0 -101
  596. package/tests/skills/google-maps.test.ts +0 -78
  597. package/tests/skills/info-gatherer.test.ts +0 -411
  598. package/tests/skills/joke.test.ts +0 -81
  599. package/tests/skills/math.test.ts +0 -68
  600. package/tests/skills/mcp-gateway.test.ts +0 -101
  601. package/tests/skills/play-background.test.ts +0 -54
  602. package/tests/skills/spider.test.ts +0 -108
  603. package/tests/skills/swml-transfer.test.ts +0 -178
  604. package/tests/skills/trivia.test.ts +0 -54
  605. package/tests/skills/vector-search.test.ts +0 -135
  606. package/tests/skills/weather-api.test.ts +0 -77
  607. package/tests/skills/web-search-parity.test.ts +0 -59
  608. package/tests/skills/web-search.test.ts +0 -103
  609. package/tests/skills/wikipedia.test.ts +0 -63
  610. package/tsconfig.json +0 -18
  611. package/vitest.config.ts +0 -9
  612. /package/{src → dist}/schema.json +0 -0
package/src/WebService.ts DELETED
@@ -1,619 +0,0 @@
1
- /**
2
- * WebService - Static file serving service with HTTP API.
3
- *
4
- * Provides configurable static file serving with security features including
5
- * basic auth, extension filtering, directory browsing, file size limits,
6
- * CORS, and SSL support. Equivalent to the Python SDK's WebService class.
7
- */
8
-
9
- import { Hono } from 'hono';
10
- import { basicAuth } from 'hono/basic-auth';
11
- import { cors } from 'hono/cors';
12
- import { readFile, stat, readdir } from 'node:fs/promises';
13
- import { join, extname, normalize, resolve, basename } from 'node:path';
14
- import { existsSync, statSync } from 'node:fs';
15
- import { getLogger } from './Logger.js';
16
- import { ConfigLoader } from './ConfigLoader.js';
17
- import { SslConfig } from './SslConfig.js';
18
- import type { SslOptions } from './SslConfig.js';
19
-
20
- /** Common MIME types for static file serving. */
21
- const MIME_TYPES: Record<string, string> = {
22
- '.html': 'text/html',
23
- '.htm': 'text/html',
24
- '.css': 'text/css',
25
- '.js': 'application/javascript',
26
- '.mjs': 'application/javascript',
27
- '.json': 'application/json',
28
- '.xml': 'application/xml',
29
- '.txt': 'text/plain',
30
- '.md': 'text/markdown',
31
- '.csv': 'text/csv',
32
- '.png': 'image/png',
33
- '.jpg': 'image/jpeg',
34
- '.jpeg': 'image/jpeg',
35
- '.gif': 'image/gif',
36
- '.svg': 'image/svg+xml',
37
- '.ico': 'image/x-icon',
38
- '.webp': 'image/webp',
39
- '.woff': 'font/woff',
40
- '.woff2': 'font/woff2',
41
- '.ttf': 'font/ttf',
42
- '.otf': 'font/otf',
43
- '.mp3': 'audio/mpeg',
44
- '.wav': 'audio/wav',
45
- '.mp4': 'video/mp4',
46
- '.webm': 'video/webm',
47
- '.pdf': 'application/pdf',
48
- '.zip': 'application/zip',
49
- '.gz': 'application/gzip',
50
- };
51
-
52
- /** Configuration options for WebService. */
53
- export interface WebServiceOptions {
54
- /** Port to bind to. Default: 8002. */
55
- port?: number;
56
- /** Map of URL route prefixes to local directory paths. Default: {}. */
57
- directories?: Record<string, string>;
58
- /** Basic auth credentials as [username, password]. Default: none. */
59
- basicAuth?: [string, string];
60
- /** Path to a JSON config file. Default: none. */
61
- configFile?: string;
62
- /** Serve directory listings and fall back to index.html. Default: false. */
63
- enableDirectoryBrowsing?: boolean;
64
- /** Allowlist of file extensions (e.g. ['.html', '.css']). Default: all allowed. */
65
- allowedExtensions?: string[];
66
- /**
67
- * Blocklist of file extensions or names.
68
- * Default: ['.env', '.git', '.gitignore', '.key', '.pem', '.crt', '.pyc', '__pycache__', '.DS_Store', '.swp']
69
- */
70
- blockedExtensions?: string[];
71
- /** Maximum file size in bytes. Default: 104857600 (100 MB). */
72
- maxFileSize?: number;
73
- /** Enable CORS. Default: true. */
74
- enableCors?: boolean;
75
- /** SSL/TLS configuration options. */
76
- ssl?: SslOptions;
77
- }
78
-
79
- /** Escapes HTML special characters to prevent XSS in directory listings. */
80
- function escapeHtml(str: string): string {
81
- return str
82
- .replace(/&/g, '&amp;')
83
- .replace(/</g, '&lt;')
84
- .replace(/>/g, '&gt;')
85
- .replace(/"/g, '&quot;')
86
- .replace(/'/g, '&#39;');
87
- }
88
-
89
- /** Format a file size in bytes to a human-readable string. */
90
- function formatSize(bytes: number): string {
91
- if (bytes < 1024) return `${bytes} B`;
92
- if (bytes < 1024 * 1024) return `${(bytes / 1024).toFixed(1)} KB`;
93
- return `${(bytes / (1024 * 1024)).toFixed(1)} MB`;
94
- }
95
-
96
- /**
97
- * Static file serving service with HTTP API.
98
- *
99
- * Provides configurable static file hosting with per-route directory mounting,
100
- * extension filtering, file size limits, HTTP Basic Auth, CORS, directory
101
- * browsing, and optional SSL/TLS. Mirrors the Python SDK's WebService class.
102
- */
103
- export class WebService {
104
- /** Port the service binds to. */
105
- readonly port: number;
106
- /** Whether directory listings are enabled. */
107
- readonly enableDirectoryBrowsing: boolean;
108
- /** Maximum file size in bytes that will be served. */
109
- readonly maxFileSize: number;
110
- /** Whether CORS is enabled. */
111
- readonly enableCors: boolean;
112
- /** Allowlist of file extensions, or null to allow all (subject to blocklist). */
113
- readonly allowedExtensions: string[] | null;
114
- /** Blocklist of file extensions and file names. */
115
- readonly blockedExtensions: string[];
116
- /** Map of URL route prefixes to local directory paths. */
117
- readonly directories: Record<string, string>;
118
-
119
- private _app: Hono;
120
- private _basicAuth: [string, string] | null;
121
- private _ssl: SslConfig;
122
- private _server: { close?: () => void } | null = null;
123
- private readonly log = getLogger('WebService');
124
-
125
- /** Default blocked extensions and file names (security-sensitive files). */
126
- private static readonly DEFAULT_BLOCKED = [
127
- '.env', '.git', '.gitignore', '.key', '.pem', '.crt',
128
- '.pyc', '__pycache__', '.DS_Store', '.swp',
129
- ];
130
-
131
- /**
132
- * Create a WebService.
133
- * @param options - Configuration options for the service.
134
- */
135
- constructor(options?: WebServiceOptions) {
136
- // Load configuration from file first (if provided), then override with
137
- // explicit constructor parameters, mirroring the Python SDK's precedence.
138
- const fileConfig = this._loadConfig(options?.configFile);
139
-
140
- this.port = options?.port ?? fileConfig.port ?? 8002;
141
- this.directories = { ...(fileConfig.directories ?? {}), ...(options?.directories ?? {}) };
142
- this._basicAuth = options?.basicAuth ?? null;
143
- this.enableDirectoryBrowsing =
144
- options?.enableDirectoryBrowsing ?? fileConfig.enableDirectoryBrowsing ?? false;
145
- this.allowedExtensions =
146
- options?.allowedExtensions ?? fileConfig.allowedExtensions ?? null;
147
- this.blockedExtensions =
148
- options?.blockedExtensions ?? fileConfig.blockedExtensions ?? [...WebService.DEFAULT_BLOCKED];
149
- this.maxFileSize = options?.maxFileSize ?? fileConfig.maxFileSize ?? 100 * 1024 * 1024;
150
- this.enableCors = options?.enableCors ?? fileConfig.enableCors ?? true;
151
- this._ssl = new SslConfig(options?.ssl);
152
-
153
- this._app = new Hono();
154
- this._setupMiddleware();
155
- this._setupRoutes();
156
- this._mountDirectories();
157
- }
158
-
159
- // ── Public API ─────────────────────────────────────────────────────
160
-
161
- /**
162
- * Add a new directory to serve at a URL route prefix.
163
- * @param route - URL prefix (e.g. '/docs').
164
- * @param directory - Local directory path to serve.
165
- * @throws If the directory does not exist or is not a directory.
166
- */
167
- addDirectory(route: string, directory: string): void {
168
- const r = route.startsWith('/') ? route : `/${route}`;
169
- const dirPath = resolve(directory);
170
-
171
- if (!existsSync(dirPath)) {
172
- throw new Error(`Directory does not exist: ${directory}`);
173
- }
174
-
175
- if (!statSync(dirPath).isDirectory()) {
176
- throw new Error(`Path is not a directory: ${directory}`);
177
- }
178
-
179
- this.directories[r] = directory;
180
- this._mountSingleDirectory(r, directory);
181
- }
182
-
183
- /**
184
- * Remove a previously added directory route from the bookkeeping map.
185
- *
186
- * Note: Hono does not support dynamic route removal; a server restart
187
- * is required for the route to fully stop responding.
188
- * @param route - The URL route prefix to remove.
189
- */
190
- removeDirectory(route: string): void {
191
- const r = route.startsWith('/') ? route : `/${route}`;
192
- if (r in this.directories) {
193
- delete this.directories[r];
194
- }
195
- }
196
-
197
- /**
198
- * Get the Hono application for mounting or testing.
199
- * @returns The configured Hono app.
200
- */
201
- getApp(): Hono {
202
- return this._app;
203
- }
204
-
205
- /**
206
- * The SSL/TLS configuration for this service.
207
- *
208
- * Mirrors the Python SDK's `security` attribute (`SecurityConfig`), which
209
- * exposes SSL settings for post-construction inspection. In the Python SDK
210
- * `SecurityConfig` also covers CORS origins, HSTS, allowed hosts, and rate
211
- * limiting; in this SDK those concerns are configured via their own
212
- * constructor options (`enableCors`, `ssl`, etc.) and Hono middleware rather
213
- * than a single combined object.
214
- *
215
- * @returns The `SslConfig` instance used by this service.
216
- */
217
- get sslConfig(): SslConfig {
218
- return this._ssl;
219
- }
220
-
221
- /**
222
- * Start the HTTP(S) service.
223
- * @param host - Bind address. Default: '0.0.0.0'.
224
- * @param port - Port override. Default: this.port.
225
- * @param sslCert - Path to SSL certificate file (overrides SslConfig).
226
- * @param sslKey - Path to SSL key file (overrides SslConfig).
227
- */
228
- async start(
229
- host?: string,
230
- port?: number,
231
- sslCert?: string,
232
- sslKey?: string,
233
- ): Promise<void> {
234
- // When loaded by the CLI tool, skip server startup.
235
- if (process.env['SWAIG_CLI_MODE'] === 'true') return;
236
-
237
- const h = host ?? '0.0.0.0';
238
- const p = port ?? this.port;
239
-
240
- // Determine SSL configuration
241
- const effectiveSsl = sslCert && sslKey
242
- ? new SslConfig({ enabled: true, certPath: sslCert, keyPath: sslKey })
243
- : this._ssl;
244
-
245
- const useHttps = effectiveSsl.isConfigured();
246
- const scheme = useHttps ? 'https' : 'http';
247
-
248
- this.log.info(`WebService starting on ${scheme}://${h}:${p}`);
249
- this.log.info(`Directories: ${Object.keys(this.directories).join(', ') || 'None'}`);
250
- this.log.info(`Directory Browsing: ${this.enableDirectoryBrowsing ? 'Enabled' : 'Disabled'}`);
251
- this.log.info(`Basic Auth: ${this._basicAuth ? 'Enabled' : 'Disabled'}`);
252
- if (useHttps) {
253
- this.log.info('SSL: Enabled');
254
- }
255
-
256
- const { serve } = await import('@hono/node-server');
257
-
258
- if (useHttps) {
259
- const serverOpts = effectiveSsl.getServerOptions();
260
- if (serverOpts) {
261
- const https = await import('node:https');
262
- const server = serve({
263
- fetch: this._app.fetch,
264
- port: p,
265
- hostname: h,
266
- createServer: https.createServer,
267
- serverOptions: serverOpts,
268
- });
269
- this._server = server as unknown as { close?: () => void };
270
- }
271
- } else {
272
- const server = serve({ fetch: this._app.fetch, port: p, hostname: h });
273
- this._server = server as unknown as { close?: () => void };
274
- }
275
- }
276
-
277
- /**
278
- * Stop the service and release resources.
279
- */
280
- stop(): void {
281
- if (this._server && typeof this._server.close === 'function') {
282
- this._server.close();
283
- this._server = null;
284
- this.log.info('WebService stopped');
285
- }
286
- }
287
-
288
- // ── Config loading ─────────────────────────────────────────────────
289
-
290
- /** Intermediate config shape returned by the file loader. */
291
- private _loadConfig(configFile?: string): {
292
- port?: number;
293
- directories?: Record<string, string>;
294
- enableDirectoryBrowsing?: boolean;
295
- allowedExtensions?: string[] | null;
296
- blockedExtensions?: string[];
297
- maxFileSize?: number;
298
- enableCors?: boolean;
299
- } {
300
- const result: ReturnType<WebService['_loadConfig']> = {};
301
-
302
- if (!configFile) {
303
- // Search standard locations for a web-service config
304
- const loader = ConfigLoader.search('web_service.json');
305
- if (!loader) return result;
306
- return this._extractServiceConfig(loader);
307
- }
308
-
309
- try {
310
- const loader = new ConfigLoader(configFile);
311
- return this._extractServiceConfig(loader);
312
- } catch {
313
- this.log.warn(`Failed to load config file: ${configFile}`);
314
- return result;
315
- }
316
- }
317
-
318
- private _extractServiceConfig(loader: ConfigLoader): ReturnType<WebService['_loadConfig']> {
319
- const result: ReturnType<WebService['_loadConfig']> = {};
320
-
321
- const port = loader.get<number>('service.port');
322
- if (port !== undefined) result.port = Number(port);
323
-
324
- const dirs = loader.get<Record<string, string>>('service.directories');
325
- if (dirs && typeof dirs === 'object') result.directories = dirs;
326
-
327
- const browsing = loader.get<boolean>('service.enableDirectoryBrowsing');
328
- if (browsing !== undefined) result.enableDirectoryBrowsing = Boolean(browsing);
329
-
330
- const maxSize = loader.get<number>('service.maxFileSize');
331
- if (maxSize !== undefined) result.maxFileSize = Number(maxSize);
332
-
333
- const allowed = loader.get<string[]>('service.allowedExtensions');
334
- if (Array.isArray(allowed)) result.allowedExtensions = allowed;
335
-
336
- const blocked = loader.get<string[]>('service.blockedExtensions');
337
- if (Array.isArray(blocked)) result.blockedExtensions = blocked;
338
-
339
- const corsEnabled = loader.get<boolean>('service.enableCors');
340
- if (corsEnabled !== undefined) result.enableCors = Boolean(corsEnabled);
341
-
342
- return result;
343
- }
344
-
345
- // ── Middleware setup ────────────────────────────────────────────────
346
-
347
- private _setupMiddleware(): void {
348
- // Security headers (same set as AgentServer and SWMLService)
349
- this._app.use('*', async (c, next) => {
350
- await next();
351
- c.res.headers.set('X-Content-Type-Options', 'nosniff');
352
- c.res.headers.set('X-Frame-Options', 'DENY');
353
- c.res.headers.set('X-XSS-Protection', '1; mode=block');
354
- c.res.headers.set('Referrer-Policy', 'strict-origin-when-cross-origin');
355
- c.res.headers.set('Content-Security-Policy', "default-src 'none'; frame-ancestors 'none'");
356
- c.res.headers.set('Permissions-Policy', 'camera=(), microphone=(), geolocation=()');
357
- });
358
-
359
- // CORS
360
- if (this.enableCors) {
361
- const corsOrigins = process.env['SWML_CORS_ORIGINS'];
362
- const corsOrigin = corsOrigins ? corsOrigins.split(',').map((o: string) => o.trim()) : '*';
363
- const corsCredentials = corsOrigin !== '*';
364
- this._app.use('*', cors({ origin: corsOrigin, credentials: corsCredentials }));
365
- }
366
-
367
- // SSL HSTS middleware
368
- if (this._ssl.isConfigured()) {
369
- this._app.use('*', this._ssl.hstsMiddleware());
370
- }
371
-
372
- // Basic auth (applied to all routes if configured)
373
- if (this._basicAuth) {
374
- const [user, pass] = this._basicAuth;
375
- this._app.use('*', basicAuth({ username: user, password: pass }));
376
- }
377
- }
378
-
379
- // ── Route setup ────────────────────────────────────────────────────
380
-
381
- private _setupRoutes(): void {
382
- // Health endpoint
383
- this._app.get('/health', (c) =>
384
- c.json({
385
- status: 'healthy',
386
- directories: Object.keys(this.directories),
387
- sslEnabled: this._ssl.isConfigured(),
388
- authRequired: Boolean(this._basicAuth),
389
- directoryBrowsing: this.enableDirectoryBrowsing,
390
- }),
391
- );
392
-
393
- // Root endpoint showing available directories
394
- this._app.get('/', (c) => {
395
- const dirEntries = Object.entries(this.directories);
396
-
397
- if (dirEntries.length === 0) {
398
- return c.json({
399
- service: 'SignalWire Web Service',
400
- directories: [],
401
- });
402
- }
403
-
404
- const items = dirEntries
405
- .map(
406
- ([route, localPath]) =>
407
- `<li><a href="${escapeHtml(route)}">${escapeHtml(route)}</a>` +
408
- ` <span class="path">&rarr; ${escapeHtml(localPath)}</span></li>`,
409
- )
410
- .join('\n');
411
-
412
- const html = `<!DOCTYPE html>
413
- <html>
414
- <head>
415
- <title>SignalWire Web Service</title>
416
- <style>
417
- body { font-family: sans-serif; margin: 40px; }
418
- h1 { color: #333; }
419
- ul { list-style: none; padding: 0; }
420
- li { padding: 10px 0; }
421
- a { text-decoration: none; color: #0066cc; font-size: 18px; }
422
- a:hover { text-decoration: underline; }
423
- .path { color: #666; font-size: 14px; }
424
- </style>
425
- </head>
426
- <body>
427
- <h1>SignalWire Web Service</h1>
428
- <h2>Available Directories:</h2>
429
- <ul>
430
- ${items}
431
- </ul>
432
- </body>
433
- </html>`;
434
- c.header('Content-Type', 'text/html');
435
- return c.body(html);
436
- });
437
- }
438
-
439
- // ── Directory mounting ─────────────────────────────────────────────
440
-
441
- private _mountDirectories(): void {
442
- for (const [route, dir] of Object.entries(this.directories)) {
443
- const dirPath = resolve(dir);
444
- if (!existsSync(dirPath)) {
445
- this.log.warn(`Directory does not exist: ${dir}`);
446
- continue;
447
- }
448
- this._mountSingleDirectory(route, dir);
449
- }
450
- }
451
-
452
- private _mountSingleDirectory(route: string, directory: string): void {
453
- const baseDir = resolve(directory);
454
- const routePrefix = route.replace(/\/+$/, '') || '/';
455
-
456
- this._app.get(`${routePrefix}/*`, async (c) => {
457
- const requestedPath = c.req.path.slice(routePrefix.length);
458
-
459
- // Path traversal protection: reject any path containing ".."
460
- if (requestedPath.includes('..')) {
461
- return c.json({ error: 'Forbidden' }, 403);
462
- }
463
-
464
- const normalizedPath = normalize(requestedPath);
465
- const fullPath = resolve(join(baseDir, normalizedPath));
466
-
467
- // Double-check the resolved path is within the base directory
468
- if (!fullPath.startsWith(baseDir)) {
469
- return c.json({ error: 'Forbidden' }, 403);
470
- }
471
-
472
- try {
473
- const fileStat = await stat(fullPath);
474
-
475
- // Handle directory requests
476
- if (fileStat.isDirectory()) {
477
- if (!this.enableDirectoryBrowsing) {
478
- // Try index.html fallback
479
- const indexPath = join(fullPath, 'index.html');
480
- try {
481
- const idxStat = await stat(indexPath);
482
- if (idxStat.isFile() && this._isFileAllowed(indexPath, idxStat.size)) {
483
- return this._serveFile(c, indexPath);
484
- }
485
- } catch {
486
- // No index.html found
487
- }
488
- return c.json({ error: 'Directory browsing disabled' }, 403);
489
- }
490
- return this._serveDirectoryListing(c, fullPath, c.req.path);
491
- }
492
-
493
- // Regular file
494
- if (!fileStat.isFile()) {
495
- return c.json({ error: 'Not found' }, 404);
496
- }
497
-
498
- if (!this._isFileAllowed(fullPath, fileStat.size)) {
499
- return c.json({ error: 'File type not allowed' }, 403);
500
- }
501
-
502
- return this._serveFile(c, fullPath);
503
- } catch {
504
- return c.json({ error: 'Not found' }, 404);
505
- }
506
- });
507
-
508
- this.log.info(`Serving static files from ${baseDir} at ${routePrefix}/*`);
509
- }
510
-
511
- // ── File checks ────────────────────────────────────────────────────
512
-
513
- private _isFileAllowed(fullPath: string, size: number): boolean {
514
- // Check file size
515
- if (size > this.maxFileSize) return false;
516
-
517
- const ext = extname(fullPath).toLowerCase();
518
- const name = basename(fullPath);
519
-
520
- // Check blocked extensions and names
521
- for (const blocked of this.blockedExtensions) {
522
- if (blocked.startsWith('.')) {
523
- // Check both as extension and as full name (for files like .env, .gitignore)
524
- if (ext === blocked || name === blocked) return false;
525
- } else {
526
- // Check as a file name or as a substring of the path
527
- if (name === blocked || fullPath.includes(blocked)) return false;
528
- }
529
- }
530
-
531
- // If allowedExtensions is set, only allow those
532
- if (this.allowedExtensions && !this.allowedExtensions.includes(ext)) return false;
533
-
534
- return true;
535
- }
536
-
537
- // ── File serving ───────────────────────────────────────────────────
538
-
539
- private async _serveFile(c: any, fullPath: string): Promise<Response> {
540
- const content = await readFile(fullPath);
541
- const ext = extname(fullPath).toLowerCase();
542
- const contentType = MIME_TYPES[ext] ?? 'application/octet-stream';
543
-
544
- c.header('Content-Type', contentType);
545
- c.header('Cache-Control', 'public, max-age=3600');
546
- c.header('X-Content-Type-Options', 'nosniff');
547
-
548
- return c.body(content);
549
- }
550
-
551
- // ── Directory listing ──────────────────────────────────────────────
552
-
553
- private async _serveDirectoryListing(
554
- c: any,
555
- dirPath: string,
556
- urlPath: string,
557
- ): Promise<Response> {
558
- const entries = await readdir(dirPath, { withFileTypes: true });
559
-
560
- // Sort entries alphabetically
561
- const sorted = entries
562
- .filter((e) => !e.name.startsWith('.'))
563
- .sort((a, b) => a.name.localeCompare(b.name));
564
-
565
- const items: string[] = [];
566
-
567
- // Add parent directory link if not at root
568
- if (urlPath !== '/') {
569
- items.push('<li><a href="../">../</a></li>');
570
- }
571
-
572
- // List directories first, then files (matching Python SDK behavior)
573
- for (const entry of sorted) {
574
- if (entry.isDirectory()) {
575
- const safeName = escapeHtml(entry.name);
576
- items.push(`<li><a href="${safeName}/">${safeName}/</a></li>`);
577
- }
578
- }
579
-
580
- for (const entry of sorted) {
581
- if (entry.isFile()) {
582
- const entryPath = join(dirPath, entry.name);
583
- try {
584
- const entryStat = await stat(entryPath);
585
- if (this._isFileAllowed(entryPath, entryStat.size)) {
586
- const safeName = escapeHtml(entry.name);
587
- const sizeStr = formatSize(entryStat.size);
588
- items.push(`<li><a href="${safeName}">${safeName}</a> (${sizeStr})</li>`);
589
- }
590
- } catch {
591
- // Skip files we can't stat
592
- }
593
- }
594
- }
595
-
596
- const html = `<!DOCTYPE html>
597
- <html>
598
- <head>
599
- <title>Directory listing for ${escapeHtml(urlPath)}</title>
600
- <style>
601
- body { font-family: sans-serif; margin: 40px; }
602
- h1 { color: #333; }
603
- ul { list-style: none; padding: 0; }
604
- li { padding: 5px 0; }
605
- a { text-decoration: none; color: #0066cc; }
606
- a:hover { text-decoration: underline; }
607
- </style>
608
- </head>
609
- <body>
610
- <h1>Directory listing for ${escapeHtml(urlPath)}</h1>
611
- <ul>
612
- ${items.join('\n ')}
613
- </ul>
614
- </body>
615
- </html>`;
616
- c.header('Content-Type', 'text/html');
617
- return c.body(html);
618
- }
619
- }