@forwardslashns/taskit-validation-messages 1.10.16 → 1.10.19

package/src/validation/features/client-records-entity-states-histories.validation-messages.ts

@@ -1,83 +1,102 @@
-export const CLIENT_RECORDS_ENTITY_STATES = {
+import { defineValidationFeatureMessages, VALIDATION_SEVERITY } from '../validation-message.types';
+
+export const CLIENT_RECORDS_ENTITY_STATES = defineValidationFeatureMessages({
   STATE_ID_DOES_NOT_EXIST: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `State does not exist`,
     params: ['id'],
     affectedFields: ['state'],
   },
   NOT_ALIGNED_DATE_ESTABLISHED_DOMESTIC_STATE_STARTING_DATE: {
-    message: `The state, {domesticState}, starts on {domesticStateStartingDate}, which is earlier than the client's date established, {clientDateEstablished}. Please adjust the start date of the state or the client's date established.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `The state, '{domesticState}', starts on '{domesticStateStartingDate}', which is earlier than the client's date established, '{clientDateEstablished}'. Please adjust the start date of the state or the client's date established.`,
     params: ['clientDateEstablished', 'domesticState', 'domesticStateStartingDate'],
     affectedFields: ['dateEstablished', 'domesticState'],
   },
   NOT_ALIGNED_CLOSE_DATE_DOMESTIC_STATE_STARTING_DATE: {
-    message: `One or more states have a start date which is after the client's close date of {clientCloseDate}. {domesticState} starting {domesticStateStartingDate}. Please update the state/s start date/s to be before the client's close date, or update the client's close date.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `One or more states have a start date which is after the client's close date of '{clientCloseDate}'. '{domesticState}' starting '{domesticStateStartingDate}'. Please update the state/s start date/s to be before the client's close date, or update the client's close date.`,
     params: ['clientCloseDate', 'domesticState', 'domesticStateStartingDate'],
     affectedFields: ['closeDate', 'domesticState'],
   },
   DOMESTIC_STATE_STARTING_DATE_NOT_POPULATED: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `Current Domestic State Starting Date cannot be Empty`,
     affectedFields: ['stateStartingDate'],
   },
   STATES_IDS_DOES_NOT_EXIST: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `States do not exist`,
     params: ['ids'],
     affectedFields: ['state'],
   },
   RESIDENCE_TYPE_DOES_NOT_EXIST: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `Residence type does not exist`,
     params: ['ids'],
     affectedFields: ['residence'],
   },
   AT_LEAST_ONE_DOMESTIC_STATE_SHOULD_EXIST: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `At least one domestic state should exist`,
     affectedFields: ['domesticState'],
   },
   STATES_STARTING_DATE_NOT_POPULATED: {
-    message: `Starting date for {state} cannot be empty`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `Starting date for '{state}' cannot be empty`,
     params: ['state'],
     affectedFields: ['stateStartingDate'],
   },
   NOT_ALIGNED_STATES_STARTING_ENDING_DATE: {
-    message: `The ending date for {state} must be after its starting date`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `The ending date for '{state}' must be after its starting date`,
     params: ['state'],
     affectedFields: ['stateStartingDate', 'stateEndingDate'],
   },
   NOT_ALIGNED_DATE_ESTABLISHED_STATES_STARTING_DATE: {
-    message: `Adjust the start date to be on or after the client's date established, {clientStartDate}.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `Adjust the start date to be on or after the client's date established, '{clientStartDate}'.`,
     params: ['clientStartDate'],
     affectedFields: ['stateStartingDate', 'dateEstablished'],
   },
   NOT_ALIGNED_CLOSE_DATE_STATES_STARTING_DATE: {
-    message: `Adjust the start date to be before the client's close date, {clientCloseDate}.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `Adjust the start date to be before the client's close date, '{clientCloseDate}'.`,
     params: ['clientCloseDate'],
     affectedFields: ['stateStartingDate', 'closeDate'],
   },
   DOMESTIC_STATES_DATE_GAP_DETECTED: {
-    message: `There is a gap in the timeframes between {currentState}, ending {currentStateEndDate}, and {nextState}, starting {nextStateStartDate}. Please adjust the dates to fill this gap.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `There is a gap in the timeframes between '{currentState}', ending '{currentStateEndDate}', and '{nextState}', starting '{nextStateStartDate}'. Please adjust the dates to fill this gap.`,
     params: ['currentState', 'currentStateEndDate', 'nextState', 'nextStateStartDate'],
     affectedFields: ['domesticState'],
   },
   STATES_CONSECUTIVE_DUPLICATES_DETECTED: {
-    message: `There are two entries for {state} with timeframes that immediately follow each other. {state} ending {firstPeriodEnd}, and {state} starting {secondPeriodStart}. Please update one entry to include the entire timeframe for {state}. `,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `There are two entries for '{state}' with timeframes that immediately follow each other. '{state}' ending '{firstPeriodEnd}', and '{state}' starting '{secondPeriodStart}'. Please update one entry to include the entire timeframe for '{state}'. `,
     params: ['state', 'firstPeriodStart', 'firstPeriodEnd', 'secondPeriodStart'],
     affectedFields: ['domesticState'],
   },
   DOMESTIC_STATE_EARLIEST_AND_DATE_ESTABLISHED_GAP_DETECTED: {
-    message: `There is a gap between the client's date established ({dateEstablished}) and the start of its first state ({earliestState} starting {earliestStateStartDate}). There must be a state that begins on {dateEstablished}.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `There is a gap between the client's date established ('{dateEstablished}') and the start of its first state ('{earliestState}' starting '{earliestStateStartDate}'). There must be a state that begins on '{dateEstablished}'.`,
     params: ['dateEstablished', 'earliestState', 'earliestStateStartDate'],
     affectedFields: ['domesticState', 'dateEstablished'],
   },
   STATES_DATES_OVERLAP: {
-    message: `The client already has {state} starting from {startDate2} to {endDate2}. Your current entity type overlaps with that time. Please adjust the dates so they don't overlap.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `The client already has '{state}' starting from '{startDate2}' to '{endDate2}'. Your current entity type overlaps with that time. Please adjust the dates so they don't overlap.`,
     params: ['state', 'startDate1', 'endDate1', 'startDate2', 'endDate2'],
     affectedFields: ['domesticState'],
   },
   ALL_NON_LAST_DOMESTIC_STATES_REQUIRE_ENDING_DATE: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `Only the last domestic state can be open without an end date. Add an ending date to the existing state before adding a start date for a new state.`,
     affectedFields: ['stateEndingDate'],
   },
   CURRENT_DOMESTIC_STATE_CANNOT_HAVE_ENDING_DATE: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `The current domestic state cannot have an end date. Please remove the end date for this state.`,
     affectedFields: ['stateEndingDate'],
   },
