@clickup/rest-client 2.10.296 → 2.11.0

package/dist/internal/inspectPossibleJSON.js

@@ -5,19 +5,19 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const util_1 = require("util");
 const sortBy_1 = __importDefault(require("lodash/sortBy"));
-const truncate_1 = __importDefault(require("lodash/truncate"));
+const ellipsis_1 = __importDefault(require("./ellipsis"));
 function inspectPossibleJSON(headers, text, maxOutputLen) {
     const MAX_LEN_TO_TRY_PARSE = 1024 * 1024;
     if (typeof text === "string" && text.length > MAX_LEN_TO_TRY_PARSE) {
         // Don't even try to JSON-parse if the text is too long.
-        return ellipsis(text, maxOutputLen);
+        return (0, ellipsis_1.default)(text, maxOutputLen);
     }
     if (text instanceof Buffer) {
         return `<Buffer: ${text.length} bytes>`;
     }
     if (!text || typeof text === "string") {
         if (!(headers.get("content-type") || "").match(/json/)) {
-            return ellipsis(text, maxOutputLen);
+            return (0, ellipsis_1.default)(text, maxOutputLen);
         }
         try {
             const json = JSON.parse(text);
@@ -27,10 +27,10 @@ function inspectPossibleJSON(headers, text, maxOutputLen) {
                 // all, but it's hard to reorder at any other layer of abstraction.
                 reorderObjectProps(json, (k) => k === "error" || k === "errors" ? "" : k);
             }
-            return ellipsis((0, util_1.inspect)(json, { depth: 20, compact: true }), maxOutputLen);
+            return (0, ellipsis_1.default)((0, util_1.inspect)(json, { depth: 20, compact: true }), maxOutputLen);
         }
         catch (e) {
-            return ellipsis(text, maxOutputLen);
+            return (0, ellipsis_1.default)(text, maxOutputLen);
         }
     }
     return "<Stream>";
@@ -47,7 +47,4 @@ function reorderObjectProps(obj, ranker) {
     }
     Object.assign(obj, Object.fromEntries((0, sortBy_1.default)(entries, ([k, v]) => ranker(k, v))));
 }
-function ellipsis(text, length) {
-    return (0, truncate_1.default)("" + text, { length }).trimEnd();
-}
 //# sourceMappingURL=inspectPossibleJSON.js.map

package/dist/internal/inspectPossibleJSON.js.map

@@ -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,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"}
+{"version":3,"file":"inspectPossibleJSON.js","sourceRoot":"","sources":["../../src/internal/inspectPossibleJSON.ts"],"names":[],"mappings":";;;;;AAAA,+BAA+B;AAC/B,2DAAmC;AACnC,0DAAkC;AAElC,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,IAAA,kBAAQ,EAAC,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,IAAA,kBAAQ,EAAC,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,IAAA,kBAAQ,EACb,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,IAAA,kBAAQ,EAAC,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"}

package/dist/internal/throwIfErrorResponse.js

