addResolversToSchema.js 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341
  1. "use strict";
  2. Object.defineProperty(exports, "__esModule", { value: true });
  3. exports.addResolversToSchema = void 0;
  4. const graphql_1 = require("graphql");
  5. const utils_1 = require("@graphql-tools/utils");
  6. const checkForResolveTypeResolver_js_1 = require("./checkForResolveTypeResolver.js");
  7. const extendResolversFromInterfaces_js_1 = require("./extendResolversFromInterfaces.js");
  8. function addResolversToSchema({ schema, resolvers: inputResolvers, defaultFieldResolver, resolverValidationOptions = {}, inheritResolversFromInterfaces = false, updateResolversInPlace = false, }) {
  9. const { requireResolversToMatchSchema = 'error', requireResolversForResolveType } = resolverValidationOptions;
  10. const resolvers = inheritResolversFromInterfaces
  11. ? (0, extendResolversFromInterfaces_js_1.extendResolversFromInterfaces)(schema, inputResolvers)
  12. : inputResolvers;
  13. for (const typeName in resolvers) {
  14. const resolverValue = resolvers[typeName];
  15. const resolverType = typeof resolverValue;
  16. if (resolverType !== 'object') {
  17. throw new Error(`"${typeName}" defined in resolvers, but has invalid value "${resolverValue}". The resolver's value must be of type object.`);
  18. }
  19. const type = schema.getType(typeName);
  20. if (type == null) {
  21. const msg = `"${typeName}" defined in resolvers, but not in schema`;
  22. if (requireResolversToMatchSchema && requireResolversToMatchSchema !== 'error') {
  23. if (requireResolversToMatchSchema === 'warn') {
  24. console.warn(msg);
  25. }
  26. continue;
  27. }
  28. throw new Error(msg);
  29. }
  30. else if ((0, graphql_1.isSpecifiedScalarType)(type)) {
  31. // allow -- without recommending -- overriding of specified scalar types
  32. for (const fieldName in resolverValue) {
  33. if (fieldName.startsWith('__')) {
  34. type[fieldName.substring(2)] = resolverValue[fieldName];
  35. }
  36. else {
  37. type[fieldName] = resolverValue[fieldName];
  38. }
  39. }
  40. }
  41. else if ((0, graphql_1.isEnumType)(type)) {
  42. const values = type.getValues();
  43. for (const fieldName in resolverValue) {
  44. if (!fieldName.startsWith('__') &&
  45. !values.some(value => value.name === fieldName) &&
  46. requireResolversToMatchSchema &&
  47. requireResolversToMatchSchema !== 'ignore') {
  48. const msg = `${type.name}.${fieldName} was defined in resolvers, but not present within ${type.name}`;
  49. if (requireResolversToMatchSchema === 'error') {
  50. throw new Error(msg);
  51. }
  52. else {
  53. console.warn(msg);
  54. }
  55. }
  56. }
  57. }
  58. else if ((0, graphql_1.isUnionType)(type)) {
  59. for (const fieldName in resolverValue) {
  60. if (!fieldName.startsWith('__') &&
  61. requireResolversToMatchSchema &&
  62. requireResolversToMatchSchema !== 'ignore') {
  63. const msg = `${type.name}.${fieldName} was defined in resolvers, but ${type.name} is not an object or interface type`;
  64. if (requireResolversToMatchSchema === 'error') {
  65. throw new Error(msg);
  66. }
  67. else {
  68. console.warn(msg);
  69. }
  70. }
  71. }
  72. }
  73. else if ((0, graphql_1.isObjectType)(type) || (0, graphql_1.isInterfaceType)(type)) {
  74. for (const fieldName in resolverValue) {
  75. if (!fieldName.startsWith('__')) {
  76. const fields = type.getFields();
  77. const field = fields[fieldName];
  78. if (field == null) {
  79. // Field present in resolver but not in schema
  80. if (requireResolversToMatchSchema && requireResolversToMatchSchema !== 'ignore') {
  81. const msg = `${typeName}.${fieldName} defined in resolvers, but not in schema`;
  82. if (requireResolversToMatchSchema === 'error') {
  83. throw new Error(msg);
  84. }
  85. else {
  86. console.error(msg);
  87. }
  88. }
  89. }
  90. else {
  91. // Field present in both the resolver and schema
  92. const fieldResolve = resolverValue[fieldName];
  93. if (typeof fieldResolve !== 'function' && typeof fieldResolve !== 'object') {
  94. throw new Error(`Resolver ${typeName}.${fieldName} must be object or function`);
  95. }
  96. }
  97. }
  98. }
  99. }
  100. }
  101. schema = updateResolversInPlace
  102. ? addResolversToExistingSchema(schema, resolvers, defaultFieldResolver)
  103. : createNewSchemaWithResolvers(schema, resolvers, defaultFieldResolver);
  104. if (requireResolversForResolveType && requireResolversForResolveType !== 'ignore') {
  105. (0, checkForResolveTypeResolver_js_1.checkForResolveTypeResolver)(schema, requireResolversForResolveType);
  106. }
  107. return schema;
  108. }
  109. exports.addResolversToSchema = addResolversToSchema;
  110. function addResolversToExistingSchema(schema, resolvers, defaultFieldResolver) {
  111. const typeMap = schema.getTypeMap();
  112. for (const typeName in resolvers) {
  113. const type = schema.getType(typeName);
  114. const resolverValue = resolvers[typeName];
  115. if ((0, graphql_1.isScalarType)(type)) {
  116. for (const fieldName in resolverValue) {
  117. if (fieldName.startsWith('__')) {
  118. type[fieldName.substring(2)] = resolverValue[fieldName];
  119. }
  120. else if (fieldName === 'astNode' && type.astNode != null) {
  121. type.astNode = {
  122. ...type.astNode,
  123. description: resolverValue?.astNode?.description ??
  124. type.astNode.description,
  125. directives: (type.astNode.directives ?? []).concat(resolverValue?.astNode?.directives ?? []),
  126. };
  127. }
  128. else if (fieldName === 'extensionASTNodes' && type.extensionASTNodes != null) {
  129. type.extensionASTNodes = type.extensionASTNodes.concat(resolverValue?.extensionASTNodes ?? []);
  130. }
  131. else if (fieldName === 'extensions' &&
  132. type.extensions != null &&
  133. resolverValue.extensions != null) {
  134. type.extensions = Object.assign(Object.create(null), type.extensions, resolverValue.extensions);
  135. }
  136. else {
  137. type[fieldName] = resolverValue[fieldName];
  138. }
  139. }
  140. }
  141. else if ((0, graphql_1.isEnumType)(type)) {
  142. const config = type.toConfig();
  143. const enumValueConfigMap = config.values;
  144. for (const fieldName in resolverValue) {
  145. if (fieldName.startsWith('__')) {
  146. config[fieldName.substring(2)] = resolverValue[fieldName];
  147. }
  148. else if (fieldName === 'astNode' && config.astNode != null) {
  149. config.astNode = {
  150. ...config.astNode,
  151. description: resolverValue?.astNode?.description ??
  152. config.astNode.description,
  153. directives: (config.astNode.directives ?? []).concat(resolverValue?.astNode?.directives ?? []),
  154. };
  155. }
  156. else if (fieldName === 'extensionASTNodes' && config.extensionASTNodes != null) {
  157. config.extensionASTNodes = config.extensionASTNodes.concat(resolverValue?.extensionASTNodes ?? []);
  158. }
  159. else if (fieldName === 'extensions' &&
  160. type.extensions != null &&
  161. resolverValue.extensions != null) {
  162. type.extensions = Object.assign(Object.create(null), type.extensions, resolverValue.extensions);
  163. }
  164. else if (enumValueConfigMap[fieldName]) {
  165. enumValueConfigMap[fieldName].value = resolverValue[fieldName];
  166. }
  167. }
  168. typeMap[typeName] = new graphql_1.GraphQLEnumType(config);
  169. }
  170. else if ((0, graphql_1.isUnionType)(type)) {
  171. for (const fieldName in resolverValue) {
  172. if (fieldName.startsWith('__')) {
  173. type[fieldName.substring(2)] = resolverValue[fieldName];
  174. }
  175. }
  176. }
  177. else if ((0, graphql_1.isObjectType)(type) || (0, graphql_1.isInterfaceType)(type)) {
  178. for (const fieldName in resolverValue) {
  179. if (fieldName.startsWith('__')) {
  180. // this is for isTypeOf and resolveType and all the other stuff.
  181. type[fieldName.substring(2)] = resolverValue[fieldName];
  182. continue;
  183. }
  184. const fields = type.getFields();
  185. const field = fields[fieldName];
  186. if (field != null) {
  187. const fieldResolve = resolverValue[fieldName];
  188. if (typeof fieldResolve === 'function') {
  189. // for convenience. Allows shorter syntax in resolver definition file
  190. field.resolve = fieldResolve.bind(resolverValue);
  191. }
  192. else {
  193. setFieldProperties(field, fieldResolve);
  194. }
  195. }
  196. }
  197. }
  198. }
  199. // serialize all default values prior to healing fields with new scalar/enum types.
  200. (0, utils_1.forEachDefaultValue)(schema, utils_1.serializeInputValue);
  201. // schema may have new scalar/enum types that require healing
  202. (0, utils_1.healSchema)(schema);
  203. // reparse all default values with new parsing functions.
  204. (0, utils_1.forEachDefaultValue)(schema, utils_1.parseInputValue);
  205. if (defaultFieldResolver != null) {
  206. (0, utils_1.forEachField)(schema, field => {
  207. if (!field.resolve) {
  208. field.resolve = defaultFieldResolver;
  209. }
  210. });
  211. }
  212. return schema;
  213. }
  214. function createNewSchemaWithResolvers(schema, resolvers, defaultFieldResolver) {
  215. schema = (0, utils_1.mapSchema)(schema, {
  216. [utils_1.MapperKind.SCALAR_TYPE]: type => {
  217. const config = type.toConfig();
  218. const resolverValue = resolvers[type.name];
  219. if (!(0, graphql_1.isSpecifiedScalarType)(type) && resolverValue != null) {
  220. for (const fieldName in resolverValue) {
  221. if (fieldName.startsWith('__')) {
  222. config[fieldName.substring(2)] = resolverValue[fieldName];
  223. }
  224. else if (fieldName === 'astNode' && config.astNode != null) {
  225. config.astNode = {
  226. ...config.astNode,
  227. description: resolverValue?.astNode?.description ??
  228. config.astNode.description,
  229. directives: (config.astNode.directives ?? []).concat(resolverValue?.astNode?.directives ?? []),
  230. };
  231. }
  232. else if (fieldName === 'extensionASTNodes' && config.extensionASTNodes != null) {
  233. config.extensionASTNodes = config.extensionASTNodes.concat(resolverValue?.extensionASTNodes ?? []);
  234. }
  235. else if (fieldName === 'extensions' &&
  236. config.extensions != null &&
  237. resolverValue.extensions != null) {
  238. config.extensions = Object.assign(Object.create(null), type.extensions, resolverValue.extensions);
  239. }
  240. else {
  241. config[fieldName] = resolverValue[fieldName];
  242. }
  243. }
  244. return new graphql_1.GraphQLScalarType(config);
  245. }
  246. },
  247. [utils_1.MapperKind.ENUM_TYPE]: type => {
  248. const resolverValue = resolvers[type.name];
  249. const config = type.toConfig();
  250. const enumValueConfigMap = config.values;
  251. if (resolverValue != null) {
  252. for (const fieldName in resolverValue) {
  253. if (fieldName.startsWith('__')) {
  254. config[fieldName.substring(2)] = resolverValue[fieldName];
  255. }
  256. else if (fieldName === 'astNode' && config.astNode != null) {
  257. config.astNode = {
  258. ...config.astNode,
  259. description: resolverValue?.astNode?.description ??
  260. config.astNode.description,
  261. directives: (config.astNode.directives ?? []).concat(resolverValue?.astNode?.directives ?? []),
  262. };
  263. }
  264. else if (fieldName === 'extensionASTNodes' && config.extensionASTNodes != null) {
  265. config.extensionASTNodes = config.extensionASTNodes.concat(resolverValue?.extensionASTNodes ?? []);
  266. }
  267. else if (fieldName === 'extensions' &&
  268. config.extensions != null &&
  269. resolverValue.extensions != null) {
  270. config.extensions = Object.assign(Object.create(null), type.extensions, resolverValue.extensions);
  271. }
  272. else if (enumValueConfigMap[fieldName]) {
  273. enumValueConfigMap[fieldName].value = resolverValue[fieldName];
  274. }
  275. }
  276. return new graphql_1.GraphQLEnumType(config);
  277. }
  278. },
  279. [utils_1.MapperKind.UNION_TYPE]: type => {
  280. const resolverValue = resolvers[type.name];
  281. if (resolverValue != null) {
  282. const config = type.toConfig();
  283. if (resolverValue['__resolveType']) {
  284. config.resolveType = resolverValue['__resolveType'];
  285. }
  286. return new graphql_1.GraphQLUnionType(config);
  287. }
  288. },
  289. [utils_1.MapperKind.OBJECT_TYPE]: type => {
  290. const resolverValue = resolvers[type.name];
  291. if (resolverValue != null) {
  292. const config = type.toConfig();
  293. if (resolverValue['__isTypeOf']) {
  294. config.isTypeOf = resolverValue['__isTypeOf'];
  295. }
  296. return new graphql_1.GraphQLObjectType(config);
  297. }
  298. },
  299. [utils_1.MapperKind.INTERFACE_TYPE]: type => {
  300. const resolverValue = resolvers[type.name];
  301. if (resolverValue != null) {
  302. const config = type.toConfig();
  303. if (resolverValue['__resolveType']) {
  304. config.resolveType = resolverValue['__resolveType'];
  305. }
  306. return new graphql_1.GraphQLInterfaceType(config);
  307. }
  308. },
  309. [utils_1.MapperKind.COMPOSITE_FIELD]: (fieldConfig, fieldName, typeName) => {
  310. const resolverValue = resolvers[typeName];
  311. if (resolverValue != null) {
  312. const fieldResolve = resolverValue[fieldName];
  313. if (fieldResolve != null) {
  314. const newFieldConfig = { ...fieldConfig };
  315. if (typeof fieldResolve === 'function') {
  316. // for convenience. Allows shorter syntax in resolver definition file
  317. newFieldConfig.resolve = fieldResolve.bind(resolverValue);
  318. }
  319. else {
  320. setFieldProperties(newFieldConfig, fieldResolve);
  321. }
  322. return newFieldConfig;
  323. }
  324. }
  325. },
  326. });
  327. if (defaultFieldResolver != null) {
  328. schema = (0, utils_1.mapSchema)(schema, {
  329. [utils_1.MapperKind.OBJECT_FIELD]: fieldConfig => ({
  330. ...fieldConfig,
  331. resolve: fieldConfig.resolve != null ? fieldConfig.resolve : defaultFieldResolver,
  332. }),
  333. });
  334. }
  335. return schema;
  336. }
  337. function setFieldProperties(field, propertiesObj) {
  338. for (const propertyName in propertiesObj) {
  339. field[propertyName] = propertiesObj[propertyName];
  340. }
  341. }