placementt-core 1.400.1249 → 1.400.1251

package/lib/bulkEngagement.d.ts

@@ -0,0 +1,48 @@
+import { InstituteData } from "./typeDefinitions";
+import { ResolvedProducts } from "./productResolver";
+/**
+ * Bulk engagement emails: one admin email template, sent now to many schools.
+ * The admin decides what goes out and when; this only suggests which schools
+ * it fits, and flags what is missing for each.
+ *
+ * Pure: the backend reads each school and hands it in.
+ */
+/** Something about a school that makes the email go out incomplete, or not at all. */
+export type BulkEngagementFlag = "noContacts" | "noRenewalDate" | "noQuote" | "noFinanceContact" | "sentRecently";
+export declare const BULK_ENGAGEMENT_FLAG_LABELS: Record<BulkEngagementFlag, string>;
+/** Flags that stop a school being sent the email at all. */
+export declare const BULK_ENGAGEMENT_BLOCKING_FLAGS: BulkEngagementFlag[];
+/** A school that had this email this recently isn't suggested it again. */
+export declare const RECENTLY_SENT_DAYS = 60;
+export type BulkEngagementSchool = {
+    institute: InstituteData;
+    products: ResolvedProducts;
+    now: Date;
+    /** How many of the school's contacts it would go to. */
+    contactCount: number;
+    /** Whether the school has a price for next year. */
+    hasQuote: boolean;
+    /** The email of the school's next onboarding step, if any. */
+    nextOnboardingTemplate?: string;
+    /** ISO date this email last went to the school, if it has. */
+    lastSent?: string;
+};
+export type BulkEngagementSuggestion = {
+    /** Ticked to start with in the send popup. */
+    suggested: boolean;
+    /** Why it is suggested, for the admin. */
+    reason?: string;
+    flags: BulkEngagementFlag[];
+};
+/**
+ * Whether one email suits one school, and what is missing for it.
+ *
+ * Renewal emails are suggested by days to renewal, and any other admin email
+ * to schools whose next onboarding step it is. Neither is suggested to a
+ * school that had it in the last 60 days.
+ *
+ * @param {string} templateKey the admin email template.
+ * @param {BulkEngagementSchool} school the school.
+ * @return {BulkEngagementSuggestion} whether to suggest it, why, and its flags.
+ */
+export declare const bulkEngagementSuggestion: (templateKey: string, school: BulkEngagementSchool) => BulkEngagementSuggestion;

