@signalwire/sdk 2.0.1 → 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 (610) hide show
  1. package/dist/AgentBase.d.ts +1045 -0
  2. package/dist/AgentBase.js +2375 -0
  3. package/dist/AgentBase.js.map +1 -0
  4. package/dist/AgentServer.d.ts +146 -0
  5. package/dist/AgentServer.js +388 -0
  6. package/dist/AgentServer.js.map +1 -0
  7. package/dist/AuthHandler.d.ts +127 -0
  8. package/dist/AuthHandler.js +212 -0
  9. package/dist/AuthHandler.js.map +1 -0
  10. package/dist/ConfigLoader.d.ts +170 -0
  11. package/dist/ConfigLoader.js +393 -0
  12. package/dist/ConfigLoader.js.map +1 -0
  13. package/dist/ContextBuilder.d.ts +652 -0
  14. package/dist/ContextBuilder.js +1115 -0
  15. package/dist/ContextBuilder.js.map +1 -0
  16. package/dist/DataMap.d.ts +271 -0
  17. package/dist/DataMap.js +430 -0
  18. package/dist/DataMap.js.map +1 -0
  19. package/dist/FunctionResult.d.ts +481 -0
  20. package/dist/FunctionResult.js +775 -0
  21. package/dist/FunctionResult.js.map +1 -0
  22. package/dist/Logger.d.ts +113 -0
  23. package/dist/Logger.js +320 -0
  24. package/dist/Logger.js.map +1 -0
  25. package/dist/PomBuilder.d.ts +208 -0
  26. package/dist/PomBuilder.js +409 -0
  27. package/dist/PomBuilder.js.map +1 -0
  28. package/dist/PromptManager.d.ts +85 -0
  29. package/dist/PromptManager.js +108 -0
  30. package/dist/PromptManager.js.map +1 -0
  31. package/dist/SWMLHandler.d.ts +159 -0
  32. package/dist/SWMLHandler.js +229 -0
  33. package/dist/SWMLHandler.js.map +1 -0
  34. package/dist/SWMLService.d.ts +326 -0
  35. package/dist/SWMLService.js +610 -0
  36. package/dist/SWMLService.js.map +1 -0
  37. package/dist/SchemaUtils.d.ts +108 -0
  38. package/dist/SchemaUtils.js +317 -0
  39. package/dist/SchemaUtils.js.map +1 -0
  40. package/dist/SecurityUtils.d.ts +60 -0
  41. package/{src/SecurityUtils.ts → dist/SecurityUtils.js} +82 -83
  42. package/dist/SecurityUtils.js.map +1 -0
  43. package/dist/ServerlessAdapter.d.ts +119 -0
  44. package/dist/ServerlessAdapter.js +188 -0
  45. package/dist/ServerlessAdapter.js.map +1 -0
  46. package/dist/SessionManager.d.ts +142 -0
  47. package/dist/SessionManager.js +260 -0
  48. package/dist/SessionManager.js.map +1 -0
  49. package/dist/SslConfig.d.ts +77 -0
  50. package/dist/SslConfig.js +100 -0
  51. package/dist/SslConfig.js.map +1 -0
  52. package/dist/SwaigFunction.d.ts +159 -0
  53. package/dist/SwaigFunction.js +209 -0
  54. package/dist/SwaigFunction.js.map +1 -0
  55. package/dist/SwmlBuilder.d.ts +165 -0
  56. package/dist/SwmlBuilder.js +247 -0
  57. package/dist/SwmlBuilder.js.map +1 -0
  58. package/dist/SwmlVerbMethods.generated.d.ts +254 -0
  59. package/dist/SwmlVerbMethods.generated.js +9 -0
  60. package/dist/SwmlVerbMethods.generated.js.map +1 -0
  61. package/dist/TypeInference.d.ts +71 -0
  62. package/dist/TypeInference.js +164 -0
  63. package/dist/TypeInference.js.map +1 -0
  64. package/dist/WebService.d.ts +148 -0
  65. package/dist/WebService.js +532 -0
  66. package/dist/WebService.js.map +1 -0
  67. package/dist/cli/agent-loader.d.ts +22 -0
  68. package/dist/cli/agent-loader.js +144 -0
  69. package/dist/cli/agent-loader.js.map +1 -0
  70. package/dist/cli/mock-data.d.ts +37 -0
  71. package/dist/cli/mock-data.js +80 -0
  72. package/dist/cli/mock-data.js.map +1 -0
  73. package/dist/cli/swaig-test.d.ts +32 -0
  74. package/dist/cli/swaig-test.js +418 -0
  75. package/dist/cli/swaig-test.js.map +1 -0
  76. package/dist/generateVerbTypes.d.ts +11 -0
  77. package/dist/generateVerbTypes.js +265 -0
  78. package/dist/generateVerbTypes.js.map +1 -0
  79. package/{src/index.ts → dist/index.d.ts} +13 -100
  80. package/dist/index.js +152 -0
  81. package/dist/index.js.map +1 -0
  82. package/dist/livewire/index.d.ts +653 -0
  83. package/dist/livewire/index.js +992 -0
  84. package/dist/livewire/index.js.map +1 -0
  85. package/dist/prefabs/ConciergeAgent.d.ts +89 -0
  86. package/dist/prefabs/ConciergeAgent.js +245 -0
  87. package/dist/prefabs/ConciergeAgent.js.map +1 -0
  88. package/dist/prefabs/FAQBotAgent.d.ts +113 -0
  89. package/dist/prefabs/FAQBotAgent.js +329 -0
  90. package/dist/prefabs/FAQBotAgent.js.map +1 -0
  91. package/dist/prefabs/InfoGathererAgent.d.ts +126 -0
  92. package/dist/prefabs/InfoGathererAgent.js +287 -0
  93. package/dist/prefabs/InfoGathererAgent.js.map +1 -0
  94. package/dist/prefabs/ReceptionistAgent.d.ts +104 -0
  95. package/dist/prefabs/ReceptionistAgent.js +303 -0
  96. package/dist/prefabs/ReceptionistAgent.js.map +1 -0
  97. package/dist/prefabs/SurveyAgent.d.ts +148 -0
  98. package/dist/prefabs/SurveyAgent.js +540 -0
  99. package/dist/prefabs/SurveyAgent.js.map +1 -0
  100. package/{src/prefabs/index.ts → dist/prefabs/index.d.ts} +1 -15
  101. package/dist/prefabs/index.js +14 -0
  102. package/dist/prefabs/index.js.map +1 -0
  103. package/dist/relay/Action.d.ts +258 -0
  104. package/dist/relay/Action.js +402 -0
  105. package/dist/relay/Action.js.map +1 -0
  106. package/dist/relay/Call.d.ts +697 -0
  107. package/dist/relay/Call.js +1062 -0
  108. package/dist/relay/Call.js.map +1 -0
  109. package/dist/relay/Deferred.d.ts +44 -0
  110. package/dist/relay/Deferred.js +69 -0
  111. package/dist/relay/Deferred.js.map +1 -0
  112. package/dist/relay/Message.d.ts +103 -0
  113. package/dist/relay/Message.js +169 -0
  114. package/dist/relay/Message.js.map +1 -0
  115. package/dist/relay/RelayClient.d.ts +302 -0
  116. package/dist/relay/RelayClient.js +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/dist/rest/index.d.ts +131 -0
  149. package/{src/rest/index.ts → dist/rest/index.js} +101 -136
  150. package/dist/rest/index.js.map +1 -0
  151. package/dist/rest/namespaces/addresses.d.ts +46 -0
  152. package/dist/rest/namespaces/addresses.js +55 -0
  153. package/dist/rest/namespaces/addresses.js.map +1 -0
  154. package/dist/rest/namespaces/calling.d.ts +382 -0
  155. package/dist/rest/namespaces/calling.js +478 -0
  156. package/dist/rest/namespaces/calling.js.map +1 -0
  157. package/dist/rest/namespaces/chat.d.ts +22 -0
  158. package/dist/rest/namespaces/chat.js +26 -0
  159. package/dist/rest/namespaces/chat.js.map +1 -0
  160. package/dist/rest/namespaces/compat.d.ts +585 -0
  161. package/dist/rest/namespaces/compat.js +735 -0
  162. package/dist/rest/namespaces/compat.js.map +1 -0
  163. package/dist/rest/namespaces/datasphere.d.ts +66 -0
  164. package/dist/rest/namespaces/datasphere.js +77 -0
  165. package/dist/rest/namespaces/datasphere.js.map +1 -0
  166. package/dist/rest/namespaces/fabric.d.ts +282 -0
  167. package/dist/rest/namespaces/fabric.js +373 -0
  168. package/dist/rest/namespaces/fabric.js.map +1 -0
  169. package/dist/rest/namespaces/imported-numbers.d.ts +22 -0
  170. package/dist/rest/namespaces/imported-numbers.js +26 -0
  171. package/dist/rest/namespaces/imported-numbers.js.map +1 -0
  172. package/dist/rest/namespaces/logs.d.ts +105 -0
  173. package/dist/rest/namespaces/logs.js +133 -0
  174. package/dist/rest/namespaces/logs.js.map +1 -0
  175. package/dist/rest/namespaces/lookup.d.ts +29 -0
  176. package/dist/rest/namespaces/lookup.js +32 -0
  177. package/dist/rest/namespaces/lookup.js.map +1 -0
  178. package/dist/rest/namespaces/mfa.d.ts +46 -0
  179. package/dist/rest/namespaces/mfa.js +54 -0
  180. package/dist/rest/namespaces/mfa.js.map +1 -0
  181. package/dist/rest/namespaces/number-groups.d.ts +49 -0
  182. package/dist/rest/namespaces/number-groups.js +58 -0
  183. package/dist/rest/namespaces/number-groups.js.map +1 -0
  184. package/dist/rest/namespaces/phone-numbers.d.ts +60 -0
  185. package/dist/rest/namespaces/phone-numbers.js +67 -0
  186. package/dist/rest/namespaces/phone-numbers.js.map +1 -0
  187. package/dist/rest/namespaces/project.d.ts +46 -0
  188. package/dist/rest/namespaces/project.js +56 -0
  189. package/dist/rest/namespaces/project.js.map +1 -0
  190. package/dist/rest/namespaces/pubsub.d.ts +22 -0
  191. package/dist/rest/namespaces/pubsub.js +26 -0
  192. package/dist/rest/namespaces/pubsub.js.map +1 -0
  193. package/dist/rest/namespaces/queues.d.ts +42 -0
  194. package/dist/rest/namespaces/queues.js +49 -0
  195. package/dist/rest/namespaces/queues.js.map +1 -0
  196. package/dist/rest/namespaces/recordings.d.ts +38 -0
  197. package/dist/rest/namespaces/recordings.js +45 -0
  198. package/dist/rest/namespaces/recordings.js.map +1 -0
  199. package/dist/rest/namespaces/registry.d.ts +141 -0
  200. package/dist/rest/namespaces/registry.js +178 -0
  201. package/dist/rest/namespaces/registry.js.map +1 -0
  202. package/dist/rest/namespaces/short-codes.d.ts +39 -0
  203. package/dist/rest/namespaces/short-codes.js +46 -0
  204. package/dist/rest/namespaces/short-codes.js.map +1 -0
  205. package/dist/rest/namespaces/sip-profile.d.ts +28 -0
  206. package/dist/rest/namespaces/sip-profile.js +34 -0
  207. package/dist/rest/namespaces/sip-profile.js.map +1 -0
  208. package/dist/rest/namespaces/verified-callers.d.ts +33 -0
  209. package/dist/rest/namespaces/verified-callers.js +39 -0
  210. package/dist/rest/namespaces/verified-callers.js.map +1 -0
  211. package/dist/rest/namespaces/video.d.ts +235 -0
  212. package/dist/rest/namespaces/video.js +297 -0
  213. package/dist/rest/namespaces/video.js.map +1 -0
  214. package/{src/rest/pagination.ts → dist/rest/pagination.d.ts} +2 -61
  215. package/dist/rest/pagination.js +78 -0
  216. package/dist/rest/pagination.js.map +1 -0
  217. package/dist/rest/types.d.ts +54 -0
  218. package/dist/rest/types.js +5 -0
  219. package/dist/rest/types.js.map +1 -0
  220. package/dist/skills/SkillBase.d.ts +404 -0
  221. package/dist/skills/SkillBase.js +471 -0
  222. package/dist/skills/SkillBase.js.map +1 -0
  223. package/dist/skills/SkillManager.d.ts +195 -0
  224. package/dist/skills/SkillManager.js +378 -0
  225. package/dist/skills/SkillManager.js.map +1 -0
  226. package/dist/skills/SkillRegistry.d.ts +176 -0
  227. package/dist/skills/SkillRegistry.js +310 -0
  228. package/dist/skills/SkillRegistry.js.map +1 -0
  229. package/dist/skills/builtin/api_ninjas_trivia.d.ts +47 -0
  230. package/dist/skills/builtin/api_ninjas_trivia.js +211 -0
  231. package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -0
  232. package/dist/skills/builtin/ask_claude.d.ts +37 -0
  233. package/dist/skills/builtin/ask_claude.js +162 -0
  234. package/dist/skills/builtin/ask_claude.js.map +1 -0
  235. package/dist/skills/builtin/claude_skills.d.ts +75 -0
  236. package/dist/skills/builtin/claude_skills.js +753 -0
  237. package/dist/skills/builtin/claude_skills.js.map +1 -0
  238. package/dist/skills/builtin/custom_skills.d.ts +79 -0
  239. package/dist/skills/builtin/custom_skills.js +227 -0
  240. package/dist/skills/builtin/custom_skills.js.map +1 -0
  241. package/dist/skills/builtin/datasphere.d.ts +73 -0
  242. package/dist/skills/builtin/datasphere.js +350 -0
  243. package/dist/skills/builtin/datasphere.js.map +1 -0
  244. package/dist/skills/builtin/datasphere_serverless.d.ts +89 -0
  245. package/dist/skills/builtin/datasphere_serverless.js +291 -0
  246. package/dist/skills/builtin/datasphere_serverless.js.map +1 -0
  247. package/dist/skills/builtin/datetime.d.ts +40 -0
  248. package/dist/skills/builtin/datetime.js +118 -0
  249. package/dist/skills/builtin/datetime.js.map +1 -0
  250. package/dist/skills/builtin/google_maps.d.ts +48 -0
  251. package/dist/skills/builtin/google_maps.js +470 -0
  252. package/dist/skills/builtin/google_maps.js.map +1 -0
  253. package/dist/skills/builtin/index.d.ts +31 -0
  254. package/{src/skills/builtin/index.ts → dist/skills/builtin/index.js} +30 -36
  255. package/dist/skills/builtin/index.js.map +1 -0
  256. package/dist/skills/builtin/info_gatherer.d.ts +115 -0
  257. package/dist/skills/builtin/info_gatherer.js +328 -0
  258. package/dist/skills/builtin/info_gatherer.js.map +1 -0
  259. package/dist/skills/builtin/joke.d.ts +41 -0
  260. package/dist/skills/builtin/joke.js +156 -0
  261. package/dist/skills/builtin/joke.js.map +1 -0
  262. package/dist/skills/builtin/math.d.ts +39 -0
  263. package/dist/skills/builtin/math.js +119 -0
  264. package/dist/skills/builtin/math.js.map +1 -0
  265. package/dist/skills/builtin/mcp_gateway.d.ts +82 -0
  266. package/dist/skills/builtin/mcp_gateway.js +574 -0
  267. package/dist/skills/builtin/mcp_gateway.js.map +1 -0
  268. package/dist/skills/builtin/native_vector_search.d.ts +128 -0
  269. package/dist/skills/builtin/native_vector_search.js +752 -0
  270. package/dist/skills/builtin/native_vector_search.js.map +1 -0
  271. package/dist/skills/builtin/play_background_file.d.ts +59 -0
  272. package/dist/skills/builtin/play_background_file.js +274 -0
  273. package/dist/skills/builtin/play_background_file.js.map +1 -0
  274. package/dist/skills/builtin/spider.d.ts +91 -0
  275. package/dist/skills/builtin/spider.js +758 -0
  276. package/dist/skills/builtin/spider.js.map +1 -0
  277. package/dist/skills/builtin/swml_transfer.d.ts +66 -0
  278. package/dist/skills/builtin/swml_transfer.js +475 -0
  279. package/dist/skills/builtin/swml_transfer.js.map +1 -0
  280. package/dist/skills/builtin/weather_api.d.ts +59 -0
  281. package/dist/skills/builtin/weather_api.js +196 -0
  282. package/dist/skills/builtin/weather_api.js.map +1 -0
  283. package/dist/skills/builtin/web_search.d.ts +160 -0
  284. package/dist/skills/builtin/web_search.js +894 -0
  285. package/dist/skills/builtin/web_search.js.map +1 -0
  286. package/dist/skills/builtin/wikipedia_search.d.ts +77 -0
  287. package/dist/skills/builtin/wikipedia_search.js +241 -0
  288. package/dist/skills/builtin/wikipedia_search.js.map +1 -0
  289. package/{src/skills/index.ts → dist/skills/index.d.ts} +0 -1
  290. package/dist/skills/index.js +10 -0
  291. package/dist/skills/index.js.map +1 -0
  292. package/dist/types.d.ts +118 -0
  293. package/dist/types.js +5 -0
  294. package/dist/types.js.map +1 -0
  295. package/package.json +7 -1
  296. package/.github/workflows/publish.yml +0 -27
  297. package/.github/workflows/test.yml +0 -17
  298. package/CLAUDE.md +0 -112
  299. package/docs/MIGRATION-2.0.md +0 -81
  300. package/docs/agent-guide.md +0 -869
  301. package/docs/agent_guide.md +0 -1026
  302. package/docs/api-reference.md +0 -2420
  303. package/docs/api_reference.md +0 -1301
  304. package/docs/architecture.md +0 -843
  305. package/docs/cli-guide.md +0 -579
  306. package/docs/cli_guide.md +0 -448
  307. package/docs/cloud_functions_guide.md +0 -474
  308. package/docs/configuration.md +0 -422
  309. package/docs/contexts-guide.md +0 -787
  310. package/docs/contexts_guide.md +0 -511
  311. package/docs/datamap-guide.md +0 -1141
  312. package/docs/datamap_guide.md +0 -595
  313. package/docs/llm_parameters.md +0 -239
  314. package/docs/mcp_gateway_reference.md +0 -648
  315. package/docs/mcp_integration.md +0 -108
  316. package/docs/prefabs-guide.md +0 -800
  317. package/docs/sdk_features.md +0 -477
  318. package/docs/security.md +0 -436
  319. package/docs/serverless-guide.md +0 -513
  320. package/docs/skills-guide.md +0 -857
  321. package/docs/skills-system.md +0 -301
  322. package/docs/skills_parameter_schema.md +0 -392
  323. package/docs/skills_system.md +0 -467
  324. package/docs/swaig-reference.md +0 -1627
  325. package/docs/swaig_reference.md +0 -910
  326. package/docs/swml_service_guide.md +0 -600
  327. package/docs/third_party_skills.md +0 -533
  328. package/docs/web_service.md +0 -677
  329. package/examples/README.md +0 -131
  330. package/examples/advanced-datamap.ts +0 -100
  331. package/examples/advanced-dynamic-config.ts +0 -70
  332. package/examples/auto-vivified.ts +0 -94
  333. package/examples/call-flow.ts +0 -63
  334. package/examples/comprehensive-dynamic.ts +0 -125
  335. package/examples/contexts-steps.ts +0 -65
  336. package/examples/custom-path.ts +0 -45
  337. package/examples/datamap-tools.ts +0 -55
  338. package/examples/datasphere-multi-instance.ts +0 -63
  339. package/examples/datasphere-serverless-env.ts +0 -68
  340. package/examples/datasphere-webhook-env.ts +0 -66
  341. package/examples/datasphere.ts +0 -37
  342. package/examples/declarative.ts +0 -100
  343. package/examples/dynamic-config.ts +0 -54
  344. package/examples/dynamic-info-gatherer.ts +0 -69
  345. package/examples/dynamic-swml-service.ts +0 -67
  346. package/examples/gather-info.ts +0 -71
  347. package/examples/gather-per-question-functions-demo.ts +0 -140
  348. package/examples/joke-agent.ts +0 -34
  349. package/examples/kubernetes-agent.ts +0 -45
  350. package/examples/llm-params.ts +0 -69
  351. package/examples/mcp-agent.ts +0 -84
  352. package/examples/mcp-gateway.ts +0 -35
  353. package/examples/multi-agent.ts +0 -73
  354. package/examples/multi-endpoint.ts +0 -79
  355. package/examples/pom-prompt.ts +0 -71
  356. package/examples/prefab-concierge.ts +0 -47
  357. package/examples/prefab-faq.ts +0 -54
  358. package/examples/prefab-info-gatherer.ts +0 -33
  359. package/examples/prefab-receptionist.ts +0 -36
  360. package/examples/prefab-survey.ts +0 -68
  361. package/examples/record-call.ts +0 -67
  362. package/examples/relay-demo.ts +0 -33
  363. package/examples/room-and-sip.ts +0 -94
  364. package/examples/serverless-lambda.ts +0 -35
  365. package/examples/session-state.ts +0 -83
  366. package/examples/simple-agent.ts +0 -36
  367. package/examples/simple-static.ts +0 -29
  368. package/examples/skills-demo.ts +0 -38
  369. package/examples/step-function-inheritance-demo.ts +0 -124
  370. package/examples/swaig-features.ts +0 -187
  371. package/examples/swml-service-routing.ts +0 -66
  372. package/examples/swml-service.ts +0 -38
  373. package/examples/tap.ts +0 -68
  374. package/examples/verb-methods.ts +0 -45
  375. package/examples/web-search-multi-instance.ts +0 -72
  376. package/examples/web-search.ts +0 -38
  377. package/examples/wikipedia.ts +0 -36
  378. package/livewire/README.md +0 -140
  379. package/livewire/docs/migration-guide.md +0 -228
  380. package/livewire/examples/livewire-basic-agent.ts +0 -74
  381. package/livewire/examples/livewire-handoff.ts +0 -197
  382. package/livewire/examples/livewire-multi-tool.ts +0 -117
  383. package/relay/README.md +0 -70
  384. package/relay/RELAY_IMPLEMENTATION_GUIDE.md +0 -1257
  385. package/relay/docs/call-methods.md +0 -474
  386. package/relay/docs/client-reference.md +0 -142
  387. package/relay/docs/events.md +0 -134
  388. package/relay/docs/getting-started.md +0 -134
  389. package/relay/docs/guide.md +0 -306
  390. package/relay/docs/messaging.md +0 -182
  391. package/relay/examples/relay-inbound.ts +0 -66
  392. package/relay/examples/relay-messaging.ts +0 -71
  393. package/relay/examples/relay-outbound.ts +0 -76
  394. package/rest/README.md +0 -95
  395. package/rest/docs/calling.md +0 -273
  396. package/rest/docs/client-reference.md +0 -107
  397. package/rest/docs/compat.md +0 -204
  398. package/rest/docs/fabric.md +0 -183
  399. package/rest/docs/getting-started.md +0 -110
  400. package/rest/docs/guide.md +0 -351
  401. package/rest/docs/namespaces.md +0 -285
  402. package/rest/examples/rest-10dlc-registration.ts +0 -161
  403. package/rest/examples/rest-calling-ivr-and-ai.ts +0 -102
  404. package/rest/examples/rest-calling-play-and-record.ts +0 -91
  405. package/rest/examples/rest-client.ts +0 -65
  406. package/rest/examples/rest-compat-laml.ts +0 -210
  407. package/rest/examples/rest-datasphere-search.ts +0 -82
  408. package/rest/examples/rest-fabric-conferences-and-routing.ts +0 -144
  409. package/rest/examples/rest-fabric-subscribers-and-sip.ts +0 -108
  410. package/rest/examples/rest-fabric-swml-and-callflows.ts +0 -99
  411. package/rest/examples/rest-manage-resources.ts +0 -65
  412. package/rest/examples/rest-phone-number-management.ts +0 -197
  413. package/rest/examples/rest-queues-mfa-and-recordings.ts +0 -143
  414. package/rest/examples/rest-video-rooms.ts +0 -186
  415. package/src/AgentBase.ts +0 -2598
  416. package/src/AgentServer.ts +0 -442
  417. package/src/AuthHandler.ts +0 -256
  418. package/src/ConfigLoader.ts +0 -447
  419. package/src/ContextBuilder.ts +0 -1181
  420. package/src/DataMap.ts +0 -477
  421. package/src/FunctionResult.ts +0 -903
  422. package/src/Logger.ts +0 -337
  423. package/src/PomBuilder.ts +0 -467
  424. package/src/PromptManager.ts +0 -133
  425. package/src/SWMLHandler.ts +0 -298
  426. package/src/SWMLService.ts +0 -749
  427. package/src/SchemaUtils.ts +0 -361
  428. package/src/ServerlessAdapter.ts +0 -240
  429. package/src/SessionManager.ts +0 -311
  430. package/src/SslConfig.ts +0 -118
  431. package/src/SwaigFunction.ts +0 -276
  432. package/src/SwmlBuilder.ts +0 -283
  433. package/src/SwmlVerbMethods.generated.ts +0 -234
  434. package/src/TypeInference.ts +0 -199
  435. package/src/WebService.ts +0 -641
  436. package/src/cli/agent-loader.ts +0 -166
  437. package/src/cli/mock-data.ts +0 -111
  438. package/src/cli/swaig-test.ts +0 -452
  439. package/src/generateVerbTypes.ts +0 -322
  440. package/src/livewire/index.ts +0 -1252
  441. package/src/prefabs/ConciergeAgent.ts +0 -309
  442. package/src/prefabs/FAQBotAgent.ts +0 -415
  443. package/src/prefabs/InfoGathererAgent.ts +0 -379
  444. package/src/prefabs/ReceptionistAgent.ts +0 -395
  445. package/src/prefabs/SurveyAgent.ts +0 -671
  446. package/src/relay/Action.ts +0 -482
  447. package/src/relay/Call.ts +0 -1270
  448. package/src/relay/Deferred.ts +0 -94
  449. package/src/relay/Message.ts +0 -199
  450. package/src/relay/RelayClient.ts +0 -1185
  451. package/src/relay/RelayError.ts +0 -20
  452. package/src/relay/RelayEvent.ts +0 -944
  453. package/src/relay/index.ts +0 -123
  454. package/src/relay/types.ts +0 -149
  455. package/src/rest/HttpClient.ts +0 -164
  456. package/src/rest/RestError.ts +0 -45
  457. package/src/rest/base/BaseResource.ts +0 -32
  458. package/src/rest/base/CrudResource.ts +0 -98
  459. package/src/rest/base/CrudWithAddresses.ts +0 -37
  460. package/src/rest/namespaces/addresses.ts +0 -64
  461. package/src/rest/namespaces/calling.ts +0 -534
  462. package/src/rest/namespaces/chat.ts +0 -31
  463. package/src/rest/namespaces/compat.ts +0 -812
  464. package/src/rest/namespaces/datasphere.ts +0 -88
  465. package/src/rest/namespaces/fabric.ts +0 -417
  466. package/src/rest/namespaces/imported-numbers.ts +0 -31
  467. package/src/rest/namespaces/logs.ts +0 -151
  468. package/src/rest/namespaces/lookup.ts +0 -38
  469. package/src/rest/namespaces/mfa.ts +0 -61
  470. package/src/rest/namespaces/number-groups.ts +0 -68
  471. package/src/rest/namespaces/phone-numbers.ts +0 -76
  472. package/src/rest/namespaces/project.ts +0 -65
  473. package/src/rest/namespaces/pubsub.ts +0 -31
  474. package/src/rest/namespaces/queues.ts +0 -58
  475. package/src/rest/namespaces/recordings.ts +0 -53
  476. package/src/rest/namespaces/registry.ts +0 -200
  477. package/src/rest/namespaces/short-codes.ts +0 -54
  478. package/src/rest/namespaces/sip-profile.ts +0 -40
  479. package/src/rest/namespaces/verified-callers.ts +0 -46
  480. package/src/rest/namespaces/video.ts +0 -332
  481. package/src/rest/types.ts +0 -61
  482. package/src/skills/SkillBase.ts +0 -582
  483. package/src/skills/SkillManager.ts +0 -419
  484. package/src/skills/SkillRegistry.ts +0 -367
  485. package/src/skills/builtin/api_ninjas_trivia.ts +0 -285
  486. package/src/skills/builtin/ask_claude.ts +0 -246
  487. package/src/skills/builtin/claude_skills.ts +0 -983
  488. package/src/skills/builtin/custom_skills.ts +0 -327
  489. package/src/skills/builtin/datasphere.ts +0 -447
  490. package/src/skills/builtin/datasphere_serverless.ts +0 -347
  491. package/src/skills/builtin/datetime.ts +0 -137
  492. package/src/skills/builtin/google_maps.ts +0 -656
  493. package/src/skills/builtin/info_gatherer.ts +0 -415
  494. package/src/skills/builtin/joke.ts +0 -196
  495. package/src/skills/builtin/math.ts +0 -149
  496. package/src/skills/builtin/mcp_gateway.ts +0 -685
  497. package/src/skills/builtin/native_vector_search.ts +0 -910
  498. package/src/skills/builtin/play_background_file.ts +0 -367
  499. package/src/skills/builtin/spider.ts +0 -874
  500. package/src/skills/builtin/swml_transfer.ts +0 -645
  501. package/src/skills/builtin/weather_api.ts +0 -255
  502. package/src/skills/builtin/web_search.ts +0 -1083
  503. package/src/skills/builtin/wikipedia_search.ts +0 -304
  504. package/src/types.ts +0 -132
  505. package/tests/AgentBase.test.ts +0 -1093
  506. package/tests/AgentServer.test.ts +0 -126
  507. package/tests/AuthHandler.test.ts +0 -133
  508. package/tests/ConfigLoader.test.ts +0 -151
  509. package/tests/ContextBuilder.test.ts +0 -108
  510. package/tests/DataMap.test.ts +0 -367
  511. package/tests/EphemeralSkillCopy.test.ts +0 -107
  512. package/tests/FunctionResult.test.ts +0 -298
  513. package/tests/GracefulShutdown.test.ts +0 -46
  514. package/tests/Logger.test.ts +0 -420
  515. package/tests/PomBuilder.test.ts +0 -228
  516. package/tests/ProxyDetection.test.ts +0 -228
  517. package/tests/SWMLService.test.ts +0 -320
  518. package/tests/SWMLVerbHandler.test.ts +0 -523
  519. package/tests/SchemaUtils.test.ts +0 -106
  520. package/tests/SchemaUtils.verb.test.ts +0 -206
  521. package/tests/SecurityUtils.test.ts +0 -192
  522. package/tests/ServerlessAdapter.test.ts +0 -222
  523. package/tests/SessionManager.test.ts +0 -257
  524. package/tests/SkillBaseFeatures.test.ts +0 -130
  525. package/tests/SkillMultiInstance.test.ts +0 -102
  526. package/tests/SkillParameterSchemas.test.ts +0 -134
  527. package/tests/SkillRegistrySchema.test.ts +0 -84
  528. package/tests/SslConfig.test.ts +0 -97
  529. package/tests/SwmlBuilder.test.ts +0 -400
  530. package/tests/TypeInference.test.ts +0 -165
  531. package/tests/VerbHandlerRegistry.test.ts +0 -128
  532. package/tests/cli/mock-data.test.ts +0 -113
  533. package/tests/cli/swaig-test.test.ts +0 -108
  534. package/tests/examples.test.ts +0 -194
  535. package/tests/fixtures/scrape-parity/README.md +0 -53
  536. package/tests/fixtures/scrape-parity/expected/01_simple_article.json +0 -5
  537. package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +0 -5
  538. package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +0 -5
  539. package/tests/fixtures/scrape-parity/expected/04_bare_body.json +0 -5
  540. package/tests/fixtures/scrape-parity/expected/05_malformed.json +0 -5
  541. package/tests/fixtures/scrape-parity/expected/06_multi_class.json +0 -5
  542. package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +0 -5
  543. package/tests/fixtures/scrape-parity/expected/08_inline_script.json +0 -5
  544. package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +0 -5
  545. package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +0 -5
  546. package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +0 -5
  547. package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +0 -5
  548. package/tests/fixtures/scrape-parity/html/01_simple_article.html +0 -18
  549. package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +0 -18
  550. package/tests/fixtures/scrape-parity/html/03_nested_containers.html +0 -13
  551. package/tests/fixtures/scrape-parity/html/04_bare_body.html +0 -9
  552. package/tests/fixtures/scrape-parity/html/05_malformed.html +0 -11
  553. package/tests/fixtures/scrape-parity/html/06_multi_class.html +0 -18
  554. package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +0 -12
  555. package/tests/fixtures/scrape-parity/html/08_inline_script.html +0 -17
  556. package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +0 -21
  557. package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +0 -10
  558. package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +0 -13
  559. package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +0 -24
  560. package/tests/fixtures/scrape-parity/python_extract.py +0 -109
  561. package/tests/livewire/livewire.test.ts +0 -780
  562. package/tests/mcp.test.ts +0 -221
  563. package/tests/prefabs/prefabs.test.ts +0 -1093
  564. package/tests/relay/Action.test.ts +0 -392
  565. package/tests/relay/Call.test.ts +0 -535
  566. package/tests/relay/Deferred.test.ts +0 -71
  567. package/tests/relay/Message.test.ts +0 -164
  568. package/tests/relay/RelayClient.test.ts +0 -779
  569. package/tests/relay/RelayEvent.test.ts +0 -463
  570. package/tests/relay/helpers.ts +0 -79
  571. package/tests/rest/HttpClient.test.ts +0 -274
  572. package/tests/rest/RestError.test.ts +0 -53
  573. package/tests/rest/calling.test.ts +0 -156
  574. package/tests/rest/client.test.ts +0 -197
  575. package/tests/rest/compat.test.ts +0 -335
  576. package/tests/rest/datasphere.test.ts +0 -71
  577. package/tests/rest/fabric.test.ts +0 -186
  578. package/tests/rest/helpers.ts +0 -95
  579. package/tests/rest/logs.test.ts +0 -68
  580. package/tests/rest/pagination.test.ts +0 -133
  581. package/tests/rest/registry.test.ts +0 -94
  582. package/tests/rest/relay-rest.test.ts +0 -290
  583. package/tests/rest/video.test.ts +0 -173
  584. package/tests/setup.ts +0 -6
  585. package/tests/skills/SkillBase.test.ts +0 -108
  586. package/tests/skills/SkillManager.test.ts +0 -268
  587. package/tests/skills/SkillRegistry.test.ts +0 -176
  588. package/tests/skills/builtin.test.ts +0 -1472
  589. package/tests/skills/claude-skills.test.ts +0 -54
  590. package/tests/skills/custom-skills.test.ts +0 -53
  591. package/tests/skills/datasphere-serverless.test.ts +0 -70
  592. package/tests/skills/datasphere.test.ts +0 -107
  593. package/tests/skills/datetime.test.ts +0 -101
  594. package/tests/skills/google-maps.test.ts +0 -78
  595. package/tests/skills/info-gatherer.test.ts +0 -411
  596. package/tests/skills/joke.test.ts +0 -81
  597. package/tests/skills/math.test.ts +0 -68
  598. package/tests/skills/mcp-gateway.test.ts +0 -101
  599. package/tests/skills/play-background.test.ts +0 -54
  600. package/tests/skills/spider.test.ts +0 -108
  601. package/tests/skills/swml-transfer.test.ts +0 -178
  602. package/tests/skills/trivia.test.ts +0 -54
  603. package/tests/skills/vector-search.test.ts +0 -135
  604. package/tests/skills/weather-api.test.ts +0 -77
  605. package/tests/skills/web-search-parity.test.ts +0 -59
  606. package/tests/skills/web-search.test.ts +0 -103
  607. package/tests/skills/wikipedia.test.ts +0 -63
  608. package/tsconfig.json +0 -18
  609. package/vitest.config.ts +0 -9
  610. /package/{src → dist}/schema.json +0 -0
