placementt-core 1.400.828 → 1.400.830

package/lib/hooks.d.ts

@@ -1,5 +1,5 @@
-import { DocumentData, QueryConstraint, QueryDocumentSnapshot, WhereFilterOp } from "firebase/firestore";
-import { AlumniConvoUser, ApplicantStage, Application, ArrowObject, CohortData, CustomFormSchema, ExternalEvent, FileItem, FlagCodes, InstituteData, OnboardingDocs, PlacementListing, Products, ProviderData, QueryObject, QueryObjectConstraint, Sorts, StudentPlacementData, UserData, UserGroupData, WorkflowStage } from "./typeDefinitions";
+import { DocumentData, QueryConstraint, QueryDocumentSnapshot } from "firebase/firestore";
+import { AlumniConvoUser, ApplicantStage, Application, ArrowObject, CohortData, CSVExportResponse, CustomFormSchema, ExternalEvent, FileItem, FilterObject, FlagCodes, InstituteData, OnboardingDocs, PlacementListing, Products, ProviderData, QueryObject, QueryObjectConstraint, Sorts, StudentPlacementData, UserData, UserGroupData, WorkflowStage } from "./typeDefinitions";
 type StudentPlacementListParams = {
     user: UserData;
     student?: UserData;
@@ -133,6 +133,12 @@ export declare function useParentPaginator({ user, filters, view, school, additi
         };
     };
 };
