File Uploads

LICENSE

@@ -176,3 +176,29 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
+
+
+
+Express-FileUpload - https://github.com/richardgirges/express-fileupload
+
+The MIT License (MIT)
+
+Copyright (c) 2015 Richard Girges
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

example/example.swagger.yaml

@@ -190,6 +190,77 @@ paths:
             type: string
             pattern: /\d+/
             description: GET /v1/stream parameter
+  /v1/upload:
+    post:
+      responses:
+        "200":
+          description: POST /v1/upload Successful response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  status:
+                    type: string
+                    enum:
+                      - success
+                  data:
+                    type: object
+                    properties:
+                      name:
+                        type: string
+                      size:
+                        type: integer
+                        format: int64
+                        minimum: 0
+                        exclusiveMinimum: false
+                        maximum: 9007199254740991
+                        exclusiveMaximum: false
+                      mime:
+                        type: string
+                      hash:
+                        type: string
+                    required:
+                      - name
+                      - size
+                      - mime
+                      - hash
+                required:
+                  - status
+                  - data
+        "400":
+          description: POST /v1/upload Error response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  status:
+                    type: string
+                    enum:
+                      - error
+                  error:
+                    type: object
+                    properties:
+                      message:
+                        type: string
+                    required:
+                      - message
+                required:
+                  - status
+                  - error
+      requestBody:
+        content:
+          multipart/form-data:
+            schema:
+              type: object
+              properties:
+                avatar:
+                  nullable: true
+                  type: string
+                  format: binary
+              required: []
+              description: POST /v1/upload request body
 components:
   schemas: {}
   responses: {}

example/v1/file-upload.ts

@@ -0,0 +1,24 @@
+import {z, defaultEndpointsFactory} from '../../src';
+import crypto from 'crypto';
+
+export const fileUploadEndpoint = defaultEndpointsFactory.build({
+  method: 'post',
+  type: 'upload',
+  input: z.object({
+    avatar: z.upload(),
+  }),
+  output: z.object({
+    name: z.string(),
+    size: z.number().int().nonnegative(),
+    mime: z.string(),
+    hash: z.string()
+  }),
+  handler: async ({input: {avatar}}) => {
+    return {
+      name: avatar.name,
+      size: avatar.size,
+      mime: avatar.mimetype,
+      hash: crypto.createHash('sha1').update(avatar.data).digest('hex')
+    };
+  }
+});

example/v1/index.ts

@@ -1,8 +1,9 @@
 import {DependsOnMethod, Routing} from '../../src';
+import {fileUploadEndpoint} from './file-upload';
 import {getUserEndpoint} from './get-user';
-import {sendAvatar} from './send-avatar';
+import {sendAvatarEndpoint} from './send-avatar';
 import {setUserEndpoint} from './set-user';
-import {streamAvatar} from './stream-avatar';
+import {streamAvatarEndpoint} from './stream-avatar';
 
 export const v1Routing: Routing = {
   // syntax 1: methods are defined within the endpoint
@@ -14,6 +15,9 @@ export const v1Routing: Routing = {
   }),
 
   // custom result handler examples with a file serving
-  avatar: sendAvatar,
-  stream: streamAvatar
+  avatar: sendAvatarEndpoint,
+  stream: streamAvatarEndpoint,
+
+  // file upload
+  upload: fileUploadEndpoint,
 };

example/v1/send-avatar.ts

@@ -2,7 +2,7 @@ import { z } from '../../src';
 import {fileDownloadEndpointsFactory} from '../factories';
 import fs from 'fs';
 