@@ -1,367 +0,0 @@
1
- /**
2
- * SkillRegistry - Global singleton registry for discovering and loading skills.
3
- *
4
- * Matches Python's `skills/registry.py:SkillRegistry`: the registry stores
5
- * **class references** keyed by each class's static `SKILL_NAME`, and reads
6
- * metadata (description, version, required packages/env vars,
7
- * multi-instance support) by direct static-attribute access.
8
- *
9
- * Registration via `register(SkillClass)` validates that the class defines
10
- * `SKILL_NAME`, that `getParameterSchema()` is callable and returns a
11
- * non-empty object (Python `register_skill` at `registry.py:132-194`).
12
- *
13
- * Supports the `SIGNALWIRE_SKILL_PATHS` environment variable for custom
14
- * skill directories, matching Python's discovery search path.
15
- */
16
-
17
- import { SkillBase, type SkillConfig, type ParameterSchemaEntry } from './SkillBase.js';
18
- import { getLogger } from '../Logger.js';
19
-
20
- const log = getLogger('SkillRegistry');
21
-
22
- /**
23
- * Metadata exposed for a registered skill. Shape matches Python's
24
- * `SkillRegistry.list_skills()` / `get_all_skills_schema()` return values
25
- * (`skills/registry.py:205-227`, `229-296`).
26
- */
27
- export interface SkillSchemaInfo {
28
- /** The skill's registered name (from `SkillBase.SKILL_NAME`). */
29
- name: string;
30
- /** Human-readable description (from `SkillBase.SKILL_DESCRIPTION`). */
31
- description: string;
32
- /** Semantic version string (from `SkillBase.SKILL_VERSION`). */
33
- version: string;
34
- /** Whether this skill supports multiple simultaneous instances. */
35
- supportsMultipleInstances: boolean;
36
- /** Environment variables required by the skill. */
37
- requiredEnvVars: string[];
38
- /** NPM packages required by the skill. */
39
- requiredPackages: string[];
40
- /** Full parameter schema with types, defaults, and constraints. */
41
- parameters: Record<string, ParameterSchemaEntry>;
42
- /** Optional source category for grouping (e.g., "builtin", "external"). */
43
- source?: string;
44
- }
45
-
46
- let _instance: SkillRegistry | null = null;
47
-
48
- /**
49
- * Global singleton registry for registering and instantiating skills.
50
- *
51
- * Skills can be registered programmatically via `register(SkillClass)`.
52
- * Matches Python's `skill_registry` global (`skills/registry.py:481`).
53
- */
54
- export class SkillRegistry {
55
- /**
56
- * Map from `SKILL_NAME` to class reference. Matches Python's
57
- * `self._skills: Dict[str, Type[SkillBase]]` (`registry.py:26`).
58
- */
59
- private registry: Map<string, typeof SkillBase> = new Map();
60
- private lockedNames: Set<string> = new Set();
61
- private searchPaths: string[];
62
-
63
- constructor() {
64
- const envPaths = process.env['SIGNALWIRE_SKILL_PATHS'];
65
- this.searchPaths = envPaths ? envPaths.split(':').filter(Boolean) : [];
66
- }
67
-
68
- /**
69
- * Get the global singleton instance, creating it on first access.
70
- * @returns The shared SkillRegistry instance.
71
- */
72
- static getInstance(): SkillRegistry {
73
- if (!_instance) {
74
- _instance = new SkillRegistry();
75
- }
76
- return _instance;
77
- }
78
-
79
- /**
80
- * Reset the global singleton (for testing).
81
- */
82
- static resetInstance(): void {
83
- _instance = null;
84
- }
85
-
86
- /**
87
- * Register a skill class. The skill name is read from the class's static
88
- * `SKILL_NAME`. Mirrors Python's `register_skill(skill_class)`
89
- * (`skills/registry.py:132-194`) — including the schema-non-empty check
90
- * and the protection against overwriting locked skills.
91
- *
92
- * @param SkillClass - A concrete subclass of `SkillBase` with a
93
- * non-empty `SKILL_NAME`.
94
- */
95
- register(SkillClass: typeof SkillBase): void {
96
- const name = SkillClass.SKILL_NAME;
97
- if (!name) {
98
- throw new Error(
99
- `${SkillClass.name} must define static SKILL_NAME before registration ` +
100
- `(Python equivalent: registry.py:150 SKILL_NAME validation).`,
101
- );
102
- }
103
- if (this.lockedNames.has(name)) {
104
- log.warn(`Cannot overwrite locked skill: ${name}`);
105
- return;
106
- }
107
- // Schema non-emptiness check — Python registry.py:163-166.
108
- try {
109
- const schema = SkillClass.getParameterSchema();
110
- if (!schema || typeof schema !== 'object' || Object.keys(schema).length === 0) {
111
- throw new Error(
112
- `${SkillClass.name}.getParameterSchema() must return a non-empty object`,
113
- );
114
- }
115
- } catch (err) {
116
- throw new Error(
117
- `${SkillClass.name}.getParameterSchema() failed: ${err instanceof Error ? err.message : String(err)}`,
118
- );
119
- }
120
- if (this.registry.has(name)) {
121
- log.warn(`Overwriting skill registration: ${name}`);
122
- }
123
- this.registry.set(name, SkillClass);
124
- log.debug(`Registered skill: ${name}`);
125
- }
126
-
127
- /**
128
- * Lock one or more skill names to prevent overwriting.
129
- * If called with no arguments, locks all currently registered skills.
130
- * @param names - Skill names to lock; if omitted, all current names are locked.
131
- */
132
- lock(names?: string[]): void {
133
- const toLock = names ?? Array.from(this.registry.keys());
134
- for (const name of toLock) {
135
- this.lockedNames.add(name);
136
- }
137
- }
138
-
139
- /**
140
- * Unregister a skill by name, removing it from the registry.
141
- * @param name - The skill name to unregister.
142
- * @returns True if the skill was found and removed.
143
- */
144
- unregister(name: string): boolean {
145
- return this.registry.delete(name);
146
- }
147
-
148
- /**
149
- * Create a new skill instance by looking up its class in the registry.
150
- * Matches Python's `skill_manager.load_skill(name)` class-lookup + instantiate
151
- * flow (`skill_manager.py:97`: `skill_instance = skill_class(self.agent, params)`).
152
- *
153
- * @param name - The registered skill name.
154
- * @param config - Optional configuration to pass to the skill constructor.
155
- * @returns A new skill instance, or null if the name is not registered.
156
- */
157
- create(name: string, config?: SkillConfig): SkillBase | null {
158
- const SkillClass = this.registry.get(name);
159
- if (!SkillClass) {
160
- log.warn(`Skill not found in registry: ${name}`);
161
- return null;
162
- }
163
- // typeof SkillBase is abstract at the type level; concrete subclasses
164
- // are what's actually stored. Cast through unknown to allow `new`.
165
- const Ctor = SkillClass as unknown as new (config?: SkillConfig) => SkillBase;
166
- return new Ctor(config);
167
- }
168
-
169
- /**
170
- * Get the registered skill class by name. Matches Python's
171
- * `get_skill_class(skill_name)` (`registry.py:196-203`).
172
- * @param name - The registered skill name.
173
- * @returns The skill class reference, or undefined if not registered.
174
- */
175
- getSkillClass(name: string): typeof SkillBase | undefined {
176
- return this.registry.get(name);
177
- }
178
-
179
- /**
180
- * Check if a skill name is registered.
181
- * @param name - The skill name to check.
182
- * @returns True if the skill is registered.
183
- */
184
- has(name: string): boolean {
185
- return this.registry.has(name);
186
- }
187
-
188
- /**
189
- * List all registered skill names.
190
- * @returns Array of registered skill name strings.
191
- */
192
- listRegistered(): string[] {
193
- return Array.from(this.registry.keys());
194
- }
195
-
196
- /**
197
- * List all registered skills with their full metadata. Matches Python's
198
- * `list_skills()` shape (`registry.py:205-227`) plus TS-idiomatic
199
- * camelCase keys.
200
- * @returns Array of skill metadata objects.
201
- */
202
- listSkills(): SkillSchemaInfo[] {
203
- return Array.from(this.registry.values()).map((SkillClass) => ({
204
- name: SkillClass.SKILL_NAME,
205
- description: SkillClass.SKILL_DESCRIPTION,
206
- version: SkillClass.SKILL_VERSION,
207
- supportsMultipleInstances: SkillClass.SUPPORTS_MULTIPLE_INSTANCES,
208
- requiredEnvVars: [...SkillClass.REQUIRED_ENV_VARS],
209
- requiredPackages: [...SkillClass.REQUIRED_PACKAGES],
210
- parameters: SkillClass.getParameterSchema(),
211
- }));
212
- }
213
-
214
- /**
215
- * Add a directory path to search during skill discovery.
216
- * @param path - Absolute path to a directory containing skill files.
217
- */
218
- addSearchPath(path: string): void {
219
- if (!this.searchPaths.includes(path)) {
220
- this.searchPaths.push(path);
221
- }
222
- }
223
-
224
- /**
225
- * Get all configured search paths for skill discovery.
226
- * @returns Copy of the search paths array.
227
- */
228
- getSearchPaths(): string[] {
229
- return [...this.searchPaths];
230
- }
231
-
232
- /**
233
- * Discover and register skills from a directory by importing each file.
234
- * Looks for SkillBase subclass exports and registers them.
235
- * @param dirPath - Absolute path to the directory to scan.
236
- * @returns Array of newly discovered skill names.
237
- */
238
- async discoverFromDirectory(dirPath: string): Promise<string[]> {
239
- if (process.env['SWML_SKILL_DISCOVERY_ENABLED'] !== 'true') {
240
- log.warn('Skill directory discovery is disabled. Set SWML_SKILL_DISCOVERY_ENABLED=true to enable.');
241
- return [];
242
- }
243
- const { readdir } = await import('node:fs/promises');
244
- const { join } = await import('node:path');
245
- const { pathToFileURL } = await import('node:url');
246
-
247
- const discovered: string[] = [];
248
- let entries: string[];
249
-
250
- try {
251
- const dirEntries = await readdir(dirPath, { withFileTypes: true });
252
- entries = dirEntries
253
- .filter(e => (e.isFile() && (e.name.endsWith('.ts') || e.name.endsWith('.js'))) || e.isDirectory())
254
- .map(e => e.name);
255
- } catch {
256
- log.warn(`Cannot read skill directory: ${dirPath}`);
257
- return discovered;
258
- }
259
-
260
- for (const entry of entries) {
261
- const fullPath = join(dirPath, entry);
262
- try {
263
- const fileUrl = pathToFileURL(
264
- entry.endsWith('.ts') || entry.endsWith('.js') ? fullPath : join(fullPath, 'skill.ts'),
265
- ).href;
266
- const mod: Record<string, unknown> = await import(fileUrl);
267
-
268
- // Find any SkillBase subclass exported from the module. Matches
269
- // Python `registry.py:104-113` which inspects loaded modules for
270
- // `issubclass(obj, SkillBase)`.
271
- for (const value of Object.values(mod)) {
272
- if (
273
- typeof value === 'function' &&
274
- (value as { prototype?: unknown }).prototype instanceof SkillBase &&
275
- (value as typeof SkillBase).SKILL_NAME
276
- ) {
277
- const SkillClass = value as typeof SkillBase;
278
- this.register(SkillClass);
279
- discovered.push(SkillClass.SKILL_NAME);
280
- }
281
- }
282
- } catch (err) {
283
- log.debug(`Could not load skill from ${fullPath}: ${err}`);
284
- }
285
- }
286
-
287
- return discovered;
288
- }
289
-
290
- /**
291
- * Discover and register skills from all configured search paths.
292
- * @returns Array of all newly discovered skill names.
293
- */
294
- async discoverAll(): Promise<string[]> {
295
- const all: string[] = [];
296
- for (const path of this.searchPaths) {
297
- const found = await this.discoverFromDirectory(path);
298
- all.push(...found);
299
- }
300
- return all;
301
- }
302
-
303
- /**
304
- * Get the combined schema info for a registered skill.
305
- * Matches Python `get_all_skills_schema` per-skill shape
306
- * (`registry.py:287-295`).
307
- * @param name - The registered skill name to query.
308
- * @returns The skill's schema info, or undefined if not found.
309
- */
310
- getSkillSchema(name: string): SkillSchemaInfo | undefined {
311
- const SkillClass = this.registry.get(name);
312
- if (!SkillClass) return undefined;
313
- return {
314
- name: SkillClass.SKILL_NAME,
315
- description: SkillClass.SKILL_DESCRIPTION,
316
- version: SkillClass.SKILL_VERSION,
317
- supportsMultipleInstances: SkillClass.SUPPORTS_MULTIPLE_INSTANCES,
318
- requiredEnvVars: [...SkillClass.REQUIRED_ENV_VARS],
319
- requiredPackages: [...SkillClass.REQUIRED_PACKAGES],
320
- parameters: SkillClass.getParameterSchema(),
321
- };
322
- }
323
-
324
- /**
325
- * Get combined schema info for all registered skills.
326
- * @returns Record mapping skill names to their schema info.
327
- */
328
- getAllSkillsSchema(): Record<string, SkillSchemaInfo> {
329
- const result: Record<string, SkillSchemaInfo> = {};
330
- for (const name of this.registry.keys()) {
331
- const schema = this.getSkillSchema(name);
332
- if (schema) result[name] = schema;
333
- }
334
- return result;
335
- }
336
-
337
- /**
338
- * Group registered skill names by source category. Matches Python's
339
- * `list_all_skill_sources` (`skills/registry.py:436-478`).
340
- *
341
- * Current TS implementation treats every registered skill as "registered"
342
- * (the only category that fits — filesystem-based discovery is optional
343
- * and entry-points don't apply to Node the way they do to Python).
344
- *
345
- * @returns Record mapping source categories to arrays of skill names.
346
- */
347
- listAllSkillSources(): Record<string, string[]> {
348
- return {
349
- registered: Array.from(this.registry.keys()),
350
- };
351
- }
352
-
353
- /**
354
- * Get the number of registered skills.
355
- * @returns The count of registered skills.
356
- */
357
- get size(): number {
358
- return this.registry.size;
359
- }
360
-
361
- /**
362
- * Clear all registrations.
363
- */
364
- clear(): void {
365
- this.registry.clear();
366
- }
367
- }
@@ -1,285 +0,0 @@
1
- /**
2
- * API Ninjas Trivia Skill - Fetches trivia questions from the API Ninjas service.
3
- *
4
- * Tier 2 built-in skill: requires API_NINJAS_KEY environment variable.
5
- * Uses the API Ninjas Trivia endpoint to retrieve random trivia questions
6
- * with optional category filtering.
7
- */
8
-
9
- import { SkillBase } from '../SkillBase.js';
10
- import type {
11
- SkillToolDefinition,
12
- SkillPromptSection,
13
- SkillConfig,
14
- ParameterSchemaEntry,
15
- } from '../SkillBase.js';
16
- import { FunctionResult } from '../../FunctionResult.js';
17
- import { getLogger } from '../../Logger.js';
18
-
19
- const log = getLogger('ApiNinjasTriviaSkill');
20
-
21
- /** Response shape from the API Ninjas trivia endpoint. */
22
- interface TriviaResponse {
23
- /** Trivia category name. */
24
- category: string;
25
- /** The trivia question text. */
26
- question: string;
27
- /** The correct answer. */
28
- answer: string;
29
- }
30
-
31
- const VALID_CATEGORIES = [
32
- 'artliterature',
33
- 'language',
34
- 'sciencenature',
35
- 'general',
36
- 'fooddrink',
37
- 'peopleplaces',
38
- 'geography',
39
- 'historyholidays',
40
- 'entertainment',
41
- 'toysgames',
42
- 'music',
43
- 'mathematics',
44
- 'religionmythology',
45
- 'sportsleisure',
46
- ] as const;
47
-
48
- /**
49
- * Fetches trivia questions from the API Ninjas service.
50
- *
51
- * Tier 2 built-in skill. Requires the `API_NINJAS_KEY` environment variable.
52
- * Supports optional `default_category` and `reveal_answer` config options.
53
- *
54
- * @example
55
- * ```ts
56
- * agent.addSkill('api_ninjas_trivia', { default_category: 'sciencenature' });
57
- * ```
58
- */
59
- export class ApiNinjasTriviaSkill extends SkillBase {
60
- static override SKILL_NAME = 'api_ninjas_trivia';
61
- static override SKILL_DESCRIPTION = 'Get trivia questions from API Ninjas';
62
- // Python skill.py:61 — `REQUIRED_ENV_VARS = []` because the api_key can
63
- // be supplied via params. The handler still falls back to `API_NINJAS_KEY`
64
- // so env-based configuration keeps working.
65
- static override REQUIRED_ENV_VARS: readonly string[] = [];
66
- static override SUPPORTS_MULTIPLE_INSTANCES = true;
67
-
68
- static override getParameterSchema(): Record<string, ParameterSchemaEntry> {
69
- return {
70
- ...super.getParameterSchema(),
71
- tool_name: {
72
- type: 'string',
73
- description:
74
- 'Custom name for the SWAIG trivia tool (enables multiple instances).',
75
- default: 'get_trivia',
76
- },
77
- api_key: {
78
- type: 'string',
79
- description: 'API Ninjas API key.',
80
- hidden: true,
81
- env_var: 'API_NINJAS_KEY',
82
- required: true,
83
- },
84
- categories: {
85
- type: 'array',
86
- description:
87
- 'Subset of trivia categories to enable. Defaults to all categories.',
88
- required: false,
89
- default: [...VALID_CATEGORIES],
90
- items: {
91
- type: 'string',
92
- enum: [...VALID_CATEGORIES],
93
- },
94
- },
95
- default_category: {
96
- type: 'string',
97
- description: 'Default trivia category if none is specified.',
98
- },
99
- reveal_answer: {
100
- type: 'boolean',
101
- description: 'Whether to include the answer in the response.',
102
- default: false,
103
- },
104
- };
105
- }
106
-
107
- /**
108
- * Produce a compound instance key matching Python `get_instance_key`
109
- * (skill.py:139-146): `f"{SKILL_NAME}_{self.tool_name}"` with
110
- * `tool_name` defaulting to `'get_trivia'` (skill.py:95). The base
111
- * `SkillBase.getInstanceKey` uses `this.skillName` as the fallback,
112
- * so we override to match Python's `'get_trivia'` default.
113
- */
114
- override getInstanceKey(): string {
115
- const toolName = this.getConfig<string>('tool_name', 'get_trivia');
116
- return `${this.skillName}_${toolName}`;
117
- }
118
-
119
- /** @returns A single trivia tool (configurable name) that fetches a random trivia question with optional category. */
120
- getTools(): SkillToolDefinition[] {
121
- const toolName = this.getConfig<string>('tool_name', 'get_trivia');
122
- const defaultCategory = this.getConfig<string | undefined>(
123
- 'default_category',
124
- undefined,
125
- );
126
- const revealAnswer = this.getConfig<boolean>('reveal_answer', false);
127
- const configuredCategories = this.getConfig<string[] | undefined>(
128
- 'categories',
129
- undefined,
130
- );
131
- const enabledCategories =
132
- Array.isArray(configuredCategories) && configuredCategories.length > 0
133
- ? configuredCategories.filter((c): c is string =>
134
- (VALID_CATEGORIES as readonly string[]).includes(c),
135
- )
136
- : [...VALID_CATEGORIES];
137
-
138
- return [
139
- {
140
- name: toolName,
141
- description:
142
- 'Get a random trivia question. Optionally specify a category to narrow the topic.',
143
- parameters: {
144
- category: {
145
- type: 'string',
146
- description:
147
- 'Trivia category. Available categories: ' +
148
- enabledCategories.join(', ') +
149
- '. If not specified, a random category is used.',
150
- enum: enabledCategories,
151
- },
152
- },
153
- handler: async (args: Record<string, unknown>) => {
154
- const apiKey =
155
- this.getConfig<string | undefined>('api_key', undefined) ??
156
- process.env['API_NINJAS_KEY'];
157
- if (!apiKey) {
158
- return new FunctionResult(
159
- 'Trivia service is not configured. The API_NINJAS_KEY environment variable is missing.',
160
- );
161
- }
162
-
163
- let category = (args.category as string | undefined) ?? defaultCategory;
164
-
165
- // Validate category if provided
166
- if (category && typeof category === 'string') {
167
- const normalized = category.toLowerCase().trim().replace(/[\s_-]/g, '');
168
- if (
169
- !enabledCategories.includes(normalized)
170
- ) {
171
- return new FunctionResult(
172
- `Unknown trivia category "${category}". Available categories: ${enabledCategories.join(', ')}.`,
173
- );
174
- }
175
- category = normalized;
176
- }
177
-
178
- try {
179
- const url = category
180
- ? `https://api.api-ninjas.com/v1/trivia?category=${encodeURIComponent(category)}`
181
- : 'https://api.api-ninjas.com/v1/trivia';
182
-
183
- const controller = new AbortController();
184
- const timeout = setTimeout(() => controller.abort(), 30_000);
185
- let response: Response;
186
- try {
187
- response = await fetch(url, {
188
- headers: {
189
- 'X-Api-Key': apiKey,
190
- },
191
- signal: controller.signal,
192
- });
193
- } finally {
194
- clearTimeout(timeout);
195
- }
196
-
197
- if (!response.ok) {
198
- log.error('trivia_api_error', { status: response.status });
199
- return new FunctionResult(
200
- 'The trivia service encountered an error. Please try again later.',
201
- );
202
- }
203
-
204
- const data = (await response.json()) as TriviaResponse[];
205
-
206
- if (!Array.isArray(data) || data.length === 0) {
207
- return new FunctionResult(
208
- 'No trivia questions were returned. Please try again or try a different category.',
209
- );
210
- }
211
-
212
- const trivia = data[0]!;
213
-
214
- if (revealAnswer) {
215
- return new FunctionResult(
216
- `Trivia (${trivia.category}): ${trivia.question} Answer: ${trivia.answer}`,
217
- );
218
- }
219
-
220
- // When not revealing the answer, provide it in a structured way
221
- // so the AI knows the answer but can quiz the user
222
- return new FunctionResult(
223
- `Here is a trivia question from the "${trivia.category}" category. ` +
224
- `Question: ${trivia.question} ` +
225
- `[The correct answer is: ${trivia.answer}. Do not reveal this unless the user attempts an answer or asks for it.]`,
226
- );
227
- } catch (err) {
228
- log.error('get_trivia_failed', { error: err instanceof Error ? err.message : String(err) });
229
- return new FunctionResult(
230
- 'The request could not be completed. Please try again.',
231
- );
232
- }
233
- },
234
- },
235
- ];
236
- }
237
-
238
- /** @returns Prompt section describing trivia capabilities and quiz behavior. */
239
- protected override _getPromptSections(): SkillPromptSection[] {
240
- const revealAnswer = this.getConfig<boolean>('reveal_answer', false);
241
-
242
- const bullets: string[] = [
243
- 'Use the get_trivia tool to fetch a random trivia question.',
244
- `Available categories: ${VALID_CATEGORIES.join(', ')}.`,
245
- 'If no category is specified, a random category will be selected.',
246
- ];
247
-
248
- if (!revealAnswer) {
249
- bullets.push(
250
- 'When you receive a trivia question, ask it to the user and let them try to answer before revealing the correct answer.',
251
- 'If the user gets it wrong, give them a hint or tell them the correct answer.',
252
- );
253
- } else {
254
- bullets.push(
255
- 'Trivia answers are included in the response. Share the question and answer with the user.',
256
- );
257
- }
258
-
259
- bullets.push(
260
- 'Keep trivia fun and engaging. Encourage the user to try more questions.',
261
- );
262
-
263
- return [
264
- {
265
- title: 'Trivia Questions',
266
- body: 'You can fetch and ask trivia questions from a wide range of categories.',
267
- bullets,
268
- },
269
- ];
270
- }
271
-
272
- /** @returns Speech recognition hints for trivia-related keywords. */
273
- getHints(): string[] {
274
- return ['trivia', 'quiz', 'question', 'fun fact'];
275
- }
276
- }
277
-
278
- /**
279
- * Factory function for creating ApiNinjasTriviaSkill instances.
280
- * @param config - Optional skill configuration.
281
- * @returns A new ApiNinjasTriviaSkill instance.
282
- */
283
- export function createSkill(config?: SkillConfig): ApiNinjasTriviaSkill {
284
- return new ApiNinjasTriviaSkill(config);
285
- }