BURNBASE

Burnbase is a firebase (module-based) wrapper, to handle the functions in an easier way, with a lot of utils as lib plus

OBS: We are in the alpha version, so something can break, we'll release the first Beta version, once we have everything well tested.

How to install

You can install the package on your js-based project with:

pnpm

pnpm add burnbase@alpha # yarn-like
# or
pnpm install burnbase@alpha # npm-like

yarn

yarn add burnbase@alpha

npm

npm add burnbase@alpha

How to use

Init

In your burnbase folder (api | service | ...), you must create a file with the init scripts exposed on burnbase/app:

/src/api/init.ts

import { init } from "burnbase/app";

export const firebaseConfig = {
  apiKey: FIREBASE_API_KEY,
  authDomain: FIREBASE_AUTH_DOMAIN,
  projectId: FIREBASE_PROJECT_ID,
  storageBucket: FIREBASE_STORAGE_BUCKET,
  messagingSenderId: FIREBASE_MESSAGING_SENDER_ID,
  appId: FIREBASE_APP_ID,
};

init(firebaseConfig);

Note that, firebaseConfig constant has the same format of firebase one, so all properties are optional according with what you need to config, or you will use.

And then you have the burnbase init function, that wraps all firebase app creation flow.

Knowing that, you ready to import this code on your main file, warranting that you always has the app in all the code.

/src/main.ts

import '../api/init';

...

Now, you are able to use any burnbase and firebase function in your code.

Auth

For Firebase Auth, we have the following functions on burnbase/auth:

getLoggedInUser;
loginWithEmailAndPassword;
resetPassword;
createUser;
logout.

`getLoggedInUser`

This function returns the currentUser as Firebase User.

./get-current-user.ts

import { getLoggedInUser } from 'burnbase/auth';

export const getCurrentUser = async () => {
  const currentUser = await getLoggedInUser();

  ...

  return currentUser;
};

`loginWithEmailAndPassword`

This function returns the userCredentialInfo as Firebase UserCredential, expecting 2-3 params.

Usage (`loginWithEmailAndPassword`)

Passing only the email and password, you can login with an existing account on Firebase auth.

./login.ts

import { loginWithEmailAndPassword } from 'burnbase/auth';

export const login = async (email: string, password: string) => {
  const user = await loginWithEmailAndPassword(user, password);

  ...

  return user;
};

Advanced Usage (`loginWithEmailAndPassword`)

Passing options after passing the email and password, you can login with an existing account on Firebase auth, and verify if this account exists on firestoreCollectionName in options, and if you want you can add many more conditions to the firestoreCondition list.

./login.ts

import { loginWithEmailAndPassword } from 'burnbase/auth';

export const login = async (email: string, password: string) => {
  const user = await loginWithEmailAndPassword(
    user,
    password,
    {
      firestoreCollectionName: 'userCollection' // it will verify if the email exists on this collection, on prop email
    }
  );

  ...

  return user;
};

import { loginWithEmailAndPassword } from "burnbase/auth";

const login = async (email: string, password: string) => {
  const user = await loginWithEmailAndPassword(user, password, {
    firestoreCollectionName: "userCollection",
    firestoreCondition: [
      ["role", "==", "admin"], // it will verify if the property role is equal to "admin"
      ["status", ">", 0], // it will verify if the property status is greater than 0 (in my case, means active).
    ],
  });

  return user;
};

`resetPassword`

This function will update the password in your Firebase Auth, expecting an Firebase User and a new string password

./renew-password.ts

import { resetPassword } from "burnbase/auth";
import type { User } from "firebase/auth";

const renewPassword = async (user: User, newPassword) => {
  await resetPassword(user, newPassword);
};

`logout`

This function will kill the current user session.

./logout.ts

import { logout } from "burnbase/auth";

const logoff = async () => {
  await logout();
};

Firestore

For Firebase Firestore, we have the following functions on burnbase/firestore:

getAllData;
getPagination;
getCollection;
getCollectionRef;
getDocument;
setDocument;
updateDocument;
addDocument;
deleteDocument;
getCollectionSize;
mapQueryParams.

Understanding `queryParams`

queryParams is an object parameter composed by:

pagination;
conditions;
ordinateBy.

`pagination`

Pagination is an optional object and undefined by default, and there is some utils attributes:

