[Feature] Generate Zod Schemas for Prisma Foreign Keys

[kpidoff]

Context

Currently, the generation with the Zod plugin does not generate Zod schemas for foreign keys of Prisma tables when creating an entity. This presents an issue as foreign keys are required to establish relationships with other tables, and it is essential to specify validation constraints for these keys during creation.

Proposal

I propose enhancing the Zod plugin to include the generation of Zod schemas for foreign keys of Prisma tables when creating an entity. This would allow developers to specify validation constraints for foreign keys, such as minimum length, mandatory presence, etc., when creating a new entry in the table.

Benefits

• Improving the Zod schema generation by including foreign keys would facilitate data validation during entity creation.
• It would help maintain data consistency and integrity in the database by ensuring that foreign keys are correctly filled.

Exemple

Schema schema.zmodel

model Society {
    id String @id() @default(cuid())
    name String @length(1, 100, 'zod.required')
    brand Brand @relation(fields: [brandId], references: [id])
    brandId String
}

Schema zod

/* eslint-disable */
import { z } from 'zod';
const baseSchema = z.object({
    id: z.string(),
    name: z.string(),
});
export const SocietySchema = baseSchema;
export const SocietyCreateSchema = baseSchema.partial({
    id: true,
    name: true,
    brandId: z.string()
});
export const SocietyUpdateSchema = baseSchema.partial();

Conclusion

I believe that this enhancement would be beneficial for users of the Zod plugin working with Prisma databases. It would streamline the management of foreign keys during entity creation and improve data quality in the database.

Thank you for considering this feature request. I am willing to collaborate and contribute to its implementation if needed.

[ymc9]

Thank you for filing this @kpidoff Yes, I agree foreign keys should be included in the create schema.

It'll be great if you have time to work on a PR, and I'll be happy to facilitate on where to start.

[ymc9]

Hi @kpidoff , just wanted to check if you have time to work on this issue. It's completely fine if not, I'll see if I'll include it in the upcoming 1.4 release. Thanks!