package/lib/bulkEngagement.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.bulkEngagementSuggestion = exports.RECENTLY_SENT_DAYS = exports.BULK_ENGAGEMENT_BLOCKING_FLAGS = exports.BULK_ENGAGEMENT_FLAG_LABELS = void 0;
+const renewals_1 = require("./renewals");
+const constants_1 = require("./constants");
+exports.BULK_ENGAGEMENT_FLAG_LABELS = {
+    noContacts: "No one to send to",
+    noRenewalDate: "No renewal date",
+    noQuote: "No quote",
+    noFinanceContact: "No finance contact",
+    sentRecently: "Sent in the last 60 days",
+};
+/** Flags that stop a school being sent the email at all. */
+exports.BULK_ENGAGEMENT_BLOCKING_FLAGS = ["noContacts"];
+/** A school that had this email this recently isn't suggested it again. */
+exports.RECENTLY_SENT_DAYS = 60;
+/**
+ * Days to renewal each renewal email is suggested for, inclusive. "paying"
+ * suggests it to every paying school, date or not.
+ */
+const RENEWAL_SUGGEST_DAYS = {
+    engagementRenewalPrice: [61, 365],
+    engagementRenewalReview: "paying",
+    engagementRenewalDue: [31, 90],
+    engagementRenewalInvoice: [0, 45],
+    // A date this far off has most likely just moved on a year.
+    engagementRenewalThanks: [300, 400],
+};
+/**
+ * Whether one email suits one school, and what is missing for it.
+ *
+ * Renewal emails are suggested by days to renewal, and any other admin email
+ * to schools whose next onboarding step it is. Neither is suggested to a
+ * school that had it in the last 60 days.
+ *
+ * @param {string} templateKey the admin email template.
+ * @param {BulkEngagementSchool} school the school.
+ * @return {BulkEngagementSuggestion} whether to suggest it, why, and its flags.
+ */
+const bulkEngagementSuggestion = (templateKey, school) => {
+    const { institute, products, now, contactCount, hasQuote, nextOnboardingTemplate, lastSent } = school;
+    const params = constants_1.emailTemplates[templateKey]?.params || [];
+    const renewal = (0, renewals_1.renewalInfo)({ institute, products, now });
+    const recent = Boolean(lastSent) && now.getTime() - Date.parse(lastSent) < exports.RECENTLY_SENT_DAYS * 86400000;
+    const flags = [];
+    if (!contactCount)
+        flags.push("noContacts");
+    if (params.includes("renewalDate") && !renewal.renewalDate)
+        flags.push("noRenewalDate");
+    if (params.includes("quote") && !hasQuote)
+        flags.push("noQuote");
+    if (renewals_1.RENEWAL_FINANCE_TEMPLATES.includes(templateKey) && !institute.financeContact)
+        flags.push("noFinanceContact");
+    if (recent)
+        flags.push("sentRecently");
+    const none = { suggested: false, flags };
+    if (recent || flags.some((f) => exports.BULK_ENGAGEMENT_BLOCKING_FLAGS.includes(f)))
+        return none;
+    const window = RENEWAL_SUGGEST_DAYS[templateKey];
+    if (!window)
+        return nextOnboardingTemplate === templateKey ? { suggested: true, reason: "Their next onboarding step", flags } : none;
+    if (!renewal.applies)
+        return none;
+    if (window === "paying")
+        return { suggested: true, reason: "Paying customer", flags };
+    const days = renewal.daysToRenewal;
+    if (days === undefined || days < window[0] || days > window[1])
+        return none;
+    return { suggested: true, reason: `Renews in ${days} days`, flags };
+};
+exports.bulkEngagementSuggestion = bulkEngagementSuggestion;
+//# sourceMappingURL=bulkEngagement.js.map

