FirelordJS 烈火君JS

           

High Precision Firestore Web Typescript Wrapper, Providing Unparalleled Type Safety and Dev Experience

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

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

Be The Master Of Your Fire, Be Firelord

Beyond Typing

Doc

FirelordJS

FirelordJS is the only library capable of providing truly generic type safety while exposing almost all the API of the official Firestore SDK. The goal is to end Firestore typing madness.

Example of how Firelord transforms ServerTimestamp type in different operations:

FirelordJS:

• Lowest learning curve. API is nearly identical to the original API and simpler: Eliminates the repetitive tasks of writing collections ID and assigning the Firestore instance.
• Technical debt is the lowest (easy to revert to the official API).
• Minimum types creation and no type assertion.
• Offers truly generic type safe solutions, declare any data shape and unions.
• Supports deeply nested object type: Record<string,Record<string,Record<string,...>>>, max 1000 levels.
• Supports deeply nested sub collection, all children can track back all their ancestors type, max 100 generations.
• Generates all possible flatten paths combinations based on your declared type(e.g.: a, a.b, a.b.c, a.b.d, a.x, a.x.y, a.x.z) with type safety.
• Generates different types for different operations, see Transformative Types for complete list of type transformations.
• Package size is the smallest, 3 KB!
• Code generation and domain specific language are not required, just pure Typescript all the way.
• Supports @firebase/rules-unit-testing and emulator, no extra API is needed!
• Beyond source code testing, we also test built files and published package. (test source code -> build -> test built files -> publish -> test published files)
• No mock test, all 250 tests test against live database to ensure the highest certainty.

Firelord is the only library capable of typing against Firestore limitations. It also blocks undocumented errors and prevent pesky runtime errors like empty array errors filter, cursors and implicit data deletion in update operation. Firelord provides over 30 custom error messages to assist you in writing proper Firestore code! Here is an example:

Bounty

I am confident Firelord is the best among its kind in terms of best safety and developer experience. I stand behind my words, and I will buy you x cups of coffee if you:

1. find something better: 300 cups
2. created something better: 3000 cups.

The bounty has been available and keeps increasing since July 14, 2022.

Nested Composite Query Rulings

(Web feature only, admin can skip this section)

Rulings for or & and composite query are ready, rulings works with nested query, example:

Official SDK runtime error:

Firelord compile time error:

It has all the regular rulings plus new composite rulings. See also peeling composite query error messages

Eslint False Errors

Below ESLint rules give false error, please turn them off.

{
	"rules": {
		"@typescript-eslint/no-unsafe-assignment": "off",
		"@typescript-eslint/no-unsafe-call": "off",
		"@typescript-eslint/no-redundant-type-constituents": "off",
		"@typescript-eslint/no-unsafe-return": "off",
		"@typescript-eslint/no-unsafe-member-access": "off"
	}
}

ESM? CommonJS?

(Web version's issue only, admin can skip this section)

FirelordJS built files are a bit complicated. It is not an ESM module(no "type":"module" in package.json) but it also does not transpile import statements to CommonJS.

Results tested with various build tools:

1. (Default) Non ESM with import statements (Pseudo ESM)

• ✅ works with create-react-app
• ✅ works with @vitejs/plugin-react-swc
• ✅ works with @sveltejs/vite-plugin-svelte
• ✅ works with nextjs with next-transpile-modules
• ❌ does not work with @sveltejs/kit/vite

2. Real ESM (Not available on NPM)

• ✅ works with @vitejs/plugin-react-swc
• ✅ works with @sveltejs/vite-plugin-svelte
• ✅ works with nextjs with next-transpile-modules
• ❌ does not work with create-react-app, see issue
• ❌ does not work with @sveltejs/kit/vite see issue

3. CommonJS

• ❌ does not work with create-react-app
• ❌ does not work with @vitejs/plugin-react-swc
• ❌ does not work with @sveltejs/vite-plugin-svelte
• ✅ works with nextjs.
• ✅ works with @sveltejs/kit/vite

Using CommonJS Firelord with Firebase v9.17.0 and beyond break most of the build tools because of this Firebase issue

Pseudo ESM has the highest compatibility which is why it is the default package. If you see cannot use import statement outside a module error, please install the CommonJS version with

npm i firelordjs@cjs

Types That You Need To Pay Attention To

These are types that are supported but be careful when using them. They are not limitations, but how things work.

Record<string, something> Support

By design Firelord banned mapped type, this was until version 2.5.10. To understand why mapped was banned in the first place and why it is possible now, see this issue. In short, querying mapped type requires extra information, make sure you know what you are doing.

Object Unions Type

Object unions type was banned before v2.6.2 because it brings uncertainty that cannot be handled reasonably. For example, with {a:number}|{b:string}, you can set {a:1} then update {b:"x"}, in this case the type is no longer unions type but an intersection type: {a:number} & {b:string}. This limitation is lifted to allow users to fully utilize discriminated unions. Plus in future update operation Mandatory Field could mitigate this problem.

TO DO

• 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 tuple data type.

• Replace set merge with upset(update if exists, else set). It will receive 1 doc ref argument and 2 data arguments(partial data and complete data). It will attempt to update the document with partial data or create a document with complete data if the document does not exist.

• More in code documentation and tests.

• Add support for V2 Firestore function triggers(for Firelord admin version only).

Dropped TO DO

• Support for optional (? modifier). Optional is a highly requested feature because of how common it is, however because of how Firestore works: it is impossible to query a missing field. Example: it is impossible to query user that has no phone number if phone number field does not exist. Because of this, it is important to make sure every field exists. You may not need the field now, but you may need it later plus adding default value is simple, especially with such powerful typing library like Firelord. So in order to not accidentally cripple your query in the future, I will not implement this feature. Yes, set merge basically lead to the same problem, hence I encourage you to use upset instead (will be available in the future).

• Narrow read type base on query constraint. For example where('a', '==', true) will narrow the read type of field a to true, it should be able to narrow down complex case like where('a.b.c', '==', { d:[{e:1}] }). Expected to support == comparator for all types and possibly != comparator for literal type(type filtering for!= comparator poses great complexity hence I may not work on it). Update: I decided to give this up because with the introduction of composite query, it will be extremely difficult to implement this. Plus unlike narrowing down write type, narrowing down the read type does not contribute to type safety, it just makes thing slightly simpler(skip exhaustive check).

TO FIX

1. Bytes type is not working correctly and is unusable.
2. The rule You can use at most one array-contains or array-contains-any clause per query. You can't combine array-contains with array-contains-any is not enabled, see this release note
3. The type check of composite query (or() / and()) value is wrong if the field is __name__ of collection reference, example: query(collectionRef, or(where("__name__", "==", "id_only_not_full_path"))) result in false negative because Firelord will ask for full path but we only need full path if the reference is group collection.
4. Significant lag when trying to import anything from the library. (turn out this is due to Import Cost VS Code extension. This extension is no longer maintained, please uninstall it.)

Trivial

• The name Firelord is a reference to the Firelord of Avatar.
• Undocumented releases are README updates.
• Documentation Github

Related Projects

1. FirelordJS - Typescript wrapper for Firestore Web.
2. Firelord - Typescript wrapper for Firestore Admin.
3. FireSageJS - Typescript wrapper for Realtime Database Web
4. Firelordrn - Typescript wrapper for Firestore React Native
5. FireSage - Typescript wrapper for Realtime Database Admin.