Package Exports

firelordjs
firelordjs/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (firelordjs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

FirelordJS 烈火君JS

Extremely High Precision Typescript Wrapper for Firestore Web, Providing Unparalleled Type Safe and Dev Experience

Modular, Minuscule, Intuitive, Unopinionated, Craftsmanship, Ultimate, Peaceful, Deep

Of The VFQAT || By The VFQAT || For The VFQAT

End Firestore Typing Madness

Documentation

FirelordJS is the only library capable of providing insane type safety while exposing almost all the API of the official Firestore SDK.

FirelordJS:

Has the lowest learning curve (API is nearly identical to the original API).
Has the lowest technical debt (easy to revert to the official API).
Offer truly and most generic type safe solutions.
Is the only library capable of typing against Firestore limitations.
Offer Effortless solutions for Firestore quirks.
Has The smallest package size.

Support @firebase/rules-unit-testing and emulator

I am confident it has the best type safe and nothing come close. I put money on my words and I will buy you x cups of coffee if you:

found something better: 75 cups
created something better: 1000 cups (you don't need to a make full fledge library, something that is minimally better is enough, open an issue if you want to take this challenge)

Tests

FirelordJS is thoroughly tested, FirelordJS tests source code, built files and published package.

The tests test against real database and emulators, no mock test!

Trivial

The name Firelord is a reference to the Firelord of Avatar.

Contributing

Read here

Firelord - Typescript wrapper for Firestore Admin
FireSword - Filter Firestore and RTDB Unknown Keys.
FireCall - Helper Function to write easier and safer Firebase onCall function.
FireSageJS - Typescript wrapper for Realtime Database

Be the master of fire, be Firelord.

Upcoming V3

V3 focus on codebase overhaul, hopefully with further improved code quality, potential contributor will find it easier to work with.

Code Quality Improvements:

Simpler type logics.
Implement latest TS features.
Better file and folder structure.
Remove trivial APIs.
More Tests.
New Documentation.

New Features:

Auto narrow to literal type, remove the need to manually assert as const.
Narrow read type base on query constraint. For example where('a', '==', true) will narrow the read type of field a to true.
Mandatory field update. Example, for field like updatedAt, it is mandatory to includes it every time you update the document. There are two ways to implement these feature: via Meta Type and via abstraction. With Meta Type(using special field value), it is less flexible because we no longer able to exclude it from all update operations. With abstraction, it is more flexible but require more works from user. I prefer via abstraction due to it does not shut down other use cases despite having lower user experience.
Support wide numeric key and wide string key (Record<number, unknown> and Record<string, unknown>). It still needs more consideration because this data type is pointless to query(we need to know what the key is first, it would be better to just save the document ID somewhere) and we need to constantly aware of the document size limit. If you don't care about query and you sure that the size limit will not exceed 1 MB, then this is for you. But allowing this also open up for mistake and bad practice for those who are not aware. Most likely I will not implement this.

firelordjs