@clickup/rest-client 2.10.296 → 2.11.1

package/src/middlewares/paceRequests.ts

@@ -1,15 +1,38 @@
-import type Pacer from "../pacers/Pacer";
 import type { Middleware } from "../RestOptions";
 import type RestRequest from "../RestRequest";
 
 const MIN_LOG_DELAY_MS = 10;
 
+/**
+ * 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,
+  delayMetric?: (delay: number, reason: string) => void,
 ): Middleware {
   return async (req, next) => {
     if (typeof pacer === "function") {
@@ -17,8 +40,10 @@ export default function paceRequests(
     }
 
     if (pacer) {
-      const { delayMs, reason } = await pacer.touch();
+      const { delayMs, reason } = await pacer.pace();
+
       if (delayMs > 0) {
+        delayMetric?.(delayMs, reason);
         await req.options.heartbeater.delay(delayMs);
       }
 

package/tsconfig.base.json

@@ -0,0 +1,31 @@
+{
+  "include": ["src/**/*"],
+  "compilerOptions": {
+    "allowJs": true,
+    "declaration": true,
+    "declarationMap": true,
+    "disableReferencedProjectLoad": true,
+    "disableSourceOfProjectReferenceRedirect": true,
+    "esModuleInterop": true,
+    "experimentalDecorators": true,
+    "incremental": true,
+    "lib": ["ES2019"],
+    "module": "Node16",
+    "noEmitOnError": true,
+    "noErrorTruncation": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "outDir": "dist",
+    "pretty": true,
+    "removeComments": false,
+    "resolveJsonModule": true,
+    "rootDir": "src",
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "strict": true,
+    "target": "ES2019",
+    "tsBuildInfoFile": "dist/tsconfig.tsbuildinfo",
+    "types": ["node", "jest"]
+  }
+}

package/tsconfig.json

@@ -1,31 +1 @@
-{
-  "include": ["src/**/*"],
-  "compilerOptions": {
-    "allowJs": true,
-    "declaration": true,
-    "declarationMap": true,
-    "disableReferencedProjectLoad": true,
-    "disableSourceOfProjectReferenceRedirect": true,
-    "esModuleInterop": true,
-    "experimentalDecorators": true,
-    "incremental": true,
-    "lib": ["ES2019"],
-    "module": "Node16",
-    "noEmitOnError": true,
-    "noErrorTruncation": true,
-    "noImplicitOverride": true,
-    "noImplicitReturns": true,
-    "noPropertyAccessFromIndexSignature": true,
-    "outDir": "dist",
-    "pretty": true,
-    "removeComments": false,
-    "resolveJsonModule": true,
-    "rootDir": "src",
-    "skipLibCheck": true,
-    "sourceMap": true,
-    "strict": true,
-    "target": "ES2019",
-    "tsBuildInfoFile": "dist/tsconfig.tsbuildinfo",
-    "types": ["node", "jest"]
-  }
-}
+{ "extends": "./tsconfig.base.json" }

package/typedoc.config.js

@@ -0,0 +1,20 @@
+"use strict";
+const { basename } = require("path");
+
+module.exports = {
+  entryPoints: ["src"],
+  exclude: ["**/internal/**", "**/__tests__/**", "**/node_modules/**"],
+  entryPointStrategy: "expand",
+  mergeModulesMergeMode: "project",
+  sort: ["source-order"],
+  out: "docs",
+  logLevel: "Warn",
+  hideGenerator: true,
+  excludeInternal: true,
+  excludePrivate: true,
+  categorizeByGroup: true,
+  hideInPageTOC: true,
+  gitRevision: "master",
+  sourceLinkTemplate: `https://github.com/clickup/${basename(__dirname)}/blob/master/{path}#L{line}`,
+  basePath: ".",
+};

package/dist/pacers/Pacer.d.ts

