placementt-core 1.400.919 → 1.400.921

package/lib/typeDefinitions.d.ts

@@ -424,6 +424,16 @@ export type UserData = {
     referrals?: number;
     shareNameWithReferralLeaderboardConsent?: boolean;
     shareNameWithReferralLeaderboardConsentDate?: boolean;
+    alumniConsent?: boolean;
+    alumniConsentDate?: string;
+    checkInConsent?: boolean;
+    checkInConsentDate?: string;
+    nccisDataSharingConsent?: boolean;
+    nccisDataSharingConsentDate?: string;
+    trustedContact?: TrustedContact;
+    trustedContactConsent?: boolean;
+    trustedContactConsentDate?: string;
+    trustedContactAsked?: boolean;
     referralCode?: string;
     notificationFrequency?: "daily" | "weekly" | "fortnightly" | "never";
     monthAdded?: number;
@@ -2060,14 +2070,14 @@ export type LeaverTransitionData = {
     nccisDataSharingConsent?: boolean;
 };
 /**
- * Consent, contact and alumni opt-in captured on a post-leaving checkpoint when
- * the student never completed the intentions form (checkpoint 1). Mirrors the
- * consent/alumni half of LeaverTransitionData so a leaver who only ever answers
- * the results-day or Christmas form still gives the parent-contact, alumni and
- * NCCIS data-sharing consent that the intentions form would have collected.
- * The destination itself is NOT here — the checkpoint already asks for it.
+ * Consent / one-time capture bundle submitted by the leaver forms. The
+ * destination forms collect these but they are NOT stored on the LeaverRequest —
+ * the backend routes them to the canonical home on UserData (and the Alumni
+ * record), where they are captured once and never re-asked. A given form only
+ * includes the items still outstanding for that leaver (see the needs* flags on
+ * getLeaverCheckpointRequest). The destination itself is not here.
  */
-export type LeaverIntentionsCapture = {
+export type LeaverConsentCapture = {
     becomeAlumni?: boolean;
     mobile?: string;
     linkedinUrl?: string;
@@ -2078,6 +2088,9 @@ export type LeaverIntentionsCapture = {
     checkInConsent?: boolean;
     checkInConsentDate?: string;
     nccisDataSharingConsent?: boolean;
+    /** True when the additional-contact step was shown on this form (given or
+     * declined) — lets the backend mark trustedContactAsked so it isn't re-asked. */
+    additionalContactAsked?: boolean;
 };
 /**
  * Response payload for a post-leaving checkpoint (results day / Christmas).
@@ -2098,9 +2111,13 @@ export type LeaverCheckpointResponse = {
     wellbeingScore?: 1 | 2 | 3 | 4 | 5;
     personalEmail?: string;
     date: string;
-    /** Present only when checkpoint 1 was skipped — the consent/alumni data the
-     * intentions form would have collected, bolted onto this form instead. */
-    intentionsCapture?: LeaverIntentionsCapture;
+    /** Set when the leaver answered the staying-on gate on this form (only shown
+     * when the group permits staying and we didn't already know). true → they're
+     * staying at the school, so the alumni/consent capture is skipped. */
+    stayingAtSchoolSixthForm?: boolean;
+    /** Consent / one-time items still outstanding for this leaver, collected on
+     * this form and routed to UserData by the backend (never stored here). */
+    intentionsCapture?: LeaverConsentCapture;
 };
 /**
  * One per leaver per LeaverGroup — tracks whether the student has completed Form B.
@@ -2113,6 +2130,7 @@ export type LeaverRequest = Omit<AspirationRequest, "cycleId" | "response"> & {
     response?: LeaverTransitionData;
     alumniId?: string;
     intentionsCapturedAt?: string;
+    stayingAtSchoolSixthForm?: boolean;
     personalEmail?: string;
     token?: string;
     tokenExpiry?: string;
@@ -3012,6 +3030,11 @@ export type LeaverGroup = {
     totalInvited?: number;
     totalResponded?: number;
     aggregates?: LeaverAggregates;
+    /** Staff setup flag — true when every student in this group leaves after this
+     * year (no internal sixth-form option). When false/undefined the leaver form
+     * asks "are you staying on?" first, and stayers skip the alumni / consent
+     * capture (and aren't seeded as alumni). */
+    allStudentsLeave?: boolean;
     /** Post-leaving checkpoint schedule. Absent = checkpoints disabled for this group. */
     checkpointConfig?: {
         resultsDay?: {

package/package.json

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

package/src/typeDefinitions.ts

@@ -430,6 +430,23 @@ export type UserData = {
     referrals?: number,
     shareNameWithReferralLeaderboardConsent?: boolean,
     shareNameWithReferralLeaderboardConsentDate?: boolean,
+
+    // ── Leaver / alumni one-time consent (canonical home) ──
+    // Captured once across the leaver forms (Form B / results day / Christmas) and
+    // never re-asked. The leaver forms gate each section on these: `undefined`
+    // means "never asked" (show the page); `true`/`false` means answered (skip it).
+    // Dates are server-stamped ISO strings. These are the source of truth; the
+    // Alumni record holds denormalised copies taken at opt-in.
+    alumniConsent?: boolean,                  // becomeAlumni — only meaningful for leavers, not sixth-form stayers
+    alumniConsentDate?: string,
+    checkInConsent?: boolean,                 // annual check-in (alumni only)
+    checkInConsentDate?: string,
+    nccisDataSharingConsent?: boolean,        // statutory NCCIS destination-tracking consent (all leavers)
+    nccisDataSharingConsentDate?: string,
+    trustedContact?: TrustedContact,          // backup/additional contact
+    trustedContactConsent?: boolean,
+    trustedContactConsentDate?: string,
+    trustedContactAsked?: boolean,            // set once the additional-contact step is submitted (given or declined) so an empty contact isn't re-prompted
     referralCode?: string,
     notificationFrequency?: "daily"|"weekly"|"fortnightly"|"never",
     monthAdded?: number,
@@ -1969,14 +1986,14 @@ export type LeaverTransitionData = {
 }
 
 /**
- * Consent, contact and alumni opt-in captured on a post-leaving checkpoint when
- * the student never completed the intentions form (checkpoint 1). Mirrors the
- * consent/alumni half of LeaverTransitionData so a leaver who only ever answers
- * the results-day or Christmas form still gives the parent-contact, alumni and
- * NCCIS data-sharing consent that the intentions form would have collected.
- * The destination itself is NOT here — the checkpoint already asks for it.
+ * Consent / one-time capture bundle submitted by the leaver forms. The
+ * destination forms collect these but they are NOT stored on the LeaverRequest —
+ * the backend routes them to the canonical home on UserData (and the Alumni
+ * record), where they are captured once and never re-asked. A given form only
+ * includes the items still outstanding for that leaver (see the needs* flags on
+ * getLeaverCheckpointRequest). The destination itself is not here.
  */
-export type LeaverIntentionsCapture = {
+export type LeaverConsentCapture = {
     becomeAlumni?: boolean,
     mobile?: string,
     linkedinUrl?: string,
@@ -1987,6 +2004,9 @@ export type LeaverIntentionsCapture = {
     checkInConsent?: boolean,
     checkInConsentDate?: string,           // server-stamped
     nccisDataSharingConsent?: boolean,
+    /** True when the additional-contact step was shown on this form (given or
+     * declined) — lets the backend mark trustedContactAsked so it isn't re-asked. */
+    additionalContactAsked?: boolean,
 }
 
 /**
@@ -2008,9 +2028,13 @@ export type LeaverCheckpointResponse = {
     wellbeingScore?: 1|2|3|4|5,    // christmas only, optional
     personalEmail?: string,        // lets them update their contact email
     date: string,                  // ISO — server-stamped submission time
-    /** Present only when checkpoint 1 was skipped — the consent/alumni data the
-     * intentions form would have collected, bolted onto this form instead. */
-    intentionsCapture?: LeaverIntentionsCapture,
+    /** Set when the leaver answered the staying-on gate on this form (only shown
+     * when the group permits staying and we didn't already know). true → they're
+     * staying at the school, so the alumni/consent capture is skipped. */
+    stayingAtSchoolSixthForm?: boolean,
+    /** Consent / one-time items still outstanding for this leaver, collected on
+     * this form and routed to UserData by the backend (never stored here). */
+    intentionsCapture?: LeaverConsentCapture,
 }
 
 /**
@@ -2024,6 +2048,7 @@ export type LeaverRequest = Omit<AspirationRequest, "cycleId"|"response"> & {
     response?: LeaverTransitionData,
     alumniId?: string,                  // set when this leaver opted in and an Alumni record was created
     intentionsCapturedAt?: string,      // ISO — set when consent/alumni data was captured via a later checkpoint (intentions form itself was never completed)
+    stayingAtSchoolSixthForm?: boolean, // canonical per-request staying-on answer (from whichever form captured it); gates whether any form re-asks the staying-on question
 
     // ── Post-leaving contact + magic-link auth (set at checkpoint send time) ──
     personalEmail?: string,             // denormalised from response.personalEmail at checkpoint-1 submit
@@ -3000,6 +3025,12 @@ export type LeaverGroup = {
     totalResponded?: number,                    // incremented on each completion
     aggregates?: LeaverAggregates,              // pre-aggregated response data for dashboard charts
 
+    /** Staff setup flag — true when every student in this group leaves after this
+     * year (no internal sixth-form option). When false/undefined the leaver form
+     * asks "are you staying on?" first, and stayers skip the alumni / consent
+     * capture (and aren't seeded as alumni). */
+    allStudentsLeave?: boolean,
+
     /** Post-leaving checkpoint schedule. Absent = checkpoints disabled for this group. */
     checkpointConfig?: {
         resultsDay?: {enabled: boolean, sendAt: string, emailTemplateId?: string},   // ISO datetime