firebase-admin-edge 1.1.1 → 2.0.0

package/dist/db/bytes.js

@@ -0,0 +1,49 @@
+import { FirestoreErrorInfo } from './firestore-error-codes.js';
+import { FirebaseEdgeError, ensureError } from '../auth/errors.js';
+/** Edge-compatible byte values; no Node Buffer dependency. */
+export class Bytes {
+    value;
+    constructor(value) {
+        this.value = value;
+    }
+    static fromBase64String(value) {
+        if (typeof value !== 'string')
+            throw new FirebaseEdgeError({
+                ...FirestoreErrorInfo.INVALID_ARGUMENT,
+                message: 'Expected base64 text.'
+            });
+        try {
+            return new Bytes(Uint8Array.from(atob(value), (character) => character.charCodeAt(0)));
+        }
+        catch (cause) {
+            throw new FirebaseEdgeError({
+                ...FirestoreErrorInfo.INVALID_ARGUMENT,
+                message: 'Expected base64 text.'
+            }, { cause: ensureError(cause) });
+        }
+    }
+    static fromUint8Array(value) {
+        if (!(value instanceof Uint8Array)) {
+            throw new FirebaseEdgeError({
+                ...FirestoreErrorInfo.INVALID_ARGUMENT,
+                message: 'Expected Uint8Array.'
+            });
+        }
+        return new Bytes(new Uint8Array(value));
+    }
+    toBase64() {
+        return btoa(Array.from(this.value, (byte) => String.fromCharCode(byte)).join(''));
+    }
+    toUint8Array() {
+        return this.value.slice();
+    }
+    isEqual(other) {
+        return (other instanceof Bytes &&
+            this.value.length === other.value.length &&
+            this.value.every((byte, index) => byte === other.value[index]));
+    }
+    toString() {
+        return `Bytes(base64: ${this.toBase64()})`;
+    }
+}
+//# sourceMappingURL=bytes.js.map

package/dist/db/bytes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bytes.js","sourceRoot":"","sources":["../../src/db/bytes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACnE,8DAA8D;AAC9D,MAAM,OAAO,KAAK;IACuB;IAArC,YAAqC,KAAiB;QAAjB,UAAK,GAAL,KAAK,CAAY;IAAG,CAAC;IAC1D,MAAM,CAAC,gBAAgB,CAAC,KAAa;QACjC,IAAI,OAAO,KAAK,KAAK,QAAQ;YACzB,MAAM,IAAI,iBAAiB,CAAC;gBACxB,GAAG,kBAAkB,CAAC,gBAAgB;gBACtC,OAAO,EAAE,uBAAuB;aACnC,CAAC,CAAC;QACP,IAAI,CAAC;YACD,OAAO,IAAI,KAAK,CACZ,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,SAAS,EAAE,EAAE,CACvC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CAC1B,CACJ,CAAC;QACN,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,MAAM,IAAI,iBAAiB,CACvB;gBACI,GAAG,kBAAkB,CAAC,gBAAgB;gBACtC,OAAO,EAAE,uBAAuB;aACnC,EACD,EAAE,KAAK,EAAE,WAAW,CAAC,KAAK,CAAC,EAAE,CAChC,CAAC;QACN,CAAC;IACL,CAAC;IACD,MAAM,CAAC,cAAc,CAAC,KAAiB;QACnC,IAAI,CAAC,CAAC,KAAK,YAAY,UAAU,CAAC,EAAE,CAAC;YACjC,MAAM,IAAI,iBAAiB,CAAC;gBACxB,GAAG,kBAAkB,CAAC,gBAAgB;gBACtC,OAAO,EAAE,sBAAsB;aAClC,CAAC,CAAC;QACP,CAAC;QAED,OAAO,IAAI,KAAK,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IAC5C,CAAC;IACD,QAAQ;QACJ,OAAO,IAAI,CACP,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CACvE,CAAC;IACN,CAAC;IACD,YAAY;QACR,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IAC9B,CAAC;IACD,OAAO,CAAC,KAAY;QAChB,OAAO,CACH,KAAK,YAAY,KAAK;YACtB,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,KAAK,CAAC,KAAK,CAAC,MAAM;YACxC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,KAAK,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CACjE,CAAC;IACN,CAAC;IACD,QAAQ;QACJ,OAAO,iBAAiB,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC;IAC/C,CAAC;CACJ"}

package/dist/db/collection-group.d.ts

@@ -0,0 +1,14 @@
+import { Query, type QueryExecutor } from './query.js';
+import type { Firestore } from './firestore.js';
+import type { DocumentData } from './firestore-document.js';
+import { type FirestoreDataConverter } from './firestore-converter.js';
+import { QueryPartition } from './query-partition.js';
+export declare class CollectionGroup<T = DocumentData, DbModelType extends DocumentData = DocumentData> extends Query<T, DbModelType> {
+    /** @internal Use firestore.collectionGroup(). */
+    constructor(firestore: Firestore, collectionId: string, execute: QueryExecutor, converter?: FirestoreDataConverter<T, DbModelType> | null);
+    getPartitions(desiredPartitionCount: number): AsyncGenerator<QueryPartition<T, DbModelType>>;
+    withConverter<U, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<U, NewDbModelType>): CollectionGroup<U, NewDbModelType>;
+    withConverter(converter: null): CollectionGroup;
+    withConverter<U, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<U, NewDbModelType> | null): CollectionGroup<U, NewDbModelType>;
+}
+//# sourceMappingURL=collection-group.d.ts.map

package/dist/db/collection-group.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"collection-group.d.ts","sourceRoot":"","sources":["../../src/db/collection-group.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,KAAK,aAAa,EAAE,MAAM,YAAY,CAAC;AACvD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAEH,KAAK,sBAAsB,EAC9B,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAItD,qBAAa,eAAe,CACxB,CAAC,GAAG,YAAY,EAChB,WAAW,SAAS,YAAY,GAAG,YAAY,CACjD,SAAQ,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC;IAC3B,iDAAiD;gBAE7C,SAAS,EAAE,SAAS,EACpB,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,aAAa,EACtB,SAAS,GAAE,sBAAsB,CAAC,CAAC,EAAE,WAAW,CAAC,GAAG,IAAW;IAoB5D,aAAa,CAChB,qBAAqB,EAAE,MAAM,GAC9B,cAAc,CAAC,cAAc,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;IAwBxC,aAAa,CAClB,CAAC,EACD,cAAc,SAAS,YAAY,GAAG,YAAY,EAElD,SAAS,EAAE,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,GACrD,eAAe,CAAC,CAAC,EAAE,cAAc,CAAC;IAC5B,aAAa,CAAC,SAAS,EAAE,IAAI,GAAG,eAAe;IAC/C,aAAa,CAClB,CAAC,EACD,cAAc,SAAS,YAAY,GAAG,YAAY,EAElD,SAAS,EAAE,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,GAAG,IAAI,GAC5D,eAAe,CAAC,CAAC,EAAE,cAAc,CAAC;CAexC"}

