fix: use renderName for scalar types to escape TypeScript reserved keywords (#1363)

Author: jasonkuhrt

examples/$/graffle/modules/data.ts

@@ -1,4 +1,5 @@
 export const Name = `default`
+
 export type Name = 'default'
 
 export const defaultSchemaUrl = new URL('http://localhost:3000/graphql')

examples/$/graffle/modules/scalar.ts

@@ -1,5 +1,4 @@
 import type * as $$Utilities from 'graffle/utilities-for-generated'
-
 export * from 'graffle/generator-helpers/standard-scalar-types'
 
 //

examples/$/graffle/modules/select.ts

@@ -19,6 +19,7 @@ import * as $$SelectionSets from './selection-sets.js'
 //
 //
 //
+
 import { createSelect } from 'graffle/client'
 export const Select = createSelect($$Data.Name)
 

package.json

@@ -58,7 +58,7 @@
   "scripts": {
     "extension:document-builder:test:generate-fixtures": "tsx src/extensions/DocumentBuilder/__tests__/fixtures/generate.ts",
     "extension:schema-errors:test:generate-fixtures": "pnpm graffle --project src/extensions/SchemaErrors/__tests__/fixture",
-    "graffle": "tsx ./src/generator/cli/generate.ts",
+    "graffle": "tsx ./src/cli/index.ts",
     "serve:pokemon": "tsx tests/_/services/pokemonManual.ts",
     "gen:graffle": "pnpm test:e2e:github:gen:graffle && pnpm extension:schema-errors:test:generate-fixtures && pnpm extension:document-builder:test:generate-fixtures && pnpm website:gen:graffle",
     "examples:gen:graffle": "pnpm build && cd examples && pnpm i && pnpm gen:graffle",

src/extensions/DocumentBuilder/__tests__/fixtures/possible-with-scalars/modules/methods-root.ts

@@ -106,6 +106,40 @@ export interface QueryMethods<$Context extends $$Utilities.Context> {
     >
   >
 
+  bigintField: $$Utilities.GraffleKit.Context.Configuration.Check.Preflight<
+    $Context,
+    <$SelectionSet>(
+      selectionSet?: $$Utilities.Exact<$SelectionSet, $$SelectionSets.Query.bigintField<$Context['scalars']>>,
+    ) => Promise<
+      & (null | {})
+      & $$Utilities.HandleOutputDocumentBuilderRootField<
+        $Context,
+        $$Utilities.DocumentBuilderKit.InferResult.OperationQuery<
+          { bigintField: $SelectionSet },
+          $$Schema.Schema<$Context['scalars']>
+        >,
+        'bigintField'
+      >
+    >
+  >
+
+  bigintFieldNonNull: $$Utilities.GraffleKit.Context.Configuration.Check.Preflight<
+    $Context,
+    <$SelectionSet>(
+      selectionSet?: $$Utilities.Exact<$SelectionSet, $$SelectionSets.Query.bigintFieldNonNull<$Context['scalars']>>,
+    ) => Promise<
+      & (null | {})
+      & $$Utilities.HandleOutputDocumentBuilderRootField<
+        $Context,
+        $$Utilities.DocumentBuilderKit.InferResult.OperationQuery<
+          { bigintFieldNonNull: $SelectionSet },
+          $$Schema.Schema<$Context['scalars']>
+        >,
+        'bigintFieldNonNull'
+      >
+    >
+  >
+
   date: $$Utilities.GraffleKit.Context.Configuration.Check.Preflight<
     $Context,
     <$SelectionSet>(

src/extensions/DocumentBuilder/__tests__/fixtures/possible-with-scalars/modules/scalar.ts

@@ -21,6 +21,25 @@ type Date_ = typeof CustomScalars.Date
 export type DateDecoded = $$Utilities.Schema.Scalar.GetDecoded<Date_>
 export type DateEncoded = $$Utilities.Schema.Scalar.GetEncoded<Date_>
 
+//
+//
+//
+//
+// CUSTOM SCALAR TYPE
+// BIGINT
+// --------------------------------------------------------------------------------------------------
+//                                               bigint
+// --------------------------------------------------------------------------------------------------
+//
+//
+
+export type $bigint = typeof CustomScalars.bigint
+// Without this we get error:
+// "Exported type alias 'DateDecoded' has or is using private name 'Date'."
+type $bigint_ = typeof CustomScalars.bigint
+export type $bigintDecoded = $$Utilities.Schema.Scalar.GetDecoded<$bigint_>
+export type $bigintEncoded = $$Utilities.Schema.Scalar.GetEncoded<$bigint_>
+
 export * from '../../../../../../types/Schema/StandardTypes/scalar.js'
 
 //
@@ -42,13 +61,17 @@ export * from '../../../../../../types/Schema/StandardTypes/scalar.js'
 export const $registry = {
   map: {
     Date: CustomScalars.Date,
+    bigint: CustomScalars.bigint,
   },
 } as $Registry
 
 export type $Registry = $$Utilities.Schema.Scalar.Registry<
   {
     Date: Date_
+    bigint: bigint_
   },
-  $$Utilities.Schema.Scalar.GetEncoded<Date_>,
-  $$Utilities.Schema.Scalar.GetDecoded<Date_>
+  | $$Utilities.Schema.Scalar.GetEncoded<Date_>
+  | $$Utilities.Schema.Scalar.GetEncoded<bigint_>,
+  | $$Utilities.Schema.Scalar.GetDecoded<Date_>
+  | $$Utilities.Schema.Scalar.GetDecoded<bigint_>
 >

src/extensions/DocumentBuilder/__tests__/fixtures/possible-with-scalars/modules/schema-driven-data-map.ts

@@ -44,6 +44,8 @@ const String = $$Scalar.String
 
 const Date = $$Scalar.Date
 
+const bigint = $$Scalar.$bigint
+
 //
 //
 //
@@ -431,6 +433,12 @@ const Query: $$Utilities.SchemaDrivenDataMap.OutputObject = {
         },
       },
     },
+    bigintField: {
+      nt: bigint,
+    },
+    bigintFieldNonNull: {
+      nt: bigint,
+    },
     date: {
       nt: Date,
     },
@@ -823,6 +831,7 @@ const $schemaDrivenDataMap: $$Utilities.SchemaDrivenDataMap = {
     Int,
     String,
     Date,
+    bigint,
     ABCEnum,
     Case,
     ChildAInterfaceHierarchyMember,

src/extensions/DocumentBuilder/__tests__/fixtures/possible-with-scalars/modules/schema.ts

@@ -33,6 +33,8 @@ export namespace Schema {
       InputObjectNestedNonNull: Query.InputObjectNestedNonNull
       abcEnum: Query.abcEnum
       argInputObjectCircular: Query.argInputObjectCircular
+      bigintField: Query.bigintField
+      bigintFieldNonNull: Query.bigintFieldNonNull
       date: Query.date
       dateArg: Query.dateArg
       dateArgInputObject: Query.dateArgInputObject
@@ -155,6 +157,22 @@ export namespace Schema {
       namedType: $$NamedTypes.$$String
     }
 
+    export interface bigintField extends $.OutputField {
+      kind: 'OutputField'
+      name: 'bigintField'
+      arguments: {}
+      inlineType: [0]
+      namedType: $$NamedTypes.$$bigint
+    }
+
+    export interface bigintFieldNonNull extends $.OutputField {
+      kind: 'OutputField'
+      name: 'bigintFieldNonNull'
+      arguments: {}
+      inlineType: [1]
+      namedType: $$NamedTypes.$$bigint
+    }
+
     export interface date extends $.OutputField {
       kind: 'OutputField'
       name: 'date'
@@ -2348,6 +2366,12 @@ export namespace Schema {
 
   export type Date = $$Scalar.Date
 
+  //                                               bigint
+  // --------------------------------------------------------------------------------------------------
+  //
+
+  export type $bigint = $$Scalar.$bigint
+
   //
   //
   //
@@ -2461,6 +2485,7 @@ export namespace Schema {
     export type $$GrandparentInterfaceHierarchyMember = GrandparentInterfaceHierarchyMember
     export type $$ParentInterfaceHierarchyMember = ParentInterfaceHierarchyMember
     export type $$Date = Date
+    export type $$bigint = $bigint
     export type $$Boolean = Boolean
     export type $$Float = Float
     export type $$ID = ID
@@ -2570,13 +2595,15 @@ export interface Schema<$Scalars extends $$Utilities.Schema.Scalar.Registry = $$
   }
   scalarNamesUnion:
     | 'Date'
+    | 'bigint'
     | 'Boolean'
     | 'Float'
     | 'ID'
     | 'Int'
     | 'String'
   scalars: {
     Date: Schema.Date
+    bigint: Schema.$bigint
     Boolean: Schema.Boolean
     Float: Schema.Float
     ID: Schema.ID

src/extensions/DocumentBuilder/__tests__/fixtures/possible-with-scalars/modules/selection-sets.ts

@@ -72,6 +72,18 @@ export interface Query<
   argInputObjectCircular?:
     | Query.argInputObjectCircular$Expanded<_$Scalars>
     | $$Utilities.DocumentBuilderKit.Select.SelectAlias.SelectAlias<Query.argInputObjectCircular<_$Scalars>>
+  /**
+   * Select the `bigintField` field on the `Query` object. Its type is `bigint` (a `ScalarCustom` kind of type).
+   */
+  bigintField?:
+    | Query.bigintField$Expanded<_$Scalars>
+    | $$Utilities.DocumentBuilderKit.Select.SelectAlias.SelectAlias<Query.bigintField<_$Scalars>>
+  /**
+   * Select the `bigintFieldNonNull` field on the `Query` object. Its type is `bigint` (a `ScalarCustom` kind of type).
+   */
+  bigintFieldNonNull?:
+    | Query.bigintFieldNonNull$Expanded<_$Scalars>
+    | $$Utilities.DocumentBuilderKit.Select.SelectAlias.SelectAlias<Query.bigintFieldNonNull<_$Scalars>>
   /**
    * Select the `date` field on the `Query` object. Its type is `Date` (a `ScalarCustom` kind of type).
    */
@@ -541,6 +553,58 @@ export namespace Query {
 
   // --------------------------------------------------------------------------------------------------
 
+  export type bigintField<
+    _$Scalars extends $$Utilities.Schema.Scalar.Registry = $$Utilities.Schema.Scalar.Registry.Empty,
+  > =
+    | $$Utilities.DocumentBuilderKit.Select.Indicator.NoArgsIndicator
+    | bigintField$SelectionSet<_$Scalars>
+
+  export interface bigintField$SelectionSet<
+    _$Scalars extends $$Utilities.Schema.Scalar.Registry = $$Utilities.Schema.Scalar.Registry.Empty,
+  > extends $$Utilities.DocumentBuilderKit.Select.Bases.Base {}
+
+  // --- expanded ---
+
+  /**
+   * This is the "expanded" version of the `bigintField` type. It is identical except for the fact
+   * that IDEs will display its contents (a union type) directly, rather than the name of this type.
+   * In some cases, this is a preferable DX, making the types easier to read for users.
+   */
+  export type bigintField$Expanded<
+    _$Scalars extends $$Utilities.Schema.Scalar.Registry = $$Utilities.Schema.Scalar.Registry.Empty,
+  > = $$Utilities.Simplify<
+    | $$Utilities.DocumentBuilderKit.Select.Indicator.NoArgsIndicator
+    | bigintField$SelectionSet<_$Scalars>
+  >
+
+  // --------------------------------------------------------------------------------------------------
+
+  export type bigintFieldNonNull<
+    _$Scalars extends $$Utilities.Schema.Scalar.Registry = $$Utilities.Schema.Scalar.Registry.Empty,
+  > =
+    | $$Utilities.DocumentBuilderKit.Select.Indicator.NoArgsIndicator
+    | bigintFieldNonNull$SelectionSet<_$Scalars>
+
+  export interface bigintFieldNonNull$SelectionSet<
+    _$Scalars extends $$Utilities.Schema.Scalar.Registry = $$Utilities.Schema.Scalar.Registry.Empty,
+  > extends $$Utilities.DocumentBuilderKit.Select.Bases.Base {}
+
+  // --- expanded ---
+
+  /**
+   * This is the "expanded" version of the `bigintFieldNonNull` type. It is identical except for the fact
+   * that IDEs will display its contents (a union type) directly, rather than the name of this type.
+   * In some cases, this is a preferable DX, making the types easier to read for users.
+   */
+  export type bigintFieldNonNull$Expanded<
+    _$Scalars extends $$Utilities.Schema.Scalar.Registry = $$Utilities.Schema.Scalar.Registry.Empty,
+  > = $$Utilities.Simplify<
+    | $$Utilities.DocumentBuilderKit.Select.Indicator.NoArgsIndicator
+    | bigintFieldNonNull$SelectionSet<_$Scalars>
+  >
+
+  // --------------------------------------------------------------------------------------------------
+
   export type date<_$Scalars extends $$Utilities.Schema.Scalar.Registry = $$Utilities.Schema.Scalar.Registry.Empty> =
     | $$Utilities.DocumentBuilderKit.Select.Indicator.NoArgsIndicator
     | date$SelectionSet<_$Scalars>

src/extensions/DocumentBuilder/__tests__/fixtures/possible-with-scalars/schema.graphql

@@ -195,6 +195,8 @@ type Query {
   """Query enum field documentation."""
   abcEnum: ABCEnum
   argInputObjectCircular(input: InputObjectCircular): String
+  bigintField: bigint
+  bigintFieldNonNull: bigint!
   date: Date
   dateArg(date: Date): Date
   dateArgInputObject(input: InputObject): Date
@@ -260,6 +262,8 @@ type Query {
 
 union Result = ErrorOne | ErrorTwo | Object1
 
+scalar bigint
+
 type lowerCaseObject {
   id: ID
 }