npmpackage.info

@graphql-tools/load

🔧 Utility library for GraphQL to build, stitch and mock GraphQL schemas in the SDL-first approach

8.0.6

5,354

MIT

TypeScript

593,532,459 5.5

Installations

npm install @graphql-tools/load

Pull Requests

Open

38

Total

5,181

Closed

392

Merged

4,751

Issues

Open

137

Total

1,265

Closed

1,128

Releases

1,428

November 27, 2024

release-1732735109178

Published on 27 Nov 2024

November 22, 2024

release-1732269407946

Published on 22 Nov 2024

November 13, 2024

release-1731509960802

Published on 13 Nov 2024

November 08, 2024

release-1731080717646

Published on 08 Nov 2024

November 01, 2024

release-1730468946128

Published on 01 Nov 2024

October 31, 2024

release-1730380473863

Published on 31 Oct 2024

View all 1,428 releases

Developer

ardatan

Developer Guide

BETA

Module System

ESM

Min. Node Version

>=16.0.0

Typescript Support

No

Node Version

22.11.0

NPM Version

10.9.0 Statistics

5,354 Stars

6,176 Commits

818 Forks

78 Watching

30 Branches

384 Contributors

Updated on 27 Nov 2024

Languages

TypeScript (90.74%)

MDX (8.17%)

JavaScript (1.07%)

Shell (0.02%)

Total Downloads

Cumulative downloads

Total Downloads

593,532,459

Last day

-1.8%

850,995

Compared to previous day

Last week

5.5%

4,412,932

Compared to previous week

Last month

12.4%

18,011,985

Compared to previous month

Last year

8.3%

191,828,224

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@graphql-tools/schema @graphql-tools/utils p-limit tslib

Peer Dependencies

graphql

Versions

This package provides a few useful ways to create a GraphQL schema:

Use the GraphQL schema language to generate a schema with full support for resolvers, interfaces, unions, and custom scalars. The schema produced is completely compatible with GraphQL.js.
Mock your GraphQL API with fine-grained per-type mocking
Automatically stitch multiple schemas together into one larger API

Documentation

Read the docs.

Binding to HTTP

If you want to bind your JavaScript GraphQL schema to an HTTP server, you can use GraphQL Yoga .

You can develop your JavaScript based GraphQL API with graphql-tools and GraphQL Yoga together: One to write the schema and resolver code, and the other to connect it to a web server.

Example

When using graphql-tools, you describe the schema as a GraphQL type language string:

1const typeDefs = /* GraphQL */ `
2  type Author {
3    id: ID! # the ! means that every author object _must_ have an id
4    firstName: String
5    lastName: String
6    """
7    the list of Posts by this author
8    """
9    posts: [Post]
10  }
11
12  type Post {
13    id: ID!
14    title: String
15    author: Author
16    votes: Int
17  }
18
19  # the schema allows the following query:
20  type Query {
21    posts: [Post]
22  }
23
24  # this schema allows the following mutation:
25  type Mutation {
26    upvotePost(postId: ID!): Post
27  }
28
29  # we need to tell the server which types represent the root query
30  # and root mutation types. We call them RootQuery and RootMutation by convention.
31  schema {
32    query: Query
33    mutation: Mutation
34  }
35`
36
37export default typeDefs

Then you define resolvers as a nested object that maps type and field names to resolver functions:

1const resolvers = {
2  Query: {
3    posts() {
4      return posts
5    }
6  },
7  Mutation: {
8    upvotePost(_, { postId }) {
9      const post = find(posts, { id: postId })
10      if (!post) {
11        throw new Error(`Couldn't find post with id ${postId}`)
12      }
13      post.votes += 1
14      return post
15    }
16  },
17  Author: {
18    posts(author) {
19      return filter(posts, { authorId: author.id })
20    }
21  },
22  Post: {
23    author(post) {
24      return find(authors, { id: post.authorId })
25    }
26  }
27}
28
29export default resolvers

At the end, the schema and resolvers are combined using makeExecutableSchema:

1import { makeExecutableSchema } from '@graphql-tools/schema'
2
3const executableSchema = makeExecutableSchema({
4  typeDefs,
5  resolvers
6})

GraphQL-Tools schema can be consumed by frameworks like GraphQL Yoga, Apollo GraphQL or express-graphql For example in Node.js;

1const { createYoga } = require('graphql-yoga')
2const { createServer } = require('http')
3
4const yoga = createYoga({
5  schema: executableSchema
6})
7
8const server = createServer(yoga)
9
10server.listen(4000, () => {
11  console.log('Yoga is listening at http://localhost:4000/graphql')
12})

You can check GraphQL Yoga for other JavaScript platforms and frameworks besides vanilla Node.js HTTP.

This example has the entire type definition in one string and all resolvers in one file, but you can combine types and resolvers from multiple files and objects, as documented in the modularizing type definitions and merging resolvers section of the docs.

Contributions

Contributions, issues and feature requests are very welcome. If you are using this package and fixed a bug for yourself, please consider submitting a PR!

And if this is your first time contributing to this project, please do read our Contributor Workflow Guide before you get started off.

Code of Conduct

Help us keep GraphQL Tools open and inclusive. Please read and follow our Code of Conduct as adopted from Contributor Covenant

Maintainers

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Security-Policy

Determines if the project has published a security policy.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

9

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

1

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 1

Details

Warn: third-party GitHubAction not pinned by hash: .github/workflows/tests.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/ardatan/graphql-tools/tests.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/tests.yml:69: update your workflow using https://app.stepsecurity.io/secureworkflow/ardatan/graphql-tools/tests.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/tests.yml:99: update your workflow using https://app.stepsecurity.io/secureworkflow/ardatan/graphql-tools/tests.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests.yml:108: update your workflow using https://app.stepsecurity.io/secureworkflow/ardatan/graphql-tools/tests.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/tests.yml:121: update your workflow using https://app.stepsecurity.io/secureworkflow/ardatan/graphql-tools/tests.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/tests.yml:134: update your workflow using https://app.stepsecurity.io/secureworkflow/ardatan/graphql-tools/tests.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/tests.yml:138: update your workflow using https://app.stepsecurity.io/secureworkflow/ardatan/graphql-tools/tests.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/tests.yml:142: update your workflow using https://app.stepsecurity.io/secureworkflow/ardatan/graphql-tools/tests.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/tests.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/ardatan/graphql-tools/tests.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/website.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/ardatan/graphql-tools/website.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/website.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/ardatan/graphql-tools/website.yml/master?enable=pin
Info: 6 out of 7 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 10 third-party GitHubAction dependencies pinned

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

Score

5.5

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to @graphql-tools/load

@graphql-tools/executor

1.3.4

Fork of GraphQL.js' execute function

@graphql-tools/optimize

2.0.0

A set of utils for faster development of GraphQL tools

graphql-config

5.1.3

The easiest way to configure your development environment with your GraphQL schema (supported by most tools, editors & IDEs)

@graphql-tools/webpack-loader

7.0.0

A set of utils for faster development of GraphQL tools