planner

type Conflict struct {
	ModFileVersionID int64
	ProfileItemID    int64
	Entry            RemappedEntry
	Priority         int64
	Won              bool
	// Display fields for dry-run output and status reporting.
	ModPageName   string
	FileLabel     string
	VersionString string // empty if not set
}

type DriftResult struct {
	State DriftState

	// Err is why the file could not be read, when State is DriftUnknown.
	Err error
}

type DriftState int

type Plan struct {
	GameInstallID int64
	ProfileID     int64 // 0 for unapply plans
	TargetID      int64
	TargetName    string
	TargetRoot    string
	Files         []PlanFile // one per destination path, apply plans only
	Ops           []PlanOp
	Warnings      []string

	// PatchBaseArchives is the set of archive sha256s that must be staged
	// for patch override base files, even if no mod write op requires them.
	PatchBaseArchives []string
}

type PlanFile struct {
	DestPath      string
	ProfileItemID int64
	Conflicts     []Conflict // sorted priority desc; exactly one has Won=true
}

type PlanOp struct {
	Kind     PlanOpKind
	DestPath string
	// File is set for Write, Overwrite ops.
	File *PlanFile
	// BackupSha256 is set for RestoreBackup ops.
	BackupSha256 string
	// NeedsBackup is true when a pre-existing non-tool-owned file must be
	// backed up before being overwritten.
	NeedsBackup bool

	// OverrideID is set when this op's content comes from an override.
	OverrideID sql.NullInt64
	// OverrideType is set when OverrideID is valid.
	// One of: "full_file", "ini_patch", "yaml_patch", "json_patch"
	OverrideType string
	// OverrideBlobSha256 is set for full_file override ops.
	OverrideBlobSha256 sql.NullString
	// OverrideBaseArchiveSha256 is set for patch override ops: the archive
	// that must be staged to provide the base file.
	OverrideBaseArchiveSha256 sql.NullString
	// OverrideBaseRawPath is the path inside the base archive for patch ops.
	OverrideBaseRawPath sql.NullString

	// SkipBackup is true when a skip-backup pattern matched this path.
	// Informational only; used for dry-run display.
	SkipBackup bool
	// WriteOnce is true when a write-once pattern matched this path.
	// Informational only; used for dry-run display.
	WriteOnce bool
}

type PlanOpKind string

type RemappedEntry struct {
	ArchiveSha256 string
	Position      int64
	SourcePath    string
	DestPath      string
	SizeBytes     int64
}

type UninventoriedArchiveError struct {
	ModFileVersionID int64
	ModPageName      string
	FileLabel        string
	ArchiveSha256    string
}