@@ -27,7 +27,7 @@ function throwIfErrorResponse(options, res) {
         case "BEST_EFFORT":
             if (res.status === STATUS_TOO_MANY_REQUESTS) {
                 const retryAfterHeader = res.headers.get("Retry-After") || "0";
-                throw new RestRateLimitError_1.default(`Rate limited by HTTP status ${STATUS_TOO_MANY_REQUESTS}`, parseInt(retryAfterHeader) || 0, res);
+                throw new RestRateLimitError_1.default(`Rate limited by HTTP status ${STATUS_TOO_MANY_REQUESTS}`, 1000 * parseInt(retryAfterHeader) || 0, res);
             }
             break;
         case "SOMETHING_ELSE":

package/dist/internal/throwIfErrorResponse.js.map

@@ -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,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"}
+{"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,IAAI,GAAG,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,EACtC,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"}

package/dist/middlewares/paceRequests.d.ts

@@ -1,9 +1,28 @@
-import type Pacer from "../pacers/Pacer";
 import type { Middleware } from "../RestOptions";
 import type RestRequest from "../RestRequest";
+/**
+ * Pacer is a class which allows to pace requests on some resource identified by
+ * the instance of this class.
+ */
+export interface Pacer {
+    /** Human readable name of the pacer, used when composing multiple pacers. */
+    readonly key: string;
+    /**
+     * Signals that we're about to send a request. Returns the delay we need to
+     * wait for before actually sending.
+     */
+    pace(): Promise<PacerOutcome>;
+}
+/**
+ * A result of some Pacer work.
+ */
+export interface PacerOutcome {
+    delayMs: number;
+    reason: string;
+}
 /**
  * Rest Client middleware that adds some delay between requests using one of
  * Pacer implementations.
  */
-export default function paceRequests(pacer: Pacer | ((req: RestRequest) => Promise<Pacer | null>) | null): Middleware;
+export default function paceRequests(pacer: Pacer | ((req: RestRequest) => Promise<Pacer | null>) | null, delayMetric?: (delay: number, reason: string) => void): Middleware;
 //# sourceMappingURL=paceRequests.d.ts.map

package/dist/middlewares/paceRequests.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"paceRequests.d.ts","sourceRoot":"","sources":["../../src/middlewares/paceRequests.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,iBAAiB,CAAC;AACzC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,KAAK,WAAW,MAAM,gBAAgB,CAAC;AAI9C;;;GAGG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY,CAClC,KAAK,EAAE,KAAK,GAAG,CAAC,CAAC,GAAG,EAAE,WAAW,KAAK,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,GAClE,UAAU,CA6BZ"}
+{"version":3,"file":"paceRequests.d.ts","sourceRoot":"","sources":["../../src/middlewares/paceRequests.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,KAAK,WAAW,MAAM,gBAAgB,CAAC;AAI9C;;;GAGG;AACH,MAAM,WAAW,KAAK;IACpB,6EAA6E;IAC7E,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,IAAI,IAAI,OAAO,CAAC,YAAY,CAAC,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY,CAClC,KAAK,EAAE,KAAK,GAAG,CAAC,CAAC,GAAG,EAAE,WAAW,KAAK,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,EACnE,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,GACpD,UAAU,CA+BZ"}

package/dist/middlewares/paceRequests.js

@@ -5,14 +5,15 @@ const MIN_LOG_DELAY_MS = 10;
  * Rest Client middleware that adds some delay between requests using one of
  * Pacer implementations.
  */
-function paceRequests(pacer) {
+function paceRequests(pacer, delayMetric) {
     return async (req, next) => {
         if (typeof pacer === "function") {
             pacer = await pacer(req);
         }
         if (pacer) {
-            const { delayMs, reason } = await pacer.touch();
+            const { delayMs, reason } = await pacer.pace();
             if (delayMs > 0) {
+                delayMetric === null || delayMetric === void 0 ? void 0 : delayMetric(delayMs, reason);
                 await req.options.heartbeater.delay(delayMs);
             }
             if (delayMs > MIN_LOG_DELAY_MS) {

package/dist/middlewares/paceRequests.js.map

@@ -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,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"}
+{"version":3,"file":"paceRequests.js","sourceRoot":"","sources":["../../src/middlewares/paceRequests.ts"],"names":[],"mappings":";;AAGA,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAyB5B;;;GAGG;AACH,SAAwB,YAAY,CAClC,KAAmE,EACnE,WAAqD;IAErD,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,IAAI,EAAE,CAAC;YAE/C,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;gBAChB,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAG,OAAO,EAAE,MAAM,CAAC,CAAC;gBAC/B,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;AAlCD,+BAkCC"}

package/docs/interfaces/Pacer.md

@@ -5,36 +5,31 @@
 Pacer is a class which allows to pace requests on some resource identified by
 the instance of this class.
 
-## Implemented by
-
-- [`PacerComposite`](../classes/PacerComposite.md)
-- [`PacerQPS`](../classes/PacerQPS.md)
-
 ## Properties
 
-### name
+### key
 
-• `Readonly` **name**: `string`
+• `Readonly` **key**: `string`
 
 Human readable name of the pacer, used when composing multiple pacers.
 
 #### Defined in
 
-[src/pacers/Pacer.ts:15](https://github.com/clickup/rest-client/blob/master/src/pacers/Pacer.ts#L15)
+[src/middlewares/paceRequests.ts:12](https://github.com/clickup/rest-client/blob/master/src/middlewares/paceRequests.ts#L12)
 
 ## Methods
 
-### touch
+### pace
 
-▸ **touch**(): `Promise`\<[`PacerDelay`](PacerDelay.md)\>
+▸ **pace**(): `Promise`\<[`PacerOutcome`](PacerOutcome.md)\>
 
 Signals that we're about to send a request. Returns the delay we need to
 wait for before actually sending.
 
 #### Returns
 
-`Promise`\<[`PacerDelay`](PacerDelay.md)\>
+`Promise`\<[`PacerOutcome`](PacerOutcome.md)\>
 
 #### Defined in
 
-[src/pacers/Pacer.ts:21](https://github.com/clickup/rest-client/blob/master/src/pacers/Pacer.ts#L21)
+[src/middlewares/paceRequests.ts:18](https://github.com/clickup/rest-client/blob/master/src/middlewares/paceRequests.ts#L18)

package/docs/interfaces/PacerOutcome.md

@@ -0,0 +1,25 @@
+[@clickup/rest-client](../README.md) / [Exports](../modules.md) / PacerOutcome
+
+# Interface: PacerOutcome
+
+A result of some Pacer work.
+
+## Properties
+
+### delayMs
+
+• **delayMs**: `number`
+
+#### Defined in
+
+[src/middlewares/paceRequests.ts:25](https://github.com/clickup/rest-client/blob/master/src/middlewares/paceRequests.ts#L25)
+
+___
+
+### reason
+
+• **reason**: `string`
+
+#### Defined in
+
+[src/middlewares/paceRequests.ts:26](https://github.com/clickup/rest-client/blob/master/src/middlewares/paceRequests.ts#L26)

package/docs/interfaces/RestOptions.md

@@ -126,6 +126,18 @@ addresses are allowed.
 
 ___
 
+### responseEncoding
+
+• **responseEncoding**: `undefined` \| `BufferEncoding`
+
+Overrides the default encoding heuristics for responses.
+
+#### Defined in
+
+[src/RestOptions.ts:100](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L100)
+
+___
+
 ### isDebug
 
 • **isDebug**: `boolean`
@@ -134,7 +146,7 @@ If true, logs request-response pairs to console.
 
 #### Defined in
 
-[src/RestOptions.ts:100](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L100)
+[src/RestOptions.ts:102](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L102)
 
 ___
 
@@ -153,7 +165,7 @@ Sets Keep-Alive parameters (persistent connections).
 
 #### Defined in
 
-[src/RestOptions.ts:104](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L104)
+[src/RestOptions.ts:106](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L106)
 
 ___
 
@@ -165,7 +177,7 @@ When resolving DNS, use IPv4, IPv6 or both (see dns.lookup() docs).
 
 #### Defined in
 
-[src/RestOptions.ts:112](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L112)
+[src/RestOptions.ts:114](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L114)
 
 ___
 
@@ -177,7 +189,7 @@ Max timeout to wait for a response.
 
 #### Defined in
 
-[src/RestOptions.ts:114](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L114)
+[src/RestOptions.ts:116](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L116)
 
 ___
 
@@ -192,9 +204,6 @@ delay events logging.
 
 ▸ (`event`): `void`
 
-Logger to be used for each responses (including retried) plus for backoff
-delay events logging.
-
 ##### Parameters
 
 | Name | Type |
@@ -207,7 +216,7 @@ delay events logging.
 
 #### Defined in
 
-[src/RestOptions.ts:117](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L117)
+[src/RestOptions.ts:119](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L119)
 
 ___
 
@@ -219,7 +228,7 @@ Middlewares to wrap requests. May alter both request and response.
 
 #### Defined in
 
-[src/RestOptions.ts:119](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L119)
+[src/RestOptions.ts:121](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L121)
 
 ___
 
@@ -244,19 +253,6 @@ remote API is that weird. Return values:
 
 ▸ (`res`): ``"SUCCESS"`` \| ``"THROW"`` \| ``"BEST_EFFORT"``
 
-If set, makes decision whether the response is successful or not. The
-response will either be returned to the client, or an error will be thrown.
-This allows to treat some non-successful HTTP statuses as success if the
-remote API is that weird. Return values:
-* "SUCCESS" - the request will be considered successful, no further checks
-  will be performed;
-* "BEST_EFFORT" - inconclusive, the request may be either successful or
-  unsuccessful, additional tests (e.g. will check HTTP status code) will be
-  performed;
-* "THROW" - the request resulted in error. Additional tests will be
-  performed to determine is the error is retriable, is OAuth token good,
-  and etc.
-
 ##### Parameters
 
 | Name | Type |
@@ -269,7 +265,7 @@ remote API is that weird. Return values:
 
 #### Defined in
 
-[src/RestOptions.ts:132](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L132)
+[src/RestOptions.ts:134](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L134)
 
 ___
 
@@ -291,16 +287,6 @@ contradictory information; then isRateLimitError wins.
 
 ▸ (`res`): `number` \| ``"BEST_EFFORT"`` \| ``"SOMETHING_ELSE"`` \| ``"RATE_LIMIT"``
 
-Decides whether the response is a rate-limit error or not. Returning
-non-zero value is treated as retry delay (if retries are set up). In case
-the returned value is "SOMETHING_ELSE", the response ought to be either
-success or some other error. Returning "BEST_EFFORT" turns on built-in
-heuristic (e.g. relying on HTTP status code and Retry-After header). In
-case we've made a decision that it's a rate limited error, the request is
-always retried; this covers a very common case when we have both
-isRateLimitError and isRetriableError handlers set up, and they return
-contradictory information; then isRateLimitError wins.
-
 ##### Parameters
 
 | Name | Type |
@@ -313,7 +299,7 @@ contradictory information; then isRateLimitError wins.
 
 #### Defined in
 
-[src/RestOptions.ts:142](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L142)
+[src/RestOptions.ts:144](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L144)
 
 ___
 
@@ -328,9 +314,6 @@ not, the response ought to be either success or some other error.
 
 ▸ (`res`): `boolean`
 
-Decides whether the response is a token-invalid error or not. In case it's
-not, the response ought to be either success or some other error.
-
 ##### Parameters
 
 | Name | Type |
@@ -343,7 +326,7 @@ not, the response ought to be either success or some other error.
 
 #### Defined in
 
-[src/RestOptions.ts:147](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L147)
+[src/RestOptions.ts:149](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L149)
 
 ___
 
@@ -363,14 +346,6 @@ retry will happen in not less than this number of milliseconds.
 
 ▸ (`res`, `_error`): `number` \| ``"BEST_EFFORT"`` \| ``"NEVER_RETRY"`` \| ``"RETRY"``
 
-Called only if we haven't decided earlier that it's a rate limit error.
-Decides whether the response is a retriable error or not. In case the
-returned value is "NEVER_RETRY", the response ought to be either success or
-some other error, but it's guaranteed that the request won't be retried.
-Returning "BEST_EFFORT" turns on built-in heuristics (e.g. never retry "not
-found" errors). Returning a number is treated as "RETRY", and the next
-retry will happen in not less than this number of milliseconds.
-
 ##### Parameters
 
 | Name | Type |
@@ -384,4 +359,4 @@ retry will happen in not less than this number of milliseconds.
 
 #### Defined in
 
-[src/RestOptions.ts:155](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L155)
+[src/RestOptions.ts:157](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L157)

package/docs/modules.md

@@ -15,8 +15,6 @@
 - [RestRetriableError](classes/RestRetriableError.md)
 - [RestTimeoutError](classes/RestTimeoutError.md)
 - [RestTokenInvalidError](classes/RestTokenInvalidError.md)
-- [PacerComposite](classes/PacerComposite.md)
-- [PacerQPS](classes/PacerQPS.md)
 
 ## Interfaces
 
@@ -24,10 +22,8 @@
 - [RestLogEvent](interfaces/RestLogEvent.md)
 - [Middleware](interfaces/Middleware.md)
 - [RestOptions](interfaces/RestOptions.md)
-- [PacerDelay](interfaces/PacerDelay.md)
 - [Pacer](interfaces/Pacer.md)
-- [PacerQPSBackend](interfaces/PacerQPSBackend.md)
-- [PacerQPSOptions](interfaces/PacerQPSOptions.md)
+- [PacerOutcome](interfaces/PacerOutcome.md)
 
 ## Functions
 
@@ -67,7 +63,7 @@ ___
 
 ### paceRequests
 
-▸ **paceRequests**(`pacer`): [`Middleware`](interfaces/Middleware.md)
+▸ **paceRequests**(`pacer`, `delayMetric?`): [`Middleware`](interfaces/Middleware.md)
 
 Rest Client middleware that adds some delay between requests using one of
 Pacer implementations.
@@ -77,6 +73,7 @@ Pacer implementations.
 | Name | Type |
 | :------ | :------ |
 | `pacer` | ``null`` \| [`Pacer`](interfaces/Pacer.md) \| (`req`: [`RestRequest`](classes/RestRequest.md)\<`any`\>) => `Promise`\<``null`` \| [`Pacer`](interfaces/Pacer.md)\> |
+| `delayMetric?` | (`delay`: `number`, `reason`: `string`) => `void` |
 
 #### Returns
 
@@ -84,4 +81,4 @@ Pacer implementations.
 
 #### Defined in
 
-[src/middlewares/paceRequests.ts:11](https://github.com/clickup/rest-client/blob/master/src/middlewares/paceRequests.ts#L11)
+[src/middlewares/paceRequests.ts:33](https://github.com/clickup/rest-client/blob/master/src/middlewares/paceRequests.ts#L33)

package/internal/clean.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+set -e
+
+rm -rf dist yarn.lock package-lock.json pnpm-lock.yaml node_modules ./*.log

package/internal/deploy.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -e
+
+npm run build
+npm run lint
+npm run test
+npm publish --access=public

package/internal/docs.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+set -e
+
+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')

package/internal/lint.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+set -e
+
+eslint . --ext .ts --cache --cache-location dist/.eslintcache

package/jest.config.base.js

@@ -0,0 +1,13 @@
+"use strict";
+module.exports = {
+  roots: ["<rootDir>/src"],
+  testMatch: ["**/*.test.ts"],
+  clearMocks: true,
+  restoreMocks: true,
+  ...(process.env.IN_JEST_PROJECT
+    ? {}
+    : { forceExit: true, testTimeout: 30000 }),
+  transform: {
+    "\\.ts$": "ts-jest",
+  },
+};

package/jest.config.js

@@ -1,11 +1,2 @@
 "use strict";
-module.exports = {
-  roots: ["<rootDir>/src"],
-  testMatch: ["**/*.test.ts"],
-  clearMocks: true,
-  restoreMocks: true,
-  ...(process.env.IN_JEST_PROJECT ? {} : { forceExit: true }),
-  transform: {
-    "\\.ts$": "ts-jest",
-  },
-};
+module.exports = { ...require("./jest.config.base") };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@clickup/rest-client",
   "description": "A syntax sugar tool around Node fetch() API, tailored to work with TypeScript and response validators",
-  "version": "2.10.296",
+  "version": "2.11.0",
   "license": "MIT",
   "keywords": [
     "rest-client",
@@ -24,18 +24,18 @@
   "scripts": {
     "build": "tsc",
     "dev": "tsc --watch --preserveWatchOutput",
-    "lint": "eslint . --ext .ts --cache --cache-location dist/.eslintcache",
+    "lint": "bash internal/lint.sh",
     "test": "jest",
-    "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')",
-    "clean": "rm -rf dist node_modules yarn.lock package-lock.json pnpm-lock.yaml *.log",
+    "docs": "bash internal/docs.sh",
+    "clean": "bash internal/clean.sh",
     "copy-package-to-public-dir": "copy-package-to-public-dir.sh",
     "backport-package-from-public-dir": "backport-package-from-public-dir.sh",
-    "deploy": "npm run build && npm run lint && npm run test && npm publish --access=public"
+    "deploy": "bash internal/deploy.sh"
   },
   "dependencies": {
     "abort-controller": "^3.0.0",
     "delay": "^4.4.1",
-    "fast-typescript-memoize": "^1.0.2",
+    "fast-typescript-memoize": "^1.1.1",
     "ipaddr.js": "^1.9.1",
     "lodash": "^4.17.21",
     "node-fetch": "^2.6.11",
@@ -51,6 +51,7 @@
     "eslint-import-resolver-typescript": "^3.5.5",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-lodash": "^7.4.0",
+    "eslint-plugin-no-only-tests": "^3.1.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-react": "^7.32.2",

package/src/RestClient.ts

@@ -480,8 +480,8 @@ function simpleShape(path: string, args?: any) {
     args && typeof args === "object"
       ? Object.keys(args)
           // Filter out args that are already mentioned in the path, e.g.
-          // /pages/:pageID/blocks.
-          .filter((arg) => !argsInPath.includes(arg))
+          // /pages/:pageID/blocks. Also filter out undefined args.
+          .filter((arg) => !argsInPath.includes(arg) && args[arg] !== undefined)
           .sort()
           .join(",")
       : "";

package/src/RestOptions.ts

@@ -96,6 +96,8 @@ export default interface RestOptions {
   /** If true, non-public IP addresses are allowed too; otherwise, only unicast
    * addresses are allowed. */
   allowInternalIPs: boolean;
+  /** Overrides the default encoding heuristics for responses. */
+  responseEncoding: NodeJS.BufferEncoding | undefined;
   /** If true, logs request-response pairs to console. */
   isDebug: boolean;
   /** @ignore Holds HttpsAgent/HttpAgent instances; used internally only. */
@@ -172,6 +174,7 @@ export const DEFAULT_OPTIONS: RestOptions = {
   throwIfResIsBigger: undefined,
   privateDataInResponse: false,
   allowInternalIPs: false,
+  responseEncoding: undefined,
   isDebug: false,
   agents: new Agents(),
   keepAlive: { timeoutMs: 10000 },

package/src/RestRequest.ts

@@ -347,6 +347,7 @@ export default class RestRequest<TAssertShape = any> {
           );
         }
       },
+      responseEncoding: this.options.responseEncoding,
     });
   }
 

package/src/__tests__/RestClient.test.ts

@@ -0,0 +1,53 @@
+import { RestClient } from "..";
+import substituteParams from "../internal/substituteParams";
+
+test("fetch_plain_url", async () => {
+  const client = new RestClient();
+  const res = await client.get("http://example.com", undefined, "*/*").text();
+  expect(res.length).toBeGreaterThan(10);
+});
+
+test("fetch_loopback_url_fails", async () => {
+  const client = new RestClient();
+  await expect(client.get("http://localhost/abc").response()).rejects.toThrow(
+    new RegExp(
+      "^Domain localhost resolves to a non-public \\(loopback\\) IP address (127\\.0\\.0\\.1)|(\\:\\:1)",
+    ),
+  );
+});
+
+test("fetch_private_url_fails", async () => {
+  const client = new RestClient();
+  await expect(client.get("http://10.0.0.1/abc").response()).rejects.toThrow(
+    "Domain 10.0.0.1 resolves to a non-public (private) IP address 10.0.0.1",
+  );
+});
+
+test("fetch_url_with_redirect_fails", async () => {
+  const client = new RestClient();
+  await expect(client.get("http://google.com").response()).rejects.toThrow(
+    /redirect mode is set to error:/,
+  );
+});
+
+test("fetch_relative_url_fails", async () => {
+  const client = new RestClient();
+  await expect(client.get("/test").text()).rejects.toThrow(/Invalid URL/);
+  await expect(client.get("zzz").text()).rejects.toThrow(/Invalid URL/);
+});
+
+test("substituteParams", async () => {
+  const body = { aa: "aaa", b: 42, x: "y" };
+  expect(substituteParams("/some/:aa/other/:b/ccc/:ddd/eee", body)).toEqual([
+    "/some/aaa/other/42/ccc/:ddd/eee",
+    { x: "y" },
+  ]);
+  expect(body).toEqual({ aa: "aaa", b: 42, x: "y" });
+});
+
+test("withOptions ignores undefined", async () => {
+  const request = new RestClient({ timeoutMs: 1234 })
+    .withOptions({ timeoutMs: undefined })
+    .writeJson("/", "");
+  expect(request.options.timeoutMs).toEqual(1234);
+});