@sanity/cli 3.88.3 → 3.89.0

package/src/commands/functions/envFunctionsCommand.ts

@@ -22,7 +22,11 @@ Examples
   sanity functions env list echo
 `
 
-const envFunctionsCommand: CliCommandDefinition = {
+export interface FunctionsEnvFlags {
+  //
+}
+
+const envFunctionsCommand: CliCommandDefinition<FunctionsEnvFlags> = {
   name: 'env',
   group: 'functions',
   helpText,
@@ -31,7 +35,6 @@ const envFunctionsCommand: CliCommandDefinition = {
     '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, name, key, value] = args.argsWithoutOptions
 
     if (!subCommand || !['add', 'list', 'remove'].includes(subCommand)) {
@@ -49,71 +52,53 @@ const envFunctionsCommand: CliCommandDefinition = {
       requireProject: false,
     })
 
-    if (name === '') {
+    if (!name) {
       throw new Error('You must provide a function name as the first argument')
     }
 
     const token = client.config().token
     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 getBlueprintAndStack({token})
-
-    if (!deployedStack) {
-      throw new Error('Stack not found')
-    }
+    const {initDeployedBlueprintConfig} = await import('@sanity/runtime-cli/cores')
+    const {functionEnvAddCore, functionEnvListCore, functionEnvRemoveCore} = await import(
+      '@sanity/runtime-cli/cores/functions'
+    )
 
-    const blueprintConfig = blueprint.readConfigFile()
-    const projectId = blueprintConfig?.projectId
+    const cmdConfig = await initDeployedBlueprintConfig({
+      bin: 'sanity',
+      log: (message) => output.print(message),
+      token,
+    })
 
-    const {externalId} = findFunction.findFunctionByName(deployedStack, name)
+    if (!cmdConfig.ok) throw new Error(cmdConfig.error)
 
-    if (token && projectId) {
-      if (subCommand === 'add') {
-        print(`Updating "${key}" environment variable in "${name}"`)
-        const result = await envAction.update(externalId, key, value, {
-          token,
-          projectId,
+    let response
+    switch (subCommand) {
+      case 'add':
+        response = await functionEnvAddCore({
+          ...cmdConfig.value,
+          args: {name, key, value},
         })
-        if (result.ok) {
-          print(`Update of "${key}" succeeded`)
-        } else {
-          print(`Failed to update "${key}"`)
-          print(`Error: ${result.error || 'Unknown error'}`)
-        }
-      } else if (subCommand === 'remove') {
-        print(`Removing "${key}" environment variable in "${name}"`)
-        const result = await envAction.remove(externalId, key, {
-          token,
-          projectId,
+        break
+      case 'list':
+        response = await functionEnvListCore({
+          ...cmdConfig.value,
+          args: {name},
         })
-        if (result.ok) {
-          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,
+        break
+      case 'remove':
+        response = await functionEnvRemoveCore({
+          ...cmdConfig.value,
+          args: {name, key},
         })
-        if (result.ok && Array.isArray(result.envvars)) {
-          for (const envVarKey of result.envvars) {
-            print(envVarKey)
-          }
-        } else {
-          print(`Failed to list environment variables in "${key}"`)
-          print(`Error: ${result.error || 'Unknown error'}`)
-        }
-      }
-    } else {
-      print('You must run this command from a blueprints project')
+        break
+      default:
+        throw new Error(`Unknown subcommand: ${subCommand}`)
     }
+
+    const {success, error} = response
+
+    if (!success) throw new Error(error)
   },
 }
 

package/src/commands/functions/functionsGroup.ts

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

package/src/commands/functions/logsFunctionsCommand.ts

@@ -1,6 +1,3 @@
-import chalk from 'chalk'
-import inquirer from 'inquirer'
-
 import {type CliCommandDefinition} from '../../types'
 
 const helpText = `
@@ -11,6 +8,8 @@ Options
   --limit <limit> The number of log entries to retrieve [default 50]
   --json If set return json
   --utc Use UTC dates in logs
+  --delete Delete all logs for the Function
+  --force Force delete all logs for the Function
 
 Examples
   # Retrieve logs for Sanity Function
