@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
@@ -0,0 +1,310 @@
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
+ import { SkillBase } from './SkillBase.js';
17
+ import { getLogger } from '../Logger.js';
18
+ const log = getLogger('SkillRegistry');
19
+ let _instance = null;
20
+ /**
21
+ * Global singleton registry for registering and instantiating skills.
22
+ *
23
+ * Skills can be registered programmatically via `register(SkillClass)`.
24
+ * Matches Python's `skill_registry` global (`skills/registry.py:481`).
25
+ */
26
+ export class SkillRegistry {
27
+ /**
28
+ * Map from `SKILL_NAME` to class reference. Matches Python's
29
+ * `self._skills: Dict[str, Type[SkillBase]]` (`registry.py:26`).
30
+ */
31
+ registry = new Map();
32
+ lockedNames = new Set();
33
+ searchPaths;
34
+ constructor() {
35
+ const envPaths = process.env['SIGNALWIRE_SKILL_PATHS'];
36
+ this.searchPaths = envPaths ? envPaths.split(':').filter(Boolean) : [];
37
+ }
38
+ /**
39
+ * Get the global singleton instance, creating it on first access.
40
+ * @returns The shared SkillRegistry instance.
41
+ */
42
+ static getInstance() {
43
+ if (!_instance) {
44
+ _instance = new SkillRegistry();
45
+ }
46
+ return _instance;
47
+ }
48
+ /**
49
+ * Reset the global singleton (for testing).
50
+ */
51
+ static resetInstance() {
52
+ _instance = null;
53
+ }
54
+ /**
55
+ * Register a skill class. The skill name is read from the class's static
56
+ * `SKILL_NAME`. Mirrors Python's `register_skill(skill_class)`
57
+ * (`skills/registry.py:132-194`) — including the schema-non-empty check
58
+ * and the protection against overwriting locked skills.
59
+ *
60
+ * @param SkillClass - A concrete subclass of `SkillBase` with a
61
+ * non-empty `SKILL_NAME`.
62
+ */
63
+ register(SkillClass) {
64
+ const name = SkillClass.SKILL_NAME;
65
+ if (!name) {
66
+ throw new Error(`${SkillClass.name} must define static SKILL_NAME before registration ` +
67
+ `(Python equivalent: registry.py:150 SKILL_NAME validation).`);
68
+ }
69
+ if (this.lockedNames.has(name)) {
70
+ log.warn(`Cannot overwrite locked skill: ${name}`);
71
+ return;
72
+ }
73
+ // Schema non-emptiness check — Python registry.py:163-166.
74
+ try {
75
+ const schema = SkillClass.getParameterSchema();
76
+ if (!schema || typeof schema !== 'object' || Object.keys(schema).length === 0) {
77
+ throw new Error(`${SkillClass.name}.getParameterSchema() must return a non-empty object`);
78
+ }
79
+ }
80
+ catch (err) {
81
+ throw new Error(`${SkillClass.name}.getParameterSchema() failed: ${err instanceof Error ? err.message : String(err)}`);
82
+ }
83
+ if (this.registry.has(name)) {
84
+ log.warn(`Overwriting skill registration: ${name}`);
85
+ }
86
+ this.registry.set(name, SkillClass);
87
+ log.debug(`Registered skill: ${name}`);
88
+ }
89
+ /**
90
+ * Lock one or more skill names to prevent overwriting.
91
+ * If called with no arguments, locks all currently registered skills.
92
+ * @param names - Skill names to lock; if omitted, all current names are locked.
93
+ */
94
+ lock(names) {
95
+ const toLock = names ?? Array.from(this.registry.keys());
96
+ for (const name of toLock) {
97
+ this.lockedNames.add(name);
98
+ }
99
+ }
100
+ /**
101
+ * Unregister a skill by name, removing it from the registry.
102
+ * @param name - The skill name to unregister.
103
+ * @returns True if the skill was found and removed.
104
+ */
105
+ unregister(name) {
106
+ return this.registry.delete(name);
107
+ }
108
+ /**
109
+ * Create a new skill instance by looking up its class in the registry.
110
+ * Matches Python's `skill_manager.load_skill(name)` class-lookup + instantiate
111
+ * flow (`skill_manager.py:97`: `skill_instance = skill_class(self.agent, params)`).
112
+ *
113
+ * @param name - The registered skill name.
114
+ * @param config - Optional configuration to pass to the skill constructor.
115
+ * @returns A new skill instance, or null if the name is not registered.
116
+ */
117
+ create(name, config) {
118
+ const SkillClass = this.registry.get(name);
119
+ if (!SkillClass) {
120
+ log.warn(`Skill not found in registry: ${name}`);
121
+ return null;
122
+ }
123
+ // typeof SkillBase is abstract at the type level; concrete subclasses
124
+ // are what's actually stored. Cast through unknown to allow `new`.
125
+ const Ctor = SkillClass;
126
+ return new Ctor(config);
127
+ }
128
+ /**
129
+ * Get the registered skill class by name. Matches Python's
130
+ * `get_skill_class(skill_name)` (`registry.py:196-203`).
131
+ * @param name - The registered skill name.
132
+ * @returns The skill class reference, or undefined if not registered.
133
+ */
134
+ getSkillClass(name) {
135
+ return this.registry.get(name);
136
+ }
137
+ /**
138
+ * Check if a skill name is registered.
139
+ * @param name - The skill name to check.
140
+ * @returns True if the skill is registered.
141
+ */
142
+ has(name) {
143
+ return this.registry.has(name);
144
+ }
145
+ /**
146
+ * List all registered skill names.
147
+ * @returns Array of registered skill name strings.
148
+ */
149
+ listRegistered() {
150
+ return Array.from(this.registry.keys());
151
+ }
152
+ /**
153
+ * List all registered skills with their full metadata. Matches Python's
154
+ * `list_skills()` shape (`registry.py:205-227`) plus TS-idiomatic
155
+ * camelCase keys.
156
+ * @returns Array of skill metadata objects.
157
+ */
158
+ listSkills() {
159
+ return Array.from(this.registry.values()).map((SkillClass) => ({
160
+ name: SkillClass.SKILL_NAME,
161
+ description: SkillClass.SKILL_DESCRIPTION,
162
+ version: SkillClass.SKILL_VERSION,
163
+ supportsMultipleInstances: SkillClass.SUPPORTS_MULTIPLE_INSTANCES,
164
+ requiredEnvVars: [...SkillClass.REQUIRED_ENV_VARS],
165
+ requiredPackages: [...SkillClass.REQUIRED_PACKAGES],
166
+ parameters: SkillClass.getParameterSchema(),
167
+ }));
168
+ }
169
+ /**
170
+ * Add a directory path to search during skill discovery.
171
+ * @param path - Absolute path to a directory containing skill files.
172
+ */
173
+ addSearchPath(path) {
174
+ if (!this.searchPaths.includes(path)) {
175
+ this.searchPaths.push(path);
176
+ }
177
+ }
178
+ /**
179
+ * Get all configured search paths for skill discovery.
180
+ * @returns Copy of the search paths array.
181
+ */
182
+ getSearchPaths() {
183
+ return [...this.searchPaths];
184
+ }
185
+ /**
186
+ * Discover and register skills from a directory by importing each file.
187
+ * Looks for SkillBase subclass exports and registers them.
188
+ * @param dirPath - Absolute path to the directory to scan.
189
+ * @returns Array of newly discovered skill names.
190
+ */
191
+ async discoverFromDirectory(dirPath) {
192
+ if (process.env['SWML_SKILL_DISCOVERY_ENABLED'] !== 'true') {
193
+ log.warn('Skill directory discovery is disabled. Set SWML_SKILL_DISCOVERY_ENABLED=true to enable.');
194
+ return [];
195
+ }
196
+ const { readdir } = await import('node:fs/promises');
197
+ const { join } = await import('node:path');
198
+ const { pathToFileURL } = await import('node:url');
199
+ const discovered = [];
200
+ let entries;
201
+ try {
202
+ const dirEntries = await readdir(dirPath, { withFileTypes: true });
203
+ entries = dirEntries
204
+ .filter(e => (e.isFile() && (e.name.endsWith('.ts') || e.name.endsWith('.js'))) || e.isDirectory())
205
+ .map(e => e.name);
206
+ }
207
+ catch {
208
+ log.warn(`Cannot read skill directory: ${dirPath}`);
209
+ return discovered;
210
+ }
211
+ for (const entry of entries) {
212
+ const fullPath = join(dirPath, entry);
213
+ try {
214
+ const fileUrl = pathToFileURL(entry.endsWith('.ts') || entry.endsWith('.js') ? fullPath : join(fullPath, 'skill.ts')).href;
215
+ const mod = await import(fileUrl);
216
+ // Find any SkillBase subclass exported from the module. Matches
217
+ // Python `registry.py:104-113` which inspects loaded modules for
218
+ // `issubclass(obj, SkillBase)`.
219
+ for (const value of Object.values(mod)) {
220
+ if (typeof value === 'function' &&
221
+ value.prototype instanceof SkillBase &&
222
+ value.SKILL_NAME) {
223
+ const SkillClass = value;
224
+ this.register(SkillClass);
225
+ discovered.push(SkillClass.SKILL_NAME);
226
+ }
227
+ }
228
+ }
229
+ catch (err) {
230
+ log.debug(`Could not load skill from ${fullPath}: ${err}`);
231
+ }
232
+ }
233
+ return discovered;
234
+ }
235
+ /**
236
+ * Discover and register skills from all configured search paths.
237
+ * @returns Array of all newly discovered skill names.
238
+ */
239
+ async discoverAll() {
240
+ const all = [];
241
+ for (const path of this.searchPaths) {
242
+ const found = await this.discoverFromDirectory(path);
243
+ all.push(...found);
244
+ }
245
+ return all;
246
+ }
247
+ /**
248
+ * Get the combined schema info for a registered skill.
249
+ * Matches Python `get_all_skills_schema` per-skill shape
250
+ * (`registry.py:287-295`).
251
+ * @param name - The registered skill name to query.
252
+ * @returns The skill's schema info, or undefined if not found.
253
+ */
254
+ getSkillSchema(name) {
255
+ const SkillClass = this.registry.get(name);
256
+ if (!SkillClass)
257
+ return undefined;
258
+ return {
259
+ name: SkillClass.SKILL_NAME,
260
+ description: SkillClass.SKILL_DESCRIPTION,
261
+ version: SkillClass.SKILL_VERSION,
262
+ supportsMultipleInstances: SkillClass.SUPPORTS_MULTIPLE_INSTANCES,
263
+ requiredEnvVars: [...SkillClass.REQUIRED_ENV_VARS],
264
+ requiredPackages: [...SkillClass.REQUIRED_PACKAGES],
265
+ parameters: SkillClass.getParameterSchema(),
266
+ };
267
+ }
268
+ /**
269
+ * Get combined schema info for all registered skills.
270
+ * @returns Record mapping skill names to their schema info.
271
+ */
272
+ getAllSkillsSchema() {
273
+ const result = {};
274
+ for (const name of this.registry.keys()) {
275
+ const schema = this.getSkillSchema(name);
276
+ if (schema)
277
+ result[name] = schema;
278
+ }
279
+ return result;
280
+ }
281
+ /**
282
+ * Group registered skill names by source category. Matches Python's
283
+ * `list_all_skill_sources` (`skills/registry.py:436-478`).
284
+ *
285
+ * Current TS implementation treats every registered skill as "registered"
286
+ * (the only category that fits — filesystem-based discovery is optional
287
+ * and entry-points don't apply to Node the way they do to Python).
288
+ *
289
+ * @returns Record mapping source categories to arrays of skill names.
290
+ */
291
+ listAllSkillSources() {
292
+ return {
293
+ registered: Array.from(this.registry.keys()),
294
+ };
295
+ }
296
+ /**
297
+ * Get the number of registered skills.
298
+ * @returns The count of registered skills.
299
+ */
300
+ get size() {
301
+ return this.registry.size;
302
+ }
303
+ /**
304
+ * Clear all registrations.
305
+ */
306
+ clear() {
307
+ this.registry.clear();
308
+ }
309
+ }
310
+ //# sourceMappingURL=SkillRegistry.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"SkillRegistry.js","sourceRoot":"","sources":["../../src/skills/SkillRegistry.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,SAAS,EAA+C,MAAM,gBAAgB,CAAC;AACxF,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,MAAM,GAAG,GAAG,SAAS,CAAC,eAAe,CAAC,CAAC;AA0BvC,IAAI,SAAS,GAAyB,IAAI,CAAC;AAE3C;;;;;GAKG;AACH,MAAM,OAAO,aAAa;IACxB;;;OAGG;IACK,QAAQ,GAAkC,IAAI,GAAG,EAAE,CAAC;IACpD,WAAW,GAAgB,IAAI,GAAG,EAAE,CAAC;IACrC,WAAW,CAAW;IAE9B;QACE,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;QACvD,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACzE,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,WAAW;QAChB,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,SAAS,GAAG,IAAI,aAAa,EAAE,CAAC;QAClC,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,aAAa;QAClB,SAAS,GAAG,IAAI,CAAC;IACnB,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,UAA4B;QACnC,MAAM,IAAI,GAAG,UAAU,CAAC,UAAU,CAAC;QACnC,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,KAAK,CACb,GAAG,UAAU,CAAC,IAAI,qDAAqD;gBACrE,6DAA6D,CAChE,CAAC;QACJ,CAAC;QACD,IAAI,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAC/B,GAAG,CAAC,IAAI,CAAC,kCAAkC,IAAI,EAAE,CAAC,CAAC;YACnD,OAAO;QACT,CAAC;QACD,2DAA2D;QAC3D,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,UAAU,CAAC,kBAAkB,EAAE,CAAC;YAC/C,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC9E,MAAM,IAAI,KAAK,CACb,GAAG,UAAU,CAAC,IAAI,sDAAsD,CACzE,CAAC;YACJ,CAAC;QACH,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CACb,GAAG,UAAU,CAAC,IAAI,iCAAiC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CACtG,CAAC;QACJ,CAAC;QACD,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5B,GAAG,CAAC,IAAI,CAAC,mCAAmC,IAAI,EAAE,CAAC,CAAC;QACtD,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QACpC,GAAG,CAAC,KAAK,CAAC,qBAAqB,IAAI,EAAE,CAAC,CAAC;IACzC,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAC,KAAgB;QACnB,MAAM,MAAM,GAAG,KAAK,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;QACzD,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;YAC1B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,IAAY;QACrB,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAY,EAAE,MAAoB;QACvC,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC3C,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,GAAG,CAAC,IAAI,CAAC,gCAAgC,IAAI,EAAE,CAAC,CAAC;YACjD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,sEAAsE;QACtE,mEAAmE;QACnE,MAAM,IAAI,GAAG,UAAgE,CAAC;QAC9E,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACH,aAAa,CAAC,IAAY;QACxB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,IAAY;QACd,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED;;;OAGG;IACH,cAAc;QACZ,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;OAKG;IACH,UAAU;QACR,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;YAC7D,IAAI,EAAE,UAAU,CAAC,UAAU;YAC3B,WAAW,EAAE,UAAU,CAAC,iBAAiB;YACzC,OAAO,EAAE,UAAU,CAAC,aAAa;YACjC,yBAAyB,EAAE,UAAU,CAAC,2BAA2B;YACjE,eAAe,EAAE,CAAC,GAAG,UAAU,CAAC,iBAAiB,CAAC;YAClD,gBAAgB,EAAE,CAAC,GAAG,UAAU,CAAC,iBAAiB,CAAC;YACnD,UAAU,EAAE,UAAU,CAAC,kBAAkB,EAAE;SAC5C,CAAC,CAAC,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,aAAa,CAAC,IAAY;QACxB,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACrC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,cAAc;QACZ,OAAO,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,qBAAqB,CAAC,OAAe;QACzC,IAAI,OAAO,CAAC,GAAG,CAAC,8BAA8B,CAAC,KAAK,MAAM,EAAE,CAAC;YAC3D,GAAG,CAAC,IAAI,CAAC,yFAAyF,CAAC,CAAC;YACpG,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,MAAM,CAAC,kBAAkB,CAAC,CAAC;QACrD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,CAAC;QAC3C,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,MAAM,CAAC,UAAU,CAAC,CAAC;QAEnD,MAAM,UAAU,GAAa,EAAE,CAAC;QAChC,IAAI,OAAiB,CAAC;QAEtB,IAAI,CAAC;YACH,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,OAAO,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;YACnE,OAAO,GAAG,UAAU;iBACjB,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;iBAClG,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACtB,CAAC;QAAC,MAAM,CAAC;YACP,GAAG,CAAC,IAAI,CAAC,gCAAgC,OAAO,EAAE,CAAC,CAAC;YACpD,OAAO,UAAU,CAAC;QACpB,CAAC;QAED,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC5B,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YACtC,IAAI,CAAC;gBACH,MAAM,OAAO,GAAG,aAAa,CAC3B,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,UAAU,CAAC,CACvF,CAAC,IAAI,CAAC;gBACP,MAAM,GAAG,GAA4B,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC;gBAE3D,gEAAgE;gBAChE,iEAAiE;gBACjE,gCAAgC;gBAChC,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;oBACvC,IACE,OAAO,KAAK,KAAK,UAAU;wBAC1B,KAAiC,CAAC,SAAS,YAAY,SAAS;wBAChE,KAA0B,CAAC,UAAU,EACtC,CAAC;wBACD,MAAM,UAAU,GAAG,KAAyB,CAAC;wBAC7C,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;wBAC1B,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;oBACzC,CAAC;gBACH,CAAC;YACH,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,GAAG,CAAC,KAAK,CAAC,6BAA6B,QAAQ,KAAK,GAAG,EAAE,CAAC,CAAC;YAC7D,CAAC;QACH,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW;QACf,MAAM,GAAG,GAAa,EAAE,CAAC;QACzB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACpC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;YACrD,GAAG,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;QACrB,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;;;OAMG;IACH,cAAc,CAAC,IAAY;QACzB,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC3C,IAAI,CAAC,UAAU;YAAE,OAAO,SAAS,CAAC;QAClC,OAAO;YACL,IAAI,EAAE,UAAU,CAAC,UAAU;YAC3B,WAAW,EAAE,UAAU,CAAC,iBAAiB;YACzC,OAAO,EAAE,UAAU,CAAC,aAAa;YACjC,yBAAyB,EAAE,UAAU,CAAC,2BAA2B;YACjE,eAAe,EAAE,CAAC,GAAG,UAAU,CAAC,iBAAiB,CAAC;YAClD,gBAAgB,EAAE,CAAC,GAAG,UAAU,CAAC,iBAAiB,CAAC;YACnD,UAAU,EAAE,UAAU,CAAC,kBAAkB,EAAE;SAC5C,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,kBAAkB;QAChB,MAAM,MAAM,GAAoC,EAAE,CAAC;QACnD,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC;YACxC,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;YACzC,IAAI,MAAM;gBAAE,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC;QACpC,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;;;OASG;IACH,mBAAmB;QACjB,OAAO;YACL,UAAU,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;SAC7C,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;IACxB,CAAC;CACF"}
@@ -0,0 +1,47 @@
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
+ import { SkillBase } from '../SkillBase.js';
9
+ import type { SkillToolDefinition, SkillPromptSection, SkillConfig, ParameterSchemaEntry } from '../SkillBase.js';
10
+ /**
11
+ * Fetches trivia questions from the API Ninjas service.
12
+ *
13
+ * Tier 2 built-in skill. Requires the `API_NINJAS_KEY` environment variable.
14
+ * Supports optional `default_category` and `reveal_answer` config options.
15
+ *
16
+ * @example
17
+ * ```ts
18
+ * agent.addSkill('api_ninjas_trivia', { default_category: 'sciencenature' });
19
+ * ```
20
+ */
21
+ export declare class ApiNinjasTriviaSkill extends SkillBase {
22
+ static SKILL_NAME: string;
23
+ static SKILL_DESCRIPTION: string;
24
+ static REQUIRED_ENV_VARS: readonly string[];
25
+ static SUPPORTS_MULTIPLE_INSTANCES: boolean;
26
+ static getParameterSchema(): Record<string, ParameterSchemaEntry>;
27
+ /**
28
+ * Produce a compound instance key matching Python `get_instance_key`
29
+ * (skill.py:139-146): `f"{SKILL_NAME}_{self.tool_name}"` with
30
+ * `tool_name` defaulting to `'get_trivia'` (skill.py:95). The base
31
+ * `SkillBase.getInstanceKey` uses `this.skillName` as the fallback,
32
+ * so we override to match Python's `'get_trivia'` default.
33
+ */
34
+ getInstanceKey(): string;
35
+ /** @returns A single trivia tool (configurable name) that fetches a random trivia question with optional category. */
36
+ getTools(): SkillToolDefinition[];
37
+ /** @returns Prompt section describing trivia capabilities and quiz behavior. */
38
+ protected _getPromptSections(): SkillPromptSection[];
39
+ /** @returns Speech recognition hints for trivia-related keywords. */
40
+ getHints(): string[];
41
+ }
42
+ /**
43
+ * Factory function for creating ApiNinjasTriviaSkill instances.
44
+ * @param config - Optional skill configuration.
45
+ * @returns A new ApiNinjasTriviaSkill instance.
46
+ */
47
+ export declare function createSkill(config?: SkillConfig): ApiNinjasTriviaSkill;
@@ -0,0 +1,211 @@
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
+ import { SkillBase } from '../SkillBase.js';
9
+ import { FunctionResult } from '../../FunctionResult.js';
10
+ import { getLogger } from '../../Logger.js';
11
+ const log = getLogger('ApiNinjasTriviaSkill');
12
+ const VALID_CATEGORIES = [
13
+ 'artliterature',
14
+ 'language',
15
+ 'sciencenature',
16
+ 'general',
17
+ 'fooddrink',
18
+ 'peopleplaces',
19
+ 'geography',
20
+ 'historyholidays',
21
+ 'entertainment',
22
+ 'toysgames',
23
+ 'music',
24
+ 'mathematics',
25
+ 'religionmythology',
26
+ 'sportsleisure',
27
+ ];
28
+ /**
29
+ * Fetches trivia questions from the API Ninjas service.
30
+ *
31
+ * Tier 2 built-in skill. Requires the `API_NINJAS_KEY` environment variable.
32
+ * Supports optional `default_category` and `reveal_answer` config options.
33
+ *
34
+ * @example
35
+ * ```ts
36
+ * agent.addSkill('api_ninjas_trivia', { default_category: 'sciencenature' });
37
+ * ```
38
+ */
39
+ export class ApiNinjasTriviaSkill extends SkillBase {
40
+ static SKILL_NAME = 'api_ninjas_trivia';
41
+ static SKILL_DESCRIPTION = 'Get trivia questions from API Ninjas';
42
+ // Python skill.py:61 — `REQUIRED_ENV_VARS = []` because the api_key can
43
+ // be supplied via params. The handler still falls back to `API_NINJAS_KEY`
44
+ // so env-based configuration keeps working.
45
+ static REQUIRED_ENV_VARS = [];
46
+ static SUPPORTS_MULTIPLE_INSTANCES = true;
47
+ static getParameterSchema() {
48
+ return {
49
+ ...super.getParameterSchema(),
50
+ tool_name: {
51
+ type: 'string',
52
+ description: 'Custom name for the SWAIG trivia tool (enables multiple instances).',
53
+ default: 'get_trivia',
54
+ },
55
+ api_key: {
56
+ type: 'string',
57
+ description: 'API Ninjas API key.',
58
+ hidden: true,
59
+ env_var: 'API_NINJAS_KEY',
60
+ required: true,
61
+ },
62
+ categories: {
63
+ type: 'array',
64
+ description: 'Subset of trivia categories to enable. Defaults to all categories.',
65
+ required: false,
66
+ default: [...VALID_CATEGORIES],
67
+ items: {
68
+ type: 'string',
69
+ enum: [...VALID_CATEGORIES],
70
+ },
71
+ },
72
+ default_category: {
73
+ type: 'string',
74
+ description: 'Default trivia category if none is specified.',
75
+ },
76
+ reveal_answer: {
77
+ type: 'boolean',
78
+ description: 'Whether to include the answer in the response.',
79
+ default: false,
80
+ },
81
+ };
82
+ }
83
+ /**
84
+ * Produce a compound instance key matching Python `get_instance_key`
85
+ * (skill.py:139-146): `f"{SKILL_NAME}_{self.tool_name}"` with
86
+ * `tool_name` defaulting to `'get_trivia'` (skill.py:95). The base
87
+ * `SkillBase.getInstanceKey` uses `this.skillName` as the fallback,
88
+ * so we override to match Python's `'get_trivia'` default.
89
+ */
90
+ getInstanceKey() {
91
+ const toolName = this.getConfig('tool_name', 'get_trivia');
92
+ return `${this.skillName}_${toolName}`;
93
+ }
94
+ /** @returns A single trivia tool (configurable name) that fetches a random trivia question with optional category. */
95
+ getTools() {
96
+ const toolName = this.getConfig('tool_name', 'get_trivia');
97
+ const defaultCategory = this.getConfig('default_category', undefined);
98
+ const revealAnswer = this.getConfig('reveal_answer', false);
99
+ const configuredCategories = this.getConfig('categories', undefined);
100
+ const enabledCategories = Array.isArray(configuredCategories) && configuredCategories.length > 0
101
+ ? configuredCategories.filter((c) => VALID_CATEGORIES.includes(c))
102
+ : [...VALID_CATEGORIES];
103
+ return [
104
+ {
105
+ name: toolName,
106
+ description: 'Get a random trivia question. Optionally specify a category to narrow the topic.',
107
+ parameters: {
108
+ category: {
109
+ type: 'string',
110
+ description: 'Trivia category. Available categories: ' +
111
+ enabledCategories.join(', ') +
112
+ '. If not specified, a random category is used.',
113
+ enum: enabledCategories,
114
+ },
115
+ },
116
+ handler: async (args) => {
117
+ const apiKey = this.getConfig('api_key', undefined) ??
118
+ process.env['API_NINJAS_KEY'];
119
+ if (!apiKey) {
120
+ return new FunctionResult('Trivia service is not configured. The API_NINJAS_KEY environment variable is missing.');
121
+ }
122
+ let category = args.category ?? defaultCategory;
123
+ // Validate category if provided
124
+ if (category && typeof category === 'string') {
125
+ const normalized = category.toLowerCase().trim().replace(/[\s_-]/g, '');
126
+ if (!enabledCategories.includes(normalized)) {
127
+ return new FunctionResult(`Unknown trivia category "${category}". Available categories: ${enabledCategories.join(', ')}.`);
128
+ }
129
+ category = normalized;
130
+ }
131
+ try {
132
+ const url = category
133
+ ? `https://api.api-ninjas.com/v1/trivia?category=${encodeURIComponent(category)}`
134
+ : 'https://api.api-ninjas.com/v1/trivia';
135
+ const controller = new AbortController();
136
+ const timeout = setTimeout(() => controller.abort(), 30_000);
137
+ let response;
138
+ try {
139
+ response = await fetch(url, {
140
+ headers: {
141
+ 'X-Api-Key': apiKey,
142
+ },
143
+ signal: controller.signal,
144
+ });
145
+ }
146
+ finally {
147
+ clearTimeout(timeout);
148
+ }
149
+ if (!response.ok) {
150
+ log.error('trivia_api_error', { status: response.status });
151
+ return new FunctionResult('The trivia service encountered an error. Please try again later.');
152
+ }
153
+ const data = (await response.json());
154
+ if (!Array.isArray(data) || data.length === 0) {
155
+ return new FunctionResult('No trivia questions were returned. Please try again or try a different category.');
156
+ }
157
+ const trivia = data[0];
158
+ if (revealAnswer) {
159
+ return new FunctionResult(`Trivia (${trivia.category}): ${trivia.question} Answer: ${trivia.answer}`);
160
+ }
161
+ // When not revealing the answer, provide it in a structured way
162
+ // so the AI knows the answer but can quiz the user
163
+ return new FunctionResult(`Here is a trivia question from the "${trivia.category}" category. ` +
164
+ `Question: ${trivia.question} ` +
165
+ `[The correct answer is: ${trivia.answer}. Do not reveal this unless the user attempts an answer or asks for it.]`);
166
+ }
167
+ catch (err) {
168
+ log.error('get_trivia_failed', { error: err instanceof Error ? err.message : String(err) });
169
+ return new FunctionResult('The request could not be completed. Please try again.');
170
+ }
171
+ },
172
+ },
173
+ ];
174
+ }
175
+ /** @returns Prompt section describing trivia capabilities and quiz behavior. */
176
+ _getPromptSections() {
177
+ const revealAnswer = this.getConfig('reveal_answer', false);
178
+ const bullets = [
179
+ 'Use the get_trivia tool to fetch a random trivia question.',
180
+ `Available categories: ${VALID_CATEGORIES.join(', ')}.`,
181
+ 'If no category is specified, a random category will be selected.',
182
+ ];
183
+ if (!revealAnswer) {
184
+ bullets.push('When you receive a trivia question, ask it to the user and let them try to answer before revealing the correct answer.', 'If the user gets it wrong, give them a hint or tell them the correct answer.');
185
+ }
186
+ else {
187
+ bullets.push('Trivia answers are included in the response. Share the question and answer with the user.');
188
+ }
189
+ bullets.push('Keep trivia fun and engaging. Encourage the user to try more questions.');
190
+ return [
191
+ {
192
+ title: 'Trivia Questions',
193
+ body: 'You can fetch and ask trivia questions from a wide range of categories.',
194
+ bullets,
195
+ },
196
+ ];
197
+ }
198
+ /** @returns Speech recognition hints for trivia-related keywords. */
199
+ getHints() {
200
+ return ['trivia', 'quiz', 'question', 'fun fact'];
201
+ }
202
+ }
203
+ /**
204
+ * Factory function for creating ApiNinjasTriviaSkill instances.
205
+ * @param config - Optional skill configuration.
206
+ * @returns A new ApiNinjasTriviaSkill instance.
207
+ */
208
+ export function createSkill(config) {
209
+ return new ApiNinjasTriviaSkill(config);
210
+ }
211
+ //# sourceMappingURL=api_ninjas_trivia.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"api_ninjas_trivia.js","sourceRoot":"","sources":["../../../src/skills/builtin/api_ninjas_trivia.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAO5C,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,MAAM,GAAG,GAAG,SAAS,CAAC,sBAAsB,CAAC,CAAC;AAY9C,MAAM,gBAAgB,GAAG;IACvB,eAAe;IACf,UAAU;IACV,eAAe;IACf,SAAS;IACT,WAAW;IACX,cAAc;IACd,WAAW;IACX,iBAAiB;IACjB,eAAe;IACf,WAAW;IACX,OAAO;IACP,aAAa;IACb,mBAAmB;IACnB,eAAe;CACP,CAAC;AAEX;;;;;;;;;;GAUG;AACH,MAAM,OAAO,oBAAqB,SAAQ,SAAS;IACjD,MAAM,CAAU,UAAU,GAAG,mBAAmB,CAAC;IACjD,MAAM,CAAU,iBAAiB,GAAG,sCAAsC,CAAC;IAC3E,wEAAwE;IACxE,2EAA2E;IAC3E,4CAA4C;IAC5C,MAAM,CAAU,iBAAiB,GAAsB,EAAE,CAAC;IAC1D,MAAM,CAAU,2BAA2B,GAAG,IAAI,CAAC;IAEnD,MAAM,CAAU,kBAAkB;QAChC,OAAO;YACL,GAAG,KAAK,CAAC,kBAAkB,EAAE;YAC7B,SAAS,EAAE;gBACT,IAAI,EAAE,QAAQ;gBACd,WAAW,EACT,qEAAqE;gBACvE,OAAO,EAAE,YAAY;aACtB;YACD,OAAO,EAAE;gBACP,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,qBAAqB;gBAClC,MAAM,EAAE,IAAI;gBACZ,OAAO,EAAE,gBAAgB;gBACzB,QAAQ,EAAE,IAAI;aACf;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,OAAO;gBACb,WAAW,EACT,oEAAoE;gBACtE,QAAQ,EAAE,KAAK;gBACf,OAAO,EAAE,CAAC,GAAG,gBAAgB,CAAC;gBAC9B,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,GAAG,gBAAgB,CAAC;iBAC5B;aACF;YACD,gBAAgB,EAAE;gBAChB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,+CAA+C;aAC7D;YACD,aAAa,EAAE;gBACb,IAAI,EAAE,SAAS;gBACf,WAAW,EAAE,gDAAgD;gBAC7D,OAAO,EAAE,KAAK;aACf;SACF,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACM,cAAc;QACrB,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAS,WAAW,EAAE,YAAY,CAAC,CAAC;QACnE,OAAO,GAAG,IAAI,CAAC,SAAS,IAAI,QAAQ,EAAE,CAAC;IACzC,CAAC;IAED,sHAAsH;IACtH,QAAQ;QACN,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAS,WAAW,EAAE,YAAY,CAAC,CAAC;QACnE,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CACpC,kBAAkB,EAClB,SAAS,CACV,CAAC;QACF,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAU,eAAe,EAAE,KAAK,CAAC,CAAC;QACrE,MAAM,oBAAoB,GAAG,IAAI,CAAC,SAAS,CACzC,YAAY,EACZ,SAAS,CACV,CAAC;QACF,MAAM,iBAAiB,GACrB,KAAK,CAAC,OAAO,CAAC,oBAAoB,CAAC,IAAI,oBAAoB,CAAC,MAAM,GAAG,CAAC;YACpE,CAAC,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAe,EAAE,CAC5C,gBAAsC,CAAC,QAAQ,CAAC,CAAC,CAAC,CACpD;YACH,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC;QAE5B,OAAO;YACL;gBACE,IAAI,EAAE,QAAQ;gBACd,WAAW,EACT,kFAAkF;gBACpF,UAAU,EAAE;oBACV,QAAQ,EAAE;wBACR,IAAI,EAAE,QAAQ;wBACd,WAAW,EACT,yCAAyC;4BACzC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC;4BAC5B,gDAAgD;wBAClD,IAAI,EAAE,iBAAiB;qBACxB;iBACF;gBACD,OAAO,EAAE,KAAK,EAAE,IAA6B,EAAE,EAAE;oBAC/C,MAAM,MAAM,GACV,IAAI,CAAC,SAAS,CAAqB,SAAS,EAAE,SAAS,CAAC;wBACxD,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;oBAChC,IAAI,CAAC,MAAM,EAAE,CAAC;wBACZ,OAAO,IAAI,cAAc,CACvB,uFAAuF,CACxF,CAAC;oBACJ,CAAC;oBAED,IAAI,QAAQ,GAAI,IAAI,CAAC,QAA+B,IAAI,eAAe,CAAC;oBAExE,gCAAgC;oBAChC,IAAI,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;wBAC7C,MAAM,UAAU,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;wBACxE,IACE,CAAC,iBAAiB,CAAC,QAAQ,CAAC,UAAU,CAAC,EACvC,CAAC;4BACD,OAAO,IAAI,cAAc,CACvB,4BAA4B,QAAQ,4BAA4B,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAChG,CAAC;wBACJ,CAAC;wBACD,QAAQ,GAAG,UAAU,CAAC;oBACxB,CAAC;oBAED,IAAI,CAAC;wBACH,MAAM,GAAG,GAAG,QAAQ;4BAClB,CAAC,CAAC,iDAAiD,kBAAkB,CAAC,QAAQ,CAAC,EAAE;4BACjF,CAAC,CAAC,sCAAsC,CAAC;wBAE3C,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;wBACzC,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,MAAM,CAAC,CAAC;wBAC7D,IAAI,QAAkB,CAAC;wBACvB,IAAI,CAAC;4BACH,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;gCAC1B,OAAO,EAAE;oCACP,WAAW,EAAE,MAAM;iCACpB;gCACD,MAAM,EAAE,UAAU,CAAC,MAAM;6BAC1B,CAAC,CAAC;wBACL,CAAC;gCAAS,CAAC;4BACT,YAAY,CAAC,OAAO,CAAC,CAAC;wBACxB,CAAC;wBAED,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;4BACjB,GAAG,CAAC,KAAK,CAAC,kBAAkB,EAAE,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;4BAC3D,OAAO,IAAI,cAAc,CACvB,kEAAkE,CACnE,CAAC;wBACJ,CAAC;wBAED,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAqB,CAAC;wBAEzD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;4BAC9C,OAAO,IAAI,cAAc,CACvB,kFAAkF,CACnF,CAAC;wBACJ,CAAC;wBAED,MAAM,MAAM,GAAG,IAAI,CAAC,CAAC,CAAE,CAAC;wBAExB,IAAI,YAAY,EAAE,CAAC;4BACjB,OAAO,IAAI,cAAc,CACvB,WAAW,MAAM,CAAC,QAAQ,MAAM,MAAM,CAAC,QAAQ,YAAY,MAAM,CAAC,MAAM,EAAE,CAC3E,CAAC;wBACJ,CAAC;wBAED,gEAAgE;wBAChE,mDAAmD;wBACnD,OAAO,IAAI,cAAc,CACvB,uCAAuC,MAAM,CAAC,QAAQ,cAAc;4BAClE,aAAa,MAAM,CAAC,QAAQ,GAAG;4BAC/B,2BAA2B,MAAM,CAAC,MAAM,0EAA0E,CACrH,CAAC;oBACJ,CAAC;oBAAC,OAAO,GAAG,EAAE,CAAC;wBACb,GAAG,CAAC,KAAK,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;wBAC5F,OAAO,IAAI,cAAc,CACvB,uDAAuD,CACxD,CAAC;oBACJ,CAAC;gBACH,CAAC;aACF;SACF,CAAC;IACJ,CAAC;IAED,gFAAgF;IAC7D,kBAAkB;QACnC,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAU,eAAe,EAAE,KAAK,CAAC,CAAC;QAErE,MAAM,OAAO,GAAa;YACxB,4DAA4D;YAC5D,yBAAyB,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;YACvD,kEAAkE;SACnE,CAAC;QAEF,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,OAAO,CAAC,IAAI,CACV,wHAAwH,EACxH,8EAA8E,CAC/E,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,IAAI,CACV,2FAA2F,CAC5F,CAAC;QACJ,CAAC;QAED,OAAO,CAAC,IAAI,CACV,yEAAyE,CAC1E,CAAC;QAEF,OAAO;YACL;gBACE,KAAK,EAAE,kBAAkB;gBACzB,IAAI,EAAE,yEAAyE;gBAC/E,OAAO;aACR;SACF,CAAC;IACJ,CAAC;IAED,qEAAqE;IACrE,QAAQ;QACN,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;IACpD,CAAC;;AAGH;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,MAAoB;IAC9C,OAAO,IAAI,oBAAoB,CAAC,MAAM,CAAC,CAAC;AAC1C,CAAC"}
@@ -0,0 +1,37 @@
1
+ /**
2
+ * Ask Claude - Provides access to Anthropic's Claude AI for sub-queries.
3
+ *
4
+ * Tier 3 built-in skill: requires ANTHROPIC_API_KEY environment variable.
5
+ * Allows the agent to send prompts to Claude for complex reasoning,
6
+ * analysis, or sub-tasks that benefit from a dedicated AI query.
7
+ */
8
+ import { SkillBase } from '../SkillBase.js';
9
+ import type { SkillToolDefinition, SkillPromptSection, SkillConfig, ParameterSchemaEntry } from '../SkillBase.js';
10
+ /**
11
+ * Provides access to Anthropic's Claude AI for sub-queries and complex reasoning.
12
+ *
13
+ * Tier 3 built-in skill. Requires the `ANTHROPIC_API_KEY` environment variable.
14
+ * Supports `model` and `max_tokens` config options to control which Claude model
15
+ * is used and the maximum response length.
16
+ *
17
+ * @example
18
+ * ```ts
19
+ * agent.addSkill('ask_claude', { model: 'claude-sonnet-4-6', max_tokens: 512 });
20
+ * ```
21
+ */
22
+ export declare class AskClaudeSkill extends SkillBase {
23
+ static SKILL_NAME: string;
24
+ static SKILL_DESCRIPTION: string;
25
+ static REQUIRED_ENV_VARS: readonly string[];
26
+ static getParameterSchema(): Record<string, ParameterSchemaEntry>;
27
+ /** @returns A single `ask_claude` tool that sends prompts to the Claude API. */
28
+ getTools(): SkillToolDefinition[];
29
+ /** @returns Prompt section describing Claude AI delegation capabilities. */
30
+ protected _getPromptSections(): SkillPromptSection[];
31
+ }
32
+ /**
33
+ * Factory function for creating AskClaudeSkill instances.
34
+ * @param config - Optional skill configuration.
35
+ * @returns A new AskClaudeSkill instance.
36
+ */
37
+ export declare function createSkill(config?: SkillConfig): AskClaudeSkill;