fix: schema prop type fix (#2029)

graphql · Nov 23, 2021 · c83d1d4 · c83d1d4 · github-actions · Nov 23, 2021
1 parent 9efa672
commit c83d1d4
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 7 deletions.
diff --git a/.changeset/bright-knives-cough.md b/.changeset/bright-knives-cough.md
@@ -0,0 +1,5 @@
+---
+'graphiql': patch
+---
+
+fix `schema` type nullability for #2028
diff --git a/packages/graphiql/src/components/GraphiQL.tsx b/packages/graphiql/src/components/GraphiQL.tsx
@@ -110,7 +110,7 @@ export type GenericError =
 
 export type GraphiQLProps = {
   fetcher: Fetcher;
-  schema?: GraphQLSchema;
+  schema?: GraphQLSchema | null;
   validationRules?: ValidationRule[];
   query?: string;
   variables?: string;
@@ -145,7 +145,7 @@ export type GraphiQLProps = {
 };
 
 export type GraphiQLState = {
-  schema?: GraphQLSchema;
+  schema?: GraphQLSchema | null;
   query?: string;
   variables?: string;
   headers?: string;
@@ -1399,7 +1399,7 @@ export class GraphiQL extends React.Component<GraphiQLProps, GraphiQLState> {
     query: string,
     operationName?: string,
     prevOperations?: OperationDefinitionNode[],
-    schema?: GraphQLSchema,
+    schema?: GraphQLSchema | null,
   ) => {
     const queryFacts = getOperationFacts(schema, query);
     if (queryFacts) {

diff --git a/packages/graphiql/src/components/QueryEditor.tsx b/packages/graphiql/src/components/QueryEditor.tsx
@@ -23,7 +23,7 @@ const md = new MD();
 const AUTO_COMPLETE_AFTER_KEY = /^[a-zA-Z0-9_@(]$/;
 
 type QueryEditorProps = {
-  schema?: GraphQLSchema;
+  schema?: GraphQLSchema | null;
   validationRules?: ValidationRule[];
   value?: string;
   onEdit?: (value: string) => void;

diff --git a/packages/graphiql/src/utility/fillLeafs.ts b/packages/graphiql/src/utility/fillLeafs.ts
@@ -40,7 +40,7 @@ export type GetDefaultFieldNamesFn = (type: GraphQLType) => string[];
  * utility represents a "best effort" which may be useful within IDE tools.
  */
 export function fillLeafs(
-  schema?: GraphQLSchema,
+  schema?: GraphQLSchema | null,
   docString?: string,
   getDefaultFieldNames?: GetDefaultFieldNamesFn,
 ) {

diff --git a/packages/graphiql/src/utility/getQueryFacts.ts b/packages/graphiql/src/utility/getQueryFacts.ts
@@ -33,7 +33,7 @@ export type QueryFacts = {
  * If the query cannot be parsed, returns undefined.
  */
 export default function getOperationFacts(
-  schema?: GraphQLSchema,
+  schema?: GraphQLSchema | null,
   documentStr?: string | null,
 ): QueryFacts | undefined {
   if (!documentStr) {

diff --git a/packages/graphiql/src/utility/mergeAst.ts b/packages/graphiql/src/utility/mergeAst.ts
@@ -117,7 +117,7 @@ export function inlineRelevantFragmentSpreads(
  */
 export default function mergeAST(
   documentAST: DocumentNode,
-  schema?: GraphQLSchema,
+  schema?: GraphQLSchema | null,
 ): DocumentNode {
   // If we're given the schema, we can simplify even further by resolving object
   // types vs unions/interfaces