Better Auth•4w ago

Adding simple role to User Schema

hi guys! im having a little issue with adding a role to my User schema. I'm using Prisma and i wanted to add a role property to the User schema. It all works well, until i need to use the authClient.useSession() hook. I get the session off of it, but when trying to access the session.user.role property, it says there is no role property on it. What i've already tried: - Adding aditionalFields property to the better auth instance

user: {
    additionalFields: {
      role: {
        type: "string",
      }
    }
  }

user: {
    additionalFields: {
      role: {
        type: "string",
      }
    }
  }

- Adding the inferAdditionalFields plugins, both ways suggested in here: https://www.better-auth.com/docs/concepts/typescript#inferring-additional-fields-on-client - Regenerated my Prisma client I didnt want to include that whole admin plugin for roles since i dont think theres need for it in my simple app. I believe just an "Admin", "Customer" or "Support" role column on the User schema will do. But if theres no better way to do it, i'll try that option.

TypeScript | Better Auth

Better Auth TypeScript integration.

Solution:

alright, i'll summarize the fix in here for anybody who happens to have the same issue in the future: To add a custom field to your User schema: 1. In your auth.ts file, add the user.additionalFields property: (dont mind the prismaAdapter or socialProviders, these are specific to my project)...

Jump to solution

11 Replies

Ping•4w ago

Have you looked into the customSession plugin?

Ping•4w ago

https://www.better-auth.com/docs/concepts/session-management#customizing-session-response

Session Management | Better Auth

Better Auth session management.

CampFireOP•4w ago

hey Max! thanks for the reply! Let me have a look at it yeah, apparently it doesnt have anything to solve it. The issue is that im trying to access a newly added property to the User schema as in session.user.role but it doesnt recognizes it

enum Role {
  ADMIN
  SUPPORT
  CUSTOMER
}

model User {
  id            String    @id
  name          String
  email         String
  emailVerified Boolean   @default(false)
  image         String?
  role          Role      @default(CUSTOMER) // <---- This role was manually added
  createdAt     DateTime  @default(now())
  updatedAt     DateTime  @default(now()) @updatedAt
  sessions      Session[]
  accounts      Account[]

  @@unique([email])
  @@map("user")
}

enum Role {
  ADMIN
  SUPPORT
  CUSTOMER
}

model User {
  id            String    @id
  name          String
  email         String
  emailVerified Boolean   @default(false)
  image         String?
  role          Role      @default(CUSTOMER) // <---- This role was manually added
  createdAt     DateTime  @default(now())
  updatedAt     DateTime  @default(now()) @updatedAt
  sessions      Session[]
  accounts      Account[]

  @@unique([email])
  @@map("user")
}

then inside a client component, i do:

const { data: session } = authClient.useSession();

const { data: session } = authClient.useSession();

and try to access the user role from the session:

const role = session?.user?.role

const role = session?.user?.role

but TS tells me theres no role on the user object I tried adding the aditionalFields property in the auth.ts file:

import { PrismaClient } from "@/generated/prisma";
import { betterAuth } from "better-auth";
import { prismaAdapter } from "better-auth/adapters/prisma";
// If your Prisma file is located elsewhere, you can change the path"

const prisma = new PrismaClient();
export const auth = betterAuth({
  database: prismaAdapter(prisma, {
    provider: "postgresql",
  }),
  socialProviders: {
    cognito: {
      clientId: process.env.COGNITO_CLIENT_ID!,
      clientSecret: process.env.COGNITO_CLIENT_SECRET!,
      domain: process.env.COGNITO_DOMAIN!,
      region: process.env.COGNITO_REGION!,
      userPoolId: process.env.COGNITO_USER_POOL_ID!,
    },
  },
  user: {
    additionalFields: {
      role: {
        type: "string",
      }
    }
  }
});

import { PrismaClient } from "@/generated/prisma";
import { betterAuth } from "better-auth";
import { prismaAdapter } from "better-auth/adapters/prisma";
// If your Prisma file is located elsewhere, you can change the path"

