placementt-core 1.400.1126 → 1.400.1128

package/lib/callables/__tests__/outreach.test.d.ts

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

package/lib/callables/__tests__/outreach.test.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const outreach_1 = require("../outreach");
+/** One valid request and response per outreach contract, so a schema change that
+ * breaks the web or backend payload fails here first. */
+const samples = {
+    "outreach-upsertContacts": {
+        request: { rows: [{ urn: "100000", affiliation: "Test School", email: "head@test.sch.uk" }], dryRun: true },
+        response: { added: 1, updated: 0, keptStatus: 0, noEmail: 0, invalidEmail: 0, duplicateEmailInUpload: 0, skipped: [{ row: 2, reason: "No URN" }] },
+    },
+    "outreach-setStatus": {
+        request: { urn: 100000, status: "deferred", deferUntil: "2027-09-28", reason: "Next year" },
+        response: { urn: 100000, status: "deferred", brevoSynced: true, affectedUrns: [100000] },
+    },
+    "outreach-convertToLead": {
+        request: { urn: 100000, lead: { forename: "Jo", surname: "Bloggs", email: "jo@test.sch.uk", organisation: "Test School", assignee: "uid1" } },
+        response: { leadId: "lead1" },
+    },
+    "outreach-getBrevoContact": {
+        request: { urn: 100000 },
+        response: { found: true, contactId: 12, listIds: [3], emailBlacklisted: false, attributes: { URN: 100000 }, brevoUrl: "https://app.brevo.com/contact/index/12" },
+    },
+    "outreach-setupBrevo": {
+        request: {},
+        response: { marketingListId: 3, customersListId: 80, webhookId: 5, attributesCreated: ["URN"] },
+    },
+    "outreach-migrateExisting": {
+        request: {},
+        response: { initialised: 10, linkedToLeads: 1, linkedToCustomers: 1, importedToBrevo: 8 },
+    },
+    "outreach-backfillFromBrevo": {
+        request: { batchSize: 400 },
+        response: { processed: 400, total: 1000, done: false, cursorUrn: 100400 },
+    },
+    "outreach-runSweep": {
+        request: { step: "reconcile" },
+        response: { undeferred: 0, campaignsSynced: 0, domainMatches: 0, attributesPushed: 0, reconcile: { marketingOnlyInBrevo: 0, missingFromBrevo: 0 } },
+    },
+};
+describe("outreach contracts", () => {
+    for (const [name, sample] of Object.entries(samples)) {
+        it(`parses a sample ${name}`, () => {
+            const contract = outreach_1.outreachCallables[name];
+            expect(contract.request.safeParse(sample.request).success).toBe(true);
+            expect(contract.response.safeParse(sample.response).success).toBe(true);
+        });
+    }
+    it("rejects a deferral date that is not YYYY-MM-DD", () => {
+        expect(outreach_1.outreachCallables["outreach-setStatus"].request
+            .safeParse({ urn: 1, status: "deferred", deferUntil: "28/09/2027" }).success).toBe(false);
+    });
+    it("rejects an empty upload", () => {
+        expect(outreach_1.outreachCallables["outreach-upsertContacts"].request.safeParse({ rows: [] }).success).toBe(false);
+    });
+});
+//# sourceMappingURL=outreach.test.js.map

