@sanity/cli-core 1.0.0 → 1.1.0

package/dist/index.d.ts

@@ -1,36 +1,39 @@
-import {ClientConfig} from '@sanity/client'
-import {CLIError} from '@oclif/core/errors'
-import {Command} from '@oclif/core'
-import {ConfigEnv} from 'vite'
-import ConfigStore from 'configstore'
-import {ConsentStatus} from '@sanity/telemetry'
-import debugIt from 'debug'
-import {InlineConfig} from 'vite'
-import {Interfaces} from '@oclif/core'
-import {PluginOptions} from 'babel-plugin-react-compiler'
-import {SanityClient} from '@sanity/client'
-import {TelemetryLogger} from '@sanity/telemetry'
-import {URL as URL_2} from 'node:url'
-import {Worker as Worker_2} from 'node:worker_threads'
-import {WorkerOptions as WorkerOptions_2} from 'node:worker_threads'
-import {Workspace} from 'sanity'
-import * as z from 'zod'
-import {z as z_2} from 'zod'
-
-declare type Args<T extends typeof Command> = Interfaces.InferredArgs<T['args']>
+import { ClientConfig } from "@sanity/client";
+import { CLIError } from "@oclif/core/errors";
+import { Command } from "@oclif/core";
+import { CommandError } from "@oclif/core/interfaces";
+import { ConfigEnv } from "vite";
+import ConfigStore from "configstore";
+import { ConsentStatus } from "@sanity/telemetry";
+import debugIt from "debug";
+import { InlineConfig } from "vite";
+import { Interfaces } from "@oclif/core";
+import { PluginOptions } from "babel-plugin-react-compiler";
+import { SanityClient } from "sanity";
+import { SanityClient as SanityClient_2 } from "@sanity/client";
+import { TelemetryLogger } from "@sanity/telemetry";
+import { URL as URL_2 } from "node:url";
+import { Worker as Worker_2 } from "node:worker_threads";
+import { WorkerOptions as WorkerOptions_2 } from "node:worker_threads";
+import { Workspace } from "sanity";
+import { z } from "zod";
+
+declare type Args<T extends typeof Command> = Interfaces.InferredArgs<
+  T["args"]
+>;
 
 /**
  * Clears the global CLI telemetry store.
  * @internal
  */
-export declare function clearCliTelemetry(): void
+export declare function clearCliTelemetry(): void;
 
 /**
  * @public
- * Symbol used to store the CLI telemetry store on globalThis.
- * Use `getCliTelemetry()` to access the store instead of accessing this directly.
+ * Symbol used to store CLI telemetry state on globalThis.
+ * Use the accessor functions instead of accessing this directly.
  */
-export declare const CLI_TELEMETRY_SYMBOL: unique symbol
+export declare const CLI_TELEMETRY_SYMBOL: unique symbol;
 
 /**
  * @public
@@ -38,24 +41,27 @@ export declare const CLI_TELEMETRY_SYMBOL: unique symbol
 export declare interface CliConfig {
   /** The project ID and dataset the Sanity CLI should use to run its commands */
   api?: {
-    dataset?: string
-    projectId?: string
-  }
+    dataset?: string;
+    projectId?: string;
+  };
   /** Configuration for custom Sanity apps built with the App SDK */
   app?: {
     /** The entrypoint for your custom app. By default, `src/App.tsx` */
-    entry?: string
-    /** String encoding of an icon (typically an SVG) */
-    icon?: string
+    entry?: string;
+    /**
+     * Path to an icon file relative to project root.
+     * The file must be an SVG.
+     */
+    icon?: string;
     /** @deprecated Use deployment.appId */
-    id?: string
+    id?: string;
     /** The ID for the Sanity organization that manages this application */
-    organizationId?: string
-    /** The title of the custom app. Used in Dashboard and in the browser tab */
-    title?: string
-  }
+    organizationId?: string;
+    /** The title of the custom app, as it is seen in Dashboard UI */
+    title?: string;
+  };
   /** @deprecated Use deployment.autoUpdates */
-  autoUpdates?: boolean
+  autoUpdates?: boolean;
   /** Options for custom app and Studio deployments */
   deployment?: {
     /**
@@ -67,37 +73,37 @@ export declare interface CliConfig {
      * @remarks This is required for all custom app deployments, and for Studios opting in to fine grained version control.
      * {@link https://www.sanity.io/docs/studio/latest-version-of-sanity#k0896ed4574b7}
      */
-    appId?: string
+    appId?: string;
     /**
      * Enable automatic updates for your Studio or custom app’s Sanity dependencies.
      * {@link https://www.sanity.io/docs/studio/latest-version-of-sanity}
      */
-    autoUpdates?: boolean
-  }
+    autoUpdates?: boolean;
+  };
   /** Define the GraphQL APIs that the CLI can deploy and interact with */
   graphql?: Array<{
-    filterSuffix?: string
-    generation?: 'gen1' | 'gen2' | 'gen3'
-    id?: string
-    nonNullDocumentFields?: boolean
-    playground?: boolean
-    source?: string
-    tag?: string
-    workspace?: string
-  }>
+    filterSuffix?: string;
+    generation?: "gen1" | "gen2" | "gen3";
+    id?: string;
+    nonNullDocumentFields?: boolean;
+    playground?: boolean;
+    source?: string;
+    tag?: string;
+    workspace?: string;
+  }>;
   /** Configuration for the Media Library */
   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
-  }
+    aspectsPath?: string;
+  };
   /** Contains the property `basePath` which lets you change the top-level slug for the Studio. You typically need to set this if you embed the Studio in another application where it is one of many routes. Defaults to an empty string. */
   project?: {
-    basePath?: string
-  }
+    basePath?: string;
+  };
   /** Configuration options for React Compiler */
