feat: optionally allow validatorOptions of class-validator

[rinkstiekema]

The validate function from class-validator has the optional function validatorOptions. An example usage that makes sense for FireORM would be forbidding non-whitelisted values, such that document will not be polluted accidentally. Find validatorOptions documentation here

I have added an optional property validatorOptions to MetadataStorageConfig, hope the code and tests are up to standards!

[codecov]

Codecov Report

Merging #233 (96175fa) into master (b66b24e) will increase coverage by 0.02%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master     #233      +/-   ##
==========================================
+ Coverage   94.85%   94.88%   +0.02%     
==========================================
  Files          24       24              
  Lines         583      586       +3     
  Branches       95       95              
==========================================
+ Hits          553      556       +3     
  Misses         27       27              
  Partials        3        3              

Impacted Files	Coverage Δ
src/MetadataStorage.ts	100.00% <ø> (ø)
src/AbstractFirestoreRepository.ts	90.72% <100.00%> (+0.09%)	⬆️
src/BaseFirestoreRepository.ts	100.00% <100.00%> (ø)
src/Batch/BaseFirestoreBatchRepository.ts	95.83% <100.00%> (ø)
src/Batch/FirestoreBatchUnit.ts	90.00% <100.00%> (ø)
src/MetadataUtils.ts	100.00% <100.00%> (ø)
.../Transaction/BaseFirestoreTransactionRepository.ts	86.95% <100.00%> (+0.28%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b66b24e...96175fa. Read the comment docs.

[wovalle]

This looks good!

I don't love the idea to test the internals of ClassValidator inside BaseFirestoreRepository (like testing if it whitelists or not) but I guess we have no other place to do it for now (until #198 is done).

I see that there are lint issues in the test, you can use prettier --write . to fix them 😄

[rinkstiekema]

Yes I think you are right. I wrote those tests like this to check whether the validatorOptions were actually applied to all database operations, not so much to test the internals of ClassValidator. Very similar to the must not validate if the validateModels: false test.

I might take some time to take up #198 sometime soon, as I think integrated validation is a great feature of FireORM. Might aswell show some appreciation for a great project!

[wovalle]

@all-contributors add @rinkstiekema for code

[allcontributors]

@wovalle

I've put up a pull request to add @rinkstiekema! 🎉

[whateverbot]

🎉 This PR is included in version 0.20.0 🎉

The release is available on:

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

Your semantic-release bot 📦🚀