@sanity/cli 6.0.0-alpha.8 → 6.0.0-alpha.9

package/dist/actions/docs/normalizeDocsPath.d.ts

@@ -1,8 +0,0 @@
-/**
- * Normalizes input to a path, handling both paths and full Sanity docs URLs
- * @param input - Either a path like "/docs/studio" or full URL like "https://www.sanity.io/docs/studio"
- * @returns Normalized path starting with "/"
- *
- * @internal
- */
-export declare function normalizeDocsPath(input: string): string;

package/dist/actions/documents/constants.d.ts

@@ -1 +0,0 @@
-export declare const DOCUMENTS_API_VERSION = "2025-08-15";

package/dist/actions/documents/editor.d.ts

@@ -1,11 +0,0 @@
-/**
- * Gets the configured editor for the current platform
- */
-export declare function getEditor(): {
-    args: string[];
-    bin: string;
-};
-/**
- * Registers a cleanup handler for SIGINT that removes the temporary file
- */
-export declare function registerUnlinkOnSigInt(tmpFile: string): void;

package/dist/actions/documents/types.d.ts

@@ -1,2 +0,0 @@
-import { type ValidationMarker } from '@sanity/types';
-export type Level = ValidationMarker['level'];

package/dist/actions/documents/validate.d.ts

@@ -1,26 +0,0 @@
-import { type ValidationMarker } from '@sanity/types';
-import { type ValidationWorkerChannel } from '../../threads/validateDocuments.js';
-import { type WorkerChannelReceiver } from '../../util/workerChannels.js';
-import { Level } from './types.js';
-interface ValidateDocumentsOptions<TReturn = unknown> {
-    dataset?: string;
-    level?: Level;
-    maxCustomValidationConcurrency?: number;
-    maxFetchConcurrency?: number;
-    ndjsonFilePath?: string;
-    projectId?: string;
-    reporter?: (worker: WorkerChannelReceiver<ValidationWorkerChannel>) => TReturn;
-    studioHost?: string;
-    workDir?: string;
-    workspace?: string;
-}
-interface DocumentValidationResult {
-    documentId: string;
-    documentType: string;
-    level: ValidationMarker['level'];
-    markers: ValidationMarker[];
-    revision: string;
-}
-export declare function validateDocuments<TReturn>(options: Required<Pick<ValidateDocumentsOptions<TReturn>, 'reporter'>> & ValidateDocumentsOptions<TReturn>): Promise<TReturn>;
-export declare function validateDocuments(options: ValidateDocumentsOptions): Promise<AsyncIterable<DocumentValidationResult>>;
-export {};

package/dist/actions/documents/validation/reporters/index.d.ts

@@ -1,5 +0,0 @@
-export declare const reporters: {
-    json: import("../../../../commands/documents/validate.js").BuiltInValidationReporter;
-    ndjson: import("../../../../commands/documents/validate.js").BuiltInValidationReporter;
-    pretty: import("../../../../commands/documents/validate.js").BuiltInValidationReporter;
-};

package/dist/actions/documents/validation/reporters/jsonReporter.d.ts

@@ -1,2 +0,0 @@
-import { type BuiltInValidationReporter } from '../../../../commands/documents/validate.js';
-export declare const json: BuiltInValidationReporter;

package/dist/actions/documents/validation/reporters/ndjsonReporter.d.ts

@@ -1,2 +0,0 @@
-import { type BuiltInValidationReporter } from '../../../../commands/documents/validate.js';
-export declare const ndjson: BuiltInValidationReporter;

package/dist/actions/documents/validation/reporters/prettyReporter/formatDocumentValidation.d.ts

@@ -1,10 +0,0 @@
-import { type DocumentValidationResult } from './util.js';
-interface FormatDocumentValidationOptions extends DocumentValidationResult {
-    basePath?: string;
-    studioHost?: string;
-}
-/**
- * Formats document validation results into a user-friendly tree structure
- */
-export declare function formatDocumentValidation({ documentId, documentType, intentUrl, level, markers, }: FormatDocumentValidationOptions): string;
-export {};

package/dist/actions/documents/validation/reporters/prettyReporter/index.d.ts

@@ -1 +0,0 @@
-export { pretty } from './prettyReporter.js';

package/dist/actions/documents/validation/reporters/prettyReporter/prettyReporter.d.ts

