Consider exposing the __name__ reserved field in snapshot.data (Firestore)

[Jonas-Sander]

I'm trying to deserialize a dto in Dart from a DocumentSnapshot.

What I want to write:

  factory HomeworkDto.fromData(Map<String, dynamic> data) {
    return HomeworkDto._(
      // Reserved name which holds the document id
      id: data['__name__'],
      subject: data['subject'],
       // ....
    );
  }

In this way I wouldn't have to either

1. add a String id-Parameter where I pass snapshot.id (fromData(Map<String, dynamic> data, {String id})) or
2. pass the DocumentSnapshot snapshot as the parameter in fromData instead of Map<String, dynamic> data (HomeworkDto.fromData(DocumentSnapshot snapshot)).

In my special case I am trying to get to the point where I can share DTOs between dart frontend and backend (WIP) which means that I don't want a dependency on cloud:firestore in my DTOs if possible.

I still think this would even benefit users not trying to share DTOs as this code is more concise instead of having to use the 2 ways mentioned above. I also can't really think of any cons.