@seamapi/cli 0.0.1 → 0.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/cli",
-  "version": "0.0.1",
+  "version": "0.5.0",
   "description": "A command line interface (CLI) for interacting with the Seam API.",
   "type": "module",
   "main": "index.js",
@@ -14,9 +14,17 @@
     }
   },
   "module": "index.js",
-  "sideEffects": false,
+  "bin": {
+    "seam": "./bin/cli.js"
+  },
+  "sideEffects": [
+    "./bin/cli.js",
+    "./src/bin/cli.ts"
+  ],
   "keywords": [
-    "node"
+    "cli",
+    "node",
+    "seam"
   ],
   "homepage": "https://github.com/seamapi/cli",
   "bugs": "https://github.com/seamapi/cli/issues",
@@ -30,6 +38,7 @@
     "index.js",
     "index.js.map",
     "index.d.ts",
+    "bin",
     "lib",
     "src",
     "!test",
@@ -38,29 +47,30 @@
   "scripts": {
     "build": "npm run build:entrypoints",
     "prebuild": "tsx src/index.ts",
-    "postbuild": "node ./index.js",
+    "postbuild": "concurrently --raw --group 'node ./index.js' 'node ./bin/cli.js --version'",
     "build:entrypoints": "npm run build:ts",
     "build:ts": "tsc --project tsconfig.build.json",
-    "prebuild:ts": "del 'index.*' lib",
+    "prebuild:ts": "del 'index.*' bin lib",
     "postbuild:ts": "tsc-alias --project tsconfig.build.json",
     "typecheck": "tsc",
-    "test": "c8 ava",
+    "test": "vitest run --coverage",
     "pretest": "tsx src/index.ts",
-    "test:update": "ava --update-snapshots",
-    "test:watch": "ava --watch",
-    "test:debug": "ava debug --break",
+    "test:update": "vitest run --update",
+    "test:watch": "vitest",
+    "test:debug": "vitest --inspect-brk --no-file-parallelism",
     "lint": "eslint .",
     "postlint": "prettier --check --ignore-path .gitignore .",
+    "prepack": "tsx ./prepack.ts",
     "postversion": "git push --follow-tags",
-    "example": "tsx examples",
-    "example:inspect": "tsx --inspect examples",
+    "seam": "tsx src/bin/cli.ts",
+    "inspect": "tsx --inspect src/bin/cli.ts",
     "format": "prettier --write --ignore-path .gitignore .",
     "preformat": "eslint --fix .",
-    "report": "c8 report"
+    "report": "vitest run --coverage"
   },
   "engines": {
     "node": ">=22.11.0",
-    "npm": ">=10.9.4"
+    "npm": ">=10.0.0"
   },
   "devEngines": {
     "runtime": {
@@ -69,24 +79,40 @@
     },
     "packageManager": {
       "name": "npm",
-      "version": "^11.16.0 || ^10.9.4"
+      "version": "^11.0.0 || ^10.0.0"
     }
   },
+  "dependencies": {
+    "@seamapi/blueprint": "^1.1.0",
+    "@seamapi/http": "^2.2.0",
+    "chalk": "^6.0.0",
+    "command-line-usage": "^7.0.4",
+    "configstore": "^8.0.0",
+    "minimist": "^1.2.8",
+    "nanospinner": "^1.2.2",
+    "open": "^11.0.0",
+    "prompts": "^2.4.2"
+  },
   "devDependencies": {
+    "@seamapi/types": "^1.983.0",
+    "@types/command-line-usage": "^5.0.4",
+    "@types/minimist": "^1.2.5",
     "@types/node": "^24.10.9",
-    "ava": "^8.0.1",
-    "c8": "^12.0.0",
+    "@types/prompts": "^2.4.9",
+    "@vitest/coverage-v8": "^4.1.10",
+    "concurrently": "^10.0.4",
     "del-cli": "^7.0.0",
     "eslint": "^9.31.0",
     "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-simple-import-sort": "^12.1.1",
     "eslint-plugin-unused-imports": "^4.1.4",
+    "execa": "^10.0.0",
     "jiti": "^2.4.2",
-    "landlubber": "^2.0.0",
     "neostandard": "^0.13.0",
     "prettier": "^3.0.0",
     "tsc-alias": "^1.8.2",
     "tsx": "^4.6.2",
-    "typescript": "^6.0.3"
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.10"
   }
 }

package/src/bin/cli.ts

