Firefose

Firefose is a Firebase object modeling tool designed to work in an asynchronous environment.

Installation

Use the package manager npm to install Firefose.

npm install firefose --save
yarn add firefose

Importing

// Using Node.js
const firefose = require('firefose');

// Using ES6 imports
import firefose from 'firefose';

Connection

You can connect to Firefose using services account key from firebase. Details of admin account SDK can be found here.

Connect methods has 2 parameters.

• credentials- which should be an object with following keys.
  • project_id: (required)
  • private_key: (required)
  • client_email: (required)
  • type: (optional)
  • private_key_id: (optional)
  • client_id: (optional)
  • auth_uri: (optional)
  • token_uri: (optional)
  • auth_provider_x509_cert_url: (optional)
  • client_x509_cert_url: (optional)

const {connect} = require('firefose');

const credentials = {
    type: 'type',
    project_id: "project_id",
    private_key_id: "private_key_id",
    private_key: "private_key",
    client_email: "client_email",
    client_id: "client_id",
    auth_uri: "auth_uri",
    token_uri: "token_uri",
    auth_provider_x509_cert_url: "auth_provider_x509_cert_url",
    client_x509_cert_url: "client_x509_cert_url"
}

await connect(credentials, "databaseURI")

Types

Firefose supports following data types.

• String: string
• Number: number (integer or float)
• Boolean: boolean
• Object: Javascript object
• Array: Javascript array
• Date: Javascript date
• ObjectId: Reference to other schema

Schema

Next you can build schema. Schema constructor has 2 parameters.

• Schema Definations - Each Key in schema can have following properties.
  • type: Type from Firefose types
  • required (optional): Boolean indicatiing if the field is required
  • default (optional): Any data type specifying default value
  • ref (optional): string reference of to other schemas
• Options (optional)
  • Timestamp: Boolean value (Default false)

const {Schema} = require('firefose');
const {SchemaTypes} = require('firefose');
const {String, Number, Array} = SchemaTypes;

const userSchema = new Schema({
    name: {
        type: String,
        required: true
    },
    email: {
        type: String,
        required: true
    },
    active: {
        type: Number,
        default: 1
    },
    password: {
        type: String,
        required: true
    }
}, {timestamp: true});

Model

You can create model from the schema. It requires 2 parameters.

• collection: String value for the firestore collection
• schema: An instance of Schema.

const {Model} = require('firefose');

const User = new Model("users", userSchema);

Usage

Model object has following methods

create

This methods creates a document in the respective firestore collection.

Requires

• data: An object of the data to be stored in firestore
• docId (optional): String value for the document id

Returns

• A promise of the data stored in the firestore collection

const data = await User.create({name: "John Doe", email: "[email protected]", password: "123456"});
/*
{
  id: 'kWVzukkK2XXqhmJkS6Lb',
  name: 'John Doe',
  email: '[email protected]',   
  password: '123456',        
  active: 1
}
*/

findById

This methods returns a single document from the collection.

Requires

• id: id of the document

Returns

• Promise of the data from collection

const data = await User.findById('kWVzukkK2XXqhmJkS6Lb');
/*
{
  id: 'kWVzukkK2XXqhmJkS6Lb',
  name: 'John Doe',
  email: '[email protected]',   
  active: 1,
  password: '123456'
}
*/

find

This method can be used to get one or more documents from firestore.

Requires

• query: An object of type Query (You can find the documentation of query at the end) Returns
• Promise of the data from collection

Different usages of this method are as following:

//returns all the  posts in collection
const query = new Query();
const posts = Post.find(query);
/*
[
  {
    id: 'qXdmXL1ebnE2aAMRJLBt',
    user: { id: 'NLQklOyIeP6FChAPtMck' },
    createdAt: 2022-06-20T14:17:53.986Z, 
    updatedAt: 2022-06-20T14:17:53.986Z, 
    content: 'This is a test post',      
    title: 'Hello World 2'
  },
  {
    id: 'zHsHFjSQ0MCcrIgnilN1',
    user: { id: 'NLQklOyIeP6FChAPtMck' },
    title: 'Hello World',
    createdAt: 2022-06-20T14:16:04.658Z,
    updatedAt: 2022-06-20T17:35:34.088Z,
    content: 'content updated'
  }
]
*/

// returns conditional data
const query = new Query()
        .where('title', '==', 'Hello World')
        .orderBy('createdAt', 'desc')
        .limit(1)
        .offset(2);
