placementt-core 1.400.1080 → 1.400.1081

package/lib/activityLogging.d.ts

@@ -0,0 +1,67 @@
+import { ActivityLoggingConfig, InstituteData } from "./typeDefinitions";
+/**
+ * Whether a student can log activities, and whether we may email them about it.
+ *
+ * Two different switches are easy to confuse here, so they are named apart:
+ *
+ * - `trackExtracurriculars` is the PRODUCT. Absent means on, which is right for
+ *   staff: a school that has never touched the switch still gets the Activities
+ *   area, its analytics and its Gatsby reporting.
+ * - `activityLogging` is the LAUNCH. It is what a school says to its students, and
+ *   absent means nothing has been said. A feature that appears in a pupil's account
+ *   unannounced gets used by nobody and asked about by everybody, so a year group
+ *   sees activity logging only once the school has launched it to them.
+ *
+ * The launch is per year group and, unless the school says otherwise, per academic
+ * year: last year's Year 11 is not this year's Year 11, and a school introducing it
+ * to each new cohort in assembly should not find it already live.
+ */
+/** Does the school have the Activities area at all? Absent means yes. */
+export declare const activityLoggingProductOn: (institute?: Pick<InstituteData, "trackExtracurriculars">) => boolean;
+/**
+ * Does the stored launch still count today?
+ *
+ * A launch is made for one academic year. With `rollOver` on it carries forward
+ * forever; without it, September spends it.
+ *
+ * @param {ActivityLoggingConfig} [config] the school's launch.
+ * @param {Date} [now] the date to judge it against.
+ * @return {boolean} whether the year groups below are live.
+ */
+export declare const activityLaunchCurrent: (config?: ActivityLoggingConfig, now?: Date) => boolean;
+/**
+ * The year groups activity logging is live for right now.
+ *
+ * @param {InstituteData} [institute] the school.
+ * @param {Date} [now] the date to judge the launch against.
+ * @return {string[]} the year group tags, empty when nothing is live.
+ */
+export declare const activityLoggingLiveYearGroups: (institute?: InstituteData, now?: Date) => string[];
+/**
+ * Can THIS student log activities, and may we email them about it?
+ *
+ * The one gate every student-facing surface asks. A student with no year group on
+ * their record is not in a launched year group, so the answer is no — which is the
+ * safe way round: they see nothing rather than being shown something their school
+ * hasn't announced.
+ *
+ * @param {InstituteData} [institute] their school.
+ * @param {string} [yearGroup] their year group tag, as their record holds it.
+ * @param {Date} [now] the date to judge the launch against.
+ * @return {boolean} whether activity logging is live for them.
+ */
+export declare const activityLoggingLive: (institute?: InstituteData, yearGroup?: string, now?: Date) => boolean;
+/** Where a school's activity logging stands, in the vocabulary the careers year
+ * setup uses for every other programme. */
+export type ActivityLoggingState = "unconfigured" | "needsLaunch" | "live";
+/**
+ * Has this school launched activity logging, and does the launch still stand?
+ *
+ * The three answers are the three different things to do about it: ask the setup
+ * questions, re-launch a year that has rolled over, or nothing.
+ *
+ * @param {InstituteData} [institute] the school.
+ * @param {Date} [now] the date to judge the launch against.
+ * @return {ActivityLoggingState} what is left to do.
+ */
+export declare const activityLoggingState: (institute?: InstituteData, now?: Date) => ActivityLoggingState;

package/lib/activityLogging.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.activityLoggingState = exports.activityLoggingLive = exports.activityLoggingLiveYearGroups = exports.activityLaunchCurrent = exports.activityLoggingProductOn = void 0;
+const schedule_1 = require("./surveys/schedule");
+/**
+ * Whether a student can log activities, and whether we may email them about it.
+ *
+ * Two different switches are easy to confuse here, so they are named apart:
+ *
+ * - `trackExtracurriculars` is the PRODUCT. Absent means on, which is right for
+ *   staff: a school that has never touched the switch still gets the Activities
+ *   area, its analytics and its Gatsby reporting.
+ * - `activityLogging` is the LAUNCH. It is what a school says to its students, and
+ *   absent means nothing has been said. A feature that appears in a pupil's account
+ *   unannounced gets used by nobody and asked about by everybody, so a year group
+ *   sees activity logging only once the school has launched it to them.
+ *
+ * The launch is per year group and, unless the school says otherwise, per academic
+ * year: last year's Year 11 is not this year's Year 11, and a school introducing it
+ * to each new cohort in assembly should not find it already live.
+ */
+/** Does the school have the Activities area at all? Absent means yes. */
+const activityLoggingProductOn = (institute) => institute?.trackExtracurriculars !== false;
+exports.activityLoggingProductOn = activityLoggingProductOn;
+/**
+ * Does the stored launch still count today?
+ *
+ * A launch is made for one academic year. With `rollOver` on it carries forward
+ * forever; without it, September spends it.
+ *
+ * @param {ActivityLoggingConfig} [config] the school's launch.
+ * @param {Date} [now] the date to judge it against.
+ * @return {boolean} whether the year groups below are live.
+ */
+const activityLaunchCurrent = (config, now = new Date()) => {
+    if (!config?.launchedYear)
+        return false;
+    return Boolean(config.rollOver) || config.launchedYear === (0, schedule_1.academicYearOf)(now);
+};
+exports.activityLaunchCurrent = activityLaunchCurrent;
+/**
+ * The year groups activity logging is live for right now.
+ *
+ * @param {InstituteData} [institute] the school.
+ * @param {Date} [now] the date to judge the launch against.
+ * @return {string[]} the year group tags, empty when nothing is live.
+ */
+const activityLoggingLiveYearGroups = (institute, now = new Date()) => {
+    if (!(0, exports.activityLoggingProductOn)(institute))
+        return [];
+    const config = institute?.activityLogging;
+    if (!(0, exports.activityLaunchCurrent)(config, now))
+        return [];
+    return Object.entries(config?.yearGroups || {}).filter(([, on]) => on).map(([yg]) => yg);
+};
+exports.activityLoggingLiveYearGroups = activityLoggingLiveYearGroups;
+/**
+ * Can THIS student log activities, and may we email them about it?
+ *
+ * The one gate every student-facing surface asks. A student with no year group on
+ * their record is not in a launched year group, so the answer is no — which is the
+ * safe way round: they see nothing rather than being shown something their school
+ * hasn't announced.
+ *
+ * @param {InstituteData} [institute] their school.
+ * @param {string} [yearGroup] their year group tag, as their record holds it.
+ * @param {Date} [now] the date to judge the launch against.
+ * @return {boolean} whether activity logging is live for them.
+ */
+const activityLoggingLive = (institute, yearGroup, now = new Date()) => {
+    if (!yearGroup)
+        return false;
+    if (!(0, exports.activityLoggingProductOn)(institute))
+        return false;
+    const config = institute?.activityLogging;
+    if (!(0, exports.activityLaunchCurrent)(config, now))
+        return false;
+    return config?.yearGroups?.[yearGroup] === true;
+};
+exports.activityLoggingLive = activityLoggingLive;
+/**
+ * Has this school launched activity logging, and does the launch still stand?
+ *
+ * The three answers are the three different things to do about it: ask the setup
+ * questions, re-launch a year that has rolled over, or nothing.
+ *
+ * @param {InstituteData} [institute] the school.
+ * @param {Date} [now] the date to judge the launch against.
+ * @return {ActivityLoggingState} what is left to do.
+ */
+const activityLoggingState = (institute, now = new Date()) => {
+    const config = institute?.activityLogging;
+    // Never answered, or answered and launched to nobody — both leave a school with
+    // the questions still to answer.
+    if (!config?.setupCompletedAt || !Object.values(config.yearGroups || {}).some(Boolean))
+        return "unconfigured";
+    if ((0, exports.activityLoggingLiveYearGroups)(institute, now).length)
+        return "live";
+    return "needsLaunch";
+};
+exports.activityLoggingState = activityLoggingState;
+//# sourceMappingURL=activityLogging.js.map