@@ -1,21 +0,0 @@
-/**
- * A result of some Pacer work.
- */
-export interface PacerDelay {
-    delayMs: number;
-    reason: string;
-}
-/**
- * Pacer is a class which allows to pace requests on some resource identified by
- * the instance of this class.
- */
-export default interface Pacer {
-    /** Human readable name of the pacer, used when composing multiple pacers. */
-    readonly name: string;
-    /**
-     * Signals that we're about to send a request. Returns the delay we need to
-     * wait for before actually sending.
-     */
-    touch(): Promise<PacerDelay>;
-}
-//# sourceMappingURL=Pacer.d.ts.map

package/dist/pacers/Pacer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Pacer.d.ts","sourceRoot":"","sources":["../../src/pacers/Pacer.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,WAAW,KAAK;IAC5B,6EAA6E;IAC7E,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,KAAK,IAAI,OAAO,CAAC,UAAU,CAAC,CAAC;CAC9B"}

package/dist/pacers/Pacer.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=Pacer.js.map

package/dist/pacers/Pacer.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Pacer.js","sourceRoot":"","sources":["../../src/pacers/Pacer.ts"],"names":[],"mappings":""}

package/dist/pacers/PacerComposite.d.ts

@@ -1,14 +0,0 @@
-import type Pacer from "./Pacer";
-/**
- * A Pacer which runs all sub-pacers and chooses the largest delay.
- */
-export default class PacerComposite implements Pacer {
-    private _pacers;
-    readonly name = "";
-    constructor(_pacers: Pacer[]);
-    touch(): Promise<{
-        reason: string;
-        delayMs: number;
-    }>;
-}
-//# sourceMappingURL=PacerComposite.d.ts.map

package/dist/pacers/PacerComposite.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"PacerComposite.d.ts","sourceRoot":"","sources":["../../src/pacers/PacerComposite.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AAEjC;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,cAAe,YAAW,KAAK;IAGtC,OAAO,CAAC,OAAO;IAF3B,QAAQ,CAAC,IAAI,MAAM;gBAEC,OAAO,EAAE,KAAK,EAAE;IAE9B,KAAK;;;;CAiBZ"}

package/dist/pacers/PacerComposite.js

@@ -1,32 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const maxBy_1 = __importDefault(require("lodash/maxBy"));
-/**
- * A Pacer which runs all sub-pacers and chooses the largest delay.
- */
-class PacerComposite {
-    constructor(_pacers) {
-        this._pacers = _pacers;
-        this.name = "";
-    }
-    async touch() {
-        const delays = await Promise["all"](this._pacers.map(async (pacer) => ({
-            pacer,
-            delay: await pacer.touch(),
-        })));
-        const pair = (0, maxBy_1.default)(delays, ({ delay }) => delay.delayMs);
-        return pair
-            ? {
-                ...pair.delay,
-                reason: pair.pacer.name
-                    ? `${pair.pacer.constructor.name} ${pair.pacer.name}\n${pair.delay.reason}`
-                    : pair.delay.reason,
-            }
-            : { delayMs: 0, reason: "no pacers" };
-    }
-}
-exports.default = PacerComposite;
-//# sourceMappingURL=PacerComposite.js.map

package/dist/pacers/PacerComposite.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"PacerComposite.js","sourceRoot":"","sources":["../../src/pacers/PacerComposite.ts"],"names":[],"mappings":";;;;;AAAA,yDAAiC;AAGjC;;GAEG;AACH,MAAqB,cAAc;IAGjC,YAAoB,OAAgB;QAAhB,YAAO,GAAP,OAAO,CAAS;QAF3B,SAAI,GAAG,EAAE,CAAC;IAEoB,CAAC;IAExC,KAAK,CAAC,KAAK;QACT,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,CACjC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;YACjC,KAAK;YACL,KAAK,EAAE,MAAM,KAAK,CAAC,KAAK,EAAE;SAC3B,CAAC,CAAC,CACJ,CAAC;QACF,MAAM,IAAI,GAAG,IAAA,eAAK,EAAC,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACzD,OAAO,IAAI;YACT,CAAC,CAAC;gBACE,GAAG,IAAI,CAAC,KAAK;gBACb,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI;oBACrB,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;oBAC3E,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM;aACtB;YACH,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;IAC1C,CAAC;CACF;AAtBD,iCAsBC"}

