feat(document): add support for getAtomics() to allow custom container types to utilize atomics

[vkarpov15]

Summary

Right now, only container types that extend from Mongoose arrays can take advantage of atomics (change tracking so, for example, push() translates to $push in save()). That's problematic for trying to implement custom types like Sets.

This PR makes Mongoose look for a getAtomics() function on values, so custom types can use atomics without having to implement an internal method like $__atomics().

Similarly, I added clearAtomics() which allows Mongoose to clear custom types' atomics after successful save

Examples

[Copilot]

Pull request overview

This PR adds support for custom container types (like Sets) to utilize Mongoose's atomic operations tracking without needing to extend from MongooseArray. It introduces a new public getAtomics() method that custom types can implement to provide atomic operations during document save.

Key changes:

• Added public getAtomics() method to MongooseArray as an alias for $__getAtomics()
• Modified document save logic to check for getAtomics() function instead of MongooseArray-specific properties
• Enabled custom container types to participate in atomic operations by implementing getAtomics()

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.

File	Description
lib/types/array/methods/index.js	Adds public getAtomics() method to MongooseArray as an API for custom types
lib/document.js	Updates $__delta and handleAtomics to detect and use getAtomics() for atomic operations

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.