feat(deleteReferences): Add deleteAll flag

Author: michaelprichardson

src/common.ts

@@ -18,6 +18,13 @@ export function isConfig(arg: Rule | Config): arg is Config {
   return (arg as Config).config !== undefined;
 }
 
+export function isSubCollection(collection: string): boolean {
+  const filteredCollections = collection.split('/').filter(c => c.length > 0);
+  const numCollections = filteredCollections.length;
+  // Return false is equal to 1 or an even number
+  return numCollections !== 1 && numCollections % 2 === 1;
+}
+
 enum Key {
   Primary = '{(.*?)}',
   Foreign = '([$][^/]*|$)',

src/rules/deleteReferences.ts

@@ -1,13 +1,20 @@
-import { Config, Rule, replaceReferencesWith, getPrimaryKey } from '../common';
+import {
+  Config,
+  Rule,
+  replaceReferencesWith,
+  getPrimaryKey,
+  isSubCollection,
+} from '../common';
 
 export interface DeleteReferencesRule extends Rule {
   source: {
     collection: string;
   };
   targets: {
     collection: string;
-    foreignKey: string;
+    foreignKey?: string;
     isCollectionGroup?: boolean;
+    deleteAll?: boolean;
   }[];
   hooks?: {
     pre?: Function;
@@ -60,13 +67,24 @@ export function integrifyDeleteReferences(
       // Loop over each target
       const db = config.config.db;
       rule.targets.forEach(target => {
-        console.log(
-          `integrify: Deleting all docs in collection ${
-            target.isCollectionGroup ? 'group ' : ''
-          }[${target.collection}] where foreign key [${
-            target.foreignKey
-          }] matches [${primaryKeyValue}]`
-        );
+        // Check delete all flag
+        if (!target.deleteAll) {
+          target.deleteAll = false;
+        }
+        // CHeck the foreign key
+        if (!target.foreignKey) {
+          target.foreignKey = '';
+        }
+
+        if (!target.deleteAll && target.foreignKey.trim().length === 0) {
+          throw new Error(
+            `integrify: missing foreign key or set deleteAll to true`
+          );
+        } else if (target.deleteAll && !isSubCollection(target.collection)) {
+          throw new Error(
+            `integrify: [${target.collection}] is an invalid sub-collection`
+          );
+        }
 
         // Replace the context.params in the target collection
         const paramSwap = replaceReferencesWith(
@@ -89,20 +107,33 @@ export function integrifyDeleteReferences(
           whereable = db.collection(target.collection);
         }
 
+        if (target.deleteAll) {
+          console.log(
+            `integrify: Deleting all docs in sub-collection [${target.collection}]`
+          );
+        } else {
+          console.log(
+            `integrify: Deleting all docs in collection ${
+              target.isCollectionGroup ? 'group ' : ''
+            }[${target.collection}] where foreign key [${
+              target.foreignKey
+            }] matches [${primaryKeyValue}]`
+          );
+
+          whereable = whereable.where(target.foreignKey, '==', primaryKeyValue);
+        }
+
         promises.push(
-          whereable
-            .where(target.foreignKey, '==', primaryKeyValue)
-            .get()
-            .then(querySnap => {
-              querySnap.forEach(doc => {
-                console.log(
-                  `integrify: Deleting [${target.collection}]${
-                    target.isCollectionGroup ? ' (group)' : ''
-                  }, id [${doc.id}]`
-                );
-                promises.push(doc.ref.delete());
-              });
-            })
+          whereable.get().then(querySnap => {
+            querySnap.forEach(doc => {
+              console.log(
+                `integrify: Deleting [${target.collection}]${
+                  target.isCollectionGroup ? ' (group)' : ''
+                }, id [${doc.id}]`
+              );
+              promises.push(doc.ref.delete());
+            });
+          })
         );
       });
       return Promise.all(promises);