placementt-core 1.20.231 → 1.300.4

package/src/typeDefinitions.ts

@@ -1,1130 +1,1261 @@
-import {DocumentData, DocumentReference, Timestamp} from "firebase/firestore";
-import {Descendant} from "slate";
-import {emailTemplates} from "./constants";
-
-export type Products = "institutes"|"providers"|"students"|"admin";
-
-export type StudentPlacementData = {
-    title: string,
-    reqUserType: "Students" | "Staff" | "Provider" | "Parent",
-    uid: string,
-    startDate: string,
-    endDate: string,
-    providerId?: string,
-    name: string,
-    parentKey: string,
-    parentEmail: string,
-    providerKey: string,
-    parentExpiry: string,
-    providerExpiry: string,
-    providerEmail: string,
-    providerEmailed: Timestamp,
-    parentEmailed: Timestamp,
-    providerPhone: string,
-    website?: string,
-    id:string,
-    providerCompleted: string[],
-    oId: string,
-    contactForename: string,
-    contactSurname: string,
-    status: number,
-    nextStatus: number,
-    ["address-line1"]: string,
-    ["address-line2"]: string,
-    locality: string,
-    postal_code: string,
-    what3Words?: string,
-    country: string,
-    cohort?: string,
-    leadTimes: string[],
-    flags?: FlagCodes[],
-    mapConsent: true | "institute" | false,
-    mapConsentDate?: string,
-    placementId?: string,
-    addressId?: string,
-    geoHash?: string,
-    statusType: "draft"|"submitted"|"active"|"completed"|"withdrawn"|"requested",
-    questions: PlacementQuestions,
-    staffRoles: string[],
-    sector: string,
-    subsector: string,
-    importedProviderForms?: boolean,
-    analytics: string[],
-    units: string,
-    schoolId?: string,
-    active: boolean,
-    completed: boolean,
-    personalAnalytics?: string[],
-    completedStages?: number[],
-    contactId?: string
-    created: string,
-    inProgress: boolean,
-    draft: boolean,
-    activeDates: string[],
-    insurance: boolean|"awaitingReview",
-    insuranceSkippedReason?: string,
-    riskAssessment?: boolean|"awaitingReview",
-    riskAssessmentType?: "file"|"form"|"skipped",
-    riskAssessmentData?: {[key:string]: unknown}[]|string,
-    dbsCheck?: boolean|"awaitingReview",
-    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: {
-            completed: boolean, 
-            data?: {[key: string]: unknown}
-        },
-        provider: {
-            completed: boolean, 
-            data?: {[key: string]: unknown}
-        },
-        staff: {
-            completed: boolean, 
-            data?: {[key: string]: unknown}
-        },
-    },
-    onboarding: (OnboardingDocs&{
-        deadline?: string,
-        completed: {
-            submitted: boolean,
-            submittedDate?: string,
-            accepted?: boolean,
-            filesViewed?: string[],
-            formsCompleted?: {[key: string]: unknown},
-            filesUploaded?: {[key: number]: string[]},
-        }})|false|null,
-    studentForename?: string,
-    studentSurname?: string,
-    studentEmail?: string,
-    skillsTargetsValues?: {[key: string]: {
-        provider: number[],
-        student: number[],
-    }}
-}
-
-export type PlacementQuestions = {
-    title: string
-    description: string
-    dressCode: string
-    dressCodeText?: string
-    firstDayContact: string
-    firstAider?: string
-    equipment: string
-    responsibilities: string
-    experiencesGiven: string
-    experienceDesired: string
-    otherAdvice: string
-    carParking: boolean
-    bikeStorage: boolean
-    wheelchairFriendly: boolean
-    kitchen: boolean
-    lunchArrangements?: string
-    hours: any,
-    studentLevel: "gcse"|"college"|"undergraduate"|"postgraduate"|"over18",
-    studentSublevel: string[],
-    desiredLength: number,
-    desiredMinLength?: number, 
-    desiredMaxLength?: number,
-    desiredLengthUnits: "days"|"weeks"|"months",
-    maximumStudents: number,
-    workingLocation: "inPerson"|"hybrid"|"remote",
-    pay?: number,
-    payFrequency: "total"|"hourly"|"daily"|"weekly"|"monthly"|"annually",
-}
-
-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 PlacementListing = {
-    title: string,
-    uid: string,
-    template?: string,
-    providerId?: string,
-    name: string,
-    providerEmail: string,
-    providerPhone: string,
-    id:string,
-    studentType: "secondary" | "higher" | "undergraduate" | "postgraduate"
-    contactForename: string,
-    contactSurname: string,
-    ["address-line1"]: string,
-    ["address-line2"]: string,
-    locality: string,
-    postal_code: string,
-    country: string,
-    what3Words?: string,
-    addressId?: string,
-    geoHash?: string,
-    status: "listed"|"unlisted"|"deleted"|"draft",
-    questions: PlacementQuestions,
-    savedBy?: {[key:string]: {
-        exists: true,
-        providerConsent: boolean,
-        providerConsentDate?: Timestamp,
-        status: "uploaded"|"approved"|"rejected"|"blocked"}},
-    mapConsent?: boolean,
-    mapConsentData?: string,
-    uploadedBy: "student"|"institute"|"provider",
-    riskAssessmentType?: "file"|"form"|"skipped",
-    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,
-}
-
-export type OnboardingDocs = {
-    message?: string,
-    forms?: string[],
-    files?: string[],
-    requiredFiles?: {fileName: string, fileType: string}[]
-}
-
-export type PlacementTemplate = PlacementListing&{templateName: string};
-
-export type OrganisationAddressStages = "address"|"contacts"|"misc"|"review"|"complete";
-
-export type OrganisationAddress = Address & {
-    name?: string,
-    savedBy?: string[],
-    product: Products,
-    oId: string,
-    stage: OrganisationAddressStages,
-    additionalQuestions?: {
-        bikeStorage?: boolean,
-        kitchen?: boolean,
-        parking?: boolean,
-        disabledAccess?: boolean,
-    },
-    contacts?: {
-        firstAid?: {
-            name?: string,
-            phone?: string,
-            email?: string,
-            location?: string
-        }[],
-        security?: {
-            name?: string,
-            phone?: string,
-            email?: string,
-            location?: string
-        }[],
-        reception?: {
-            name?: string,
-            phone?: string,
-            email?: string,
-            location?: string
-        }[],
-    },
-    primaryContactId?: string,
-    default?: boolean,
-    flags?: ("addressMissing" | "noPrimaryContact")[],
-    color?: string;
-    image?: string|false;
-};
-
-export type Address = {
-    id?: string,
-    ["address-line1"]: string,
-    ["address-line2"]: string,
-    locality: string,
-    postal_code: string,
-    country: string,
-    geoHash?: string,
-    what3Words?: string
-};
-
-export type FlagCodes =
-    "inactive" |
-    "noParentEmailWarning" |
-    "noParentEmailError" |
-    "overdue" |
-    "noInsurance" |
-    "providerRejection" | 
-    "nearingStart"|
-    "awaitingInsurance"|
-    "noRiskAssessment"|
-    "awaitingRiskAssessment"|
-    "parentEmailFailed"|
-    "providerEmailFailed"|
-    "userEmailFailed"|
-    "noDbsCheck"|
-    "awaitingDbsCheck"|
-    "completeOnboarding"|
-    "reviewOnboarding"|
-    "requestedVisibleAddresses"|
-    "requestedVisiblePlacementListings"|
-    "addOnboarding"|
-    "studentNotAccepted"|
-    "reminder"
-
-
-export type UserData = {
-    details: {
-        forename: string,
-        surname: string,
-        pronouns?: string,
-        parentEmail?: string,
-        year?: string
-    },
-    renewalMonth: number,
-    placementCharged?: boolean,
-    algoliaKey: string,
-    email: string,
-    phone?: string,
-    status: "active" | "inactive" | "unclaimed",
-    favGuidance?: string[];
-    oId: string,
-    id: string,
-    resetExpiry?: {seconds: number},
-    product: Products,
-    userGroup?: string,
-    userType: "Staff"|"Students",
-    created: string,
-    activated: string,
-    groupData?: UserGroupData,
-    staffRoles: string[],
-    flags?: FlagCodes[],
-    cohortRequests: {[oId: string]: string[]},
-    cohorts: {[oId: string]: string[]},
-    analytics?: AnalyticsItem,
-    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"
-    studentFilter?: string // Field on which students can be filtered
-    visibleCohorts?: string[], // comma delimited list of values
-    readUpdates?: string[],
-    contactProviderConsent?: boolean,
-    contactProviderConsentDate?: boolean
-    referrals?: number,
-    shareNameWithReferralLeaderboardConsent?: boolean,
-    shareNameWithReferralLeaderboardConsentDate?: boolean,
-    referralCode?: string,
-    notificationFrequency?: "daily"|"weekly"|"fortnightly"|"never",
-    monthAdded?: number,
-    placementsCharged?: boolean,
-    visibleAddresses?: string[],
-    visibleSchools?: string[],
-    visibleListings?: string[],
-    requestedVisibleAddresses?: 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 = {
-    units?: "placements"|"weeks"|"days"|"hours",
-    name?: string
-    total?: number,
-    completion?: {
-        total?: number,
-        completed?: number
-    },
-    time?: {[key: string]: {date?:string, total?: number, completion?: {total?: number, completed?:number}}},
-    year?: {[key: string]: {year?: number, total?: number, completion?: {total?: number, completed?:number}}},
-    subtypes?: {[key:string]: AnalyticsItem}
-}
-
-export type UserGroupData = {
-    id: string,
-    default?: boolean,
-    name: string,
-    template: "Staff"|"Students",
-    oId: string,
-    product: Products,
-    viewStudents: "all"|"filter"|"none",
-    filterUsersBy?: string,
-    filterUsersValue?: string,
-}&ProviderUserPermissions
-
-export type StaffUserGroup = UserGroupData & StaffUserPermissions
-export type ProviderUserGroup = UserGroupData & ProviderUserPermissions
-
-export type StaffUserPermissions =
-    UserGroupData & {
-    viewStaff: boolean,
-    addStaff?: boolean,
-    activateStaff?: boolean,
-    editStaff?: boolean,
-    deleteStaff?: boolean,
-    addStaffGroups?: boolean,
-    editStaffGroups?: boolean,
-    deleteStaffGroups?: boolean,
-    addStudents?: boolean,
-    activateStudents?: boolean,
-    editStudents?: boolean,
-    deleteStudents?: boolean,
-    viewSetup?: boolean,
-    editInstitute?: boolean,
-    addForms?: boolean,
-    editForms?: boolean,
-    deleteForms?: boolean,
-    addFiles?: boolean,
-    deleteFiles?: boolean,
-    viewBilling?: boolean,
-    manageBilling?: boolean,
-    proposePlacements?: boolean,
-    createCohorts?: boolean,
-    viewPlacements?: boolean,
-    viewPlacementTasks?: boolean,
-    signOffPlacements?: boolean,
-    editPlacements?: boolean,
-    addPlacements?: boolean,
-    deletePlacements?: boolean,
-    verifyInsurance?: boolean,
-    verifyListings?: boolean
-    viewDatabase?: boolean,
-    addListings?: boolean,
-    deleteListings?: boolean,
-    verifyRiskAssessments?: boolean,
-    verifyDbsChecks?: boolean,
-    addCohorts?: boolean,
-    editCohorts?: boolean,
-    deleteCohorts?: boolean,
-    editRequests?: boolean,
-    deleteRequests?: boolean,
-    addEmailTemplates?: boolean,
-    editEmailTemplates?: boolean,
-    deleteEmailTemplates?: boolean,
-    addActivity?: boolean,
-    editActivity?: boolean,
-    deleteActivity?: boolean,
-}
-
-export type ProviderUserPermissions = {
-    viewStaff: boolean,
-    addStaff?: boolean,
-    activateStaff?: boolean,
-    editStaff?: boolean,
-    deleteStaff?: boolean,
-    addUserGroups?: boolean,
-    editUserGroups?: boolean,
-    deleteUserGroups?: boolean,
-    addStudents?: boolean,
-    addForms?: boolean,
-    editForms?: boolean,
-    deleteForms?: boolean,
-    addFiles?: boolean,
-    deleteFiles?: boolean,
-    viewBilling?: boolean,
-    manageBilling?: boolean,
-    createPlacementListing?: "any"|"template"|"none",
-    createPlacementTemplate?: boolean,
-    viewPlacementListings?: "all"|"request"|"none",
-    viewPlacementGroups?: "all"|"request"|"none",
-    viewAddresses?: "all"|"request"|"none",
-    processApplicants?: boolean,
-    addSchools?: boolean,
-    editSchools?: boolean,
-    deleteSchools?: boolean,
-    addAddresses?: boolean,
-    editAddresses?: boolean,
-    deleteAddresses?: boolean,
-    addApplicantWorkflows?: boolean,
-    editApplicantWorkflows?: boolean,
-    deleteApplicantWorkflows?: boolean,
-    editRequests?: boolean,
-    deleteRequests?: boolean,
-    manageAccessRequests?: boolean,
-    manageRegistrationRequests?: boolean,
-}
-
-export type RegistrationRequest = {
-    forename: string,
-    surname: string,
-    email: string,
-    message: string,
-    created: string,
-    oId: string,
-    product: "providers"|"institutes"
-}
-
-export type WorkflowStage = {
-    id: number,
-    name: string,
-    permanent?: boolean,
-    checkpoint?: boolean,
-    buttons?: {id: number, name: string|false, required: boolean}[],
-    pos?: { x: number, y: number },
-    userType?: "Students" | "Staff" | "Provider" | "Parent",
-    forms?: string[],
-    files?: string[],
-    deadline?: string,
-    deadlineType?: "date"|"days"
-    formDetails?: [{name: string}],
-    eli?: boolean,
-    riskAssessment?: boolean,
-    dbsCheck?: boolean,
-    defaultForms?: {
-        name: string,
-        description: string,
-        time: "during"|"post",
-        user: "staff"|"students"|"provider",
-        details: CustomFormSchema
-    }[],
-    requiredFiles?: {fileName: string, fileType: string}[]
-};
-
-export type ProviderPlacementData = {
-    title: string,
-    name: string,
-    providerPhone: string,
-    providerEmail: string,
-    contactForename: string,
-    contactSurname: string,
-    providerId: string,
-    addressId: string,
-    sector: string,
-    subsector: string,
-    id?: string
-};
-
-
-export type ProviderData = {
-    staff: number,
-    staffFields: string[],
-    staffActive: number,
-    admin: string,
-    name: string,
-    insurance: boolean|"awaitingReview",
-    insuranceSkippedReason?: string,
-    regNumber?: string,
-    insuranceExpiry: string,
-    mapConsent?: boolean|"unlisted",
-    mapConsentDate?: string,
-    staffGuidance?: {[key:number]: string},
-    about?: string,
-    sector: string,
-    defAddress: string,
-    subsector: string,
-    website?: 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[],
-}
-
-export type InstituteData = {
-    students: number,
-    staff: number,
-    studentsFields: string[],
-    staffFields: string[],
-    studentsActive: number,
-    staffActive: number,
-    admin: string,
-    name: string,
-    monthAdded: number,
-    platformFee: number,
-    color?: string,
-    verifiedProviders?: string[],
-    awaitingProviderInsurance?: string[],
-    verifiedRiskAssessments?: string[],
-    awaitingPlacementRiskAssessments?: string[],
-    verifiedDbsChecks?: string[],
-    awaitingPlacementDbsChecks?: string[],
-    staffGuidance?: {[key:number]: string}
-    studentsGuidance?: {[key:number]: string},
-    cohortRequests: {[oId: string]: {[cohortId: string]: string[]}},
-    externalProviderUploads?: boolean,
-    discount?: string,
-    package: string,
-    splitBilling?: boolean,
-    adminBillingContactId?: 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,
-}
-
-export type NotificationObject = {
-    buttonURL: string,
-    created: Timestamp,
-    description: string,
-    title: string,
-    viewableBy: string[],
-    viewedBy: string[],
-    docPath: DocumentReference<DocumentData>
-}
-
-export type CustomFormSchemaField = {
-    id: number,
-    label: string,
-    required: boolean,
-    type: "short"|"long"|"number"|"date"|"dropdown"|"checkbox"|"rating" // If Microsoft forms has more, make a note and I'll add them
-    width: number, // 1-12 default 12
-    subtitle?: string,
-    extra: {
-        default?: boolean /* type: checkbox */ | string /* type: short, long, dropdown (inputted option) */ | number /* type:number */,
-        min?: number /* type: number */
-        max?: number /* type: number */
-        minRows?: number /* type: long */
-        options?: string[] // from dropdown only
-        levels?: number // For ratings, number of stars.
-    }
-}
-
-export type CustomFormSchemaSection = 
-    {
-        id: number // random
-        title?: string,
-        description?: string,
-        fields: CustomFormSchemaField[]
-    }
-
-
-export type CustomFormSchema = {
-    name?: string,
-    description?: string,
-    updated?: string,
-    id?: string,
-    form?: CustomFormSchemaSection[]}
-
-export type StaffRoles = {
-    name: string,
-    filters: {
-        students: string[],
-        fields: {[key:string]: unknown},
-    },
-    staff: string[]
-};
-
-export type QueryObjectConstraint = [string, "=="|"<"|"<="|">="|">"|"!="|"array-contains"|"array-contains-any"|"in"|"not-in", string|boolean][]
-
-export type QueryObject = {
-    path: string[],
-    where?: QueryObjectConstraint,
-    orderBy?: string
-};
-
-export type Note = {
-    title?: string,
-    body?: {
-        type: string;
-        children: {
-            text: string;
-        }[];
-    }[],
-    created: string,
-    updated: string
-}
-
-export type Referral = {
-    signUps: number,
-    volume: number,
-    product: Products,
-    expiry: Timestamp,
-    name: string
-}
-
-export type Contact = {
-    id: string,
-    contactForename: string,
-    contactSurname: string,
-    name: string,
-    providerEmail: string,
-    providerPhone: number,
-    "address-line1": string,
-    "address-line2": string,
-    locality: string,
-    what3Words?: string,
-    postal_code: string,
-    country: string,
-    created: string,
-    docPath: unknown
-}
-
-
-export type CohortData = {
-    id?: string,
-    name: string,
-    placementType: "defined"|"continuous",
-    forms?: string[],
-    files?: string[],
-    startSubmission: string,
-    endSubmission: string,
-    startPlacements: string,
-    endPlacements: string,
-    stage: "info"|"name"|"placementType"|"students"|"workflow"|"review"|"created"|"archived",
-    workflow: WorkflowStage[]
-    customWorkflow?: boolean,
-    oId: string,
-    product: Products,
-    schoolId?: string,
-    designatedStaff?: string,
-    logType?: "basic"|"custom",
-    logs?: {
-        students?: string,
-        staff?: string,
-        provider?: string,
-    }
-    feedback?: {
-        students?: string,
-        staff?: string,
-        provider?: string,
-    },
-    feedbackText?: {
-        students?: Descendant[],
-        staff?: Descendant[],
-        provider?: Descendant[],
-    },
-    providerFeedbackSent?: Timestamp,
-    studentsFeedbackSent?: Timestamp,
-    emailTemplates?: {[key in keyof typeof emailTemplates]: string},
-    skillsTargets?: string[]
-}
-
-export type ArrowObject = {
-    start: number|string,
-    end: number|string,
-    name: string|false,
-    required?: boolean,
-    screenX?: number,
-}
-
-
-export type PlacementReviewDetails = {
-    activeDates: string[],
-    studentForename: string,
-    studentSurname: string,
-    instituteName: string,
-    title: string,
-    product: string,
-    name: string,
-    startDate: string,
-    endDate: string,
-    providerEmail: string,
-    providerPhone: string,
-    contactForename: string,
-    contactSurname: string,
-    cohort: string,
-    cohortData?: CohortData,
-    providerKey: string,
-    status: number,
-    ["address-line1"]: string,
-    ["address-line2"]: string,
-    locality: string,
-    postal_code: string,
-    what3Words?: string,
-    country: string,
-    key: string,
-    oId: string,
-    providerCompleted: string[],
-    providerId: string,
-    questions: PlacementQuestions,
-    mapConsent: boolean | "institute",
-    userType: string,
-    id: string,
-    uid: string,
-    leadTimes: string[],
-    requiredSections: string[],
-    existingPlacements?: {
-        [key: string]: {
-            mapConsent: boolean,
-            jobTitle: string,
-            questions: PlacementQuestions,
-            riskAssessment: boolean|"awaitingReview",
-            riskAssessmentType: "form"|"file",
-            riskAssessmentData?: {[key: string]: unknown}|string,
-            dbsCheck: boolean|"awaitingReview",
-            dbsCheckType: "form"|"file",
-            dbsCheckData?: {[key: string]: unknown}|string,
-        }
-    },
-    requireELI?: boolean,
-    requireRA?: boolean,
-    requireDBS?: boolean,
-    importedProviderForms: boolean,
-    currentStage: WorkflowStage&{files: {[fileId: string]: {name: string, url: string}}},
-    placementId?: string,
-    incompleteItems: {[key: number]: string[]},
-    riskAssessmentData?: {[key: string]: unknown}[]|string,
-    dbsCheckData?: {[key: string]: unknown}[]|string,
-    feedbackText?: Descendant[],
-    feedback: CustomFormSchema,
-    providerFeedback?: {[key: string]: unknown},
-    primaryColor?: string,
-    primaryImage?: string
-}
-
-export type BlogCategories = "students"|"providers"|"institutes"|"placementt"
-
-export type Blog = {
-    title?: string,
-    summary?: string,
-    body?: Descendant[],
-    uploaded?: string,
-    category?: BlogCategories,
-    author?: string,
-    tags?: string
-}
-
-export type PlacementExportObject = {
-    cohortId: string,
-    startDate?: string,
-    endDate?: string,
-    allTime?: boolean,
-    includeStudentData?: boolean,
-    activePlacements?: boolean,
-    completedPlacements?: boolean,
-}
-
-
-
-export type ApplicantWorkflow = {
-    id?: string,
-    name: string,
-    forms?: string[],
-    files?: string[],
-    workflow: ApplicantStage[]
-    customWorkflow?: boolean,
-    oId: string,
-    product: Products,
-    type: "simple"|"complex"
-}
-
-export type ApplicantStage = {
-    id: number,
-    name: string,
-    message?: string,
-    userType?: "Students" | "Staff",
-    permanent?: boolean,
-    checkpoint?: boolean,
-    buttons?: {id: number, name: string|false, required: boolean}[],
-    pos?: { x: number, y: number },
-    forms?: string[],
-    files?: string[],
-    deadline?: string,
-    deadlineType?: "date"|"days"
-    formDetails?: {[key: string]: {
-        name: string,
-        id: string,
-        description?: string,
-        product: Products,
-        oId: string,
-        form: CustomFormSchema
-    }},
-    requiredFiles?: {fileName: string, fileType: string}[]
-    portfolio?: boolean,
-    viewableFiles?: {[key: string]: FileItem},
-};
-
-export type Application = {
-    id?: string,
-    uid: string,
-    applicantWorkflowId: string,
-    listingId: string,
-    addressId: string,
-    providerId: string,
-    reqUserType: "Students"|"Staff",
-    completedSections: {[stage: number]: {
-        submitted?: string,
-        filesViewed?: string[],
-        formsCompleted?: {[key: string]: unknown},
-        filesUploaded?: {[key: number]: string[]},
-    }},
-    created: string,
-    submitted: string,
-    startDate: string,
-    endDate: string,
-    leadTimes?: string[],
-    stage: number, // This is what stage of the custom workflow.
-    outcomeMessage?: string,
-    status: "draft"|"submitted"|"approved"|"declined",
-    placementId?: string,
-}
-
-export type Report = {
-    added: string,
-    id: string,
-    oId: string,
-    product: Products,
-    pId: string,
-    reason: string,
-    uid: string,
-    status: "open"|"closed"
-}
-
-
-export type FileItem = {
-    product: Products,
-    oId: string,
-    added: string,
-    name: string,
-    fileName: string,
-    url?: string
-}
-
-export type Event = {
-    collection: "users"|"placements"|"placementListings",
-    documentId: string,
-    product: Products,
-    oId: string,
-    created: Timestamp,
-    title: string,
-    description?: string,
-    severity: string,
-    button?: {title: string, url: string}
-}
-
-export type BillingPackage = {
-    name: string,
-    staffUnitCost: number,
-    platformFee: number,
-    platformFeeFrequency: "yearly"|"monthly",
-    studentUnitCost: number,
-    placementUnitCost: number,
-    product: Products,
-    priority: number,
-    features: {[key: string]: number|boolean|string},
-    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
+import {DocumentData, DocumentReference, Timestamp} from "firebase/firestore";
+import {Descendant} from "slate";
+import {emailTemplates} from "./constants";
+import {FilterObject} from "./hooks";
+
+export type Products = "institutes"|"providers"|"students"|"admin";
+
+export type StudentPlacementData = {
+    title: string,
+    reqUserType: "Students" | "Staff" | "Provider" | "Parent",
+    uid: string,
+    startDate: string,
+    endDate: string,
+    providerId?: string,
+    name: string,
+    parentKey: string,
+    parentEmail: string,
+    providerKey: string,
+    parentExpiry: string,
+    providerExpiry: string,
+    providerEmail: string,
+    providerEmailed: Timestamp,
+    parentEmailed: Timestamp,
+    providerPhone: string,
+    studentDescription?: string,
+    website?: string,
+    id:string,
+    providerCompleted: string[],
+    oId: string,
+    contactForename: string,
+    contactSurname: string,
+    status: number,
+    nextStatus: number,
+    ["address-line1"]: string,
+    ["address-line2"]: string,
+    locality: string,
+    postal_code: string,
+    what3Words?: string,
+    country: string,
+    cohort?: string,
+    leadTimes: string[],
+    flags?: FlagCodes[],
+    mapConsent: true | false,
+    mapConsentDate?: string,
+    eventsConsent: true | false,
+    eventsConsentDate?: string,
+    placementId?: string,
+    providerContactId?: string,
+    geoHash?: string,
+    statusType: "draft"|"submitted"|"active"|"completed"|"withdrawn"|"requested",
+    questions: PlacementQuestions,
+    staffRoles: string[],
+    sector: string,
+    subsector: string,
+    importedProviderForms?: boolean,
+    analytics: string[],
+    units: string,
+    schoolId?: string,
+    active: boolean,
+    completed: boolean,
+    personalAnalytics?: string[],
+    completedStages?: number[],
+    contactId?: string
+    created: string,
+    inProgress: boolean,
+    draft: boolean,
+    activeDates: string[],
+    insurance: boolean|"awaitingReview",
+    insuranceSkippedReason?: string,
+    riskAssessment?: boolean|"awaitingReview",
+    riskAssessmentType?: "file"|"form"|"skipped",
+    riskAssessmentData?: {[key:string]: unknown}[]|string,
+    dbsCheck?: boolean|"awaitingReview",
+    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: {
+            completed: boolean, 
+            data?: {[key: string]: unknown}
+        },
+        provider: {
+            completed: boolean, 
+            data?: {[key: string]: unknown}
+        },
+        staff: {
+            completed: boolean, 
+            data?: {[key: string]: unknown}
+        },
+    },
+    onboarding: (OnboardingDocs&{
+        deadline?: string,
+        completed: {
+            submitted: boolean,
+            submittedDate?: string,
+            accepted?: boolean,
+            filesViewed?: string[],
+            formsCompleted?: {[key: string]: unknown},
+            filesUploaded?: {[key: number]: string[]},
+        }})|false|null,
+    studentForename?: string,
+    studentSurname?: string,
+    studentEmail?: string,
+    skillsTargetsValues?: {[key: string]: {
+        provider: number[],
+        student: number[],
+    }}
+}
+
+export type PlacementQuestions = {
+    title: string
+    description: string
+    dressCode: string
+    dressCodeText?: string
+    firstDayContact: string
+    firstAider?: string
+    equipment: string
+    responsibilities: string
+    experiencesGiven: string
+    experienceDesired: string
+    otherAdvice: string
+    carParking: boolean
+    bikeStorage: boolean
+    wheelchairFriendly: boolean
+    kitchen: boolean
+    lunchArrangements?: string
+    hours: any,
+    studentLevel: "gcse"|"college"|"undergraduate"|"postgraduate"|"over18",
+    studentSublevel: string[],
+    desiredLength: number,
+    desiredMinLength?: number, 
+    desiredMaxLength?: number,
+    desiredLengthUnits: "days"|"weeks"|"months",
+    maximumStudents: number,
+    workingLocation: "inPerson"|"hybrid"|"remote",
+    pay?: number,
+    payFrequency: "total"|"hourly"|"daily"|"weekly"|"monthly"|"annually",
+}
+
+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 PlacementListing = {
+    title: string,
+    // uid: string,
+    // template?: string,
+    providerId: string,
+    providerContactId: string,
+    name: string,
+    providerEmail: string,
+    providerPhone: string,
+    id?:string,
+    created?: string,
+    // studentType: "secondary" | "higher" | "undergraduate" | "postgraduate"
+    contactForename: string,
+    contactSurname: string,
+    ["address-line1"]: string,
+    ["address-line2"]: string,
+    locality: string,
+    postal_code: string,
+    country: string,
+    what3Words?: string,
+    geoHash?: string,
+    // status: "listed"|"unlisted"|"deleted"|"draft",
+    questions: PlacementQuestions,
+    savedBy?: {[key:string]: { // LIST OF SCHOOLS THAT HAVE SAVED THIS
+        MATschools?: string[],
+        exists: true,
+        cohorts?: {[key: string]: {
+            exists: boolean,
+            listed: boolean
+        }},
+        eventsConsent?: boolean,
+        eventsConsentDate?: string,
+        providerConsent?: boolean, // Actually consent to placemnts.
+        providerConsentDate?: string,
+        savedByUserType: "Organisation"|"Student",
+        status: "uploaded"|"approved"|"rejected"|"providerReviewed"|"blocked"}},
+    mapConsent?: boolean,
+    mapConsentDate?: string,
+    uploadedBy: "student"|"institute"|"provider",
+    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,
+    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 = {
+    message?: string,
+    forms?: string[],
+    files?: string[],
+    requiredFiles?: {fileName: string, fileType: string}[]
+}
+
+// export type PlacementTemplate = PlacementListing&{templateName: string};
+
+export type OrganisationAddressStages = "address"|"contacts"|"misc"|"review"|"complete";
+
+export type OrganisationAddress = Address & {
+    name?: string,
+    savedBy?: string[],
+    product: Products,
+    oId: string,
+    stage: OrganisationAddressStages,
+    additionalQuestions?: {
+        bikeStorage?: boolean,
+        kitchen?: boolean,
+        parking?: boolean,
+        disabledAccess?: boolean,
+    },
+    contacts?: {
+        firstAid?: {
+            name?: string,
+            phone?: string,
+            email?: string,
+            location?: string
+        }[],
+        security?: {
+            name?: string,
+            phone?: string,
+            email?: string,
+            location?: string
+        }[],
+        reception?: {
+            name?: string,
+            phone?: string,
+            email?: string,
+            location?: string
+        }[],
+    },
+    primaryContactId?: string,
+    default?: boolean,
+    flags?: ("addressMissing" | "noPrimaryContact")[],
+    color?: string;
+    image?: string|false;
+};
+
+export type Address = {
+    id?: string,
+    ["address-line1"]: string,
+    ["address-line2"]: string,
+    locality: string,
+    postal_code: string,
+    country: string,
+    geoHash?: string,
+    what3Words?: string
+};
+
+export type FlagCodes =
+    "inactive" |
+    "noParentEmailWarning" |
+    "noParentEmailError" |
+    "overdue" |
+    "noInsurance" |
+    "providerRejection" | 
+    "nearingStart"|
+    "awaitingInsurance"|
+    "noRiskAssessment"|
+    "awaitingRiskAssessment"|
+    "parentEmailFailed"|
+    "providerEmailFailed"|
+    "userEmailFailed"|
+    "noDbsCheck"|
+    "awaitingDbsCheck"|
+    "completeOnboarding"|
+    "reviewOnboarding"|
+    "requestedVisibleAddresses"|
+    "requestedVisiblePlacementListings"|
+    "addOnboarding"|
+    "studentNotAccepted"|
+    "reminder"
+
+
+export type UserData = {
+    details: {
+        forename: string,
+        surname: string,
+        pronouns?: string,
+        parentEmail?: string,
+        year?: string
+    },
+    renewalMonth: number,
+    placementCharged?: boolean,
+    algoliaKey: string,
+    email: string,
+    phone?: string,
+    status: "active" | "inactive" | "unclaimed",
+    passwordless?: boolean,
+    accessKey?: string,
+    accessKeyExpiry?: string,
+    events?: string[],
+    favGuidance?: string[];
+    oId: string,
+    id: string,
+    resetExpiry?: {seconds: number},
+    product: Products,
+    userGroup?: string,
+    userType: "Staff"|"Students",
+    created: string,
+    activated: string,
+    groupData?: UserGroupData,
+    staffRoles: string[],
+    flags?: FlagCodes[],
+    cohortRequests: {[oId: string]: string[]},
+    cohorts: {[oId: string]: string[]},
+    analytics?: AnalyticsItem,
+    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"
+    studentFilter?: string // Field on which students can be filtered
+    visibleCohorts?: string[], // comma delimited list of values
+    readUpdates?: string[],
+    contactProviderConsent?: boolean,
+    contactProviderConsentDate?: boolean
+    referrals?: number,
+    shareNameWithReferralLeaderboardConsent?: boolean,
+    shareNameWithReferralLeaderboardConsentDate?: boolean,
+    referralCode?: string,
+    notificationFrequency?: "daily"|"weekly"|"fortnightly"|"never",
+    monthAdded?: number,
+    placementsCharged?: boolean,
+    visibleAddresses?: string[],
+    visibleSchools?: string[],
+    visibleListings?: string[],
+    requestedVisibleAddresses?: 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,
+    savedDataViewerFilters?: {
+        [cohortId: string]: {
+        [key in "cohortPlacements"|"cohortStudents"]: {
+            [viewKey: string]: DataViewerFilterView
+            }
+        }
+    }
+};
+
+export type DataViewerFilterView = {
+    title: string,
+    search?: string,
+    sort?: string,
+    filters?: FilterObject,
+    permanent?: boolean,
+}
+
+export type AnalyticsItem = {
+    units?: "placements"|"weeks"|"days"|"hours",
+    name?: string
+    total?: number,
+    completion?: {
+        total?: number,
+        completed?: number
+    },
+    time?: {[key: string]: {date?:string, total?: number, completion?: {total?: number, completed?:number}}},
+    year?: {[key: string]: {year?: number, total?: number, completion?: {total?: number, completed?:number}}},
+    subtypes?: {[key:string]: AnalyticsItem}
+}
+
+export type UserGroupData = {
+    id: string,
+    default?: boolean,
+    name: string,
+    template: "Staff"|"Students",
+    oId: string,
+    product: Products,
+    viewStudents: "all"|"filter"|"none",
+    filterUsersBy?: string,
+    filterUsersValue?: string,
+}&ProviderUserPermissions
+
+export type StaffUserGroup = UserGroupData & StaffUserPermissions
+export type ProviderUserGroup = UserGroupData & ProviderUserPermissions
+
+export type StaffUserPermissions =
+    UserGroupData & {
+    viewStaff: boolean,
+    addStaff?: boolean,
+    activateStaff?: boolean,
+    editStaff?: boolean,
+    deleteStaff?: boolean,
+    addStaffGroups?: boolean,
+    editStaffGroups?: boolean,
+    deleteStaffGroups?: boolean,
+    addStudents?: boolean,
+    activateStudents?: boolean,
+    editStudents?: boolean,
+    deleteStudents?: boolean,
+    viewSetup?: boolean,
+    editInstitute?: boolean,
+    addForms?: boolean,
+    editForms?: boolean,
+    deleteForms?: boolean,
+    addFiles?: boolean,
+    deleteFiles?: boolean,
+    viewBilling?: boolean,
+    manageBilling?: boolean,
+    proposePlacements?: boolean,
+    createCohorts?: boolean,
+    viewPlacements?: boolean,
+    viewPlacementTasks?: boolean,
+    signOffPlacements?: boolean,
+    editPlacements?: boolean,
+    addPlacements?: boolean,
+    deletePlacements?: boolean,
+    verifyInsurance?: boolean,
+    verifyListings?: boolean
+    viewDatabase?: boolean,
+    addListings?: boolean,
+    deleteListings?: boolean,
+    verifyRiskAssessments?: boolean,
+    verifyDbsChecks?: boolean,
+    addCohorts?: boolean,
+    editCohorts?: boolean,
+    deleteCohorts?: boolean,
+    editRequests?: boolean,
+    deleteRequests?: boolean,
+    addEmailTemplates?: boolean,
+    editEmailTemplates?: boolean,
+    deleteEmailTemplates?: boolean,
+    addActivity?: boolean,
+    editActivity?: boolean,
+    deleteActivity?: boolean,
+}
+
+export type ProviderUserPermissions = {
+    viewStaff: boolean,
+    addStaff?: boolean,
+    activateStaff?: boolean,
+    editStaff?: boolean,
+    deleteStaff?: boolean,
+    addUserGroups?: boolean,
+    editUserGroups?: boolean,
+    deleteUserGroups?: boolean,
+    addStudents?: boolean,
+    addForms?: boolean,
+    editForms?: boolean,
+    deleteForms?: boolean,
+    addFiles?: boolean,
+    deleteFiles?: boolean,
+    viewBilling?: boolean,
+    manageBilling?: boolean,
+    createPlacementListing?: "any"|"template"|"none",
+    createPlacementTemplate?: boolean,
+    viewPlacementListings?: "all"|"request"|"none",
+    viewPlacementGroups?: "all"|"request"|"none",
+    viewAddresses?: "all"|"request"|"none",
+    processApplicants?: boolean,
+    addSchools?: boolean,
+    editSchools?: boolean,
+    deleteSchools?: boolean,
+    addAddresses?: boolean,
+    editAddresses?: boolean,
+    deleteAddresses?: boolean,
+    addApplicantWorkflows?: boolean,
+    editApplicantWorkflows?: boolean,
+    deleteApplicantWorkflows?: boolean,
+    editRequests?: boolean,
+    deleteRequests?: boolean,
+    manageAccessRequests?: boolean,
+    manageRegistrationRequests?: boolean,
+}
+
+export type RegistrationRequest = {
+    forename: string,
+    surname: string,
+    email: string,
+    message: string,
+    created: string,
+    oId: string,
+    product: "providers"|"institutes"
+}
+
+export type WorkflowStage = {
+    id: number,
+    name: string,
+    permanent?: boolean,
+    checkpoint?: boolean,
+    buttons?: {id: number, name: string|false, required: boolean}[],
+    pos?: { x: number, y: number },
+    userType?: "Students" | "Staff" | "Provider" | "Parent",
+    forms?: string[],
+    files?: string[],
+    deadline?: string,
+    deadlineType?: "date"|"days"
+    formDetails?: [{name: string}],
+    eli?: boolean,
+    riskAssessment?: boolean,
+    dbsCheck?: boolean,
+    defaultForms?: {
+        name: string,
+        description: string,
+        time: "during"|"post",
+        user: "staff"|"students"|"provider",
+        details: CustomFormSchema
+    }[],
+    requiredFiles?: {fileName: string, fileType: string}[]
+};
+
+export type ProviderPlacementData = {
+    title: string,
+    name: string,
+    providerPhone: string,
+    providerEmail: string,
+    contactForename: string,
+    contactSurname: string,
+    providerId: string,
+    addressId: string,
+    sector: string,
+    subsector: string,
+    id?: string
+};
+
+
+export type ProviderData = {
+    // staff: number,
+    // staffFields: string[],
+    // staffActive: number,
+    // admin: string,
+    name: string,
+    // insurance: boolean|"awaitingReview",
+    // insuranceSkippedReason?: string,
+    regNumber?: 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,
+    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,
+        activities?: null|string[], // IDs of consented activities.
+        eventsConsent?: boolean,
+        eventsConsentDate?: string,
+        providerConsent?: boolean, // Actually consent to placemnts.
+        providerConsentDate?: string,
+        MATschools?: string[],
+        status: "uploaded"|"approved"|"rejected"|"providerReviewed"|"blocked"}},
+}&Address
+
+export type InstituteData = {
+    students: number,
+    staff: number,
+    studentsFields: string[],
+    staffFields: string[],
+    studentsActive: number,
+    staffActive: number,
+    admin: string,
+    name: string,
+    monthAdded: number,
+    platformFee: number,
+    color?: string,
+    verifiedProviders?: string[],
+    awaitingProviderInsurance?: string[],
+    verifiedRiskAssessments?: string[],
+    awaitingPlacementRiskAssessments?: string[],
+    verifiedDbsChecks?: string[],
+    awaitingPlacementDbsChecks?: string[],
+    staffGuidance?: {[key:number]: string}
+    studentsGuidance?: {[key:number]: string},
+    cohortRequests: {[oId: string]: {[cohortId: string]: string[]}},
+    externalProviderUploads?: boolean,
+    discount?: string,
+    package: string,
+    splitBilling?: boolean,
+    adminBillingContactId?: string,
+    addOnPackages?: string[],
+    authorisedMISSystem?: {
+        name: "arbor",
+        data: {
+            url: string
+        }
+    },
+    acceptingAlumni?: boolean,
+    approveAlumni?: boolean,
+    shareAlumni?: boolean
+    approveAlumniMessages?: boolean,
+    anonymiseAlumniConvoStudents?: boolean,
+    alumniConversations?: boolean,
+    activityInvitesSent?: string
+}&Address;
+
+export type ExternalActivity = {
+    title?: string,
+    description: string,
+    position?: number,
+    image?: string,
+    color: string,
+    public?: boolean,
+    oId?: string,
+    alumni?: boolean,
+    provider?: boolean,
+    permanent?: boolean,
+    activityType: "workExperience"|"workplaceVisits"|"mentoring"|"mockInterviews"|"other"
+}
+
+export type NotificationObject = {
+    buttonURL: string,
+    created: Timestamp,
+    description: string,
+    title: string,
+    viewableBy: string[],
+    viewedBy: string[],
+    docPath: DocumentReference<DocumentData>
+}
+
+export type CustomFormSchemaField = {
+    id: number,
+    label: string,
+    required: boolean,
+    type: "short"|"long"|"number"|"date"|"dropdown"|"checkbox"|"rating" // If Microsoft forms has more, make a note and I'll add them
+    width: number, // 1-12 default 12
+    subtitle?: string,
+    extra: {
+        default?: boolean /* type: checkbox */ | string /* type: short, long, dropdown (inputted option) */ | number /* type:number */,
+        min?: number /* type: number */
+        max?: number /* type: number */
+        minRows?: number /* type: long */
+        options?: string[] // from dropdown only
+        levels?: number // For ratings, number of stars.
+    }
+}
+
+export type CustomFormSchemaSection = 
+    {
+        id: number // random
+        title?: string,
+        description?: string,
+        fields: CustomFormSchemaField[]
+    }
+
+
+export type CustomFormSchema = {
+    name?: string,
+    description?: string,
+    updated?: string,
+    id?: string,
+    form?: CustomFormSchemaSection[]}
+
+export type StaffRoles = {
+    name: string,
+    filters: {
+        students: string[],
+        fields: {[key:string]: unknown},
+    },
+    staff: string[]
+};
+
+export type QueryObjectConstraint = [string, "=="|"<"|"<="|">="|">"|"!="|"array-contains"|"array-contains-any"|"in"|"not-in", string|boolean|string[]][]
+
+export type QueryObject = {
+    path: string[],
+    where?: QueryObjectConstraint,
+    orderBy?: string
+};
+
+export type Note = {
+    title?: string,
+    body?: {
+        type: string;
+        children: {
+            text: string;
+        }[];
+    }[],
+    created: string,
+    updated: string
+}
+
+export type Referral = {
+    signUps: number,
+    volume: number,
+    product: Products,
+    expiry: Timestamp,
+    name: string
+}
+
+export type Contact = {
+    id: string,
+    contactForename: string,
+    contactSurname: string,
+    name: string,
+    providerEmail: string,
+    providerPhone: number,
+    "address-line1": string,
+    "address-line2": string,
+    locality: string,
+    what3Words?: string,
+    postal_code: string,
+    country: string,
+    created: string,
+    docPath: unknown
+}
+
+
+export type CohortData = {
+    id?: string,
+    name: string,
+    placementType: "defined"|"continuous",
+    forms?: string[],
+    files?: string[],
+    startSubmission: string,
+    endSubmission: string,
+    startPlacements: string,
+    endPlacements: string,
+    stage: "info"|"name"|"placementType"|"students"|"workflow"|"review"|"created"|"archived"|"database",
+    workflow: WorkflowStage[]
+    customWorkflow?: boolean,
+    oId: string,
+    product: Products,
+    schoolId?: string,
+    designatedStaff?: string,
+    autoArchiveDate?: string,
+    logType?: "basic"|"custom",
+    listingReleaseDate?: string,
+    enableListings?: boolean,
+    logs?: {
+        students?: string,
+        staff?: string,
+        provider?: string,
+    }
+    feedback?: {
+        students?: string,
+        staff?: string,
+        provider?: string,
+    },
+    feedbackText?: {
+        students?: Descendant[],
+        staff?: Descendant[],
+        provider?: Descendant[],
+    },
+    providerFeedbackSent?: Timestamp,
+    studentsFeedbackSent?: Timestamp,
+    emailTemplates?: {[key in keyof typeof emailTemplates]: string},
+    skillsTargets?: string[],
+    recurringEmails?: {
+        sendType?: "all"|"lastWeek",
+        frequency?: "oneTime"|"weeklyMonday"|"fortnightlyMonday"
+    },
+    savedDataViewerFilters?: {
+        [key in "cohortPlacements"|"cohortStudents"]: {
+            [key: string]: DataViewerFilterView
+        }
+    }
+}
+
+export type ArrowObject = {
+    start: number|string,
+    end: number|string,
+    name: string|false,
+    required?: boolean,
+    screenX?: number,
+}
+
+
+export type PlacementReviewDetails = {
+    activeDates: string[],
+    studentForename: string,
+    studentSurname: string,
+    instituteName: string,
+    title: string,
+    product: string,
+    name: string,
+    startDate: string,
+    endDate: string,
+    providerEmail: string,
+    providerPhone: string,
+    contactForename: string,
+    contactSurname: string,
+    cohort: string,
+    cohortData?: CohortData,
+    providerKey: string,
+    status: number,
+    ["address-line1"]: string,
+    ["address-line2"]: string,
+    locality: string,
+    postal_code: string,
+    what3Words?: string,
+    country: string,
+    key: string,
+    oId: string,
+    providerCompleted: string[],
+    providerId: string,
+    questions: PlacementQuestions,
+    userType: string,
+    id: string,
+    uid: string,
+    leadTimes: string[],
+    requiredSections: string[],
+    existingPlacements?: {
+        [key: string]: {
+            mapConsent: boolean,
+            jobTitle: string,
+            questions: PlacementQuestions,
+            riskAssessment: boolean|"awaitingReview",
+            riskAssessmentType: "form"|"file",
+            riskAssessmentData?: {[key: string]: unknown}|string,
+            dbsCheck: boolean|"awaitingReview",
+            dbsCheckType: "form"|"file",
+            dbsCheckData?: {[key: string]: unknown}|string,
+        }
+    },
+    requireELI?: boolean,
+    requireRA?: boolean,
+    requireDBS?: boolean,
+    importedProviderForms: boolean,
+    currentStage: WorkflowStage&{files: {[fileId: string]: {name: string, url: string}}},
+    placementId?: string,
+    providerContactId: string,
+    incompleteItems: {[key: number]: string[]},
+    riskAssessmentData?: {[key: string]: unknown}[]|string,
+    dbsCheckData?: {[key: string]: unknown}[]|string,
+    feedbackText?: Descendant[],
+    feedback: CustomFormSchema,
+    providerFeedback?: {[key: string]: unknown},
+    primaryColor?: string,
+    primaryImage?: string,
+    mapConsent?: boolean,
+    eventsConsent?: boolean,
+    consentedActivities?: string[],
+    instituteActivities?: {[key: string]: ExternalActivity}
+}
+
+export type BlogCategories = "students"|"providers"|"institutes"|"placementt"
+
+export type Blog = {
+    title?: string,
+    summary?: string,
+    body?: Descendant[],
+    uploaded?: string,
+    category?: BlogCategories,
+    author?: string,
+    tags?: string
+}
+
+export type PlacementExportObject = {
+    cohortId: string,
+    startDate?: string,
+    endDate?: string,
+    allTime?: boolean,
+    includeStudentData?: boolean,
+    activePlacements?: boolean,
+    completedPlacements?: boolean,
+}
+
+
+
+export type ApplicantWorkflow = {
+    id?: string,
+    name: string,
+    forms?: string[],
+    files?: string[],
+    workflow: ApplicantStage[]
+    customWorkflow?: boolean,
+    oId: string,
+    product: Products,
+    type: "simple"|"complex"
+}
+
+export type ApplicantStage = {
+    id: number,
+    name: string,
+    message?: string,
+    userType?: "Students" | "Staff",
+    permanent?: boolean,
+    checkpoint?: boolean,
+    buttons?: {id: number, name: string|false, required: boolean}[],
+    pos?: { x: number, y: number },
+    forms?: string[],
+    files?: string[],
+    deadline?: string,
+    deadlineType?: "date"|"days"
+    formDetails?: {[key: string]: {
+        name: string,
+        id: string,
+        description?: string,
+        product: Products,
+        oId: string,
+        form: CustomFormSchema
+    }},
+    requiredFiles?: {fileName: string, fileType: string}[]
+    portfolio?: boolean,
+    viewableFiles?: {[key: string]: FileItem},
+};
+
+export type Application = {
+    id?: string,
+    uid: string,
+    applicantWorkflowId: string,
+    listingId: string,
+    addressId: string,
+    providerId: string,
+    reqUserType: "Students"|"Staff",
+    completedSections: {[stage: number]: {
+        submitted?: string,
+        filesViewed?: string[],
+        formsCompleted?: {[key: string]: unknown},
+        filesUploaded?: {[key: number]: string[]},
+    }},
+    created: string,
+    submitted: string,
+    startDate: string,
+    endDate: string,
+    leadTimes?: string[],
+    stage: number, // This is what stage of the custom workflow.
+    outcomeMessage?: string,
+    status: "draft"|"submitted"|"approved"|"declined",
+    placementId?: string,
+}
+
+export type Report = {
+    added: string,
+    id: string,
+    oId: string,
+    product: Products,
+    pId: string,
+    reason: string,
+    uid: string,
+    status: "open"|"closed"
+}
+
+
+export type FileItem = {
+    product: Products,
+    oId: string,
+    added: string,
+    name: string,
+    fileName: string,
+    url?: string
+}
+
+export type Event = {
+    collection: "users"|"placements"|"placementListings",
+    documentId: string,
+    product: Products,
+    oId: string,
+    created: Timestamp,
+    title: string,
+    description?: string,
+    severity: string,
+    button?: {title: string, url: string}
+}
+
+export type BillingPackage = {
+    name: string,
+    staffUnitCost: number,
+    platformFee: number,
+    platformFeeFrequency: "yearly"|"monthly",
+    studentUnitCost: number,
+    placementUnitCost: number,
+    product: Products,
+    priority: number,
+    features: {[key: string]: number|boolean|string},
+    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"|"event"
+}
+
+
+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,
+    staffInformation?: string,
+    studentInformation?: string,
+    employerInformation?: string
+    designatedStaff: string,
+    created: string,
+    activityId?: string,
+    gatsbyBenchmarks?: string, // String array
+    oId: string,
+    submissionClose: string,
+    acceptingEmployers?: boolean,
+    acceptingStudents?: boolean,
+    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"|"students"|"inviteConfirmation"|"review"|"created",
+    inviteEmailTemplate: string,
+    alumni: {
+        completed?: boolean,
+        shareable?: boolean,
+        filters: "all"|(string|{[key: string]: unknown})[]
+    }
+    employers: {
+        completed?: boolean,
+        shareable?: boolean,
+        filters: "all"|(string|{[key: string]: unknown})[]
+    },
+    employerInvites: {
+        completed?: boolean
+        files: string[],
+        forms: string[],
+        requiredFiles: {
+            fileName: string,
+            fileType: string
+        }[],
+    },
+    employerFeedback: {
+            files: string[],
+            forms: string[],
+            requiredFiles: {
+                fileName: string,
+                fileType: string
+            }[],
+    },
+    studentFeedback: {
+        files: string[],
+        forms: string[],
+        requiredFiles: {
+            fileName: string,
+            fileType: string
+        }[],
+    }
+    completedStages: ("basicDetails"|"employerInvites"|"studentInvites"|"employerSelection"|"feedback")[]
+}&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 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
+}
+
+
+
+export type ExternalEventAttendee = {
+    oId: string,
+    schoolId?: string,
+    eventId: string,
+    providerContactId: string,
+    status: "pendingInvite"|"invited"|"providerAvailable"|"finalConfirmationSent"|"providerConfirmed"|"feedbackSent"
+    emails: {
+        [k in "invited"|"finalConfirmationSent"|"feedbackSent"]: {
+            sent: number, // If below 3, keep sending reminders.
+            reconciled: string|boolean, // When did the step get finished, such as employers responding to invites
+            log: {
+                [k: string]: string // emailNumber_dateTimeString : eventType
+            }
+        }
+    }
+    initialJobId?: string,
+    emailTemplates?: {
+        invited?: string,
+        finalConfirmationSent?: string,
+        feedbackSent?: string,
+    }
+    attended?: boolean,
+    feedback: {[key: string]: unknown}
 }