package/dist/pacers/PacerQPS.d.ts

@@ -1,53 +0,0 @@
-import type { PacerDelay } from "./Pacer";
-import type Pacer from "./Pacer";
-export interface PacerQPSBackend {
-    /** Resource key which this backend is operating on. */
-    readonly key: string;
-    /**
-     * Maintains the array of numbers somewhere in memory (time-value pairs),
-     * inserts a new time-value pair to the end of this list, and removes all the
-     * entries which are earlier than `minTime`. Returns the size of the resulting
-     * array and some central tendency statistics about its values.
-     */
-    push(props: {
-        time: number;
-        minTime: number;
-        value: number;
-        minCountForCentralTendency: number;
-    }): Promise<{
-        count: number;
-        sum: number;
-        avg: number;
-        median: number;
-    }>;
-}
-export interface PacerQPSOptions {
-    /** The maximum QPS allowed within the rolling window. */
-    qps: number;
-    /** The length of the rolling windows in milliseconds. */
-    windowSec?: number;
-    /** Decrease the delay if the number of requests in the window has dropped
-     * below `decreaseThreshold` portion of the limit. */
-    decreaseThreshold?: number;
-}
-/**
- * Implements a very simple heuristic:
- * - increase the delay if we're above the QPS within the rolling window;
- * - decrease the delay if we're below the desired QPS.
- *
- * Each worker keeps (and grows/shrinks) its delay individually; this way, we
- * don't need to elect, who's the "source of truth" for the delay.
- *
- * Backend is a concrete (and minimal) implementation of the storage logic for
- * the pacing algorithm.
- */
-export default class PacerQPS implements Pacer {
-    private _options;
-    private _backend;
-    private _isFirstTouch;
-    private _delay;
-    constructor(_options: PacerQPSOptions, _backend: PacerQPSBackend);
-    get name(): string;
-    touch(): Promise<PacerDelay>;
-}
-//# sourceMappingURL=PacerQPS.d.ts.map

package/dist/pacers/PacerQPS.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"PacerQPS.d.ts","sourceRoot":"","sources":["../../src/pacers/PacerQPS.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAC1C,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AA4BjC,MAAM,WAAW,eAAe;IAC9B,uDAAuD;IACvD,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,IAAI,CAAC,KAAK,EAAE;QACV,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,KAAK,EAAE,MAAM,CAAC;QACd,0BAA0B,EAAE,MAAM,CAAC;KACpC,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAC1E;AAED,MAAM,WAAW,eAAe;IAC9B,yDAAyD;IACzD,GAAG,EAAE,MAAM,CAAC;IACZ,yDAAyD;IACzD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;yDACqD;IACrD,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,OAAO,OAAO,QAAS,YAAW,KAAK;IAK1C,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,QAAQ;IALlB,OAAO,CAAC,aAAa,CAAQ;IAC7B,OAAO,CAAC,MAAM,CAAK;gBAGT,QAAQ,EAAE,eAAe,EACzB,QAAQ,EAAE,eAAe;IAGnC,IAAI,IAAI,WAEP;IAEK,KAAK,IAAI,OAAO,CAAC,UAAU,CAAC;CAgEnC"}

package/dist/pacers/PacerQPS.js

