Export more types to the external API (#3383)

Author: cte

src/core/config/ProviderSettingsManager.ts

@@ -247,7 +247,7 @@ export class ProviderSettingsManager {
 	 * Preserves the ID from the input 'config' object if it exists,
 	 * otherwise generates a new one (for creation scenarios).
 	 */
-	public async saveConfig(name: string, config: ProviderSettingsWithId) {
+	public async saveConfig(name: string, config: ProviderSettingsWithId): Promise<string> {
 		try {
 			return await this.lock(async () => {
 				const providerProfiles = await this.load()
@@ -259,13 +259,16 @@ export class ProviderSettingsManager {
 				const filteredConfig = providerSettingsSchemaDiscriminated.parse(config)
 				providerProfiles.apiConfigs[name] = { ...filteredConfig, id }
 				await this.store(providerProfiles)
+				return id
 			})
 		} catch (error) {
 			throw new Error(`Failed to save config: ${error}`)
 		}
 	}
 
-	public async getProfile(params: { name: string } | { id: string }) {
+	public async getProfile(
+		params: { name: string } | { id: string },
+	): Promise<ProviderSettingsWithId & { name: string }> {
 		try {
 			return await this.lock(async () => {
 				const providerProfiles = await this.load()

src/exports/api.ts

@@ -178,90 +178,6 @@ export class API extends EventEmitter<RooCodeEvents> implements RooCodeAPI {
 		await this.sidebarProvider.postMessageToWebview({ type: "invoke", invoke: "secondaryButtonClick" })
 	}
 
-	public getConfiguration() {
-		return this.sidebarProvider.getValues()
-	}
-
-	public async setConfiguration(values: RooCodeSettings) {
-		await this.sidebarProvider.setValues(values)
-		await this.sidebarProvider.providerSettingsManager.saveConfig(values.currentApiConfigName || "default", values)
-		await this.sidebarProvider.postStateToWebview()
-	}
-
-	public async createProfile(name: string) {
-		if (!name || !name.trim()) {
-			throw new Error("Profile name cannot be empty")
-		}
-
-		const currentSettings = this.getConfiguration()
-		const profiles = currentSettings.listApiConfigMeta || []
-
-		if (profiles.some((profile) => profile.name === name)) {
-			throw new Error(`A profile with the name "${name}" already exists`)
-		}
-
-		const id = this.sidebarProvider.providerSettingsManager.generateId()
-
-		await this.setConfiguration({
-			...currentSettings,
-			listApiConfigMeta: [
-				...profiles,
-				{
-					id,
-					name: name.trim(),
-					apiProvider: "openai" as const,
-				},
-			],
-		})
-
-		return id
-	}
-
-	private getProfilesMeta() {
-		return this.getConfiguration().listApiConfigMeta || []
-	}
-
-	public getProfiles() {
-		return this.getProfilesMeta().map((profile) => profile.name)
-	}
-
-	public hasProfile(name: string): boolean {
-		return !!(this.getConfiguration().listApiConfigMeta || []).find((profile) => profile.name === name)
-	}
-
-	public async setActiveProfile(name: string) {
-		if (!this.hasProfile(name)) {
-			throw new Error(`Profile with name "${name}" does not exist`)
-		}
-
-		await this.sidebarProvider.activateProviderProfile({ name })
-	}
-
-	public getActiveProfile() {
-		return this.getConfiguration().currentApiConfigName
-	}
-
-	public async deleteProfile(name: string) {
-		const currentSettings = this.getConfiguration()
-		const listApiConfigMeta = this.getProfilesMeta()
-		const targetIndex = listApiConfigMeta.findIndex((p) => p.name === name)
-
-		if (targetIndex === -1) {
-			throw new Error(`Profile with name "${name}" does not exist`)
-		}
-
-		const profileToDelete = listApiConfigMeta[targetIndex]
-		listApiConfigMeta.splice(targetIndex, 1)
-
-		// If we're deleting the active profile, clear the currentApiConfigName.
-		const currentApiConfigName =
-			currentSettings.currentApiConfigName === profileToDelete.name
-				? undefined
-				: currentSettings.currentApiConfigName
-
-		await this.setConfiguration({ ...currentSettings, listApiConfigMeta, currentApiConfigName })
-	}
-
 	public isReady() {
 		return this.sidebarProvider.viewLaunched
 	}
@@ -327,4 +243,92 @@ export class API extends EventEmitter<RooCodeEvents> implements RooCodeAPI {
 			this.logfile = undefined
 		}
 	}
+
+	// Global Settings Management
+
+	public getConfiguration() {
+		return this.sidebarProvider.getValues()
+	}
+
+	public async setConfiguration(values: RooCodeSettings) {
+		await this.sidebarProvider.contextProxy.setValues(values)
+		await this.sidebarProvider.providerSettingsManager.saveConfig(values.currentApiConfigName || "default", values)
+		await this.sidebarProvider.postStateToWebview()
+	}
+
+	// Provider Profile Management
+
+	private getProfilesMeta() {
+		return this.getConfiguration().listApiConfigMeta || []
+	}
+
+	public getProfiles() {
+		return this.getProfilesMeta().map((profile) => profile.name)
+	}
+
+	public hasProfile(name: string): boolean {
+		return !!(this.getConfiguration().listApiConfigMeta || []).find((profile) => profile.name === name)
+	}
+
+	public async createProfile(name: string) {
+		if (!name || !name.trim()) {
+			throw new Error("Profile name cannot be empty")
+		}
+
+		const currentSettings = this.getConfiguration()
+		const profiles = currentSettings.listApiConfigMeta || []
+
+		if (profiles.some((profile) => profile.name === name)) {
+			throw new Error(`A profile with the name "${name}" already exists`)
+		}
+
+		const id = this.sidebarProvider.providerSettingsManager.generateId()
+
+		await this.setConfiguration({
+			...currentSettings,
+			listApiConfigMeta: [
+				...profiles,
+				{
+					id,
+					name: name.trim(),
+					apiProvider: "openai" as const,
+				},
+			],
+		})
+
+		return id
+	}
+
+	public async deleteProfile(name: string) {
+		const currentSettings = this.getConfiguration()
+		const listApiConfigMeta = this.getProfilesMeta()
+		const targetIndex = listApiConfigMeta.findIndex((p) => p.name === name)
+
+		if (targetIndex === -1) {
+			throw new Error(`Profile with name "${name}" does not exist`)
+		}
+
+		const profileToDelete = listApiConfigMeta[targetIndex]
+		listApiConfigMeta.splice(targetIndex, 1)
+
+		// If we're deleting the active profile, clear the currentApiConfigName.
+		const currentApiConfigName =
+			currentSettings.currentApiConfigName === profileToDelete.name
+				? undefined
+				: currentSettings.currentApiConfigName
+
+		await this.setConfiguration({ ...currentSettings, listApiConfigMeta, currentApiConfigName })
+	}
+
+	public getActiveProfile(): string | undefined {
+		return this.getConfiguration().currentApiConfigName
+	}
+
+	public async setActiveProfile(name: string) {
+		if (!this.hasProfile(name)) {
+			throw new Error(`Profile with name "${name}" does not exist`)
+		}
+
+		await this.sidebarProvider.activateProviderProfile({ name })
+	}
 }

src/exports/interface.ts

@@ -1,7 +1,23 @@
 import { EventEmitter } from "events"
 
-import type { ProviderSettings, GlobalSettings, ClineMessage, TokenUsage, RooCodeEvents } from "./types"
-export type { RooCodeSettings, ProviderSettings, GlobalSettings, ClineMessage, TokenUsage, RooCodeEvents }
+import type {
+	GlobalSettings,
+	ProviderSettings,
+	ProviderSettingsEntry,
+	ClineMessage,
+	TokenUsage,
+	RooCodeEvents,
+} from "./types"
+
+export type {
+	RooCodeSettings,
+	GlobalSettings,
+	ProviderSettings,
+	ProviderSettingsEntry,
+	ClineMessage,
+	TokenUsage,
+	RooCodeEvents,
+}
 
 import { RooCodeEventName } from "../schemas"
 export type { RooCodeEventName }
@@ -74,6 +90,11 @@ export interface RooCodeAPI extends EventEmitter<RooCodeEvents> {
 	 */
 	pressSecondaryButton(): Promise<void>
 
+	/**
+	 * Returns true if the API is ready to use.
+	 */
+	isReady(): boolean
+
 	/**
 	 * Returns the current configuration.
 	 * @returns The current configuration.
@@ -86,25 +107,26 @@ export interface RooCodeAPI extends EventEmitter<RooCodeEvents> {
 	 */
 	setConfiguration(values: RooCodeSettings): Promise<void>
 
-	/**
-	 * Creates a new API configuration profile
-	 * @param name The name of the profile
-	 * @returns The ID of the created profile
-	 */
-	createProfile(name: string): Promise<string>
-
 	/**
 	 * Returns a list of all configured profile names
 	 * @returns Array of profile names
 	 */
 	getProfiles(): string[]
 
 	/**
-	 * Changes the active API configuration profile
-	 * @param name The name of the profile to activate
+	 * Creates a new API configuration profile
+	 * @param name The name of the profile
+	 * @returns The ID of the created profile
+	 * @throws Error if the profile already exists
+	 */
+	createProfile(name: string, profile?: ProviderSettings): Promise<string>
+
+	/**
+	 * Deletes a profile by name
+	 * @param name The name of the profile to delete
 	 * @throws Error if the profile does not exist
 	 */
-	setActiveProfile(name: string): Promise<void>
+	deleteProfile(name: string): Promise<void>
 
 	/**
 	 * Returns the name of the currently active profile
@@ -113,14 +135,9 @@ export interface RooCodeAPI extends EventEmitter<RooCodeEvents> {
 	getActiveProfile(): string | undefined
 
 	/**
-	 * Deletes a profile by name
-	 * @param name The name of the profile to delete
+	 * Changes the active API configuration profile
+	 * @param name The name of the profile to activate
 	 * @throws Error if the profile does not exist
 	 */
-	deleteProfile(name: string): Promise<void>
-
-	/**
-	 * Returns true if the API is ready to use.
-	 */
-	isReady(): boolean
+	setActiveProfile(name: string): Promise<void>
 }