@sanity/cli-test 0.0.2-alpha.5 → 0.0.2-alpha.7

package/dist/utils/fileExists.js

@@ -0,0 +1,13 @@
+import { access } from 'node:fs/promises';
+/**
+ * Checks if a file exists and can be "accessed".
+ * Prone to race conditions, but good enough for our use cases.
+ *
+ * @param filePath - The path to the file to check
+ * @returns A promise that resolves to true if the file exists, false otherwise
+ * @internal
+ */ export function fileExists(filePath) {
+    return access(filePath).then(()=>true, ()=>false);
+}
+
+//# sourceMappingURL=fileExists.js.map

package/dist/utils/fileExists.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/utils/fileExists.ts"],"sourcesContent":["import {access} from 'node:fs/promises'\n\n/**\n * Checks if a file exists and can be \"accessed\".\n * Prone to race conditions, but good enough for our use cases.\n *\n * @param filePath - The path to the file to check\n * @returns A promise that resolves to true if the file exists, false otherwise\n * @internal\n */\nexport function fileExists(filePath: string): Promise<boolean> {\n  return access(filePath).then(\n    () => true,\n    () => false,\n  )\n}\n"],"names":["access","fileExists","filePath","then"],"mappings":"AAAA,SAAQA,MAAM,QAAO,mBAAkB;AAEvC;;;;;;;CAOC,GACD,OAAO,SAASC,WAAWC,QAAgB;IACzC,OAAOF,OAAOE,UAAUC,IAAI,CAC1B,IAAM,MACN,IAAM;AAEV"}

package/dist/utils/paths.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Gets the path to the examples directory bundled with this package.
+ *
+ * The examples are copied during build and bundled with the published package.
+ * This function works the same whether the package is used in a monorepo
+ * or installed from npm.
+ *
+ * @returns Absolute path to the examples directory
+ * @internal
+ */
+export declare function getExamplesPath(): string;
+/**
+ * Gets the path to the temporary directory for test examples.
+ *
+ * Uses the initial working directory captured when this module was first loaded,
+ * not process.cwd() which may change during test execution.
+ *
+ * @param customTempDir - Optional custom temp directory path
+ * @returns Absolute path to temp directory (default: initial cwd/tmp)
+ * @internal
+ */
+export declare function getTempPath(customTempDir?: string): string;

package/dist/utils/paths.js

@@ -0,0 +1,30 @@
+import { resolve } from 'node:path';
+// Capture the initial working directory before any tests change it
+const INITIAL_CWD = process.cwd();
+/**
+ * Gets the path to the examples directory bundled with this package.
+ *
+ * The examples are copied during build and bundled with the published package.
+ * This function works the same whether the package is used in a monorepo
+ * or installed from npm.
+ *
+ * @returns Absolute path to the examples directory
+ * @internal
+ */ export function getExamplesPath() {
+    // From dist/utils/paths.js -> ../../examples
+    return resolve(import.meta.dirname, '../../examples');
+}
+/**
+ * Gets the path to the temporary directory for test examples.
+ *
+ * Uses the initial working directory captured when this module was first loaded,
+ * not process.cwd() which may change during test execution.
+ *
+ * @param customTempDir - Optional custom temp directory path
+ * @returns Absolute path to temp directory (default: initial cwd/tmp)
+ * @internal
+ */ export function getTempPath(customTempDir) {
+    return customTempDir || resolve(INITIAL_CWD, 'tmp');
+}
+
+//# sourceMappingURL=paths.js.map

