placementt-core 1.20.197 → 11.0.533

package/lib/hooks.d.ts

@@ -1,6 +1,6 @@
-/// <reference types="react" />
 import { DocumentData, QueryConstraint, QueryDocumentSnapshot } from "firebase/firestore";
-import { ArrowObject, CohortData, InstituteData, PlacementListing, Products, QueryObject, StudentPlacementData, UserData, UserGroupData, WorkflowStage } from "./typeDefinitions";
+import { ApplicantStage, ApplicantWorkflow, Application, ArrowObject, CohortData, FileItem, FlagCodes, InstituteData, OnboardingDocs, PlacementListing, Products, ProviderData, QueryObject, SavedPlacement, StudentPlacementData, UserData, UserGroupData, WorkflowStage } from "./typeDefinitions";
+import { OrganisationAddress } from "placementt-core";
 type StudentPlacementListParams = {
     user: UserData;
     student?: UserData;
@@ -24,8 +24,9 @@ type InstitutePlacementParams = {
     cohort?: string;
     queryConstraint?: QueryConstraint[];
     ql?: number;
+    inProgress?: boolean;
 };
-export declare function useNewInstitutePlacementList({ id, user, cohort, queryConstraint, ql }: InstitutePlacementParams): {
+export declare function useNewInstitutePlacementList({ id, user, cohort, queryConstraint, ql, inProgress }: InstitutePlacementParams): {
     placements: {
         [key: string]: StudentPlacementData & {
             student: UserData;
@@ -33,7 +34,7 @@ export declare function useNewInstitutePlacementList({ id, user, cohort, queryCo
     } | undefined;
     loadMoreIcon: boolean;
     loadMorePlacements: (fStartPlacementAfter?: [QueryDocumentSnapshot<DocumentData> | undefined, number] | undefined) => Promise<void>;
-    setQuery: import("react").Dispatch<import("react").SetStateAction<string>>;
+    setQuery: import("react").Dispatch<import("react").SetStateAction<string | undefined>>;
     setInitialQueryLimit: import("react").Dispatch<import("react").SetStateAction<number>>;
     reset: () => void;
     changeQueryConstraints: (e: QueryConstraint[]) => void;
@@ -67,31 +68,38 @@ export declare function useFilterTablePaginator({ data }: {
     setFilters: import("react").Dispatch<import("react").SetStateAction<{
         [key: string]: unknown;
     } | undefined>>;
+    page: number[];
 };
 export declare function usePlacementListingPaginator({ data, user }: {
     data: QueryObject[];
     user: UserData;
 }): {
     tableData: {
-        [key: string]: PlacementListing;
+        [key: string]: PlacementListing & {
+            savedPlacement: SavedPlacement;
+        };
     };
     setPage: import("react").Dispatch<import("react").SetStateAction<number[]>>;
     setFilters: import("react").Dispatch<import("react").SetStateAction<{
         [key: string]: unknown;
     } | undefined>>;
+    page: number[];
 };
 type UserPaginatorParams = {
     user: UserData;
     cohort?: string;
     data: QueryObject[];
+    search?: string;
+    userType: "Staff" | "Students";
 };
-export declare function useCohortUserPaginator({ user, cohort, data }: UserPaginatorParams): {
+export declare function useCohortUserPaginator({ user, cohort, data, search, userType }: UserPaginatorParams): {
     tableData: {
         [key: string]: {
             [key: string]: unknown;
         };
     };
     setPage: import("react").Dispatch<import("react").SetStateAction<number[]>>;
+    page: number[];
     setFilters: import("react").Dispatch<import("react").SetStateAction<{
         [key: string]: unknown;
     } | undefined>>;
@@ -119,8 +127,11 @@ type LazyLoadQueryParams = {
     number: number;
     endResultsText?: string;
     noResultsText?: string;
+    onItemFetched?: (item: unknown) => Promise<{
+        [key: string]: unknown;
+    }>;
 };
-export declare function useLazyLoadQueryList({ path, constraints, number }: LazyLoadQueryParams): {
+export declare function useLazyLoadQueryList({ path, constraints, number, onItemFetched }: LazyLoadQueryParams): {
     items: {
         [key: string]: {
             [key: string]: unknown;
@@ -130,6 +141,162 @@ export declare function useLazyLoadQueryList({ path, constraints, number }: Lazy
     loadMoreIcon: boolean;
     reset: () => void;
 };
+type PublicPlacementListingLoaderParams = {
+    providerId?: string;
+    number: number;
+};
+export declare function usePublicPlacementListingLoader({ providerId, number }: PublicPlacementListingLoaderParams): {
+    items: {
+        [key: string]: {
+            [key: string]: unknown;
+        };
+    };
+    loadMore: () => Promise<void>;
+    loadMoreIcon: boolean;
+    reset: () => void;
+};
+export type ApplicationHookParams = {
+    successText: {
+        submitted: {
+            title: string;
+            desc: string;
+        };
+        draftSaved: {
+            title: string;
+            desc: string;
+        };
+        stageComplete: {
+            title: string;
+            desc: string;
+        };
+        outcome: {
+            title: string;
+            desc: string;
+        };
+    };
+    setSuccessPopup: import("react").Dispatch<import("react").SetStateAction<"submitted" | "draftSaved" | "stageComplete" | "outcome" | undefined>>;
+    openSuccessPopup: (type: "submitted" | "draftSaved" | "stageComplete" | "outcome") => void;
+    setFApplication: import("react").Dispatch<import("react").SetStateAction<Partial<Application>>>;
+    fApplication: Partial<Application>;
+    draftSaved: boolean;
+    profileUrl: string | undefined;
+    successPopup: "submitted" | "draftSaved" | "stageComplete" | "outcome" | undefined;
+    fApplicationId: string | undefined;
+    fListing: PlacementListing | undefined;
+    student: UserData | undefined;
+    fProvider: {
+        details?: ProviderData;
+        profile?: string;
+        id?: string;
+    } | undefined;
+    onFApply: (draft?: boolean) => Promise<void>;
+    setFormComplete: (formId: string, e: {
+        [key: string]: unknown;
+    }) => void;
+    viewFile: (file: string, onOpen: (url: string) => void) => void;
+    addFile: (files: string[], fileId: number) => void;
+    uploadedFiles?: {
+        [key: string]: FileItem;
+    };
+    getCurrentStage: (stage: number) => Promise<{
+        stage: ApplicantStage;
+        completedSections: {
+            submitted?: string | undefined;
+            filesViewed?: string[] | undefined;
+            formsCompleted?: {
+                [key: string]: unknown;
+            } | undefined;
+            filesUploaded?: {
+                [key: number]: string[];
+            } | undefined;
+        };
+    }>;
+    currentStageComplete?: boolean;
+    progressStage: (type: number | "accept" | "reject", e?: {
+        feedback?: string;
+    }) => Promise<void>;
+};
+export declare function useCreateApplicationRenderer({ user, listingId, listing, provider, application, applicationId, orgContext }: {
+    user: UserData;
+    listingId: string;
+    applicationId?: string;
+    listing?: PlacementListing;
+    application?: Partial<Application>;
+    orgContext?: {
+        details: ProviderData;
+        addresses: {
+            [key: string]: OrganisationAddress;
+        };
+        applicantWorkflows: {
+            [key: string]: ApplicantWorkflow;
+        };
+    };
+    provider?: {
+        details?: ProviderData;
+        profile?: string;
+        id?: string;
+    };
+}): {
+    successText: {
+        submitted: {
+            title: string;
+            desc: string;
+        };
+        draftSaved: {
+            title: string;
+            desc: string;
+        };
+        stageComplete: {
+            title: string;
+            desc: string;
+        };
+        outcome: {
+            title: string;
+            desc: string;
+        };
+    };
+    onFApply: (draft?: boolean) => Promise<void>;
+    progressStage: (type: number | "accept" | "reject", e?: {
+        feedback?: string;
+    }) => Promise<void>;
+    currentStageComplete: boolean | undefined;
+    uploadedFiles: {
+        [key: string]: FileItem;
+    } | undefined;
+    getCurrentStage: (stage: number) => Promise<{
+        stage: ApplicantStage;
+        completedSections: {
+            submitted?: string | undefined;
+            filesViewed?: string[] | undefined;
+            formsCompleted?: {
+                [key: string]: unknown;
+            } | undefined;
+            filesUploaded?: {
+                [key: number]: string[];
+            } | undefined;
+        };
+    }>;
+    setFormComplete: (formId: string, e: {
+        [key: string]: unknown;
+    }) => void;
+    viewFile: (file: string, onOpen: (url: string) => void) => void;
+    addFile: (files: string[], fileId: number) => void;
+    setSuccessPopup: import("react").Dispatch<import("react").SetStateAction<"submitted" | "draftSaved" | "stageComplete" | "outcome" | undefined>>;
+    openSuccessPopup: (type: "submitted" | "draftSaved" | "stageComplete" | "outcome") => void;
+    setFApplication: import("react").Dispatch<import("react").SetStateAction<Partial<Application>>>;
+    fApplication: Partial<Application>;
+    draftSaved: boolean;
+    profileUrl: string | undefined;
+    successPopup: "submitted" | "draftSaved" | "stageComplete" | "outcome" | undefined;
+    fApplicationId: string | undefined;
+    fListing: PlacementListing | undefined;
+    student: UserData | undefined;
+    fProvider: {
+        details?: ProviderData;
+        profile?: string;
+        id?: string;
+    } | undefined;
+};
 export declare function useProposePlacementRenderer({ user, orgContext, placement }: {
     user: UserData;
     orgContext?: {
@@ -158,9 +325,7 @@ export declare function useProposePlacementRenderer({ user, orgContext, placemen
     setBusinessSectionComplete: import("react").Dispatch<import("react").SetStateAction<boolean>>;
     setAddressSectionComplete: import("react").Dispatch<import("react").SetStateAction<boolean>>;
     setPlacementSectionComplete: import("react").Dispatch<import("react").SetStateAction<boolean>>;
-    proposePlacement: (draft?: boolean) => Promise<{
-        screen: string;
-    }>;
+    proposePlacement: (draft?: boolean) => Promise<any>;
     deletePlacement: (id: string) => Promise<void>;
     setStudent: import("react").Dispatch<import("react").SetStateAction<UserData | undefined>>;
     submitSection: (type: "dates" | "provider" | "address", data: {
@@ -183,12 +348,12 @@ type CreateCohortRendererParams = {
     product: Products;
     initialData?: CohortData;
 };
-export type CreateCohortStages = "name" | "placementType" | "students" | "workflow" | "review";
+export type CreateCohortStages = "info" | "name" | "placementType" | "review";
 export declare function useCreateCohortRenderer({ oId, product, initialData }: CreateCohortRendererParams): {
     submitCohort: () => void;
     submitSection: (e?: {
         [key: string]: unknown;
-    } | undefined) => void;
+    }) => void;
     back: () => void;
     setCohortData: import("react").Dispatch<import("react").SetStateAction<CohortData>>;
     deleteCohort: () => Promise<void>;
@@ -207,10 +372,10 @@ type UserUploadParams = {
 };
 export declare function useUserUploadHandler({ product, oId, userType, user, onComplete, userGroupId, cohortId }: UserUploadParams): {
     uploadUsers: (users: {
-        [key: string]: unknown;
-        email?: string | undefined;
-        parentEmail?: string | undefined;
+        email?: string;
+        parentEmail?: string;
         year: number;
+        [key: string]: unknown;
     }[]) => Promise<void>;
     alert: {
         severity: "warning" | "error" | "success" | "info";
@@ -220,25 +385,29 @@ export declare function useUserUploadHandler({ product, oId, userType, user, onC
 };
 type WorkflowEditorParams = {
     user: UserData;
-    initialData?: WorkflowStage[];
+    initialData?: WorkflowStage[] | ApplicantStage[];
     onSubmit: (e: {
         workflow: WorkflowStage[];
         includedFiles: string[];
         includedForms: string[];
     }) => void;
-    cohortId: string;
-    product?: "providers" | "institutes";
+    cohortId?: string;
+    product?: Products;
     oId?: string;
 };
-export declare function useWorkflowEditor({ user, initialData, onSubmit, cohortId, product, oId }: WorkflowEditorParams): {
+export declare function useWorkflowEditor({ user, initialData, onSubmit, cohortId }: WorkflowEditorParams): {
     filePopupActive: boolean;
     files: {
         name: string;
         url: string;
     }[];
     uploadFile: (files: any[]) => Promise<void>;
-    addNode: () => void;
-    onDelete: (id: number) => void;
+    addNode: ({ userType, nextStage, prevStage }?: {
+        userType?: "Students" | "Staff" | "Provider" | "Parent";
+        nextStage?: number;
+        prevStage?: number;
+    }) => number;
+    onDelete: (id?: number) => Promise<void>;
     arrows: ArrowObject[];
     onChange: (path: (string | number)[], value: unknown) => void;
     error: string | undefined;
@@ -249,7 +418,7 @@ export declare function useWorkflowEditor({ user, initialData, onSubmit, cohortI
     setTutorialActive: import("react").Dispatch<import("react").SetStateAction<boolean>>;
     setFilePopupActive: import("react").Dispatch<import("react").SetStateAction<boolean>>;
     includedForms: string[];
-    submitWorkflow: () => Promise<void>;
+    submitWorkflow: (workflow?: WorkflowStage[] | ApplicantStage[], callOnComplete?: boolean) => Promise<false | void>;
     openPopup: () => void;
     snackbar: string | undefined;
     setSnackbar: import("react").Dispatch<import("react").SetStateAction<string | undefined>>;
@@ -264,7 +433,55 @@ export declare function useWorkflowEditor({ user, initialData, onSubmit, cohortI
     containerRef: import("react").RefObject<HTMLFormElement>;
     setError: import("react").Dispatch<import("react").SetStateAction<string | undefined>>;
     setArrows: import("react").Dispatch<import("react").SetStateAction<ArrowObject[]>>;
-    setWorkflowNodes: import("react").Dispatch<import("react").SetStateAction<WorkflowStage[]>>;
+    setWorkflowNodes: import("react").Dispatch<import("react").SetStateAction<ApplicantStage[] | WorkflowStage[]>>;
+};
+type ApplicantWorkflowEditorParams = {
+    user: UserData;
+    initialData?: ApplicantStage[];
+    onSubmit: (e: {
+        workflow: ApplicantStage[];
+        includedFiles: string[];
+        includedForms: string[];
+    }) => void;
+    workflowId?: string;
+    product?: Products;
+    oId?: string;
+};
+export declare function useApplicantWorkflowEditor({ user, initialData, onSubmit, workflowId }: ApplicantWorkflowEditorParams): {
+    filePopupActive: boolean;
+    uploadFile: (files: any[]) => Promise<void>;
+    addNode: ({ userType, nextStage, prevStage }?: {
+        userType?: "Students" | "Staff";
+        nextStage?: number;
+        prevStage?: number;
+    }) => number;
+    onDelete: (id?: number) => Promise<void>;
+    arrows: ArrowObject[];
+    onChange: (path: (string | number)[], value: unknown) => void;
+    error: string | undefined;
+    includedFiles: string[];
+    onMoveEnd: (id: number, currentRef?: HTMLDivElement) => void;
+    addEdgePoint: (id: number, existingEdgePoint: number) => void;
+    newEdgePoint: number | undefined;
+    setTutorialActive: import("react").Dispatch<import("react").SetStateAction<boolean>>;
+    setFilePopupActive: import("react").Dispatch<import("react").SetStateAction<boolean>>;
+    includedForms: string[];
+    submitWorkflow: (workflow?: ApplicantStage[], callOnComplete?: boolean) => Promise<false | void>;
+    openPopup: () => void;
+    snackbar: string | undefined;
+    setSnackbar: import("react").Dispatch<import("react").SetStateAction<string | undefined>>;
+    setMousePosFunc: (e: React.MouseEvent<HTMLDivElement, MouseEvent>) => void;
+    mousePos: {
+        x: number;
+        y: number;
+    } | undefined;
+    tutorialActive: boolean;
+    onDeleteArrow: (data: ArrowObject) => void;
+    workflowNodes: ApplicantStage[];
+    containerRef: import("react").RefObject<HTMLFormElement>;
+    setError: import("react").Dispatch<import("react").SetStateAction<string | undefined>>;
+    setArrows: import("react").Dispatch<import("react").SetStateAction<ArrowObject[]>>;
+    setWorkflowNodes: import("react").Dispatch<import("react").SetStateAction<ApplicantStage[]>>;
 };
 type InstitutePlacementListingUploadParams = {
     user: UserData;
@@ -289,4 +506,148 @@ export declare function useInstitutePlacementListingHandler({ user }: InstituteP
     } | undefined;
     onChange: () => void;
 };
+export declare function useGetIndividualPlacementForPlacementPage({ user, placementId, organisation }: {
+    user: UserData;
+    placementId: string;
+    organisation?: {
+        details: InstituteData | ProviderData;
+        cohorts: {
+            [key: string]: CohortData;
+        };
+    };
+}): {
+    placement: StudentPlacementData | undefined;
+    wStage: WorkflowStage | undefined;
+    student: UserData | undefined;
+    workflow: WorkflowStage[] | undefined;
+    editable: boolean;
+    withdrawFromPlacementPopup: boolean;
+    setWithdrawFromPlacementPopup: import("react").Dispatch<import("react").SetStateAction<boolean>>;
+    withdrawFromPlacement: () => Promise<void>;
+    onFlagClick: (e: FlagCodes) => Promise<void>;
+    setUploadInsurance: import("react").Dispatch<import("react").SetStateAction<boolean>>;
+    setUploadProviderDocPopup: import("react").Dispatch<import("react").SetStateAction<"insurance" | "riskAssessment" | "DbsCheck" | undefined>>;
+    setUploadRA: import("react").Dispatch<import("react").SetStateAction<boolean>>;
+    setUploadDBS: import("react").Dispatch<import("react").SetStateAction<boolean>>;
+    onboardingStatus: "Add onboarding documents" | "Onboarding sent" | "Onboarding docs completed" | "Onboarding docs approved" | "Complete onboarding";
+    setSkipStagePopup: import("react").Dispatch<import("react").SetStateAction<boolean>>;
+    onboardingPopup: boolean;
+    setViewExternalLinkPopup: import("react").Dispatch<import("react").SetStateAction<boolean>>;
+    setOnboardingPopup: import("react").Dispatch<import("react").SetStateAction<boolean>>;
+    setRejectELIPopup: import("react").Dispatch<import("react").SetStateAction<boolean>>;
+    eliURL: string;
+    riskAssessmentURL: string;
+    dbsCheckURL: string;
+    setExternalLinkCopied: import("react").Dispatch<import("react").SetStateAction<boolean>>;
+    skipStagePopup: boolean;
+    snackbar: {
+        open: boolean;
+        message?: string;
+    };
+    setSnackbar: import("react").Dispatch<import("react").SetStateAction<{
+        open: boolean;
+        message?: string;
+    }>>;
+    cohort: CohortData | undefined;
+    disableEmail: {
+        parent: boolean;
+        provider: boolean;
+    };
+    rejectELIPopup: boolean;
+    eliPopupOpen: boolean;
+    rejectExternalDocPopup: false | "riskAssessment" | "dbsCheck";
+    externalDocPopupOpen: false | "riskAssessment" | "dbsCheck";
+    viewExternalLinkPopup: boolean;
+    externalLinkCopied: boolean;
+    uploadInsurance: boolean;
+    uploadRA: boolean;
+    uploadDBS: boolean;
+    editStage: (nextStageId: number) => Promise<void>;
+    sendEmail: (type: "provider" | "parent") => undefined;
+    canEdit: boolean;
+    approveELI: () => Promise<void>;
+    setEliPopupOpen: import("react").Dispatch<import("react").SetStateAction<boolean>>;
+    uploadProviderDocPopup: "insurance" | "riskAssessment" | "DbsCheck" | undefined;
+    rejectELI: ({ reason }: {
+        reason: string;
+    }) => Promise<void>;
+    setRejectExternalDocPopup: import("react").Dispatch<import("react").SetStateAction<false | "riskAssessment" | "dbsCheck">>;
+    setExternalDocPopupOpen: import("react").Dispatch<import("react").SetStateAction<false | "riskAssessment" | "dbsCheck">>;
+    approveProviderDoc: (type: "riskAssessment" | "dbsCheck") => Promise<void>;
+    rejectProviderDoc: ({ reason }: {
+        reason: string;
+    }, type: "riskAssessment" | "dbsCheck") => Promise<void>;
+    manuallyConfigureProvider: () => Promise<void>;
+    institute: InstituteData | undefined;
+};
+export declare function useOnboardingPopup({ onboarding, placementId, user, onClose }: {
+    onboarding: (OnboardingDocs & {
+        completed: {
+            submitted: string | false;
+            accepted?: boolean;
+            filesViewed?: string[];
+            formsCompleted?: {
+                [key: string]: unknown;
+            };
+            filesUploaded?: {
+                [key: number]: string[];
+            };
+        };
+    });
+    placementId: string;
+    user: UserData;
+    onClose: () => void;
+}): {
+    addFile: (files: string[]) => void;
+    viewFile: (file: string, onOpen: (url: string) => void) => void;
+    uploadedFiles: {
+        [key: string]: FileItem;
+    };
+    setFormComplete: (e: {
+        [key: string]: unknown;
+    }, formId?: string) => void;
+    setRejectPopup: import("react").Dispatch<import("react").SetStateAction<boolean>>;
+    stagesCompleted: () => boolean;
+    setForm: import("react").Dispatch<import("react").SetStateAction<{
+        [key: string]: unknown;
+        id: string;
+        name: string;
+    } | undefined>>;
+    mOnboarding: OnboardingDocs & {
+        completed: {
+            submitted: string | false;
+            accepted?: boolean;
+            filesViewed?: string[];
+            formsCompleted?: {
+                [key: string]: unknown;
+            };
+            filesUploaded?: {
+                [key: number]: string[];
+            };
+        };
+    };
+    form: {
+        [key: string]: unknown;
+        id: string;
+        name: string;
+    } | undefined;
+    submit: () => Promise<void>;
+    acceptOnboarding: () => Promise<void>;
+    rejectOnboarding: ({ reason }: {
+        reason: string;
+    }) => Promise<void>;
+    rejectPopup: boolean;
+    completedSections: {
+        submitted: string | false;
+        filesViewed?: string[] | undefined;
+        formsCompleted?: {
+            [key: string]: unknown;
+        } | undefined;
+        filesUploaded?: {
+            [key: number]: string[];
+        } | undefined;
+    } | undefined;
+    fileUploadPopup: number | false;
+    setFileUploadPopup: import("react").Dispatch<import("react").SetStateAction<number | false>>;
+};
 export {};