TurboWriteableId<T extends Object> class abstract

A base class for Firestore documents that require a unique identifier.

This abstract class extends TurboWriteable and adds functionality for handling document identifiers in Firestore. It provides a type-safe way to work with document IDs and includes functionality to track whether a document is a local default.

Type parameter T represents the type of the document's ID (typically String). The ID type must be non-nullable (extends Object).

Example of a basic implementation:

class User extends TurboWriteableId<String> {
  User({
    required this.name,
    this.isDefault = false,
  }) : super(isLocalDefault: isDefault);

  final String name;

  @override
  String get id => 'user-123';

  @override
  Map<String, dynamic> toJson() => {
    'name': name,
  };

  @override
  TurboResponse<void>? validate<void>() {
    if (name.isEmpty) {
      return TurboResponse.fail(message: 'Name cannot be empty');
    }
    return null;
  }
}

Example usage with custom ID type:

class CustomId {
  const CustomId(this.value);
  final String value;

  @override
  String toString() => value;
}

class Document extends TurboWriteableId<CustomId> {
  Document() : super();

  @override
  CustomId get id => CustomId('doc-123');
}