@signalwire/sdk 2.0.0 → 2.0.2

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