create-pardx-scaffold 0.1.0

package/template/packages/contracts/src/index.ts

@@ -0,0 +1,16 @@
+/**
+ * @repo/contracts
+ * Shared API contracts between frontend and backend using ts-rest
+ */
+
+// Base types and utilities
+export * from './base';
+
+// Zod schemas
+export * from './schemas';
+
+// API contracts
+export * from './api';
+
+// Error codes and types
+export * from './errors';

package/template/packages/contracts/src/schemas/analytics.schema.ts

@@ -0,0 +1,81 @@
+import { z } from 'zod';
+
+/**
+ * Analytics Event Types
+ * 定义所有可追踪的事件类型
+ */
+export const AnalyticsEventTypeSchema = z.enum([
+  // Page View Events
+  'PAGE_VIEW',
+
+  // User Engagement Events
+  'SESSION_START', // 会话开始
+  'SESSION_END', // 会话结束
+  'APP_BACKGROUND', // 应用进入后台
+  'APP_FOREGROUND', // 应用回到前台
+]);
+
+export type AnalyticsEventType = z.infer<typeof AnalyticsEventTypeSchema>;
+
+/**
+ * Base Analytics Event Properties
+ * 所有事件的基础属性
+ */
+export const BaseEventPropertiesSchema = z.object({
+  timestamp: z.number().optional(), // Unix timestamp (ms)
+  sessionId: z.string().optional(), // 会话ID
+  userId: z.string().optional(), // 用户ID
+  locale: z.string().optional(), // 语言环境 (en, zh)
+  platform: z.string().optional(), // 平台 (web, ios, android)
+  userAgent: z.string().optional(), // User Agent
+  referrer: z.string().optional(), // 来源页面
+});
+
+/**
+ * Page View Event Properties
+ */
+export const PageViewPropertiesSchema = BaseEventPropertiesSchema.extend({
+  path: z.string(), // 页面路径
+  title: z.string().optional(), // 页面标题
+});
+
+/**
+ * Union of all event properties
+ */
+export const EventPropertiesSchema = z.union([
+  BaseEventPropertiesSchema,
+  PageViewPropertiesSchema,
+]);
+
+export type EventProperties = z.infer<typeof EventPropertiesSchema>;
+
+/**
+ * Analytics Event Schema
+ * 完整的事件数据结构
+ */
+export const AnalyticsEventSchema = z.object({
+  event: AnalyticsEventTypeSchema,
+  properties: EventPropertiesSchema.optional(),
+});
+
+export type AnalyticsEvent = z.infer<typeof AnalyticsEventSchema>;
+
+/**
+ * Batch Analytics Events Schema
+ * 批量上报事件
+ */
+export const BatchAnalyticsEventsSchema = z.object({
+  events: z.array(AnalyticsEventSchema),
+});
+
+export type BatchAnalyticsEvents = z.infer<typeof BatchAnalyticsEventsSchema>;
+
+/**
+ * Analytics Response Schema
+ */
+export const AnalyticsResponseSchema = z.object({
+  success: z.boolean(),
+  eventsProcessed: z.number().optional(),
+});
+
+export type AnalyticsResponse = z.infer<typeof AnalyticsResponseSchema>;

package/template/packages/contracts/src/schemas/download.schema.ts

@@ -0,0 +1,59 @@
+import { z } from 'zod';
+
+/**
+ * Download-related Zod schemas
+ */
+
+// Operation type for file download
+export const DownloadOperationTypeSchema = z.enum([
+  'fileViewOp',
+  'fileDownloadOp',
+]);
+
+export type DownloadOperationType = z.infer<typeof DownloadOperationTypeSchema>;
+
+// Single file download params
+export const DownloadFileParamsSchema = z.object({
+  spaceId: z.string().uuid(),
+  fileId: z.string().uuid(),
+});
+
+export type DownloadFileParams = z.infer<typeof DownloadFileParamsSchema>;
+
+// Single file download query
+export const DownloadFileQuerySchema = z.object({
+  operationType:
+    DownloadOperationTypeSchema.optional().default('fileDownloadOp'),
+});
+
+export type DownloadFileQuery = z.infer<typeof DownloadFileQuerySchema>;
+
+// Single file download response
+export const DownloadFileResponseSchema = z.object({
+  url: z.string().url(),
+  filename: z.string().optional(),
+  contentType: z.string().optional(),
+  size: z.number().optional(),
+});
+
+export type DownloadFileResponse = z.infer<typeof DownloadFileResponseSchema>;
+
+// Batch download request body
+export const BatchDownloadRequestSchema = z.object({
+  spaceId: z.string().uuid(),
+  // folderId can be "root" (special value for space root) or a UUID
+  folderId: z.union([z.literal('root'), z.string().uuid()]).optional(),
+  fileId: z.string().uuid().optional(),
+  fileSystemIds: z.array(z.string().uuid()).optional(),
+});
+
+export type BatchDownloadRequest = z.infer<typeof BatchDownloadRequestSchema>;
+
+// Batch download response
+export const BatchDownloadResponseSchema = z.object({
+  url: z.string().url(),
+  filename: z.string().optional(),
+  expiresAt: z.coerce.date().optional(),
+});
+
+export type BatchDownloadResponse = z.infer<typeof BatchDownloadResponseSchema>;