package/lib/bulkEngagement.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bulkEngagement.js","sourceRoot":"","sources":["../src/bulkEngagement.ts"],"names":[],"mappings":";;;AAEA,yCAAkE;AAClE,2CAA2C;AAa9B,QAAA,2BAA2B,GAAuC;IAC3E,UAAU,EAAE,mBAAmB;IAC/B,aAAa,EAAE,iBAAiB;IAChC,OAAO,EAAE,UAAU;IACnB,gBAAgB,EAAE,oBAAoB;IACtC,YAAY,EAAE,0BAA0B;CAC3C,CAAC;AAEF,4DAA4D;AAC/C,QAAA,8BAA8B,GAAyB,CAAC,YAAY,CAAC,CAAC;AAEnF,2EAA2E;AAC9D,QAAA,kBAAkB,GAAG,EAAE,CAAC;AAErC;;;GAGG;AACH,MAAM,oBAAoB,GAAuD;IAC7E,sBAAsB,EAAE,CAAC,EAAE,EAAE,GAAG,CAAC;IACjC,uBAAuB,EAAE,QAAQ;IACjC,oBAAoB,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC;IAC9B,wBAAwB,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC;IACjC,4DAA4D;IAC5D,uBAAuB,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;CACtC,CAAC;AAwBF;;;;;;;;;;GAUG;AACI,MAAM,wBAAwB,GAAG,CAAC,WAAmB,EAAE,MAA4B,EAA4B,EAAE;IACpH,MAAM,EAAC,SAAS,EAAE,QAAQ,EAAE,GAAG,EAAE,YAAY,EAAE,QAAQ,EAAE,sBAAsB,EAAE,QAAQ,EAAC,GAAG,MAAM,CAAC;IACpG,MAAM,MAAM,GAAG,0BAAc,CAAC,WAAW,CAAC,EAAE,MAAM,IAAI,EAAE,CAAC;IACzD,MAAM,OAAO,GAAG,IAAA,sBAAW,EAAC,EAAC,SAAS,EAAE,QAAQ,EAAE,GAAG,EAAC,CAAC,CAAC;IACxD,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,GAAG,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,QAAkB,CAAC,GAAG,0BAAkB,GAAG,QAAQ,CAAC;IAEnH,MAAM,KAAK,GAAyB,EAAE,CAAC;IACvC,IAAI,CAAC,YAAY;QAAE,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC5C,IAAI,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW;QAAE,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACxF,IAAI,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ;QAAE,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACjE,IAAI,oCAAyB,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc;QAAE,KAAK,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IACjH,IAAI,MAAM;QAAE,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAEvC,MAAM,IAAI,GAAG,EAAC,SAAS,EAAE,KAAK,EAAE,KAAK,EAAC,CAAC;IACvC,IAAI,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,sCAA8B,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QAAE,OAAO,IAAI,CAAC;IAEzF,MAAM,MAAM,GAAG,oBAAoB,CAAC,WAAW,CAAC,CAAC;IACjD,IAAI,CAAC,MAAM;QAAE,OAAO,sBAAsB,KAAK,WAAW,CAAC,CAAC,CAAC,EAAC,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,4BAA4B,EAAE,KAAK,EAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACnI,IAAI,CAAC,OAAO,CAAC,OAAO;QAAE,OAAO,IAAI,CAAC;IAClC,IAAI,MAAM,KAAK,QAAQ;QAAE,OAAO,EAAC,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,iBAAiB,EAAE,KAAK,EAAC,CAAC;IACpF,MAAM,IAAI,GAAG,OAAO,CAAC,aAAa,CAAC;IACnC,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC;QAAE,OAAO,IAAI,CAAC;IAC5E,OAAO,EAAC,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,aAAa,IAAI,OAAO,EAAE,KAAK,EAAC,CAAC;AACtE,CAAC,CAAC;AAvBW,QAAA,wBAAwB,4BAuBnC"}

