@forwardslashns/taskit-validation-messages 1.0.64 → 1.1.0

package/.env.example

@@ -0,0 +1 @@
+NPM_TOKEN=your_npm_token_here

package/PUBLISHING.md

@@ -0,0 +1,78 @@
+# Publishing Guide
+
+## Prerequisites
+
+You need a valid NPM access token with publish permissions for the `@forwardslashns` scope.
+
+### Generate a New Token (if needed)
+
+1. Go to https://www.npmjs.com/settings/YOUR_USERNAME/tokens
+2. Click "Generate New Token"
+3. Choose "Classic Token"
+4. Select "Automation" or "Publish" type
+5. Copy the token (starts with `npm_`)
+
+**Important:** The token must be associated with the `forwardslashns` npm account that has publish permissions for `@forwardslashns/taskit-validation-messages`.
+
+## Setup
+
+1. **Create `.env` file** (first time only):
+   ```bash
+   cp .env.example .env
+   ```
+
+2. **Add your NPM token** to `.env`:
+   ```
+   NPM_TOKEN=npm_your_actual_token_here
+   ```
+
+   Make sure to use the **full token** (should be 40+ characters starting with `npm_`)
+
+## Publishing
+
+Run the publish script:
+
+```powershell
+pnpm run publish:token
+```
+
+Or directly:
+
+```powershell
+.\publish.ps1
+```
+
+## Troubleshooting
+
+### "Access token expired or revoked"
+
+This means your token is either:
+- **Expired** - Generate a new token from npm
+- **Invalid** - Check you copied the complete token
+- **No permissions** - Token must belong to `forwardslashns` npm account with publish rights
+
+**Solution:** Generate a fresh token from the npm account that owns the package.
+
+### "Not in this registry"
+
+- Verify the package exists: `npm view @forwardslashns/taskit-validation-messages`
+- Ensure you have publish permissions for the `@forwardslashns` scope
+
+### Token not loading
+
+- Verify `.env` exists and contains `NPM_TOKEN=...`
+- Check token has no extra spaces or quotes
+- Run `Get-Content .env` to verify the file
+
+## How It Works
+
+1. Script loads `NPM_TOKEN` from `.env` file
+2. Temporarily replaces `${NPM_TOKEN}` in `.npmrc` with actual token
+3. Runs `pnpm publish`
+4. Restores original `.npmrc` (keeps token out of git)
+
+## Security
+
+- `.env` is in `.gitignore` - never commit it
+- `.npmrc` uses `${NPM_TOKEN}` placeholder - safe to commit
+- Token is only in memory during publish

package/README.md

@@ -2,6 +2,13 @@
 
 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
+- **Dynamic parameter substitution** for contextual messages
+- **Affected fields tracking** for better frontend UX (v1.1.0+)
+
 # 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.
@@ -9,3 +16,55 @@ The package exposes validation messages that can be retrieved using specific ali
 # 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:
+
+```typescript
+{
+  content: string;          // The formatted validation message
+  affectedFields: string[]; // Array of field identifiers affected by this validation error
+}
+```
+
+## Usage
+
+```typescript
+import { getValidationMessage } from '@forwardslashns/taskit-validation-messages';
+
+// Simple usage
+const result = 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](./MIGRATION_GUIDE.md) for detailed migration instructions.
+
+**Quick update:**
+
+```typescript
+// Old (v1.0.x)
+const message = getValidationMessage('FEATURE', 'ERROR');
+
+// New (v1.1.0+)
+const { content, affectedFields } = getValidationMessage('FEATURE', 'ERROR');
+```
+
+## Documentation
+
+- [Migration Guide](./MIGRATION_GUIDE.md) - Upgrading from v1.0.x
+- [Implementation Summary](./IMPLEMENTATION_SUMMARY.md) - Technical details
+- [Backend Update Checklist](./BACKEND_UPDATE_CHECKLIST.md) - Step-by-step backend migration
+- [Example Usage](./example-usage.ts) - Code examples

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { getValidationMessage } from './validation/validation-message.formatter';
+import { getValidationMessage, ValidationMessageResult } from './validation/validation-message.formatter';
 import { VALIDATION_MESSAGES } from './validation/validation-messages';
-export { VALIDATION_MESSAGES, getValidationMessage };
+export { VALIDATION_MESSAGES, 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,MAAM,2CAA2C,CAAC;AACjF,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAEvE,OAAO,EAAE,mBAAmB,EAAE,oBAAoB,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,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAEvE,OAAO,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,uBAAuB,EAAE,CAAC"}

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

@@ -7,6 +7,10 @@ type ErrorMessageParams<F extends Features, E extends ErrorType<F>> = (typeof VA
 type MessageParams<T extends readonly string[]> = {
     [K in T[number]]: string;
 };
-export declare const getValidationMessage: <FeatureType extends Features, FeatureErrorType extends ErrorType<FeatureType>>(feature: FeatureType, featureError: FeatureErrorType, params?: MessageParams<ErrorMessageParams<FeatureType, FeatureErrorType>>) => string;
+export type ValidationMessageResult = {
+    content: string;
+    affectedFields: string[];
+};
+export declare const getValidationMessage: <FeatureType extends Features, FeatureErrorType extends ErrorType<FeatureType>>(feature: FeatureType, featureError: FeatureErrorType, 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;AAM/E,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,MA4CF,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;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"}

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

@@ -35,6 +35,9 @@ const getValidationMessage = (feature, featureError, params) => {
     expectedParams.forEach((param) => {
         message = message.replaceAll(`{${param}}`, inputParams[param]);
     });
-    return message;
+    return {
+        content: message,
+        affectedFields: messageConfig.affectedFields ? [...messageConfig.affectedFields] : [],
+    };
 };
 exports.getValidationMessage = getValidationMessage;