placementt-core 11.0.533 → 11.0.892

package/src/typeDefinitions.ts

@@ -1,5 +1,6 @@
 import {DocumentData, DocumentReference, Timestamp} from "firebase/firestore";
 import {Descendant} from "slate";
+import {emailTemplates} from "./constants";
 
 export type Products = "institutes"|"providers"|"students"|"admin";
 
@@ -32,6 +33,7 @@ export type StudentPlacementData = {
     ["address-line2"]: string,
     locality: string,
     postal_code: string,
+    what3Words?: string,
     country: string,
     cohort?: string,
     leadTimes: string[],
@@ -39,9 +41,9 @@ export type StudentPlacementData = {
     mapConsent: true | "institute" | false,
     mapConsentDate?: string,
     placementId?: string,
-    addressId?: string,
+    providerContactId?: string,
     geoHash?: string,
-    statusType: "draft"|"submitted"|"active"|"completed"|"withdrawn",
+    statusType: "draft"|"submitted"|"active"|"completed"|"withdrawn"|"requested",
     questions: PlacementQuestions,
     staffRoles: string[],
     sector: string,
@@ -49,6 +51,7 @@ export type StudentPlacementData = {
     importedProviderForms?: boolean,
     analytics: string[],
     units: string,
+    schoolId?: string,
     active: boolean,
     completed: boolean,
     personalAnalytics?: string[],
@@ -59,16 +62,22 @@ 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[],
     studentsLogs?: string[],
+    notes?: {
+        providers?: Descendant[],
+        institutes?: Descendant[],
+        students?: Descendant[]
+    }
     staffLogs?: [],
     feedback: {
         students: {
@@ -85,13 +94,22 @@ export type StudentPlacementData = {
         },
     },
     onboarding: (OnboardingDocs&{
+        deadline?: string,
         completed: {
-            submitted: string|false,
+            submitted: boolean,
+            submittedDate?: string,
             accepted?: boolean,
             filesViewed?: string[],
             formsCompleted?: {[key: string]: unknown},
             filesUploaded?: {[key: number]: string[]},
-        }})|false,
+        }})|false|null,
+    studentForename?: string,
+    studentSurname?: string,
+    studentEmail?: string,
+    skillsTargetsValues?: {[key: string]: {
+        provider: number[],
+        student: number[],
+    }}
 }
 
 export type PlacementQuestions = {
@@ -124,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,
@@ -154,56 +175,53 @@ export type PlacementListing = {
     locality: string,
     postal_code: string,
     country: string,
-    addressId?: string,
+    what3Words?: 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|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 = {
-    deadline?: string,
     message?: string,
-    deadlineType?: "date"|"days"
     forms?: string[],
     files?: string[],
-    formDetails?: {[key: string]:
-        {
-            name: string,
-            id: string,
-            description?: string,
-            product: Products,
-            oId: string,
-            form: CustomFormSchema
-        }},
     requiredFiles?: {fileName: string, fileType: string}[]
-    viewableFiles?: {[key: string]: FileItem},
 }
 
-export type PlacementTemplate = PlacementListing&{templateName: string};
+// export type PlacementTemplate = PlacementListing&{templateName: string};
 
 export type OrganisationAddressStages = "address"|"contacts"|"misc"|"review"|"complete";
 
@@ -241,7 +259,9 @@ export type OrganisationAddress = Address & {
     },
     primaryContactId?: string,
     default?: boolean,
-    flags?: ("addressMissing" | "noPrimaryContact")[]
+    flags?: ("addressMissing" | "noPrimaryContact")[],
+    color?: string;
+    image?: string|false;
 };
 
 export type Address = {
@@ -251,7 +271,8 @@ export type Address = {
     locality: string,
     postal_code: string,
     country: string,
-    geoHash?: string
+    geoHash?: string,
+    what3Words?: string
 };
 
 export type FlagCodes =
@@ -273,13 +294,17 @@ export type FlagCodes =
     "completeOnboarding"|
     "reviewOnboarding"|
     "requestedVisibleAddresses"|
-    "requestedVisiblePlacementListings"
+    "requestedVisiblePlacementListings"|
+    "addOnboarding"|
+    "studentNotAccepted"|
+    "reminder"
 
 
 export type UserData = {
     details: {
         forename: string,
         surname: string,
+        pronouns?: string,
         parentEmail?: string,
         year?: string
     },
@@ -307,18 +332,20 @@ 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",
-    viewUsers?: "all"|"some",
-    studentFilterValues?: string,
-    studentFilter?: string
-    visibleCohorts?: string,
+    viewStudents?: "all"|"some"|"none",
+    studentFilterValues?: string[], // comma delimited list of values, such as "a, b, c, d"
+    studentFilter?: string // Field on which students can be filtered
+    visibleCohorts?: string[], // comma delimited list of values
     readUpdates?: string[],
     contactProviderConsent?: boolean,
-    contactProviderConsenDate?: boolean
+    contactProviderConsentDate?: boolean
     referrals?: number,
     shareNameWithReferralLeaderboardConsent?: boolean,
     shareNameWithReferralLeaderboardConsentDate?: boolean,
@@ -327,9 +354,21 @@ export type UserData = {
     monthAdded?: number,
     placementsCharged?: boolean,
     visibleAddresses?: string[],
+    visibleSchools?: string[],
     visibleListings?: string[],
     requestedVisibleAddresses?: string[],
-    requestedVisibleListings?: string[]
+    requestedVisibleListings?: string[],
+    packageData?: BillingPackage,
+    viewAddresses?: "all"|"request"|"none"|"some",
+    viewSchools?: "all"|"request"|"none"|"some",
+    viewPlacementListings?: "all"|"request"|"none",
+    viewPlacementGroups?: "all"|"request"|"none",
+    skillsTargets?: string[],
+    skillsTargetsValues?: {[key: string]: {
+        provider: number[],
+        student: number[],
+    }},
+    alumniConversationUid?: string
 };
 
 export type AnalyticsItem = {
@@ -402,7 +441,13 @@ export type StaffUserPermissions =
     editCohorts?: boolean,
     deleteCohorts?: boolean,
     editRequests?: boolean,
-    deleteRequests?: boolean
+    deleteRequests?: boolean,
+    addEmailTemplates?: boolean,
+    editEmailTemplates?: boolean,
+    deleteEmailTemplates?: boolean,
+    addActivity?: boolean,
+    editActivity?: boolean,
+    deleteActivity?: boolean,
 }
 
 export type ProviderUserPermissions = {
@@ -428,6 +473,9 @@ export type ProviderUserPermissions = {
     viewPlacementGroups?: "all"|"request"|"none",
     viewAddresses?: "all"|"request"|"none",
     processApplicants?: boolean,
+    addSchools?: boolean,
+    editSchools?: boolean,
+    deleteSchools?: boolean,
     addAddresses?: boolean,
     editAddresses?: boolean,
     deleteAddresses?: boolean,
@@ -492,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,
+    // 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,
+    // 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,
+    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,
@@ -539,7 +608,10 @@ export type InstituteData = {
     studentsActive: number,
     staffActive: number,
     admin: string,
-    name: string
+    name: string,
+    monthAdded: number,
+    platformFee: number,
+    color?: string,
     verifiedProviders?: string[],
     awaitingProviderInsurance?: string[],
     verifiedRiskAssessments?: string[],
@@ -551,12 +623,37 @@ export type InstituteData = {
     cohortRequests: {[oId: string]: {[cohortId: string]: string[]}},
     externalProviderUploads?: boolean,
     discount?: string,
-    package?: string,
+    package: string,
     splitBilling?: boolean,
     adminBillingContactId?: string,
-    addOnPackages?: string[]
+    addOnPackages?: string[],
+    authorisedMISSystem?: {
+        name: "arbor",
+        data: {
+            url: string
+        }
+    },
+    acceptingAlumni?: boolean,
+    approveAlumni?: boolean,
+    shareAlumni?: boolean
+    approveAlumniMessages?: boolean,
+    anonymiseAlumniConvoStudents?: boolean,
+    alumniConversations?: boolean
 }&Address;
 
+export type ExternalActivity = {
+    title?: string,
+    description: string,
+    position?: number,
+    image?: string,
+    color: string,
+    public?: boolean,
+    oId?: string,
+    alumni?: boolean,
+    provider?: boolean,
+    permanent?: boolean
+}
+
 export type NotificationObject = {
     buttonURL: string,
     created: Timestamp,
@@ -647,6 +744,7 @@ export type Contact = {
     "address-line1": string,
     "address-line2": string,
     locality: string,
+    what3Words?: string,
     postal_code: string,
     country: string,
     created: string,
@@ -669,7 +767,9 @@ export type CohortData = {
     customWorkflow?: boolean,
     oId: string,
     product: Products,
+    schoolId?: string,
     designatedStaff?: string,
+    autoArchiveDate?: string,
     logType?: "basic"|"custom",
     logs?: {
         students?: string,
@@ -688,8 +788,8 @@ export type CohortData = {
     },
     providerFeedbackSent?: Timestamp,
     studentsFeedbackSent?: Timestamp,
-    billingEmail?: string,
-    billingContactId?: string
+    emailTemplates?: {[key in keyof typeof emailTemplates]: string},
+    skillsTargets?: string[]
 }
 
 export type ArrowObject = {
@@ -723,6 +823,7 @@ export type PlacementReviewDetails = {
     ["address-line2"]: string,
     locality: string,
     postal_code: string,
+    what3Words?: string,
     country: string,
     key: string,
     oId: string,
@@ -742,24 +843,27 @@ 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,
     requireRA?: boolean,
     requireDBS?: boolean,
     importedProviderForms: boolean,
-    currentStage: WorkflowStage,
+    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}
+    providerFeedback?: {[key: string]: unknown},
+    primaryColor?: string,
+    primaryImage?: string
 }
 
 export type BlogCategories = "students"|"providers"|"institutes"|"placementt"
@@ -829,6 +933,7 @@ export type Application = {
     uid: string,
     applicantWorkflowId: string,
     listingId: string,
+    addressId: string,
     providerId: string,
     reqUserType: "Students"|"Staff",
     completedSections: {[stage: number]: {
@@ -884,6 +989,8 @@ export type Event = {
 export type BillingPackage = {
     name: string,
     staffUnitCost: number,
+    platformFee: number,
+    platformFeeFrequency: "yearly"|"monthly",
     studentUnitCost: number,
     placementUnitCost: number,
     product: Products,
@@ -892,8 +999,165 @@ export type BillingPackage = {
     description: string
 }
 
+export type EmailTemplate = {
+    name: string,
+    created: Timestamp,
+    subject: string,
+    emailTemplate: string,
+    bodyText: Descendant[],
+    color?: string,
+    product: Products,
+    oId: string,
+    public?: boolean,
+}
+
+
+export type EmailTemplateConfig = {
+        description: string,
+        params: string[],
+        button?: {text: string, link: string},
+        type: "workflow"|"feedback"
+}
+
+
+export type Reminder = {
+    collection: "users"|"placements"|"placementListings",
+    documentId: string,
+    product: Products,
+    oId: string,
+    created: Timestamp,
+    title: string,
+    description?: string,
+    dueDate: string,
+    status: "upcoming"|"dismissed"
+}
+
+export type Sorts = {[label: string]: {
+    value: string
+    direction: "asc"|"desc"
+}}|undefined
+
+export type SchoolData = OrganisationAddress&{
+    billingEmail?: string,
+    billingContactId?: string,
+    authorisedMISSystem?: {
+        name: "arbor",
+        data: {
+            url: string
+        }
+    },
+    monthAdded: number,
+    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
+}