Bugs with yup v1 and arrays of non nullable

[erwan-joly]

It seems like their is some issues with array and nullable types

export function UpdateAssessmentInputSchema(): yup.ObjectSchema<UpdateAssessmentInput> {
    return yup.object({
        answers: yup.array(yup.lazy(() => QuestionAnswerInputSchema().nonNullable())).defined(),
        domainIndex: yup.number().defined().nonNullable(),
        encodedId: yup.string().defined().nonNullable(),
        groupIndex: yup.number().defined().nonNullable(),
        previous: yup.boolean().defined().nonNullable(),
        save: yup.boolean().defined().nonNullable()
    })
}

export type UpdateAssessmentInput = {
  answers: Array<QuestionAnswerInput>;
  domainIndex: Scalars['Int'];
  encodedId: Scalars['String'];
  groupIndex: Scalars['Int'];
  previous: Scalars['Boolean'];
  save: Scalars['Boolean'];
};

export function QuestionAnswerInputSchema(): yup.ObjectSchema<QuestionAnswerInput> {
    return yup.object({
        answer: yup.string().defined().nullable().optional(),
        index: yup.number().defined().nonNullable(),
        multichoiceAnswers: yup.array(yup.string().defined().nonNullable()).defined()
    })
}

Results in this error:

Error	TS2322	(TS) Type 'ObjectSchema<{ answers: { answer?: string; index?: number; multichoiceAnswers?: string[]; }[]; domainIndex: number; encodedId: string; groupIndex: number; previous: boolean; save: boolean; }, AnyObject, { ...; }, "">' is not assignable to type 'ObjectSchema<UpdateAssessmentInput, AnyObject, any, "">'.
  The types of 'default(...).fields.answers' are incompatible between these types.
    Type 'Reference<unknown> | ISchema<{ answer?: string; index?: number; multichoiceAnswers?: string[]; }[], AnyObject, any, any>' is not assignable to type 'Reference<unknown> | ISchema<QuestionAnswerInput[], AnyObject, any, any>'.
      Type 'ISchema<{ answer?: string; index?: number; multichoiceAnswers?: string[]; }[], AnyObject, any, any>' is not assignable to type 'Reference<unknown> | ISchema<QuestionAnswerInput[], AnyObject, any, any>'.
        Type 'ISchema<{ answer?: string; index?: number; multichoiceAnswers?: string[]; }[], AnyObject, any, any>' is not assignable to type 'ISchema<QuestionAnswerInput[], AnyObject, any, any>'.
          Type '{ answer?: string; index?: number; multichoiceAnswers?: string[]; }[]' is not assignable to type 'QuestionAnswerInput[]'.
            Type '{ answer?: string; index?: number; multichoiceAnswers?: string[]; }' is not assignable to type 'QuestionAnswerInput'.
              Property 'index' is optional in type '{ answer?: string; index?: number; multichoiceAnswers?: string[]; }' but required in type 'QuestionAnswerInput'.	

For some reasons it seems like the system believe all properties of QuestionAnswerInputSchema should be nullable but in the end gets some required property and fail.

[erwan-joly]

may be related to yup jquense/yup#1890 ?

[Code-Hex]

@erwan-joly mmm, The link mentioned to Yup v0.32 not v1.

Could you give me the QuestionAnswerInputSchema as GraphQL Schema?
I want to check it in my local too.

[erwan-joly]

yep it's happening for me in v1 and was fine before the upgrade but thats the only thing close to my issue i could find.
here the graphql part

input QuestionAnswerInput {
  answer: String
  index: Int!
  multichoiceAnswers: [String!]!
}

input UpdateAssessmentInput {
  answers: [QuestionAnswerInput!]!
  domainIndex: Int!
  encodedId: String!
  groupIndex: Int!
  previous: Boolean!
  save: Boolean!
}

[Code-Hex]

I tried this schema and type-checked with tsc --strict --noEmit example/yup/schemas.ts but I couldn't get build error.

Do you use "strict": true, option in tsconfig.json?

You can try it!

1. Clone this repository on your local (main branch).
2. Rewrite example/test.graphql with your provided schema.
3. Run yarn generate to generate validation schema for example code.
4. Run type check with yarn type-check:yup

[erwan-joly]

I only use
"noImplicitAny": true,
"module": "ES2022",
"target": "ES2022",
"allowSyntheticDefaultImports": true,
"jsx": "react",
"allowJs": false,
"moduleResolution": "node",
"skipLibCheck": true

will test that asap

[erwan-joly]

@Code-Hex I've been able to reproduce the error
this as test.graphql will fail yarn type-check:yup

type InnerType {
  testScalar: MyScalar!
}

type OuterType {
  inner: InnerType
}

scalar MyScalar

Seems to be due to nested type with custom scalar field. as This schema would not fire an error

type OuterType {
  testScalar: MyScalar!
}

scalar MyScalar

[Code-Hex]

@erwan-joly Thanks! I submitted issue in yup
jquense/yup#2013

[Code-Hex]

Covered in #1423. The repo is now on Yup 1.7.1, and I added a strict TypeScript compile regression for arrays of non-null input objects so this case stays checked.