fix: hide isRequired from API and add more tests and notes

Author: spion

README.md

@@ -65,7 +65,9 @@ const countryQuery = query(q => [
 ])
 ```
 
-This will generate `TypedDocumentNode<{ countries: Array<{...}>}, { continentCode: string }>`, a typed document node that includes the input variable `continentCode`.
+This will generate `TypedDocumentNode<{ countries: Array<{...}>}, { continentCode?: string | null | undefined }>`, a typed document node that includes the input variable `continentCode`.
+
+> Note: By default, `$` will allow nulls if the input type allows it in the desired position. Use `$$` to force-require the variable to have a non-null value.
 
 The GraphQL version of the above query is shown below:
 

src/preamble.src.ts

@@ -15,7 +15,7 @@ class Variable<T, Name extends string> {
   private [VariableName]: Name
   private _type?: T
 
-  constructor(name: Name, public readonly isRequired?: boolean) {
+  constructor(name: Name, private readonly isRequired?: boolean) {
     this[VariableName] = name
   }
 }
@@ -271,7 +271,7 @@ function fieldToQuery(prefix: string, field: $Field<any, any, any>) {
           if (kind.isRequired) type += '!'
           if (kind.array) type += kind.array.isRequired ? ']!' : ']'
 
-          if (!type.endsWith('!') && variable.isRequired === true) {
+          if (!type.endsWith('!') && (variable as any).isRequired === true) {
             type += '!'
           }
 

test/examples/test-countries.good.ts

@@ -1,4 +1,4 @@
-import { query } from './countries.graphql.api'
+import { query, $, $$ } from './countries.graphql.api'
 import { verify } from './verify'
 
 // Allow both overloads
@@ -18,11 +18,69 @@ let twoCountriesString = `{
   }
 }`
 
+let countryQuery = query(q => [
+  q.countries({ filter: { continent: { eq: $('continentCode') } } }, c => [
+    c.code,
+    c.capital,
+    c.name,
+    c.languages(l => [l.name]),
+  ]),
+])
+
+let countryQueryString = `
+query ($continentCode: String) {
+  countries(filter: {continent: {eq: $continentCode}}) {
+    code
+    capital
+    name
+    languages {
+      name
+    }
+  }
+}`
+
+let countryQueryRequiredVar = query(q => [
+  q.countries({ filter: { continent: { eq: $$('continentCode') } } }, c => [
+    c.code,
+    c.capital,
+    c.name,
+    c.languages(l => [l.name]),
+  ]),
+])
+
+let countryQueryStringRequired = `
+query ($continentCode: String!) {
+  countries(filter: {continent: {eq: $continentCode}}) {
+    code
+    capital
+    name
+    languages {
+      name
+    }
+  }
+}`
+
 export default [
   verify({
     query: twoCountries,
     variables: {},
     schemaPath: 'countries.graphql',
     string: twoCountriesString,
   }),
+  verify({
+    query: countryQuery,
+    variables: {
+      continentCode: null,
+    },
+    schemaPath: 'countries.graphql',
+    string: countryQueryString,
+  }),
+  verify({
+    query: countryQueryRequiredVar,
+    variables: {
+      continentCode: 'x',
+    },
+    schemaPath: 'countries.graphql',
+    string: countryQueryStringRequired,
+  }),
 ]