@graphql-codegen/graphql-modules-preset 2.4.3-alpha-7e47fba48.0 → 2.5.0

package/cjs/builder.js

@@ -6,7 +6,7 @@ const change_case_all_1 = require("change-case-all");
 const utils_js_1 = require("./utils.js");
 const registryKeys = ['objects', 'inputs', 'interfaces', 'scalars', 'unions', 'enums'];
 const resolverKeys = ['scalars', 'objects', 'enums'];
-function buildModule(name, doc, { importNamespace, importPath, encapsulate, shouldDeclare, rootTypes, schema, baseVisitor, useGraphQLModules, }) {
+function buildModule(name, doc, { importNamespace, importPath, encapsulate, requireRootResolvers, shouldDeclare, rootTypes, schema, baseVisitor, useGraphQLModules, }) {
     const picks = (0, utils_js_1.createObject)(registryKeys, () => ({}));
     const defined = (0, utils_js_1.createObject)(registryKeys, () => []);
     const extended = (0, utils_js_1.createObject)(registryKeys, () => []);
@@ -135,7 +135,9 @@ function buildModule(name, doc, { importNamespace, importPath, encapsulate, shou
     function printResolveSignaturesPerType(registry) {
         return [
             [...registry.objects, ...registry.interfaces]
-                .map(name => printResolverType(name, 'DefinedFields', !rootTypes.includes(name) && defined.objects.includes(name) ? ` | '__isTypeOf'` : ''))
+                .map(name => printResolverType(name, 'DefinedFields', 
+            // In case of enabled `requireRootResolvers` flag, the preset has to produce a non-optional properties.
+            requireRootResolvers && rootTypes.includes(name), !rootTypes.includes(name) && defined.objects.includes(name) ? ` | '__isTypeOf'` : ''))
                 .join('\n'),
         ].join('\n');
     }
@@ -172,7 +174,9 @@ function buildModule(name, doc, { importNamespace, importPath, encapsulate, shou
                         lines.push(`${typeName}?: ${encapsulateTypeName(importNamespace)}.Resolvers['${typeName}'];`);
                     }
                     else {
-                        lines.push(`${typeName}?: ${encapsulateTypeName(typeName)}Resolvers;`);
+                        // In case of enabled `requireRootResolvers` flag, the preset has to produce a non-optional property.
+                        const fieldModifier = requireRootResolvers && rootTypes.includes(typeName) ? '' : '?';
+                        lines.push(`${typeName}${fieldModifier}: ${encapsulateTypeName(typeName)}Resolvers;`);
                     }
                 });
             }
@@ -207,10 +211,11 @@ function buildModule(name, doc, { importNamespace, importPath, encapsulate, shou
     function printResolveMiddlewareRecord(path) {
         return `${path}?: gm.Middleware[];`;
     }
-    function printResolverType(typeName, picksTypeName, extraKeys = '') {
-        return `export type ${encapsulateTypeName(`${typeName}Resolvers`)} = Pick<${importNamespace}.${baseVisitor.convertName(typeName, {
+    function printResolverType(typeName, picksTypeName, requireFieldsResolvers = false, extraKeys = '') {
+        const typeSignature = `Pick<${importNamespace}.${baseVisitor.convertName(typeName, {
             suffix: 'Resolvers',
-        })}, ${picksTypeName}['${typeName}']${extraKeys}>;`;
+        })}, ${picksTypeName}['${typeName}']${extraKeys}>`;
+        return `export type ${encapsulateTypeName(`${typeName}Resolvers`)} = ${requireFieldsResolvers ? `Required<${typeSignature}>` : typeSignature};`;
     }
     function printPicks(typeName, records) {
         return records[typeName].filter(utils_js_1.unique).map(utils_js_1.withQuotes).join(' | ');

package/cjs/index.js

@@ -8,9 +8,10 @@ const builder_js_1 = require("./builder.js");
 const visitor_plugin_common_1 = require("@graphql-codegen/visitor-plugin-common");
 exports.preset = {
     buildGeneratesSection: options => {
-        const useGraphQLModules = (0, visitor_plugin_common_1.getConfigValue)(options === null || options === void 0 ? void 0 : options.presetConfig.useGraphQLModules, true);
         const { baseOutputDir } = options;
         const { baseTypesPath, encapsulateModuleTypes } = options.presetConfig;
+        const useGraphQLModules = (0, visitor_plugin_common_1.getConfigValue)(options === null || options === void 0 ? void 0 : options.presetConfig.useGraphQLModules, true);
+        const requireRootResolvers = (0, visitor_plugin_common_1.getConfigValue)(options === null || options === void 0 ? void 0 : options.presetConfig.requireRootResolvers, false);
         const cwd = (0, path_1.resolve)(options.presetConfig.cwd || process.cwd());
         const importTypesNamespace = options.presetConfig.importTypesNamespace || 'Types';
         if (!baseTypesPath) {
@@ -88,6 +89,7 @@ exports.preset = {
                                 importNamespace: importTypesNamespace,
                                 importPath,
                                 encapsulate: encapsulateModuleTypes || 'namespace',
+                                requireRootResolvers,
                                 shouldDeclare,
                                 schema,
                                 baseVisitor,

package/esm/builder.js

@@ -3,7 +3,7 @@ import { pascalCase } from 'change-case-all';
 import { unique, withQuotes, buildBlock, pushUnique, concatByKey, uniqueByKey, createObject, collectUsedTypes, indent, } from './utils.js';
 const registryKeys = ['objects', 'inputs', 'interfaces', 'scalars', 'unions', 'enums'];
 const resolverKeys = ['scalars', 'objects', 'enums'];
-export function buildModule(name, doc, { importNamespace, importPath, encapsulate, shouldDeclare, rootTypes, schema, baseVisitor, useGraphQLModules, }) {
+export function buildModule(name, doc, { importNamespace, importPath, encapsulate, requireRootResolvers, shouldDeclare, rootTypes, schema, baseVisitor, useGraphQLModules, }) {
     const picks = createObject(registryKeys, () => ({}));
     const defined = createObject(registryKeys, () => []);
     const extended = createObject(registryKeys, () => []);
@@ -132,7 +132,9 @@ export function buildModule(name, doc, { importNamespace, importPath, encapsulat
     function printResolveSignaturesPerType(registry) {
         return [
             [...registry.objects, ...registry.interfaces]
-                .map(name => printResolverType(name, 'DefinedFields', !rootTypes.includes(name) && defined.objects.includes(name) ? ` | '__isTypeOf'` : ''))
+                .map(name => printResolverType(name, 'DefinedFields', 
+            // In case of enabled `requireRootResolvers` flag, the preset has to produce a non-optional properties.
+            requireRootResolvers && rootTypes.includes(name), !rootTypes.includes(name) && defined.objects.includes(name) ? ` | '__isTypeOf'` : ''))
                 .join('\n'),
         ].join('\n');
     }
@@ -169,7 +171,9 @@ export function buildModule(name, doc, { importNamespace, importPath, encapsulat
                         lines.push(`${typeName}?: ${encapsulateTypeName(importNamespace)}.Resolvers['${typeName}'];`);
                     }
                     else {
-                        lines.push(`${typeName}?: ${encapsulateTypeName(typeName)}Resolvers;`);
+                        // In case of enabled `requireRootResolvers` flag, the preset has to produce a non-optional property.
+                        const fieldModifier = requireRootResolvers && rootTypes.includes(typeName) ? '' : '?';
+                        lines.push(`${typeName}${fieldModifier}: ${encapsulateTypeName(typeName)}Resolvers;`);
                     }
                 });
             }
@@ -204,10 +208,11 @@ export function buildModule(name, doc, { importNamespace, importPath, encapsulat
     function printResolveMiddlewareRecord(path) {
         return `${path}?: gm.Middleware[];`;
     }
-    function printResolverType(typeName, picksTypeName, extraKeys = '') {
-        return `export type ${encapsulateTypeName(`${typeName}Resolvers`)} = Pick<${importNamespace}.${baseVisitor.convertName(typeName, {
+    function printResolverType(typeName, picksTypeName, requireFieldsResolvers = false, extraKeys = '') {
+        const typeSignature = `Pick<${importNamespace}.${baseVisitor.convertName(typeName, {
             suffix: 'Resolvers',
-        })}, ${picksTypeName}['${typeName}']${extraKeys}>;`;
+        })}, ${picksTypeName}['${typeName}']${extraKeys}>`;
+        return `export type ${encapsulateTypeName(`${typeName}Resolvers`)} = ${requireFieldsResolvers ? `Required<${typeSignature}>` : typeSignature};`;
     }
     function printPicks(typeName, records) {
         return records[typeName].filter(unique).map(withQuotes).join(' | ');

package/esm/index.js

@@ -5,9 +5,10 @@ import { buildModule } from './builder.js';
 import { BaseVisitor, getConfigValue } from '@graphql-codegen/visitor-plugin-common';
 export const preset = {
     buildGeneratesSection: options => {
-        const useGraphQLModules = getConfigValue(options === null || options === void 0 ? void 0 : options.presetConfig.useGraphQLModules, true);
         const { baseOutputDir } = options;
         const { baseTypesPath, encapsulateModuleTypes } = options.presetConfig;
+        const useGraphQLModules = getConfigValue(options === null || options === void 0 ? void 0 : options.presetConfig.useGraphQLModules, true);
+        const requireRootResolvers = getConfigValue(options === null || options === void 0 ? void 0 : options.presetConfig.requireRootResolvers, false);
         const cwd = resolve(options.presetConfig.cwd || process.cwd());
         const importTypesNamespace = options.presetConfig.importTypesNamespace || 'Types';
         if (!baseTypesPath) {
@@ -85,6 +86,7 @@ export const preset = {
                                 importNamespace: importTypesNamespace,
                                 importPath,
                                 encapsulate: encapsulateModuleTypes || 'namespace',
+                                requireRootResolvers,
                                 shouldDeclare,
                                 schema,
                                 baseVisitor,

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@graphql-codegen/graphql-modules-preset",
-  "version": "2.4.3-alpha-7e47fba48.0",
+  "version": "2.5.0",
   "description": "GraphQL Code Generator preset for modularized schema",
   "peerDependencies": {
     "graphql": "^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0"
   },
   "dependencies": {
-    "@graphql-codegen/plugin-helpers": "^2.6.1-alpha-7e47fba48.0",
-    "@graphql-codegen/visitor-plugin-common": "2.12.1-alpha-7e47fba48.0",
+    "@graphql-codegen/plugin-helpers": "^2.6.0",
+    "@graphql-codegen/visitor-plugin-common": "2.12.0",
     "@graphql-tools/utils": "^8.8.0",
     "parse-filepath": "^1.0.2",
     "change-case-all": "1.0.14",

package/typings/builder.d.ts

@@ -1,10 +1,11 @@
 import { DocumentNode, GraphQLSchema } from 'graphql';
 import { ModulesConfig } from './config.js';
 import { BaseVisitor } from '@graphql-codegen/visitor-plugin-common';
-export declare function buildModule(name: string, doc: DocumentNode, { importNamespace, importPath, encapsulate, shouldDeclare, rootTypes, schema, baseVisitor, useGraphQLModules, }: {
+export declare function buildModule(name: string, doc: DocumentNode, { importNamespace, importPath, encapsulate, requireRootResolvers, shouldDeclare, rootTypes, schema, baseVisitor, useGraphQLModules, }: {
     importNamespace: string;
     importPath: string;
     encapsulate: ModulesConfig['encapsulateModuleTypes'];
+    requireRootResolvers: ModulesConfig['requireRootResolvers'];
     shouldDeclare: boolean;
     rootTypes: string[];
     baseVisitor: BaseVisitor;

package/typings/config.d.ts

@@ -82,6 +82,26 @@ export declare type ModulesConfig = {
      *
      */
     encapsulateModuleTypes: 'prefix' | 'namespace' | 'none';
+    /**
+     * @name requireRootResolvers
+     * @type boolean
+     * @default false
+     * @description Generate resolvers of root types (Query, Mutation and Subscription) as non-optional.
+     *
+     * @example
+     * ```yml
+     * generates:
+     * src/:
+     *  preset: modules
+     *  presetConfig:
+     *    baseTypesPath: types.ts
+     *    filename: types.ts
+     *    requireRootResolvers: true
+     *  plugins:
+     *    - typescript-resolvers
+     * ```
+     */
+    requireRootResolvers?: boolean;
     /**
      * @name useGraphQLModules
      * @type boolean