@sanity/cli 3.88.0 → 3.88.1

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

package/src/commands/functions/logsFunctionsCommand.ts

@@ -1,44 +1,49 @@
-import {type types} from '@sanity/runtime-cli/utils'
+import chalk from 'chalk'
+import inquirer from 'inquirer'
 
 import {type CliCommandDefinition} from '../../types'
 
-type StackFunctionResource = types.StackFunctionResource
-
 const helpText = `
+Arguments
+  <name> The name of the Function to retrieve logs for
+
 Options
-  --name <name> The name of the function to retrieve logs for
   --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
-  sanity functions logs --name echo
+  # Retrieve logs for Sanity Function
+  sanity functions logs echo
 
-  # Retrieve the last two log entries for Sanity Function abcd1234
-  sanity functions logs --name echo --limit 2
+  # Retrieve the last two log entries for Sanity Function
+  sanity functions logs echo --limit 2
 
-  # Retrieve logs for Sanity Function abcd1234 in json format
+  # Retrieve logs for Sanity Function in json format
   sanity functions logs --name echo --json
+
+  # Delete all logs for Sanity Function
+  sanity functions logs --name echo --delete
 `
 
 const defaultFlags = {
-  name: '',
   limit: 50,
   json: false,
   utc: false,
+  delete: false,
+  force: false,
 }
 
 const logsFunctionsCommand: CliCommandDefinition = {
   name: 'logs',
   group: 'functions',
   helpText,
-  signature: '',
-  description: 'Retrieve logs for a Sanity Function',
-  hideFromHelp: true,
+  signature: '<name> [--limit <number>] [--json] [--utc] [--delete [--force]]',
+  description: 'Retrieve or delete logs for a Sanity Function',
   async action(args, context) {
     const {apiClient, output} = context
-    const {print} = output
+    const {print, error: printError} = output
+    const [name] = args.argsWithoutOptions
     const flags = {...defaultFlags, ...args.extOptions}
 
     const client = apiClient({
@@ -46,69 +51,97 @@ const logsFunctionsCommand: 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 {blueprint} = await import('@sanity/runtime-cli/actions/blueprints')
+    if (!token) throw new Error('No API token found. Please run `sanity login`.')
+
+    const {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')
     }
 
-    const blueprintConfig = blueprint.readConfigFile()
-    const projectId = blueprintConfig?.projectId
+    const {projectId} = deployedStack
 
-    const {externalId} = findFunction.findFunctionByName(
-      deployedStack,
-      flags.name,
-    ) as StackFunctionResource
+    const {externalId} = findFunction.findFunctionByName(deployedStack, name)
 
     if (token && projectId) {
       const {logs: logsAction} = await import('@sanity/runtime-cli/actions/functions')
-      const {ok, error, logs, total} = await logsAction.logs(
-        externalId,
-        {limit: flags.limit},
-        {token, projectId},
-      )
-
-      if (!ok) {
-        print(`Error: ${error || 'Unknown error'}`)
-        return
-      }
 
-      const filteredLogs = logs.filter(
-        (entry: {level: string; message: string}) => entry.level && entry.message,
-      )
+      if (!externalId) throw new Error('Unable to delete logs. Unable to determine function ID.')
+
+      if (flags.delete) {
+        if (!flags.force) {
+          const {certain} = await inquirer.prompt({
+            type: 'confirm',
+            name: 'certain',
+            message: `Are you sure you want to delete ${chalk.bold('all')} logs for function ${chalk.yellow(name)}?`,
+            default: false,
+          })
+          if (!certain) return
+        }
 
-      if (filteredLogs.length === 0) {
-        print(`No logs found for function ${flags.name}`)
-        return
-      }
+        print(`Deleting logs for function ${chalk.yellow(name)}`)
+        const {ok, error} = await logsAction.deleteLogs(externalId, {token, projectId})
 
-      if (flags.json) {
-        print(JSON.stringify(filteredLogs, null, 2))
+        if (!ok) {
+          printError(`${chalk.red('Failed')} to retrieve logs`)
+          printError(`Error: ${error || 'Unknown error'}`)
+          return
+        }
+
+        print('Logs deleted')
       } else {
-        print(`Found ${total} log entries for function ${flags.name}`)
-        if (logs.length < total) {
-          print(`Here are the last ${filteredLogs.length} entries`)
+        print(`Finding logs for function "${name}"`)
+
+        const {ok, error, logs, total} = await logsAction.logs(
+          externalId,
+          {limit: flags.limit},
+          {token, projectId},
+        )
+
+        if (!ok) {
+          printError(`${chalk.red('Failed')} to retrieve logs`)
+          printError(`Error: ${error || 'Unknown error'}`)
+          return
+        }
+
+        const filteredLogs = logs.filter(
+          (entry: {level: string; message: string}) => entry.level && entry.message,
+        )
+
+        if (filteredLogs.length === 0) {
+          print(`No logs found for function ${name}`)
+          return
         }
-        print('\n')
-
-        for (const log of filteredLogs) {
-          const {time, level, message} = log
-          const date = new Date(time)
-          const dateString = flags.utc
-            ? date.toISOString().slice(0, 19).split('T').join(' ')
-            : `${date.toLocaleDateString()} ${date.toLocaleTimeString()}`
-          print(`${dateString} ${level} ${message}`)
+
+        if (flags.json) {
+          print(JSON.stringify(filteredLogs, null, 2))
+        } else {
+          print(`Found ${total} log entries for function ${name}`)
+          if (logs.length < total) {
+            print(`Here are the last ${filteredLogs.length} entries`)
+          }
+          print('\n')
+
+          for (const log of filteredLogs) {
+            const {time, level, message} = log
+            const date = new Date(time)
+            const [dateString, timeString] = flags.utc
+              ? date.toISOString().slice(0, 19).split('T')
+              : [date.toLocaleDateString(), date.toLocaleTimeString()]
+            print(
+              [chalk.bold(dateString), chalk.bold.blue(timeString), logLevel(level), message].join(
+                ' ',
+              ),
+            )
+          }
         }
       }
     } else {
@@ -117,4 +150,14 @@ const logsFunctionsCommand: CliCommandDefinition = {
   },
 }
 
+function logLevel(level: string) {
+  if (level === 'ERROR') {
+    return chalk.red(level)
+  }
+  if (level === 'WARN') {
+    return chalk.yellow(level)
+  }
+  return chalk.green(level)
+}
+
 export default logsFunctionsCommand

package/src/commands/functions/testFunctionsCommand.ts

@@ -1,76 +1,96 @@
 import {type CliCommandDefinition} from '../../types'
 
 const helpText = `
+Arguments
+  <name> The name of the Sanity Function
+
 Options
   --data <data> Data to send to the function
   --file <file> Read data from file and send to the function
-  --name <name> The name of your Sanity Function
   --timeout <timeout> Execution timeout value in seconds
+  --api <version> Sanity API Version to use
+  --dataset <dataset> The Sanity dataset to use
+  --project-id <id> Sanity Project ID to use
+
 
 Examples
   # Test function passing event data on command line
-  sanity functions test --name echo --data '{ "id": 1 }'
+  sanity functions test echo --data '{ "id": 1 }'
 
   # Test function passing event data via a file
-  sanity functions test -name echo --file 'payload.json'
+  sanity functions test echo --file 'payload.json'
 
   # Test function passing event data on command line and cap execution time to 60 seconds
-  sanity functions test -name echo --data '{ "id": 1 }' --timeout 60
+  sanity functions test echo --data '{ "id": 1 }' --timeout 60
 `
 
 const defaultFlags = {
-  data: undefined,
-  file: undefined,
-  name: '',
-  timeout: 5, // seconds
+  'data': undefined,
+  'file': undefined,
+  'timeout': 10, // seconds
+  'api': undefined,
+  'dataset': undefined,
+  'project-id': undefined,
+  'project': undefined,
+  'projectId': undefined,
 }
 
 const testFunctionsCommand: CliCommandDefinition = {
   name: 'test',
   group: 'functions',
   helpText,
-  signature: '',
+  signature:
+    '<name> [--data <json>] [--file <filename>] [--timeout <seconds>] [--api <version>] [--dataset <name>] [--project-id] <id>]',
   description: 'Invoke a local Sanity Function',
-  hideFromHelp: true,
   async action(args, context) {
     const {output} = context
-    const {print} = output
+    const {print, error: printError} = output
+    const [name] = args.argsWithoutOptions
     const flags = {...defaultFlags, ...args.extOptions}
 
-    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 {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 blueprint.readBlueprintOnDisk({
-      getStack: false,
-    })
+    const {parsedBlueprint} = await blueprint.readLocalBlueprint()
 
-    const src = findFunction.getFunctionSource(parsedBlueprint, flags.name)
-    if (!src) {
-      throw new Error(`Error: Function ${flags.name} has no source code`)
-    }
+    try {
+      const fn = findFunction.findFunctionByName(parsedBlueprint, name)
+      if (!fn) {
+        throw new Error(`Function ${name} has no source code`)
+      }
 
-    const {json, logs, error} = await test.testAction(
-      src,
-      {
-        data: flags.data,
-        file: flags.file,
-        timeout: flags.timeout,
-      },
-      {}, // @TODO: Add context
-    )
+      const projectId = flags['project-id'] ?? flags.projectId ?? flags.project
+      const {json, logs, error} = await test.testAction(
+        fn,
+        {
+          data: flags.data,
+          file: flags.file,
+          timeout: flags.timeout,
+        },
+        {
+          clientOptions: {
+            apiVersion: flags.api,
+            dataset: flags.dataset,
+            projectId: projectId,
+          },
+        },
+      )
 
-    if (error) {
-      print(error.toString())
-    } else {
-      print('Logs:')
-      print(logs)
-      print('Response:')
-      print(JSON.stringify(json, null, 2))
+      if (error) {
+        print(error.toString())
+      } else {
+        print('Logs:')
+        print(logs)
+        print('Response:')
+        print(JSON.stringify(json, null, 2))
+      }
+    } catch (error) {
+      printError(`Error: ${error || 'Unknown error'}`)
     }
   },
 }

package/src/commands/index.ts

@@ -3,6 +3,7 @@ import addBlueprintsCommand from './blueprints/addBlueprintsCommand'
 import blueprintsGroup from './blueprints/blueprintsGroup'
 import configBlueprintsCommand from './blueprints/configBlueprintsCommand'
 import deployBlueprintsCommand from './blueprints/deployBlueprintsCommand'
+import destroyBlueprintsCommand from './blueprints/destroyBlueprintsCommand'
 import infoBlueprintsCommand from './blueprints/infoBlueprintsCommand'
 import initBlueprintsCommand from './blueprints/initBlueprintsCommand'
 import logsBlueprintsCommand from './blueprints/logsBlueprintsCommand'
@@ -59,12 +60,13 @@ export const baseCommands: (CliCommandDefinition | CliCommandGroupDefinition)[]
   testfunctionsCommand,
   envFunctionsCommand,
   blueprintsGroup,
+  addBlueprintsCommand,
+  configBlueprintsCommand,
+  deployBlueprintsCommand,
+  destroyBlueprintsCommand,
   infoBlueprintsCommand,
-  listBlueprintsCommand,
   initBlueprintsCommand,
-  deployBlueprintsCommand,
+  listBlueprintsCommand,
   logsBlueprintsCommand,
-  addBlueprintsCommand,
-  configBlueprintsCommand,
   planBlueprintsCommand,
 ]

package/templates/app-sanity-ui/src/ExampleComponent.tsx

@@ -23,7 +23,7 @@ export function ExampleComponent() {
             </Text>
             <Text muted>
               Looking for more guidance? See the <a href="https://sanity.io/ui">Sanity UI docs</a>{' '}
-              and the <a href="https://sdk-docs.sanity.dev">Sanity App SDK docs</a>!
+              and the <a href="https://reference.sanity.io/_sanity/sdk-react/">Sanity App SDK docs</a>!
             </Text>
           </Stack>
         </Flex>