@sanity/cli 3.84.1-next.2 → 3.85.0

package/lib/index.d.mts

@@ -128,6 +128,16 @@ export declare interface CliConfig {
    * Signals to `sanity` commands that this is not a studio.
    */
   app?: AppConfig
+  /**
+   * Configuration for Sanity media libraries.
+   */
+  mediaLibrary?: {
+    /**
+     * The path to the Media Library aspects directory. When using the CLI to manage aspects, this
+     * is the directory they will be read from and written to.
+     */
+    aspectsPath: string
+  }
 }
 
 declare type CliConfigResult =

package/lib/index.d.ts

@@ -128,6 +128,16 @@ export declare interface CliConfig {
    * Signals to `sanity` commands that this is not a studio.
    */
   app?: AppConfig
+  /**
+   * Configuration for Sanity media libraries.
+   */
+  mediaLibrary?: {
+    /**
+     * The path to the Media Library aspects directory. When using the CLI to manage aspects, this
+     * is the directory they will be read from and written to.
+     */
+    aspectsPath: string
+  }
 }
 
 declare type CliConfigResult =

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/cli",
-  "version": "3.84.1-next.2",
+  "version": "3.85.0",
   "description": "Sanity CLI tool for managing Sanity installations, managing plugins, schemas and datasets",
   "keywords": [
     "sanity",
@@ -58,12 +58,12 @@
   },
   "dependencies": {
     "@babel/traverse": "^7.23.5",
-    "@sanity/client": "^6.28.4",
-    "@sanity/codegen": "3.84.1-next.2",
-    "@sanity/runtime-cli": "^1.1.1",
+    "@sanity/client": "^6.29.0",
+    "@sanity/codegen": "3.85.0",
+    "@sanity/runtime-cli": "^2.5.0",
     "@sanity/telemetry": "^0.8.0",
     "@sanity/template-validator": "^2.4.3",
-    "@sanity/util": "3.84.1-next.2",
+    "@sanity/util": "3.85.0",
     "chalk": "^4.1.2",
     "debug": "^4.3.4",
     "decompress": "^4.2.0",
@@ -77,13 +77,13 @@
     "validate-npm-package-name": "^3.0.0"
   },
   "devDependencies": {
-    "@repo/package.config": "3.84.0",
-    "@repo/test-config": "3.84.0",
+    "@repo/package.config": "3.85.0",
+    "@repo/test-config": "3.85.0",
     "@rexxars/gitconfiglocal": "^3.0.1",
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@sanity/eslint-config-studio": "^4.0.0",
     "@sanity/generate-help-url": "^3.0.0",
-    "@sanity/types": "3.84.1-next.2",
+    "@sanity/types": "3.85.0",
     "@types/babel__traverse": "^7.20.5",
     "@types/configstore": "^5.0.1",
     "@types/cpx": "^1.5.2",
@@ -135,5 +135,5 @@
   "engines": {
     "node": ">=18"
   },
-  "gitHead": "4d4623a564198367850adfb2d81c71ec33e11e68"
+  "gitHead": "b29374fa3044d1707d15229dc300f4e0595cfa4b"
 }

package/src/commands/functions/devFunctionsCommand.ts

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

package/src/commands/functions/envFunctionsCommand.ts

