placementt-core 1.400.877 → 1.400.878

package/lib/customerCareConfig.d.ts

@@ -0,0 +1,45 @@
+export type PhoneCheckInRule = {
+    intervalDays: number;
+    label: string;
+};
+export type SeasonalTaskConfig = {
+    id: string;
+    name: string;
+    deadlineMMDD: string;
+    createAtMMDD: string;
+    description: string;
+};
+export type BlackoutPeriod = {
+    start: string;
+    end: string;
+    label: string;
+};
+export type ChecklistItemStatus = "waiting" | "packed" | "shipped";
+export type ChecklistItem = {
+    oId: string;
+    name: string;
+    status: ChecklistItemStatus;
+};
+export type PhoneCheckInCategory = "careersHub" | "trust" | "workExperience" | "employerEvents" | null;
+export type CustomerCareConfig = {
+    seasonalTasks: SeasonalTaskConfig[];
+    phoneCheckIn: {
+        careersHub: PhoneCheckInRule;
+        trust: PhoneCheckInRule;
+        workExperience: PhoneCheckInRule;
+        employerEvents: PhoneCheckInRule;
+    };
+    blackoutPeriods: BlackoutPeriod[];
+};
+export declare const customerCareConfig: CustomerCareConfig;
+export declare function resolveSeasonalDates(cfg: SeasonalTaskConfig): {
+    createAt: Date;
+    deadline: Date;
+    taskTag: string;
+};
+export declare function isInBlackout(date: Date, blackouts: BlackoutPeriod[]): BlackoutPeriod | null;
+export declare function getCheckInCategory(ins: {
+    package: string;
+    workExperience?: boolean;
+    employerEvents?: boolean;
+}): PhoneCheckInCategory;

package/lib/customerCareConfig.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.customerCareConfig = void 0;
+exports.resolveSeasonalDates = resolveSeasonalDates;
+exports.isInBlackout = isInBlackout;
+exports.getCheckInCategory = getCheckInCategory;
+exports.customerCareConfig = {
+    seasonalTasks: [
+        {
+            id: "christmasCards",
+            name: "Christmas Cards",
+            deadlineMMDD: "12-12",
+            createAtMMDD: "11-28",
+            description: "Send Christmas cards to admin staff at every active school.",
+        },
+        {
+            // Easter moves ~1–2 weeks each year; update createAtMMDD / deadlineMMDD as needed.
+            id: "easterEggs",
+            name: "Easter Eggs",
+            deadlineMMDD: "03-27",
+            createAtMMDD: "03-09",
+            description: "Send Easter eggs to admin staff at every active school.",
+        },
+    ],
+    phoneCheckIn: {
+        careersHub: { intervalDays: 42, label: "Careers Hub" },
+        trust: { intervalDays: 56, label: "Trust" },
+        workExperience: { intervalDays: 56, label: "Work Experience" },
+        employerEvents: { intervalDays: 70, label: "Employer Events" },
+    },
+    // UK school term blackout periods (MM-DD, approximate national averages)
+    blackoutPeriods: [
+        { start: "07-18", end: "09-01", label: "Summer holidays" },
+        { start: "10-20", end: "10-31", label: "October half-term" },
+        { start: "12-22", end: "01-05", label: "Christmas holidays" },
+        { start: "02-16", end: "02-20", label: "February half-term" },
+        // Easter window – adjust if Easter falls unusually early or late
+        { start: "03-28", end: "04-14", label: "Easter holidays" },
+        { start: "05-25", end: "05-29", label: "May half-term" },
+    ],
+};
+function mmddToDate(mmdd, year) {
+    const [month, day] = mmdd.split("-").map(Number);
+    return new Date(year, month - 1, day);
+}
+function resolveSeasonalDates(cfg) {
+    const now = new Date();
+    const year = now.getFullYear();
+    let createAt = mmddToDate(cfg.createAtMMDD, year);
+    let deadline = mmddToDate(cfg.deadlineMMDD, year);
+    // If we're already past this year's deadline, resolve to next year
+    if (now > deadline) {
+        createAt = mmddToDate(cfg.createAtMMDD, year + 1);
+        deadline = mmddToDate(cfg.deadlineMMDD, year + 1);
+        return { createAt, deadline, taskTag: `${cfg.id}_${year + 1}` };
+    }
+    return { createAt, deadline, taskTag: `${cfg.id}_${year}` };
+}
+function isInBlackout(date, blackouts) {
+    const month = date.getMonth() + 1;
+    const day = date.getDate();
+    const mmdd = `${String(month).padStart(2, "0")}-${String(day).padStart(2, "0")}`;
+    for (const b of blackouts) {
+        if (b.start <= b.end) {
+            if (mmdd >= b.start && mmdd <= b.end)
+                return b;
+        }
+        else {
+            // Wraps year boundary (e.g. 12-22 to 01-05)
+            if (mmdd >= b.start || mmdd <= b.end)
+                return b;
+        }
+    }
+    return null;
+}
+function getCheckInCategory(ins) {
+    if (ins.package === "careersHub")
+        return "careersHub";
+    if (ins.package === "institutes-two")
+        return "trust";
+    if (ins.package === "institutes-one" && ins.workExperience)
+        return "workExperience";
+    if (ins.package === "institutes-one" && ins.employerEvents)
+        return "employerEvents";
+    return null;
+}
+//# sourceMappingURL=customerCareConfig.js.map

