@useshortcut/client 1.1.0 → 2.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Shortcut
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,55 +1,37 @@
-<p align="center">
-  <img height="60" src="https://github.com/useshortcut/shortcut-client-js/assets/739719/b1a2efa0-6de1-4bc4-8525-563c53a9b2ba" alt="Shortcut" />
-</p>
-
-<h3 align="center">
-  @shortcut/client
-</h3>
-
-<p align="center">
-  A library for interacting with the Shortcut REST API.
-</p>
-
-<p align="center">
-  <a href="https://www.npmjs.org/package/@shortcut/client">
-    <img src="https://badge.fury.io/js/@shortcut%2Fclient.svg" alt="Current npm package version." />
-  </a>
-  <a href="https://circleci.com/gh/useshortcut/shortcut-client-js">
-    <img src="https://circleci.com/gh/useshortcut/shortcut-client-js.svg?style=shield" alt="Current CircleCI build status." />
-  </a>
-  <a href="https://circleci.com/gh/useshortcut/shortcut-client-js">
-    <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@shortcut" alt="Follow @shortcut" />
-  </a>
-</p>
-
-<br>
+# @shortcut/client
 
-## Getting Started
+<img height="125" src="https://github.com/user-attachments/assets/7c3d3b8e-6252-4790-81cd-6640cd46a2d6" alt="Shortcut's logo" align="right">
 
-### Installation
+[![Version](https://badge.fury.io/js/@shortcut%2Fclient.svg)](https://badge.fury.io/js/@shortcut%2Fclient)
+[![Monthly Downloads](https://img.shields.io/npm/dm/@shortcut%2Fclient)](https://www.npmjs.org/package/@shortcut%2Fclient)
+[![GitHub License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/useshortcut/shortcut-client-js/blob/main/LICENSE)
+[![PRs welcome!](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)]()
+[![X](https://img.shields.io/twitter/follow/shortcut.svg?label=Follow%20@shortcut)](https://twitter.com/intent/follow?screen_name=shortcut)
 
-You can install `@shortcut/client` with [NPM](https://www.npmjs.com/) or [Yarn](https://yarnpkg.com).
+A library for interacting with the Shortcut REST API.
 
-```shell
-npm install --save @shortcut/client
-```
+<br />
+
+## Getting Started
 
-or
+### Installation
 
 ```shell
-yarn add @shortcut/client
+npm install @shortcut/client
 ```
 
-> Our legacy organization name is `@useshortcut`. While this will still contain copies of all future released package versions, we **strongly** recommended switching to our primary `@shortcut` organization namespace.
+> [!IMPORTANT]
+> Our legacy npm organization namespace is `@useshortcut`.
+>
+> While it will still contain copies of all future released package versions, we **strongly** recommend switching to our primary `@shortcut` organization namespace.
 
 ### 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:
+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"
@@ -57,7 +39,18 @@ 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.
+> [!NOTE]
+> Requests made with a missing or invalid token will get a `401 Unauthorized` response.
+
+> [!NOTE]
+> All requests must be made over HTTPS.
+
+> [!CAUTION]
+> 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
 

package/lib/ShortcutClient.d.mts

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

package/lib/ShortcutClient.d.ts

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