@kiyasov/platform-hono 1.4.0 → 1.4.2

package/src/multer/interceptors/file-fields-interceptor.ts

@@ -1,24 +1,24 @@
-import { Observable, tap } from "rxjs";
 import {
   CallHandler,
   ExecutionContext,
   mixin,
   NestInterceptor,
   Type,
-} from "@nestjs/common";
+} from '@nestjs/common';
+import { finalize } from 'rxjs';
 
-import { getMultipartRequest } from "../multipart/request";
-import { transformUploadOptions, UploadOptions } from "../multipart/options";
 import {
   handleMultipartFileFields,
   UploadField,
   UploadFieldMapEntry,
   uploadFieldsToMap,
-} from "../multipart/handlers/file-fields";
+} from '../multipart/handlers/file-fields';
+import { transformUploadOptions, UploadOptions } from '../multipart/options';
+import { getMultipartRequest } from '../multipart/request';
 
 export function FileFieldsInterceptor(
   uploadFields: UploadField[],
-  options?: UploadOptions
+  options?: UploadOptions,
 ): Type<NestInterceptor> {
   class MixinInterceptor implements NestInterceptor {
     private readonly options: UploadOptions;
@@ -30,27 +30,24 @@ export function FileFieldsInterceptor(
       this.fieldsMap = uploadFieldsToMap(uploadFields);
     }
 
-    async intercept(
-      context: ExecutionContext,
-      next: CallHandler
-    ): Promise<Observable<any>> {
+    async intercept(context: ExecutionContext, next: CallHandler) {
       const ctx = context.switchToHttp();
       const req = getMultipartRequest(ctx);
 
-      if (!req.header("content-type")?.startsWith("multipart/form-data")) {
+      if (!req.header('content-type')?.startsWith('multipart/form-data')) {
         return next.handle();
       }
 
       const { body, files, remove } = await handleMultipartFileFields(
         req,
         this.fieldsMap,
-        this.options
+        this.options,
       );
 
       req.body = body;
       req.storageFiles = files;
 
-      return next.handle().pipe(tap(remove));
+      return next.handle().pipe(finalize(remove));
     }
   }
 

package/src/multer/interceptors/file-interceptor.ts

@@ -1,19 +1,19 @@
-import { Observable, tap } from "rxjs";
 import {
   CallHandler,
   ExecutionContext,
   mixin,
   NestInterceptor,
   Type,
-} from "@nestjs/common";
+} from '@nestjs/common';
+import { finalize } from 'rxjs';
 
-import { getMultipartRequest } from "../multipart/request";
-import { transformUploadOptions, UploadOptions } from "../multipart/options";
-import { handleMultipartSingleFile } from "../multipart/handlers/single-file";
+import { handleMultipartSingleFile } from '../multipart/handlers/single-file';
+import { transformUploadOptions, UploadOptions } from '../multipart/options';
+import { getMultipartRequest } from '../multipart/request';
 
 export function FileInterceptor(
   fieldname: string,
-  options?: UploadOptions
+  options?: UploadOptions,
 ): Type<NestInterceptor> {
   class MixinInterceptor implements NestInterceptor {
     private readonly options: UploadOptions;
@@ -22,27 +22,24 @@ export function FileInterceptor(
       this.options = transformUploadOptions(options);
     }
 
-    async intercept(
-      context: ExecutionContext,
-      next: CallHandler
-    ): Promise<Observable<any>> {
+    async intercept(context: ExecutionContext, next: CallHandler) {
       const ctx = context.switchToHttp();
       const req = getMultipartRequest(ctx);
 
-      if (!req.header("content-type")?.startsWith("multipart/form-data")) {
+      if (!req.header('content-type')?.startsWith('multipart/form-data')) {
         return next.handle();
       }
 
       const { file, body, remove } = await handleMultipartSingleFile(
         req,
         fieldname,
-        this.options
+        this.options,
       );
 
       req.body = body;
       req.storageFile = file;
 
-      return next.handle().pipe(tap(remove));
+      return next.handle().pipe(finalize(remove));
     }
   }
 

package/src/multer/interceptors/files-interceptor.ts

@@ -1,20 +1,20 @@
-import { Observable, tap } from "rxjs";
 import {
   CallHandler,
   ExecutionContext,
   mixin,
   NestInterceptor,
   Type,
-} from "@nestjs/common";
+} from '@nestjs/common';
+import { finalize } from 'rxjs';
 
-import { getMultipartRequest } from "../multipart/request";
-import { transformUploadOptions, UploadOptions } from "../multipart/options";
-import { handleMultipartMultipleFiles } from "../multipart/handlers/multiple-files";
+import { handleMultipartMultipleFiles } from '../multipart/handlers/multiple-files';
+import { transformUploadOptions, UploadOptions } from '../multipart/options';
+import { getMultipartRequest } from '../multipart/request';
 
 export function FilesInterceptor(
   fieldname: string,
   maxCount = 1,
-  options?: UploadOptions
+  options?: UploadOptions,
 ): Type<NestInterceptor> {
   class MixinInterceptor implements NestInterceptor {
     private readonly options: UploadOptions;
@@ -23,14 +23,11 @@ export function FilesInterceptor(
       this.options = transformUploadOptions(options);
     }
 
-    async intercept(
-      context: ExecutionContext,
-      next: CallHandler
-    ): Promise<Observable<any>> {
+    async intercept(context: ExecutionContext, next: CallHandler) {
       const ctx = context.switchToHttp();
       const req = getMultipartRequest(ctx);
 
-      if (!req.header("content-type")?.startsWith("multipart/form-data")) {
+      if (!req.header('content-type')?.startsWith('multipart/form-data')) {
         return next.handle();
       }
 
@@ -38,13 +35,13 @@ export function FilesInterceptor(
         req,
         fieldname,
         maxCount,
-        this.options
+        this.options,
       );
 
       req.body = body;
       req.storageFiles = files;
 
-      return next.handle().pipe(tap(remove));
+      return next.handle().pipe(finalize(remove));
     }
   }
 

package/src/multer/interceptors/index.ts

@@ -1,4 +1,4 @@
-export * from "./file-fields-interceptor";
-export * from "./file-interceptor";
-export * from "./any-files-interceptor";
-export * from "./files-interceptor";
+export * from './file-fields-interceptor';
+export * from './file-interceptor';
+export * from './any-files-interceptor';
+export * from './files-interceptor';

package/src/multer/multipart/exceptions.ts

@@ -9,6 +9,7 @@ export const transformException = (err: Error | undefined) => {
     return err;
   }
 
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   const code: string = (err as any).code;
 
   switch (code) {

package/src/multer/multipart/file.ts

@@ -1,8 +1,9 @@
 import { Readable } from 'stream';
+
 import { Storage, StorageFile } from '../storage';
 
 export type MultipartFile = Omit<File[], 'file'> & {
-  value?: any;
+  value?: unknown;
   file: Readable & { truncated?: boolean };
 };
 

package/src/multer/multipart/filter.ts

@@ -1,8 +1,8 @@
 import { BadRequestException } from '@nestjs/common';
-import { UploadOptions } from '.';
+import { HonoRequest } from 'hono';
 
+import { UploadOptions } from '.';
 import { DiskStorageFile, MemoryStorageFile, StorageFile } from '../storage';
-import { HonoRequest } from 'hono';
 
 export type UploadFilterFile =
   | DiskStorageFile

package/src/multer/multipart/handlers/any-files.ts

@@ -1,16 +1,18 @@
-import { UploadOptions } from "../options";
-import { StorageFile } from "../../storage";
-import { THonoRequest, getParts } from "../request";
-import { removeStorageFiles } from "../file";
-import { filterUpload } from "../filter";
+import { BodyData } from 'hono/utils/body';
+
+import { StorageFile } from '../../storage';
+import { removeStorageFiles } from '../file';
+import { filterUpload } from '../filter';
+import { UploadOptions } from '../options';
+import { THonoRequest, getParts } from '../request';
 
 export const handleMultipartAnyFiles = async (
   req: THonoRequest,
-  options: UploadOptions
+  options: UploadOptions,
 ) => {
   const parts = getParts(req, options);
 
-  const body: Record<string, any> = {};
+  const body: BodyData = {};
 
   const files: StorageFile[] = [];
 

package/src/multer/multipart/handlers/file-fields.ts

@@ -1,48 +1,57 @@
-import { BadRequestException } from "@nestjs/common";
+import { BadRequestException } from '@nestjs/common';
+import { BodyData } from 'hono/utils/body';
 
-import { UploadOptions } from "../options";
-import { StorageFile } from "../../storage/storage";
-import { THonoRequest, getParts } from "../request";
-import { removeStorageFiles } from "../file";
-import { filterUpload } from "../filter";
-import { HonoRequest } from "hono";
+import { StorageFile } from '../../storage/storage';
+import { removeStorageFiles } from '../file';
+import { filterUpload } from '../filter';
+import { UploadOptions } from '../options';
+import { THonoRequest, getParts } from '../request';
 
 export interface UploadField {
-  /**
-   * Field name
-   */
   name: string;
-  /**
-   * Max number of files in this field
-   */
   maxCount?: number;
 }
 
-export type UploadFieldMapEntry = Required<Pick<UploadField, "maxCount">>;
-
-export const uploadFieldsToMap = (uploadFields: UploadField[]) => {
-  const map = new Map<string, UploadFieldMapEntry>();
-
-  uploadFields.forEach(({ name, ...opts }) => {
-    map.set(name, { maxCount: 1, ...opts });
-  });
-
-  return map;
-};
-
+export type UploadFieldMapEntry = Required<Pick<UploadField, 'maxCount'>>;
+
+/**
+ * Converts an array of upload fields into a map for easy lookup.
+ * @param {UploadField[]} uploadFields - Array of upload field definitions.
+ * @returns {Map<string, UploadFieldMapEntry>} A map of field names to their max count settings.
+ */
+export const uploadFieldsToMap = (uploadFields: UploadField[]) =>
+  new Map(
+    uploadFields.map(({ name, ...opts }) => [name, { maxCount: 1, ...opts }]),
+  );
+
+/**
+ * Handles multipart file fields by processing form-data parts.
+ * @param {THonoRequest} req - The incoming request object.
+ * @param {Map<string, UploadFieldMapEntry>} fieldsMap - A map of allowed upload fields.
+ * @param {UploadOptions} options - Upload options including storage handler.
+ * @returns {Promise<{ body: BodyData, files: Record<string, StorageFile[]>, remove: () => Promise<void> }>} The parsed body and files with a removal function.
+ */
 export const handleMultipartFileFields = async (
   req: THonoRequest,
   fieldsMap: Map<string, UploadFieldMapEntry>,
-  options: UploadOptions
-) => {
+  options: UploadOptions,
+): Promise<{
+  body: BodyData;
+  files: Record<string, StorageFile[]>;
+  remove: () => Promise<void>;
+}> => {
   const parts = getParts(req, options);
-  const body: Record<string, any> = {};
-
+  const body: BodyData = {};
   const files: Record<string, StorageFile[]> = {};
 
-  const removeFiles = async (error?: boolean) => {
-    const allFiles = ([] as StorageFile[]).concat(...Object.values(files));
-    return await removeStorageFiles(options.storage!, allFiles, error);
+  /**
+   * Removes stored files in case of an error or cleanup.
+   * @param {boolean} [error=false] - Whether the removal is due to an error.
+   * @returns {Promise<void>} Resolves after files are removed.
+   */
+  const removeFiles = async (error?: boolean): Promise<void> => {
+    const allFiles = Object.values(files).flat();
+    return removeStorageFiles(options.storage!, allFiles, error);
   };
 
   try {
@@ -53,25 +62,20 @@ export const handleMultipartFileFields = async (
       }
 
       const fieldOptions = fieldsMap.get(fieldName);
-
-      if (fieldOptions == null) {
+      if (!fieldOptions) {
         throw new BadRequestException(
-          `Field ${fieldName} doesn't accept files`
+          `Field ${fieldName} doesn't accept files`,
         );
       }
 
-      if (files[fieldName] == null) {
-        files[fieldName] = [];
-      }
-
-      if (files[fieldName].length + 1 > fieldOptions.maxCount) {
+      files[fieldName] = files[fieldName] || [];
+      if (files[fieldName].length >= fieldOptions.maxCount) {
         throw new BadRequestException(
-          `Field ${fieldName} accepts max ${fieldOptions.maxCount} files`
+          `Field ${fieldName} accepts max ${fieldOptions.maxCount} files`,
         );
       }
 
       const file = await options.storage!.handleFile(part, req, fieldName);
-
       if (await filterUpload(options, req, file)) {
         files[fieldName].push(file);
       }
@@ -81,9 +85,5 @@ export const handleMultipartFileFields = async (
     throw error;
   }
 
-  return {
-    body,
-    files,
-    remove: () => removeFiles(),
-  };
+  return { body, files, remove: removeFiles };
 };

package/src/multer/multipart/handlers/index.ts

@@ -1 +1 @@
-export { UploadField } from "./file-fields";
+export { UploadField } from './file-fields';

package/src/multer/multipart/handlers/multiple-files.ts

@@ -1,19 +1,20 @@
-import { BadRequestException } from "@nestjs/common";
+import { BadRequestException } from '@nestjs/common';
+import { BodyData } from 'hono/utils/body';
 
-import { UploadOptions } from "../options";
-import { StorageFile } from "../../storage";
-import { removeStorageFiles } from "../file";
-import { THonoRequest, getParts } from "../request";
-import { filterUpload } from "../filter";
+import { StorageFile } from '../../storage';
+import { removeStorageFiles } from '../file';
+import { filterUpload } from '../filter';
+import { UploadOptions } from '../options';
+import { THonoRequest, getParts } from '../request';
 
 export const handleMultipartMultipleFiles = async (
   req: THonoRequest,
   fieldname: string,
   maxCount: number,
-  options: UploadOptions
+  options: UploadOptions,
 ) => {
   const parts = getParts(req, options);
-  const body: Record<string, any> = {};
+  const body: BodyData = {};
 
   const files: StorageFile[] = [];
 
@@ -30,13 +31,13 @@ export const handleMultipartMultipleFiles = async (
 
       if (partFieldName !== fieldname) {
         throw new BadRequestException(
-          `Field ${partFieldName} doesn't accept files`
+          `Field ${partFieldName} doesn't accept files`,
         );
       }
 
       if (files.length + 1 > maxCount) {
         throw new BadRequestException(
-          `Field ${partFieldName} accepts max ${maxCount} files`
+          `Field ${partFieldName} accepts max ${maxCount} files`,
         );
       }
 

package/src/multer/multipart/handlers/single-file.ts

@@ -1,22 +1,33 @@
-import { BadRequestException } from "@nestjs/common";
+import { BadRequestException } from '@nestjs/common';
+import { BodyData } from 'hono/utils/body';
 
-import { UploadOptions } from "../options";
-import { StorageFile } from "../../storage";
-import { THonoRequest, getParts } from "../request";
-import { filterUpload } from "../filter";
+import { StorageFile } from '../../storage';
+import { filterUpload } from '../filter';
+import { UploadOptions } from '../options';
+import { THonoRequest, getParts } from '../request';
 
+/**
+ * Handles a single file upload in a multipart request.
+ * @param req - The request object.
+ * @param fieldname - The name of the field that should contain the file.
+ * @param options - Upload options with storage configurations.
+ * @returns An object containing the request body, uploaded file, and a remove function.
+ */
 export const handleMultipartSingleFile = async (
   req: THonoRequest,
   fieldname: string,
-  options: UploadOptions
+  options: UploadOptions,
 ) => {
   const parts = getParts(req, options);
-  const body: Record<string, any> = {};
-
-  let file: StorageFile | undefined = undefined;
+  const body: BodyData = {};
+  let file: StorageFile | undefined;
 
+  /**
+   * Removes uploaded file in case of an error or cleanup.
+   * @param error - Whether the removal is due to an error.
+   */
   const removeFiles = async (error?: boolean) => {
-    if (file == null) return;
+    if (!file) return;
     await options.storage!.removeFile(file, error);
   };
 
@@ -29,11 +40,13 @@ export const handleMultipartSingleFile = async (
 
       if (partFieldName !== fieldname) {
         throw new BadRequestException(
-          `Field ${partFieldName} doesn't accept file`
+          `Field "${partFieldName}" doesn't accept file.`,
         );
-      } else if (file != null) {
+      }
+
+      if (file) {
         throw new BadRequestException(
-          `Field ${fieldname} accepts only one file`
+          `Field "${fieldname}" accepts only one file.`,
         );
       }
 

package/src/multer/multipart/index.ts

@@ -1,3 +1,3 @@
-export * from "./options";
-export * from "./filter";
-export { UploadFilterFile, UploadFilterHandler } from "./filter";
+export * from './options';
+export * from './filter';
+export { UploadFilterFile, UploadFilterHandler } from './filter';

package/src/multer/multipart/options.ts

@@ -1,4 +1,5 @@
 import busboy from 'busboy';
+
 import { DiskStorage, MemoryStorage, Storage } from '../storage';
 import { UploadFilterHandler } from './filter';
 

package/src/multer/multipart/request.ts

@@ -1,36 +1,49 @@
-import { BadRequestException } from "@nestjs/common";
-import { HttpArgumentsHost } from "@nestjs/common/interfaces";
+import { BadRequestException } from '@nestjs/common';
+import { HttpArgumentsHost } from '@nestjs/common/interfaces';
+import { HonoRequest } from 'hono';
+import { BodyData } from 'hono/utils/body';
 
-import { UploadOptions } from "./options";
-import { StorageFile } from "../storage";
-import { MultipartFile } from "./file";
-import { HonoRequest } from "hono";
+import { StorageFile } from '../storage';
+import { MultipartFile } from './file';
+import { UploadOptions } from './options';
 
 export type THonoRequest = HonoRequest & {
   files: Record<string, File[]>;
-  body: Record<string, any>;
+  body: BodyData;
   storageFile?: StorageFile;
   storageFiles?: StorageFile[] | Record<string, StorageFile[]>;
 };
 
-export const getMultipartRequest = (ctx: HttpArgumentsHost) => {
-  const req = ctx.getRequest<THonoRequest>();
-
-  return req;
+/**
+ * Retrieves the multipart request from the given context.
+ * @param ctx - The HTTP arguments host.
+ * @returns The request object extended with THonoRequest.
+ */
+export const getMultipartRequest = (ctx: HttpArgumentsHost): THonoRequest => {
+  return ctx.getRequest<THonoRequest>();
 };
 
-export const getParts = (req: THonoRequest, options: UploadOptions) => {
+/**
+ * Validates and extracts file parts from the request body.
+ * @param req - The request object containing multipart data.
+ * @param options - Upload options with file size limits.
+ * @returns The request body containing validated file parts.
+ * @throws {BadRequestException} If any file exceeds the allowed size limit.
+ */
+export const getParts = (
+  req: THonoRequest,
+  options: UploadOptions,
+): BodyData => {
   const parts = req.body;
 
   for (const [key, file] of Object.entries(parts)) {
-    if (
-      file instanceof File &&
-      options?.limits?.fileSize &&
-      file.size > options.limits.fileSize
-    ) {
-      throw new BadRequestException(
-        `File ${key} is too large. Maximum size is ${options.limits.fileSize} bytes`
-      );
+    if (file instanceof File) {
+      const maxSize = options?.limits?.fileSize;
+      if (maxSize && file.size > maxSize) {
+        throw new BadRequestException(
+          `File "${key}" is too large. Maximum size is ${maxSize} bytes.`,
+        );
+      }
     }
   }
 

package/src/multer/storage/disk-storage.ts

@@ -1,13 +1,13 @@
-import { tmpdir } from "os";
-import { createWriteStream } from "fs";
-import { mkdir, unlink } from "fs/promises";
-import { join } from "path";
+import { createWriteStream } from 'fs';
+import { mkdir, unlink } from 'fs/promises';
+import { HonoRequest } from 'hono';
+import { Readable } from 'node:stream';
+import { pipeline } from 'node:stream/promises';
+import { tmpdir } from 'os';
+import { join } from 'path';
 
-import { StorageFile, Storage } from "./storage";
-import { getUniqueFilename, pathExists } from "../fs";
-import { pipeline } from "node:stream/promises";
-import { HonoRequest } from "hono";
-import { Readable } from "node:stream";
+import { getUniqueFilename, pathExists } from '../fs';
+import { StorageFile, Storage } from './storage';
 
 export interface DiskStorageFile extends StorageFile {
   dest: string;
@@ -28,9 +28,9 @@ export interface DiskStorageOptions {
 const excecuteStorageHandler = (
   file: File,
   req: HonoRequest,
-  obj?: DiskStorageOptionHandler
+  obj?: DiskStorageOptionHandler,
 ) => {
-  if (typeof obj === "function") {
+  if (typeof obj === 'function') {
     return obj(file, req);
   }
 
@@ -76,7 +76,7 @@ export class DiskStorage
       originalFilename: file.name,
       path,
       mimetype: file.type,
-      encoding: "utf-8",
+      encoding: 'utf-8',
       fieldname: fieldName,
     };
   }
@@ -90,7 +90,7 @@ export class DiskStorage
   protected async getFilename(
     file: File,
     req: HonoRequest,
-    obj?: DiskStorageOptionHandler
+    obj?: DiskStorageOptionHandler,
   ): Promise<string> {
     return (
       excecuteStorageHandler(file, req, obj) ?? getUniqueFilename(file.name)
@@ -100,7 +100,7 @@ export class DiskStorage
   protected async getFileDestination(
     file: File,
     req: HonoRequest,
-    obj?: DiskStorageOptionHandler
+    obj?: DiskStorageOptionHandler,
   ): Promise<string> {
     return excecuteStorageHandler(file, req, obj) ?? tmpdir();
   }

package/src/multer/storage/index.ts

@@ -1,3 +1,3 @@
-export * from "./disk-storage";
-export * from "./memory-storage";
-export * from "./storage";
+export * from './disk-storage';
+export * from './memory-storage';
+export * from './storage';