ianpaschal•2mo ago

How to re-organize api structure?

It's neat that Convex automatically structures the api object according to your folders, files, and function names, but on a larger project it becomes a bit impractical. For example, I have convex/users/fetchCurrentUser.ts with a function in there called, of course, fetchCurrentUser(). However, in order to consume this, I have to use:

const user = useQuery(api.users.fetchCurrentUser.fetchCurrentUser);

const user = useQuery(api.users.fetchCurrentUser.fetchCurrentUser);

Is it possible to avoid this besides putting all functions in one file? That seems really impractical.

5 Replies

Convex Bot•2mo ago

Thanks for posting in <#1088161997662724167>. Reminder: If you have a Convex Pro account, use the Convex Dashboard to file support tickets. - Provide context: What are you trying to achieve, what is the end-user interaction, what are you seeing? (full error message, command output, etc.) - Use search.convex.dev to search Docs, Stack, and Discord all at once. - Additionally, you can post your questions in the Convex Community's <#1228095053885476985> channel to receive a response from AI. - Avoid tagging staff unless specifically instructed. Thank you!

makrdev•2mo ago

Yes, you can put all related functions into a single file. A pattern I follow is: collections(folder) > users.ts (schema and all the functions)

ianpaschalOP•2mo ago

That's not really practical IMO. It will make a single file hundreds and hundreds of lines long.

Tom Redman•2mo ago

@ianpaschal For context I have about 150 functions, and have been partial to this pattern:

/table
 - actions.ts
 - mutations.ts
 - queries.ts

/table
 - actions.ts
 - mutations.ts
 - queries.ts

But I'm not religious about it. I find if one of my table/functions.ts files starts to grow large, there's usually a more semantic way to chunk it out -- I'm usually "mixing metaphors" and I'll create a new folder that has a more narrow scope, and move some things there. That said, sometimes I'll throw caution to the wind and create what feels like the most ergonomic setup (see google/places.ts below). Here's how my setup looks:

/convex
├── README.md
├── _generated
│   ├── api.d.ts
│   ├── api.js
│   ├── dataModel.d.ts
│   ├── server.d.ts
│   └── server.js
├── admin
│   ├── mutations.ts
│   └── queries.ts
├── aggregates
│   ├── campaigns.ts
│   └── migrations.ts
├── auth.config.ts
├── auth.ts
├── authProviders
│   └── Password.ts
├── authentication
│   ├── mutations.ts
│   ├── queries.ts
│   └── user.ts
├── campaigns
│   ├── actions.ts
│   ├── migrations.ts
│   ├── mutations.ts
│   ├── queries.ts
│   └── utils.ts
├── convex.config.ts
├── crons.ts
├── domains
│   ├── actions.ts
│   ├── mutations.ts
│   └── queries.ts
├── dub
│   ├── mutations.ts
│   └── webhooks.ts
├── emailEvents
│   └── mutations.ts
├── emailableLists
│   └── queries.ts
├── emails
│   ├── actions.ts
│   ├── mutations.ts
│   ├── parser.ts
│   └── utils.ts
├── fub
│   ├── contacts
│   └── lists
├── google
│   └── places.ts
...

/convex
├── README.md
├── _generated
│   ├── api.d.ts
│   ├── api.js
│   ├── dataModel.d.ts
│   ├── server.d.ts
│   └── server.js
├── admin
│   ├── mutations.ts
│   └── queries.ts
├── aggregates
│   ├── campaigns.ts
│   └── migrations.ts
├── auth.config.ts
├── auth.ts
├── authProviders
│   └── Password.ts
├── authentication
│   ├── mutations.ts
│   ├── queries.ts
│   └── user.ts
├── campaigns
│   ├── actions.ts
│   ├── migrations.ts
│   ├── mutations.ts
│   ├── queries.ts
│   └── utils.ts
├── convex.config.ts
├── crons.ts
├── domains
│   ├── actions.ts
│   ├── mutations.ts
│   └── queries.ts
├── dub
│   ├── mutations.ts
│   └── webhooks.ts
├── emailEvents
│   └── mutations.ts
├── emailableLists
│   └── queries.ts
├── emails
│   ├── actions.ts
│   ├── mutations.ts
│   ├── parser.ts
│   └── utils.ts
├── fub
│   ├── contacts
│   └── lists
├── google
│   └── places.ts
...

Edit: Just did the math: 139 functions in 39 files. So 3-4 functions per file on average.

ianpaschalOP•2mo ago

Nice, that looks very sensible. Thanks for sharing!

How to re-organize api structure?

Did you find this page helpful?