placementt-core 1.400.1111 → 1.400.1113

package/lib/callables/__tests__/registry.test.js

@@ -19,7 +19,8 @@ describe("callable registry", () => {
     });
     it("names every callable as `<module>-<export>`", () => {
         for (const name of names) {
-            expect(name).toMatch(/^[a-zA-Z]+-[a-zA-Z]+$/);
+            // Letters first; digits allowed after, for modules like `e2e`.
+            expect(name).toMatch(/^[a-zA-Z][a-zA-Z0-9]*-[a-zA-Z][a-zA-Z0-9]*$/);
         }
     });
     it("gives every callable a request and response zod schema", () => {

package/lib/callables/__tests__/registry.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"registry.test.js","sourceRoot":"","sources":["../../../src/callables/__tests__/registry.test.ts"],"names":[],"mappings":";;AAAA,6BAAsB;AACtB,0CAAyD;AAEzD;;;;;GAKG;AACH,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IAC/B,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,uBAAY,CAAC,CAAC;IAExC,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACpD,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,yBAAc,CAAC;aAC9C,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAChE,wEAAwE;QACxE,sEAAsE;QACtE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACnD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACvB,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC;QAClD,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;QAC9D,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACvB,MAAM,QAAQ,GAAG,uBAAY,CAAC,IAAiC,CAAC,CAAC;YACjE,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,OAAC,CAAC,OAAO,CAAC,CAAC;YACnD,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,OAAC,CAAC,OAAO,CAAC,CAAC;QACxD,CAAC;IACL,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
+{"version":3,"file":"registry.test.js","sourceRoot":"","sources":["../../../src/callables/__tests__/registry.test.ts"],"names":[],"mappings":";;AAAA,6BAAsB;AACtB,0CAAyD;AAEzD;;;;;GAKG;AACH,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IAC/B,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,uBAAY,CAAC,CAAC;IAExC,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACpD,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,yBAAc,CAAC;aAC9C,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAChE,wEAAwE;QACxE,sEAAsE;QACtE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACnD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACvB,+DAA+D;YAC/D,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,6CAA6C,CAAC,CAAC;QACxE,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;QAC9D,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACvB,MAAM,QAAQ,GAAG,uBAAY,CAAC,IAAiC,CAAC,CAAC;YACjE,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,OAAC,CAAC,OAAO,CAAC,CAAC;YACnD,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,OAAC,CAAC,OAAO,CAAC,CAAC;QACxD,CAAC;IACL,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/lib/callables/e2e.d.ts

@@ -0,0 +1,33 @@
+import { z } from "zod";
+/**
+ * Contracts for the end-to-end and UX-audit harness
+ * (`Placementt-Backend/functions/src/e2e.ts`).
+ *
+ * `redeemSignInLink` is public: the token is the credential. Links are only
+ * ever minted by the harness (service account, straight into Firestore) and
+ * only ever sign in a reserved `e2e.*@careerthread.co.uk` user, so the UX audit
+ * can walk a registered school without anyone typing a password.
+ */
+export declare const e2eCallables: {
+    "e2e-redeemSignInLink": {
+        request: z.ZodObject<{
+            /** The raw token from `/e2eSignIn/:token`. Stored only as a SHA-256 hash. */
+            token: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            token: string;
+        }, {
+            token: string;
+        }>;
+        response: z.ZodObject<{
+            code: z.ZodEnum<["ok", "notFound", "expired"]>;
+            /** Firebase custom token for the linked e2e user. Only set when code is "ok". */
+            authToken: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            code: "expired" | "ok" | "notFound";
+            authToken?: string | undefined;
+        }, {
+            code: "expired" | "ok" | "notFound";
+            authToken?: string | undefined;
+        }>;
+    };
+};

package/lib/callables/e2e.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.e2eCallables = void 0;
+const zod_1 = require("zod");
+/**
+ * Contracts for the end-to-end and UX-audit harness
+ * (`Placementt-Backend/functions/src/e2e.ts`).
+ *
+ * `redeemSignInLink` is public: the token is the credential. Links are only
+ * ever minted by the harness (service account, straight into Firestore) and
+ * only ever sign in a reserved `e2e.*@careerthread.co.uk` user, so the UX audit
+ * can walk a registered school without anyone typing a password.
+ */
+exports.e2eCallables = {
+    "e2e-redeemSignInLink": {
+        request: zod_1.z.object({
+            /** The raw token from `/e2eSignIn/:token`. Stored only as a SHA-256 hash. */
+            token: zod_1.z.string().min(32).max(128).regex(/^[A-Za-z0-9_-]+$/),
+        }),
+        response: zod_1.z.object({
+            code: zod_1.z.enum(["ok", "notFound", "expired"]),
+            /** Firebase custom token for the linked e2e user. Only set when code is "ok". */
+            authToken: zod_1.z.string().optional(),
+        }),
+    },
+};
+//# sourceMappingURL=e2e.js.map

package/lib/callables/e2e.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"e2e.js","sourceRoot":"","sources":["../../src/callables/e2e.ts"],"names":[],"mappings":";;;AAAA,6BAAsB;AAGtB;;;;;;;;GAQG;AACU,QAAA,YAAY,GAAG;IACxB,sBAAsB,EAAE;QACpB,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC;YACd,6EAA6E;YAC7E,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC;SAC/D,CAAC;QACF,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC;YACf,IAAI,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;YAC3C,iFAAiF;YACjF,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;SACnC,CAAC;KACL;CACoB,CAAC"}

package/lib/callables/index.d.ts

@@ -9,3 +9,5 @@ export * from "./he";
 export * from "./studentLaunches";
 export * from "./billing";
 export * from "./hubImpactReport";
+export * from "./e2e";
+export * from "./wonde";

package/lib/callables/index.js

@@ -25,4 +25,6 @@ __exportStar(require("./he"), exports);
 __exportStar(require("./studentLaunches"), exports);
 __exportStar(require("./billing"), exports);
 __exportStar(require("./hubImpactReport"), exports);
+__exportStar(require("./e2e"), exports);
+__exportStar(require("./wonde"), exports);
 //# sourceMappingURL=index.js.map

package/lib/callables/index.js.map

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

package/lib/callables/registry.d.ts

@@ -11,6 +11,47 @@ import { z } from "zod";
  * equals the sum of the group key counts.
  */
 export declare const allCallables: {
+    "wonde-requestConnection": {
+        request: z.ZodObject<{
+            oId: z.ZodString;
+            itManagerName: z.ZodString;
+            itManagerEmail: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            oId: string;
+            itManagerName: string;
+            itManagerEmail: string;
+        }, {
+            oId: string;
+            itManagerName: string;
+            itManagerEmail: string;
+        }>;
+        response: z.ZodObject<{
+            taskId: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            taskId: string;
+        }, {
+            taskId: string;
+        }>;
+    };
+    "e2e-redeemSignInLink": {
+        request: z.ZodObject<{
+            token: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            token: string;
+        }, {
+            token: string;
+        }>;
+        response: z.ZodObject<{
+            code: z.ZodEnum<["ok", "notFound", "expired"]>;
+            authToken: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            code: "expired" | "ok" | "notFound";
+            authToken?: string | undefined;
+        }, {
+            code: "expired" | "ok" | "notFound";
+            authToken?: string | undefined;
+        }>;
+    };
     "hubImpactReport-createHubImpactReport": {
         request: z.ZodObject<{
             oId: z.ZodOptional<z.ZodString>;
@@ -2515,4 +2556,49 @@ export declare const callableGroups: {
             response: z.ZodString;
         };
     };
+    e2eCallables: {
+        "e2e-redeemSignInLink": {
+            request: z.ZodObject<{
+                token: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                token: string;
+            }, {
+                token: string;
+            }>;
+            response: z.ZodObject<{
+                code: z.ZodEnum<["ok", "notFound", "expired"]>;
+                authToken: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                code: "expired" | "ok" | "notFound";
+                authToken?: string | undefined;
+            }, {
+                code: "expired" | "ok" | "notFound";
+                authToken?: string | undefined;
+            }>;
+        };
+    };
+    wondeCallables: {
+        "wonde-requestConnection": {
+            request: z.ZodObject<{
+                oId: z.ZodString;
+                itManagerName: z.ZodString;
+                itManagerEmail: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                oId: string;
+                itManagerName: string;
+                itManagerEmail: string;
+            }, {
+                oId: string;
+                itManagerName: string;
+                itManagerEmail: string;
+            }>;
+            response: z.ZodObject<{
+                taskId: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                taskId: string;
+            }, {
+                taskId: string;
+            }>;
+        };
+    };
 };

package/lib/callables/registry.js

@@ -13,6 +13,8 @@ const studentLaunches_1 = require("./studentLaunches");
 const billing_1 = require("./billing");
 const jobRoles_1 = require("./jobRoles");
 const hubImpactReport_1 = require("./hubImpactReport");
+const e2e_1 = require("./e2e");
+const wonde_1 = require("./wonde");
 /**
  * The single source of truth for every typed callable. Add a feature group's
  * spread here and its callables are automatically covered by:
@@ -37,7 +39,9 @@ exports.allCallables = {
     ...billing_1.billingCallables,
     ...jobRoles_1.jobRolesCallables,
     ...hubImpactReport_1.hubImpactReportCallables,
+    ...e2e_1.e2eCallables,
+    ...wonde_1.wondeCallables,
 };
 /** The per-group maps, exported so tests can assert no key collisions. */
-exports.callableGroups = { destinationsConfigCallables: destinationsConfig_1.destinationsConfigCallables, placementCallables: placement_1.placementCallables, eventsCallables: events_1.eventsCallables, surveyCallables: surveys_1.surveyCallables, checksCallables: checks_1.checksCallables, benchmarksCallables: benchmarks_1.benchmarksCallables, apprenticeshipsCallables: apprenticeships_1.apprenticeshipsCallables, heCallables: he_1.heCallables, studentLaunchCallables: studentLaunches_1.studentLaunchCallables, billingCallables: billing_1.billingCallables, jobRolesCallables: jobRoles_1.jobRolesCallables, hubImpactReportCallables: hubImpactReport_1.hubImpactReportCallables };
+exports.callableGroups = { destinationsConfigCallables: destinationsConfig_1.destinationsConfigCallables, placementCallables: placement_1.placementCallables, eventsCallables: events_1.eventsCallables, surveyCallables: surveys_1.surveyCallables, checksCallables: checks_1.checksCallables, benchmarksCallables: benchmarks_1.benchmarksCallables, apprenticeshipsCallables: apprenticeships_1.apprenticeshipsCallables, heCallables: he_1.heCallables, studentLaunchCallables: studentLaunches_1.studentLaunchCallables, billingCallables: billing_1.billingCallables, jobRolesCallables: jobRoles_1.jobRolesCallables, hubImpactReportCallables: hubImpactReport_1.hubImpactReportCallables, e2eCallables: e2e_1.e2eCallables, wondeCallables: wonde_1.wondeCallables };
 //# sourceMappingURL=registry.js.map

package/lib/callables/registry.js.map

@@ -1 +1 @@
-{"version":3,"file":"registry.js","sourceRoot":"","sources":["../../src/callables/registry.ts"],"names":[],"mappings":";;;AAEA,6DAAiE;AACjE,2CAA+C;AAC/C,qCAAyC;AACzC,uCAA0C;AAC1C,qCAAyC;AACzC,6CAAiD;AACjD,uDAA2D;AAC3D,6BAAiC;AACjC,uDAAyD;AACzD,uCAA2C;AAC3C,yCAA6C;AAC7C,uDAA2D;AAE3D;;;;;;;;;;GAUG;AACU,QAAA,YAAY,GAAG;IACxB,GAAG,gDAA2B;IAC9B,GAAG,8BAAkB;IACrB,GAAG,wBAAe;IAClB,GAAG,yBAAe;IAClB,GAAG,wBAAe;IAClB,GAAG,gCAAmB;IACtB,GAAG,0CAAwB;IAC3B,GAAG,gBAAW;IACd,GAAG,wCAAsB;IACzB,GAAG,0BAAgB;IACnB,GAAG,4BAAiB;IACpB,GAAG,0CAAwB;CACN,CAAC;AAiB1B,0EAA0E;AAC7D,QAAA,cAAc,GAAG,EAAC,2BAA2B,EAA3B,gDAA2B,EAAE,kBAAkB,EAAlB,8BAAkB,EAAE,eAAe,EAAf,wBAAe,EAAE,eAAe,EAAf,yBAAe,EAAE,eAAe,EAAf,wBAAe,EAAE,mBAAmB,EAAnB,gCAAmB,EAAE,wBAAwB,EAAxB,0CAAwB,EAAE,WAAW,EAAX,gBAAW,EAAE,sBAAsB,EAAtB,wCAAsB,EAAE,gBAAgB,EAAhB,0BAAgB,EAAE,iBAAiB,EAAjB,4BAAiB,EAAE,wBAAwB,EAAxB,0CAAwB,EAAC,CAAC"}
+{"version":3,"file":"registry.js","sourceRoot":"","sources":["../../src/callables/registry.ts"],"names":[],"mappings":";;;AAEA,6DAAiE;AACjE,2CAA+C;AAC/C,qCAAyC;AACzC,uCAA0C;AAC1C,qCAAyC;AACzC,6CAAiD;AACjD,uDAA2D;AAC3D,6BAAiC;AACjC,uDAAyD;AACzD,uCAA2C;AAC3C,yCAA6C;AAC7C,uDAA2D;AAC3D,+BAAmC;AACnC,mCAAuC;AAEvC;;;;;;;;;;GAUG;AACU,QAAA,YAAY,GAAG;IACxB,GAAG,gDAA2B;IAC9B,GAAG,8BAAkB;IACrB,GAAG,wBAAe;IAClB,GAAG,yBAAe;IAClB,GAAG,wBAAe;IAClB,GAAG,gCAAmB;IACtB,GAAG,0CAAwB;IAC3B,GAAG,gBAAW;IACd,GAAG,wCAAsB;IACzB,GAAG,0BAAgB;IACnB,GAAG,4BAAiB;IACpB,GAAG,0CAAwB;IAC3B,GAAG,kBAAY;IACf,GAAG,sBAAc;CACI,CAAC;AAiB1B,0EAA0E;AAC7D,QAAA,cAAc,GAAG,EAAC,2BAA2B,EAA3B,gDAA2B,EAAE,kBAAkB,EAAlB,8BAAkB,EAAE,eAAe,EAAf,wBAAe,EAAE,eAAe,EAAf,yBAAe,EAAE,eAAe,EAAf,wBAAe,EAAE,mBAAmB,EAAnB,gCAAmB,EAAE,wBAAwB,EAAxB,0CAAwB,EAAE,WAAW,EAAX,gBAAW,EAAE,sBAAsB,EAAtB,wCAAsB,EAAE,gBAAgB,EAAhB,0BAAgB,EAAE,iBAAiB,EAAjB,4BAAiB,EAAE,wBAAwB,EAAxB,0CAAwB,EAAE,YAAY,EAAZ,kBAAY,EAAE,cAAc,EAAd,sBAAc,EAAC,CAAC"}

package/lib/callables/wonde.d.ts

@@ -0,0 +1,35 @@
+import { z } from "zod";
+/**
+ * Contracts for the Wonde connection request
+ * (`Placementt-Backend/functions/src/wonde.ts`).
+ *
+ * Wonde only approves a connection once the school's IT manager signs it off, so
+ * the school gives us their details and we raise the request with Wonde. Nothing
+ * is emailed from the platform: the request lands as a support task.
+ */
+export declare const wondeCallables: {
+    "wonde-requestConnection": {
+        request: z.ZodObject<{
+            /** The school the connection is for. */
+            oId: z.ZodString;
+            itManagerName: z.ZodString;
+            itManagerEmail: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            oId: string;
+            itManagerName: string;
+            itManagerEmail: string;
+        }, {
+            oId: string;
+            itManagerName: string;
+            itManagerEmail: string;
+        }>;
+        response: z.ZodObject<{
+            /** supportTasks/{id} raised, or the open one it updated. */
+            taskId: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            taskId: string;
+        }, {
+            taskId: string;
+        }>;
+    };
+};

package/lib/callables/wonde.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.wondeCallables = void 0;
+const zod_1 = require("zod");
+/**
+ * Contracts for the Wonde connection request
+ * (`Placementt-Backend/functions/src/wonde.ts`).
+ *
+ * Wonde only approves a connection once the school's IT manager signs it off, so
+ * the school gives us their details and we raise the request with Wonde. Nothing
+ * is emailed from the platform: the request lands as a support task.
+ */
+exports.wondeCallables = {
+    "wonde-requestConnection": {
+        request: zod_1.z.object({
+            /** The school the connection is for. */
+            oId: zod_1.z.string().min(1),
+            itManagerName: zod_1.z.string().trim().min(1).max(200),
+            itManagerEmail: zod_1.z.string().trim().email().max(320),
+        }),
+        response: zod_1.z.object({
+            /** supportTasks/{id} raised, or the open one it updated. */
+            taskId: zod_1.z.string(),
+        }),
+    },
+};
+//# sourceMappingURL=wonde.js.map

package/lib/callables/wonde.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wonde.js","sourceRoot":"","sources":["../../src/callables/wonde.ts"],"names":[],"mappings":";;;AAAA,6BAAsB;AAGtB;;;;;;;GAOG;AACU,QAAA,cAAc,GAAG;IAC1B,yBAAyB,EAAE;QACvB,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC;YACd,wCAAwC;YACxC,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;YACtB,aAAa,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;YAChD,cAAc,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;SACrD,CAAC;QACF,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC;YACf,4DAA4D;YAC5D,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE;SACrB,CAAC;KACL;CACoB,CAAC"}

package/lib/index.d.ts

@@ -22,6 +22,7 @@ export * from "./activityLogging";
 export * from "./studentTools";
 export * from "./featureMarketing";
 export * from "./onboardingPathways";
+export * from "./studentData";
 export * from "./lmi";
 export * from "./lmiCategories";
 export * from "./pathways";

package/lib/index.js

@@ -42,6 +42,7 @@ __exportStar(require("./activityLogging"), exports);
 __exportStar(require("./studentTools"), exports);
 __exportStar(require("./featureMarketing"), exports);
 __exportStar(require("./onboardingPathways"), exports);
+__exportStar(require("./studentData"), exports);
 __exportStar(require("./lmi"), exports);
 __exportStar(require("./lmiCategories"), exports);
 __exportStar(require("./pathways"), 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,qDAAmC;AACnC,sDAAoC;AACpC,kDAAgC;AAChC,mDAAiC;AACjC,+CAA6B;AAC7B,oDAAkC;AAClC,iDAA+B;AAC/B,qDAAmC;AACnC,uDAAqC;AACrC,wCAAsB;AACtB,kDAAgC;AAChC,6CAA2B;AAC3B,oDAAkC;AAClC,4CAA0B;AAC1B,8CAA4B;AAC5B,2CAAyB;AACzB,kDAAgC;AAChC,uDAAqC;AACrC,oDAAkC;AAClC,kDAAgC;AAChC,0DAAwC;AACxC,iDAA+B;AAC/B,2DAAyC;AACzC,uDAAqC;AACrC,uDAAqC;AACrC,iDAA+B;AAC/B,8CAA4B;AAC5B,qDAAmC;AACnC,0CAAwB;AACxB,kDAAgC;AAChC,yCAAuB;AACvB,4DAA0C;AAC1C,kDAAgC;AAChC,iDAA+B;AAC/B,2CAAyB;AACzB,4DAA0C;AAC1C,oEAAiD;AACjD,yEAAuD;AACvD,kEAAgD;AAChD,kEAAgD;AAChD,oEAAkD;AAClD,yGAAuF;AACvF,0GAAwF;AACxF,+FAA6E;AAC7E,4DAA0C;AAC1C,oEAAkD;AAClD,iEAA+C;AAC/C,gEAA8C;AAC9C,2EAAyD;AACzD,6CAA2B;AAC3B,+CAA6B;AAC7B,8CAA4B;AAC5B,6DAAuE;AAA9D,2IAAA,OAAO,OAAuB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AACA,sDAAoC;AACpC,gEAA8C;AAC9C,0DAAwC;AACxC,2DAAyC;AACzC,kDAAgC;AAChC,uDAAqC;AACrC,4DAA0C;AAC1C,2DAAyC;AAEzC,oDAAkC;AAClC,8CAA4B;AAC5B,kDAAgC;AAChC,kDAAgC;AAChC,qDAAmC;AACnC,mDAAiC;AACjC,qDAAmC;AACnC,qDAAmC;AACnC,sDAAoC;AACpC,kDAAgC;AAChC,mDAAiC;AACjC,+CAA6B;AAC7B,oDAAkC;AAClC,iDAA+B;AAC/B,qDAAmC;AACnC,uDAAqC;AACrC,gDAA8B;AAC9B,wCAAsB;AACtB,kDAAgC;AAChC,6CAA2B;AAC3B,oDAAkC;AAClC,4CAA0B;AAC1B,8CAA4B;AAC5B,2CAAyB;AACzB,kDAAgC;AAChC,uDAAqC;AACrC,oDAAkC;AAClC,kDAAgC;AAChC,0DAAwC;AACxC,iDAA+B;AAC/B,2DAAyC;AACzC,uDAAqC;AACrC,uDAAqC;AACrC,iDAA+B;AAC/B,8CAA4B;AAC5B,qDAAmC;AACnC,0CAAwB;AACxB,kDAAgC;AAChC,yCAAuB;AACvB,4DAA0C;AAC1C,kDAAgC;AAChC,iDAA+B;AAC/B,2CAAyB;AACzB,4DAA0C;AAC1C,oEAAiD;AACjD,yEAAuD;AACvD,kEAAgD;AAChD,kEAAgD;AAChD,oEAAkD;AAClD,yGAAuF;AACvF,0GAAwF;AACxF,+FAA6E;AAC7E,4DAA0C;AAC1C,oEAAkD;AAClD,iEAA+C;AAC/C,gEAA8C;AAC9C,2EAAyD;AACzD,6CAA2B;AAC3B,+CAA6B;AAC7B,8CAA4B;AAC5B,6DAAuE;AAA9D,2IAAA,OAAO,OAAuB"}

package/lib/studentData.d.ts

@@ -0,0 +1,55 @@
+import { InstituteData } from "./typeDefinitions";
+/**
+ * Whether a school has the student data an area of the platform needs before it
+ * can be set up.
+ *
+ * Destinations, Development and the careers calendar are all set up per year
+ * group. A school with no students, or students with no year group, cannot answer
+ * a single question those setups ask, so instead of the setup flow they are shown
+ * what the area does and asked to bring their students in first.
+ *
+ * Destinations and Development go further and need Wonde: they run all year off
+ * the school's roll, and a CSV goes stale the week after it is uploaded.
+ */
+/**
+ * The connection token the E2E and UX-audit harness writes to stand in for a
+ * real Wonde connection. The platform only ever checks that a connection exists,
+ * so this is enough to make a test school look Wonde-connected. The backend sync
+ * skips any institute holding it, so nothing ever calls Wonde with it.
+ */
+export declare const WONDE_TEST_CONNECTION_TOKEN = "e2e-test-connection";
+/** What is missing, most fundamental first. */
+export type StudentDataGate = "ready" | "needsStudents" | "needsWonde";
+/**
+ * Whether the Wonde connection is the harness's stand-in rather than a real one.
+ *
+ * @param {InstituteData["wonde"]} [wonde] the institute's Wonde block.
+ * @return {boolean} true for a test connection.
+ */
+export declare const isWondeTestConnection: (wonde?: Pick<NonNullable<InstituteData["wonde"]>, "connectionToken">) => boolean;
+/**
+ * Whether the school has students with a year group on them. `yearGroups` is
+ * only ever added to, so the student count is checked as well: a school that
+ * deleted every student still has its old year groups listed.
+ *
+ * @param {Partial<InstituteData>} [institute] the school.
+ * @return {boolean} true when there are students to set anything up for.
+ */
+export declare const hasStudentYearGroups: (institute?: Partial<InstituteData>) => boolean;
+/**
+ * Whether the school has a Wonde connection. The connection id is what the sync
+ * runs off, so it is the thing checked, not the `hasIntegration` switch.
+ *
+ * @param {Partial<InstituteData>} [institute] the school.
+ * @return {boolean} true when a Wonde connection id is stored.
+ */
+export declare const hasWondeConnection: (institute?: Partial<InstituteData>) => boolean;
+/**
+ * What stands between the school and setting an area up.
+ *
+ * @param {Partial<InstituteData>} [institute] the school.
+ * @param {boolean} needsWonde whether the area needs Wonde (Destinations,
+ *     Development) or just students with year groups (the careers calendar).
+ * @return {StudentDataGate} "ready", or the first thing missing.
+ */
+export declare const studentDataGate: (institute: Partial<InstituteData> | undefined, needsWonde: boolean) => StudentDataGate;

package/lib/studentData.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.studentDataGate = exports.hasWondeConnection = exports.hasStudentYearGroups = exports.isWondeTestConnection = exports.WONDE_TEST_CONNECTION_TOKEN = void 0;
+/**
+ * Whether a school has the student data an area of the platform needs before it
+ * can be set up.
+ *
+ * Destinations, Development and the careers calendar are all set up per year
+ * group. A school with no students, or students with no year group, cannot answer
+ * a single question those setups ask, so instead of the setup flow they are shown
+ * what the area does and asked to bring their students in first.
+ *
+ * Destinations and Development go further and need Wonde: they run all year off
+ * the school's roll, and a CSV goes stale the week after it is uploaded.
+ */
+/**
+ * The connection token the E2E and UX-audit harness writes to stand in for a
+ * real Wonde connection. The platform only ever checks that a connection exists,
+ * so this is enough to make a test school look Wonde-connected. The backend sync
+ * skips any institute holding it, so nothing ever calls Wonde with it.
+ */
+exports.WONDE_TEST_CONNECTION_TOKEN = "e2e-test-connection";
+/**
+ * Whether the Wonde connection is the harness's stand-in rather than a real one.
+ *
+ * @param {InstituteData["wonde"]} [wonde] the institute's Wonde block.
+ * @return {boolean} true for a test connection.
+ */
+const isWondeTestConnection = (wonde) => wonde?.connectionToken === exports.WONDE_TEST_CONNECTION_TOKEN;
+exports.isWondeTestConnection = isWondeTestConnection;
+/**
+ * Whether the school has students with a year group on them. `yearGroups` is
+ * only ever added to, so the student count is checked as well: a school that
+ * deleted every student still has its old year groups listed.
+ *
+ * @param {Partial<InstituteData>} [institute] the school.
+ * @return {boolean} true when there are students to set anything up for.
+ */
+const hasStudentYearGroups = (institute) => Boolean((institute?.students ?? 0) > 0 && institute?.yearGroups?.length);
+exports.hasStudentYearGroups = hasStudentYearGroups;
+/**
+ * Whether the school has a Wonde connection. The connection id is what the sync
+ * runs off, so it is the thing checked, not the `hasIntegration` switch.
+ *
+ * @param {Partial<InstituteData>} [institute] the school.
+ * @return {boolean} true when a Wonde connection id is stored.
+ */
+const hasWondeConnection = (institute) => Boolean(institute?.wonde?.id);
+exports.hasWondeConnection = hasWondeConnection;
+/**
+ * What stands between the school and setting an area up.
+ *
+ * @param {Partial<InstituteData>} [institute] the school.
+ * @param {boolean} needsWonde whether the area needs Wonde (Destinations,
+ *     Development) or just students with year groups (the careers calendar).
+ * @return {StudentDataGate} "ready", or the first thing missing.
+ */
+const studentDataGate = (institute, needsWonde) => {
+    if (needsWonde && !(0, exports.hasWondeConnection)(institute))
+        return "needsWonde";
+    if (!(0, exports.hasStudentYearGroups)(institute))
+        return "needsStudents";
+    return "ready";
+};
+exports.studentDataGate = studentDataGate;
+//# sourceMappingURL=studentData.js.map

package/lib/studentData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"studentData.js","sourceRoot":"","sources":["../src/studentData.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;;GAWG;AAEH;;;;;GAKG;AACU,QAAA,2BAA2B,GAAG,qBAAqB,CAAC;AAKjE;;;;;GAKG;AACI,MAAM,qBAAqB,GAAG,CAAC,KAAoE,EAAW,EAAE,CACnH,KAAK,EAAE,eAAe,KAAK,mCAA2B,CAAC;AAD9C,QAAA,qBAAqB,yBACyB;AAE3D;;;;;;;GAOG;AACI,MAAM,oBAAoB,GAAG,CAAC,SAAkC,EAAW,EAAE,CAChF,OAAO,CAAC,CAAC,SAAS,EAAE,QAAQ,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,SAAS,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;AADhE,QAAA,oBAAoB,wBAC4C;AAE7E;;;;;;GAMG;AACI,MAAM,kBAAkB,GAAG,CAAC,SAAkC,EAAW,EAAE,CAC9E,OAAO,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;AADrB,QAAA,kBAAkB,sBACG;AAElC;;;;;;;GAOG;AACI,MAAM,eAAe,GAAG,CAAC,SAA2C,EAAE,UAAmB,EAAmB,EAAE;IACjH,IAAI,UAAU,IAAI,CAAC,IAAA,0BAAkB,EAAC,SAAS,CAAC;QAAE,OAAO,YAAY,CAAC;IACtE,IAAI,CAAC,IAAA,4BAAoB,EAAC,SAAS,CAAC;QAAE,OAAO,eAAe,CAAC;IAC7D,OAAO,OAAO,CAAC;AACnB,CAAC,CAAC;AAJW,QAAA,eAAe,mBAI1B"}

package/lib/studentData.test.d.ts

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

package/lib/studentData.test.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const studentData_1 = require("./studentData");
+const wonde = (id, connectionToken = "real-token") => ({ wonde: { id, connectionToken, hasIntegration: true } });
+describe("hasStudentYearGroups", () => {
+    it("is false with no students", () => {
+        expect((0, studentData_1.hasStudentYearGroups)({ students: 0, yearGroups: ["7"] })).toBe(false);
+    });
+    it("is false when students have no year group", () => {
+        expect((0, studentData_1.hasStudentYearGroups)({ students: 30 })).toBe(false);
+        expect((0, studentData_1.hasStudentYearGroups)({ students: 30, yearGroups: [] })).toBe(false);
+    });
+    it("is true with students and year groups", () => {
+        expect((0, studentData_1.hasStudentYearGroups)({ students: 30, yearGroups: ["7", "8"] })).toBe(true);
+    });
+    it("is false with no institute", () => {
+        expect((0, studentData_1.hasStudentYearGroups)(undefined)).toBe(false);
+    });
+});
+describe("hasWondeConnection", () => {
+    it("reads the connection id", () => {
+        expect((0, studentData_1.hasWondeConnection)({})).toBe(false);
+        expect((0, studentData_1.hasWondeConnection)(wonde(""))).toBe(false);
+        expect((0, studentData_1.hasWondeConnection)(wonde("A123"))).toBe(true);
+    });
+});
+describe("isWondeTestConnection", () => {
+    it("recognises only the harness token", () => {
+        expect((0, studentData_1.isWondeTestConnection)({ connectionToken: studentData_1.WONDE_TEST_CONNECTION_TOKEN })).toBe(true);
+        expect((0, studentData_1.isWondeTestConnection)({ connectionToken: "real-token" })).toBe(false);
+        expect((0, studentData_1.isWondeTestConnection)(undefined)).toBe(false);
+    });
+});
+describe("studentDataGate", () => {
+    const withStudents = { students: 30, yearGroups: ["7"] };
+    it("asks for students first when Wonde is not needed", () => {
+        expect((0, studentData_1.studentDataGate)({}, false)).toBe("needsStudents");
+        expect((0, studentData_1.studentDataGate)(withStudents, false)).toBe("ready");
+    });
+    it("asks for Wonde when it is needed and missing, even with CSV students", () => {
+        expect((0, studentData_1.studentDataGate)(withStudents, true)).toBe("needsWonde");
+    });
+    it("asks for students when Wonde is connected but nothing has synced", () => {
+        expect((0, studentData_1.studentDataGate)(wonde("A123"), true)).toBe("needsStudents");
+    });
+    it("is ready with Wonde and year groups", () => {
+        expect((0, studentData_1.studentDataGate)({ ...wonde("A123"), ...withStudents }, true)).toBe("ready");
+    });
+});
+//# sourceMappingURL=studentData.test.js.map

package/lib/studentData.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"studentData.test.js","sourceRoot":"","sources":["../src/studentData.test.ts"],"names":[],"mappings":";;AACA,+CAMuB;AAEvB,MAAM,KAAK,GAAG,CAAC,EAAU,EAAE,eAAe,GAAG,YAAY,EAAE,EAAE,CACzD,CAAC,EAAC,KAAK,EAAE,EAAC,EAAE,EAAE,eAAe,EAAE,cAAc,EAAE,IAAI,EAAC,EAAuC,CAAA,CAAC;AAEhG,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;IAClC,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACjC,MAAM,CAAC,IAAA,kCAAoB,EAAC,EAAC,QAAQ,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,GAAG,CAAC,EAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC/E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACjD,MAAM,CAAC,IAAA,kCAAoB,EAAC,EAAC,QAAQ,EAAE,EAAE,EAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzD,MAAM,CAAC,IAAA,kCAAoB,EAAC,EAAC,QAAQ,EAAE,EAAE,EAAE,UAAU,EAAE,EAAE,EAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC7E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC7C,MAAM,CAAC,IAAA,kCAAoB,EAAC,EAAC,QAAQ,EAAE,EAAE,EAAE,UAAU,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,EAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;QAClC,MAAM,CAAC,IAAA,kCAAoB,EAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAChC,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;QAC/B,MAAM,CAAC,IAAA,gCAAkB,EAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC3C,MAAM,CAAC,IAAA,gCAAkB,EAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAClD,MAAM,CAAC,IAAA,gCAAkB,EAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;IACnC,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QACzC,MAAM,CAAC,IAAA,mCAAqB,EAAC,EAAC,eAAe,EAAE,yCAA2B,EAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzF,MAAM,CAAC,IAAA,mCAAqB,EAAC,EAAC,eAAe,EAAE,YAAY,EAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC3E,MAAM,CAAC,IAAA,mCAAqB,EAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC7B,MAAM,YAAY,GAAG,EAAC,QAAQ,EAAE,EAAE,EAAE,UAAU,EAAE,CAAC,GAAG,CAAC,EAAC,CAAC;IAEvD,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;QACxD,MAAM,CAAC,IAAA,6BAAe,EAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QACzD,MAAM,CAAC,IAAA,6BAAe,EAAC,YAAY,EAAE,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sEAAsE,EAAE,GAAG,EAAE;QAC5E,MAAM,CAAC,IAAA,6BAAe,EAAC,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACnE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kEAAkE,EAAE,GAAG,EAAE;QACxE,MAAM,CAAC,IAAA,6BAAe,EAAC,KAAK,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;QAC3C,MAAM,CAAC,IAAA,6BAAe,EAAC,EAAC,GAAG,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,YAAY,EAAC,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACrF,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/lib/typeDefinitions.d.ts

@@ -1127,6 +1127,15 @@ export type InstituteData = {
         connectionToken: string;
         fields?: string[];
     };
+    /** The school asked us to set Wonde up, from an area that needs it. Wonde
+     * approves a connection through the school's IT manager, so their details are
+     * what we pass on. Written by wonde-requestConnection. */
+    wondeRequest?: {
+        itManagerName: string;
+        itManagerEmail: string;
+        requestedAt: string;
+        requestedBy: string;
+    };
     microsoft?: {
         enabled: boolean;
         tenantId?: string;
@@ -4157,7 +4166,7 @@ export type SupportTask = {
     assignee: string;
     commId?: string;
     commType?: "leads" | "users";
-    source?: "customerQuery" | "general" | "seasonalTask" | "onboardingPack" | "midYearPack" | "welcomePack";
+    source?: "customerQuery" | "general" | "seasonalTask" | "onboardingPack" | "midYearPack" | "welcomePack" | "wondeRequest";
     dueAt: string;
     inbox?: SupportInbox;
     messageId?: string;

package/lib/typeDefinitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"typeDefinitions.js","sourceRoot":"","sources":["../src/typeDefinitions.ts"],"names":[],"mappings":";;;AA4iIA,sDASC;AAeD,oDAKC;AAaD,0CAEC;AA/nED;;;;;kFAKkF;AACrE,QAAA,qBAAqB,GAAG,SAAS,CAAC;AAClC,QAAA,iBAAiB,GAAG,OAAO,CAAC;AA2iEzC;yEACyE;AAC5D,QAAA,0BAA0B,GAA2C;IAC9E,gBAAgB,EAAE,2BAA2B;IAC7C,mBAAmB,EAAE,sBAAsB;IAC3C,cAAc,EAAE,iBAAiB;IACjC,kBAAkB,EAAE,qBAAqB;IACzC,UAAU,EAAE,oCAAoC;IAChD,aAAa,EAAE,yBAAyB;IACxC,aAAa,EAAE,wBAAwB;IACvC,KAAK,EAAE,OAAO;CACjB,CAAC;AAEW,QAAA,0BAA0B,GAA+C;IAClF,QAAQ,EAAE,WAAW;IACrB,KAAK,EAAE,YAAY;IACnB,KAAK,EAAE,OAAO;CACjB,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,SAAgB,qBAAqB,CAAC,SAAsC;IACxE,QAAQ,SAAS,EAAE,CAAC;QACpB,KAAK,MAAM,CAAC,CAAC,OAAO,OAAO,CAAC;QAC5B,KAAK,OAAO,CAAC,CAAC,OAAO,OAAO,CAAC;QAC7B,KAAK,WAAW,CAAC;QACjB,KAAK,OAAO,CAAC;QACb,KAAK,OAAO,CAAC;QACb,OAAO,CAAC,CAAC,OAAO,UAAU,CAAC;IAC3B,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,oBAAoB,CAChC,IAAwC,EACxC,MAA6C;IAE7C,OAAO,IAAI,EAAE,WAAW,IAAI,MAAM,EAAE,YAAY,IAAI,KAAK,CAAC;AAC9D,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,eAAe,CAAC,KAA6D;IACzF,OAAO,GAAG,KAAK,CAAC,cAAc,IAAI,EAAE,IAAI,KAAK,CAAC,aAAa,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC;AAC/E,CAAC"}
+{"version":3,"file":"typeDefinitions.js","sourceRoot":"","sources":["../src/typeDefinitions.ts"],"names":[],"mappings":";;;AAqjIA,sDASC;AAeD,oDAKC;AAaD,0CAEC;AA/nED;;;;;kFAKkF;AACrE,QAAA,qBAAqB,GAAG,SAAS,CAAC;AAClC,QAAA,iBAAiB,GAAG,OAAO,CAAC;AA2iEzC;yEACyE;AAC5D,QAAA,0BAA0B,GAA2C;IAC9E,gBAAgB,EAAE,2BAA2B;IAC7C,mBAAmB,EAAE,sBAAsB;IAC3C,cAAc,EAAE,iBAAiB;IACjC,kBAAkB,EAAE,qBAAqB;IACzC,UAAU,EAAE,oCAAoC;IAChD,aAAa,EAAE,yBAAyB;IACxC,aAAa,EAAE,wBAAwB;IACvC,KAAK,EAAE,OAAO;CACjB,CAAC;AAEW,QAAA,0BAA0B,GAA+C;IAClF,QAAQ,EAAE,WAAW;IACrB,KAAK,EAAE,YAAY;IACnB,KAAK,EAAE,OAAO;CACjB,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,SAAgB,qBAAqB,CAAC,SAAsC;IACxE,QAAQ,SAAS,EAAE,CAAC;QACpB,KAAK,MAAM,CAAC,CAAC,OAAO,OAAO,CAAC;QAC5B,KAAK,OAAO,CAAC,CAAC,OAAO,OAAO,CAAC;QAC7B,KAAK,WAAW,CAAC;QACjB,KAAK,OAAO,CAAC;QACb,KAAK,OAAO,CAAC;QACb,OAAO,CAAC,CAAC,OAAO,UAAU,CAAC;IAC3B,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,oBAAoB,CAChC,IAAwC,EACxC,MAA6C;IAE7C,OAAO,IAAI,EAAE,WAAW,IAAI,MAAM,EAAE,YAAY,IAAI,KAAK,CAAC;AAC9D,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,eAAe,CAAC,KAA6D;IACzF,OAAO,GAAG,KAAK,CAAC,cAAc,IAAI,EAAE,IAAI,KAAK,CAAC,aAAa,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC;AAC/E,CAAC"}

package/package.json

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

package/src/callables/__tests__/registry.test.ts

@@ -20,7 +20,8 @@ describe("callable registry", () => {
 
     it("names every callable as `<module>-<export>`", () => {
         for (const name of names) {
-            expect(name).toMatch(/^[a-zA-Z]+-[a-zA-Z]+$/);
+            // Letters first; digits allowed after, for modules like `e2e`.
+            expect(name).toMatch(/^[a-zA-Z][a-zA-Z0-9]*-[a-zA-Z][a-zA-Z0-9]*$/);
         }
     });
 

package/src/callables/e2e.ts

@@ -0,0 +1,25 @@
+import {z} from "zod";
+import {CallableGroup} from "./types";
+
+/**
+ * Contracts for the end-to-end and UX-audit harness
+ * (`Placementt-Backend/functions/src/e2e.ts`).
+ *
+ * `redeemSignInLink` is public: the token is the credential. Links are only
+ * ever minted by the harness (service account, straight into Firestore) and
+ * only ever sign in a reserved `e2e.*@careerthread.co.uk` user, so the UX audit
+ * can walk a registered school without anyone typing a password.
+ */
+export const e2eCallables = {
+    "e2e-redeemSignInLink": {
+        request: z.object({
+            /** The raw token from `/e2eSignIn/:token`. Stored only as a SHA-256 hash. */
+            token: z.string().min(32).max(128).regex(/^[A-Za-z0-9_-]+$/),
+        }),
+        response: z.object({
+            code: z.enum(["ok", "notFound", "expired"]),
+            /** Firebase custom token for the linked e2e user. Only set when code is "ok". */
+            authToken: z.string().optional(),
+        }),
+    },
+} satisfies CallableGroup;

package/src/callables/index.ts

@@ -9,3 +9,5 @@ export * from "./he";
 export * from "./studentLaunches";
 export * from "./billing";
 export * from "./hubImpactReport";
+export * from "./e2e";
+export * from "./wonde";

package/src/callables/registry.ts

@@ -12,6 +12,8 @@ import {studentLaunchCallables} from "./studentLaunches";
 import {billingCallables} from "./billing";
 import {jobRolesCallables} from "./jobRoles";
 import {hubImpactReportCallables} from "./hubImpactReport";
+import {e2eCallables} from "./e2e";
+import {wondeCallables} from "./wonde";
 
 /**
  * The single source of truth for every typed callable. Add a feature group's
@@ -37,6 +39,8 @@ export const allCallables = {
     ...billingCallables,
     ...jobRolesCallables,
     ...hubImpactReportCallables,
+    ...e2eCallables,
+    ...wondeCallables,
 } satisfies CallableGroup;
 
 /** Every registered callable name. */
@@ -55,4 +59,4 @@ export type CallableContracts = {
 };
 
 /** The per-group maps, exported so tests can assert no key collisions. */
-export const callableGroups = {destinationsConfigCallables, placementCallables, eventsCallables, surveyCallables, checksCallables, benchmarksCallables, apprenticeshipsCallables, heCallables, studentLaunchCallables, billingCallables, jobRolesCallables, hubImpactReportCallables};
+export const callableGroups = {destinationsConfigCallables, placementCallables, eventsCallables, surveyCallables, checksCallables, benchmarksCallables, apprenticeshipsCallables, heCallables, studentLaunchCallables, billingCallables, jobRolesCallables, hubImpactReportCallables, e2eCallables, wondeCallables};

package/src/callables/wonde.ts

@@ -0,0 +1,25 @@
+import {z} from "zod";
+import {CallableGroup} from "./types";
+
+/**
+ * Contracts for the Wonde connection request
+ * (`Placementt-Backend/functions/src/wonde.ts`).
+ *
+ * Wonde only approves a connection once the school's IT manager signs it off, so
+ * the school gives us their details and we raise the request with Wonde. Nothing
+ * is emailed from the platform: the request lands as a support task.
+ */
+export const wondeCallables = {
+    "wonde-requestConnection": {
+        request: z.object({
+            /** The school the connection is for. */
+            oId: z.string().min(1),
+            itManagerName: z.string().trim().min(1).max(200),
+            itManagerEmail: z.string().trim().email().max(320),
+        }),
+        response: z.object({
+            /** supportTasks/{id} raised, or the open one it updated. */
+            taskId: z.string(),
+        }),
+    },
+} satisfies CallableGroup;

package/src/index.ts

@@ -24,6 +24,7 @@ export * from "./activityLogging";
 export * from "./studentTools";
 export * from "./featureMarketing";
 export * from "./onboardingPathways";
+export * from "./studentData";
 export * from "./lmi";
 export * from "./lmiCategories";
 export * from "./pathways";

package/src/studentData.test.ts

@@ -0,0 +1,67 @@
+import {InstituteData} from "./typeDefinitions";
+import {
+    WONDE_TEST_CONNECTION_TOKEN,
+    hasStudentYearGroups,
+    hasWondeConnection,
+    isWondeTestConnection,
+    studentDataGate,
+} from "./studentData";
+
+const wonde = (id: string, connectionToken = "real-token") =>
+    ({wonde: {id, connectionToken, hasIntegration: true}} as unknown as Partial<InstituteData>);
+
+describe("hasStudentYearGroups", () => {
+    it("is false with no students", () => {
+        expect(hasStudentYearGroups({students: 0, yearGroups: ["7"]})).toBe(false);
+    });
+
+    it("is false when students have no year group", () => {
+        expect(hasStudentYearGroups({students: 30})).toBe(false);
+        expect(hasStudentYearGroups({students: 30, yearGroups: []})).toBe(false);
+    });
+
+    it("is true with students and year groups", () => {
+        expect(hasStudentYearGroups({students: 30, yearGroups: ["7", "8"]})).toBe(true);
+    });
+
+    it("is false with no institute", () => {
+        expect(hasStudentYearGroups(undefined)).toBe(false);
+    });
+});
+
+describe("hasWondeConnection", () => {
+    it("reads the connection id", () => {
+        expect(hasWondeConnection({})).toBe(false);
+        expect(hasWondeConnection(wonde(""))).toBe(false);
+        expect(hasWondeConnection(wonde("A123"))).toBe(true);
+    });
+});
+
+describe("isWondeTestConnection", () => {
+    it("recognises only the harness token", () => {
+        expect(isWondeTestConnection({connectionToken: WONDE_TEST_CONNECTION_TOKEN})).toBe(true);
+        expect(isWondeTestConnection({connectionToken: "real-token"})).toBe(false);
+        expect(isWondeTestConnection(undefined)).toBe(false);
+    });
+});
+
+describe("studentDataGate", () => {
+    const withStudents = {students: 30, yearGroups: ["7"]};
+
+    it("asks for students first when Wonde is not needed", () => {
+        expect(studentDataGate({}, false)).toBe("needsStudents");
+        expect(studentDataGate(withStudents, false)).toBe("ready");
+    });
+
+    it("asks for Wonde when it is needed and missing, even with CSV students", () => {
+        expect(studentDataGate(withStudents, true)).toBe("needsWonde");
+    });
+
+    it("asks for students when Wonde is connected but nothing has synced", () => {
+        expect(studentDataGate(wonde("A123"), true)).toBe("needsStudents");
+    });
+
+    it("is ready with Wonde and year groups", () => {
+        expect(studentDataGate({...wonde("A123"), ...withStudents}, true)).toBe("ready");
+    });
+});

package/src/studentData.ts

@@ -0,0 +1,69 @@
+import {InstituteData} from "./typeDefinitions";
+
+/**
+ * Whether a school has the student data an area of the platform needs before it
+ * can be set up.
+ *
+ * Destinations, Development and the careers calendar are all set up per year
+ * group. A school with no students, or students with no year group, cannot answer
+ * a single question those setups ask, so instead of the setup flow they are shown
+ * what the area does and asked to bring their students in first.
+ *
+ * Destinations and Development go further and need Wonde: they run all year off
+ * the school's roll, and a CSV goes stale the week after it is uploaded.
+ */
+
+/**
+ * The connection token the E2E and UX-audit harness writes to stand in for a
+ * real Wonde connection. The platform only ever checks that a connection exists,
+ * so this is enough to make a test school look Wonde-connected. The backend sync
+ * skips any institute holding it, so nothing ever calls Wonde with it.
+ */
+export const WONDE_TEST_CONNECTION_TOKEN = "e2e-test-connection";
+
+/** What is missing, most fundamental first. */
+export type StudentDataGate = "ready"|"needsStudents"|"needsWonde";
+
+/**
+ * Whether the Wonde connection is the harness's stand-in rather than a real one.
+ *
+ * @param {InstituteData["wonde"]} [wonde] the institute's Wonde block.
+ * @return {boolean} true for a test connection.
+ */
+export const isWondeTestConnection = (wonde?: Pick<NonNullable<InstituteData["wonde"]>, "connectionToken">): boolean =>
+    wonde?.connectionToken === WONDE_TEST_CONNECTION_TOKEN;
+
+/**
+ * Whether the school has students with a year group on them. `yearGroups` is
+ * only ever added to, so the student count is checked as well: a school that
+ * deleted every student still has its old year groups listed.
+ *
+ * @param {Partial<InstituteData>} [institute] the school.
+ * @return {boolean} true when there are students to set anything up for.
+ */
+export const hasStudentYearGroups = (institute?: Partial<InstituteData>): boolean =>
+    Boolean((institute?.students ?? 0) > 0 && institute?.yearGroups?.length);
+
+/**
+ * Whether the school has a Wonde connection. The connection id is what the sync
+ * runs off, so it is the thing checked, not the `hasIntegration` switch.
+ *
+ * @param {Partial<InstituteData>} [institute] the school.
+ * @return {boolean} true when a Wonde connection id is stored.
+ */
+export const hasWondeConnection = (institute?: Partial<InstituteData>): boolean =>
+    Boolean(institute?.wonde?.id);
+
+/**
+ * What stands between the school and setting an area up.
+ *
+ * @param {Partial<InstituteData>} [institute] the school.
+ * @param {boolean} needsWonde whether the area needs Wonde (Destinations,
+ *     Development) or just students with year groups (the careers calendar).
+ * @return {StudentDataGate} "ready", or the first thing missing.
+ */
+export const studentDataGate = (institute: Partial<InstituteData>|undefined, needsWonde: boolean): StudentDataGate => {
+    if (needsWonde && !hasWondeConnection(institute)) return "needsWonde";
+    if (!hasStudentYearGroups(institute)) return "needsStudents";
+    return "ready";
+};

package/src/typeDefinitions.ts

@@ -1155,6 +1155,15 @@ export type InstituteData = {
         connectionToken: string,
         fields?: string[]
     },
+    /** The school asked us to set Wonde up, from an area that needs it. Wonde
+     * approves a connection through the school's IT manager, so their details are
+     * what we pass on. Written by wonde-requestConnection. */
+    wondeRequest?: {
+        itManagerName: string,
+        itManagerEmail: string,
+        requestedAt: string, // ISO string
+        requestedBy: string, // uid
+    },
     microsoft?: {
         enabled: boolean,
         tenantId?: string,
@@ -4302,7 +4311,7 @@ export type SupportTask = {
     assignee: string;       // uid of the assigned team member
     commId?: string;        // optional link to a Communication doc
     commType?: "leads" | "users"; // collection the comm lives in
-    source?: "customerQuery" | "general" | "seasonalTask" | "onboardingPack" | "midYearPack" | "welcomePack";
+    source?: "customerQuery" | "general" | "seasonalTask" | "onboardingPack" | "midYearPack" | "welcomePack" | "wondeRequest";
     dueAt: string; // ISO string
     inbox?: SupportInbox; // which task inbox triggered this (absent for non-email tasks)
     messageId?: string; // Graph message ID — used to prevent duplicates