@forwardslashns/taskit-validation-messages 1.3.0 → 1.3.2

package/README.md

@@ -6,9 +6,51 @@ This package provides a centralized list of validation messages used across both
 
 - **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:
+
+```typescript
+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
+
+```typescript
+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_TYPE_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.
@@ -31,10 +73,13 @@ This mechanism allows for the retrieval and dynamic creation of validation messa
 ## Usage
 
 ```typescript
-import { getValidationMessage } from '@forwardslashns/taskit-validation-messages';
+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' });
 
-// Simple usage
-const result = getValidationMessage('ACCOUNT_CATEGORY', 'NAME_ALREADY_EXISTS', {
+// Also works: String literals (backward compatible)
+const result2 = getValidationMessage('ACCOUNT_CATEGORY', 'NAME_ALREADY_EXISTS', {
   name: 'Marketing',
 });
 

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 import { getValidationMessage, ValidationMessageResult } from './validation/validation-message.formatter';
-import { VALIDATION_MESSAGES } from './validation/validation-messages';
-export { VALIDATION_MESSAGES, getValidationMessage, ValidationMessageResult };
+import { VALIDATION } from './validation/validation-constants';
+export { VALIDATION, getValidationMessage, ValidationMessageResult };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,uBAAuB,EAAE,MAAM,2CAA2C,CAAC;AAC1G,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAEvE,OAAO,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,uBAAuB,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,uBAAuB,EAAE,MAAM,2CAA2C,CAAC;AAC1G,OAAO,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAC;AAE/D,OAAO,EAAE,UAAU,EAAE,oBAAoB,EAAE,uBAAuB,EAAE,CAAC"}

package/dist/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getValidationMessage = exports.VALIDATION_MESSAGES = void 0;
+exports.getValidationMessage = exports.VALIDATION = void 0;
 const validation_message_formatter_1 = require("./validation/validation-message.formatter");
 Object.defineProperty(exports, "getValidationMessage", { enumerable: true, get: function () { return validation_message_formatter_1.getValidationMessage; } });
-const validation_messages_1 = require("./validation/validation-messages");
-Object.defineProperty(exports, "VALIDATION_MESSAGES", { enumerable: true, get: function () { return validation_messages_1.VALIDATION_MESSAGES; } });
+const validation_constants_1 = require("./validation/validation-constants");
+Object.defineProperty(exports, "VALIDATION", { enumerable: true, get: function () { return validation_constants_1.VALIDATION; } });

package/dist/validation/validation-constants.d.ts

@@ -0,0 +1,5 @@
+import { VALIDATION_MESSAGES } from './validation-messages';
+export declare const VALIDATION: { [F in keyof typeof VALIDATION_MESSAGES]: {
+    readonly FEATURE: F;
+} & { [K in keyof (typeof VALIDATION_MESSAGES)[F]]: `${F}.${K & string}`; }; };
+//# sourceMappingURL=validation-constants.d.ts.map

package/dist/validation/validation-constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation-constants.d.ts","sourceRoot":"","sources":["../../src/validation/validation-constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAmB5D,eAAO,MAAM,UAAU,EAAkC,GACtD,CAAC,IAAI,MAAM,OAAO,mBAAmB,GAAG;IACvC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;CACrB,GAAG,GACD,CAAC,IAAI,MAAM,CAAC,OAAO,mBAAmB,EAAE,CAAC,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,GAAG,MAAM,EAAE,GACnE,GACF,CAAC"}

package/dist/validation/validation-constants.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VALIDATION = void 0;
+const validation_messages_1 = require("./validation-messages");
+const createValidationConstants = () => {
+    const result = {};
+    for (const feature in validation_messages_1.VALIDATION_MESSAGES) {
+        result[feature] = {
+            FEATURE: feature,
+        };
+        const messages = validation_messages_1.VALIDATION_MESSAGES[feature];
+        for (const messageKey in messages) {
+            result[feature][messageKey] = `${feature}.${messageKey}`;
+        }
+    }
+    return result;
+};
+exports.VALIDATION = createValidationConstants();

package/dist/validation/validation-message.formatter.d.ts

@@ -10,7 +10,8 @@ type MessageParams<T extends readonly string[]> = {
 export type ValidationMessageResult = {
     content: string;
     affectedFields: string[];
+    feature: string;
 };
-export declare const getValidationMessage: <FeatureType extends Features, FeatureErrorType extends ErrorType<FeatureType>>(feature: FeatureType, featureError: FeatureErrorType, params?: MessageParams<ErrorMessageParams<FeatureType, FeatureErrorType>>) => ValidationMessageResult;
+export declare const getValidationMessage: <FeatureType extends Features, FeatureErrorType extends ErrorType<FeatureType>>(combinedKey: `${FeatureType}.${FeatureErrorType & string}`, params?: MessageParams<ErrorMessageParams<FeatureType, FeatureErrorType>>) => ValidationMessageResult;
 export {};
 //# sourceMappingURL=validation-message.formatter.d.ts.map

package/dist/validation/validation-message.formatter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validation-message.formatter.d.ts","sourceRoot":"","sources":["../../src/validation/validation-message.formatter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,KAAK,QAAQ,GAAG,MAAM,OAAO,mBAAmB,CAAC;AACjD,KAAK,SAAS,CAAC,CAAC,SAAS,QAAQ,IAAI,MAAM,CAAC,OAAO,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC;AAC3E,KAAK,kBAAkB,CAAC,CAAC,SAAS,QAAQ,EAAE,CAAC,SAAS,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;IAC/G,MAAM,EAAE,MAAM,CAAC,SAAS,SAAS,MAAM,EAAE,CAAC;CAC3C,GACG,CAAC,GACD,EAAE,CAAC;AACP,KAAK,aAAa,CAAC,CAAC,SAAS,SAAS,MAAM,EAAE,IAAI;KAAG,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,MAAM;CAAE,CAAC;AAO/E,MAAM,MAAM,uBAAuB,GAAG;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,EAAE,CAAC;CAC1B,CAAC;AAEF,eAAO,MAAM,oBAAoB,GAAI,WAAW,SAAS,QAAQ,EAAE,gBAAgB,SAAS,SAAS,CAAC,WAAW,CAAC,EAChH,SAAS,WAAW,EACpB,cAAc,gBAAgB,EAC9B,SAAS,aAAa,CAAC,kBAAkB,CAAC,WAAW,EAAE,gBAAgB,CAAC,CAAC,KACxE,uBA+CF,CAAC"}
+{"version":3,"file":"validation-message.formatter.d.ts","sourceRoot":"","sources":["../../src/validation/validation-message.formatter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,KAAK,QAAQ,GAAG,MAAM,OAAO,mBAAmB,CAAC;AACjD,KAAK,SAAS,CAAC,CAAC,SAAS,QAAQ,IAAI,MAAM,CAAC,OAAO,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC;AAC3E,KAAK,kBAAkB,CAAC,CAAC,SAAS,QAAQ,EAAE,CAAC,SAAS,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;IAC/G,MAAM,EAAE,MAAM,CAAC,SAAS,SAAS,MAAM,EAAE,CAAC;CAC3C,GACG,CAAC,GACD,EAAE,CAAC;AACP,KAAK,aAAa,CAAC,CAAC,SAAS,SAAS,MAAM,EAAE,IAAI;KAAG,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,MAAM;CAAE,CAAC;AAO/E,MAAM,MAAM,uBAAuB,GAAG;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,eAAO,MAAM,oBAAoB,GAAI,WAAW,SAAS,QAAQ,EAAE,gBAAgB,SAAS,SAAS,CAAC,WAAW,CAAC,EAChH,aAAa,GAAG,WAAW,IAAI,gBAAgB,GAAG,MAAM,EAAE,EAC1D,SAAS,aAAa,CAAC,kBAAkB,CAAC,WAAW,EAAE,gBAAgB,CAAC,CAAC,KACxE,uBAoDF,CAAC"}

package/dist/validation/validation-message.formatter.js

@@ -2,7 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getValidationMessage = void 0;
 const validation_messages_1 = require("./validation-messages");
-const getValidationMessage = (feature, featureError, params) => {
+const getValidationMessage = (combinedKey, params) => {
+    const parts = combinedKey.split('.');
+    const feature = parts[0];
+    const featureError = parts[1];
     const messageConfig = validation_messages_1.VALIDATION_MESSAGES[feature][featureError];
     if (!messageConfig) {
         throw new Error(`Validation error message is not defined properly in configuration for feature: '${String(feature)}', error: '${String(featureError)}')`);
@@ -38,6 +41,7 @@ const getValidationMessage = (feature, featureError, params) => {
     return {
         content: message,
         affectedFields: messageConfig.affectedFields ? [...messageConfig.affectedFields] : [],
+        feature: feature,
     };
 };
 exports.getValidationMessage = getValidationMessage;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forwardslashns/taskit-validation-messages",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "commonjs",

package/src/index.ts

@@ -1,4 +1,4 @@
 import { getValidationMessage, ValidationMessageResult } from './validation/validation-message.formatter';
-import { VALIDATION_MESSAGES } from './validation/validation-messages';
+import { VALIDATION } from './validation/validation-constants';
 
-export { VALIDATION_MESSAGES, getValidationMessage, ValidationMessageResult };
+export { VALIDATION, getValidationMessage, ValidationMessageResult };

package/src/validation/validation-constants.ts

@@ -0,0 +1,26 @@
+import { VALIDATION_MESSAGES } from './validation-messages';
+
+const createValidationConstants = () => {
+  const result: any = {};
+
+  for (const feature in VALIDATION_MESSAGES) {
+    result[feature] = {
+      FEATURE: feature,
+    };
+
+    const messages = VALIDATION_MESSAGES[feature as keyof typeof VALIDATION_MESSAGES];
+    for (const messageKey in messages) {
+      result[feature][messageKey] = `${feature}.${messageKey}`;
+    }
+  }
+
+  return result;
+};
+
+export const VALIDATION = createValidationConstants() as {
+  [F in keyof typeof VALIDATION_MESSAGES]: {
+    readonly FEATURE: F;
+  } & {
+    [K in keyof (typeof VALIDATION_MESSAGES)[F]]: `${F}.${K & string}`;
+  };
+};

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

@@ -17,13 +17,17 @@ type MessageConfig = {
 export type ValidationMessageResult = {
   content: string;
   affectedFields: string[];
+  feature: string;
 };
 
 export const getValidationMessage = <FeatureType extends Features, FeatureErrorType extends ErrorType<FeatureType>>(
-  feature: FeatureType,
-  featureError: FeatureErrorType,
+  combinedKey: `${FeatureType}.${FeatureErrorType & string}`,
   params?: MessageParams<ErrorMessageParams<FeatureType, FeatureErrorType>>
 ): ValidationMessageResult => {
+  const parts = combinedKey.split('.');
+  const feature = parts[0] as FeatureType;
+  const featureError = parts[1] as FeatureErrorType;
+
   const messageConfig = VALIDATION_MESSAGES[feature][featureError] as MessageConfig;
 
   if (!messageConfig) {
@@ -69,5 +73,6 @@ export const getValidationMessage = <FeatureType extends Features, FeatureErrorT
   return {
     content: message,
     affectedFields: messageConfig.affectedFields ? [...messageConfig.affectedFields] : [],
+    feature: feature,
   };
 };