Agentic UI: Add Anthropic API key form to AI settings

apps/cli/ai/providers.ts

@@ -1,24 +1,27 @@
 import { password } from '@inquirer/prompts';
+import { validateAnthropicApiKey } from '@studio/common/ai/anthropic-key';
+import { DEFAULT_MODEL, type AiModelId } from '@studio/common/ai/models';
 import {
-	AI_MODELS,
-	DEFAULT_MODEL,
-	type AiModelFamily,
-	type AiModelId,
-} from '@studio/common/ai/models';
+	AI_PROVIDER_IDS,
+	DEFAULT_AI_PROVIDER,
+	getAiProviderModels,
+	type AiProviderId,
+} from '@studio/common/ai/providers';
 import { readAuthToken } from '@studio/common/lib/shared-config';
 import { __ } from '@wordpress/i18n';
 import { readCliConfig, updateCliConfigWithPartial } from 'cli/lib/cli-config/core';
 import { LoggerError } from 'cli/logger';
 
-export const AI_PROVIDERS = {
+export const AI_PROVIDERS: Record< AiProviderId, string > = {
 	wpcom: 'WordPress.com',
 	'anthropic-api-key': 'Anthropic · API key',
-} as const;
-
-export type AiProviderId = keyof typeof AI_PROVIDERS;
+};
 
-export const DEFAULT_AI_PROVIDER: AiProviderId = 'wpcom';
-export const AI_PROVIDER_PRIORITY: AiProviderId[] = [ 'wpcom', 'anthropic-api-key' ];
+export type { AiProviderId };
+export { DEFAULT_AI_PROVIDER };
+// Fallback order when the configured provider is unavailable; declaration
+// order of the canonical id list.
+export const AI_PROVIDER_PRIORITY: readonly AiProviderId[] = AI_PROVIDER_IDS;
 
 const DEFAULT_WPCOM_AI_GATEWAY_BASE_URL = 'https://public-api.wordpress.com/wpcom/v2/ai-api-proxy';
 // The wpcom AI proxy maps feature slugs to upstream providers. Historically
