active-firestore

!CI
!codecov

Firestore sdk which has ActiveRecord like syntax

Features

- 🚀 No dependencies
- ⚡️ Lightweight
- ✏️ Less code
- 💪 Type strong(Written in TypeScript)
- 🔧 Customizable(You can add any methods you want)
- 📚 Usable in nested collections
- 🕒 Convert firestore.Timestamp to Date automatically

Usage

$3

``shell
yarn add active-firestore


or npm intall active-firestore


`

$3

`ts
/ src/plugins/firestore.ts /
import firebase from 'firebase/app'
import 'firebase/firestore'

// TODO: Replace the following with your app's Firebase project configuration
const firebaseConfig = {
// ...
};

if (firebase.apps.length === 0) firebase.initializeApp(firebaseConfig)
export const db = firebase.firestore()
`

#### NOTE: if you use firebase-admin, you should install a firebase package and initialize as below
`ts
import admin from "firebase-admin";
import { firestore } from 'firebase/app' // for type assertion

if (admin.apps.length === 0) admin.initializeApp();
const db = (admin.firestore() as unknown) as firestore.Firestore;
`

$3

`ts
/ src/models/Application.ts /
import { Base, BaseObject } from 'active-firestore'
import { db } from '../plugins/firebase'

export class Application extends Base {
get baseProps(): typeof Base.prototype.props {
return { db }
}
}
`

$3

For example,
- root collection: users
- name: string
- child collection: posts
- title: string
- body: string

`ts
/ src/models/User.ts /
import { Application } from './Application'

type TUser = {
name: string
}

export class User extends Application {
get props(): typeof Application.prototype.props {
return {
collectionName: 'users',
}
}
}
`

`ts
/ src/models/Post.ts /
import { Application } from './Application'
import { User } from './User'

type TPost = {
title: string
body: string
}

export class Post extends Application {
get props(): typeof Application.prototype.props {
return {
collectionName: 'posts',
parent: User, // Set parent model
}
}
}
`

$3

`ts
/ src/index.ts /
import { User } from '../models/User'
import { Post } from '../models/Post'

const userId = 'USER_ID'
const userDAO = new User(userId)
// Create
await userDAO.create({ name: 'user1' }) // or await new User().create({ name: 'user1' })
// Create with ID
await userDAO.create({ name: 'user1', id: 'USER_1' }) // firestore documentID will be USER_1
// Read
const userData = await userDAO.find()
// Read all
const usersData = await userDAO.all() // or await new User().all()
// Read all (limit 10)
const usersDataWithLimit = await userDAO.all({ limit: 10 }) // or await new User().all({ limit: 10 })
// Update
await userDAO.update({ name: 'user1-renamed' })
// Delete
await userDAO.destroy()

const postId = 'POST_ID'
const postDAO = new Post([userId], postId) // Path parent documentID in array
// Create
await postDAO.create({ title: 'title1', body: 'body1' }) // or await new Post([userId]).create({ title: 'title1', body: 'body1' })
// Read
const postData = await postDAO.find()
// Update
await postDAO.update({ title: 'title1-changed', body: 'body1-changed' })
// Delete
await postDAO.destroy()

// More nested (Comment is Post's child)
const commentDAO = new Comment([userId, postId], commentId)
`

Q. Why not syntax such as Post.find

$3

In Firestore, when you get data from post collection(example given above), you need not only postId but also userId(parent documentID). So:
`ts
Post.create(userId, { title: 'title1' }) // It's confusing! You use Post but API require userId
Post.find(userId, postId) // Not bad...?
Post.update(userId, postId, { title: 'title-changed' }) // It's confusing!
Post.destroy(userId, postId) // It's confusing!
``