@@ -1,5 +0,0 @@
-import { type BuiltInValidationReporter } from '../../../../../commands/documents/validate.js';
-/**
- * Represents the default stylish/pretty reporter
- */
-export declare const pretty: BuiltInValidationReporter;

package/dist/actions/documents/validation/reporters/prettyReporter/util.d.ts

@@ -1,53 +0,0 @@
-import { type ValidationMarker } from '@sanity/types';
-import { Level } from '../../../types';
-export interface DocumentValidationResult {
-    documentId: string;
-    documentType: string;
-    level: Level;
-    markers: ValidationMarker[];
-    revision: string;
-    intentUrl?: string;
-}
-export declare const isTty: boolean;
-export declare const levelValues: {
-    readonly error: 0;
-    readonly info: 2;
-    readonly warning: 1;
-};
-/**
- * Generates a formatted string that includes a numerical amount and a subject
- * in plural or singular form. Note: the subject must end in `s`
- */
-export declare const count: (amount: number, subject: string) => string;
-/**
- * Given a decimal, this will return that number formatted as a percentage
- */
-export declare const percent: (value: number) => string;
-/**
- * Given a start time in milliseconds, this will output the time elapsed
- * formatted in seconds
- */
-export declare const seconds: (startTime: number) => string;
-interface ValidationTotals {
-    errors: {
-        documents: number;
-        markers: number;
-    };
-    infos: {
-        documents: number;
-        markers: number;
-    };
-    valid: {
-        documents: number;
-    };
-    warnings: {
-        documents: number;
-        markers: number;
-    };
-}
-/**
- * Outputs summary text given an object of totals. Omits totals depending on the
- * desired validation `level`
- */
-export declare const summary: ({ errors, infos, valid, warnings }: ValidationTotals, level?: Level) => string;
-export {};

package/dist/actions/exec/execScript.d.ts

@@ -1,11 +0,0 @@
-interface ExecScriptOptions {
-    extraArguments: string[];
-    flags: {
-        'mock-browser-env': boolean;
-        'with-user-token': boolean;
-    };
-    scriptPath: string;
-    workDir: string;
-}
-export declare function execScript(options: ExecScriptOptions): Promise<void>;
-export {};

package/dist/actions/graphql/getGraphQLAPIs.d.ts

@@ -1,2 +0,0 @@
-import { type ResolvedGraphQLAPI } from './types.js';
-export declare function getGraphQLAPIs(workDir: string): Promise<ResolvedGraphQLAPI[]>;

package/dist/actions/graphql/getGraphQLAPIs.worker.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/actions/graphql/types.d.ts

@@ -1,68 +0,0 @@
-import { type Schema } from '@sanity/types';
-export interface GraphQLAPIConfig {
-    /**
-     * Dataset name for this API
-     */
-    dataset?: string;
-    /**
-     * Generation of API to deploy
-     *
-     * Optional, defaults to `gen3` (which is the only option, currently)
-     */
-    generation?: 'gen1' | 'gen2' | 'gen3';
-    /**
-     * ID of GraphQL API. Only (currently) required when using the `--api` flag
-     * for `sanity graphql deploy`, in order to only deploy a specific API.
-     */
-    id?: string;
-    /**
-     * Whether or not to enable the GraphQL v2021-10-21 query semantics
-     */
-    nonNullDocumentFields?: boolean;
-    /**
-     * Whether or not to enable the GraphQL Playground for this API
-     *
-     * Optional, defaults to `true` in development mode,  `false` otherwise
-     */
-    playground?: boolean;
-    /**
-     * Project ID for this API
-     */
-    projectId?: string;
-    /**
-     * Name of source containing the schema to deploy, within the configured workspace
-     *
-     * Optional, defaults to `default` (eg the one used if no `name` is defined)
-     */
-    source?: string;
-    /**
-     * API tag for this API - allows deploying multiple different APIs to a single dataset
-     *
-     * Optional, defaults to `default`
-     */
-    tag?: string;
-    /**
-     * Name of workspace containing the schema to deploy
-     *
-     * Optional, defaults to `default` (eg the one used if no `name` is defined)
-     */
-    workspace?: string;
-}
-export interface SchemaDefinitionish {
-    name: string;
-    type: string;
-    fields?: SchemaDefinitionish[];
-}
-interface ResolvedSerializableProperties {
-    dataset: string;
-    projectId: string;
-    schemaTypes: SchemaDefinitionish[];
-}
-export interface ResolvedSourceProperties {
-    dataset: string;
-    projectId: string;
-    schema: Schema;
-}
-export type TypeResolvedGraphQLAPI = Omit<GraphQLAPIConfig, 'source' | 'workspace'> & ResolvedSerializableProperties;
-export type ResolvedGraphQLAPI = Omit<GraphQLAPIConfig, 'source' | 'workspace'> & ResolvedSourceProperties;
-export {};

