placementt-core 1.400.1043 → 1.400.1044

package/lib/index.d.ts

@@ -17,6 +17,7 @@ export * from "./skillsResolver";
 export * from "./activities";
 export * from "./lmi";
 export * from "./productResolver";
+export * from "./pricing";
 export * from "./groups";
 export * from "./emailSections";
 export * from "./exportTransformers";

package/lib/index.js

@@ -37,6 +37,7 @@ __exportStar(require("./skillsResolver"), exports);
 __exportStar(require("./activities"), exports);
 __exportStar(require("./lmi"), exports);
 __exportStar(require("./productResolver"), exports);
+__exportStar(require("./pricing"), exports);
 __exportStar(require("./groups"), exports);
 __exportStar(require("./emailSections"), exports);
 __exportStar(require("./exportTransformers"), 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,2CAAyB;AACzB,kDAAgC;AAChC,uDAAqC;AACrC,kDAAgC;AAChC,iDAA+B;AAC/B,2DAAyC;AACzC,uDAAqC;AACrC,iDAA+B;AAC/B,8CAA4B;AAC5B,qDAAmC;AACnC,0CAAwB;AACxB,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,wCAAsB;AACtB,oDAAkC;AAClC,4CAA0B;AAC1B,2CAAyB;AACzB,kDAAgC;AAChC,uDAAqC;AACrC,kDAAgC;AAChC,iDAA+B;AAC/B,2DAAyC;AACzC,uDAAqC;AACrC,iDAA+B;AAC/B,8CAA4B;AAC5B,qDAAmC;AACnC,0CAAwB;AACxB,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/pricing.d.ts

@@ -0,0 +1,137 @@
+/**
+ * The 2026 pricing model.
+ *
+ * A quote is a base fee plus a per-product fee, and every per-product fee is
+ * graduated: the tiers are bands, not lookups, so a school with 1,250 students
+ * pays the tier 1 rate on its first 1,000 and the tier 2 rate on the next 250.
+ * Anything above the final threshold keeps paying the final tier's rate.
+ *
+ * Work experience is charged per placement (Y10 and Y12 are quoted separately,
+ * and a year group left blank is a year group not taking the product); events
+ * and destinations are charged per student. Only events and destinations carry
+ * a partial-product discount — that is how the pricing sheet has it, and it is
+ * why `partialProductDiscount` names those two rather than being one number.
+ *
+ * Every figure lives in `PricingConfig` so it can be stored in Firestore and
+ * adjusted without a deploy. `DEFAULT_PRICING_CONFIG` is the fallback and the
+ * seed for that document.
+ */
+/** One band of the graduated fee, with the rate each product charges in it. */
+export type PricingTier = {
+    /** Upper bound of the band, in students (events and destinations). */
+    students: number;
+    /** Upper bound of the band, in placements (work experience). */
+    placements: number;
+    /** £ per placement. */
+    wex: number;
+    /** £ per student. */
+    events: number;
+    /** £ per student. */
+    destinations: number;
+};
+export type PricingConfig = {
+    /** No school is quoted below this, however little the products come to. */
+    minFee: number;
+    /** Charged on every quote. Not itemised to the customer. */
+    baseFee: number;
+    /** In ascending order of threshold. The last band's rate runs to infinity. */
+    tiers: PricingTier[];
+    /** Taken off a single product's fee, as a fraction (0.2 = 20% off). */
+    partialProductDiscount: {
+        events: number;
+        destinations: number;
+    };
+    /** Taken off the whole quote when a school takes the full platform. */
+    fullPlatformDiscount: number;
+    /** Careers hubs are a flat platform fee plus a fee for each school. */
+    hub: {
+        baseFee: number;
+        perSchoolFee: number;
+    };
+};
+/** The pricing sheet's figures, as agreed for 2026. */
+export declare const DEFAULT_PRICING_CONFIG: PricingConfig;
+/** Where the adjustable copy of the config lives. */
+export declare const PRICING_CONFIG_PATH: string[];
+export type SchoolPricingInput = {
+    /** Roll size. Drives the events and destinations fees. */
+    students?: number;
+    /** Y10 placements. Undefined means the year group isn't taking work experience. */
+    wexY10?: number;
+    /** Y12 placements. Undefined means the year group isn't taking work experience. */
+    wexY12?: number;
+    events?: boolean;
+    /** Discount the events fee on its own. */
+    eventsDiscount?: boolean;
+    destinations?: boolean;
+    /** Discount the destinations fee on its own. */
+    destinationsDiscount?: boolean;
+    /** Discount the whole quote, for a school taking the full platform. */
+    fullPlatformDiscount?: boolean;
+};
+export type PricingLineKey = "base" | "wexY10" | "wexY12" | "events" | "destinations";
+export type PricingLine = {
+    key: PricingLineKey;
+    label: string;
+    /** What the product costs after any partial-product discount. */
+    amount: number;
+    /** The fee before its partial-product discount, when one was applied. */
+    undiscounted?: number;
+    /** How the amount was reached, band by band. Empty for the base fee. */
+    bands: PricingBand[];
+};
+/** One band's contribution to a product's fee, for showing the working. */
+export type PricingBand = {
+    /** 1-indexed, matching the tier's position in the config. */
+    tier: number;
+    /** Units charged in this band. */
+    quantity: number;
+    rate: number;
+    amount: number;
+};
+export type SchoolPricingResult = {
+    lines: PricingLine[];
+    /** The lines added up, before the full-platform discount. */
+    subtotal: number;
+    /** £ taken off the subtotal by the full-platform discount. */
+    fullPlatformDiscountApplied: number;
+    /** True when the minimum fee, not the products, set the price. */
+    minFeeApplied: boolean;
+    total: number;
+};
+export type HubPricingResult = {
+    baseFee: number;
+    /** The per-school fee multiplied by the number of schools. */
+    schoolFees: number;
+    total: number;
+};
+/**
+ * Price a school, trust or hub-school quote.
+ *
+ * Products the school isn't taking are left out of `lines` entirely, so the
+ * breakdown only ever shows what is being charged for.
+ *
+ * @param {object} input the roll, the year groups and the products taken.
+ * @param {object} [config] the figures to price with. Defaults to the 2026 sheet.
+ * @return {object} the total, and the working that reached it.
+ */
+export declare function calculateSchoolPrice(input: SchoolPricingInput, config?: PricingConfig): SchoolPricingResult;
+/**
+ * Price a careers hub: the platform fee, plus a fee for every school on it.
+ *
+ * @param {number} schools how many schools the hub brings on.
+ * @param {object} [config] the figures to price with. Defaults to the 2026 sheet.
+ * @return {object} the platform fee, the school fees and the total.
+ */
+export declare function calculateHubPrice(schools: number, config?: PricingConfig): HubPricingResult;
+/**
+ * Fill a stored config out with the defaults.
+ *
+ * The Firestore document is hand-edited, so treat every branch of it as
+ * possibly absent — a config saved before a tier was added should still price,
+ * rather than throwing on a missing rate.
+ *
+ * @param {object} [stored] whatever the Firestore document holds.
+ * @return {object} a complete config, safe to price with.
+ */
+export declare function mergePricingConfig(stored?: Partial<PricingConfig>): PricingConfig;

package/lib/pricing.js

@@ -0,0 +1,156 @@
+"use strict";
+/**
+ * The 2026 pricing model.
+ *
+ * A quote is a base fee plus a per-product fee, and every per-product fee is
+ * graduated: the tiers are bands, not lookups, so a school with 1,250 students
+ * pays the tier 1 rate on its first 1,000 and the tier 2 rate on the next 250.
+ * Anything above the final threshold keeps paying the final tier's rate.
+ *
+ * Work experience is charged per placement (Y10 and Y12 are quoted separately,
+ * and a year group left blank is a year group not taking the product); events
+ * and destinations are charged per student. Only events and destinations carry
+ * a partial-product discount — that is how the pricing sheet has it, and it is
+ * why `partialProductDiscount` names those two rather than being one number.
+ *
+ * Every figure lives in `PricingConfig` so it can be stored in Firestore and
+ * adjusted without a deploy. `DEFAULT_PRICING_CONFIG` is the fallback and the
+ * seed for that document.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PRICING_CONFIG_PATH = exports.DEFAULT_PRICING_CONFIG = void 0;
+exports.calculateSchoolPrice = calculateSchoolPrice;
+exports.calculateHubPrice = calculateHubPrice;
+exports.mergePricingConfig = mergePricingConfig;
+/** The pricing sheet's figures, as agreed for 2026. */
+exports.DEFAULT_PRICING_CONFIG = {
+    minFee: 500,
+    baseFee: 250,
+    tiers: [
+        { students: 1000, placements: 20, wex: 3, events: 0.6, destinations: 0.6 },
+        { students: 1500, placements: 150, wex: 3, events: 0.5, destinations: 0.5 },
+        { students: 2000, placements: 200, wex: 1.5, events: 0.25, destinations: 0.25 },
+    ],
+    partialProductDiscount: { events: 0.2, destinations: 0.2 },
+    fullPlatformDiscount: 0.2,
+    hub: { baseFee: 2000, perSchoolFee: 150 },
+};
+/** Where the adjustable copy of the config lives. */
+exports.PRICING_CONFIG_PATH = ["adminConfig", "pricing"];
+/**
+ * Charge `quantity` across the bands, each band at its own rate, with anything
+ * above the final threshold staying on the final band's rate.
+ *
+ * @param {number} quantity students or placements, depending on the product.
+ * @param {Array} bands each band's upper threshold and its rate.
+ * @return {Array} one entry per band that charged something.
+ */
+function graduated(quantity, bands) {
+    if (!(quantity > 0) || !bands.length)
+        return [];
+    const lines = [];
+    let previousLimit = 0;
+    bands.forEach((band, index) => {
+        const inBand = Math.max(Math.min(quantity, band.limit) - previousLimit, 0);
+        previousLimit = band.limit;
+        if (inBand > 0)
+            lines.push({ tier: index + 1, quantity: inBand, rate: band.rate, amount: inBand * band.rate });
+    });
+    // Everything past the last threshold keeps paying the last rate, so it belongs
+    // in the last band rather than as a second row at the same rate.
+    const last = bands[bands.length - 1];
+    const overflow = Math.max(quantity - last.limit, 0);
+    if (overflow > 0) {
+        const finalBand = lines.find((l) => l.tier === bands.length);
+        if (finalBand) {
+            finalBand.quantity += overflow;
+            finalBand.amount += overflow * last.rate;
+        }
+        else {
+            lines.push({ tier: bands.length, quantity: overflow, rate: last.rate, amount: overflow * last.rate });
+        }
+    }
+    return lines;
+}
+const sum = (values) => values.reduce((total, value) => total + value, 0);
+const bandsTotal = (bands) => sum(bands.map((b) => b.amount));
+/**
+ * Price a school, trust or hub-school quote.
+ *
+ * Products the school isn't taking are left out of `lines` entirely, so the
+ * breakdown only ever shows what is being charged for.
+ *
+ * @param {object} input the roll, the year groups and the products taken.
+ * @param {object} [config] the figures to price with. Defaults to the 2026 sheet.
+ * @return {object} the total, and the working that reached it.
+ */
+function calculateSchoolPrice(input, config = exports.DEFAULT_PRICING_CONFIG) {
+    const students = input.students || 0;
+    const tiers = config.tiers;
+    const perPlacement = tiers.map((t) => ({ limit: t.placements, rate: t.wex }));
+    const perStudent = (key) => tiers.map((t) => ({ limit: t.students, rate: t[key] }));
+    const lines = [{ key: "base", label: "Base fee", amount: config.baseFee, bands: [] }];
+    const addWex = (key, label, placements) => {
+        if (placements === undefined)
+            return;
+        const bands = graduated(placements, perPlacement);
+        lines.push({ key, label, amount: bandsTotal(bands), bands });
+    };
+    addWex("wexY10", "Work experience — Y10", input.wexY10);
+    addWex("wexY12", "Work experience — Y12", input.wexY12);
+    const addPerStudent = (key, label, taken, discounted) => {
+        if (!taken)
+            return;
+        const bands = graduated(students, perStudent(key));
+        const undiscounted = bandsTotal(bands);
+        const amount = discounted ? undiscounted * (1 - config.partialProductDiscount[key]) : undiscounted;
+        lines.push({ key, label, amount, bands, ...(discounted ? { undiscounted } : {}) });
+    };
+    addPerStudent("events", "Employer events", input.events, input.eventsDiscount);
+    addPerStudent("destinations", "Destinations", input.destinations, input.destinationsDiscount);
+    const subtotal = sum(lines.map((l) => l.amount));
+    const discounted = input.fullPlatformDiscount ? subtotal * (1 - config.fullPlatformDiscount) : subtotal;
+    const total = Math.max(discounted, config.minFee);
+    return {
+        lines,
+        subtotal,
+        fullPlatformDiscountApplied: subtotal - discounted,
+        minFeeApplied: total > discounted,
+        total,
+    };
+}
+/**
+ * Price a careers hub: the platform fee, plus a fee for every school on it.
+ *
+ * @param {number} schools how many schools the hub brings on.
+ * @param {object} [config] the figures to price with. Defaults to the 2026 sheet.
+ * @return {object} the platform fee, the school fees and the total.
+ */
+function calculateHubPrice(schools, config = exports.DEFAULT_PRICING_CONFIG) {
+    const schoolFees = Math.max(schools || 0, 0) * config.hub.perSchoolFee;
+    return { baseFee: config.hub.baseFee, schoolFees, total: config.hub.baseFee + schoolFees };
+}
+/**
+ * Fill a stored config out with the defaults.
+ *
+ * The Firestore document is hand-edited, so treat every branch of it as
+ * possibly absent — a config saved before a tier was added should still price,
+ * rather than throwing on a missing rate.
+ *
+ * @param {object} [stored] whatever the Firestore document holds.
+ * @return {object} a complete config, safe to price with.
+ */
+function mergePricingConfig(stored) {
+    const d = exports.DEFAULT_PRICING_CONFIG;
+    if (!stored)
+        return d;
+    return {
+        minFee: stored.minFee ?? d.minFee,
+        baseFee: stored.baseFee ?? d.baseFee,
+        tiers: stored.tiers?.length ? stored.tiers.map((t, i) => ({ ...(d.tiers[i] || d.tiers[d.tiers.length - 1]), ...t })) : d.tiers,
+        partialProductDiscount: { ...d.partialProductDiscount, ...stored.partialProductDiscount },
+        fullPlatformDiscount: stored.fullPlatformDiscount ?? d.fullPlatformDiscount,
+        hub: { ...d.hub, ...stored.hub },
+    };
+}
+//# sourceMappingURL=pricing.js.map

package/lib/pricing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pricing.js","sourceRoot":"","sources":["../src/pricing.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;GAiBG;;;AA6JH,oDA0CC;AASD,8CAMC;AAYD,gDAYC;AA/MD,uDAAuD;AAC1C,QAAA,sBAAsB,GAAkB;IACjD,MAAM,EAAE,GAAG;IACX,OAAO,EAAE,GAAG;IACZ,KAAK,EAAE;QACH,EAAC,QAAQ,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,YAAY,EAAE,GAAG,EAAC;QACxE,EAAC,QAAQ,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,YAAY,EAAE,GAAG,EAAC;QACzE,EAAC,QAAQ,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAC;KAChF;IACD,sBAAsB,EAAE,EAAC,MAAM,EAAE,GAAG,EAAE,YAAY,EAAE,GAAG,EAAC;IACxD,oBAAoB,EAAE,GAAG;IACzB,GAAG,EAAE,EAAC,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,GAAG,EAAC;CAC1C,CAAC;AAEF,qDAAqD;AACxC,QAAA,mBAAmB,GAAG,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;AA4D9D;;;;;;;GAOG;AACH,SAAS,SAAS,CAAC,QAAgB,EAAE,KAAsC;IACvE,IAAI,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM;QAAE,OAAO,EAAE,CAAC;IAEhD,MAAM,KAAK,GAAkB,EAAE,CAAC;IAChC,IAAI,aAAa,GAAG,CAAC,CAAC;IAEtB,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QAC1B,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,aAAa,EAAE,CAAC,CAAC,CAAC;QAC3E,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC;QAC3B,IAAI,MAAM,GAAG,CAAC;YAAE,KAAK,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,KAAK,GAAG,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,IAAI,EAAC,CAAC,CAAC;IACjH,CAAC,CAAC,CAAC;IAEH,+EAA+E;IAC/E,iEAAiE;IACjE,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACrC,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IACpD,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;QACf,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,MAAM,CAAC,CAAC;QAC7D,IAAI,SAAS,EAAE,CAAC;YACZ,SAAS,CAAC,QAAQ,IAAI,QAAQ,CAAC;YAC/B,SAAS,CAAC,MAAM,IAAI,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC;QAC7C,CAAC;aAAM,CAAC;YACJ,KAAK,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,GAAG,IAAI,CAAC,IAAI,EAAC,CAAC,CAAC;QACxG,CAAC;IACL,CAAC;IAED,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,MAAM,GAAG,GAAG,CAAC,MAAgB,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC;AAEpF,MAAM,UAAU,GAAG,CAAC,KAAoB,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;AAE7E;;;;;;;;;GASG;AACH,SAAgB,oBAAoB,CAChC,KAAyB,EACzB,SAAwB,8BAAsB;IAE9C,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,CAAC,CAAC;IACrC,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;IAE3B,MAAM,YAAY,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAC,KAAK,EAAE,CAAC,CAAC,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,EAAC,CAAC,CAAC,CAAC;IAC5E,MAAM,UAAU,GAAG,CAAC,GAA4B,EAAE,EAAE,CAChD,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAC,KAAK,EAAE,CAAC,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,EAAC,CAAC,CAAC,CAAC;IAE1D,MAAM,KAAK,GAAkB,CAAC,EAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,EAAC,CAAC,CAAC;IAEnG,MAAM,MAAM,GAAG,CAAC,GAAsB,EAAE,KAAa,EAAE,UAAmB,EAAE,EAAE;QAC1E,IAAI,UAAU,KAAK,SAAS;YAAE,OAAO;QACrC,MAAM,KAAK,GAAG,SAAS,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;QAClD,KAAK,CAAC,IAAI,CAAC,EAAC,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,KAAK,CAAC,EAAE,KAAK,EAAC,CAAC,CAAC;IAC/D,CAAC,CAAC;IACF,MAAM,CAAC,QAAQ,EAAE,uBAAuB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACxD,MAAM,CAAC,QAAQ,EAAE,uBAAuB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExD,MAAM,aAAa,GAAG,CAAC,GAA4B,EAAE,KAAa,EAAE,KAAe,EAAE,UAAoB,EAAE,EAAE;QACzG,IAAI,CAAC,KAAK;YAAE,OAAO;QACnB,MAAM,KAAK,GAAG,SAAS,CAAC,QAAQ,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;QACnD,MAAM,YAAY,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;QACvC,MAAM,MAAM,GAAG,UAAU,CAAC,CAAC,CAAC,YAAY,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC;QACnG,KAAK,CAAC,IAAI,CAAC,EAAC,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,EAAC,YAAY,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAC,CAAC,CAAC;IACnF,CAAC,CAAC;IACF,aAAa,CAAC,QAAQ,EAAE,iBAAiB,EAAE,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IAC/E,aAAa,CAAC,cAAc,EAAE,cAAc,EAAE,KAAK,CAAC,YAAY,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAE9F,MAAM,QAAQ,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;IACjD,MAAM,UAAU,GAAG,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;IACxG,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAElD,OAAO;QACH,KAAK;QACL,QAAQ;QACR,2BAA2B,EAAE,QAAQ,GAAG,UAAU;QAClD,aAAa,EAAE,KAAK,GAAG,UAAU;QACjC,KAAK;KACR,CAAC;AACN,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,iBAAiB,CAC7B,OAAe,EACf,SAAwB,8BAAsB;IAE9C,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,IAAI,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC;IACvE,OAAO,EAAC,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,OAAO,GAAG,UAAU,EAAC,CAAC;AAC7F,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,kBAAkB,CAAC,MAA+B;IAC9D,MAAM,CAAC,GAAG,8BAAsB,CAAC;IACjC,IAAI,CAAC,MAAM;QAAE,OAAO,CAAC,CAAC;IAEtB,OAAO;QACH,MAAM,EAAE,MAAM,CAAC,MAAM,IAAI,CAAC,CAAC,MAAM;QACjC,OAAO,EAAE,MAAM,CAAC,OAAO,IAAI,CAAC,CAAC,OAAO;QACpC,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK;QAC5H,sBAAsB,EAAE,EAAC,GAAG,CAAC,CAAC,sBAAsB,EAAE,GAAG,MAAM,CAAC,sBAAsB,EAAC;QACvF,oBAAoB,EAAE,MAAM,CAAC,oBAAoB,IAAI,CAAC,CAAC,oBAAoB;QAC3E,GAAG,EAAE,EAAC,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,GAAG,EAAC;KACjC,CAAC;AACN,CAAC"}

package/lib/pricing.test.d.ts

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

package/lib/pricing.test.js

@@ -0,0 +1,119 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const pricing_1 = require("./pricing");
+/**
+ * The worked examples from the 2026 pricing sheet, kept here as the contract:
+ * if the calculation drifts from the spreadsheet, these fail. The awkward
+ * numbers (Teddington's 1405/7 year groups) are the point — they exercise the
+ * band boundaries and the overflow rate rather than landing on round tiers.
+ */
+const price = (input) => (0, pricing_1.calculateSchoolPrice)(input).total;
+const line = (input, key) => (0, pricing_1.calculateSchoolPrice)(input).lines.find((l) => l.key === key);
+describe("calculateSchoolPrice - the pricing sheet's examples", () => {
+    it("GHS: 1,250 students, discounted events", () => {
+        // 1,000 @ 0.6 + 250 @ 0.5 = 725, less 20% = 580, plus the 250 base.
+        const input = { students: 1250, events: true, eventsDiscount: true };
+        expect(line(input, "events")?.amount).toBeCloseTo(580, 2);
+        expect(price(input)).toBeCloseTo(830, 2);
+    });
+    it("Horizon: a small school falls back to the minimum fee", () => {
+        // 250 + 30 + 30 + 54 = 364, which is under the 500 floor.
+        const input = { students: 90, wexY10: 10, wexY12: 10, destinations: true };
+        const result = (0, pricing_1.calculateSchoolPrice)(input);
+        expect(result.subtotal).toBeCloseTo(364, 2);
+        expect(result.minFeeApplied).toBe(true);
+        expect(result.total).toBe(500);
+    });
+    it("Big School: 2,500 students spills past the last tier at the last rate", () => {
+        // 600 + 250 + 125 + (500 over the top threshold @ 0.25) 125 = 1,100.
+        const input = { students: 2500, events: true };
+        expect(line(input, "events")?.amount).toBeCloseTo(1100, 2);
+        expect(price(input)).toBeCloseTo(1350, 2);
+    });
+    it("BET School: 1,500 students on events and destinations", () => {
+        expect(price({ students: 1500, events: true, destinations: true })).toBeCloseTo(1950, 2);
+    });
+    it("Alperton: both products discounted individually", () => {
+        const input = {
+            students: 1929,
+            events: true, eventsDiscount: true,
+            destinations: true, destinationsDiscount: true,
+        };
+        expect(line(input, "events")?.undiscounted).toBeCloseTo(957.25, 2);
+        expect(line(input, "events")?.amount).toBeCloseTo(765.8, 2);
+        expect(price(input)).toBeCloseTo(1781.6, 2);
+    });
+    it("Teddington: full platform, with year groups estimated as roll/7", () => {
+        const yearGroup = 1405 / 7;
+        const input = {
+            students: 1405,
+            wexY10: yearGroup, wexY12: yearGroup,
+            events: true, destinations: true,
+            fullPlatformDiscount: true,
+        };
+        const result = (0, pricing_1.calculateSchoolPrice)(input);
+        expect(line(input, "wexY10")?.amount).toBeCloseTo(526.07, 2);
+        expect(result.subtotal).toBeCloseTo(2907.14, 2);
+        expect(result.total).toBeCloseTo(2325.71, 2);
+    });
+});
+describe("calculateSchoolPrice - the breakdown", () => {
+    it("only itemises the products the school is taking", () => {
+        const keys = (0, pricing_1.calculateSchoolPrice)({ students: 1000, events: true }).lines.map((l) => l.key);
+        expect(keys).toEqual(["base", "events"]);
+    });
+    it("charges a year group that is taking work experience but has no placements yet", () => {
+        // Zero is a real answer; undefined means the year group isn't on the product.
+        expect(line({ students: 500, wexY10: 0 }, "wexY10")?.amount).toBe(0);
+        expect(line({ students: 500 }, "wexY10")).toBeUndefined();
+    });
+    it("shows the working, band by band", () => {
+        const bands = line({ students: 1250, events: true }, "events")?.bands;
+        expect(bands).toEqual([
+            { tier: 1, quantity: 1000, rate: 0.6, amount: 600 },
+            { tier: 2, quantity: 250, rate: 0.5, amount: 125 },
+        ]);
+    });
+    it("rolls the amount above the top threshold into the final band", () => {
+        // 2,500 students is 500 past the last threshold, charged at the last rate:
+        // one Tier 3 row of 1,000, not a 500 row and a 500 row.
+        const bands = line({ students: 2500, events: true }, "events")?.bands;
+        expect(bands).toEqual([
+            { tier: 1, quantity: 1000, rate: 0.6, amount: 600 },
+            { tier: 2, quantity: 500, rate: 0.5, amount: 250 },
+            { tier: 3, quantity: 1000, rate: 0.25, amount: 250 },
+        ]);
+    });
+    it("reports what the full-platform discount took off", () => {
+        const result = (0, pricing_1.calculateSchoolPrice)({ students: 2000, events: true, destinations: true, fullPlatformDiscount: true });
+        expect(result.fullPlatformDiscountApplied).toBeCloseTo(result.subtotal * 0.2, 6);
+        expect(result.total).toBeCloseTo(result.subtotal - result.fullPlatformDiscountApplied, 6);
+    });
+});
+describe("calculateHubPrice", () => {
+    it("prices the agreed option: 2,000 base plus 150 a school", () => {
+        expect((0, pricing_1.calculateHubPrice)(50).total).toBe(9500);
+        expect((0, pricing_1.calculateHubPrice)(100).total).toBe(17000);
+    });
+    it("is the base fee alone with no schools", () => {
+        expect((0, pricing_1.calculateHubPrice)(0)).toEqual({ baseFee: 2000, schoolFees: 0, total: 2000 });
+    });
+});
+describe("mergePricingConfig", () => {
+    it("returns the defaults when nothing is stored", () => {
+        expect((0, pricing_1.mergePricingConfig)()).toEqual(pricing_1.DEFAULT_PRICING_CONFIG);
+        expect((0, pricing_1.mergePricingConfig)({})).toEqual(pricing_1.DEFAULT_PRICING_CONFIG);
+    });
+    it("takes a stored value without losing its siblings", () => {
+        const merged = (0, pricing_1.mergePricingConfig)({ minFee: 750, hub: { perSchoolFee: 200 } });
+        expect(merged.minFee).toBe(750);
+        expect(merged.baseFee).toBe(pricing_1.DEFAULT_PRICING_CONFIG.baseFee);
+        expect(merged.hub).toEqual({ baseFee: 2000, perSchoolFee: 200 });
+    });
+    it("fills a half-written tier out from the default in its place", () => {
+        const merged = (0, pricing_1.mergePricingConfig)({ tiers: [{ events: 0.8 }, {}, {}] });
+        expect(merged.tiers[0]).toEqual({ ...pricing_1.DEFAULT_PRICING_CONFIG.tiers[0], events: 0.8 });
+        expect(merged.tiers[2]).toEqual(pricing_1.DEFAULT_PRICING_CONFIG.tiers[2]);
+    });
+});
+//# sourceMappingURL=pricing.test.js.map

package/lib/pricing.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pricing.test.js","sourceRoot":"","sources":["../src/pricing.test.ts"],"names":[],"mappings":";;AAAA,uCAAkI;AAElI;;;;;GAKG;AAEH,MAAM,KAAK,GAAG,CAAC,KAAyB,EAAE,EAAE,CAAC,IAAA,8BAAoB,EAAC,KAAK,CAAC,CAAC,KAAK,CAAC;AAE/E,MAAM,IAAI,GAAG,CAAC,KAAyB,EAAE,GAAW,EAAE,EAAE,CACpD,IAAA,8BAAoB,EAAC,KAAK,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;AAEjE,QAAQ,CAAC,qDAAqD,EAAE,GAAG,EAAE;IACjE,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;QAC9C,oEAAoE;QACpE,MAAM,KAAK,GAAuB,EAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAC,CAAC;QAEvF,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QAC1D,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;QAC7D,0DAA0D;QAC1D,MAAM,KAAK,GAAuB,EAAC,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,YAAY,EAAE,IAAI,EAAC,CAAC;QAC7F,MAAM,MAAM,GAAG,IAAA,8BAAoB,EAAC,KAAK,CAAC,CAAC;QAE3C,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QAC5C,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uEAAuE,EAAE,GAAG,EAAE;QAC7E,qEAAqE;QACrE,MAAM,KAAK,GAAuB,EAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAC,CAAC;QAEjE,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QAC3D,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;QAC7D,MAAM,CAAC,KAAK,CAAC,EAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAC,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAC3F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;QACvD,MAAM,KAAK,GAAuB;YAC9B,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI;YAClC,YAAY,EAAE,IAAI,EAAE,oBAAoB,EAAE,IAAI;SACjD,CAAC;QAEF,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,YAAY,CAAC,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QACnE,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAC5D,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAChD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;QACvE,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,CAAC;QAC3B,MAAM,KAAK,GAAuB;YAC9B,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS;YACpC,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI;YAChC,oBAAoB,EAAE,IAAI;SAC7B,CAAC;QACF,MAAM,MAAM,GAAG,IAAA,8BAAoB,EAAC,KAAK,CAAC,CAAC;QAE3C,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC7D,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;QAChD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,sCAAsC,EAAE,GAAG,EAAE;IAClD,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;QACvD,MAAM,IAAI,GAAG,IAAA,8BAAoB,EAAC,EAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QAE1F,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+EAA+E,EAAE,GAAG,EAAE;QACrF,8EAA8E;QAC9E,MAAM,CAAC,IAAI,CAAC,EAAC,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,EAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACnE,MAAM,CAAC,IAAI,CAAC,EAAC,QAAQ,EAAE,GAAG,EAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;IAC5D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;QACvC,MAAM,KAAK,GAAG,IAAI,CAAC,EAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAC,EAAE,QAAQ,CAAC,EAAE,KAAK,CAAC;QAEpE,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;YAClB,EAAC,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAC;YACjD,EAAC,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAC;SACnD,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,GAAG,EAAE;QACpE,2EAA2E;QAC3E,wDAAwD;QACxD,MAAM,KAAK,GAAG,IAAI,CAAC,EAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAC,EAAE,QAAQ,CAAC,EAAE,KAAK,CAAC;QAEpE,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;YAClB,EAAC,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAC;YACjD,EAAC,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAC;YAChD,EAAC,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAC;SACrD,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;QACxD,MAAM,MAAM,GAAG,IAAA,8BAAoB,EAAC,EAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,oBAAoB,EAAE,IAAI,EAAC,CAAC,CAAC;QAEpH,MAAM,CAAC,MAAM,CAAC,2BAA2B,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC;QACjF,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,2BAA2B,EAAE,CAAC,CAAC,CAAC;IAC9F,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IAC/B,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;QAC9D,MAAM,CAAC,IAAA,2BAAiB,EAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/C,MAAM,CAAC,IAAA,2BAAiB,EAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC7C,MAAM,CAAC,IAAA,2BAAiB,EAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAC,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,EAAC,CAAC,CAAC;IACtF,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAChC,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACnD,MAAM,CAAC,IAAA,4BAAkB,GAAE,CAAC,CAAC,OAAO,CAAC,gCAAsB,CAAC,CAAC;QAC7D,MAAM,CAAC,IAAA,4BAAkB,EAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,gCAAsB,CAAC,CAAC;IACnE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;QACxD,MAAM,MAAM,GAAG,IAAA,4BAAkB,EAAC,EAAC,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,EAAC,YAAY,EAAE,GAAG,EAAU,EAAC,CAAC,CAAC;QAEpF,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAChC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,gCAAsB,CAAC,OAAO,CAAC,CAAC;QAC5D,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,EAAC,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,GAAG,EAAC,CAAC,CAAC;IACnE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;QACnE,MAAM,MAAM,GAAG,IAAA,4BAAkB,EAAC,EAAC,KAAK,EAAE,CAAC,EAAC,MAAM,EAAE,GAAG,EAAU,EAAE,EAAW,EAAE,EAAW,CAAC,EAAC,CAAC,CAAC;QAE/F,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAC,GAAG,gCAAsB,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,EAAC,CAAC,CAAC;QACnF,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,gCAAsB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/lib/typeDefinitions.d.ts

@@ -779,8 +779,9 @@ export type WorkflowStage = {
  * - "open": schools may add or remove freely. */
 export type WorkflowEditPolicy = "locked" | "add" | "open";
 /** The features a trust can impose on its schools. Work experience is absent because
- * it predates this and carries its policy on the workflow document itself — see
- * WorkflowConfig.mandatory/editPolicy, which this generalises. */
+ * it predates this and carries its policy on the cohort template a school applies —
+ * see InstituteData.cohortConfig.mandatory and WorkflowConfig.editPolicy, which this
+ * generalises. */
 export type TrustPolicyFeature = "regularChecks" | "aspirations" | "leaverGroups" | "skills";
 /**
  * A trust's answer for one feature.
@@ -822,10 +823,10 @@ export type WorkflowConfig = {
     /** Flattened forms/files used across the stages, mirroring CohortData.forms/files. */
     forms?: string[];
     files?: string[];
-    /** Authored by a trust (institutes-two) for the schools beneath it. */
+    /** Authored by a trust (institutes-two) for the schools beneath it. A trust
+     * requires a workflow by putting it on a mandatory cohort template
+     * (InstituteData.cohortConfig), not by marking the workflow itself. */
     trust?: boolean;
-    /** Schools in the trust must use this workflow on their work experience cohorts. */
-    mandatory?: boolean;
     /** What a school may change on the stages of this workflow. Defaults to "open". */
     editPolicy?: WorkflowEditPolicy;
 };
@@ -1169,14 +1170,26 @@ export type InstituteData = {
             v: unknown;
         }[];
     };