package/template/packages/contracts/src/schemas/index.ts

@@ -0,0 +1,18 @@
+// Auto-generated Prisma enums (source of truth)
+export * from './prisma-enums.generated';
+
+// Domain schemas (alphabetically ordered)
+export * from './analytics.schema';
+export * from './download.schema';
+export * from './message.schema';
+export * from './risk-words.schema';
+export * from './setting.schema';
+export * from './sign.schema';
+export * from './sms.schema';
+export * from './sse.schema';
+export * from './system.schema';
+export * from './tag.schema';
+export * from './task.schema';
+export * from './uploader.schema';
+export * from './user.schema';
+export * from './webhook.schema';

package/template/packages/contracts/src/schemas/message.schema.ts

@@ -0,0 +1,83 @@
+/**
+ * Message API Schemas
+ * 消息相关的 Zod Schema 定义
+ */
+
+import { z } from 'zod';
+import { PaginationQuerySchema, PaginatedResponseSchema } from '../base';
+
+// ============================================================================
+// Message Schemas - 消息
+// ============================================================================
+
+/**
+ * 消息内容 Schema
+ */
+export const MessageContentSchema = z.object({
+    id: z.string(),
+    type: z.string(),
+    content: z.any(),
+});
+
+export type MessageContent = z.infer<typeof MessageContentSchema>;
+
+/**
+ * 消息接收者 Schema
+ */
+export const MessageReceiverSchema = z.object({
+    id: z.string(),
+    nickname: z.string().nullable(),
+    headerImg: z.string().nullable(),
+});
+
+export type MessageReceiver = z.infer<typeof MessageReceiverSchema>;
+
+/**
+ * 消息接收记录 Schema
+ */
+export const MessageRecipientSchema = z.object({
+    id: z.string(),
+    createdAt: z.coerce.date(),
+    isRead: z.boolean(),
+    readAt: z.coerce.date().nullable(),
+    message: MessageContentSchema,
+    receiver: MessageReceiverSchema,
+});
+
+export type MessageRecipient = z.infer<typeof MessageRecipientSchema>;
+
+/**
+ * 消息列表响应 Schema - 使用标准 PaginatedResponseSchema
+ */
+export const MessageListResponseSchema = PaginatedResponseSchema(
+    MessageRecipientSchema,
+);
+
+export type MessageListResponse = z.infer<typeof MessageListResponseSchema>;
+
+/**
+ * 消息列表查询参数 Schema
+ */
+export const MessageListQuerySchema = PaginationQuerySchema.extend({
+    read: z.string().optional(),
+});
+
+export type MessageListQuery = z.infer<typeof MessageListQuerySchema>;
+
+/**
+ * 设置消息已读请求 Schema
+ */
+export const SetMessageReadRequestSchema = z.object({
+    messageIds: z.array(z.string()),
+});
+
+export type SetMessageReadRequest = z.infer<typeof SetMessageReadRequestSchema>;
+
+/**
+ * 未读消息数量响应 Schema
+ */
+export const UnreadCountResponseSchema = z.object({
+    total: z.number(),
+});
+
+export type UnreadCountResponse = z.infer<typeof UnreadCountResponseSchema>;

package/template/packages/contracts/src/schemas/risk-words.schema.ts

@@ -0,0 +1,25 @@
+import { z } from 'zod';
+
+/**
+ * Risk Words-related Zod schemas
+ */
+
+// Check risk word request
+export const CheckRiskWordRequestSchema = z.object({
+  text: z.string().min(1),
+});
+
+// Volcengine risk word detection request
+export const VolcengineRiskWordDetectionRequestSchema = z.object({
+  text: z.string().min(1),
+  account_id: z.string().min(1),
+  biztype: z.string().optional(),
+  operate_time: z.number().optional(),
+});
+
+// Risk word check response (task result - can be any)
+export const CheckRiskWordResponseSchema = z.any();
+
+// Volcengine detection response (can be any)
+export const VolcengineRiskWordDetectionResponseSchema = z.any();
+

