@sanity/cli 3.85.1 → 3.86.0

package/src/commands/blueprints/planBlueprintsCommand.ts

@@ -0,0 +1,63 @@
+import {type CliCommandDefinition} from '../../types'
+
+const helpText = `
+Safe to run at any time. Will not modify any Resources.
+
+Examples
+  # Show deployment plan
+  sanity blueprints plan
+`
+
+const planBlueprintsCommand: CliCommandDefinition = {
+  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 {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 (!blueprint) {
+      print('Unable to read Blueprint manifest file. Run `sanity blueprints init`')
+      return
+    }
+
+    const {errors, projectId, stackId, parsedBlueprint, fileInfo} = blueprint
+
+    if (errors && errors.length > 0) {
+      print(errors)
+    }
+
+    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 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')
+  },
+}
+
+export default planBlueprintsCommand

package/src/commands/blueprints/stacksBlueprintsCommand.ts

@@ -0,0 +1,76 @@
+import {type CliCommandDefinition} from '../../types'
+
+const helpText = `
+Examples
+  # List all Stacks for the current Project
+  sanity blueprints stacks
+`
+
+const stacksBlueprintsCommand: CliCommandDefinition = {
+  name: 'stacks',
+  group: 'blueprints',
+  helpText,
+  signature: '',
+  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()
+
+    if (!token) {
+      print('No API token found. Please run `sanity login` first.')
+      return
+    }
+
+    const {blueprint: blueprintAction, stacks: stacksAction} = 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
+    }
+
+    if (!projectId) {
+      print('Blueprint is not configured for a Project. Run `sanity blueprints config`')
+      return
+    }
+
+    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 {bold, yellow} = display.colors
+    print(`${bold('Project')} <${yellow(projectId)}> ${bold('Stacks')}:\n`)
+    print(display.blueprintsFormatting.formatStacksListing(stacks, stackId))
+  },
+}
+
+export default stacksBlueprintsCommand

package/src/commands/functions/devFunctionsCommand.ts

