prisma-json-types-generator

/* schema.prisma */ generator client { provider = "prisma-client-js" } generator json { provider = "prisma-json-types-generator" namespace = "PrismaJson" // Optional: define a custom namespace for generated types allowAny = false } model User { id String @id @default(uuid()) settings Json @db.Text @PrismaJson.UserSettings // Apply custom type } /// @PrismaJson.UserSettings type UserSettings = { theme: "dark" | "light"; notifications: boolean; preferences?: { locale: string; timezone: string; }; } /* index.ts */ import { PrismaClient } from '@prisma/client'; import { UserSettings } from './@prisma/client'; // Import generated type (adjust path as needed if namespace is used) const prisma = new PrismaClient(); async function main() { // Example: Create a user with strongly typed JSON settings const user = await prisma.user.create({ data: { settings: { theme: 'dark', notifications: true, preferences: { locale: 'en-US', timezone: 'UTC' } }, }, }); console.log('Created user:', user); // Accessing settings provides full TypeScript autocompletion and type-checking console.log('User theme:', user.settings.theme); // 'dark' // Example: Update user settings with type-safety const updatedUser = await prisma.user.update({ where: { id: user.id }, data: { settings: { theme: 'light', // Autocompletion for 'dark' | 'light' notifications: false, preferences: { locale: 'es-ES', timezone: 'America/Mexico_City' } }, }, }); console.log('Updated user:', updatedUser); // If you try to assign an invalid type, TypeScript will catch it at compile time. // e.g., updatedUser.settings.theme = 'invalid'; // Type error } main().catch(console.error).finally(() => prisma.$disconnect());