pub(all) suberror FormatError {
  Invalid(String)
} derive(Eq, 
@moonbitlang/core/debug.Debug
Debug)

pub(all) struct AcceptanceReport {
  accepted : Bool
  policy : String
  bag : Report
  diagnostics : Array[Diagnostic]
} derive(ToJson)

pub(all) enum Algorithm {
  Md5
  Sha1
  Sha256
  Sha512
} derive(Eq, 
@moonbitlang/core/debug.Debug
Debug)

pub(all) struct AuditSummary {
  manifest_count : Int
  expected_files : Int
  missing_files : Int
  mismatched_checksums : Int
  unavailable_checksums : Int
  unprotected_tags : Int
  pending_fetches : Int
  verified_algorithms : Array[String]
} derive(ToJson)

pub(all) struct BagAudit {
  report : Report
  summary : AuditSummary
  files : Array[FileAudit]
  located_diagnostics : Array[LocatedDiagnostic]
} derive(ToJson)

pub(all) struct BagSnapshot {
  label : String
  bag_version : String
  encoding : String
  directories : Array[String]
  files : Array[FileRecord]
  metadata : Array[Metadata]
}

pub(all) struct BagView {
  files : Array[FileRecord]
  directories : Array[String]
  texts : Map[String, String]
} derive(
@moonbitlang/core/debug.Debug
Debug, 
@moonbitlang/core/json.FromJson
FromJson)

pub(all) struct ChecksumEvidence {
  manifest : String
  algorithm : String
  expected : String
  observed : String?
  status : String
} derive(ToJson)

pub(all) struct CollectionItem {
  identifier : String
  view : BagView
}

pub(all) struct CollectionReport {
  accepted : Bool
  accepted_bags : Int
  rejected_bags : Int
  payload_files : Int64
  payload_bytes : Int64
  items : Array[CollectionResult]
} derive(ToJson)

pub(all) struct CollectionResult {
  identifier : String
  acceptance : AcceptanceReport
} derive(ToJson)

pub(all) struct Declaration {
  version : String
  encoding : String
} derive(Eq, 
@moonbitlang/core/debug.Debug
Debug)

pub(all) enum DeliveryMode {
  ExactCopy
  CompleteFetch
} derive(Eq)

pub(all) struct DeliveryReport {
  accepted : Bool
  mode : String
  source : Report
  received : Report
  preserved_files : Int
  completed_files : Int
  diagnostics : Array[Diagnostic]
} derive(ToJson)

pub(all) struct Diagnostic {
  severity : Severity
  code : String
  path : String
  message : String
} derive(ToJson, 
@moonbitlang/core/debug.Debug
Debug)

pub(all) struct DiagnosticGroup {
  code : String
  errors : Int
  warnings : Int
  paths : Array[String]
} derive(ToJson)

pub(all) struct Entry {
  path : String
  checksum : String
} derive(Eq, 
@moonbitlang/core/debug.Debug
Debug)

pub(all) struct FetchEntry {
  url : String
  size : Int64?
  path : String
} derive(Eq, ToJson, 
@moonbitlang/core/debug.Debug
Debug)

pub(all) struct FileAudit {
  path : String
  payload : Bool
  present : Bool
  size : Int64?
  checksums : Array[ChecksumEvidence]
  integrity_verified : Bool
} derive(ToJson)

pub(all) struct FileChange {
  path : String
  kind : String
  payload : Bool
  before_size : Int64?
  after_size : Int64?
  compared_algorithms : Array[String]
  added_algorithms : Array[String]
  removed_algorithms : Array[String]
} derive(ToJson)

pub(all) struct FileRecord {
  path : String
  size : Int64
  digests : Map[String, String]
} derive(ToJson, 
@moonbitlang/core/debug.Debug
Debug, 
@moonbitlang/core/json.FromJson
FromJson)

pub(all) struct LocatedDiagnostic {
  path : String
  line : Int
  code : String
  message : String
} derive(ToJson)

pub(all) struct Manifest {
  name : String
  algorithm : Algorithm
  tag : Bool
  entries : Array[Entry]
} derive(Eq, 
@moonbitlang/core/debug.Debug
Debug)

pub(all) struct ManifestInspection {
  name : String
  parsed_entries : Array[Entry]
  diagnostics : Array[LocatedDiagnostic]
}

pub struct ManifestReader {
  name : String
  alg : Algorithm
  tag : Bool
  max_line_units : Int?
  max_entries : Int?
  entries : Array[Entry]
  seen : Map[String, Bool]
  buffer : StringBuilder
  buffer_units : Int
  line : Int
  after_cr : Bool
  finished : Bool
  failure : String?
}

pub(all) struct Metadata {
  label : String
  value : String
} derive(Eq, ToJson, 
@moonbitlang/core/debug.Debug
Debug, 
@moonbitlang/core/json.FromJson
FromJson)

pub(all) struct MetadataChange {
  label : String
  before_values : Array[String]
  after_values : Array[String]
} derive(ToJson)

pub(all) struct MetadataRule {
  label : String
  required : Bool
  repeatable : Bool
  values : Array[String]
} derive(
@moonbitlang/core/debug.Debug
Debug)

pub(all) struct PathBudget {
  pattern : String
  max_files : Int64?
  max_bytes : Int64?
}

pub(all) struct PreservationReport {
  preserved : Bool
  bag : Report
  inventory : SnapshotVerification
  metadata : Array[MetadataChange]
  declaration_matches : Bool
} derive(ToJson)

