@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
@@ -1,910 +0,0 @@
1
- /**
2
- * Native Vector Search Skill - Document search over a local or remote index.
3
- *
4
- * Port of the Python `NativeVectorSearchSkill`. Supports three backends in
5
- * Python (SQLite `.swsearch`, PostgreSQL `pgvector`, and a remote HTTP
6
- * search server). This TypeScript implementation provides:
7
- *
8
- * - In-memory TF-IDF search over `documents` passed via config (fast path
9
- * that needs no additional deps), and
10
- * - Remote HTTP search via a configured `remote_url` (compatible with the
11
- * Python SDK's `sw-search` remote protocol).
12
- *
13
- * The SQLite/pgvector backends require native Python dependencies and are
14
- * not available here; their schema entries are preserved so configuration
15
- * written for the Python SDK remains valid.
16
- */
17
-
18
- import { SkillBase } from '../SkillBase.js';
19
- import type {
20
- SkillToolDefinition,
21
- SkillPromptSection,
22
- SkillConfig,
23
- ParameterSchemaEntry,
24
- } from '../SkillBase.js';
25
- import type { AgentBase } from '../../AgentBase.js';
26
- import { FunctionResult } from '../../FunctionResult.js';
27
- import { getLogger } from '../../Logger.js';
28
- import { validateUrl } from '../../SecurityUtils.js';
29
-
30
- const log = getLogger('NativeVectorSearchSkill');
31
-
32
- /**
33
- * Callback signature for customizing the formatted search response.
34
- *
35
- * The context object is the TypeScript idiom for Python's positional-args
36
- * convention: `(response, agent, query, results, args)`. All Python fields are
37
- * present plus TS-specific additions (`count`, `skill`):
38
- *
39
- * - `response` — pre-formatted response string (same as Python arg 1)
40
- * - `agent` — the AgentBase instance that owns this skill (same as Python arg 2)
41
- * - `query` — the search query string (same as Python arg 3)
42
- * - `results` — array of search results (same as Python arg 4)
43
- * - `args` — raw tool call arguments (same as Python arg 5)
44
- * - `count` — requested result count (TS addition)
45
- * - `skill` — this skill instance (TS addition)
46
- */
47
- export type ResponseFormatCallback = (ctx: {
48
- response: string;
49
- /** The AgentBase instance that owns this skill. Equivalent to Python's `agent` positional arg. */
50
- agent?: AgentBase;
51
- query: string;
52
- results: Array<{ content: string; score: number; metadata: Record<string, unknown> }>;
53
- args: Record<string, unknown>;
54
- count: number;
55
- skill: NativeVectorSearchSkill;
56
- }) => string;
57
-
58
- /** A document entry in the in-memory search index. */
59
- interface DocumentEntry {
60
- /** Unique document identifier. */
61
- id: string;
62
- /** Full text content of the document. */
63
- text: string;
64
- /** Optional metadata associated with the document. */
65
- metadata?: Record<string, unknown>;
66
- /** Optional tags for filtering. */
67
- tags?: string[];
68
- }
69
-
70
- /** A single search result in normalized form. */
71
- interface SearchResult {
72
- content: string;
73
- score: number;
74
- metadata: Record<string, unknown>;
75
- }
76
-
77
- /**
78
- * Tokenize text into lowercase words, removing punctuation and common stop words.
79
- */
80
- function tokenize(text: string): string[] {
81
- const stopWords = new Set([
82
- 'a', 'an', 'the', 'is', 'are', 'was', 'were', 'be', 'been', 'being',
83
- 'have', 'has', 'had', 'do', 'does', 'did', 'will', 'would', 'could',
84
- 'should', 'may', 'might', 'shall', 'can', 'to', 'of', 'in', 'for',
85
- 'on', 'with', 'at', 'by', 'from', 'as', 'into', 'through', 'during',
86
- 'before', 'after', 'above', 'below', 'between', 'and', 'but', 'or',
87
- 'nor', 'not', 'so', 'yet', 'both', 'either', 'neither', 'each',
88
- 'every', 'all', 'any', 'few', 'more', 'most', 'other', 'some',
89
- 'such', 'no', 'only', 'own', 'same', 'than', 'too', 'very',
90
- 'just', 'because', 'if', 'when', 'where', 'how', 'what', 'which',
91
- 'who', 'whom', 'this', 'that', 'these', 'those', 'i', 'me', 'my',
92
- 'we', 'our', 'you', 'your', 'he', 'him', 'his', 'she', 'her',
93
- 'it', 'its', 'they', 'them', 'their', 'about', 'up', 'out',
94
- ]);
95
-
96
- return text
97
- .toLowerCase()
98
- .replace(/[^a-z0-9\s]/g, ' ')
99
- .split(/\s+/)
100
- .filter((word) => word.length > 1 && !stopWords.has(word));
101
- }
102
-
103
- function termFrequency(tokens: string[]): Map<string, number> {
104
- const tf = new Map<string, number>();
105
- for (const token of tokens) {
106
- tf.set(token, (tf.get(token) ?? 0) + 1);
107
- }
108
- const len = tokens.length || 1;
109
- for (const [term, count] of tf) {
110
- tf.set(term, count / len);
111
- }
112
- return tf;
113
- }
114
-
115
- function inverseDocumentFrequency(corpus: string[][]): Map<string, number> {
116
- const idf = new Map<string, number>();
117
- const numDocs = corpus.length || 1;
118
- const docFreq = new Map<string, number>();
119
- for (const tokens of corpus) {
120
- const unique = new Set(tokens);
121
- for (const t of unique) docFreq.set(t, (docFreq.get(t) ?? 0) + 1);
122
- }
123
- for (const [term, freq] of docFreq) {
124
- idf.set(term, Math.log((numDocs + 1) / (freq + 1)) + 1);
125
- }
126
- return idf;
127
- }
128
-
129
- function scoreTfIdf(
130
- queryTokens: string[],
131
- docTf: Map<string, number>,
132
- idf: Map<string, number>,
133
- ): number {
134
- if (queryTokens.length === 0) return 0;
135
- let score = 0;
136
- const queryTf = termFrequency(queryTokens);
137
- for (const [term, qWeight] of queryTf) {
138
- const docWeight = docTf.get(term) ?? 0;
139
- const idfWeight = idf.get(term) ?? 1;
140
- score += qWeight * docWeight * idfWeight * idfWeight;
141
- }
142
- return score;
143
- }
144
-
145
- /**
146
- * Document search using TF-IDF in-memory scoring or a remote search server.
147
- *
148
- * Multi-instance capable (distinguished by `tool_name` + `index_file`).
149
- *
150
- * @example Local JSON index
151
- * ```ts
152
- * agent.addSkill('native_vector_search', {
153
- * tool_name: 'search_docs',
154
- * index_file: './data/support-docs.json',
155
- * count: 3,
156
- * });
157
- * ```
158
- */
159
- export class NativeVectorSearchSkill extends SkillBase {
160
- // Python ground truth: skills/native_vector_search/skill.py:~75-82
161
- static override SKILL_NAME = 'native_vector_search';
162
- static override SKILL_DESCRIPTION =
163
- 'Search document indexes using vector similarity and keyword search (local or remote)';
164
- static override SKILL_VERSION = '1.0.0';
165
- static override REQUIRED_PACKAGES: readonly string[] = [];
166
- static override REQUIRED_ENV_VARS: readonly string[] = [];
167
- static override SUPPORTS_MULTIPLE_INSTANCES = true;
168
-
169
- static override getParameterSchema(): Record<string, ParameterSchemaEntry> {
170
- return {
171
- ...super.getParameterSchema(),
172
- index_file: {
173
- type: 'string',
174
- description:
175
- 'Path to .swsearch index file (SQLite backend only). Use this for local file-based search',
176
- required: false,
177
- },
178
- build_index: {
179
- type: 'boolean',
180
- description: 'Whether to build index from source files',
181
- default: false,
182
- required: false,
183
- },
184
- source_dir: {
185
- type: 'string',
186
- description:
187
- 'Directory containing documents to index (required if build_index=True)',
188
- required: false,
189
- },
190
- remote_url: {
191
- type: 'string',
192
- description:
193
- 'URL of remote search server for network mode (e.g., http://localhost:8001)',
194
- required: false,
195
- },
196
- index_name: {
197
- type: 'string',
198
- description:
199
- 'Name of index on remote server (network mode only, used with remote_url)',
200
- default: 'default',
201
- required: false,
202
- },
203
- count: {
204
- type: 'integer',
205
- description: 'Number of search results to return',
206
- default: 5,
207
- required: false,
208
- min: 1,
209
- max: 20,
210
- },
211
- similarity_threshold: {
212
- type: 'number',
213
- description:
214
- 'Minimum similarity score for results (0.0 = no limit, 1.0 = exact match)',
215
- default: 0.0,
216
- required: false,
217
- min: 0.0,
218
- max: 1.0,
219
- },
220
- tags: {
221
- type: 'array',
222
- description: 'Tags to filter search results',
223
- default: [],
224
- required: false,
225
- items: { type: 'string' },
226
- },
227
- global_tags: {
228
- type: 'array',
229
- description: 'Tags to apply to all indexed documents',
230
- default: [],
231
- required: false,
232
- items: { type: 'string' },
233
- },
234
- file_types: {
235
- type: 'array',
236
- description: 'File extensions to include when building index',
237
- default: ['md', 'txt', 'pdf', 'docx', 'html'],
238
- required: false,
239
- items: { type: 'string' },
240
- },
241
- exclude_patterns: {
242
- type: 'array',
243
- description: 'Patterns to exclude when building index',
244
- default: [
245
- '**/node_modules/**',
246
- '**/.git/**',
247
- '**/dist/**',
248
- '**/build/**',
249
- ],
250
- required: false,
251
- items: { type: 'string' },
252
- },
253
- no_results_message: {
254
- type: 'string',
255
- description: 'Message when no results are found',
256
- default: "No information found for '{query}'",
257
- required: false,
258
- },
259
- response_prefix: {
260
- type: 'string',
261
- description: 'Prefix to add to search results',
262
- default: '',
263
- required: false,
264
- },
265
- response_postfix: {
266
- type: 'string',
267
- description: 'Postfix to add to search results',
268
- default: '',
269
- required: false,
270
- },
271
- max_content_length: {
272
- type: 'integer',
273
- description:
274
- 'Maximum total response size in characters (distributed across all results)',
275
- default: 32768,
276
- required: false,
277
- min: 1000,
278
- },
279
- response_format_callback: {
280
- type: 'object',
281
- description:
282
- 'Optional callback function to format/transform the response.',
283
- required: false,
284
- },
285
- description: {
286
- type: 'string',
287
- description: 'Tool description',
288
- default: 'Search the knowledge base for information',
289
- required: false,
290
- },
291
- hints: {
292
- type: 'array',
293
- description: 'Speech recognition hints',
294
- default: [],
295
- required: false,
296
- items: { type: 'string' },
297
- },
298
- nlp_backend: {
299
- type: 'string',
300
- description: 'NLP backend for query processing (deprecated)',
301
- default: 'basic',
302
- required: false,
303
- enum: ['basic', 'spacy', 'nltk'],
304
- },
305
- query_nlp_backend: {
306
- type: 'string',
307
- description: 'NLP backend for query expansion',
308
- required: false,
309
- enum: ['basic', 'spacy', 'nltk'],
310
- },
311
- index_nlp_backend: {
312
- type: 'string',
313
- description: 'NLP backend for indexing',
314
- required: false,
315
- enum: ['basic', 'spacy', 'nltk'],
316
- },
317
- backend: {
318
- type: 'string',
319
- description:
320
- "Storage backend for local database mode: 'sqlite' or 'pgvector'. Ignored if remote_url is set",
321
- default: 'sqlite',
322
- required: false,
323
- enum: ['sqlite', 'pgvector'],
324
- },
325
- connection_string: {
326
- type: 'string',
327
- description: 'PostgreSQL connection string (pgvector backend only)',
328
- required: false,
329
- },
330
- collection_name: {
331
- type: 'string',
332
- description: 'Collection/table name in PostgreSQL (pgvector backend only)',
333
- required: false,
334
- },
335
- verbose: {
336
- type: 'boolean',
337
- description: 'Enable verbose logging',
338
- default: false,
339
- required: false,
340
- },
341
- keyword_weight: {
342
- type: 'number',
343
- description:
344
- 'Manual keyword weight (0.0-1.0). Overrides automatic weight detection',
345
- required: false,
346
- min: 0.0,
347
- max: 1.0,
348
- },
349
- model_name: {
350
- type: 'string',
351
- description: 'Embedding model to use',
352
- default: 'mini',
353
- required: false,
354
- },
355
- overwrite: {
356
- type: 'boolean',
357
- description: 'Overwrite existing pgvector collection when building index',
358
- default: false,
359
- required: false,
360
- },
361
- documents: {
362
- type: 'array',
363
- description:
364
- 'In-memory array of documents to index: [{ id, text, metadata?, tags? }] (TS-specific)',
365
- required: false,
366
- items: { type: 'object' },
367
- },
368
- };
369
- }
370
-
371
- // Runtime state
372
- private toolName = 'search_knowledge';
373
- private backend = 'sqlite';
374
- private indexFile: string | undefined;
375
- private remoteUrl: string | undefined;
376
- private indexName = 'default';
377
- private count = 5;
378
- private similarityThreshold = 0.0;
379
- private filterTags: string[] = [];
380
- private noResultsMessage = "No information found for '{query}'";
381
- private responsePrefix = '';
382
- private responsePostfix = '';
383
- private maxContentLength = 32768;
384
- private responseFormatCallback: ResponseFormatCallback | undefined;
385
- private description = 'Search the knowledge base for information';
386
- private verbose = false;
387
- /**
388
- * Hybrid scoring weight: 0.0 = pure TF-IDF, 1.0 = pure keyword overlap.
389
- * `null` means "use Python default of 0.3 at search time" — matches
390
- * Python `SearchEngine._merge_all_results` behavior when `keyword_weight`
391
- * is None (see `search_engine.py` line 449).
392
- */
393
- private keywordWeight: number | null = null;
394
- private searchAvailable = false;
395
- private useRemote = false;
396
- private remoteBaseUrl: string | undefined;
397
- private remoteAuth: { user: string; pass: string } | undefined;
398
-
399
- // In-memory index state
400
- private _documents: DocumentEntry[] = [];
401
- private _tokenizedDocs: string[][] = [];
402
- private _docTfs: Map<string, number>[] = [];
403
- private _idf: Map<string, number> = new Map();
404
- private _indexed = false;
405
-
406
- override getInstanceKey(): string {
407
- const toolName = this.getConfig<string>('tool_name', 'search_knowledge');
408
- const indexFile = this.getConfig<string>('index_file', 'default');
409
- return `${this.skillName}_${toolName}_${indexFile}`;
410
- }
411
-
412
- override async setup(): Promise<boolean> {
413
- // Config
414
- this.toolName = this.getConfig<string>('tool_name', 'search_knowledge');
415
- this.backend = this.getConfig<string>('backend', 'sqlite');
416
- this.indexFile = this.getConfig<string | undefined>('index_file', undefined);
417
- this.count = this.getConfig<number>('count', 5);
418
- this.similarityThreshold = this.getConfig<number>('similarity_threshold', 0.0);
419
- this.filterTags = this.getConfig<string[]>('tags', []) ?? [];
420
- this.noResultsMessage = this.getConfig<string>(
421
- 'no_results_message',
422
- "No information found for '{query}'",
423
- );
424
- this.responsePrefix = this.getConfig<string>('response_prefix', '');
425
- this.responsePostfix = this.getConfig<string>('response_postfix', '');
426
- this.maxContentLength = this.getConfig<number>('max_content_length', 32768);
427
- this.responseFormatCallback = this.getConfig<ResponseFormatCallback | undefined>(
428
- 'response_format_callback',
429
- undefined,
430
- );
431
- this.description = this.getConfig<string>(
432
- 'description',
433
- 'Search the knowledge base for information',
434
- );
435
- this.verbose = this.getConfig<boolean>('verbose', false);
436
- const kw = this.getConfig<number | null | undefined>('keyword_weight', null);
437
- this.keywordWeight = kw == null ? null : Math.min(1.0, Math.max(0.0, kw));
438
-
439
- // Remote search configuration
440
- this.remoteUrl = this.getConfig<string | undefined>('remote_url', undefined);
441
- this.indexName = this.getConfig<string>('index_name', 'default');
442
-
443
- // Parse auth from URL if present
444
- if (this.remoteUrl) {
445
- try {
446
- const parsed = new URL(this.remoteUrl);
447
- if (parsed.username && parsed.password) {
448
- this.remoteAuth = {
449
- user: decodeURIComponent(parsed.username),
450
- pass: decodeURIComponent(parsed.password),
451
- };
452
- parsed.username = '';
453
- parsed.password = '';
454
- this.remoteBaseUrl = parsed.toString().replace(/\/+$/, '');
455
- } else {
456
- this.remoteBaseUrl = this.remoteUrl.replace(/\/+$/, '');
457
- }
458
- } catch {
459
- this.remoteBaseUrl = this.remoteUrl;
460
- }
461
- }
462
-
463
- // Remote mode — validate and skip heavy local setup
464
- if (this.remoteUrl) {
465
- this.useRemote = true;
466
-
467
- // SSRF protection — match Python skills/native_vector_search/skill.py:292-293
468
- // which calls validate_url(self.remote_url) and refuses to connect to
469
- // private/loopback/metadata-endpoint URLs in multi-tenant deployments.
470
- const urlToValidate = this.remoteBaseUrl ?? this.remoteUrl;
471
- if (!(await validateUrl(urlToValidate))) {
472
- log.error('native_vector_search: remote_url rejected by SSRF protection', {
473
- url: urlToValidate,
474
- });
475
- return false;
476
- }
477
-
478
- try {
479
- // Python uses timeout=5 for the health check (skill.py). Don't wait
480
- // the default 30s if a misconfigured remote URL doesn't respond.
481
- const response = await this._fetchWithAuth(
482
- `${this.remoteBaseUrl}/health`,
483
- { method: 'GET' },
484
- 5000,
485
- );
486
- if (response.status === 200) {
487
- log.info('native_vector_search: remote server available', {
488
- url: this.remoteBaseUrl,
489
- });
490
- this.searchAvailable = true;
491
- return true;
492
- }
493
- if (response.status === 401) {
494
- log.error('native_vector_search: remote auth failed');
495
- } else {
496
- log.error('native_vector_search: remote server returned non-200', {
497
- status: response.status,
498
- });
499
- }
500
- this.searchAvailable = false;
501
- } catch (err) {
502
- log.error('native_vector_search: failed to connect to remote', {
503
- error: err instanceof Error ? err.message : String(err),
504
- });
505
- this.searchAvailable = false;
506
- }
507
- return this.searchAvailable;
508
- }
509
-
510
- // Local / in-memory mode
511
- this.useRemote = false;
512
- this._loadDocuments();
513
- this.searchAvailable = this._indexed;
514
-
515
- if (this.verbose) {
516
- log.info('native_vector_search: local index loaded', {
517
- docCount: this._documents.length,
518
- indexed: this._indexed,
519
- });
520
- }
521
- // Python parity (skill.py): local mode always returns True from setup()
522
- // even when no documents are loaded. The skill stays registered and the
523
- // "no information found" fallback fires at query time instead of the
524
- // skill being rejected entirely. This lets a caller fix the config and
525
- // reload without tearing down the agent.
526
- return true;
527
- }
528
-
529
- override getHints(): string[] {
530
- const hints = ['search', 'find', 'look up', 'documentation', 'knowledge base'];
531
- const extra = this.getConfig<string[]>('hints', []) ?? [];
532
- return [...hints, ...extra];
533
- }
534
-
535
- override getGlobalData(): Record<string, unknown> {
536
- const globalData: Record<string, unknown> = {};
537
- if (this._indexed) {
538
- globalData['search_stats'] = {
539
- doc_count: this._documents.length,
540
- backend: this.useRemote ? 'remote' : this.backend,
541
- };
542
- }
543
- return globalData;
544
- }
545
-
546
- override async cleanup(): Promise<void> {
547
- this._documents = [];
548
- this._tokenizedDocs = [];
549
- this._docTfs = [];
550
- this._idf = new Map();
551
- this._indexed = false;
552
- }
553
-
554
- /**
555
- * Load and TF-IDF-index documents from config.
556
- * Applies `global_tags` to every document's tag list.
557
- */
558
- private _loadDocuments(): void {
559
- const docs = this.getConfig<DocumentEntry[]>('documents', []) ?? [];
560
- const globalTags = this.getConfig<string[]>('global_tags', []) ?? [];
561
-
562
- if (!Array.isArray(docs) || docs.length === 0) {
563
- this._documents = [];
564
- this._indexed = false;
565
- return;
566
- }
567
-
568
- this._documents = docs
569
- .filter(
570
- (d) =>
571
- d &&
572
- typeof d.id === 'string' &&
573
- typeof d.text === 'string' &&
574
- d.text.trim().length > 0,
575
- )
576
- .map((d) => ({
577
- ...d,
578
- tags: Array.from(new Set([...(d.tags ?? []), ...globalTags])),
579
- }));
580
-
581
- this._tokenizedDocs = this._documents.map((doc) => tokenize(doc.text));
582
- this._docTfs = this._tokenizedDocs.map((tokens) => termFrequency(tokens));
583
- this._idf = inverseDocumentFrequency(this._tokenizedDocs);
584
- this._indexed = this._documents.length > 0;
585
- }
586
-
587
- /** @returns A single search tool using the configured `tool_name` (default `search_knowledge`). */
588
- getTools(): SkillToolDefinition[] {
589
- const toolName = this.getConfig<string>('tool_name', 'search_knowledge');
590
- const defaultCount = this.getConfig<number>('count', 5);
591
- const description = this.getConfig<string>(
592
- 'description',
593
- 'Search the knowledge base for information',
594
- );
595
-
596
- return [
597
- {
598
- name: toolName,
599
- description,
600
- parameters: {
601
- query: {
602
- type: 'string',
603
- description: 'Search query or question',
604
- },
605
- count: {
606
- type: 'integer',
607
- description: `Number of results to return (default: ${defaultCount})`,
608
- default: defaultCount,
609
- },
610
- },
611
- required: ['query'],
612
- handler: async (
613
- args: Record<string, unknown>,
614
- rawData: Record<string, unknown>,
615
- ) => this._searchHandler(args, rawData),
616
- },
617
- ];
618
- }
619
-
620
- /** @returns Prompt section describing the local document search capabilities. */
621
- protected override _getPromptSections(): SkillPromptSection[] {
622
- const toolName = this.getConfig<string>('tool_name', 'search_knowledge');
623
- const docCount = this._documents.length;
624
- const mode = this.useRemote ? 'remote search server' : 'local document indexes';
625
-
626
- return [
627
- {
628
- title: 'Knowledge Search',
629
- body: `You can search ${mode} using the ${toolName} tool${docCount > 0 ? ` over ${docCount} indexed document(s)` : ''}.`,
630
- bullets: [
631
- `Use the ${toolName} tool when users ask questions about topics that might be in the indexed documents`,
632
- 'Search for relevant information using clear, specific queries',
633
- 'Provide helpful summaries of the search results',
634
- 'If no results are found, suggest the user try rephrasing their question or try another knowledge source',
635
- ],
636
- },
637
- ];
638
- }
639
-
640
- // ---------------------------------------------------------------------------
641
- // Search
642
- // ---------------------------------------------------------------------------
643
-
644
- private async _searchHandler(
645
- args: Record<string, unknown>,
646
- _rawData: Record<string, unknown>,
647
- ): Promise<FunctionResult> {
648
- if (!this.searchAvailable && !this.useRemote) {
649
- // In-memory path — we should still be usable if docs were loaded synchronously
650
- // (constructor path); otherwise report unavailability.
651
- if (!this._indexed || this._documents.length === 0) {
652
- return new FunctionResult(
653
- 'No documents are loaded for searching. Configure the skill with a "documents" array or a "remote_url".',
654
- );
655
- }
656
- }
657
-
658
- const query =
659
- typeof args['query'] === 'string' ? (args['query'] as string).trim() : '';
660
- if (!query) {
661
- return new FunctionResult('Please provide a search query.');
662
- }
663
-
664
- const count = Math.max(
665
- 1,
666
- Math.min(20, (args['count'] as number | undefined) ?? this.count),
667
- );
668
-
669
- let results: SearchResult[] = [];
670
- try {
671
- if (this.useRemote) {
672
- results = await this._searchRemote(query, count);
673
- } else {
674
- results = this._searchLocal(query, count);
675
- }
676
- } catch (err) {
677
- log.error('native_vector_search: search error', {
678
- error: err instanceof Error ? err.message : String(err),
679
- });
680
- return new FunctionResult(
681
- "I'm sorry, I encountered an issue while searching. Please try rephrasing your question.",
682
- );
683
- }
684
-
685
- if (results.length === 0) {
686
- let msg = this.noResultsMessage.replace('{query}', query);
687
- if (this.responsePrefix) msg = `${this.responsePrefix} ${msg}`;
688
- if (this.responsePostfix) msg = `${msg} ${this.responsePostfix}`;
689
-
690
- if (typeof this.responseFormatCallback === 'function') {
691
- try {
692
- const formatted = this.responseFormatCallback({
693
- response: msg,
694
- agent: this.agent,
695
- query,
696
- results: [],
697
- args,
698
- count,
699
- skill: this,
700
- });
701
- if (typeof formatted === 'string') msg = formatted;
702
- } catch (err) {
703
- log.error(
704
- 'native_vector_search: response_format_callback error (no results)',
705
- { error: err instanceof Error ? err.message : String(err) },
706
- );
707
- }
708
- }
709
- return new FunctionResult(msg);
710
- }
711
-
712
- // Compose formatted response with per-result truncation
713
- const responseParts: string[] = [];
714
- if (this.responsePrefix) responseParts.push(this.responsePrefix);
715
- responseParts.push(`Found ${results.length} relevant results for '${query}':\n`);
716
-
717
- const estimatedOverheadPerResult = 300;
718
- const prefixPostfixOverhead =
719
- this.responsePrefix.length + this.responsePostfix.length + 100;
720
- const totalOverhead =
721
- results.length * estimatedOverheadPerResult + prefixPostfixOverhead;
722
- const available = this.maxContentLength - totalOverhead;
723
- const perResultLimit =
724
- results.length > 0
725
- ? Math.max(500, Math.floor(available / results.length))
726
- : 1000;
727
-
728
- results.forEach((r, i) => {
729
- const filename =
730
- (r.metadata['filename'] as string | undefined) ?? `result-${i + 1}`;
731
- const section = (r.metadata['section'] as string | undefined) ?? '';
732
- const score = r.score;
733
- let content = r.content;
734
- if (content.length > perResultLimit) {
735
- content = content.slice(0, perResultLimit) + '...';
736
- }
737
- const tags = (r.metadata['tags'] as string[] | undefined) ?? [];
738
-
739
- let text = `**Result ${i + 1}** (from ${filename}`;
740
- if (section) text += `, section: ${section}`;
741
- if (tags.length > 0) text += `, tags: ${tags.join(', ')}`;
742
- text += `, relevance: ${score.toFixed(2)})\n${content}\n`;
743
- responseParts.push(text);
744
- });
745
-
746
- if (this.responsePostfix) responseParts.push(this.responsePostfix);
747
-
748
- let response = responseParts.join('\n');
749
-
750
- if (typeof this.responseFormatCallback === 'function') {
751
- try {
752
- const formatted = this.responseFormatCallback({
753
- response,
754
- agent: this.agent,
755
- query,
756
- results,
757
- args,
758
- count,
759
- skill: this,
760
- });
761
- if (typeof formatted === 'string') {
762
- response = formatted;
763
- } else {
764
- log.warn(
765
- 'native_vector_search: response_format_callback returned non-string',
766
- );
767
- }
768
- } catch (err) {
769
- log.error('native_vector_search: response_format_callback error', {
770
- error: err instanceof Error ? err.message : String(err),
771
- });
772
- }
773
- }
774
-
775
- return new FunctionResult(response);
776
- }
777
-
778
- private _searchLocal(query: string, count: number): SearchResult[] {
779
- const queryTokens = tokenize(query);
780
- if (queryTokens.length === 0) return [];
781
-
782
- // Mirrors Python search_engine.py line 449: None → 0.3.
783
- const weight = this.keywordWeight ?? 0.3;
784
- const scored = this._documents.map((doc, i) => {
785
- const tfidf = scoreTfIdf(queryTokens, this._docTfs[i], this._idf);
786
- let score: number;
787
- if (weight > 0) {
788
- // Keyword-overlap component: fraction of unique query terms present in doc.
789
- // Mirrors Python: `keyword_weight=self.keyword_weight` passed to
790
- // `search_engine.search()` for hybrid TF-IDF + keyword scoring.
791
- const docTokenSet = new Set(this._tokenizedDocs[i]);
792
- const uniqueQueryTokens = new Set(queryTokens);
793
- let matches = 0;
794
- for (const t of uniqueQueryTokens) {
795
- if (docTokenSet.has(t)) matches++;
796
- }
797
- const keywordOverlap = uniqueQueryTokens.size > 0 ? matches / uniqueQueryTokens.size : 0;
798
- score = tfidf * (1 - weight) + keywordOverlap * weight;
799
- } else {
800
- score = tfidf;
801
- }
802
- return { doc, score };
803
- });
804
-
805
- const filtered = scored
806
- .filter((s) => s.score > this.similarityThreshold)
807
- .filter((s) => {
808
- if (this.filterTags.length === 0) return true;
809
- const docTags = s.doc.tags ?? [];
810
- return this.filterTags.some((t) => docTags.includes(t));
811
- });
812
-
813
- filtered.sort((a, b) => b.score - a.score);
814
-
815
- return filtered.slice(0, count).map(({ doc, score }) => ({
816
- content: doc.text,
817
- score,
818
- metadata: {
819
- filename: doc.id,
820
- ...(doc.metadata ?? {}),
821
- tags: doc.tags ?? [],
822
- },
823
- }));
824
- }
825
-
826
- /** Perform search against a remote search server. */
827
- private async _searchRemote(
828
- query: string,
829
- count: number,
830
- ): Promise<SearchResult[]> {
831
- if (!this.remoteBaseUrl) return [];
832
-
833
- try {
834
- const body = {
835
- query,
836
- index_name: this.indexName,
837
- count,
838
- similarity_threshold: this.similarityThreshold,
839
- tags: this.filterTags,
840
- };
841
-
842
- const response = await this._fetchWithAuth(
843
- `${this.remoteBaseUrl}/search`,
844
- {
845
- method: 'POST',
846
- headers: { 'Content-Type': 'application/json' },
847
- body: JSON.stringify(body),
848
- },
849
- );
850
-
851
- if (response.status !== 200) {
852
- log.error('native_vector_search: remote search failed', {
853
- status: response.status,
854
- });
855
- return [];
856
- }
857
- const data = (await response.json()) as {
858
- results?: Array<{
859
- content: string;
860
- score: number;
861
- metadata: Record<string, unknown>;
862
- }>;
863
- };
864
- return (data.results ?? []).map((r) => ({
865
- content: r.content,
866
- score: r.score,
867
- metadata: r.metadata,
868
- }));
869
- } catch (err) {
870
- log.error('native_vector_search: remote search error', {
871
- error: err instanceof Error ? err.message : String(err),
872
- });
873
- return [];
874
- }
875
- }
876
-
877
- /** Fetch wrapper that injects Basic auth if configured. */
878
- private async _fetchWithAuth(
879
- url: string,
880
- init: RequestInit = {},
881
- timeoutMs = 30_000,
882
- ): Promise<Response> {
883
- const headers: Record<string, string> = {
884
- Accept: 'application/json',
885
- ...((init.headers as Record<string, string>) ?? {}),
886
- };
887
- if (this.remoteAuth) {
888
- const creds = Buffer.from(
889
- `${this.remoteAuth.user}:${this.remoteAuth.pass}`,
890
- ).toString('base64');
891
- headers['Authorization'] = `Basic ${creds}`;
892
- }
893
- const controller = new AbortController();
894
- const timer = setTimeout(() => controller.abort(), timeoutMs);
895
- try {
896
- return await fetch(url, { ...init, headers, signal: controller.signal });
897
- } finally {
898
- clearTimeout(timer);
899
- }
900
- }
901
- }
902
-
903
- /**
904
- * Factory function for creating NativeVectorSearchSkill instances.
905
- * @param config - Optional skill configuration.
906
- * @returns A new NativeVectorSearchSkill instance.
907
- */
908
- export function createSkill(config?: SkillConfig): NativeVectorSearchSkill {
909
- return new NativeVectorSearchSkill(config);
910
- }