refactor: Internal type cleanup (graphql-nexus#980)

* refactor: Internal type cleanup
* chore: Remove prettier-plugin-jsdoc as its output is non-determinstic

package.json

@@ -46,7 +46,6 @@
     "release:pr": "dripip pr",
     "release:preview": "dripip preview",
     "release:stable": "dripip stable",
-    "pretest": "yarn patch-package",
     "test": "yarn test:types && jest --testTimeout 10000",
     "test:ci": "yarn test:types && jest --maxWorkers 2 --coverage --testTimeout 10000",
     "test:debug": "node --inspect-brk $(yarn bin)/jest -i --watch",
@@ -92,9 +91,7 @@
     "jest": "^26.6.3",
     "jest-watch-typeahead": "^0.6.1",
     "lint-staged": "^7.3.0",
-    "patch-package": "6.2.2",
     "prettier": "^2.3.1",
-    "prettier-plugin-jsdoc": "^0.3.23",
     "sort-package-json": "^1.22.1",
     "ts-jest": "^26.4.4",
     "ts-morph": "^8.2.0",

src/definitions/args.ts

@@ -1,7 +1,8 @@
 import type { GraphQLScalarTypeConfig } from 'graphql'
+import type { AllNexusInputTypeDefs } from '../core'
 import type { AllInputTypes, GetGen2 } from '../typegenTypeHelpers'
-import type { AllNexusArgsDefs, AllNexusInputTypeDefs } from './wrapping'
-import { NexusTypes, withNexusSymbol } from './_types'
+import type { AllNexusArgsDefs } from './wrapping'
+import { Maybe, NexusTypes, withNexusSymbol } from './_types'
 
 export type ArgsRecord = Record<string, AllNexusArgsDefs>
 
@@ -39,7 +40,7 @@ export type CommonArgConfig = {
    *   //   ): [Int]
    *   // }
    */
-  description?: string
+  description?: Maybe<string>
 
   /**
    * Data that will be added to the arg-level [extensions field on the graphql-js type def

src/definitions/definitionBlocks.ts

@@ -11,18 +11,18 @@ import type {
 import type { ArgsRecord } from './args'
 import type { NexusMetaType } from './nexusMeta'
 import type { AllNexusInputTypeDefs, AllNexusOutputTypeDefs, NexusWrapKind } from './wrapping'
-import type { BaseScalars } from './_types'
+import type { BaseScalars, Maybe } from './_types'
 
 export interface CommonFieldConfig {
   //todo
   /** The description to annotate the GraphQL SDL */
-  description?: string
+  description?: Maybe<string>
   //todo
   /**
    * Info about a field deprecation. Formatted as a string and provided with the deprecated directive on
    * field/enum types and as a comment on input fields.
    */
-  deprecation?: string // | DeprecationInfo;
+  deprecation?: Maybe<string> // | DeprecationInfo;
 }
 
 export type CommonOutputFieldConfig<TypeName extends string, FieldName extends string> = CommonFieldConfig & {

src/definitions/enumType.ts

@@ -1,6 +1,6 @@
 import { assertValidName, GraphQLEnumTypeConfig, GraphQLEnumValueConfig } from 'graphql'
 import { arg, NexusArgDef, NexusAsArgConfig } from './args'
-import { NexusTypes, SourceTypingDef, withNexusSymbol } from './_types'
+import { Maybe, NexusTypes, SourceTypingDef, withNexusSymbol } from './_types'
 
 type TypeScriptEnumLike = {
   [key: number]: string
@@ -12,12 +12,12 @@ export interface EnumMemberInfo {
   /** The internal representation of the enum */
   value?: string | number | object | boolean
   /** The description to annotate the GraphQL SDL */
-  description?: string
+  description?: Maybe<string>
   /**
    * Info about a field deprecation. Formatted as a string and provided with the deprecated directive on
    * field/enum types and as a comment on input fields.
    */
-  deprecation?: string // | DeprecationInfo;
+  deprecation?: Maybe<string> // | DeprecationInfo;
   /**
    * Custom extensions, as supported in graphql-js
    *
@@ -29,7 +29,7 @@ export interface EnumMemberInfo {
 export interface NexusEnumTypeConfig<TypeName extends string> {
   name: TypeName
   /** The description to annotate the GraphQL SDL */
-  description?: string
+  description?: Maybe<string>
   /** Source type information for this type */
   sourceType?: SourceTypingDef
   /** All members of the enum, either as an array of strings/definition objects, as an object, or as a TypeScript enum */

src/definitions/inputObjectType.ts

@@ -1,15 +1,15 @@
 import { assertValidName, GraphQLInputObjectTypeConfig } from 'graphql'
 import { arg, NexusArgDef, NexusAsArgConfig } from './args'
 import type { InputDefinitionBlock } from './definitionBlocks'
-import { NexusTypes, NonNullConfig, withNexusSymbol } from './_types'
+import { Maybe, NexusTypes, NonNullConfig, withNexusSymbol } from './_types'
 
 export type NexusInputObjectTypeConfig<TypeName extends string> = {
   /** Name of the input object type */
   name: TypeName
   /** Definition block for the input type */
   definition(t: InputDefinitionBlock<TypeName>): void
   /** The description to annotate the GraphQL SDL */
-  description?: string
+  description?: Maybe<string>
   /**
    * Configures the nullability for the type, check the documentation's "Getting Started" section to learn
    * more about GraphQL Nexus's assumptions and configuration on nullability.

src/definitions/interfaceType.ts

@@ -2,14 +2,14 @@ import { assertValidName, GraphQLInterfaceTypeConfig } from 'graphql'
 import type { FieldResolver, GetGen, InterfaceFieldsFor, ModificationType } from '../typegenTypeHelpers'
 import type { ArgsRecord } from './args'
 import { OutputDefinitionBlock, OutputDefinitionBuilder } from './definitionBlocks'
-import { AbstractTypes, NexusTypes, NonNullConfig, SourceTypingDef, withNexusSymbol } from './_types'
+import { AbstractTypes, Maybe, NexusTypes, NonNullConfig, SourceTypingDef, withNexusSymbol } from './_types'
 
 export type Implemented = GetGen<'interfaceNames'> | NexusInterfaceTypeDef<any>
 
 export interface FieldModification<TypeName extends string, FieldName extends string> {
   type?: ModificationType<TypeName, FieldName>
   /** The description to annotate the GraphQL SDL */
-  description?: string
+  description?: Maybe<string>
   /** The resolve method we should be resolving the field with */
   resolve?: FieldResolver<TypeName, FieldName>
   /** You are allowed to add non-required args when modifying a field */
@@ -44,7 +44,7 @@ export type NexusInterfaceTypeConfig<TypeName extends string> = {
    */
   nonNullDefaults?: NonNullConfig
   /** The description to annotate the GraphQL SDL */
-  description?: string
+  description?: Maybe<string>
   /** Source type information for this type */
   sourceType?: SourceTypingDef
   /**

src/definitions/list.ts

@@ -1,11 +1,7 @@
 import { isType } from 'graphql'
 import { isNexusMeta } from './nexusMeta'
-import { AllNamedTypeDefs, isNexusStruct, NexusListableTypes } from './wrapping'
+import { isNexusStruct, NexusListableTypes } from './wrapping'
 import { NexusTypes, withNexusSymbol } from './_types'
-/** List() */
-export type NexusListDefConfig<TypeName extends AllNamedTypeDefs> = {
-  type: TypeName
-}
 
 export class NexusListDef<TypeName extends NexusListableTypes> {
   // @ts-ignore

src/definitions/mutationField.ts

@@ -1,4 +1,4 @@
-import type { FieldOutConfig, OutputDefinitionBlock } from '../core'
+import type { FieldOutConfig, OutputDefinitionBlock } from './definitionBlocks'
 import { extendType, NexusExtendTypeDef } from './extendType'
 
 export type MutationFieldConfig<FieldName extends string> =

src/definitions/objectType.ts

@@ -2,7 +2,7 @@ import { assertValidName, GraphQLObjectType } from 'graphql'
 import type { InterfaceFieldsFor } from '../typegenTypeHelpers'
 import { OutputDefinitionBlock, OutputDefinitionBuilder } from './definitionBlocks'
 import type { FieldModification, FieldModificationDef, Implemented } from './interfaceType'
-import { AbstractTypes, NexusTypes, NonNullConfig, SourceTypingDef, withNexusSymbol } from './_types'
+import { AbstractTypes, Maybe, NexusTypes, NonNullConfig, SourceTypingDef, withNexusSymbol } from './_types'
 
 export interface ObjectDefinitionBuilder extends OutputDefinitionBuilder {
   addInterfaces(toAdd: Implemented[]): void
@@ -102,7 +102,7 @@ export type NexusObjectTypeConfig<TypeName extends string> = {
    *   //   # ...
    *   // }
    */
-  description?: string
+  description?: Maybe<string>
   /**
    * [Source Types Guide](https://nxs.li/guides/backing-types)
    *

src/definitions/queryField.ts

@@ -1,4 +1,4 @@
-import type { FieldOutConfig, OutputDefinitionBlock } from '../core'
+import type { FieldOutConfig, OutputDefinitionBlock } from './definitionBlocks'
 import { extendType, NexusExtendTypeDef } from './extendType'
 
 export type QueryFieldConfig<FieldName extends string> =

src/definitions/scalarType.ts

@@ -1,6 +1,6 @@
 import { assertValidName, GraphQLScalarType, GraphQLScalarTypeConfig } from 'graphql'
 import { decorateType } from './decorateType'
-import { NexusTypes, SourceTypingDef, withNexusSymbol } from './_types'
+import { Maybe, NexusTypes, SourceTypingDef, withNexusSymbol } from './_types'
 
 export interface ScalarBase
   extends Pick<
@@ -10,7 +10,7 @@ export interface ScalarBase
 
 export interface ScalarConfig {
   /** Any deprecation info for this scalar type */
-  deprecation?: string // | DeprecationInfo;
+  deprecation?: Maybe<string> // | DeprecationInfo;
   /** Adds this type as a method on the Object/Interface definition blocks */
   asNexusMethod?: string
   /** Source type information for this type */

src/definitions/unionType.ts

@@ -1,7 +1,7 @@
 import { assertValidName, GraphQLUnionTypeConfig } from 'graphql'
 import type { GetGen } from '../typegenTypeHelpers'
 import type { NexusObjectTypeDef } from './objectType'
-import { AbstractTypes, NexusTypes, SourceTypingDef, withNexusSymbol } from './_types'
+import { AbstractTypes, Maybe, NexusTypes, SourceTypingDef, withNexusSymbol } from './_types'
 
 export interface UnionDefinitionBuilder {
   typeName: string
@@ -27,12 +27,12 @@ export type NexusUnionTypeConfig<TypeName extends string> = {
   /** Builds the definition for the union */
   definition(t: UnionDefinitionBlock): void
   /** The description to annotate the GraphQL SDL */
-  description?: string
+  description?: Maybe<string>
   /**
    * Info about a field deprecation. Formatted as a string and provided with the deprecated directive on
    * field/enum types and as a comment on input fields.
    */
-  deprecation?: string // | DeprecationInfo;
+  deprecation?: Maybe<string> // | DeprecationInfo;
   /** Source type information for this type */
   sourceType?: SourceTypingDef
   /**

src/definitions/wrapping.ts

@@ -28,38 +28,71 @@ import { isNexusMetaType, NexusMetaType, resolveNexusMetaType } from './nexusMet
 import type { NexusUnionTypeDef } from './unionType'
 import { NexusTypes, NexusWrappedSymbol } from './_types'
 
+/**
+ * input(named): Nexus only
+ */
 export type AllNexusNamedInputTypeDefs<T extends string = any> =
   | NexusInputObjectTypeDef<T>
   | NexusEnumTypeDef<T>
   | NexusScalarTypeDef<T>
+
+/**
+ * input(named): Nexus + GraphQLInput
+ */
+export type AllNamedInputTypeDefs<T extends string = any> =
+  | AllNexusNamedInputTypeDefs<T>
   | Exclude<GraphQLInputType, GraphQLList<any> | GraphQLNonNull<any>>
 
+/**
+ * input(all): Nexus + GraphQL
+ */
 export type AllNexusInputTypeDefs<T extends string = any> =
-  | AllNexusNamedInputTypeDefs<T>
+  | AllNamedInputTypeDefs<T>
   | NexusListDef<any>
   | NexusNonNullDef<any>
   | NexusNullDef<any>
   | GraphQLList<any>
   | GraphQLNonNull<any>
 
+/**
+ * output(named): Nexus only
+ */
 export type AllNexusNamedOutputTypeDefs =
   | NexusObjectTypeDef<any>
   | NexusInterfaceTypeDef<any>
   | NexusUnionTypeDef<any>
   | NexusEnumTypeDef<any>
   | NexusScalarTypeDef<any>
 
+/**
+ * output(all): Nexus only
+ */
 export type AllNexusOutputTypeDefs =
   | AllNexusNamedOutputTypeDefs
   | NexusListDef<any>
   | NexusNonNullDef<any>
   | NexusNullDef<any>
 
+/**
+ * input + output(named): Nexus only
+ */
 export type AllNexusNamedTypeDefs = AllNexusNamedInputTypeDefs | AllNexusNamedOutputTypeDefs
 
+/**
+ * input + output(all): Nexus only
+ */
 export type AllNexusTypeDefs = AllNexusOutputTypeDefs | AllNexusInputTypeDefs
 
+/**
+ * input + output(all): Nexus only + Name
+ */
+export type AllNamedTypeDefs = AllNexusNamedTypeDefs | GraphQLNamedType
+
+/**
+ * All inputs to list(...)
+ */
 export type NexusListableTypes =
+  | GetGen<'allNamedTypes', string>
   | AllNamedTypeDefs
   | NexusArgDef<any>
   | NexusListDef<NexusListableTypes>
@@ -68,24 +101,30 @@ export type NexusListableTypes =
   | GraphQLType
   | NexusMetaType
 
+/**
+ * All inputs to nonNull(...)
+ */
 export type NexusNonNullableTypes =
+  | GetGen<'allNamedTypes', string>
   | AllNamedTypeDefs
   | NexusListDef<NexusListableTypes>
   | NexusArgDef<any>
   | NexusMetaType
 
+/**
+ * All inputs to nullable(...)
+ */
 export type NexusNullableTypes =
+  | GetGen<'allNamedTypes', string>
   | AllNamedTypeDefs
   | NexusListDef<NexusListableTypes>
   | NexusArgDef<any>
   | NexusMetaType
 
-export type AllNamedTypeDefs = GetGen<'allNamedTypes', string> | AllNexusNamedTypeDefs
-
 export type AllNexusNamedArgsDefs<T extends AllInputTypes = AllInputTypes> =
   | T
   | NexusArgDef<T>
-  | AllNexusNamedInputTypeDefs<T>
+  | AllNamedInputTypeDefs<T>
   | GraphQLInputType
 
 export type AllNexusArgsDefs =

src/plugin.ts

@@ -51,7 +51,7 @@ export interface PluginConfig {
   /** A name for the plugin, useful for errors, etc. */
   name: string
   /** A description for the plugin */
-  description?: string
+  description?: Maybe<string>
   /** Any type definitions we want to add to output field definitions */
   fieldDefTypes?: StringLike | StringLike[]
   /** Any type definitions we want to add to input field definitions */

src/utils.ts

@@ -31,9 +31,10 @@ import {
   AllNexusTypeDefs,
   isNexusWrappingType,
   isNexusArgDef,
-  AllNexusNamedInputTypeDefs,
+  AllNamedInputTypeDefs,
 } from './definitions/wrapping'
 import {
+  Maybe,
   MissingType,
   NexusFeatures,
   NexusGraphQLSchema,
@@ -266,7 +267,7 @@ export interface PrintedGenTypingConfig {
   name: string
   optional: boolean
   type: string
-  description?: string
+  description?: Maybe<string>
   imports?: PrintedGenTypingImport[]
 }
 
@@ -517,7 +518,7 @@ export function resolveImportPath(rootType: TypingImport, typeName: string, outp
 }
 
 /** Given the right hand side of an arg definition, returns the underlying "named type" for us to add to the builder */
-export function getArgNamedType(argDef: AllNexusArgsDefs | string): AllNexusNamedInputTypeDefs | string {
+export function getArgNamedType(argDef: AllNexusArgsDefs | string): AllNamedInputTypeDefs | string {
   let finalValue = argDef
   if (typeof finalValue === 'string') {
     return finalValue