feat: support for leanWithVirtuals option to work with mongoose-lean-virtuals plugin

[nexus-aissam]

Description

Added support for leanWithVirtuals option to work seamlessly with the mongoose-lean-virtuals plugin. This enhancement allows virtual properties to be included in lean queries when using pagination.

Changes Made

• Added leanWithVirtuals option to the pagination options
• When leanWithVirtuals: true, the plugin will apply lean virtuals to the query
• Maintained backward compatibility with existing lean options
• Works in conjunction with mongoose-lean-virtuals plugin

Use Case Example

const options = {
  lean: true,
  leanWithVirtuals: true
};
Model.paginate({}, options);

[aravindnc]

@nexus-aissam Thanks. Can you please add some test cases too.

[nexus-aissam]

Response to Test Case Addition

@aravindnc I have added a test case that verifies the leanWithVirtuals functionality. The test confirms the following functionality:

it('should work with lean and leanWithVirtuals options', async function () {
    var options = {
        limit: 10,
        page: 1,
        lean: true,
        leanWithVirtuals: true,
        populate: {
            path: 'user'
        }
    };
    // Test verifies:
    // 1. Virtual fields in populated docs
    // 2. Lean object conversion
    // 3. Correct virtual field computation
    // 4. Pagination functionality
});

Test Coverage

• ✅ Virtual fields inclusion in populated documents
• ✅ Lean object conversion verification
• ✅ Virtual field value computation
• ✅ Pagination functionality with options enabled

[aravindnc]

Awesome. Thanks for the support. I've updated the package. @nexus-aissam