placementt-core 11.0.533 → 11.0.803

package/lib/hooks.d.ts

@@ -1,5 +1,5 @@
-import { DocumentData, QueryConstraint, QueryDocumentSnapshot } from "firebase/firestore";
-import { ApplicantStage, ApplicantWorkflow, Application, ArrowObject, CohortData, FileItem, FlagCodes, InstituteData, OnboardingDocs, PlacementListing, Products, ProviderData, QueryObject, SavedPlacement, StudentPlacementData, UserData, UserGroupData, WorkflowStage } from "./typeDefinitions";
+import { DocumentData, QueryConstraint, QueryDocumentSnapshot, QueryFieldFilterConstraint } from "firebase/firestore";
+import { ApplicantStage, ApplicantWorkflow, Application, ArrowObject, CohortData, CustomFormSchema, FileItem, FlagCodes, InstituteData, OnboardingDocs, PlacementListing, Products, ProviderData, QueryObject, QueryObjectConstraint, SavedPlacement, Sorts, StudentPlacementData, UserData, UserGroupData, WorkflowStage } from "./typeDefinitions";
 import { OrganisationAddress } from "placementt-core";
 type StudentPlacementListParams = {
     user: UserData;
@@ -26,7 +26,17 @@ type InstitutePlacementParams = {
     ql?: number;
     inProgress?: boolean;
 };
-export declare function useNewInstitutePlacementList({ id, user, cohort, queryConstraint, ql, inProgress }: InstitutePlacementParams): {
+type NewInstitutePlacementParams = {
+    id?: string;
+    user: UserData;
+    cohort?: string;
+    queryConstraints?: QueryObjectConstraint;
+    ql?: number;
+    inProgress?: boolean;
+    view: "list" | "table";
+    filters?: FilterObject;
+};
+export declare function useOldInstitutePlacementList({ id, user, cohort, queryConstraint, ql, inProgress }: InstitutePlacementParams): {
     placements: {
         [key: string]: StudentPlacementData & {
             student: UserData;
@@ -39,7 +49,32 @@ export declare function useNewInstitutePlacementList({ id, user, cohort, queryCo
     reset: () => void;
     changeQueryConstraints: (e: QueryConstraint[]) => void;
 };
-export declare function useOldInstitutePlacementList({ user, cohort, queryConstraint, ql }: InstitutePlacementParams): {
+export declare function useNewInstitutePlacementList({ id, user, filters, view, cohort, queryConstraints, ql, inProgress }: NewInstitutePlacementParams): {
+    tableData: {
+        [key: string]: {
+            [key: string]: unknown;
+        };
+    };
+    page: number;
+    loading: boolean | "loaded";
+    updateSearch: import("react").Dispatch<import("react").SetStateAction<string | undefined>>;
+    setFilters: import("react").Dispatch<import("react").SetStateAction<FilterObject | undefined>>;
+    setView: import("react").Dispatch<import("react").SetStateAction<"table" | "list">>;
+    pageUp: () => void;
+    pageDown: () => void;
+    sorts: {
+        [label: string]: {
+            value: string;
+            direction: "asc" | "desc";
+        };
+    };
+    updateSort: (sortLabel: string) => void;
+    sort: [string, {
+        value: string;
+        direction: "asc" | "desc";
+    }] | undefined;
+};
+export declare function useVeryOldInstitutePlacementList({ user, cohort, queryConstraint, ql }: InstitutePlacementParams): {
     placements: {
         [key: string]: StudentPlacementData & {
             student: UserData;
@@ -91,8 +126,9 @@ type UserPaginatorParams = {
     data: QueryObject[];
     search?: string;
     userType: "Staff" | "Students";
+    sort?: string;
 };
-export declare function useCohortUserPaginator({ user, cohort, data, search, userType }: UserPaginatorParams): {
+export declare function useCohortUserPaginator({ user, cohort, data, search, userType, sort }: UserPaginatorParams): {
     tableData: {
         [key: string]: {
             [key: string]: unknown;
@@ -103,6 +139,9 @@ export declare function useCohortUserPaginator({ user, cohort, data, search, use
     setFilters: import("react").Dispatch<import("react").SetStateAction<{
         [key: string]: unknown;
     } | undefined>>;
+    setSort: (s: string) => void;
+    sortOptions: string[];
+    sortBy: string | undefined;
 };
 export declare function useAdmissionsPaginator({ data }: {
     data: {
@@ -182,7 +221,7 @@ export type ApplicationHookParams = {
     profileUrl: string | undefined;
     successPopup: "submitted" | "draftSaved" | "stageComplete" | "outcome" | undefined;
     fApplicationId: string | undefined;
-    fListing: PlacementListing | undefined;
+    fListing: PlacementListing | false | undefined;
     student: UserData | undefined;
     fProvider: {
         details?: ProviderData;
@@ -289,7 +328,7 @@ export declare function useCreateApplicationRenderer({ user, listingId, listing,
     profileUrl: string | undefined;
     successPopup: "submitted" | "draftSaved" | "stageComplete" | "outcome" | undefined;
     fApplicationId: string | undefined;
-    fListing: PlacementListing | undefined;
+    fListing: false | PlacementListing | undefined;
     student: UserData | undefined;
     fProvider: {
         details?: ProviderData;
@@ -325,7 +364,13 @@ 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<any>;
+    proposePlacement: (draft?: boolean) => Promise<{
+        status: {
+            active: boolean;
+            inProgress: boolean;
+            completed: boolean;
+        };
+    }>;
     deletePlacement: (id: string) => Promise<void>;
     setStudent: import("react").Dispatch<import("react").SetStateAction<UserData | undefined>>;
     submitSection: (type: "dates" | "provider" | "address", data: {
@@ -363,7 +408,7 @@ export declare function useCreateCohortRenderer({ oId, product, initialData }: C
 type UserUploadParams = {
     userType: "Staff" | "Students";
     user: UserData;
-    onComplete?: () => void;
+    onComplete?: (e: string) => void;
     cohortId?: string;
     userGroupId?: string;
     shareNameWithReferralLeaderboardConsent?: string;
@@ -433,7 +478,7 @@ 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<ApplicantStage[] | WorkflowStage[]>>;
+    setWorkflowNodes: import("react").Dispatch<import("react").SetStateAction<WorkflowStage[] | ApplicantStage[]>>;
 };
 type ApplicantWorkflowEditorParams = {
     user: UserData;
@@ -517,14 +562,25 @@ export declare function useGetIndividualPlacementForPlacementPage({ user, placem
     };
 }): {
     placement: StudentPlacementData | undefined;
-    wStage: WorkflowStage | undefined;
+    wStage: (WorkflowStage & {
+        files: {
+            [fileId: string]: {
+                name: string;
+                url: string;
+            };
+        };
+    }) | undefined;
     student: UserData | undefined;
     workflow: WorkflowStage[] | undefined;
     editable: boolean;
     withdrawFromPlacementPopup: boolean;
+    addOnboardingDocsPopup: boolean;
+    setAddOnboardingDocsPopup: import("react").Dispatch<import("react").SetStateAction<boolean>>;
+    dismissOnboardingPopup: boolean;
+    setDismissOnboardingPopup: import("react").Dispatch<import("react").SetStateAction<boolean>>;
     setWithdrawFromPlacementPopup: import("react").Dispatch<import("react").SetStateAction<boolean>>;
     withdrawFromPlacement: () => Promise<void>;
-    onFlagClick: (e: FlagCodes) => Promise<void>;
+    onFlagClick: (e: FlagCodes, onClose?: boolean) => 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>>;
@@ -579,11 +635,14 @@ export declare function useGetIndividualPlacementForPlacementPage({ user, placem
     }, type: "riskAssessment" | "dbsCheck") => Promise<void>;
     manuallyConfigureProvider: () => Promise<void>;
     institute: InstituteData | undefined;
+    shareStudentRequestPopup: boolean;
+    setShareStudentRequestPopup: import("react").Dispatch<import("react").SetStateAction<boolean>>;
 };
-export declare function useOnboardingPopup({ onboarding, placementId, user, onClose }: {
+export declare function useOnboardingPopup({ onboarding, providerId, placementId, user, onClose }: {
     onboarding: (OnboardingDocs & {
         completed: {
-            submitted: string | false;
+            submitted: boolean;
+            submittedDate?: string;
             accepted?: boolean;
             filesViewed?: string[];
             formsCompleted?: {
@@ -596,6 +655,7 @@ export declare function useOnboardingPopup({ onboarding, placementId, user, onCl
     });
     placementId: string;
     user: UserData;
+    providerId: string;
     onClose: () => void;
 }): {
     addFile: (files: string[]) => void;
@@ -615,7 +675,8 @@ export declare function useOnboardingPopup({ onboarding, placementId, user, onCl
     } | undefined>>;
     mOnboarding: OnboardingDocs & {
         completed: {
-            submitted: string | false;
+            submitted: boolean;
+            submittedDate?: string;
             accepted?: boolean;
             filesViewed?: string[];
             formsCompleted?: {
@@ -638,7 +699,8 @@ export declare function useOnboardingPopup({ onboarding, placementId, user, onCl
     }) => Promise<void>;
     rejectPopup: boolean;
     completedSections: {
-        submitted: string | false;
+        submitted: boolean;
+        submittedDate?: string;
         filesViewed?: string[] | undefined;
         formsCompleted?: {
             [key: string]: unknown;
@@ -649,5 +711,153 @@ export declare function useOnboardingPopup({ onboarding, placementId, user, onCl
     } | undefined;
     fileUploadPopup: number | false;
     setFileUploadPopup: import("react").Dispatch<import("react").SetStateAction<number | false>>;
+    viewableFiles: {
+        [key: string]: FileItem;
+    } | undefined;
+    formDetails: {
+        [key: string]: {
+            name: string;
+            id: string;
+            description?: string;
+            product: Products;
+            oId: string;
+            form: CustomFormSchema;
+        };
+    };
+};
+export declare function useLoadAddresses(user: UserData, limitItems?: number, queryConstraint?: QueryConstraint[], request?: boolean): {
+    addresses: {
+        [key: string]: import("placementt-core").Address & {
+            name?: string;
+            savedBy?: string[];
+            product: import("placementt-core").Products;
+            oId: string;
+            stage: import("placementt-core").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")[];
+        } & {
+            listings: number;
+        };
+    };
+    onScrollBottom: () => void;
+    loading: boolean;
+    changeQueryConstraints: (e: QueryConstraint[]) => void;
+};
+export declare function useLoadListings(user: UserData, queryConstraint?: QueryConstraint[], request?: boolean): {
+    listings: [string, PlacementListing & {
+        applicants?: number;
+        scheduled?: number;
+        active?: number;
+    }][];
+    onScrollBottom: () => void;
+    loading: boolean;
+    changeQueryConstraints: (e: QueryConstraint[]) => void;
+};
+export declare function useLoadProviderPlacements(user: UserData, queryConstraint?: QueryConstraint[], placementId?: string): {
+    placements: {
+        [k: string]: never;
+    };
+    onScrollBottom: () => void;
+    loading: boolean;
+    changeQueryConstraints: (e: QueryConstraint[]) => void;
+};
+export declare function useLoadApplications({ user, applicationType, listingId, queryConstraint }: {
+    user: UserData;
+    applicationType?: "all" | "actionRequired" | "awaitingStudent" | "closed";
+    listingId?: string;
+    queryConstraint?: QueryConstraint[];
+}): {
+    applications: [string, Application][];
+    type: "all" | "closed" | "actionRequired" | "awaitingStudent";
+    setType: import("react").Dispatch<import("react").SetStateAction<"all" | "closed" | "actionRequired" | "awaitingStudent">>;
+    onScrollBottom: () => void;
+    loading: boolean;
+    changeQueryConstraints: (e: QueryConstraint[]) => void;
+};
+export type FilterObject = {
+    [key: string]: {
+        label: string;
+        value?: unknown;
+        values?: {
+            [key: string | number]: string | {
+                label: string;
+                test: QueryFieldFilterConstraint;
+            };
+        };
+        type: "dropdown" | "string" | "number";
+    };
+};
+export type DataViewerPaginater = {
+    view: "list" | "table";
+    queryLimit?: number;
+    formatItems?: (key: string, item: any) => Promise<{
+        key: string;
+        item: any;
+    }> | {
+        key: string;
+        item: any;
+    };
+    snapshot?: boolean;
+    filters?: FilterObject;
+    onSearch?: boolean | ((search?: string, sort?: [string, {
+        value: string;
+        direction: "asc" | "desc";
+    }], page?: number, filters?: FilterObject, limit?: number) => Promise<{
+        [key: string]: any;
+    }>);
+    data?: {
+        [key: string]: {
+            [key: string]: unknown;
+        };
+    } | QueryObject[];
+    additionalEntryProcessing?: (k: string, v: any) => Promise<any> | any;
+    sorts?: Sorts;
+};
+export declare function useDataViewerPaginator({ view: initialView, sorts, queryLimit, additionalEntryProcessing, formatItems, snapshot, filters: initialFilters, onSearch, data }: DataViewerPaginater): {
+    tableData: {
+        [key: string]: {
+            [key: string]: unknown;
+        };
+    };
+    pageUp: () => void;
+    pageDown: () => void;
+    setFilters: import("react").Dispatch<import("react").SetStateAction<FilterObject | undefined>>;
+    page: number;
+    sorts: Sorts;
+    loading: boolean | "loaded";
+    sort: [string, {
+        value: string;
+        direction: "asc" | "desc";
+    }] | undefined;
+    updateSort: (sortLabel: string) => void;
+    setView: import("react").Dispatch<import("react").SetStateAction<"table" | "list">>;
+    updateSearch: import("react").Dispatch<import("react").SetStateAction<string | undefined>>;
 };
 export {};