Attribute	Structure
`limit`	`number` - the limit of the data that you need.
`page`	`number` (optional) - the exact page that you are looking for.
`target`	`"next"` or `"previous"` (optional) - asks for next or previous page, based on current page.
`targetDocument`*	`QueryDocumentSnapshot<DocumentData>` (optional) - the target document that you must have in the list.
`firstItem`*	`ReadonlyArray<QueryDocumentSnapshot<DocumentData>>` (option) - a list of all pages first items elements.

Note: * means that the attribute is mostly for internal use, but is ok if you find a nice tricky to use it by your own, or maybe improve the code xD.

`conditions`

Conditions is an optional list and undefined by default, and it's structure is basically based on an array with 3 position:

[<field-name>, <operator>, <value>]

Where:

<field-name>: is a string that represents the attribute on document;
<operator>: is a WhereFilterOp that represents the operation properly;
<value>: is an unknown value, that represents the matching value that you want.

Ex.1: Checking if the role is equal to admin. ['role', '==', 'admin']

Ex.2: Checking if the position represents the podium, that can be 1, 2 oe 3. ['position', 'in', [1, 2, 3]]

And then after you understand how conditions works, you can combine them into a list of conditions.

`ordinateBy`

This is the sorting field, that expect a list of sorting objects, that is represented by a label and a orderDirection.

Ex.: ordinate: [{ label: "date" }, { label: "position", orderDirection: "desc" }]

Where:

label: is a required string that presents the field to sort;
orderDirection: is an optional field that by default it's 'asc', and you can change to 'desc'.

`getCollectionRef`

This function expects a collection name, it will return a CollectionReference<DocumentData> of the collection.

Usage (`getCollectionRef`)

./get-admin-ref.ts

import { getCollectionRef } from "burnbase/firestore";

const getAdminRef = async () => {
  await getCollectionRef("admin");
};

`getCollectionSize`

This function expects a collection name and a query if needed, it will return the size of the collection

Usage (`getCollectionSize`)

./get-admin-size.ts

import { getCollectionSize } from "burnbase/firestore";

const getAdminRef = async () => {
  await getCollectionSize("admin");
};

Advanced Usage (`getCollectionSize`)

./get-admin-size.ts

import { getCollectionSize } from "burnbase/firestore";

const getActivesAdminsSize = async () => {
  await getCollectionSize("admin", {
    conditions: [["active", "==", true]],
    ordinateBy: [{ label: "createdAt" }],
  });
};

`getCollection`

This function expects a collection name and a query if needed, it will return a list of the data on the collection, with the respective uid.

Usage (`getCollection`)

./get-clients.ts

import { getCollection } from "burnbase/firestore";

const getClients = async () => {
  await getCollection<Client>("clients");
};

Advanced Usage (`getCollection`)

./get-clients.ts

import { getCollection } from "burnbase/firestore";

const getActiveClients = async () => {
  await getCollection<Client>("clients", {
    conditions: [["active", "==", true]],
    ordinateBy: [{ label: "createdAt" }],
  });
};

`getAllData`

This function expects a collection name and then a query if needed, it will return all the data on the collection.

Usage (`getAllData`)

./get-users.ts

import { getAllData } from "burnbase/firestore";

const getUsers = async () => {
  await getAllData("users")();
};

Advanced Usage (`getAllData`)

./get-admins-sorted.ts

import { getAllData } from "burnbase/firestore";

const getAdminsSorted = async () => {
  await getAllData("users")({
    conditions: [["role", "==", "admin"]],
    ordinateBy: [{ label: "name", orderDirection: "asc" }],
  });
};

./get-strict-admin-list.ts

import { getAllData } from "burnbase/firestore";

const getStrictAdminList = async () => {
  await getAllData("users")({
    pagination: { limit: 5, page: 1 },
    conditions: [["role", "==", "admin"]],
    ordinateBy: [{ label: "name", orderDirection: "asc" }],
  });
};

`getPagination`

This function expects a collection name with an optional dataCallback (a transformer function that expects the QueryDocumentSnapshot<DocumentData, DocumentData>), and then a query if needed, it will return all the data on the collection.

Usage (`getPagination`)

./get-activities.ts

import { getPagination } from "burnbase/firestore";

const getActivities = async () => {
  const {
    data, // page data
    page, // current page (number)
    next, // handler function to ask the next page
    previous, // handler function to ask the previous page
  } = await getPagination("activities")();

  ...
};

Advanced Usage (`getPagination`)

./get-activities.ts

import { getPagination } from "burnbase/firestore";

