Easier context binding

emmatown · emmatown · commit 320e8d18f21d · 2025-03-11T17:31:33.000+10:00
diff --git a/examples/auth-magic-link/schema.ts b/examples/auth-magic-link/schema.ts
@@ -1,10 +1,13 @@
-import { g, list } from '@keystone-6/core'
+import { initG, list } from '@keystone-6/core'
 import { allowAll, denyAll } from '@keystone-6/core/access'
 import { password, text, timestamp } from '@keystone-6/core/fields'
-import type { Lists, Context } from '.keystone/types'
+import type { Lists, TypeInfo } from '.keystone/types'
 
 import { randomBytes } from 'node:crypto'
 
+const g = initG<TypeInfo>()
+type g<T> = initG<T>
+
 export type Session = {
   itemId: string
 }
@@ -107,7 +110,7 @@ export const extendGraphqlSchema = g.extend(base => {
         type: g.nonNull(g.Boolean), // always true
         args: { userId: g.arg({ type: g.nonNull(g.String) }) },
 
-        async resolve(args, { userId }, context: Context) {
+        async resolve(args, { userId }, context) {
           // run asynchronously to reduce timing attacks
           ;(async function () {
             const ott = randomBytes(16).toString('base64url')
@@ -141,7 +144,7 @@ export const extendGraphqlSchema = g.extend(base => {
           token: g.arg({ type: g.nonNull(g.String) }),
         },
 
-        async resolve(args, { userId, token }, context: Context) {
+        async resolve(args, { userId, token }, context) {
           if (!context.sessionStrategy)
             throw new Error('No session implementation available on context')
 
diff --git a/examples/extend-graphql-schema-graphql-ts/schema.ts b/examples/extend-graphql-schema-graphql-ts/schema.ts
@@ -1,7 +1,10 @@
-import { g, list } from '@keystone-6/core'
+import { initG, list } from '@keystone-6/core'
 import { allowAll } from '@keystone-6/core/access'
 import { select, relationship, text, timestamp } from '@keystone-6/core/fields'
-import { type Context, type Lists } from '.keystone/types'
+import type { TypeInfo, Lists } from '.keystone/types'
+
+const g = initG<TypeInfo>()
+type g<T> = initG<T>
 
 export const lists = {
   Post: list({
@@ -37,23 +40,23 @@ export const extendGraphqlSchema = g.extend(base => {
     fields: {
       draft: g.field({
         type: g.Int,
-        resolve({ authorId }, args, context: Context) {
+        resolve({ authorId }, args, context) {
           return context.query.Post.count({
             where: { author: { id: { equals: authorId } }, status: { equals: 'draft' } },
           })
         },
       }),
       published: g.field({
         type: g.Int,
-        resolve({ authorId }, args, context: Context) {
+        resolve({ authorId }, args, context) {
           return context.query.Post.count({
             where: { author: { id: { equals: authorId } }, status: { equals: 'published' } },
           })
         },
       }),
       latest: g.field({
         type: base.object('Post'),
-        async resolve({ authorId }, args, context: Context) {
+        async resolve({ authorId }, args, context) {
           const [post] = await context.db.Post.findMany({
             take: 1,
             orderBy: { publishDate: 'desc' },
@@ -72,7 +75,7 @@ export const extendGraphqlSchema = g.extend(base => {
         // with the name provided or throw if it doesn't exist
         type: base.object('Post'),
         args: { id: g.arg({ type: g.nonNull(g.ID) }) },
-        resolve(source, { id }, context: Context) {
+        resolve(source, { id }, context) {
           // Note we use `context.db.Post` here as we have a return type
           // of Post, and this API provides results in the correct format.
           // If you accidentally use `context.query.Post` here you can expect problems
@@ -90,7 +93,7 @@ export const extendGraphqlSchema = g.extend(base => {
             banPost: g.field({
               type: base.object('Post'),
               args: { id: g.arg({ type: g.nonNull(g.ID) }) },
-              resolve(source, { id }, context: Context) {
+              resolve(source, { id }, context) {
                 return context.db.Post.updateOne({
                   where: { id },
                   data: { status: 'banned' },
@@ -107,7 +110,7 @@ export const extendGraphqlSchema = g.extend(base => {
           id: g.arg({ type: g.nonNull(g.ID) }),
           seconds: g.arg({ type: g.nonNull(g.Int), defaultValue: 600 }),
         },
-        resolve(source, { id, seconds }, context: Context) {
+        resolve(source, { id, seconds }, context) {
           const cutoff = new Date(Date.now() - seconds * 1000)
 
           // Note we use `context.db.Post` here as we have a return type
diff --git a/examples/graphql-codegen/schema.ts b/examples/graphql-codegen/schema.ts
@@ -1,10 +1,13 @@
 /* eslint-disable @typescript-eslint/consistent-type-imports */
-import { list, g } from '@keystone-6/core'
+import { list, initG } from '@keystone-6/core'
 import { relationship, text, timestamp, virtual } from '@keystone-6/core/fields'
 import { allowAll } from '@keystone-6/core/access'
 import { graphql } from './gql'
 
-import type { Lists } from '.keystone/types'
+import type { Lists, TypeInfo } from '.keystone/types'
+
+const g = initG<TypeInfo>()
+type g<T> = initG<T>
 
 const LatestPostQuery = graphql(/* GraphQL */ `
   query LastestPostQuery($id: ID!) {
diff --git a/examples/graphql-gql.tada/schema.ts b/examples/graphql-gql.tada/schema.ts
@@ -1,8 +1,8 @@
-import { list, g } from '@keystone-6/core'
+import { initG, list } from '@keystone-6/core'
 import { relationship, text, timestamp, virtual } from '@keystone-6/core/fields'
 import { allowAll } from '@keystone-6/core/access'
 import { graphql } from './tada'
-import type { Lists } from '.keystone/types'
+import type { Lists, TypeInfo } from '.keystone/types'
 
 const LatestPostQuery = graphql(`
   query LastestPostQuery($id: ID!) {
@@ -15,6 +15,9 @@ const LatestPostQuery = graphql(`
   }
 `)
 
+const g = initG<TypeInfo>()
+type g<T> = initG<T>
+
 export const lists: Lists = {
   Post: list({
     access: allowAll,
diff --git a/examples/graphql-ts-gql/schema.ts b/examples/graphql-ts-gql/schema.ts
@@ -1,10 +1,10 @@
 /* eslint-disable @typescript-eslint/consistent-type-imports */
-import { list, g } from '@keystone-6/core'
+import { list, initG } from '@keystone-6/core'
 import { relationship, text, timestamp, virtual } from '@keystone-6/core/fields'
 import { allowAll } from '@keystone-6/core/access'
 import { gql } from '@ts-gql/tag/no-transform'
 
-import type { Lists } from '.keystone/types'
+import type { Lists, TypeInfo } from '.keystone/types'
 
 const LatestPostQuery = gql`
   query LastestPostQuery($id: ID!) {
@@ -18,6 +18,9 @@ const LatestPostQuery = gql`
   }
 ` as import('./__generated__/ts-gql/LastestPostQuery').type
 
+const g = initG<TypeInfo>()
+type g<T> = initG<T>
+
 export const lists = {
   Post: list({
     access: allowAll,
diff --git a/examples/number-fields/schema.ts b/examples/number-fields/schema.ts
@@ -1,7 +1,10 @@
-import { list, g } from '@keystone-6/core'
+import { list, initG } from '@keystone-6/core'
 import { bigInt, float, integer, virtual } from '@keystone-6/core/fields'
 import { allowAll } from '@keystone-6/core/access'
-import type { Lists } from '.keystone/types'
+import type { Lists, TypeInfo } from '.keystone/types'
+
+const g = initG<TypeInfo>()
+type g<T> = initG<T>
 
 export const lists = {
   Example: list({
diff --git a/examples/transactions/schema.ts b/examples/transactions/schema.ts
@@ -1,15 +1,18 @@
-import { g, list } from '@keystone-6/core'
+import { initG, list } from '@keystone-6/core'
 import { allowAll } from '@keystone-6/core/access'
 import { text, integer, relationship, timestamp, virtual } from '@keystone-6/core/fields'
-import { type Context, type Lists } from '.keystone/types'
+import type { Lists, TypeInfo } from '.keystone/types'
+
+const g = initG<TypeInfo>()
+type g<T> = initG<T>
 
 export const extendGraphqlSchema = g.extend(base => {
   return {
     mutation: {
       submitOrder: g.field({
         type: base.object('Order'),
         args: {},
-        async resolve(source, {}, context: Context) {
+        async resolve(source, {}, context) {
           // TODO: this should come from GraphQL arguments
           const orderInput = [
             { sku: '123', count: 1 },
diff --git a/examples/usecase-relationship-union/schema.ts b/examples/usecase-relationship-union/schema.ts
@@ -1,7 +1,7 @@
-import { list, group, g } from '@keystone-6/core'
+import { list, group, initG } from '@keystone-6/core'
 import { allowAll } from '@keystone-6/core/access'
 import { text, relationship, virtual } from '@keystone-6/core/fields'
-import type { Lists } from '.keystone/types'
+import type { Lists, TypeInfo } from '.keystone/types'
 
 function ifUnsetHideUI<Key extends string>(field: Key) {
   return {
@@ -15,6 +15,9 @@ function ifUnsetHideUI<Key extends string>(field: Key) {
   }
 }
 
+const g = initG<TypeInfo>()
+type g<T> = initG<T>
+
 export const lists: Lists = {
   Post: list({
     access: allowAll,
diff --git a/examples/virtual-field/schema.ts b/examples/virtual-field/schema.ts
@@ -1,8 +1,11 @@
-import { list, g } from '@keystone-6/core'
+import { list, initG } from '@keystone-6/core'
 import { text, checkbox, virtual } from '@keystone-6/core/fields'
 import { allowAll } from '@keystone-6/core/access'
 
-import type { Lists } from '.keystone/types'
+import type { Lists, TypeInfo } from '.keystone/types'
+
+const g = initG<TypeInfo>()
+type g<T> = initG<T>
 
 export const lists = {
   Post: list({
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -235,8 +235,8 @@
     "@aws-sdk/lib-storage": "^3.83.0",
     "@aws-sdk/s3-request-presigner": "^3.83.0",
     "@babel/runtime": "^7.24.7",
-    "@graphql-ts/extend": "https://pkg.pr.new/Thinkmill/graphql-ts/@graphql-ts/extend@5eafeea",
-    "@graphql-ts/schema": "https://pkg.pr.new/Thinkmill/graphql-ts/@graphql-ts/schema@5eafeea",
+    "@graphql-ts/extend": "0.0.0-test-20250311072637",
+    "@graphql-ts/schema": "0.0.0-test-20250311072637",
     "@graphql-typed-document-node/core": "^3.1.2",
     "@hapi/iron": "^7.0.0",
     "@internationalized/date": "^3.5.5",
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -7,3 +7,5 @@ export type { ListConfig, BaseFields } from './types'
 // if this was an explicit list, it would change the re-export here
 // rather than the usage in their project
 export * from './types/schema'
+
+export { initG } from './types/schema/graphql-ts-schema'
diff --git a/packages/core/src/types/schema/graphql-ts-schema.ts b/packages/core/src/types/schema/graphql-ts-schema.ts
@@ -2,12 +2,10 @@ import type { ReadStream } from 'node:fs'
 import * as graphqlTsSchema from '@graphql-ts/schema'
 // @ts-expect-error
 import GraphQLUpload from 'graphql-upload/GraphQLUpload.js'
-import type { GraphQLFieldExtensions, GraphQLResolveInfo } from 'graphql'
 import { GraphQLError, GraphQLScalarType } from 'graphql'
 import { Decimal as DecimalValue } from 'decimal.js'
 import type { KeystoneContext } from '../context'
 import type { JSONValue } from '../utils'
-import { field as fieldd } from './schema-api-with-context'
 
 export {
   Boolean,
@@ -37,79 +35,42 @@ export type {
   NullableInputType,
   ScalarType,
 } from '@graphql-ts/schema/api-without-context'
-export { bindGraphQLSchemaAPIToContext } from '@graphql-ts/schema'
 export type { BaseSchemaMeta, Extension } from '@graphql-ts/extend'
 export { extend } from '@graphql-ts/extend'
-export { fields, interface, interfaceField, object, union } from './schema-api-with-context'
+export { fields, interface, interfaceField, object, union, field } from './schema-api-with-context'
+import type { GWithContext } from '@graphql-ts/schema'
+import { initG as baseInitG } from '@graphql-ts/schema'
+import type { BaseKeystoneTypeInfo } from '../type-info'
+import { extend } from '@graphql-ts/extend'
 
-// TODO: remove when we use { graphql } from '.keystone'
-type SomeTypeThatIsntARecordOfArgs = string
-
-type ImpliedResolver<
-  Args extends { [Key in keyof Args]: graphqlTsSchema.Arg<graphqlTsSchema.InputType> },
-  Type extends OutputType<Context>,
-  Context extends KeystoneContext<any>,
-> =
-  | graphqlTsSchema.InferValueFromOutputType<Type>
-  | ((
-      args: graphqlTsSchema.InferValueFromArgs<Args>,
-      context: Context,
-      info: GraphQLResolveInfo
-    ) => graphqlTsSchema.InferValueFromOutputType<Type>)
+export function initG<TypeInfo extends BaseKeystoneTypeInfo>(): GWithContext<
+  KeystoneContext<TypeInfo>
+> & {
+  Empty: typeof Empty
+  JSON: typeof JSON
+  Decimal: typeof Decimal
+  BigInt: typeof BigInt
+  DateTime: typeof DateTime
+  CalendarDay: typeof CalendarDay
+  Hex: typeof Hex
+  Upload: typeof Upload
+  extend: typeof extend
+} {
+  return {
+    ...baseInitG<KeystoneContext<TypeInfo>>(),
+    Empty,
+    JSON,
+    Decimal,
+    BigInt,
+    DateTime,
+    CalendarDay,
+    Hex,
+    Upload,
+    extend,
+  }
+}
 
-export const field: <
-  Source,
-  Type extends OutputType<Context>,
-  Resolve extends
-    | undefined
-    | ((
-        source: Source,
-        args: graphqlTsSchema.InferValueFromArgs<
-          SomeTypeThatIsntARecordOfArgs extends Args ? {} : Args
-        >,
-        context: Context,
-        info: GraphQLResolveInfo
-      ) => graphqlTsSchema.InferValueFromOutputType<Type>),
-  Context extends KeystoneContext<any>,
-  Args extends { [Key in keyof Args]: graphqlTsSchema.Arg<graphqlTsSchema.InputType> } = {},
->(
-  field: {
-    args?: Args
-    type: Type
-    deprecationReason?: string
-    description?: string
-    extensions?: Readonly<GraphQLFieldExtensions<Source, unknown>>
-  } & (Resolve extends {}
-    ? {
-        resolve: ((
-          source: Source,
-          args: graphqlTsSchema.InferValueFromArgs<
-            SomeTypeThatIsntARecordOfArgs extends Args ? {} : Args
-          >,
-          context: Context,
-          info: GraphQLResolveInfo
-        ) => graphqlTsSchema.InferValueFromOutputType<Type>) &
-          Resolve
-      }
-    : {
-        resolve?: ((
-          source: Source,
-          args: graphqlTsSchema.InferValueFromArgs<
-            SomeTypeThatIsntARecordOfArgs extends Args ? {} : Args
-          >,
-          context: Context,
-          info: GraphQLResolveInfo
-        ) => graphqlTsSchema.InferValueFromOutputType<Type>) &
-          Resolve
-      })
-) => Field<
-  Source,
-  Args,
-  Type,
-  undefined extends Resolve ? ImpliedResolver<Args, Type, Context> : unknown,
-  Context
-> = fieldd as any
-// TODO: remove when we use { graphql } from '.keystone'
+export type initG<T> = baseInitG<T>
 
 export const JSON = graphqlTsSchema.g.scalar<JSONValue>(
   new GraphQLScalarType({
diff --git a/packages/core/src/types/schema/index.ts b/packages/core/src/types/schema/index.ts
@@ -1,2 +1,5 @@
+import type { initG } from './graphql-ts-schema'
+
 export * as g from './graphql-ts-schema'
+export type g<T> = initG<T>
 export * from './legacy-alias'
diff --git a/packages/core/src/types/schema/schema-api-with-context.d.ts b/packages/core/src/types/schema/schema-api-with-context.d.ts
@@ -1,5 +1,6 @@
-import { type GraphQLSchemaAPIWithContext } from '@graphql-ts/schema'
+import type { GWithContext } from '@graphql-ts/schema'
+import type { KeystoneContext } from '../context'
 
-declare const __graphql: GraphQLSchemaAPIWithContext<any>
+declare const __graphql: GWithContext<KeystoneContext>
 
 export = __graphql
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/tests/test-projects/live-reloading/schemas/second.ts b/tests/test-projects/live-reloading/schemas/second.ts
