postgrest-js: ParserError "Unexpected input: .sum()" when using aggregate functions with TypeScript

Bug report

  • I confirm this is a bug with Supabase, not with my own application.
  • I confirm I have searched the Docs, GitHub Discussions, and Discord.

Describe the bug

When I use aggregate functions, the inferred TypeScript data type will always depict an error, requiring me to use casts to any.

To Reproduce

  const { data } = await supabase.from("things").select(`
    field.sum(),
    ...other_things(id, name, color)
  `);

The inferred type for data seen in my VS Code is: ParserError<"Unexpected input: .sum(),\n ...other_things(id, name, color)\n ">[] | null

Inference works fine when not using aggregate functions. Re-generating TS types via supabase gen types typescript does not fix the issue.

Expected behavior

Types should be inferred correctly without an error.

System information

  • OS: MacOS
  • Version of supabase-js: 2.39.7
  • Version of Node.js: 21.6.2

About this issue

  • Original URL
  • State: closed
  • Created 3 years ago
  • Comments: 15 (5 by maintainers)

Most upvoted comments

@stefan-girlich thanks for providing the examples; I’m really busy now so I can probably look at them next week only.

I created a case with supabase support ✅ Support Ticket ID: 15885286048

In case it helps anyone, here’s a generic way to override the faulty type:

import fail from '@/utils/fail'
import { createClient } from '@/utils/supabase/server'

type FixSupabaseAggregateType<
  T extends readonly any[] | null,
  K extends keyof R,
  R extends Record<K, any>,
> = Array<Omit<NonNullable<T>[number], K> & R>

export const fetchSomeData = async () => {
  const supabase = createClient()
  const { data, error } = await supabase
    .from('some_table')
    .select(
      `
        some_prop,
        other_table(aggregated_prop:nested_prop.sum())
    `
    )

  if (error) fail(error)

  type Result = FixSupabaseAggregateType<
    typeof data,
    'other_table',
    {
      other_table: { aggregated_prop: number }
    }
  >

  return data as unknown as Result
}

@bnjmnt4n Would you know if a fix is scheduled already? Thanks!

Moving this issue to Postgrest-js repo. Issue is similar to https://github.com/supabase/postgrest-js/issues/447 which was fixed recently