firestore-schema-kit 1.0.0 → 2.1.0

package/dist/operations.js

@@ -0,0 +1,184 @@
+import { addDoc, collection, deleteDoc as _deleteDoc, doc, getDoc as _getDoc, getDocs as _getDocs, onSnapshot as _onSnapshot, query, runTransaction as _runTransaction, setDoc as _setDoc, updateDoc as _updateDoc, writeBatch, } from 'firebase/firestore';
+function assertSchema(schema, opName) {
+    if (!schema || typeof schema !== 'object' || schema._type !== 'CollectionSchema') {
+        throw new TypeError(`${opName}: first argument must be a CollectionSchema from defineCollection(). ` +
+            `Got: ${typeof schema}`);
+    }
+}
+function resolveDocRef(db, schema, idOrRef) {
+    if (typeof idOrRef === 'string') {
+        return doc(db, schema._name, idOrRef);
+    }
+    if (idOrRef && typeof idOrRef.path === 'string') {
+        return idOrRef;
+    }
+    throw new TypeError(`Expected a document ID (string) or DocumentReference, got: ${typeof idOrRef}`);
+}
+function collectionRef(db, schema) {
+    return collection(db, schema._name);
+}
+function docToData(snapshot) {
+    if (!snapshot.exists())
+        return null;
+    return { id: snapshot.id, ...snapshot.data() };
+}
+function snapshotToArray(querySnapshot) {
+    return querySnapshot.docs.map((docSnapshot) => ({
+        id: docSnapshot.id,
+        ...docSnapshot.data(),
+    }));
+}
+function shouldValidatePartial(options) {
+    const hasMergeFlag = 'merge' in options && Boolean(options.merge);
+    const hasMergeFields = 'mergeFields' in options && Array.isArray(options.mergeFields);
+    return hasMergeFlag || hasMergeFields;
+}
+export function initFirestoreSchema(db) {
+    if (!db)
+        throw new Error('initFirestoreSchema: db (Firestore instance) is required');
+    async function createDoc(schema, data) {
+        assertSchema(schema, 'createDoc');
+        const validated = schema.validate(data);
+        const ref = await addDoc(collectionRef(db, schema), validated);
+        return ref;
+    }
+    async function setDoc(schema, idOrRef, data, options = {}) {
+        assertSchema(schema, 'setDoc');
+        const ref = resolveDocRef(db, schema, idOrRef);
+        const validated = shouldValidatePartial(options)
+            ? schema.validatePartial(data)
+            : schema.validate(data);
+        await _setDoc(ref, validated, options);
+    }
+    async function updateDoc(schema, idOrRef, data) {
+        assertSchema(schema, 'updateDoc');
+        const ref = resolveDocRef(db, schema, idOrRef);
+        const validated = schema.validatePartial(data);
+        await _updateDoc(ref, validated);
+    }
+    async function deleteDoc(schema, idOrRef) {
+        assertSchema(schema, 'deleteDoc');
+        const ref = resolveDocRef(db, schema, idOrRef);
+        await _deleteDoc(ref);
+    }
+    async function getDoc(schema, idOrRef) {
+        assertSchema(schema, 'getDoc');
+        const ref = resolveDocRef(db, schema, idOrRef);
+        const snapshot = await _getDoc(ref);
+        return docToData(snapshot);
+    }
+    async function getDocs(schema, ...constraints) {
+        assertSchema(schema, 'getDocs');
+        const ref = collectionRef(db, schema);
+        const q = constraints.length ? query(ref, ...constraints) : ref;
+        const snapshot = await _getDocs(q);
+        return snapshotToArray(snapshot);
+    }
+    function getDocRef(schema, id) {
+        assertSchema(schema, 'getDocRef');
+        return doc(db, schema._name, id);
+    }
+    function getCollectionRef(schema) {
+        assertSchema(schema, 'getCollectionRef');
+        return collectionRef(db, schema);
+    }
+    function onDocSnapshot(schema, idOrRef, callback, onError) {
+        assertSchema(schema, 'onDocSnapshot');
+        const ref = resolveDocRef(db, schema, idOrRef);
+        return _onSnapshot(ref, (snapshot) => callback(docToData(snapshot)), onError);
+    }
+    function onCollectionSnapshot(schema, callback, ...constraints) {
+        assertSchema(schema, 'onCollectionSnapshot');
+        const ref = collectionRef(db, schema);
+        const q = constraints.length ? query(ref, ...constraints) : ref;
+        return _onSnapshot(q, (snapshot) => callback(snapshotToArray(snapshot)));
+    }
+    function createBatch() {
+        const batch = writeBatch(db);
+        const schemaBatch = {
+            create(schema, data) {
+                assertSchema(schema, 'batch.create');
+                const validated = schema.validate(data);
+                const ref = doc(collectionRef(db, schema));
+                batch.set(ref, validated);
+                return ref;
+            },
+            set(schema, idOrRef, data, options = {}) {
+                assertSchema(schema, 'batch.set');
+                const ref = resolveDocRef(db, schema, idOrRef);
+                const validated = shouldValidatePartial(options)
+                    ? schema.validatePartial(data)
+                    : schema.validate(data);
+                batch.set(ref, validated, options);
+                return schemaBatch;
+            },
+            update(schema, idOrRef, data) {
+                assertSchema(schema, 'batch.update');
+                const ref = resolveDocRef(db, schema, idOrRef);
+                const validated = schema.validatePartial(data);
+                batch.update(ref, validated);
+                return schemaBatch;
+            },
+            delete(schema, idOrRef) {
+                assertSchema(schema, 'batch.delete');
+                const ref = resolveDocRef(db, schema, idOrRef);
+                batch.delete(ref);
+                return schemaBatch;
+            },
+            commit() {
+                return batch.commit();
+            },
+        };
+        return schemaBatch;
+    }
+    async function runTransaction(updateFn) {
+        return _runTransaction(db, async (firestoreTx) => {
+            const transaction = {
+                async get(schema, idOrRef) {
+                    assertSchema(schema, 'transaction.get');
+                    const ref = resolveDocRef(db, schema, idOrRef);
+                    const snapshot = await firestoreTx.get(ref);
+                    return docToData(snapshot);
+                },
+                set(schema, idOrRef, data, options = {}) {
+                    assertSchema(schema, 'transaction.set');
+                    const ref = resolveDocRef(db, schema, idOrRef);
+                    const validated = shouldValidatePartial(options)
+                        ? schema.validatePartial(data)
+                        : schema.validate(data);
+                    firestoreTx.set(ref, validated, options);
+                    return transaction;
+                },
+                update(schema, idOrRef, data) {
+                    assertSchema(schema, 'transaction.update');
+                    const ref = resolveDocRef(db, schema, idOrRef);
+                    const validated = schema.validatePartial(data);
+                    firestoreTx.update(ref, validated);
+                    return transaction;
+                },
+                delete(schema, idOrRef) {
+                    assertSchema(schema, 'transaction.delete');
+                    const ref = resolveDocRef(db, schema, idOrRef);
+                    firestoreTx.delete(ref);
+                    return transaction;
+                },
+            };
+            return updateFn(transaction);
+        });
+    }
+    return {
+        createDoc,
+        setDoc,
+        updateDoc,
+        deleteDoc,
+        getDoc,
+        getDocs,
+        getDocRef,
+        getCollectionRef,
+        onDocSnapshot,
+        onCollectionSnapshot,
+        createBatch,
+        runTransaction,
+    };
+}
+//# sourceMappingURL=operations.js.map

