Taskit Validation Messages

This package provides a centralized list of validation messages used across both frontend and backend of the project. It ensures consistent error display and simplifies maintenance by keeping all validation messages in one place, without altering code in development repositories.

✨ Features

• Centralized validation messages across all features
• Type-safe message retrieval with TypeScript
• Feature name constants to eliminate magic strings (v1.3.0+)
• Message key constants to eliminate magic strings for error aliases (v1.3.1+)
• Dynamic parameter substitution for contextual messages
• Affected fields tracking for better frontend UX (v1.1.0+)

VALIDATION_FEATURES (v1.3.0+)

To avoid using magic strings and improve type safety, the package now exports VALIDATION_FEATURES constants:

import { getValidationMessage, VALIDATION_FEATURES } from '@forwardslashns/taskit-validation-messages';

// ✅ Recommended: Use constants
const result = getValidationMessage(VALIDATION_FEATURES.CLIENT_CURRENT_ENTITY_STATUS, 'NAME_ALREADY_EXISTS', {
  name: 'Client Name',
});

// ❌ Not recommended: Using string literals
const result = getValidationMessage('CLIENT_CURRENT_ENTITY_STATUS', 'NAME_ALREADY_EXISTS', { name: 'Client Name' });

Available Feature Constants

VALIDATION_FEATURES.ACCOUNT_CATEGORY;
VALIDATION_FEATURES.ACCOUNT_ID;
VALIDATION_FEATURES.CLIENT_RECORD_ADDRESS;
VALIDATION_FEATURES.BUSINESS_ACTIVITY;
VALIDATION_FEATURES.CLIENT_RECORD_BANK_AND_CREDIT_CARD;
VALIDATION_FEATURES.CLIENT_RECORD_CONTACT;
VALIDATION_FEATURES.CLIENT_RECORD_COMISSION_DETAIL;
VALIDATION_FEATURES.CLIENT_CURRENT_ENTITY_STATUS;
VALIDATION_FEATURES.CLIENT_RECORD_ENTITY_TYPE_HISTORY;
VALIDATION_FEATURES.CLIENT_RECORD_FILING_STATUS_HISTORY;
VALIDATION_FEATURES.CLIENT_RECORD_ENTITY_STATE_HISTORY;
VALIDATION_FEATURES.CLIENT_RELATIONSHIP;
VALIDATION_FEATURES.FILING_CATEGORY;
VALIDATION_FEATURES.STATE;
VALIDATION_FEATURES.USER;
VALIDATION_FEATURES.ROLE_AND_PERMISSION;
VALIDATION_FEATURES.DATA_FILTER;
VALIDATION_FEATURES.USER_PREFERENCE;
VALIDATION_FEATURES.CLIENT_RECORD_OUTSIDE_PROVIDER;

VALIDATION_MESSAGES

The package exposes validation messages that can be retrieved using specific aliases. These messages are organized by the features they belong to, making it easier to manage and update them.

getValidationMessage

This mechanism allows for the retrieval and dynamic creation of validation messages by passing their aliases and any required parameters. Parameters are optional and passed as objects, following the structure defined within each validation message itself.

Return Value (v1.1.0+)

getValidationMessage now returns a ValidationMessageResult object:

{
  content: string;          // The formatted validation message
  affectedFields: string[]; // Array of field identifiers affected by this validation error
}

Usage

import { getValidationMessage, VALIDATION_FEATURES } from '@forwardslashns/taskit-validation-messages';

// ✅ Best practice: Use feature constants (v1.3.0+)
const result = getValidationMessage(VALIDATION_FEATURES.ACCOUNT_CATEGORY, 'NAME_ALREADY_EXISTS', { name: 'Marketing' });

// Also works: String literals (backward compatible)
const result2 = getValidationMessage('ACCOUNT_CATEGORY', 'NAME_ALREADY_EXISTS', {
  name: 'Marketing',
});

console.log(result.content); // "Account category with the same name 'Marketing' already exists"
console.log(result.affectedFields); // ['name']

// In API responses
return reply.status(400).send({
  message: result.content,
  affectedFields: result.affectedFields,
});

Migration from v1.0.x

See MIGRATION_GUIDE.md for detailed migration instructions.

Quick update:

// Old (v1.0.x)
const message = getValidationMessage('FEATURE', 'ERROR');

// New (v1.1.0+)
const { content, affectedFields } = getValidationMessage('FEATURE', 'ERROR');

Documentation

• Migration Guide - Upgrading from v1.0.x
• Implementation Summary - Technical details
• Backend Update Checklist - Step-by-step backend migration
• Example Usage - Code examples