@sanity/cli 3.74.1 → 3.74.2-canary.67

package/lib/index.d.mts

@@ -14,6 +14,7 @@ export declare type CliApiClient = (options?: ClientRequirements) => SanityClien
 
 export declare interface CliApiConfig {
   projectId?: string
+  organizationId?: string
   dataset?: string
 }
 
@@ -114,6 +115,14 @@ export declare interface CliConfig {
   vite?: UserViteConfig
   autoUpdates?: boolean
   studioHost?: string
+  /**
+   * Parameter used to configure other kinds of applications.
+   * Signals to `sanity` commands that this is not a studio.
+   * @internal
+   */
+  __experimental_coreAppConfiguration?: {
+    appLocation?: string
+  }
 }
 
 declare type CliConfigResult =
@@ -357,6 +366,7 @@ export declare function loadEnv(
 export declare interface PackageJson {
   name: string
   version: string
+  scripts?: Record<string, string>
   description?: string
   author?: string
   license?: string

package/lib/index.d.ts

@@ -14,6 +14,7 @@ export declare type CliApiClient = (options?: ClientRequirements) => SanityClien
 
 export declare interface CliApiConfig {
   projectId?: string
+  organizationId?: string
   dataset?: string
 }
 
@@ -114,6 +115,14 @@ export declare interface CliConfig {
   vite?: UserViteConfig
   autoUpdates?: boolean
   studioHost?: string
+  /**
+   * Parameter used to configure other kinds of applications.
+   * Signals to `sanity` commands that this is not a studio.
+   * @internal
+   */
+  __experimental_coreAppConfiguration?: {
+    appLocation?: string
+  }
 }
 
 declare type CliConfigResult =
@@ -357,6 +366,7 @@ export declare function loadEnv(
 export declare interface PackageJson {
   name: string
   version: string
+  scripts?: Record<string, string>
   description?: string
   author?: string
   license?: string

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/cli",
-  "version": "3.74.1",
+  "version": "3.74.2-canary.67+a9a66e73d5",
   "description": "Sanity CLI tool for managing Sanity installations, managing plugins, schemas and datasets",
   "keywords": [
     "sanity",
@@ -58,10 +58,10 @@
   "dependencies": {
     "@babel/traverse": "^7.23.5",
     "@sanity/client": "^6.27.2",
-    "@sanity/codegen": "3.74.1",
+    "@sanity/codegen": "3.74.2-canary.67+a9a66e73d5",
     "@sanity/telemetry": "^0.7.7",
     "@sanity/template-validator": "^2.4.0",
-    "@sanity/util": "3.74.1",
+    "@sanity/util": "3.74.2-canary.67+a9a66e73d5",
     "chalk": "^4.1.2",
     "debug": "^4.3.4",
     "decompress": "^4.2.0",
@@ -81,7 +81,7 @@
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@sanity/eslint-config-studio": "^4.0.0",
     "@sanity/generate-help-url": "^3.0.0",
-    "@sanity/types": "3.74.1",
+    "@sanity/types": "3.74.2-canary.67+a9a66e73d5",
     "@types/babel__traverse": "^7.20.5",
     "@types/configstore": "^5.0.1",
     "@types/cpx": "^1.5.2",
@@ -125,13 +125,13 @@
     "semver": "^7.3.5",
     "semver-compare": "^1.0.0",
     "tar": "^6.1.11",
-    "vite": "^6.0.11",
-    "vitest": "^2.1.9",
+    "vite": "^6.1.0",
+    "vitest": "^3.0.5",
     "which": "^2.0.2",
     "xdg-basedir": "^4.0.0"
   },
   "engines": {
     "node": ">=18"
   },
-  "gitHead": "51a67224fe7fd4f3efced0fcd833d47cb617f3c2"
+  "gitHead": "a9a66e73d50a681d71e210b8747c50fde8de637b"
 }

package/src/actions/init-project/bootstrapLocalTemplate.ts

@@ -10,8 +10,10 @@ import {copy} from '../../util/copy'
 import {getAndWriteJourneySchemaWorker} from '../../util/journeyConfig'
 import {resolveLatestVersions} from '../../util/resolveLatestVersions'
 import {createCliConfig} from './createCliConfig'
+import {createCoreAppCliConfig} from './createCoreAppCliConfig'
 import {createPackageManifest} from './createPackageManifest'
 import {createStudioConfig, type GenerateConfigOptions} from './createStudioConfig'
+import {determineCoreAppTemplate} from './determineCoreAppTemplate'
 import {type ProjectTemplate} from './initProject'
 import templates from './templates'
 import {updateInitialTemplateMetadata} from './updateInitialTemplateMetadata'
@@ -36,9 +38,9 @@ export async function bootstrapLocalTemplate(
   const {apiClient, cliRoot, output} = context
   const templatesDir = path.join(cliRoot, 'templates')
   const {outputPath, templateName, useTypeScript, packageName, variables} = opts
-  const {projectId} = variables
   const sourceDir = path.join(templatesDir, templateName)
   const sharedDir = path.join(templatesDir, 'shared')
+  const isCoreAppTemplate = determineCoreAppTemplate(templateName)
 
   // Check that we have a template info file (dependencies, plugins etc)
   const template = templates[templateName]
@@ -81,15 +83,16 @@ export async function bootstrapLocalTemplate(
   // Resolve latest versions of Sanity-dependencies
   spinner = output.spinner('Resolving latest module versions').start()
   const dependencyVersions = await resolveLatestVersions({
-    ...studioDependencies.dependencies,
-    ...studioDependencies.devDependencies,
+    ...(isCoreAppTemplate ? {} : studioDependencies.dependencies),
+    ...(isCoreAppTemplate ? {} : studioDependencies.devDependencies),
     ...(template.dependencies || {}),
+    ...(template.devDependencies || {}),
   })
   spinner.succeed()
 
   // Use the resolved version for the given dependency
   const dependencies = Object.keys({
-    ...studioDependencies.dependencies,
+    ...(isCoreAppTemplate ? {} : studioDependencies.dependencies),
     ...template.dependencies,
   }).reduce(
     (deps, dependency) => {
@@ -100,7 +103,7 @@ export async function bootstrapLocalTemplate(
   )
 
   const devDependencies = Object.keys({
-    ...studioDependencies.devDependencies,
+    ...(isCoreAppTemplate ? {} : studioDependencies.devDependencies),
     ...template.devDependencies,
   }).reduce(
     (deps, dependency) => {
@@ -116,32 +119,44 @@ export async function bootstrapLocalTemplate(
     name: packageName,
     dependencies,
     devDependencies,
+    scripts: template.scripts,
   })
 
   // ...and a studio config (`sanity.config.[ts|js]`)
-  const studioConfig = await createStudioConfig({
+  const studioConfig = createStudioConfig({
     template: template.configTemplate,
     variables,
   })
 
   // ...and a CLI config (`sanity.cli.[ts|js]`)
-  const cliConfig = await createCliConfig({
-    projectId: variables.projectId,
-    dataset: variables.dataset,
-    autoUpdates: variables.autoUpdates,
-  })
+  const cliConfig = isCoreAppTemplate
+    ? createCoreAppCliConfig({
+        appLocation: template.appLocation!,
+        organizationId: variables.organizationId,
+      })
+    : createCliConfig({
+        projectId: variables.projectId,
+        dataset: variables.dataset,
+        autoUpdates: variables.autoUpdates,
+      })
 
   // Write non-template files to disc
   const codeExt = useTypeScript ? 'ts' : 'js'
-  await Promise.all([
-    writeFileIfNotExists(`sanity.config.${codeExt}`, studioConfig),
-    writeFileIfNotExists(`sanity.cli.${codeExt}`, cliConfig),
-    writeFileIfNotExists('package.json', packageManifest),
-    writeFileIfNotExists(
-      'eslint.config.mjs',
-      `import studio from '@sanity/eslint-config-studio'\n\nexport default [...studio]\n`,
-    ),
-  ])
+  await Promise.all(
+    [
+      ...[
+        isCoreAppTemplate
+          ? Promise.resolve(null)
+          : writeFileIfNotExists(`sanity.config.${codeExt}`, studioConfig),
+      ],
+      writeFileIfNotExists(`sanity.cli.${codeExt}`, cliConfig),
+      writeFileIfNotExists('package.json', packageManifest),
+      writeFileIfNotExists(
+        'eslint.config.mjs',
+        `import studio from '@sanity/eslint-config-studio'\n\nexport default [...studio]\n`,
+      ),
+    ].filter(Boolean),
+  )
 
   debug('Updating initial template metadata')
   await updateInitialTemplateMetadata(apiClient, variables.projectId, `cli-${templateName}`)

package/src/actions/init-project/createCliConfig.ts

@@ -1,6 +1,4 @@
-import traverse from '@babel/traverse'
-import {parse, print} from 'recast'
-import * as parser from 'recast/parsers/typescript'
+import {processTemplate} from './processTemplate'
 
 const defaultTemplate = `
 import {defineCliConfig} from 'sanity/cli'
@@ -25,49 +23,9 @@ export interface GenerateCliConfigOptions {
 }
 
 export function createCliConfig(options: GenerateCliConfigOptions): string {
-  const variables = options
-  const template = defaultTemplate.trimStart()
-  const ast = parse(template, {parser})
-
-  traverse(ast, {
-    StringLiteral: {
-      enter({node}) {
-        const value = node.value
-        if (!value.startsWith('%') || !value.endsWith('%')) {
-          return
-        }
-        const variableName = value.slice(1, -1) as keyof GenerateCliConfigOptions
-        if (!(variableName in variables)) {
-          throw new Error(`Template variable '${value}' not defined`)
-        }
-        const newValue = variables[variableName]
-        /*
-         * although there are valid non-strings in our config,
-         * they're not in StringLiteral nodes, so assume undefined
-         */
-        node.value = typeof newValue === 'string' ? newValue : ''
-      },
-    },
-    Identifier: {
-      enter(path) {
-        if (!path.node.name.startsWith('__BOOL__')) {
-          return
-        }
-        const variableName = path.node.name.replace(
-          /^__BOOL__(.+?)__$/,
-          '$1',
-        ) as keyof GenerateCliConfigOptions
-        if (!(variableName in variables)) {
-          throw new Error(`Template variable '${variableName}' not defined`)
-        }
-        const value = variables[variableName]
-        if (typeof value !== 'boolean') {
-          throw new Error(`Expected boolean value for '${variableName}'`)
-        }
-        path.replaceWith({type: 'BooleanLiteral', value})
-      },
-    },
+  return processTemplate({
+    template: defaultTemplate,
+    variables: options,
+    includeBooleanTransform: true,
   })
-
-  return print(ast, {quote: 'single'}).code
 }

package/src/actions/init-project/createCoreAppCliConfig.ts

@@ -0,0 +1,26 @@
+import {processTemplate} from './processTemplate'
+
+const defaultCoreAppTemplate = `
+import {defineCliConfig} from 'sanity/cli'
+
+export default defineCliConfig({
+  api: {
+    organizationId: '%organizationId%'
+  },
+  __experimental_coreAppConfiguration: {
+    appLocation: '%appLocation%'
+  },
+})
+`
+
+export interface GenerateCliConfigOptions {
+  organizationId?: string
+  appLocation: string
+}
+
+export function createCoreAppCliConfig(options: GenerateCliConfigOptions): string {
+  return processTemplate({
+    template: defaultCoreAppTemplate,
+    variables: options,
+  })
+}

package/src/actions/init-project/createPackageManifest.ts

@@ -29,7 +29,7 @@ export function createPackageManifest(
 
     main: 'package.json',
     keywords: ['sanity'],
-    scripts: {
+    scripts: data.scripts || {
       'dev': 'sanity dev',
       'start': 'sanity start',
       'build': 'sanity build',

package/src/actions/init-project/createStudioConfig.ts

@@ -1,6 +1,4 @@
-import traverse from '@babel/traverse'
-import {parse, print} from 'recast'
-import * as parser from 'recast/parsers/typescript'
+import {processTemplate} from './processTemplate'
 
 const defaultTemplate = `
 import {defineConfig} from 'sanity'
@@ -38,6 +36,7 @@ export interface GenerateConfigOptions {
     projectName?: string
     sourceName?: string
     sourceTitle?: string
+    organizationId?: string
   }
 }
 
@@ -47,29 +46,8 @@ export function createStudioConfig(options: GenerateConfigOptions): string {
     return options.template(variables).trimStart()
   }
 
-  const template = (options.template || defaultTemplate).trimStart()
-  const ast = parse(template, {parser})
-  traverse(ast, {
-    StringLiteral: {
-      enter({node}) {
-        const value = node.value
-        if (!value.startsWith('%') || !value.endsWith('%')) {
-          return
-        }
-
-        const variableName = value.slice(1, -1) as keyof GenerateConfigOptions['variables']
-        if (!(variableName in variables)) {
-          throw new Error(`Template variable '${value}' not defined`)
-        }
-        const newValue = variables[variableName]
-        /*
-         * although there are valid non-strings in our config,
-         * they're not in this template, so assume undefined
-         */
-        node.value = typeof newValue === 'string' ? newValue : ''
-      },
-    },
+  return processTemplate({
+    template: options.template || defaultTemplate,
+    variables,
   })
-
-  return print(ast, {quote: 'single'}).code
 }

package/src/actions/init-project/determineCoreAppTemplate.ts

@@ -0,0 +1,13 @@
+const coreAppTemplates = ['core-app']
+
+/**
+ * Determine if a given template is a studio template.
+ * This function may need to be more robust once we
+ * introduce remote templates, for example.
+ *
+ * @param templateName - Name of the template
+ * @returns boolean indicating if the template is a studio template
+ */
+export function determineCoreAppTemplate(templateName: string): boolean {
+  return coreAppTemplates.includes(templateName)
+}

package/src/actions/init-project/initProject.ts

@@ -49,6 +49,7 @@ import {createProject} from '../project/createProject'
 import {bootstrapLocalTemplate} from './bootstrapLocalTemplate'
 import {bootstrapRemoteTemplate} from './bootstrapRemoteTemplate'
 import {type GenerateConfigOptions} from './createStudioConfig'
+import {determineCoreAppTemplate} from './determineCoreAppTemplate'
 import {absolutify, validateEmptyPath} from './fsUtils'
 import {tryGitInit} from './git'
 import {promptForDatasetName} from './promptForDatasetName'
@@ -97,6 +98,8 @@ export interface ProjectTemplate {
   importPrompt?: string
   configTemplate?: string | ((variables: GenerateConfigOptions['variables']) => string)
   typescriptOnly?: boolean
+  appLocation?: string
+  scripts?: Record<string, string>
 }
 
 export interface ProjectOrganization {
@@ -271,8 +274,12 @@ export default async function initSanity(
   print('')
 
   const flags = await prepareFlags()
-  // We're authenticated, now lets select or create a project
-  const {projectId, displayName, isFirstProject, datasetName, schemaUrl} = await getProjectDetails()
+  // skip project / dataset prompting
+  const isCoreAppTemplate = cliFlags.template ? determineCoreAppTemplate(cliFlags.template) : false // Default to false
+
+  // We're authenticated, now lets select or create a project (for studios) or org (for core apps)
+  const {projectId, displayName, isFirstProject, datasetName, schemaUrl, organizationId} =
+    await getProjectDetails()
 
   const sluggedName = deburr(displayName.toLowerCase())
     .replace(/\s+/g, '-')
@@ -655,11 +662,15 @@ export default async function initSanity(
   const isCurrentDir = outputPath === process.cwd()
   if (isCurrentDir) {
     print(`\n${chalk.green('Success!')} Now, use this command to continue:\n`)
-    print(`${chalk.cyan(devCommand)} - to run Sanity Studio\n`)
+    print(
+      `${chalk.cyan(devCommand)} - to run ${isCoreAppTemplate ? 'your Sanity application' : 'Sanity Studio'}\n`,
+    )
   } else {
     print(`\n${chalk.green('Success!')} Now, use these commands to continue:\n`)
     print(`First: ${chalk.cyan(`cd ${outputPath}`)} - to enter project’s directory`)
-    print(`Then: ${chalk.cyan(devCommand)} - to run Sanity Studio\n`)
+    print(
+      `Then: ${chalk.cyan(devCommand)} -to run ${isCoreAppTemplate ? 'your Sanity application' : 'Sanity Studio'}\n`,
+    )
   }
 
   print(`Other helpful commands`)
@@ -705,6 +716,7 @@ export default async function initSanity(
     displayName: string
     isFirstProject: boolean
     schemaUrl?: string
+    organizationId?: string
   }> {
     // If we're doing a quickstart, we don't need to prompt for project details
     if (flags.quickstart) {
@@ -720,6 +732,21 @@ export default async function initSanity(
       return data
     }
 
+    if (isCoreAppTemplate) {
+      const client = apiClient({requireUser: true, requireProject: false})
+      const organizations = await client.request({uri: '/organizations'})
+
+      const coreAppOrganizationId = await getOrganizationId(organizations)
+
+      return {
+        projectId: '',
+        displayName: '',
+        datasetName: '',
+        isFirstProject: false,
+        organizationId: coreAppOrganizationId,
+      }
+    }
+
     debug('Prompting user to select or create a project')
     const project = await getOrCreateProject()
     debug(`Project with name ${project.displayName} selected`)
@@ -1072,6 +1099,7 @@ export default async function initSanity(
       dataset: datasetName,
       projectId,
       projectName: displayName || answers.projectName,
+      organizationId,
     }
 
     if (remoteTemplateInfo) {
@@ -1211,12 +1239,12 @@ export default async function initSanity(
   }
 
   async function getOrganizationId(organizations: ProjectOrganization[]) {
-    let organizationId = flags.organization
+    let orgId = flags.organization
     if (unattended) {
-      return organizationId || undefined
+      return orgId || undefined
     }
 
-    const shouldPrompt = organizations.length > 0 && !organizationId
+    const shouldPrompt = organizations.length > 0 && !orgId
     if (shouldPrompt) {
       debug(`User has ${organizations.length} organization(s), checking attach access`)
       const withGrant = await getOrganizationsWithAttachGrant(organizations)
@@ -1242,18 +1270,18 @@ export default async function initSanity(
       })
 
       if (chosenOrg && chosenOrg !== 'none') {
-        organizationId = chosenOrg
+        orgId = chosenOrg
       }
-    } else if (organizationId) {
-      debug(`User has defined organization flag explicitly (%s)`, organizationId)
+    } else if (orgId) {
+      debug(`User has defined organization flag explicitly (%s)`, orgId)
     } else if (organizations.length === 0) {
       debug('User has no organizations, skipping selection prompt')
     }
 
-    return organizationId || undefined
+    return orgId || undefined
   }
 
-  async function hasProjectAttachGrant(organizationId: string) {
+  async function hasProjectAttachGrant(orgId: string) {
     const requiredGrantGroup = 'sanity.organization.projects'
     const requiredGrant = 'attach'
 
@@ -1261,7 +1289,7 @@ export default async function initSanity(
       .clone()
       .config({apiVersion: 'v2021-06-07'})
 
-    const grants = await client.request({uri: `organizations/${organizationId}/grants`})
+    const grants = await client.request({uri: `organizations/${orgId}/grants`})
     const group: {grants: {name: string}[]}[] = grants[requiredGrantGroup] || []
     return group.some(
       (resource) =>

package/src/actions/init-project/processTemplate.ts

@@ -0,0 +1,55 @@
+import traverse from '@babel/traverse'
+import {parse, print} from 'recast'
+import * as parser from 'recast/parsers/typescript'
+
+interface TemplateOptions<T> {
+  template: string
+  variables: T
+  includeBooleanTransform?: boolean
+}
+
+export function processTemplate<T extends object>(options: TemplateOptions<T>): string {
+  const {template, variables, includeBooleanTransform = false} = options
+  const ast = parse(template.trimStart(), {parser})
+
+  traverse(ast, {
+    StringLiteral: {
+      enter({node}) {
+        const value = node.value
+        if (!value.startsWith('%') || !value.endsWith('%')) {
+          return
+        }
+        const variableName = value.slice(1, -1) as keyof T
+        if (!(variableName in variables)) {
+          throw new Error(`Template variable '${value}' not defined`)
+        }
+        const newValue = variables[variableName]
+        /*
+         * although there are valid non-strings in our config,
+         * they're not in StringLiteral nodes, so assume undefined
+         */
+        node.value = typeof newValue === 'string' ? newValue : ''
+      },
+    },
+    ...(includeBooleanTransform && {
+      Identifier: {
+        enter(path) {
+          if (!path.node.name.startsWith('__BOOL__')) {
+            return
+          }
+          const variableName = path.node.name.replace(/^__BOOL__(.+?)__$/, '$1') as keyof T
+          if (!(variableName in variables)) {
+            throw new Error(`Template variable '${variableName.toString()}' not defined`)
+          }
+          const value = variables[variableName]
+          if (typeof value !== 'boolean') {
+            throw new Error(`Expected boolean value for '${variableName.toString()}'`)
+          }
+          path.replaceWith({type: 'BooleanLiteral', value})
+        },
+      },
+    }),
+  })
+
+  return print(ast, {quote: 'single'}).code
+}

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

@@ -0,0 +1,31 @@
+import {type ProjectTemplate} from '../initProject'
+
+const coreAppTemplate: ProjectTemplate = {
+  dependencies: {
+    '@sanity/sdk': '^0.0.0-alpha',
+    '@sanity/sdk-react': '^0.0.0-alpha',
+    'react': '^19',
+    'react-dom': '^19',
+  },
+  devDependencies: {
+    /*
+     * this will be changed to eslint-config sanity,
+     *  eslint.config generation will be a fast follow
+     */
+    '@sanity/eslint-config-studio': '^5.0.1',
+    '@types/react': '^18.0.25',
+    'eslint': '^9.9.0',
+    'prettier': '^3.0.2',
+    'sanity': '^3',
+    'typescript': '^5.1.6',
+  },
+  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',
+  },
+}
+
+export default coreAppTemplate

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

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

package/src/types.ts

@@ -24,6 +24,7 @@ export interface SanityModuleInternal {
 export interface PackageJson {
   name: string
   version: string
+  scripts?: Record<string, string>
 
   description?: string
   author?: string
@@ -181,6 +182,7 @@ export type CliStubbedYarn = (args: string[], options?: CliYarnOptions) => Promi
 
 export interface CliApiConfig {
   projectId?: string
+  organizationId?: string
   dataset?: string
 }
 
@@ -344,6 +346,15 @@ export interface CliConfig {
   autoUpdates?: boolean
 
   studioHost?: string
+
+  /**
+   * Parameter used to configure other kinds of applications.
+   * Signals to `sanity` commands that this is not a studio.
+   * @internal
+   */
+  __experimental_coreAppConfiguration?: {
+    appLocation?: string
+  }
 }
 
 export type UserViteConfig =

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

@@ -0,0 +1,26 @@
+import {createSanityInstance} from '@sanity/sdk'
+import {SanityProvider} from '@sanity/sdk-react/context'
+
+export function App() {
+
+  const sanityConfig = {
+    auth: {
+      authScope: 'global'
+    }
+    /* 
+     * 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',
+  }
+
+  const sanityInstance = createSanityInstance(sanityConfig)
+  return (
+    <SanityProvider sanityInstance={sanityInstance}>
+      Hello world!
+    </SanityProvider>
+  )
+}
+
+export default App