chore: 🔧 clean up workspace, add utils [skip ci]

.eslintrc.cjs

@@ -19,6 +19,7 @@ const config = {
   ],
   rules: {
     "no-unused-vars": "off",
+    "@typescript-eslint/consistent-type-imports": "error",
     "@typescript-eslint/no-unused-vars": [
       "error",
       {

.github/workflows/deploy-prod.yml

@@ -46,8 +46,7 @@ jobs:
         uses: ./.github/actions/setup-node-and-pnpm
 
       - name: Install dependencies
-        # Ensure NODE_ENV != production so pnpm will install devDependencies!!!
-        run: NODE_ENV=development pnpm install --frozen-lockfile
+        run: pnpm install --frozen-lockfile
 
       - name: Build API
         run: pnpm build --filter="@apps/api"
@@ -72,8 +71,7 @@ jobs:
         uses: ./.github/actions/setup-node-and-pnpm
 
       - name: Install dependencies
-        # Ensure NODE_ENV != production so pnpm will install devDependencies!!!
-        run: NODE_ENV=development pnpm install --frozen-lockfile
+        run: pnpm install --frozen-lockfile
 
       - name: Build documentation
         run: pnpm build --filter="@apps/docs"
@@ -96,8 +94,7 @@ jobs:
         uses: ./.github/actions/setup-node-and-pnpm
 
       - name: Install dependencies
-        # Ensure NODE_ENV != production so pnpm will install devDependencies!!!
-        run: NODE_ENV=development pnpm install --frozen-lockfile
+        run: pnpm install --frozen-lockfile
 
       - name: Build services
         run: pnpm build --filter="@services/*"

.github/workflows/validate-pull-request.yml

@@ -26,8 +26,8 @@ jobs:
       - name: Setup Node.js and pnpm
         uses: ./.github/actions/setup-node-and-pnpm
 
-      - name: Install devDependencies
-        run: pnpm install --dev --frozen-lockfile --ignore-scripts --workspace-root
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile --ignore-scripts --workspace-root
 
       - name: Lint pull request title
         run: echo ${{ toJSON(github.event.pull_request.title) }} | npx --no -- commitlint

.npmrc

@@ -1 +1,2 @@
 engine-strict = true
+public-hoist-pattern[]=*prisma*

apps/api/package.json

@@ -27,7 +27,8 @@
     "@graphql-tools/utils": "10.0.13",
     "@libs/db": "workspace:^",
     "@libs/lambda": "workspace:^",
-    "@libs/uc-irvine-api": "workspace:^",
+    "@libs/uc-irvine-lib": "workspace:^",
+    "@libs/utils": "workspace:^",
     "@libs/websoc-utils": "workspace:^",
     "@peterportal-api/types": "workspace:^",
     "@services/websoc-proxy": "workspace:^",

apps/api/src/global.d.ts

@@ -9,11 +9,13 @@
  * Virtual module for caching course information during build time.
  */
 declare module "virtual:courses" {
+  // eslint-disable-next-line @typescript-eslint/consistent-type-imports
   declare const courses: Record<string, import("@peterportal-api/types").Course>;
 }
 /**
  * Virtual module for caching instructor information during build time.
  */
 declare module "virtual:instructors" {
+  // eslint-disable-next-line @typescript-eslint/consistent-type-imports
   declare const instructors: Record<string, import("@peterportal-api/types").Instructor>;
 }

apps/api/src/lib/utils.ts

@@ -1,5 +1,5 @@
-import { Course as PrismaCourse } from "@libs/db";
-import {
+import type { Course as PrismaCourse } from "@libs/db";
+import type {
   Course,
   CourseLevel,
   CoursePreview,

apps/api/src/routes/v1/graphql/+config.ts

@@ -1,7 +1,7 @@
 import { cpSync, mkdirSync } from "node:fs";
 import { join, resolve } from "node:path";
 
-import { ApiPropsOverride } from "@bronya.js/api-construct";
+import type { ApiPropsOverride } from "@bronya.js/api-construct";
 
 import { esbuildOptions, constructs } from "../../../../bronya.config";
 

apps/api/src/routes/v1/graphql/+endpoint.ts

@@ -1,7 +1,8 @@
 import { join } from "node:path";
 import { parse } from "node:url";
 
-import { ApolloServer, HeaderMap, HTTPGraphQLRequest } from "@apollo/server";
+import type { HTTPGraphQLRequest } from "@apollo/server";
+import { ApolloServer, HeaderMap } from "@apollo/server";
 import {
   ApolloServerPluginLandingPageLocalDefault,
   ApolloServerPluginLandingPageProductionDefault,

apps/api/src/routes/v1/rest/calendar/+endpoint.ts

@@ -1,6 +1,6 @@
 import { PrismaClient } from "@libs/db";
 import { createHandler } from "@libs/lambda";
-import { getTermDateData } from "@libs/uc-irvine-api/registrar";
+import { getTermDateData } from "@libs/uc-irvine-lib/registrar";
 import type { Quarter, QuarterDates } from "@peterportal-api/types";
 import { ZodError } from "zod";
 

apps/api/src/routes/v1/rest/courses/lib.ts

@@ -1,6 +1,6 @@
-import { Prisma } from "@libs/db";
+import type { Prisma } from "@libs/db";
 
-import { Query } from "./schema";
+import type { Query } from "./schema";
 
 /**
  * Constructs a Prisma query for the given filter parameters.

apps/api/src/routes/v1/rest/courses/{id}/+config.ts

@@ -1,4 +1,4 @@
-import { ApiPropsOverride } from "@bronya.js/api-construct";
+import type { ApiPropsOverride } from "@bronya.js/api-construct";
 
 import { esbuildOptions, constructs } from "../../../../../../bronya.config";
 

apps/api/src/routes/v1/rest/grades/{id}/lib.ts

@@ -1,4 +1,5 @@
-import { GradesSection, Prisma } from "@libs/db";
+import type { GradesSection, Prisma } from "@libs/db";
+import { notNull } from "@libs/utils";
 import type {
   AggregateGrades,
   AggregateGradesByOffering,
@@ -13,12 +14,7 @@ import type {
 } from "@peterportal-api/types";
 import { geCodes } from "@peterportal-api/types";
 
-import { Query } from "./schema";
-
-/**
- * type guard that asserts input is defined
- */
-export const notNull = <T>(x: T): x is NonNullable<T> => x != null;
+import type { Query } from "./schema";
 
 /**
  * Returns the lexicographical ordering of two elements.

apps/api/src/routes/v1/rest/instructors/lib.ts

@@ -1,6 +1,6 @@
-import { Prisma } from "@libs/db";
+import type { Prisma } from "@libs/db";
 
-import { Query } from "./schema";
+import type { Query } from "./schema";
 
 /**
  * Constructs a Prisma query for the given filter parameters.

apps/api/src/routes/v1/rest/instructors/{id}/+config.ts

@@ -1,4 +1,4 @@
-import { ApiPropsOverride } from "@bronya.js/api-construct";
+import type { ApiPropsOverride } from "@bronya.js/api-construct";
 
 import { esbuildOptions, constructs } from "../../../../../../bronya.config";
 

apps/api/src/routes/v1/rest/larc/lib.ts

@@ -1,4 +1,4 @@
-import { Quarter } from "@peterportal-api/types";
+import type { Quarter } from "@peterportal-api/types";
 
 export const quarterToLarcSuffix = (quarter: Exclude<Quarter, "Summer10wk">): string => {
   switch (quarter) {

apps/api/src/routes/v1/rest/websoc/+config.ts

@@ -1,4 +1,4 @@
-import { ApiPropsOverride } from "@bronya.js/api-construct";
+import type { ApiPropsOverride } from "@bronya.js/api-construct";
 import {
   Effect,
   ManagedPolicy,

apps/api/src/routes/v1/rest/websoc/+endpoint.ts

@@ -1,7 +1,8 @@
 import { PrismaClient } from "@libs/db";
 import { createHandler } from "@libs/lambda";
-import type { WebsocAPIResponse } from "@libs/uc-irvine-api/websoc";
-import { combineAndNormalizeResponses, notNull, sortResponse } from "@libs/websoc-utils";
+import type { WebsocAPIResponse } from "@libs/uc-irvine-lib/websoc";
+import { notNull } from "@libs/utils";
+import { combineAndNormalizeResponses, sortResponse } from "@libs/websoc-utils";
 import { ZodError } from "zod";
 
 import { APILambdaClient } from "./APILambdaClient";

apps/api/src/routes/v1/rest/websoc/APILambdaClient.ts

@@ -1,6 +1,7 @@
-import { InvokeCommand, LambdaClient, LambdaClientConfig } from "@aws-sdk/client-lambda";
+import type { LambdaClientConfig } from "@aws-sdk/client-lambda";
+import { InvokeCommand, LambdaClient } from "@aws-sdk/client-lambda";
 import { zeroUUID } from "@libs/lambda";
-import type { WebsocAPIResponse } from "@libs/uc-irvine-api/websoc";
+import type { WebsocAPIResponse } from "@libs/uc-irvine-lib/websoc";
 import type { Department, TermData } from "@peterportal-api/types";
 import type { APIGatewayProxyEvent, APIGatewayProxyResult, Context } from "aws-lambda";
 

apps/api/src/routes/v1/rest/websoc/lib.ts

@@ -1,5 +1,6 @@
-import { Prisma } from "@libs/db";
-import { WebsocAPIOptions } from "@libs/uc-irvine-api/websoc";
+import type { Prisma } from "@libs/db";
+import type { WebsocAPIOptions } from "@libs/uc-irvine-lib/websoc";
+import { notNull } from "@libs/utils";
 
 import type { Query } from "./schema";
 
@@ -9,11 +10,6 @@ import type { Query } from "./schema";
 export const fulfilled = <T>(value: PromiseSettledResult<T>): value is PromiseFulfilledResult<T> =>
   value.status === "fulfilled";
 
-/**
- * type guard that asserts input is defined
- */
-export const notNull = <T>(x: T): x is NonNullable<T> => x != null;
-
 /**
  * Converts a 12-hour time string into number of minutes since midnight.
  * @param time The time string to parse.

apps/api/src/routes/v1/rest/websoc/{id}/+config.ts

@@ -1,4 +1,4 @@
-import { ApiPropsOverride } from "@bronya.js/api-construct";
+import type { ApiPropsOverride } from "@bronya.js/api-construct";
 import {
   Effect,
   ManagedPolicy,

apps/api/src/routes/v1/rest/week/lib.ts

@@ -1,5 +1,5 @@
-import { CalendarTerm } from "@libs/db";
-import { Quarter } from "@peterportal-api/types";
+import type { CalendarTerm } from "@libs/db";
+import type { Quarter } from "@peterportal-api/types";
 
 const DAY_MS = 24 * 60 * 60 * 1000;
 const WEEK_MS = 7 * DAY_MS;

apps/docs/package.json

@@ -2,6 +2,7 @@
   "name": "@apps/docs",
   "version": "0.0.0",
   "private": true,
+  "description": "The documentation site for API",
   "scripts": {
     "build": "docusaurus build",
     "dev": "docusaurus start"

libs/db/package.json

@@ -2,6 +2,7 @@
   "name": "@libs/db",
   "version": "0.0.0",
   "private": true,
+  "description": "Wrapper package for shared Prisma Client",
   "license": "MIT",
   "type": "module",
   "main": "index.ts",

libs/lambda/package.json

@@ -2,6 +2,7 @@
   "name": "@libs/lambda",
   "version": "0.0.0",
   "private": true,
+  "description": "Helpers for handling Lambda requests",
   "license": "MIT",
   "type": "module",
   "main": "src/index.ts",

libs/uc-irvine-api/package.json → libs/uc-irvine-lib/package.json

@@ -1,8 +1,8 @@
 {
-  "name": "@libs/uc-irvine-api",
+  "name": "@libs/uc-irvine-lib",
   "version": "0.10.8",
   "private": true,
-  "description": "SDK for various UC Irvine services",
+  "description": "Libraries to interface with various UC Irvine data sources",
   "keywords": [],
   "homepage": "https://docs.api-next.peterportal.org",
   "bugs": {
@@ -11,7 +11,7 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/icssc/peterportal-api-next",
-    "directory": "libs/uc-irvine-api"
+    "directory": "libs/uc-irvine-lib"
   },
   "license": "MIT",
   "type": "module",
@@ -55,8 +55,5 @@
   "engines": {
     "node": "20",
     "pnpm": "8"
-  },
-  "publishConfig": {
-    "access": "public"
   }
 }

libs/uc-irvine-api/src/registrar/index.ts → libs/uc-irvine-lib/src/registrar/index.ts

@@ -1,4 +1,5 @@
-import { QuarterDates, quarters } from "@peterportal-api/types";
+import type { QuarterDates } from "@peterportal-api/types";
+import { quarters } from "@peterportal-api/types";
 import { load } from "cheerio";
 import fetch from "cross-fetch";
 

libs/uc-irvine-lib/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": ["../../tsconfig.json"],
+}

libs/utils/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@libs/utils",
+  "version": "0.0.0",
+  "private": true,
+  "description": "Miscellaneous utilities used by the API's components",
+  "license": "MIT",
+  "main": "src/index.ts"
+}

libs/utils/src/index.ts

@@ -0,0 +1,12 @@
+/**
+ * Sleep for the given number of milliseconds.
+ * @param duration Duration in ms.
+ */
+export const sleep = async (duration: number) =>
+  new Promise((resolve) => setTimeout(resolve, duration));
+
+/**
+ * Type guard that asserts the input is defined.
+ * @param x The input to check.
+ */
+export const notNull = <T>(x: T): x is NonNullable<T> => x != null;

libs/websoc-utils/package.json

@@ -2,11 +2,12 @@
   "name": "@libs/websoc-utils",
   "version": "0.0.0",
   "private": true,
+  "description": "Helper functions for transforming WebSoc JSON responses",
   "type": "module",
   "main": "src/index.ts",
   "types": "src/index.ts",
   "dependencies": {
-    "@libs/uc-irvine-api": "workspace:^",
+    "@libs/uc-irvine-lib": "workspace:^",
     "@peterportal-api/types": "workspace:^"
   }
 }

libs/websoc-utils/src/index.ts

@@ -5,7 +5,7 @@ import type {
   WebsocSchool,
   WebsocSection,
   WebsocSectionMeeting,
-} from "@libs/uc-irvine-api/websoc";
+} from "@libs/uc-irvine-lib/websoc";
 import type {
   DayOfWeek,
   WebsocAPIResponse as NormalizedResponse,
@@ -40,18 +40,6 @@ export type EnhancedNormalizedSection = {
 export const fulfilled = <T>(value: PromiseSettledResult<T>): value is PromiseFulfilledResult<T> =>
   value.status === "fulfilled";
 
-/**
- * type guard that asserts input is defined
- */
-export const notNull = <T>(x: T): x is NonNullable<T> => x != null;
-
-/**
- * Sleep for the given number of milliseconds.
- * @param duration Duration in ms.
- */
-export const sleep = async (duration: number) =>
-  new Promise((resolve) => setTimeout(resolve, duration));
-
 const months = ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"];
 
 /**

package.json

@@ -14,11 +14,11 @@
     "destroy": "turbo run destroy",
     "dev": "dotenv -c development -- turbo run dev",
     "format": "prettier --write .",
-    "postinstall": "husky install",
     "lint": "eslint --fix .",
+    "prepare": "husky",
     "test": "turbo run test"
   },
-  "devDependencies": {
+  "dependencies": {
     "@commitlint/cli": "18.6.0",
     "@commitlint/config-conventional": "18.6.0",
     "@commitlint/types": "18.6.0",

packages/types/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@peterportal-api/types",
   "version": "1.0.0-rc.3",
+  "description": "",
   "license": "MIT",
   "type": "module",
   "main": "index.ts",

packages/types/types/courses.ts

@@ -1,5 +1,5 @@
-import { CourseLevel, GECategory } from "./constants";
-import { InstructorPreview } from "./instructor";
+import type { CourseLevel, GECategory } from "./constants";
+import type { InstructorPreview } from "./instructor";
 
 /**
  * An object representing a prerequisite.

packages/types/types/enrollmentHistory.ts

@@ -1,4 +1,4 @@
-import { Quarter, SectionType } from "./constants";
+import type { Quarter, SectionType } from "./constants";
 
 export type Meeting = {
   bldg: string[];