@seamapi/cli 0.21.0 → 0.23.0

package/src/lib/context.ts

@@ -1,6 +1,6 @@
 import type { Interactivity } from './args/parse.js'
 import type { ApiBlueprint } from './blueprint/index.js'
-import { type ConfigStore, getConfigStore } from './config/index.js'
+import { type CliConfig, getConfig } from './config/index.js'
 import {
   getEndpointFromEnv,
   getTokenFromEnv,
@@ -8,18 +8,20 @@ import {
 } from './env.js'
 import type { SeamApi } from './http/api.js'
 import type { Output } from './output/output.js'
+import { getAuthOverrides } from './overrides.js'
 
 export const defaultEndpoint = 'https://connect.getseam.com'
 
 /** Where a resolved value came from, e.g., to refuse writes the env shadows. */
-export type ValueSource = 'env' | 'config' | 'default'
+export type ValueSource = 'flag' | 'env' | 'config' | 'default'
 
 /**
  * The endpoint, token, and workspace requests are made with.
  *
- * Resolved in one place so the precedence rule exists once: an environment
- * variable wins over the stored value, and the endpoint falls back to Seam.
- * The source tags say where each value came from.
+ * Resolved in one place so the precedence rule exists once: a flag given for
+ * the one command wins over an environment variable, which wins over the
+ * stored value, and the endpoint falls back to Seam. The source tags say
+ * where each value came from.
  */
 export interface AuthContext {
   endpoint: string
@@ -30,38 +32,45 @@ export interface AuthContext {
   workspaceIdSource: Exclude<ValueSource, 'default'> | null
 }
 
-export const resolveAuth = (
-  config: ConfigStore = getConfigStore(),
-): AuthContext => {
+export const resolveAuth = (config: CliConfig = getConfig()): AuthContext => {
+  const { endpoint: flagEndpoint, workspaceId: flagWorkspaceId } =
+    getAuthOverrides()
+
   const envEndpoint = getEndpointFromEnv()
-  // Configs written before the endpoint was called one still hold it under
-  // `server`, so fall back to that key rather than silently resetting them.
-  const storedEndpoint = config.get('endpoint') ?? config.get('server')
-  const endpoint =
-    envEndpoint ?? (typeof storedEndpoint === 'string' ? storedEndpoint : null)
+  const storedEndpoint = config.getEndpoint()
+  const endpoint = flagEndpoint ?? envEndpoint ?? storedEndpoint
 
   const envToken = getTokenFromEnv()
-  const storedToken = readString(
-    config.get(`${endpoint ?? defaultEndpoint}.pat`),
-  )
+  // The token is stored per endpoint, so an overridden endpoint is read with
+  // the token belonging to it rather than the one it replaced.
+  const storedToken = config.getToken(endpoint ?? defaultEndpoint)
 
   const envWorkspaceId = getWorkspaceIdFromEnv()
-  const storedWorkspaceId = readString(config.get('current_workspace_id'))
+  const storedWorkspaceId = config.getWorkspace()
+  const workspaceId = flagWorkspaceId ?? envWorkspaceId ?? storedWorkspaceId
 
   return {
     endpoint: endpoint ?? defaultEndpoint,
     endpointSource:
-      envEndpoint != null ? 'env' : endpoint != null ? 'config' : 'default',
+      flagEndpoint != null
+        ? 'flag'
+        : envEndpoint != null
+          ? 'env'
+          : endpoint != null
+            ? 'config'
+            : 'default',
     token: envToken ?? storedToken,
     tokenSource:
       envToken != null ? 'env' : storedToken != null ? 'config' : null,
-    workspaceId: envWorkspaceId ?? storedWorkspaceId,
+    workspaceId,
     workspaceIdSource:
-      envWorkspaceId != null
-        ? 'env'
-        : storedWorkspaceId != null
-          ? 'config'
-          : null,
+      flagWorkspaceId != null
+        ? 'flag'
+        : envWorkspaceId != null
+          ? 'env'
+          : storedWorkspaceId != null
+            ? 'config'
+            : null,
   }
 }
 
@@ -70,7 +79,7 @@ export const resolveAuth = (
  * shape it acts on, and how it may interact with the user.
  */
 export interface CliContext {
-  config: ConfigStore
+  config: CliConfig
   auth: AuthContext
   output: Output
   blueprint: ApiBlueprint
@@ -78,11 +87,3 @@ export interface CliContext {
   /** The Seam API, constructed on first use and shared for the run. */
   api: () => Promise<SeamApi>
 }
-
-const readString = (value: unknown): string | null => {
-  if (typeof value !== 'string') return null
-
-  const trimmedValue = value.trim()
-
-  return trimmedValue === '' ? null : trimmedValue
-}

package/src/lib/interactions/endpoint-selection.ts

@@ -1,11 +1,11 @@
 import { assertMutable, selectEndpoint } from 'lib/auth/operations.js'
-import { getConfigStore } from 'lib/config/index.js'
+import { getConfig } from 'lib/config/index.js'
 import { resolveAuth } from 'lib/context.js'
 import { getOutput } from 'lib/output/get-output.js'
 import { promptAutocomplete } from 'lib/prompt.js'
 
 export async function interactForEndpointSelection() {
-  const config = getConfigStore()
+  const config = getConfig()
   assertMutable(resolveAuth(config), 'endpoint', 'select an endpoint')
 
   const endpoints = ['http://localhost:3020', 'https://connect.getseam.com']

package/src/lib/interactions/login.ts

@@ -3,7 +3,7 @@ import chalk from 'chalk'
 
 import { assertMutable, storeToken } from 'lib/auth/operations.js'
 import { validateToken } from 'lib/auth/validate-token.js'
-import { getConfigStore } from 'lib/config/index.js'
+import { getConfig } from 'lib/config/index.js'
 import { resolveAuth } from 'lib/context.js'
 import { getOutput } from 'lib/output/get-output.js'
 import { withLoading } from 'lib/output/with-loading.js'
@@ -12,7 +12,7 @@ import { promptText } from 'lib/prompt.js'
 import { interactForWorkspaceId } from './workspace-id.js'
 
 export const interactForLogin = async () => {
-  const config = getConfigStore()
+  const config = getConfig()
   const output = getOutput()
   const auth = resolveAuth(config)
 

package/src/lib/interactions/workspace-id.ts

@@ -1,14 +1,14 @@
 import { SeamHttpWithoutWorkspace } from '@seamapi/http/connect'
 
 import { assertMutable, selectWorkspace } from 'lib/auth/operations.js'
-import { getConfigStore } from 'lib/config/index.js'
+import { getConfig } from 'lib/config/index.js'
 import { resolveAuth } from 'lib/context.js'
 import { getSeamMultiWorkspace } from 'lib/http/client.js'
 import { withLoading } from 'lib/output/with-loading.js'
 import { promptAutocomplete } from 'lib/prompt.js'
 
 export const interactForWorkspaceId = async (personalAccessToken?: string) => {
-  const config = getConfigStore()
+  const config = getConfig()
 
   // Refuse before prompting: nothing selected here could be stored.
   assertMutable(resolveAuth(config), 'workspaceId', 'select a workspace')

package/src/lib/overrides.ts

@@ -0,0 +1,32 @@
+/**
+ * The endpoint and workspace may be overridden for a single command.
+ *
+ * `--endpoint` and `--workspace-id` change what one invocation resolves to
+ * and are never stored: only `seam select endpoint` and `seam select
+ * workspace` write those settings. They are held here rather than threaded
+ * through every call because auth resolves ambiently, exactly as the
+ * environment variables they shadow do (see `env.ts`).
+ *
+ * Set once from the parsed arguments before anything resolves auth, and
+ * reset between tests.
+ */
+
+export interface AuthOverrides {
+  endpoint: string | null
+  workspaceId: string | null
+}
+
+const noOverrides: AuthOverrides = { endpoint: null, workspaceId: null }
+
+let overrides: AuthOverrides = noOverrides
+
+export const getAuthOverrides = (): AuthOverrides => overrides
+
+export const setAuthOverrides = (next: AuthOverrides): void => {
+  overrides = next
+}
+
+/** Drop the overrides, e.g., between tests sharing a process. */
+export const resetAuthOverrides = (): void => {
+  overrides = noOverrides
+}

package/src/lib/render/help.ts

@@ -131,6 +131,7 @@ const commandSections = (
 ): Section[] => {
   const name = ['seam', ...command.path].join(' ')
   const hasFlags = command.flags.length > 0
+  const { positional } = command
 
   return [
     {
@@ -139,7 +140,26 @@ const commandSections = (
         (line) => line !== '',
       ),
     },
-    { header: 'Usage', content: `${name} [options]` },
+    {
+      header: 'Usage',
+      content:
+        positional == null
+          ? `${name} [options]`
+          : `${name} <${positional.name}> [options]`,
+    },
+    ...(positional == null
+      ? []
+      : [
+          {
+            header: 'Arguments',
+            content: [
+              {
+                name: `{underline <${positional.name}>}`,
+                summary: positional.description,
+              },
+            ],
+          },
+        ]),
     // The command's own parameters are what the request is made of, so keep
     // them apart from the options every seam command takes.
     ...(hasFlags ? [optionSection(command.flags, 'Parameters')] : []),

package/src/lib/version.ts

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