placementt-core 1.400.1010 → 1.400.1013

package/lib/typeDefinitions.d.ts

@@ -114,11 +114,13 @@ export type StudentPlacementData = {
     insuranceExpiry?: string;
     insuranceSkippedReason?: string;
     riskAssessment?: boolean | "awaitingReview";
-    riskAssessmentType?: "file" | "form" | "skipped";
+    riskAssessmentType?: "file" | "form" | "skipped" | "customForm";
     riskAssessmentData?: {
         [key: string]: unknown;
     }[] | string;
     riskAssessmentCustomFields?: RiskAssessmentFieldDef[];
+    riskAssessmentFormId?: string;
+    riskAssessmentFormSchema?: CustomFormSchema;
     dbsCheck?: boolean | "awaitingReview";
     dbsCheckType?: "file" | "form" | "skipped";
     dbsCheckData?: {
@@ -280,11 +282,12 @@ export type PlacementListing = {
     mapConsent?: boolean;
     mapConsentDate?: string;
     uploadedBy: "student" | "institute" | "provider";
-    riskAssessmentType?: "file" | "form" | "skipped";
+    riskAssessmentType?: "file" | "form" | "skipped" | "customForm";
     concurrentPlacements?: number;
     riskAssessmentData?: {
         [key: string]: unknown;
     }[] | string;
+    riskAssessmentFormId?: string;
     dbsCheckType?: "file" | "form" | "skipped";
     dbsCheckData?: {
         [key: string]: unknown;
@@ -971,6 +974,12 @@ export type InstituteData = {
         employerSharingScope: "membership" | "unrestricted";
     };
     emailDomain: string;
+    /** Kill switch for all outbound email associated with this institute. When true the
+     * backend drops every email it sends on the institute's behalf — students, parents,
+     * employers, linked hubs/trusts and the public — before it reaches Brevo. The only
+     * exception is mail to the institute's own staff, so the account stays usable while
+     * the block is on. Set from Organisation > Overview. */
+    blockAllEmails?: boolean;
     splitBilling?: boolean;
     adminBillingContactId?: string;
     employerEvents?: boolean;
@@ -1052,6 +1061,12 @@ export type InstituteData = {
     autoVerifyInsurance?: boolean | "reject";
     riskAssessmentTemplate?: Timestamp;
     riskAssessmentColumns?: RiskAssessmentFieldDef[];
+    riskAssessmentFormId?: string;
+    riskAssessmentEnabled?: {
+        template?: boolean;
+        columns?: boolean;
+        form?: boolean;
+    };
     privacyPolicy: Timestamp;
     demo?: boolean;
     emailTemplates?: {
@@ -1356,7 +1371,7 @@ export type PlacementReviewDetails = {
             jobTitle: string;
             questions: PlacementQuestions;
             riskAssessment: boolean | "awaitingReview";
-            riskAssessmentType: "form" | "file";
+            riskAssessmentType: "form" | "file" | "customForm";
             riskAssessmentData?: {
                 [key: string]: unknown;
             } | string;
@@ -1387,6 +1402,8 @@ export type PlacementReviewDetails = {
     riskAssessmentData?: {
         [key: string]: unknown;
     }[] | string;
+    riskAssessmentFormId?: string;
+    riskAssessmentFormSchema?: CustomFormSchema;
     dbsCheckData?: {
         [key: string]: unknown;
     }[] | string;
@@ -3034,6 +3051,10 @@ export type EmailInteraction = {
     recipientEmail: string;
     recipientForename: string;
     recipientSurname: string;
+    /** The institute this email was sent on behalf of. Written on every send that
+     * knows its institute, so a reminder resent weeks later can still resolve the
+     * institute's email settings (e.g. `blockAllEmails`) without the original context. */
+    oId?: string;
     messageType?: MessageTypes;
     reminderNumber?: number;
     sendReminders?: boolean;

package/package.json

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

package/src/typeDefinitions.ts

@@ -108,9 +108,11 @@ export type StudentPlacementData = {
     insuranceExpiry?: string,
     insuranceSkippedReason?: string,
     riskAssessment?: boolean|"awaitingReview",
-    riskAssessmentType?: "file"|"form"|"skipped",
+    riskAssessmentType?: "file"|"form"|"skipped"|"customForm",
     riskAssessmentData?: {[key:string]: unknown}[]|string,
     riskAssessmentCustomFields?: RiskAssessmentFieldDef[],
+    riskAssessmentFormId?: string,
+    riskAssessmentFormSchema?: CustomFormSchema,
     dbsCheck?: boolean|"awaitingReview",
     dbsCheckType?: "file"|"form"|"skipped",
     dbsCheckData?: {[key:string]: unknown}[]|string,
@@ -259,9 +261,10 @@ export type PlacementListing = {
     mapConsent?: boolean,
     mapConsentDate?: string,
     uploadedBy: "student"|"institute"|"provider",
-    riskAssessmentType?: "file"|"form"|"skipped",
+    riskAssessmentType?: "file"|"form"|"skipped"|"customForm",
     concurrentPlacements?: number,
     riskAssessmentData?: {[key:string]: unknown}[]|string,
+    riskAssessmentFormId?: string,
     dbsCheckType?: "file"|"form"|"skipped",
     dbsCheckData?: {[key:string]: unknown}[]|string,
     contactType?: "email"|"website"|"phone"|"post",
@@ -979,6 +982,12 @@ export type InstituteData = {
         employerSharingScope: "membership"|"unrestricted",
     },
     emailDomain: string,
+    /** Kill switch for all outbound email associated with this institute. When true the
+     * backend drops every email it sends on the institute's behalf — students, parents,
+     * employers, linked hubs/trusts and the public — before it reaches Brevo. The only
+     * exception is mail to the institute's own staff, so the account stays usable while
+     * the block is on. Set from Organisation > Overview. */
+    blockAllEmails?: boolean,
     splitBilling?: boolean,
     adminBillingContactId?: string,
     // Packages institutes can be signed up to
@@ -1072,6 +1081,12 @@ export type InstituteData = {
     autoVerifyInsurance?: boolean|"reject",
     riskAssessmentTemplate?: Timestamp,
     riskAssessmentColumns?: RiskAssessmentFieldDef[],
+    riskAssessmentFormId?: string,
+    riskAssessmentEnabled?: {
+        template?: boolean,
+        columns?: boolean,
+        form?: boolean,
+    },
     privacyPolicy: Timestamp,
     demo?: boolean,
     emailTemplates?: {
@@ -1381,7 +1396,7 @@ export type PlacementReviewDetails = {
             jobTitle: string,
             questions: PlacementQuestions,
             riskAssessment: boolean|"awaitingReview",
-            riskAssessmentType: "form"|"file",
+            riskAssessmentType: "form"|"file"|"customForm",
             riskAssessmentData?: {[key: string]: unknown}|string,
             dbsCheck: boolean|"awaitingReview",
             dbsCheckType: "form"|"file",
@@ -1397,6 +1412,8 @@ export type PlacementReviewDetails = {
     providerContactId: string,
     incompleteItems: {[key: number]: string[]},
     riskAssessmentData?: {[key: string]: unknown}[]|string,
+    riskAssessmentFormId?: string,
+    riskAssessmentFormSchema?: CustomFormSchema,
     dbsCheckData?: {[key: string]: unknown}[]|string,
     feedbackText?: Descendant[],
     feedback: CustomFormSchema,
@@ -2982,6 +2999,10 @@ export type EmailInteraction = {
     recipientEmail: string,
     recipientForename: string,
     recipientSurname: string,
+    /** The institute this email was sent on behalf of. Written on every send that
+     * knows its institute, so a reminder resent weeks later can still resolve the
+     * institute's email settings (e.g. `blockAllEmails`) without the original context. */
+    oId?: string,
     // Email reminders values
     messageType?: MessageTypes, // This will be used to determine which test is necessary to decide to send a reminder
     reminderNumber?: number, // Which of the reminders is this?