mongoose-query-find 3.0.5 → 3.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +468 -0
- package/dist/aggregate.d.ts +177 -0
- package/dist/aggregate.d.ts.map +1 -0
- package/dist/aggregate.js +733 -0
- package/dist/aggregate.js.map +1 -0
- package/dist/find.d.ts +243 -0
- package/dist/find.d.ts.map +1 -0
- package/dist/find.js +740 -0
- package/dist/find.js.map +1 -0
- package/dist/index.d.ts +2 -247
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +5 -701
- package/dist/index.js.map +1 -1
- package/package.json +78 -65
package/dist/find.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"find.js","sourceRoot":"","sources":["../src/find.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwFG;;;AAMH,iFAAiF;AAEjF,MAAM,aAAa,GAAG,IAAI,GAAG,CAAS,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC;AAChF,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAC9B,MAAM,iBAAiB,GAAG,CAAC,CAAC;AAC5B,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAC9B,MAAM,eAAe,GAAG,CAAC,CAAC;AAC1B,MAAM,mBAAmB,GAAG,IAAK,CAAC;AAElC,8EAA8E;AAC9E,qEAAqE;AACrE,MAAM,aAAa,GACjB,kEAAkE,CAAC;AACrE,MAAM,aAAa,GAAG,qBAAqB,CAAC;AAE5C,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC;IAC5B,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,KAAK;IACL,IAAI;IACJ,KAAK;IACL,IAAI;IACJ,KAAK;CACN,CAAC,CAAC;AACH,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;AAE1D,MAAM,YAAY,GAA2B,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC;AAC/D,MAAM,qBAAqB,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AACvE,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAC;IAC/B,QAAQ;IACR,OAAO;IACP,WAAW;IACX,cAAc;IACd,MAAM;IACN,SAAS;IACT,SAAS;CACV,CAAC,CAAC;AA4CH,iFAAiF;AAEjF,MAAa,cAAe,SAAQ,KAAK;IACvC,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,gBAAgB,CAAC;IAC/B,CAAC;CACF;AALD,wCAKC;AAED,MAAa,wBAAyB,SAAQ,cAAc;IAC1D,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,0BAA0B,CAAC;IACzC,CAAC;CACF;AALD,4DAKC;AAED,iFAAiF;AAEjF,SAAS,SAAS,CAAC,GAAuB;IACxC,MAAM,CAAC,GAAG,QAAQ,CAAC,GAAG,IAAI,GAAG,EAAE,EAAE,CAAC,CAAC;IACnC,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACnC,CAAC;AAED,SAAS,UAAU,CACjB,GAAuB,EACvB,QAAQ,GAAG,iBAAiB;IAE5B,MAAM,CAAC,GAAG,QAAQ,CAAC,GAAG,IAAI,IAAI,EAAE,EAAE,CAAC,CAAC;IACpC,IAAI,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;QAAE,OAAO,EAAE,CAAC;IACjC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;AAC/B,CAAC;AAED,iFAAiF;AAEjF;;;;;;;GAOG;AACH,SAAS,QAAQ,CACf,KAAc,EACd,KAAK,GAAG,CAAC,EACT,IAAI,GAAG,EAAE,EACT,MAA+C;IAE/C,IAAI,KAAK,IAAI,iBAAiB,EAAE;QAC9B,IAAI,MAAM;YAAE,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;aAC3B,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,EAAE;YAC9C,OAAO,CAAC,IAAI,CACV,+CAA+C,IAAI,IAAI,EACvD,KAAK,CACN,CAAC;SACH;QACD,OAAO,SAAS,CAAC;KAClB;IAED,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAChC,MAAM,CAAC,GAAG,OAAO,KAAK,CAAC;IACvB,IAAI,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IAEtE,gGAAgG;IAChG,IAAI,KAAK,YAAY,IAAI;QAAE,OAAO,KAAK,CAAC;IAExC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QACxB,MAAM,GAAG,GAAc,EAAE,CAAC;QAC1B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACrC,MAAM,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,GAAG,CAAC,EAAE,GAAG,IAAI,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;YACjE,IAAI,CAAC,KAAK,SAAS;gBAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SAClC;QACD,OAAO,GAAG,CAAC;KACZ;IAED,IAAI,CAAC,KAAK,QAAQ,IAAI,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,MAAM,CAAC,SAAS,EAAE;QACvE,MAAM,GAAG,GAAG,KAAgC,CAAC;QAC7C,MAAM,GAAG,GAA4B,EAAE,CAAC;QACxC,KAAK,MAAM,CAAC,IAAI,GAAG,EAAE;YACnB,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE;gBAChD,MAAM,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC5C,MAAM,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,GAAG,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;gBACzD,IAAI,CAAC,KAAK,SAAS;oBAAE,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;aACjC;SACF;QACD,OAAO,GAAG,CAAC;KACZ;IAED,IAAI,MAAM;QAAE,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;SAC3B,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,EAAE;QAC9C,OAAO,CAAC,IAAI,CAAC,4CAA4C,IAAI,IAAI,EAAE,KAAK,CAAC,CAAC;KAC3E;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,kFAAkF;AAElF,SAAS,sBAAsB,CAAC,aAA0B;IAIxD,MAAM,MAAM,GAAG,IAAI,GAAG,EAAU,CAAC;IACjC,MAAM,SAAS,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC5C,KAAK,MAAM,CAAC,IAAI,aAAa,EAAE;QAC7B,MAAM,EAAE,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC;QAC3B,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACf,SAAS,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;KACtB;IACD,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;AAC/B,CAAC;AAED,SAAS,cAAc,CAAC,KAAa,EAAE,aAA0B;IAC/D,OAAO,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;AAChD,CAAC;AAED;;;;;GAKG;AACH,SAAS,gBAAgB,CACvB,MAA+B,EAC/B,aAA0B,EAC1B,YAAiC;IAEjC,IAAI,aAAa,CAAC,IAAI,KAAK,CAAC;QAAE,OAAO,MAAM,CAAC;IAE5C,MAAM,GAAG,GAA4B,EAAE,CAAC;IACxC,KAAK,MAAM,CAAC,IAAI,MAAM,EAAE;QACtB,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;YAAE,SAAS;QAC/D,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QAEpB,IAAI,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YACrB,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;gBACpB,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CACtB,aAAa,CAAC,IAAI,CAAC;oBACjB,CAAC,CAAC,gBAAgB,CAAC,IAAI,EAAE,aAAa,EAAE,YAAY,CAAC;oBACrD,CAAC,CAAC,IAAI,CACT,CAAC;aACH;iBAAM,IAAI,aAAa,CAAC,CAAC,CAAC,EAAE;gBAC3B,GAAG,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,EAAE,aAAa,EAAE,YAAY,CAAC,CAAC;aAC3D;iBAAM;gBACL,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;aACZ;YACD,SAAS;SACV;QAED,MAAM,EAAE,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC;QAC3B,IAAI,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;YAAE,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;KAC/D;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,aAAa,CAAC,CAAU;IAC/B,OAAO,CACL,CAAC,KAAK,IAAI;QACV,OAAO,CAAC,KAAK,QAAQ;QACrB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QACjB,CAAC,CAAC,CAAC,YAAY,IAAI,CAAC;QACpB,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,SAAS,CAC9C,CAAC;AACJ,CAAC;AAED,iFAAiF;AAEjF;;;;;;;;;;;GAWG;AACH,SAAS,SAAS,CAAC,KAAc,EAAE,SAAS,GAAG,EAAE,EAAE,QAAiB;IAClE,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAEhC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC7B,IAAI,KAAK,KAAK,MAAM;YAAE,OAAO,IAAI,CAAC;QAClC,IAAI,KAAK,KAAK,OAAO;YAAE,OAAO,KAAK,CAAC;QAEpC,IAAI,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;YACjC,MAAM,MAAM,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC;YAC/B,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,EAAE;gBAC5B,IAAI,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;oBAC7B,IAAI,QAAQ,IAAI,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC;wBAAE,OAAO,MAAM,CAAC;oBACzD,MAAM,KAAK,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC;oBAC9B,MAAM,GAAG,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC;oBAC5B,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,CAAC;oBACrC,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;iBAClC;gBACD,OAAO,MAAM,CAAC;aACf;SACF;QACD,OAAO,KAAK,CAAC;KACd;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,YAAY,IAAI;QAAE,OAAO,KAAK,CAAC;IAErE,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QACxB,MAAM,GAAG,GAAc,EAAE,CAAC;QAC1B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACrC,MAAM,OAAO,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;YACzD,IAAI,OAAO,KAAK,SAAS;gBAAE,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SAC9C;QACD,OAAO,GAAG,CAAC;KACZ;IAED,MAAM,GAAG,GAAG,KAAgC,CAAC;IAC7C,MAAM,GAAG,GAA4B,EAAE,CAAC;IACxC,KAAK,MAAM,CAAC,IAAI,GAAG,EAAE;QACnB,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;YAAE,SAAS;QAC5D,MAAM,MAAM,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAClD,MAAM,IAAI,GAAG,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACvD,MAAM,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QACzE,oEAAoE;QACpE,8DAA8D;QAC9D,GAAG,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;KAClE;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,iFAAiF;AAEjF;;;GAGG;AACH,SAAS,yBAAyB,CAChC,MAA+B,EAC/B,KAAK,GAAG,CAAC;IAET,KAAK,MAAM,CAAC,IAAI,MAAM,EAAE;QACtB,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;YAAE,SAAS;QAE/D,IAAI,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;YAC3B,MAAM,IAAI,wBAAwB,CAChC,kCAAkC,CAAC,GAAG,CACvC,CAAC;SACH;QACD,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;YACrE,MAAM,IAAI,wBAAwB,CAChC,mDAAmD,CAAC,GAAG,CACxD,CAAC;SACH;QAED,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QACpB,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;YACpB,KAAK,MAAM,IAAI,IAAI,CAAC,EAAE;gBACpB,IAAI,aAAa,CAAC,IAAI,CAAC;oBAAE,yBAAyB,CAAC,IAAI,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;aACrE;SACF;aAAM,IAAI,aAAa,CAAC,CAAC,CAAC,EAAE;YAC3B,yBAAyB,CAAC,CAAC,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;SACzC;KACF;AACH,CAAC;AAED,iFAAiF;AAEjF,SAAS,WAAW,CAClB,GAAgB,EAChB,aAA0B,EAC1B,YAAiC,EACjC,MAA+C;IAE/C,MAAM,QAAQ,GAA4B,EAAE,CAAC;IAC7C,KAAK,MAAM,CAAC,IAAI,GAAG,EAAE;QACnB,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;YACzE,QAAQ,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;SACtB;KACF;IAED,MAAM,IAAI,GAAG,QAAQ,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,EAAE,MAAM,CAA4B,CAAC;IAC1E,MAAM,OAAO,GAAG,SAAS,CAAC,IAAI,CAA4B,CAAC;IAC3D,MAAM,OAAO,GAAG,gBAAgB,CAAC,OAAO,EAAE,aAAa,EAAE,YAAY,CAAC,CAAC;IACvE,yBAAyB,CAAC,OAAO,CAAC,CAAC;IACnC,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,iFAAiF;AAEjF;;;;GAIG;AACH,SAAS,SAAS,CAChB,IAAY,EACZ,aAA0B,EAC1B,YAAiC;IAEjC,MAAM,GAAG,GAA2B,EAAE,CAAC;IACvC,IAAI,KAAK,GAAG,CAAC,CAAC;IAEd,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;QACnC,IAAI,KAAK,IAAI,eAAe;YAAE,MAAM;QAEpC,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;QAC7B,IAAI,CAAC,OAAO,IAAI,OAAO,KAAK,GAAG;YAAE,SAAS;QAE1C,MAAM,IAAI,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QACrC,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;QACvD,IAAI,CAAC,KAAK;YAAE,SAAS;QAErB,IAAI,aAAa,CAAC,IAAI,GAAG,CAAC,EAAE;YAC1B,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,aAAa,CAAC;gBAAE,SAAS;YACpD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACrE;aAAM;YACL,GAAG,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SAC5B;QACD,KAAK,EAAE,CAAC;KACT;IAED,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,YAAY,EAAE,CAAC;AACjE,CAAC;AAED,iFAAiF;AAEjF;;;;;GAKG;AACH,SAAS,kBAAkB,CACzB,UAAkB,EAClB,aAA0B,EAC1B,YAAiC;IAEjC,IAAI,aAAa,CAAC,IAAI,KAAK,CAAC;QAAE,OAAO,UAAU,CAAC;IAEhD,OAAO,UAAU;SACd,KAAK,CAAC,KAAK,CAAC;SACZ,MAAM,CAAC,OAAO,CAAC;SACf,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QAChB,MAAM,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QAC7D,OAAO,CACL,KAAK,KAAK,KAAK;YACf,KAAK,KAAK,KAAK;YACf,cAAc,CAAC,KAAK,EAAE,aAAa,CAAC,CACrC,CAAC;IACJ,CAAC,CAAC;SACD,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QACb,MAAM,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QACpC,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QAC7C,MAAM,SAAS,GAAG,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,IAAI,KAAK,CAAC;QACjE,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7C,CAAC,CAAC;SACD,IAAI,CAAC,GAAG,CAAC,CAAC;AACf,CAAC;AAED,iFAAiF;AAEjF;;;;;;;;;;;;;GAaG;AACH,MAAa,SAAS;IAmCpB,YACE,KAAwC,EACxC,WAAwB,EACxB,UAA4B,EAAE;QA3BxB,mBAAc,GAAgB,IAAI,GAAG,EAAE,CAAC;QACxC,kBAAa,GAAwB,IAAI,GAAG,EAAE,CAAC;QAEvD;;;;WAIG;QACK,eAAU,GAA4B,EAAE,CAAC;QACzC,sBAAiB,GAA4B,EAAE,CAAC;QAExD,6EAA6E;QACrE,cAAS,GAA8B,EAAE,CAAC;QAE1C,UAAK,GAA2B,EAAE,GAAG,YAAY,EAAE,CAAC;QACpD,YAAO,GAAkB,IAAI,CAAC;QAC9B,eAAU,GAAsB,EAAE,CAAC;QAE3C,oEAAoE;QAC5D,mBAAc,GAAkB,IAAI,CAAC;QAU3C,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAA8B,CAAC;QAClD,IAAI,CAAC,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,WAAW,EAAE,CAAC,CAAC;QAC5C,IAAI,CAAC,OAAO,GAAG;YACb,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,mBAAmB;YACnD,oBAAoB,EAClB,OAAO,CAAC,oBAAoB;gBAC5B,OAAO,CAAC,SAAS;gBACjB,mBAAmB;YACrB,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,iBAAiB;YAC/C,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,IAAI;YAC1B,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,cAAc,EAAE,OAAO,CAAC,cAAc;SACvC,CAAC;QACF,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;QACrC,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACjE,CAAC;IAED,6EAA6E;IAE7E;;;;OAIG;IACH,WAAW,CAAC,MAAgB;QAC1B,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,sBAAsB,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;QACtE,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC;QAC7B,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,6EAA6E;IAE7E;;;;OAIG;IACH,MAAM;QACJ,MAAM,MAAM,GAAG,WAAW,CACxB,IAAI,CAAC,EAAE,EACP,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,aAAa,EAClB,IAAI,CAAC,OAAO,CAAC,cAAc,CAC5B,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAuD;QAC3D,MAAM,QAAQ,GAAG,UAAqC,CAAC;QACvD,yBAAyB,CAAC,QAAQ,CAAC,CAAC;QACpC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;QAChD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAC,MAAgB;QAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC;QAC9B,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,GAAG,iBAAiB,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;YAC/D,OAAO,IAAI,CAAC;QAEd,MAAM,UAAU,GACd,IAAI,CAAC,cAAc,CAAC,IAAI,GAAG,CAAC;YAC1B,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,cAAc,CAAC,CAAC,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;YAC9D,CAAC,CAAC,MAAM,CAAC;QACb,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QAEzC,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;QAC3D,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QACvC,KAAK,MAAM,KAAK,IAAI,UAAU;YAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;QACxE,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,IAAI;QACF,IAAI,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE;YAChB,IAAI,CAAC,KAAK,GAAG,SAAS,CACpB,IAAI,CAAC,EAAE,CAAC,IAAI,EACZ,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,aAAa,CACnB,CAAC;SACH;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,WAAW,CAAC,aAAsB;QAChC,IAAI,aAAa;YAAE,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;QAEvD,IAAI,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE;YAClB,MAAM,GAAG,GAAG,IAAI,CAAC,EAAE,CAAC,MAAM;iBACvB,KAAK,CAAC,GAAG,CAAC;iBACV,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;iBACpB,MAAM,CAAC,OAAO,CAAC;iBACf,IAAI,CAAC,GAAG,CAAC,CAAC;YACb,MAAM,SAAS,GAAG,kBAAkB,CAClC,GAAG,EACH,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,aAAa,CACnB,CAAC;YACF,IAAI,CAAC,OAAO,GAAG,SAAS,IAAI,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC;SACzD;aAAM,IAAI,aAAa,EAAE;YACxB,IAAI,CAAC,OAAO,GAAG,aAAa,CAAC;SAC9B;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAC,IAA8B,EAAE,MAAe;QACtD,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YAC5B,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;YAC3D,OAAO,IAAI,CAAC;SACb;QAED,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE;YACtB,MAAM,SAAS,GAAG,QAAQ,CACxB,IAAI,CAAC,KAAK,EACV,CAAC,EACD,gBAAgB,EAChB,IAAI,CAAC,OAAO,CAAC,cAAc,CACD,CAAC;YAC7B,MAAM,YAAY,GAAG,SAAS,CAAC,SAAS,CAA4B,CAAC;YACrE,yBAAyB,CAAC,YAAY,CAAC,CAAC;YACxC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,CAAC;SACxD;aAAM;YACL,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAC5B;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,6EAA6E;IAE7E;;;;;;;;;;;;OAYG;IACK,gBAAgB;QACtB,IAAI,IAA6B,CAAC;QAElC,iEAAiE;QACjE,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;QAE7D,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE;YAC7B,IAAI,YAAY,EAAE;gBAChB,IAAI,GAAG,EAAE,IAAI,EAAE,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC;aAC7D;iBAAM;gBACL,IAAI,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;aAChC;SACF;aAAM;YACL,IAAI,GAAG,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;SAC5C;QAED,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;QAEjE,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,SAAS,EAAE;YAC7C,OAAO,EAAE,IAAI,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC;SACjD;QACD,IAAI,SAAS,EAAE;YACb,OAAO,IAAI,CAAC,iBAAiB,CAAC;SAC/B;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,QAAQ,CACd,WAAiC,EACjC,IAAY;QAEZ,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QACzC,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK;aACjB,IAAI,CAAC,WAAW,CAAC;aACjB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;aAChB,IAAI,CAAC,IAAI,CAAC;aACV,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEtB,IAAI,IAAI;YAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QACnB,IAAI,IAAI,CAAC,OAAO;YAAE,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzC,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,UAAU;YAAE,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACnD,IAAI,SAAS,GAAG,CAAC;YAAE,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAE1C,OAAO,CAAC,CAAC,IAAI,EAA4B,CAAC;IAC5C,CAAC;IAED,8EAA8E;IACtE,KAAK,CAAC,SAAS,CACrB,WAAiC,EACjC,SAAkB;QAElB,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QACnC,IAAI,CAAC,SAAS,EAAE;YACd,OAAO,CAAC,MAAM,IAAI,CAAC,KAAK;iBACrB,sBAAsB,EAAE;iBACxB,SAAS,CAAC,SAAS,CAAC;iBACpB,IAAI,EAAE,CAAW,CAAC;SACtB;QACD,OAAO,CAAC,MAAM,IAAI,CAAC,KAAK;aACrB,cAAc,CAAC,WAAW,CAAC;aAC3B,SAAS,CAAC,SAAS,CAAC;aACpB,IAAI,EAAE,CAAW,CAAC;IACvB,CAAC;IAEO,KAAK,CAAC,SAAS,CACrB,EAAoB,EACpB,IAAY,EACZ,KAAa,EACb,MAA+B;QAE/B,MAAM,EAAE,WAAW,EAAE,oBAAoB,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QACtE,IAAI,CAAC,WAAW;YAAE,OAAO,EAAE,EAAE,CAAC;QAE9B,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACzB,MAAM,MAAM,GAAG,MAAM,EAAE,EAAE,CAAC;QAC1B,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;QAErC,IAAI,SAAS,IAAI,CAAC,oBAAoB,IAAI,SAAS,CAAC,EAAE;YACpD,WAAW,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;SACnE;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,8EAA8E;IAE9E;;;;;;OAMG;IACH,KAAK,CAAC,QAAQ,CAAC,WAAoB;QACjC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC;QACxB,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1B,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC5C,MAAM,WAAW,GAAG,WAAmC,CAAC;QACxD,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;QAEtD,IAAI,IAAI,KAAK,CAAC,EAAE;YACd,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,MAAM,IAAI,CAAC,SAAS,CACxC,GAAG,EAAE,CACH,OAAO,CAAC,GAAG,CAAC;gBACV,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,SAAS,CAAC;gBACtC,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;aAC9B,CAAC,EACJ,IAAI,EACJ,KAAK,EACL,WAAW,CACZ,CAAC;YACF,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;YACzD,OAAO;gBACL,IAAI;gBACJ,KAAK;gBACL,IAAI,EAAE,CAAC;gBACP,UAAU;gBACV,KAAK;gBACL,WAAW,EAAE,CAAC,GAAG,UAAU;gBAC3B,WAAW,EAAE,KAAK;aACnB,CAAC;SACH;QAED,IAAI,WAAW,KAAK,SAAS,EAAE;YAC7B,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;YAC/D,MAAM,QAAQ,GAAG,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YAC9C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAC/B,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,QAAQ,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,EACxD,QAAQ,EACR,KAAK,EACL,WAAW,CACZ,CAAC;YACF,OAAO;gBACL,IAAI;gBACJ,KAAK,EAAE,WAAW;gBAClB,IAAI,EAAE,QAAQ;gBACd,UAAU;gBACV,KAAK;gBACL,WAAW,EAAE,QAAQ,GAAG,UAAU;gBAClC,WAAW,EAAE,QAAQ,GAAG,CAAC;aAC1B,CAAC;SACH;QAED,MAAM,MAAM,GAKR;YACF,KAAK,EAAE,CAAC;YACR,IAAI,EAAE,EAAE;YACR,QAAQ,EAAE,IAAI;YACd,UAAU,EAAE,CAAC;SACd,CAAC;QAEF,MAAM,IAAI,CAAC,SAAS,CAClB,KAAK,IAAI,EAAE;YACT,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;YAC3D,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;YACzD,MAAM,QAAQ,GAAG,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YAC9C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,QAAQ,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC;YACtE,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;YACrB,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;YACnB,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC;YAC3B,MAAM,CAAC,UAAU,GAAG,UAAU,CAAC;QACjC,CAAC,EACD,IAAI,EACJ,KAAK,EACL,WAAW,CACZ,CAAC;QAEF,OAAO;YACL,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,IAAI,EAAE,MAAM,CAAC,QAAQ;YACrB,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,KAAK;YACL,WAAW,EAAE,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,UAAU;YAChD,WAAW,EAAE,MAAM,CAAC,QAAQ,GAAG,CAAC;SACjC,CAAC;IACJ,CAAC;CACF;AApYD,8BAoYC;AAED,iFAAiF;AAEjF,2DAA2D;AAC3D,SAAgB,SAAS,CACvB,KAAoB,EACpB,WAAwB,EACxB,OAA0B;IAE1B,OAAO,IAAI,SAAS,CAAI,KAAK,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;AACvD,CAAC;AAND,8BAMC;AAED,kBAAe,SAAS,CAAC"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,248 +1,3 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
* @description Production-grade fluent query builder for Mongoose 8.x / 9.x.
|
|
4
|
-
* @requires mongoose ^8.0.0 || ^9.0.0
|
|
5
|
-
*
|
|
6
|
-
* Features:
|
|
7
|
-
* - URL query string → Mongoose filter (sanitized, validated, coerced)
|
|
8
|
-
* - Global full-text search via $or regex
|
|
9
|
-
* - Flexible sort, field projection, and populate
|
|
10
|
-
* - count + find run fully in parallel (Promise.all) — no wasted round-trips
|
|
11
|
-
* - Hard limits on page size, sort fields, search length, nesting depth (DoS protection)
|
|
12
|
-
* - Allowlist-based field filtering on filters, sort, AND projection (NoSQL injection prevention)
|
|
13
|
-
* - Case-insensitive allowlist matching (e.g. allowFields(['Name']) matches ?name=, ?NAME=, ?Name=)
|
|
14
|
-
* - Deep recursive operator validation (catches nested $where, $expr, etc.)
|
|
15
|
-
* - Deep recursive boolean coercion (handles nested query objects)
|
|
16
|
-
* - Deep recursive operator-key coercion (eq/ne/gt/... → $eq/$ne/$gt/...), applied
|
|
17
|
-
* ONLY to object keys — never to string values
|
|
18
|
-
* - estimatedDocumentCount fast-path when no filter is applied
|
|
19
|
-
* - Query timeout via maxTimeMS (prevents runaway queries)
|
|
20
|
-
* - Structured error types for clean upstream handling
|
|
21
|
-
* - Optional cached total for skipping re-count on page > 1
|
|
22
|
-
* - Optional slow-query hook for observability
|
|
23
|
-
* - Zero external runtime dependencies beyond mongoose
|
|
24
|
-
*/
|
|
25
|
-
import { Model, PopulateOptions, Query } from 'mongoose';
|
|
26
|
-
export interface QueryParams {
|
|
27
|
-
page?: string;
|
|
28
|
-
limit?: string;
|
|
29
|
-
sort?: string;
|
|
30
|
-
fields?: string;
|
|
31
|
-
q?: string;
|
|
32
|
-
[key: string]: unknown;
|
|
33
|
-
}
|
|
34
|
-
export interface PaginatedResult<T> {
|
|
35
|
-
data: T[];
|
|
36
|
-
total: number;
|
|
37
|
-
page: number;
|
|
38
|
-
totalPages: number;
|
|
39
|
-
limit: number;
|
|
40
|
-
hasNextPage: boolean;
|
|
41
|
-
hasPrevPage: boolean;
|
|
42
|
-
}
|
|
43
|
-
export interface SlowQueryInfo {
|
|
44
|
-
/** Elapsed time in milliseconds */
|
|
45
|
-
elapsedMs: number;
|
|
46
|
-
/** The Mongoose filter that was applied */
|
|
47
|
-
filter: Record<string, unknown>;
|
|
48
|
-
/** The sort that was applied */
|
|
49
|
-
sort: Record<string, 1 | -1>;
|
|
50
|
-
/** The page that was requested */
|
|
51
|
-
page: number;
|
|
52
|
-
/** The limit that was applied */
|
|
53
|
-
limit: number;
|
|
54
|
-
}
|
|
55
|
-
export interface QueryFindOptions {
|
|
56
|
-
maxTimeMS?: number;
|
|
57
|
-
/**
|
|
58
|
-
* Threshold in ms above which onSlowQuery fires.
|
|
59
|
-
* Defaults to maxTimeMS. Set lower (e.g. 1000) to catch slow-but-not-timed-out queries.
|
|
60
|
-
*/
|
|
61
|
-
slowQueryThresholdMS?: number;
|
|
62
|
-
/**
|
|
63
|
-
* Called when a query exceeds slowQueryThresholdMS.
|
|
64
|
-
* Use to emit metrics, log to your APM, etc.
|
|
65
|
-
*/
|
|
66
|
-
onSlowQuery?: (info: SlowQueryInfo) => void;
|
|
67
|
-
/**
|
|
68
|
-
* Called when sanitize() silently drops a value (e.g. a Date or class instance).
|
|
69
|
-
* Defaults to console.warn in non-production environments.
|
|
70
|
-
*/
|
|
71
|
-
onSanitizeDrop?: (path: string, value: unknown) => void;
|
|
72
|
-
/**
|
|
73
|
-
* Whether to call .lean() on find queries (default: true).
|
|
74
|
-
* Set to false if you need Mongoose document instances (virtuals, instance methods).
|
|
75
|
-
*/
|
|
76
|
-
lean?: boolean;
|
|
77
|
-
}
|
|
78
|
-
export declare class QueryFindError extends Error {
|
|
79
|
-
constructor(message: string);
|
|
80
|
-
}
|
|
81
|
-
export declare class QueryFindValidationError extends QueryFindError {
|
|
82
|
-
constructor(message: string);
|
|
83
|
-
}
|
|
84
|
-
/**
|
|
85
|
-
* Production-grade fluent query builder / paginator for Mongoose 8/9.
|
|
86
|
-
*
|
|
87
|
-
* @example
|
|
88
|
-
* ```ts
|
|
89
|
-
* const result = await new QueryFind(User.find(), req.query)
|
|
90
|
-
* .allowFields(['name', 'email', 'role', 'createdAt'])
|
|
91
|
-
* .where({ orgId: req.user.orgId, deletedAt: null })
|
|
92
|
-
* .filter()
|
|
93
|
-
* .globalSearch(['name', 'email'])
|
|
94
|
-
* .sort()
|
|
95
|
-
* .limitFields('-password -__v')
|
|
96
|
-
* .populate('department', 'name')
|
|
97
|
-
* .paginate();
|
|
98
|
-
* ```
|
|
99
|
-
*/
|
|
100
|
-
export declare class QueryFind<TRawDocType, TModelType extends Model<TRawDocType> = Model<TRawDocType>> {
|
|
101
|
-
private readonly model;
|
|
102
|
-
private readonly qs;
|
|
103
|
-
private readonly options;
|
|
104
|
-
private _allowedFields;
|
|
105
|
-
private _allowedLookup;
|
|
106
|
-
private _canonicalMap;
|
|
107
|
-
/**
|
|
108
|
-
* URL-derived filter and server-side conditions are kept separate so that
|
|
109
|
-
* server conditions merged last in paginate() can never be overwritten by
|
|
110
|
-
* URL params, regardless of the order in which where() and filter() are called.
|
|
111
|
-
*/
|
|
112
|
-
private _urlFilter;
|
|
113
|
-
private _serverConditions;
|
|
114
|
-
/**
|
|
115
|
-
* $or clauses from globalSearch() are collected here and assembled once
|
|
116
|
-
* inside buildFinalFilter(). This prevents double-call from re-wrapping the
|
|
117
|
-
* entire filter in nested $and.
|
|
118
|
-
*/
|
|
119
|
-
private _searchOr;
|
|
120
|
-
private _sort;
|
|
121
|
-
private _select;
|
|
122
|
-
private _populates;
|
|
123
|
-
/** Stored so limitFields() can fall back to it when ?fields= is fully blocked. */
|
|
124
|
-
private _defaultFields;
|
|
125
|
-
/** Parsed once in the constructor — not recomputed on every paginate() call. */
|
|
126
|
-
private readonly _page;
|
|
127
|
-
private readonly _limit;
|
|
128
|
-
constructor(query: Query<TRawDocType[], TRawDocType>, queryString: QueryParams, options?: QueryFindOptions);
|
|
129
|
-
/**
|
|
130
|
-
* Declares which fields the client is permitted to filter, sort, and select.
|
|
131
|
-
* Must be called before filter(), sort(), and limitFields() to take effect.
|
|
132
|
-
* Matching is case-insensitive: allowFields(['Name']) accepts ?name=, ?NAME=.
|
|
133
|
-
*
|
|
134
|
-
* @example .allowFields(['basicInfo.name', 'pricing.base', 'status'])
|
|
135
|
-
*/
|
|
136
|
-
allowFields(fields: string[]): this;
|
|
137
|
-
/**
|
|
138
|
-
* Parses URL query params into a Mongoose filter and merges them into the
|
|
139
|
-
* URL-derived filter store. Only fields present in allowFields() pass through.
|
|
140
|
-
* Reserved keys (page, sort, limit, fields, q) are always stripped first.
|
|
141
|
-
*/
|
|
142
|
-
filter(): this;
|
|
143
|
-
/**
|
|
144
|
-
* Applies mandatory server-side conditions that the client cannot override.
|
|
145
|
-
* Conditions are merged into the final filter after URL-derived values, so
|
|
146
|
-
* they always win regardless of what the client sends.
|
|
147
|
-
*
|
|
148
|
-
* Unlike filter(), values here are not sanitized — ObjectIds, Dates, and
|
|
149
|
-
* other non-plain types are valid. Banned $ operators are still rejected.
|
|
150
|
-
*
|
|
151
|
-
* @example .where({ linkedTo: req.user.orgId, deletedAt: null })
|
|
152
|
-
*/
|
|
153
|
-
where(conditions: Partial<Record<keyof TRawDocType, unknown>>): this;
|
|
154
|
-
/**
|
|
155
|
-
* Enables case-insensitive full-text search across the given fields when
|
|
156
|
-
* ?q= is present in the query string. Fields not in allowFields() are
|
|
157
|
-
* silently skipped. Safe to call multiple times — subsequent calls extend
|
|
158
|
-
* the $or clause list rather than re-wrapping the filter.
|
|
159
|
-
*
|
|
160
|
-
* @example .globalSearch(['basicInfo.name', 'basicInfo.sku'])
|
|
161
|
-
*/
|
|
162
|
-
globalSearch(fields: string[]): this;
|
|
163
|
-
/**
|
|
164
|
-
* Parses the ?sort= query param into a Mongoose sort object. Fields not in
|
|
165
|
-
* allowFields() are silently dropped. Falls back to DEFAULT_SORT when the
|
|
166
|
-
* parsed result is empty. Capped at MAX_SORT_FIELDS entries.
|
|
167
|
-
*
|
|
168
|
-
* Prefix a field with - for descending order: ?sort=-createdAt,name
|
|
169
|
-
*/
|
|
170
|
-
sort(): this;
|
|
171
|
-
/**
|
|
172
|
-
* Controls which fields are returned by the query.
|
|
173
|
-
*
|
|
174
|
-
* When ?fields= is present in the URL, the value is parsed as a
|
|
175
|
-
* comma-separated list and filtered through the allowlist. Only fields
|
|
176
|
-
* declared in allowFields() will be included in the projection.
|
|
177
|
-
*
|
|
178
|
-
* When ?fields= is absent, `defaultFields` is used as-is (no allowlist
|
|
179
|
-
* filtering) — this is the server-controlled default projection.
|
|
180
|
-
*
|
|
181
|
-
* When ?fields= is present but every requested field is blocked by the
|
|
182
|
-
* allowlist, the projection falls back to `defaultFields` rather than
|
|
183
|
-
* omitting select() entirely (which would return all fields).
|
|
184
|
-
*
|
|
185
|
-
* @param defaultFields - Space-separated Mongoose projection string used
|
|
186
|
-
* when the client does not specify ?fields=.
|
|
187
|
-
* Example: 'basicInfo.name pricing.base status -__v'
|
|
188
|
-
*/
|
|
189
|
-
limitFields(defaultFields?: string): this;
|
|
190
|
-
/**
|
|
191
|
-
* Registers a populate path to be applied on the find query.
|
|
192
|
-
* populate.match conditions are sanitized and validated like any other filter.
|
|
193
|
-
*
|
|
194
|
-
* @example
|
|
195
|
-
* .populate('author')
|
|
196
|
-
* .populate('author', 'name avatar')
|
|
197
|
-
* .populate({ path: 'comments', select: 'text', match: { visible: true } })
|
|
198
|
-
*/
|
|
199
|
-
populate(path: string | PopulateOptions, select?: string): this;
|
|
200
|
-
/**
|
|
201
|
-
* Assembles the final Mongoose filter from three sources in priority order:
|
|
202
|
-
* 1. URL-derived filter (lowest priority — client controlled)
|
|
203
|
-
* 2. Global search $or clause
|
|
204
|
-
* 3. Server conditions (highest priority — cannot be overridden by client)
|
|
205
|
-
*/
|
|
206
|
-
private buildFinalFilter;
|
|
207
|
-
private execFind;
|
|
208
|
-
/**
|
|
209
|
-
* Uses estimatedDocumentCount when no filter is active for a fast O(1) count.
|
|
210
|
-
* Falls back to countDocuments when a filter is present.
|
|
211
|
-
*/
|
|
212
|
-
private execCount;
|
|
213
|
-
/**
|
|
214
|
-
* Wraps an async operation with slow-query detection. When onSlowQuery is
|
|
215
|
-
* provided and the operation exceeds slowQueryThresholdMS, the hook is called
|
|
216
|
-
* with timing and query metadata for observability.
|
|
217
|
-
*/
|
|
218
|
-
private wrapTimed;
|
|
219
|
-
/**
|
|
220
|
-
* Executes the query and returns a paginated result.
|
|
221
|
-
*
|
|
222
|
-
* On page 1, count and find run in parallel via Promise.all.
|
|
223
|
-
* On subsequent pages, pass the previously returned `total` as `cachedTotal`
|
|
224
|
-
* to skip the count query entirely.
|
|
225
|
-
*
|
|
226
|
-
* @param cachedTotal - Total document count from a prior page-1 response.
|
|
227
|
-
* When provided, the countDocuments call is skipped for this request.
|
|
228
|
-
*
|
|
229
|
-
* @throws {QueryFindValidationError} when the URL contains a disallowed $ operator.
|
|
230
|
-
*/
|
|
231
|
-
paginate(cachedTotal?: number): Promise<PaginatedResult<TRawDocType>>;
|
|
232
|
-
}
|
|
233
|
-
/**
|
|
234
|
-
* Convenience factory — avoids `new` at the call site.
|
|
235
|
-
*
|
|
236
|
-
* @example
|
|
237
|
-
* const result = await queryFind(User.find(), req.query, { maxTimeMS: 3000 })
|
|
238
|
-
* .allowFields(['name', 'email', 'createdAt'])
|
|
239
|
-
* .where({ deletedAt: null })
|
|
240
|
-
* .filter()
|
|
241
|
-
* .globalSearch(['name', 'email'])
|
|
242
|
-
* .sort()
|
|
243
|
-
* .limitFields('-password -__v')
|
|
244
|
-
* .paginate();
|
|
245
|
-
*/
|
|
246
|
-
export declare function queryFind<T>(query: Query<T[], T>, queryString: QueryParams, options?: QueryFindOptions): QueryFind<T>;
|
|
247
|
-
export default QueryFind;
|
|
1
|
+
export { QueryAggregate } from './aggregate';
|
|
2
|
+
export { QueryFind } from './find';
|
|
248
3
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC"}
|