Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(typegen): Fix support for custom SQL schemas in TypeScript type generation. #717

Closed
wants to merge 6 commits into from
Closed

fix(typegen): Fix support for custom SQL schemas in TypeScript type generation. #717

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2f1db4e
fix(typegen): Fix support for custom SQL schemas in TypeScript type g…
yingw787 Feb 15, 2024
a933456
Delete test.ts
yingw787 Feb 15, 2024
8bade6c
Update typegen.ts updated expected TypeScript types.
yingw787 Feb 15, 2024
e70059b
Update typescript.ts creating types for Tables, TabelsInsert, TablesU…
yingw787 Feb 17, 2024
877ca53
Merge branch 'master' into fix/custom-schemas
yingw787 Feb 17, 2024
7a8ab6b
Update typegen.ts update 2 test cases, 96 tests passing.
yingw787 Feb 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions src/server/templates/typescript.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -421,7 +421,7 @@ export type Database = {

export type Tables<
PublicTableNameOrOptions extends
| keyof (Database["public"]["Tables"] & Database["public"]["Views"])
| keyof (Database[keyof Database]["Tables"] & Database[keyof Database]["Views"])
| { schema: keyof Database },
TableName extends PublicTableNameOrOptions extends { schema: keyof Database }
? keyof (Database[PublicTableNameOrOptions["schema"]]["Tables"] &
Expand All @@ -434,10 +434,10 @@ export type Tables<
}
? R
: never
: PublicTableNameOrOptions extends keyof (Database["public"]["Tables"] &
Database["public"]["Views"])
? (Database["public"]["Tables"] &
Database["public"]["Views"])[PublicTableNameOrOptions] extends {
: PublicTableNameOrOptions extends keyof (Database[keyof Database]["Tables"] &
Database[keyof Database]["Views"])
? (Database[keyof Database]["Tables"] &
Database[keyof Database]["Views"])[PublicTableNameOrOptions] extends {
Row: infer R
}
? R
Expand All @@ -446,7 +446,7 @@ export type Tables<

export type TablesInsert<
PublicTableNameOrOptions extends
| keyof Database["public"]["Tables"]
| keyof Database[keyof Database]["Tables"]
| { schema: keyof Database },
TableName extends PublicTableNameOrOptions extends { schema: keyof Database }
? keyof Database[PublicTableNameOrOptions["schema"]]["Tables"]
Expand All @@ -457,8 +457,8 @@ export type TablesInsert<
}
? I
: never
: PublicTableNameOrOptions extends keyof Database["public"]["Tables"]
? Database["public"]["Tables"][PublicTableNameOrOptions] extends {
: PublicTableNameOrOptions extends keyof Database[keyof Database]["Tables"]
? Database[keyof Database]["Tables"][PublicTableNameOrOptions] extends {
Insert: infer I
}
? I
Expand All @@ -467,7 +467,7 @@ export type TablesInsert<

export type TablesUpdate<
PublicTableNameOrOptions extends
| keyof Database["public"]["Tables"]
| keyof Database[keyof Database]["Tables"]
| { schema: keyof Database },
TableName extends PublicTableNameOrOptions extends { schema: keyof Database }
? keyof Database[PublicTableNameOrOptions["schema"]]["Tables"]
Expand All @@ -478,8 +478,8 @@ export type TablesUpdate<
}
? U
: never
: PublicTableNameOrOptions extends keyof Database["public"]["Tables"]
? Database["public"]["Tables"][PublicTableNameOrOptions] extends {
: PublicTableNameOrOptions extends keyof Database[keyof Database]["Tables"]
? Database[keyof Database]["Tables"][PublicTableNameOrOptions] extends {
Update: infer U
}
? U
Expand All @@ -488,15 +488,15 @@ export type TablesUpdate<

export type Enums<
PublicEnumNameOrOptions extends
| keyof Database["public"]["Enums"]
| keyof Database[keyof Database]["Enums"]
| { schema: keyof Database },
EnumName extends PublicEnumNameOrOptions extends { schema: keyof Database }
? keyof Database[PublicEnumNameOrOptions["schema"]]["Enums"]
: never = never
> = PublicEnumNameOrOptions extends { schema: keyof Database }
? Database[PublicEnumNameOrOptions["schema"]]["Enums"][EnumName]
: PublicEnumNameOrOptions extends keyof Database["public"]["Enums"]
? Database["public"]["Enums"][PublicEnumNameOrOptions]
: PublicEnumNameOrOptions extends keyof Database[keyof Database]["Enums"]
? Database[keyof Database]["Enums"][PublicEnumNameOrOptions]
: never
`

Expand Down
58 changes: 30 additions & 28 deletions test/server/typegen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -367,7 +367,8 @@ test('typegen', async () => {

export type Tables<
PublicTableNameOrOptions extends
| keyof (Database["public"]["Tables"] & Database["public"]["Views"])
| keyof (Database[keyof Database]["Tables"] &
Database[keyof Database]["Views"])
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm I think the concept here is to constrain each table to a new type on its own, for eg. PublicTableNameOrOptions type corresponds to the public schema exclusively.

We might need to generate separate export type Tables blocks depending on the schema name. @soedirgo wdyt?

Copy link
Contributor Author

@yingw787 yingw787 Feb 16, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah sounds good! I was looking at that approach but since I don't personally use the new Table types I didn't know what the context of including them was. Happy to make this change (mapping over each schema to create the PascalCase Table types, and updating the typegen tests) and push up later this evening.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sweatybridge @soedirgo just pushed up some changes in order to create schema-specific types for Tables, TablesInsert, TablesUpdate, and Enums. Would love feedback on the source and test cases (should I add an additional test case to cover schemas not named public, and having multiple schemas)?

Copy link
Contributor

@sweatybridge sweatybridge Feb 20, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After some thought, I think there's a backwards compatibility issue with this change. So I proposed a new approach in #723 and added you as the co-author.

We can close this PR if you are happy with it.

| { schema: keyof Database },
TableName extends PublicTableNameOrOptions extends { schema: keyof Database }
? keyof (Database[PublicTableNameOrOptions["schema"]]["Tables"] &
Expand All @@ -380,10 +381,10 @@ test('typegen', async () => {
}
? R
: never
: PublicTableNameOrOptions extends keyof (Database["public"]["Tables"] &
Database["public"]["Views"])
? (Database["public"]["Tables"] &
Database["public"]["Views"])[PublicTableNameOrOptions] extends {
: PublicTableNameOrOptions extends keyof (Database[keyof Database]["Tables"] &
Database[keyof Database]["Views"])
? (Database[keyof Database]["Tables"] &
Database[keyof Database]["Views"])[PublicTableNameOrOptions] extends {
Row: infer R
}
? R
Expand All @@ -392,7 +393,7 @@ test('typegen', async () => {

export type TablesInsert<
PublicTableNameOrOptions extends
| keyof Database["public"]["Tables"]
| keyof Database[keyof Database]["Tables"]
| { schema: keyof Database },
TableName extends PublicTableNameOrOptions extends { schema: keyof Database }
? keyof Database[PublicTableNameOrOptions["schema"]]["Tables"]
Expand All @@ -403,8 +404,8 @@ test('typegen', async () => {
}
? I
: never
: PublicTableNameOrOptions extends keyof Database["public"]["Tables"]
? Database["public"]["Tables"][PublicTableNameOrOptions] extends {
: PublicTableNameOrOptions extends keyof Database[keyof Database]["Tables"]
? Database[keyof Database]["Tables"][PublicTableNameOrOptions] extends {
Insert: infer I
}
? I
Expand All @@ -413,7 +414,7 @@ test('typegen', async () => {

export type TablesUpdate<
PublicTableNameOrOptions extends
| keyof Database["public"]["Tables"]
| keyof Database[keyof Database]["Tables"]
| { schema: keyof Database },
TableName extends PublicTableNameOrOptions extends { schema: keyof Database }
? keyof Database[PublicTableNameOrOptions["schema"]]["Tables"]
Expand All @@ -424,8 +425,8 @@ test('typegen', async () => {
}
? U
: never
: PublicTableNameOrOptions extends keyof Database["public"]["Tables"]
? Database["public"]["Tables"][PublicTableNameOrOptions] extends {
: PublicTableNameOrOptions extends keyof Database[keyof Database]["Tables"]
? Database[keyof Database]["Tables"][PublicTableNameOrOptions] extends {
Update: infer U
}
? U
Expand All @@ -434,15 +435,15 @@ test('typegen', async () => {

export type Enums<
PublicEnumNameOrOptions extends
| keyof Database["public"]["Enums"]
| keyof Database[keyof Database]["Enums"]
| { schema: keyof Database },
EnumName extends PublicEnumNameOrOptions extends { schema: keyof Database }
? keyof Database[PublicEnumNameOrOptions["schema"]]["Enums"]
: never = never,
> = PublicEnumNameOrOptions extends { schema: keyof Database }
? Database[PublicEnumNameOrOptions["schema"]]["Enums"][EnumName]
: PublicEnumNameOrOptions extends keyof Database["public"]["Enums"]
? Database["public"]["Enums"][PublicEnumNameOrOptions]
: PublicEnumNameOrOptions extends keyof Database[keyof Database]["Enums"]
? Database[keyof Database]["Enums"][PublicEnumNameOrOptions]
: never
"
`)
Expand Down Expand Up @@ -831,7 +832,8 @@ test('typegen w/ one-to-one relationships', async () => {

export type Tables<
PublicTableNameOrOptions extends
| keyof (Database["public"]["Tables"] & Database["public"]["Views"])
| keyof (Database[keyof Database]["Tables"] &
Database[keyof Database]["Views"])
| { schema: keyof Database },
TableName extends PublicTableNameOrOptions extends { schema: keyof Database }
? keyof (Database[PublicTableNameOrOptions["schema"]]["Tables"] &
Expand All @@ -844,10 +846,10 @@ test('typegen w/ one-to-one relationships', async () => {
}
? R
: never
: PublicTableNameOrOptions extends keyof (Database["public"]["Tables"] &
Database["public"]["Views"])
? (Database["public"]["Tables"] &
Database["public"]["Views"])[PublicTableNameOrOptions] extends {
: PublicTableNameOrOptions extends keyof (Database[keyof Database]["Tables"] &
Database[keyof Database]["Views"])
? (Database[keyof Database]["Tables"] &
Database[keyof Database]["Views"])[PublicTableNameOrOptions] extends {
Row: infer R
}
? R
Expand All @@ -856,7 +858,7 @@ test('typegen w/ one-to-one relationships', async () => {

export type TablesInsert<
PublicTableNameOrOptions extends
| keyof Database["public"]["Tables"]
| keyof Database[keyof Database]["Tables"]
| { schema: keyof Database },
TableName extends PublicTableNameOrOptions extends { schema: keyof Database }
? keyof Database[PublicTableNameOrOptions["schema"]]["Tables"]
Expand All @@ -867,8 +869,8 @@ test('typegen w/ one-to-one relationships', async () => {
}
? I
: never
: PublicTableNameOrOptions extends keyof Database["public"]["Tables"]
? Database["public"]["Tables"][PublicTableNameOrOptions] extends {
: PublicTableNameOrOptions extends keyof Database[keyof Database]["Tables"]
? Database[keyof Database]["Tables"][PublicTableNameOrOptions] extends {
Insert: infer I
}
? I
Expand All @@ -877,7 +879,7 @@ test('typegen w/ one-to-one relationships', async () => {

export type TablesUpdate<
PublicTableNameOrOptions extends
| keyof Database["public"]["Tables"]
| keyof Database[keyof Database]["Tables"]
| { schema: keyof Database },
TableName extends PublicTableNameOrOptions extends { schema: keyof Database }
? keyof Database[PublicTableNameOrOptions["schema"]]["Tables"]
Expand All @@ -888,8 +890,8 @@ test('typegen w/ one-to-one relationships', async () => {
}
? U
: never
: PublicTableNameOrOptions extends keyof Database["public"]["Tables"]
? Database["public"]["Tables"][PublicTableNameOrOptions] extends {
: PublicTableNameOrOptions extends keyof Database[keyof Database]["Tables"]
? Database[keyof Database]["Tables"][PublicTableNameOrOptions] extends {
Update: infer U
}
? U
Expand All @@ -898,15 +900,15 @@ test('typegen w/ one-to-one relationships', async () => {

export type Enums<
PublicEnumNameOrOptions extends
| keyof Database["public"]["Enums"]
| keyof Database[keyof Database]["Enums"]
| { schema: keyof Database },
EnumName extends PublicEnumNameOrOptions extends { schema: keyof Database }
? keyof Database[PublicEnumNameOrOptions["schema"]]["Enums"]
: never = never,
> = PublicEnumNameOrOptions extends { schema: keyof Database }
? Database[PublicEnumNameOrOptions["schema"]]["Enums"][EnumName]
: PublicEnumNameOrOptions extends keyof Database["public"]["Enums"]
? Database["public"]["Enums"][PublicEnumNameOrOptions]
: PublicEnumNameOrOptions extends keyof Database[keyof Database]["Enums"]
? Database[keyof Database]["Enums"][PublicEnumNameOrOptions]
: never
"
`)
Expand Down