123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337 |
- import { GraphQLEnumType, GraphQLInterfaceType, GraphQLObjectType, GraphQLScalarType, GraphQLUnionType, isEnumType, isInterfaceType, isObjectType, isScalarType, isSpecifiedScalarType, isUnionType, } from 'graphql';
- import { forEachDefaultValue, forEachField, healSchema, MapperKind, mapSchema, parseInputValue, serializeInputValue, } from '@graphql-tools/utils';
- import { checkForResolveTypeResolver } from './checkForResolveTypeResolver.js';
- import { extendResolversFromInterfaces } from './extendResolversFromInterfaces.js';
- export function addResolversToSchema({ schema, resolvers: inputResolvers, defaultFieldResolver, resolverValidationOptions = {}, inheritResolversFromInterfaces = false, updateResolversInPlace = false, }) {
- const { requireResolversToMatchSchema = 'error', requireResolversForResolveType } = resolverValidationOptions;
- const resolvers = inheritResolversFromInterfaces
- ? extendResolversFromInterfaces(schema, inputResolvers)
- : inputResolvers;
- for (const typeName in resolvers) {
- const resolverValue = resolvers[typeName];
- const resolverType = typeof resolverValue;
- if (resolverType !== 'object') {
- throw new Error(`"${typeName}" defined in resolvers, but has invalid value "${resolverValue}". The resolver's value must be of type object.`);
- }
- const type = schema.getType(typeName);
- if (type == null) {
- const msg = `"${typeName}" defined in resolvers, but not in schema`;
- if (requireResolversToMatchSchema && requireResolversToMatchSchema !== 'error') {
- if (requireResolversToMatchSchema === 'warn') {
- console.warn(msg);
- }
- continue;
- }
- throw new Error(msg);
- }
- else if (isSpecifiedScalarType(type)) {
- // allow -- without recommending -- overriding of specified scalar types
- for (const fieldName in resolverValue) {
- if (fieldName.startsWith('__')) {
- type[fieldName.substring(2)] = resolverValue[fieldName];
- }
- else {
- type[fieldName] = resolverValue[fieldName];
- }
- }
- }
- else if (isEnumType(type)) {
- const values = type.getValues();
- for (const fieldName in resolverValue) {
- if (!fieldName.startsWith('__') &&
- !values.some(value => value.name === fieldName) &&
- requireResolversToMatchSchema &&
- requireResolversToMatchSchema !== 'ignore') {
- const msg = `${type.name}.${fieldName} was defined in resolvers, but not present within ${type.name}`;
- if (requireResolversToMatchSchema === 'error') {
- throw new Error(msg);
- }
- else {
- console.warn(msg);
- }
- }
- }
- }
- else if (isUnionType(type)) {
- for (const fieldName in resolverValue) {
- if (!fieldName.startsWith('__') &&
- requireResolversToMatchSchema &&
- requireResolversToMatchSchema !== 'ignore') {
- const msg = `${type.name}.${fieldName} was defined in resolvers, but ${type.name} is not an object or interface type`;
- if (requireResolversToMatchSchema === 'error') {
- throw new Error(msg);
- }
- else {
- console.warn(msg);
- }
- }
- }
- }
- else if (isObjectType(type) || isInterfaceType(type)) {
- for (const fieldName in resolverValue) {
- if (!fieldName.startsWith('__')) {
- const fields = type.getFields();
- const field = fields[fieldName];
- if (field == null) {
- // Field present in resolver but not in schema
- if (requireResolversToMatchSchema && requireResolversToMatchSchema !== 'ignore') {
- const msg = `${typeName}.${fieldName} defined in resolvers, but not in schema`;
- if (requireResolversToMatchSchema === 'error') {
- throw new Error(msg);
- }
- else {
- console.error(msg);
- }
- }
- }
- else {
- // Field present in both the resolver and schema
- const fieldResolve = resolverValue[fieldName];
- if (typeof fieldResolve !== 'function' && typeof fieldResolve !== 'object') {
- throw new Error(`Resolver ${typeName}.${fieldName} must be object or function`);
- }
- }
- }
- }
- }
- }
- schema = updateResolversInPlace
- ? addResolversToExistingSchema(schema, resolvers, defaultFieldResolver)
- : createNewSchemaWithResolvers(schema, resolvers, defaultFieldResolver);
- if (requireResolversForResolveType && requireResolversForResolveType !== 'ignore') {
- checkForResolveTypeResolver(schema, requireResolversForResolveType);
- }
- return schema;
- }
- function addResolversToExistingSchema(schema, resolvers, defaultFieldResolver) {
- const typeMap = schema.getTypeMap();
- for (const typeName in resolvers) {
- const type = schema.getType(typeName);
- const resolverValue = resolvers[typeName];
- if (isScalarType(type)) {
- for (const fieldName in resolverValue) {
- if (fieldName.startsWith('__')) {
- type[fieldName.substring(2)] = resolverValue[fieldName];
- }
- else if (fieldName === 'astNode' && type.astNode != null) {
- type.astNode = {
- ...type.astNode,
- description: resolverValue?.astNode?.description ??
- type.astNode.description,
- directives: (type.astNode.directives ?? []).concat(resolverValue?.astNode?.directives ?? []),
- };
- }
- else if (fieldName === 'extensionASTNodes' && type.extensionASTNodes != null) {
- type.extensionASTNodes = type.extensionASTNodes.concat(resolverValue?.extensionASTNodes ?? []);
- }
- else if (fieldName === 'extensions' &&
- type.extensions != null &&
- resolverValue.extensions != null) {
- type.extensions = Object.assign(Object.create(null), type.extensions, resolverValue.extensions);
- }
- else {
- type[fieldName] = resolverValue[fieldName];
- }
- }
- }
- else if (isEnumType(type)) {
- const config = type.toConfig();
- const enumValueConfigMap = config.values;
- for (const fieldName in resolverValue) {
- if (fieldName.startsWith('__')) {
- config[fieldName.substring(2)] = resolverValue[fieldName];
- }
- else if (fieldName === 'astNode' && config.astNode != null) {
- config.astNode = {
- ...config.astNode,
- description: resolverValue?.astNode?.description ??
- config.astNode.description,
- directives: (config.astNode.directives ?? []).concat(resolverValue?.astNode?.directives ?? []),
- };
- }
- else if (fieldName === 'extensionASTNodes' && config.extensionASTNodes != null) {
- config.extensionASTNodes = config.extensionASTNodes.concat(resolverValue?.extensionASTNodes ?? []);
- }
- else if (fieldName === 'extensions' &&
- type.extensions != null &&
- resolverValue.extensions != null) {
- type.extensions = Object.assign(Object.create(null), type.extensions, resolverValue.extensions);
- }
- else if (enumValueConfigMap[fieldName]) {
- enumValueConfigMap[fieldName].value = resolverValue[fieldName];
- }
- }
- typeMap[typeName] = new GraphQLEnumType(config);
- }
- else if (isUnionType(type)) {
- for (const fieldName in resolverValue) {
- if (fieldName.startsWith('__')) {
- type[fieldName.substring(2)] = resolverValue[fieldName];
- }
- }
- }
- else if (isObjectType(type) || isInterfaceType(type)) {
- for (const fieldName in resolverValue) {
- if (fieldName.startsWith('__')) {
- // this is for isTypeOf and resolveType and all the other stuff.
- type[fieldName.substring(2)] = resolverValue[fieldName];
- continue;
- }
- const fields = type.getFields();
- const field = fields[fieldName];
- if (field != null) {
- const fieldResolve = resolverValue[fieldName];
- if (typeof fieldResolve === 'function') {
- // for convenience. Allows shorter syntax in resolver definition file
- field.resolve = fieldResolve.bind(resolverValue);
- }
- else {
- setFieldProperties(field, fieldResolve);
- }
- }
- }
- }
- }
- // serialize all default values prior to healing fields with new scalar/enum types.
- forEachDefaultValue(schema, serializeInputValue);
- // schema may have new scalar/enum types that require healing
- healSchema(schema);
- // reparse all default values with new parsing functions.
- forEachDefaultValue(schema, parseInputValue);
- if (defaultFieldResolver != null) {
- forEachField(schema, field => {
- if (!field.resolve) {
- field.resolve = defaultFieldResolver;
- }
- });
- }
- return schema;
- }
- function createNewSchemaWithResolvers(schema, resolvers, defaultFieldResolver) {
- schema = mapSchema(schema, {
- [MapperKind.SCALAR_TYPE]: type => {
- const config = type.toConfig();
- const resolverValue = resolvers[type.name];
- if (!isSpecifiedScalarType(type) && resolverValue != null) {
- for (const fieldName in resolverValue) {
- if (fieldName.startsWith('__')) {
- config[fieldName.substring(2)] = resolverValue[fieldName];
- }
- else if (fieldName === 'astNode' && config.astNode != null) {
- config.astNode = {
- ...config.astNode,
- description: resolverValue?.astNode?.description ??
- config.astNode.description,
- directives: (config.astNode.directives ?? []).concat(resolverValue?.astNode?.directives ?? []),
- };
- }
- else if (fieldName === 'extensionASTNodes' && config.extensionASTNodes != null) {
- config.extensionASTNodes = config.extensionASTNodes.concat(resolverValue?.extensionASTNodes ?? []);
- }
- else if (fieldName === 'extensions' &&
- config.extensions != null &&
- resolverValue.extensions != null) {
- config.extensions = Object.assign(Object.create(null), type.extensions, resolverValue.extensions);
- }
- else {
- config[fieldName] = resolverValue[fieldName];
- }
- }
- return new GraphQLScalarType(config);
- }
- },
- [MapperKind.ENUM_TYPE]: type => {
- const resolverValue = resolvers[type.name];
- const config = type.toConfig();
- const enumValueConfigMap = config.values;
- if (resolverValue != null) {
- for (const fieldName in resolverValue) {
- if (fieldName.startsWith('__')) {
- config[fieldName.substring(2)] = resolverValue[fieldName];
- }
- else if (fieldName === 'astNode' && config.astNode != null) {
- config.astNode = {
- ...config.astNode,
- description: resolverValue?.astNode?.description ??
- config.astNode.description,
- directives: (config.astNode.directives ?? []).concat(resolverValue?.astNode?.directives ?? []),
- };
- }
- else if (fieldName === 'extensionASTNodes' && config.extensionASTNodes != null) {
- config.extensionASTNodes = config.extensionASTNodes.concat(resolverValue?.extensionASTNodes ?? []);
- }
- else if (fieldName === 'extensions' &&
- config.extensions != null &&
- resolverValue.extensions != null) {
- config.extensions = Object.assign(Object.create(null), type.extensions, resolverValue.extensions);
- }
- else if (enumValueConfigMap[fieldName]) {
- enumValueConfigMap[fieldName].value = resolverValue[fieldName];
- }
- }
- return new GraphQLEnumType(config);
- }
- },
- [MapperKind.UNION_TYPE]: type => {
- const resolverValue = resolvers[type.name];
- if (resolverValue != null) {
- const config = type.toConfig();
- if (resolverValue['__resolveType']) {
- config.resolveType = resolverValue['__resolveType'];
- }
- return new GraphQLUnionType(config);
- }
- },
- [MapperKind.OBJECT_TYPE]: type => {
- const resolverValue = resolvers[type.name];
- if (resolverValue != null) {
- const config = type.toConfig();
- if (resolverValue['__isTypeOf']) {
- config.isTypeOf = resolverValue['__isTypeOf'];
- }
- return new GraphQLObjectType(config);
- }
- },
- [MapperKind.INTERFACE_TYPE]: type => {
- const resolverValue = resolvers[type.name];
- if (resolverValue != null) {
- const config = type.toConfig();
- if (resolverValue['__resolveType']) {
- config.resolveType = resolverValue['__resolveType'];
- }
- return new GraphQLInterfaceType(config);
- }
- },
- [MapperKind.COMPOSITE_FIELD]: (fieldConfig, fieldName, typeName) => {
- const resolverValue = resolvers[typeName];
- if (resolverValue != null) {
- const fieldResolve = resolverValue[fieldName];
- if (fieldResolve != null) {
- const newFieldConfig = { ...fieldConfig };
- if (typeof fieldResolve === 'function') {
- // for convenience. Allows shorter syntax in resolver definition file
- newFieldConfig.resolve = fieldResolve.bind(resolverValue);
- }
- else {
- setFieldProperties(newFieldConfig, fieldResolve);
- }
- return newFieldConfig;
- }
- }
- },
- });
- if (defaultFieldResolver != null) {
- schema = mapSchema(schema, {
- [MapperKind.OBJECT_FIELD]: fieldConfig => ({
- ...fieldConfig,
- resolve: fieldConfig.resolve != null ? fieldConfig.resolve : defaultFieldResolver,
- }),
- });
- }
- return schema;
- }
- function setFieldProperties(field, propertiesObj) {
- for (const propertyName in propertiesObj) {
- field[propertyName] = propertiesObj[propertyName];
- }
- }
|