Firestore

queryFirestore()

This function gets you an item or an array of items from a Firebase query without you having to care about loops or getting the data from the snapshot. You'll just get the objects right away.

In addition (if not deactivated) you get the documents id and path for every object, too.

TRADITIONAL WAY:

/** For document query  */
const ref = db.collection('cities').doc('cityId')
const snapshot = await query.get()
const city = snapshot.data()

/** For collection query  */
const ref = db.collection('cities')
const snapshot = await query.get()
let cities = []
for (const doc of snapshot.docs) {
  let city = doc.data()
  cities.push(city)
}

WITH FIREWINGS:

/**  For document query */
const query = db.collection('cities').doc('cityId')
const city = await queryFirestore(query)

/**  For collection query */
const query = db.collection('cities')
const cities = await queryFirestore(query)

The function adds the documents id and path to every item. If you don't want that, set the second argument to false.

You can also pass a serialize function as the second argument to do your own object serialization, like convert timestamps to date objects.

Example:

// Serialize Function
export const serializeUser = (doc) => {
  const user = doc.data()
  user.uid = doc.id
  if (user.createdAt) {
    user.createdAt = user.createdAt.toDate()
  }
  return user
}

// Query
const query = db.collection('users')
const users = await queryFirestore(query, serializeUser)

unwrapFirestoreDoc()

This function unwraps a Firestore snapshot of a single- or multiple-document query and returns the item(s)' data as objects. Either as an array of objects, object of objects or as a single object.

Additionally, per default it adds the documents id and path to every item. As with queryFirestore(), you can also pass false as the second arguent to disable serialization, or pass your own serialization function.

TRADITIONAL WAY:

/** For single-doc queries */
const city = snapshot.data()
city.id = snapshot.id
city.path = snapshot.ref.path

/** For multi-doc queries */
let cities = []
for (const doc of snapshot.docs) {
  let city = doc.data()
  item.id = doc.id
  item.path = doc.ref.path
  items.push(item)
}

WITH FIREWINGS:

/** For single-doc queries returns an single object*/
const city = unwrapFirestoreDoc(snapshot)

/** For multi-doc queries returns an array of objects*/
const cities = unwrapFirestoreDoc(snapshot)

addToFirestore()

This function takes a reference and an object as payload and adds it to Firestore. It returns the added object including its Firebase id and path.

TRADITIONAL WAY:

const ref = await ref.add(data)
data.id = ref.id
data.path = ref.path
return data

WITH FIREWINGS:

return await addToFirestore(ref, data)

setToFirestore()

This function takes a query and an object as payload and sets (updates or creates) the document in Firestore. Befrore that, the properties id and path will be removed from the object, so it won't be written to Firestore.

TRADITIONAL WAY:

let clone = Object.assign({}, data)
let id = clone.id
delete clone.id
delete clone.path
await ref.doc(id).set(clone)

WITH FIREWINGS:

await setToFirestore(ref.doc(id), data)

It's also possible to do batched writes.

// Get a new write batch
let batch = db.batch()

// Set something
await setToFirestore(ref.doc(id), data, batch)

// Delete something
await batch.delete(ref.doc(id))

//  Set again something
await setToFirestore(ref2.doc(id), data, batch)

// Commit the batch
batch.commit().then(function() {
  // ...
})

changeDocId() DANGEROUS

This function changes the id of an existing document to a new id. It does this by creating a new document wwith the new key, and then deleting the old document.

WARNING

This functions might result in data loss or high Firebase bills.

Only do this, if you are sure what you are doing and how many documents it will affect, taking into account EVERYTHING, e.g. possibly existing onDelete() Firebase Functions etc.

TRADITIONAL WAY:

// First get the document
const doc = await queryFirestore(docRef)
// Then save it under the new id
const newRef = docRef.parent.doc(newKey)
const newDoc = await setToFirestore(newRef, doc)
// Then delete the old document and return the new document
await docRef.delete()

WITH FIREWINGS:

await changeDocId(ref, 'newId')

deleteEntireCollection() DANGEROUS

Deletes all documents in a collection (not including sub collections).

WARNING

This functions might result in data loss or high Firebase bills.

Only do this, if you are sure what you are doing and how many documents it will affect, taking into account EVERYTHING, e.g. possibly existing onDelete() Firebase Functions etc.

TRADITIONAL WAY:

// Too much code :P

WITH FIREWINGS:

await deleteEntireCollection(fireStore, collectionRef, batchSize = 400)

// Firestore = Firestore instance, needed for creating batches

copyCollection() DANGEROUS

Copies an entire collection to another path. Optionally, also copy it's sub-collections (but only 1 level deep). Also optionally deletes the old collection.

WARNING

This functions might result in data loss or high Firebase bills.

Only do this, if you are sure what you are doing and how many documents it will affect, taking into account EVERYTHING, e.g. possibly existing onDelete() Firebase Functions etc.

TRADITIONAL WAY:

// Too much code :P

WITH FIREWINGS:

await copyCollection(
  sourceCollectionRef,
  targetCollectionRef,
  subCollections = [], // Optional
  fireStore = null, // Optional, but a must if deleteOld = true
  deleteOld = false // Optional
  )

// Firestore = Firestore instance, needed for creating batches