placementt-core 1.400.1237 → 1.400.1239

package/lib/constants.d.ts

@@ -1,4 +1,4 @@
-import { AnalyticsItem, ApplicantStage, OutreachDeliverability, OutreachStatus, CommSchema, CustomFormSchema, CustomFormSchemaField, EmailTemplateConfig, FlagCodes, ProductTag, LeadStageSchema, StudentActivity, StudentActivityCategory, StudentActivityType, SurveyDateRule, SurveyOrdinal, SurveyWeekday, WorkflowStage } from "./typeDefinitions";
+import { AnalyticsItem, ApplicantStage, OutreachDeliverability, OutreachStatus, CommSchema, CustomFormSchema, CustomFormSchemaField, EmailTemplateConfig, EmailTemplateProduct, FlagCodes, ProductTag, LeadStageSchema, StudentActivity, StudentActivityCategory, StudentActivityType, SurveyDateRule, SurveyOrdinal, SurveyWeekday, WorkflowStage } from "./typeDefinitions";
 import type { ResolvedProducts } from "./productResolver";
 export declare const providerCodes: {
     soleTrader: {
@@ -208,6 +208,9 @@ export declare function emailTemplateAvailable(templateKey: string | undefined,
 export declare const productTagLabels: {
     [k in ProductTag]: string;
 };
+export declare const emailTemplateProductLabels: {
+    [k in EmailTemplateProduct]: string;
+};
 export declare const emailTemplateExampleData: {
     [templateKey: string]: {
         [param: string]: string;

package/lib/constants.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.gatsbyBenchmarks = exports.externalActivityTypes = exports.MISQueryParams = exports.emailTemplateExampleData = exports.productTagLabels = exports.emailTemplates = exports.defaultApplicantWorkflow = exports.mobileCountryCodes = exports.ERROR_COLOR = exports.SUCCESS_COLOR = exports.WARNING_COLOR = exports.INFO_COLOR = exports.INFOBACKGROUNDCOLOR = exports.INFOTEXTCOLOR = exports.WARNINGBACKGROUNDCOLOR = exports.WARNINGTEXTCOLOR = exports.SUCCESSBACKGROUNDCOLOR = exports.SUCCESSTEXTCOLOR = exports.ERRORBACKGROUNDCOLOR = exports.ERRORTEXTCOLOR = exports.STUDENT_COLOUR = exports.PROVIDER_COLOUR = exports.INSTITUTE_COLOUR = exports.SECONDARY_COLOUR = exports.LOGO_TERTIARY_COLOUR = exports.LOGO_SECONDARY_COLOUR = exports.PRIMARY_COLOUR = exports.MICROSOFT_SSO_GUIDE_URL = exports.MICROSOFT_ISSUER_HOST = exports.MICROSOFT_AUTHORITY = exports.MICROSOFT_CLIENT_ID = exports.DEFAULT_ACTIVITY_REFLECTION_FORM = exports.studentActivityCategory = exports.ACTIVITY_SCHEMAS = exports.DEFAULT_ACTIVITY_DESCRIPTION = exports.ACTIVITY_TYPE_DESCRIPTION = exports.ACTIVITY_TYPE_ORGANISATION = exports.activityProfile = exports.ACTIVITY_TYPE_PROFILE = exports.ACTIVITY_PROFILES = exports.ACTIVITY_TYPE_TITLE = exports.ACTIVITY_TYPES_BY_CATEGORY = exports.STUDENT_ACTIVITY_CATEGORIES = exports.DEFAULT_ACTIVITY_REFLECTION_FORM_ID = exports.sampleTargets = exports.flagCodes = exports.defaultStudentWorkflow = exports.defaultInstituteWorkflow = exports.countryList = exports.providerCodes = void 0;
-exports.DFE_CONTACT_UPLOAD_COLUMNS = exports.OUTREACH_DEFAULT_DEFER_MONTHS = exports.outreachDeliverabilityLabels = exports.outreachStatusColours = exports.outreachStatusLabels = exports.outreachStatusOrder = exports.SCHEDULED_CHECK_REMINDER_LEAD_DAYS = exports.SCHEDULED_CHECK_MISSED_AFTER_DAYS = exports.STUDENT_YEAR_FIELD = exports.JOB_VALUES = exports.CAREER_INTEREST_CATEGORIES = exports.SIC_SECTIONS = exports.SOC_MAJOR_GROUPS = exports.DESTINATION_CODES = exports.careersHubSchoolOnboardingEmailTemplates = exports.emailCampaignFullStatuses = exports.emailCampaignSummaryStatuses = exports.leadStageOrder = exports.leadStageSchema = exports.commSchema = exports.DEFAULT_YEAR_GROUPS = exports.DEFAULT_SURVEY_RULE = exports.surveyRuleLabel = exports.SURVEY_MONTHS = exports.SURVEY_WEEKDAYS = exports.SURVEY_ORDINALS = exports.skillAssessmentSchedule = exports.skillLabelColours = exports.equalexLearningOutcomes = void 0;
+exports.externalActivityTypes = exports.MISQueryParams = exports.emailTemplateExampleData = exports.emailTemplateProductLabels = exports.productTagLabels = exports.emailTemplates = exports.defaultApplicantWorkflow = exports.mobileCountryCodes = exports.ERROR_COLOR = exports.SUCCESS_COLOR = exports.WARNING_COLOR = exports.INFO_COLOR = exports.INFOBACKGROUNDCOLOR = exports.INFOTEXTCOLOR = exports.WARNINGBACKGROUNDCOLOR = exports.WARNINGTEXTCOLOR = exports.SUCCESSBACKGROUNDCOLOR = exports.SUCCESSTEXTCOLOR = exports.ERRORBACKGROUNDCOLOR = exports.ERRORTEXTCOLOR = exports.STUDENT_COLOUR = exports.PROVIDER_COLOUR = exports.INSTITUTE_COLOUR = exports.SECONDARY_COLOUR = exports.LOGO_TERTIARY_COLOUR = exports.LOGO_SECONDARY_COLOUR = exports.PRIMARY_COLOUR = exports.MICROSOFT_SSO_GUIDE_URL = exports.MICROSOFT_ISSUER_HOST = exports.MICROSOFT_AUTHORITY = exports.MICROSOFT_CLIENT_ID = exports.DEFAULT_ACTIVITY_REFLECTION_FORM = exports.studentActivityCategory = exports.ACTIVITY_SCHEMAS = exports.DEFAULT_ACTIVITY_DESCRIPTION = exports.ACTIVITY_TYPE_DESCRIPTION = exports.ACTIVITY_TYPE_ORGANISATION = exports.activityProfile = exports.ACTIVITY_TYPE_PROFILE = exports.ACTIVITY_PROFILES = exports.ACTIVITY_TYPE_TITLE = exports.ACTIVITY_TYPES_BY_CATEGORY = exports.STUDENT_ACTIVITY_CATEGORIES = exports.DEFAULT_ACTIVITY_REFLECTION_FORM_ID = exports.sampleTargets = exports.flagCodes = exports.defaultStudentWorkflow = exports.defaultInstituteWorkflow = exports.countryList = exports.providerCodes = void 0;
+exports.DFE_CONTACT_UPLOAD_COLUMNS = exports.OUTREACH_DEFAULT_DEFER_MONTHS = exports.outreachDeliverabilityLabels = exports.outreachStatusColours = exports.outreachStatusLabels = exports.outreachStatusOrder = exports.SCHEDULED_CHECK_REMINDER_LEAD_DAYS = exports.SCHEDULED_CHECK_MISSED_AFTER_DAYS = exports.STUDENT_YEAR_FIELD = exports.JOB_VALUES = exports.CAREER_INTEREST_CATEGORIES = exports.SIC_SECTIONS = exports.SOC_MAJOR_GROUPS = exports.DESTINATION_CODES = exports.careersHubSchoolOnboardingEmailTemplates = exports.emailCampaignFullStatuses = exports.emailCampaignSummaryStatuses = exports.leadStageOrder = exports.leadStageSchema = exports.commSchema = exports.DEFAULT_YEAR_GROUPS = exports.DEFAULT_SURVEY_RULE = exports.surveyRuleLabel = exports.SURVEY_MONTHS = exports.SURVEY_WEEKDAYS = exports.SURVEY_ORDINALS = exports.skillAssessmentSchedule = exports.skillLabelColours = exports.equalexLearningOutcomes = exports.gatsbyBenchmarks = void 0;
 exports.productTagAvailable = productTagAvailable;
 exports.emailTemplateAvailable = emailTemplateAvailable;
 exports.skillColour = skillColour;
@@ -1172,6 +1172,7 @@ const placementRejectedParams = [...placementEmailParams, "reason"];
 // Emails to the cohort contact about the cohort as a whole.
 const staffCohortEmailParams = ["cohortName", "submissionDeadline", "daysUntilDeadline", "instituteName", "cohortContactForename", "cohortContactSurname", "cohortContactEmail"];
 // Cohort emails sent before a student has a placement.
+const engagementEmailParams = ["contactForename", "instituteName"];
 const cohortEmailParams = ["studentForename", "studentSurname", "studentEmail", "parentEmail", "submissionDeadline", "daysUntilDeadline", "cohortName", "instituteName", "cohortContactForename", "cohortContactSurname", "cohortContactEmail"];
 exports.emailTemplates = {
     studentSubmissionReminder: {
@@ -1639,6 +1640,250 @@ exports.emailTemplates = {
         type: "leaverChristmasInvite",
         button: { text: "Quick check-in", link: "/leaverCheckpoint/{{requestId}}/christmas/{{token}}" },
     },
+    // CareerThread's own onboarding and renewal emails to schools, sent by an admin from the institute's
+    // emails. product "admin" keeps them out of every school's template list.
+    engagementPickFeatures: {
+        product: "admin",
+        description: "First onboarding email: asks the school which parts of CareerThread they will use.",
+        params: [...engagementEmailParams],
+        button: { text: "Pick your features", link: "/institutes/home" },
+        type: "engagement",
+        name: "Pick your features",
+        recipient: "staff",
+        group: "Joining",
+    },
+    engagementPlanYear: {
+        product: "admin",
+        description: "Asks the school to drag each feature into the term they want to start it.",
+        params: [...engagementEmailParams],
+        button: { text: "Plan your year", link: "/institutes/organisation/overview" },
+        type: "engagement",
+        name: "Plan your year",
+        recipient: "staff",
+        group: "Joining",
+    },
+    engagementInviteStaff: {
+        product: "admin",
+        description: "Suggests inviting the rest of the careers team. Sent once, no reminders.",
+        params: [...engagementEmailParams],
+        button: { text: "Invite staff", link: "/institutes/organisation/staff" },
+        type: "engagement",
+        name: "Invite staff",
+        recipient: "staff",
+        group: "Joining",
+    },
+    engagementStudentRoute: {
+        product: "admin",
+        description: "Asks how the school will add students: Wonde, an MIS file or a spreadsheet.",
+        params: [...engagementEmailParams, "routeCode"],
+        optionalButtons: [
+            { text: "Connect through Wonde", link: "/students-route/{{routeCode}}?route=wonde" },
+            { text: "Send a file from our MIS", link: "/students-route/{{routeCode}}?route=mis" },
+            { text: "Upload a spreadsheet", link: "/students-route/{{routeCode}}?route=csv" },
+        ],
+        type: "engagement",
+        name: "Choose how to add students",
+        recipient: "staff",
+        group: "Students",
+    },
+    engagementWonde: {
+        product: "admin",
+        description: "Sent to the school and its IT contact once they choose Wonde.",
+        params: [...engagementEmailParams],
+        button: { text: "Data protection policy", link: "/data-protection-policy-july-2026.pdf" },
+        type: "engagement",
+        name: "Approve Wonde",
+        recipient: "staff",
+        group: "Students",
+    },
+    engagementMis: {
+        product: "admin",
+        description: "Sent to the school and its IT contact once they choose an MIS file transfer.",
+        params: [...engagementEmailParams],
+        button: { text: "Data protection policy", link: "/data-protection-policy-july-2026.pdf" },
+        type: "engagement",
+        name: "MIS file transfer",
+        recipient: "staff",
+        group: "Students",
+    },
+    engagementUploadStudents: {
+        product: "admin",
+        description: "Sent once the school chooses to upload a spreadsheet of students.",
+        params: [...engagementEmailParams],
+        button: { text: "Upload students", link: "/institutes/students" },
+        type: "engagement",
+        name: "Upload your students",
+        recipient: "staff",
+        group: "Students",
+    },
+    engagementWexGroups: {
+        product: "admin",
+        description: "Asks which year groups go on work experience, to set up a group for each.",
+        params: [...engagementEmailParams],
+        button: { text: "Set up a group", link: "/institutes/cohorts" },
+        secondaryButton: { text: "Pick a different term", link: "/plan/{{planCode}}" },
+        type: "engagement",
+        name: "Set up work experience groups",
+        recipient: "staff",
+        group: "Work experience",
+    },
+    engagementWexCohort: {
+        product: "admin",
+        description: "Each new year: asks the school to check this year's cohort dates and students.",
+        params: [...engagementEmailParams],
+        button: { text: "Check this year's cohort", link: "/institutes/cohorts" },
+        secondaryButton: { text: "Pick a different term", link: "/plan/{{planCode}}" },
+        type: "engagement",
+        name: "This year's cohort",
+        recipient: "staff",
+        group: "Work experience",
+    },
+    engagementWexWorkflow: {
+        product: "admin",
+        description: "Asks who signs off each placement, to build the workflow.",
+        params: [...engagementEmailParams],
+        button: { text: "Build the workflow", link: "/institutes/cohorts" },
+        secondaryButton: { text: "Pick a different term", link: "/plan/{{planCode}}" },
+        type: "engagement",
+        name: "Sign-off workflow",
+        recipient: "staff",
+        group: "Work experience",
+    },
+    engagementWexActivate: {
+        product: "admin",
+        description: "Asks the school to activate the students in their work experience group.",
+        params: [...engagementEmailParams],
+        button: { text: "Activate students", link: "/institutes/students" },
+        secondaryButton: { text: "Pick a different term", link: "/plan/{{planCode}}" },
+        type: "engagement",
+        name: "Activate students",
+        recipient: "staff",
+        group: "Work experience",
+    },
+    engagementWexPlacements: {
+        product: "admin",
+        description: "Suggests adding the first placement.",
+        params: [...engagementEmailParams],
+        button: { text: "Add a placement", link: "/institutes/cohorts" },
+        secondaryButton: { text: "Pick a different term", link: "/plan/{{planCode}}" },
+        type: "engagement",
+        name: "First placements",
+        recipient: "staff",
+        group: "Work experience",
+    },
+    engagementWexFeedback: {
+        product: "admin",
+        description: "Suggests turning on feedback at the end of each placement.",
+        params: [...engagementEmailParams],
+        button: { text: "Set up feedback", link: "/institutes/cohorts" },
+        secondaryButton: { text: "Pick a different term", link: "/plan/{{planCode}}" },
+        type: "engagement",
+        name: "Placement feedback",
+        recipient: "staff",
+        group: "Work experience",
+    },
+    engagementHubFirstEvent: {
+        product: "admin",
+        description: "Suggests a careers hub school requests its first employer event.",
+        params: [...engagementEmailParams, "hubName"],
+        button: { text: "Request an event", link: "/institutes/events" },
+        type: "engagement",
+        name: "Hub school first event",
+        recipient: "staff",
+        group: "Hub schools",
+    },
+    engagementReminderDay7: {
+        product: "admin",
+        description: "A week after any onboarding email, if the step still isn't done.",
+        params: [...engagementEmailParams, "featureName", "featureDescription", "featurePath"],
+        button: { text: "Get started", link: "/institutes{{featurePath}}" },
+        type: "engagement",
+        name: "Reminder: day 7",
+        recipient: "staff",
+        group: "Reminders",
+    },
+    engagementReminderDay7Plan: {
+        product: "admin",
+        description: "Day 7 reminder for a feature on the plan board, with a link to pick a different term.",
+        params: [...engagementEmailParams, "featureName", "featureDescription", "featurePath"],
+        button: { text: "Get started", link: "/institutes{{featurePath}}" },
+        secondaryButton: { text: "Pick a different term", link: "/plan/{{planCode}}" },
+        type: "engagement",
+        name: "Reminder: day 7 (plan feature)",
+        recipient: "staff",
+        group: "Reminders",
+    },
+    engagementReminderDay21: {
+        product: "admin",
+        description: "Three weeks after any onboarding email, if the step still isn't done. Offers a call.",
+        params: [...engagementEmailParams, "featureName", "featureSentence", "featurePath"],
+        button: { text: "Get started", link: "/institutes{{featurePath}}" },
+        type: "engagement",
+        name: "Reminder: day 21",
+        recipient: "staff",
+        group: "Reminders",
+    },
+    engagementReminderDay21Plan: {
+        product: "admin",
+        description: "Day 21 reminder for a feature on the plan board: do it now or pick a term.",
+        params: [...engagementEmailParams, "featureName", "featureSentence", "featurePath"],
+        button: { text: "Get started", link: "/institutes{{featurePath}}" },
+        secondaryButton: { text: "Pick a different term", link: "/plan/{{planCode}}" },
+        type: "engagement",
+        name: "Reminder: day 21 (plan feature)",
+        recipient: "staff",
+        group: "Reminders",
+    },
+    engagementRenewalPrice: {
+        product: "admin",
+        description: "Gives next year's price in time for the school's budget.",
+        params: [...engagementEmailParams, "renewalDate", "quote"],
+        button: { text: "See plan and invoices", link: "/institutes/organisation/billing" },
+        type: "engagement",
+        name: "Next year's price",
+        recipient: "staff",
+        group: "Renewals",
+    },
+    engagementRenewalReview: {
+        product: "admin",
+        description: "Before the summer: thanks the school and points to the impact report.",
+        params: [...engagementEmailParams],
+        button: { text: "Get your impact report", link: "/institutes/organisation/overview" },
+        type: "engagement",
+        name: "Year in review",
+        recipient: "staff",
+        group: "Renewals",
+    },
+    engagementRenewalDue: {
+        product: "admin",
+        description: "60 days before renewal: the date and next year's price.",
+        params: [...engagementEmailParams, "renewalDate", "quote"],
+        button: { text: "See your plan", link: "/institutes/organisation/billing" },
+        type: "engagement",
+        name: "60 days out",
+        recipient: "staff",
+        group: "Renewals",
+    },
+    engagementRenewalInvoice: {
+        product: "admin",
+        description: "Asks whether the renewal invoice needs a purchase order number.",
+        params: [...engagementEmailParams, "renewalDate", "quote"],
+        button: { text: "See your invoices", link: "/institutes/organisation/billing" },
+        type: "engagement",
+        name: "Invoice or PO",
+        recipient: "staff",
+        group: "Renewals",
+    },
+    engagementRenewalThanks: {
+        product: "admin",
+        description: "Sent once the school has renewed.",
+        params: [...engagementEmailParams],
+        button: { text: "Open CareerThread", link: "/institutes/home" },
+        type: "engagement",
+        name: "Thanks for renewing",
+        recipient: "staff",
+        group: "Renewals",
+    },
 };
 // Whether a resource tagged with a product belongs to a product this organisation has. Untagged, or no product info, shows.
 function productTagAvailable(tag, products) {
@@ -1656,7 +1901,11 @@ function emailTemplateAvailable(templateKey, products) {
     // A saved template whose key has since been removed from emailTemplates is never sent, so hide it.
     if (templateKey && !exports.emailTemplates[templateKey])
         return false;
-    return productTagAvailable(templateKey ? exports.emailTemplates[templateKey]?.product : undefined, products);
+    const product = templateKey ? exports.emailTemplates[templateKey].product : undefined;
+    // CareerThread's own emails: only when there's no product info, which is an admin looking.
+    if (product === "admin")
+        return !products;
+    return productTagAvailable(product, products);
 }
 exports.productTagLabels = {
     wex: "Work experience",
@@ -1670,6 +1919,10 @@ exports.productTagLabels = {
     alumni: "Alumni",
     hub: "Careers hub",
 };
+exports.emailTemplateProductLabels = {
+    ...exports.productTagLabels,
+    admin: "CareerThread admin",
+};
 // Example values for previewing email templates, so customers see a filled-in email
 // rather than {{placeholders}}. Shared values first, then per-template overrides where
 // the same param means something different.