moonflower 0.9.2 → 0.10.0

package/src/openapi/analyzerModule/types.ts

@@ -4,6 +4,7 @@ export type ShapeOfType =
 	| ShapeOfNumberLiteral
 	| ShapeOfUnion
 	| ShapeOfUnionEntry
+	| ShapeOfBuffer
 	| ShapeOfRecord
 	| ShapeOfArray
 	| ShapeOfRef
@@ -41,6 +42,12 @@ export type ShapeOfUnionEntry = {
 	optional: boolean
 }
 
+export type ShapeOfBuffer = {
+	role: 'buffer'
+	shape: string
+	optional: boolean
+}
+
 export type ShapeOfRecord = {
 	role: 'record'
 	shape: string | ShapeOfType[]

package/src/openapi/generatorModule/generatePaths.ts

@@ -92,16 +92,19 @@ export const generatePaths = (endpoints: EndpointData[], preferences: ApiDocsPre
 		endpoint.responses.forEach((response) => {
 			const status = String(response.status)
 
-			const existingSchemas = responses[status]?.['content']?.['application/json']['schema']['oneOf'] ?? []
+			const existingSchemas =
+				responses[status]?.['content']?.[response.contentType]?.['schema']['oneOf'] ?? []
 
 			const responseSchema = getSchema(response.signature)
+
 			const content = (() => {
 				if ('type' in responseSchema && (responseSchema.type === 'void' || responseSchema.type === 'null')) {
 					return undefined
 				}
 
 				return {
-					'application/json': {
+					...responses[status]?.['content'],
+					[response.contentType]: {
 						schema: {
 							oneOf: [...existingSchemas, getSchema(response.signature)],
 						},

package/src/openapi/generatorModule/test/openApiGenerator.spec.data.ts

@@ -10,7 +10,7 @@ export const manyEndpointsData: EndpointData[] = [
 		requestHeaders: [],
 		rawBody: undefined,
 		objectBody: [],
-		responses: [{ status: 200, signature: 'void' }],
+		responses: [{ status: 200, signature: 'void', contentType: 'application/json' }],
 		name: 'Test endpoint name',
 		summary: 'Test endpoint summary',
 		description: 'Test endpoint description',
@@ -40,7 +40,7 @@ export const manyEndpointsData: EndpointData[] = [
 		requestHeaders: [],
 		rawBody: undefined,
 		objectBody: [],
-		responses: [{ status: 200, signature: 'void' }],
+		responses: [{ status: 200, signature: 'void', contentType: 'application/json' }],
 		name: undefined,
 		summary: undefined,
 		description: undefined,
@@ -70,7 +70,7 @@ export const manyEndpointsData: EndpointData[] = [
 		requestHeaders: [],
 		rawBody: undefined,
 		objectBody: [],
-		responses: [{ status: 200, signature: 'void' }],
+		responses: [{ status: 200, signature: 'void', contentType: 'application/json' }],
 		name: undefined,
 		summary: undefined,
 		description: undefined,
@@ -121,7 +121,7 @@ export const manyEndpointsData: EndpointData[] = [
 		requestHeaders: [],
 		rawBody: undefined,
 		objectBody: [],
-		responses: [{ status: 200, signature: 'void' }],
+		responses: [{ status: 200, signature: 'void', contentType: 'application/json' }],
 		name: undefined,
 		summary: undefined,
 		description: undefined,
@@ -160,7 +160,7 @@ export const manyEndpointsData: EndpointData[] = [
 		requestHeaders: [],
 		rawBody: undefined,
 		objectBody: [],
-		responses: [{ status: 200, signature: 'void' }],
+		responses: [{ status: 200, signature: 'void', contentType: 'application/json' }],
 		name: undefined,
 		summary: undefined,
 		description: undefined,
@@ -233,7 +233,7 @@ export const manyEndpointsData: EndpointData[] = [
 		requestHeaders: [],
 		rawBody: undefined,
 		objectBody: [],
-		responses: [{ status: 200, signature: 'void' }],
+		responses: [{ status: 200, signature: 'void', contentType: 'application/json' }],
 		name: undefined,
 		summary: undefined,
 		description: undefined,
@@ -259,7 +259,7 @@ export const manyEndpointsData: EndpointData[] = [
 		requestHeaders: [],
 		rawBody: undefined,
 		objectBody: [],
-		responses: [{ status: 200, signature: 'void' }],
+		responses: [{ status: 200, signature: 'void', contentType: 'application/json' }],
 		name: undefined,
 		summary: undefined,
 		description: undefined,
@@ -289,7 +289,7 @@ export const manyEndpointsData: EndpointData[] = [
 			optional: false,
 		},
 		objectBody: [],
-		responses: [{ status: 200, signature: 'void' }],
+		responses: [{ status: 200, signature: 'void', contentType: 'application/json' }],
 		name: undefined,
 		summary: undefined,
 		description: undefined,
@@ -319,7 +319,7 @@ export const manyEndpointsData: EndpointData[] = [
 			optional: false,
 		},
 		objectBody: [],
-		responses: [{ status: 200, signature: 'void' }],
+		responses: [{ status: 200, signature: 'void', contentType: 'application/json' }],
 		name: undefined,
 		summary: undefined,
 		description: undefined,
@@ -349,7 +349,7 @@ export const manyEndpointsData: EndpointData[] = [
 			optional: true,
 		},
 		objectBody: [],
-		responses: [{ status: 200, signature: 'void' }],
+		responses: [{ status: 200, signature: 'void', contentType: 'application/json' }],
 		name: undefined,
 		summary: undefined,
 		description: undefined,
@@ -363,7 +363,7 @@ export const manyEndpointsData: EndpointData[] = [
 		requestHeaders: [],
 		rawBody: { signature: 'boolean', optional: true },
 		objectBody: [],
-		responses: [{ status: 200, signature: 'void' }],
+		responses: [{ status: 200, signature: 'void', contentType: 'application/json' }],
 		name: undefined,
 		summary: undefined,
 		description: undefined,
@@ -389,7 +389,7 @@ export const manyEndpointsData: EndpointData[] = [
 			},
 			{ identifier: 'thirdParam', signature: 'number', optional: true },
 		],
-		responses: [{ status: 200, signature: 'void' }],
+		responses: [{ status: 200, signature: 'void', contentType: 'application/json' }],
 		name: undefined,
 		summary: undefined,
 		description: undefined,
@@ -415,7 +415,7 @@ export const manyEndpointsData: EndpointData[] = [
 			},
 			{ identifier: 'thirdParam', signature: 'number', optional: true },
 		],
-		responses: [{ status: 200, signature: 'void' }],
+		responses: [{ status: 200, signature: 'void', contentType: 'application/json' }],
 		name: undefined,
 		summary: undefined,
 		description: undefined,
@@ -441,7 +441,7 @@ export const manyEndpointsData: EndpointData[] = [
 			},
 			{ identifier: 'thirdParam', signature: 'number', optional: true },
 		],
-		responses: [{ status: 200, signature: 'void' }],
+		responses: [{ status: 200, signature: 'void', contentType: 'application/json' }],
 		name: undefined,
 		summary: undefined,
 		description: undefined,
@@ -455,7 +455,7 @@ export const manyEndpointsData: EndpointData[] = [
 		requestHeaders: [],
 		rawBody: undefined,
 		objectBody: [],
-		responses: [{ status: 200, signature: 'string' }],
+		responses: [{ status: 200, signature: 'string', contentType: 'application/json' }],
 		name: undefined,
 		summary: undefined,
 		description: undefined,
@@ -470,9 +470,9 @@ export const manyEndpointsData: EndpointData[] = [
 		rawBody: undefined,
 		objectBody: [],
 		responses: [
-			{ status: 200, signature: 'boolean' },
-			{ status: 200, signature: 'string' },
-			{ status: 200, signature: 'number' },
+			{ status: 200, signature: 'boolean', contentType: 'application/json' },
+			{ status: 200, signature: 'string', contentType: 'application/json' },
+			{ status: 200, signature: 'number', contentType: 'application/json' },
 		],
 		name: undefined,
 		summary: undefined,
@@ -490,6 +490,7 @@ export const manyEndpointsData: EndpointData[] = [
 		responses: [
 			{
 				status: 200,
+				contentType: 'application/json',
 				signature: [
 					{
 						role: 'property',
@@ -522,6 +523,7 @@ export const manyEndpointsData: EndpointData[] = [
 		responses: [
 			{
 				status: 200,
+				contentType: 'application/json',
 				signature: [
 					{
 						role: 'property',
@@ -554,6 +556,7 @@ export const manyEndpointsData: EndpointData[] = [
 		responses: [
 			{
 				status: 200,
+				contentType: 'application/json',
 				signature: [
 					{
 						role: 'property',
@@ -602,6 +605,7 @@ export const manyEndpointsData: EndpointData[] = [
 		responses: [
 			{
 				status: 200,
+				contentType: 'application/json',
 				signature: [
 					{
 						role: 'property',
@@ -640,6 +644,7 @@ export const manyEndpointsData: EndpointData[] = [
 		responses: [
 			{
 				status: 200,
+				contentType: 'application/json',
 				signature: [
 					{
 						role: 'property',
@@ -690,6 +695,7 @@ export const manyEndpointsData: EndpointData[] = [
 		responses: [
 			{
 				status: 200,
+				contentType: 'application/json',
 				signature: [
 					{
 						role: 'property',
@@ -701,6 +707,7 @@ export const manyEndpointsData: EndpointData[] = [
 			},
 			{
 				status: 200,
+				contentType: 'application/json',
 				signature: [
 					{
 						role: 'property',
@@ -736,7 +743,7 @@ export const manyEndpointsData: EndpointData[] = [
 		requestHeaders: [],
 		rawBody: undefined,
 		objectBody: [],
-		responses: [{ status: 200, signature: 'object' }],
+		responses: [{ status: 200, signature: 'object', contentType: 'application/json' }],
 		name: undefined,
 		summary: undefined,
 		description: undefined,
@@ -750,7 +757,7 @@ export const manyEndpointsData: EndpointData[] = [
 		requestHeaders: [],
 		rawBody: undefined,
 		objectBody: [],
-		responses: [{ status: 204, signature: 'void' }],
+		responses: [{ status: 204, signature: 'void', contentType: 'application/json' }],
 		name: undefined,
 		summary: undefined,
 		description: undefined,

package/src/openapi/generatorModule/test/openApiGenerator.spec.ts

@@ -77,6 +77,7 @@ describe('OpenApi Generator', () => {
 					{
 						status: 204,
 						signature: 'void',
+						contentType: 'application/json',
 					},
 				],
 			},
@@ -94,6 +95,7 @@ describe('OpenApi Generator', () => {
 					{
 						status: 200,
 						signature: 'bigint',
+						contentType: 'application/json',
 					},
 				],
 			},
@@ -121,6 +123,7 @@ describe('OpenApi Generator', () => {
 				responses: [
 					{
 						status: 200,
+						contentType: 'application/json',
 						signature: [
 							{
 								role: 'record',
@@ -179,6 +182,7 @@ describe('OpenApi Generator', () => {
 				responses: [
 					{
 						status: 200,
+						contentType: 'application/json',
 						signature: [
 							{
 								role: 'property',
@@ -225,6 +229,7 @@ describe('OpenApi Generator', () => {
 				responses: [
 					{
 						status: 200,
+						contentType: 'application/json',
 						signature: [
 							{
 								role: 'array',
@@ -270,6 +275,7 @@ describe('OpenApi Generator', () => {
 				responses: [
 					{
 						status: 200,
+						contentType: 'application/json',
 						signature: [
 							{
 								identifier: 'foo',
@@ -316,6 +322,7 @@ describe('OpenApi Generator', () => {
 				responses: [
 					{
 						status: 200,
+						contentType: 'application/json',
 						signature: [
 							{
 								role: 'union',
@@ -369,6 +376,7 @@ describe('OpenApi Generator', () => {
 				responses: [
 					{
 						status: 200,
+						contentType: 'application/json',
 						signature: [{ role: 'literal_string', shape: 'hello world', optional: false }],
 					},
 				],
@@ -496,6 +504,7 @@ describe('OpenApi Generator', () => {
 				responses: [
 					{
 						status: 200,
+						contentType: 'application/json',
 						signature: 'string',
 						description: 'Test description',
 					},
@@ -730,6 +739,7 @@ describe('OpenApi Generator', () => {
 				responses: [
 					{
 						status: 200,
+						contentType: 'application/json',
 						signature: [
 							{
 								identifier: 'foo',
@@ -780,4 +790,156 @@ describe('OpenApi Generator', () => {
 			responses: {},
 		})
 	})
+
+	describe('responses with multiple content types', () => {
+		it('respects contentType in single response', () => {
+			const manager = createManagerWithEndpoints([
+				{
+					...minimalEndpointData,
+					responses: [
+						{
+							status: 200,
+							contentType: 'text/plain',
+							signature: 'string',
+						},
+					],
+				},
+			])
+			const spec = generateOpenApiSpec(manager)
+
+			expect(spec.paths['/test/path'].get?.responses[200].content).toEqual({
+				'text/plain': {
+					schema: {
+						oneOf: [{ type: 'string' }],
+					},
+				},
+			})
+		})
+
+		it('includes multiple responses with different content types', () => {
+			const manager = createManagerWithEndpoints([
+				{
+					...minimalEndpointData,
+					responses: [
+						{
+							status: 200,
+							contentType: 'text/plain',
+							signature: 'string',
+						},
+						{
+							status: 200,
+							contentType: 'application/json',
+							signature: 'string',
+						},
+						{
+							status: 200,
+							contentType: 'content/custom',
+							signature: 'string',
+						},
+					],
+				},
+			])
+			const spec = generateOpenApiSpec(manager)
+
+			expect(spec.paths['/test/path'].get?.responses[200].content).toEqual({
+				'text/plain': {
+					schema: {
+						oneOf: [{ type: 'string' }],
+					},
+				},
+				'application/json': {
+					schema: {
+						oneOf: [{ type: 'string' }],
+					},
+				},
+				'content/custom': {
+					schema: {
+						oneOf: [{ type: 'string' }],
+					},
+				},
+			})
+		})
+
+		it('combines responses with the same content type and status code', () => {
+			const manager = createManagerWithEndpoints([
+				{
+					...minimalEndpointData,
+					responses: [
+						{
+							status: 200,
+							contentType: 'text/plain',
+							signature: 'number',
+						},
+						{
+							status: 200,
+							contentType: 'text/plain',
+							signature: 'string',
+						},
+						{
+							status: 200,
+							contentType: 'text/plain',
+							signature: 'boolean',
+						},
+					],
+				},
+			])
+			const spec = generateOpenApiSpec(manager)
+
+			expect(spec.paths['/test/path'].get?.responses[200].content).toEqual({
+				'text/plain': {
+					schema: {
+						oneOf: [{ type: 'number' }, { type: 'string' }, { type: 'boolean' }],
+					},
+				},
+			})
+		})
+
+		it('keeps content types separate for different status codes', () => {
+			const manager = createManagerWithEndpoints([
+				{
+					...minimalEndpointData,
+					responses: [
+						{
+							status: 200,
+							contentType: 'text/plain',
+							signature: 'number',
+						},
+						{
+							status: 204,
+							contentType: 'text/plain',
+							signature: 'string',
+						},
+						{
+							status: 418,
+							contentType: 'text/plain',
+							signature: 'boolean',
+						},
+					],
+				},
+			])
+			const spec = generateOpenApiSpec(manager)
+
+			expect(spec.paths['/test/path'].get?.responses[200].content).toEqual({
+				'text/plain': {
+					schema: {
+						oneOf: [{ type: 'number' }],
+					},
+				},
+			})
+			expect(spec.paths['/test/path'].get?.responses[204].content).toEqual({
+				'text/plain': {
+					schema: {
+						oneOf: [{ type: 'string' }],
+					},
+				},
+			})
+			expect(spec.paths['/test/path'].get?.responses[418].content).toEqual({
+				'text/plain': {
+					schema: {
+						oneOf: [{ type: 'boolean' }],
+					},
+				},
+			})
+		})
+	})
 })

package/src/openapi/types.ts

@@ -19,13 +19,14 @@ export type PathDefinition = {
 		string,
 		{
 			description: string
-			content?: {
-				'application/json': {
+			content?: Record<
+				string,
+				{
 					schema: {
 						oneOf: SchemaType[]
 					}
 				}
-			}
+			>
 		}
 	>
 }
@@ -80,6 +81,7 @@ export type EndpointData = {
 	responses: {
 		status: number
 		signature: string | ShapeOfType[]
+		contentType: string
 		description?: string
 		errorMessage?: string
 	}[]

package/src/router/Router.ts

@@ -4,7 +4,7 @@ import Koa from 'koa'
 
 import { OpenApiManager } from '../openapi/manager/OpenApiManager'
 import { ExtractedRequestParams } from '../utils/TypeUtils'
-import { responseValueToJson } from './responseValueToJson'
+import { parseEndpointReturnValue } from './parseEndpointReturnValue'
 
 type Props = {
 	skipOpenApiAnalysis: boolean
@@ -46,10 +46,11 @@ export class Router<StateT = Koa.DefaultState, ContextT = Koa.DefaultContext> {
 		callback: KoaRouter.Middleware<StateT, ContextT & ExtractedRequestParams<P>>
 	) {
 		this.koaRouter.get(path, async (ctx) => {
-			ctx.set('Content-Type', 'application/json; charset=utf-8')
 			// @ts-ignore
 			const responseValue = await callback(ctx, undefined)
-			ctx.body = responseValueToJson(responseValue)
+			const { value, contentType } = parseEndpointReturnValue(responseValue)
+			ctx.body = value
+			ctx.set('Content-Type', contentType)
 		})
 		return this
 	}
@@ -59,10 +60,11 @@ export class Router<StateT = Koa.DefaultState, ContextT = Koa.DefaultContext> {
 		callback: KoaRouter.Middleware<StateT, ContextT & ExtractedRequestParams<P>>
 	) {
 		this.koaRouter.post(path, async (ctx) => {
-			ctx.set('Content-Type', 'application/json; charset=utf-8')
 			// @ts-ignore
 			const responseValue = await callback(ctx, undefined)
-			ctx.body = responseValueToJson(responseValue)
+			const { value, contentType } = parseEndpointReturnValue(responseValue)
+			ctx.body = value
+			ctx.set('Content-Type', contentType)
 		})
 		return this
 	}
@@ -72,10 +74,11 @@ export class Router<StateT = Koa.DefaultState, ContextT = Koa.DefaultContext> {
 		callback: KoaRouter.Middleware<StateT, ContextT & ExtractedRequestParams<P>>
 	) {
 		this.koaRouter.put(path, async (ctx) => {
-			ctx.set('Content-Type', 'application/json; charset=utf-8')
 			// @ts-ignore
 			const responseValue = await callback(ctx, undefined)
-			ctx.body = responseValueToJson(responseValue)
+			const { value, contentType } = parseEndpointReturnValue(responseValue)
+			ctx.body = value
+			ctx.set('Content-Type', contentType)
 		})
 		return this
 	}
@@ -85,10 +88,11 @@ export class Router<StateT = Koa.DefaultState, ContextT = Koa.DefaultContext> {
 		callback: KoaRouter.Middleware<StateT, ContextT & ExtractedRequestParams<P>>
 	) {
 		this.koaRouter.delete(path, async (ctx) => {
-			ctx.set('Content-Type', 'application/json; charset=utf-8')
 			// @ts-ignore
 			const responseValue = await callback(ctx, undefined)
-			ctx.body = responseValueToJson(responseValue)
+			const { value, contentType } = parseEndpointReturnValue(responseValue)
+			ctx.body = value
+			ctx.set('Content-Type', contentType)
 		})
 		return this
 	}
@@ -98,10 +102,11 @@ export class Router<StateT = Koa.DefaultState, ContextT = Koa.DefaultContext> {
 		callback: KoaRouter.Middleware<StateT, ContextT & ExtractedRequestParams<P>>
 	) {
 		this.koaRouter.del(path, async (ctx) => {
-			ctx.set('Content-Type', 'application/json; charset=utf-8')
 			// @ts-ignore
 			const responseValue = await callback(ctx, undefined)
-			ctx.body = responseValueToJson(responseValue)
+			const { value, contentType } = parseEndpointReturnValue(responseValue)
+			ctx.body = value
+			ctx.set('Content-Type', contentType)
 		})
 		return this
 	}
@@ -111,10 +116,11 @@ export class Router<StateT = Koa.DefaultState, ContextT = Koa.DefaultContext> {
 		callback: KoaRouter.Middleware<StateT, ContextT & ExtractedRequestParams<P>>
 	) {
 		this.koaRouter.patch(path, async (ctx) => {
-			ctx.set('Content-Type', 'application/json; charset=utf-8')
 			// @ts-ignore
 			const responseValue = await callback(ctx, undefined)
-			ctx.body = responseValueToJson(responseValue)
+			const { value, contentType } = parseEndpointReturnValue(responseValue)
+			ctx.body = value
+			ctx.set('Content-Type', contentType)
 		})
 		return this
 	}

package/src/router/parseEndpointReturnValue.spec.ts

@@ -0,0 +1,35 @@
+import { parseEndpointReturnValue } from './parseEndpointReturnValue'
+
+describe('parseEndpointReturnValue', () => {
+	it('returns string as plain text data', () => {
+		const value = 'foo'
+		expect(parseEndpointReturnValue(value)).toEqual({
+			value,
+			contentType: 'text/plain',
+		})
+	})
+
+	it('returns Buffer as raw data', () => {
+		const value = Buffer.from('foo')
+		expect(parseEndpointReturnValue(value)).toEqual({
+			value,
+			contentType: 'application/octet-stream',
+		})
+	})
+
+	it('transforms object into JSON', () => {
+		const value = { foo: 'bar' }
+		expect(parseEndpointReturnValue(value)).toEqual({
+			value: JSON.stringify(value),
+			contentType: 'application/json; charset=utf-8',
+		})
+	})
+
+	it('keeps custom content type', () => {
+		const value = {
+			value: 'foo',
+			contentType: 'application/custom',
+		}
+		expect(parseEndpointReturnValue(value)).toEqual(value)
+	})
+})

package/src/router/parseEndpointReturnValue.ts

@@ -0,0 +1,31 @@
+export const parseEndpointReturnValue = (response: unknown) => {
+	if (
+		typeof response === 'object' &&
+		response &&
+		'value' in response &&
+		typeof response['value'] === 'string' &&
+		'contentType' in response &&
+		typeof response['contentType'] === 'string'
+	) {
+		return {
+			value: response.value,
+			contentType: response.contentType,
+		}
+	}
+	if (typeof response === 'string') {
+		return {
+			value: response,
+			contentType: 'text/plain',
+		}
+	}
+	if (Buffer.isBuffer(response)) {
+		return {
+			value: response,
+			contentType: 'application/octet-stream',
+		}
+	}
+	return {
+		value: JSON.stringify(response, (_, value) => (typeof value === 'bigint' ? value.toString() : value)),
+		contentType: 'application/json; charset=utf-8',
+	}
+}

package/src/router/responseValueToJson.ts

@@ -1,6 +0,0 @@
-export const responseValueToJson = (value: any) => {
-	if (typeof value === 'string') {
-		return value
-	}
-	return JSON.stringify(value, (_, value) => (typeof value === 'bigint' ? value.toString() : value))
-}