package/lib/activityLogging.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"activityLogging.js","sourceRoot":"","sources":["../src/activityLogging.ts"],"names":[],"mappings":";;;AACA,iDAAkD;AAElD;;;;;;;;;;;;;;;;GAgBG;AAEH,yEAAyE;AAClE,MAAM,wBAAwB,GAAG,CAAC,SAAwD,EAAW,EAAE,CAC1G,SAAS,EAAE,qBAAqB,KAAK,KAAK,CAAC;AADlC,QAAA,wBAAwB,4BACU;AAE/C;;;;;;;;;GASG;AACI,MAAM,qBAAqB,GAAG,CAAC,MAA8B,EAAE,GAAG,GAAG,IAAI,IAAI,EAAE,EAAW,EAAE;IAC/F,IAAI,CAAC,MAAM,EAAE,YAAY;QAAE,OAAO,KAAK,CAAC;IACxC,OAAO,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,MAAM,CAAC,YAAY,KAAK,IAAA,yBAAc,EAAC,GAAG,CAAC,CAAC;AACnF,CAAC,CAAC;AAHW,QAAA,qBAAqB,yBAGhC;AAEF;;;;;;GAMG;AACI,MAAM,6BAA6B,GAAG,CAAC,SAAyB,EAAE,GAAG,GAAG,IAAI,IAAI,EAAE,EAAY,EAAE;IACnG,IAAI,CAAC,IAAA,gCAAwB,EAAC,SAAS,CAAC;QAAE,OAAO,EAAE,CAAC;IACpD,MAAM,MAAM,GAAG,SAAS,EAAE,eAAe,CAAC;IAC1C,IAAI,CAAC,IAAA,6BAAqB,EAAC,MAAM,EAAE,GAAG,CAAC;QAAE,OAAO,EAAE,CAAC;IACnD,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,UAAU,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;AAC7F,CAAC,CAAC;AALW,QAAA,6BAA6B,iCAKxC;AAEF;;;;;;;;;;;;GAYG;AACI,MAAM,mBAAmB,GAAG,CAAC,SAAyB,EAAE,SAAkB,EAAE,GAAG,GAAG,IAAI,IAAI,EAAE,EAAW,EAAE;IAC5G,IAAI,CAAC,SAAS;QAAE,OAAO,KAAK,CAAC;IAC7B,IAAI,CAAC,IAAA,gCAAwB,EAAC,SAAS,CAAC;QAAE,OAAO,KAAK,CAAC;IACvD,MAAM,MAAM,GAAG,SAAS,EAAE,eAAe,CAAC;IAC1C,IAAI,CAAC,IAAA,6BAAqB,EAAC,MAAM,EAAE,GAAG,CAAC;QAAE,OAAO,KAAK,CAAC;IACtD,OAAO,MAAM,EAAE,UAAU,EAAE,CAAC,SAAS,CAAC,KAAK,IAAI,CAAC;AACpD,CAAC,CAAC;AANW,QAAA,mBAAmB,uBAM9B;AAMF;;;;;;;;;GASG;AACI,MAAM,oBAAoB,GAAG,CAAC,SAAyB,EAAE,GAAG,GAAG,IAAI,IAAI,EAAE,EAAwB,EAAE;IACtG,MAAM,MAAM,GAAG,SAAS,EAAE,eAAe,CAAC;IAC1C,gFAAgF;IAChF,iCAAiC;IACjC,IAAI,CAAC,MAAM,EAAE,gBAAgB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;QAAE,OAAO,cAAc,CAAC;IAC9G,IAAI,IAAA,qCAA6B,EAAC,SAAS,EAAE,GAAG,CAAC,CAAC,MAAM;QAAE,OAAO,MAAM,CAAC;IACxE,OAAO,aAAa,CAAC;AACzB,CAAC,CAAC;AAPW,QAAA,oBAAoB,wBAO/B"}

package/lib/activityLogging.test.d.ts

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

