Rename transaction methods to Tx suffix - #12
Merged
Conversation
Align naming with @typed-firestore/server by using the Tx suffix convention. Fix getDocumentTx and getDocumentMaybeTx to use transaction-bound mutations instead of standalone ones. Fix getSpecificDocumentTx to return a mutable document instead of an immutable one. Deprecated re-exports are added for backward compatibility.
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the library’s public API naming to use a Tx suffix for transaction-aware helpers (matching the @typed-firestore/server convention) and fixes transaction mutation behavior to correctly bind updates/deletes to the provided Firestore transaction.
Changes:
- Renames transaction variants to
*Tx(withMaybebeforeTx) and adds deprecated aliases for prior names. - Fixes transaction helpers to use
makeMutableDocumentTxso mutations don’t bypass the transaction. - Ensures
getSpecificDocumentTxreturns a mutable transaction document type and updates docs accordingly.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/types.ts | Introduces FsMutableDocumentTx and deprecates FsMutableDocumentInTransaction alias. |
| src/make-mutable-document.ts | Adds makeMutableDocumentTx, deprecates makeMutableDocumentInTransaction. |
| src/get-specific-document.ts | Renames transaction accessor to getSpecificDocumentTx and returns a mutable Tx document. |
| src/get-document.ts | Renames transaction accessors to getDocumentTx / getDocumentMaybeTx and binds mutations to Tx. |
| README.md | Updates documented function list to reflect new *Tx naming. |
| CLAUDE.md | Updates type naming reference for transaction variant. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Rename
InTransaction/FromTransactionnaming to theTxsuffix convention used by@typed-firestore/server. TheTxsuffix goes at the end, withMaybebefore it (e.g.getDocumentMaybeTx).Fixes two bugs:
getDocumentTxandgetDocumentMaybeTxwere usingmakeMutableDocumentinstead ofmakeMutableDocumentTx, so mutations bypassed the transaction.getSpecificDocumentTxwas returning an immutableFsDocumentinstead of a mutableFsMutableDocumentTx.Deprecated re-exports are provided for all old names to maintain backward compatibility.