@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
@@ -1,978 +0,0 @@
1
- /**
2
- * Claude Skills — Load Claude-style SKILL.md files as SignalWire agent tools.
3
- *
4
- * Tier 3 built-in skill that parses Claude Code skill directories and makes
5
- * them available as SWAIG tools the AI can call. Each Claude skill becomes a
6
- * tool that returns the skill's instructions when invoked.
7
- *
8
- * Port of Python SDK's `signalwire_agents/skills/claude_skills/skill.py`.
9
- */
10
-
11
- import { readFileSync, readdirSync, statSync, existsSync } from 'node:fs';
12
- import { resolve, join, relative, basename, extname, sep } from 'node:path';
13
- import { execSync } from 'node:child_process';
14
-
15
- import yaml from 'js-yaml';
16
-
17
- import { SkillBase } from '../SkillBase.js';
18
- import type {
19
- SkillToolDefinition,
20
- SkillPromptSection,
21
- SkillConfig,
22
- ParameterSchemaEntry,
23
- } from '../SkillBase.js';
24
- import { FunctionResult } from '../../FunctionResult.js';
25
- import { getLogger } from '../../Logger.js';
26
-
27
- const log = getLogger('ClaudeSkillsSkill');
28
-
29
- // Frontmatter fields that are parsed but not supported in SignalWire agents
30
- const _UNSUPPORTED_FIELDS: Record<string, string> = {
31
- context:
32
- "context: fork is not supported in SignalWire agents — skill '{name}' will run inline, not in a subagent",
33
- agent:
34
- "agent field is not supported in SignalWire agents — skill '{name}' cannot select a subagent type",
35
- 'allowed-tools':
36
- "allowed-tools is not supported in SignalWire agents — skill '{name}' tool restrictions will not be enforced",
37
- model:
38
- "model field is not supported in SignalWire agents — skill '{name}' model selection is controlled at the agent level",
39
- hooks:
40
- "hooks field is not supported in SignalWire agents — skill '{name}' lifecycle hooks will not fire",
41
- };
42
-
43
- // Regex for shell injection patterns: !`command`
44
- const _SHELL_INJECTION_RE = /!`([^`]+)`/g;
45
-
46
- /** Internal representation of a parsed Claude skill. */
47
- interface ParsedSkill {
48
- name: string;
49
- description: string | null;
50
- body: string;
51
- path: string;
52
- skillDir: string;
53
- sections: Map<string, string>;
54
- files: Record<string, string[]>;
55
- disableModelInvocation: boolean;
56
- userInvocable: boolean;
57
- argumentHint: string | null;
58
- license: string | null;
59
- compatibility: string | null;
60
- context: unknown;
61
- agent: unknown;
62
- allowedTools: unknown;
63
- model: unknown;
64
- hooks: unknown;
65
- _skipTool: boolean;
66
- _skipPrompt: boolean;
67
- }
68
-
69
- /**
70
- * Load Claude-style SKILL.md files as SignalWire agent tools.
71
- *
72
- * This skill parses Claude Code skill directories and makes them available
73
- * as SWAIG tools that the AI can call. Each Claude skill becomes a tool
74
- * that returns the skill's instructions when invoked.
75
- */
76
- export class ClaudeSkillsSkill extends SkillBase {
77
- // Python ground truth: skills/claude_skills/skill.py
78
- // Python REQUIRED_PACKAGES = ["yaml"]; TS uses js-yaml but kept [] historically.
79
- static override SKILL_NAME = 'claude_skills';
80
- static override SKILL_DESCRIPTION = 'Load Claude SKILL.md files as agent tools';
81
- static override SKILL_VERSION = '1.0.0';
82
- static override REQUIRED_ENV_VARS: readonly string[] = [];
83
- static override SUPPORTS_MULTIPLE_INSTANCES = true;
84
-
85
- private _skillsPath = '';
86
- private _includePatterns: string[] = ['*'];
87
- private _excludePatterns: string[] = [];
88
- private _allowShellInjection = false;
89
- private _allowScriptExecution = false;
90
- private _ignoreInvocationControl = false;
91
- private _shellTimeout = 30;
92
- private _skills: ParsedSkill[] = [];
93
-
94
- static override getParameterSchema(): Record<string, ParameterSchemaEntry> {
95
- return {
96
- ...super.getParameterSchema(),
97
- skills_path: {
98
- type: 'string',
99
- description:
100
- 'Path to directory containing Claude skill folders (each with SKILL.md)',
101
- required: true,
102
- },
103
- include: {
104
- type: 'array',
105
- description: "Glob patterns for skills to include (default: ['*'])",
106
- default: ['*'],
107
- },
108
- exclude: {
109
- type: 'array',
110
- description: 'Glob patterns for skills to exclude',
111
- default: [],
112
- },
113
- prompt_title: {
114
- type: 'string',
115
- description: 'Title for the prompt section listing skills',
116
- default: 'Claude Skills',
117
- },
118
- prompt_intro: {
119
- type: 'string',
120
- description: 'Introductory text for the prompt section',
121
- default:
122
- 'You have access to specialized skills. Call the appropriate tool when the user\'s question matches:',
123
- },
124
- skill_descriptions: {
125
- type: 'object',
126
- description:
127
- 'Override descriptions for specific skills (skill_name -> description)',
128
- default: {},
129
- },
130
- tool_prefix: {
131
- type: 'string',
132
- description:
133
- "Prefix for generated tool names (default: 'claude_'). Use empty string for no prefix.",
134
- default: 'claude_',
135
- },
136
- response_prefix: {
137
- type: 'string',
138
- description:
139
- 'Text to prepend to skill results (e.g., instructions for the AI)',
140
- default: '',
141
- },
142
- response_postfix: {
143
- type: 'string',
144
- description:
145
- 'Text to append to skill results (e.g., reminders or constraints)',
146
- default: '',
147
- },
148
- allow_shell_injection: {
149
- type: 'boolean',
150
- description:
151
- 'Enable !`command` preprocessing in skill bodies. DANGEROUS: allows arbitrary shell execution.',
152
- default: false,
153
- },
154
- allow_script_execution: {
155
- type: 'boolean',
156
- description:
157
- 'Discover and list scripts/, assets/ files in prompt sections',
158
- default: false,
159
- },
160
- ignore_invocation_control: {
161
- type: 'boolean',
162
- description:
163
- 'Override disable-model-invocation and user-invocable flags, register everything',
164
- default: false,
165
- },
166
- shell_timeout: {
167
- type: 'integer',
168
- description: 'Timeout in seconds for shell injection commands',
169
- default: 30,
170
- },
171
- };
172
- }
173
-
174
- /**
175
- * Setup the Claude skills loader — discovers and parses all SKILL.md files.
176
- *
177
- * Returns `true` on success and `false` on any failure (missing path,
178
- * invalid path, stat failure, or non-directory), mirroring the Python
179
- * skill's `setup() -> bool` contract.
180
- */
181
- override async setup(): Promise<boolean> {
182
- const skillsPath = this.getConfig<string>('skills_path');
183
- if (!skillsPath) {
184
- log.error('claude_skills: skills_path parameter is required');
185
- return false;
186
- }
187
-
188
- this._skillsPath = resolve(skillsPath);
189
-
190
- if (!existsSync(this._skillsPath)) {
191
- log.error(`claude_skills: skills_path does not exist: ${this._skillsPath}`);
192
- return false;
193
- }
194
-
195
- let stat;
196
- try {
197
- stat = statSync(this._skillsPath);
198
- } catch {
199
- log.error(`claude_skills: cannot stat skills_path: ${this._skillsPath}`);
200
- return false;
201
- }
202
- if (!stat.isDirectory()) {
203
- log.error(
204
- `claude_skills: skills_path is not a directory: ${this._skillsPath}`,
205
- );
206
- return false;
207
- }
208
-
209
- // Load include/exclude patterns
210
- this._includePatterns = this.getConfig<string[]>('include', ['*']);
211
- this._excludePatterns = this.getConfig<string[]>('exclude', []);
212
-
213
- // Store safety/control flags
214
- this._allowShellInjection = this.getConfig<boolean>(
215
- 'allow_shell_injection',
216
- false,
217
- );
218
- this._allowScriptExecution = this.getConfig<boolean>(
219
- 'allow_script_execution',
220
- false,
221
- );
222
- this._ignoreInvocationControl = this.getConfig<boolean>(
223
- 'ignore_invocation_control',
224
- false,
225
- );
226
- this._shellTimeout = this.getConfig<number>('shell_timeout', 30);
227
-
228
- if (this._allowShellInjection) {
229
- log.warn(
230
- 'claude_skills: allow_shell_injection is enabled — ' +
231
- 'skill bodies may execute arbitrary shell commands',
232
- );
233
- }
234
-
235
- // Discover and parse skills
236
- this._skills = this._discoverSkills();
237
-
238
- if (this._skills.length === 0) {
239
- log.warn(`claude_skills: no skills found in ${this._skillsPath}`);
240
- }
241
-
242
- log.info(
243
- `claude_skills: loaded ${this._skills.length} skills from ${this._skillsPath}`,
244
- );
245
- return true;
246
- }
247
-
248
- // ---------------------------------------------------------------------------
249
- // Discovery
250
- // ---------------------------------------------------------------------------
251
-
252
- private _discoverSkills(): ParsedSkill[] {
253
- const skills: ParsedSkill[] = [];
254
- let entries: string[];
255
-
256
- try {
257
- entries = readdirSync(this._skillsPath);
258
- } catch {
259
- log.error(
260
- `claude_skills: failed to read skills directory: ${this._skillsPath}`,
261
- );
262
- return skills;
263
- }
264
-
265
- for (const entry of entries) {
266
- const entryPath = join(this._skillsPath, entry);
267
- let stat;
268
- try {
269
- stat = statSync(entryPath);
270
- } catch {
271
- continue;
272
- }
273
- if (!stat.isDirectory()) continue;
274
-
275
- const skillFile = join(entryPath, 'SKILL.md');
276
- if (!existsSync(skillFile)) continue;
277
-
278
- // Check include/exclude patterns
279
- if (!this._matchesPatterns(entry)) {
280
- log.debug(`claude_skills: skipping ${entry} (excluded by patterns)`);
281
- continue;
282
- }
283
-
284
- // Parse the skill
285
- const parsed = this._parseSkillMd(skillFile);
286
- if (!parsed) continue;
287
-
288
- // Use directory name as fallback for skill name
289
- if (!parsed.name) {
290
- parsed.name = entry;
291
- }
292
- parsed.path = skillFile;
293
- parsed.skillDir = entryPath;
294
-
295
- // Discover supporting files (all .md files except SKILL.md)
296
- parsed.sections = this._discoverSections(entryPath);
297
-
298
- // Discover non-.md files if script execution is enabled
299
- if (this._allowScriptExecution) {
300
- parsed.files = this._discoverAllFiles(entryPath);
301
- } else {
302
- parsed.files = {};
303
- }
304
-
305
- // Warn about unsupported frontmatter fields
306
- this._warnUnsupportedFields(parsed);
307
-
308
- // Warn about shell injection patterns if disabled
309
- if (!this._allowShellInjection) {
310
- this._warnShellPatterns(parsed);
311
- }
312
-
313
- // Determine invocation control flags
314
- this._applyInvocationControl(parsed);
315
-
316
- skills.push(parsed);
317
- const sectionCount = parsed.sections.size;
318
- log.debug(
319
- `claude_skills: loaded skill '${parsed.name}' from ${skillFile} with ${sectionCount} sections`,
320
- );
321
- }
322
-
323
- return skills;
324
- }
325
-
326
- private _discoverSections(skillDir: string): Map<string, string> {
327
- const sections = new Map<string, string>();
328
- this._discoverSectionsRecursive(skillDir, skillDir, sections);
329
- return sections;
330
- }
331
-
332
- private _discoverSectionsRecursive(
333
- baseDir: string,
334
- currentDir: string,
335
- sections: Map<string, string>,
336
- ): void {
337
- let entries: string[];
338
- try {
339
- entries = readdirSync(currentDir);
340
- } catch {
341
- return;
342
- }
343
-
344
- for (const entry of entries) {
345
- const fullPath = join(currentDir, entry);
346
- let stat;
347
- try {
348
- stat = statSync(fullPath);
349
- } catch {
350
- continue;
351
- }
352
-
353
- if (stat.isDirectory()) {
354
- this._discoverSectionsRecursive(baseDir, fullPath, sections);
355
- continue;
356
- }
357
-
358
- if (!stat.isFile()) continue;
359
- if (extname(entry).toLowerCase() !== '.md') continue;
360
- if (entry.toUpperCase() === 'SKILL.MD') continue;
361
-
362
- // Calculate relative path from skill dir
363
- const rel = relative(baseDir, fullPath);
364
- const relParts = rel.split(sep);
365
- const stem = basename(entry, '.md');
366
-
367
- let key: string;
368
- if (relParts.length > 1) {
369
- // Nested file: include parent path
370
- const parentPath = relParts.slice(0, -1).join('/');
371
- key = `${parentPath}/${stem}`;
372
- } else {
373
- key = stem;
374
- }
375
-
376
- // Normalize path separators
377
- key = key.replace(/\\/g, '/');
378
- sections.set(key, fullPath);
379
- }
380
- }
381
-
382
- private _discoverAllFiles(
383
- skillDir: string,
384
- ): Record<string, string[]> {
385
- const files: Record<string, string[]> = {
386
- scripts: [],
387
- assets: [],
388
- other: [],
389
- };
390
-
391
- this._discoverAllFilesRecursive(skillDir, skillDir, files);
392
-
393
- // Sort for deterministic output
394
- files.scripts.sort();
395
- files.assets.sort();
396
- files.other.sort();
397
-
398
- return files;
399
- }
400
-
401
- private _discoverAllFilesRecursive(
402
- baseDir: string,
403
- currentDir: string,
404
- files: Record<string, string[]>,
405
- ): void {
406
- let entries: string[];
407
- try {
408
- entries = readdirSync(currentDir);
409
- } catch {
410
- return;
411
- }
412
-
413
- for (const entry of entries) {
414
- const fullPath = join(currentDir, entry);
415
- let stat;
416
- try {
417
- stat = statSync(fullPath);
418
- } catch {
419
- continue;
420
- }
421
-
422
- if (stat.isDirectory()) {
423
- // Skip hidden dirs and __pycache__
424
- if (entry.startsWith('.') || entry === '__pycache__' || entry === 'node_modules') continue;
425
- this._discoverAllFilesRecursive(baseDir, fullPath, files);
426
- continue;
427
- }
428
-
429
- if (!stat.isFile()) continue;
430
-
431
- // Skip .md files (handled by _discoverSections)
432
- if (extname(entry).toLowerCase() === '.md') continue;
433
-
434
- // Skip hidden files
435
- if (entry.startsWith('.')) continue;
436
-
437
- const rel = relative(baseDir, fullPath).replace(/\\/g, '/');
438
- const parts = rel.split('/');
439
-
440
- // Categorize by top-level directory
441
- if (parts[0] === 'scripts') {
442
- files.scripts.push(rel);
443
- } else if (parts[0] === 'assets') {
444
- files.assets.push(rel);
445
- } else {
446
- files.other.push(rel);
447
- }
448
- }
449
- }
450
-
451
- // ---------------------------------------------------------------------------
452
- // Parsing
453
- // ---------------------------------------------------------------------------
454
-
455
- private _parseSkillMd(
456
- filePath: string,
457
- ): ParsedSkill | null {
458
- let content: string;
459
- try {
460
- content = readFileSync(filePath, 'utf-8');
461
- } catch (err) {
462
- log.error(
463
- `claude_skills: failed to read ${filePath}: ${err instanceof Error ? err.message : String(err)}`,
464
- );
465
- return null;
466
- }
467
-
468
- // Check for YAML frontmatter
469
- if (!content.startsWith('---')) {
470
- // No frontmatter — treat entire content as body
471
- return this._buildParsedSkill(null, null, content.trim());
472
- }
473
-
474
- // Split frontmatter from body
475
- const parts = content.split('---', 3);
476
- if (parts.length < 3) {
477
- // Malformed frontmatter
478
- log.warn(`claude_skills: malformed frontmatter in ${filePath}`);
479
- return this._buildParsedSkill(null, null, content.trim());
480
- }
481
-
482
- const frontmatterStr = parts[1].trim();
483
- const body = parts[2].trim();
484
-
485
- // Parse YAML frontmatter
486
- let frontmatter: Record<string, unknown> = {};
487
- try {
488
- const parsed = yaml.load(frontmatterStr);
489
- if (parsed && typeof parsed === 'object' && !Array.isArray(parsed)) {
490
- frontmatter = parsed as Record<string, unknown>;
491
- }
492
- } catch (err) {
493
- log.warn(
494
- `claude_skills: failed to parse YAML in ${filePath}: ${err instanceof Error ? err.message : String(err)}`,
495
- );
496
- }
497
-
498
- return this._buildParsedSkill(
499
- (frontmatter['name'] as string) ?? null,
500
- (frontmatter['description'] as string) ?? null,
501
- body,
502
- frontmatter,
503
- );
504
- }
505
-
506
- private _buildParsedSkill(
507
- name: string | null,
508
- description: string | null,
509
- body: string,
510
- frontmatter?: Record<string, unknown>,
511
- ): ParsedSkill {
512
- const fm = frontmatter ?? {};
513
- return {
514
- name: name ?? '',
515
- description,
516
- body,
517
- path: '',
518
- skillDir: '',
519
- sections: new Map(),
520
- files: {},
521
- disableModelInvocation: (fm['disable-model-invocation'] as boolean) ?? false,
522
- userInvocable: fm['user-invocable'] !== undefined ? (fm['user-invocable'] as boolean) : true,
523
- argumentHint: (fm['argument-hint'] as string) ?? null,
524
- license: (fm['license'] as string) ?? null,
525
- compatibility: (fm['compatibility'] as string) ?? null,
526
- context: fm['context'] ?? null,
527
- agent: fm['agent'] ?? null,
528
- allowedTools: fm['allowed-tools'] ?? null,
529
- model: fm['model'] ?? null,
530
- hooks: fm['hooks'] ?? null,
531
- _skipTool: false,
532
- _skipPrompt: false,
533
- };
534
- }
535
-
536
- // ---------------------------------------------------------------------------
537
- // Pattern matching
538
- // ---------------------------------------------------------------------------
539
-
540
- private _matchesPatterns(name: string): boolean {
541
- // Check excludes first
542
- for (const pattern of this._excludePatterns) {
543
- if (this._fnmatch(name, pattern)) return false;
544
- }
545
- // Check includes
546
- for (const pattern of this._includePatterns) {
547
- if (this._fnmatch(name, pattern)) return true;
548
- }
549
- return false;
550
- }
551
-
552
- /** Simple fnmatch implementation: `*` → `.*`, `?` → `.`, escape the rest. */
553
- private _fnmatch(name: string, pattern: string): boolean {
554
- // Convert glob pattern to regex
555
- let regex = '^';
556
- for (const ch of pattern) {
557
- if (ch === '*') regex += '.*';
558
- else if (ch === '?') regex += '.';
559
- else if ('.+^${}()|[]\\'.includes(ch)) regex += '\\' + ch;
560
- else regex += ch;
561
- }
562
- regex += '$';
563
- return new RegExp(regex, 'i').test(name);
564
- }
565
-
566
- // ---------------------------------------------------------------------------
567
- // Warning helpers
568
- // ---------------------------------------------------------------------------
569
-
570
- private _warnUnsupportedFields(parsed: ParsedSkill): void {
571
- const name = parsed.name || 'unknown';
572
-
573
- const fieldMapping: [keyof ParsedSkill, string][] = [
574
- ['context', 'context'],
575
- ['agent', 'agent'],
576
- ['allowedTools', 'allowed-tools'],
577
- ['model', 'model'],
578
- ['hooks', 'hooks'],
579
- ];
580
-
581
- for (const [parsedKey, frontmatterKey] of fieldMapping) {
582
- const value = parsed[parsedKey];
583
- if (value !== null && value !== undefined) {
584
- const msg = _UNSUPPORTED_FIELDS[frontmatterKey].replace(
585
- '{name}',
586
- name,
587
- );
588
- log.warn(`claude_skills: ${msg}`);
589
- }
590
- }
591
-
592
- // Log informational fields at debug level
593
- if (parsed.license) {
594
- log.debug(
595
- `claude_skills: skill '${name}' has license: ${parsed.license}`,
596
- );
597
- }
598
- if (parsed.compatibility) {
599
- log.debug(
600
- `claude_skills: skill '${name}' has compatibility: ${parsed.compatibility}`,
601
- );
602
- }
603
- }
604
-
605
- private _warnShellPatterns(parsed: ParsedSkill): void {
606
- const name = parsed.name || 'unknown';
607
- const body = parsed.body || '';
608
-
609
- // Reset regex state (global flag)
610
- const re = /!`([^`]+)`/g;
611
- let match: RegExpExecArray | null;
612
- while ((match = re.exec(body)) !== null) {
613
- const command = match[1];
614
- log.warn(
615
- 'claude_skills: shell injection pattern `!' + command + '` found in skill ' +
616
- `'${name}' but allow_shell_injection is disabled — pattern will be ` +
617
- 'passed through as-is. Set allow_shell_injection=True to enable.',
618
- );
619
- }
620
- }
621
-
622
- private _applyInvocationControl(parsed: ParsedSkill): void {
623
- if (this._ignoreInvocationControl) {
624
- parsed._skipTool = false;
625
- parsed._skipPrompt = false;
626
- return;
627
- }
628
-
629
- if (parsed.disableModelInvocation) {
630
- // disable-model-invocation: true → no tool, no prompt
631
- parsed._skipTool = true;
632
- parsed._skipPrompt = true;
633
- log.debug(
634
- `claude_skills: skill '${parsed.name}' has disable-model-invocation=true — skipping tool and prompt`,
635
- );
636
- } else if (!parsed.userInvocable) {
637
- // user-invocable: false → no tool, yes prompt (knowledge-only)
638
- parsed._skipTool = true;
639
- parsed._skipPrompt = false;
640
- log.debug(
641
- `claude_skills: skill '${parsed.name}' has user-invocable=false — skipping tool, keeping prompt`,
642
- );
643
- } else {
644
- // Default: register both
645
- parsed._skipTool = false;
646
- parsed._skipPrompt = false;
647
- }
648
- }
649
-
650
- // ---------------------------------------------------------------------------
651
- // Name sanitization
652
- // ---------------------------------------------------------------------------
653
-
654
- private _sanitizeToolName(name: string): string {
655
- // Replace hyphens and spaces with underscores
656
- let sanitized = name.toLowerCase().replace(/[-\s]+/g, '_');
657
- // Remove any other invalid characters
658
- sanitized = sanitized.replace(/[^a-z0-9_]/g, '');
659
- // Ensure it doesn't start with a number
660
- if (sanitized.length > 0 && /^\d/.test(sanitized)) {
661
- sanitized = '_' + sanitized;
662
- }
663
- return sanitized || 'unnamed';
664
- }
665
-
666
- // ---------------------------------------------------------------------------
667
- // Content processing
668
- // ---------------------------------------------------------------------------
669
-
670
- private _executeShellInjection(
671
- content: string,
672
- skillDir: string,
673
- timeout: number,
674
- ): string {
675
- return content.replace(/!`([^`]+)`/g, (_match, command: string) => {
676
- try {
677
- const result = execSync(command, {
678
- cwd: skillDir,
679
- timeout: timeout * 1000,
680
- encoding: 'utf-8',
681
- stdio: ['pipe', 'pipe', 'pipe'],
682
- });
683
- return result.replace(/\n$/, '');
684
- } catch (err: unknown) {
685
- if (
686
- err &&
687
- typeof err === 'object' &&
688
- 'killed' in err &&
689
- (err as { killed: boolean }).killed
690
- ) {
691
- log.error(
692
- `claude_skills: shell command timed out after ${timeout}s: ${command}`,
693
- );
694
- return `[command timed out: ${command}]`;
695
- }
696
- log.error(`claude_skills: shell command failed: ${command}: ${err instanceof Error ? err.message : String(err)}`);
697
- return `[command error: ${command}]`;
698
- }
699
- });
700
- }
701
-
702
- private _substituteVariables(
703
- content: string,
704
- skillDir: string,
705
- rawData?: Record<string, unknown>,
706
- ): string {
707
- content = content.replace(/\$\{CLAUDE_SKILL_DIR\}/g, skillDir);
708
-
709
- let sessionId = '';
710
- if (rawData) {
711
- sessionId = (rawData['call_id'] as string) ?? '';
712
- }
713
- content = content.replace(/\$\{CLAUDE_SESSION_ID\}/g, sessionId);
714
-
715
- return content;
716
- }
717
-
718
- private _substituteArguments(body: string, arguments_: string): string {
719
- if (!arguments_) arguments_ = '';
720
-
721
- // Check if body contains bare $ARGUMENTS before substitution
722
- const hasBareArguments = /\$ARGUMENTS(?!\[)/.test(body);
723
-
724
- // Split into positional args
725
- const positional = arguments_ ? arguments_.split(/\s+/) : [];
726
-
727
- // Replace $ARGUMENTS[N] with positional args
728
- let result = body.replace(
729
- /\$ARGUMENTS\[(\d+)\]/g,
730
- (_m: string, indexStr: string) => {
731
- const index = parseInt(indexStr, 10);
732
- return index < positional.length ? positional[index] : '';
733
- },
734
- );
735
-
736
- // Replace $N shorthand (must do after $ARGUMENTS to avoid conflicts)
737
- result = result.replace(/\$(\d+)(?!\d)/g, (_m: string, indexStr: string) => {
738
- const index = parseInt(indexStr, 10);
739
- return index < positional.length ? positional[index] : '';
740
- });
741
-
742
- // Replace $ARGUMENTS with full string
743
- result = result.replace(/\$ARGUMENTS/g, arguments_);
744
-
745
- // Fallback: append arguments if body had no bare $ARGUMENTS placeholder
746
- if (!hasBareArguments && arguments_) {
747
- result += `\n\nARGUMENTS: ${arguments_}`;
748
- }
749
-
750
- return result;
751
- }
752
-
753
- // ---------------------------------------------------------------------------
754
- // Tool registration
755
- // ---------------------------------------------------------------------------
756
-
757
- getTools(): SkillToolDefinition[] {
758
- const prefix = this.getConfig<string>('tool_prefix', 'claude_');
759
- const overrides = this.getConfig<Record<string, string>>(
760
- 'skill_descriptions',
761
- {},
762
- );
763
- const responsePrefix = this.getConfig<string>('response_prefix', '');
764
- const responsePostfix = this.getConfig<string>('response_postfix', '');
765
- const tools: SkillToolDefinition[] = [];
766
-
767
- for (const skill of this._skills) {
768
- // Check invocation control — skip tool registration if flagged
769
- if (skill._skipTool) {
770
- log.debug(
771
- `claude_skills: skipping tool registration for '${skill.name}' (invocation control)`,
772
- );
773
- continue;
774
- }
775
-
776
- const toolName = `${prefix}${this._sanitizeToolName(skill.name)}`;
777
-
778
- // Get description (with override support)
779
- const description =
780
- overrides[skill.name] ??
781
- skill.description ??
782
- `Use the ${skill.name} skill`;
783
-
784
- // Build parameters
785
- const parameters: Record<string, unknown> = {
786
- arguments: {
787
- type: 'string',
788
- description:
789
- skill.argumentHint || 'Arguments or context to pass to the skill',
790
- },
791
- };
792
-
793
- // Add section enum if there are supporting files
794
- const sectionNames = Array.from(skill.sections.keys()).sort();
795
- if (sectionNames.length > 0) {
796
- parameters['section'] = {
797
- type: 'string',
798
- description: 'Which reference section to load',
799
- enum: sectionNames,
800
- };
801
- }
802
-
803
- // Create handler that captures the skill and prefix/postfix
804
- const handler = this._makeHandler(
805
- skill,
806
- responsePrefix,
807
- responsePostfix,
808
- );
809
-
810
- tools.push({
811
- name: toolName,
812
- description,
813
- parameters,
814
- handler,
815
- });
816
-
817
- const sectionInfo =
818
- sectionNames.length > 0
819
- ? ` with sections: ${JSON.stringify(sectionNames)}`
820
- : '';
821
- log.debug(`claude_skills: registered tool '${toolName}'${sectionInfo}`);
822
- }
823
-
824
- return tools;
825
- }
826
-
827
- private _makeHandler(
828
- skill: ParsedSkill,
829
- responsePrefix: string,
830
- responsePostfix: string,
831
- ): (
832
- args: Record<string, unknown>,
833
- rawData: Record<string, unknown>,
834
- ) => FunctionResult {
835
- return (
836
- args: Record<string, unknown>,
837
- rawData: Record<string, unknown>,
838
- ): FunctionResult => {
839
- const section = args['section'] as string | undefined;
840
- const arguments_ = (args['arguments'] as string) ?? '';
841
-
842
- let content: string;
843
-
844
- if (section && skill.sections.has(section)) {
845
- // Load the requested section file
846
- try {
847
- content = readFileSync(skill.sections.get(section)!, 'utf-8');
848
- } catch (err) {
849
- log.error(
850
- `claude_skills: failed to read section '${section}': ${err instanceof Error ? err.message : String(err)}`,
851
- );
852
- content = `Error loading section '${section}'`;
853
- }
854
- } else {
855
- // No section specified or invalid — return SKILL.md body
856
- content = skill.body;
857
- }
858
-
859
- const skillDir = skill.skillDir || '.';
860
-
861
- // 1. Shell injection (if enabled)
862
- if (this._allowShellInjection) {
863
- content = this._executeShellInjection(
864
- content,
865
- skillDir,
866
- this._shellTimeout,
867
- );
868
- }
869
-
870
- // 2. Variable substitution
871
- content = this._substituteVariables(content, skillDir, rawData);
872
-
873
- // 3. Argument substitution (with fallback append)
874
- content = this._substituteArguments(content, arguments_);
875
-
876
- // 4. Prefix/postfix wrapping
877
- if (responsePrefix || responsePostfix) {
878
- const parts: string[] = [];
879
- if (responsePrefix) parts.push(responsePrefix);
880
- parts.push(content);
881
- if (responsePostfix) parts.push(responsePostfix);
882
- content = parts.join('\n\n');
883
- }
884
-
885
- return new FunctionResult(content);
886
- };
887
- }
888
-
889
- // ---------------------------------------------------------------------------
890
- // Prompts & hints
891
- // ---------------------------------------------------------------------------
892
-
893
- override getHints(): string[] {
894
- const hints: string[] = [];
895
- for (const skill of this._skills) {
896
- const name = skill.name || '';
897
- hints.push(
898
- ...name
899
- .replace(/-/g, ' ')
900
- .replace(/_/g, ' ')
901
- .split(/\s+/)
902
- .filter((w) => w.length > 0),
903
- );
904
- }
905
- // Deduplicate
906
- return [...new Set(hints)];
907
- }
908
-
909
- protected override _getPromptSections(): SkillPromptSection[] {
910
- if (this._skills.length === 0) return [];
911
-
912
- const prefix = this.getConfig<string>('tool_prefix', 'claude_');
913
- const sections: SkillPromptSection[] = [];
914
-
915
- for (const skill of this._skills) {
916
- // Skip skills marked to exclude from prompt
917
- if (skill._skipPrompt) continue;
918
-
919
- const toolName = `${prefix}${this._sanitizeToolName(skill.name)}`;
920
- const hasTool = !skill._skipTool;
921
-
922
- // Start with the SKILL.md body
923
- let body = skill.body;
924
-
925
- // Append available sections if any
926
- if (skill.sections.size > 0 && hasTool) {
927
- const sectionList = Array.from(skill.sections.keys()).sort().join(', ');
928
- body += `\n\nAvailable reference sections: ${sectionList}`;
929
- body += `\nCall ${toolName}(section="<name>") to load a section.`;
930
- }
931
-
932
- // Append discovered files if script execution is enabled
933
- if (this._allowScriptExecution) {
934
- for (const category of ['scripts', 'assets', 'other'] as const) {
935
- const fileList = skill.files[category] ?? [];
936
- if (fileList.length > 0) {
937
- const label =
938
- category !== 'other'
939
- ? category.charAt(0).toUpperCase() + category.slice(1)
940
- : 'Other files';
941
- body += `\n\n${label}: ${fileList.join(', ')}`;
942
- }
943
- }
944
- }
945
-
946
- sections.push({
947
- title: skill.name,
948
- body,
949
- });
950
- }
951
-
952
- return sections;
953
- }
954
-
955
- // ---------------------------------------------------------------------------
956
- // Instance key
957
- // ---------------------------------------------------------------------------
958
-
959
- override getInstanceKey(): string {
960
- const skillsPath = this.getConfig<string>('skills_path', 'default');
961
- // Use a simple hash for the key
962
- let hash = 0;
963
- for (let i = 0; i < skillsPath.length; i++) {
964
- const ch = skillsPath.charCodeAt(i);
965
- hash = ((hash << 5) - hash + ch) | 0;
966
- }
967
- return `claude_skills_${Math.abs(hash) % 10000}`;
968
- }
969
- }
970
-
971
- /**
972
- * Factory function for creating ClaudeSkillsSkill instances.
973
- * @param config - Optional skill configuration.
974
- * @returns A new ClaudeSkillsSkill instance.
975
- */
976
- export function createSkill(config?: SkillConfig): ClaudeSkillsSkill {
977
- return new ClaudeSkillsSkill(config);
978
- }