-  reactCompiler?: PluginOptions
+  reactCompiler?: PluginOptions;
   /** Wraps the Studio in \<React.StrictMode\> root to aid in flagging potential problems related to concurrent features (startTransition, useTransition, useDeferredValue, Suspense). Can also be enabled by setting SANITY_STUDIO_REACT_STRICT_MODE="true"|"false". It only applies to sanity dev in development mode and is ignored in sanity build and in production. Defaults to false. */
-  reactStrictMode?: boolean
+  reactStrictMode?: boolean;
   /**
    * Configuration for schema extraction (`sanity schema extract`)
    */
@@ -105,37 +111,37 @@ export declare interface CliConfig {
     /**
      * Enable schema extraction as part of sanity dev and sanity build
      */
-    enabled?: boolean
+    enabled?: boolean;
     /**
      * When true, schema fields marked as required will be non-optional in the output.
      * Defaults to `false`
      */
-    enforceRequiredFields?: boolean
+    enforceRequiredFields?: boolean;
     /**
      * Output path for the extracted schema file.
      * Defaults to `schema.json` in the working directory.
      */
-    path?: string
+    path?: string;
     /**
      * Additional glob patterns to watch for schema changes in watch mode.
      * These extend the default patterns:
      * - `sanity.config.{js,jsx,ts,tsx,mjs}`
      * - `schema*\/**\/*.{js,jsx,ts,tsx,mjs}`
      */
-    watchPatterns?: string[]
+    watchPatterns?: string[];
     /**
      * The name of the workspace to generate a schema for. Required if your Sanity project has more than one
      * workspace.
      */
-    workspace?: string
-  }
+    workspace?: string;
+  };
   /** Defines the hostname and port that the development server should run on. hostname defaults to localhost, and port to 3333. */
   server?: {
-    hostname?: string
-    port?: number
-  }
+    hostname?: string;
+    port?: number;
+  };
   /** @deprecated Use deployment.appId */
-  studioHost?: string
+  studioHost?: string;
   /**
    * Configuration for Sanity typegen
    */
@@ -145,81 +151,68 @@ export declare interface CliConfig {
      * When enabled, types are generated on startup and when files change.
      * Defaults to `false`
      */
-    enabled?: boolean
-  }
+    enabled?: boolean;
+  };
   /** Exposes the default Vite configuration for custom apps and the Studio so it can be changed and extended. */
-  vite?: UserViteConfig
+  vite?: UserViteConfig;
 }
 
 /**
  * @public
  */
-export declare type CLITelemetryStore = TelemetryLogger<TelemetryUserProperties>
+export declare type CLITelemetryStore =
+  TelemetryLogger<TelemetryUserProperties>;
 
 /**
  * The CLI user configuration schema.
  *
  * @internal
  */
-declare type CliUserConfig = z_2.infer<z_2.ZodObject<typeof cliUserConfigSchema>>
+declare type CliUserConfig = z.infer<z.ZodObject<typeof cliUserConfigSchema>>;
 
 declare const cliUserConfigSchema: {
-  authToken: z_2.ZodOptional<z_2.ZodString>
-  telemetryConsent: z_2.ZodOptional<
-    z_2.ZodObject<
+  authToken: z.ZodOptional<z.ZodString>;
+  telemetryConsent: z.ZodOptional<
+    z.ZodObject<
       {
-        updatedAt: z_2.ZodOptional<z_2.ZodNumber>
-        value: z_2.ZodObject<
+        updatedAt: z.ZodOptional<z.ZodNumber>;
+        value: z.ZodObject<
           {
-            status: z_2.ZodEnum<{
-              undetermined: 'undetermined'
-              unset: 'unset'
-              granted: 'granted'
-              denied: 'denied'
-            }>
-            type: z_2.ZodString
+            status: z.ZodEnum<{
+              undetermined: "undetermined";
+              unset: "unset";
+              granted: "granted";
+              denied: "denied";
+            }>;
+            type: z.ZodString;
           },
-          z_2.core.$loose
-        >
+          z.core.$loose
+        >;
       },
-      z_2.core.$strip
+      z.core.$strip
     >
-  >
-}
-
-export declare function colorizeJson(input: unknown): string
+  >;
+};
 
-/**
- * @internal
- */
-declare const configDefinition: z.ZodObject<
-  {
-    formatGeneratedCode: z.ZodDefault<z.ZodBoolean>
-    generates: z.ZodDefault<z.ZodString>
-    overloadClientMethods: z.ZodDefault<z.ZodBoolean>
-    path: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString>]>>
-    schema: z.ZodDefault<z.ZodString>
-  },
-  z.core.$strip
->
+export declare function colorizeJson(input: unknown): string;
 
 export declare type ConsentInformation =
   | {
-      reason: 'fetchError' | 'unauthenticated'
-      status: Extract<ConsentStatus, 'undetermined'>
+      reason: "fetchError" | "unauthenticated";
+      status: Extract<ConsentStatus, "undetermined">;
     }
   | {
-      reason?: 'localOverride'
-      status: Extract<ConsentStatus, 'denied'>
+      reason?: "localOverride";
+      status: Extract<ConsentStatus, "denied">;
     }
   | {
-      reason?: never
-      status: Extract<ConsentStatus, 'granted'>
+      reason?: never;
+      status: Extract<ConsentStatus, "granted">;
     }
   | {
-      reason?: never
-      status: Extract<ConsentStatus, 'unset'>
-    }
+      reason?: never;
+      status: Extract<ConsentStatus, "unset">;
+    };
 
 /**
  * Creates a new worker for a studio worker task.
@@ -252,15 +245,15 @@ export declare type ConsentInformation =
 export declare function createStudioWorker(
   filePath: URL,
   options: StudioWorkerTaskOptions,
-): Worker_2
+): Worker_2;
 
 /**
  * `debug` instance for the CLI
  *
  * @internal
  */
-declare const debug_2: debugIt.Debugger
-export {debug_2 as debug}
+declare const debug_2: debugIt.Debugger;
+export { debug_2 as debug };
 
 /**
  * This function is a replacement for built in dynamic import
@@ -268,7 +261,7 @@ export {debug_2 as debug}
  *
  * @param source - File path
  */
