Feat/studio manifests

.github/CODEOWNERS

@@ -99,3 +99,7 @@ packages/sanity/src/core/studio/upsell/ @sanity-io/studio-ex
 /packages/sanity/src/structure/panes/documentList/PaneContainer.tsx @sanity-io/ecosystem @sanity-io/studio-dx
 /packages/sanity/src/structure/StructureToolProvider.tsx @sanity-io/ecosystem @sanity-io/studio-dx
 /packages/sanity/src/structure/types.ts @sanity-io/ecosystem @sanity-io/studio-dx
+
+# -- Manifest --
+/packages/@sanity/manifest @sanity-io/studio-dx
+

dev/aliases.cjs

@@ -22,6 +22,7 @@ const devAliases = {
   '@sanity/mutator': './packages/@sanity/mutator/src',
   '@sanity/portable-text-editor': './packages/@sanity/portable-text-editor/src',
   '@sanity/schema': './packages/@sanity/schema/src/_exports',
+  '@sanity/manifest': './packages/@sanity/manifrst/src/_exports',
   '@sanity/migrate': './packages/@sanity/migrate/src/_exports',
   '@sanity/types': './packages/@sanity/types/src',
   '@sanity/util': './packages/@sanity/util/src/_exports',

dev/embedded-studio/package.json

@@ -3,7 +3,7 @@
   "version": "3.43.0",
   "private": true,
   "scripts": {
-    "build": "tsc && vite build",
+    "build": "tsc && vite build && sanity manifest extract",
     "dev": "vite",
     "preview": "vite preview"
   },

dev/embedded-studio/sanity.cli.ts

@@ -0,0 +1,9 @@
+import {defineCliConfig} from 'sanity/cli'
+
+export default defineCliConfig({
+  api: {
+    projectId: 'ppsg7ml5',
+    dataset: 'test',
+  },
+  unstable_staticAssetsPath: './dist/assets',
+})

dev/embedded-studio/sanity.config.ts

@@ -0,0 +1,34 @@
+import {defineConfig, defineType} from 'sanity'
+import {structureTool} from 'sanity/structure'
+
+const BLOG_POST_SCHEMA = defineType({
+  type: 'document',
+  name: 'blogPost',
+  title: 'Blog post',
+  fields: [
+    {
+      type: 'string',
+      name: 'title',
+      title: 'Title',
+    },
+  ],
+})
+
+export const SCHEMA_TYPES = [BLOG_POST_SCHEMA]
+
+export default defineConfig({
+  projectId: 'ppsg7ml5',
+  dataset: 'test',
+
+  document: {
+    unstable_comments: {
+      enabled: true,
+    },
+  },
+
+  schema: {
+    types: SCHEMA_TYPES,
+  },
+
+  plugins: [structureTool()],
+})

dev/embedded-studio/src/App.tsx

@@ -1,46 +1,8 @@
 import {Button, Card, Flex, studioTheme, ThemeProvider, usePrefersDark} from '@sanity/ui'
 import {useCallback, useMemo, useState} from 'react'
-import {
-  defineConfig,
-  defineType,
-  Studio,
-  StudioLayout,
-  StudioProvider,
-  type StudioThemeColorSchemeKey,
-} from 'sanity'
-import {structureTool} from 'sanity/structure'
+import {Studio, StudioLayout, StudioProvider, type StudioThemeColorSchemeKey} from 'sanity'
 
-const BLOG_POST_SCHEMA = defineType({
-  type: 'document',
-  name: 'blogPost',
-  title: 'Blog post',
-  fields: [
-    {
-      type: 'string',
-      name: 'title',
-      title: 'Title',
-    },
-  ],
-})
-
-const SCHEMA_TYPES = [BLOG_POST_SCHEMA]
-
-const config = defineConfig({
-  projectId: 'ppsg7ml5',
-  dataset: 'test',
-
-  document: {
-    unstable_comments: {
-      enabled: true,
-    },
-  },
-
-  schema: {
-    types: SCHEMA_TYPES,
-  },
-
-  plugins: [structureTool()],
-})
+import config from '../sanity.config'
 
 export function App() {
   const prefersDark = usePrefersDark()

dev/starter-next-studio/components/Studio.tsx

@@ -1,41 +1,13 @@
-import {useMemo} from 'react'
-import {defineConfig, Studio} from 'sanity'
-import {structureTool} from 'sanity/structure'
+import {Studio} from 'sanity'
+
+import config from '../sanity.config'
 
 const wrapperStyles = {height: '100vh', width: '100vw'}
 
 export default function StudioRoot({basePath}: {basePath: string}) {
-  const config = useMemo(
-    () =>
-      defineConfig({
-        basePath,
-        plugins: [structureTool()],
-        title: 'Next.js Starter',
-        projectId: 'ppsg7ml5',
-        dataset: 'test',
-        schema: {
-          types: [
-            {
-              type: 'document',
-              name: 'post',
-              title: 'Post',
-              fields: [
-                {
-                  type: 'string',
-                  name: 'title',
-                  title: 'Title',
-                },
-              ],
-            },
-          ],
-        },
-      }),
-    [basePath],
-  )
-
   return (
     <div style={wrapperStyles}>
-      <Studio config={config} />
+      <Studio config={{...config, basePath}} />
     </div>
   )
 }

dev/starter-next-studio/package.json

@@ -5,7 +5,7 @@
   "license": "MIT",
   "author": "Sanity.io <[email protected]>",
   "scripts": {
-    "build": "next build",
+    "build": "sanity manifest extract && next build",
     "dev": "next dev",
     "start": "next start"
   },

dev/starter-next-studio/sanity.cli.ts

@@ -0,0 +1,8 @@
+import {defineCliConfig} from 'sanity/cli'
+
+export default defineCliConfig({
+  api: {
+    projectId: 'ppsg7ml5',
+    dataset: 'test',
+  },
+})

dev/starter-next-studio/sanity.config.ts

@@ -0,0 +1,25 @@
+import {defineConfig} from 'sanity'
+import {structureTool} from 'sanity/structure'
+
+export default defineConfig({
+  plugins: [structureTool()],
+  title: 'Next.js Starter',
+  projectId: 'ppsg7ml5',
+  dataset: 'test',
+  schema: {
+    types: [
+      {
+        type: 'document',
+        name: 'post',
+        title: 'Post',
+        fields: [
+          {
+            type: 'string',
+            name: 'title',
+            title: 'Title',
+          },
+        ],
+      },
+    ],
+  },
+})

dev/test-studio/sanity.cli.ts

@@ -9,6 +9,8 @@ export default defineCliConfig({
     dataset: 'test',
   },
 
+  unstable_extractManifestOnBuild: true,
+
   // Can be overriden by:
   // A) `SANITY_STUDIO_REACT_STRICT_MODE=false pnpm dev`
   // B) creating a `.env` file locally that sets the same env variable as above

dev/test-studio/sanity.config.ts

@@ -14,7 +14,6 @@ import {defineConfig, definePlugin, type WorkspaceOptions} from 'sanity'
 import {presentationTool} from 'sanity/presentation'
 import {structureTool} from 'sanity/structure'
 import {imageHotspotArrayPlugin} from 'sanity-plugin-hotspot-array'
-import {muxInput} from 'sanity-plugin-mux-input'
 
 import {imageAssetSource} from './assetSources'
 import {
@@ -130,8 +129,6 @@ const sharedSettings = definePlugin({
     visionTool({
       defaultApiVersion: '2022-08-08',
     }),
-    // eslint-disable-next-line camelcase
-    muxInput({mp4_support: 'standard'}),
     imageHotspotArrayPlugin(),
     presenceTool(),
     routerDebugTool(),

dev/test-studio/schema/index.ts

@@ -76,7 +76,6 @@ import {virtualizationInObject} from './debug/virtualizationInObject'
 import {demos3d} from './demos/3d'
 import {v3docs} from './docs/v3'
 import markdown from './externalPlugins/markdown'
-import mux from './externalPlugins/mux'
 import playlist from './playlist'
 import playlistTrack from './playlistTrack'
 import code from './plugins/code'
@@ -261,7 +260,6 @@ export const schemaTypes = [
 
   // Test documents with 3rd party plugin inputs
   markdown,
-  mux,
 
   // Other documents
   author,

dev/tsconfig.dev.json

@@ -10,6 +10,8 @@
       "@sanity/cli": ["./packages/@sanity/cli/src/index.ts"],
       "@sanity/codegen": ["./packages/@sanity/codegen/src/_exports/index.ts"],
       "@sanity/mutator": ["./packages/@sanity/mutator/src/index.ts"],
+      "@sanity/manifest/*": ["./packages/@sanity/manifest/src/_exports/*"],
+      "@sanity/manifest": ["./packages/@sanity/manifest/src/_exports/index.ts"],
       "@sanity/portable-text-editor": ["./packages/@sanity/portable-text-editor/src/index.ts"],
       "@sanity/schema/*": ["./packages/@sanity/schema/src/_exports/*"],
       "@sanity/schema": ["./packages/@sanity/schema/src/_exports/index.ts"],

examples/tsconfig.json

@@ -10,6 +10,8 @@
       "@sanity/cli": ["./packages/@sanity/cli/src/index.ts"],
       "@sanity/codegen": ["./packages/@sanity/codegen/src/_exports/index.ts"],
       "@sanity/mutator": ["./packages/@sanity/mutator/src/index.ts"],
+      "@sanity/manifest/*": ["./packages/@sanity/manifest/src/_exports/*"],
+      "@sanity/manifest": ["./packages/@sanity/manifest/src/_exports/index.ts"],
       "@sanity/portable-text-editor": ["./packages/@sanity/portable-text-editor/src/index.ts"],
       "@sanity/schema/*": ["./packages/@sanity/schema/src/_exports/*"],
       "@sanity/schema": ["./packages/@sanity/schema/src/_exports/index.ts"],

packages/@repo/test-exports/.depcheckrc.json

@@ -5,6 +5,7 @@
     "@sanity/cli",
     "@sanity/codegen",
     "@sanity/diff",
+    "@sanity/manifest",
     "@sanity/migrate",
     "@sanity/mutator",
     "@sanity/portable-text-editor",

packages/@repo/test-exports/package.json

@@ -14,6 +14,7 @@
     "@sanity/cli": "workspace:*",
     "@sanity/codegen": "workspace:*",
     "@sanity/diff": "workspace:*",
+    "@sanity/manifest": "workspace:*",
     "@sanity/migrate": "workspace:*",
     "@sanity/mutator": "workspace:*",
     "@sanity/portable-text-editor": "workspace:*",

packages/@sanity/cli/src/types.ts

@@ -310,6 +310,26 @@ export interface CliConfig {
   graphql?: GraphQLAPIConfig[]
 
   vite?: UserViteConfig
+
+  /**
+   * Whether or not to extract a Studio Manifest to the static assets directory when building
+   * (or deploying) the project.
+   *
+   * Optional, defaults to `false`.
+   */
+  unstable_extractManifestOnBuild?: boolean
+
+  /**
+   * The path Sanity CLI will write static assets (such as the Studio Manifest) to when used inside
+   * an embedded Studio project. Relative to the CLI config file.
+   *
+   * Sanity CLI will attempt to create this path if it does not exist.
+   *
+   * You should not define a value if your Studio is not embedded.
+   *
+   * Optional, defaults to `dist/static`.
+   */
+  unstable_staticAssetsPath?: string
 }
 
 export type UserViteConfig =

packages/@sanity/cli/src/util/noSuchCommandText.ts

@@ -17,6 +17,7 @@ const coreCommands = [
   'exec',
   'graphql',
   'hook',
+  'manifest',
   'migration',
   'preview',
   'schema',

packages/@sanity/manifest/.depcheckrc.json

@@ -0,0 +1,3 @@
+{
+  "ignores": ["@repo/tsconfig", "@sanity/pkg-utils"]
+}

packages/@sanity/manifest/.eslintrc.cjs

@@ -0,0 +1,11 @@
+'use strict'
+
+const path = require('path')
+
+const ROOT_PATH = path.resolve(__dirname, '../../..')
+
+module.exports = {
+  rules: {
+    'import/no-extraneous-dependencies': ['error', {packageDir: [ROOT_PATH, __dirname]}],
+  },
+}

packages/@sanity/manifest/.gitignore

@@ -0,0 +1,15 @@
+# Logs
+/logs
+*.log
+
+# Coverage directory used by tools like istanbul
+/coverage
+
+# Dependency directories
+/node_modules
+
+# Compiled code
+/lib
+
+# Legacy exports
+/_internal.js

packages/@sanity/manifest/README.md

@@ -0,0 +1 @@
+# Sanity Manifest

packages/@sanity/manifest/jest.config.cjs

@@ -0,0 +1,8 @@
+'use strict'
+
+const {createJestConfig} = require('../../../test/config.cjs')
+
+module.exports = createJestConfig({
+  displayName: require('./package.json').name,
+  testEnvironment: 'node',
+})

packages/@sanity/manifest/package.config.ts

@@ -0,0 +1,4 @@
+import baseConfig from '@repo/package.config'
+import {defineConfig} from '@sanity/pkg-utils'
+
+export default defineConfig(baseConfig)