package/template/packages/contracts/src/schemas/setting.schema.ts

@@ -0,0 +1,84 @@
+import { z } from 'zod';
+
+/**
+ * Setting-related Zod schemas
+ */
+
+// Send verify email request
+export const SendVerifyEmailRequestSchema = z.object({
+  email: z.string().email(),
+});
+
+// Setting account request
+export const SettingAccountRequestSchema = z.object({
+  nickname: z.string().min(1),
+  code: z.string().min(1).optional(),
+  email: z.string().email().optional(),
+  emailCode: z.string().optional(),
+  mobile: z.string().optional(),
+  mobileCode: z.string().optional(),
+  oldPassword: z.string().optional(),
+  newPassword: z.string().optional(),
+});
+
+// Set password request
+export const SetPasswordRequestSchema = z.object({
+  newPassword: z.string().min(6),
+});
+
+// Brand schema
+export const BrandSchema = z.object({
+  id: z.string().uuid(),
+  appearance: z.number().optional().nullable(),
+  domain: z.string().optional().nullable(),
+  logo: z.string().optional().nullable(),
+  wallpaperDomain: z.string().optional().nullable(),
+  wallpaper: z.string().optional().nullable(),
+});
+
+// Brand setting request
+export const BrandSettingRequestSchema = z.object({
+  appearance: z.number().optional(),
+  domain: z.string().optional(),
+  logo: z.string().optional(),
+  wallpaperDomain: z.string().optional(),
+  wallpaper: z.string().optional(),
+});
+
+// Usage response schema
+export const UsageResponseSchema = z.object({
+  storageUsed: z.number().optional(),
+  storageLimit: z.number().optional(),
+  aiCreditsUsed: z.number().optional(),
+  aiCreditsLimit: z.number().optional(),
+});
+
+// Email verify request (for binding)
+export const EmailVerifyRequestSchema = z.object({
+  email: z.string().email(),
+  code: z.string().min(1),
+});
+
+// Mobile login request (for binding)
+export const MobileLoginRequestSchema = z.object({
+  mobile: z.string().regex(/^1[3-9]\d{9}$/),
+  code: z.string().min(1),
+});
+
+// Update avatar request
+export const UpdateAvatarRequestSchema = z.object({
+  avatarFileId: z.string().uuid(),
+});
+
+// Inferred types
+export type SendVerifyEmailRequest = z.infer<
+  typeof SendVerifyEmailRequestSchema
+>;
+export type SettingAccountRequest = z.infer<typeof SettingAccountRequestSchema>;
+export type SetPasswordRequest = z.infer<typeof SetPasswordRequestSchema>;
+export type Brand = z.infer<typeof BrandSchema>;
+export type BrandSettingRequest = z.infer<typeof BrandSettingRequestSchema>;
+export type UsageResponse = z.infer<typeof UsageResponseSchema>;
+export type EmailVerifyRequest = z.infer<typeof EmailVerifyRequestSchema>;
+export type MobileLoginRequest = z.infer<typeof MobileLoginRequestSchema>;
+export type UpdateAvatarRequest = z.infer<typeof UpdateAvatarRequestSchema>;

package/template/packages/contracts/src/schemas/sign.schema.ts

