@useshortcut/client 1.0.0-beta.1 → 1.1.0

package/lib/generated/http-client.d.ts

@@ -1,6 +1,6 @@
-import { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
-export declare type QueryParamsType = Record<string | number, any>;
-export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
+import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from 'axios';
+export type QueryParamsType = Record<string | number, any>;
+export interface FullRequestParams extends Omit<AxiosRequestConfig, 'data' | 'params' | 'url' | 'responseType'> {
     /** set parameter to `true` for call `securityWorker` for this request */
     secure?: boolean;
     /** request path */
@@ -14,8 +14,8 @@ export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "pa
     /** request body */
     body?: unknown;
 }
-export declare type RequestParams = Omit<FullRequestParams, "body" | "method" | "query" | "path">;
-export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequestConfig, "data" | "cancelToken"> {
+export type RequestParams = Omit<FullRequestParams, 'body' | 'method' | 'query' | 'path'>;
+export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequestConfig, 'data' | 'cancelToken'> {
     securityWorker?: (securityData: SecurityDataType | null) => Promise<AxiosRequestConfig | void> | AxiosRequestConfig | void;
     secure?: boolean;
     format?: ResponseType;
@@ -23,12 +23,13 @@ export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequest
 export declare enum ContentType {
     Json = "application/json",
     FormData = "multipart/form-data",
-    UrlEncoded = "application/x-www-form-urlencoded"
+    UrlEncoded = "application/x-www-form-urlencoded",
+    Text = "text/plain"
 }
 /**
-* @internal
-* @private
-*/
+ * @internal
+ * @private
+ */
 export declare class HttpClient<SecurityDataType = unknown> {
     instance: AxiosInstance;
     private securityData;
@@ -37,7 +38,8 @@ export declare class HttpClient<SecurityDataType = unknown> {
     private format?;
     constructor({ securityWorker, secure, format, ...axiosConfig }?: ApiConfig<SecurityDataType>);
     setSecurityData: (data: SecurityDataType | null) => void;
-    private mergeRequestParams;
-    private createFormData;
-    request: <T = any, _E = any>({ secure, path, type, query, format, body, ...params }: FullRequestParams) => Promise<AxiosResponse<T>>;
+    protected mergeRequestParams(params1: AxiosRequestConfig, params2?: AxiosRequestConfig): AxiosRequestConfig;
+    protected stringifyFormItem(formItem: unknown): string;
+    protected createFormData(input: Record<string, unknown>): FormData;
+    request: <T = any, _E = any>({ secure, path, type, query, format, body, ...params }: FullRequestParams) => Promise<AxiosResponse<T, any>>;
 }

package/lib/generated/http-client.js

@@ -9,17 +9,6 @@
  * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
  * ---------------------------------------------------------------
  */
-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);
-};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -29,33 +18,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
 var __rest = (this && this.__rest) || function (s, e) {
     var t = {};
     for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
@@ -69,70 +31,68 @@ var __rest = (this && this.__rest) || function (s, e) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HttpClient = exports.ContentType = void 0;
-var axios_1 = require("axios");
-var FormData = require("form-data");
+const axios_1 = require("axios");
 var ContentType;
 (function (ContentType) {
     ContentType["Json"] = "application/json";
     ContentType["FormData"] = "multipart/form-data";
     ContentType["UrlEncoded"] = "application/x-www-form-urlencoded";
-})(ContentType = exports.ContentType || (exports.ContentType = {}));
+    ContentType["Text"] = "text/plain";
+})(ContentType || (exports.ContentType = ContentType = {}));
 /**
-* @internal
-* @private
-*/
-var HttpClient = /** @class */ (function () {
-    function HttpClient(_a) {
-        var _this = this;
-        if (_a === void 0) { _a = {}; }
-        var securityWorker = _a.securityWorker, secure = _a.secure, format = _a.format, axiosConfig = __rest(_a, ["securityWorker", "secure", "format"]);
+ * @internal
+ * @private
+ */
+class HttpClient {
+    constructor(_a = {}) {
+        var { securityWorker, secure, format } = _a, axiosConfig = __rest(_a, ["securityWorker", "secure", "format"]);
         this.securityData = null;
-        this.setSecurityData = function (data) {
-            _this.securityData = data;
+        this.setSecurityData = (data) => {
+            this.securityData = data;
         };
-        this.request = function (_a) { return __awaiter(_this, void 0, void 0, function () {
-            var secureParams, _b, requestParams, responseFormat;
-            var secure = _a.secure, path = _a.path, type = _a.type, query = _a.query, format = _a.format, body = _a.body, params = __rest(_a, ["secure", "path", "type", "query", "format", "body"]);
-            return __generator(this, function (_c) {
-                switch (_c.label) {
-                    case 0:
-                        _b = (typeof secure === "boolean" ? secure : this.secure) &&
-                            this.securityWorker;
-                        if (!_b) return [3 /*break*/, 2];
-                        return [4 /*yield*/, this.securityWorker(this.securityData)];
-                    case 1:
-                        _b = (_c.sent());
-                        _c.label = 2;
-                    case 2:
-                        secureParams = (_b) ||
-                            {};
-                        requestParams = this.mergeRequestParams(params, secureParams);
-                        responseFormat = (format && this.format) || void 0;
-                        if (type === ContentType.FormData && body && body !== null && typeof body === "object") {
-                            requestParams.headers.common = { Accept: "*/*" };
-                            requestParams.headers.post = {};
-                            requestParams.headers.put = {};
-                            body = this.createFormData(body);
-                        }
-                        return [2 /*return*/, this.instance.request(__assign(__assign({}, requestParams), { headers: __assign(__assign(__assign({}, (type && type !== ContentType.FormData ? { "Content-Type": type } : {})), (body instanceof FormData ? { "Content-Type": body.getHeaders()["content-type"] } : {})), (requestParams.headers || {})), params: query, responseType: responseFormat, data: body, url: path }))];
-                }
-            });
-        }); };
-        this.instance = axios_1.default.create(__assign(__assign({}, axiosConfig), { baseURL: axiosConfig.baseURL || "https://api.app.shortcut.com" }));
+        this.request = (_b) => __awaiter(this, void 0, void 0, function* () {
+            var { secure, path, type, query, format, body } = _b, params = __rest(_b, ["secure", "path", "type", "query", "format", "body"]);
+            const secureParams = ((typeof secure === 'boolean' ? secure : this.secure) &&
+                this.securityWorker &&
+                (yield this.securityWorker(this.securityData))) ||
+                {};
+            const requestParams = this.mergeRequestParams(params, secureParams);
+            const responseFormat = format || this.format || undefined;
+            if (type === ContentType.FormData && body && body !== null && typeof body === 'object') {
+                body = this.createFormData(body);
+            }
+            if (type === ContentType.Text && body && body !== null && typeof body !== 'string') {
+                body = JSON.stringify(body);
+            }
+            return this.instance.request(Object.assign(Object.assign({}, requestParams), { headers: Object.assign(Object.assign({}, (requestParams.headers || {})), (type && type !== ContentType.FormData ? { 'Content-Type': type } : {})), params: query, responseType: responseFormat, data: body, url: path }));
+        });
+        this.instance = axios_1.default.create(Object.assign(Object.assign({}, axiosConfig), { baseURL: axiosConfig.baseURL || 'https://api.app.shortcut.com' }));
         this.secure = secure;
         this.format = format;
         this.securityWorker = securityWorker;
     }
-    HttpClient.prototype.mergeRequestParams = function (params1, params2) {
-        return __assign(__assign(__assign(__assign({}, this.instance.defaults), params1), (params2 || {})), { headers: __assign(__assign(__assign({}, (this.instance.defaults.headers || {})), (params1.headers || {})), ((params2 && params2.headers) || {})) });
-    };
-    HttpClient.prototype.createFormData = function (input) {
-        return Object.keys(input || {}).reduce(function (formData, key) {
-            var property = input[key];
-            formData.append(key, property);
+    mergeRequestParams(params1, params2) {
+        const method = params1.method || (params2 && params2.method);
+        return Object.assign(Object.assign(Object.assign(Object.assign({}, this.instance.defaults), params1), (params2 || {})), { headers: Object.assign(Object.assign(Object.assign({}, ((method && this.instance.defaults.headers[method.toLowerCase()]) || {})), (params1.headers || {})), ((params2 && params2.headers) || {})) });
+    }
+    stringifyFormItem(formItem) {
+        if (typeof formItem === 'object' && formItem !== null) {
+            return JSON.stringify(formItem);
+        }
+        else {
+            return `${formItem}`;
+        }
+    }
+    createFormData(input) {
+        return Object.keys(input || {}).reduce((formData, key) => {
+            const property = input[key];
+            const propertyContent = property instanceof Array ? property : [property];
+            for (const formItem of propertyContent) {
+                const isFileType = formItem instanceof Blob;
+                formData.append(key, isFileType ? formItem : this.stringifyFormItem(formItem));
+            }
             return formData;
         }, new FormData());
-    };
-    return HttpClient;
-}());
+    }
+}
 exports.HttpClient = HttpClient;

package/lib/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@useshortcut/client",
-  "version": "1.0.0-beta.1",
-  "description": "A Promise based library to the Shortcut (formerly Clubhouse) REST API",
+  "version": "1.1.0",
+  "description": "A Promise based library to the Shortcut REST API",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "files": [
@@ -18,43 +18,45 @@
   },
   "license": "MIT",
   "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",
+    "build": "yarn build:client && yarn build:add-typedoc-comments && tsc",
+    "build:client": "swagger-typescript-api -p ./schema/shortcut.swagger.json -o ./src/generated --clean-output --axios --modular --templates ./templates",
+    "build:add-typedoc-comments": "npx jscodeshift -t scripts/add-typedoc-comments.ts --extensions=ts --parser=ts src/generated/**",
+    "build:docs": "typedoc ./src --exclude 'src/__tests__/**'",
     "validate:examples": "npx tsc examples/*.ts --noEmit",
-    "add-typedoc-comments": "node ./node_modules/.bin/jscodeshift -t scripts/add-typedoc-comments-transform.js src/generated/**",
+    "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",
+    "validate:schema": "swagger-cli validate ./schema/shortcut.swagger.json",
     "lint": "eslint 'src/**/*.{js,ts}'",
     "test": "jest",
-    "prepublishOnly": "yarn build"
+    "format": "prettier --write -l *.{json,md,prettierrc} '{src,scripts}/**/*.ts'",
+    "format:check": "prettier --check *.{json,md,prettierrc} '{src,scripts}/**/*.ts'"
   },
   "dependencies": {
-    "axios": "^0.21.3",
-    "form-data": "^4.0.0"
+    "axios": "^1.5.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",
+    "@types/jest": "^29.5.4",
+    "@types/jscodeshift": "0.11.6",
+    "@types/node": "^20.5.7",
+    "@typescript-eslint/eslint-plugin": "^6.5.0",
+    "@typescript-eslint/parser": "^6.5.0",
+    "eslint": "^8.48.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-import": "^2.28.1",
+    "eslint-plugin-jest": "^27.2.3",
+    "eslint-plugin-prettier": "^5.0.0",
+    "jest": "^29.6.4",
+    "jscodeshift": "^0.15.0",
+    "prettier": "^3.0.3",
+    "rimraf": "^5.0.1",
+    "stream-to-blob": "^2.0.1",
     "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"
+    "swagger-typescript-api": "^13.0.3",
+    "ts-jest": "^29.1.1",
+    "typedoc": "0.25.0",
+    "typedoc-plugin-merge-modules": "5.1.0",
+    "typescript": "^5.2.2"
   },
   "jest": {
     "preset": "ts-jest",

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;