placementt-core 1.20.211 → 11.10.151

package/lib/typeDefinitions.d.ts

@@ -39,6 +39,7 @@ export type StudentPlacementData = {
     placementId?: string;
     addressId?: string;
     geoHash?: string;
+    statusType: "draft" | "submitted" | "active" | "completed" | "withdrawn";
     questions: PlacementQuestions;
     staffRoles: string[];
     sector: string;
@@ -49,12 +50,63 @@ export type StudentPlacementData = {
     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;
@@ -62,6 +114,7 @@ export type PlacementQuestions = {
     dressCode: string;
     dressCodeText?: string;
     firstDayContact: string;
+    firstAider?: string;
     equipment: string;
     responsibilities: string;
     experiencesGiven: string;
@@ -71,15 +124,34 @@ export type PlacementQuestions = {
     bikeStorage: boolean;
     wheelchairFriendly: boolean;
     kitchen: boolean;
-    studentLevel: "gcse" | "college" | "undergraduate" | "postgraduate";
+    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;
@@ -95,7 +167,7 @@ export type PlacementListing = {
     country: string;
     addressId?: string;
     geoHash?: string;
-    status: "listed" | "unlisted" | "deleted";
+    status: "listed" | "unlisted" | "deleted" | "draft";
     questions: PlacementQuestions;
     savedBy?: {
         [key: string]: {
@@ -108,12 +180,80 @@ export type PlacementListing = {
     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;
@@ -124,14 +264,18 @@ export type Address = {
     country: string;
     geoHash?: string;
 };
-export type FlagCodes = "inactive" | "noParentEmailWarning" | "noParentEmailError" | "overdue" | "noInsurance" | "nearingStart" | "awaitingInsurance" | "notVerified" | "needInformation";
+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;
-        parentEmail: string;
+        pronouns?: string;
+        parentEmail?: string;
         year?: string;
     };
+    renewalMonth: number;
+    placementCharged?: boolean;
+    algoliaKey: string;
     email: string;
     phone?: string;
     status: "active" | "inactive" | "unclaimed";
@@ -170,11 +314,19 @@ export type UserData = {
     visibleCohorts?: string;
     readUpdates?: string[];
     contactProviderConsent?: boolean;
-    contactProviderConsenDate?: 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";
@@ -218,21 +370,20 @@ export type UserGroupData = {
     viewStudents: "all" | "filter" | "none";
     filterUsersBy?: string;
     filterUsersValue?: string;
-};
-export type StaffUserGroup = UserGroupData & {
+} & ProviderUserPermissions;
+export type StaffUserGroup = UserGroupData & StaffUserPermissions;
+export type ProviderUserGroup = UserGroupData & ProviderUserPermissions;
+export type StaffUserPermissions = UserGroupData & {
     viewStaff: boolean;
-    viewCohorts: "all" | "some" | "none";
-    cohorts?: string[];
-    viewStudents: "all" | "filter" | "none";
-    filterUsersBy?: string;
-    filterUsersValue?: string;
     addStaff?: boolean;
+    activateStaff?: boolean;
     editStaff?: boolean;
     deleteStaff?: boolean;
     addStaffGroups?: boolean;
     editStaffGroups?: boolean;
     deleteStaffGroups?: boolean;
     addStudents?: boolean;
+    activateStudents?: boolean;
     editStudents?: boolean;
     deleteStudents?: boolean;
     viewSetup?: boolean;
@@ -246,6 +397,67 @@ export type StaffUserGroup = UserGroupData & {
     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;
@@ -270,6 +482,8 @@ export type WorkflowStage = {
         name: string;
     }];
     eli?: boolean;
+    riskAssessment?: boolean;
+    dbsCheck?: boolean;
     defaultForms?: {
         name: string;
         description: string;
@@ -277,6 +491,10 @@ export type WorkflowStage = {
         user: "staff" | "students" | "provider";
         details: CustomFormSchema;
     }[];
+    requiredFiles?: {
+        fileName: string;
+        fileType: string;
+    }[];
 };
 export type ProviderPlacementData = {
     title: string;
@@ -297,14 +515,15 @@ export type ProviderData = {
     staffActive: number;
     admin: string;
     name: string;
-    insurance: boolean;
+    insurance: boolean | "awaitingReview";
     regNumber?: string;
     insuranceExpiry: string;
-    mapConsent?: boolean;
+    mapConsent?: boolean | "unlisted";
     mapConsentDate?: string;
     staffGuidance?: {
         [key: number]: string;
     };
+    about?: string;
     sector: string;
     defAddress: string;
     subsector: string;
@@ -317,6 +536,22 @@ export type ProviderData = {
             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;
@@ -329,6 +564,10 @@ export type InstituteData = {
     name: string;
     verifiedProviders?: string[];
     awaitingProviderInsurance?: string[];
+    verifiedRiskAssessments?: string[];
+    awaitingPlacementRiskAssessments?: string[];
+    verifiedDbsChecks?: string[];
+    awaitingPlacementDbsChecks?: string[];
     staffGuidance?: {
         [key: number]: string;
     };
@@ -340,10 +579,12 @@ export type InstituteData = {
             [cohortId: string]: string[];
         };
     };
-    packages?: {
-        [key: string]: unknown;
-    };
     externalProviderUploads?: boolean;
+    discount?: string;
+    package?: string;
+    splitBilling?: boolean;
+    adminBillingContactId?: string;
+    addOnPackages?: string[];
 } & Address;
 export type NotificationObject = {
     buttonURL: string;
@@ -354,28 +595,35 @@ export type NotificationObject = {
     viewedBy: string[];
     docPath: DocumentReference<DocumentData>;
 };
-export type CustomFormSchema = [
-    {
-        id: number;
-        title: string;
-        fields: {
-            id: number;
-            label: string;
-            required: boolean;
-            type: "short" | "long" | "number" | "date" | "dropdown" | "checkbox" | "rating";
-            width: number;
-            subtitle?: string;
-            extra: {
-                default?: boolean | string | number;
-                min?: number;
-                max?: number;
-                minRows?: number;
-                options?: string[];
-                levels?: number;
-            };
-        }[];
-    }
-];
+export type CustomFormSchemaField = {
+    id: number;
+    label: string;
+    required: boolean;
+    type: "short" | "long" | "number" | "date" | "dropdown" | "checkbox" | "rating";
+    width: number;
+    subtitle?: string;
+    extra: {
+        default?: boolean | string | number;
+        min?: number;
+        max?: number;
+        minRows?: number;
+        options?: string[];
+        levels?: number;
+    };
+};
+export type CustomFormSchemaSection = {
+    id: number;
+    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: {
@@ -392,21 +640,6 @@ export type QueryObject = {
     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?: {
@@ -444,15 +677,38 @@ export type CohortData = {
     id?: string;
     name: string;
     placementType: "defined" | "continuous";
+    forms?: string[];
+    files?: string[];
     startSubmission: string;
     endSubmission: string;
     startPlacements: string;
     endPlacements: string;
-    stage: "name" | "placementType" | "students" | "workflow" | "review" | "created" | "archived";
+    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;
@@ -462,6 +718,7 @@ export type ArrowObject = {
     screenX?: number;
 };
 export type PlacementReviewDetails = {
+    activeDates: string[];
     studentForename: string;
     studentSurname: string;
     instituteName: string;
@@ -475,6 +732,7 @@ export type PlacementReviewDetails = {
     contactForename: string;
     contactSurname: string;
     cohort: string;
+    cohortData?: CohortData;
     providerKey: string;
     status: number;
     ["address-line1"]: string;
@@ -498,12 +756,38 @@ export type PlacementReviewDetails = {
             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 = {
@@ -515,3 +799,136 @@ export type Blog = {
     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;
+    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;
+};