feat: add rest and graphql endpoints for study rooms

apps/api/package.json

@@ -28,6 +28,6 @@
   "devDependencies": {
     "@packages/key-types": "workspace:*",
     "@types/node": "20.8.3",
-    "wrangler": "3.88.0"
+    "wrangler": "3.85.0"
   }
 }

apps/api/src/graphql/resolvers/index.ts

@@ -3,6 +3,7 @@ import { coursesResolvers } from "$graphql/resolvers/courses";
 import { enrollmentHistoryResolvers } from "$graphql/resolvers/enrollment-history";
 import { gradesResolvers } from "$graphql/resolvers/grades";
 import { instructorsResolvers } from "$graphql/resolvers/instructors";
+import { studyRoomsResolvers } from "$graphql/resolvers/study-rooms";
 import { larcResolvers } from "$graphql/resolvers/larc.ts";
 import { searchResolvers } from "$graphql/resolvers/search";
 import { websocResolvers } from "$graphql/resolvers/websoc";
@@ -18,5 +19,6 @@ export const resolvers = mergeResolvers([
   searchResolvers,
   websocResolvers,
   weekResolvers,
+  studyRoomsResolvers,
   larcResolvers,
 ]);

apps/api/src/graphql/resolvers/study-rooms.ts

@@ -0,0 +1,23 @@
+import type { GraphQLContext } from "$graphql/graphql-context";
+import { studyRoomsQuerySchema } from "$schema";
+import { StudyRoomsService } from "$services";
+import { GraphQLError } from "graphql/error";
+
+export const studyRoomsResolvers = {
+  Query: {
+    studyRoom: async (_: unknown, { id }: { id: string }, { db }: GraphQLContext) => {
+      const service = new StudyRoomsService(db);
+      const res = await service.getStudyRoomById(id);
+      if (!res)
+        throw new GraphQLError(`Study room '${id}' not found`, {
+          extensions: { code: "NOT_FOUND" },
+        });
+      return res;
+    },
+    studyRooms: async (_: unknown, args: { query?: unknown }, { db }: GraphQLContext) => {
+      const service = new StudyRoomsService(db);
+      const validatedQuery = args.query ? studyRoomsQuerySchema.parse(args.query) : {};
+      return await service.getStudyRooms(validatedQuery);
+    },
+  },
+};

apps/api/src/graphql/schema/index.ts

@@ -5,6 +5,7 @@ import { enrollmentHistorySchema } from "./enrollment-history";
 import { enums } from "./enums";
 import { gradesSchema } from "./grades";
 import { instructorsSchema } from "./instructors";
+import { studyRoomsGraphQLSchema } from "./study-rooms";
 import { larcSchema } from "./larc";
 import { searchSchema } from "./search";
 import { websocSchema } from "./websoc";
@@ -39,5 +40,6 @@ export const typeDefs = mergeTypeDefs([
   searchSchema,
   websocSchema,
   weekSchema,
+  studyRoomsGraphQLSchema,
   larcSchema,
 ]);

apps/api/src/graphql/schema/study-rooms.ts

@@ -0,0 +1,31 @@
+export const studyRoomsGraphQLSchema = `#graphql
+  type Slot {
+    studyRoomId: String!
+    start: String!
+    end: String!
+    isAvailable: Boolean!
+  }
+
+  type StudyRoom {
+    id: String!
+    name: String!
+    capacity: Int!
+    location: String!
+    description: String
+    directions: String
+    techEnhanced: Boolean!
+    slots: [Slot]
+  }
+
+  input StudyRoomsQuery {
+    location: String
+    capacityMin: Int
+    capacityMax: Int
+    isTechEnhanced: Boolean
+  }
+
+  extend type Query {
+    studyRoom(id: String!): StudyRoom!
+    studyRooms(query: StudyRoomsQuery): [StudyRoom!]!
+  }
+`;

apps/api/src/rest/index.ts

@@ -7,6 +7,7 @@ import { gradesRouter } from "./routes/grades";
 import { instructorsRouter } from "./routes/instructors";
 import { larcRouter } from "./routes/larc.ts";
 import { pingRouter } from "./routes/ping";
