Tags property doesn't exist in FastifySchema in TypeScript

[marko1010]

Prerequisites

• I have written a descriptive issue title
• I have searched existing issues to ensure the bug has not already been reported

Fastify version

4.5.3

Plugin version

7.5.1

Node.js version

14.7.3

Operating system

Windows

Operating system version (i.e. 20.04, 11.3, 10)

10

Description

When trying to add 'tags' property to Fastify schema, TypeScript complains with the following error:

Type '{ tags: string[]; body: TObject<{ firstName: TOptional<TString>; lastName: TOptional<TString>; email: TString; password: TString; }>; }' is not assignable to type 'FastifySchema'.
  Object literal may only specify known properties, and 'tags' does not exist in type 'FastifySchema'.ts(2322)

Steps to Reproduce

 fastify.post<{ Body: newUserType }>('/register', { schema: { tags: ['user'], body: newUserSchema } }, async (req, rep) => {
  });

Expected Behavior

No response

[mcollina]

cc @fastify/typescript

[oitozero]

@marko1010 I'm having the same problem. Have you been able to solve it? cc/ @mcollina

[CNLHC]

@marko1010 I'm having the same problem. Have you been able to solve it? cc/ @mcollina

@oitozero A quick fix: creating a global index.d.ts and using type augmentation

declare module 'fastify' {
    interface FastifySchema {
        body?: unknown;
        querystring?: unknown;
        params?: unknown;
        headers?: unknown;
        response?: unknown;
        tags?: string[]
    }
}

This can fix the problem but is not a good solution.

I think we need to wait for the developer to add the missing type to the type definition.

[climba03003]

I think we need to wait for the developer to add the missing type to the type definition.

The types exist, most of the issue related to project setup.
And I didn't see a repro for us to debug.

[CNLHC]

I think we need to wait for the developer to add the missing type to the type definition.

The types exist, and most of the issues are related to project setup. And I didn't see a repro for us to debug.

oh you are right, the type can be found at

fastify-swagger/index.d.ts

Line 34 in c8d675d

interface FastifySchema {

So the cause of this PR is the extra type shipped with this package is not recognized by the typescript. It does sound like a project setup problem.

[Kislax]

@marko1010, @oitozero
Hello, I spent about 5 hours to find what the problem was, it turned out that I did not import the plugins correctly
As you wrote, it depends on the configuration of ts, namely the selected type of module/moduleResolution

Hope it helps someone

Source link
fastify/fastify#4122

not working

worked.

need import library to file