package/lib/customerCareConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"customerCareConfig.js","sourceRoot":"","sources":["../src/customerCareConfig.ts"],"names":[],"mappings":";;;AAmFA,oDAeC;AAED,oCAcC;AAED,gDAMC;AAhFY,QAAA,kBAAkB,GAAuB;IAClD,aAAa,EAAE;QACX;YACI,EAAE,EAAE,gBAAgB;YACpB,IAAI,EAAE,iBAAiB;YACvB,YAAY,EAAE,OAAO;YACrB,YAAY,EAAE,OAAO;YACrB,WAAW,EAAE,6DAA6D;SAC7E;QACD;YACI,mFAAmF;YACnF,EAAE,EAAE,YAAY;YAChB,IAAI,EAAE,aAAa;YACnB,YAAY,EAAE,OAAO;YACrB,YAAY,EAAE,OAAO;YACrB,WAAW,EAAE,yDAAyD;SACzE;KACJ;IACD,YAAY,EAAE;QACV,UAAU,EAAE,EAAC,YAAY,EAAE,EAAE,EAAE,KAAK,EAAE,aAAa,EAAC;QACpD,KAAK,EAAE,EAAC,YAAY,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAC;QACzC,cAAc,EAAE,EAAC,YAAY,EAAE,EAAE,EAAE,KAAK,EAAE,iBAAiB,EAAC;QAC5D,cAAc,EAAE,EAAC,YAAY,EAAE,EAAE,EAAE,KAAK,EAAE,iBAAiB,EAAC;KAC/D;IACD,yEAAyE;IACzE,eAAe,EAAE;QACb,EAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,iBAAiB,EAAC;QACxD,EAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,mBAAmB,EAAC;QAC1D,EAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,oBAAoB,EAAC;QAC3D,EAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,oBAAoB,EAAC;QAC3D,iEAAiE;QACjE,EAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,iBAAiB,EAAC;QACxD,EAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,eAAe,EAAC;KACzD;CACJ,CAAC;AAEF,SAAS,UAAU,CAAC,IAAY,EAAE,IAAY;IAC1C,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACjD,OAAO,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;AAC1C,CAAC;AAED,SAAgB,oBAAoB,CAAC,GAAuB;IACxD,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;IACvB,MAAM,IAAI,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC;IAE/B,IAAI,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;IAClD,IAAI,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;IAElD,mEAAmE;IACnE,IAAI,GAAG,GAAG,QAAQ,EAAE,CAAC;QACjB,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC,YAAY,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC;QAClD,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC,YAAY,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC;QAClD,OAAO,EAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,GAAG,CAAC,EAAE,IAAI,IAAI,GAAG,CAAC,EAAE,EAAC,CAAC;IAClE,CAAC;IAED,OAAO,EAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,GAAG,CAAC,EAAE,IAAI,IAAI,EAAE,EAAC,CAAC;AAC9D,CAAC;AAED,SAAgB,YAAY,CAAC,IAAU,EAAE,SAA2B;IAChE,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;IAClC,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;IAC3B,MAAM,IAAI,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC;IAEjF,KAAK,MAAM,CAAC,IAAI,SAAS,EAAE,CAAC;QACxB,IAAI,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,GAAG,EAAE,CAAC;YACnB,IAAI,IAAI,IAAI,CAAC,CAAC,KAAK,IAAI,IAAI,IAAI,CAAC,CAAC,GAAG;gBAAE,OAAO,CAAC,CAAC;QACnD,CAAC;aAAM,CAAC;YACJ,4CAA4C;YAC5C,IAAI,IAAI,IAAI,CAAC,CAAC,KAAK,IAAI,IAAI,IAAI,CAAC,CAAC,GAAG;gBAAE,OAAO,CAAC,CAAC;QACnD,CAAC;IACL,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,SAAgB,kBAAkB,CAAC,GAA0E;IACzG,IAAI,GAAG,CAAC,OAAO,KAAK,YAAY;QAAE,OAAO,YAAY,CAAC;IACtD,IAAI,GAAG,CAAC,OAAO,KAAK,gBAAgB;QAAE,OAAO,OAAO,CAAC;IACrD,IAAI,GAAG,CAAC,OAAO,KAAK,gBAAgB,IAAI,GAAG,CAAC,cAAc;QAAE,OAAO,gBAAgB,CAAC;IACpF,IAAI,GAAG,CAAC,OAAO,KAAK,gBAAgB,IAAI,GAAG,CAAC,cAAc;QAAE,OAAO,gBAAgB,CAAC;IACpF,OAAO,IAAI,CAAC;AAChB,CAAC"}

