placementt-core 1.400.990 → 1.400.991

package/lib/callables/destinationsConfig.d.ts

@@ -0,0 +1,72 @@
+import { z } from "zod";
+/**
+ * Contracts for the Destinations setup wizard
+ * (`Placementt-Backend/functions/src/destinationsConfig.ts`).
+ *
+ * These were `aspirations-*` while they lived in the legacy survey backend. That
+ * module is gone, but the config it happened to host is institute setup that the
+ * survey engine READS and does not own, so the two callables moved rather than being
+ * deleted. The names moved with them: never rename a deployed function in place, so
+ * the old `aspirations-saveDestinationsConfig` and `aspirations-provisionDestinationsNow`
+ * must be deleted explicitly at deploy time.
+ */
+export declare const destinationsConfigCallables: {
+    "destinationsConfig-saveDestinationsConfig": {
+        request: z.ZodObject<{
+            oId: z.ZodString;
+            /** 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>;
+        }, "strip", z.ZodTypeAny, {
+            config: Record<string, unknown>;
+            oId: string;
+        }, {
+            config: Record<string, unknown>;
+            oId: string;
+        }>;
+        response: z.ZodObject<{
+            saved: z.ZodBoolean;
+            /** True on a first save, which provisions the current year immediately. */
+            provisioned: z.ZodBoolean;
+            created: z.ZodOptional<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            saved: boolean;
+            provisioned: boolean;
+            created?: number | undefined;
+        }, {
+            saved: boolean;
+            provisioned: boolean;
+            created?: number | undefined;
+        }>;
+    };
+    "destinationsConfig-provisionDestinationsNow": {
+        request: z.ZodObject<{
+            oId: z.ZodString;
+            /** Provision the upcoming academic year early ("Set Up Next Year"). */
+            nextYear: z.ZodOptional<z.ZodBoolean>;
+            /** Limit to one feature; omit for everything the institute has configured. */
+            scope: z.ZodOptional<z.ZodEnum<["aspirations", "leavers"]>>;
+        }, "strip", z.ZodTypeAny, {
+            oId: string;
+            scope?: "aspirations" | "leavers" | undefined;
+            nextYear?: boolean | undefined;
+        }, {
+            oId: string;
+            scope?: "aspirations" | "leavers" | undefined;
+            nextYear?: boolean | undefined;
+        }>;
+        response: z.ZodObject<{
+            provisioned: z.ZodBoolean;
+            created: z.ZodNumber;
+            academicYear: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            created: number;
+            academicYear: string;
+            provisioned: boolean;
+        }, {
+            created: number;
+            academicYear: string;
+            provisioned: boolean;
+        }>;
+    };
+};

package/lib/callables/destinationsConfig.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.destinationsConfigCallables = void 0;
+const zod_1 = require("zod");
+/**
+ * Contracts for the Destinations setup wizard
+ * (`Placementt-Backend/functions/src/destinationsConfig.ts`).
+ *
+ * These were `aspirations-*` while they lived in the legacy survey backend. That
+ * module is gone, but the config it happened to host is institute setup that the
+ * survey engine READS and does not own, so the two callables moved rather than being
+ * deleted. The names moved with them: never rename a deployed function in place, so
+ * the old `aspirations-saveDestinationsConfig` and `aspirations-provisionDestinationsNow`
+ * must be deleted explicitly at deploy time.
+ */
+exports.destinationsConfigCallables = {
+    "destinationsConfig-saveDestinationsConfig": {
+        request: zod_1.z.object({
+            oId: zod_1.z.string(),
+            /** 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()),
+        }),
+        response: zod_1.z.object({
+            saved: zod_1.z.boolean(),
+            /** True on a first save, which provisions the current year immediately. */
+            provisioned: zod_1.z.boolean(),
+            created: zod_1.z.number().optional(),
+        }),
+    },
+    "destinationsConfig-provisionDestinationsNow": {
+        request: zod_1.z.object({
+            oId: zod_1.z.string(),
+            /** Provision the upcoming academic year early ("Set Up Next Year"). */
+            nextYear: zod_1.z.boolean().optional(),
+            /** Limit to one feature; omit for everything the institute has configured. */
+            scope: zod_1.z.enum(["aspirations", "leavers"]).optional(),
+        }),
+        response: zod_1.z.object({
+            provisioned: zod_1.z.boolean(),
+            created: zod_1.z.number(),
+            academicYear: zod_1.z.string(),
+        }),
+    },
+};
+//# sourceMappingURL=destinationsConfig.js.map

