placementt-core 1.400.1038 → 1.400.1040

package/lib/callables/destinationsConfig.d.ts

@@ -17,12 +17,18 @@ export declare const destinationsConfigCallables: {
             /** The full DestinationsConfig from the setup wizard. Validated server
              * side, which is also where provenance fields are stamped. */
             config: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+            /** Trust-only: what this trust imposes on its schools, keyed by feature.
+             * Merged into the institute's existing policies, and refused outright
+             * from a school. Lives on the institute root, not inside config. */
+            trustPolicies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
         }, "strip", z.ZodTypeAny, {
             config: Record<string, unknown>;
             oId: string;
+            trustPolicies?: Record<string, unknown> | undefined;
         }, {
             config: Record<string, unknown>;
             oId: string;
+            trustPolicies?: Record<string, unknown> | undefined;
         }>;
         response: z.ZodObject<{
             saved: z.ZodBoolean;
@@ -39,6 +45,34 @@ export declare const destinationsConfigCallables: {
             created?: number | undefined;
         }>;
     };
+    "destinationsConfig-saveLeaverDestinations": {
+        request: z.ZodObject<{
+            oId: z.ZodString;
+            /** The school's own leaver destination categories, keyed by id. The nine
+             * NCCIS codes are fixed and are never sent — only what sits under them.
+             * Validated server side, which also stamps provenance and turns a
+             * removal into an archive. */
+            destinations: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        }, "strip", z.ZodTypeAny, {
+            oId: string;
+            destinations: Record<string, unknown>;
+        }, {
+            oId: string;
+            destinations: Record<string, unknown>;
+        }>;
+        response: z.ZodObject<{
+            saved: z.ZodBoolean;
+            /** The stored map, including anything the server archived rather than
+             * deleted — the client adopts this rather than its own copy. */
+            destinations: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        }, "strip", z.ZodTypeAny, {
+            destinations: Record<string, unknown>;
+            saved: boolean;
+        }, {
+            destinations: Record<string, unknown>;
+            saved: boolean;
+        }>;
+    };
     "destinationsConfig-provisionDestinationsNow": {
         request: z.ZodObject<{
             oId: z.ZodString;

package/lib/callables/destinationsConfig.js

@@ -20,6 +20,10 @@ exports.destinationsConfigCallables = {
             /** The full DestinationsConfig from the setup wizard. Validated server
              * side, which is also where provenance fields are stamped. */
             config: zod_1.z.record(zod_1.z.unknown()),
+            /** Trust-only: what this trust imposes on its schools, keyed by feature.
+             * Merged into the institute's existing policies, and refused outright
+             * from a school. Lives on the institute root, not inside config. */
+            trustPolicies: zod_1.z.record(zod_1.z.unknown()).optional(),
         }),
         response: zod_1.z.object({
             saved: zod_1.z.boolean(),
@@ -28,6 +32,22 @@ exports.destinationsConfigCallables = {
             created: zod_1.z.number().optional(),
         }),
     },
+    "destinationsConfig-saveLeaverDestinations": {
+        request: zod_1.z.object({
+            oId: zod_1.z.string(),
+            /** The school's own leaver destination categories, keyed by id. The nine
+             * NCCIS codes are fixed and are never sent — only what sits under them.
+             * Validated server side, which also stamps provenance and turns a
+             * removal into an archive. */
+            destinations: zod_1.z.record(zod_1.z.unknown()),
+        }),
+        response: zod_1.z.object({
+            saved: zod_1.z.boolean(),
+            /** The stored map, including anything the server archived rather than
+             * deleted — the client adopts this rather than its own copy. */
+            destinations: zod_1.z.record(zod_1.z.unknown()),
+        }),
+    },
     "destinationsConfig-provisionDestinationsNow": {
         request: zod_1.z.object({
             oId: zod_1.z.string(),

package/lib/callables/destinationsConfig.js.map

@@ -1 +1 @@
-{"version":3,"file":"destinationsConfig.js","sourceRoot":"","sources":["../../src/callables/destinationsConfig.ts"],"names":[],"mappings":";;;AAAA,6BAAsB;AAGtB;;;;;;;;;;GAUG;AACU,QAAA,2BAA2B,GAAG;IACvC,2CAA2C,EAAE;QACzC,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC;YACd,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE;YACf;0EAC8D;YAC9D,MAAM,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SAChC,CAAC;QACF,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC;YACf,KAAK,EAAE,OAAC,CAAC,OAAO,EAAE;YAClB,2EAA2E;YAC3E,WAAW,EAAE,OAAC,CAAC,OAAO,EAAE;YACxB,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;SACjC,CAAC;KACL;IACD,6CAA6C,EAAE;QAC3C,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC;YACd,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE;YACf,uEAAuE;YACvE,QAAQ,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;YAChC,8EAA8E;YAC9E,KAAK,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC,CAAC,QAAQ,EAAE;SACvD,CAAC;QACF,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC;YACf,WAAW,EAAE,OAAC,CAAC,OAAO,EAAE;YACxB,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE;YACnB,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE;SAC3B,CAAC;KACL;CACoB,CAAC"}
+{"version":3,"file":"destinationsConfig.js","sourceRoot":"","sources":["../../src/callables/destinationsConfig.ts"],"names":[],"mappings":";;;AAAA,6BAAsB;AAGtB;;;;;;;;;;GAUG;AACU,QAAA,2BAA2B,GAAG;IACvC,2CAA2C,EAAE;QACzC,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC;YACd,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE;YACf;0EAC8D;YAC9D,MAAM,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;YAC7B;;gFAEoE;YACpE,aAAa,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;SAClD,CAAC;QACF,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC;YACf,KAAK,EAAE,OAAC,CAAC,OAAO,EAAE;YAClB,2EAA2E;YAC3E,WAAW,EAAE,OAAC,CAAC,OAAO,EAAE;YACxB,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;SACjC,CAAC;KACL;IACD,2CAA2C,EAAE;QACzC,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC;YACd,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE;YACf;;;0CAG8B;YAC9B,YAAY,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACtC,CAAC;QACF,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC;YACf,KAAK,EAAE,OAAC,CAAC,OAAO,EAAE;YAClB;4EACgE;YAChE,YAAY,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACtC,CAAC;KACL;IACD,6CAA6C,EAAE;QAC3C,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC;YACd,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE;YACf,uEAAuE;YACvE,QAAQ,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;YAChC,8EAA8E;YAC9E,KAAK,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC,CAAC,QAAQ,EAAE;SACvD,CAAC;QACF,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC;YACf,WAAW,EAAE,OAAC,CAAC,OAAO,EAAE;YACxB,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE;YACnB,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE;SAC3B,CAAC;KACL;CACoB,CAAC"}

package/lib/callables/registry.d.ts

@@ -763,12 +763,15 @@ export declare const allCallables: {
         request: z.ZodObject<{
             oId: z.ZodString;
             config: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+            trustPolicies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
         }, "strip", z.ZodTypeAny, {
             config: Record<string, unknown>;
             oId: string;
+            trustPolicies?: Record<string, unknown> | undefined;
         }, {
             config: Record<string, unknown>;
             oId: string;
+            trustPolicies?: Record<string, unknown> | undefined;
         }>;
         response: z.ZodObject<{
             saved: z.ZodBoolean;
@@ -784,6 +787,28 @@ export declare const allCallables: {
             created?: number | undefined;
         }>;
     };
+    "destinationsConfig-saveLeaverDestinations": {
+        request: z.ZodObject<{
+            oId: z.ZodString;
+            destinations: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        }, "strip", z.ZodTypeAny, {
+            oId: string;
+            destinations: Record<string, unknown>;
+        }, {
+            oId: string;
+            destinations: Record<string, unknown>;
+        }>;
+        response: z.ZodObject<{
+            saved: z.ZodBoolean;
+            destinations: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        }, "strip", z.ZodTypeAny, {
+            destinations: Record<string, unknown>;
+            saved: boolean;
+        }, {
+            destinations: Record<string, unknown>;
+            saved: boolean;
+        }>;
+    };
     "destinationsConfig-provisionDestinationsNow": {
         request: z.ZodObject<{
             oId: z.ZodString;
@@ -833,12 +858,15 @@ export declare const callableGroups: {
             request: z.ZodObject<{
                 oId: z.ZodString;
                 config: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+                trustPolicies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
             }, "strip", z.ZodTypeAny, {
                 config: Record<string, unknown>;
                 oId: string;
+                trustPolicies?: Record<string, unknown> | undefined;
             }, {
                 config: Record<string, unknown>;
                 oId: string;
+                trustPolicies?: Record<string, unknown> | undefined;
             }>;
             response: z.ZodObject<{
                 saved: z.ZodBoolean;
@@ -854,6 +882,28 @@ export declare const callableGroups: {
                 created?: number | undefined;
             }>;
         };
+        "destinationsConfig-saveLeaverDestinations": {
+            request: z.ZodObject<{
+                oId: z.ZodString;
+                destinations: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+            }, "strip", z.ZodTypeAny, {
+                oId: string;
+                destinations: Record<string, unknown>;
+            }, {
+                oId: string;
+                destinations: Record<string, unknown>;
+            }>;
+            response: z.ZodObject<{
+                saved: z.ZodBoolean;
+                destinations: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+            }, "strip", z.ZodTypeAny, {
+                destinations: Record<string, unknown>;
+                saved: boolean;
+            }, {
+                destinations: Record<string, unknown>;
+                saved: boolean;
+            }>;
+        };
         "destinationsConfig-provisionDestinationsNow": {
             request: z.ZodObject<{
                 oId: z.ZodString;

package/lib/destinations.d.ts

@@ -0,0 +1,140 @@
+import { DestinationCode, DestinationValue, InstituteData, LeaverDestination } from "./typeDefinitions";
+/**
+ * destinations.ts — the nine NCCIS codes plus whatever a school has added to them.
+ *
+ * NCCIS gives every leaver one of nine activity codes, and two of them — NEET and
+ * NK — cover situations that could hardly be less alike: a leaver in hospital, one
+ * in care, one in custody and one who simply hasn't decided are all the same row of
+ * the return. Schools with SEND cohorts need that row broken up, so a school can
+ * define its own categories (`InstituteData.leaverDestinations`) and every one of
+ * them names the NCCIS code it counts within.
+ *
+ * That mapping is the whole design: a custom category's id is what gets stored and
+ * counted, so the school's own charts get the finer breakdown, while anything
+ * statutory (Compass+, the LA MI return) resolves it back to one of the nine.
+ */
+export type LeaverDestinationMap = {
+    [id: string]: LeaverDestination;
+};
+/**
+ * One option as the forms and charts see it — standard and custom side by side, so
+ * nothing downstream has to know which it is unless it cares.
+ */
+export type DestinationOption = {
+    /** What gets stored: an NCCIS code, or a custom category's id. */
+    code: DestinationValue;
+    label: string;
+    /** The NCCIS code this counts within — its own code, for the standard nine. */
+    nccisCode: DestinationCode;
+    custom: boolean;
+    description?: string;
+    archived?: boolean;
+};
+/** Ids become Firestore field-path segments (`aggregates.destinations.<id>`), so
+ * they may not contain a dot, a slash or anything else a path splits on. */
+export declare const DESTINATION_ID_PATTERN: RegExp;
+/** Custom ids carry a prefix so nothing can shadow a standard code, now or when
+ * NCCIS adds one. */
+export declare const CUSTOM_DESTINATION_PREFIX = "custom_";
+/** The NCCIS codes that mean "not in education, employment or training, or we don't
+ * know" — the pair schools break down, and the pair a positive-destination rate
+ * counts against. */
+export declare const NEGATIVE_DESTINATION_CODES: DestinationCode[];
+/**
+ * A stable id for a new custom category, derived from its label.
+ *
+ * @param {string} label the category's display name.
+ * @param {object} [existing] categories already defined, so ids stay unique.
+ * @return {string} a field-path-safe id.
+ */
+export declare const customDestinationId: (label: string, existing?: LeaverDestinationMap) => string;
+/** The nine NCCIS codes as options, in the order the MI return lists them. */
+export declare const standardDestinationOptions: () => DestinationOption[];
+/**
+ * Every destination a school offers: the nine standard codes, then its own
+ * categories grouped after the NCCIS code each one belongs to.
+ *
+ * Archived categories are left out unless asked for — they exist so that historical
+ * records keep their label, not so that new leavers can pick them.
+ *
+ * @param {object} [customs] the institute's leaverDestinations map.
+ * @param {object} [opts] `includeArchived` to keep withdrawn categories in the list.
+ * @return {DestinationOption[]} the ordered option list.
+ */
+export declare const destinationOptions: (customs?: LeaverDestinationMap, opts?: {
+    includeArchived?: boolean;
+}) => DestinationOption[];
+/**
+ * A school's categories, plus the ones its trust supplies.
+ *
+ * A trust's categories are extra vocabulary, not a mandate: they are added to
+ * whatever the school has of its own, and the school can neither edit nor remove
+ * them. Nothing is copied onto the school — resolution is a read-time merge, so a
+ * school that leaves the trust simply stops seeing them (see ./trustPolicies for why
+ * that is how every trust-supplied setting works here).
+ *
+ * On an id collision the SCHOOL's entry wins. Both keys are the same, so responses
+ * and aggregates land in the same place either way; what differs is that the school
+ * keeps the category it made, and keeps being able to edit it.
+ *
+ * @param {object} [school] the school's own institute doc.
+ * @param {object} [trust] the trust's institute doc, when the school is in one.
+ * @return {object} the merged map, and the ids the trust owns.
+ */
+export declare const resolveLeaverDestinations: (school?: Pick<InstituteData, "leaverDestinations">, trust?: Pick<InstituteData, "leaverDestinations">) => {
+    destinations: LeaverDestinationMap;
+    trustIds: string[];
+};
+/**
+ * What to show for a stored destination — a standard label, or a school's own.
+ *
+ * A category defined by a DIFFERENT school (a student browsing trust-wide alumni
+ * meets these) isn't in the map we hold, so its id is turned back into words rather
+ * than shown raw: an id is derived from the label it was created with, which makes
+ * "custom_in_hospital" recoverable as "In hospital".
+ *
+ * @param {string} [code] the stored destination.
+ * @param {object} [customs] the institute's leaverDestinations map.
+ * @return {string|undefined} the display label.
+ */
+export declare const destinationLabel: (code?: DestinationValue, customs?: LeaverDestinationMap) => string | undefined;
+/**
+ * The NCCIS code a stored destination counts within. Statutory exports and the
+ * NEET/NK figures go through this, never through the raw value.
+ *
+ * @param {string} [code] the stored destination.
+ * @param {object} [customs] the institute's leaverDestinations map.
+ * @return {DestinationCode|undefined} the NCCIS code to report it as.
+ */
+export declare const destinationNccisCode: (code?: DestinationValue, customs?: LeaverDestinationMap) => DestinationCode | undefined;
+/**
+ * Whether a destination is one of the two the school is trying to shrink. Custom
+ * categories count exactly as the NCCIS code they name does.
+ *
+ * @param {string} [code] the stored destination.
+ * @param {object} [customs] the institute's leaverDestinations map.
+ * @return {boolean} true for NEET / NK and anything mapped to them.
+ */
+export declare const isNegativeDestination: (code?: DestinationValue, customs?: LeaverDestinationMap) => boolean;
+/**
+ * Re-keys a `{destination: count}` aggregate onto the nine NCCIS codes, folding each
+ * custom category into its parent. For anything that has to report in NCCIS terms
+ * while the raw aggregate stays as granular as the school made it.
+ *
+ * @param {object} [counts] the raw aggregate.
+ * @param {object} [customs] the institute's leaverDestinations map.
+ * @return {object} counts keyed by NCCIS code.
+ */
+export declare const rollUpDestinationCounts: (counts?: {
+    [code: string]: number;
+}, customs?: LeaverDestinationMap) => {
+    [code: string]: number;
+};
+/**
+ * Validates a set of custom categories before it is stored. Shared by the setup card
+ * and the callable so both refuse the same things.
+ *
+ * @param {object} destinations the map to check.
+ * @return {string|undefined} the first problem found, or undefined if it's valid.
+ */
+export declare const validateLeaverDestinations: (destinations: LeaverDestinationMap) => string | undefined;

package/lib/destinations.js

@@ -0,0 +1,220 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateLeaverDestinations = exports.rollUpDestinationCounts = exports.isNegativeDestination = exports.destinationNccisCode = exports.destinationLabel = exports.resolveLeaverDestinations = exports.destinationOptions = exports.standardDestinationOptions = exports.customDestinationId = exports.NEGATIVE_DESTINATION_CODES = exports.CUSTOM_DESTINATION_PREFIX = exports.DESTINATION_ID_PATTERN = void 0;
+const constants_1 = require("./constants");
+/** Ids become Firestore field-path segments (`aggregates.destinations.<id>`), so
+ * they may not contain a dot, a slash or anything else a path splits on. */
+exports.DESTINATION_ID_PATTERN = /^[A-Za-z0-9_]{1,60}$/;
+/** Custom ids carry a prefix so nothing can shadow a standard code, now or when
+ * NCCIS adds one. */
+exports.CUSTOM_DESTINATION_PREFIX = "custom_";
+/** The NCCIS codes that mean "not in education, employment or training, or we don't
+ * know" — the pair schools break down, and the pair a positive-destination rate
+ * counts against. */
+exports.NEGATIVE_DESTINATION_CODES = ["NEET", "NK"];
+/**
+ * A stable id for a new custom category, derived from its label.
+ *
+ * @param {string} label the category's display name.
+ * @param {object} [existing] categories already defined, so ids stay unique.
+ * @return {string} a field-path-safe id.
+ */
+const customDestinationId = (label, existing) => {
+    const slug = (label || "")
+        .trim().toLowerCase()
+        .replace(/[^a-z0-9]+/g, "_")
+        .replace(/^_+|_+$/g, "")
+        .slice(0, 40) || "category";
+    const base = `${exports.CUSTOM_DESTINATION_PREFIX}${slug}`;
+    if (!existing?.[base])
+        return base;
+    // Two categories can legitimately slug the same ("In care" / "In-care"), so the
+    // second one gets a suffix rather than silently overwriting the first.
+    let n = 2;
+    while (existing[`${base}_${n}`])
+        n++;
+    return `${base}_${n}`;
+};
+exports.customDestinationId = customDestinationId;
+/** The nine NCCIS codes as options, in the order the MI return lists them. */
+const standardDestinationOptions = () => Object.entries(constants_1.DESTINATION_CODES).map(([code, label]) => ({
+    code, label, nccisCode: code, custom: false,
+}));
+exports.standardDestinationOptions = standardDestinationOptions;
+/**
+ * Every destination a school offers: the nine standard codes, then its own
+ * categories grouped after the NCCIS code each one belongs to.
+ *
+ * Archived categories are left out unless asked for — they exist so that historical
+ * records keep their label, not so that new leavers can pick them.
+ *
+ * @param {object} [customs] the institute's leaverDestinations map.
+ * @param {object} [opts] `includeArchived` to keep withdrawn categories in the list.
+ * @return {DestinationOption[]} the ordered option list.
+ */
+const destinationOptions = (customs, opts) => {
+    const custom = Object.entries(customs ?? {})
+        .filter(([, d]) => d && (opts?.includeArchived || !d.archived))
+        .map(([id, d]) => ({
+        code: id,
+        label: d.label,
+        nccisCode: (constants_1.DESTINATION_CODES[d.nccisCode] ? d.nccisCode : "NEET"),
+        custom: true,
+        description: d.description,
+        archived: d.archived,
+    }))
+        .sort((a, b) => a.label.localeCompare(b.label));
+    // Grouped under their parent so "In hospital" reads as a kind of NEET rather than
+    // as a tenth code of its own.
+    return (0, exports.standardDestinationOptions)().flatMap((std) => [
+        std, ...custom.filter((c) => c.nccisCode === std.code),
+    ]);
+};
+exports.destinationOptions = destinationOptions;
+/**
+ * A school's categories, plus the ones its trust supplies.
+ *
+ * A trust's categories are extra vocabulary, not a mandate: they are added to
+ * whatever the school has of its own, and the school can neither edit nor remove
+ * them. Nothing is copied onto the school — resolution is a read-time merge, so a
+ * school that leaves the trust simply stops seeing them (see ./trustPolicies for why
+ * that is how every trust-supplied setting works here).
+ *
+ * On an id collision the SCHOOL's entry wins. Both keys are the same, so responses
+ * and aggregates land in the same place either way; what differs is that the school
+ * keeps the category it made, and keeps being able to edit it.
+ *
+ * @param {object} [school] the school's own institute doc.
+ * @param {object} [trust] the trust's institute doc, when the school is in one.
+ * @return {object} the merged map, and the ids the trust owns.
+ */
+const resolveLeaverDestinations = (school, trust) => {
+    const own = school?.leaverDestinations ?? {};
+    const fromTrust = trust?.leaverDestinations ?? {};
+    const trustIds = Object.keys(fromTrust).filter((id) => !own[id]);
+    return {
+        destinations: { ...fromTrust, ...own },
+        trustIds,
+    };
+};
+exports.resolveLeaverDestinations = resolveLeaverDestinations;
+/**
+ * What to show for a stored destination — a standard label, or a school's own.
+ *
+ * A category defined by a DIFFERENT school (a student browsing trust-wide alumni
+ * meets these) isn't in the map we hold, so its id is turned back into words rather
+ * than shown raw: an id is derived from the label it was created with, which makes
+ * "custom_in_hospital" recoverable as "In hospital".
+ *
+ * @param {string} [code] the stored destination.
+ * @param {object} [customs] the institute's leaverDestinations map.
+ * @return {string|undefined} the display label.
+ */
+const destinationLabel = (code, customs) => {
+    if (!code)
+        return undefined;
+    if (constants_1.DESTINATION_CODES[code])
+        return constants_1.DESTINATION_CODES[code];
+    const known = customs?.[code]?.label;
+    if (known)
+        return known;
+    if (!code.startsWith(exports.CUSTOM_DESTINATION_PREFIX))
+        return code;
+    const words = code.slice(exports.CUSTOM_DESTINATION_PREFIX.length).replace(/_/g, " ").trim();
+    return words ? words.charAt(0).toUpperCase() + words.slice(1) : code;
+};
+exports.destinationLabel = destinationLabel;
+/**
+ * The NCCIS code a stored destination counts within. Statutory exports and the
+ * NEET/NK figures go through this, never through the raw value.
+ *
+ * @param {string} [code] the stored destination.
+ * @param {object} [customs] the institute's leaverDestinations map.
+ * @return {DestinationCode|undefined} the NCCIS code to report it as.
+ */
+const destinationNccisCode = (code, customs) => {
+    if (!code)
+        return undefined;
+    if (constants_1.DESTINATION_CODES[code])
+        return code;
+    const custom = customs?.[code];
+    // An id we no longer recognise is still somebody's leaver: "not known" is the
+    // honest reading, and it keeps them in the cohort rather than dropping them.
+    if (!custom)
+        return "NK";
+    return constants_1.DESTINATION_CODES[custom.nccisCode] ? custom.nccisCode : "NEET";
+};
+exports.destinationNccisCode = destinationNccisCode;
+/**
+ * Whether a destination is one of the two the school is trying to shrink. Custom
+ * categories count exactly as the NCCIS code they name does.
+ *
+ * @param {string} [code] the stored destination.
+ * @param {object} [customs] the institute's leaverDestinations map.
+ * @return {boolean} true for NEET / NK and anything mapped to them.
+ */
+const isNegativeDestination = (code, customs) => {
+    const nccis = (0, exports.destinationNccisCode)(code, customs);
+    return Boolean(nccis && exports.NEGATIVE_DESTINATION_CODES.includes(nccis));
+};
+exports.isNegativeDestination = isNegativeDestination;
+/**
+ * Re-keys a `{destination: count}` aggregate onto the nine NCCIS codes, folding each
+ * custom category into its parent. For anything that has to report in NCCIS terms
+ * while the raw aggregate stays as granular as the school made it.
+ *
+ * @param {object} [counts] the raw aggregate.
+ * @param {object} [customs] the institute's leaverDestinations map.
+ * @return {object} counts keyed by NCCIS code.
+ */
+const rollUpDestinationCounts = (counts, customs) => {
+    const out = {};
+    for (const [code, n] of Object.entries(counts ?? {})) {
+        const key = (0, exports.destinationNccisCode)(code, customs) ?? "NK";
+        out[key] = (out[key] ?? 0) + (n ?? 0);
+    }
+    return out;
+};
+exports.rollUpDestinationCounts = rollUpDestinationCounts;
+/**
+ * Validates a set of custom categories before it is stored. Shared by the setup card
+ * and the callable so both refuse the same things.
+ *
+ * @param {object} destinations the map to check.
+ * @return {string|undefined} the first problem found, or undefined if it's valid.
+ */
+const validateLeaverDestinations = (destinations) => {
+    const entries = Object.entries(destinations ?? {});
+    if (entries.length > 50)
+        return "You can add up to 50 destination categories.";
+    const seen = new Set();
+    for (const [id, d] of entries) {
+        if (!d)
+            return "One of your categories is empty.";
+        if (!exports.DESTINATION_ID_PATTERN.test(id) || id !== d.id)
+            return "A category id is invalid.";
+        if (!id.startsWith(exports.CUSTOM_DESTINATION_PREFIX))
+            return "A category id is invalid.";
+        if (constants_1.DESTINATION_CODES[id])
+            return "A category can't reuse a standard destination code.";
+        const label = (d.label ?? "").trim();
+        if (!label)
+            return "Give every category a name.";
+        if (label.length > 60)
+            return "Category names must be 60 characters or fewer.";
+        if (!constants_1.DESTINATION_CODES[d.nccisCode])
+            return `Choose which group "${label}" counts within.`;
+        const key = label.toLowerCase();
+        if (seen.has(key))
+            return `You already have a category called "${label}".`;
+        // A category that duplicates a standard label would show twice in the picker
+        // with no way to tell them apart.
+        if (Object.values(constants_1.DESTINATION_CODES).some((l) => l.toLowerCase() === key)) {
+            return `"${label}" is already a standard destination.`;
+        }
+        seen.add(key);
+    }
+    return undefined;
+};
+exports.validateLeaverDestinations = validateLeaverDestinations;
+//# sourceMappingURL=destinations.js.map

package/lib/destinations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"destinations.js","sourceRoot":"","sources":["../src/destinations.ts"],"names":[],"mappings":";;;AAAA,2CAA8C;AAmC9C;4EAC4E;AAC/D,QAAA,sBAAsB,GAAG,sBAAsB,CAAC;AAE7D;qBACqB;AACR,QAAA,yBAAyB,GAAG,SAAS,CAAC;AAEnD;;qBAEqB;AACR,QAAA,0BAA0B,GAAsB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAE5E;;;;;;GAMG;AACI,MAAM,mBAAmB,GAAG,CAAC,KAAa,EAAE,QAA+B,EAAU,EAAE;IAC1F,MAAM,IAAI,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC;SACrB,IAAI,EAAE,CAAC,WAAW,EAAE;SACpB,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC;SAC3B,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC;SACvB,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,UAAU,CAAC;IAChC,MAAM,IAAI,GAAG,GAAG,iCAAyB,GAAG,IAAI,EAAE,CAAC;IACnD,IAAI,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IACnC,gFAAgF;IAChF,uEAAuE;IACvE,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,OAAO,QAAQ,CAAC,GAAG,IAAI,IAAI,CAAC,EAAE,CAAC;QAAE,CAAC,EAAE,CAAC;IACrC,OAAO,GAAG,IAAI,IAAI,CAAC,EAAE,CAAC;AAC1B,CAAC,CAAC;AAbW,QAAA,mBAAmB,uBAa9B;AAEF,8EAA8E;AACvE,MAAM,0BAA0B,GAAG,GAAwB,EAAE,CAChE,MAAM,CAAC,OAAO,CAAC,6BAAiB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;IACtD,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,IAAuB,EAAE,MAAM,EAAE,KAAK;CACjE,CAAC,CAAC,CAAC;AAHK,QAAA,0BAA0B,8BAG/B;AAER;;;;;;;;;;GAUG;AACI,MAAM,kBAAkB,GAAG,CAC9B,OAA8B,EAAE,IAAkC,EAC/C,EAAE;IACrB,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC;SACvC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,eAAe,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;SAC9D,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACf,IAAI,EAAE,EAAE;QACR,KAAK,EAAE,CAAC,CAAC,KAAK;QACd,SAAS,EAAE,CAAC,6BAAiB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAoB;QACrF,MAAM,EAAE,IAAI;QACZ,WAAW,EAAE,CAAC,CAAC,WAAW;QAC1B,QAAQ,EAAE,CAAC,CAAC,QAAQ;KACvB,CAAC,CAAC;SACF,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IAEpD,kFAAkF;IAClF,8BAA8B;IAC9B,OAAO,IAAA,kCAA0B,GAAE,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC;QACjD,GAAG,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,KAAK,GAAG,CAAC,IAAI,CAAC;KACzD,CAAC,CAAC;AACP,CAAC,CAAC;AApBW,QAAA,kBAAkB,sBAoB7B;AAEF;;;;;;;;;;;;;;;;GAgBG;AACI,MAAM,yBAAyB,GAAG,CACrC,MAAkD,EAClD,KAAiD,EACO,EAAE;IAC1D,MAAM,GAAG,GAAG,MAAM,EAAE,kBAAkB,IAAI,EAAE,CAAC;IAC7C,MAAM,SAAS,GAAG,KAAK,EAAE,kBAAkB,IAAI,EAAE,CAAC;IAClD,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;IACjE,OAAO;QACH,YAAY,EAAE,EAAC,GAAG,SAAS,EAAE,GAAG,GAAG,EAAC;QACpC,QAAQ;KACX,CAAC;AACN,CAAC,CAAC;AAXW,QAAA,yBAAyB,6BAWpC;AAEF;;;;;;;;;;;GAWG;AACI,MAAM,gBAAgB,GAAG,CAC5B,IAAuB,EAAE,OAA8B,EACvC,EAAE;IAClB,IAAI,CAAC,IAAI;QAAE,OAAO,SAAS,CAAC;IAC5B,IAAI,6BAAiB,CAAC,IAAI,CAAC;QAAE,OAAO,6BAAiB,CAAC,IAAI,CAAC,CAAC;IAC5D,MAAM,KAAK,GAAG,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC;IACrC,IAAI,KAAK;QAAE,OAAO,KAAK,CAAC;IACxB,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,iCAAyB,CAAC;QAAE,OAAO,IAAI,CAAC;IAC7D,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,iCAAyB,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;IACrF,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACzE,CAAC,CAAC;AAVW,QAAA,gBAAgB,oBAU3B;AAEF;;;;;;;GAOG;AACI,MAAM,oBAAoB,GAAG,CAChC,IAAuB,EAAE,OAA8B,EAC9B,EAAE;IAC3B,IAAI,CAAC,IAAI;QAAE,OAAO,SAAS,CAAC;IAC5B,IAAI,6BAAiB,CAAC,IAAI,CAAC;QAAE,OAAO,IAAuB,CAAC;IAC5D,MAAM,MAAM,GAAG,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC;IAC/B,8EAA8E;IAC9E,6EAA6E;IAC7E,IAAI,CAAC,MAAM;QAAE,OAAO,IAAI,CAAC;IACzB,OAAO,6BAAiB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC;AAC3E,CAAC,CAAC;AAVW,QAAA,oBAAoB,wBAU/B;AAEF;;;;;;;GAOG;AACI,MAAM,qBAAqB,GAAG,CACjC,IAAuB,EAAE,OAA8B,EAChD,EAAE;IACT,MAAM,KAAK,GAAG,IAAA,4BAAoB,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAClD,OAAO,OAAO,CAAC,KAAK,IAAI,kCAA0B,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;AACxE,CAAC,CAAC;AALW,QAAA,qBAAqB,yBAKhC;AAEF;;;;;;;;GAQG;AACI,MAAM,uBAAuB,GAAG,CACnC,MAAiC,EAAE,OAA8B,EACzC,EAAE;IAC1B,MAAM,GAAG,GAA6B,EAAE,CAAC;IACzC,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,EAAE,CAAC;QACnD,MAAM,GAAG,GAAG,IAAA,4BAAoB,EAAC,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,CAAC;QACxD,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1C,CAAC;IACD,OAAO,GAAG,CAAC;AACf,CAAC,CAAC;AATW,QAAA,uBAAuB,2BASlC;AAEF;;;;;;GAMG;AACI,MAAM,0BAA0B,GAAG,CAAC,YAAkC,EAAoB,EAAE;IAC/F,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC;IACnD,IAAI,OAAO,CAAC,MAAM,GAAG,EAAE;QAAE,OAAO,8CAA8C,CAAC;IAC/E,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,KAAK,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,OAAO,EAAE,CAAC;QAC5B,IAAI,CAAC,CAAC;YAAE,OAAO,kCAAkC,CAAC;QAClD,IAAI,CAAC,8BAAsB,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,EAAE;YAAE,OAAO,2BAA2B,CAAC;QACxF,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,iCAAyB,CAAC;YAAE,OAAO,2BAA2B,CAAC;QAClF,IAAI,6BAAiB,CAAC,EAAE,CAAC;YAAE,OAAO,qDAAqD,CAAC;QACxF,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QACrC,IAAI,CAAC,KAAK;YAAE,OAAO,6BAA6B,CAAC;QACjD,IAAI,KAAK,CAAC,MAAM,GAAG,EAAE;YAAE,OAAO,gDAAgD,CAAC;QAC/E,IAAI,CAAC,6BAAiB,CAAC,CAAC,CAAC,SAAS,CAAC;YAAE,OAAO,uBAAuB,KAAK,kBAAkB,CAAC;QAC3F,MAAM,GAAG,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;QAChC,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,OAAO,uCAAuC,KAAK,IAAI,CAAC;QAC3E,6EAA6E;QAC7E,kCAAkC;QAClC,IAAI,MAAM,CAAC,MAAM,CAAC,6BAAiB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,GAAG,CAAC,EAAE,CAAC;YACxE,OAAO,IAAI,KAAK,sCAAsC,CAAC;QAC3D,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAClB,CAAC;IACD,OAAO,SAAS,CAAC;AACrB,CAAC,CAAC;AAvBW,QAAA,0BAA0B,8BAuBrC"}

package/lib/destinations.test.d.ts

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