placementt-core 1.400.1228 → 1.400.1229

package/lib/engagementPlan.d.ts

@@ -0,0 +1,101 @@
+import { EngagementPlan, InstituteData } from "./typeDefinitions";
+/**
+ * The school's plan for the year: which term each feature is set up in.
+ *
+ * A school drags each feature it has into a term on its homepage board, and
+ * the engagement engine sends nothing about a feature before that term starts.
+ * Terms rather than months because that is how schools plan, and because we
+ * already work out every school's term dates from the holidays
+ * (outreachRules.ts). A term starts on the day after the summer, Christmas or
+ * Easter holidays; half-terms don't split one.
+ *
+ * Term ids are absolute ("2026-27:spring") so a saved card means the same
+ * thing all year. The board shows them relative: "This term", the rest of
+ * this academic year by name, "Next year" and "Not needed". A plan only
+ * counts in the academic year it was saved in; in September the board asks
+ * again.
+ *
+ * This file is the term arithmetic. Which features go on the board, and the
+ * default term for each, is in featureMarketing.ts, which owns the registry.
+ */
+export type PlanTerm = "autumn" | "spring" | "summer";
+/** A card's term when the feature is not needed this year. */
+export declare const PLAN_NEVER = "never";
+/** A column on the board. `start` is absent on "Not needed". */
+export type PlanColumn = {
+    id: string;
+    label: string;
+    start?: string;
+};
+/**
+ * @param {number} startYear the year the academic year starts in.
+ * @param {PlanTerm} term the term.
+ * @return {string} its id, e.g. "2026-27:spring".
+ */
+export declare const planTermId: (startYear: number, term: PlanTerm) => string;
+/**
+ * The first school day of a term: the day after the holiday before it.
+ *
+ * @param {string} id a term id.
+ * @return {string|undefined} YYYY-MM-DD, or undefined for "never" or a bad id.
+ */
+export declare const planTermStart: (id: string) => string | undefined;
+/**
+ * The term a date belongs to. In term time, the term it is in; in the summer,
+ * Christmas or Easter holidays, the term that comes next.
+ *
+ * @param {string} date YYYY-MM-DD.
+ * @return {string} the term id.
+ */
+export declare const planTermOn: (date: string) => string;
+/**
+ * @param {Date} now the clock.
+ * @return {string} the term it is now, by the rule in planTermOn.
+ */
+export declare const currentPlanTerm: (now: Date) => string;
+/**
+ * The academic year a plan saved now belongs to: the current term's. In the
+ * summer holidays that is the year about to start.
+ *
+ * @param {Date} now the clock.
+ * @return {string} e.g. "2026-27".
+ */
+export declare const planYearOf: (now: Date) => string;
+/**
+ * The board's columns today: this term, the rest of this academic year, next
+ * year (its autumn term) and not needed.
+ *
+ * @param {Date} now the clock.
+ * @return {PlanColumn[]} in board order.
+ */
+export declare const planColumns: (now: Date) => PlanColumn[];
+/**
+ * Which column a term id sits in today. A term already started is "This
+ * term"; one past next autumn is "Next year"; an unknown id is "Not needed".
+ *
+ * @param {string} term a card's term.
+ * @param {Date} now the clock.
+ * @return {string} the column id.
+ */
+export declare const planColumnOf: (term: string, now: Date) => string;
+/**
+ * Where a feature starts on a fresh board: the term its next season starts
+ * in, or this term for one in season now or with no season. Nothing defaults
+ * past next autumn.
+ *
+ * @param {object[]} seasons the feature's "MM-DD" windows, as in featureMarketing.ts.
+ * @param {Date} now the clock.
+ * @return {string} a term id.
+ */
+export declare const defaultPlanTerm: (seasons: {
+    start: string;
+    end: string;
+}[], now: Date) => string;
+/**
+ * The institute's plan, if it was saved this academic year.
+ *
+ * @param {InstituteData} institute the institute.
+ * @param {Date} now the clock.
+ * @return {EngagementPlan|undefined} the plan in force.
+ */
+export declare const savedEngagementPlan: (institute: InstituteData, now: Date) => EngagementPlan | undefined;

package/lib/engagementPlan.js

