// SPDX-FileCopyrightText: 2026 FocusFlow contributors
// SPDX-License-Identifier: AGPL-3.0-only

part of '../../document_migration.dart';

/// A non-fatal detail about a migrated document.
class DocumentMigrationNote {
  /// Creates a `DocumentMigrationNote` instance with the values required by its invariants.
  /// Callers should pass already-normalized scheduler data because validation and defaulting belong at the model or service boundary, not in arbitrary UI code.
  const DocumentMigrationNote({
    required this.code,
    this.fieldName,
    this.detailCode,
  });

  /// Stores the `code` value for this object.
  /// This field is part of the explicit state that downstream scheduling, persistence, or UI code reads when composing behavior.
  final DocumentMigrationNoteCode code;

  /// Stores the `fieldName` value for this object.
  /// This field is part of the explicit state that downstream scheduling, persistence, or UI code reads when composing behavior.
  final String? fieldName;

  /// Stores the `detailCode` value for this object.
  /// This field is part of the explicit state that downstream scheduling, persistence, or UI code reads when composing behavior.
  final String? detailCode;
}
