@signalwire/sdk 2.0.0 → 2.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (612) hide show
  1. package/dist/AgentBase.d.ts +1045 -0
  2. package/dist/AgentBase.js +2375 -0
  3. package/dist/AgentBase.js.map +1 -0
  4. package/dist/AgentServer.d.ts +146 -0
  5. package/dist/AgentServer.js +388 -0
  6. package/dist/AgentServer.js.map +1 -0
  7. package/dist/AuthHandler.d.ts +127 -0
  8. package/dist/AuthHandler.js +212 -0
  9. package/dist/AuthHandler.js.map +1 -0
  10. package/dist/ConfigLoader.d.ts +170 -0
  11. package/dist/ConfigLoader.js +393 -0
  12. package/dist/ConfigLoader.js.map +1 -0
  13. package/dist/ContextBuilder.d.ts +652 -0
  14. package/dist/ContextBuilder.js +1115 -0
  15. package/dist/ContextBuilder.js.map +1 -0
  16. package/dist/DataMap.d.ts +271 -0
  17. package/dist/DataMap.js +430 -0
  18. package/dist/DataMap.js.map +1 -0
  19. package/dist/FunctionResult.d.ts +481 -0
  20. package/dist/FunctionResult.js +775 -0
  21. package/dist/FunctionResult.js.map +1 -0
  22. package/dist/Logger.d.ts +113 -0
  23. package/dist/Logger.js +320 -0
  24. package/dist/Logger.js.map +1 -0
  25. package/dist/PomBuilder.d.ts +208 -0
  26. package/dist/PomBuilder.js +409 -0
  27. package/dist/PomBuilder.js.map +1 -0
  28. package/dist/PromptManager.d.ts +85 -0
  29. package/dist/PromptManager.js +108 -0
  30. package/dist/PromptManager.js.map +1 -0
  31. package/dist/SWMLHandler.d.ts +159 -0
  32. package/dist/SWMLHandler.js +229 -0
  33. package/dist/SWMLHandler.js.map +1 -0
  34. package/dist/SWMLService.d.ts +326 -0
  35. package/dist/SWMLService.js +610 -0
  36. package/dist/SWMLService.js.map +1 -0
  37. package/dist/SchemaUtils.d.ts +108 -0
  38. package/dist/SchemaUtils.js +317 -0
  39. package/dist/SchemaUtils.js.map +1 -0
  40. package/dist/SecurityUtils.d.ts +60 -0
  41. package/{src/SecurityUtils.ts → dist/SecurityUtils.js} +82 -83
  42. package/dist/SecurityUtils.js.map +1 -0
  43. package/dist/ServerlessAdapter.d.ts +119 -0
  44. package/dist/ServerlessAdapter.js +188 -0
  45. package/dist/ServerlessAdapter.js.map +1 -0
  46. package/dist/SessionManager.d.ts +142 -0
  47. package/dist/SessionManager.js +260 -0
  48. package/dist/SessionManager.js.map +1 -0
  49. package/dist/SslConfig.d.ts +77 -0
  50. package/dist/SslConfig.js +100 -0
  51. package/dist/SslConfig.js.map +1 -0
  52. package/dist/SwaigFunction.d.ts +159 -0
  53. package/dist/SwaigFunction.js +209 -0
  54. package/dist/SwaigFunction.js.map +1 -0
  55. package/dist/SwmlBuilder.d.ts +165 -0
  56. package/dist/SwmlBuilder.js +247 -0
  57. package/dist/SwmlBuilder.js.map +1 -0
  58. package/dist/SwmlVerbMethods.generated.d.ts +254 -0
  59. package/dist/SwmlVerbMethods.generated.js +9 -0
  60. package/dist/SwmlVerbMethods.generated.js.map +1 -0
  61. package/dist/TypeInference.d.ts +71 -0
  62. package/dist/TypeInference.js +164 -0
  63. package/dist/TypeInference.js.map +1 -0
  64. package/dist/WebService.d.ts +148 -0
  65. package/dist/WebService.js +532 -0
  66. package/dist/WebService.js.map +1 -0
  67. package/dist/cli/agent-loader.d.ts +22 -0
  68. package/dist/cli/agent-loader.js +144 -0
  69. package/dist/cli/agent-loader.js.map +1 -0
  70. package/dist/cli/mock-data.d.ts +37 -0
  71. package/dist/cli/mock-data.js +80 -0
  72. package/dist/cli/mock-data.js.map +1 -0
  73. package/dist/cli/swaig-test.d.ts +32 -0
  74. package/dist/cli/swaig-test.js +418 -0
  75. package/dist/cli/swaig-test.js.map +1 -0
  76. package/dist/generateVerbTypes.d.ts +11 -0
  77. package/dist/generateVerbTypes.js +265 -0
  78. package/dist/generateVerbTypes.js.map +1 -0
  79. package/dist/index.d.ts +146 -0
  80. package/dist/index.js +152 -0
  81. package/dist/index.js.map +1 -0
  82. package/dist/livewire/index.d.ts +653 -0
  83. package/dist/livewire/index.js +992 -0
  84. package/dist/livewire/index.js.map +1 -0
  85. package/dist/prefabs/ConciergeAgent.d.ts +89 -0
  86. package/dist/prefabs/ConciergeAgent.js +245 -0
  87. package/dist/prefabs/ConciergeAgent.js.map +1 -0
  88. package/dist/prefabs/FAQBotAgent.d.ts +113 -0
  89. package/dist/prefabs/FAQBotAgent.js +329 -0
  90. package/dist/prefabs/FAQBotAgent.js.map +1 -0
  91. package/dist/prefabs/InfoGathererAgent.d.ts +126 -0
  92. package/dist/prefabs/InfoGathererAgent.js +287 -0
  93. package/dist/prefabs/InfoGathererAgent.js.map +1 -0
  94. package/dist/prefabs/ReceptionistAgent.d.ts +104 -0
  95. package/dist/prefabs/ReceptionistAgent.js +303 -0
  96. package/dist/prefabs/ReceptionistAgent.js.map +1 -0
  97. package/dist/prefabs/SurveyAgent.d.ts +148 -0
  98. package/dist/prefabs/SurveyAgent.js +540 -0
  99. package/dist/prefabs/SurveyAgent.js.map +1 -0
  100. package/{src/prefabs/index.ts → dist/prefabs/index.d.ts} +1 -15
  101. package/dist/prefabs/index.js +14 -0
  102. package/dist/prefabs/index.js.map +1 -0
  103. package/dist/relay/Action.d.ts +258 -0
  104. package/dist/relay/Action.js +402 -0
  105. package/dist/relay/Action.js.map +1 -0
  106. package/dist/relay/Call.d.ts +697 -0
  107. package/dist/relay/Call.js +1062 -0
  108. package/dist/relay/Call.js.map +1 -0
  109. package/dist/relay/Deferred.d.ts +44 -0
  110. package/dist/relay/Deferred.js +69 -0
  111. package/dist/relay/Deferred.js.map +1 -0
  112. package/dist/relay/Message.d.ts +103 -0
  113. package/dist/relay/Message.js +169 -0
  114. package/dist/relay/Message.js.map +1 -0
  115. package/dist/relay/RelayClient.d.ts +302 -0
  116. package/dist/relay/RelayClient.js +1019 -0
  117. package/dist/relay/RelayClient.js.map +1 -0
  118. package/dist/relay/RelayError.d.ts +15 -0
  119. package/dist/relay/RelayError.js +20 -0
  120. package/dist/relay/RelayError.js.map +1 -0
  121. package/dist/relay/RelayEvent.d.ts +254 -0
  122. package/dist/relay/RelayEvent.js +509 -0
  123. package/dist/relay/RelayEvent.js.map +1 -0
  124. package/dist/relay/constants.d.ts +90 -0
  125. package/{src/relay/constants.ts → dist/relay/constants.js} +11 -29
  126. package/dist/relay/constants.js.map +1 -0
  127. package/dist/relay/index.d.ts +16 -0
  128. package/dist/relay/index.js +18 -0
  129. package/dist/relay/index.js.map +1 -0
  130. package/dist/relay/types.d.ts +142 -0
  131. package/dist/relay/types.js +5 -0
  132. package/dist/relay/types.js.map +1 -0
  133. package/dist/rest/HttpClient.d.ts +80 -0
  134. package/dist/rest/HttpClient.js +148 -0
  135. package/dist/rest/HttpClient.js.map +1 -0
  136. package/dist/rest/RestError.d.ts +30 -0
  137. package/dist/rest/RestError.js +39 -0
  138. package/dist/rest/RestError.js.map +1 -0
  139. package/dist/rest/base/BaseResource.d.ts +24 -0
  140. package/dist/rest/base/BaseResource.js +29 -0
  141. package/dist/rest/base/BaseResource.js.map +1 -0
  142. package/dist/rest/base/CrudResource.d.ts +68 -0
  143. package/dist/rest/base/CrudResource.js +82 -0
  144. package/dist/rest/base/CrudResource.js.map +1 -0
  145. package/dist/rest/base/CrudWithAddresses.d.ts +22 -0
  146. package/dist/rest/base/CrudWithAddresses.js +25 -0
  147. package/dist/rest/base/CrudWithAddresses.js.map +1 -0
  148. package/{src/rest/index.ts → dist/rest/index.d.ts} +53 -122
  149. package/dist/rest/index.js +195 -0
  150. package/dist/rest/index.js.map +1 -0
  151. package/dist/rest/namespaces/addresses.d.ts +46 -0
  152. package/dist/rest/namespaces/addresses.js +55 -0
  153. package/dist/rest/namespaces/addresses.js.map +1 -0
  154. package/dist/rest/namespaces/calling.d.ts +382 -0
  155. package/dist/rest/namespaces/calling.js +478 -0
  156. package/dist/rest/namespaces/calling.js.map +1 -0
  157. package/dist/rest/namespaces/chat.d.ts +22 -0
  158. package/dist/rest/namespaces/chat.js +26 -0
  159. package/dist/rest/namespaces/chat.js.map +1 -0
  160. package/dist/rest/namespaces/compat.d.ts +585 -0
  161. package/dist/rest/namespaces/compat.js +735 -0
  162. package/dist/rest/namespaces/compat.js.map +1 -0
  163. package/dist/rest/namespaces/datasphere.d.ts +66 -0
  164. package/dist/rest/namespaces/datasphere.js +77 -0
  165. package/dist/rest/namespaces/datasphere.js.map +1 -0
  166. package/dist/rest/namespaces/fabric.d.ts +282 -0
  167. package/dist/rest/namespaces/fabric.js +373 -0
  168. package/dist/rest/namespaces/fabric.js.map +1 -0
  169. package/dist/rest/namespaces/imported-numbers.d.ts +22 -0
  170. package/dist/rest/namespaces/imported-numbers.js +26 -0
  171. package/dist/rest/namespaces/imported-numbers.js.map +1 -0
  172. package/dist/rest/namespaces/logs.d.ts +105 -0
  173. package/dist/rest/namespaces/logs.js +133 -0
  174. package/dist/rest/namespaces/logs.js.map +1 -0
  175. package/dist/rest/namespaces/lookup.d.ts +29 -0
  176. package/dist/rest/namespaces/lookup.js +32 -0
  177. package/dist/rest/namespaces/lookup.js.map +1 -0
  178. package/dist/rest/namespaces/mfa.d.ts +46 -0
  179. package/dist/rest/namespaces/mfa.js +54 -0
  180. package/dist/rest/namespaces/mfa.js.map +1 -0
  181. package/dist/rest/namespaces/number-groups.d.ts +49 -0
  182. package/dist/rest/namespaces/number-groups.js +58 -0
  183. package/dist/rest/namespaces/number-groups.js.map +1 -0
  184. package/dist/rest/namespaces/phone-numbers.d.ts +60 -0
  185. package/dist/rest/namespaces/phone-numbers.js +67 -0
  186. package/dist/rest/namespaces/phone-numbers.js.map +1 -0
  187. package/dist/rest/namespaces/project.d.ts +46 -0
  188. package/dist/rest/namespaces/project.js +56 -0
  189. package/dist/rest/namespaces/project.js.map +1 -0
  190. package/dist/rest/namespaces/pubsub.d.ts +22 -0
  191. package/dist/rest/namespaces/pubsub.js +26 -0
  192. package/dist/rest/namespaces/pubsub.js.map +1 -0
  193. package/dist/rest/namespaces/queues.d.ts +42 -0
  194. package/dist/rest/namespaces/queues.js +49 -0
  195. package/dist/rest/namespaces/queues.js.map +1 -0
  196. package/dist/rest/namespaces/recordings.d.ts +38 -0
  197. package/dist/rest/namespaces/recordings.js +45 -0
  198. package/dist/rest/namespaces/recordings.js.map +1 -0
  199. package/dist/rest/namespaces/registry.d.ts +141 -0
  200. package/dist/rest/namespaces/registry.js +178 -0
  201. package/dist/rest/namespaces/registry.js.map +1 -0
  202. package/dist/rest/namespaces/short-codes.d.ts +39 -0
  203. package/dist/rest/namespaces/short-codes.js +46 -0
  204. package/dist/rest/namespaces/short-codes.js.map +1 -0
  205. package/dist/rest/namespaces/sip-profile.d.ts +28 -0
  206. package/dist/rest/namespaces/sip-profile.js +34 -0
  207. package/dist/rest/namespaces/sip-profile.js.map +1 -0
  208. package/dist/rest/namespaces/verified-callers.d.ts +33 -0
  209. package/dist/rest/namespaces/verified-callers.js +39 -0
  210. package/dist/rest/namespaces/verified-callers.js.map +1 -0
  211. package/dist/rest/namespaces/video.d.ts +235 -0
  212. package/dist/rest/namespaces/video.js +297 -0
  213. package/dist/rest/namespaces/video.js.map +1 -0
  214. package/dist/rest/pagination.d.ts +39 -0
  215. package/dist/rest/pagination.js +78 -0
  216. package/dist/rest/pagination.js.map +1 -0
  217. package/dist/rest/types.d.ts +54 -0
  218. package/dist/rest/types.js +5 -0
  219. package/dist/rest/types.js.map +1 -0
  220. package/dist/skills/SkillBase.d.ts +404 -0
  221. package/dist/skills/SkillBase.js +471 -0
  222. package/dist/skills/SkillBase.js.map +1 -0
  223. package/dist/skills/SkillManager.d.ts +195 -0
  224. package/dist/skills/SkillManager.js +378 -0
  225. package/dist/skills/SkillManager.js.map +1 -0
  226. package/dist/skills/SkillRegistry.d.ts +176 -0
  227. package/dist/skills/SkillRegistry.js +310 -0
  228. package/dist/skills/SkillRegistry.js.map +1 -0
  229. package/dist/skills/builtin/api_ninjas_trivia.d.ts +47 -0
  230. package/dist/skills/builtin/api_ninjas_trivia.js +211 -0
  231. package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -0
  232. package/dist/skills/builtin/ask_claude.d.ts +37 -0
  233. package/dist/skills/builtin/ask_claude.js +162 -0
  234. package/dist/skills/builtin/ask_claude.js.map +1 -0
  235. package/dist/skills/builtin/claude_skills.d.ts +75 -0
  236. package/dist/skills/builtin/claude_skills.js +753 -0
  237. package/dist/skills/builtin/claude_skills.js.map +1 -0
  238. package/dist/skills/builtin/custom_skills.d.ts +79 -0
  239. package/dist/skills/builtin/custom_skills.js +227 -0
  240. package/dist/skills/builtin/custom_skills.js.map +1 -0
  241. package/dist/skills/builtin/datasphere.d.ts +73 -0
  242. package/dist/skills/builtin/datasphere.js +350 -0
  243. package/dist/skills/builtin/datasphere.js.map +1 -0
  244. package/dist/skills/builtin/datasphere_serverless.d.ts +89 -0
  245. package/dist/skills/builtin/datasphere_serverless.js +291 -0
  246. package/dist/skills/builtin/datasphere_serverless.js.map +1 -0
  247. package/dist/skills/builtin/datetime.d.ts +40 -0
  248. package/dist/skills/builtin/datetime.js +118 -0
  249. package/dist/skills/builtin/datetime.js.map +1 -0
  250. package/dist/skills/builtin/google_maps.d.ts +48 -0
  251. package/dist/skills/builtin/google_maps.js +470 -0
  252. package/dist/skills/builtin/google_maps.js.map +1 -0
  253. package/dist/skills/builtin/index.d.ts +31 -0
  254. package/{src/skills/builtin/index.ts → dist/skills/builtin/index.js} +30 -36
  255. package/dist/skills/builtin/index.js.map +1 -0
  256. package/dist/skills/builtin/info_gatherer.d.ts +115 -0
  257. package/dist/skills/builtin/info_gatherer.js +328 -0
  258. package/dist/skills/builtin/info_gatherer.js.map +1 -0
  259. package/dist/skills/builtin/joke.d.ts +41 -0
  260. package/dist/skills/builtin/joke.js +156 -0
  261. package/dist/skills/builtin/joke.js.map +1 -0
  262. package/dist/skills/builtin/math.d.ts +39 -0
  263. package/dist/skills/builtin/math.js +119 -0
  264. package/dist/skills/builtin/math.js.map +1 -0
  265. package/dist/skills/builtin/mcp_gateway.d.ts +82 -0
  266. package/dist/skills/builtin/mcp_gateway.js +574 -0
  267. package/dist/skills/builtin/mcp_gateway.js.map +1 -0
  268. package/dist/skills/builtin/native_vector_search.d.ts +128 -0
  269. package/dist/skills/builtin/native_vector_search.js +752 -0
  270. package/dist/skills/builtin/native_vector_search.js.map +1 -0
  271. package/dist/skills/builtin/play_background_file.d.ts +59 -0
  272. package/dist/skills/builtin/play_background_file.js +274 -0
  273. package/dist/skills/builtin/play_background_file.js.map +1 -0
  274. package/dist/skills/builtin/spider.d.ts +91 -0
  275. package/dist/skills/builtin/spider.js +758 -0
  276. package/dist/skills/builtin/spider.js.map +1 -0
  277. package/dist/skills/builtin/swml_transfer.d.ts +66 -0
  278. package/dist/skills/builtin/swml_transfer.js +475 -0
  279. package/dist/skills/builtin/swml_transfer.js.map +1 -0
  280. package/dist/skills/builtin/weather_api.d.ts +59 -0
  281. package/dist/skills/builtin/weather_api.js +196 -0
  282. package/dist/skills/builtin/weather_api.js.map +1 -0
  283. package/dist/skills/builtin/web_search.d.ts +160 -0
  284. package/dist/skills/builtin/web_search.js +894 -0
  285. package/dist/skills/builtin/web_search.js.map +1 -0
  286. package/dist/skills/builtin/wikipedia_search.d.ts +77 -0
  287. package/dist/skills/builtin/wikipedia_search.js +241 -0
  288. package/dist/skills/builtin/wikipedia_search.js.map +1 -0
  289. package/{src/skills/index.ts → dist/skills/index.d.ts} +0 -1
  290. package/dist/skills/index.js +10 -0
  291. package/dist/skills/index.js.map +1 -0
  292. package/dist/types.d.ts +118 -0
  293. package/dist/types.js +5 -0
  294. package/dist/types.js.map +1 -0
  295. package/package.json +7 -1
  296. package/.github/workflows/publish.yml +0 -27
  297. package/.github/workflows/test.yml +0 -17
  298. package/CLAUDE.md +0 -112
  299. package/docs/MIGRATION-2.0.md +0 -81
  300. package/docs/agent-guide.md +0 -869
  301. package/docs/agent_guide.md +0 -1026
  302. package/docs/api-reference.md +0 -2420
  303. package/docs/api_reference.md +0 -1301
  304. package/docs/architecture.md +0 -843
  305. package/docs/cli-guide.md +0 -579
  306. package/docs/cli_guide.md +0 -448
  307. package/docs/cloud_functions_guide.md +0 -474
  308. package/docs/configuration.md +0 -422
  309. package/docs/contexts-guide.md +0 -787
  310. package/docs/contexts_guide.md +0 -511
  311. package/docs/datamap-guide.md +0 -1141
  312. package/docs/datamap_guide.md +0 -595
  313. package/docs/llm_parameters.md +0 -239
  314. package/docs/mcp_gateway_reference.md +0 -648
  315. package/docs/mcp_integration.md +0 -108
  316. package/docs/prefabs-guide.md +0 -800
  317. package/docs/sdk_features.md +0 -477
  318. package/docs/security.md +0 -436
  319. package/docs/serverless-guide.md +0 -513
  320. package/docs/skills-guide.md +0 -857
  321. package/docs/skills-system.md +0 -301
  322. package/docs/skills_parameter_schema.md +0 -392
  323. package/docs/skills_system.md +0 -467
  324. package/docs/swaig-reference.md +0 -1627
  325. package/docs/swaig_reference.md +0 -910
  326. package/docs/swml_service_guide.md +0 -600
  327. package/docs/third_party_skills.md +0 -533
  328. package/docs/web_service.md +0 -677
  329. package/examples/README.md +0 -131
  330. package/examples/advanced-datamap.ts +0 -100
  331. package/examples/advanced-dynamic-config.ts +0 -70
  332. package/examples/auto-vivified.ts +0 -94
  333. package/examples/call-flow.ts +0 -63
  334. package/examples/comprehensive-dynamic.ts +0 -125
  335. package/examples/contexts-steps.ts +0 -65
  336. package/examples/custom-path.ts +0 -45
  337. package/examples/datamap-tools.ts +0 -55
  338. package/examples/datasphere-multi-instance.ts +0 -63
  339. package/examples/datasphere-serverless-env.ts +0 -68
  340. package/examples/datasphere-webhook-env.ts +0 -66
  341. package/examples/datasphere.ts +0 -37
  342. package/examples/declarative.ts +0 -100
  343. package/examples/dynamic-config.ts +0 -54
  344. package/examples/dynamic-info-gatherer.ts +0 -69
  345. package/examples/dynamic-swml-service.ts +0 -67
  346. package/examples/gather-info.ts +0 -71
  347. package/examples/gather-per-question-functions-demo.ts +0 -140
  348. package/examples/joke-agent.ts +0 -34
  349. package/examples/kubernetes-agent.ts +0 -45
  350. package/examples/llm-params.ts +0 -69
  351. package/examples/mcp-agent.ts +0 -84
  352. package/examples/mcp-gateway.ts +0 -35
  353. package/examples/multi-agent.ts +0 -73
  354. package/examples/multi-endpoint.ts +0 -79
  355. package/examples/pom-prompt.ts +0 -71
  356. package/examples/prefab-concierge.ts +0 -47
  357. package/examples/prefab-faq.ts +0 -54
  358. package/examples/prefab-info-gatherer.ts +0 -33
  359. package/examples/prefab-receptionist.ts +0 -36
  360. package/examples/prefab-survey.ts +0 -68
  361. package/examples/record-call.ts +0 -67
  362. package/examples/relay-demo.ts +0 -33
  363. package/examples/room-and-sip.ts +0 -94
  364. package/examples/serverless-lambda.ts +0 -35
  365. package/examples/session-state.ts +0 -83
  366. package/examples/simple-agent.ts +0 -36
  367. package/examples/simple-static.ts +0 -29
  368. package/examples/skills-demo.ts +0 -38
  369. package/examples/step-function-inheritance-demo.ts +0 -124
  370. package/examples/swaig-features.ts +0 -187
  371. package/examples/swml-service-routing.ts +0 -66
  372. package/examples/swml-service.ts +0 -38
  373. package/examples/tap.ts +0 -68
  374. package/examples/verb-methods.ts +0 -45
  375. package/examples/web-search-multi-instance.ts +0 -72
  376. package/examples/web-search.ts +0 -38
  377. package/examples/wikipedia.ts +0 -36
  378. package/livewire/README.md +0 -140
  379. package/livewire/docs/migration-guide.md +0 -228
  380. package/livewire/examples/livewire-basic-agent.ts +0 -74
  381. package/livewire/examples/livewire-handoff.ts +0 -197
  382. package/livewire/examples/livewire-multi-tool.ts +0 -117
  383. package/relay/README.md +0 -70
  384. package/relay/RELAY_IMPLEMENTATION_GUIDE.md +0 -1257
  385. package/relay/docs/call-methods.md +0 -474
  386. package/relay/docs/client-reference.md +0 -142
  387. package/relay/docs/events.md +0 -134
  388. package/relay/docs/getting-started.md +0 -134
  389. package/relay/docs/guide.md +0 -306
  390. package/relay/docs/messaging.md +0 -182
  391. package/relay/examples/relay-inbound.ts +0 -66
  392. package/relay/examples/relay-messaging.ts +0 -71
  393. package/relay/examples/relay-outbound.ts +0 -76
  394. package/rest/README.md +0 -95
  395. package/rest/docs/calling.md +0 -273
  396. package/rest/docs/client-reference.md +0 -107
  397. package/rest/docs/compat.md +0 -204
  398. package/rest/docs/fabric.md +0 -183
  399. package/rest/docs/getting-started.md +0 -110
  400. package/rest/docs/guide.md +0 -351
  401. package/rest/docs/namespaces.md +0 -285
  402. package/rest/examples/rest-10dlc-registration.ts +0 -161
  403. package/rest/examples/rest-calling-ivr-and-ai.ts +0 -102
  404. package/rest/examples/rest-calling-play-and-record.ts +0 -91
  405. package/rest/examples/rest-client.ts +0 -65
  406. package/rest/examples/rest-compat-laml.ts +0 -210
  407. package/rest/examples/rest-datasphere-search.ts +0 -82
  408. package/rest/examples/rest-fabric-conferences-and-routing.ts +0 -144
  409. package/rest/examples/rest-fabric-subscribers-and-sip.ts +0 -108
  410. package/rest/examples/rest-fabric-swml-and-callflows.ts +0 -99
  411. package/rest/examples/rest-manage-resources.ts +0 -65
  412. package/rest/examples/rest-phone-number-management.ts +0 -197
  413. package/rest/examples/rest-queues-mfa-and-recordings.ts +0 -143
  414. package/rest/examples/rest-video-rooms.ts +0 -186
  415. package/src/AgentBase.ts +0 -2489
  416. package/src/AgentServer.ts +0 -415
  417. package/src/AuthHandler.ts +0 -256
  418. package/src/ConfigLoader.ts +0 -447
  419. package/src/ContextBuilder.ts +0 -1150
  420. package/src/DataMap.ts +0 -449
  421. package/src/FunctionResult.ts +0 -866
  422. package/src/Logger.ts +0 -337
  423. package/src/PomBuilder.ts +0 -439
  424. package/src/PromptManager.ts +0 -133
  425. package/src/SWMLHandler.ts +0 -298
  426. package/src/SWMLService.ts +0 -717
  427. package/src/SchemaUtils.ts +0 -361
  428. package/src/ServerlessAdapter.ts +0 -221
  429. package/src/SessionManager.ts +0 -311
  430. package/src/SslConfig.ts +0 -118
  431. package/src/SwaigFunction.ts +0 -276
  432. package/src/SwmlBuilder.ts +0 -258
  433. package/src/SwmlVerbMethods.generated.ts +0 -234
  434. package/src/TypeInference.ts +0 -181
  435. package/src/WebService.ts +0 -619
  436. package/src/cli/agent-loader.ts +0 -166
  437. package/src/cli/mock-data.ts +0 -111
  438. package/src/cli/swaig-test.ts +0 -452
  439. package/src/generateVerbTypes.ts +0 -322
  440. package/src/index.ts +0 -167
  441. package/src/livewire/index.ts +0 -950
  442. package/src/prefabs/ConciergeAgent.ts +0 -287
  443. package/src/prefabs/FAQBotAgent.ts +0 -384
  444. package/src/prefabs/InfoGathererAgent.ts +0 -339
  445. package/src/prefabs/ReceptionistAgent.ts +0 -366
  446. package/src/prefabs/SurveyAgent.ts +0 -646
  447. package/src/relay/Action.ts +0 -314
  448. package/src/relay/Call.ts +0 -854
  449. package/src/relay/Deferred.ts +0 -71
  450. package/src/relay/Message.ts +0 -148
  451. package/src/relay/RelayClient.ts +0 -1036
  452. package/src/relay/RelayError.ts +0 -14
  453. package/src/relay/RelayEvent.ts +0 -892
  454. package/src/relay/index.ts +0 -123
  455. package/src/relay/types.ts +0 -149
  456. package/src/rest/HttpClient.ts +0 -103
  457. package/src/rest/RestError.ts +0 -31
  458. package/src/rest/base/BaseResource.ts +0 -19
  459. package/src/rest/base/CrudResource.ts +0 -51
  460. package/src/rest/base/CrudWithAddresses.ts +0 -26
  461. package/src/rest/namespaces/addresses.ts +0 -32
  462. package/src/rest/namespaces/calling.ts +0 -187
  463. package/src/rest/namespaces/chat.ts +0 -20
  464. package/src/rest/namespaces/compat.ts +0 -352
  465. package/src/rest/namespaces/datasphere.ts +0 -45
  466. package/src/rest/namespaces/fabric.ts +0 -222
  467. package/src/rest/namespaces/imported-numbers.ts +0 -20
  468. package/src/rest/namespaces/logs.ts +0 -84
  469. package/src/rest/namespaces/lookup.ts +0 -21
  470. package/src/rest/namespaces/mfa.ts +0 -30
  471. package/src/rest/namespaces/number-groups.ts +0 -38
  472. package/src/rest/namespaces/phone-numbers.ts +0 -44
  473. package/src/rest/namespaces/project.ts +0 -36
  474. package/src/rest/namespaces/pubsub.ts +0 -20
  475. package/src/rest/namespaces/queues.ts +0 -33
  476. package/src/rest/namespaces/recordings.ts +0 -28
  477. package/src/rest/namespaces/registry.ts +0 -101
  478. package/src/rest/namespaces/short-codes.ts +0 -28
  479. package/src/rest/namespaces/sip-profile.ts +0 -25
  480. package/src/rest/namespaces/verified-callers.ts +0 -27
  481. package/src/rest/namespaces/video.ts +0 -165
  482. package/src/rest/pagination.ts +0 -84
  483. package/src/rest/types.ts +0 -61
  484. package/src/skills/SkillBase.ts +0 -547
  485. package/src/skills/SkillManager.ts +0 -415
  486. package/src/skills/SkillRegistry.ts +0 -367
  487. package/src/skills/builtin/api_ninjas_trivia.ts +0 -280
  488. package/src/skills/builtin/ask_claude.ts +0 -241
  489. package/src/skills/builtin/claude_skills.ts +0 -978
  490. package/src/skills/builtin/custom_skills.ts +0 -312
  491. package/src/skills/builtin/datasphere.ts +0 -438
  492. package/src/skills/builtin/datasphere_serverless.ts +0 -339
  493. package/src/skills/builtin/datetime.ts +0 -130
  494. package/src/skills/builtin/google_maps.ts +0 -651
  495. package/src/skills/builtin/info_gatherer.ts +0 -405
  496. package/src/skills/builtin/joke.ts +0 -191
  497. package/src/skills/builtin/math.ts +0 -142
  498. package/src/skills/builtin/mcp_gateway.ts +0 -677
  499. package/src/skills/builtin/native_vector_search.ts +0 -901
  500. package/src/skills/builtin/play_background_file.ts +0 -358
  501. package/src/skills/builtin/spider.ts +0 -869
  502. package/src/skills/builtin/swml_transfer.ts +0 -635
  503. package/src/skills/builtin/weather_api.ts +0 -248
  504. package/src/skills/builtin/web_search.ts +0 -1074
  505. package/src/skills/builtin/wikipedia_search.ts +0 -299
  506. package/src/types.ts +0 -132
  507. package/tests/AgentBase.test.ts +0 -1093
  508. package/tests/AgentServer.test.ts +0 -126
  509. package/tests/AuthHandler.test.ts +0 -133
  510. package/tests/ConfigLoader.test.ts +0 -151
  511. package/tests/ContextBuilder.test.ts +0 -108
  512. package/tests/DataMap.test.ts +0 -367
  513. package/tests/EphemeralSkillCopy.test.ts +0 -107
  514. package/tests/FunctionResult.test.ts +0 -298
  515. package/tests/GracefulShutdown.test.ts +0 -46
  516. package/tests/Logger.test.ts +0 -420
  517. package/tests/PomBuilder.test.ts +0 -228
  518. package/tests/ProxyDetection.test.ts +0 -228
  519. package/tests/SWMLService.test.ts +0 -320
  520. package/tests/SWMLVerbHandler.test.ts +0 -523
  521. package/tests/SchemaUtils.test.ts +0 -106
  522. package/tests/SchemaUtils.verb.test.ts +0 -206
  523. package/tests/SecurityUtils.test.ts +0 -192
  524. package/tests/ServerlessAdapter.test.ts +0 -222
  525. package/tests/SessionManager.test.ts +0 -257
  526. package/tests/SkillBaseFeatures.test.ts +0 -130
  527. package/tests/SkillMultiInstance.test.ts +0 -102
  528. package/tests/SkillParameterSchemas.test.ts +0 -134
  529. package/tests/SkillRegistrySchema.test.ts +0 -84
  530. package/tests/SslConfig.test.ts +0 -97
  531. package/tests/SwmlBuilder.test.ts +0 -400
  532. package/tests/TypeInference.test.ts +0 -165
  533. package/tests/VerbHandlerRegistry.test.ts +0 -128
  534. package/tests/cli/mock-data.test.ts +0 -113
  535. package/tests/cli/swaig-test.test.ts +0 -108
  536. package/tests/examples.test.ts +0 -194
  537. package/tests/fixtures/scrape-parity/README.md +0 -53
  538. package/tests/fixtures/scrape-parity/expected/01_simple_article.json +0 -5
  539. package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +0 -5
  540. package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +0 -5
  541. package/tests/fixtures/scrape-parity/expected/04_bare_body.json +0 -5
  542. package/tests/fixtures/scrape-parity/expected/05_malformed.json +0 -5
  543. package/tests/fixtures/scrape-parity/expected/06_multi_class.json +0 -5
  544. package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +0 -5
  545. package/tests/fixtures/scrape-parity/expected/08_inline_script.json +0 -5
  546. package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +0 -5
  547. package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +0 -5
  548. package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +0 -5
  549. package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +0 -5
  550. package/tests/fixtures/scrape-parity/html/01_simple_article.html +0 -18
  551. package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +0 -18
  552. package/tests/fixtures/scrape-parity/html/03_nested_containers.html +0 -13
  553. package/tests/fixtures/scrape-parity/html/04_bare_body.html +0 -9
  554. package/tests/fixtures/scrape-parity/html/05_malformed.html +0 -11
  555. package/tests/fixtures/scrape-parity/html/06_multi_class.html +0 -18
  556. package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +0 -12
  557. package/tests/fixtures/scrape-parity/html/08_inline_script.html +0 -17
  558. package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +0 -21
  559. package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +0 -10
  560. package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +0 -13
  561. package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +0 -24
  562. package/tests/fixtures/scrape-parity/python_extract.py +0 -109
  563. package/tests/livewire/livewire.test.ts +0 -780
  564. package/tests/mcp.test.ts +0 -221
  565. package/tests/prefabs/prefabs.test.ts +0 -1093
  566. package/tests/relay/Action.test.ts +0 -392
  567. package/tests/relay/Call.test.ts +0 -535
  568. package/tests/relay/Deferred.test.ts +0 -71
  569. package/tests/relay/Message.test.ts +0 -164
  570. package/tests/relay/RelayClient.test.ts +0 -779
  571. package/tests/relay/RelayEvent.test.ts +0 -463
  572. package/tests/relay/helpers.ts +0 -79
  573. package/tests/rest/HttpClient.test.ts +0 -274
  574. package/tests/rest/RestError.test.ts +0 -53
  575. package/tests/rest/calling.test.ts +0 -156
  576. package/tests/rest/client.test.ts +0 -197
  577. package/tests/rest/compat.test.ts +0 -335
  578. package/tests/rest/datasphere.test.ts +0 -71
  579. package/tests/rest/fabric.test.ts +0 -186
  580. package/tests/rest/helpers.ts +0 -95
  581. package/tests/rest/logs.test.ts +0 -68
  582. package/tests/rest/pagination.test.ts +0 -133
  583. package/tests/rest/registry.test.ts +0 -94
  584. package/tests/rest/relay-rest.test.ts +0 -290
  585. package/tests/rest/video.test.ts +0 -173
  586. package/tests/setup.ts +0 -6
  587. package/tests/skills/SkillBase.test.ts +0 -108
  588. package/tests/skills/SkillManager.test.ts +0 -268
  589. package/tests/skills/SkillRegistry.test.ts +0 -176
  590. package/tests/skills/builtin.test.ts +0 -1472
  591. package/tests/skills/claude-skills.test.ts +0 -54
  592. package/tests/skills/custom-skills.test.ts +0 -53
  593. package/tests/skills/datasphere-serverless.test.ts +0 -70
  594. package/tests/skills/datasphere.test.ts +0 -107
  595. package/tests/skills/datetime.test.ts +0 -101
  596. package/tests/skills/google-maps.test.ts +0 -78
  597. package/tests/skills/info-gatherer.test.ts +0 -411
  598. package/tests/skills/joke.test.ts +0 -81
  599. package/tests/skills/math.test.ts +0 -68
  600. package/tests/skills/mcp-gateway.test.ts +0 -101
  601. package/tests/skills/play-background.test.ts +0 -54
  602. package/tests/skills/spider.test.ts +0 -108
  603. package/tests/skills/swml-transfer.test.ts +0 -178
  604. package/tests/skills/trivia.test.ts +0 -54
  605. package/tests/skills/vector-search.test.ts +0 -135
  606. package/tests/skills/weather-api.test.ts +0 -77
  607. package/tests/skills/web-search-parity.test.ts +0 -59
  608. package/tests/skills/web-search.test.ts +0 -103
  609. package/tests/skills/wikipedia.test.ts +0 -63
  610. package/tsconfig.json +0 -18
  611. package/vitest.config.ts +0 -9
  612. /package/{src → dist}/schema.json +0 -0
