sodaru / yup-to-json-schema Goto Github PK

HI Team,

I am trying to get the below Json format

"RegistrationNumber": {
"type": "string",
"when": {
"SearchRegoOrManual": { "is": "RegistrationNumber", "then": { "required": true } },
},
}

by using yup.string().when("SearchRegoOrManual", {is: "RegistrationNumber". then : yup.number().required() })

but in the output we are getting the expected output.

Please help

I've got working version of support for Yup V1 on my forked repo that I plan to open a PR for soon. This is a full rewrite and may require a major version. I actually got a few PR's merged in Yup specifically for this case. See : jquense/yup#1887

• Supports nullable()
• Support for the new getDefault()
• Better required() support with how Yup V1 changed. It now has an optional flag instead of relying on the tests array.
• General cleanup and type improvements.
• Relies solely on the result of describe() instead of digging around in schema internals
• Various other bug fixes and improvements found along the way.

PR coming soon!

It would be helpful if the metadata helper merged additional properties onto the JSON Schema. https://github.com/sodaru/yup-to-json-schema/blob/main/src/converters/commonMetadata.ts should be updated to merge shape.spec.meta.jsonSchema properties onto the jsonSchema.
For example

if (shape.spec.meta?.jsonSchema) {
  Object.assign(jsonSchema, shape.spec.meta.jsonSchema);
}

This would allow the user to pass any arbitrary keys to .meta({ jsonSchema: { ... } }) which would allow them to customize this library while still keeping the library JSON Schema compliant.

I am using Swagger to create a docs website. Swagger supports the example and examples keywords, even though example is no longer valid. With this update, I could still use example with the following:

yup.object({
  name: yup.string().meta({ jsonSchema: { example: 'DaddyWarbucks' } })
})

is any field item is pending?

expected

jsonSchema.meta = shape.spec.meta