package/dist/db/collection-group.js

@@ -0,0 +1,43 @@
+import { Query } from './query.js';
+import { validateConverter } from './firestore-converter.js';
+import { FieldPath } from './field-path.js';
+import { QueryPartition } from './query-partition.js';
+import { FirebaseEdgeError } from '../auth/errors.js';
+import { FirestoreErrorInfo } from './firestore-error-codes.js';
+export class CollectionGroup extends Query {
+    /** @internal Use firestore.collectionGroup(). */
+    constructor(firestore, collectionId, execute, converter = null) {
+        if (typeof collectionId !== 'string' ||
+            !collectionId ||
+            collectionId.includes('/') ||
+            ['.', '..'].includes(collectionId))
+            throw new FirebaseEdgeError({
+                ...FirestoreErrorInfo.INVALID_ARGUMENT,
+                message: 'A collection group requires a single collection ID.'
+            });
+        super(firestore, collectionId, execute, { allDescendants: true }, converter);
+    }
+    async *getPartitions(desiredPartitionCount) {
+        if (!Number.isSafeInteger(desiredPartitionCount) ||
+            desiredPartitionCount < 1)
+            throw new FirebaseEdgeError({
+                ...FirestoreErrorInfo.INVALID_ARGUMENT,
+                message: 'Partition count must be a positive safe integer.'
+            });
+        const paths = desiredPartitionCount === 1
+            ? []
+            : await this.firestore._partitionQuery(this.collectionPath, desiredPartitionCount);
+        const query = this.orderBy(FieldPath.documentId());
+        let start;
+        for (const end of paths) {
+            yield new QueryPartition(query, start, end);
+            start = end;
+        }
+        yield new QueryPartition(query, start, undefined);
+    }
+    withConverter(converter) {
+        validateConverter(converter);
+        return new CollectionGroup(this.firestore, this.collectionPath, this.execute, converter);
+    }
+}
+//# sourceMappingURL=collection-group.js.map

package/dist/db/collection-group.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"collection-group.js","sourceRoot":"","sources":["../../src/db/collection-group.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAsB,MAAM,YAAY,CAAC;AAGvD,OAAO,EACH,iBAAiB,EAEpB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAEhE,MAAM,OAAO,eAGX,SAAQ,KAAqB;IAC3B,iDAAiD;IACjD,YACI,SAAoB,EACpB,YAAoB,EACpB,OAAsB,EACtB,YAA2D,IAAI;QAE/D,IACI,OAAO,YAAY,KAAK,QAAQ;YAChC,CAAC,YAAY;YACb,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC;YAC1B,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC;YAElC,MAAM,IAAI,iBAAiB,CAAC;gBACxB,GAAG,kBAAkB,CAAC,gBAAgB;gBACtC,OAAO,EAAE,qDAAqD;aACjE,CAAC,CAAC;QACP,KAAK,CACD,SAAS,EACT,YAAY,EACZ,OAAO,EACP,EAAE,cAAc,EAAE,IAAI,EAAE,EACxB,SAAS,CACZ,CAAC;IACN,CAAC;IACD,KAAK,CAAC,CAAC,aAAa,CAChB,qBAA6B;QAE7B,IACI,CAAC,MAAM,CAAC,aAAa,CAAC,qBAAqB,CAAC;YAC5C,qBAAqB,GAAG,CAAC;YAEzB,MAAM,IAAI,iBAAiB,CAAC;gBACxB,GAAG,kBAAkB,CAAC,gBAAgB;gBACtC,OAAO,EAAE,kDAAkD;aAC9D,CAAC,CAAC;QACP,MAAM,KAAK,GACP,qBAAqB,KAAK,CAAC;YACvB,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,eAAe,CAChC,IAAI,CAAC,cAAc,EACnB,qBAAqB,CACxB,CAAC;QACZ,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC,CAAC;QACnD,IAAI,KAAyB,CAAC;QAC9B,KAAK,MAAM,GAAG,IAAI,KAAK,EAAE,CAAC;YACtB,MAAM,IAAI,cAAc,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;YAC5C,KAAK,GAAG,GAAG,CAAC;QAChB,CAAC;QACD,MAAM,IAAI,cAAc,CAAC,KAAK,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;IACtD,CAAC;IAcQ,aAAa,CAIlB,SAA2D;QAE3D,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAC7B,OAAO,IAAI,eAAe,CACtB,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,OAAO,EACZ,SAAS,CACZ,CAAC;IACN,CAAC;CACJ"}

package/dist/db/collection-reference.d.ts

@@ -0,0 +1,21 @@
+import { type FirestoreResult } from './firestore-results.js';
+import type { WithFieldValue } from './firestore-types.js';
+import { Query, type QueryExecutor } from './query.js';
+import type { Firestore, DocumentReference } from './firestore.js';
+import type { DocumentData } from './firestore-document.js';
+import { type FirestoreDataConverter } from './firestore-converter.js';
+/** A collection reference is also an unfiltered query. */
+export declare class CollectionReference<T = DocumentData, DbModelType extends DocumentData = DocumentData> extends Query<T, DbModelType> {
+    readonly path: string;
+    readonly id: string;
+    readonly parent: DocumentReference | null;
+    /** @internal Obtain collection references from firestore.collection(). */
+    constructor(firestore: Firestore, path: string, execute: QueryExecutor, converter?: FirestoreDataConverter<T, DbModelType> | null);
+    doc(documentPath?: string): DocumentReference<T, DbModelType>;
+    add(data: WithFieldValue<T>): Promise<FirestoreResult<DocumentReference<T, DbModelType>>>;
+    listDocuments(): Promise<FirestoreResult<DocumentReference<T, DbModelType>[]>>;
+    withConverter<U, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<U, NewDbModelType>): CollectionReference<U, NewDbModelType>;
+    withConverter(converter: null): CollectionReference;
+    withConverter<U, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<U, NewDbModelType> | null): CollectionReference<U, NewDbModelType>;
+}
+//# sourceMappingURL=collection-reference.d.ts.map

