@typed-firestore/server/src/documents/make-mutable-document.ts

Elegant, typed abstractions for Firestore in server environments

import type {
  DocumentData,
  DocumentSnapshot,
  PartialWithFieldValue,
  Transaction,
  UpdateData,
} from "firebase-admin/firestore";
import type { FsMutableDocument, FsMutableDocumentTx } from "~/types";

export function makeMutableDocument<
  TNarrowOrFull extends DocumentData,
  TFull extends DocumentData = TNarrowOrFull,
>(
  doc: DocumentSnapshot<TNarrowOrFull>
): FsMutableDocument<TNarrowOrFull, TFull> {
  const data = doc.data();
  return {
    id: doc.id,
    data: data as TNarrowOrFull,
    ref: doc.ref,
    update: (data: UpdateData<TFull>) => doc.ref.update(data),
    updateWithPartial: (data: PartialWithFieldValue<TFull>) =>
      doc.ref.update(data as UpdateData<TFull>),
    delete: () => doc.ref.delete(),
  };
}

export function makeMutableDocumentTx<
  TNarrowOrFull extends DocumentData,
  TFull extends DocumentData = TNarrowOrFull,
>(
  tx: Transaction,
  doc: DocumentSnapshot<TNarrowOrFull>
): FsMutableDocumentTx<TNarrowOrFull, TFull> {
  const data = doc.data();
  return {
    id: doc.id,
    data: data as TNarrowOrFull,
    ref: doc.ref,
    update: (data: UpdateData<TFull>) => tx.update(doc.ref, data),
    updateWithPartial: (data: PartialWithFieldValue<TFull>) =>
      tx.update(doc.ref, data as UpdateData<TFull>),
    delete: () => tx.delete(doc.ref),
  };
}