@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,758 @@
1
+ /**
2
+ * Spider Skill - Fast web scraping and crawling capabilities.
3
+ *
4
+ * Tier 2 built-in skill. Port of the Python `SpiderSkill` that performs
5
+ * HTTP scraping via `fetch`, lightweight HTML-to-text extraction, and
6
+ * breadth-first crawling with configurable limits. Supports three tools:
7
+ *
8
+ * - `scrape_url` — single-page text/markdown extraction
9
+ * - `crawl_site` — breadth-first crawl from a start URL
10
+ * - `extract_structured_data` — CSS/XPath-like structured extraction
11
+ *
12
+ * Multiple instances are supported; use `tool_name` in config to differentiate.
13
+ */
14
+ import { SkillBase } from '../SkillBase.js';
15
+ import { FunctionResult } from '../../FunctionResult.js';
16
+ import { resolveAndValidateUrl, validateUrl, MAX_SKILL_INPUT_LENGTH } from '../../SecurityUtils.js';
17
+ import { getLogger } from '../../Logger.js';
18
+ import * as cheerio from 'cheerio';
19
+ const log = getLogger('SpiderSkill');
20
+ const WHITESPACE_REGEX = /\s+/g;
21
+ /** Tags stripped from HTML before text extraction. */
22
+ const STRIP_TAG_REGEXES = [
23
+ /<script\b[^>]*>[\s\S]*?<\/script>/gi,
24
+ /<style\b[^>]*>[\s\S]*?<\/style>/gi,
25
+ /<nav\b[^>]*>[\s\S]*?<\/nav>/gi,
26
+ /<header\b[^>]*>[\s\S]*?<\/header>/gi,
27
+ /<footer\b[^>]*>[\s\S]*?<\/footer>/gi,
28
+ /<aside\b[^>]*>[\s\S]*?<\/aside>/gi,
29
+ /<noscript\b[^>]*>[\s\S]*?<\/noscript>/gi,
30
+ ];
31
+ /**
32
+ * Fast web scraping skill optimized for speed and token efficiency.
33
+ *
34
+ * Multi-instance capable. Port of the Python `SpiderSkill` with three tools:
35
+ * `scrape_url`, `crawl_site`, and `extract_structured_data`. Configuration
36
+ * mirrors the Python schema (delay, concurrent_requests, timeout, max_pages,
37
+ * max_depth, extract_type, max_text_length, clean_text, selectors,
38
+ * follow_patterns, user_agent, headers, follow_robots_txt, cache_enabled).
39
+ *
40
+ * @example
41
+ * ```ts
42
+ * agent.addSkill('spider', { max_pages: 5, max_depth: 2 });
43
+ * ```
44
+ */
45
+ export class SpiderSkill extends SkillBase {
46
+ // Python ground truth: skills/spider/skill.py:~140-145
47
+ // REQUIRED_PACKAGES = ["lxml"] in Python; TS uses cheerio.
48
+ static SKILL_NAME = 'spider';
49
+ static SKILL_DESCRIPTION = 'Fast web scraping and crawling capabilities';
50
+ static SKILL_VERSION = '1.0.0';
51
+ static REQUIRED_PACKAGES = ['cheerio'];
52
+ static REQUIRED_ENV_VARS = [];
53
+ static SUPPORTS_MULTIPLE_INSTANCES = true;
54
+ static getParameterSchema() {
55
+ return {
56
+ ...super.getParameterSchema(),
57
+ delay: {
58
+ type: 'number',
59
+ description: 'Delay between requests in seconds',
60
+ default: 0.1,
61
+ required: false,
62
+ min: 0,
63
+ },
64
+ concurrent_requests: {
65
+ type: 'integer',
66
+ description: 'Number of concurrent requests allowed',
67
+ default: 5,
68
+ required: false,
69
+ min: 1,
70
+ max: 20,
71
+ },
72
+ timeout: {
73
+ type: 'integer',
74
+ description: 'Request timeout in seconds',
75
+ default: 5,
76
+ required: false,
77
+ min: 1,
78
+ max: 60,
79
+ },
80
+ max_pages: {
81
+ type: 'integer',
82
+ description: 'Maximum number of pages to scrape',
83
+ default: 1,
84
+ required: false,
85
+ min: 1,
86
+ max: 100,
87
+ },
88
+ max_depth: {
89
+ type: 'integer',
90
+ description: 'Maximum crawl depth (0 = single page only)',
91
+ default: 0,
92
+ required: false,
93
+ min: 0,
94
+ max: 5,
95
+ },
96
+ extract_type: {
97
+ type: 'string',
98
+ description: 'Content extraction method',
99
+ default: 'fast_text',
100
+ required: false,
101
+ enum: ['fast_text', 'clean_text', 'full_text', 'html', 'markdown', 'structured', 'custom'],
102
+ },
103
+ max_text_length: {
104
+ type: 'integer',
105
+ description: 'Maximum text length to return',
106
+ default: 3000,
107
+ required: false,
108
+ min: 100,
109
+ max: 100000,
110
+ },
111
+ clean_text: {
112
+ type: 'boolean',
113
+ description: 'Whether to clean extracted text',
114
+ default: true,
115
+ required: false,
116
+ },
117
+ selectors: {
118
+ type: 'object',
119
+ description: 'Custom CSS/XPath selectors for structured extraction',
120
+ default: {},
121
+ required: false,
122
+ additionalProperties: { type: 'string' },
123
+ },
124
+ follow_patterns: {
125
+ type: 'array',
126
+ description: 'URL patterns to follow when crawling',
127
+ default: [],
128
+ required: false,
129
+ items: { type: 'string' },
130
+ },
131
+ user_agent: {
132
+ type: 'string',
133
+ description: 'User agent string for requests',
134
+ default: 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36',
135
+ required: false,
136
+ },
137
+ headers: {
138
+ type: 'object',
139
+ description: 'Additional HTTP headers',
140
+ default: {},
141
+ required: false,
142
+ additionalProperties: { type: 'string' },
143
+ },
144
+ follow_robots_txt: {
145
+ type: 'boolean',
146
+ // Matches Python's __init__ runtime fallback (skills/spider/skill.py:177
147
+ // uses `params.get('follow_robots_txt', False)`). Python's schema said
148
+ // True but the runtime and TS both use False — aligning the schema
149
+ // eliminates the cross-SDK contract mismatch.
150
+ description: 'Whether to respect robots.txt (default: false to match Python runtime)',
151
+ default: false,
152
+ required: false,
153
+ },
154
+ cache_enabled: {
155
+ type: 'boolean',
156
+ description: 'Whether to cache scraped pages',
157
+ default: true,
158
+ required: false,
159
+ },
160
+ };
161
+ }
162
+ // Runtime state, populated in setup()
163
+ delay = 0.1;
164
+ concurrentRequests = 5;
165
+ timeout = 5;
166
+ maxPages = 1;
167
+ maxDepth = 0;
168
+ extractType = 'fast_text';
169
+ maxTextLength = 3000;
170
+ cleanText = true;
171
+ cacheEnabled = true;
172
+ followRobotsTxt = true;
173
+ userAgent = 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36';
174
+ headers = {};
175
+ selectors = {};
176
+ compiledFollowPatterns = [];
177
+ cache = null;
178
+ cacheMaxSize = 100;
179
+ getInstanceKey() {
180
+ const toolName = this.getConfig('tool_name', this.skillName);
181
+ return `${this.skillName}_${toolName}`;
182
+ }
183
+ async setup() {
184
+ // Performance
185
+ this.delay = this.getConfig('delay', 0.1);
186
+ this.concurrentRequests = this.getConfig('concurrent_requests', 5);
187
+ this.timeout = this.getConfig('timeout', 5);
188
+ // Crawl limits
189
+ this.maxPages = this.getConfig('max_pages', 1);
190
+ this.maxDepth = this.getConfig('max_depth', 0);
191
+ // Content processing
192
+ this.extractType = this.getConfig('extract_type', 'fast_text');
193
+ // Python has an internal inconsistency (schema: 10000, __init__ fallback:
194
+ // 3000). The effective runtime default is 3000 because Python reads via
195
+ // `self.params.get('max_text_length', 3000)` and schema defaults are not
196
+ // applied. Use 3000 for parity. Follow-up: reconcile Python schema vs init.
197
+ this.maxTextLength = this.getConfig('max_text_length', 3000);
198
+ this.cleanText = this.getConfig('clean_text', true);
199
+ // Features
200
+ this.cacheEnabled = this.getConfig('cache_enabled', true);
201
+ this.followRobotsTxt = this.getConfig('follow_robots_txt', false);
202
+ this.userAgent = this.getConfig('user_agent', 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36');
203
+ // Optional headers + user-agent merge
204
+ const headers = this.getConfig('headers', {}) ?? {};
205
+ this.headers = { ...headers, 'User-Agent': this.userAgent };
206
+ // Selectors for structured extraction
207
+ this.selectors = this.getConfig('selectors', {}) ?? {};
208
+ // Setup cache
209
+ this.cache = this.cacheEnabled ? new Map() : null;
210
+ // Validate numeric ranges
211
+ if (this.delay < 0) {
212
+ log.error('spider: delay cannot be negative', { delay: this.delay });
213
+ return false;
214
+ }
215
+ if (this.concurrentRequests < 1 || this.concurrentRequests > 20) {
216
+ log.error('spider: concurrent_requests must be between 1 and 20', { concurrent_requests: this.concurrentRequests });
217
+ return false;
218
+ }
219
+ if (this.maxPages < 1) {
220
+ log.error('spider: max_pages must be at least 1', { max_pages: this.maxPages });
221
+ return false;
222
+ }
223
+ if (this.maxDepth < 0) {
224
+ log.error('spider: max_depth cannot be negative', { max_depth: this.maxDepth });
225
+ return false;
226
+ }
227
+ // Pre-compile follow patterns
228
+ this.compiledFollowPatterns = [];
229
+ const patterns = this.getConfig('follow_patterns', []) ?? [];
230
+ for (const pattern of patterns) {
231
+ try {
232
+ this.compiledFollowPatterns.push(new RegExp(pattern));
233
+ }
234
+ catch (err) {
235
+ log.error('spider: invalid follow pattern', {
236
+ pattern,
237
+ error: err instanceof Error ? err.message : String(err),
238
+ });
239
+ }
240
+ }
241
+ log.info('spider: configured', {
242
+ delay: this.delay,
243
+ max_pages: this.maxPages,
244
+ max_depth: this.maxDepth,
245
+ });
246
+ return true;
247
+ }
248
+ getHints() {
249
+ return [
250
+ 'scrape',
251
+ 'crawl',
252
+ 'extract',
253
+ 'web page',
254
+ 'website',
255
+ 'get content from',
256
+ 'fetch data from',
257
+ 'spider',
258
+ ];
259
+ }
260
+ async cleanup() {
261
+ if (this.cache) {
262
+ this.cache.clear();
263
+ }
264
+ log.info('spider: cleaned up');
265
+ }
266
+ /** @returns Three tools: `scrape_url`, `crawl_site`, and `extract_structured_data`. */
267
+ getTools() {
268
+ const toolPrefix = this.getConfig('tool_name', '');
269
+ const prefix = toolPrefix ? `${toolPrefix}_` : '';
270
+ return [
271
+ {
272
+ name: `${prefix}scrape_url`,
273
+ description: 'Extract text content from a single web page',
274
+ parameters: {
275
+ url: {
276
+ type: 'string',
277
+ description: 'The URL to scrape',
278
+ },
279
+ },
280
+ required: ['url'],
281
+ handler: async (args, rawData) => this._scrapeUrlHandler(args, rawData),
282
+ },
283
+ {
284
+ name: `${prefix}crawl_site`,
285
+ description: 'Crawl multiple pages starting from a URL',
286
+ parameters: {
287
+ start_url: {
288
+ type: 'string',
289
+ description: 'Starting URL for the crawl',
290
+ },
291
+ },
292
+ required: ['start_url'],
293
+ handler: async (args, rawData) => this._crawlSiteHandler(args, rawData),
294
+ },
295
+ {
296
+ name: `${prefix}extract_structured_data`,
297
+ description: 'Extract specific data from a web page using selectors',
298
+ parameters: {
299
+ url: {
300
+ type: 'string',
301
+ description: 'The URL to scrape',
302
+ },
303
+ },
304
+ required: ['url'],
305
+ handler: async (args, rawData) => this._extractStructuredHandler(args, rawData),
306
+ },
307
+ ];
308
+ }
309
+ // ---------------------------------------------------------------------------
310
+ // Internal helpers
311
+ // ---------------------------------------------------------------------------
312
+ /** Fetch a URL with caching and timeout handling. Returns null on failure. */
313
+ async _fetchUrl(url) {
314
+ if (this.cacheEnabled && this.cache?.has(url)) {
315
+ log.debug('spider: cache hit', { url });
316
+ return this.cache.get(url);
317
+ }
318
+ const controller = new AbortController();
319
+ const timer = setTimeout(() => controller.abort(), this.timeout * 1000);
320
+ try {
321
+ const response = await fetch(url, {
322
+ method: 'GET',
323
+ headers: this.headers,
324
+ signal: controller.signal,
325
+ });
326
+ if (!response.ok) {
327
+ log.error('spider: fetch failed', { url, status: response.status });
328
+ return null;
329
+ }
330
+ const body = await response.text();
331
+ const cached = {
332
+ url: response.url || url,
333
+ status: response.status,
334
+ body,
335
+ };
336
+ if (this.cacheEnabled && this.cache) {
337
+ if (this.cache.size >= this.cacheMaxSize) {
338
+ const oldest = this.cache.keys().next().value;
339
+ if (oldest !== undefined)
340
+ this.cache.delete(oldest);
341
+ }
342
+ this.cache.set(url, cached);
343
+ }
344
+ return cached;
345
+ }
346
+ catch (err) {
347
+ log.error('spider: fetch error', {
348
+ url,
349
+ error: err instanceof Error ? err.message : String(err),
350
+ });
351
+ return null;
352
+ }
353
+ finally {
354
+ clearTimeout(timer);
355
+ }
356
+ }
357
+ /**
358
+ * Extract plain text from a fetched response using simple regex stripping.
359
+ *
360
+ * Takes a {@link CachedResponse} (TS equivalent of `requests.Response`) to
361
+ * match Python's `_fast_text_extract(response)` capability surface — the
362
+ * response-like object exposes `url`, `status`, and `body` for callers that
363
+ * need to branch on status/content-type.
364
+ */
365
+ _fastTextExtract(response) {
366
+ try {
367
+ // Parse through cheerio so every named and numeric HTML entity is
368
+ // decoded (Python's lxml does this natively). Previously TS only
369
+ // decoded six hand-coded entities, leaving `&mdash;`, `&#8212;`, etc.
370
+ // literal in the output.
371
+ const $ = cheerio.load(response.body);
372
+ // Strip noise tags before extracting text — matches Python's
373
+ // lxml drop_tree() on the same 7 tags.
374
+ for (const tag of [
375
+ 'script',
376
+ 'style',
377
+ 'nav',
378
+ 'header',
379
+ 'footer',
380
+ 'aside',
381
+ 'noscript',
382
+ ]) {
383
+ $(tag).remove();
384
+ }
385
+ let text = $('body').text();
386
+ if (!text || text.trim().length === 0) {
387
+ // Pages without <body> fall through to document-root text.
388
+ text = $.root().text();
389
+ }
390
+ if (this.cleanText) {
391
+ text = text.replace(WHITESPACE_REGEX, ' ').trim();
392
+ }
393
+ // Smart truncation
394
+ if (text.length > this.maxTextLength) {
395
+ const keepStart = Math.floor((this.maxTextLength * 2) / 3);
396
+ const keepEnd = Math.floor(this.maxTextLength / 3);
397
+ text =
398
+ text.slice(0, keepStart) +
399
+ '\n\n[...CONTENT TRUNCATED...]\n\n' +
400
+ text.slice(-keepEnd);
401
+ }
402
+ return text;
403
+ }
404
+ catch (err) {
405
+ // Python swallows extraction errors and returns '' so the handler
406
+ // emits a clean "no content extracted" message instead of bubbling
407
+ // a parse failure all the way up to the AI.
408
+ log.error('spider: fast-text extraction failed', {
409
+ error: err instanceof Error ? err.message : String(err),
410
+ });
411
+ return '';
412
+ }
413
+ }
414
+ /**
415
+ * Extract a value using a CSS selector (via cheerio) or XPath-like
416
+ * selector (`//tag`). Mirrors Python `_structured_extract`'s selector
417
+ * branching: selectors starting with `/` are treated as XPath (tag-name
418
+ * subset), everything else is full CSS via cheerio's querySelector-style
419
+ * engine.
420
+ */
421
+ _applySelector($, selector) {
422
+ const trimmed = selector.trim();
423
+ if (!trimmed)
424
+ return [];
425
+ if (trimmed.startsWith('/')) {
426
+ // Subset of XPath supported in Python's lxml path — `//tag`, `//tag/text()`.
427
+ const tagMatch = /\/\/([a-zA-Z][a-zA-Z0-9]*)/.exec(trimmed);
428
+ if (!tagMatch)
429
+ return [];
430
+ return $(tagMatch[1])
431
+ .toArray()
432
+ .map((el) => $(el).text().trim())
433
+ .filter((t) => t.length > 0);
434
+ }
435
+ return $(trimmed)
436
+ .toArray()
437
+ .map((el) => $(el).text().trim())
438
+ .filter((t) => t.length > 0);
439
+ }
440
+ /** Markdown extraction using cheerio. Mirrors Python `_markdown_extract`. */
441
+ _markdownExtract(response) {
442
+ try {
443
+ const $ = cheerio.load(response.body);
444
+ // Remove unwanted tags
445
+ for (const tag of ['script', 'style', 'nav', 'header', 'footer', 'aside']) {
446
+ $(tag).remove();
447
+ }
448
+ const parts = [];
449
+ const title = $('title').first().text().trim();
450
+ if (title)
451
+ parts.push(`# ${title}\n`);
452
+ $('h1, h2, h3, h4, h5, h6, p, li, code, pre').each((_, el) => {
453
+ const tag = el.tagName.toLowerCase();
454
+ const text = $(el).text().trim();
455
+ if (!text)
456
+ return;
457
+ if (/^h[1-6]$/.test(tag)) {
458
+ const level = Number(tag[1]);
459
+ parts.push(`\n${'#'.repeat(level)} ${text}\n`);
460
+ }
461
+ else if (tag === 'p') {
462
+ parts.push(`\n${text}\n`);
463
+ }
464
+ else if (tag === 'li') {
465
+ parts.push(`- ${text}`);
466
+ }
467
+ else if (tag === 'code' || tag === 'pre') {
468
+ parts.push(`\n\`\`\`\n${text}\n\`\`\`\n`);
469
+ }
470
+ });
471
+ let text = parts.join('\n');
472
+ if (text.length > this.maxTextLength) {
473
+ text = text.slice(0, this.maxTextLength) + '\n\n[...TRUNCATED...]';
474
+ }
475
+ return text;
476
+ }
477
+ catch (err) {
478
+ log.error('spider: markdown extraction error', {
479
+ error: err instanceof Error ? err.message : String(err),
480
+ });
481
+ return this._fastTextExtract(response);
482
+ }
483
+ }
484
+ _structuredExtract(cached, selectors) {
485
+ let $;
486
+ try {
487
+ $ = cheerio.load(cached.body);
488
+ }
489
+ catch (err) {
490
+ // Python returns `{'error': str(e)}` from _structured_extract when the
491
+ // parser fails (skill.py). Surface the same shape so upstream handlers
492
+ // can branch on `'error' in result`.
493
+ log.error('spider: structured parse failed', {
494
+ error: err instanceof Error ? err.message : String(err),
495
+ });
496
+ return { error: err instanceof Error ? err.message : String(err) };
497
+ }
498
+ const result = {
499
+ url: cached.url,
500
+ status_code: cached.status,
501
+ title: $('title').first().text().trim(),
502
+ data: {},
503
+ };
504
+ const data = {};
505
+ for (const [field, selector] of Object.entries(selectors)) {
506
+ try {
507
+ const values = this._applySelector($, selector);
508
+ if (values.length === 0) {
509
+ data[field] = null;
510
+ }
511
+ else if (values.length === 1) {
512
+ data[field] = values[0];
513
+ }
514
+ else {
515
+ data[field] = values;
516
+ }
517
+ }
518
+ catch (err) {
519
+ log.warn('spider: selector error', {
520
+ selector,
521
+ error: err instanceof Error ? err.message : String(err),
522
+ });
523
+ data[field] = null;
524
+ }
525
+ }
526
+ result['data'] = data;
527
+ return result;
528
+ }
529
+ // ---------------------------------------------------------------------------
530
+ // Tool handlers
531
+ // ---------------------------------------------------------------------------
532
+ async _scrapeUrlHandler(args, _rawData) {
533
+ const urlArg = args['url'];
534
+ if (typeof urlArg !== 'string' || urlArg.trim().length === 0) {
535
+ return new FunctionResult('Please provide a URL to scrape');
536
+ }
537
+ const url = urlArg.trim();
538
+ if (url.length > MAX_SKILL_INPUT_LENGTH) {
539
+ return new FunctionResult('Input URL is too long.');
540
+ }
541
+ if (!/^https?:\/\//.test(url)) {
542
+ return new FunctionResult(`Invalid URL: ${url}`);
543
+ }
544
+ // SSRF protection
545
+ const allowPrivate = process.env['SWML_ALLOW_PRIVATE_URLS'] === 'true';
546
+ try {
547
+ await resolveAndValidateUrl(url, allowPrivate);
548
+ }
549
+ catch {
550
+ return new FunctionResult('URL rejected: cannot access private or internal URLs');
551
+ }
552
+ const cached = await this._fetchUrl(url);
553
+ if (!cached) {
554
+ return new FunctionResult(`Failed to fetch ${url}`);
555
+ }
556
+ try {
557
+ if (this.extractType === 'structured') {
558
+ const result = this._structuredExtract(cached, this.selectors);
559
+ return new FunctionResult(`Extracted structured data from ${url}: ${JSON.stringify(result)}`);
560
+ }
561
+ const content = this.extractType === 'markdown'
562
+ ? this._markdownExtract(cached)
563
+ : this._fastTextExtract(cached);
564
+ if (!content) {
565
+ return new FunctionResult(`No content extracted from ${url}`);
566
+ }
567
+ const charCount = content.length;
568
+ const header = `Content from ${url} (${charCount} characters):\n\n`;
569
+ return new FunctionResult(header + content);
570
+ }
571
+ catch (err) {
572
+ log.error('spider: scrape_url error', {
573
+ url,
574
+ error: err instanceof Error ? err.message : String(err),
575
+ });
576
+ return new FunctionResult(`Error processing ${url}: ${err instanceof Error ? err.message : String(err)}`);
577
+ }
578
+ }
579
+ async _crawlSiteHandler(args, _rawData) {
580
+ const startArg = args['start_url'];
581
+ if (typeof startArg !== 'string' || startArg.trim().length === 0) {
582
+ return new FunctionResult('Please provide a starting URL for the crawl');
583
+ }
584
+ const startUrl = startArg.trim();
585
+ if (!/^https?:\/\//.test(startUrl)) {
586
+ return new FunctionResult(`Invalid URL: ${startUrl}`);
587
+ }
588
+ const allowPrivate = process.env['SWML_ALLOW_PRIVATE_URLS'] === 'true';
589
+ try {
590
+ await resolveAndValidateUrl(startUrl, allowPrivate);
591
+ }
592
+ catch {
593
+ return new FunctionResult('URL rejected: cannot access private or internal URLs');
594
+ }
595
+ const maxDepth = this.maxDepth;
596
+ const maxPages = this.maxPages;
597
+ if (maxDepth < 0)
598
+ return new FunctionResult('Max depth cannot be negative');
599
+ if (maxPages < 1)
600
+ return new FunctionResult('Max pages must be at least 1');
601
+ const visited = new Set();
602
+ const toVisit = [[startUrl, 0]];
603
+ const results = [];
604
+ let startHost;
605
+ try {
606
+ startHost = new URL(startUrl).host;
607
+ }
608
+ catch {
609
+ return new FunctionResult(`Invalid URL: ${startUrl}`);
610
+ }
611
+ while (toVisit.length > 0 && visited.size < maxPages) {
612
+ const next = toVisit.shift();
613
+ if (!next)
614
+ break;
615
+ const [url, depth] = next;
616
+ if (visited.has(url) || depth > maxDepth)
617
+ continue;
618
+ const cached = await this._fetchUrl(url);
619
+ if (!cached)
620
+ continue;
621
+ visited.add(url);
622
+ const content = this._fastTextExtract(cached);
623
+ if (content) {
624
+ results.push({
625
+ url,
626
+ depth,
627
+ contentLength: content.length,
628
+ summary: content.length > 500 ? content.slice(0, 500) + '...' : content,
629
+ });
630
+ }
631
+ // Extract links if not at max depth. Use cheerio so we correctly
632
+ // pick up unquoted and oddly-whitespaced href attributes that the
633
+ // regex path missed (Python skills/spider/skill.py:487 uses lxml
634
+ // xpath('//a[@href]/@href') which has the same robustness).
635
+ if (depth < maxDepth) {
636
+ try {
637
+ const $links = cheerio.load(cached.body);
638
+ const hrefs = [];
639
+ $links('a[href]').each((_, el) => {
640
+ const href = $links(el).attr('href');
641
+ if (href)
642
+ hrefs.push(href);
643
+ });
644
+ for (const href of hrefs) {
645
+ let absoluteUrl;
646
+ try {
647
+ absoluteUrl = new URL(href, url).toString();
648
+ }
649
+ catch {
650
+ continue;
651
+ }
652
+ if (this.compiledFollowPatterns.length > 0) {
653
+ const allowed = this.compiledFollowPatterns.some((re) => re.test(absoluteUrl));
654
+ if (!allowed)
655
+ continue;
656
+ }
657
+ try {
658
+ const absHost = new URL(absoluteUrl).host;
659
+ if (absHost !== startHost)
660
+ continue;
661
+ }
662
+ catch {
663
+ continue;
664
+ }
665
+ // SSRF hardening — discovered links must pass the same
666
+ // validation the entry URL did. Prevents a crafted page from
667
+ // bouncing the crawler into internal/metadata endpoints.
668
+ if (!(await validateUrl(absoluteUrl))) {
669
+ log.debug('spider: skipping discovered URL rejected by SSRF', {
670
+ url: absoluteUrl,
671
+ });
672
+ continue;
673
+ }
674
+ if (!visited.has(absoluteUrl)) {
675
+ toVisit.push([absoluteUrl, depth + 1]);
676
+ }
677
+ }
678
+ }
679
+ catch (err) {
680
+ log.warn('spider: link extraction error', {
681
+ url,
682
+ error: err instanceof Error ? err.message : String(err),
683
+ });
684
+ }
685
+ }
686
+ if (this.delay > 0 && visited.size < maxPages) {
687
+ await new Promise((resolve) => setTimeout(resolve, this.delay * 1000));
688
+ }
689
+ }
690
+ if (results.length === 0) {
691
+ return new FunctionResult(`No pages could be crawled from ${startUrl}`);
692
+ }
693
+ const lines = [
694
+ `Crawled ${results.length} pages from ${startHost}:`,
695
+ '',
696
+ ];
697
+ results.forEach((r, i) => {
698
+ lines.push(`${i + 1}. ${r.url} (depth: ${r.depth}, ${r.contentLength} chars)`);
699
+ lines.push(` Summary: ${r.summary.slice(0, 100)}...`);
700
+ lines.push('');
701
+ });
702
+ const totalChars = results.reduce((acc, r) => acc + r.contentLength, 0);
703
+ lines.push('');
704
+ lines.push(`Total content: ${totalChars.toLocaleString()} characters across ${results.length} pages`);
705
+ return new FunctionResult(lines.join('\n'));
706
+ }
707
+ async _extractStructuredHandler(args, _rawData) {
708
+ const urlArg = args['url'];
709
+ if (typeof urlArg !== 'string' || urlArg.trim().length === 0) {
710
+ return new FunctionResult('Please provide a URL');
711
+ }
712
+ const url = urlArg.trim();
713
+ if (!/^https?:\/\//.test(url)) {
714
+ return new FunctionResult(`Invalid URL: ${url}`);
715
+ }
716
+ const allowPrivate = process.env['SWML_ALLOW_PRIVATE_URLS'] === 'true';
717
+ try {
718
+ await resolveAndValidateUrl(url, allowPrivate);
719
+ }
720
+ catch {
721
+ return new FunctionResult('URL rejected: cannot access private or internal URLs');
722
+ }
723
+ if (!this.selectors || Object.keys(this.selectors).length === 0) {
724
+ return new FunctionResult('No selectors configured for structured data extraction');
725
+ }
726
+ const cached = await this._fetchUrl(url);
727
+ if (!cached) {
728
+ return new FunctionResult(`Failed to fetch ${url}`);
729
+ }
730
+ const result = this._structuredExtract(cached, this.selectors);
731
+ if ('error' in result) {
732
+ return new FunctionResult(`Error extracting data: ${result['error']}`);
733
+ }
734
+ const lines = [`Extracted data from ${url}:`, ''];
735
+ lines.push(`Title: ${result['title'] || 'N/A'}`);
736
+ lines.push('');
737
+ const data = result['data'];
738
+ if (data && Object.keys(data).length > 0) {
739
+ lines.push('Data:');
740
+ for (const [field, value] of Object.entries(data)) {
741
+ lines.push(`- ${field}: ${String(value)}`);
742
+ }
743
+ }
744
+ else {
745
+ lines.push('No data extracted with provided selectors');
746
+ }
747
+ return new FunctionResult(lines.join('\n'));
748
+ }
749
+ }
750
+ /**
751
+ * Factory function for creating SpiderSkill instances.
752
+ * @param config - Optional skill configuration.
753
+ * @returns A new SpiderSkill instance.
754
+ */
755
+ export function createSkill(config) {
756
+ return new SpiderSkill(config);
757
+ }
758
+ //# sourceMappingURL=spider.js.map