fix: allow to provide Options in buildSchema(module, opts) method

Author: nodkz

.vscode/settings.json

@@ -3,4 +3,5 @@
   "javascript.validate.enable": false,
   "javascript.autoClosingTags": false,
   "eslint.autoFixOnSave": true,
+  "typescript.tsdk": "node_modules/typescript/lib",
 }

examples/forTests/schema/index.ts

@@ -1,3 +1,12 @@
 import { buildSchema } from '../../../src';
+import { SchemaComposer } from 'graphql-compose';
 
-export const schema = buildSchema(module);
+const schemaComposer = new SchemaComposer();
+schemaComposer.Query.addFields({
+  time: {
+    type: 'String',
+    resolve: () => Date.now(),
+  },
+});
+
+export const schema = buildSchema(module, { schemaComposer });

src/__tests__/requireAstToSchema-test.ts

@@ -5,7 +5,7 @@ import { printSchema } from 'graphql/utilities';
 
 describe('requireAstToSchema()', () => {
   describe('Schema ../../examples/forTests/schema', () => {
-    const ast = requireSchemaDirectory(module, '../../examples/forTests/schema');
+    const ast = requireSchemaDirectory(module, { relativePath: '../../examples/forTests/schema' });
     const sc = requireAstToSchema(ast);
 
     it('should return schema composer', () => {

src/__tests__/requireSchemaDirectory-test.ts

@@ -2,7 +2,7 @@ import { requireSchemaDirectory } from '../requireSchemaDirectory';
 
 describe('requireSchemaDirectory()', () => {
   describe('Schema ../../examples/forTests/schema', () => {
-    const ast = requireSchemaDirectory(module, '../../examples/forTests/schema');
+    const ast = requireSchemaDirectory(module, { relativePath: '../../examples/forTests/schema' });
 
     it('should return root types', () => {
       expect(Object.keys(ast)).toEqual(expect.arrayContaining(['query', 'mutation']));

src/index.ts

@@ -1,13 +1,15 @@
-import { requireSchemaDirectory } from './requireSchemaDirectory';
-import { requireAstToSchema } from './requireAstToSchema';
+import { requireSchemaDirectory, RequireOptions } from './requireSchemaDirectory';
+import { requireAstToSchema, AstOptions } from './requireAstToSchema';
 
-export function buildSchema(module: NodeModule) {
-  return loadSchemaComposer(module).buildSchema();
+export interface BuildOptions extends RequireOptions, AstOptions {}
+
+export function buildSchema(module: NodeModule, opts: BuildOptions = {}) {
+  return loadSchemaComposer(module, opts).buildSchema();
 }
 
-export function loadSchemaComposer(module: NodeModule) {
-  const ast = requireSchemaDirectory(module);
-  const sc = requireAstToSchema(ast);
+export function loadSchemaComposer(module: NodeModule, opts: BuildOptions) {
+  const ast = requireSchemaDirectory(module, opts);
+  const sc = requireAstToSchema(ast, opts);
   return sc;
 }
 

src/requireAstToSchema.ts

@@ -18,11 +18,28 @@ import {
 import dedent from 'dedent';
 import { GraphQLObjectType } from 'graphql';
 
+export interface AstOptions {
+  schemaComposer?: SchemaComposer<any>;
+}
+
 export function requireAstToSchema<TContext = any>(
   ast: RequireAstResult,
-  schemaComposer?: SchemaComposer<TContext>
+  opts: AstOptions = {}
 ): SchemaComposer<TContext> {
-  const sc = schemaComposer || new SchemaComposer<TContext>();
+  let sc: SchemaComposer<any>;
+
+  if (opts?.schemaComposer) {
+    if (!opts.schemaComposer) {
+      throw new Error(dedent`
+        Provided option 'schemaComposer' should be an instance of SchemaComposer class from 'graphql-compose' package. 
+        Recieved:
+          ${inspect(opts.schemaComposer)}
+      `);
+    }
+    sc = opts.schemaComposer;
+  } else {
+    sc = new SchemaComposer();
+  }
 
   if (ast.query) populateRoot(sc, 'Query', ast.query);
   if (ast.mutation) populateRoot(sc, 'Mutation', ast.mutation);

src/requireSchemaDirectory.ts

@@ -1,8 +1,9 @@
 import fs from 'fs';
 import { join, resolve, dirname, basename } from 'path';
 
-interface Options {
-  extensions: string[];
+export interface RequireOptions {
+  relativePath?: string;
+  extensions?: string[];
   include?: RegExp | ((path: string, filename: string) => boolean);
   exclude?: RegExp | ((path: string, filename: string) => boolean);
 }
@@ -42,18 +43,19 @@ export interface RequireAstResult {
   subscription?: RequireAstRootTypeNode;
 }
 
-export const defaultOptions: Options = {
+export const defaultOptions: RequireOptions = {
   extensions: ['js', 'ts'],
 };
 
 export function requireSchemaDirectory(
   m: NodeModule,
-  path?: string,
-  options: Options = defaultOptions
+  options: RequireOptions = defaultOptions
 ): RequireAstResult {
   // if no path was passed in, assume the equivelant of __dirname from caller
   // otherwise, resolve path relative to the equivalent of __dirname
-  const schemaPath = !path ? dirname(m.filename) : resolve(dirname(m.filename), path);
+  const schemaPath = options?.relativePath
+    ? resolve(dirname(m.filename), options.relativePath)
+    : dirname(m.filename);
 
   const result = {} as RequireAstResult;
 
@@ -94,7 +96,7 @@ export function requireSchemaDirectory(
 export function requireSubDirectory(
   m: NodeModule,
   path: string,
-  options: Options = defaultOptions
+  options: RequireOptions = defaultOptions
 ): RequireAstDirNode {
   const result: RequireAstDirNode = {
     kind: 'dir',
@@ -153,7 +155,7 @@ function skipName(filename: string): boolean {
   return /^__.*/i.test(filename);
 }
 
-function checkFileInclusion(absPath: string, filename: string, options: Options): boolean {
+function checkFileInclusion(absPath: string, filename: string, options: RequireOptions): boolean {
   return (
     // verify file has valid extension
     new RegExp('\\.(' + options.extensions.join('|') + ')$', 'i').test(filename) &&