add curriculums basics backend routes (crud) with tests

Author: jeanbfly

@apps/backend/src/app/app.router.ts

@@ -1,15 +1,16 @@
-import { type AuthModule, type UserModule } from "@libs/users-backend";
+import { type AuthModule, type UserModule, type CurriculumModule } from "@libs/users-backend";
 import type { FastifyInstanceType } from "./app.js";
 import { statusRoute } from "./status.route.js";
 
 interface AppRouterOptions {
   authModule: AuthModule;
   userModule: UserModule;
+  curriculumModule: CurriculumModule;
 }
 
 export async function appRouter(
   fastify: FastifyInstanceType,
-  { authModule, userModule }: AppRouterOptions,
+  { authModule, userModule, curriculumModule }: AppRouterOptions,
 ) {
   await fastify.register(
     async function (fastify) {
@@ -25,6 +26,7 @@ export async function appRouter(
       });
 
       await userModule.setupRoutes(fastify);
+      await curriculumModule.setupRoutes(fastify);
     },
     {
       prefix: "api/v1",

@apps/backend/src/app/app.ts

@@ -19,7 +19,7 @@ import packageJson from "../../package.json" with { type: "json" };
 import { appRouter } from "./app.router.js";
 import type { ApplicationContext } from "./application.context.js";
 import { logger } from "./logger.js";
-import { UserModule, AuthModule } from "@libs/users-backend";
+import { UserModule, AuthModule, CurriculumModule } from "@libs/users-backend";
 
 export type FastifyInstanceType = FastifyInstance<
   RawServerDefault,
@@ -162,6 +162,12 @@ export class App {
           jwtSecret: this.context.configuration.JWT_SECRET,
         },
       }),
+      curriculumModule: CurriculumModule.init({
+        em: this.context.orm.em.fork(),
+        configuration: {
+          jwtSecret: this.context.configuration.JWT_SECRET,
+        },
+      }),
     });
   }
 

@apps/backend/src/app/database.connection.ts

@@ -1,14 +1,14 @@
 import { defineConfig, MikroORM } from "@mikro-orm/postgresql";
 import type { AppConfiguration } from "../configuration.js";
-import { RefreshTokenEntity, UserEntity } from "@libs/users-backend";
+import { RefreshTokenEntity, UserEntity, CurriculumEntity } from "@libs/users-backend";
 
 export function databaseConfig(config: Pick<AppConfiguration, "DATABASE_URI">) {
   return defineConfig({
     seeder: {
       pathTs: "./src/seeders",
     },
     clientUrl: config.DATABASE_URI,
-    entities: [UserEntity, RefreshTokenEntity],
+    entities: [UserEntity, RefreshTokenEntity, CurriculumEntity],
   });
 }
 

@libs/users-backend/src/context.ts

@@ -14,3 +14,10 @@ export interface AuthLibraryContext {
     jwtSecret: string;
   };
 }
+
+export interface CurriculumLibraryContext {
+  em: EntityManager;
+  configuration: {
+    jwtSecret: string;
+  };
+}

@libs/users-backend/src/entities/curriculum.entity.ts

@@ -0,0 +1,13 @@
+import { defineEntity, p, type InferEntity } from "@mikro-orm/core";
+
+export const CurriculumEntity = defineEntity({
+  name: "Curriculum",
+  properties: {
+    id: p.string().primary(),
+    userId: p.string().index(),
+    title: p.string(),
+    updatedAt: p.datetime(),
+  },
+});
+
+export type CurriculumEntityType = InferEntity<typeof CurriculumEntity>;

@libs/users-backend/src/entities/proposedSections.entity.ts

@@ -0,0 +1,13 @@
+import { defineEntity, p, type InferEntity } from "@mikro-orm/core";
+
+export const ProposedSectionEntity = defineEntity({
+  name: "ProposedSection",
+  properties: {
+    id: p.string().primary(),
+    curriculumId: p.string().index(),
+    title: p.string(),
+    position: p.integer(),
+  },
+});
+
+export type ProposedSectionEntityType = InferEntity<typeof ProposedSectionEntity>;

@libs/users-backend/src/entities/section.entity.ts

@@ -0,0 +1,13 @@
+import { defineEntity, p, type InferEntity } from "@mikro-orm/core";
+
+export const SectionEntity = defineEntity({
+  name: "Section",
+  properties: {
+    id: p.string().primary(),
+    curriculumId: p.string().index(),
+    title: p.string(),
+    position: p.integer(),
+  },
+});
+
+export type SectionEntityType = InferEntity<typeof SectionEntity>;

@libs/users-backend/src/entities/sectionItem.entity.ts

@@ -0,0 +1,13 @@
+import { defineEntity, p, type InferEntity } from "@mikro-orm/core";
+
+export const SectionItemEntity = defineEntity({
+  name: "SectionItem",
+  properties: {
+    id: p.string().primary(),
+    sectionId: p.string().index(),
+    position: p.integer(),
+    jsonData: p.json(),
+  },
+});
+
+export type SectionItemEntityType = InferEntity<typeof SectionItemEntity>;