@@ -0,0 +1,159 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.savedEngagementPlan = exports.defaultPlanTerm = exports.planColumnOf = exports.planColumns = exports.planYearOf = exports.currentPlanTerm = exports.planTermOn = exports.planTermStart = exports.planTermId = exports.PLAN_NEVER = void 0;
+const outreachRules_1 = require("./outreachRules");
+const schedule_1 = require("./surveys/schedule");
+/** A card's term when the feature is not needed this year. */
+exports.PLAN_NEVER = "never";
+const TERMS = ["autumn", "spring", "summer"];
+const TERM_LABELS = { autumn: "Autumn term", spring: "Spring term", summer: "Summer term" };
+/**
+ * @param {number} startYear the year the academic year starts in.
+ * @param {PlanTerm} term the term.
+ * @return {string} its id, e.g. "2026-27:spring".
+ */
+const planTermId = (startYear, term) => `${(0, schedule_1.academicYearLabel)(startYear)}:${term}`;
+exports.planTermId = planTermId;
+const parseTermId = (id) => {
+    const [label, term] = id.split(":");
+    const startYear = Number(label?.slice(0, 4));
+    return startYear && TERMS.includes(term) ? { startYear, term: term } : undefined;
+};
+const holidayEnd = (year, label) => (0, outreachRules_1.schoolHolidays)(year).find((h) => h.label === label).end;
+/**
+ * The first school day of a term: the day after the holiday before it.
+ *
+ * @param {string} id a term id.
+ * @return {string|undefined} YYYY-MM-DD, or undefined for "never" or a bad id.
+ */
+const planTermStart = (id) => {
+    const parsed = parseTermId(id);
+    if (!parsed)
+        return undefined;
+    const { startYear, term } = parsed;
+    if (term === "autumn")
+        return (0, outreachRules_1.addYmdDays)(holidayEnd(startYear, "Summer holidays"), 1);
+    if (term === "spring")
+        return (0, outreachRules_1.addYmdDays)(holidayEnd(startYear, "Christmas holidays"), 1);
+    return (0, outreachRules_1.addYmdDays)(holidayEnd(startYear + 1, "Easter holidays"), 1);
+};
+exports.planTermStart = planTermStart;
+const termsAround = (date) => {
+    const year = Number(date.slice(0, 4));
+    const out = [];
+    for (let y = year - 2; y <= year + 1; y++) {
+        TERMS.forEach((t) => {
+            const id = (0, exports.planTermId)(y, t);
+            out.push({ id, start: (0, exports.planTermStart)(id) });
+        });
+    }
+    return out.sort((a, b) => a.start.localeCompare(b.start));
+};
+/**
+ * The term a date belongs to. In term time, the term it is in; in the summer,
+ * Christmas or Easter holidays, the term that comes next.
+ *
+ * @param {string} date YYYY-MM-DD.
+ * @return {string} the term id.
+ */
+const planTermOn = (date) => {
+    const terms = termsAround(date);
+    const year = Number(date.slice(0, 4));
+    const longHolidays = [year - 1, year].flatMap(outreachRules_1.schoolHolidays)
+        .filter((h) => /Summer|Christmas|Easter/.test(h.label));
+    if ((0, outreachRules_1.blackoutOn)(date, longHolidays))
+        return terms.find((t) => t.start > date).id;
+    return [...terms].reverse().find((t) => t.start <= date)?.id;
+};
+exports.planTermOn = planTermOn;
+/**
+ * @param {Date} now the clock.
+ * @return {string} the term it is now, by the rule in planTermOn.
+ */
+const currentPlanTerm = (now) => (0, exports.planTermOn)((0, outreachRules_1.londonYmd)(now));
+exports.currentPlanTerm = currentPlanTerm;
+/**
+ * The academic year a plan saved now belongs to: the current term's. In the
+ * summer holidays that is the year about to start.
+ *
+ * @param {Date} now the clock.
+ * @return {string} e.g. "2026-27".
+ */
+const planYearOf = (now) => (0, exports.currentPlanTerm)(now).split(":")[0];
+exports.planYearOf = planYearOf;
+/**
+ * The board's columns today: this term, the rest of this academic year, next
+ * year (its autumn term) and not needed.
+ *
+ * @param {Date} now the clock.
+ * @return {PlanColumn[]} in board order.
+ */
+const planColumns = (now) => {
+    const current = parseTermId((0, exports.currentPlanTerm)(now));
+    const columns = TERMS.slice(TERMS.indexOf(current.term)).map((t, i) => {
+        const id = (0, exports.planTermId)(current.startYear, t);
+        return { id, label: i === 0 ? "This term" : TERM_LABELS[t], start: (0, exports.planTermStart)(id) };
+    });
+    const nextYear = (0, exports.planTermId)(current.startYear + 1, "autumn");
+    columns.push({ id: nextYear, label: "Next year", start: (0, exports.planTermStart)(nextYear) });
+    columns.push({ id: exports.PLAN_NEVER, label: "Not needed" });
+    return columns;
+};
+exports.planColumns = planColumns;
+/**
+ * Which column a term id sits in today. A term already started is "This
+ * term"; one past next autumn is "Next year"; an unknown id is "Not needed".
+ *
+ * @param {string} term a card's term.
+ * @param {Date} now the clock.
+ * @return {string} the column id.
+ */
+const planColumnOf = (term, now) => {
+    const columns = (0, exports.planColumns)(now);
+    const start = (0, exports.planTermStart)(term);
+    if (!start)
+        return exports.PLAN_NEVER;
+    const dated = columns.filter((c) => c.start);
+    if (start <= dated[0].start)
+        return dated[0].id;
+    const nextYear = dated[dated.length - 1];
+    if (start >= nextYear.start)
+        return nextYear.id;
+    return dated.find((c) => c.start === start)?.id ?? nextYear.id;
+};
+exports.planColumnOf = planColumnOf;
+const mmdd = (date) => date.slice(5);
+/**
+ * Where a feature starts on a fresh board: the term its next season starts
+ * in, or this term for one in season now or with no season. Nothing defaults
+ * past next autumn.
+ *
+ * @param {object[]} seasons the feature's "MM-DD" windows, as in featureMarketing.ts.
+ * @param {Date} now the clock.
+ * @return {string} a term id.
+ */
+const defaultPlanTerm = (seasons, now) => {
+    const today = (0, outreachRules_1.londonYmd)(now);
+    const md = mmdd(today);
+    const current = (0, exports.currentPlanTerm)(now);
+    const inSeason = seasons.some(({ start, end }) => start <= end ? (md >= start && md <= end) : (md >= start || md <= end));
+    if (!seasons.length || inSeason)
+        return current;
+    const year = Number(today.slice(0, 4));
+    const next = seasons.map((s) => `${s.start > md ? year : year + 1}-${s.start}`).sort()[0];
+    return (0, exports.planColumnOf)((0, exports.planTermOn)(next), now);
+};
+exports.defaultPlanTerm = defaultPlanTerm;
+/**
+ * The institute's plan, if it was saved this academic year.
+ *
+ * @param {InstituteData} institute the institute.
+ * @param {Date} now the clock.
+ * @return {EngagementPlan|undefined} the plan in force.
+ */
+const savedEngagementPlan = (institute, now) => {
+    const plan = institute.engagementPlan;
+    return plan && plan.academicYear === (0, exports.planYearOf)(now) ? plan : undefined;
+};
+exports.savedEngagementPlan = savedEngagementPlan;
+//# sourceMappingURL=engagementPlan.js.map