package/dist/utils/paths.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/utils/paths.ts"],"sourcesContent":["import {resolve} from 'node:path'\n\n// Capture the initial working directory before any tests change it\nconst INITIAL_CWD = process.cwd()\n\n/**\n * Gets the path to the examples directory bundled with this package.\n *\n * The examples are copied during build and bundled with the published package.\n * This function works the same whether the package is used in a monorepo\n * or installed from npm.\n *\n * @returns Absolute path to the examples directory\n * @internal\n */\nexport function getExamplesPath(): string {\n  // From dist/utils/paths.js -> ../../examples\n  return resolve(import.meta.dirname, '../../examples')\n}\n\n/**\n * Gets the path to the temporary directory for test examples.\n *\n * Uses the initial working directory captured when this module was first loaded,\n * not process.cwd() which may change during test execution.\n *\n * @param customTempDir - Optional custom temp directory path\n * @returns Absolute path to temp directory (default: initial cwd/tmp)\n * @internal\n */\nexport function getTempPath(customTempDir?: string): string {\n  return customTempDir || resolve(INITIAL_CWD, 'tmp')\n}\n"],"names":["resolve","INITIAL_CWD","process","cwd","getExamplesPath","dirname","getTempPath","customTempDir"],"mappings":"AAAA,SAAQA,OAAO,QAAO,YAAW;AAEjC,mEAAmE;AACnE,MAAMC,cAAcC,QAAQC,GAAG;AAE/B;;;;;;;;;CASC,GACD,OAAO,SAASC;IACd,6CAA6C;IAC7C,OAAOJ,QAAQ,YAAYK,OAAO,EAAE;AACtC;AAEA;;;;;;;;;CASC,GACD,OAAO,SAASC,YAAYC,aAAsB;IAChD,OAAOA,iBAAiBP,QAAQC,aAAa;AAC/C"}

package/dist/vitest.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Vitest global setup entry point.
+ *
+ * Import this in your vitest.config.ts globalSetup array for automatic
+ * test example setup and teardown.
+ *
+ * @example
+ * ```typescript
+ * // vitest.config.ts
+ * import {defineConfig} from 'vitest/config'
+ *
+ * export default defineConfig({
+ *   test: {
+ *     globalSetup: ['@sanity/cli-test/vitest']
+ *   }
+ * })
+ * ```
+ */
+export { setup, teardown } from './test/setupExamples.js';
+export { setupWorkerBuild, teardownWorkerBuild } from './vitestWorker.js';

package/dist/vitest.js

@@ -0,0 +1,21 @@
+/**
+ * Vitest global setup entry point.
+ *
+ * Import this in your vitest.config.ts globalSetup array for automatic
+ * test example setup and teardown.
+ *
+ * @example
+ * ```typescript
+ * // vitest.config.ts
+ * import {defineConfig} from 'vitest/config'
+ *
+ * export default defineConfig({
+ *   test: {
+ *     globalSetup: ['@sanity/cli-test/vitest']
+ *   }
+ * })
+ * ```
+ */ export { setup, teardown } from './test/setupExamples.js';
+export { setupWorkerBuild, teardownWorkerBuild } from './vitestWorker.js';
+
+//# sourceMappingURL=vitest.js.map

package/dist/vitest.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/vitest.ts"],"sourcesContent":["/**\n * Vitest global setup entry point.\n *\n * Import this in your vitest.config.ts globalSetup array for automatic\n * test example setup and teardown.\n *\n * @example\n * ```typescript\n * // vitest.config.ts\n * import {defineConfig} from 'vitest/config'\n *\n * export default defineConfig({\n *   test: {\n *     globalSetup: ['@sanity/cli-test/vitest']\n *   }\n * })\n * ```\n */\nexport {setup, teardown} from './test/setupExamples.js'\nexport {setupWorkerBuild, teardownWorkerBuild} from './vitestWorker.js'\n"],"names":["setup","teardown","setupWorkerBuild","teardownWorkerBuild"],"mappings":"AAAA;;;;;;;;;;;;;;;;;CAiBC,GACD,SAAQA,KAAK,EAAEC,QAAQ,QAAO,0BAAyB;AACvD,SAAQC,gBAAgB,EAAEC,mBAAmB,QAAO,oBAAmB"}

package/dist/vitestWorker.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Setup function to build the worker files with esbuild.
+ *
+ * Bundles the worker files with esbuild and sets up watch mode if in watch mode.
+ * All npm packages are automatically marked as external (loaded from node_modules at runtime).
+ * Only internal project code is bundled inline.
+ *
+ * @param filePaths - The paths to the worker files to build
+ * @returns A promise that resolves when the worker build is setup
+ * @throws If the worker files cannot be bundled
+ * @throws If the watcher cannot be set up
+ */
+export declare function setupWorkerBuild(filePaths: string[]): Promise<void>;
+/**
+ * Teardown function to clean up the worker build.
+ *
+ * Closes all build contexts and deletes the compiled JavaScript files.
+ *
+ * @returns A promise that resolves when the worker build is teared down
+ * @throws If the build contexts cannot be disposed
+ * @throws If the compiled JavaScript files cannot be deleted
+ */
+export declare function teardownWorkerBuild(): Promise<void>;