-export declare function doImport(source: string): Promise<any>
+export declare function doImport(source: string): Promise<any>;
 
 /**
  * Finds the path for a given set of files.
@@ -277,7 +270,10 @@ export declare function doImport(source: string): Promise<any>
  * @param files - The files to search for.
  * @internal
  */
-export declare function findPathForFiles(basePath: string, files: string[]): Promise<PathResult[]>
+export declare function findPathForFiles(
+  basePath: string,
+  files: string[],
+): Promise<PathResult[]>;
 
 /**
  * Resolve project root directory and type.
@@ -291,7 +287,9 @@ export declare function findPathForFiles(basePath: string, files: string[]): Pro
  *
  * @internal
  */
-export declare function findProjectRoot(cwd: string): Promise<ProjectRootResult>
+export declare function findProjectRoot(
+  cwd: string,
+): Promise<ProjectRootResult>;
 
 /**
  * Resolve project root directory and type synchronously.
@@ -307,7 +305,7 @@ export declare function findProjectRoot(cwd: string): Promise<ProjectRootResult>
  * @returns Project root result
  * @internal
  */
-export declare function findProjectRootSync(cwd: string): ProjectRootResult
+export declare function findProjectRootSync(cwd: string): ProjectRootResult;
 
 /**
  * Resolves to a string containing the found config path, otherwise throws an error.
@@ -318,11 +316,11 @@ export declare function findProjectRootSync(cwd: string): ProjectRootResult
  * @throws On multiple config files found, if v2 studio root found, or no config found
  * @internal
  */
-export declare function findStudioConfigPath(basePath: string): Promise<string>
+export declare function findStudioConfigPath(basePath: string): Promise<string>;
 
 declare type Flags<T extends typeof Command> = Interfaces.InferredFlags<
-  (typeof SanityCommand)['baseFlags'] & T['flags']
->
+  (typeof SanityCommand)["baseFlags"] & T["flags"]
+>;
 
 /**
  * Get the CLI config for a project, given the root path.
@@ -339,7 +337,7 @@ declare type Flags<T extends typeof Command> = Interfaces.InferredFlags<
  * @returns The CLI config
  * @internal
  */
-export declare function getCliConfig(rootPath: string): Promise<CliConfig>
+export declare function getCliConfig(rootPath: string): Promise<CliConfig>;
 
 /**
  * Get the CLI config for a project synchronously, given the root path.
@@ -351,12 +349,12 @@ export declare function getCliConfig(rootPath: string): Promise<CliConfig>
  * @returns The CLI config
  * @internal
  */
-export declare function getCliConfigSync(rootPath: string): CliConfig
+export declare function getCliConfigSync(rootPath: string): CliConfig;
 
 /**
  * @public
  */
-export declare function getCliTelemetry(): CLITelemetryStore
+export declare function getCliTelemetry(): CLITelemetryStore;
 
 /**
  * Get the CLI authentication token from the environment or the config file
@@ -364,7 +362,7 @@ export declare function getCliTelemetry(): CLITelemetryStore
  * @returns A promise that resolves to a CLI token, or undefined if no token is found
  * @internal
  */
-export declare function getCliToken(): Promise<string | undefined>
+export declare function getCliToken(): Promise<string | undefined>;
 
 /**
  * Get the config value for the given property
@@ -375,7 +373,7 @@ export declare function getCliToken(): Promise<string | undefined>
  */
 export declare function getCliUserConfig<P extends keyof CliUserConfig>(
   prop: P,
-): Promise<CliUserConfig[P]>
+): Promise<CliUserConfig[P]>;
 
 /**
  * Create a "global" (unscoped) Sanity API client.
@@ -390,7 +388,7 @@ export declare function getGlobalCliClient({
   token: providedToken,
   unauthenticated,
   ...config
-}: GlobalCliClientOptions): Promise<SanityClient>
+}: GlobalCliClientOptions): Promise<SanityClient_2>;
 
 /**
  * Create a "project" (scoped) Sanity API client.
@@ -404,7 +402,7 @@ export declare function getProjectCliClient({
   requireUser,
   token: providedToken,
   ...config
-}: ProjectCliClientOptions): Promise<SanityClient>
+}: ProjectCliClientOptions): Promise<SanityClient_2>;
 
 /**
  * Gets an environment variable with the appropriate Sanity prefix based on whether it's an app or studio.
@@ -424,13 +422,16 @@ export declare function getProjectCliClient({
  *
  * @internal
  */
-export declare function getSanityEnvVar(suffix: string, isApp: boolean): string | undefined
+export declare function getSanityEnvVar(
+  suffix: string,
+  isApp: boolean,
+): string | undefined;
 
 /**
  * @internal
  * @returns The Sanity URL for the given path, using the correct domain based on the environment
  */
-export declare function getSanityUrl(path?: string): string
+export declare function getSanityUrl(path?: string): string;
 
 /**
  * Get the studio config for a project, given the root path.
@@ -442,16 +443,16 @@ export declare function getSanityUrl(path?: string): string
 export declare function getStudioConfig(
   rootPath: string,
   options: {
-    resolvePlugins: true
+    resolvePlugins: true;
   },
-): Promise<ResolvedStudioConfig>
+): Promise<ResolvedStudioConfig>;
 
 export declare function getStudioConfig(
   rootPath: string,
   options: {
-    resolvePlugins: false
+    resolvePlugins: false;
   },
-): Promise<RawStudioConfig>
+): Promise<RawStudioConfig>;
 
 /**
  * Resolves the workspaces from the studio config.
@@ -462,7 +463,9 @@ export declare function getStudioConfig(
  * @returns The workspaces
  * @internal
  */
-export declare function getStudioWorkspaces(configPath: string): Promise<Workspace[]>
+export declare function getStudioWorkspaces(
+  configPath: string,
+): Promise<Workspace[]>;
 
 /**
  * Gets the base telemetry information needed for file operations.
@@ -475,16 +478,16 @@ export declare function getStudioWorkspaces(configPath: string): Promise<Workspa
  * @throws Error if no auth token is found
  * @internal
  */