package/lib/activityLogging.test.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const activityLogging_1 = require("./activityLogging");
+// 1 September is the academic-year boundary the whole platform uses, so a launch
+// made in one year is spent the moment the next one starts.
+const IN_2026_27 = new Date("2026-10-01T09:00:00Z");
+const IN_2027_28 = new Date("2027-10-01T09:00:00Z");
+// The August before 2026-27 starts: still the 2025-26 academic year.
+const AUGUST_2026 = new Date("2026-08-20T09:00:00Z");
+const school = (overrides = {}) => ({
+    name: "Calder Park Academy",
+    ...overrides,
+});
+const launched = (yearGroups, extra = {}) => school({ activityLogging: {
+        setupCompletedAt: "2026-09-02T10:00:00Z",
+        launchedYear: "2026-27",
+        yearGroups,
+        ...extra,
+    } });
+describe("activityLoggingProductOn", () => {
+    it("is on when the flag is absent, because staff have the area by default", () => {
+        expect((0, activityLogging_1.activityLoggingProductOn)(school())).toBe(true);
+    });
+    it("is on when explicitly true", () => {
+        expect((0, activityLogging_1.activityLoggingProductOn)(school({ trackExtracurriculars: true }))).toBe(true);
+    });
+    it("is off only when explicitly false", () => {
+        expect((0, activityLogging_1.activityLoggingProductOn)(school({ trackExtracurriculars: false }))).toBe(false);
+    });
+});
+describe("activityLaunchCurrent", () => {
+    it("is false with nothing launched", () => {
+        expect((0, activityLogging_1.activityLaunchCurrent)(undefined, IN_2026_27)).toBe(false);
+        expect((0, activityLogging_1.activityLaunchCurrent)({ yearGroups: { "Year 12": true } }, IN_2026_27)).toBe(false);
+    });
+    it("holds within the year it was launched for", () => {
+        expect((0, activityLogging_1.activityLaunchCurrent)({ launchedYear: "2026-27" }, IN_2026_27)).toBe(true);
+    });
+    it("is spent by the next academic year", () => {
+        expect((0, activityLogging_1.activityLaunchCurrent)({ launchedYear: "2026-27" }, IN_2027_28)).toBe(false);
+    });
+    it("carries forward when the school asked it to", () => {
+        expect((0, activityLogging_1.activityLaunchCurrent)({ launchedYear: "2026-27", rollOver: true }, IN_2027_28)).toBe(true);
+    });
+    it("counts August as the year that is ending, not the one about to start", () => {
+        expect((0, activityLogging_1.activityLaunchCurrent)({ launchedYear: "2025-26" }, AUGUST_2026)).toBe(true);
+        expect((0, activityLogging_1.activityLaunchCurrent)({ launchedYear: "2026-27" }, AUGUST_2026)).toBe(false);
+    });
+});
+describe("activityLoggingLive", () => {
+    it("is live for a launched year group", () => {
+        expect((0, activityLogging_1.activityLoggingLive)(launched({ "Year 12": true }), "Year 12", IN_2026_27)).toBe(true);
+    });
+    it("is not live for a year group left out of the launch", () => {
+        expect((0, activityLogging_1.activityLoggingLive)(launched({ "Year 12": true }), "Year 9", IN_2026_27)).toBe(false);
+    });
+    it("is not live for a year group switched off", () => {
+        expect((0, activityLogging_1.activityLoggingLive)(launched({ "Year 12": false }), "Year 12", IN_2026_27)).toBe(false);
+    });
+    it("is not live for a student with no year group on their record", () => {
+        expect((0, activityLogging_1.activityLoggingLive)(launched({ "Year 12": true }), undefined, IN_2026_27)).toBe(false);
+    });
+    it("stops at the new academic year unless the launch rolls over", () => {
+        expect((0, activityLogging_1.activityLoggingLive)(launched({ "Year 12": true }), "Year 12", IN_2027_28)).toBe(false);
+        expect((0, activityLogging_1.activityLoggingLive)(launched({ "Year 12": true }, { rollOver: true }), "Year 12", IN_2027_28)).toBe(true);
+    });
+    it("is never live when the product itself is off, whatever the launch says", () => {
+        const off = launched({ "Year 12": true });
+        off.trackExtracurriculars = false;
+        expect((0, activityLogging_1.activityLoggingLive)(off, "Year 12", IN_2026_27)).toBe(false);
+    });
+    it("matches the school's own year tag verbatim rather than normalising it", () => {
+        expect((0, activityLogging_1.activityLoggingLive)(launched({ "Yr 12 (KS5)": true }), "Yr 12 (KS5)", IN_2026_27)).toBe(true);
+        expect((0, activityLogging_1.activityLoggingLive)(launched({ "Yr 12 (KS5)": true }), "Year 12", IN_2026_27)).toBe(false);
+    });
+});
+describe("activityLoggingLiveYearGroups", () => {
+    it("lists only the year groups switched on", () => {
+        expect((0, activityLogging_1.activityLoggingLiveYearGroups)(launched({ "Year 9": true, "Year 10": false, "Year 12": true }), IN_2026_27))
+            .toEqual(["Year 9", "Year 12"]);
+    });
+    it("is empty once the launch is spent", () => {
+        expect((0, activityLogging_1.activityLoggingLiveYearGroups)(launched({ "Year 9": true }), IN_2027_28)).toEqual([]);
+    });
+});
+describe("activityLoggingState", () => {
+    it("is unconfigured before the school has answered the setup", () => {
+        expect((0, activityLogging_1.activityLoggingState)(school(), IN_2026_27)).toBe("unconfigured");
+    });
+    it("is unconfigured when setup was answered but nobody was launched to", () => {
+        expect((0, activityLogging_1.activityLoggingState)(launched({ "Year 9": false }), IN_2026_27)).toBe("unconfigured");
+    });
+    it("is live while a launch stands", () => {
+        expect((0, activityLogging_1.activityLoggingState)(launched({ "Year 9": true }), IN_2026_27)).toBe("live");
+    });
+    it("asks for a new launch once the year has rolled over", () => {
+        expect((0, activityLogging_1.activityLoggingState)(launched({ "Year 9": true }), IN_2027_28)).toBe("needsLaunch");
+    });
+    it("stays live across years when the school said it should", () => {
+        expect((0, activityLogging_1.activityLoggingState)(launched({ "Year 9": true }, { rollOver: true }), IN_2027_28)).toBe("live");
+    });
+});
+//# sourceMappingURL=activityLogging.test.js.map

package/lib/activityLogging.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"activityLogging.test.js","sourceRoot":"","sources":["../src/activityLogging.test.ts"],"names":[],"mappings":";;AACA,uDAM2B;AAE3B,iFAAiF;AACjF,4DAA4D;AAC5D,MAAM,UAAU,GAAG,IAAI,IAAI,CAAC,sBAAsB,CAAC,CAAC;AACpD,MAAM,UAAU,GAAG,IAAI,IAAI,CAAC,sBAAsB,CAAC,CAAC;AACpD,qEAAqE;AACrE,MAAM,WAAW,GAAG,IAAI,IAAI,CAAC,sBAAsB,CAAC,CAAC;AAErD,MAAM,MAAM,GAAG,CAAC,YAAoC,EAAE,EAAiB,EAAE,CAAC,CAAC;IACvE,IAAI,EAAE,qBAAqB;IAC3B,GAAG,SAAS;CACG,CAAA,CAAC;AAEpB,MAAM,QAAQ,GAAG,CAAC,UAAmC,EAAE,QAAgE,EAAE,EAAE,EAAE,CACzH,MAAM,CAAC,EAAC,eAAe,EAAE;QACrB,gBAAgB,EAAE,sBAAsB;QACxC,YAAY,EAAE,SAAS;QACvB,UAAU;QACV,GAAG,KAAK;KACX,EAAC,CAAC,CAAC;AAER,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;IACtC,EAAE,CAAC,uEAAuE,EAAE,GAAG,EAAE;QAC7E,MAAM,CAAC,IAAA,0CAAwB,EAAC,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;QAClC,MAAM,CAAC,IAAA,0CAAwB,EAAC,MAAM,CAAC,EAAC,qBAAqB,EAAE,IAAI,EAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QACzC,MAAM,CAAC,IAAA,0CAAwB,EAAC,MAAM,CAAC,EAAC,qBAAqB,EAAE,KAAK,EAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACzF,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;IACnC,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;QACtC,MAAM,CAAC,IAAA,uCAAqB,EAAC,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACjE,MAAM,CAAC,IAAA,uCAAqB,EAAC,EAAC,UAAU,EAAE,EAAC,SAAS,EAAE,IAAI,EAAC,EAAC,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC3F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACjD,MAAM,CAAC,IAAA,uCAAqB,EAAC,EAAC,YAAY,EAAE,SAAS,EAAC,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;QAC1C,MAAM,CAAC,IAAA,uCAAqB,EAAC,EAAC,YAAY,EAAE,SAAS,EAAC,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACnD,MAAM,CAAC,IAAA,uCAAqB,EAAC,EAAC,YAAY,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAC,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpG,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sEAAsE,EAAE,GAAG,EAAE;QAC5E,MAAM,CAAC,IAAA,uCAAqB,EAAC,EAAC,YAAY,EAAE,SAAS,EAAC,EAAE,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjF,MAAM,CAAC,IAAA,uCAAqB,EAAC,EAAC,YAAY,EAAE,SAAS,EAAC,EAAE,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACtF,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;IACjC,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QACzC,MAAM,CAAC,IAAA,qCAAmB,EAAC,QAAQ,CAAC,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;QAC3D,MAAM,CAAC,IAAA,qCAAmB,EAAC,QAAQ,CAAC,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC/F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACjD,MAAM,CAAC,IAAA,qCAAmB,EAAC,QAAQ,CAAC,EAAC,SAAS,EAAE,KAAK,EAAC,CAAC,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACjG,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,GAAG,EAAE;QACpE,MAAM,CAAC,IAAA,qCAAmB,EAAC,QAAQ,CAAC,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChG,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;QACnE,MAAM,CAAC,IAAA,qCAAmB,EAAC,QAAQ,CAAC,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC5F,MAAM,CAAC,IAAA,qCAAmB,EAAC,QAAQ,CAAC,EAAC,SAAS,EAAE,IAAI,EAAC,EAAE,EAAC,QAAQ,EAAE,IAAI,EAAC,CAAC,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wEAAwE,EAAE,GAAG,EAAE;QAC9E,MAAM,GAAG,GAAG,QAAQ,CAAC,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC,CAAC;QACxC,GAAG,CAAC,qBAAqB,GAAG,KAAK,CAAC;QAClC,MAAM,CAAC,IAAA,qCAAmB,EAAC,GAAG,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACxE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uEAAuE,EAAE,GAAG,EAAE;QAC7E,MAAM,CAAC,IAAA,qCAAmB,EAAC,QAAQ,CAAC,EAAC,aAAa,EAAE,IAAI,EAAC,CAAC,EAAE,aAAa,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnG,MAAM,CAAC,IAAA,qCAAmB,EAAC,QAAQ,CAAC,EAAC,aAAa,EAAE,IAAI,EAAC,CAAC,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACpG,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,+BAA+B,EAAE,GAAG,EAAE;IAC3C,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;QAC9C,MAAM,CAAC,IAAA,+CAA6B,EAAC,QAAQ,CAAC,EAAC,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAC,CAAC,EAAE,UAAU,CAAC,CAAC;aAC3G,OAAO,CAAC,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QACzC,MAAM,CAAC,IAAA,+CAA6B,EAAC,QAAQ,CAAC,EAAC,QAAQ,EAAE,IAAI,EAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC9F,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;IAClC,EAAE,CAAC,0DAA0D,EAAE,GAAG,EAAE;QAChE,MAAM,CAAC,IAAA,sCAAoB,EAAC,MAAM,EAAE,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oEAAoE,EAAE,GAAG,EAAE;QAC1E,MAAM,CAAC,IAAA,sCAAoB,EAAC,QAAQ,CAAC,EAAC,QAAQ,EAAE,KAAK,EAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC/F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;QACrC,MAAM,CAAC,IAAA,sCAAoB,EAAC,QAAQ,CAAC,EAAC,QAAQ,EAAE,IAAI,EAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACtF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;QAC3D,MAAM,CAAC,IAAA,sCAAoB,EAAC,QAAQ,CAAC,EAAC,QAAQ,EAAE,IAAI,EAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC7F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;QAC9D,MAAM,CAAC,IAAA,sCAAoB,EAAC,QAAQ,CAAC,EAAC,QAAQ,EAAE,IAAI,EAAC,EAAE,EAAC,QAAQ,EAAE,IAAI,EAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACxG,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/lib/callables/activityLogging.d.ts