package/dist/db/collection-reference.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"collection-reference.d.ts","sourceRoot":"","sources":["../../src/db/collection-reference.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,KAAK,eAAe,EAGvB,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EACR,cAAc,EAGjB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,KAAK,EAAE,KAAK,aAAa,EAAE,MAAM,YAAY,CAAC;AAEvD,OAAO,KAAK,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACnE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAEH,KAAK,sBAAsB,EAC9B,MAAM,0BAA0B,CAAC;AAGlC,0DAA0D;AAC1D,qBAAa,mBAAmB,CAC5B,CAAC,GAAG,YAAY,EAChB,WAAW,SAAS,YAAY,GAAG,YAAY,CACjD,SAAQ,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC;IAMvB,QAAQ,CAAC,IAAI,EAAE,MAAM;IALzB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,MAAM,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAC1C,0EAA0E;gBAEtE,SAAS,EAAE,SAAS,EACX,IAAI,EAAE,MAAM,EACrB,OAAO,EAAE,aAAa,EACtB,SAAS,GAAE,sBAAsB,CAAC,CAAC,EAAE,WAAW,CAAC,GAAG,IAAW;IAWnE,GAAG,CAAC,YAAY,GAAE,MAAiB,GAAG,iBAAiB,CAAC,CAAC,EAAE,WAAW,CAAC;IAMjE,GAAG,CACL,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,GACxB,OAAO,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC;IAOxD,aAAa,IAAI,OAAO,CAC1B,eAAe,CAAC,iBAAiB,CAAC,CAAC,EAAE,WAAW,CAAC,EAAE,CAAC,CACvD;IAQQ,aAAa,CAClB,CAAC,EACD,cAAc,SAAS,YAAY,GAAG,YAAY,EAElD,SAAS,EAAE,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,GACrD,mBAAmB,CAAC,CAAC,EAAE,cAAc,CAAC;IAChC,aAAa,CAAC,SAAS,EAAE,IAAI,GAAG,mBAAmB;IACnD,aAAa,CAClB,CAAC,EACD,cAAc,SAAS,YAAY,GAAG,YAAY,EAElD,SAAS,EAAE,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,GAAG,IAAI,GAC5D,mBAAmB,CAAC,CAAC,EAAE,cAAc,CAAC;CAe5C"}

package/dist/db/collection-reference.js

@@ -0,0 +1,46 @@
+import { firestoreResult, firestoreData } from './firestore-results.js';
+import { Query } from './query.js';
+import { validatePath } from './firestore-path.js';
+import { validateConverter } from './firestore-converter.js';
+import { autoId } from './firestore-path.js';
+/** A collection reference is also an unfiltered query. */
+export class CollectionReference extends Query {
+    path;
+    id;
+    parent;
+    /** @internal Obtain collection references from firestore.collection(). */
+    constructor(firestore, path, execute, converter = null) {
+        validatePath(path, false);
+        super(firestore, path, execute, {}, converter);
+        this.path = path;
+        const segments = path.split('/');
+        this.id = segments.pop();
+        this.parent = segments.length
+            ? firestore.doc(segments.join('/'))
+            : null;
+    }
+    doc(documentPath = autoId()) {
+        validatePath(documentPath, false);
+        return this.firestore
+            .doc(`${this.path}/${documentPath}`)
+            .withConverter(this.converter);
+    }
+    async add(data) {
+        return firestoreResult(async () => {
+            const ref = this.doc();
+            await ref.create(data).then(firestoreData);
+            return ref;
+        });
+    }
+    async listDocuments() {
+        return firestoreResult(async () => {
+            const paths = await this.firestore._listDocuments(this.path);
+            return paths.map((path) => this.firestore.doc(path).withConverter(this.converter));
+        });
+    }
+    withConverter(converter) {
+        validateConverter(converter);
+        return new CollectionReference(this.firestore, this.path, this.execute, converter);
+    }
+}
+//# sourceMappingURL=collection-reference.js.map

package/dist/db/collection-reference.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"collection-reference.js","sourceRoot":"","sources":["../../src/db/collection-reference.ts"],"names":[],"mappings":"AAAA,OAAO,EAEH,eAAe,EACf,aAAa,EAChB,MAAM,wBAAwB,CAAC;AAMhC,OAAO,EAAE,KAAK,EAAsB,MAAM,YAAY,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAGnD,OAAO,EACH,iBAAiB,EAEpB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAE7C,0DAA0D;AAC1D,MAAM,OAAO,mBAGX,SAAQ,KAAqB;IAMd;IALJ,EAAE,CAAS;IACX,MAAM,CAA2B;IAC1C,0EAA0E;IAC1E,YACI,SAAoB,EACX,IAAY,EACrB,OAAsB,EACtB,YAA2D,IAAI;QAE/D,YAAY,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC1B,KAAK,CAAC,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,SAAS,CAAC,CAAC;QALtC,SAAI,GAAJ,IAAI,CAAQ;QAMrB,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACjC,IAAI,CAAC,EAAE,GAAG,QAAQ,CAAC,GAAG,EAAG,CAAC;QAC1B,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM;YACzB,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACnC,CAAC,CAAC,IAAI,CAAC;IACf,CAAC;IAED,GAAG,CAAC,eAAuB,MAAM,EAAE;QAC/B,YAAY,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;QAClC,OAAO,IAAI,CAAC,SAAS;aAChB,GAAG,CAAC,GAAG,IAAI,CAAC,IAAI,IAAI,YAAY,EAAE,CAAC;aACnC,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACvC,CAAC;IACD,KAAK,CAAC,GAAG,CACL,IAAuB;QAEvB,OAAO,eAAe,CAAC,KAAK,IAAI,EAAE;YAC9B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YACvB,MAAM,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YAC3C,OAAO,GAAG,CAAC;QACf,CAAC,CAAC,CAAC;IACP,CAAC;IACD,KAAK,CAAC,aAAa;QAGf,OAAO,eAAe,CAAC,KAAK,IAAI,EAAE;YAC9B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC7D,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CACtB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CACzD,CAAC;QACN,CAAC,CAAC,CAAC;IACP,CAAC;IAcQ,aAAa,CAIlB,SAA2D;QAE3D,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAC7B,OAAO,IAAI,mBAAmB,CAC1B,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,OAAO,EACZ,SAAS,CACZ,CAAC;IACN,CAAC;CACJ"}

package/dist/db/document-reference.d.ts

