fastify-type-provider-json-schema-to-ts
fastify-type-provider-json-schema-to-ts copied to clipboard
Circular reference types when used with @fastify/multipart
Prerequisites
- [X] I have written a descriptive issue title
- [X] I have searched existing issues to ensure the bug has not already been reported
Fastify version
4.22.0
Plugin version
2.2.2
Node.js version
18.16.0
Operating system
macOS
Operating system version (i.e. 20.04, 11.3, 10)
12.6.8
Description
Using FastifyPluginAsyncJsonSchemaToTs along with the shared schema from @fastify/multipart generates a circular type error:
[TypeScript] src/routes/indexes/index.ts:104:40 - error TS2615: Type of property 'file' circularly references itself in mapped type '{ file: Never; }'.
[TypeScript]
[TypeScript] 104 const { file } = request.body;
[TypeScript] ~~~~~~~~~~~~
Steps to Reproduce
- Configure
@fastify/multipartin a test project with these options:
import fp from 'fastify-plugin';
import multipart from '@fastify/multipart';
export default fp(async (fastify) => {
fastify.register(multipart, {
attachFieldsToBody: true,
sharedSchemaId: '#multipartField',
});
});
- Create a route that references the shared schema:
import { FastifyPluginAsyncJsonSchemaToTs } from '@fastify/type-provider-json-schema-to-ts';
const root: FastifyPluginAsyncJsonSchemaToTs = async (fastify, opts): Promise<void> => {
fastify.post('/upload', {
schema: {
body: {
type: 'object',
properties: {
file: { $ref: '#multipartField' },
},
required: ['file'],
},
} as const,
handler: async function (request, reply) {
const { file } = request.body;
}
});
});
Expected Behavior
No error