@useshortcut/client 1.0.0 → 2.0.0

package/package.json

@@ -1,60 +1,50 @@
 {
   "name": "@useshortcut/client",
-  "version": "1.0.0",
-  "description": "A Promise based library to the Shortcut (formerly Clubhouse) REST API",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
-  "files": [
-    "lib"
-  ],
+  "version": "2.0.0",
+  "description": "A Promise based library to the Shortcut REST API",
+  "homepage": "https://github.com/useshortcut/shortcut-client-js",
   "bugs": {
     "url": "https://github.com/useshortcut/shortcut-client-js/issues"
   },
-  "homepage": "https://github.com/useshortcut/shortcut-client-js",
-  "readme": "https://github.com/useshortcut/shortcut-client-js#readme",
   "repository": {
     "type": "git",
     "url": "https://github.com/useshortcut/shortcut-client-js.git"
   },
   "license": "MIT",
+  "sideEffects": false,
+  "type": "commonjs",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./lib/index.d.mts",
+        "default": "./lib/index.mjs"
+      },
+      "require": {
+        "types": "./lib/index.d.ts",
+        "default": "./lib/index.js"
+      }
+    }
+  },
+  "main": "./lib/index.js",
+  "module": "./lib/index.mjs",
+  "types": "./lib/index.d.ts",
+  "files": [
+    "lib"
+  ],
   "scripts": {
-    "build": "yarn build:client && tsc",
-    "build:client": "swagger-typescript-api -p ./schema/shortcut.swagger.json -o ./src/generated --clean-output --axios --modular --templates ./templates && yarn add-typedoc-comments",
-    "build:docs": "typedoc --entryPointStrategy expand ./src --exclude 'src/__tests__/**'",
-    "sync:schema": "wget https://shortcut.com/api/rest/v3/shortcut.swagger.json --destination ./schema/shortcut.swagger.json && yarn validate:schema",
-    "validate:schema": "swagger-cli validate ./schema/shortcut.swagger.json",
-    "validate:examples": "npx tsc examples/*.ts --noEmit",
-    "add-typedoc-comments": "node ./node_modules/.bin/jscodeshift -t scripts/add-typedoc-comments-transform.js src/generated/**",
+    "build": "yarn build:client && yarn build:add-typedoc-comments && tsup",
+    "build:add-typedoc-comments": "npx jscodeshift -t scripts/add-typedoc-comments.ts --extensions=ts --parser=ts src/generated/**",
+    "build:client": "swagger-typescript-api generate --path ./schema/shortcut.swagger.json --output ./src/generated --clean-output --axios --modular --templates ./templates",
+    "build:docs": "typedoc ./src --exclude 'src/__tests__/**'",
+    "check-exports": "attw --pack .",
+    "format": "prettier --write -l *.{json,md,prettierrc} '{src,scripts}/**/*.ts'",
+    "format:check": "prettier --check *.{json,md,prettierrc} '{src,scripts}/**/*.ts'",
     "lint": "eslint 'src/**/*.{js,ts}'",
+    "prepublishOnly": "yarn build",
+    "sync:schema": "curl --silent https://developer.shortcut.com/api/rest/v3/shortcut.swagger.json --output ./schema/shortcut.swagger.json && yarn validate:schema",
     "test": "jest",
-    "prepublishOnly": "yarn build"
-  },
-  "dependencies": {
-    "axios": "^0.21.3",
-    "form-data": "^4.0.0"
-  },
-  "devDependencies": {
-    "@types/jest": "^27.0.2",
-    "@types/node": "^16.10.3",
-    "@typescript-eslint/eslint-plugin": "^4.33.0",
-    "@typescript-eslint/parser": "^4.33.0",
-    "eslint": "^7.32.0",
-    "eslint-config-airbnb-base": "^14.2.1",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-import": "^2.24.2",
-    "eslint-plugin-jest": "^24.5.2",
-    "eslint-plugin-prettier": "^4.0.0",
-    "jest": "^27.2.4",
-    "jscodeshift": "^0.13.0",
-    "node-wget": "^0.4.3",
-    "prettier": "2.4.1",
-    "rimraf": "^3.0.2",
-    "swagger-cli": "^4.0.4",
-    "swagger-typescript-api": "9.2.0",
-    "ts-jest": "^27.0.5",
-    "typedoc": "0.22.5",
-    "typedoc-plugin-merge-modules": "3.0.2",
-    "typescript": "4.4.3"
+    "validate:examples": "npx tsc examples/*.ts --noEmit",
+    "validate:schema": "swagger-cli validate ./schema/shortcut.swagger.json"
   },
   "jest": {
     "preset": "ts-jest",
@@ -63,5 +53,37 @@
       "<rootDir>/lib/",
       "<rootDir>/node_modules/"
     ]
-  }
+  },
+  "dependencies": {
+    "axios": "^1.9.0"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.1",
+    "@total-typescript/tsconfig": "^1.0.4",
+    "@types/glob": "^8.1.0",
+    "@types/jest": "^29.5.14",
+    "@types/jscodeshift": "17.3.0",
+    "@types/node": "^22.15.30",
+    "@typescript-eslint/eslint-plugin": "^8.33.1",
+    "@typescript-eslint/parser": "^8.33.1",
+    "eslint": "^8.57.1",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-prettier": "^10.1.5",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-jest": "^28.12.0",
+    "eslint-plugin-prettier": "^5.4.1",
+    "glob": "^11.0.2",
+    "jest": "^29.7.0",
+    "jscodeshift": "^17.3.0",
+    "prettier": "^3.5.3",
+    "stream-to-blob": "^2.0.1",
+    "swagger-cli": "^4.0.4",
+    "swagger-typescript-api": "^13.2.0",
+    "ts-jest": "^29.3.4",
+    "tsup": "^8.5.0",
+    "typedoc": "0.28.5",
+    "typedoc-plugin-merge-modules": "7.0.0",
+    "typescript": "^5.8.3"
+  },
+  "readme": "https://github.com/useshortcut/shortcut-client-js#readme"
 }

package/lib/ShortcutApi.d.ts

@@ -1,5 +0,0 @@
-import { Api } from './generated/Api';
-import type { ApiConfig } from './generated/http-client';
-export declare class ShortcutApi<SecurityDataType = unknown> extends Api<SecurityDataType> {
-    constructor(apiToken: string, config?: ApiConfig<SecurityDataType>);
-}

package/lib/ShortcutApi.js

@@ -1,45 +0,0 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ShortcutApi = void 0;
-var Api_1 = require("./generated/Api");
-var ShortcutApi = /** @class */ (function (_super) {
-    __extends(ShortcutApi, _super);
-    function ShortcutApi(apiToken, config) {
-        if (config === void 0) { config = {}; }
-        var _this = this;
-        if (apiToken == null || typeof apiToken !== 'string') {
-            // eslint-disable-next-line no-console
-            console.error('You need to supply an API Token.');
-        }
-        _this = _super.call(this, __assign({ headers: __assign({ 'Shortcut-Token': apiToken }, config.headers) }, config)) || this;
-        return _this;
-    }
-    return ShortcutApi;
-}(Api_1.Api));
-exports.ShortcutApi = ShortcutApi;