@@ -0,0 +1,58 @@
+import { z } from "zod";
+/**
+ * Contract for launching activity logging to students
+ * (`Placementt-Backend/functions/src/activityLogging.ts`).
+ *
+ * Launching is a callable rather than a client write for one reason: it emails
+ * pupils. Which year groups a school has told about activity logging decides who
+ * gets that email, so the list and the send have to be the same act, checked in one
+ * place — a client that could write the year groups itself could mail a school's
+ * whole roll by editing one document.
+ */
+export declare const activityLoggingCallables: {
+    "activityLogging-launchActivityLogging": {
+        request: z.ZodObject<{
+            oId: z.ZodString;
+            /** Every year group tag the school wants live, exactly as its MIS writes
+             * them. The stored map is replaced by this list, so a tag left out is a
+             * year group switched off. */
+            yearGroups: z.ZodArray<z.ZodString, "many">;
+            /** Whether the launch carries into each new academic year, or has to be
+             * made again every September. */
+            rollOver: z.ZodOptional<z.ZodBoolean>;
+            /** Skip the announcement email. For a school switching a year group off,
+             * correcting a tag, or turning rollOver on and off — none of which is
+             * news a pupil needs. Newly launched year groups are emailed otherwise. */
+            silent: z.ZodOptional<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            oId: string;
+            yearGroups: string[];
+            silent?: boolean | undefined;
+            rollOver?: boolean | undefined;
+        }, {
+            oId: string;
+            yearGroups: string[];
+            silent?: boolean | undefined;
+            rollOver?: boolean | undefined;
+        }>;
+        response: z.ZodObject<{
+            launched: z.ZodBoolean;
+            academicYear: z.ZodString;
+            /** Year groups live after this call. */
+            yearGroups: z.ZodArray<z.ZodString, "many">;
+            /** How many students were emailed. Zero on a silent launch, and on one
+             * that only switched year groups off. */
+            emailed: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            yearGroups: string[];
+            academicYear: string;
+            launched: boolean;
+            emailed: number;
+        }, {
+            yearGroups: string[];
+            academicYear: string;
+            launched: boolean;
+            emailed: number;
+        }>;
+    };
+};

package/lib/callables/activityLogging.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.activityLoggingCallables = void 0;
+const zod_1 = require("zod");
+/**
+ * Contract for launching activity logging to students
+ * (`Placementt-Backend/functions/src/activityLogging.ts`).
+ *
+ * Launching is a callable rather than a client write for one reason: it emails
+ * pupils. Which year groups a school has told about activity logging decides who
+ * gets that email, so the list and the send have to be the same act, checked in one
+ * place — a client that could write the year groups itself could mail a school's
+ * whole roll by editing one document.
+ */
+exports.activityLoggingCallables = {
+    "activityLogging-launchActivityLogging": {
+        request: zod_1.z.object({
+            oId: zod_1.z.string(),
+            /** Every year group tag the school wants live, exactly as its MIS writes
+             * them. The stored map is replaced by this list, so a tag left out is a
+             * year group switched off. */
+            yearGroups: zod_1.z.array(zod_1.z.string()),
+            /** Whether the launch carries into each new academic year, or has to be
+             * made again every September. */
+            rollOver: zod_1.z.boolean().optional(),
+            /** Skip the announcement email. For a school switching a year group off,
+             * correcting a tag, or turning rollOver on and off — none of which is
+             * news a pupil needs. Newly launched year groups are emailed otherwise. */
+            silent: zod_1.z.boolean().optional(),
+        }),
+        response: zod_1.z.object({
+            launched: zod_1.z.boolean(),
+            academicYear: zod_1.z.string(),
+            /** Year groups live after this call. */
+            yearGroups: zod_1.z.array(zod_1.z.string()),
+            /** How many students were emailed. Zero on a silent launch, and on one
+             * that only switched year groups off. */
+            emailed: zod_1.z.number(),
+        }),
+    },
+};
+//# sourceMappingURL=activityLogging.js.map

package/lib/callables/activityLogging.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"activityLogging.js","sourceRoot":"","sources":["../../src/callables/activityLogging.ts"],"names":[],"mappings":";;;AAAA,6BAAsB;AAGtB;;;;;;;;;GASG;AACU,QAAA,wBAAwB,GAAG;IACpC,uCAAuC,EAAE;QACrC,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC;YACd,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE;YACf;;0CAE8B;YAC9B,UAAU,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC;YAC/B;6CACiC;YACjC,QAAQ,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;YAChC;;uFAE2E;YAC3E,MAAM,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;SACjC,CAAC;QACF,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC;YACf,QAAQ,EAAE,OAAC,CAAC,OAAO,EAAE;YACrB,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE;YACxB,wCAAwC;YACxC,UAAU,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC;YAC/B;qDACyC;YACzC,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE;SACtB,CAAC;KACL;CACoB,CAAC"}

package/lib/callables/index.d.ts