package/lib/bulkEngagement.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/bulkEngagement.test.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+jest.mock("firebase/firestore", () => ({ where: jest.fn() }));
+jest.mock("./firebase/firebaseQuery", () => ({ __esModule: true, default: class {
+    } }));
+const productResolver_1 = require("./productResolver");
+const bulkEngagement_1 = require("./bulkEngagement");
+const school = (renewalDate, overrides = {}) => ({
+    name: "Calder Park Academy",
+    package: "institutes-one",
+    workExperience: true,
+    cs: { lifecycleStatus: "maintenance", productTypes: ["workExperience"], ...(renewalDate ? { renewalDate } : {}) },
+    ...overrides,
+});
+const suggest = (templateKey, institute, date, extra = {}) => (0, bulkEngagement_1.bulkEngagementSuggestion)(templateKey, {
+    institute,
+    products: (0, productResolver_1.resolveProducts)(institute),
+    now: new Date(`${date}T09:00:00Z`),
+    contactCount: extra.contactCount ?? 2,
+    hasQuote: extra.hasQuote ?? true,
+    nextOnboardingTemplate: extra.nextOnboardingTemplate,
+    lastSent: extra.lastSent,
+});
+describe("bulk engagement suggestions", () => {
+    it("suggests the 60-day email to schools renewing in 31 to 90 days", () => {
+        expect(suggest("engagementRenewalDue", school("2027-01-10"), "2026-11-04")).toMatchObject({ suggested: true, reason: "Renews in 67 days" });
+        expect(suggest("engagementRenewalDue", school("2027-06-10"), "2026-11-04").suggested).toBe(false);
+        expect(suggest("engagementRenewalDue", school("2026-11-20"), "2026-11-04").suggested).toBe(false);
+    });
+    it("suggests the invoice email inside 45 days, and next year's price further out", () => {
+        expect(suggest("engagementRenewalInvoice", school("2026-11-20"), "2026-11-04").suggested).toBe(true);
+        expect(suggest("engagementRenewalPrice", school("2027-06-10"), "2026-11-04").suggested).toBe(true);
+        expect(suggest("engagementRenewalPrice", school("2026-11-20"), "2026-11-04").suggested).toBe(false);
+    });
+    it("suggests the year in review to every paying school, and thanks to those just renewed", () => {
+        expect(suggest("engagementRenewalReview", school(), "2026-11-04").suggested).toBe(true);
+        expect(suggest("engagementRenewalThanks", school("2027-10-20"), "2026-11-04").suggested).toBe(true);
+        expect(suggest("engagementRenewalThanks", school("2027-01-10"), "2026-11-04").suggested).toBe(false);
+    });
+    it("leaves out hub schools", () => {
+        expect(suggest("engagementRenewalDue", school("2027-01-10", { package: "careersSchool" }), "2026-11-04").suggested).toBe(false);
+    });
+    it("doesn't suggest an email the school had in the last 60 days", () => {
+        const recent = suggest("engagementRenewalDue", school("2027-01-10"), "2026-11-04", { lastSent: "2026-10-01T09:00:00Z" });
+        expect(recent).toMatchObject({ suggested: false, flags: expect.arrayContaining(["sentRecently"]) });
+        expect(suggest("engagementRenewalDue", school("2027-01-10"), "2026-11-04", { lastSent: "2026-06-01T09:00:00Z" }).suggested).toBe(true);
+    });
+    it("flags what the email is missing", () => {
+        expect(suggest("engagementRenewalDue", school(), "2026-11-04", { hasQuote: false }).flags)
+            .toEqual(["noRenewalDate", "noQuote", "noFinanceContact"]);
+        const withFinance = school("2027-01-10", { financeContact: { name: "Pat Lee", email: "pat@school.org" } });
+        expect(suggest("engagementRenewalDue", withFinance, "2026-11-04").flags).toEqual([]);
+    });
+    it("never suggests a school with no one to send to", () => {
+        expect(suggest("engagementRenewalReview", school(), "2026-11-04", { contactCount: 0 })).toMatchObject({ suggested: false, flags: ["noContacts"] });
+    });
+    it("suggests an onboarding email to schools whose next step it is", () => {
+        expect(suggest("engagementPickFeatures", school(), "2026-11-04", { nextOnboardingTemplate: "engagementPickFeatures" }))
+            .toMatchObject({ suggested: true, reason: "Their next onboarding step" });
+        expect(suggest("engagementPickFeatures", school(), "2026-11-04", { nextOnboardingTemplate: "engagementPlanYear" }).suggested).toBe(false);
+    });
+});
+//# sourceMappingURL=bulkEngagement.test.js.map