package/dist/vitestWorker.js

@@ -0,0 +1,131 @@
+/**
+ * Vitest worker setup for the Sanity CLI.
+ *
+ * This builds the worker TS files into JS files using esbuild bundling.
+ * All internal dependencies are bundled inline, while npm packages remain external.
+ */ import { unlink } from 'node:fs/promises';
+import { build, context } from 'esbuild';
+const compiledFiles = new Set();
+let buildContexts = [];
+/**
+ * Generate esbuild configuration for bundling worker files.
+ *
+ * @param filePath - The worker file path to bundle
+ * @param outputFile - The output file path for the bundled worker
+ * @returns esbuild configuration object
+ */ function esbuildOptions(filePath, outputFile) {
+    return {
+        bundle: true,
+        conditions: [
+            'node',
+            'import'
+        ],
+        entryPoints: [
+            filePath
+        ],
+        // Marks cli-core as external to avoid bundling it inline
+        // this is mostly necessary for the monorepo.
+        external: [
+            '@sanity/cli-core'
+        ],
+        format: 'esm',
+        loader: {
+            '.json': 'json'
+        },
+        logLevel: 'warning',
+        mainFields: [
+            'module',
+            'main'
+        ],
+        outfile: outputFile,
+        packages: 'external',
+        platform: 'node',
+        sourcemap: false,
+        target: 'node20'
+    };
+}
+/**
+ * Bundle a single worker file with esbuild.
+ *
+ * @param filePath - The worker file path to bundle
+ * @param external - Array of package names to keep external
+ * @returns The output file path
+ */ async function bundleWorkerFile(filePath) {
+    const outputFile = filePath.replace(/\.ts$/, '.js');
+    await build(esbuildOptions(filePath, outputFile));
+    compiledFiles.add(outputFile);
+    return outputFile;
+}
+/**
+ * Bundle all worker files with esbuild (non-watch mode).
+ *
+ * @param filePaths - Array of worker file paths to bundle
+ */ async function setupBundling(filePaths) {
+    console.log(`Found ${filePaths.length} worker files to bundle`);
+    for (const workerFile of filePaths){
+        try {
+            await bundleWorkerFile(workerFile);
+            console.log(`✓ Bundled ${workerFile}`);
+        } catch (error) {
+            console.error(`✗ Failed to bundle ${workerFile}:`, error);
+            throw error;
+        }
+    }
+}
+/**
+ * Set up watch mode for worker files using esbuild's native watch API.
+ *
+ * @param files - Array of worker file paths to watch
+ */ async function setupWatchMode(files) {
+    for (const filePath of files){
+        const outputFile = filePath.replace(/\.ts$/, '.js');
+        const ctx = await context(esbuildOptions(filePath, outputFile));
+        await ctx.watch();
+        buildContexts.push(ctx);
+        compiledFiles.add(outputFile);
+        console.log(`👀 Watching ${filePath}`);
+    }
+}
+/**
+ * Setup function to build the worker files with esbuild.
+ *
+ * Bundles the worker files with esbuild and sets up watch mode if in watch mode.
+ * All npm packages are automatically marked as external (loaded from node_modules at runtime).
+ * Only internal project code is bundled inline.
+ *
+ * @param filePaths - The paths to the worker files to build
+ * @returns A promise that resolves when the worker build is setup
+ * @throws If the worker files cannot be bundled
+ * @throws If the watcher cannot be set up
+ */ export async function setupWorkerBuild(filePaths) {
+    const isWatchMode = (process.env.VITEST_WATCH === 'true' || !process.argv.includes('run')) && process.env.CI !== 'true';
+    await (isWatchMode ? setupWatchMode(filePaths) : setupBundling(filePaths));
+}
+/**
+ * Teardown function to clean up the worker build.
+ *
+ * Closes all build contexts and deletes the compiled JavaScript files.
+ *
+ * @returns A promise that resolves when the worker build is teared down
+ * @throws If the build contexts cannot be disposed
+ * @throws If the compiled JavaScript files cannot be deleted
+ */ export async function teardownWorkerBuild() {
+    // Dispose all build contexts (for watch mode)
+    for (const ctx of buildContexts){
+        await ctx.dispose();
+    }
+    buildContexts = [];
+    // Clean up compiled JavaScript files
+    console.log('Cleaning up compiled JavaScript files...');
+    for (const filePath of compiledFiles){
+        try {
+            await unlink(filePath);
+            console.log(`✓ Deleted ${filePath}`);
+        } catch (error) {
+            console.error(`Failed to delete ${filePath}:`, error);
+        }
+    }
+    compiledFiles.clear();
+}
+
+//# sourceMappingURL=vitestWorker.js.map

