@forwardslashns/taskit-validation-messages 1.10.18 → 1.10.19

package/src/validation/features/template-recurrence-settings.validation-messages.ts

@@ -1,140 +1,174 @@
-export const TEMPLATE_RECURRENCE_SETTINGS = {
+import { defineValidationFeatureMessages, VALIDATION_SEVERITY } from '../validation-message.types';
+
+export const TEMPLATE_RECURRENCE_SETTINGS = defineValidationFeatureMessages({
   RECURRENCE_NOT_FOUND: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'Template recurrence setting not found',
     affectedFields: [] as string[],
   },
   RECURRENCE_FREQUENCY_REQUIRED: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'Recurrence frequency is required',
     affectedFields: ['recurrenceFrequency'],
   },
   RECURRENCE_FREQUENCY_NOT_FOUND: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'Recurrence frequency not found.',
     affectedFields: ['recurrenceFrequencyId'],
   },
   RECURRENCE_FREQUENCY_ALREADY_EXISTS: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message:
       'Each recurrence frequency can only be added to a template once. A recurrence for {recurrenceFrequency} already exists. Please edit that recurrence setup, or change the recurrence frequency selected here before saving.',
     params: ['recurrenceFrequency'],
     affectedFields: ['recurrenceFrequencyId'],
   },
   INCOME_TAX_MUST_BE_ANNUAL: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message:
       'An Income tax filing template can only have an annual recurrence frequency. Please update your selection before saving.',
     affectedFields: ['recurrenceFrequencyId'],
   },
   BASED_ON_MUST_BE_PERIOD: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message:
       "A {templateType} template recurrence must always be based on 'Period'. Please update your selection before saving.",
     params: ['templateType'],
     affectedFields: ['basedOn'],
   },
   BASED_ON_REQUIRED: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'Based on is required',
     affectedFields: ['basedOn'],
   },
   BASED_ON_MUST_BE_DATE: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message:
       "A {templateType} template recurrence must always be based on 'Date'. Please update your selection before saving.",
     params: ['templateType'],
     affectedFields: ['basedOn'],
   },
   FIRST_MONTH_REQUIRED: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'First month is required',
     affectedFields: ['firstMonth'],
   },
   FIRST_MONTH_INVALID: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'First month must be a value between 1 and 12.',
     affectedFields: ['firstMonth'],
   },
   SECOND_MONTH_REQUIRED: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'Second month is required',
     affectedFields: ['secondMonth'],
   },
   SECOND_MONTH_INVALID: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'Second month must be a value between 1 and 12.',
     affectedFields: ['secondMonth'],
   },
   THIRD_MONTH_REQUIRED: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'Third month is required',
     affectedFields: ['thirdMonth'],
   },
   THIRD_MONTH_INVALID: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'Third month must be a value between 1 and 12.',
     affectedFields: ['thirdMonth'],
   },
   FOURTH_MONTH_REQUIRED: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'Fourth month is required',
     affectedFields: ['fourthMonth'],
   },
   FOURTH_MONTH_INVALID: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'Fourth month must be a value between 1 and 12.',
     affectedFields: ['fourthMonth'],
   },
   DAY_OF_MONTH_REQUIRED: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'Day of month is required',
     affectedFields: ['dayOfMonth'],
   },
   DAY_OF_MONTH_INVALID: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'Day of month must be a value between 1 and 31.',
     affectedFields: ['dayOfMonth'],
   },
   DUE_MONTH_REQUIRED: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'Due month is required',
     affectedFields: ['dueMonth'],
   },
   DUE_MONTH_INVALID: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'Due month must be a value between 0 and 12.',
     affectedFields: ['dueMonth'],
   },
   DUE_DAY_REQUIRED: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'Due day is required',
     affectedFields: ['dueDay'],
   },
   DUE_DAY_INVALID: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'Due day must be a value between 0 and 31.',
     affectedFields: ['dueDay'],
   },
   EXTEND_MONTH_REQUIRED: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'Extend month is required',
     affectedFields: ['extendMonth'],
   },
   EXTEND_MONTH_INVALID: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'Extend month cannot be a negative number.',
     affectedFields: ['extendMonth'],
   },
   GENERATE_BEFORE_REQUIRED: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'Before is required',
     affectedFields: ['generateBeforeId'],
   },
   GENERATE_TASKS_DAYS_REQUIRED: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'Generate task days is required',
     affectedFields: ['generateTasksDays'],
   },
   GENERATE_BEFORE_MUST_BE_DUE_DATE: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message:
       'This recurrence is based on a date, therefore it can only be generated before a due date. Please update your selection before saving.',
     affectedFields: ['generateBeforeId'],
   },
   DAY_EXCEEDS_MONTH_MAX: {
-    message: 'Day {dayOfMonth} is not valid for {monthName}. The maximum allowed day is {maxDays}.',
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `Day '{dayOfMonth}' is not valid for '{monthName}'. The maximum allowed day is '{maxDays}'.`,
     params: ['dayOfMonth', 'monthName', 'maxDays'],
     affectedFields: ['dayOfMonth'],
   },
   RECURRENCE_IN_USE_CANNOT_EDIT: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'This recurrence is currently applied to a client and cannot be edited.',
     affectedFields: [] as string[],
   },
   RECURRENCE_IN_USE_CANNOT_DELETE: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'This recurrence is currently in use and cannot be deleted.',
     affectedFields: [] as string[],
   },
   RECURRENCE_GENERATE_BEFORE_NOT_FOUND: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'Generate before option not found.',
     affectedFields: ['generateBeforeId'],
   },
   RECURRENCE_REQUIRED_FOR_TEMPLATE_TYPE: {
-    message: 'A {templateType} template must have a recurrence set up. Please add a recurrence before saving.',
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `A '{templateType}' template must have a recurrence set up. Please add a recurrence before saving.`,
     params: ['templateType'],
     affectedFields: ['recurrenceSettings'],
   },
