placementt-core 1.400.985 → 1.400.987

package/lib/surveys/types.js

@@ -0,0 +1,25 @@
+"use strict";
+/**
+ * surveys/types.ts — the unified survey engine's data model.
+ *
+ * One shape for every student/alumni survey CareerThread sends: skills surveys,
+ * careers aspiration surveys (Form A), leaver transition forms + their post-leaving
+ * checkpoints (Form B), and annual alumni check-ins. Each is a `SurveyKind`; the
+ * behavioural differences between them live in the registry (./registry), not in
+ * the data model.
+ *
+ * Firestore:
+ *   surveyCycles/{cycleId}    — one scheduled SEND to one cohort
+ *   surveyRequests/{requestId} — one PERSON inside one cycle
+ *
+ * These supersede aspirationCycles/aspirationRequests, leaverGroups/leaverRequests,
+ * skillsAssessmentRequests, and the per-Alumni check-in fields. Migration mapping is
+ * documented per field below and in SURVEY_UNIFICATION_PLAN.md §3.2.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SURVEY_KINDS_LIST = void 0;
+/** Every SurveyKind as a runtime array — for iteration, validation and registry tests. */
+exports.SURVEY_KINDS_LIST = [
+    "skills", "aspirations", "leaverIntentions", "leaverResults", "leaverChristmas", "alumniCheckIn",
+];
+//# sourceMappingURL=types.js.map

package/lib/surveys/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/surveys/types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;GAgBG;;;AAiBH,0FAA0F;AAC7E,QAAA,iBAAiB,GAAiB;IAC3C,QAAQ,EAAE,aAAa,EAAE,kBAAkB,EAAE,eAAe,EAAE,iBAAiB,EAAE,eAAe;CACnG,CAAC"}

package/lib/typeDefinitions.d.ts

