@sanity/cli 3.88.0 → 3.88.1

package/src/commands/blueprints/infoBlueprintsCommand.ts

@@ -1,29 +1,28 @@
 import {type CliCommandDefinition} from '../../types'
 
 const helpText = `
-Options
-  --id, -i  Stack ID
-
-Examples
+Examples:
   # Retrieve information about the current Stack
   sanity blueprints info
-
-  # Retrieve information about a specific Stack
-  sanity blueprints info --id <stack-id>
 `
 
-const defaultFlags = {id: undefined}
+export interface BlueprintsInfoFlags {
+  id?: string
+}
+
+const defaultFlags: BlueprintsInfoFlags = {
+  //
+}
 
-const infoBlueprintsCommand: CliCommandDefinition = {
+const infoBlueprintsCommand: CliCommandDefinition<BlueprintsInfoFlags> = {
   name: 'info',
   group: 'blueprints',
   helpText,
   signature: '',
   description: 'Retrieve information about a Blueprint Stack',
-  hideFromHelp: true,
+
   async action(args, context) {
     const {apiClient, output} = context
-    const {print} = output
     const flags = {...defaultFlags, ...args.extOptions}
 
     const client = apiClient({
@@ -31,53 +30,32 @@ const infoBlueprintsCommand: CliCommandDefinition = {
       requireProject: false,
     })
     const {token} = client.config()
-    const {blueprint: blueprintAction, stacks: stacksAction} = await import(
-      '@sanity/runtime-cli/actions/blueprints'
-    )
+    if (!token) throw new Error('No API token found. Please run `sanity login`.')
+
+    const {blueprintInfoCore} = 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, projectId} = blueprint
-
-    if (errors && errors.length > 0) {
-      print(errors)
-      return
-    }
+    const {projectId, stackId} = localBlueprint
+    const auth = {token, projectId}
 
-    if (token && projectId) {
-      const auth = {token, projectId}
-      let result
-      if (flags.id) {
-        const {stack, error, ok} = await stacksAction.getStack({stackId: flags.id, auth})
-        if (ok) {
-          result = stack
-        } else {
-          print(error)
-        }
-      } else {
-        result = deployedStack
-      }
+    const {success, error} = await blueprintInfoCore({
+      bin: 'sanity',
+      log: (message) => output.print(message),
+      auth,
+      stackId,
+      deployedStack,
+      flags,
+    })
 
-      if (result) {
-        print(display.blueprintsFormatting.formatStackInfo(result))
-      } else {
-        print('No Stack found')
-      }
-    } else {
-      print('Cannot retrieve information for Blueprint: missing API token or Project ID')
-    }
+    if (!success) throw new Error(error)
   },
 }
 

package/src/commands/blueprints/initBlueprintsCommand.ts

@@ -1,95 +1,77 @@
-import {join} from 'node:path'
-import {cwd} from 'node:process'
-
 import {type CliCommandDefinition} from '../../types'
 
 const helpText = `
-Examples
-  # Create a new Blueprint manifest file
+Arguments
+  [dir]  Path to initialize the Blueprint in
+
+Options
+  --blueprint-type, --type <json>    Type of Blueprint to create
+  --project-id <id>                  Project ID to use
+
+Examples:
+  # Create a new Blueprint manifest file in the current directory
   sanity blueprints init
+
+  # Create a new Blueprint manifest file in a specific directory
+  sanity blueprints init my-sanity-project --type json
 `
 
-const initBlueprintsCommand: CliCommandDefinition = {
+export interface BlueprintsInitFlags {
+  'dir'?: string
+  'blueprint-type'?: string
+  'type'?: string
+  'project-id'?: string
+  'projectId'?: string
+  'project'?: string
+  'stack-id'?: string
+  'stackId'?: string
+  'stack'?: string
+  'stack-name'?: string
+  'name'?: string
+}
+
+const defaultFlags: BlueprintsInitFlags = {
+  //
+}
+
+const initBlueprintsCommand: CliCommandDefinition<BlueprintsInitFlags> = {
   name: 'init',
   group: 'blueprints',
   helpText,
-  signature: '',
+  signature: '[dir] [--blueprint-type <type>] [--project-id <id>]',
   description: 'Initialize a new Blueprint manifest file',
-  hideFromHelp: true,
+
   async action(args, context) {
-    const {apiClient, output, prompt} = context
-    const {print} = output
+    const {apiClient, output} = context
+    const flags = {...defaultFlags, ...args.extOptions}
+
+    const [dir] = args.argsWithoutOptions
 
     const client = apiClient({
       requireUser: true,
       requireProject: false,
     })
     const {token} = client.config()
-
-    if (!token) {
-      print('No API token found. Please run `sanity login` first.')
-      return
-    }
-
-    const {blueprint: blueprintAction, projects: projectsAction} = await import(
-      '@sanity/runtime-cli/actions/blueprints'
-    )
-
-    const existingBlueprint = blueprintAction.findBlueprintFile()
-
-    if (existingBlueprint) {
-      print(`A blueprint file already exists: ${existingBlueprint.fileName}`)
-      return
-    }
-
-    const blueprintExtension = await prompt.single({
-      type: 'list',
-      message: 'Choose a Blueprint manifest file type:',
-      choices: [
-        {value: 'json', name: 'JSON (Recommended)'},
-        {value: 'js', name: 'JavaScript (Available soon)', disabled: true},
-        {value: 'ts', name: 'TypeScript (Available soon)', disabled: true},
-      ],
+    if (!token) throw new Error('No API token found. Please run `sanity login`.')
+
+    const {blueprintInitCore} = await import('@sanity/runtime-cli/cores/blueprints')
+
+    const {success, error} = await blueprintInitCore({
+      bin: 'sanity',
+      log: (message) => output.print(message),
+      token,
+      args: {
+        dir: dir ?? flags.dir,
+      },
+      flags: {
+        'blueprint-type': flags['blueprint-type'] ?? flags.type,
+        'project-id': flags['project-id'] ?? flags.projectId ?? flags.project,
+        'stack-id': flags['stack-id'] ?? flags.stackId ?? flags.stack,
+        'stack-name': flags['stack-name'] ?? flags.name,
+      },
     })
 
-    const {ok, projects, error} = await projectsAction.listProjects({token})
-
-    if (!ok) {
-      print(error)
-      return
-    }
-
-    if (!projects || projects.length === 0) {
-      print('No Projects found. Please create a Project in Sanity.io first.')
-      return
-    }
-
-    const projectChoices = projects.map(({displayName, id}) => ({
-      value: id,
-      name: `${displayName} <${id}>`,
-    }))
-
-    const projectId = await prompt.single({
-      type: 'list',
-      message: 'Select your Sanity Project:',
-      choices: projectChoices,
-    })
-
-    const fileName = `blueprint.${blueprintExtension}`
-    const filePath = join(cwd(), fileName)
-
-    blueprintAction.writeBlueprintToDisk({
-      path: filePath,
-      fileType: blueprintExtension as 'json' | 'js' | 'ts',
-    })
-
-    blueprintAction.writeConfigFile({projectId})
-
-    print(`Created new blueprint: ./${fileName}`)
-
-    if (blueprintExtension === 'ts') {
-      print('\nNote: TypeScript support requires "tsx" to be installed. Run: npm install -D tsx')
-    }
+    if (!success) throw new Error(error)
   },
 }
 

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