Files
2026-06-06 10:40:48 +08:00

1 line
20 KiB
JSON
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
{"projectName":"OAFlow","domain":"enterprise","contract":{"projectName":"OAFlow","domain":"enterprise","entities":[{"name":"User","table":"users","description":"系统用户","fields":[{"name":"id","type":"UUID","isPrimary":true,"isAuto":true},{"name":"username","type":"VARCHAR(128)","required":true,"unique":true,"validation":{"minLength":2,"maxLength":50}},{"name":"password_hash","type":"VARCHAR(256)","required":true,"isSecret":true},{"name":"nickname","type":"VARCHAR(128)"},{"name":"role","type":"VARCHAR(32)","defaultValue":"user","enum":["user","admin"]},{"name":"phone","type":"VARCHAR(20)"},{"name":"avatar_url","type":"TEXT"},{"name":"created_at","type":"TIMESTAMP","isAuto":true},{"name":"updated_at","type":"TIMESTAMP","isAuto":true}],"relationships":[{"type":"hasMany","entity":"contracts","via":"user_id"},{"type":"hasMany","entity":"customers","via":"user_id"}]},{"name":"Contract","table":"contracts","description":"合同","fields":[{"name":"id","type":"UUID","isPrimary":true,"isAuto":true},{"name":"user_id","type":"UUID","required":true,"fkEntity":"users","fkColumn":"id"},{"name":"title","type":"VARCHAR(256)","required":true},{"name":"party_a","type":"VARCHAR(128)"},{"name":"party_b","type":"VARCHAR(128)"},{"name":"amount","type":"DECIMAL(14,2)"},{"name":"signed_at","type":"DATE"},{"name":"expires_at","type":"DATE"},{"name":"status","type":"VARCHAR(32)","defaultValue":"draft","enum":["draft","pending","active","expired","terminated"]},{"name":"file_url","type":"TEXT"},{"name":"created_at","type":"TIMESTAMP","isAuto":true},{"name":"updated_at","type":"TIMESTAMP","isAuto":true}],"relationships":[{"type":"belongsTo","entity":"users","via":"user_id"}]},{"name":"Approval","table":"approvals","description":"审批流程","fields":[{"name":"id","type":"UUID","isPrimary":true,"isAuto":true},{"name":"user_id","type":"UUID","required":true,"fkEntity":"users","fkColumn":"id"},{"name":"entity_type","type":"VARCHAR(32)","required":true},{"name":"entity_id","type":"UUID"},{"name":"applicant_id","type":"UUID","required":true,"fkEntity":"users","fkColumn":"id"},{"name":"status","type":"VARCHAR(32)","defaultValue":"pending","enum":["pending","approved","rejected"]},{"name":"form_data","type":"JSONB"},{"name":"created_at","type":"TIMESTAMP","isAuto":true},{"name":"updated_at","type":"TIMESTAMP","isAuto":true}],"relationships":[{"type":"belongsTo","entity":"users","via":"user_id"},{"type":"belongsTo","entity":"users","via":"applicant_id","as":"applicant"}]},{"name":"Customer","table":"customers","description":"客户","fields":[{"name":"id","type":"UUID","isPrimary":true,"isAuto":true},{"name":"user_id","type":"UUID","required":true,"fkEntity":"users","fkColumn":"id"},{"name":"name","type":"VARCHAR(128)","required":true},{"name":"email","type":"VARCHAR(256)"},{"name":"phone","type":"VARCHAR(20)"},{"name":"company","type":"VARCHAR(128)"},{"name":"source","type":"VARCHAR(64)"},{"name":"tags","type":"JSONB","defaultValue":"[]"},{"name":"created_at","type":"TIMESTAMP","isAuto":true},{"name":"updated_at","type":"TIMESTAMP","isAuto":true}],"relationships":[{"type":"belongsTo","entity":"users","via":"user_id"}]},{"name":"Reminder","table":"reminders","description":"到期提醒","fields":[{"name":"id","type":"UUID","isPrimary":true,"isAuto":true},{"name":"user_id","type":"UUID","required":true,"fkEntity":"users","fkColumn":"id"},{"name":"entity_type","type":"VARCHAR(32)","required":true},{"name":"entity_id","type":"UUID"},{"name":"remind_at","type":"TIMESTAMP","required":true},{"name":"message","type":"TEXT"},{"name":"sent","type":"BOOLEAN","defaultValue":"false"},{"name":"created_at","type":"TIMESTAMP","isAuto":true},{"name":"updated_at","type":"TIMESTAMP","isAuto":true}],"relationships":[{"type":"belongsTo","entity":"users","via":"user_id"}]},{"name":"Tickets","table":"tickets","description":"工单创建表","fields":[{"name":"id","type":"UUID","required":true,"isPrimary":true,"isAuto":true},{"name":"user_id","type":"UUID","required":false,"isPrimary":false,"isAuto":false,"fkEntity":"users","fkColumn":"id"},{"name":"title","type":"VARCHAR(256)","required":true,"isPrimary":false,"isAuto":false},{"name":"description","type":"TEXT","required":false,"isPrimary":false,"isAuto":false},{"name":"priority","type":"VARCHAR(16)","required":false,"isPrimary":false,"isAuto":true},{"name":"status","type":"VARCHAR(32)","required":false,"isPrimary":false,"isAuto":true},{"name":"assignee_id","type":"UUID","required":false,"isPrimary":false,"isAuto":false,"fkEntity":"assignees","fkColumn":"id"},{"name":"category","type":"VARCHAR(64)","required":false,"isPrimary":false,"isAuto":false},{"name":"created_at","type":"TIMESTAMPTZ","required":false,"isPrimary":false,"isAuto":true},{"name":"updated_at","type":"TIMESTAMPTZ","required":false,"isPrimary":false,"isAuto":true}],"relationships":[{"type":"belongsTo","entity":"users","via":"user_id"},{"type":"belongsTo","entity":"assignees","via":"assignee_id"}]},{"name":"Items","table":"items","description":"分配表","fields":[{"name":"id","type":"UUID","required":true,"isPrimary":true,"isAuto":true},{"name":"user_id","type":"UUID","required":false,"isPrimary":false,"isAuto":false,"fkEntity":"users","fkColumn":"id"},{"name":"title","type":"VARCHAR(256)","required":true,"isPrimary":false,"isAuto":false},{"name":"description","type":"TEXT","required":false,"isPrimary":false,"isAuto":false},{"name":"status","type":"VARCHAR(32)","required":false,"isPrimary":false,"isAuto":true},{"name":"data","type":"JSONB","required":false,"isPrimary":false,"isAuto":false},{"name":"created_at","type":"TIMESTAMPTZ","required":false,"isPrimary":false,"isAuto":true},{"name":"updated_at","type":"TIMESTAMPTZ","required":false,"isPrimary":false,"isAuto":true}],"relationships":[{"type":"belongsTo","entity":"users","via":"user_id"}]}],"auth":{"registrationFields":["username","password","nickname"],"loginFields":["username","password"],"jwtPayload":["userId","username","role"],"passwordPolicy":{"minLength":8,"requireSpecial":true}},"permissions":[{"role":"admin","allow":["*"]},{"role":"user","allow":["read:own","create:*","update:own","delete:own"]}],"fieldMapping":{"snakeToCamel":{"created_at":"createdAt","updated_at":"updatedAt","user_id":"userId","password_hash":"passwordHash","avatar_url":"avatarUrl","party_a":"partyA","party_b":"partyB","signed_at":"signedAt","expires_at":"expiresAt","file_url":"fileUrl","entity_type":"entityType","entity_id":"entityId","applicant_id":"applicantId","form_data":"formData","remind_at":"remindAt","assignee_id":"assigneeId","id":"id","username":"username","nickname":"nickname","role":"role","phone":"phone","title":"title","description":"description","status":"status","data":"data","amount":"amount","name":"name","email":"email","company":"company","source":"source","tags":"tags","breed":"breed","species":"species","birth_date":"birthDate","weight_kg":"weightKg","price":"price","stock":"stock","images":"images","total_amount":"totalAmount","address_id":"addressId","message":"message","sent":"sent"},"camelToSnake":{"createdAt":"created_at","updatedAt":"updated_at","userId":"user_id","passwordHash":"password_hash","avatarUrl":"avatar_url","partyA":"party_a","partyB":"party_b","signedAt":"signed_at","expiresAt":"expires_at","fileUrl":"file_url","entityType":"entity_type","entityId":"entity_id","applicantId":"applicant_id","formData":"form_data","remindAt":"remind_at","assigneeId":"assignee_id","id":"id","username":"username","nickname":"nickname","role":"role","phone":"phone","title":"title","description":"description","status":"status","data":"data","amount":"amount","name":"name","email":"email","company":"company","source":"source","tags":"tags","breed":"breed","species":"species","birthDate":"birth_date","weightKg":"weight_kg","price":"price","stock":"stock","images":"images","totalAmount":"total_amount","addressId":"address_id","message":"message","sent":"sent"}},"validation":{"User":{"username":{"minLength":2,"maxLength":50,"required":true,"unique":true},"password_hash":{"required":true},"role":{"enum":["user","admin"],"defaultValue":"user"}},"Contract":{"user_id":{"required":true},"title":{"required":true},"status":{"enum":["draft","pending","active","expired","terminated"],"defaultValue":"draft"}},"Approval":{"user_id":{"required":true},"entity_type":{"required":true},"applicant_id":{"required":true},"status":{"enum":["pending","approved","rejected"],"defaultValue":"pending"}},"Customer":{"user_id":{"required":true},"name":{"required":true},"tags":{"defaultValue":"[]"}},"Reminder":{"user_id":{"required":true},"entity_type":{"required":true},"remind_at":{"required":true},"sent":{"defaultValue":"false"}},"Tickets":{"id":{"required":true},"title":{"required":true}},"Items":{"id":{"required":true},"title":{"required":true}}}},"techStack":{"frontend":"React Native 0.76 + Expo / Flutter 3.x","backend":"NestJS + Prisma","database":"PostgreSQL 15 + Redis 7 + MinIO(文件存储)","deployment":"Docker Compose + Nginx / K8s(规模化)","considerations":[]},"architectureDiagram":"┌─────────────────────────────────────────────────────────┐\n│ OAFlow — System Architecture │\n├─────────────────────────────────────────────────────────┤\n│ │\n│ ┌──────────────────────┐ ┌──────────────────────┐ │\n│ │ Client Layer │ │ Admin / Web │ │\n│ │ React Native 0.76 + Expo / Flutter 3.x │ │ React + Vite (Web) │ │\n│ └──────────┬───────────┘ └──────────┬───────────┘ │\n│ │ │ │\n│ └──────────┬────────────────┘ │\n│ │ │\n│ ┌─────────▼──────────┐ │\n│ │ API Gateway │ │\n│ │ Nginx / Kong │ │\n│ └─────────┬──────────┘ │\n│ │ │\n│ ┌─────────▼──────────┐ │\n│ │ Backend Services │ │\n│ │ NestJS + Prisma │ │\n│ └─────────┬──────────┘ │\n│ │ │\n│ ┌───────────────┼───────────────┐ │\n│ │ │ │ │\n│ ┌─────▼─────┐ ┌──────▼──────┐ ┌────▼─────┐ │\n│ │ PostgreSQL 15│ │ Redis Cache │ │ MinIO │ │\n│ │ Primary │ │ Session │ │ Files │ │\n│ └───────────┘ └─────────────┘ └──────────┘ │\n│ │\n├─────────────────────────────────────────────────────────┤\n│ Modules: │\n│ 1 工单创建 │\n│ 2 分配 │\n│ 3 Workflow │\n│ 4 优先级管理 │\n│ 5 工单归档 │\n│ 6 审批引擎 │\n│ │\n└─────────────────────────────────────────────────────────┘","dataFlows":[{"page":"工单创建","route":"/tickets","description":"工单创建","dataFlow":["GET /api/tickets → 获取工单创建列表","POST /api/tickets → 创建工单创建"],"direction":"Client → API Gateway → Backend → Database → Response → Client"},{"page":"分配","route":"/items","description":"分配","dataFlow":["GET /api/items → 获取分配列表","POST /api/items → 创建分配"],"direction":"Client → API Gateway → Backend → Database → Response → Client"},{"page":"处理流程","route":"/items","description":"处理流程","dataFlow":["GET /api/items → 获取分配列表","POST /api/items → 创建分配"],"direction":"Client → API Gateway → Backend → Database → Response → Client"},{"page":"优先级管理","route":"/items","description":"优先级管理","dataFlow":["GET /api/items → 获取分配列表","POST /api/items → 创建分配"],"direction":"Client → API Gateway → Backend → Database → Response → Client"}],"modules":[{"name":"工单创建","label":"工单创建","features":["工单创建"],"responsibilities":["提供 工单创建 相关功能"]},{"name":"分配","label":"分配","features":["分配"],"responsibilities":["提供 分配 相关功能"]},{"name":"workflow","label":"Workflow","features":["处理流程"],"responsibilities":["提供 处理流程 相关功能"]},{"name":"优先级管理","label":"优先级管理","features":["优先级管理"],"responsibilities":["提供 优先级管理 相关功能"]},{"name":"工单归档","label":"工单归档","features":["工单归档"],"responsibilities":["提供 工单归档 相关功能"]},{"name":"approval","label":"审批引擎","features":["审批流程"],"responsibilities":["提供 审批流程 相关功能"]},{"name":"attendance","label":"考勤管理","features":["考勤打卡"],"responsibilities":["提供 考勤打卡 相关功能"]},{"name":"department","label":"组织架构","features":["部门管理"],"responsibilities":["提供 部门管理 相关功能"]}],"databaseSchema":[{"table":"users","description":"用户表","fields":[{"name":"id","type":"UUID","constraints":"PK, DEFAULT gen_random_uuid()"},{"name":"phone","type":"VARCHAR(20)","constraints":"UNIQUE"},{"name":"nickname","type":"VARCHAR(64)"},{"name":"avatar_url","type":"TEXT"},{"name":"created_at","type":"TIMESTAMPTZ","constraints":"DEFAULT NOW()"},{"name":"updated_at","type":"TIMESTAMPTZ","constraints":"DEFAULT NOW()"}],"indexes":["idx_users_phone ON users(phone)"]},{"table":"tickets","description":"工单创建表","fields":[{"name":"id","type":"UUID","constraints":"PK, DEFAULT gen_random_uuid()"},{"name":"user_id","type":"UUID","constraints":"FK → users.id"},{"name":"title","type":"VARCHAR(256)","constraints":"NOT NULL"},{"name":"description","type":"TEXT"},{"name":"priority","type":"VARCHAR(16)","constraints":"DEFAULT 'medium'"},{"name":"status","type":"VARCHAR(32)","constraints":"DEFAULT 'open'"},{"name":"assignee_id","type":"UUID","constraints":"FK → users.id"},{"name":"category","type":"VARCHAR(64)"},{"name":"created_at","type":"TIMESTAMPTZ","constraints":"DEFAULT NOW()"},{"name":"updated_at","type":"TIMESTAMPTZ","constraints":"DEFAULT NOW()"}],"indexes":["idx_tickets_user ON tickets(user_id)"]},{"table":"items","description":"分配表","fields":[{"name":"id","type":"UUID","constraints":"PK, DEFAULT gen_random_uuid()"},{"name":"user_id","type":"UUID","constraints":"FK → users.id"},{"name":"title","type":"VARCHAR(256)","constraints":"NOT NULL"},{"name":"description","type":"TEXT"},{"name":"status","type":"VARCHAR(32)","constraints":"DEFAULT 'active'"},{"name":"data","type":"JSONB"},{"name":"created_at","type":"TIMESTAMPTZ","constraints":"DEFAULT NOW()"},{"name":"updated_at","type":"TIMESTAMPTZ","constraints":"DEFAULT NOW()"}],"indexes":["idx_items_user ON items(user_id)"]}],"apiDesign":[{"resource":"auth","basePath":"/api/auth","endpoints":[{"method":"POST","path":"/api/auth/login","description":"用户登录"},{"method":"GET","path":"/api/auth/me","description":"获取当前用户"}]},{"resource":"items","basePath":"/api/items","endpoints":[{"method":"GET","path":"/api/items","description":"获取分配列表"},{"method":"POST","path":"/api/items","description":"创建分配"},{"method":"GET","path":"/api/items","description":"获取处理流程列表"},{"method":"POST","path":"/api/items","description":"创建处理流程"},{"method":"GET","path":"/api/items","description":"获取优先级管理列表"},{"method":"POST","path":"/api/items","description":"创建优先级管理"}]},{"resource":"tickets","basePath":"/api/tickets","endpoints":[{"method":"GET","path":"/api/tickets","description":"获取工单创建列表"},{"method":"POST","path":"/api/tickets","description":"创建工单创建"}]}],"directoryStructure":["oaflow/","├── apps/","│ ├── mobile/ # React Native / Flutter 移动端","│ │ ├── src/","│ │ │ ├── screens/ # 页面组件","│ │ │ │ ├── 工单创建/","│ │ │ │ ├── 分配/","│ │ │ │ ├── workflow/","│ │ │ │ ├── 优先级管理/","│ │ │ ├── components/ # 通用组件","│ │ │ ├── hooks/ # 自定义 Hooks","│ │ │ ├── services/ # API 调用层","│ │ │ ├── store/ # 状态管理","│ │ │ └── utils/ # 工具函数","│ │ ├── app.json","│ │ └── package.json","│ └── web/ # Web 管理后台","│ ├── src/","│ │ ├── pages/","│ │ ├── components/","│ │ └── layouts/","│ └── package.json","├── packages/","│ └── shared/ # 共享类型/常量","├── server/ # NestJS 后端服务","│ ├── src/","│ │ ├── modules/ # 业务模块","│ │ │ ├── 工单创建/","│ │ │ │ ├── 工单创建.controller.ts","│ │ │ │ ├── 工单创建.service.ts","│ │ │ │ ├── 工单创建.module.ts","│ │ │ │ └── dto/","│ │ │ ├── 分配/","│ │ │ │ ├── 分配.controller.ts","│ │ │ │ ├── 分配.service.ts","│ │ │ │ ├── 分配.module.ts","│ │ │ │ └── dto/","│ │ │ ├── workflow/","│ │ │ │ ├── workflow.controller.ts","│ │ │ │ ├── workflow.service.ts","│ │ │ │ ├── workflow.module.ts","│ │ │ │ └── dto/","│ │ │ ├── 优先级管理/","│ │ │ │ ├── 优先级管理.controller.ts","│ │ │ │ ├── 优先级管理.service.ts","│ │ │ │ ├── 优先级管理.module.ts","│ │ │ │ └── dto/","│ │ │ ├── 工单归档/","│ │ │ │ ├── 工单归档.controller.ts","│ │ │ │ ├── 工单归档.service.ts","│ │ │ │ ├── 工单归档.module.ts","│ │ │ │ └── dto/","│ │ ├── common/ # 通用(guards, filters, interceptors","│ │ ├── prisma/ # Prisma ORM","│ │ │ └── schema.prisma","│ │ ├── config/ # 环境配置","│ │ └── main.ts","│ ├── test/","│ ├── Dockerfile","│ └── package.json","├── docker-compose.yml","├── .github/workflows/ # CI/CD","│ └── ci.yml","├── .env.example","├── README.md","└── turbo.json # Monorepo 配置"],"deployment":{"environments":["development","staging","production"],"strategy":"Docker Compose + Nginx / K8s(规模化)","services":["API Server (NestJS)","PostgreSQL 15","Redis 7"],"ci":"GitHub Actions → Build → Test → Deploy"},"meta":{"generatedAt":"2026-06-05T22:08:35.099Z","sourceDomain":"enterprise","moduleCount":8,"tableCount":3,"apiEndpointCount":10}}