feat(types): setup postgrest-13 types inference #618
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
avallete
commented
May 19, 2025
Comment on lines
+448
to
+449
| ? ClientOptions['postgrestVersion'] extends 13 // Spread over an many-to-many relationship, turn all the result fields into arrays | ||
| ? ProcessManyToManySpreadNodeResult<Result> |
There was a problem hiding this comment.
note
Here is what the conditionality for the inference can look like.
Comment on lines
+5
to
20
| rest13: | ||
| image: postgrest/postgrest:v13.0.0 | ||
| ports: | ||
| - '3001:3000' | ||
| environment: | ||
| PGRST_DB_URI: postgres://postgres:postgres@db:5432/postgres | ||
| PGRST_DB_SCHEMAS: public,personal | ||
| PGRST_DB_EXTRA_SEARCH_PATH: extensions | ||
| PGRST_DB_ANON_ROLE: postgres | ||
| PGRST_DB_PLAN_ENABLED: 1 | ||
| PGRST_DB_TX_END: commit-allow-override | ||
| PGRST_DB_AGGREGATES_ENABLED: true | ||
| depends_on: | ||
| - db | ||
| rest12: | ||
| image: postgrest/postgrest:v12.2.0 |
There was a problem hiding this comment.
note
It is also possible to check if all the current tests and the new version ones are matching by upgrading the rest12 container to postgrest:v13. I did so for testing, and except from the Spread on Many feature, everything was behaving the same, with the only difference being the returned error message within some of the inline snapshots.
| ? { | ||
| [K in Spread['target']['name']]: SelectQueryError<`"${RelationName}" and "${Spread['target']['name']}" do not form a many-to-one or one-to-one relationship spread not possible`> | ||
| } | ||
| ? ClientOptions['postgrestVersion'] extends 13 // Spread over an many-to-many relationship, turn all the result fields into arrays |
There was a problem hiding this comment.
Q: Will this comment appear on the docs? If so, it would be good to mention the arrays are correlated (they share the same order).
Suggested change
| ? ClientOptions['postgrestVersion'] extends 13 // Spread over an many-to-many relationship, turn all the result fields into arrays | |
| ? ClientOptions['postgrestVersion'] extends 13 // Spread over an many-to-many relationship, turn all the result fields into correlated arrays |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What kind of change does this PR introduce?
This lay out the ground basis to start introducing new postgrest-13 features to the client library.
new PostgrestClient(DB_URL, { postgrestVersion: 12 | 13 }>allowing the types inference to pick in and choose the right result based on the available features for this major version.