codegen-graphql-yup v1.0.4

GRAPHQL SCHEMA TO YUP SCHEMA

The reason for this project is to maintain a single source of truth, between graphql and yup.

Configs

• defaultRequiredMessage: string, this message is overwrited if you use requeridMessage in the directive.
• onlyWithConstrain: boolean ( default false) If you want to generate an schema for all your input objects definitions with or without the directive put it in true.

You can use this pluggin de dos formas distintas

Simple use

If you only want to validate the required fields, what you can do is use the plugin in the following way

generates:
  schemas.ts:
    plugins:
      - codegen-graphql-yup:
          defaultRequiredMessage: "You can put it or not"

Full Use

If you need more validations than only required fields, you have to follow this steps.

this is because in graphql instrospection we dont have access to directives

1. Add the directive in your schema.

2. Generate a file, the result of merge of all schemas. Example:

   import path from 'path';
   import fs from 'fs';
   const mergeGraphqlSchemas = require('merge-graphql-schemas');
   
   const { fileLoader } = mergeGraphqlSchemas;
   const { mergeTypes } = mergeGraphqlSchemas;
   
   const types = fileLoader(path.join(__dirname, '/entities/**/*.graphql'));
   
   const mt = mergeTypes(types, { all: true });
   
   try {
       fs.writeFileSync('./result.graphql', mt);
   } catch (error) { }
   
   export default mt;

3. In codegen.yml config use that file like schema.

Directive Schema

directive @constraint(
  pattern: String
  min: Int
  max: Int
  requiredMessage: String
  typeOf: String
) on INPUT_FIELD_DEFINITION | ARGUMENT_DEFINITION

Example

result.graphql

directive @constraint(
  pattern: String
  min: Int
  max: Int
  requiredMessage: String
  typeOf: String
) on INPUT_FIELD_DEFINITION | ARGUMENT_DEFINITION

input TestInput {
  something: String!
}

input RegisterAddressInput {
  postalCode: TestInput! @constraint(requiredMessage: "It field have custom message.")
  state: [String]!
  city: String!
  someNumber: Int @constraint(min: 10, max: 20)
  someNumberFloat: Float @constraint(min: 10.50, max: 20.50)
  someBoolean: Boolean
  line2: String @constraint(min: 10, max: 20)
}

codegen.yml

overwrite: true
schema: "./result.graphql"
generates:
  schemas.ts:
    plugins:
      - codegen-graphql-yup:
          defaultRequiredMessage: "This field have generic message"
          onlyWithConstrain: false

schemas.ts ( THE RESULT )

import * as yup from 'yup'

export const TestInputSchema = yup.object().shape({
    something: yup.string().required('This field have generic message')
});

export const RegisterAddressInputSchema = yup.object().shape({
    postalCode: TestInputSchema.required('It field have custom message.'),
    state: yup.arrayOf(yup.string()).required('This field have generic message'),
    city: yup.string().required('This field have generic message'),
    someNumber: yup.number().min(10).max(20),
    someNumberFloat: yup.number().min(10.5).max(20.5),
    someBoolean: yup.boolean(),
    line2: yup.string().min(10).max(20)
})

COLABORATE

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

You will need to install:

Node

npm

type script

You will need to have:

an schema from graphql. or use the default.

Installing

The steps to use this pluggin are:

Clone the project

npm install

npm run generate

Author

• Matias Martinez
• BeFish
• Nemac