dalenguyen / firebase-functions-helper

A helper NPM package for Firebase Cloud Functions

firebase-functions-helper

A helper NPM package for Firebase Cloud Functions

Tables of Contents

• Installation
• Get Google Cloud Account Credentials from Firebase
• Usage
• Contributions

Installation

Install using npm.

npm install firebase-functions-helper

Get Google Cloud Account Credentials from Firebase

You can Generate New Private Key from Project Settings from Firebase Console.

After that you need to copy the databaseURL for initiating the App.

Usage

Examples

This is the first step that you need to do before doing any other actions. You still can use the other methods from firebase helpers if you initialize the app by using other methods from Firebase docs.

const { firebaseHelper }  = require('firebase-functions-helper');
const serviceAccount = require('./serviceAccountKey.json');

// Initialize Firebase App
firebaseHelper.initializeApp(serviceAccount);

If you want to use this package in TypeScript. Please follow this instruction:

import { firebaseHelper } from 'firebase-functions-helper';
import * as serviceAccount from './serviceAccountKey.json';

// Initialize Firebase App
firebaseHelper.initializeApp(serviceAccount);

In order to import JSON, you need to create a typings.d.ts in your project

// typings.d.ts
declare module "*.json" {
    const value: any;
    export default value;
}

Working with Firebase

Working with Firestore

Working with Realtime Database

Contributions

This project is based on firebase-functions-snippets, feel free to report bugs and make feature requests in the Issue Tracker, fork and create pull requests!

firebase-functions-helper's Issues

Get specifict document with subcollections

In method:
firebaseHelper.firestore
.getDocument(db, 'collection-name', 'document-id')
.then(doc => console.log(doc));

the data return dosen't include subcollections.

Limit how many documents are returned when querying firestore

There seems to be a way to easily do this in the official docs with a .limit(number)
https://firebase.google.com/docs/firestore/query-data/order-limit-data?authuser=0#order_and_limit_data

request to add createSubcollectionWithDocument and deleteDocumentFromSubcollection (or is there already a way to do this?)

I am trying to create a document in a subcollection, and then delete a document in a subcollection - is there a way I can accomplish this with the functions available? Otherwise, I would like to add:

js:

createSubcollectionWithDocument(db, collectionName, docId, collectionNameTwo, docIdTwo, data) {
        db.collection(collectionName).doc(docId).collection(collectionNameTwo).doc(docIdTwo).set(data)
            .then(res => console.log(`${JSON.stringify(data)} is added to ${collectionNameTwo} collection`))
            .catch(err => console.log('Error: ', err));
    }

deleteDocumentFromSubcollection(db, collectionName, docId, collectionNameTwo, docIdTwo) {
        db.collection(collectionName).doc(docId).collection(collectionNameTwo).doc(docIdTwo).delete()
            .then(() => {
            console.log(`${docIdTwo} successfully deleted!`);
        }).catch(error => {
            console.error("Error removing document: ", error);
        });
    }

ts:

createSubcollectionWithDocument (db: any, collectionName: string, docId: string, , collectionNameTwo: string, docIdTwo: string, data: Object): void {
        db.collection(collectionName).doc(docId).collection(collectionNameTwo).doc(docIdTwo)).set(data)
            .then(res => console.log(`${JSON.stringify(data)} is added to ${collectionNameTwo} collection`))
            .catch(err => console.log('Error: ', err))
    }

deleteDocumentFromSubcollection (db: any, collectionName: string, docId: string, collectionNameTwo: string, docIdTwo: string) {
        db.collection(collectionName).doc(docId).collection(collectionNameTwo).doc(docIdTwo).delete()
            .then(() => {
                console.log(`${docIdTwo} successfully deleted!`);
            }).catch(error => {
                console.error("Error removing document: ", error);
            });
    }

I've actually never gone about editing a package. if you can provide the steps that would be helpful (i think maybe requesting a pull? and then commiting...to master?)

Error in Backup method to get subCollections

