feat: add support for recursive deletes

Author: fwal

packages/admin/src/lib/firestore/firestore-service.ts

@@ -116,6 +116,11 @@ const make = (db: Firestore) => {
         try: () => db.doc(path).withConverter(converter).delete(),
         catch: (error) => mapError(error),
       }),
+    deleteRecursive: (path) =>
+      Effect.tryPromise({
+        try: () => db.recursiveDelete(db.doc(path)),
+        catch: (error) => mapError(error),
+      }),
     query: (collectionPath, constraints) =>
       Effect.tryPromise({
         try: async () => {

packages/client/src/lib/firestore/firestore-service.ts

@@ -64,6 +64,10 @@ const make = (db: Firestore) => {
         try: () => deleteDoc(doc(db, path).withConverter(converter)),
         catch: (error) => FirestoreError.fromError(error),
       }),
+    deleteRecursive: (_path) =>
+      Effect.die(
+        new Error('deleteRecursive is not supported by the client SDK')
+      ),
     query: (collectionPath, constraints) =>
       Effect.tryPromise({
         try: async () => {

packages/effect-firebase/src/lib/firestore/firestore-service.ts

@@ -63,6 +63,19 @@ type FirestoreCRUD = {
   readonly remove: (
     path: string
   ) => Effect.Effect<void, FirestoreError | UnknownException>;
+
+  /**
+   * Recursively delete a document and all its subcollections.
+   *
+   * **Admin SDK only.** Calling this method with the client SDK layer will
+   * cause a defect (`Effect.die`). Repositories and models that use this
+   * method must only be run in an admin context.
+   *
+   * @param path - The path to the document.
+   */
+  readonly deleteRecursive: (
+    path: string
+  ) => Effect.Effect<void, FirestoreError | UnknownException>;
 };
 
 type FirestoreQuery = {

packages/effect-firebase/src/lib/firestore/noop-layer.ts

@@ -20,6 +20,7 @@ export const noopLayer = Layer.succeed(FirestoreService, {
   set: NotInitiallized,
   update: NotInitiallized,
   remove: NotInitiallized,
+  deleteRecursive: NotInitiallized,
   query: NotInitiallized,
   streamDoc: NotInitiallized,
   streamQuery: NotInitiallized,

packages/mock/src/lib/firestore/firestore-service.ts

@@ -25,6 +25,9 @@ export const MockFirestoreService = (
     remove: () => {
       throw new Error('MockFirestoreService.remove not implemented.');
     },
+    deleteRecursive: () => {
+      throw new Error('MockFirestoreService.deleteRecursive not implemented.');
+    },
     query: () => {
       throw new Error('MockFirestoreService.query not implemented.');
     },