+import { studyRoomsRouter } from "./routes/study-rooms";
 import { searchRouter } from "./routes/search";
 import { websocRouter } from "./routes/websoc";
 import { weekRouter } from "./routes/week";
@@ -22,6 +23,7 @@ restRouter.route("/ping", pingRouter);
 restRouter.route("/search", searchRouter);
 restRouter.route("/websoc", websocRouter);
 restRouter.route("/week", weekRouter);
+restRouter.route("/studyRooms", studyRoomsRouter);
 restRouter.route("/larc", larcRouter);
 
 export { restRouter };

apps/api/src/rest/routes/study-rooms.ts

@@ -0,0 +1,90 @@
+import { defaultHook } from "$hooks";
+import {
+  errorSchema,
+  responseSchema,
+  studyRoomSchema,
+  studyRoomsPathSchema,
+  studyRoomsQuerySchema,
+} from "$schema";
+import { StudyRoomsService } from "$services";
+import type { Bindings } from "$types/bindings";
+import { OpenAPIHono, createRoute } from "@hono/zod-openapi";
+import { database } from "@packages/db";
+
+const studyRoomsRouter = new OpenAPIHono<{ Bindings: Bindings }>({ defaultHook });
+
+const studyRoomByIdRoute = createRoute({
+  summary: "Retrieve a study room",
+  operationId: "studyRoomById",
+  tags: ["Study Rooms"],
+  method: "get",
+  path: "/{id}",
+  request: { params: studyRoomsPathSchema },
+  description: "Retrieves a study room by its ID.",
+  responses: {
+    200: {
+      content: { "application/json": { schema: responseSchema(studyRoomSchema) } },
+      description: "Successful operation",
+    },
+    404: {
+      content: { "application/json": { schema: errorSchema } },
+      description: "Study room not found",
+    },
+    422: {
+      content: { "application/json": { schema: errorSchema } },
+      description: "Parameters failed validation",
+    },
+    500: {
+      content: { "application/json": { schema: errorSchema } },
+      description: "Server error occurred",
+    },
+  },
+});
+
+const studyRoomsByFiltersRoute = createRoute({
+  summary: "Retrieve study rooms",
+  operationId: "studyRoomsByFilters",
+  tags: ["Study Rooms"],
+  method: "get",
+  path: "/",
+  request: { query: studyRoomsQuerySchema },
+  description:
+    "Retrieves study rooms matching the given filters. If no filters are provided, all rooms are returned.",
+  responses: {
+    200: {
+      content: {
+        "application/json": { schema: responseSchema(studyRoomSchema.array()) },
+      },
+      description: "Successful operation",
+    },
+    500: {
+      content: { "application/json": { schema: errorSchema } },
+      description: "Server error occurred",
+    },
+  },
+});
+
+// studyRoomsRouter.get("*");
+
+studyRoomsRouter.openapi(studyRoomByIdRoute, async (c) => {
+  const { id } = c.req.valid("param");
+  const service = new StudyRoomsService(database(c.env.DB.connectionString));
+  const res = await service.getStudyRoomById(id);
+  return res
+    ? c.json({ ok: true, data: studyRoomSchema.parse(res) }, 200)
+    : c.json({ ok: false, message: `Study room ${id} not found` }, 404);
+});
+
+studyRoomsRouter.openapi(studyRoomsByFiltersRoute, async (c) => {
+  const query = c.req.valid("query") || {}; // no filters required
+  const service = new StudyRoomsService(database(c.env.DB.connectionString));
+  return c.json(
+    {
+      ok: true,
+      data: studyRoomSchema.array().parse(await service.getStudyRooms(query)),
+    },
+    200,
+  );
+});
+
+export { studyRoomsRouter };

apps/api/src/schema/index.ts

@@ -7,3 +7,4 @@ export * from "./instructors";
 export * from "./search";
 export * from "./websoc";
 export * from "./week";
+export * from "./study-rooms";

apps/api/src/schema/study-rooms.ts

