placementt-core 1.400.1096 → 1.400.1097

package/lib/callables/hubImpactReport.d.ts

@@ -0,0 +1,39 @@
+import { z } from "zod";
+/**
+ * Contract for the Careers Hub impact report
+ * (`Placementt-Backend/functions/src/hubImpactReport.ts`).
+ *
+ * The school/trust impact report is scoped by cohort, because a school's year IS
+ * its cohort. A hub has no cohort, so this one is scoped by date instead, and by
+ * nothing else: everything in the report is derived from the hub's own links,
+ * employer network, events, opportunities and campaigns, so there is no filter
+ * the client could pass that the server should trust.
+ */
+export declare const hubImpactReportCallables: {
+    "hubImpactReport-createHubImpactReport": {
+        request: z.ZodObject<{
+            /** The careers hub to report on. Omitted means the caller's own
+             * organisation; a different one is allowed only where the caller
+             * already has staff access to it. */
+            oId: z.ZodOptional<z.ZodString>;
+            /** Inclusive ISO start date. Both ends must be given, or the report
+             * falls back to the current academic year (1 September onwards) -
+             * which is the period a hub means by "this year" anyway. */
+            startDate: z.ZodOptional<z.ZodString>;
+            /** Inclusive ISO end date. */
+            endDate: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            oId?: string | undefined;
+            startDate?: string | undefined;
+            endDate?: string | undefined;
+        }, {
+            oId?: string | undefined;
+            startDate?: string | undefined;
+            endDate?: string | undefined;
+        }>;
+        /** The Storage path of the generated PDF. The client resolves it with
+         * getDownloadURL, so the download is governed by the Storage rules
+         * rather than by a signed URL the functions runtime cannot mint. */
+        response: z.ZodString;
+    };
+};

package/lib/callables/hubImpactReport.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hubImpactReportCallables = void 0;
+const zod_1 = require("zod");
+/**
+ * Contract for the Careers Hub impact report
+ * (`Placementt-Backend/functions/src/hubImpactReport.ts`).
+ *
+ * The school/trust impact report is scoped by cohort, because a school's year IS
+ * its cohort. A hub has no cohort, so this one is scoped by date instead, and by
+ * nothing else: everything in the report is derived from the hub's own links,
+ * employer network, events, opportunities and campaigns, so there is no filter
+ * the client could pass that the server should trust.
+ */
+exports.hubImpactReportCallables = {
+    "hubImpactReport-createHubImpactReport": {
+        request: zod_1.z.object({
+            /** The careers hub to report on. Omitted means the caller's own
+             * organisation; a different one is allowed only where the caller
+             * already has staff access to it. */
+            oId: zod_1.z.string().optional(),
+            /** Inclusive ISO start date. Both ends must be given, or the report
+             * falls back to the current academic year (1 September onwards) -
+             * which is the period a hub means by "this year" anyway. */
+            startDate: zod_1.z.string().optional(),
+            /** Inclusive ISO end date. */
+            endDate: zod_1.z.string().optional(),
+        }),
+        /** The Storage path of the generated PDF. The client resolves it with
+         * getDownloadURL, so the download is governed by the Storage rules
+         * rather than by a signed URL the functions runtime cannot mint. */
+        response: zod_1.z.string(),
+    },
+};
+//# sourceMappingURL=hubImpactReport.js.map

package/lib/callables/hubImpactReport.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hubImpactReport.js","sourceRoot":"","sources":["../../src/callables/hubImpactReport.ts"],"names":[],"mappings":";;;AAAA,6BAAsB;AAGtB;;;;;;;;;GASG;AACU,QAAA,wBAAwB,GAAG;IACpC,uCAAuC,EAAE;QACrC,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC;YACd;;iDAEqC;YACrC,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YAC1B;;wEAE4D;YAC5D,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YAChC,8BAA8B;YAC9B,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;SACjC,CAAC;QACF;;4EAEoE;QACpE,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE;KACvB;CACoB,CAAC"}

package/lib/callables/index.d.ts

@@ -8,3 +8,4 @@ export * from "./apprenticeships";
 export * from "./he";
 export * from "./activityLogging";
 export * from "./billing";
+export * from "./hubImpactReport";

package/lib/callables/index.js

@@ -24,4 +24,5 @@ __exportStar(require("./apprenticeships"), exports);
 __exportStar(require("./he"), exports);
 __exportStar(require("./activityLogging"), exports);
 __exportStar(require("./billing"), exports);
