feat: Lara paper Briefing

package.json

@@ -64,6 +64,6 @@
     "serverless-s3-local": "^0.6.22",
     "serverless-s3-sync": "3.1.0",
     "sort-package-json": "^1.46.0",
-    "typescript": "^5.2.2"
+    "typescript": "^4.7.2"
   }
 }

packages/api/codegen.yml

@@ -21,4 +21,6 @@ generates:
         Report: ./models#Report
         Trainer: ./models#Trainer
         Trainee: ./models#Trainee
+        Mentor: ./models#Mentor
         UserInterface: ./models#UserInterface
+        Paper: ./models#Paper

packages/api/schema.gql

@@ -98,6 +98,62 @@ type UpdateReportPayload {
   report: Report!
 }
 
+input MentorInput {
+  name: String
+  email: String
+  signature: String
+}
+
+
+input PaperEntryInput {
+  id: ID!
+  questionId: ID!
+  question: String!
+  answer: String
+  hint: String
+}
+
+type MutatePaperPayload {
+  papers: [Paper]
+}
+
+input PaperInput {
+  traineeId: ID!
+  trainerId: ID!
+  client: String!
+  mentorId: ID!
+  periodStart: String
+  periodEnd: String
+  schoolPeriodStart: String
+  schoolPeriodEnd: String
+  subject: String!
+  status: PaperStatus!
+  briefing: [PaperEntryInput!]!
+}
+
+input PaperUpdateInput {
+  id: ID!
+  traineeId: ID!
+  trainerId: ID!
+  client: String!
+  mentorId: ID!
+  periodStart: String
+  periodEnd: String
+  schoolPeriodStart: String
+  schoolPeriodEnd: String
+  subject: String!
+  status: PaperStatus!
+  briefing: [PaperEntryInput!]!
+}
+
+input AnswerPaperInput {
+  id: ID!
+  questionId: ID!
+  question: String!
+  answer: String!
+  hint: String!
+}
+
 type Mutation {
   """
   [DEV] Login as a user.
@@ -181,6 +237,16 @@ type Mutation {
   """
   createTrainer(input: CreateTrainerInput!): Trainer
 
+  """
+  Creates Mentor.
+  """
+  createMentor(input: CreateMentorInput!): Mentor
+
+  """
+  Get a User by Email
+  """
+  getUserByEmail(email: String!): UserInterface
+
   """
   Marks User to be deleted
   """
@@ -201,6 +267,11 @@ type Mutation {
   """
   updateTrainer(input: UpdateTrainerInput!, id: ID!): Trainer
 
+  """
+  Updates Mentor.
+  """
+  updateMentor(input: UpdateMentorInput!, id: ID!): Mentor
+
   """
   Link Alexa account
   """
@@ -215,6 +286,36 @@ type Mutation {
   Create OAuth Code
   """
   createOAuthCode: String!
+
+  """
+  Create Paper
+  """
+  createPaper(input: PaperInput!): Paper!
+
+  """
+  Update Paper
+  """
+  updatePaper(input: PaperUpdateInput!): Paper!
+
+  """
+  Delete Paper
+  """
+  deletePaper(paperId: ID!): [Paper]!
+
+  """
+  Updates Entry for Lara Paper
+  """
+  updatePaperEntry(input: AnswerPaperInput!): PaperFormData!
+
+  """
+  Creates Entry for Lara Paper
+  """
+  createPaperEntry(input: AnswerPaperInput!): PaperFormData!
+
+  """
+  Deletes Entry for Lara Paper
+  """
+  deletePaperEntry(id: ID!): PaperFormData!
 }
 
 type LaraConfig {
@@ -272,11 +373,21 @@ type Query {
   """
   trainers: [Trainer!]!
 
+  """
+  Get all Trainers
+  """
+  mentors: [Mentor!]!
+
   """
   Print single report or report batch
   """
   print(ids: [ID!]!): PrintPayload!
 
+  """
+  Print single paper
+  """
+  printPaper(ids: [ID!]!): PrintPayload!
+
   """
   Get a User by ID
   """
@@ -291,6 +402,7 @@ type Query {
   Get the alexa account linking url
   """
   alexaLinkingUrl: String
+
 }
 
 type PrintPayload {
@@ -353,6 +465,7 @@ type Trainee implements UserInterface {
   lastName: String!
   notification: Boolean
   reports: [Report!]!
+  papers: [Paper]
   signature: String
   startDate: String
   startOfToolUsage: String
@@ -396,12 +509,28 @@ input CreateTrainerInput {
   lastName: String!
 }
 
+input CreateMentorInput {
+  email: String!
+  firstName: String!
+  lastName: String!
+  startDate: String
+  endDate: String
+}
+
 input UpdateTrainerInput {
   email: String
   firstName: String
   lastName: String
 }
 
+input UpdateMentorInput {
+  email: String
+  firstName: String
+  lastName: String
+  startDate: String
+  endDate: String
+}
+
 type Trainer implements UserInterface {
   avatar: String!
   createdAt: String!
@@ -413,7 +542,28 @@ type Trainer implements UserInterface {
   signature: String
   theme: String
   trainees: [Trainee!]!
+  papers: [Paper]
+  type: UserTypeEnum!
+  username: String!
+  email: String!
+  deleteAt: String
+  alexaSkillLinked: Boolean
+}
+
+type Mentor implements UserInterface {
+  avatar: String!
+  createdAt: String!
+  firstName: String!
+  id: ID!
+  language: String
+  lastName: String!
+  notification: Boolean
+  signature: String
+  theme: String
   type: UserTypeEnum!
+  papers: [Paper]
+  startDate: String
+  endDate: String
   username: String!
   email: String!
   deleteAt: String
@@ -475,8 +625,47 @@ enum UserTypeEnum {
   """
   Trainer
 
+  """
+  User is a Mentor
+  """
+  Mentor
+
   """
   User is an Admin
   """
   Admin
 }
+
+enum PaperStatus {
+  InProgress
+  TraineeDone
+  MentorDone
+  InReview
+  Archived
+}
+
+type PaperFormData {
+  id: ID!
+  questionId: ID!
+  question: String!
+  answer: String
+  hint: String
+}
+
+type Paper {
+  id: ID!
+  traineeId: ID!
+  trainerId: ID!
+  status: PaperStatus!
+  briefing: [PaperFormData!]!
+  conclusion: String
+  archivedAt: String
+  createdAt: String
+  client: String!
+  mentorId: ID!
+  periodStart: String
+  periodEnd: String
+  schoolPeriodStart: String
+  schoolPeriodEnd: String
+  subject: String!
+}

packages/api/src/context.ts

@@ -1,14 +1,14 @@
 import { APIGatewayProxyEvent, Context as AWSContext } from 'aws-lambda'
 import { Request, Response } from 'express'
 
-import { Trainee, Trainer, Admin, User } from './models'
+import { Trainee, Trainer, Admin, Mentor, User } from './models'
 
 type ExpressContext = {
   req: Request
   res: Response
 }
 
-type BaseContext = {
+export type BaseContext = {
   event: APIGatewayProxyEvent
   express: ExpressContext
 }
@@ -29,6 +29,10 @@ export type TraineeContext = BaseContext & {
   currentUser: Trainee
 }
 
+export type MentorContext = BaseContext & {
+  currentUser: Mentor
+}
+
 export type AdminContext = BaseContext & {
   currentUser: Admin
 }

packages/api/src/email.ts

@@ -47,8 +47,18 @@ export type ExportMailPayload = BaseEmailPayload & {
   ]
 }
 
+export type PaperBriefingMailPayload = BaseEmailPayload & {
+  emailType: 'paperBriefing'
+  userData: BaseMailUserData
+  attachments: [
+    {
+      filename: string
+    }
+  ]
+}
+
 export type SimpleMailPayload = BaseEmailPayload & {
-  emailType: 'deleteAccount' | 'error' | 'alexa'
+  emailType: 'deleteAccount' | 'error' | 'alexa' | 'paperBriefingMail'
   userData: BaseMailUserData
 }
 
@@ -59,6 +69,7 @@ export type EmailPayload =
   | SimpleMailPayload
   | ExportMailPayload
   | ReportInReviewPayload
+  | PaperBriefingMailPayload
 
 export type EmailType = EmailPayload['emailType']
 
@@ -76,6 +87,8 @@ export type EmailTranslations = {
     deleteUser: string
     reportInReview: string
     alexa: string
+    paperBriefing: string
+    paperBriefingMail: string
   }
   headline: {
     export: string
@@ -86,6 +99,7 @@ export type EmailTranslations = {
     deleteUser: string
     handOver: string
     alexa: string
+    paperBriefing: string
   }
   message: {
     error: string
@@ -97,10 +111,12 @@ export type EmailTranslations = {
     deleteUser: string
     handOver: string
     alexa: string
+    paperBriefing: string
   }
   link: {
     archive: string
     report: string
+    paperBriefing: string
     lara: string
     settings: string
   }