@sanity/cli 3.77.3-server-side-schemas.26 → 3.77.3-server-side-schemas.36

package/src/actions/init-project/templates/{coreApp.ts → appQuickstart.ts}

@@ -1,9 +1,9 @@
 import {type ProjectTemplate} from '../initProject'
 
-const coreAppTemplate: ProjectTemplate = {
+const appTemplate: ProjectTemplate = {
   dependencies: {
-    '@sanity/sdk': '^0.0.0-alpha',
-    '@sanity/sdk-react': '^0.0.0-alpha',
+    '@sanity/sdk': '^0.0.0-rc',
+    '@sanity/sdk-react': '^0.0.0-rc',
     'react': '^19',
     'react-dom': '^19',
   },
@@ -21,11 +21,10 @@ const coreAppTemplate: ProjectTemplate = {
   },
   appLocation: './src/App.tsx',
   scripts: {
-    // this will eventually run a concurrently process with another in-flight utility
-    dev: 'sanity app dev',
-    build: 'sanity app build',
-    start: 'sanity app start',
+    dev: 'sanity dev',
+    build: 'sanity build',
+    start: 'sanity start',
   },
 }
 
-export default coreAppTemplate
+export default appTemplate

package/src/actions/init-project/templates/index.ts

@@ -1,7 +1,7 @@
 import {type ProjectTemplate} from '../initProject'
+import appTemplate from './appQuickstart'
 import blog from './blog'
 import clean from './clean'
-import coreAppTemplate from './coreApp'
 import getStartedTemplate from './getStarted'
 import moviedb from './moviedb'
 import quickstart from './quickstart'
@@ -11,7 +11,7 @@ import shopifyOnline from './shopifyOnline'
 const templates: Record<string, ProjectTemplate | undefined> = {
   blog,
   clean,
-  'core-app': coreAppTemplate,
+  'app-quickstart': appTemplate,
   'get-started': getStartedTemplate,
   moviedb,
   shopify,

package/src/cli.ts

@@ -47,17 +47,16 @@ export async function runCli(cliRoot: string, {cliVersion}: {cliVersion: string}
 
   const args = parseArguments()
   const isInit = args.groupOrCommand === 'init' && args.argsWithoutOptions[0] !== 'plugin'
-  const isCoreApp = args.groupOrCommand === 'app'
   const cwd = getCurrentWorkingDirectory()
   let workDir: string | undefined
   try {
-    workDir = isInit ? process.cwd() : resolveRootDir(cwd, isCoreApp)
+    workDir = isInit ? process.cwd() : resolveRootDir(cwd)
   } catch (err) {
     console.error(chalk.red(err.message))
     process.exit(1)
   }
 
-  loadAndSetEnvFromDotEnvFiles({workDir, cmd: args.groupOrCommand, isCoreApp})
+  loadAndSetEnvFromDotEnvFiles({workDir, cmd: args.groupOrCommand})
   maybeFixMissingWindowsEnvVar()
 
   // Check if there are updates available for the CLI, and notify if there is
@@ -100,7 +99,6 @@ export async function runCli(cliRoot: string, {cliVersion}: {cliVersion: string}
     corePath: await getCoreModulePath(workDir, cliConfig),
     cliConfig,
     telemetry,
-    isCoreApp,
   }
 
   warnOnNonProductionEnvironment()
@@ -276,15 +274,7 @@ function warnOnNonProductionEnvironment(): void {
   )
 }
 
-function loadAndSetEnvFromDotEnvFiles({
-  workDir,
-  cmd,
-  isCoreApp,
-}: {
-  workDir: string
-  cmd: string
-  isCoreApp: boolean
-}) {
+function loadAndSetEnvFromDotEnvFiles({workDir, cmd}: {workDir: string; cmd: string}) {
   /* eslint-disable no-process-env */
 
   // Do a cheap lookup for a sanity.json file. If there is one, assume it is a v2 project,
@@ -319,7 +309,7 @@ function loadAndSetEnvFromDotEnvFiles({
 
   debug('Loading environment files using %s mode', mode)
 
-  const studioEnv = loadEnv(mode, workDir, isCoreApp ? ['VITE_'] : ['SANITY_STUDIO_'])
+  const studioEnv = loadEnv(mode, workDir, ['SANITY_STUDIO_'])
   process.env = {...process.env, ...studioEnv}
   /* eslint-disable no-process-env */
 }

package/src/commands/functions/devFunctionsCommand.ts

@@ -0,0 +1,42 @@
+import open from 'open'
+
+import {type CliCommandDefinition} from '../../types'
+
+const helpText = `
+Options
+  --port <port> Port to start emulator on
+
+Examples
+  # Start dev server on default port
+  sanity functions dev
+
+  # Start dev server on specific port
+  sanity functions dev --port 3333
+`
+
+const defaultFlags = {
+  port: 8080,
+}
+
+const devFunctionsCommand: CliCommandDefinition = {
+  name: 'dev',
+  group: 'functions',
+  helpText,
+  signature: '',
+  description: 'Start the Sanity Function emulator',
+  hideFromHelp: true,
+  async action(args, context) {
+    const {output} = context
+    const {print} = output
+    const flags = {...defaultFlags, ...args.extOptions}
+
+    const {devAction} = await import('@sanity/runtime-cli')
+
+    devAction(flags.port)
+
+    print(`Server is running on port ${flags.port}\n`)
+    open(`http://localhost:${flags.port}`)
+  },
+}
+
+export default devFunctionsCommand

package/src/commands/functions/functionsGroup.ts

@@ -0,0 +1,11 @@
+import {type CliCommandGroupDefinition} from '../../types'
+
+const functionsGroup: CliCommandGroupDefinition = {
+  name: 'functions',
+  signature: '[COMMAND]',
+  isGroupRoot: true,
+  description: 'Test Sanity Functions locally and retrieve logs',
+  hideFromHelp: true,
+}
+
+export default functionsGroup

package/src/commands/functions/logsFunctionsCommand.ts

@@ -0,0 +1,46 @@
+import {type CliCommandDefinition} from '../../types'
+
+const helpText = `
+Options
+  --id <id> The ID of the function to retrieve logs for
+
+Examples
+  # Retrieve logs for Sanity Function abcd1234
+  sanity functions logs --id abcd1234
+`
+
+const defaultFlags = {
+  id: undefined,
+}
+
+const logsFunctionsCommand: CliCommandDefinition = {
+  name: 'logs',
+  group: 'functions',
+  helpText,
+  signature: '',
+  description: 'Retrieve logs 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.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))
+      }
+    } else {
+      print('You must provide a function ID')
+    }
+  },
+}
+
+export default logsFunctionsCommand

package/src/commands/functions/testFunctionsCommand.ts

@@ -0,0 +1,62 @@
+import {type CliCommandDefinition} from '../../types'
+
+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
+  --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 }'
+
+  # Test function passing event data via a file
+  sanity functions test -path ./test.js --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
+`
+
+const defaultFlags = {
+  data: undefined,
+  file: undefined,
+  path: undefined,
+  timeout: 5, // seconds
+}
+
+const testFunctionsCommand: CliCommandDefinition = {
+  name: 'test',
+  group: 'functions',
+  helpText,
+  signature: '',
+  description: 'Invoke a local Sanity Function',
+  hideFromHelp: true,
+  async action(args, context) {
+    const {output} = context
+    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))
+      }
+    } else {
+      print('You must provide a path to the Sanity Function code')
+    }
+  },
+}
+
+export default testFunctionsCommand

package/src/commands/index.ts

@@ -2,6 +2,10 @@ import {type CliCommandDefinition, type CliCommandGroupDefinition} from '../type
 import codemodCommand from './codemod/codemodCommand'
 import debugCommand from './debug/debugCommand'
 import docsCommand from './docs/docsCommand'
+import devfunctionsCommand from './functions/devFunctionsCommand'
+import functionsGroup from './functions/functionsGroup'
+import logsfunctionsCommand from './functions/logsFunctionsCommand'
+import testfunctionsCommand from './functions/testFunctionsCommand'
 import helpCommand from './help/helpCommand'
 import initCommand from './init/initCommand'
 import installCommand from './install/installCommand'
@@ -39,4 +43,8 @@ export const baseCommands: (CliCommandDefinition | CliCommandGroupDefinition)[]
   telemetryStatusCommand,
   generateTypegenCommand,
   typegenGroup,
+  functionsGroup,
+  devfunctionsCommand,
+  logsfunctionsCommand,
+  testfunctionsCommand,
 ]

package/src/commands/init/initCommand.ts

@@ -101,7 +101,6 @@ export const initCommand: CliCommandDefinition<InitFlags> = {
   description: 'Initializes a new Sanity Studio and/or project',
   helpText,
   action: async (args, context) => {
-    const {output, chalk} = context
     const [type] = args.argsWithoutOptions
 
     // `sanity init whatever`

package/src/types.ts

@@ -147,7 +147,6 @@ export interface CommandRunnerOptions {
   workDir: string
   corePath: string | undefined
   telemetry: TelemetryLogger<TelemetryUserProperties>
-  isCoreApp: boolean
 }
 
 export interface CliOutputter {
@@ -352,8 +351,8 @@ export interface CliConfig {
    * Signals to `sanity` commands that this is not a studio.
    * @internal
    */
-  __experimental_coreAppConfiguration?: {
-    organizationId?: string
+  __experimental_appConfiguration?: {
+    organizationId: string
     appLocation?: string
     appId?: string
   }

package/src/util/clientWrapper.ts

@@ -15,7 +15,7 @@ import {getUserConfig} from './getUserConfig'
 
 const apiHosts: Record<string, string | undefined> = {
   staging: 'https://api.sanity.work',
-  development: 'http://api.sanity.wtf',
+  development: 'http://api.sanity.local',
 }
 
 /**

package/src/util/resolveRootDir.ts

@@ -7,9 +7,9 @@ import {debug} from '../debug'
 /**
  * Resolve project root directory, falling back to cwd if it cannot be found
  */
-export function resolveRootDir(cwd: string, isCoreApp = false): string {
+export function resolveRootDir(cwd: string): string {
   try {
-    return resolveProjectRoot(cwd, 0, isCoreApp) || cwd
+    return resolveProjectRoot(cwd) || cwd
   } catch (err) {
     throw new Error(`Error occurred trying to resolve project root:\n${err.message}`)
   }
@@ -25,8 +25,8 @@ function hasSanityConfig(basePath: string, configName: string): boolean {
   return buildConfigs.some(Boolean)
 }
 
-function resolveProjectRoot(basePath: string, iterations = 0, isCoreApp = false): string | false {
-  const configName = isCoreApp ? 'sanity.cli' : 'sanity.config'
+function resolveProjectRoot(basePath: string, iterations = 0): string | false {
+  const configName = 'sanity.config'
   if (hasSanityConfig(basePath, configName)) {
     return basePath
   }
@@ -37,7 +37,7 @@ function resolveProjectRoot(basePath: string, iterations = 0, isCoreApp = false)
     return false
   }
 
-  return resolveProjectRoot(parentDir, iterations + 1, isCoreApp)
+  return resolveProjectRoot(parentDir, iterations + 1)
 }
 
 function isSanityV2StudioRoot(basePath: string): boolean {

package/templates/core-app/src/App.css

@@ -0,0 +1,18 @@
+/* Container styling for the app */
+.app-container {
+  max-width: 1200px;
+  margin: 0 auto;
+  padding: 2rem;
+  font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen, Ubuntu, Cantarell, 'Open Sans', 'Helvetica Neue', sans-serif;
+}
+
+/* Basic reset */
+* {
+  box-sizing: border-box;
+}
+
+body {
+  margin: 0;
+  padding: 0;
+  background-color: #f9f9f9;
+}

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

@@ -1,27 +1,25 @@
 import {type SanityConfig} from '@sanity/sdk'
-import {SanityApp} from '@sanity/sdk-react/components'
+import {SanityApp} from '@sanity/sdk-react'
 import {ExampleComponent} from './ExampleComponent'
+import './App.css'
 
 export function App() {
-
-  const sanityConfig: SanityConfig = {
-    auth: {
-      authScope: 'global'
+  // apps can access many different projects or other sources of data
+  const sanityConfigs: SanityConfig[] = [
+    {
+      projectId: 'project-id',
+      dataset: 'dataset-name',
     }
-    /* 
-     * Apps can access several different projects!
-     * Add the below configuration if you want to connect to a specific project.
-     */
-    // projectId: 'my-project-id',
-    // dataset: 'my-dataset',
-  }
+  ]
 
   return (
-    <SanityApp sanityConfig={sanityConfig}>
-      {/* add your own components here! */}
-      <ExampleComponent />
-    </SanityApp>
+    <div className="app-container">
+      <SanityApp sanityConfigs={sanityConfigs} fallback={<div>Loading...</div>}>
+        {/* add your own components here! */}
+        <ExampleComponent />
+      </SanityApp>
+    </div>
   )
 }
 
-export default App
+export default App

package/templates/core-app/src/ExampleComponent.css

@@ -0,0 +1,26 @@
+.example-container {
+  background-color: white;
+  border-radius: 8px;
+  padding: 2rem;
+  box-shadow: 0 2px 8px rgba(0, 0, 0, 0.05);
+}
+
+.example-heading {
+  color: #333;
+  margin-top: 0;
+  font-size: 1.8rem;
+}
+
+.example-text {
+  color: #666;
+  line-height: 1.6;
+}
+
+.code-hint {
+  background-color: #f5f5f5;
+  padding: 1rem;
+  border-radius: 4px;
+  font-family: monospace;
+  margin-top: 1.5rem;
+  border-left: 3px solid #e0e0e0;
+}

package/templates/core-app/src/ExampleComponent.tsx

@@ -1,11 +1,22 @@
+import './ExampleComponent.css'
+
 export function ExampleComponent() {
   return (
-    <div>
-      <h1>Welcome to Your Sanity App!</h1>
-      <p>
+    <div className="example-container">
+      <h1 className="example-heading">Welcome to your Sanity App!</h1>
+      <p className="example-text">
         This is an example component. You can replace this with your own content
         by creating a new component and importing it in App.tsx.
       </p>
+      <div className="code-hint">
+        <p>Quick tip: Create new components in separate files and import them like this in App.tsx / App.jsx:</p>
+        <pre>{`import {YourComponent} from './YourComponent'
+
+// Then use it in your JSX 
+<SanityApp sanityConfigs={sanityConfigs}>
+  <YourComponent />
+</SanityApp>`}</pre>
+      </div>
     </div>
   )
-}
+}