-export declare function getTelemetryBaseInfo(): Promise<TelemetryBaseInfo>
+export declare function getTelemetryBaseInfo(): Promise<TelemetryBaseInfo>;
 
 /**
  * Starts a terminal timer
  *
  * @internal
  */
-export declare function getTimer(): TimeMeasurer
+export declare function getTimer(): TimeMeasurer;
 
-export declare const getUserConfig: () => ConfigStore
+export declare const getUserConfig: () => ConfigStore;
 
 /**
  * @public
@@ -493,19 +496,19 @@ export declare interface GlobalCliClientOptions extends ClientConfig {
   /**
    * The API version to use for this client.
    */
-  apiVersion: string
+  apiVersion: string;
   /**
    * Whether to require a user to be authenticated to use this client.
    * Default: `false`.
    * Throws an error if `true` and user is not authenticated.
    */
-  requireUser?: boolean
+  requireUser?: boolean;
   /**
    * Whether to skip reading the stored CLI token. When `true`, the client will
    * have no token unless one is explicitly provided.
    * Default: `false`.
    */
-  unauthenticated?: boolean
+  unauthenticated?: boolean;
 }
 
 /**
@@ -521,24 +524,24 @@ export declare interface GlobalCliClientOptions extends ClientConfig {
 export declare function importModule<T = unknown>(
   filePath: string | URL,
   options?: ImportModuleOptions,
-): Promise<T>
+): Promise<T>;
 
 declare interface ImportModuleOptions {
   /**
    * Whether to return the default export of the module.
    * Default: true
    */
-  default?: boolean
+  default?: boolean;
   /**
    * Path to the tsconfig file to use for the import. If not provided, the tsconfig
    * will be inferred from the nearest `tsconfig.json` file.
    */
-  tsconfigPath?: string
+  tsconfigPath?: string;
 }
 
-export declare const isCi: () => boolean
+export declare const isCi: () => boolean;
 
-export declare function isInteractive(): boolean
+export declare function isInteractive(): boolean;
 
 /**
  * Returns whether or not the given error is a `NotFoundError`
@@ -547,7 +550,7 @@ export declare function isInteractive(): boolean
  * @returns `true` if the error is a `NotFoundError`, `false` otherwise
  * @internal
  */
-export declare function isNotFoundError(err: unknown): err is NotFoundError
+export declare function isNotFoundError(err: unknown): err is NotFoundError;
 
 /**
  * Returns whether or not the given error is a `ProjectRootNotFoundError`
@@ -556,7 +559,9 @@ export declare function isNotFoundError(err: unknown): err is NotFoundError
  * @returns `true` if the error is a `ProjectRootNotFoundError`, `false` otherwise
  * @internal
  */
-export declare function isProjectRootNotFoundError(err: unknown): err is ProjectRootNotFoundError
+export declare function isProjectRootNotFoundError(
+  err: unknown,
+): err is ProjectRootNotFoundError;
 
 /**
  * Checks if the environment is staging.
@@ -564,7 +569,7 @@ export declare function isProjectRootNotFoundError(err: unknown): err is Project
  * @returns True if the environment is staging, false otherwise
  * @internal
  */
-export declare function isStaging(): boolean
+export declare function isStaging(): boolean;
 
 /**
  * Checks if the given value conforms to a minimum studio config shape.
@@ -573,7 +578,7 @@ export declare function isStaging(): boolean
  * @returns Whether the value is a studio config
  * @internal
  */
-export declare function isStudioConfig(value: unknown): boolean
+export declare function isStudioConfig(value: unknown): boolean;
 
 /**
  * Mocks a browser-like environment for processes in the main thread by:
@@ -591,7 +596,9 @@ export declare function isStudioConfig(value: unknown): boolean
  * @returns A cleanup function that removes the injected globals and environment variables
  * @internal
  */
-export declare function mockBrowserEnvironment(basePath: string): Promise<() => void>
+export declare function mockBrowserEnvironment(
+  basePath: string,
+): Promise<() => void>;
 
 /**
  * Error thrown when a prompt is attempted in a non-interactive environment
@@ -601,7 +608,7 @@ export declare function mockBrowserEnvironment(basePath: string): Promise<() =>
  * Extends `CLIError` to suppress stack traces in user-facing output.
  */
 export declare class NonInteractiveError extends CLIError {
-  constructor(promptName: string)
+  constructor(promptName: string);
 }
 
 /**
@@ -612,7 +619,7 @@ export declare class NonInteractiveError extends CLIError {
  * @returns Normalized path with forward slashes
  * @public
  */
-export declare function normalizePath(path: string): string
+export declare function normalizePath(path: string): string;
 
 /**
  * Error thrown when a file or directory is not found
@@ -622,15 +629,15 @@ export declare function normalizePath(path: string): string
  * @internal
  */
 export declare class NotFoundError extends Error {
-  code: string
-  path?: string
-  constructor(message: string, path?: string)
+  code: string;
+  path?: string;
+  constructor(message: string, path?: string);
 }
 
 export declare interface Output {
-  error: Command['error']
-  log: Command['log']
-  warn: Command['warn']
+  error: Command["error"];
+  log: Command["log"];
+  warn: Command["warn"];
 }
 
 /**
@@ -639,7 +646,7 @@ export declare interface Output {
  *
  * @public
  */
-export declare type PackageJson = z_2.infer<typeof packageJsonSchema>
+export declare type PackageJson = z.infer<typeof packageJsonSchema>;
 
 /**
  * Comprehensive package.json schema including all common properties.
@@ -648,47 +655,47 @@ export declare type PackageJson = z_2.infer<typeof packageJsonSchema>
  * 🟠ℹ️ SINCE THIS IS USED IN A NUMBER OF LOCATIONS WHERE ℹ️🟠
  * 🟠ℹ️ WE CANNOT ENFORCE/GUARANTEE ANY PARTICULAR PROPS  ℹ️🟠
  */
