ts-firestore-admin-helper

Typesafe Firestore Admin Helper

Instalation

Using NPM

1npm install ts-firestore-admin-helper

Using Yarn

1yarn add ts-firestore-admin-helper

Usage

1// Start: Your Firestore initialization script
2import admin from 'firebase-admin';
3import FirestoreHelper from 'ts-firestore-admin-helper';
4
5const serviceAccount = require('./firebase-service-account.json');
6
7if (admin.apps.length === 0) {
8  admin.initializeApp({
9    credential: admin.credential.cert(serviceAccount),
10  });
11}
12
13const firestoreAdmin = admin.firestore();
14// End: Your firestore initialization script
15
16// Start: Define your collection interface
17interface YourCollectionInterface {
18    key1: string;
19    key2: string;
20}
21// End: Define your collection interface
22
23// Start: Define your Firestore Collection
24const yourCollection = new FirestoreHelper<YourCollectionInterface>(
25  firestoreAdmin,
26  'yourCollection'
27);
28// End: Define your Firestore Collection
29
30// Create a new document
31yourCollection.addDocument({
32    key1: 'value1',
33    key2: 'value2',
34});
35
36// Edit a document
37yourCollection.editDocument(
38    'document_key',
39    {
40        key1: 'value2',
41        key2: 'value1',
42    }
43);

Additional Notes

Firestore ID

This helper does not use the default Firestore Document ID format to maintain consistency. It will generate its own Document ID based on the following rules:

• 30 characters
• Alphanumeric
• Lowercase

However, you can also customize your own ID by passing a second parameter to addDocument

1...
2
3// Create a new document with your own ID
4yourCollection.addDocument(
5  {
6    key1: 'value1',
7    key2: 'value2',
8  },
9  'your-own-id',
10);
11
12...