//! # sqz_engine
//!
//! The core compression engine behind sqz. Takes text — JSON, CLI output, code,
//! logs, prose — and squeezes it down to use fewer LLM tokens while keeping the
//! important stuff intact.
//!
//! ## Quick start
//!
//! ```rust
//! use sqz_engine::SqzEngine;
//! # let dir = tempfile::tempdir().unwrap();
//! # std::env::set_var("SQZ_DB_PATH", dir.path().join("sessions.db"));
//!
//! let engine = SqzEngine::new().expect("failed to init engine");
//!
//! // Compress some text
//! let result = engine.compress("hello world").unwrap();
//! println!("compressed: {}", result.data);
//! println!("tokens: {} → {}", result.tokens_original, result.tokens_compressed);
//!
//! // JSON gets TOON-encoded automatically
//! let json_result = engine.compress(r#"{"name": "Alice", "age": 30}"#).unwrap();
//! assert!(json_result.data.starts_with("TOON:"));
//! ```
//!
//! ## How it works
//!
//! Content flows through a multi-stage pipeline:
//!
//! 1. **Content routing** — the confidence router classifies input (JSON, code,
//! logs, prose) and picks a compression mode (safe, default, aggressive).
//! 2. **Stage pipeline** — configurable stages run in priority order: ANSI
//! stripping, null removal, repeated-line condensing, git diff folding,
//! string truncation, array collapsing, and custom transforms.
//! 3. **Post-processing** — RLE compression, sliding-window dedup, entropy
//! truncation, and token pruning for prose.
//! 4. **TOON encoding** — JSON gets encoded into Token-Optimized Object
//! Notation, which drops unnecessary quotes and whitespace for 30-60%
//! fewer tokens.
//! 5. **Verification** — a two-pass verifier checks that error lines, JSON
//! keys, and diff hunks survived compression. If confidence is low, the
//! engine falls back to safe mode.
//!
//! ## Key types
//!
//! - [`SqzEngine`] — top-level facade, wires everything together
//! - [`CompressionPipeline`] — the stage-based compression orchestrator
//! - [`CacheManager`] — SHA-256 content-hash dedup cache
//! - [`SessionStore`] — SQLite-backed session and cache persistence
//! - [`Preset`] — TOML-configurable compression settings
//! - [`ToonEncoder`] — JSON → TOON lossless encoding
//! - [`CompressedContent`] — compression result with token counts and metadata
pub mod adaptive_tree;
pub mod advanced_search;
pub mod ansi_strip;
pub mod api_proxy;
pub mod ast_delta;
pub mod ast_parser;
pub mod benchmarks;
#[cfg(test)]
mod cmd_formatter_bench;
pub mod bpe_compressor;
pub mod cascade_compressor;
pub mod claude_md_integration;
pub mod cmd_formatters;
pub mod codex_integration;
pub mod compression_quality;
pub mod confidence_router;
pub mod context_evictor;
pub mod crp_engine;
pub mod dashboard;
pub mod delta_encoder;
pub mod dependency_mapper;
pub mod dict_compressor;
pub mod entropy_analyzer;
pub mod entropy_truncator;
pub mod exit_marker;
pub mod file_reader;
pub mod image_compressor;
pub mod json_projection;
pub mod kv_cache_optimizer;
pub mod litm_positioner;
pub mod mdl_selector;
pub mod minhash_lsh;
pub mod ngram_abbreviator;
pub mod opencode_plugin;
pub mod rle_compressor;
pub mod simhash;
pub mod table_compactor;
pub mod textrank;
pub mod token_pruner;
pub mod tool_hooks;
pub mod tool_selector;
pub mod engine;
pub mod hook_manager;
pub mod budget_tracker;
pub mod cache_manager;
pub mod correction_log;
pub mod cost_calculator;
pub mod ctx_format;
pub mod error;
pub mod model_router;
pub mod parse_tree_compressor;
pub mod pipeline;
pub mod pin_manager;
pub mod plugin_api;
pub mod preset;
pub mod progressive_throttle;
pub mod prompt_cache;
pub mod regret_tracker;
pub mod sandbox_executor;
pub mod session_continuity;
pub mod session_store;
pub mod shell_scan;
pub mod kiro_integration;
pub mod stages;
pub mod structural_summary;
pub mod text_boundary;
mod text_search;
pub mod zed_integration;
pub mod tee_mode;
pub mod terse_mode;
pub mod token_counter;
pub mod toon;
pub mod transparency;
pub mod types;
pub mod url_indexer;
pub mod verifier;
pub use advanced_search::{AdvancedSearch, SearchResult};
pub use ansi_strip::AnsiStripper;
pub use api_proxy::{compress_request, parse_http_request, build_http_response, ApiFormat, ProxyConfig, ProxyStats};
pub use ast_parser::{AstParser, ClassDefinition, CodeSummary, FunctionSignature, ImportDecl, TypeDeclaration};
pub use bpe_compressor::{bpe_compress, BpeConfig, BpeResult};
pub use compression_quality::{measure_quality, format_quality_report, CompressionQuality, QualityGrade};
pub use confidence_router::{ConfidenceRouter, CompressionMode};
pub use context_evictor::{evict, should_evict, ContextItem, EvictionConfig, EvictionResult};
pub use cmd_formatters::format_command;
pub use delta_encoder::{DeltaConfig, DeltaEncoder, DeltaResult};
pub use dependency_mapper::DependencyMapper;
pub use dict_compressor::{DictCompressor, DictConfig, DictCompressResult};
pub use entropy_analyzer::{EntropyAnalyzer, InfoLevel, AnalyzedBlock};
pub use entropy_truncator::{EntropyTruncator, EntropyTruncConfig, EntropyTruncResult, EntropyTruncArrayResult};
pub use file_reader::{FileReadMode, FileReader, ReadResult, BlockEntropy, compute_entropy, analyze_block_entropies};
pub use image_compressor::{ImageCompressor, ImageDescription};
pub use json_projection::{project_json, ProjectionConfig, ProjectionResult};
pub use litm_positioner::{ContextSection, LitmPositioner, LitmStrategy, SectionType};
pub use ngram_abbreviator::{NgramAbbreviator, AbbreviatorConfig, AbbreviationResult};
pub use rle_compressor::{rle_compress, sliding_window_dedup, RleResult, SlidingWindowResult};
pub use simhash::{simhash, SimHashFingerprint};
pub use structural_summary::{summarize as structural_summarize, summarize_multi, SummaryConfig, StructuralSummaryResult};
pub use textrank::{textrank_compress, TextRankConfig, TextRankResult};
pub use mdl_selector::{select_stages, profile_content, ContentProfile, MdlSelection};
pub use tool_hooks::{process_hook, process_hook_cursor, process_hook_gemini, process_hook_kiro, process_hook_windsurf, process_hook_copilot, generate_hook_configs, has_sqz_rules, refresh_sqz_rules, remove_sqz_rules, sqz_rules_change, sqz_rules_content, sqz_rules_path, sqz_rules_state, install_tool_hooks, install_tool_hooks_scoped, install_tool_hooks_scoped_filtered, claude_user_settings_path, claude_project_settings_needs_update, remove_claude_global_hook, remove_claude_project_hook, claude_settings_stale, refresh_claude_settings, claude_post_tool_use_target, claude_hooks_compress, PostToolUseTarget, CLAUDE_ALLOW_RULES, copilot_hooks_path, install_copilot_hook, remove_copilot_hook, ci_hooks_path, ci_hook_content, install_ci_hook, remove_ci_hook, canonicalize_tool_name, parse_tool_list, integration_tier, InstallScope, IntegrationTier, ToolFilter, ToolHookConfig, HookScope, HookPlatform, SUPPORTED_TOOL_NAMES};
pub use tool_hooks::{
gemini_settings_has_sqz, gemini_settings_needs_update, merge_sqz_gemini_hook,
remove_sqz_from_gemini_settings, resolve_sqz_binary, claude_settings_have_sqz_hooks,
claude_user_hooks_installed, remove_claude_project_hooks_only, sqz_hook_binaries,
legacy_sqz_hook_files, remove_legacy_sqz_hooks, claude_settings_have_sqz,
};
pub use opencode_plugin::{
generate_opencode_plugin, install_opencode_plugin, update_opencode_config,
update_opencode_config_detailed, find_opencode_config,
opencode_config_has_comments,
plan_opencode_config_change, PlannedOpencodeChange,
remove_sqz_from_opencode_config, strip_jsonc_comments,
process_opencode_hook, opencode_plugin_path,
opencode_plugin_stale, refresh_opencode_plugin,
};
pub use codex_integration::{
agents_md_guidance_block, agents_md_guidance_state, agents_md_path,
codex_config_path, codex_mcp_registered, guidance_blocks, guidance_change,
install_agents_md_guidance, install_codex_mcp_config,
refresh_agents_md_guidance, remove_agents_md_guidance, remove_all_sqz_guidance,
remove_codex_mcp_config, sqz_guidance, GuidanceBlock, GuidanceChange,
};
pub use claude_md_integration::{
claude_mcp_config_managed, claude_md_block_outdated, claude_md_guidance_block, claude_md_guidance_state,
claude_md_has_guidance, claude_md_path, claude_user_json_path, install_claude_md_guidance,
install_claude_mcp_config, refresh_claude_md_guidance, remove_claude_md_guidance,
remove_claude_mcp_config,
};
pub use zed_integration::{
install_zed_guidance, install_zed_mcp_config, remove_zed_guidance,
remove_zed_mcp_config, zed_guidance_block, zed_guidance_target,
zed_mcp_snippet, zed_settings_path, ZedMcpInstall, ZedMcpRemove,
};
pub use kiro_integration::{
install_kiro_mcp_config, install_kiro_steering, install_kiro_user_steering,
kiro_legacy_hook_path, kiro_mcp_path, kiro_steering_path, kiro_steering_state,
kiro_user_root, kiro_user_steering_path, refresh_kiro_steering, remove_kiro_legacy_hook,
remove_kiro_mcp_config, remove_kiro_steering, KiroMcpInstall, KiroMcpRemove,
SteeringState,
};
pub use token_pruner::{TokenPruner, PrunerConfig, PruneResult};
pub use tool_selector::{ToolDefinition, ToolSelector};
pub use budget_tracker::{
AgentBudget, BudgetTracker, BudgetWarning, UsagePrediction, UsageReport,
};
pub use cache_manager::{parse_ref_token, CacheManager, CacheResult, DedupHit, ExpandResult, SliceHit};
pub use correction_log::ContextWindow;
pub use crp_engine::{CrpEngine, CrpLevel};
pub use cost_calculator::{
CostBreakdown, CostCalculator, ModelPricing, PricingConfig, SavedCostEstimate,
SavingsAssumptions, SessionCostSummary, TokenUsage, ToolCost, estimate_saved_cost,
};
pub use ctx_format::{CtxEnvelope, CtxFormat, CtxMetadata};
pub use error::{Result, SqzError, SourceLocation};
pub use exit_marker::{
posix_rewrite, posix_rewrite_list, powershell_rewrite, strip_exit_marker,
strip_exit_marker_bytes,
};
pub use model_router::{ModelRouter, RoutingDecision, TaskContext};
pub use pipeline::{CompressionPipeline, SessionContext};
pub use pin_manager::PinManager;
pub use plugin_api::{PluginLoader, PluginManifest, PluginSource, SqzPlugin};
pub use prompt_cache::{CacheBoundary, Message, PromptCacheDetector};
pub use session_store::{CommandStats, CompressionStats, DailyGain, RecallHit, RegretStats, SessionStore, SessionSummary};
pub use session_continuity::{
SessionContinuityManager, SessionGuide, Snapshot, SnapshotEvent, SnapshotEventType,
};
pub use toon::ToonEncoder;
pub use tee_mode::{TeeMode, TeeManager, TeeEntry};
pub use terse_mode::TerseMode;
pub use token_counter::TokenCounter;
pub use types::*;
pub use preset::{
BudgetConfig, CollapseArraysConfig, CompressionConfig, CondenseConfig, CustomTransformsConfig,
FlattenConfig, GitDiffFoldConfig, KeepFieldsConfig, ModelConfig, ModelPricingConfig, Preset,
PresetHeader, PresetMeta, PresetParser, StripFieldsConfig, StripNullsConfig, TerseLevel,
TerseModeConfig, ToolSelectionConfig, TruncateStringsConfig,
};
pub use progressive_throttle::{ProgressiveThrottler, ThrottleConfig, ThrottleLevel};
pub use dashboard::{
CommandBreakdown, DashboardConfig, DashboardHtml, DashboardMetrics, DashboardServer,
SessionHistoryEntry, ToolBreakdown,
};
pub use engine::{SqzEngine, ToolResultCompression, TOOL_RESULT_MIN_SAVING};
pub use hook_manager::{
generate_platform_config, known_platforms, Hook, HookAction, HookContext, HookManager, HookType,
};
pub use sandbox_executor::{SandboxExecutor, SandboxResult, RuntimeInfo, FilteredOutput};
pub use url_indexer::{ContentFetcher, IndexedChunk, IndexResult, UrlIndexer};
pub use verifier::Verifier;
pub use adaptive_tree::{compress_to_budget, build_tree, SemanticNode};
pub use ast_delta::{ast_diff, encode_delta, AstDelta, AstChange, ChangeKind};
pub use kv_cache_optimizer::{compress_with_sinks, compress_with_custom_sinks};
pub use minhash_lsh::{MinHashLsh, MinHashSignature};
pub use parse_tree_compressor::{compress_code, char_entropy};
pub use cascade_compressor::{cascade_compress, CascadeLevel, CascadeThresholds, CascadeResult};
pub use regret_tracker::{RegretTracker, RegretEvent, RegretKind, FileProfile};
pub use transparency::{CompressionAnnotation};