@@ -0,0 +1,109 @@
+import {type StackFunctionResource} from '@sanity/runtime-cli/dist/utils/types'
+
+import {type CliCommandDefinition} from '../../types'
+
+const helpText = `
+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/
+
+  # Remove an environment variable
+  sanity functions env --name echo --remove --key API_URL
+`
+
+const defaultFlags = {
+  name: '',
+  add: false,
+  remove: false,
+  key: '',
+  value: '',
+}
+
+const envFunctionsCommand: CliCommandDefinition = {
+  name: 'env',
+  group: 'functions',
+  helpText,
+  signature: '',
+  description: 'Add or remove an environment variable for a Sanity function',
+  hideFromHelp: true,
+  async action(args, context) {
+    const {apiClient, output} = context
+    const {print} = output
+    const flags = {...defaultFlags, ...args.extOptions}
+
+    const client = apiClient({
+      requireUser: true,
+      requireProject: false,
+    })
+
+    if (flags.name === '') {
+      print('You must provide a function name')
+      return
+    }
+
+    const token = client.config().token
+    const {blueprintsActions, functionsActions, utils} = await import('@sanity/runtime-cli')
+
+    const {deployedStack} = await blueprintsActions.blueprint.readBlueprintOnDisk({
+      getStack: true,
+      token,
+    })
+
+    if (!deployedStack) {
+      print('Stack not found')
+      return
+    }
+
+    const blueprintConfig = blueprintsActions.blueprint.readConfigFile()
+    const projectId = blueprintConfig?.projectId
+
+    const {externalId} = utils.findFunctions.findFunctionByName(
+      deployedStack,
+      flags.name,
+    ) as StackFunctionResource
+
+    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,
+          },
+        )
+        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) {
+        print(`Removing "${flags.key}" environment variable in "${flags.name}"`)
+        const result = await functionsActions.env.remove.remove(externalId, flags.key, {
+          token,
+          projectId,
+        })
+        if (result.ok) {
+          print(`Remove of ${flags.key} succeeded`)
+        } else {
+          print(`Failed to remove ${flags.key}`)
+          print(`Error: ${result.error || 'Unknown error'}`)
+        }
+      }
+    } else {
+      print('You must run this command from a blueprints project')
+    }
+  },
+}
+
+export default envFunctionsCommand

package/src/commands/functions/logsFunctionsCommand.ts

@@ -1,16 +1,28 @@
+import {type StackFunctionResource} from '@sanity/runtime-cli/dist/utils/types'
+
 import {type CliCommandDefinition} from '../../types'
 
 const helpText = `
 Options
-  --id <id> The ID of the function to retrieve logs for
+  --name <name> The name of the function to retrieve logs for
+  --limit <limit> The number of log entries to retrieve
+  --json If set return json
 
 Examples
   # Retrieve logs for Sanity Function abcd1234
-  sanity functions logs --id abcd1234
+  sanity functions logs --name echo
+
+  # Retrieve the last two log entries for Sanity Function abcd1234
+  sanity functions logs --name echo --limit 2
+
+  # Retrieve logs for Sanity Function abcd1234 in json format
+  sanity functions logs --name echo --json
 `
 
 const defaultFlags = {
-  id: undefined,
+  name: '',
+  limit: 50,
+  json: false,
 }
 
 const logsFunctionsCommand: CliCommandDefinition = {
@@ -30,15 +42,71 @@ const logsFunctionsCommand: CliCommandDefinition = {
       requireProject: false,
     })
 