-} as const;
+});

package/src/validation/features/template-states.validation-messages.ts

@@ -1,42 +1,54 @@
-export const TEMPLATE_STATES = {
+import { defineValidationFeatureMessages, VALIDATION_SEVERITY } from '../validation-message.types';
+
+export const TEMPLATE_STATES = defineValidationFeatureMessages({
   TEMPLATE_STATE_NOT_FOUND: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'Template state not found',
     affectedFields: [],
   },
   NAME_REQUIRED: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'Name is required',
     affectedFields: ['name'],
   },
   NAME_ALREADY_IN_USE: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'This name is already in use on this template. Please enter a different name.',
     affectedFields: ['name'],
   },
   STATE_REQUIRED: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'State is required',
     affectedFields: ['stateId'],
   },
   INVALID_STATE: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'Invalid state',
     affectedFields: ['stateId'],
   },
   STATE_LOCKED_WHEN_IN_USE: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'The State field cannot be changed because this state is already applied to a client.',
     affectedFields: ['stateId'],
   },
   DATE_STOPPED_REQUIRED_WHEN_INACTIVE: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'Date stopped is required when status is Inactive.',
     affectedFields: ['dateStopped'],
   },
   IS_ACTIVE_REQUIRED: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'Status is required',
     affectedFields: ['isActive'],
   },
   IN_USE_CANNOT_DELETE: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'This state is currently in use and cannot be deleted.',
     affectedFields: [],
   },
   TEMPLATE_MUST_BE_FILING_TYPE: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'States can only be added to Filing type templates.',
     affectedFields: [],
   },
-} as const;
+});

package/src/validation/features/user-preferences.validation-messages.ts

@@ -1,19 +1,25 @@
-export const USER_PREFERENCES = {
+import { defineValidationFeatureMessages, VALIDATION_SEVERITY } from '../validation-message.types';
+
+export const USER_PREFERENCES = defineValidationFeatureMessages({
   FEATURE_DOES_NOT_EXIST: {
-    message: `Feature with name {feature} does not exist`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `Feature with name '{feature}' does not exist`,
     params: ['feature'],
     affectedFields: ['feature'],
   },
   INVALID_REQUEST: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'Request is invalid',
     affectedFields: [],
   },
   PREFERENCE_DOES_NOT_BELONG_TO_USER: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'Preference does not belong to the user',
     affectedFields: [],
   },
   INVALID_COLUMN_ORDER: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: 'Invalid columnOrder values',
     affectedFields: ['columnOrder'],
   },
-} as const;
+});

package/src/validation/features/users.validation-messages.ts