package/dist/actions/hook/constants.d.ts

@@ -1 +0,0 @@
-export declare const HOOK_API_VERSION = "v2025-08-04";

package/dist/actions/hook/formatFailure.d.ts

@@ -1,4 +0,0 @@
-import { type DeliveryAttempt } from './types.js';
-export declare function formatFailure(attempt: DeliveryAttempt, options?: {
-    includeHelp?: boolean;
-}): string;

package/dist/actions/hook/types.d.ts

@@ -1,78 +0,0 @@
-export type Hook = GroqHook | LegacyHook;
-export type HookMessage = GroqHookMessage | LegacyHookMessage;
-interface GroqHookMessage {
-    createdAt: string;
-    dataset: string;
-    failureCount: number;
-    id: string;
-    payload: string;
-    projectId: string;
-    resultCode: number | null;
-    status: 'failure' | 'queued' | 'sending' | 'success';
-}
-interface LegacyHookMessage {
-    createdAt: string;
-    dataset: string;
-    deletedAt: string | null;
-    failureCount: number;
-    hookId: string;
-    id: string;
-    payload: string;
-    projectId: string;
-    resultCode: number | null;
-    status: 'failure' | 'queued' | 'sending' | 'success';
-    updatedAt: string | null;
-}
-interface GroqHook {
-    apiVersion: string;
-    createdAt: string;
-    createdByUserId: string;
-    dataset: string;
-    deletedAt: string | null;
-    description: string | null;
-    headers: Record<string, string | undefined>;
-    httpMethod: string;
-    id: string;
-    includeDrafts: boolean;
-    isDisabled: boolean;
-    isDisabledByUser: boolean;
-    name: string;
-    projectId: string;
-    rule: {
-        filter: string | null;
-        on: ('create' | 'delete' | 'update')[];
-        projection: string | null;
-    };
-    secret: string | null;
-    type: 'document';
-    url: string;
-}
-interface LegacyHook {
-    createdAt: string;
-    createdByUserId: string;
-    dataset: string;
-    deletedAt: string | null;
-    description: string | null;
-    id: string;
-    isDisabled: boolean;
-    isDisabledByUser: boolean;
-    name: string;
-    projectId: string;
-    type: 'transaction';
-    url: string;
-}
-export interface DeliveryAttempt {
-    createdAt: string;
-    duration: number | null;
-    failureReason: string;
-    hookId: string;
-    id: string;
-    inProgress: boolean;
-    isFailure: boolean;
-    messageId: string;
-    projectId: string;
-    resultBody: string;
-    resultCode: number;
-    updatedAt: string | null;
-}
-export {};

package/dist/actions/init/bootstrapLocalTemplate.d.ts

@@ -1,13 +0,0 @@
-import { Output } from '@sanity/cli-core';
-import { type GenerateConfigOptions } from './createStudioConfig.js';
-import { type ProjectTemplate } from './types.js';
-export interface BootstrapLocalOptions {
-    output: Output;
-    outputPath: string;
-    packageName: string;
-    templateName: string;
-    useTypeScript: boolean;
-    variables: GenerateConfigOptions['variables'];
-    overwriteFiles?: boolean;
-}
-export declare function bootstrapLocalTemplate(opts: BootstrapLocalOptions): Promise<ProjectTemplate>;

package/dist/actions/init/bootstrapRemoteTemplate.d.ts

@@ -1,12 +0,0 @@
-import { Output } from '@sanity/cli-core';
-import { type GenerateConfigOptions } from './createStudioConfig.js';
-import { type RepoInfo } from './remoteTemplate.js';
-export interface BootstrapRemoteOptions {
-    output: Output;
-    outputPath: string;
-    packageName: string;
-    repoInfo: RepoInfo;
-    variables: GenerateConfigOptions['variables'];
-    bearerToken?: string;
-}
-export declare function bootstrapRemoteTemplate(opts: BootstrapRemoteOptions): Promise<void>;