package/lib/bulkEngagement.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bulkEngagement.test.js","sourceRoot":"","sources":["../src/bulkEngagement.test.ts"],"names":[],"mappings":";;AAAA,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE,GAAG,EAAE,CAAC,CAAC,EAAC,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE,EAAC,CAAC,CAAC,CAAC;AAC5D,IAAI,CAAC,IAAI,CAAC,0BAA0B,EAAE,GAAG,EAAE,CAAC,CAAC,EAAC,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE;KAAQ,EAAC,CAAC,CAAC,CAAC;AAGrF,uDAAkD;AAClD,qDAA0D;AAE1D,MAAM,MAAM,GAAG,CAAC,WAAoB,EAAE,YAAoC,EAAE,EAAiB,EAAE,CAAC,CAAC;IAC7F,IAAI,EAAE,qBAAqB;IAC3B,OAAO,EAAE,gBAAgB;IACzB,cAAc,EAAE,IAAI;IACpB,EAAE,EAAE,EAAC,eAAe,EAAE,aAAa,EAAE,YAAY,EAAE,CAAC,gBAAgB,CAAC,EAAE,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAC,WAAW,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAC;IAC7G,GAAG,SAAS;CACc,CAAA,CAAC;AAE/B,MAAM,OAAO,GAAG,CAAC,WAAmB,EAAE,SAAwB,EAAE,IAAY,EAAE,QAAyG,EAAE,EAAE,EAAE,CACzL,IAAA,yCAAwB,EAAC,WAAW,EAAE;IAClC,SAAS;IACT,QAAQ,EAAE,IAAA,iCAAe,EAAC,SAAS,CAAC;IACpC,GAAG,EAAE,IAAI,IAAI,CAAC,GAAG,IAAI,YAAY,CAAC;IAClC,YAAY,EAAE,KAAK,CAAC,YAAY,IAAI,CAAC;IACrC,QAAQ,EAAE,KAAK,CAAC,QAAQ,IAAI,IAAI;IAChC,sBAAsB,EAAE,KAAK,CAAC,sBAAsB;IACpD,QAAQ,EAAE,KAAK,CAAC,QAAQ;CAC3B,CAAC,CAAC;AAEP,QAAQ,CAAC,6BAA6B,EAAE,GAAG,EAAE;IACzC,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACtE,MAAM,CAAC,OAAO,CAAC,sBAAsB,EAAE,MAAM,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,aAAa,CAAC,EAAC,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,mBAAmB,EAAC,CAAC,CAAC;QAC1I,MAAM,CAAC,OAAO,CAAC,sBAAsB,EAAE,MAAM,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAClG,MAAM,CAAC,OAAO,CAAC,sBAAsB,EAAE,MAAM,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACtG,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8EAA8E,EAAE,GAAG,EAAE;QACpF,MAAM,CAAC,OAAO,CAAC,0BAA0B,EAAE,MAAM,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrG,MAAM,CAAC,OAAO,CAAC,wBAAwB,EAAE,MAAM,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnG,MAAM,CAAC,OAAO,CAAC,wBAAwB,EAAE,MAAM,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACxG,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sFAAsF,EAAE,GAAG,EAAE;QAC5F,MAAM,CAAC,OAAO,CAAC,yBAAyB,EAAE,MAAM,EAAE,EAAE,YAAY,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxF,MAAM,CAAC,OAAO,CAAC,yBAAyB,EAAE,MAAM,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACpG,MAAM,CAAC,OAAO,CAAC,yBAAyB,EAAE,MAAM,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACzG,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wBAAwB,EAAE,GAAG,EAAE;QAC9B,MAAM,CAAC,OAAO,CAAC,sBAAsB,EAAE,MAAM,CAAC,YAAY,EAAE,EAAC,OAAO,EAAE,eAAe,EAAC,CAAC,EAAE,YAAY,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAClI,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;QACnE,MAAM,MAAM,GAAG,OAAO,CAAC,sBAAsB,EAAE,MAAM,CAAC,YAAY,CAAC,EAAE,YAAY,EAAE,EAAC,QAAQ,EAAE,sBAAsB,EAAC,CAAC,CAAC;QACvH,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,EAAC,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,eAAe,CAAC,CAAC,cAAc,CAAC,CAAC,EAAC,CAAC,CAAC;QAClG,MAAM,CAAC,OAAO,CAAC,sBAAsB,EAAE,MAAM,CAAC,YAAY,CAAC,EAAE,YAAY,EAAE,EAAC,QAAQ,EAAE,sBAAsB,EAAC,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzI,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;QACvC,MAAM,CAAC,OAAO,CAAC,sBAAsB,EAAE,MAAM,EAAE,EAAE,YAAY,EAAE,EAAC,QAAQ,EAAE,KAAK,EAAC,CAAC,CAAC,KAAK,CAAC;aACnF,OAAO,CAAC,CAAC,eAAe,EAAE,SAAS,EAAE,kBAAkB,CAAC,CAAC,CAAC;QAC/D,MAAM,WAAW,GAAG,MAAM,CAAC,YAAY,EAAE,EAAC,cAAc,EAAE,EAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,gBAAgB,EAAC,EAA2B,CAAC,CAAC;QACjI,MAAM,CAAC,OAAO,CAAC,sBAAsB,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACzF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;QACtD,MAAM,CAAC,OAAO,CAAC,yBAAyB,EAAE,MAAM,EAAE,EAAE,YAAY,EAAE,EAAC,YAAY,EAAE,CAAC,EAAC,CAAC,CAAC,CAAC,aAAa,CAAC,EAAC,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,YAAY,CAAC,EAAC,CAAC,CAAC;IACnJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+DAA+D,EAAE,GAAG,EAAE;QACrE,MAAM,CAAC,OAAO,CAAC,wBAAwB,EAAE,MAAM,EAAE,EAAE,YAAY,EAAE,EAAC,sBAAsB,EAAE,wBAAwB,EAAC,CAAC,CAAC;aAChH,aAAa,CAAC,EAAC,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,4BAA4B,EAAC,CAAC,CAAC;QAC5E,MAAM,CAAC,OAAO,CAAC,wBAAwB,EAAE,MAAM,EAAE,EAAE,YAAY,EAAE,EAAC,sBAAsB,EAAE,oBAAoB,EAAC,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC5I,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/lib/callables/engagement.d.ts

