@clickup/rest-client 2.10.292

package/.eslintrc.base.js

@@ -0,0 +1,412 @@
+"use strict";
+module.exports = (projectRoot) => ({
+  root: true, // fix possible "Plugin %s was conflicted between %s.json and %s.json" errors
+  env: {
+    jest: true,
+    browser: true,
+    es6: true,
+    node: true,
+  },
+  extends: [
+    "eslint:recommended",
+    "plugin:react/recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:import/recommended",
+  ],
+  globals: {
+    Atomics: "readonly",
+    SharedArrayBuffer: "readonly",
+  },
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    ecmaFeatures: {
+      jsx: true,
+    },
+    ecmaVersion: 2018,
+    sourceType: "module",
+    tsconfigRootDir: projectRoot,
+    project: "tsconfig.json",
+    warnOnUnsupportedTypeScriptVersion: false,
+  },
+  plugins: [
+    "@typescript-eslint",
+    "import",
+    "lodash",
+    "node",
+    "react-hooks",
+    "react",
+    "typescript-enum",
+    "typescript-sort-keys",
+    "unused-imports",
+  ],
+  settings: {
+    react: {
+      version: "detect",
+    },
+    "import/parsers": {
+      "@typescript-eslint/parser": [".ts", ".tsx"],
+    },
+    "import/resolver": {
+      typescript: {
+        project: projectRoot,
+      },
+    },
+  },
+  ignorePatterns: [
+    "node_modules",
+    "webpack.config.ts",
+    "**/bin/**",
+    "*.d.ts",
+    "**/jest.config.js",
+  ],
+  rules: {
+    // TODO: slowly enable no-extraneous-dependencies rule below. For now, it's
+    // enforced only for some packages.
+    //
+    // In an ideal world, the root package.json should have 0 dependencies, and
+    // all packages/* should define their own dependencies by themselves,
+    // independently and locally. The rule below is exactly for that: it ensures
+    // that all package's dependencies are explicitly mentioned in its
+    // package.json, and no dependencies are borrowed implicitly from the root
+    // node_modules.
+    //
+    // In real life though, enforcing packages independency is dangerous: we may
+    // e.g. start accidentally bundle 2 React or 2 Redux versions if we forget
+    // to sync their versions in different monorepo packages' package.json
+    // files. (There must be some other lint rule for this hopefully.)
+    //
+    // In all cases, we should treat node_modules folders content as something
+    // secondary and transient. (It's true even now with the new "yarn
+    // Plug-n-Play" technology which we don't use yet.) The source of truth is
+    // always package.json (enforced by lint) and yarn.lock (defines the exact
+    // contents of all node_modules folders, bit by bit). In this schema, it
+    // doesn't matter at all, does yarn use hoisting or not.
+    //
+    // "import/no-extraneous-dependencies": "error";
+
+    "node/prefer-global/process": "error",
+    "node/prefer-global/console": "error",
+    "node/prefer-global/buffer": "error",
+    "node/prefer-global/url-search-params": "error",
+    "node/prefer-global/url": "error",
+
+    "require-atomic-updates": "off",
+    "no-prototype-builtins": "off",
+    "react/prop-types": "off",
+    "react/no-unescaped-entities": "off",
+    "react-hooks/rules-of-hooks": "error",
+    "react-hooks/exhaustive-deps": "warn",
+    "@typescript-eslint/no-misused-promises": "error",
+    "@typescript-eslint/promise-function-async": "error",
+    "arrow-body-style": ["error", "as-needed"],
+    "@typescript-eslint/await-thenable": "error",
+    "@typescript-eslint/no-floating-promises": ["error", { ignoreVoid: false }],
+    "@typescript-eslint/unbound-method": ["error", { ignoreStatic: true }],
+    "@typescript-eslint/return-await": ["error"],
+    "@typescript-eslint/array-type": ["error", { default: "array-simple" }],
+    "@typescript-eslint/ban-ts-comment": ["error"],
+    "@typescript-eslint/no-useless-constructor": ["error"],
+    "@typescript-eslint/prefer-optional-chain": ["error"],
+    "@typescript-eslint/consistent-type-imports": ["error"],
+    eqeqeq: ["error"],
+    "object-shorthand": ["error", "always"],
+    "@typescript-eslint/unbound-method": ["error"],
+    "typescript-enum/no-const-enum": ["error"], // not supported in SWC
+
+    "@typescript-eslint/naming-convention": [
+      "error",
+      {
+        selector: "variable",
+        format: ["camelCase", "PascalCase", "UPPER_CASE"],
+        leadingUnderscore: "allow",
+        trailingUnderscore: "allow",
+        filter: {
+          regex: "^__webpack",
+          match: false,
+        },
+      },
+    ],
+
+    // Disable in favour of @typescript-eslint/no-unused-vars.
+    "no-unused-vars": "off",
+    "@typescript-eslint/no-unused-vars": [
+      "error",
+      {
+        args: "all",
+        argsIgnorePattern: "^_",
+        varsIgnorePattern: "^_",
+        ignoreRestSiblings: true,
+      },
+    ],
+    "@typescript-eslint/member-ordering": [
+      "error",
+      {
+        //
+        // ATTENTION: the rules here are not simple, mainly because of this:
+        // https://github.com/typescript-eslint/typescript-eslint/issues/6133
+        //
+        // Besides that, we also wand contradictory things, like:
+        //
+        // 1. Having constructor close to fields definition (because people
+        //    often define fields in the constructor arguments), although it
+        //    logically should've been below static methods.
+        // 2. Having all abstract things in the class grouped, irregardless on
+        //    their public/protected/private modifiers.
+        //
+        default: [
+          "signature",
+          "call-signature",
+
+          // Typically, class constants (that's why they're on top).
+          "public-static-field",
+          "public-static-get",
+          "public-static-set",
+          "protected-static-field",
+          "protected-static-get",
+          "protected-static-set",
+
+          // All concrete fields. What's interesting is that the order we
+          // emotionally want here for properties is private-protected-public,
+          // which is the opposite to the order of methods (which is
+          // public-protected-private). This is likely because the methods are
+          // bulky, and properties are lean.
+          "private-static-field",
+          "private-instance-field",
+          "public-instance-field",
+          "public-abstract-field",
+          "public-abstract-get",
+          "public-abstract-set",
+
+          // Protected fields and methods are grouped, because eslint currently
+          // doesn't distinguish fields assigned with a lambda FROM methods, and
+          // we often times expose abstract protected overridable lambdas:
+          // https://github.com/typescript-eslint/typescript-eslint/issues/6133
+          "protected-abstract-field",
+          "protected-abstract-get",
+          "protected-abstract-set",
+          "protected-abstract-method",
+          "public-abstract-method", // the only exception; it's to group all abstract things too
+          "protected-instance-field",
+          "protected-constructor",
+          "protected-static-method",
+          "protected-instance-get",
+          "protected-instance-set",
+          "protected-instance-method",
+
+          // Public constructor, instance methods, static methods.
+          "public-constructor", // often defines more public/protected/private properties, so should be close to fields
+          "public-static-method",
+          "public-instance-get",
+          "public-instance-set",
+          "public-instance-method",
+
+          // Private constructor, instance methods, static methods.
+          "private-constructor",
+          "private-static-method",
+          "private-instance-get",
+          "private-instance-set",
+          "private-instance-method",
+          "private-static-get",
+          "private-static-set",
+        ],
+      },
+    ],
+
+    "no-constant-condition": ["error", { checkLoops: false }],
+    "no-buffer-constructor": ["error"],
+    "no-console": ["error"],
+    curly: ["error", "all"],
+    "no-case-declarations": "off",
+
+    "padding-line-between-statements": "off",
+    "@typescript-eslint/padding-line-between-statements": [
+      "warn",
+      // Force empty lines.
+      {
+        blankLine: "always",
+        prev: ["block", "block-like", "function", "class", "interface", "type"],
+        next: "*",
+      },
+      {
+        blankLine: "always",
+        prev: "import",
+        next: [
+          "const",
+          "if",
+          "let",
+          "var",
+          "export",
+          "function",
+          "class",
+          "interface",
+          "type",
+        ],
+      },
+      {
+        blankLine: "always",
+        prev: "*",
+        next: ["function", "class", "interface", "type"],
+      },
+      // Allow one-liner functions without extra spacing (hacky):
+      { blankLine: "any", prev: "singleline-const", next: "*" },
+      { blankLine: "any", prev: "singleline-var", next: "*" },
+      { blankLine: "any", prev: "singleline-let", next: "*" },
+    ],
+
+    "no-restricted-properties": [
+      "error",
+      {
+        object: "window",
+        property: "location",
+        message:
+          "We use React Router and History to control the location of our web or desktop app. Prefer `useLocation` in React components and `historyFromContext` in Redux Saga.",
+      },
+      ...(projectRoot.endsWith("client")
+        ? [
+            {
+              object: "window",
+              property: "document",
+              message: "Please use `useDocument` from `useDocument.tsx`.",
+            },
+            ...[
+              "addEventListener",
+              "removeEventListener",
+              "getElementById",
+              "documentElement",
+              "activeElement",
+              "querySelectorAll",
+            ].map((property) => ({
+              object: "document",
+              property,
+              message: "Please use `useDocument` from `useDocument.tsx`.",
+            })),
+          ]
+        : []),
+    ],
+
+    "no-restricted-globals": [
+      "warn",
+      {
+        name: "location",
+        message:
+          "We use React Router and History to control the location of our web or desktop app. Prefer `useLocation` in React components and `historyFromContext` in Redux Saga.",
+      },
+    ],
+
+    "prefer-const": [
+      "error",
+      {
+        destructuring: "all",
+      },
+    ],
+
+    "no-var": "error",
+    "no-void": "error",
+
+    "react/forbid-dom-props": [
+      "error",
+      {
+        forbid: [
+          {
+            propName: "style",
+            message: "Please use CSS Modules instead",
+          },
+        ],
+      },
+    ],
+    "react/forbid-component-props": [
+      "error",
+      {
+        forbid: [
+          {
+            propName: "style",
+            message: "Please use CSS Modules instead",
+          },
+        ],
+      },
+    ],
+    "no-sequences": ["error"],
+    // Too noisy about `react` and other node_modules
+    "import/default": 0,
+    // This complains about React.forwardRef, ReactDOM.render, etc.
+    "import/no-named-as-default-member": 0,
+    // This complains about "apollo" exporting ApolloClient as a default and as a
+    // named import at the same time.
+    "import/no-named-as-default": 0,
+    // Does not seem to work well with node_modules
+    "import/named": 0,
+    "import/newline-after-import": "error",
+    "import/order": [
+      "error",
+      {
+        groups: ["builtin", "external", "index", "parent", "sibling"],
+        pathGroups: [
+          {
+            pattern: "./**.module.css",
+            group: "sibling",
+            position: "after",
+          },
+          {
+            pattern: "./**.module.scss",
+            group: "sibling",
+            position: "after",
+          },
+        ],
+        alphabetize: {
+          order: "asc",
+          caseInsensitive: true,
+        },
+      },
+    ],
+    "unused-imports/no-unused-imports": "error",
+    "no-restricted-imports": [
+      "error",
+      {
+        patterns: [
+          {
+            group: ["react-router"],
+            message:
+              "Please use react-router-dom instead, since react-router's useLocation() doesn't work properly with StaticRouter on server side.",
+          },
+        ],
+      },
+    ],
+    // Fixes a common mistake: `a ?? b < c` which feels like `(a ?? b) < c`, but
+    // actually is `a ?? (b < c)`
+    "no-mixed-operators": [
+      "error",
+      {
+        allowSamePrecedence: false,
+        groups: [
+          ["??", "+"],
+          ["??", "-"],
+          ["??", "*"],
+          ["??", "/"],
+          ["??", "%"],
+          ["??", "**"],
+          ["??", "&"],
+          ["??", "|"],
+          ["??", "^"],
+          ["??", "~"],
+          ["??", "<<"],
+          ["??", ">>"],
+          ["??", ">>>"],
+          ["??", "=="],
+          ["??", "!="],
+          ["??", "==="],
+          ["??", "!=="],
+          ["??", ">"],
+          ["??", ">="],
+          ["??", "<"],
+          ["??", "<="],
+          ["??", "&&"],
+          ["??", "||"],
+          ["??", "in"],
+          ["??", "instanceof"],
+        ],
+      },
+    ],
+
+    quotes: ["error", "double", { avoidEscape: true }],
+  },
+});

