Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Augment internal types #91

Closed
wants to merge 2 commits into from
Closed

Augment internal types #91

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cd2accb
Add support to augment types with internal properties
lorefnon Feb 7, 2024
60c6b29
Update loader example to also use internal properties
lorefnon Feb 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions examples/loader.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,15 @@ import { createServer } from 'http'
const Dog = g.type('Dog', {
name: g.string(),
owner: g.string().omitResolver()
})
}).augment<{
id: number
}>()

const queryType = g.type('Query', {
dogs: g.ref(() => Dog).list()
})

const owners = {
Apollo: 'Mish',
Buddy: 'Sebastian'
}
const owners = ['Mish', 'Sebastian']

type resolverTypes = InferResolvers<{ Query: typeof queryType, Dog: typeof Dog }, {}>

Expand All @@ -23,9 +22,11 @@ const resolvers: resolverTypes = {
dogs: (parent, args, context, info) => {
return [
{
id: 0,
name: 'Apollo',
},
{
id: 1,
name: 'Buddy',
}
]
Expand All @@ -36,7 +37,7 @@ const resolvers: resolverTypes = {
load (queries) {
return new Promise(resolve => {
setTimeout(() => {
resolve(queries.map(q => owners[q.parent.name]))
resolve(queries.map(q => owners[q.parent.id]))
}, 1000)
})
}
Expand Down
100 changes: 68 additions & 32 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,28 +84,59 @@ type InferResolverConfig = {
}

type InferOptions = {
internal: boolean
omitResolver?: AnyOmitResolver | never
}

type RefType = () => AnyType

// TODO: Refactor Args to get rid of this mess
export type Infer<T, options extends InferOptions = { omitResolver: never }> = ExpandRecursively<InferRaw<T, options>>
export type InferRaw<T, options extends InferOptions = { omitResolver: never }> = T extends AnyInput | AnyObject | AnyInterface ? {
export type Infer<T, options extends InferOptions = {
internal: false,
omitResolver: never
}> = ExpandRecursively<InferRaw<T, options>>

export type InferInternal<T> = Infer<T, {
internal: true,
omitResolver: AnyOmitResolver
}>

type AnyNested = AnyInput | AnyObject | AnyInterface

export type InferRaw<T, options extends InferOptions = {
omitResolver: never,
internal: false
}> = T extends AnyNested ? InferNested<T, options> : InferShallow<T, options>

type IsOmitable<T extends AnyNested, options extends InferOptions, K extends keyof T['_shape']> =
T['_shape'][K] extends AnyOptional | options['omitResolver'] ? true :
T['_shape'][K] extends AnyArgs ?
T['_shape'][K]['_shape'] extends AnyOptional | options['omitResolver'] ? true : false :
false

type InferNested<T extends AnyNested, options extends InferOptions> = {
__typename?: T['_name']
} & {
[K in keyof T['_shape'] as T['_shape'][K] extends AnyOptional | options['omitResolver'] ? never :
T['_shape'][K] extends AnyArgs ?
T['_shape'][K]['_shape'] extends AnyOptional | options['omitResolver'] ? never : K :
K]: InferRaw<T['_shape'][K], options>
[K in keyof T['_shape'] as (
IsOmitable<T, options, K> extends true
? never
: K
)]: InferRaw<T['_shape'][K], options>
} & {
[K in keyof T['_shape'] as T['_shape'][K] extends AnyOptional | options['omitResolver'] ? K :
T['_shape'][K] extends AnyArgs ?
T['_shape'][K]['_shape'] extends AnyOptional | options['omitResolver'] ? K : never :
never]?: InferRaw<T['_shape'][K], options>
} : InferShallow<T, options>

export type InferShallow<T, options extends InferOptions = { omitResolver: never }> =
[K in keyof T['_shape'] as (
IsOmitable<T, options, K> extends true
? K
: never
)]?: InferRaw<T['_shape'][K], options>
} & (
T extends GType<string, AnyTypes, infer E>
? options["internal"] extends true
? E
: {}
: {}
)

export type InferShallow<T, options extends InferOptions = { omitResolver: never, internal: false }> =
T extends AnyString | AnyID | AnyScalar | AnyNumber | AnyBoolean ? T['_shape'] :
T extends AnyEnum ? T['_inner'] :
T extends AnyUnion ? InferRaw<ObjectToUnion<T['_inner']>, options> :
Expand Down Expand Up @@ -134,49 +165,50 @@ export type InferUnionNames<T> = T extends AnyUnion ? ObjectToUnion<T['_inner']>
export type InferResolvers<T extends AnyTypes, X extends InferResolverConfig> = {
[K in keyof T]: K extends 'Subscription' ? {
[G in keyof T[K]['_shape']]?: {
subscribe: (parent: {}, args: InferArg<T[K]['_shape'][G]>, context: X['context'], info: GraphQLResolveInfo) => MaybePromise<AsyncIterator<{ [G in keyof T[K]['_shape']]: Infer<T[K]['_shape'][G], { omitResolver: AnyOmitResolver }> }>>
resolve?: (value: Infer<T[K]['_shape'][G]>, args: InferArg<T[K]['_shape'][G]>, context: X['context'], info: GraphQLResolveInfo) => MaybePromise<Infer<T[K]['_shape'][G], { omitResolver: AnyOmitResolver }>>
subscribe: (parent: {}, args: InferArg<T[K]['_shape'][G]>, context: X['context'], info: GraphQLResolveInfo) => MaybePromise<AsyncIterator<{ [G in keyof T[K]['_shape']]: InferInternal<T[K]['_shape'][G]> }>>
resolve?: (value: InferInternal<T[K]['_shape'][G]>, args: InferArg<T[K]['_shape'][G]>, context: X['context'], info: GraphQLResolveInfo) => MaybePromise<InferInternal<T[K]['_shape'][G]>>
}
} : {
[G in keyof T[K]['_shape']]?: (parent: K extends GraphQLRootType ? {} : Infer<T[K]>, args: InferArg<T[K]['_shape'][G]>, context: X['context'], info: GraphQLResolveInfo) => MaybePromise<MaybeFunction<Infer<T[K]['_shape'][G], { omitResolver: AnyOmitResolver }>>> | AsyncGenerator<Infer<T[K]['_shape'][G]['_shape'], { omitResolver: AnyOmitResolver }>>
[G in keyof T[K]['_shape']]?: (parent: K extends GraphQLRootType ? {} : InferInternal<T[K]>, args: InferArg<T[K]['_shape'][G]>, context: X['context'], info: GraphQLResolveInfo) => MaybePromise<MaybeFunction<InferInternal<T[K]['_shape'][G]>>> | AsyncGenerator<InferInternal<T[K]['_shape'][G]['_shape']>>
} | {
[G in keyof T[K]['_shape']]?: {
resolve: (parent: K extends GraphQLRootType ? {} : Infer<T[K]>, args: InferArg<T[K]['_shape'][G]>, context: X['context'], info: GraphQLResolveInfo) => MaybePromise<Infer<T[K]['_shape'][G], { omitResolver: AnyOmitResolver }>> | AsyncGenerator<Infer<T[K]['_shape'][G]['_shape'], { omitResolver: AnyOmitResolver }>>
resolve: (parent: K extends GraphQLRootType ? {} : InferInternal<T[K]>, args: InferArg<T[K]['_shape'][G]>, context: X['context'], info: GraphQLResolveInfo) => MaybePromise<InferInternal<T[K]['_shape'][G]>> | AsyncGenerator<InferInternal<T[K]['_shape'][G]['_shape']>>
} | {
load: (queries: { parent: K extends GraphQLRootType ? {} : Infer<T[K]>, args: InferArg<T[K]['_shape'][G]>, context: X['context'], info: GraphQLResolveInfo } []) => MaybePromise<Infer<T[K]['_shape'][G], { omitResolver: AnyOmitResolver }>[]>
load: (queries: { parent: K extends GraphQLRootType ? {} : InferInternal<T[K]>, args: InferArg<T[K]['_shape'][G]>, context: X['context'], info: GraphQLResolveInfo } []) => MaybePromise<InferInternal<T[K]['_shape'][G]>[]>
} | {
loadBatch: (queries: { parent: K extends GraphQLRootType ? {} : Infer<T[K]>, args: InferArg<T[K]['_shape'][G]>, context: X['context'], info: GraphQLResolveInfo } []) => MaybePromise<Infer<T[K]['_shape'][G], { omitResolver: AnyOmitResolver }>[]>
loadBatch: (queries: { parent: K extends GraphQLRootType ? {} : InferInternal<T[K]>, args: InferArg<T[K]['_shape'][G]>, context: X['context'], info: GraphQLResolveInfo } []) => MaybePromise<InferInternal<T[K]['_shape'][G]>[]>
}
} & {
__isTypeOf?: (parent: Infer<T[K]>, context: X['context'], info: GraphQLResolveInfo) => MaybePromise<boolean>
__resolveType?: (parent: Infer<T[K]>, context: X['context'], info: GraphQLResolveInfo) => MaybePromise<InferUnionNames<T[K]>>
__isTypeOf?: (parent: InferInternal<T[K]>, context: X['context'], info: GraphQLResolveInfo) => MaybePromise<boolean>
__resolveType?: (parent: InferInternal<T[K]>, context: X['context'], info: GraphQLResolveInfo) => MaybePromise<InferUnionNames<T[K]>>
}
}

export type InferResolversStrict<T extends AnyTypes, X extends InferResolverConfig> = {
[K in keyof T]: K extends 'Subscription' ? {
[G in keyof T[K]['_shape']]: {
subscribe: (parent: {}, args: InferArg<T[K]['_shape'][G]>, context: X['context'], info: GraphQLResolveInfo) => MaybePromise<AsyncIterator<{ [G in keyof T[K]['_shape']]: Infer<T[K]['_shape'][G], { omitResolver: AnyOmitResolver }> }>>
resolve?: (value: Infer<T[K]['_shape'][G]>, args: InferArg<T[K]['_shape'][G]>, context: X['context'], info: GraphQLResolveInfo) => MaybePromise<Infer<T[K]['_shape'][G], { omitResolver: AnyOmitResolver }>>
subscribe: (parent: {}, args: InferArg<T[K]['_shape'][G]>, context: X['context'], info: GraphQLResolveInfo) => MaybePromise<AsyncIterator<{ [G in keyof T[K]['_shape']]: InferInternal<T[K]['_shape'][G]> }>>
resolve?: (value: InferInternal<T[K]['_shape'][G]>, args: InferArg<T[K]['_shape'][G]>, context: X['context'], info: GraphQLResolveInfo) => MaybePromise<InferInternal<T[K]['_shape'][G]>>
}
} : {
[G in keyof T[K]['_shape']]: (parent: K extends GraphQLRootType ? {} : Infer<T[K]>, args: InferArg<T[K]['_shape'][G]>, context: X['context'], info: GraphQLResolveInfo) => MaybePromise<MaybeFunction<Infer<T[K]['_shape'][G], { omitResolver: AnyOmitResolver }>>> | AsyncGenerator<Infer<T[K]['_shape'][G]['_shape'], { omitResolver: AnyOmitResolver }>>
[G in keyof T[K]['_shape']]: (parent: K extends GraphQLRootType ? {} : InferInternal<T[K]>, args: InferArg<T[K]['_shape'][G]>, context: X['context'], info: GraphQLResolveInfo) => MaybePromise<MaybeFunction<InferInternal<T[K]['_shape'][G]>>> | AsyncGenerator<InferInternal<T[K]['_shape'][G]['_shape']>>
} | {
[G in keyof T[K]['_shape']]: {
resolve: (parent: K extends GraphQLRootType ? {} : Infer<T[K]>, args: InferArg<T[K]['_shape'][G]>, context: X['context'], info: GraphQLResolveInfo) => MaybePromise<Infer<T[K]['_shape'][G], { omitResolver: AnyOmitResolver }>> | AsyncGenerator<Infer<T[K]['_shape'][G]['_shape'], { omitResolver: AnyOmitResolver }>>
resolve: (parent: K extends GraphQLRootType ? {} : InferInternal<T[K]>, args: InferArg<T[K]['_shape'][G]>, context: X['context'], info: GraphQLResolveInfo) => MaybePromise<InferInternal<T[K]['_shape'][G]>> | AsyncGenerator<InferInternal<T[K]['_shape'][G]['_shape']>>
} | {
load: (queries: { parent: K extends GraphQLRootType ? {} : Infer<T[K]>, args: InferArg<T[K]['_shape'][G]>, context: X['context'], info: GraphQLResolveInfo } []) => MaybePromise<Infer<T[K]['_shape'][G], { omitResolver: AnyOmitResolver }>>[]
load: (queries: { parent: K extends GraphQLRootType ? {} : InferInternal<T[K]>, args: InferArg<T[K]['_shape'][G]>, context: X['context'], info: GraphQLResolveInfo } []) => MaybePromise<InferInternal<T[K]['_shape'][G]>>[]
} | {
loadBatch: (queries: { parent: K extends GraphQLRootType ? {} : Infer<T[K]>, args: InferArg<T[K]['_shape'][G]>, context: X['context'], info: GraphQLResolveInfo } []) => MaybePromise<Infer<T[K]['_shape'][G], { omitResolver: AnyOmitResolver }>>[]
loadBatch: (queries: { parent: K extends GraphQLRootType ? {} : InferInternal<T[K]>, args: InferArg<T[K]['_shape'][G]>, context: X['context'], info: GraphQLResolveInfo } []) => MaybePromise<InferInternal<T[K]['_shape'][G]>>[]
}
} & {
__isTypeOf?: (parent: Infer<T[K]>, context: X['context'], info: GraphQLResolveInfo) => MaybePromise<boolean>
__resolveType?: (parent: Infer<T[K]>, context: X['context'], info: GraphQLResolveInfo) => MaybePromise<InferUnionNames<T[K]>>
__isTypeOf?: (parent: InferInternal<T[K]>, context: X['context'], info: GraphQLResolveInfo) => MaybePromise<boolean>
__resolveType?: (parent: InferInternal<T[K]>, context: X['context'], info: GraphQLResolveInfo) => MaybePromise<InferUnionNames<T[K]>>
}
}

class GType<N extends string, T extends AnyTypes> extends Type<T, 'ObjectType'> {
class GType<N extends string, T extends AnyTypes, E extends object = object> extends Type<T, 'ObjectType'> {
declare _name: N
declare _ext: E

constructor(name: string, shape: T, interfaces?: AnyInterface[], extend?: AnyTypes[]) {
super()
Expand All @@ -192,13 +224,17 @@ class GType<N extends string, T extends AnyTypes> extends Type<T, 'ObjectType'>
implements<D extends AnyInterface>(ref: D | D[]) {
// This is temporary construct, until we figure out how to properly manage to shared schema
this.typeDef.interfaces = Array.isArray(ref) ? ref : [ref]
return new GType<N, T & UnionToIntersection<D['_shape']>>(this.typeDef.name, this.typeDef.shape as any, Array.isArray(ref) ? ref : [ref], this.typeDef.extend)
return new GType<N, T & UnionToIntersection<D['_shape']>, E>(this.typeDef.name, this.typeDef.shape as any, Array.isArray(ref) ? ref : [ref], this.typeDef.extend)
}

extend<D extends AnyTypes>(ref: D | D[]) {
// This is temporary construct, until we figure out how to properly manage to shared schema
this.typeDef.extend = Array.isArray(ref) ? ref : [ref]
return new GType<N, T & UnionToIntersection<D>>(this.typeDef.name, this.typeDef.shape as any, this.typeDef.interfaces, Array.isArray(ref) ? ref : [ref])
return new GType<N, T & UnionToIntersection<D>, E>(this.typeDef.name, this.typeDef.shape as any, this.typeDef.interfaces, Array.isArray(ref) ? ref : [ref])
}

augment<ENext extends object>() {
return new GType<N, T, ENext>(this.typeDef.name, this.typeDef.shape as any, this.typeDef.interfaces, this.typeDef.extend)
}
}

Expand Down
1 change: 1 addition & 0 deletions src/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,4 @@ export type ExpandRecursively<T>
? T extends infer O
? { [K in keyof O]: ExpandRecursively<O[K]> }
: never : T