package/lib/index.d.ts

@@ -3,6 +3,7 @@ export * from "./firebase/callableJobContext";
 export * from "./firebase/readDatabase";
 export * from "./firebase/writeDatabase";
 export * from "./firebase/util";
+export * from "./customerCareConfig";
 export * from "./firebase/firebaseConfig";
 export * from "./firebase/firebaseQuery";
 export * from "./typeDefinitions";

package/lib/index.js

@@ -23,6 +23,7 @@ __exportStar(require("./firebase/callableJobContext"), exports);
 __exportStar(require("./firebase/readDatabase"), exports);
 __exportStar(require("./firebase/writeDatabase"), exports);
 __exportStar(require("./firebase/util"), exports);
+__exportStar(require("./customerCareConfig"), exports);
 __exportStar(require("./firebase/firebaseConfig"), exports);
 __exportStar(require("./firebase/firebaseQuery"), exports);
 __exportStar(require("./typeDefinitions"), exports);

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AACA,sDAAoC;AACpC,gEAA8C;AAC9C,0DAAwC;AACxC,2DAAyC;AACzC,kDAAgC;AAChC,4DAA0C;AAC1C,2DAAyC;AAEzC,oDAAkC;AAClC,kDAAgC;AAChC,uDAAqC;AACrC,iDAA+B;AAC/B,8CAA4B;AAC5B,0CAAwB;AACxB,yCAAuB;AACvB,4DAA0C;AAC1C,kDAAgC;AAChC,iDAA+B;AAC/B,2CAAyB;AACzB,4DAA0C;AAC1C,oEAAiD;AACjD,yEAAuD;AACvD,kEAAgD;AAChD,kEAAgD;AAChD,oEAAkD;AAClD,yGAAuF;AACvF,0GAAwF;AACxF,+FAA6E;AAC7E,4DAA0C;AAC1C,oEAAkD;AAClD,gEAA8C;AAC9C,2EAAyD;AACzD,6CAA2B;AAC3B,+CAA6B;AAC7B,6DAAuE;AAA9D,2IAAA,OAAO,OAAuB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AACA,sDAAoC;AACpC,gEAA8C;AAC9C,0DAAwC;AACxC,2DAAyC;AACzC,kDAAgC;AAChC,uDAAqC;AACrC,4DAA0C;AAC1C,2DAAyC;AAEzC,oDAAkC;AAClC,kDAAgC;AAChC,uDAAqC;AACrC,iDAA+B;AAC/B,8CAA4B;AAC5B,0CAAwB;AACxB,yCAAuB;AACvB,4DAA0C;AAC1C,kDAAgC;AAChC,iDAA+B;AAC/B,2CAAyB;AACzB,4DAA0C;AAC1C,oEAAiD;AACjD,yEAAuD;AACvD,kEAAgD;AAChD,kEAAgD;AAChD,oEAAkD;AAClD,yGAAuF;AACvF,0GAAwF;AACxF,+FAA6E;AAC7E,4DAA0C;AAC1C,oEAAkD;AAClD,gEAA8C;AAC9C,2EAAyD;AACzD,6CAA2B;AAC3B,+CAA6B;AAC7B,6DAAuE;AAA9D,2IAAA,OAAO,OAAuB"}