-} as const;
+});

package/src/validation/features/client-records-entity-types-histories.validation-messages.ts

@@ -1,82 +1,101 @@
-export const CLIENT_RECORDS_ENTITY_TYPES = {
+import { defineValidationFeatureMessages, VALIDATION_SEVERITY } from '../validation-message.types';
+
+export const CLIENT_RECORDS_ENTITY_TYPES = defineValidationFeatureMessages({
   ENTITY_TYPE_ID_DOES_NOT_EXIST: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `Entity type does not exist`,
     params: ['id'],
     affectedFields: ['entityType'],
   },
   NOT_ALIGNED_DATE_ESTABLISHED_ENTITY_TYPE_STARTING_DATE: {
-    message: `One or more entity types have a start date that is before the client's date established, {clientDateEstablished}. ({entityType} starting {entityTypeStartingDate}). Please update the entity type start dates to be on or after the client's date established, or update the client's date established.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `One or more entity types have a start date that is before the client's date established, '{clientDateEstablished}'. ('{entityType}' starting '{entityTypeStartingDate}'). Please update the entity type start dates to be on or after the client's date established, or update the client's date established.`,
     params: ['clientDateEstablished', 'entityType', 'entityTypeStartingDate'],
     affectedFields: ['dateEstablished', 'entityType'],
   },
   NOT_ALIGNED_CLOSE_DATE_ENTITY_TYPE_STARTING_DATE: {
-    message: `One or more entity types have start dates that are after the client's close date, {clientCloseDate}. {entityType} starting {entityTypeStartingDate}. Please update the entity type/s end date/s to be on or before the client's close date, or update the client's close date.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `One or more entity types have start dates that are after the client's close date, '{clientCloseDate}'. '{entityType}' starting '{entityTypeStartingDate}'. Please update the entity type/s end date/s to be on or before the client's close date, or update the client's close date.`,
     params: ['clientCloseDate', 'entityType', 'entityTypeStartingDate'],
     affectedFields: ['closeDate', 'entityType'],
   },
   ENTITY_TYPE_STARTING_DATE_NOT_POPULATED: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `Current Entity Type Starting Date cannot be Empty`,
     affectedFields: ['entityTypeStartingDate'],
   },
   NOT_ALIGNED_ENTITY_TYPE_STARTING_ENDING_DATE: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `Entity type starting date needs to be before the ending date`,
     affectedFields: ['entityTypeStartingDate', 'entityTypeEndingDate'],
   },
   ENTITY_TYPES_IDS_DOES_NOT_EXIST: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `Entity types do not exist`,
     params: ['ids'],
     affectedFields: ['entityType'],
   },
   AT_LEAST_ONE_ENTITY_TYPE_SHOULD_EXIST: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `At least one entity type should exist`,
     affectedFields: ['entityType'],
   },
   ENTITY_TYPES_STARTING_DATE_NOT_POPULATED: {
-    message: `Starting date for {entityType} cannot be empty`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `Starting date for '{entityType}' cannot be empty`,
     params: ['entityType'],
     affectedFields: ['entityTypeStartingDate'],
   },
   NOT_ALIGNED_ENTITY_TYPES_STARTING_ENDING_DATE: {
-    message: `The ending date for {entityType} must be after its starting date`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `The ending date for '{entityType}' must be after its starting date`,
     params: ['entityType'],
     affectedFields: ['entityTypeStartingDate', 'entityTypeEndingDate'],
   },
   NOT_ALIGNED_DATE_ESTABLISHED_ENTITY_TYPES_STARTING_DATE: {
-    message: `Adjust the start date to be on or after the client's date established, {clientStartDate}.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `Adjust the start date to be on or after the client's date established, '{clientStartDate}'.`,
     params: ['clientStartDate'],
     affectedFields: ['entityTypeStartingDate', 'dateEstablished'],
   },
   NOT_ALIGNED_CLOSE_DATE_ENTITY_TYPES_STARTING_DATE: {
-    message: `Adjust the start date to be before the client's close date, {clientCloseDate}.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `Adjust the start date to be before the client's close date, '{clientCloseDate}'.`,
     params: ['clientCloseDate'],
     affectedFields: ['entityTypeStartingDate', 'closeDate'],
   },
   ENTITY_TYPES_DATE_GAP_DETECTED: {
-    message: `There is a gap in the timeframes between {currentEntityType}, ending {currentEntityTypeEndDate}, and {nextEntityType}, starting {nextEntityTypeStartDate}. Please adjust the dates to fill this gap.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `There is a gap in the timeframes between '{currentEntityType}', ending '{currentEntityTypeEndDate}', and '{nextEntityType}', starting '{nextEntityTypeStartDate}'. Please adjust the dates to fill this gap.`,
     params: ['currentEntityType', 'currentEntityTypeEndDate', 'nextEntityType', 'nextEntityTypeStartDate'],
     affectedFields: ['entityType'],
   },
   ENTITY_TYPES_CONSECUTIVE_DUPLICATES_DETECTED: {
-    message: `There are two entries for {entityType} with timeframes that immediately follow each other. {entityType} ending {firstPeriodEnd}, and {entityType} starting {secondPeriodStart}. Please update one entry to include the entire timeframe for {entityType}. `,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `There are two entries for '{entityType}' with timeframes that immediately follow each other. '{entityType}' ending '{firstPeriodEnd}', and '{entityType}' starting '{secondPeriodStart}'. Please update one entry to include the entire timeframe for '{entityType}'. `,
     params: ['entityType', 'firstPeriodStart', 'firstPeriodEnd', 'secondPeriodStart'],
     affectedFields: ['entityType'],
   },
   ENTITY_TYPE_EARLIEST_AND_DATE_ESTABLISHED_GAP_DETECTED: {
-    message: `There is a gap between the client's date established ({dateEstablished}) and the start of its first entity type ({earliestEntityType} starting {earliestEntityTypeStartDate}). There must be an entity type that begins on {dateEstablished}.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `There is a gap between the client's date established ('{dateEstablished}') and the start of its first entity type ('{earliestEntityType}' starting '{earliestEntityTypeStartDate}'). There must be an entity type that begins on '{dateEstablished}'.`,
     params: ['dateEstablished', 'earliestEntityType', 'earliestEntityTypeStartDate'],
     affectedFields: ['entityType', 'dateEstablished'],
   },
   ENTITY_TYPES_DATES_OVERLAP: {
-    message: `The client already has {entityType} starting from {startDate2} to {endDate2}. Your current entity type overlaps with that time. Please adjust the dates so they don't overlap.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `The client already has '{entityType}' starting from '{startDate2}' to '{endDate2}'. Your current entity type overlaps with that time. Please adjust the dates so they don't overlap.`,
     params: ['entityType', 'startDate1', 'endDate1', 'startDate2', 'endDate2'],
     affectedFields: ['entityType'],
   },
   ALL_NON_LAST_ENTITY_TYPES_REQUIRE_ENDING_DATE: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `Only the last entity type can be open without an end date. Add an ending date to the existing entity type before adding a start date for a new entity type.`,
     affectedFields: ['entityTypeEndingDate'],
   },
   CURRENT_ENTITY_TYPE_CANNOT_HAVE_ENDING_DATE: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `The current entity type cannot have an end date. Please remove the end date for this state.`,
     affectedFields: ['entityTypeEndingDate'],
   },
-} as const;
+});

package/src/validation/features/client-records-filing-statuses-histories.validation-messages.ts

@@ -1,82 +1,101 @@
-export const CLIENT_RECORDS_FILING_STATUSES = {
+import { defineValidationFeatureMessages, VALIDATION_SEVERITY } from '../validation-message.types';
+
+export const CLIENT_RECORDS_FILING_STATUSES = defineValidationFeatureMessages({
   FILING_STATUS_ID_DOES_NOT_EXIST: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `Sub/Parent status does not exist`,
     params: ['id'],
     affectedFields: ['filingStatus'],
   },
   NOT_ALIGNED_DATE_ESTABLISHED_FILING_STATUS_STARTING_DATE: {
-    message: `The Sub/Parent status {filingStatus} starts on {filingStatusStartingDate} which is earlier than the client's date established, {clientDateEstablished}. Please adjust the start date of the Sub/Parent status or the client's date established.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `The Sub/Parent status '{filingStatus}' starts on '{filingStatusStartingDate}' which is earlier than the client's date established, '{clientDateEstablished}'. Please adjust the start date of the Sub/Parent status or the client's date established.`,
     params: ['clientDateEstablished', 'filingStatus', 'filingStatusStartingDate'],
     affectedFields: ['dateEstablished', 'filingStatus'],
   },
   NOT_ALIGNED_CLOSE_DATE_FILING_STATUS_STARTING_DATE: {
-    message: `One or more Sub/Parent status have a start date which is after the client's close date of {clientCloseDate}. {filingStatus}, starting {filingStatusStartingDate}. Please update the start date to be earlier than the client's close date, or update the client's close date.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `One or more Sub/Parent status have a start date which is after the client's close date of '{clientCloseDate}'. '{filingStatus}', starting '{filingStatusStartingDate}'. Please update the start date to be earlier than the client's close date, or update the client's close date.`,
     params: ['clientCloseDate', 'filingStatus', 'filingStatusStartingDate'],
     affectedFields: ['closeDate', 'filingStatus'],
   },
   FILING_STATUS_STARTING_DATE_NOT_POPULATED: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `Current Sub/Parent status Starting Date cannot be Empty`,
     affectedFields: ['filingStatusStartingDate'],
   },
   NOT_ALIGNED_FILING_STATUS_STARTING_ENDING_DATE: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `Sub/Parent status starting date needs to be before the ending date`,
     affectedFields: ['filingStatusStartingDate', 'filingStatusEndingDate'],
   },
   FILING_STATUSES_IDS_DOES_NOT_EXIST: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `Sub/Parent status do not exist`,
     params: ['ids'],
     affectedFields: ['filingStatus'],
   },
   AT_LEAST_ONE_FILING_STATUS_SHOULD_EXIST: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `At least one Sub/Parent status should exist`,
     affectedFields: ['filingStatus'],
   },
   FILING_STATUSES_STARTING_DATE_NOT_POPULATED: {
-    message: `Starting date for {filingStatus} cannot be empty`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `Starting date for '{filingStatus}' cannot be empty`,
     params: ['filingStatus'],
     affectedFields: ['filingStatusStartingDate'],
   },
   NOT_ALIGNED_FILING_STATUSES_STARTING_ENDING_DATE: {
-    message: `The ending date for {filingStatus} must be after its starting date`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `The ending date for '{filingStatus}' must be after its starting date`,
     params: ['filingStatus'],
     affectedFields: ['filingStatusStartingDate', 'filingStatusEndingDate'],
   },
   NOT_ALIGNED_DATE_ESTABLISHED_FILING_STATUSES_STARTING_DATE: {
-    message: `Adjust the start date to be on or after the client's date established, {clientStartDate}.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `Adjust the start date to be on or after the client's date established, '{clientStartDate}'.`,
     params: ['clientStartDate'],
     affectedFields: ['filingStatusStartingDate', 'dateEstablished'],
   },
   NOT_ALIGNED_CLOSE_DATE_FILING_STATUSES_STARTING_DATE: {
-    message: `Adjust the start date to be before the client's close date, {clientCloseDate}.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `Adjust the start date to be before the client's close date, '{clientCloseDate}'.`,
     params: ['clientCloseDate'],
     affectedFields: ['filingStatusStartingDate', 'closeDate'],
   },
   FILING_STATUSES_DATE_GAP_DETECTED: {
-    message: `There is a gap in the timeframes between {currentFilingStatus}, ending {currentFilingStatusEndDate}, and {nextFilingStatus}, starting {nextFilingStatusStartDate}. Please adjust the dates to fill this gap.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `There is a gap in the timeframes between '{currentFilingStatus}', ending '{currentFilingStatusEndDate}', and '{nextFilingStatus}', starting '{nextFilingStatusStartDate}'. Please adjust the dates to fill this gap.`,
     params: ['currentFilingStatus', 'currentFilingStatusEndDate', 'nextFilingStatus', 'nextFilingStatusStartDate'],
     affectedFields: ['filingStatus'],
   },
   FILING_STATUSES_CONSECUTIVE_DUPLICATES_DETECTED: {
-    message: `There are two entries for {filingStatus} with timeframes that immediately follow each other. {filingStatus} ending {firstPeriodEnd}, and {filingStatus} starting {secondPeriodStart}. Please update one entry to include the entire timeframe for {filingStatus}. `,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `There are two entries for '{filingStatus}' with timeframes that immediately follow each other. '{filingStatus}' ending '{firstPeriodEnd}', and '{filingStatus}' starting '{secondPeriodStart}'. Please update one entry to include the entire timeframe for '{filingStatus}'. `,
     params: ['filingStatus', 'firstPeriodStart', 'firstPeriodEnd', 'secondPeriodStart'],
     affectedFields: ['filingStatus'],
   },
   FILING_STATUS_EARLIEST_AND_DATE_ESTABLISHED_GAP_DETECTED: {
-    message: `There is a gap between the client's date established ({dateEstablished}) and the start date of the first Sub/Parent status ({earliestFilingStatusStartDate}). Please ensure that the status of one Sub/Parent status matches the client's date established.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `There is a gap between the client's date established ('{dateEstablished}') and the start date of the first Sub/Parent status ('{earliestFilingStatusStartDate}'). Please ensure that the status of one Sub/Parent status matches the client's date established.`,
     params: ['dateEstablished', 'earliestFilingStatusStartDate'],
     affectedFields: ['filingStatus', 'dateEstablished'],
   },
   FILING_STATUSES_DATES_OVERLAP: {
-    message: `The client already has {filingStatus} starting from {startDate2} to {endDate2}. Your current entity type overlaps with that time. Please adjust the dates so they don't overlap.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `The client already has '{filingStatus}' starting from '{startDate2}' to '{endDate2}'. Your current entity type overlaps with that time. Please adjust the dates so they don't overlap.`,
     params: ['filingStatus', 'startDate1', 'endDate1', 'startDate2', 'endDate2'],
     affectedFields: ['filingStatus'],
   },
   ALL_NON_LAST_FILING_STATUSES_REQUIRE_ENDING_DATE: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `Only the last Sub/Parent status can be open without an end date. Add an ending date to the existing Sub/Parent status before adding a start date for a new Sub/Parent status.`,
     affectedFields: ['filingStatusEndingDate'],
   },
   CURRENT_FILING_STATUS_CANNOT_HAVE_ENDING_DATE: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `The current Sub/Parent status cannot have an end date. Please remove the end date for this state.`,
     affectedFields: ['filingStatusEndingDate'],
   },
