Add typeshare for automatic server-side type conversion (#664)

Author: terror

Cargo.lock

@@ -7,16 +7,24 @@ publish = false
 [workspace]
 members = ["crates/*", "tools/changelog-generator", "tools/scraper"]
 
-[dependencies]
+[workspace.dependencies]
 anyhow = "1.0.98"
+chrono = "0.4.41"
+serde = { version = "1.0.219", features = ["derive"] }
+serde_json = "1.0.140"
+tokio = { version = "1.45.0", features = ["rt-multi-thread", "macros"] }
+typeshare = "1.0.4"
+
+[dependencies]
+anyhow = { workspace = true }
 async-mongodb-session = { version = "3.0.0", default-features = false }
 async-session = "3.0.0"
 axum = { version = "0.7.9", features = ["json"] }
 axum-extra = { version = "0.9.6", features = ["cookie", "typed-header"] }
 axum-server = "0.6.0"
 base64 = "0.21.7"
 bytes = "1.10.1"
-chrono = "0.4.41"
+chrono = { workspace = true }
 clap = { version = "4.5.38", features = ["derive"] }
 db = { path = "crates/db" }
 dotenv = "0.15.0"
@@ -30,14 +38,15 @@ rand = "0.9.1"
 reqwest = { version = "0.11.27", default-features = false, features = [ "blocking", "json", "rustls-tls"] }
 rusoto_core = { version = "0.48.0", default-features = false, features = [ "rustls", ] }
 rusoto_s3 = { version = "0.48.0", default-features = false, features = [ "rustls", ] }
-serde = { version = "1.0.219", features = ["derive"] }
-serde_json = "1.0.140"
+serde = { workspace = true }
+serde_json = { workspace = true }
 sha2 = "0.10.9"
-tokio = { version = "1.45.0", features = ["rt-multi-thread", "macros"] }
+tokio = { workspace = true }
 tower = { version = "0.4.13", features = ["tracing", "limit", "buffer"] }
 tower-http = { version = "0.5.2", features = ["cors", "fs", "trace"] }
 tower_governor = "0.2.0"
 tracing = "0.1.41"
+typeshare = { workspace = true }
 url = "2.5.4"
 walkdir = "2.5.0"
 

Cargo.toml

@@ -6,9 +6,9 @@ import { IoIosArrowDown, IoIosArrowUp } from 'react-icons/io';
 import { Link } from 'react-router-dom';
 import { twMerge } from 'tailwind-merge';
 
+import { Instructor } from '../lib/types';
 import { compareTerms } from '../lib/utils';
 import { Course } from '../model/Course';
-import { Instructor } from '../model/Instructor';
 import { TermAverage } from '../model/TermAverage';
 
 type InstructorLinkProps = {

client/src/components/CourseAverages.tsx

@@ -1,3 +1,5 @@
+import type { Subscription } from '../lib/types';
+import type { UserResponse } from '../lib/types';
 import { GetCourseReviewsInteractionPayload } from '../model/GetCourseReviewsInteractionsPayload';
 import type { GetCourseWithReviewsPayload } from '../model/GetCourseWithReviewsPayload';
 import { GetCoursesPayload } from '../model/GetCoursesPayload';
@@ -7,8 +9,6 @@ import { GetReviewsPayload } from '../model/GetReviewsPayload';
 import type { InteractionKind } from '../model/Interaction';
 import type { Notification } from '../model/Notification';
 import type { SearchResults } from '../model/SearchResults';
-import type { Subscription } from '../model/Subscription';
-import type { UserResponse } from '../model/User';
 
 const prefix = '/api';
 

client/src/lib/repo.ts

@@ -0,0 +1,23 @@
+/*
+ Generated by typeshare 1.11.0
+*/
+
+export interface Instructor {
+  name: string;
+  nameNgrams?: string;
+  term: string;
+}
+
+export interface Subscription {
+  courseId: string;
+  userId: string;
+}
+
+export interface User {
+  id: string;
+  mail: string;
+}
+
+export interface UserResponse {
+  user?: User;
+}

client/src/lib/types.ts

@@ -1,14 +1,16 @@
 import { groupBy } from 'lodash';
 
+import { Instructor } from '../lib/types';
 import { Course } from '../model/Course';
-import { Instructor } from '../model/Instructor';
 import type { Schedule } from '../model/Schedule';
 
 const TERM_ORDER = ['Winter', 'Summer', 'Fall'];
 
 /**
  * Groups course instructors by their terms, but only for current terms.
+ *
  * Creates empty arrays for current terms that have no instructors.
+ *
  * @param {Course} course - The course object containing instructors and terms
  * @returns {Record<string, Instructor[]>} Object mapping terms to arrays of instructors
  */
@@ -33,9 +35,11 @@ export const groupCurrentCourseTermInstructors = (
 
 /**
  * Determines the current and next two academic terms based on the current date.
+ *
  * - May-July: Returns [Summer current, Fall current, Winter next]
  * - August-December: Returns [Fall current, Winter next, Summer next]
  * - January-April: Returns [Fall previous, Winter current, Summer current]
+ *
  * @returns {[string, string, string]} Array of three consecutive terms
  */
 export const getCurrentTerms = (): [string, string, string] => {
@@ -57,9 +61,11 @@ export const getCurrentTerms = (): [string, string, string] => {
 
 /**
  * Determines the current academic term based on the current date.
+ *
  * - May-July: Summer <year>
  * - August-December: Fall <year>
  * - January-April: Winter <year>
+ *
  * @returns string The current term
  */
 export const getCurrentTerm = (): string => {
@@ -80,7 +86,9 @@ export const getCurrentTerm = (): string => {
 
 /**
  * Compares two academic terms for sorting.
+ *
  * Terms are compared first by year, then by season according to TERM_ORDER.
+ *
  * @param {string} a - First term string (e.g., "Fall 2023")
  * @param {string} b - Second term string (e.g., "Winter 2024")
  * @returns {number} Negative if a comes before b, positive if b comes before a, 0 if equal
@@ -93,7 +101,9 @@ export const compareTerms = (a: string, b: string): number => {
 
 /**
  * Sorts an array of academic terms chronologically.
+ *
  * Uses compareTerms to determine order.
+ *
  * @param {string[]} terms - Array of term strings to sort
  * @returns {string[]} Sorted array of terms
  */
@@ -103,8 +113,11 @@ export const sortTerms = (terms: string[]): string[] => {
 
 /**
  * Sorts course schedules by block type and number.
+ *
  * Order priority: Lec > Lab > Seminar > Tut > Conf
+ *
  * Within each type, sorts numerically by block number.
+ *
  * @param {Schedule[]} schedules - Array of course schedules to sort
  * @returns {Schedule[]} Sorted array of schedules
  */
@@ -125,7 +138,9 @@ export const sortSchedulesByBlocks = (schedules: Schedule[]): Schedule[] => {
 
 /**
  * Converts a course ID to a URL-friendly parameter format.
+ *
  * Example: "COMP202" -> "comp-202"
+ *
  * @param {string} courseId - The course ID to convert
  * @returns {string} URL-friendly course ID
  */
@@ -134,6 +149,7 @@ export const courseIdToUrlParam = (courseId: string): string =>
 
 /**
  * Capitalizes the first character of a string.
+ *
  * @param {string} s - The string to capitalize
  * @returns {string} Capitalized string
  */
@@ -142,7 +158,9 @@ export const capitalize = (s: string): string =>
 
 /**
  * Ensures a string ends with a period.
+ *
  * Adds a period if one is not already present.
+ *
  * @param {string} s - The string to punctuate
  * @returns {string} String ending with a period
  */
@@ -153,8 +171,11 @@ const COURSE_CODE_REGEX = /^(([A-Z0-9]){4} [0-9]{3}(D1|D2|N1|N2|J1|J2|J3)?)$/;
 
 /**
  * Validates if a string matches the course code format.
+ *
  * Valid format: 4 alphanumeric chars + space + 3 digits + optional suffix
+ *
  * Suffixes: D1, D2, N1, N2, J1, J2, J3
+ *
  * @param {string} s - The string to validate
  * @returns {boolean} True if string is a valid course code
  */
@@ -163,7 +184,9 @@ export const isValidCourseCode = (s: string): boolean =>
 
 /**
  * Inserts a delimiter between the subject and number portions of a course code.
+ *
  * Example: spliceCourseCode("COMP202", "-") -> "COMP-202"
+ *
  * @param {string} courseCode - The course code to splice
  * @param {string} delimiter - The delimiter to insert
  * @returns {string} Course code with delimiter inserted
@@ -175,14 +198,17 @@ export const spliceCourseCode = (
 
 /**
  * Rounds a number to 2 decimal places.
+ *
  * @param {number} n - Number to round
  * @returns {number} Rounded number
  */
 export const round2Decimals = (n: number): number => Math.round(n * 100) / 100;
 
 /**
  * Performs a true modulo operation (different from JavaScript's % operator).
+ *
  * Always returns a positive number, even when inputs are negative.
+ *
  * @param {number} n - Dividend
  * @param {number} m - Divisor
  * @returns {number} Positive modulo result
@@ -191,6 +217,7 @@ export const mod = (n: number, m: number): number => ((n % m) + m) % m;
 
 /**
  * Custom error class for date-related errors.
+ *
  * @extends Error
  */
 export class InvalidDateError extends Error {
@@ -202,8 +229,11 @@ export class InvalidDateError extends Error {
 
 /**
  * Converts a date to a human-readable "time ago" string.
+ *
  * Handles various time units from seconds to years.
+ *
  * Throws InvalidDateError for null, undefined, invalid formats, or future dates.
+ *
  * @param {Date | string | number | null | undefined} date - Date to convert
  * @returns {string} Human-readable time difference (e.g., "2 hours ago")
  * @throws {InvalidDateError} If date is invalid, missing, or in the future

client/src/lib/utils.ts

@@ -1,4 +1,4 @@
-import type { Instructor } from './Instructor';
+import type { Instructor } from '../lib/types';
 import type { ReqNode } from './Requirements';
 import type { Schedule } from './Schedule';
 

client/src/model/Course.ts

@@ -1,4 +1,4 @@
-import type { Instructor } from './Instructor';
+import type { Instructor } from '../lib/types';
 import type { Review } from './Review';
 
 export type GetInstructorPayload = {