@clickup/rest-client 2.10.293 → 2.10.294

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.
Files changed (68) hide show
  1. package/.eslintrc.base.js +18 -1
  2. package/README.md +1 -1
  3. package/SECURITY.md +39 -0
  4. package/dist/.eslintcache +1 -0
  5. package/dist/RestClient.js +1 -1
  6. package/dist/RestClient.js.map +1 -1
  7. package/dist/RestOptions.d.ts +5 -7
  8. package/dist/RestOptions.d.ts.map +1 -1
  9. package/dist/RestOptions.js +2 -2
  10. package/dist/RestOptions.js.map +1 -1
  11. package/dist/RestRequest.d.ts.map +1 -1
  12. package/dist/RestRequest.js +7 -13
  13. package/dist/RestRequest.js.map +1 -1
  14. package/dist/RestResponse.d.ts +4 -1
  15. package/dist/RestResponse.d.ts.map +1 -1
  16. package/dist/RestResponse.js +2 -1
  17. package/dist/RestResponse.js.map +1 -1
  18. package/dist/RestStream.js.map +1 -1
  19. package/dist/helpers/depaginate.d.ts +1 -1
  20. package/dist/helpers/depaginate.d.ts.map +1 -1
  21. package/dist/helpers/depaginate.js.map +1 -1
  22. package/dist/internal/RestFetchReader.d.ts +9 -2
  23. package/dist/internal/RestFetchReader.d.ts.map +1 -1
  24. package/dist/internal/RestFetchReader.js +14 -3
  25. package/dist/internal/RestFetchReader.js.map +1 -1
  26. package/dist/internal/RestRangeUploader.js.map +1 -1
  27. package/dist/internal/calcRetryDelay.js.map +1 -1
  28. package/dist/internal/inspectPossibleJSON.js.map +1 -1
  29. package/dist/internal/substituteParams.js.map +1 -1
  30. package/dist/internal/throwIfErrorResponse.js.map +1 -1
  31. package/dist/middlewares/paceRequests.js.map +1 -1
  32. package/dist/pacers/PacerQPS.js.map +1 -1
  33. package/docs/README.md +1 -1
  34. package/docs/classes/RestResponse.md +19 -8
  35. package/docs/interfaces/RestOptions.md +20 -21
  36. package/docs/modules.md +1 -1
  37. package/jest.config.js +3 -0
  38. package/package.json +36 -7
  39. package/src/RestClient.ts +490 -0
  40. package/src/RestOptions.ts +186 -0
  41. package/src/RestRequest.ts +441 -0
  42. package/src/RestResponse.ts +49 -0
  43. package/src/RestStream.ts +89 -0
  44. package/src/errors/RestContentSizeOverLimitError.ts +3 -0
  45. package/src/errors/RestError.ts +6 -0
  46. package/src/errors/RestRateLimitError.ts +8 -0
  47. package/src/errors/RestResponseError.ts +46 -0
  48. package/src/errors/RestRetriableError.ts +8 -0
  49. package/src/errors/RestTimeoutError.ts +3 -0
  50. package/src/errors/RestTokenInvalidError.ts +8 -0
  51. package/src/helpers/depaginate.ts +37 -0
  52. package/src/index.ts +50 -0
  53. package/src/internal/RestFetchReader.ts +188 -0
  54. package/src/internal/RestRangeUploader.ts +61 -0
  55. package/src/internal/calcRetryDelay.ts +59 -0
  56. package/src/internal/inferResBodyEncoding.ts +33 -0
  57. package/src/internal/inspectPossibleJSON.ts +71 -0
  58. package/src/internal/prependNewlineIfMultiline.ts +3 -0
  59. package/src/internal/substituteParams.ts +25 -0
  60. package/src/internal/throwIfErrorResponse.ts +89 -0
  61. package/src/internal/toFloatMs.ts +3 -0
  62. package/src/middlewares/paceRequests.ts +42 -0
  63. package/src/pacers/Pacer.ts +22 -0
  64. package/src/pacers/PacerComposite.ts +29 -0
  65. package/src/pacers/PacerQPS.ts +147 -0
  66. package/tsconfig.json +3 -10
  67. package/typedoc.json +6 -1
  68. package/dist/tsconfig.tsbuildinfo +0 -1
