@clickup/rest-client 2.10.292

package/dist/RestClient.d.ts

@@ -0,0 +1,154 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import type RestOptions from "./RestOptions";
+import RestRequest from "./RestRequest";
+import type RestResponse from "./RestResponse";
+/**
+ * A callback which returns access token, possibly after refreshing it, and also
+ * possibly before a retry on "invalid token" condition. I.e. it can be called
+ * once or twice (the 2nd time after the previous request error, and that error
+ * will be passed as a parameter).
+ */
+export interface TokenGetter<TData = string> {
+    (prevError: Error | null): Promise<TData>;
+}
+/**
+ * RestClient is an immutable object which allows to:
+ * 1. Send remote requests in different formats, in a caller-friendly manner.
+ * 2. Create a new RestClient objects deriving the current set of options and
+ *    adding new ones.
+ */
+export default class RestClient {
+    private readonly _options;
+    constructor(options?: Partial<RestOptions>);
+    /**
+     * Returns a new RestClient with some options updated with the passed ones.
+     */
+    withOptions(options: Partial<RestOptions>): RestClient;
+    /**
+     * Returns a new RestClient with added middleware.
+     */
+    withMiddleware(middleware: RestOptions["middlewares"][0], method?: "unshift" | "push"): RestClient;
+    /**
+     * Returns a new RestClient with the base URL which will be prepended to all
+     * relative paths in get(), writeForm() etc. Allows to defer resolution of
+     * this base URL to the very late per-request moment. The complicated piece
+     * here is that, if we want base URL to be resolved asynchronously, we often
+     * times want to reuse the same RestClient object (to e.g. fetch some part of
+     * the base URL using already authenticated client). And a re-enterable call
+     * appears here which we must protect against in the code below.
+     */
+    withBase(base: string | (() => Promise<string>)): RestClient;
+    /**
+     * Returns a new RestClient with a custom header.
+     */
+    withHeader(name: string, value: string | (() => Promise<string>)): RestClient;
+    /**
+     * Returns a new RestClient with a bearer token authentication workflow.
+     * - RestClient supports interception of options.isTokenInvalid() signal and
+     *   conversion it into RestTokenInvalidError exception.
+     * - If a token() is a lambda with 1 argument, it may be called the 2nd time
+     *   when we get an isTokenInvalid() signal. In this case, the request is
+     *   retried.
+     * - If token() is a lambda with 0 arguments, that means it doesn't want to
+     *   watch for the isTokenInvalid() signal, so there is no sense in retrying
+     *   the request either.
+     *
+     * From the first sight, it looks like options.isTokenInvalid() signal is
+     * coupled to setBearer() auth method only. But it's not true:
+     * isTokenInvalid() makes sense for ALL authentication methods actually (even
+     * for basic auth), and setBearer() is just one of "clients" which implements
+     * refreshing/retries on top of isTokenInvalid().
+     *
+     * Passing the token as lambda allows the caller to implement some complex
+     * logic, e.g.:
+     * - oauth2 tokens refreshing
+     * - marking the token as "revoked" in the database in case the refresh fails
+     * - marking the token as "revoked" after a failed request if refresh-token is
+     *   not supported
+     */
+    withBearer(token: TokenGetter, bearerPrefix?: string): RestClient;
+    /**
+     * Returns a new RestClient with oauth1 authentication workflow.
+     * - In case we get an options.isTokenInvalid() signal, the token() lambda is
+     *   called the 2nd time with the error object, then the request is retries.
+     *   This gives the lambda a chance to recover or update something in the
+     *   database.
+     *
+     * We use a separate and small oauth-1.0a node library here, because the more
+     * popular one (https://www.npmjs.com/package/oauth) doesn't support signing
+     * of arbitrary requests, it can only send its own requests.
+     */
+    withOAuth1(consumer: {
+        consumerKey: string;
+        consumerSecret: string;
+    }, token: TokenGetter<{
+        token: string;
+        tokenSecret: string;
+    }>): RestClient;
+    /**
+     * Returns a new RestClient with basic authorization workflow.
+     */
+    withBasic(token: TokenGetter<{
+        name: string;
+        password: string;
+    }>): RestClient;
+    /**
+     * Sends a plain GET request without body.
+     *
+     * NOTE, all args will be passed through `encodeURIComponent`.
+     */
+    get(path: string, args?: Partial<Record<string, string | number | string[]>>, accept?: string): RestRequest<any>;
+    /**
+     * Writes some raw string, buffer or a stream.
+     */
+    writeRaw(path: string, body: string | Buffer | NodeJS.ReadableStream, contentType: string, method?: "POST" | "PUT" | "PATCH", accept?: string): RestRequest<any>;
+    /**
+     * A shortcut method to write JSON body.
+     */
+    writeJson(path: string, body: any, method?: "POST" | "PUT" | "PATCH" | "DELETE", accept?: string): RestRequest<any>;
+    /**
+     * A shortcut method to write "application/x-www-form-urlencoded" data.
+     */
+    writeForm(path: string, body: Partial<Record<string, string>> | string, method?: "POST" | "PUT" | "PATCH", accept?: string): RestRequest<any>;
+    /**
+     * A shortcut method to write DELETE request.
+     */
+    writeDelete(path: string, args?: Partial<Record<string, string>>, accept?: string): RestRequest<any>;
+    /**
+     * Returns a RestRequest prepared for sending GraphQL operation.
+     * - Expects the response to contain no errors; throws otherwise.
+     * - In case of success, returns just the content of `data` field (this is
+     *   different with writeGraphQLNullable() which returns `data` as a separate
+     *   fields along with `error` and `errors`).
+     */
+    writeGraphQLX(query: string, variables?: any): RestRequest<any>;
+    /**
+     * Same as writeGraphQLX(), but doesn't throw if GraphQL response contains
+     * non-empty `error` or `errors` fields and instead returns the full response.
+     * I.e. allows the caller to process these errors.
+     */
+    writeGraphQLNullable(query: string, variables?: any): RestRequest<{
+        data?: any;
+        error?: any;
+        errors?: any[] | undefined;
+    } | null | undefined>;
+    /**
+     * Performs a series of Content-Range requests with content from a sequence of
+     * Buffers.
+     */
+    rangeUpload(path: string, mimeType: string, stream: AsyncIterable<Buffer>, method: "POST" | "PUT" | undefined, chunkSize: number): Promise<string | null>;
+    private _writeGraphQLImpl;
+    /**
+     * Sends a plain request (with no body, like GET or DELETE).
+     */
+    private _noBodyRequest;
+}
+/**
+ * @ignore
+ * Calls token(null), then runs body() passing the result there. If we get a
+ * RestTokenInvalidError exception, call token() with this error as a parameter
+ * and then passes the response to body() again (kinda retry with a new token).
+ */
+export declare function tokenRetryStrategy<TData>(token: TokenGetter<TData>, body: (tokenData: TData) => Promise<RestResponse>): Promise<RestResponse>;
+//# sourceMappingURL=RestClient.d.ts.map

