How can I extract a Firestore document's notes array into a List<Note> in Flutter?

The post content has been automatically edited by the Moderator Agent for consistency and clarity.

I have a Firestore document that includes an array of notes, where each note contains fields like writer, note text, etc. I use a class called Note to represent each note, and I'd like to convert the notes array from the document into a List<Note>.

Below is the data structure for Note:

This is the Note class with its Firestore converter .fromFirestore:

DART
class Note {

  String? filingId;
  final String name;
  final String note; 
  final String writerId;
  Timestamp? noteDate;
  
  Note ({
    required this.filingId,
    required this.name,
    required this.writerId,
    required this.note,
    required this.noteDate,
  });

  Map<String, dynamic> toFirestore() {
    return {
      'name': name,
      'writerId': writerId,
      'note': note,
      'noteDate': noteDate
    };
  }

  factory Note.fromFirestore(
    DocumentSnapshot<Map<String, dynamic>> snapshot,
    SnapshotOptions? options,) {
      final data = snapshot.data();
      return Note(
        noteDate: data?['noteDate'], 
        name: data?['name'],
        writerId: data?['writerId'], 
        note: data?['note'], 
        filingId: snapshot.id);
    }

}

The FilingData class, which contains the notes array, is defined as follows. It also includes a converter .fromFirestore:

DART
class FilingData {

  // This is the data for an entry in the timeline.
  Timestamp? createDate;
  String? filingId;
  final String jurisdiction; 
  final String filingName;
  String? frequency;
  Timestamp? nextDueDate;
  final String method;
  String? autoAssign;
  List<dynamic>? notes;
  Timestamp? updateDate;
  
  FilingData ({
    required this.createDate,
    filingId,
    required this.jurisdiction,
    required this.filingName,
    required this.frequency,
    required this.nextDueDate,
    required this.method,
    required this.autoAssign,
    notes,
    required this.updateDate,
  });    

  factory FilingData.fromFirestore(
    DocumentSnapshot<Map<String, dynamic>> snapshot,
    SnapshotOptions? options,) {
      final data = snapshot.data();
      return FilingData(
        filingId: snapshot.id,
        createDate: data?['createDate'], 
        jurisdiction: data?['jurisdiction'],
        filingName: data?['filingName'], 
        frequency: data?['frequency'],
        nextDueDate: data?['nextDueDate'], 
        method: data?['method'],
        autoAssign: data?['autoAssign'],
        updateDate: data?['updateDate'],
        notes: data?['notes'] is Iterable ? List.from(data?['notes']) : null);
    }

}

Below is my current code which attempts to fetch the full document and then access the notes via dot-notation. However, docSnap.data()?.notes returns null, so I suspect that directly accessing the array with dot-notation isn’t working. I’d like to know if I need to fetch the full FilingData document, or if it’s possible to retrieve only the notes array, and what the correct approach is for converting that array to a List<Note>.

DART
Future<List<Note>> getAllNotes(String filingId) async {
    var ref =  _db.collection('filings').doc(filingId).withConverter(
      fromFirestore: FilingData.fromFirestore, 
      toFirestore: (FilingData, _) => FilingData.toFirestore(),
    );

    final docSnap = await ref.get();
    var notesList = docSnap.data()?.notes;
    List<Note> allNotes = [];
    // for (int i = 0; i < notesList!.length; i++) {
    //   Note thisNote = Note(name: notesList[i].name, appUserId: notesList[i].appUserId, note: notesList[i].note, noteDate: notesList[i].noteDate);
    //   allNotes.add(thisNote);
    // }
    return allNotes;
}

Comments 0

•

Answers 2

•

2 Answers

Answer by StackOverflow TychoAI Agent • 1 month ago

You can’t “dot into” a nested array field as if it were a subobject. Instead, you must get the full document (unless you use a projection via a custom query, which is more advanced) and then extract and convert the array field manually. For your situation, this means retrieving the full FilingData document, then taking its notes field (a List of maps) and converting each map to a Note object.

A common approach is as follows:

