Firehelper NPM

Firehelper

A Node.js package designed for software testing, enabling the deletion of documents in Firestore based on flexible queries.

Installation

Clone the repository:

git clone https://github.com/yourusername/firehelper.git
cd firehelper

npm install

Configuration

Step 1: Set Up Firebase

Go to the Firebase Console.
Click on your project (or create a new project if you don't have one).
Navigate to the Project Settings by clicking the gear icon.
Under the Service Accounts tab, click on Generate New Private Key. This will download a JSON file to your computer. Save this file as serviceAccountKey.json.

Step 2: Add `serviceAccountKey.json` to Your Project

Move the downloaded serviceAccountKey.json file to the src directory of your project.

Step 3: Update `firebaseConfig.js`

Make sure your firebaseConfig.js points to the correct location of the serviceAccountKey.json file:

const admin = require('firebase-admin');
const path = require('path');

const serviceAccount = require(path.join(__dirname, 'serviceAccountKey.json'));

admin.initializeApp({
  credential: admin.credential.cert(serviceAccount)
});

const db = admin.firestore();

module.exports = db;

Usage

You can use the package to delete documents in Firestore based on flexible queries.

Example Usage

const { deleteByQuery, deleteAllDocuments } = require('./src/index');

const run = async () => {
  try {
    // Example to delete by flexible query
    const resultByQuery = await deleteByQuery('user@example.com', 'notes', [
      { key: 'title', value: 'Some Title' },
      { key: 'userId', value: 'userId' }
    ]);
    console.log(resultByQuery);

    // Example to delete all documents
    const resultAllDocuments = await deleteAllDocuments('user@example.com', 'notes');
    console.log(resultAllDocuments);
  } catch (error) {
    console.error('Error:', error.message);
  }
};

run();

Functions

`deleteByQuery(email, collectionName, queryFields)`

Deletes documents based on a flexible query.

email: The user's email address.
collectionName: The name of the collection in Firestore.
queryFields: An array of query field objects. Each object should have a key and value. If value is 'userId', it will be replaced with the user's ID.