-} as const;
+});

package/src/validation/features/client-records-outside-providers.validation-messages.ts

@@ -1,12 +1,16 @@
-export const CLIENT_RECORDS_OUTSIDE_PROVIDERS = {
+import { defineValidationFeatureMessages, VALIDATION_SEVERITY } from '../validation-message.types';
+
+export const CLIENT_RECORDS_OUTSIDE_PROVIDERS = defineValidationFeatureMessages({
   INVALID_TYPE: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `Outside provider types do not exist`,
     params: ['ids'],
     affectedFields: ['type'],
   },
   SAME_TYPE_TIMELINE_OVERLAP: {
-    message: `The client already has {outsideProviderType} starting from {startDate}. Your entry overlaps with that time. Please adjust the dates so they don't overlap.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `The client already has '{outsideProviderType}' starting from '{startDate}'. Your entry overlaps with that time. Please adjust the dates so they don't overlap.`,
     params: ['outsideProviderType', 'startDate'],
     affectedFields: ['starting', 'ending'],
   },
-} as const;
+});

package/src/validation/features/client-relationships-common.validation-messages.ts

@@ -1,71 +1,87 @@
-export const CLIENT_RELATIONSHIPS_COMMON = {
+import { defineValidationFeatureMessages, VALIDATION_SEVERITY } from '../validation-message.types';
+
+export const CLIENT_RELATIONSHIPS_COMMON = defineValidationFeatureMessages({
   CURRENT_CLIENT_CANNOT_BE_RELATED_TO_CURRENT_CLIENT: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `A client cannot have a relationship with itself.`,
     affectedFields: ['relatedClient'],
   },
   INVALID_RELATIONSHIP_TYPE_FOR_ENTITY_TYPE: {
-    message: `{clientName} is a/an {entityType}, which can't have {relationshipType}s. Please update the relationship type.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `'{clientName}' is a/an '{entityType}', which can't have '{relationshipType}'s. Please update the relationship type.`,
     params: ['clientName', 'entityType', 'relationshipType'],
     affectedFields: ['relationshipType'],
   },
   STARTING_DATE_BEFORE_CLIENT_DATE_ESTABLISHED: {
-    message: `This relationship's start date cannot be before {clientName}'s date established, {clientDateEstablished}. Please adjust the dates to proceed.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `This relationship's start date cannot be before {clientName}'s date established, '{clientDateEstablished}'. Please adjust the dates to proceed.`,
     params: ['clientName', 'clientDateEstablished'],
     affectedFields: ['startingDate'],
   },
   STARTING_DATE_ON_OR_AFTER_CLIENT_CLOSE_DATE: {
-    message: `This relationship's start date cannot be on or after {clientName}'s close date, {clientCloseDate}. Please adjust the dates to proceed.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `This relationship's start date cannot be on or after {clientName}'s close date, '{clientCloseDate}'. Please adjust the dates to proceed.`,
     params: ['clientName', 'clientCloseDate'],
     affectedFields: ['startingDate'],
   },
   STARTING_DATE_BEFORE_RELATED_CLIENT_DATE_ESTABLISHED: {
-    message: `This relationship's start date cannot be before {relatedClientName}'s date established, {relatedClientDateEstablished}. Please adjust the dates to proceed.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `This relationship's start date cannot be before {relatedClientName}'s date established, '{relatedClientDateEstablished}'. Please adjust the dates to proceed.`,
     params: ['relatedClientName', 'relatedClientDateEstablished'],
     affectedFields: ['startingDate'],
   },
   STARTING_DATE_ON_OR_AFTER_RELATED_CLIENT_CLOSE_DATE: {
-    message: `This relationship's start date cannot be on or after {relatedClientName}'s close date, {relatedClientCloseDate}. Please adjust the dates to proceed.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `This relationship's start date cannot be on or after {relatedClientName}'s close date, '{relatedClientCloseDate}'. Please adjust the dates to proceed.`,
     params: ['relatedClientName', 'relatedClientCloseDate'],
     affectedFields: ['startingDate'],
   },
   ENDING_DATE_ON_OR_BEFORE_STARTING_DATE: {
-    message: `Please update the relationship ending date to be after the starting date, {startingDate}.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `Please update the relationship ending date to be after the starting date, '{startingDate}'.`,
     params: ['startingDate'],
     affectedFields: ['endingDate'],
   },
   ENDING_DATE_AFTER_CLIENT_CLOSE_DATE: {
-    message: `{clientName}'s close date is {clientCloseDate}. One or more relationships have end dates later than this. Please update the following relationship end dates to be on or before {clientCloseDate}: {relationshipsWithEndingDateAfterCloseDate}, or update {clientName}'s close date.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `{clientName}'s close date is '{clientCloseDate}'. One or more relationships have end dates later than this. Please update the following relationship end dates to be on or before '{clientCloseDate}': '{relationshipsWithEndingDateAfterCloseDate}', or update {clientName}'s close date.`,
     params: ['clientName', 'clientCloseDate', 'relationshipsWithEndingDateAfterCloseDate'],
     affectedFields: ['endingDate'],
   },
   ENDING_DATE_AFTER_RELATED_CLIENT_CLOSE_DATE: {
-    message: `{relatedClientName}'s close date is {relatedClientCloseDate}. One or more relationships have end dates later than this. Please update the following relationship end dates to be on or before {relatedClientCloseDate}: {relationshipsWithEndingDateAfterCloseDate}, or update {relatedClientName}'s close date.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `{relatedClientName}'s close date is '{relatedClientCloseDate}'. One or more relationships have end dates later than this. Please update the following relationship end dates to be on or before '{relatedClientCloseDate}': '{relationshipsWithEndingDateAfterCloseDate}', or update {relatedClientName}'s close date.`,
     params: ['relatedClientName', 'relatedClientCloseDate', 'relationshipsWithEndingDateAfterCloseDate'],
     affectedFields: ['endingDate'],
   },
   FINAL_REQUIRED_WHEN_ENDING_DATE_MATCHES_CLIENT_CLOSE_DATE: {
-    message: `The relationship between {clientName} and {relatedClientName} has no end date or is not marked as final. Please update {relatedClientName}'s end date to be on or before {clientName}'s close date of {clientCloseDate}, or mark the relationship as final.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `The relationship between '{clientName}' and '{relatedClientName}' has no end date or is not marked as final. Please update {relatedClientName}'s end date to be on or before {clientName}'s close date of '{clientCloseDate}', or mark the relationship as final.`,
     params: ['clientName', 'relatedClientName', 'clientCloseDate'],
     affectedFields: ['endingDate', 'final'],
   },
   FINAL_REQUIRED_WHEN_ENDING_DATE_MATCHES_RELATED_CLIENT_CLOSE_DATE: {
-    message: `The relationship between {clientName} and {relatedClientName} has no end date or is not marked as final. Please update {clientName}'s end date to be on or before {relatedClientName}'s close date of {relatedClientCloseDate}, or mark the relationship as final.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `The relationship between '{clientName}' and '{relatedClientName}' has no end date or is not marked as final. Please update {clientName}'s end date to be on or before {relatedClientName}'s close date of '{relatedClientCloseDate}', or mark the relationship as final.`,
     params: ['clientName', 'relatedClientName', 'relatedClientCloseDate'],
     affectedFields: ['endingDate', 'final'],
   },
   CIRCULAR_RELATIONSHIP_DETECTED: {
-    message: `{clientName} is listed as a {relationshipType} of {relatedClientName}, during the same timeframe that {relatedClientName} is listed as a {relationshipType} of {clientName}. Please review the relationship records for both clients and adjust the dates or relationship types to prevent a circular loop.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `'{clientName}' is listed as a '{relationshipType}' of '{relatedClientName}', during the same timeframe that '{relatedClientName}' is listed as a '{relationshipType}' of '{clientName}'. Please review the relationship records for both clients and adjust the dates or relationship types to prevent a circular loop.`,
     params: ['clientName', 'relatedClientName', 'relationshipType'],
     affectedFields: ['relationshipType', 'relatedClient', 'startingDate', 'endingDate'],
   },
   CONFLICTING_RELATIONSHIP_TYPES_SAME_TIMEFRAME: {
-    message: `{relatedClientName} cannot be associated with {clientName} more than once within the same timeframe. Please ensure there are no conflicting relationships for these clients in this timeframe.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `'{relatedClientName}' cannot be associated with '{clientName}' more than once within the same timeframe. Please ensure there are no conflicting relationships for these clients in this timeframe.`,
     params: ['relatedClientName', 'clientName'],
     affectedFields: ['relationshipType', 'relatedClient', 'startingDate', 'endingDate'],
   },
   CONSECUTIVE_DUPLICATE_RELATIONSHIPS: {
-    message: `There is another {relationshipType} relationship between {relatedClientName} and {clientName} ending on {relationshipEnding}. Please review and adjust the dates to track this relationship in one record.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `There is another '{relationshipType}' relationship between '{relatedClientName}' and '{clientName}' ending on '{relationshipEnding}'. Please review and adjust the dates to track this relationship in one record.`,
     params: ['relationshipType', 'relatedClientName', 'clientName', 'relationshipEnding'],
     affectedFields: ['startingDate', 'endingDate'],
   },
-} as const;
+});