pub(all) struct Profile {
  identifier : String
  version : String
  metadata : Array[MetadataRule]
  manifests_required : Array[String]
  manifests_allowed : Array[String]?
  tag_manifests_required : Array[String]
  tag_manifests_allowed : Array[String]?
  allow_fetch : Bool
  require_fetch : Bool
  data_empty : Bool
  serialization : String
  accepted_serializations : Array[String]
  bag_versions : Array[String]
  tags_required : Array[String]
  tags_allowed : Array[String]
  payload_required : Array[String]
  payload_allowed : Array[String]
} derive(
@moonbitlang/core/debug.Debug
Debug)

pub(all) struct ProfileReport {
  conforms : Bool
  bag : Report
  diagnostics : Array[Diagnostic]
} derive(ToJson, 
@moonbitlang/core/debug.Debug
Debug)

pub(all) struct ReceivingPolicy {
  name : String
  payload_algorithms : Array[String]
  tag_algorithms : Array[String]
  forbid_legacy : Bool
  require_tag_protection : Bool
  require_portable : Bool
  allow_empty : Bool
  allow_fetch : Bool
  max_payload_files : Int64?
  max_payload_bytes : Int64?
  max_file_bytes : Int64?
  max_tag_bytes : Int64?
  max_path_depth : Int64?
  max_manifest_entries : Int64?
  path_budgets : Array[PathBudget]
}

pub(all) struct Report {
  complete : Bool
  valid : Bool
  payload_files : Int
  payload_bytes : Int64
  verified_checksums : Int
  diagnostics : Array[Diagnostic]
} derive(ToJson, 
@moonbitlang/core/debug.Debug
Debug)

pub(all) enum Severity {
  Error
  Warning
} derive(Eq, ToJson, 
@moonbitlang/core/debug.Debug
Debug)

pub(all) struct SnapshotDelta {
  byte_identical : Bool
  payload_identical : Bool
  comparable : Bool
  unchanged_files : Int
  files : Array[FileChange]
  directories_added : Array[String]
  directories_removed : Array[String]
  metadata : Array[MetadataChange]
  declaration_changed : Bool
} derive(ToJson)

pub(all) struct SnapshotVerification {
  matches : Bool
  checked_files : Int
  verified_checksums : Int
  diagnostics : Array[Diagnostic]
} derive(ToJson)

pub(all) struct TransferBatch {
  number : Int
  reserved_bytes : Int64
  tasks : Array[TransferTask]
} derive(ToJson)

pub(all) struct TransferOptions {
  allowed_schemes : Array[String]
  max_total_bytes : Int64
  max_file_bytes : Int64
  max_batch_bytes : Int64
  max_batch_files : Int
  unknown_size_reservation : Int64?
}

pub(all) struct TransferPlan {
  pending_files : Int
  known_bytes : Int64
  reserved_bytes : Int64
  unknown_sizes : Int
  directories_to_create : Array[String]
  batches : Array[TransferBatch]
} derive(ToJson)

pub(all) struct TransferTask {
  path : String
  url : String
  scheme : String
  declared_bytes : Int64?
  reserved_bytes : Int64
  checksums : Map[String, String]
} derive(ToJson)

pub(all) struct UpgradePlan {
  payload_manifests : Map[String, String]
  tag_algorithms : Array[Algorithm]
} derive(
@moonbitlang/core/debug.Debug
Debug)

fn algorithm(name : String) -> Algorithm raise FormatError

fn audit_bag(view : BagView) -> BagAudit

fn capture_snapshot(view : BagView, label? : String) -> BagSnapshot raise FormatError

fn check_fetch_url(url : String) -> Unit raise FormatError

fn check_path(path : String) -> Unit raise FormatError

fn compare_snapshots(before : BagSnapshot, after : BagSnapshot) -> SnapshotDelta raise FormatError

fn create_tag_manifests(tags : Array[FileRecord], algorithms? : Array[Algorithm]) -> Map[String, String] raise FormatError

fn create_tags(payload : Array[FileRecord], metadata? : Array[Metadata], algorithms? : Array[Algorithm], encoding? : String) -> Map[String, String] raise FormatError

fn decode_path(path : String) -> String raise FormatError

fn encode_path(path : String) -> String

fn evaluate_collection(collection : Array[CollectionItem], policy : ReceivingPolicy) -> CollectionReport raise FormatError

fn evaluate_receiving_policy(view : BagView, policy : ReceivingPolicy) -> AcceptanceReport raise FormatError

fn group_diagnostics(items : Array[Diagnostic]) -> Array[DiagnosticGroup]

fn inspect_manifest(name : String, text : String) -> ManifestInspection

fn lint_portability(view : BagView) -> Array[Diagnostic]

fn manifest_reader(name : String, max_line_units? : Int, max_entries? : Int) -> ManifestReader raise FormatError

fn parse_declaration(text : String) -> Declaration raise FormatError

fn parse_fetch(text : String) -> Array[FetchEntry] raise FormatError

fn parse_manifest(name : String, text : String) -> Manifest raise FormatError

fn parse_metadata(text : String) -> Array[Metadata] raise FormatError

fn parse_profile(json : Json) -> Profile raise FormatError

fn parse_receiving_policy(document : Json) -> ReceivingPolicy raise FormatError

fn parse_snapshot(document : Json) -> BagSnapshot raise FormatError

fn parse_transfer_options(document : Json) -> TransferOptions raise FormatError

fn payload_oxum(files : Array[FileRecord]) -> String raise FormatError