feat: Merge pull request #21 from seamapi/feat-cli-browser

Author: codetheweb

modules.d.ts

@@ -0,0 +1,6 @@
+declare module "https://unpkg.com/[email protected]/browser.mjs" {
+  export const Yargs: any
+}
+declare module "esbuild-plugin-cache" {
+  export const cache: any
+}

package.json

@@ -19,10 +19,15 @@
       "import": "./dist/index.mjs",
       "types": "./dist/index.d.ts"
     },
-    "./cli": {
-      "require": "./dist/cli/index.js",
-      "import": "./dist/cli/index.js",
-      "types": "./dist/cli/index.d.ts"
+    "./cli/browser": {
+      "require": "./dist/cli/browser.js",
+      "import": "./dist/cli/browser.mjs",
+      "types": "./dist/cli/browser.d.ts"
+    },
+    "./dist/cli/browser": {
+      "require": "./dist/cli/browser.js",
+      "import": "./dist/cli/browser.mjs",
+      "types": "./dist/cli/browser.d.ts"
     }
   },
   "files": [
@@ -32,6 +37,8 @@
   "dependencies": {
     "axios": "0.25.0",
     "change-case": "4.1.2",
+    "eventemitter3": "4.0.7",
+    "node-inspect-extracted": "1.1.0",
     "ora": "5.4.1",
     "yargs": "17.3.1"
   },
@@ -46,6 +53,7 @@
     "ajv": "8.9.0",
     "ava": "4.0.1",
     "esbuild": "0.14.18",
+    "esbuild-plugin-cache": "0.2.9",
     "esbuild-runner": "2.2.1",
     "husky": ">=6",
     "knex": "1.0.2",
@@ -58,27 +66,27 @@
     "ts-json-schema-generator": "0.98.0",
     "tsup": "5.11.11",
     "type-fest": "2.11.1",
+    "typed-emitter": "2.1.0",
     "typedoc": "0.22.12",
     "typedoc-plugin-markdown": "3.11.12",
     "typescript": "4.5.5"
   },
   "lint-staged": {
-    "*.{ts,css,md}": "prettier --write"
+    "*.{ts,css,md,js}": "prettier --write"
   },
   "pkg": {
-    "outputPath": "cli-binaries",
-    "assets": "./dist/cli/commands/**/*"
+    "outputPath": "cli-binaries"
   },
   "scripts": {
     "prepare": "husky install",
     "prepack": "npm run build && npm run pack:cli",
     "build:package": "tsup",
     "build:docs": "typedoc",
+    "build:json-response-schemas": "ts-json-schema-generator --path src/types/route-responses.ts -o src/types/route-responses.generated.json && ts-json-schema-generator --path src/types/models.ts -o src/types/models.generated.json",
     "build": "npm run build:package && npm run build:docs",
     "pack:cli": "pkg -c package.json dist/cli/entry.js",
     "format": "prettier --write .",
     "format:check": "prettier --check .",
-    "build:json-response-schemas": "ts-json-schema-generator --path src/types/route-responses.ts -o src/types/route-responses.generated.json && ts-json-schema-generator --path src/types/models.ts -o src/types/models.generated.json",
     "test": "npm run build:json-response-schemas && ava",
     "test:watch": "npm run build:json-response-schemas && ava --watch",
     "cli:dev": "esr src/cli/entry.ts"

release.config.js

@@ -12,12 +12,24 @@ module.exports = {
           "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}",
       },
     ],
