placementt-core 1.300.1207 → 1.300.1209

package/lib/callables/registry.d.ts

@@ -628,6 +628,90 @@ export declare const allCallables: {
             restored: number;
         }>;
     };
+    "userManagement-checkStudentActivation": {
+        request: z.ZodObject<{
+            users: z.ZodUnion<[z.ZodArray<z.ZodObject<{
+                path: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+                where: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodUnknown, "many">, "many">>;
+            }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+                path: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+                where: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodUnknown, "many">, "many">>;
+            }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+                path: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+                where: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodUnknown, "many">, "many">>;
+            }, z.ZodTypeAny, "passthrough">>, "many">, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
+            filters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>>>;
+            cohortId: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            users: Record<string, unknown> | z.objectOutputType<{
+                path: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+                where: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodUnknown, "many">, "many">>;
+            }, z.ZodTypeAny, "passthrough">[];
+            cohortId?: string | undefined;
+            filters?: Record<string, string | number | boolean> | undefined;
+        }, {
+            users: Record<string, unknown> | z.objectInputType<{
+                path: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+                where: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodUnknown, "many">, "many">>;
+            }, z.ZodTypeAny, "passthrough">[];
+            cohortId?: string | undefined;
+            filters?: Record<string, string | number | boolean> | undefined;
+        }>;
+        response: z.ZodObject<{
+            total: z.ZodNumber;
+            counts: z.ZodRecord<z.ZodString, z.ZodNumber>;
+            blank: z.ZodNumber;
+            blankSample: z.ZodArray<z.ZodObject<{
+                uid: z.ZodString;
+                name: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                name: string;
+                uid: string;
+            }, {
+                name: string;
+                uid: string;
+            }>, "many">;
+            cohortsMissingWorkflow: z.ZodArray<z.ZodObject<{
+                cohortId: z.ZodString;
+                name: z.ZodString;
+                students: z.ZodNumber;
+            }, "strip", z.ZodTypeAny, {
+                name: string;
+                students: number;
+                cohortId: string;
+            }, {
+                name: string;
+                students: number;
+                cohortId: string;
+            }>, "many">;
+        }, "strip", z.ZodTypeAny, {
+            total: number;
+            counts: Record<string, number>;
+            blank: number;
+            blankSample: {
+                name: string;
+                uid: string;
+            }[];
+            cohortsMissingWorkflow: {
+                name: string;
+                students: number;
+                cohortId: string;
+            }[];
+        }, {
+            total: number;
+            counts: Record<string, number>;
+            blank: number;
+            blankSample: {
+                name: string;
+                uid: string;
+            }[];
+            cohortsMissingWorkflow: {
+                name: string;
+                students: number;
+                cohortId: string;
+            }[];
+        }>;
+    };
     "misSync-saveConfig": {
         request: z.ZodObject<z.objectUtil.extendShape<{
             enabled: z.ZodBoolean;
@@ -4750,6 +4834,90 @@ export declare const callableGroups: {
                 restored: number;
             }>;
         };
+        "userManagement-checkStudentActivation": {
+            request: z.ZodObject<{
+                users: z.ZodUnion<[z.ZodArray<z.ZodObject<{
+                    path: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+                    where: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodUnknown, "many">, "many">>;
+                }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+                    path: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+                    where: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodUnknown, "many">, "many">>;
+                }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+                    path: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+                    where: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodUnknown, "many">, "many">>;
+                }, z.ZodTypeAny, "passthrough">>, "many">, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
+                filters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>>>;
+                cohortId: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                users: Record<string, unknown> | z.objectOutputType<{
+                    path: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+                    where: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodUnknown, "many">, "many">>;
+                }, z.ZodTypeAny, "passthrough">[];
+                cohortId?: string | undefined;
+                filters?: Record<string, string | number | boolean> | undefined;
+            }, {
+                users: Record<string, unknown> | z.objectInputType<{
+                    path: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+                    where: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodUnknown, "many">, "many">>;
+                }, z.ZodTypeAny, "passthrough">[];
+                cohortId?: string | undefined;
+                filters?: Record<string, string | number | boolean> | undefined;
+            }>;
+            response: z.ZodObject<{
+                total: z.ZodNumber;
+                counts: z.ZodRecord<z.ZodString, z.ZodNumber>;
+                blank: z.ZodNumber;
+                blankSample: z.ZodArray<z.ZodObject<{
+                    uid: z.ZodString;
+                    name: z.ZodString;
+                }, "strip", z.ZodTypeAny, {
+                    name: string;
+                    uid: string;
+                }, {
+                    name: string;
+                    uid: string;
+                }>, "many">;
+                cohortsMissingWorkflow: z.ZodArray<z.ZodObject<{
+                    cohortId: z.ZodString;
+                    name: z.ZodString;
+                    students: z.ZodNumber;
+                }, "strip", z.ZodTypeAny, {
+                    name: string;
+                    students: number;
+                    cohortId: string;
+                }, {
+                    name: string;
+                    students: number;
+                    cohortId: string;
+                }>, "many">;
+            }, "strip", z.ZodTypeAny, {
+                total: number;
+                counts: Record<string, number>;
+                blank: number;
+                blankSample: {
+                    name: string;
+                    uid: string;
+                }[];
+                cohortsMissingWorkflow: {
+                    name: string;
+                    students: number;
+                    cohortId: string;
+                }[];
+            }, {
+                total: number;
+                counts: Record<string, number>;
+                blank: number;
+                blankSample: {
+                    name: string;
+                    uid: string;
+                }[];
+                cohortsMissingWorkflow: {
+                    name: string;
+                    students: number;
+                    cohortId: string;
+                }[];
+            }>;
+        };
     };
     outreachCallables: {
         "outreach-upsertContacts": {

package/lib/callables/userManagement.d.ts

@@ -35,4 +35,100 @@ export declare const userManagementCallables: {
             restored: number;
         }>;
     };
+    /**
+     * Dry run before activating students: which of them would have something to
+     * use, and which would see an empty platform. Takes the same `users` and
+     * `filters` as `userManagement-activateUsers`. Writes nothing.
+     */
+    "userManagement-checkStudentActivation": {
+        request: z.ZodObject<{
+            /** Query objects for a filtered or "all" selection, or picked students keyed by uid. */
+            users: z.ZodUnion<[z.ZodArray<z.ZodObject<{
+                path: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+                where: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodUnknown, "many">, "many">>;
+            }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+                path: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+                where: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodUnknown, "many">, "many">>;
+            }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+                path: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+                where: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodUnknown, "many">, "many">>;
+            }, z.ZodTypeAny, "passthrough">>, "many">, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
+            /** Equality filters from the student table. */
+            filters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>>>;
+            cohortId: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            users: Record<string, unknown> | z.objectOutputType<{
+                path: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+                where: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodUnknown, "many">, "many">>;
+            }, z.ZodTypeAny, "passthrough">[];
+            cohortId?: string | undefined;
+            filters?: Record<string, string | number | boolean> | undefined;
+        }, {
+            users: Record<string, unknown> | z.objectInputType<{
+                path: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+                where: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodUnknown, "many">, "many">>;
+            }, z.ZodTypeAny, "passthrough">[];
+            cohortId?: string | undefined;
+            filters?: Record<string, string | number | boolean> | undefined;
+        }>;
+        response: z.ZodObject<{
+            /** Students checked, excluding leavers and anyone already active. */
+            total: z.ZodNumber;
+            /** How many have each feature. */
+            counts: z.ZodRecord<z.ZodString, z.ZodNumber>;
+            /** How many would see an empty platform. */
+            blank: z.ZodNumber;
+            /** Up to 20 of them, by name. */
+            blankSample: z.ZodArray<z.ZodObject<{
+                uid: z.ZodString;
+                name: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                name: string;
+                uid: string;
+            }, {
+                name: string;
+                uid: string;
+            }>, "many">;
+            /** Cohorts with students in this selection but no workflow set up. */
+            cohortsMissingWorkflow: z.ZodArray<z.ZodObject<{
+                cohortId: z.ZodString;
+                name: z.ZodString;
+                students: z.ZodNumber;
+            }, "strip", z.ZodTypeAny, {
+                name: string;
+                students: number;
+                cohortId: string;
+            }, {
+                name: string;
+                students: number;
+                cohortId: string;
+            }>, "many">;
+        }, "strip", z.ZodTypeAny, {
+            total: number;
+            counts: Record<string, number>;
+            blank: number;
+            blankSample: {
+                name: string;
+                uid: string;
+            }[];
+            cohortsMissingWorkflow: {
+                name: string;
+                students: number;
+                cohortId: string;
+            }[];
+        }, {
+            total: number;
+            counts: Record<string, number>;
+            blank: number;
+            blankSample: {
+                name: string;
+                uid: string;
+            }[];
+            cohortsMissingWorkflow: {
+                name: string;
+                students: number;
+                cohortId: string;
+            }[];
+        }>;
+    };
 };

