Define better auth's table schema in `convex/schema.ts`

[jasongitmail]

My understanding (as someone new to Convex), is that if I create schema.ts, I'm required to define all tables, in this case, all of my own tables + better auth's tables.

For this reason, Convex Auth's implementation, as an example, imports the auth-related schema via ...authTables. This seems to be missing for better auth.

// schema.ts
import { authTables } from "@convex-dev/auth/server";
import { defineSchema, defineTable } from "convex/server";
import { v } from "convex/values";

const schema = defineSchema({
  ...authTables,
  tasks: defineTable({
    text: v.string(),
    isCompleted: v.boolean(),
  }),
});

export default schema;

[ping-maxwell]

Tldr:

• Yes there is some support.
• No it's not documented
• I need to write my own CLI (not started yet) for you guys to use it.

Long story:

Currently we do have schema generation (it's not documented though), where it will update your schema.ts file for you with the new Better auth tables and stuff.

I didn't went with the idea of just exporting an object where you can just ... spread into your defineSchema since that doesn't give you full control over stuff like table names, field names, and whether you want to index a specific field.

It's also a little more tricky with Better Auth, since we don't just have a set of tables that's consistently the same.
Since Better Auth works in a plugin ecosystem, any plugin you add could modify an existing table or add new tables.
This makes exporting an object for users to spread operator into their schema a little more tricky to accomplish...

That said, in order for you to actually use the schema generation, you'd normally, have to use the Better Auth CLI and run the generate command like this:

npx @better-auth/cli generate

Which would in theory would use the current adapter in your better auth config and see if said adapter supports generating a config.

However... better auth has yet to implement this. They only support schema generating with built-in adapters from Better-auth themselves at the moment.

Furthermore, our schema generation requires us to use fs module from node. And in some cases you may need to import your auth.ts file into a Convex function related file, and therefore causing an error saying that Convex won't work in it's default environment when importing a node module.
So in the end, even if we do have schema generating ,we can't include it natively in our adapter since it would mean Convex won't build.

Thus coming to the conclusion that I need to write my own CLI specifically to do schema generation.
It's not started yet. But I'll update the Better-Auth-Kit roadmap to include that as a goal

[jasongitmail]

I wonder if you'd be able to tie that in with Convex dev server somehow, so that the "Convex experience" of starting the dev server to update things stays consistent. Might be something to chat with them about to plant the seed for them to support a hook or something for you to define a script to in, instead of being a separate CLI command. Just an idea.

Appreciate the info! Will keep an eye on the this area. I don't get any schema-related app errors right now, as far as I can tell, which is what matters.