package/dist/vitestWorker.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/vitestWorker.ts"],"sourcesContent":["/**\n * Vitest worker setup for the Sanity CLI.\n *\n * This builds the worker TS files into JS files using esbuild bundling.\n * All internal dependencies are bundled inline, while npm packages remain external.\n */\nimport {unlink} from 'node:fs/promises'\n\nimport {build, type BuildContext, type BuildOptions, context} from 'esbuild'\n\nconst compiledFiles: Set<string> = new Set()\nlet buildContexts: BuildContext[] = []\n\n/**\n * Generate esbuild configuration for bundling worker files.\n *\n * @param filePath - The worker file path to bundle\n * @param outputFile - The output file path for the bundled worker\n * @returns esbuild configuration object\n */\nfunction esbuildOptions(filePath: string, outputFile: string): BuildOptions {\n  return {\n    bundle: true,\n    conditions: ['node', 'import'],\n    entryPoints: [filePath],\n    // Marks cli-core as external to avoid bundling it inline\n    // this is mostly necessary for the monorepo.\n    external: ['@sanity/cli-core'],\n    format: 'esm',\n    loader: {'.json': 'json'},\n    logLevel: 'warning',\n    mainFields: ['module', 'main'],\n    outfile: outputFile,\n    packages: 'external',\n    platform: 'node',\n    sourcemap: false,\n    target: 'node20',\n  }\n}\n\n/**\n * Bundle a single worker file with esbuild.\n *\n * @param filePath - The worker file path to bundle\n * @param external - Array of package names to keep external\n * @returns The output file path\n */\nasync function bundleWorkerFile(filePath: string): Promise<string> {\n  const outputFile = filePath.replace(/\\.ts$/, '.js')\n\n  await build(esbuildOptions(filePath, outputFile))\n\n  compiledFiles.add(outputFile)\n  return outputFile\n}\n\n/**\n * Bundle all worker files with esbuild (non-watch mode).\n *\n * @param filePaths - Array of worker file paths to bundle\n */\nasync function setupBundling(filePaths: string[]) {\n  console.log(`Found ${filePaths.length} worker files to bundle`)\n\n  for (const workerFile of filePaths) {\n    try {\n      await bundleWorkerFile(workerFile)\n      console.log(`✓ Bundled ${workerFile}`)\n    } catch (error) {\n      console.error(`✗ Failed to bundle ${workerFile}:`, error)\n      throw error\n    }\n  }\n}\n\n/**\n * Set up watch mode for worker files using esbuild's native watch API.\n *\n * @param files - Array of worker file paths to watch\n */\nasync function setupWatchMode(files: string[]) {\n  for (const filePath of files) {\n    const outputFile = filePath.replace(/\\.ts$/, '.js')\n\n    const ctx = await context(esbuildOptions(filePath, outputFile))\n\n    await ctx.watch()\n    buildContexts.push(ctx)\n    compiledFiles.add(outputFile)\n\n    console.log(`👀 Watching ${filePath}`)\n  }\n}\n\n/**\n * Setup function to build the worker files with esbuild.\n *\n * Bundles the worker files with esbuild and sets up watch mode if in watch mode.\n * All npm packages are automatically marked as external (loaded from node_modules at runtime).\n * Only internal project code is bundled inline.\n *\n * @param filePaths - The paths to the worker files to build\n * @returns A promise that resolves when the worker build is setup\n * @throws If the worker files cannot be bundled\n * @throws If the watcher cannot be set up\n */\nexport async function setupWorkerBuild(filePaths: string[]) {\n  const isWatchMode =\n    (process.env.VITEST_WATCH === 'true' || !process.argv.includes('run')) &&\n    process.env.CI !== 'true'\n\n  await (isWatchMode ? setupWatchMode(filePaths) : setupBundling(filePaths))\n}\n\n/**\n * Teardown function to clean up the worker build.\n *\n * Closes all build contexts and deletes the compiled JavaScript files.\n *\n * @returns A promise that resolves when the worker build is teared down\n * @throws If the build contexts cannot be disposed\n * @throws If the compiled JavaScript files cannot be deleted\n */\nexport async function teardownWorkerBuild(): Promise<void> {\n  // Dispose all build contexts (for watch mode)\n  for (const ctx of buildContexts) {\n    await ctx.dispose()\n  }\n  buildContexts = []\n\n  // Clean up compiled JavaScript files\n  console.log('Cleaning up compiled JavaScript files...')\n  for (const filePath of compiledFiles) {\n    try {\n      await unlink(filePath)\n      console.log(`✓ Deleted ${filePath}`)\n    } catch (error) {\n      console.error(`Failed to delete ${filePath}:`, error)\n    }\n  }\n  compiledFiles.clear()\n}\n"],"names":["unlink","build","context","compiledFiles","Set","buildContexts","esbuildOptions","filePath","outputFile","bundle","conditions","entryPoints","external","format","loader","logLevel","mainFields","outfile","packages","platform","sourcemap","target","bundleWorkerFile","replace","add","setupBundling","filePaths","console","log","length","workerFile","error","setupWatchMode","files","ctx","watch","push","setupWorkerBuild","isWatchMode","process","env","VITEST_WATCH","argv","includes","CI","teardownWorkerBuild","dispose","clear"],"mappings":"AAAA;;;;;CAKC,GACD,SAAQA,MAAM,QAAO,mBAAkB;AAEvC,SAAQC,KAAK,EAAwCC,OAAO,QAAO,UAAS;AAE5E,MAAMC,gBAA6B,IAAIC;AACvC,IAAIC,gBAAgC,EAAE;AAEtC;;;;;;CAMC,GACD,SAASC,eAAeC,QAAgB,EAAEC,UAAkB;IAC1D,OAAO;QACLC,QAAQ;QACRC,YAAY;YAAC;YAAQ;SAAS;QAC9BC,aAAa;YAACJ;SAAS;QACvB,yDAAyD;QACzD,6CAA6C;QAC7CK,UAAU;YAAC;SAAmB;QAC9BC,QAAQ;QACRC,QAAQ;YAAC,SAAS;QAAM;QACxBC,UAAU;QACVC,YAAY;YAAC;YAAU;SAAO;QAC9BC,SAAST;QACTU,UAAU;QACVC,UAAU;QACVC,WAAW;QACXC,QAAQ;IACV;AACF;AAEA;;;;;;CAMC,GACD,eAAeC,iBAAiBf,QAAgB;IAC9C,MAAMC,aAAaD,SAASgB,OAAO,CAAC,SAAS;IAE7C,MAAMtB,MAAMK,eAAeC,UAAUC;IAErCL,cAAcqB,GAAG,CAAChB;IAClB,OAAOA;AACT;AAEA;;;;CAIC,GACD,eAAeiB,cAAcC,SAAmB;IAC9CC,QAAQC,GAAG,CAAC,CAAC,MAAM,EAAEF,UAAUG,MAAM,CAAC,uBAAuB,CAAC;IAE9D,KAAK,MAAMC,cAAcJ,UAAW;QAClC,IAAI;YACF,MAAMJ,iBAAiBQ;YACvBH,QAAQC,GAAG,CAAC,CAAC,UAAU,EAAEE,YAAY;QACvC,EAAE,OAAOC,OAAO;YACdJ,QAAQI,KAAK,CAAC,CAAC,mBAAmB,EAAED,WAAW,CAAC,CAAC,EAAEC;YACnD,MAAMA;QACR;IACF;AACF;AAEA;;;;CAIC,GACD,eAAeC,eAAeC,KAAe;IAC3C,KAAK,MAAM1B,YAAY0B,MAAO;QAC5B,MAAMzB,aAAaD,SAASgB,OAAO,CAAC,SAAS;QAE7C,MAAMW,MAAM,MAAMhC,QAAQI,eAAeC,UAAUC;QAEnD,MAAM0B,IAAIC,KAAK;QACf9B,cAAc+B,IAAI,CAACF;QACnB/B,cAAcqB,GAAG,CAAChB;QAElBmB,QAAQC,GAAG,CAAC,CAAC,YAAY,EAAErB,UAAU;IACvC;AACF;AAEA;;;;;;;;;;;CAWC,GACD,OAAO,eAAe8B,iBAAiBX,SAAmB;IACxD,MAAMY,cACJ,AAACC,CAAAA,QAAQC,GAAG,CAACC,YAAY,KAAK,UAAU,CAACF,QAAQG,IAAI,CAACC,QAAQ,CAAC,MAAK,KACpEJ,QAAQC,GAAG,CAACI,EAAE,KAAK;IAErB,MAAON,CAAAA,cAAcN,eAAeN,aAAaD,cAAcC,UAAS;AAC1E;AAEA;;;;;;;;CAQC,GACD,OAAO,eAAemB;IACpB,8CAA8C;IAC9C,KAAK,MAAMX,OAAO7B,cAAe;QAC/B,MAAM6B,IAAIY,OAAO;IACnB;IACAzC,gBAAgB,EAAE;IAElB,qCAAqC;IACrCsB,QAAQC,GAAG,CAAC;IACZ,KAAK,MAAMrB,YAAYJ,cAAe;QACpC,IAAI;YACF,MAAMH,OAAOO;YACboB,QAAQC,GAAG,CAAC,CAAC,UAAU,EAAErB,UAAU;QACrC,EAAE,OAAOwB,OAAO;YACdJ,QAAQI,KAAK,CAAC,CAAC,iBAAiB,EAAExB,SAAS,CAAC,CAAC,EAAEwB;QACjD;IACF;IACA5B,cAAc4C,KAAK;AACrB"}

package/examples/basic-app/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "basic-app",
+  "version": "1.0.0",
+  "private": true,
+  "keywords": [
+    "sanity"
+  ],
+  "license": "UNLICENSED",
+  "main": "package.json",
+  "scripts": {
+    "build": "sanity build",
+    "dev": "sanity dev",
+    "start": "sanity start"
+  },
+  "dependencies": {
+    "@sanity/sdk": "^2.5.0",
+    "@sanity/sdk-react": "^2.5.0",
+    "react": "^19.2.3",
+    "react-dom": "^19.2.3",
+    "sanity": "^5.6.0"
+  },
+  "devDependencies": {
+    "@types/react": "^19.2.8",
+    "sanity": "^5.6.0",
+    "typescript": "^5.9.3"
+  }
+}

package/examples/basic-app/sanity.cli.ts

@@ -0,0 +1,12 @@
+import {defineCliConfig} from 'sanity/cli'
+
+export default defineCliConfig({
+  app: {
+    entry: './src/App.tsx',
+    organizationId: 'org-id',
+  },
+  deployment: {
+    appId: 'app-id',
+    autoUpdates: true,
+  },
+})

package/examples/basic-app/src/App.css

@@ -0,0 +1,20 @@
+/* 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/examples/basic-app/src/App.tsx

@@ -0,0 +1,26 @@
+import {type SanityConfig} from '@sanity/sdk'
+import {SanityApp} from '@sanity/sdk-react'
+
+import {ExampleComponent} from './ExampleComponent'
+import './App.css'
+
+function App() {
+  // apps can access many different projects or other sources of data
+  const sanityConfigs: SanityConfig[] = [
+    {
+      dataset: 'dataset-name',
+      projectId: 'project-id',
+    },
+  ]
+
+  return (
+    <div className="app-container">
+      <SanityApp config={sanityConfigs} fallback={<div>Loading...</div>}>
+        {/* add your own components here! */}
+        <ExampleComponent />
+      </SanityApp>
+    </div>
+  )
+}
+
+export default App