package/lib/callables/__tests__/outreach.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"outreach.test.js","sourceRoot":"","sources":["../../../src/callables/__tests__/outreach.test.ts"],"names":[],"mappings":";;AAAA,0CAA8C;AAE9C;yDACyD;AACzD,MAAM,OAAO,GAAmF;IAC5F,yBAAyB,EAAE;QACvB,OAAO,EAAE,EAAC,IAAI,EAAE,CAAC,EAAC,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAE,aAAa,EAAE,KAAK,EAAE,kBAAkB,EAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAC;QACvG,QAAQ,EAAE,EAAC,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,sBAAsB,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAC,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAC,CAAC,EAAC;KACjJ;IACD,oBAAoB,EAAE;QAClB,OAAO,EAAE,EAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,EAAE,WAAW,EAAC;QACzF,QAAQ,EAAE,EAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC,MAAM,CAAC,EAAC;KACzF;IACD,wBAAwB,EAAE;QACtB,OAAO,EAAE,EAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,EAAC,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,gBAAgB,EAAE,YAAY,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,EAAC,EAAC;QACzI,QAAQ,EAAE,EAAC,MAAM,EAAE,OAAO,EAAC;KAC9B;IACD,0BAA0B,EAAE;QACxB,OAAO,EAAE,EAAC,GAAG,EAAE,MAAM,EAAC;QACtB,QAAQ,EAAE,EAAC,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,gBAAgB,EAAE,KAAK,EAAE,UAAU,EAAE,EAAC,GAAG,EAAE,MAAM,EAAC,EAAE,QAAQ,EAAE,wCAAwC,EAAC;KAC/J;IACD,qBAAqB,EAAE;QACnB,OAAO,EAAE,EAAE;QACX,QAAQ,EAAE,EAAC,eAAe,EAAE,CAAC,EAAE,eAAe,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE,iBAAiB,EAAE,CAAC,KAAK,CAAC,EAAC;KAChG;IACD,0BAA0B,EAAE;QACxB,OAAO,EAAE,EAAE;QACX,QAAQ,EAAE,EAAC,WAAW,EAAE,EAAE,EAAE,aAAa,EAAE,CAAC,EAAE,iBAAiB,EAAE,CAAC,EAAE,eAAe,EAAE,CAAC,EAAC;KAC1F;IACD,4BAA4B,EAAE;QAC1B,OAAO,EAAE,EAAC,SAAS,EAAE,GAAG,EAAC;QACzB,QAAQ,EAAE,EAAC,SAAS,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAC;KAC1E;IACD,mBAAmB,EAAE;QACjB,OAAO,EAAE,EAAC,IAAI,EAAE,WAAW,EAAC;QAC5B,QAAQ,EAAE,EAAC,UAAU,EAAE,CAAC,EAAE,eAAe,EAAE,CAAC,EAAE,aAAa,EAAE,CAAC,EAAE,gBAAgB,EAAE,CAAC,EAAE,SAAS,EAAE,EAAC,oBAAoB,EAAE,CAAC,EAAE,gBAAgB,EAAE,CAAC,EAAC,EAAC;KAClJ;CACJ,CAAC;AAEF,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAChC,KAAK,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QACnD,EAAE,CAAC,mBAAmB,IAAI,EAAE,EAAE,GAAG,EAAE;YAC/B,MAAM,QAAQ,GAAG,4BAAiB,CAAC,IAAsC,CAAC,CAAC;YAC3E,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACtE,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5E,CAAC,CAAC,CAAC;IACP,CAAC;IAED,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;QACtD,MAAM,CAAC,4BAAiB,CAAC,oBAAoB,CAAC,CAAC,OAAO;aACjD,SAAS,CAAC,EAAC,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,YAAY,EAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChG,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;QAC/B,MAAM,CAAC,4BAAiB,CAAC,yBAAyB,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,EAAC,IAAI,EAAE,EAAE,EAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC3G,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/lib/callables/events.d.ts

@@ -30,8 +30,8 @@ export declare const eventsCallables: {
             "address-line1"?: string | undefined;
             "address-line2"?: string | undefined;
             country?: string | undefined;
-            locality?: string | undefined;
             postal_code?: string | undefined;
+            locality?: string | undefined;
             geohash?: string | undefined;
         }, {
             id: string;
@@ -39,8 +39,8 @@ export declare const eventsCallables: {
             "address-line1"?: string | undefined;
             "address-line2"?: string | undefined;
             country?: string | undefined;
-            locality?: string | undefined;
             postal_code?: string | undefined;
+            locality?: string | undefined;
             geohash?: string | undefined;
         }>, "many">;
     };

