@sanity/cli 3.87.1 → 3.88.1-typegen-experimental.0

package/src/commands/blueprints/logsBlueprintsCommand.ts

@@ -1,110 +1,72 @@
 import {type CliCommandDefinition} from '../../types'
 
 const helpText = `
-${
-  /*Options
-  --watch, -w  Watch for new logs (streaming mode)
-*/ ''
-}
-Examples
+Options
+  --watch, -w    Watch for new logs (streaming mode)
+
+Examples:
   # Show logs for the current Stack
   sanity blueprints logs
-${
-  /*
-  # Watch for new logs
+
+  # Watch for new logs (streaming mode)
   sanity blueprints logs --watch
-*/ ''
-}
 `
 
-// const defaultFlags = {watch: false}
+export interface BlueprintsLogsFlags {
+  watch?: boolean
+  w?: boolean
+}
 
-const logsBlueprintsCommand: CliCommandDefinition = {
+const defaultFlags: BlueprintsLogsFlags = {
+  //
+}
+
+const logsBlueprintsCommand: CliCommandDefinition<BlueprintsLogsFlags> = {
   name: 'logs',
   group: 'blueprints',
   helpText,
-  signature: '[--watch]',
+  signature: '[--watch] [-w]',
   description: 'Display logs for the current Blueprint Stack',
-  hideFromHelp: true,
+
   async action(args, context) {
     const {apiClient, output} = context
-    const {print} = output
-    // const flags = {...defaultFlags, ...args.extOptions}
-    // const watchMode = Boolean(flags.watch)
+    const flags = {...defaultFlags, ...args.extOptions}
 
-    const client = apiClient({requireUser: true, requireProject: false})
+    const client = apiClient({
+      requireUser: true,
+      requireProject: false,
+    })
     const {token} = client.config()
+    if (!token) throw new Error('No API token found. Please run `sanity login`.')
 
-    if (!token) {
-      print('No API token found. Please run `sanity login` first.')
-      return
-    }
-
-    const {blueprint: blueprintAction, logs: logsAction} = await import(
-      '@sanity/runtime-cli/actions/blueprints'
-    )
+    const {blueprintLogsCore} = await import('@sanity/runtime-cli/cores/blueprints')
+    const {getBlueprintAndStack} = await import('@sanity/runtime-cli/actions/blueprints')
     const {display} = await import('@sanity/runtime-cli/utils')
 
-    let blueprint = null
-    try {
-      blueprint = await blueprintAction.readBlueprintOnDisk({token})
-    } catch (error) {
-      print('Unable to read Blueprint manifest file. Run `sanity blueprints init`')
-      return
-    }
+    const {localBlueprint, deployedStack, issues} = await getBlueprintAndStack({token})
 
-    if (!blueprint) {
-      print('Unable to read Blueprint manifest file. Run `sanity blueprints init`')
-      return
+    if (issues) {
+      output.print(display.errors.presentBlueprintIssues(issues))
+      throw new Error('Unable to parse Blueprint file.')
     }
 
-    const {errors, deployedStack} = blueprint
-
-    if (errors && errors.length > 0) {
-      print(errors)
-      return
-    }
+    const {projectId, stackId} = localBlueprint
+    const auth = {token, projectId}
 
-    if (!deployedStack) {
-      print('Stack not found')
-      return
-    }
+    const {success, streaming, error} = await blueprintLogsCore({
+      bin: 'sanity',
+      log: (message) => output.print(message),
+      auth,
+      stackId,
+      deployedStack,
+      flags: {
+        watch: flags.watch ?? flags.w,
+      },
+    })
 
-    const {id: stackId, projectId, name} = deployedStack
-    const auth = {token, projectId}
+    if (streaming) await streaming
 
-    print(`Fetching logs for stack ${display.colors.yellow(`<${stackId}>`)}`)
-
-    // enable watch mode here
-
-    try {
-      const {ok, logs, error} = await logsAction.getLogs(stackId, auth)
-
-      if (!ok) {
-        print(`${display.colors.red('Failed')} to retrieve logs`)
-        print(`Error: ${error || 'Unknown error'}`)
-        return
-      }
-
-      if (logs.length === 0) {
-        print(`No logs found for Stack ${stackId}`)
-        return
-      }
-
-      print(`${display.blueprintsFormatting.formatTitle('Blueprint', name)} Logs`)
-      print(
-        `Found ${display.colors.bold(logs.length.toString())} log entries for stack ${display.colors.yellow(stackId)}\n`,
-      )
-
-      // Organize and format logs by day
-      const logsByDay = display.logsFormatting.organizeLogsByDay(logs)
-      print(display.logsFormatting.formatLogsByDay(logsByDay))
-    } catch (err) {
-      print('Failed to retrieve logs')
-      if (err instanceof Error) {
-        print(`Error: ${err.message}`)
-      }
-    }
+    if (!success) throw new Error(error)
   },
 }
 

package/src/commands/blueprints/planBlueprintsCommand.ts

@@ -3,60 +3,50 @@ import {type CliCommandDefinition} from '../../types'
 const helpText = `
 Safe to run at any time. Will not modify any Resources.
 
-Examples
-  # Show deployment plan
+Examples:
+  # Show deployment plan for the current Blueprint
   sanity blueprints plan
 `
 
-const planBlueprintsCommand: CliCommandDefinition = {
+export interface BlueprintsPlanFlags {
+  //
+}
+
+const planBlueprintsCommand: CliCommandDefinition<BlueprintsPlanFlags> = {
   name: 'plan',
   group: 'blueprints',
   helpText,
   signature: '',
   description: 'Enumerate Resources to be deployed',
-  hideFromHelp: true,
+
   async action(args, context) {
     const {apiClient, output} = context
-    const {print} = output
 
-    const client = apiClient({requireUser: true, requireProject: false})
+    const client = apiClient({
+      requireUser: true,
+      requireProject: false,
+    })
     const {token} = client.config()
-    const {blueprint: blueprintAction} = await import('@sanity/runtime-cli/actions/blueprints')
-    const {display} = await import('@sanity/runtime-cli/utils')
-
-    let blueprint = null
-    try {
-      blueprint = await blueprintAction.readBlueprintOnDisk({token})
-    } catch (error) {
-      print('Unable to read Blueprint manifest file. Run `sanity blueprints init`')
-      return
-    }
+    if (!token) throw new Error('No API token found. Please run `sanity login`.')
 
-    if (!blueprint) {
-      print('Unable to read Blueprint manifest file. Run `sanity blueprints init`')
-      return
-    }
+    const {blueprintPlanCore} = await import('@sanity/runtime-cli/cores/blueprints')
+    const {getBlueprintAndStack} = await import('@sanity/runtime-cli/actions/blueprints')
+    const {display} = await import('@sanity/runtime-cli/utils')
 
-    const {errors, projectId, stackId, parsedBlueprint, fileInfo} = blueprint
+    const {localBlueprint, issues} = await getBlueprintAndStack({token})
 
-    if (errors && errors.length > 0) {
-      print(errors)
+    if (issues) {
+      // print issues and continue
+      output.print(display.errors.presentBlueprintIssues(issues))
     }
 
-    const resources = parsedBlueprint.resources || []
-
-    if (!projectId) {
-      print('Unable to determine Project ID.')
-      print('To configure this Blueprint, run `sanity blueprints config`')
-      // continue to show the plan
-    }
+    const {success, error} = await blueprintPlanCore({
+      bin: 'sanity',
+      log: (message) => output.print(message),
+      blueprint: localBlueprint,
+    })
 
-    const name = stackId || 'Unknown'
-    print(`${display.blueprintsFormatting.formatTitle('Blueprint', name)} Plan\n`)
-    print(`Blueprint document: (${fileInfo.fileName})`)
-    print('')
-    print(display.blueprintsFormatting.formatResourceTree(resources))
-    print('\nRun `sanity blueprints deploy` to deploy these changes')
+    if (!success) throw new Error(error)
   },
 }
 

package/src/commands/blueprints/stacksBlueprintsCommand.ts

@@ -1,75 +1,67 @@
 import {type CliCommandDefinition} from '../../types'
 
 const helpText = `
-Examples
+Options
+  --project-id <id>    Project ID to use
+
+Examples:
   # List all Stacks for the current Project
   sanity blueprints stacks
+
+  # List Stacks for a specific project
+  sanity blueprints stacks --project-id abc123
 `
 
-const stacksBlueprintsCommand: CliCommandDefinition = {
+export interface BlueprintsStacksFlags {
+  'project-id'?: string
+  'projectId'?: string
+  'project'?: string
+}
+
+const defaultFlags: BlueprintsStacksFlags = {
+  //
+}
+
+const stacksBlueprintsCommand: CliCommandDefinition<BlueprintsStacksFlags> = {
   name: 'stacks',
   group: 'blueprints',
   helpText,
-  signature: '',
+  signature: '[--project-id <id>]',
   description: 'List all Blueprint Stacks for the current Project',
-  hideFromHelp: true,
+
   async action(args, context) {
     const {apiClient, output} = context
-    const {print} = output
-    const client = apiClient({requireUser: true, requireProject: false})
-    const {token} = client.config()
+    const flags = {...defaultFlags, ...args.extOptions}
 
-    if (!token) {
-      print('No API token found. Please run `sanity login` first.')
-      return
-    }
+    const client = apiClient({
+      requireUser: true,
+      requireProject: false,
+    })
+    const {token} = client.config()
+    if (!token) throw new Error('No API token found. Please run `sanity login`.')
 
-    const {blueprint: blueprintAction, stacks: stacksAction} = await import(
-      '@sanity/runtime-cli/actions/blueprints'
-    )
+    const {blueprintStacksCore} = await import('@sanity/runtime-cli/cores/blueprints')
+    const {getBlueprintAndStack} = await import('@sanity/runtime-cli/actions/blueprints')
     const {display} = await import('@sanity/runtime-cli/utils')
 
-    let blueprint = null
-    try {
-      blueprint = await blueprintAction.readBlueprintOnDisk({token})
-    } catch (error) {
-      print('Unable to read Blueprint manifest file. Run `sanity blueprints init`')
-      return
-    }
-
-    if (!blueprint) {
-      print('Unable to read Blueprint manifest file. Run `sanity blueprints init`')
-      return
-    }
-
-    const {errors, projectId, stackId} = blueprint
-
-    if (errors && errors.length > 0) {
-      print(errors)
-      return
-    }
+    const {localBlueprint, issues} = await getBlueprintAndStack({token})
 
-    if (!projectId) {
-      print('Blueprint is not configured for a Project. Run `sanity blueprints config`')
-      return
+    if (issues) {
+      // print issues and continue
+      output.print(display.errors.presentBlueprintIssues(issues))
     }
 
-    const auth = {token, projectId}
-    const {ok, stacks, error} = await stacksAction.listStacks(auth)
-
-    if (!ok) {
-      print(error || 'Failed to list Stacks')
-      return
-    }
-
-    if (!stacks || stacks.length === 0) {
-      print('No Stacks found')
-      return
-    }
+    const {success, error} = await blueprintStacksCore({
+      bin: 'sanity',
+      log: (message) => output.print(message),
+      token,
+      blueprint: localBlueprint,
+      flags: {
+        projectId: flags['project-id'] ?? flags.projectId ?? flags.project,
+      },
+    })
 
-    const {bold, yellow} = display.colors
-    print(`${bold('Project')} <${yellow(projectId)}> ${bold('Stacks')}:\n`)
-    print(display.blueprintsFormatting.formatStacksListing(stacks, stackId))
+    if (!success) throw new Error(error)
   },
 }
 

package/src/commands/functions/devFunctionsCommand.ts

@@ -22,9 +22,8 @@ const devFunctionsCommand: CliCommandDefinition = {
   name: 'dev',
   group: 'functions',
   helpText,
-  signature: '',
+  signature: '[--port <port>]',
   description: 'Start the Sanity Function emulator',
-  hideFromHelp: true,
   async action(args, context) {
     const {output} = context
     const {print} = output

package/src/commands/functions/envFunctionsCommand.ts

@@ -1,48 +1,47 @@
-import {type types} from '@sanity/runtime-cli/utils'
-
 import {type CliCommandDefinition} from '../../types'
 
-type StackFunctionResource = types.StackFunctionResource
-
 const helpText = `
-Arguments
-  [add] Add or update an environment variable
-  [remove] Remove an environment variable
+Commands
+  add    Add or update an environment variable
+  list   List the environment variables
+  remove Remove an environment variable
 
-Options
-  --name <name> The name of the function
-  --key <key> The name of the environment variable
-  --value <value> The value of the environment variable
+Arguments
+  <name> The name of the function
+  <key> The name of the environment variable
+  <value> The value of the environment variable
 
 Examples
   # Add or update an environment variable
-  sanity functions env add --name echo --key API_URL --value https://api.example.com/
+  sanity functions env add echo API_URL https://api.example.com/
 
   # Remove an environment variable
-  sanity functions env remove --name echo --key API_URL
-`
+  sanity functions env remove echo API_URL
 
-const defaultFlags = {
-  name: '',
-  key: '',
-  value: '',
-}
+  # List environment variables
+  sanity functions env list echo
+`
 
 const envFunctionsCommand: CliCommandDefinition = {
   name: 'env',
   group: 'functions',
   helpText,
-  signature: '',
-  description: 'Add or remove an environment variable for a Sanity function',
-  hideFromHelp: true,
+  signature: '<add|list|remove> <name> [key] [value]',
+  description:
+    'Add or remove an environment variable or list environment variables for a Sanity function',
   async action(args, context) {
     const {apiClient, output} = context
     const {print} = output
-    const [subCommand] = args.argsWithoutOptions
-    const flags = {...defaultFlags, ...args.extOptions}
+    const [subCommand, name, key, value] = args.argsWithoutOptions
+
+    if (!subCommand || !['add', 'list', 'remove'].includes(subCommand)) {
+      throw new Error('You must specify if you want to list, add or remove')
+    }
 
-    if (!subCommand || !['add', 'remove'].includes(subCommand)) {
-      throw new Error('You must specify if you wish to add or remove an environment variable')
+    if (subCommand === 'add' && (!key || !value)) {
+      throw new Error('You must specify the name, key and value arguments')
+    } else if (subCommand === 'remove' && !key) {
+      throw new Error('You must specify the name and key arguments')
     }
 
     const client = apiClient({
@@ -50,19 +49,18 @@ const envFunctionsCommand: CliCommandDefinition = {
       requireProject: false,
     })
 
-    if (flags.name === '') {
-      throw new Error('You must provide a function name via the --name flag')
+    if (name === '') {
+      throw new Error('You must provide a function name as the first argument')
     }
 
     const token = client.config().token
-    const {env} = await import('@sanity/runtime-cli/actions/functions')
-    const {blueprint} = await import('@sanity/runtime-cli/actions/blueprints')
+    if (!token) throw new Error('No API token found. Please run `sanity login`.')
+
+    const {env: envAction} = await import('@sanity/runtime-cli/actions/functions')
+    const {blueprint, getBlueprintAndStack} = await import('@sanity/runtime-cli/actions/blueprints')
     const {findFunction} = await import('@sanity/runtime-cli/utils')
 
-    const {deployedStack} = await blueprint.readBlueprintOnDisk({
-      getStack: true,
-      token,
-    })
+    const {deployedStack} = await getBlueprintAndStack({token})
 
     if (!deployedStack) {
       throw new Error('Stack not found')
@@ -71,34 +69,45 @@ const envFunctionsCommand: CliCommandDefinition = {
     const blueprintConfig = blueprint.readConfigFile()
     const projectId = blueprintConfig?.projectId
 
-    const {externalId} = findFunction.findFunctionByName(
-      deployedStack,
-      flags.name,
-    ) as StackFunctionResource
+    const {externalId} = findFunction.findFunctionByName(deployedStack, name)
 
     if (token && projectId) {
       if (subCommand === 'add') {
-        print(`Updating "${flags.key}" environment variable in "${flags.name}"`)
-        const result = await env.update.update(externalId, flags.key, flags.value, {
+        print(`Updating "${key}" environment variable in "${name}"`)
+        const result = await envAction.update(externalId, key, value, {
           token,
           projectId,
         })
         if (result.ok) {
-          print(`Update of ${flags.key} succeeded`)
+          print(`Update of "${key}" succeeded`)
         } else {
-          print(`Failed to update ${flags.key}`)
+          print(`Failed to update "${key}"`)
           print(`Error: ${result.error || 'Unknown error'}`)
         }
       } else if (subCommand === 'remove') {
-        print(`Removing "${flags.key}" environment variable in "${flags.name}"`)
-        const result = await env.remove.remove(externalId, flags.key, {
+        print(`Removing "${key}" environment variable in "${name}"`)
+        const result = await envAction.remove(externalId, key, {
           token,
           projectId,
         })
         if (result.ok) {
-          print(`Remove of ${flags.key} succeeded`)
+          print(`Removal of "${key}" succeeded`)
+        } else {
+          print(`Failed to remove "${key}"`)
+          print(`Error: ${result.error || 'Unknown error'}`)
+        }
+      } else if (subCommand === 'list') {
+        print(`Environment variables in "${name}"`)
+        const result = await envAction.list(externalId, {
+          token,
+          projectId,
+        })
+        if (result.ok && Array.isArray(result.envvars)) {
+          for (const envVarKey of result.envvars) {
+            print(envVarKey)
+          }
         } else {
-          print(`Failed to remove ${flags.key}`)
+          print(`Failed to list environment variables in "${key}"`)
           print(`Error: ${result.error || 'Unknown error'}`)
         }
       }

package/src/commands/functions/functionsGroup.ts

@@ -4,8 +4,7 @@ const functionsGroup: CliCommandGroupDefinition = {
   name: 'functions',
   signature: '[COMMAND]',
   isGroupRoot: true,
-  description: 'Test Sanity Functions locally and retrieve logs',
-  hideFromHelp: true,
+  description: 'Test Sanity Functions locally, update environment variables and retrieve logs',
 }
 
 export default functionsGroup