@@ -0,0 +1,41 @@
+import { type FirestoreResult } from './firestore-results.js';
+import type { WithFieldValue, PartialWithFieldValue, UpdateData } from './firestore-types.js';
+import type { Firestore } from './firestore.js';
+import { type SnapshotListenOptions, type SnapshotCallback, type SnapshotErrorCallback } from './snapshot-listener.js';
+import { DocumentSnapshot } from './document-snapshot.js';
+import { FieldPath } from './field-path.js';
+import type { CollectionReference } from './collection-reference.js';
+import type { FirestoreDocument } from './firestore-document.js';
+import type { DocumentData } from './firestore-document.js';
+import type { SetOptions, Precondition, WriteResult } from './write-request.js';
+import { type FirestoreDataConverter } from './firestore-converter.js';
+export type DocumentExecutor = (path: string) => Promise<FirestoreDocument | undefined>;
+/** A document location with read access and collection navigation. */
+export declare class DocumentReference<T = DocumentData, DbModelType extends DocumentData = DocumentData> {
+    readonly firestore: Firestore;
+    readonly path: string;
+    private readonly execute;
+    readonly converter: FirestoreDataConverter<T, DbModelType> | null;
+    onSnapshot(next: SnapshotCallback<DocumentSnapshot<T, DbModelType>>, error?: SnapshotErrorCallback, options?: SnapshotListenOptions): () => void;
+    onSnapshot(options: SnapshotListenOptions, next: SnapshotCallback<DocumentSnapshot<T, DbModelType>>, error?: SnapshotErrorCallback): () => void;
+    create(data: WithFieldValue<T>): Promise<FirestoreResult<WriteResult>>;
+    set(data: WithFieldValue<T>): Promise<FirestoreResult<WriteResult>>;
+    set(data: PartialWithFieldValue<T>, options: SetOptions): Promise<FirestoreResult<WriteResult>>;
+    update(data: UpdateData<DbModelType>, precondition?: Precondition): Promise<FirestoreResult<WriteResult>>;
+    update(field: string | FieldPath, value: unknown, ...moreFieldsOrPrecondition: unknown[]): Promise<FirestoreResult<WriteResult>>;
+    delete(precondition?: Precondition): Promise<FirestoreResult<WriteResult>>;
+    readonly id: string;
+    /** @internal Obtain references from firestore.doc() or collection.doc(). */
+    constructor(firestore: Firestore, path: string, execute: DocumentExecutor, converter?: FirestoreDataConverter<T, DbModelType> | null);
+    get parent(): CollectionReference<T, DbModelType>;
+    collection(collectionPath: string): CollectionReference;
+    get(): Promise<FirestoreResult<DocumentSnapshot<T, DbModelType>>>;
+    isEqual(other: DocumentReference<any>): boolean;
+    withConverter<U, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<U, NewDbModelType>): DocumentReference<U, NewDbModelType>;
+    withConverter(converter: null): DocumentReference;
+    withConverter<U, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<U, NewDbModelType> | null): DocumentReference<U, NewDbModelType>;
+    listCollections(): Promise<FirestoreResult<CollectionReference[]>>;
+    /** @internal Updates deliberately bypass converters, matching Admin Firestore. */
+    _toFirestore(data: PartialWithFieldValue<T>, options?: SetOptions): DocumentData;
+}
+//# sourceMappingURL=document-reference.d.ts.map

package/dist/db/document-reference.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-reference.d.ts","sourceRoot":"","sources":["../../src/db/document-reference.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,KAAK,eAAe,EAGvB,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EACR,cAAc,EACd,qBAAqB,EACrB,UAAU,EACb,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAEH,KAAK,qBAAqB,EAC1B,KAAK,gBAAgB,EACrB,KAAK,qBAAqB,EAC7B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AACrE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAEjE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAChF,OAAO,EAEH,KAAK,sBAAsB,EAC9B,MAAM,0BAA0B,CAAC;AAElC,MAAM,MAAM,gBAAgB,GAAG,CAC3B,IAAI,EAAE,MAAM,KACX,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,CAAC;AAE5C,sEAAsE;AACtE,qBAAa,iBAAiB,CAC1B,CAAC,GAAG,YAAY,EAChB,WAAW,SAAS,YAAY,GAAG,YAAY;IAuH3C,QAAQ,CAAC,SAAS,EAAE,SAAS;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM;IACrB,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,QAAQ,CAAC,SAAS,EAAE,sBAAsB,CAAC,CAAC,EAAE,WAAW,CAAC,GAAG,IAAI;IAxHrE,UAAU,CACN,IAAI,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,EACxD,KAAK,CAAC,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,qBAAqB,GAChC,MAAM,IAAI;IACb,UAAU,CACN,OAAO,EAAE,qBAAqB,EAC9B,IAAI,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,EACxD,KAAK,CAAC,EAAE,qBAAqB,GAC9B,MAAM,IAAI;IAoBP,MAAM,CACR,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,GACxB,OAAO,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;IAexC,GAAG,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;IACnE,GAAG,CACC,IAAI,EAAE,qBAAqB,CAAC,CAAC,CAAC,EAC9B,OAAO,EAAE,UAAU,GACpB,OAAO,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;IAkBxC,MAAM,CACF,IAAI,EAAE,UAAU,CAAC,WAAW,CAAC,EAC7B,YAAY,CAAC,EAAE,YAAY,GAC5B,OAAO,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;IACxC,MAAM,CACF,KAAK,EAAE,MAAM,GAAG,SAAS,EACzB,KAAK,EAAE,OAAO,EACd,GAAG,wBAAwB,EAAE,OAAO,EAAE,GACvC,OAAO,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;IAoBlC,MAAM,CACR,YAAY,CAAC,EAAE,YAAY,GAC5B,OAAO,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;IAexC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,4EAA4E;gBAE/D,SAAS,EAAE,SAAS,EACpB,IAAI,EAAE,MAAM,EACJ,OAAO,EAAE,gBAAgB,EACjC,SAAS,GAAE,sBAAsB,CAAC,CAAC,EAAE,WAAW,CAAC,GAAG,IAAW;IAM5E,IAAI,MAAM,IAAI,mBAAmB,CAAC,CAAC,EAAE,WAAW,CAAC,CAIhD;IAED,UAAU,CAAC,cAAc,EAAE,MAAM,GAAG,mBAAmB;IAKjD,GAAG,IAAI,OAAO,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC;IAUvE,OAAO,CAAC,KAAK,EAAE,iBAAiB,CAAC,GAAG,CAAC,GAAG,OAAO;IAS/C,aAAa,CAAC,CAAC,EAAE,cAAc,SAAS,YAAY,GAAG,YAAY,EAC/D,SAAS,EAAE,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,GACrD,iBAAiB,CAAC,CAAC,EAAE,cAAc,CAAC;IACvC,aAAa,CAAC,SAAS,EAAE,IAAI,GAAG,iBAAiB;IACjD,aAAa,CAAC,CAAC,EAAE,cAAc,SAAS,YAAY,GAAG,YAAY,EAC/D,SAAS,EAAE,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,GAAG,IAAI,GAC5D,iBAAiB,CAAC,CAAC,EAAE,cAAc,CAAC;IAYvC,eAAe,IAAI,OAAO,CAAC,eAAe,CAAC,mBAAmB,EAAE,CAAC,CAAC;IAUlE,kFAAkF;IAClF,YAAY,CACR,IAAI,EAAE,qBAAqB,CAAC,CAAC,CAAC,EAC9B,OAAO,CAAC,EAAE,UAAU,GACrB,YAAY;CAMlB"}

package/dist/db/document-reference.js