-    if (flags.id) {
-      const token = client.config().token
-      if (token) {
-        const {logsAction} = await import('@sanity/runtime-cli')
-        const result = await logsAction(flags.id, token)
-        print(JSON.stringify(result, null, 2))
+    if (flags.name === '') {
+      print('You must provide a function name')
+      return
+    }
+
+    const token = client.config().token
+    const {blueprintsActions, utils} = await import('@sanity/runtime-cli')
+
+    const {deployedStack} = await blueprintsActions.blueprint.readBlueprintOnDisk({
+      getStack: true,
+      token,
+    })
+
+    if (!deployedStack) {
+      print('Stack not found')
+      return
+    }
+
+    const blueprintConfig = blueprintsActions.blueprint.readConfigFile()
+    const projectId = blueprintConfig?.projectId
+
+    const {externalId} = utils.findFunctions.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(
+        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 (filteredLogs.length === 0) {
+        print(`No logs found for function ${flags.name}`)
+        return
+      }
+
+      if (flags.json) {
+        print(JSON.stringify(filteredLogs, null, 2))
+      } else {
+        print(`Found ${total} log entries for function ${flags.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)
+          print(`${date.toLocaleDateString()} ${date.toLocaleTimeString()} ${level} ${message}`)
+        }
       }
     } else {
-      print('You must provide a function ID')
+      print('You must run this command from a blueprints project')
     }
   },
 }

package/src/commands/functions/testFunctionsCommand.ts

@@ -4,24 +4,24 @@ const helpText = `
 Options
   --data <data> Data to send to the function
   --file <file> Read data from file and send to the function
-  --path <path> Path to your Sanity Function code
+  --name <name> The name of your Sanity Function
   --timeout <timeout> Execution timeout value in seconds
 
 Examples
   # Test function passing event data on command line
-  sanity functions test --path ./test.ts --data '{ "id": 1 }'
+  sanity functions test --name echo --data '{ "id": 1 }'
 
   # Test function passing event data via a file
-  sanity functions test -path ./test.js --file 'payload.json'
+  sanity functions test -name echo --file 'payload.json'
 
   # Test function passing event data on command line and cap execution time to 60 seconds
-  sanity functions test -path ./test.ts --data '{ "id": 1 }' --timeout 60
+  sanity functions test -name echo --data '{ "id": 1 }' --timeout 60
 `
 
 const defaultFlags = {
   data: undefined,
   file: undefined,
-  path: undefined,
+  name: '',
   timeout: 5, // seconds
 }
 
@@ -37,24 +37,35 @@ const testFunctionsCommand: CliCommandDefinition = {
     const {print} = output
     const flags = {...defaultFlags, ...args.extOptions}
 
-    if (flags.path) {
-      const {testAction} = await import('@sanity/runtime-cli')
-      const {json, logs, error} = await testAction(flags.path, {
-        data: flags.data,
-        file: flags.file,
-        timeout: flags.timeout,
-      })
-
-      if (error) {
-        print(error.toString())
-      } else {
-        print('Logs:')
-        print(logs)
-        print('Response:')
-        print(JSON.stringify(json, null, 2))
-      }
+    if (flags.name === '') {
+      print('You must provide a function name')
+      return
+    }
+
+    const {blueprintsActions, functionsActions, utils} = await import('@sanity/runtime-cli')
+
+    const {parsedBlueprint} = await blueprintsActions.blueprint.readBlueprintOnDisk({
+      getStack: false,
+    })
+
+    const src = utils.findFunctions.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,
+    })
+
+    if (error) {
+      print(error.toString())
     } else {
-      print('You must provide a path to the Sanity Function code')
+      print('Logs:')
+      print(logs)
+      print('Response:')
+      print(JSON.stringify(json, null, 2))
     }
   },
 }

package/src/commands/index.ts

@@ -3,6 +3,7 @@ import codemodCommand from './codemod/codemodCommand'
 import debugCommand from './debug/debugCommand'
 import docsCommand from './docs/docsCommand'
 import devfunctionsCommand from './functions/devFunctionsCommand'
+import envFunctionsCommand from './functions/envFunctionsCommand'
 import functionsGroup from './functions/functionsGroup'
 import logsfunctionsCommand from './functions/logsFunctionsCommand'
 import testfunctionsCommand from './functions/testFunctionsCommand'
@@ -47,4 +48,5 @@ export const baseCommands: (CliCommandDefinition | CliCommandGroupDefinition)[]
   devfunctionsCommand,
   logsfunctionsCommand,
   testfunctionsCommand,
+  envFunctionsCommand,
 ]

package/src/types.ts

@@ -360,6 +360,17 @@ export interface CliConfig {
    * Signals to `sanity` commands that this is not a studio.
    */
   app?: AppConfig
+
+  /**
+   * Configuration for Sanity media libraries.
+   */
+  mediaLibrary?: {
+    /**
+     * The path to the Media Library aspects directory. When using the CLI to manage aspects, this
+     * is the directory they will be read from and written to.
+     */
+    aspectsPath: string
+  }
 }
 
 export type UserViteConfig =