refactor: add AstRootNode node with children for better compatibility with visitor pattern

Author: nodkz

src/__tests__/__snapshots__/astToSchema-test.ts.snap

@@ -14,7 +14,8 @@ type Mutation {
 }
 
 type MutationAuth {
-  login: Boolean
+  # Login operation
+  login(email: String, password: String): Boolean
   logout: Boolean
   nested: MutationAuthNested
 }

src/__tests__/__testSchema__/mutation.auth/login.ts

@@ -1,4 +1,6 @@
 export default {
   type: 'Boolean',
+  description: 'Login operation',
+  args: { email: 'String', password: 'String' },
   resolve: () => true,
 };

src/__tests__/directoryToAst-test.ts

@@ -5,11 +5,11 @@ describe('directoryToAst()', () => {
     const ast = directoryToAst(module, { relativePath: './__testSchema__' });
 
     it('should return root types', () => {
-      expect(Object.keys(ast)).toEqual(expect.arrayContaining(['query', 'mutation']));
+      expect(Object.keys(ast.children)).toEqual(expect.arrayContaining(['query', 'mutation']));
     });
 
     it('query has proper values', () => {
-      expect(ast.query).toMatchSnapshot({
+      expect(ast.children.query).toMatchSnapshot({
         name: 'query',
         kind: 'rootType',
         absPath: expect.any(String),
@@ -46,7 +46,7 @@ describe('directoryToAst()', () => {
     });
 
     it('mutation has proper values', () => {
-      expect(ast.mutation).toMatchSnapshot({
+      expect(ast.children.mutation).toMatchSnapshot({
         name: 'mutation',
         kind: 'rootType',
         absPath: expect.any(String),

src/astToSchema.ts

@@ -9,7 +9,7 @@ import {
   isSomeOutputTypeDefinitionString,
   inspect,
 } from 'graphql-compose';
-import { AstResult, AstRootTypeNode, AstDirNode, AstFileNode } from './directoryToAst';
+import { AstRootNode, AstRootTypeNode, AstDirNode, AstFileNode } from './directoryToAst';
 import dedent from 'dedent';
 import { GraphQLObjectType } from 'graphql';
 
@@ -20,7 +20,7 @@ export interface AstToSchemaOptions {
 }
 
 export function astToSchema<TContext = any>(
-  ast: AstResult,
+  ast: AstRootNode,
   opts: AstToSchemaOptions = {}
 ): SchemaComposer<TContext> {
   let sc: SchemaComposer<any>;
@@ -38,9 +38,9 @@ export function astToSchema<TContext = any>(
     sc = new SchemaComposer();
   }
 
-  if (ast.query) populateRoot(sc, 'Query', ast.query, opts);
-  if (ast.mutation) populateRoot(sc, 'Mutation', ast.mutation, opts);
-  if (ast.subscription) populateRoot(sc, 'Subscription', ast.subscription, opts);
+  if (ast.children.query) populateRoot(sc, 'Query', ast.children.query, opts);
+  if (ast.children.mutation) populateRoot(sc, 'Mutation', ast.children.mutation, opts);
+  if (ast.children.subscription) populateRoot(sc, 'Subscription', ast.children.subscription, opts);
 
   return sc;
 }

src/directoryToAst.ts

@@ -8,7 +8,7 @@ export interface DirectoryToAstOptions {
   exclude?: RegExp | ((path: string, kind: 'dir' | 'file', filename: string) => boolean);
 }
 
-export type AstNodeKinds = 'rootType' | 'dir' | 'file';
+export type AstNodeKinds = 'rootType' | 'dir' | 'file' | 'root';
 
 export interface AstBaseNode {
   kind: AstNodeKinds;
@@ -39,10 +39,13 @@ export interface AstFileNode extends AstBaseNode {
   };
 }
 
-export interface AstResult {
-  query?: AstRootTypeNode;
-  mutation?: AstRootTypeNode;
-  subscription?: AstRootTypeNode;
+type RootTypeNames = 'query' | 'mutation' | 'subscription';
+
+export interface AstRootNode extends AstBaseNode {
+  kind: 'root';
+  children: {
+    [T in RootTypeNames]?: AstRootTypeNode;
+  };
 }
 
 export const defaultOptions: DirectoryToAstOptions = {
@@ -52,7 +55,7 @@ export const defaultOptions: DirectoryToAstOptions = {
 export function directoryToAst(
   m: NodeModule,
   options: DirectoryToAstOptions = defaultOptions
-): AstResult {
+): AstRootNode {
   // if no path was passed in, assume the equivelant of __dirname from caller
   // otherwise, resolve path relative to the equivalent of __dirname
   const schemaPath = options?.relativePath
@@ -66,7 +69,12 @@ export function directoryToAst(
     }
   });
 
-  const result = {} as AstResult;
+  const result = {
+    kind: 'root',
+    name: basename(schemaPath),
+    absPath: schemaPath,
+    children: {},
+  } as AstRootNode;
 
   fs.readdirSync(schemaPath).forEach((filename) => {
     const absPath = join(schemaPath, filename);
@@ -76,8 +84,8 @@ export function directoryToAst(
       const re = /^(query|mutation|subscription)(\.(.*))?$/i;
       const found = dirName.match(re);
       if (found) {
-        const opType = found[1].toLowerCase() as keyof AstResult;
-        let rootTypeAst = result[opType];
+        const opType = found[1].toLowerCase() as keyof AstRootNode['children'];
+        let rootTypeAst = result.children[opType];
         if (!rootTypeAst)
           rootTypeAst = {
             kind: 'rootType',
@@ -101,7 +109,7 @@ export function directoryToAst(
               rootTypeAst.namespaceConfig = astDir.namespaceConfig;
             }
           }
-          result[opType] = rootTypeAst;
+          result.children[opType] = rootTypeAst;
         }
       }
     }

src/index.ts

@@ -21,7 +21,7 @@ export {
   AstRootTypeNode,
   AstDirNode,
   AstFileNode,
-  AstResult,
+  AstRootNode,
 } from './directoryToAst';
 export { astToSchema, AstToSchemaOptions } from './astToSchema';
 export * from './testHelpers';