moonflower 0.10.2 → 0.10.4

package/src/router/Router.ts

@@ -20,6 +20,20 @@ export class Router<StateT = Koa.DefaultState, ContextT = Koa.DefaultContext> {
 		}
 	}
 
+	private async sendResponseValue<P extends string>(
+		ctx: Parameters<Parameters<KoaRouter['get']>[1]>[0],
+		callback: KoaRouter.Middleware<StateT, ContextT & ExtractedRequestParams<P>>
+	) {
+		// @ts-ignore
+		const responseValue = await callback(ctx, undefined)
+		const { value, status, contentType } = parseEndpointReturnValue(responseValue)
+		ctx.body = value
+		if (status !== 'unset') {
+			ctx.status = status
+		}
+		ctx.set('Content-Type', contentType)
+	}
+
 	public use(...middleware: Array<KoaRouter.Middleware<StateT, ContextT>>) {
 		// @ts-ignore
 		this.koaRouter.use(...middleware)
@@ -46,11 +60,7 @@ export class Router<StateT = Koa.DefaultState, ContextT = Koa.DefaultContext> {
 		callback: KoaRouter.Middleware<StateT, ContextT & ExtractedRequestParams<P>>
 	) {
 		this.koaRouter.get(path, async (ctx) => {
-			// @ts-ignore
-			const responseValue = await callback(ctx, undefined)
-			const { value, contentType } = parseEndpointReturnValue(responseValue)
-			ctx.body = value
-			ctx.set('Content-Type', contentType)
+			await this.sendResponseValue(ctx, callback)
 		})
 		return this
 	}
@@ -60,11 +70,7 @@ export class Router<StateT = Koa.DefaultState, ContextT = Koa.DefaultContext> {
 		callback: KoaRouter.Middleware<StateT, ContextT & ExtractedRequestParams<P>>
 	) {
 		this.koaRouter.post(path, async (ctx) => {
-			// @ts-ignore
-			const responseValue = await callback(ctx, undefined)
-			const { value, contentType } = parseEndpointReturnValue(responseValue)
-			ctx.body = value
-			ctx.set('Content-Type', contentType)
+			await this.sendResponseValue(ctx, callback)
 		})
 		return this
 	}
@@ -74,11 +80,7 @@ export class Router<StateT = Koa.DefaultState, ContextT = Koa.DefaultContext> {
 		callback: KoaRouter.Middleware<StateT, ContextT & ExtractedRequestParams<P>>
 	) {
 		this.koaRouter.put(path, async (ctx) => {
-			// @ts-ignore
-			const responseValue = await callback(ctx, undefined)
-			const { value, contentType } = parseEndpointReturnValue(responseValue)
-			ctx.body = value
-			ctx.set('Content-Type', contentType)
+			await this.sendResponseValue(ctx, callback)
 		})
 		return this
 	}
@@ -88,11 +90,7 @@ export class Router<StateT = Koa.DefaultState, ContextT = Koa.DefaultContext> {
 		callback: KoaRouter.Middleware<StateT, ContextT & ExtractedRequestParams<P>>
 	) {
 		this.koaRouter.delete(path, async (ctx) => {
-			// @ts-ignore
-			const responseValue = await callback(ctx, undefined)
-			const { value, contentType } = parseEndpointReturnValue(responseValue)
-			ctx.body = value
-			ctx.set('Content-Type', contentType)
+			await this.sendResponseValue(ctx, callback)
 		})
 		return this
 	}
@@ -102,11 +100,7 @@ export class Router<StateT = Koa.DefaultState, ContextT = Koa.DefaultContext> {
 		callback: KoaRouter.Middleware<StateT, ContextT & ExtractedRequestParams<P>>
 	) {
 		this.koaRouter.del(path, async (ctx) => {
-			// @ts-ignore
-			const responseValue = await callback(ctx, undefined)
-			const { value, contentType } = parseEndpointReturnValue(responseValue)
-			ctx.body = value
-			ctx.set('Content-Type', contentType)
+			await this.sendResponseValue(ctx, callback)
 		})
 		return this
 	}
@@ -116,11 +110,7 @@ export class Router<StateT = Koa.DefaultState, ContextT = Koa.DefaultContext> {
 		callback: KoaRouter.Middleware<StateT, ContextT & ExtractedRequestParams<P>>
 	) {
 		this.koaRouter.patch(path, async (ctx) => {
-			// @ts-ignore
-			const responseValue = await callback(ctx, undefined)
-			const { value, contentType } = parseEndpointReturnValue(responseValue)
-			ctx.body = value
-			ctx.set('Content-Type', contentType)
+			await this.sendResponseValue(ctx, callback)
 		})
 		return this
 	}

package/src/router/parseEndpointReturnValue.spec.ts

@@ -1,3 +1,4 @@
+import { useReturnValue } from '../hooks/useReturnValue'
 import { parseEndpointReturnValue } from './parseEndpointReturnValue'
 
 describe('parseEndpointReturnValue', () => {
@@ -5,6 +6,16 @@ describe('parseEndpointReturnValue', () => {
 		const value = 'foo'
 		expect(parseEndpointReturnValue(value)).toEqual({
 			value,
+			status: 'unset',
+			contentType: 'text/plain',
+		})
+	})
+
+	it('returns number as plain text data', () => {
+		const value = 100
+		expect(parseEndpointReturnValue(value)).toEqual({
+			value: '100',
+			status: 'unset',
 			contentType: 'text/plain',
 		})
 	})
@@ -13,6 +24,7 @@ describe('parseEndpointReturnValue', () => {
 		const value = Buffer.from('foo')
 		expect(parseEndpointReturnValue(value)).toEqual({
 			value,
+			status: 'unset',
 			contentType: 'application/octet-stream',
 		})
 	})
@@ -21,15 +33,50 @@ describe('parseEndpointReturnValue', () => {
 		const value = { foo: 'bar' }
 		expect(parseEndpointReturnValue(value)).toEqual({
 			value: JSON.stringify(value),
+			status: 'unset',
 			contentType: 'application/json; charset=utf-8',
 		})
 	})
 
-	it('keeps custom content type', () => {
-		const value = {
+	it('parses useReturnValue with string value correctly', () => {
+		const value: ReturnType<typeof useReturnValue> = {
+			_isUseReturnValue: true,
 			value: 'foo',
+			status: 418,
 			contentType: 'application/custom',
 		}
-		expect(parseEndpointReturnValue(value)).toEqual(value)
+		expect(parseEndpointReturnValue(value)).toEqual({
+			value: 'foo',
+			status: 418,
+			contentType: 'application/custom',
+		})
+	})
+
+	it('parses useReturnValue with number value correctly', () => {
+		const value: ReturnType<typeof useReturnValue> = {
+			_isUseReturnValue: true,
+			value: 100,
+			status: 418,
+			contentType: 'application/custom',
+		}
+		expect(parseEndpointReturnValue(value)).toEqual({
+			value: '100',
+			status: 418,
+			contentType: 'application/custom',
+		})
+	})
+
+	it('parses useReturnValue with Buffer value correctly', () => {
+		const value: ReturnType<typeof useReturnValue> = {
+			_isUseReturnValue: true,
+			value: Buffer.from('foo'),
+			status: 418,
+			contentType: 'application/custom',
+		}
+		expect(parseEndpointReturnValue(value)).toEqual({
+			value: Buffer.from('foo'),
+			status: 418,
+			contentType: 'application/custom',
+		})
 	})
 })

package/src/router/parseEndpointReturnValue.ts

@@ -2,30 +2,37 @@ export const parseEndpointReturnValue = (response: unknown) => {
 	if (
 		typeof response === 'object' &&
 		response &&
+		'_isUseReturnValue' in response &&
 		'value' in response &&
-		typeof response['value'] === 'string' &&
+		'status' in response &&
 		'contentType' in response &&
+		response['_isUseReturnValue'] === true &&
+		typeof response['status'] === 'number' &&
 		typeof response['contentType'] === 'string'
 	) {
 		return {
-			value: response.value,
+			value: Buffer.isBuffer(response.value) ? response.value : String(response.value),
+			status: response.status,
 			contentType: response.contentType,
 		}
 	}
-	if (typeof response === 'string') {
+	if (['string', 'boolean', 'number', 'bigint', 'symbol'].includes(typeof response)) {
 		return {
-			value: response,
+			value: String(response),
+			status: 'unset' as const,
 			contentType: 'text/plain',
 		}
 	}
 	if (Buffer.isBuffer(response)) {
 		return {
 			value: response,
+			status: 'unset' as const,
 			contentType: 'application/octet-stream',
 		}
 	}
 	return {
 		value: JSON.stringify(response, (_, value) => (typeof value === 'bigint' ? value.toString() : value)),
+		status: 'unset' as const,
 		contentType: 'application/json; charset=utf-8',
 	}
 }

package/src/test/TestAppRouter.ts

@@ -4,6 +4,7 @@ import {
 	NonEmptyStringValidator,
 	UnauthorizedError,
 	useQueryParams,
+	useReturnValue,
 } from '..'
 import { Router as RenamedRouter } from '../router/Router'
 
@@ -67,6 +68,14 @@ myRouter.get('/test/get/bigint', () => {
 	}
 })
 
+myRouter.get('/test/get/useReturnValue', () => {
+	return useReturnValue('foo', 418, 'text/custom')
+})
+
+myRouter.get('/test/get/useReturnValue/buffer', () => {
+	return useReturnValue(Buffer.from('foo'), 418, 'text/custom')
+})
+
 myRouter.get('/test/get/middleware-data', (ctx) => {
 	return {
 		user: ctx.user,

package/src/test/app.spec.ts

@@ -81,6 +81,20 @@ describe('TestAppRouter', () => {
 		expect(response.text).toBe(JSON.stringify({ foo: '100' }))
 	})
 
+	it('handles useReturnValue return value correctly', async () => {
+		const response = await request(app.callback()).get('/test/get/useReturnValue')
+		expect(response.text).toBe('foo')
+		expect(response.status).toBe(418)
+		expect(response.header['content-type']).toEqual('text/custom')
+	})
+
+	it('handles useReturnValue binary return value correctly', async () => {
+		const response = await request(app.callback()).get('/test/get/useReturnValue')
+		expect(response.text).toBe('foo')
+		expect(response.status).toBe(418)
+		expect(response.header['content-type']).toEqual('text/custom')
+	})
+
 	it('includes middleware data from context', async () => {
 		const response = await request(app.callback()).get('/test/get/middleware-data')
 		expect(response.status).toBe(200)