-    ["@semantic-release/github", {
-      "assets": [
-        {"path": "cli-binaries/seamapi-linux", "label": "seamapi-linux-x64-${nextRelease.gitTag}"},
-        {"path": "cli-binaries/seamapi-macos", "label": "seamapi-macos-x64-${nextRelease.gitTag}"},
-        {"path": "cli-binaries/seamapi-win.exe", "label": "seamapi-win-x64-${nextRelease.gitTag}.exe"},
-      ]
-    }],
+    [
+      "@semantic-release/github",
+      {
+        assets: [
+          {
+            path: "cli-binaries/seamapi-linux",
+            label: "seamapi-linux-x64-${nextRelease.gitTag}",
+          },
+          {
+            path: "cli-binaries/seamapi-macos",
+            label: "seamapi-macos-x64-${nextRelease.gitTag}",
+          },
+          {
+            path: "cli-binaries/seamapi-win.exe",
+            label: "seamapi-win-x64-${nextRelease.gitTag}.exe",
+          },
+        ],
+      },
+    ],
   ],
 }

src/cli/browser.ts

@@ -0,0 +1,91 @@
+import { getCLI } from "."
+import type Y from "yargs"
+// todo: replace with yargs/browser.mjs when https://github.com/yargs/yargs/pull/2144 is merged
+import { Yargs } from "https://unpkg.com/[email protected]/browser.mjs"
+import EventEmitter from "eventemitter3"
+import TypedEmitter from "typed-emitter"
+
+const yargsInstance = Yargs() as ReturnType<typeof Y>
+
+type CLIEvents = {
+  data: (data: string) => void
+}
+
+class BrowserCLI extends (EventEmitter as unknown as new () => TypedEmitter<CLIEvents>) {
+  private instance = getCLI(yargsInstance).scriptName("seam")
+
+  /**
+   * Use the Seam CLI in the browser!
+   */
+  constructor(private apiKey?: string) {
+    super()
+    this.setUpShims()
+  }
+
+  /**
+   * Parse a command line string. Output will be emitted as data events.
+   * @param input a given command string
+   * @example
+   * ```
+   * const cli = new BrowserCLI()
+   * await cli.parse("seam --help")
+   * ```
+   */
+  async parse(input: string) {
+    this.setUpShims()
+
+    const inputWithKey = input.includes("--api-key")
+      ? input
+      : `${input} --api-key ${this.apiKey}`
+
+    const inputWithKeyAndWithoutPrefix = inputWithKey.startsWith("seam ")
+      ? inputWithKey.replace("seam ", "")
+      : inputWithKey.startsWith("seamapi ")
+      ? inputWithKey.replace("seamapi ", "")
+      : inputWithKey
+
+    await new Promise<void>((resolve, reject) => {
+      // .parseAsync isn't available in v16, so we listen for the ending newline instead
+      const onData = (data: string) => {
+        if (data === "\n") {
+          this.removeListener("data", onData)
+          resolve()
+        }
+      }
+      this.on("data", onData)
+
+      this.instance.parse(
+        inputWithKeyAndWithoutPrefix,
+        (error: Error, _argv: any, output?: string) => {
+          if (error) {
+            this.removeListener("data", onData)
+            return reject(error)
+          }
+
+          if (output) {
+            this.emit("data", output)
+            this.emit("data", "\n")
+          }
+        }
+      )
+    })
+  }
+
+  /**
+   * Set the wrap value of the Yargs instance
+   * @param columns number of columns to wrap to
+   */
+  setWidth(columns: number) {
+    this.instance = this.instance.wrap(columns)
+  }
+
+  private setUpShims() {
+    process.stdout = {} as any
+    process.stdout.write = (data: string) => {
+      this.emit("data", data)
+      return true
+    }
+  }
+}
+
+export default BrowserCLI

src/cli/commands/access-codes.ts

@@ -1,12 +1,13 @@
-import executeCommand from "../execute-command"
-import { YargsWithGlobalOptions } from "../global-options"
+import { CommandModule } from "yargs"
+import executeCommand from "../lib/execute-command"
+import { GlobalOptions } from "../lib/global-options"
 
