placementt-core 1.400.839 → 1.400.841

package/lib/exportTransformers.d.ts

@@ -0,0 +1,3 @@
+import { SectionDataFetcher } from "./typeDefinitions";
+export type ExportTransformerFn = (fetcher: SectionDataFetcher, value: unknown, item: Record<string, unknown>) => Promise<unknown>;
+export declare const exportTransformers: Record<string, ExportTransformerFn>;

package/lib/exportTransformers.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exportTransformers = void 0;
+exports.exportTransformers = {
+    resolveCohortName: async (fetcher, value) => {
+        var _a;
+        if (!value)
+            return value;
+        const cohort = await fetcher.getDocData(["cohorts", value]).catch(() => null);
+        return (_a = cohort === null || cohort === void 0 ? void 0 : cohort.name) !== null && _a !== void 0 ? _a : value;
+    },
+    resolveWorkflowStageName: async (fetcher, value, item) => {
+        var _a, _b, _c;
+        const cohortId = item.cohort;
+        if (!cohortId)
+            return value;
+        const cohort = await fetcher.getDocData(["cohorts", cohortId]).catch(() => null);
+        return (_c = (_b = (_a = cohort === null || cohort === void 0 ? void 0 : cohort.workflow) === null || _a === void 0 ? void 0 : _a.find(s => s.id === value)) === null || _b === void 0 ? void 0 : _b.name) !== null && _c !== void 0 ? _c : value;
+    },
+};
+//# sourceMappingURL=exportTransformers.js.map

package/lib/exportTransformers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exportTransformers.js","sourceRoot":"","sources":["../src/exportTransformers.ts"],"names":[],"mappings":";;;AAQa,QAAA,kBAAkB,GAAwC;IACnE,iBAAiB,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;;QACxC,IAAI,CAAC,KAAK;YAAE,OAAO,KAAK,CAAC;QACzB,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CAAa,CAAC,SAAS,EAAE,KAAe,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;QACpG,OAAO,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,mCAAI,KAAK,CAAC;IACjC,CAAC;IAED,wBAAwB,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;;QACrD,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAgB,CAAC;QACvC,IAAI,CAAC,QAAQ;YAAE,OAAO,KAAK,CAAC;QAC5B,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CAAa,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;QAC7F,OAAO,MAAA,MAAA,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,QAAQ,0CAAE,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC,0CAAE,IAAI,mCAAI,KAAK,CAAC;IACtE,CAAC;CACJ,CAAC"}

package/lib/hooks.d.ts

@@ -76,7 +76,7 @@ export declare function useNewInstitutePlacementList({ id, user, oId, uid, filte
         value: string;
         direction: "asc" | "desc";
     }] | undefined;
