@signalwire/sdk 2.0.1 → 2.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (610) hide show
  1. package/dist/AgentBase.d.ts +1045 -0
  2. package/dist/AgentBase.js +2375 -0
  3. package/dist/AgentBase.js.map +1 -0
  4. package/dist/AgentServer.d.ts +146 -0
  5. package/dist/AgentServer.js +388 -0
  6. package/dist/AgentServer.js.map +1 -0
  7. package/dist/AuthHandler.d.ts +127 -0
  8. package/dist/AuthHandler.js +212 -0
  9. package/dist/AuthHandler.js.map +1 -0
  10. package/dist/ConfigLoader.d.ts +170 -0
  11. package/dist/ConfigLoader.js +393 -0
  12. package/dist/ConfigLoader.js.map +1 -0
  13. package/dist/ContextBuilder.d.ts +652 -0
  14. package/dist/ContextBuilder.js +1115 -0
  15. package/dist/ContextBuilder.js.map +1 -0
  16. package/dist/DataMap.d.ts +271 -0
  17. package/dist/DataMap.js +430 -0
  18. package/dist/DataMap.js.map +1 -0
  19. package/dist/FunctionResult.d.ts +481 -0
  20. package/dist/FunctionResult.js +775 -0
  21. package/dist/FunctionResult.js.map +1 -0
  22. package/dist/Logger.d.ts +113 -0
  23. package/dist/Logger.js +320 -0
  24. package/dist/Logger.js.map +1 -0
  25. package/dist/PomBuilder.d.ts +208 -0
  26. package/dist/PomBuilder.js +409 -0
  27. package/dist/PomBuilder.js.map +1 -0
  28. package/dist/PromptManager.d.ts +85 -0
  29. package/dist/PromptManager.js +108 -0
  30. package/dist/PromptManager.js.map +1 -0
  31. package/dist/SWMLHandler.d.ts +159 -0
  32. package/dist/SWMLHandler.js +229 -0
  33. package/dist/SWMLHandler.js.map +1 -0
  34. package/dist/SWMLService.d.ts +326 -0
  35. package/dist/SWMLService.js +610 -0
  36. package/dist/SWMLService.js.map +1 -0
  37. package/dist/SchemaUtils.d.ts +108 -0
  38. package/dist/SchemaUtils.js +317 -0
  39. package/dist/SchemaUtils.js.map +1 -0
  40. package/dist/SecurityUtils.d.ts +60 -0
  41. package/{src/SecurityUtils.ts → dist/SecurityUtils.js} +82 -83
  42. package/dist/SecurityUtils.js.map +1 -0
  43. package/dist/ServerlessAdapter.d.ts +119 -0
  44. package/dist/ServerlessAdapter.js +188 -0
  45. package/dist/ServerlessAdapter.js.map +1 -0
  46. package/dist/SessionManager.d.ts +142 -0
  47. package/dist/SessionManager.js +260 -0
  48. package/dist/SessionManager.js.map +1 -0
  49. package/dist/SslConfig.d.ts +77 -0
  50. package/dist/SslConfig.js +100 -0
  51. package/dist/SslConfig.js.map +1 -0
  52. package/dist/SwaigFunction.d.ts +159 -0
  53. package/dist/SwaigFunction.js +209 -0
  54. package/dist/SwaigFunction.js.map +1 -0
  55. package/dist/SwmlBuilder.d.ts +165 -0
  56. package/dist/SwmlBuilder.js +247 -0
  57. package/dist/SwmlBuilder.js.map +1 -0
  58. package/dist/SwmlVerbMethods.generated.d.ts +254 -0
  59. package/dist/SwmlVerbMethods.generated.js +9 -0
  60. package/dist/SwmlVerbMethods.generated.js.map +1 -0
  61. package/dist/TypeInference.d.ts +71 -0
  62. package/dist/TypeInference.js +164 -0
  63. package/dist/TypeInference.js.map +1 -0
  64. package/dist/WebService.d.ts +148 -0
  65. package/dist/WebService.js +532 -0
  66. package/dist/WebService.js.map +1 -0
  67. package/dist/cli/agent-loader.d.ts +22 -0
  68. package/dist/cli/agent-loader.js +144 -0
  69. package/dist/cli/agent-loader.js.map +1 -0
  70. package/dist/cli/mock-data.d.ts +37 -0
  71. package/dist/cli/mock-data.js +80 -0
  72. package/dist/cli/mock-data.js.map +1 -0
  73. package/dist/cli/swaig-test.d.ts +32 -0
  74. package/dist/cli/swaig-test.js +418 -0
  75. package/dist/cli/swaig-test.js.map +1 -0
  76. package/dist/generateVerbTypes.d.ts +11 -0
  77. package/dist/generateVerbTypes.js +265 -0
  78. package/dist/generateVerbTypes.js.map +1 -0
  79. package/{src/index.ts → dist/index.d.ts} +13 -100
  80. package/dist/index.js +152 -0
  81. package/dist/index.js.map +1 -0
  82. package/dist/livewire/index.d.ts +653 -0
  83. package/dist/livewire/index.js +992 -0
  84. package/dist/livewire/index.js.map +1 -0
  85. package/dist/prefabs/ConciergeAgent.d.ts +89 -0
  86. package/dist/prefabs/ConciergeAgent.js +245 -0
  87. package/dist/prefabs/ConciergeAgent.js.map +1 -0
  88. package/dist/prefabs/FAQBotAgent.d.ts +113 -0
  89. package/dist/prefabs/FAQBotAgent.js +329 -0
  90. package/dist/prefabs/FAQBotAgent.js.map +1 -0
  91. package/dist/prefabs/InfoGathererAgent.d.ts +126 -0
  92. package/dist/prefabs/InfoGathererAgent.js +287 -0
  93. package/dist/prefabs/InfoGathererAgent.js.map +1 -0
  94. package/dist/prefabs/ReceptionistAgent.d.ts +104 -0
  95. package/dist/prefabs/ReceptionistAgent.js +303 -0
  96. package/dist/prefabs/ReceptionistAgent.js.map +1 -0
  97. package/dist/prefabs/SurveyAgent.d.ts +148 -0
  98. package/dist/prefabs/SurveyAgent.js +540 -0
  99. package/dist/prefabs/SurveyAgent.js.map +1 -0
  100. package/{src/prefabs/index.ts → dist/prefabs/index.d.ts} +1 -15
  101. package/dist/prefabs/index.js +14 -0
  102. package/dist/prefabs/index.js.map +1 -0
  103. package/dist/relay/Action.d.ts +258 -0
  104. package/dist/relay/Action.js +402 -0
  105. package/dist/relay/Action.js.map +1 -0
  106. package/dist/relay/Call.d.ts +697 -0
  107. package/dist/relay/Call.js +1062 -0
  108. package/dist/relay/Call.js.map +1 -0
  109. package/dist/relay/Deferred.d.ts +44 -0
  110. package/dist/relay/Deferred.js +69 -0
  111. package/dist/relay/Deferred.js.map +1 -0
  112. package/dist/relay/Message.d.ts +103 -0
  113. package/dist/relay/Message.js +169 -0
  114. package/dist/relay/Message.js.map +1 -0
  115. package/dist/relay/RelayClient.d.ts +302 -0
  116. package/dist/relay/RelayClient.js +1026 -0
  117. package/dist/relay/RelayClient.js.map +1 -0
  118. package/dist/relay/RelayError.d.ts +15 -0
  119. package/dist/relay/RelayError.js +20 -0
  120. package/dist/relay/RelayError.js.map +1 -0
  121. package/dist/relay/RelayEvent.d.ts +254 -0
  122. package/dist/relay/RelayEvent.js +509 -0
  123. package/dist/relay/RelayEvent.js.map +1 -0
  124. package/dist/relay/constants.d.ts +90 -0
  125. package/{src/relay/constants.ts → dist/relay/constants.js} +11 -29
  126. package/dist/relay/constants.js.map +1 -0
  127. package/dist/relay/index.d.ts +16 -0
  128. package/dist/relay/index.js +18 -0
  129. package/dist/relay/index.js.map +1 -0
  130. package/dist/relay/types.d.ts +142 -0
  131. package/dist/relay/types.js +5 -0
  132. package/dist/relay/types.js.map +1 -0
  133. package/dist/rest/HttpClient.d.ts +80 -0
  134. package/dist/rest/HttpClient.js +148 -0
  135. package/dist/rest/HttpClient.js.map +1 -0
  136. package/dist/rest/RestError.d.ts +30 -0
  137. package/dist/rest/RestError.js +39 -0
  138. package/dist/rest/RestError.js.map +1 -0
  139. package/dist/rest/base/BaseResource.d.ts +24 -0
  140. package/dist/rest/base/BaseResource.js +29 -0
  141. package/dist/rest/base/BaseResource.js.map +1 -0
  142. package/dist/rest/base/CrudResource.d.ts +68 -0
  143. package/dist/rest/base/CrudResource.js +82 -0
  144. package/dist/rest/base/CrudResource.js.map +1 -0
  145. package/dist/rest/base/CrudWithAddresses.d.ts +22 -0
  146. package/dist/rest/base/CrudWithAddresses.js +25 -0
  147. package/dist/rest/base/CrudWithAddresses.js.map +1 -0
  148. package/dist/rest/index.d.ts +131 -0
  149. package/{src/rest/index.ts → dist/rest/index.js} +101 -136
  150. package/dist/rest/index.js.map +1 -0
  151. package/dist/rest/namespaces/addresses.d.ts +46 -0
  152. package/dist/rest/namespaces/addresses.js +55 -0
  153. package/dist/rest/namespaces/addresses.js.map +1 -0
  154. package/dist/rest/namespaces/calling.d.ts +382 -0
  155. package/dist/rest/namespaces/calling.js +478 -0
  156. package/dist/rest/namespaces/calling.js.map +1 -0
  157. package/dist/rest/namespaces/chat.d.ts +22 -0
  158. package/dist/rest/namespaces/chat.js +26 -0
  159. package/dist/rest/namespaces/chat.js.map +1 -0
  160. package/dist/rest/namespaces/compat.d.ts +585 -0
  161. package/dist/rest/namespaces/compat.js +735 -0
  162. package/dist/rest/namespaces/compat.js.map +1 -0
  163. package/dist/rest/namespaces/datasphere.d.ts +66 -0
  164. package/dist/rest/namespaces/datasphere.js +77 -0
  165. package/dist/rest/namespaces/datasphere.js.map +1 -0
  166. package/dist/rest/namespaces/fabric.d.ts +282 -0
  167. package/dist/rest/namespaces/fabric.js +373 -0
  168. package/dist/rest/namespaces/fabric.js.map +1 -0
  169. package/dist/rest/namespaces/imported-numbers.d.ts +22 -0
  170. package/dist/rest/namespaces/imported-numbers.js +26 -0
  171. package/dist/rest/namespaces/imported-numbers.js.map +1 -0
  172. package/dist/rest/namespaces/logs.d.ts +105 -0
  173. package/dist/rest/namespaces/logs.js +133 -0
  174. package/dist/rest/namespaces/logs.js.map +1 -0
  175. package/dist/rest/namespaces/lookup.d.ts +29 -0
  176. package/dist/rest/namespaces/lookup.js +32 -0
  177. package/dist/rest/namespaces/lookup.js.map +1 -0
  178. package/dist/rest/namespaces/mfa.d.ts +46 -0
  179. package/dist/rest/namespaces/mfa.js +54 -0
  180. package/dist/rest/namespaces/mfa.js.map +1 -0
  181. package/dist/rest/namespaces/number-groups.d.ts +49 -0
  182. package/dist/rest/namespaces/number-groups.js +58 -0
  183. package/dist/rest/namespaces/number-groups.js.map +1 -0
  184. package/dist/rest/namespaces/phone-numbers.d.ts +60 -0
  185. package/dist/rest/namespaces/phone-numbers.js +67 -0
  186. package/dist/rest/namespaces/phone-numbers.js.map +1 -0
  187. package/dist/rest/namespaces/project.d.ts +46 -0
  188. package/dist/rest/namespaces/project.js +56 -0
  189. package/dist/rest/namespaces/project.js.map +1 -0
  190. package/dist/rest/namespaces/pubsub.d.ts +22 -0
  191. package/dist/rest/namespaces/pubsub.js +26 -0
  192. package/dist/rest/namespaces/pubsub.js.map +1 -0
  193. package/dist/rest/namespaces/queues.d.ts +42 -0
  194. package/dist/rest/namespaces/queues.js +49 -0
  195. package/dist/rest/namespaces/queues.js.map +1 -0
  196. package/dist/rest/namespaces/recordings.d.ts +38 -0
  197. package/dist/rest/namespaces/recordings.js +45 -0
  198. package/dist/rest/namespaces/recordings.js.map +1 -0
  199. package/dist/rest/namespaces/registry.d.ts +141 -0
  200. package/dist/rest/namespaces/registry.js +178 -0
  201. package/dist/rest/namespaces/registry.js.map +1 -0
  202. package/dist/rest/namespaces/short-codes.d.ts +39 -0
  203. package/dist/rest/namespaces/short-codes.js +46 -0
  204. package/dist/rest/namespaces/short-codes.js.map +1 -0
  205. package/dist/rest/namespaces/sip-profile.d.ts +28 -0
  206. package/dist/rest/namespaces/sip-profile.js +34 -0
  207. package/dist/rest/namespaces/sip-profile.js.map +1 -0
  208. package/dist/rest/namespaces/verified-callers.d.ts +33 -0
  209. package/dist/rest/namespaces/verified-callers.js +39 -0
  210. package/dist/rest/namespaces/verified-callers.js.map +1 -0
  211. package/dist/rest/namespaces/video.d.ts +235 -0
  212. package/dist/rest/namespaces/video.js +297 -0
  213. package/dist/rest/namespaces/video.js.map +1 -0
  214. package/{src/rest/pagination.ts → dist/rest/pagination.d.ts} +2 -61
  215. package/dist/rest/pagination.js +78 -0
  216. package/dist/rest/pagination.js.map +1 -0
  217. package/dist/rest/types.d.ts +54 -0
  218. package/dist/rest/types.js +5 -0
  219. package/dist/rest/types.js.map +1 -0
  220. package/dist/skills/SkillBase.d.ts +404 -0
  221. package/dist/skills/SkillBase.js +471 -0
  222. package/dist/skills/SkillBase.js.map +1 -0
  223. package/dist/skills/SkillManager.d.ts +195 -0
  224. package/dist/skills/SkillManager.js +378 -0
  225. package/dist/skills/SkillManager.js.map +1 -0
  226. package/dist/skills/SkillRegistry.d.ts +176 -0
  227. package/dist/skills/SkillRegistry.js +310 -0
  228. package/dist/skills/SkillRegistry.js.map +1 -0
  229. package/dist/skills/builtin/api_ninjas_trivia.d.ts +47 -0
  230. package/dist/skills/builtin/api_ninjas_trivia.js +211 -0
  231. package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -0
  232. package/dist/skills/builtin/ask_claude.d.ts +37 -0
  233. package/dist/skills/builtin/ask_claude.js +162 -0
  234. package/dist/skills/builtin/ask_claude.js.map +1 -0
  235. package/dist/skills/builtin/claude_skills.d.ts +75 -0
  236. package/dist/skills/builtin/claude_skills.js +753 -0
  237. package/dist/skills/builtin/claude_skills.js.map +1 -0
  238. package/dist/skills/builtin/custom_skills.d.ts +79 -0
  239. package/dist/skills/builtin/custom_skills.js +227 -0
  240. package/dist/skills/builtin/custom_skills.js.map +1 -0
  241. package/dist/skills/builtin/datasphere.d.ts +73 -0
  242. package/dist/skills/builtin/datasphere.js +350 -0
  243. package/dist/skills/builtin/datasphere.js.map +1 -0
  244. package/dist/skills/builtin/datasphere_serverless.d.ts +89 -0
  245. package/dist/skills/builtin/datasphere_serverless.js +291 -0
  246. package/dist/skills/builtin/datasphere_serverless.js.map +1 -0
  247. package/dist/skills/builtin/datetime.d.ts +40 -0
  248. package/dist/skills/builtin/datetime.js +118 -0
  249. package/dist/skills/builtin/datetime.js.map +1 -0
  250. package/dist/skills/builtin/google_maps.d.ts +48 -0
  251. package/dist/skills/builtin/google_maps.js +470 -0
  252. package/dist/skills/builtin/google_maps.js.map +1 -0
  253. package/dist/skills/builtin/index.d.ts +31 -0
  254. package/{src/skills/builtin/index.ts → dist/skills/builtin/index.js} +30 -36
  255. package/dist/skills/builtin/index.js.map +1 -0
  256. package/dist/skills/builtin/info_gatherer.d.ts +115 -0
  257. package/dist/skills/builtin/info_gatherer.js +328 -0
  258. package/dist/skills/builtin/info_gatherer.js.map +1 -0
  259. package/dist/skills/builtin/joke.d.ts +41 -0
  260. package/dist/skills/builtin/joke.js +156 -0
  261. package/dist/skills/builtin/joke.js.map +1 -0
  262. package/dist/skills/builtin/math.d.ts +39 -0
  263. package/dist/skills/builtin/math.js +119 -0
  264. package/dist/skills/builtin/math.js.map +1 -0
  265. package/dist/skills/builtin/mcp_gateway.d.ts +82 -0
  266. package/dist/skills/builtin/mcp_gateway.js +574 -0
  267. package/dist/skills/builtin/mcp_gateway.js.map +1 -0
  268. package/dist/skills/builtin/native_vector_search.d.ts +128 -0
  269. package/dist/skills/builtin/native_vector_search.js +752 -0
  270. package/dist/skills/builtin/native_vector_search.js.map +1 -0
  271. package/dist/skills/builtin/play_background_file.d.ts +59 -0
  272. package/dist/skills/builtin/play_background_file.js +274 -0
  273. package/dist/skills/builtin/play_background_file.js.map +1 -0
  274. package/dist/skills/builtin/spider.d.ts +91 -0
  275. package/dist/skills/builtin/spider.js +758 -0
  276. package/dist/skills/builtin/spider.js.map +1 -0
  277. package/dist/skills/builtin/swml_transfer.d.ts +66 -0
  278. package/dist/skills/builtin/swml_transfer.js +475 -0
  279. package/dist/skills/builtin/swml_transfer.js.map +1 -0
  280. package/dist/skills/builtin/weather_api.d.ts +59 -0
  281. package/dist/skills/builtin/weather_api.js +196 -0
  282. package/dist/skills/builtin/weather_api.js.map +1 -0
  283. package/dist/skills/builtin/web_search.d.ts +160 -0
  284. package/dist/skills/builtin/web_search.js +894 -0
  285. package/dist/skills/builtin/web_search.js.map +1 -0
  286. package/dist/skills/builtin/wikipedia_search.d.ts +77 -0
  287. package/dist/skills/builtin/wikipedia_search.js +241 -0
  288. package/dist/skills/builtin/wikipedia_search.js.map +1 -0
  289. package/{src/skills/index.ts → dist/skills/index.d.ts} +0 -1
  290. package/dist/skills/index.js +10 -0
  291. package/dist/skills/index.js.map +1 -0
  292. package/dist/types.d.ts +118 -0
  293. package/dist/types.js +5 -0
  294. package/dist/types.js.map +1 -0
  295. package/package.json +7 -1
  296. package/.github/workflows/publish.yml +0 -27
  297. package/.github/workflows/test.yml +0 -17
  298. package/CLAUDE.md +0 -112
  299. package/docs/MIGRATION-2.0.md +0 -81
  300. package/docs/agent-guide.md +0 -869
  301. package/docs/agent_guide.md +0 -1026
  302. package/docs/api-reference.md +0 -2420
  303. package/docs/api_reference.md +0 -1301
  304. package/docs/architecture.md +0 -843
  305. package/docs/cli-guide.md +0 -579
  306. package/docs/cli_guide.md +0 -448
  307. package/docs/cloud_functions_guide.md +0 -474
  308. package/docs/configuration.md +0 -422
  309. package/docs/contexts-guide.md +0 -787
  310. package/docs/contexts_guide.md +0 -511
  311. package/docs/datamap-guide.md +0 -1141
  312. package/docs/datamap_guide.md +0 -595
  313. package/docs/llm_parameters.md +0 -239
  314. package/docs/mcp_gateway_reference.md +0 -648
  315. package/docs/mcp_integration.md +0 -108
  316. package/docs/prefabs-guide.md +0 -800
  317. package/docs/sdk_features.md +0 -477
  318. package/docs/security.md +0 -436
  319. package/docs/serverless-guide.md +0 -513
  320. package/docs/skills-guide.md +0 -857
  321. package/docs/skills-system.md +0 -301
  322. package/docs/skills_parameter_schema.md +0 -392
  323. package/docs/skills_system.md +0 -467
  324. package/docs/swaig-reference.md +0 -1627
  325. package/docs/swaig_reference.md +0 -910
  326. package/docs/swml_service_guide.md +0 -600
  327. package/docs/third_party_skills.md +0 -533
  328. package/docs/web_service.md +0 -677
  329. package/examples/README.md +0 -131
  330. package/examples/advanced-datamap.ts +0 -100
  331. package/examples/advanced-dynamic-config.ts +0 -70
  332. package/examples/auto-vivified.ts +0 -94
  333. package/examples/call-flow.ts +0 -63
  334. package/examples/comprehensive-dynamic.ts +0 -125
  335. package/examples/contexts-steps.ts +0 -65
  336. package/examples/custom-path.ts +0 -45
  337. package/examples/datamap-tools.ts +0 -55
  338. package/examples/datasphere-multi-instance.ts +0 -63
  339. package/examples/datasphere-serverless-env.ts +0 -68
  340. package/examples/datasphere-webhook-env.ts +0 -66
  341. package/examples/datasphere.ts +0 -37
  342. package/examples/declarative.ts +0 -100
  343. package/examples/dynamic-config.ts +0 -54
  344. package/examples/dynamic-info-gatherer.ts +0 -69
  345. package/examples/dynamic-swml-service.ts +0 -67
  346. package/examples/gather-info.ts +0 -71
  347. package/examples/gather-per-question-functions-demo.ts +0 -140
  348. package/examples/joke-agent.ts +0 -34
  349. package/examples/kubernetes-agent.ts +0 -45
  350. package/examples/llm-params.ts +0 -69
  351. package/examples/mcp-agent.ts +0 -84
  352. package/examples/mcp-gateway.ts +0 -35
  353. package/examples/multi-agent.ts +0 -73
  354. package/examples/multi-endpoint.ts +0 -79
  355. package/examples/pom-prompt.ts +0 -71
  356. package/examples/prefab-concierge.ts +0 -47
  357. package/examples/prefab-faq.ts +0 -54
  358. package/examples/prefab-info-gatherer.ts +0 -33
  359. package/examples/prefab-receptionist.ts +0 -36
  360. package/examples/prefab-survey.ts +0 -68
  361. package/examples/record-call.ts +0 -67
  362. package/examples/relay-demo.ts +0 -33
  363. package/examples/room-and-sip.ts +0 -94
  364. package/examples/serverless-lambda.ts +0 -35
  365. package/examples/session-state.ts +0 -83
  366. package/examples/simple-agent.ts +0 -36
  367. package/examples/simple-static.ts +0 -29
  368. package/examples/skills-demo.ts +0 -38
  369. package/examples/step-function-inheritance-demo.ts +0 -124
  370. package/examples/swaig-features.ts +0 -187
  371. package/examples/swml-service-routing.ts +0 -66
  372. package/examples/swml-service.ts +0 -38
  373. package/examples/tap.ts +0 -68
  374. package/examples/verb-methods.ts +0 -45
  375. package/examples/web-search-multi-instance.ts +0 -72
  376. package/examples/web-search.ts +0 -38
  377. package/examples/wikipedia.ts +0 -36
  378. package/livewire/README.md +0 -140
  379. package/livewire/docs/migration-guide.md +0 -228
  380. package/livewire/examples/livewire-basic-agent.ts +0 -74
  381. package/livewire/examples/livewire-handoff.ts +0 -197
  382. package/livewire/examples/livewire-multi-tool.ts +0 -117
  383. package/relay/README.md +0 -70
  384. package/relay/RELAY_IMPLEMENTATION_GUIDE.md +0 -1257
  385. package/relay/docs/call-methods.md +0 -474
  386. package/relay/docs/client-reference.md +0 -142
  387. package/relay/docs/events.md +0 -134
  388. package/relay/docs/getting-started.md +0 -134
  389. package/relay/docs/guide.md +0 -306
  390. package/relay/docs/messaging.md +0 -182
  391. package/relay/examples/relay-inbound.ts +0 -66
  392. package/relay/examples/relay-messaging.ts +0 -71
  393. package/relay/examples/relay-outbound.ts +0 -76
  394. package/rest/README.md +0 -95
  395. package/rest/docs/calling.md +0 -273
  396. package/rest/docs/client-reference.md +0 -107
  397. package/rest/docs/compat.md +0 -204
  398. package/rest/docs/fabric.md +0 -183
  399. package/rest/docs/getting-started.md +0 -110
  400. package/rest/docs/guide.md +0 -351
  401. package/rest/docs/namespaces.md +0 -285
  402. package/rest/examples/rest-10dlc-registration.ts +0 -161
  403. package/rest/examples/rest-calling-ivr-and-ai.ts +0 -102
  404. package/rest/examples/rest-calling-play-and-record.ts +0 -91
  405. package/rest/examples/rest-client.ts +0 -65
  406. package/rest/examples/rest-compat-laml.ts +0 -210
  407. package/rest/examples/rest-datasphere-search.ts +0 -82
  408. package/rest/examples/rest-fabric-conferences-and-routing.ts +0 -144
  409. package/rest/examples/rest-fabric-subscribers-and-sip.ts +0 -108
  410. package/rest/examples/rest-fabric-swml-and-callflows.ts +0 -99
  411. package/rest/examples/rest-manage-resources.ts +0 -65
  412. package/rest/examples/rest-phone-number-management.ts +0 -197
  413. package/rest/examples/rest-queues-mfa-and-recordings.ts +0 -143
  414. package/rest/examples/rest-video-rooms.ts +0 -186
  415. package/src/AgentBase.ts +0 -2598
  416. package/src/AgentServer.ts +0 -442
  417. package/src/AuthHandler.ts +0 -256
  418. package/src/ConfigLoader.ts +0 -447
  419. package/src/ContextBuilder.ts +0 -1181
  420. package/src/DataMap.ts +0 -477
  421. package/src/FunctionResult.ts +0 -903
  422. package/src/Logger.ts +0 -337
  423. package/src/PomBuilder.ts +0 -467
  424. package/src/PromptManager.ts +0 -133
  425. package/src/SWMLHandler.ts +0 -298
  426. package/src/SWMLService.ts +0 -749
  427. package/src/SchemaUtils.ts +0 -361
  428. package/src/ServerlessAdapter.ts +0 -240
  429. package/src/SessionManager.ts +0 -311
  430. package/src/SslConfig.ts +0 -118
  431. package/src/SwaigFunction.ts +0 -276
  432. package/src/SwmlBuilder.ts +0 -283
  433. package/src/SwmlVerbMethods.generated.ts +0 -234
  434. package/src/TypeInference.ts +0 -199
  435. package/src/WebService.ts +0 -641
  436. package/src/cli/agent-loader.ts +0 -166
  437. package/src/cli/mock-data.ts +0 -111
  438. package/src/cli/swaig-test.ts +0 -452
  439. package/src/generateVerbTypes.ts +0 -322
  440. package/src/livewire/index.ts +0 -1252
  441. package/src/prefabs/ConciergeAgent.ts +0 -309
  442. package/src/prefabs/FAQBotAgent.ts +0 -415
  443. package/src/prefabs/InfoGathererAgent.ts +0 -379
  444. package/src/prefabs/ReceptionistAgent.ts +0 -395
  445. package/src/prefabs/SurveyAgent.ts +0 -671
  446. package/src/relay/Action.ts +0 -482
  447. package/src/relay/Call.ts +0 -1270
  448. package/src/relay/Deferred.ts +0 -94
  449. package/src/relay/Message.ts +0 -199
  450. package/src/relay/RelayClient.ts +0 -1185
  451. package/src/relay/RelayError.ts +0 -20
  452. package/src/relay/RelayEvent.ts +0 -944
  453. package/src/relay/index.ts +0 -123
  454. package/src/relay/types.ts +0 -149
  455. package/src/rest/HttpClient.ts +0 -164
  456. package/src/rest/RestError.ts +0 -45
  457. package/src/rest/base/BaseResource.ts +0 -32
  458. package/src/rest/base/CrudResource.ts +0 -98
  459. package/src/rest/base/CrudWithAddresses.ts +0 -37
  460. package/src/rest/namespaces/addresses.ts +0 -64
  461. package/src/rest/namespaces/calling.ts +0 -534
  462. package/src/rest/namespaces/chat.ts +0 -31
  463. package/src/rest/namespaces/compat.ts +0 -812
  464. package/src/rest/namespaces/datasphere.ts +0 -88
  465. package/src/rest/namespaces/fabric.ts +0 -417
  466. package/src/rest/namespaces/imported-numbers.ts +0 -31
  467. package/src/rest/namespaces/logs.ts +0 -151
  468. package/src/rest/namespaces/lookup.ts +0 -38
  469. package/src/rest/namespaces/mfa.ts +0 -61
  470. package/src/rest/namespaces/number-groups.ts +0 -68
  471. package/src/rest/namespaces/phone-numbers.ts +0 -76
  472. package/src/rest/namespaces/project.ts +0 -65
  473. package/src/rest/namespaces/pubsub.ts +0 -31
  474. package/src/rest/namespaces/queues.ts +0 -58
  475. package/src/rest/namespaces/recordings.ts +0 -53
  476. package/src/rest/namespaces/registry.ts +0 -200
  477. package/src/rest/namespaces/short-codes.ts +0 -54
  478. package/src/rest/namespaces/sip-profile.ts +0 -40
  479. package/src/rest/namespaces/verified-callers.ts +0 -46
  480. package/src/rest/namespaces/video.ts +0 -332
  481. package/src/rest/types.ts +0 -61
  482. package/src/skills/SkillBase.ts +0 -582
  483. package/src/skills/SkillManager.ts +0 -419
  484. package/src/skills/SkillRegistry.ts +0 -367
  485. package/src/skills/builtin/api_ninjas_trivia.ts +0 -285
  486. package/src/skills/builtin/ask_claude.ts +0 -246
  487. package/src/skills/builtin/claude_skills.ts +0 -983
  488. package/src/skills/builtin/custom_skills.ts +0 -327
  489. package/src/skills/builtin/datasphere.ts +0 -447
  490. package/src/skills/builtin/datasphere_serverless.ts +0 -347
  491. package/src/skills/builtin/datetime.ts +0 -137
  492. package/src/skills/builtin/google_maps.ts +0 -656
  493. package/src/skills/builtin/info_gatherer.ts +0 -415
  494. package/src/skills/builtin/joke.ts +0 -196
  495. package/src/skills/builtin/math.ts +0 -149
  496. package/src/skills/builtin/mcp_gateway.ts +0 -685
  497. package/src/skills/builtin/native_vector_search.ts +0 -910
  498. package/src/skills/builtin/play_background_file.ts +0 -367
  499. package/src/skills/builtin/spider.ts +0 -874
  500. package/src/skills/builtin/swml_transfer.ts +0 -645
  501. package/src/skills/builtin/weather_api.ts +0 -255
  502. package/src/skills/builtin/web_search.ts +0 -1083
  503. package/src/skills/builtin/wikipedia_search.ts +0 -304
  504. package/src/types.ts +0 -132
  505. package/tests/AgentBase.test.ts +0 -1093
  506. package/tests/AgentServer.test.ts +0 -126
  507. package/tests/AuthHandler.test.ts +0 -133
  508. package/tests/ConfigLoader.test.ts +0 -151
  509. package/tests/ContextBuilder.test.ts +0 -108
  510. package/tests/DataMap.test.ts +0 -367
  511. package/tests/EphemeralSkillCopy.test.ts +0 -107
  512. package/tests/FunctionResult.test.ts +0 -298
  513. package/tests/GracefulShutdown.test.ts +0 -46
  514. package/tests/Logger.test.ts +0 -420
  515. package/tests/PomBuilder.test.ts +0 -228
  516. package/tests/ProxyDetection.test.ts +0 -228
  517. package/tests/SWMLService.test.ts +0 -320
  518. package/tests/SWMLVerbHandler.test.ts +0 -523
  519. package/tests/SchemaUtils.test.ts +0 -106
  520. package/tests/SchemaUtils.verb.test.ts +0 -206
  521. package/tests/SecurityUtils.test.ts +0 -192
  522. package/tests/ServerlessAdapter.test.ts +0 -222
  523. package/tests/SessionManager.test.ts +0 -257
  524. package/tests/SkillBaseFeatures.test.ts +0 -130
  525. package/tests/SkillMultiInstance.test.ts +0 -102
  526. package/tests/SkillParameterSchemas.test.ts +0 -134
  527. package/tests/SkillRegistrySchema.test.ts +0 -84
  528. package/tests/SslConfig.test.ts +0 -97
  529. package/tests/SwmlBuilder.test.ts +0 -400
  530. package/tests/TypeInference.test.ts +0 -165
  531. package/tests/VerbHandlerRegistry.test.ts +0 -128
  532. package/tests/cli/mock-data.test.ts +0 -113
  533. package/tests/cli/swaig-test.test.ts +0 -108
  534. package/tests/examples.test.ts +0 -194
  535. package/tests/fixtures/scrape-parity/README.md +0 -53
  536. package/tests/fixtures/scrape-parity/expected/01_simple_article.json +0 -5
  537. package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +0 -5
  538. package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +0 -5
  539. package/tests/fixtures/scrape-parity/expected/04_bare_body.json +0 -5
  540. package/tests/fixtures/scrape-parity/expected/05_malformed.json +0 -5
  541. package/tests/fixtures/scrape-parity/expected/06_multi_class.json +0 -5
  542. package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +0 -5
  543. package/tests/fixtures/scrape-parity/expected/08_inline_script.json +0 -5
  544. package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +0 -5
  545. package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +0 -5
  546. package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +0 -5
  547. package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +0 -5
  548. package/tests/fixtures/scrape-parity/html/01_simple_article.html +0 -18
  549. package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +0 -18
  550. package/tests/fixtures/scrape-parity/html/03_nested_containers.html +0 -13
  551. package/tests/fixtures/scrape-parity/html/04_bare_body.html +0 -9
  552. package/tests/fixtures/scrape-parity/html/05_malformed.html +0 -11
  553. package/tests/fixtures/scrape-parity/html/06_multi_class.html +0 -18
  554. package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +0 -12
  555. package/tests/fixtures/scrape-parity/html/08_inline_script.html +0 -17
  556. package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +0 -21
  557. package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +0 -10
  558. package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +0 -13
  559. package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +0 -24
  560. package/tests/fixtures/scrape-parity/python_extract.py +0 -109
  561. package/tests/livewire/livewire.test.ts +0 -780
  562. package/tests/mcp.test.ts +0 -221
  563. package/tests/prefabs/prefabs.test.ts +0 -1093
  564. package/tests/relay/Action.test.ts +0 -392
  565. package/tests/relay/Call.test.ts +0 -535
  566. package/tests/relay/Deferred.test.ts +0 -71
  567. package/tests/relay/Message.test.ts +0 -164
  568. package/tests/relay/RelayClient.test.ts +0 -779
  569. package/tests/relay/RelayEvent.test.ts +0 -463
  570. package/tests/relay/helpers.ts +0 -79
  571. package/tests/rest/HttpClient.test.ts +0 -274
  572. package/tests/rest/RestError.test.ts +0 -53
  573. package/tests/rest/calling.test.ts +0 -156
  574. package/tests/rest/client.test.ts +0 -197
  575. package/tests/rest/compat.test.ts +0 -335
  576. package/tests/rest/datasphere.test.ts +0 -71
  577. package/tests/rest/fabric.test.ts +0 -186
  578. package/tests/rest/helpers.ts +0 -95
  579. package/tests/rest/logs.test.ts +0 -68
  580. package/tests/rest/pagination.test.ts +0 -133
  581. package/tests/rest/registry.test.ts +0 -94
  582. package/tests/rest/relay-rest.test.ts +0 -290
  583. package/tests/rest/video.test.ts +0 -173
  584. package/tests/setup.ts +0 -6
  585. package/tests/skills/SkillBase.test.ts +0 -108
  586. package/tests/skills/SkillManager.test.ts +0 -268
  587. package/tests/skills/SkillRegistry.test.ts +0 -176
  588. package/tests/skills/builtin.test.ts +0 -1472
  589. package/tests/skills/claude-skills.test.ts +0 -54
  590. package/tests/skills/custom-skills.test.ts +0 -53
  591. package/tests/skills/datasphere-serverless.test.ts +0 -70
  592. package/tests/skills/datasphere.test.ts +0 -107
  593. package/tests/skills/datetime.test.ts +0 -101
  594. package/tests/skills/google-maps.test.ts +0 -78
  595. package/tests/skills/info-gatherer.test.ts +0 -411
  596. package/tests/skills/joke.test.ts +0 -81
  597. package/tests/skills/math.test.ts +0 -68
  598. package/tests/skills/mcp-gateway.test.ts +0 -101
  599. package/tests/skills/play-background.test.ts +0 -54
  600. package/tests/skills/spider.test.ts +0 -108
  601. package/tests/skills/swml-transfer.test.ts +0 -178
  602. package/tests/skills/trivia.test.ts +0 -54
  603. package/tests/skills/vector-search.test.ts +0 -135
  604. package/tests/skills/weather-api.test.ts +0 -77
  605. package/tests/skills/web-search-parity.test.ts +0 -59
  606. package/tests/skills/web-search.test.ts +0 -103
  607. package/tests/skills/wikipedia.test.ts +0 -63
  608. package/tsconfig.json +0 -18
  609. package/vitest.config.ts +0 -9
  610. /package/{src → dist}/schema.json +0 -0