@@ -0,0 +1,265 @@
+#!/usr/bin/env node
+import { randomBytes } from 'node:crypto'
+import { isDeepStrictEqual as isEqual } from 'node:util'
+
+import chalk from 'chalk'
+import commandLineUsage from 'command-line-usage'
+import parseArgs, { type ParsedArgs } from 'minimist'
+import prompts from 'prompts'
+
+import { getApiBlueprint } from 'lib/get-api-blueprint.js'
+import { getConfigStore } from 'lib/get-config-store.js'
+import { getServer } from 'lib/get-server.js'
+import { interactForActionAttemptPoll } from 'lib/interact-for-action-attempt-poll.js'
+import { interactForCommandParams } from 'lib/interact-for-command-params.js'
+import { interactForCommandSelection } from 'lib/interact-for-command-selection.js'
+import { interactForLogin } from 'lib/interact-for-login.js'
+import { interactForServerSelection } from 'lib/interact-for-server-selection.js'
+import { interactForUseRemoteApiDefs } from 'lib/interact-for-use-remote-api-defs.js'
+import { interactForWorkspaceId } from 'lib/interact-for-workspace-id.js'
+import type { ContextHelpers } from 'lib/types.js'
+import { RequestSeamApi } from 'lib/util/request-seam-api.js'
+import { validateToken } from 'lib/validate-token.js'
+import seamapiCliVersion from 'lib/version.js'
+
+const sections = [
+  {
+    header: 'Seam CLI',
+    content:
+      'Every seam command is interactive and will prompt you for any missing required properties with helpful suggestions. To avoid automatic behavior, pass -y ',
+  },
+  {
+    header: 'Options',
+    optionList: [
+      {
+        name: 'help',
+        description: 'Display this help guide.',
+        alias: 'h',
+        type: Boolean,
+      },
+    ],
+  },
+  {
+    header: 'Command List Examples',
+    content: [
+      { name: 'seam', summary: 'Interactively select commands to execute.' },
+      { name: 'seam login', summary: 'Login to Seam.' },
+      { name: 'seam select workspace', summary: 'Select your workspace.' },
+      {
+        name: 'seam connect-webviews create',
+        summary: 'Create a connect webview to connect devices.',
+      },
+      { name: 'seam devices list', summary: 'List devices in your workspace.' },
+      {
+        name: 'seam locks unlock-door {bold --device-id} $MY_DOOR',
+        summary: 'Unlock a lock.',
+      },
+      {
+        name: "seam access-codes create {bold --code} '1234' {bold --name} 'My Code'",
+        summary: 'Create an access code.',
+      },
+      {
+        name: 'seam access-codes list {bold --device-id} $MY_DOOR',
+        summary: 'List you access codes.',
+      },
+    ],
+  },
+]
+
+async function cli(args: ParsedArgs) {
+  const config = getConfigStore()
+
+  if (args['help'] || args['h']) {
+    const usage = commandLineUsage(sections)
+    console.log(usage)
+    return
+  }
+
+  if (args['version']) {
+    console.log(seamapiCliVersion)
+    process.exit(0)
+  }
+
+  if (
+    args._[0] === 'config' &&
+    args._[1] === 'set' &&
+    args._[2] === 'fake-server'
+  ) {
+    const randomstring = randomBytes(5).toString('hex')
+    const fakeApiUrl = `https://${randomstring}.fakeseamconnect.seam.vc`
+
+    config.set('server', fakeApiUrl)
+    console.log(`Server URL set to ${fakeApiUrl}`)
+
+    config.set(`${getServer()}.pat`, `seam_apikey1_token`)
+    console.log(`PAT set to use fakeseamconnect with "seam_apikey1_token"`)
+    return
+  }
+
+  if (
+    !config.get(`${getServer()}.pat`) &&
+    args._[0] !== 'login' &&
+    !isEqual(args._, ['select', 'server'])
+  ) {
+    console.log(`Not logged in. Please run "seam login"`)
+    process.exit(1)
+  }
+
+  args._ = args._.map((arg) => arg.toLowerCase().replace(/_/g, '-'))
+  for (const k in args) {
+    args[k.toLowerCase().replace(/-/g, '_')] = args[k]
+  }
+
+  const use_remote_api_defs =
+    args['remote_api_defs'] ?? config.get('use_remote_api_defs')
+
+  const blueprint = await getApiBlueprint(use_remote_api_defs ?? false)
+
+  const commandParams: Record<string, any> = {}
+
+  /**
+   * Whether or not to auto-select first option
+   */
+  const is_interactive = args['y'] !== true
+
+  const ctx: ContextHelpers = {
+    blueprint,
+    is_interactive,
+  }
+
+  for (const k in args) {
+    if (k === '_') continue
+    const v = args[k]
+    delete args[k]
+    args[k.replace(/-/g, '_')] = v
+    commandParams[k.replace(/-/g, '_')] = v
+  }
+
+  const selectedCommand = await interactForCommandSelection(args._, ctx)
+  if (isEqual(selectedCommand, ['login'])) {
+    if (args['server']) {
+      config.set('server', args['server'])
+      config.delete('current_workspace_id')
+    }
+    if (args['token']) {
+      const token = String(args['token']).trim()
+      await validateToken(token, args['workspace_id'])
+      config.set(`${getServer()}.pat`, token)
+      config.delete('current_workspace_id')
+    }
+    if (args['workspace_id']) {
+      config.set(`current_workspace_id`, args['workspace_id'])
+    }
+    if (args['token'] || args['workspace_id'] || args['server']) {
+      return
+    }
+    await interactForLogin()
+    return
+  } else if (isEqual(selectedCommand, ['logout'])) {
+    config.delete('pat')
+    console.log('Logged out!')
+    return
+  } else if (isEqual(selectedCommand, ['config', 'reveal-location'])) {
+    console.log(config.path)
+    return
+  } else if (isEqual(selectedCommand, ['config', 'use-remote-api-defs'])) {
+    await interactForUseRemoteApiDefs()
+    return
+  } else if (isEqual(selectedCommand, ['select', 'workspace'])) {
+    await interactForWorkspaceId()
+    return
+  } else if (isEqual(selectedCommand, ['events', 'list'])) {
+    if (!commandParams['since']) {
+      const date = new Date()
+      date.setMonth(date.getMonth() - 1)
+      commandParams['since'] = date.toISOString()
+    }
+  } else if (isEqual(selectedCommand, ['select', 'server'])) {
+    if (args['server']) {
+      config.set('server', args['server'])
+      config.delete('current_workspace_id')
+      return
+    }
+    await interactForServerSelection()
+    return
+  } else if (isEqual(selectedCommand, ['health', 'get-health'])) {
+    await RequestSeamApi({
+      path: '/health/get_health',
+      params: {},
+    })
+
+    return
+  }
+  // TODO - do this using the OpenAPI spec for the command rather than
+  // explicitly encoding the property names
+  if (commandParams['accepted_providers']) {
+    commandParams['accepted_providers'] =
+      commandParams['accepted_providers'].split(',')
+  }
+
+  // Hit 'back' on a top-level command path, so we start again
+  const lastCommandPath = selectedCommand.slice(-1)[0]
+  if (lastCommandPath === '[Back]') {
+    return await cli({
+      ...args,
+      _: [],
+    })
+  }
+
+  const params = await interactForCommandParams(
+    { command: selectedCommand, params: commandParams },
+    ctx,
+  )
+
+  if (params === '[Back]') {
+    const previousCommands = [...selectedCommand]
+    previousCommands.pop()
+    return await cli({
+      ...args,
+      _: previousCommands,
+    })
+  }
+
+  const apiPath = `/${selectedCommand.join('/').replace(/-/g, '_')}`
+
+  if (apiPath.includes('/events/list') && params.between) {
+    delete params.since
+  }
+
+  const response = await RequestSeamApi({
+    path: apiPath,
+    params,
+  })
+
+  if (response.data?.connect_webview) {
+    await handleConnectWebviewResponse(response.data.connect_webview)
+  }
+
+  if (response.data?.action_attempt) {
+    interactForActionAttemptPoll(response.data.action_attempt)
+  }
+}
+
+const handleConnectWebviewResponse = async (connect_webview: any) => {
+  const url = connect_webview.url
+
+  if (process.env['INSIDE_WEB_BROWSER'] !== '1') {
+    const { action } = await prompts({
+      type: 'confirm',
+      name: 'action',
+      message: 'Would you like to open the webview in your browser?',
+    })
+
+    if (action) {
+      const { default: open } = await import('open')
+      await open(url)
+    }
+  }
+}
+
+cli(parseArgs(process.argv.slice(2), { string: ['code'] })).catch((e) => {
+  console.log(chalk.red(`CLI Error: ${e.toString()}\n${e.stack}`))
+  if (e.toString().includes('object Object')) {
+    console.log(e)
+  }
+})

package/src/index.ts

@@ -1 +1,4 @@
-export * from 'lib/index.js'
+// This package is a CLI, not a library: nothing here is part of a public API.
+// The entrypoint exists so that importing the package resolves to a module
+// instead of failing, for consumers that depend on it to get the bin.
+export default null