Prisma关联列表字段传参报错，求模型类型生成最佳实践

问题描述 #

使用Prisma Client创建新项目时，传递参数（即使是空数组[]），关联列表字段images始终出现类型错误，同时希望了解基于Prisma模型生成TypeScript类型的最佳实践。

Prisma模型 #

generator client {
  provider = "prisma-client-js"
}

datasource db {
  provider = "postgresql"
  url      = env("DATABASE_URL")
}

model Project {
    id String @id @default(cuid())
    name String
    date DateTime @default(now())
    createdAt DateTime @default(now())
    updatedAt DateTime @default(now())
    type String
    client String?
    images Image[]
}

model Image {
    id String @id @default(cuid())
    createdAt DateTime @default(now())
    updatedAt DateTime @default(now())
    title String?
    alt String?
    description String?
    src String
    project Project @relation(fields: [projectId], references: [id], onDelete: Cascade)
    projectId String
}

自定义TypeScript类型 #

export interface Project {
    name: string;
    date: Date;
    type: string;
    client: string;
    images?: Image[];
}

export interface Image {
    title: string;
    alt: string;
    description: string;
    src: string;
    projectId?: string;
}

三次尝试的Mutation #

Attempt 1

createProject: async (args: Project) => {
  const project = await prisma.project.create({
    data: {
      client: args.client,
      date: args.date,
      name: args.name,
      type: args.type,
      images: args.images
    }
  })
}

Attempt 2

createProject: async (args: Project) => {
  const project = await prisma.project.create({
    data: {
      client: args.client,
      date: args.date,
      name: args.name,
      type: args.type,
      images: []
    }
  })
}

Attempt 3

createProject: async (args: Project & { images?: Image[] }) => {
  const project = await prisma.project.create({
    data: {
      client: args.client,
      date: args.date,
      name: args.name,
      type: args.type,
      images: args.images
    }
  })
}

报错信息 #

类型“Image[] | undefined”不能赋值给类型“ImageUncheckedCreateNestedManyWithoutProjectInput | ImageCreateNestedManyWithoutProjectInput | undefined”。类型“Image[]”不能赋值给类型“ImageUncheckedCreateNestedManyWithoutProjectInput | ImageCreateNestedManyWithoutProjectInput | undefined”。ts(2322)

index.d.ts(3077, 5): 预期类型来自属性“images”，该属性在类型“(Without<ProjectCreateInput, ProjectUncheckedCreateInput> & ProjectUncheckedCreateInput) | (Without<...> & ProjectCreateInput)”上声明，(属性) images: Image[] | undefined

解决方案 #

Prisma处理关联字段的嵌套创建时，需要使用特定的输入结构，不能直接传递数组。正确的做法是通过create字段声明要创建的关联数据：

处理空数组或传入的images数据 #

createProject: async (args: Project) => {
  const project = await prisma.project.create({
    data: {
      client: args.client,
      date: args.date,
      name: args.name,
      type: args.type,
      // 用create包裹images数组，空数组时传递{ create: [] }
      images: args.images ? { create: args.images } : { create: [] }
    }
  })
}

如果不需要创建新的Image，而是关联已有的Image，则使用connect或connectOrCreate结构，具体根据业务需求选择。

TypeScript类型最佳实践 #

1. 直接使用Prisma自动生成的类型
   运行npx prisma generate后，Prisma会在@prisma/client中导出与模型对应的TypeScript类型，比如ProjectCreateInput、Project、ImageCreateInput等。这些类型完全匹配Prisma Client的输入要求，无需手动定义接口。

   示例：

   import { ProjectCreateInput } from '@prisma/client';
   
   createProject: async (args: ProjectCreateInput) => {
     const project = await prisma.project.create({
       data: args
     })
   }
   

2. 自定义类型时基于生成的类型扩展
   如果需要在生成的类型基础上添加额外字段，可以通过交叉类型扩展：

   import { ProjectCreateInput } from '@prisma/client';
   
   type CustomProjectInput = ProjectCreateInput & {
     // 添加自定义字段
     extraField: string;
   };
   

3. 避免手动重复定义模型字段
   手动定义的接口容易和Prisma模型产生不一致，导致类型错误。依赖Prisma自动生成的类型能确保类型与数据库模型同步，减少维护成本。

内容的提问来源于stack exchange，提问作者xtreebug