+__exportStar(require("./hubImpactReport"), 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"}
+{"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"}

package/lib/callables/registry.d.ts

@@ -11,6 +11,22 @@ import { z } from "zod";
  * equals the sum of the group key counts.
  */
 export declare const allCallables: {
+    "hubImpactReport-createHubImpactReport": {
+        request: z.ZodObject<{
+            oId: z.ZodOptional<z.ZodString>;
+            startDate: z.ZodOptional<z.ZodString>;
+            endDate: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            oId?: string | undefined;
+            startDate?: string | undefined;
+            endDate?: string | undefined;
+        }, {
+            oId?: string | undefined;
+            startDate?: string | undefined;
+            endDate?: string | undefined;
+        }>;
+        response: z.ZodString;
+    };
     "jobRoles-getSchoolPopularity": {
         request: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
         response: z.ZodObject<{
@@ -2035,4 +2051,22 @@ export declare const callableGroups: {
             }>;
         };
     };
+    hubImpactReportCallables: {
+        "hubImpactReport-createHubImpactReport": {
+            request: z.ZodObject<{
+                oId: z.ZodOptional<z.ZodString>;
+                startDate: z.ZodOptional<z.ZodString>;
+                endDate: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                oId?: string | undefined;
+                startDate?: string | undefined;
+                endDate?: string | undefined;
+            }, {
+                oId?: string | undefined;
+                startDate?: string | undefined;
+                endDate?: string | undefined;
+            }>;
+            response: z.ZodString;
+        };
+    };
 };

package/lib/callables/registry.js

@@ -12,6 +12,7 @@ const he_1 = require("./he");
 const activityLogging_1 = require("./activityLogging");
 const billing_1 = require("./billing");
 const jobRoles_1 = require("./jobRoles");
+const hubImpactReport_1 = require("./hubImpactReport");
 /**
  * The single source of truth for every typed callable. Add a feature group's
  * spread here and its callables are automatically covered by:
@@ -35,7 +36,8 @@ exports.allCallables = {
     ...activityLogging_1.activityLoggingCallables,
     ...billing_1.billingCallables,
     ...jobRoles_1.jobRolesCallables,
+    ...hubImpactReport_1.hubImpactReportCallables,
 };
 /** 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, activityLoggingCallables: activityLogging_1.activityLoggingCallables, billingCallables: billing_1.billingCallables, jobRolesCallables: jobRoles_1.jobRolesCallables };
+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, activityLoggingCallables: activityLogging_1.activityLoggingCallables, billingCallables: billing_1.billingCallables, jobRolesCallables: jobRoles_1.jobRolesCallables, hubImpactReportCallables: hubImpactReport_1.hubImpactReportCallables };
 //# 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,uDAA2D;AAC3D,uCAA2C;AAC3C,yCAA6C;AAE7C;;;;;;;;;;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,0CAAwB;IAC3B,GAAG,0BAAgB;IACnB,GAAG,4BAAiB;CACC,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,wBAAwB,EAAxB,0CAAwB,EAAE,gBAAgB,EAAhB,0BAAgB,EAAE,iBAAiB,EAAjB,4BAAiB,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,uDAA2D;AAC3D,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,0CAAwB;IAC3B,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,wBAAwB,EAAxB,0CAAwB,EAAE,gBAAgB,EAAhB,0BAAgB,EAAE,iBAAiB,EAAjB,4BAAiB,EAAE,wBAAwB,EAAxB,0CAAwB,EAAC,CAAC"}

package/package.json

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

package/src/callables/hubImpactReport.ts

@@ -0,0 +1,33 @@
+import {z} from "zod";
+import {CallableGroup} from "./types";
+
+/**
+ * Contract for the Careers Hub impact report
+ * (`Placementt-Backend/functions/src/hubImpactReport.ts`).
+ *
+ * The school/trust impact report is scoped by cohort, because a school's year IS
+ * its cohort. A hub has no cohort, so this one is scoped by date instead, and by
+ * nothing else: everything in the report is derived from the hub's own links,
+ * employer network, events, opportunities and campaigns, so there is no filter
+ * the client could pass that the server should trust.
+ */
+export const hubImpactReportCallables = {
+    "hubImpactReport-createHubImpactReport": {
+        request: z.object({
+            /** The careers hub to report on. Omitted means the caller's own
+             * organisation; a different one is allowed only where the caller
+             * already has staff access to it. */
+            oId: z.string().optional(),
+            /** Inclusive ISO start date. Both ends must be given, or the report
+             * falls back to the current academic year (1 September onwards) -
+             * which is the period a hub means by "this year" anyway. */
+            startDate: z.string().optional(),
+            /** Inclusive ISO end date. */
+            endDate: z.string().optional(),
+        }),
+        /** The Storage path of the generated PDF. The client resolves it with
+         * getDownloadURL, so the download is governed by the Storage rules
+         * rather than by a signed URL the functions runtime cannot mint. */
+        response: z.string(),
+    },
+} satisfies CallableGroup;

package/src/callables/index.ts

@@ -8,3 +8,4 @@ export * from "./apprenticeships";
 export * from "./he";
 export * from "./activityLogging";
 export * from "./billing";
+export * from "./hubImpactReport";

package/src/callables/registry.ts

@@ -11,6 +11,7 @@ import {heCallables} from "./he";
 import {activityLoggingCallables} from "./activityLogging";
 import {billingCallables} from "./billing";
 import {jobRolesCallables} from "./jobRoles";
+import {hubImpactReportCallables} from "./hubImpactReport";
 
 /**
  * The single source of truth for every typed callable. Add a feature group's
@@ -35,6 +36,7 @@ export const allCallables = {
     ...activityLoggingCallables,
     ...billingCallables,
     ...jobRolesCallables,
+    ...hubImpactReportCallables,
 } satisfies CallableGroup;
 
 /** Every registered callable name. */
@@ -53,4 +55,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, activityLoggingCallables, billingCallables, jobRolesCallables};
+export const callableGroups = {destinationsConfigCallables, placementCallables, eventsCallables, surveyCallables, checksCallables, benchmarksCallables, apprenticeshipsCallables, heCallables, activityLoggingCallables, billingCallables, jobRolesCallables, hubImpactReportCallables};