package/dist/operations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"operations.js","sourceRoot":"","sources":["../operations.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,MAAM,EACN,UAAU,EACV,SAAS,IAAI,UAAU,EACvB,GAAG,EACH,MAAM,IAAI,OAAO,EACjB,OAAO,IAAI,QAAQ,EACnB,UAAU,IAAI,WAAW,EACzB,KAAK,EACL,cAAc,IAAI,eAAe,EACjC,MAAM,IAAI,OAAO,EACjB,SAAS,IAAI,UAAU,EACvB,UAAU,GACX,MAAM,oBAAoB,CAAA;AAgH3B,SAAS,YAAY,CACnB,MAAe,EACf,MAAc;IAEd,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAK,MAA6B,CAAC,KAAK,KAAK,kBAAkB,EAAE,CAAC;QACzG,MAAM,IAAI,SAAS,CACjB,GAAG,MAAM,uEAAuE;YAC9E,QAAQ,OAAO,MAAM,EAAE,CAC1B,CAAA;IACH,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CACpB,EAAa,EACb,MAA+B,EAC/B,OAAmC;IAEnC,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAChC,OAAO,GAAG,CAAC,EAAE,EAAE,MAAM,CAAC,KAAK,EAAE,OAAO,CAA6B,CAAA;IACnE,CAAC;IACD,IAAI,OAAO,IAAI,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAChD,OAAO,OAAmC,CAAA;IAC5C,CAAC;IACD,MAAM,IAAI,SAAS,CACjB,8DAA8D,OAAO,OAAO,EAAE,CAC/E,CAAA;AACH,CAAC;AAED,SAAS,aAAa,CACpB,EAAa,EACb,MAA+B;IAE/B,OAAO,UAAU,CAAC,EAAE,EAAE,MAAM,CAAC,KAAK,CAA+B,CAAA;AACnE,CAAC;AAED,SAAS,SAAS,CAA6B,QAAiC;IAC9E,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;QAAE,OAAO,IAAI,CAAA;IACnC,OAAO,EAAE,EAAE,EAAE,QAAQ,CAAC,EAAE,EAAE,GAAI,QAAQ,CAAC,IAAI,EAAY,EAAE,CAAA;AAC3D,CAAC;AAED,SAAS,eAAe,CAA6B,aAAmC;IACtF,OAAO,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QAC9C,EAAE,EAAE,WAAW,CAAC,EAAE;QAClB,GAAI,WAAW,CAAC,IAAI,EAAY;KACjC,CAAC,CAAC,CAAA;AACL,CAAC;AAED,SAAS,qBAAqB,CAAC,OAAmB;IAChD,MAAM,YAAY,GAAG,OAAO,IAAI,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;IACjE,MAAM,cAAc,GAAG,aAAa,IAAI,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA;IACrF,OAAO,YAAY,IAAI,cAAc,CAAA;AACvC,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,EAAa;IAC/C,IAAI,CAAC,EAAE;QAAE,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAA;IAEpF,KAAK,UAAU,SAAS,CACtB,MAA+B,EAC/B,IAAW;QAEX,YAAY,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;QACjC,MAAM,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;QACvC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,EAAE,EAAE,MAAM,CAAC,EAAE,SAAS,CAAC,CAAA;QAC9D,OAAO,GAA+B,CAAA;IACxC,CAAC;IAED,KAAK,UAAU,MAAM,CACnB,MAA+B,EAC/B,OAAmC,EACnC,IAA4B,EAC5B,UAAsB,EAAE;QAExB,YAAY,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;QAC9B,MAAM,GAAG,GAAG,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;QAC9C,MAAM,SAAS,GAAG,qBAAqB,CAAC,OAAO,CAAC;YAC9C,CAAC,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC;YAC9B,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;QACzB,MAAM,OAAO,CAAC,GAAG,EAAE,SAAS,EAAE,OAAO,CAAC,CAAA;IACxC,CAAC;IAED,KAAK,UAAU,SAAS,CACtB,MAA+B,EAC/B,OAAmC,EACnC,IAAoB;QAEpB,YAAY,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;QACjC,MAAM,GAAG,GAAG,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;QAC9C,MAAM,SAAS,GAAG,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,CAAA;QAC9C,MAAM,UAAU,CAAC,GAAsC,EAAE,SAAyB,CAAC,CAAA;IACrF,CAAC;IAED,KAAK,UAAU,SAAS,CACtB,MAA+B,EAC/B,OAAmC;QAEnC,YAAY,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;QACjC,MAAM,GAAG,GAAG,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;QAC9C,MAAM,UAAU,CAAC,GAAG,CAAC,CAAA;IACvB,CAAC;IAED,KAAK,UAAU,MAAM,CACnB,MAA+B,EAC/B,OAAmC;QAEnC,YAAY,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;QAC9B,MAAM,GAAG,GAAG,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;QAC9C,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAA;QACnC,OAAO,SAAS,CAAC,QAAmC,CAAC,CAAA;IACvD,CAAC;IAED,KAAK,UAAU,OAAO,CACpB,MAA+B,EAC/B,GAAG,WAA8B;QAEjC,YAAY,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;QAC/B,MAAM,GAAG,GAAG,aAAa,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;QACrC,MAAM,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,GAAG,CAAA;QAC/D,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,CAAC,CAAC,CAAA;QAClC,OAAO,eAAe,CAAC,QAAgC,CAAC,CAAA;IAC1D,CAAC;IAED,SAAS,SAAS,CAChB,MAA+B,EAC/B,EAAU;QAEV,YAAY,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;QACjC,OAAO,GAAG,CAAC,EAAE,EAAE,MAAM,CAAC,KAAK,EAAE,EAAE,CAA6B,CAAA;IAC9D,CAAC;IAED,SAAS,gBAAgB,CACvB,MAA+B;QAE/B,YAAY,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAA;QACxC,OAAO,aAAa,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;IAClC,CAAC;IAED,SAAS,aAAa,CACpB,MAA+B,EAC/B,OAAmC,EACnC,QAA8C,EAC9C,OAAgC;QAEhC,YAAY,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;QACrC,MAAM,GAAG,GAAG,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;QAC9C,OAAO,WAAW,CAChB,GAAG,EACH,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,QAAmC,CAAC,CAAC,EACtE,OAAO,CACR,CAAA;IACH,CAAC;IAED,SAAS,oBAAoB,CAC3B,MAA+B,EAC/B,QAA8C,EAC9C,GAAG,WAA8B;QAEjC,YAAY,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAA;QAC5C,MAAM,GAAG,GAAG,aAAa,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;QACrC,MAAM,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,GAAG,CAAA;QAC/D,OAAO,WAAW,CAChB,CAAC,EACD,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,QAAgC,CAAC,CAAC,CAC1E,CAAA;IACH,CAAC;IAED,SAAS,WAAW;QAClB,MAAM,KAAK,GAAG,UAAU,CAAC,EAAE,CAAC,CAAA;QAE5B,MAAM,WAAW,GAAgB;YAC/B,MAAM,CACJ,MAA+B,EAC/B,IAAW;gBAEX,YAAY,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;gBACpC,MAAM,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;gBACvC,MAAM,GAAG,GAAG,GAAG,CAAC,aAAa,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;gBAC1C,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,SAAS,CAAC,CAAA;gBACzB,OAAO,GAA+B,CAAA;YACxC,CAAC;YAED,GAAG,CACD,MAA+B,EAC/B,OAAmC,EACnC,IAA4B,EAC5B,UAAsB,EAAE;gBAExB,YAAY,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;gBACjC,MAAM,GAAG,GAAG,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;gBAC9C,MAAM,SAAS,GAAG,qBAAqB,CAAC,OAAO,CAAC;oBAC9C,CAAC,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC;oBAC9B,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;gBACzB,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,SAAS,EAAE,OAAO,CAAC,CAAA;gBAClC,OAAO,WAAW,CAAA;YACpB,CAAC;YAED,MAAM,CACJ,MAA+B,EAC/B,OAAmC,EACnC,IAAoB;gBAEpB,YAAY,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;gBACpC,MAAM,GAAG,GAAG,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;gBAC9C,MAAM,SAAS,GAAG,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,CAAA;gBAC9C,KAAK,CAAC,MAAM,CAAC,GAAsC,EAAE,SAAyB,CAAC,CAAA;gBAC/E,OAAO,WAAW,CAAA;YACpB,CAAC;YAED,MAAM,CACJ,MAA+B,EAC/B,OAAmC;gBAEnC,YAAY,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;gBACpC,MAAM,GAAG,GAAG,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;gBAC9C,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;gBACjB,OAAO,WAAW,CAAA;YACpB,CAAC;YAED,MAAM;gBACJ,OAAO,KAAK,CAAC,MAAM,EAAE,CAAA;YACvB,CAAC;SACF,CAAA;QAED,OAAO,WAAW,CAAA;IACpB,CAAC;IAED,KAAK,UAAU,cAAc,CAC3B,QAAoD;QAEpD,OAAO,eAAe,CAAC,EAAE,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE;YAC/C,MAAM,WAAW,GAAsB;gBACrC,KAAK,CAAC,GAAG,CACP,MAA+B,EAC/B,OAAmC;oBAEnC,YAAY,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;oBACvC,MAAM,GAAG,GAAG,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;oBAC9C,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;oBAC3C,OAAO,SAAS,CAAC,QAAmC,CAAC,CAAA;gBACvD,CAAC;gBAED,GAAG,CACD,MAA+B,EAC/B,OAAmC,EACnC,IAA4B,EAC5B,UAAsB,EAAE;oBAExB,YAAY,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;oBACvC,MAAM,GAAG,GAAG,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;oBAC9C,MAAM,SAAS,GAAG,qBAAqB,CAAC,OAAO,CAAC;wBAC9C,CAAC,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC;wBAC9B,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;oBACzB,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE,SAAS,EAAE,OAAO,CAAC,CAAA;oBACxC,OAAO,WAAW,CAAA;gBACpB,CAAC;gBAED,MAAM,CACJ,MAA+B,EAC/B,OAAmC,EACnC,IAAoB;oBAEpB,YAAY,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAA;oBAC1C,MAAM,GAAG,GAAG,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;oBAC9C,MAAM,SAAS,GAAG,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,CAAA;oBAC9C,WAAW,CAAC,MAAM,CAAC,GAAsC,EAAE,SAAyB,CAAC,CAAA;oBACrF,OAAO,WAAW,CAAA;gBACpB,CAAC;gBAED,MAAM,CACJ,MAA+B,EAC/B,OAAmC;oBAEnC,YAAY,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAA;oBAC1C,MAAM,GAAG,GAAG,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;oBAC9C,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;oBACvB,OAAO,WAAW,CAAA;gBACpB,CAAC;aACF,CAAA;YAED,OAAO,QAAQ,CAAC,WAAW,CAAC,CAAA;QAC9B,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,OAAO;QACL,SAAS;QACT,MAAM;QACN,SAAS;QACT,SAAS;QACT,MAAM;QACN,OAAO;QACP,SAAS;QACT,gBAAgB;QAChB,aAAa;QACb,oBAAoB;QACpB,WAAW;QACX,cAAc;KACf,CAAA;AACH,CAAC"}