-declare const packageJsonSchema: z_2.ZodObject<
+declare const packageJsonSchema: z.ZodObject<
   {
-    name: z_2.ZodString
-    version: z_2.ZodString
-    dependencies: z_2.ZodOptional<z_2.ZodRecord<z_2.ZodString, z_2.ZodString>>
-    devDependencies: z_2.ZodOptional<z_2.ZodRecord<z_2.ZodString, z_2.ZodString>>
-    peerDependencies: z_2.ZodOptional<z_2.ZodRecord<z_2.ZodString, z_2.ZodString>>
-    exports: z_2.ZodOptional<z_2.ZodRecord<z_2.ZodString, z_2.ZodAny>>
-    main: z_2.ZodOptional<z_2.ZodString>
-    types: z_2.ZodOptional<z_2.ZodString>
-    author: z_2.ZodOptional<z_2.ZodString>
-    description: z_2.ZodOptional<z_2.ZodString>
-    engines: z_2.ZodOptional<z_2.ZodRecord<z_2.ZodString, z_2.ZodString>>
-    license: z_2.ZodOptional<z_2.ZodString>
-    private: z_2.ZodOptional<z_2.ZodBoolean>
-    repository: z_2.ZodOptional<
-      z_2.ZodObject<
+    name: z.ZodString;
+    version: z.ZodString;
+    dependencies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    devDependencies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    peerDependencies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    exports: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    main: z.ZodOptional<z.ZodString>;
+    types: z.ZodOptional<z.ZodString>;
+    author: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    engines: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    license: z.ZodOptional<z.ZodString>;
+    private: z.ZodOptional<z.ZodBoolean>;
+    repository: z.ZodOptional<
+      z.ZodObject<
         {
-          type: z_2.ZodString
-          url: z_2.ZodString
+          type: z.ZodString;
+          url: z.ZodString;
         },
-        z_2.core.$strip
+        z.core.$strip
       >
-    >
-    scripts: z_2.ZodOptional<z_2.ZodRecord<z_2.ZodString, z_2.ZodString>>
-    type: z_2.ZodOptional<
-      z_2.ZodEnum<{
-        module: 'module'
-        commonjs: 'commonjs'
+    >;
+    scripts: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    type: z.ZodOptional<
+      z.ZodEnum<{
+        module: "module";
+        commonjs: "commonjs";
       }>
-    >
+    >;
   },
-  z_2.core.$loose
->
+  z.core.$loose
+>;
 
 /**
  * @internal
  */
 declare interface PathResult {
-  exists: boolean
-  path: string
+  exists: boolean;
+  path: string;
 }
 
 /**
@@ -698,21 +705,21 @@ export declare interface ProjectCliClientOptions extends ClientConfig {
   /**
    * The API version to use for this client.
    */
-  apiVersion: string
+  apiVersion: string;
   /**
    * The project ID to use for this client.
    */
-  projectId: string
+  projectId: string;
   /**
    * The dataset to use for this client.
    */
-  dataset?: string
+  dataset?: string;
   /**
    * Whether to require a user to be authenticated to use this client.
    * Default: `false`.
    * Throws an error if `true` and user is not authenticated.
    */
-  requireUser?: boolean
+  requireUser?: boolean;
 }
 
 /**
@@ -729,10 +736,10 @@ export declare class ProjectRootNotFoundError extends CLIError {
   constructor(
     message: string,
     options?: {
-      cause?: Error
-      suggestions?: string[]
+      cause?: Error;
+      suggestions?: string[];
     },
-  )
+  );
 }
 
 /**
@@ -741,15 +748,15 @@ export declare class ProjectRootNotFoundError extends CLIError {
  * @public
  */
 export declare interface ProjectRootResult {
-  directory: string
+  directory: string;
   /**
    * Path to the project configuration file, if found.
    */
-  path: string
+  path: string;
   /**
    * Type of project root.
    */
-  type: 'app' | 'studio'
+  type: "app" | "studio";
 }
 
 /**
@@ -767,106 +774,106 @@ export declare interface ProjectRootResult {
 export declare function promisifyWorker<T = unknown>(
   filePath: URL,
   options?: PromisifyWorkerOptions,
-): Promise<T>
+): Promise<T>;
 
 declare interface PromisifyWorkerOptions extends WorkerOptions_2 {
   /** Optional timeout in milliseconds. If the worker does not respond within this time, it will be terminated and the promise rejected. */
-  timeout?: number
+  timeout?: number;
 }
 
