Merge pull request #3 from arizworld/feat/npm_pulish

Dev - fixed prettier issue

Author: aritradevelops

CHANGELOG.md

@@ -1,12 +1,14 @@
 # Changelog
 
 _This changelog follows the [keep a changelog][keep-a-changelog]_ format to maintain a human readable changelog.
+
 ### [0.0.1](https://github.com/arizworld/class-validator-custom-errors/pull/1/) (2024-03-21)
 
 ### Added
+
 - added `transformFunction` in validatorOptions to customize the message for each time of validation.
-- added `transformKey` in validationOptions to pass specific keys to transformFunction for 
-specific properties.
+- added `transformKey` in validationOptions to pass specific keys to transformFunction for
+  specific properties.
 
 ### [0.14.0](https://github.com/typestack/class-validator/compare/v0.13.2...v0.14.0) (2022-12-09)
 

README.md

@@ -80,7 +80,7 @@ validate(post, {
     //pass a transform function to overwrite the default implementation for this validation only
     transformFunction: (key: string) => `I was called with ${key}`,
   },
-}).then((errors) => {
+}).then(errors => {
   // errors is an array of validation errors
   if (errors.length > 0) {
     console.log('validation failed. errors: ', errors);
@@ -94,23 +94,20 @@ validateOrReject(post, {
     //pass a transform function to overwrite the default implementation for this validation only
     transformFunction: (key: string) => `I was called with ${key}`,
   },
-}).catch((errors) => {
+}).catch(errors => {
   console.log('Promise rejected (validation failed). Errors: ', errors);
 });
 // or
 async function validateOrRejectExample(input: any) {
   try {
-    await validateOrReject(input,{
+    await validateOrReject(input, {
       validationError: {
         //pass a transform function to overwrite the default implementation for this validation only
         transformFunction: (key: string) => `I was called with ${key}`,
       },
     });
   } catch (errors) {
-    console.log(
-      'Caught promise rejection (validation failed). Errors: ',
-      errors
-    );
+    console.log('Caught promise rejection (validation failed). Errors: ', errors);
   }
 }
 ```
@@ -257,6 +254,7 @@ import app from './server'
   console.log('responseFrench: ', JSON.stringify(responseFrench.json(), null, 2))
 })()
 ```
+
 See this for more of the basic [class-validator documentation](https://github.com/typestack/class-validator)
 
 ## Validation decorators
@@ -384,5 +382,3 @@ See this for more of the basic [class-validator documentation](https://github.co
 
 Take a look on samples in [./sample](https://github.com/arizworld/class-validator-custom-errors/tree/develop/sample) for more examples of
 usages.
-
-

docs/basics/validating-objects.md

@@ -57,4 +57,3 @@ async function awaitExample() {
   }
 }
 ```
-

docs/introduction/installation.md

@@ -5,4 +5,3 @@ To install the stable version:
 ```
 npm install --save class-validator-custom-errors
 ```
-

sample/basic-usage/index.ts

@@ -1,15 +1,4 @@
-import {
-  validate,
-  validateOrReject,
-  Contains,
-  IsInt,
-  Length,
-  IsEmail,
-  IsFQDN,
-  IsDate,
-  Min,
-  Max,
-} from '../../src';
+import { validate, validateOrReject, Contains, IsInt, Length, IsEmail, IsFQDN, IsDate, Min, Max } from '../../src';
 
 export class Post {
   @Length(10, 20)
@@ -47,7 +36,7 @@ validate(post, {
     //pass a transform function to overwrite the default implemention for this validation only
     transformFunction: (key: string) => `I was called with ${key}`,
   },
-}).then((errors) => {
+}).then(errors => {
   // errors is an array of validation errors
   if (errors.length > 0) {
     console.log('validation failed. errors: ', errors);
@@ -61,7 +50,7 @@ validateOrReject(post, {
     //pass a transform function to overwrite the default implemention for this validation only
     transformFunction: (key: string) => `I was called with ${key}`,
   },
-}).catch((errors) => {
+}).catch(errors => {
   console.log('Promise rejected (validation failed). Errors: ', errors);
 });
 // or
@@ -74,9 +63,6 @@ async function validateOrRejectExample(input: any) {
       },
     });
   } catch (errors) {
-    console.log(
-      'Caught promise rejection (validation failed). Errors: ',
-      errors
-    );
+    console.log('Caught promise rejection (validation failed). Errors: ', errors);
   }
 }

sample/i18next/Readme.md

@@ -1 +1 @@
-This repo shows an example of integrating internationalization and validation with i18next and class-validator-custom-errors
+This repo shows an example of integrating internationalization and validation with i18next and class-validator-custom-errors

sample/i18next/src/main.ts

@@ -1,23 +1,23 @@
-import inject from 'light-my-request'
-import app from './server'
+import inject from 'light-my-request';
+import app from './server';
 (async function () {
   const responseEnglish = await inject(app, {
     method: 'POST',
     url: '/urls/create',
     headers: {
-      "content-type": "application/json"
+      'content-type': 'application/json',
     },
-    payload: JSON.stringify({ query: {} })
-  })
-  console.log('responseEnglish: ', JSON.stringify(responseEnglish.json(), null, 2))
+    payload: JSON.stringify({ query: {} }),
+  });
+  console.log('responseEnglish: ', JSON.stringify(responseEnglish.json(), null, 2));
   const responseFrench = await inject(app, {
     method: 'POST',
     url: '/urls/create',
     headers: {
-      "content-type": "application/json",
-      "accept-language": "fr"
+      'content-type': 'application/json',
+      'accept-language': 'fr',
     },
-    payload: JSON.stringify({ query: {} })
-  })
-  console.log('responseFrench: ', JSON.stringify(responseFrench.json(), null, 2))
-})()
+    payload: JSON.stringify({ query: {} }),
+  });
+  console.log('responseFrench: ', JSON.stringify(responseFrench.json(), null, 2));
+})();

sample/i18next/src/schemas/Url.ts

@@ -1,38 +1,38 @@
-import { Type } from "class-transformer";
-import { IsArray, IsEnum, IsObject, IsOptional, IsString, ValidateNested } from "class-validator-custom-errors";
+import { Type } from 'class-transformer';
+import { IsArray, IsEnum, IsObject, IsOptional, IsString, ValidateNested } from 'class-validator-custom-errors';
 
 export enum HttpProtocols {
-  http = "http",
-  https = "https",
-  ws = "ws",
-  wss = "wss",
-  ftp = "ftp"
+  http = 'http',
+  https = 'https',
+  ws = 'ws',
+  wss = 'wss',
+  ftp = 'ftp',
 }
 
 export class Query {
   @IsString()
-  search!: string
+  search!: string;
 
   @IsArray()
   @IsOptional()
   @ValidateNested()
-  select: string[] = []
+  select: string[] = [];
 }
 
 export class Url {
   @IsString({
-    transformKey: 'uniqueString'
+    transformKey: 'uniqueString',
   })
-  host!: string
+  host!: string;
 
   @IsEnum(HttpProtocols)
-  protocol!: string
+  protocol!: string;
 
   @IsString()
-  tld!: string
+  tld!: string;
 
   @IsObject()
   @ValidateNested()
   @Type(() => Query)
-  query!: Query
-}
+  query!: Query;
+}

sample/i18next/src/server.ts

@@ -1,29 +1,25 @@
-import express, { NextFunction, Request, Response } from 'express'
+import express, { NextFunction, Request, Response } from 'express';
 import i18next from 'i18next';
-import middleware from 'i18next-http-middleware'
-import './utils/i18nextSetup'
-import 'reflect-metadata'
+import middleware from 'i18next-http-middleware';
+import './utils/i18nextSetup';
+import 'reflect-metadata';
 import { validateOrReject } from 'class-validator-custom-errors';
 import { plainToClass } from 'class-transformer';
 import { Url } from './schemas/Url';
-const app = express()
-app.use([
-  middleware.handle(i18next),
-  express.json(),
-  express.urlencoded({ extended: true }),
-]);
+const app = express();
+app.use([middleware.handle(i18next), express.json(), express.urlencoded({ extended: true })]);
 app.post('/urls/create', async (req: Request, res: Response, next: NextFunction) => {
   try {
     await validateOrReject(plainToClass(Url, req.body), {
       whitelist: true,
       validationError: {
         target: false,
-        transformFunction: (key: string) => req.t(`validation.${key}`)
-      }
-    })
-    res.json({ success: true, message: req.t("success"), errors: null })
+        transformFunction: (key: string) => req.t(`validation.${key}`),
+      },
+    });
+    res.json({ success: true, message: req.t('success'), errors: null });
   } catch (error) {
-    res.json({ success: false, message: req.t("failure"), errors: error })
+    res.json({ success: false, message: req.t('failure'), errors: error });
   }
-})
-export default app
+});
+export default app;

sample/i18next/src/utils/i18nextSetup.ts

@@ -1,14 +1,13 @@
-import i18next from "i18next";
-import I18NexFsBackend from "i18next-fs-backend";
-import middleware from 'i18next-http-middleware'
+import i18next from 'i18next';
+import I18NexFsBackend from 'i18next-fs-backend';
+import middleware from 'i18next-http-middleware';
 
 i18next
   .use(I18NexFsBackend)
   .use(middleware.LanguageDetector)
   .init({
-    fallbackLng: "en",
+    fallbackLng: 'en',
     backend: {
-      loadPath: "./locales/{{lng}}/translation.json",
+      loadPath: './locales/{{lng}}/translation.json',
     },
   });
-

src/decorator/ValidationOptions.ts

@@ -33,7 +33,7 @@ export interface ValidationOptions {
   /**
    * While using transformFunction if provided then the transformFunction will be called with this.
    */
-  transformKey?: string
+  transformKey?: string;
 }
 
 export function isValidationOptions(val: any): val is ValidationOptions {

src/metadata/ValidationMetadata.ts

@@ -47,7 +47,7 @@ export class ValidationMetadata {
   /**
    * While using transformFunction to customize error messages the transformFunction will be called with this key.
    */
-  transformKey?: string
+  transformKey?: string;
   /**
    * Validation groups used for this validation.
    */

src/validation/ValidationExecutor.ts

@@ -30,7 +30,7 @@ export class ValidationExecutor {
   // Constructor
   // -------------------------------------------------------------------------
 
-  constructor(private validator: Validator, private validatorOptions?: ValidatorOptions) { }
+  constructor(private validator: Validator, private validatorOptions?: ValidatorOptions) {}
 
   // -------------------------------------------------------------------------
   // Public Methods
@@ -46,8 +46,8 @@ export class ValidationExecutor {
     if (!this.metadataStorage.hasValidationMetaData && this.validatorOptions?.enableDebugMessages === true) {
       console.warn(
         `No validation metadata found. No validation will be  performed. There are multiple possible reasons:\n` +
-        `  - There may be multiple class-validator versions installed. You will need to flatten your dependencies to fix the issue.\n` +
-        `  - This validation runs before any file with validation decorator was parsed by NodeJS.`
+          `  - There may be multiple class-validator versions installed. You will need to flatten your dependencies to fix the issue.\n` +
+          `  - This validation runs before any file with validation decorator was parsed by NodeJS.`
       );
     }
 
@@ -68,15 +68,30 @@ export class ValidationExecutor {
     const groupedMetadatas = this.metadataStorage.groupByPropertyName(targetMetadatas);
 
     /**if transformationFunction is provided then overwrite the message with the transformationFunction */
-    if (this.validatorOptions?.validationError?.transformFunction && typeof this.validatorOptions?.validationError?.transformFunction === 'function') {
+    if (
+      this.validatorOptions?.validationError?.transformFunction &&
+      typeof this.validatorOptions?.validationError?.transformFunction === 'function'
+    ) {
       targetMetadatas.forEach(e => {
-        e.message = () => (this.validatorOptions?.validationError?.transformFunction as Function)(e.transformKey || e.name || e.type || 'This validation does not have an name or type associated with it, please add one.')
+        e.message = () =>
+          (this.validatorOptions?.validationError?.transformFunction as Function)(
+            e.transformKey ||
+              e.name ||
+              e.type ||
+              'This validation does not have an name or type associated with it, please add one.'
+          );
       });
       Object.keys(groupedMetadatas).forEach(prop => {
         groupedMetadatas[prop].forEach(e => {
-          e.message = () => (this.validatorOptions?.validationError?.transformFunction as Function)(e.transformKey || e.name || e.type || 'This validation does not have an name or type associated with it, please add one.')
+          e.message = () =>
+            (this.validatorOptions?.validationError?.transformFunction as Function)(
+              e.transformKey ||
+                e.name ||
+                e.type ||
+                'This validation does not have an name or type associated with it, please add one.'
+            );
         });
-      })
+      });
     }
 
     if (forbidUnknownValues && !targetMetadatas.length) {

src/validation/ValidatorOptions.ts

@@ -75,7 +75,7 @@ export interface ValidatorOptions {
      * @param key the name of the error.
      * @returns string. it will be shown instead of the default error message.
      */
-    transformFunction?: (key: string) => string
+    transformFunction?: (key: string) => string;
   };
 
   /**