feat: generate types on local dev and self-hosted supabase studio

[kishanhitk]

What kind of change does this PR introduce?

Feature Addition

What is the current behavior?

Closes: #16793

Allow generating types from local supabase studio.

Additional Info

The type generator in the cloud dashboard generates types only for the public schema. But, the type generated by cli contains the public, storage and graphql_public schema.
I have followed what the cli does because that is what we generally use in the CI pipeline to verify if types are updated.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 4, 2023 6:26am
studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 4, 2023 6:26am
studio-self-hosted	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 4, 2023 6:26am
studio-staging	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 4, 2023 6:26am
zone-www-dot-com	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 4, 2023 6:26am

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
ui-storybook	⬜️ Ignored (Inspect)	Visit Preview		Sep 4, 2023 6:26am

[vercel]

@kishanhitk is attempting to deploy a commit to the Supabase Team on Vercel.

A member of the Team first needs to authorize it.

[kishanhitk]

I am having some confusion.

When using supabase locally. Clicking on the "Generate and Download types" button makes a call to this URL: http://localhost:8082/api/v1/projects/${projectRef}/types/typescript. But there is no file in the api folder to handle this route.

On cloud supabase dashboard, it makes a call to https://api.supabase.io/v1/projects/${projectRef}/types/typescript, which is working as expected.

There is an API route, http://localhost:8082/api/pg-meta/${projectRef}/types, that can generate types, but I found that even that is not working as expected.

What should be the solution?
Replace the http://localhost:8082/api/v1/projects/${projectRef}/types/typescript with http://localhost:8082/api/pg-meta/${projectRef}/types, and make the http://localhost:8082/api/pg-meta/${projectRef}/types work correctly?

[alaister]

Hey @kishanhitk,

I think the solution here would be to add an API route for /types/typescript and remove the /types route altogether as it doesn't seem to be used. What do you think?

[kishanhitk]

Hey @kishanhitk,

I think the solution here would be to add an API route for /types/typescript and remove the /types route altogether as it doesn't seem to be used. What do you think?

@alaister
But since the URL also has v1 prefix, it requires creating a v1 folder within the api route, as the current api folder does not have any v1 folder.

Why is there a v1? Are we building a new version of API? I see some of the newer features (eg: branches) are using API routes with v1 prefix.

[alaister]

You can go ahead and create a v1 folder. v1 routes are there because they are publically facing, and so should be versioned :)

[kishanhitk]

The type generator in the cloud dashboard generates types only for the public schema. But, the type generated by cli contains the public, storage and graphql_public schema.
I have followed what the cli does because that is what we generally use in the CI pipeline to verify if types are updated.

[alaister]

LGTM! Thanks, @kishanhitk!

[kiwicopple]

Closes #15502