package/lib/engagementPlan.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"engagementPlan.js","sourceRoot":"","sources":["../src/engagementPlan.ts"],"names":[],"mappings":";;;AACA,mDAAkF;AAClF,iDAAqD;AAwBrD,8DAA8D;AACjD,QAAA,UAAU,GAAG,OAAO,CAAC;AAElC,MAAM,KAAK,GAAe,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;AAEzD,MAAM,WAAW,GAA6B,EAAC,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,aAAa,EAAC,CAAC;AAKpH;;;;GAIG;AACI,MAAM,UAAU,GAAG,CAAC,SAAiB,EAAE,IAAc,EAAU,EAAE,CAAC,GAAG,IAAA,4BAAiB,EAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;AAAtG,QAAA,UAAU,cAA4F;AAEnH,MAAM,WAAW,GAAG,CAAC,EAAU,EAAiD,EAAE;IAC9E,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACpC,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAC7C,OAAO,SAAS,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAgB,CAAC,CAAC,CAAC,CAAC,EAAC,SAAS,EAAE,IAAI,EAAE,IAAgB,EAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAC3G,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,KAAa,EAAU,EAAE,CACtD,IAAA,8BAAc,EAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,KAAK,CAAmB,CAAC,GAAG,CAAC;AAE/E;;;;;GAKG;AACI,MAAM,aAAa,GAAG,CAAC,EAAU,EAAoB,EAAE;IAC1D,MAAM,MAAM,GAAG,WAAW,CAAC,EAAE,CAAC,CAAC;IAC/B,IAAI,CAAC,MAAM;QAAE,OAAO,SAAS,CAAC;IAC9B,MAAM,EAAC,SAAS,EAAE,IAAI,EAAC,GAAG,MAAM,CAAC;IACjC,IAAI,IAAI,KAAK,QAAQ;QAAE,OAAO,IAAA,0BAAU,EAAC,UAAU,CAAC,SAAS,EAAE,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC;IACtF,IAAI,IAAI,KAAK,QAAQ;QAAE,OAAO,IAAA,0BAAU,EAAC,UAAU,CAAC,SAAS,EAAE,oBAAoB,CAAC,EAAE,CAAC,CAAC,CAAC;IACzF,OAAO,IAAA,0BAAU,EAAC,UAAU,CAAC,SAAS,GAAG,CAAC,EAAE,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC;AACvE,CAAC,CAAC;AAPW,QAAA,aAAa,iBAOxB;AAEF,MAAM,WAAW,GAAG,CAAC,IAAY,EAAiC,EAAE;IAChE,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACtC,MAAM,GAAG,GAAkC,EAAE,CAAC;IAC9C,KAAK,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QACxC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YAChB,MAAM,EAAE,GAAG,IAAA,kBAAU,EAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YAC5B,GAAG,CAAC,IAAI,CAAC,EAAC,EAAE,EAAE,KAAK,EAAE,IAAA,qBAAa,EAAC,EAAE,CAAW,EAAC,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;IACP,CAAC;IACD,OAAO,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;AAC9D,CAAC,CAAC;AAEF;;;;;;GAMG;AACI,MAAM,UAAU,GAAG,CAAC,IAAY,EAAU,EAAE;IAC/C,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAChC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACtC,MAAM,YAAY,GAAG,CAAC,IAAI,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,8BAAc,CAAC;SACxD,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IAC5D,IAAI,IAAA,0BAAU,EAAC,IAAI,EAAE,YAAY,CAAC;QAAE,OAAQ,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,CAAkB,CAAC,EAAE,CAAC;IAClG,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,EAAE,EAAY,CAAC;AAC3E,CAAC,CAAC;AAPW,QAAA,UAAU,cAOrB;AAEF;;;GAGG;AACI,MAAM,eAAe,GAAG,CAAC,GAAS,EAAU,EAAE,CAAC,IAAA,kBAAU,EAAC,IAAA,yBAAS,EAAC,GAAG,CAAC,CAAC,CAAC;AAApE,QAAA,eAAe,mBAAqD;AAEjF;;;;;;GAMG;AACI,MAAM,UAAU,GAAG,CAAC,GAAS,EAAU,EAAE,CAAC,IAAA,uBAAe,EAAC,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AAAvE,QAAA,UAAU,cAA6D;AAEpF;;;;;;GAMG;AACI,MAAM,WAAW,GAAG,CAAC,GAAS,EAAgB,EAAE;IACnD,MAAM,OAAO,GAAG,WAAW,CAAC,IAAA,uBAAe,EAAC,GAAG,CAAC,CAAwC,CAAC;IACzF,MAAM,OAAO,GAAiB,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QAChF,MAAM,EAAE,GAAG,IAAA,kBAAU,EAAC,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;QAC5C,OAAO,EAAC,EAAE,EAAE,KAAK,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,IAAA,qBAAa,EAAC,EAAE,CAAC,EAAC,CAAC;IACzF,CAAC,CAAC,CAAC;IACH,MAAM,QAAQ,GAAG,IAAA,kBAAU,EAAC,OAAO,CAAC,SAAS,GAAG,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC7D,OAAO,CAAC,IAAI,CAAC,EAAC,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,IAAA,qBAAa,EAAC,QAAQ,CAAC,EAAC,CAAC,CAAC;IACjF,OAAO,CAAC,IAAI,CAAC,EAAC,EAAE,EAAE,kBAAU,EAAE,KAAK,EAAE,YAAY,EAAC,CAAC,CAAC;IACpD,OAAO,OAAO,CAAC;AACnB,CAAC,CAAC;AAVW,QAAA,WAAW,eAUtB;AAEF;;;;;;;GAOG;AACI,MAAM,YAAY,GAAG,CAAC,IAAY,EAAE,GAAS,EAAU,EAAE;IAC5D,MAAM,OAAO,GAAG,IAAA,mBAAW,EAAC,GAAG,CAAC,CAAC;IACjC,MAAM,KAAK,GAAG,IAAA,qBAAa,EAAC,IAAI,CAAC,CAAC;IAClC,IAAI,CAAC,KAAK;QAAE,OAAO,kBAAU,CAAC;IAC9B,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IAC7C,IAAI,KAAK,IAAK,KAAK,CAAC,CAAC,CAAC,CAAC,KAAgB;QAAE,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5D,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACzC,IAAI,KAAK,IAAK,QAAQ,CAAC,KAAgB;QAAE,OAAO,QAAQ,CAAC,EAAE,CAAC;IAC5D,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,KAAK,CAAC,EAAE,EAAE,IAAI,QAAQ,CAAC,EAAE,CAAC;AACnE,CAAC,CAAC;AATW,QAAA,YAAY,gBASvB;AAEF,MAAM,IAAI,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAErD;;;;;;;;GAQG;AACI,MAAM,eAAe,GAAG,CAAC,OAAuC,EAAE,GAAS,EAAU,EAAE;IAC1F,MAAM,KAAK,GAAG,IAAA,yBAAS,EAAC,GAAG,CAAC,CAAC;IAC7B,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;IACvB,MAAM,OAAO,GAAG,IAAA,uBAAe,EAAC,GAAG,CAAC,CAAC;IACrC,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,EAAC,KAAK,EAAE,GAAG,EAAC,EAAE,EAAE,CAAC,KAAK,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,KAAK,IAAI,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,KAAK,IAAI,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC;IACxH,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,QAAQ;QAAE,OAAO,OAAO,CAAC;IAChD,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACvC,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAC1F,OAAO,IAAA,oBAAY,EAAC,IAAA,kBAAU,EAAC,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;AAC/C,CAAC,CAAC;AATW,QAAA,eAAe,mBAS1B;AAEF;;;;;;GAMG;AACI,MAAM,mBAAmB,GAAG,CAAC,SAAwB,EAAE,GAAS,EAA4B,EAAE;IACjG,MAAM,IAAI,GAAG,SAAS,CAAC,cAAc,CAAC;IACtC,OAAO,IAAI,IAAI,IAAI,CAAC,YAAY,KAAK,IAAA,kBAAU,EAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;AAC5E,CAAC,CAAC;AAHW,QAAA,mBAAmB,uBAG9B"}

