refactor(types): rename AppType to AppId for semantic clarity
Rename `AppType` to `AppId` across the entire frontend codebase to better reflect its purpose as an application identifier rather than a type category. This aligns frontend naming with backend command parameter conventions. Changes: - Rename type `AppType` to `AppId` in src/lib/api/types.ts - Remove `AppType` export from src/lib/api/index.ts - Update all component props from `appType` to `appId` (43 files) - Update all variable names from `appType` to `appId` - Synchronize documentation (CHANGELOG, refactoring plans) - Update test files and MSW mocks BREAKING CHANGE: `AppType` type is no longer exported. Use `AppId` instead. All component props have been renamed from `appType` to `appId`.
This commit is contained in:
@@ -1,4 +1,4 @@
|
||||
export type { AppType, AppId } from "./types";
|
||||
export type { AppId } from "./types";
|
||||
export { providersApi } from "./providers";
|
||||
export { settingsApi } from "./settings";
|
||||
export { mcpApi } from "./mcp";
|
||||
|
||||
@@ -5,7 +5,7 @@ import type {
|
||||
McpServerSpec,
|
||||
McpStatus,
|
||||
} from "@/types";
|
||||
import type { AppType } from "./types";
|
||||
import type { AppId } from "./types";
|
||||
|
||||
export const mcpApi = {
|
||||
async getStatus(): Promise<McpStatus> {
|
||||
@@ -31,7 +31,7 @@ export const mcpApi = {
|
||||
return await invoke("validate_mcp_command", { cmd });
|
||||
},
|
||||
|
||||
async getConfig(app: AppType = "claude"): Promise<McpConfigResponse> {
|
||||
async getConfig(app: AppId = "claude"): Promise<McpConfigResponse> {
|
||||
return await invoke("get_mcp_config", { app });
|
||||
},
|
||||
|
||||
@@ -44,7 +44,7 @@ export const mcpApi = {
|
||||
},
|
||||
|
||||
async upsertServerInConfig(
|
||||
app: AppType,
|
||||
app: AppId,
|
||||
id: string,
|
||||
spec: McpServer,
|
||||
options?: { syncOtherSide?: boolean },
|
||||
@@ -61,7 +61,7 @@ export const mcpApi = {
|
||||
},
|
||||
|
||||
async deleteServerInConfig(
|
||||
app: AppType,
|
||||
app: AppId,
|
||||
id: string,
|
||||
options?: { syncOtherSide?: boolean },
|
||||
): Promise<boolean> {
|
||||
@@ -76,7 +76,7 @@ export const mcpApi = {
|
||||
},
|
||||
|
||||
async setEnabled(
|
||||
app: AppType,
|
||||
app: AppId,
|
||||
id: string,
|
||||
enabled: boolean,
|
||||
): Promise<boolean> {
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
import { invoke } from "@tauri-apps/api/core";
|
||||
import { listen, type UnlistenFn } from "@tauri-apps/api/event";
|
||||
import type { Provider } from "@/types";
|
||||
import type { AppType } from "./types";
|
||||
import type { AppId } from "./types";
|
||||
|
||||
export interface ProviderSortUpdate {
|
||||
id: string;
|
||||
@@ -9,37 +9,37 @@ export interface ProviderSortUpdate {
|
||||
}
|
||||
|
||||
export interface ProviderSwitchEvent {
|
||||
appType: AppType;
|
||||
appType: AppId;
|
||||
providerId: string;
|
||||
}
|
||||
|
||||
export const providersApi = {
|
||||
async getAll(appType: AppType): Promise<Record<string, Provider>> {
|
||||
return await invoke("get_providers", { app: appType });
|
||||
async getAll(appId: AppId): Promise<Record<string, Provider>> {
|
||||
return await invoke("get_providers", { app: appId });
|
||||
},
|
||||
|
||||
async getCurrent(appType: AppType): Promise<string> {
|
||||
return await invoke("get_current_provider", { app: appType });
|
||||
async getCurrent(appId: AppId): Promise<string> {
|
||||
return await invoke("get_current_provider", { app: appId });
|
||||
},
|
||||
|
||||
async add(provider: Provider, appType: AppType): Promise<boolean> {
|
||||
return await invoke("add_provider", { provider, app: appType });
|
||||
async add(provider: Provider, appId: AppId): Promise<boolean> {
|
||||
return await invoke("add_provider", { provider, app: appId });
|
||||
},
|
||||
|
||||
async update(provider: Provider, appType: AppType): Promise<boolean> {
|
||||
return await invoke("update_provider", { provider, app: appType });
|
||||
async update(provider: Provider, appId: AppId): Promise<boolean> {
|
||||
return await invoke("update_provider", { provider, app: appId });
|
||||
},
|
||||
|
||||
async delete(id: string, appType: AppType): Promise<boolean> {
|
||||
return await invoke("delete_provider", { id, app: appType });
|
||||
async delete(id: string, appId: AppId): Promise<boolean> {
|
||||
return await invoke("delete_provider", { id, app: appId });
|
||||
},
|
||||
|
||||
async switch(id: string, appType: AppType): Promise<boolean> {
|
||||
return await invoke("switch_provider", { id, app: appType });
|
||||
async switch(id: string, appId: AppId): Promise<boolean> {
|
||||
return await invoke("switch_provider", { id, app: appId });
|
||||
},
|
||||
|
||||
async importDefault(appType: AppType): Promise<boolean> {
|
||||
return await invoke("import_default_config", { app: appType });
|
||||
async importDefault(appId: AppId): Promise<boolean> {
|
||||
return await invoke("import_default_config", { app: appId });
|
||||
},
|
||||
|
||||
async updateTrayMenu(): Promise<boolean> {
|
||||
@@ -48,9 +48,9 @@ export const providersApi = {
|
||||
|
||||
async updateSortOrder(
|
||||
updates: ProviderSortUpdate[],
|
||||
appType: AppType,
|
||||
appId: AppId,
|
||||
): Promise<boolean> {
|
||||
return await invoke("update_providers_sort_order", { updates, app: appType });
|
||||
return await invoke("update_providers_sort_order", { updates, app: appId });
|
||||
},
|
||||
|
||||
async onSwitched(
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import { invoke } from "@tauri-apps/api/core";
|
||||
import type { Settings } from "@/types";
|
||||
import type { AppType } from "./types";
|
||||
import type { AppId } from "./types";
|
||||
|
||||
export interface ConfigTransferResult {
|
||||
success: boolean;
|
||||
@@ -30,12 +30,12 @@ export const settingsApi = {
|
||||
return await invoke("is_portable_mode");
|
||||
},
|
||||
|
||||
async getConfigDir(appType: AppType): Promise<string> {
|
||||
return await invoke("get_config_dir", { app: appType });
|
||||
async getConfigDir(appId: AppId): Promise<string> {
|
||||
return await invoke("get_config_dir", { app: appId });
|
||||
},
|
||||
|
||||
async openConfigFolder(appType: AppType): Promise<void> {
|
||||
await invoke("open_config_folder", { app: appType });
|
||||
async openConfigFolder(appId: AppId): Promise<void> {
|
||||
await invoke("open_config_folder", { app: appId });
|
||||
},
|
||||
|
||||
async selectConfigDirectory(defaultPath?: string): Promise<string | null> {
|
||||
|
||||
@@ -1,3 +1,2 @@
|
||||
export type AppType = "claude" | "codex";
|
||||
// 为避免与后端 Rust `AppType` 枚举语义混淆,可使用更贴近“标识符”的别名
|
||||
export type AppId = AppType;
|
||||
// 前端统一使用 AppId 作为应用标识(与后端命令参数 `app` 一致)
|
||||
export type AppId = "claude" | "codex";
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
import { invoke } from "@tauri-apps/api/core";
|
||||
import type { UsageResult } from "@/types";
|
||||
import type { AppType } from "./types";
|
||||
import type { AppId } from "./types";
|
||||
|
||||
export const usageApi = {
|
||||
async query(providerId: string, appType: AppType): Promise<UsageResult> {
|
||||
async query(providerId: string, appId: AppId): Promise<UsageResult> {
|
||||
return await invoke("query_provider_usage", {
|
||||
provider_id: providerId,
|
||||
app: appType,
|
||||
app: appId,
|
||||
});
|
||||
},
|
||||
};
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import { invoke } from "@tauri-apps/api/core";
|
||||
import type { CustomEndpoint } from "@/types";
|
||||
import type { AppType } from "./types";
|
||||
import type { AppId } from "./types";
|
||||
|
||||
export interface EndpointLatencyResult {
|
||||
url: string;
|
||||
@@ -10,8 +10,8 @@ export interface EndpointLatencyResult {
|
||||
}
|
||||
|
||||
export const vscodeApi = {
|
||||
async getLiveProviderSettings(appType: AppType) {
|
||||
return await invoke("read_live_provider_settings", { app: appType });
|
||||
async getLiveProviderSettings(appId: AppId) {
|
||||
return await invoke("read_live_provider_settings", { app: appId });
|
||||
},
|
||||
|
||||
async testApiEndpoints(
|
||||
@@ -25,46 +25,46 @@ export const vscodeApi = {
|
||||
},
|
||||
|
||||
async getCustomEndpoints(
|
||||
appType: AppType,
|
||||
appId: AppId,
|
||||
providerId: string,
|
||||
): Promise<CustomEndpoint[]> {
|
||||
return await invoke("get_custom_endpoints", {
|
||||
app: appType,
|
||||
app: appId,
|
||||
provider_id: providerId,
|
||||
});
|
||||
},
|
||||
|
||||
async addCustomEndpoint(
|
||||
appType: AppType,
|
||||
appId: AppId,
|
||||
providerId: string,
|
||||
url: string,
|
||||
): Promise<void> {
|
||||
await invoke("add_custom_endpoint", {
|
||||
app: appType,
|
||||
app: appId,
|
||||
provider_id: providerId,
|
||||
url,
|
||||
});
|
||||
},
|
||||
|
||||
async removeCustomEndpoint(
|
||||
appType: AppType,
|
||||
appId: AppId,
|
||||
providerId: string,
|
||||
url: string,
|
||||
): Promise<void> {
|
||||
await invoke("remove_custom_endpoint", {
|
||||
app: appType,
|
||||
app: appId,
|
||||
provider_id: providerId,
|
||||
url,
|
||||
});
|
||||
},
|
||||
|
||||
async updateEndpointLastUsed(
|
||||
appType: AppType,
|
||||
appId: AppId,
|
||||
providerId: string,
|
||||
url: string,
|
||||
): Promise<void> {
|
||||
await invoke("update_endpoint_last_used", {
|
||||
app: appType,
|
||||
app: appId,
|
||||
provider_id: providerId,
|
||||
url,
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user