@@ -0,0 +1,115 @@
1
+ /**
2
+ * Info Gatherer Skill - Guides an AI agent through a sequence of questions,
3
+ * collecting and storing answers in namespaced SWAIG `global_data`.
4
+ *
5
+ * Tier 2 built-in skill with no external dependencies. Direct port of
6
+ * Python's `signalwire.skills.info_gatherer.skill.InfoGathererSkill`
7
+ * (core/skill_base.py usage; skill.py:16-312). Supports multiple instances
8
+ * with different `prefix` values so several question sets can coexist on a
9
+ * single agent (e.g. "intake" and "medical" questionnaires running side by
10
+ * side).
11
+ */
12
+ import { SkillBase } from '../SkillBase.js';
13
+ import type { SkillToolDefinition, SkillPromptSection, SkillConfig, ParameterSchemaEntry } from '../SkillBase.js';
14
+ /**
15
+ * Collects answers to a configurable list of questions, one at a time.
16
+ *
17
+ * Mirrors Python `InfoGathererSkill` exactly: the same required
18
+ * `questions` config, the same `prefix` / `completion_message` options,
19
+ * the same two tools (`start_questions`, `submit_answer`), and the same
20
+ * state shape in `global_data`.
21
+ *
22
+ * @example
23
+ * ```ts
24
+ * agent.addSkill('info_gatherer', {
25
+ * questions: [
26
+ * { key_name: 'name', question_text: 'What is your name?' },
27
+ * { key_name: 'email', question_text: 'Your email?', confirm: true },
28
+ * ],
29
+ * });
30
+ * ```
31
+ */
32
+ export declare class InfoGathererSkill extends SkillBase {
33
+ static SKILL_NAME: string;
34
+ static SKILL_DESCRIPTION: string;
35
+ static SKILL_VERSION: string;
36
+ static REQUIRED_PACKAGES: readonly string[];
37
+ static REQUIRED_ENV_VARS: readonly string[];
38
+ static SUPPORTS_MULTIPLE_INSTANCES: boolean;
39
+ /** List of question definitions populated in `setup()`. */
40
+ private questions;
41
+ /** Derived tool name for the start tool (prefix-aware). */
42
+ private startToolName;
43
+ /** Derived tool name for the submit tool (prefix-aware). */
44
+ private submitToolName;
45
+ /** Message returned once all questions are answered. */
46
+ private completionMessage;
47
+ static getParameterSchema(): Record<string, ParameterSchemaEntry>;
48
+ /**
49
+ * Instance key for the SkillManager. When `prefix` is configured, returns
50
+ * `info_gatherer_<prefix>` to support multi-instance use. Matches Python's
51
+ * `get_instance_key()` (skill.py:81-85).
52
+ */
53
+ getInstanceKey(): string;
54
+ /**
55
+ * Validate the `questions` config, derive tool names (with optional prefix),
56
+ * and cache the completion message.
57
+ *
58
+ * Python parity: skill.py:91-121. Returns `false` (logging an error) when
59
+ * `questions` is missing or fails validation; setup must produce a
60
+ * functional skill or fail closed.
61
+ */
62
+ setup(): Promise<boolean>;
63
+ /**
64
+ * Seed SWAIG `global_data` with the initial question state under this
65
+ * skill's namespace. Mirrors Python `get_global_data()` (skill.py:127-135).
66
+ *
67
+ * Defensive no-op when the skill was not successfully set up (empty
68
+ * `questions`). Python relies on the SkillManager to skip unloaded skills;
69
+ * TS adds this guard so `getGlobalData()` called without a successful
70
+ * `setup()` returns `{}` instead of a malformed state payload.
71
+ */
72
+ getGlobalData(): Record<string, unknown>;
73
+ /**
74
+ * Register the two sequential-flow tools. Mirrors Python
75
+ * `register_tools()` (skill.py:162-184). Returns an empty array when
76
+ * `setup()` did not complete (no questions) so the skill never exposes
77
+ * half-initialized tools.
78
+ */
79
+ getTools(): SkillToolDefinition[];
80
+ /**
81
+ * Handle the `start_questions` tool: read state from global_data and return
82
+ * an instruction for the first question. Mirrors Python
83
+ * `_handle_start_questions` (skill.py:190-208).
84
+ */
85
+ private _handleStartQuestions;
86
+ /**
87
+ * Handle the `submit_answer` tool: validate confirmation, record the answer,
88
+ * advance the index, and either return the next question or the completion
89
+ * message (disabling both tools on completion). Mirrors Python
90
+ * `_handle_submit_answer` (skill.py:210-262).
91
+ */
92
+ private _handleSubmitAnswer;
93
+ /**
94
+ * Generate the per-question instruction returned to the agent. Mirrors
95
+ * Python `_generate_question_instruction` (skill.py:268-297).
96
+ */
97
+ private static _generateQuestionInstruction;
98
+ /**
99
+ * Validate that `questions` is a non-empty array of objects each having
100
+ * `key_name` and `question_text`. Throws on invalid input. Mirrors Python
101
+ * `_validate_questions` (skill.py:299-311).
102
+ */
103
+ private static _validateQuestions;
104
+ /**
105
+ * Prompt section describing the question flow to the agent. Mirrors Python
106
+ * `_get_prompt_sections` (skill.py:141-156).
107
+ */
108
+ protected _getPromptSections(): SkillPromptSection[];
109
+ }
110
+ /**
111
+ * Factory function for creating InfoGathererSkill instances.
112
+ * @param config - Optional skill configuration.
113
+ * @returns A new InfoGathererSkill instance.
114
+ */
115
+ export declare function createSkill(config?: SkillConfig): InfoGathererSkill;
@@ -0,0 +1,328 @@
1
+ /**
2
+ * Info Gatherer Skill - Guides an AI agent through a sequence of questions,
3
+ * collecting and storing answers in namespaced SWAIG `global_data`.
4
+ *
5
+ * Tier 2 built-in skill with no external dependencies. Direct port of
6
+ * Python's `signalwire.skills.info_gatherer.skill.InfoGathererSkill`
7
+ * (core/skill_base.py usage; skill.py:16-312). Supports multiple instances
8
+ * with different `prefix` values so several question sets can coexist on a
9
+ * single agent (e.g. "intake" and "medical" questionnaires running side by
10
+ * side).
11
+ */
12
+ import { SkillBase } from '../SkillBase.js';
13
+ import { FunctionResult } from '../../FunctionResult.js';
14
+ import { getLogger } from '../../Logger.js';
15
+ const log = getLogger('InfoGathererSkill');
16
+ const DEFAULT_COMPLETION_MESSAGE = "Thank you! All questions have been answered. You can now summarize the " +
17
+ "information collected or ask if there's anything else the user would like " +
18
+ 'to discuss.';
19
+ /**
20
+ * Collects answers to a configurable list of questions, one at a time.
21
+ *
22
+ * Mirrors Python `InfoGathererSkill` exactly: the same required
23
+ * `questions` config, the same `prefix` / `completion_message` options,
24
+ * the same two tools (`start_questions`, `submit_answer`), and the same
25
+ * state shape in `global_data`.
26
+ *
27
+ * @example
28
+ * ```ts
29
+ * agent.addSkill('info_gatherer', {
30
+ * questions: [
31
+ * { key_name: 'name', question_text: 'What is your name?' },
32
+ * { key_name: 'email', question_text: 'Your email?', confirm: true },
33
+ * ],
34
+ * });
35
+ * ```
36
+ */
37
+ export class InfoGathererSkill extends SkillBase {
38
+ // Python ground truth: skills/info_gatherer/skill.py:26-31
39
+ static SKILL_NAME = 'info_gatherer';
40
+ static SKILL_DESCRIPTION = 'Gather answers to a configurable list of questions';
41
+ static SKILL_VERSION = '1.0.0';
42
+ static REQUIRED_PACKAGES = [];
43
+ static REQUIRED_ENV_VARS = [];
44
+ static SUPPORTS_MULTIPLE_INSTANCES = true;
45
+ /** List of question definitions populated in `setup()`. */
46
+ questions = [];
47
+ /** Derived tool name for the start tool (prefix-aware). */
48
+ startToolName = 'start_questions';
49
+ /** Derived tool name for the submit tool (prefix-aware). */
50
+ submitToolName = 'submit_answer';
51
+ /** Message returned once all questions are answered. */
52
+ completionMessage = DEFAULT_COMPLETION_MESSAGE;
53
+ static getParameterSchema() {
54
+ return {
55
+ ...super.getParameterSchema(),
56
+ questions: {
57
+ type: 'array',
58
+ description: "List of question objects. Each must have 'key_name' (str) and 'question_text' (str). Optional 'confirm' (bool) asks the agent to confirm the answer before proceeding.",
59
+ required: true,
60
+ items: {
61
+ type: 'object',
62
+ properties: {
63
+ key_name: { type: 'string' },
64
+ question_text: { type: 'string' },
65
+ confirm: { type: 'boolean' },
66
+ prompt_add: { type: 'string' },
67
+ },
68
+ },
69
+ },
70
+ prefix: {
71
+ type: 'string',
72
+ description: "Optional prefix for tool names and namespace. When set, tools are named <prefix>_start_questions / <prefix>_submit_answer and state is stored under 'skill:<prefix>' in global_data.",
73
+ required: false,
74
+ },
75
+ completion_message: {
76
+ type: 'string',
77
+ description: 'Message returned after all questions are answered',
78
+ default: DEFAULT_COMPLETION_MESSAGE,
79
+ required: false,
80
+ },
81
+ };
82
+ }
83
+ /**
84
+ * Instance key for the SkillManager. When `prefix` is configured, returns
85
+ * `info_gatherer_<prefix>` to support multi-instance use. Matches Python's
86
+ * `get_instance_key()` (skill.py:81-85).
87
+ */
88
+ getInstanceKey() {
89
+ const prefix = this.getConfig('prefix', '');
90
+ return prefix ? `info_gatherer_${prefix}` : 'info_gatherer';
91
+ }
92
+ /**
93
+ * Validate the `questions` config, derive tool names (with optional prefix),
94
+ * and cache the completion message.
95
+ *
96
+ * Python parity: skill.py:91-121. Returns `false` (logging an error) when
97
+ * `questions` is missing or fails validation; setup must produce a
98
+ * functional skill or fail closed.
99
+ */
100
+ async setup() {
101
+ const questions = this.getConfig('questions', undefined);
102
+ if (questions === undefined || questions === null) {
103
+ log.error("'questions' parameter is required");
104
+ return false;
105
+ }
106
+ try {
107
+ InfoGathererSkill._validateQuestions(questions);
108
+ }
109
+ catch (err) {
110
+ log.error(err instanceof Error ? err.message : String(err));
111
+ return false;
112
+ }
113
+ this.questions = questions;
114
+ const prefix = this.getConfig('prefix', '');
115
+ if (prefix) {
116
+ this.startToolName = `${prefix}_start_questions`;
117
+ this.submitToolName = `${prefix}_submit_answer`;
118
+ }
119
+ else {
120
+ this.startToolName = 'start_questions';
121
+ this.submitToolName = 'submit_answer';
122
+ }
123
+ this.completionMessage = this.getConfig('completion_message', DEFAULT_COMPLETION_MESSAGE);
124
+ return true;
125
+ }
126
+ /**
127
+ * Seed SWAIG `global_data` with the initial question state under this
128
+ * skill's namespace. Mirrors Python `get_global_data()` (skill.py:127-135).
129
+ *
130
+ * Defensive no-op when the skill was not successfully set up (empty
131
+ * `questions`). Python relies on the SkillManager to skip unloaded skills;
132
+ * TS adds this guard so `getGlobalData()` called without a successful
133
+ * `setup()` returns `{}` instead of a malformed state payload.
134
+ */
135
+ getGlobalData() {
136
+ if (this.questions.length === 0) {
137
+ return {};
138
+ }
139
+ return {
140
+ [this.getSkillNamespace()]: {
141
+ questions: this.questions,
142
+ question_index: 0,
143
+ answers: [],
144
+ },
145
+ };
146
+ }
147
+ /**
148
+ * Register the two sequential-flow tools. Mirrors Python
149
+ * `register_tools()` (skill.py:162-184). Returns an empty array when
150
+ * `setup()` did not complete (no questions) so the skill never exposes
151
+ * half-initialized tools.
152
+ */
153
+ getTools() {
154
+ if (this.questions.length === 0) {
155
+ return [];
156
+ }
157
+ return [
158
+ {
159
+ name: this.startToolName,
160
+ description: 'Start the question sequence with the first question',
161
+ parameters: {},
162
+ handler: (args, rawData) => this._handleStartQuestions(args, rawData),
163
+ },
164
+ {
165
+ name: this.submitToolName,
166
+ description: 'Submit an answer to the current question and move to the next one',
167
+ parameters: {
168
+ answer: {
169
+ type: 'string',
170
+ description: "The user's answer to the current question",
171
+ },
172
+ confirmed_by_user: {
173
+ type: 'boolean',
174
+ description: "Only set to true when the user has explicitly said 'yes' or confirmed the answer is correct in their own words in their most recent response. Never set this to true on your own.",
175
+ },
176
+ },
177
+ handler: (args, rawData) => this._handleSubmitAnswer(args, rawData),
178
+ },
179
+ ];
180
+ }
181
+ /**
182
+ * Handle the `start_questions` tool: read state from global_data and return
183
+ * an instruction for the first question. Mirrors Python
184
+ * `_handle_start_questions` (skill.py:190-208).
185
+ */
186
+ _handleStartQuestions(_args, rawData) {
187
+ const state = this.getSkillData(rawData);
188
+ const questions = state['questions'] ?? [];
189
+ const questionIndex = state['question_index'] ?? 0;
190
+ if (questions.length === 0 || questionIndex >= questions.length) {
191
+ return new FunctionResult("I don't have any questions to ask.");
192
+ }
193
+ const current = questions[questionIndex];
194
+ const instruction = InfoGathererSkill._generateQuestionInstruction(current.question_text ?? '', current.confirm ?? false, true, current.prompt_add ?? '', this.submitToolName, questionIndex + 1, questions.length);
195
+ return new FunctionResult(instruction);
196
+ }
197
+ /**
198
+ * Handle the `submit_answer` tool: validate confirmation, record the answer,
199
+ * advance the index, and either return the next question or the completion
200
+ * message (disabling both tools on completion). Mirrors Python
201
+ * `_handle_submit_answer` (skill.py:210-262).
202
+ */
203
+ _handleSubmitAnswer(args, rawData) {
204
+ const answer = args['answer'] ?? '';
205
+ const confirmed = args['confirmed_by_user'] ?? false;
206
+ const state = this.getSkillData(rawData);
207
+ const questions = state['questions'] ?? [];
208
+ const questionIndex = state['question_index'] ?? 0;
209
+ const answers = state['answers'] ?? [];
210
+ if (questionIndex >= questions.length) {
211
+ return new FunctionResult('All questions have already been answered.');
212
+ }
213
+ const current = questions[questionIndex];
214
+ const keyName = current.key_name ?? '';
215
+ // Enforce confirmation: reject the submission if the question requires
216
+ // confirmation but the confirmed flag was not set to true.
217
+ if ((current.confirm ?? false) && !confirmed) {
218
+ return new FunctionResult(`Before submitting, you must read the answer "${answer}" back to the user ` +
219
+ `and ask them to confirm it is correct. Then call this function again with ` +
220
+ `confirmed set to true. If the user says it is wrong, ask the question again.`);
221
+ }
222
+ const newAnswers = [...answers, { key_name: keyName, answer }];
223
+ const newIndex = questionIndex + 1;
224
+ let result;
225
+ if (newIndex < questions.length) {
226
+ const nextQ = questions[newIndex];
227
+ const instruction = InfoGathererSkill._generateQuestionInstruction(nextQ.question_text ?? '', nextQ.confirm ?? false, false, nextQ.prompt_add ?? '', this.submitToolName, newIndex + 1, questions.length);
228
+ result = new FunctionResult(instruction);
229
+ }
230
+ else {
231
+ result = new FunctionResult(this.completionMessage);
232
+ result.toggleFunctions([
233
+ { function: this.startToolName, active: false },
234
+ { function: this.submitToolName, active: false },
235
+ ]);
236
+ }
237
+ const newState = {
238
+ questions,
239
+ question_index: newIndex,
240
+ answers: newAnswers,
241
+ };
242
+ this.updateSkillData(result, newState);
243
+ return result;
244
+ }
245
+ /**
246
+ * Generate the per-question instruction returned to the agent. Mirrors
247
+ * Python `_generate_question_instruction` (skill.py:268-297).
248
+ */
249
+ static _generateQuestionInstruction(questionText, needsConfirmation, isFirstQuestion, promptAdd, submitToolName, questionNumber, totalQuestions) {
250
+ let instruction;
251
+ if (isFirstQuestion) {
252
+ instruction =
253
+ `Ask each question one at a time, wait for the user's answer, ` +
254
+ `then call ${submitToolName} with their answer. Do not reuse previous answers.\n\n` +
255
+ `[Question ${questionNumber} of ${totalQuestions}]: "${questionText}"`;
256
+ }
257
+ else {
258
+ instruction = `Previous answer saved. [Question ${questionNumber} of ${totalQuestions}]: "${questionText}"`;
259
+ }
260
+ if (promptAdd) {
261
+ instruction += `\nNote: ${promptAdd}`;
262
+ }
263
+ if (needsConfirmation) {
264
+ instruction +=
265
+ `\nThis question requires confirmation. Read the answer back to the user ` +
266
+ `and ask them to confirm it is correct before calling ${submitToolName}. ` +
267
+ `If they say it is wrong, ask the question again.`;
268
+ }
269
+ return instruction;
270
+ }
271
+ /**
272
+ * Validate that `questions` is a non-empty array of objects each having
273
+ * `key_name` and `question_text`. Throws on invalid input. Mirrors Python
274
+ * `_validate_questions` (skill.py:299-311).
275
+ */
276
+ static _validateQuestions(questions) {
277
+ // Python order (skill.py:301-304): emptiness / falsy check BEFORE type
278
+ // check. JS `!questions` is true for null/undefined/0/""/false but NOT
279
+ // for `[]`, so we also handle the empty-array case explicitly.
280
+ if (!questions || (Array.isArray(questions) && questions.length === 0)) {
281
+ throw new Error('At least one question is required');
282
+ }
283
+ if (!Array.isArray(questions)) {
284
+ throw new Error('Questions must be a list');
285
+ }
286
+ for (let i = 0; i < questions.length; i++) {
287
+ const q = questions[i];
288
+ if (!q || typeof q !== 'object' || Array.isArray(q)) {
289
+ throw new Error(`Question ${i + 1} must be a dictionary`);
290
+ }
291
+ const obj = q;
292
+ if (!('key_name' in obj)) {
293
+ throw new Error(`Question ${i + 1} is missing 'key_name' field`);
294
+ }
295
+ if (!('question_text' in obj)) {
296
+ throw new Error(`Question ${i + 1} is missing 'question_text' field`);
297
+ }
298
+ }
299
+ }
300
+ /**
301
+ * Prompt section describing the question flow to the agent. Mirrors Python
302
+ * `_get_prompt_sections` (skill.py:141-156).
303
+ */
304
+ _getPromptSections() {
305
+ return [
306
+ {
307
+ title: `Info Gatherer (${this.getInstanceKey()})`,
308
+ body: `You need to gather answers to a series of questions from the user. ` +
309
+ `Start by introducing yourself and asking the user if they are ready ` +
310
+ `to answer some questions. Once the user confirms they are ready, ` +
311
+ `call the ${this.startToolName} function to get the first question. ` +
312
+ `Ask the user that question, wait for their response, then call ` +
313
+ `${this.submitToolName} with the answer they gave you. ` +
314
+ `Each call to ${this.submitToolName} will return the next question ` +
315
+ `to ask. Repeat this process until all questions are complete.`,
316
+ },
317
+ ];
318
+ }
319
+ }
320
+ /**
321
+ * Factory function for creating InfoGathererSkill instances.
322
+ * @param config - Optional skill configuration.
323
+ * @returns A new InfoGathererSkill instance.
324
+ */
325
+ export function createSkill(config) {
326
+ return new InfoGathererSkill(config);
327
+ }
328
+ //# sourceMappingURL=info_gatherer.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"info_gatherer.js","sourceRoot":"","sources":["../../../src/skills/builtin/info_gatherer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;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,mBAAmB,CAAC,CAAC;AAE3C,MAAM,0BAA0B,GAC9B,yEAAyE;IACzE,4EAA4E;IAC5E,aAAa,CAAC;AAchB;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,OAAO,iBAAkB,SAAQ,SAAS;IAC9C,2DAA2D;IAC3D,MAAM,CAAU,UAAU,GAAG,eAAe,CAAC;IAC7C,MAAM,CAAU,iBAAiB,GAAG,oDAAoD,CAAC;IACzF,MAAM,CAAU,aAAa,GAAG,OAAO,CAAC;IACxC,MAAM,CAAU,iBAAiB,GAAsB,EAAE,CAAC;IAC1D,MAAM,CAAU,iBAAiB,GAAsB,EAAE,CAAC;IAC1D,MAAM,CAAU,2BAA2B,GAAG,IAAI,CAAC;IAEnD,2DAA2D;IACnD,SAAS,GAAyB,EAAE,CAAC;IAC7C,2DAA2D;IACnD,aAAa,GAAW,iBAAiB,CAAC;IAClD,4DAA4D;IACpD,cAAc,GAAW,eAAe,CAAC;IACjD,wDAAwD;IAChD,iBAAiB,GAAW,0BAA0B,CAAC;IAE/D,MAAM,CAAU,kBAAkB;QAChC,OAAO;YACL,GAAG,KAAK,CAAC,kBAAkB,EAAE;YAC7B,SAAS,EAAE;gBACT,IAAI,EAAE,OAAO;gBACb,WAAW,EACT,wKAAwK;gBAC1K,QAAQ,EAAE,IAAI;gBACd,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,UAAU,EAAE;wBACV,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;wBAC5B,aAAa,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;wBACjC,OAAO,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;wBAC5B,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;qBAC/B;iBACF;aACF;YACD,MAAM,EAAE;gBACN,IAAI,EAAE,QAAQ;gBACd,WAAW,EACT,sLAAsL;gBACxL,QAAQ,EAAE,KAAK;aAChB;YACD,kBAAkB,EAAE;gBAClB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,mDAAmD;gBAChE,OAAO,EAAE,0BAA0B;gBACnC,QAAQ,EAAE,KAAK;aAChB;SACF,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACM,cAAc;QACrB,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAS,QAAQ,EAAE,EAAE,CAAC,CAAC;QACpD,OAAO,MAAM,CAAC,CAAC,CAAC,iBAAiB,MAAM,EAAE,CAAC,CAAC,CAAC,eAAe,CAAC;IAC9D,CAAC;IAED;;;;;;;OAOG;IACM,KAAK,CAAC,KAAK;QAClB,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAU,WAAW,EAAE,SAAS,CAAC,CAAC;QAClE,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;YAClD,GAAG,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;YAC/C,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,CAAC;YACH,iBAAiB,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;QAClD,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,GAAG,CAAC,KAAK,CAAC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;YAC5D,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,CAAC,SAAS,GAAG,SAAiC,CAAC;QAEnD,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAS,QAAQ,EAAE,EAAE,CAAC,CAAC;QACpD,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,CAAC,aAAa,GAAG,GAAG,MAAM,kBAAkB,CAAC;YACjD,IAAI,CAAC,cAAc,GAAG,GAAG,MAAM,gBAAgB,CAAC;QAClD,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,aAAa,GAAG,iBAAiB,CAAC;YACvC,IAAI,CAAC,cAAc,GAAG,eAAe,CAAC;QACxC,CAAC;QAED,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,SAAS,CACrC,oBAAoB,EACpB,0BAA0B,CAC3B,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACM,aAAa;QACpB,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAChC,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,OAAO;YACL,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,EAAE;gBAC1B,SAAS,EAAE,IAAI,CAAC,SAAS;gBACzB,cAAc,EAAE,CAAC;gBACjB,OAAO,EAAE,EAAE;aACZ;SACF,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACM,QAAQ;QACf,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAChC,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,OAAO;YACL;gBACE,IAAI,EAAE,IAAI,CAAC,aAAa;gBACxB,WAAW,EAAE,qDAAqD;gBAClE,UAAU,EAAE,EAAE;gBACd,OAAO,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,IAAI,EAAE,OAAO,CAAC;aACtE;YACD;gBACE,IAAI,EAAE,IAAI,CAAC,cAAc;gBACzB,WAAW,EACT,mEAAmE;gBACrE,UAAU,EAAE;oBACV,MAAM,EAAE;wBACN,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,2CAA2C;qBACzD;oBACD,iBAAiB,EAAE;wBACjB,IAAI,EAAE,SAAS;wBACf,WAAW,EACT,mLAAmL;qBACtL;iBACF;gBACD,OAAO,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,mBAAmB,CAAC,IAAI,EAAE,OAAO,CAAC;aACpE;SACF,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACK,qBAAqB,CAC3B,KAA8B,EAC9B,OAAgC;QAEhC,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QACzC,MAAM,SAAS,GAAI,KAAK,CAAC,WAAW,CAAsC,IAAI,EAAE,CAAC;QACjF,MAAM,aAAa,GAAI,KAAK,CAAC,gBAAgB,CAAwB,IAAI,CAAC,CAAC;QAE3E,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,IAAI,aAAa,IAAI,SAAS,CAAC,MAAM,EAAE,CAAC;YAChE,OAAO,IAAI,cAAc,CAAC,oCAAoC,CAAC,CAAC;QAClE,CAAC;QAED,MAAM,OAAO,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC;QACzC,MAAM,WAAW,GAAG,iBAAiB,CAAC,4BAA4B,CAChE,OAAO,CAAC,aAAa,IAAI,EAAE,EAC3B,OAAO,CAAC,OAAO,IAAI,KAAK,EACxB,IAAI,EACJ,OAAO,CAAC,UAAU,IAAI,EAAE,EACxB,IAAI,CAAC,cAAc,EACnB,aAAa,GAAG,CAAC,EACjB,SAAS,CAAC,MAAM,CACjB,CAAC;QACF,OAAO,IAAI,cAAc,CAAC,WAAW,CAAC,CAAC;IACzC,CAAC;IAED;;;;;OAKG;IACK,mBAAmB,CACzB,IAA6B,EAC7B,OAAgC;QAEhC,MAAM,MAAM,GAAI,IAAI,CAAC,QAAQ,CAAwB,IAAI,EAAE,CAAC;QAC5D,MAAM,SAAS,GAAI,IAAI,CAAC,mBAAmB,CAAyB,IAAI,KAAK,CAAC;QAC9E,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAEzC,MAAM,SAAS,GAAI,KAAK,CAAC,WAAW,CAAsC,IAAI,EAAE,CAAC;QACjF,MAAM,aAAa,GAAI,KAAK,CAAC,gBAAgB,CAAwB,IAAI,CAAC,CAAC;QAC3E,MAAM,OAAO,GAAI,KAAK,CAAC,SAAS,CAA6D,IAAI,EAAE,CAAC;QAEpG,IAAI,aAAa,IAAI,SAAS,CAAC,MAAM,EAAE,CAAC;YACtC,OAAO,IAAI,cAAc,CAAC,2CAA2C,CAAC,CAAC;QACzE,CAAC;QAED,MAAM,OAAO,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC;QACzC,MAAM,OAAO,GAAG,OAAO,CAAC,QAAQ,IAAI,EAAE,CAAC;QAEvC,uEAAuE;QACvE,2DAA2D;QAC3D,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YAC7C,OAAO,IAAI,cAAc,CACvB,gDAAgD,MAAM,qBAAqB;gBACzE,4EAA4E;gBAC5E,8EAA8E,CACjF,CAAC;QACJ,CAAC;QAED,MAAM,UAAU,GAAG,CAAC,GAAG,OAAO,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;QAC/D,MAAM,QAAQ,GAAG,aAAa,GAAG,CAAC,CAAC;QAEnC,IAAI,MAAsB,CAAC;QAE3B,IAAI,QAAQ,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC;YAChC,MAAM,KAAK,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;YAClC,MAAM,WAAW,GAAG,iBAAiB,CAAC,4BAA4B,CAChE,KAAK,CAAC,aAAa,IAAI,EAAE,EACzB,KAAK,CAAC,OAAO,IAAI,KAAK,EACtB,KAAK,EACL,KAAK,CAAC,UAAU,IAAI,EAAE,EACtB,IAAI,CAAC,cAAc,EACnB,QAAQ,GAAG,CAAC,EACZ,SAAS,CAAC,MAAM,CACjB,CAAC;YACF,MAAM,GAAG,IAAI,cAAc,CAAC,WAAW,CAAC,CAAC;QAC3C,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;YACpD,MAAM,CAAC,eAAe,CAAC;gBACrB,EAAE,QAAQ,EAAE,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,KAAK,EAAE;gBAC/C,EAAE,QAAQ,EAAE,IAAI,CAAC,cAAc,EAAE,MAAM,EAAE,KAAK,EAAE;aACjD,CAAC,CAAC;QACL,CAAC;QAED,MAAM,QAAQ,GAAG;YACf,SAAS;YACT,cAAc,EAAE,QAAQ;YACxB,OAAO,EAAE,UAAU;SACpB,CAAC;QACF,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QACvC,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,4BAA4B,CACzC,YAAoB,EACpB,iBAA0B,EAC1B,eAAwB,EACxB,SAAiB,EACjB,cAAsB,EACtB,cAAsB,EACtB,cAAsB;QAEtB,IAAI,WAAmB,CAAC;QACxB,IAAI,eAAe,EAAE,CAAC;YACpB,WAAW;gBACT,+DAA+D;oBAC/D,aAAa,cAAc,wDAAwD;oBACnF,aAAa,cAAc,OAAO,cAAc,OAAO,YAAY,GAAG,CAAC;QAC3E,CAAC;aAAM,CAAC;YACN,WAAW,GAAG,oCAAoC,cAAc,OAAO,cAAc,OAAO,YAAY,GAAG,CAAC;QAC9G,CAAC;QAED,IAAI,SAAS,EAAE,CAAC;YACd,WAAW,IAAI,WAAW,SAAS,EAAE,CAAC;QACxC,CAAC;QAED,IAAI,iBAAiB,EAAE,CAAC;YACtB,WAAW;gBACT,0EAA0E;oBAC1E,wDAAwD,cAAc,IAAI;oBAC1E,kDAAkD,CAAC;QACvD,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACK,MAAM,CAAC,kBAAkB,CAAC,SAAkB;QAClD,uEAAuE;QACvE,uEAAuE;QACvE,+DAA+D;QAC/D,IAAI,CAAC,SAAS,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC;YACvE,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACvD,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC9C,CAAC;QACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC1C,MAAM,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;YACvB,IAAI,CAAC,CAAC,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;gBACpD,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;YAC5D,CAAC;YACD,MAAM,GAAG,GAAG,CAA4B,CAAC;YACzC,IAAI,CAAC,CAAC,UAAU,IAAI,GAAG,CAAC,EAAE,CAAC;gBACzB,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAC;YACnE,CAAC;YACD,IAAI,CAAC,CAAC,eAAe,IAAI,GAAG,CAAC,EAAE,CAAC;gBAC9B,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAC;YACxE,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;OAGG;IACgB,kBAAkB;QACnC,OAAO;YACL;gBACE,KAAK,EAAE,kBAAkB,IAAI,CAAC,cAAc,EAAE,GAAG;gBACjD,IAAI,EACF,qEAAqE;oBACrE,sEAAsE;oBACtE,mEAAmE;oBACnE,YAAY,IAAI,CAAC,aAAa,uCAAuC;oBACrE,iEAAiE;oBACjE,GAAG,IAAI,CAAC,cAAc,kCAAkC;oBACxD,gBAAgB,IAAI,CAAC,cAAc,iCAAiC;oBACpE,+DAA+D;aAClE;SACF,CAAC;IACJ,CAAC;;AAGH;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,MAAoB;IAC9C,OAAO,IAAI,iBAAiB,CAAC,MAAM,CAAC,CAAC;AACvC,CAAC"}
@@ -0,0 +1,41 @@
1
+ /**
2
+ * Joke Skill - Tells random jokes from a built-in collection.
3
+ *
4
+ * Tier 1 built-in skill: no external dependencies required.
5
+ * Contains a curated set of jokes across multiple categories.
6
+ */
7
+ import { SkillBase } from '../SkillBase.js';
8
+ import type { SkillToolDefinition, SkillPromptSection, SkillConfig, ParameterSchemaEntry } from '../SkillBase.js';
9
+ /**
10
+ * Tells random jokes from a curated built-in collection.
11
+ *
12
+ * Tier 1 built-in skill with no external dependencies. Includes general,
13
+ * programming, and dad joke categories.
14
+ *
15
+ * @example
16
+ * ```ts
17
+ * agent.addSkill('joke');
18
+ * ```
19
+ */
20
+ export declare class JokeSkill extends SkillBase {
21
+ static SKILL_NAME: string;
22
+ static SKILL_DESCRIPTION: string;
23
+ static SKILL_VERSION: string;
24
+ static REQUIRED_PACKAGES: readonly string[];
25
+ static REQUIRED_ENV_VARS: readonly string[];
26
+ static getParameterSchema(): Record<string, ParameterSchemaEntry>;
27
+ /**
28
+ * Signal to the agent prompt that the joke skill is active. Python
29
+ * parity: `get_global_data` returns `{"joke_skill_enabled": true}`.
30
+ */
31
+ getGlobalData(): Record<string, unknown>;
32
+ /** @returns A single joke tool (configurable name) that returns a random joke with optional category filter. */
33
+ getTools(): SkillToolDefinition[];
34
+ protected _getPromptSections(): SkillPromptSection[];
35
+ }
36
+ /**
37
+ * Factory function for creating JokeSkill instances.
38
+ * @param config - Optional skill configuration.
39
+ * @returns A new JokeSkill instance.
40
+ */
41
+ export declare function createSkill(config?: SkillConfig): JokeSkill;
@@ -0,0 +1,156 @@
1
+ /**
2
+ * Joke Skill - Tells random jokes from a built-in collection.
3
+ *
4
+ * Tier 1 built-in skill: no external dependencies required.
5
+ * Contains a curated set of jokes across multiple categories.
6
+ */
7
+ import { SkillBase } from '../SkillBase.js';
8
+ import { FunctionResult } from '../../FunctionResult.js';
9
+ const JOKES = [
10
+ // General
11
+ {
12
+ category: 'general',
13
+ setup: 'Why did the scarecrow win an award?',
14
+ punchline: 'Because he was outstanding in his field.',
15
+ },
16
+ {
17
+ category: 'general',
18
+ setup: 'What do you call a fake noodle?',
19
+ punchline: 'An impasta.',
20
+ },
21
+ {
22
+ category: 'general',
23
+ setup: 'Why did the bicycle fall over?',
24
+ punchline: 'Because it was two-tired.',
25
+ },
26
+ // Programming
27
+ {
28
+ category: 'programming',
29
+ setup: 'Why do programmers prefer dark mode?',
30
+ punchline: 'Because light attracts bugs.',
31
+ },
32
+ {
33
+ category: 'programming',
34
+ setup: 'What is a programmer\'s favorite hangout place?',
35
+ punchline: 'Foo Bar.',
36
+ },
37
+ {
38
+ category: 'programming',
39
+ setup: 'Why do Java developers wear glasses?',
40
+ punchline: 'Because they can\'t C#.',
41
+ },
42
+ {
43
+ category: 'programming',
44
+ setup: 'How many programmers does it take to change a light bulb?',
45
+ punchline: 'None. That\'s a hardware problem.',
46
+ },
47
+ // Dad jokes
48
+ {
49
+ category: 'dad',
50
+ setup: 'I\'m reading a book about anti-gravity.',
51
+ punchline: 'It\'s impossible to put down.',
52
+ },
53
+ {
54
+ category: 'dad',
55
+ setup: 'What did the ocean say to the beach?',
56
+ punchline: 'Nothing, it just waved.',
57
+ },
58
+ {
59
+ category: 'dad',
60
+ setup: 'Why don\'t skeletons fight each other?',
61
+ punchline: 'They don\'t have the guts.',
62
+ },
63
+ ];
64
+ const VALID_CATEGORIES = ['general', 'programming', 'dad'];
65
+ /**
66
+ * Tells random jokes from a curated built-in collection.
67
+ *
68
+ * Tier 1 built-in skill with no external dependencies. Includes general,
69
+ * programming, and dad joke categories.
70
+ *
71
+ * @example
72
+ * ```ts
73
+ * agent.addSkill('joke');
74
+ * ```
75
+ */
76
+ export class JokeSkill extends SkillBase {
77
+ // Python ground truth: skills/joke/skill.py
78
+ static SKILL_NAME = 'joke';
79
+ static SKILL_DESCRIPTION = 'Tell jokes using the API Ninjas joke API';
80
+ static SKILL_VERSION = '1.0.0';
81
+ static REQUIRED_PACKAGES = [];
82
+ static REQUIRED_ENV_VARS = [];
83
+ static getParameterSchema() {
84
+ return {
85
+ ...super.getParameterSchema(),
86
+ tool_name: {
87
+ type: 'string',
88
+ description: 'Custom name for the joke tool',
89
+ default: 'tell_joke',
90
+ },
91
+ };
92
+ }
93
+ /**
94
+ * Signal to the agent prompt that the joke skill is active. Python
95
+ * parity: `get_global_data` returns `{"joke_skill_enabled": true}`.
96
+ */
97
+ getGlobalData() {
98
+ return { joke_skill_enabled: true };
99
+ }
100
+ /** @returns A single joke tool (configurable name) that returns a random joke with optional category filter. */
101
+ getTools() {
102
+ const toolName = this.getConfig('tool_name', 'tell_joke');
103
+ return [
104
+ {
105
+ name: toolName,
106
+ description: 'Tell a random joke. Optionally specify a category to get a joke from that category.',
107
+ parameters: {
108
+ category: {
109
+ type: 'string',
110
+ description: 'Joke category: "general", "programming", or "dad". If not specified, a random joke from any category is returned.',
111
+ },
112
+ },
113
+ handler: (args) => {
114
+ const category = args.category;
115
+ let pool = JOKES;
116
+ if (category && typeof category === 'string') {
117
+ const normalized = category.toLowerCase().trim();
118
+ if (!VALID_CATEGORIES.includes(normalized)) {
119
+ return new FunctionResult(`Unknown joke category "${category}". Available categories are: ${VALID_CATEGORIES.join(', ')}.`);
120
+ }
121
+ pool = JOKES.filter((j) => j.category === normalized);
122
+ }
123
+ if (pool.length === 0) {
124
+ return new FunctionResult('Sorry, I could not find any jokes for that category.');
125
+ }
126
+ const joke = pool[Math.floor(Math.random() * pool.length)];
127
+ return new FunctionResult(`${joke.setup} ... ${joke.punchline}`);
128
+ },
129
+ },
130
+ ];
131
+ }
132
+ _getPromptSections() {
133
+ const toolName = this.getConfig('tool_name', 'tell_joke');
134
+ return [
135
+ {
136
+ title: 'Jokes',
137
+ body: 'You have the ability to tell jokes to lighten the mood.',
138
+ bullets: [
139
+ `Use the ${toolName} tool when a user asks for a joke or when humor is appropriate.`,
140
+ 'Available joke categories: general, programming, and dad jokes.',
141
+ 'If the user asks for a specific type of joke, pass the category parameter.',
142
+ 'Deliver the joke naturally: say the setup, pause briefly, then deliver the punchline.',
143
+ ],
144
+ },
145
+ ];
146
+ }
147
+ }
148
+ /**
149
+ * Factory function for creating JokeSkill instances.
150
+ * @param config - Optional skill configuration.
151
+ * @returns A new JokeSkill instance.
152
+ */
153
+ export function createSkill(config) {
154
+ return new JokeSkill(config);
155
+ }
156
+ //# sourceMappingURL=joke.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"joke.js","sourceRoot":"","sources":["../../../src/skills/builtin/joke.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAO5C,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAYzD,MAAM,KAAK,GAAW;IACpB,UAAU;IACV;QACE,QAAQ,EAAE,SAAS;QACnB,KAAK,EAAE,qCAAqC;QAC5C,SAAS,EAAE,0CAA0C;KACtD;IACD;QACE,QAAQ,EAAE,SAAS;QACnB,KAAK,EAAE,iCAAiC;QACxC,SAAS,EAAE,aAAa;KACzB;IACD;QACE,QAAQ,EAAE,SAAS;QACnB,KAAK,EAAE,gCAAgC;QACvC,SAAS,EAAE,2BAA2B;KACvC;IACD,cAAc;IACd;QACE,QAAQ,EAAE,aAAa;QACvB,KAAK,EAAE,sCAAsC;QAC7C,SAAS,EAAE,8BAA8B;KAC1C;IACD;QACE,QAAQ,EAAE,aAAa;QACvB,KAAK,EAAE,iDAAiD;QACxD,SAAS,EAAE,UAAU;KACtB;IACD;QACE,QAAQ,EAAE,aAAa;QACvB,KAAK,EAAE,sCAAsC;QAC7C,SAAS,EAAE,yBAAyB;KACrC;IACD;QACE,QAAQ,EAAE,aAAa;QACvB,KAAK,EAAE,2DAA2D;QAClE,SAAS,EAAE,mCAAmC;KAC/C;IACD,YAAY;IACZ;QACE,QAAQ,EAAE,KAAK;QACf,KAAK,EAAE,yCAAyC;QAChD,SAAS,EAAE,+BAA+B;KAC3C;IACD;QACE,QAAQ,EAAE,KAAK;QACf,KAAK,EAAE,sCAAsC;QAC7C,SAAS,EAAE,yBAAyB;KACrC;IACD;QACE,QAAQ,EAAE,KAAK;QACf,KAAK,EAAE,wCAAwC;QAC/C,SAAS,EAAE,4BAA4B;KACxC;CACF,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,SAAS,EAAE,aAAa,EAAE,KAAK,CAAC,CAAC;AAE3D;;;;;;;;;;GAUG;AACH,MAAM,OAAO,SAAU,SAAQ,SAAS;IACtC,4CAA4C;IAC5C,MAAM,CAAU,UAAU,GAAG,MAAM,CAAC;IACpC,MAAM,CAAU,iBAAiB,GAAG,0CAA0C,CAAC;IAC/E,MAAM,CAAU,aAAa,GAAG,OAAO,CAAC;IACxC,MAAM,CAAU,iBAAiB,GAAsB,EAAE,CAAC;IAC1D,MAAM,CAAU,iBAAiB,GAAsB,EAAE,CAAC;IAE1D,MAAM,CAAU,kBAAkB;QAChC,OAAO;YACL,GAAG,KAAK,CAAC,kBAAkB,EAAE;YAC7B,SAAS,EAAE;gBACT,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,+BAA+B;gBAC5C,OAAO,EAAE,WAAW;aACrB;SACF,CAAC;IACJ,CAAC;IAED;;;OAGG;IACM,aAAa;QACpB,OAAO,EAAE,kBAAkB,EAAE,IAAI,EAAE,CAAC;IACtC,CAAC;IAED,gHAAgH;IAChH,QAAQ;QACN,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAS,WAAW,EAAE,WAAW,CAAC,CAAC;QAElE,OAAO;YACL;gBACE,IAAI,EAAE,QAAQ;gBACd,WAAW,EACT,qFAAqF;gBACvF,UAAU,EAAE;oBACV,QAAQ,EAAE;wBACR,IAAI,EAAE,QAAQ;wBACd,WAAW,EACT,mHAAmH;qBACtH;iBACF;gBACD,OAAO,EAAE,CAAC,IAA6B,EAAE,EAAE;oBACzC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAA8B,CAAC;oBAErD,IAAI,IAAI,GAAG,KAAK,CAAC;oBAEjB,IAAI,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;wBAC7C,MAAM,UAAU,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC;wBAEjD,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;4BAC3C,OAAO,IAAI,cAAc,CACvB,0BAA0B,QAAQ,gCAAgC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CACjG,CAAC;wBACJ,CAAC;wBAED,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,UAAU,CAAC,CAAC;oBACxD,CAAC;oBAED,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;wBACtB,OAAO,IAAI,cAAc,CACvB,sDAAsD,CACvD,CAAC;oBACJ,CAAC;oBAED,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,CAAE,CAAC;oBAE5D,OAAO,IAAI,cAAc,CACvB,GAAG,IAAI,CAAC,KAAK,QAAQ,IAAI,CAAC,SAAS,EAAE,CACtC,CAAC;gBACJ,CAAC;aACF;SACF,CAAC;IACJ,CAAC;IAEkB,kBAAkB;QACnC,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAS,WAAW,EAAE,WAAW,CAAC,CAAC;QAClE,OAAO;YACL;gBACE,KAAK,EAAE,OAAO;gBACd,IAAI,EAAE,yDAAyD;gBAC/D,OAAO,EAAE;oBACP,WAAW,QAAQ,iEAAiE;oBACpF,iEAAiE;oBACjE,4EAA4E;oBAC5E,uFAAuF;iBACxF;aACF;SACF,CAAC;IACJ,CAAC;;AAGH;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,MAAoB;IAC9C,OAAO,IAAI,SAAS,CAAC,MAAM,CAAC,CAAC;AAC/B,CAAC"}