@useshortcut/client 1.0.0-beta.0

package/lib/generated/data-contracts.js

@@ -0,0 +1,12 @@
+"use strict";
+/* eslint-disable */
+/* tslint:disable */
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,39 @@
+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"> {
+    /** set parameter to `true` for call `securityWorker` for this request */
+    secure?: boolean;
+    /** request path */
+    path: string;
+    /** content type of request body */
+    type?: ContentType;
+    /** query params */
+    query?: QueryParamsType;
+    /** format of response (i.e. response.json() -> format: "json") */
+    format?: ResponseType;
+    /** request body */
+    body?: unknown;
+}
+export declare 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;
+}
+export declare enum ContentType {
+    Json = "application/json",
+    FormData = "multipart/form-data",
+    UrlEncoded = "application/x-www-form-urlencoded"
+}
+export declare class HttpClient<SecurityDataType = unknown> {
+    instance: AxiosInstance;
+    private securityData;
+    private securityWorker?;
+    private secure?;
+    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>>;
+}

package/lib/generated/http-client.js

@@ -0,0 +1,134 @@
+"use strict";
+/* eslint-disable */
+/* tslint:disable */
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## 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) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        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)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpClient = exports.ContentType = void 0;
+var axios_1 = require("axios");
+var FormData = require("form-data");
+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 = {}));
+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"]);
+        this.securityData = null;
+        this.setSecurityData = function (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.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);
+            return formData;
+        }, new FormData());
+    };
+    return HttpClient;
+}());
+exports.HttpClient = HttpClient;

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export * from './ShortcutApi';
+export * from './generated/data-contracts';

package/lib/index.js

@@ -0,0 +1,14 @@
+"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]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ShortcutApi"), exports);
+__exportStar(require("./generated/data-contracts"), exports);

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@useshortcut/client",
+  "version": "1.0.0-beta.0",
+  "description": "A Promise based library to the Shortcut (formerly Clubhouse) REST API",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib"
+  ],
+  "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",
+  "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",
+    "build:docs": "typedoc ./src",
+    "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",
+    "lint": "eslint 'src/**/*.{js,ts}'",
+    "test": "jest",
+    "prepublishOnly": "yarn build"
+  },
+  "dependencies": {
+    "axios": "^0.21.4",
+    "form-data": "^4.0.0"
+  },
+  "devDependencies": {
+    "@types/jest": "^27.0.1",
+    "@types/node": "^16.9.2",
+    "@typescript-eslint/eslint-plugin": "^4.31.1",
+    "@typescript-eslint/parser": "^4.31.1",
+    "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.4.2",
+    "eslint-plugin-prettier": "^4.0.0",
+    "jest": "^27.2.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.21.9",
+    "typedoc-plugin-merge-modules": "3.0.1",
+    "typescript": "4.4.3"
+  },
+  "jest": {
+    "preset": "ts-jest",
+    "testEnvironment": "node",
+    "testPathIgnorePatterns": [
+      "<rootDir>/lib/",
+      "<rootDir>/node_modules/"
+    ]
+  }
+}