package/dist/RestClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RestClient.d.ts","sourceRoot":"","sources":["../src/RestClient.ts"],"names":[],"mappings":";;AAQA,OAAO,KAAK,WAAW,MAAM,eAAe,CAAC;AAE7C,OAAO,WAAW,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,YAAY,MAAM,gBAAgB,CAAC;AAE/C;;;;;GAKG;AACH,MAAM,WAAW,WAAW,CAAC,KAAK,GAAG,MAAM;IACzC,CAAC,SAAS,EAAE,KAAK,GAAG,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;CAC3C;AAED;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,UAAU;IAC7B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAc;gBAE3B,OAAO,GAAE,OAAO,CAAC,WAAW,CAAM;IAS9C;;OAEG;IACH,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,WAAW,CAAC;IAOzC;;OAEG;IACH,cAAc,CACZ,UAAU,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,EACzC,MAAM,GAAE,SAAS,GAAG,MAAe;IAOrC;;;;;;;;OAQG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;IA8B/C;;OAEG;IACH,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,CAAC,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;IAOhE;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,UAAU,CAAC,KAAK,EAAE,WAAW,EAAE,YAAY,SAAY;IASvD;;;;;;;;;;OAUG;IACH,UAAU,CACR,QAAQ,EAAE;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,cAAc,EAAE,MAAM,CAAA;KAAE,EACzD,KAAK,EAAE,WAAW,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;IA+B5D;;OAEG;IACH,SAAS,CAAC,KAAK,EAAE,WAAW,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC;IAahE;;;;OAIG;IACH,GAAG,CACD,IAAI,EAAE,MAAM,EACZ,IAAI,GAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,CAAM,EAC9D,MAAM,GAAE,MAA2B;IAKrC;;OAEG;IACH,QAAQ,CACN,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,cAAc,EAC7C,WAAW,EAAE,MAAM,EACnB,MAAM,GAAE,MAAM,GAAG,KAAK,GAAG,OAAgB,EACzC,MAAM,CAAC,EAAE,MAAM;IAgBjB;;OAEG;IACH,SAAS,CACP,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,GAAG,EACT,MAAM,GAAE,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAiB,EACpD,MAAM,GAAE,MAA2B;IAiBrC;;OAEG;IACH,SAAS,CACP,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,MAAM,EAC9C,MAAM,GAAE,MAAM,GAAG,KAAK,GAAG,OAAgB,EACzC,MAAM,GAAE,MAA2B;IAqBrC;;OAEG;IACH,WAAW,CACT,IAAI,EAAE,MAAM,EACZ,IAAI,GAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAM,EAC1C,MAAM,GAAE,MAA2B;IAKrC;;;;;;OAMG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,GAAE,GAAQ;IAyBhD;;;;OAIG;IACH,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,GAAE,GAAQ;eAE1C,GAAG;gBAAU,GAAG;;;IAI7B;;;OAGG;IACG,WAAW,CACf,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,aAAa,CAAC,MAAM,CAAC,EAC7B,MAAM,4BAAyB,EAC/B,SAAS,EAAE,MAAM;IAWnB,OAAO,CAAC,iBAAiB;IAmBzB;;OAEG;IACH,OAAO,CAAC,cAAc;CAiCvB;AAED;;;;;GAKG;AACH,wBAAsB,kBAAkB,CAAC,KAAK,EAC5C,KAAK,EAAE,WAAW,CAAC,KAAK,CAAC,EACzB,IAAI,EAAE,CAAC,SAAS,EAAE,KAAK,KAAK,OAAO,CAAC,YAAY,CAAC,yBAsBlD"}