package/dist/actions/init/bootstrapTemplate.d.ts

@@ -1,18 +0,0 @@
-import { Output } from '@sanity/cli-core';
-import { type RepoInfo } from './remoteTemplate.js';
-export interface BootstrapTemplateOptions {
-    autoUpdates: boolean;
-    bearerToken: string | undefined;
-    dataset: string;
-    organizationId: string | undefined;
-    output: Output;
-    outputPath: string;
-    overwriteFiles: boolean;
-    packageName: string;
-    projectId: string;
-    projectName: string;
-    remoteTemplateInfo: RepoInfo | undefined;
-    templateName: string;
-    useTypeScript: boolean;
-}
-export declare function bootstrapTemplate({ autoUpdates, bearerToken, dataset, organizationId, output, outputPath, overwriteFiles, packageName, projectId, projectName, remoteTemplateInfo, templateName, useTypeScript, }: BootstrapTemplateOptions): Promise<void | import("./types.js").ProjectTemplate>;

package/dist/actions/init/checkNextJsReactCompatibility.d.ts

@@ -1,9 +0,0 @@
-import { Output } from '@sanity/cli-core';
-import { VersionedFramework } from './types.js';
-interface CheckCompatibilityOptions {
-    detectedFramework: VersionedFramework;
-    output: Output;
-    outputPath: string;
-}
-export declare function checkNextJsReactCompatibility({ detectedFramework, output, outputPath, }: CheckCompatibilityOptions): Promise<void>;
-export {};

package/dist/actions/init/constants.d.ts

@@ -1 +0,0 @@
-export declare const INIT_API_VERSION = "v2025-06-01";

package/dist/actions/init/countNestedFolders.d.ts

@@ -1 +0,0 @@
-export declare function countNestedFolders(path: string): number;

package/dist/actions/init/createAppCliConfig.d.ts

@@ -1,5 +0,0 @@
-export interface GenerateCliConfigOptions {
-    entry: string;
-    organizationId?: string;
-}
-export declare function createAppCliConfig(options: GenerateCliConfigOptions): string;

package/dist/actions/init/createCliConfig.d.ts

@@ -1,6 +0,0 @@
-export interface GenerateCliConfigOptions {
-    autoUpdates: boolean;
-    dataset: string;
-    projectId: string;
-}
-export declare function createCliConfig(options: GenerateCliConfigOptions): string;

package/dist/actions/init/createPackageManifest.d.ts

@@ -1,6 +0,0 @@
-import { type PackageJson } from '../../types.js';
-export declare function createPackageManifest(data: Omit<PackageJson, 'version'> & {
-    gitRemote?: string;
-} & {
-    isAppTemplate?: boolean;
-}): string;

package/dist/actions/init/createStudioConfig.d.ts

@@ -1,13 +0,0 @@
-export interface GenerateConfigOptions {
-    variables: {
-        autoUpdates: boolean;
-        dataset: string;
-        organizationId?: string;
-        projectId: string;
-        projectName?: string;
-        sourceName?: string;
-        sourceTitle?: string;
-    };
-    template?: ((variables: GenerateConfigOptions['variables']) => string) | string;
-}
-export declare function createStudioConfig(options: GenerateConfigOptions): string;

package/dist/actions/init/determineAppTemplate.d.ts

