What is the best option to return custom object in query or mutation using Prisma plugin?

[ds-codemag]

I created user model in Prisma schema:

model User {
  id           String   @id @default(uuid())
  email        String   @unique
  password     String
  role         Role     @default(USER)
  refreshToken String?
  createdAt    DateTime @default(now())
  updatedAt    DateTime @updatedAt
}

Then I created user object using prismaObject().

builder.prismaObject('User', {
  fields: (t) => ({
    id: t.exposeID('id'),
    email: t.exposeString('email'),
    password: t.exposeString('password'),
    role: t.expose('role', {type: Role}),
    refreshToken: t.exposeString('refreshToken', {nullable: true}),
    createdAt: t.expose('createdAt', {type: 'DateTime'}),
    updatedAt: t.expose('updatedAt', {type: 'DateTime'})
  })
});

User model and object contains password field but in query I want to return users without password.
I used Prisma omitApi.

builder.queryField('users', (t) =>
  t.prismaField({
    type: ['User'],
    resolve: async (query, root, args, ctx, info) => {
      const users = await prisma.user.findMany({omit: {password: true}});
      return users;
    }
  })
);

And I'm getting type error because 'password' is missing

To solve this error I created new object using generated User type from Prisma Client:

export const UserWithoutPassword = builder.objectRef<Omit<User, 'password'>>('UserWithoutPassword').implement({
  fields: (t) => ({
    id: t.exposeID('id'),
    email: t.exposeString('email'),
    role: t.expose('role', {type: Role}),
    refreshToken: t.exposeString('refreshToken', {nullable: true}),
    createdAt: t.expose('createdAt', {type: 'DateTime'}),
    updatedAt: t.expose('updatedAt', {type: 'DateTime'})
  })
});

And I changed query using not prismaField() but standard field() method:

builder.queryField('users', (t) =>
  t.field({
    type: [UserWithoutPassword],
    resolve: async (root, args, ctx, info) => {
      const users = await prisma.user.findMany({omit: {password: true}});
      return users;
    }
  })
);

Everything works fine.

But my question is:
Is this the only solution or maybe there is a better solution where i can still use prismaObject and prismaField?

[hayes]

You can define a select on your prisma objects:

builder.prismaObject('User', {
  select: {
    id: true,
  },
  fields: (t) => ({
    id: t.exposeID('id'),
    email: t.exposeString('email'),
    password: t.exposeString('password'),
    role: t.expose('role', {type: Role}),
    refreshToken: t.exposeString('refreshToken', {nullable: true}),
    createdAt: t.expose('createdAt', {type: 'DateTime'}),
    updatedAt: t.expose('updatedAt', {type: 'DateTime'})
  })
});

This will update your type so that only the id field is expected.

In your query, you should use t.prismaField, and just rely on query:

builder.queryField('users', (t) =>
  t.prismaField({
    type: ['User'],
    resolve: (query, root, args, ctx, info) => prisma.user.findMany({ ...query }),
  })
);

The query, will take the default select from the type, and add in any "exposed" fields the user requests, + any custom selections needed by other fields. As long as you have a default select on the Object type, and don't expose the password field, it shouldn't be loaded

[hayes]

its important to ALWAYS use the query argument when using prisma fields