package/package.json

@@ -1,12 +1,24 @@
 {
   "name": "firestore-schema-kit",
-  "version": "1.0.0",
-  "main": "index.js",
-  "exports": "./index.js",
+  "version": "2.1.0",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
   "type": "module",
   "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
+  "files": [
+    "dist",
+    "readme.md"
+  ],
   "keywords": [],
   "author": "Bonanza Narayan",
   "license": "ISC",
@@ -20,8 +32,12 @@
   },
   "homepage": "https://github.com/BonanzaNarayan/firebase-schema#readme",
   "dependencies": {
-    "firebase": "^12.11.0",
     "zod": "^4.3.6"
   },
-  "devDependencies": {}
+  "peerDependencies": {
+    "firebase": "^12.11.0"
+  },
+  "devDependencies": {
+    "typescript": "^6.0.2"
+  }
 }

package/readme.md

@@ -9,7 +9,9 @@ Zod handles validation internally. You never touch Zod directly.
 ## Install
 
 ```bash
-npm install zod firebase
+npm install firestore-schema-kit
+pnpm add firestore-schema-kit
+bun add firestore-schema-kit
 ```
 
 Copy `src/` into your project (e.g. `lib/firebase-schema/`).

package/collection.js

@@ -1,98 +0,0 @@
-import { z } from 'zod'
-import { s } from './fields.js'
-
-// ─── Schema Validation Error ───────────────────────────────────────────────────
-
-export class SchemaValidationError extends Error {
-  constructor(collectionName, zodError) {
-    const issues = zodError.issues
-      .map((i) => `  • ${i.path.join('.')}: ${i.message}`)
-      .join('\n')
-
-    super(`[${collectionName}] Schema validation failed:\n${issues}`)
-    this.name       = 'SchemaValidationError'
-    this.collection = collectionName
-    this.issues     = zodError.issues
-  }
-}
-
-// ─── defineCollection ─────────────────────────────────────────────────────────
-
-/**
- * Define a typed Firestore collection with schema validation.
- *
- * @param {string} collectionName - Firestore collection path (e.g. 'users', 'posts/comments')
- * @param {(s: SchemaBuilder) => Record<string, BaseField>} builder - Field definition callback
- * @returns {CollectionSchema}
- *
- * @example
- * export const usersSchema = defineCollection('users', (s) => ({
- *   name:      s.string().min(1),
- *   email:     s.string().email(),
- *   age:       s.number().optional(),
- *   role:      s.enum(['admin', 'user']).default('user'),
- *   createdAt: s.timestamp(),
- * }))
- */
-export function defineCollection(collectionName, builder) {
-  if (typeof collectionName !== 'string' || !collectionName.trim()) {
-    throw new Error('defineCollection: collectionName must be a non-empty string')
-  }
-  if (typeof builder !== 'function') {
-    throw new Error('defineCollection: builder must be a function')
-  }
-
-  // Call builder with the schema builder (s)
-  const fieldDefs = builder(s)
-
-  if (!fieldDefs || typeof fieldDefs !== 'object') {
-    throw new Error('defineCollection: builder must return an object of field definitions')
-  }
-
-  // Convert field definitions → Zod schema shape
-  const zodShape = {}
-  for (const [key, field] of Object.entries(fieldDefs)) {
-    if (typeof field?.toZod !== 'function') {
-      throw new Error(
-        `defineCollection [${collectionName}]: field "${key}" is not a valid schema field. ` +
-        `Use s.string(), s.number(), etc.`
-      )
-    }
-    zodShape[key] = field.toZod()
-  }
-
-  const zodSchema        = z.object(zodShape)
-  const zodPartialSchema = zodSchema.partial()
-
-  return {
-    // ── Metadata ────────────────────────────────────────────────────────────
-    _name:      collectionName,
-    _fieldDefs: fieldDefs,
-    _type:      'CollectionSchema',
-
-    // ── Validation ──────────────────────────────────────────────────────────
-
-    /** Full validation — use for createDoc / setDoc */
-    validate(data) {
-      const result = zodSchema.safeParse(data)
-      if (!result.success) throw new SchemaValidationError(collectionName, result.error)
-      return result.data
-    },
-
-    /** Partial validation — use for updateDoc (only validates fields present in data) */
-    validatePartial(data) {
-      const result = zodPartialSchema.safeParse(data)
-      if (!result.success) throw new SchemaValidationError(collectionName, result.error)
-      return result.data
-    },
-
-    /** Safe (non-throwing) full validation */
-    safeParse(data) {
-      const result = zodSchema.safeParse(data)
-      if (!result.success) {
-        return { success: false, error: new SchemaValidationError(collectionName, result.error) }
-      }
-      return { success: true, data: result.data }
-    },
-  }
-}

