fix: expose TypeScript definitions

Author: nodkz

src/astToSchema.ts

@@ -13,15 +13,15 @@ import { AstResult, AstRootTypeNode, AstDirNode, AstFileNode } from './directory
 import dedent from 'dedent';
 import { GraphQLObjectType } from 'graphql';
 
-export interface AstOptions {
+export interface AstToSchemaOptions {
   schemaComposer?: SchemaComposer<any>;
   prefix?: string;
   suffix?: string;
 }
 
 export function astToSchema<TContext = any>(
   ast: AstResult,
-  opts: AstOptions = {}
+  opts: AstToSchemaOptions = {}
 ): SchemaComposer<TContext> {
   let sc: SchemaComposer<any>;
 
@@ -49,7 +49,7 @@ function populateRoot(
   sc: SchemaComposer<any>,
   rootName: 'Query' | 'Mutation' | 'Subscription',
   astRootNode: AstRootTypeNode,
-  opts?: AstOptions
+  opts?: AstToSchemaOptions
 ) {
   const tc = sc[rootName];
   Object.keys(astRootNode.children).forEach((key) => {
@@ -62,7 +62,7 @@ export function createFields(
   ast: AstDirNode | AstFileNode | void,
   parent: ObjectTypeComposer,
   pathPrefix: string,
-  opts: AstOptions = {}
+  opts: AstToSchemaOptions = {}
 ): void {
   if (!ast) return;
 
@@ -105,7 +105,11 @@ export function createFields(
   }
 }
 
-function getTypename(ast: AstDirNode | AstFileNode, pathPrefix: string, opts: AstOptions): string {
+function getTypename(
+  ast: AstDirNode | AstFileNode,
+  pathPrefix: string,
+  opts: AstToSchemaOptions
+): string {
   const name = ast.name;
 
   let typename = pathPrefix;

src/directoryToAst.ts

@@ -1,16 +1,16 @@
 import fs from 'fs';
 import { join, resolve, dirname, basename } from 'path';
 
-export interface Options {
+export interface DirectoryToAstOptions {
   relativePath?: string;
   extensions?: string[];
   include?: RegExp | ((path: string, kind: 'dir' | 'file', filename: string) => boolean);
   exclude?: RegExp | ((path: string, kind: 'dir' | 'file', filename: string) => boolean);
 }
 
-type AstNodeKinds = 'rootType' | 'dir' | 'file';
+export type AstNodeKinds = 'rootType' | 'dir' | 'file';
 
-interface AstBaseNode {
+export interface AstBaseNode {
   kind: AstNodeKinds;
   name: string;
   absPath: string;
@@ -45,11 +45,14 @@ export interface AstResult {
   subscription?: AstRootTypeNode;
 }
 
-export const defaultOptions: Options = {
+export const defaultOptions: DirectoryToAstOptions = {
   extensions: ['js', 'ts'],
 };
 
-export function directoryToAst(m: NodeModule, options: Options = defaultOptions): AstResult {
+export function directoryToAst(
+  m: NodeModule,
+  options: DirectoryToAstOptions = defaultOptions
+): AstResult {
   // 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
@@ -110,7 +113,7 @@ export function directoryToAst(m: NodeModule, options: Options = defaultOptions)
 export function getAstForDir(
   m: NodeModule,
   absPath: string,
-  options: Options = defaultOptions
+  options: DirectoryToAstOptions = defaultOptions
 ): AstDirNode | void {
   const name = basename(absPath);
 
@@ -162,7 +165,7 @@ export function getAstForDir(
 export function getAstForFile(
   m: NodeModule,
   absPath: string,
-  options: Options = defaultOptions
+  options: DirectoryToAstOptions = defaultOptions
 ): AstFileNode | void {
   const filename = basename(absPath);
   if (absPath !== m.filename && checkInclusion(absPath, 'file', filename, options)) {
@@ -181,7 +184,7 @@ function checkInclusion(
   absPath: string,
   kind: 'dir' | 'file',
   filename: string,
-  options: Options
+  options: DirectoryToAstOptions
 ): boolean {
   // Skip dir/files started from double underscore
   if (/^__.*/i.test(filename)) {

src/index.ts

@@ -1,7 +1,7 @@
-import { directoryToAst, Options } from './directoryToAst';
-import { astToSchema, AstOptions } from './astToSchema';
+import { directoryToAst, DirectoryToAstOptions } from './directoryToAst';
+import { astToSchema, AstToSchemaOptions } from './astToSchema';
 
-export interface BuildOptions extends Options, AstOptions {}
+export interface BuildOptions extends DirectoryToAstOptions, AstToSchemaOptions {}
 
 export function buildSchema(module: NodeModule, opts: BuildOptions = {}) {
   return loadSchemaComposer(module, opts).buildSchema();
@@ -13,5 +13,15 @@ export function loadSchemaComposer(module: NodeModule, opts: BuildOptions) {
   return sc;
 }
 
-export { directoryToAst, astToSchema };
+export {
+  directoryToAst,
+  DirectoryToAstOptions,
+  AstNodeKinds,
+  AstBaseNode,
+  AstRootTypeNode,
+  AstDirNode,
+  AstFileNode,
+  AstResult,
+} from './directoryToAst';
+export { astToSchema, AstToSchemaOptions } from './astToSchema';
 export * from './testHelpers';