package/lib/engagementPlan.test.d.ts

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

package/lib/engagementPlan.test.js

@@ -0,0 +1,171 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+jest.mock("firebase/firestore", () => ({ where: jest.fn() }));
+jest.mock("./firebase/firebaseQuery", () => ({ __esModule: true, default: class {
+    } }));
+const productResolver_1 = require("./productResolver");
+const engagementPlan_1 = require("./engagementPlan");
+const featureMarketing_1 = require("./featureMarketing");
+const onboardingPathways_1 = require("./onboardingPathways");
+const NOVEMBER = new Date("2026-11-02T09:00:00Z");
+/** A school that has bought everything and set up nothing. */
+const school = (overrides = {}) => ({
+    name: "Calder Park Academy",
+    package: "institutes-one",
+    workExperience: true,
+    employerEvents: true,
+    destinationTracking: true,
+    alumniManagement: true,
+    skillsAssessmentsProduct: true,
+    trackExtracurriculars: true,
+    ...overrides,
+});
+const ctx = (institute, counts = {}, now = NOVEMBER) => ({
+    institute,
+    products: (0, productResolver_1.resolveProducts)(institute, { parentCount: counts.parents || 0 }),
+    counts,
+    now,
+});
+const plan = (cards, academicYear = "2026-27") => ({ engagementPlan: { academicYear, cards, savedAt: "2026-11-02T09:00:00Z", savedBy: "u1" } });
+describe("terms", () => {
+    it("starts each term the day after the long holiday before it", () => {
+        expect((0, engagementPlan_1.planTermStart)("2026-27:autumn")).toBe("2026-09-07");
+        expect((0, engagementPlan_1.planTermStart)("2026-27:spring")).toBe("2027-01-04");
+        expect((0, engagementPlan_1.planTermStart)("2026-27:summer")).toBe("2027-04-10");
+        expect((0, engagementPlan_1.planTermStart)(engagementPlan_1.PLAN_NEVER)).toBeUndefined();
+    });
+    it("puts a long holiday in the term after it, and a half-term in its own", () => {
+        expect((0, engagementPlan_1.planTermOn)("2026-10-28")).toBe("2026-27:autumn");
+        expect((0, engagementPlan_1.planTermOn)("2026-12-21")).toBe("2026-27:spring");
+        expect((0, engagementPlan_1.planTermOn)("2026-08-10")).toBe("2026-27:autumn");
+        expect((0, engagementPlan_1.planTermOn)("2027-02-17")).toBe("2026-27:spring");
+    });
+    it("rolls the plan year over in the summer holidays", () => {
+        expect((0, engagementPlan_1.planYearOf)(new Date("2027-07-01T09:00:00Z"))).toBe("2026-27");
+        expect((0, engagementPlan_1.planYearOf)(new Date("2027-08-10T09:00:00Z"))).toBe("2027-28");
+    });
+    it("shows this term, the rest of the year, next year and not needed", () => {
+        expect((0, engagementPlan_1.planColumns)(NOVEMBER).map((c) => [c.id, c.label])).toEqual([
+            ["2026-27:autumn", "This term"],
+            ["2026-27:spring", "Spring term"],
+            ["2026-27:summer", "Summer term"],
+            ["2027-28:autumn", "Next year"],
+            [engagementPlan_1.PLAN_NEVER, "Not needed"],
+        ]);
+        expect((0, engagementPlan_1.planColumns)(new Date("2027-05-10T09:00:00Z")).map((c) => c.label))
+            .toEqual(["This term", "Next year", "Not needed"]);
+    });
+    it("files a started term under this term, and anything later than next autumn under next year", () => {
+        expect((0, engagementPlan_1.planColumnOf)("2026-27:autumn", new Date("2027-01-20T09:00:00Z"))).toBe("2026-27:spring");
+        expect((0, engagementPlan_1.planColumnOf)("2028-29:spring", NOVEMBER)).toBe("2027-28:autumn");
+        expect((0, engagementPlan_1.planColumnOf)("nonsense", NOVEMBER)).toBe(engagementPlan_1.PLAN_NEVER);
+    });
+    it("defaults a feature to the term its next season starts in", () => {
+        expect((0, engagementPlan_1.defaultPlanTerm)([], NOVEMBER)).toBe("2026-27:autumn");
+        expect((0, engagementPlan_1.defaultPlanTerm)([{ start: "11-01", end: "11-30" }], NOVEMBER)).toBe("2026-27:autumn");
+        expect((0, engagementPlan_1.defaultPlanTerm)([{ start: "01-05", end: "02-15" }], NOVEMBER)).toBe("2026-27:spring");
+        expect((0, engagementPlan_1.defaultPlanTerm)([{ start: "05-01", end: "07-15" }], NOVEMBER)).toBe("2026-27:summer");
+        expect((0, engagementPlan_1.defaultPlanTerm)([{ start: "09-01", end: "10-31" }], NOVEMBER)).toBe("2027-28:autumn");
+    });
+});
+describe("board", () => {
+    it("lays out the agreed defaults for a school joining in November", () => {
+        const terms = Object.fromEntries((0, featureMarketing_1.engagementPlanBoard)(ctx(school())).map((c) => [c.key, c.term]));
+        expect(terms).toEqual({
+            wexCohort: "2026-27:autumn",
+            guidance: "2026-27:autumn",
+            events: "2026-27:autumn",
+            employerPortal: "2026-27:autumn",
+            careersLibrary: "2026-27:autumn",
+            aspirations: "2026-27:spring",
+            skills: "2026-27:spring",
+            activities: "2026-27:spring",
+            leavers: "2026-27:spring",
+            alumni: "2026-27:summer",
+            parents: "2027-28:autumn",
+        });
+    });
+    it("leaves the impact report off, and gives trusts and hubs no board", () => {
+        expect((0, featureMarketing_1.engagementPlanBoard)(ctx(school())).map((c) => c.key)).not.toContain("impactReport");
+        expect((0, featureMarketing_1.engagementPlanBoard)(ctx(school({ package: "institutes-two" })))).toEqual([]);
+        expect((0, featureMarketing_1.engagementPlanBoard)(ctx(school({ package: "careersHub" })))).toEqual([]);
+    });
+    it("uses the school's terms and order, and defaults for anything it has not placed", () => {
+        const board = (0, featureMarketing_1.engagementPlanBoard)(ctx(school(plan({
+            careersLibrary: { term: "2026-27:autumn", order: 1 },
+            activities: { term: "2026-27:autumn", order: 0 },
+            leavers: { term: engagementPlan_1.PLAN_NEVER, order: 0 },
+        }))));
+        expect(board.slice(0, 2).map((c) => c.key)).toEqual(["activities", "careersLibrary"]);
+        expect(board.find((c) => c.key === "leavers")?.term).toBe(engagementPlan_1.PLAN_NEVER);
+        expect(board[board.length - 1].key).toBe("leavers");
+        expect(board.find((c) => c.key === "alumni")?.term).toBe("2026-27:summer");
+    });
+    it("ignores a plan from last year", () => {
+        const institute = school(plan({ activities: { term: "2025-26:autumn", order: 0 } }, "2025-26"));
+        expect((0, engagementPlan_1.savedEngagementPlan)(institute, NOVEMBER)).toBeUndefined();
+        expect((0, featureMarketing_1.engagementPlanBoard)(ctx(institute)).find((c) => c.key === "activities")?.term).toBe("2026-27:spring");
+    });
+});
+describe("engine", () => {
+    it("pitches by season when there is no plan", () => {
+        const keys = (0, featureMarketing_1.featureMarketingCandidates)(ctx(school())).map((f) => f.key);
+        expect(keys).toContain("wexCohort");
+        expect(keys).not.toContain("activities");
+    });
+    it("pitches what the plan puts in this term, in the school's order, whatever the season", () => {
+        const c = ctx(school(plan({
+            activities: { term: "2026-27:autumn", order: 0 },
+            wexCohort: { term: "2026-27:spring", order: 0 },
+            leavers: { term: "2026-27:autumn", order: 1 },
+        })));
+        const keys = (0, featureMarketing_1.featureMarketingCandidates)(c).map((f) => f.key);
+        expect(keys.slice(0, 2)).toEqual(["activities", "leavers"]);
+        expect(keys).not.toContain("wexCohort");
+        expect((0, featureMarketing_1.evaluateFeatureAdoption)(c).find((a) => a.key === "wexCohort")?.planOpen).toBe(false);
+    });
+    it("never pitches a feature marked not needed", () => {
+        const c = ctx(school(plan({ guidance: { term: engagementPlan_1.PLAN_NEVER, order: 0 } })));
+        expect((0, featureMarketing_1.featureMarketingCandidates)(c).map((f) => f.key)).not.toContain("guidance");
+    });
+    it("skips an onboarding step whose term has not started, and offers the next open one", () => {
+        // Students in, aspirations set up, so destinations has begun and its
+        // next step would be leaver tracking. No work experience, whose
+        // pathway would otherwise come first.
+        const base = school({
+            workExperience: false,
+            destinationsConfig: { setupCompletedAt: "2026-09-10", aspirations: { enabled: true } },
+        });
+        const counts = { students: 100, surveyScopesThisYear: ["aspirations"] };
+        expect((0, onboardingPathways_1.nextOnboardingStep)({ ...ctx(base, counts), counts })?.step.key).toBe("destinations.leavers");
+        const planned = { ...base, ...plan({ leavers: { term: "2026-27:summer", order: 0 }, alumni: { term: "2026-27:autumn", order: 0 } }) };
+        expect((0, onboardingPathways_1.nextOnboardingStep)({ ...ctx(planned, counts), counts })?.step.key).toBe("destinations.alumni");
+    });
+});
+describe("moving one card from an email link", () => {
+    it("keeps every other card where it sits and puts the moved one last in its new column", () => {
+        const cards = (0, featureMarketing_1.engagementPlanCardsAfterMove)(ctx(school()), "careersLibrary", "2026-27:spring");
+        expect(cards.careersLibrary.term).toBe("2026-27:spring");
+        const spring = Object.entries(cards).filter(([, c]) => c.term === "2026-27:spring");
+        expect(cards.careersLibrary.order).toBe(spring.length - 1);
+        expect(cards.wexCohort.term).toBe("2026-27:autumn");
+        expect(Object.keys(cards)).toHaveLength(11);
+    });
+    it("can mark a feature not needed", () => {
+        expect((0, featureMarketing_1.engagementPlanCardsAfterMove)(ctx(school()), "leavers", engagementPlan_1.PLAN_NEVER).leavers).toEqual({ term: engagementPlan_1.PLAN_NEVER, order: 0 });
+    });
+    it("ignores a feature the school does not have", () => {
+        const cards = (0, featureMarketing_1.engagementPlanCardsAfterMove)(ctx(school({ alumniManagement: false })), "alumni", engagementPlan_1.PLAN_NEVER);
+        expect(cards.alumni).toBeUndefined();
+    });
+});
+describe("planFeatureOf", () => {
+    it("finds the board feature behind a pitch or a step", () => {
+        expect((0, onboardingPathways_1.planFeatureOf)("marketing", "alumni")).toBe("alumni");
+        expect((0, onboardingPathways_1.planFeatureOf)("marketing", "impactReport")).toBeUndefined();
+        expect((0, onboardingPathways_1.planFeatureOf)("onboarding", "wex.placements")).toBe("wexCohort");
+        expect((0, onboardingPathways_1.planFeatureOf)("onboarding", "skills.guidance")).toBe("guidance");
+        expect((0, onboardingPathways_1.planFeatureOf)("onboarding", "students")).toBeUndefined();
+    });
+});
+//# sourceMappingURL=engagementPlan.test.js.map

