graphql-io-utils

Utilities directives and scalar types to help on graphql input/output validation and sanitization.

Installation

``sh
npm i @winninjs/graphql-io-utils
`

Scalar

$3

Represents a valid email

`graphql
type Query{

email:Email! # Returns a non-null valid Email
sendEmail(email:Email):Email # Send and returns a valid Email
}
`

$3

Represents a valid URL

`graphql
type Query{

url:URL! # Returns a non-null valid URL
sendURL(url:URL):URL # Send and returns a valid URL
}
`

$3

Redacts PII info on string

`graphql
type Query{

piiData:PII! # Returns a redacted PII string
}
`

Directives

It includes two directives:

$3

Lets you run a method over a string input or output

`graphql
type Query{

returnTrimmedAndUpper:String! @stringUtils(stringMethods:["trim","toUpperCase"]) # runs trim and toUpperCase on returned String

sendTrimmedAndLower(trimmedAndLower:String!@stringUtils(stringMethods:["trim","toLowerCase"])):String! # runs trim and toLowerCase on query argument

}
`


$3

Runs common validations over input

`graphql
type Query{
email(value:String! @validate(email:true)):String! #validates if the value is an valid email
}
``

Currently supports the following validations:

- email
- url
- alpha
- alphaNum
- alphaDash
- digits
- ip
- hex
- lt
- lte
- gt
- gte
- stringLengthLT
- stringLengthLTE
- stringLengthGT
- stringLengthGTE
- stringLengthEquals
- notEmpty
- startsWith
- endsWith
- contains
- notContains