@useshortcut/client 1.0.0-beta.0

package/README.md

@@ -0,0 +1,80 @@
+<p align="center">
+  <img height="60" src="https://user-images.githubusercontent.com/7189823/133838642-9a05e1ec-9a79-46ae-b22e-a8b931caf233.png" alt="Shortcut logo">
+</p>
+
+<h3 align="center">
+  @useshortcut/client
+</h3>
+
+<p align="center">
+  A library for interacting with the Shortcut (formerly Clubhouse) REST API
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.org/package/clubhouse-lib">
+    <img src="https://badge.fury.io/js/clubhouse-lib.svg" alt="Current npm package version." />
+  </a>
+  <a href="https://circleci.com/gh/useshortcut/clubhouse-lib">
+    <img src="https://circleci.com/gh/useshortcut/clubhouse-lib.svg?style=shield" alt="Current CircleCI build status." />
+  </a>
+  <a href="https://circleci.com/gh/useshortcut/clubhouse-lib">
+    <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs welcome!" />
+  </a>
+  <a href="https://twitter.com/intent/follow?screen_name=useshortcut">
+    <img src="https://img.shields.io/twitter/follow/useshortcut.svg?label=Follow%20@useshortcut" alt="Follow @useshortcut" />
+  </a>
+</p>
+
+<br>
+
+## Getting Started
+
+### Installation
+
+You can install `@useshortcut/client` with [NPM](https://www.npmjs.com/) or [Yarn](https://yarnpkg.com).
+
+```shell
+npm install --save @useshortcut/client
+```
+
+or
+
+```shell
+yarn add @useshortcut/client
+```
+
+### How to Get an API Token
+
+The Shortcut API uses token-based authentication, you will need one to use this library.
+
+To generate an API token, go to https://app.shortcut.com/settings/account/api-tokens. To make it easier to explore our API, we recommend saving this token as an environment variable in your local dev environment:
+
+```bash
+export SHORTCUT_API_TOKEN="YOUR API TOKEN HERE"
+```
+
+This will allow you to copy and paste many examples in the documentation to try them out.
+
+Requests made with a missing or invalid token will get a `401 Unauthorized` response. All requests must be made over HTTPS. Tokens provide complete access to your Shortcut account, **so keep them secure**. Don’t paste them into your source code, use an environment variable instead. For security reasons, we will immediately invalidate any tokens we find have been made public.
+
+## Usage
+
+```javascript
+import { ShortcutApi } from './';
+
+const shortcut = new ShortcutApi('YOUR_API_TOKEN'); // See https://github.com/useshortcut/clubhouse-lib#how-to-get-an-api-token
+
+shortcut.getCurrentMemberInfo().then((response) => console.log(response?.data));
+
+shortcut.listProjects().then((response) => console.log(response?.data));
+```
+
+## Play with It
+
+You can play with it in your web browser with this live playground: 
+
+- [CodeSandbox](https://codesandbox.io/s/clubhouse-lib-playground-r447i)
+
+## Documentation
+
+[Documentation for the REST API](https://shortcut.com/api/rest).

package/lib/ShortcutApi.d.ts

@@ -0,0 +1,5 @@
+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

@@ -0,0 +1,45 @@
+"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;