feat(opapi): support for binary content types (#203)

botpress · Mar 13, 2024 · bf01620 · bf01620
1 parent b5545c7
commit bf01620
Show file tree

Hide file tree

Showing 7 changed files with 26 additions and 10 deletions.
diff --git a/opapi/package.json b/opapi/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@bpinternal/opapi",
-  "version": "0.7.10",
+  "version": "0.8.0",
   "description": "",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

diff --git a/opapi/src/generator.ts b/opapi/src/generator.ts
@@ -200,6 +200,7 @@ function mapOperationPropsToHandlerProps(
     params: [],
     body: isOperationWithBodyProps(operation) ? true : false,
     isEmptyBody: isOperationWithBodyProps(operation) ? schemaIsEmptyObject(operation.requestBody.schema) : true,
+    contentType: isOperationWithBodyProps(operation) ? operation.contentType ?? 'application/json' : 'application/json',
   }
 
   if (operation.parameters) {

diff --git a/opapi/src/generators/handlers.ts b/opapi/src/generators/handlers.ts
@@ -40,6 +40,7 @@ export type GenerateHandlerProps = {
   status: number
   body: boolean
   isEmptyBody: boolean
+  contentType: string
 }
 
 const generateRequestResponseTypes = (useExpressTypes: boolean) => {
@@ -63,8 +64,8 @@ ${generateParameterFields(props)}
 }
 `
 
-const generateBodyField = (operationName: string) =>
-  `\t\t...req.body as NonNullable<components['requestBodies']['${operationName}Body']>['content']['application/json'],`
+const generateBodyField = (operationName: string, contentType: string) =>
+  `\t\t...req.body as NonNullable<components['requestBodies']['${operationName}Body']>['content']['${contentType}'],`
 
 const generateParameterFields = ({
   cookies,
@@ -73,9 +74,10 @@ const generateParameterFields = ({
   queries,
   body,
   operationName,
+  contentType,
 }: GenerateHandlerProps): string =>
   [
-    body ? generateBodyField(operationName) : undefined,
+    body ? generateBodyField(operationName, contentType) : undefined,
     ...cookies.map((cookie) =>
       generateField(cookie.name, 'cookies', cookie.parameter, cookie.parameter.required !== false),
     ),

diff --git a/opapi/src/generators/types.ts b/opapi/src/generators/types.ts
@@ -1,6 +1,9 @@
 const typesCode = `
 
-type RequestBody = { requestBody?: { content: { 'application/json': {} } } }
+type JsonRequestBody = { requestBody?: { content: { 'application/json': {} } } }
+type BinaryRequestBody = { requestBody?: { content: { '*/*': {} } } }
+
+type RequestBody = JsonRequestBody | BinaryRequestBody
 type Responses = { responses: { default: { content: { 'application/json': {} } } } }
 type Parameters = { parameters?: {} }
 
@@ -9,7 +12,7 @@ type GetHeaderParameters<T> = T extends { header?: any } ? NonNullable<T['header
 type GetCookieParameters<T> = T extends { cookie?: any } ? NonNullable<T['cookie']> : {}
 type GetQueryParameters<T> = T extends { query?: any } ? NonNullable<T['query']> : {}
 
-type GetRequestBody<T> = T extends RequestBody ? NonNullable<T['requestBody']>['content']['application/json'] : {}
+type GetRequestBody<T> = T extends JsonRequestBody ? NonNullable<T['requestBody']>['content']['application/json'] : T extends BinaryRequestBody ? NonNullable<T['requestBody']>['content']['*/*'] : {}
 type GetParameters<T> = T extends Parameters
   ? GetPathParameters<NonNullable<T['parameters']>> &
       GetHeaderParameters<NonNullable<T['parameters']>> &

diff --git a/opapi/src/openapi.ts b/opapi/src/openapi.ts
@@ -68,11 +68,12 @@ export const createOpenapi = <
 
     if (isOperationWithBodyProps(operationObject)) {
       const requestBody = operationObject.requestBody
+      const contentType = operationObject.contentType ?? 'application/json'
 
       openapi.addRequestBody(bodyName, {
         description: requestBody.description,
         content: {
-          'application/json': {
+          [contentType]: {
             schema: requestBody.schema,
           },
         },

diff --git a/opapi/src/operation.ts b/opapi/src/operation.ts
@@ -49,7 +49,10 @@ export const addOperation = <
   const response = {
     description: operationProps.response.description,
     status: operationProps.response.status,
-    schema: generateSchemaFromZod(extendApi(operationProps.response.schema, { title: responseName }), state.options),
+    schema: generateSchemaFromZod(
+      extendApi(operationProps.response.schema, { title: responseName, format: operationProps.response.format }),
+      state.options,
+    ),
   }
 
   let operation: Operation<DefaultParameterName, SectionName, string, 'json-schema'>
@@ -62,7 +65,10 @@ export const addOperation = <
       response,
       requestBody: {
         description: operationProps.requestBody.description,
-        schema: generateSchemaFromZod(extendApi(operationProps.requestBody.schema, { title: bodyName }), state.options),
+        schema: generateSchemaFromZod(
+          extendApi(operationProps.requestBody.schema, { title: bodyName, format: operationProps.requestBody?.format }),
+          state.options,
+        ),
       },
     }
   } else {

diff --git a/opapi/src/state.ts b/opapi/src/state.ts
@@ -124,7 +124,9 @@ export type OperationWithBodyProps<
   requestBody: {
     description: string
     schema: SchemaOfType<S>
+    format?: 'binary'
   }
+  contentType?: 'application/json' | '*/*'
 } & BaseOperationProps<DefaultParameterName, SectionName, Path, S>
 
 export const operationsWithoutBodyMethod = ['get', 'delete', 'options', 'head', 'trace'] as const
@@ -196,9 +198,10 @@ type BaseOperationProps<
   response: {
     // Status code of the response
     // Default is 200
-    status?: 200 | 201 | 418
+    status?: 200 | 201 | 418 | 302
     description: string
     schema: SchemaOfType<S>
+    format?: 'binary'
   }
 }