package/.eslintrc.js

@@ -0,0 +1,5 @@
+"use strict";
+const config = require("./.eslintrc.base.js")(__dirname);
+config.rules["import/no-extraneous-dependencies"] = "error";
+config.rules["lodash/import-scope"] = ["error", "method"];
+module.exports = config;

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2023 Mango Technologies, Inc. DBA ClickUp
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,121 @@
+# RestClient: a syntax sugar tool around Node fetch() API, tailored to work with typescript-is or superstruct validators
+
+See also [Full API documentation](https://github.com/clickup/rest-client/blob/master/docs/modules.md).
+
+## Examples
+
+In the example below we use
+[superstruct](https://www.npmjs.com/package/superstruct) library to build a
+strongly typed response validator. Validator is just a function passed to
+`json()` method: it must throw if the argument passed doesn't match what it
+expects the value to be.
+
+```ts
+import { array, number, object, string } from "superstruct";
+import RestClient from "rest-client";
+
+// Initialized once. See RestOptions for lots of other options.
+const client = new RestClient()
+  .withOptions({
+    timeoutMs: 1000,
+    logger: (_event) => {
+      /* myLogger.log(event); */
+    },
+  })
+  .withBase("https://reqres.in");
+
+async function main() {
+  // Send individual request using superstruct as a validation backend.
+  const res = await client
+    .get("/api/users", { page: 2 })
+    .setDebug()
+    .json(
+      object({
+        total: number(),
+        data: array(
+          object({
+            id: number(),
+            email: string(),
+          })
+        ),
+      })
+    );
+  console.log("Masked and validated response: ", res);
+  // Notice that `res` is strongly typed! You won't make a typo.
+  console.log("Here is a TS strongly-typed field:", res.data[0].email);
+}
+
+main().catch((e) => console.error(e));
+```
+
+The above script prints the following:
+
+```
++++ GET https://reqres.in/api/users?page=2
++++ Accept: application/json
+=== HTTP 200 (took 105 ms)
+=== { data:
+===    [ { id: 7,
+===        email: 'michael.lawson@reqres.in',
+===        first_name: 'Michael',
+===        last_name: 'Lawson',
+===        avatar: 'https://reqres.in/img/faces/7-image.jpg' },
+===      { id: 8,
+===        email: 'lindsay.ferguson@reqres.in',
+===        first_name: 'Lindsay',
+===        last_name: 'Ferguson',
+===        avatar: 'https://reqres.in/img/faces/8-image.jpg' },
+===      { id: 9,
+===        email: 'tobias.funke@reqres.in',
+===        first_name: 'Tobias',
+===        last_name: 'Funke',
+===        avatar: 'https://reqres.in/img/faces/9-image.jpg' },
+===      { id: 10,
+===        email: 'byron.fields@reqres.in',
+===        first_name: 'Byron',
+===        last_name: 'Fields',
+===        avatar: 'https://reqres.in/img/faces/10-image.jpg' },
+===      { id: 11,
+===        email: 'george.edwards@reqres.in',
+===        first_name: 'George',
+===        last_name: 'Edwards',
+===        avatar: 'https://reqres.in/img/faces/11-image.jpg' },
+===      { id: 12,
+===        email: 'rachel.howell@reqres.in',
+===        first_name: 'Rachel',
+===        last_name: 'Howell',
+===        avatar: 'https://reqres.in/img/faces/12-image.jpg' } ],
+===   page: 2,
+===   per_page: 6,
+===   support:
+===    { url: 'https://reqres.in/#support-heading',
+===      text: 'To keep ReqRes free, contributions!' },
+===   total: 12,
+===   total_pages: 2 }
+
+Masked and validated response:  {
+  total: 12,
+  data: [
+    { id: 7, email: 'michael.lawson@reqres.in' },
+    { id: 8, email: 'lindsay.ferguson@reqres.in' },
+    { id: 9, email: 'tobias.funke@reqres.in' },
+    { id: 10, email: 'byron.fields@reqres.in' },
+    { id: 11, email: 'george.edwards@reqres.in' },
+    { id: 12, email: 'rachel.howell@reqres.in' }
+  ]
+}
+Here is a TS strongly-typed field: michael.lawson@reqres.in
+```
+
+If the API response doesn't match the expected shape (e.g. we expect "other_field" to be presented too), superstruct will throw a descriptive message:
+
+```
+StructError: At path: data.0.other_field -- Expected a number, but received: undefined
+```
+
+## Validation Backends
+
+You can use one of the following libraries to type-enforce the response:
+- [typescript-is](https://www.npmjs.com/package/typescript-is)
+- [superstruct](https://www.npmjs.com/package/superstruct)
+- any other solution which can validate TS object shape against a JSON