feat(types): add override types method

[avallete]

• Add overrideTypes method allow both partial and complete override of the return type, do partial override by default

@kamilogorek mentioned that we often had to port a lot of properties definition in order to override a single field when using .returns method.

This new method introduce a way to perform "partial override" per default, and allow the user to have similar behavior than the current .returns method by providing the option { merge: false }.

This make this kind of type override where we only want to override func_call result easier to maintain.

Before:

const results = await getOrThrowTyped(
  readWriteNext
    .from('sometable')
    .select(
      'id, projects!projects_sometable_id_fkey(ref, name), func_call(id)'
    )
    .eq('slug', 'some-slug')
    .is('projects.metadata->base_project_id', null)
    .neq('projects.status', 'SOMEVALUE')
    .single()
    .returns<{
      id: number
      func_call?: { value: SomeEnum }
      projects: { ref: string; name: string }[]
    }>(),
  'Failed to retrieve infos'
)

After

const results = await getOrThrowTyped(
  readWriteNext
    .from('sometable')
    .select(
      'id, projects!projects_sometable_id_fkey(ref, name), func_call(id)'
    )
    .eq('slug', 'some-slug')
    .is('projects.metadata->base_project_id', null)
    .neq('projects.status', 'SOMEVALUE')
    .single()
    .overrideTypes<{
      // Here we can now override only the part that we are interested in
      func_call?: { value: SomeEnum }
    }>(),
  'Failed to retrieve infos'
)

// We can still opt out from the merging behavior with:
await getOrThrowTyped(
  readWriteNext
    .from('sometable')
    .select(
      'id, projects!projects_sometable_id_fkey(ref, name), func_call(id)'
    )
    .eq('slug', 'some-slug')
    .is('projects.metadata->base_project_id', null)
    .neq('projects.status', 'SOMEVALUE')
    .single()
    .overrideTypes<{
      id: number
      func_call?: { value: SomeEnum }
      projects: { ref: string; name: string }[]
    }, { merge: false }>(),
  'Failed to retrieve infos'
)

[kamilogorek]

Concept looks good to me and I believe it'd fix most our type problems.
Just a general note that https://supabase.com/docs/reference/javascript/typescript-support and https://supabase.com/docs/reference/javascript/db-returns will need to be updated/expanded.

[avallete]

Concept looks good to me and I believe it'd fix most our type problems. Just a general note that https://supabase.com/docs/reference/javascript/typescript-support and https://supabase.com/docs/reference/javascript/db-returns will need to be updated/expanded.

Started to write some draft for the docs here: supabase/supabase#33705 for when it land.

[soedirgo]

Is this meant to be in draft still?

[avallete]

Is this meant to be in draft still?

Nope 😓

Feel free to give a review. I'll be merging this one with the "return type casting" PR so we can deploy both together.

[github-actions]

🎉 This PR is included in version 1.19.0 🎉

The release is available on:

• GitHub release
• npm package (@latest dist-tag)

Your semantic-release bot 📦🚀