const data = await User.find(query);
/*
[
  {
    id: 'TBI3l7bp0YCNZfoOlKuR', 
    active: 1,
    email: 'sdfsdfsdf',
    name: 'John Doe',
    password: '123456'
  }
]
*/

// returns posts populated with users
const query = new Query()
        .populate('user');
const posts = await Post.find(query);
/*
[
  {
    id: 'qXdmXL1ebnE2aAMRJLBt',
    updatedAt: 2022-06-20T14:17:53.986Z,
    content: 'This is a test post',     
    createdAt: 2022-06-20T14:17:53.986Z,
    user: {
      id: 'NLQklOyIeP6FChAPtMck',       
      posts: 'aa',
      email: 'sdfsdfsdf',
      name: 'jack',
      password: '123456',
      active: 1
    },
    title: 'Hello World 2'
  },
  {
    id: 'zHsHFjSQ0MCcrIgnilN1',
    content: 'content updated',
    updatedAt: 2022-06-20T17:35:34.088Z,
    title: 'Hello World',
    user: {
      id: 'NLQklOyIeP6FChAPtMck',
      password: '123456',
      name: 'jack',
      email: 'sdfsdfsdf',
      posts: 'aa',
      active: 1
    },
    createdAt: 2022-06-20T14:16:04.658Z
  }
]
*/

updateById

This method can be used to update the content of an existing document in collection.

Requires

• id: Id of the document
• data: Data to be updated

Returns

• Promise of the id

const data = await User.updateById('TBI3l7bp0YCNZfoOlKuR', {password: 'new password'});
/*
TBI3l7bp0YCNZfoOlKuR
*/

update

This method can be used to update one or more documents from firestore.

Requires

• query: An object of type Query (You can find the documentation of query at the end) Returns
• Promise of the data from collection

// updates all the documents in collection
const query = new Query()
query.where('title', '==', 'Helo World');
const result = await Posts.update(query, { name: 'Updated Title' })

/*
[
  {
    id: 'qXdmXL1ebnE2aAMRJLBt',
    updatedAt: 2022-06-20T14:17:53.986Z,
    content: 'This is a test post',
    createdAt: 2022-06-20T14:17:53.986Z,
    user: {
      id: 'NLQklOyIeP6FChAPtMck',
      posts: 'aa',
      email: 'sdfsdfsdf',
      name: 'jack',
      password: '123456',
      active: 1
    },
    title: 'Updated Title'
  }
]
*/

deleteById

This method can be used to delete an existing document in collection.

Requires

• id: Id of the document

Returns

• Promise of the id

const data = await User.deleteById('TBI3l7bp0YCNZfoOlKuR');
/*
TBI3l7bp0YCNZfoOlKuR
*/

delete

This method can be used to delete one or more documents from firestore.

Requires

• query: An object of type Query (You can find the documentation of query at the end) Returns
• Promise of the ids of data from collection

// delete all the documents in collection
const query = new Query()
query.where('title', '==', 'Helo World');
const result = await Posts.delete(query)

// [ 'qXdmXL1ebnE2aAMRJLBt', 'zHsHFjSQ0MCcrIgnilN1' ]

Query

You can create model from the schema. It requires 2 parameters.

• collection: String value for the firestore collection
• schema: An instance of Schema.

const query = new Query();

Usage

Query object has following methods

where

This method can be used to add where clause to the query.

Requires

• field: Name of the field which should be s string
• operator: Operator to be used which should be
  • ==
  • !=
  • <
  • <=
  • >
  • >=
  • array-contains
  • in
  • array-contains-any
  • not-in
• value: Value to be compared

Returns

• query object

const query = new Query();
query.where('name', '==', 'John Doe');

orderBy

This method can be used to add order by clause to the query.

Requires

• field: Name of the field which should be s string
• direction: Direction of the order which should be
  • asc
  • desc

Returns

• query object

const query = new Query();
query.orderBy('name', 'asc');

limit

This method can be used to add limit clause to the query.

Requires

• limit: Number of documents to be returned

Returns

• query object

const query = new Query();
query.limit(10);

offset

This method can be used to add offset clause to the query.

Requires

• offset: Number of documents to be skipped

Returns

• query object

const query = new Query();
query.offset(10);

populate

This method can be used to add populate clause to the query while finding documents.

Requires

• field: Name of the field which should be s string

Returns

• query object

const query = new Query();
query.populate('user');

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT