@seamapi/cli 0.13.1 → 0.15.0

package/src/lib/interact-for-blueprint-object.ts

@@ -51,11 +51,11 @@ export const interactForBlueprintObject = async (
 
   const cmdPath = `/${args.command.join('/').replace(/-/g, '_')}`
 
-  const should_auto_submit =
+  const shouldAutoSubmit =
     ctx.interactivity !== 'interactive' &&
     haveAllRequiredParams &&
     !args.isSubProperty
-  if (should_auto_submit) {
+  if (shouldAutoSubmit) {
     return args.params
   }
 
@@ -160,18 +160,16 @@ export const interactForBlueprintObject = async (
     args.params[paramToEdit] = await interactForAccessCode(args.params as any)
     return interactForBlueprintObject(args, ctx)
   } else if (paramToEdit === 'connected_account_id') {
-    const connected_account_id = await interactForConnectedAccount()
-    args.params[paramToEdit] = connected_account_id
+    const connectedAccountId = await interactForConnectedAccount()
+    args.params[paramToEdit] = connectedAccountId
     return interactForBlueprintObject(args, ctx)
   } else if (
     paramToEdit === 'user_identity_id' ||
     paramToEdit === 'user_identity_ids'
   ) {
-    const user_identity_id = await interactForUserIdentity()
+    const userIdentityId = await interactForUserIdentity()
     args.params[paramToEdit] =
-      paramToEdit === 'user_identity_ids'
-        ? [user_identity_id]
-        : user_identity_id
+      paramToEdit === 'user_identity_ids' ? [userIdentityId] : userIdentityId
     return interactForBlueprintObject(args, ctx)
   } else if (paramToEdit.endsWith('acs_system_id')) {
     args.params[paramToEdit] = await interactForAcsSystem()

package/src/lib/interact-for-custom-metadata.ts

@@ -10,16 +10,16 @@ type UpdatedCustomMetadata = {
 }
 
 export const interactForCustomMetadata = async (
-  custom_metadata: CustomMetadata,
+  customMetadata: CustomMetadata,
 ) => {
-  const updated_custom_metadata: UpdatedCustomMetadata = { ...custom_metadata }
+  const updatedCustomMetadata: UpdatedCustomMetadata = { ...customMetadata }
   const output = getOutput()
 
   const displayCurrentCustomMetadata = () => {
     output.info('custom_metadata:')
-    if (Object.keys(updated_custom_metadata).length > 0) {
-      Object.keys(updated_custom_metadata).forEach((key, index) => {
-        output.info(`${index + 1}: ${key}: ${updated_custom_metadata[key]}`)
+    if (Object.keys(updatedCustomMetadata).length > 0) {
+      Object.keys(updatedCustomMetadata).forEach((key, index) => {
+        output.info(`${index + 1}: ${key}: ${updatedCustomMetadata[key]}`)
       })
     } else {
       output.info('The custom metadata param is empty.')
@@ -61,31 +61,29 @@ export const interactForCustomMetadata = async (
           newValue = Boolean(newValue)
         }
         if (newValue === 'null') {
-          updated_custom_metadata[newKey] = null
+          updatedCustomMetadata[newKey] = null
         } else {
-          updated_custom_metadata[newKey] = newValue
+          updatedCustomMetadata[newKey] = newValue
         }
       }
     } else if (action === 'remove') {
-      const { custom_key_to_remove } = await prompt({
+      const { customKeyToRemove } = await prompt({
         type: 'select',
-        name: 'custom_key_to_remove',
+        name: 'customKeyToRemove',
         message: 'Choose a key-value pair to remove from params:',
-        choices: Object.keys(updated_custom_metadata).map(
-          (custom_metadata_key) => {
-            return {
-              title: `${custom_metadata_key}: ${updated_custom_metadata[custom_metadata_key]}`,
-              value: custom_metadata_key,
-            }
-          },
-        ),
+        choices: Object.keys(updatedCustomMetadata).map((customMetadataKey) => {
+          return {
+            title: `${customMetadataKey}: ${updatedCustomMetadata[customMetadataKey]}`,
+            value: customMetadataKey,
+          }
+        }),
       })
 
-      if (custom_key_to_remove) {
-        delete custom_metadata[custom_key_to_remove]
+      if (customKeyToRemove) {
+        delete customMetadata[customKeyToRemove]
       }
     }
   } while (action !== 'done')
 
-  return updated_custom_metadata
+  return updatedCustomMetadata
 }

package/src/lib/interact-for-login.ts

@@ -2,6 +2,7 @@ import { isApiKey, isPersonalAccessToken } from '@seamapi/http/connect'
 import chalk from 'chalk'
 
 import { getConfigStore } from './config/index.js'
+import { assertEnvVarUnset, getTokenFromEnv, tokenEnvVar } from './env.js'
 import { getServer } from './get-server.js'
 import { interactForWorkspaceId } from './interact-for-workspace-id.js'
 import { getOutput } from './output/get-output.js'
@@ -13,6 +14,8 @@ export const interactForLogin = async () => {
   const config = await getConfigStore()
   const output = getOutput()
 
+  assertEnvVarUnset(tokenEnvVar, getTokenFromEnv(), 'log in')
+
   if (getServer().includes('localhost')) {
     output.info(
       `You're using a local Seam Connect instance, you can enter the API Key to your local user, you can create a new user from:\n\n${getServer()}/admin/create_user_with_api_key`,

package/src/lib/interact-for-server-selection.ts

@@ -1,11 +1,20 @@
 import { randomBytes } from 'node:crypto'
 
 import { getConfigStore } from './config/index.js'
+import {
+  assertEnvVarUnset,
+  endpointEnvVar,
+  getEndpointFromEnv,
+  getTokenFromEnv,
+  tokenEnvVar,
+} from './env.js'
 import { getServer } from './get-server.js'
 import { getOutput } from './output/get-output.js'
 import { prompt } from './util/prompt.js'
 
 export async function interactForServerSelection() {
+  assertEnvVarUnset(endpointEnvVar, getEndpointFromEnv(), 'select a server')
+
   const servers = [
     'http://localhost:3020',
     'https://connect.getseam.com',
@@ -36,6 +45,7 @@ export async function interactForServerSelection() {
     if (userUrlSeed.trim().length === 0) {
       userUrlSeed = randomBytes(5).toString('hex')
     }
+    assertEnvVarUnset(tokenEnvVar, getTokenFromEnv(), 'log in')
     config.set('server', `https://${userUrlSeed}.fakeseamconnect.seam.vc`)
     config.set(`${getServer()}.pat`, `seam_apikey1_token`)
     output.info(`PAT set to use fakeseamconnect with "seam_apikey1_token"`)

package/src/lib/interact-for-use-remote-api-defs.ts

@@ -3,10 +3,10 @@ import { getOutput } from './output/get-output.js'
 import { prompt } from './util/prompt.js'
 
 export async function interactForUseRemoteApiDefs() {
-  const { use_remote_api_defs } = await prompt([
+  const { useRemoteApiDefs } = await prompt([
     {
       type: 'select',
-      name: 'use_remote_api_defs',
+      name: 'useRemoteApiDefs',
       message: 'Always use remote API Definitions?',
       choices: [
         {
@@ -22,6 +22,6 @@ export async function interactForUseRemoteApiDefs() {
   ])
 
   const config = getConfigStore()
-  config.set('use_remote_api_defs', use_remote_api_defs)
-  getOutput().info(`Use remote API Definitions: ${use_remote_api_defs}`)
+  config.set('use_remote_api_defs', useRemoteApiDefs)
+  getOutput().info(`Use remote API Definitions: ${useRemoteApiDefs}`)
 }

package/src/lib/interact-for-workspace-id.ts

@@ -1,6 +1,11 @@
 import { SeamHttpWithoutWorkspace } from '@seamapi/http/connect'
 
 import { getConfigStore } from './config/index.js'
+import {
+  assertEnvVarUnset,
+  getWorkspaceIdFromEnv,
+  workspaceIdEnvVar,
+} from './env.js'
 import { getSeamMultiWorkspace } from './get-seam.js'
 import { getServer } from './get-server.js'
 import { prompt } from './util/prompt.js'
@@ -8,6 +13,13 @@ import { withLoading } from './util/with-loading.js'
 
 export const interactForWorkspaceId = async (personalAccessToken?: string) => {
   const config = getConfigStore()
+
+  assertEnvVarUnset(
+    workspaceIdEnvVar,
+    getWorkspaceIdFromEnv(),
+    'select a workspace',
+  )
+
   const seam = personalAccessToken
     ? SeamHttpWithoutWorkspace.fromPersonalAccessToken(personalAccessToken, {
         endpoint: getServer(),

package/src/lib/render-help.ts

@@ -66,6 +66,10 @@ const examples = [
     name: "seam access-codes create {bold --code} '1234' {bold --name} 'My Code'",
     summary: 'Create an access code.',
   },
+  {
+    name: 'seam devices list {bold --page-cursor} $NEXT_PAGE_CURSOR',
+    summary: 'List the next page of devices.',
+  },
   {
     name: 'seam devices list > devices.json',
     summary: 'Write the response to a file as JSON.',

package/src/lib/util/cli-args.ts

@@ -44,9 +44,27 @@ export class NonInteractiveError extends Error {
   override name = 'NonInteractiveError'
 }
 
+/**
+ * Thrown when the arguments do not name something the CLI can run.
+ */
+export class UsageError extends Error {
+  override name = 'UsageError'
+
+  /** What to run instead, reported after the message. */
+  readonly hint: string
+
+  constructor(message: string, { hint = '' }: { hint?: string } = {}) {
+    super(message)
+    this.hint = hint
+  }
+}
+
 export const parseCliArgs = (argv: string[]): ParsedArgs =>
   parseArgs(argv, {
-    string: ['code'],
+    // A page cursor is opaque, so keep it exactly as given: read as a number
+    // it would lose leading zeroes and turn exponent notation into a digit
+    // string, naming a page the API never issued.
+    string: ['code', 'page-cursor', 'page_cursor'],
     boolean: ['non-interactive', 'interactive', 'json'],
     // Deliberately not aliased to -n, which is reserved for a future
     // --dry-run flag.
@@ -90,3 +108,17 @@ export const getInteractivity = (
  */
 export const toArgName = (parameterName: string): string =>
   `--${parameterName.replace(/_/g, '-')}`
+
+/**
+ * Read an argument key as the parameter it names, e.g., `--page-cursor`,
+ * `--page_cursor`, and `--PAGE-CURSOR` all name `page_cursor`.
+ */
+export const toParameterName = (argKey: string): string =>
+  argKey.toLowerCase().replace(/-/g, '_')
+
+/**
+ * Render an argument key as the argument it was given as, naming a one letter
+ * key as the short form it can only have been written as, e.g., `-n`.
+ */
+export const toGivenArgName = (argKey: string): string =>
+  argKey.length === 1 ? `-${argKey}` : toArgName(argKey)

package/src/lib/version.ts

@@ -1,5 +1,5 @@
 // Versions are replaced with generated values when the package is packed.
-const seamapiCliVersion = '0.13.1'
+const seamapiCliVersion = '0.15.0'
 const seamapiBlueprintVersion = '1.2.0'
 
 export { seamapiBlueprintVersion }