placementt-core 1.400.1143 → 1.400.1144

package/lib/callables/checks.d.ts

@@ -31,12 +31,12 @@ export declare const checksCallables: {
             }, "strip", z.ZodTypeAny, {
                 label: string;
                 done?: boolean | undefined;
-                owner?: "staff" | "student" | undefined;
+                owner?: "student" | "staff" | undefined;
                 dueDate?: string | undefined;
             }, {
                 label: string;
                 done?: boolean | undefined;
-                owner?: "staff" | "student" | undefined;
+                owner?: "student" | "staff" | undefined;
                 dueDate?: string | undefined;
             }>, "many">>;
             concern: z.ZodOptional<z.ZodBoolean>;
@@ -48,7 +48,7 @@ export declare const checksCallables: {
             actions?: {
                 label: string;
                 done?: boolean | undefined;
-                owner?: "staff" | "student" | undefined;
+                owner?: "student" | "staff" | undefined;
                 dueDate?: string | undefined;
             }[] | undefined;
             staffNotes?: string | undefined;
@@ -63,7 +63,7 @@ export declare const checksCallables: {
             actions?: {
                 label: string;
                 done?: boolean | undefined;
-                owner?: "staff" | "student" | undefined;
+                owner?: "student" | "staff" | undefined;
                 dueDate?: string | undefined;
             }[] | undefined;
             staffNotes?: string | undefined;

package/lib/callables/registry.d.ts

@@ -804,6 +804,179 @@ export declare const allCallables: {
             taskId: string;
         }>;
     };
+    "wonde-findDualRegistrations": {
+        request: z.ZodObject<{
+            oId: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            oId: string;
+        }, {
+            oId: string;
+        }>;
+        response: z.ZodObject<{
+            trustId: z.ZodString;
+            schools: z.ZodArray<z.ZodObject<{
+                oId: z.ZodString;
+                name: z.ZodString;
+                rosterSize: z.ZodNumber;
+                missingUpn: z.ZodNumber;
+                enrolmentStatuses: z.ZodRecord<z.ZodString, z.ZodNumber>;
+            }, "strip", z.ZodTypeAny, {
+                name: string;
+                oId: string;
+                rosterSize: number;
+                missingUpn: number;
+                enrolmentStatuses: Record<string, number>;
+            }, {
+                name: string;
+                oId: string;
+                rosterSize: number;
+                missingUpn: number;
+                enrolmentStatuses: Record<string, number>;
+            }>, "many">;
+            skipped: z.ZodArray<z.ZodObject<{
+                oId: z.ZodString;
+                name: z.ZodString;
+                reason: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                name: string;
+                reason: string;
+                oId: string;
+            }, {
+                name: string;
+                reason: string;
+                oId: string;
+            }>, "many">;
+            matches: z.ZodArray<z.ZodObject<{
+                matchedOn: z.ZodEnum<["upn", "nameDob"]>;
+                upn: z.ZodNullable<z.ZodString>;
+                forename: z.ZodString;
+                surname: z.ZodString;
+                dateOfBirth: z.ZodNullable<z.ZodString>;
+                enrolments: z.ZodArray<z.ZodObject<{
+                    oId: z.ZodString;
+                    schoolName: z.ZodString;
+                    wondeId: z.ZodString;
+                    email: z.ZodNullable<z.ZodString>;
+                    year: z.ZodNullable<z.ZodString>;
+                    formGroup: z.ZodNullable<z.ZodString>;
+                    enrolmentStatus: z.ZodNullable<z.ZodString>;
+                    userId: z.ZodNullable<z.ZodString>;
+                }, "strip", z.ZodTypeAny, {
+                    email: string | null;
+                    year: string | null;
+                    oId: string;
+                    userId: string | null;
+                    schoolName: string;
+                    wondeId: string;
+                    formGroup: string | null;
+                    enrolmentStatus: string | null;
+                }, {
+                    email: string | null;
+                    year: string | null;
+                    oId: string;
+                    userId: string | null;
+                    schoolName: string;
+                    wondeId: string;
+                    formGroup: string | null;
+                    enrolmentStatus: string | null;
+                }>, "many">;
+            }, "strip", z.ZodTypeAny, {
+                upn: string | null;
+                matchedOn: "upn" | "nameDob";
+                forename: string;
+                surname: string;
+                dateOfBirth: string | null;
+                enrolments: {
+                    email: string | null;
+                    year: string | null;
+                    oId: string;
+                    userId: string | null;
+                    schoolName: string;
+                    wondeId: string;
+                    formGroup: string | null;
+                    enrolmentStatus: string | null;
+                }[];
+            }, {
+                upn: string | null;
+                matchedOn: "upn" | "nameDob";
+                forename: string;
+                surname: string;
+                dateOfBirth: string | null;
+                enrolments: {
+                    email: string | null;
+                    year: string | null;
+                    oId: string;
+                    userId: string | null;
+                    schoolName: string;
+                    wondeId: string;
+                    formGroup: string | null;
+                    enrolmentStatus: string | null;
+                }[];
+            }>, "many">;
+        }, "strip", z.ZodTypeAny, {
+            skipped: {
+                name: string;
+                reason: string;
+                oId: string;
+            }[];
+            matches: {
+                upn: string | null;
+                matchedOn: "upn" | "nameDob";
+                forename: string;
+                surname: string;
+                dateOfBirth: string | null;
+                enrolments: {
+                    email: string | null;
+                    year: string | null;
+                    oId: string;
+                    userId: string | null;
+                    schoolName: string;
+                    wondeId: string;
+                    formGroup: string | null;
+                    enrolmentStatus: string | null;
+                }[];
+            }[];
+            schools: {
+                name: string;
+                oId: string;
+                rosterSize: number;
+                missingUpn: number;
+                enrolmentStatuses: Record<string, number>;
+            }[];
+            trustId: string;
+        }, {
+            skipped: {
+                name: string;
+                reason: string;
+                oId: string;
+            }[];
+            matches: {
+                upn: string | null;
+                matchedOn: "upn" | "nameDob";
+                forename: string;
+                surname: string;
+                dateOfBirth: string | null;
+                enrolments: {
+                    email: string | null;
+                    year: string | null;
+                    oId: string;
+                    userId: string | null;
+                    schoolName: string;
+                    wondeId: string;
+                    formGroup: string | null;
+                    enrolmentStatus: string | null;
+                }[];
+            }[];
+            schools: {
+                name: string;
+                oId: string;
+                rosterSize: number;
+                missingUpn: number;
+                enrolmentStatuses: Record<string, number>;
+            }[];
+            trustId: string;
+        }>;
+    };
     "e2e-redeemSignInLink": {
         request: z.ZodObject<{
             token: z.ZodString;
@@ -1499,12 +1672,12 @@ export declare const allCallables: {
             }, "strip", z.ZodTypeAny, {
                 label: string;
                 done?: boolean | undefined;
-                owner?: "staff" | "student" | undefined;
+                owner?: "student" | "staff" | undefined;
                 dueDate?: string | undefined;
             }, {
                 label: string;
                 done?: boolean | undefined;
-                owner?: "staff" | "student" | undefined;
+                owner?: "student" | "staff" | undefined;
                 dueDate?: string | undefined;
             }>, "many">>;
             concern: z.ZodOptional<z.ZodBoolean>;
@@ -1516,7 +1689,7 @@ export declare const allCallables: {
             actions?: {
                 label: string;
                 done?: boolean | undefined;
-                owner?: "staff" | "student" | undefined;
+                owner?: "student" | "staff" | undefined;
                 dueDate?: string | undefined;
             }[] | undefined;
             staffNotes?: string | undefined;
@@ -1531,7 +1704,7 @@ export declare const allCallables: {
             actions?: {
                 label: string;
                 done?: boolean | undefined;
-                owner?: "staff" | "student" | undefined;
+                owner?: "student" | "staff" | undefined;
                 dueDate?: string | undefined;
             }[] | undefined;
             staffNotes?: string | undefined;
@@ -2076,14 +2249,14 @@ export declare const allCallables: {
             requestId: string;
             token?: string | undefined;
             response?: unknown;
-            submittedBy?: "parent" | "staff" | "student" | "trustedContact" | "employer" | undefined;
+            submittedBy?: "parent" | "employer" | "student" | "staff" | "trustedContact" | undefined;
             rater?: "students" | "parents" | "trustedContact" | "employers" | undefined;
             noChange?: boolean | undefined;
         }, {
             requestId: string;
             token?: string | undefined;
             response?: unknown;
-            submittedBy?: "parent" | "staff" | "student" | "trustedContact" | "employer" | undefined;
+            submittedBy?: "parent" | "employer" | "student" | "staff" | "trustedContact" | undefined;
             rater?: "students" | "parents" | "trustedContact" | "employers" | undefined;
             noChange?: boolean | undefined;
         }>;
@@ -2862,14 +3035,14 @@ export declare const callableGroups: {
                 requestId: string;
                 token?: string | undefined;
                 response?: unknown;
-                submittedBy?: "parent" | "staff" | "student" | "trustedContact" | "employer" | undefined;
+                submittedBy?: "parent" | "employer" | "student" | "staff" | "trustedContact" | undefined;
                 rater?: "students" | "parents" | "trustedContact" | "employers" | undefined;
                 noChange?: boolean | undefined;
             }, {
                 requestId: string;
                 token?: string | undefined;
                 response?: unknown;
-                submittedBy?: "parent" | "staff" | "student" | "trustedContact" | "employer" | undefined;
+                submittedBy?: "parent" | "employer" | "student" | "staff" | "trustedContact" | undefined;
                 rater?: "students" | "parents" | "trustedContact" | "employers" | undefined;
                 noChange?: boolean | undefined;
             }>;
@@ -2900,12 +3073,12 @@ export declare const callableGroups: {
                 }, "strip", z.ZodTypeAny, {
                     label: string;
                     done?: boolean | undefined;
-                    owner?: "staff" | "student" | undefined;
+                    owner?: "student" | "staff" | undefined;
                     dueDate?: string | undefined;
                 }, {
                     label: string;
                     done?: boolean | undefined;
-                    owner?: "staff" | "student" | undefined;
+                    owner?: "student" | "staff" | undefined;
                     dueDate?: string | undefined;
                 }>, "many">>;
                 concern: z.ZodOptional<z.ZodBoolean>;
@@ -2917,7 +3090,7 @@ export declare const callableGroups: {
                 actions?: {
                     label: string;
                     done?: boolean | undefined;
-                    owner?: "staff" | "student" | undefined;
+                    owner?: "student" | "staff" | undefined;
                     dueDate?: string | undefined;
                 }[] | undefined;
                 staffNotes?: string | undefined;
@@ -2932,7 +3105,7 @@ export declare const callableGroups: {
                 actions?: {
                     label: string;
                     done?: boolean | undefined;
-                    owner?: "staff" | "student" | undefined;
+                    owner?: "student" | "staff" | undefined;
                     dueDate?: string | undefined;
                 }[] | undefined;
                 staffNotes?: string | undefined;
@@ -3669,6 +3842,179 @@ export declare const callableGroups: {
                 taskId: string;
             }>;
         };
+        "wonde-findDualRegistrations": {
+            request: z.ZodObject<{
+                oId: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                oId: string;
+            }, {
+                oId: string;
+            }>;
+            response: z.ZodObject<{
+                trustId: z.ZodString;
+                schools: z.ZodArray<z.ZodObject<{
+                    oId: z.ZodString;
+                    name: z.ZodString;
+                    rosterSize: z.ZodNumber;
+                    missingUpn: z.ZodNumber;
+                    enrolmentStatuses: z.ZodRecord<z.ZodString, z.ZodNumber>;
+                }, "strip", z.ZodTypeAny, {
+                    name: string;
+                    oId: string;
+                    rosterSize: number;
+                    missingUpn: number;
+                    enrolmentStatuses: Record<string, number>;
+                }, {
+                    name: string;
+                    oId: string;
+                    rosterSize: number;
+                    missingUpn: number;
+                    enrolmentStatuses: Record<string, number>;
+                }>, "many">;
+                skipped: z.ZodArray<z.ZodObject<{
+                    oId: z.ZodString;
+                    name: z.ZodString;
+                    reason: z.ZodString;
+                }, "strip", z.ZodTypeAny, {
+                    name: string;
+                    reason: string;
+                    oId: string;
+                }, {
+                    name: string;
+                    reason: string;
+                    oId: string;
+                }>, "many">;
+                matches: z.ZodArray<z.ZodObject<{
+                    matchedOn: z.ZodEnum<["upn", "nameDob"]>;
+                    upn: z.ZodNullable<z.ZodString>;
+                    forename: z.ZodString;
+                    surname: z.ZodString;
+                    dateOfBirth: z.ZodNullable<z.ZodString>;
+                    enrolments: z.ZodArray<z.ZodObject<{
+                        oId: z.ZodString;
+                        schoolName: z.ZodString;
+                        wondeId: z.ZodString;
+                        email: z.ZodNullable<z.ZodString>;
+                        year: z.ZodNullable<z.ZodString>;
+                        formGroup: z.ZodNullable<z.ZodString>;
+                        enrolmentStatus: z.ZodNullable<z.ZodString>;
+                        userId: z.ZodNullable<z.ZodString>;
+                    }, "strip", z.ZodTypeAny, {
+                        email: string | null;
+                        year: string | null;
+                        oId: string;
+                        userId: string | null;
+                        schoolName: string;
+                        wondeId: string;
+                        formGroup: string | null;
+                        enrolmentStatus: string | null;
+                    }, {
+                        email: string | null;
+                        year: string | null;
+                        oId: string;
+                        userId: string | null;
+                        schoolName: string;
+                        wondeId: string;
+                        formGroup: string | null;
+                        enrolmentStatus: string | null;
+                    }>, "many">;
+                }, "strip", z.ZodTypeAny, {
+                    upn: string | null;
+                    matchedOn: "upn" | "nameDob";
+                    forename: string;
+                    surname: string;
+                    dateOfBirth: string | null;
+                    enrolments: {
+                        email: string | null;
+                        year: string | null;
+                        oId: string;
+                        userId: string | null;
+                        schoolName: string;
+                        wondeId: string;
+                        formGroup: string | null;
+                        enrolmentStatus: string | null;
+                    }[];
+                }, {
+                    upn: string | null;
+                    matchedOn: "upn" | "nameDob";
+                    forename: string;
+                    surname: string;
+                    dateOfBirth: string | null;
+                    enrolments: {
+                        email: string | null;
+                        year: string | null;
+                        oId: string;
+                        userId: string | null;
+                        schoolName: string;
+                        wondeId: string;
+                        formGroup: string | null;
+                        enrolmentStatus: string | null;
+                    }[];
+                }>, "many">;
+            }, "strip", z.ZodTypeAny, {
+                skipped: {
+                    name: string;
+                    reason: string;
+                    oId: string;
+                }[];
+                matches: {
+                    upn: string | null;
+                    matchedOn: "upn" | "nameDob";
+                    forename: string;
+                    surname: string;
+                    dateOfBirth: string | null;
+                    enrolments: {
+                        email: string | null;
+                        year: string | null;
+                        oId: string;
+                        userId: string | null;
+                        schoolName: string;
+                        wondeId: string;
+                        formGroup: string | null;
+                        enrolmentStatus: string | null;
+                    }[];
+                }[];
+                schools: {
+                    name: string;
+                    oId: string;
+                    rosterSize: number;
+                    missingUpn: number;
+                    enrolmentStatuses: Record<string, number>;
+                }[];
+                trustId: string;
+            }, {
+                skipped: {
+                    name: string;
+                    reason: string;
+                    oId: string;
+                }[];
+                matches: {
+                    upn: string | null;
+                    matchedOn: "upn" | "nameDob";
+                    forename: string;
+                    surname: string;
+                    dateOfBirth: string | null;
+                    enrolments: {
+                        email: string | null;
+                        year: string | null;
+                        oId: string;
+                        userId: string | null;
+                        schoolName: string;
+                        wondeId: string;
+                        formGroup: string | null;
+                        enrolmentStatus: string | null;
+                    }[];
+                }[];
+                schools: {
+                    name: string;
+                    oId: string;
+                    rosterSize: number;
+                    missingUpn: number;
+                    enrolmentStatuses: Record<string, number>;
+                }[];
+                trustId: string;
+            }>;
+        };
     };
     misSyncCallables: {
         "misSync-saveConfig": {

package/lib/callables/surveys.d.ts

@@ -580,14 +580,14 @@ export declare const surveyCallables: {
             requestId: string;
             token?: string | undefined;
             response?: unknown;
-            submittedBy?: "parent" | "staff" | "student" | "trustedContact" | "employer" | undefined;
+            submittedBy?: "parent" | "employer" | "student" | "staff" | "trustedContact" | undefined;
             rater?: "students" | "parents" | "trustedContact" | "employers" | undefined;
             noChange?: boolean | undefined;
         }, {
             requestId: string;
             token?: string | undefined;
             response?: unknown;
-            submittedBy?: "parent" | "staff" | "student" | "trustedContact" | "employer" | undefined;
+            submittedBy?: "parent" | "employer" | "student" | "staff" | "trustedContact" | undefined;
             rater?: "students" | "parents" | "trustedContact" | "employers" | undefined;
             noChange?: boolean | undefined;
         }>;

package/lib/callables/wonde.d.ts

@@ -1,6 +1,6 @@
 import { z } from "zod";
 /**
- * Contracts for the Wonde connection request
+ * Contracts for the Wonde connection request and the dual registration check
  * (`Placementt-Backend/functions/src/wonde.ts`).
  *
  * Wonde only approves a connection once the school's IT manager signs it off, so
@@ -32,4 +32,190 @@ export declare const wondeCallables: {
             taskId: string;
         }>;
     };
+    /**
+     * Admin only, read only. Pulls the full Wonde roster of every connected school
+     * in the trust `oId` belongs to (or is) and lists the pupils on more than one,
+     * such as a SEND school's pupils based in satellite centres at other schools.
+     * Writes nothing, so it is safe to run against a live trust.
+     */
+    "wonde-findDualRegistrations": {
+        request: z.ZodObject<{
+            /** The trust, or any school in it. */
+            oId: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            oId: string;
+        }, {
+            oId: string;
+        }>;
+        response: z.ZodObject<{
+            trustId: z.ZodString;
+            schools: z.ZodArray<z.ZodObject<{
+                oId: z.ZodString;
+                name: z.ZodString;
+                rosterSize: z.ZodNumber;
+                /** Pupils Wonde returned with no UPN, matched on name and date of birth instead. */
+                missingUpn: z.ZodNumber;
+                /** Distinct `extended_details.enrolment_status` values on the roster, with counts. */
+                enrolmentStatuses: z.ZodRecord<z.ZodString, z.ZodNumber>;
+            }, "strip", z.ZodTypeAny, {
+                name: string;
+                oId: string;
+                rosterSize: number;
+                missingUpn: number;
+                enrolmentStatuses: Record<string, number>;
+            }, {
+                name: string;
+                oId: string;
+                rosterSize: number;
+                missingUpn: number;
+                enrolmentStatuses: Record<string, number>;
+            }>, "many">;
+            /** Trust schools left out, and why. */
+            skipped: z.ZodArray<z.ZodObject<{
+                oId: z.ZodString;
+                name: z.ZodString;
+                reason: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                name: string;
+                reason: string;
+                oId: string;
+            }, {
+                name: string;
+                reason: string;
+                oId: string;
+            }>, "many">;
+            matches: z.ZodArray<z.ZodObject<{
+                /** What the pupils were matched on. */
+                matchedOn: z.ZodEnum<["upn", "nameDob"]>;
+                upn: z.ZodNullable<z.ZodString>;
+                forename: z.ZodString;
+                surname: z.ZodString;
+                dateOfBirth: z.ZodNullable<z.ZodString>;
+                /** One per school the pupil is on roll at. */
+                enrolments: z.ZodArray<z.ZodObject<{
+                    oId: z.ZodString;
+                    schoolName: z.ZodString;
+                    wondeId: z.ZodString;
+                    email: z.ZodNullable<z.ZodString>;
+                    year: z.ZodNullable<z.ZodString>;
+                    formGroup: z.ZodNullable<z.ZodString>;
+                    enrolmentStatus: z.ZodNullable<z.ZodString>;
+                    /** The CareerThread student at this school, if we hold one. */
+                    userId: z.ZodNullable<z.ZodString>;
+                }, "strip", z.ZodTypeAny, {
+                    email: string | null;
+                    year: string | null;
+                    oId: string;
+                    userId: string | null;
+                    schoolName: string;
+                    wondeId: string;
+                    formGroup: string | null;
+                    enrolmentStatus: string | null;
+                }, {
+                    email: string | null;
+                    year: string | null;
+                    oId: string;
+                    userId: string | null;
+                    schoolName: string;
+                    wondeId: string;
+                    formGroup: string | null;
+                    enrolmentStatus: string | null;
+                }>, "many">;
+            }, "strip", z.ZodTypeAny, {
+                upn: string | null;
+                matchedOn: "upn" | "nameDob";
+                forename: string;
+                surname: string;
+                dateOfBirth: string | null;
+                enrolments: {
+                    email: string | null;
+                    year: string | null;
+                    oId: string;
+                    userId: string | null;
+                    schoolName: string;
+                    wondeId: string;
+                    formGroup: string | null;
+                    enrolmentStatus: string | null;
+                }[];
+            }, {
+                upn: string | null;
+                matchedOn: "upn" | "nameDob";
+                forename: string;
+                surname: string;
+                dateOfBirth: string | null;
+                enrolments: {
+                    email: string | null;
+                    year: string | null;
+                    oId: string;
+                    userId: string | null;
+                    schoolName: string;
+                    wondeId: string;
+                    formGroup: string | null;
+                    enrolmentStatus: string | null;
+                }[];
+            }>, "many">;
+        }, "strip", z.ZodTypeAny, {
+            skipped: {
+                name: string;
+                reason: string;
+                oId: string;
+            }[];
+            matches: {
+                upn: string | null;
+                matchedOn: "upn" | "nameDob";
+                forename: string;
+                surname: string;
+                dateOfBirth: string | null;
+                enrolments: {
+                    email: string | null;
+                    year: string | null;
+                    oId: string;
+                    userId: string | null;
+                    schoolName: string;
+                    wondeId: string;
+                    formGroup: string | null;
+                    enrolmentStatus: string | null;
+                }[];
+            }[];
+            schools: {
+                name: string;
+                oId: string;
+                rosterSize: number;
+                missingUpn: number;
+                enrolmentStatuses: Record<string, number>;
+            }[];
+            trustId: string;
+        }, {
+            skipped: {
+                name: string;
+                reason: string;
+                oId: string;
+            }[];
+            matches: {
+                upn: string | null;
+                matchedOn: "upn" | "nameDob";
+                forename: string;
+                surname: string;
+                dateOfBirth: string | null;
+                enrolments: {
+                    email: string | null;
+                    year: string | null;
+                    oId: string;
+                    userId: string | null;
+                    schoolName: string;
+                    wondeId: string;
+                    formGroup: string | null;
+                    enrolmentStatus: string | null;
+                }[];
+            }[];
+            schools: {
+                name: string;
+                oId: string;
+                rosterSize: number;
+                missingUpn: number;
+                enrolmentStatuses: Record<string, number>;
+            }[];
+            trustId: string;
+        }>;
+    };
 };

package/lib/callables/wonde.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.wondeCallables = void 0;
 const zod_1 = require("zod");
 /**
- * Contracts for the Wonde connection request
+ * Contracts for the Wonde connection request and the dual registration check
  * (`Placementt-Backend/functions/src/wonde.ts`).
  *
  * Wonde only approves a connection once the school's IT manager signs it off, so
@@ -23,5 +23,51 @@ exports.wondeCallables = {
             taskId: zod_1.z.string(),
         }),
     },
+    /**
+     * Admin only, read only. Pulls the full Wonde roster of every connected school
+     * in the trust `oId` belongs to (or is) and lists the pupils on more than one,
+     * such as a SEND school's pupils based in satellite centres at other schools.
+     * Writes nothing, so it is safe to run against a live trust.
+     */
+    "wonde-findDualRegistrations": {
+        request: zod_1.z.object({
+            /** The trust, or any school in it. */
+            oId: zod_1.z.string().min(1),
+        }),
+        response: zod_1.z.object({
+            trustId: zod_1.z.string(),
+            schools: zod_1.z.array(zod_1.z.object({
+                oId: zod_1.z.string(),
+                name: zod_1.z.string(),
+                rosterSize: zod_1.z.number(),
+                /** Pupils Wonde returned with no UPN, matched on name and date of birth instead. */
+                missingUpn: zod_1.z.number(),
+                /** Distinct `extended_details.enrolment_status` values on the roster, with counts. */
+                enrolmentStatuses: zod_1.z.record(zod_1.z.string(), zod_1.z.number()),
+            })),
+            /** Trust schools left out, and why. */
+            skipped: zod_1.z.array(zod_1.z.object({ oId: zod_1.z.string(), name: zod_1.z.string(), reason: zod_1.z.string() })),
+            matches: zod_1.z.array(zod_1.z.object({
+                /** What the pupils were matched on. */
+                matchedOn: zod_1.z.enum(["upn", "nameDob"]),
+                upn: zod_1.z.string().nullable(),
+                forename: zod_1.z.string(),
+                surname: zod_1.z.string(),
+                dateOfBirth: zod_1.z.string().nullable(),
+                /** One per school the pupil is on roll at. */
+                enrolments: zod_1.z.array(zod_1.z.object({
+                    oId: zod_1.z.string(),
+                    schoolName: zod_1.z.string(),
+                    wondeId: zod_1.z.string(),
+                    email: zod_1.z.string().nullable(),
+                    year: zod_1.z.string().nullable(),
+                    formGroup: zod_1.z.string().nullable(),
+                    enrolmentStatus: zod_1.z.string().nullable(),
+                    /** The CareerThread student at this school, if we hold one. */
+                    userId: zod_1.z.string().nullable(),
+                })),
+            })),
+        }),
+    },
 };
 //# sourceMappingURL=wonde.js.map

package/lib/callables/wonde.js.map

@@ -1 +1 @@
-{"version":3,"file":"wonde.js","sourceRoot":"","sources":["../../src/callables/wonde.ts"],"names":[],"mappings":";;;AAAA,6BAAsB;AAGtB;;;;;;;GAOG;AACU,QAAA,cAAc,GAAG;IAC1B,yBAAyB,EAAE;QACvB,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC;YACd,wCAAwC;YACxC,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;YACtB,aAAa,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;YAChD,cAAc,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;SACrD,CAAC;QACF,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC;YACf,4DAA4D;YAC5D,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE;SACrB,CAAC;KACL;CACoB,CAAC"}
+{"version":3,"file":"wonde.js","sourceRoot":"","sources":["../../src/callables/wonde.ts"],"names":[],"mappings":";;;AAAA,6BAAsB;AAGtB;;;;;;;GAOG;AACU,QAAA,cAAc,GAAG;IAC1B,yBAAyB,EAAE;QACvB,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC;YACd,wCAAwC;YACxC,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;YACtB,aAAa,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;YAChD,cAAc,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;SACrD,CAAC;QACF,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC;YACf,4DAA4D;YAC5D,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE;SACrB,CAAC;KACL;IACD;;;;;OAKG;IACH,6BAA6B,EAAE;QAC3B,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC;YACd,sCAAsC;YACtC,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;SACzB,CAAC;QACF,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC;YACf,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE;YACnB,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,CAAC;gBACtB,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE;gBACf,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;gBAChB,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE;gBACtB,oFAAoF;gBACpF,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE;gBACtB,sFAAsF;gBACtF,iBAAiB,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC;aACtD,CAAC,CAAC;YACH,uCAAuC;YACvC,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,CAAC,EAAC,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,EAAC,CAAC,CAAC;YACnF,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,CAAC;gBACtB,uCAAuC;gBACvC,SAAS,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;gBACrC,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;gBAC1B,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE;gBACpB,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE;gBACnB,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;gBAClC,8CAA8C;gBAC9C,UAAU,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,CAAC;oBACzB,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE;oBACf,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE;oBACtB,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE;oBACnB,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;oBAC5B,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;oBAC3B,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;oBAChC,eAAe,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;oBACtC,+DAA+D;oBAC/D,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;iBAChC,CAAC,CAAC;aACN,CAAC,CAAC;SACN,CAAC;KACL;CACoB,CAAC"}

package/lib/index.d.ts

@@ -44,6 +44,7 @@ export * from "./benchmarkAggregate";
 export * from "./portfolioAggregate";
 export * from "./tutorialTips";
 export * from "./constants";
+export * from "./letters";
 export * from "./dataViewerReload";
 export * from "./hooks";
 export * from "./workflowBands";

package/lib/index.js

@@ -64,6 +64,7 @@ __exportStar(require("./benchmarkAggregate"), exports);
 __exportStar(require("./portfolioAggregate"), exports);
 __exportStar(require("./tutorialTips"), exports);
 __exportStar(require("./constants"), exports);
+__exportStar(require("./letters"), exports);
 __exportStar(require("./dataViewerReload"), exports);
 __exportStar(require("./hooks"), exports);
 __exportStar(require("./workflowBands"), 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,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"}
+{"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"}

package/lib/letters.d.ts

@@ -0,0 +1,22 @@
+import { Descendant } from "slate";
+import type { ProductTag } from "./typeDefinitions";
+export type WexLetterKey = "employer" | "parent" | "student";
+export type WexLetterOverride = {
+    body: Descendant[];
+    updated: string;
+    updatedBy?: string;
+};
+export type WexLetterConfig = {
+    name: string;
+    audience: "employers" | "parents" | "students";
+    description: string;
+    productTag: ProductTag;
+    body: Descendant[];
+};
+export declare const wexLetterParams: string[];
+export declare const wexLetters: {
+    [key in WexLetterKey]: WexLetterConfig;
+};
+export declare function fillLetterParams(text: string, values: {
+    [key: string]: string | undefined;
+}): string;

package/lib/letters.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.wexLetters = exports.wexLetterParams = void 0;
+exports.fillLetterParams = fillLetterParams;
+// Params available in every letter. Filled in when the letter is previewed or downloaded.
+exports.wexLetterParams = ["instituteName", "academicYear", "cohortName", "placementStart", "placementEnd", "staffName", "staffEmail"];
+// Builds Slate content from lines. "# " and "## " start headings, **text** is bold, {{param}} becomes a param node.
+function toLetterBody(lines) {
+    return lines.map((line) => {
+        const type = line.startsWith("# ") ? "heading-one" : line.startsWith("## ") ? "heading-two" : "paragraph";
+        const text = type === "heading-one" ? line.slice(2) : type === "heading-two" ? line.slice(3) : line;
+        const children = text.split(/(\*\*[^*]+\*\*|\{\{\w+\}\})/).filter(Boolean).map((part) => {
+            if (part.startsWith("**"))
+                return { text: part.slice(2, -2), bold: true };
+            if (part.startsWith("{{"))
+                return { text: part, param: true };
+            return { text: part };
+        });
+        return { type, children: children.length ? children : [{ text: "" }] };
+    });
+}
+const signOff = ["Kind regards,", "", "Thomas Barton", "Founder, Director", "tom@careerthread.co.uk", "CareerThread"];
+exports.wexLetters = {
+    employer: {
+        name: "Employer letter",
+        audience: "employers",
+        description: "Introduces CareerThread to businesses hosting a student, and what we will ask them for.",
+        productTag: "wex",
+        body: toLetterBody([
+            "# Employer Guidance",
+            "{{instituteName}} are using CareerThread through the academic year {{academicYear}} to support their students in managing work experience.",
+            "CareerThread helps students find placements, manages administrative sign-off and provides tools for schools to build lasting connections to businesses. As you are hosting a work experience student, we will contact you over the next few months to request additional information. This is to ensure students have all the information they need to prepare effectively for their placement.",
+            "We aim to build a community of businesses willing to support work experience at the school and the surrounding area. If you would like to advertise additional placements this year or in the future, please contact the school. Likewise, if you would like any support on hosting a student, please get in touch.",
+            "All automated correspondence from CareerThread will be sent from admin@careerthread.co.uk. If you have any questions specific to your placement, please contact the school. If you have any questions regarding CareerThread, please contact Tom at tom@careerthread.co.uk.",
+            "Thank you for agreeing to host a student for work experience. We hope it will be an enriching experience for you and your student.",
+            ...signOff,
+        ]),
+    },
+    parent: {
+        name: "Parent letter",
+        audience: "parents",
+        description: "Explains to parents how work experience is managed and what we will email them about.",
+        productTag: "wex",
+        body: toLetterBody([
+            "# Parent Guidance",
+            "{{instituteName}} is using CareerThread to manage your child's work experience. CareerThread helps secondary schools to coordinate work experience placements while supporting students with daily reflections and post-placement feedback, ensuring a meaningful and structured experience.",
+            "While CareerThread supports secondary schools in managing work experience, we do not currently find placements for your child. The students remain responsible for organising placements directly with an employer.",
+            "Your school will securely upload your email address to our platform so we can keep you informed about your child's placement and any potential issues. If you have any concerns or would prefer not to share your email, please contact the school.",
+            "Once your child has uploaded details of their work experience, we will retrieve necessary documentation from the employer. We may also email you requesting sign-off on the placement. This is necessary for us to go ahead with the placement.",
+            "During your child's work experience, you can view placement details and feedback through the email links we send you, so you can monitor your child's progress.",
+            "If you have any questions on how CareerThread works, please get in touch by emailing Tom at tom@careerthread.co.uk.",
+            ...signOff,
+        ]),
+    },
+    student: {
+        name: "Student guide",
+        audience: "students",
+        description: "Helps students prepare for their placement once it has been confirmed.",
+        productTag: "wex",
+        body: toLetterBody([
+            "# Preparing for Your Work Experience Placement",
+            "Congratulations on finding a placement! Now it's time to make the most of the opportunity. Good preparation can make all the difference, and this guide will walk you through some key steps to help you feel confident and ready to thrive.",
+            "**Confirm Details:** Once your placement has been verified on our portal, you'll see key information like your responsibilities, dress code, working hours, and any required preparation on your placement page. Review these carefully, and don't hesitate to contact the business if anything is unclear.",
+            "**Research the Company:** Take time to explore the business's website and any recent news or updates about them. Get familiar with their mission and the sector they work in. Think of a few questions you'd like to ask your new colleagues - it's a great way to learn and show your interest.",
+            "**Sharpen Your Skills:** Consider what skills might be useful during your placement. These could be technical skills (like using a specific type of software) or general ones like teamwork or communication. Practising these beforehand will help you feel ready and confident.",
+            "**Plan Your Travel:** Punctuality is key to a great first impression. Aim to arrive 15 minutes before your start time. Don't be too early, as your contact may not be ready for you. Before you start your placement, plan your travel route. If necessary, do a trial commute to make sure you will be on time.",
+            "**Pack Your Essentials:** Bring everything you'll need to feel prepared - this might include a notebook, pen, water bottle, lunch, or anything specific the business has asked you to bring. If you're unsure, ask ahead. Being well-prepared shows you're reliable, enthusiastic, and organised.",
+        ]),
+    },
+};
+// Replaces {{param}} text with its value. Unknown params are left as they are, so a missing value is visible rather than blank.
+function fillLetterParams(text, values) {
+    return text.replace(/\{\{(\w+)\}\}/g, (match, key) => values[key] ?? match);
+}
+//# sourceMappingURL=letters.js.map

package/lib/letters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"letters.js","sourceRoot":"","sources":["../src/letters.ts"],"names":[],"mappings":";;;AAwFA,4CAEC;AAvED,0FAA0F;AAC7E,QAAA,eAAe,GAAG,CAAC,eAAe,EAAE,cAAc,EAAE,YAAY,EAAE,gBAAgB,EAAE,cAAc,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC;AAE5I,oHAAoH;AACpH,SAAS,YAAY,CAAC,KAAe;IACjC,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACtB,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,WAAW,CAAC;QAC1G,MAAM,IAAI,GAAG,IAAI,KAAK,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACpG,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACpF,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;gBAAE,OAAO,EAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAC,CAAC;YACxE,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;gBAAE,OAAO,EAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAC,CAAC;YAC5D,OAAO,EAAC,IAAI,EAAE,IAAI,EAAC,CAAC;QACxB,CAAC,CAAC,CAAC;QACH,OAAO,EAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAC,IAAI,EAAE,EAAE,EAAC,CAAC,EAA0B,CAAC;IAChG,CAAC,CAAC,CAAC;AACP,CAAC;AAED,MAAM,OAAO,GAAG,CAAC,eAAe,EAAE,EAAE,EAAE,eAAe,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,cAAc,CAAC,CAAC;AAEzG,QAAA,UAAU,GAA6C;IAChE,QAAQ,EAAE;QACN,IAAI,EAAE,iBAAiB;QACvB,QAAQ,EAAE,WAAW;QACrB,WAAW,EAAE,yFAAyF;QACtG,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE,YAAY,CAAC;YACf,qBAAqB;YACrB,4IAA4I;YAC5I,iYAAiY;YACjY,qTAAqT;YACrT,6QAA6Q;YAC7Q,oIAAoI;YACpI,GAAG,OAAO;SACb,CAAC;KACL;IACD,MAAM,EAAE;QACJ,IAAI,EAAE,eAAe;QACrB,QAAQ,EAAE,SAAS;QACnB,WAAW,EAAE,uFAAuF;QACpG,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE,YAAY,CAAC;YACf,mBAAmB;YACnB,8RAA8R;YAC9R,qNAAqN;YACrN,qPAAqP;YACrP,iPAAiP;YACjP,iKAAiK;YACjK,qHAAqH;YACrH,GAAG,OAAO;SACb,CAAC;KACL;IACD,OAAO,EAAE;QACL,IAAI,EAAE,eAAe;QACrB,QAAQ,EAAE,UAAU;QACpB,WAAW,EAAE,wEAAwE;QACrF,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE,YAAY,CAAC;YACf,gDAAgD;YAChD,8OAA8O;YAC9O,6SAA6S;YAC7S,kSAAkS;YAClS,mRAAmR;YACnR,kTAAkT;YAClT,mSAAmS;SACtS,CAAC;KACL;CACJ,CAAC;AAEF,gIAAgI;AAChI,SAAgB,gBAAgB,CAAC,IAAY,EAAE,MAAyC;IACpF,OAAO,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,CAAC;AAChF,CAAC"}

package/lib/typeDefinitions.d.ts

@@ -7,6 +7,7 @@ import type { StudentTaskConfigMap, SurveyKind, SurveySendPolicyMap, SurveySlot
 import type { InstitutePricing } from "./pricing";
 import type { CompassActivityType, CompassCareersPartnerType, CompassDeliveryMethod } from "./compassTemplate";
 import type { MisColumnMapping } from "./misSync";
+import type { WexLetterKey, WexLetterOverride } from "./letters";
 export type FilterObject = {
     [key: string]: {
         label: string;
@@ -1078,6 +1079,10 @@ export type EmployerField = {
 /** The areas of the staff platform that each own part of the careers year. */
 export type CareersSetupArea = "development" | "destinations";
 export type InstituteData = {
+    /** The school's own edited versions of our work experience letters. Missing keys use our default. */
+    wexLetters?: {
+        [key in WexLetterKey]?: WexLetterOverride;
+    };
     /** MIS file sync. `mapping` holds the college's own header for any field not named exactly as we specify. */
     mis?: {
         mapping?: MisColumnMapping;
@@ -1277,6 +1282,9 @@ export type InstituteData = {
      * screen shown before the platform on first sign-in. Registration sets it false;
      * absent means the account predates the screen and is never asked. */
     featureSetupComplete?: boolean;
+    /** Every feature ticked on that screen, including those with no flag of their own yet
+     * (aspirations, leavers, careersLibrary), so the platform knows what to show. */
+    selectedFeatures?: string[];
     deactivated?: boolean;
     isTest?: boolean;
     cohortFilters?: {

package/lib/typeDefinitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"typeDefinitions.js","sourceRoot":"","sources":["../src/typeDefinitions.ts"],"names":[],"mappings":";;;AAmnIA,sDASC;AAeD,oDAKC;AAaD,0CAEC;AAjoED;;;;;kFAKkF;AACrE,QAAA,qBAAqB,GAAG,SAAS,CAAC;AAClC,QAAA,iBAAiB,GAAG,OAAO,CAAC;AA6iEzC;yEACyE;AAC5D,QAAA,0BAA0B,GAA2C;IAC9E,gBAAgB,EAAE,2BAA2B;IAC7C,mBAAmB,EAAE,sBAAsB;IAC3C,cAAc,EAAE,iBAAiB;IACjC,kBAAkB,EAAE,qBAAqB;IACzC,UAAU,EAAE,oCAAoC;IAChD,aAAa,EAAE,yBAAyB;IACxC,aAAa,EAAE,wBAAwB;IACvC,KAAK,EAAE,OAAO;CACjB,CAAC;AAEW,QAAA,0BAA0B,GAA+C;IAClF,QAAQ,EAAE,WAAW;IACrB,KAAK,EAAE,YAAY;IACnB,KAAK,EAAE,OAAO;CACjB,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,SAAgB,qBAAqB,CAAC,SAAsC;IACxE,QAAQ,SAAS,EAAE,CAAC;QACpB,KAAK,MAAM,CAAC,CAAC,OAAO,OAAO,CAAC;QAC5B,KAAK,OAAO,CAAC,CAAC,OAAO,OAAO,CAAC;QAC7B,KAAK,WAAW,CAAC;QACjB,KAAK,OAAO,CAAC;QACb,KAAK,OAAO,CAAC;QACb,OAAO,CAAC,CAAC,OAAO,UAAU,CAAC;IAC3B,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,oBAAoB,CAChC,IAAwC,EACxC,MAA6C;IAE7C,OAAO,IAAI,EAAE,WAAW,IAAI,MAAM,EAAE,YAAY,IAAI,KAAK,CAAC;AAC9D,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,eAAe,CAAC,KAA6D;IACzF,OAAO,GAAG,KAAK,CAAC,cAAc,IAAI,EAAE,IAAI,KAAK,CAAC,aAAa,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC;AAC/E,CAAC"}
+{"version":3,"file":"typeDefinitions.js","sourceRoot":"","sources":["../src/typeDefinitions.ts"],"names":[],"mappings":";;;AAynIA,sDASC;AAeD,oDAKC;AAaD,0CAEC;AAjoED;;;;;kFAKkF;AACrE,QAAA,qBAAqB,GAAG,SAAS,CAAC;AAClC,QAAA,iBAAiB,GAAG,OAAO,CAAC;AA6iEzC;yEACyE;AAC5D,QAAA,0BAA0B,GAA2C;IAC9E,gBAAgB,EAAE,2BAA2B;IAC7C,mBAAmB,EAAE,sBAAsB;IAC3C,cAAc,EAAE,iBAAiB;IACjC,kBAAkB,EAAE,qBAAqB;IACzC,UAAU,EAAE,oCAAoC;IAChD,aAAa,EAAE,yBAAyB;IACxC,aAAa,EAAE,wBAAwB;IACvC,KAAK,EAAE,OAAO;CACjB,CAAC;AAEW,QAAA,0BAA0B,GAA+C;IAClF,QAAQ,EAAE,WAAW;IACrB,KAAK,EAAE,YAAY;IACnB,KAAK,EAAE,OAAO;CACjB,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,SAAgB,qBAAqB,CAAC,SAAsC;IACxE,QAAQ,SAAS,EAAE,CAAC;QACpB,KAAK,MAAM,CAAC,CAAC,OAAO,OAAO,CAAC;QAC5B,KAAK,OAAO,CAAC,CAAC,OAAO,OAAO,CAAC;QAC7B,KAAK,WAAW,CAAC;QACjB,KAAK,OAAO,CAAC;QACb,KAAK,OAAO,CAAC;QACb,OAAO,CAAC,CAAC,OAAO,UAAU,CAAC;IAC3B,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,oBAAoB,CAChC,IAAwC,EACxC,MAA6C;IAE7C,OAAO,IAAI,EAAE,WAAW,IAAI,MAAM,EAAE,YAAY,IAAI,KAAK,CAAC;AAC9D,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,eAAe,CAAC,KAA6D;IACzF,OAAO,GAAG,KAAK,CAAC,cAAc,IAAI,EAAE,IAAI,KAAK,CAAC,aAAa,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC;AAC/E,CAAC"}

package/package.json

@@ -2,7 +2,7 @@
   "private": false,
   "name": "placementt-core",
   "author": "Placementt",
-  "version": "1.400.1143",
+  "version": "1.400.1144",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "scripts": {

package/src/callables/wonde.ts

@@ -2,7 +2,7 @@ import {z} from "zod";
 import {CallableGroup} from "./types";
 
 /**
- * Contracts for the Wonde connection request
+ * Contracts for the Wonde connection request and the dual registration check
  * (`Placementt-Backend/functions/src/wonde.ts`).
  *
  * Wonde only approves a connection once the school's IT manager signs it off, so
@@ -22,4 +22,50 @@ export const wondeCallables = {
             taskId: z.string(),
         }),
     },
+    /**
+     * Admin only, read only. Pulls the full Wonde roster of every connected school
+     * in the trust `oId` belongs to (or is) and lists the pupils on more than one,
+     * such as a SEND school's pupils based in satellite centres at other schools.
+     * Writes nothing, so it is safe to run against a live trust.
+     */
+    "wonde-findDualRegistrations": {
+        request: z.object({
+            /** The trust, or any school in it. */
+            oId: z.string().min(1),
+        }),
+        response: z.object({
+            trustId: z.string(),
+            schools: z.array(z.object({
+                oId: z.string(),
+                name: z.string(),
+                rosterSize: z.number(),
+                /** Pupils Wonde returned with no UPN, matched on name and date of birth instead. */
+                missingUpn: z.number(),
+                /** Distinct `extended_details.enrolment_status` values on the roster, with counts. */
+                enrolmentStatuses: z.record(z.string(), z.number()),
+            })),
+            /** Trust schools left out, and why. */
+            skipped: z.array(z.object({oId: z.string(), name: z.string(), reason: z.string()})),
+            matches: z.array(z.object({
+                /** What the pupils were matched on. */
+                matchedOn: z.enum(["upn", "nameDob"]),
+                upn: z.string().nullable(),
+                forename: z.string(),
+                surname: z.string(),
+                dateOfBirth: z.string().nullable(),
+                /** One per school the pupil is on roll at. */
+                enrolments: z.array(z.object({
+                    oId: z.string(),
+                    schoolName: z.string(),
+                    wondeId: z.string(),
+                    email: z.string().nullable(),
+                    year: z.string().nullable(),
+                    formGroup: z.string().nullable(),
+                    enrolmentStatus: z.string().nullable(),
+                    /** The CareerThread student at this school, if we hold one. */
+                    userId: z.string().nullable(),
+                })),
+            })),
+        }),
+    },
 } satisfies CallableGroup;

package/src/index.ts

@@ -46,6 +46,7 @@ export * from "./benchmarkAggregate";
 export * from "./portfolioAggregate";
 export * from "./tutorialTips";
 export * from "./constants";
+export * from "./letters";
 export * from "./dataViewerReload";
 export * from "./hooks";
 export * from "./workflowBands";

package/src/letters.ts

@@ -0,0 +1,91 @@
+import {Descendant} from "slate";
+import type {ProductTag} from "./typeDefinitions";
+
+// Work experience letters schools hand to employers, parents and students. We provide the defaults below.
+// A school can edit a letter once, saved to InstituteData.wexLetters[key], and that version is used for all their cohorts.
+// Cohort specific details (name, dates) come in through params, so one school version suits every cohort.
+
+export type WexLetterKey = "employer"|"parent"|"student";
+
+export type WexLetterOverride = {body: Descendant[], updated: string, updatedBy?: string};
+
+export type WexLetterConfig = {
+    name: string,
+    audience: "employers"|"parents"|"students",
+    description: string,
+    productTag: ProductTag,
+    body: Descendant[],
+};
+
+// Params available in every letter. Filled in when the letter is previewed or downloaded.
+export const wexLetterParams = ["instituteName", "academicYear", "cohortName", "placementStart", "placementEnd", "staffName", "staffEmail"];
+
+// Builds Slate content from lines. "# " and "## " start headings, **text** is bold, {{param}} becomes a param node.
+function toLetterBody(lines: string[]): Descendant[] {
+    return lines.map((line) => {
+        const type = line.startsWith("# ") ? "heading-one" : line.startsWith("## ") ? "heading-two" : "paragraph";
+        const text = type === "heading-one" ? line.slice(2) : type === "heading-two" ? line.slice(3) : line;
+        const children = text.split(/(\*\*[^*]+\*\*|\{\{\w+\}\})/).filter(Boolean).map((part) => {
+            if (part.startsWith("**")) return {text: part.slice(2, -2), bold: true};
+            if (part.startsWith("{{")) return {text: part, param: true};
+            return {text: part};
+        });
+        return {type, children: children.length ? children : [{text: ""}]} as unknown as Descendant;
+    });
+}
+
+const signOff = ["Kind regards,", "", "Thomas Barton", "Founder, Director", "tom@careerthread.co.uk", "CareerThread"];
+
+export const wexLetters: {[key in WexLetterKey]: WexLetterConfig} = {
+    employer: {
+        name: "Employer letter",
+        audience: "employers",
+        description: "Introduces CareerThread to businesses hosting a student, and what we will ask them for.",
+        productTag: "wex",
+        body: toLetterBody([
+            "# Employer Guidance",
+            "{{instituteName}} are using CareerThread through the academic year {{academicYear}} to support their students in managing work experience.",
+            "CareerThread helps students find placements, manages administrative sign-off and provides tools for schools to build lasting connections to businesses. As you are hosting a work experience student, we will contact you over the next few months to request additional information. This is to ensure students have all the information they need to prepare effectively for their placement.",
+            "We aim to build a community of businesses willing to support work experience at the school and the surrounding area. If you would like to advertise additional placements this year or in the future, please contact the school. Likewise, if you would like any support on hosting a student, please get in touch.",
+            "All automated correspondence from CareerThread will be sent from admin@careerthread.co.uk. If you have any questions specific to your placement, please contact the school. If you have any questions regarding CareerThread, please contact Tom at tom@careerthread.co.uk.",
+            "Thank you for agreeing to host a student for work experience. We hope it will be an enriching experience for you and your student.",
+            ...signOff,
+        ]),
+    },
+    parent: {
+        name: "Parent letter",
+        audience: "parents",
+        description: "Explains to parents how work experience is managed and what we will email them about.",
+        productTag: "wex",
+        body: toLetterBody([
+            "# Parent Guidance",
+            "{{instituteName}} is using CareerThread to manage your child's work experience. CareerThread helps secondary schools to coordinate work experience placements while supporting students with daily reflections and post-placement feedback, ensuring a meaningful and structured experience.",
+            "While CareerThread supports secondary schools in managing work experience, we do not currently find placements for your child. The students remain responsible for organising placements directly with an employer.",
+            "Your school will securely upload your email address to our platform so we can keep you informed about your child's placement and any potential issues. If you have any concerns or would prefer not to share your email, please contact the school.",
+            "Once your child has uploaded details of their work experience, we will retrieve necessary documentation from the employer. We may also email you requesting sign-off on the placement. This is necessary for us to go ahead with the placement.",
+            "During your child's work experience, you can view placement details and feedback through the email links we send you, so you can monitor your child's progress.",
+            "If you have any questions on how CareerThread works, please get in touch by emailing Tom at tom@careerthread.co.uk.",
+            ...signOff,
+        ]),
+    },
+    student: {
+        name: "Student guide",
+        audience: "students",
+        description: "Helps students prepare for their placement once it has been confirmed.",
+        productTag: "wex",
+        body: toLetterBody([
+            "# Preparing for Your Work Experience Placement",
+            "Congratulations on finding a placement! Now it's time to make the most of the opportunity. Good preparation can make all the difference, and this guide will walk you through some key steps to help you feel confident and ready to thrive.",
+            "**Confirm Details:** Once your placement has been verified on our portal, you'll see key information like your responsibilities, dress code, working hours, and any required preparation on your placement page. Review these carefully, and don't hesitate to contact the business if anything is unclear.",
+            "**Research the Company:** Take time to explore the business's website and any recent news or updates about them. Get familiar with their mission and the sector they work in. Think of a few questions you'd like to ask your new colleagues - it's a great way to learn and show your interest.",
+            "**Sharpen Your Skills:** Consider what skills might be useful during your placement. These could be technical skills (like using a specific type of software) or general ones like teamwork or communication. Practising these beforehand will help you feel ready and confident.",
+            "**Plan Your Travel:** Punctuality is key to a great first impression. Aim to arrive 15 minutes before your start time. Don't be too early, as your contact may not be ready for you. Before you start your placement, plan your travel route. If necessary, do a trial commute to make sure you will be on time.",
+            "**Pack Your Essentials:** Bring everything you'll need to feel prepared - this might include a notebook, pen, water bottle, lunch, or anything specific the business has asked you to bring. If you're unsure, ask ahead. Being well-prepared shows you're reliable, enthusiastic, and organised.",
+        ]),
+    },
+};
+
+// Replaces {{param}} text with its value. Unknown params are left as they are, so a missing value is visible rather than blank.
+export function fillLetterParams(text: string, values: {[key: string]: string|undefined}) {
+    return text.replace(/\{\{(\w+)\}\}/g, (match, key) => values[key] ?? match);
+}

package/src/typeDefinitions.ts

@@ -7,6 +7,7 @@ import type {StudentTaskConfigMap, SurveyKind, SurveySendPolicyMap, SurveySlot}
 import type {InstitutePricing} from "./pricing";
 import type {CompassActivityType, CompassCareersPartnerType, CompassDeliveryMethod} from "./compassTemplate";
 import type {MisColumnMapping} from "./misSync";
+import type {WexLetterKey, WexLetterOverride} from "./letters";
 
 export type FilterObject = {
     [key: string]: {
@@ -1125,6 +1126,8 @@ export type EmployerField = {
 export type CareersSetupArea = "development"|"destinations";
 
 export type InstituteData = {
+    /** The school's own edited versions of our work experience letters. Missing keys use our default. */
+    wexLetters?: {[key in WexLetterKey]?: WexLetterOverride},
     /** MIS file sync. `mapping` holds the college's own header for any field not named exactly as we specify. */
     mis?: {mapping?: MisColumnMapping},
     students: number,
@@ -1305,6 +1308,9 @@ export type InstituteData = {
      * screen shown before the platform on first sign-in. Registration sets it false;
      * absent means the account predates the screen and is never asked. */
     featureSetupComplete?: boolean,
+    /** Every feature ticked on that screen, including those with no flag of their own yet
+     * (aspirations, leavers, careersLibrary), so the platform knows what to show. */
+    selectedFeatures?: string[],
     deactivated?: boolean,
     isTest?: boolean,
     cohortFilters?: {