placementt-core 1.20.232 → 1.300.4

package/lib/hooks.d.ts

@@ -1,6 +1,5 @@
 import { DocumentData, QueryConstraint, QueryDocumentSnapshot, QueryFieldFilterConstraint } from "firebase/firestore";
-import { AlumniConvoUser, 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";
+import { AlumniConvoUser, ApplicantStage, Application, ArrowObject, CohortData, CustomFormSchema, FileItem, FlagCodes, InstituteData, OnboardingDocs, PlacementListing, Products, ProviderData, QueryObject, QueryObjectConstraint, Sorts, StudentPlacementData, UserData, UserGroupData, WorkflowStage } from "./typeDefinitions";
 type StudentPlacementListParams = {
     user: UserData;
     student?: UserData;
@@ -35,6 +34,9 @@ type NewInstitutePlacementParams = {
     inProgress?: boolean;
     view: "list" | "table";
     filters?: FilterObject;
+    initialSort?: string;
+    initialSearch?: string;
+    uid?: string;
 };
 export declare function useOldInstitutePlacementList({ id, user, cohort, queryConstraint, ql, inProgress }: InstitutePlacementParams): {
     placements: {
@@ -49,7 +51,7 @@ export declare function useOldInstitutePlacementList({ id, user, cohort, queryCo
     reset: () => void;
     changeQueryConstraints: (e: QueryConstraint[]) => void;
 };
-export declare function useNewInstitutePlacementList({ id, user, filters, view, cohort, queryConstraints, ql, inProgress }: NewInstitutePlacementParams): {
+export declare function useNewInstitutePlacementList({ id, user, uid, filters, initialSort, initialSearch, view, cohort, queryConstraints, ql, inProgress }: NewInstitutePlacementParams): {
     tableData: {
         [key: string]: {
             [key: string]: unknown;
@@ -57,9 +59,9 @@ export declare function useNewInstitutePlacementList({ id, user, filters, view,
     };
     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">>;
+    updateSearch: (search: string) => void;
+    setFilters: (fFilters?: FilterObject) => void;
+    setView: (v: "list" | "table") => void;
     pageUp: () => void;
     pageDown: () => void;
     sorts: {
@@ -68,7 +70,7 @@ export declare function useNewInstitutePlacementList({ id, user, filters, view,
             direction: "asc" | "desc";
         };
     };
-    updateSort: (sortLabel: string) => void;
+    updateSort: (sortLabel?: string) => void;
     sort: [string, {
         value: string;
         direction: "asc" | "desc";
@@ -91,8 +93,8 @@ export declare function useAlumniPaginator({ user, alumniConvoUser, filters, vie
     };
     page: number;
     loading: boolean | "loaded";
-    setFilters: import("react").Dispatch<import("react").SetStateAction<FilterObject | undefined>>;
-    setView: import("react").Dispatch<import("react").SetStateAction<"table" | "list">>;
+    setFilters: (fFilters?: FilterObject) => void;
+    setView: (v: "list" | "table") => void;
     pageUp: () => void;
     pageDown: () => void;
     sorts: {
@@ -133,20 +135,23 @@ export declare function useFilterTablePaginator({ data }: {
     } | undefined>>;
     page: number[];
 };
-export declare function usePlacementListingPaginator({ data, user }: {
+export declare function useProviderContactPaginator({ data, user, view, filters }: {
     data: QueryObject[];
     user: UserData;
+    view: "list" | "table";
+    filters?: FilterObject;
 }): {
     tableData: {
-        [key: string]: PlacementListing & {
-            savedPlacement: SavedPlacement;
+        [key: string]: {
+            [key: string]: unknown;
         };
     };
-    setPage: import("react").Dispatch<import("react").SetStateAction<number[]>>;
-    setFilters: import("react").Dispatch<import("react").SetStateAction<{
-        [key: string]: unknown;
-    } | undefined>>;
-    page: number[];
+    pageUp: () => void;
+    pageDown: () => void;
+    setFilters: (fFilters?: FilterObject) => void;
+    page: number;
+    setView: (v: "list" | "table") => void;
+    loading: boolean | "loaded";
 };
 type UserPaginatorParams = {
     user: UserData;
@@ -156,6 +161,42 @@ type UserPaginatorParams = {
     userType: "Staff" | "Students";
     sort?: string;
 };
+type NewUserPaginatorParams = {
+    user: UserData;
+    cohort?: string;
+    queryConstraints?: QueryObjectConstraint;
+    ql?: number;
+    view: "list" | "table";
+    filters?: FilterObject;
+    institute: InstituteData;
+    userType: "Staff" | "Students";
+    initialSort?: string;
+};
+export declare function useNewCohortUserPaginator({ user, institute, initialSort, filters, view, cohort, queryConstraints, ql, userType }: NewUserPaginatorParams): {
+    tableData: {
+        [key: string]: {
+            [key: string]: unknown;
+        };
+    };
+    page: number;
+    loading: boolean | "loaded";
+    updateSearch: (search: string) => void;
+    setFilters: (fFilters?: FilterObject) => void;
+    setView: (v: "list" | "table") => void;
+    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 useCohortUserPaginator({ user, cohort, data, search, userType, sort }: UserPaginatorParams): {
     tableData: {
         [key: string]: {
@@ -208,162 +249,6 @@ export declare function useLazyLoadQueryList({ path, constraints, number, onItem
     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 | false | 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: false | PlacementListing | undefined;
-    student: UserData | undefined;
-    fProvider: {
-        details?: ProviderData;
-        profile?: string;
-        id?: string;
-    } | undefined;
-};
 export declare function useProposePlacementRenderer({ user, orgContext, placement }: {
     user: UserData;
     orgContext?: {
@@ -393,7 +278,11 @@ export declare function useProposePlacementRenderer({ user, orgContext, placemen
     setAddressSectionComplete: import("react").Dispatch<import("react").SetStateAction<boolean>>;
     setPlacementSectionComplete: import("react").Dispatch<import("react").SetStateAction<boolean>>;
     proposePlacement: (draft?: boolean) => Promise<{
-        data: any;
+        status: {
+            active: boolean;
+            inProgress: boolean;
+            completed: boolean;
+        };
     }>;
     deletePlacement: (id: string) => Promise<void>;
     setStudent: import("react").Dispatch<import("react").SetStateAction<UserData | undefined>>;
@@ -417,7 +306,7 @@ type CreateCohortRendererParams = {
     product: Products;
     initialData?: CohortData;
 };
-export type CreateCohortStages = "info" | "name" | "placementType" | "review";
+export type CreateCohortStages = "info" | "name" | "placementType" | "database" | "review";
 export declare function useCreateCohortRenderer({ oId, product, initialData }: CreateCohortRendererParams): {
     submitCohort: () => void;
     submitSection: (e?: {
@@ -552,23 +441,24 @@ export declare function useApplicantWorkflowEditor({ user, initialData, onSubmit
     setArrows: import("react").Dispatch<import("react").SetStateAction<ArrowObject[]>>;
     setWorkflowNodes: import("react").Dispatch<import("react").SetStateAction<ApplicantStage[]>>;
 };
-type InstitutePlacementListingUploadParams = {
+type InstituteProviderContactUploadParams = {
     user: UserData;
     onComplete?: () => void;
 };
-export type InstitutePlacementListingUpload = {
-    provider: string;
-    jobTitle: string;
+export type InstituteProviderContactUpload = {
+    business: string;
+    forename?: string;
+    surname?: string;
     email: string;
     phone?: string;
-    addressOne: string;
-    addressTwo: string;
-    city: string;
-    postcode: string;
-    country: string;
-};
-export declare function useInstitutePlacementListingHandler({ user }: InstitutePlacementListingUploadParams): {
-    uploadPlacements: (placements: InstitutePlacementListingUpload[]) => Promise<boolean>;
+    addressOne?: string;
+    addressTwo?: string;
+    city?: string;
+    postcode?: string;
+    country?: string;
+};
+export declare function useInstituteProviderContactsHandler({ user }: InstituteProviderContactUploadParams): {
+    uploadProviderContacts: (providers: InstituteProviderContactUpload[], schoolId?: string) => Promise<boolean>;
     alert: {
         severity: "warning" | "error" | "success" | "info";
         msg: string;
@@ -863,8 +753,10 @@ export type DataViewerPaginater = {
     } | QueryObject[];
     additionalEntryProcessing?: (k: string, v: any) => Promise<any> | any;
     sorts?: Sorts;
+    initialSort?: string;
+    initialSearch?: string;
 };
-export declare function useDataViewerPaginator({ view: initialView, sorts, queryLimit, additionalEntryProcessing, formatItems, snapshot, filters: initialFilters, onSearch, data }: DataViewerPaginater): {
+export declare function useDataViewerPaginator({ view: initialView, sorts, queryLimit, additionalEntryProcessing, formatItems, snapshot, filters: initialFilters, initialSort, initialSearch, onSearch, data }: DataViewerPaginater): {
     tableData: {
         [key: string]: {
             [key: string]: unknown;
@@ -872,7 +764,8 @@ export declare function useDataViewerPaginator({ view: initialView, sorts, query
     };
     pageUp: () => void;
     pageDown: () => void;
-    setFilters: import("react").Dispatch<import("react").SetStateAction<FilterObject | undefined>>;
+    search: string | undefined;
+    setFilters: (fFilters?: FilterObject) => void;
     page: number;
     sorts: Sorts;
     loading: boolean | "loaded";
@@ -880,8 +773,8 @@ export declare function useDataViewerPaginator({ view: initialView, sorts, query
         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>>;
+    updateSort: (sortLabel?: string) => void;
+    setView: (v: "list" | "table") => void;
+    updateSearch: (search: string) => void;
 };
 export {};