Refactor: Remove original Dart references from comments across multiple files

- Updated comments in various components, schemas, and repositories to remove references to original Dart files.
- Ensured consistency in documentation while maintaining the context of the code.
This commit is contained in:
2026-06-29 11:31:21 +08:00
parent cdaf3cc365
commit 6e51cb7d16
119 changed files with 116 additions and 128 deletions
+1 -1
View File
@@ -1,7 +1,7 @@
/**
* 认证模式(登录 / 注册)
*
* 原始 Dart: lib/ui/auth/model/auth_mode.dart
*
*/
export const AuthMode = {
Login: "login",
+1 -1
View File
@@ -1,7 +1,7 @@
/**
* 认证面板模式(Facebook / Email
*
* 原始 Dart: lib/ui/auth/model/auth_panel_mode.dart
*
*/
export const AuthPanelMode = {
Facebook: "facebook",
+1 -1
View File
@@ -1,7 +1,7 @@
/**
* Facebook 用户数据 DTO
*
* 原始 Dart: FacebookUserData (lib/data/services/auth/auth_platform.dart)
*
*/
import {
FacebookUserDataSchema,
+1 -1
View File
@@ -1,7 +1,7 @@
/**
* 聊天列表项 discriminated union
*
* 原始 Dart: lib/ui/chat/models/chat_list_item.dart
*
*
* 4 种类型:
* - ai-disclosure:顶部 AI 披露横幅
+1 -1
View File
@@ -1,7 +1,7 @@
/**
* 聊天 UI 消息模型
*
* 原始 Dart: lib/ui/chat/models/message.dartfreezed + json_serializable 生成)
*
*
* 字段:content、isFromAI、date、imageUrl(可选)、audioUrl(可选)
*/
+1 -1
View File
@@ -1,7 +1,7 @@
/**
* UI 侧用户模型(基于 data/dto/user/user + user_storage 重新导出 view-model
*
* 原始 Dart: lib/data/models/user/user.dart
*
*/
import { z } from "zod";
+1 -1
View File
@@ -10,7 +10,7 @@
* - `getCurrentUser` 成功后尽力写本地 User 缓存(不因缓存失败影响主流程)
* - 写 storage 失败用 `Logger.warn` 记录,不让本地缓存失败影响主流程
*
* 原始 Dart: lib/data/repositories/auth_repository_impl.dart
*
*/
import { AuthApi, authApi } from "@/data/services/api";
import {
@@ -10,7 +10,7 @@
* - 所有方法返回 `Promise<Result<T>>`,与 Dart `Future<Result<T>>` 对齐
*
* 注:仓库内私有方法(`_socialLogin` / `_saveLoginData`)不暴露在接口上。
* 原始 Dart: lib/data/repositories/auth_repository_impl.dart
*
*/
import type { Result } from "@/utils";
@@ -8,7 +8,7 @@
* - 本地:写入 / 批量覆盖 / 读取 / 清空 / 计数
*
* 私有助手(`_chatToLocal` / `_localToChat` / `_mapLocalStorageResult`)不暴露。
* 原始 Dart: lib/data/repositories/chat_repository_impl.dart
*
*/
import type { Result } from "@/utils";
@@ -6,7 +6,7 @@
* 对齐 Dart 端 `MetricsRepository` 抽象(lib/data/repositories/metrics_repository.dart):
* - 纯远程 fire-and-forget 上报,无本地状态
*
* 原始 Dart: lib/data/repositories/metrics_repository_impl.dart
*
*/
import type { Result } from "@/utils";
@@ -6,7 +6,7 @@
* 对齐 Dart 端 `UserRepository` 抽象(lib/data/repositories/user_repository.dart):
* - 纯远程调用,不直接写本地 storage(持久化由 AuthRepository 在登录流程中处理)
*
* 原始 Dart: lib/data/repositories/user_repository_impl.dart
*
*/
import type { Result } from "@/utils";
@@ -4,8 +4,6 @@
* MetricsRepository
*
* 指标/埋点仓库:纯远程 fire-and-forget 上报,无本地状态。
*
* 原始 Dart: lib/data/repositories/metrics_repository_impl.dart
*/
import { MetricsApi, metricsApi } from "@/data/services/api";
import { AppEvent, PwaEvent } from "@/data/dto/metrics";
-9
View File
@@ -1,13 +1,4 @@
"use client";
/**
* UserRepository
*
* 用户信息仓库:纯远程调用,不直接写入本地 storage
* (用户数据持久化由 AuthRepository 在登录流程中统一处理)。
*
* 原始 Dart: lib/data/repositories/user_repository_impl.dart
*/
import { UserApi, userApi } from "@/data/services/api";
import {
CreditsData,
+1 -1
View File
@@ -1,6 +1,6 @@
/**
* Apple 登录请求
* 原始 Dart: AppleLoginRequest (lib/data/models/auth/auth_request.dart)
*
*/
import { z } from "zod";
@@ -1,6 +1,6 @@
/**
* Facebook 登录请求
* 原始 Dart: FacebookLoginRequest (lib/data/models/auth/auth_request.dart)
*
*/
import { z } from "zod";
+1 -1
View File
@@ -1,6 +1,6 @@
/**
* Facebook 用户数据 schema
* 原始 Dart: FacebookUserData (lib/data/services/auth/auth_platform.dart)
*
*
* 字段对齐 Dart 端 `String?` 可空语义:缺字段时存 `null`。
*/
+1 -1
View File
@@ -1,6 +1,6 @@
/**
* Facebook ID 登录请求
* 原始 Dart: FbIdLoginRequest (lib/data/models/auth/auth_request.dart)
*
*/
import { z } from "zod";
@@ -1,6 +1,6 @@
/**
* Google 登录请求
* 原始 Dart: GoogleLoginRequest (lib/data/models/auth/auth_request.dart)
*
*/
import { z } from "zod";
+1 -1
View File
@@ -1,6 +1,6 @@
/**
* 游客登录请求
* 原始 Dart: GuestLoginRequest (lib/data/models/auth/auth_request.dart)
*
*/
import { z } from "zod";
@@ -1,6 +1,6 @@
/**
* 游客登录响应
* 原始 Dart: GuestLoginResponse (lib/data/models/auth/auth_response.dart)
*
*/
import { z } from "zod";
import { UserSchema } from "../user/user";
+1 -1
View File
@@ -1,6 +1,6 @@
/**
* 登录请求
* 原始 Dart: LoginRequest (lib/data/models/auth/auth_request.dart)
*
*/
import { z } from "zod";
+1 -1
View File
@@ -1,6 +1,6 @@
/**
* 登录响应
* 原始 Dart: LoginResponse (lib/data/models/auth/auth_response.dart)
*
*/
import { z } from "zod";
import { UserSchema } from "../user/user";
+1 -1
View File
@@ -1,6 +1,6 @@
/**
* 退出登录响应
* 原始 Dart: LogoutResponse (lib/data/models/auth/auth_response.dart)
*
*/
import { z } from "zod";
@@ -1,6 +1,6 @@
/**
* 刷新 Token 请求
* 原始 Dart: RefreshTokenRequest (lib/data/models/auth/auth_request.dart)
*
*/
import { z } from "zod";
@@ -1,6 +1,6 @@
/**
* 刷新 Token 响应
* 原始 Dart: RefreshTokenResponse (lib/data/models/auth/auth_response.dart)
*
*/
import { z } from "zod";
+1 -1
View File
@@ -1,6 +1,6 @@
/**
* 注册请求
* 原始 Dart: RegisterRequest (lib/data/models/auth/auth_request.dart)
*
*/
import { z } from "zod";
+1 -1
View File
@@ -1,6 +1,6 @@
/**
* 发送验证码请求
* 原始 Dart: SendCodeRequest (lib/data/models/auth/auth_request.dart)
*
*/
import { z } from "zod";
@@ -1,6 +1,6 @@
/**
* 聊天历史响应
* 原始 Dart: ChatHistoryResponse (lib/data/models/chat/chat_response.dart)
*
*/
import { z } from "zod";
import { ChatMessageSchema } from "./chat_message";
+1 -1
View File
@@ -1,6 +1,6 @@
/**
* 聊天历史中的单条消息
* 原始 Dart: ChatMessage (lib/data/models/chat/chat_response.dart)
*
*/
import { z } from "zod";
import { ChatImageSchema, ChatLockDetailSchema } from "./chat_payloads";
+1 -1
View File
@@ -1,6 +1,6 @@
/**
* 发送消息响应
* 原始 Dart: ChatSendResponse (lib/data/models/chat/chat_response.dart)
*
*/
import { z } from "zod";
import { ChatImageSchema, ChatLockDetailSchema } from "./chat_payloads";
+1 -1
View File
@@ -1,6 +1,6 @@
/**
* 消息同步响应
* 原始 Dart: ChatSyncData (lib/data/models/chat/chat_sync.dart)
*
*/
import { z } from "zod";
+1 -1
View File
@@ -1,6 +1,6 @@
/**
* 消息同步请求
* 原始 Dart: ChatSyncRequest (lib/data/models/chat/chat_sync.dart)
*
*/
import { z } from "zod";
import { SyncMessageSchema } from "./sync_message";
@@ -1,6 +1,6 @@
/**
* 图片上传响应
* 原始 Dart: ImageUploadResponse (lib/data/models/chat/image_upload_response.dart)
*
*/
import { z } from "zod";
@@ -1,6 +1,6 @@
/**
* 发送消息请求
* 原始 Dart: SendMessageRequest (lib/data/models/chat/send_message_request.dart)
*
*/
import { z } from "zod";
+1 -1
View File
@@ -1,6 +1,6 @@
/**
* STT(语音转文字)响应
* 原始 Dart: SttData (lib/data/models/chat/stt_response.dart)
*
*/
import { z } from "zod";
+1 -1
View File
@@ -1,6 +1,6 @@
/**
* 待同步的单条消息
* 原始 Dart: SyncMessage (lib/data/models/chat/chat_sync.dart)
*
*/
import { z } from "zod";
+1 -1
View File
@@ -1,6 +1,6 @@
/**
* 应用事件上报请求
* 原始 Dart: AppEvent (lib/data/models/metrics/app_event.dart)
*
*/
import { z } from "zod";
+1 -1
View File
@@ -1,6 +1,6 @@
/**
* PWA 事件上报请求
* 原始 Dart: PwaEvent (lib/data/models/metrics/pwa_event.dart)
*
*/
import { z } from "zod";
+1 -1
View File
@@ -1,6 +1,6 @@
/**
* 头像数据模型
* 原始 Dart: AvatarData (lib/data/models/user/user.dart)
*
*/
import { z } from "zod";
+1 -1
View File
@@ -1,6 +1,6 @@
/**
* 积分数据模型
* 原始 Dart: CreditsData (lib/data/models/user/user.dart)
*
*/
import { z } from "zod";
@@ -1,6 +1,6 @@
/**
* 积分历史记录模型
* 原始 Dart: CreditsHistoryData (lib/data/models/user/user.dart)
*
*/
import { z } from "zod";
+1 -1
View File
@@ -1,6 +1,6 @@
/**
* 个性特征模型
* 原始 Dart: PersonalityTraits (lib/data/models/user/user.dart)
*
*/
import { z } from "zod";
+1 -1
View File
@@ -1,6 +1,6 @@
/**
* 最近记忆模型
* 原始 Dart: RecentMemory (lib/data/models/user/recent_memory.dart)
*
*/
import { z } from "zod";
@@ -1,6 +1,6 @@
/**
* 更新个人资料请求
* 原始 Dart: UpdateProfileRequest (lib/data/models/user/user.dart)
*
*/
import { z } from "zod";
+1 -1
View File
@@ -1,6 +1,6 @@
/**
* 用户模型
* 原始 Dart: User (lib/data/models/user/user.dart)
*
*/
import { z } from "zod";
import { PersonalityTraitsSchema, PERSONALITY_TRAITS_DEFAULTS } from "./personality_traits";
+1 -1
View File
@@ -1,6 +1,6 @@
/**
* 用户统计响应
* 原始 Dart: UserStatsResponse (lib/data/models/user/user_stats_response.dart)
*
*/
import { z } from "zod";
import { PersonalityTraitsSchema, PERSONALITY_TRAITS_DEFAULTS } from "./personality_traits";
+1 -1
View File
@@ -1,7 +1,7 @@
/**
* API 路径管理
* 统一管理所有接口路径
* 原始 Dart: lib/data/services/api/api_path.dart
*
*/
export class ApiPath {
private constructor() {}
+1 -1
View File
@@ -2,7 +2,7 @@
* Auth API
*
* 认证相关接口
* 原始 Dart: lib/data/services/api/auth_api_client.dart
*
*/
import { z } from "zod";
+1 -1
View File
@@ -2,7 +2,7 @@
* Chat API
*
* 聊天相关接口
* 原始 Dart: lib/data/services/api/chat_api_client.dart
*
*/
import { httpClient } from "./http_client";
import { ApiPath } from "./api_path";
+1 -1
View File
@@ -2,7 +2,7 @@
* HTTP 客户端工厂
*
* 创建配置好拦截器的 ofetch 实例。
* 原始 Dart: lib/core/net/backend_service.dart
*
*/
import { ofetch, type $Fetch, type FetchHook } from "ofetch";
import { ApiError, ErrorCode } from "./api_result";
+1 -1
View File
@@ -2,7 +2,7 @@
* Metrics API
*
* 数据看板/上报相关接口
* 原始 Dart: lib/data/services/api/metrics_api_client.dart
*
*/
import { httpClient } from "./http_client";
import { ApiPath } from "./api_path";
+1 -1
View File
@@ -8,7 +8,7 @@
* 行为升级:失败时抛 `ApiError``ApiError extends Error`),而不是裸 `Error`。
* 这样调用方在 `Result.err` 内能 `instanceof ApiError` 检查 `.code` / `.status`。
*
* 原始 Dart: lib/data/services/api/api_client.dart 的 `NetResult<T>` 解析。
*
*/
import { ApiError, ErrorCode } from "./api_result";
+1 -1
View File
@@ -2,7 +2,7 @@
* User API
*
* 用户相关接口
* 原始 Dart: lib/data/services/api/user_api_client.dart
*
*/
import { httpClient } from "./http_client";
import { ApiPath } from "./api_path";