placementt-core 11.0.533 → 11.0.803

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[],
@@ -41,7 +43,7 @@ export type StudentPlacementData = {
     placementId?: string,
     addressId?: string,
     geoHash?: string,
-    statusType: "draft"|"submitted"|"active"|"completed"|"withdrawn",
+    statusType: "draft"|"submitted"|"active"|"completed"|"withdrawn"|"requested",
     questions: PlacementQuestions,
     staffRoles: string[],
     sector: string,
@@ -69,6 +71,11 @@ export type StudentPlacementData = {
     webpage?: string,
     providerLogs?: string[],
     studentsLogs?: string[],
+    notes?: {
+        providers?: Descendant[],
+        institutes?: Descendant[],
+        students?: Descendant[]
+    }
     staffLogs?: [],
     feedback: {
         students: {
@@ -85,13 +92,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 = {
@@ -154,6 +170,7 @@ export type PlacementListing = {
     locality: string,
     postal_code: string,
     country: string,
+    what3Words?: string,
     addressId?: string,
     geoHash?: string,
     status: "listed"|"unlisted"|"deleted"|"draft",
@@ -178,29 +195,17 @@ export type PlacementListing = {
     applicationType?: "simple"|"complex",
     applicantWorkflowId?: string,
     applicantWorkflow?: ApplicantStage[],
-    onboarding: OnboardingDocs|false,
+    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};
@@ -241,7 +246,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 +258,8 @@ export type Address = {
     locality: string,
     postal_code: string,
     country: string,
-    geoHash?: string
+    geoHash?: string,
+    what3Words?: string
 };
 
 export type FlagCodes =
@@ -273,13 +281,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
     },
@@ -312,13 +324,13 @@ export type UserData = {
     dismissedTutorials?: string[],
     dismissedTips?: string[],
     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 +339,20 @@ 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[],
+    }}
 };
 
 export type AnalyticsItem = {
@@ -402,7 +425,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 +457,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,
@@ -497,7 +529,7 @@ export type ProviderData = {
     staffActive: number,
     admin: string,
     name: string,
-    insurance: boolean,
+    insurance: boolean|"awaitingReview",
     regNumber?: string,
     insuranceExpiry: string,
     mapConsent?: boolean|"unlisted",
@@ -525,7 +557,7 @@ export type ProviderData = {
         locations?: number,
     },
     discount?: string,
-    package?: string,
+    package: string,
     splitBilling?: boolean,
     adminBillingContactId: string,
     addOnPackages?: string[],
@@ -539,7 +571,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 +586,29 @@ 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
+        }
+    },
+    providerActivities?: {[key: string]: ProviderActivity}
 }&Address;
 
+export type ProviderActivity = {
+    title?: string,
+    description: string,
+    position?: number,
+    image?: string,
+    color: string,
+    public?: boolean,
+    oId?: string
+}
+
 export type NotificationObject = {
     buttonURL: string,
     created: Timestamp,
@@ -647,6 +699,7 @@ export type Contact = {
     "address-line1": string,
     "address-line2": string,
     locality: string,
+    what3Words?: string,
     postal_code: string,
     country: string,
     created: string,
@@ -669,6 +722,7 @@ export type CohortData = {
     customWorkflow?: boolean,
     oId: string,
     product: Products,
+    schoolId?: string,
     designatedStaff?: string,
     logType?: "basic"|"custom",
     logs?: {
@@ -688,8 +742,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 +777,7 @@ export type PlacementReviewDetails = {
     ["address-line2"]: string,
     locality: string,
     postal_code: string,
+    what3Words?: string,
     country: string,
     key: string,
     oId: string,
@@ -752,14 +807,16 @@ export type PlacementReviewDetails = {
     requireRA?: boolean,
     requireDBS?: boolean,
     importedProviderForms: boolean,
-    currentStage: WorkflowStage,
+    currentStage: WorkflowStage&{files: {[fileId: string]: {name: string, url: string}}},
     placementId?: string,
     incompleteItems: {[key: number]: string[]},
     riskAssessmentData?: {[key: string]: unknown}[],
     dbsCheckData?: {[key: string]: unknown}[],
     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 +886,7 @@ export type Application = {
     uid: string,
     applicantWorkflowId: string,
     listingId: string,
+    addressId: string,
     providerId: string,
     reqUserType: "Students"|"Staff",
     completedSections: {[stage: number]: {
@@ -884,6 +942,8 @@ export type Event = {
 export type BillingPackage = {
     name: string,
     staffUnitCost: number,
+    platformFee: number,
+    platformFeeFrequency: "yearly"|"monthly",
     studentUnitCost: number,
     placementUnitCost: number,
     product: Products,
@@ -892,8 +952,53 @@ 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
+}

package/src/util.ts

@@ -1,16 +1,26 @@
+import {where} from "firebase/firestore";
+import FirebaseQuery from "./firebase/firebaseQuery";
 import {FlagCodes, InstituteData, StudentPlacementData, UserData, WorkflowStage} from "./typeDefinitions";
-
-type Params = {
-    placement : StudentPlacementData,
-    studentData: UserData,
-    workflow: WorkflowStage[],
-    institute: InstituteData,
-    user: UserData
+import {convertDate} from "./firebase/util";
+
+type PlacementFlagCodeParams = {
+    placement : StudentPlacementData, // Placement we get flag codes for
+    studentData: UserData, // Student associated with the placement
+    workflow: WorkflowStage[], // Workflow associated with the placement
+    institute: InstituteData, // Associated institutes
+    user: UserData // User that is fetching flag codes (staff or student)
 };
+/**
+ * Description of function
+ * 
+ */
+
+type PlaceFlagCodeReturn = Promise<FlagCodes[]>;
 
-export const getPlacementFlagCodes = ({placement, studentData, workflow, institute, user}: Params) => {
+export const getPlacementFlagCodes = async ({placement, studentData, workflow, institute, user}: PlacementFlagCodeParams):PlaceFlagCodeReturn => {
     let flags:FlagCodes[] = placement.flags || [];
 
+    const firebaseQuery = new FirebaseQuery();
 
     if (!studentData.details.parentEmail && !flags.find((x) => x.includes("noParentEmail"))) {
         if (workflow.find((obj) => obj.id === placement.status)?.userType === "Parent") {
@@ -32,51 +42,70 @@ export const getPlacementFlagCodes = ({placement, studentData, workflow, institu
     const dbsCheckNotVerified = !institute?.verifiedDbsChecks?.includes(placement.placementId || placement.id);
     const awaitingDbsCheck = !placement.dbsCheck || institute?.awaitingPlacementDbsChecks?.includes(placement.placementId || placement.id);
 
-    if (user.userType === "Staff" && placement.insurance && placementIsPostProviderReview && placementNotEnded && providerUnverified && !awaitingProviderInsurance) {
+    const reminderCount = (await firebaseQuery.getCount(["reminders"], [where("oId", "==", user.oId), where("uid", "==", user.id), where("dueDate", "<=", convertDate(new Date(), "dbstring") as string), where("documentId", "==", placement.id), where("status", "==", "upcoming")]));
+
+    if (reminderCount) {
+        flags.push("reminder");
+    }
+
+    if (user.userType === "Staff" && user.product === "institutes" && placement.insurance && placementIsPostProviderReview && placementNotEnded && providerUnverified && !awaitingProviderInsurance) {
         console.log("Add insurance flag!");
         flags.includes("noInsurance") || flags.push("noInsurance");
     } else {
         flags = flags.filter((x) => x !== "noInsurance");
     }
 
-    if (user.userType === "Staff" && placementIsPostProviderReview && placementNotEnded && awaitingProviderInsurance) {
+    if (user.product === "providers" && placement.statusType === "requested") {
+        flags.includes("studentNotAccepted") || flags.push("studentNotAccepted");
+    } else {
+        flags = flags.filter((x) => x !== "studentNotAccepted");
+    }
+
+
+    if (user.userType === "Staff" && user.product === "institutes" && placementIsPostProviderReview && placementNotEnded && awaitingProviderInsurance) {
         flags.includes("awaitingInsurance") || flags.push("awaitingInsurance");
     } else {
         flags = flags.filter((x) => x !== "awaitingInsurance");
     }
 
-    if (user.userType === "Staff" && placement.dbsCheck && workflow.find((stage) => stage.dbsCheck) && placement.dbsCheck !== true && placementIsPostProviderReview && placementNotEnded && dbsCheckNotVerified && !awaitingDbsCheck) {
+    if (user.userType === "Staff" && user.product === "institutes" && placement.dbsCheck && workflow.find((stage) => stage.dbsCheck) && placement.dbsCheck !== true && placementIsPostProviderReview && placementNotEnded && dbsCheckNotVerified && !awaitingDbsCheck) {
         flags.includes("noDbsCheck") || flags.push("noDbsCheck");
     } else {
         flags = flags.filter((x) => x !== "noDbsCheck");
     }
 
-    if (user.userType === "Staff" && placementIsPostProviderReview && workflow.find((stage) => stage.dbsCheck) && placementNotEnded && awaitingProviderInsurance) {
+    if (user.userType === "Staff" && user.product === "institutes" && placementIsPostProviderReview && workflow.find((stage) => stage.dbsCheck) && placementNotEnded && awaitingProviderInsurance) {
         flags.includes("awaitingDbsCheck") || flags.push("awaitingDbsCheck");
     } else {
         flags = flags.filter((x) => x !== "awaitingDbsCheck");
     }
 
-    if (user.userType === "Staff" && placement.riskAssessment && workflow.find((stage) => stage.riskAssessment) && placement.riskAssessment !== true && placementIsPostProviderReview && placementNotEnded && riskAssessmentNotVerified && !awaitingRiskAssessment) {
+    if (user.userType === "Staff" && user.product === "institutes" && placement.riskAssessment && workflow.find((stage) => stage.riskAssessment) && placement.riskAssessment !== true && placementIsPostProviderReview && placementNotEnded && riskAssessmentNotVerified && !awaitingRiskAssessment) {
         console.log("Add RA flag!");
         flags.includes("noRiskAssessment") || flags.push("noRiskAssessment");
     } else {
         flags = flags.filter((x) => x !== "noRiskAssessment");
     }
 
-    if (user.userType === "Staff" && placementIsPostProviderReview && workflow.find((stage) => stage.riskAssessment) && placementNotEnded && awaitingProviderInsurance) {
+    if (user.userType === "Staff" && user.product === "institutes" && placementIsPostProviderReview && workflow.find((stage) => stage.riskAssessment) && placementNotEnded && awaitingProviderInsurance) {
         flags.includes("awaitingRiskAssessment") || flags.push("awaitingRiskAssessment");
     } else {
         flags = flags.filter((x) => x !== "awaitingRiskAssessment");
     }
 
-    if (user.userType === "Staff" && user.product === "providers" && user.oId === placement.providerId && placement.onboarding && (placement.onboarding.completed?.submitted && !placement.onboarding.completed.accepted) && (placement.inProgress || placement.active)) {
+    if (placement.inProgress && user.userType === "Staff" && user.product === "providers" && user.oId === placement.providerId && placement.onboarding === null) {
+        flags.includes("addOnboarding") || flags.push("addOnboarding");
+    } else {
+        flags = flags.filter((x) => x !== "addOnboarding");
+    }
+
+    if (placement.inProgress && user.userType === "Staff" && user.product === "providers" && user.oId === placement.providerId && placement.onboarding && (placement.onboarding.completed?.submitted && !placement.onboarding.completed.accepted) && (placement.inProgress || placement.active)) {
         flags.includes("reviewOnboarding") || flags.push("reviewOnboarding");
     } else {
         flags = flags.filter((x) => x !== "reviewOnboarding");
     }
 
-    if (user.userType === "Students" && placement.onboarding && (!placement.onboarding.completed || (placement.onboarding.completed && !placement.onboarding.completed?.submitted)) && (placement.inProgress || placement.active)) {
+    if (placement.inProgress && user.userType === "Students" && placement.onboarding && (!placement.onboarding.completed || (placement.onboarding.completed && !placement.onboarding.completed?.submitted)) && (placement.inProgress || placement.active)) {
         flags.includes("completeOnboarding") || flags.push("completeOnboarding");
     } else {
         flags = flags.filter((x) => x !== "completeOnboarding");
@@ -87,7 +116,6 @@ export const getPlacementFlagCodes = ({placement, studentData, workflow, institu
 };
 
 
-
 export function objectsEqualNew(a: any, b: any): boolean { // Works with arrays or objects.
     if (a === b) {
         return true;