@@ -0,0 +1,125 @@
+import { firestoreResult, firestoreData } from './firestore-results.js';
+import { listenByPolling } from './snapshot-listener.js';
+import { DocumentSnapshot } from './document-snapshot.js';
+import { Timestamp } from './timestamp.js';
+import { FieldPath } from './field-path.js';
+import { normalizeUpdateArguments } from './write-request.js';
+import { validatePath } from './firestore-path.js';
+import { validateConverter } from './firestore-converter.js';
+/** A document location with read access and collection navigation. */
+export class DocumentReference {
+    firestore;
+    path;
+    execute;
+    converter;
+    onSnapshot(first, second, third) {
+        return listenByPolling(this.firestore, () => this.get().then(firestoreData), (current, previous) => previous?.isEqual(current) ? undefined : current, first, second, third);
+    }
+    async create(data) {
+        return firestoreResult(async () => {
+            return this.firestore._trace('DocumentReference.create', async () => {
+                const results = await this.firestore
+                    .batch()
+                    .create(this, data)
+                    .commit()
+                    .then(firestoreData);
+                return results[0];
+            });
+        });
+    }
+    async set(data, options) {
+        return firestoreResult(async () => {
+            return this.firestore._trace('DocumentReference.set', async () => {
+                const batch = this.firestore.batch();
+                if (options === undefined) {
+                    batch.set(this, data);
+                }
+                else {
+                    batch.set(this, data, options);
+                }
+                const results = await batch.commit().then(firestoreData);
+                return results[0];
+            });
+        });
+    }
+    async update(data, ...args) {
+        return firestoreResult(async () => {
+            return this.firestore._trace('DocumentReference.update', async () => {
+                const update = normalizeUpdateArguments(data, args);
+                const results = await this.firestore
+                    .batch()
+                    .update(this, update.data, update.precondition)
+                    .commit()
+                    .then(firestoreData);
+                return results[0];
+            });
+        });
+    }
+    async delete(precondition) {
+        return firestoreResult(async () => {
+            return this.firestore._trace('DocumentReference.delete', async () => {
+                const results = await this.firestore
+                    .batch()
+                    .delete(this, precondition)
+                    .commit()
+                    .then(firestoreData);
+                return results[0];
+            });
+        });
+    }
+    id;
+    /** @internal Obtain references from firestore.doc() or collection.doc(). */
+    constructor(firestore, path, execute, converter = null) {
+        this.firestore = firestore;
+        this.path = path;
+        this.execute = execute;
+        this.converter = converter;
+        validatePath(path, true);
+        this.id = path.split('/').at(-1);
+    }
+    get parent() {
+        return this.firestore
+            .collection(this.path.slice(0, this.path.lastIndexOf('/')))
+            .withConverter(this.converter);
+    }
+    collection(collectionPath) {
+        validatePath(collectionPath, false);
+        return this.firestore.collection(`${this.path}/${collectionPath}`);
+    }
+    async get() {
+        return firestoreResult(async () => {
+            return this.firestore._trace('DocumentReference.get', async () => {
+                const readTime = Timestamp.now();
+                const document = await this.execute(this.path);
+                return new DocumentSnapshot(this, document, readTime);
+            });
+        });
+    }
+    isEqual(other) {
+        if (!(other instanceof DocumentReference))
+            return false;
+        return (this.firestore === other.firestore &&
+            this.path === other.path &&
+            this.converter === other.converter);
+    }
+    withConverter(converter) {
+        validateConverter(converter);
+        return new DocumentReference(this.firestore, this.path, this.execute, converter);
+    }
+    listCollections() {
+        return firestoreResult(async () => {
+            return this.firestore._trace('DocumentReference.listCollections', async () => {
+                return this.firestore._listCollections(this.path);
+            });
+        });
+    }
+    /** @internal Updates deliberately bypass converters, matching Admin Firestore. */
+    _toFirestore(data, options) {
+        if (!this.converter)
+            return data;
+        if (options === undefined)
+            return this.converter.toFirestore(data);
+        return this.converter.toFirestore(data, options);
+    }
+}
+//# sourceMappingURL=document-reference.js.map

package/dist/db/document-reference.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-reference.js","sourceRoot":"","sources":["../../src/db/document-reference.ts"],"names":[],"mappings":"AAAA,OAAO,EAEH,eAAe,EACf,aAAa,EAChB,MAAM,wBAAwB,CAAC;AAOhC,OAAO,EACH,eAAe,EAIlB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAC;AAG9D,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAGnD,OAAO,EACH,iBAAiB,EAEpB,MAAM,0BAA0B,CAAC;AAMlC,sEAAsE;AACtE,MAAM,OAAO,iBAAiB;IAyHb;IACA;IACQ;IACR;IA9Gb,UAAU,CACN,KAEwD,EACxD,MAE2B,EAC3B,KAAqD;QAErD,OAAO,eAAe,CAClB,IAAI,CAAC,SAAS,EACd,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,EACpC,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE,CAClB,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,EACpD,KAAK,EACL,MAAM,EACN,KAAK,CACR,CAAC;IACN,CAAC;IACD,KAAK,CAAC,MAAM,CACR,IAAuB;QAEvB,OAAO,eAAe,CAAC,KAAK,IAAI,EAAE;YAC9B,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CACxB,0BAA0B,EAC1B,KAAK,IAAI,EAAE;gBACP,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,SAAS;qBAC/B,KAAK,EAAE;qBACP,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC;qBAClB,MAAM,EAAE;qBACR,IAAI,CAAC,aAAa,CAAC,CAAC;gBACzB,OAAO,OAAO,CAAC,CAAC,CAAE,CAAC;YACvB,CAAC,CACJ,CAAC;QACN,CAAC,CAAC,CAAC;IACP,CAAC;IAMD,KAAK,CAAC,GAAG,CACL,IAA8B,EAC9B,OAAoB;QAEpB,OAAO,eAAe,CAAC,KAAK,IAAI,EAAE;YAC9B,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,uBAAuB,EAAE,KAAK,IAAI,EAAE;gBAC7D,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;gBACrC,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;oBACxB,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,IAAyB,CAAC,CAAC;gBAC/C,CAAC;qBAAM,CAAC;oBACJ,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;gBACnC,CAAC;gBACD,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;gBACzD,OAAO,OAAO,CAAC,CAAC,CAAE,CAAC;YACvB,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;IAUD,KAAK,CAAC,MAAM,CACR,IAAuC,EACvC,GAAG,IAAe;QAElB,OAAO,eAAe,CAAC,KAAK,IAAI,EAAE;YAC9B,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CACxB,0BAA0B,EAC1B,KAAK,IAAI,EAAE;gBACP,MAAM,MAAM,GAAG,wBAAwB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBACpD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,SAAS;qBAC/B,KAAK,EAAE;qBACP,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,YAAY,CAAC;qBAC9C,MAAM,EAAE;qBACR,IAAI,CAAC,aAAa,CAAC,CAAC;gBACzB,OAAO,OAAO,CAAC,CAAC,CAAE,CAAC;YACvB,CAAC,CACJ,CAAC;QACN,CAAC,CAAC,CAAC;IACP,CAAC;IACD,KAAK,CAAC,MAAM,CACR,YAA2B;QAE3B,OAAO,eAAe,CAAC,KAAK,IAAI,EAAE;YAC9B,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CACxB,0BAA0B,EAC1B,KAAK,IAAI,EAAE;gBACP,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,SAAS;qBAC/B,KAAK,EAAE;qBACP,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC;qBAC1B,MAAM,EAAE;qBACR,IAAI,CAAC,aAAa,CAAC,CAAC;gBACzB,OAAO,OAAO,CAAC,CAAC,CAAE,CAAC;YACvB,CAAC,CACJ,CAAC;QACN,CAAC,CAAC,CAAC;IACP,CAAC;IACQ,EAAE,CAAS;IAEpB,4EAA4E;IAC5E,YACa,SAAoB,EACpB,IAAY,EACJ,OAAyB,EACjC,YAA2D,IAAI;QAH/D,cAAS,GAAT,SAAS,CAAW;QACpB,SAAI,GAAJ,IAAI,CAAQ;QACJ,YAAO,GAAP,OAAO,CAAkB;QACjC,cAAS,GAAT,SAAS,CAAsD;QAExE,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACzB,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAE,CAAC;IACtC,CAAC;IAED,IAAI,MAAM;QACN,OAAO,IAAI,CAAC,SAAS;aAChB,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;aAC1D,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACvC,CAAC;IAED,UAAU,CAAC,cAAsB;QAC7B,YAAY,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;QACpC,OAAO,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,IAAI,IAAI,cAAc,EAAE,CAAC,CAAC;IACvE,CAAC;IAED,KAAK,CAAC,GAAG;QACL,OAAO,eAAe,CAAC,KAAK,IAAI,EAAE;YAC9B,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,uBAAuB,EAAE,KAAK,IAAI,EAAE;gBAC7D,MAAM,QAAQ,GAAG,SAAS,CAAC,GAAG,EAAE,CAAC;gBACjC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC/C,OAAO,IAAI,gBAAgB,CAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;YAC1D,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;IAED,OAAO,CAAC,KAA6B;QACjC,IAAI,CAAC,CAAC,KAAK,YAAY,iBAAiB,CAAC;YAAE,OAAO,KAAK,CAAC;QACxD,OAAO,CACH,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS;YAClC,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI;YACxB,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS,CACrC,CAAC;IACN,CAAC;IASD,aAAa,CACT,SAA2D;QAE3D,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAC7B,OAAO,IAAI,iBAAiB,CACxB,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,OAAO,EACZ,SAAS,CACZ,CAAC;IACN,CAAC;IACD,eAAe;QACX,OAAO,eAAe,CAAC,KAAK,IAAI,EAAE;YAC9B,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CACxB,mCAAmC,EACnC,KAAK,IAAI,EAAE;gBACP,OAAO,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACtD,CAAC,CACJ,CAAC;QACN,CAAC,CAAC,CAAC;IACP,CAAC;IACD,kFAAkF;IAClF,YAAY,CACR,IAA8B,EAC9B,OAAoB;QAEpB,IAAI,CAAC,IAAI,CAAC,SAAS;YAAE,OAAO,IAAoB,CAAC;QACjD,IAAI,OAAO,KAAK,SAAS;YACrB,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,IAAyB,CAAC,CAAC;QACjE,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;CACJ"}