-declare const rawConfigSchema: z_2.ZodUnion<
+declare const rawConfigSchema: z.ZodUnion<
   readonly [
-    z_2.ZodArray<
-      z_2.ZodObject<
+    z.ZodArray<
+      z.ZodObject<
         {
-          basePath: z_2.ZodString
-          name: z_2.ZodString
-          plugins: z_2.ZodOptional<z_2.ZodArray<z_2.ZodUnknown>>
-          title: z_2.ZodString
-          unstable_sources: z_2.ZodArray<
-            z_2.ZodObject<
+          basePath: z.ZodString;
+          name: z.ZodString;
+          plugins: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
+          title: z.ZodString;
+          unstable_sources: z.ZodArray<
+            z.ZodObject<
               {
-                dataset: z_2.ZodString
-                projectId: z_2.ZodString
-                schema: z_2.ZodObject<
+                dataset: z.ZodString;
+                projectId: z.ZodString;
+                schema: z.ZodObject<
                   {
-                    _original: z_2.ZodObject<
+                    _original: z.ZodObject<
                       {
-                        name: z_2.ZodOptional<z_2.ZodString>
-                        types: z_2.ZodArray<z_2.ZodObject<{}, z_2.core.$loose>>
+                        name: z.ZodOptional<z.ZodString>;
+                        types: z.ZodArray<z.ZodObject<{}, z.core.$loose>>;
                       },
-                      z_2.core.$strip
-                    >
+                      z.core.$strip
+                    >;
                   },
-                  z_2.core.$strip
-                >
+                  z.core.$strip
+                >;
               },
-              z_2.core.$strip
+              z.core.$strip
             >
-          >
-          dataset: z_2.ZodString
-          projectId: z_2.ZodString
-          schema: z_2.ZodObject<
+          >;
+          dataset: z.ZodString;
+          projectId: z.ZodString;
+          schema: z.ZodObject<
             {
-              _original: z_2.ZodObject<
+              _original: z.ZodObject<
                 {
-                  name: z_2.ZodOptional<z_2.ZodString>
-                  types: z_2.ZodArray<z_2.ZodObject<{}, z_2.core.$loose>>
+                  name: z.ZodOptional<z.ZodString>;
+                  types: z.ZodArray<z.ZodObject<{}, z.core.$loose>>;
                 },
-                z_2.core.$strip
-              >
+                z.core.$strip
+              >;
             },
-            z_2.core.$strip
-          >
+            z.core.$strip
+          >;
         },
-        z_2.core.$strip
+        z.core.$strip
       >
     >,
-    z_2.ZodObject<
+    z.ZodObject<
       {
-        basePath: z_2.ZodOptional<z_2.ZodString>
-        name: z_2.ZodOptional<z_2.ZodString>
-        plugins: z_2.ZodOptional<z_2.ZodArray<z_2.ZodUnknown>>
-        schema: z_2.ZodOptional<
-          z_2.ZodObject<
+        basePath: z.ZodOptional<z.ZodString>;
+        name: z.ZodOptional<z.ZodString>;
+        plugins: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
+        schema: z.ZodOptional<
+          z.ZodObject<
             {
-              name: z_2.ZodOptional<z_2.ZodString>
-              types: z_2.ZodArray<z_2.ZodObject<{}, z_2.core.$loose>>
+              name: z.ZodOptional<z.ZodString>;
+              types: z.ZodArray<z.ZodObject<{}, z.core.$loose>>;
             },
-            z_2.core.$strip
+            z.core.$strip
           >
-        >
-        title: z_2.ZodOptional<z_2.ZodString>
-        unstable_sources: z_2.ZodArray<
-          z_2.ZodObject<
+        >;
+        title: z.ZodOptional<z.ZodString>;
+        unstable_sources: z.ZodArray<
+          z.ZodObject<
             {
-              dataset: z_2.ZodString
-              projectId: z_2.ZodString
-              schema: z_2.ZodObject<
+              dataset: z.ZodString;
+              projectId: z.ZodString;
+              schema: z.ZodObject<
                 {
-                  _original: z_2.ZodObject<
+                  _original: z.ZodObject<
                     {
-                      name: z_2.ZodOptional<z_2.ZodString>
-                      types: z_2.ZodArray<z_2.ZodObject<{}, z_2.core.$loose>>
+                      name: z.ZodOptional<z.ZodString>;
+                      types: z.ZodArray<z.ZodObject<{}, z.core.$loose>>;
                     },
-                    z_2.core.$strip
-                  >
+                    z.core.$strip
+                  >;
                 },
-                z_2.core.$strip
-              >
+                z.core.$strip
+              >;
             },
-            z_2.core.$strip
+            z.core.$strip
           >
-        >
-        dataset: z_2.ZodString
-        projectId: z_2.ZodString
+        >;
+        dataset: z.ZodString;
+        projectId: z.ZodString;
       },
-      z_2.core.$loose
+      z.core.$loose
     >,
   ]
->
+>;
 
-declare type RawStudioConfig = z_2.infer<typeof rawConfigSchema>
+declare type RawStudioConfig = z.infer<typeof rawConfigSchema>;
 
 /**
  * Read the `package.json` file at the given path
@@ -879,7 +886,7 @@ declare type RawStudioConfig = z_2.infer<typeof rawConfigSchema>
 export declare function readPackageJson(
   filePath: string | URL,
   options?: ReadPackageJsonOptions,
-): Promise<PackageJson>
+): Promise<PackageJson>;
 
 /**
  * Options for reading package.json files
@@ -891,64 +898,65 @@ export declare interface ReadPackageJsonOptions {
    * Default values to merge with the parsed package.json.
    * Parsed values take precedence over defaults.
    */
-  defaults?: Partial<PackageJson>
+  defaults?: Partial<PackageJson>;
   /**
    * Skip Zod schema validation. When true, the file is parsed but not validated.
    * Defaults to false.
    */
-  skipSchemaValidation?: boolean
+  skipSchemaValidation?: boolean;
 }
 
-declare type RequireProps<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>
+declare type RequireProps<T, K extends keyof T> = Omit<T, K> &
+  Required<Pick<T, K>>;
 
