placementt-core 11.0.914 → 11.0.951

package/src/hooks.tsx

@@ -22,6 +22,7 @@ import {
 import algoliasearch from "algoliasearch";
 import {getDownloadURL, ref} from "firebase/storage";
 import {OrganisationAddress} from "placementt-core";
+import {objectsEqualNew} from "./util";
 
 
 type StudentPlacementListParams = {
@@ -161,6 +162,9 @@ type NewInstitutePlacementParams = {
     inProgress?: boolean,
     view: "list"|"table",
     filters?: FilterObject,
+    initialSort?: string,
+    initialSearch?: string
+    uid?: string,
 }
 
 
@@ -323,7 +327,7 @@ export function useOldInstitutePlacementList({id, user, cohort, queryConstraint,
 }
 
 
-export function useNewInstitutePlacementList({id, user, filters, view, cohort, queryConstraints, ql=DEFAULTQUERYLIMIT, inProgress}:NewInstitutePlacementParams) {
+export function useNewInstitutePlacementList({id, user, uid, filters, initialSort, initialSearch, view, cohort, queryConstraints, ql=DEFAULTQUERYLIMIT, inProgress}:NewInstitutePlacementParams) {
     const [query, setQuery] = useState<QueryObject[]>();
 
     const sorts:Sorts = {
@@ -377,14 +381,13 @@ export function useNewInstitutePlacementList({id, user, filters, view, cohort, q
                 return false;
             }
         }
-        console.log("Valid placement", k);
         return {...placement, id: k};
     }
 
-
-    const {tableData, pageUp, pageDown, setFilters, page, setView, loading, updateSearch, updateSort, sort} = useDataViewerPaginator({view, filters, sorts, queryLimit: ql, data: query, additionalEntryProcessing: additionalProcessing, onSearch: async (s, sort, page, filters, limit) => await algoliaPlacementSearch(query || [], user, s, sort, page, filters, limit, cohort, inProgress)})
+    const {tableData, pageUp, pageDown, setFilters, page, setView, loading, updateSearch, updateSort, sort} = useDataViewerPaginator({view, filters, sorts, queryLimit: ql, initialSort, initialSearch, data: query, additionalEntryProcessing: additionalProcessing, onSearch: async (s, sort, page, filters, limit) => await algoliaPlacementSearch(query || [], user, s, sort, page, filters, limit, cohort, inProgress)})
 
     useEffect(() => {
+        console.log("SET QUERY", user, queryConstraints, cohort);
         // Sets the query of for the DataViewerPaginator
         if(user.product !== "institutes" || user.userType !== "Staff") {
             setQuery(undefined);
@@ -394,6 +397,8 @@ export function useNewInstitutePlacementList({id, user, filters, view, cohort, q
             const constraints:QueryObjectConstraint = [["oId", "==", user.oId], ["draft", "==", false]];
 
             cohort && constraints.push(["cohort", "==", cohort]);
+            uid && constraints.push(["uid", "==", uid]);
+
             queryConstraints && constraints.unshift(...queryConstraints);
             inProgress !== undefined && constraints.push(["inProgress", "==", inProgress]);
             
@@ -1044,25 +1049,26 @@ const algoliaUsersSearch = async (data: QueryObject[], user: UserData, query?: s
         if (!constraints?.length) return {};
 
         let userSearchString = constraints.map(([k, e, v]) => {
-            if (e === "==") return `${k}:"${v}"`; // Equality check
-            if (e === "!=") return `${k}:-"${v}"`; // Not equal check
+            if (e === "==") return `${k}:${v}`; // Equality check
+            if (e === "!=") return `${k}:-${v}`; // Not equal check
             if (e === "<") return `${k}:<${v}`; // Less than check
             if (e === "<=") return `${k}:<=${v}`; // Less than or equal check
             if (e === ">") return `${k}:>${v}`; // Greater than check
             if (e === ">=") return `${k}:>=${v}`; // Greater than or equal check
-            if (e === "array-contains") return `${k}:"${v}"`; // Array contains check (string format)
+            if (e === "array-contains") return `${k}:${v}`; // Array contains check (string format)
             if (e === "array-contains-any") return `${k}:"${(v as string[]).join('","')}"`; // Array contains any of the values (string format)
-            if (e === "in") return `${k}:(${(v as string[]).join('","')})`; // In check
-            if (e === "not-in") return `${k}:(-${(v as string[]).join('","')})`; // Not in check
+            if (e === "in") return `(${(v as string[]).map((value) => `${k}:${value}`).join(' OR ')})`; // In check
+            if (e === "not-in") return (v as string[]).map((value) => `${k}:-${value}`).join(' AND '); // In check
             return;
         }).join(" AND ");
 
-        console.log("QUERY", userSearchString);
-
         filters && Object.entries(filters).filter(([, filter]) => filter.value).map(([id, filter]) => {
             userSearchString = userSearchString + ` AND ${id}:${filter.value}`;
         });
 
+        console.log("QUERY", userSearchString);
+
+
         const options = {
             filters: userSearchString,
             hitsPerPage: limit,
@@ -1089,11 +1095,12 @@ type NewUserPaginatorParams = {
     view: "list"|"table",
     filters?: FilterObject,
     institute: InstituteData,
-    userType: "Staff"|"Students"
+    userType: "Staff"|"Students",
+    initialSort?: string
 }
 
 
-export function useNewCohortUserPaginator({user, institute, filters, view, cohort, queryConstraints, ql=DEFAULTQUERYLIMIT, userType}:NewUserPaginatorParams) {
+export function useNewCohortUserPaginator({user, institute, initialSort, filters, view, cohort, queryConstraints, ql=DEFAULTQUERYLIMIT, userType}:NewUserPaginatorParams) {
     const [query, setQuery] = useState<QueryObject[]>();
 
     const firebaseQuery = new FirebaseQuery();
@@ -1202,7 +1209,7 @@ export function useNewCohortUserPaginator({user, institute, filters, view, cohor
     }, [user, queryConstraints, cohort])
 
 
-    const {tableData, pageUp, pageDown, setFilters, page, setView, loading, updateSearch, updateSort, sort} = useDataViewerPaginator({view, filters, sorts, queryLimit: ql, data: query, onSearch: async (s, sort, page, filters, limit) => await algoliaUsersSearch(query || [], user, s, sort, page, filters, limit, cohort)})
+    const {tableData, pageUp, pageDown, setFilters, page, setView, loading, updateSearch, updateSort, sort} = useDataViewerPaginator({view, filters, initialSort, sorts, queryLimit: ql, data: query, onSearch: async (s, sort, page, filters, limit) => await algoliaUsersSearch(query || [], user, s, sort, page, filters, limit, cohort)})
 
 
     return {tableData, page, loading, updateSearch, setFilters, setView, pageUp, pageDown, sorts, updateSort, sort}
@@ -4129,10 +4136,12 @@ export type DataViewerPaginater = {
     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
+    sorts?: Sorts,
+    initialSort?: string,
+    initialSearch?: string
 }
 
-export function useDataViewerPaginator({view: initialView, sorts, queryLimit=10, additionalEntryProcessing, formatItems, snapshot, filters: initialFilters, onSearch, data}:DataViewerPaginater) {
+export function useDataViewerPaginator({view: initialView, sorts, queryLimit=10, additionalEntryProcessing, formatItems, snapshot, filters: initialFilters, initialSort, initialSearch, onSearch, data}:DataViewerPaginater) {
     const [tableData, setTableData] = useState<{[key:string]:{[key:string]: unknown}}>(Array.isArray(data) ? Object.fromEntries(Object.entries(data).slice(0, queryLimit)) : {});
     const [page, setPage] = useState([1, 0]);
     const [view, setView] = useState(initialView);
@@ -4142,16 +4151,18 @@ export function useDataViewerPaginator({view: initialView, sorts, queryLimit=10,
     const [dataListenerUnsubscribe, setDataListenerUnsubscribe] = useState<{[key: string] : Unsubscribe}>();
     const [loading, setLoading] = useState<boolean|"loaded">(true);
     const [searchString, setSearchString] = useState<string>();
-    const [sort, setSort] = useState<[string, {value: string, direction: "asc"|"desc"}]>();
+    const [sort, setSort] = useState<[string, {value: string, direction: "asc"|"desc"}]|undefined>((initialSort && sorts && sorts[initialSort]) ? [initialSort, sorts[initialSort]] : undefined);
+    const [fData, setFData] = useState(data);
 
+    console.log("SORT", sort, initialSort, sorts, sorts?.[initialSort || ""]);
 
 
     const processedData = async (k: string, v: any) => additionalEntryProcessing ? await additionalEntryProcessing(k, v) : v;
 
     const setTableDataFromDefinedData = async () => {
-        if (!data || Array.isArray(data)) return;
+        if (!fData || Array.isArray(fData)) return;
 
-        const dataWithAdditionalProcessingPossibleNulls: [string, any][] = (await Promise.all(Object.entries(data).map(async ([k, v]) => [k, await processedData(k, v)])))
+        const dataWithAdditionalProcessingPossibleNulls: [string, any][] = (await Promise.all(Object.entries(fData).map(async ([k, v]) => [k, await processedData(k, v)])))
         const dataWithAdditionalProcessing = dataWithAdditionalProcessingPossibleNulls.filter(([k, v]) => v);
 
         const searchedData: [string, any][] = searchString ? dataWithAdditionalProcessing.filter(([, v]) => {
@@ -4173,7 +4184,7 @@ export function useDataViewerPaginator({view: initialView, sorts, queryLimit=10,
             if (!queryLimit) throw new Error("Tables must have a limit defined.");
             const newData:[string, any][] = filteredData.slice((page[0] - 1)*queryLimit, page[0]*queryLimit);
             setTableData(Object.fromEntries(newData));
-            if (Object.keys(Object.fromEntries(newData)).pop() === Object.keys(data).pop()) {
+            if (Object.keys(Object.fromEntries(newData)).pop() === Object.keys(fData).pop()) {
                 setLoading("loaded");
             } else {
                 setLoading(false);
@@ -4191,7 +4202,7 @@ export function useDataViewerPaginator({view: initialView, sorts, queryLimit=10,
         
         // if (!filters) return;
         setLoading(true);
-        if (!Array.isArray(data)) {
+        if (!Array.isArray(fData)) {
             setTableDataFromDefinedData();
             return;
         }
@@ -4226,7 +4237,7 @@ export function useDataViewerPaginator({view: initialView, sorts, queryLimit=10,
             cursorPos = currentQueryAnchor.startQueryPos;
         }
 
-        const querySchema:QueryObject = data[cursorPos];
+        const querySchema:QueryObject = fData[cursorPos];
 
         const createQuery = (queryData:QueryObject) => {
             const constraints:any[] = [];
@@ -4288,7 +4299,7 @@ export function useDataViewerPaginator({view: initialView, sorts, queryLimit=10,
 
         // Function to handle query snapshot
         async function handleQuerySnapshot(querySnapshot: QuerySnapshot) {
-            if (!Array.isArray(data)) throw new Error("Called querySnapshot but data is defined.");
+            if (!Array.isArray(fData)) throw new Error("Called querySnapshot but data is defined.");
             if (!queryLimit) throw new Error("Firestore queries must have a limit defined.");
 
             const queryResults: { [key: string]: { [key: string]: unknown } } = {};
@@ -4343,7 +4354,7 @@ export function useDataViewerPaginator({view: initialView, sorts, queryLimit=10,
 
             if (querySnapshot.size < queryLimit && Object.keys(itemList).length < queryLimit) {
                 // If we have ran out of entries, increase or decrease the index.
-                if (page[0] > page[1] && cursorPos+1 < data.length) {
+                if (page[0] > page[1] && cursorPos+1 < fData.length) {
                     return getDataFromQuery(itemList, {...currentQueryAnchor, endQueryPos: currentQueryAnchor.endQueryPos+1}, "increase", prevEntries);
                 } else if (page[0] < page[1] && cursorPos > 0) {
                     return getDataFromQuery(itemList, {...currentQueryAnchor, startQueryPos: currentQueryAnchor.startQueryPos-1}, "decrease", prevEntries);
@@ -4357,7 +4368,7 @@ export function useDataViewerPaginator({view: initialView, sorts, queryLimit=10,
 
             if (querySnapshot.size === 0 &&
                 Object.keys(itemList).length === 0 &&
-                currentQueryAnchor.endQueryPos+1 === data.length &&
+                currentQueryAnchor.endQueryPos+1 === fData.length &&
                 page[0] > 1) {
                 if (view === "table") {
                     setTableData({});
@@ -4395,31 +4406,34 @@ export function useDataViewerPaginator({view: initialView, sorts, queryLimit=10,
     };
 
     useEffect(() => {
-        console.log("Filters updates", filters);
-        if (!filters) return;
-        console.log("Resetting cus filters");
-        reset();
-    }, [filters]);
-
-    useEffect(() => {
-        console.log("View reset.")
+        if (objectsEqualNew(fData, data)) return;
+        console.log("data reset.", fData, data);
+        setFData(data);
         reset();
-    }, [view]);
+    }, [data]);
 
-    useEffect(() => {
-        console.log("search reset.")
-        reset();
-    }, [searchString]);
+    const updateFilters = (fFilters?: FilterObject) => {
+        if (!objectsEqualNew(fFilters, filters)) {
+            console.log("FILTER RESET", fFilters, filters);
+            setFilters(fFilters);
+            reset();
+        }
+    }
 
-    useEffect(() => {
-        console.log("data reset.")
+    
+    const updateSearch = (search: string) => {
+        if (searchString === search) return;
+        console.log("SEARCH RESET", searchString, search);
+        setSearchString(search);
         reset();
-    }, [data]);
+    }
 
-    useEffect(() => {
-        console.log("sort reset.")
+    const updateView = (v: "list" | "table") => {
+        if (v === view) return;
+        console.log("View reset", view, v);
+        setView(v);
         reset();
-    }, [sort]);
+    }
 
 
     // Fetch new data when queries or page change
@@ -4436,10 +4450,15 @@ export function useDataViewerPaginator({view: initialView, sorts, queryLimit=10,
         setPage((p) => ([p[0]-1, p[0]]));
     };
 
-    const updateSort = (sortLabel: string) => {
-        if (!sorts || !sorts[sortLabel]) return;
-        setSort([sortLabel, sorts[sortLabel]]);
+    const updateSort = (sortLabel?: string) => {
+        if (!sortLabel) {
+            setSort(undefined);
+        } else {
+            if (!sorts || !sorts[sortLabel]) return;
+            setSort([sortLabel, sorts[sortLabel]]);
+        }
+        reset();
     }
 
-    return ({...{tableData, pageUp, pageDown, setFilters, page: page[0], sorts, loading, sort, updateSort: updateSort, setView, updateSearch: setSearchString}});
+    return ({...{tableData, pageUp, pageDown, search: searchString, setFilters: updateFilters, page: page[0], sorts, loading, sort, updateSort: updateSort, setView: updateView, updateSearch}});
 };

package/src/typeDefinitions.ts

@@ -1,6 +1,7 @@
 import {DocumentData, DocumentReference, Timestamp} from "firebase/firestore";
 import {Descendant} from "slate";
 import {emailTemplates} from "./constants";
+import {FilterObject} from "./hooks";
 
 export type Products = "institutes"|"providers"|"students"|"admin";
 
@@ -369,9 +370,24 @@ export type UserData = {
         provider: number[],
         student: number[],
     }},
-    alumniConversationUid?: string
+    alumniConversationUid?: string,
+    savedDataViewerFilters?: {
+        [cohortId: string]: {
+        [key in "cohortPlacements"|"cohortStudents"]: {
+            [viewKey: string]: DataViewerFilterView
+            }
+        }
+    }
 };
 
+export type DataViewerFilterView = {
+    title: string,
+    search?: string,
+    sort?: string,
+    filters?: FilterObject,
+    permanent?: boolean,
+}
+
 export type AnalyticsItem = {
     units?: "placements"|"weeks"|"days"|"hours",
     name?: string
@@ -798,6 +814,11 @@ export type CohortData = {
     recurringEmails?: {
         sendType?: "all"|"lastWeek",
         frequency?: "oneTime"|"weeklyMonday"|"fortnightlyMonday"
+    },
+    savedDataViewerFilters?: {
+        [key in "cohortPlacements"|"cohortStudents"]: {
+            [key: string]: DataViewerFilterView
+        }
     }
 }
 
@@ -1028,7 +1049,7 @@ export type EmailTemplateConfig = {
         description: string,
         params: string[],
         button?: {text: string, link: string},
-        type: "workflow"|"feedback"
+        type: "workflow"|"feedback"|"event"
 }
 
 
@@ -1071,10 +1092,16 @@ export type SchoolData = OrganisationAddress&{
 export type ExternalEvent = {
     name: string,
     description: string,
+    staffInformation?: string,
+    studentInformation?: string,
+    employerInformation?: string
+    designatedStaff: string,
     created: string,
     activityId?: string,
+    gatsbyBenchmarks?: string, // String array
     oId: string,
     submissionClose: string,
+    acceptingEmployers?: boolean,
     schoolId?: string,
     startDate?: string,
     endDate?: string,
@@ -1094,7 +1121,24 @@ export type ExternalEvent = {
     employers: {
         shareable?: boolean,
         filters: {[key: string]: unknown}
+    },
+    employerFeedback: {
+            files: string[],
+            forms: string[],
+            requiredFiles: {
+                fileName: string,
+                fileType: string
+            }[],
+    },
+    studentFeedback: {
+        files: string[],
+        forms: string[],
+        requiredFiles: {
+            fileName: string,
+            fileType: string
+        }[],
     }
+    completedStages: ("basicDetails"|"employerInvites"|"studentInvites"|"employerSelection"|"feedback")[]
 }&Address
 
 
@@ -1172,4 +1216,24 @@ export type Update = {
     buttonLink?: string,
     date: string,
     imageData?: boolean
+}
+
+
+
+export type ExternalEventAttendee = {
+    oId: string, 
+    eventId: string,
+    providerContactId: string,
+    status: "invited"|"providerAvailable"|"finalConfirmationSent"|"providerConfirmed"|"feedbackSent"
+    emails: {
+        [k in "invited"|"finalConfirmationSent"|"feedbackSent"]: {
+            sent: number, // If below 3, keep sending reminders.
+            reconciled: string|boolean,
+            log: {
+                [k: string]: string // emailNumber_dateTimeString : eventType
+            }
+        }
+    }
+    attended?: boolean,
+    feedback: {[key: string]: unknown}
 }