feat: add documentSnapshots method to FirestoreCollection and update tests

Author: stevenkellner

eslint.config.mjs

@@ -55,6 +55,7 @@ export default [
             '@typescript-eslint/no-unused-expressions': 'off',
             'multiline-comment-style': 'off',
             '@typescript-eslint/member-ordering': 'off',
+            '@stylistic/arrow-parens': 'off',
             'max-len': 'off',
             'quote-props': ['error', 'consistent-as-needed'],
             'object-property-newline': 'off',

src/firestore/FirestoreCollection.ts

@@ -1,6 +1,8 @@
+import { FirestoreSnapshot } from './FirestoreSnapshot';
 import type { Firestore } from 'firebase-admin/firestore';
 import { FirestoreDocument } from './FirestoreDocument';
 import type { FirestorePath } from './FirestorePath';
+import type { Flattable } from '@stevenkellner/typescript-common-functionality';
 
 export class FirestoreCollection<
     Documents extends Record<string, FirestoreDocument<any, any>>
@@ -11,6 +13,15 @@ export class FirestoreCollection<
         private readonly path: FirestorePath
     ) {}
 
+    public async documentSnapshots(): Promise<FirestoreSnapshot<FirestoreDocument.ValuesOf<Documents[string]>>[]> {
+        const collection = this.firestore.collection(this.path.fullPath);
+        const documents = await collection.listDocuments();
+        return Promise.all(documents.map(async document => {
+            const snapshot = await document.get() as FirebaseFirestore.DocumentSnapshot<Flattable.Flatten<FirestoreDocument.ValuesOf<Documents[string]>>>;
+            return new FirestoreSnapshot(snapshot);
+        }));
+    }
+
     public document<Key extends keyof Documents & string>(key: Key): Documents[Key] {
         return new FirestoreDocument(this.firestore, this.path.appending(key)) as Documents[Key];
     }

test/firestore/firestore-admin.test.ts

@@ -12,6 +12,11 @@ export type FirestoreScheme = FirestoreDocument<never, {
                     v10: boolean;
                 }>;
             }>;
+            col3: FirestoreCollection<{
+                [key: string]: FirestoreDocument<{
+                    v11: string;
+                }>;
+            }>;
         }>;
         doc3: FirestoreDocument<never, {
             col2: FirestoreCollection<{
@@ -133,4 +138,13 @@ describe('Firestore admin', () => {
         const snapshot = await baseDocument.collection('baseCollection').document('doc4').snapshot();
         expect(snapshot.exists).toBeEqual(false);
     });
+
+    it('should get document snapshots', async () => {
+        await baseDocument.collection('baseCollection').document('doc1').collection('col3').document('d1').set({ v11: 'value1' });
+        await baseDocument.collection('baseCollection').document('doc1').collection('col3').document('d2').set({ v11: 'value2' });
+        await baseDocument.collection('baseCollection').document('doc1').collection('col3').document('d3').set({ v11: 'value3' });
+        const snapshots = await baseDocument.collection('baseCollection').document('doc1').collection('col3').documentSnapshots();
+        expect(snapshots.length).toBeEqual(3);
+        expect(snapshots.map(s => s.data.v11)).toHaveSameMembers(['value1', 'value2', 'value3']);
+    });
 });