@signalwire/sdk 2.0.1 → 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 (610) hide show
  1. package/dist/AgentBase.d.ts +1045 -0
  2. package/dist/AgentBase.js +2375 -0
  3. package/dist/AgentBase.js.map +1 -0
  4. package/dist/AgentServer.d.ts +146 -0
  5. package/dist/AgentServer.js +388 -0
  6. package/dist/AgentServer.js.map +1 -0
  7. package/dist/AuthHandler.d.ts +127 -0
  8. package/dist/AuthHandler.js +212 -0
  9. package/dist/AuthHandler.js.map +1 -0
  10. package/dist/ConfigLoader.d.ts +170 -0
  11. package/dist/ConfigLoader.js +393 -0
  12. package/dist/ConfigLoader.js.map +1 -0
  13. package/dist/ContextBuilder.d.ts +652 -0
  14. package/dist/ContextBuilder.js +1115 -0
  15. package/dist/ContextBuilder.js.map +1 -0
  16. package/dist/DataMap.d.ts +271 -0
  17. package/dist/DataMap.js +430 -0
  18. package/dist/DataMap.js.map +1 -0
  19. package/dist/FunctionResult.d.ts +481 -0
  20. package/dist/FunctionResult.js +775 -0
  21. package/dist/FunctionResult.js.map +1 -0
  22. package/dist/Logger.d.ts +113 -0
  23. package/dist/Logger.js +320 -0
  24. package/dist/Logger.js.map +1 -0
  25. package/dist/PomBuilder.d.ts +208 -0
  26. package/dist/PomBuilder.js +409 -0
  27. package/dist/PomBuilder.js.map +1 -0
  28. package/dist/PromptManager.d.ts +85 -0
  29. package/dist/PromptManager.js +108 -0
  30. package/dist/PromptManager.js.map +1 -0
  31. package/dist/SWMLHandler.d.ts +159 -0
  32. package/dist/SWMLHandler.js +229 -0
  33. package/dist/SWMLHandler.js.map +1 -0
  34. package/dist/SWMLService.d.ts +326 -0
  35. package/dist/SWMLService.js +610 -0
  36. package/dist/SWMLService.js.map +1 -0
  37. package/dist/SchemaUtils.d.ts +108 -0
  38. package/dist/SchemaUtils.js +317 -0
  39. package/dist/SchemaUtils.js.map +1 -0
  40. package/dist/SecurityUtils.d.ts +60 -0
  41. package/{src/SecurityUtils.ts → dist/SecurityUtils.js} +82 -83
  42. package/dist/SecurityUtils.js.map +1 -0
  43. package/dist/ServerlessAdapter.d.ts +119 -0
  44. package/dist/ServerlessAdapter.js +188 -0
  45. package/dist/ServerlessAdapter.js.map +1 -0
  46. package/dist/SessionManager.d.ts +142 -0
  47. package/dist/SessionManager.js +260 -0
  48. package/dist/SessionManager.js.map +1 -0
  49. package/dist/SslConfig.d.ts +77 -0
  50. package/dist/SslConfig.js +100 -0
  51. package/dist/SslConfig.js.map +1 -0
  52. package/dist/SwaigFunction.d.ts +159 -0
  53. package/dist/SwaigFunction.js +209 -0
  54. package/dist/SwaigFunction.js.map +1 -0
  55. package/dist/SwmlBuilder.d.ts +165 -0
  56. package/dist/SwmlBuilder.js +247 -0
  57. package/dist/SwmlBuilder.js.map +1 -0
  58. package/dist/SwmlVerbMethods.generated.d.ts +254 -0
  59. package/dist/SwmlVerbMethods.generated.js +9 -0
  60. package/dist/SwmlVerbMethods.generated.js.map +1 -0
  61. package/dist/TypeInference.d.ts +71 -0
  62. package/dist/TypeInference.js +164 -0
  63. package/dist/TypeInference.js.map +1 -0
  64. package/dist/WebService.d.ts +148 -0
  65. package/dist/WebService.js +532 -0
  66. package/dist/WebService.js.map +1 -0
  67. package/dist/cli/agent-loader.d.ts +22 -0
  68. package/dist/cli/agent-loader.js +144 -0
  69. package/dist/cli/agent-loader.js.map +1 -0
  70. package/dist/cli/mock-data.d.ts +37 -0
  71. package/dist/cli/mock-data.js +80 -0
  72. package/dist/cli/mock-data.js.map +1 -0
  73. package/dist/cli/swaig-test.d.ts +32 -0
  74. package/dist/cli/swaig-test.js +418 -0
  75. package/dist/cli/swaig-test.js.map +1 -0
  76. package/dist/generateVerbTypes.d.ts +11 -0
  77. package/dist/generateVerbTypes.js +265 -0
  78. package/dist/generateVerbTypes.js.map +1 -0
  79. package/{src/index.ts → dist/index.d.ts} +13 -100
  80. package/dist/index.js +152 -0
  81. package/dist/index.js.map +1 -0
  82. package/dist/livewire/index.d.ts +653 -0
  83. package/dist/livewire/index.js +992 -0
  84. package/dist/livewire/index.js.map +1 -0
  85. package/dist/prefabs/ConciergeAgent.d.ts +89 -0
  86. package/dist/prefabs/ConciergeAgent.js +245 -0
  87. package/dist/prefabs/ConciergeAgent.js.map +1 -0
  88. package/dist/prefabs/FAQBotAgent.d.ts +113 -0
  89. package/dist/prefabs/FAQBotAgent.js +329 -0
  90. package/dist/prefabs/FAQBotAgent.js.map +1 -0
  91. package/dist/prefabs/InfoGathererAgent.d.ts +126 -0
  92. package/dist/prefabs/InfoGathererAgent.js +287 -0
  93. package/dist/prefabs/InfoGathererAgent.js.map +1 -0
  94. package/dist/prefabs/ReceptionistAgent.d.ts +104 -0
  95. package/dist/prefabs/ReceptionistAgent.js +303 -0
  96. package/dist/prefabs/ReceptionistAgent.js.map +1 -0
  97. package/dist/prefabs/SurveyAgent.d.ts +148 -0
  98. package/dist/prefabs/SurveyAgent.js +540 -0
  99. package/dist/prefabs/SurveyAgent.js.map +1 -0
  100. package/{src/prefabs/index.ts → dist/prefabs/index.d.ts} +1 -15
  101. package/dist/prefabs/index.js +14 -0
  102. package/dist/prefabs/index.js.map +1 -0
  103. package/dist/relay/Action.d.ts +258 -0
  104. package/dist/relay/Action.js +402 -0
  105. package/dist/relay/Action.js.map +1 -0
  106. package/dist/relay/Call.d.ts +697 -0
  107. package/dist/relay/Call.js +1062 -0
  108. package/dist/relay/Call.js.map +1 -0
  109. package/dist/relay/Deferred.d.ts +44 -0
  110. package/dist/relay/Deferred.js +69 -0
  111. package/dist/relay/Deferred.js.map +1 -0
  112. package/dist/relay/Message.d.ts +103 -0
  113. package/dist/relay/Message.js +169 -0
  114. package/dist/relay/Message.js.map +1 -0
  115. package/dist/relay/RelayClient.d.ts +302 -0
  116. package/dist/relay/RelayClient.js +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/dist/rest/index.d.ts +131 -0
  149. package/{src/rest/index.ts → dist/rest/index.js} +101 -136
  150. package/dist/rest/index.js.map +1 -0
  151. package/dist/rest/namespaces/addresses.d.ts +46 -0
  152. package/dist/rest/namespaces/addresses.js +55 -0
  153. package/dist/rest/namespaces/addresses.js.map +1 -0
  154. package/dist/rest/namespaces/calling.d.ts +382 -0
  155. package/dist/rest/namespaces/calling.js +478 -0
  156. package/dist/rest/namespaces/calling.js.map +1 -0
  157. package/dist/rest/namespaces/chat.d.ts +22 -0
  158. package/dist/rest/namespaces/chat.js +26 -0
  159. package/dist/rest/namespaces/chat.js.map +1 -0
  160. package/dist/rest/namespaces/compat.d.ts +585 -0
  161. package/dist/rest/namespaces/compat.js +735 -0
  162. package/dist/rest/namespaces/compat.js.map +1 -0
  163. package/dist/rest/namespaces/datasphere.d.ts +66 -0
  164. package/dist/rest/namespaces/datasphere.js +77 -0
  165. package/dist/rest/namespaces/datasphere.js.map +1 -0
  166. package/dist/rest/namespaces/fabric.d.ts +282 -0
  167. package/dist/rest/namespaces/fabric.js +373 -0
  168. package/dist/rest/namespaces/fabric.js.map +1 -0
  169. package/dist/rest/namespaces/imported-numbers.d.ts +22 -0
  170. package/dist/rest/namespaces/imported-numbers.js +26 -0
  171. package/dist/rest/namespaces/imported-numbers.js.map +1 -0
  172. package/dist/rest/namespaces/logs.d.ts +105 -0
  173. package/dist/rest/namespaces/logs.js +133 -0
  174. package/dist/rest/namespaces/logs.js.map +1 -0
  175. package/dist/rest/namespaces/lookup.d.ts +29 -0
  176. package/dist/rest/namespaces/lookup.js +32 -0
  177. package/dist/rest/namespaces/lookup.js.map +1 -0
  178. package/dist/rest/namespaces/mfa.d.ts +46 -0
  179. package/dist/rest/namespaces/mfa.js +54 -0
  180. package/dist/rest/namespaces/mfa.js.map +1 -0
  181. package/dist/rest/namespaces/number-groups.d.ts +49 -0
  182. package/dist/rest/namespaces/number-groups.js +58 -0
  183. package/dist/rest/namespaces/number-groups.js.map +1 -0
  184. package/dist/rest/namespaces/phone-numbers.d.ts +60 -0
  185. package/dist/rest/namespaces/phone-numbers.js +67 -0
  186. package/dist/rest/namespaces/phone-numbers.js.map +1 -0
  187. package/dist/rest/namespaces/project.d.ts +46 -0
  188. package/dist/rest/namespaces/project.js +56 -0
  189. package/dist/rest/namespaces/project.js.map +1 -0
  190. package/dist/rest/namespaces/pubsub.d.ts +22 -0
  191. package/dist/rest/namespaces/pubsub.js +26 -0
  192. package/dist/rest/namespaces/pubsub.js.map +1 -0
  193. package/dist/rest/namespaces/queues.d.ts +42 -0
  194. package/dist/rest/namespaces/queues.js +49 -0
  195. package/dist/rest/namespaces/queues.js.map +1 -0
  196. package/dist/rest/namespaces/recordings.d.ts +38 -0
  197. package/dist/rest/namespaces/recordings.js +45 -0
  198. package/dist/rest/namespaces/recordings.js.map +1 -0
  199. package/dist/rest/namespaces/registry.d.ts +141 -0
  200. package/dist/rest/namespaces/registry.js +178 -0
  201. package/dist/rest/namespaces/registry.js.map +1 -0
  202. package/dist/rest/namespaces/short-codes.d.ts +39 -0
  203. package/dist/rest/namespaces/short-codes.js +46 -0
  204. package/dist/rest/namespaces/short-codes.js.map +1 -0
  205. package/dist/rest/namespaces/sip-profile.d.ts +28 -0
  206. package/dist/rest/namespaces/sip-profile.js +34 -0
  207. package/dist/rest/namespaces/sip-profile.js.map +1 -0
  208. package/dist/rest/namespaces/verified-callers.d.ts +33 -0
  209. package/dist/rest/namespaces/verified-callers.js +39 -0
  210. package/dist/rest/namespaces/verified-callers.js.map +1 -0
  211. package/dist/rest/namespaces/video.d.ts +235 -0
  212. package/dist/rest/namespaces/video.js +297 -0
  213. package/dist/rest/namespaces/video.js.map +1 -0
  214. package/{src/rest/pagination.ts → dist/rest/pagination.d.ts} +2 -61
  215. package/dist/rest/pagination.js +78 -0
  216. package/dist/rest/pagination.js.map +1 -0
  217. package/dist/rest/types.d.ts +54 -0
  218. package/dist/rest/types.js +5 -0
  219. package/dist/rest/types.js.map +1 -0
  220. package/dist/skills/SkillBase.d.ts +404 -0
  221. package/dist/skills/SkillBase.js +471 -0
  222. package/dist/skills/SkillBase.js.map +1 -0
  223. package/dist/skills/SkillManager.d.ts +195 -0
  224. package/dist/skills/SkillManager.js +378 -0
  225. package/dist/skills/SkillManager.js.map +1 -0
  226. package/dist/skills/SkillRegistry.d.ts +176 -0
  227. package/dist/skills/SkillRegistry.js +310 -0
  228. package/dist/skills/SkillRegistry.js.map +1 -0
  229. package/dist/skills/builtin/api_ninjas_trivia.d.ts +47 -0
  230. package/dist/skills/builtin/api_ninjas_trivia.js +211 -0
  231. package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -0
  232. package/dist/skills/builtin/ask_claude.d.ts +37 -0
  233. package/dist/skills/builtin/ask_claude.js +162 -0
  234. package/dist/skills/builtin/ask_claude.js.map +1 -0
  235. package/dist/skills/builtin/claude_skills.d.ts +75 -0
  236. package/dist/skills/builtin/claude_skills.js +753 -0
  237. package/dist/skills/builtin/claude_skills.js.map +1 -0
  238. package/dist/skills/builtin/custom_skills.d.ts +79 -0
  239. package/dist/skills/builtin/custom_skills.js +227 -0
  240. package/dist/skills/builtin/custom_skills.js.map +1 -0
  241. package/dist/skills/builtin/datasphere.d.ts +73 -0
  242. package/dist/skills/builtin/datasphere.js +350 -0
  243. package/dist/skills/builtin/datasphere.js.map +1 -0
  244. package/dist/skills/builtin/datasphere_serverless.d.ts +89 -0
  245. package/dist/skills/builtin/datasphere_serverless.js +291 -0
  246. package/dist/skills/builtin/datasphere_serverless.js.map +1 -0
  247. package/dist/skills/builtin/datetime.d.ts +40 -0
  248. package/dist/skills/builtin/datetime.js +118 -0
  249. package/dist/skills/builtin/datetime.js.map +1 -0
  250. package/dist/skills/builtin/google_maps.d.ts +48 -0
  251. package/dist/skills/builtin/google_maps.js +470 -0
  252. package/dist/skills/builtin/google_maps.js.map +1 -0
  253. package/dist/skills/builtin/index.d.ts +31 -0
  254. package/{src/skills/builtin/index.ts → dist/skills/builtin/index.js} +30 -36
  255. package/dist/skills/builtin/index.js.map +1 -0
  256. package/dist/skills/builtin/info_gatherer.d.ts +115 -0
  257. package/dist/skills/builtin/info_gatherer.js +328 -0
  258. package/dist/skills/builtin/info_gatherer.js.map +1 -0
  259. package/dist/skills/builtin/joke.d.ts +41 -0
  260. package/dist/skills/builtin/joke.js +156 -0
  261. package/dist/skills/builtin/joke.js.map +1 -0
  262. package/dist/skills/builtin/math.d.ts +39 -0
  263. package/dist/skills/builtin/math.js +119 -0
  264. package/dist/skills/builtin/math.js.map +1 -0
  265. package/dist/skills/builtin/mcp_gateway.d.ts +82 -0
  266. package/dist/skills/builtin/mcp_gateway.js +574 -0
  267. package/dist/skills/builtin/mcp_gateway.js.map +1 -0
  268. package/dist/skills/builtin/native_vector_search.d.ts +128 -0
  269. package/dist/skills/builtin/native_vector_search.js +752 -0
  270. package/dist/skills/builtin/native_vector_search.js.map +1 -0
  271. package/dist/skills/builtin/play_background_file.d.ts +59 -0
  272. package/dist/skills/builtin/play_background_file.js +274 -0
  273. package/dist/skills/builtin/play_background_file.js.map +1 -0
  274. package/dist/skills/builtin/spider.d.ts +91 -0
  275. package/dist/skills/builtin/spider.js +758 -0
  276. package/dist/skills/builtin/spider.js.map +1 -0
  277. package/dist/skills/builtin/swml_transfer.d.ts +66 -0
  278. package/dist/skills/builtin/swml_transfer.js +475 -0
  279. package/dist/skills/builtin/swml_transfer.js.map +1 -0
  280. package/dist/skills/builtin/weather_api.d.ts +59 -0
  281. package/dist/skills/builtin/weather_api.js +196 -0
  282. package/dist/skills/builtin/weather_api.js.map +1 -0
  283. package/dist/skills/builtin/web_search.d.ts +160 -0
  284. package/dist/skills/builtin/web_search.js +894 -0
  285. package/dist/skills/builtin/web_search.js.map +1 -0
  286. package/dist/skills/builtin/wikipedia_search.d.ts +77 -0
  287. package/dist/skills/builtin/wikipedia_search.js +241 -0
  288. package/dist/skills/builtin/wikipedia_search.js.map +1 -0
  289. package/{src/skills/index.ts → dist/skills/index.d.ts} +0 -1
  290. package/dist/skills/index.js +10 -0
  291. package/dist/skills/index.js.map +1 -0
  292. package/dist/types.d.ts +118 -0
  293. package/dist/types.js +5 -0
  294. package/dist/types.js.map +1 -0
  295. package/package.json +7 -1
  296. package/.github/workflows/publish.yml +0 -27
  297. package/.github/workflows/test.yml +0 -17
  298. package/CLAUDE.md +0 -112
  299. package/docs/MIGRATION-2.0.md +0 -81
  300. package/docs/agent-guide.md +0 -869
  301. package/docs/agent_guide.md +0 -1026
  302. package/docs/api-reference.md +0 -2420
  303. package/docs/api_reference.md +0 -1301
  304. package/docs/architecture.md +0 -843
  305. package/docs/cli-guide.md +0 -579
  306. package/docs/cli_guide.md +0 -448
  307. package/docs/cloud_functions_guide.md +0 -474
  308. package/docs/configuration.md +0 -422
  309. package/docs/contexts-guide.md +0 -787
  310. package/docs/contexts_guide.md +0 -511
  311. package/docs/datamap-guide.md +0 -1141
  312. package/docs/datamap_guide.md +0 -595
  313. package/docs/llm_parameters.md +0 -239
  314. package/docs/mcp_gateway_reference.md +0 -648
  315. package/docs/mcp_integration.md +0 -108
  316. package/docs/prefabs-guide.md +0 -800
  317. package/docs/sdk_features.md +0 -477
  318. package/docs/security.md +0 -436
  319. package/docs/serverless-guide.md +0 -513
  320. package/docs/skills-guide.md +0 -857
  321. package/docs/skills-system.md +0 -301
  322. package/docs/skills_parameter_schema.md +0 -392
  323. package/docs/skills_system.md +0 -467
  324. package/docs/swaig-reference.md +0 -1627
  325. package/docs/swaig_reference.md +0 -910
  326. package/docs/swml_service_guide.md +0 -600
  327. package/docs/third_party_skills.md +0 -533
  328. package/docs/web_service.md +0 -677
  329. package/examples/README.md +0 -131
  330. package/examples/advanced-datamap.ts +0 -100
  331. package/examples/advanced-dynamic-config.ts +0 -70
  332. package/examples/auto-vivified.ts +0 -94
  333. package/examples/call-flow.ts +0 -63
  334. package/examples/comprehensive-dynamic.ts +0 -125
  335. package/examples/contexts-steps.ts +0 -65
  336. package/examples/custom-path.ts +0 -45
  337. package/examples/datamap-tools.ts +0 -55
  338. package/examples/datasphere-multi-instance.ts +0 -63
  339. package/examples/datasphere-serverless-env.ts +0 -68
  340. package/examples/datasphere-webhook-env.ts +0 -66
  341. package/examples/datasphere.ts +0 -37
  342. package/examples/declarative.ts +0 -100
  343. package/examples/dynamic-config.ts +0 -54
  344. package/examples/dynamic-info-gatherer.ts +0 -69
  345. package/examples/dynamic-swml-service.ts +0 -67
  346. package/examples/gather-info.ts +0 -71
  347. package/examples/gather-per-question-functions-demo.ts +0 -140
  348. package/examples/joke-agent.ts +0 -34
  349. package/examples/kubernetes-agent.ts +0 -45
  350. package/examples/llm-params.ts +0 -69
  351. package/examples/mcp-agent.ts +0 -84
  352. package/examples/mcp-gateway.ts +0 -35
  353. package/examples/multi-agent.ts +0 -73
  354. package/examples/multi-endpoint.ts +0 -79
  355. package/examples/pom-prompt.ts +0 -71
  356. package/examples/prefab-concierge.ts +0 -47
  357. package/examples/prefab-faq.ts +0 -54
  358. package/examples/prefab-info-gatherer.ts +0 -33
  359. package/examples/prefab-receptionist.ts +0 -36
  360. package/examples/prefab-survey.ts +0 -68
  361. package/examples/record-call.ts +0 -67
  362. package/examples/relay-demo.ts +0 -33
  363. package/examples/room-and-sip.ts +0 -94
  364. package/examples/serverless-lambda.ts +0 -35
  365. package/examples/session-state.ts +0 -83
  366. package/examples/simple-agent.ts +0 -36
  367. package/examples/simple-static.ts +0 -29
  368. package/examples/skills-demo.ts +0 -38
  369. package/examples/step-function-inheritance-demo.ts +0 -124
  370. package/examples/swaig-features.ts +0 -187
  371. package/examples/swml-service-routing.ts +0 -66
  372. package/examples/swml-service.ts +0 -38
  373. package/examples/tap.ts +0 -68
  374. package/examples/verb-methods.ts +0 -45
  375. package/examples/web-search-multi-instance.ts +0 -72
  376. package/examples/web-search.ts +0 -38
  377. package/examples/wikipedia.ts +0 -36
  378. package/livewire/README.md +0 -140
  379. package/livewire/docs/migration-guide.md +0 -228
  380. package/livewire/examples/livewire-basic-agent.ts +0 -74
  381. package/livewire/examples/livewire-handoff.ts +0 -197
  382. package/livewire/examples/livewire-multi-tool.ts +0 -117
  383. package/relay/README.md +0 -70
  384. package/relay/RELAY_IMPLEMENTATION_GUIDE.md +0 -1257
  385. package/relay/docs/call-methods.md +0 -474
  386. package/relay/docs/client-reference.md +0 -142
  387. package/relay/docs/events.md +0 -134
  388. package/relay/docs/getting-started.md +0 -134
  389. package/relay/docs/guide.md +0 -306
  390. package/relay/docs/messaging.md +0 -182
  391. package/relay/examples/relay-inbound.ts +0 -66
  392. package/relay/examples/relay-messaging.ts +0 -71
  393. package/relay/examples/relay-outbound.ts +0 -76
  394. package/rest/README.md +0 -95
  395. package/rest/docs/calling.md +0 -273
  396. package/rest/docs/client-reference.md +0 -107
  397. package/rest/docs/compat.md +0 -204
  398. package/rest/docs/fabric.md +0 -183
  399. package/rest/docs/getting-started.md +0 -110
  400. package/rest/docs/guide.md +0 -351
  401. package/rest/docs/namespaces.md +0 -285
  402. package/rest/examples/rest-10dlc-registration.ts +0 -161
  403. package/rest/examples/rest-calling-ivr-and-ai.ts +0 -102
  404. package/rest/examples/rest-calling-play-and-record.ts +0 -91
  405. package/rest/examples/rest-client.ts +0 -65
  406. package/rest/examples/rest-compat-laml.ts +0 -210
  407. package/rest/examples/rest-datasphere-search.ts +0 -82
  408. package/rest/examples/rest-fabric-conferences-and-routing.ts +0 -144
  409. package/rest/examples/rest-fabric-subscribers-and-sip.ts +0 -108
  410. package/rest/examples/rest-fabric-swml-and-callflows.ts +0 -99
  411. package/rest/examples/rest-manage-resources.ts +0 -65
  412. package/rest/examples/rest-phone-number-management.ts +0 -197
  413. package/rest/examples/rest-queues-mfa-and-recordings.ts +0 -143
  414. package/rest/examples/rest-video-rooms.ts +0 -186
  415. package/src/AgentBase.ts +0 -2598
  416. package/src/AgentServer.ts +0 -442
  417. package/src/AuthHandler.ts +0 -256
  418. package/src/ConfigLoader.ts +0 -447
  419. package/src/ContextBuilder.ts +0 -1181
  420. package/src/DataMap.ts +0 -477
  421. package/src/FunctionResult.ts +0 -903
  422. package/src/Logger.ts +0 -337
  423. package/src/PomBuilder.ts +0 -467
  424. package/src/PromptManager.ts +0 -133
  425. package/src/SWMLHandler.ts +0 -298
  426. package/src/SWMLService.ts +0 -749
  427. package/src/SchemaUtils.ts +0 -361
  428. package/src/ServerlessAdapter.ts +0 -240
  429. package/src/SessionManager.ts +0 -311
  430. package/src/SslConfig.ts +0 -118
  431. package/src/SwaigFunction.ts +0 -276
  432. package/src/SwmlBuilder.ts +0 -283
  433. package/src/SwmlVerbMethods.generated.ts +0 -234
  434. package/src/TypeInference.ts +0 -199
  435. package/src/WebService.ts +0 -641
  436. package/src/cli/agent-loader.ts +0 -166
  437. package/src/cli/mock-data.ts +0 -111
  438. package/src/cli/swaig-test.ts +0 -452
  439. package/src/generateVerbTypes.ts +0 -322
  440. package/src/livewire/index.ts +0 -1252
  441. package/src/prefabs/ConciergeAgent.ts +0 -309
  442. package/src/prefabs/FAQBotAgent.ts +0 -415
  443. package/src/prefabs/InfoGathererAgent.ts +0 -379
  444. package/src/prefabs/ReceptionistAgent.ts +0 -395
  445. package/src/prefabs/SurveyAgent.ts +0 -671
  446. package/src/relay/Action.ts +0 -482
  447. package/src/relay/Call.ts +0 -1270
  448. package/src/relay/Deferred.ts +0 -94
  449. package/src/relay/Message.ts +0 -199
  450. package/src/relay/RelayClient.ts +0 -1185
  451. package/src/relay/RelayError.ts +0 -20
  452. package/src/relay/RelayEvent.ts +0 -944
  453. package/src/relay/index.ts +0 -123
  454. package/src/relay/types.ts +0 -149
  455. package/src/rest/HttpClient.ts +0 -164
  456. package/src/rest/RestError.ts +0 -45
  457. package/src/rest/base/BaseResource.ts +0 -32
  458. package/src/rest/base/CrudResource.ts +0 -98
  459. package/src/rest/base/CrudWithAddresses.ts +0 -37
  460. package/src/rest/namespaces/addresses.ts +0 -64
  461. package/src/rest/namespaces/calling.ts +0 -534
  462. package/src/rest/namespaces/chat.ts +0 -31
  463. package/src/rest/namespaces/compat.ts +0 -812
  464. package/src/rest/namespaces/datasphere.ts +0 -88
  465. package/src/rest/namespaces/fabric.ts +0 -417
  466. package/src/rest/namespaces/imported-numbers.ts +0 -31
  467. package/src/rest/namespaces/logs.ts +0 -151
  468. package/src/rest/namespaces/lookup.ts +0 -38
  469. package/src/rest/namespaces/mfa.ts +0 -61
  470. package/src/rest/namespaces/number-groups.ts +0 -68
  471. package/src/rest/namespaces/phone-numbers.ts +0 -76
  472. package/src/rest/namespaces/project.ts +0 -65
  473. package/src/rest/namespaces/pubsub.ts +0 -31
  474. package/src/rest/namespaces/queues.ts +0 -58
  475. package/src/rest/namespaces/recordings.ts +0 -53
  476. package/src/rest/namespaces/registry.ts +0 -200
  477. package/src/rest/namespaces/short-codes.ts +0 -54
  478. package/src/rest/namespaces/sip-profile.ts +0 -40
  479. package/src/rest/namespaces/verified-callers.ts +0 -46
  480. package/src/rest/namespaces/video.ts +0 -332
  481. package/src/rest/types.ts +0 -61
  482. package/src/skills/SkillBase.ts +0 -582
  483. package/src/skills/SkillManager.ts +0 -419
  484. package/src/skills/SkillRegistry.ts +0 -367
  485. package/src/skills/builtin/api_ninjas_trivia.ts +0 -285
  486. package/src/skills/builtin/ask_claude.ts +0 -246
  487. package/src/skills/builtin/claude_skills.ts +0 -983
  488. package/src/skills/builtin/custom_skills.ts +0 -327
  489. package/src/skills/builtin/datasphere.ts +0 -447
  490. package/src/skills/builtin/datasphere_serverless.ts +0 -347
  491. package/src/skills/builtin/datetime.ts +0 -137
  492. package/src/skills/builtin/google_maps.ts +0 -656
  493. package/src/skills/builtin/info_gatherer.ts +0 -415
  494. package/src/skills/builtin/joke.ts +0 -196
  495. package/src/skills/builtin/math.ts +0 -149
  496. package/src/skills/builtin/mcp_gateway.ts +0 -685
  497. package/src/skills/builtin/native_vector_search.ts +0 -910
  498. package/src/skills/builtin/play_background_file.ts +0 -367
  499. package/src/skills/builtin/spider.ts +0 -874
  500. package/src/skills/builtin/swml_transfer.ts +0 -645
  501. package/src/skills/builtin/weather_api.ts +0 -255
  502. package/src/skills/builtin/web_search.ts +0 -1083
  503. package/src/skills/builtin/wikipedia_search.ts +0 -304
  504. package/src/types.ts +0 -132
  505. package/tests/AgentBase.test.ts +0 -1093
  506. package/tests/AgentServer.test.ts +0 -126
  507. package/tests/AuthHandler.test.ts +0 -133
  508. package/tests/ConfigLoader.test.ts +0 -151
  509. package/tests/ContextBuilder.test.ts +0 -108
  510. package/tests/DataMap.test.ts +0 -367
  511. package/tests/EphemeralSkillCopy.test.ts +0 -107
  512. package/tests/FunctionResult.test.ts +0 -298
  513. package/tests/GracefulShutdown.test.ts +0 -46
  514. package/tests/Logger.test.ts +0 -420
  515. package/tests/PomBuilder.test.ts +0 -228
  516. package/tests/ProxyDetection.test.ts +0 -228
  517. package/tests/SWMLService.test.ts +0 -320
  518. package/tests/SWMLVerbHandler.test.ts +0 -523
  519. package/tests/SchemaUtils.test.ts +0 -106
  520. package/tests/SchemaUtils.verb.test.ts +0 -206
  521. package/tests/SecurityUtils.test.ts +0 -192
  522. package/tests/ServerlessAdapter.test.ts +0 -222
  523. package/tests/SessionManager.test.ts +0 -257
  524. package/tests/SkillBaseFeatures.test.ts +0 -130
  525. package/tests/SkillMultiInstance.test.ts +0 -102
  526. package/tests/SkillParameterSchemas.test.ts +0 -134
  527. package/tests/SkillRegistrySchema.test.ts +0 -84
  528. package/tests/SslConfig.test.ts +0 -97
  529. package/tests/SwmlBuilder.test.ts +0 -400
  530. package/tests/TypeInference.test.ts +0 -165
  531. package/tests/VerbHandlerRegistry.test.ts +0 -128
  532. package/tests/cli/mock-data.test.ts +0 -113
  533. package/tests/cli/swaig-test.test.ts +0 -108
  534. package/tests/examples.test.ts +0 -194
  535. package/tests/fixtures/scrape-parity/README.md +0 -53
  536. package/tests/fixtures/scrape-parity/expected/01_simple_article.json +0 -5
  537. package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +0 -5
  538. package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +0 -5
  539. package/tests/fixtures/scrape-parity/expected/04_bare_body.json +0 -5
  540. package/tests/fixtures/scrape-parity/expected/05_malformed.json +0 -5
  541. package/tests/fixtures/scrape-parity/expected/06_multi_class.json +0 -5
  542. package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +0 -5
  543. package/tests/fixtures/scrape-parity/expected/08_inline_script.json +0 -5
  544. package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +0 -5
  545. package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +0 -5
  546. package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +0 -5
  547. package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +0 -5
  548. package/tests/fixtures/scrape-parity/html/01_simple_article.html +0 -18
  549. package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +0 -18
  550. package/tests/fixtures/scrape-parity/html/03_nested_containers.html +0 -13
  551. package/tests/fixtures/scrape-parity/html/04_bare_body.html +0 -9
  552. package/tests/fixtures/scrape-parity/html/05_malformed.html +0 -11
  553. package/tests/fixtures/scrape-parity/html/06_multi_class.html +0 -18
  554. package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +0 -12
  555. package/tests/fixtures/scrape-parity/html/08_inline_script.html +0 -17
  556. package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +0 -21
  557. package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +0 -10
  558. package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +0 -13
  559. package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +0 -24
  560. package/tests/fixtures/scrape-parity/python_extract.py +0 -109
  561. package/tests/livewire/livewire.test.ts +0 -780
  562. package/tests/mcp.test.ts +0 -221
  563. package/tests/prefabs/prefabs.test.ts +0 -1093
  564. package/tests/relay/Action.test.ts +0 -392
  565. package/tests/relay/Call.test.ts +0 -535
  566. package/tests/relay/Deferred.test.ts +0 -71
  567. package/tests/relay/Message.test.ts +0 -164
  568. package/tests/relay/RelayClient.test.ts +0 -779
  569. package/tests/relay/RelayEvent.test.ts +0 -463
  570. package/tests/relay/helpers.ts +0 -79
  571. package/tests/rest/HttpClient.test.ts +0 -274
  572. package/tests/rest/RestError.test.ts +0 -53
  573. package/tests/rest/calling.test.ts +0 -156
  574. package/tests/rest/client.test.ts +0 -197
  575. package/tests/rest/compat.test.ts +0 -335
  576. package/tests/rest/datasphere.test.ts +0 -71
  577. package/tests/rest/fabric.test.ts +0 -186
  578. package/tests/rest/helpers.ts +0 -95
  579. package/tests/rest/logs.test.ts +0 -68
  580. package/tests/rest/pagination.test.ts +0 -133
  581. package/tests/rest/registry.test.ts +0 -94
  582. package/tests/rest/relay-rest.test.ts +0 -290
  583. package/tests/rest/video.test.ts +0 -173
  584. package/tests/setup.ts +0 -6
  585. package/tests/skills/SkillBase.test.ts +0 -108
  586. package/tests/skills/SkillManager.test.ts +0 -268
  587. package/tests/skills/SkillRegistry.test.ts +0 -176
  588. package/tests/skills/builtin.test.ts +0 -1472
  589. package/tests/skills/claude-skills.test.ts +0 -54
  590. package/tests/skills/custom-skills.test.ts +0 -53
  591. package/tests/skills/datasphere-serverless.test.ts +0 -70
  592. package/tests/skills/datasphere.test.ts +0 -107
  593. package/tests/skills/datetime.test.ts +0 -101
  594. package/tests/skills/google-maps.test.ts +0 -78
  595. package/tests/skills/info-gatherer.test.ts +0 -411
  596. package/tests/skills/joke.test.ts +0 -81
  597. package/tests/skills/math.test.ts +0 -68
  598. package/tests/skills/mcp-gateway.test.ts +0 -101
  599. package/tests/skills/play-background.test.ts +0 -54
  600. package/tests/skills/spider.test.ts +0 -108
  601. package/tests/skills/swml-transfer.test.ts +0 -178
  602. package/tests/skills/trivia.test.ts +0 -54
  603. package/tests/skills/vector-search.test.ts +0 -135
  604. package/tests/skills/weather-api.test.ts +0 -77
  605. package/tests/skills/web-search-parity.test.ts +0 -59
  606. package/tests/skills/web-search.test.ts +0 -103
  607. package/tests/skills/wikipedia.test.ts +0 -63
  608. package/tsconfig.json +0 -18
  609. package/vitest.config.ts +0 -9
  610. /package/{src → dist}/schema.json +0 -0