package/dist/db/document-snapshot.d.ts

@@ -0,0 +1,31 @@
+import { Timestamp } from './timestamp.js';
+import type { DocumentReference } from './document-reference.js';
+import { FieldPath } from './field-path.js';
+import { type FirestoreValue } from './firestore-document.js';
+import { type DocumentData, type FirestoreDocument } from './firestore-document.js';
+/** A document read result, including a result for a missing document. */
+export declare class DocumentSnapshot<T = DocumentData, DbModelType extends DocumentData = DocumentData> {
+    readonly ref: DocumentReference<T, DbModelType>;
+    private readonly document;
+    readonly id: string;
+    readonly exists: boolean;
+    readonly readTime: Timestamp;
+    get createTime(): Timestamp | undefined;
+    get updateTime(): Timestamp | undefined;
+    isEqual(other: unknown): boolean;
+    /** @internal Obtain snapshots from DocumentReference.get(). */
+    constructor(ref: DocumentReference<T, DbModelType>, document: FirestoreDocument | undefined, readTime?: Timestamp);
+    /** @internal Preserve raw fields and nanosecond timestamps for bundles. */
+    _bundleDocument(): FirestoreDocument | undefined;
+    data(): T | undefined;
+    get(fieldPath: string | FieldPath): unknown;
+    /** @internal Snapshot cursors use stored values, not converted application data. */
+    _getValue(fieldPath: string | FieldPath): FirestoreValue | undefined;
+}
+/** A query result always represents an existing document. */
+export declare class QueryDocumentSnapshot<T = DocumentData, DbModelType extends DocumentData = DocumentData> extends DocumentSnapshot<T, DbModelType> {
+    readonly exists: true;
+    constructor(ref: DocumentReference<T, DbModelType>, document: FirestoreDocument);
+    data(): T;
+}
+//# sourceMappingURL=document-snapshot.d.ts.map

package/dist/db/document-snapshot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-snapshot.d.ts","sourceRoot":"","sources":["../../src/db/document-snapshot.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAG3C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AACjE,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,OAAO,EAAe,KAAK,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC3E,OAAO,EAEH,KAAK,YAAY,EACjB,KAAK,iBAAiB,EACzB,MAAM,yBAAyB,CAAC;AAEjC,yEAAyE;AACzE,qBAAa,gBAAgB,CACzB,CAAC,GAAG,YAAY,EAChB,WAAW,SAAS,YAAY,GAAG,YAAY;IA6B3C,QAAQ,CAAC,GAAG,EAAE,iBAAiB,CAAC,CAAC,EAAE,WAAW,CAAC;IAC/C,OAAO,CAAC,QAAQ,CAAC,QAAQ;IA5B7B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;IAC7B,IAAI,UAAU,IAAI,SAAS,GAAG,SAAS,CAItC;IACD,IAAI,UAAU,IAAI,SAAS,GAAG,SAAS,CAItC;IACD,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAYhC,+DAA+D;gBAElD,GAAG,EAAE,iBAAiB,CAAC,CAAC,EAAE,WAAW,CAAC,EAC9B,QAAQ,EAAE,iBAAiB,GAAG,SAAS,EACxD,QAAQ,YAAkB;IAQ9B,2EAA2E;IAC3E,eAAe,IAAI,iBAAiB,GAAG,SAAS;IAShD,IAAI,IAAI,CAAC,GAAG,SAAS;IAWrB,GAAG,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO;IAM3C,oFAAoF;IACpF,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,GAAG,cAAc,GAAG,SAAS;CAiBvE;AAED,6DAA6D;AAC7D,qBAAa,qBAAqB,CAC9B,CAAC,GAAG,YAAY,EAChB,WAAW,SAAS,YAAY,GAAG,YAAY,CACjD,SAAQ,gBAAgB,CAAC,CAAC,EAAE,WAAW,CAAC;IACtC,SAAkB,MAAM,EAAG,IAAI,CAAU;gBAErC,GAAG,EAAE,iBAAiB,CAAC,CAAC,EAAE,WAAW,CAAC,EACtC,QAAQ,EAAE,iBAAiB;IAUtB,IAAI,IAAI,CAAC;CAGrB"}

