FirelordJS

• fix getDocs cannot infer type from collection reference, getDocs(example.collection('...')) now return accurate type

will fix other related problems in the next version

• fix incorrect error message when in or not-in comparators trigger error (error is correct but message is not)
• Fix array const assertion (recursively)

import {
	MetaTypeCreator,
	getFirelord,
	query,
	where,
	getFirestore,
} from 'firelordjs'

const fs = getFirestore()

type ABC = MetaTypeCreator<
	{
		a: 1 | 2 | 3 // literal type
		b: ('a' | 'b' | 'c')[] // literal array type
	},
	'ABC'
>

const ColRef = getFirelord<ABC>(db, 'ABC').collection()

// literal type
query(ColRef, where('a', '>', 1)) // ok, not dealing with array
query(ColRef, where('a', 'in', [1])) // not ok, it is an array AND literal type, need const assertion!
query(ColRef, where('a', 'in', [1 as const])) // ok, const assertion!
query(ColRef, where('a', 'in', [1] as const)) // error before v2.3.2, now it is fixed

// literal array type
query(ColRef, where('b', '==', ['a'])) // not ok, dealing with array AND literal type, need const assertion!
query(ColRef, where('b', '==', ['a' as const])) // ok, const assertion!
query(ColRef, where('b', 'in', [['a' as const]])) // ok, const assertion!
query(ColRef, where('b', '==', ['a'] as const)) // // error before v2.3.2, now it is fixed
query(ColRef, where('b', 'in', [['a'] as const])) // error before v2.3.2, now it is fixed
query(ColRef, where('b', 'in', [['a']] as const)) // error before v2.3.2, now it is fixed

• remove most of the need to assert as const, greatly improve user experience when dealing with literal types (very few cases still need to assert as const)

type ABC = MetaTypeCreator<
	{
		a: 1 | 2 | 3 // literal type
	},
	'ABC'
>

const ColRef = getFirelord<ABC>(db, 'ABC').collection()

query(ColRef, where('a', '>', 1)) // before v2.3.1 this will error and require const assertion `1 as const`, now it no longer requires const assertion

• tons of housekeeping

• update documentation to the latest
• add getCountFromServer api and related tests, example:

getCountFromServer(query(example.collection(), where('a', '>', 1))).then(
	aggregatedQuerySnapshot => {
		const count = aggregatedQuerySnapshot.data().count
	}
)

Breaking:
no longer expose firestore terminate, initializeFirestore, loadBundle, clearIndexedDbPersistence, connectFirestoreEmulator, disableNetwork, enableIndexedDbPersistence, enableMultiTabIndexedDbPersistence, enableNetwork, onSnapshotsInSync, namedQuery, waitForPendingWrites, CACHE_SIZE_UNLIMITED and DocumentData to offload firelordjs responsibility

Breaking(Admin):
no longer expose firestore BulkWriter, GrpcStatus, BundleBuilder, setLogFunction, and DocumentData to offload firelord responsibility

• (web only)transpiling to cjs now does not transpile import to require(fix not working with firebase 9.17.1 https://github.com/tylim88/FirelordJS/issues/91)
• support auto generate document reference ID (v2.2.2). usage example:

const autoIdDocRef = example.doc(example.collection())

• add AbstractMetaTypeCreator to make abstractig meta type easier, see use case https://github.com/tylim88/FirelordJS/issues/90#issuecomment-1407071081
• expose DocumentData type

• allow all update operations and set merge to accept value with optional type (this sacrificed some granularity because of how exactOptionalPropertyTypes works but this is trivial, also added minimum related tests) https://github.com/tylim88/FirelordJS/issues/89
• must turn onexactOptionalPropertyTypes in tsconfig, it is no longer optional (breaking)
• expose RunTransaction and WriteBatch types

• narrow the id type of document reference
• add more tests and more code for doc

• fix incorrect id, path, and parent types of collection reference
• narrow the id type of document reference

• new way to create firelord ref
• new interface for doc, collection and collection group
• this is a big change, please read the documentation for more details
• add check for InvalidID (Cannot match the regular expression __.*__)

• fix missing in code documentation
• housekeeping in code documentation (internal)
• refactor types (internal)
• add new argument TransactionOptions to runTransaction (new feature)
• add firebase as peerDependencies
• remove the need for crypto module, this module may cause a lot of issues because it is a nodejs module(important)
• reduce compile size
• further simplify typing (internal)
• update eslint (internal)

tons of housekeeping and simplification

2 breaking changes:

• rename MetaTypeCreator setting allFieldsPossiblyUndefined as allFieldsPossiblyReadAsUndefined
• remove onSnapshot onCompletion parameter (remove 1 function overload)

collection path now check for number of forward slash

when using cursor(eg startAt) with orderBy('name'), cursor will only accept full document path as value

compile to es5 instead of es6

remove sourcemap because sourcemap requires src code to be included, which is very redundant and can cause issues to creat-react-app

now support @firebase/rules-unit-testing

example: https://github.com/tylim88/Firelordjs/blob/main/codeForDoc/src/rulesUnitTesting.test.ts

will update the doc

MetaType now able to refer to itself, CollectionReference Parent props no longer need type casting

if you already type cast it, you can remove it or leave it

ok this one is good, stable