@@ -1,582 +0,0 @@
1
- /**
2
- * SkillBase - Abstract base class for agent skills.
3
- *
4
- * Skills are modular capabilities that can be added to an agent.
5
- * They define tools, prompt sections, hints, and global data.
6
- */
7
-
8
- import { randomBytes } from 'node:crypto';
9
- import type { SwaigHandler } from '../SwaigFunction.js';
10
- import type { FunctionResult } from '../FunctionResult.js';
11
- import type { AgentBase } from '../AgentBase.js';
12
- import { getLogger, type Logger } from '../Logger.js';
13
-
14
- /** Configuration key-value pairs passed to a skill at construction time. */
15
- export interface SkillConfig {
16
- [key: string]: unknown;
17
- }
18
-
19
- /** Definition of a SWAIG tool provided by a skill. */
20
- export interface SkillToolDefinition {
21
- /** Unique tool name used in SWAIG function registration. */
22
- name: string;
23
- /** Human-readable description of what the tool does, shown to the AI. */
24
- description: string;
25
- /** Parameter schema for the tool, keyed by parameter name. */
26
- parameters?: Record<string, unknown>;
27
- /** Handler function invoked when the tool is called. */
28
- handler: SwaigHandler;
29
- /** Whether the tool requires secure (authenticated) invocation. */
30
- secure?: boolean;
31
- /** Filler phrases spoken while the tool executes, keyed by language. */
32
- fillers?: Record<string, string[]>;
33
- /** List of parameter names that are required. */
34
- required?: string[];
35
- /** If true, wait for any in-flight fillers to complete before executing the tool. */
36
- wait_for_fillers?: boolean;
37
- /** If true, suppress filler phrases while the tool executes. */
38
- skip_fillers?: boolean;
39
- /**
40
- * When true, the SignalWire platform automatically invokes this tool when
41
- * the call ends (hangup), regardless of whether the AI explicitly calls it.
42
- * Equivalent to Python's `is_hangup_hook=True` in `define_tool()`.
43
- * The flag is serialised as `"is_hangup_hook": true` in the SWAIG JSON.
44
- */
45
- isHangupHook?: boolean;
46
- }
47
-
48
- /** A section of prompt content injected into the agent's system prompt by a skill. */
49
- export interface SkillPromptSection {
50
- /** Section heading displayed in the prompt. */
51
- title: string;
52
- /** Optional body text for the section. */
53
- body?: string;
54
- /** Optional bullet points appended after the body. */
55
- bullets?: string[];
56
- /** If true, render bullets as a numbered list instead of unordered. */
57
- numbered?: boolean;
58
- }
59
-
60
- /** Schema entry describing a single skill configuration parameter. */
61
- export interface ParameterSchemaEntry {
62
- /** JSON Schema type of the parameter value. */
63
- type: 'string' | 'number' | 'integer' | 'boolean' | 'object' | 'array';
64
- /** Human-readable description of the parameter. */
65
- description: string;
66
- /** Default value used when the parameter is not provided. */
67
- default?: unknown;
68
- /** Whether the parameter must be supplied. */
69
- required?: boolean;
70
- /** Whether the parameter should be hidden from user-facing output (e.g., API keys). */
71
- hidden?: boolean;
72
- /** Environment variable that can supply this parameter's value. */
73
- env_var?: string;
74
- /** Allowed values for the parameter. */
75
- enum?: unknown[];
76
- /** Minimum value (for numeric types). */
77
- min?: number;
78
- /** Maximum value (for numeric types). */
79
- max?: number;
80
- /** Item schema for array-type parameters. */
81
- items?: Record<string, unknown>;
82
- }
83
-
84
- /**
85
- * Abstract base class for agent skills.
86
- *
87
- * Skills are modular, reusable capabilities that plug into an {@link AgentBase}.
88
- * A single skill can contribute:
89
- *
90
- * - **Tools** (SWAIG functions) via `getTools()` or `defineTool()`
91
- * - **Prompt sections** via `_getPromptSections()`
92
- * - **Speech hints** via `getHints()`
93
- * - **Global data** seeded into each call via `getGlobalData()`
94
- *
95
- * Skills are added to an agent with `agent.addSkill('name', config)` and the
96
- * {@link SkillManager} calls `setAgent()` + `setup()` in sequence before the
97
- * agent starts serving requests.
98
- *
99
- * @example Custom skill
100
- * ```ts
101
- * import { SkillBase, FunctionResult, type SkillToolDefinition } from '@signalwire/sdk';
102
- *
103
- * export class GreetingSkill extends SkillBase {
104
- * static override SKILL_NAME = 'greeting';
105
- * static override SKILL_DESCRIPTION = 'Responds with a configurable greeting.';
106
- *
107
- * override getTools(): SkillToolDefinition[] {
108
- * return [{
109
- * name: 'say_hello',
110
- * description: 'Say a friendly hello.',
111
- * parameters: { type: 'object', properties: {} },
112
- * handler: () => new FunctionResult(this.getConfig('message', 'Hi!')),
113
- * }];
114
- * }
115
- * }
116
- *
117
- * // In your agent:
118
- * agent.addSkill(new GreetingSkill({ message: 'Howdy!' }));
119
- * ```
120
- *
121
- * @see {@link SkillManager}
122
- * @see {@link SkillRegistry}
123
- * @see {@link AgentBase.addSkill}
124
- */
125
- export abstract class SkillBase {
126
- /**
127
- * Unique skill name. Subclasses MUST override with a non-empty string.
128
- *
129
- * Python parity: `SKILL_NAME: str = None` at `core/skill_base.py:23`.
130
- * Python raises `ValueError` in `__init__` when this is left as `None`;
131
- * TS throws at construction when this is left as the empty default.
132
- */
133
- static SKILL_NAME: string = '';
134
-
135
- /**
136
- * Human-readable description of the skill. Subclasses MUST override.
137
- *
138
- * Python parity: `SKILL_DESCRIPTION: str = None` at `core/skill_base.py:24`.
139
- */
140
- static SKILL_DESCRIPTION: string = '';
141
-
142
- /**
143
- * Semantic version string. Subclasses may override; defaults to `"1.0.0"`.
144
- *
145
- * Python parity: `SKILL_VERSION: str = "1.0.0"` at `core/skill_base.py:25`.
146
- */
147
- static SKILL_VERSION: string = '1.0.0';
148
-
149
- /**
150
- * Packages required by the skill, checked at load time by `validatePackages()`.
151
- *
152
- * Python parity: `REQUIRED_PACKAGES: List[str] = []` at `core/skill_base.py:26`.
153
- * In TS these are npm package names importable via dynamic `import()`.
154
- */
155
- static REQUIRED_PACKAGES: readonly string[] = [];
156
-
157
- /**
158
- * Environment variables required for the skill to function, checked at load
159
- * time by `validateEnvVars()`.
160
- *
161
- * Python parity: `REQUIRED_ENV_VARS: List[str] = []` at `core/skill_base.py:27`.
162
- */
163
- static REQUIRED_ENV_VARS: readonly string[] = [];
164
-
165
- /**
166
- * Whether this skill type supports multiple simultaneous instances (e.g., with different tool_name).
167
- *
168
- * Python parity: `SUPPORTS_MULTIPLE_INSTANCES: bool = False` at `core/skill_base.py:30`.
169
- */
170
- static SUPPORTS_MULTIPLE_INSTANCES = false;
171
-
172
- /**
173
- * Get the parameter schema for this skill class, describing all accepted configuration options.
174
- * Subclasses should override and call `super.getParameterSchema()` to include base parameters.
175
- *
176
- * Mirrors Python's `SkillBase.get_parameter_schema()` (skill_base.py:197-266):
177
- * returns `swaig_fields` + `skip_prompt` for all skills, and additionally adds a
178
- * `tool_name` entry with `default: cls.SKILL_NAME` for classes with
179
- * `SUPPORTS_MULTIPLE_INSTANCES = true`.
180
- *
181
- * @returns Record mapping parameter names to their schema entries.
182
- */
183
- static getParameterSchema(): Record<string, ParameterSchemaEntry> {
184
- const schema: Record<string, ParameterSchemaEntry> = {
185
- swaig_fields: {
186
- type: 'object',
187
- description: 'Additional SWAIG fields to merge into each tool definition provided by this skill.',
188
- default: {},
189
- required: false,
190
- },
191
- skip_prompt: {
192
- type: 'boolean',
193
- description: 'When true, suppress all prompt sections from this skill.',
194
- default: false,
195
- required: false,
196
- },
197
- };
198
- if (this.SUPPORTS_MULTIPLE_INSTANCES) {
199
- schema['tool_name'] = {
200
- type: 'string',
201
- description: 'Custom name for this skill instance (for multiple instances).',
202
- // Python `core/skill_base.py:261`: `default: cls.SKILL_NAME`.
203
- default: this.SKILL_NAME || undefined,
204
- required: false,
205
- };
206
- }
207
- return schema;
208
- }
209
-
210
- /** The registered name of this skill type. */
211
- readonly skillName: string;
212
- /** Unique identifier for this skill instance (includes timestamp and random bytes). */
213
- readonly instanceId: string;
214
- /** Configuration options provided at construction time. */
215
- protected config: SkillConfig;
216
- /** Additional SWAIG fields extracted from config, merged into tool definitions. */
217
- readonly swaigFields: Record<string, unknown>;
218
- /**
219
- * Reference to the agent that owns this skill.
220
- * Set via `setAgent()` when the skill is added to an agent.
221
- * Python equivalent: `self.agent` (set in `__init__`).
222
- *
223
- * In the Python SDK `agent` is always non-null because it is injected in the
224
- * constructor. In the TypeScript SDK the SkillManager always calls
225
- * `setAgent()` before `setup()`, so subclasses can rely on `getAgent()` being
226
- * safe to call inside `setup()` and any method invoked after it.
227
- */
228
- protected agent?: AgentBase;
229
- /**
230
- * Logger scoped to this skill. Python equivalent: `self.logger = get_logger(...)`
231
- * set in `SkillBase.__init__` so every subclass can call `self.logger.info(...)`.
232
- */
233
- protected readonly logger: Logger;
234
- private _initialized = false;
235
-
236
- /**
237
- * Tools registered imperatively via `defineTool()`.
238
- *
239
- * Python parity: Python's `SkillBase.register_tools()` is a `@abstractmethod` that
240
- * calls `self.agent.define_tool(...)` (or `self.define_tool(...)`) once per tool.
241
- * In TypeScript the tool pipeline is declarative (pull model): `SkillManager`
242
- * calls `getTools()` at SWML render time. Skills that want to build their tool
243
- * list imperatively (e.g. to branch on config at setup time) can push into this
244
- * collection via `defineTool()`; the default `getTools()` returns it.
245
- */
246
- protected _dynamicTools: SkillToolDefinition[] = [];
247
-
248
- /**
249
- * Return the agent that owns this skill, asserting it is non-null.
250
- * Equivalent to accessing `self.agent` in Python, where the agent reference
251
- * is always set before `setup()` is called.
252
- *
253
- * The SkillManager lifecycle guarantees that `setAgent()` is called before
254
- * `setup()`, so this method is safe to use inside `setup()` and in any
255
- * tool handler invoked during an active agent session.
256
- *
257
- * @returns The owning `AgentBase` instance.
258
- * @throws {Error} If called before `setAgent()` (i.e., before the skill is
259
- * attached to an agent by the SkillManager).
260
- */
261
- protected getAgent(): AgentBase {
262
- if (!this.agent) {
263
- throw new Error(
264
- `SkillBase.getAgent() called before setAgent() on skill "${this.skillName}". ` +
265
- 'Ensure getAgent() is only called from setup() or tool handlers, ' +
266
- 'where the SkillManager has already attached the agent.',
267
- );
268
- }
269
- return this.agent;
270
- }
271
-
272
- /**
273
- * Create a new skill instance.
274
- *
275
- * Python parity: `core/skill_base.py:32-43`.
276
- * Python `__init__` raises `ValueError` if `SKILL_NAME` or `SKILL_DESCRIPTION`
277
- * is left as `None` on the subclass. TS throws the equivalent when the static
278
- * defaults haven't been overridden.
279
- *
280
- * @param config - Optional configuration key-value pairs (Python: `params`).
281
- */
282
- constructor(config?: SkillConfig) {
283
- const klass = this.constructor as typeof SkillBase;
284
- if (!klass.SKILL_NAME) {
285
- throw new Error(
286
- `${klass.name} must define static SKILL_NAME ` +
287
- `(Python equivalent: core/skill_base.py:23,33-34).`,
288
- );
289
- }
290
- if (!klass.SKILL_DESCRIPTION) {
291
- throw new Error(
292
- `${klass.name} must define static SKILL_DESCRIPTION ` +
293
- `(Python equivalent: core/skill_base.py:24,35-36).`,
294
- );
295
- }
296
-
297
- this.skillName = klass.SKILL_NAME;
298
- this.config = { ...(config ?? {}) };
299
- this.instanceId = `${klass.SKILL_NAME}-${Date.now().toString(36)}-${randomBytes(4).toString('hex')}`;
300
- this.logger = getLogger(`signalwire.skills.${klass.SKILL_NAME}`);
301
-
302
- // Extract swaig_fields from config (matches Python's self.swaig_fields = self.params.pop('swaig_fields', {}))
303
- this.swaigFields = (this.config['swaig_fields'] as Record<string, unknown>) ?? {};
304
- delete this.config['swaig_fields'];
305
- }
306
-
307
- /**
308
- * Setup the skill. Called when the skill is added to an agent.
309
- * Override to perform initialization (API connections, config validation, etc.)
310
- * @returns `true` if setup succeeded, `false` otherwise.
311
- * Python equivalent: abstract `setup() -> bool`.
312
- */
313
- async setup(): Promise<boolean> {
314
- return true;
315
- }
316
-
317
- /**
318
- * Return the SWAIG tool definitions this skill provides.
319
- *
320
- * Default implementation returns tools registered imperatively via
321
- * `defineTool()`. Skills using the declarative pattern override this
322
- * method to return a static array built from their config.
323
- *
324
- * Python parity: replaces the `@abstractmethod register_tools()` contract
325
- * — Python skills call `self.define_tool(...)` inside `register_tools()`;
326
- * TypeScript skills either call `this.defineTool(...)` in `setup()` (and
327
- * let the default `getTools()` return them) or override `getTools()`
328
- * directly.
329
- *
330
- * @returns Array of tool definitions to register with the agent.
331
- */
332
- getTools(): SkillToolDefinition[] {
333
- return [...this._dynamicTools];
334
- }
335
-
336
- /**
337
- * Imperatively register a tool with this skill.
338
- *
339
- * Python parity: `core/skill_base.py:58` `def define_tool(self, **kwargs)`.
340
- * Merges `this.swaigFields` into the tool definition (explicit fields on
341
- * `toolDef` take precedence), then pushes the result into `_dynamicTools`
342
- * so the default `getTools()` returns it at SWML render time.
343
- *
344
- * Intended for skills whose tool shape depends on config evaluated at
345
- * `setup()` time. Skills with a static tool list should override
346
- * `getTools()` instead.
347
- *
348
- * @param toolDef - The tool definition to register. Must include at
349
- * minimum `name`, `description`, `parameters`, and `handler`.
350
- */
351
- protected defineTool(toolDef: SkillToolDefinition): void {
352
- const swaigDefaults = this.swaigFields as Partial<SkillToolDefinition>;
353
- const merged: SkillToolDefinition = {
354
- ...swaigDefaults,
355
- ...toolDef,
356
- };
357
- this._dynamicTools.push(merged);
358
- }
359
-
360
- /**
361
- * Optional DataMap-style tool definitions. Skills that build their own
362
- * SWAIG function dicts (e.g. via `DataMap.toSwaigFunction()`) return them
363
- * here and `AgentBase.addSkill()` registers each via `registerSwaigFunction`.
364
- *
365
- * Python equivalent: the direct `self.agent.register_swaig_function(fn)`
366
- * call inside `register_tools()` (e.g. `skills/datasphere_serverless/skill.py:210`).
367
- * Default returns `[]` — skills using only the declarative `getTools()` path
368
- * do not need to override this.
369
- *
370
- * @returns Array of fully-built SWAIG function dicts.
371
- */
372
- getDataMapTools(): Record<string, unknown>[] {
373
- return [];
374
- }
375
-
376
- /**
377
- * Get prompt sections to inject into the agent's system prompt.
378
- * Respects the `skip_prompt` config option — returns `[]` if set to `true`.
379
- * Subclasses should override `_getPromptSections()` instead of this method.
380
- * @returns Array of prompt sections with titles, bodies, and bullets.
381
- */
382
- getPromptSections(): SkillPromptSection[] {
383
- if (this.config['skip_prompt'] === true) {
384
- return [];
385
- }
386
- return this._getPromptSections();
387
- }
388
-
389
- /**
390
- * Internal method returning this skill's prompt sections.
391
- * Override this in subclasses instead of `getPromptSections()`.
392
- * @returns Array of prompt sections with titles, bodies, and bullets.
393
- */
394
- protected _getPromptSections(): SkillPromptSection[] {
395
- return [];
396
- }
397
-
398
- /**
399
- * Get speech recognition hints relevant to this skill.
400
- * @returns Array of hint strings to improve speech recognition accuracy.
401
- */
402
- getHints(): string[] {
403
- return [];
404
- }
405
-
406
- /**
407
- * Get global data to merge into the agent's global data store.
408
- * @returns Key-value pairs to be merged into the agent's global data.
409
- */
410
- getGlobalData(): Record<string, unknown> {
411
- return {};
412
- }
413
-
414
- /**
415
- * Get the instance key used for deduplication in the SkillManager.
416
- *
417
- * For single-instance skills (`SUPPORTS_MULTIPLE_INSTANCES = false`), returns
418
- * the skill name. For multi-instance skills, returns `${skillName}_${toolName}`
419
- * using the `tool_name` config (falls back to the skill name).
420
- *
421
- * Matches Python's `SkillBase.get_instance_key()` default (`skill_base.py:141-146`).
422
- * Multi-instance subclasses only need to override when their key derivation
423
- * depends on config beyond `tool_name`.
424
- *
425
- * @returns A unique key identifying this skill instance.
426
- */
427
- getInstanceKey(): string {
428
- const SkillClass = this.constructor as typeof SkillBase;
429
- if (!SkillClass.SUPPORTS_MULTIPLE_INSTANCES) {
430
- return this.skillName;
431
- }
432
- const toolName = (this.config['tool_name'] as string | undefined) ?? this.skillName;
433
- return `${this.skillName}_${toolName}`;
434
- }
435
-
436
- /**
437
- * Get the namespaced key for storing per-skill data in global_data.
438
- * @returns A string like "skill:datetime" or "skill:my_prefix".
439
- */
440
- getSkillNamespace(): string {
441
- const prefix = this.config['prefix'] as string | undefined;
442
- return `skill:${prefix ?? this.getInstanceKey()}`;
443
- }
444
-
445
- /**
446
- * Read this skill's data from a raw call data object's global_data.
447
- * @param rawData - The raw request data containing global_data.
448
- * @returns The skill's stored data, or an empty object if not found.
449
- */
450
- getSkillData(rawData: Record<string, unknown>): Record<string, unknown> {
451
- const globalData = rawData['global_data'] as Record<string, unknown> | undefined;
452
- if (!globalData) return {};
453
- return (globalData[this.getSkillNamespace()] as Record<string, unknown>) ?? {};
454
- }
455
-
456
- /**
457
- * Update this skill's namespaced data on a FunctionResult via updateGlobalData.
458
- * @param result - The FunctionResult to update.
459
- * @param data - The data to store under this skill's namespace.
460
- * @returns The FunctionResult for chaining.
461
- */
462
- updateSkillData(result: FunctionResult, data: Record<string, unknown>): FunctionResult {
463
- return result.updateGlobalData({ [this.getSkillNamespace()]: data });
464
- }
465
-
466
- /**
467
- * Cleanup resources. Called when the skill is removed from an agent.
468
- */
469
- async cleanup(): Promise<void> {
470
- // Default no-op
471
- }
472
-
473
- /**
474
- * Validate that all required environment variables declared on the skill class
475
- * are set in the current process environment.
476
- *
477
- * Python parity: `core/skill_base.py:103-110` reads `self.REQUIRED_ENV_VARS`
478
- * directly. TS reads the same static from the class.
479
- *
480
- * Returns the list of missing variable names so callers can produce actionable
481
- * error messages. This differs from Python's `validate_env_vars() -> bool`
482
- * return shape; {@link hasAllEnvVars} is the boolean equivalent.
483
- *
484
- * @returns Array of missing environment variable names (empty if all are present).
485
- */
486
- validateEnvVars(): string[] {
487
- const klass = this.constructor as typeof SkillBase;
488
- const missing: string[] = [];
489
- for (const envVar of klass.REQUIRED_ENV_VARS) {
490
- if (!process.env[envVar]) {
491
- missing.push(envVar);
492
- }
493
- }
494
- // Python parity: core/skill_base.py:107-109 logs an error line when any
495
- // required env vars are missing. Mirror that here so both SDKs produce
496
- // the same diagnostic signal during skill setup.
497
- if (missing.length > 0) {
498
- this.logger.error(`Missing required environment variables: ${missing.join(', ')}`);
499
- }
500
- return missing;
501
- }
502
-
503
- /**
504
- * Check if the skill has been initialized by the SkillManager.
505
- * @returns True if setup() has completed and the skill is marked initialized.
506
- */
507
- isInitialized(): boolean {
508
- return this._initialized;
509
- }
510
-
511
- /**
512
- * Mark the skill as initialized (called by SkillManager).
513
- */
514
- markInitialized(): void {
515
- this._initialized = true;
516
- }
517
-
518
- /**
519
- * Get a configuration value by key, falling back to a default if not set.
520
- * @param key - The configuration key to look up.
521
- * @param defaultValue - Value to return if the key is not present.
522
- * @returns The configuration value cast to type T, or the default value.
523
- */
524
- getConfig<T = unknown>(key: string, defaultValue?: T): T {
525
- return (this.config[key] !== undefined ? this.config[key] : defaultValue) as T;
526
- }
527
-
528
- /**
529
- * Set the agent reference for this skill.
530
- * Called by the SkillManager/AgentBase when the skill is attached to an agent.
531
- * Python equivalent: `self.agent = agent` in `__init__`.
532
- * @param agent - The agent that owns this skill.
533
- */
534
- setAgent(agent: AgentBase): void {
535
- this.agent = agent;
536
- }
537
-
538
- /**
539
- * Check if all required environment variables are present.
540
- * Convenience wrapper around `validateEnvVars()` that returns a boolean,
541
- * matching the Python `validate_env_vars() -> bool` return type.
542
- * @returns `true` if all required env vars are set, `false` otherwise.
543
- */
544
- hasAllEnvVars(): boolean {
545
- return this.validateEnvVars().length === 0;
546
- }
547
-
548
- /**
549
- * Validate that all required packages declared on the skill class can be imported.
550
- *
551
- * Python parity: `core/skill_base.py:112-124` reads `self.REQUIRED_PACKAGES`
552
- * directly and tries `importlib.import_module(pkg)` for each; TS does the
553
- * equivalent with a dynamic `import()`.
554
- *
555
- * @returns Array of package names that could not be imported (empty if all present).
556
- */
557
- async validatePackages(): Promise<string[]> {
558
- const klass = this.constructor as typeof SkillBase;
559
- const missing: string[] = [];
560
- for (const pkg of klass.REQUIRED_PACKAGES) {
561
- try {
562
- await import(pkg);
563
- } catch {
564
- missing.push(pkg);
565
- }
566
- }
567
- if (missing.length > 0) {
568
- this.logger.error(`Missing required packages: ${missing.join(', ')}`);
569
- }
570
- return missing;
571
- }
572
-
573
- /**
574
- * Check if all required packages declared in the manifest are available.
575
- * Convenience wrapper around `validatePackages()` that returns a boolean,
576
- * matching the Python `validate_packages() -> bool` return type.
577
- * @returns `true` if all required packages are importable, `false` otherwise.
578
- */
579
- async hasAllPackages(): Promise<boolean> {
580
- return (await this.validatePackages()).length === 0;
581
- }
582
- }