vsimko/node-graphql-constraint-lambda

GraphQL 'constraint' directive written in functional programming style

node-graphql-constraint-lambda's Issues

use custom Error class due to `Error(string)` type

something like this

class ConstraintDirectiveError extends Error {
  /** @param {string[]} errors */
  constructor (errors) {
    super("Validation errors")
    this.errors = errors
  }
}

Custom validation, translations

I've followed the link from prisma/prisma#728 and this package looks useful indeed.

A couple of questions though:

1. Can we use custom validation functions?
2. How is it possible to translate the error messages?

With my usecase it is required to customize the error messages with certain fields. E.g. field primaryEmail should have another error message compared with secondaryEmail. So I need to define the error message per field. Maybe this could be implemented with a future version.
Depending on the project, a validation with contains could require a very specific error message as well.

Add rules for arrays and objects validation

Validate array argument. Something like:

type Mutation {
  updateUser(
    id: ID!
    name: String
    emails: [String!]! @constraint(
      minItems: 1,
      maxItems: 3,
      uniqueItems: true,
      format: "email" #applies to all items of array?
    )
  )
}

Validate object argument (useful when argument is an input type). Something like:

type Mutation {
  updateUser(
    data: UserUpdateInput! @constraint(
      name: { minLength: 5, maxLength: 40 },
      email: { format: "email" },
      age: { min: 18, max: 100 }
    )
    where: UserWhereUniqueInput!
  ): User!
}

input UserUpdateInput {
  name: String
  email: String
  age: Int
  verified: Boolean
}

Add support of INPUT_FIELD_DEFINITION location

Currently, @constraint supports only ARGUMENT_DEFINITION directive location.

Problem: e.g. Prisma extracts all query/mutation arguments to separate input types when generates schema from datamodel.

Please add support of INPUT_FIELD_DEFINITION location to be able to apply @constraint to input type fields. E.g.:

type User {
  name: String
  phone: String
  email: String
  ...
}

...

type Mutation {
  createUser(data: UserCreateInput!): User!
  updateUser(data: UserUpdateInput!, where: UserWhereUniqueInput!): User!
  deleteUser(where: UserWhereUniqueInput!): User
  ...
}

...

input UserUpdateInput {
  name: String
  phone: String
  email: String @constraint(format:"email")
  ...
}

peerDependencies vs dependencies

for "graphql"

Add support of logical operations

Please add support of logical (boolean) operations (AND, OR and NOT) for combining rules inside directive.

I'm personally interested in OR combinator.

See the rationale, use cases, syntax ideas, etc. here: confuser/graphql-constraint-directive#13.

Apollo server 2.x

Seem not work with apollo server 2.x

I config like document but not return any error

schema.graphql

directive @constraint(
  minLength: Int
  maxLength: Int
  startsWith: String
  endsWith: String
  contains: String
  notContains: String
  pattern: String
  format: String
  differsFrom: String
  min: Float
  max: Float
  exclusiveMin: Float
  exclusiveMax: Float
  notEqual: Float
) on ARGUMENT_DEFINITION

category.grapqhl

type Query {
  category(id: ID!): Category
  categories(
    where: JSON
    limit: Float @constraint(min: 1, max: 10)
    offset: Int
    order: String
  ): [Category!]
  categoriesConnection(
    where: JSON
    first: Int!
    last: Int
    after: String
    before: String
  ): CategoryConnection!
}

import { resolver, createConnectionResolver } from 'graphql-sequelize'

export default {
  category: resolver((parent, args, context, info) => context.models.Category),

  categories: resolver((parent, args, context, info) => context.models.Category),

  categoriesConnection: createConnectionResolver({
    target: (parent, args, context, info) => context.models.Category,
    where: (findOptions, args) => args
  }).resolveConnection
}

my query in playground

query{
 	categories(limit: 15){
    id
    name
  }
}

and graphql still return right data not validate limit arg