+    /**
+     * Two things share this map, because they are the same thing at two levels.
+     *
+     * On a SCHOOL it is a recurring work experience group: a cohort is spawned from
+     * it each year on `createMMDD`, carrying the dates, filters and settings below.
+     *
+     * On a TRUST (institutes-two) it is a settings template its schools apply when
+     * they create a cohort. A trust neither runs cohorts nor knows a school's dates,
+     * so the scheduling and student-filter fields are absent there — a trust template
+     * only carries the things it is entitled to decide (workflow, feedback forms and,
+     * in future, daily logs) plus whether its schools must use it (`mandatory`).
+     */
     cohortConfig?: {
         [groupId: string]: {
             name: string;
-            placementType: "defined" | "continuous";
+            placementType?: "defined" | "continuous";
             workflowId?: string;
             workflowOverrides?: WorkflowOverrides;
-            autoCreate: boolean;
-            createMMDD: string;
+            autoCreate?: boolean;
+            createMMDD?: string;
             autoAddFilter?: {
                 k: string;
                 e?: WhereFilterOp;
@@ -1185,6 +1198,9 @@ export type InstituteData = {
             feedback?: CohortData["feedback"];
             feedbackText?: CohortData["feedbackText"];
             emailParentOnStatusChange?: boolean;
+            /** Trust templates only — schools must apply this template to every new
+             * work experience cohort. Optional templates are offered as a choice. */
+            mandatory?: boolean;
         };
     };
     cs?: CustomerSuccessData;

package/lib/workflows.d.ts

@@ -5,18 +5,15 @@ import { CohortData, InstituteData, WorkflowConfig, WorkflowEditPolicy, Workflow
  * school (or a trust, on behalf of its schools) defines a workflow once and every cohort
  * that uses it points at it with CohortData.workflowId.
  *
- * A trust can mark its workflow mandatory, in which case schools beneath it get that
- * workflowId applied to new cohorts. Schools may still layer per-stage forms/files on top
- * (subject to the workflow's editPolicy); those deltas are stored as WorkflowOverrides on
- * the cohort, and mirrored onto the recurring group template so they carry into next year.
+ * A trust requires a workflow by putting it on a cohort template it marks mandatory
+ * (InstituteData.cohortConfig) — the workflow document itself says nothing about who
+ * must use it. Schools may still layer per-stage forms/files on top (subject to the
+ * workflow's editPolicy); those deltas are stored as WorkflowOverrides on the cohort,
+ * and mirrored onto the recurring group template so they carry into next year.
  */
 /** The trust a school belongs to, if any. */
 export declare const approvedTrustId: (institute?: Pick<InstituteData, "trustLinks">) => string | undefined;
-/** The trust-authored workflow a school is obliged to use, if the trust set one. */
-export declare const mandatoryTrustWorkflow: (workflows?: {
-    [id: string]: WorkflowConfig;
-}, trustId?: string) => [string, WorkflowConfig] | undefined;
-/** Trust workflows visible to a school, mandatory or not. */
+/** Trust workflows visible to a school. */
 export declare const trustWorkflows: (workflows?: {
     [id: string]: WorkflowConfig;
 }, trustId?: string) => [string, WorkflowConfig][];

package/lib/workflows.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.cohortWorkflowConfigured = exports.workflowEditPolicy = exports.trustWorkflows = exports.mandatoryTrustWorkflow = exports.approvedTrustId = void 0;
+exports.cohortWorkflowConfigured = exports.workflowEditPolicy = exports.trustWorkflows = exports.approvedTrustId = void 0;
 exports.applyWorkflowOverrides = applyWorkflowOverrides;
 exports.diffWorkflowOverrides = diffWorkflowOverrides;
 exports.enforceEditPolicy = enforceEditPolicy;
@@ -16,23 +16,16 @@ const firebaseQuery_1 = __importDefault(require("./firebase/firebaseQuery"));
  * school (or a trust, on behalf of its schools) defines a workflow once and every cohort
  * that uses it points at it with CohortData.workflowId.
  *
- * A trust can mark its workflow mandatory, in which case schools beneath it get that
- * workflowId applied to new cohorts. Schools may still layer per-stage forms/files on top
- * (subject to the workflow's editPolicy); those deltas are stored as WorkflowOverrides on
- * the cohort, and mirrored onto the recurring group template so they carry into next year.
+ * A trust requires a workflow by putting it on a cohort template it marks mandatory
+ * (InstituteData.cohortConfig) — the workflow document itself says nothing about who
+ * must use it. Schools may still layer per-stage forms/files on top (subject to the
+ * workflow's editPolicy); those deltas are stored as WorkflowOverrides on the cohort,
+ * and mirrored onto the recurring group template so they carry into next year.
  */
 /** The trust a school belongs to, if any. */
 const approvedTrustId = (institute) => Object.entries(institute?.trustLinks || {}).find(([, l]) => l.status === "approved")?.[0];
 exports.approvedTrustId = approvedTrustId;
-/** The trust-authored workflow a school is obliged to use, if the trust set one. */
-const mandatoryTrustWorkflow = (workflows, trustId) => {
-    if (!trustId)
-        return undefined;
-    return Object.entries(workflows || {})
-        .find(([, w]) => w.trust && w.mandatory && w.oId === trustId);
-};
-exports.mandatoryTrustWorkflow = mandatoryTrustWorkflow;
-/** Trust workflows visible to a school, mandatory or not. */
+/** Trust workflows visible to a school. */
 const trustWorkflows = (workflows, trustId) => Object.entries(workflows || {}).filter(([, w]) => w.trust && (!trustId || w.oId === trustId));
 exports.trustWorkflows = trustWorkflows;
 const workflowEditPolicy = (workflow) => (workflow?.trust ? workflow.editPolicy || "open" : "open");

package/lib/workflows.js.map

@@ -1 +1 @@
-{"version":3,"file":"workflows.js","sourceRoot":"","sources":["../src/workflows.ts"],"names":[],"mappings":";;;;;;AAoCA,wDAWC;AAGD,sDAgBC;AASD,8CAMC;AAGD,oEAQC;AAMD,sDAQC;AAID,kDAQC;AAtHD,6EAAqD;AAGrD;;;;;;;;;GASG;AAEH,6CAA6C;AACtC,MAAM,eAAe,GAAG,CAAC,SAA6C,EAAE,EAAE,CAC7E,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,UAAU,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AADjF,QAAA,eAAe,mBACkE;AAE9F,oFAAoF;AAC7E,MAAM,sBAAsB,GAAG,CAClC,SAA0C,EAC1C,OAAgB,EACkB,EAAE;IACpC,IAAI,CAAC,OAAO;QAAE,OAAO,SAAS,CAAC;IAC/B,OAAO,MAAM,CAAC,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC;SACjC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,SAAS,IAAI,CAAC,CAAC,GAAG,KAAK,OAAO,CAAC,CAAC;AACtE,CAAC,CAAC;AAPW,QAAA,sBAAsB,0BAOjC;AAEF,6DAA6D;AACtD,MAAM,cAAc,GAAG,CAAC,SAA0C,EAAE,OAAgB,EAAE,EAAE,CAC3F,MAAM,CAAC,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,GAAG,KAAK,OAAO,CAAC,CAAC,CAAC;AADrF,QAAA,cAAc,kBACuE;AAE3F,MAAM,kBAAkB,GAAG,CAAC,QAAyB,EAAsB,EAAE,CAChF,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,IAAI,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;AADlD,QAAA,kBAAkB,sBACgC;AAE/D,0EAA0E;AAC1E,SAAgB,sBAAsB,CAAC,QAAyB,EAAE,SAA6B;IAC3F,IAAI,CAAC,SAAS,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM;QAAE,OAAO,QAAQ,CAAC;IAClE,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QAC1B,MAAM,QAAQ,GAAG,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;QAC7C,IAAI,CAAC,QAAQ;YAAE,OAAO,KAAK,CAAC;QAC5B,OAAO;YACH,GAAG,KAAK;YACR,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAClD,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC;SACrD,CAAC;IACN,CAAC,CAAC,CAAC;AACP,CAAC;AAED,gGAAgG;AAChG,SAAgB,qBAAqB,CAAC,IAAqB,EAAE,MAAuB;IAChF,MAAM,QAAQ,GAAG,CAAC,CAAY,EAAE,CAAY,EAAE,EAAE,CAC5C,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAE3F,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;QAChC,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC,EAAE,CAAC,CAAC;QACtD,IAAI,CAAC,SAAS;YAAE,OAAO,GAAG,CAAC;QAC3B,MAAM,YAAY,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC;QAC7D,MAAM,YAAY,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC;QAC7D,IAAI,CAAC,YAAY,IAAI,CAAC,YAAY;YAAE,OAAO,GAAG,CAAC;QAC/C,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,GAAG;YACpB,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,EAAC,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,EAAE,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACnD,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,EAAC,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,EAAE,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC;SACtD,CAAC;QACF,OAAO,GAAG,CAAC;IACf,CAAC,EAAE,EAAuB,CAAC,CAAC;AAChC,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,iBAAiB,CAAC,IAAwB,EAAE,QAA4B,EAAE,MAA0B;IAChH,MAAM,QAAQ,GAAG,IAAI,IAAI,EAAE,CAAC;IAC5B,MAAM,YAAY,GAAG,QAAQ,IAAI,EAAE,CAAC;IACpC,IAAI,MAAM,KAAK,QAAQ;QAAE,OAAO,CAAC,GAAG,QAAQ,CAAC,CAAC;IAC9C,IAAI,MAAM,KAAK,KAAK;QAAE,OAAO,CAAC,GAAG,QAAQ,EAAE,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACjG,OAAO,CAAC,GAAG,YAAY,CAAC,CAAC;AAC7B,CAAC;AAED,sFAAsF;AACtF,SAAgB,4BAA4B,CAAC,QAAyB;IAClE,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;IAChC,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;IAChC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QACvB,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACtD,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;IACH,OAAO,EAAC,KAAK,EAAE,CAAC,GAAG,KAAK,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,CAAC,EAAC,CAAC;AAClD,CAAC;AAED;;;GAGG;AACH,SAAgB,qBAAqB,CACjC,MAAoE,EACpE,SAA0C;IAE1C,IAAI,CAAC,MAAM,EAAE,UAAU;QAAE,OAAO,EAAE,CAAC;IACnC,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAC9C,IAAI,CAAC,MAAM;QAAE,OAAO,EAAE,CAAC;IACvB,OAAO,sBAAsB,CAAC,MAAM,CAAC,QAAQ,IAAI,EAAE,EAAE,MAAM,CAAC,iBAAiB,CAAC,CAAC;AACnF,CAAC;AAED;oFACoF;AAC7E,KAAK,UAAU,mBAAmB,CACrC,MAAoE,EACpE,aAAa,GAAG,IAAI,uBAAa,EAAE;IAEnC,IAAI,CAAC,MAAM,EAAE,UAAU;QAAE,OAAO,EAAE,CAAC;IACnC,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,UAAU,CAAC,CAAC,WAAW,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAA6B,CAAC;IACnI,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM;QAAE,OAAO,EAAE,CAAC;IACzC,OAAO,sBAAsB,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,iBAAiB,CAAC,CAAC;AAC7E,CAAC;AAED,yDAAyD;AAClD,MAAM,wBAAwB,GAAG,CACpC,MAAgD,EAChD,SAA0C,EAC5C,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,UAAU,IAAI,SAAS,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;AAHxE,QAAA,wBAAwB,4BAGgD"}
+{"version":3,"file":"workflows.js","sourceRoot":"","sources":["../src/workflows.ts"],"names":[],"mappings":";;;;;;AA2BA,wDAWC;AAGD,sDAgBC;AASD,8CAMC;AAGD,oEAQC;AAMD,sDAQC;AAID,kDAQC;AA7GD,6EAAqD;AAGrD;;;;;;;;;;GAUG;AAEH,6CAA6C;AACtC,MAAM,eAAe,GAAG,CAAC,SAA6C,EAAE,EAAE,CAC7E,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,UAAU,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AADjF,QAAA,eAAe,mBACkE;AAE9F,2CAA2C;AACpC,MAAM,cAAc,GAAG,CAAC,SAA0C,EAAE,OAAgB,EAAE,EAAE,CAC3F,MAAM,CAAC,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,GAAG,KAAK,OAAO,CAAC,CAAC,CAAC;AADrF,QAAA,cAAc,kBACuE;AAE3F,MAAM,kBAAkB,GAAG,CAAC,QAAyB,EAAsB,EAAE,CAChF,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,IAAI,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;AADlD,QAAA,kBAAkB,sBACgC;AAE/D,0EAA0E;AAC1E,SAAgB,sBAAsB,CAAC,QAAyB,EAAE,SAA6B;IAC3F,IAAI,CAAC,SAAS,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM;QAAE,OAAO,QAAQ,CAAC;IAClE,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QAC1B,MAAM,QAAQ,GAAG,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;QAC7C,IAAI,CAAC,QAAQ;YAAE,OAAO,KAAK,CAAC;QAC5B,OAAO;YACH,GAAG,KAAK;YACR,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAClD,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC;SACrD,CAAC;IACN,CAAC,CAAC,CAAC;AACP,CAAC;AAED,gGAAgG;AAChG,SAAgB,qBAAqB,CAAC,IAAqB,EAAE,MAAuB;IAChF,MAAM,QAAQ,GAAG,CAAC,CAAY,EAAE,CAAY,EAAE,EAAE,CAC5C,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAE3F,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;QAChC,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC,EAAE,CAAC,CAAC;QACtD,IAAI,CAAC,SAAS;YAAE,OAAO,GAAG,CAAC;QAC3B,MAAM,YAAY,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC;QAC7D,MAAM,YAAY,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC;QAC7D,IAAI,CAAC,YAAY,IAAI,CAAC,YAAY;YAAE,OAAO,GAAG,CAAC;QAC/C,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,GAAG;YACpB,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,EAAC,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,EAAE,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACnD,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,EAAC,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,EAAE,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC;SACtD,CAAC;QACF,OAAO,GAAG,CAAC;IACf,CAAC,EAAE,EAAuB,CAAC,CAAC;AAChC,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,iBAAiB,CAAC,IAAwB,EAAE,QAA4B,EAAE,MAA0B;IAChH,MAAM,QAAQ,GAAG,IAAI,IAAI,EAAE,CAAC;IAC5B,MAAM,YAAY,GAAG,QAAQ,IAAI,EAAE,CAAC;IACpC,IAAI,MAAM,KAAK,QAAQ;QAAE,OAAO,CAAC,GAAG,QAAQ,CAAC,CAAC;IAC9C,IAAI,MAAM,KAAK,KAAK;QAAE,OAAO,CAAC,GAAG,QAAQ,EAAE,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACjG,OAAO,CAAC,GAAG,YAAY,CAAC,CAAC;AAC7B,CAAC;AAED,sFAAsF;AACtF,SAAgB,4BAA4B,CAAC,QAAyB;IAClE,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;IAChC,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;IAChC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QACvB,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACtD,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;IACH,OAAO,EAAC,KAAK,EAAE,CAAC,GAAG,KAAK,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,CAAC,EAAC,CAAC;AAClD,CAAC;AAED;;;GAGG;AACH,SAAgB,qBAAqB,CACjC,MAAoE,EACpE,SAA0C;IAE1C,IAAI,CAAC,MAAM,EAAE,UAAU;QAAE,OAAO,EAAE,CAAC;IACnC,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAC9C,IAAI,CAAC,MAAM;QAAE,OAAO,EAAE,CAAC;IACvB,OAAO,sBAAsB,CAAC,MAAM,CAAC,QAAQ,IAAI,EAAE,EAAE,MAAM,CAAC,iBAAiB,CAAC,CAAC;AACnF,CAAC;AAED;oFACoF;AAC7E,KAAK,UAAU,mBAAmB,CACrC,MAAoE,EACpE,aAAa,GAAG,IAAI,uBAAa,EAAE;IAEnC,IAAI,CAAC,MAAM,EAAE,UAAU;QAAE,OAAO,EAAE,CAAC;IACnC,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,UAAU,CAAC,CAAC,WAAW,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAA6B,CAAC;IACnI,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM;QAAE,OAAO,EAAE,CAAC;IACzC,OAAO,sBAAsB,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,iBAAiB,CAAC,CAAC;AAC7E,CAAC;AAED,yDAAyD;AAClD,MAAM,wBAAwB,GAAG,CACpC,MAAgD,EAChD,SAA0C,EAC5C,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,UAAU,IAAI,SAAS,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;AAHxE,QAAA,wBAAwB,4BAGgD"}

package/package.json

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

package/src/index.ts

@@ -19,6 +19,7 @@ export * from "./skillsResolver";
 export * from "./activities";
 export * from "./lmi";
 export * from "./productResolver";
+export * from "./pricing";
 export * from "./groups";
 export * from "./emailSections";
 export * from "./exportTransformers";

package/src/pricing.test.ts

@@ -0,0 +1,147 @@
+import {calculateHubPrice, calculateSchoolPrice, DEFAULT_PRICING_CONFIG, mergePricingConfig, SchoolPricingInput} from "./pricing";
+
+/**
+ * The worked examples from the 2026 pricing sheet, kept here as the contract:
+ * if the calculation drifts from the spreadsheet, these fail. The awkward
+ * numbers (Teddington's 1405/7 year groups) are the point — they exercise the
+ * band boundaries and the overflow rate rather than landing on round tiers.
+ */
+
+const price = (input: SchoolPricingInput) => calculateSchoolPrice(input).total;
+
+const line = (input: SchoolPricingInput, key: string) =>
+    calculateSchoolPrice(input).lines.find((l) => l.key === key);
+
+describe("calculateSchoolPrice - the pricing sheet's examples", () => {
+    it("GHS: 1,250 students, discounted events", () => {
+        // 1,000 @ 0.6 + 250 @ 0.5 = 725, less 20% = 580, plus the 250 base.
+        const input: SchoolPricingInput = {students: 1250, events: true, eventsDiscount: true};
+
+        expect(line(input, "events")?.amount).toBeCloseTo(580, 2);
+        expect(price(input)).toBeCloseTo(830, 2);
+    });
+
+    it("Horizon: a small school falls back to the minimum fee", () => {
+        // 250 + 30 + 30 + 54 = 364, which is under the 500 floor.
+        const input: SchoolPricingInput = {students: 90, wexY10: 10, wexY12: 10, destinations: true};
+        const result = calculateSchoolPrice(input);
+
+        expect(result.subtotal).toBeCloseTo(364, 2);
+        expect(result.minFeeApplied).toBe(true);
+        expect(result.total).toBe(500);
+    });
+
+    it("Big School: 2,500 students spills past the last tier at the last rate", () => {
+        // 600 + 250 + 125 + (500 over the top threshold @ 0.25) 125 = 1,100.
+        const input: SchoolPricingInput = {students: 2500, events: true};
+
+        expect(line(input, "events")?.amount).toBeCloseTo(1100, 2);
+        expect(price(input)).toBeCloseTo(1350, 2);
+    });
+
+    it("BET School: 1,500 students on events and destinations", () => {
+        expect(price({students: 1500, events: true, destinations: true})).toBeCloseTo(1950, 2);
+    });
+
+    it("Alperton: both products discounted individually", () => {
+        const input: SchoolPricingInput = {
+            students: 1929,
+            events: true, eventsDiscount: true,
+            destinations: true, destinationsDiscount: true,
+        };
+
+        expect(line(input, "events")?.undiscounted).toBeCloseTo(957.25, 2);
+        expect(line(input, "events")?.amount).toBeCloseTo(765.8, 2);
+        expect(price(input)).toBeCloseTo(1781.6, 2);
+    });
+
+    it("Teddington: full platform, with year groups estimated as roll/7", () => {
+        const yearGroup = 1405 / 7;
+        const input: SchoolPricingInput = {
+            students: 1405,
+            wexY10: yearGroup, wexY12: yearGroup,
+            events: true, destinations: true,
+            fullPlatformDiscount: true,
+        };
+        const result = calculateSchoolPrice(input);
+
+        expect(line(input, "wexY10")?.amount).toBeCloseTo(526.07, 2);
+        expect(result.subtotal).toBeCloseTo(2907.14, 2);
+        expect(result.total).toBeCloseTo(2325.71, 2);
+    });
+});
+
+describe("calculateSchoolPrice - the breakdown", () => {
+    it("only itemises the products the school is taking", () => {
+        const keys = calculateSchoolPrice({students: 1000, events: true}).lines.map((l) => l.key);
+
+        expect(keys).toEqual(["base", "events"]);
+    });
+
+    it("charges a year group that is taking work experience but has no placements yet", () => {
+        // Zero is a real answer; undefined means the year group isn't on the product.
+        expect(line({students: 500, wexY10: 0}, "wexY10")?.amount).toBe(0);
+        expect(line({students: 500}, "wexY10")).toBeUndefined();
+    });
+
+    it("shows the working, band by band", () => {
+        const bands = line({students: 1250, events: true}, "events")?.bands;
+
+        expect(bands).toEqual([
+            {tier: 1, quantity: 1000, rate: 0.6, amount: 600},
+            {tier: 2, quantity: 250, rate: 0.5, amount: 125},
+        ]);
+    });
+
+    it("rolls the amount above the top threshold into the final band", () => {
+        // 2,500 students is 500 past the last threshold, charged at the last rate:
+        // one Tier 3 row of 1,000, not a 500 row and a 500 row.
+        const bands = line({students: 2500, events: true}, "events")?.bands;
+
+        expect(bands).toEqual([
+            {tier: 1, quantity: 1000, rate: 0.6, amount: 600},
+            {tier: 2, quantity: 500, rate: 0.5, amount: 250},
+            {tier: 3, quantity: 1000, rate: 0.25, amount: 250},
+        ]);
+    });
+
+    it("reports what the full-platform discount took off", () => {
+        const result = calculateSchoolPrice({students: 2000, events: true, destinations: true, fullPlatformDiscount: true});
+
+        expect(result.fullPlatformDiscountApplied).toBeCloseTo(result.subtotal * 0.2, 6);
+        expect(result.total).toBeCloseTo(result.subtotal - result.fullPlatformDiscountApplied, 6);
+    });
+});
+
+describe("calculateHubPrice", () => {
+    it("prices the agreed option: 2,000 base plus 150 a school", () => {
+        expect(calculateHubPrice(50).total).toBe(9500);
+        expect(calculateHubPrice(100).total).toBe(17000);
+    });
+
+    it("is the base fee alone with no schools", () => {
+        expect(calculateHubPrice(0)).toEqual({baseFee: 2000, schoolFees: 0, total: 2000});
+    });
+});
+
+describe("mergePricingConfig", () => {
+    it("returns the defaults when nothing is stored", () => {
+        expect(mergePricingConfig()).toEqual(DEFAULT_PRICING_CONFIG);
+        expect(mergePricingConfig({})).toEqual(DEFAULT_PRICING_CONFIG);
+    });
+
+    it("takes a stored value without losing its siblings", () => {
+        const merged = mergePricingConfig({minFee: 750, hub: {perSchoolFee: 200} as never});
+
+        expect(merged.minFee).toBe(750);
+        expect(merged.baseFee).toBe(DEFAULT_PRICING_CONFIG.baseFee);
+        expect(merged.hub).toEqual({baseFee: 2000, perSchoolFee: 200});
+    });
+
+    it("fills a half-written tier out from the default in its place", () => {
+        const merged = mergePricingConfig({tiers: [{events: 0.8} as never, {} as never, {} as never]});
+
+        expect(merged.tiers[0]).toEqual({...DEFAULT_PRICING_CONFIG.tiers[0], events: 0.8});
+        expect(merged.tiers[2]).toEqual(DEFAULT_PRICING_CONFIG.tiers[2]);
+    });
+});

package/src/pricing.ts

@@ -0,0 +1,256 @@
+/**
+ * The 2026 pricing model.
+ *
+ * A quote is a base fee plus a per-product fee, and every per-product fee is
+ * graduated: the tiers are bands, not lookups, so a school with 1,250 students
+ * pays the tier 1 rate on its first 1,000 and the tier 2 rate on the next 250.
+ * Anything above the final threshold keeps paying the final tier's rate.
+ *
+ * Work experience is charged per placement (Y10 and Y12 are quoted separately,
+ * and a year group left blank is a year group not taking the product); events
+ * and destinations are charged per student. Only events and destinations carry
+ * a partial-product discount — that is how the pricing sheet has it, and it is
+ * why `partialProductDiscount` names those two rather than being one number.
+ *
+ * Every figure lives in `PricingConfig` so it can be stored in Firestore and
+ * adjusted without a deploy. `DEFAULT_PRICING_CONFIG` is the fallback and the
+ * seed for that document.
+ */
+
+/** One band of the graduated fee, with the rate each product charges in it. */
+export type PricingTier = {
+    /** Upper bound of the band, in students (events and destinations). */
+    students: number,
+    /** Upper bound of the band, in placements (work experience). */
+    placements: number,
+    /** £ per placement. */
+    wex: number,
+    /** £ per student. */
+    events: number,
+    /** £ per student. */
+    destinations: number,
+};
+
+export type PricingConfig = {
+    /** No school is quoted below this, however little the products come to. */
+    minFee: number,
+    /** Charged on every quote. Not itemised to the customer. */
+    baseFee: number,
+    /** In ascending order of threshold. The last band's rate runs to infinity. */
+    tiers: PricingTier[],
+    /** Taken off a single product's fee, as a fraction (0.2 = 20% off). */
+    partialProductDiscount: {events: number, destinations: number},
+    /** Taken off the whole quote when a school takes the full platform. */
+    fullPlatformDiscount: number,
+    /** Careers hubs are a flat platform fee plus a fee for each school. */
+    hub: {baseFee: number, perSchoolFee: number},
+};
+
+/** The pricing sheet's figures, as agreed for 2026. */
+export const DEFAULT_PRICING_CONFIG: PricingConfig = {
+    minFee: 500,
+    baseFee: 250,
+    tiers: [
+        {students: 1000, placements: 20, wex: 3, events: 0.6, destinations: 0.6},
+        {students: 1500, placements: 150, wex: 3, events: 0.5, destinations: 0.5},
+        {students: 2000, placements: 200, wex: 1.5, events: 0.25, destinations: 0.25},
+    ],
+    partialProductDiscount: {events: 0.2, destinations: 0.2},
+    fullPlatformDiscount: 0.2,
+    hub: {baseFee: 2000, perSchoolFee: 150},
+};
+
+/** Where the adjustable copy of the config lives. */
+export const PRICING_CONFIG_PATH = ["adminConfig", "pricing"];
+
+export type SchoolPricingInput = {
+    /** Roll size. Drives the events and destinations fees. */
+    students?: number,
+    /** Y10 placements. Undefined means the year group isn't taking work experience. */
+    wexY10?: number,
+    /** Y12 placements. Undefined means the year group isn't taking work experience. */
+    wexY12?: number,
+    events?: boolean,
+    /** Discount the events fee on its own. */
+    eventsDiscount?: boolean,
+    destinations?: boolean,
+    /** Discount the destinations fee on its own. */
+    destinationsDiscount?: boolean,
+    /** Discount the whole quote, for a school taking the full platform. */
+    fullPlatformDiscount?: boolean,
+};
+
+export type PricingLineKey = "base"|"wexY10"|"wexY12"|"events"|"destinations";
+
+export type PricingLine = {
+    key: PricingLineKey,
+    label: string,
+    /** What the product costs after any partial-product discount. */
+    amount: number,
+    /** The fee before its partial-product discount, when one was applied. */
+    undiscounted?: number,
+    /** How the amount was reached, band by band. Empty for the base fee. */
+    bands: PricingBand[],
+};
+
+/** One band's contribution to a product's fee, for showing the working. */
+export type PricingBand = {
+    /** 1-indexed, matching the tier's position in the config. */
+    tier: number,
+    /** Units charged in this band. */
+    quantity: number,
+    rate: number,
+    amount: number,
+};
+
+export type SchoolPricingResult = {
+    lines: PricingLine[],
+    /** The lines added up, before the full-platform discount. */
+    subtotal: number,
+    /** £ taken off the subtotal by the full-platform discount. */
+    fullPlatformDiscountApplied: number,
+    /** True when the minimum fee, not the products, set the price. */
+    minFeeApplied: boolean,
+    total: number,
+};
+
+export type HubPricingResult = {
+    baseFee: number,
+    /** The per-school fee multiplied by the number of schools. */
+    schoolFees: number,
+    total: number,
+};
+
+/**
+ * Charge `quantity` across the bands, each band at its own rate, with anything
+ * above the final threshold staying on the final band's rate.
+ *
+ * @param {number} quantity students or placements, depending on the product.
+ * @param {Array} bands each band's upper threshold and its rate.
+ * @return {Array} one entry per band that charged something.
+ */
+function graduated(quantity: number, bands: {limit: number, rate: number}[]): PricingBand[] {
+    if (!(quantity > 0) || !bands.length) return [];
+
+    const lines: PricingBand[] = [];
+    let previousLimit = 0;
+
+    bands.forEach((band, index) => {
+        const inBand = Math.max(Math.min(quantity, band.limit) - previousLimit, 0);
+        previousLimit = band.limit;
+        if (inBand > 0) lines.push({tier: index + 1, quantity: inBand, rate: band.rate, amount: inBand * band.rate});
+    });
+
+    // Everything past the last threshold keeps paying the last rate, so it belongs
+    // in the last band rather than as a second row at the same rate.
+    const last = bands[bands.length - 1];
+    const overflow = Math.max(quantity - last.limit, 0);
+    if (overflow > 0) {
+        const finalBand = lines.find((l) => l.tier === bands.length);
+        if (finalBand) {
+            finalBand.quantity += overflow;
+            finalBand.amount += overflow * last.rate;
+        } else {
+            lines.push({tier: bands.length, quantity: overflow, rate: last.rate, amount: overflow * last.rate});
+        }
+    }
+
+    return lines;
+}
+
+const sum = (values: number[]) => values.reduce((total, value) => total + value, 0);
+
+const bandsTotal = (bands: PricingBand[]) => sum(bands.map((b) => b.amount));
+
+/**
+ * Price a school, trust or hub-school quote.
+ *
+ * Products the school isn't taking are left out of `lines` entirely, so the
+ * breakdown only ever shows what is being charged for.
+ *
+ * @param {object} input the roll, the year groups and the products taken.
+ * @param {object} [config] the figures to price with. Defaults to the 2026 sheet.
+ * @return {object} the total, and the working that reached it.
+ */
+export function calculateSchoolPrice(
+    input: SchoolPricingInput,
+    config: PricingConfig = DEFAULT_PRICING_CONFIG,
+): SchoolPricingResult {
+    const students = input.students || 0;
+    const tiers = config.tiers;
+
+    const perPlacement = tiers.map((t) => ({limit: t.placements, rate: t.wex}));
+    const perStudent = (key: "events"|"destinations") =>
+        tiers.map((t) => ({limit: t.students, rate: t[key]}));
+
+    const lines: PricingLine[] = [{key: "base", label: "Base fee", amount: config.baseFee, bands: []}];
+
+    const addWex = (key: "wexY10"|"wexY12", label: string, placements?: number) => {
+        if (placements === undefined) return;
+        const bands = graduated(placements, perPlacement);
+        lines.push({key, label, amount: bandsTotal(bands), bands});
+    };
+    addWex("wexY10", "Work experience — Y10", input.wexY10);
+    addWex("wexY12", "Work experience — Y12", input.wexY12);
+
+    const addPerStudent = (key: "events"|"destinations", label: string, taken?: boolean, discounted?: boolean) => {
+        if (!taken) return;
+        const bands = graduated(students, perStudent(key));
+        const undiscounted = bandsTotal(bands);
+        const amount = discounted ? undiscounted * (1 - config.partialProductDiscount[key]) : undiscounted;
+        lines.push({key, label, amount, bands, ...(discounted ? {undiscounted} : {})});
+    };
+    addPerStudent("events", "Employer events", input.events, input.eventsDiscount);
+    addPerStudent("destinations", "Destinations", input.destinations, input.destinationsDiscount);
+
+    const subtotal = sum(lines.map((l) => l.amount));
+    const discounted = input.fullPlatformDiscount ? subtotal * (1 - config.fullPlatformDiscount) : subtotal;
+    const total = Math.max(discounted, config.minFee);
+
+    return {
+        lines,
+        subtotal,
+        fullPlatformDiscountApplied: subtotal - discounted,
+        minFeeApplied: total > discounted,
+        total,
+    };
+}
+
+/**
+ * Price a careers hub: the platform fee, plus a fee for every school on it.
+ *
+ * @param {number} schools how many schools the hub brings on.
+ * @param {object} [config] the figures to price with. Defaults to the 2026 sheet.
+ * @return {object} the platform fee, the school fees and the total.
+ */
+export function calculateHubPrice(
+    schools: number,
+    config: PricingConfig = DEFAULT_PRICING_CONFIG,
+): HubPricingResult {
+    const schoolFees = Math.max(schools || 0, 0) * config.hub.perSchoolFee;
+    return {baseFee: config.hub.baseFee, schoolFees, total: config.hub.baseFee + schoolFees};
+}
+
+/**
+ * Fill a stored config out with the defaults.
+ *
+ * The Firestore document is hand-edited, so treat every branch of it as
+ * possibly absent — a config saved before a tier was added should still price,
+ * rather than throwing on a missing rate.
+ *
+ * @param {object} [stored] whatever the Firestore document holds.
+ * @return {object} a complete config, safe to price with.
+ */
+export function mergePricingConfig(stored?: Partial<PricingConfig>): PricingConfig {
+    const d = DEFAULT_PRICING_CONFIG;
+    if (!stored) return d;
+
+    return {
+        minFee: stored.minFee ?? d.minFee,
+        baseFee: stored.baseFee ?? d.baseFee,
+        tiers: stored.tiers?.length ? stored.tiers.map((t, i) => ({...(d.tiers[i] || d.tiers[d.tiers.length - 1]), ...t})) : d.tiers,
+        partialProductDiscount: {...d.partialProductDiscount, ...stored.partialProductDiscount},
+        fullPlatformDiscount: stored.fullPlatformDiscount ?? d.fullPlatformDiscount,
+        hub: {...d.hub, ...stored.hub},
+    };
+}

package/src/typeDefinitions.ts

@@ -781,8 +781,9 @@ export type WorkflowStage = {
 export type WorkflowEditPolicy = "locked"|"add"|"open";
 
 /** The features a trust can impose on its schools. Work experience is absent because
- * it predates this and carries its policy on the workflow document itself — see
- * WorkflowConfig.mandatory/editPolicy, which this generalises. */
+ * it predates this and carries its policy on the cohort template a school applies —
+ * see InstituteData.cohortConfig.mandatory and WorkflowConfig.editPolicy, which this
+ * generalises. */
 export type TrustPolicyFeature = "regularChecks"|"aspirations"|"leaverGroups"|"skills";
 
 /**
@@ -828,10 +829,10 @@ export type WorkflowConfig = {
     forms?: string[],
     files?: string[],
     // --- Trust-authored workflows only ---
-    /** Authored by a trust (institutes-two) for the schools beneath it. */
+    /** Authored by a trust (institutes-two) for the schools beneath it. A trust
+     * requires a workflow by putting it on a mandatory cohort template
+     * (InstituteData.cohortConfig), not by marking the workflow itself. */
     trust?: boolean,
-    /** Schools in the trust must use this workflow on their work experience cohorts. */
-    mandatory?: boolean,
     /** What a school may change on the stages of this workflow. Defaults to "open". */
     editPolicy?: WorkflowEditPolicy,
 };
@@ -1199,16 +1200,27 @@ export type InstituteData = {
         v: unknown;
     }[],
     }
-    // RECURRING WORK EXPERIENCE GROUPS (templates that spawn a cohort instance each year)
+    /**
+     * Two things share this map, because they are the same thing at two levels.
+     *
+     * On a SCHOOL it is a recurring work experience group: a cohort is spawned from
+     * it each year on `createMMDD`, carrying the dates, filters and settings below.
+     *
+     * On a TRUST (institutes-two) it is a settings template its schools apply when
+     * they create a cohort. A trust neither runs cohorts nor knows a school's dates,
+     * so the scheduling and student-filter fields are absent there — a trust template
+     * only carries the things it is entitled to decide (workflow, feedback forms and,
+     * in future, daily logs) plus whether its schools must use it (`mandatory`).
+     */
     cohortConfig?: {
         [groupId: string]: {
             name: string,
-            placementType: "defined"|"continuous",
+            placementType?: "defined"|"continuous",  // school groups only
             workflowId?: string,            // doc in the `workflows` collection
             workflowOverrides?: WorkflowOverrides, // school deltas on a trust workflow, reapplied each year
-            autoCreate: boolean,            // recurrence on; always true when created via setup
-            createMMDD: string,             // "08-15" — annual creation trigger (mirrors aspirationCycleConfig.scheduledSendMMDD)
-            autoAddFilter?: {               // same shape as a cohortFilters entry; copied to cohortFilters[newCohortId] on creation
+            autoCreate?: boolean,           // school groups only — recurrence on
+            createMMDD?: string,            // school groups only — "08-15" annual creation trigger
+            autoAddFilter?: {               // school groups only; copied to cohortFilters[newCohortId] on creation
                 k: string;
                 e?: WhereFilterOp;
                 v: unknown;
@@ -1216,6 +1228,9 @@ export type InstituteData = {
             feedback?: CohortData["feedback"],          // promoted feedback form config
             feedbackText?: CohortData["feedbackText"],
             emailParentOnStatusChange?: boolean,
+            /** Trust templates only — schools must apply this template to every new
+             * work experience cohort. Optional templates are offered as a choice. */
+            mandatory?: boolean,
         }
     },
     cs?: CustomerSuccessData,

package/src/workflows.ts

@@ -6,27 +6,18 @@ import {CohortData, InstituteData, WorkflowConfig, WorkflowEditPolicy, WorkflowO
  * school (or a trust, on behalf of its schools) defines a workflow once and every cohort
  * that uses it points at it with CohortData.workflowId.
  *
- * A trust can mark its workflow mandatory, in which case schools beneath it get that
- * workflowId applied to new cohorts. Schools may still layer per-stage forms/files on top
- * (subject to the workflow's editPolicy); those deltas are stored as WorkflowOverrides on
- * the cohort, and mirrored onto the recurring group template so they carry into next year.
+ * A trust requires a workflow by putting it on a cohort template it marks mandatory
+ * (InstituteData.cohortConfig) — the workflow document itself says nothing about who
+ * must use it. Schools may still layer per-stage forms/files on top (subject to the
+ * workflow's editPolicy); those deltas are stored as WorkflowOverrides on the cohort,
+ * and mirrored onto the recurring group template so they carry into next year.
  */
 
 /** The trust a school belongs to, if any. */
 export const approvedTrustId = (institute?: Pick<InstituteData, "trustLinks">) =>
     Object.entries(institute?.trustLinks || {}).find(([, l]) => l.status === "approved")?.[0];
 
-/** The trust-authored workflow a school is obliged to use, if the trust set one. */
-export const mandatoryTrustWorkflow = (
-    workflows?: {[id: string]: WorkflowConfig},
-    trustId?: string,
-): [string, WorkflowConfig]|undefined => {
-    if (!trustId) return undefined;
-    return Object.entries(workflows || {})
-        .find(([, w]) => w.trust && w.mandatory && w.oId === trustId);
-};
-
-/** Trust workflows visible to a school, mandatory or not. */
+/** Trust workflows visible to a school. */
 export const trustWorkflows = (workflows?: {[id: string]: WorkflowConfig}, trustId?: string) =>
     Object.entries(workflows || {}).filter(([, w]) => w.trust && (!trustId || w.oId === trustId));