package/dist/db/document-snapshot.js

@@ -0,0 +1,103 @@
+import { FirestoreErrorInfo } from './firestore-error-codes.js';
+import { Timestamp } from './timestamp.js';
+import { valueEquals } from './value-equality.js';
+import { FirebaseEdgeError } from '../auth/errors.js';
+import { FieldPath } from './field-path.js';
+import { validateFieldPath } from './query-request.js';
+import { decodeValue } from './firestore-document.js';
+import { decodeFields } from './firestore-document.js';
+/** A document read result, including a result for a missing document. */
+export class DocumentSnapshot {
+    ref;
+    document;
+    id;
+    exists;
+    readTime;
+    get createTime() {
+        return this.document?.createTime
+            ? Timestamp.fromString(this.document.createTime)
+            : undefined;
+    }
+    get updateTime() {
+        return this.document?.updateTime
+            ? Timestamp.fromString(this.document.updateTime)
+            : undefined;
+    }
+    isEqual(other) {
+        return (other instanceof DocumentSnapshot &&
+            this.ref.isEqual(other.ref) &&
+            this.exists === other.exists &&
+            valueEquals(this.document?.fields ?? {}, other.document?.fields ?? {}));
+    }
+    /** @internal Obtain snapshots from DocumentReference.get(). */
+    constructor(ref, document, readTime = Timestamp.now()) {
+        this.ref = ref;
+        this.document = document;
+        this.id = ref.id;
+        this.exists = document !== undefined && !document.missing;
+        this.readTime = document?.readTime
+            ? Timestamp.fromString(document.readTime)
+            : readTime;
+    }
+    /** @internal Preserve raw fields and nanosecond timestamps for bundles. */
+    _bundleDocument() {
+        if (!this.exists || !this.document)
+            return undefined;
+        const { readTime: _, ...document } = this.document;
+        return structuredClone({
+            ...document,
+            name: this.ref.firestore._documentName(this.ref.path)
+        });
+    }
+    data() {
+        if (!this.exists || this.document === undefined)
+            return undefined;
+        if (!this.ref.converter)
+            return decodeFields(this.document.fields, this.ref.firestore);
+        const raw = new QueryDocumentSnapshot(this.ref.withConverter(null), this.document);
+        return this.ref.converter.fromFirestore(raw);
+    }
+    get(fieldPath) {
+        const value = this._getValue(fieldPath);
+        if (value === undefined)
+            return undefined;
+        return decodeValue(value, this.ref.firestore);
+    }
+    /** @internal Snapshot cursors use stored values, not converted application data. */
+    _getValue(fieldPath) {
+        if (!(fieldPath instanceof FieldPath))
+            validateFieldPath(fieldPath);
+        const segments = fieldPath instanceof FieldPath
+            ? fieldPath.segments
+            : fieldPath.split('.');
+        let fields = this.document?.fields;
+        for (let index = 0; index < segments.length; index++) {
+            const segment = segments[index];
+            if (!fields || !Object.hasOwn(fields, segment))
+                return undefined;
+            const value = fields[segment];
+            if (index === segments.length - 1)
+                return value;
+            if (!('mapValue' in value))
+                return undefined;
+            fields = value.mapValue.fields;
+        }
+        return undefined;
+    }
+}
+/** A query result always represents an existing document. */
+export class QueryDocumentSnapshot extends DocumentSnapshot {
+    exists = true;
+    constructor(ref, document) {
+        if (!document || document.missing)
+            throw new FirebaseEdgeError({
+                ...FirestoreErrorInfo.INVALID_ARGUMENT,
+                message: 'A query document snapshot requires an existing document.'
+            });
+        super(ref, document);
+    }
+    data() {
+        return super.data();
+    }
+}
+//# sourceMappingURL=document-snapshot.js.map

package/dist/db/document-snapshot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-snapshot.js","sourceRoot":"","sources":["../../src/db/document-snapshot.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAEtD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAuB,MAAM,yBAAyB,CAAC;AAC3E,OAAO,EACH,YAAY,EAGf,MAAM,yBAAyB,CAAC;AAEjC,yEAAyE;AACzE,MAAM,OAAO,gBAAgB;IA+BZ;IACQ;IA5BZ,EAAE,CAAS;IACX,MAAM,CAAU;IAChB,QAAQ,CAAY;IAC7B,IAAI,UAAU;QACV,OAAO,IAAI,CAAC,QAAQ,EAAE,UAAU;YAC5B,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC;YAChD,CAAC,CAAC,SAAS,CAAC;IACpB,CAAC;IACD,IAAI,UAAU;QACV,OAAO,IAAI,CAAC,QAAQ,EAAE,UAAU;YAC5B,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC;YAChD,CAAC,CAAC,SAAS,CAAC;IACpB,CAAC;IACD,OAAO,CAAC,KAAc;QAClB,OAAO,CACH,KAAK,YAAY,gBAAgB;YACjC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC;YAC3B,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM;YAC5B,WAAW,CACP,IAAI,CAAC,QAAQ,EAAE,MAAM,IAAI,EAAE,EAC3B,KAAK,CAAC,QAAQ,EAAE,MAAM,IAAI,EAAE,CAC/B,CACJ,CAAC;IACN,CAAC;IAED,+DAA+D;IAC/D,YACa,GAAsC,EAC9B,QAAuC,EACxD,QAAQ,GAAG,SAAS,CAAC,GAAG,EAAE;QAFjB,QAAG,GAAH,GAAG,CAAmC;QAC9B,aAAQ,GAAR,QAAQ,CAA+B;QAGxD,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,EAAE,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,QAAQ,KAAK,SAAS,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;QAC1D,IAAI,CAAC,QAAQ,GAAG,QAAQ,EAAE,QAAQ;YAC9B,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC;YACzC,CAAC,CAAC,QAAQ,CAAC;IACnB,CAAC;IACD,2EAA2E;IAC3E,eAAe;QACX,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ;YAAE,OAAO,SAAS,CAAC;QACrD,MAAM,EAAE,QAAQ,EAAE,CAAC,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC;QACnD,OAAO,eAAe,CAAC;YACnB,GAAG,QAAQ;YACX,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC;SACxD,CAAC,CAAC;IACP,CAAC;IAED,IAAI;QACA,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS;YAAE,OAAO,SAAS,CAAC;QAClE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS;YACnB,OAAO,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,SAAS,CAAM,CAAC;QACvE,MAAM,GAAG,GAAG,IAAI,qBAAqB,CACjC,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,EAC5B,IAAI,CAAC,QAAQ,CAChB,CAAC;QACF,OAAO,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IACjD,CAAC;IAED,GAAG,CAAC,SAA6B;QAC7B,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QACxC,IAAI,KAAK,KAAK,SAAS;YAAE,OAAO,SAAS,CAAC;QAC1C,OAAO,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAClD,CAAC;IAED,oFAAoF;IACpF,SAAS,CAAC,SAA6B;QACnC,IAAI,CAAC,CAAC,SAAS,YAAY,SAAS,CAAC;YAAE,iBAAiB,CAAC,SAAS,CAAC,CAAC;QACpE,MAAM,QAAQ,GACV,SAAS,YAAY,SAAS;YAC1B,CAAC,CAAC,SAAS,CAAC,QAAQ;YACpB,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,MAAM,GAAG,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC;QACnC,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;YACnD,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAE,CAAC;YACjC,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;gBAAE,OAAO,SAAS,CAAC;YACjE,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAE,CAAC;YAC/B,IAAI,KAAK,KAAK,QAAQ,CAAC,MAAM,GAAG,CAAC;gBAAE,OAAO,KAAK,CAAC;YAChD,IAAI,CAAC,CAAC,UAAU,IAAI,KAAK,CAAC;gBAAE,OAAO,SAAS,CAAC;YAC7C,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC;QACnC,CAAC;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;CACJ;AAED,6DAA6D;AAC7D,MAAM,OAAO,qBAGX,SAAQ,gBAAgC;IACpB,MAAM,GAAG,IAAa,CAAC;IACzC,YACI,GAAsC,EACtC,QAA2B;QAE3B,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,OAAO;YAC7B,MAAM,IAAI,iBAAiB,CAAC;gBACxB,GAAG,kBAAkB,CAAC,gBAAgB;gBACtC,OAAO,EACH,0DAA0D;aACjE,CAAC,CAAC;QACP,KAAK,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IACzB,CAAC;IACQ,IAAI;QACT,OAAO,KAAK,CAAC,IAAI,EAAG,CAAC;IACzB,CAAC;CACJ"}