package/src/validation/features/client-relationships-income-sources.validation-messages.ts

@@ -1,71 +1,89 @@
-export const CLIENT_RELATIONSHIPS_INCOME_SOURCES = {
+import { defineValidationFeatureMessages, VALIDATION_SEVERITY } from '../validation-message.types';
+
+export const CLIENT_RELATIONSHIPS_INCOME_SOURCES = defineValidationFeatureMessages({
   SUBSIDIARY_CANNOT_HAVE_PARENT: {
-    message: `{clientName} cannot have subsidiary relationships since it is filing as a subsidiary under {parentClientName} during this timeframe. Please adjust the timeframe or select a different relationship type.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `'{clientName}' cannot have subsidiary relationships since it is filing as a subsidiary under '{parentClientName}' during this timeframe. Please adjust the timeframe or select a different relationship type.`,
     params: ['clientName', 'parentClientName'],
     affectedFields: ['relationshipType', 'startingDate', 'endingDate'],
   },
   SUBSIDIARY_REQUIRES_FILES_SEPARATELY: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `A subsidiary relationship can only be added to an entity that files separately. Please update the Sub/Parent status before adding a subsidiary relationship, or choose a different relationship type.`,
     affectedFields: ['relationshipType', 'filingStatus'],
   },
   SUBSIDIARY_PROFIT_PERCENTAGE_MUST_BE_100: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `A subsidiary must allocate 100% profit to its parent. Please update the percentage to 100% or change the relationship type.`,
     affectedFields: ['profit', 'relationshipType'],
   },
   SUBSIDIARY_LOSS_PERCENTAGE_MUST_BE_100: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `A subsidiary must allocate 100% loss to its parent. Please update the percentage to 100% or change the relationship type.`,
     affectedFields: ['loss', 'relationshipType'],
   },
   SUBSIDIARY_CAPITAL_PERCENTAGE_MUST_BE_100: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `A subsidiary must allocate 100% capital to its parent. Please update the percentage to 100% or change the relationship type.`,
     affectedFields: ['capital', 'relationshipType'],
   },
   SUBSIDIARY_ENTITY_TYPE_MISMATCH: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `A subsidiary entity must be the same entity type as the client during the relationship's timeframe (besides DBA or LLC subsidiaries). Please select a different relationship type, or update either client's entity type.`,
     affectedFields: ['relatedClient', 'relationshipType'],
   },
   K1_ISSUER_PROFIT_PERCENTAGE_MUST_BE_GREATER_THAN_0: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `A K1 issuer must allocate a profit percentage greater than 0%. Please enter a profit percentage, or change Receives K1 to 'No'.`,
     affectedFields: ['profit', 'k1Applicable'],
   },
   K1_ISSUER_LOSS_PERCENTAGE_MUST_BE_GREATER_THAN_0: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `A K1 issuer must allocate a loss percentage greater than 0%. Please enter a profit percentage, or change Receives K1 to 'No'.`,
     affectedFields: ['loss', 'k1Applicable'],
   },
   K1_ISSUER_CAPITAL_PERCENTAGE_MUST_BE_GREATER_THAN_0: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `A K1 issuer must allocate a capital percentage greater than 0%. Please enter a capital percentage, or change Receives K1 to 'No'.`,
     affectedFields: ['capital', 'k1Applicable'],
   },
   K1_ISSUER_NO_K1_PROFIT_PERCENTAGE_MUST_BE_0: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `A K1 issuer that does not issue a K1 cannot allocate a profit percentage. Please update the profit percentage to 0%, or change Receives K1 to 'Yes'.`,
     affectedFields: ['profit', 'k1Applicable'],
   },
   K1_ISSUER_NO_K1_LOSS_PERCENTAGE_MUST_BE_0: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `A K1 issuer that does not issue a K1 cannot allocate a loss percentage. Please update the loss percentage to 0%, or change Receives K1 to 'Yes'.`,
     affectedFields: ['loss', 'k1Applicable'],
   },
   K1_ISSUER_NO_K1_CAPITAL_PERCENTAGE_MUST_BE_0: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `A K1 issuer that does not issue a K1 cannot allocate a capital percentage. Please update the capital percentage to 0%, or change Receives K1 to 'Yes'.`,
     affectedFields: ['capital', 'k1Applicable'],
   },
   K1_ISSUER_INVALID_ENTITY_TYPE: {
-    message: `{relatedClient} is a/an {entityType}, which cannot issue K1s. Please select a different client or choose a different relationship type.`,
+    severity: VALIDATION_SEVERITY.ERROR,
+    message: `'{relatedClient}' is a/an '{entityType}', which cannot issue K1s. Please select a different client or choose a different relationship type.`,
     params: ['relatedClient', 'entityType'],
     affectedFields: ['relatedClient', 'relationshipType'],
   },
   INCOME_SOURCE_TOTAL_PROFIT_PERCENTAGE_EXCEEDS_100: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `The ownership percentages for {relatedClient}'s profit exceeds 100% for this timeframe. Please update their shareholder percentages so that the total between all owners does not exceed 100%.`,
     params: ['relatedClient'],
     affectedFields: ['profit', 'startingDate', 'endingDate'],
   },
   INCOME_SOURCE_TOTAL_LOSS_PERCENTAGE_EXCEEDS_100: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `The ownership percentages for {relatedClient}'s loss exceeds 100% for this timeframe. Please update their shareholder percentages so that the total between all owners does not exceed 100%.`,
     params: ['relatedClient'],
     affectedFields: ['loss', 'startingDate', 'endingDate'],
   },
   INCOME_SOURCE_TOTAL_CAPITAL_PERCENTAGE_EXCEEDS_100: {
+    severity: VALIDATION_SEVERITY.ERROR,
     message: `The ownership percentages for {relatedClient}'s capital exceeds 100% for this timeframe. Please update their shareholder percentages so that the total between all owners does not exceed 100%.`,
     params: ['relatedClient'],
     affectedFields: ['capital', 'startingDate', 'endingDate'],
   },
-} as const;
+});