-export const sendAvatar = fileDownloadEndpointsFactory.build({
+export const sendAvatarEndpoint = fileDownloadEndpointsFactory.build({
   methods: ['get'],
   input: z.object({
     userId: z.string().regex(/\d+/).transform((str) => parseInt(str, 10))

example/v1/stream-avatar.ts

@@ -1,7 +1,7 @@
 import {z} from '../../src';
 import {fileStreamingEndpointsFactory} from '../factories';
 
-export const streamAvatar = fileStreamingEndpointsFactory.build({
+export const streamAvatarEndpoint = fileStreamingEndpointsFactory.build({
   methods: ['get'],
   input: z.object({
     userId: z.string().regex(/\d+/).transform((str) => parseInt(str, 10))

package.json

@@ -24,6 +24,7 @@
   "types": "dist/index.d.ts",
   "dependencies": {
     "express": "^4.17.1",
+    "express-fileupload": "^1.2.1",
     "http-errors": "^1.8.0",
     "mime": "^2.5.2",
     "openapi3-ts": "^2.0.1",
@@ -33,6 +34,7 @@
   "devDependencies": {
     "@tsconfig/node10": "^1.0.8",
     "@types/express": "^4.17.11",
+    "@types/express-fileupload": "^1.1.7",
     "@types/http-errors": "^1.8.0",
     "@types/jest": "^27.0.1",
     "@types/mime": "^2.0.3",

src/api-response.ts

@@ -0,0 +1,14 @@
+import {z} from 'zod';
+import {mimeJson, MimeParam} from './mime';
+
+export type ApiResponse<A = z.ZodTypeAny> = {
+  schema: A;
+  mimeTypes: string[];
+};
+
+export const createApiResponse = <S extends z.ZodTypeAny>(schema: S, mimeTypes: MimeParam = mimeJson) => {
+  return {
+    schema,
+    mimeTypes: typeof mimeTypes === 'string' ? [mimeTypes] : mimeTypes,
+  } as ApiResponse<S>;
+};

src/endpoint.ts

@@ -1,9 +1,9 @@
 import {Request, Response} from 'express';
 import {Logger} from 'winston';
 import {z} from 'zod';
+import {ApiResponse} from './api-response';
 import {CommonConfig} from './config-type';
 import {
-  ApiResponse,
   combineEndpointAndMiddlewareInputSchemas,
   getInitialInput,
   IOSchema,
@@ -13,6 +13,7 @@ import {
 } from './helpers';
 import {Method, MethodsDefinition} from './method';
 import {MiddlewareDefinition} from './middleware';
+import {mimeUpload} from './mime';
 import {ResultHandlerDefinition} from './result-handler';
 
 export type Handler<IN, OUT, OPT> = (params: {
@@ -40,6 +41,7 @@ export abstract class AbstractEndpoint {
   public abstract getOutputSchema(): IOSchema;
   public abstract getPositiveResponseSchema(): z.ZodTypeAny;
   public abstract getNegativeResponseSchema(): z.ZodTypeAny;
+  public abstract getInputMimeTypes(): string[];
   public abstract getPositiveMimeTypes(): string[];
   public abstract getNegativeMimeTypes(): string[];
 }
@@ -69,6 +71,7 @@ type EndpointProps<
 > = {
   middlewares: MiddlewareDefinition<any, any, any>[];
   inputSchema: IN;
+  mimeTypes: string[];
   outputSchema: OUT;
   handler: Handler<z.output<Merge<IN, mIN>>, z.input<OUT>, OPT>;
   resultHandler: ResultHandlerDefinition<POS, NEG>;
@@ -83,16 +86,18 @@ export class Endpoint<
   protected methods: M[] = [];
   protected middlewares: MiddlewareDefinition<any, any, any>[] = [];
   protected inputSchema: Merge<IN, mIN>; // combined with middlewares input
+  protected mimeTypes: string[];
   protected outputSchema: OUT;
   protected handler: Handler<z.output<Merge<IN, mIN>>, z.input<OUT>, OPT>
   protected resultHandler: ResultHandlerDefinition<POS, NEG>;
 
   constructor({
-    middlewares, inputSchema, outputSchema, handler, resultHandler, description, ...rest
+    middlewares, inputSchema, outputSchema, handler, resultHandler, description, mimeTypes, ...rest
   }: EndpointProps<IN, OUT, mIN, OPT, M, POS, NEG>) {
     super();
     this.middlewares = middlewares;
     this.inputSchema = combineEndpointAndMiddlewareInputSchemas<IN, mIN>(inputSchema, middlewares);
+    this.mimeTypes = mimeTypes;
     this.outputSchema = outputSchema;
     this.handler = handler;
     this.resultHandler = resultHandler;
@@ -124,6 +129,10 @@ export class Endpoint<
     return this.resultHandler.getNegativeResponse().schema;
   }
 
+  public override getInputMimeTypes() {
+    return this.mimeTypes;
+  }
+
   public override getPositiveMimeTypes() {
     return this.resultHandler.getPositiveResponse(this.outputSchema).mimeTypes;
   }
@@ -222,7 +231,9 @@ export class Endpoint<
     if (request.method === 'OPTIONS') {
       return response.end();
     }
-    const initialInput = getInitialInput(request);
+    const contentType = request.header('content-type') || '';
+    const isUpload = contentType.substr(0, mimeUpload.length).toLowerCase() === mimeUpload;
+    const initialInput = getInitialInput(request, isUpload);
     try {
       const {input, options, isStreamClosed} = await this.#runMiddlewares({
         input: {...initialInput}, // preserve the initial

src/endpoints-factory.ts

@@ -1,15 +1,18 @@
 import {z} from 'zod';
+import {ApiResponse} from './api-response';
 import {Endpoint, Handler} from './endpoint';
-import {ApiResponse, FlatObject, IOSchema, Merge} from './helpers';
+import {FlatObject, IOSchema, Merge} from './helpers';
 import {Method, MethodsDefinition} from './method';
 import {MiddlewareDefinition} from './middleware';
+import {mimeJson, mimeUpload} from './mime';
 import {defaultResultHandler, ResultHandlerDefinition} from './result-handler';
 
 type BuildProps<IN extends IOSchema, OUT extends IOSchema, mIN, mOUT, M extends Method> = {
   input: IN;
   output: OUT;
   handler: Handler<z.output<Merge<IN, mIN>>, z.input<OUT>, mOUT>;
   description?: string;
+  type?: 'json' | 'upload';
 } & MethodsDefinition<M>;
 
 /** mIN, mOUT - accumulated from all middlewares */
@@ -39,14 +42,15 @@ export class EndpointsFactory<mIN, mOUT, POS extends ApiResponse, NEG extends Ap
   }
 
   public build<IN extends IOSchema, OUT extends IOSchema, M extends Method>({
-    input, output, handler, description, ...rest
+    input, output, handler, description, type, ...rest
   }: BuildProps<IN, OUT, mIN, mOUT, M>) {
     return new Endpoint<IN, OUT, mIN, mOUT, M, POS, NEG>({
       handler, description,
       middlewares: this.middlewares,
       inputSchema: input,
       outputSchema: output,
       resultHandler: this.resultHandler,
+      mimeTypes: type === 'upload' ? [mimeUpload] : [mimeJson],
       ...rest
     });
   }

src/extend-zod.ts

@@ -1,4 +1,6 @@
 import {ZodFile} from './file-schema';
+import {ZodUpload} from './upload-schema';
 
 export * from 'zod';
 export const file = ZodFile.create;
+export const upload = ZodUpload.create;

src/file-schema.ts

@@ -5,18 +5,12 @@ import {
   ZodParsedType,
   ZodType,
   INVALID,
-  OK,
-  ZodString,
+  OK
 } from 'zod';
+import {ErrMessage, errToObj} from './helpers';
 
 const zodFileKind = 'ZodFile';
 
-// obtaining the private helper type from Zod
-type ErrMessage = Exclude<Parameters<typeof ZodString.prototype.email>[0], undefined>;
-
-// the copy of the private Zod errorUtil.errToObj
-const errToObj = (message: ErrMessage | undefined) => typeof message === 'string' ? {message} : message || {};
-
 declare type ZodFileCheck = {
   kind: 'binary';
   message?: string;

src/helpers.ts

@@ -1,6 +1,5 @@
 import {Request} from 'express';
 import {HttpError} from 'http-errors';
-import {getType} from 'mime';
 import {z} from 'zod';
 import {LoggerConfig, loggerLevels} from './config-type';
 import {MiddlewareDefinition} from './middleware';
@@ -68,9 +67,10 @@ export function combineEndpointAndMiddlewareInputSchemas<IN extends IOSchema, mI
   return extractObjectSchema(mSchema).merge(extractObjectSchema(input)) as Merge<IN, mIN>;
 }
 
-export function getInitialInput(request: Request): any {
+export function getInitialInput(request: Request, isWithFiles: boolean): any {
   switch (request.method) {
     case 'POST':
+      return isWithFiles ? {...request.body, ...request.files} : request.body; // @todo configurable?
     case 'PUT':
     case 'PATCH':
       return request.body;
@@ -107,17 +107,8 @@ export function getStatusCodeFromError(error: Error): number {
   return 500;
 }
 
-export type ApiResponse<A = z.ZodTypeAny> = {
-  schema: A;
-  mimeTypes: string[];
-};
-
-export const createApiResponse = <S extends z.ZodTypeAny>(
-  schema: S,
-  mimeTypes: string | string[] = getType('json') || 'application/json'
-) => {
-  return {
-    schema,
-    mimeTypes: typeof mimeTypes === 'string' ? [mimeTypes] : mimeTypes,
-  } as ApiResponse<S>;
-};
+// obtaining the private helper type from Zod
+export type ErrMessage = Exclude<Parameters<typeof z.ZodString.prototype.email>[0], undefined>;
+
+// the copy of the private Zod errorUtil.errToObj
+export const errToObj = (message: ErrMessage | undefined) => typeof message === 'string' ? {message} : message || {};