placementt-core 1.400.1077 → 1.400.1079

package/lib/callables/apprenticeships.d.ts

@@ -0,0 +1,102 @@
+import { z } from "zod";
+export declare const apprenticeshipsCallables: {
+    /** Run one crawl step now (about eight minutes of paced requests), starting
+     * a new run if none is open. */
+    "apprenticeships-syncStep": {
+        request: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+        response: z.ZodObject<{
+            runId: z.ZodString;
+            /** True once every route has been crawled and the purge has run. */
+            complete: z.ZodBoolean;
+            cursor: z.ZodOptional<z.ZodObject<{
+                routeIndex: z.ZodNumber;
+                pageNumber: z.ZodNumber;
+                routeCount: z.ZodNumber;
+            }, "strip", z.ZodTypeAny, {
+                routeIndex: number;
+                pageNumber: number;
+                routeCount: number;
+            }, {
+                routeIndex: number;
+                pageNumber: number;
+                routeCount: number;
+            }>>;
+            totals: z.ZodObject<{
+                fetched: z.ZodNumber;
+                written: z.ZodNumber;
+                unchanged: z.ZodNumber;
+                deleted: z.ZodNumber;
+                requests: z.ZodNumber;
+            }, "strip", z.ZodTypeAny, {
+                deleted: number;
+                fetched: number;
+                written: number;
+                unchanged: number;
+                requests: number;
+            }, {
+                deleted: number;
+                fetched: number;
+                written: number;
+                unchanged: number;
+                requests: number;
+            }>;
+            /** Requests this step made, so an admin can see the pacing held. */
+            stepRequests: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            complete: boolean;
+            runId: string;
+            totals: {
+                deleted: number;
+                fetched: number;
+                written: number;
+                unchanged: number;
+                requests: number;
+            };
+            stepRequests: number;
+            cursor?: {
+                routeIndex: number;
+                pageNumber: number;
+                routeCount: number;
+            } | undefined;
+        }, {
+            complete: boolean;
+            runId: string;
+            totals: {
+                deleted: number;
+                fetched: number;
+                written: number;
+                unchanged: number;
+                requests: number;
+            };
+            stepRequests: number;
+            cursor?: {
+                routeIndex: number;
+                pageNumber: number;
+                routeCount: number;
+            } | undefined;
+        }>;
+    };
+    /** Abandon the open run so the next step starts afresh. The mirror and its
+     * manifest are left alone. */
+    "apprenticeships-resetRun": {
+        request: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+        response: z.ZodObject<{
+            ok: z.ZodLiteral<true>;
+        }, "strip", z.ZodTypeAny, {
+            ok: true;
+        }, {
+            ok: true;
+        }>;
+    };
+    /** Refetch the course route list into the config document. */
+    "apprenticeships-refreshRoutes": {
+        request: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+        response: z.ZodObject<{
+            routes: z.ZodArray<z.ZodString, "many">;
+        }, "strip", z.ZodTypeAny, {
+            routes: string[];
+        }, {
+            routes: string[];
+        }>;
+    };
+};

package/lib/callables/apprenticeships.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.apprenticeshipsCallables = void 0;
+const zod_1 = require("zod");
+/**
+ * Contracts for the `apprenticeships` backend module
+ * (`Placementt-Backend/functions/src/apprenticeshipImport.ts`).
+ *
+ * Admin-only controls for the nightly mirror of DfE's Find an apprenticeship
+ * vacancies. All three take no payload; the status document
+ * (`apprenticeshipMeta/status`) is the source of truth the admin card reads
+ * live, so the responses only echo enough to confirm the call landed - a step
+ * can outlive the client's callable deadline and the card still resolves.
+ */
+const syncCursor = zod_1.z.object({
+    routeIndex: zod_1.z.number(),
+    pageNumber: zod_1.z.number(),
+    routeCount: zod_1.z.number(),
+});
+const syncTotals = zod_1.z.object({
+    fetched: zod_1.z.number(),
+    written: zod_1.z.number(),
+    unchanged: zod_1.z.number(),
+    deleted: zod_1.z.number(),
+    requests: zod_1.z.number(),
+});
+exports.apprenticeshipsCallables = {
+    /** Run one crawl step now (about eight minutes of paced requests), starting
+     * a new run if none is open. */
+    "apprenticeships-syncStep": {
+        request: zod_1.z.object({}),
+        response: zod_1.z.object({
+            runId: zod_1.z.string(),
+            /** True once every route has been crawled and the purge has run. */
+            complete: zod_1.z.boolean(),
+            cursor: syncCursor.optional(),
+            totals: syncTotals,
+            /** Requests this step made, so an admin can see the pacing held. */
+            stepRequests: zod_1.z.number(),
+        }),
+    },
+    /** Abandon the open run so the next step starts afresh. The mirror and its
+     * manifest are left alone. */
+    "apprenticeships-resetRun": {
+        request: zod_1.z.object({}),
+        response: zod_1.z.object({
+            ok: zod_1.z.literal(true),
+        }),
+    },
+    /** Refetch the course route list into the config document. */
+    "apprenticeships-refreshRoutes": {
+        request: zod_1.z.object({}),
+        response: zod_1.z.object({
+            routes: zod_1.z.array(zod_1.z.string()),
+        }),
+    },
+};
+//# sourceMappingURL=apprenticeships.js.map

