placementt-core 1.400.1111 → 1.400.1112

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,4 @@ export * from "./he";
 export * from "./studentLaunches";
 export * from "./billing";
 export * from "./hubImpactReport";
+export * from "./e2e";

package/lib/callables/index.js

@@ -25,4 +25,5 @@ __exportStar(require("./he"), exports);
 __exportStar(require("./studentLaunches"), exports);
 __exportStar(require("./billing"), exports);
 __exportStar(require("./hubImpactReport"), exports);
+__exportStar(require("./e2e"), 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"}

package/lib/callables/registry.d.ts

@@ -11,6 +11,25 @@ import { z } from "zod";
  * equals the sum of the group key counts.
  */
 export declare const allCallables: {
+    "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 +2534,25 @@ 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;
+            }>;
+        };
+    };
 };

package/lib/callables/registry.js

@@ -13,6 +13,7 @@ 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");
 /**
  * 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 +38,8 @@ exports.allCallables = {
     ...billing_1.billingCallables,
     ...jobRoles_1.jobRolesCallables,
     ...hubImpactReport_1.hubImpactReportCallables,
+    ...e2e_1.e2eCallables,
 };
 /** 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 };
 //# 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;AAEnC;;;;;;;;;;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;CACM,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,EAAC,CAAC"}

package/package.json

@@ -2,7 +2,7 @@
   "private": false,
   "name": "placementt-core",
   "author": "Placementt",
-  "version": "1.400.1111",
+  "version": "1.400.1112",
   "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,4 @@ export * from "./he";
 export * from "./studentLaunches";
 export * from "./billing";
 export * from "./hubImpactReport";
+export * from "./e2e";

package/src/callables/registry.ts

@@ -12,6 +12,7 @@ import {studentLaunchCallables} from "./studentLaunches";
 import {billingCallables} from "./billing";
 import {jobRolesCallables} from "./jobRoles";
 import {hubImpactReportCallables} from "./hubImpactReport";
+import {e2eCallables} from "./e2e";
 
 /**
  * The single source of truth for every typed callable. Add a feature group's
@@ -37,6 +38,7 @@ export const allCallables = {
     ...billingCallables,
     ...jobRolesCallables,
     ...hubImpactReportCallables,
+    ...e2eCallables,
 } satisfies CallableGroup;
 
 /** Every registered callable name. */
@@ -55,4 +57,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};