package/lib/engagementPlan.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"engagementPlan.test.js","sourceRoot":"","sources":["../src/engagementPlan.test.ts"],"names":[],"mappings":";;AAAA,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE,GAAG,EAAE,CAAC,CAAC,EAAC,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE,EAAC,CAAC,CAAC,CAAC;AAC5D,IAAI,CAAC,IAAI,CAAC,0BAA0B,EAAE,GAAG,EAAE,CAAC,CAAC,EAAC,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE;KAAQ,EAAC,CAAC,CAAC,CAAC;AAGrF,uDAAkD;AAClD,qDAS0B;AAC1B,yDAO4B;AAC5B,6DAAuE;AAEvE,MAAM,QAAQ,GAAG,IAAI,IAAI,CAAC,sBAAsB,CAAC,CAAC;AAElD,8DAA8D;AAC9D,MAAM,MAAM,GAAG,CAAC,YAAoC,EAAE,EAAiB,EAAE,CAAC,CAAC;IACvE,IAAI,EAAE,qBAAqB;IAC3B,OAAO,EAAE,gBAAgB;IACzB,cAAc,EAAE,IAAI;IACpB,cAAc,EAAE,IAAI;IACpB,mBAAmB,EAAE,IAAI;IACzB,gBAAgB,EAAE,IAAI;IACtB,wBAAwB,EAAE,IAAI;IAC9B,qBAAqB,EAAE,IAAI;IAC3B,GAAG,SAAS;CACG,CAAA,CAAC;AAEpB,MAAM,GAAG,GAAG,CAAC,SAAwB,EAAE,SAAiC,EAAE,EAAE,GAAG,GAAG,QAAQ,EAA2B,EAAE,CAAC,CAAC;IACrH,SAAS;IACT,QAAQ,EAAE,IAAA,iCAAe,EAAC,SAAS,EAAE,EAAC,WAAW,EAAE,MAAM,CAAC,OAAO,IAAI,CAAC,EAAC,CAAC;IACxE,MAAM;IACN,GAAG;CACN,CAAC,CAAC;AAEH,MAAM,IAAI,GAAG,CAAC,KAAqD,EAAE,YAAY,GAAG,SAAS,EAAE,EAAE,CAC7F,CAAC,EAAC,cAAc,EAAE,EAAC,YAAY,EAAE,KAAK,EAAE,OAAO,EAAE,sBAAsB,EAAE,OAAO,EAAE,IAAI,EAAC,EAAC,CAAC,CAAC;AAE9F,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE;IACnB,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;QACjE,MAAM,CAAC,IAAA,8BAAa,EAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC3D,MAAM,CAAC,IAAA,8BAAa,EAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC3D,MAAM,CAAC,IAAA,8BAAa,EAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC3D,MAAM,CAAC,IAAA,8BAAa,EAAC,2BAAU,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sEAAsE,EAAE,GAAG,EAAE;QAC5E,MAAM,CAAC,IAAA,2BAAU,EAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACxD,MAAM,CAAC,IAAA,2BAAU,EAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACxD,MAAM,CAAC,IAAA,2BAAU,EAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACxD,MAAM,CAAC,IAAA,2BAAU,EAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;QACvD,MAAM,CAAC,IAAA,2BAAU,EAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACrE,MAAM,CAAC,IAAA,2BAAU,EAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACzE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;QACvE,MAAM,CAAC,IAAA,4BAAW,EAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;YAC9D,CAAC,gBAAgB,EAAE,WAAW,CAAC;YAC/B,CAAC,gBAAgB,EAAE,aAAa,CAAC;YACjC,CAAC,gBAAgB,EAAE,aAAa,CAAC;YACjC,CAAC,gBAAgB,EAAE,WAAW,CAAC;YAC/B,CAAC,2BAAU,EAAE,YAAY,CAAC;SAC7B,CAAC,CAAC;QACH,MAAM,CAAC,IAAA,4BAAW,EAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;aACpE,OAAO,CAAC,CAAC,WAAW,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2FAA2F,EAAE,GAAG,EAAE;QACjG,MAAM,CAAC,IAAA,6BAAY,EAAC,gBAAgB,EAAE,IAAI,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAChG,MAAM,CAAC,IAAA,6BAAY,EAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACxE,MAAM,CAAC,IAAA,6BAAY,EAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,2BAAU,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0DAA0D,EAAE,GAAG,EAAE;QAChE,MAAM,CAAC,IAAA,gCAAe,EAAC,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC7D,MAAM,CAAC,IAAA,gCAAe,EAAC,CAAC,EAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC3F,MAAM,CAAC,IAAA,gCAAe,EAAC,CAAC,EAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC3F,MAAM,CAAC,IAAA,gCAAe,EAAC,CAAC,EAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC3F,MAAM,CAAC,IAAA,gCAAe,EAAC,CAAC,EAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAC/F,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE;IACnB,EAAE,CAAC,+DAA+D,EAAE,GAAG,EAAE;QACrE,MAAM,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC,IAAA,sCAAmB,EAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjG,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;YAClB,SAAS,EAAE,gBAAgB;YAC3B,QAAQ,EAAE,gBAAgB;YAC1B,MAAM,EAAE,gBAAgB;YACxB,cAAc,EAAE,gBAAgB;YAChC,cAAc,EAAE,gBAAgB;YAChC,WAAW,EAAE,gBAAgB;YAC7B,MAAM,EAAE,gBAAgB;YACxB,UAAU,EAAE,gBAAgB;YAC5B,OAAO,EAAE,gBAAgB;YACzB,MAAM,EAAE,gBAAgB;YACxB,OAAO,EAAE,gBAAgB;SAC5B,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kEAAkE,EAAE,GAAG,EAAE;QACxE,MAAM,CAAC,IAAA,sCAAmB,EAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;QAC3F,MAAM,CAAC,IAAA,sCAAmB,EAAC,GAAG,CAAC,MAAM,CAAC,EAAC,OAAO,EAAE,gBAAgB,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAClF,MAAM,CAAC,IAAA,sCAAmB,EAAC,GAAG,CAAC,MAAM,CAAC,EAAC,OAAO,EAAE,YAAY,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAClF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gFAAgF,EAAE,GAAG,EAAE;QACtF,MAAM,KAAK,GAAG,IAAA,sCAAmB,EAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC;YAC9C,cAAc,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAE,KAAK,EAAE,CAAC,EAAC;YAClD,UAAU,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAE,KAAK,EAAE,CAAC,EAAC;YAC9C,OAAO,EAAE,EAAC,IAAI,EAAE,2BAAU,EAAE,KAAK,EAAE,CAAC,EAAC;SACxC,CAAC,CAAC,CAAC,CAAC,CAAC;QACN,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,gBAAgB,CAAC,CAAC,CAAC;QACtF,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,SAAS,CAAC,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,2BAAU,CAAC,CAAC;QACtE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACpD,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,QAAQ,CAAC,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAC/E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;QACrC,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,EAAC,UAAU,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAE,KAAK,EAAE,CAAC,EAAC,EAAC,EAAE,SAAS,CAAC,CAAC,CAAC;QAC5F,MAAM,CAAC,IAAA,oCAAmB,EAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;QACjE,MAAM,CAAC,IAAA,sCAAmB,EAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,YAAY,CAAC,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IACjH,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;IACpB,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;QAC/C,MAAM,IAAI,GAAG,IAAA,6CAA0B,EAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QACzE,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QACpC,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qFAAqF,EAAE,GAAG,EAAE;QAC3F,MAAM,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC;YACtB,UAAU,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAE,KAAK,EAAE,CAAC,EAAC;YAC9C,SAAS,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAE,KAAK,EAAE,CAAC,EAAC;YAC7C,OAAO,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAE,KAAK,EAAE,CAAC,EAAC;SAC9C,CAAC,CAAC,CAAC,CAAC;QACL,MAAM,IAAI,GAAG,IAAA,6CAA0B,EAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QAC7D,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;QAC5D,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QACxC,MAAM,CAAC,IAAA,0CAAuB,EAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,WAAW,CAAC,EAAE,QAAQ,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChG,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACjD,MAAM,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,EAAC,QAAQ,EAAE,EAAC,IAAI,EAAE,2BAAU,EAAE,KAAK,EAAE,CAAC,EAAC,EAAC,CAAC,CAAC,CAAC,CAAC;QACtE,MAAM,CAAC,IAAA,6CAA0B,EAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IACtF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mFAAmF,EAAE,GAAG,EAAE;QACzF,qEAAqE;QACrE,gEAAgE;QAChE,sCAAsC;QACtC,MAAM,IAAI,GAAG,MAAM,CAAC;YAChB,cAAc,EAAE,KAAK;YACrB,kBAAkB,EAAE,EAAC,gBAAgB,EAAE,YAAY,EAAE,WAAW,EAAE,EAAC,OAAO,EAAE,IAAI,EAAC,EAAC;SAC3D,CAAC,CAAC;QAC7B,MAAM,MAAM,GAAgD,EAAC,QAAQ,EAAE,GAAG,EAAE,oBAAoB,EAAE,CAAC,aAAa,CAAC,EAAC,CAAC;QACnH,MAAM,CAAC,IAAA,uCAAkB,EAAC,EAAC,GAAG,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,MAAM,EAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;QAElG,MAAM,OAAO,GAAG,EAAC,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC,EAAC,OAAO,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAE,KAAK,EAAE,CAAC,EAAC,EAAE,MAAM,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAE,KAAK,EAAE,CAAC,EAAC,EAAC,CAAC,EAAkB,CAAC;QAC/I,MAAM,CAAC,IAAA,uCAAkB,EAAC,EAAC,GAAG,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,MAAM,EAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;IACxG,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,oCAAoC,EAAE,GAAG,EAAE;IAChD,EAAE,CAAC,oFAAoF,EAAE,GAAG,EAAE;QAC1F,MAAM,KAAK,GAAG,IAAA,+CAA4B,EAAC,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,gBAAgB,EAAE,gBAAgB,CAAC,CAAC;QAC9F,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACzD,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,gBAAgB,CAAC,CAAC;QACpF,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC3D,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACpD,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;IAChD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;QACrC,MAAM,CAAC,IAAA,+CAA4B,EAAC,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,2BAAU,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,EAAC,IAAI,EAAE,2BAAU,EAAE,KAAK,EAAE,CAAC,EAAC,CAAC,CAAC;IAC7H,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QAClD,MAAM,KAAK,GAAG,IAAA,+CAA4B,EAAC,GAAG,CAAC,MAAM,CAAC,EAAC,gBAAgB,EAAE,KAAK,EAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,2BAAU,CAAC,CAAC;QACzG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,aAAa,EAAE,CAAC;IACzC,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC3B,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;QACxD,MAAM,CAAC,IAAA,kCAAa,EAAC,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC5D,MAAM,CAAC,IAAA,kCAAa,EAAC,WAAW,EAAE,cAAc,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;QACnE,MAAM,CAAC,IAAA,kCAAa,EAAC,YAAY,EAAE,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACxE,MAAM,CAAC,IAAA,kCAAa,EAAC,YAAY,EAAE,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxE,MAAM,CAAC,IAAA,kCAAa,EAAC,YAAY,EAAE,UAAU,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;IACpE,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/lib/featureMarketing.d.ts