package/dist/RestClient.js

@@ -0,0 +1,361 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tokenRetryStrategy = void 0;
+const crypto_1 = __importDefault(require("crypto"));
+const isUndefined_1 = __importDefault(require("lodash/isUndefined"));
+const omitBy_1 = __importDefault(require("lodash/omitBy"));
+const node_fetch_1 = require("node-fetch");
+const oauth_1_0a_1 = __importDefault(require("oauth-1.0a"));
+const RestTokenInvalidError_1 = __importDefault(require("./errors/RestTokenInvalidError"));
+const RestRangeUploader_1 = __importDefault(require("./internal/RestRangeUploader"));
+const substituteParams_1 = __importDefault(require("./internal/substituteParams"));
+const RestOptions_1 = require("./RestOptions");
+const RestRequest_1 = __importDefault(require("./RestRequest"));
+/**
+ * RestClient is an immutable object which allows to:
+ * 1. Send remote requests in different formats, in a caller-friendly manner.
+ * 2. Create a new RestClient objects deriving the current set of options and
+ *    adding new ones.
+ */
+class RestClient {
+    constructor(options = {}) {
+        this._options = {
+            ...RestOptions_1.DEFAULT_OPTIONS,
+            ...(0, omitBy_1.default)(options, isUndefined_1.default),
+            ...(options.keepAlive ? { keepAlive: { ...options.keepAlive } } : {}),
+            ...(options.middlewares ? { middlewares: [...options.middlewares] } : {}),
+        };
+    }
+    /**
+     * Returns a new RestClient with some options updated with the passed ones.
+     */
+    withOptions(options) {
+        return new RestClient({
+            ...this._options,
+            ...(0, omitBy_1.default)(options, isUndefined_1.default),
+        });
+    }
+    /**
+     * Returns a new RestClient with added middleware.
+     */
+    withMiddleware(middleware, method = "push") {
+        const clone = new RestClient(this._options);
+        clone._options.middlewares[method](middleware);
+        return clone;
+    }
+    /**
+     * Returns a new RestClient with the base URL which will be prepended to all
+     * relative paths in get(), writeForm() etc. Allows to defer resolution of
+     * this base URL to the very late per-request moment. The complicated piece
+     * here is that, if we want base URL to be resolved asynchronously, we often
+     * times want to reuse the same RestClient object (to e.g. fetch some part of
+     * the base URL using already authenticated client). And a re-enterable call
+     * appears here which we must protect against in the code below.
+     */
+    withBase(base) {
+        return this.withMiddleware(async function withBaseMiddleware(req, next) {
+            // If URL is already absolute, we don't even need to call base() lambda
+            // to resolve it. Return early.
+            if (req.url.match(/^\w+:\/\//)) {
+                return next(req);
+            }
+            // Re-enterable call detected, e.g. base() lambda issued a request
+            // through the same RestClient. We must just skip setting the base.
+            if (base === "") {
+                return next(req);
+            }
+            if (typeof base !== "string") {
+                const baseGetter = base;
+                base = ""; // disable re-enterable calls
+                try {
+                    base = await baseGetter();
+                }
+                catch (e) {
+                    base = baseGetter;
+                    throw e;
+                }
+            }
+            req.url = new URL(req.url, base).toString();
+            return next(req);
+        });
+    }
+    /**
+     * Returns a new RestClient with a custom header.
+     */
+    withHeader(name, value) {
+        return this.withMiddleware(async function withHeaderMiddleware(req, next) {
+            req.headers.set(name, typeof value === "string" ? value : await value());
+            return next(req);
+        });
+    }
+    /**
+     * Returns a new RestClient with a bearer token authentication workflow.
+     * - RestClient supports interception of options.isTokenInvalid() signal and
+     *   conversion it into RestTokenInvalidError exception.
+     * - If a token() is a lambda with 1 argument, it may be called the 2nd time
+     *   when we get an isTokenInvalid() signal. In this case, the request is
+     *   retried.
+     * - If token() is a lambda with 0 arguments, that means it doesn't want to
+     *   watch for the isTokenInvalid() signal, so there is no sense in retrying
+     *   the request either.
+     *
+     * From the first sight, it looks like options.isTokenInvalid() signal is
+     * coupled to setBearer() auth method only. But it's not true:
+     * isTokenInvalid() makes sense for ALL authentication methods actually (even
+     * for basic auth), and setBearer() is just one of "clients" which implements
+     * refreshing/retries on top of isTokenInvalid().
+     *
+     * Passing the token as lambda allows the caller to implement some complex
+     * logic, e.g.:
+     * - oauth2 tokens refreshing
+     * - marking the token as "revoked" in the database in case the refresh fails
+     * - marking the token as "revoked" after a failed request if refresh-token is
+     *   not supported
+     */
+    withBearer(token, bearerPrefix = "Bearer ") {
+        return this.withMiddleware(async function withBearerMiddleware(req, next) {
+            return tokenRetryStrategy(token, async (tokenData) => {
+                req.headers.set("Authorization", bearerPrefix + tokenData);
+                return next(req);
+            });
+        });
+    }
+    /**
+     * Returns a new RestClient with oauth1 authentication workflow.
+     * - In case we get an options.isTokenInvalid() signal, the token() lambda is
+     *   called the 2nd time with the error object, then the request is retries.
+     *   This gives the lambda a chance to recover or update something in the
+     *   database.
+     *
+     * We use a separate and small oauth-1.0a node library here, because the more
+     * popular one (https://www.npmjs.com/package/oauth) doesn't support signing
+     * of arbitrary requests, it can only send its own requests.
+     */
+    withOAuth1(consumer, token) {
+        const oauth = new oauth_1_0a_1.default({
+            consumer: { key: consumer.consumerKey, secret: consumer.consumerSecret },
+            signature_method: "HMAC-SHA1",
+            hash_function: (baseString, key) => crypto_1.default.createHmac("sha1", key).update(baseString).digest("base64"),
+        });
+        return this.withMiddleware(async function withOAuth1Middleware(req, next) {
+            return tokenRetryStrategy(token, async (tokenData) => {
+                const requestData = {
+                    url: req.url,
+                    method: req.method,
+                    data: req.body,
+                };
+                const addHeaders = oauth.toHeader(oauth.authorize(requestData, {
+                    key: tokenData.token,
+                    secret: tokenData.tokenSecret,
+                }));
+                for (const [name, value] of Object.entries(addHeaders)) {
+                    req.headers.set(name, value);
+                }
+                return next(req);
+            });
+        });
+    }
+    /**
+     * Returns a new RestClient with basic authorization workflow.
+     */
+    withBasic(token) {
+        return this.withMiddleware(async function withBasicMiddleware(req, next) {
+            return tokenRetryStrategy(token, async ({ name, password }) => {
+                const unencodedHeader = name + ":" + password;
+                req.headers.set("Authorization", "Basic " + Buffer.from(unencodedHeader).toString("base64"));
+                return next(req);
+            });
+        });
+    }
+    /**
+     * Sends a plain GET request without body.
+     *
+     * NOTE, all args will be passed through `encodeURIComponent`.
+     */
+    get(path, args = {}, accept = "application/json") {
+        return this._noBodyRequest(path, args, "GET", accept);
+    }
+    /**
+     * Writes some raw string, buffer or a stream.
+     */
+    writeRaw(path, body, contentType, method = "POST", accept) {
+        const origShape = simpleShape(path);
+        return new RestRequest_1.default(this._options, method, path, new node_fetch_1.Headers({
+            Accept: accept || contentType,
+            "Content-Type": contentType,
+        }), body, origShape);
+    }
+    /**
+     * A shortcut method to write JSON body.
+     */
+    writeJson(path, body, method = "POST", accept = "application/json") {
+        const origShape = simpleShape(path, body);
+        [path, body] = (0, substituteParams_1.default)(path, body);
+        return new RestRequest_1.default(this._options, method, path, new node_fetch_1.Headers({
+            Accept: accept || "application/json",
+            "Content-Type": "application/json",
+        }), JSON.stringify(body), origShape);
+    }
+    /**
+     * A shortcut method to write "application/x-www-form-urlencoded" data.
+     */
+    writeForm(path, body, method = "POST", accept = "application/json") {
+        const origShape = simpleShape(path, body);
+        [path, body] = (0, substituteParams_1.default)(path, body);
+        return new RestRequest_1.default(this._options, method, path, new node_fetch_1.Headers({
+            Accept: accept,
+            "Content-Type": "application/x-www-form-urlencoded",
+        }), typeof body === "string"
+            ? body
+            : new URLSearchParams((0, omitBy_1.default)(body, isUndefined_1.default)).toString(), origShape);
+    }
+    /**
+     * A shortcut method to write DELETE request.
+     */
+    writeDelete(path, args = {}, accept = "application/json") {
+        return this._noBodyRequest(path, args, "DELETE", accept);
+    }
+    /**
+     * Returns a RestRequest prepared for sending GraphQL operation.
+     * - Expects the response to contain no errors; throws otherwise.
+     * - In case of success, returns just the content of `data` field (this is
+     *   different with writeGraphQLNullable() which returns `data` as a separate
+     *   fields along with `error` and `errors`).
+     */
+    writeGraphQLX(query, variables = {}) {
+        const oldIsSuccessResponse = this._options.isSuccessResponse;
+        return this.withOptions({
+            isSuccessResponse: (res) => {
+                const oldIsSuccess = oldIsSuccessResponse === null || oldIsSuccessResponse === void 0 ? void 0 : oldIsSuccessResponse(res);
+                const json = res.json;
+                return oldIsSuccess === "THROW" ||
+                    !(json === null || json === void 0 ? void 0 : json.data) ||
+                    json.error ||
+                    (json.errors instanceof Array && json.errors.length > 0)
+                    ? "THROW"
+                    : "BEST_EFFORT";
+            },
+        })
+            .withMiddleware(async function writeGraphQLXMiddleware(req, next) {
+            const res = await next(req);
+            const json = res.json;
+            // Substitute the response json object with just its data field.
+            Object.defineProperty(res, "json", { value: json.data });
+            return res;
+        })
+            ._writeGraphQLImpl(query, variables);
+    }
+    /**
+     * Same as writeGraphQLX(), but doesn't throw if GraphQL response contains
+     * non-empty `error` or `errors` fields and instead returns the full response.
+     * I.e. allows the caller to process these errors.
+     */
+    writeGraphQLNullable(query, variables = {}) {
+        return this._writeGraphQLImpl(query, variables);
+    }
+    /**
+     * Performs a series of Content-Range requests with content from a sequence of
+     * Buffers.
+     */
+    async rangeUpload(path, mimeType, stream, method = "POST", chunkSize) {
+        return new RestRangeUploader_1.default(this, chunkSize, method, path, mimeType).upload(stream);
+    }
+    _writeGraphQLImpl(query, variables = {}) {
+        const origShape = query;
+        // To beautify the query, we remove leading spaces (extracted from the last line).
+        query = query.trimEnd();
+        if (query.match(/\n([ \t]+)[^\n]+$/)) {
+            const prefix = RegExp.$1;
+            query = query.replace(new RegExp("^" + prefix, "gm"), "").trimEnd();
+        }
+        return new RestRequest_1.default(this._options, "POST", "", new node_fetch_1.Headers({ "Content-Type": "application/json" }), JSON.stringify({ variables, query }), // variables first - for truncation in logs,
+        origShape);
+    }
+    /**
+     * Sends a plain request (with no body, like GET or DELETE).
+     */
+    _noBodyRequest(path, args = {}, method, accept = "application/json") {
+        const origShape = simpleShape(path, args);
+        [path, args] = (0, substituteParams_1.default)(path, args);
+        const searchParams = new URLSearchParams();
+        for (const [k, v] of Object.entries(args)) {
+            if (Array.isArray(v)) {
+                for (const element of v) {
+                    searchParams.append(k, element.toString());
+                }
+            }
+            else if (v !== undefined) {
+                searchParams.append(k, v.toString());
+            }
+        }
+        const suffix = searchParams.toString();
+        if (suffix !== "") {
+            path += (path.includes("?") ? "&" : "?") + suffix;
+        }
+        return new RestRequest_1.default(this._options, method, path, new node_fetch_1.Headers({ Accept: accept }), "", origShape);
+    }
+}
+exports.default = RestClient;
+/**
+ * @ignore
+ * Calls token(null), then runs body() passing the result there. If we get a
+ * RestTokenInvalidError exception, call token() with this error as a parameter
+ * and then passes the response to body() again (kinda retry with a new token).
+ */
+async function tokenRetryStrategy(token, body) {
+    let tokenData = await token(null);
+    try {
+        return await body(tokenData);
+    }
+    catch (e) {
+        const supportsRetry = token.length > 0; // args count
+        if (e instanceof RestTokenInvalidError_1.default && supportsRetry) {
+            tokenData = await token(e);
+            try {
+                return await body(tokenData);
+            }
+            catch (e) {
+                if (e instanceof RestTokenInvalidError_1.default) {
+                    e.message = `(still failed, even with updated token) ${e.message}`;
+                }
+                throw e;
+            }
+        }
+        throw e;
+    }
+}
+exports.tokenRetryStrategy = tokenRetryStrategy;
+/**
+ * Returns a simple "shape" of a request useful for e.g. grouping by in logger
+ * to figure out, which requests are more frequent.
+ * - reflects args names and not values
+ * - wipes the domain
+ * - removes query string parameter values
+ */
+function simpleShape(path, args) {
+    path = path.replace(/^\w+:\/\/[^/]+/, "").replace(/=[^&]+/g, "=");
+    const argsInPath = [];
+    const regex = /:([a-z0-9_]+)/gi;
+    while (true) {
+        const match = regex.exec(path);
+        if (!match) {
+            break;
+        }
+        else {
+            argsInPath.push(match[1]);
+        }
+    }
+    const keys = 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))
+            .sort()
+            .join(",")
+        : "";
+    return path + (keys !== "" ? `:${keys}` : "");
+}
+//# sourceMappingURL=RestClient.js.map