@@ -1,105 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const random_1 = __importDefault(require("lodash/random"));
-/** Start decreasing the delay (and thus speeding up requests) only when we have
- * less requests in the moving window than allowed by the desired QPS multiplied
- * by this factor. I.e. we don't speed up immediately when we're slow; we wait
- * until we're SLIGHTLY below the limits. */
-const DEFAULT_DECREASE_THRESHOLD = 0.75;
-/** Default moving window length. */
-const DEFAULT_WINDOW_SEC = 30;
-/** Below how many samples do we stop relying on samples to recalculate the
- * current fleet's average delay and instead keep using the previously
- * calculated (and saved) value for the delay. E.g. it doesn't make much sense
- * to rely on an average of 3-4 samples to calculate the average delay, it makes
- * sense to wait for more samples to come. */
-const MIN_COUNT_FOR_CENTRAL_TENDENCY = 10;
-/** The value here is multiplied by the fleet average to get the delay
- * increment/decrement step. It basically determines, in how many increments
- * would a "cold started" worker reach the current fleet's average delay. Or, in
- * how many steps would it reach delay=0 situation from the current fleet's
- * average if needed.  */
-const DELAY_AVG_TO_STEP_FACTOR = 0.02;
-/** Delay increments are jittered by +/- this proportion. */
-const DELAY_STEP_JITTER = 0.1;
-/**
- * Implements a very simple heuristic:
- * - increase the delay if we're above the QPS within the rolling window;
- * - decrease the delay if we're below the desired QPS.
- *
- * Each worker keeps (and grows/shrinks) its delay individually; this way, we
- * don't need to elect, who's the "source of truth" for the delay.
- *
- * Backend is a concrete (and minimal) implementation of the storage logic for
- * the pacing algorithm.
- */
-class PacerQPS {
-    constructor(_options, _backend) {
-        this._options = _options;
-        this._backend = _backend;
-        this._isFirstTouch = true;
-        this._delay = 0;
-    }
-    get name() {
-        return this._backend.key;
-    }
-    async touch() {
-        var _a, _b;
-        const windowSec = (_a = this._options.windowSec) !== null && _a !== void 0 ? _a : DEFAULT_WINDOW_SEC;
-        const limit = Math.round(windowSec * this._options.qps);
-        const decreaseThreshold = (_b = this._options.decreaseThreshold) !== null && _b !== void 0 ? _b : DEFAULT_DECREASE_THRESHOLD;
-        const time = Date.now();
-        const delayPushed = this._delay;
-        const { count, sum, avg, median } = await this._backend.push({
-            time,
-            minTime: time - windowSec * 1000,
-            value: this._delay,
-            minCountForCentralTendency: MIN_COUNT_FOR_CENTRAL_TENDENCY,
-        });
-        const sumDivCount = count ? sum / count : 0;
-        // "Cold start": start with the fleet average delay.
-        if (this._isFirstTouch && this._delay === 0) {
-            this._delay = Math.round(avg);
-            this._isFirstTouch = false;
-        }
-        // If we imagine there is only 1 worker in the fleet, what would be its
-        // delay increment/decrement step. We use this number in a fallback
-        // situation, when we don't know much about the entire fleet average delay
-        // yet, or when this delay is too small to count on.
-        const singleWorkerDelayStepMs = Math.round(((windowSec * 1000) / limit) * DELAY_AVG_TO_STEP_FACTOR);
-        // Considering that there are multiple workers running, and that the current
-        // average fleet's delay is representative, what would be a delay increment
-        // to reach from delay=0 to that fleet's average delay.
-        const multiWorkerDelayStepMs = Math.round(avg *
-            DELAY_AVG_TO_STEP_FACTOR *
-            (0, random_1.default)(1 - DELAY_STEP_JITTER, 1 + DELAY_STEP_JITTER, true));
-        // If average fleet delay is not representative yet, we fallback to a
-        // single-worker delay increment.
-        const delayStepMs = multiWorkerDelayStepMs || singleWorkerDelayStepMs || 1;
-        if (count > limit) {
-            // Increase the delay if the limit is reached. There is no "max delay":
-            // imagine we have 10 QPS limit and 10000 users; it's obvious that in this
-            // case, the delay between requests per a single user will be gigantic.
-            this._delay += delayStepMs;
-        }
-        else if (count < limit * decreaseThreshold) {
-            // Decrease the delay if we're significantly under the limit.
-            this._delay = Math.max(0, this._delay - delayStepMs);
-        }
-        return {
-            delayMs: this._delay,
-            reason: [
-                `count=${count} per ${windowSec}s (limit=${limit})`,
-                `delay=${this._delay} step=${delayStepMs} delayPushed=${delayPushed}`,
-                `median=${Math.round(median)}`,
-                `sum/count=${Math.round(sumDivCount)}`,
-                `avg=${Math.round(avg)}`,
-            ].join("\n"),
-        };
-    }
-}
-exports.default = PacerQPS;
-//# sourceMappingURL=PacerQPS.js.map

