placementt-core 1.20.211 → 11.10.151

package/src/typeDefinitions.ts

@@ -1,503 +1,893 @@
-import {DocumentData, DocumentReference, Timestamp} from "firebase/firestore";
-import {Descendant} from "slate";
-
-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,
-    country: string,
-    cohort?: string,
-    leadTimes: string[],
-    flags?: FlagCodes[],
-    mapConsent: true | "institute" | false,
-    mapConsentDate?: string,
-    placementId?: string,
-    addressId?: string,
-    geoHash?: string,
-    questions: PlacementQuestions
-    staffRoles: string[],
-    sector: string,
-    subsector: string,
-    importedProviderForms?: boolean,
-    analytics: string[],
-    units: string,
-    active: boolean,
-    completed: boolean,
-    personalAnalytics?: string[],
-    contactId?: string
-    created: string,
-    inProgress: boolean,
-    draft: boolean,
-    activeDates: string[],
-    insurance: boolean|"awaitingReview",
-};
-
-export type PlacementQuestions = {
-    title: string,
-    description: string
-    dressCode: string,
-    dressCodeText?: string,
-    firstDayContact: string
-    equipment: string
-    responsibilities: string
-    experiencesGiven: string
-    experienceDesired: string
-    otherAdvice: string
-    carParking: boolean
-    bikeStorage: boolean
-    wheelchairFriendly: boolean
-    kitchen: boolean,
-    studentLevel: "gcse"|"college"|"undergraduate"|"postgraduate",
-    desiredLength: number,
-    desiredLengthUnits: "days"|"weeks"|"months",
-    maximumStudents: number,
-    workingLocation: "inPerson"|"hybrid"|"remote"
-}
-
-export type PlacementListing = {
-    title: string,
-    uid: 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,
-    addressId?: string,
-    geoHash?: string,
-    status: "listed"|"unlisted"|"deleted",
-    questions: PlacementQuestions,
-    savedBy?: {[key:string]: {
-        exists: true,
-        providerConsent: boolean,
-        providerConsentDate?: Timestamp,
-        status: "uploaded"|"approved"|"rejected"|"blocked"}},
-    mapConsent?: boolean,
-    mapConsentData?: string,
-    uploadedBy: "student"|"institute"|"provider"
-}
-
-export type OrganisationAddress = Address & {
-    name?: string,
-    savedBy?: string[],
-    product: Products,
-    oId: string
-};
-
-export type Address = {
-    id?: string,
-    ["address-line1"]: string,
-    ["address-line2"]: string,
-    locality: string,
-    postal_code: string,
-    country: string,
-    geoHash?: string
-};
-
-export type FlagCodes =
-    "inactive" |
-    "noParentEmailWarning" |
-    "noParentEmailError" |
-    "overdue" |
-    "noInsurance" |
-    "nearingStart"|
-    "awaitingInsurance"|
-    "notVerified"|
-    "needInformation"
-
-
-export type UserData = {
-    details: {
-        forename: string,
-        surname: string,
-        parentEmail: string,
-        year?: 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,
-    cohortData?: CohortData,
-    dismissedTasks?: string[],
-    dismissedTutorials?: string[],
-    dismissedTips?: string[],
-    viewCohorts?: "all"|"some"|"none",
-    viewUsers?: "all"|"some",
-    studentFilterValues?: string,
-    studentFilter?: string
-    visibleCohorts?: string,
-    readUpdates?: string[],
-    contactProviderConsent?: boolean,
-    contactProviderConsenDate?: boolean
-    referrals?: number,
-    shareNameWithReferralLeaderboardConsent?: boolean,
-    shareNameWithReferralLeaderboardConsentDate?: boolean,
-    referralCode?: 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,
-}
-
-export type StaffUserGroup =
-    UserGroupData & {
-    viewStaff: boolean,
-    viewCohorts: "all"|"some"|"none",
-    cohorts?: string[],
-    viewStudents: "all"|"filter"|"none",
-    filterUsersBy?: string,
-    filterUsersValue?: string,
-    addStaff?: boolean,
-    editStaff?: boolean,
-    deleteStaff?: boolean,
-    addStaffGroups?: boolean,
-    editStaffGroups?: boolean,
-    deleteStaffGroups?: boolean,
-    addStudents?: 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,
-}
-
-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,
-    defaultForms?: {
-        name: string,
-        description: string,
-        time: "during"|"post",
-        user: "staff"|"students"|"provider",
-        details: CustomFormSchema
-    }[]
-};
-
-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,
-    regNumber?: string,
-    insuranceExpiry: string,
-    mapConsent?: boolean,
-    mapConsentDate?: string,
-    staffGuidance?: {[key:number]: string},
-    sector: string,
-    defAddress: string,
-    subsector: string,
-    website?: string,
-    savedBy?: {[key:string]: {
-        exists: true,
-        providerConsent: boolean,
-        providerConsentDate?: Timestamp,
-        status: "uploaded"|"approved"|"blocked"}},
-}
-
-export type InstituteData = {
-    students: number,
-    staff: number,
-    studentsFields: string[],
-    staffFields: string[],
-    studentsActive: number,
-    staffActive: number,
-    admin: string,
-    name: string
-    verifiedProviders?: string[],
-    awaitingProviderInsurance?: string[],
-    staffGuidance?: {[key:number]: string}
-    studentsGuidance?: {[key:number]: string},
-    cohortRequests: {[oId: string]: {[cohortId: string]: string[]}},
-    packages?: {[key:string]:unknown},
-    externalProviderUploads?: boolean,
-}&Address;
-
-export type NotificationObject = {
-    buttonURL: string,
-    created: Timestamp,
-    description: string,
-    title: string,
-    viewableBy: string[],
-    viewedBy: string[],
-    docPath: DocumentReference<DocumentData>
-}
-
-export type CustomFormSchema = [
-    {
-        id: number // random
-        title: string,
-        fields: {
-                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 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 AdmissionsCohort = {
-    name: string,
-    students: {
-        [key:string]: {
-            email: string,
-            status: "Pending"|"Accepted"|"Rejected"|"In institute"|"Account removed",
-            forename: string,
-            surname: string
-        }
-    },
-    permissions: {[key:string]: unknown},
-    expiry: 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,
-    postal_code: string,
-    country: string,
-    created: string,
-    docPath: unknown
-}
-
-
-export type CohortData = {
-    id?: string,
-    name: string,
-    placementType: "defined"|"continuous",
-    startSubmission: string,
-    endSubmission: string,
-    startPlacements: string,
-    endPlacements: string,
-    stage: "name"|"placementType"|"students"|"workflow"|"review"|"created"|"archived",
-    workflow: WorkflowStage[],
-    oId: string,
-    product: Products,
-    designatedStaff?: string
-}
-
-export type ArrowObject = {
-    start: number|string,
-    end: number|string,
-    name: string|false,
-    required?: boolean,
-    screenX?: number,
-}
-
-
-export type PlacementReviewDetails = {
-    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,
-    providerKey: string,
-    status: number,
-    ["address-line1"]: string,
-    ["address-line2"]: string,
-    locality: string,
-    postal_code: 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
-        }
-    },
-    requireELI?: boolean,
-    importedProviderForms: boolean,
-    currentStage: WorkflowStage,
-    placementId?: 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
-}
+import {DocumentData, DocumentReference, Timestamp} from "firebase/firestore";
+import {Descendant} from "slate";
+
+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,
+    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",
+    questions: PlacementQuestions,
+    staffRoles: string[],
+    sector: string,
+    subsector: string,
+    importedProviderForms?: boolean,
+    analytics: string[],
+    units: string,
+    active: boolean,
+    completed: boolean,
+    personalAnalytics?: string[],
+    completedStages?: number[],
+    contactId?: string
+    created: string,
+    inProgress: boolean,
+    draft: boolean,
+    activeDates: string[],
+    insurance: boolean|"awaitingReview",
+    riskAssessment?: boolean|"awaitingReview",
+    riskAssessmentType?: "file"|"form",
+    riskAssessmentData?: {[key:string]: unknown}[],
+    dbsCheck?: boolean|"awaitingReview",
+    dbsCheckType?: "file"|"form",
+    dbsCheckData?: {[key:string]: unknown}[],
+    contactType?: "email"|"website"|"phone"|"post",
+    webpage?: string,
+    providerLogs?: string[],
+    studentsLogs?: string[],
+    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,
+}
+
+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,
+    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,
+    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",
+    riskAssessmentData?: {[key:string]: unknown}[],
+    dbsCheckType?: "file"|"form",
+    dbsCheckData?: {[key:string]: unknown}[],
+    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")[]
+};
+
+export type Address = {
+    id?: string,
+    ["address-line1"]: string,
+    ["address-line2"]: string,
+    locality: string,
+    postal_code: string,
+    country: string,
+    geoHash?: string
+};
+
+export type FlagCodes =
+    "inactive" |
+    "noParentEmailWarning" |
+    "noParentEmailError" |
+    "overdue" |
+    "noInsurance" |
+    "providerRejection" | 
+    "nearingStart"|
+    "awaitingInsurance"|
+    "noRiskAssessment"|
+    "awaitingRiskAssessment"|
+    "parentEmailFailed"|
+    "providerEmailFailed"|
+    "userEmailFailed"|
+    "noDbsCheck"|
+    "awaitingDbsCheck"|
+    "completeOnboarding"|
+    "reviewOnboarding"|
+    "requestedVisibleAddresses"|
+    "requestedVisiblePlacementListings"|
+    "addOnboarding"
+
+
+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,
+    cohortData?: CohortData,
+    dismissedTasks?: string[],
+    dismissedTutorials?: string[],
+    dismissedTips?: string[],
+    viewCohorts?: "all"|"some"|"none",
+    viewUsers?: "all"|"some",
+    studentFilterValues?: string,
+    studentFilter?: string
+    visibleCohorts?: string,
+    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[],
+    visibleListings?: string[],
+    requestedVisibleAddresses?: string[],
+    requestedVisibleListings?: string[],
+    packageData?: BillingPackage
+};
+
+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
+}
+
+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,
+    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",
+    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
+    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[]
+}&Address;
+
+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,
+    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,
+    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,
+    billingEmail?: string,
+    billingContactId?: 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,
+    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},
+            dbsCheck: boolean|"awaitingReview",
+            dbsCheckType: "form"|"file",
+            dbsCheckData?: {[key: string]: unknown},
+        }
+    },
+    requireELI?: boolean,
+    requireRA?: boolean,
+    requireDBS?: boolean,
+    importedProviderForms: boolean,
+    currentStage: WorkflowStage,
+    placementId?: string,
+    incompleteItems: {[key: number]: string[]},
+    riskAssessmentData?: {[key: string]: unknown}[],
+    dbsCheckData?: {[key: string]: unknown}[],
+    feedbackText?: Descendant[],
+    feedback: CustomFormSchema,
+    providerFeedback?: {[key: string]: unknown}
+}
+
+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,
+    studentUnitCost: number,
+    placementUnitCost: number,
+    product: Products,
+    priority: number,
+    features: {[key: string]: number|boolean|string},
+    description: string
+}
+
+
+
+
+
+