npmpackage.info

Gathering detailed insights and metrics for @iksena/graphql-constraint-directive

@iksena/graphql-constraint-directive - 1.0.0 | npmpackage.info

@iksena/graphql-constraint-directive

Validate GraphQL fields

1.0.0

ISC

JavaScript

101.40 kB

1.7

Installations

npm install @iksena/graphql-constraint-directive

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>=8.0.0

Node Version

14.15.3

NPM Version

6.14.9 Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Languages

JavaScript

JavaScript (100%)

Developer

iksena

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

ISC License

49 Commits

1 Forks

5 Branches

1 Contributors

Updated on Feb 06, 2021

Maintainers

View All 1 Contributors

Package Meta Information

Latest Version

1.0.0

Package Id

@iksena/graphql-constraint-directive@1.0.0

Unpacked Size

101.40 kB

Size

8.77 kB

File Count

NPM Version

6.14.9

Node Version

14.15.3

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

graphql validator

Dev Dependencies

apollo-server-express express mocha nyc standard supertest

@iksena/graphql-constraint-directive

Allows using @constraint as a directive to validate input data. Inspired by Constraints Directives RFC and OpenAPI
Forked from graphql-constraint-directive to use SchemaDirectiveVisitor and make it compatible with Apollo Federation

Install

npm install @iksena/graphql-constraint-directive

Usage

1const { ConstraintDirective, constraintDirectiveTypeDefs } = require('@iksena/graphql-constraint-directive');
2const express = require('express');
3const { ApolloServer, SchemaDirectiveVisitor, makeExecutableSchema } = require('apollo-server-express');
4const typeDefs = `
5  type Query {
6    books: [Book]
7  }
8  type Book {
9    title: String
10  }
11  type Mutation {
12    createBook(input: BookInput): Book
13  }
14  input BookInput {
15    title: String! @constraint(minLength: 5, format: "email")
16  }
17`;
18const schema = makeExecutableSchema({
19  typeDefs: [constraintDirectiveTypeDefs, typeDefs]
20});
21SchemaDirectiveVisitor.visitSchemaDirectives(schema, {
22  constraint: ConstraintDirective
23});
24const app = express();
25const server = new ApolloServer({ schema });
26
27server.applyMiddleware({ app });
28

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

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.

1{
2  code: 'ERR_GRAPHQL_CONSTRAINT_VALIDATION',
3  fieldName: 'theFieldName',
4  context: [ { arg: 'argument name which failed', value: 'value of argument' } ]
5}

1const formatError = function (error) {
2  if (error.originalError && error.originalError.code === 'ERR_GRAPHQL_CONSTRAINT_VALIDATION') {
3    // return a custom object
4  }
5
6  return error
7}
8
9app.use('/graphql', bodyParser.json(), graphqlExpress({ schema, formatError }))
10

uniqueTypeName

@constraint(uniqueTypeName: "Unique_Type_Name") Override the unique type name generate by the library to the one passed as an argument

No vulnerabilities found.

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.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

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

0

SAST

Determines if the project uses static code analysis.

0

CII-Best-Practices

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

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.7

/10

Last Scanned on 2025-07-07

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