mongodb-pipeline-builder 3.3.0

package/CHANGELOG.md

@@ -0,0 +1,362 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+## [3.3.0](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v3.2.3...v3.3.0) (2021-09-17)
+
+
+### Features
+
+* add the GetTotalPageNumber method to the methods that can be used when paging with the GetResult method ([c885926](https://github.com/MikeDev75015/mongodb-pipeline-builder/commit/c885926eefcaa80b641f4062d5cf9e90438130fe))
+
+
+### Bug Fixes
+
+* correct some array operators ([6e50682](https://github.com/MikeDev75015/mongodb-pipeline-builder/commit/6e506823967a2b28cfd4e161d6a7bf1fd102e9a4))
+
+### [3.2.3](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v3.2.2...v3.2.3) (2021-07-19)
+
+
+### Bug Fixes
+
+* correct the path to index.js and index.d.ts files in package.json ([2ecd7a5](https://github.com/MikeDev75015/mongodb-pipeline-builder/commit/2ecd7a56462d8959b78163f697d5c576bbd39d0c))
+
+### [3.2.2](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v3.2.1...v3.2.2) (2021-07-18)
+
+
+### Bug Fixes
+
+* correct the value returned by the GetDocs method for a pagination result ([f83f4f0](https://github.com/MikeDev75015/mongodb-pipeline-builder/commit/f83f4f08e91c5065df1d1edb1ba79100cc231f22))
+
+### [3.2.1](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v3.2.0...v3.2.1) (2021-07-14)
+
+
+### Bug Fixes
+
+* correct the interpretation of 0 as not valid when passed as an argument of the GetDocs method ([f32531d](https://github.com/MikeDev75015/mongodb-pipeline-builder/commit/f32531de6404a46270d766c2d09c927f8ffab6d5))
+
+## [3.2.0](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v3.1.2...v3.2.0) (2021-07-11)
+
+
+### Features
+
+* add the ability to get a particular item when using the GetDocs, increase the reliability of the pipeline parameter of the GetResult method ([ee6d745](https://github.com/MikeDev75015/mongodb-pipeline-builder/commit/ee6d7453db77898c592be025c14a80dd934e9fb3))
+
+### [3.1.2](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v3.1.1...v3.1.2) (2021-07-09)
+
+### [3.1.1](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v3.1.0...v3.1.1) (2021-06-08)
+
+## [3.1.0](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v3.0.0...v3.1.0) (2021-06-02)
+
+
+### Features
+
+* add the ability to pass a single object with multiple properties in the Facet method ([8401905](https://github.com/MikeDev75015/mongodb-pipeline-builder/commit/84019059b220d1d11681d545e2411fd6bdba563b))
+* add the possibility of testing undefined values ([9afca54](https://github.com/MikeDev75015/mongodb-pipeline-builder/commit/9afca54f5ab471236fd7710b4490ae86ee30e4eb))
+
+## [3.0.0](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v2.7.7...v3.0.0) (2021-04-06)
+
+
+### ⚠ BREAKING CHANGES
+
+* Add the possibility of using one or more Field
+helper(s)
+
+* change the Facet payload ([459bf0a](https://github.com/MikeDev75015/mongodb-pipeline-builder/commit/459bf0acc89132a595653c76e74136de786a3c2f))
+
+### [2.7.7](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v2.7.6...v2.7.7) (2021-04-06)
+
+### [2.7.6](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v2.7.5...v2.7.6) (2021-04-05)
+
+### [2.7.5](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v2.7.4...v2.7.5) (2021-04-05)
+
+### [2.7.4](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v2.7.3...v2.7.4) (2021-04-05)
+
+### [2.7.3](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v2.7.2...v2.7.3) (2021-04-01)
+
+### [2.7.2](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v2.7.1...v2.7.2) (2021-04-01)
+
+### [2.7.1](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v2.7.0...v2.7.1) (2021-04-01)
+
+## [2.7.0](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v2.6.3-1...v2.7.0) (2021-03-30)
+
+
+### Features
+
+* add pipeline name decorator validation rules ([1370ea6](https://github.com/MikeDev75015/mongodb-pipeline-builder/commit/1370ea6bf90709ead9ca37d1cc3f9a01ac0c625d))
+
+### [2.6.3-1](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v2.6.3-0...v2.6.3-1) (2021-03-30)
+
+### [2.6.3-0](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v2.6.2...v2.6.3-0) (2021-03-30)
+
+### [2.6.2](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v2.6.1...v2.6.2) (2021-03-30)
+
+### [2.6.1](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v2.6.0...v2.6.1) (2021-03-29)
+
+## [2.6.0](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v2.5.0...v2.6.0) (2021-03-29)
+
+
+### Features
+
+* add currentOp OpPayload helper ([b47c269](https://github.com/MikeDev75015/mongodb-pipeline-builder/commit/b47c269fe791b73ba678d12f176d75e66dd44939))
+
+## [2.5.0](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v2.4.2...v2.5.0) (2021-03-26)
+
+
+### Features
+
+* add geoNear NearPayload helper ([9d973b0](https://github.com/MikeDev75015/mongodb-pipeline-builder/commit/9d973b0ab36e4ff6f55732713137d70f6997825f))
+
+### [2.4.2](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v2.4.1...v2.4.2) (2021-03-24)
+
+### [2.4.1](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v2.4.0...v2.4.1) (2021-03-24)
+
+## [2.4.0](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v22.3.2...v2.4.0) (2021-03-24)
+
+
+### Features
+
+* add GetResult super method ([d744405](https://github.com/MikeDev75015/mongodb-pipeline-builder/commit/d744405e8da141438dbd201f47900e726037cfe7))
+
+### [2.3.2](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v2.3.1...v2.3.2) (2021-03-23)
+
+### [2.3.1](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v2.3.0...v2.3.1) (2021-03-23)
+
+## [2.3.0](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v2.2.0...v2.3.0) (2021-03-23)
+
+
+### Features
+
+* Add a check if a Skip, Limit or Count stage is already in the pipeline ([6913cb3](https://github.com/MikeDev75015/mongodb-pipeline-builder/commit/6913cb35f730d8889ed774dd6304a4023c4d1ad2))
+
+## [2.2.0](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v2.1.0...v2.2.0) (2021-03-23)
+
+
+### Features
+
+* add a Paging method that will automatically add the necessary stages to paginate the pipeline results ([f78cfb5](https://github.com/MikeDev75015/mongodb-pipeline-builder/commit/f78cfb51bef33a229d1e32b45dc4d1ac2f07f98d))
+
+## [2.1.0](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v2.0.4...v2.1.0) (2021-03-23)
+
+
+### Features
+
+* add DbCollPayload helper for the Out method ([663f2bf](https://github.com/MikeDev75015/mongodb-pipeline-builder/commit/663f2bf86ec6882476bb83e3fb820ba1196396bb))
+
+### [2.0.4](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v2.0.3...v2.0.4) (2021-03-22)
+
+### [2.0.3](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v2.0.2...v2.0.3) (2021-03-22)
+
+### [2.0.2](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v2.0.1...v2.0.2) (2021-03-22)
+
+### [2.0.1](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v2.0.0...v2.0.1) (2021-03-22)
+
+
+### Bug Fixes
+
+* fix to enable debug mode by modifying import of moment.js library ([a973cb0](https://github.com/MikeDev75015/mongodb-pipeline-builder/commit/a973cb076f14686e505bc90940f869b24cce9084))
+
+## [2.0.0](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v1.1.0...v2.0.0) (2021-03-22)
+
+
+### ⚠ BREAKING CHANGES
+
+* modify the payload arguments by adding an optional argument containing all optional payload parameters ([b258e26](https://github.com/MikeDev75015/mongodb-pipeline-builder/commit/b258e26dfdb8897ca447af036771e09f63e4b3c0))
+
+## [1.1.0](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v1.0.1...v1.1.0) (2021-03-22)
+
+
+### Features
+
+* add merge IntoPayload helper ([91b73f1](https://github.com/MikeDev75015/mongodb-pipeline-builder/commit/91b73f1a06d983836b2afdefd91ed81d78886906))
+
+### [1.0.1](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-72...v1.0.1) (2021-03-21)
+
+## [1.0.0](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-72...v1.0.0) (2021-03-21)
+
+### [0.0.2-72](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-71...v0.0.2-72) (2021-03-21)
+
+
+### Features
+
+* add bucket auto GroupByAutoPayload helper ([344b46c](https://github.com/MikeDev75015/mongodb-pipeline-builder/commit/344b46c1342988cd411585ef87f12d338cfcecac))
+* add sample SizePayload helper ([c8d05f7](https://github.com/MikeDev75015/mongodb-pipeline-builder/commit/c8d05f7cda38fbf96c6832e697ea634e2f04f84f))
+* add unionWith CollectionPayload helper ([938bcaa](https://github.com/MikeDev75015/mongodb-pipeline-builder/commit/938bcaad9692df2cb57dd63277056cf44a900aec))
+
+### [0.0.2-71](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-70...v0.0.2-71) (2021-03-21)
+
+
+### Features
+
+* add bucket GroupByPayload helper ([03fb8d6](https://github.com/MikeDev75015/mongodb-pipeline-builder/commit/03fb8d697439b154febdc29616bd8c752d0ca70e))
+
+### [0.0.2-70](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-69...v0.0.2-70) (2021-03-21)
+
+### [0.0.2-69](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-68...v0.0.2-69) (2021-03-21)
+
+
+### Bug Fixes
+
+* github script in circleci pipeline to delete develop branch when release is ready to merge ([fd11909](https://github.com/MikeDev75015/mongodb-pipeline-builder/commit/fd11909414eb9bb0c73b6f8b002c2aa5daadfb12))
+
+### [0.0.2-68](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-67...v0.0.2-68) (2021-03-20)
+
+### [0.0.2-67](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-66...v0.0.2-67) (2021-03-20)
+
+
+### Features
+
+* add Property helper to create a javascript object ([62855da](https://github.com/MikeDev75015/mongodb-pipeline-builder/commit/62855da58b42c0da372e2009bf514c5d66638b4f))
+* add the ability to pass an object or a list to AddFields ([9c97026](https://github.com/MikeDev75015/mongodb-pipeline-builder/commit/9c97026efe2da77a98291911fea30aa8a8a599a3))
+
+### [0.0.2-66](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-65...v0.0.2-66) (2021-03-20)
+
+
+### Features
+
+* add new helper List ([8dc7919](https://github.com/MikeDev75015/mongodb-pipeline-builder/commit/8dc791950e889f972941f6f152f0c38dd915ccf2))
+
+### [0.0.2-65](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-64...v0.0.2-65) (2021-03-20)
+
+### [0.0.2-64](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-63...v0.0.2-64) (2021-03-20)
+
+### [0.0.2-63](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-62...v0.0.2-63) (2021-03-20)
+
+
+### Features
+
+* add payload validator ([6c243e1](https://github.com/MikeDev75015/mongodb-pipeline-builder/commit/6c243e1fe4a3c38af469371d3423649c598022fa))
+* implement all the stage methods as an alias of the addStage method ([b4066e0](https://github.com/MikeDev75015/mongodb-pipeline-builder/commit/b4066e0bd8bfba11780134ce22d5c0a706a4bfd9))
+
+### [0.0.2-62](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-61...v0.0.2-62) (2021-03-19)
+
+
+### Features
+
+* implement Lookup, Match and Project method of the pipeline builder ([9b859cf](https://github.com/MikeDev75015/mongodb-pipeline-builder/commit/9b859cf72b0847bd632f6bb66ebde952854e5c65))
+
+### [0.0.2-61](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-60...v0.0.2-61) (2021-03-19)
+
+### [0.0.2-60](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-59...v0.0.2-60) (2021-03-19)
+
+### [0.0.2-59](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-58...v0.0.2-59) (2021-03-18)
+
+### [0.0.2-58](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-56...v0.0.2-58) (2021-03-18)
+
+### [0.0.2-56](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-55...v0.0.2-56) (2021-03-18)
+
+### [0.0.2-55](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-54...v0.0.2-55) (2021-03-18)
+
+### [0.0.2-54](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-53...v0.0.2-54) (2021-03-18)
+
+### [0.0.2-53](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-52...v0.0.2-53) (2021-03-18)
+
+### [0.0.2-52](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-51...v0.0.2-52) (2021-03-18)
+
+### [0.0.2-51](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-50...v0.0.2-51) (2021-03-18)
+
+### [0.0.2-50](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-49...v0.0.2-50) (2021-03-18)
+
+### [0.0.2-49](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-48...v0.0.2-49) (2021-03-18)
+
+### [0.0.2-48](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-47...v0.0.2-48) (2021-03-18)
+
+### [0.0.2-47](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-46...v0.0.2-47) (2021-03-18)
+
+### [0.0.2-46](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-45...v0.0.2-46) (2021-03-18)
+
+### [0.0.2-45](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-44...v0.0.2-45) (2021-03-18)
+
+### [0.0.2-44](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-43...v0.0.2-44) (2021-03-18)
+
+### [0.0.2-43](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-42...v0.0.2-43) (2021-03-18)
+
+### [0.0.2-42](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-41...v0.0.2-42) (2021-03-18)
+
+### [0.0.2-41](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-40...v0.0.2-41) (2021-03-18)
+
+### [0.0.2-40](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-39...v0.0.2-40) (2021-03-18)
+
+### [0.0.2-39](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-38...v0.0.2-39) (2021-03-17)
+
+### [0.0.2-38](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-37...v0.0.2-38) (2021-03-17)
+
+### [0.0.2-37](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-36...v0.0.2-37) (2021-03-17)
+
+### [0.0.2-36](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-35...v0.0.2-36) (2021-03-17)
+
+### [0.0.2-35](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-34...v0.0.2-35) (2021-03-17)
+
+### [0.0.2-34](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-33...v0.0.2-34) (2021-03-17)
+
+### [0.0.2-33](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-32...v0.0.2-33) (2021-03-17)
+
+### [0.0.2-32](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-31...v0.0.2-32) (2021-03-17)
+
+### [0.0.2-31](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-30...v0.0.2-31) (2021-03-17)
+
+### [0.0.2-30](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-29...v0.0.2-30) (2021-03-17)
+
+### [0.0.2-29](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-28...v0.0.2-29) (2021-03-17)
+
+### [0.0.2-28](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-27...v0.0.2-28) (2021-03-17)
+
+### [0.0.2-27](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-26...v0.0.2-27) (2021-03-17)
+
+### [0.0.2-26](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-25...v0.0.2-26) (2021-03-17)
+
+### [0.0.2-25](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-24...v0.0.2-25) (2021-03-17)
+
+### [0.0.2-24](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-23...v0.0.2-24) (2021-03-17)
+
+### [0.0.2-23](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-22...v0.0.2-23) (2021-03-17)
+
+### [0.0.2-22](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-21...v0.0.2-22) (2021-03-17)
+
+### [0.0.2-21](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-20...v0.0.2-21) (2021-03-17)
+
+### [0.0.2-20](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-19...v0.0.2-20) (2021-03-17)
+
+### [0.0.2-19](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-18...v0.0.2-19) (2021-03-17)
+
+### [0.0.2-18](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-17...v0.0.2-18) (2021-03-17)
+
+### [0.0.2-17](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-16...v0.0.2-17) (2021-03-17)
+
+### [0.0.2-16](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-15...v0.0.2-16) (2021-03-17)
+
+### [0.0.2-15](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-14...v0.0.2-15) (2021-03-17)
+
+### [0.0.2-14](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-13...v0.0.2-14) (2021-03-17)
+
+### [0.0.2-13](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-12...v0.0.2-13) (2021-03-17)
+
+### [0.0.2-12](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-11...v0.0.2-12) (2021-03-17)
+
+### [0.0.2-11](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-10...v0.0.2-11) (2021-03-17)
+
+### [0.0.2-10](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-alpha.7...v0.0.2-10) (2021-03-17)
+
+
+### Bug Fixes
+
+* change import moment to require moment ([826ac37](https://github.com/MikeDev75015/mongodb-pipeline-builder/commit/826ac37b36f2d9bc2bfb9f2f98b349a78799554c))
+
+### [0.0.2-alpha.7](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-alpha.5...v0.0.2-alpha.7) (2021-03-16)
+
+### [0.0.2-alpha.5](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-alpha.4...v0.0.2-alpha.5) (2021-03-16)
+
+### [0.0.2-alpha.4](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-alpha.3...v0.0.2-alpha.4) (2021-03-16)
+
+### [0.0.2-alpha.3](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-alpha.2...v0.0.2-alpha.3) (2021-03-16)
+
+
+### Bug Fixes
+
+* build script ([281fb81](https://github.com/MikeDev75015/mongodb-pipeline-builder/commit/281fb81632b222a19ef0cbdbe22748a7e6fafe81))
+
+### [0.0.2-alpha.2](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-alpha.1...v0.0.2-alpha.2) (2021-03-16)
+
+### [0.0.2-alpha.1](https://github.com/MikeDev75015/mongodb-pipeline-builder/compare/v0.0.2-alpha.0...v0.0.2-alpha.1) (2021-03-16)
+
+### 0.0.2-alpha.0 (2021-03-15)

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Mickael Nodanche
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/Readme.md

@@ -0,0 +1,280 @@
+<div style="text-align: center; width: 100%;">
+
+<div style="display: inline-block">
+
+[![NPM version](https://img.shields.io/npm/v/mongodb-pipeline-builder.svg)](https://www.npmjs.com/package/mongodb-pipeline-builder)
+![NPM](https://img.shields.io/npm/l/mongodb-pipeline-builder?registry_uri=https%3A%2F%2Fregistry.npmjs.com)
+![npm](https://img.shields.io/npm/dw/mongodb-pipeline-builder)
+</div>
+
+<div style="display: inline-block">
+
+![GitHub branch checks state](https://img.shields.io/github/checks-status/MikeDev75015/mongodb-pipeline-builder/main)
+[![CircleCI](https://circleci.com/gh/MikeDev75015/mongodb-pipeline-builder.svg?style=shield)](https://app.circleci.com/pipelines/github/MikeDev75015/mongodb-pipeline-builder)
+![Sonar Quality Gate](https://img.shields.io/sonar/quality_gate/MikeDev75015_mongodb-pipeline-builder?server=https%3A%2F%2Fsonarcloud.io)
+</div>
+</div>
+
+<div style="text-align: center; width: 100%;">
+<div style="display: inline-block">
+
+![Sonar Tests](https://img.shields.io/sonar/tests/MikeDev75015_mongodb-pipeline-builder?server=https%3A%2F%2Fsonarcloud.io)
+![Sonar Coverage](https://img.shields.io/sonar/coverage/MikeDev75015_mongodb-pipeline-builder?server=https%3A%2F%2Fsonarcloud.io)
+<img src="https://mikedev75015.github.io/mongodb-pipeline-builder/images/coverage-badge-documentation.svg" alt="documentation-badge">
+</div>
+
+<div style="display: inline-block">
+
+![GitHub top language](https://img.shields.io/github/languages/top/MikeDev75015/mongodb-pipeline-builder)
+[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=MikeDev75015_mongodb-pipeline-builder&metric=ncloc)](https://sonarcloud.io/dashboard?id=MikeDev75015_mongodb-pipeline-builder)
+[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=MikeDev75015_mongodb-pipeline-builder&metric=duplicated_lines_density)](https://sonarcloud.io/dashboard?id=MikeDev75015_mongodb-pipeline-builder)
+</div>
+</div>
+
+<div style="text-align: center; width: 100%;">
+<div style="display: inline-block">
+
+![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/MikeDev75015/mongodb-pipeline-builder)
+![GitHub commit activity](https://img.shields.io/github/commit-activity/w/MikeDev75015/mongodb-pipeline-builder)
+![GitHub last commit (branch)](https://img.shields.io/github/last-commit/MikeDev75015/mongodb-pipeline-builder/main)
+</div>
+
+<div style="display: inline-block">
+
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=MikeDev75015_mongodb-pipeline-builder&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=MikeDev75015_mongodb-pipeline-builder)
+[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=MikeDev75015_mongodb-pipeline-builder&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=MikeDev75015_mongodb-pipeline-builder)
+[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=MikeDev75015_mongodb-pipeline-builder&metric=security_rating)](https://sonarcloud.io/dashboard?id=MikeDev75015_mongodb-pipeline-builder)
+</div>
+</div>
+
+<div style="text-align: center; width: 100%;">
+
+# `mongodb-pipeline-builder`
+
+</div>
+
+<a id="doc-link" style="display: block; cursor: pointer;" href="https://mikedev75015.github.io/mongodb-pipeline-builder" target="_blank">Technical documentation</a>
+
+<p style="text-align: justify; width: 100%;font-size: 15px;">
+is a pipeline builder for the db.collection.aggregate method and db.aggregate method. It will simplify pipelines by making them more
+readable and much easier to edit. It also allows you to test your pipelines on a dataset in order to verify them. Pipeline stages appear in an array. Documents pass
+through the stages in sequence.
+</p>
+
+## npm package <img src="https://pbs.twimg.com/media/EDoWJbUXYAArclg.png" width="24" height="24" />
+
+### `npm i -S mongodb-pipeline-builder`
+
+## Usage:
+
+
+### - with require
+
+```typescript
+const PipelineBuilder = require("mongodb-pipeline-builder").PipelineBuilder;
+const { EqualityPayload, OnlyPayload, Field } = require('mongodb-pipeline-builder/helpers');
+const { LessThanEqual, ArrayElemAt, Equal, Expression } = require('mongodb-pipeline-builder/operators');
+```
+
+### - with import
+
+
+```typescript
+import { PipelineBuilder } from 'mongodb-pipeline-builder';
+import { EqualityPayload, OnlyPayload, Field } from 'mongodb-pipeline-builder/helpers';
+import { LessThanEqual, ArrayElemAt, Equal, Expression } from 'mongodb-pipeline-builder/operators';
+```
+
+## Example with paging:
+
+
+```typescript
+const myNewPipeline = new PipelineBuilder( 'myPagination', { debug: true } )
+    .Match( Expression( LessThanEqual( '$id', 20 ) ) )
+    .Project( OnlyPayload( 'name', 'weight' ) )
+    .Paging( 5, 3 ) // 5 per page, page 3
+    .getPipeline();
+```
+
+### is equivalent to:
+
+
+```typescript
+const myNewPipeline = [ {
+    $facet: {
+        docs: [
+            { $match: { $expr: { $lte: ["$id", 20] } } },
+            { $project: { _id: 0, name: 1, weight: 1 } },
+            { $skip: 10 },
+            { $limit: 5 }
+        ],
+        count: [
+            { $match: { $expr: { $lte: ["$id", 20] } } },
+            { $project: { _id: 0, name: 1, weight: 1 } },
+            { $count: "totalElements" }
+        ]
+    }
+} ];
+```
+
+## Example without paging:
+
+
+```typescript
+const myNewPipeline = new PipelineBuilder( 'user-skills' )
+    .Match( Expression( Equal( '$id', 123456 ) ) )
+    .Lookup( EqualityPayload( 'profiles', 'profile', 'profileId', 'id' ) )
+    .Project( OnlyPayload( 'firstname', 'lastname', 'email' ) )
+    .AddFields(
+        Field( 'skills', ArrayElemAt( '$profile.skills', 0 ) ),
+        Field( 'availability', ArrayElemAt( '$profile.availability', 0 ) )
+    )
+    .Unset( 'profile' )
+    .getPipeline();
+```
+
+### is equivalent to:
+
+```typescript
+const myNewPipeline = [
+    { $match: { $expr: { $eq: ["$id", 123456] } } },
+    { $lookup: { from: "profiles", as: "profile", localField: "profileId", foreignField: "id" } },
+    { $project: { _id: 0, firstname: 1, lastname: 1, email: 1 } },
+    { $addFields: {
+        skills: { $arrayElemAt: ["$profile.skills", 0] },
+        availability: { $arrayElemAt: ["$profile.availability", 0] }
+    } },
+    { $unset: "profile" }
+];
+```
+
+___
+
+# The GetResult method
+#### GetResult(): Promise<GetResultResponse | GetPagingResultResponse>
+
+<p style="font-size: 15px;">
+is an asynchronous method that provides a very easy way to use your aggregation pipelines on a target (collection or mongoose model having the aggregation method) with pagination or without.
+<p>
+
+## GetResultResponse
+
+<p style="font-size: 15px;">
+When you are not using pagination, the GetResult method returns a GetResultResponse object that contains two methods:<br>
+&nbsp;&nbsp;- GetDocs() to get the documents found.<br>
+&nbsp;&nbsp;- GetCount() to get the total number of documents found.
+</p>
+
+
+```typescript
+// in an asynchronous function
+const result = await GetResult( target, pipeline );
+result.GetDocs(); // => any[]
+result.GetCount(); // => number
+```
+
+#### Or:
+```typescript
+GetResult( target, pipeline ).then( result => {
+    result.GetDocs(); // => any[]
+    result.GetCount(); // => number
+} );
+```
+
+### GetDocs() method possibilities:
+
+<p style="font-size: 15px;">
+You can retrieve a particular document by specifying its index as an argument of the GetDocs method.<br>Just pass "last" to get the last document. If the specified index is greater than the index of the last document, GetDocs() will return the last document.
+</p>
+
+```typescript
+// if GetDocs() returns [document0, document1, document2, document3, ..., document51]
+result.GetDocs(2); // will return document to index 2, document2
+result.GetDocs('last'); // will return the last document, document51
+result.GetDocs(99); // will return the last document, document51
+```
+
+## GetPagingResultResponse
+
+<p style="font-size: 15px;">
+When you use paging, the GetResult method returns a GetPagingResultResponse object that contains three methods:<br>
+&nbsp;&nbsp;- GetDocs() to get the documents found.<br>
+&nbsp;&nbsp;- GetCount() to get the total number of documents found.<br>
+&nbsp;&nbsp;- GetTotalPageNumber() to get the total number of pages.
+</p>
+
+
+```typescript
+// in an asynchronous function
+const result = await GetResult( target, pipeline );
+result.GetDocs(); // => any[]
+result.GetCount(); // => number
+result.GetTotalPageNumber(); // => number
+```
+
+#### Or:
+```typescript
+GetResult( target, pipeline ).then( result => {
+    result.GetDocs(); // => any[]
+    result.GetCount(); // => number
+    result.GetTotalPageNumber(); // => number
+} );
+```
+
+
+___
+
+
+### [ <a href="https://npm.runkit.com/mongodb-pipeline-builder" target="_blank">Try the lib on NPM RunKit with the require method</a> ]<br>
+
+
+<p style="font-size: 14px; white-space: nowrap;">[ <a href="https://docs.mongodb.com/manual/reference/operator/aggregation-pipeline/" target="_blank">Aggregation Pipeline Stages</a> ]</p>
+
+## `MONGODB STAGES:`
+<p style="font-size: 15px;">
+AddFields | Bucket | BucketAuto | CollStats | Count | Facet | GeoNear | GraphLookup | Group | IndexStats | Limit | ListSessions | Lookup | Match | Merge | Out | PlanCacheStats | Project | Redact | ReplaceRoot | ReplaceWith | Sample | Search | Set | Skip | Sort | SortByCount | UnionWith | Unset | Unwind
+</p>
+
+## `CUSTOM STAGE:`
+<p style="font-size: 15px;">
+Paging
+</p>
+
+___
+
+<p style="font-size: 14px; white-space: nowrap;">[ <a href="https://docs.mongodb.com/manual/reference/operator/aggregation-pipeline/" target="_blank">Aggregation Pipeline Helpers</a> ]</p>
+
+## `STAGE HELPERS * :`
+<p style="font-size: 15px;">
+&nbsp;- Bucket ( GroupByPayload )<br>
+&nbsp;- BucketAuto ( GroupByAutoPayload )<br>
+&nbsp;- CurrentOp ( OpPayload )<br>
+&nbsp;- GeoNear ( NearPayload )<br>
+&nbsp;- Lookup ( ConditionPayload | EqualityPayload )<br>
+&nbsp;- Merge ( IntoPayload )<br>
+&nbsp;- Out ( DbCollPayload )<br>
+&nbsp;- Project ( IgnorePayload | OnlyPayload )<br>
+&nbsp;- Sample ( SizePayload )<br>
+&nbsp;- UnionWith ( CollectionPayload )
+
+## `COMMON HELPERS:`
+<p style="font-size: 15px;">
+&nbsp;- Field: AddFields( Field ** ) | Facet( Field ** ) | Set( Field ** ) | Sort( Field ** )<br>
+&nbsp;- List
+<p>
+
+<p style="font-style: italic">
+* If no helper is available for a stage, use stage method and pass it a valid value as a parameter.<br>
+** One or more Field helper(s) separated by a comma.
+
+___
+
+<p style="font-size: 14px; white-space: nowrap;">[ <a href="https://docs.mongodb.com/manual/reference/operator/aggregation/" target="_blank">Aggregation Pipeline Operators</a> ]</p>
+
+<p style="font-size: 15px;">
+Absolute | Accumulator | Acos | Acosh | Add | AddToSet | AllElementsTrue | And | AnyElementTrue | ArrayElemAt | ArrayToObject | Asin | Asinh | Atan | Atan2 | Atanh | Avg | BinarySize | BsonSize | Ceil | Compare | Concat | ConcatArrays | Cond | Convert | Cos | Cosh | DateFromParts | DateFromString | DateToParts | DateToString | DayOfMonth | DayOfWeek | DayOfYear | DegreesToRadians | Divide | Equal | Exponent | Expression | Filter | First | Floor | FunctionOperator | GreaterThan | GreaterThanEqual | Hour | IfNull | In | IndexOfArray | IndexOfBytes | IndexOfCP | IsArray | IsNumber | IsoDayOfWeek | IsoWeek | IsoWeekYear | Last | LessThan | LessThanEqual | Let | Literal | Log | Log10 | Ltrim | MapOperator | Max | MergeObjects | Meta | Millisecond | Min | Minute | Mod | Month | Multiply | NaturalLog | Not | NotEqual | ObjectToArray | Or | Pow | Push | RadiansToDegrees | Rand | Range | Reduce | RegexFind | RegexFindAll | RegexMatch | ReplaceAll | ReplaceOne | ReverseArray | Round | Rtrim | SampleRate | Second | SetDifference | SetEquals | SetIntersection | SetIsSubset | SetUnion | Sin | Sinh | Size | Slice | Split | Sqrt | StdDevPop | StdDevSamp | StrCaseCmp | StrLenBytes | StrLenCP | Substr | SubstrBytes | SubstrCP | Subtract | Sum | Switch | Tan | Tanh | ToBool | ToDate | ToDecimal | ToDouble | ToInt | ToLong | ToLower | ToObjectId | ToString | ToUpper | Trim | Trunc | Type | Week | Year | Zip
+</p>
+<br><br><br><br>
+
+
+