Add document to firestore and split it up into sub collection.

A replacement/extension to the AngularFirestoreCollection.add. Does the same as AngularFirestoreCollection.add but can also add createdDate and modifiedDate and returns the data with the added properties in FirebaseDbItem

Used internally

Turn a batch into an Observable instead of Promise.

For some reason angularfire returns a promise on batch.commit() instead of an observable like for everything else.

This method turns it into an observable

Firestore doesn't allow you do change the name or move a doc directly so you will have to create a new doc under the new name and then delete the old doc. returns the new doc once the delete is done.

clean FirestoreBaseItem properties from the data. Usually done if you wish to save the data to firestore, since some FirestoreBaseItem properties are of non allowed types.

Goes through each level and removes DbItemExtras In case you wish to save the data

Delete Document and child documents. Takes a DocumentReference and an optional list of SubCollectionQuery

Delete all documents and sub collections as specified in subCollectionQueries. Not very efficient and causes a lot of db reads. If possible use the firebase CLI or the console instead when deleting large collections.

Delete firestore document by path Convenience method in case we do not have direct access to the AngularFirestoreDocument reference

Use when you wish to delete an indexed document and have the remaining documents update their indices to reflect the change.

Use when you wish to delete several indexed documents and have the remaining documents update their indices to reflect the change.

Delete document by FirestoreItem

A very convenient method to remove a previously fetched document. Requires that the document/Item is previously fetched since the item needs to be a FireItem, i.e. includes firestoreMetadata.

Delete Documents and child documents

Delete Documents

Does the heavy lifting when it comes to updating multiple docs to change their index. Not called directly.

Used mainly for drag and drop scenarios where we drag an item from one list to another and the the docs have an index value and a groupName.

Run this on collections with a fixed order using an index: number attribute; This will update that index with the index in the collectionData, so it should be sorted by index first. Basically needs to be run after a delete

Returns WriteBatch that is set to delete Document and child documents of given docRef

Returns an Observable containing a list of DocumentReference found under the given docRef using the SubCollectionQuery[] Mainly used to delete a docFs and its sub docs

Used by deleteDeepByItem$ to get all the AngularFirestoreDocuments to be deleted including child documents using SubCollectionQueries

Internal use

DO NOT CALL THIS METHOD, its meant as a support method for getDocs$

Same as AngularFirestoreCollection.snapshotChanges but it adds the properties in FirebaseDbItem.

Important to understand this is will trigger for every change/update on any of the documents we are listening to. That means that if any document we are listening to is changed the entire object will be triggered containing the updated data.

Example usage.

ngFirestoreDeep: RxFirestoreExtended; // RxFirestoreExtended variable restaurantCollectionFs = this.ngFireStore.collection('restaurants'); // AngularFirestoreCollectionRef to restaurants

constructor(private ngFireStore: AngularFirestore) { this.ngFirestoreDeep = new RxFirestoreExtended(ngFireStore); // initialize AngularFireStoreDeep with AngularFirestore }

listenForRestaurants$(): Observable<RestaurantItem[]> { return this.ngFirestoreDeep.listenForCollection$(this.restaurantCollectionFs); }

If you do not wish to listen for changes and only care about getting the values once

getRestaurants$(): Observable<RestaurantItem[]> { return this.ngFirestoreDeep.listenForCollection$(this.restaurantCollectionFs).pipe( take(1) ); }

Listens for collections inside collections with the same name to an unlimited depth and returns all of it as an array.

Used internally for both listenForDoc and listenForCollection in order to recursively get collections.

Please use listenForDoc or listenForCollection.

Listens for single collection and returns an array of documents as FireItem[] Used internally, please use listenForCollection$() instead.

Allows for listening to documents and collections n deep up to the firestore max of 100 levels.

Triggers for any change in any document that is listened to.

E.x: const subCollectionQueries: SubCollectionQuery[] = [ { name: 'data' }, { name: 'secure' }, { name: 'variants' }, { name: 'images', queryFn: ref => ref.orderBy('index'), collectionWithNames: [ { name: 'secure'} ] }, ];

this.listenForDocAndSubCollections<Product>(docFs, collections)

Wrapper for listenForDocDeepRecursiveHelper$ so that we can cast the return to the correct type All logic is in listenForDocDeepRecursiveHelper$.

DO NOT CALL THIS METHOD, meant to be used solely by listenForDocAndSubCollections$

Same as AngularFirestoreDocument.snapshotChanges but it adds the properties in FirebaseDbItem and also allows for to choose action to take when document does not exist

Important to understand this is will trigger for every change/update on the document we are listening to.

Moved item within the same list so we need to update the index of all items in the list; Use a copy if you dont wish to update the given array, for example when you want to just listen for the change of the db.. The reason to not do this is because it takes some time for the db to update and it looks better if the list updates immediately.

Recursive method to clean FirestoreBaseItem properties from the dbItem

DO NOT CALL THIS METHOD, used in addDeep and updateDeep to split the data into currentDoc and subCollections Only goes one sub level deep;

Update document and child documents

Be careful when updating a document of any kind since we allow partial data there cannot be any type checking prior to update so its possible to introduce spelling mistakes on attributes and so forth

DO NOT CALL THIS METHOD, used by update deep

Update/ add data to the firestore documents

Used internally for updates that doesn't affect child documents