package/lib/callables/index.d.ts

@@ -13,3 +13,4 @@ export * from "./e2e";
 export * from "./wonde";
 export * from "./misSync";
 export * from "./userManagement";
+export * from "./outreach";

package/lib/callables/index.js

@@ -29,4 +29,5 @@ __exportStar(require("./e2e"), exports);
 __exportStar(require("./wonde"), exports);
 __exportStar(require("./misSync"), exports);
 __exportStar(require("./userManagement"), exports);
+__exportStar(require("./outreach"), 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"}
+{"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"}

package/lib/callables/outreach.d.ts

@@ -0,0 +1,330 @@
+import { z } from "zod";
+export declare const outreachCallables: {
+    "outreach-upsertContacts": {
+        request: z.ZodObject<{
+            rows: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodString>>, "many">;
+            /** Count what would happen without writing to Firestore or Brevo. */
+            dryRun: z.ZodOptional<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            rows: Record<string, string | undefined>[];
+            dryRun?: boolean | undefined;
+        }, {
+            rows: Record<string, string | undefined>[];
+            dryRun?: boolean | undefined;
+        }>;
+        response: z.ZodObject<{
+            added: z.ZodNumber;
+            updated: z.ZodNumber;
+            /** Existing contacts not in the pool: data updated, status left alone. */
+            keptStatus: z.ZodNumber;
+            noEmail: z.ZodNumber;
+            invalidEmail: z.ZodNumber;
+            duplicateEmailInUpload: z.ZodNumber;
+            skipped: z.ZodArray<z.ZodObject<{
+                row: z.ZodNumber;
+                urn: z.ZodOptional<z.ZodString>;
+                reason: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                reason: string;
+                row: number;
+                urn?: string | undefined;
+            }, {
+                reason: string;
+                row: number;
+                urn?: string | undefined;
+            }>, "many">;
+            brevoProcessId: z.ZodOptional<z.ZodNumber>;
+            brevoError: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            skipped: {
+                reason: string;
+                row: number;
+                urn?: string | undefined;
+            }[];
+            added: number;
+            noEmail: number;
+            updated: number;
+            keptStatus: number;
+            invalidEmail: number;
+            duplicateEmailInUpload: number;
+            brevoProcessId?: number | undefined;
+            brevoError?: string | undefined;
+        }, {
+            skipped: {
+                reason: string;
+                row: number;
+                urn?: string | undefined;
+            }[];
+            added: number;
+            noEmail: number;
+            updated: number;
+            keptStatus: number;
+            invalidEmail: number;
+            duplicateEmailInUpload: number;
+            brevoProcessId?: number | undefined;
+            brevoError?: string | undefined;
+        }>;
+    };
+    "outreach-setStatus": {
+        request: z.ZodObject<{
+            urn: z.ZodNumber;
+            status: z.ZodEnum<["pool", "lead", "deferred", "customer", "doNotContact"]>;
+            reason: z.ZodOptional<z.ZodString>;
+            /** Required when status is deferred. */
+            deferUntil: z.ZodOptional<z.ZodString>;
+            /** Customer institute, when status is customer. */
+            oId: z.ZodOptional<z.ZodString>;
+            /** Lead to link, e.g. when confirming a domain match. */
+            leadId: z.ZodOptional<z.ZodString>;
+            /** Also apply to every URN in `outreach.sharedEmailUrns`. */
+            applyToSharedEmail: z.ZodOptional<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            status: "pool" | "lead" | "deferred" | "customer" | "doNotContact";
+            urn: number;
+            reason?: string | undefined;
+            oId?: string | undefined;
+            deferUntil?: string | undefined;
+            leadId?: string | undefined;
+            applyToSharedEmail?: boolean | undefined;
+        }, {
+            status: "pool" | "lead" | "deferred" | "customer" | "doNotContact";
+            urn: number;
+            reason?: string | undefined;
+            oId?: string | undefined;
+            deferUntil?: string | undefined;
+            leadId?: string | undefined;
+            applyToSharedEmail?: boolean | undefined;
+        }>;
+        response: z.ZodObject<{
+            urn: z.ZodNumber;
+            status: z.ZodEnum<["pool", "lead", "deferred", "customer", "doNotContact"]>;
+            brevoSynced: z.ZodBoolean;
+            affectedUrns: z.ZodArray<z.ZodNumber, "many">;
+        }, "strip", z.ZodTypeAny, {
+            status: "pool" | "lead" | "deferred" | "customer" | "doNotContact";
+            urn: number;
+            brevoSynced: boolean;
+            affectedUrns: number[];
+        }, {
+            status: "pool" | "lead" | "deferred" | "customer" | "doNotContact";
+            urn: number;
+            brevoSynced: boolean;
+            affectedUrns: number[];
+        }>;
+    };
+    "outreach-convertToLead": {
+        request: z.ZodObject<{
+            urn: z.ZodNumber;
+            lead: z.ZodObject<{
+                forename: z.ZodOptional<z.ZodString>;
+                surname: z.ZodOptional<z.ZodString>;
+                email: z.ZodString;
+                organisation: z.ZodString;
+                wex: z.ZodOptional<z.ZodBoolean>;
+                events: z.ZodOptional<z.ZodBoolean>;
+                docCheck: z.ZodOptional<z.ZodBoolean>;
+                assignee: z.ZodString;
+                personalNotes: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
+                generalNotes: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
+            }, "strip", z.ZodTypeAny, {
+                email: string;
+                organisation: string;
+                assignee: string;
+                wex?: boolean | undefined;
+                events?: boolean | undefined;
+                docCheck?: boolean | undefined;
+                forename?: string | undefined;
+                surname?: string | undefined;
+                personalNotes?: any[] | undefined;
+                generalNotes?: any[] | undefined;
+            }, {
+                email: string;
+                organisation: string;
+                assignee: string;
+                wex?: boolean | undefined;
+                events?: boolean | undefined;
+                docCheck?: boolean | undefined;
+                forename?: string | undefined;
+                surname?: string | undefined;
+                personalNotes?: any[] | undefined;
+                generalNotes?: any[] | undefined;
+            }>;
+        }, "strip", z.ZodTypeAny, {
+            lead: {
+                email: string;
+                organisation: string;
+                assignee: string;
+                wex?: boolean | undefined;
+                events?: boolean | undefined;
+                docCheck?: boolean | undefined;
+                forename?: string | undefined;
+                surname?: string | undefined;
+                personalNotes?: any[] | undefined;
+                generalNotes?: any[] | undefined;
+            };
+            urn: number;
+        }, {
+            lead: {
+                email: string;
+                organisation: string;
+                assignee: string;
+                wex?: boolean | undefined;
+                events?: boolean | undefined;
+                docCheck?: boolean | undefined;
+                forename?: string | undefined;
+                surname?: string | undefined;
+                personalNotes?: any[] | undefined;
+                generalNotes?: any[] | undefined;
+            };
+            urn: number;
+        }>;
+        response: z.ZodObject<{
+            leadId: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            leadId: string;
+        }, {
+            leadId: string;
+        }>;
+    };
+    "outreach-getBrevoContact": {
+        request: z.ZodObject<{
+            urn: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            urn: number;
+        }, {
+            urn: number;
+        }>;
+        response: z.ZodObject<{
+            found: z.ZodBoolean;
+            contactId: z.ZodOptional<z.ZodNumber>;
+            listIds: z.ZodArray<z.ZodNumber, "many">;
+            emailBlacklisted: z.ZodOptional<z.ZodBoolean>;
+            attributes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+            brevoUrl: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            found: boolean;
+            listIds: number[];
+            attributes?: Record<string, unknown> | undefined;
+            contactId?: number | undefined;
+            emailBlacklisted?: boolean | undefined;
+            brevoUrl?: string | undefined;
+        }, {
+            found: boolean;
+            listIds: number[];
+            attributes?: Record<string, unknown> | undefined;
+            contactId?: number | undefined;
+            emailBlacklisted?: boolean | undefined;
+            brevoUrl?: string | undefined;
+        }>;
+    };
+    "outreach-setupBrevo": {
+        request: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+        response: z.ZodObject<{
+            marketingListId: z.ZodNumber;
+            customersListId: z.ZodNumber;
+            webhookId: z.ZodNumber;
+            attributesCreated: z.ZodArray<z.ZodString, "many">;
+        }, "strip", z.ZodTypeAny, {
+            marketingListId: number;
+            customersListId: number;
+            webhookId: number;
+            attributesCreated: string[];
+        }, {
+            marketingListId: number;
+            customersListId: number;
+            webhookId: number;
+            attributesCreated: string[];
+        }>;
+    };
+    "outreach-migrateExisting": {
+        request: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+        response: z.ZodObject<{
+            initialised: z.ZodNumber;
+            linkedToLeads: z.ZodNumber;
+            linkedToCustomers: z.ZodNumber;
+            importedToBrevo: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            initialised: number;
+            linkedToLeads: number;
+            linkedToCustomers: number;
+            importedToBrevo: number;
+        }, {
+            initialised: number;
+            linkedToLeads: number;
+            linkedToCustomers: number;
+            importedToBrevo: number;
+        }>;
+    };
+    "outreach-backfillFromBrevo": {
+        request: z.ZodObject<{
+            batchSize: z.ZodOptional<z.ZodNumber>;
+            /** Restart from the first URN. */
+            reset: z.ZodOptional<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            reset?: boolean | undefined;
+            batchSize?: number | undefined;
+        }, {
+            reset?: boolean | undefined;
+            batchSize?: number | undefined;
+        }>;
+        response: z.ZodObject<{
+            processed: z.ZodNumber;
+            total: z.ZodNumber;
+            done: z.ZodBoolean;
+            cursorUrn: z.ZodOptional<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            total: number;
+            done: boolean;
+            processed: number;
+            cursorUrn?: number | undefined;
+        }, {
+            total: number;
+            done: boolean;
+            processed: number;
+            cursorUrn?: number | undefined;
+        }>;
+    };
+    "outreach-runSweep": {
+        request: z.ZodObject<{
+            step: z.ZodOptional<z.ZodEnum<["all", "deferrals", "campaigns", "domainMatch", "brevoAttributes", "reconcile"]>>;
+        }, "strip", z.ZodTypeAny, {
+            step?: "all" | "reconcile" | "deferrals" | "campaigns" | "domainMatch" | "brevoAttributes" | undefined;
+        }, {
+            step?: "all" | "reconcile" | "deferrals" | "campaigns" | "domainMatch" | "brevoAttributes" | undefined;
+        }>;
+        response: z.ZodObject<{
+            undeferred: z.ZodNumber;
+            campaignsSynced: z.ZodNumber;
+            domainMatches: z.ZodNumber;
+            attributesPushed: z.ZodNumber;
+            reconcile: z.ZodOptional<z.ZodObject<{
+                marketingOnlyInBrevo: z.ZodNumber;
+                missingFromBrevo: z.ZodNumber;
+            }, "strip", z.ZodTypeAny, {
+                marketingOnlyInBrevo: number;
+                missingFromBrevo: number;
+            }, {
+                marketingOnlyInBrevo: number;
+                missingFromBrevo: number;
+            }>>;
+        }, "strip", z.ZodTypeAny, {
+            undeferred: number;
+            campaignsSynced: number;
+            domainMatches: number;
+            attributesPushed: number;
+            reconcile?: {
+                marketingOnlyInBrevo: number;
+                missingFromBrevo: number;
+            } | undefined;
+        }, {
+            undeferred: number;
+            campaignsSynced: number;
+            domainMatches: number;
+            attributesPushed: number;
+            reconcile?: {
+                marketingOnlyInBrevo: number;
+                missingFromBrevo: number;
+            } | undefined;
+        }>;
+    };
+};

package/lib/callables/outreach.js

@@ -0,0 +1,133 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.outreachCallables = void 0;
+const zod_1 = require("zod");
+/**
+ * Contracts for the outreach pipeline (`Placementt-Backend/functions/src/outreach`).
+ *
+ * `dfeSchoolContacts` is the single source of truth for who is in the outreach pool.
+ * Every write to `outreach` goes through these callables so Firestore and the Brevo
+ * lists never drift. All of them are admin-only.
+ */
+const outreachStatus = zod_1.z.enum(["pool", "lead", "deferred", "customer", "doNotContact"]);
+/** A pasted spreadsheet row keyed by DFE_CONTACT_UPLOAD_COLUMNS. Raw strings; the backend coerces. */
+const uploadRow = zod_1.z.record(zod_1.z.string(), zod_1.z.string().optional());
+const isoDate = zod_1.z.string().regex(/^\d{4}-\d{2}-\d{2}$/, "Use a YYYY-MM-DD date.");
+exports.outreachCallables = {
+    "outreach-upsertContacts": {
+        request: zod_1.z.object({
+            rows: zod_1.z.array(uploadRow).min(1).max(2000),
+            /** Count what would happen without writing to Firestore or Brevo. */
+            dryRun: zod_1.z.boolean().optional(),
+        }),
+        response: zod_1.z.object({
+            added: zod_1.z.number(),
+            updated: zod_1.z.number(),
+            /** Existing contacts not in the pool: data updated, status left alone. */
+            keptStatus: zod_1.z.number(),
+            noEmail: zod_1.z.number(),
+            invalidEmail: zod_1.z.number(),
+            duplicateEmailInUpload: zod_1.z.number(),
+            skipped: zod_1.z.array(zod_1.z.object({ row: zod_1.z.number(), urn: zod_1.z.string().optional(), reason: zod_1.z.string() })),
+            brevoProcessId: zod_1.z.number().optional(),
+            brevoError: zod_1.z.string().optional(),
+        }),
+    },
+    "outreach-setStatus": {
+        request: zod_1.z.object({
+            urn: zod_1.z.number(),
+            status: outreachStatus,
+            reason: zod_1.z.string().optional(),
+            /** Required when status is deferred. */
+            deferUntil: isoDate.optional(),
+            /** Customer institute, when status is customer. */
+            oId: zod_1.z.string().optional(),
+            /** Lead to link, e.g. when confirming a domain match. */
+            leadId: zod_1.z.string().optional(),
+            /** Also apply to every URN in `outreach.sharedEmailUrns`. */
+            applyToSharedEmail: zod_1.z.boolean().optional(),
+        }),
+        response: zod_1.z.object({
+            urn: zod_1.z.number(),
+            status: outreachStatus,
+            brevoSynced: zod_1.z.boolean(),
+            affectedUrns: zod_1.z.array(zod_1.z.number()),
+        }),
+    },
+    "outreach-convertToLead": {
+        request: zod_1.z.object({
+            urn: zod_1.z.number(),
+            lead: zod_1.z.object({
+                forename: zod_1.z.string().optional(),
+                surname: zod_1.z.string().optional(),
+                email: zod_1.z.string().email(),
+                organisation: zod_1.z.string(),
+                wex: zod_1.z.boolean().optional(),
+                events: zod_1.z.boolean().optional(),
+                docCheck: zod_1.z.boolean().optional(),
+                assignee: zod_1.z.string(),
+                personalNotes: zod_1.z.array(zod_1.z.any()).optional(),
+                generalNotes: zod_1.z.array(zod_1.z.any()).optional(),
+            }),
+        }),
+        response: zod_1.z.object({ leadId: zod_1.z.string() }),
+    },
+    "outreach-getBrevoContact": {
+        request: zod_1.z.object({ urn: zod_1.z.number() }),
+        response: zod_1.z.object({
+            found: zod_1.z.boolean(),
+            contactId: zod_1.z.number().optional(),
+            listIds: zod_1.z.array(zod_1.z.number()),
+            emailBlacklisted: zod_1.z.boolean().optional(),
+            attributes: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()).optional(),
+            brevoUrl: zod_1.z.string().optional(),
+        }),
+    },
+    "outreach-setupBrevo": {
+        request: zod_1.z.object({}),
+        response: zod_1.z.object({
+            marketingListId: zod_1.z.number(),
+            customersListId: zod_1.z.number(),
+            webhookId: zod_1.z.number(),
+            attributesCreated: zod_1.z.array(zod_1.z.string()),
+        }),
+    },
+    "outreach-migrateExisting": {
+        request: zod_1.z.object({}),
+        response: zod_1.z.object({
+            initialised: zod_1.z.number(),
+            linkedToLeads: zod_1.z.number(),
+            linkedToCustomers: zod_1.z.number(),
+            importedToBrevo: zod_1.z.number(),
+        }),
+    },
+    "outreach-backfillFromBrevo": {
+        request: zod_1.z.object({
+            batchSize: zod_1.z.number().int().min(1).max(400).optional(),
+            /** Restart from the first URN. */
+            reset: zod_1.z.boolean().optional(),
+        }),
+        response: zod_1.z.object({
+            processed: zod_1.z.number(),
+            total: zod_1.z.number(),
+            done: zod_1.z.boolean(),
+            cursorUrn: zod_1.z.number().optional(),
+        }),
+    },
+    "outreach-runSweep": {
+        request: zod_1.z.object({
+            step: zod_1.z.enum(["all", "deferrals", "campaigns", "domainMatch", "brevoAttributes", "reconcile"]).optional(),
+        }),
+        response: zod_1.z.object({
+            undeferred: zod_1.z.number(),
+            campaignsSynced: zod_1.z.number(),
+            domainMatches: zod_1.z.number(),
+            attributesPushed: zod_1.z.number(),
+            reconcile: zod_1.z.object({
+                marketingOnlyInBrevo: zod_1.z.number(),
+                missingFromBrevo: zod_1.z.number(),
+            }).optional(),
+        }),
+    },
+};
+//# sourceMappingURL=outreach.js.map

