Files
ChatLab/electron/main/api/errors.ts
T
2026-03-28 00:10:29 +08:00

105 lines
2.9 KiB
TypeScript

/**
* ChatLab API 错误码与错误工厂
*/
export enum ApiErrorCode {
UNAUTHORIZED = 'UNAUTHORIZED',
SESSION_NOT_FOUND = 'SESSION_NOT_FOUND',
INVALID_FORMAT = 'INVALID_FORMAT',
SQL_READONLY_VIOLATION = 'SQL_READONLY_VIOLATION',
SQL_EXECUTION_ERROR = 'SQL_EXECUTION_ERROR',
EXPORT_TOO_LARGE = 'EXPORT_TOO_LARGE',
BODY_TOO_LARGE = 'BODY_TOO_LARGE',
IMPORT_IN_PROGRESS = 'IMPORT_IN_PROGRESS',
IMPORT_FAILED = 'IMPORT_FAILED',
SERVER_ERROR = 'SERVER_ERROR',
}
const HTTP_STATUS: Record<ApiErrorCode, number> = {
[ApiErrorCode.UNAUTHORIZED]: 401,
[ApiErrorCode.SESSION_NOT_FOUND]: 404,
[ApiErrorCode.INVALID_FORMAT]: 400,
[ApiErrorCode.SQL_READONLY_VIOLATION]: 400,
[ApiErrorCode.SQL_EXECUTION_ERROR]: 400,
[ApiErrorCode.EXPORT_TOO_LARGE]: 400,
[ApiErrorCode.BODY_TOO_LARGE]: 413,
[ApiErrorCode.IMPORT_IN_PROGRESS]: 409,
[ApiErrorCode.IMPORT_FAILED]: 500,
[ApiErrorCode.SERVER_ERROR]: 500,
}
export class ApiError extends Error {
code: ApiErrorCode
statusCode: number
constructor(code: ApiErrorCode, message: string) {
super(message)
this.name = 'ApiError'
this.code = code
this.statusCode = HTTP_STATUS[code]
}
}
export function unauthorized(message = 'Token 无效或缺失'): ApiError {
return new ApiError(ApiErrorCode.UNAUTHORIZED, message)
}
export function sessionNotFound(id: string): ApiError {
return new ApiError(ApiErrorCode.SESSION_NOT_FOUND, `会话不存在: ${id}`)
}
export function invalidFormat(message: string): ApiError {
return new ApiError(ApiErrorCode.INVALID_FORMAT, message)
}
export function sqlReadonlyViolation(): ApiError {
return new ApiError(ApiErrorCode.SQL_READONLY_VIOLATION, '仅允许 SELECT 查询')
}
export function sqlExecutionError(message: string): ApiError {
return new ApiError(ApiErrorCode.SQL_EXECUTION_ERROR, message)
}
export function exportTooLarge(count: number, limit: number): ApiError {
return new ApiError(
ApiErrorCode.EXPORT_TOO_LARGE,
`消息数 ${count} 超过导出上限 ${limit},请使用分页 /messages API`
)
}
export function importInProgress(): ApiError {
return new ApiError(ApiErrorCode.IMPORT_IN_PROGRESS, '当前有导入任务正在执行')
}
export function importFailed(message: string): ApiError {
return new ApiError(ApiErrorCode.IMPORT_FAILED, message)
}
export function serverError(message = '服务内部错误'): ApiError {
return new ApiError(ApiErrorCode.SERVER_ERROR, message)
}
/** 构建统一的成功响应 */
export function successResponse<T>(data: T, meta?: Record<string, unknown>) {
return {
success: true as const,
data,
meta: {
timestamp: Math.floor(Date.now() / 1000),
version: '0.0.2',
...meta,
},
}
}
/** 构建统一的错误响应 */
export function errorResponse(error: ApiError) {
return {
success: false as const,
error: {
code: error.code,
message: error.message,
},
}
}