Author: Adam Lewis

Description:

This Firebase Extension allows you to restore previously deleted Firestore documents with ease.

Imagine a Recycle Bin (Windows) or Bin (Mac) for your firestore documents. When you delete a firestore document (or an entire collection/subcollection of documents), the deleted document(s) will all safely be stored in a separate collection called DeletedRecords where you can see and most importantly, restore the document back into its original location.

To view deleted documents, head to the DeletedRecords/DeletedRecords document. Deleted documents will all be stored in subcollections with the same path as the original document. 

Note: To avoid conflicts on .collectionGroup() queries, the extension appends _archived to the end of all collection & subcollection names.

In order to restore a document back to its original location, simply find the document and set the softDeletes.restored value from false to true. The document will then be inserted at its original location.

Deleting documents contained within the DeletedRecords collection will delete the document permenantly. If you wish to delete all previously deleted records, simply use the Firestore console to delete the DeletedRecords collection.

By default, this extension keeps a copy of every document in every collection when it is deleted. You can specify individual collections if you don't want to retain deleted documents from every collection in your Firestore database. Note: you will need to add an instance of this extension for each collection if you choose to use this option.

This extension uses other Firebase or Google Cloud services which may have
 associated charges:

*   Cloud Firestore
*   Cloud Functions

When you use Firebase Extensions, you're only charged for the underlying
resources that you use. A paid-tier billing plan is only required if the
extension uses a service that requires a paid-tier plan, for example calling to
a Google Cloud API or making outbound network requests to non-Google services.
All Firebase services offer a no-cost tier of usage.
[Learn more about Firebase billing.](https://firebase.google.com/pricing)

Configuration Parameters:

• Cloud Functions location: Where do you want to deploy the functions created for this extension? For help selecting a location, refer to the location selection guide.

• Collection (default is all collections): Which collection do you want to use Soft Deletes on? Choose the default ({AllCollections=**}) to cover all collections / subcollections. Note: You can configure specific subcollections by using the syntax: 'ExampleCollection/{docId}/ExampleSubCollection'

• Collection name to store deleted documents: Specify the name for the collection where deleted documents will be stored

Cloud Functions:

• firestoreSoftDeletes: Creates a clone of a deleted firestore record and inserts it into a separate collection

• firestoreSoftDeletesRestore: Restores a record previously cloned by the firestore soft deletes function

APIs Used:

• firestore.googleapis.com (Reason: This is required for the extension to operate)

Access Required:

This extension will operate with the following project IAM roles:

• datastore.user (Reason: Allows the extension to read and write documents to/from Cloud Firestore.)