@@ -1,9 +0,0 @@
-/**
- * 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 declare function determineAppTemplate(templateName: string): boolean;

package/dist/actions/init/env/createOrAppendEnvVars.d.ts

@@ -1,12 +0,0 @@
-import { Output } from '@sanity/cli-core';
-import { VersionedFramework } from '../types.js';
-interface CreateOrAppendEnvVarsOptions {
-    envVars: Record<string, string>;
-    filename: string;
-    framework: VersionedFramework | null;
-    log: boolean;
-    output: Output;
-    outputPath: string;
-}
-export declare function createOrAppendEnvVars({ envVars, filename, framework, log, output, outputPath, }: CreateOrAppendEnvVarsOptions): Promise<void>;
-export {};

package/dist/actions/init/env/parseAndUpdateEnvVars.d.ts

@@ -1,9 +0,0 @@
-import { Output } from '@sanity/cli-core';
-interface ParseAndUpdateEnvVarsOptions {
-    envVars: Record<string, string>;
-    fileContents: string;
-    log: boolean;
-    output: Output;
-}
-export declare function parseAndUpdateEnvVars({ envVars, fileContents, log, output, }: ParseAndUpdateEnvVarsOptions): string;
-export {};

package/dist/actions/init/env/writeEnvVarsToFile.d.ts

@@ -1,12 +0,0 @@
-import { Output } from '@sanity/cli-core';
-import { VersionedFramework } from '../types.js';
-interface WriteEnvVarsToFileOptions {
-    envVars: Record<string, string>;
-    filename: string;
-    framework: VersionedFramework | null;
-    log: boolean;
-    output: Output;
-    outputPath: string;
-}
-export declare function writeEnvVarsToFile({ envVars, filename, framework, log, output, outputPath, }: WriteEnvVarsToFileOptions): Promise<void>;
-export {};

package/dist/actions/init/fetchPostInitPrompt.d.ts

@@ -1,6 +0,0 @@
-/**
- * Fetches the post-init MCP prompt from the Journey API and interpolates editor names.
- * Falls back to a hardcoded default if the API call fails, times out, or returns empty.
- * Text wrapped in **markers** will be formatted with cyan color.
- */
-export declare function fetchPostInitPrompt(editorNames: string): Promise<string>;

package/dist/actions/init/git.d.ts

@@ -1 +0,0 @@
-export declare function tryGitInit(rootDir: string, commitMessage?: string): boolean;

package/dist/actions/init/processTemplate.d.ts

@@ -1,7 +0,0 @@
-interface TemplateOptions<T> {
-    template: string;
-    variables: T;
-    includeBooleanTransform?: boolean;
-}
-export declare function processTemplate<T extends object>(options: TemplateOptions<T>): string;
-export {};

package/dist/actions/init/remoteTemplate.d.ts

@@ -1,20 +0,0 @@
-type EnvData = {
-    dataset: string;
-    projectId: string;
-    readToken?: string;
-    writeToken?: string;
-};
-export type RepoInfo = {
-    branch: string;
-    filePath: string;
-    name: string;
-    username: string;
-};
-export declare function getGitHubRawContentUrl(repoInfo: RepoInfo): string;
-export declare function checkIsRemoteTemplate(templateName?: string): boolean;
-export declare function getGitHubRepoInfo(value: string, bearerToken?: string): Promise<RepoInfo>;
-export declare function downloadAndExtractRepo(root: string, { branch, filePath, name, username }: RepoInfo, bearerToken?: string): Promise<void>;
-export declare function checkIfNeedsApiToken(root: string, type: 'read' | 'write'): Promise<boolean>;
-export declare function applyEnvVariables(root: string, envData: EnvData, targetName?: string): Promise<void>;
-export declare function tryApplyPackageName(root: string, name: string): Promise<void>;
-export {};

package/dist/actions/init/resolvePackageManager.d.ts

@@ -1,10 +0,0 @@
-import { Output } from '@sanity/cli-core';
-import { PackageManager } from '../../util/packageManager/packageManagerChoice.js';
-interface ResolvePackageManagerOptions {
-    interactive: boolean;
-    output: Output;
-    packageManager: PackageManager;
-    targetDir: string;
-}
-export declare function resolvePackageManager({ interactive, output, packageManager, targetDir, }: ResolvePackageManagerOptions): Promise<PackageManager>;
-export {};

package/dist/actions/init/setupMCP.d.ts

@@ -1,21 +0,0 @@
-import { Output } from '@sanity/cli-core';
-export type EditorName = 'Claude Code' | 'Cursor' | 'VS Code';
-export interface Editor {
-    configKey: 'mcpServers' | 'servers';
-    configPath: string;
-    name: EditorName;
-}
-export interface MCPSetupResult {
-    configuredEditors: EditorName[];
-    detectedEditors: EditorName[];
-    skipped: boolean;
-    error?: Error;
-}
-/**
- * Main MCP setup orchestration
- * Opt-out by default: runs automatically unless skipMcp flag is set
- */
-export declare function setupMCP(options: {
-    mcp?: boolean;
-    output: Output;
-}): Promise<MCPSetupResult>;