@signalwire/sdk 2.0.1 → 2.0.3

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 +1026 -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
package/src/DataMap.ts DELETED
@@ -1,477 +0,0 @@
1
- /**
2
- * DataMap - Fluent builder for SWAIG data_map configurations.
3
- *
4
- * Creates server-side tool definitions that execute on SignalWire
5
- * without requiring webhook endpoints.
6
- */
7
-
8
- import { FunctionResult } from './FunctionResult.js';
9
-
10
- const ENV_PATTERN = /\$\{ENV\.([^}]+)\}/g;
11
-
12
- /** Default allowed env var prefixes for expansion. */
13
- let globalAllowedEnvPrefixes: string[] = ['SIGNALWIRE_', 'SWML_', 'SW_'];
14
-
15
- /**
16
- * Set the global allowed env var prefixes for `${ENV.*}` expansion.
17
- *
18
- * Only environment variables whose names start with one of these prefixes
19
- * will be expanded. An empty array allows all variables (escape hatch).
20
- *
21
- * @param prefixes - Array of prefix strings to allow.
22
- */
23
- export function setAllowedEnvPrefixes(prefixes: string[]): void {
24
- globalAllowedEnvPrefixes = prefixes;
25
- }
26
-
27
- /**
28
- * Get the current global allowed env var prefixes.
29
- * @returns A copy of the current prefix list.
30
- */
31
- export function getAllowedEnvPrefixes(): string[] {
32
- return [...globalAllowedEnvPrefixes];
33
- }
34
-
35
- function isEnvVarAllowed(varName: string, allowedPrefixes: string[]): boolean {
36
- if (allowedPrefixes.length === 0) return true;
37
- return allowedPrefixes.some((prefix) => varName.startsWith(prefix));
38
- }
39
-
40
- function expandEnvVars(value: string, allowedPrefixes: string[]): string {
41
- return value.replace(ENV_PATTERN, (_match, varName: string) => {
42
- if (!isEnvVarAllowed(varName, allowedPrefixes)) return '';
43
- return process.env[varName] ?? '';
44
- });
45
- }
46
-
47
- function expandEnvInObject(obj: unknown, allowedPrefixes: string[]): unknown {
48
- if (typeof obj === 'string') return expandEnvVars(obj, allowedPrefixes);
49
- if (Array.isArray(obj)) return obj.map((item) => expandEnvInObject(item, allowedPrefixes));
50
- if (obj && typeof obj === 'object') {
51
- const result: Record<string, unknown> = {};
52
- for (const [k, v] of Object.entries(obj as Record<string, unknown>)) {
53
- result[k] = expandEnvInObject(v, allowedPrefixes);
54
- }
55
- return result;
56
- }
57
- return obj;
58
- }
59
-
60
- /**
61
- * Fluent builder for SWAIG data_map configurations.
62
- *
63
- * Creates server-side tool definitions that execute on SignalWire's infrastructure
64
- * **without** requiring a webhook endpoint in your application. Ideal for simple
65
- * third-party API integrations (REST calls + pattern-matched response shaping).
66
- *
67
- * @example Simple webhook-driven tool (no handler needed)
68
- * ```ts
69
- * import { DataMap, FunctionResult } from '@signalwire/sdk';
70
- *
71
- * const weather = new DataMap('get_weather')
72
- * .purpose('Look up the current weather for a city')
73
- * .parameter('city', 'string', 'The city name', true)
74
- * .webhook('GET', 'https://api.example.com/weather?city=${args.city}')
75
- * .output(new FunctionResult('In ${city} it is ${response.temp}°F and ${response.condition}.'));
76
- *
77
- * // Register onto an agent:
78
- * agent.registerSwaigFunction(weather.toSwaigFunction());
79
- * ```
80
- *
81
- * @example Expression-based tool (no webhook, pattern matching only)
82
- * ```ts
83
- * new DataMap('classify_intent')
84
- * .purpose('Route callers to the right department.')
85
- * .parameter('utterance', 'string', 'What the caller said', true)
86
- * .expression('${args.utterance}', /billing|invoice|charge/i, new FunctionResult('billing'))
87
- * .expression('${args.utterance}', /tech|broken|error/i, new FunctionResult('support'));
88
- * ```
89
- *
90
- * @see {@link FunctionResult} — response shape used in `.output()` / `.expression()`
91
- * @see {@link createSimpleApiTool} — one-liner helper for REST API tools
92
- * @see {@link AgentBase.defineTool} — alternative for tools that run in your process
93
- */
94
- export class DataMap {
95
- /** The name of the SWAIG function this data map defines. */
96
- functionName: string;
97
- private _purpose = '';
98
- private _parameters: Record<string, unknown> = {};
99
- private _expressions: Record<string, unknown>[] = [];
100
- private _webhooks: Record<string, unknown>[] = [];
101
- private _output: Record<string, unknown> | null = null;
102
- private _errorKeys: string[] = [];
103
- private _expandEnv = false;
104
- private _allowedEnvPrefixes: string[] | null = null;
105
-
106
- /**
107
- * @param functionName - The unique name for this data map tool.
108
- */
109
- constructor(functionName: string) {
110
- this.functionName = functionName;
111
- }
112
-
113
- /**
114
- * Enable `${ENV.*}` variable expansion in URLs, bodies, and outputs.
115
- * @param enabled - Whether to enable expansion (defaults to true).
116
- * @returns This instance for chaining.
117
- */
118
- enableEnvExpansion(enabled = true): this {
119
- this._expandEnv = enabled;
120
- return this;
121
- }
122
-
123
- /**
124
- * Set the allowed env var prefixes for this DataMap instance.
125
- *
126
- * Overrides the global defaults. Only env vars whose names start with
127
- * one of these prefixes will be expanded. An empty array allows all.
128
- *
129
- * @param prefixes - Array of prefix strings to allow.
130
- * @returns This instance for chaining.
131
- */
132
- setAllowedEnvPrefixes(prefixes: string[]): this {
133
- this._allowedEnvPrefixes = prefixes;
134
- return this;
135
- }
136
-
137
- /**
138
- * Set the purpose (description) for this data-map tool — READ BY THE LLM.
139
- *
140
- * This string is rendered into the OpenAI tool schema `description`
141
- * field and sent to the model on every turn. The model uses it to
142
- * decide WHEN to call this tool. It is **prompt engineering**, not
143
- * developer documentation.
144
- *
145
- * A vague `purpose()` is the #1 cause of "the model has the right tool
146
- * but doesn't call it" failures with data-map tools.
147
- *
148
- * ### Bad vs good
149
- *
150
- * ```text
151
- * BAD : .purpose('weather api')
152
- * GOOD: .purpose('Get the current weather conditions and forecast for
153
- * a specific city. Use this whenever the user asks about weather,
154
- * temperature, rain, or similar conditions in a named location.')
155
- * ```
156
- *
157
- * @param description - Prompt-engineering description of when to call this tool.
158
- * @returns This instance for chaining.
159
- */
160
- purpose(description: string): this {
161
- this._purpose = description;
162
- return this;
163
- }
164
-
165
- /**
166
- * Alias for {@link purpose}; sets the LLM-facing tool description.
167
- *
168
- * This string is read by the model to decide WHEN to call this tool.
169
- * See {@link purpose} for bad-vs-good examples.
170
- *
171
- * @param description - Prompt-engineering description of when to call this tool.
172
- * @returns This instance for chaining.
173
- */
174
- description(description: string): this {
175
- return this.purpose(description);
176
- }
177
-
178
- /**
179
- * Define a parameter for this data-map tool — `description` is READ BY THE LLM.
180
- *
181
- * Each parameter `description` is rendered into the OpenAI tool schema
182
- * under `parameters.properties.<name>.description` and sent to the
183
- * model. The model uses it to decide HOW to fill in the argument from
184
- * user speech. It is **prompt engineering**, not developer FYI.
185
- *
186
- * ### Bad vs good
187
- *
188
- * ```text
189
- * BAD : .parameter('city', 'string', 'the city')
190
- * GOOD: .parameter('city', 'string',
191
- * 'The name of the city to get weather for, e.g. "San Francisco".
192
- * Ask the user if they did not provide one. Include the state
193
- * or country if the city name is ambiguous.')
194
- * ```
195
- *
196
- * @param name - The parameter name (JSON object key).
197
- * @param paramType - The JSON Schema type (e.g., "string", "number").
198
- * @param description - Prompt-engineering description telling the model
199
- * how to extract this value from the user's utterance. Read by the LLM.
200
- * @param opts - Optional flags for required and enum constraints.
201
- * @returns This instance for chaining.
202
- */
203
- parameter(
204
- name: string,
205
- paramType: string,
206
- description: string,
207
- opts?: { required?: boolean; enum?: string[] },
208
- ): this {
209
- const paramDef: Record<string, unknown> = { type: paramType, description };
210
- if (opts?.enum) paramDef['enum'] = opts.enum;
211
- this._parameters[name] = paramDef;
212
-
213
- if (opts?.required) {
214
- if (!this._parameters['_required']) {
215
- this._parameters['_required'] = [];
216
- }
217
- const req = this._parameters['_required'] as string[];
218
- if (!req.includes(name)) req.push(name);
219
- }
220
- return this;
221
- }
222
-
223
- /**
224
- * Add a pattern-matching expression that evaluates a test value against a regex.
225
- * @param testValue - The string or template variable to test.
226
- * @param pattern - A regex pattern (string or RegExp) to match against.
227
- * @param output - The result to return when the pattern matches.
228
- * @param nomatchOutput - Optional result to return when the pattern does not match.
229
- * @returns This instance for chaining.
230
- */
231
- expression(
232
- testValue: string,
233
- pattern: string | RegExp,
234
- output: FunctionResult,
235
- nomatchOutput?: FunctionResult,
236
- ): this {
237
- const patternStr = typeof pattern === 'string' ? pattern : pattern.source;
238
- const expr: Record<string, unknown> = {
239
- string: testValue,
240
- pattern: patternStr,
241
- output: output.toDict(),
242
- };
243
- if (nomatchOutput) {
244
- expr['nomatch-output'] = nomatchOutput.toDict();
245
- }
246
- this._expressions.push(expr);
247
- return this;
248
- }
249
-
250
- /**
251
- * Add a webhook that is called when this data map tool is invoked.
252
- * @param method - HTTP method (e.g., "GET", "POST").
253
- * @param url - The webhook URL to call.
254
- * @param opts - Optional headers, form parameter name, and argument settings.
255
- * @returns This instance for chaining.
256
- */
257
- webhook(
258
- method: string,
259
- url: string,
260
- opts?: {
261
- headers?: Record<string, string>;
262
- formParam?: string;
263
- inputArgsAsParams?: boolean;
264
- requireArgs?: string[];
265
- },
266
- ): this {
267
- const def: Record<string, unknown> = { url, method: method.toUpperCase() };
268
- if (opts?.headers) def['headers'] = opts.headers;
269
- if (opts?.formParam) def['form_param'] = opts.formParam;
270
- if (opts?.inputArgsAsParams) def['input_args_as_params'] = true;
271
- if (opts?.requireArgs) def['require_args'] = opts.requireArgs;
272
- this._webhooks.push(def);
273
- return this;
274
- }
275
-
276
- /**
277
- * Set pattern-matching expressions on the most recently added webhook.
278
- * @param expressions - Array of expression objects to evaluate against the webhook response.
279
- * @returns This instance for chaining.
280
- */
281
- webhookExpressions(expressions: Record<string, unknown>[]): this {
282
- if (!this._webhooks.length) throw new Error('Must add webhook before setting webhook expressions');
283
- this._webhooks[this._webhooks.length - 1]['expressions'] = expressions;
284
- return this;
285
- }
286
-
287
- /**
288
- * Set the JSON body for the most recently added webhook.
289
- * @param data - The request body object.
290
- * @returns This instance for chaining.
291
- */
292
- body(data: Record<string, unknown>): this {
293
- if (!this._webhooks.length) throw new Error('Must add webhook before setting body');
294
- this._webhooks[this._webhooks.length - 1]['body'] = data;
295
- return this;
296
- }
297
-
298
- /**
299
- * Set query or form parameters for the most recently added webhook.
300
- * @param data - The parameters object.
301
- * @returns This instance for chaining.
302
- */
303
- params(data: Record<string, unknown>): this {
304
- if (!this._webhooks.length) throw new Error('Must add webhook before setting params');
305
- this._webhooks[this._webhooks.length - 1]['params'] = data;
306
- return this;
307
- }
308
-
309
- /**
310
- * Configure iteration over an array in the webhook response.
311
- * @param config - Foreach configuration with input/output keys, append template, and optional max.
312
- * @returns This instance for chaining.
313
- */
314
- foreach(config: {
315
- input_key: string;
316
- output_key: string;
317
- append: string;
318
- max?: number;
319
- }): this {
320
- if (!this._webhooks.length) throw new Error('Must add webhook before setting foreach');
321
- this._webhooks[this._webhooks.length - 1]['foreach'] = config;
322
- return this;
323
- }
324
-
325
- /**
326
- * Set the output template for the most recently added webhook.
327
- * @param result - The FunctionResult to use as the output template.
328
- * @returns This instance for chaining.
329
- */
330
- output(result: FunctionResult): this {
331
- if (!this._webhooks.length) throw new Error('Must add webhook before setting output');
332
- this._webhooks[this._webhooks.length - 1]['output'] = result.toDict();
333
- return this;
334
- }
335
-
336
- /**
337
- * Set a fallback output used when no webhook or expression matches.
338
- * @param result - The FunctionResult to use as the fallback.
339
- * @returns This instance for chaining.
340
- */
341
- fallbackOutput(result: FunctionResult): this {
342
- this._output = result.toDict();
343
- return this;
344
- }
345
-
346
- /**
347
- * Set error keys on the most recently added webhook, or globally if no webhook exists.
348
- * @param keys - Response keys that indicate an error occurred.
349
- * @returns This instance for chaining.
350
- */
351
- errorKeys(keys: string[]): this {
352
- if (this._webhooks.length) {
353
- this._webhooks[this._webhooks.length - 1]['error_keys'] = keys;
354
- } else {
355
- this._errorKeys = keys;
356
- }
357
- return this;
358
- }
359
-
360
- /**
361
- * Set error keys at the top-level data map scope, regardless of webhook context.
362
- * @param keys - Response keys that indicate an error occurred.
363
- * @returns This instance for chaining.
364
- */
365
- globalErrorKeys(keys: string[]): this {
366
- this._errorKeys = keys;
367
- return this;
368
- }
369
-
370
- /**
371
- * Register this DataMap tool with an AgentBase instance.
372
- * @param agent - An object with a registerSwaigFunction method (typically an AgentBase).
373
- * @returns This instance for chaining.
374
- */
375
- registerWithAgent(agent: { registerSwaigFunction(fn: Record<string, unknown>): unknown }): this {
376
- agent.registerSwaigFunction(this.toSwaigFunction());
377
- return this;
378
- }
379
-
380
- /**
381
- * Serialize this data map to a SWAIG function definition object.
382
- * @returns A plain object suitable for inclusion in the SWML SWAIG array.
383
- */
384
- toSwaigFunction(): Record<string, unknown> {
385
- // Build parameter schema
386
- let paramSchema: Record<string, unknown>;
387
- const paramKeys = Object.keys(this._parameters).filter((k) => k !== '_required');
388
- if (paramKeys.length) {
389
- const properties: Record<string, unknown> = {};
390
- for (const k of paramKeys) {
391
- properties[k] = this._parameters[k];
392
- }
393
- paramSchema = { type: 'object', properties };
394
- const required = this._parameters['_required'] as string[] | undefined;
395
- if (required?.length) paramSchema['required'] = required;
396
- } else {
397
- paramSchema = { type: 'object', properties: {} };
398
- }
399
-
400
- // Build data_map
401
- const dataMap: Record<string, unknown> = {};
402
- if (this._expressions.length) dataMap['expressions'] = this._expressions;
403
- if (this._webhooks.length) dataMap['webhooks'] = this._webhooks;
404
- if (this._output) dataMap['output'] = this._output;
405
- if (this._errorKeys.length) dataMap['error_keys'] = this._errorKeys;
406
-
407
- let result: Record<string, unknown> = {
408
- function: this.functionName,
409
- description: this._purpose || `Execute ${this.functionName}`,
410
- parameters: paramSchema,
411
- data_map: dataMap,
412
- };
413
-
414
- if (this._expandEnv) {
415
- const prefixes = this._allowedEnvPrefixes ?? globalAllowedEnvPrefixes;
416
- result = expandEnvInObject(result, prefixes) as Record<string, unknown>;
417
- }
418
-
419
- return result;
420
- }
421
- }
422
-
423
- // ── Helper functions ────────────────────────────────────────────────────
424
-
425
- /**
426
- * Create a DataMap tool that calls a single API endpoint and formats the response.
427
- * @param opts - Configuration including name, URL, response template, and optional parameters.
428
- * @returns A configured DataMap instance ready for registration.
429
- */
430
- export function createSimpleApiTool(opts: {
431
- name: string;
432
- url: string;
433
- responseTemplate: string;
434
- parameters?: Record<string, { type?: string; description?: string; required?: boolean }>;
435
- method?: string;
436
- headers?: Record<string, string>;
437
- body?: Record<string, unknown>;
438
- errorKeys?: string[];
439
- }): DataMap {
440
- const dm = new DataMap(opts.name);
441
- if (opts.parameters) {
442
- for (const [name, def] of Object.entries(opts.parameters)) {
443
- dm.parameter(name, def.type ?? 'string', def.description ?? `${name} parameter`, {
444
- required: def.required,
445
- });
446
- }
447
- }
448
- dm.webhook(opts.method ?? 'GET', opts.url, { headers: opts.headers });
449
- if (opts.body) dm.body(opts.body);
450
- if (opts.errorKeys) dm.errorKeys(opts.errorKeys);
451
- dm.output(new FunctionResult(opts.responseTemplate));
452
- return dm;
453
- }
454
-
455
- /**
456
- * Create a DataMap tool that evaluates expressions against patterns without making HTTP calls.
457
- * @param opts - Configuration including name, pattern-result pairs, and optional parameters.
458
- * @returns A configured DataMap instance ready for registration.
459
- */
460
- export function createExpressionTool(opts: {
461
- name: string;
462
- patterns: Record<string, [string, FunctionResult]>;
463
- parameters?: Record<string, { type?: string; description?: string; required?: boolean }>;
464
- }): DataMap {
465
- const dm = new DataMap(opts.name);
466
- if (opts.parameters) {
467
- for (const [name, def] of Object.entries(opts.parameters)) {
468
- dm.parameter(name, def.type ?? 'string', def.description ?? `${name} parameter`, {
469
- required: def.required,
470
- });
471
- }
472
- }
473
- for (const [testValue, [pattern, result]] of Object.entries(opts.patterns)) {
474
- dm.expression(testValue, pattern, result);
475
- }
476
- return dm;
477
- }