@signalwire/sdk 2.0.0

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 (325) hide show
  1. package/.github/workflows/publish.yml +27 -0
  2. package/.github/workflows/test.yml +17 -0
  3. package/CLAUDE.md +112 -0
  4. package/README.md +254 -0
  5. package/docs/MIGRATION-2.0.md +81 -0
  6. package/docs/agent-guide.md +869 -0
  7. package/docs/agent_guide.md +1026 -0
  8. package/docs/api-reference.md +2420 -0
  9. package/docs/api_reference.md +1301 -0
  10. package/docs/architecture.md +843 -0
  11. package/docs/cli-guide.md +579 -0
  12. package/docs/cli_guide.md +448 -0
  13. package/docs/cloud_functions_guide.md +474 -0
  14. package/docs/configuration.md +422 -0
  15. package/docs/contexts-guide.md +787 -0
  16. package/docs/contexts_guide.md +511 -0
  17. package/docs/datamap-guide.md +1141 -0
  18. package/docs/datamap_guide.md +595 -0
  19. package/docs/llm_parameters.md +239 -0
  20. package/docs/mcp_gateway_reference.md +648 -0
  21. package/docs/mcp_integration.md +108 -0
  22. package/docs/prefabs-guide.md +800 -0
  23. package/docs/sdk_features.md +477 -0
  24. package/docs/security.md +436 -0
  25. package/docs/serverless-guide.md +513 -0
  26. package/docs/skills-guide.md +857 -0
  27. package/docs/skills-system.md +301 -0
  28. package/docs/skills_parameter_schema.md +392 -0
  29. package/docs/skills_system.md +467 -0
  30. package/docs/swaig-reference.md +1627 -0
  31. package/docs/swaig_reference.md +910 -0
  32. package/docs/swml_service_guide.md +600 -0
  33. package/docs/third_party_skills.md +533 -0
  34. package/docs/web_service.md +677 -0
  35. package/examples/README.md +131 -0
  36. package/examples/advanced-datamap.ts +100 -0
  37. package/examples/advanced-dynamic-config.ts +70 -0
  38. package/examples/auto-vivified.ts +94 -0
  39. package/examples/call-flow.ts +63 -0
  40. package/examples/comprehensive-dynamic.ts +125 -0
  41. package/examples/contexts-steps.ts +65 -0
  42. package/examples/custom-path.ts +45 -0
  43. package/examples/datamap-tools.ts +55 -0
  44. package/examples/datasphere-multi-instance.ts +63 -0
  45. package/examples/datasphere-serverless-env.ts +68 -0
  46. package/examples/datasphere-webhook-env.ts +66 -0
  47. package/examples/datasphere.ts +37 -0
  48. package/examples/declarative.ts +100 -0
  49. package/examples/dynamic-config.ts +54 -0
  50. package/examples/dynamic-info-gatherer.ts +69 -0
  51. package/examples/dynamic-swml-service.ts +67 -0
  52. package/examples/gather-info.ts +71 -0
  53. package/examples/gather-per-question-functions-demo.ts +140 -0
  54. package/examples/joke-agent.ts +34 -0
  55. package/examples/kubernetes-agent.ts +45 -0
  56. package/examples/llm-params.ts +69 -0
  57. package/examples/mcp-agent.ts +84 -0
  58. package/examples/mcp-gateway.ts +35 -0
  59. package/examples/multi-agent.ts +73 -0
  60. package/examples/multi-endpoint.ts +79 -0
  61. package/examples/pom-prompt.ts +71 -0
  62. package/examples/prefab-concierge.ts +47 -0
  63. package/examples/prefab-faq.ts +54 -0
  64. package/examples/prefab-info-gatherer.ts +33 -0
  65. package/examples/prefab-receptionist.ts +36 -0
  66. package/examples/prefab-survey.ts +68 -0
  67. package/examples/record-call.ts +67 -0
  68. package/examples/relay-demo.ts +33 -0
  69. package/examples/room-and-sip.ts +94 -0
  70. package/examples/serverless-lambda.ts +35 -0
  71. package/examples/session-state.ts +83 -0
  72. package/examples/simple-agent.ts +36 -0
  73. package/examples/simple-static.ts +29 -0
  74. package/examples/skills-demo.ts +38 -0
  75. package/examples/step-function-inheritance-demo.ts +124 -0
  76. package/examples/swaig-features.ts +187 -0
  77. package/examples/swml-service-routing.ts +66 -0
  78. package/examples/swml-service.ts +38 -0
  79. package/examples/tap.ts +68 -0
  80. package/examples/verb-methods.ts +45 -0
  81. package/examples/web-search-multi-instance.ts +72 -0
  82. package/examples/web-search.ts +38 -0
  83. package/examples/wikipedia.ts +36 -0
  84. package/livewire/README.md +140 -0
  85. package/livewire/docs/migration-guide.md +228 -0
  86. package/livewire/examples/livewire-basic-agent.ts +74 -0
  87. package/livewire/examples/livewire-handoff.ts +197 -0
  88. package/livewire/examples/livewire-multi-tool.ts +117 -0
  89. package/package.json +38 -0
  90. package/relay/README.md +70 -0
  91. package/relay/RELAY_IMPLEMENTATION_GUIDE.md +1257 -0
  92. package/relay/docs/call-methods.md +474 -0
  93. package/relay/docs/client-reference.md +142 -0
  94. package/relay/docs/events.md +134 -0
  95. package/relay/docs/getting-started.md +134 -0
  96. package/relay/docs/guide.md +306 -0
  97. package/relay/docs/messaging.md +182 -0
  98. package/relay/examples/relay-inbound.ts +66 -0
  99. package/relay/examples/relay-messaging.ts +71 -0
  100. package/relay/examples/relay-outbound.ts +76 -0
  101. package/rest/README.md +95 -0
  102. package/rest/docs/calling.md +273 -0
  103. package/rest/docs/client-reference.md +107 -0
  104. package/rest/docs/compat.md +204 -0
  105. package/rest/docs/fabric.md +183 -0
  106. package/rest/docs/getting-started.md +110 -0
  107. package/rest/docs/guide.md +351 -0
  108. package/rest/docs/namespaces.md +285 -0
  109. package/rest/examples/rest-10dlc-registration.ts +161 -0
  110. package/rest/examples/rest-calling-ivr-and-ai.ts +102 -0
  111. package/rest/examples/rest-calling-play-and-record.ts +91 -0
  112. package/rest/examples/rest-client.ts +65 -0
  113. package/rest/examples/rest-compat-laml.ts +210 -0
  114. package/rest/examples/rest-datasphere-search.ts +82 -0
  115. package/rest/examples/rest-fabric-conferences-and-routing.ts +144 -0
  116. package/rest/examples/rest-fabric-subscribers-and-sip.ts +108 -0
  117. package/rest/examples/rest-fabric-swml-and-callflows.ts +99 -0
  118. package/rest/examples/rest-manage-resources.ts +65 -0
  119. package/rest/examples/rest-phone-number-management.ts +197 -0
  120. package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
  121. package/rest/examples/rest-video-rooms.ts +186 -0
  122. package/src/AgentBase.ts +2489 -0
  123. package/src/AgentServer.ts +415 -0
  124. package/src/AuthHandler.ts +256 -0
  125. package/src/ConfigLoader.ts +447 -0
  126. package/src/ContextBuilder.ts +1150 -0
  127. package/src/DataMap.ts +449 -0
  128. package/src/FunctionResult.ts +866 -0
  129. package/src/Logger.ts +337 -0
  130. package/src/PomBuilder.ts +439 -0
  131. package/src/PromptManager.ts +133 -0
  132. package/src/SWMLHandler.ts +298 -0
  133. package/src/SWMLService.ts +717 -0
  134. package/src/SchemaUtils.ts +361 -0
  135. package/src/SecurityUtils.ts +153 -0
  136. package/src/ServerlessAdapter.ts +221 -0
  137. package/src/SessionManager.ts +311 -0
  138. package/src/SslConfig.ts +118 -0
  139. package/src/SwaigFunction.ts +276 -0
  140. package/src/SwmlBuilder.ts +258 -0
  141. package/src/SwmlVerbMethods.generated.ts +234 -0
  142. package/src/TypeInference.ts +181 -0
  143. package/src/WebService.ts +619 -0
  144. package/src/cli/agent-loader.ts +166 -0
  145. package/src/cli/mock-data.ts +111 -0
  146. package/src/cli/swaig-test.ts +452 -0
  147. package/src/generateVerbTypes.ts +322 -0
  148. package/src/index.ts +167 -0
  149. package/src/livewire/index.ts +950 -0
  150. package/src/prefabs/ConciergeAgent.ts +287 -0
  151. package/src/prefabs/FAQBotAgent.ts +384 -0
  152. package/src/prefabs/InfoGathererAgent.ts +339 -0
  153. package/src/prefabs/ReceptionistAgent.ts +366 -0
  154. package/src/prefabs/SurveyAgent.ts +646 -0
  155. package/src/prefabs/index.ts +27 -0
  156. package/src/relay/Action.ts +314 -0
  157. package/src/relay/Call.ts +854 -0
  158. package/src/relay/Deferred.ts +71 -0
  159. package/src/relay/Message.ts +148 -0
  160. package/src/relay/RelayClient.ts +1036 -0
  161. package/src/relay/RelayError.ts +14 -0
  162. package/src/relay/RelayEvent.ts +892 -0
  163. package/src/relay/constants.ts +132 -0
  164. package/src/relay/index.ts +123 -0
  165. package/src/relay/types.ts +149 -0
  166. package/src/rest/HttpClient.ts +103 -0
  167. package/src/rest/RestError.ts +31 -0
  168. package/src/rest/base/BaseResource.ts +19 -0
  169. package/src/rest/base/CrudResource.ts +51 -0
  170. package/src/rest/base/CrudWithAddresses.ts +26 -0
  171. package/src/rest/index.ts +200 -0
  172. package/src/rest/namespaces/addresses.ts +32 -0
  173. package/src/rest/namespaces/calling.ts +187 -0
  174. package/src/rest/namespaces/chat.ts +20 -0
  175. package/src/rest/namespaces/compat.ts +352 -0
  176. package/src/rest/namespaces/datasphere.ts +45 -0
  177. package/src/rest/namespaces/fabric.ts +222 -0
  178. package/src/rest/namespaces/imported-numbers.ts +20 -0
  179. package/src/rest/namespaces/logs.ts +84 -0
  180. package/src/rest/namespaces/lookup.ts +21 -0
  181. package/src/rest/namespaces/mfa.ts +30 -0
  182. package/src/rest/namespaces/number-groups.ts +38 -0
  183. package/src/rest/namespaces/phone-numbers.ts +44 -0
  184. package/src/rest/namespaces/project.ts +36 -0
  185. package/src/rest/namespaces/pubsub.ts +20 -0
  186. package/src/rest/namespaces/queues.ts +33 -0
  187. package/src/rest/namespaces/recordings.ts +28 -0
  188. package/src/rest/namespaces/registry.ts +101 -0
  189. package/src/rest/namespaces/short-codes.ts +28 -0
  190. package/src/rest/namespaces/sip-profile.ts +25 -0
  191. package/src/rest/namespaces/verified-callers.ts +27 -0
  192. package/src/rest/namespaces/video.ts +165 -0
  193. package/src/rest/pagination.ts +84 -0
  194. package/src/rest/types.ts +61 -0
  195. package/src/schema.json +12250 -0
  196. package/src/skills/SkillBase.ts +547 -0
  197. package/src/skills/SkillManager.ts +415 -0
  198. package/src/skills/SkillRegistry.ts +367 -0
  199. package/src/skills/builtin/api_ninjas_trivia.ts +280 -0
  200. package/src/skills/builtin/ask_claude.ts +241 -0
  201. package/src/skills/builtin/claude_skills.ts +978 -0
  202. package/src/skills/builtin/custom_skills.ts +312 -0
  203. package/src/skills/builtin/datasphere.ts +438 -0
  204. package/src/skills/builtin/datasphere_serverless.ts +339 -0
  205. package/src/skills/builtin/datetime.ts +130 -0
  206. package/src/skills/builtin/google_maps.ts +651 -0
  207. package/src/skills/builtin/index.ts +88 -0
  208. package/src/skills/builtin/info_gatherer.ts +405 -0
  209. package/src/skills/builtin/joke.ts +191 -0
  210. package/src/skills/builtin/math.ts +142 -0
  211. package/src/skills/builtin/mcp_gateway.ts +677 -0
  212. package/src/skills/builtin/native_vector_search.ts +901 -0
  213. package/src/skills/builtin/play_background_file.ts +358 -0
  214. package/src/skills/builtin/spider.ts +869 -0
  215. package/src/skills/builtin/swml_transfer.ts +635 -0
  216. package/src/skills/builtin/weather_api.ts +248 -0
  217. package/src/skills/builtin/web_search.ts +1074 -0
  218. package/src/skills/builtin/wikipedia_search.ts +299 -0
  219. package/src/skills/index.ts +12 -0
  220. package/src/types.ts +132 -0
  221. package/tests/AgentBase.test.ts +1093 -0
  222. package/tests/AgentServer.test.ts +126 -0
  223. package/tests/AuthHandler.test.ts +133 -0
  224. package/tests/ConfigLoader.test.ts +151 -0
  225. package/tests/ContextBuilder.test.ts +108 -0
  226. package/tests/DataMap.test.ts +367 -0
  227. package/tests/EphemeralSkillCopy.test.ts +107 -0
  228. package/tests/FunctionResult.test.ts +298 -0
  229. package/tests/GracefulShutdown.test.ts +46 -0
  230. package/tests/Logger.test.ts +420 -0
  231. package/tests/PomBuilder.test.ts +228 -0
  232. package/tests/ProxyDetection.test.ts +228 -0
  233. package/tests/SWMLService.test.ts +320 -0
  234. package/tests/SWMLVerbHandler.test.ts +523 -0
  235. package/tests/SchemaUtils.test.ts +106 -0
  236. package/tests/SchemaUtils.verb.test.ts +206 -0
  237. package/tests/SecurityUtils.test.ts +192 -0
  238. package/tests/ServerlessAdapter.test.ts +222 -0
  239. package/tests/SessionManager.test.ts +257 -0
  240. package/tests/SkillBaseFeatures.test.ts +130 -0
  241. package/tests/SkillMultiInstance.test.ts +102 -0
  242. package/tests/SkillParameterSchemas.test.ts +134 -0
  243. package/tests/SkillRegistrySchema.test.ts +84 -0
  244. package/tests/SslConfig.test.ts +97 -0
  245. package/tests/SwmlBuilder.test.ts +400 -0
  246. package/tests/TypeInference.test.ts +165 -0
  247. package/tests/VerbHandlerRegistry.test.ts +128 -0
  248. package/tests/cli/mock-data.test.ts +113 -0
  249. package/tests/cli/swaig-test.test.ts +108 -0
  250. package/tests/examples.test.ts +194 -0
  251. package/tests/fixtures/scrape-parity/README.md +53 -0
  252. package/tests/fixtures/scrape-parity/expected/01_simple_article.json +5 -0
  253. package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +5 -0
  254. package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +5 -0
  255. package/tests/fixtures/scrape-parity/expected/04_bare_body.json +5 -0
  256. package/tests/fixtures/scrape-parity/expected/05_malformed.json +5 -0
  257. package/tests/fixtures/scrape-parity/expected/06_multi_class.json +5 -0
  258. package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +5 -0
  259. package/tests/fixtures/scrape-parity/expected/08_inline_script.json +5 -0
  260. package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +5 -0
  261. package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +5 -0
  262. package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +5 -0
  263. package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +5 -0
  264. package/tests/fixtures/scrape-parity/html/01_simple_article.html +18 -0
  265. package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +18 -0
  266. package/tests/fixtures/scrape-parity/html/03_nested_containers.html +13 -0
  267. package/tests/fixtures/scrape-parity/html/04_bare_body.html +9 -0
  268. package/tests/fixtures/scrape-parity/html/05_malformed.html +11 -0
  269. package/tests/fixtures/scrape-parity/html/06_multi_class.html +18 -0
  270. package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +12 -0
  271. package/tests/fixtures/scrape-parity/html/08_inline_script.html +17 -0
  272. package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +21 -0
  273. package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +10 -0
  274. package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +13 -0
  275. package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +24 -0
  276. package/tests/fixtures/scrape-parity/python_extract.py +109 -0
  277. package/tests/livewire/livewire.test.ts +780 -0
  278. package/tests/mcp.test.ts +221 -0
  279. package/tests/prefabs/prefabs.test.ts +1093 -0
  280. package/tests/relay/Action.test.ts +392 -0
  281. package/tests/relay/Call.test.ts +535 -0
  282. package/tests/relay/Deferred.test.ts +71 -0
  283. package/tests/relay/Message.test.ts +164 -0
  284. package/tests/relay/RelayClient.test.ts +779 -0
  285. package/tests/relay/RelayEvent.test.ts +463 -0
  286. package/tests/relay/helpers.ts +79 -0
  287. package/tests/rest/HttpClient.test.ts +274 -0
  288. package/tests/rest/RestError.test.ts +53 -0
  289. package/tests/rest/calling.test.ts +156 -0
  290. package/tests/rest/client.test.ts +197 -0
  291. package/tests/rest/compat.test.ts +335 -0
  292. package/tests/rest/datasphere.test.ts +71 -0
  293. package/tests/rest/fabric.test.ts +186 -0
  294. package/tests/rest/helpers.ts +95 -0
  295. package/tests/rest/logs.test.ts +68 -0
  296. package/tests/rest/pagination.test.ts +133 -0
  297. package/tests/rest/registry.test.ts +94 -0
  298. package/tests/rest/relay-rest.test.ts +290 -0
  299. package/tests/rest/video.test.ts +173 -0
  300. package/tests/setup.ts +6 -0
  301. package/tests/skills/SkillBase.test.ts +108 -0
  302. package/tests/skills/SkillManager.test.ts +268 -0
  303. package/tests/skills/SkillRegistry.test.ts +176 -0
  304. package/tests/skills/builtin.test.ts +1472 -0
  305. package/tests/skills/claude-skills.test.ts +54 -0
  306. package/tests/skills/custom-skills.test.ts +53 -0
  307. package/tests/skills/datasphere-serverless.test.ts +70 -0
  308. package/tests/skills/datasphere.test.ts +107 -0
  309. package/tests/skills/datetime.test.ts +101 -0
  310. package/tests/skills/google-maps.test.ts +78 -0
  311. package/tests/skills/info-gatherer.test.ts +411 -0
  312. package/tests/skills/joke.test.ts +81 -0
  313. package/tests/skills/math.test.ts +68 -0
  314. package/tests/skills/mcp-gateway.test.ts +101 -0
  315. package/tests/skills/play-background.test.ts +54 -0
  316. package/tests/skills/spider.test.ts +108 -0
  317. package/tests/skills/swml-transfer.test.ts +178 -0
  318. package/tests/skills/trivia.test.ts +54 -0
  319. package/tests/skills/vector-search.test.ts +135 -0
  320. package/tests/skills/weather-api.test.ts +77 -0
  321. package/tests/skills/web-search-parity.test.ts +59 -0
  322. package/tests/skills/web-search.test.ts +103 -0
  323. package/tests/skills/wikipedia.test.ts +63 -0
  324. package/tsconfig.json +18 -0
  325. package/vitest.config.ts +9 -0
