feat(oas-typescript-koa): implement multer for file uploads and stuff (…

…#110)
imballinst · Jan 7, 2024 · 4a31928 · 4a31928
1 parent 19c6f72
commit 4a31928
Show file tree

Hide file tree

Showing 27 changed files with 388 additions and 194 deletions.
diff --git a/.changeset/stupid-hornets-smoke.md b/.changeset/stupid-hornets-smoke.md
@@ -0,0 +1,7 @@
+---
+'@oas-typescript/shared-cli-http-server': minor
+'@oas-typescript/koa': minor
+'@oas-typescript/shared': minor
+---
+
+feat: implement multer for file uploads and stuff
diff --git a/.yarn/cache/@esbuild-darwin-arm64-npm-0.18.20-00b3504077-8.zip b/.yarn/cache/@esbuild-darwin-arm64-npm-0.18.20-00b3504077-8.zip
diff --git a/.yarn/cache/@rollup-rollup-darwin-arm64-npm-4.4.1-0124a9273e-8.zip b/.yarn/cache/@rollup-rollup-darwin-arm64-npm-4.4.1-0124a9273e-8.zip
diff --git a/.yarn/install-state.gz b/.yarn/install-state.gz
diff --git a/packages/oas-typescript-koa/generated-vanilla/static/client.ts b/packages/oas-typescript-koa/generated-vanilla/static/client.ts
@@ -22,6 +22,12 @@ export const Pet = z
   })
   .passthrough();
 export interface Pet extends z.infer<typeof Pet> {}