@@ -0,0 +1,171 @@
+import { z } from 'zod';
+
+/**
+ * Sign/Auth API Schemas
+ * 登录认证相关的 Zod Schema 定义
+ */
+
+// ============================================================================
+// Request Schemas
+// ============================================================================
+
+/**
+ * Email 登录请求
+ */
+export const EmailLoginSchema = z.object({
+  email: z.string().email('请输入有效的邮箱地址'),
+  password: z.string().min(6, '密码至少6个字符'),
+});
+export type EmailLogin = z.infer<typeof EmailLoginSchema>;
+
+/**
+ * 手机号密码登录请求
+ */
+export const MobilePasswordLoginSchema = z.object({
+  mobile: z.string().regex(/^1[3-9]\d{9}$/, '请输入有效的手机号'),
+  password: z.string().min(6, '密码至少6个字符'),
+});
+export type MobilePasswordLogin = z.infer<typeof MobilePasswordLoginSchema>;
+
+/**
+ * 手机号验证码登录请求
+ */
+export const MobileCodeLoginSchema = z.object({
+  mobile: z.string().regex(/^1[3-9]\d{9}$/, '请输入有效的手机号'),
+  code: z.string().min(4, '请输入验证码'),
+});
+export type MobileCodeLogin = z.infer<typeof MobileCodeLoginSchema>;
+
+/**
+ * Email 注册请求
+ */
+export const EmailRegisterSchema = z.object({
+  email: z.string().email('请输入有效的邮箱地址'),
+  password: z.string().min(6, '密码至少6个字符'),
+  name: z.string().optional(),
+});
+export type EmailRegister = z.infer<typeof EmailRegisterSchema>;
+
+/**
+ * 手机号注册请求
+ */
+export const MobileRegisterSchema = z.object({
+  mobile: z.string().regex(/^1[3-9]\d{9}$/, '请输入有效的手机号'),
+  password: z.string().min(6, '密码至少6个字符'),
+  name: z.string().optional(),
+  code: z.string().min(4, '请输入验证码'),
+});
+export type MobileRegister = z.infer<typeof MobileRegisterSchema>;
+
+/**
+ * Email 验证请求
+ */
+export const EmailVerifySchema = z.object({
+  email: z.string().email('请输入有效的邮箱地址'),
+  code: z.string().min(4, '请输入验证码'),
+});
+export type EmailVerify = z.infer<typeof EmailVerifySchema>;
+
+/**
+ * 手机号验证请求
+ */
+export const MobileVerifySchema = z.object({
+  mobile: z.string().regex(/^1[3-9]\d{9}$/, '请输入有效的手机号'),
+  code: z.string().min(4, '请输入验证码'),
+});
+export type MobileVerify = z.infer<typeof MobileVerifySchema>;
+
+/**
+ * 发送验证码请求
+ */
+export const SendCodeSchema = z.object({
+  mobile: z.string().regex(/^1[3-9]\d{9}$/, '请输入有效的手机号'),
+});
+export type SendCode = z.infer<typeof SendCodeSchema>;
+
+/**
+ * 发送邮箱验证码请求
+ */
+export const SendEmailCodeSchema = z.object({
+  email: z.string().email('请输入有效的邮箱地址'),
+});
+export type SendEmailCode = z.infer<typeof SendEmailCodeSchema>;
+
+/**
+ * 刷新 Token 请求
+ */
+export const RefreshTokenSchema = z.object({
+  refresh: z.string().min(1, '请提供 refresh token'),
+});
+export type RefreshToken = z.infer<typeof RefreshTokenSchema>;
+
+// ============================================================================
+// Response Schemas
+// ============================================================================
+
+export const PlanSchema = z.object({
+  id: z.string(),
+  type: z.string(),
+  name: z.string(),
+  duration: z.number(),
+});
+export type Plan = z.infer<typeof PlanSchema>;
+
+/**
+ * 用户基本信息
+ */
+export const UserInfoSchema = z.object({
+  id: z.string(),
+  isAnonymity: z.boolean().optional(),
+  isAdmin: z.boolean().optional(),
+  code: z.string().nullable(),
+  nickname: z.string().nullable(),
+  headerImg: z.string().nullable(),
+  sex: z.string().nullable(),
+  /** 手机号（已脱敏） */
+  mobile: z.string().nullable().optional(),
+  /** 邮箱（已脱敏） */
+  email: z.string().nullable().optional(),
+});
+export type UserInfo = z.infer<typeof UserInfoSchema>;
+
+/**
+ * 登录成功响应
+ */
+export const LoginSuccessSchema = z.object({
+  access: z.string(),
+  refresh: z.string(),
+  expire: z.number(),
+  accessExpire: z.number(),
+  isAnonymity: z.boolean().optional(),
+  user: UserInfoSchema,
+});
+export type LoginSuccess = z.infer<typeof LoginSuccessSchema>;
+
+/**
+ * 注册成功响应 - Email
+ */
+export const EmailAccountSchema = z.object({
+  id: z.string(),
+  email: z.string(),
+  validator: z.boolean(),
+});
+export type EmailAccount = z.infer<typeof EmailAccountSchema>;
+
+/**
+ * 注册成功响应 - Mobile
+ */
+export const MobileAccountSchema = z.object({
+  id: z.string(),
+  mobile: z.string(),
+  validator: z.boolean(),
+});
+export type MobileAccount = z.infer<typeof MobileAccountSchema>;
+
+/**
+ * 登出成功响应
+ */
+export const SignOutSuccessSchema = z.object({
+  success: z.boolean(),
+});
+export type SignOutSuccess = z.infer<typeof SignOutSuccessSchema>;