@@ -2,6 +2,7 @@ import { DocumentData, DocumentReference, OrderByDirection, Timestamp, WhereFilt
 import { Descendant } from "slate";
 import { emailTemplates, skillLabelColours } from "./constants";
 import type { ChecklistItem, GiftHistory } from "./customerCareConfig";
+import type { SurveySlot } from "./surveys/types";
 export type FilterObject = {
     [key: string]: {
         label: string;
@@ -1918,6 +1919,8 @@ export type EmploymentDetails = {
     sicSection?: string;
     sicLabel?: string;
     employmentStatus: "fullTime" | "partTime" | "selfEmployed" | "contractor" | "zeroHours";
+    /** Optional short free-text description of what the role entails — shown on the journey timeline. */
+    roleDescription?: string;
     employerName?: string;
     employerSize?: "<10" | "10-49" | "50-249" | "250+" | "publicSector";
     isPrimaryJob?: boolean;
@@ -2064,16 +2067,11 @@ export type DestinationsRecipientFilter = {
     e?: WhereFilterOp;
     v: unknown;
 }[];
-/** One scheduled survey in a year's aspiration programme.
- * `rule` (when present) is the source of truth — a relative rule like "first Monday
- * of June", resolved to a concrete date for each academic year at provision time.
- * `sendMMDD` ("MM-DD") is the materialised date (and the sole value on legacy slots);
- * provisioning resolves `rule` for the target year, falling back to `sendMMDD`. */
-export type AspirationSurveySlot = {
-    sendMMDD: string;
-    rule?: SurveyDateRule;
-    label?: string;
-};
+/**
+ * @deprecated Use SurveySlot (surveys/types.ts) — this is now an alias of it.
+ * One scheduled survey in a year's aspiration programme.
+ */
+export type AspirationSurveySlot = SurveySlot;
 /**
  * Per-year-group leaver settings. Used as an override entry in
  * DestinationsConfig.leavers.byYearGroup — each field replaces the shared leaver
@@ -2926,21 +2924,11 @@ export type SurveyDateRule = {
     weekday: SurveyWeekday;
     month: number;
 };
-/** One scheduled skills survey in a group's annual programme.
- * `rule` (when present) is the source of truth — a relative rule like "first Monday
- * of June" resolved to a concrete date for each academic year each September.
- * `sendMMDD` ("MM-DD") is the materialised date for the current academic year (and
- * the sole value on legacy slots created before rules existed); the daily cron fires
- * on it, so it is kept in step with `rule`.
- * Auto-provisioned into each new academic year by the daily cron (mirrors the
- * aspirations AspirationSurveySlot model). */
-export type SkillsSurveySlot = {
-    sendMMDD: string;
-    rule?: SurveyDateRule;
-    label?: string;
-    students?: boolean;
-    parents?: boolean;
-};
+/**
+ * @deprecated Use SurveySlot (surveys/types.ts) — this is now an alias of it.
+ * One scheduled skills survey in a group's annual programme.
+ */
+export type SkillsSurveySlot = SurveySlot;
 /**
  * A staff-defined student group mapping students to the skills they are served on
  * assessments. `filters` keys are student detail field names (from

package/package.json

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

package/src/constants.ts

@@ -1131,60 +1131,12 @@ export const SURVEY_MONTHS = [
     "July", "August", "September", "October", "November", "December",
 ];
 
-const pad2 = (n: number) => String(n).padStart(2, "0");
-
-/**
- * Academic years run September→August. Given the year a school year STARTS in
- * (e.g. 2026 for "2026/27"), return the calendar year the given month falls in:
- * September–December sit in the start year; January–August roll into the next.
- * Mirrors the aspirations mmddToISO boundary (month >= 9 ⇒ start year).
- */
-export const academicCalendarYear = (month: number, academicStartYear: number): number =>
-    month >= 9 ? academicStartYear : academicStartYear + 1;
-
-/**
- * The academic year that a given date falls within, as the START year. From
- * September onwards we are in a new academic year (getMonth() is 0-indexed, so
- * >= 8 is September). Matches DestinationsSetup.currentStartYear.
- */
-export const currentAcademicStartYear = (date = new Date()): number =>
-    date.getMonth() >= 8 ? date.getFullYear() : date.getFullYear() - 1;
-
-/**
- * Resolve a rule to a concrete Date in a specific CALENDAR year+month, e.g.
- * ("first", Monday, June 2027). "last" walks back from the month's final day.
- */
-export const resolveNthWeekday = (
-    calendarYear: number, month: number, ordinal: SurveyOrdinal, weekday: SurveyWeekday,
-): Date => {
-    if (ordinal === "last") {
-        const lastDay = new Date(calendarYear, month, 0).getDate(); // day 0 of next month
-        for (let d = lastDay; d >= 1; d--) {
-            const date = new Date(calendarYear, month - 1, d);
-            if (date.getDay() === weekday) return date;
-        }
-        return new Date(calendarYear, month - 1, lastDay);
-    }
-    const nth = {first: 1, second: 2, third: 3, fourth: 4}[ordinal];
-    let count = 0;
-    const daysInMonth = new Date(calendarYear, month, 0).getDate();
-    for (let d = 1; d <= daysInMonth; d++) {
-        const date = new Date(calendarYear, month - 1, d);
-        if (date.getDay() === weekday && ++count === nth) return date;
-    }
-    // Fewer than `nth` occurrences (e.g. a 5th Monday) — fall back to the last one.
-    return resolveNthWeekday(calendarYear, month, "last", weekday);
-};
-
-/** Resolve a rule to the concrete Date for the academic year starting in academicStartYear. */
-export const surveyRuleToDate = (rule: SurveyDateRule, academicStartYear: number): Date =>
-    resolveNthWeekday(academicCalendarYear(rule.month, academicStartYear), rule.month, rule.ordinal, rule.weekday);
-
-/** Resolve a rule to an "MM-DD" string for the academic year starting in academicStartYear. */
-export const surveyRuleToMMDD = (rule: SurveyDateRule, academicStartYear: number): string => {
-    const d = surveyRuleToDate(rule, academicStartYear);
-    return `${pad2(d.getMonth() + 1)}-${pad2(d.getDate())}`;
-};
+// The rule→date resolvers (academicCalendarYear, currentAcademicStartYear,
+// resolveNthWeekday, surveyRuleToDate, surveyRuleToMMDD) now live in
+// surveys/schedule.ts alongside the rest of the survey engine's scheduling helpers.
+// They are still exported from the package root, so `import {surveyRuleToMMDD} from
+// "placementt-core"` is unchanged. The label constants below stay here: they are
+// editor copy, not scheduling logic.
 
 /** Human label for a rule, e.g. "First Monday of June". */
 export const surveyRuleLabel = (rule: SurveyDateRule): string => {

package/src/index.ts

@@ -9,6 +9,9 @@ export * from "./firebase/firebaseConfig";
 export * from "./firebase/firebaseQuery";
 
 export * from "./typeDefinitions";
+export * from "./surveys/types";
+export * from "./surveys/registry";
+export * from "./surveys/schedule";
 export * from "./skillsResolver";
 export * from "./emailSections";
 export * from "./exportTransformers";