feat(document): add flattenUUIDs option to toObject() and toJSON()
#15864
+203
−16
Conversation
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
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a flattenUUIDs option to the toObject() and toJSON() document methods, enabling conversion of UUID instances to 36-character hex strings. This feature mirrors the existing flattenObjectIds functionality and is useful for JSON serialization scenarios where UUID objects need to be represented as strings.
Key Changes
- Added
flattenUUIDsoption toToObjectOptionsinterface and document transformation methods - Implemented UUID-to-string conversion logic in the clone helper
- Renamed
UUIDToJSONtype toUUIDToStringwith backward-compatible alias - Added comprehensive tests for UUID flattening with nested objects, subdocuments, and document arrays
Reviewed changes
Copilot reviewed 5 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| types/index.d.ts | Added flattenUUIDs option to ToObjectOptions interface, implemented UUIDToString<T> type helper, and added deprecated UUIDToJSON alias |
| types/document.d.ts | Added method overloads for toObject() and toJSON() supporting flattenUUIDs option with and without virtuals |
| test/types/document.test.ts | Added TypeScript type tests verifying UUID-to-string conversion behavior |
| test/document.test.js | Added comprehensive JavaScript tests covering UUID flattening in various scenarios including nested objects, subdocuments, and arrays |
| lib/options.js | Added flattenUUIDs: false to default internal options |
| lib/helpers/clone.js | Implemented UUID instance detection and conversion to string when flattenUUIDs option is enabled |
| lib/document.js | Added JSDoc documentation for the new flattenUUIDs option in both toObject() and toJSON() methods |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
hasezoey
approved these changes
Dec 4, 2025
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.
Summary
flattenUUIDsoption totoObject()andtoJSON()that converts UUID instances to 36-character hex strings, similar toflattenObjectIdsUUIDToString<T>type helper and method overloadsUUIDToJSONtoUUIDToStringfor consistency withObjectIdToString, keepingUUIDToJSONas a deprecated alias for backwards compatibilityFixes #15021