package/lib/callables/outreach.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"outreach.js","sourceRoot":"","sources":["../../src/callables/outreach.ts"],"names":[],"mappings":";;;AAAA,6BAAsB;AAGtB;;;;;;GAMG;AAEH,MAAM,cAAc,GAAG,OAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,cAAc,CAAC,CAAC,CAAC;AAExF,sGAAsG;AACtG,MAAM,SAAS,GAAG,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;AAE9D,MAAM,OAAO,GAAG,OAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,qBAAqB,EAAE,wBAAwB,CAAC,CAAC;AAErE,QAAA,iBAAiB,GAAG;IAC7B,yBAAyB,EAAE;QACvB,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC;YACd,IAAI,EAAE,OAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC;YACzC,qEAAqE;YACrE,MAAM,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;SACjC,CAAC;QACF,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC;YACf,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;YACjB,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE;YACnB,0EAA0E;YAC1E,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE;YACtB,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE;YACnB,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE;YACxB,sBAAsB,EAAE,OAAC,CAAC,MAAM,EAAE;YAClC,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,CAAC,EAAC,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,EAAE,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,EAAC,CAAC,CAAC;YAC7F,cAAc,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YACrC,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;SACpC,CAAC;KACL;IACD,oBAAoB,EAAE;QAClB,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC;YACd,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE;YACf,MAAM,EAAE,cAAc;YACtB,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YAC7B,wCAAwC;YACxC,UAAU,EAAE,OAAO,CAAC,QAAQ,EAAE;YAC9B,mDAAmD;YACnD,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YAC1B,yDAAyD;YACzD,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YAC7B,6DAA6D;YAC7D,kBAAkB,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;SAC7C,CAAC;QACF,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC;YACf,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE;YACf,MAAM,EAAE,cAAc;YACtB,WAAW,EAAE,OAAC,CAAC,OAAO,EAAE;YACxB,YAAY,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC;SACpC,CAAC;KACL;IACD,wBAAwB,EAAE;QACtB,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC;YACd,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE;YACf,IAAI,EAAE,OAAC,CAAC,MAAM,CAAC;gBACX,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;gBAC/B,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;gBAC9B,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE;gBACzB,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE;gBACxB,GAAG,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;gBAC3B,MAAM,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;gBAC9B,QAAQ,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;gBAChC,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE;gBACpB,aAAa,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE;gBAC1C,YAAY,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE;aAC5C,CAAC;SACL,CAAC;QACF,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC,EAAC,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,EAAC,CAAC;KAC3C;IACD,0BAA0B,EAAE;QACxB,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC,EAAC,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,EAAC,CAAC;QACpC,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC;YACf,KAAK,EAAE,OAAC,CAAC,OAAO,EAAE;YAClB,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YAChC,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC;YAC5B,gBAAgB,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;YACxC,UAAU,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;YACxD,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;SAClC,CAAC;KACL;IACD,qBAAqB,EAAE;QACnB,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC,EAAE,CAAC;QACrB,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC;YACf,eAAe,EAAE,OAAC,CAAC,MAAM,EAAE;YAC3B,eAAe,EAAE,OAAC,CAAC,MAAM,EAAE;YAC3B,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;YACrB,iBAAiB,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC;SACzC,CAAC;KACL;IACD,0BAA0B,EAAE;QACxB,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC,EAAE,CAAC;QACrB,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC;YACf,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE;YACvB,aAAa,EAAE,OAAC,CAAC,MAAM,EAAE;YACzB,iBAAiB,EAAE,OAAC,CAAC,MAAM,EAAE;YAC7B,eAAe,EAAE,OAAC,CAAC,MAAM,EAAE;SAC9B,CAAC;KACL;IACD,4BAA4B,EAAE;QAC1B,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC;YACd,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;YACtD,kCAAkC;YAClC,KAAK,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;SAChC,CAAC;QACF,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC;YACf,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;YACrB,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;YACjB,IAAI,EAAE,OAAC,CAAC,OAAO,EAAE;YACjB,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;SACnC,CAAC;KACL;IACD,mBAAmB,EAAE;QACjB,OAAO,EAAE,OAAC,CAAC,MAAM,CAAC;YACd,IAAI,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,aAAa,EAAE,iBAAiB,EAAE,WAAW,CAAC,CAAC,CAAC,QAAQ,EAAE;SAC5G,CAAC;QACF,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC;YACf,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE;YACtB,eAAe,EAAE,OAAC,CAAC,MAAM,EAAE;YAC3B,aAAa,EAAE,OAAC,CAAC,MAAM,EAAE;YACzB,gBAAgB,EAAE,OAAC,CAAC,MAAM,EAAE;YAC5B,SAAS,EAAE,OAAC,CAAC,MAAM,CAAC;gBAChB,oBAAoB,EAAE,OAAC,CAAC,MAAM,EAAE;gBAChC,gBAAgB,EAAE,OAAC,CAAC,MAAM,EAAE;aAC/B,CAAC,CAAC,QAAQ,EAAE;SAChB,CAAC;KACL;CACoB,CAAC"}