@@ -1 +1 @@
1
- {"version":3,"file":"inspectPossibleJSON.js","sourceRoot":"","sources":["../../src/internal/inspectPossibleJSON.ts"],"names":[],"mappings":";;;;;AAAA,+BAA+B;AAC/B,2DAAmC;AACnC,+DAAuC;AAEvC,SAAwB,mBAAmB,CACzC,OAA6C,EAC7C,IAA6C,EAC7C,YAAoB;IAEpB,MAAM,oBAAoB,GAAG,IAAI,GAAG,IAAI,CAAC;IAEzC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,MAAM,GAAG,oBAAoB,EAAE;QAClE,wDAAwD;QACxD,OAAO,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;KACrC;IAED,IAAI,IAAI,YAAY,MAAM,EAAE;QAC1B,OAAO,YAAY,IAAI,CAAC,MAAM,SAAS,CAAC;KACzC;IAED,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QACrC,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE;YACtD,OAAO,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;SACrC;QAED,IAAI;YACF,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAE9B,IAAI,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,CAAC,IAAI,YAAY,KAAK,CAAC,EAAE;gBAChE,qEAAqE;gBACrE,uEAAuE;gBACvE,mEAAmE;gBACnE,kBAAkB,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,CAC7B,CAAC,KAAK,OAAO,IAAI,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CACzC,CAAC;aACH;YAED,OAAO,QAAQ,CACb,IAAA,cAAO,EAAC,IAAI,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,EAC3C,YAAY,CACb,CAAC;SACH;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;SACrC;KACF;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AA3CD,sCA2CC;AAED;;;GAGG;AACH,SAAS,kBAAkB,CACzB,GAAwB,EACxB,MAA8C;IAE9C,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACpC,KAAK,MAAM,CAAC,IAAI,GAAG,EAAE;QACnB,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC;KACf;IAED,MAAM,CAAC,MAAM,CACX,GAAG,EACH,MAAM,CAAC,WAAW,CAAC,IAAA,gBAAM,EAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAC9D,CAAC;AACJ,CAAC;AAED,SAAS,QAAQ,CAAC,IAAS,EAAE,MAAc;IACzC,OAAO,IAAA,kBAAQ,EAAC,EAAE,GAAG,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;AACnD,CAAC"}
1
+ {"version":3,"file":"inspectPossibleJSON.js","sourceRoot":"","sources":["../../src/internal/inspectPossibleJSON.ts"],"names":[],"mappings":";;;;;AAAA,+BAA+B;AAC/B,2DAAmC;AACnC,+DAAuC;AAEvC,SAAwB,mBAAmB,CACzC,OAA6C,EAC7C,IAA6C,EAC7C,YAAoB;IAEpB,MAAM,oBAAoB,GAAG,IAAI,GAAG,IAAI,CAAC;IAEzC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,MAAM,GAAG,oBAAoB,EAAE,CAAC;QACnE,wDAAwD;QACxD,OAAO,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IACtC,CAAC;IAED,IAAI,IAAI,YAAY,MAAM,EAAE,CAAC;QAC3B,OAAO,YAAY,IAAI,CAAC,MAAM,SAAS,CAAC;IAC1C,CAAC;IAED,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QACtC,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;YACvD,OAAO,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;QACtC,CAAC;QAED,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAE9B,IAAI,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,CAAC,IAAI,YAAY,KAAK,CAAC,EAAE,CAAC;gBACjE,qEAAqE;gBACrE,uEAAuE;gBACvE,mEAAmE;gBACnE,kBAAkB,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,CAC7B,CAAC,KAAK,OAAO,IAAI,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CACzC,CAAC;YACJ,CAAC;YAED,OAAO,QAAQ,CACb,IAAA,cAAO,EAAC,IAAI,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,EAC3C,YAAY,CACb,CAAC;QACJ,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,OAAO,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;QACtC,CAAC;IACH,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AA3CD,sCA2CC;AAED;;;GAGG;AACH,SAAS,kBAAkB,CACzB,GAAwB,EACxB,MAA8C;IAE9C,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACpC,KAAK,MAAM,CAAC,IAAI,GAAG,EAAE,CAAC;QACpB,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC;IAChB,CAAC;IAED,MAAM,CAAC,MAAM,CACX,GAAG,EACH,MAAM,CAAC,WAAW,CAAC,IAAA,gBAAM,EAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAC9D,CAAC;AACJ,CAAC;AAED,SAAS,QAAQ,CAAC,IAAS,EAAE,MAAc;IACzC,OAAO,IAAA,kBAAQ,EAAC,EAAE,GAAG,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;AACnD,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"substituteParams.js","sourceRoot":"","sources":["../../src/internal/substituteParams.ts"],"names":[],"mappings":";;AAAA;;;;GAIG;AACH,SAAwB,gBAAgB,CACtC,GAAW,EACX,IAAW;IAEX,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QACrC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;KACpB;IAED,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,iBAAiB,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QACpD,MAAM,KAAK,GAAI,IAAY,CAAC,KAAK,CAAC,CAAC;QACnC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC1D,IAAI,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC;YACnB,OAAQ,IAAY,CAAC,KAAK,CAAC,CAAC;YAC5B,OAAO,kBAAkB,CAAC,KAAK,CAAC,CAAC;SAClC;QAED,OAAO,KAAK,CAAC;IACf,CAAC,CAAC,CAAC;IACH,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;AACrB,CAAC;AAnBD,mCAmBC"}
1
+ {"version":3,"file":"substituteParams.js","sourceRoot":"","sources":["../../src/internal/substituteParams.ts"],"names":[],"mappings":";;AAAA;;;;GAIG;AACH,SAAwB,gBAAgB,CACtC,GAAW,EACX,IAAW;IAEX,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QACtC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACrB,CAAC;IAED,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,iBAAiB,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QACpD,MAAM,KAAK,GAAI,IAAY,CAAC,KAAK,CAAC,CAAC;QACnC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC3D,IAAI,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC;YACnB,OAAQ,IAAY,CAAC,KAAK,CAAC,CAAC;YAC5B,OAAO,kBAAkB,CAAC,KAAK,CAAC,CAAC;QACnC,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC,CAAC,CAAC;IACH,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;AACrB,CAAC;AAnBD,mCAmBC"}
@@ -1 +1 @@
1
- {"version":3,"file":"throwIfErrorResponse.js","sourceRoot":"","sources":["../../src/internal/throwIfErrorResponse.ts"],"names":[],"mappings":";;;;;AAAA,sFAA8D;AAC9D,oFAA4D;AAC5D,sFAA8D;AAC9D,4FAAoE;AAIpE,MAAM,wBAAwB,GAAG,GAAG,CAAC;AAErC;;;;;;GAMG;AACH,SAAwB,oBAAoB,CAC1C,OAAoB,EACpB,GAAiB;IAEjB,MAAM,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACzD,IAAI,iBAAiB,KAAK,SAAS,EAAE;QACnC,OAAO;KACR;IAED,MAAM,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;IACvD,QAAQ,gBAAgB,EAAE;QACxB,KAAK,YAAY;YACf,MAAM,IAAI,4BAAkB,CAC1B,+BAA+B,gBAAgB,EAAE,EACjD,CAAC,EACD,GAAG,CACJ,CAAC;QACJ,KAAK,aAAa;YAChB,IAAI,GAAG,CAAC,MAAM,KAAK,wBAAwB,EAAE;gBAC3C,MAAM,gBAAgB,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,GAAG,CAAC;gBAC/D,MAAM,IAAI,4BAAkB,CAC1B,+BAA+B,wBAAwB,EAAE,EACzD,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAC/B,GAAG,CACJ,CAAC;aACH;YAED,MAAM;QACR,KAAK,gBAAgB;YACnB,MAAM;QACR;YACE,MAAM,IAAI,4BAAkB,CAC1B,2CAA2C,gBAAgB,KAAK,EAChE,gBAAgB,EAChB,GAAG,CACJ,CAAC;KACL;IAED,MAAM,mBAAmB,GAAG,OAAO,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC;IAC7D,IAAI,mBAAmB,EAAE;QACvB,MAAM,IAAI,+BAAqB,CAAC,mBAAmB,EAAE,GAAG,CAAC,CAAC;KAC3D;IAED,MAAM,YAAY,GAAG,OAAO,CAAC,gBAAgB,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACzD,QAAQ,YAAY,EAAE;QACpB,KAAK,OAAO;YACV,MAAM,IAAI,4BAAkB,CAC1B,+BAA+B,YAAY,EAAE,EAC7C,CAAC,EACD,GAAG,CACJ,CAAC;QACJ,KAAK,aAAa,CAAC;QACnB,KAAK,aAAa;YAChB,MAAM;QACR;YACE,MAAM,IAAI,4BAAkB,CAC1B,4CAA4C,YAAY,KAAK,EAC7D,YAAY,EACZ,GAAG,CACJ,CAAC;KACL;IAED,IAAI,iBAAiB,KAAK,OAAO,EAAE;QACjC,MAAM,IAAI,2BAAiB,CACzB,gCAAgC,iBAAiB,EAAE,EACnD,GAAG,CACJ,CAAC;KACH;IAED,IAAI,GAAG,CAAC,MAAM,IAAI,GAAG,EAAE;QACrB,MAAM,IAAI,2BAAiB,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;KACtC;AACH,CAAC;AAxED,uCAwEC"}
1
+ {"version":3,"file":"throwIfErrorResponse.js","sourceRoot":"","sources":["../../src/internal/throwIfErrorResponse.ts"],"names":[],"mappings":";;;;;AAAA,sFAA8D;AAC9D,oFAA4D;AAC5D,sFAA8D;AAC9D,4FAAoE;AAIpE,MAAM,wBAAwB,GAAG,GAAG,CAAC;AAErC;;;;;;GAMG;AACH,SAAwB,oBAAoB,CAC1C,OAAoB,EACpB,GAAiB;IAEjB,MAAM,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACzD,IAAI,iBAAiB,KAAK,SAAS,EAAE,CAAC;QACpC,OAAO;IACT,CAAC;IAED,MAAM,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;IACvD,QAAQ,gBAAgB,EAAE,CAAC;QACzB,KAAK,YAAY;YACf,MAAM,IAAI,4BAAkB,CAC1B,+BAA+B,gBAAgB,EAAE,EACjD,CAAC,EACD,GAAG,CACJ,CAAC;QACJ,KAAK,aAAa;YAChB,IAAI,GAAG,CAAC,MAAM,KAAK,wBAAwB,EAAE,CAAC;gBAC5C,MAAM,gBAAgB,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,GAAG,CAAC;gBAC/D,MAAM,IAAI,4BAAkB,CAC1B,+BAA+B,wBAAwB,EAAE,EACzD,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAC/B,GAAG,CACJ,CAAC;YACJ,CAAC;YAED,MAAM;QACR,KAAK,gBAAgB;YACnB,MAAM;QACR;YACE,MAAM,IAAI,4BAAkB,CAC1B,2CAA2C,gBAAgB,KAAK,EAChE,gBAAgB,EAChB,GAAG,CACJ,CAAC;IACN,CAAC;IAED,MAAM,mBAAmB,GAAG,OAAO,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC;IAC7D,IAAI,mBAAmB,EAAE,CAAC;QACxB,MAAM,IAAI,+BAAqB,CAAC,mBAAmB,EAAE,GAAG,CAAC,CAAC;IAC5D,CAAC;IAED,MAAM,YAAY,GAAG,OAAO,CAAC,gBAAgB,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACzD,QAAQ,YAAY,EAAE,CAAC;QACrB,KAAK,OAAO;YACV,MAAM,IAAI,4BAAkB,CAC1B,+BAA+B,YAAY,EAAE,EAC7C,CAAC,EACD,GAAG,CACJ,CAAC;QACJ,KAAK,aAAa,CAAC;QACnB,KAAK,aAAa;YAChB,MAAM;QACR;YACE,MAAM,IAAI,4BAAkB,CAC1B,4CAA4C,YAAY,KAAK,EAC7D,YAAY,EACZ,GAAG,CACJ,CAAC;IACN,CAAC;IAED,IAAI,iBAAiB,KAAK,OAAO,EAAE,CAAC;QAClC,MAAM,IAAI,2BAAiB,CACzB,gCAAgC,iBAAiB,EAAE,EACnD,GAAG,CACJ,CAAC;IACJ,CAAC;IAED,IAAI,GAAG,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;QACtB,MAAM,IAAI,2BAAiB,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IACvC,CAAC;AACH,CAAC;AAxED,uCAwEC"}
@@ -1 +1 @@
1
- {"version":3,"file":"paceRequests.js","sourceRoot":"","sources":["../../src/middlewares/paceRequests.ts"],"names":[],"mappings":";;AAIA,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAE5B;;;GAGG;AACH,SAAwB,YAAY,CAClC,KAAmE;IAEnE,OAAO,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QACzB,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE;YAC/B,KAAK,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;SAC1B;QAED,IAAI,KAAK,EAAE;YACT,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC;YAChD,IAAI,OAAO,GAAG,CAAC,EAAE;gBACf,MAAM,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;aAC9C;YAED,IAAI,OAAO,GAAG,gBAAgB,EAAE;gBAC9B,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC;oBACjB,OAAO,EAAE,CAAC;oBACV,GAAG;oBACH,GAAG,EAAE,eAAe;oBACpB,SAAS,EAAE,IAAI;oBACf,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;oBACrB,OAAO,EAAE,OAAO;oBAChB,cAAc,EAAE,IAAI;oBACpB,qBAAqB,EAAE,KAAK;oBAC5B,OAAO,EAAE,MAAM;iBAChB,CAAC,CAAC;aACJ;SACF;QAED,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;IACnB,CAAC,CAAC;AACJ,CAAC;AA/BD,+BA+BC"}
1
+ {"version":3,"file":"paceRequests.js","sourceRoot":"","sources":["../../src/middlewares/paceRequests.ts"],"names":[],"mappings":";;AAIA,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAE5B;;;GAGG;AACH,SAAwB,YAAY,CAClC,KAAmE;IAEnE,OAAO,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QACzB,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;YAChC,KAAK,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;QAC3B,CAAC;QAED,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC;YAChD,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;gBAChB,MAAM,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAC/C,CAAC;YAED,IAAI,OAAO,GAAG,gBAAgB,EAAE,CAAC;gBAC/B,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC;oBACjB,OAAO,EAAE,CAAC;oBACV,GAAG;oBACH,GAAG,EAAE,eAAe;oBACpB,SAAS,EAAE,IAAI;oBACf,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;oBACrB,OAAO,EAAE,OAAO;oBAChB,cAAc,EAAE,IAAI;oBACpB,qBAAqB,EAAE,KAAK;oBAC5B,OAAO,EAAE,MAAM;iBAChB,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;IACnB,CAAC,CAAC;AACJ,CAAC;AA/BD,+BA+BC"}
@@ -1 +1 @@
1
- {"version":3,"file":"PacerQPS.js","sourceRoot":"","sources":["../../src/pacers/PacerQPS.ts"],"names":[],"mappings":";;;;;AAAA,2DAAmC;AAInC;;;4CAG4C;AAC5C,MAAM,0BAA0B,GAAG,IAAI,CAAC;AAExC,oCAAoC;AACpC,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAE9B;;;;6CAI6C;AAC7C,MAAM,8BAA8B,GAAG,EAAE,CAAC;AAE1C;;;;yBAIyB;AACzB,MAAM,wBAAwB,GAAG,IAAI,CAAC;AAEtC,4DAA4D;AAC5D,MAAM,iBAAiB,GAAG,GAAG,CAAC;AA8B9B;;;;;;;;;;GAUG;AACH,MAAqB,QAAQ;IAI3B,YACU,QAAyB,EACzB,QAAyB;QADzB,aAAQ,GAAR,QAAQ,CAAiB;QACzB,aAAQ,GAAR,QAAQ,CAAiB;QAL3B,kBAAa,GAAG,IAAI,CAAC;QACrB,WAAM,GAAG,CAAC,CAAC;IAKhB,CAAC;IAEJ,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,KAAK;;QACT,MAAM,SAAS,GAAG,MAAA,IAAI,CAAC,QAAQ,CAAC,SAAS,mCAAI,kBAAkB,CAAC;QAChE,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACxD,MAAM,iBAAiB,GACrB,MAAA,IAAI,CAAC,QAAQ,CAAC,iBAAiB,mCAAI,0BAA0B,CAAC;QAEhE,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACxB,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC;QAChC,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;YAC3D,IAAI;YACJ,OAAO,EAAE,IAAI,GAAG,SAAS,GAAG,IAAI;YAChC,KAAK,EAAE,IAAI,CAAC,MAAM;YAClB,0BAA0B,EAAE,8BAA8B;SAC3D,CAAC,CAAC;QACH,MAAM,WAAW,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAE5C,oDAAoD;QACpD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;YAC3C,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC9B,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;SAC5B;QAED,uEAAuE;QACvE,mEAAmE;QACnE,0EAA0E;QAC1E,oDAAoD;QACpD,MAAM,uBAAuB,GAAG,IAAI,CAAC,KAAK,CACxC,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,KAAK,CAAC,GAAG,wBAAwB,CACxD,CAAC;QAEF,4EAA4E;QAC5E,2EAA2E;QAC3E,uDAAuD;QACvD,MAAM,sBAAsB,GAAG,IAAI,CAAC,KAAK,CACvC,GAAG;YACD,wBAAwB;YACxB,IAAA,gBAAM,EAAC,CAAC,GAAG,iBAAiB,EAAE,CAAC,GAAG,iBAAiB,EAAE,IAAI,CAAC,CAC7D,CAAC;QAEF,qEAAqE;QACrE,iCAAiC;QACjC,MAAM,WAAW,GAAG,sBAAsB,IAAI,uBAAuB,IAAI,CAAC,CAAC;QAE3E,IAAI,KAAK,GAAG,KAAK,EAAE;YACjB,uEAAuE;YACvE,0EAA0E;YAC1E,uEAAuE;YACvE,IAAI,CAAC,MAAM,IAAI,WAAW,CAAC;SAC5B;aAAM,IAAI,KAAK,GAAG,KAAK,GAAG,iBAAiB,EAAE;YAC5C,6DAA6D;YAC7D,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,CAAC;SACtD;QAED,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,MAAM;YACpB,MAAM,EAAE;gBACN,SAAS,KAAK,QAAQ,SAAS,YAAY,KAAK,GAAG;gBACnD,SAAS,IAAI,CAAC,MAAM,SAAS,WAAW,gBAAgB,WAAW,EAAE;gBACrE,UAAU,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE;gBAC9B,aAAa,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE;gBACtC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;aACzB,CAAC,IAAI,CAAC,IAAI,CAAC;SACb,CAAC;IACJ,CAAC;CACF;AA7ED,2BA6EC"}
1
+ {"version":3,"file":"PacerQPS.js","sourceRoot":"","sources":["../../src/pacers/PacerQPS.ts"],"names":[],"mappings":";;;;;AAAA,2DAAmC;AAInC;;;4CAG4C;AAC5C,MAAM,0BAA0B,GAAG,IAAI,CAAC;AAExC,oCAAoC;AACpC,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAE9B;;;;6CAI6C;AAC7C,MAAM,8BAA8B,GAAG,EAAE,CAAC;AAE1C;;;;yBAIyB;AACzB,MAAM,wBAAwB,GAAG,IAAI,CAAC;AAEtC,4DAA4D;AAC5D,MAAM,iBAAiB,GAAG,GAAG,CAAC;AA8B9B;;;;;;;;;;GAUG;AACH,MAAqB,QAAQ;IAI3B,YACU,QAAyB,EACzB,QAAyB;QADzB,aAAQ,GAAR,QAAQ,CAAiB;QACzB,aAAQ,GAAR,QAAQ,CAAiB;QAL3B,kBAAa,GAAG,IAAI,CAAC;QACrB,WAAM,GAAG,CAAC,CAAC;IAKhB,CAAC;IAEJ,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,KAAK;;QACT,MAAM,SAAS,GAAG,MAAA,IAAI,CAAC,QAAQ,CAAC,SAAS,mCAAI,kBAAkB,CAAC;QAChE,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACxD,MAAM,iBAAiB,GACrB,MAAA,IAAI,CAAC,QAAQ,CAAC,iBAAiB,mCAAI,0BAA0B,CAAC;QAEhE,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACxB,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC;QAChC,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;YAC3D,IAAI;YACJ,OAAO,EAAE,IAAI,GAAG,SAAS,GAAG,IAAI;YAChC,KAAK,EAAE,IAAI,CAAC,MAAM;YAClB,0BAA0B,EAAE,8BAA8B;SAC3D,CAAC,CAAC;QACH,MAAM,WAAW,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAE5C,oDAAoD;QACpD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC5C,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC9B,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;QAC7B,CAAC;QAED,uEAAuE;QACvE,mEAAmE;QACnE,0EAA0E;QAC1E,oDAAoD;QACpD,MAAM,uBAAuB,GAAG,IAAI,CAAC,KAAK,CACxC,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,KAAK,CAAC,GAAG,wBAAwB,CACxD,CAAC;QAEF,4EAA4E;QAC5E,2EAA2E;QAC3E,uDAAuD;QACvD,MAAM,sBAAsB,GAAG,IAAI,CAAC,KAAK,CACvC,GAAG;YACD,wBAAwB;YACxB,IAAA,gBAAM,EAAC,CAAC,GAAG,iBAAiB,EAAE,CAAC,GAAG,iBAAiB,EAAE,IAAI,CAAC,CAC7D,CAAC;QAEF,qEAAqE;QACrE,iCAAiC;QACjC,MAAM,WAAW,GAAG,sBAAsB,IAAI,uBAAuB,IAAI,CAAC,CAAC;QAE3E,IAAI,KAAK,GAAG,KAAK,EAAE,CAAC;YAClB,uEAAuE;YACvE,0EAA0E;YAC1E,uEAAuE;YACvE,IAAI,CAAC,MAAM,IAAI,WAAW,CAAC;QAC7B,CAAC;aAAM,IAAI,KAAK,GAAG,KAAK,GAAG,iBAAiB,EAAE,CAAC;YAC7C,6DAA6D;YAC7D,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,CAAC;QACvD,CAAC;QAED,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,MAAM;YACpB,MAAM,EAAE;gBACN,SAAS,KAAK,QAAQ,SAAS,YAAY,KAAK,GAAG;gBACnD,SAAS,IAAI,CAAC,MAAM,SAAS,WAAW,gBAAgB,WAAW,EAAE;gBACrE,UAAU,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE;gBAC9B,aAAa,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE;gBACtC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;aACzB,CAAC,IAAI,CAAC,IAAI,CAAC;SACb,CAAC;IACJ,CAAC;CACF;AA7ED,2BA6EC"}
package/docs/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  @clickup/rest-client / [Exports](modules.md)
2
2
 
3
- # RestClient: a syntax sugar tool around Node fetch() API, tailored to work with typescript-is or superstruct validators
3
+ # rest-client: a syntax sugar tool around Node fetch() API, tailored to work with typescript-is or superstruct validators
4
4
 
5
5
  See also [Full API documentation](https://github.com/clickup/rest-client/blob/master/docs/modules.md).
6
6
 
@@ -16,13 +16,14 @@ body and make it a part of RestResponse abstraction.
16
16
 
17
17
  ### constructor
18
18
 
19
- • **new RestResponse**(`req`, `status`, `headers`, `text`, `textIsPartial`)
19
+ • **new RestResponse**(`req`, `agent`, `status`, `headers`, `text`, `textIsPartial`)
20
20
 
21
21
  #### Parameters
22
22
 
23
23
  | Name | Type |
24
24
  | :------ | :------ |
25
25
  | `req` | [`RestRequest`](RestRequest.md)<`any`\> |
26
+ | `agent` | ``null`` \| `Agent` |
26
27
  | `status` | `number` |
27
28
  | `headers` | `Headers` |
28
29
  | `text` | `string` |
@@ -30,7 +31,7 @@ body and make it a part of RestResponse abstraction.
30
31
 
31
32
  #### Defined in
32
33
 
33
- [src/RestResponse.ts:17](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L17)
34
+ [src/RestResponse.ts:18](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L18)
34
35
 
35
36
  ## Properties
36
37
 
@@ -40,7 +41,17 @@ body and make it a part of RestResponse abstraction.
40
41
 
41
42
  #### Defined in
42
43
 
43
- [src/RestResponse.ts:18](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L18)
44
+ [src/RestResponse.ts:19](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L19)
45
+
46
+ ___
47
+
48
+ ### agent
49
+
50
+ • `Readonly` **agent**: ``null`` \| `Agent`
51
+
52
+ #### Defined in
53
+
54
+ [src/RestResponse.ts:20](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L20)
44
55
 
45
56
  ___
46
57
 
@@ -50,7 +61,7 @@ ___
50
61
 
51
62
  #### Defined in
52
63
 
53
- [src/RestResponse.ts:19](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L19)
64
+ [src/RestResponse.ts:21](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L21)
54
65
 
55
66
  ___
56
67
 
@@ -60,7 +71,7 @@ ___
60
71
 
61
72
  #### Defined in
62
73
 
63
- [src/RestResponse.ts:20](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L20)
74
+ [src/RestResponse.ts:22](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L22)
64
75
 
65
76
  ___
66
77
 
@@ -70,7 +81,7 @@ ___
70
81
 
71
82
  #### Defined in
72
83
 
73
- [src/RestResponse.ts:21](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L21)
84
+ [src/RestResponse.ts:23](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L23)
74
85
 
75
86
  ___
76
87
 
@@ -80,7 +91,7 @@ ___
80
91
 
81
92
  #### Defined in
82
93
 
83
- [src/RestResponse.ts:22](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L22)
94
+ [src/RestResponse.ts:24](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L24)
84
95
 
85
96
  ## Accessors
86
97
 
@@ -107,4 +118,4 @@ RestRequest.json() instead.
107
118
 
108
119
  #### Defined in
109
120
 
110
- [src/RestResponse.ts:40](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L40)
121
+ [src/RestResponse.ts:42](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L42)
@@ -16,7 +16,7 @@ web app, and we don't want to retry them.
16
16
 
17
17
  #### Defined in
18
18
 
19
- [src/RestOptions.ts:69](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L69)
19
+ [src/RestOptions.ts:70](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L70)
20
20
 
21
21
  ___
22
22
 
@@ -28,7 +28,7 @@ How much time to wait by default on the 1st retry attempt.
28
28
 
29
29
  #### Defined in
30
30
 
31
- [src/RestOptions.ts:71](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L71)
31
+ [src/RestOptions.ts:72](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L72)
32
32
 
33
33
  ___
34
34
 
@@ -40,7 +40,7 @@ How much to increase the retry delay on each retry.
40
40
 
41
41
  #### Defined in
42
42
 
43
- [src/RestOptions.ts:73](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L73)
43
+ [src/RestOptions.ts:74](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L74)
44
44
 
45
45
  ___
46
46
 
@@ -53,7 +53,7 @@ Use this fraction (random) of the current retry delay to jitter both ways
53
53
 
54
54
  #### Defined in
55
55
 
56
- [src/RestOptions.ts:76](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L76)
56
+ [src/RestOptions.ts:77](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L77)
57
57
 
58
58
  ___
59
59
 
@@ -65,7 +65,7 @@ Maximum delay between each retry.
65
65
 
66
66
  #### Defined in
67
67
 
68
- [src/RestOptions.ts:78](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L78)
68
+ [src/RestOptions.ts:79](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L79)
69
69
 
70
70
  ___
71
71
 
@@ -84,7 +84,7 @@ A logic which runs on different IO stages (delay and heartbeats).
84
84
 
85
85
  #### Defined in
86
86
 
87
- [src/RestOptions.ts:80](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L80)
87
+ [src/RestOptions.ts:81](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L81)
88
88
 
89
89
  ___
90
90
 
@@ -96,7 +96,7 @@ Allows to limit huge requests and throw instead.
96
96
 
97
97
  #### Defined in
98
98
 
99
- [src/RestOptions.ts:91](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L91)
99
+ [src/RestOptions.ts:92](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L92)
100
100
 
101
101
  ___
102
102
 
@@ -109,7 +109,7 @@ response or not.
109
109
 
110
110
  #### Defined in
111
111
 
112
- [src/RestOptions.ts:94](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L94)
112
+ [src/RestOptions.ts:95](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L95)
113
113
 
114
114
  ___
115
115
 
@@ -122,7 +122,7 @@ addresses are allowed.
122
122
 
123
123
  #### Defined in
124
124
 
125
- [src/RestOptions.ts:97](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L97)
125
+ [src/RestOptions.ts:98](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L98)
126
126
 
127
127
  ___
128
128
 
@@ -134,7 +134,7 @@ If true, logs request-response pairs to console.
134
134
 
135
135
  #### Defined in
136
136
 
137
- [src/RestOptions.ts:99](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L99)
137
+ [src/RestOptions.ts:100](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L100)
138
138
 
139
139
  ___
140
140
 
@@ -148,13 +148,12 @@ Sets Keep-Alive parameters (persistent connections).
148
148
 
149
149
  | Name | Type | Description |
150
150
  | :------ | :------ | :------ |
151
- | `timeout` | `number` | A hint to the server, how much time to keep the connection alive. Not all the servers respect it though (e.g. nginx and express do not). |
152
- | `max` | `number` | How many requests are allowed to be processed in one connection. |
151
+ | `timeoutMs` | `number` | How much time to keep an idle connection alive in the pool. If 0, closes the connection immediately after the response. |
153
152
  | `maxSockets?` | `number` | How many sockets at maximum will be kept open. |
154
153
 
155
154
  #### Defined in
156
155
 
157
- [src/RestOptions.ts:103](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L103)
156
+ [src/RestOptions.ts:104](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L104)
158
157
 
159
158
  ___
160
159
 
@@ -166,7 +165,7 @@ When resolving DNS, use IPv4, IPv6 or both (see dns.lookup() docs).
166
165
 
167
166
  #### Defined in
168
167
 
169
- [src/RestOptions.ts:113](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L113)
168
+ [src/RestOptions.ts:112](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L112)
170
169
 
171
170
  ___
172
171
 
@@ -178,7 +177,7 @@ Max timeout to wait for a response.
178
177
 
179
178
  #### Defined in
180
179
 
181
- [src/RestOptions.ts:115](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L115)
180
+ [src/RestOptions.ts:114](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L114)
182
181
 
183
182
  ___
184
183
 
@@ -205,7 +204,7 @@ delay events logging.
205
204
 
206
205
  #### Defined in
207
206
 
208
- [src/RestOptions.ts:118](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L118)
207
+ [src/RestOptions.ts:117](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L117)
209
208
 
210
209
  ___
211
210
 
@@ -217,7 +216,7 @@ Middlewares to wrap requests. May alter both request and response.
217
216
 
218
217
  #### Defined in
219
218
 
220
- [src/RestOptions.ts:120](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L120)
219
+ [src/RestOptions.ts:119](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L119)
221
220
 
222
221
  ___
223
222
 
@@ -254,7 +253,7 @@ remote API is that weird. Return values:
254
253
 
255
254
  #### Defined in
256
255
 
257
- [src/RestOptions.ts:134](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L134)
256
+ [src/RestOptions.ts:132](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L132)
258
257
 
259
258
  ___
260
259
 
@@ -288,7 +287,7 @@ contradictory information; then isRateLimitError wins.
288
287
 
289
288
  #### Defined in
290
289
 
291
- [src/RestOptions.ts:144](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L144)
290
+ [src/RestOptions.ts:142](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L142)
292
291
 
293
292
  ___
294
293
 
@@ -315,7 +314,7 @@ not, the response ought to be either success or some other error.
315
314
 
316
315
  #### Defined in
317
316
 
318
- [src/RestOptions.ts:149](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L149)
317
+ [src/RestOptions.ts:147](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L147)
319
318
 
320
319
  ___
321
320
 
@@ -348,4 +347,4 @@ retry will happen in not less than this number of milliseconds.
348
347
 
349
348
  #### Defined in
350
349
 
351
- [src/RestOptions.ts:157](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L157)
350
+ [src/RestOptions.ts:155](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L155)
package/docs/modules.md CHANGED
@@ -53,7 +53,7 @@ On each call, the inner function needs to return an array with two elements:
53
53
 
54
54
  | Name | Type |
55
55
  | :------ | :------ |
56
- | `readFunc` | (`cursor`: `undefined` \| `TCursor`) => `Promise`<[`TItem`[], `undefined` \| ``null`` \| `TCursor`]\> |
56
+ | `readFunc` | (`cursor`: `undefined` \| `TCursor`) => `Promise`<readonly [`TItem`[], `undefined` \| ``null`` \| `TCursor`]\> |
57
57
 
58
58
  #### Returns
59
59
 
package/jest.config.js CHANGED
@@ -2,6 +2,9 @@
2
2
  module.exports = {
3
3
  roots: ["<rootDir>/src"],
4
4
  testMatch: ["**/*.test.ts"],
5
+ clearMocks: true,
6
+ restoreMocks: true,
7
+ ...(process.env.IN_JEST_PROJECT ? {} : { forceExit: true }),
5
8
  transform: {
6
9
  "\\.ts$": "ts-jest",
7
10
  },
package/package.json CHANGED
@@ -1,19 +1,36 @@
1
1
  {
2
2
  "name": "@clickup/rest-client",
3
3
  "description": "A syntax sugar tool around Node fetch() API, tailored to work with TypeScript and response validators",
4
- "version": "2.10.293",
4
+ "version": "2.10.294",
5
5
  "license": "MIT",
6
- "main": "dist/index.js",
7
- "types": "dist/index.d.ts",
6
+ "keywords": [
7
+ "rest-client",
8
+ "rest",
9
+ "request",
10
+ "response",
11
+ "fetch",
12
+ "typescript",
13
+ "nodejs",
14
+ "superstruct",
15
+ "typescript-is",
16
+ "validation",
17
+ "json validation",
18
+ "strong typing",
19
+ "node-fetch"
20
+ ],
21
+ "main": "./dist/index.js",
22
+ "types": "./dist/index.d.ts",
23
+ "exports": "./dist/index.js",
8
24
  "scripts": {
9
25
  "build": "tsc",
10
- "dev": "tsc --watch",
26
+ "dev": "tsc --watch --preserveWatchOutput",
11
27
  "lint": "eslint . --ext .ts --cache --cache-location dist/.eslintcache",
12
28
  "test": "jest",
13
29
  "docs": "rm -rf docs && typedoc --plugin typedoc-plugin-markdown --plugin typedoc-plugin-merge-modules && sed -i '' -E 's#packages/[^/]+/##g' $(find docs -type f -name '*.md')",
14
30
  "clean": "rm -rf dist node_modules yarn.lock package-lock.json",
15
31
  "copy-package-to-public-dir": "copy-package-to-public-dir.sh",
16
- "deploy": "npm run build && npm test && npm publish --access=public"
32
+ "backport-package-from-public-dir": "backport-package-from-public-dir.sh",
33
+ "deploy": "npm run build && npm run lint && npm run test && npm publish --access=public"
17
34
  },
18
35
  "dependencies": {
19
36
  "abort-controller": "^3.0.0",
@@ -28,11 +45,23 @@
28
45
  "@types/jest": "^29.5.5",
29
46
  "@types/lodash": "^4.14.175",
30
47
  "@types/node-fetch": "^2.6.4",
31
- "superstruct": "^0.15.3",
48
+ "@typescript-eslint/eslint-plugin": "^5.59.6",
49
+ "@typescript-eslint/parser": "^5.59.6",
50
+ "eslint-import-resolver-typescript": "^3.5.5",
51
+ "eslint-plugin-import": "^2.27.5",
52
+ "eslint-plugin-lodash": "^7.4.0",
53
+ "eslint-plugin-node": "^11.1.0",
54
+ "eslint-plugin-react-hooks": "^4.6.0",
55
+ "eslint-plugin-react": "^7.32.2",
56
+ "eslint-plugin-typescript-enum": "^2.1.0",
57
+ "eslint-plugin-typescript-sort-keys": "^2.3.0",
58
+ "eslint-plugin-unused-imports": "^2.0.0",
59
+ "eslint": "^8.40.0",
60
+ "superstruct": "^1.0.3",
32
61
  "ts-jest": "^29.1.1",
33
- "typedoc": "^0.25.2",
34
62
  "typedoc-plugin-markdown": "^3.16.0",
35
63
  "typedoc-plugin-merge-modules": "^5.1.0",
64
+ "typedoc": "^0.25.2",
36
65
  "typescript": "^5.2.2"
37
66
  },
38
67
  "repository": {