package/lib/callables/destinationsConfig.js.map

@@ -0,0 +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"}

package/lib/callables/index.d.ts

@@ -1,5 +1,5 @@
 export * from "./types";
 export * from "./registry";
-export * from "./aspirations";
+export * from "./destinationsConfig";
 export * from "./placement";
 export * from "./events";

package/lib/callables/index.js

@@ -16,7 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./types"), exports);
 __exportStar(require("./registry"), exports);
-__exportStar(require("./aspirations"), exports);
+__exportStar(require("./destinationsConfig"), exports);
 __exportStar(require("./placement"), exports);
 __exportStar(require("./events"), 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,gDAA8B;AAC9B,8CAA4B;AAC5B,2CAAyB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/callables/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB;AACxB,6CAA2B;AAC3B,uDAAqC;AACrC,8CAA4B;AAC5B,2CAAyB"}

package/lib/callables/registry.d.ts

@@ -419,30 +419,58 @@ export declare const allCallables: {
         }>;
         response: z.ZodAny;
     };
-    "aspirations-createAspirationCycle": {
+    "destinationsConfig-saveDestinationsConfig": {
         request: z.ZodObject<{
             oId: z.ZodString;
-            yearGroupsIncluded: z.ZodArray<z.ZodNumber, "many">;
-            scheduledSendDate: z.ZodString;
-            closeAfterDays: z.ZodOptional<z.ZodNumber>;
-            emailTemplateId: z.ZodOptional<z.ZodString>;
-            students: z.ZodOptional<z.ZodString>;
+            config: z.ZodRecord<z.ZodString, z.ZodUnknown>;
         }, "strip", z.ZodTypeAny, {
+            config: Record<string, unknown>;
             oId: string;
-            yearGroupsIncluded: number[];
-            scheduledSendDate: string;
-            students?: string | undefined;
-            closeAfterDays?: number | undefined;
-            emailTemplateId?: string | undefined;
         }, {
+            config: Record<string, unknown>;
             oId: string;
-            yearGroupsIncluded: number[];
-            scheduledSendDate: string;
-            students?: string | undefined;
-            closeAfterDays?: number | undefined;
-            emailTemplateId?: string | undefined;
         }>;
-        response: z.ZodAny;
+        response: z.ZodObject<{
+            saved: z.ZodBoolean;
+            provisioned: z.ZodBoolean;
+            created: z.ZodOptional<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            saved: boolean;
+            provisioned: boolean;
+            created?: number | undefined;
+        }, {
+            saved: boolean;
+            provisioned: boolean;
+            created?: number | undefined;
+        }>;
+    };
+    "destinationsConfig-provisionDestinationsNow": {
+        request: z.ZodObject<{
+            oId: z.ZodString;
+            nextYear: z.ZodOptional<z.ZodBoolean>;
+            scope: z.ZodOptional<z.ZodEnum<["aspirations", "leavers"]>>;
+        }, "strip", z.ZodTypeAny, {
+            oId: string;
+            scope?: "aspirations" | "leavers" | undefined;
+            nextYear?: boolean | undefined;
+        }, {
+            oId: string;
+            scope?: "aspirations" | "leavers" | undefined;
+            nextYear?: boolean | undefined;
+        }>;
+        response: z.ZodObject<{
+            provisioned: z.ZodBoolean;
+            created: z.ZodNumber;
+            academicYear: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            created: number;
+            academicYear: string;
+            provisioned: boolean;
+        }, {
+            created: number;
+            academicYear: string;
+            provisioned: boolean;
+        }>;
     };
 };
 /** Every registered callable name. */
