93 lines
3.3 KiB
JavaScript
93 lines
3.3 KiB
JavaScript
import { buildASTSchema, buildSchema, isSchema } from 'graphql';
|
|
import { asArray, pruneSchema } from '@graphql-tools/utils';
|
|
import { addResolversToSchema } from './addResolversToSchema.js';
|
|
import { assertResolversPresent } from './assertResolversPresent.js';
|
|
import { applyExtensions, mergeExtensions, mergeResolvers, mergeTypeDefs } from '@graphql-tools/merge';
|
|
/**
|
|
* Builds a schema from the provided type definitions and resolvers.
|
|
*
|
|
* The type definitions are written using Schema Definition Language (SDL). They
|
|
* can be provided as a string, a `DocumentNode`, a function, or an array of any
|
|
* of these. If a function is provided, it will be passed no arguments and
|
|
* should return an array of strings or `DocumentNode`s.
|
|
*
|
|
* Note: You can use `graphql-tag` to not only parse a string into a
|
|
* `DocumentNode` but also to provide additional syntax highlighting in your
|
|
* editor (with the appropriate editor plugin).
|
|
*
|
|
* ```js
|
|
* const typeDefs = gql`
|
|
* type Query {
|
|
* posts: [Post]
|
|
* author(id: Int!): Author
|
|
* }
|
|
* `;
|
|
* ```
|
|
*
|
|
* The `resolvers` object should be a map of type names to nested object, which
|
|
* themselves map the type's fields to their appropriate resolvers.
|
|
* See the [Resolvers](/docs/resolvers) section of the documentation for more details.
|
|
*
|
|
* ```js
|
|
* const resolvers = {
|
|
* Query: {
|
|
* posts: (obj, args, ctx, info) => getAllPosts(),
|
|
* author: (obj, args, ctx, info) => getAuthorById(args.id)
|
|
* }
|
|
* };
|
|
* ```
|
|
*
|
|
* Once you've defined both the `typeDefs` and `resolvers`, you can create your
|
|
* schema:
|
|
*
|
|
* ```js
|
|
* const schema = makeExecutableSchema({
|
|
* typeDefs,
|
|
* resolvers,
|
|
* })
|
|
* ```
|
|
*/
|
|
export function makeExecutableSchema({ typeDefs, resolvers = {}, resolverValidationOptions = {}, parseOptions = {}, inheritResolversFromInterfaces = false, pruningOptions, updateResolversInPlace = false, schemaExtensions, }) {
|
|
// Validate and clean up arguments
|
|
if (typeof resolverValidationOptions !== 'object') {
|
|
throw new Error('Expected `resolverValidationOptions` to be an object');
|
|
}
|
|
if (!typeDefs) {
|
|
throw new Error('Must provide typeDefs');
|
|
}
|
|
let schema;
|
|
if (isSchema(typeDefs)) {
|
|
schema = typeDefs;
|
|
}
|
|
else if (parseOptions === null || parseOptions === void 0 ? void 0 : parseOptions.commentDescriptions) {
|
|
const mergedTypeDefs = mergeTypeDefs(typeDefs, {
|
|
...parseOptions,
|
|
commentDescriptions: true,
|
|
});
|
|
schema = buildSchema(mergedTypeDefs, parseOptions);
|
|
}
|
|
else {
|
|
const mergedTypeDefs = mergeTypeDefs(typeDefs, parseOptions);
|
|
schema = buildASTSchema(mergedTypeDefs, parseOptions);
|
|
}
|
|
if (pruningOptions) {
|
|
schema = pruneSchema(schema);
|
|
}
|
|
// We allow passing in an array of resolver maps, in which case we merge them
|
|
schema = addResolversToSchema({
|
|
schema,
|
|
resolvers: mergeResolvers(resolvers),
|
|
resolverValidationOptions,
|
|
inheritResolversFromInterfaces,
|
|
updateResolversInPlace,
|
|
});
|
|
if (Object.keys(resolverValidationOptions).length > 0) {
|
|
assertResolversPresent(schema, resolverValidationOptions);
|
|
}
|
|
if (schemaExtensions) {
|
|
schemaExtensions = mergeExtensions(asArray(schemaExtensions));
|
|
applyExtensions(schema, schemaExtensions);
|
|
}
|
|
return schema;
|
|
}
|