feat(api): schools controller

Fixes #49

Author: akdasa

.github/workflows/api_pr_coverage_report.yml

@@ -16,6 +16,7 @@ jobs:
 
       - name: Install Dependencies
         run: npm ci
+        working-directory: modules/
 
       - name: Run Jest Tests with Coverage
         run: npm run test

modules/libs/protocol/index.ts

@@ -5,3 +5,4 @@ export * from './routes'
 export * from './roles'
 export * from './userRoles'
 export * from './users'
+export * from './schools'

modules/libs/protocol/routes.ts

@@ -32,5 +32,12 @@ export const Routes = (baseUrl: string = '') => ({
         delete: (roleId: string) => `${baseUrl}/edu/users/${userId}/roles/${roleId}`,
       }
     }),
+    schools: {
+      find: () => `${baseUrl}/edu/schools`,
+      get: (id: string) => `${baseUrl}/edu/schools/${id}`,
+      create: () => `${baseUrl}/edu/schools`,
+      update: (id: string) => `${baseUrl}/edu/schools/${id}`,
+      delete: (id: string) => `${baseUrl}/edu/schools/${id}`,
+    }
   }
 })

modules/libs/protocol/schools.ts

@@ -0,0 +1,46 @@
+import * as crud from './crud'
+
+/* -------------------------------------------------------------------------- */
+/*                                   Models                                   */
+/* -------------------------------------------------------------------------- */
+
+export type SchoolDetails = {
+  id: string;
+  name: string;
+}
+
+export type SchoolSummary = Pick<SchoolDetails, 'id' | 'name'>;
+
+/* -------------------------------------------------------------------------- */
+/*                                   Create                                   */
+/* -------------------------------------------------------------------------- */
+
+export type CreateSchoolRequest = crud.CreateItemRequest<Omit<SchoolDetails, 'id'>>;
+export type CreateSchoolResponse = crud.CreateItemResponse<SchoolDetails['id']>;
+
+/* -------------------------------------------------------------------------- */
+/*                                    Read                                    */
+/* -------------------------------------------------------------------------- */
+
+export type GetSchoolsResponse = 
+  crud.GetItemsListResponse<SchoolSummary>;
+
+export type GetSchoolResponse = 
+  crud.GetItemResponse<SchoolDetails>;
+
+/* -------------------------------------------------------------------------- */
+/*                                   Update                                   */
+/* -------------------------------------------------------------------------- */
+
+export type UpdateSchoolRequest = 
+  crud.UpdateItemRequest<Omit<SchoolDetails, 'id'>>; 
+
+export type UpdateSchoolResponse = 
+  crud.UpdateItemResponse<SchoolDetails>;
+
+/* -------------------------------------------------------------------------- */
+/*                                   Delete                                   */
+/* -------------------------------------------------------------------------- */
+
+export type DeleteSchoolResponse = 
+  crud.DeleteItemResponse;

modules/services/api/jest.config.js

@@ -0,0 +1,18 @@
+module.exports = {
+  moduleFileExtensions: ['js', 'json', 'ts'],
+  rootDir: 'src',
+  testRegex: '.*\\.spec\\.ts$',
+  transform: {
+    '^.+\\.(t|j)s$': 'ts-jest',
+  },
+  collectCoverageFrom: ['**/*.(t|j)s'],
+  testTimeout: 20000,
+  coverageDirectory: '../coverage',
+  testEnvironment: 'node',
+  moduleNameMapper: {
+    '^@vidya/api/(.*)$': '<rootDir>/$1',
+    '^@vidya/protocol$': '<rootDir>/../../../libs/protocol',
+    '^@vidya/entities$': '<rootDir>/../../../libs/entities',
+    '^@vidya/domain$': '<rootDir>/../../../libs/domain',
+  },
+};

modules/services/api/package.json

@@ -66,29 +66,5 @@
     "ts-node": "^10.9.2",
     "tsconfig-paths": "^4.2.0",
     "typescript": "^5.1.3"
-  },
-  "jest": {
-    "moduleFileExtensions": [
-      "js",
-      "json",
-      "ts"
-    ],
-    "rootDir": "src",
-    "testRegex": ".*\\.spec\\.ts$",
-    "transform": {
-      "^.+\\.(t|j)s$": "ts-jest"
-    },
-    "collectCoverageFrom": [
-      "**/*.(t|j)s"
-    ],
-    "testTimeout": 20000,
-    "coverageDirectory": "../coverage",
-    "testEnvironment": "node",
-    "moduleNameMapper": {
-      "^@vidya/api/(.*)$": "<rootDir>/$1",
-      "^@vidya/protocol$": "<rootDir>/../../../libs/protocol",
-      "^@vidya/entities$": "<rootDir>/../../../libs/entities",
-      "^@vidya/domain$": "<rootDir>/../../../libs/domain"
-    }
   }
 }

modules/services/api/src/auth/controllers/otp.controller.ts

@@ -18,7 +18,7 @@ import { OtpService } from '@vidya/api/auth/services';
 import { Routes } from '@vidya/protocol';
 
 @Controller()
-@ApiTags('Authentication :: One-Time Password')
+@ApiTags('🎟️ Authentication :: One-Time Password')
 export class OtpController {
   constructor(private readonly otpService: OtpService) {}
 

modules/services/api/src/auth/controllers/tokens.controller.ts

@@ -21,7 +21,7 @@ import {
 import { Routes } from '@vidya/protocol';
 
 @Controller()
-@ApiTags('Authentication')
+@ApiTags('🔐 Authentication')
 export class TokensController {
   constructor(
     private readonly revokedTokensService: RevokedTokensService,

modules/services/api/src/auth/controllers/user-authentication.controller.ts

@@ -29,7 +29,7 @@ import { AuthConfig } from '@vidya/api/configs';
 import { JwtToken, OtpType, Routes } from '@vidya/protocol';
 
 @Controller()
-@ApiTags('Authentication')
+@ApiTags('🔐 Authentication')
 export class UserAuthenticationController {
   constructor(
     @Inject(AuthConfig.KEY)

modules/services/api/src/edu/controllers/index.ts

@@ -1,3 +1,4 @@
 export * from './roles/roles.controller';
+export * from './schools/schools.controller';
 export * from './users/userRoles.controller';
 export * from './users/users.controller';