@@ -0,0 +1,54 @@
1
+ /**
2
+ * Individual tests for the PlayBackgroundFile skill.
3
+ */
4
+
5
+ import { describe, it, expect, beforeAll } from 'vitest';
6
+ import { PlayBackgroundFileSkill, createPlayBackgroundFileSkill } from '../../src/skills/builtin/index.js';
7
+ import { SkillBase } from '../../src/skills/SkillBase.js';
8
+ import { FunctionResult } from '../../src/FunctionResult.js';
9
+ import { suppressAllLogs } from '../../src/Logger.js';
10
+
11
+ beforeAll(() => { suppressAllLogs(true); });
12
+
13
+ describe('PlayBackgroundFileSkill', () => {
14
+ it('should instantiate via constructor and factory', () => {
15
+ expect(new PlayBackgroundFileSkill()).toBeInstanceOf(SkillBase);
16
+ expect(createPlayBackgroundFileSkill()).toBeInstanceOf(PlayBackgroundFileSkill);
17
+ });
18
+
19
+ it('should complete setup without errors', async () => {
20
+ await expect(new PlayBackgroundFileSkill().setup()).resolves.toBe(true);
21
+ });
22
+
23
+ it('should register tools', () => {
24
+ const tools = new PlayBackgroundFileSkill().getTools();
25
+ expect(tools.length).toBeGreaterThan(0);
26
+ expect(tools[0].handler).toBeTypeOf('function');
27
+ });
28
+
29
+ it('should provide prompt sections', () => {
30
+ const sections = new PlayBackgroundFileSkill().getPromptSections();
31
+ expect(sections.length).toBeGreaterThan(0);
32
+ });
33
+
34
+ it('should skip prompt sections when skip_prompt is set', () => {
35
+ expect(new PlayBackgroundFileSkill({ skip_prompt: true }).getPromptSections()).toHaveLength(0);
36
+ });
37
+
38
+ it('should return empty hints and global data', () => {
39
+ const skill = new PlayBackgroundFileSkill();
40
+ expect(skill.getHints()).toEqual([]);
41
+ expect(skill.getGlobalData()).toEqual({});
42
+ });
43
+
44
+ it('should return correct manifest', () => {
45
+ const klass = PlayBackgroundFileSkill as typeof SkillBase;
46
+ expect(klass.SKILL_NAME).toBe('play_background_file');
47
+ expect(klass.SKILL_VERSION).toBe('1.0.0');
48
+ });
49
+
50
+ it('should have a parameter schema', () => {
51
+ const schema = PlayBackgroundFileSkill.getParameterSchema();
52
+ expect(schema).toBeDefined();
53
+ });
54
+ });
@@ -0,0 +1,108 @@
1
+ /**
2
+ * Individual tests for the Spider skill.
3
+ */
4
+
5
+ import { describe, it, expect, beforeAll } from 'vitest';
6
+ import { SpiderSkill, createSpiderSkill } from '../../src/skills/builtin/index.js';
7
+ import { SkillBase } from '../../src/skills/SkillBase.js';
8
+ import { FunctionResult } from '../../src/FunctionResult.js';
9
+ import { suppressAllLogs } from '../../src/Logger.js';
10
+
11
+ beforeAll(() => { suppressAllLogs(true); });
12
+
13
+ describe('SpiderSkill', () => {
14
+ it('should instantiate via constructor and factory', () => {
15
+ expect(new SpiderSkill()).toBeInstanceOf(SkillBase);
16
+ expect(createSpiderSkill()).toBeInstanceOf(SpiderSkill);
17
+ });
18
+
19
+ it('should complete setup without errors', async () => {
20
+ await expect(new SpiderSkill().setup()).resolves.toBe(true);
21
+ });
22
+
23
+ it('should register three tools', async () => {
24
+ const skill = new SpiderSkill();
25
+ await skill.setup();
26
+ const tools = skill.getTools();
27
+ expect(tools).toHaveLength(3);
28
+ const names = tools.map((t) => t.name);
29
+ expect(names).toContain('scrape_url');
30
+ expect(names).toContain('crawl_site');
31
+ expect(names).toContain('extract_structured_data');
32
+ expect(tools[0].required).toContain('url');
33
+ });
34
+
35
+ it('should provide no prompt sections (matches Python — no override)', () => {
36
+ const sections = new SpiderSkill().getPromptSections();
37
+ expect(sections).toHaveLength(0);
38
+ });
39
+
40
+ it('should skip prompt sections when skip_prompt is set', () => {
41
+ expect(new SpiderSkill({ skip_prompt: true }).getPromptSections()).toHaveLength(0);
42
+ });
43
+
44
+ it('should return speech recognition hints', () => {
45
+ const hints = new SpiderSkill().getHints();
46
+ expect(hints).toContain('scrape');
47
+ expect(hints).toContain('spider');
48
+ expect(hints.length).toBeGreaterThanOrEqual(8);
49
+ });
50
+
51
+ it('should return empty global data', () => {
52
+ expect(new SpiderSkill().getGlobalData()).toEqual({});
53
+ });
54
+
55
+ it('should return correct manifest', () => {
56
+ const klass = SpiderSkill as typeof SkillBase;
57
+ expect(klass.SKILL_NAME).toBe('spider');
58
+ expect(klass.SKILL_VERSION).toBe('1.0.0');
59
+ });
60
+
61
+ it('should have full parameter schema', () => {
62
+ const schema = SpiderSkill.getParameterSchema();
63
+ expect(schema['delay']).toBeDefined();
64
+ expect(schema['concurrent_requests']).toBeDefined();
65
+ expect(schema['timeout']).toBeDefined();
66
+ expect(schema['max_pages']).toBeDefined();
67
+ expect(schema['max_depth']).toBeDefined();
68
+ expect(schema['extract_type']).toBeDefined();
69
+ expect(schema['max_text_length']).toBeDefined();
70
+ expect(schema['clean_text']).toBeDefined();
71
+ expect(schema['selectors']).toBeDefined();
72
+ expect(schema['follow_patterns']).toBeDefined();
73
+ expect(schema['user_agent']).toBeDefined();
74
+ expect(schema['headers']).toBeDefined();
75
+ expect(schema['follow_robots_txt']).toBeDefined();
76
+ expect(schema['cache_enabled']).toBeDefined();
77
+ });
78
+
79
+ it('should support multiple instances', () => {
80
+ expect(SpiderSkill.SUPPORTS_MULTIPLE_INSTANCES).toBe(true);
81
+ const skill = new SpiderSkill({ tool_name: 'custom' });
82
+ expect(skill.getInstanceKey()).toBe('spider_custom');
83
+ });
84
+
85
+ it('should validate URL format in scrape_url handler', async () => {
86
+ const skill = new SpiderSkill();
87
+ await skill.setup();
88
+ const handler = skill.getTools().find((t) => t.name === 'scrape_url')!.handler;
89
+ const res = (await handler({ url: 'not-a-url' }, {})) as FunctionResult;
90
+ expect(res.response).toMatch(/Invalid URL/i);
91
+ });
92
+
93
+ it('should require selectors for extract_structured_data', async () => {
94
+ const skill = new SpiderSkill();
95
+ await skill.setup();
96
+ const handler = skill
97
+ .getTools()
98
+ .find((t) => t.name === 'extract_structured_data')!.handler;
99
+ // URL is fine but selectors are empty, so we get an error before any fetch
100
+ const res = (await handler(
101
+ { url: 'https://example.com' },
102
+ {},
103
+ )) as FunctionResult;
104
+ // Either SSRF validation or missing selectors should trigger an error
105
+ expect(typeof res.response).toBe('string');
106
+ expect(res.response.length).toBeGreaterThan(0);
107
+ });
108
+ });
@@ -0,0 +1,178 @@
1
+ /**
2
+ * Individual tests for the SwmlTransfer skill.
3
+ */
4
+
5
+ import { describe, it, expect, beforeAll } from 'vitest';
6
+ import { SwmlTransferSkill, createSwmlTransferSkill } from '../../src/skills/builtin/index.js';
7
+ import { SkillBase } from '../../src/skills/SkillBase.js';
8
+ import { FunctionResult } from '../../src/FunctionResult.js';
9
+ import { suppressAllLogs } from '../../src/Logger.js';
10
+
11
+ beforeAll(() => { suppressAllLogs(true); });
12
+
13
+ describe('SwmlTransferSkill', () => {
14
+ it('should instantiate via constructor and factory', () => {
15
+ expect(new SwmlTransferSkill()).toBeInstanceOf(SkillBase);
16
+ expect(createSwmlTransferSkill()).toBeInstanceOf(SwmlTransferSkill);
17
+ });
18
+
19
+ it('should return false from setup when neither transfers nor patterns configured', async () => {
20
+ // Python parity (skills/swml_transfer/skill.py:132-136): setup() returns
21
+ // false with an error log when `transfers` is absent. TS additionally
22
+ // accepts a `patterns` array, but requires at least one of the two.
23
+ await expect(new SwmlTransferSkill().setup()).resolves.toBe(false);
24
+ });
25
+
26
+ it('should register transfer_call tool when patterns configured', async () => {
27
+ const skill = new SwmlTransferSkill({
28
+ patterns: [{ name: 'sales', destination: '+15551112222' }],
29
+ });
30
+ await skill.setup();
31
+ const tools = skill.getTools();
32
+ expect(tools.length).toBeGreaterThan(0);
33
+ expect(tools[0].name).toBe('transfer_call');
34
+ expect(tools[0].handler).toBeTypeOf('function');
35
+ });
36
+
37
+ it('should use custom tool_name if provided', async () => {
38
+ const skill = new SwmlTransferSkill({
39
+ tool_name: 'my_transfer',
40
+ patterns: [{ name: 'sales', destination: '+15551112222' }],
41
+ });
42
+ await skill.setup();
43
+ expect(skill.getTools()[0].name).toBe('my_transfer');
44
+ });
45
+
46
+ it('should register list_transfer_destinations when patterns configured', async () => {
47
+ const skill = new SwmlTransferSkill({
48
+ patterns: [{ name: 'sales', destination: '+15551112222' }],
49
+ });
50
+ await skill.setup();
51
+ const names = skill.getTools().map((t) => t.name);
52
+ expect(names).toContain('list_transfer_destinations');
53
+ });
54
+
55
+ it('should emit no prompt sections when unconfigured (Python parity)', () => {
56
+ // Python returns [] when self.transfers is empty; TS matches that so
57
+ // AI prompts aren't polluted by a generic "Call Transfer" section for
58
+ // a skill that has no destinations wired up.
59
+ const sections = new SwmlTransferSkill().getPromptSections();
60
+ expect(sections).toEqual([]);
61
+ });
62
+
63
+ it('should provide prompt sections when patterns configured', () => {
64
+ const sections = new SwmlTransferSkill({
65
+ patterns: [{ name: 'sales', destination: '+15551112222' }],
66
+ }).getPromptSections();
67
+ expect(sections.length).toBeGreaterThan(0);
68
+ });
69
+
70
+ it('should skip prompt sections when skip_prompt is set', () => {
71
+ expect(new SwmlTransferSkill({ skip_prompt: true }).getPromptSections()).toHaveLength(0);
72
+ });
73
+
74
+ it('should return transfer hints', () => {
75
+ const hints = new SwmlTransferSkill().getHints();
76
+ expect(hints).toContain('transfer');
77
+ expect(hints).toContain('connect');
78
+ expect(hints).toContain('speak to');
79
+ expect(hints).toContain('talk to');
80
+ });
81
+
82
+ it('should extract hints from transfer patterns', async () => {
83
+ const skill = new SwmlTransferSkill({
84
+ transfers: {
85
+ sales: { address: '+15551112222' },
86
+ 'billing|accounts': { address: '+15552223333' },
87
+ },
88
+ });
89
+ await skill.setup();
90
+ const hints = skill.getHints();
91
+ expect(hints).toContain('sales');
92
+ expect(hints).toContain('billing');
93
+ expect(hints).toContain('accounts');
94
+ });
95
+
96
+ it('should return empty global data', () => {
97
+ expect(new SwmlTransferSkill().getGlobalData()).toEqual({});
98
+ });
99
+
100
+ it('should return correct manifest', () => {
101
+ const klass = SwmlTransferSkill as typeof SkillBase;
102
+ expect(klass.SKILL_NAME).toBe('swml_transfer');
103
+ expect(klass.SKILL_VERSION).toBe('1.0.0');
104
+ });
105
+
106
+ it('should support multiple instances', () => {
107
+ expect(SwmlTransferSkill.SUPPORTS_MULTIPLE_INSTANCES).toBe(true);
108
+ const a = new SwmlTransferSkill({ tool_name: 'a' });
109
+ const b = new SwmlTransferSkill({ tool_name: 'b' });
110
+ expect(a.getInstanceKey()).not.toBe(b.getInstanceKey());
111
+ });
112
+
113
+ it('should have a full parameter schema', () => {
114
+ const schema = SwmlTransferSkill.getParameterSchema();
115
+ expect(schema['transfers']).toBeDefined();
116
+ expect(schema['tool_name']).toBeDefined();
117
+ expect(schema['description']).toBeDefined();
118
+ expect(schema['parameter_name']).toBeDefined();
119
+ expect(schema['parameter_description']).toBeDefined();
120
+ expect(schema['default_message']).toBeDefined();
121
+ expect(schema['default_post_process']).toBeDefined();
122
+ expect(schema['required_fields']).toBeDefined();
123
+ expect(schema['patterns']).toBeDefined();
124
+ expect(schema['allow_arbitrary']).toBeDefined();
125
+ });
126
+
127
+ it('should transfer to a named pattern destination', async () => {
128
+ const skill = new SwmlTransferSkill({
129
+ patterns: [{ name: 'sales', destination: '+15551112222' }],
130
+ });
131
+ await skill.setup();
132
+ const handler = skill.getTools()[0].handler;
133
+ const res = (await handler({ transfer_type: 'sales' }, {})) as FunctionResult;
134
+ expect(res.action.length).toBeGreaterThan(0);
135
+ });
136
+
137
+ it('should use default_message when destination is unknown and arbitrary disallowed', async () => {
138
+ const skill = new SwmlTransferSkill({
139
+ patterns: [{ name: 'sales', destination: '+15551112222' }],
140
+ allow_arbitrary: false,
141
+ default_message: 'I cannot transfer there.',
142
+ });
143
+ await skill.setup();
144
+ const handler = skill.getTools()[0].handler;
145
+ const res = (await handler({ transfer_type: 'unknown' }, {})) as FunctionResult;
146
+ expect(res.response).toContain('cannot transfer');
147
+ });
148
+
149
+ it('should support Python-style transfers config with regex keys', async () => {
150
+ const skill = new SwmlTransferSkill({
151
+ transfers: {
152
+ sales: { address: '+15551112222', message: 'Connecting to sales.' },
153
+ },
154
+ });
155
+ await skill.setup();
156
+ const handler = skill.getTools()[0].handler;
157
+ const res = (await handler({ transfer_type: 'sales' }, {})) as FunctionResult;
158
+ expect(res.action.length).toBeGreaterThan(0);
159
+ });
160
+
161
+ it('should save required fields to call_data under global_data', async () => {
162
+ const skill = new SwmlTransferSkill({
163
+ patterns: [{ name: 'support', destination: '+15551234567' }],
164
+ required_fields: { name: 'Caller name', reason: 'Reason for calling' },
165
+ });
166
+ await skill.setup();
167
+ const handler = skill.getTools()[0].handler;
168
+ const res = (await handler(
169
+ { transfer_type: 'support', name: 'Alice', reason: 'Billing issue' },
170
+ {},
171
+ )) as FunctionResult;
172
+ // Look for updateGlobalData action with call_data
173
+ const updateAction = res.action.find(
174
+ (a) => typeof a === 'object' && a !== null && 'set_global_data' in a,
175
+ );
176
+ expect(updateAction).toBeDefined();
177
+ });
178
+ });
@@ -0,0 +1,54 @@
1
+ /**
2
+ * Individual tests for the ApiNinjasTrivia skill.
3
+ */
4
+
5
+ import { describe, it, expect, beforeAll } from 'vitest';
6
+ import { ApiNinjasTriviaSkill, createApiNinjasTriviaSkill } from '../../src/skills/builtin/index.js';
7
+ import { SkillBase } from '../../src/skills/SkillBase.js';
8
+ import { FunctionResult } from '../../src/FunctionResult.js';
9
+ import { suppressAllLogs } from '../../src/Logger.js';
10
+
11
+ beforeAll(() => { suppressAllLogs(true); });
12
+
13
+ describe('ApiNinjasTriviaSkill', () => {
14
+ it('should instantiate via constructor and factory', () => {
15
+ expect(new ApiNinjasTriviaSkill()).toBeInstanceOf(SkillBase);
16
+ expect(createApiNinjasTriviaSkill()).toBeInstanceOf(ApiNinjasTriviaSkill);
17
+ });
18
+
19
+ it('should complete setup without errors', async () => {
20
+ await expect(new ApiNinjasTriviaSkill().setup()).resolves.toBe(true);
21
+ });
22
+
23
+ it('should register tools', () => {
24
+ const tools = new ApiNinjasTriviaSkill().getTools();
25
+ expect(tools.length).toBeGreaterThan(0);
26
+ expect(tools[0].handler).toBeTypeOf('function');
27
+ });
28
+
29
+ it('should provide prompt sections', () => {
30
+ const sections = new ApiNinjasTriviaSkill().getPromptSections();
31
+ expect(sections.length).toBeGreaterThan(0);
32
+ });
33
+
34
+ it('should skip prompt sections when skip_prompt is set', () => {
35
+ expect(new ApiNinjasTriviaSkill({ skip_prompt: true }).getPromptSections()).toHaveLength(0);
36
+ });
37
+
38
+ it('should return hints and empty global data', () => {
39
+ const skill = new ApiNinjasTriviaSkill();
40
+ expect(skill.getHints().length).toBeGreaterThan(0);
41
+ expect(skill.getGlobalData()).toEqual({});
42
+ });
43
+
44
+ it('should return correct manifest', () => {
45
+ const klass = ApiNinjasTriviaSkill as typeof SkillBase;
46
+ expect(klass.SKILL_NAME).toBe('api_ninjas_trivia');
47
+ expect(klass.SKILL_VERSION).toBe('1.0.0');
48
+ });
49
+
50
+ it('should have a parameter schema', () => {
51
+ const schema = ApiNinjasTriviaSkill.getParameterSchema();
52
+ expect(schema).toBeDefined();
53
+ });
54
+ });
@@ -0,0 +1,135 @@
1
+ /**
2
+ * Individual tests for the NativeVectorSearch skill.
3
+ */
4
+
5
+ import { describe, it, expect, beforeAll } from 'vitest';
6
+ import { NativeVectorSearchSkill, createNativeVectorSearchSkill } from '../../src/skills/builtin/index.js';
7
+ import { SkillBase } from '../../src/skills/SkillBase.js';
8
+ import { FunctionResult } from '../../src/FunctionResult.js';
9
+ import { suppressAllLogs } from '../../src/Logger.js';
10
+
11
+ beforeAll(() => { suppressAllLogs(true); });
12
+
13
+ describe('NativeVectorSearchSkill', () => {
14
+ it('should instantiate via constructor and factory', () => {
15
+ expect(new NativeVectorSearchSkill()).toBeInstanceOf(SkillBase);
16
+ expect(createNativeVectorSearchSkill()).toBeInstanceOf(NativeVectorSearchSkill);
17
+ });
18
+
19
+ it('should return true from setup in local mode even without documents (Python parity)', async () => {
20
+ // Python skills/native_vector_search/skill.py always returns True from
21
+ // setup() for local mode even when no index is loaded. The "no results"
22
+ // fallback fires at query time. This lets operators fix config and hot-
23
+ // reload without having the SkillManager reject the skill entirely.
24
+ const skill = new NativeVectorSearchSkill();
25
+ await expect(skill.setup()).resolves.toBe(true);
26
+ // searchAvailable still reports the honest state so handler callers see false.
27
+ });
28
+
29
+ it('should register a search tool using configured tool_name', async () => {
30
+ const skill = new NativeVectorSearchSkill({
31
+ tool_name: 'my_search',
32
+ documents: [{ id: 'd1', text: 'hello world' }],
33
+ });
34
+ await skill.setup();
35
+ const tools = skill.getTools();
36
+ expect(tools.length).toBe(1);
37
+ expect(tools[0].name).toBe('my_search');
38
+ expect(tools[0].handler).toBeTypeOf('function');
39
+ });
40
+
41
+ it('should default to search_knowledge tool name', async () => {
42
+ const skill = new NativeVectorSearchSkill();
43
+ await skill.setup();
44
+ expect(skill.getTools()[0].name).toBe('search_knowledge');
45
+ });
46
+
47
+ it('should provide prompt sections', () => {
48
+ const sections = new NativeVectorSearchSkill().getPromptSections();
49
+ expect(sections.length).toBeGreaterThan(0);
50
+ });
51
+
52
+ it('should skip prompt sections when skip_prompt is set', () => {
53
+ expect(new NativeVectorSearchSkill({ skip_prompt: true }).getPromptSections()).toHaveLength(0);
54
+ });
55
+
56
+ it('should return search hints', () => {
57
+ const hints = new NativeVectorSearchSkill().getHints();
58
+ expect(hints).toContain('search');
59
+ expect(hints).toContain('knowledge base');
60
+ });
61
+
62
+ it('should include custom hints from config', () => {
63
+ const skill = new NativeVectorSearchSkill({ hints: ['foo', 'bar'] });
64
+ const hints = skill.getHints();
65
+ expect(hints).toContain('foo');
66
+ expect(hints).toContain('bar');
67
+ });
68
+
69
+ it('should return empty global data before indexing', () => {
70
+ expect(new NativeVectorSearchSkill().getGlobalData()).toEqual({});
71
+ });
72
+
73
+ it('should include search_stats after indexing', async () => {
74
+ const skill = new NativeVectorSearchSkill({
75
+ documents: [{ id: 'd1', text: 'test document' }],
76
+ });
77
+ await skill.setup();
78
+ const data = skill.getGlobalData();
79
+ expect(data['search_stats']).toBeDefined();
80
+ });
81
+
82
+ it('should return correct manifest', () => {
83
+ const klass = NativeVectorSearchSkill as typeof SkillBase;
84
+ expect(klass.SKILL_NAME).toBe('native_vector_search');
85
+ expect(klass.SKILL_VERSION).toBe('1.0.0');
86
+ });
87
+
88
+ it('should have a parameter schema with all expected keys', () => {
89
+ const schema = NativeVectorSearchSkill.getParameterSchema();
90
+ expect(schema['count']).toBeDefined();
91
+ expect(schema['similarity_threshold']).toBeDefined();
92
+ expect(schema['tags']).toBeDefined();
93
+ expect(schema['global_tags']).toBeDefined();
94
+ expect(schema['no_results_message']).toBeDefined();
95
+ expect(schema['response_prefix']).toBeDefined();
96
+ expect(schema['response_postfix']).toBeDefined();
97
+ expect(schema['max_content_length']).toBeDefined();
98
+ expect(schema['description']).toBeDefined();
99
+ expect(schema['hints']).toBeDefined();
100
+ expect(schema['verbose']).toBeDefined();
101
+ expect(schema['remote_url']).toBeDefined();
102
+ expect(schema['backend']).toBeDefined();
103
+ });
104
+
105
+ it('should support multiple instances with distinct keys', () => {
106
+ expect(NativeVectorSearchSkill.SUPPORTS_MULTIPLE_INSTANCES).toBe(true);
107
+ const a = new NativeVectorSearchSkill({ tool_name: 'a', index_file: 'ia' });
108
+ const b = new NativeVectorSearchSkill({ tool_name: 'b', index_file: 'ib' });
109
+ expect(a.getInstanceKey()).not.toBe(b.getInstanceKey());
110
+ });
111
+
112
+ it('should return empty query error when query is missing', async () => {
113
+ const skill = new NativeVectorSearchSkill({
114
+ documents: [{ id: 'd1', text: 'hello world' }],
115
+ });
116
+ await skill.setup();
117
+ const handler = skill.getTools()[0].handler;
118
+ const res = (await handler({}, {})) as FunctionResult;
119
+ expect(res.response).toMatch(/provide a search query/i);
120
+ });
121
+
122
+ it('should return search results for matching query', async () => {
123
+ const skill = new NativeVectorSearchSkill({
124
+ documents: [
125
+ { id: 'doc1', text: 'The quick brown fox jumps over the lazy dog' },
126
+ { id: 'doc2', text: 'Nothing related here' },
127
+ ],
128
+ });
129
+ await skill.setup();
130
+ const handler = skill.getTools()[0].handler;
131
+ const res = (await handler({ query: 'fox' }, {})) as FunctionResult;
132
+ expect(res.response).toContain('Result 1');
133
+ expect(res.response).toContain('doc1');
134
+ });
135
+ });
@@ -0,0 +1,77 @@
1
+ /**
2
+ * Individual tests for the WeatherApi skill.
3
+ */
4
+
5
+ import { describe, it, expect, beforeAll } from 'vitest';
6
+ import { WeatherApiSkill, createWeatherApiSkill } from '../../src/skills/builtin/index.js';
7
+ import { SkillBase } from '../../src/skills/SkillBase.js';
8
+ import { FunctionResult } from '../../src/FunctionResult.js';
9
+ import { suppressAllLogs } from '../../src/Logger.js';
10
+
11
+ beforeAll(() => { suppressAllLogs(true); });
12
+
13
+ describe('WeatherApiSkill', () => {
14
+ it('should instantiate via constructor and factory', () => {
15
+ expect(new WeatherApiSkill()).toBeInstanceOf(SkillBase);
16
+ expect(createWeatherApiSkill()).toBeInstanceOf(WeatherApiSkill);
17
+ });
18
+
19
+ it('should return false from setup when api_key is absent', async () => {
20
+ const saved = process.env['WEATHER_API_KEY'];
21
+ delete process.env['WEATHER_API_KEY'];
22
+ await expect(new WeatherApiSkill().setup()).resolves.toBe(false);
23
+ if (saved !== undefined) process.env['WEATHER_API_KEY'] = saved;
24
+ });
25
+
26
+ it('should return true from setup when api_key is provided via config', async () => {
27
+ await expect(new WeatherApiSkill({ api_key: 'test-key' }).setup()).resolves.toBe(true);
28
+ });
29
+
30
+ it('should return true from setup when WEATHER_API_KEY env var is set', async () => {
31
+ process.env['WEATHER_API_KEY'] = 'env-key';
32
+ await expect(new WeatherApiSkill().setup()).resolves.toBe(true);
33
+ delete process.env['WEATHER_API_KEY'];
34
+ });
35
+
36
+ it('should register a get_weather tool', () => {
37
+ const tools = new WeatherApiSkill().getTools();
38
+ expect(tools).toHaveLength(1);
39
+ expect(tools[0].name).toBe('get_weather');
40
+ expect(tools[0].required).toContain('location');
41
+ });
42
+
43
+ it('should provide prompt sections', () => {
44
+ const sections = new WeatherApiSkill().getPromptSections();
45
+ expect(sections.length).toBeGreaterThan(0);
46
+ expect(sections[0].title).toBe('Weather Information');
47
+ });
48
+
49
+ it('should skip prompt sections when skip_prompt is set', () => {
50
+ expect(new WeatherApiSkill({ skip_prompt: true }).getPromptSections()).toHaveLength(0);
51
+ });
52
+
53
+ it('should return empty hints and global data', () => {
54
+ const skill = new WeatherApiSkill();
55
+ expect(skill.getHints()).toEqual([]);
56
+ expect(skill.getGlobalData()).toEqual({});
57
+ });
58
+
59
+ it('should return correct manifest with required env vars', () => {
60
+ const klass = WeatherApiSkill as typeof SkillBase;
61
+ expect(klass.SKILL_NAME).toBe('weather_api');
62
+ expect(klass.REQUIRED_ENV_VARS).toContain('WEATHER_API_KEY');
63
+ });
64
+
65
+ it('should return error when API key is missing', async () => {
66
+ delete process.env['WEATHER_API_KEY'];
67
+ const handler = new WeatherApiSkill().getTools()[0].handler;
68
+ const result = await handler({ location: 'London' }, {}) as FunctionResult;
69
+ expect(result.response).toContain('not configured');
70
+ });
71
+
72
+ it('should have a parameter schema with units', () => {
73
+ const schema = WeatherApiSkill.getParameterSchema();
74
+ expect(schema['units']).toBeDefined();
75
+ expect(schema['api_key']).toBeDefined();
76
+ });
77
+ });
@@ -0,0 +1,59 @@
1
+ /**
2
+ * Behavioral parity test for the web_search HTML-extraction pipeline.
3
+ *
4
+ * Each fixture under `tests/fixtures/scrape-parity/html/` has a matching
5
+ * expected-output JSON under `expected/`. The expected JSON is the
6
+ * authoritative output from the Python SDK's BeautifulSoup-based
7
+ * `extract_html_content` (`signalwire-python/skills/web_search/skill.py`).
8
+ *
9
+ * We run the TS `extractTextFromHtml` helper against each fixture and
10
+ * assert the text, codepoint length, and sentence count match Python's
11
+ * output byte-for-byte. See `tests/fixtures/scrape-parity/README.md` for
12
+ * regenerating the expected JSON when the Python reference changes.
13
+ */
14
+ import { describe, it, expect } from 'vitest';
15
+ import { readdirSync, readFileSync } from 'node:fs';
16
+ import { join } from 'node:path';
17
+ import { fileURLToPath } from 'node:url';
18
+ import { dirname } from 'node:path';
19
+ import { extractTextFromHtml } from '../../src/skills/builtin/web_search.js';
20
+
21
+ const here = dirname(fileURLToPath(import.meta.url));
22
+ const htmlDir = join(here, '..', 'fixtures', 'scrape-parity', 'html');
23
+ const expectedDir = join(here, '..', 'fixtures', 'scrape-parity', 'expected');
24
+
25
+ interface ExpectedParityOutput {
26
+ text: string;
27
+ text_length: number;
28
+ sentence_count: number;
29
+ }
30
+
31
+ const fixtures = readdirSync(htmlDir)
32
+ .filter((f) => f.endsWith('.html'))
33
+ .sort();
34
+
35
+ describe('WebSearchSkill.extractTextFromHtml — Python BeautifulSoup parity', () => {
36
+ it.each(fixtures)('matches Python reference for %s', (fixtureName) => {
37
+ const base = fixtureName.replace(/\.html$/, '');
38
+ const html = readFileSync(join(htmlDir, fixtureName), 'utf8');
39
+ const expected = JSON.parse(
40
+ readFileSync(join(expectedDir, `${base}.json`), 'utf8'),
41
+ ) as ExpectedParityOutput;
42
+
43
+ const text = extractTextFromHtml(html);
44
+
45
+ // `text_length` is in codepoints (matches Python's `len()`), not
46
+ // UTF-16 code units. Use [...text].length rather than text.length.
47
+ const codepointLength = [...text].length;
48
+
49
+ // `sentence_count` replicates the _qualityMetrics sentence branch:
50
+ // split on [.!?]+, keep segments whose stripped length > 30.
51
+ const sentenceCount = text
52
+ .split(/[.!?]+/)
53
+ .filter((s) => s.trim().length > 30).length;
54
+
55
+ expect(text).toBe(expected.text);
56
+ expect(codepointLength).toBe(expected.text_length);
57
+ expect(sentenceCount).toBe(expected.sentence_count);
58
+ });
59
+ });