test: add unit tests, minor updates

packages/common/pipes/index.ts

@@ -1,9 +1,10 @@
 export * from './default-value.pipe';
+export * from './file';
 export * from './parse-array.pipe';
 export * from './parse-bool.pipe';
-export * from './parse-int.pipe';
-export * from './parse-float.pipe';
+export * from './parse-date.pipe';
 export * from './parse-enum.pipe';
+export * from './parse-float.pipe';
+export * from './parse-int.pipe';
 export * from './parse-uuid.pipe';
 export * from './validation.pipe';
-export * from './file';

packages/common/pipes/parse-array.pipe.ts

@@ -7,7 +7,7 @@ import {
   PipeTransform,
 } from '../interfaces/features/pipe-transform.interface';
 import { HttpErrorByCode } from '../utils/http-error-by-code.util';
-import { isNil, isUndefined, isString } from '../utils/shared.utils';
+import { isNil, isString, isUndefined } from '../utils/shared.utils';
 import { ValidationPipe, ValidationPipeOptions } from './validation.pipe';
 
 const VALIDATION_ERROR_MESSAGE = 'Validation failed (parsable array expected)';
@@ -21,9 +21,26 @@ export interface ParseArrayOptions
     ValidationPipeOptions,
     'transform' | 'validateCustomDecorators' | 'exceptionFactory'
   > {
+  /**
+   * Type for items to be converted into
+   */
   items?: Type<unknown>;
+  /**
+   * Items separator to split string by
+   * @default ','
+   */
   separator?: string;
+  /**
+   * If true, the pipe will return null or undefined if the value is not provided
+   * @default false
+   */
   optional?: boolean;
+  /**
+   * A factory function that returns an exception object to be thrown
+   * if validation fails.
+   * @param error Error message or object
+   * @returns The exception object
+   */
   exceptionFactory?: (error: any) => any;
 }
 

packages/common/pipes/parse-bool.pipe.ts

@@ -15,8 +15,21 @@ import { isNil } from '../utils/shared.utils';
  * @publicApi
  */
 export interface ParseBoolPipeOptions {
+  /**
+   * The HTTP status code to be used in the response when the validation fails.
+   */
   errorHttpStatusCode?: ErrorHttpStatusCode;
+  /**
+   * A factory function that returns an exception object to be thrown
+   * if validation fails.
+   * @param error Error message
+   * @returns The exception object
+   */
   exceptionFactory?: (error: string) => any;
+  /**
+   * If true, the pipe will return null or undefined if the value is not provided
+   * @default false
+   */
   optional?: boolean;
 }
 

packages/common/pipes/parse-date.pipe.ts

@@ -0,0 +1,74 @@
+import { Injectable } from '../decorators/core/injectable.decorator';
+import { HttpStatus } from '../enums/http-status.enum';
+import { PipeTransform } from '../interfaces/features/pipe-transform.interface';
+import {
+  ErrorHttpStatusCode,
+  HttpErrorByCode,
+} from '../utils/http-error-by-code.util';
+import { isNil } from '../utils/shared.utils';
+
+export interface ParseDatePipeOptions {
+  /**
+   * If true, the pipe will return null or undefined if the value is not provided
+   * @default false
+   */
+  optional?: boolean;
+  /**
+   * Default value for the date
+   */
+  default?: () => Date;
+  /**
+   * The HTTP status code to be used in the response when the validation fails.
+   */
+  errorHttpStatusCode?: ErrorHttpStatusCode;
+  /**
+   * A factory function that returns an exception object to be thrown
+   * if validation fails.
+   * @param error Error message
+   * @returns The exception object
+   */
+  exceptionFactory?: (error: string) => any;
+}
+
+@Injectable()
+export class ParseDatePipe
+  implements PipeTransform<string | number | undefined | null>
+{
+  protected exceptionFactory: (error: string) => any;
+
+  constructor(private readonly options: ParseDatePipeOptions = {}) {
+    const { exceptionFactory, errorHttpStatusCode = HttpStatus.BAD_REQUEST } =
+      options;
+
+    this.exceptionFactory =
+      exceptionFactory ||
+      (error => new HttpErrorByCode[errorHttpStatusCode](error));
+  }
+
+  /**
+   * Method that accesses and performs optional transformation on argument for
+   * in-flight requests.
+   *
+   * @param value currently processed route argument
+   * @param metadata contains metadata about the currently processed route argument
+   */
+  transform(value: string | number | undefined | null): Date {
+    if (this.options.optional && isNil(value)) {
+      return this.options.default
+        ? this.options.default()
+        : (value as undefined | null);
+    }
+
+    if (!value) {
+      throw this.exceptionFactory('Validation failed (no Date provided)');
+    }
+
+    const transformedValue = new Date(value);
+
+    if (isNaN(transformedValue.getTime())) {
+      throw this.exceptionFactory('Validation failed (invalid date format)');
+    }
+
+    return transformedValue;
+  }
+}

packages/common/pipes/parse-enum.pipe.ts