-declare const resolvedConfigSchema: z_2.ZodArray<
-  z_2.ZodObject<
+declare const resolvedConfigSchema: z.ZodArray<
+  z.ZodObject<
     {
-      basePath: z_2.ZodString
-      name: z_2.ZodString
-      plugins: z_2.ZodOptional<z_2.ZodArray<z_2.ZodUnknown>>
-      title: z_2.ZodString
-      unstable_sources: z_2.ZodArray<
-        z_2.ZodObject<
+      basePath: z.ZodString;
+      name: z.ZodString;
+      plugins: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
+      title: z.ZodString;
+      unstable_sources: z.ZodArray<
+        z.ZodObject<
           {
-            dataset: z_2.ZodString
-            projectId: z_2.ZodString
-            schema: z_2.ZodObject<
+            dataset: z.ZodString;
+            projectId: z.ZodString;
+            schema: z.ZodObject<
               {
-                _original: z_2.ZodObject<
+                _original: z.ZodObject<
                   {
-                    name: z_2.ZodOptional<z_2.ZodString>
-                    types: z_2.ZodArray<z_2.ZodObject<{}, z_2.core.$loose>>
+                    name: z.ZodOptional<z.ZodString>;
+                    types: z.ZodArray<z.ZodObject<{}, z.core.$loose>>;
                   },
-                  z_2.core.$strip
-                >
+                  z.core.$strip
+                >;
               },
-              z_2.core.$strip
-            >
+              z.core.$strip
+            >;
           },
-          z_2.core.$strip
+          z.core.$strip
         >
-      >
-      dataset: z_2.ZodString
-      projectId: z_2.ZodString
-      schema: z_2.ZodObject<
+      >;
+      dataset: z.ZodString;
+      projectId: z.ZodString;
+      schema: z.ZodObject<
         {
-          _original: z_2.ZodObject<
+          _original: z.ZodObject<
             {
-              name: z_2.ZodOptional<z_2.ZodString>
-              types: z_2.ZodArray<z_2.ZodObject<{}, z_2.core.$loose>>
+              name: z.ZodOptional<z.ZodString>;
+              types: z.ZodArray<z.ZodObject<{}, z.core.$loose>>;
             },
-            z_2.core.$strip
-          >
+            z.core.$strip
+          >;
         },
-        z_2.core.$strip
-      >
+        z.core.$strip
+      >;
     },
-    z_2.core.$strip
+    z.core.$strip
   >
->
+>;
 
-declare type ResolvedStudioConfig = z_2.infer<typeof resolvedConfigSchema>
+declare type ResolvedStudioConfig = z.infer<typeof resolvedConfigSchema>;
 
 /**
  * Resolves and imports a package from the local project's node_modules,
@@ -970,7 +978,7 @@ declare type ResolvedStudioConfig = z_2.infer<typeof resolvedConfigSchema>
 export declare function resolveLocalPackage<T = unknown>(
   packageName: string,
   workDir: string,
-): Promise<T>
+): Promise<T>;
 
 /**
  * `structuredClone()`, but doesn't throw on non-clonable values - instead it drops them.
@@ -979,11 +987,13 @@ export declare function resolveLocalPackage<T = unknown>(
  * @returns The cloned object.
  * @internal
  */
-export declare function safeStructuredClone<T>(obj: T): T
+export declare function safeStructuredClone<T>(obj: T): T;
 
-export declare abstract class SanityCommand<T extends typeof Command> extends Command {
-  protected args: Args<T>
-  protected flags: Flags<T>
+export declare abstract class SanityCommand<
+  T extends typeof Command,
+> extends Command {
+  protected args: Args<T>;
+  protected flags: Flags<T>;
   /**
    * Get the global API client.
    *
@@ -992,7 +1002,9 @@ export declare abstract class SanityCommand<T extends typeof Command> extends Co
    *
    * @deprecated use `getGlobalCliClient` function directly instead.
    */
-  protected getGlobalApiClient: (args: GlobalCliClientOptions) => Promise<SanityClient>
+  protected getGlobalApiClient: (
+    args: GlobalCliClientOptions,
+  ) => Promise<SanityClient>;
   /**
    * Get the project API client.
    *
@@ -1001,7 +1013,9 @@ export declare abstract class SanityCommand<T extends typeof Command> extends Co
    *
    * @deprecated use `getProjectCliClient` function directly instead.
    */
-  protected getProjectApiClient: (args: ProjectCliClientOptions) => Promise<SanityClient>
+  protected getProjectApiClient: (
+    args: ProjectCliClientOptions,
+  ) => Promise<SanityClient>;
   /**
    * Helper for outputting to the console.
    *
@@ -1012,19 +1026,25 @@ export declare abstract class SanityCommand<T extends typeof Command> extends Co
    * this.output.error('Error')
    * ```
    */
-  protected output: Output
+  protected output: Output;
   /**
    * The telemetry store.
    *
    * @returns The telemetry store.
    */
-  protected telemetry: CLITelemetryStore
+  protected telemetry: CLITelemetryStore;
+  /**
+   * Report real command errors to the CLI command trace.
+   * User aborts (SIGINT, ExitPromptError) are not reported — the trace is left
+   * incomplete, which accurately represents that the command was interrupted.
+   */
+  protected catch(err: CommandError): Promise<void>;
   /**
    * Get the CLI config.
    *
    * @returns The CLI config.
    */
-  protected getCliConfig(): Promise<CliConfig>
+  protected getCliConfig(): Promise<CliConfig>;
   /**
    * Get the project ID from passed flags or (if not provided) the CLI config.
    *
@@ -1042,16 +1062,16 @@ export declare abstract class SanityCommand<T extends typeof Command> extends Co
    * @returns The project ID.
    */
   protected getProjectId(options?: {
-    deprecatedFlagName?: string
-    fallback?: () => Promise<string>
-  }): Promise<string>
+    deprecatedFlagName?: string;
+    fallback?: () => Promise<string>;
+  }): Promise<string>;
   /**
    * Get the project's root directory by resolving the config
    *
    * @returns The project root result.
    */
-  protected getProjectRoot(): Promise<ProjectRootResult>
-  init(): Promise<void>
+  protected getProjectRoot(): Promise<ProjectRootResult>;
+  init(): Promise<void>;
   /**
    * Check if the command is running in unattended mode.
    *
@@ -1063,13 +1083,13 @@ export declare abstract class SanityCommand<T extends typeof Command> extends Co
    * some commands may also be run in unattended mode if `process.stdin` is not a TTY
    * (eg when running in a CI environment).
    */
-  protected isUnattended(): boolean
+  protected isUnattended(): boolean;
   /**
    * Resolver for checking if the terminal is interactive. Override in tests to provide mock values.
    *
    * @returns Whether the terminal is interactive.
    */
-  protected resolveIsInteractive(): boolean
+  protected resolveIsInteractive(): boolean;
   /**
    * Get the CLI config, returning an empty config if no project root is found.
    *
@@ -1078,23 +1098,28 @@ export declare abstract class SanityCommand<T extends typeof Command> extends Co
    *
    * @returns The CLI config, or an empty config object if no project root is found.
    */