@@ -1,194 +0,0 @@
1
- /**
2
- * Smoke tests for all example files.
3
- *
4
- * Dynamically imports each example and verifies it produces valid SWML
5
- * and has expected tools registered.
6
- */
7
-
8
- import { loadAgent } from '../src/cli/agent-loader.js';
9
-
10
- // Helper: load an example and return the agent
11
- async function loadExample(name: string): Promise<any> {
12
- return loadAgent(`examples/${name}`);
13
- }
14
-
15
- describe('examples', () => {
16
- // ── Existing examples ───────────────────────────────────────────
17
-
18
- describe('simple-agent.ts', () => {
19
- it('renders SWML with AI block and get_time tool', async () => {
20
- const agent = await loadExample('simple-agent.ts');
21
- const swml = JSON.parse(agent.renderSwml('test-call-id'));
22
- expect(swml).toHaveProperty('version', '1.0.0');
23
- expect(swml).toHaveProperty('sections');
24
- const tools = agent.getRegisteredTools();
25
- expect(tools.some((t: any) => t.name === 'get_time')).toBe(true);
26
- });
27
- });
28
-
29
- // ── Prefab examples ─────────────────────────────────────────────
30
-
31
- describe('prefab-info-gatherer.ts', () => {
32
- it('renders SWML with start_questions and submit_answer tools', async () => {
33
- const agent = await loadExample('prefab-info-gatherer.ts');
34
- const swml = JSON.parse(agent.renderSwml('test-call-id'));
35
- expect(swml).toHaveProperty('version');
36
- const tools = agent.getRegisteredTools();
37
- const names = tools.map((t: any) => t.name);
38
- expect(names).toContain('start_questions');
39
- expect(names).toContain('submit_answer');
40
- });
41
- });
42
-
43
- describe('prefab-survey.ts', () => {
44
- it('renders SWML with survey tools', async () => {
45
- const agent = await loadExample('prefab-survey.ts');
46
- const tools = agent.getRegisteredTools();
47
- const names = tools.map((t: any) => t.name);
48
- expect(names).toContain('answer_question');
49
- expect(names).toContain('get_current_question');
50
- expect(names).toContain('get_survey_progress');
51
- });
52
- });
53
-
54
- describe('prefab-faq.ts', () => {
55
- it('renders SWML with search_faqs and escalate tools', async () => {
56
- const agent = await loadExample('prefab-faq.ts');
57
- const tools = agent.getRegisteredTools();
58
- const names = tools.map((t: any) => t.name);
59
- expect(names).toContain('search_faqs');
60
- expect(names).toContain('escalate');
61
- });
62
- });
63
-
64
- describe('prefab-concierge.ts', () => {
65
- it('renders SWML with concierge tools', async () => {
66
- const agent = await loadExample('prefab-concierge.ts');
67
- const tools = agent.getRegisteredTools();
68
- const names = tools.map((t: any) => t.name);
69
- expect(names).toContain('check_availability');
70
- expect(names).toContain('get_directions');
71
- });
72
- });
73
-
74
- describe('prefab-receptionist.ts', () => {
75
- it('renders SWML with receptionist tools', async () => {
76
- const agent = await loadExample('prefab-receptionist.ts');
77
- const tools = agent.getRegisteredTools();
78
- const names = tools.map((t: any) => t.name);
79
- expect(names).toContain('collect_caller_info');
80
- expect(names).toContain('transfer_call');
81
- expect(names).toContain('check_in_visitor');
82
- });
83
- });
84
-
85
- // ── Skills & features examples ──────────────────────────────────
86
-
87
- describe('skills-demo.ts', () => {
88
- it('renders SWML with datetime and math tools from skills', async () => {
89
- const agent = await loadExample('skills-demo.ts');
90
- const tools = agent.getRegisteredTools();
91
- const names = tools.map((t: any) => t.name);
92
- expect(names).toContain('get_current_time');
93
- expect(names).toContain('get_current_date');
94
- expect(names).toContain('calculate');
95
- });
96
- });
97
-
98
- describe('advanced-dynamic-config.ts', () => {
99
- it('renders SWML with lookup_account tool', async () => {
100
- const agent = await loadExample('advanced-dynamic-config.ts');
101
- const tools = agent.getRegisteredTools();
102
- expect(tools.some((t: any) => t.name === 'lookup_account')).toBe(true);
103
- });
104
- });
105
-
106
- describe('llm-params.ts', () => {
107
- it('renders SWML with tuned parameters', async () => {
108
- const agent = await loadExample('llm-params.ts');
109
- const swml = JSON.parse(agent.renderSwml('test-call-id'));
110
- expect(swml).toHaveProperty('version');
111
- // Check the AI params contain temperature
112
- const sections = swml['sections'];
113
- const main = sections['main'];
114
- const aiVerb = main.find((v: any) => v['ai']);
115
- expect(aiVerb).toBeDefined();
116
- expect(aiVerb['ai']['params']['temperature']).toBe(0.2);
117
- });
118
- });
119
-
120
- describe('session-state.ts', () => {
121
- it('renders SWML with lookup_order tool', async () => {
122
- const agent = await loadExample('session-state.ts');
123
- const tools = agent.getRegisteredTools();
124
- expect(tools.some((t: any) => t.name === 'lookup_order')).toBe(true);
125
- });
126
- });
127
-
128
- describe('record-call.ts', () => {
129
- it('renders SWML with recording tools', async () => {
130
- const agent = await loadExample('record-call.ts');
131
- const tools = agent.getRegisteredTools();
132
- const names = tools.map((t: any) => t.name);
133
- expect(names).toContain('start_recording');
134
- expect(names).toContain('stop_recording');
135
- expect(names).toContain('transfer_to_supervisor');
136
- });
137
- });
138
-
139
- // ── Infrastructure & verb examples ──────────────────────────────
140
-
141
- describe('serverless-lambda.ts', () => {
142
- it('renders SWML and exports handler function', async () => {
143
- // loadAgent will find the 'agent' export
144
- const agent = await loadExample('serverless-lambda.ts');
145
- const swml = JSON.parse(agent.renderSwml('test-call-id'));
146
- expect(swml).toHaveProperty('version');
147
- });
148
- });
149
-
150
- describe('verb-methods.ts', () => {
151
- it('renders SWML with pre-answer and post-AI verbs', async () => {
152
- const agent = await loadExample('verb-methods.ts');
153
- const swml = JSON.parse(agent.renderSwml('test-call-id'));
154
- expect(swml).toHaveProperty('version');
155
- const main = swml['sections']['main'];
156
- // Should have pre-answer play verb
157
- expect(main.some((v: any) => v['play'])).toBe(true);
158
- });
159
- });
160
-
161
- describe('kubernetes-agent.ts', () => {
162
- it('renders SWML with get_status tool', async () => {
163
- const agent = await loadExample('kubernetes-agent.ts');
164
- const tools = agent.getRegisteredTools();
165
- expect(tools.some((t: any) => t.name === 'get_status')).toBe(true);
166
- });
167
- });
168
-
169
- // ── SWMLService examples ────────────────────────────────────────
170
-
171
- describe('swml-service.ts', () => {
172
- it('produces SWML with no AI block', async () => {
173
- const svc = await loadExample('swml-service.ts');
174
- const doc = svc.renderSwml();
175
- expect(doc).toHaveProperty('version', '1.0.0');
176
- const main = doc['sections']['main'];
177
- expect(main.length).toBeGreaterThan(0);
178
- // No AI block in any verb
179
- for (const verb of main) {
180
- expect(verb).not.toHaveProperty('ai');
181
- }
182
- });
183
- });
184
-
185
- describe('dynamic-swml-service.ts', () => {
186
- it('loads without error', async () => {
187
- const svc = await loadExample('dynamic-swml-service.ts');
188
- expect(svc).toBeDefined();
189
- // Static renderSwml returns empty main (dynamic content is per-request)
190
- const doc = svc.renderSwml();
191
- expect(doc).toHaveProperty('version', '1.0.0');
192
- });
193
- });
194
- });
@@ -1,53 +0,0 @@
1
- # Web-search scrape parity fixtures
2
-
3
- These fixtures cross-check that the TypeScript SDK's HTML → plain-text
4
- extraction (`extractTextFromHtml` in `src/skills/builtin/web_search.ts`)
5
- produces byte-identical output to the Python SDK's `extract_html_content`
6
- (`signalwire-python/skills/web_search/skill.py:204-282`).
7
-
8
- The TypeScript side uses cheerio; the Python side uses BeautifulSoup with
9
- the `html.parser` backend. The test at `tests/skills/web-search-parity.test.ts`
10
- runs the TS pipeline against each `html/*.html` fixture and asserts the
11
- result matches `expected/*.json` exactly.
12
-
13
- ## Why this is pinned, not live
14
-
15
- The expected outputs are checked in (rather than computed by running Python
16
- in the test). That avoids a Python runtime dependency in CI and guarantees
17
- the test is deterministic — the Python side is effectively frozen until a
18
- developer intentionally regenerates.
19
-
20
- ## Regenerating expected outputs
21
-
22
- When the Python reference changes or a new fixture is added:
23
-
24
- ```bash
25
- cd tests/fixtures/scrape-parity
26
- pip install beautifulsoup4 # only first time
27
-
28
- for html in html/*.html; do
29
- name=$(basename "$html" .html)
30
- python3 python_extract.py "$html" > "expected/$name.json"
31
- done
32
- ```
33
-
34
- Review the diff carefully before committing — any change to an expected
35
- file is a behavioral change in the Python reference that the TS side now
36
- needs to match.
37
-
38
- ## Fixture guide
39
-
40
- | File | Behavior exercised |
41
- |---|---|
42
- | `01_simple_article.html` | Baseline — `<nav>` / `<header>` / `<footer>` stripped around a plain `<article>`. |
43
- | `02_class_based_noise.html` | Class-based pattern filter against sidebar / advertisement / cookie / related / share wrappers. |
44
- | `03_nested_containers.html` | `<article>` nested inside `<main>` — selector priority picks `article` first. |
45
- | `04_bare_body.html` | No semantic containers — falls all the way through to `<body>`. |
46
- | `05_malformed.html` | Unclosed tags — verifies parsers recover to the same DOM shape. |
47
- | `06_multi_class.html` | Multi-class elements — tests that the regex matches on substring of the full `class` attribute. |
48
- | `07_anchor_pattern.html` | Patterns are substring regexes with no anchors — `nav` matches both `"nav"` and `"snav"`. |
49
- | `08_inline_script.html` | `<script>` / `<style>` content is dropped, neighboring `<p>` content preserved. |
50
- | `09_whitespace_nbsp.html` | Runs of whitespace, `&nbsp;`, tabs and newlines collapse to single spaces. |
51
- | `10_entity_unicode.html` | HTML entities decode; astral-plane characters (emoji, mathematical bold) count as codepoints, not UTF-16 code units. |
52
- | `11_cdata_comments.html` | HTML comments dropped; `<![CDATA[…]]>` content preserved (matches Python `html.parser`). |
53
- | `12_deep_nested_removals.html` | Real article nested inside a `class="also-sidebar-deep"` wrapper — selector runs BEFORE pattern removal so the article still wins. |
@@ -1,5 +0,0 @@
1
- {
2
- "text": "The Quick Brown Fox The quick brown fox jumps over the lazy dog. This is a test of basic content extraction. We want to make sure the main article text is preserved while boilerplate is dropped. Second paragraph has some additional content. Enough to make the extracted text meaningful and testable for character counts and sentence parsing.",
3
- "text_length": 341,
4
- "sentence_count": 5
5
- }
@@ -1,5 +0,0 @@
1
- {
2
- "text": "Real Article Title This is the actual article content. It should survive the class/id based filter because its class names do not match any of the boilerplate patterns. The filter walks every element with a class or id attribute and removes the ones matching patterns like sidebar, advertisement, cookie, etc.",
3
- "text_length": 309,
4
- "sentence_count": 3
5
- }
@@ -1,5 +0,0 @@
1
- {
2
- "text": "Nested Article Article tag comes before main in our selector priority list. This article is nested inside main so whichever selector wins first determines the extraction root. Expected behavior: article should be picked because it is earlier in the candidate list. If main is picked, we extract the whole subtree including the article.",
3
- "text_length": 335,
4
- "sentence_count": 4
5
- }
@@ -1,5 +0,0 @@
1
- {
2
- "text": "No semantic containers There is no main article or any semantic tag. The selector list should fall all the way through to body and extract the whole thing. This tests the fallback behavior where none of the twelve priority selectors match.",
3
- "text_length": 239,
4
- "sentence_count": 3
5
- }
@@ -1,5 +0,0 @@
1
- {
2
- "text": "Malformed HTML with unclosed tags Second paragraph without closing the first Div inside paragraph context Inline in div",
3
- "text_length": 119,
4
- "sentence_count": 1
5
- }
@@ -1,5 +0,0 @@
1
- {
2
- "text": "Kept Content This div has classes content and main-section. Neither matches a noise pattern so the element survives.",
3
- "text_length": 116,
4
- "sentence_count": 2
5
- }
@@ -1,5 +0,0 @@
1
- {
2
- "text": "Baseline paragraph A. Baseline paragraph B with extra text. Baseline paragraph C with even more extra text to pad. This div's class equals \"nav\" exactly — tests whether per-token vs whole-string regex differs. Whole-string match for 'nav' would catch this; per-token would not, because 'snav' is not 'nav'.",
3
- "text_length": 306,
4
- "sentence_count": 4
5
- }
@@ -1,5 +0,0 @@
1
- {
2
- "text": "Before the script tag. After the script tag. After the style tag. Tests that inline script and style contents are dropped.",
3
- "text_length": 122,
4
- "sentence_count": 1
5
- }
@@ -1,5 +0,0 @@
1
- {
2
- "text": "Line with nbsp. Line with runs of spaces. Line with line breaks in the middle. Combined runs and newlines plus some tabs here and there for good measure.",
3
- "text_length": 153,
4
- "sentence_count": 2
5
- }
@@ -1,5 +0,0 @@
1
- {
2
- "text": "HTML entities: & < > \" ' © ’ — Unicode: café naïve résumé 你好 مرحبا 👋 𝕳𝖊𝖑𝖑𝖔 Smart quotes: “hello” and ‘world’ — em dash en dash – too.",
3
- "text_length": 133,
4
- "sentence_count": 1
5
- }
@@ -1,5 +0,0 @@
1
- {
2
- "text": "Paragraph before the comment. Paragraph after the comment. This is CDATA content; parsers disagree whether this ends up in text. Last paragraph to give enough text above the 100-char selector threshold.",
3
- "text_length": 202,
4
- "sentence_count": 2
5
- }
@@ -1,5 +0,0 @@
1
- {
2
- "text": "Article nested INSIDE a class='also-sidebar-deep' wrapper. Tests removal cascade.",
3
- "text_length": 81,
4
- "sentence_count": 1
5
- }
@@ -1,18 +0,0 @@
1
- <!DOCTYPE html>
2
- <html>
3
- <head>
4
- <title>Simple Article</title>
5
- <script>var foo = 1;</script>
6
- <style>body { color: red; }</style>
7
- </head>
8
- <body>
9
- <nav>Home | About | Contact</nav>
10
- <header>Site header</header>
11
- <article>
12
- <h1>The Quick Brown Fox</h1>
13
- <p>The quick brown fox jumps over the lazy dog. This is a test of basic content extraction. We want to make sure the main article text is preserved while boilerplate is dropped.</p>
14
- <p>Second paragraph has some additional content. Enough to make the extracted text meaningful and testable for character counts and sentence parsing.</p>
15
- </article>
16
- <footer>Copyright 2026. All rights reserved.</footer>
17
- </body>
18
- </html>
@@ -1,18 +0,0 @@
1
- <!DOCTYPE html>
2
- <html>
3
- <head><title>Class Noise</title></head>
4
- <body>
5
- <main>
6
- <div class="sidebar-nav">Side navigation menu with links to other pages</div>
7
- <div class="advertisement-banner">Sponsored content goes here</div>
8
- <div id="cookie-gdpr-notice">Please accept our cookies and GDPR notice</div>
9
- <div class="main-content">
10
- <h1>Real Article Title</h1>
11
- <p>This is the actual article content. It should survive the class/id based filter because its class names do not match any of the boilerplate patterns.</p>
12
- <p>The filter walks every element with a class or id attribute and removes the ones matching patterns like sidebar, advertisement, cookie, etc.</p>
13
- </div>
14
- <aside class="related-articles">Related: other stuff</aside>
15
- <div class="share-social">Share on Twitter Facebook</div>
16
- </main>
17
- </body>
18
- </html>
@@ -1,13 +0,0 @@
1
- <!DOCTYPE html>
2
- <html>
3
- <head><title>Nested</title></head>
4
- <body>
5
- <main>
6
- <article>
7
- <h1>Nested Article</h1>
8
- <p>Article tag comes before main in our selector priority list. This article is nested inside main so whichever selector wins first determines the extraction root.</p>
9
- <p>Expected behavior: article should be picked because it is earlier in the candidate list. If main is picked, we extract the whole subtree including the article.</p>
10
- </article>
11
- </main>
12
- </body>
13
- </html>
@@ -1,9 +0,0 @@
1
- <!DOCTYPE html>
2
- <html>
3
- <head><title>Bare Body</title></head>
4
- <body>
5
- <h1>No semantic containers</h1>
6
- <p>There is no main article or any semantic tag. The selector list should fall all the way through to body and extract the whole thing.</p>
7
- <p>This tests the fallback behavior where none of the twelve priority selectors match.</p>
8
- </body>
9
- </html>
@@ -1,11 +0,0 @@
1
- <!DOCTYPE html>
2
- <html>
3
- <body>
4
- <article>
5
- <p>Malformed HTML with unclosed tags
6
- <p>Second paragraph without closing the first
7
- <div>Div inside paragraph context
8
- <span>Inline in div
9
- </article>
10
- Unclosed everything. Parsers recover differently here so this tests how each library handles broken structure.
11
- </body>
@@ -1,18 +0,0 @@
1
- <!DOCTYPE html>
2
- <html>
3
- <head><title>Multi-class</title></head>
4
- <body>
5
- <main>
6
- <div class="wrapper sidebar-menu promoted">
7
- This div has three classes. One of them (sidebar-menu) matches the sidebar pattern.
8
- </div>
9
- <div class="content main-section">
10
- <h1>Kept Content</h1>
11
- <p>This div has classes content and main-section. Neither matches a noise pattern so the element survives.</p>
12
- </div>
13
- <div class="banner-wrapper">
14
- Banner class should be removed by the banner pattern filter.
15
- </div>
16
- </main>
17
- </body>
18
- </html>
@@ -1,12 +0,0 @@
1
- <!DOCTYPE html>
2
- <html>
3
- <body>
4
- <main>
5
- <p>Baseline paragraph A.</p>
6
- <p>Baseline paragraph B with extra text.</p>
7
- <p>Baseline paragraph C with even more extra text to pad.</p>
8
- <div class="nav">This div's class equals "nav" exactly — tests whether per-token vs whole-string regex differs.</div>
9
- <div class="snav">Whole-string match for 'nav' would catch this; per-token would not, because 'snav' is not 'nav'.</div>
10
- </main>
11
- </body>
12
- </html>
@@ -1,17 +0,0 @@
1
- <!DOCTYPE html>
2
- <html>
3
- <body>
4
- <main>
5
- <p>Before the script tag.</p>
6
- <script>
7
- var secret = 'this should be removed';
8
- alert('also removed');
9
- </script>
10
- <p>After the script tag.</p>
11
- <style>
12
- .secret-style { color: red; }
13
- </style>
14
- <p>After the style tag. Tests that inline script and style contents are dropped.</p>
15
- </main>
16
- </body>
17
- </html>
@@ -1,21 +0,0 @@
1
- <!DOCTYPE html>
2
- <html>
3
- <body>
4
- <main>
5
- <p>Line&nbsp;with&nbsp;nbsp.</p>
6
- <p>Line with runs of spaces.</p>
7
- <p>Line
8
- with
9
- line
10
- breaks
11
- in
12
- the
13
- middle.</p>
14
- <p>Combined runs
15
-
16
- and newlines
17
-
18
- plus some tabs here and there for good measure.</p>
19
- </main>
20
- </body>
21
- </html>
@@ -1,10 +0,0 @@
1
- <!DOCTYPE html>
2
- <html>
3
- <body>
4
- <main>
5
- <p>HTML entities: &amp; &lt; &gt; &quot; &#39; &copy; &rsquo; &mdash;</p>
6
- <p>Unicode: café naïve résumé 你好 مرحبا 👋 𝕳𝖊𝖑𝖑𝖔</p>
7
- <p>Smart quotes: “hello” and ‘world’ — em dash en dash – too.</p>
8
- </main>
9
- </body>
10
- </html>
@@ -1,13 +0,0 @@
1
- <!DOCTYPE html>
2
- <html>
3
- <body>
4
- <main>
5
- <!-- This is a comment and should not appear in text output -->
6
- <p>Paragraph before the comment.</p>
7
- <!-- nested <p>fake paragraph</p> inside comment -->
8
- <p>Paragraph after the comment.</p>
9
- <![CDATA[This is CDATA content; parsers disagree whether this ends up in text.]]>
10
- <p>Last paragraph to give enough text above the 100-char selector threshold.</p>
11
- </main>
12
- </body>
13
- </html>
@@ -1,24 +0,0 @@
1
- <!DOCTYPE html>
2
- <html>
3
- <body>
4
- <main>
5
- <p>Top-level kept paragraph one with text padding.</p>
6
- <div class="promoted">
7
- <div>
8
- <div>
9
- <p>Deeply nested paragraph inside a sidebar-containing wrapper.</p>
10
- <aside class="cookie">Nested cookie notice to be removed as well.</aside>
11
- </div>
12
- </div>
13
- </div>
14
- <div class="also-sidebar-deep">
15
- <section>
16
- <article>
17
- <p>Article nested INSIDE a class='also-sidebar-deep' wrapper. Tests removal cascade.</p>
18
- </article>
19
- </section>
20
- </div>
21
- <p>Bottom-level kept paragraph two with text padding to pass 100-char selector threshold.</p>
22
- </main>
23
- </body>
24
- </html>
@@ -1,109 +0,0 @@
1
- #!/usr/bin/env python3
2
- """
3
- Reference implementation of the HTML → text pipeline from the Python SDK
4
- (signalwire-python/skills/web_search/skill.py:204-282, `extract_html_content`
5
- minus the HTTP fetch step). Also emits the text_length and sentence_count
6
- sub-metrics used in `_calculate_content_quality` (skill.py:301, 339-342).
7
-
8
- Used to regenerate tests/fixtures/scrape-parity/expected/*.json when either
9
- the Python SDK or this fixture suite changes. See README.md in this folder.
10
-
11
- Requires: beautifulsoup4 (pip install beautifulsoup4).
12
-
13
- Usage:
14
- python3 python_extract.py path/to/fixture.html > expected.json
15
- """
16
- import json
17
- import re
18
- import sys
19
- from bs4 import BeautifulSoup
20
-
21
-
22
- def extract(html: str) -> dict:
23
- soup = BeautifulSoup(html, "html.parser")
24
-
25
- # Selector priority — skill.py:220-228
26
- content_selectors = [
27
- "article",
28
- "main",
29
- '[role="main"]',
30
- ".content",
31
- "#content",
32
- ".post",
33
- ".entry-content",
34
- ".article-body",
35
- ".story-body",
36
- ".markdown-body",
37
- ".wiki-body",
38
- ".documentation",
39
- ]
40
- main_content = None
41
- for selector in content_selectors:
42
- main_content = soup.select_one(selector)
43
- if main_content:
44
- break
45
- if not main_content:
46
- main_content = soup.find("body") or soup
47
-
48
- content_soup = BeautifulSoup(str(main_content), "html.parser")
49
-
50
- # Unwanted tags — skill.py:239
51
- for tag in [
52
- "script",
53
- "style",
54
- "nav",
55
- "footer",
56
- "header",
57
- "aside",
58
- "noscript",
59
- "iframe",
60
- ]:
61
- for element in content_soup(tag):
62
- element.decompose()
63
-
64
- # Unwanted patterns — skill.py:245-257
65
- for pattern in [
66
- "sidebar",
67
- "navigation",
68
- "menu",
69
- "advertisement",
70
- "ads",
71
- "banner",
72
- "popup",
73
- "modal",
74
- "cookie",
75
- "gdpr",
76
- "subscribe",
77
- "newsletter",
78
- "comments",
79
- "related",
80
- "share",
81
- "social",
82
- ]:
83
- for element in content_soup.find_all(class_=re.compile(pattern, re.I)):
84
- element.decompose()
85
- for element in content_soup.find_all(id=re.compile(pattern, re.I)):
86
- element.decompose()
87
-
88
- # Text extraction & whitespace normalization — skill.py:260-269
89
- text = content_soup.get_text()
90
- lines = [line.strip() for line in text.splitlines()]
91
- lines = [line for line in lines if line]
92
- text = " ".join(lines)
93
- text = re.sub(r"\s+", " ", text).strip()
94
-
95
- # Sub-metrics — skill.py:301 (text_length), skill.py:339-342 (sentence_count)
96
- sentences = re.split(r"[.!?]+", text)
97
- sentence_count = len([s for s in sentences if len(s.strip()) > 30])
98
-
99
- return {
100
- "text": text,
101
- "text_length": len(text),
102
- "sentence_count": sentence_count,
103
- }
104
-
105
-
106
- if __name__ == "__main__":
107
- html = open(sys.argv[1], encoding="utf-8").read()
108
- json.dump(extract(html), sys.stdout, ensure_ascii=False, indent=2)
109
- sys.stdout.write("\n")