chore: implicitly infer SchemaCompiler as readonly by DemonHa · Pull Request #5060 · fastify/fastify

DemonHa · 2023-09-25T13:19:02Z

Skip explicitly providing as const when defining a schema with json-schema-to-ts as a type provider.

Now we can go from this:

const server = fastify().withTypeProvider<JsonSchemaToTsProvider>()

server.get('/route', {
    schema: {
        querystring: {
            type: 'object',
            properties: {
                foo: { type: 'number' },
                bar: { type: 'string' },
            },
            required: ['foo', 'bar']
        }
    } as const // <----- You had to specify it as const to get the literal types
}, (request, reply) => {
    const { foo, bar } = request.query // type safe!
})

To this:

const server = fastify().withTypeProvider<JsonSchemaToTsProvider>()

server.get('/route', {
    schema: {
        querystring: {
            type: 'object',
            properties: {
                foo: { type: 'number' },
                bar: { type: 'string' },
            },
            required: ['foo', 'bar']
        }
    } // <--- We can now skip as const because the compiler knows that object is both readonly and literal type
}, (request, reply) => {
    const { foo, bar } = request.query // type safe!
})

Checklist

run npm run test and npm run benchmark
tests and/or benchmarks are included
documentation is changed or added
commit message and code follows the Developer's Certification of Origin
and the Code of conduct

Uzlopak · 2023-09-25T14:34:49Z

Didnt know you can define them as const like this?!

DemonHa · 2023-09-25T14:54:15Z

@Uzlopak You have to manually add as const so the compiler knows to use the literal types, so JsonSchemaToTsProvider can do the magic behind the scene. With this change you don't have to manually add as const in every schema because the complier can understand your intention

Eomm · 2023-09-25T19:24:21Z

What if we release it and the user has written as const? Does it break the codebase?

DemonHa · 2023-09-25T20:18:39Z

@Eomm It does not break, its fully backward compatible. The only difference is that you don't need to manually tell the compiler, but it you want you can still do it.

DemonHa · 2023-09-25T20:28:46Z

@Eomm I can also add a test case with as const

mcollina

lgtm

Uzlopak

LGTM

Uzlopak · 2023-09-26T14:07:44Z

@DemonHa

Do you plan to improve our typings on the long run? :)

DemonHa · 2023-09-26T15:00:24Z

@Uzlopak I would love to

fox1t · 2023-11-10T11:33:05Z

One note: This works only with the latest TS version and no longer compiles on TS v4.x.x.

I needed to upgrade TS in several projects after updating Fastify.

PS: we decided we don't care about semver when dealing with types and TS, so this is fine. I am pointing this out since, at the end of the day, this was a breaking change. :)

github-actions · 2024-11-10T00:29:16Z

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

chore: explicitly infer SchemaCompiler as readonly

97c143a

DemonHa changed the title ~~chore: explicitly infer SchemaCompiler as readonly~~ chore: implicitly infer SchemaCompiler as readonly Sep 25, 2023

test: missing test case

719ba37

mcollina approved these changes Sep 26, 2023

View reviewed changes

Uzlopak approved these changes Sep 26, 2023

View reviewed changes

mcollina merged commit 14a9ccc into fastify:main Sep 26, 2023

arthurfiorette mentioned this pull request Oct 18, 2023

Type definitions do not compile anymore when using TypeScript v4.6 #4873

Closed

2 tasks

Uzlopak mentioned this pull request Nov 2, 2023

Fix instance.d.ts to remove const in function declaration #5133

Closed

4 tasks

github-actions Bot locked as resolved and limited conversation to collaborators Nov 10, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore: implicitly infer SchemaCompiler as readonly#5060

chore: implicitly infer SchemaCompiler as readonly#5060
mcollina merged 2 commits into
fastify:mainfrom
DemonHa:skip-as-const

DemonHa commented Sep 25, 2023 •

edited

Loading

Uh oh!

Uzlopak commented Sep 25, 2023

Uh oh!

DemonHa commented Sep 25, 2023

Uh oh!

Eomm commented Sep 25, 2023

Uh oh!

DemonHa commented Sep 25, 2023 •

edited

Loading

Uh oh!

DemonHa commented Sep 25, 2023

Uh oh!

mcollina left a comment

Uh oh!

Uzlopak left a comment

Uh oh!

Uzlopak commented Sep 26, 2023

Uh oh!

DemonHa commented Sep 26, 2023

Uh oh!

fox1t commented Nov 10, 2023

Uh oh!

github-actions Bot commented Nov 10, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

DemonHa commented Sep 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Uh oh!

Uzlopak commented Sep 25, 2023

Uh oh!

DemonHa commented Sep 25, 2023

Uh oh!

Eomm commented Sep 25, 2023

Uh oh!

DemonHa commented Sep 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DemonHa commented Sep 25, 2023

Uh oh!

mcollina left a comment

Choose a reason for hiding this comment

Uh oh!

Uzlopak left a comment

Choose a reason for hiding this comment

Uh oh!

Uzlopak commented Sep 26, 2023

Uh oh!

DemonHa commented Sep 26, 2023

Uh oh!

fox1t commented Nov 10, 2023

Uh oh!

github-actions Bot commented Nov 10, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

DemonHa commented Sep 25, 2023 •

edited

Loading

DemonHa commented Sep 25, 2023 •

edited

Loading