@@ -11,8 +11,21 @@ import { isNil } from '../utils/shared.utils';
  * @publicApi
  */
 export interface ParseEnumPipeOptions {
+  /**
+   * If true, the pipe will return null or undefined if the value is not provided
+   * @default false
+   */
   optional?: boolean;
+  /**
+   * The HTTP status code to be used in the response when the validation fails.
+   */
   errorHttpStatusCode?: ErrorHttpStatusCode;
+  /**
+   * A factory function that returns an exception object to be thrown
+   * if validation fails.
+   * @param error Error message
+   * @returns The exception object
+   */
   exceptionFactory?: (error: string) => any;
 }
 

packages/common/pipes/parse-float.pipe.ts

@@ -11,8 +11,21 @@ import { isNil } from '../utils/shared.utils';
  * @publicApi
  */
 export interface ParseFloatPipeOptions {
+  /**
+   * The HTTP status code to be used in the response when the validation fails.
+   */
   errorHttpStatusCode?: ErrorHttpStatusCode;
+  /**
+   * A factory function that returns an exception object to be thrown
+   * if validation fails.
+   * @param error Error message
+   * @returns The exception object
+   */
   exceptionFactory?: (error: string) => any;
+  /**
+   * If true, the pipe will return null or undefined if the value is not provided
+   * @default false
+   */
   optional?: boolean;
 }
 

packages/common/pipes/parse-int.pipe.ts

@@ -15,8 +15,21 @@ import { isNil } from '../utils/shared.utils';
  * @publicApi
  */
 export interface ParseIntPipeOptions {
+  /**
+   * The HTTP status code to be used in the response when the validation fails.
+   */
   errorHttpStatusCode?: ErrorHttpStatusCode;
+  /**
+   * A factory function that returns an exception object to be thrown
+   * if validation fails.
+   * @param error Error message
+   * @returns The exception object
+   */
   exceptionFactory?: (error: string) => any;
+  /**
+   * If true, the pipe will return null or undefined if the value is not provided
+   * @default false
+   */
   optional?: boolean;
 }
 

packages/common/pipes/parse-uuid.pipe.ts

@@ -15,9 +15,25 @@ import { isNil, isString } from '../utils/shared.utils';
  * @publicApi
  */
 export interface ParseUUIDPipeOptions {
+  /**
+   * UUID version to validate
+   */
   version?: '3' | '4' | '5' | '7';
+  /**
+   * The HTTP status code to be used in the response when the validation fails.
+   */
   errorHttpStatusCode?: ErrorHttpStatusCode;
+  /**
+   * A factory function that returns an exception object to be thrown
+   * if validation fails.
+   * @param error Error message
+   * @returns The exception object
+   */
   exceptionFactory?: (errors: string) => any;
+  /**
+   * If true, the pipe will return null or undefined if the value is not provided
+   * @default false
+   */
   optional?: boolean;
 }
 

packages/common/test/pipes/parse-date.pipe.spec.ts

@@ -0,0 +1,71 @@
+import { expect } from 'chai';
+import { BadRequestException } from '../../exceptions';
+import { ParseDatePipe } from '../../pipes/parse-date.pipe';
+
+describe('ParseDatePipe', () => {
+  let target: ParseDatePipe;
+
+  beforeEach(() => {
+    target = new ParseDatePipe();
+  });
+
+  describe('transform', () => {
+    describe('when validation passes', () => {
+      it('should return a valid date object', () => {
+        const date = new Date().toISOString();
+
+        const transformedDate = target.transform(date);
+        expect(transformedDate).to.be.instanceOf(Date);
+        expect(transformedDate.toISOString()).to.equal(date);
+
+        const asNumber = transformedDate.getTime();
+        const transformedNumber = target.transform(asNumber);
+        expect(transformedNumber).to.be.instanceOf(Date);
+        expect(transformedNumber.getTime()).to.equal(asNumber);
+      });
+
+      it('should not throw an error if the value is undefined/null and optional is true', () => {
+        const target = new ParseDatePipe({ optional: true });
+        const value = target.transform(undefined);
+        expect(value).to.equal(undefined);
+      });
+    });
+    describe('when default value is provided', () => {
+      it('should return the default value if the value is undefined/null', () => {
+        const defaultValue = new Date();
+        const target = new ParseDatePipe({
+          optional: true,
+          default: () => defaultValue,
+        });
+        const value = target.transform(undefined);
+        expect(value).to.equal(defaultValue);
+      });
+    });
+    describe('when validation fails', () => {
+      it('should throw an error', () => {
+        try {
+          target.transform('123abc');
+          expect.fail();
+        } catch (error) {
+          expect(error).to.be.instanceOf(BadRequestException);
+          expect(error.message).to.equal(
+            'Validation failed (invalid date format)',
+          );
+        }
+      });
+    });
+    describe('when empty value', () => {
+      it('should throw an error', () => {
+        try {
+          target.transform('');
+          expect.fail();
+        } catch (error) {
+          expect(error).to.be.instanceOf(BadRequestException);
+          expect(error.message).to.equal(
+            'Validation failed (no Date provided)',
+          );
+        }
+      });
+    });
+  });
+});