feat(common): define type for file input

packages/common/pipes/file/file-type.validator.ts

@@ -1,4 +1,5 @@
 import { FileValidator } from './file-validator.interface';
+import { IFile } from './interfaces';
 
 export type FileTypeValidatorOptions = {
   fileType: string | RegExp;
@@ -20,17 +21,14 @@ export class FileTypeValidator extends FileValidator<FileTypeValidatorOptions> {
     return `Validation failed (expected type is ${this.validationOptions.fileType})`;
   }
 
-  isValid(file: any): boolean {
+  isValid<TFile extends IFile = any>(file: TFile): boolean {
     if (!this.validationOptions) {
       return true;
     }
 
-    if (!file.mimetype) {
-      return false;
-    }
-
-    return Boolean(
-      (file.mimetype as string).match(this.validationOptions.fileType),
+    return (
+      'mimetype' in file &&
+      !!file.mimetype.match(this.validationOptions.fileType)
     );
   }
 }

packages/common/pipes/file/file-validator.interface.ts

@@ -1,3 +1,5 @@
+import { IFile } from './interfaces';
+
 /**
  * Interface describing FileValidators, which can be added to a {@link ParseFilePipe}.
  *
@@ -10,7 +12,9 @@ export abstract class FileValidator<TValidationOptions = Record<string, any>> {
    * Indicates if this file should be considered valid, according to the options passed in the constructor.
    * @param file the file from the request object
    */
-  abstract isValid(file?: any): boolean | Promise<boolean>;
+  abstract isValid<TFile extends IFile = any>(
+    file?: TFile,
+  ): boolean | Promise<boolean>;
 
   /**
    * Builds an error message in case the validation fails.

packages/common/pipes/file/interfaces/file.interface.ts

@@ -0,0 +1,4 @@
+export interface IFile {
+  mimetype: string;
+  size: number;
+}

packages/common/pipes/file/interfaces/index.ts

@@ -0,0 +1 @@
+export * from './file.interface';

packages/common/pipes/file/max-file-size.validator.ts

@@ -1,4 +1,5 @@
 import { FileValidator } from './file-validator.interface';
+import { IFile } from './interfaces';
 
 export type MaxFileSizeValidatorOptions = {
   maxSize: number;
@@ -16,11 +17,11 @@ export class MaxFileSizeValidator extends FileValidator<MaxFileSizeValidatorOpti
     return `Validation failed (expected size is less than ${this.validationOptions.maxSize})`;
   }
 
-  public isValid(file: any): boolean {
+  public isValid<TFile extends IFile = any>(file: TFile): boolean {
     if (!this.validationOptions) {
       return true;
     }
 
-    return file.size < this.validationOptions.maxSize;
+    return 'size' in file && file.size < this.validationOptions.maxSize;
   }
 }

packages/common/test/pipes/file/file-type.validator.spec.ts

@@ -1,5 +1,5 @@
-import { FileTypeValidator } from '../../../pipes';
 import { expect } from 'chai';
+import { FileTypeValidator } from '../../../pipes';
 
 describe('FileTypeValidator', () => {
   describe('isValid', () => {
@@ -10,7 +10,7 @@ describe('FileTypeValidator', () => {
 
       const requestFile = {
         mimetype: 'image/jpeg',
-      };
+      } as any;
 
       expect(fileTypeValidator.isValid(requestFile)).to.equal(true);
     });
@@ -22,7 +22,7 @@ describe('FileTypeValidator', () => {
 
       const requestFile = {
         mimetype: 'image/jpeg',
-      };
+      } as any;
 
       expect(fileTypeValidator.isValid(requestFile)).to.equal(true);
     });
@@ -34,7 +34,7 @@ describe('FileTypeValidator', () => {
 
       const requestFile = {
         mimetype: 'application/msword',
-      };
+      } as any;
 
       expect(fileTypeValidator.isValid(requestFile)).to.equal(true);
     });
@@ -46,7 +46,7 @@ describe('FileTypeValidator', () => {
 
       const requestFile = {
         mimetype: 'image/png',
-      };
+      } as any;
 
       expect(fileTypeValidator.isValid(requestFile)).to.equal(false);
     });
@@ -58,7 +58,7 @@ describe('FileTypeValidator', () => {
 
       const requestFile = {
         mimetype: 'image/png',
-      };
+      } as any;
 
       expect(fileTypeValidator.isValid(requestFile)).to.equal(false);
     });
@@ -68,7 +68,7 @@ describe('FileTypeValidator', () => {
         fileType: 'image/jpeg',
       });
 
-      const requestFile = {};
+      const requestFile = {} as any;
 
       expect(fileTypeValidator.isValid(requestFile)).to.equal(false);
     });

packages/common/test/pipes/file/max-file-size.validator.spec.ts

@@ -12,7 +12,7 @@ describe('MaxFileSizeValidator', () => {
 
       const requestFile = {
         size: 100,
-      };
+      } as any;
 
       expect(maxFileSizeValidator.isValid(requestFile)).to.equal(true);
     });
@@ -24,7 +24,7 @@ describe('MaxFileSizeValidator', () => {
 
       const requestFile = {
         size: oneKb + 1,
-      };
+      } as any;
 
       expect(maxFileSizeValidator.isValid(requestFile)).to.equal(false);
     });
@@ -36,7 +36,7 @@ describe('MaxFileSizeValidator', () => {
 
       const requestFile = {
         size: oneKb,
-      };
+      } as any;
 
       expect(maxFileSizeValidator.isValid(requestFile)).to.equal(false);
     });

packages/common/test/pipes/file/parse-file-pipe.builder.spec.ts

@@ -1,7 +1,6 @@
 import { expect } from 'chai';
 import {
   FileTypeValidator,
-  FileTypeValidatorOptions,
   FileValidator,
   MaxFileSizeValidator,
   ParseFilePipeBuilder,