package/dist/db/explain.d.ts

@@ -0,0 +1,28 @@
+export interface ExplainOptions {
+    analyze?: boolean;
+}
+export interface PlanSummary {
+    indexesUsed: Record<string, unknown>[];
+}
+export interface ExecutionStats {
+    resultsReturned: number;
+    executionDuration: {
+        seconds: number;
+        nanoseconds: number;
+    };
+    readOperations: number;
+    debugStats: Record<string, unknown>;
+}
+export interface ExplainMetrics {
+    planSummary: PlanSummary;
+    executionStats: ExecutionStats | null;
+}
+export interface ExplainResults<T> {
+    metrics: ExplainMetrics;
+    snapshot: T | null;
+}
+/** @internal Validate options before any request. */
+export declare function validateExplainOptions(options: ExplainOptions): void;
+/** @internal Convert protobuf JSON numbers and duration into SDK metric types. */
+export declare function parseExplainMetrics(input: unknown): ExplainMetrics;
+//# sourceMappingURL=explain.d.ts.map

package/dist/db/explain.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"explain.d.ts","sourceRoot":"","sources":["../../src/db/explain.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,cAAc;IAC3B,OAAO,CAAC,EAAE,OAAO,CAAC;CACrB;AACD,MAAM,WAAW,WAAW;IACxB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;CAC1C;AACD,MAAM,WAAW,cAAc;IAC3B,eAAe,EAAE,MAAM,CAAC;IACxB,iBAAiB,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;IAC5D,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACvC;AACD,MAAM,WAAW,cAAc;IAC3B,WAAW,EAAE,WAAW,CAAC;IACzB,cAAc,EAAE,cAAc,GAAG,IAAI,CAAC;CACzC;AACD,MAAM,WAAW,cAAc,CAAC,CAAC;IAC7B,OAAO,EAAE,cAAc,CAAC;IACxB,QAAQ,EAAE,CAAC,GAAG,IAAI,CAAC;CACtB;AAED,qDAAqD;AACrD,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,cAAc,GAAG,IAAI,CAWpE;AACD,kFAAkF;AAClF,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,OAAO,GAAG,cAAc,CA0DlE"}

package/dist/db/explain.js

@@ -0,0 +1,61 @@
+import { FirebaseEdgeError } from '../auth/errors.js';
+import { FirestoreErrorInfo } from './firestore-error-codes.js';
+/** @internal Validate options before any request. */
+export function validateExplainOptions(options) {
+    if (!options ||
+        typeof options !== 'object' ||
+        Array.isArray(options) ||
+        (options.analyze !== undefined && typeof options.analyze !== 'boolean'))
+        throw new FirebaseEdgeError({
+            ...FirestoreErrorInfo.INVALID_ARGUMENT,
+            message: 'Invalid explain options.'
+        });
+}
+/** @internal Convert protobuf JSON numbers and duration into SDK metric types. */
+export function parseExplainMetrics(input) {
+    const value = input;
+    if (!value ||
+        typeof value !== 'object' ||
+        !value.planSummary ||
+        (value.planSummary.indexesUsed !== undefined &&
+            !Array.isArray(value.planSummary.indexesUsed)))
+        throw new FirebaseEdgeError({
+            ...FirestoreErrorInfo.INVALID_RESPONSE,
+            message: 'Invalid explain metrics.'
+        });
+    const result = {
+        planSummary: { indexesUsed: value.planSummary.indexesUsed ?? [] },
+        executionStats: null
+    };
+    if (!value.executionStats)
+        return result;
+    const stats = value.executionStats;
+    if (typeof stats !== 'object' || Array.isArray(stats))
+        throw new FirebaseEdgeError({
+            ...FirestoreErrorInfo.INVALID_RESPONSE,
+            message: 'Invalid execution statistics.'
+        });
+    const duration = /^(\d+)(?:\.(\d{1,9}))?s$/.exec(stats.executionDuration ?? '0s');
+    const resultsReturned = Number(stats.resultsReturned ?? 0);
+    const readOperations = Number(stats.readOperations ?? 0);
+    if (!duration ||
+        !Number.isSafeInteger(resultsReturned) ||
+        resultsReturned < 0 ||
+        !Number.isSafeInteger(readOperations) ||
+        readOperations < 0)
+        throw new FirebaseEdgeError({
+            ...FirestoreErrorInfo.INVALID_RESPONSE,
+            message: 'Invalid execution statistics.'
+        });
+    result.executionStats = {
+        resultsReturned,
+        readOperations,
+        executionDuration: {
+            seconds: Number(duration[1]),
+            nanoseconds: Number((duration[2] ?? '').padEnd(9, '0'))
+        },
+        debugStats: stats.debugStats ?? {}
+    };
+    return result;
+}
+//# sourceMappingURL=explain.js.map