@@ -460,31 +488,59 @@ export type CallableContracts = {
 };
 /** The per-group maps, exported so tests can assert no key collisions. */
 export declare const callableGroups: {
-    aspirationCallables: {
-        "aspirations-createAspirationCycle": {
+    destinationsConfigCallables: {
+        "destinationsConfig-saveDestinationsConfig": {
             request: z.ZodObject<{
                 oId: z.ZodString;
-                yearGroupsIncluded: z.ZodArray<z.ZodNumber, "many">;
-                scheduledSendDate: z.ZodString;
-                closeAfterDays: z.ZodOptional<z.ZodNumber>;
-                emailTemplateId: z.ZodOptional<z.ZodString>;
-                students: z.ZodOptional<z.ZodString>;
+                config: z.ZodRecord<z.ZodString, z.ZodUnknown>;
             }, "strip", z.ZodTypeAny, {
+                config: Record<string, unknown>;
                 oId: string;
-                yearGroupsIncluded: number[];
-                scheduledSendDate: string;
-                students?: string | undefined;
-                closeAfterDays?: number | undefined;
-                emailTemplateId?: string | undefined;
             }, {
+                config: Record<string, unknown>;
                 oId: string;
-                yearGroupsIncluded: number[];
-                scheduledSendDate: string;
-                students?: string | undefined;
-                closeAfterDays?: number | undefined;
-                emailTemplateId?: string | undefined;
             }>;
-            response: z.ZodAny;
+            response: z.ZodObject<{
+                saved: z.ZodBoolean;
+                provisioned: z.ZodBoolean;
+                created: z.ZodOptional<z.ZodNumber>;
+            }, "strip", z.ZodTypeAny, {
+                saved: boolean;
+                provisioned: boolean;
+                created?: number | undefined;
+            }, {
+                saved: boolean;
+                provisioned: boolean;
+                created?: number | undefined;
+            }>;
+        };
+        "destinationsConfig-provisionDestinationsNow": {
+            request: z.ZodObject<{
+                oId: z.ZodString;
+                nextYear: z.ZodOptional<z.ZodBoolean>;
+                scope: z.ZodOptional<z.ZodEnum<["aspirations", "leavers"]>>;
+            }, "strip", z.ZodTypeAny, {
+                oId: string;
+                scope?: "aspirations" | "leavers" | undefined;
+                nextYear?: boolean | undefined;
+            }, {
+                oId: string;
+                scope?: "aspirations" | "leavers" | undefined;
+                nextYear?: boolean | undefined;
+            }>;
+            response: z.ZodObject<{
+                provisioned: z.ZodBoolean;
+                created: z.ZodNumber;
+                academicYear: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                created: number;
+                academicYear: string;
+                provisioned: boolean;
+            }, {
+                created: number;
+                academicYear: string;
+                provisioned: boolean;
+            }>;
         };
     };
     placementCallables: {

package/lib/callables/registry.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.callableGroups = exports.allCallables = void 0;
-const aspirations_1 = require("./aspirations");
+const destinationsConfig_1 = require("./destinationsConfig");
 const placement_1 = require("./placement");
 const events_1 = require("./events");
 const surveys_1 = require("./surveys");
@@ -17,11 +17,11 @@ const surveys_1 = require("./surveys");
  * equals the sum of the group key counts.
  */
 exports.allCallables = {
-    ...aspirations_1.aspirationCallables,
+    ...destinationsConfig_1.destinationsConfigCallables,
     ...placement_1.placementCallables,
     ...events_1.eventsCallables,
     ...surveys_1.surveyCallables,
 };
 /** The per-group maps, exported so tests can assert no key collisions. */
-exports.callableGroups = { aspirationCallables: aspirations_1.aspirationCallables, placementCallables: placement_1.placementCallables, eventsCallables: events_1.eventsCallables, surveyCallables: surveys_1.surveyCallables };
+exports.callableGroups = { destinationsConfigCallables: destinationsConfig_1.destinationsConfigCallables, placementCallables: placement_1.placementCallables, eventsCallables: events_1.eventsCallables, surveyCallables: surveys_1.surveyCallables };
 //# 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,+CAAkD;AAClD,2CAA+C;AAC/C,qCAAyC;AACzC,uCAA0C;AAE1C;;;;;;;;;;GAUG;AACU,QAAA,YAAY,GAAG;IACxB,GAAG,iCAAmB;IACtB,GAAG,8BAAkB;IACrB,GAAG,wBAAe;IAClB,GAAG,yBAAe;CACG,CAAC;AAiB1B,0EAA0E;AAC7D,QAAA,cAAc,GAAG,EAAC,mBAAmB,EAAnB,iCAAmB,EAAE,kBAAkB,EAAlB,8BAAkB,EAAE,eAAe,EAAf,wBAAe,EAAE,eAAe,EAAf,yBAAe,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;AAE1C;;;;;;;;;;GAUG;AACU,QAAA,YAAY,GAAG;IACxB,GAAG,gDAA2B;IAC9B,GAAG,8BAAkB;IACrB,GAAG,wBAAe;IAClB,GAAG,yBAAe;CACG,CAAC;AAiB1B,0EAA0E;AAC7D,QAAA,cAAc,GAAG,EAAC,2BAA2B,EAA3B,gDAA2B,EAAE,kBAAkB,EAAlB,8BAAkB,EAAE,eAAe,EAAf,wBAAe,EAAE,eAAe,EAAf,yBAAe,EAAC,CAAC"}

package/package.json

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

package/src/callables/destinationsConfig.ts

@@ -0,0 +1,44 @@
+import {z} from "zod";
+import {CallableGroup} from "./types";
+
+/**
+ * Contracts for the Destinations setup wizard
+ * (`Placementt-Backend/functions/src/destinationsConfig.ts`).
+ *
+ * These were `aspirations-*` while they lived in the legacy survey backend. That
+ * module is gone, but the config it happened to host is institute setup that the
+ * survey engine READS and does not own, so the two callables moved rather than being
+ * deleted. The names moved with them: never rename a deployed function in place, so
+ * the old `aspirations-saveDestinationsConfig` and `aspirations-provisionDestinationsNow`
+ * must be deleted explicitly at deploy time.
+ */
+export const destinationsConfigCallables = {
+    "destinationsConfig-saveDestinationsConfig": {
+        request: z.object({
+            oId: z.string(),
+            /** The full DestinationsConfig from the setup wizard. Validated server
+             * side, which is also where provenance fields are stamped. */
+            config: z.record(z.unknown()),
+        }),
+        response: z.object({
+            saved: z.boolean(),
+            /** True on a first save, which provisions the current year immediately. */
+            provisioned: z.boolean(),
+            created: z.number().optional(),
+        }),
+    },
+    "destinationsConfig-provisionDestinationsNow": {
+        request: z.object({
+            oId: z.string(),
+            /** Provision the upcoming academic year early ("Set Up Next Year"). */
+            nextYear: z.boolean().optional(),
+            /** Limit to one feature; omit for everything the institute has configured. */
+            scope: z.enum(["aspirations", "leavers"]).optional(),
+        }),
+        response: z.object({
+            provisioned: z.boolean(),
+            created: z.number(),
+            academicYear: z.string(),
+        }),
+    },
+} satisfies CallableGroup;

package/src/callables/index.ts

@@ -1,5 +1,5 @@
 export * from "./types";
 export * from "./registry";
-export * from "./aspirations";
+export * from "./destinationsConfig";
 export * from "./placement";
 export * from "./events";

package/src/callables/registry.ts

@@ -1,6 +1,6 @@
 import {z} from "zod";
 import {CallableGroup} from "./types";
-import {aspirationCallables} from "./aspirations";
+import {destinationsConfigCallables} from "./destinationsConfig";
 import {placementCallables} from "./placement";
 import {eventsCallables} from "./events";
 import {surveyCallables} from "./surveys";
@@ -17,7 +17,7 @@ import {surveyCallables} from "./surveys";
  * equals the sum of the group key counts.
  */
 export const allCallables = {
-    ...aspirationCallables,
+    ...destinationsConfigCallables,
     ...placementCallables,
     ...eventsCallables,
     ...surveyCallables,
@@ -39,4 +39,4 @@ export type CallableContracts = {
 };
 
 /** The per-group maps, exported so tests can assert no key collisions. */
-export const callableGroups = {aspirationCallables, placementCallables, eventsCallables, surveyCallables};
+export const callableGroups = {destinationsConfigCallables, placementCallables, eventsCallables, surveyCallables};

package/src/callables/aspirations.ts

@@ -1,21 +0,0 @@
-import {z} from "zod";
-import {CallableGroup} from "./types";
-
-/**
- * Contracts for the `aspirations` backend module
- * (`Placementt-Backend/functions/src/aspirations.ts`).
- */
-export const aspirationCallables = {
-    "aspirations-createAspirationCycle": {
-        request: z.object({
-            oId: z.string(),
-            yearGroupsIncluded: z.array(z.number()),
-            scheduledSendDate: z.string(), // ISO string
-            closeAfterDays: z.number().optional(),
-            emailTemplateId: z.string().optional(),
-            students: z.string().optional(), // JSON-serialised DataViewerSelectionBackend
-        }),
-        // TODO: tighten once the return shape is confirmed.
-        response: z.any(),
-    },
-} satisfies CallableGroup;