package/examples/basic-app/src/ExampleComponent.css

@@ -0,0 +1,84 @@
+.example-container {
+  background-color: white;
+  border-radius: 8px;
+  padding: 2rem;
+  box-shadow: 0 2px 8px rgba(0, 0, 0, 0.05);
+}
+
+.example-avatar-container {
+  position: relative;
+  margin-block-end: 1rem;
+}
+
+@keyframes wave {
+  0% {
+    rotate: 0deg;
+  }
+  2% {
+    rotate: 20deg;
+    filter: blur(1px);
+  }
+  4% {
+    rotate: 0deg;
+  }
+  6% {
+    rotate: -20deg;
+  }
+  8% {
+    rotate: 0deg;
+  }
+  10% {
+    rotate: 20deg;
+  }
+  12% {
+    rotate: 0deg;
+  }
+  14% {
+    rotate: -20deg;
+  }
+  16% {
+    rotate: 0deg;
+    filter: blur(0);
+  }
+}
+
+.example-avatar-container:after {
+  content: '👋';
+  position: absolute;
+  font-size: 1.5rem;
+  display: flex;
+  align-items: center;
+  justify-container: center;
+  inset-inline-start: 0;
+  inset-block-start: 0;
+  translate: -25% -25%;
+  transform-origin: 100% 100%;
+  animation: wave 4s infinite linear;
+}
+
+.example-avatar {
+  inline-size: 4rem;
+  aspect-ratio: 1;
+  border-radius: 50%;
+}
+
+.example-heading {
+  color: #333;
+  margin-top: 0;
+  font-size: 2rem;
+}
+
+p {
+  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;
+  line-height: 1.5;
+}