@@ -1,56 +1,70 @@
-export const USERS = {
+import { defineValidationFeatureMessages, VALIDATION_SEVERITY } from '../validation-message.types';
+
+export const USERS = defineValidationFeatureMessages({
   USERNAME_DOES_NOT_EXIST: {
-    message: `User with username {username} does not exist.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `User with username '{username}' does not exist.`,
     params: ['username'],
     affectedFields: ['userName'],
   },
   INVALID_PASSWORD: {
-    message: `User with username {username} password does not match.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `User with username '{username}' password does not match.`,
     params: ['username'],
     affectedFields: ['password'],
   },
   INVALID_RESET_PASSWORD_TOKEN: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `Invalid or expired reset token.`,
     affectedFields: ['resetToken'],
   },
   RESET_PASSWORD_LINK_ALREADY_USED: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `Reset password link has already been used. Please request a new one.`,
     affectedFields: ['resetToken'],
   },
   RESET_PASSWORD_LINK_NOT_LATEST: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `Reset password link is no longer valid. Please use the most recent one.`,
     affectedFields: ['resetToken'],
   },
   USERNAME_ALREADY_EXISTS: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `User with username '{username}' already exists`,
     params: ['username'],
     affectedFields: ['userName'],
   },
   EMAIL_ALREADY_EXISTS: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `User with email '{email}' already exists`,
     params: ['email'],
     affectedFields: ['email'],
   },
   ROLE_DOES_NOT_EXIST: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `Role does not exist`,
     params: ['roleId'],
   },
   USER_DOES_NOT_EXIST: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `User does not exist`,
     params: ['userId'],
     affectedFields: ['userId'],
   },
   USER_PASSWORDS_DO_NOT_MATCH: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `User passwords do not match`,
     affectedFields: ['password', 'confirmPassword'],
   },
   USER_HAS_REFERENCED_DATA: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `User '{fullName}' cannot be deleted because they are referenced by existing records.`,
     params: ['fullName'],
     affectedFields: ['userId'],
   },
   USER_CANNOT_DELETE_SELF: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `You cannot delete your own account.`,
     affectedFields: ['userId'],
   },
-} as const;
+});

package/src/validation/validation-message.formatter.ts

@@ -1,4 +1,5 @@
 import { VALIDATION_MESSAGES } from './validation-messages';
+import { ValidationMessageDefinition, ValidationSeverity } from './validation-message.types';
 
 type Features = keyof typeof VALIDATION_MESSAGES;
 type ErrorType<F extends Features> = keyof (typeof VALIDATION_MESSAGES)[F];
@@ -8,16 +9,12 @@ type ErrorMessageParams<F extends Features, E extends ErrorType<F>> = (typeof VA
   ? P
   : [];
 type MessageParams<T extends readonly string[]> = { [K in T[number]]: string };
-type MessageConfig = {
-  message: string;
-  params?: readonly string[];
-  affectedFields?: readonly string[];
-};
 
 export type ValidationMessageResult = {
   content: string;
   affectedFields: string[];
   feature: string;
+  severity: ValidationSeverity;
 };
 
 export const getValidationMessage = <FeatureType extends Features, FeatureErrorType extends ErrorType<FeatureType>>(
@@ -28,7 +25,7 @@ export const getValidationMessage = <FeatureType extends Features, FeatureErrorT
   const feature = parts[0] as FeatureType;
   const featureError = parts[1] as FeatureErrorType;
 
-  const messageConfig = VALIDATION_MESSAGES[feature][featureError] as MessageConfig;
+  const messageConfig = VALIDATION_MESSAGES[feature][featureError] as ValidationMessageDefinition;
 
   if (!messageConfig) {
     throw new Error(
@@ -74,5 +71,6 @@ export const getValidationMessage = <FeatureType extends Features, FeatureErrorT
     content: message,
     affectedFields: messageConfig.affectedFields ? [...messageConfig.affectedFields] : [],
     feature: feature,
+    severity: messageConfig.severity,
   };
 };

package/src/validation/validation-message.types.ts

@@ -0,0 +1,36 @@
+export const VALIDATION_SEVERITY = {
+  ERROR: 'error',
+  WARNING: 'warning',
+} as const;
+
+export type ValidationSeverity = (typeof VALIDATION_SEVERITY)[keyof typeof VALIDATION_SEVERITY];
+
+export type ValidationIssue = {
+  feature: string;
+  severity: ValidationSeverity;
+  message: string;
+  affectedFields: string[];
+  code: string;
+};
+
+export type ManualValidationIssueInput = Omit<ValidationIssue, 'severity'> & {
+  severity?: ValidationSeverity;
+};
+
+export type ValidationIssueInput = {
+  feature: string;
+  content: string;
+  affectedFields: string[];
+  severity?: ValidationSeverity;
+};
+
+export type ValidationMessageDefinition = {
+  severity: ValidationSeverity;
+  message: string;
+  params?: readonly string[];
+  affectedFields?: readonly string[];
+};
+
+export type ValidationFeatureMessages = Record<string, ValidationMessageDefinition>;
+
+export const defineValidationFeatureMessages = <T extends ValidationFeatureMessages>(messages: T): T => messages;