@@ -0,0 +1,30 @@
+import { z } from "@hono/zod-openapi";
+
+export const slotSchema = z.object({
+  studyRoomId: z.string(),
+  start: z.string().openapi({ format: "date-time" }),
+  end: z.string().openapi({ format: "date-time" }),
+  isAvailable: z.boolean(),
+});
+
+export const studyRoomSchema = z.object({
+  id: z.string(),
+  name: z.string(),
+  capacity: z.number().int(),
+  location: z.string(),
+  description: z.string().optional(),
+  directions: z.string().optional(),
+  techEnhanced: z.boolean(),
+  slots: z.array(slotSchema).optional(),
+});
+
+export const studyRoomsPathSchema = z.object({
+  id: z.string(),
+});
+
+export const studyRoomsQuerySchema = z.object({
+  location: z.string().optional(),
+  capacityMin: z.coerce.number().int().optional(),
+  capacityMax: z.coerce.number().int().optional(),
+  isTechEnhanced: z.coerce.boolean().optional(),
+});

apps/api/src/services/index.ts

@@ -6,3 +6,4 @@ export * from "./instructors";
 export * from "./search";
 export * from "./websoc";
 export * from "./week";
+export * from "./study-rooms";

apps/api/src/services/study-rooms.ts

@@ -0,0 +1,30 @@
+import type { studyRoomsQuerySchema } from "$schema";
+import type { z } from "@hono/zod-openapi";
+import type { database } from "@packages/db";
+import { and, eq, gte, lte } from "@packages/db/drizzle";
+import { studyRoom } from "@packages/db/schema";
+
+type StudyRoomsServiceInput = z.infer<typeof studyRoomsQuerySchema>;
+
+export class StudyRoomsService {
+  constructor(private readonly db: ReturnType<typeof database>) {}
+
+  async getStudyRoomById(id: string) {
+    const [room] = await this.db.select().from(studyRoom).where(eq(studyRoom.id, id));
+    return room || null;
+  }
+
+  async getStudyRooms(input: StudyRoomsServiceInput) {
+    const conditions = [];
+    if (input.location) conditions.push(eq(studyRoom.location, input.location));
+    if (input.capacityMin) conditions.push(gte(studyRoom.capacity, input.capacityMin));
+    if (input.capacityMax) conditions.push(lte(studyRoom.capacity, input.capacityMax));
+    if (input.isTechEnhanced !== undefined)
+      conditions.push(eq(studyRoom.techEnhanced, input.isTechEnhanced));
+
+    return await this.db
+      .select()
+      .from(studyRoom)
+      .where(conditions.length ? and(...conditions) : undefined);
+  }
+}

apps/data-pipeline/larc-scraper/package.json

@@ -18,6 +18,6 @@
   },
   "devDependencies": {
     "@types/node": "20.8.3",
-    "wrangler": "3.88.0"
+    "wrangler": "3.85.0"
   }
 }

apps/data-pipeline/larc-scraper/worker-configuration.d.ts

@@ -1,5 +1,6 @@
 // Generated by Wrangler by running `wrangler types --x-include-runtime`
 
-interface Env {
-  DB: Hyperdrive;
+export {};
+declare global {
+  const DB: Hyperdrive;
 }

apps/data-pipeline/study-location-scraper/package.json

@@ -19,6 +19,6 @@
   "devDependencies": {
     "@types/node": "20.8.3",
     "domhandler": "5.0.3",
-    "wrangler": "3.88.0"
+    "wrangler": "3.85.0"
   }
 }

apps/data-pipeline/study-location-scraper/worker-configuration.d.ts

@@ -1,5 +1,6 @@
 // Generated by Wrangler by running `wrangler types --x-include-runtime`
 
-interface Env {
-  DB: Hyperdrive;
+export {};
+declare global {
+  const DB: Hyperdrive;
 }

apps/data-pipeline/websoc-scraper/package.json

@@ -19,6 +19,6 @@
   },
   "devDependencies": {
     "@types/node": "20.8.3",
-    "wrangler": "3.88.0"
+    "wrangler": "3.85.0"
   }
 }

apps/key-manager/package.json

@@ -45,6 +45,6 @@
     "postcss": "8.4.49",
     "tailwindcss": "3.4.15",
     "typescript": "5.6.3",
-    "wrangler": "3.88.0"
+    "wrangler": "3.85.0"
   }
 }