app

type AppContainer interface {
	// Logger gets logger
	// Logger 获取日志器
	Logger() *zap.Logger
	// SubmitTask submits task to Worker Pool
	// SubmitTask 提交任务到 Worker Pool
	SubmitTask(ctx context.Context, task func(context.Context) error) error
	// SubmitTaskAsync submits task to Worker Pool asynchronously (without waiting for results)
	// SubmitTaskAsync 异步提交任务到 Worker Pool（不等待结果）
	SubmitTaskAsync(ctx context.Context, task func(context.Context) error) error
	// Version gets version info
	// Version 获取版本信息
	Version() VersionInfo
	// CheckVersion checks version
	// CheckVersion 检查版本
	CheckVersion(pluginVersion string) CheckVersionInfo
	// Validator gets validator (may be nil)
	// Validator 获取验证器（可能为 nil）
	Validator() ValidatorInterface
	// IsReturnSuccess whether to return success response
	// IsReturnSuccess 是否返回成功响应
	IsReturnSuccess() bool
	// GetAuthTokenKey gets Token key
	// GetAuthTokenKey 获取 Token 密钥
	GetAuthTokenKey() string
	// IsProductionMode whether it is production mode
	// IsProductionMode 是否为生产模式
	IsProductionMode() bool
}

type CheckVersionInfo struct {
	GithubAvailable                  bool   `json:"githubAvailable"`
	VersionIsNew                     bool   `json:"versionIsNew"`
	VersionNewName                   string `json:"versionNewName"`
	VersionNewLink                   string `json:"versionNewLink"`
	VersionNewChangelog              string `json:"versionNewChangelog"`
	VersionNewChangelogContent       string `json:"versionNewChangelogContent"`
	PluginVersionIsNew               bool   `json:"pluginVersionIsNew"`
	PluginVersionNewName             string `json:"pluginVersionNewName"`
	PluginVersionNewLink             string `json:"pluginVersionNewLink"`
	PluginVersionNewChangelog        string `json:"pluginVersionNewChangelog"`
	PluginVersionNewChangelogContent string `json:"pluginVersionNewChangelogContent"`
}

type ClientInfoMessage struct {
	Name                string `json:"name"`                // Client name // 客户端名称
	Version             string `json:"version"`             // Client version // 客户端版本
	Type                string `json:"type"`                // Client type "web" | "desktop" | "mobile" | "obsidianPlugin" // 客户端类型 "web" | "desktop" | "mobile" | "obsidianPlugin"
	OfflineSyncStrategy string `json:"offlineSyncStrategy"` // Offline device sync strategy "newTimeMerge" | "ignoreTimeMerge" // 离线设备同步策略 "newTimeMerge" | "ignoreTimeMerge"
}

type ConnStorage = map[*gws.Conn]*WebsocketClient

type Datetime time.Time

type DiffMergeEntry struct {
	CreatedAt time.Time // Entry creation time // 条目创建时间
}

type ListRes struct {
	List  interface{} `json:"list"`  // Data list // 数据清单
	Pager Pager       `json:"pager"` // Pagination info // 翻页信息
}

type LogType string

type Pager struct {
	Page      int `json:"page"`      // Page number // 页码
	PageSize  int `json:"pageSize"`  // Page size // 每页数量
	TotalRows int `json:"totalRows"` // Total rows // 总行数
}

type PaginationConfig struct {
	DefaultPageSize int
	MaxPageSize     int
}

type PaginationRequest struct {
	Page     int `json:"page" form:"page" query:"page"`             // Page number // 页码
	PageSize int `json:"pageSize" form:"pageSize" query:"pageSize"` // Page size // 每页数量
}

type Res struct {
	Code    int         `json:"code"`
	Status  bool        `json:"status"`
	Message interface{} `json:"message,omitempty"`
	Data    interface{} `json:"data,omitempty"`
	Details interface{} `json:"details,omitempty"`
	Vault   interface{} `json:"vault,omitempty"`
	Context interface{} `json:"context,omitempty"`
}

type Response struct {
	Ctx *gin.Context
}

type SessionCleaner interface {
	Cleanup()
}

type ShareEntity struct {
	SID       int64               `json:"sid"`       // Share record ID in database // 数据库中的分享记录 ID (Share ID)
	UID       int64               `json:"uid"`       // User ID in database // 数据库中的用户 ID (User ID)
	Resources map[string][]string `json:"resources"` // Resource list // 资源列表
	ExpiresAt time.Time           `json:"exp"`
}