const prisma = new PrismaClient();
export const auth = betterAuth({
  database: prismaAdapter(prisma, {
    provider: "postgresql",
  }),
  socialProviders: {
    cognito: {
      clientId: process.env.COGNITO_CLIENT_ID!,
      clientSecret: process.env.COGNITO_CLIENT_SECRET!,
      domain: process.env.COGNITO_DOMAIN!,
      region: process.env.COGNITO_REGION!,
      userPoolId: process.env.COGNITO_USER_POOL_ID!,
    },
  },
  user: {
    additionalFields: {
      role: {
        type: "string",
      }
    }
  }
});

Karl•4w ago

db synced with schema after adding that custom field?

CampFireOP•4w ago

yes, Prisma Studio shows me that column is already in the database

Ping•4w ago

can you show me your authClient config?

CampFireOP•4w ago

import { createAuthClient } from "better-auth/react";
export const authClient = createAuthClient({
  /** The base URL of the server (optional if you're using the same domain) */
  baseURL: "http://localhost:3000",
});

import { createAuthClient } from "better-auth/react";
export const authClient = createAuthClient({
  /** The base URL of the server (optional if you're using the same domain) */
  baseURL: "http://localhost:3000",
});

Ping•4w ago

You need the inferAdditionalFields client plugin

CampFireOP•4w ago

Perfect! That solved the problem My mistake was that I added the plugin on the auth instance, rather than on the auth-client instance

Solution

CampFire•4w ago

import { PrismaClient } from "@/generated/prisma";
import { betterAuth } from "better-auth";
import { prismaAdapter } from "better-auth/adapters/prisma";
// If your Prisma file is located elsewhere, you can change the path"

const prisma = new PrismaClient();
export const auth = betterAuth({
  database: prismaAdapter(prisma, {
    provider: "postgresql",
  }),
  socialProviders: {
    cognito: {
      clientId: process.env.COGNITO_CLIENT_ID!,
      clientSecret: process.env.COGNITO_CLIENT_SECRET!,
      domain: process.env.COGNITO_DOMAIN!,
      region: process.env.COGNITO_REGION!,
      userPoolId: process.env.COGNITO_USER_POOL_ID!,
    },
  },
  user: {
    additionalFields: {
      role: {
        type: "string",
      },
    },
  },
});

import { PrismaClient } from "@/generated/prisma";
import { betterAuth } from "better-auth";
import { prismaAdapter } from "better-auth/adapters/prisma";
// If your Prisma file is located elsewhere, you can change the path"

const prisma = new PrismaClient();
export const auth = betterAuth({
  database: prismaAdapter(prisma, {
    provider: "postgresql",
  }),
  socialProviders: {
    cognito: {
      clientId: process.env.COGNITO_CLIENT_ID!,
      clientSecret: process.env.COGNITO_CLIENT_SECRET!,
      domain: process.env.COGNITO_DOMAIN!,
      region: process.env.COGNITO_REGION!,
      userPoolId: process.env.COGNITO_USER_POOL_ID!,
    },
  },
  user: {
    additionalFields: {
      role: {
        type: "string",
      },
    },
  },
});

2. in your auth-client.ts file, add the inferAdditionalFields plugins:

import { createAuthClient } from "better-auth/react";
import { inferAdditionalFields } from "better-auth/client/plugins";
import type { auth } from "./auth";
export const authClient = createAuthClient({
  /** The base URL of the server (optional if you're using the same domain) */
  baseURL: "http://localhost:3000",
  plugins: [inferAdditionalFields<typeof auth>()],
});

import { createAuthClient } from "better-auth/react";
import { inferAdditionalFields } from "better-auth/client/plugins";
import type { auth } from "./auth";
export const authClient = createAuthClient({
  /** The base URL of the server (optional if you're using the same domain) */
  baseURL: "http://localhost:3000",
  plugins: [inferAdditionalFields<typeof auth>()],
});

3. From there, any additional property you add to the User schema, you'll need to include it on the user.additionalFields property from step 1 and they should get automatically picked up when you fetch the user.

CampFireOP•4w ago

Thank you guys for the help

Gaming

Programming

Adding simple role to User Schema

Did you find this page helpful?