In this line:

https://github.com/dalenguyen/firebase-functions-helper/blob/master/src/firestore.ts#L267

missing check if exist subcollections, because if not exist, get throw time-out

queryData() return only ONE RECORD

Hi @dalenguyen
I used queryData as your guide and its response only one record while FireStore has 2 records.

Can you help to check, Thank you!

app.get('/ielts-reading-level/:levelSlug', (req, res) => {
   const {levelSlug} = req.params
    const queryArray = [['levelSlug', '==',  levelSlug]];
    firebaseHelper.firestore
        .queryData(db, levelsCollection, queryArray)
        .then(data => res.status(200).send(data))
        .catch(error => {
            console.error('ERROR::: ', error)
            res.status(500).send(error.message)
        })
})

Response:

{
    "PfX9074Z1uvaMT18djas": {
        "name": "Children",
        "description": "For children",
        "levelSlug": "level1",
        "slug": "level1"
    }
}

Helper functions don't return the promise always

Functions like createDocumentWithID, createNewDocument and updateDocument do not return the Firebase promise.

This makes it impossible to chain functions use the Promise methods.

can admin sdk be accessed using firebase-functions-helper

I am trying to make firebaseHelper.firebase.auth().verifyIdToken()

looking for alternative way to achieve this

Basically in my app

1. validating the idToken
2. if user is valid then he can perform crud operations

Service account does not recognize project_id

Hey,

I wanted to use your library to upload a json with an auto-generated id to firestore.
As I was using firestore-import-export and it worked quite well, I wanted to switch over to this lib, as it has the auto-generated id.
Nevertheless, when I try to call initializeApp with the serviceAccount it says:

Error: Service account object must contain a string "project_id" property.

Even though it has this value in the serviceaccount.json file I have downloaded from firebase. It is also the same file that was working with the firestore-import-export lib.

any help :) ?

Update document

Hi @dalenguyen,

I have seen the breaking change in function queryData between 0.6.3 and 0.6.4. You should notice about it in README.md on git repository homepage.

Thank you!

Object.entries is not a function un backup

Hi, when i call this line:

firebaseHelper.firestore.backup(firestoreInstance, 'Categories', 'Subcollection')

appear this error:

TypeError: Object.entries is not a function
    at FirestoreHelper.<anonymous> (/user_code/node_modules/firebase-functions-helper/dist/firestore.js:268:47)
    at next (native)
    at /user_code/node_modules/firebase-functions-helper/dist/firestore.js:7:71
    at __awaiter (/user_code/node_modules/firebase-functions-helper/dist/firestore.js:3:12)
    at FirestoreHelper.getSubCollection (/user_code/node_modules/firebase-functions-helper/dist/firestore.js:267:16)
    at results.then.dt (/user_code/node_modules/firebase-functions-helper/dist/firestore.js:244:26)
    at process._tickDomainCallback (internal/process/next_tick.js:135:7)

Create multiple users in Aaray

I saw the documentation of being able to create a
Single user but I would like to pass an array of data
To create multiple users. Is this possible?

*I am using firebase real-time database and storage

I need create subcollection with document

Hi, i need create a subcollection with a exist document or not, how i can do?

Wrong status when deleting document has error

firebase-functions-helper/src/firestore.ts

Line 89 in 56a22f4

return { status: true, message: error };

How to write our own implementations

Hello.Thanks for this amazing package. This sound like stupid question.But I really like to add my own implementations to this package.How to do it ? For example instead of updating a document is it possible to write code segment to append items into a firestore document? I tired to do it by reading firestore documentation. But didn't work. My question If can add something that to which file should I add those custom code parts ?Thank you

Could not find a declaration file for module 'firebase-functions-helper'

Good morning,
Im getting:

[ts]
Could not find a declaration file for module 'firebase-functions-helper'. 'c:/Projects/firebase-typescript-express-functions/node_modules/firebase-functions-helper/dist/index.js' implicitly has an 'any' type.
Try npm install @types/firebase-functions-helper if it exists or add a new declaration (.d.ts) file containing declare module 'firebase-functions-helper'; [7016]