const getActiveActivities = async (defaultPage: number, pageLimit: number) => {
  const {
    data, // page data
    page, // current page
    next, // handler function to ask the next page
    previous, // handler function to ask the previous page
  } = await getPagination("activities")({
    pagination: {
      limit: pageLimit,
      page: defaultPage
    },
    conditions: [["active", "==", true]],
    ordinateBy: [{ label: "updatedAt", orderDirection: "asc" }],
  });

  ...
};

`getDocumentRef`

This function expects a collection name and the docId, it will return a DocumentReference<DocumentData> of the collection.

Usage (`getDocumentRef`)

./get-admin-ref.ts

import { getDocumentRef } from "burnbase/firestore";

const getAdminRef = async (docId: string) => {
  await getDocumentRef("admin", docId);
};

`getDocument`

This function expects a collection name and the docId, it will return the data of the document.

Usage (`getDocument`)

./get-admin.ts

import { getDocument } from "burnbase/firestore";

const getAdmin = async (docId: string) => {
  await getDocument("admin", docId);
};

`setDocument`

This function expects a collection name, a docId, and the data. It will create a new document with in the docId with this data.

Usage (`setDocument`)

./set-admin.ts

import { setDocument } from "burnbase/firestore";

const setAdmin = async (docId: string, data: Admin) => {
  await setDocument("admin", docId, data);
};

`addDocument`

This function expects a collection name, and the data. It will create a new document in with a random docId with this data.

Usage (`addDocument`)

./add-admin.ts

import { addDocument } from "burnbase/firestore";

const addAdmin = async (data: Admin) => {
  await addDocument("admin", data);
};

`deleteDocument`

This function expects a collection name, and the docId. It will delete the document in this docId.

Usage (`deleteDocument`)

./delete-user.ts

import { deleteDocument } from "burnbase/firestore";

const deleteUser = async (data: User) => {
  await deleteDocument("admin", "NlzIlLHFMcbmtK8ORodq9TvmDFR2");
};

`updateDocument`

This function expects a collection name, a docId, and the data. It will update the data in docId.

Note: The data can be only the field that you want to update

Usage (`updateDocument`)

./update-admin.ts

import { updateDocument } from "burnbase/firestore";

const updateAdmin = async (docId: string, data: Partial<Admin>) => {
  await updateDocument("admin", docId, data);
};

Storage

For Firebase Storage, we have the following functions on burnbase/storage:

addFile;
deleteFile.

`addFile`

This function expects a file, a path, and the options if needed. It will save the File inside the path, and will return the download URL.

Usage (`addFile`)

./add-image.ts

import { addFile } from "burnbase/storage";

const addImage = async (image: File) => {
  const link = await addFile(image, "pictures");

  ...
};

Advanced Usage (`addFile`)

./add-profile-image.ts

import { addFile } from "burnbase/storage";

const addProfileImage = async (image: File) => {
  const link = await addFile(image, "pictures", {
    prefix: 'profile',
    suffix: 'image',
    metadata: { // You can find more usage on the typing
      customMetadata: {
        name: 'profile-image',
        createdAt: Date.now()
      }
    }
  });

  ...
};

`deleteFile`

This function expects a storage url. It will delete the file.

Usage (`deleteFile`)

./delete-image.ts

import { deleteFile } from "burnbase/storage";

const deleteImage = async (url: string) => {
  await deleteFile(url);
};

Files

README.md

Latest commit

History

README.md

File metadata and controls

BURNBASE

How to install

pnpm

yarn

npm

How to use

Init

Auth

getLoggedInUser

loginWithEmailAndPassword

Usage (loginWithEmailAndPassword)

Advanced Usage (loginWithEmailAndPassword)

resetPassword

logout

Firestore

Understanding queryParams

pagination

conditions

ordinateBy

getCollectionRef

Usage (getCollectionRef)

getCollectionSize

Usage (getCollectionSize)

Advanced Usage (getCollectionSize)

getCollection

Usage (getCollection)

Advanced Usage (getCollection)

getAllData

Usage (getAllData)

Advanced Usage (getAllData)

getPagination

Usage (getPagination)

Advanced Usage (getPagination)

getDocumentRef

Usage (getDocumentRef)

getDocument

Usage (getDocument)

setDocument

Usage (setDocument)

addDocument

Usage (addDocument)

deleteDocument

Usage (deleteDocument)

updateDocument

Usage (updateDocument)