package/dist/pacers/PacerQPS.js.map

@@ -1 +0,0 @@
-{"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/classes/PacerComposite.md

@@ -1,66 +0,0 @@
-[@clickup/rest-client](../README.md) / [Exports](../modules.md) / PacerComposite
-
-# Class: PacerComposite
-
-A Pacer which runs all sub-pacers and chooses the largest delay.
-
-## Implements
-
-- [`Pacer`](../interfaces/Pacer.md)
-
-## Constructors
-
-### constructor
-
-• **new PacerComposite**(`_pacers`): [`PacerComposite`](PacerComposite.md)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `_pacers` | [`Pacer`](../interfaces/Pacer.md)[] |
-
-#### Returns
-
-[`PacerComposite`](PacerComposite.md)
-
-#### Defined in
-
-[src/pacers/PacerComposite.ts:10](https://github.com/clickup/rest-client/blob/master/src/pacers/PacerComposite.ts#L10)
-
-## Properties
-
-### name
-
-• `Readonly` **name**: ``""``
-
-Human readable name of the pacer, used when composing multiple pacers.
-
-#### Implementation of
-
-[Pacer](../interfaces/Pacer.md).[name](../interfaces/Pacer.md#name)
-
-#### Defined in
-
-[src/pacers/PacerComposite.ts:8](https://github.com/clickup/rest-client/blob/master/src/pacers/PacerComposite.ts#L8)
-
-## Methods
-
-### touch
-
-▸ **touch**(): `Promise`\<\{ `delayMs`: `number` ; `reason`: `string`  }\>
-
-Signals that we're about to send a request. Returns the delay we need to
-wait for before actually sending.
-
-#### Returns
-
-`Promise`\<\{ `delayMs`: `number` ; `reason`: `string`  }\>
-
-#### Implementation of
-
-[Pacer](../interfaces/Pacer.md).[touch](../interfaces/Pacer.md#touch)
-
-#### Defined in
-
-[src/pacers/PacerComposite.ts:12](https://github.com/clickup/rest-client/blob/master/src/pacers/PacerComposite.ts#L12)

package/docs/classes/PacerQPS.md

@@ -1,79 +0,0 @@
-[@clickup/rest-client](../README.md) / [Exports](../modules.md) / PacerQPS
-
-# Class: PacerQPS
-
-Implements a very simple heuristic:
-- increase the delay if we're above the QPS within the rolling window;
-- decrease the delay if we're below the desired QPS.
-
-Each worker keeps (and grows/shrinks) its delay individually; this way, we
-don't need to elect, who's the "source of truth" for the delay.
-
-Backend is a concrete (and minimal) implementation of the storage logic for
-the pacing algorithm.
-
-## Implements
-
-- [`Pacer`](../interfaces/Pacer.md)
-
-## Constructors
-
-### constructor
-
-• **new PacerQPS**(`_options`, `_backend`): [`PacerQPS`](PacerQPS.md)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `_options` | [`PacerQPSOptions`](../interfaces/PacerQPSOptions.md) |
-| `_backend` | [`PacerQPSBackend`](../interfaces/PacerQPSBackend.md) |
-
-#### Returns
-
-[`PacerQPS`](PacerQPS.md)
-
-#### Defined in
-
-[src/pacers/PacerQPS.ts:74](https://github.com/clickup/rest-client/blob/master/src/pacers/PacerQPS.ts#L74)
-
-## Accessors
-
-### name
-
-• `get` **name**(): `string`
-
-Human readable name of the pacer, used when composing multiple pacers.
-
-#### Returns
-
-`string`
-
-#### Implementation of
-
-[Pacer](../interfaces/Pacer.md).[name](../interfaces/Pacer.md#name)
-
-#### Defined in
-
-[src/pacers/PacerQPS.ts:79](https://github.com/clickup/rest-client/blob/master/src/pacers/PacerQPS.ts#L79)
-
-## Methods
-
-### touch
-
-▸ **touch**(): `Promise`\<[`PacerDelay`](../interfaces/PacerDelay.md)\>
-
-Signals that we're about to send a request. Returns the delay we need to
-wait for before actually sending.
-
-#### Returns
-
-`Promise`\<[`PacerDelay`](../interfaces/PacerDelay.md)\>
-
-#### Implementation of
-
-[Pacer](../interfaces/Pacer.md).[touch](../interfaces/Pacer.md#touch)
-
-#### Defined in
-
-[src/pacers/PacerQPS.ts:83](https://github.com/clickup/rest-client/blob/master/src/pacers/PacerQPS.ts#L83)

package/docs/interfaces/PacerDelay.md

@@ -1,25 +0,0 @@
-[@clickup/rest-client](../README.md) / [Exports](../modules.md) / PacerDelay
-
-# Interface: PacerDelay
-
-A result of some Pacer work.
-
-## Properties
-
-### delayMs
-
-• **delayMs**: `number`
-
-#### Defined in
-
-[src/pacers/Pacer.ts:5](https://github.com/clickup/rest-client/blob/master/src/pacers/Pacer.ts#L5)
-
-___
-
-### reason
-
-• **reason**: `string`
-
-#### Defined in
-
-[src/pacers/Pacer.ts:6](https://github.com/clickup/rest-client/blob/master/src/pacers/Pacer.ts#L6)

package/docs/interfaces/PacerQPSBackend.md

@@ -1,44 +0,0 @@
-[@clickup/rest-client](../README.md) / [Exports](../modules.md) / PacerQPSBackend
-
-# Interface: PacerQPSBackend
-
-## Properties
-
-### key
-
-• `Readonly` **key**: `string`
-
-Resource key which this backend is operating on.
-
-#### Defined in
-
-[src/pacers/PacerQPS.ts:33](https://github.com/clickup/rest-client/blob/master/src/pacers/PacerQPS.ts#L33)
-
-## Methods
-
-### push
-
-▸ **push**(`props`): `Promise`\<\{ `count`: `number` ; `sum`: `number` ; `avg`: `number` ; `median`: `number`  }\>
-
-Maintains the array of numbers somewhere in memory (time-value pairs),
-inserts a new time-value pair to the end of this list, and removes all the
-entries which are earlier than `minTime`. Returns the size of the resulting
-array and some central tendency statistics about its values.
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `props` | `Object` |
-| `props.time` | `number` |
-| `props.minTime` | `number` |
-| `props.value` | `number` |
-| `props.minCountForCentralTendency` | `number` |
-
-#### Returns
-
-`Promise`\<\{ `count`: `number` ; `sum`: `number` ; `avg`: `number` ; `median`: `number`  }\>
-
-#### Defined in
-
-[src/pacers/PacerQPS.ts:41](https://github.com/clickup/rest-client/blob/master/src/pacers/PacerQPS.ts#L41)

package/docs/interfaces/PacerQPSOptions.md

@@ -1,40 +0,0 @@
-[@clickup/rest-client](../README.md) / [Exports](../modules.md) / PacerQPSOptions
-
-# Interface: PacerQPSOptions
-
-## Properties
-
-### qps
-
-• **qps**: `number`
-
-The maximum QPS allowed within the rolling window.
-
-#### Defined in
-
-[src/pacers/PacerQPS.ts:51](https://github.com/clickup/rest-client/blob/master/src/pacers/PacerQPS.ts#L51)
-
-___
-
-### windowSec
-
-• `Optional` **windowSec**: `number`
-
-The length of the rolling windows in milliseconds.
-
-#### Defined in
-
-[src/pacers/PacerQPS.ts:53](https://github.com/clickup/rest-client/blob/master/src/pacers/PacerQPS.ts#L53)
-
-___
-
-### decreaseThreshold
-
-• `Optional` **decreaseThreshold**: `number`
-
-Decrease the delay if the number of requests in the window has dropped
-below `decreaseThreshold` portion of the limit.
-
-#### Defined in
-
-[src/pacers/PacerQPS.ts:56](https://github.com/clickup/rest-client/blob/master/src/pacers/PacerQPS.ts#L56)