xithead 1.2.2 → 1.5.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 (659) hide show
  1. package/.actrc +14 -0
  2. package/.actrc.local.example +15 -0
  3. package/.changelog.md +2 -0
  4. package/.claude/agents/academic-anthropologist.md +125 -0
  5. package/.claude/agents/academic-geographer.md +127 -0
  6. package/.claude/agents/academic-historian.md +123 -0
  7. package/.claude/agents/academic-narratologist.md +118 -0
  8. package/.claude/agents/academic-psychologist.md +118 -0
  9. package/.claude/agents/academic-statistician.md +144 -0
  10. package/.claude/agents/accounts-payable-agent.md +205 -0
  11. package/.claude/agents/agentic-identity-trust.md +394 -0
  12. package/.claude/agents/agents-orchestrator.md +367 -0
  13. package/.claude/agents/automation-governance-architect.md +216 -0
  14. package/.claude/agents/blender-addon-engineer.md +243 -0
  15. package/.claude/agents/business-strategist.md +488 -0
  16. package/.claude/agents/change-management-consultant.md +497 -0
  17. package/.claude/agents/chief-financial-officer.md +388 -0
  18. package/.claude/agents/corporate-training-designer.md +192 -0
  19. package/.claude/agents/customer-service.md +398 -0
  20. package/.claude/agents/customer-success-manager.md +460 -0
  21. package/.claude/agents/data-consolidation-agent.md +60 -0
  22. package/.claude/agents/data-privacy-officer.md +412 -0
  23. package/.claude/agents/design-brand-guardian.md +322 -0
  24. package/.claude/agents/design-image-prompt-engineer.md +236 -0
  25. package/.claude/agents/design-inclusive-visuals-specialist.md +73 -0
  26. package/.claude/agents/design-persona-walkthrough.md +272 -0
  27. package/.claude/agents/design-ui-designer.md +386 -0
  28. package/.claude/agents/design-ui-finish-gate-reviewer.md +217 -0
  29. package/.claude/agents/design-ux-architect.md +482 -0
  30. package/.claude/agents/design-ux-researcher.md +329 -0
  31. package/.claude/agents/design-visual-storyteller.md +149 -0
  32. package/.claude/agents/design-whimsy-injector.md +460 -0
  33. package/.claude/agents/economy-designer.md +156 -0
  34. package/.claude/agents/engineering-ai-data-remediation-engineer.md +211 -0
  35. package/.claude/agents/engineering-ai-engineer.md +146 -0
  36. package/.claude/agents/engineering-api-platform-engineer.md +181 -0
  37. package/.claude/agents/engineering-ats-validator-architect.md +383 -0
  38. package/.claude/agents/engineering-autonomous-optimization-architect.md +121 -0
  39. package/.claude/agents/engineering-backend-architect.md +255 -0
  40. package/.claude/agents/engineering-china-network-engineer.md +252 -0
  41. package/.claude/agents/engineering-cms-developer.md +536 -0
  42. package/.claude/agents/engineering-code-reviewer.md +76 -0
  43. package/.claude/agents/engineering-codebase-onboarding-engineer.md +173 -0
  44. package/.claude/agents/engineering-data-engineer.md +349 -0
  45. package/.claude/agents/engineering-data-visualization-engineer.md +151 -0
  46. package/.claude/agents/engineering-database-optimizer.md +188 -0
  47. package/.claude/agents/engineering-database-reliability-engineer.md +201 -0
  48. package/.claude/agents/engineering-desktop-app-engineer.md +209 -0
  49. package/.claude/agents/engineering-developer-tooling-engineer.md +153 -0
  50. package/.claude/agents/engineering-devops-automator.md +385 -0
  51. package/.claude/agents/engineering-drupal-performance.md +347 -0
  52. package/.claude/agents/engineering-drupal-shopping-cart.md +360 -0
  53. package/.claude/agents/engineering-electrical-engineer.md +575 -0
  54. package/.claude/agents/engineering-email-intelligence-engineer.md +390 -0
  55. package/.claude/agents/engineering-embedded-firmware-engineer.md +196 -0
  56. package/.claude/agents/engineering-feishu-integration-developer.md +606 -0
  57. package/.claude/agents/engineering-filament-optimization-specialist.md +283 -0
  58. package/.claude/agents/engineering-finops-engineer.md +164 -0
  59. package/.claude/agents/engineering-frontend-developer.md +257 -0
  60. package/.claude/agents/engineering-gaussdb-expert.md +334 -0
  61. package/.claude/agents/engineering-git-workflow-master.md +98 -0
  62. package/.claude/agents/engineering-i18n-engineer.md +214 -0
  63. package/.claude/agents/engineering-identity-access-engineer.md +217 -0
  64. package/.claude/agents/engineering-incident-response-commander.md +444 -0
  65. package/.claude/agents/engineering-iot-fleet-engineer.md +148 -0
  66. package/.claude/agents/engineering-it-service-manager.md +561 -0
  67. package/.claude/agents/engineering-knowledge-graph-engineer.md +372 -0
  68. package/.claude/agents/engineering-llm-post-training-engineer.md +166 -0
  69. package/.claude/agents/engineering-minimal-change-engineer.md +207 -0
  70. package/.claude/agents/engineering-mobile-app-builder.md +493 -0
  71. package/.claude/agents/engineering-mobile-release-engineer.md +164 -0
  72. package/.claude/agents/engineering-multi-agent-systems-architect.md +600 -0
  73. package/.claude/agents/engineering-network-engineer.md +245 -0
  74. package/.claude/agents/engineering-orgscript-engineer.md +113 -0
  75. package/.claude/agents/engineering-payments-billing-engineer.md +228 -0
  76. package/.claude/agents/engineering-pdf-engine-architect.md +696 -0
  77. package/.claude/agents/engineering-platform-engineer.md +270 -0
  78. package/.claude/agents/engineering-privacy-engineer.md +152 -0
  79. package/.claude/agents/engineering-prompt-engineer.md +209 -0
  80. package/.claude/agents/engineering-rag-pipeline-engineer.md +450 -0
  81. package/.claude/agents/engineering-rapid-prototyper.md +466 -0
  82. package/.claude/agents/engineering-realtime-collaboration-engineer.md +200 -0
  83. package/.claude/agents/engineering-rust-refactoring-specialist.md +313 -0
  84. package/.claude/agents/engineering-search-relevance-engineer.md +237 -0
  85. package/.claude/agents/engineering-section-508-specialist.md +339 -0
  86. package/.claude/agents/engineering-senior-developer.md +176 -0
  87. package/.claude/agents/engineering-servicenow-developer-mentor.md +180 -0
  88. package/.claude/agents/engineering-software-architect.md +112 -0
  89. package/.claude/agents/engineering-solidity-smart-contract-engineer.md +522 -0
  90. package/.claude/agents/engineering-sre.md +90 -0
  91. package/.claude/agents/engineering-technical-writer.md +393 -0
  92. package/.claude/agents/engineering-universal-document-compiler.md +370 -0
  93. package/.claude/agents/engineering-uswds-developer.md +340 -0
  94. package/.claude/agents/engineering-video-streaming-engineer.md +151 -0
  95. package/.claude/agents/engineering-voice-ai-integration-engineer.md +584 -0
  96. package/.claude/agents/engineering-webassembly-engineer.md +153 -0
  97. package/.claude/agents/engineering-wechat-mini-program-developer.md +356 -0
  98. package/.claude/agents/engineering-wordpress-performance.md +346 -0
  99. package/.claude/agents/engineering-wordpress-shopping-cart.md +346 -0
  100. package/.claude/agents/esg-sustainability-officer.md +396 -0
  101. package/.claude/agents/finance-bookkeeper-controller.md +260 -0
  102. package/.claude/agents/finance-financial-analyst.md +234 -0
  103. package/.claude/agents/finance-fpa-analyst.md +263 -0
  104. package/.claude/agents/finance-investment-researcher.md +272 -0
  105. package/.claude/agents/finance-tax-strategist.md +239 -0
  106. package/.claude/agents/game-audio-engineer.md +264 -0
  107. package/.claude/agents/game-designer.md +167 -0
  108. package/.claude/agents/gis-3d-scene-developer.md +111 -0
  109. package/.claude/agents/gis-analyst.md +91 -0
  110. package/.claude/agents/gis-bim-specialist.md +108 -0
  111. package/.claude/agents/gis-cartography-designer.md +150 -0
  112. package/.claude/agents/gis-drone-reality-mapping.md +120 -0
  113. package/.claude/agents/gis-geoai-ml-engineer.md +105 -0
  114. package/.claude/agents/gis-geoprocessing-specialist.md +97 -0
  115. package/.claude/agents/gis-qa-engineer.md +133 -0
  116. package/.claude/agents/gis-solution-engineer.md +101 -0
  117. package/.claude/agents/gis-spatial-data-engineer.md +97 -0
  118. package/.claude/agents/gis-spatial-data-scientist.md +111 -0
  119. package/.claude/agents/gis-technical-consultant.md +86 -0
  120. package/.claude/agents/gis-web-gis-developer.md +108 -0
  121. package/.claude/agents/godot-gameplay-scripter.md +338 -0
  122. package/.claude/agents/godot-multiplayer-engineer.md +301 -0
  123. package/.claude/agents/godot-shader-developer.md +267 -0
  124. package/.claude/agents/government-digital-presales-consultant.md +363 -0
  125. package/.claude/agents/grant-writer.md +511 -0
  126. package/.claude/agents/healthcare-aging-parent-care-companion.md +414 -0
  127. package/.claude/agents/healthcare-clinical-evidence-agent.md +231 -0
  128. package/.claude/agents/healthcare-customer-service.md +389 -0
  129. package/.claude/agents/healthcare-innovation-strategist.md +433 -0
  130. package/.claude/agents/healthcare-marketing-compliance.md +395 -0
  131. package/.claude/agents/healthcare-sovereign-health-systems-agent.md +312 -0
  132. package/.claude/agents/hospitality-guest-services.md +603 -0
  133. package/.claude/agents/hr-onboarding.md +451 -0
  134. package/.claude/agents/identity-graph-operator.md +303 -0
  135. package/.claude/agents/language-translator.md +264 -0
  136. package/.claude/agents/legal-billing-time-tracking.md +569 -0
  137. package/.claude/agents/legal-client-intake.md +492 -0
  138. package/.claude/agents/legal-document-review.md +454 -0
  139. package/.claude/agents/level-designer.md +208 -0
  140. package/.claude/agents/loan-officer-assistant.md +555 -0
  141. package/.claude/agents/lsp-index-engineer.md +320 -0
  142. package/.claude/agents/ma-integration-manager.md +427 -0
  143. package/.claude/agents/macos-spatial-metal-engineer.md +337 -0
  144. package/.claude/agents/marketing-aeo-foundations.md +264 -0
  145. package/.claude/agents/marketing-agentic-search-optimizer.md +279 -0
  146. package/.claude/agents/marketing-ai-citation-strategist.md +172 -0
  147. package/.claude/agents/marketing-app-store-optimizer.md +321 -0
  148. package/.claude/agents/marketing-baidu-seo-specialist.md +226 -0
  149. package/.claude/agents/marketing-bilibili-content-strategist.md +199 -0
  150. package/.claude/agents/marketing-book-co-author.md +110 -0
  151. package/.claude/agents/marketing-carousel-growth-engine.md +204 -0
  152. package/.claude/agents/marketing-china-ecommerce-operator.md +283 -0
  153. package/.claude/agents/marketing-china-market-localization-strategist.md +283 -0
  154. package/.claude/agents/marketing-content-creator.md +54 -0
  155. package/.claude/agents/marketing-cross-border-ecommerce.md +259 -0
  156. package/.claude/agents/marketing-developer-community-builder.md +285 -0
  157. package/.claude/agents/marketing-douyin-strategist.md +149 -0
  158. package/.claude/agents/marketing-email-strategist.md +249 -0
  159. package/.claude/agents/marketing-global-podcast-strategist.md +206 -0
  160. package/.claude/agents/marketing-growth-hacker.md +54 -0
  161. package/.claude/agents/marketing-instagram-curator.md +113 -0
  162. package/.claude/agents/marketing-kuaishou-strategist.md +223 -0
  163. package/.claude/agents/marketing-linkedin-content-creator.md +214 -0
  164. package/.claude/agents/marketing-livestream-commerce-coach.md +305 -0
  165. package/.claude/agents/marketing-multi-platform-publisher.md +217 -0
  166. package/.claude/agents/marketing-podcast-strategist.md +277 -0
  167. package/.claude/agents/marketing-pr-communications-manager.md +473 -0
  168. package/.claude/agents/marketing-private-domain-operator.md +308 -0
  169. package/.claude/agents/marketing-reddit-community-builder.md +123 -0
  170. package/.claude/agents/marketing-seo-specialist.md +370 -0
  171. package/.claude/agents/marketing-short-video-editing-coach.md +412 -0
  172. package/.claude/agents/marketing-social-media-strategist.md +125 -0
  173. package/.claude/agents/marketing-tiktok-strategist.md +125 -0
  174. package/.claude/agents/marketing-twitter-engager.md +126 -0
  175. package/.claude/agents/marketing-video-optimization-specialist.md +119 -0
  176. package/.claude/agents/marketing-wechat-official-account.md +145 -0
  177. package/.claude/agents/marketing-weibo-strategist.md +240 -0
  178. package/.claude/agents/marketing-x-twitter-intelligence-analyst.md +161 -0
  179. package/.claude/agents/marketing-xiaohongshu-specialist.md +138 -0
  180. package/.claude/agents/marketing-zhihu-strategist.md +162 -0
  181. package/.claude/agents/medical-billing-coding-specialist.md +491 -0
  182. package/.claude/agents/narrative-designer.md +243 -0
  183. package/.claude/agents/operations-manager.md +399 -0
  184. package/.claude/agents/organizational-psychologist.md +391 -0
  185. package/.claude/agents/paid-media-auditor.md +71 -0
  186. package/.claude/agents/paid-media-creative-strategist.md +71 -0
  187. package/.claude/agents/paid-media-paid-social-strategist.md +71 -0
  188. package/.claude/agents/paid-media-ppc-strategist.md +71 -0
  189. package/.claude/agents/paid-media-programmatic-buyer.md +71 -0
  190. package/.claude/agents/paid-media-search-query-analyst.md +71 -0
  191. package/.claude/agents/paid-media-tracking-specialist.md +71 -0
  192. package/.claude/agents/personal-growth-mentor.md +159 -0
  193. package/.claude/agents/product-behavioral-nudge-engine.md +83 -0
  194. package/.claude/agents/product-dx-engineer.md +332 -0
  195. package/.claude/agents/product-feedback-synthesizer.md +119 -0
  196. package/.claude/agents/product-manager.md +469 -0
  197. package/.claude/agents/product-sprint-prioritizer.md +154 -0
  198. package/.claude/agents/product-trend-researcher.md +159 -0
  199. package/.claude/agents/project-management-experiment-tracker.md +198 -0
  200. package/.claude/agents/project-management-jira-workflow-steward.md +233 -0
  201. package/.claude/agents/project-management-meeting-notes-specialist.md +95 -0
  202. package/.claude/agents/project-management-project-shepherd.md +194 -0
  203. package/.claude/agents/project-management-studio-operations.md +200 -0
  204. package/.claude/agents/project-management-studio-producer.md +203 -0
  205. package/.claude/agents/project-manager-senior.md +135 -0
  206. package/.claude/agents/real-estate-buyer-seller.md +596 -0
  207. package/.claude/agents/recruitment-specialist.md +515 -0
  208. package/.claude/agents/report-distribution-agent.md +65 -0
  209. package/.claude/agents/research-synthesist.md +136 -0
  210. package/.claude/agents/resume-tailor.md +230 -0
  211. package/.claude/agents/retail-customer-returns.md +566 -0
  212. package/.claude/agents/roblox-avatar-creator.md +297 -0
  213. package/.claude/agents/roblox-experience-designer.md +306 -0
  214. package/.claude/agents/roblox-systems-scripter.md +332 -0
  215. package/.claude/agents/sales-account-strategist.md +227 -0
  216. package/.claude/agents/sales-coach.md +271 -0
  217. package/.claude/agents/sales-data-extraction-agent.md +67 -0
  218. package/.claude/agents/sales-deal-strategist.md +180 -0
  219. package/.claude/agents/sales-discovery-coach.md +225 -0
  220. package/.claude/agents/sales-engineer.md +182 -0
  221. package/.claude/agents/sales-offer-lead-gen-strategist.md +257 -0
  222. package/.claude/agents/sales-outbound-strategist.md +201 -0
  223. package/.claude/agents/sales-outreach.md +425 -0
  224. package/.claude/agents/sales-pipeline-analyst.md +267 -0
  225. package/.claude/agents/sales-proposal-strategist.md +217 -0
  226. package/.claude/agents/security-ai-generated-code-auditor.md +207 -0
  227. package/.claude/agents/security-appsec-engineer.md +536 -0
  228. package/.claude/agents/security-architect.md +307 -0
  229. package/.claude/agents/security-blockchain-security-auditor.md +482 -0
  230. package/.claude/agents/security-cloud-security-architect.md +576 -0
  231. package/.claude/agents/security-compliance-auditor.md +158 -0
  232. package/.claude/agents/security-incident-responder.md +450 -0
  233. package/.claude/agents/security-penetration-tester.md +399 -0
  234. package/.claude/agents/security-secrets-credential-engineer.md +189 -0
  235. package/.claude/agents/security-senior-secops.md +760 -0
  236. package/.claude/agents/security-threat-detection-engineer.md +553 -0
  237. package/.claude/agents/security-threat-intelligence-analyst.md +661 -0
  238. package/.claude/agents/specialized-chief-of-staff.md +279 -0
  239. package/.claude/agents/specialized-civil-engineer.md +356 -0
  240. package/.claude/agents/specialized-codebase-archaeologist.md +341 -0
  241. package/.claude/agents/specialized-cultural-intelligence-strategist.md +88 -0
  242. package/.claude/agents/specialized-developer-advocate.md +317 -0
  243. package/.claude/agents/specialized-document-generator.md +55 -0
  244. package/.claude/agents/specialized-fedramp-rmf-compliance.md +378 -0
  245. package/.claude/agents/specialized-focus-music-architect.md +175 -0
  246. package/.claude/agents/specialized-french-consulting-market.md +194 -0
  247. package/.claude/agents/specialized-korean-business-navigator.md +216 -0
  248. package/.claude/agents/specialized-master-plan-architect.md +157 -0
  249. package/.claude/agents/specialized-mcp-builder.md +260 -0
  250. package/.claude/agents/specialized-model-qa.md +528 -0
  251. package/.claude/agents/specialized-pricing-analyst.md +243 -0
  252. package/.claude/agents/specialized-salesforce-architect.md +182 -0
  253. package/.claude/agents/specialized-strategy-duel-agent.md +130 -0
  254. package/.claude/agents/specialized-workflow-architect.md +597 -0
  255. package/.claude/agents/study-abroad-advisor.md +282 -0
  256. package/.claude/agents/supply-chain-strategist.md +591 -0
  257. package/.claude/agents/support-analytics-reporter.md +387 -0
  258. package/.claude/agents/support-executive-summary-generator.md +212 -0
  259. package/.claude/agents/support-finance-tracker.md +480 -0
  260. package/.claude/agents/support-infrastructure-maintainer.md +628 -0
  261. package/.claude/agents/support-legal-compliance-checker.md +591 -0
  262. package/.claude/agents/support-support-responder.md +607 -0
  263. package/.claude/agents/technical-artist.md +233 -0
  264. package/.claude/agents/terminal-integration-specialist.md +70 -0
  265. package/.claude/agents/testing-accessibility-auditor.md +327 -0
  266. package/.claude/agents/testing-api-tester.md +334 -0
  267. package/.claude/agents/testing-evidence-collector.md +210 -0
  268. package/.claude/agents/testing-performance-benchmarker.md +283 -0
  269. package/.claude/agents/testing-reality-checker.md +249 -0
  270. package/.claude/agents/testing-test-automation-engineer.md +196 -0
  271. package/.claude/agents/testing-test-results-analyzer.md +330 -0
  272. package/.claude/agents/testing-tool-evaluator.md +416 -0
  273. package/.claude/agents/testing-workflow-optimizer.md +463 -0
  274. package/.claude/agents/unity-architect.md +271 -0
  275. package/.claude/agents/unity-editor-tool-developer.md +310 -0
  276. package/.claude/agents/unity-multiplayer-engineer.md +323 -0
  277. package/.claude/agents/unity-shader-graph-artist.md +269 -0
  278. package/.claude/agents/unreal-multiplayer-architect.md +364 -0
  279. package/.claude/agents/unreal-systems-engineer.md +322 -0
  280. package/.claude/agents/unreal-technical-artist.md +256 -0
  281. package/.claude/agents/unreal-world-builder.md +273 -0
  282. package/.claude/agents/visionos-spatial-engineer.md +54 -0
  283. package/.claude/agents/xr-cockpit-interaction-specialist.md +32 -0
  284. package/.claude/agents/xr-immersive-developer.md +32 -0
  285. package/.claude/agents/xr-interface-architect.md +32 -0
  286. package/.claude/agents/zk-steward.md +211 -0
  287. package/.claude-plugin/marketplace.json +30 -0
  288. package/.commitlintrc.json +26 -0
  289. package/.devcontainer/Dockerfile +24 -0
  290. package/.devcontainer/devcontainer.json +70 -0
  291. package/.devcontainer/docker-compose.memory.yml +42 -0
  292. package/.devcontainer/memory-stack/devcontainer.json +84 -0
  293. package/.devcontainer/post-create.sh +83 -0
  294. package/.dockerignore +23 -0
  295. package/.env.act.example +15 -0
  296. package/.env.example +171 -0
  297. package/.eslintrc.json +16 -0
  298. package/.git-blame-ignore-revs +10 -0
  299. package/.gitattributes +2 -0
  300. package/.gitguardian.yaml +50 -0
  301. package/.githooks/pre-commit +6 -0
  302. package/.pre-commit-config.yaml +30 -0
  303. package/.release-please-config-xithead.json +22 -0
  304. package/.release-please-config.json +44 -0
  305. package/.release-please-manifest-xithead.json +3 -0
  306. package/.release-please-manifest.json +3 -0
  307. package/CODE_OF_CONDUCT.md +133 -0
  308. package/CONTRIBUTING.md +133 -0
  309. package/Cargo.lock +5557 -0
  310. package/Cargo.toml +121 -0
  311. package/Dockerfile +38 -0
  312. package/Dockerfile.proxy +48 -0
  313. package/ENTERPRISE.md +5 -0
  314. package/FEATURES_ADVANCED.md +311 -0
  315. package/Headroom-2.gif +0 -0
  316. package/HeadroomDemo-Fast.gif +0 -0
  317. package/MANIFEST.in +4 -0
  318. package/MODERNIZATION_GUIDE.md +358 -0
  319. package/Makefile +140 -0
  320. package/NOTICE +43 -0
  321. package/NPM_TOKEN_SETUP.md +81 -0
  322. package/PR.md +170 -0
  323. package/PUBLISH.md +77 -0
  324. package/README.md +58 -137
  325. package/README_FRONTEND.md +196 -0
  326. package/REALIGNMENT/00-overview.md +53 -0
  327. package/REALIGNMENT/01-bug-list.md +421 -0
  328. package/REALIGNMENT/02-architecture.md +322 -0
  329. package/REALIGNMENT/03-phase-A-lockdown.md +420 -0
  330. package/REALIGNMENT/04-phase-B-live-zone.md +470 -0
  331. package/REALIGNMENT/05-phase-C-rust-proxy.md +329 -0
  332. package/REALIGNMENT/06-phase-D-bedrock-vertex.md +222 -0
  333. package/REALIGNMENT/07-phase-E-cache-stabilization.md +338 -0
  334. package/REALIGNMENT/08-phase-F-auth-mode.md +254 -0
  335. package/REALIGNMENT/09-phase-G-rtk-observability.md +194 -0
  336. package/REALIGNMENT/10-phase-H-python-retirement.md +214 -0
  337. package/REALIGNMENT/11-phase-I-test-infra.md +385 -0
  338. package/REALIGNMENT/12-decisions-needed.md +196 -0
  339. package/REALIGNMENT/INDEX.md +82 -0
  340. package/REFACTORING_CAMPAIGN.md +277 -0
  341. package/RESTRUCTURE_PLAN.md +100 -0
  342. package/RUST_DEV.md +361 -0
  343. package/SECURITY.md +65 -0
  344. package/SETUP_AUTO_PUBLISH.md +164 -0
  345. package/TESTING-copilot-subscription.md +153 -0
  346. package/app/api/config/route.ts +22 -0
  347. package/app/api/export/route.ts +83 -0
  348. package/app/api/models/route.ts +12 -0
  349. package/app/api/stats/route.ts +46 -0
  350. package/app/dashboard/page.tsx +445 -0
  351. package/app/globals.css +35 -0
  352. package/app/installation/page.tsx +293 -0
  353. package/app/layout.tsx +35 -0
  354. package/app/master-design-system.css +2076 -0
  355. package/app/master-design-system.source.css +8 -0
  356. package/app/page.tsx +187 -0
  357. package/app/rechtliches/agb/page.tsx +165 -0
  358. package/app/rechtliches/datenschutz/page.tsx +128 -0
  359. package/app/rechtliches/impressum/page.tsx +122 -0
  360. package/app/rechtliches/widerruf/page.tsx +185 -0
  361. package/bin/xithead.js +264 -0
  362. package/codecov.yml +34 -0
  363. package/components/layout/AppShell.tsx +25 -0
  364. package/components/layout/Footer.tsx +120 -0
  365. package/components/layout/Header.tsx +145 -0
  366. package/components/marketing/LegalHighlights.tsx +45 -0
  367. package/components/marketing/LegalPageShell.tsx +49 -0
  368. package/components/marketing/LegalPanel.tsx +41 -0
  369. package/components/marketing/index.ts +3 -0
  370. package/crates/headroom-core/Cargo.toml +165 -0
  371. package/crates/headroom-core/benches/auth_mode.rs +74 -0
  372. package/crates/headroom-core/benches/ccr_store.rs +224 -0
  373. package/crates/headroom-core/benches/tokenizer.rs +52 -0
  374. package/crates/headroom-core/config/pipeline.toml +151 -0
  375. package/crates/headroom-core/proptest-regressions/transforms/tag_protector.txt +9 -0
  376. package/crates/headroom-core/src/auth_mode.rs +250 -0
  377. package/crates/headroom-core/src/cache_control.rs +414 -0
  378. package/crates/headroom-core/src/ccr/backends/in_memory.rs +317 -0
  379. package/crates/headroom-core/src/ccr/backends/mod.rs +152 -0
  380. package/crates/headroom-core/src/ccr/backends/redis.rs +146 -0
  381. package/crates/headroom-core/src/ccr/backends/sqlite.rs +205 -0
  382. package/crates/headroom-core/src/ccr/mod.rs +119 -0
  383. package/crates/headroom-core/src/compression_policy.rs +505 -0
  384. package/crates/headroom-core/src/lib.rs +33 -0
  385. package/crates/headroom-core/src/relevance/base.rs +139 -0
  386. package/crates/headroom-core/src/relevance/bm25.rs +385 -0
  387. package/crates/headroom-core/src/relevance/embedding.rs +354 -0
  388. package/crates/headroom-core/src/relevance/hybrid.rs +364 -0
  389. package/crates/headroom-core/src/relevance/mod.rs +64 -0
  390. package/crates/headroom-core/src/signals/keyword_detector.rs +433 -0
  391. package/crates/headroom-core/src/signals/line_importance.rs +84 -0
  392. package/crates/headroom-core/src/signals/mod.rs +61 -0
  393. package/crates/headroom-core/src/signals/tiered.rs +141 -0
  394. package/crates/headroom-core/src/tokenizer/estimator.rs +152 -0
  395. package/crates/headroom-core/src/tokenizer/hf_impl.rs +314 -0
  396. package/crates/headroom-core/src/tokenizer/mod.rs +56 -0
  397. package/crates/headroom-core/src/tokenizer/registry.rs +342 -0
  398. package/crates/headroom-core/src/tokenizer/tiktoken_impl.rs +265 -0
  399. package/crates/headroom-core/src/transforms/adaptive_sizer.rs +610 -0
  400. package/crates/headroom-core/src/transforms/anchor_selector.rs +1189 -0
  401. package/crates/headroom-core/src/transforms/content_detector.rs +769 -0
  402. package/crates/headroom-core/src/transforms/detection.rs +222 -0
  403. package/crates/headroom-core/src/transforms/diff_compressor.rs +1685 -0
  404. package/crates/headroom-core/src/transforms/live_zone.rs +2967 -0
  405. package/crates/headroom-core/src/transforms/log_compressor.rs +1295 -0
  406. package/crates/headroom-core/src/transforms/magika_detector.rs +395 -0
  407. package/crates/headroom-core/src/transforms/mod.rs +64 -0
  408. package/crates/headroom-core/src/transforms/pipeline/config.rs +331 -0
  409. package/crates/headroom-core/src/transforms/pipeline/mod.rs +103 -0
  410. package/crates/headroom-core/src/transforms/pipeline/offloads/diff_noise.rs +524 -0
  411. package/crates/headroom-core/src/transforms/pipeline/offloads/diff_offload.rs +279 -0
  412. package/crates/headroom-core/src/transforms/pipeline/offloads/json_offload.rs +400 -0
  413. package/crates/headroom-core/src/transforms/pipeline/offloads/log_offload.rs +284 -0
  414. package/crates/headroom-core/src/transforms/pipeline/offloads/mod.rs +34 -0
  415. package/crates/headroom-core/src/transforms/pipeline/offloads/search_offload.rs +331 -0
  416. package/crates/headroom-core/src/transforms/pipeline/orchestrator.rs +848 -0
  417. package/crates/headroom-core/src/transforms/pipeline/reformats/json_minifier.rs +175 -0
  418. package/crates/headroom-core/src/transforms/pipeline/reformats/log_template.rs +545 -0
  419. package/crates/headroom-core/src/transforms/pipeline/reformats/mod.rs +12 -0
  420. package/crates/headroom-core/src/transforms/pipeline/traits.rs +338 -0
  421. package/crates/headroom-core/src/transforms/recommendations.rs +329 -0
  422. package/crates/headroom-core/src/transforms/safety.rs +215 -0
  423. package/crates/headroom-core/src/transforms/search_compressor.rs +902 -0
  424. package/crates/headroom-core/src/transforms/smart_crusher/analyzer.rs +1262 -0
  425. package/crates/headroom-core/src/transforms/smart_crusher/anchors.rs +407 -0
  426. package/crates/headroom-core/src/transforms/smart_crusher/builder.rs +263 -0
  427. package/crates/headroom-core/src/transforms/smart_crusher/classifier.rs +214 -0
  428. package/crates/headroom-core/src/transforms/smart_crusher/compaction/classifier.rs +283 -0
  429. package/crates/headroom-core/src/transforms/smart_crusher/compaction/compactor.rs +733 -0
  430. package/crates/headroom-core/src/transforms/smart_crusher/compaction/formatter.rs +961 -0
  431. package/crates/headroom-core/src/transforms/smart_crusher/compaction/ir.rs +252 -0
  432. package/crates/headroom-core/src/transforms/smart_crusher/compaction/mod.rs +127 -0
  433. package/crates/headroom-core/src/transforms/smart_crusher/compaction/walker.rs +397 -0
  434. package/crates/headroom-core/src/transforms/smart_crusher/config.rs +173 -0
  435. package/crates/headroom-core/src/transforms/smart_crusher/constraints.rs +159 -0
  436. package/crates/headroom-core/src/transforms/smart_crusher/crusher.rs +1665 -0
  437. package/crates/headroom-core/src/transforms/smart_crusher/crushers.rs +865 -0
  438. package/crates/headroom-core/src/transforms/smart_crusher/error_keywords.rs +77 -0
  439. package/crates/headroom-core/src/transforms/smart_crusher/field_detect.rs +393 -0
  440. package/crates/headroom-core/src/transforms/smart_crusher/hashing.rs +72 -0
  441. package/crates/headroom-core/src/transforms/smart_crusher/mod.rs +81 -0
  442. package/crates/headroom-core/src/transforms/smart_crusher/observer.rs +66 -0
  443. package/crates/headroom-core/src/transforms/smart_crusher/orchestration.rs +459 -0
  444. package/crates/headroom-core/src/transforms/smart_crusher/outliers.rs +507 -0
  445. package/crates/headroom-core/src/transforms/smart_crusher/planning.rs +904 -0
  446. package/crates/headroom-core/src/transforms/smart_crusher/statistics.rs +510 -0
  447. package/crates/headroom-core/src/transforms/smart_crusher/stats_math.rs +287 -0
  448. package/crates/headroom-core/src/transforms/smart_crusher/traits.rs +203 -0
  449. package/crates/headroom-core/src/transforms/smart_crusher/types.rs +263 -0
  450. package/crates/headroom-core/src/transforms/tag_protector.rs +1272 -0
  451. package/crates/headroom-core/src/transforms/unidiff_detector.rs +232 -0
  452. package/crates/headroom-parity/Cargo.toml +26 -0
  453. package/crates/headroom-parity/examples/diff_fixture.rs +66 -0
  454. package/crates/headroom-parity/src/bin/parity_run.rs +78 -0
  455. package/crates/headroom-parity/src/lib.rs +613 -0
  456. package/crates/headroom-proxy/Cargo.toml +119 -0
  457. package/crates/headroom-proxy/data/model_prices_and_context_window.json +39767 -0
  458. package/crates/headroom-proxy/src/bedrock/auth_mode_layer.rs +192 -0
  459. package/crates/headroom-proxy/src/bedrock/envelope.rs +239 -0
  460. package/crates/headroom-proxy/src/bedrock/eventstream.rs +769 -0
  461. package/crates/headroom-proxy/src/bedrock/eventstream_to_sse.rs +459 -0
  462. package/crates/headroom-proxy/src/bedrock/invoke.rs +735 -0
  463. package/crates/headroom-proxy/src/bedrock/invoke_streaming.rs +1098 -0
  464. package/crates/headroom-proxy/src/bedrock/mod.rs +66 -0
  465. package/crates/headroom-proxy/src/bedrock/sigv4.rs +324 -0
  466. package/crates/headroom-proxy/src/bedrock/vendor.rs +82 -0
  467. package/crates/headroom-proxy/src/cache_stabilization/anthropic_cache_control.rs +698 -0
  468. package/crates/headroom-proxy/src/cache_stabilization/drift_detector.rs +683 -0
  469. package/crates/headroom-proxy/src/cache_stabilization/mod.rs +61 -0
  470. package/crates/headroom-proxy/src/cache_stabilization/openai_cache_key.rs +600 -0
  471. package/crates/headroom-proxy/src/cache_stabilization/tool_def_normalize.rs +514 -0
  472. package/crates/headroom-proxy/src/cache_stabilization/volatile_detector.rs +720 -0
  473. package/crates/headroom-proxy/src/compression/anthropic.rs +92 -0
  474. package/crates/headroom-proxy/src/compression/live_zone_anthropic.rs +1311 -0
  475. package/crates/headroom-proxy/src/compression/live_zone_openai.rs +660 -0
  476. package/crates/headroom-proxy/src/compression/live_zone_responses.rs +678 -0
  477. package/crates/headroom-proxy/src/compression/mod.rs +127 -0
  478. package/crates/headroom-proxy/src/compression/model_limits.rs +211 -0
  479. package/crates/headroom-proxy/src/config.rs +646 -0
  480. package/crates/headroom-proxy/src/error.rs +69 -0
  481. package/crates/headroom-proxy/src/handlers/chat_completions.rs +100 -0
  482. package/crates/headroom-proxy/src/handlers/conversations.rs +241 -0
  483. package/crates/headroom-proxy/src/handlers/mod.rs +13 -0
  484. package/crates/headroom-proxy/src/handlers/responses.rs +256 -0
  485. package/crates/headroom-proxy/src/headers.rs +288 -0
  486. package/crates/headroom-proxy/src/health.rs +41 -0
  487. package/crates/headroom-proxy/src/lib.rs +21 -0
  488. package/crates/headroom-proxy/src/main.rs +141 -0
  489. package/crates/headroom-proxy/src/observability/cache_hit_rate.rs +340 -0
  490. package/crates/headroom-proxy/src/observability/compression_ratio.rs +158 -0
  491. package/crates/headroom-proxy/src/observability/metric_names.rs +174 -0
  492. package/crates/headroom-proxy/src/observability/mod.rs +68 -0
  493. package/crates/headroom-proxy/src/observability/prometheus.rs +394 -0
  494. package/crates/headroom-proxy/src/observability/proxy_metrics.rs +368 -0
  495. package/crates/headroom-proxy/src/proxy.rs +1619 -0
  496. package/crates/headroom-proxy/src/responses_items.rs +565 -0
  497. package/crates/headroom-proxy/src/sse/anthropic.rs +415 -0
  498. package/crates/headroom-proxy/src/sse/framing.rs +366 -0
  499. package/crates/headroom-proxy/src/sse/mod.rs +40 -0
  500. package/crates/headroom-proxy/src/sse/openai_chat.rs +231 -0
  501. package/crates/headroom-proxy/src/sse/openai_responses.rs +458 -0
  502. package/crates/headroom-proxy/src/vertex/adc.rs +315 -0
  503. package/crates/headroom-proxy/src/vertex/envelope.rs +167 -0
  504. package/crates/headroom-proxy/src/vertex/mod.rs +277 -0
  505. package/crates/headroom-proxy/src/vertex/raw_predict.rs +490 -0
  506. package/crates/headroom-proxy/src/vertex/stream_raw_predict.rs +49 -0
  507. package/crates/headroom-proxy/src/websocket.rs +246 -0
  508. package/crates/headroom-py/Cargo.toml +37 -0
  509. package/crates/headroom-py/build.rs +77 -0
  510. package/crates/headroom-py/glibc_compat.c +170 -0
  511. package/crates/headroom-py/src/lib.rs +1655 -0
  512. package/deny.toml +32 -0
  513. package/design-system/base.css +127 -0
  514. package/design-system/components.css +1943 -0
  515. package/design-system/fonts.css +17 -0
  516. package/design-system/tailwind-preset.js +95 -0
  517. package/design-system/tokens.css +48 -0
  518. package/design-system/utilities.css +53 -0
  519. package/docker/differential-network-capture/Dockerfile.runner +14 -0
  520. package/docker/differential-network-capture/docker-compose.yml +142 -0
  521. package/docker/differential-network-capture/run-claude-lane.sh +24 -0
  522. package/docker/docker-compose.native.yml +44 -0
  523. package/docker-bake.hcl +88 -0
  524. package/docker-compose.yml +80 -0
  525. package/e2e/_lib/make_shim.ps1 +24 -0
  526. package/e2e/_lib/make_shim.sh +28 -0
  527. package/e2e/docker-native-install.sh +120 -0
  528. package/e2e/init/Dockerfile +79 -0
  529. package/e2e/wrap/Dockerfile +115 -0
  530. package/examples/07-context-compression.ipynb +279 -0
  531. package/examples/deployment/macos-launchagent/com.headroom.proxy.plist.template +65 -0
  532. package/examples/deployment/macos-launchagent/install.sh +227 -0
  533. package/examples/deployment/macos-launchagent/shell-integration.sh +74 -0
  534. package/examples/deployment/macos-launchagent/uninstall.sh +145 -0
  535. package/headroom-savings.png +0 -0
  536. package/headroom_learn.gif +0 -0
  537. package/lib/config/index.ts +12 -0
  538. package/lib/hooks/index.ts +4 -0
  539. package/lib/hooks/use-mounted.ts +13 -0
  540. package/lib/hooks/use-session.ts +34 -0
  541. package/lib/hooks/use-settings.ts +49 -0
  542. package/lib/utils/index.ts +1 -0
  543. package/lib/utils/settings.ts +162 -0
  544. package/lib/utils/utils.ts +6 -0
  545. package/llms.txt +67 -0
  546. package/middleware.ts +26 -0
  547. package/mkdocs.yml +136 -0
  548. package/next-env.d.ts +7 -0
  549. package/next.config.ts +12 -0
  550. package/npm/bin/xithead.js +2 -2
  551. package/npm/bin/xtream-head.js +366 -0
  552. package/npm/index.js +18 -91
  553. package/npm/package.json +55 -0
  554. package/package.json +47 -42
  555. package/plugins/headroom-agent-hooks/.claude-plugin/plugin.json +17 -0
  556. package/plugins/headroom-agent-hooks/hooks/hooks.json +29 -0
  557. package/plugins/headroom-oauth2/LICENSE +3 -0
  558. package/plugins/headroom-oauth2/SPEC.md +115 -0
  559. package/plugins/headroom-oauth2/pyproject.toml +48 -0
  560. package/plugins/hermes/headroom_retrieve/plugin.yaml +6 -0
  561. package/plugins/openclaw/hook-shim/HOOK.md +21 -0
  562. package/plugins/openclaw/hook-shim/handler.js +3 -0
  563. package/plugins/openclaw/openclaw.plugin.json +98 -0
  564. package/plugins/openclaw/package-lock.json +2692 -0
  565. package/plugins/openclaw/package.json +54 -0
  566. package/plugins/openclaw/prepare-dist.mjs +56 -0
  567. package/plugins/openclaw/src/convert.ts +418 -0
  568. package/plugins/openclaw/src/engine.ts +284 -0
  569. package/plugins/openclaw/src/gateway-config.ts +143 -0
  570. package/plugins/openclaw/src/index.ts +11 -0
  571. package/plugins/openclaw/src/plugin/index.ts +98 -0
  572. package/plugins/openclaw/src/proxy-manager.ts +477 -0
  573. package/plugins/openclaw/src/tools/headroom-retrieve.ts +76 -0
  574. package/plugins/openclaw/test/convert.test.ts +96 -0
  575. package/plugins/openclaw/test/engine-normalization.test.ts +21 -0
  576. package/plugins/openclaw/test/engine.test.ts +101 -0
  577. package/plugins/openclaw/test/gateway-config.test.ts +278 -0
  578. package/plugins/openclaw/test/plugin-runtime-routing.test.ts +141 -0
  579. package/plugins/openclaw/test/proxy-manager.test.ts +343 -0
  580. package/plugins/openclaw/tsup.config.ts +9 -0
  581. package/postcss.config.mjs +7 -0
  582. package/pyproject.toml +438 -0
  583. package/rust-toolchain.toml +16 -0
  584. package/sdk/typescript/examples/basic-compress.ts +64 -0
  585. package/sdk/typescript/examples/ccr-retrieve.ts +80 -0
  586. package/sdk/typescript/examples/hooks-custom-compression.ts +117 -0
  587. package/sdk/typescript/examples/middleware-composition.ts +59 -0
  588. package/sdk/typescript/examples/multi-provider.ts +53 -0
  589. package/sdk/typescript/examples/openai-anthropic-adapters.ts +73 -0
  590. package/sdk/typescript/examples/shared-context-multi-agent.ts +74 -0
  591. package/sdk/typescript/examples/simulation-dry-run.ts +80 -0
  592. package/sdk/typescript/examples/streaming-chat.ts +71 -0
  593. package/sdk/typescript/examples/structured-output.ts +99 -0
  594. package/sdk/typescript/examples/tool-calling-agent.ts +86 -0
  595. package/sdk/typescript/examples/with-headroom-vercel.ts +57 -0
  596. package/sdk/typescript/package-lock.json +3437 -0
  597. package/sdk/typescript/package.json +108 -0
  598. package/sdk/typescript/src/adapters/anthropic.ts +218 -0
  599. package/sdk/typescript/src/adapters/gemini.ts +83 -0
  600. package/sdk/typescript/src/adapters/openai.ts +77 -0
  601. package/sdk/typescript/src/adapters/vercel-ai.ts +131 -0
  602. package/sdk/typescript/src/client.ts +632 -0
  603. package/sdk/typescript/src/compress.ts +87 -0
  604. package/sdk/typescript/src/errors.ts +114 -0
  605. package/sdk/typescript/src/hooks.ts +113 -0
  606. package/sdk/typescript/src/index.ts +140 -0
  607. package/sdk/typescript/src/paths.ts +272 -0
  608. package/sdk/typescript/src/shared-context.ts +188 -0
  609. package/sdk/typescript/src/simulate.ts +52 -0
  610. package/sdk/typescript/src/types/config.ts +183 -0
  611. package/sdk/typescript/src/types/models.ts +314 -0
  612. package/sdk/typescript/src/types.ts +139 -0
  613. package/sdk/typescript/src/utils/case.ts +34 -0
  614. package/sdk/typescript/src/utils/format.ts +480 -0
  615. package/sdk/typescript/src/utils/stream.ts +50 -0
  616. package/sdk/typescript/test/adapters/anthropic.test.ts +217 -0
  617. package/sdk/typescript/test/adapters/gemini.test.ts +131 -0
  618. package/sdk/typescript/test/adapters/openai.test.ts +174 -0
  619. package/sdk/typescript/test/adapters/vercel-ai.test.ts +306 -0
  620. package/sdk/typescript/test/client-expanded.test.ts +333 -0
  621. package/sdk/typescript/test/client.test.ts +266 -0
  622. package/sdk/typescript/test/compress.test.ts +118 -0
  623. package/sdk/typescript/test/config.test.ts +275 -0
  624. package/sdk/typescript/test/errors.test.ts +169 -0
  625. package/sdk/typescript/test/format-integration.test.ts +252 -0
  626. package/sdk/typescript/test/hooks.test.ts +265 -0
  627. package/sdk/typescript/test/integration.test.ts +249 -0
  628. package/sdk/typescript/test/mdx-examples.test.ts +253 -0
  629. package/sdk/typescript/test/models.test.ts +318 -0
  630. package/sdk/typescript/test/parity.test.ts +337 -0
  631. package/sdk/typescript/test/paths.test.ts +447 -0
  632. package/sdk/typescript/test/shared-context.test.ts +245 -0
  633. package/sdk/typescript/test/simulate.test.ts +84 -0
  634. package/sdk/typescript/test/types.test.ts +244 -0
  635. package/sdk/typescript/test/utils/case.test.ts +129 -0
  636. package/sdk/typescript/test/utils/detect-format.test.ts +133 -0
  637. package/sdk/typescript/test/utils/format.test.ts +434 -0
  638. package/sdk/typescript/test/vercel-ai-e2e.test.ts +179 -0
  639. package/sdk/typescript/tsup.config.ts +17 -0
  640. package/tailwind.master.config.cjs +47 -0
  641. package/types/api.ts +12 -0
  642. package/types/config.ts +9 -0
  643. package/types/index.ts +2 -0
  644. package/uv.lock +6951 -0
  645. package/xithead.egg-info/PKG-INFO +22 -0
  646. package/xithead.egg-info/SOURCES.txt +16 -0
  647. package/xithead.egg-info/dependency_links.txt +1 -0
  648. package/xithead.egg-info/entry_points.txt +2 -0
  649. package/xithead.egg-info/requires.txt +10 -0
  650. package/xithead.egg-info/top_level.txt +2 -0
  651. package/xithead.ps1 +136 -0
  652. package/xithead.sh +129 -0
  653. package/xithead_dist/pyproject.toml +39 -0
  654. package/xithead_dist/xithead.egg-info/PKG-INFO +22 -0
  655. package/xithead_dist/xithead.egg-info/SOURCES.txt +16 -0
  656. package/xithead_dist/xithead.egg-info/dependency_links.txt +1 -0
  657. package/xithead_dist/xithead.egg-info/entry_points.txt +3 -0
  658. package/xithead_dist/xithead.egg-info/requires.txt +10 -0
  659. package/xithead_dist/xithead.egg-info/top_level.txt +2 -0