@@ -7,3 +7,4 @@ export * from "./jobRoles";
 export * from "./apprenticeships";
 export * from "./he";
 export * from "./nextSteps";
+export * from "./activityLogging";

package/lib/callables/index.js

@@ -23,4 +23,5 @@ __exportStar(require("./jobRoles"), exports);
 __exportStar(require("./apprenticeships"), exports);
 __exportStar(require("./he"), exports);
 __exportStar(require("./nextSteps"), exports);
+__exportStar(require("./activityLogging"), exports);
 //# sourceMappingURL=index.js.map

package/lib/callables/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/callables/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB;AACxB,6CAA2B;AAC3B,uDAAqC;AACrC,8CAA4B;AAC5B,2CAAyB;AACzB,6CAA2B;AAC3B,oDAAkC;AAClC,uCAAqB;AACrB,8CAA4B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/callables/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB;AACxB,6CAA2B;AAC3B,uDAAqC;AACrC,8CAA4B;AAC5B,2CAAyB;AACzB,6CAA2B;AAC3B,oDAAkC;AAClC,uCAAqB;AACrB,8CAA4B;AAC5B,oDAAkC"}

package/lib/callables/registry.d.ts

@@ -11,6 +11,40 @@ import { z } from "zod";
  * equals the sum of the group key counts.
  */
 export declare const allCallables: {
+    "activityLogging-launchActivityLogging": {
+        request: z.ZodObject<{
+            oId: z.ZodString;
+            yearGroups: z.ZodArray<z.ZodString, "many">;
+            rollOver: z.ZodOptional<z.ZodBoolean>;
+            silent: z.ZodOptional<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            oId: string;
+            yearGroups: string[];
+            silent?: boolean | undefined;
+            rollOver?: boolean | undefined;
+        }, {
+            oId: string;
+            yearGroups: string[];
+            silent?: boolean | undefined;
+            rollOver?: boolean | undefined;
+        }>;
+        response: z.ZodObject<{
+            launched: z.ZodBoolean;
+            academicYear: z.ZodString;
+            yearGroups: z.ZodArray<z.ZodString, "many">;
+            emailed: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            yearGroups: string[];
+            academicYear: string;
+            launched: boolean;
+            emailed: number;
+        }, {
+            yearGroups: string[];
+            academicYear: string;
+            launched: boolean;
+            emailed: number;
+        }>;
+    };
     "nextSteps-search": {
         request: z.ZodObject<{
             query: z.ZodOptional<z.ZodString>;
@@ -5395,4 +5429,40 @@ export declare const callableGroups: {
             }>;
         };
     };
+    activityLoggingCallables: {
+        "activityLogging-launchActivityLogging": {
+            request: z.ZodObject<{
+                oId: z.ZodString;
+                yearGroups: z.ZodArray<z.ZodString, "many">;
+                rollOver: z.ZodOptional<z.ZodBoolean>;
+                silent: z.ZodOptional<z.ZodBoolean>;
+            }, "strip", z.ZodTypeAny, {
+                oId: string;
+                yearGroups: string[];
+                silent?: boolean | undefined;
+                rollOver?: boolean | undefined;
+            }, {
+                oId: string;
+                yearGroups: string[];
+                silent?: boolean | undefined;
+                rollOver?: boolean | undefined;
+            }>;
+            response: z.ZodObject<{
+                launched: z.ZodBoolean;
+                academicYear: z.ZodString;
+                yearGroups: z.ZodArray<z.ZodString, "many">;
+                emailed: z.ZodNumber;
+            }, "strip", z.ZodTypeAny, {
+                yearGroups: string[];
+                academicYear: string;
+                launched: boolean;
+                emailed: number;
+            }, {
+                yearGroups: string[];
+                academicYear: string;
+                launched: boolean;
+                emailed: number;
+            }>;
+        };
+    };
 };

package/lib/callables/registry.js

@@ -11,6 +11,7 @@ const benchmarks_1 = require("./benchmarks");
 const apprenticeships_1 = require("./apprenticeships");
 const he_1 = require("./he");
 const nextSteps_1 = require("./nextSteps");
+const activityLogging_1 = require("./activityLogging");
 /**
  * The single source of truth for every typed callable. Add a feature group's
  * spread here and its callables are automatically covered by:
@@ -33,7 +34,8 @@ exports.allCallables = {
     ...apprenticeships_1.apprenticeshipsCallables,
     ...he_1.heCallables,
     ...nextSteps_1.nextStepsCallables,
+    ...activityLogging_1.activityLoggingCallables,
 };
 /** The per-group maps, exported so tests can assert no key collisions. */
-exports.callableGroups = { destinationsConfigCallables: destinationsConfig_1.destinationsConfigCallables, placementCallables: placement_1.placementCallables, eventsCallables: events_1.eventsCallables, surveyCallables: surveys_1.surveyCallables, jobRolesCallables: jobRoles_1.jobRolesCallables, checksCallables: checks_1.checksCallables, benchmarksCallables: benchmarks_1.benchmarksCallables, apprenticeshipsCallables: apprenticeships_1.apprenticeshipsCallables, heCallables: he_1.heCallables, nextStepsCallables: nextSteps_1.nextStepsCallables };
+exports.callableGroups = { destinationsConfigCallables: destinationsConfig_1.destinationsConfigCallables, placementCallables: placement_1.placementCallables, eventsCallables: events_1.eventsCallables, surveyCallables: surveys_1.surveyCallables, jobRolesCallables: jobRoles_1.jobRolesCallables, checksCallables: checks_1.checksCallables, benchmarksCallables: benchmarks_1.benchmarksCallables, apprenticeshipsCallables: apprenticeships_1.apprenticeshipsCallables, heCallables: he_1.heCallables, nextStepsCallables: nextSteps_1.nextStepsCallables, activityLoggingCallables: activityLogging_1.activityLoggingCallables };
 //# sourceMappingURL=registry.js.map

package/lib/callables/registry.js.map

