Add CLI framework & handlers for connected accounts, action attempts

Author: codetheweb

Diff for: package.json

@@ -9,6 +9,7 @@
   ],
   "version": "2.0.0",
   "license": "MIT",
+  "sideEffects": false,
   "main": "./cjs-wrapper.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
@@ -24,7 +25,10 @@
     "cjs-wrapper.js"
   ],
   "dependencies": {
-    "axios": "0.25.0"
+    "axios": "0.25.0",
+    "change-case": "4.1.2",
+    "ora": "5.4.1",
+    "yargs": "17.3.1"
   },
   "devDependencies": {
     "@semantic-release/commit-analyzer": "9.0.2",
@@ -33,6 +37,7 @@
     "@semantic-release/release-notes-generator": "10.0.3",
     "@swc/core": "1.2.133",
     "@types/node": "17.0.10",
+    "@types/yargs": "17.0.8",
     "ajv": "8.9.0",
     "ava": "4.0.1",
     "esbuild": "0.14.18",
@@ -44,10 +49,10 @@
     "pgknexlove": "1.1.21",
     "prettier": "2.5.1",
     "testcontainers": "8.2.0",
-    "ts-json-schema-generator": "0.97.0",
+    "ts-json-schema-generator": "0.98.0",
     "tsup": "5.11.11",
     "type-fest": "2.11.1",
-    "typedoc": "0.22.11",
+    "typedoc": "0.22.12",
     "typedoc-plugin-markdown": "3.11.12",
     "typescript": "4.5.5"
   },
@@ -58,7 +63,7 @@
     "prepare": "husky install",
     "prepack": "npm run build",
     "build:package": "tsup",
-    "build:docs": "typedoc --plugin typedoc-plugin-markdown --gitRevision main src/index.ts",
+    "build:docs": "typedoc",
     "build": "npm run build:package && npm run build:docs",
     "format": "prettier --write .",
     "format:check": "prettier --check .",

Diff for: src/cli.ts

@@ -0,0 +1,110 @@
+#!/usr/bin/env node
+import yargs from "yargs"
+import { hideBin } from "yargs/helpers"
+import ora from "ora"
+import { paramCase } from "change-case"
+import Seam, { SeamAPIError } from "."
+
+const parser = yargs(hideBin(process.argv))
+
+const executeCommand = async (
+  methodName: string,
+  args: any[],
+  executeArgs: { json?: boolean; quiet?: boolean }
+) => {
+  const displaySpinner = !(executeArgs.quiet || executeArgs.json)
+
+  const spinner = displaySpinner
+    ? ora(
+        methodName
+          .split(".")
+          .map((v) => paramCase(v))
+          .join(".")
+      ).start()
+    : undefined
+
+  const seam = new Seam()
+
+  let method: any = seam
+  for (const path of methodName.split(".")) {
+    method = method[path]
+  }
+
+  try {
+    const result = await method(...args)
+    spinner?.succeed()
+
+    if (executeArgs.json) {
+      console.log(JSON.stringify(result, null, 2))
+    } else {
+      console.log(result)
+    }
+  } catch (error) {
+    let message = "Unknown error"
+    if (error instanceof SeamAPIError) {
+      message = `${error.name} (HTTP ${error.status}): ${error.message}`
+    } else if (error instanceof Error) {
+      message = error.message
+    }
+    spinner?.fail(message)
+    process.exit(1)
+  }
+}
+
+parser
+  .option("api-key", {
+    describe:
+      "Seam API key (the environment variable SEAM_API_KEY is used if not provided)",
+  })
+  .option("quiet", {
+    describe: "Hide progress indicators",
+    type: "boolean",
+  })
+  .option("json", {
+    describe: "Output JSON",
+    type: "boolean",
+  })
+  .command(
+    "connected-accounts",
+    "interact with connected accounts",
+    (yargs) => {
+      yargs
+        .command(
+          "list",
+          "list connected accounts",
+          () => {},
+          async (argv) => {
+            await executeCommand("connectedAccounts.list", [], argv)
+          }
+        )
+        .command(
+          "get <id>",
+          "get a connected account",
+          (yargs) => {
+            return yargs.positional("id", {
+              describe: "the connected account ID",
+              demandOption: true,
+            })
+          },
+          async (argv) => {
+            await executeCommand("connectedAccounts.get", [argv.id], argv)
+          }
+        )
+    }
+  )
+  .command("action-attempts", "interact with action attempts", (yargs) => {
+    yargs.command(
+      "get <id>",
+      "get an action attempt",
+      (yargs) => {
+        return yargs.positional("id", {
+          describe: "the action attempt ID",
+          demandOption: true,
+        })
+      },
+      async (argv) => {
+        await executeCommand("actionAttempts.get", [argv.id], argv)
+      }
+    )
+  })
+  .parse()

Diff for: typedoc.json

@@ -0,0 +1,5 @@
+{
+  "plugin": "typedoc-plugin-markdown",
+  "gitRevision": "main",
+  "entryPoints": "src/index.ts"
+}