feat: create schema file config interface and migrate use fed2 to it

Author: greguintow

packages/graphql/lib/interfaces/gql-module-options.interface.ts

@@ -5,27 +5,10 @@ import { GraphQLSchema } from 'graphql';
 import { GraphQLDriver } from '.';
 import { DefinitionsGeneratorOptions } from '../graphql-ast.explorer';
 import { BuildSchemaOptions } from './build-schema-options.interface';
+import { AutoSchemaFileValue } from './schema-file-config.interface';
 
 export type Enhancer = 'guards' | 'interceptors' | 'filters';
 
-export interface AliasDirectiveImport {
-  name: string;
-  as: string;
-}
-
-export interface Federation2Config {
-  /**
-   * The imported directives
-   * @default ['@key', '@shareable', '@external', '@override', '@requires']
-   */
-  directives?: (string | AliasDirectiveImport)[];
-  /**
-   * The import link
-   * @default 'https://specs.apollo.dev/federation/v2.0'
-   */
-  importUrl?: string;
-}
-
 /**
  * "GraphQLModule" options object.
  */
@@ -55,18 +38,6 @@ export interface GqlModuleOptions<TDriver extends GraphQLDriver = any> {
    */
   include?: Function[];
 
-  /**
-   * If enabled, it will use federation 2 schema
-   * 
-   * **Note:** You need to have installed @apollo/subgraph@^2.0.0 and enable `autoSchemaFile`
-   * 
-   * This will add to your schema:
-   * ```graphql
-      extend schema @link(url: "https://specs.apollo.dev/federation/v2.0", import: ["@key", "@shareable", "@external", "@override", "@requires"])
-   * ```
-   */
-  useFed2?: boolean | Federation2Config;
-
   /**
    * Directive resolvers
    */
@@ -93,7 +64,7 @@ export interface GqlModuleOptions<TDriver extends GraphQLDriver = any> {
   /**
    * If enabled, GraphQL schema will be generated automatically
    */
-  autoSchemaFile?: string | boolean;
+  autoSchemaFile?: AutoSchemaFileValue;
 
   /**
    * Sort the schema lexicographically

packages/graphql/lib/interfaces/index.ts

@@ -14,3 +14,4 @@ export * from './graphql-driver.interface';
 export * from './resolve-type-fn.interface';
 export * from './return-type-func.interface';
 export * from './build-federated-schema-options.interface';
+export * from './schema-file-config.interface';

packages/graphql/lib/interfaces/schema-file-config.interface.ts

@@ -0,0 +1,40 @@
+export interface AliasDirectiveImport {
+  name: string;
+  as: string;
+}
+
+export interface Federation2Config {
+  /**
+   * The imported directives
+   * @default ['@key', '@shareable', '@external', '@override', '@requires']
+   */
+  directives?: (string | AliasDirectiveImport)[];
+  /**
+   * The import link
+   * @default 'https://specs.apollo.dev/federation/v2.0'
+   */
+  importUrl?: string;
+}
+
+export type UseFed2Value = boolean | Federation2Config;
+
+export interface SchemaFileConfig {
+  /**
+   * If enabled, it will use federation 2 schema
+   * 
+   * **Note:** You need to have installed @apollo/subgraph@^2.0.0 and enable `autoSchemaFile`
+   * 
+   * This will add to your schema:
+   * ```graphql
+      extend schema @link(url: "https://specs.apollo.dev/federation/v2.0", import: ["@key", "@shareable", "@external", "@override", "@requires"])
+   * ```
+  */
+  useFed2?: UseFed2Value;
+
+  /**
+   * The path to the schema file
+   */
+  path?: string;
+}
+
+export type AutoSchemaFileValue = boolean | string | SchemaFileConfig;