@@ -1 +1 @@
-{"version":3,"file":"registry.js","sourceRoot":"","sources":["../../src/callables/registry.ts"],"names":[],"mappings":";;;AAEA,6DAAiE;AACjE,2CAA+C;AAC/C,qCAAyC;AACzC,uCAA0C;AAC1C,yCAA6C;AAC7C,qCAAyC;AACzC,6CAAiD;AACjD,uDAA2D;AAC3D,6BAAiC;AACjC,2CAA+C;AAE/C;;;;;;;;;;GAUG;AACU,QAAA,YAAY,GAAG;IACxB,GAAG,gDAA2B;IAC9B,GAAG,8BAAkB;IACrB,GAAG,wBAAe;IAClB,GAAG,yBAAe;IAClB,GAAG,4BAAiB;IACpB,GAAG,wBAAe;IAClB,GAAG,gCAAmB;IACtB,GAAG,0CAAwB;IAC3B,GAAG,gBAAW;IACd,GAAG,8BAAkB;CACA,CAAC;AAiB1B,0EAA0E;AAC7D,QAAA,cAAc,GAAG,EAAC,2BAA2B,EAA3B,gDAA2B,EAAE,kBAAkB,EAAlB,8BAAkB,EAAE,eAAe,EAAf,wBAAe,EAAE,eAAe,EAAf,yBAAe,EAAE,iBAAiB,EAAjB,4BAAiB,EAAE,eAAe,EAAf,wBAAe,EAAE,mBAAmB,EAAnB,gCAAmB,EAAE,wBAAwB,EAAxB,0CAAwB,EAAE,WAAW,EAAX,gBAAW,EAAE,kBAAkB,EAAlB,8BAAkB,EAAC,CAAC"}
+{"version":3,"file":"registry.js","sourceRoot":"","sources":["../../src/callables/registry.ts"],"names":[],"mappings":";;;AAEA,6DAAiE;AACjE,2CAA+C;AAC/C,qCAAyC;AACzC,uCAA0C;AAC1C,yCAA6C;AAC7C,qCAAyC;AACzC,6CAAiD;AACjD,uDAA2D;AAC3D,6BAAiC;AACjC,2CAA+C;AAC/C,uDAA2D;AAE3D;;;;;;;;;;GAUG;AACU,QAAA,YAAY,GAAG;IACxB,GAAG,gDAA2B;IAC9B,GAAG,8BAAkB;IACrB,GAAG,wBAAe;IAClB,GAAG,yBAAe;IAClB,GAAG,4BAAiB;IACpB,GAAG,wBAAe;IAClB,GAAG,gCAAmB;IACtB,GAAG,0CAAwB;IAC3B,GAAG,gBAAW;IACd,GAAG,8BAAkB;IACrB,GAAG,0CAAwB;CACN,CAAC;AAiB1B,0EAA0E;AAC7D,QAAA,cAAc,GAAG,EAAC,2BAA2B,EAA3B,gDAA2B,EAAE,kBAAkB,EAAlB,8BAAkB,EAAE,eAAe,EAAf,wBAAe,EAAE,eAAe,EAAf,yBAAe,EAAE,iBAAiB,EAAjB,4BAAiB,EAAE,eAAe,EAAf,wBAAe,EAAE,mBAAmB,EAAnB,gCAAmB,EAAE,wBAAwB,EAAxB,0CAAwB,EAAE,WAAW,EAAX,gBAAW,EAAE,kBAAkB,EAAlB,8BAAkB,EAAE,wBAAwB,EAAxB,0CAAwB,EAAC,CAAC"}

package/lib/index.d.ts

@@ -15,6 +15,7 @@ export * from "./surveys/checks";
 export * from "./surveys/schedule";
 export * from "./skillsResolver";
 export * from "./activities";
+export * from "./activityLogging";
 export * from "./lmi";
 export * from "./productResolver";
 export * from "./pricing";

package/lib/index.js

@@ -35,6 +35,7 @@ __exportStar(require("./surveys/checks"), exports);
 __exportStar(require("./surveys/schedule"), exports);
 __exportStar(require("./skillsResolver"), exports);
 __exportStar(require("./activities"), exports);
