Upgrade to @graphql-ts/schema@1

[emmatown]

This updates Keystone to @graphql-ts/schema@1.0.0 which makes a few changes, the most notable thing for users is that they should use gWithContext to bind g(named graphql in the current stable version of keystone, renamed to g in #9460) to their own Context type from .keystone/types instead of using the g exported by @keystone-6/core that is bound to the generic KeystoneContext.

import { gWithContext } from '@keystone-6/core'
import type { Context } from '.keystone/types'

const g = gWithContext<Context>()
type g<T> = gWithContext.infer<T>

This means that e.g. writing resolvers will have the correct context type.

The g type alias is used to help declaring types, particular for circular types, like this:

type PersonSource = {
  id: string;
  name: string;
};

const Person: g<typeof g.object<PersonSource>> = g.object<PersonSource>()({
  name: "Person",
  fields: () => ({
    id: g.field({ type: g.nonNull(g.ID) }),
    name: g.field({ type: g.nonNull(g.String) }),
    friends: g.field({
      type: g.list(g.nonNull(Person)),
      resolve(source, _, context) {
        return []
      },
    }),
  }),
});

Without the g<typeof g.object<PersonSource>>, TypeScript would error about the circularity. Previously this could be written with g.ObjectType<PersonSource>, the types for this no longer exist, you should now use the g<typeof g.something<...>> or imports from @keystone-6/core/graphql-ts which re-exports types from @graphql-ts/schema.

Another notable change is that all the various types returned by e.g. g.object/etc. are now directly compatible with GraphQLObjectType/etc. from GraphQL.js instead of being accessible at .graphQLType on the returned object.

Also, the minimum TypeScript version is now 5.7.

[socket-security]

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher

🚮 Removed packages: npm/@graphql-ts/extend@1.0.3, npm/@graphql-ts/schema@0.6.4

View full report↗︎

[dcousens]

Amazing