+export const uploadFileMultipart_Body = z
+  .object({ name: z.string(), profileImage: z.any() })
+  .partial()
+  .passthrough();
+export interface uploadFileMultipart_Body
+  extends z.infer<typeof uploadFileMultipart_Body> {}
 export const Order = z
   .object({
     id: z.number().int(),
@@ -314,12 +320,12 @@ export const DeletePetErrors = {
 } as const;
 export type DeletePetErrors = typeof DeletePetErrors;
 
-export const UploadFileParameters = [
+export const UploadFileMultipartParameters = [
   {
     name: 'body',
     type: 'Body',
-    schema: z.object({ profileImage: z.string() }),
-    formDataMode: 'single'
+    schema: uploadFileMultipart_Body,
+    isFormData: true
   },
   {
     name: 'petId',
@@ -332,7 +338,7 @@ export const UploadFileParameters = [
     schema: z.string().optional()
   }
 ] as const;
-export const UploadFileSecurity = {
+export const UploadFileMultipartSecurity = {
   petstore_auth: {
     meta: {
       type: 'oauth2',
@@ -350,24 +356,24 @@ export const UploadFileSecurity = {
   }
 } as const;
 
-export const UploadFileResponse = {
+export const UploadFileMultipartResponse = {
   schema: z
     .object({ code: z.number().int(), type: z.string(), message: z.string() })
     .partial()
     .passthrough(),
   status: 200
 } as const;
-export type UploadFileResponse = typeof UploadFileResponse;
+export type UploadFileMultipartResponse = typeof UploadFileMultipartResponse;
 
-export const UploadFileErrors = {} as const;
-export type UploadFileErrors = typeof UploadFileErrors;
+export const UploadFileMultipartErrors = {} as const;
+export type UploadFileMultipartErrors = typeof UploadFileMultipartErrors;
 
-export const UploadFileMultipartParameters = [
+export const UploadFileParameters = [
   {
     name: 'body',
     type: 'Body',
-    schema: z.object({ profileImage: z.any() }).partial().passthrough(),
-    formDataMode: 'multiple'
+    schema: z.object({ profileImage: z.string() }),
+    isFormData: true
   },
   {
     name: 'petId',
@@ -380,7 +386,7 @@ export const UploadFileMultipartParameters = [
     schema: z.string().optional()
   }
 ] as const;
-export const UploadFileMultipartSecurity = {
+export const UploadFileSecurity = {
   petstore_auth: {
     meta: {
       type: 'oauth2',
@@ -398,17 +404,14 @@ export const UploadFileMultipartSecurity = {
   }
 } as const;
 
-export const UploadFileMultipartResponse = {
-  schema: z
-    .object({ code: z.number().int(), type: z.string(), message: z.string() })
-    .partial()
-    .passthrough(),
+export const UploadFileResponse = {
+  schema: z.void(),
   status: 200
 } as const;
-export type UploadFileMultipartResponse = typeof UploadFileMultipartResponse;
+export type UploadFileResponse = typeof UploadFileResponse;
 
-export const UploadFileMultipartErrors = {} as const;
-export type UploadFileMultipartErrors = typeof UploadFileMultipartErrors;
+export const UploadFileErrors = {} as const;
+export type UploadFileErrors = typeof UploadFileErrors;
 
 export const FindPetsByStatusParameters = [
   {

diff --git a/packages/oas-typescript-koa/generated-vanilla/static/router.ts b/packages/oas-typescript-koa/generated-vanilla/static/router.ts
@@ -192,9 +192,12 @@ router.post(
 );
 
 router.post(
-  '/pet/:petId/uploadImageMultipart',
+  '/pet/:petId/updatePetMultipart',
   KoaGeneratedUtils.createSecurityMiddleware(UploadFileMultipartSecurity),
   upload.fields([
+    {
+      name: 'name'
+    },
     {
       name: 'profileImage'
     }

diff --git a/packages/oas-typescript-koa/generated-vanilla/static/types.ts b/packages/oas-typescript-koa/generated-vanilla/static/types.ts
@@ -25,16 +25,20 @@ export type ResponseHeaders<
   THeadersSchemaType = string | number | z.ZodSchema
 > = Record<string, { schema: THeadersSchemaType; nullable?: boolean }>;
 
+type MaybePromise<T> = T | Promise<T>;
+
 type BuildResponseObject<TObject extends { headers?: ResponseHeaders }> =
-  TObject['headers'] extends object
-    ? Omit<TObject, 'headers'> & {
-        headers: {
-          [K in keyof TObject['headers']]: TObject['headers'][K]['schema'] extends z.ZodSchema
-            ? z.infer<TObject['headers'][K]['schema']>
-            : TObject['headers'][K]['schema'];
-        };
-      }
-    : Omit<TObject, 'headers'>;
+  MaybePromise<
+    TObject['headers'] extends object
+      ? Omit<TObject, 'headers'> & {
+          headers: {
+            [K in keyof TObject['headers']]: TObject['headers'][K]['schema'] extends z.ZodSchema
+              ? z.infer<TObject['headers'][K]['schema']>
+              : TObject['headers'][K]['schema'];
+          };
+        }
+      : Omit<TObject, 'headers'>
+  >;
 
 export interface ErrorResponse<
   TSchemaType = string,

diff --git a/packages/oas-typescript-koa/generated-vanilla/static/utils.ts b/packages/oas-typescript-koa/generated-vanilla/static/utils.ts
@@ -9,7 +9,7 @@ export interface OasParameter {
   name: string;
   description?: string;
   type: 'Path' | 'Query' | 'Body' | 'Header';
-  formDataMode?: 'single' | 'multiple';
+  isFormData?: boolean;
   schema: z.ZodTypeAny;
 }
 
@@ -53,6 +53,8 @@ export class KoaGeneratedUtils {
     ctx: Koa.Context;
     oasParameters: OasParametersType;
   }): ParsedRequestInfo<OasParametersType> | undefined {
+    try {
+    } catch (err) {}
     const pathParams: Record<string, any> = {};
     const queryParams: Record<string, any> = {};
     const headerParams: Record<string, any> = {};
@@ -84,10 +86,36 @@ export class KoaGeneratedUtils {
       if (oasParameter.type === 'Body') {
         let body: any;
 
-        if (oasParameter.formDataMode === 'single') {
-          body = ctx.request.file;
-        } else if (oasParameter.formDataMode === 'multiple') {
-          body = ctx.request.files;
+        // TODO: properly handle multer.single, multer.array, and multer.fields.
+        if (oasParameter.isFormData) {
+          if (ctx.request.file) {
+            // Single file --> multer: single.
+            body = {
+              [ctx.request.file.fieldname]:
+                ctx.request.file.buffer.toString('base64')
+            };
+          } else {
+            // Multiple files --> multer: array or fields.
+            body = ctx.request.body;
+
+            const files = ctx.request.files;
+
+            if (!Array.isArray(files)) {
+              // Multer: fields.
+              for (const key in files) {
+                body[key] = files[key].map((item) =>
+                  item.buffer.toString('base64')
+                );
+              }
+            } else if (files.length > 0) {
+              // Multer: array.
+              body = {
+                [files[0].fieldname]: files.map((item) =>
+                  item.buffer.toString('base64')
+                )
+              };
+            }
+          }
         } else {
           body = ctx.request.body;
         }

diff --git a/packages/oas-typescript-koa/generated/controllers/PetController.ts b/packages/oas-typescript-koa/generated/controllers/PetController.ts
@@ -1,3 +1,4 @@
+import { mkdir, writeFile } from 'fs/promises';
 import { Pet } from '../static/client.js';
 import {
   AddPetControllerFunction,
@@ -10,6 +11,7 @@ import {
   UploadFileControllerFunction,
   UploadFileMultipartControllerFunction
 } from '../static/controller-types/PetControllerTypes.js';
+import path from 'path';
 
 const db: Pet[] = [];
 
@@ -73,26 +75,24 @@ export class PetController {
       status: 204
     };
   };
-  static uploadFile: UploadFileControllerFunction = (params) => {
-    return {
-      body: {},
-      status: 200
-    };
-  };
-  static uploadFileMultipart: UploadFileMultipartControllerFunction = (
-    params
-  ) => {
+  static uploadFile: UploadFileControllerFunction = async (params) => {
+    await mkdir(path.join(process.cwd(), 'tests/output'), { recursive: true });
+    await writeFile(
+      path.join(process.cwd(), 'tests/output/image.jpg'),
+      Buffer.from(params.body.profileImage, 'base64'),
+      'binary'
+    );
     return {
       body: undefined,
-      status: undefined
+      status: 200
     };
   };
   static uploadFileMultipart: UploadFileMultipartControllerFunction = (
     params
   ) => {
     return {
-      body: undefined,
-      status: undefined
+      body: {},
+      status: 200
     };
   };
 }
diff --git a/packages/oas-typescript-koa/generated/static/client.ts b/packages/oas-typescript-koa/generated/static/client.ts
@@ -22,6 +22,12 @@ export const Pet = z
   })
   .passthrough();
 export interface Pet extends z.infer<typeof Pet> {}
+export const uploadFileMultipart_Body = z
+  .object({ name: z.string(), profileImage: z.any() })
+  .partial()
+  .passthrough();
+export interface uploadFileMultipart_Body
+  extends z.infer<typeof uploadFileMultipart_Body> {}
 export const Order = z
   .object({
     id: z.number().int(),
@@ -314,12 +320,12 @@ export const DeletePetErrors = {
 } as const;
 export type DeletePetErrors = typeof DeletePetErrors;
 
-export const UploadFileParameters = [
+export const UploadFileMultipartParameters = [
   {
     name: 'body',
     type: 'Body',
-    schema: z.object({ profileImage: z.string() }),
-    formDataMode: 'single'
+    schema: uploadFileMultipart_Body,
+    isFormData: true
   },
   {
     name: 'petId',
@@ -332,7 +338,7 @@ export const UploadFileParameters = [
     schema: z.string().optional()
   }
 ] as const;
-export const UploadFileSecurity = {
+export const UploadFileMultipartSecurity = {
   petstore_auth: {
     meta: {
       type: 'oauth2',
@@ -350,24 +356,24 @@ export const UploadFileSecurity = {
   }
 } as const;
 
-export const UploadFileResponse = {
+export const UploadFileMultipartResponse = {
   schema: z
     .object({ code: z.number().int(), type: z.string(), message: z.string() })
     .partial()
     .passthrough(),
   status: 200
 } as const;
-export type UploadFileResponse = typeof UploadFileResponse;
+export type UploadFileMultipartResponse = typeof UploadFileMultipartResponse;
 
-export const UploadFileErrors = {} as const;
-export type UploadFileErrors = typeof UploadFileErrors;
+export const UploadFileMultipartErrors = {} as const;
+export type UploadFileMultipartErrors = typeof UploadFileMultipartErrors;
 
-export const UploadFileMultipartParameters = [
+export const UploadFileParameters = [
   {
     name: 'body',
     type: 'Body',
-    schema: z.object({ profileImage: z.any() }).partial().passthrough(),
-    formDataMode: 'multiple'
+    schema: z.object({ profileImage: z.string() }),
+    isFormData: true
   },
   {
     name: 'petId',
@@ -380,7 +386,7 @@ export const UploadFileMultipartParameters = [
     schema: z.string().optional()
   }
 ] as const;
-export const UploadFileMultipartSecurity = {
+export const UploadFileSecurity = {
   petstore_auth: {
     meta: {
       type: 'oauth2',
@@ -398,17 +404,14 @@ export const UploadFileMultipartSecurity = {
   }
 } as const;
 
-export const UploadFileMultipartResponse = {
-  schema: z
-    .object({ code: z.number().int(), type: z.string(), message: z.string() })
-    .partial()
-    .passthrough(),
+export const UploadFileResponse = {
+  schema: z.void(),
   status: 200
 } as const;
-export type UploadFileMultipartResponse = typeof UploadFileMultipartResponse;
+export type UploadFileResponse = typeof UploadFileResponse;
 
-export const UploadFileMultipartErrors = {} as const;
-export type UploadFileMultipartErrors = typeof UploadFileMultipartErrors;
+export const UploadFileErrors = {} as const;
+export type UploadFileErrors = typeof UploadFileErrors;
 
 export const FindPetsByStatusParameters = [
   {