@clickup/rest-client 2.10.294 → 2.10.296

package/src/RestClient.ts

@@ -54,7 +54,7 @@ export default class RestClient {
    */
   withMiddleware(
     middleware: RestOptions["middlewares"][0],
-    method: "unshift" | "push" = "push"
+    method: "unshift" | "push" = "push",
   ) {
     const clone = new RestClient(this._options);
     clone._options.middlewares[method](middleware);
@@ -156,7 +156,7 @@ export default class RestClient {
    */
   withOAuth1(
     consumer: { consumerKey: string; consumerSecret: string },
-    token: TokenGetter<{ token: string; tokenSecret: string }>
+    token: TokenGetter<{ token: string; tokenSecret: string }>,
   ) {
     const oauth = new OAuth1({
       consumer: { key: consumer.consumerKey, secret: consumer.consumerSecret },
@@ -176,7 +176,7 @@ export default class RestClient {
           oauth.authorize(requestData, {
             key: tokenData.token,
             secret: tokenData.tokenSecret,
-          })
+          }),
         );
         for (const [name, value] of Object.entries(addHeaders)) {
           req.headers.set(name, value);
@@ -196,7 +196,7 @@ export default class RestClient {
         const unencodedHeader = name + ":" + password;
         req.headers.set(
           "Authorization",
-          "Basic " + Buffer.from(unencodedHeader).toString("base64")
+          "Basic " + Buffer.from(unencodedHeader).toString("base64"),
         );
         return next(req);
       });
@@ -211,7 +211,7 @@ export default class RestClient {
   get(
     path: string,
     args: Partial<Record<string, string | number | string[]>> = {},
-    accept: string = "application/json"
+    accept: string = "application/json",
   ) {
     return this._noBodyRequest(path, args, "GET", accept);
   }
@@ -224,7 +224,7 @@ export default class RestClient {
     body: string | Buffer | NodeJS.ReadableStream,
     contentType: string,
     method: "POST" | "PUT" | "PATCH" = "POST",
-    accept?: string
+    accept?: string,
   ) {
     const origShape = simpleShape(path);
     return new RestRequest(
@@ -236,7 +236,7 @@ export default class RestClient {
         "Content-Type": contentType,
       }),
       body,
-      origShape
+      origShape,
     );
   }
 
@@ -247,7 +247,7 @@ export default class RestClient {
     path: string,
     body: any,
     method: "POST" | "PUT" | "PATCH" | "DELETE" = "POST",
-    accept: string = "application/json"
+    accept: string = "application/json",
   ) {
     const origShape = simpleShape(path, body);
     [path, body] = substituteParams(path, body);
@@ -260,7 +260,7 @@ export default class RestClient {
         "Content-Type": "application/json",
       }),
       JSON.stringify(body),
-      origShape
+      origShape,
     );
   }
 
@@ -271,7 +271,7 @@ export default class RestClient {
     path: string,
     body: Partial<Record<string, string>> | string,
     method: "POST" | "PUT" | "PATCH" = "POST",
-    accept: string = "application/json"
+    accept: string = "application/json",
   ) {
     const origShape = simpleShape(path, body);
     [path, body] = substituteParams(path, body);
@@ -286,9 +286,9 @@ export default class RestClient {
       typeof body === "string"
         ? body
         : new URLSearchParams(
-            omitBy(body, isUndefined) as Record<string, string>
+            omitBy(body, isUndefined) as Record<string, string>,
           ).toString(),
-      origShape
+      origShape,
     );
   }
 
@@ -298,7 +298,7 @@ export default class RestClient {
   writeDelete(
     path: string,
     args: Partial<Record<string, string>> = {},
-    accept: string = "application/json"
+    accept: string = "application/json",
   ) {
     return this._noBodyRequest(path, args, "DELETE", accept);
   }
@@ -355,14 +355,14 @@ export default class RestClient {
     mimeType: string,
     stream: AsyncIterable<Buffer>,
     method: "POST" | "PUT" = "POST",
-    chunkSize: number
+    chunkSize: number,
   ) {
     return new RestRangeUploader(
       this,
       chunkSize,
       method,
       path,
-      mimeType
+      mimeType,
     ).upload(stream);
   }
 
@@ -381,7 +381,7 @@ export default class RestClient {
       "",
       new Headers({ "Content-Type": "application/json" }),
       JSON.stringify({ variables, query }), // variables first - for truncation in logs,
-      origShape
+      origShape,
     );
   }
 
@@ -392,7 +392,7 @@ export default class RestClient {
     path: string,
     args: Partial<Record<string, string | number | string[]>> = {},
     method: "GET" | "DELETE",
-    accept: string = "application/json"
+    accept: string = "application/json",
   ) {
     const origShape = simpleShape(path, args);
     [path, args] = substituteParams(path, args);
@@ -418,7 +418,7 @@ export default class RestClient {
       path,
       new Headers({ Accept: accept }),
       "",
-      origShape
+      origShape,
     );
   }
 }
@@ -431,7 +431,7 @@ export default class RestClient {
  */
 export async function tokenRetryStrategy<TData>(
   token: TokenGetter<TData>,
-  body: (tokenData: TData) => Promise<RestResponse>
+  body: (tokenData: TData) => Promise<RestResponse>,
 ) {
   let tokenData = await token(null);
   try {

package/src/RestOptions.ts

@@ -27,7 +27,7 @@ export interface RestLogEvent {
 export interface Middleware {
   (
     req: RestRequest,
-    next: (req: RestRequest) => Promise<RestResponse>
+    next: (req: RestRequest) => Promise<RestResponse>,
   ): Promise<RestResponse>;
 }
 
@@ -140,7 +140,7 @@ export default interface RestOptions {
    * isRateLimitError and isRetriableError handlers set up, and they return
    * contradictory information; then isRateLimitError wins. */
   isRateLimitError: (
-    res: RestResponse
+    res: RestResponse,
   ) => "SOMETHING_ELSE" | "RATE_LIMIT" | "BEST_EFFORT" | number;
   /** 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. */
@@ -154,7 +154,7 @@ export default interface RestOptions {
    * retry will happen in not less than this number of milliseconds. */
   isRetriableError: (
     res: RestResponse,
-    _error: any
+    _error: any,
   ) => "NEVER_RETRY" | "RETRY" | "BEST_EFFORT" | number;
 }
 

package/src/RestRequest.ts

@@ -33,7 +33,7 @@ export default class RestRequest<TAssertShape = any> {
     public url: string,
     public readonly headers: Headers,
     public readonly body: string | Buffer | NodeJS.ReadableStream,
-    public readonly shape?: string
+    public readonly shape?: string,
   ) {
     this.options = { ...options };
   }
@@ -120,7 +120,7 @@ export default class RestRequest<TAssertShape = any> {
       // By passing Number.MAX_SAFE_INTEGER to stream(), we ensure that the
       // entire data will be preloaded, or the loading will fail due to
       // throwIfResIsBigger limitation, whichever will happen faster.
-      Number.MAX_SAFE_INTEGER
+      Number.MAX_SAFE_INTEGER,
     );
     await stream.close();
     return stream.res;
@@ -182,7 +182,7 @@ export default class RestRequest<TAssertShape = any> {
               await reader?.close();
               throw e;
             }
-          }
+          },
         );
 
         // The only place where we return the response. Otherwise we retry or
@@ -215,7 +215,7 @@ export default class RestRequest<TAssertShape = any> {
           error,
           this.options,
           res,
-          retryDelayMs
+          retryDelayMs,
         );
         if (newRetryDelay === "no_retry") {
           throw error;
@@ -228,7 +228,7 @@ export default class RestRequest<TAssertShape = any> {
       retryDelayMs *= random(
         1 - this.options.retryDelayJitter,
         1 + this.options.retryDelayJitter,
-        true
+        true,
       );
       await this.options.heartbeater.delay(retryDelayMs);
 
@@ -279,7 +279,7 @@ export default class RestRequest<TAssertShape = any> {
       const isInternal = range !== "unicast";
       if (isInternal) {
         throw new RestError(
-          `Domain ${hostname} resolves to a non-public (${range}) IP address ${addr.address}`
+          `Domain ${hostname} resolves to a non-public (${range}) IP address ${addr.address}`,
         );
       }
 
@@ -333,7 +333,7 @@ export default class RestRequest<TAssertShape = any> {
       onTimeout: (reader) => {
         throw new RestTimeoutError(
           `Timed out while reading response body (${this.options.timeoutMs} ms)`,
-          this._createRestResponse(reader)!
+          this._createRestResponse(reader)!,
         );
       },
       onAfterRead: (reader) => {
@@ -343,7 +343,7 @@ export default class RestRequest<TAssertShape = any> {
         ) {
           throw new RestContentSizeOverLimitError(
             `Content size is over limit of ${this.options.throwIfResIsBigger} characters`,
-            this._createRestResponse(reader)!
+            this._createRestResponse(reader)!,
           );
         }
       },
@@ -361,7 +361,7 @@ export default class RestRequest<TAssertShape = any> {
       reader.status,
       reader.headers,
       reader.textFetched,
-      reader.textIsPartial
+      reader.textIsPartial,
     );
   }
 
@@ -405,7 +405,7 @@ export default class RestRequest<TAssertShape = any> {
             inspectPossibleJSON(
               event.res.headers,
               event.res.text,
-              MAX_DEBUG_LEN
+              MAX_DEBUG_LEN,
             );
         }
       } else if (event.exception) {
@@ -430,7 +430,7 @@ export default class RestRequest<TAssertShape = any> {
 async function runMiddlewares(
   req: RestRequest,
   middlewares: RestOptions["middlewares"],
-  last: (req: RestRequest) => Promise<RestResponse>
+  last: (req: RestRequest) => Promise<RestResponse>,
 ): Promise<RestResponse> {
   if (middlewares.length > 0) {
     const [head, ...tail] = middlewares;

package/src/RestResponse.ts

@@ -21,7 +21,7 @@ export default class RestResponse {
     public readonly status: number,
     public readonly headers: Headers,
     public readonly text: string,
-    public readonly textIsPartial: boolean
+    public readonly textIsPartial: boolean,
   ) {}
 
   /**

package/src/RestStream.ts

@@ -18,7 +18,7 @@ export default class RestStream {
     public readonly res: RestResponse,
     readerIterable: {
       [Symbol.asyncIterator]: () => AsyncGenerator<string, void>;
-    }
+    },
   ) {
     this._generator = readerIterable[Symbol.asyncIterator]();
   }

package/src/errors/RestRateLimitError.ts

@@ -2,7 +2,11 @@ import type RestResponse from "../RestResponse";
 import RestResponseError from "./RestResponseError";
 
 export default class RestRateLimitError extends RestResponseError {
-  constructor(message: string, public delayMs: number, res: RestResponse) {
+  constructor(
+    message: string,
+    public delayMs: number,
+    res: RestResponse,
+  ) {
     super(message, res);
   }
 }

package/src/errors/RestResponseError.ts

@@ -21,8 +21,8 @@ export default class RestResponseError extends RestError {
       `HTTP ${res.status}: ` +
         (message ? `${message}: ` : "") +
         prependNewlineIfMultiline(
-          inspectPossibleJSON(res.headers, res.text, RESPONSE_MAX_LEN_IN_ERROR)
-        )
+          inspectPossibleJSON(res.headers, res.text, RESPONSE_MAX_LEN_IN_ERROR),
+        ),
     );
     Object.defineProperty(this, "res", { value: res, enumerable: false }); // hidden from inspect()
     const url = new URL(res.req.url);
@@ -34,7 +34,7 @@ export default class RestResponseError extends RestError {
     this.requestBody = inspectPossibleJSON(
       res.headers,
       res.req.body,
-      RESPONSE_MAX_LEN_IN_ERROR
+      RESPONSE_MAX_LEN_IN_ERROR,
     );
     this.responseHeaders = [...res.headers]
       .map(([name, value]) => `${name}: ${value}`)

package/src/errors/RestRetriableError.ts

@@ -2,7 +2,11 @@ import type RestResponse from "../RestResponse";
 import RestResponseError from "./RestResponseError";
 
 export default class RestRetriableError extends RestResponseError {
-  constructor(message: string, public delayMs: number, res: RestResponse) {
+  constructor(
+    message: string,
+    public delayMs: number,
+    res: RestResponse,
+  ) {
     super(message, res);
   }
 }

package/src/errors/RestTokenInvalidError.ts

@@ -2,7 +2,10 @@ import type RestResponse from "../RestResponse";
 import RestResponseError from "./RestResponseError";
 
 export default class RestTokenInvalidError extends RestResponseError {
-  constructor(public readonly humanReason: string, res: RestResponse) {
+  constructor(
+    public readonly humanReason: string,
+    res: RestResponse,
+  ) {
     super(humanReason, res);
   }
 }

package/src/helpers/depaginate.ts

@@ -8,8 +8,8 @@
  */
 export default async function* depaginate<TItem, TCursor = string>(
   readFunc: (
-    cursor: TCursor | undefined
-  ) => Promise<readonly [TItem[], TCursor | null | undefined]>
+    cursor: TCursor | undefined,
+  ) => Promise<readonly [TItem[], TCursor | null | undefined]>,
 ): AsyncGenerator<TItem, void, undefined> {
   let prevCursor: TCursor | null | undefined = undefined;
   let cursor: TCursor | null | undefined = undefined;
@@ -28,7 +28,7 @@ export default async function* depaginate<TItem, TCursor = string>(
           JSON.stringify(prevCursor) +
           ", cursor=" +
           JSON.stringify(cursor) +
-          " (they must differ)"
+          " (they must differ)",
       );
     }
 

package/src/internal/RestFetchReader.ts

@@ -34,7 +34,7 @@ export default class RestFetchReader {
   constructor(
     private _url: string,
     private _reqInit: RequestInit,
-    private _options: RestFetchReaderOptions
+    private _options: RestFetchReaderOptions,
   ) {}
 
   /**
@@ -151,7 +151,7 @@ export default class RestFetchReader {
         new Request(this._url, {
           ...this._reqInit,
           signal: controller.signal as any,
-        })
+        }),
       );
       this._status = res.status;
       this._headers = res.headers;

package/src/internal/RestRangeUploader.ts

@@ -18,7 +18,7 @@ export default class RestRangeUploader {
     private _chunkSize: number,
     private _method: "POST" | "PUT",
     private _path: string,
-    private _mimeType: string
+    private _mimeType: string,
   ) {}
 
   async upload(stream: AsyncIterable<Buffer>) {
@@ -52,7 +52,7 @@ export default class RestRangeUploader {
       .writeRaw(this._path, buf, this._mimeType, this._method, "*/*")
       .setHeader(
         "Content-Range",
-        `bytes ${this._pos}-${this._pos + buf.length - 1}/${totalSize}`
+        `bytes ${this._pos}-${this._pos + buf.length - 1}/${totalSize}`,
       )
       .text();
     this._pos += buf.length;

package/src/internal/calcRetryDelay.ts

@@ -13,7 +13,7 @@ export default function calcRetryDelay(
   error: any,
   options: RestOptions,
   res: RestResponse,
-  retryDelayMs: number
+  retryDelayMs: number,
 ): number | "no_retry" {
   if (
     error instanceof RestRateLimitError ||
@@ -22,7 +22,7 @@ export default function calcRetryDelay(
     // We've already made a decision to retry this error.
     return Math.min(
       options.retryDelayMaxMs,
-      Math.max(retryDelayMs, error.delayMs)
+      Math.max(retryDelayMs, error.delayMs),
     );
   }
 

package/src/internal/inferResBodyEncoding.ts

@@ -17,17 +17,17 @@ export default function inferResBodyEncoding(res: Response): BufferEncoding {
     ? // It's a binary Content-Type.
       "binary"
     : charset && !BUFFER_ENCODINGS.includes(charset)
-    ? // The charset is provided in Content-Type, but unknown by Buffer.
-      "binary"
-    : charset && BUFFER_ENCODINGS.includes(charset)
-    ? // Charset is provided in Content-Type header, and Buffer knows
-      // how to decode it.
-      (charset as BufferEncoding)
-    : // An opinionated choice is made here to always default-decode the
-      // response stream as UTF-8. This is because JSON is by definition a UTF-8
-      // stream, and people often time respond with JSONs forgetting to provide
-      // "; charset=utf-8" part of the Content-Type header (or they forget
-      // Content-Type header at all, or put some wrong value as "text/plain"
-      // there; there is an endless list of mistake variations here).
-      "utf-8";
+      ? // The charset is provided in Content-Type, but unknown by Buffer.
+        "binary"
+      : charset && BUFFER_ENCODINGS.includes(charset)
+        ? // Charset is provided in Content-Type header, and Buffer knows
+          // how to decode it.
+          (charset as BufferEncoding)
+        : // An opinionated choice is made here to always default-decode the
+          // response stream as UTF-8. This is because JSON is by definition a UTF-8
+          // stream, and people often time respond with JSONs forgetting to provide
+          // "; charset=utf-8" part of the Content-Type header (or they forget
+          // Content-Type header at all, or put some wrong value as "text/plain"
+          // there; there is an endless list of mistake variations here).
+          "utf-8";
 }

package/src/internal/inspectPossibleJSON.ts

@@ -5,7 +5,7 @@ import truncate from "lodash/truncate";
 export default function inspectPossibleJSON(
   headers: { get(name: string): string | null },
   text: string | Buffer | NodeJS.ReadableStream,
-  maxOutputLen: number
+  maxOutputLen: number,
 ): string {
   const MAX_LEN_TO_TRY_PARSE = 1024 * 1024;
 
@@ -31,13 +31,13 @@ export default function inspectPossibleJSON(
         // man's approach: of course not all APIs return error/errors fields at
         // all, but it's hard to reorder at any other layer of abstraction.
         reorderObjectProps(json, (k) =>
-          k === "error" || k === "errors" ? "" : k
+          k === "error" || k === "errors" ? "" : k,
         );
       }
 
       return ellipsis(
         inspect(json, { depth: 20, compact: true }),
-        maxOutputLen
+        maxOutputLen,
       );
     } catch (e: any) {
       return ellipsis(text, maxOutputLen);
@@ -53,7 +53,7 @@ export default function inspectPossibleJSON(
  */
 function reorderObjectProps(
   obj: Record<string, any>,
-  ranker: (k: string, v: any) => string | number
+  ranker: (k: string, v: any) => string | number,
 ) {
   const entries = Object.entries(obj);
   for (const k in obj) {
@@ -62,7 +62,7 @@ function reorderObjectProps(
 
   Object.assign(
     obj,
-    Object.fromEntries(sortBy(entries, ([k, v]) => ranker(k, v)))
+    Object.fromEntries(sortBy(entries, ([k, v]) => ranker(k, v))),
   );
 }
 

package/src/internal/substituteParams.ts

@@ -5,7 +5,7 @@
  */
 export default function substituteParams<TBody>(
   url: string,
-  body: TBody
+  body: TBody,
 ): [string, TBody] {
   if (!body || typeof body !== "object") {
     return [url, body];

package/src/internal/throwIfErrorResponse.ts

@@ -16,7 +16,7 @@ const STATUS_TOO_MANY_REQUESTS = 429;
  */
 export default function throwIfErrorResponse(
   options: RestOptions,
-  res: RestResponse
+  res: RestResponse,
 ) {
   const isSuccessResponse = options.isSuccessResponse(res);
   if (isSuccessResponse === "SUCCESS") {
@@ -29,7 +29,7 @@ export default function throwIfErrorResponse(
       throw new RestRateLimitError(
         `isRateLimitError() returned ${rateLimitDelayMs}`,
         0,
-        res
+        res,
       );
     case "BEST_EFFORT":
       if (res.status === STATUS_TOO_MANY_REQUESTS) {
@@ -37,7 +37,7 @@ export default function throwIfErrorResponse(
         throw new RestRateLimitError(
           `Rate limited by HTTP status ${STATUS_TOO_MANY_REQUESTS}`,
           parseInt(retryAfterHeader) || 0,
-          res
+          res,
         );
       }
 
@@ -48,7 +48,7 @@ export default function throwIfErrorResponse(
       throw new RestRateLimitError(
         `isRateLimitError() returned retry delay ${rateLimitDelayMs} ms`,
         rateLimitDelayMs,
-        res
+        res,
       );
   }
 
@@ -63,7 +63,7 @@ export default function throwIfErrorResponse(
       throw new RestRetriableError(
         `isRetriableError() returned ${retryDelayMs}`,
         0,
-        res
+        res,
       );
     case "BEST_EFFORT":
     case "NEVER_RETRY":
@@ -72,14 +72,14 @@ export default function throwIfErrorResponse(
       throw new RestRetriableError(
         `"isRetriableError() returned retry delay ${retryDelayMs} ms`,
         retryDelayMs,
-        res
+        res,
       );
   }
 
   if (isSuccessResponse === "THROW") {
     throw new RestResponseError(
       `isSuccessResponse() returned ${isSuccessResponse}`,
-      res
+      res,
     );
   }
 

package/src/middlewares/paceRequests.ts

@@ -9,7 +9,7 @@ const MIN_LOG_DELAY_MS = 10;
  * Pacer implementations.
  */
 export default function paceRequests(
-  pacer: Pacer | ((req: RestRequest) => Promise<Pacer | null>) | null
+  pacer: Pacer | ((req: RestRequest) => Promise<Pacer | null>) | null,
 ): Middleware {
   return async (req, next) => {
     if (typeof pacer === "function") {

package/src/pacers/PacerComposite.ts

@@ -14,7 +14,7 @@ export default class PacerComposite implements Pacer {
       this._pacers.map(async (pacer) => ({
         pacer,
         delay: await pacer.touch(),
-      }))
+      })),
     );
     const pair = maxBy(delays, ({ delay }) => delay.delayMs);
     return pair

package/src/pacers/PacerQPS.ts

@@ -73,7 +73,7 @@ export default class PacerQPS implements Pacer {
 
   constructor(
     private _options: PacerQPSOptions,
-    private _backend: PacerQPSBackend
+    private _backend: PacerQPSBackend,
   ) {}
 
   get name() {
@@ -107,7 +107,7 @@ export default class PacerQPS implements Pacer {
     // 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
+      ((windowSec * 1000) / limit) * DELAY_AVG_TO_STEP_FACTOR,
     );
 
     // Considering that there are multiple workers running, and that the current
@@ -116,7 +116,7 @@ export default class PacerQPS implements Pacer {
     const multiWorkerDelayStepMs = Math.round(
       avg *
         DELAY_AVG_TO_STEP_FACTOR *
-        random(1 - DELAY_STEP_JITTER, 1 + DELAY_STEP_JITTER, true)
+        random(1 - DELAY_STEP_JITTER, 1 + DELAY_STEP_JITTER, true),
     );
 
     // If average fleet delay is not representative yet, we fallback to a

package/tsconfig.json

@@ -9,9 +9,8 @@
     "esModuleInterop": true,
     "experimentalDecorators": true,
     "incremental": true,
-    "lib": ["es2019"],
-    "module": "commonjs",
-    "moduleResolution": "node",
+    "lib": ["ES2019"],
+    "module": "Node16",
     "noEmitOnError": true,
     "noErrorTruncation": true,
     "noImplicitOverride": true,
@@ -25,7 +24,7 @@
     "skipLibCheck": true,
     "sourceMap": true,
     "strict": true,
-    "target": "es2019",
+    "target": "ES2019",
     "tsBuildInfoFile": "dist/tsconfig.tsbuildinfo",
     "types": ["node", "jest"]
   }