@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,59 @@
1
+ /**
2
+ * Weather API Skill - Fetches current weather data from OpenWeatherMap.
3
+ *
4
+ * Tier 2 built-in skill: requires WEATHER_API_KEY environment variable.
5
+ * Uses the OpenWeatherMap API to retrieve current weather conditions
6
+ * for a specified location.
7
+ */
8
+ import { SkillBase } from '../SkillBase.js';
9
+ import type { SkillToolDefinition, SkillPromptSection, SkillConfig, ParameterSchemaEntry } from '../SkillBase.js';
10
+ /**
11
+ * Fetches current weather data from OpenWeatherMap for any location worldwide.
12
+ *
13
+ * Tier 2 built-in skill. Requires the `WEATHER_API_KEY` environment variable
14
+ * containing a valid OpenWeatherMap API key (obtainable at openweathermap.org).
15
+ * Supports metric, imperial, and standard temperature units via the `units`
16
+ * config option. The `api_key` config value takes precedence over the
17
+ * environment variable when both are set.
18
+ *
19
+ * **Provider note:** The Python reference SDK uses WeatherAPI.com
20
+ * (`api.weatherapi.com/v1/current.json`). This TypeScript skill uses
21
+ * OpenWeatherMap (`api.openweathermap.org/data/2.5/weather`). These providers
22
+ * use different API key formats — a WeatherAPI.com key will NOT work here.
23
+ * Obtain an OpenWeatherMap key at https://openweathermap.org/api.
24
+ *
25
+ * **Unit aliases:** For migration compatibility with the Python SDK the `units`
26
+ * config also accepts `"fahrenheit"` (normalized to `"imperial"`) and
27
+ * `"celsius"` (normalized to `"metric"`).
28
+ *
29
+ * @example
30
+ * ```ts
31
+ * agent.addSkill('weather_api', { units: 'imperial' });
32
+ * // or pass the key explicitly:
33
+ * agent.addSkill('weather_api', { api_key: process.env.WEATHER_API_KEY });
34
+ * ```
35
+ */
36
+ export declare class WeatherApiSkill extends SkillBase {
37
+ static SKILL_NAME: string;
38
+ static SKILL_DESCRIPTION: string;
39
+ static REQUIRED_ENV_VARS: readonly string[];
40
+ static SUPPORTS_MULTIPLE_INSTANCES: boolean;
41
+ /**
42
+ * Validates that an API key is available either via inline config or the
43
+ * `WEATHER_API_KEY` environment variable. Fails fast (returns `false`) when
44
+ * neither source provides a key — matching Python SDK behaviour where
45
+ * `_validate_config()` raises on construction when `api_key` is absent.
46
+ * @returns `true` if a key is present, `false` otherwise.
47
+ */
48
+ setup(): Promise<boolean>;
49
+ static getParameterSchema(): Record<string, ParameterSchemaEntry>;
50
+ /** @returns A single weather tool (configurable name) that fetches current weather for a location. */
51
+ getTools(): SkillToolDefinition[];
52
+ protected _getPromptSections(): SkillPromptSection[];
53
+ }
54
+ /**
55
+ * Factory function for creating WeatherApiSkill instances.
56
+ * @param config - Optional skill configuration.
57
+ * @returns A new WeatherApiSkill instance.
58
+ */
59
+ export declare function createSkill(config?: SkillConfig): WeatherApiSkill;
@@ -0,0 +1,196 @@
1
+ /**
2
+ * Weather API Skill - Fetches current weather data from OpenWeatherMap.
3
+ *
4
+ * Tier 2 built-in skill: requires WEATHER_API_KEY environment variable.
5
+ * Uses the OpenWeatherMap API to retrieve current weather conditions
6
+ * for a specified location.
7
+ */
8
+ import { SkillBase } from '../SkillBase.js';
9
+ import { FunctionResult } from '../../FunctionResult.js';
10
+ import { MAX_SKILL_INPUT_LENGTH } from '../../SecurityUtils.js';
11
+ import { getLogger } from '../../Logger.js';
12
+ const log = getLogger('WeatherApiSkill');
13
+ /**
14
+ * Fetches current weather data from OpenWeatherMap for any location worldwide.
15
+ *
16
+ * Tier 2 built-in skill. Requires the `WEATHER_API_KEY` environment variable
17
+ * containing a valid OpenWeatherMap API key (obtainable at openweathermap.org).
18
+ * Supports metric, imperial, and standard temperature units via the `units`
19
+ * config option. The `api_key` config value takes precedence over the
20
+ * environment variable when both are set.
21
+ *
22
+ * **Provider note:** The Python reference SDK uses WeatherAPI.com
23
+ * (`api.weatherapi.com/v1/current.json`). This TypeScript skill uses
24
+ * OpenWeatherMap (`api.openweathermap.org/data/2.5/weather`). These providers
25
+ * use different API key formats — a WeatherAPI.com key will NOT work here.
26
+ * Obtain an OpenWeatherMap key at https://openweathermap.org/api.
27
+ *
28
+ * **Unit aliases:** For migration compatibility with the Python SDK the `units`
29
+ * config also accepts `"fahrenheit"` (normalized to `"imperial"`) and
30
+ * `"celsius"` (normalized to `"metric"`).
31
+ *
32
+ * @example
33
+ * ```ts
34
+ * agent.addSkill('weather_api', { units: 'imperial' });
35
+ * // or pass the key explicitly:
36
+ * agent.addSkill('weather_api', { api_key: process.env.WEATHER_API_KEY });
37
+ * ```
38
+ */
39
+ export class WeatherApiSkill extends SkillBase {
40
+ // Python ground truth: skills/weather_api/skill.py
41
+ // TS declares env var as required historically; Python declares [] explicitly.
42
+ // Preserving TS behavior — full Python parity is out-of-scope for this PR.
43
+ static SKILL_NAME = 'weather_api';
44
+ static SKILL_DESCRIPTION = 'Get current weather information from WeatherAPI.com';
45
+ static REQUIRED_ENV_VARS = ['WEATHER_API_KEY'];
46
+ static SUPPORTS_MULTIPLE_INSTANCES = false;
47
+ /**
48
+ * Validates that an API key is available either via inline config or the
49
+ * `WEATHER_API_KEY` environment variable. Fails fast (returns `false`) when
50
+ * neither source provides a key — matching Python SDK behaviour where
51
+ * `_validate_config()` raises on construction when `api_key` is absent.
52
+ * @returns `true` if a key is present, `false` otherwise.
53
+ */
54
+ async setup() {
55
+ const key = this.getConfig('api_key') ?? process.env['WEATHER_API_KEY'];
56
+ if (!key) {
57
+ log.error('WeatherApiSkill: api_key is required. Set the WEATHER_API_KEY environment variable or pass api_key in skill config.');
58
+ return false;
59
+ }
60
+ return true;
61
+ }
62
+ static getParameterSchema() {
63
+ return {
64
+ ...super.getParameterSchema(),
65
+ api_key: {
66
+ type: 'string',
67
+ description: 'OpenWeatherMap API key.',
68
+ hidden: true,
69
+ env_var: 'WEATHER_API_KEY',
70
+ required: true,
71
+ },
72
+ tool_name: {
73
+ type: 'string',
74
+ description: 'Custom name for the generated weather tool.',
75
+ default: 'get_weather',
76
+ },
77
+ units: {
78
+ type: 'string',
79
+ description: 'Temperature units. Preferred values: "metric" (Celsius), "imperial" (Fahrenheit), "standard" (Kelvin). ' +
80
+ 'Python SDK aliases also accepted: "celsius" → "metric", "fahrenheit" → "imperial". ' +
81
+ 'Default matches Python (`temperature_unit: "fahrenheit"` → `"imperial"`).',
82
+ default: 'fahrenheit',
83
+ enum: ['metric', 'imperial', 'standard', 'celsius', 'fahrenheit'],
84
+ },
85
+ };
86
+ }
87
+ /** @returns A single weather tool (configurable name) that fetches current weather for a location. */
88
+ getTools() {
89
+ // Normalize Python SDK unit aliases to OpenWeatherMap unit names.
90
+ const rawUnits = this.getConfig('units', 'metric');
91
+ const units = rawUnits === 'fahrenheit' ? 'imperial' :
92
+ rawUnits === 'celsius' ? 'metric' :
93
+ rawUnits;
94
+ const toolName = this.getConfig('tool_name', 'get_weather');
95
+ return [
96
+ {
97
+ name: toolName,
98
+ description: 'Get the current weather conditions for a specified location. Returns temperature, humidity, wind speed, and weather description.',
99
+ parameters: {
100
+ location: {
101
+ type: 'string',
102
+ description: 'The city name, optionally with country code (e.g., "London", "Paris,FR", "New York,US").',
103
+ },
104
+ },
105
+ required: ['location'],
106
+ handler: async (args) => {
107
+ const location = args.location;
108
+ if (!location || typeof location !== 'string' || location.trim().length === 0) {
109
+ return new FunctionResult('Please provide a location to get the weather for.');
110
+ }
111
+ if (location.length > MAX_SKILL_INPUT_LENGTH) {
112
+ return new FunctionResult('Input is too long.');
113
+ }
114
+ const apiKey = this.getConfig('api_key') ?? process.env['WEATHER_API_KEY'];
115
+ if (!apiKey) {
116
+ return new FunctionResult('Service is not configured. Please contact your administrator.');
117
+ }
118
+ try {
119
+ const encodedLocation = encodeURIComponent(location.trim());
120
+ const url = `https://api.openweathermap.org/data/2.5/weather?q=${encodedLocation}&appid=${apiKey}&units=${units}`;
121
+ const controller = new AbortController();
122
+ const timeout = setTimeout(() => controller.abort(), 30_000);
123
+ let response;
124
+ try {
125
+ response = await fetch(url, { signal: controller.signal });
126
+ }
127
+ finally {
128
+ clearTimeout(timeout);
129
+ }
130
+ const data = (await response.json());
131
+ if (!response.ok || data.cod !== 200) {
132
+ log.error('weather_api_error', { status: response.status });
133
+ return new FunctionResult(`Could not retrieve weather for "${location}". Please check the location name and try again.`);
134
+ }
135
+ const unitLabel = units === 'imperial' ? 'F' : units === 'standard' ? 'K' : 'C';
136
+ const speedUnit = units === 'imperial' ? 'mph' : 'm/s';
137
+ const weatherDesc = data.weather.length > 0
138
+ ? data.weather.map((w) => w.description).join(', ')
139
+ : 'unknown';
140
+ const parts = [
141
+ `Weather for ${data.name}, ${data.sys.country}:`,
142
+ `Conditions: ${weatherDesc}.`,
143
+ `Temperature: ${data.main.temp}\u00B0${unitLabel} (feels like ${data.main.feels_like}\u00B0${unitLabel}).`,
144
+ `High: ${data.main.temp_max}\u00B0${unitLabel}, Low: ${data.main.temp_min}\u00B0${unitLabel}.`,
145
+ `Humidity: ${data.main.humidity}%.`,
146
+ `Wind: ${data.wind.speed} ${speedUnit}.`,
147
+ `Pressure: ${data.main.pressure} hPa.`,
148
+ ];
149
+ if (data.visibility !== undefined) {
150
+ const visKm = (data.visibility / 1000).toFixed(1);
151
+ parts.push(`Visibility: ${visKm} km.`);
152
+ }
153
+ if (data.clouds?.all !== undefined) {
154
+ parts.push(`Cloud cover: ${data.clouds.all}%.`);
155
+ }
156
+ return new FunctionResult(parts.join(' '));
157
+ }
158
+ catch (err) {
159
+ log.error('get_weather_failed', { error: err instanceof Error ? err.message : String(err) });
160
+ return new FunctionResult('The request could not be completed. Please try again.');
161
+ }
162
+ },
163
+ },
164
+ ];
165
+ }
166
+ _getPromptSections() {
167
+ const units = this.getConfig('units', 'metric');
168
+ const unitDesc = units === 'imperial'
169
+ ? 'Fahrenheit'
170
+ : units === 'standard'
171
+ ? 'Kelvin'
172
+ : 'Celsius';
173
+ return [
174
+ {
175
+ title: 'Weather Information',
176
+ body: 'You can look up current weather conditions for any location worldwide.',
177
+ bullets: [
178
+ 'Use the get_weather tool when a user asks about current weather conditions.',
179
+ 'You can specify a city name, optionally with a country code (e.g., "London", "Paris,FR").',
180
+ `Temperature is reported in ${unitDesc}.`,
181
+ 'The weather data includes temperature, humidity, wind speed, pressure, and general conditions.',
182
+ 'If the user asks about a forecast or future weather, let them know you can only provide current conditions.',
183
+ ],
184
+ },
185
+ ];
186
+ }
187
+ }
188
+ /**
189
+ * Factory function for creating WeatherApiSkill instances.
190
+ * @param config - Optional skill configuration.
191
+ * @returns A new WeatherApiSkill instance.
192
+ */
193
+ export function createSkill(config) {
194
+ return new WeatherApiSkill(config);
195
+ }
196
+ //# sourceMappingURL=weather_api.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"weather_api.js","sourceRoot":"","sources":["../../../src/skills/builtin/weather_api.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAO5C,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,MAAM,GAAG,GAAG,SAAS,CAAC,iBAAiB,CAAC,CAAC;AAsBzC;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,OAAO,eAAgB,SAAQ,SAAS;IAC5C,mDAAmD;IACnD,+EAA+E;IAC/E,2EAA2E;IAC3E,MAAM,CAAU,UAAU,GAAG,aAAa,CAAC;IAC3C,MAAM,CAAU,iBAAiB,GAAG,qDAAqD,CAAC;IAC1F,MAAM,CAAU,iBAAiB,GAAsB,CAAC,iBAAiB,CAAC,CAAC;IAC3E,MAAM,CAAU,2BAA2B,GAAG,KAAK,CAAC;IAEpD;;;;;;OAMG;IACM,KAAK,CAAC,KAAK;QAClB,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAS,SAAS,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAChF,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,GAAG,CAAC,KAAK,CAAC,qHAAqH,CAAC,CAAC;YACjI,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,CAAU,kBAAkB;QAChC,OAAO;YACL,GAAG,KAAK,CAAC,kBAAkB,EAAE;YAC7B,OAAO,EAAE;gBACP,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,yBAAyB;gBACtC,MAAM,EAAE,IAAI;gBACZ,OAAO,EAAE,iBAAiB;gBAC1B,QAAQ,EAAE,IAAI;aACf;YACD,SAAS,EAAE;gBACT,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,6CAA6C;gBAC1D,OAAO,EAAE,aAAa;aACvB;YACD,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;gBACd,WAAW,EACT,yGAAyG;oBACzG,qFAAqF;oBACrF,2EAA2E;gBAC7E,OAAO,EAAE,YAAY;gBACrB,IAAI,EAAE,CAAC,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,CAAC;aAClE;SACF,CAAC;IACJ,CAAC;IAED,sGAAsG;IACtG,QAAQ;QACN,kEAAkE;QAClE,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAS,OAAO,EAAE,QAAQ,CAAC,CAAC;QAC3D,MAAM,KAAK,GACT,QAAQ,KAAK,YAAY,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;YACxC,QAAQ,KAAK,SAAS,CAAI,CAAC,CAAC,QAAQ,CAAG,CAAC;gBACxC,QAAQ,CAAC;QACX,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAS,WAAW,EAAE,aAAa,CAAC,CAAC;QAEpE,OAAO;YACL;gBACE,IAAI,EAAE,QAAQ;gBACd,WAAW,EACT,kIAAkI;gBACpI,UAAU,EAAE;oBACV,QAAQ,EAAE;wBACR,IAAI,EAAE,QAAQ;wBACd,WAAW,EACT,0FAA0F;qBAC7F;iBACF;gBACD,QAAQ,EAAE,CAAC,UAAU,CAAC;gBACtB,OAAO,EAAE,KAAK,EAAE,IAA6B,EAAE,EAAE;oBAC/C,MAAM,QAAQ,GAAG,IAAI,CAAC,QAA8B,CAAC;oBAErD,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;wBAC9E,OAAO,IAAI,cAAc,CACvB,mDAAmD,CACpD,CAAC;oBACJ,CAAC;oBAED,IAAI,QAAQ,CAAC,MAAM,GAAG,sBAAsB,EAAE,CAAC;wBAC7C,OAAO,IAAI,cAAc,CAAC,oBAAoB,CAAC,CAAC;oBAClD,CAAC;oBAED,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAS,SAAS,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;oBACnF,IAAI,CAAC,MAAM,EAAE,CAAC;wBACZ,OAAO,IAAI,cAAc,CACvB,+DAA+D,CAChE,CAAC;oBACJ,CAAC;oBAED,IAAI,CAAC;wBACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;wBAC5D,MAAM,GAAG,GAAG,qDAAqD,eAAe,UAAU,MAAM,UAAU,KAAK,EAAE,CAAC;wBAElH,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,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC;wBAC7D,CAAC;gCAAS,CAAC;4BACT,YAAY,CAAC,OAAO,CAAC,CAAC;wBACxB,CAAC;wBACD,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAuB,CAAC;wBAE3D,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,IAAI,CAAC,GAAG,KAAK,GAAG,EAAE,CAAC;4BACrC,GAAG,CAAC,KAAK,CAAC,mBAAmB,EAAE,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;4BAC5D,OAAO,IAAI,cAAc,CACvB,mCAAmC,QAAQ,kDAAkD,CAC9F,CAAC;wBACJ,CAAC;wBAED,MAAM,SAAS,GAAG,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;wBAChF,MAAM,SAAS,GAAG,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC;wBAEvD,MAAM,WAAW,GACf,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC;4BACrB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;4BACnD,CAAC,CAAC,SAAS,CAAC;wBAEhB,MAAM,KAAK,GAAa;4BACtB,eAAe,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG;4BAChD,eAAe,WAAW,GAAG;4BAC7B,gBAAgB,IAAI,CAAC,IAAI,CAAC,IAAI,SAAS,SAAS,gBAAgB,IAAI,CAAC,IAAI,CAAC,UAAU,SAAS,SAAS,IAAI;4BAC1G,SAAS,IAAI,CAAC,IAAI,CAAC,QAAQ,SAAS,SAAS,UAAU,IAAI,CAAC,IAAI,CAAC,QAAQ,SAAS,SAAS,GAAG;4BAC9F,aAAa,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI;4BACnC,SAAS,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,SAAS,GAAG;4BACxC,aAAa,IAAI,CAAC,IAAI,CAAC,QAAQ,OAAO;yBACvC,CAAC;wBAEF,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;4BAClC,MAAM,KAAK,GAAG,CAAC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;4BAClD,KAAK,CAAC,IAAI,CAAC,eAAe,KAAK,MAAM,CAAC,CAAC;wBACzC,CAAC;wBAED,IAAI,IAAI,CAAC,MAAM,EAAE,GAAG,KAAK,SAAS,EAAE,CAAC;4BACnC,KAAK,CAAC,IAAI,CAAC,gBAAgB,IAAI,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;wBAClD,CAAC;wBAED,OAAO,IAAI,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;oBAC7C,CAAC;oBAAC,OAAO,GAAG,EAAE,CAAC;wBACb,GAAG,CAAC,KAAK,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;wBAC7F,OAAO,IAAI,cAAc,CACvB,uDAAuD,CACxD,CAAC;oBACJ,CAAC;gBACH,CAAC;aACF;SACF,CAAC;IACJ,CAAC;IAEkB,kBAAkB;QACnC,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAS,OAAO,EAAE,QAAQ,CAAC,CAAC;QACxD,MAAM,QAAQ,GACZ,KAAK,KAAK,UAAU;YAClB,CAAC,CAAC,YAAY;YACd,CAAC,CAAC,KAAK,KAAK,UAAU;gBACpB,CAAC,CAAC,QAAQ;gBACV,CAAC,CAAC,SAAS,CAAC;QAElB,OAAO;YACL;gBACE,KAAK,EAAE,qBAAqB;gBAC5B,IAAI,EAAE,wEAAwE;gBAC9E,OAAO,EAAE;oBACP,6EAA6E;oBAC7E,2FAA2F;oBAC3F,8BAA8B,QAAQ,GAAG;oBACzC,gGAAgG;oBAChG,6GAA6G;iBAC9G;aACF;SACF,CAAC;IACJ,CAAC;;AAGH;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,MAAoB;IAC9C,OAAO,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;AACrC,CAAC"}
@@ -0,0 +1,160 @@
1
+ /**
2
+ * Web Search Skill - Searches the web using the Google Custom Search API.
3
+ *
4
+ * Tier 3 built-in skill: requires `GOOGLE_SEARCH_API_KEY` and
5
+ * `GOOGLE_SEARCH_ENGINE_ID` (legacy alias: `GOOGLE_SEARCH_CX`) environment
6
+ * variables, or the equivalent config params. Uses the Google Custom Search
7
+ * JSON API to perform web searches and return formatted results.
8
+ */
9
+ import { SkillBase } from '../SkillBase.js';
10
+ import type { SkillToolDefinition, SkillPromptSection, SkillConfig, ParameterSchemaEntry } from '../SkillBase.js';
11
+ /**
12
+ * Run the HTML → plain-text extraction pipeline that mirrors Python's
13
+ * `GoogleSearchScraper.extract_html_content` (skill.py:204-282).
14
+ *
15
+ * Pipeline:
16
+ * 1. Pre-process `<![CDATA[…]]>` sections to plain text (Python html.parser
17
+ * keeps CDATA content; cheerio/htmlparser2 drops it).
18
+ * 2. Walk {@link CONTENT_CANDIDATES} in order, picking the first match.
19
+ * Fall back to `<body>` or the raw document.
20
+ * 3. Clone the picked subtree so tag/pattern removal only affects it —
21
+ * analogous to Python's `content_soup = BeautifulSoup(str(main_content))`.
22
+ * The selector-first-then-filter order is load-bearing: if the real
23
+ * content is wrapped in a sidebar-pattern div, Python still finds it
24
+ * because the selector runs before removal.
25
+ * 4. Remove {@link UNWANTED_TAGS} and every element matching any of
26
+ * {@link UNWANTED_PATTERNS} on either `class` or `id` (case-insensitive).
27
+ * 5. Collapse whitespace and trim.
28
+ *
29
+ * Exported so `tests/skills/web-search-parity.test.ts` can verify byte-
30
+ * identical behavior against Python BeautifulSoup fixtures; not re-exported
31
+ * from the skills barrel, so this stays internal to the skill module.
32
+ *
33
+ * @internal
34
+ */
35
+ export declare function extractTextFromHtml(html: string): string;
36
+ /**
37
+ * Searches the web using the Google Custom Search JSON API.
38
+ *
39
+ * Tier 3 built-in skill. Credentials can be supplied via the `api_key` and
40
+ * `search_engine_id` params or `GOOGLE_SEARCH_API_KEY` /
41
+ * `GOOGLE_SEARCH_ENGINE_ID` (legacy: `GOOGLE_SEARCH_CX`) environment variables.
42
+ *
43
+ * The handler mirrors Python's `search_and_scrape_best` pipeline: fetches
44
+ * `oversample_factor × num_results` candidates from Google, scrapes each
45
+ * result page (SSRF-guarded, cheerio-based text extraction), scores for
46
+ * quality (length + query relevance + boilerplate penalty), deduplicates by
47
+ * domain, and returns the top `num_results` above `min_quality_score` with
48
+ * full page content. If every scrape fails or falls below the threshold the
49
+ * handler falls back to raw API snippets so the agent still has something
50
+ * to say.
51
+ *
52
+ * Supported config: `tool_name`, `num_results`, `no_results_message`,
53
+ * `safe_search`, `delay`, `max_content_length`, `oversample_factor`,
54
+ * `min_quality_score`.
55
+ *
56
+ * @example
57
+ * ```ts
58
+ * agent.addSkill('web_search', {
59
+ * api_key: process.env.GOOGLE_SEARCH_API_KEY,
60
+ * search_engine_id: process.env.GOOGLE_CSE_ID,
61
+ * num_results: 3,
62
+ * });
63
+ * ```
64
+ */
65
+ export declare class WebSearchSkill extends SkillBase {
66
+ static SKILL_NAME: string;
67
+ static SKILL_DESCRIPTION: string;
68
+ static SKILL_VERSION: string;
69
+ static REQUIRED_PACKAGES: readonly string[];
70
+ static REQUIRED_ENV_VARS: readonly string[];
71
+ static SUPPORTS_MULTIPLE_INSTANCES: boolean;
72
+ static getParameterSchema(): Record<string, ParameterSchemaEntry>;
73
+ /**
74
+ * @returns Manifest declaring Google Search credentials as required env vars.
75
+ * Reports `GOOGLE_SEARCH_ENGINE_ID` as the canonical name; `GOOGLE_SEARCH_CX`
76
+ * is still accepted as a legacy fallback at runtime.
77
+ */
78
+ /**
79
+ * Validate required credentials before the skill becomes active.
80
+ *
81
+ * Mirrors Python's `setup()` (skill.py:559-600) which checks `api_key` and
82
+ * `search_engine_id` and returns `False` (logging an error) if either is
83
+ * absent. In the TS SDK credentials may also arrive via environment variables
84
+ * (`GOOGLE_SEARCH_API_KEY` / `GOOGLE_SEARCH_ENGINE_ID` or the legacy alias
85
+ * `GOOGLE_SEARCH_CX`), so both config params and env vars are checked.
86
+ * @returns `true` if all required credentials are present, `false` otherwise.
87
+ */
88
+ setup(): Promise<boolean>;
89
+ /**
90
+ * Instance key for the SkillManager. Includes the configured
91
+ * `search_engine_id` (or `"default"`) and `tool_name` (or `"web_search"`)
92
+ * to match Python's `"{SKILL_NAME}_{search_engine_id}_{tool_name}"` scheme.
93
+ */
94
+ getInstanceKey(): string;
95
+ /** Global data injected into the agent's SWML context (mirrors Python). */
96
+ getGlobalData(): Record<string, unknown>;
97
+ /** Resolve the tool name (defaults to `web_search`, matches Python default). */
98
+ private getToolName;
99
+ /**
100
+ * @returns A single tool (named via `tool_name`) that performs a Google
101
+ * Custom Search and returns formatted results.
102
+ */
103
+ getTools(): SkillToolDefinition[];
104
+ /** Apply the `{query}` template to the no-results message. */
105
+ private static _formatNoResultsMessage;
106
+ /**
107
+ * Check whether the URL points at Reddit. Python parity: `is_reddit_url`
108
+ * (skill.py:66).
109
+ */
110
+ private static _isRedditUrl;
111
+ /**
112
+ * Fetch a Reddit URL via the `.json` endpoint and build a structured summary
113
+ * of the post + top comments.
114
+ *
115
+ * Python parity: `extract_reddit_content` (skill.py:71-190). Matches the
116
+ * post-title/author/score/comments assembly and the top-20 → valid → top-5
117
+ * comment pipeline. Returns just the compiled text — Python's
118
+ * `search_and_scrape_best` unconditionally overwrites Reddit's
119
+ * engagement-score metrics with the 6-factor `_calculate_content_quality`
120
+ * (skill.py:447-448), so we skip computing the dead engagement score here
121
+ * and let the handler score the text via `_qualityMetrics`.
122
+ *
123
+ * Falls through to HTML extraction on JSON fetch failure or malformed
124
+ * payload, matching Python's `except Exception: fall back` behavior.
125
+ */
126
+ private _extractRedditContent;
127
+ /**
128
+ * Fetch a URL and extract clean text content, then score it with the
129
+ * 6-factor `_qualityMetrics`. Reddit URLs are routed to the JSON extractor
130
+ * first; the compiled Reddit text is scored with the same 6-factor formula
131
+ * to match Python's `search_and_scrape_best` overwrite behavior
132
+ * (skill.py:447-448).
133
+ *
134
+ * Python parity: `extract_text_from_url` (skill.py:192-202). Returns `null`
135
+ * on any failure (network, non-200, parse error, or SSRF rejection).
136
+ */
137
+ private _scrapeUrl;
138
+ /**
139
+ * Six-factor content quality metrics (score + sub-metrics used in the
140
+ * per-result output). Combines content length, word diversity,
141
+ * boilerplate penalty, sentence structure, domain reputation, and query
142
+ * relevance.
143
+ *
144
+ * Python parity: `_calculate_content_quality` (skill.py:284-414). Preserves
145
+ * the weights (0.25/0.10/0.10/0.15/0.15/0.25), the 26-phrase boilerplate
146
+ * list, the quality/low-quality domain lists, and the phrase-match bonus
147
+ * on relevance. Also returns the same metric fields Python exposes
148
+ * (`text_length`, `sentence_count`, `query_relevance`, `query_words_found`,
149
+ * `domain`) so the handler can render the full Python output format.
150
+ */
151
+ private static _qualityMetrics;
152
+ /** @returns Prompt section describing web search capabilities and usage guidance. */
153
+ protected _getPromptSections(): SkillPromptSection[];
154
+ }
155
+ /**
156
+ * Factory function for creating WebSearchSkill instances.
157
+ * @param config - Optional skill configuration.
158
+ * @returns A new WebSearchSkill instance.
159
+ */
160
+ export declare function createSkill(config?: SkillConfig): WebSearchSkill;