-export default {
+const command: CommandModule<GlobalOptions> = {
   command: "access-codes",
   aliases: ["access-code", "ac"],
   describe: "interact with access codes",
-  builder: (yargs: YargsWithGlobalOptions) => {
-    yargs
+  builder: (yargs) => {
+    return yargs
       .demandCommand()
       .command(
         "list",
@@ -99,4 +100,7 @@ export default {
         }
       )
   },
+  handler: () => {},
 }
+
+export default command

src/cli/commands/action-attempts.ts

@@ -1,12 +1,13 @@
-import executeCommand from "../execute-command"
-import { YargsWithGlobalOptions } from "../global-options"
+import { CommandModule } from "yargs"
+import executeCommand from "../lib/execute-command"
+import { GlobalOptions } from "../lib/global-options"
 
-export default {
+const command: CommandModule<GlobalOptions> = {
   command: "action-attempts",
   aliases: ["action-attempt", "aa"],
   describe: "interact with action attempts",
-  builder: (yargs: YargsWithGlobalOptions) => {
-    yargs.demandCommand().command(
+  builder: (yargs) => {
+    return yargs.demandCommand().command(
       "get <id>",
       "get an action attempt",
       (yargs) => {
@@ -21,4 +22,7 @@ export default {
       }
     )
   },
+  handler: () => {},
 }
+
+export default command

src/cli/commands/connect-webviews.ts

@@ -1,13 +1,14 @@
+import { CommandModule } from "yargs"
 import { Provider } from "../../types/models"
-import executeCommand from "../execute-command"
-import { YargsWithGlobalOptions } from "../global-options"
+import executeCommand from "../lib/execute-command"
+import { GlobalOptions } from "../lib/global-options"
 
-export default {
+const command: CommandModule<GlobalOptions> = {
   command: "connect-webviews",
   aliases: ["connect-webview", "cw"],
   describe: "interact with connect webviews",
-  builder: (yargs: YargsWithGlobalOptions) => {
-    yargs
+  builder: (yargs) => {
+    return yargs
       .demandCommand()
       .command(
         "list",
@@ -65,4 +66,7 @@ export default {
         }
       )
   },
+  handler: () => {},
 }
+
+export default command

src/cli/commands/connected-accounts.ts

@@ -1,12 +1,13 @@
-import executeCommand from "../execute-command"
-import { YargsWithGlobalOptions } from "../global-options"
+import { CommandModule } from "yargs"
+import executeCommand from "../lib/execute-command"
+import { GlobalOptions } from "../lib/global-options"
 
-export default {
+const command: CommandModule<GlobalOptions> = {
   command: "connected-accounts",
   aliases: ["connected-account", "ca"],
   describe: "interact with connected accounts",
-  builder: (yargs: YargsWithGlobalOptions) => {
-    yargs
+  builder: (yargs) => {
+    return yargs
       .demandCommand()
       .command(
         "list",
@@ -31,4 +32,7 @@ export default {
         }
       )
   },
+  handler: () => {},
 }
+
+export default command

src/cli/commands/devices.ts

@@ -1,12 +1,13 @@
-import executeCommand from "../execute-command"
-import { YargsWithGlobalOptions } from "../global-options"
+import { CommandModule } from "yargs"
+import executeCommand from "../lib/execute-command"
+import { GlobalOptions } from "../lib/global-options"
 
-export default {
+const command: CommandModule<GlobalOptions> = {
   command: "devices",
   aliases: ["device"],
   describe: "interact with devices",
-  builder: (yargs: YargsWithGlobalOptions) => {
-    yargs
+  builder: (yargs) => {
+    return yargs
       .demandCommand()
       .command(
         "get <id>",
@@ -37,4 +38,7 @@ export default {
         }
       )
   },
+  handler: () => {},
 }
+
+export default command

src/cli/commands/index.ts

@@ -0,0 +1,7 @@
+export * as accessCodes from "./access-codes"
+export * as actionAttempts from "./action-attempts"
+export * as connectWebviews from "./connect-webviews"
+export * as connectedAccounts from "./connected-accounts"
+export * as devices from "./devices"
+export * as locks from "./locks"
+export * as workspaces from "./workspaces"