-    exportCSV: (userId: string, filename?: string) => Promise<CSVExportResponse>;
+    exportCSV: ((userId: string, filename?: string) => Promise<CSVExportResponse>) | undefined;
 };
 type AlumniPaginatorParams = {
     user?: UserData;
@@ -105,7 +105,7 @@ export declare function useAlumniPaginator({ user, alumniConvoUser, filters, vie
             direction: "asc" | "desc";
         };
     };
-    exportCSV: (userId: string, filename?: string) => Promise<CSVExportResponse>;
+    exportCSV: ((userId: string, filename?: string) => Promise<CSVExportResponse>) | undefined;
 };
 type ParentPaginatorParams = {
     user?: UserData;
@@ -134,7 +134,7 @@ export declare function useParentPaginator({ user, filters, view, school, additi
             direction: "asc" | "desc";
         };
     };
-    exportCSV: (userId: string, filename?: string) => Promise<CSVExportResponse>;
+    exportCSV: ((userId: string, filename?: string) => Promise<CSVExportResponse>) | undefined;
 };
 export declare const algoliaPlacementSearch: (data: QueryObject | null, user: UserData, query?: string, sort?: [string, {
     value: string;
@@ -179,7 +179,7 @@ export declare const algoliaProviderContactSearch: (data: QueryObject | null, us
 }], 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 }: {
+export declare function useProviderContactPaginator({ data, institute, user, event, view, initialSort, initialSearch, eventId, filters, sources, csvExport }: {
     data: QueryObject[];
     institute: InstituteData;
     event?: Partial<ExternalEvent>;
@@ -190,6 +190,7 @@ export declare function useProviderContactPaginator({ data, institute, user, eve
     initialSort?: string;
     initialSearch?: string;
     sources?: ("self" | "trust" | "hub")[];
+    csvExport?: DataViewerPaginater["csvExport"];
 }): {
     tableData: {
         [key: string]: {
@@ -214,7 +215,7 @@ export declare function useProviderContactPaginator({ data, institute, user, eve
         value: string;
         direction: "asc" | "desc";
     }] | undefined;
-    exportCSV: (userId: string, filename?: string) => Promise<CSVExportResponse>;
+    exportCSV: ((userId: string, filename?: string) => Promise<CSVExportResponse>) | undefined;
 };
 type UserPaginatorParams = {
     user: UserData;
@@ -268,7 +269,7 @@ export declare function useNewCohortUserPaginator({ user, oId, trustSchoolsIDs,
         direction: "asc" | "desc";
     }] | undefined;
     search: string | undefined;
-    exportCSV: (userId: string, filename?: string) => Promise<CSVExportResponse>;
+    exportCSV: ((userId: string, filename?: string) => Promise<CSVExportResponse>) | undefined;
 };
 export declare function useCohortUserPaginator({ user, cohort, data, search, userType, sort }: UserPaginatorParams): {
     tableData: {
@@ -849,6 +850,7 @@ export type DataViewerPaginater = {
         columns?: {
             field: string;
             header: string;
+            transform?: string;
         }[];
         filename?: string;
     };
@@ -873,6 +875,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, filename?: string) => Promise<CSVExportResponse>;
+    exportCSV: ((userId: string, filename?: string) => Promise<CSVExportResponse>) | undefined;
 };
 export {};

package/lib/hooks.js

@@ -298,7 +298,27 @@ function useNewInstitutePlacementList({ id, user, oId, uid, filters, initialSort
         }
         return [k, { ...placement, id: k }];
     };
-    const { tableData, pageUp, pageDown, setFilters, page, setView, loading, updateSearch, updateSort, sort, exportCSV } = 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" });
+    const exportCols = {
+        columns: [
+            { field: "name", header: "Employer Name" },
+            { field: "contactForename", header: "Employer Contact" },
+            { field: "startDate", header: "Start Date" },
+            { field: "endDate", header: "End Date" },
+            ...(!cohort ? [{ field: "cohort", header: "Cohort", transform: "resolveCohortName" }] : []),
+            { field: "status", header: "Workflow Stage", transform: "resolveWorkflowStageName" },
+            { field: "providerEmail", header: "Employer Email" },
+            { field: "providerPhone", header: "Employer Phone" },
+            { field: "address-line1", header: "Address One" },
+            { field: "address-line2", header: "Address Two" },
+            { field: "locality", header: "City" },
+            { field: "postal_code", header: "Postcode" },
+            { field: "country", header: "Country" },
+            { field: "studentForename", header: "Student Forename" },
+            { field: "studentSurname", header: "Student Surname" },
+            { field: "studentEmail", header: "Student Email" },
+        ]
+    };
+    const { tableData, pageUp, pageDown, setFilters, page, setView, loading, updateSearch, updateSort, sort, exportCSV } = 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", csvExport: exportCols });
     (0, react_1.useEffect)(() => {
         var _a;
         console.log("SET QUERY", user, queryConstraints, cohort);
@@ -909,7 +929,8 @@ const algoliaProviderContactSearch = async (data, user, query, sort, page, filte
     return Object.fromEntries(i);
 };
 exports.algoliaProviderContactSearch = algoliaProviderContactSearch;
-function useProviderContactPaginator({ data, institute, user, event, view, initialSort, initialSearch, eventId, filters, sources = ["self"] }) {
+function useProviderContactPaginator({ data, institute, user, event, view, initialSort, initialSearch, eventId, filters, sources = ["self"], csvExport }) {
+    var _a;
     const [query, setQuery] = (0, react_1.useState)();
     const firebaseQuery = new firebaseQuery_1.default();
     const sorts = {
@@ -973,7 +994,23 @@ 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, exportCSV } = 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" });
+    const defaultExportColumns = [
+        { field: "contactForename", header: "First Name" },
+        { field: "contactSurname", header: "Last Name" },
+        { field: "name", header: "Employer" },
+        { field: "providerEmail", header: "Email" },
+        { field: "providerPhone", header: "Phone" },
+        { field: "sector", header: "Sector" },
+        { field: "subsector", header: "Subsector" },
+        { field: "address-line1", header: "Address line 1" },
+        { field: "address-line2", header: "Address line 2" },
+        { field: "locality", header: "City" },
+        { field: "postal_code", header: "Postcode" },
+        { field: "country", header: "Country" },
+        { field: "created", header: "Created" },
+    ];
+    const mergedCsvExport = { ...csvExport, columns: (_a = csvExport === null || csvExport === void 0 ? void 0 : csvExport.columns) !== null && _a !== void 0 ? _a : defaultExportColumns };
+    const { tableData, pageUp, pageDown, setFilters, page, setView, loading, updateSearch, updateSort, sort, exportCSV } = 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", csvExport: mergedCsvExport });
     (0, react_1.useEffect)(() => {
         if (eventId && (event === null || event === void 0 ? void 0 : event.oId)) {
             console.log("Setting Query");
@@ -4019,7 +4056,7 @@ function useDataViewerPaginator({ view: initialView, sorts, queryLimit = 10, add
         }
         reset();
     };
-    const exportCSV = async (userId, filename) => {
+    const exportCSV = (csvExportConfig === null || csvExportConfig === void 0 ? void 0 : csvExportConfig.columns) ? async (userId, filename) => {
         console.log("Export Data");
         if (!fData || !Array.isArray(fData))
             throw new Error("CSV export requires QueryObject[] data.");
@@ -4034,7 +4071,7 @@ function useDataViewerPaginator({ view: initialView, sorts, queryLimit = 10, add
             filename: filename || (csvExportConfig === null || csvExportConfig === void 0 ? void 0 : csvExportConfig.filename),
         });
         return res.data;
-    };
+    } : undefined;
     return ({ ...{ tableData, pageUp, pageDown, search: searchString, setFilters: updateFilters, page: page[0], sorts, loading, sort, updateSort: updateSort, setView: updateView, updateSearch, exportCSV } });
 }
 ;