@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
@@ -1,361 +0,0 @@
1
- /**
2
- * SchemaUtils - JSON Schema validation for SWML documents.
3
- *
4
- * Provides basic structural validation of rendered SWML and
5
- * schema-driven verb extraction/validation.
6
- * Set SWML_SKIP_SCHEMA_VALIDATION=true to disable.
7
- */
8
-
9
- import { createRequire } from 'module';
10
-
11
- /** Result of validating a SWML document. */
12
- export interface ValidationResult {
13
- /** Whether the document passed all validation checks. */
14
- valid: boolean;
15
- /** List of human-readable error messages; empty when valid. */
16
- errors: string[];
17
- }
18
-
19
- /** A verb definition extracted from the schema. */
20
- export interface VerbDefinition {
21
- /** The verb name as used in SWML (e.g. "answer", "hangup", "sip_refer"). */
22
- name: string;
23
- /** The PascalCase schema definition name (e.g. "Answer", "Hangup", "SIPRefer"). */
24
- schemaName: string;
25
- /** The raw JSON Schema definition object for this verb. */
26
- definition: Record<string, unknown>;
27
- }
28
-
29
- // Basic SWML structure expectations
30
- const REQUIRED_TOP_LEVEL = ['version', 'sections'];
31
- const VALID_VERSIONS = ['1.0.0'];
32
-
33
- /** Validates SWML documents against structural rules with an LRU-style result cache. */
34
- export class SchemaUtils {
35
- private skipValidation: boolean;
36
- private cache: Map<string, ValidationResult> = new Map();
37
- private maxCacheSize: number;
38
- private schema: Record<string, unknown> | null = null;
39
- private verbs: Map<string, VerbDefinition> = new Map();
40
- /** Path to the schema file, or null to use the bundled schema. */
41
- private schemaPath: string | null;
42
-
43
- /**
44
- * Create a SchemaUtils instance.
45
- * @param opts - Optional settings for skipping validation, limiting cache size, or overriding the schema file path.
46
- */
47
- constructor(opts?: { skipValidation?: boolean; maxCacheSize?: number; schemaPath?: string }) {
48
- this.skipValidation = opts?.skipValidation ?? (process.env['SWML_SKIP_SCHEMA_VALIDATION'] === 'true');
49
- this.maxCacheSize = opts?.maxCacheSize ?? 100;
50
- this.schemaPath = opts?.schemaPath ?? null;
51
- this.loadSchema();
52
- }
53
-
54
- /**
55
- * Load the schema from the path specified in opts.schemaPath (if given) or fall back
56
- * to the bundled schema.json. Mirrors Python's SchemaUtils which accepts an explicit
57
- * schema_path and falls back to _get_default_schema_path() when None is supplied.
58
- */
59
- private loadSchema(): void {
60
- // Try custom schema path first (mirrors Python's schema_path parameter)
61
- if (this.schemaPath) {
62
- try {
63
- const require = createRequire(import.meta.url);
64
- this.schema = require(this.schemaPath) as Record<string, unknown>;
65
- this.verbs = this.extractVerbDefinitions();
66
- return;
67
- } catch {
68
- // Fall through to bundled schema on load failure
69
- }
70
- }
71
- // Fall back to bundled schema.json
72
- try {
73
- const require = createRequire(import.meta.url);
74
- this.schema = require('./schema.json') as Record<string, unknown>;
75
- this.verbs = this.extractVerbDefinitions();
76
- } catch {
77
- // Schema loading is optional — validation still works structurally
78
- this.schema = null;
79
- }
80
- }
81
-
82
- /**
83
- * Extract verb definitions from `$defs/SWMLMethod.anyOf` in the schema.
84
- * Mirrors Python SDK's `_extract_verb_definitions()`.
85
- */
86
- private extractVerbDefinitions(): Map<string, VerbDefinition> {
87
- const verbs = new Map<string, VerbDefinition>();
88
- if (!this.schema) return verbs;
89
-
90
- const defs = this.schema['$defs'] as Record<string, unknown> | undefined;
91
- if (!defs) return verbs;
92
-
93
- const swmlMethod = defs['SWMLMethod'] as Record<string, unknown> | undefined;
94
- if (!swmlMethod || !Array.isArray(swmlMethod['anyOf'])) return verbs;
95
-
96
- for (const ref of swmlMethod['anyOf'] as Record<string, unknown>[]) {
97
- const refPath = ref['$ref'] as string | undefined;
98
- if (!refPath) continue;
99
-
100
- // Extract the PascalCase name from "#/$defs/Answer"
101
- const schemaName = refPath.split('/').pop()!;
102
- const verbDef = defs[schemaName] as Record<string, unknown> | undefined;
103
- if (!verbDef || !verbDef['properties']) continue;
104
-
105
- // The actual verb name is the first (and only) property key
106
- const propNames = Object.keys(verbDef['properties'] as Record<string, unknown>);
107
- if (propNames.length === 0) continue;
108
-
109
- const verbName = propNames[0];
110
- verbs.set(verbName, {
111
- name: verbName,
112
- schemaName,
113
- definition: verbDef,
114
- });
115
- }
116
-
117
- return verbs;
118
- }
119
-
120
- /**
121
- * Get all verb names defined in the schema.
122
- * @returns Array of verb names (e.g. ["answer", "ai", "hangup", ...]).
123
- */
124
- getVerbNames(): string[] {
125
- return Array.from(this.verbs.keys());
126
- }
127
-
128
- /**
129
- * Get the inner properties schema for a specific verb.
130
- * For example, for "hangup" this returns `{ type: "object", properties: { reason: ... }, ... }`.
131
- * @param verbName - The verb name (e.g. "answer", "tap").
132
- * @returns The inner schema definition or an empty object if not found.
133
- */
134
- getVerbProperties(verbName: string): Record<string, unknown> {
135
- const verb = this.verbs.get(verbName);
136
- if (!verb) return {};
137
- const outerProps = verb.definition['properties'] as Record<string, unknown> | undefined;
138
- if (!outerProps || !outerProps[verbName]) return {};
139
- return outerProps[verbName] as Record<string, unknown>;
140
- }
141
-
142
- /**
143
- * Get the required properties for a verb's inner config.
144
- * @param verbName - The verb name.
145
- * @returns Array of required property names.
146
- */
147
- getVerbRequiredProperties(verbName: string): string[] {
148
- const innerSchema = this.getVerbProperties(verbName);
149
- if (!innerSchema || !Array.isArray(innerSchema['required'])) return [];
150
- return innerSchema['required'] as string[];
151
- }
152
-
153
- /**
154
- * Get the description text for a verb.
155
- * @param verbName - The verb name.
156
- * @returns The description string or empty string.
157
- */
158
- getVerbDescription(verbName: string): string {
159
- const innerSchema = this.getVerbProperties(verbName);
160
- return (innerSchema['description'] as string) ?? '';
161
- }
162
-
163
- /**
164
- * Check if a verb name is defined in the schema.
165
- * @param verbName - The verb name.
166
- * @returns True if the verb exists.
167
- */
168
- hasVerb(verbName: string): boolean {
169
- return this.verbs.has(verbName);
170
- }
171
-
172
- /**
173
- * Lightweight validation of a verb config against the schema.
174
- * Checks that the verb exists and required properties are present.
175
- * Mirrors Python SDK's `_validate_verb_lightweight()`.
176
- *
177
- * @param verbName - The verb name.
178
- * @param config - The verb configuration to validate.
179
- * @returns Validation result.
180
- */
181
- validateVerb(verbName: string, config: unknown): ValidationResult {
182
- if (this.skipValidation) {
183
- return { valid: true, errors: [] };
184
- }
185
-
186
- const errors: string[] = [];
187
-
188
- // Check verb exists
189
- if (!this.verbs.has(verbName)) {
190
- errors.push(`Unknown verb: '${verbName}'`);
191
- return { valid: false, errors };
192
- }
193
-
194
- const innerSchema = this.getVerbProperties(verbName);
195
-
196
- // If the inner schema is not an object type (e.g. "label" takes a string,
197
- // "sleep" takes anyOf int/object), skip property checks
198
- const innerType = innerSchema['type'];
199
- if (innerType !== 'object') {
200
- return { valid: true, errors: [] };
201
- }
202
-
203
- // Config must be an object for object-typed verbs
204
- if (typeof config !== 'object' || config === null || Array.isArray(config)) {
205
- // Allow empty config for verbs with no required props
206
- const required = this.getVerbRequiredProperties(verbName);
207
- if (required.length > 0) {
208
- errors.push(`Verb '${verbName}' expects an object config`);
209
- return { valid: false, errors };
210
- }
211
- return { valid: true, errors: [] };
212
- }
213
-
214
- // Check required properties
215
- const required = this.getVerbRequiredProperties(verbName);
216
- const configObj = config as Record<string, unknown>;
217
- for (const prop of required) {
218
- if (!(prop in configObj)) {
219
- errors.push(`Missing required property '${prop}' for verb '${verbName}'`);
220
- }
221
- }
222
-
223
- return { valid: errors.length === 0, errors };
224
- }
225
-
226
- /**
227
- * Validate a SWML document against structural rules.
228
- * @param swml - The SWML document as a JSON string or parsed object.
229
- * @returns The validation result indicating success or a list of errors.
230
- */
231
- validate(swml: string | Record<string, unknown>): ValidationResult {
232
- if (this.skipValidation) {
233
- return { valid: true, errors: [] };
234
- }
235
-
236
- const swmlStr = typeof swml === 'string' ? swml : JSON.stringify(swml);
237
-
238
- // Check cache
239
- const cached = this.cache.get(swmlStr);
240
- if (cached) return cached;
241
-
242
- const errors: string[] = [];
243
- let doc: Record<string, unknown>;
244
-
245
- try {
246
- doc = typeof swml === 'string' ? JSON.parse(swml) : swml;
247
- } catch {
248
- const result: ValidationResult = { valid: false, errors: ['Invalid JSON'] };
249
- this.cacheResult(swmlStr, result);
250
- return result;
251
- }
252
-
253
- // Check top-level required keys
254
- for (const key of REQUIRED_TOP_LEVEL) {
255
- if (!(key in doc)) {
256
- errors.push(`Missing required top-level key: ${key}`);
257
- }
258
- }
259
-
260
- // Check version
261
- if (doc['version'] && !VALID_VERSIONS.includes(doc['version'] as string)) {
262
- errors.push(`Invalid version: ${doc['version']}. Expected one of: ${VALID_VERSIONS.join(', ')}`);
263
- }
264
-
265
- // Check sections
266
- if (doc['sections']) {
267
- if (typeof doc['sections'] !== 'object' || Array.isArray(doc['sections'])) {
268
- errors.push('sections must be an object');
269
- } else {
270
- const sections = doc['sections'] as Record<string, unknown>;
271
- if (!('main' in sections)) {
272
- errors.push('sections must contain a "main" section');
273
- }
274
- // Validate each section is an array
275
- for (const [name, section] of Object.entries(sections)) {
276
- if (!Array.isArray(section)) {
277
- errors.push(`Section "${name}" must be an array`);
278
- }
279
- }
280
- }
281
- }
282
-
283
- // Validate AI verb structure if present
284
- if (doc['sections'] && typeof doc['sections'] === 'object') {
285
- const sections = doc['sections'] as Record<string, unknown[]>;
286
- const main = sections['main'];
287
- if (Array.isArray(main)) {
288
- for (const verb of main) {
289
- if (typeof verb === 'object' && verb !== null && 'ai' in verb) {
290
- this.validateAiVerb((verb as Record<string, unknown>)['ai'] as Record<string, unknown>, errors);
291
- }
292
- }
293
- }
294
- }
295
-
296
- const result: ValidationResult = {
297
- valid: errors.length === 0,
298
- errors,
299
- };
300
- this.cacheResult(swmlStr, result);
301
- return result;
302
- }
303
-
304
- private validateAiVerb(ai: Record<string, unknown>, errors: string[]): void {
305
- if (!ai) return;
306
-
307
- // Prompt must have text
308
- if (ai['prompt']) {
309
- const prompt = ai['prompt'] as Record<string, unknown>;
310
- if (typeof prompt === 'object' && !prompt['text']) {
311
- errors.push('AI prompt must have a "text" field');
312
- }
313
- }
314
-
315
- // SWAIG validation
316
- if (ai['SWAIG']) {
317
- const swaig = ai['SWAIG'] as Record<string, unknown>;
318
- if (swaig['functions'] && !Array.isArray(swaig['functions'])) {
319
- errors.push('SWAIG functions must be an array');
320
- }
321
- if (Array.isArray(swaig['functions'])) {
322
- for (let i = 0; i < (swaig['functions'] as unknown[]).length; i++) {
323
- const fn = (swaig['functions'] as Record<string, unknown>[])[i];
324
- if (!fn['function']) {
325
- errors.push(`SWAIG function at index ${i} missing "function" name`);
326
- }
327
- }
328
- }
329
- }
330
-
331
- // Post-prompt validation
332
- if (ai['post_prompt']) {
333
- const pp = ai['post_prompt'] as Record<string, unknown>;
334
- if (typeof pp === 'object' && !pp['text']) {
335
- errors.push('AI post_prompt must have a "text" field');
336
- }
337
- }
338
- }
339
-
340
- /** Clear the validation cache */
341
- clearCache(): void {
342
- this.cache.clear();
343
- }
344
-
345
- /**
346
- * Get the number of cached validation results.
347
- * @returns The current cache entry count.
348
- */
349
- getCacheSize(): number {
350
- return this.cache.size;
351
- }
352
-
353
- private cacheResult(key: string, result: ValidationResult): void {
354
- if (this.cache.size >= this.maxCacheSize) {
355
- // Remove oldest entry
356
- const firstKey = this.cache.keys().next().value;
357
- if (firstKey) this.cache.delete(firstKey);
358
- }
359
- this.cache.set(key, result);
360
- }
361
- }
@@ -1,221 +0,0 @@
1
- /**
2
- * ServerlessAdapter - Adapts AgentBase for serverless platforms.
3
- *
4
- * Supports AWS Lambda, Google Cloud Functions, Azure Functions, and CGI mode.
5
- * Auto-detects platform from environment variables.
6
- */
7
-
8
- import { getLogger } from './Logger.js';
9
-
10
- const log = getLogger('ServerlessAdapter');
11
-
12
- /** Supported serverless platform identifiers, or 'auto' for environment-based detection. */
13
- export type ServerlessPlatform = 'lambda' | 'gcf' | 'azure' | 'cgi' | 'auto';
14
-
15
- /** Normalized incoming event from a serverless platform. */
16
- export interface ServerlessEvent {
17
- /** HTTP method (AWS Lambda style). */
18
- httpMethod?: string;
19
- /** HTTP method (GCF/Azure style). */
20
- method?: string;
21
- /** Request headers as key-value pairs. */
22
- headers?: Record<string, string>;
23
- /** Request body, either raw JSON string or parsed object. */
24
- body?: string | Record<string, unknown>;
25
- /** Request path. */
26
- path?: string;
27
- /** Raw request path (AWS API Gateway v2). */
28
- rawPath?: string;
29
- /** Query string parameters as key-value pairs. */
30
- queryStringParameters?: Record<string, string>;
31
- /** Platform-specific request context metadata. */
32
- requestContext?: Record<string, unknown>;
33
- }
34
-
35
- /** Normalized outgoing response returned to a serverless platform. */
36
- export interface ServerlessResponse {
37
- /** HTTP status code. */
38
- statusCode: number;
39
- /** Response headers as key-value pairs. */
40
- headers: Record<string, string>;
41
- /** Response body as a string. */
42
- body: string;
43
- }
44
-
45
- /** Adapts a Hono application for deployment on AWS Lambda, Google Cloud Functions, Azure Functions, or CGI. */
46
- export class ServerlessAdapter {
47
- private platform: ServerlessPlatform;
48
-
49
- /**
50
- * Create a ServerlessAdapter for the given platform.
51
- * @param platform - Target platform; defaults to 'auto' which detects from environment variables.
52
- */
53
- constructor(platform: ServerlessPlatform = 'auto') {
54
- this.platform = platform === 'auto' ? this.detectPlatform() : platform;
55
- }
56
-
57
- /**
58
- * Detect the serverless platform by inspecting well-known environment variables.
59
- * @returns The detected platform identifier; defaults to 'lambda' if no match is found.
60
- */
61
- detectPlatform(): ServerlessPlatform {
62
- if (process.env['AWS_LAMBDA_FUNCTION_NAME'] || process.env['_HANDLER']) return 'lambda';
63
- if (process.env['FUNCTION_TARGET'] || process.env['K_SERVICE']) return 'gcf';
64
- if (process.env['FUNCTIONS_WORKER_RUNTIME'] || process.env['AZURE_FUNCTIONS_ENVIRONMENT']) return 'azure';
65
- if (process.env['GATEWAY_INTERFACE']) return 'cgi';
66
- return 'lambda'; // default fallback
67
- }
68
-
69
- /**
70
- * Get the resolved platform identifier.
71
- * @returns The serverless platform this adapter is configured for.
72
- */
73
- getPlatform(): ServerlessPlatform {
74
- return this.platform;
75
- }
76
-
77
- /**
78
- * Convert a serverless event into a standard Request, route it through the Hono app, and return a normalized response.
79
- * @param app - A Hono-compatible application with a `fetch` method.
80
- * @param event - The incoming serverless event to process.
81
- * @returns The normalized serverless response.
82
- */
83
- async handleRequest(app: { fetch: (req: Request) => Promise<Response> }, event: ServerlessEvent): Promise<ServerlessResponse> {
84
- const method = event.httpMethod ?? event.method ?? 'POST';
85
- const path = event.rawPath ?? event.path ?? '/';
86
- const headers = event.headers ?? {};
87
-
88
- // Build URL — prefer platform env vars over client headers
89
- const host = process.env['AWS_LAMBDA_FUNCTION_URL']
90
- ? new URL(process.env['AWS_LAMBDA_FUNCTION_URL']).hostname
91
- : (headers['host'] ?? 'localhost');
92
- const proto = process.env['AWS_LAMBDA_FUNCTION_URL'] ? 'https'
93
- : (headers['x-forwarded-proto'] ?? 'https');
94
- let url = `${proto}://${host}${path}`;
95
- if (event.queryStringParameters) {
96
- const qs = new URLSearchParams(event.queryStringParameters).toString();
97
- if (qs) url += `?${qs}`;
98
- }
99
-
100
- // Build body
101
- let body: string | undefined;
102
- if (event.body) {
103
- body = typeof event.body === 'string' ? event.body : JSON.stringify(event.body);
104
- }
105
-
106
- // Create Request
107
- const request = new Request(url, {
108
- method,
109
- headers: new Headers(headers),
110
- body: method !== 'GET' && method !== 'HEAD' ? body : undefined,
111
- });
112
-
113
- log.debug(`Handling ${method} ${path} on ${this.platform}`);
114
-
115
- // Route through Hono
116
- const response = await app.fetch(request);
117
-
118
- // Convert back to serverless response
119
- const responseHeaders: Record<string, string> = {};
120
- response.headers.forEach((v, k) => { responseHeaders[k] = v; });
121
-
122
- return {
123
- statusCode: response.status,
124
- headers: responseHeaders,
125
- body: await response.text(),
126
- };
127
- }
128
-
129
- /**
130
- * Generate the platform-specific invocation URL for a deployed function.
131
- * @param opts - Optional overrides for region, project, function name, stage, or API ID.
132
- * @returns The constructed URL string.
133
- */
134
- generateUrl(opts?: {
135
- region?: string;
136
- projectId?: string;
137
- functionName?: string;
138
- stage?: string;
139
- apiId?: string;
140
- }): string {
141
- const functionName = opts?.functionName ?? process.env['AWS_LAMBDA_FUNCTION_NAME'] ?? 'agent';
142
-
143
- switch (this.platform) {
144
- case 'lambda': {
145
- const region = opts?.region ?? process.env['AWS_REGION'] ?? 'us-east-1';
146
- const apiId = opts?.apiId ?? 'API_ID';
147
- const stage = opts?.stage ?? 'prod';
148
- return `https://${apiId}.execute-api.${region}.amazonaws.com/${stage}`;
149
- }
150
- case 'gcf': {
151
- const project = opts?.projectId ?? process.env['GCLOUD_PROJECT'] ?? 'PROJECT';
152
- const region = opts?.region ?? process.env['FUNCTION_REGION'] ?? 'us-central1';
153
- return `https://${region}-${project}.cloudfunctions.net/${functionName}`;
154
- }
155
- case 'azure': {
156
- return `https://${functionName}.azurewebsites.net/api/${functionName}`;
157
- }
158
- case 'cgi': {
159
- return `http://localhost/cgi-bin/${functionName}`;
160
- }
161
- default:
162
- return `https://localhost/${functionName}`;
163
- }
164
- }
165
-
166
- /**
167
- * Create an AWS Lambda-compatible handler function from a Hono app.
168
- * @param app - A Hono-compatible application with a `fetch` method.
169
- * @returns A function that accepts a Lambda event and returns a promise of a serverless response.
170
- */
171
- static createLambdaHandler(app: { fetch: (req: Request) => Promise<Response> }): (event: ServerlessEvent) => Promise<ServerlessResponse> {
172
- const adapter = new ServerlessAdapter('lambda');
173
- return (event: ServerlessEvent) => adapter.handleRequest(app, event);
174
- }
175
-
176
- /**
177
- * Create a Google Cloud Functions-compatible handler from a Hono app.
178
- * @param app - A Hono-compatible application with a `fetch` method.
179
- * @returns A function that accepts GCF request/response objects.
180
- */
181
- static createGcfHandler(app: { fetch: (req: Request) => Promise<Response> }): (req: any, res: any) => Promise<void> {
182
- const adapter = new ServerlessAdapter('gcf');
183
- return async (req: any, res: any) => {
184
- const event: ServerlessEvent = {
185
- method: req.method,
186
- headers: req.headers,
187
- body: req.body,
188
- path: req.path ?? req.url,
189
- };
190
- const response = await adapter.handleRequest(app, event);
191
- res.status(response.statusCode);
192
- for (const [k, v] of Object.entries(response.headers)) {
193
- res.set(k, v);
194
- }
195
- res.send(response.body);
196
- };
197
- }
198
-
199
- /**
200
- * Create an Azure Functions-compatible handler from a Hono app.
201
- * @param app - A Hono-compatible application with a `fetch` method.
202
- * @returns A function that accepts an Azure context and request object.
203
- */
204
- static createAzureHandler(app: { fetch: (req: Request) => Promise<Response> }): (context: any, req: any) => Promise<void> {
205
- const adapter = new ServerlessAdapter('azure');
206
- return async (context: any, req: any) => {
207
- const event: ServerlessEvent = {
208
- method: req.method,
209
- headers: req.headers,
210
- body: req.body,
211
- path: req.url,
212
- };
213
- const response = await adapter.handleRequest(app, event);
214
- context.res = {
215
- status: response.statusCode,
216
- headers: response.headers,
217
- body: response.body,
218
- };
219
- };
220
- }
221
- }