custom + variant is throwing some error.

[premdasvm]

Hi everyone,

i've few schemas in my project as shown below,

const QuestionSchema = v.object(
	{
		Question: v.string(),
		QuestionLevel: v.enum_(QuestionLevel),
		Metadata: v.object({
			Curriculum: v.object({ Name: v.string(), Id: v.number() }),
			Grade: v.object({ Name: v.string(), Id: v.number() }),
			Qualification: v.array(v.object({ Name: v.string(), Id: v.number() })),
			Subjects: v.array(v.object({ Id: v.number(), Name: v.string() }), [v.minLength(1)]),
			Modules: v.array(v.object({ Id: v.number(), Name: v.string() }), [v.minLength(1)]),
			Chapters: v.array(v.object({ Id: v.number(), Name: v.string() }), [v.minLength(1)]),
			Topics: v.array(v.object({ Id: v.number(), Name: v.string() }), [v.minLength(1)]),
		}),
	},
	[v.custom(input => validateMetadata(input), "Subject should'nt be empty")],
);

const validateMetadata = (input: v.Input<typeof QuestionSchema>): boolean => {
	if (input.QuestionLevel === QuestionLevel.SUBJECT && input.Metadata.Subjects.length <= 0) {
		return false;
	}
	return true;
};

const MCQMergedSchema = v.merge([
	QuestionSchema,
	v.object({
		Type: v.literal(QuestionTypes.MULTI_CHOICE),
		Options: v.array(
			v.object({
				Id: v.number(),
				Option: v.nullish(v.string()),
				OptionImage: v.nullish(v.string()),
				CorrectAnswer: v.boolean(),
			}),
			[v.minLength(1)],
		),
		CorrectAnswerCount: v.number(),
	}),
]);

const EssayMergedSchema = v.merge([
	QuestionSchema,
	v.object({
		Type: v.literal(QuestionTypes.ESSAY),
		MinimumWords: v.number(),
		MaximumWords: v.number(),
		AnswerKeys: v.array(v.string()),
	}),
]);
const SPMergedSchema = v.merge([
	QuestionSchema,
	v.object({
		Type: v.literal(QuestionTypes.SUB_PART),
		Questions: v.lazy(() => v.array(QuestionValibotSchema)),
	}),
]);

export const QuestionValibotSchema = v.variant("Type", [
	MCQMergedSchema,
	EssayMergedSchema,
	SPMergedSchema,
]);

so basically, I have a common schema with common fields and other schemas merged with the common schema.
The thing I'm trying to achieve is, that if the QuestionLevel = SUBJECT then Metadata.Subjects shouldn't be empty or null, but if QuestionLevel = "MODULE" then Metadata.Subjects can be empty or null, but then Metadata.Modules shouldn't be.

adding the [v.custom(input => validateMetadata(input), "Subject shouldn't be empty")] to my common schema is throwing an error in my variant method,

how should i approach this issue? any help would be much appreciated

[fabian-hiller]

Can you send me your code with the enums so that I can run it in our playground?

[premdasvm]

Sure,

export enum QuestionLevel {
	SUBJECT = "SUBJECT",
	MODULE = "MODULE",
	CHAPTER = "CHAPTER",
	TOPIC = "TOPIC",
}

export enum QuestionTypes {
	MULTI_CHOICE = "MULTI_CHOICE",
	FILL_IN_THE_BLANKS = "FILL_IN_THE_BLANKS",
	ESSAY = "ESSAY",
	SINGLE_LINE = "SINGLE_LINE",
	MULTI_LINE = "MULTI_LINE",
	SUB_PART = "SUB_PART",
}

[fabian-hiller]

Thank you!

[fabian-hiller]

There are two problems (check it out in our playground). The first is the pipe of QuestionSchema because it references itself. This seems to be a TypeScript problem. Valibot can't do anything about it. Also, the pipeline is ignored when you merge QuestionSchema with other objects because properties may be over-written, making the pipeline typing invalid. We will improve the DX in our next release.

The same problem occurs when using lazy. Due to a TypeScript limitation, the input and output types of lazy schemas cannot be inferred automatically. Therefore, you must explicitly specify these types using BaseSchema. Read more here.