feat: add maxPopulateDepth configuration with getter/setter

[matiaslopezd]

This pull request introduces a new configuration option to control the depth of population for referenced documents in the MongooseDummy class. The main change is the addition of a maxPopulateDepth property, which allows users to specify how many levels deep referenced documents should be populated when generating dummy data. Comprehensive tests have been added to verify the correct behavior for various depth settings.

Configuration and API changes

• Added a maxPopulateDepth property to the MongooseDummy class, with a default value of 1. This property is accessible via getter/setter and can be set through the setup method. (src/index.js, [1] [2]
• Updated the population logic in evaluateDummy and evaluateObjectId methods to respect the maxPopulateDepth setting, ensuring referenced documents are only populated up to the specified depth. (src/index.js, [1] [2]

Testing

• Added a suite of tests to verify the maxPopulateDepth behavior, including default depth, zero population, multi-level population, configuration via setup, usage of getter/setter, and handling of nested subdocuments. (test/unit.test.js, test/unit.test.jsR205-R307)

[github-actions]

🎉 This PR is included in version 1.5.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