package/examples/basic-app/src/ExampleComponent.tsx

@@ -0,0 +1,38 @@
+import {type CurrentUser, useCurrentUser} from '@sanity/sdk-react'
+
+import './ExampleComponent.css'
+
+export function ExampleComponent() {
+  const user: CurrentUser | null = useCurrentUser()
+
+  return (
+    <div className="example-container">
+      {user?.profileImage ? (
+        <div className="example-avatar-container">
+          <img alt="" className="example-avatar" src={user.profileImage} />
+        </div>
+      ) : (
+        ''
+      )}
+      <h1 className="example-heading">
+        Welcome to your Sanity App{user?.name ? `, ${user.name}` : ''}!
+      </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 config={sanityConfigs}>
+  <YourComponent />
+</SanityApp>`}</pre>
+      </div>
+    </div>
+  )
+}

package/examples/basic-app/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "target": "ES2017",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "module": "Preserve",
+    "moduleDetection": "force",
+    "isolatedModules": true,
+    "jsx": "preserve",
+    "incremental": true
+  },
+  "include": ["**/*.ts", "**/*.tsx"],
+  "exclude": ["node_modules"]
+}

package/examples/basic-studio/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@sanity/basic-studio",
+  "version": "1.0.0",
+  "private": true,
+  "keywords": [
+    "sanity"
+  ],
+  "license": "MIT",
+  "type": "module",
+  "main": "package.json",
+  "scripts": {
+    "build": "sanity build",
+    "deploy": "sanity deploy",
+    "deploy-graphql": "sanity graphql deploy",
+    "dev": "sanity dev",
+    "start": "sanity start"
+  },
+  "dependencies": {
+    "@sanity/vision": "^5.6.0",
+    "react": "^19.2.3",
+    "react-dom": "^19.2.3",
+    "sanity": "^5.6.0",
+    "styled-components": "^6.3.5"
+  },
+  "devDependencies": {
+    "@types/react": "^19.2.8",
+    "typescript": "^5.9.3"
+  }
+}

package/examples/basic-studio/sanity.cli.ts

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

package/examples/basic-studio/sanity.config.ts

@@ -0,0 +1,18 @@
+import {visionTool} from '@sanity/vision'
+import {defineConfig} from 'sanity'
+import {structureTool} from 'sanity/structure'
+
+import {schemaTypes} from './schemaTypes'
+
+export default defineConfig({
+  title: 'Basic Studio',
+
+  dataset: 'test',
+  projectId: 'ppsg7ml5',
+
+  plugins: [structureTool(), visionTool()],
+
+  schema: {
+    types: schemaTypes,
+  },
+})

package/examples/basic-studio/schemaTypes/author.ts

@@ -0,0 +1,52 @@
+import {defineField, defineType} from 'sanity'
+
+export default defineType({
+  name: 'author',
+  title: 'Author',
+  type: 'document',
+
+  fields: [
+    defineField({
+      name: 'name',
+      title: 'Name',
+      type: 'string',
+    }),
+    defineField({
+      name: 'slug',
+      options: {
+        maxLength: 96,
+        source: 'name',
+      },
+      title: 'Slug',
+      type: 'slug',
+    }),
+    defineField({
+      name: 'image',
+      options: {
+        hotspot: true,
+      },
+      title: 'Image',
+      type: 'image',
+    }),
+    defineField({
+      name: 'bio',
+      of: [
+        {
+          lists: [],
+          styles: [{title: 'Normal', value: 'normal'}],
+          title: 'Block',
+          type: 'block',
+        },
+      ],
+      title: 'Bio',
+      type: 'array',
+    }),
+  ],
+
+  preview: {
+    select: {
+      media: 'image',
+      title: 'name',
+    },
+  },
+})