package/lib/callables/userManagement.js

@@ -24,5 +24,37 @@ exports.userManagementCallables = {
             skipped: zod_1.z.number(),
         }),
     },
+    /**
+     * Dry run before activating students: which of them would have something to
+     * use, and which would see an empty platform. Takes the same `users` and
+     * `filters` as `userManagement-activateUsers`. Writes nothing.
+     */
+    "userManagement-checkStudentActivation": {
+        request: zod_1.z.object({
+            /** Query objects for a filtered or "all" selection, or picked students keyed by uid. */
+            users: zod_1.z.union([
+                zod_1.z.array(zod_1.z.object({
+                    path: zod_1.z.array(zod_1.z.string()).optional(),
+                    where: zod_1.z.array(zod_1.z.array(zod_1.z.unknown())).optional(),
+                }).passthrough()).max(10),
+                zod_1.z.record(zod_1.z.string().min(1).max(128), zod_1.z.unknown()),
+            ]),
+            /** Equality filters from the student table. */
+            filters: zod_1.z.record(zod_1.z.string(), zod_1.z.union([zod_1.z.string(), zod_1.z.number(), zod_1.z.boolean()])).optional(),
+            cohortId: zod_1.z.string().max(128).optional(),
+        }),
+        response: zod_1.z.object({
+            /** Students checked, excluding leavers and anyone already active. */
+            total: zod_1.z.number(),
+            /** How many have each feature. */
+            counts: zod_1.z.record(zod_1.z.string(), zod_1.z.number()),
+            /** How many would see an empty platform. */
+            blank: zod_1.z.number(),
+            /** Up to 20 of them, by name. */
+            blankSample: zod_1.z.array(zod_1.z.object({ uid: zod_1.z.string(), name: zod_1.z.string() })),
+            /** Cohorts with students in this selection but no workflow set up. */
+            cohortsMissingWorkflow: zod_1.z.array(zod_1.z.object({ cohortId: zod_1.z.string(), name: zod_1.z.string(), students: zod_1.z.number() })),
+        }),
+    },
 };
 //# sourceMappingURL=userManagement.js.map