package/fields.js

@@ -1,245 +0,0 @@
-import { z } from 'zod'
-
-// ─── Base Field ───────────────────────────────────────────────────────────────
-
-class BaseField {
-  constructor() {
-    this._optional   = false
-    this._nullable   = false
-    this._hasDefault = false
-    this._defaultVal = undefined
-  }
-
-  optional() {
-    this._optional = true
-    return this
-  }
-
-  nullable() {
-    this._nullable = true
-    return this
-  }
-
-  default(val) {
-    this._hasDefault = true
-    this._defaultVal = val
-    return this
-  }
-
-  // Subclasses implement this — returns a raw Zod schema with no optional/default wrapping
-  _baseZod() {
-    throw new Error(`_baseZod() not implemented on ${this.constructor.name}`)
-  }
-
-  // Builds the final Zod schema, applying nullable → default → optional in the correct order
-  toZod() {
-    let schema = this._baseZod()
-    if (this._nullable)   schema = schema.nullable()
-    if (this._hasDefault) schema = schema.default(this._defaultVal)
-    if (this._optional)   schema = schema.optional()
-    return schema
-  }
-}
-
-// ─── String ───────────────────────────────────────────────────────────────────
-
-export class StringField extends BaseField {
-  constructor() {
-    super()
-    this._min   = null
-    this._max   = null
-    this._email = false
-    this._url   = false
-    this._uuid  = false
-    this._regex = null
-  }
-
-  min(n)      { this._min   = n; return this }
-  max(n)      { this._max   = n; return this }
-  email()     { this._email = true; return this }
-  url()       { this._url   = true; return this }
-  uuid()      { this._uuid  = true; return this }
-  regex(r)    { this._regex = r; return this }
-
-  _baseZod() {
-    let schema = z.string()
-    if (this._min   !== null) schema = schema.min(this._min)
-    if (this._max   !== null) schema = schema.max(this._max)
-    if (this._email)          schema = schema.email()
-    if (this._url)            schema = schema.url()
-    if (this._uuid)           schema = schema.uuid()
-    if (this._regex !== null) schema = schema.regex(this._regex)
-    return schema
-  }
-}
-
-// ─── Number ───────────────────────────────────────────────────────────────────
-
-export class NumberField extends BaseField {
-  constructor() {
-    super()
-    this._min      = null
-    this._max      = null
-    this._int      = false
-    this._positive = false
-    this._negative = false
-  }
-
-  min(n)      { this._min      = n;    return this }
-  max(n)      { this._max      = n;    return this }
-  int()       { this._int      = true; return this }
-  positive()  { this._positive = true; return this }
-  negative()  { this._negative = true; return this }
-
-  _baseZod() {
-    let schema = this._int ? z.number().int() : z.number()
-    if (this._min      !== null) schema = schema.min(this._min)
-    if (this._max      !== null) schema = schema.max(this._max)
-    if (this._positive)          schema = schema.positive()
-    if (this._negative)          schema = schema.negative()
-    return schema
-  }
-}
-
-// ─── Boolean ──────────────────────────────────────────────────────────────────
-
-export class BooleanField extends BaseField {
-  _baseZod() {
-    return z.boolean()
-  }
-}
-
-// ─── Timestamp ────────────────────────────────────────────────────────────────
-// Accepts: JS Date, Firestore Timestamp, serverTimestamp() sentinel
-
-export class TimestampField extends BaseField {
-  _baseZod() {
-    return z.custom(
-      (val) => {
-        if (!val) return false
-        // JS Date
-        if (val instanceof Date) return true
-        // Firestore Timestamp (has toDate method)
-        if (typeof val.toDate === 'function') return true
-        // serverTimestamp() sentinel — has _methodName internally
-        if (typeof val === 'object' && '_methodName' in val) return true
-        return false
-      },
-      { message: 'Expected a Date, Firestore Timestamp, or serverTimestamp()' }
-    )
-  }
-}
-
-// ─── Array ────────────────────────────────────────────────────────────────────
-
-export class ArrayField extends BaseField {
-  constructor(itemField) {
-    super()
-    this._itemField = itemField
-    this._min       = null
-    this._max       = null
-  }
-
-  min(n) { this._min = n; return this }
-  max(n) { this._max = n; return this }
-
-  _baseZod() {
-    let schema = z.array(this._itemField.toZod())
-    if (this._min !== null) schema = schema.min(this._min)
-    if (this._max !== null) schema = schema.max(this._max)
-    return schema
-  }
-}
-
-// ─── Map (nested object) ──────────────────────────────────────────────────────
-
-export class MapField extends BaseField {
-  constructor(shape) {
-    super()
-    this._shape = shape
-  }
-
-  _baseZod() {
-    const zodShape = {}
-    for (const [key, field] of Object.entries(this._shape)) {
-      zodShape[key] = field.toZod()
-    }
-    return z.object(zodShape)
-  }
-}
-
-// ─── Enum ─────────────────────────────────────────────────────────────────────
-
-export class EnumField extends BaseField {
-  constructor(values) {
-    super()
-    this._values = values
-  }
-
-  _baseZod() {
-    return z.enum(this._values)
-  }
-}
-
-// ─── Literal ──────────────────────────────────────────────────────────────────
-
-export class LiteralField extends BaseField {
-  constructor(value) {
-    super()
-    this._value = value
-  }
-
-  _baseZod() {
-    return z.literal(this._value)
-  }
-}
-
-// ─── Reference (Firestore DocumentReference) ──────────────────────────────────
-
-export class ReferenceField extends BaseField {
-  _baseZod() {
-    return z.custom(
-      (val) => val && typeof val.path === 'string' && typeof val.id === 'string',
-      { message: 'Expected a Firestore DocumentReference' }
-    )
-  }
-}
-
-// ─── Union ────────────────────────────────────────────────────────────────────
-
-export class UnionField extends BaseField {
-  constructor(fields) {
-    super()
-    this._fields = fields
-  }
-
-  _baseZod() {
-    const schemas = this._fields.map((f) => f.toZod())
-    return z.union(schemas)
-  }
-}
-
-// ─── Any (escape hatch) ───────────────────────────────────────────────────────
-
-export class AnyField extends BaseField {
-  _baseZod() {
-    return z.any()
-  }
-}
-
-// ─── Schema Builder (s) ───────────────────────────────────────────────────────
-// This is what gets passed into the defineCollection callback
-
-export const s = {
-  string:    ()           => new StringField(),
-  number:    ()           => new NumberField(),
-  boolean:   ()           => new BooleanField(),
-  timestamp: ()           => new TimestampField(),
-  array:     (itemField)  => new ArrayField(itemField),
-  map:       (shape)      => new MapField(shape),
-  enum:      (values)     => new EnumField(values),
-  literal:   (value)      => new LiteralField(value),
-  reference: ()           => new ReferenceField(),
-  union:     (fields)     => new UnionField(fields),
-  any:       ()           => new AnyField(),
-}

package/index.js

@@ -1,3 +0,0 @@
-export { s } from './fields.js'
-export { defineCollection, SchemaValidationError } from './collection.js'
-export { initFirestoreSchema } from './operations.js'