placementt-core 1.400.1186 → 1.400.1188

package/lib/callables/outreach.d.ts

@@ -172,9 +172,9 @@ export declare const outreachCallables: {
                 assignee: string;
                 events?: boolean | undefined;
                 wex?: boolean | undefined;
-                docCheck?: boolean | undefined;
                 forename?: string | undefined;
                 surname?: string | undefined;
+                docCheck?: boolean | undefined;
                 personalNotes?: any[] | undefined;
                 generalNotes?: any[] | undefined;
             }, {
@@ -183,9 +183,9 @@ export declare const outreachCallables: {
                 assignee: string;
                 events?: boolean | undefined;
                 wex?: boolean | undefined;
-                docCheck?: boolean | undefined;
                 forename?: string | undefined;
                 surname?: string | undefined;
+                docCheck?: boolean | undefined;
                 personalNotes?: any[] | undefined;
                 generalNotes?: any[] | undefined;
             }>;
@@ -196,9 +196,9 @@ export declare const outreachCallables: {
                 assignee: string;
                 events?: boolean | undefined;
                 wex?: boolean | undefined;
-                docCheck?: boolean | undefined;
                 forename?: string | undefined;
                 surname?: string | undefined;
+                docCheck?: boolean | undefined;
                 personalNotes?: any[] | undefined;
                 generalNotes?: any[] | undefined;
             };
@@ -210,9 +210,9 @@ export declare const outreachCallables: {
                 assignee: string;
                 events?: boolean | undefined;
                 wex?: boolean | undefined;
-                docCheck?: boolean | undefined;
                 forename?: string | undefined;
                 surname?: string | undefined;
+                docCheck?: boolean | undefined;
                 personalNotes?: any[] | undefined;
                 generalNotes?: any[] | undefined;
             };

package/lib/callables/registry.d.ts

@@ -409,9 +409,9 @@ export declare const allCallables: {
                 assignee: string;
                 events?: boolean | undefined;
                 wex?: boolean | undefined;
-                docCheck?: boolean | undefined;
                 forename?: string | undefined;
                 surname?: string | undefined;
+                docCheck?: boolean | undefined;
                 personalNotes?: any[] | undefined;
                 generalNotes?: any[] | undefined;
             }, {
@@ -420,9 +420,9 @@ export declare const allCallables: {
                 assignee: string;
                 events?: boolean | undefined;
                 wex?: boolean | undefined;
-                docCheck?: boolean | undefined;
                 forename?: string | undefined;
                 surname?: string | undefined;
+                docCheck?: boolean | undefined;
                 personalNotes?: any[] | undefined;
                 generalNotes?: any[] | undefined;
             }>;
@@ -433,9 +433,9 @@ export declare const allCallables: {
                 assignee: string;
                 events?: boolean | undefined;
                 wex?: boolean | undefined;
-                docCheck?: boolean | undefined;
                 forename?: string | undefined;
                 surname?: string | undefined;
+                docCheck?: boolean | undefined;
                 personalNotes?: any[] | undefined;
                 generalNotes?: any[] | undefined;
             };
@@ -447,9 +447,9 @@ export declare const allCallables: {
                 assignee: string;
                 events?: boolean | undefined;
                 wex?: boolean | undefined;
-                docCheck?: boolean | undefined;
                 forename?: string | undefined;
                 surname?: string | undefined;
+                docCheck?: boolean | undefined;
                 personalNotes?: any[] | undefined;
                 generalNotes?: any[] | undefined;
             };
@@ -890,10 +890,10 @@ export declare const allCallables: {
                     enrolmentStatus: string | null;
                 }>, "many">;
             }, "strip", z.ZodTypeAny, {
-                upn: string | null;
-                matchedOn: "upn" | "nameDob";
                 forename: string;
                 surname: string;
+                upn: string | null;
+                matchedOn: "upn" | "nameDob";
                 dateOfBirth: string | null;
                 enrolments: {
                     email: string | null;
@@ -906,10 +906,10 @@ export declare const allCallables: {
                     enrolmentStatus: string | null;
                 }[];
             }, {
-                upn: string | null;
-                matchedOn: "upn" | "nameDob";
                 forename: string;
                 surname: string;
+                upn: string | null;
+                matchedOn: "upn" | "nameDob";
                 dateOfBirth: string | null;
                 enrolments: {
                     email: string | null;
@@ -936,9 +936,9 @@ export declare const allCallables: {
             }, "strip", z.ZodTypeAny, {
                 year: string | null;
                 oId: string;
-                schoolName: string;
                 forename: string;
                 surname: string;
+                schoolName: string;
                 dateOfBirth: string | null;
                 wondeId: string;
                 formGroup: string | null;
@@ -947,9 +947,9 @@ export declare const allCallables: {
             }, {
                 year: string | null;
                 oId: string;
-                schoolName: string;
                 forename: string;
                 surname: string;
+                schoolName: string;
                 dateOfBirth: string | null;
                 wondeId: string;
                 formGroup: string | null;
@@ -963,10 +963,10 @@ export declare const allCallables: {
                 oId: string;
             }[];
             matches: {
-                upn: string | null;
-                matchedOn: "upn" | "nameDob";
                 forename: string;
                 surname: string;
+                upn: string | null;
+                matchedOn: "upn" | "nameDob";
                 dateOfBirth: string | null;
                 enrolments: {
                     email: string | null;
@@ -993,9 +993,9 @@ export declare const allCallables: {
             dualStatus: {
                 year: string | null;
                 oId: string;
-                schoolName: string;
                 forename: string;
                 surname: string;
+                schoolName: string;
                 dateOfBirth: string | null;
                 wondeId: string;
                 formGroup: string | null;
@@ -1009,10 +1009,10 @@ export declare const allCallables: {
                 oId: string;
             }[];
             matches: {
-                upn: string | null;
-                matchedOn: "upn" | "nameDob";
                 forename: string;
                 surname: string;
+                upn: string | null;
+                matchedOn: "upn" | "nameDob";
                 dateOfBirth: string | null;
                 enrolments: {
                     email: string | null;
@@ -1039,9 +1039,9 @@ export declare const allCallables: {
             dualStatus: {
                 year: string | null;
                 oId: string;
-                schoolName: string;
                 forename: string;
                 surname: string;
+                schoolName: string;
                 dateOfBirth: string | null;
                 wondeId: string;
                 formGroup: string | null;
@@ -4407,10 +4407,10 @@ export declare const callableGroups: {
                         enrolmentStatus: string | null;
                     }>, "many">;
                 }, "strip", z.ZodTypeAny, {
-                    upn: string | null;
-                    matchedOn: "upn" | "nameDob";
                     forename: string;
                     surname: string;
+                    upn: string | null;
+                    matchedOn: "upn" | "nameDob";
                     dateOfBirth: string | null;
                     enrolments: {
                         email: string | null;
@@ -4423,10 +4423,10 @@ export declare const callableGroups: {
                         enrolmentStatus: string | null;
                     }[];
                 }, {
-                    upn: string | null;
-                    matchedOn: "upn" | "nameDob";
                     forename: string;
                     surname: string;
+                    upn: string | null;
+                    matchedOn: "upn" | "nameDob";
                     dateOfBirth: string | null;
                     enrolments: {
                         email: string | null;
@@ -4453,9 +4453,9 @@ export declare const callableGroups: {
                 }, "strip", z.ZodTypeAny, {
                     year: string | null;
                     oId: string;
-                    schoolName: string;
                     forename: string;
                     surname: string;
+                    schoolName: string;
                     dateOfBirth: string | null;
                     wondeId: string;
                     formGroup: string | null;
@@ -4464,9 +4464,9 @@ export declare const callableGroups: {
                 }, {
                     year: string | null;
                     oId: string;
-                    schoolName: string;
                     forename: string;
                     surname: string;
+                    schoolName: string;
                     dateOfBirth: string | null;
                     wondeId: string;
                     formGroup: string | null;
@@ -4480,10 +4480,10 @@ export declare const callableGroups: {
                     oId: string;
                 }[];
                 matches: {
-                    upn: string | null;
-                    matchedOn: "upn" | "nameDob";
                     forename: string;
                     surname: string;
+                    upn: string | null;
+                    matchedOn: "upn" | "nameDob";
                     dateOfBirth: string | null;
                     enrolments: {
                         email: string | null;
@@ -4510,9 +4510,9 @@ export declare const callableGroups: {
                 dualStatus: {
                     year: string | null;
                     oId: string;
-                    schoolName: string;
                     forename: string;
                     surname: string;
+                    schoolName: string;
                     dateOfBirth: string | null;
                     wondeId: string;
                     formGroup: string | null;
@@ -4526,10 +4526,10 @@ export declare const callableGroups: {
                     oId: string;
                 }[];
                 matches: {
-                    upn: string | null;
-                    matchedOn: "upn" | "nameDob";
                     forename: string;
                     surname: string;
+                    upn: string | null;
+                    matchedOn: "upn" | "nameDob";
                     dateOfBirth: string | null;
                     enrolments: {
                         email: string | null;
@@ -4556,9 +4556,9 @@ export declare const callableGroups: {
                 dualStatus: {
                     year: string | null;
                     oId: string;
-                    schoolName: string;
                     forename: string;
                     surname: string;
+                    schoolName: string;
                     dateOfBirth: string | null;
                     wondeId: string;
                     formGroup: string | null;
@@ -4915,9 +4915,9 @@ export declare const callableGroups: {
                     assignee: string;
                     events?: boolean | undefined;
                     wex?: boolean | undefined;
-                    docCheck?: boolean | undefined;
                     forename?: string | undefined;
                     surname?: string | undefined;
+                    docCheck?: boolean | undefined;
                     personalNotes?: any[] | undefined;
                     generalNotes?: any[] | undefined;
                 }, {
@@ -4926,9 +4926,9 @@ export declare const callableGroups: {
                     assignee: string;
                     events?: boolean | undefined;
                     wex?: boolean | undefined;
-                    docCheck?: boolean | undefined;
                     forename?: string | undefined;
                     surname?: string | undefined;
+                    docCheck?: boolean | undefined;
                     personalNotes?: any[] | undefined;
                     generalNotes?: any[] | undefined;
                 }>;
@@ -4939,9 +4939,9 @@ export declare const callableGroups: {
                     assignee: string;
                     events?: boolean | undefined;
                     wex?: boolean | undefined;
-                    docCheck?: boolean | undefined;
                     forename?: string | undefined;
                     surname?: string | undefined;
+                    docCheck?: boolean | undefined;
                     personalNotes?: any[] | undefined;
                     generalNotes?: any[] | undefined;
                 };
@@ -4953,9 +4953,9 @@ export declare const callableGroups: {
                     assignee: string;
                     events?: boolean | undefined;
                     wex?: boolean | undefined;
-                    docCheck?: boolean | undefined;
                     forename?: string | undefined;
                     surname?: string | undefined;
+                    docCheck?: boolean | undefined;
                     personalNotes?: any[] | undefined;
                     generalNotes?: any[] | undefined;
                 };

package/lib/callables/wonde.d.ts

@@ -132,10 +132,10 @@ export declare const wondeCallables: {
                     enrolmentStatus: string | null;
                 }>, "many">;
             }, "strip", z.ZodTypeAny, {
-                upn: string | null;
-                matchedOn: "upn" | "nameDob";
                 forename: string;
                 surname: string;
+                upn: string | null;
+                matchedOn: "upn" | "nameDob";
                 dateOfBirth: string | null;
                 enrolments: {
                     email: string | null;
@@ -148,10 +148,10 @@ export declare const wondeCallables: {
                     enrolmentStatus: string | null;
                 }[];
             }, {
-                upn: string | null;
-                matchedOn: "upn" | "nameDob";
                 forename: string;
                 surname: string;
+                upn: string | null;
+                matchedOn: "upn" | "nameDob";
                 dateOfBirth: string | null;
                 enrolments: {
                     email: string | null;
@@ -180,9 +180,9 @@ export declare const wondeCallables: {
             }, "strip", z.ZodTypeAny, {
                 year: string | null;
                 oId: string;
-                schoolName: string;
                 forename: string;
                 surname: string;
+                schoolName: string;
                 dateOfBirth: string | null;
                 wondeId: string;
                 formGroup: string | null;
@@ -191,9 +191,9 @@ export declare const wondeCallables: {
             }, {
                 year: string | null;
                 oId: string;
-                schoolName: string;
                 forename: string;
                 surname: string;
+                schoolName: string;
                 dateOfBirth: string | null;
                 wondeId: string;
                 formGroup: string | null;
@@ -207,10 +207,10 @@ export declare const wondeCallables: {
                 oId: string;
             }[];
             matches: {
-                upn: string | null;
-                matchedOn: "upn" | "nameDob";
                 forename: string;
                 surname: string;
+                upn: string | null;
+                matchedOn: "upn" | "nameDob";
                 dateOfBirth: string | null;
                 enrolments: {
                     email: string | null;
@@ -237,9 +237,9 @@ export declare const wondeCallables: {
             dualStatus: {
                 year: string | null;
                 oId: string;
-                schoolName: string;
                 forename: string;
                 surname: string;
+                schoolName: string;
                 dateOfBirth: string | null;
                 wondeId: string;
                 formGroup: string | null;
@@ -253,10 +253,10 @@ export declare const wondeCallables: {
                 oId: string;
             }[];
             matches: {
-                upn: string | null;
-                matchedOn: "upn" | "nameDob";
                 forename: string;
                 surname: string;
+                upn: string | null;
+                matchedOn: "upn" | "nameDob";
                 dateOfBirth: string | null;
                 enrolments: {
                     email: string | null;
@@ -283,9 +283,9 @@ export declare const wondeCallables: {
             dualStatus: {
                 year: string | null;
                 oId: string;
-                schoolName: string;
                 forename: string;
                 surname: string;
+                schoolName: string;
                 dateOfBirth: string | null;
                 wondeId: string;
                 formGroup: string | null;

package/lib/index.d.ts

@@ -41,6 +41,7 @@ export * from "./compassGuidanceExport";
 export * from "./destinations";
 export * from "./benchmarkEvidenceRules";
 export * from "./benchmarkAggregate";
+export * from "./kcsie";
 export * from "./portfolioAggregate";
 export * from "./tutorialTips";
 export * from "./constants";

package/lib/index.js

@@ -61,6 +61,7 @@ __exportStar(require("./compassGuidanceExport"), exports);
 __exportStar(require("./destinations"), exports);
 __exportStar(require("./benchmarkEvidenceRules"), exports);
 __exportStar(require("./benchmarkAggregate"), exports);
+__exportStar(require("./kcsie"), exports);
 __exportStar(require("./portfolioAggregate"), exports);
 __exportStar(require("./tutorialTips"), exports);
 __exportStar(require("./constants"), exports);

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AACA,sDAAoC;AACpC,gEAA8C;AAC9C,0DAAwC;AACxC,2DAAyC;AACzC,kDAAgC;AAChC,uDAAqC;AACrC,4DAA0C;AAC1C,2DAAyC;AAEzC,oDAAkC;AAClC,8CAA4B;AAC5B,kDAAgC;AAChC,kDAAgC;AAChC,qDAAmC;AACnC,mDAAiC;AACjC,qDAAmC;AACnC,qDAAmC;AACnC,sDAAoC;AACpC,kDAAgC;AAChC,mDAAiC;AACjC,+CAA6B;AAC7B,oDAAkC;AAClC,iDAA+B;AAC/B,qDAAmC;AACnC,uDAAqC;AACrC,gDAA8B;AAC9B,4CAA0B;AAC1B,wCAAsB;AACtB,kDAAgC;AAChC,6CAA2B;AAC3B,8CAA4B;AAC5B,oDAAkC;AAClC,4CAA0B;AAC1B,8CAA4B;AAC5B,2CAAyB;AACzB,wDAAsC;AACtC,kDAAgC;AAChC,uDAAqC;AACrC,oDAAkC;AAClC,kDAAgC;AAChC,0DAAwC;AACxC,iDAA+B;AAC/B,2DAAyC;AACzC,uDAAqC;AACrC,uDAAqC;AACrC,iDAA+B;AAC/B,8CAA4B;AAC5B,4CAA0B;AAC1B,qDAAmC;AACnC,0CAAwB;AACxB,kDAAgC;AAChC,yCAAuB;AACvB,4DAA0C;AAC1C,kDAAgC;AAChC,iDAA+B;AAC/B,2CAAyB;AACzB,4DAA0C;AAC1C,oEAAiD;AACjD,yEAAuD;AACvD,kEAAgD;AAChD,kEAAgD;AAChD,oEAAkD;AAClD,yGAAuF;AACvF,0GAAwF;AACxF,+FAA6E;AAC7E,4DAA0C;AAC1C,oEAAkD;AAClD,iEAA+C;AAC/C,gEAA8C;AAC9C,2EAAyD;AACzD,6CAA2B;AAC3B,+CAA6B;AAC7B,8CAA4B;AAC5B,4CAA0B;AAC1B,6DAAuE;AAA9D,2IAAA,OAAO,OAAuB;AACvC,mDAAiC;AACjC,mDAAiC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AACA,sDAAoC;AACpC,gEAA8C;AAC9C,0DAAwC;AACxC,2DAAyC;AACzC,kDAAgC;AAChC,uDAAqC;AACrC,4DAA0C;AAC1C,2DAAyC;AAEzC,oDAAkC;AAClC,8CAA4B;AAC5B,kDAAgC;AAChC,kDAAgC;AAChC,qDAAmC;AACnC,mDAAiC;AACjC,qDAAmC;AACnC,qDAAmC;AACnC,sDAAoC;AACpC,kDAAgC;AAChC,mDAAiC;AACjC,+CAA6B;AAC7B,oDAAkC;AAClC,iDAA+B;AAC/B,qDAAmC;AACnC,uDAAqC;AACrC,gDAA8B;AAC9B,4CAA0B;AAC1B,wCAAsB;AACtB,kDAAgC;AAChC,6CAA2B;AAC3B,8CAA4B;AAC5B,oDAAkC;AAClC,4CAA0B;AAC1B,8CAA4B;AAC5B,2CAAyB;AACzB,wDAAsC;AACtC,kDAAgC;AAChC,uDAAqC;AACrC,oDAAkC;AAClC,kDAAgC;AAChC,0DAAwC;AACxC,iDAA+B;AAC/B,2DAAyC;AACzC,uDAAqC;AACrC,0CAAwB;AACxB,uDAAqC;AACrC,iDAA+B;AAC/B,8CAA4B;AAC5B,4CAA0B;AAC1B,qDAAmC;AACnC,0CAAwB;AACxB,kDAAgC;AAChC,yCAAuB;AACvB,4DAA0C;AAC1C,kDAAgC;AAChC,iDAA+B;AAC/B,2CAAyB;AACzB,4DAA0C;AAC1C,oEAAiD;AACjD,yEAAuD;AACvD,kEAAgD;AAChD,kEAAgD;AAChD,oEAAkD;AAClD,yGAAuF;AACvF,0GAAwF;AACxF,+FAA6E;AAC7E,4DAA0C;AAC1C,oEAAkD;AAClD,iEAA+C;AAC/C,gEAA8C;AAC9C,2EAAyD;AACzD,6CAA2B;AAC3B,+CAA6B;AAC7B,8CAA4B;AAC5B,4CAA0B;AAC1B,6DAAuE;AAA9D,2IAAA,OAAO,OAAuB;AACvC,mDAAiC;AACjC,mDAAiC"}

package/lib/kcsie.d.ts

@@ -0,0 +1,38 @@
+import { PlacementQuestions, StudentPlacementData, WorkflowStage } from "./typeDefinitions";
+type KcsiePerson = NonNullable<StudentPlacementData["kcsiePeople"]>[string];
+export declare const KCSIE_BARRED_LIST_URL = "https://check-the-childrens-barred-list.education.gov.uk/";
+export declare const KCSIE_STATUS_LABELS: Record<NonNullable<StudentPlacementData["kcsie"]>, string>;
+export declare const KCSIE_NOT_REQUESTED: Pick<StudentPlacementData, "kcsie" | "kcsieStatuses">;
+export declare const kcsiePersonId: ({ surname, dob }: Pick<KcsiePerson, "surname" | "dob">) => string;
+export declare const kcsieCheckedOverAYearAgo: (person: Pick<KcsiePerson, "status" | "reviewed">, now?: Date) => boolean;
+export declare const kcsiePeopleDetails: (people?: StudentPlacementData["kcsiePeople"]) => NonNullable<PlacementQuestions["kcsie"]>["people"];
+export declare const matchingKcsiePeople: (previous: NonNullable<PlacementQuestions["kcsie"]>["people"], surname: string) => NonNullable<PlacementQuestions["kcsie"]>["people"];
+export declare const kcsieOutstanding: (status?: StudentPlacementData["kcsie"]) => boolean;
+export declare const workflowRequiresKcsie: (workflow?: WorkflowStage[]) => boolean;
+export declare const placementKcsieFields: (people: NonNullable<StudentPlacementData["kcsiePeople"]>) => Pick<StudentPlacementData, "kcsie" | "kcsieStatuses">;
+export declare const kcsieRowsForPlacement: (placementId: string, placement: StudentPlacementData, status?: StudentPlacementData["kcsie"]) => ({
+    placementId: string;
+    providerContactId: string | undefined;
+    studentForename: string | undefined;
+    studentSurname: string | undefined;
+    employerName: string;
+    startDate: string;
+    endDate: string;
+} & {
+    status: StudentPlacementData["kcsie"];
+    personId?: string;
+    person?: KcsiePerson;
+})[];
+export declare const reviewKcsiePerson: ({ oId, providerContactId, personId, dob, previousSurnames, status, note, reviewedBy, reviewedByName }: {
+    oId: string;
+    providerContactId: string;
+    personId: string;
+    dob: string;
+    previousSurnames?: string[];
+    status: KcsiePerson["status"];
+    note?: string;
+    reviewedBy: string;
+    reviewedByName: string;
+}) => Promise<void>;
+export declare const getKcsieCohortCounts: (oId: string, cohortId: string) => Promise<Record<string, number>>;
+export {};

package/lib/kcsie.js

@@ -0,0 +1,80 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getKcsieCohortCounts = exports.reviewKcsiePerson = exports.kcsieRowsForPlacement = exports.placementKcsieFields = exports.workflowRequiresKcsie = exports.kcsieOutstanding = exports.matchingKcsiePeople = exports.kcsiePeopleDetails = exports.kcsieCheckedOverAYearAgo = exports.kcsiePersonId = exports.KCSIE_NOT_REQUESTED = exports.KCSIE_STATUS_LABELS = exports.KCSIE_BARRED_LIST_URL = void 0;
+const firestore_1 = require("firebase/firestore");
+const firebaseQuery_1 = __importDefault(require("./firebase/firebaseQuery"));
+const firebaseQuery = new firebaseQuery_1.default();
+exports.KCSIE_BARRED_LIST_URL = "https://check-the-childrens-barred-list.education.gov.uk/";
+exports.KCSIE_STATUS_LABELS = {
+    pending: "Awaiting check",
+    approved: "Approved",
+    flagged: "Flagged",
+    rejected: "Rejected",
+    notRequired: "Not required",
+    notRequested: "Not yet requested",
+};
+exports.KCSIE_NOT_REQUESTED = { kcsie: "notRequested", kcsieStatuses: ["notRequested"] };
+// Surname and DOB are what the DfE search uses, so they identify a person across placements.
+const kcsiePersonId = ({ surname, dob }) => `${surname.trim().toLowerCase().replace(/[^a-z]/g, "")}_${dob}`;
+exports.kcsiePersonId = kcsiePersonId;
+// Outcomes carry over indefinitely; the school is just told when one is over a year old.
+const kcsieCheckedOverAYearAgo = (person, now = new Date()) => person.status !== "pending" && Boolean(person.reviewed) && now.getTime() - new Date(person.reviewed).getTime() > 365 * 24 * 60 * 60 * 1000;
+exports.kcsieCheckedOverAYearAgo = kcsieCheckedOverAYearAgo;
+// Just the details the employer enters, e.g. to import people from another placement.
+const kcsiePeopleDetails = (people) => Object.values(people || {}).map(({ forename, surname, dob, previousSurnames }) => ({ forename, surname, dob, ...(previousSurnames?.length ? { previousSurnames } : {}) }));
+exports.kcsiePeopleDetails = kcsiePeopleDetails;
+// Previous individuals whose surname starts with what's been typed, for the employer to pick from.
+const matchingKcsiePeople = (previous, surname) => {
+    const typed = surname.trim().toLowerCase();
+    return typed.length < 2 ? [] : previous.filter((p) => p.surname.toLowerCase().startsWith(typed));
+};
+exports.matchingKcsiePeople = matchingKcsiePeople;
+const kcsieOutstanding = (status) => status === "pending" || status === "flagged" || status === "rejected";
+exports.kcsieOutstanding = kcsieOutstanding;
+const workflowRequiresKcsie = (workflow) => Boolean(workflow?.some((s) => s.kcsie && s.userType === "Provider"));
+exports.workflowRequiresKcsie = workflowRequiresKcsie;
+// The worst person's status wins, so one rejection holds the placement.
+const placementKcsieFields = (people) => {
+    const statuses = Object.values(people).map((p) => p.status);
+    const kcsie = statuses.length ? ["rejected", "flagged", "pending", "approved"].find((s) => statuses.includes(s)) : "notRequired";
+    return { kcsie, kcsieStatuses: [...new Set(statuses)] };
+};
+exports.placementKcsieFields = placementKcsieFields;
+// One row per person, so a placement naming two people appears twice.
+const kcsieRowsForPlacement = (placementId, placement, status) => {
+    const base = { placementId, providerContactId: placement.providerContactId, studentForename: placement.studentForename, studentSurname: placement.studentSurname, employerName: placement.name, startDate: placement.startDate, endDate: placement.endDate };
+    const rows = placement.kcsie === "notRequested" ?
+        [{ ...base, status: "notRequested" }] :
+        Object.entries(placement.kcsiePeople || {}).map(([personId, person]) => ({ ...base, status: person.status, personId, person }));
+    return status ? rows.filter((r) => r.status === status) : rows;
+};
+exports.kcsieRowsForPlacement = kcsieRowsForPlacement;
+// Applies the outcome to every placement at the school with this employer naming the person, and saves it on the employer for future placements.
+const reviewKcsiePerson = async ({ oId, providerContactId, personId, dob, previousSurnames, status, note, reviewedBy, reviewedByName }) => {
+    const now = new Date();
+    const outcome = { status, reviewed: now.toISOString(), reviewedBy, reviewedByName, ...(note?.trim() ? { note: note.trim() } : {}) };
+    await firebaseQuery.update(["providerContacts", providerContactId], { [`savedBy.${oId}.kcsie.${personId}`]: { ...outcome, ...(previousSurnames?.length ? { previousSurnames } : {}) } });
+    const placements = await firebaseQuery.getDocsWhere(["placements"], [
+        (0, firestore_1.where)("oId", "==", oId),
+        (0, firestore_1.where)("providerContactId", "==", providerContactId),
+        (0, firestore_1.where)(`kcsiePeople.${personId}.dob`, "==", dob),
+    ]);
+    await Promise.all(Object.entries(placements).map(([id, placement]) => {
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        const { note: _, ...person } = placement.kcsiePeople?.[personId];
+        const updated = { ...person, ...outcome };
+        return firebaseQuery.update(["placements", id], { [`kcsiePeople.${personId}`]: updated, ...(0, exports.placementKcsieFields)({ ...placement.kcsiePeople, [personId]: updated }) });
+    }));
+};
+exports.reviewKcsiePerson = reviewKcsiePerson;
+// Placement counts, since a placement can have people at more than one status.
+const getKcsieCohortCounts = async (oId, cohortId) => {
+    const statuses = ["pending", "flagged", "rejected", "approved", "notRequested"];
+    const counts = await Promise.all(statuses.map((s) => firebaseQuery.getCount(["placements"], [(0, firestore_1.where)("oId", "==", oId), (0, firestore_1.where)("cohort", "==", cohortId), (0, firestore_1.where)("kcsieStatuses", "array-contains", s)])));
+    return Object.fromEntries(statuses.map((s, i) => [s, counts[i]]));
+};
+exports.getKcsieCohortCounts = getKcsieCohortCounts;
+//# sourceMappingURL=kcsie.js.map

package/lib/kcsie.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"kcsie.js","sourceRoot":"","sources":["../src/kcsie.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAyC;AACzC,6EAAqD;AAGrD,MAAM,aAAa,GAAG,IAAI,uBAAa,EAAE,CAAC;AAI7B,QAAA,qBAAqB,GAAG,2DAA2D,CAAC;AAEpF,QAAA,mBAAmB,GAA+D;IAC3F,OAAO,EAAE,gBAAgB;IACzB,QAAQ,EAAE,UAAU;IACpB,OAAO,EAAE,SAAS;IAClB,QAAQ,EAAE,UAAU;IACpB,WAAW,EAAE,cAAc;IAC3B,YAAY,EAAE,mBAAmB;CACpC,CAAC;AAEW,QAAA,mBAAmB,GAAwD,EAAC,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,CAAC,cAAc,CAAC,EAAC,CAAC;AAEjJ,6FAA6F;AACtF,MAAM,aAAa,GAAG,CAAC,EAAC,OAAO,EAAE,GAAG,EAAqC,EAAU,EAAE,CACxF,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,IAAI,GAAG,EAAE,CAAC;AADvD,QAAA,aAAa,iBAC0C;AAEpE,yFAAyF;AAClF,MAAM,wBAAwB,GAAG,CAAC,MAA8C,EAAE,GAAG,GAAG,IAAI,IAAI,EAAE,EAAW,EAAE,CAClH,MAAM,CAAC,MAAM,KAAK,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,GAAG,CAAC,OAAO,EAAE,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,QAAkB,CAAC,CAAC,OAAO,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAD5I,QAAA,wBAAwB,4BACoH;AAEzJ,sFAAsF;AAC/E,MAAM,kBAAkB,GAAG,CAAC,MAA4C,EAAsD,EAAE,CACnI,MAAM,CAAC,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,EAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE,gBAAgB,EAAC,EAAE,EAAE,CAAC,CAAC,EAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC,CAAC,EAAC,gBAAgB,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAC,CAAC,CAAC,CAAC;AAD5J,QAAA,kBAAkB,sBAC0I;AAEzK,mGAAmG;AAC5F,MAAM,mBAAmB,GAAG,CAAC,QAA4D,EAAE,OAAe,EAAsD,EAAE;IACrK,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IAC3C,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;AACrG,CAAC,CAAC;AAHW,QAAA,mBAAmB,uBAG9B;AAEK,MAAM,gBAAgB,GAAG,CAAC,MAAsC,EAAW,EAAE,CAChF,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,UAAU,CAAC;AAD7D,QAAA,gBAAgB,oBAC6C;AAEnE,MAAM,qBAAqB,GAAG,CAAC,QAA0B,EAAW,EAAE,CACzE,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,QAAQ,KAAK,UAAU,CAAC,CAAC,CAAC;AAD5D,QAAA,qBAAqB,yBACuC;AAEzE,wEAAwE;AACjE,MAAM,oBAAoB,GAAG,CAAC,MAAwD,EAAuD,EAAE;IAClJ,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IAC5D,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAE,CAAC,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,CAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;IAC5I,OAAO,EAAC,KAAK,EAAE,aAAa,EAAE,CAAC,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC,EAAC,CAAC;AAC1D,CAAC,CAAC;AAJW,QAAA,oBAAoB,wBAI/B;AAEF,sEAAsE;AAC/D,MAAM,qBAAqB,GAAG,CAAC,WAAmB,EAAE,SAA+B,EAAE,MAAsC,EAAE,EAAE;IAClI,MAAM,IAAI,GAAG,EAAC,WAAW,EAAE,iBAAiB,EAAE,SAAS,CAAC,iBAAiB,EAAE,eAAe,EAAE,SAAS,CAAC,eAAe,EAAE,cAAc,EAAE,SAAS,CAAC,cAAc,EAAE,YAAY,EAAE,SAAS,CAAC,IAAI,EAAE,SAAS,EAAE,SAAS,CAAC,SAAS,EAAE,OAAO,EAAE,SAAS,CAAC,OAAO,EAAC,CAAC;IAC3P,MAAM,IAAI,GAAuG,SAAS,CAAC,KAAK,KAAK,cAAc,CAAC,CAAC;QACjJ,CAAC,EAAC,GAAG,IAAI,EAAE,MAAM,EAAE,cAAc,EAAC,CAAC,CAAC,CAAC;QACrC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,EAAC,GAAG,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAC,CAAC,CAAC,CAAC;IAClI,OAAO,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACnE,CAAC,CAAC;AANW,QAAA,qBAAqB,yBAMhC;AAEF,iJAAiJ;AAC1I,MAAM,iBAAiB,GAAG,KAAK,EAAE,EAAC,GAAG,EAAE,iBAAiB,EAAE,QAAQ,EAAE,GAAG,EAAE,gBAAgB,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,cAAc,EAAiM,EAAiB,EAAE;IAC1V,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;IACvB,MAAM,OAAO,GAAG,EAAC,MAAM,EAAE,QAAQ,EAAE,GAAG,CAAC,WAAW,EAAE,EAAE,UAAU,EAAE,cAAc,EAAE,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAC,CAAC;IAEhI,MAAM,aAAa,CAAC,MAAM,CAAC,CAAC,kBAAkB,EAAE,iBAAiB,CAAC,EAAE,EAAC,CAAC,WAAW,GAAG,UAAU,QAAQ,EAAE,CAAC,EAAE,EAAC,GAAG,OAAO,EAAE,GAAG,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC,CAAC,EAAC,gBAAgB,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAC,EAAC,CAAC,CAAC;IAEnL,MAAM,UAAU,GAAG,MAAM,aAAa,CAAC,YAAY,CAAC,CAAC,YAAY,CAAC,EAAE;QAChE,IAAA,iBAAK,EAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC;QACvB,IAAA,iBAAK,EAAC,mBAAmB,EAAE,IAAI,EAAE,iBAAiB,CAAC;QACnD,IAAA,iBAAK,EAAC,eAAe,QAAQ,MAAM,EAAE,IAAI,EAAE,GAAG,CAAC;KAClD,CAAyC,CAAC;IAE3C,MAAM,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,SAAS,CAAC,EAAE,EAAE;QACjE,6DAA6D;QAC7D,MAAM,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,MAAM,EAAC,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAgB,CAAC;QAC9E,MAAM,OAAO,GAAG,EAAC,GAAG,MAAM,EAAE,GAAG,OAAO,EAAC,CAAC;QACxC,OAAO,aAAa,CAAC,MAAM,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,EAAE,EAAC,CAAC,eAAe,QAAQ,EAAE,CAAC,EAAE,OAAO,EAAE,GAAG,IAAA,4BAAoB,EAAC,EAAC,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAC,CAAC,EAAC,CAAC,CAAC;IACtK,CAAC,CAAC,CAAC,CAAC;AACR,CAAC,CAAC;AAlBW,QAAA,iBAAiB,qBAkB5B;AAEF,+EAA+E;AACxE,MAAM,oBAAoB,GAAG,KAAK,EAAE,GAAW,EAAE,QAAgB,EAAmC,EAAE;IACzG,MAAM,QAAQ,GAAG,CAAC,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,cAAc,CAAC,CAAC;IAChF,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC,IAAA,iBAAK,EAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,EAAE,IAAA,iBAAK,EAAC,QAAQ,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,IAAA,iBAAK,EAAC,eAAe,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACvM,OAAO,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACtE,CAAC,CAAC;AAJW,QAAA,oBAAoB,wBAI/B"}

package/lib/kcsie.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/kcsie.test.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+jest.mock("firebase/firestore", () => ({ where: jest.fn() }));
+jest.mock("./firebase/firebaseQuery", () => jest.fn());
+const kcsie_1 = require("./kcsie");
+const person = (status, surname = "Smith", extra = {}) => ({
+    forename: "Jane", surname, dob: "1980-02-03", status, submitted: "2026-09-01T00:00:00.000Z", ...extra,
+});
+describe("kcsiePersonId", () => {
+    it("matches the same surname and DOB however it is typed", () => {
+        expect((0, kcsie_1.kcsiePersonId)({ surname: " O'Brien ", dob: "1980-02-03" })).toBe((0, kcsie_1.kcsiePersonId)({ surname: "OBRIEN", dob: "1980-02-03" }));
+        expect((0, kcsie_1.kcsiePersonId)({ surname: "Smith", dob: "1980-02-03" })).not.toBe((0, kcsie_1.kcsiePersonId)({ surname: "Smith", dob: "1981-02-03" }));
+    });
+});
+describe("kcsieCheckedOverAYearAgo", () => {
+    const now = new Date("2026-10-08T12:00:00Z");
+    it("flags outcomes over a year old without resetting them", () => {
+        expect((0, kcsie_1.kcsieCheckedOverAYearAgo)(person("approved", "Smith", { reviewed: "2025-09-01T00:00:00Z" }), now)).toBe(true);
+        expect((0, kcsie_1.kcsieCheckedOverAYearAgo)(person("approved", "Smith", { reviewed: "2026-01-01T00:00:00Z" }), now)).toBe(false);
+        expect((0, kcsie_1.kcsieCheckedOverAYearAgo)(person("pending", "Smith", { reviewed: "2025-09-01T00:00:00Z" }), now)).toBe(false);
+    });
+});
+describe("kcsiePeopleDetails", () => {
+    it("imports names and DOBs from another placement, not its outcomes", () => {
+        expect((0, kcsie_1.kcsiePeopleDetails)({ smith: person("approved", "Smith", { previousSurnames: ["Jones"], reviewedBy: "uid1" }) }))
+            .toEqual([{ forename: "Jane", surname: "Smith", dob: "1980-02-03", previousSurnames: ["Jones"] }]);
+        expect((0, kcsie_1.kcsiePeopleDetails)(undefined)).toEqual([]);
+    });
+});
+describe("matchingKcsiePeople", () => {
+    const previous = [{ forename: "Jane", surname: "Smith", dob: "1980-02-03" }, { forename: "Bob", surname: "Smythe", dob: "1975-05-05" }, { forename: "Al", surname: "Lee", dob: "1990-01-01" }];
+    it("suggests previous individuals by surname once two letters are typed", () => {
+        expect((0, kcsie_1.matchingKcsiePeople)(previous, "S")).toEqual([]);
+        expect((0, kcsie_1.matchingKcsiePeople)(previous, "sm").map((p) => p.forename)).toEqual(["Jane", "Bob"]);
+        expect((0, kcsie_1.matchingKcsiePeople)(previous, "Smi").map((p) => p.forename)).toEqual(["Jane"]);
+    });
+});
+describe("kcsieOutstanding", () => {
+    it("only holds placements with someone pending, flagged or rejected", () => {
+        expect(["pending", "flagged", "rejected"].every((s) => (0, kcsie_1.kcsieOutstanding)(s))).toBe(true);
+        expect(["approved", "notRequired", "notRequested", undefined].some((s) => (0, kcsie_1.kcsieOutstanding)(s))).toBe(false);
+    });
+});
+describe("workflowRequiresKcsie", () => {
+    it("only counts employer stages", () => {
+        expect((0, kcsie_1.workflowRequiresKcsie)([{ id: 3, name: "Employer", userType: "Provider", kcsie: true }])).toBe(true);
+        expect((0, kcsie_1.workflowRequiresKcsie)([{ id: 2, name: "Staff", userType: "Staff", kcsie: true }])).toBe(false);
+    });
+});
+describe("placementKcsieFields", () => {
+    it("is not required when nobody was named", () => {
+        expect((0, kcsie_1.placementKcsieFields)({})).toEqual({ kcsie: "notRequired", kcsieStatuses: [] });
+    });
+    it("takes the worst outcome and lists each status once", () => {
+        expect((0, kcsie_1.placementKcsieFields)({ a: person("approved"), b: person("flagged"), c: person("approved") }))
+            .toEqual({ kcsie: "flagged", kcsieStatuses: ["approved", "flagged"] });
+    });
+});
+describe("kcsieRowsForPlacement", () => {
+    const placement = (extra) => ({ name: "Northgate", studentForename: "Priya", studentSurname: "Shah", ...extra });
+    const people = { smith: person("approved"), lee: person("flagged", "Lee") };
+    it("gives one row per person, and filters by status", () => {
+        expect((0, kcsie_1.kcsieRowsForPlacement)("p1", placement({ kcsie: "flagged", kcsiePeople: people })).map((r) => [r.personId, r.status])).toEqual([["smith", "approved"], ["lee", "flagged"]]);
+        expect((0, kcsie_1.kcsieRowsForPlacement)("p1", placement({ kcsie: "flagged", kcsiePeople: people }), "flagged").map((r) => r.personId)).toEqual(["lee"]);
+    });
+    it("gives one row for a placement still waiting on the employer", () => {
+        expect((0, kcsie_1.kcsieRowsForPlacement)("p1", placement({ kcsie: "notRequested" })).map((r) => r.status)).toEqual(["notRequested"]);
+    });
+});
+//# sourceMappingURL=kcsie.test.js.map