@@ -30,8 +30,8 @@ const devFunctionsCommand: CliCommandDefinition = {
     const {print} = output
     const flags = {...defaultFlags, ...args.extOptions}
 
-    const {functionsActions} = await import('@sanity/runtime-cli')
-    functionsActions.dev.dev(flags.port)
+    const {dev: devAction} = await import('@sanity/runtime-cli/actions/functions')
+    devAction.dev(flags.port)
 
     print(`Server is running on port ${flags.port}\n`)
     open(`http://localhost:${flags.port}`)

package/src/commands/functions/envFunctionsCommand.ts

@@ -1,7 +1,9 @@
-import {type StackFunctionResource} from '@sanity/runtime-cli/dist/utils/types'
+import {type types} from '@sanity/runtime-cli/utils'
 
 import {type CliCommandDefinition} from '../../types'
 
+type StackFunctionResource = types.StackFunctionResource
+
 const helpText = `
 Options
   --name <name> The name of the function
@@ -49,9 +51,11 @@ const envFunctionsCommand: CliCommandDefinition = {
     }
 
     const token = client.config().token
-    const {blueprintsActions, functionsActions, utils} = await import('@sanity/runtime-cli')
+    const {env} = await import('@sanity/runtime-cli/actions/functions')
+    const {blueprint} = await import('@sanity/runtime-cli/actions/blueprints')
+    const {findFunction} = await import('@sanity/runtime-cli/utils')
 
-    const {deployedStack} = await blueprintsActions.blueprint.readBlueprintOnDisk({
+    const {deployedStack} = await blueprint.readBlueprintOnDisk({
       getStack: true,
       token,
     })
@@ -61,10 +65,10 @@ const envFunctionsCommand: CliCommandDefinition = {
       return
     }
 
-    const blueprintConfig = blueprintsActions.blueprint.readConfigFile()
+    const blueprintConfig = blueprint.readConfigFile()
     const projectId = blueprintConfig?.projectId
 
-    const {externalId} = utils.findFunctions.findFunctionByName(
+    const {externalId} = findFunction.findFunctionByName(
       deployedStack,
       flags.name,
     ) as StackFunctionResource
@@ -72,15 +76,10 @@ const envFunctionsCommand: CliCommandDefinition = {
     if (token && projectId) {
       if (flags.add) {
         print(`Updating "${flags.key}" environment variable in "${flags.name}"`)
-        const result = await functionsActions.env.update.update(
-          externalId,
-          flags.key,
-          flags.value,
-          {
-            token,
-            projectId,
-          },
-        )
+        const result = await env.update.update(externalId, flags.key, flags.value, {
+          token,
+          projectId,
+        })
         if (result.ok) {
           print(`Update of ${flags.key} succeeded`)
         } else {
@@ -89,7 +88,7 @@ const envFunctionsCommand: CliCommandDefinition = {
         }
       } else if (flags.remove) {
         print(`Removing "${flags.key}" environment variable in "${flags.name}"`)
-        const result = await functionsActions.env.remove.remove(externalId, flags.key, {
+        const result = await env.remove.remove(externalId, flags.key, {
           token,
           projectId,
         })

package/src/commands/functions/logsFunctionsCommand.ts

@@ -1,7 +1,9 @@
-import {type StackFunctionResource} from '@sanity/runtime-cli/dist/utils/types'
+import {type types} from '@sanity/runtime-cli/utils'
 
 import {type CliCommandDefinition} from '../../types'
 
+type StackFunctionResource = types.StackFunctionResource
+
 const helpText = `
 Options
   --name <name> The name of the function to retrieve logs for
@@ -48,9 +50,10 @@ const logsFunctionsCommand: CliCommandDefinition = {
     }
 
     const token = client.config().token
-    const {blueprintsActions, utils} = await import('@sanity/runtime-cli')
+    const {blueprint} = await import('@sanity/runtime-cli/actions/blueprints')
+    const {findFunction} = await import('@sanity/runtime-cli/utils')
 
-    const {deployedStack} = await blueprintsActions.blueprint.readBlueprintOnDisk({
+    const {deployedStack} = await blueprint.readBlueprintOnDisk({
       getStack: true,
       token,
     })
@@ -60,17 +63,17 @@ const logsFunctionsCommand: CliCommandDefinition = {
       return
     }
 
-    const blueprintConfig = blueprintsActions.blueprint.readConfigFile()
+    const blueprintConfig = blueprint.readConfigFile()
     const projectId = blueprintConfig?.projectId
 
-    const {externalId} = utils.findFunctions.findFunctionByName(
+    const {externalId} = findFunction.findFunctionByName(
       deployedStack,
       flags.name,
     ) as StackFunctionResource
 
     if (token && projectId) {
-      const {functionsActions} = await import('@sanity/runtime-cli')
-      const {ok, error, logs, total} = await functionsActions.logs.logs(
+      const {logs: logsAction} = await import('@sanity/runtime-cli/actions/functions')
+      const {ok, error, logs, total} = await logsAction.logs(
         externalId,
         {limit: flags.limit},
         {token, projectId},

package/src/commands/functions/testFunctionsCommand.ts

@@ -42,22 +42,28 @@ const testFunctionsCommand: CliCommandDefinition = {
       return
     }
 
-    const {blueprintsActions, functionsActions, utils} = await import('@sanity/runtime-cli')
+    const {test} = await import('@sanity/runtime-cli/actions/functions')
+    const {blueprint} = await import('@sanity/runtime-cli/actions/blueprints')
+    const {findFunction} = await import('@sanity/runtime-cli/utils')
 
-    const {parsedBlueprint} = await blueprintsActions.blueprint.readBlueprintOnDisk({
+    const {parsedBlueprint} = await blueprint.readBlueprintOnDisk({
       getStack: false,
     })
 
-    const src = utils.findFunctions.getFunctionSource(parsedBlueprint, flags.name)
+    const src = findFunction.getFunctionSource(parsedBlueprint, flags.name)
     if (!src) {
       print(`Error: Function ${flags.name} has no source code`)
     }
 
-    const {json, logs, error} = await functionsActions.test.testAction(src, {
-      data: flags.data,
-      file: flags.file,
-      timeout: flags.timeout,
-    })
+    const {json, logs, error} = await test.testAction(
+      src,
+      {
+        data: flags.data,
+        file: flags.file,
+        timeout: flags.timeout,
+      },
+      {}, // @TODO: Add context
+    )
 
     if (error) {
       print(error.toString())

package/src/commands/index.ts

@@ -1,4 +1,13 @@
 import {type CliCommandDefinition, type CliCommandGroupDefinition} from '../types'
+import addBlueprintsCommand from './blueprints/addBlueprintsCommand'
+import blueprintsGroup from './blueprints/blueprintsGroup'
+import configBlueprintsCommand from './blueprints/configBlueprintsCommand'
+import deployBlueprintsCommand from './blueprints/deployBlueprintsCommand'
+import infoBlueprintsCommand from './blueprints/infoBlueprintsCommand'
+import initBlueprintsCommand from './blueprints/initBlueprintsCommand'
+import logsBlueprintsCommand from './blueprints/logsBlueprintsCommand'
+import planBlueprintsCommand from './blueprints/planBlueprintsCommand'
+import listBlueprintsCommand from './blueprints/stacksBlueprintsCommand'
 import codemodCommand from './codemod/codemodCommand'
 import debugCommand from './debug/debugCommand'
 import docsCommand from './docs/docsCommand'
@@ -49,4 +58,13 @@ export const baseCommands: (CliCommandDefinition | CliCommandGroupDefinition)[]
   logsfunctionsCommand,
   testfunctionsCommand,
   envFunctionsCommand,
+  blueprintsGroup,
+  infoBlueprintsCommand,
+  listBlueprintsCommand,
+  initBlueprintsCommand,
+  deployBlueprintsCommand,
+  logsBlueprintsCommand,
+  addBlueprintsCommand,
+  configBlueprintsCommand,
+  planBlueprintsCommand,
 ]