Required field in schema gets type 'string | undefined'

[jwasnoggin]

I'm trying to validate an input and assign it to a variable of a type that I've defined. All fields are required in the validator. However, when I try to assign the validated input I get this error:

Type 'ObjectFromSchema<{ prop1: { type: "string"; required: true; }; }, never>' is not assignable to type 'Body'.
  Types of property 'prop1' are incompatible.
    Type 'string | undefined' is not assignable to type 'string'.
      Type 'undefined' is not assignable to type 'string'.ts(2322)

Since the attribute prop1 is required, why is it showing as possibly undefined?

Demonstration code (the error is at the line which says const validBody: Body = body;):

import validator from 'is-my-json-valid';

type Body = { prop1: string };

function validateBody(body: any): Body {
    const bodyValidator = validator({
        type: 'object',
        required: true,
        properties: {
            prop1: {
                type: 'string',
                required: true as true
            }
        }
    });

    if (!bodyValidator(body)) {
        throw new Error('Invalid format: ' + bodyValidator.errors);
    }

    const validBody: Body = body;
    return validBody;
}

This is with is-my-json-valid version 2.20.5 and Typescript version 4.3.5, with "strict": true

[LinusU]

Ah, required: true is deprecated, the new way is:

    const bodyValidator = validator({
        type: 'object',
-       required: true,
+       required: ['prop1'],
        properties: {
            prop1: {
                type: 'string',
-               required: true as true
            }
        }
    })

We should update all the examples in the readme!

[jwasnoggin]

Amazing, that's much better.

Definitely should update the readme!

[jwasnoggin]

I've now got a similar issue with a slightly more complex validator which has nested objects.

Error:

Type 'ObjectFromSchema<{ StringProp: { type: "string"; }; ObjectProp: { type: "object"; required: string[]; properties: { Label: { type: "string"; }; }; }; }, "StringProp" | "ObjectProp">' is not assignable to type 'Body'.
  The types of 'ObjectProp.Label' are incompatible between these types.
    Type 'string | undefined' is not assignable to type 'string'.
      Type 'undefined' is not assignable to type 'string'.

Code:

import jsonValidator from 'is-my-json-valid';

type Body = { StringProp: string, ObjectProp: { Label: string } };

function validateBody(body: any): Body {
    const bodyValidator = jsonValidator({
        type: 'object',
        required: ['StringProp', 'ObjectProp'],
        properties: {
            StringProp: { type: 'string' },
            ObjectProp: {
                type: 'object',
                required: ['Label'],
                properties: {
                    Label: { type: 'string' }
                }
            }
        }
    });

    if (!bodyValidator(body)) {
        throw new Error('Invalid format: ' + bodyValidator.errors);
    }

    const validBody: Body = body;
    return validBody;
}

[LinusU]

Hmmm, for some reason it seems like the required field on ObjectProp is getting typed as the generic string[] instead of ['Label']...

Could you try to make the following change and see if it fixes it:

    const bodyValidator = jsonValidator({
        type: 'object',
        required: ['StringProp', 'ObjectProp'],
        properties: {
            StringProp: { type: 'string' },
            ObjectProp: {
                type: 'object',
-               required: ['Label'],
+               required: ['Label'] as const,
                properties: {
                    Label: { type: 'string' }
                }
            }
        }
    });

[jwasnoggin]

Same error message, except that required: string[] is now required: readonly ["Label"]

[jwasnoggin]

Got it to work using required: ['Label' as const]. I guess that's a reasonable workaround, if not immediately obvious.

Note this also works for objects with multiple properties, eg

{
    type: 'object',
    properties: {
        name: { type: 'string' },
        value: { type: 'number' }
    },
    required: ['name' as const, 'value' as const]
}