@shortcut/client 1.1.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,45 @@
+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 */
+    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 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",
+    Text = "text/plain"
+}
+/**
+ * @internal
+ * @private
+ */
+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;
+    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

@@ -0,0 +1,98 @@
+"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 __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 __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;
+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["Text"] = "text/plain";
+})(ContentType || (exports.ContentType = ContentType = {}));
+/**
+ * @internal
+ * @private
+ */
+class HttpClient {
+    constructor(_a = {}) {
+        var { securityWorker, secure, format } = _a, axiosConfig = __rest(_a, ["securityWorker", "secure", "format"]);
+        this.securityData = null;
+        this.setSecurityData = (data) => {
+            this.securityData = data;
+        };
+        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;
+    }
+    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());
+    }
+}
+exports.HttpClient = HttpClient;

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+export { ShortcutClient as default } from './ShortcutClient';
+export * from './ShortcutClient';
+export * from './generated/data-contracts';

package/lib/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = 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];
+}));
+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 });
+exports.default = void 0;
+var ShortcutClient_1 = require("./ShortcutClient");
+Object.defineProperty(exports, "default", { enumerable: true, get: function () { return ShortcutClient_1.ShortcutClient; } });
+__exportStar(require("./ShortcutClient"), exports);
+__exportStar(require("./generated/data-contracts"), exports);

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@shortcut/client",
+  "version": "1.1.0",
+  "description": "A Promise based library to the Shortcut 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 && 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",
+    "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",
+    "format": "prettier --write -l *.{json,md,prettierrc} '{src,scripts}/**/*.ts'",
+    "format:check": "prettier --check *.{json,md,prettierrc} '{src,scripts}/**/*.ts'"
+  },
+  "dependencies": {
+    "axios": "^1.5.0"
+  },
+  "devDependencies": {
+    "@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": "^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",
+    "testEnvironment": "node",
+    "testPathIgnorePatterns": [
+      "<rootDir>/lib/",
+      "<rootDir>/node_modules/"
+    ]
+  }
+}