@libs/users-backend/src/index.ts

@@ -1,8 +1,11 @@
 import { RefreshTokenEntity } from "#src/entities/refresh-token.entity.js";
 import { UserEntity } from "#src/entities/user.entity.js";
+import { CurriculumEntity } from "#src/entities/curriculum.entity.js";
 
 export * from "#src/entities/user.entity.js";
 export * from "#src/entities/refresh-token.entity.js";
+export * from "#src/entities/curriculum.entity.js";
+
 export * from "#src/routes/create.route.js";
 export * from "#src/routes/delete.route.js";
 export * from "#src/routes/get.route.js";
@@ -13,11 +16,19 @@ export * from "#src/routes/profile.route.js";
 export * from "#src/routes/refresh.route.js";
 export * from "#src/routes/update.route.js";
 export * from "#src/serializers/user.serializer.js";
+
 export * from "#src/utils/token.utils.js";
 export * from "#src/utils/token-cleanup.utils.js";
 export * from "#src/init.js";
 export * from "#src/utils/jwt.utils.js";
 export * from "#src/utils/auth.utils.js";
 export * from "#src/middlewares/jwt-auth.middleware.ts";
 
-export const entities = [UserEntity, RefreshTokenEntity];
+export * from "#src/routes/curriculums/get.route.js";
+export * from "#src/routes/curriculums/list.route.js";
+export * from "#src/routes/curriculums/create.route.js";
+export * from "#src/routes/curriculums/update.route.js";
+export * from "#src/routes/curriculums/delete.route.js";
+export * from "#src/serializers/curriculum.serializer.js";
+
+export const entities = [UserEntity, RefreshTokenEntity, CurriculumEntity];

@libs/users-backend/src/init.ts

@@ -5,7 +5,11 @@ import type {
   RawRequestDefaultExpression,
   RawServerDefault,
 } from "fastify";
-import type { AuthLibraryContext, UserLibraryContext } from "./context.js";
+import type {
+  AuthLibraryContext,
+  UserLibraryContext,
+  CurriculumLibraryContext,
+} from "./context.js";
 import { type ZodTypeProvider } from "fastify-type-provider-zod";
 import { LoginRoute } from "#src/routes/login.route.js";
 import { RefreshRoute } from "#src/routes/refresh.route.js";
@@ -20,6 +24,13 @@ import { UserEntity } from "./entities/user.entity.js";
 import { type ModuleInterface, type Route } from "@libs/backend-shared";
 import { handleJsonApiErrors } from "@libs/backend-shared";
 import { createJwtAuthMiddleware } from "./index.ts";
+import { CurriculumEntity } from "./entities/curriculum.entity.ts";
+
+import { GetCurriculumRoute } from "./routes/curriculums/get.route.ts";
+import { ListCurriculumRoute } from "./routes/curriculums/list.route.ts";
+import { CreateCurriculumRoute } from "./routes/curriculums/create.route.ts";
+import { UpdateCurriculumRoute } from "./routes/curriculums/update.route.ts";
+import { DeleteCurriculumRoute } from "./routes/curriculums/delete.route.ts";
 
 export type FastifyInstanceTypeForModule = FastifyInstance<
   RawServerDefault,
@@ -107,3 +118,43 @@ export class UserModule implements ModuleInterface<FastifyInstanceTypeForModule>
     );
   }
 }
+
+export class CurriculumModule implements ModuleInterface<FastifyInstanceTypeForModule> {
+  private constructor(private context: CurriculumLibraryContext) {}
+
+  public static init(context: CurriculumLibraryContext): CurriculumModule {
+    return new CurriculumModule(context);
+  }
+
+  public async setupRoutes(fastify: FastifyInstanceTypeForModule): Promise<void> {
+    const repository = this.context.em.getRepository(CurriculumEntity);
+
+    await fastify.register(
+      async (f) => {
+        const curriculumRoutes: Route<FastifyInstanceTypeForModule>[] = [
+          new GetCurriculumRoute(repository),
+          new ListCurriculumRoute(repository),
+          new CreateCurriculumRoute(repository),
+          new UpdateCurriculumRoute(repository),
+          new DeleteCurriculumRoute(repository),
+        ];
+
+        f.setErrorHandler((error, request, reply) => {
+          handleJsonApiErrors(error, request, reply);
+        });
+
+        const jwtAuthMiddleware = createJwtAuthMiddleware(
+          this.context.em,
+          this.context.configuration.jwtSecret,
+        );
+
+        f.addHook("preValidation", jwtAuthMiddleware);
+
+        for (const route of curriculumRoutes) {
+          route.routeDefinition(f);
+        }
+      },
+      { prefix: "/curriculums" },
+    );
+  }
+}