@sanity/cli 3.85.2-media-library.14 → 3.86.1

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,27 +1,29 @@
-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 = `
+Arguments
+  [add] Add or update an environment variable
+  [remove] Remove an environment variable
+
 Options
   --name <name> The name of the function
-  --add Add or update an environment variable
-  --remove Remove an environment variable
   --key <key> The name of the environment variable
   --value <value> The value of the environment variable
 
 Examples
   # Add or update an environment variable
-  sanity functions env --name echo --add --key API_URL --value https://api.example.com/
+  sanity functions env add --name echo --key API_URL --value https://api.example.com/
 
   # Remove an environment variable
-  sanity functions env --name echo --remove --key API_URL
+  sanity functions env remove --name echo --key API_URL
 `
 
 const defaultFlags = {
   name: '',
-  add: false,
-  remove: false,
   key: '',
   value: '',
 }
@@ -36,60 +38,60 @@ const envFunctionsCommand: CliCommandDefinition = {
   async action(args, context) {
     const {apiClient, output} = context
     const {print} = output
+    const [subCommand] = args.argsWithoutOptions
     const flags = {...defaultFlags, ...args.extOptions}
 
+    if (!subCommand || !['add', 'remove'].includes(subCommand)) {
+      throw new Error('You must specify if you wish to add or remove an environment variable')
+    }
+
     const client = apiClient({
       requireUser: true,
       requireProject: false,
     })
 
     if (flags.name === '') {
-      print('You must provide a function name')
-      return
+      throw new Error('You must provide a function name via the --name flag')
     }
 
     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,
     })
 
     if (!deployedStack) {
-      print('Stack not found')
-      return
+      throw new Error('Stack not found')
     }
 
-    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) {
-      if (flags.add) {
+      if (subCommand === '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 {
           print(`Failed to update ${flags.key}`)
           print(`Error: ${result.error || 'Unknown error'}`)
         }
-      } else if (flags.remove) {
+      } else if (subCommand === '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,12 +1,15 @@
-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
-  --limit <limit> The number of log entries to retrieve
+  --limit <limit> The number of log entries to retrieve [default 50]
   --json If set return json
+  --utc Use UTC dates in logs
 
 Examples
   # Retrieve logs for Sanity Function abcd1234
@@ -23,6 +26,7 @@ const defaultFlags = {
   name: '',
   limit: 50,
   json: false,
+  utc: false,
 }
 
 const logsFunctionsCommand: CliCommandDefinition = {
@@ -43,34 +47,33 @@ const logsFunctionsCommand: CliCommandDefinition = {
     })
 
     if (flags.name === '') {
-      print('You must provide a function name')
-      return
+      throw new Error('You must provide a function name via the --name flag')
     }
 
     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,
     })
 
     if (!deployedStack) {
-      print('Stack not found')
-      return
+      throw new Error('Stack not found')
     }
 
-    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},
@@ -102,7 +105,10 @@ const logsFunctionsCommand: CliCommandDefinition = {
         for (const log of filteredLogs) {
           const {time, level, message} = log
           const date = new Date(time)
-          print(`${date.toLocaleDateString()} ${date.toLocaleTimeString()} ${level} ${message}`)
+          const dateString = flags.utc
+            ? date.toISOString().slice(0, 19).split('T').join(' ')
+            : `${date.toLocaleDateString()} ${date.toLocaleTimeString()}`
+          print(`${dateString} ${level} ${message}`)
         }
       }
     } else {

package/src/commands/functions/testFunctionsCommand.ts

@@ -38,26 +38,31 @@ const testFunctionsCommand: CliCommandDefinition = {
     const flags = {...defaultFlags, ...args.extOptions}
 
     if (flags.name === '') {
-      print('You must provide a function name')
-      return
+      throw new Error('You must provide a function name via the --name flag')
     }
 
-    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`)
+      throw new Error(`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,
 ]