@@ -26,23 +25,32 @@ Examples
   sanity functions logs --name echo --delete
 `
 
+export interface FunctionsLogsFlags {
+  limit?: number
+  json?: boolean
+  utc?: boolean
+  delete?: boolean
+  force?: boolean
+  watch?: boolean // undocumented for now
+}
+
 const defaultFlags = {
   limit: 50,
   json: false,
   utc: false,
   delete: false,
   force: false,
+  watch: false,
 }
 
-const logsFunctionsCommand: CliCommandDefinition = {
+const logsFunctionsCommand: CliCommandDefinition<FunctionsLogsFlags> = {
   name: 'logs',
   group: 'functions',
   helpText,
-  signature: '<name> [--limit <number>] [--json] [--utc] [--delete [--force]]',
+  signature: '<name> [--limit <number>] [--json] [--utc] [--delete [--force]] [--watch]',
   description: 'Retrieve or delete logs for a Sanity Function',
   async action(args, context) {
     const {apiClient, output} = context
-    const {print, error: printError} = output
     const [name] = args.argsWithoutOptions
     const flags = {...defaultFlags, ...args.extOptions}
 
@@ -58,106 +66,25 @@ const logsFunctionsCommand: CliCommandDefinition = {
     const token = client.config().token
     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 {initDeployedBlueprintConfig} = await import('@sanity/runtime-cli/cores')
+    const {functionLogsCore} = await import('@sanity/runtime-cli/cores/functions')
 
-    const {deployedStack} = await getBlueprintAndStack({token})
+    const cmdConfig = await initDeployedBlueprintConfig({
+      bin: 'sanity',
+      log: (message) => output.print(message),
+      token,
+    })
 
-    if (!deployedStack) {
-      throw new Error('Stack not found')
-    }
+    if (!cmdConfig.ok) throw new Error(cmdConfig.error)
 
-    const {projectId} = deployedStack
-
-    const {externalId} = findFunction.findFunctionByName(deployedStack, name)
-
-    if (token && projectId) {
-      const {logs: logsAction} = await import('@sanity/runtime-cli/actions/functions')
-
-      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
-        }
-
-        print(`Deleting logs for function ${chalk.yellow(name)}`)
-        const {ok, error} = await logsAction.deleteLogs(externalId, {token, projectId})
-
-        if (!ok) {
-          printError(`${chalk.red('Failed')} to retrieve logs`)
-          printError(`Error: ${error || 'Unknown error'}`)
-          return
-        }
-
-        print('Logs deleted')
-      } else {
-        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
-        }
-
-        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 {
-      print('You must run this command from a blueprints project')
-    }
-  },
-}
+    const {success, error} = await functionLogsCore({
+      ...cmdConfig.value,
+      args: {name},
+      flags,
+    })
 
-function logLevel(level: string) {
-  if (level === 'ERROR') {
-    return chalk.red(level)
-  }
-  if (level === 'WARN') {
-    return chalk.yellow(level)
-  }
-  return chalk.green(level)
+    if (!success) throw new Error(error)
+  },
 }
 
 export default logsFunctionsCommand

package/src/commands/functions/testFunctionsCommand.ts

@@ -24,18 +24,20 @@ Examples
   sanity functions test echo --data '{ "id": 1 }' --timeout 60
 `
 
-const defaultFlags = {
-  'data': undefined,
-  'file': undefined,
-  'timeout': 10, // seconds
-  'api': undefined,
-  'dataset': undefined,
-  'project-id': undefined,
-  'project': undefined,
-  'projectId': undefined,
+export interface FunctionsTestFlags {
+  'data'?: string
+  'file'?: string
+  'timeout'?: number
+  'api'?: string
+  'dataset'?: string
+  'project-id'?: string
 }
 
-const testFunctionsCommand: CliCommandDefinition = {
+const defaultFlags: FunctionsTestFlags = {
+  timeout: 10, // seconds
+}
+
+const testFunctionsCommand: CliCommandDefinition<FunctionsTestFlags> = {
   name: 'test',
   group: 'functions',
   helpText,
@@ -43,55 +45,47 @@ const testFunctionsCommand: CliCommandDefinition = {
     '<name> [--data <json>] [--file <filename>] [--timeout <seconds>] [--api <version>] [--dataset <name>] [--project-id] <id>]',
   description: 'Invoke a local Sanity Function',
   async action(args, context) {
-    const {output} = context
-    const {print, error: printError} = output
+    const {apiClient, output} = context
     const [name] = args.argsWithoutOptions
     const flags = {...defaultFlags, ...args.extOptions}
 
+    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 (!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.readLocalBlueprint()
-
-    try {
-      const fn = findFunction.findFunctionByName(parsedBlueprint, name)
-      if (!fn) {
-        throw new Error(`Function ${name} has no source code`)
-      }
-
-      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))
-      }
-    } catch (error) {
-      printError(`Error: ${error || 'Unknown error'}`)
-    }
+    const {initBlueprintConfig} = await import('@sanity/runtime-cli/cores')
+    const {functionTestCore} = await import('@sanity/runtime-cli/cores/functions')
+
+    const cmdConfig = await initBlueprintConfig({
+      bin: 'sanity',
+      log: (message: string) => output.print(message),
+      token,
+    })
+
+    if (!cmdConfig.ok) throw new Error(cmdConfig.error)
+
+    const {success, error} = await functionTestCore({
+      ...cmdConfig.value,
+      args: {name},
+      flags: {
+        'data': flags.data,
+        'file': flags.file,
+        'timeout': flags.timeout,
+        'api': flags.api,
+        'dataset': flags.dataset,
+        'project-id': flags['project-id'],
+      },
+    })
+
+    if (!success) throw new Error(error)
   },
 }
 

package/templates/app-quickstart/src/App.tsx

@@ -3,7 +3,7 @@ import {SanityApp} from '@sanity/sdk-react'
 import {ExampleComponent} from './ExampleComponent'
 import './App.css'
 
-export function App() {
+function App() {
   // apps can access many different projects or other sources of data
   const sanityConfigs: SanityConfig[] = [
     {

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

@@ -6,7 +6,7 @@ import {ExampleComponent} from './ExampleComponent'
 
 const theme = buildTheme()
 
-export function App() {
+function App() {
   // apps can access many different projects or other sources of data
   const sanityConfigs: SanityConfig[] = [
     {