@@ -0,0 +1,505 @@
1
+ //! Per-auth-mode compression policy — Phase F PR-F2.1, extended in F2.2.
2
+ //!
3
+ //! F1 (`auth_mode.rs`) classifies each inbound request into one of
4
+ //! `{Payg, OAuth, Subscription}`. Phase F2.1 turns that classification
5
+ //! into a `CompressionPolicy` that downstream pipeline stages read to
6
+ //! decide whether they run. F2.2 extends the same struct with per-mode
7
+ //! tuning fields so the same call sites also read *how aggressively*
8
+ //! to run.
9
+ //!
10
+ //! Why a struct instead of `match auth_mode { ... }` everywhere?
11
+ //! Two reasons:
12
+ //!
13
+ //! 1. **Centralisation.** Without a policy struct, the per-mode
14
+ //! decision is duplicated at every gate (E3 cache_control, E4
15
+ //! prompt_cache_key, the new live-zone gate, the new cache_aligner
16
+ //! gate, …). When F2.2 wants to tune (e.g. allow OAuth users a
17
+ //! relaxed live-zone gate but stricter volatile-detector threshold)
18
+ //! we'd need to find every site. The struct is the one place to
19
+ //! edit; call sites just read `policy.field`.
20
+ //!
21
+ //! 2. **Test surface.** `for_mode(AuthMode) -> CompressionPolicy` is
22
+ //! pure and trivial to property-test. Asserting per-mode values
23
+ //! against the struct catches regressions cheaply, whereas asserting
24
+ //! end-to-end behaviour against the dispatcher requires a full
25
+ //! request fixture.
26
+ //!
27
+ //! ## Field semantics
28
+ //!
29
+ //! ### F2.1 fields (load-bearing for closing #327 / #388)
30
+ //!
31
+ //! - **`live_zone_only`**: when `true`, downstream stages MUST NOT
32
+ //! modify bytes outside the post-cache-marker live zone. Phase B's
33
+ //! Rust dispatcher is *already* live-zone-only by construction, so
34
+ //! this flag is effectively a no-op on the Rust path and exists for
35
+ //! the Python `TransformPipeline`'s `CacheAligner` / `ContentRouter`
36
+ //! gates. Storing it on the canonical struct keeps the cross-
37
+ //! language parity tests honest — Python and Rust must agree on the
38
+ //! field map even when only one side acts on a value.
39
+ //!
40
+ //! - **`cache_aligner_enabled`**: when `false`, the Python
41
+ //! `CacheAligner` transform's `should_apply` MUST return `False`.
42
+ //! `CacheAligner` is the load-bearing fix for the cache-instability
43
+ //! complaints — historically it has been mutating cached prefixes
44
+ //! and writing into `_previous_prefix_hash` per pipeline instance,
45
+ //! which is what destabilised Subscription users' prompt caches.
46
+ //! Disabling it for Subscription is the user-visible win of F2.1.
47
+ //!
48
+ //! ### F2.2 tuning fields (CONSERVATIVE defaults pending bake telemetry)
49
+ //!
50
+ //! - **`volatile_token_threshold`**: per-mode token-count threshold
51
+ //! below which content is treated as cache-stable (i.e. not flagged
52
+ //! as volatile). Subscription is conservative (low threshold → flag
53
+ //! more aggressively → keep prompts stable) while PAYG is aggressive
54
+ //! (higher threshold → tolerate more volatile noise before warning).
55
+ //! F2.1 had no such threshold; F2.2 introduces the field plumbed
56
+ //! through the struct so future detector code can pick it up. NOTE:
57
+ //! no current detector consumes this value — it lands plumbed-but-
58
+ //! unconsumed in F2.2 (intentional; the volatile detector in
59
+ //! `cache_aligner.py` is shape-based, not token-count-based, and
60
+ //! wiring it would force a detector refactor outside F2.2 scope).
61
+ //!
62
+ //! - **`max_lossy_ratio`**: per-mode upper bound on how aggressive
63
+ //! lossy compression can be, expressed as the fraction of original
64
+ //! tokens that may be dropped (`0.0` = no lossy compression allowed,
65
+ //! `1.0` = unlimited). Subscription is conservative (`0.25`) so cache
66
+ //! prefixes stay stable, PAYG aggressive (`0.45`). NOTE: no current
67
+ //! compressor consumes this value — it lands plumbed-but-unconsumed
68
+ //! in F2.2 (the `target_ratio` runtime kwarg in `content_router.py`
69
+ //! is a separate, caller-driven knob; wiring `max_lossy_ratio` as a
70
+ //! policy-driven cap is F2.2-followup once telemetry decides whether
71
+ //! to gate lossy paths or just observe them).
72
+ //!
73
+ //! - **`toin_read_only`**: when `true`, TOIN serves cached
74
+ //! recommendations but never *writes* new pattern observations from
75
+ //! this request. Subscription requests pay for prompt-cache stability,
76
+ //! so we don't want their compression events to mutate the global
77
+ //! learning pool — consistency over learning. PAYG/OAuth still write
78
+ //! so the network effect keeps growing.
79
+ //!
80
+ //! ## Per-mode F2.2 values (CONSERVATIVE; F2.2-followup will tune)
81
+ //!
82
+ //! | Mode | live_zone_only | cache_aligner_enabled | volatile_token_threshold | max_lossy_ratio | toin_read_only |
83
+ //! |--------------|----------------|-----------------------|--------------------------|-----------------|----------------|
84
+ //! | Payg | false | true | 128 | 0.45 | false |
85
+ //! | OAuth | false | true (= PAYG today) | 128 (= PAYG today) | 0.45 (= PAYG) | false (= PAYG) |
86
+ //! | Subscription | true | false | 32 | 0.25 | true |
87
+ //!
88
+ //! OAuth starts identical to PAYG. F2.2-followup will divide them once
89
+ //! telemetry from F2.1's bake on `main` shows what each mode actually
90
+ //! costs / saves.
91
+ //!
92
+ //! ## What this struct does NOT replace
93
+ //!
94
+ //! Phase E's existing PAYG-only gates (cache_control auto-placement,
95
+ //! prompt_cache_key injection) keep matching `auth_mode == Payg`
96
+ //! directly. Migrating those to the policy struct is F2.2 cleanup
97
+ //! work. Doing it in F2.1 would balloon the diff and the existing
98
+ //! gates already produce the correct per-mode behaviour — there's no
99
+ //! user-visible reason to refactor them now.
100
+
101
+ use crate::auth_mode::AuthMode;
102
+
103
+ // ── F2.2 per-mode default values (CONSERVATIVE pending bake telemetry) ──
104
+ // Centralised constants instead of inlining in the match arms so a
105
+ // follow-up tune lands in one place. Each constant is `pub(crate)` so
106
+ // the unit tests can assert against the same source of truth — if a
107
+ // caller drifts the per-mode value, the assertion fails.
108
+ //
109
+ // Per the realignment build constraints (project memory
110
+ // `feedback_realignment_build_constraints.md`): "configurable / no
111
+ // hardcoded values". The configuration *is* the per-mode default — we
112
+ // deliberately do NOT add a separate env var per field. Operators tune
113
+ // by editing these constants and shipping a new build, which is the
114
+ // same pattern the F2.1 fields use.
115
+
116
+ /// PAYG: aggressive — let volatile content noise up to ~128 tokens slip
117
+ /// before flagging. Higher than Subscription because PAYG users opt in
118
+ /// to aggressive compression.
119
+ pub(crate) const VOLATILE_TOKEN_THRESHOLD_PAYG: u32 = 128;
120
+
121
+ /// Subscription: conservative — flag volatile content earlier (32
122
+ /// tokens) so cache prefixes stay stable.
123
+ pub(crate) const VOLATILE_TOKEN_THRESHOLD_SUBSCRIPTION: u32 = 32;
124
+
125
+ /// PAYG: cap lossy compression at 45% of original tokens. Aggressive
126
+ /// but bounded — F2.1 had no cap (effectively `1.0`), F2.2 introduces
127
+ /// one.
128
+ pub(crate) const MAX_LOSSY_RATIO_PAYG: f32 = 0.45;
129
+
130
+ /// Subscription: conservative cap at 25%. Cache stability over savings.
131
+ pub(crate) const MAX_LOSSY_RATIO_SUBSCRIPTION: f32 = 0.25;
132
+
133
+ /// Anthropic prompt-cache write multiplier: a `cache_creation` token
134
+ /// costs 1.25× a plain input token (5-minute TTL tier). Input to the
135
+ /// net-cost mutation formula (#856).
136
+ pub const CACHE_WRITE_MULTIPLIER: f32 = 1.25;
137
+
138
+ /// Anthropic prompt-cache read multiplier: a `cache_read` token costs
139
+ /// 0.1× a plain input token. Input to the net-cost mutation formula
140
+ /// (#856).
141
+ pub const CACHE_READ_MULTIPLIER: f32 = 0.1;
142
+
143
+ /// Per-auth-mode policy that downstream compression stages consult.
144
+ ///
145
+ /// `Copy` because the struct is small POD (two `bool`s + a `u32` + an
146
+ /// `f32` + a `bool`) — passing by value is cheaper than passing a
147
+ /// reference and the call sites all want owned copies anyway.
148
+ #[derive(Debug, Clone, Copy, PartialEq)]
149
+ pub struct CompressionPolicy {
150
+ /// When `true`, transforms MUST NOT modify bytes outside the
151
+ /// post-cache-marker live zone. See module docs.
152
+ pub live_zone_only: bool,
153
+
154
+ /// When `false`, the `CacheAligner` transform MUST be skipped.
155
+ /// See module docs.
156
+ pub cache_aligner_enabled: bool,
157
+
158
+ /// F2.2: per-mode threshold (in tokens) below which content is
159
+ /// treated as cache-stable. Subscription is conservative
160
+ /// (`32`); PAYG aggressive (`128`). See module docs.
161
+ ///
162
+ /// NOT consumed by any detector in F2.2 — plumbed through the
163
+ /// struct so the volatile detector refactor in a follow-up PR
164
+ /// has a stable hook to read from.
165
+ pub volatile_token_threshold: u32,
166
+
167
+ /// F2.2: per-mode upper bound on lossy compression aggressiveness,
168
+ /// expressed as the fraction of original tokens that may be
169
+ /// dropped (`0.0`–`1.0`). Subscription `0.25`, PAYG `0.45`.
170
+ /// See module docs.
171
+ ///
172
+ /// NOT consumed by any compressor in F2.2 — plumbed through the
173
+ /// struct as a stable hook for a follow-up PR that gates lossy
174
+ /// paths on the cap. Distinct from the caller-driven
175
+ /// `target_ratio` kwarg in the Python ContentRouter.
176
+ pub max_lossy_ratio: f32,
177
+
178
+ /// F2.2: when `true`, TOIN serves cached recommendations but
179
+ /// never writes new pattern observations from this request.
180
+ /// Subscription `true` (consistency over learning), PAYG/OAuth
181
+ /// `false` (network effect keeps growing).
182
+ pub toin_read_only: bool,
183
+ }
184
+
185
+ // `f32` doesn't impl `Eq`, so the derived `Eq` would be invalid. Two
186
+ // `f32`s in this struct are never NaN by construction (we only set
187
+ // them from finite literal constants), so `PartialEq` is sufficient.
188
+ // The unit tests assert structural equality via `assert_eq!`.
189
+
190
+ impl CompressionPolicy {
191
+ /// Resolve the F2.1+F2.2 policy for an auth mode. See module docs
192
+ /// for per-mode rationale.
193
+ pub fn for_mode(mode: AuthMode) -> Self {
194
+ match mode {
195
+ AuthMode::Payg => Self {
196
+ live_zone_only: false,
197
+ cache_aligner_enabled: true,
198
+ volatile_token_threshold: VOLATILE_TOKEN_THRESHOLD_PAYG,
199
+ max_lossy_ratio: MAX_LOSSY_RATIO_PAYG,
200
+ toin_read_only: false,
201
+ },
202
+ // OAuth identical to PAYG in F2.1+F2.2. F2.2-followup may
203
+ // diverge once telemetry shows what OAuth users actually
204
+ // need.
205
+ AuthMode::OAuth => Self {
206
+ live_zone_only: false,
207
+ cache_aligner_enabled: true,
208
+ volatile_token_threshold: VOLATILE_TOKEN_THRESHOLD_PAYG,
209
+ max_lossy_ratio: MAX_LOSSY_RATIO_PAYG,
210
+ toin_read_only: false,
211
+ },
212
+ // The user-visible win of F2.1: subscription users stop
213
+ // seeing cache instability because CacheAligner no longer
214
+ // touches their prefix. F2.2 extends that protection: the
215
+ // volatile threshold is tighter, the lossy cap is lower,
216
+ // and TOIN won't mutate the learning pool from these
217
+ // requests.
218
+ AuthMode::Subscription => Self {
219
+ live_zone_only: true,
220
+ cache_aligner_enabled: false,
221
+ volatile_token_threshold: VOLATILE_TOKEN_THRESHOLD_SUBSCRIPTION,
222
+ max_lossy_ratio: MAX_LOSSY_RATIO_SUBSCRIPTION,
223
+ toin_read_only: true,
224
+ },
225
+ }
226
+ }
227
+
228
+ /// Whether the live-zone dispatcher should run at all for this
229
+ /// policy. Always `true` in F2.1 — every mode still gets live-zone
230
+ /// compression (closing #327/#388 requires Subscription to KEEP
231
+ /// compressing the live zone, just stop destabilising the cache).
232
+ /// F2.2 may flip Subscription to `false` if telemetry shows the
233
+ /// live-zone savings aren't worth the latency.
234
+ pub fn live_zone_compression_enabled(&self) -> bool {
235
+ true
236
+ }
237
+
238
+ /// Net gain (in plain-input-token cost units) of a mutation that
239
+ /// removes `delta_t` tokens from a message whose cached suffix is
240
+ /// `suffix_tokens` long (#856).
241
+ ///
242
+ /// Mutating message K invalidates every cached token after it. When
243
+ /// the cache is warm the mutated ΔT tokens are themselves already
244
+ /// cache-written, so keeping them costs only reads (`ΔT · r · R`)
245
+ /// while mutating re-writes the suffix: alive-case saving is
246
+ /// `ΔT·r·R − (w−r)·S`. When the cache is dead there is no suffix
247
+ /// penalty and the full `ΔT·(w + r·(R−1))` is saved. Taking the
248
+ /// expectation over `P_alive`:
249
+ ///
250
+ /// gain = ΔT · (w + r·(R − 1)) − P_alive · (w − r) · (S + ΔT)
251
+ ///
252
+ /// Sanity anchors (Anthropic w=1.25, r=0.1), matching the unit
253
+ /// tests below: a 2K shave under a 50K warm suffix needs 287.5
254
+ /// remaining reads to pay off (rarely profitable); a 50K shave
255
+ /// under a 10K suffix breaks even at 2.3 reads (profitable in any
256
+ /// session with a few turns left); an edit with S = 0 is profitable
257
+ /// whenever at least one read remains. Callers gating not-yet-cached
258
+ /// content (live-zone edits) should bypass this formula — it prices
259
+ /// mutations of content the cache has already written.
260
+ ///
261
+ /// Takes `&self` so a follow-up can apply per-mode margins; today
262
+ /// the arithmetic is mode-independent. Inputs are clamped:
263
+ /// `expected_reads` to `>= 0` (NaN → 0), `p_alive` to `[0, 1]`
264
+ /// (NaN → 1, the conservative full-penalty assumption).
265
+ pub fn net_mutation_gain(
266
+ &self,
267
+ delta_t: u32,
268
+ suffix_tokens: u32,
269
+ expected_reads: f32,
270
+ p_alive: f32,
271
+ ) -> f32 {
272
+ let w = CACHE_WRITE_MULTIPLIER;
273
+ let r = CACHE_READ_MULTIPLIER;
274
+ // f32::max ignores NaN (returns the other operand), so NaN reads
275
+ // land on 0.0; clamp would propagate NaN, so guard alive explicitly.
276
+ let reads = expected_reads.max(0.0);
277
+ let alive = if p_alive.is_nan() {
278
+ 1.0
279
+ } else {
280
+ p_alive.clamp(0.0, 1.0)
281
+ };
282
+ // Corrected warm-case penalty (#856 follow-up): when the cache is
283
+ // alive, the ΔT tokens are already cache-written, so keeping them
284
+ // costs only reads — a mutation can avoid at most ΔT·r·R, not a
285
+ // fresh write. Blending alive (ΔT·r·R − (w−r)·S) and dead
286
+ // (ΔT·(w + r·(R−1))) cases over P_alive gives a penalty over
287
+ // S + ΔT, not S alone. The looser ·S form overstated gain by
288
+ // P_alive·(w−r)·ΔT — always pro-mutation, largest for big shaves.
289
+ (delta_t as f32) * (w + r * (reads - 1.0))
290
+ - alive * (w - r) * ((suffix_tokens as f32) + (delta_t as f32))
291
+ }
292
+
293
+ /// Decision form of [`Self::net_mutation_gain`]: mutate iff the
294
+ /// gain is strictly positive.
295
+ pub fn should_mutate_deep(
296
+ &self,
297
+ delta_t: u32,
298
+ suffix_tokens: u32,
299
+ expected_reads: f32,
300
+ p_alive: f32,
301
+ ) -> bool {
302
+ self.net_mutation_gain(delta_t, suffix_tokens, expected_reads, p_alive) > 0.0
303
+ }
304
+
305
+ /// Remaining-read count at which a warm-cache (P_alive = 1)
306
+ /// mutation breaks even. With the corrected penalty this is exactly
307
+ ///
308
+ /// R = ((w − r) / r) · S/ΔT = 11.5 · S/ΔT (Anthropic 5-min)
309
+ ///
310
+ /// reproducing the #856 anchors precisely: 2K shave / 50K suffix →
311
+ /// 287.5 (~290 reads, rarely profitable); 50K shave / 10K suffix →
312
+ /// 2.3 (profitable in any session with a few turns left).
313
+ ///
314
+ /// Useful for decision telemetry ("this edit pays off if the
315
+ /// session lasts N more turns"). Returns 0 when `delta_t` is 0
316
+ /// (no savings — callers gate on `delta_t > 0`).
317
+ pub fn break_even_reads(&self, delta_t: u32, suffix_tokens: u32) -> f32 {
318
+ if delta_t == 0 {
319
+ return 0.0;
320
+ }
321
+ let w = CACHE_WRITE_MULTIPLIER;
322
+ let r = CACHE_READ_MULTIPLIER;
323
+ ((w - r) / r) * ((suffix_tokens as f32) / (delta_t as f32))
324
+ }
325
+ }
326
+
327
+ #[cfg(test)]
328
+ mod tests {
329
+ use super::*;
330
+
331
+ #[test]
332
+ fn payg_is_aggressive() {
333
+ let p = CompressionPolicy::for_mode(AuthMode::Payg);
334
+ assert!(!p.live_zone_only, "PAYG can touch outside live zone");
335
+ assert!(p.cache_aligner_enabled, "PAYG runs cache aligner");
336
+ assert!(p.live_zone_compression_enabled());
337
+ }
338
+
339
+ #[test]
340
+ fn payg_tuning_fields_aggressive() {
341
+ // F2.2: per-mode tuning fields. PAYG values are the aggressive
342
+ // end of the conservative-defaults spectrum — F2.2-followup may
343
+ // raise them once bake telemetry confirms savings.
344
+ let p = CompressionPolicy::for_mode(AuthMode::Payg);
345
+ assert_eq!(
346
+ p.volatile_token_threshold, 128,
347
+ "PAYG volatile threshold is the relaxed default; F2.2-followup will tune"
348
+ );
349
+ assert!(
350
+ (p.max_lossy_ratio - 0.45).abs() < f32::EPSILON,
351
+ "PAYG max_lossy_ratio caps lossy paths at 0.45; F2.2-followup will tune"
352
+ );
353
+ assert!(
354
+ !p.toin_read_only,
355
+ "PAYG keeps TOIN write-enabled — network effect feeds on PAYG traffic"
356
+ );
357
+ }
358
+
359
+ #[test]
360
+ fn oauth_matches_payg_today() {
361
+ // Canary: when F2.2-followup diverges OAuth from PAYG, this test
362
+ // fails and forces a deliberate update — which is the point.
363
+ // Covers ALL fields (F2.1 + F2.2) so a future field-level
364
+ // divergence (e.g. OAuth gets stricter `max_lossy_ratio` than
365
+ // PAYG) trips the assertion just as loudly as a flag flip.
366
+ let oauth = CompressionPolicy::for_mode(AuthMode::OAuth);
367
+ let payg = CompressionPolicy::for_mode(AuthMode::Payg);
368
+ assert_eq!(
369
+ oauth, payg,
370
+ "F2.1+F2.2 ship OAuth=PAYG; F2.2-followup will diverge based on telemetry"
371
+ );
372
+ }
373
+
374
+ #[test]
375
+ fn subscription_disables_cache_aligner() {
376
+ let p = CompressionPolicy::for_mode(AuthMode::Subscription);
377
+ assert!(p.live_zone_only, "Subscription is live-zone-only");
378
+ assert!(
379
+ !p.cache_aligner_enabled,
380
+ "Subscription MUST skip cache aligner — load-bearing for #327/#388"
381
+ );
382
+ assert!(
383
+ p.live_zone_compression_enabled(),
384
+ "Subscription still gets live-zone compression — closing the cache complaint must NOT mean shipping zero compression"
385
+ );
386
+ }
387
+
388
+ #[test]
389
+ fn subscription_tuning_fields_conservative() {
390
+ // F2.2: per-mode tuning fields. Subscription is the conservative
391
+ // end — tighter threshold, lower lossy cap, TOIN read-only — so
392
+ // cache prefixes stay stable and the learning pool isn't
393
+ // mutated from cache-stability-sensitive traffic.
394
+ let p = CompressionPolicy::for_mode(AuthMode::Subscription);
395
+ assert_eq!(
396
+ p.volatile_token_threshold, 32,
397
+ "Subscription volatile threshold flags content earlier (cache stability)"
398
+ );
399
+ assert!(
400
+ (p.max_lossy_ratio - 0.25).abs() < f32::EPSILON,
401
+ "Subscription max_lossy_ratio caps lossy paths at 0.25 (conservative)"
402
+ );
403
+ assert!(
404
+ p.toin_read_only,
405
+ "Subscription MUST be TOIN read-only — load-bearing for keeping the learning pool consistent across cache-sensitive traffic"
406
+ );
407
+ }
408
+
409
+ #[test]
410
+ fn max_lossy_ratio_in_unit_interval() {
411
+ // Defensive: every per-mode `max_lossy_ratio` MUST be in `[0.0,
412
+ // 1.0]` because it expresses a fraction. A tune that drifts
413
+ // outside the unit interval is a bug — catch it cheaply here
414
+ // rather than at the eventual consumer site.
415
+ for mode in [AuthMode::Payg, AuthMode::OAuth, AuthMode::Subscription] {
416
+ let r = CompressionPolicy::for_mode(mode).max_lossy_ratio;
417
+ assert!(
418
+ (0.0..=1.0).contains(&r),
419
+ "max_lossy_ratio for {mode:?} = {r} is outside [0.0, 1.0]"
420
+ );
421
+ }
422
+ }
423
+
424
+ // --- Net-cost mutation formula (#856). Scenario values are golden:
425
+ // tests/test_compression_policy.py asserts the identical numbers
426
+ // against the Python hand-mirror, so a drift in either side trips
427
+ // the parity pair loudly.
428
+
429
+ #[test]
430
+ fn net_gain_small_shave_deep_suffix_is_loss() {
431
+ // Shave 2K under a 50K warm suffix at R=10 remaining reads:
432
+ // 2000·(1.25 + 0.1·9) − 1.0·1.15·52000 = 4300 − 59800 = −55500.
433
+ let p = CompressionPolicy::for_mode(AuthMode::Payg);
434
+ let gain = p.net_mutation_gain(2_000, 50_000, 10.0, 1.0);
435
+ assert!((gain - (-55_500.0)).abs() < 1.0, "gain = {gain}");
436
+ assert!(!p.should_mutate_deep(2_000, 50_000, 10.0, 1.0));
437
+ }
438
+
439
+ #[test]
440
+ fn net_gain_big_shave_shallow_suffix_is_win() {
441
+ // Shave 50K under a 10K warm suffix at R=3:
442
+ // 50000·(1.25 + 0.1·2) − 1.0·1.15·60000 = 72500 − 69000 = 3500.
443
+ // Tight but positive — consistent with the 2.3-read break-even.
444
+ let p = CompressionPolicy::for_mode(AuthMode::Payg);
445
+ let gain = p.net_mutation_gain(50_000, 10_000, 3.0, 1.0);
446
+ assert!((gain - 3_500.0).abs() < 1.0, "gain = {gain}");
447
+ assert!(p.should_mutate_deep(50_000, 10_000, 3.0, 1.0));
448
+ }
449
+
450
+ #[test]
451
+ fn net_gain_no_suffix_edit_profitable_with_reads_remaining() {
452
+ // S = 0: nothing cached after the edit is invalidated. Warm-case
453
+ // saving is the avoided rereads, ΔT·r·R — positive whenever at
454
+ // least one read remains. At R=0 with a warm cache the gain is
455
+ // exactly 0 (already written, never read again): the boundary
456
+ // where mutating is pointless rather than harmful.
457
+ let p = CompressionPolicy::for_mode(AuthMode::Subscription);
458
+ assert!(p.should_mutate_deep(1, 0, 1.0, 1.0));
459
+ assert!(p.should_mutate_deep(2_000, 0, 1.0, 1.0));
460
+ let boundary = p.net_mutation_gain(2_000, 0, 0.0, 1.0);
461
+ assert!(boundary.abs() < f32::EPSILON, "boundary = {boundary}");
462
+ }
463
+
464
+ #[test]
465
+ fn net_gain_cold_cache_ignores_suffix() {
466
+ // P_alive = 0 (TTL lapsed): no warm suffix to lose, so even the
467
+ // worst shave/suffix ratio is profitable. This is the idle-timer
468
+ // compaction window.
469
+ let p = CompressionPolicy::for_mode(AuthMode::Payg);
470
+ assert!(p.should_mutate_deep(2_000, 50_000, 0.0, 0.0));
471
+ }
472
+
473
+ #[test]
474
+ fn net_gain_clamps_out_of_range_inputs() {
475
+ let p = CompressionPolicy::for_mode(AuthMode::Payg);
476
+ // Negative reads clamp to 0; p_alive > 1 clamps to 1.
477
+ let clamped = p.net_mutation_gain(2_000, 50_000, -5.0, 7.0);
478
+ let reference = p.net_mutation_gain(2_000, 50_000, 0.0, 1.0);
479
+ assert!((clamped - reference).abs() < f32::EPSILON);
480
+ }
481
+
482
+ #[test]
483
+ fn net_gain_guards_nan_inputs() {
484
+ // NaN reads → 0, NaN p_alive → 1: gain stays finite and matches
485
+ // the conservative reference instead of poisoning the decision.
486
+ let p = CompressionPolicy::for_mode(AuthMode::Payg);
487
+ let guarded = p.net_mutation_gain(2_000, 50_000, f32::NAN, f32::NAN);
488
+ assert!(guarded.is_finite());
489
+ let reference = p.net_mutation_gain(2_000, 50_000, 0.0, 1.0);
490
+ assert!((guarded - reference).abs() < f32::EPSILON);
491
+ }
492
+
493
+ #[test]
494
+ fn break_even_reads_matches_research_anchor() {
495
+ // R = 11.5·S/ΔT, the #856 anchors exactly: 2K shave / 50K
496
+ // suffix → 11.5·25 = 287.5 (rarely profitable); 50K shave /
497
+ // 10K suffix → 11.5·0.2 = 2.3 (profitable within a few turns).
498
+ let p = CompressionPolicy::for_mode(AuthMode::Payg);
499
+ let r = p.break_even_reads(2_000, 50_000);
500
+ assert!((r - 287.5).abs() < 0.5, "break-even = {r}");
501
+ let shallow = p.break_even_reads(50_000, 10_000);
502
+ assert!((shallow - 2.3).abs() < 0.05, "break-even = {shallow}");
503
+ assert_eq!(p.break_even_reads(0, 10_000), 0.0);
504
+ }
505
+ }
@@ -0,0 +1,33 @@
1
+ //! headroom-core: foundation crate for the Rust port of Headroom.
2
+
3
+ pub mod auth_mode;
4
+ pub mod cache_control;
5
+ pub mod ccr;
6
+ pub mod compression_policy;
7
+ pub mod relevance;
8
+ pub mod signals;
9
+ pub mod tokenizer;
10
+ pub mod transforms;
11
+
12
+ // Re-exports for the live-zone dispatcher (Phase B PR-B2 consumes this).
13
+ // Hoisted to the crate root so the proxy crate gets one stable import
14
+ // path: `use headroom_core::compute_frozen_count;`. Keeping the
15
+ // `cache_control` module public too means downstream code can reach
16
+ // the helper types directly when needed.
17
+ pub use cache_control::compute_frozen_count;
18
+
19
+ /// Identity stub used by downstream crates and the Python binding to verify
20
+ /// linkage end-to-end.
21
+ pub fn hello() -> &'static str {
22
+ "headroom-core"
23
+ }
24
+
25
+ #[cfg(test)]
26
+ mod tests {
27
+ use super::*;
28
+
29
+ #[test]
30
+ fn hello_returns_crate_name() {
31
+ assert_eq!(hello(), "headroom-core");
32
+ }
33
+ }
@@ -0,0 +1,139 @@
1
+ //! Base trait and types for relevance scoring.
2
+ //!
3
+ //! Direct port of `headroom/relevance/base.py`. The Python version uses
4
+ //! ABC + abstractmethod; we use a Rust trait with the same two
5
+ //! required methods. `default_batch_score` is provided as a free
6
+ //! function so concrete scorers without an optimized batch impl can
7
+ //! delegate to it.
8
+
9
+ /// Relevance score with explainability fields.
10
+ ///
11
+ /// Mirrors Python's `RelevanceScore` dataclass. The `__post_init__`
12
+ /// score-clamp is enforced via the `new` constructor.
13
+ #[derive(Debug, Clone)]
14
+ pub struct RelevanceScore {
15
+ pub score: f64,
16
+ pub reason: String,
17
+ pub matched_terms: Vec<String>,
18
+ }
19
+
20
+ impl RelevanceScore {
21
+ /// Build a score, clamping to `[0.0, 1.0]` to mirror Python's
22
+ /// `__post_init__` behavior.
23
+ pub fn new(score: f64, reason: impl Into<String>, matched_terms: Vec<String>) -> Self {
24
+ RelevanceScore {
25
+ score: score.clamp(0.0, 1.0),
26
+ reason: reason.into(),
27
+ matched_terms,
28
+ }
29
+ }
30
+
31
+ /// Convenience for "no match" scores.
32
+ pub fn empty(reason: impl Into<String>) -> Self {
33
+ RelevanceScore::new(0.0, reason, Vec::new())
34
+ }
35
+ }
36
+
37
+ impl Default for RelevanceScore {
38
+ fn default() -> Self {
39
+ RelevanceScore::new(0.0, "", Vec::new())
40
+ }
41
+ }
42
+
43
+ /// Trait that every relevance scorer implements.
44
+ ///
45
+ /// Mirrors Python's `RelevanceScorer` ABC: required `score` for single
46
+ /// items, required `score_batch` for collections (subclasses override
47
+ /// for vectorized impls; otherwise delegate to `default_batch_score`).
48
+ pub trait RelevanceScorer {
49
+ /// Score a single item against the context.
50
+ fn score(&self, item: &str, context: &str) -> RelevanceScore;
51
+
52
+ /// Score a batch of items. Default impl delegates to per-item
53
+ /// `score` — override when the scorer can amortize work across
54
+ /// items (BM25 pre-tokenizes context once, embeddings batch the
55
+ /// matrix multiplication, etc.).
56
+ fn score_batch(&self, items: &[&str], context: &str) -> Vec<RelevanceScore> {
57
+ items.iter().map(|item| self.score(item, context)).collect()
58
+ }
59
+
60
+ /// Whether this scorer is available in the current environment.
61
+ /// Override for scorers with optional deps (e.g. ONNX embeddings).
62
+ fn is_available(&self) -> bool {
63
+ true
64
+ }
65
+ }
66
+
67
+ /// Default batch implementation as a free function — convenient for
68
+ /// tests that want to verify the fall-back behavior without
69
+ /// constructing a trait object.
70
+ pub fn default_batch_score<S: RelevanceScorer>(
71
+ scorer: &S,
72
+ items: &[&str],
73
+ context: &str,
74
+ ) -> Vec<RelevanceScore> {
75
+ items
76
+ .iter()
77
+ .map(|item| scorer.score(item, context))
78
+ .collect()
79
+ }
80
+
81
+ #[cfg(test)]
82
+ mod tests {
83
+ use super::*;
84
+
85
+ #[test]
86
+ fn relevance_score_clamps_above_one() {
87
+ let s = RelevanceScore::new(1.5, "", Vec::new());
88
+ assert_eq!(s.score, 1.0);
89
+ }
90
+
91
+ #[test]
92
+ fn relevance_score_clamps_below_zero() {
93
+ let s = RelevanceScore::new(-0.5, "", Vec::new());
94
+ assert_eq!(s.score, 0.0);
95
+ }
96
+
97
+ #[test]
98
+ fn relevance_score_passes_through_valid_range() {
99
+ let s = RelevanceScore::new(0.5, "test", vec!["term".to_string()]);
100
+ assert_eq!(s.score, 0.5);
101
+ assert_eq!(s.reason, "test");
102
+ assert_eq!(s.matched_terms, vec!["term"]);
103
+ }
104
+
105
+ #[test]
106
+ fn empty_score_zero_with_reason() {
107
+ let s = RelevanceScore::empty("no match");
108
+ assert_eq!(s.score, 0.0);
109
+ assert_eq!(s.reason, "no match");
110
+ assert!(s.matched_terms.is_empty());
111
+ }
112
+
113
+ // Trivial scorer to test the default batch fallback.
114
+ struct StubScorer;
115
+ impl RelevanceScorer for StubScorer {
116
+ fn score(&self, _item: &str, _context: &str) -> RelevanceScore {
117
+ RelevanceScore::new(0.42, "stub", Vec::new())
118
+ }
119
+ }
120
+
121
+ #[test]
122
+ fn default_batch_calls_score_per_item() {
123
+ let scorer = StubScorer;
124
+ let items = ["a", "b", "c"];
125
+ let scores = default_batch_score(&scorer, &items, "ctx");
126
+ assert_eq!(scores.len(), 3);
127
+ for s in scores {
128
+ assert_eq!(s.score, 0.42);
129
+ }
130
+ }
131
+
132
+ #[test]
133
+ fn trait_default_batch_uses_per_item_score() {
134
+ let scorer = StubScorer;
135
+ let items = ["x", "y"];
136
+ let scores = scorer.score_batch(&items, "ctx");
137
+ assert_eq!(scores.len(), 2);
138
+ }
139
+ }