package/lib/callables/apprenticeships.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apprenticeships.js","sourceRoot":"","sources":["../../src/callables/apprenticeships.ts"],"names":[],"mappings":";;;AAAA,6BAAsB;AAGtB;;;;;;;;;GASG;AAEH,MAAM,UAAU,GAAG,OAAC,CAAC,MAAM,CAAC;IACxB,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE;IACtB,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE;IACtB,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE;CACzB,CAAC,CAAC;AAEH,MAAM,UAAU,GAAG,OAAC,CAAC,MAAM,CAAC;IACxB,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE;IACnB,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE;IACnB,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;IACrB,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE;IACnB,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE;CACvB,CAAC,CAAC;AAEU,QAAA,wBAAwB,GAAG;IACpC;oCACgC;IAChC,0BAA0B,EAAE;QACxB,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC,EAAE,CAAC;QACrB,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC;YACf,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;YACjB,oEAAoE;YACpE,QAAQ,EAAE,OAAC,CAAC,OAAO,EAAE;YACrB,MAAM,EAAE,UAAU,CAAC,QAAQ,EAAE;YAC7B,MAAM,EAAE,UAAU;YAClB,oEAAoE;YACpE,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE;SAC3B,CAAC;KACL;IACD;kCAC8B;IAC9B,0BAA0B,EAAE;QACxB,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC,EAAE,CAAC;QACrB,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC;YACf,EAAE,EAAE,OAAC,CAAC,OAAO,CAAC,IAAI,CAAC;SACtB,CAAC;KACL;IACD,8DAA8D;IAC9D,+BAA+B,EAAE;QAC7B,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC,EAAE,CAAC;QACrB,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC;YACf,MAAM,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC;SAC9B,CAAC;KACL;CACoB,CAAC"}

package/lib/callables/he.d.ts

@@ -0,0 +1,94 @@
+import { z } from "zod";
+export declare const heCallables: {
+    /** Run a full import now. `storagePath` names a zip already uploaded to
+     * Cloud Storage (`heImports/<file>.zip`) to use instead of the URL in
+     * the config; omitted, the config's `storagePath` is used if set, and
+     * the URL otherwise. */
+    "he-runImport": {
+        request: z.ZodObject<{
+            storagePath: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            storagePath?: string | undefined;
+        }, {
+            storagePath?: string | undefined;
+        }>;
+        response: z.ZodObject<{
+            runId: z.ZodString;
+            datasetVersion: z.ZodString;
+            source: z.ZodObject<{
+                kind: z.ZodEnum<["url", "storage"]>;
+                ref: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                ref: string;
+                kind: "url" | "storage";
+            }, {
+                ref: string;
+                kind: "url" | "storage";
+            }>;
+            counts: z.ZodObject<{
+                coursesAssembled: z.ZodNumber;
+                coursesWritten: z.ZodNumber;
+                coursesUnchanged: z.ZodNumber;
+                coursesDeleted: z.ZodNumber;
+                providersWritten: z.ZodNumber;
+                providersUnchanged: z.ZodNumber;
+            }, "strip", z.ZodTypeAny, {
+                coursesAssembled: number;
+                coursesWritten: number;
+                coursesUnchanged: number;
+                coursesDeleted: number;
+                providersWritten: number;
+                providersUnchanged: number;
+            }, {
+                coursesAssembled: number;
+                coursesWritten: number;
+                coursesUnchanged: number;
+                coursesDeleted: number;
+                providersWritten: number;
+                providersUnchanged: number;
+            }>;
+        }, "strip", z.ZodTypeAny, {
+            source: {
+                ref: string;
+                kind: "url" | "storage";
+            };
+            runId: string;
+            datasetVersion: string;
+            counts: {
+                coursesAssembled: number;
+                coursesWritten: number;
+                coursesUnchanged: number;
+                coursesDeleted: number;
+                providersWritten: number;
+                providersUnchanged: number;
+            };
+        }, {
+            source: {
+                ref: string;
+                kind: "url" | "storage";
+            };
+            runId: string;
+            datasetVersion: string;
+            counts: {
+                coursesAssembled: number;
+                coursesWritten: number;
+                coursesUnchanged: number;
+                coursesDeleted: number;
+                providersWritten: number;
+                providersUnchanged: number;
+            };
+        }>;
+    };
+    /** Clear a stuck "running" state. The mirror and its manifest are left
+     * alone. */
+    "he-resetRun": {
+        request: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+        response: z.ZodObject<{
+            ok: z.ZodLiteral<true>;
+        }, "strip", z.ZodTypeAny, {
+            ok: true;
+        }, {
+            ok: true;
+        }>;
+    };
+};