+export declare const algoliaPlacementSearch: (data: QueryObject | null, user: UserData, query?: string, sort?: [string, {
+    value: string;
+    direction: "asc" | "desc";
+}], page?: number, filters?: FilterObject, limit?: number, cohort?: string, inProgress?: boolean) => Promise<{
+    [k: string]: StudentPlacementData;
+}>;
 export declare function useVeryOldInstitutePlacementList({ user, cohort, queryConstraint, ql }: InstitutePlacementParams): {
     placements: {
         [key: string]: StudentPlacementData & {
@@ -164,6 +170,12 @@ export declare function useFilterTablePaginator({ data }: {
     } | undefined>>;
     page: number[];
 };
+export declare const algoliaProviderContactSearch: (data: QueryObject | null, user: UserData, query?: string, sort?: [string, {
+    value: string;
+    direction: "asc" | "desc";
+}], page?: number, filters?: FilterObject, limit?: number, cohort?: string, inProgress?: boolean) => Promise<{
+    [k: string]: StudentPlacementData;
+}>;
 export declare function useProviderContactPaginator({ data, institute, user, event, view, initialSort, initialSearch, eventId, filters, sources }: {
     data: QueryObject[];
     institute: InstituteData;
@@ -208,6 +220,12 @@ type UserPaginatorParams = {
     userType: "Staff" | "Students";
     sort?: string;
 };
+export declare const algoliaUsersSearch: (data: QueryObject | null, user: UserData, query?: string, sort?: [string, {
+    value: string;
+    direction: "asc" | "desc";
+}], page?: number, filters?: FilterObject, limit?: number, cohort?: string, userType?: string) => Promise<{
+    [k: string]: UserData;
+}>;
 type NewUserPaginatorParams = {
     user: UserData;
     cohort?: string;
@@ -794,23 +812,6 @@ export declare function useLoadApplications({ user, applicationType, listingId,
     loading: boolean;
     changeQueryConstraints: (e: QueryConstraint[]) => void;
 };
-export type FilterObject = {
-    [key: string]: {
-        label: string;
-        value?: unknown;
-        values?: {
-            [key: string | number]: string | {
-                label: string;
-                test: {
-                    k: string;
-                    e?: WhereFilterOp;
-                    v: unknown;
-                };
-            };
-        };
-        type: "dropdown" | "string" | "number";
-    };
-};
 export type DataViewerPaginater = {
     view: "list" | "table";
     queryLimit?: number;
@@ -829,6 +830,7 @@ export type DataViewerPaginater = {
     }], queryObject?: QueryObject, algoliaPage?: number, filters?: FilterObject, limit?: number) => Promise<{
         [key: string]: any;
     }>);
+    algoliaIndex?: string;
     data?: {
         [key: string]: {
             [key: string]: unknown;
@@ -838,8 +840,15 @@ export type DataViewerPaginater = {
     sorts?: Sorts;
     initialSort?: string;
     initialSearch?: string;
+    csvExport?: {
+        columns?: {
+            field: string;
+            header: string;
+        }[];
+        filename?: string;
+    };
 };
-export declare function useDataViewerPaginator({ view: initialView, sorts, queryLimit, additionalEntryProcessing, formatItems, snapshot, filters: initialFilters, initialSort, initialSearch, onSearch, data }: DataViewerPaginater): {
+export declare function useDataViewerPaginator({ view: initialView, sorts, queryLimit, additionalEntryProcessing, formatItems, snapshot, filters: initialFilters, initialSort, initialSearch, onSearch, algoliaIndex, data, csvExport: csvExportConfig }: DataViewerPaginater): {
     tableData: {
         [key: string]: {
             [key: string]: unknown;
@@ -859,5 +868,6 @@ export declare function useDataViewerPaginator({ view: initialView, sorts, query
     updateSort: (sortLabel?: string) => void;
     setView: (v: "list" | "table") => void;
     updateSearch: (search: string) => void;
+    exportCSV: (userId: string) => Promise<CSVExportResponse>;
 };
 export {};

package/lib/hooks.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useRefDimensions = void 0;
+exports.useRefDimensions = exports.algoliaUsersSearch = exports.algoliaProviderContactSearch = exports.algoliaPlacementSearch = void 0;
 exports.useStudentPlacementList = useStudentPlacementList;
 exports.useOldInstitutePlacementList = useOldInstitutePlacementList;
 exports.useNewInstitutePlacementList = useNewInstitutePlacementList;
@@ -298,7 +298,7 @@ function useNewInstitutePlacementList({ id, user, oId, uid, filters, initialSort
         }
         return [k, { ...placement, id: k }];
     };
-    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, data, page, filters, limit) => await algoliaPlacementSearch(data || null, 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, data, page, filters, limit) => await (0, exports.algoliaPlacementSearch)(data || null, user, s, sort, page, filters, limit, cohort, inProgress), algoliaIndex: "placements" });
     (0, react_1.useEffect)(() => {
         var _a;
         console.log("SET QUERY", user, queryConstraints, cohort);
@@ -510,6 +510,7 @@ const algoliaPlacementSearch = async (data, user, query, sort, page, filters, li
     }))) : []).filter((e) => e !== undefined);
     return Object.fromEntries(i);
 };
+exports.algoliaPlacementSearch = algoliaPlacementSearch;
 function useVeryOldInstitutePlacementList({ user, cohort, queryConstraint, ql = DEFAULTQUERYLIMIT }) {
     const [loadMoreIcon, setLoadMoreIcon] = (0, react_1.useState)(true);
     const [query, setQuery] = (0, react_1.useState)("");
@@ -907,6 +908,7 @@ const algoliaProviderContactSearch = async (data, user, query, sort, page, filte
     }))) : []).filter((e) => e !== undefined);
     return Object.fromEntries(i);
 };
+exports.algoliaProviderContactSearch = algoliaProviderContactSearch;
 function useProviderContactPaginator({ data, institute, user, event, view, initialSort, initialSearch, eventId, filters, sources = ["self"] }) {
     const [query, setQuery] = (0, react_1.useState)();
     const firebaseQuery = new firebaseQuery_1.default();
@@ -971,7 +973,7 @@ function useProviderContactPaginator({ data, institute, user, event, view, initi
         return [k, v];
     };
     console.log("Query", JSON.stringify(query));
-    const { tableData, pageUp, pageDown, setFilters, page, setView, loading, updateSearch, updateSort, sort } = useDataViewerPaginator({ view, filters, sorts, queryLimit: 10, data: query, initialSearch, initialSort, additionalEntryProcessing: getAdditionalData, onSearch: async (s, sort, data, page, filters, limit) => await algoliaProviderContactSearch(data !== null && data !== void 0 ? data : null, user, s, sort, page, filters, limit) });
+    const { tableData, pageUp, pageDown, setFilters, page, setView, loading, updateSearch, updateSort, sort } = useDataViewerPaginator({ view, filters, sorts, queryLimit: 10, data: query, initialSearch, initialSort, additionalEntryProcessing: getAdditionalData, onSearch: async (s, sort, data, page, filters, limit) => await (0, exports.algoliaProviderContactSearch)(data !== null && data !== void 0 ? data : null, user, s, sort, page, filters, limit), algoliaIndex: "providerContacts" });
     (0, react_1.useEffect)(() => {
         if (eventId && (event === null || event === void 0 ? void 0 : event.oId)) {
             console.log("Setting Query");
@@ -1094,6 +1096,7 @@ const algoliaUsersSearch = async (data, user, query, sort, page, filters, limit,
     }))) : []).filter((e) => e !== undefined);
     return Object.fromEntries(i);
 };
+exports.algoliaUsersSearch = algoliaUsersSearch;
 function useNewCohortUserPaginator({ user, oId, trustSchoolsIDs, institute, initialSort, filters, view, cohort, queryConstraints, ql = DEFAULTQUERYLIMIT, userType }) {
     const [query, setQuery] = (0, react_1.useState)();
     const firebaseQuery = new firebaseQuery_1.default();
@@ -1241,7 +1244,7 @@ function useNewCohortUserPaginator({ user, oId, trustSchoolsIDs, institute, init
         getAccess();
     }, [user, queryConstraints, cohort]);
     console.log("Query", query);
-    const { tableData, pageUp, pageDown, setFilters, page, setView, loading, updateSearch, updateSort, search, sort } = useDataViewerPaginator({ view, filters, initialSort, sorts, queryLimit: ql, data: query, onSearch: async (s, sort, data, page, filters, limit) => await algoliaUsersSearch(data !== null && data !== void 0 ? data : null, user, s, sort, page, filters, limit, cohort, userType) });
+    const { tableData, pageUp, pageDown, setFilters, page, setView, loading, updateSearch, updateSort, search, sort } = useDataViewerPaginator({ view, filters, initialSort, sorts, queryLimit: ql, data: query, onSearch: async (s, sort, data, page, filters, limit) => await (0, exports.algoliaUsersSearch)(data !== null && data !== void 0 ? data : null, user, s, sort, page, filters, limit, cohort, userType), algoliaIndex: "users" });
     return { tableData, page, loading, updateSearch, setFilters, setView, pageUp, pageDown, sorts, updateSort, sort, search };
 }
 function useCohortUserPaginator({ user, cohort, data, search, userType, sort }) {
@@ -3642,7 +3645,7 @@ function useLoadApplications({ user, applicationType, listingId, queryConstraint
     };
     return { applications, type, setType, onScrollBottom, loading, changeQueryConstraints };
 }
-function useDataViewerPaginator({ view: initialView, sorts, queryLimit = 10, additionalEntryProcessing, formatItems, snapshot, filters: initialFilters, initialSort, initialSearch, onSearch, data }) {
+function useDataViewerPaginator({ view: initialView, sorts, queryLimit = 10, additionalEntryProcessing, formatItems, snapshot, filters: initialFilters, initialSort, initialSearch, onSearch, algoliaIndex, data, csvExport: csvExportConfig }) {
     const [tableData, setTableData] = (0, react_1.useState)(data ? Array.isArray(data) ? {} : Object.fromEntries(Object.entries(data).slice(0, queryLimit)) : undefined);
     const [page, setPage] = (0, react_1.useState)([1, 0]);
     const [view, setView] = (0, react_1.useState)(initialView);
@@ -4016,7 +4019,22 @@ function useDataViewerPaginator({ view: initialView, sorts, queryLimit = 10, add
         }
         reset();
     };
-    return ({ ...{ tableData, pageUp, pageDown, search: searchString, setFilters: updateFilters, page: page[0], sorts, loading, sort, updateSort: updateSort, setView: updateView, updateSearch } });
+    const exportCSV = async (userId) => {
+        if (!fData || !Array.isArray(fData))
+            throw new Error("CSV export requires QueryObject[] data.");
+        const res = await (0, firebase_1.executeCallable)("exportData", {
+            userId,
+            queries: fData,
+            filters,
+            sort,
+            searchString,
+            algoliaIndex,
+            columns: csvExportConfig === null || csvExportConfig === void 0 ? void 0 : csvExportConfig.columns,
+            filename: csvExportConfig === null || csvExportConfig === void 0 ? void 0 : csvExportConfig.filename,
+        });
+        return res.data;
+    };
+    return ({ ...{ tableData, pageUp, pageDown, search: searchString, setFilters: updateFilters, page: page[0], sorts, loading, sort, updateSort: updateSort, setView: updateView, updateSearch, exportCSV } });
 }
 ;
 //# sourceMappingURL=hooks.js.map