package/lib/callables/userManagement.js.map

@@ -1 +1 @@
-{"version":3,"file":"userManagement.js","sourceRoot":"","sources":["../../src/callables/userManagement.ts"],"names":[],"mappings":";;;AAAA,6BAAsB;AAGtB;;;GAGG;AACU,QAAA,uBAAuB,GAAG;IACnC;;;OAGG;IACH,+BAA+B,EAAE;QAC7B,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC;YACd,wCAAwC;YACxC,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;YAC/B,IAAI,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE;YAC9D,oEAAoE;YACpE,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;SAC3F,CAAC;QACF,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC;YACf,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE;YACpB,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE;SACtB,CAAC;KACL;CACoB,CAAC"}
+{"version":3,"file":"userManagement.js","sourceRoot":"","sources":["../../src/callables/userManagement.ts"],"names":[],"mappings":";;;AAAA,6BAAsB;AAGtB;;;GAGG;AACU,QAAA,uBAAuB,GAAG;IACnC;;;OAGG;IACH,+BAA+B,EAAE;QAC7B,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC;YACd,wCAAwC;YACxC,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;YAC/B,IAAI,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE;YAC9D,oEAAoE;YACpE,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;SAC3F,CAAC;QACF,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC;YACf,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE;YACpB,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE;SACtB,CAAC;KACL;IACD;;;;OAIG;IACH,uCAAuC,EAAE;QACrC,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC;YACd,wFAAwF;YACxF,KAAK,EAAE,OAAC,CAAC,KAAK,CAAC;gBACX,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,CAAC;oBACb,IAAI,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;oBACpC,KAAK,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;iBAClD,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;gBACzB,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC;aACpD,CAAC;YACF,+CAA+C;YAC/C,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;YACxF,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;SAC3C,CAAC;QACF,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC;YACf,qEAAqE;YACrE,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;YACjB,kCAAkC;YAClC,MAAM,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC;YACxC,4CAA4C;YAC5C,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;YACjB,iCAAiC;YACjC,WAAW,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,CAAC,EAAC,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,EAAC,CAAC,CAAC;YACnE,sEAAsE;YACtE,sBAAsB,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,CAAC,EAAC,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,EAAC,CAAC,CAAC;SAC5G,CAAC;KACL;CACoB,CAAC"}

package/lib/constants.js

@@ -1527,7 +1527,7 @@ exports.emailTemplates = {
     studentActivation: {
         product: "wex",
         description: "Sent to students in this cohort when their account is activated, and as a reminder if they haven't signed in. Schools using Microsoft sign-in get a Microsoft sign-in button instead.",
-        params: ["studentForename", "studentSurname", "studentEmail", "instituteName", "signInInstructions", "cohortContactForename", "cohortContactSurname", "cohortContactEmail"],
+        params: ["studentForename", "studentSurname", "studentEmail", "instituteName", "signInInstructions", "platformFeatures", "cohortContactForename", "cohortContactSurname", "cohortContactEmail"],
         button: { text: "{{activationButtonText}}", link: "{{activationPath}}" },
         type: "workflow"
     },