Course.ts 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222
  1. import { IStudio } from "../auth/Studio";
  2. import { IUser } from "../auth/User";
  3. import { IChannel } from "../channel/Channel";
  4. import { TRole } from "./Auth";
  5. export interface ICourseListApiResponse {
  6. article: string;
  7. title: string;
  8. level: string;
  9. children: number;
  10. }
  11. export interface ICourseDataRequest {
  12. id?: string; //课程ID
  13. title: string; //标题
  14. subtitle?: string; //副标题
  15. summary?: string; //副标题
  16. content?: string | null;
  17. cover?: string; //封面图片文件名
  18. teacher_id?: string; //UserID
  19. publicity: number; //类型-公开/内部
  20. anthology_id?: string; //文集ID
  21. channel_id?: string; //标准答案channel
  22. start_at?: string; //课程开始时间
  23. end_at?: string; //课程结束时间
  24. sign_up_start_at: string | null; //报名开始时间
  25. sign_up_end_at: string | null; //报名结束时间
  26. join: string;
  27. request_exp: string;
  28. number: number;
  29. }
  30. export type TCourseRole =
  31. | "owner"
  32. | "teacher"
  33. | "manager"
  34. | "assistant"
  35. | "student";
  36. export type TCourseJoinMode = "invite" | "manual" | "open";
  37. export type TCourseExpRequest = "none" | "begin-end" | "daily";
  38. export interface IMember {
  39. role: TCourseRole;
  40. status: TCourseMemberStatus;
  41. }
  42. export interface ICourseDataResponse {
  43. id: string; //课程ID
  44. title: string; //标题
  45. subtitle: string; //副标题
  46. summary?: string; //副标题
  47. teacher?: IUser; //UserID
  48. course_count?: number; //课程数
  49. publicity: number; //类型-公开/内部
  50. anthology_id?: string; //文集ID
  51. anthology_title?: string; //文集标题
  52. anthology_owner?: IStudio; //文集拥有者
  53. channel_id: string; //标准答案ID
  54. channel_name?: string; //文集标题
  55. channel_owner?: IStudio; //文集拥有者
  56. start_at: string; //课程开始时间
  57. end_at: string; //课程结束时间
  58. sign_up_start_at: string; //报名开始时间
  59. sign_up_end_at: string; //报名结束时间
  60. content: string; //简介
  61. cover: string; //封面图片文件名
  62. cover_url?: string[]; //封面图片文件名
  63. member_count: number;
  64. join: TCourseJoinMode; //报名方式
  65. request_exp: TCourseExpRequest;
  66. my_status?: TCourseMemberStatus;
  67. my_status_id?: string;
  68. count_progressing?: number;
  69. number: number;
  70. members?: IMember[];
  71. created_at: string; //创建时间
  72. updated_at: string; //修改时间
  73. }
  74. export interface ICourseResponse {
  75. ok: boolean;
  76. message: string;
  77. data: ICourseDataResponse;
  78. }
  79. export interface ICourseListResponse {
  80. ok: boolean;
  81. message: string;
  82. data: {
  83. rows: ICourseDataResponse[];
  84. count: number;
  85. };
  86. }
  87. export interface ICourseCreateRequest {
  88. title: string;
  89. lang: string;
  90. studio: string;
  91. }
  92. export interface IAnthologyCreateRequest {
  93. title: string;
  94. lang: string;
  95. studio: string;
  96. }
  97. export interface ICourseNumberResponse {
  98. ok: boolean;
  99. message: string;
  100. data: {
  101. create: number;
  102. teach: number;
  103. study: number;
  104. };
  105. }
  106. export type TCourseMemberStatus =
  107. | "none" /*无*/
  108. | "normal" /*开放课程直接加入*/
  109. | "joined" /*开放课程已经加入*/
  110. | "applied" /**学生已经报名 管理员尚未审核 */
  111. | "canceled" /**学生取消报名 */
  112. | "agreed" /**学生/助教已经接受邀请 */
  113. | "disagreed" /**学生/助教已经拒绝邀请 */
  114. | "left" /**学生自己退出 */
  115. | "invited" /**管理员已经邀请学生加入 */
  116. | "revoked" /**管理员撤销邀请 */
  117. | "accepted" /**已经被管理员录取 */
  118. | "rejected" /**报名已经被管理员拒绝 */
  119. | "blocked"; /**被管理员清退 */
  120. export type TCourseMemberAction =
  121. | "join" /*加入自学课程*/
  122. | "apply" /**学生报名 */
  123. | "cancel" /**学生取消报名 */
  124. | "agree" /**学生/助教接受邀请 */
  125. | "disagree" /**学生/助教拒绝邀请 */
  126. | "leave" /**学生/助教自己退出 */
  127. | "invite" /**管理员邀请学生加入 */
  128. | "revoke" /**管理员撤销邀请 */
  129. | "accept" /**管理员录取 */
  130. | "reject" /**管理员拒绝 */
  131. | "block"; /**管理员清退 */
  132. interface IActionMap {
  133. action: TCourseMemberAction;
  134. status: TCourseMemberStatus;
  135. }
  136. export const actionMap = (action: TCourseMemberAction) => {
  137. const data: IActionMap[] = [
  138. { action: "join", status: "joined" },
  139. { action: "apply", status: "applied" },
  140. { action: "cancel", status: "canceled" },
  141. { action: "agree", status: "agreed" },
  142. { action: "disagree", status: "disagreed" },
  143. { action: "leave", status: "left" },
  144. { action: "invite", status: "invited" },
  145. { action: "revoke", status: "revoked" },
  146. { action: "accept", status: "accepted" },
  147. { action: "reject", status: "rejected" },
  148. { action: "block", status: "blocked" },
  149. ];
  150. const current = data.find((value) => value.action === action);
  151. return current?.status;
  152. };
  153. export interface ICourseMemberData {
  154. id?: string;
  155. user_id: string;
  156. course_id: string;
  157. channel_id?: string;
  158. channel?: IChannel;
  159. role?: TCourseRole;
  160. operating?: "invite" | "sign_up";
  161. user?: IUser;
  162. editor?: IUser;
  163. status?: TCourseMemberStatus;
  164. created_at?: string;
  165. updated_at?: string;
  166. }
  167. export interface ICourseMemberResponse {
  168. ok: boolean;
  169. message: string;
  170. data: ICourseMemberData;
  171. }
  172. export interface ICourseMemberListResponse {
  173. ok: boolean;
  174. message: string;
  175. data: {
  176. rows: ICourseMemberData[];
  177. role: TCourseRole;
  178. count: number;
  179. };
  180. }
  181. export interface ICourseMemberDeleteResponse {
  182. ok: boolean;
  183. message: string;
  184. data: boolean;
  185. }
  186. export interface ICourseUser {
  187. role: TCourseRole;
  188. channel_id?: string | null;
  189. }
  190. export interface ICourseCurrUserResponse {
  191. ok: boolean;
  192. message: string;
  193. data: ICourseUser;
  194. }
  195. export interface IExerciseListData {
  196. user: IUser;
  197. wbw: number;
  198. translation: number;
  199. question: number;
  200. html: string;
  201. }
  202. export interface ICourseExerciseResponse {
  203. ok: boolean;
  204. message: string;
  205. data: {
  206. rows: IExerciseListData[];
  207. count: number;
  208. };
  209. }