@@ -0,0 +1,134 @@
+import { z } from "zod";
+export declare const engagementCallables: {
+    "bulkEngagement-getBulkEngagementSchools": {
+        request: z.ZodObject<{
+            /** An admin email template (product "admin" in emailTemplates). */
+            templateKey: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            templateKey: string;
+        }, {
+            templateKey: string;
+        }>;
+        response: z.ZodObject<{
+            schools: z.ZodArray<z.ZodObject<{
+                oId: z.ZodString;
+                name: z.ZodString;
+                package: z.ZodString;
+                suggested: z.ZodBoolean;
+                reason: z.ZodOptional<z.ZodString>;
+                flags: z.ZodArray<z.ZodEnum<["noContacts", "noRenewalDate", "noQuote", "noFinanceContact", "sentRecently"]>, "many">;
+                /** How many of the school's contacts it would go to. */
+                contacts: z.ZodNumber;
+                /** ISO date this email last went to the school, if it has. */
+                lastSent: z.ZodOptional<z.ZodString>;
+                /** The school's params, for previewing the email as they'd get it. */
+                params: z.ZodRecord<z.ZodString, z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                name: string;
+                oId: string;
+                package: string;
+                flags: ("noContacts" | "noRenewalDate" | "noQuote" | "noFinanceContact" | "sentRecently")[];
+                contacts: number;
+                params: Record<string, string>;
+                suggested: boolean;
+                reason?: string | undefined;
+                lastSent?: string | undefined;
+            }, {
+                name: string;
+                oId: string;
+                package: string;
+                flags: ("noContacts" | "noRenewalDate" | "noQuote" | "noFinanceContact" | "sentRecently")[];
+                contacts: number;
+                params: Record<string, string>;
+                suggested: boolean;
+                reason?: string | undefined;
+                lastSent?: string | undefined;
+            }>, "many">;
+        }, "strip", z.ZodTypeAny, {
+            schools: {
+                name: string;
+                oId: string;
+                package: string;
+                flags: ("noContacts" | "noRenewalDate" | "noQuote" | "noFinanceContact" | "sentRecently")[];
+                contacts: number;
+                params: Record<string, string>;
+                suggested: boolean;
+                reason?: string | undefined;
+                lastSent?: string | undefined;
+            }[];
+        }, {
+            schools: {
+                name: string;
+                oId: string;
+                package: string;
+                flags: ("noContacts" | "noRenewalDate" | "noQuote" | "noFinanceContact" | "sentRecently")[];
+                contacts: number;
+                params: Record<string, string>;
+                suggested: boolean;
+                reason?: string | undefined;
+                lastSent?: string | undefined;
+            }[];
+        }>;
+    };
+    "bulkEngagement-sendBulkEngagementEmail": {
+        request: z.ZodObject<{
+            templateKey: z.ZodString;
+            oIds: z.ZodArray<z.ZodString, "many">;
+            subject: z.ZodString;
+            /** The Slate body, edited for this send. The template itself is unchanged. */
+            body: z.ZodArray<z.ZodUnknown, "many">;
+            /** Must be in our storage bucket; checked on the server. */
+            heroImage: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string | undefined, string | null | undefined>;
+            /** Send the weekly follow-ups: up to three, or until an onboarding step is done. */
+            followUps: z.ZodBoolean;
+        }, "strip", z.ZodTypeAny, {
+            body: unknown[];
+            subject: string;
+            templateKey: string;
+            oIds: string[];
+            followUps: boolean;
+            heroImage?: string | undefined;
+        }, {
+            body: unknown[];
+            subject: string;
+            templateKey: string;
+            oIds: string[];
+            followUps: boolean;
+            heroImage?: string | null | undefined;
+        }>;
+        /** Each school's outcome: who it went to, or why it didn't. */
+        response: z.ZodObject<{
+            results: z.ZodRecord<z.ZodString, z.ZodObject<{
+                sent: z.ZodArray<z.ZodString, "many">;
+                error: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                sent: string[];
+                error?: string | undefined;
+            }, {
+                sent: string[];
+                error?: string | undefined;
+            }>>;
+        }, "strip", z.ZodTypeAny, {
+            results: Record<string, {
+                sent: string[];
+                error?: string | undefined;
+            }>;
+        }, {
+            results: Record<string, {
+                sent: string[];
+                error?: string | undefined;
+            }>;
+        }>;
+    };
+    /** One-off: removes the open renewal email tasks the old automatic schedule made. */
+    "bulkEngagement-clearRenewalEmailTasks": {
+        request: z.ZodOptional<z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>>;
+        response: z.ZodObject<{
+            cleared: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            cleared: number;
+        }, {
+            cleared: number;
+        }>;
+    };
+};

