fetch course from backend

Author: aster-void

bun.lock

@@ -29,7 +29,8 @@
       "dependencies": {
         "@elysiajs/cors": "^1.3.3",
         "@libsql/client": "^0.15.10",
-        "@sinclair/typebox": "^0.34.37",
+        "@packages/class_data": "workspace:*",
+        "@sinclair/typebox": "^0.34.38",
         "better-auth": "^1.3.1",
         "drizzle-orm": "^0.44.3",
         "elysia": "^1.3.5",

packages/models/atoms.ts

@@ -8,21 +8,32 @@ export const Stream = t.UnionEnum(["s1", "s2", "s3", "l1", "l2", "l3"]);
 /**
  * 授業コード
  * 例: 30003
- * フォーマットが不明なので、 String にしておく。後の調査でフォーマットを探し、 Regex に変更したい。
  */
 export type CourseCode = typeof CourseCode.static;
-export const CourseCode = t.String();
+export const CourseCode = t.RegExp("^\\d{5}$");
 
 /**
  * 共通科目コード
  * 例:
- * - CAS-FC1871L1
  * - XAB-CD1001L2
- * 参考: https://www.u-tokyo.ac.jp/ja/students/classes/course-numbering.html
+ * - CAS-FC1871L1
+ * - CAS-GC1L37S4
+ * - CASPG1F40L3 // 絶対入力ミスだが、データにあるので対応しなければならない
+ * 仕様: https://www.u-tokyo.ac.jp/ja/students/classes/course-numbering.html
+ * 本当は CommonSubjectCode になるはずだが、公式が勝手に CommonCourseCode と読んでいる
  */
-export type CommonSubjectCode = typeof CommonSubjectCode.static;
-export const CommonSubjectCode = t.RegExp(
-  "^[A-Z]{3}-[A-Z]{2}[0-9]{3}[A-Z]{1}$",
+export type CommonCourseCode = typeof CommonCourseCode.static;
+export const CommonCourseCode = t.RegExp(
+  `
+  ^[CFG] ${/* [1] 課程コード */ ""}
+  (?:LA|ME|EN|LE|SC|AG|EC|AS|ED|PH|GL) ${/* [2] 開講学部・研究科（教育部）コード */ ""}
+  -?
+  [A-Z]{2} ${/* [3] 開講学科・専攻等コード */ ""}
+  [1-7] ${/* [4] レベルコード */ ""}
+  [0-9a-zA-Z]{3} ${/* [5] 整理番号 */ ""}
+  [LSEPTZ] ${/* [6] 授業形態コード */ ""}
+  [123459] ${/* [7] 使用言語コード */ ""}
+  $`.replaceAll(/\s/g, ""),
 );
 
 /**
@@ -60,17 +71,19 @@ export const Evaluation = t.UnionEnum(["試験", "レポート", "出席", "平
  * 単位の種類。
  */
 export type ClassType = typeof ClassType.static;
-export const ClassType = t.UnionEnum([
+export const ClassType = t.UnionEnum(["基礎", "要求", "主題", "総合", "展開"]);
+
+export type ClassSeries = typeof ClassSeries.static;
+export const ClassSeries = t.UnionEnum([
   "基礎",
-  "総合",
   "要求",
   "主題",
   "展開",
-  "L",
-  "A",
-  "B",
-  "C",
-  "D",
-  "E",
-  "F",
+  "総合L",
+  "総合A",
+  "総合B",
+  "総合C",
+  "総合D",
+  "総合E",
+  "総合F",
 ]);

packages/models/models.ts

@@ -4,8 +4,9 @@ export * from "./mappings.ts";
 import { t } from "elysia";
 
 import {
+  ClassSeries,
   ClassType,
-  CommonSubjectCode,
+  CommonCourseCode,
   CourseCode,
   DayPeriod,
   Semester,
@@ -28,41 +29,50 @@ export type Course = typeof Course.static;
 export const Course = t.Object({
   /// 基本情報
   code: CourseCode,
-  ccCode: CommonSubjectCode,
+  ccCode: CommonCourseCode,
+  /** 講義名 (例: 大規模計算) */
   titleJp: t.String(),
+  /** 講義名 (例: Large-Scale Computing) */
   titleEn: t.String(),
   lecturer: t.String(),
   lecturerEn: t.String(),
 
   /// 講義の内容に関する情報
   /** 授業詳細 */
   detail: t.String(),
-  /** 授業スケジュール */
+  /** 授業スケジュール (内容的な方) */
   schedule: t.String(),
-  notes: t.String(), // メモ (なんでも良さそう)
+  notes: t.String(), // 備考
 
   /// 授業の開催に関する情報
   semester: Semester,
-  /** 開催教室 */
+  /** 開催教室 (例: 駒場5号館 523教室) */
   classroom: t.String(),
-  shortenedClassroom: t.String(), // 短縮表示っぽい
-  /** 授業の方法? なぜ複数形になった？ */
+  /** 開催教室の短縮表示 (例: 523) */
+  shortenedClassroom: t.String(),
+  /**
+   * 授業の方法
+   * 例: 講義形式であるが, 担当教員によっては適宜小テストやレポートを課すことがある. 成績評価は主として期末試験によって行なう.
+   */
   methods: t.String(),
   /** 授業の長さ (分) (例: 90) */
   time: t.Number(),
+  dayPeriod: t.Union([t.Array(DayPeriod), t.Literal("集中")]),
 
   /// 講義のカテゴライジングに関する情報
   /** 授業の種別 (例: 基礎) */
   type: ClassType,
   /** 授業のカテゴリー (例: 数理科学) */
   category: t.String(),
-  shortenedCategory: t.String(),
-  dayPeriod: t.Union([t.Array(DayPeriod), t.Literal("集中")]),
+  /**
+   * 科目区分+系列 (例: 基礎、総合A)
+   * 授業カテゴリの短縮表示**じゃない**！！！！
+   */
+  shortenedCategory: ClassSeries,
 
   /// 単位に関する情報
   /** 単位数 (例: 2) */
   credits: t.Number(),
-  /** 評価方法 */
   /** 評価方法 (例: 出席状況、提出物などの状況、研究の達成度などをもとに評価します。) */
   evaluation: t.String(),
   shortenedEvaluation: t.String(),
@@ -79,6 +89,8 @@ export const Course = t.Object({
   importance: t.Array(t.Array(t.String())),
 });
 
+export type CourseList = typeof CourseList.static;
+export const CourseList = t.Array(Course);
 /**
  * code -> Course
  */

packages/models/package.json

@@ -3,7 +3,8 @@
   "type": "module",
   "private": true,
   "exports": {
-    ".": "./models.ts"
+    ".": "./models.ts",
+    "./transformer": "./transformer/transformer.ts"
   },
   "devDependencies": {
     "@types/bun": "^1.2.18"

packages/models/transformer/transformer.ts

@@ -0,0 +1,9 @@
+import type { CourseCollection, CourseList } from "@packages/models";
+
+export function courseListToCourseCollection(courseList: CourseList) {
+  const collection: CourseCollection = {};
+  for (const course of courseList) {
+    collection[course.code] = course;
+  }
+  return collection;
+}

packages/server/app.ts

@@ -1,11 +1,13 @@
 import { cors } from "@elysiajs/cors";
 import { Elysia } from "elysia";
 import { betterAuth } from "./lib/auth.ts";
+import coursesRouter from "./router/courses.ts";
 
 export const app = new Elysia({
   prefix: "/api",
 })
   .use(betterAuth)
-  .use(cors());
+  .use(cors())
+  .group("/courses", (route) => route.use(coursesRouter));
 
 export type App = typeof app;

packages/server/domain/transform.ts

@@ -0,0 +1,15 @@
+import { Course, type CourseCollection } from "@packages/models";
+import { Value } from "@sinclair/typebox/value";
+
+export function transformJSONToCourseCollection(coursesJSON: unknown) {
+  if (!Array.isArray(coursesJSON)) {
+    throw new Error("Invalid courses JSON: not array");
+  }
+
+  const collection: CourseCollection = {};
+  for (const rawCourse of coursesJSON) {
+    const course = Value.Parse(Course, rawCourse);
+    collection[course.code] = course;
+  }
+  return collection;
+}

packages/server/lib/utils/dateconv.test.ts

@@ -0,0 +1,16 @@
+import { describe, expect, it } from "bun:test";
+import { toHttpDate, toUnixTime } from "./dateconv.ts";
+
+describe("toHttpDate", () => {
+  it("should format a date as an HTTP date string", () => {
+    const date = new Date(Date.UTC(2006, 1, 2, 15, 4, 5));
+    expect(toHttpDate(date)).toBe("Mon, 02 Jan 2006 15:04:05 GMT");
+  });
+});
+
+describe("toUnixTime", () => {
+  it("should convert a date to a Unix timestamp", () => {
+    const date = new Date(Date.UTC(1971, 0, 1, 0, 0, 0));
+    expect(toUnixTime(date)).toBe(31536000);
+  });
+});

packages/server/lib/utils/dateconv.ts

@@ -0,0 +1,7 @@
+export function toUnixTime(date: Date) {
+  return Math.floor(date.getTime() / 1000);
+}
+
+export function toHttpDate(date: Date) {
+  return date.toUTCString();
+}

packages/server/package.json

@@ -20,7 +20,8 @@
   "dependencies": {
     "@elysiajs/cors": "^1.3.3",
     "@libsql/client": "^0.15.10",
-    "@sinclair/typebox": "^0.34.37",
+    "@packages/class_data": "workspace:*",
+    "@sinclair/typebox": "^0.34.38",
     "better-auth": "^1.3.1",
     "drizzle-orm": "^0.44.3",
     "elysia": "^1.3.5"