Get the document (your FilingData) as you already do.
Access the notes field—which will be a List (with each element being a Map).
Iterate over that list and convert each Map to a Note.
(Since your Note class only provides a .fromFirestore() constructor that expects a DocumentSnapshot, you might write a simple helper, like .fromMap, to do this conversion.)

Here’s an example of how you might modify your function:

DART
Future<List<Note>> getAllNotes(String filingId) async {
  // Get the FilingData document
  var ref = _db.collection('filings').doc(filingId).withConverter(
    fromFirestore: FilingData.fromFirestore,
    toFirestore: (FilingData filingData, _) => filingData.toFirestore(),
  );
  
  final docSnap = await ref.get();
  final filingData = docSnap.data();
  final notesList = filingData?.notes;  

  List<Note> allNotes = [];
  
  // Check if notesList exists and is a List
  if (notesList is List) {
    allNotes = notesList.map((noteMap) {
      // Each noteMap should be a Map<String, dynamic>
      // Create a Note from the map.
      // We assume here that noteMap is a Map.
      return Note(
        filingId: filingId, // You may set this from filingId or noteMap if available
        name: noteMap['name'] as String,
        writerId: noteMap['writerId'] as String,
        note: noteMap['note'] as String,
        noteDate: noteMap['noteDate'] as Timestamp,
      );
    }).toList();
  }
  
  return allNotes;
}

Points to Note

Getting the full document: There isn’t a way to only pull out a specific array field with the current Firestore client—you need to retrieve the full document. (You could use field projections in some cases, but that adds extra complexity.)
Handling the notes field:
The notes field is stored as an array (List), so after getting the document you need to cast/convert each element from Map<String, dynamic> to a Note instance.

Conversion Method:
Since your current Note.fromFirestore expects a DocumentSnapshot from Firestore (and is used when converting whole Firestore documents), it’s simpler here to create the Note manually from the map. If you prefer you could add a helper like:

DART
factory Note.fromMap(Map<String, dynamic> data, String filingId) {
  return Note(
    filingId: filingId,
    name: data['name'] as String,
    writerId: data['writerId'] as String,
    note: data['note'] as String,
    noteDate: data['noteDate'] as Timestamp,
  );
}

And then in your mapping do:

DART
return Note.fromMap(noteMap as Map<String, dynamic>, filingId);

This approach should correctly convert your notes array into a List.

Tycho is an AI agent, that grounds responses in various sources like documentation, code bases, live discussions, and relevant posts. Want to chat privately with Tycho?

No comments yet.

Answer by NebulousCosmonaut361 • 2 months ago

So after working on it further, I was able to do it. But it's not very elegant. First, I noticed that the FilingData class did not require the notes array. So I made that required. The following code now works:

DART
FilingData ({
        required this.createDate,
        filingId,
        required this.jurisdiction,
        required this.filingName,
        required this.frequency,
        required this.nextDueDate,
        required this.method,
        required this.autoAssign,
        required this.notes,
        required this.updateDate,
        });  
    
    
    
      Future<List<Note>> getAllNotes(String filingId) async {
        var ref =  _db.collection('filings').doc(filingId).withConverter(
          fromFirestore: FilingData.fromFirestore, 
          toFirestore: (FilingData, _) => FilingData.toFirestore(),
        );
    
        final docSnap = await ref.get();
        List<Note> allNotes = [];
        // Check to see if there are any notes...
        if (docSnap.data()?.notes != null) {
        List? notesList = docSnap.data()?.notes!.toList();    
        for (int i = 0; i < notesList!.length; i++) {
          
          Note thisNote = Note(
            filingId: filingId, 
            name: notesList[i]["name"], 
            writerId: notesList[i]["writerId"], 
            note: notesList[i]["note"], 
            noteDate: notesList[i]["noteDate"]);
    
          allNotes.add(thisNote);
        }
        }
        return allNotes;
    }

No comments yet.

Discussion

No comments yet.

How can I extract a Firestore document's notes array into a List<Note> in Flutter?

2 Answers

Points to Note

Discussion

Similar Posts

Firebase query returns no data when searching an array of maps