Add external_links to Story type (#93)

.circleci/config.yml

@@ -1,4 +1,10 @@
+version: 2.1
+
 aliases:
+  - &defaults
+    resource_class: small
+    docker:
+      - image: cimg/node:lts
   - &save-cache-yarn
     key: yarn-packages-{{ checksum "yarn.lock" }}
     paths:
@@ -7,16 +13,20 @@ aliases:
     name: Restore Yarn Package Cache
     keys:
       - yarn-packages-{{ checksum "yarn.lock" }}
-  - &attach_workspace
-    attach_workspace:
-      at: ~/clubhouse-lib
 
-defaults: &defaults
-  working_directory: ~/clubhouse-lib
-  docker:
-    - image: circleci/node:14
+commands:
+  persist-workspace:
+    steps:
+      - persist_to_workspace:
+          root: ~/
+          paths:
+            - project
+  attach-workspace:
+    steps:
+      - attach_workspace:
+          at: ~/
+      - run: yarn install
 
-version: 2
 jobs:
   checkout:
     <<: *defaults
@@ -31,42 +41,69 @@ jobs:
           command: |
             yarn install --frozen-lockfile --no-progress --non-interactive --cache-folder ~/.cache/yarn
       - save_cache: *save-cache-yarn
-      - persist_to_workspace:
-          root: .
-          paths: .
+      - persist-workspace
   lint:
     <<: *defaults
     steps:
-      - *attach_workspace
+      - attach-workspace
       - run:
           name: Lint
           command: yarn lint
+  validate-schema:
+    <<: *defaults
+    steps:
+      - attach-workspace
+      - run:
+          name: Validate Schema
+          command: yarn validate:schema
   test:
     <<: *defaults
     steps:
-      - *attach_workspace
+      - attach-workspace
       - run:
           name: Run Jest
           command: yarn test
+  format-check:
+    <<: *defaults
+    steps:
+      - attach-workspace
+      - run:
+          name: Format Check
+          command: yarn format:check
+  validate-examples:
+    <<: *defaults
+    steps:
+      - attach-workspace
+      - run:
+          name: Run TSC
+          command: yarn validate:examples
   build:
     <<: *defaults
     steps:
-      - *attach_workspace
+      - attach-workspace
       - run:
           name: Build
           command: yarn build
 
 workflows:
-  version: 2
   tests:
     jobs:
       - checkout
       - lint:
           requires:
             - checkout
+      - validate-schema:
+          requires:
+            - checkout
       - test:
           requires:
             - checkout
+      - validate-examples:
+          requires:
+            - checkout
+      - format-check:
+          requires:
+            - checkout
       - build:
           requires:
             - checkout

.eslintignore

@@ -0,0 +1 @@
+/src/generated

.eslintrc

@@ -1,7 +1,7 @@
 {
   "parser": "@typescript-eslint/parser",
   "extends": [
-    "airbnb",
+    "airbnb-base",
     "plugin:@typescript-eslint/recommended",
     "prettier",
     "plugin:prettier/recommended"
@@ -10,13 +10,21 @@
     "sourceType": "module"
   },
   "settings": {
-    "import/extensions": [".js", ".ts"],
+    "import/extensions": [
+      ".js",
+      ".ts"
+    ],
     "import/parsers": {
-      "@typescript-eslint/parser": [".ts"]
+      "@typescript-eslint/parser": [
+        ".ts"
+      ]
     },
     "import/resolver": {
       "node": {
-        "extensions": [".js", ".ts"]
+        "extensions": [
+          ".js",
+          ".ts"
+        ]
       }
     }
   },
@@ -29,10 +37,12 @@
     "jest": true,
     "es6": true
   },
-   "rules": {
-      "no-undef": 0,
-      "import/extensions": 0,
-      "@typescript-eslint/camelcase": 0,
-      "@typescript-eslint/no-explicit-any": 0
-   }
+  "rules": {
+    "no-undef": 0,
+    "import/extensions": 0,
+    "import/prefer-default-export": 0,
+    "@typescript-eslint/camelcase": 0,
+    "@typescript-eslint/no-explicit-any": 0,
+    "no-restricted-exports": 0
+  }
 }

.github/workflows/gh-pages.yml

@@ -0,0 +1,31 @@
+name: "GitHub Pages"
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write # Required for deploying pages
+      pages: write # Required for deploying pages
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup Node
+        uses: actions/setup-node@v2
+        with:
+          node-version: 'lts/*'
+          cache: 'yarn'
+
+      - run: yarn install
+      - run: yarn build:client
+      - run: yarn build:docs
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs

.gitignore

@@ -4,3 +4,5 @@ lib/
 node_modules/
 npm-debug.log
 package-lock.json
+/docs
+*.log

.npmignore