package/lib/callables/engagement.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.engagementCallables = void 0;
+const zod_1 = require("zod");
+const types_1 = require("./types");
+/**
+ * Contracts for bulk engagement emails (`Placementt-Backend/functions/src/bulkEngagement.ts`).
+ *
+ * An admin picks one admin email template and the schools to send it to (the
+ * backend suggests some; bulkEngagement.ts in core says which), and it goes
+ * now, through the same path as a single engagement email, so each send is
+ * an email interaction on the school. All of them are admin-only.
+ */
+const flag = zod_1.z.enum(["noContacts", "noRenewalDate", "noQuote", "noFinanceContact", "sentRecently"]);
+exports.engagementCallables = {
+    "bulkEngagement-getBulkEngagementSchools": {
+        request: zod_1.z.object({
+            /** An admin email template (product "admin" in emailTemplates). */
+            templateKey: zod_1.z.string().min(1),
+        }),
+        response: zod_1.z.object({
+            schools: zod_1.z.array(zod_1.z.object({
+                oId: zod_1.z.string(),
+                name: zod_1.z.string(),
+                package: zod_1.z.string(),
+                suggested: zod_1.z.boolean(),
+                reason: zod_1.z.string().optional(),
+                flags: zod_1.z.array(flag),
+                /** How many of the school's contacts it would go to. */
+                contacts: zod_1.z.number(),
+                /** ISO date this email last went to the school, if it has. */
+                lastSent: zod_1.z.string().optional(),
+                /** The school's params, for previewing the email as they'd get it. */
+                params: zod_1.z.record(zod_1.z.string(), zod_1.z.string()),
+            })),
+        }),
+    },
+    "bulkEngagement-sendBulkEngagementEmail": {
+        request: zod_1.z.object({
+            templateKey: zod_1.z.string().min(1),
+            oIds: zod_1.z.array(zod_1.z.string().min(1)).min(1, "Pick at least one school.").max(500),
+            subject: zod_1.z.string().trim().min(1, "Give it a subject."),
+            /** The Slate body, edited for this send. The template itself is unchanged. */
+            body: zod_1.z.array(zod_1.z.unknown()).min(1),
+            /** Must be in our storage bucket; checked on the server. */
+            heroImage: (0, types_1.optionalField)(zod_1.z.string()),
+            /** Send the weekly follow-ups: up to three, or until an onboarding step is done. */
+            followUps: zod_1.z.boolean(),
+        }),
+        /** Each school's outcome: who it went to, or why it didn't. */
+        response: zod_1.z.object({
+            results: zod_1.z.record(zod_1.z.string(), zod_1.z.object({ sent: zod_1.z.array(zod_1.z.string()), error: zod_1.z.string().optional() })),
+        }),
+    },
+    /** One-off: removes the open renewal email tasks the old automatic schedule made. */
+    "bulkEngagement-clearRenewalEmailTasks": {
+        request: zod_1.z.object({}).optional(),
+        response: zod_1.z.object({ cleared: zod_1.z.number() }),
+    },
+};
+//# sourceMappingURL=engagement.js.map