@@ -164,9 +164,69 @@ export type FeatureAdoption = {
     inSeason: boolean;
     /** Offered and, where the feature asks, with data behind it. */
     ready: boolean;
-    /** Offered, ready, not adopted and in season: a campaign could start today. */
+    /** The school's saved plan has reached this feature's term. Undefined
+     * with no plan saved this year, when the season decides instead. */
+    planOpen?: boolean;
+    /** Offered, ready, not adopted and due: in its planned term when the
+     * school has a plan, in season when it has not. A campaign could start today. */
     candidate: boolean;
 };
+/** One feature on the plan board. */
+export type EngagementPlanBoardCard = {
+    key: FeatureMarketingKey;
+    label: string;
+    description: string;
+    /** A term id, or PLAN_NEVER. */
+    term: string;
+    order: number;
+};
+/**
+ * Whether an account plans its year at all: schools running their own
+ * careers programme. Trusts, hubs and hub schools drive somebody else's.
+ *
+ * @param {FeatureMarketingContext} ctx the institute and its products.
+ * @return {boolean} whether it gets the board.
+ */
+export declare const hasEngagementPlan: (ctx: FeatureMarketingContext) => boolean;
+/**
+ * The board: every feature the school has, in the term the school put it in,
+ * or its default for a feature it has not placed (no plan yet, or a feature
+ * switched on since). Default order is the registry priority, after anything
+ * the school placed itself.
+ *
+ * @param {FeatureMarketingContext} ctx the institute and its products.
+ * @return {EngagementPlanBoardCard[]} the cards, earliest term first, then by order.
+ */
+export declare const engagementPlanBoard: (ctx: FeatureMarketingContext) => EngagementPlanBoardCard[];
+/**
+ * The plan to save when one card moves, from an email link rather than the
+ * board: every card where it sits now (defaults included, so the school's
+ * board stops following the seasons and starts following this plan), with the
+ * moved card last in its new column.
+ *
+ * @param {FeatureMarketingContext} ctx the institute and its products.
+ * @param {FeatureMarketingKey} key the feature to move.
+ * @param {string} term the column to move it to: a term id or PLAN_NEVER.
+ * @return {object} the `cards` of the plan to save.
+ */
+export declare const engagementPlanCardsAfterMove: (ctx: FeatureMarketingContext, key: FeatureMarketingKey, term: string) => {
+    [key: string]: {
+        term: string;
+        order: number;
+    };
+};
+/**
+ * Where the school's saved plan puts one feature: whether its term has
+ * started, and its rank against the others.
+ *
+ * @param {FeatureMarketingContext} ctx the institute.
+ * @param {FeatureMarketingKey} key the feature.
+ * @return {object|undefined} open and rank, or undefined with no plan saved this year.
+ */
+export declare const featurePlanStatus: (ctx: FeatureMarketingContext, key: FeatureMarketingKey) => {
+    open: boolean;
+    rank: number;
+} | undefined;
 /**
  * Every feature in the registry, judged for one institute.
  *
@@ -174,12 +234,16 @@ export type FeatureAdoption = {
  * from `candidate`, the admin panel shows adoption per feature, and a test can
  * assert on any one line without re-running the detectors.
  *
+ * A saved plan overrides the seasons: a school that put leaver tracking in
+ * the autumn hears about it in the autumn.
+ *
  * @param {FeatureMarketingContext} ctx the institute, its products and counts.
  * @return {FeatureAdoption[]} one line per feature, in registry order.
  */
 export declare const evaluateFeatureAdoption: (ctx: FeatureMarketingContext) => FeatureAdoption[];
 /**
- * The features a campaign could start for today, best first.
+ * The features a campaign could start for today, best first: in the school's
+ * plan order when it has one, by registry priority when it has not.
  *
  * @param {FeatureMarketingContext} ctx the institute, its products and counts.
  * @return {FeatureMarketingEntry[]} candidates in priority order.