-  protected tryGetCliConfig(): Promise<CliConfig>
+  protected tryGetCliConfig(): Promise<CliConfig>;
 }
 
 export declare type SanityOrgUser = {
-  email: string
-  id: string
-  name: string
-  profileImage?: string
-  provider: 'github' | 'google' | 'sanity' | `saml-${string}`
-  tosAcceptedAt?: string
-}
+  email: string;
+  id: string;
+  name: string;
+  profileImage?: string;
+  provider: "github" | "google" | "sanity" | `saml-${string}`;
+  tosAcceptedAt?: string;
+};
 
 /**
- * Sets the global CLI telemetry store.
+ * Sets the global CLI telemetry state.
  * @internal
  */
-export declare function setCliTelemetry(telemetry: CLITelemetryStore): void
+export declare function setCliTelemetry(
+  telemetry: CLITelemetryStore,
+  options?: {
+    reportTraceError?: TraceErrorReporter;
+  },
+): void;
 
 /**
  * Set the config value for the given property.
@@ -1107,7 +1132,7 @@ export declare function setCliTelemetry(telemetry: CLITelemetryStore): void
 export declare function setCliUserConfig<P extends keyof CliUserConfig>(
   prop: P,
   value: CliUserConfig[P],
-): Promise<void>
+): Promise<void>;
 
 /**
  * Executes a worker file in a Sanity Studio browser context.
@@ -1140,17 +1165,20 @@ export declare function setCliUserConfig<P extends keyof CliUserConfig>(
 export declare function studioWorkerTask<T = unknown>(
   filePath: URL,
   options: StudioWorkerTaskOptions,
-): Promise<T>
+): Promise<T>;
 
 /**
  * Options for the studio worker task
  *
  * @internal
  */
-declare interface StudioWorkerTaskOptions extends RequireProps<WorkerOptions_2, 'name'> {
-  studioRootPath: string
+declare interface StudioWorkerTaskOptions extends RequireProps<
+  WorkerOptions_2,
+  "name"
+> {
+  studioRootPath: string;
   /** Optional timeout in milliseconds. If the worker does not respond within this time, it will be terminated and the promise rejected. */
-  timeout?: number
+  timeout?: number;
 }
 
 /**
@@ -1160,7 +1188,7 @@ declare interface StudioWorkerTaskOptions extends RequireProps<WorkerOptions_2,
  * @param namespace - The namespace to extend the CLI debug instance with
  * @returns The extended `debug` instance
  */
-export declare const subdebug: (namespace: string) => debugIt.Debugger
+export declare const subdebug: (namespace: string) => debugIt.Debugger;
 
 /**
  * Base information needed for telemetry file operations.
@@ -1168,34 +1196,36 @@ export declare const subdebug: (namespace: string) => debugIt.Debugger
  */
 declare interface TelemetryBaseInfo {
   /** Base filename pattern without sessionId suffix */
-  basePattern: string
+  basePattern: string;
   /** Base directory where telemetry files are stored */
-  directory: string
+  directory: string;
   /** Environment: 'staging' or 'production' */
-  environment: string
+  environment: string;
   /** Hashed token (first 8 chars of SHA256) for privacy */
-  hashedToken: string
+  hashedToken: string;
 }
 
 /**
  * @public
  */
 export declare interface TelemetryUserProperties {
-  cliVersion: string
-  cpuArchitecture: string
-  machinePlatform: string
-  runtime: string
-  runtimeVersion: string
-  dataset?: string
-  projectId?: string
+  cliVersion: string;
+  cpuArchitecture: string;
+  machinePlatform: string;
+  runtime: string;
+  runtimeVersion: string;
+  dataset?: string;
+  projectId?: string;
 }
 
 declare interface TimeMeasurer {
-  end: (name: string) => number
-  getTimings: () => Record<string, number>
-  start: (name: string) => void
+  end: (name: string) => number;
+  getTimings: () => Record<string, number>;
+  start: (name: string) => void;
 }
 
+declare type TraceErrorReporter = (error: Error) => void;
+
 /**
  * Tries to find the studio config path, returning `undefined` if not found.
  *
@@ -1204,7 +1234,9 @@ declare interface TimeMeasurer {
  * @throws On errors other than config not found
  * @internal
  */
-export declare function tryFindStudioConfigPath(basePath: string): Promise<string | undefined>
+export declare function tryFindStudioConfigPath(
+  basePath: string,
+): Promise<string | undefined>;
 
 /**
  * Executes a worker file with tsx registered. This means you can import other
@@ -1224,24 +1256,36 @@ export declare function tryFindStudioConfigPath(basePath: string): Promise<strin
 export declare function tsxWorkerTask<T = unknown>(
   filePath: URL_2,
   options: TsxWorkerTaskOptions,
-): Promise<T>
+): Promise<T>;
 
 /**
  * Options for the tsx worker task
  *
  * @internal
  */
-declare interface TsxWorkerTaskOptions extends RequireProps<WorkerOptions_2, 'name'> {
-  rootPath: string
+declare interface TsxWorkerTaskOptions extends RequireProps<
+  WorkerOptions_2,
+  "name"
+> {
+  rootPath: string;
 }
 
-declare type TypeGenConfig = z.infer<typeof configDefinition>
+declare interface TypeGenConfig {
+  formatGeneratedCode: boolean;
+  generates: string;
+  overloadClientMethods: boolean;
+  path: string | string[];
+  schema: string;
+}
 
 /**
  * @public
  */
 export declare type UserViteConfig =
-  | ((config: InlineConfig, env: ConfigEnv) => InlineConfig | Promise<InlineConfig>)
-  | InlineConfig
+  | ((
+      config: InlineConfig,
+      env: ConfigEnv,
+    ) => InlineConfig | Promise<InlineConfig>)
+  | InlineConfig;
 
-export {}
+export {};