package/template/packages/contracts/src/schemas/sms.schema.ts

@@ -0,0 +1,53 @@
+import { z } from 'zod';
+import { LoginSuccessSchema } from './sign.schema';
+
+/**
+ * SMS-related Zod schemas
+ */
+
+// Send SMS code request
+export const SendSmsCodeRequestSchema = z.object({
+  phoneNumbers: z.string().regex(/^1[3-9]\d{9}$/, 'Invalid phone number'),
+});
+
+// Check verify code request
+export const CheckVerifyCodeRequestSchema = z.object({
+  phoneNumber: z.string().regex(/^1[3-9]\d{9}$/, 'Invalid phone number'),
+  code: z.string().regex(/^\d{4,6}$/, 'Code should be 4-6 digits'),
+});
+
+// Mobile code send request
+export const MobileCodeSendRequestSchema = z.object({
+  mobile: z.string().regex(/^1[3-9]\d{9}$/, 'Invalid phone number'),
+  iddCode: z.string().optional().default('0086'),
+});
+
+// Mobile login request (SMS)
+export const SmsMobileLoginRequestSchema = z.object({
+  mobile: z.string().regex(/^1[3-9]\d{9}$/, 'Invalid phone number'),
+  code: z.string().min(1),
+});
+
+// Send SMS code response
+export const SendSmsCodeResponseSchema = z.object({
+  success: z.boolean(),
+  message: z.string().optional(),
+});
+
+// Check verify code response
+export const CheckVerifyCodeResponseSchema = z.object({
+  success: z.boolean(),
+  result: z.string().optional(),
+});
+
+// Send login code response
+export const SendLoginCodeResponseSchema = z.object({
+  success: z.boolean(),
+  message: z.string().optional(),
+});
+
+// Send register code response
+export const SendRegisterCodeResponseSchema = z.object({
+  phoneNumber: z.string(),
+  expireTime: z.number(),
+});

package/template/packages/contracts/src/schemas/sse.schema.ts

@@ -0,0 +1,30 @@
+import { z } from 'zod';
+
+/**
+ * Meeting SSE Event Schema
+ *
+ * @description P1 优化：统一的会议相关 SSE 事件格式
+ * 用于转写、摘要生成、知识提取等会议相关任务的实时状态推送
+ */
+export const MeetingSSEEventSchema = z.object({
+  /** 事件类型 */
+  type: z.enum(['transcription', 'summary']),
+  /** 会议 ID */
+  meetingId: z.string().uuid(),
+  /** 任务状态 */
+  status: z.enum(['processing', 'success', 'error']),
+  /** 事件数据（可选） */
+  data: z.any().optional(),
+  /** 错误信息（可选，仅在 status='error' 时存在） */
+  error: z.string().optional(),
+  /** 时间戳（毫秒） */
+  timestamp: z.number(),
+  /** 任务 ID（可选，用于关联 Python Task） */
+  taskId: z.string().uuid().optional(),
+  /** 进度（0-100，可选） */
+  progress: z.number().min(0).max(100).optional(),
+  /** 当前步骤描述（可选） */
+  currentStep: z.string().optional(),
+});
+
+export type MeetingSSEEvent = z.infer<typeof MeetingSSEEventSchema>;

package/template/packages/contracts/src/schemas/system.schema.ts

@@ -0,0 +1,26 @@
+import { z } from 'zod';
+
+/**
+ * System-related Zod schemas
+ */
+
+// Permission config response
+export const PermissionConfigResponseSchema = z.object({
+  role: z.array(z.enum(['owner', 'admin', 'member', 'guest'])),
+});
+
+// Service ready response
+export const ServiceReadyResponseSchema = z.literal('ready');
+
+// Health check details
+export const HealthCheckDetailsSchema = z.object({
+  db: z.enum(['healthy', 'unhealthy']),
+  rabbitmq: z.enum(['healthy', 'unhealthy']),
+  redis: z.enum(['healthy', 'unhealthy']),
+});
+
+// Health check response
+export const HealthCheckResponseSchema = z.object({
+  status: z.enum(['healthy', 'unhealthy']),
+  details: HealthCheckDetailsSchema,
+});