@@ -2,3 +2,5 @@
 .DS_Store
 /src
 **/__tests__/**
+/docs
+/schema

.prettierignore

@@ -0,0 +1,2 @@
+/src/generated
+/schema

.prettierrc

@@ -1,5 +1,14 @@
 {
-  "parser": "typescript",
+  "singleQuote": true,
+  "semi": true,
   "trailingComma": "all",
-  "singleQuote": true
+  "arrowParens": "always",
+  "overrides": [
+    {
+      "files": "*.ts",
+      "options": {
+        "parser": "typescript"
+      }
+    }
+  ]
 }

README.md

@@ -1,27 +1,27 @@
 <p align="center">
-  <img height="60" src="https://user-images.githubusercontent.com/7189823/67512945-deb55180-f667-11e9-823f-023d1629f868.png" alt="Clubhouse logo">
+  <img height="60" src="https://github.com/useshortcut/shortcut-client-js/assets/739719/b1a2efa0-6de1-4bc4-8525-563c53a9b2ba" alt="Shortcut" />
 </p>
 
 <h3 align="center">
-  Clubhouse-lib
+  @shortcut/client
 </h3>
 
 <p align="center">
-  A library for interacting with the Clubhouse REST API
+  A library for interacting with the Shortcut 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 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/clubhouse/clubhouse-lib">
-    <img src="https://circleci.com/gh/clubhouse/clubhouse-lib.svg?style=shield" alt="Current CircleCI build status." />
+  <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/clubhouse/clubhouse-lib">
+  <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=clubhouse">
-    <img src="https://img.shields.io/twitter/follow/clubhouse.svg?label=Follow%20@clubhouse" alt="Follow @clubhouse" />
+  <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>
 
@@ -31,54 +31,57 @@
 
 ### Installation
 
-You can install clubhouse-lib with [NPM](https://www.npmjs.com/) or [Yarn](https://yarnpkg.com).
+You can install `@shortcut/client` with [NPM](https://www.npmjs.com/) or [Yarn](https://yarnpkg.com).
 
 ```shell
-npm install --save clubhouse-lib
+npm install --save @shortcut/client
 ```
 
 or
 
 ```shell
-yarn add clubhouse-lib
+yarn add @shortcut/client
 ```
 
-### How To Get an API Token
+> 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.
 
-The Clubhouse API uses token-based authentication, you will need one to use this library.
+### How to Get an API Token
 
-To generate an API token, go to https://app.clubhouse.io/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:
+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 CLUBHOUSE_API_TOKEN="YOUR API TOKEN HERE"
+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 Clubhouse 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.
+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 Clubhouse from 'clubhouse-lib';
+To see all available exports, take a look at the [API documentation](https://useshortcut.github.io/shortcut-client-js/) or check out the `.d.ts` files in this repository.
 
-const client = Clubhouse.create('your token value'); // See https://github.com/clubhouse/clubhouse-lib#how-to-get-an-api-token
+```javascript
+import { ShortcutClient } from '@shortcut/client';
+// const { ShortcutClient } = require('@shortcut/client');
 
-client.listMembers().then(console.log);
+const shortcut = new ShortcutClient('YOUR_API_TOKEN'); // See https://github.com/useshortcut/shortcut-client-js#how-to-get-an-api-token
 
-client.getMember('')
-  .catch(x => console.error(x.body))
-  .then(console.log);
+shortcut.getCurrentMemberInfo().then((response) => console.log(response?.data));
 
-client.listProjects().then(console.log);
+shortcut.listProjects().then((response) => console.log(response?.data));
 ```
 
 ## Play with It
 
-You can play with it in your web browser with this live playground: 
+You can play with it in your web browser with this live playground:
 
-- [CodeSandbox](https://codesandbox.io/s/clubhouse-lib-playground-r447i)
+- [CodeSandbox](https://codesandbox.io/s/useshortcut-client-playground-48kq1)
 
 ## Documentation
 
-[Documentation for the REST API](https://clubhouse.io/api/rest).
+[Documentation for this client](https://useshortcut.github.io/shortcut-client-js/).
+
+[Documentation for the REST API](https://developer.shortcut.com/api/rest/v3).

docker-compose.yml

@@ -0,0 +1,11 @@
+version: '3.8'
+
+services:
+  shortcut-client-js:
+    container_name: shortcut-client-js
+    image: node:20
+    stdin_open: true
+    tty: true
+    volumes:
+      - .:/shortcut-client-js
+    working_dir: /shortcut-client-js

examples/.eslintrc

@@ -0,0 +1,6 @@
+{
+  "rules": {
+    "no-console": 0,
+    "import/no-extraneous-dependencies": 0
+  }
+}

examples/README.md

@@ -0,0 +1,13 @@
+# Examples
+
+This folder contains ready-to-use examples.
+
+## Usage
+
+You will need to set an environment variable with your API Token. See [How to Get an API Token](../README.md#how-to-get-an-api-token).
+
+Then, you can run the file you want with:
+
+```bash
+SHORTCUT_API_TOKEN=YOUR_API_TOKEN npx ts-node FILE_EXAMPLE
+```

examples/getCurrentMemberInfo.ts

@@ -0,0 +1,5 @@
+import { ShortcutClient } from '../src';
+
+const shortcut = new ShortcutClient(process.env.SHORTCUT_API_TOKEN); // See https://github.com/useshortcut/shortcut-client-js#how-to-get-an-api-token
+
+shortcut.getCurrentMemberInfo().then((response) => console.log(response?.data));

examples/listProjects.ts

@@ -0,0 +1,5 @@
+import { ShortcutClient } from '../src';
+
+const shortcut = new ShortcutClient(process.env.SHORTCUT_API_TOKEN); // See https://github.com/useshortcut/shortcut-client-js#how-to-get-an-api-token
+
+shortcut.listProjects().then((response) => console.log(response?.data));