package/dist/RestClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RestClient.js","sourceRoot":"","sources":["../src/RestClient.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA4B;AAC5B,qEAA6C;AAC7C,2DAAmC;AACnC,2CAAqC;AACrC,4DAAgC;AAChC,2FAAmE;AACnE,qFAA6D;AAC7D,mFAA2D;AAE3D,+CAAgD;AAChD,gEAAwC;AAaxC;;;;;GAKG;AACH,MAAqB,UAAU;IAG7B,YAAY,UAAgC,EAAE;QAC5C,IAAI,CAAC,QAAQ,GAAG;YACd,GAAG,6BAAe;YAClB,GAAG,IAAA,gBAAM,EAAC,OAAO,EAAE,qBAAW,CAAC;YAC/B,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,EAAE,GAAG,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACrE,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAC1E,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,OAA6B;QACvC,OAAO,IAAI,UAAU,CAAC;YACpB,GAAG,IAAI,CAAC,QAAQ;YAChB,GAAG,IAAA,gBAAM,EAAC,OAAO,EAAE,qBAAW,CAAC;SAChC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,cAAc,CACZ,UAAyC,EACzC,SAA6B,MAAM;QAEnC,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC5C,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,UAAU,CAAC,CAAC;QAC/C,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,IAAsC;QAC7C,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,UAAU,kBAAkB,CAAC,GAAG,EAAE,IAAI;YACpE,uEAAuE;YACvE,+BAA+B;YAC/B,IAAI,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE;gBAC9B,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;aAClB;YAED,kEAAkE;YAClE,mEAAmE;YACnE,IAAI,IAAI,KAAK,EAAE,EAAE;gBACf,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;aAClB;YAED,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;gBAC5B,MAAM,UAAU,GAAG,IAAI,CAAC;gBACxB,IAAI,GAAG,EAAE,CAAC,CAAC,6BAA6B;gBACxC,IAAI;oBACF,IAAI,GAAG,MAAM,UAAU,EAAE,CAAC;iBAC3B;gBAAC,OAAO,CAAM,EAAE;oBACf,IAAI,GAAG,UAAU,CAAC;oBAClB,MAAM,CAAC,CAAC;iBACT;aACF;YAED,GAAG,CAAC,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC5C,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,IAAY,EAAE,KAAuC;QAC9D,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,UAAU,oBAAoB,CAAC,GAAG,EAAE,IAAI;YACtE,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,KAAK,EAAE,CAAC,CAAC;YACzE,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,UAAU,CAAC,KAAkB,EAAE,YAAY,GAAG,SAAS;QACrD,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,UAAU,oBAAoB,CAAC,GAAG,EAAE,IAAI;YACtE,OAAO,kBAAkB,CAAC,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE;gBACnD,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,YAAY,GAAG,SAAS,CAAC,CAAC;gBAC3D,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;YACnB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,UAAU,CACR,QAAyD,EACzD,KAA0D;QAE1D,MAAM,KAAK,GAAG,IAAI,oBAAM,CAAC;YACvB,QAAQ,EAAE,EAAE,GAAG,EAAE,QAAQ,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,CAAC,cAAc,EAAE;YACxE,gBAAgB,EAAE,WAAW;YAC7B,aAAa,EAAE,CAAC,UAAU,EAAE,GAAG,EAAE,EAAE,CACjC,gBAAM,CAAC,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC;SACrE,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,UAAU,oBAAoB,CAAC,GAAG,EAAE,IAAI;YACtE,OAAO,kBAAkB,CAAC,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE;gBACnD,MAAM,WAAW,GAA0B;oBACzC,GAAG,EAAE,GAAG,CAAC,GAAG;oBACZ,MAAM,EAAE,GAAG,CAAC,MAAM;oBAClB,IAAI,EAAE,GAAG,CAAC,IAAI;iBACf,CAAC;gBACF,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAC/B,KAAK,CAAC,SAAS,CAAC,WAAW,EAAE;oBAC3B,GAAG,EAAE,SAAS,CAAC,KAAK;oBACpB,MAAM,EAAE,SAAS,CAAC,WAAW;iBAC9B,CAAC,CACH,CAAC;gBACF,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;oBACtD,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;iBAC9B;gBAED,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;YACnB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,KAAsD;QAC9D,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,UAAU,mBAAmB,CAAC,GAAG,EAAE,IAAI;YACrE,OAAO,kBAAkB,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE;gBAC5D,MAAM,eAAe,GAAG,IAAI,GAAG,GAAG,GAAG,QAAQ,CAAC;gBAC9C,GAAG,CAAC,OAAO,CAAC,GAAG,CACb,eAAe,EACf,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAC3D,CAAC;gBACF,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;YACnB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,GAAG,CACD,IAAY,EACZ,OAA4D,EAAE,EAC9D,SAAiB,kBAAkB;QAEnC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IACxD,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,IAAY,EACZ,IAA6C,EAC7C,WAAmB,EACnB,SAAmC,MAAM,EACzC,MAAe;QAEf,MAAM,SAAS,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;QACpC,OAAO,IAAI,qBAAW,CACpB,IAAI,CAAC,QAAQ,EACb,MAAM,EACN,IAAI,EACJ,IAAI,oBAAO,CAAC;YACV,MAAM,EAAE,MAAM,IAAI,WAAW;YAC7B,cAAc,EAAE,WAAW;SAC5B,CAAC,EACF,IAAI,EACJ,SAAS,CACV,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,SAAS,CACP,IAAY,EACZ,IAAS,EACT,SAA8C,MAAM,EACpD,SAAiB,kBAAkB;QAEnC,MAAM,SAAS,GAAG,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC1C,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,IAAA,0BAAgB,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC5C,OAAO,IAAI,qBAAW,CACpB,IAAI,CAAC,QAAQ,EACb,MAAM,EACN,IAAI,EACJ,IAAI,oBAAO,CAAC;YACV,MAAM,EAAE,MAAM,IAAI,kBAAkB;YACpC,cAAc,EAAE,kBAAkB;SACnC,CAAC,EACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EACpB,SAAS,CACV,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,SAAS,CACP,IAAY,EACZ,IAA8C,EAC9C,SAAmC,MAAM,EACzC,SAAiB,kBAAkB;QAEnC,MAAM,SAAS,GAAG,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC1C,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,IAAA,0BAAgB,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC5C,OAAO,IAAI,qBAAW,CACpB,IAAI,CAAC,QAAQ,EACb,MAAM,EACN,IAAI,EACJ,IAAI,oBAAO,CAAC;YACV,MAAM,EAAE,MAAM;YACd,cAAc,EAAE,mCAAmC;SACpD,CAAC,EACF,OAAO,IAAI,KAAK,QAAQ;YACtB,CAAC,CAAC,IAAI;YACN,CAAC,CAAC,IAAI,eAAe,CACjB,IAAA,gBAAM,EAAC,IAAI,EAAE,qBAAW,CAA2B,CACpD,CAAC,QAAQ,EAAE,EAChB,SAAS,CACV,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,WAAW,CACT,IAAY,EACZ,OAAwC,EAAE,EAC1C,SAAiB,kBAAkB;QAEnC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;OAMG;IACH,aAAa,CAAC,KAAa,EAAE,YAAiB,EAAE;QAC9C,MAAM,oBAAoB,GAAG,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC;QAC7D,OAAO,IAAI,CAAC,WAAW,CAAC;YACtB,iBAAiB,EAAE,CAAC,GAAG,EAAE,EAAE;gBACzB,MAAM,YAAY,GAAG,oBAAoB,aAApB,oBAAoB,uBAApB,oBAAoB,CAAG,GAAG,CAAC,CAAC;gBACjD,MAAM,IAAI,GAAQ,GAAG,CAAC,IAAI,CAAC;gBAC3B,OAAO,YAAY,KAAK,OAAO;oBAC7B,CAAC,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI,CAAA;oBACX,IAAI,CAAC,KAAK;oBACV,CAAC,IAAI,CAAC,MAAM,YAAY,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;oBACxD,CAAC,CAAC,OAAO;oBACT,CAAC,CAAC,aAAa,CAAC;YACpB,CAAC;SACF,CAAC;aACC,cAAc,CAAC,KAAK,UAAU,uBAAuB,CAAC,GAAG,EAAE,IAAI;YAC9D,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,CAAC;YAC5B,MAAM,IAAI,GAAQ,GAAG,CAAC,IAAI,CAAC;YAC3B,gEAAgE;YAChE,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;YACzD,OAAO,GAAG,CAAC;QACb,CAAC,CAAC;aAED,iBAAiB,CAAM,KAAK,EAAE,SAAS,CAAC,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACH,oBAAoB,CAAC,KAAa,EAAE,YAAiB,EAAE;QACrD,OAAO,IAAI,CAAC,iBAAiB,CAE3B,KAAK,EAAE,SAAS,CAAC,CAAC;IACtB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW,CACf,IAAY,EACZ,QAAgB,EAChB,MAA6B,EAC7B,SAAyB,MAAM,EAC/B,SAAiB;QAEjB,OAAO,IAAI,2BAAiB,CAC1B,IAAI,EACJ,SAAS,EACT,MAAM,EACN,IAAI,EACJ,QAAQ,CACT,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACnB,CAAC;IAEO,iBAAiB,CAAe,KAAa,EAAE,YAAiB,EAAE;QACxE,MAAM,SAAS,GAAG,KAAK,CAAC;QACxB,kFAAkF;QAClF,KAAK,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC;QACxB,IAAI,KAAK,CAAC,KAAK,CAAC,mBAAmB,CAAC,EAAE;YACpC,MAAM,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;YACzB,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,GAAG,GAAG,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACrE;QAED,OAAO,IAAI,qBAAW,CACpB,IAAI,CAAC,QAAQ,EACb,MAAM,EACN,EAAE,EACF,IAAI,oBAAO,CAAC,EAAE,cAAc,EAAE,kBAAkB,EAAE,CAAC,EACnD,IAAI,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,EAAE,4CAA4C;QAClF,SAAS,CACV,CAAC;IACJ,CAAC;IAED;;OAEG;IACK,cAAc,CACpB,IAAY,EACZ,OAA4D,EAAE,EAC9D,MAAwB,EACxB,SAAiB,kBAAkB;QAEnC,MAAM,SAAS,GAAG,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC1C,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,IAAA,0BAAgB,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC5C,MAAM,YAAY,GAAG,IAAI,eAAe,EAAE,CAAC;QAC3C,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACzC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;gBACpB,KAAK,MAAM,OAAO,IAAI,CAAC,EAAE;oBACvB,YAAY,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;iBAC5C;aACF;iBAAM,IAAI,CAAC,KAAK,SAAS,EAAE;gBAC1B,YAAY,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;aACtC;SACF;QAED,MAAM,MAAM,GAAG,YAAY,CAAC,QAAQ,EAAE,CAAC;QACvC,IAAI,MAAM,KAAK,EAAE,EAAE;YACjB,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC;SACnD;QAED,OAAO,IAAI,qBAAW,CACpB,IAAI,CAAC,QAAQ,EACb,MAAM,EACN,IAAI,EACJ,IAAI,oBAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,EAC/B,EAAE,EACF,SAAS,CACV,CAAC;IACJ,CAAC;CACF;AA1YD,6BA0YC;AAED;;;;;GAKG;AACI,KAAK,UAAU,kBAAkB,CACtC,KAAyB,EACzB,IAAiD;IAEjD,IAAI,SAAS,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC;IAClC,IAAI;QACF,OAAO,MAAM,IAAI,CAAC,SAAS,CAAC,CAAC;KAC9B;IAAC,OAAO,CAAM,EAAE;QACf,MAAM,aAAa,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,aAAa;QACrD,IAAI,CAAC,YAAY,+BAAqB,IAAI,aAAa,EAAE;YACvD,SAAS,GAAG,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC;YAC3B,IAAI;gBACF,OAAO,MAAM,IAAI,CAAC,SAAS,CAAC,CAAC;aAC9B;YAAC,OAAO,CAAM,EAAE;gBACf,IAAI,CAAC,YAAY,+BAAqB,EAAE;oBACtC,CAAC,CAAC,OAAO,GAAG,2CAA2C,CAAC,CAAC,OAAO,EAAE,CAAC;iBACpE;gBAED,MAAM,CAAC,CAAC;aACT;SACF;QAED,MAAM,CAAC,CAAC;KACT;AACH,CAAC;AAxBD,gDAwBC;AAED;;;;;;GAMG;AACH,SAAS,WAAW,CAAC,IAAY,EAAE,IAAU;IAC3C,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;IAElE,MAAM,UAAU,GAAa,EAAE,CAAC;IAChC,MAAM,KAAK,GAAG,iBAAiB,CAAC;IAChC,OAAO,IAAI,EAAE;QACX,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/B,IAAI,CAAC,KAAK,EAAE;YACV,MAAM;SACP;aAAM;YACL,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;SAC3B;KACF;IAED,MAAM,IAAI,GACR,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ;QAC9B,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;YACf,+DAA+D;YAC/D,yBAAyB;aACxB,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;aAC1C,IAAI,EAAE;aACN,IAAI,CAAC,GAAG,CAAC;QACd,CAAC,CAAC,EAAE,CAAC;IAET,OAAO,IAAI,GAAG,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;AAChD,CAAC"}