+__exportStar(require("./activityLogging"), exports);
 __exportStar(require("./lmi"), exports);
 __exportStar(require("./productResolver"), exports);
 __exportStar(require("./pricing"), 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,mDAAiC;AACjC,+CAA6B;AAC7B,wCAAsB;AACtB,oDAAkC;AAClC,4CAA0B;AAC1B,2CAAyB;AACzB,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,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,mDAAiC;AACjC,+CAA6B;AAC7B,oDAAkC;AAClC,wCAAsB;AACtB,oDAAkC;AAClC,4CAA0B;AAC1B,2CAAyB;AACzB,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,6DAAuE;AAA9D,2IAAA,OAAO,OAAuB"}

package/lib/typeDefinitions.d.ts

@@ -1143,6 +1143,15 @@ export type InstituteData = {
     careersEvents?: boolean;
     skillsAssessmentsProduct?: boolean;
     trackExtracurriculars?: boolean;
+    /** Activity logging as STUDENTS meet it.
+     *
+     * `trackExtracurriculars` above is the product: absent or true means the school
+     * has the area and its staff can use it, which is why absent reads as on. This
+     * is the launch, and it is a different question — a school switching the product
+     * on has not put the feature in front of a single student until it says which
+     * year groups have been told about it. Nothing is shown to a student, and no
+     * student is emailed, outside the year groups in here. */
+    activityLogging?: ActivityLoggingConfig;
     destinationTracking?: boolean;
     docCheck?: boolean;
     adminLastCheckedDocs?: string;
@@ -1291,6 +1300,35 @@ export type InstituteData = {
     };
     cs?: CustomerSuccessData;
 } & Address;
+/**
+ * Which year groups activity logging has been launched to, and whether that lasts.
+ *
+ * Kept on the institute rather than per student because it is a decision about a
+ * year group, not about a person: a school launches to Year 12 in September and
+ * everyone in Year 12 has it that day, including the pupil who joins in November.
+ */
+export type ActivityLoggingConfig = {
+    /** Year groups it is live for, keyed by the school's own year tag exactly as its
+     * MIS writes it. A tag that is absent or false is a year that has not been
+     * launched to, and its students see nothing. */
+    yearGroups?: {
+        [yearGroup: string]: boolean;
+    };
+    /** Whether a launch carries into each new academic year, or has to be made again
+     * every September. Off by default, and deliberately: last year's Year 11 is not
+     * this year's Year 11, and a school that wants to introduce it to each new
+     * cohort in person should not find it already live. */
+    rollOver?: boolean;
+    /** The academic year the launch was made for, "2026-27". With `rollOver` off, a
+     * launch from an earlier year is spent and the school is asked to launch again. */
+    launchedYear?: string;
+    launchedAt?: string;
+    /** uid of the staff member who launched it. */
+    launchedBy?: string;
+    /** Set the first time the school answers the setup, so the Activities area stops
+     * showing its first-run wizard. Stamped server-side. */
+    setupCompletedAt?: string;
+};
 export type ExternalActivity = {
     title?: string;
     description: string;

package/lib/typeDefinitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"typeDefinitions.js","sourceRoot":"","sources":["../src/typeDefinitions.ts"],"names":[],"mappings":";;;AAwjIA,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":";;;AA6lIA,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.1080",
+  "version": "1.400.1081",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "scripts": {

package/src/activityLogging.test.ts

@@ -0,0 +1,133 @@
+import {InstituteData} from "./typeDefinitions";
+import {
+    activityLaunchCurrent,
+    activityLoggingLive,
+    activityLoggingLiveYearGroups,
+    activityLoggingProductOn,
+    activityLoggingState,
+} from "./activityLogging";
+
+// 1 September is the academic-year boundary the whole platform uses, so a launch
+// made in one year is spent the moment the next one starts.
+const IN_2026_27 = new Date("2026-10-01T09:00:00Z");
+const IN_2027_28 = new Date("2027-10-01T09:00:00Z");
+// The August before 2026-27 starts: still the 2025-26 academic year.
+const AUGUST_2026 = new Date("2026-08-20T09:00:00Z");
+
+const school = (overrides: Partial<InstituteData> = {}): InstituteData => ({
+    name: "Calder Park Academy",
+    ...overrides,
+} as InstituteData);
+
+const launched = (yearGroups: {[yg: string]: boolean}, extra: Partial<NonNullable<InstituteData["activityLogging"]>> = {}) =>
+    school({activityLogging: {
+        setupCompletedAt: "2026-09-02T10:00:00Z",
+        launchedYear: "2026-27",
+        yearGroups,
+        ...extra,
+    }});
+
+describe("activityLoggingProductOn", () => {
+    it("is on when the flag is absent, because staff have the area by default", () => {
+        expect(activityLoggingProductOn(school())).toBe(true);
+    });
+
+    it("is on when explicitly true", () => {
+        expect(activityLoggingProductOn(school({trackExtracurriculars: true}))).toBe(true);
+    });
+
+    it("is off only when explicitly false", () => {
+        expect(activityLoggingProductOn(school({trackExtracurriculars: false}))).toBe(false);
+    });
+});
+
+describe("activityLaunchCurrent", () => {
+    it("is false with nothing launched", () => {
+        expect(activityLaunchCurrent(undefined, IN_2026_27)).toBe(false);
+        expect(activityLaunchCurrent({yearGroups: {"Year 12": true}}, IN_2026_27)).toBe(false);
+    });
+
+    it("holds within the year it was launched for", () => {
+        expect(activityLaunchCurrent({launchedYear: "2026-27"}, IN_2026_27)).toBe(true);
+    });
+
+    it("is spent by the next academic year", () => {
+        expect(activityLaunchCurrent({launchedYear: "2026-27"}, IN_2027_28)).toBe(false);
+    });
+
+    it("carries forward when the school asked it to", () => {
+        expect(activityLaunchCurrent({launchedYear: "2026-27", rollOver: true}, IN_2027_28)).toBe(true);
+    });
+
+    it("counts August as the year that is ending, not the one about to start", () => {
+        expect(activityLaunchCurrent({launchedYear: "2025-26"}, AUGUST_2026)).toBe(true);
+        expect(activityLaunchCurrent({launchedYear: "2026-27"}, AUGUST_2026)).toBe(false);
+    });
+});
+
+describe("activityLoggingLive", () => {
+    it("is live for a launched year group", () => {
+        expect(activityLoggingLive(launched({"Year 12": true}), "Year 12", IN_2026_27)).toBe(true);
+    });
+
+    it("is not live for a year group left out of the launch", () => {
+        expect(activityLoggingLive(launched({"Year 12": true}), "Year 9", IN_2026_27)).toBe(false);
+    });
+
+    it("is not live for a year group switched off", () => {
+        expect(activityLoggingLive(launched({"Year 12": false}), "Year 12", IN_2026_27)).toBe(false);
+    });
+
+    it("is not live for a student with no year group on their record", () => {
+        expect(activityLoggingLive(launched({"Year 12": true}), undefined, IN_2026_27)).toBe(false);
+    });
+
+    it("stops at the new academic year unless the launch rolls over", () => {
+        expect(activityLoggingLive(launched({"Year 12": true}), "Year 12", IN_2027_28)).toBe(false);
+        expect(activityLoggingLive(launched({"Year 12": true}, {rollOver: true}), "Year 12", IN_2027_28)).toBe(true);
+    });
+
+    it("is never live when the product itself is off, whatever the launch says", () => {
+        const off = launched({"Year 12": true});
+        off.trackExtracurriculars = false;
+        expect(activityLoggingLive(off, "Year 12", IN_2026_27)).toBe(false);
+    });
+
+    it("matches the school's own year tag verbatim rather than normalising it", () => {
+        expect(activityLoggingLive(launched({"Yr 12 (KS5)": true}), "Yr 12 (KS5)", IN_2026_27)).toBe(true);
+        expect(activityLoggingLive(launched({"Yr 12 (KS5)": true}), "Year 12", IN_2026_27)).toBe(false);
+    });
+});
+
+describe("activityLoggingLiveYearGroups", () => {
+    it("lists only the year groups switched on", () => {
+        expect(activityLoggingLiveYearGroups(launched({"Year 9": true, "Year 10": false, "Year 12": true}), IN_2026_27))
+            .toEqual(["Year 9", "Year 12"]);
+    });
+
+    it("is empty once the launch is spent", () => {
+        expect(activityLoggingLiveYearGroups(launched({"Year 9": true}), IN_2027_28)).toEqual([]);
+    });
+});
+
+describe("activityLoggingState", () => {
+    it("is unconfigured before the school has answered the setup", () => {
+        expect(activityLoggingState(school(), IN_2026_27)).toBe("unconfigured");
+    });
+
+    it("is unconfigured when setup was answered but nobody was launched to", () => {
+        expect(activityLoggingState(launched({"Year 9": false}), IN_2026_27)).toBe("unconfigured");
+    });
+
+    it("is live while a launch stands", () => {
+        expect(activityLoggingState(launched({"Year 9": true}), IN_2026_27)).toBe("live");
+    });
+
+    it("asks for a new launch once the year has rolled over", () => {
+        expect(activityLoggingState(launched({"Year 9": true}), IN_2027_28)).toBe("needsLaunch");
+    });
+
+    it("stays live across years when the school said it should", () => {
+        expect(activityLoggingState(launched({"Year 9": true}, {rollOver: true}), IN_2027_28)).toBe("live");
+    });
+});

package/src/activityLogging.ts

@@ -0,0 +1,97 @@
+import {ActivityLoggingConfig, InstituteData} from "./typeDefinitions";
+import {academicYearOf} from "./surveys/schedule";
+
+/**
+ * Whether a student can log activities, and whether we may email them about it.
+ *
+ * Two different switches are easy to confuse here, so they are named apart:
+ *
+ * - `trackExtracurriculars` is the PRODUCT. Absent means on, which is right for
+ *   staff: a school that has never touched the switch still gets the Activities
+ *   area, its analytics and its Gatsby reporting.
+ * - `activityLogging` is the LAUNCH. It is what a school says to its students, and
+ *   absent means nothing has been said. A feature that appears in a pupil's account
+ *   unannounced gets used by nobody and asked about by everybody, so a year group
+ *   sees activity logging only once the school has launched it to them.
+ *
+ * The launch is per year group and, unless the school says otherwise, per academic
+ * year: last year's Year 11 is not this year's Year 11, and a school introducing it
+ * to each new cohort in assembly should not find it already live.
+ */
+
+/** Does the school have the Activities area at all? Absent means yes. */
+export const activityLoggingProductOn = (institute?: Pick<InstituteData, "trackExtracurriculars">): boolean =>
+    institute?.trackExtracurriculars !== false;
+
+/**
+ * Does the stored launch still count today?
+ *
+ * A launch is made for one academic year. With `rollOver` on it carries forward
+ * forever; without it, September spends it.
+ *
+ * @param {ActivityLoggingConfig} [config] the school's launch.
+ * @param {Date} [now] the date to judge it against.
+ * @return {boolean} whether the year groups below are live.
+ */
+export const activityLaunchCurrent = (config?: ActivityLoggingConfig, now = new Date()): boolean => {
+    if (!config?.launchedYear) return false;
+    return Boolean(config.rollOver) || config.launchedYear === academicYearOf(now);
+};
+
+/**
+ * The year groups activity logging is live for right now.
+ *
+ * @param {InstituteData} [institute] the school.
+ * @param {Date} [now] the date to judge the launch against.
+ * @return {string[]} the year group tags, empty when nothing is live.
+ */
+export const activityLoggingLiveYearGroups = (institute?: InstituteData, now = new Date()): string[] => {
+    if (!activityLoggingProductOn(institute)) return [];
+    const config = institute?.activityLogging;
+    if (!activityLaunchCurrent(config, now)) return [];
+    return Object.entries(config?.yearGroups || {}).filter(([, on]) => on).map(([yg]) => yg);
+};
+
+/**
+ * Can THIS student log activities, and may we email them about it?
+ *
+ * The one gate every student-facing surface asks. A student with no year group on
+ * their record is not in a launched year group, so the answer is no — which is the
+ * safe way round: they see nothing rather than being shown something their school
+ * hasn't announced.
+ *
+ * @param {InstituteData} [institute] their school.
+ * @param {string} [yearGroup] their year group tag, as their record holds it.
+ * @param {Date} [now] the date to judge the launch against.
+ * @return {boolean} whether activity logging is live for them.
+ */
+export const activityLoggingLive = (institute?: InstituteData, yearGroup?: string, now = new Date()): boolean => {
+    if (!yearGroup) return false;
+    if (!activityLoggingProductOn(institute)) return false;
+    const config = institute?.activityLogging;
+    if (!activityLaunchCurrent(config, now)) return false;
+    return config?.yearGroups?.[yearGroup] === true;
+};
+
+/** Where a school's activity logging stands, in the vocabulary the careers year
+ * setup uses for every other programme. */
+export type ActivityLoggingState = "unconfigured"|"needsLaunch"|"live";
+
+/**
+ * Has this school launched activity logging, and does the launch still stand?
+ *
+ * The three answers are the three different things to do about it: ask the setup
+ * questions, re-launch a year that has rolled over, or nothing.
+ *
+ * @param {InstituteData} [institute] the school.
+ * @param {Date} [now] the date to judge the launch against.
+ * @return {ActivityLoggingState} what is left to do.
+ */
+export const activityLoggingState = (institute?: InstituteData, now = new Date()): ActivityLoggingState => {
+    const config = institute?.activityLogging;
+    // Never answered, or answered and launched to nobody — both leave a school with
+    // the questions still to answer.
+    if (!config?.setupCompletedAt || !Object.values(config.yearGroups || {}).some(Boolean)) return "unconfigured";
+    if (activityLoggingLiveYearGroups(institute, now).length) return "live";
+    return "needsLaunch";
+};

package/src/callables/activityLogging.ts

@@ -0,0 +1,40 @@
+import {z} from "zod";
+import {CallableGroup} from "./types";
+
+/**
+ * Contract for launching activity logging to students
+ * (`Placementt-Backend/functions/src/activityLogging.ts`).
+ *
+ * Launching is a callable rather than a client write for one reason: it emails
+ * pupils. Which year groups a school has told about activity logging decides who
+ * gets that email, so the list and the send have to be the same act, checked in one
+ * place — a client that could write the year groups itself could mail a school's
+ * whole roll by editing one document.
+ */
+export const activityLoggingCallables = {
+    "activityLogging-launchActivityLogging": {
+        request: z.object({
+            oId: z.string(),
+            /** Every year group tag the school wants live, exactly as its MIS writes
+             * them. The stored map is replaced by this list, so a tag left out is a
+             * year group switched off. */
+            yearGroups: z.array(z.string()),
+            /** Whether the launch carries into each new academic year, or has to be
+             * made again every September. */
+            rollOver: z.boolean().optional(),
+            /** Skip the announcement email. For a school switching a year group off,
+             * correcting a tag, or turning rollOver on and off — none of which is
+             * news a pupil needs. Newly launched year groups are emailed otherwise. */
+            silent: z.boolean().optional(),
+        }),
+        response: z.object({
+            launched: z.boolean(),
+            academicYear: z.string(),
+            /** Year groups live after this call. */
+            yearGroups: z.array(z.string()),
+            /** How many students were emailed. Zero on a silent launch, and on one
+             * that only switched year groups off. */
+            emailed: z.number(),
+        }),
+    },
+} satisfies CallableGroup;

package/src/callables/index.ts

@@ -7,3 +7,4 @@ export * from "./jobRoles";
 export * from "./apprenticeships";
 export * from "./he";
 export * from "./nextSteps";
+export * from "./activityLogging";

package/src/callables/registry.ts

@@ -10,6 +10,7 @@ import {benchmarksCallables} from "./benchmarks";
 import {apprenticeshipsCallables} from "./apprenticeships";
 import {heCallables} from "./he";
 import {nextStepsCallables} from "./nextSteps";
+import {activityLoggingCallables} from "./activityLogging";
 
 /**
  * The single source of truth for every typed callable. Add a feature group's
@@ -33,6 +34,7 @@ export const allCallables = {
     ...apprenticeshipsCallables,
     ...heCallables,
     ...nextStepsCallables,
+    ...activityLoggingCallables,
 } satisfies CallableGroup;
 
 /** Every registered callable name. */
@@ -51,4 +53,4 @@ export type CallableContracts = {
 };
 
 /** The per-group maps, exported so tests can assert no key collisions. */
-export const callableGroups = {destinationsConfigCallables, placementCallables, eventsCallables, surveyCallables, jobRolesCallables, checksCallables, benchmarksCallables, apprenticeshipsCallables, heCallables, nextStepsCallables};
+export const callableGroups = {destinationsConfigCallables, placementCallables, eventsCallables, surveyCallables, jobRolesCallables, checksCallables, benchmarksCallables, apprenticeshipsCallables, heCallables, nextStepsCallables, activityLoggingCallables};

package/src/index.ts

@@ -17,6 +17,7 @@ export * from "./surveys/checks";
 export * from "./surveys/schedule";
 export * from "./skillsResolver";
 export * from "./activities";
+export * from "./activityLogging";
 export * from "./lmi";
 export * from "./productResolver";
 export * from "./pricing";

package/src/typeDefinitions.ts

@@ -1171,6 +1171,15 @@ export type InstituteData = {
     careersEvents?: boolean,
     skillsAssessmentsProduct?: boolean,
     trackExtracurriculars?: boolean,
+    /** Activity logging as STUDENTS meet it.
+     *
+     * `trackExtracurriculars` above is the product: absent or true means the school
+     * has the area and its staff can use it, which is why absent reads as on. This
+     * is the launch, and it is a different question — a school switching the product
+     * on has not put the feature in front of a single student until it says which
+     * year groups have been told about it. Nothing is shown to a student, and no
+     * student is emailed, outside the year groups in here. */
+    activityLogging?: ActivityLoggingConfig,
     destinationTracking?: boolean,
     docCheck?: boolean,
     adminLastCheckedDocs?: string,
@@ -1327,6 +1336,34 @@ export type InstituteData = {
     cs?: CustomerSuccessData,
 }&Address;
 
+/**
+ * Which year groups activity logging has been launched to, and whether that lasts.
+ *
+ * Kept on the institute rather than per student because it is a decision about a
+ * year group, not about a person: a school launches to Year 12 in September and
+ * everyone in Year 12 has it that day, including the pupil who joins in November.
+ */
+export type ActivityLoggingConfig = {
+    /** Year groups it is live for, keyed by the school's own year tag exactly as its
+     * MIS writes it. A tag that is absent or false is a year that has not been
+     * launched to, and its students see nothing. */
+    yearGroups?: {[yearGroup: string]: boolean},
+    /** Whether a launch carries into each new academic year, or has to be made again
+     * every September. Off by default, and deliberately: last year's Year 11 is not
+     * this year's Year 11, and a school that wants to introduce it to each new
+     * cohort in person should not find it already live. */
+    rollOver?: boolean,
+    /** The academic year the launch was made for, "2026-27". With `rollOver` off, a
+     * launch from an earlier year is spent and the school is asked to launch again. */
+    launchedYear?: string,
+    launchedAt?: string,
+    /** uid of the staff member who launched it. */
+    launchedBy?: string,
+    /** Set the first time the school answers the setup, so the Activities area stops
+     * showing its first-run wizard. Stamped server-side. */
+    setupCompletedAt?: string,
+};
+
 export type ExternalActivity = {
     title?: string,
     description: string,