@@ -35,14 +38,9 @@ export interface ResolveAiEnvironmentOptions {
 export interface AiProviderDefinition {
 	id: AiProviderId;
 	autoFallbackWhenUnavailable: boolean;
-	/**
-	 * Which model families this provider can service. `wpcom` relays both
-	 * Anthropic and OpenAI wire formats through the same proxy; direct-API
-	 * providers are restricted to their own family. `availableModels` and
-	 * `defaultModel` are derived from this and kept on the definition so
-	 * callers don't have to filter AI_MODELS themselves.
-	 */
-	readonly supportedModelFamilies: readonly AiModelFamily[];
+	// Derived from the provider's model families (see
+	// `@studio/common/ai/providers`), kept on the definition so callers don't
+	// have to filter AI_MODELS themselves.
 	readonly availableModels: readonly AiModelId[];
 	readonly defaultModel: AiModelId;
 	supportsModel( model: AiModelId ): boolean;
@@ -52,17 +50,12 @@ export interface AiProviderDefinition {
 	resolveEnv: ( options?: ResolveAiEnvironmentOptions ) => Promise< Record< string, string > >;
 }
 
-/**
- * Fills in `availableModels`, `defaultModel`, and `supportsModel` from the
- * declared `supportedModelFamilies` so each provider literal below only has to
- * state its family allowlist.
- */
+// Fills in `availableModels`, `defaultModel`, and `supportsModel` from the
+// provider id's model families.
 function defineProvider(
 	partial: Omit< AiProviderDefinition, 'availableModels' | 'defaultModel' | 'supportsModel' >
 ): AiProviderDefinition {
-	const availableModels: AiModelId[] = AI_MODELS.filter( ( model ) =>
-		partial.supportedModelFamilies.includes( model.family )
-	).map( ( model ) => model.id );
+	const availableModels = getAiProviderModels( partial.id ).map( ( model ) => model.id );
 	return {
 		...partial,
 		availableModels,
@@ -78,22 +71,30 @@ async function resolveAnthropicApiKey( options?: {
 } ): Promise< string | undefined > {
 	const { anthropicApiKey: savedKey } = await readCliConfig();
 	if ( savedKey && ! options?.force ) {
-		return savedKey;
+		// Re-prompt only when Anthropic definitively rejects the saved key;
+		// an unreachable API must not lock the user out of their provider.
+		const validation = await validateAnthropicApiKey( savedKey );
+		if ( validation.status !== 'invalid' ) {
+			return savedKey;
+		}
 	}
 
 	const apiKey = await password( {
 		message: __( 'Enter your Anthropic API key (will be saved for future use):' ),
 		mask: '*',
-		validate: ( value ) => {
-			if ( ! value.trim() ) {
+		validate: async ( value ) => {
+			const trimmed = value.trim();
+			if ( ! trimmed ) {
 				return __( 'API key is required' );
 			}
-			return true;
+			const validation = await validateAnthropicApiKey( trimmed );
+			return validation.status === 'invalid' ? validation.message : true;
 		},
 	} );
 
-	await updateCliConfigWithPartial( { anthropicApiKey: apiKey } );
-	return apiKey;
+	const trimmedKey = apiKey.trim();
+	await updateCliConfigWithPartial( { anthropicApiKey: trimmedKey } );
+	return trimmedKey;
 }
 
 function getStudioUserAgent(): string {
@@ -143,7 +144,6 @@ const AI_PROVIDER_DEFINITIONS: Record< AiProviderId, AiProviderDefinition > = {
 	wpcom: defineProvider( {
 		id: 'wpcom',
 		autoFallbackWhenUnavailable: true,
-		supportedModelFamilies: [ 'anthropic', 'openai' ],
 		isVisible: async () => true,
 		isReady: async () => hasInlineWpcomAuth() || ( await hasValidWpcomAuth() ),
 		prepare: async () => {
@@ -196,7 +196,6 @@ const AI_PROVIDER_DEFINITIONS: Record< AiProviderId, AiProviderDefinition > = {
 	'anthropic-api-key': defineProvider( {
 		id: 'anthropic-api-key',
 		autoFallbackWhenUnavailable: false,
-		supportedModelFamilies: [ 'anthropic' ],
 		isVisible: async () => true,
 		isReady: async () => {
 			const { anthropicApiKey } = await readCliConfig();

apps/cli/ai/sessions/context.ts

@@ -1,11 +1,8 @@
 import { resolveSessionModel, type AiModelId } from '@studio/common/ai/models';
+import { isAiProviderId } from '@studio/common/ai/providers';
 import { isStudioCustomEntryOfType } from '@studio/common/ai/sessions/entry-types';
-import { AI_PROVIDERS, type AiProviderId } from 'cli/ai/providers';
 import type { LoadedAiSession } from '@studio/common/ai/sessions/types';
-
-function isAiProviderId( value: string ): value is AiProviderId {
-	return Object.prototype.hasOwnProperty.call( AI_PROVIDERS, value );
-}
+import type { AiProviderId } from 'cli/ai/providers';
 
 export interface ResumeSessionContext {
 	sessionId?: string;

apps/cli/lib/cli-config/core.ts

@@ -1,17 +1,17 @@
 import fs from 'fs';
-import path from 'path';
+import { AI_PROVIDER_IDS } from '@studio/common/ai/providers';
 import {
-	CLI_CONFIG_LOCKFILE_NAME,
-	LOCKFILE_STALE_TIME,
-	LOCKFILE_WAIT_TIME,
-} from '@studio/common/constants';
+	CLI_CONFIG_VERSION,
+	ensureCliConfigDirectory,
+	lockCliConfigFile,
+	readCliConfigFileRaw,
+	unlockCliConfigFile,
+	writeCliConfigFileRaw,
+} from '@studio/common/lib/cli-config-file';
 import { siteDetailsSchema } from '@studio/common/lib/cli-events';
-import { hideDirectoryOnWindows } from '@studio/common/lib/hide-dir-windows';
-import { lockFileAsync, unlockFileAsync } from '@studio/common/lib/lockfile';
-import { getCliConfigPath, getConfigDirectory } from '@studio/common/lib/well-known-paths';
+import { getCliConfigPath } from '@studio/common/lib/well-known-paths';
 import { snapshotSchema } from '@studio/common/types/snapshot';
 import { __ } from '@wordpress/i18n';
-import { readFile, writeFile } from 'atomically';
 import { z } from 'zod';
 import { StatsMetric } from 'cli/lib/types/bump-stats';
 import { LoggerError } from 'cli/logger';
@@ -59,12 +59,12 @@ const siteSchema = siteDetailsSchema
 	.loose();
 
 // Schema updates must maintain backwards compatibility. If a breaking change is needed,
-// increment CLI_CONFIG_VERSION and add a data migration function.
-const CLI_CONFIG_VERSION = 1;
+// increment CLI_CONFIG_VERSION (in @studio/common/lib/cli-config-file) and add a data migration
+// function.
 
 // IMPORTANT: Always consider that independently installed versions of the CLI (from npm) may also
 // read this file, and any updates to this schema may require updating the `version` field.
-export const aiProviderSchema = z.enum( [ 'wpcom', 'anthropic-api-key' ] );
+export const aiProviderSchema = z.enum( AI_PROVIDER_IDS );
 
 export const updateCheckSchema = z.object( {
 	lastChecked: z.number(),
@@ -102,16 +102,13 @@ const DEFAULT_CLI_CONFIG: CliConfig = {
 };
 
 export async function readCliConfig(): Promise< CliConfig > {
-	const configPath = getCliConfigPath();
-
-	if ( ! fs.existsSync( configPath ) ) {
+	if ( ! fs.existsSync( getCliConfigPath() ) ) {
 		return structuredClone( DEFAULT_CLI_CONFIG );
 	}
 
 	let data: Record< string, unknown >;
 	try {
-		const fileContent = await readFile( configPath, { encoding: 'utf8' } );
-		data = JSON.parse( fileContent );
+		data = await readCliConfigFileRaw();
 	} catch ( error ) {
 		throw new LoggerError( __( 'Failed to read CLI config file.' ), error );
 	}
@@ -140,24 +137,11 @@ export async function readCliConfig(): Promise< CliConfig > {
 	}
 }
 
-async function ensureConfigDirectory(): Promise< void > {
-	const configDir = getConfigDirectory();
-	if ( ! fs.existsSync( configDir ) ) {
-		fs.mkdirSync( configDir, { recursive: true } );
-		await hideDirectoryOnWindows( configDir );
-	}
-}
-
 export async function saveCliConfig( config: CliConfig ): Promise< void > {
 	try {
 		config.version = CLI_CONFIG_VERSION;
-
-		await ensureConfigDirectory();
-
-		const configPath = getCliConfigPath();
-		const fileContent = JSON.stringify( config, null, 2 ) + '\n';
-
-		await writeFile( configPath, fileContent, { encoding: 'utf8' } );
+		await ensureCliConfigDirectory();
+		await writeCliConfigFileRaw( config );
 	} catch ( error ) {
 		if ( error instanceof LoggerError ) {
 			throw error;
@@ -166,19 +150,8 @@ export async function saveCliConfig( config: CliConfig ): Promise< void > {
 	}
 }
 
-const LOCKFILE_PATH = path.join( getConfigDirectory(), CLI_CONFIG_LOCKFILE_NAME );
-
-export async function lockCliConfig(): Promise< void > {
-	// The lockfile lives inside the config directory. On a first run that directory may not exist
-	// yet (e.g. telemetry bumps fire before `setupServerFiles()` creates it), and `lockfile.lock`
-	// would reject with ENOENT instead of waiting. Ensure the directory exists before locking.
-	await ensureConfigDirectory();
-	await lockFileAsync( LOCKFILE_PATH, { wait: LOCKFILE_WAIT_TIME, stale: LOCKFILE_STALE_TIME } );
-}
-
-export async function unlockCliConfig(): Promise< void > {
-	await unlockFileAsync( LOCKFILE_PATH );
-}
+export const lockCliConfig = lockCliConfigFile;
+export const unlockCliConfig = unlockCliConfigFile;
 
 export async function updateCliConfigWithPartial(
 	update: Partial< Omit< CliConfig, 'version' | 'sites' > >