Coerce function with anyOf sub-schemas

[nokome]

When using Encoda to generate documentation for Schema, @beneboy and I have noticed the followed error message (here replicated using the CLI):

./encoda coerce test.json --from json -

🚨 ERROR encoda /content/1 should have required property 'content'
  Error: /content/1 should have required property 'content'

where test.json is

{
  "type": "Paragraph",
  "content": [
    "The following content has extra ",
    {
      "type": "Emphasis",
      "content": ["emphasis"]
    },
    "."
  ]
}

I turns out that this is related to what is referred to as a bug here:

encoda/src/util/__tests__/util.test.ts

Lines 264 to 284 in 2c7dca6

	it('currently has a bug with arrays using anyOf', async () => {
	const article = await coerce(
	{
	title: 'Untitled',
	authors: [
	{
	givenNames: ['Joe']
	},
	{
	// Even though we explicitly state that this is an
	// `Organization`, `legalName` gets dropped because
	// Ajv sees it as an additional property for `Person`
	// This is a bug in Ajv.
	type: 'Organization',
	name: 'Example Uni',
	legalName: 'Example University Inc.'
	}
	]
	},
	'Article'
	)

But which is apparently not a bug, but rather expected behaviour from using Ajv's removeAdditional: true option:

• https://ajv.js.org/faq.html
• 【BUG】removeAdditional will remove the valid properties ajv-validator/ajv#264

The proposed solution to this is to not use the removeAdditional option - which will mean coerce will coerce what it can but will not cause the loss of any data - which is probably consistent with our approach elsewhere. If users want to persist additional data then the best place to put that is in Enity.meta

[stencila-ci]

🎉 This issue has been resolved in version 0.62.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