type SupportRecord struct {
	Time    string `json:"time"`
	Item    string `json:"item"`
	Amount  string `json:"amount"`
	Unit    string `json:"unit"`
	Message string `json:"message"`
	Name    string `json:"name"`
}

type TokenConfig struct {
	SecretKey     string        `yaml:"secret-key"`         // JWT 签名密钥
	Expiry        time.Duration `yaml:"expiry"`             // Token 过期时间，默认 365 天
	ShareTokenKey string        `yaml:"share-token-key"`    // 分享专用签名密钥
	ShareExpiry   time.Duration `yaml:"share-token-expiry"` // 分享专用过期时间
	Issuer        string        `yaml:"issuer"`             // Token issuer // Token 签发者
}

type TokenManager interface {
	// User authentication related // 用户认证相关
	Generate(uid int64, nickname, ip string) (string, error)
	Parse(token string) (*UserEntity, error)

	// Resource sharing related // 资源分享相关
	ShareGenerate(shareID int64, uid int64, resources map[string][]string) (string, error)
	ShareParse(token string) (*ShareEntity, error)

	Validate(token string) error
	GetSecretKey() string
}

type UserEntity struct {
	UID      int64  `json:"uid"`
	Nickname string `json:"nickname"`
	IP       string `json:"ip"`
	jwt.RegisteredClaims
}

type UserSelectEntity struct {
	UID      int64  `json:"uid"`
	Email    string `json:"email"`
	Nickname string `json:"nickname"`
	Avatar   string `json:"avatar"`
}

type ValidError struct {
	Key     string
	Message string
}

type ValidErrors []*ValidError

type ValidatorInterface interface {
	ValidateStruct(obj interface{}) error
}

type VersionInfo struct {
	Version   string `json:"version"`
	GitTag    string `json:"gitTag"`
	BuildTime string `json:"buildTime"`
}

type WSConfig struct {
	GWSOption    gws.ServerOption
	PingInterval time.Duration
	PingWait     time.Duration
}

type WebSocketMessage struct {
	Type string `json:"type"` // Operation type, e.g., "upload", "update", "delete" // 操作类型，例如 "upload", "update", "delete"
	Data []byte `json:"data"` // File data (only used for upload and update) // 文件数据（仅在上传和更新时使用）
}

type WebsocketClient struct {
	Server              *WebsocketServer          // WebSocket server reference // WebSocket 服务器引用，用于访问全局状态（如会话）
	Ctx                 *gin.Context              // Original HTTP upgrade request context // 原始 HTTP 升级请求的上下文
	WsCtx               context.Context           // Long-lifecycle context for WebSocket connection // WebSocket 连接的长生命周期 context
	WsCancel            context.CancelFunc        // Used to cancel WsCtx // 用于取消 WsCtx
	TraceID             string                    // Trace ID of the connection // 连接的追踪 ID
	User                *UserEntity               // Authenticated user info // 已认证用户信息，通常在握手阶段绑定
	UserClients         ConnStorage               // User connection pool // 用户连接池，支持多设备在线时广播或单点通信
	SF                  *singleflight.Group       // Concurrency control // 并发控制：相同 key 的请求只执行一次，其余等待结果
	BinaryMu            sync.Mutex                // Synchronization lock when reading and writing data // 用于读写数据时的同步锁 (不再保护 map 存储)
	ClientName          string                    // Client name (e.g., "Mac", "Windows", "iPhone") // 客户端名称 (例如 "Mac", "Windows", "iPhone")
	ClientVersion       string                    // Client version number (e.g., "1.2.4") // 客户端版本号 (例如 "1.2.4")
	IsFirstSync         bool                      // Whether it's the first sync // 是否是第一次同步过
	DiffMergePaths      map[string]DiffMergeEntry // File paths needing merging // 需要合并的文件路径，包含创建时间用于超时清理
	DiffMergePathsMu    sync.RWMutex              // Mutex lock to prevent concurrency conflicts // 互斥锁，防止并发冲突
	OfflineSyncStrategy string                    // Offline device sync strategy // 离线设备同步策略 "newTimeMerge" | "ignoreTimeMerge"
	// contains filtered or unexported fields
}

type WebsocketServer struct {
	// contains filtered or unexported fields
}