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,61 @@
1
+ //! Phase E cache-stabilization surface.
2
+ //!
3
+ //! The realignment plan (`REALIGNMENT/07-phase-E-cache-stabilization.md`)
4
+ //! groups every cache-stabilization mechanism behind one module so
5
+ //! operators searching for "what does Headroom do to keep prompt
6
+ //! caches warm" land in one place. Phase E PRs in this module either:
7
+ //!
8
+ //! - **Observe** inbound bodies and emit structured warnings so
9
+ //! customers can see why their prompt-cache hit rate is degrading
10
+ //! ([`volatile_detector`], PR-E5; [`drift_detector`], PR-E6). These
11
+ //! never mutate request bytes.
12
+ //! - **Normalize** request bytes to make cache hits deterministic
13
+ //! under PAYG mode ([`tool_def_normalize`], PR-E1 / PR-E2;
14
+ //! [`anthropic_cache_control`], PR-E3; [`openai_cache_key`], PR-E4).
15
+ //! These mutate bytes only when the auth-mode gate and per-policy
16
+ //! preconditions (e.g. no customer `cache_control` marker) all clear;
17
+ //! OAuth and Subscription always passthrough.
18
+ //!
19
+ //! Currently shipped:
20
+ //!
21
+ //! - [`volatile_detector`] — PR-E5: scans inbound bodies for patterns
22
+ //! that bust prompt-cache hits (ISO 8601 timestamps, UUID v4s,
23
+ //! ID-named fields) and emits one structured WARN log per finding
24
+ //! so customers know what to move out of the cached prefix.
25
+ //! - [`drift_detector`] — PR-E6: per-session SHA-256 fingerprint of
26
+ //! the cache hot zone (system / tools / early messages). Emits
27
+ //! `cache_drift_first_request` on first sight and
28
+ //! `cache_drift_observed` when consecutive requests on the same
29
+ //! session disagree on any of the three dimensions.
30
+ //! - [`tool_def_normalize`] — PR-E1 / PR-E2: sorts `tools[]`
31
+ //! alphabetically by name (PR-E1) and recursively sorts JSON
32
+ //! Schema object keys inside each tool's `input_schema` /
33
+ //! `function.parameters` (PR-E2). PAYG-only. PR-E1 additionally
34
+ //! skips when any tool already carries a top-level
35
+ //! `cache_control` marker; PR-E2 has no marker check because
36
+ //! sorting schema keys never moves the marker (which lives on
37
+ //! the tool object, not inside the schema).
38
+ //! - [`anthropic_cache_control`] — PR-E3: on PAYG-classified
39
+ //! requests where the customer hasn't placed any `cache_control`
40
+ //! marker, auto-inserts one ephemeral marker on the last tool
41
+ //! definition so unsophisticated callers (hand-rolled SDK code,
42
+ //! smaller agents, plain `curl`) get prompt-cache hits without
43
+ //! learning Anthropic's marker API. **Mutates request bytes**;
44
+ //! gated on auth_mode == PAYG and the absence of any pre-existing
45
+ //! marker.
46
+ //! - [`openai_cache_key`] — PR-E4: on PAYG OpenAI requests where the
47
+ //! customer has not set `prompt_cache_key`, derive a stable key from
48
+ //! `(model, system, tools)` and inject it so the upstream pins
49
+ //! cache lookup to a tenant-stable identity. **Mutates the body**
50
+ //! (only on PAYG) — see its docs for the gating contract.
51
+ //!
52
+ //! Sibling PRs hang additional submodules off this `mod.rs`. Conflict
53
+ //! resolution between parallel Phase E PRs is intentionally trivial:
54
+ //! each lives in its own file, the only shared surface is this
55
+ //! `mod.rs`'s `pub mod` list.
56
+
57
+ pub mod anthropic_cache_control;
58
+ pub mod drift_detector;
59
+ pub mod openai_cache_key;
60
+ pub mod tool_def_normalize;
61
+ pub mod volatile_detector;
@@ -0,0 +1,600 @@
1
+ //! PR-E4: OpenAI `prompt_cache_key` auto-injection.
2
+ //!
3
+ //! OpenAI's prefix caching is automatic since late 2024 — the API
4
+ //! caches prefix tokens server-side without client opt-in. The
5
+ //! `prompt_cache_key` field, however, is the field a client passes
6
+ //! to **pin cache lookup** to a stable identity. Without it,
7
+ //! OpenAI falls back to org-wide cache lookups that may collide
8
+ //! with other tenants. Most clients don't set the field because
9
+ //! they don't know it exists. This module derives a deterministic
10
+ //! key from the request's *structural* prefix (model + system +
11
+ //! tools) and injects it on PAYG requests where the customer has
12
+ //! not already provided one.
13
+ //!
14
+ //! # Universal safety contract
15
+ //!
16
+ //! This module mutates request bytes — that is the whole point.
17
+ //! Mutating bytes for non-PAYG auth modes risks looking like
18
+ //! cache-evasion to the upstream and would void OAuth scope; the
19
+ //! caller MUST gate on `AuthMode::Payg` before calling
20
+ //! [`inject_prompt_cache_key`]. The function itself does NOT
21
+ //! re-classify auth mode: that is the caller's responsibility,
22
+ //! consistent with PR-E3's `cache_control` placement which gates
23
+ //! the same way at the dispatch site.
24
+ //!
25
+ //! # Skip rules (this module enforces these directly)
26
+ //!
27
+ //! - **Already present**: if `body.prompt_cache_key` exists at the
28
+ //! top level and is a non-empty string, return
29
+ //! [`InjectOutcome::Skipped`] with reason
30
+ //! [`SkipReason::KeyPresent`]. The customer's value wins.
31
+ //! - **Idempotency**: re-running on a body that already has *our*
32
+ //! injected key returns [`SkipReason::KeyPresent`] (we don't
33
+ //! distinguish ours from theirs — both mean "leave alone").
34
+ //!
35
+ //! # Key derivation
36
+ //!
37
+ //! Inputs to the hash, in order:
38
+ //!
39
+ //! 1. `body.model` (string) — different model = different cache
40
+ //! universe.
41
+ //! 2. SHA-256 of canonical-JSON bytes of the system content.
42
+ //! For Chat Completions, this is the first message with
43
+ //! `role == "system"`. For Responses, this is the
44
+ //! `instructions` field if present, else the first
45
+ //! `role == "system"` item.
46
+ //! 3. SHA-256 of canonical-JSON bytes of `body.tools`.
47
+ //!
48
+ //! User and assistant messages are **deliberately excluded** —
49
+ //! including them would defeat the purpose by producing a
50
+ //! different key on every turn.
51
+ //!
52
+ //! Combined: `key = hex(sha256(model || system_hash ||
53
+ //! tools_hash))[..32]` — 128 bits of collision resistance, 32
54
+ //! hex chars on the wire, compact in logs.
55
+
56
+ use serde_json::Value;
57
+ use sha2::{Digest, Sha256};
58
+
59
+ /// Length of the injected key in hex characters. 32 hex chars =
60
+ /// 128 bits, plenty of collision resistance for per-tenant cache
61
+ /// pinning, while staying compact on the wire and in logs.
62
+ pub const KEY_HEX_LEN: usize = 32;
63
+
64
+ /// First-N chars of the key surfaced in `tracing` events. **Never**
65
+ /// log the full key — it is identifying material for cache pinning
66
+ /// and operators do not need the suffix to debug.
67
+ pub const KEY_PREFIX_LOG_LEN: usize = 8;
68
+
69
+ /// Which OpenAI request shape the body conforms to. The shape
70
+ /// affects only where the system content lives:
71
+ ///
72
+ /// - [`OpenAiShape::ChatCompletions`]: first `messages[*]` with
73
+ /// `role == "system"`.
74
+ /// - [`OpenAiShape::Responses`]: top-level `instructions` field,
75
+ /// else first `input[*]` (or `messages[*]`) with
76
+ /// `role == "system"`.
77
+ ///
78
+ /// `tools` lives at the top level in both shapes.
79
+ #[derive(Debug, Clone, Copy, PartialEq, Eq)]
80
+ pub enum OpenAiShape {
81
+ /// `POST /v1/chat/completions`.
82
+ ChatCompletions,
83
+ /// `POST /v1/responses`.
84
+ Responses,
85
+ }
86
+
87
+ /// Why the injector skipped a body.
88
+ #[derive(Debug, Clone, Copy, PartialEq, Eq)]
89
+ pub enum SkipReason {
90
+ /// The body is not a JSON object (the dispatcher should have
91
+ /// gated this earlier; we surface it as a skip rather than
92
+ /// panicking so the proxy stays a transparent forwarder for
93
+ /// pathological inputs).
94
+ NotAnObject,
95
+ /// `body.prompt_cache_key` is already a non-empty string.
96
+ /// Customer-set values win.
97
+ KeyPresent,
98
+ }
99
+
100
+ impl SkipReason {
101
+ /// Stable string for structured-log fields. Dashboards filter
102
+ /// on this; do not change without a deprecation note.
103
+ pub fn as_str(self) -> &'static str {
104
+ match self {
105
+ SkipReason::NotAnObject => "not_an_object",
106
+ SkipReason::KeyPresent => "key_present",
107
+ }
108
+ }
109
+ }
110
+
111
+ /// Outcome of an injection attempt.
112
+ #[derive(Debug, Clone, PartialEq, Eq)]
113
+ pub enum InjectOutcome {
114
+ /// We added a `prompt_cache_key` to the body. The first
115
+ /// [`KEY_PREFIX_LOG_LEN`] hex chars of the key, suitable for
116
+ /// logs. The full key is in the body — never log it.
117
+ Applied { key_prefix: String },
118
+ /// We left the body unchanged. See [`SkipReason`] for why.
119
+ Skipped { reason: SkipReason },
120
+ }
121
+
122
+ /// Top-level field check.
123
+ ///
124
+ /// Returns `true` if `body.prompt_cache_key` is a non-empty
125
+ /// string. Empty strings count as "absent" because some SDKs
126
+ /// default the field to `""` when the user did not set it.
127
+ pub fn has_prompt_cache_key(body: &Value) -> bool {
128
+ body.get("prompt_cache_key")
129
+ .and_then(Value::as_str)
130
+ .map(|s| !s.is_empty())
131
+ .unwrap_or(false)
132
+ }
133
+
134
+ /// Inject a `prompt_cache_key` into `body` if appropriate.
135
+ ///
136
+ /// **Caller MUST gate on `AuthMode::Payg`.** This function does not
137
+ /// re-classify auth mode — same contract as PR-E3
138
+ /// `cache_control` placement.
139
+ ///
140
+ /// Returns:
141
+ /// - [`InjectOutcome::Applied`] when the key is set;
142
+ /// `body["prompt_cache_key"]` is now a 32-hex-char string.
143
+ /// - [`InjectOutcome::Skipped`] when the body is not a JSON
144
+ /// object, or already has a non-empty `prompt_cache_key`.
145
+ ///
146
+ /// This function is **deterministic**: the same `(model, system,
147
+ /// tools)` triple always produces the same key, so re-running on a
148
+ /// body whose injected key was stripped yields the same key
149
+ /// (idempotency property the test suite pins).
150
+ pub fn inject_prompt_cache_key(body: &mut Value, shape: OpenAiShape) -> InjectOutcome {
151
+ // Guardrail: top-level must be an object. Anything else (array,
152
+ // string, null) is malformed for our hook point; the dispatcher
153
+ // already gates on `messages` / `input` being arrays, so this
154
+ // path is essentially unreachable but we surface it explicitly
155
+ // rather than panicking.
156
+ if !body.is_object() {
157
+ return InjectOutcome::Skipped {
158
+ reason: SkipReason::NotAnObject,
159
+ };
160
+ }
161
+
162
+ if has_prompt_cache_key(body) {
163
+ return InjectOutcome::Skipped {
164
+ reason: SkipReason::KeyPresent,
165
+ };
166
+ }
167
+
168
+ let key = derive_key(body, shape);
169
+ let key_prefix = key[..KEY_PREFIX_LOG_LEN.min(key.len())].to_string();
170
+
171
+ // Safe: we just verified `body.is_object()` above.
172
+ if let Some(map) = body.as_object_mut() {
173
+ map.insert("prompt_cache_key".to_string(), Value::String(key));
174
+ }
175
+
176
+ InjectOutcome::Applied { key_prefix }
177
+ }
178
+
179
+ /// Derive the cache key from the structural prefix of the body.
180
+ ///
181
+ /// Hash inputs (concatenated, length-prefixed to avoid ambiguity
182
+ /// between e.g. `model="ab", system="c"` vs `model="a", system="bc"`):
183
+ ///
184
+ /// 1. ASCII bytes of the model field (empty if missing).
185
+ /// 2. SHA-256 of canonical-JSON bytes of the system content.
186
+ /// 3. SHA-256 of canonical-JSON bytes of the tools field.
187
+ ///
188
+ /// Length-prefixing is critical: without it, two different
189
+ /// (model, system) splits could collide. We use a single `0x00`
190
+ /// byte separator instead of an explicit u32 length because
191
+ /// `0x00` cannot appear in a UTF-8 model name or a hex digest;
192
+ /// the separator unambiguously delimits the three inputs.
193
+ fn derive_key(body: &Value, shape: OpenAiShape) -> String {
194
+ let model = body
195
+ .get("model")
196
+ .and_then(Value::as_str)
197
+ .unwrap_or_default();
198
+
199
+ let system_value = extract_system(body, shape);
200
+ let system_hash = canonical_sha256(&system_value);
201
+
202
+ let tools_value = body.get("tools").cloned().unwrap_or(Value::Null);
203
+ let tools_hash = canonical_sha256(&tools_value);
204
+
205
+ let mut hasher = Sha256::new();
206
+ hasher.update(model.as_bytes());
207
+ hasher.update([0u8]);
208
+ hasher.update(system_hash.as_bytes());
209
+ hasher.update([0u8]);
210
+ hasher.update(tools_hash.as_bytes());
211
+ let digest = hasher.finalize();
212
+
213
+ // 16 bytes = 32 hex chars. We hex-encode by hand to avoid
214
+ // pulling in `hex` for one call site.
215
+ let mut out = String::with_capacity(KEY_HEX_LEN);
216
+ for byte in digest.iter().take(KEY_HEX_LEN / 2) {
217
+ use std::fmt::Write as _;
218
+ let _ = write!(&mut out, "{byte:02x}");
219
+ }
220
+ out
221
+ }
222
+
223
+ /// Locate the system content for the given shape, returning the
224
+ /// JSON value (possibly `Null`) we will hash. We hash the JSON
225
+ /// value (not its serialized bytes alone) so that
226
+ /// content-block-array systems and string systems with the same
227
+ /// concatenated text produce *different* keys — which is the
228
+ /// correct behaviour for cache pinning.
229
+ fn extract_system(body: &Value, shape: OpenAiShape) -> Value {
230
+ match shape {
231
+ OpenAiShape::ChatCompletions => first_system_message_content(body, "messages"),
232
+ OpenAiShape::Responses => {
233
+ // Responses canonical: top-level `instructions`.
234
+ // Legacy alias: a system message in `input` (or `messages`).
235
+ if let Some(instructions) = body.get("instructions") {
236
+ return instructions.clone();
237
+ }
238
+ if let Some(v) = body.get("input") {
239
+ if let Some(content) = first_system_in_array(v) {
240
+ return content;
241
+ }
242
+ }
243
+ first_system_message_content(body, "messages")
244
+ }
245
+ }
246
+ }
247
+
248
+ /// First `messages[*]` (under the given key) with `role == "system"` —
249
+ /// returns the message's `content` field, or `Null` if none found.
250
+ fn first_system_message_content(body: &Value, key: &str) -> Value {
251
+ body.get(key)
252
+ .and_then(first_system_in_array)
253
+ .unwrap_or(Value::Null)
254
+ }
255
+
256
+ fn first_system_in_array(arr: &Value) -> Option<Value> {
257
+ let items = arr.as_array()?;
258
+ for item in items {
259
+ if item.get("role").and_then(Value::as_str) == Some("system") {
260
+ return item.get("content").cloned().or(Some(Value::Null));
261
+ }
262
+ }
263
+ None
264
+ }
265
+
266
+ /// SHA-256 of canonical-JSON bytes of `v`, hex-encoded.
267
+ ///
268
+ /// We use `serde_json::to_vec` rather than `to_string` to avoid an
269
+ /// unnecessary UTF-8 validation pass; `serde_json` always emits
270
+ /// valid UTF-8 anyway. Object keys are emitted in insertion order
271
+ /// (workspace `serde_json` is built with `preserve_order`), which
272
+ /// is acceptable here because the **same** request body always
273
+ /// hashes the **same** way — and that is the only invariant we
274
+ /// require for stable cache pinning.
275
+ fn canonical_sha256(v: &Value) -> String {
276
+ let bytes = serde_json::to_vec(v).unwrap_or_default();
277
+ let digest = Sha256::digest(&bytes);
278
+ let mut out = String::with_capacity(64);
279
+ for byte in digest.iter() {
280
+ use std::fmt::Write as _;
281
+ let _ = write!(&mut out, "{byte:02x}");
282
+ }
283
+ out
284
+ }
285
+
286
+ #[cfg(test)]
287
+ mod tests {
288
+ use super::*;
289
+ use serde_json::json;
290
+
291
+ fn is_hex(s: &str) -> bool {
292
+ s.bytes().all(|b| b.is_ascii_hexdigit())
293
+ }
294
+
295
+ fn injected_key(body: &Value) -> String {
296
+ body.get("prompt_cache_key")
297
+ .and_then(Value::as_str)
298
+ .expect("prompt_cache_key must be a string")
299
+ .to_string()
300
+ }
301
+
302
+ #[test]
303
+ fn injects_key_when_payg_and_absent() {
304
+ let mut body = json!({
305
+ "model": "gpt-4o",
306
+ "messages": [
307
+ {"role": "system", "content": "You are a helpful assistant."},
308
+ {"role": "user", "content": "Hello"}
309
+ ],
310
+ });
311
+ let outcome = inject_prompt_cache_key(&mut body, OpenAiShape::ChatCompletions);
312
+ match outcome {
313
+ InjectOutcome::Applied { key_prefix } => {
314
+ assert_eq!(key_prefix.len(), KEY_PREFIX_LOG_LEN);
315
+ assert!(is_hex(&key_prefix));
316
+ }
317
+ other => panic!("expected Applied, got {other:?}"),
318
+ }
319
+ let key = injected_key(&body);
320
+ assert_eq!(key.len(), KEY_HEX_LEN);
321
+ assert!(is_hex(&key), "key must be hex: {key}");
322
+ }
323
+
324
+ #[test]
325
+ fn injects_key_when_payg_and_absent_responses() {
326
+ let mut body = json!({
327
+ "model": "gpt-4o",
328
+ "instructions": "You are a helpful assistant.",
329
+ "input": [{"role": "user", "content": "Hello"}],
330
+ });
331
+ let outcome = inject_prompt_cache_key(&mut body, OpenAiShape::Responses);
332
+ assert!(matches!(outcome, InjectOutcome::Applied { .. }));
333
+ let key = injected_key(&body);
334
+ assert_eq!(key.len(), KEY_HEX_LEN);
335
+ assert!(is_hex(&key));
336
+ }
337
+
338
+ #[test]
339
+ fn skips_when_key_already_set() {
340
+ let original = json!({
341
+ "model": "gpt-4o",
342
+ "prompt_cache_key": "user-pinned",
343
+ "messages": [
344
+ {"role": "system", "content": "You are a helpful assistant."},
345
+ {"role": "user", "content": "Hello"}
346
+ ],
347
+ });
348
+ let mut body = original.clone();
349
+ let outcome = inject_prompt_cache_key(&mut body, OpenAiShape::ChatCompletions);
350
+ assert_eq!(
351
+ outcome,
352
+ InjectOutcome::Skipped {
353
+ reason: SkipReason::KeyPresent,
354
+ }
355
+ );
356
+ assert_eq!(body, original, "body must be unchanged when key is present");
357
+ }
358
+
359
+ #[test]
360
+ fn skips_when_key_already_set_responses() {
361
+ let original = json!({
362
+ "model": "gpt-4o",
363
+ "prompt_cache_key": "user-pinned-2",
364
+ "instructions": "Be concise.",
365
+ "input": [{"role": "user", "content": "Hello"}],
366
+ });
367
+ let mut body = original.clone();
368
+ let outcome = inject_prompt_cache_key(&mut body, OpenAiShape::Responses);
369
+ assert!(matches!(
370
+ outcome,
371
+ InjectOutcome::Skipped {
372
+ reason: SkipReason::KeyPresent
373
+ }
374
+ ));
375
+ assert_eq!(body, original);
376
+ }
377
+
378
+ #[test]
379
+ fn skips_when_body_is_not_an_object() {
380
+ let mut body = json!(["not", "an", "object"]);
381
+ let outcome = inject_prompt_cache_key(&mut body, OpenAiShape::ChatCompletions);
382
+ assert_eq!(
383
+ outcome,
384
+ InjectOutcome::Skipped {
385
+ reason: SkipReason::NotAnObject,
386
+ }
387
+ );
388
+ }
389
+
390
+ #[test]
391
+ fn empty_string_key_treated_as_absent() {
392
+ // Some SDKs default the field to "" when the user did not
393
+ // set it. We treat that as absent and inject anyway.
394
+ let mut body = json!({
395
+ "model": "gpt-4o",
396
+ "prompt_cache_key": "",
397
+ "messages": [
398
+ {"role": "system", "content": "You are a helpful assistant."},
399
+ {"role": "user", "content": "Hello"}
400
+ ],
401
+ });
402
+ let outcome = inject_prompt_cache_key(&mut body, OpenAiShape::ChatCompletions);
403
+ assert!(matches!(outcome, InjectOutcome::Applied { .. }));
404
+ let key = injected_key(&body);
405
+ assert_eq!(key.len(), KEY_HEX_LEN);
406
+ }
407
+
408
+ #[test]
409
+ fn idempotent_same_inputs_same_key() {
410
+ // Re-running on a body whose injected key was stripped
411
+ // (e.g. customer-side scrub) must yield the same key.
412
+ let template = || {
413
+ json!({
414
+ "model": "gpt-4o",
415
+ "messages": [
416
+ {"role": "system", "content": "You are a helpful assistant."},
417
+ {"role": "user", "content": "first turn"}
418
+ ],
419
+ "tools": [
420
+ {"type": "function", "function": {"name": "search"}}
421
+ ]
422
+ })
423
+ };
424
+ let mut body1 = template();
425
+ let _ = inject_prompt_cache_key(&mut body1, OpenAiShape::ChatCompletions);
426
+ let key1 = injected_key(&body1);
427
+
428
+ let mut body2 = template();
429
+ let _ = inject_prompt_cache_key(&mut body2, OpenAiShape::ChatCompletions);
430
+ let key2 = injected_key(&body2);
431
+
432
+ assert_eq!(key1, key2);
433
+ }
434
+
435
+ #[test]
436
+ fn different_model_yields_different_key() {
437
+ let mut a = json!({
438
+ "model": "gpt-4o",
439
+ "messages": [{"role": "system", "content": "S"}, {"role": "user", "content": "u"}],
440
+ });
441
+ let mut b = json!({
442
+ "model": "gpt-4o-mini",
443
+ "messages": [{"role": "system", "content": "S"}, {"role": "user", "content": "u"}],
444
+ });
445
+ let _ = inject_prompt_cache_key(&mut a, OpenAiShape::ChatCompletions);
446
+ let _ = inject_prompt_cache_key(&mut b, OpenAiShape::ChatCompletions);
447
+ assert_ne!(injected_key(&a), injected_key(&b));
448
+ }
449
+
450
+ #[test]
451
+ fn different_system_yields_different_key() {
452
+ let mut a = json!({
453
+ "model": "gpt-4o",
454
+ "messages": [{"role": "system", "content": "system A"}, {"role": "user", "content": "u"}],
455
+ });
456
+ let mut b = json!({
457
+ "model": "gpt-4o",
458
+ "messages": [{"role": "system", "content": "system B"}, {"role": "user", "content": "u"}],
459
+ });
460
+ let _ = inject_prompt_cache_key(&mut a, OpenAiShape::ChatCompletions);
461
+ let _ = inject_prompt_cache_key(&mut b, OpenAiShape::ChatCompletions);
462
+ assert_ne!(injected_key(&a), injected_key(&b));
463
+ }
464
+
465
+ #[test]
466
+ fn different_tools_yields_different_key() {
467
+ let mut a = json!({
468
+ "model": "gpt-4o",
469
+ "messages": [{"role": "system", "content": "S"}, {"role": "user", "content": "u"}],
470
+ "tools": [{"type": "function", "function": {"name": "search"}}],
471
+ });
472
+ let mut b = json!({
473
+ "model": "gpt-4o",
474
+ "messages": [{"role": "system", "content": "S"}, {"role": "user", "content": "u"}],
475
+ "tools": [{"type": "function", "function": {"name": "lookup"}}],
476
+ });
477
+ let _ = inject_prompt_cache_key(&mut a, OpenAiShape::ChatCompletions);
478
+ let _ = inject_prompt_cache_key(&mut b, OpenAiShape::ChatCompletions);
479
+ assert_ne!(injected_key(&a), injected_key(&b));
480
+ }
481
+
482
+ #[test]
483
+ fn same_user_messages_different_system_yields_different_key() {
484
+ // Confirms user content is NOT in the hash by holding user
485
+ // content fixed and varying only the system. If user
486
+ // content were hashed, this could still differ — but the
487
+ // companion test below pins the inverse direction.
488
+ let user = json!({"role": "user", "content": "what is 2+2?"});
489
+ let mut a = json!({
490
+ "model": "gpt-4o",
491
+ "messages": [{"role": "system", "content": "concise"}, user.clone()],
492
+ });
493
+ let mut b = json!({
494
+ "model": "gpt-4o",
495
+ "messages": [{"role": "system", "content": "verbose"}, user],
496
+ });
497
+ let _ = inject_prompt_cache_key(&mut a, OpenAiShape::ChatCompletions);
498
+ let _ = inject_prompt_cache_key(&mut b, OpenAiShape::ChatCompletions);
499
+ assert_ne!(injected_key(&a), injected_key(&b));
500
+ }
501
+
502
+ #[test]
503
+ fn same_system_different_user_messages_yields_same_key() {
504
+ // The crucial property: user/assistant turns vary across
505
+ // requests, but the cache key must STAY CONSTANT so OpenAI
506
+ // can pin the cache lookup to the same identity.
507
+ let mut a = json!({
508
+ "model": "gpt-4o",
509
+ "messages": [
510
+ {"role": "system", "content": "You are concise."},
511
+ {"role": "user", "content": "first question"}
512
+ ],
513
+ });
514
+ let mut b = json!({
515
+ "model": "gpt-4o",
516
+ "messages": [
517
+ {"role": "system", "content": "You are concise."},
518
+ {"role": "user", "content": "second question, much longer than the first"},
519
+ {"role": "assistant", "content": "ok"},
520
+ {"role": "user", "content": "third question"}
521
+ ],
522
+ });
523
+ let _ = inject_prompt_cache_key(&mut a, OpenAiShape::ChatCompletions);
524
+ let _ = inject_prompt_cache_key(&mut b, OpenAiShape::ChatCompletions);
525
+ assert_eq!(
526
+ injected_key(&a),
527
+ injected_key(&b),
528
+ "user/assistant turn variation must not change the cache key"
529
+ );
530
+ }
531
+
532
+ #[test]
533
+ fn key_length_is_exactly_32_hex_chars() {
534
+ // Property test: across many input shapes the key is
535
+ // always exactly 32 hex chars.
536
+ let inputs = [
537
+ json!({"model": "gpt-4o", "messages": []}),
538
+ json!({"model": "gpt-4o-2024-08-06", "messages": [{"role": "system", "content": "abc"}]}),
539
+ json!({"model": "o1-mini", "messages": [{"role": "system", "content": ["array", "content"]}]}),
540
+ json!({"model": "", "messages": [{"role": "user", "content": "no system"}]}),
541
+ json!({"model": "gpt-4o", "instructions": "responses style"}),
542
+ ];
543
+ for (i, base) in inputs.iter().enumerate() {
544
+ let mut body = base.clone();
545
+ let outcome = inject_prompt_cache_key(&mut body, OpenAiShape::ChatCompletions);
546
+ assert!(
547
+ matches!(outcome, InjectOutcome::Applied { .. }),
548
+ "input {i}: expected Applied"
549
+ );
550
+ let key = injected_key(&body);
551
+ assert_eq!(
552
+ key.len(),
553
+ KEY_HEX_LEN,
554
+ "input {i}: key {key:?} must be {KEY_HEX_LEN} chars"
555
+ );
556
+ assert!(is_hex(&key), "input {i}: key {key:?} must be hex");
557
+ }
558
+ }
559
+
560
+ #[test]
561
+ fn responses_instructions_field_distinguishes_from_chat_system() {
562
+ // Same model, same logical "system", different shape:
563
+ // the keys may legally differ (different containers hash
564
+ // differently). What we DO assert is that running the
565
+ // same shape on the same body is stable (covered by
566
+ // idempotency test) and that running each shape produces
567
+ // a valid key.
568
+ let mut body_chat = json!({
569
+ "model": "gpt-4o",
570
+ "messages": [{"role": "system", "content": "S"}],
571
+ });
572
+ let mut body_resp = json!({
573
+ "model": "gpt-4o",
574
+ "instructions": "S",
575
+ });
576
+ let _ = inject_prompt_cache_key(&mut body_chat, OpenAiShape::ChatCompletions);
577
+ let _ = inject_prompt_cache_key(&mut body_resp, OpenAiShape::Responses);
578
+ assert_eq!(injected_key(&body_chat).len(), KEY_HEX_LEN);
579
+ assert_eq!(injected_key(&body_resp).len(), KEY_HEX_LEN);
580
+ }
581
+
582
+ #[test]
583
+ fn has_prompt_cache_key_works() {
584
+ assert!(!has_prompt_cache_key(&json!({})));
585
+ assert!(!has_prompt_cache_key(&json!({"prompt_cache_key": ""})));
586
+ assert!(!has_prompt_cache_key(&json!({"prompt_cache_key": null})));
587
+ assert!(has_prompt_cache_key(&json!({"prompt_cache_key": "x"})));
588
+ assert!(has_prompt_cache_key(
589
+ &json!({"prompt_cache_key": "user-pinned"})
590
+ ));
591
+ }
592
+
593
+ #[test]
594
+ fn skip_reason_string_is_stable() {
595
+ // Dashboards filter on these strings. Don't change without
596
+ // a deprecation note.
597
+ assert_eq!(SkipReason::NotAnObject.as_str(), "not_an_object");
598
+ assert_eq!(SkipReason::KeyPresent.as_str(), "key_present");
599
+ }
600
+ }