package/lib/typeDefinitions.d.ts

@@ -1,6 +1,7 @@
 import { DocumentData, DocumentReference, OrderByDirection, Timestamp, WhereFilterOp } from "firebase/firestore";
 import { Descendant } from "slate";
 import { emailTemplates, skillLabelColours } from "./constants";
+import type { ChecklistItem } from "./customerCareConfig";
 export type FilterObject = {
     [key: string]: {
         label: string;
@@ -2453,9 +2454,9 @@ export type Communication = {
     lastMessageDirection?: "inbound" | "outbound";
 };
 export type SupportTask = {
-    uid: string;
+    uid?: string;
     oId?: string;
-    email: string;
+    email?: string;
     title: string;
     description?: string;
     createdAt: string;
@@ -2464,10 +2465,12 @@ export type SupportTask = {
     assignee: string;
     commId?: string;
     commType?: "leads" | "users";
-    source?: "customerQuery" | "general";
+    source?: "customerQuery" | "general" | "seasonalTask";
     dueAt: string;
-    inbox: SupportInbox;
+    inbox?: SupportInbox;
     messageId?: string;
+    checklist?: ChecklistItem[];
+    taskTag?: string;
 };
 export type SupportInbox = "oneDay" | "threeDay" | "oneWeek";
 export type CustomerProductType = "careersHub" | "careersHubSchool" | "workExperience" | "trust" | "employerEvents";

package/package.json

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

package/src/customerCareConfig.ts

@@ -0,0 +1,123 @@
+export type PhoneCheckInRule = {
+    intervalDays: number;
+    label: string;
+};
+
+// Dates stored as "MM-DD" and resolved against the current (or next) year at runtime.
+// Easter moves each year; the approximate fixed date can be updated as needed.
+export type SeasonalTaskConfig = {
+    id: string; // e.g. "christmasCards" – year is appended at runtime
+    name: string; // e.g. "Christmas Cards"
+    deadlineMMDD: string; // "MM-DD" – must be sent by this date
+    createAtMMDD: string; // "MM-DD" – when the task becomes actionable
+    description: string;
+};
+
+export type BlackoutPeriod = {
+    start: string; // "MM-DD"
+    end: string; // "MM-DD" (wraps into next year if start > end, e.g. Dec–Jan)
+    label: string;
+};
+
+export type ChecklistItemStatus = "waiting" | "packed" | "shipped";
+
+export type ChecklistItem = {
+    oId: string;
+    name: string;
+    status: ChecklistItemStatus;
+};
+
+export type PhoneCheckInCategory = "careersHub" | "trust" | "workExperience" | "employerEvents" | null;
+
+export type CustomerCareConfig = {
+    seasonalTasks: SeasonalTaskConfig[];
+    phoneCheckIn: {
+        careersHub: PhoneCheckInRule;
+        trust: PhoneCheckInRule;
+        workExperience: PhoneCheckInRule;
+        employerEvents: PhoneCheckInRule;
+    };
+    blackoutPeriods: BlackoutPeriod[];
+};
+
+export const customerCareConfig: CustomerCareConfig = {
+    seasonalTasks: [
+        {
+            id: "christmasCards",
+            name: "Christmas Cards",
+            deadlineMMDD: "12-12",
+            createAtMMDD: "11-28",
+            description: "Send Christmas cards to admin staff at every active school.",
+        },
+        {
+            // Easter moves ~1–2 weeks each year; update createAtMMDD / deadlineMMDD as needed.
+            id: "easterEggs",
+            name: "Easter Eggs",
+            deadlineMMDD: "03-27",
+            createAtMMDD: "03-09",
+            description: "Send Easter eggs to admin staff at every active school.",
+        },
+    ],
+    phoneCheckIn: {
+        careersHub: {intervalDays: 42, label: "Careers Hub"},
+        trust: {intervalDays: 56, label: "Trust"},
+        workExperience: {intervalDays: 56, label: "Work Experience"},
+        employerEvents: {intervalDays: 70, label: "Employer Events"},
+    },
+    // UK school term blackout periods (MM-DD, approximate national averages)
+    blackoutPeriods: [
+        {start: "07-18", end: "09-01", label: "Summer holidays"},
+        {start: "10-20", end: "10-31", label: "October half-term"},
+        {start: "12-22", end: "01-05", label: "Christmas holidays"},
+        {start: "02-16", end: "02-20", label: "February half-term"},
+        // Easter window – adjust if Easter falls unusually early or late
+        {start: "03-28", end: "04-14", label: "Easter holidays"},
+        {start: "05-25", end: "05-29", label: "May half-term"},
+    ],
+};
+
+function mmddToDate(mmdd: string, year: number): Date {
+    const [month, day] = mmdd.split("-").map(Number);
+    return new Date(year, month - 1, day);
+}
+
+export function resolveSeasonalDates(cfg: SeasonalTaskConfig): {createAt: Date; deadline: Date; taskTag: string} {
+    const now = new Date();
+    const year = now.getFullYear();
+
+    let createAt = mmddToDate(cfg.createAtMMDD, year);
+    let deadline = mmddToDate(cfg.deadlineMMDD, year);
+
+    // If we're already past this year's deadline, resolve to next year
+    if (now > deadline) {
+        createAt = mmddToDate(cfg.createAtMMDD, year + 1);
+        deadline = mmddToDate(cfg.deadlineMMDD, year + 1);
+        return {createAt, deadline, taskTag: `${cfg.id}_${year + 1}`};
+    }
+
+    return {createAt, deadline, taskTag: `${cfg.id}_${year}`};
+}
+
+export function isInBlackout(date: Date, blackouts: BlackoutPeriod[]): BlackoutPeriod | null {
+    const month = date.getMonth() + 1;
+    const day = date.getDate();
+    const mmdd = `${String(month).padStart(2, "0")}-${String(day).padStart(2, "0")}`;
+
+    for (const b of blackouts) {
+        if (b.start <= b.end) {
+            if (mmdd >= b.start && mmdd <= b.end) return b;
+        } else {
+            // Wraps year boundary (e.g. 12-22 to 01-05)
+            if (mmdd >= b.start || mmdd <= b.end) return b;
+        }
+    }
+    return null;
+}
+
+export function getCheckInCategory(ins: {package: string; workExperience?: boolean; employerEvents?: boolean}): PhoneCheckInCategory {
+    if (ins.package === "careersHub") return "careersHub";
+    if (ins.package === "institutes-two") return "trust";
+    if (ins.package === "institutes-one" && ins.workExperience) return "workExperience";
+    if (ins.package === "institutes-one" && ins.employerEvents) return "employerEvents";
+    return null;
+}

package/src/index.ts

@@ -4,6 +4,7 @@ export * from "./firebase/callableJobContext";
 export * from "./firebase/readDatabase";
 export * from "./firebase/writeDatabase";
 export * from "./firebase/util";
+export * from "./customerCareConfig";
 export * from "./firebase/firebaseConfig";
 export * from "./firebase/firebaseQuery";
 

package/src/typeDefinitions.ts

@@ -1,6 +1,7 @@
 import {DocumentData, DocumentReference, OrderByDirection, Timestamp, WhereFilterOp} from "firebase/firestore";
 import {Descendant} from "slate";
 import {emailTemplates, skillLabelColours} from "./constants";
+import type {ChecklistItem} from "./customerCareConfig";
 
 export type FilterObject = {
     [key: string]: {
@@ -2391,9 +2392,9 @@ export type Communication = {
 };
 
 export type SupportTask = {
-    uid: string;            // user ID the task relates to
+    uid?: string;           // user ID the task relates to (absent for non-user tasks)
     oId?: string;           // organisation ID, if the user has one
-    email: string;          // email address associated with the task
+    email?: string;         // email address associated with the task (absent for non-user tasks)
     title: string;
     description?: string;
     createdAt: string;      // ISO string
@@ -2402,10 +2403,12 @@ export type SupportTask = {
     assignee: string;       // uid of the assigned team member
     commId?: string;        // optional link to a Communication doc
     commType?: "leads" | "users"; // collection the comm lives in
-    source?: "customerQuery" | "general";
+    source?: "customerQuery" | "general" | "seasonalTask";
     dueAt: string; // ISO string
-    inbox: SupportInbox; // which task inbox triggered this
+    inbox?: SupportInbox; // which task inbox triggered this (absent for non-email tasks)
     messageId?: string; // Graph message ID — used to prevent duplicates
+    checklist?: ChecklistItem[]; // school checklist for seasonalTask
+    taskTag?: string; // deduplication key, e.g. "christmasCards_2026"
 };
 
 export type SupportInbox = "oneDay" | "threeDay" | "oneWeek";