README.md

ts-firestore-admin-helper

Typesafe Firestore Admin Helper

Instalation

Using NPM

npm install ts-firestore-admin-helper

Using Yarn

yarn add ts-firestore-admin-helper

Usage

// Start: Your Firestore initialization script
import admin from 'firebase-admin';
import FirestoreHelper from 'ts-firestore-admin-helper';

const serviceAccount = require('./firebase-service-account.json');

if (admin.apps.length === 0) {
  admin.initializeApp({
    credential: admin.credential.cert(serviceAccount),
  });
}

const firestoreAdmin = admin.firestore();
// End: Your firestore initialization script

// Start: Define your collection interface
interface YourCollectionInterface {
    key1: string;
    key2: string;
}
// End: Define your collection interface

// Start: Define your Firestore Collection
const yourCollection = new FirestoreHelper<YourCollectionInterface>(
  firestoreAdmin,
  'yourCollection'
);
// End: Define your Firestore Collection

// Create a new document
yourCollection.addDocument({
    key1: 'value1',
    key2: 'value2',
});

// Edit a document
yourCollection.editDocument(
    'document_key',
    {
        key1: 'value2',
        key2: 'value1',
    }
);

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

...

// Create a new document with your own ID
yourCollection.addDocument(
  {
    key1: 'value1',
    key2: 'value2',
  },
  'your-own-id',
);

...