yup-to-json-schema

Yup is a library to validate the JSON input

JSON-Schema is a schema specification for JSON

NOTE : Upgraded to support Yup Version 1 Version Maping

Yup Major Version	This Library Major Version	Branch in this Library
1	2	main
0	1	yup_v0

This library converts Yup schema to JSON-Schema

Installation

npm i @sodaru/yup-to-json-schema

Usage

Convert YUP to JSON-SCHEMA

1import { object, string, array, tuple, date, boolean, number } from 'yup';
2import { convertSchema } from '@sodaru/yup-to-json-schema';
3
4const schema = object({
5  name: string().label('Name').required(),
6  address: tuple([string(), string()]).label('Address'),
7  hobbies: array(string()).min(1).label('Hobbies'),
8  birthdate: date().label('Birthdate'),
9  admin: boolean().label('Admin'),
10  rank: number().integer().positive().label('Rank')
11});
12
13const jsonSchema = convertSchema(schema);
14
15assert(jsonSchema).toEqual({
16  type: 'object',
17  required: ['name']
18  properties: {
19    name: {
20      type: 'string',
21      title: 'Name'
22    },
23    address: {
24      type: 'array',
25      title: 'Address',
26      minItems: 2,
27      maxItems: 2,
28      items: [
29        {
30          type: 'string'
31        },
32        {
33          type: 'string'
34        }
35      ]
36    },
37    hobbies: {
38      type: 'array',
39      title: 'Hobbies',
40      items: {
41        type: 'string'
42      },
43      minItems: 1
44    },
45    birthdate: {
46      type: 'string',
47      title: 'Birthdate',
48      format: 'date-time'
49    },
50    admin: {
51      type: 'boolean',
52      title: 'Admin'
53    },
54    rank: {
55      type: 'integer',
56      title: 'Rank',
57      exclusiveMinimum: 0
58    }
59  }
60});

Provide additional Schema as meta property in Yup

Add additional JSON Schema information to the jsonSchema property via the meta() method. This will be shallow merged with the result of the conversion.

1const schema = object({ ... }).meta({
2  jsonSchema: {
3    $id: '...'
4    description: '...'
5  }
6});

extend the schema

You can also use the extendSchema to add helpful methods to all of your yup schemas. Use the example, examples, description, and jsonSchema methods to add common proprties to your JSON Schemas.

1import {
2  object,
3  string,
4  array,
5  tuple,
6  date,
7  boolean,
8  number,
9  addMethod,
10  Schema
11} from 'yup';
12import { extendSchema, convertSchema } from '@sodaru/yup-to-json-schema';
13
14extendSchema({ addMethod, Schema });
15
16const schema = object({
17  name: string()
18    .label('Name')
19    .description('Your first name')
20    .example('Johnny Cash')
21    .required(),
22  address: tuple([string(), string()])
23    .label('Address')
24    .description('Your Address')
25    .example(['Nashville', 'TN']),
26  hobbies: array(string())
27    .label('Hobbies')
28    .min(1)
29    .description('Your hobbies')
30    .example(['Guitar', 'Singing']),
31  birthdate: date()
32    .label('Birthdate')
33    .description('Your birthdate')
34    .example(new Date('February 26, 1932')),
35  admin: boolean()
36    .label('Admin')
37    .description('Use is an admin')
38    .example(true),
39  rank: number()
40    .label('Rank')
41    .description('Your rank')
42    .jsonSchema((jsonSchema) => {
43      return {
44        ...jsonSchema,
45        testProp: true
46      };
47    })
48    .example(27)
49    .integer()
50    .positive()
51});
52
53const jsonSchema = convertSchema(schema);
54
55jsonSchema = {
56  type: 'object',
57  required: ['name']
58  properties: {
59    name: {
60      type: 'string',
61      title: 'Name',
62      description: 'Your first name',
63      example: 'Johnny Cash'
64    },
65    address: {
66      type: 'array',
67      title: 'Address',
68      description: 'Your Address',
69      example: ['Nashville', 'TN'],
70      minItems: 2,
71      maxItems: 2,
72      items: [
73        {
74          type: 'string'
75        },
76        {
77          type: 'string'
78        }
79      ]
80    },
81    hobbies: {
82      type: 'array',
83      title: 'Hobbies',
84      items: {
85        type: 'string'
86      },
87      minItems: 1,
88      description: 'Your hobbies',
89      example: ['Guitar', 'Singing']
90    },
91    birthdate: {
92      type: 'string',
93      title: 'Birthdate',
94      format: 'date-time',
95      description: 'Your birthdate',
96      example: '1932-02-26T06:00:00.000Z'
97    },
98    admin: {
99      type: 'boolean',
100      title: 'Admin',
101      description: 'User is an admin',
102      example: true
103    },
104    rank: {
105      type: 'integer',
106      title: 'Rank',
107      exclusiveMinimum: 0,
108      description: 'Your rank',
109      testProp: true,
110      example: 27
111    }
112  }
113};

Provide the data using the ResolveOptions for when and lazy

Use the second argument ResolveOptions to pass context to allow for better when and lazy methods. This argument is passed to the underlying describe(options)

1import { object, number } from "yup";
2import { convertSchema } from "@sodaru/yup-to-json-schema";
3
4const schema = object({
5  rank: number().when(["name"], ([name], schema) => {
6    return name === "Johnny Cash" ? schema.min(100) : schema.min(0);
7  })
8});
9
10const schema = object({
11  rank: lazy(({ name }) => {
12    return name === "Johnny Cash" ? number().min(100) : number().min(0);
13  })
14});
15
16const jsonSchema = convertSchema(schema, {
17  value: { name: "Johnny Cash", rank: 100 }
18});
19
20jsonSchema = {
21  type: "object",
22  properties: {
23    rank: {
24      type: "number",
25      minimum: 100
26    }
27  }
28};

Contribution

Fork the repo and send the Pull Requests to develop branch

develop is merged to the main branch periodically to make a release

Support

This project is a part of the Open Source Initiative from Sodaru Technologies

Write an email to opensource@sodaru.com for queries on this project