When I attempt to npm install firebase-functions-helper

Any ideas?

Can't find declaration file

Receiving this error

src/index.ts:4:33 - error TS7016: Could not find a declaration file for module 'firebase-functions-helper'. '/Users/asdf/Developer/git/Personal/my-api/functions/node_modules/firebase-functions-helper/dist/index.js' implicitly has an 'any' type.
Try npm install @types/firebase-functions-helper if it exists or add a new declaration (.d.ts) file containing declare module 'firebase-functions-helper';

Fix typo error in function name

firebase-functions-helper/src/firestore.ts

Line 26 in e710a38

creatNewDocument (db: any, collectionName: string, data: Object) {

Current name: creatNewDocument (missing letter e)
Right name: createNewDocument

Error: firebase-admin/lib/database/index"' has no exported member 'admin'

Hi,

I'm using the latest firebase-functions-helper, and all works well on the local emulator, but when i try to do firebase deploy, i get the following error:

node_modules/firebase-functions-helper/dist/firebase.d.ts:15:57 - error TS2694: Namespace '"/Users/xx/code/xxx/xxx/functions/node_modules/firebase-admin/lib/database/index"' has no exported member 'admin'.

15         realtime: import("firebase-admin/lib/database").admin.database.Database;
                                                           ~~~~~

This is my full code of functions/index.ts:

import * as functions from "firebase-functions";
import * as firebaseHelper from "firebase-functions-helper";
import * as express from "express";
import * as serviceAccount from "../../XXXX.json";
import * as bodyParser from "body-parser";

const databaseURL = "https://XXXXXXX";
// Initialize Firebase App
const fire = firebaseHelper.firebase.initializeApp(serviceAccount, databaseURL);

const db = fire.firestore;
const app = express();
const main = express();

main.use(bodyParser.json());
main.use(bodyParser.urlencoded({ extended: false }));
main.use("/api/v1", app);

const bookingsCollection = "bookings";

export const webApi = functions.https.onRequest(main);

app.get("/bookings", (req, res) => {
  firebaseHelper.firestore
    .backup(db, bookingsCollection)
    .then((data) => res.status(200).send(data))
    .catch((error) => res.status(400).send(`Cannot get bookings: ${error}`));
});

export { app };

i'm not sure if its an issue with the firebase-functions-helper or firebase-admin. i have another project with the exact same code and it works fine there...

any help is greatly appreciated!

Query two parameters

Is possible to query two parameters?

Something like:

const queryArray = [['website', '==', 'dalenguyen.me'],['status', '==', '200']];

Regards

Victor

FirebaseHelper backup undefined error

While using v0.11.0, I noticed that calls to firebaseHelper.firestore.backup() resulted in a cannot read property 'backup; of undefined error. I had to switch to v0.7.5. The implementation of the backup function in the two versions is different.

[email protected] - has no exported member 'admin' error

Hey,
I'm getting an error:

node_modules/firebase-functions-helper/dist/firebase.d.ts:15:57 - error TS2694: Namespace '".../functions/node_modules/firebase-admin/lib/database/index"' has no exported member 'admin'.

15         realtime: import("firebase-admin/lib/database").admin.database.Database;
                                                           ~~~~~

could you please update the package to support [email protected]
Thanks

Support multiple query

this.afStore.collection('listings', ref => {
				let query: firebase.firestore.Query = ref;
				
				if (filter.listing_type) { query = query.where('listing_type', '==', filter.listing_type) };
				if (filter.province) { query = query.where('province', '==', filter.province) };
				query = query.where('status', '==', 1);
				query = query.orderBy('created_date', 'desc').limit(10);
				
				

				return query;
			}).valueChanges().subscribe(callback);

would you mind if I PR?

Support orderBy for queryData

Please support orderBy for queryData.