package/lib/callables/engagement.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"engagement.js","sourceRoot":"","sources":["../../src/callables/engagement.ts"],"names":[],"mappings":";;;AAAA,6BAAsB;AACtB,mCAAqD;AAErD;;;;;;;GAOG;AAEH,MAAM,IAAI,GAAG,OAAC,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,eAAe,EAAE,SAAS,EAAE,kBAAkB,EAAE,cAAc,CAAC,CAAC,CAAC;AAEvF,QAAA,mBAAmB,GAAG;IAC/B,yCAAyC,EAAE;QACvC,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC;YACd,mEAAmE;YACnE,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;SACjC,CAAC;QACF,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC;YACf,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,CAAC;gBACtB,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE;gBACf,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;gBAChB,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE;gBACnB,SAAS,EAAE,OAAC,CAAC,OAAO,EAAE;gBACtB,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;gBAC7B,KAAK,EAAE,OAAC,CAAC,KAAK,CAAC,IAAI,CAAC;gBACpB,wDAAwD;gBACxD,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE;gBACpB,8DAA8D;gBAC9D,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;gBAC/B,sEAAsE;gBACtE,MAAM,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC;aAC3C,CAAC,CAAC;SACN,CAAC;KACL;IACD,wCAAwC,EAAE;QACtC,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC;YACd,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;YAC9B,IAAI,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,2BAA2B,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;YAC7E,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,oBAAoB,CAAC;YACvD,8EAA8E;YAC9E,IAAI,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YACjC,4DAA4D;YAC5D,SAAS,EAAE,IAAA,qBAAa,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC;YACpC,oFAAoF;YACpF,SAAS,EAAE,OAAC,CAAC,OAAO,EAAE;SACzB,CAAC;QACF,+DAA+D;QAC/D,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC;YACf,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,MAAM,CAAC,EAAC,IAAI,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAC,CAAC,CAAC;SACrG,CAAC;KACL;IACD,qFAAqF;IACrF,uCAAuC,EAAE;QACrC,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;QAChC,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC,EAAC,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,EAAC,CAAC;KAC5C;CACoB,CAAC"}

package/lib/callables/index.d.ts

@@ -16,3 +16,4 @@ export * from "./userManagement";
 export * from "./outreach";
 export * from "./formImport";
 export * from "./activities";
+export * from "./engagement";

package/lib/callables/index.js

@@ -32,4 +32,5 @@ __exportStar(require("./userManagement"), exports);
 __exportStar(require("./outreach"), exports);
 __exportStar(require("./formImport"), exports);
 __exportStar(require("./activities"), exports);
+__exportStar(require("./engagement"), 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;AAClC,wCAAsB;AACtB,0CAAwB;AACxB,4CAA0B;AAC1B,mDAAiC;AACjC,6CAA2B;AAC3B,+CAA6B;AAC7B,+CAA6B"}
+{"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;AACtB,0CAAwB;AACxB,4CAA0B;AAC1B,mDAAiC;AACjC,6CAA2B;AAC3B,+CAA6B;AAC7B,+CAA6B;AAC7B,+CAA6B"}