placementt-core 11.0.803 → 11.0.892

package/src/typeDefinitions.ts

@@ -41,7 +41,7 @@ export type StudentPlacementData = {
     mapConsent: true | "institute" | false,
     mapConsentDate?: string,
     placementId?: string,
-    addressId?: string,
+    providerContactId?: string,
     geoHash?: string,
     statusType: "draft"|"submitted"|"active"|"completed"|"withdrawn"|"requested",
     questions: PlacementQuestions,
@@ -51,6 +51,7 @@ export type StudentPlacementData = {
     importedProviderForms?: boolean,
     analytics: string[],
     units: string,
+    schoolId?: string,
     active: boolean,
     completed: boolean,
     personalAnalytics?: string[],
@@ -61,12 +62,13 @@ export type StudentPlacementData = {
     draft: boolean,
     activeDates: string[],
     insurance: boolean|"awaitingReview",
+    insuranceSkippedReason?: string,
     riskAssessment?: boolean|"awaitingReview",
-    riskAssessmentType?: "file"|"form",
-    riskAssessmentData?: {[key:string]: unknown}[],
+    riskAssessmentType?: "file"|"form"|"skipped",
+    riskAssessmentData?: {[key:string]: unknown}[]|string,
     dbsCheck?: boolean|"awaitingReview",
-    dbsCheckType?: "file"|"form",
-    dbsCheckData?: {[key:string]: unknown}[],
+    dbsCheckType?: "file"|"form"|"skipped",
+    dbsCheckData?: {[key:string]: unknown}[]|string,
     contactType?: "email"|"website"|"phone"|"post",
     webpage?: string,
     providerLogs?: string[],
@@ -140,29 +142,32 @@ export type PlacementQuestions = {
     payFrequency: "total"|"hourly"|"daily"|"weekly"|"monthly"|"annually",
 }
 
-export type SavedPlacement = {
-    placementId: string,
-    savedByProduct: Products,
-    savedByUserType: "Organisation"|"Student",
-    savedById: string,
-    status?: "Accepted" | "Blocked" | "providerReview";
-    listed: boolean,
-    concurrentPlacements?: number,
-    id: string
-}
+// export type SavedPlacement = {
+//     placementId: string,
+//     savedByProduct: Products,
+//     savedByUserType: "Organisation"|"Student",
+//     savedById: string,
+//     schoolId?: string,
+//     status?: "Accepted" | "Blocked" | "providerReview";
+//     listed: boolean,
+//     concurrentPlacements?: number,
+//     id: string
+// }
 
-export type PlacementListingStages = "basic"|"address"|"students"|"responsibilities"|"applications"|"onboarding"|"review"|"complete";
+// export type PlacementListingStages = "basic"|"address"|"students"|"responsibilities"|"applications"|"onboarding"|"review"|"complete";
 
 export type PlacementListing = {
     title: string,
-    uid: string,
-    template?: string,
-    providerId?: string,
+    // uid: string,
+    // template?: string,
+    providerId: string,
+    providerContactId: string,
     name: string,
     providerEmail: string,
     providerPhone: string,
-    id:string,
-    studentType: "secondary" | "higher" | "undergraduate" | "postgraduate"
+    id?:string,
+    created?: string,
+    // studentType: "secondary" | "higher" | "undergraduate" | "postgraduate"
     contactForename: string,
     contactSurname: string,
     ["address-line1"]: string,
@@ -171,34 +176,42 @@ export type PlacementListing = {
     postal_code: string,
     country: string,
     what3Words?: string,
-    addressId?: string,
     geoHash?: string,
-    status: "listed"|"unlisted"|"deleted"|"draft",
+    // status: "listed"|"unlisted"|"deleted"|"draft",
     questions: PlacementQuestions,
-    savedBy?: {[key:string]: {
+    savedBy?: {[key:string]: { // LIST OF SCHOOLS THAT HAVE SAVED THIS
+        MATschools?: string[],
         exists: true,
+        cohorts?: {[key: string]: {
+            exists: boolean,
+            listed: boolean
+        }}
         providerConsent: boolean,
-        providerConsentDate?: Timestamp,
-        status: "uploaded"|"approved"|"rejected"|"blocked"}},
+        providerConsentDate?: string,
+        savedByUserType: "Organisation"|"Student",
+        status: "uploaded"|"approved"|"rejected"|"providerReviewed"|"blocked"}},
     mapConsent?: boolean,
-    mapConsentData?: string,
+    mapConsentDate?: string,
     uploadedBy: "student"|"institute"|"provider",
-    riskAssessmentType?: "file"|"form",
-    riskAssessmentData?: {[key:string]: unknown}[],
-    dbsCheckType?: "file"|"form",
-    dbsCheckData?: {[key:string]: unknown}[],
+    riskAssessmentType?: "file"|"form"|"skipped",
+    concurrentPlacements?: number,
+    riskAssessmentData?: {[key:string]: unknown}[]|string,
+    dbsCheckType?: "file"|"form"|"skipped",
+    dbsCheckData?: {[key:string]: unknown}[]|string,
     contactType?: "email"|"website"|"phone"|"post",
     webpage?: string,
-    stage: PlacementListingStages,
-    placementDateType?: "any"|"range"|"defined",
-    placementDates?: {start: string, end: string}[],
-    applicationType?: "simple"|"complex",
-    applicantWorkflowId?: string,
-    applicantWorkflow?: ApplicantStage[],
-    onboarding: (OnboardingDocs&{deadline: number})|false,
-    maxApplicants?: number,
-    maxStudents?: number,
-    primaryContactId: string,
+    sector?: string,
+    subsector?: string,
+    // stage: PlacementListingStages,
+    // placementDateType?: "any"|"range"|"defined",
+    // placementDates?: {start: string, end: string}[],
+    // applicationType?: "simple"|"complex",
+    // applicantWorkflowId?: string,
+    // applicantWorkflow?: ApplicantStage[],
+    // onboarding: (OnboardingDocs&{deadline: number})|false,
+    // maxApplicants?: number,
+    // maxStudents?: number,
+    // primaryContactId: string,
 }
 
 export type OnboardingDocs = {
@@ -208,7 +221,7 @@ export type OnboardingDocs = {
     requiredFiles?: {fileName: string, fileType: string}[]
 }
 
-export type PlacementTemplate = PlacementListing&{templateName: string};
+// export type PlacementTemplate = PlacementListing&{templateName: string};
 
 export type OrganisationAddressStages = "address"|"contacts"|"misc"|"review"|"complete";
 
@@ -319,10 +332,12 @@ export type UserData = {
     units?: string,
     activationCode: number,
     cohort?: string,
+    schoolId?: string,
     cohortData?: CohortData,
     dismissedTasks?: string[],
     dismissedTutorials?: string[],
     dismissedTips?: string[],
+    dismissedUpdateDate?: string, // A specific date from which all previous updates have been seen.
     viewCohorts?: "all"|"some"|"none",
     viewStudents?: "all"|"some"|"none",
     studentFilterValues?: string[], // comma delimited list of values, such as "a, b, c, d"
@@ -352,7 +367,8 @@ export type UserData = {
     skillsTargetsValues?: {[key: string]: {
         provider: number[],
         student: number[],
-    }}
+    }},
+    alumniConversationUid?: string
 };
 
 export type AnalyticsItem = {
@@ -524,44 +540,65 @@ export type ProviderPlacementData = {
 
 
 export type ProviderData = {
-    staff: number,
-    staffFields: string[],
-    staffActive: number,
-    admin: string,
+    // staff: number,
+    // staffFields: string[],
+    // staffActive: number,
+    // admin: string,
     name: string,
-    insurance: boolean|"awaitingReview",
+    // insurance: boolean|"awaitingReview",
+    // insuranceSkippedReason?: string,
     regNumber?: string,
-    insuranceExpiry: string,
-    mapConsent?: boolean|"unlisted",
-    mapConsentDate?: string,
-    staffGuidance?: {[key:number]: string},
-    about?: string,
+    // insuranceExpiry: string,
+    // mapConsent?: boolean|"unlisted",
+    // mapConsentDate?: string,
+    // staffGuidance?: {[key:number]: string},
+    // about?: string,
+    sector: string,
+    // defAddress: string,
+    subsector: string,
+    website?: string,
+    created?: string
+    uploadedBy?: "institute"|"provider"|"student"
+    // onboarding?: {
+    //     hasStaff?: boolean,
+    //     multipleAddresses?: boolean,
+    // }
+    // registrationRequests?: boolean|string,
+    // registrationRequestsDate?: string,
+    // information: {
+    //     description?: string,
+    //     staff?: string,
+    //     locations?: number,
+    // },
+    // discount?: string,
+    // package: string,
+    // splitBilling?: boolean,
+    // adminBillingContactId: string,
+    // addOnPackages?: string[],
+}&Address
+
+export type ProviderContactData = {
     sector: string,
-    defAddress: string,
+    name: string,
     subsector: string,
+    providerPhone?: string,
+    providerEmail: string,
+    contactForename: string,
+    contactSurname: string,
     website?: string,
+    created: string,
+    providerId: string,
+    insurance: boolean|"awaitingReview",
+    insuranceSkippedReason?: string,
+    insuranceExpiry?: string,
     savedBy?: {[key:string]: {
         exists: true,
-        providerConsent: boolean,
-        providerConsentDate?: Timestamp,
-        status: "uploaded"|"approved"|"blocked"}},
-    onboarding?: {
-        hasStaff?: boolean,
-        multipleAddresses?: boolean,
-    }
-    registrationRequests?: boolean|string,
-    registrationRequestsDate?: string,
-    information: {
-        description?: string,
-        staff?: string,
-        locations?: number,
-    },
-    discount?: string,
-    package: string,
-    splitBilling?: boolean,
-    adminBillingContactId: string,
-    addOnPackages?: string[],
-}
+        activities?: string[], // IDs of consented activities.
+        providerConsent?: boolean,
+        providerConsentDate?: string,
+        MATschools?: string[],
+        status: "uploaded"|"approved"|"rejected"|"providerReviewed"|"blocked"}},
+}&Address
 
 export type InstituteData = {
     students: number,
@@ -596,17 +633,25 @@ export type InstituteData = {
             url: string
         }
     },
-    providerActivities?: {[key: string]: ProviderActivity}
+    acceptingAlumni?: boolean,
+    approveAlumni?: boolean,
+    shareAlumni?: boolean
+    approveAlumniMessages?: boolean,
+    anonymiseAlumniConvoStudents?: boolean,
+    alumniConversations?: boolean
 }&Address;
 
-export type ProviderActivity = {
+export type ExternalActivity = {
     title?: string,
     description: string,
     position?: number,
     image?: string,
     color: string,
     public?: boolean,
-    oId?: string
+    oId?: string,
+    alumni?: boolean,
+    provider?: boolean,
+    permanent?: boolean
 }
 
 export type NotificationObject = {
@@ -724,6 +769,7 @@ export type CohortData = {
     product: Products,
     schoolId?: string,
     designatedStaff?: string,
+    autoArchiveDate?: string,
     logType?: "basic"|"custom",
     logs?: {
         students?: string,
@@ -797,10 +843,10 @@ export type PlacementReviewDetails = {
             questions: PlacementQuestions,
             riskAssessment: boolean|"awaitingReview",
             riskAssessmentType: "form"|"file",
-            riskAssessmentData?: {[key: string]: unknown},
+            riskAssessmentData?: {[key: string]: unknown}|string,
             dbsCheck: boolean|"awaitingReview",
             dbsCheckType: "form"|"file",
-            dbsCheckData?: {[key: string]: unknown},
+            dbsCheckData?: {[key: string]: unknown}|string,
         }
     },
     requireELI?: boolean,
@@ -809,9 +855,10 @@ export type PlacementReviewDetails = {
     importedProviderForms: boolean,
     currentStage: WorkflowStage&{files: {[fileId: string]: {name: string, url: string}}},
     placementId?: string,
+    providerContactId: string,
     incompleteItems: {[key: number]: string[]},
-    riskAssessmentData?: {[key: string]: unknown}[],
-    dbsCheckData?: {[key: string]: unknown}[],
+    riskAssessmentData?: {[key: string]: unknown}[]|string,
+    dbsCheckData?: {[key: string]: unknown}[]|string,
     feedbackText?: Descendant[],
     feedback: CustomFormSchema,
     providerFeedback?: {[key: string]: unknown},
@@ -1000,5 +1047,117 @@ export type SchoolData = OrganisationAddress&{
         }
     },
     monthAdded: number,
-    acceptingAlumni?: boolean
+    acceptingAlumni?: boolean,
+    approveAlumni?: boolean,
+    shareAlumni?: boolean
+    approveAlumniMessages?: boolean,
+    anonymiseAlumniConvoStudents?: boolean,
+    alumniConversations?: boolean
+}
+
+
+export type ExternalEvent = {
+    name: string,
+    description: string,
+    created: string,
+    activityId?: string,
+    oId: string,
+    submissionClose: string,
+    schoolId?: string,
+    startDate?: string,
+    endDate?: string,
+    startTime?: string,
+    endTime?: string,
+    allDay?: boolean,
+    recurring?: boolean,
+    recurringFrequency: "daily"|"weekly"|"fortnightly"|"monthlyOnDate",
+    recurringUntil?: string,
+    students?: number,
+    maxExternalAttendees?: number,
+    stage: "basicDetails"|"date"|"invites"|"review"|"created",
+    alumni: {
+        shareable?: boolean,
+        filters: {[key: string]: unknown}
+    }
+    employers: {
+        shareable?: boolean,
+        filters: {[key: string]: unknown}
+    }
+}&Address
+
+
+export type Alumni = {
+    forename: string,
+    surname: string,
+    email: string,
+    startYear: string,
+    endYear: string,
+    activities: string[],
+    oId: string,
+    schoolId?: string,
+    dateAdded?: string,
+    currentEnrolment: "university"|"apprenticeship"|"employment",
+    status: "inactive"|"awaitingStaff"|"active"
+    sector: string,
+    subsector: string,
+    enrolmentHistory: {}[],
+    visibleToStudents?: boolean,
+    enableConversations?: boolean,
+    linkCode: string,
+    linkCodeExpiry: string
+}
+
+export type ExternalStudentAccount = {
+    oId: string,
+    schoolId?: string,
+    forename?: string,
+    surname?: string,
+    email: string,
+    created?: string
+}
+
+export type AlumniConversation = {
+    alumniId: string,
+    externalStudentId: string,
+    alumniSharable?: boolean,
+    oId: string,
+    schoolId?: string,
+    studentSharable?: boolean,
+    messages: {[key: string]: {
+        sentBy: "alumni"|"student",
+        sentAt: string,
+        message: string,
+        delivered: "blocked"|"pending"|true,
+    }},
+    open: boolean,
+    reported?: boolean,
+    delivered: "blocked"|"pending"|true,
+    report?: {
+        reportedBy: "alumni"|"student"
+        message: string,
+        createdDateTime: string,
+        resolvedDateTime: string,
+    }
+}
+
+export type AlumniConvoUser = {
+    forename: string,
+    surname: string,
+    email: string,
+    dateAdded: string,
+    oId: string,
+    schoolId?: string,
+    linkCode: string,
+    linkCodeExpiry: string
+}
+
+export type Update = {
+    title: string,
+    description: Descendant[],
+    userType: "Staff"|"Students",
+    product: Products,
+    buttonText?: string,
+    buttonLink?: string,
+    date: string,
+    imageData?: boolean
 }

package/src/util.ts

@@ -1,6 +1,6 @@
 import {where} from "firebase/firestore";
 import FirebaseQuery from "./firebase/firebaseQuery";
-import {FlagCodes, InstituteData, StudentPlacementData, UserData, WorkflowStage} from "./typeDefinitions";
+import {AlumniConversation, FlagCodes, InstituteData, StudentPlacementData, UserData, WorkflowStage} from "./typeDefinitions";
 import {convertDate} from "./firebase/util";
 
 type PlacementFlagCodeParams = {
@@ -158,3 +158,20 @@ export function objectsEqualNew(a: any, b: any): boolean { // Works with arrays
 
     return false;
 }
+
+export const getMostRecentAlumniMessage = (conversation: AlumniConversation) => {
+    const { messages } = conversation;
+  
+    if (!messages || Object.keys(messages).length === 0) {
+      return null; // No messages available
+    }
+  
+    const mostRecent = Object.entries(messages)
+      .map(([id, message]) => ({
+        id,
+        ...message,
+      }))
+      .sort((a, b) => new Date(b.sentAt).getTime() - new Date(a.sentAt).getTime())[0];
+  
+    return mostRecent || null; // Return most recent or null if none found
+  };