Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexsedeke/apollo-server-constraint-directive
Check the GraphQL input fields with directives
https://github.com/alexsedeke/apollo-server-constraint-directive
Last synced: 2 months ago
JSON representation
Check the GraphQL input fields with directives
- Host: GitHub
- URL: https://github.com/alexsedeke/apollo-server-constraint-directive
- Owner: alexsedeke
- License: isc
- Created: 2020-01-15T22:19:26.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T02:27:44.000Z (about 2 years ago)
- Last Synced: 2024-09-18T07:21:53.764Z (4 months ago)
- Language: JavaScript
- Size: 1.5 MB
- Stars: 13
- Watchers: 1
- Forks: 1
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# apollo-server-constraint-directive
[](https://codecov.io/gh/alexanderVu/apollo-server-constraint-directive)
[](https://snyk.io/test/github/alexanderVu/apollo-server-constraint-directive?targetFile=package.json)
Allows using @constraint as a directive to validate input and output data. This module is for [*Apollo Server*](https://www.apollographql.com/docs/apollo-server/getting-started/), and support the latest [Apollo Server](https://www.apollographql.com/) version 2.
It is mainly based on the module from [graphql-constraint-directive](https://github.com/confuser/graphql-constraint-directive), which is for Apollo version 1 only.
This module is an Inspired by [Constraints Directives RFC](https://github.com/APIs-guru/graphql-constraints-spec) and OpenAPI
If you are looking for a playground checkout this project [apollo-server-playground](https://github.com/alexanderVu/apollo-server-playground).
## Install
```bash
npm install apollo-server-constraint-directive
```
## Usage
```js
const { ApolloServer, makeExecutableSchema, gql } = require('apollo-server')
const ConstraintDirective = require('apollo-server-constraint-directive')
const schemaDirectives = {
constraint: ConstraintDirective,
};
const typeDefs = gql`
scalar ValidateString
scalar ValidateNumber
directive @constraint(
# String constraints
minLength: Int
maxLength: Int
startsWith: String
endsWith: String
notContains: String
pattern: String
format: String
# Number constraints
min: Int
max: Int
exclusiveMin: Int
exclusiveMax: Int
multipleOf: Int
) on INPUT_FIELD_DEFINITION
type Query {
books: [Book]
}
type Book {
title: String
}
type Mutation {
createBook(input: BookInput): Book
}
input BookInput {
title: String! @constraint(minLength: 5, format: "email")
}`
// The ApolloServer constructor
const server = new ApolloServer({
schema: makeExecutableSchema({ typeDefs, schemaDirectives })
})
// The `listen` method launches a web server.
server.listen().then(({ url }) => {
console.log(`🚀 Server ready at ${url}`)
})
```
## API
### String
#### minLength
```@constraint(minLength: 5)```
Restrict to a minimum length
#### maxLength
```@constraint(maxLength: 5)```
Restrict to a maximum length
#### startsWith
```@constraint(startsWith: "foo")```
Ensure value starts with foo
#### endsWith
```@constraint(endsWith: "foo")```
Ensure value ends with foo
#### contains
```@constraint(contains: "foo")```
Ensure value contains foo
#### notContains
```@constraint(notContains: "foo")```
Ensure value does not contain foo
#### pattern
```@constraint(pattern: "^[0-9a-zA-Z]*$")```
Ensure value matches regex, e.g. alphanumeric
#### format
```@constraint(format: "email")```
Ensure value is in a particular format
Supported formats:
- byte: Base64
- date-time: RFC 3339
- date: ISO 8601
- email
- ipv4
- ipv6
- uri
- uuid
#### password strength
```@constraint(passwordScore: 3)```
Ensure password value has estimated strength. [zxcvbn](https://github.com/dropbox/zxcvbn) is used under the hood. Possible strength values are between 1 and 5. Heigher is better
### Int/Float
#### min
```@constraint(min: 3)```
Ensure value is greater than or equal to
#### max
```@constraint(max: 3)```
Ensure value is less than or equal to
#### exclusiveMin
```@constraint(exclusiveMin: 3)```
Ensure value is greater than
#### exclusiveMax
```@constraint(exclusiveMax: 3)```
Ensure value is less than
#### multipleOf
```@constraint(multipleOf: 10)```
Ensure value is a multiple
### ConstraintDirectiveError
Each validation error throws a `ConstraintDirectiveError`. Combined with a formatError function, this can be used to customise error messages.
```js
{
code: 'ERR_GRAPHQL_CONSTRAINT_VALIDATION',
fieldName: 'theFieldName',
context: [ { arg: 'argument name which failed', value: 'value of argument' } ]
}
```
```js
const formatError = function (error) {
if (error.originalError && error.originalError.code === 'ERR_GRAPHQL_CONSTRAINT_VALIDATION') {
// return a custom object
}
return error
}
const apollo = new ApolloServer({
schema: makeExecutableSchema({ typeDefs, schemaDirectives }),
formatError
});
```