package/lib/callables/he.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.heCallables = void 0;
+const zod_1 = require("zod");
+/**
+ * Contracts for the `he` backend module
+ * (`Placementt-Backend/functions/src/heImport.ts`).
+ *
+ * Admin-only controls for the weekly mirror of the HESA Discover Uni dataset
+ * into `heCourses` / `heProviders`. The status document (`heMeta/status`) is
+ * the source of truth the admin card reads live, so the responses only echo
+ * enough to confirm the call landed - an import can outlive the client's
+ * callable deadline and the card still resolves.
+ */
+const importCounts = zod_1.z.object({
+    coursesAssembled: zod_1.z.number(),
+    coursesWritten: zod_1.z.number(),
+    coursesUnchanged: zod_1.z.number(),
+    coursesDeleted: zod_1.z.number(),
+    providersWritten: zod_1.z.number(),
+    providersUnchanged: zod_1.z.number(),
+});
+exports.heCallables = {
+    /** Run a full import now. `storagePath` names a zip already uploaded to
+     * Cloud Storage (`heImports/<file>.zip`) to use instead of the URL in
+     * the config; omitted, the config's `storagePath` is used if set, and
+     * the URL otherwise. */
+    "he-runImport": {
+        request: zod_1.z.object({
+            storagePath: zod_1.z.string().optional(),
+        }),
+        response: zod_1.z.object({
+            runId: zod_1.z.string(),
+            datasetVersion: zod_1.z.string(),
+            source: zod_1.z.object({
+                kind: zod_1.z.enum(["url", "storage"]),
+                ref: zod_1.z.string(),
+            }),
+            counts: importCounts,
+        }),
+    },
+    /** Clear a stuck "running" state. The mirror and its manifest are left
+     * alone. */
+    "he-resetRun": {
+        request: zod_1.z.object({}),
+        response: zod_1.z.object({
+            ok: zod_1.z.literal(true),
+        }),
+    },
+};
+//# sourceMappingURL=he.js.map

package/lib/callables/he.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"he.js","sourceRoot":"","sources":["../../src/callables/he.ts"],"names":[],"mappings":";;;AAAA,6BAAsB;AAGtB;;;;;;;;;GASG;AAEH,MAAM,YAAY,GAAG,OAAC,CAAC,MAAM,CAAC;IAC1B,gBAAgB,EAAE,OAAC,CAAC,MAAM,EAAE;IAC5B,cAAc,EAAE,OAAC,CAAC,MAAM,EAAE;IAC1B,gBAAgB,EAAE,OAAC,CAAC,MAAM,EAAE;IAC5B,cAAc,EAAE,OAAC,CAAC,MAAM,EAAE;IAC1B,gBAAgB,EAAE,OAAC,CAAC,MAAM,EAAE;IAC5B,kBAAkB,EAAE,OAAC,CAAC,MAAM,EAAE;CACjC,CAAC,CAAC;AAEU,QAAA,WAAW,GAAG;IACvB;;;4BAGwB;IACxB,cAAc,EAAE;QACZ,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC;YACd,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;SACrC,CAAC;QACF,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC;YACf,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;YACjB,cAAc,EAAE,OAAC,CAAC,MAAM,EAAE;YAC1B,MAAM,EAAE,OAAC,CAAC,MAAM,CAAC;gBACb,IAAI,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;gBAChC,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE;aAClB,CAAC;YACF,MAAM,EAAE,YAAY;SACvB,CAAC;KACL;IACD;gBACY;IACZ,aAAa,EAAE;QACX,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC,EAAE,CAAC;QACrB,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC;YACf,EAAE,EAAE,OAAC,CAAC,OAAO,CAAC,IAAI,CAAC;SACtB,CAAC;KACL;CACoB,CAAC"}

package/lib/callables/index.d.ts

@@ -4,3 +4,5 @@ export * from "./destinationsConfig";
 export * from "./placement";
 export * from "./events";
 export * from "./jobRoles";
+export * from "./apprenticeships";
+export * from "./he";

package/lib/callables/index.js

@@ -20,4 +20,6 @@ __exportStar(require("./destinationsConfig"), exports);
 __exportStar(require("./placement"), exports);
 __exportStar(require("./events"), exports);
 __exportStar(require("./jobRoles"), exports);
+__exportStar(require("./apprenticeships"), exports);
+__exportStar(require("./he"), 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"}
+{"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"}