feat(postgrest): add embeded functions type inference (#1632)

Author: avallete

packages/core/postgrest-js/package.json

@@ -37,6 +37,7 @@
     "format": "node scripts/format.js",
     "format:check": "node scripts/format.js check",
     "build": "npm run clean && npm run build:cjs && npm run build:esm",
+    "postbuild": "cp -rf ./src/types/common ../supabase-js/src/lib/rest/types/common",
     "build:cjs": "tsc -p tsconfig.json",
     "build:esm": "cpy wrapper.mjs dist/esm/",
     "docs": "typedoc src/index.ts --out docs/v2",
@@ -53,7 +54,7 @@
     "type-check:test": "tsc --noEmit --project tsconfig.test.json",
     "db:clean": "cd test/db && docker compose down --volumes",
     "db:run": "cd test/db && docker compose up --detach && wait-for-localhost 3000",
-    "db:generate-test-types": "cd test/db && docker compose up --detach && wait-for-localhost 8080 && curl --location 'http://0.0.0.0:8080/generators/typescript?included_schemas=public,personal&detect_one_to_one_relationships=true' > ../types.generated.ts && node ../scripts/update-json-type.js && cd ../../ && npm run format"
+    "db:generate-test-types": "cd test/db && docker compose up --detach && wait-for-localhost 8080 && wait-for-localhost 3000 && curl --location 'http://0.0.0.0:8080/generators/typescript?included_schemas=public,personal&detect_one_to_one_relationships=true' > ../types.generated.ts && node ../../scripts/update-json-type.js && cd ../../ && npm run format"
   },
   "dependencies": {
     "@supabase/node-fetch": "2.6.15"

packages/core/postgrest-js/test/scripts/update-json-type.js renamed to packages/core/postgrest-js/scripts/update-json-type.js

@@ -8,7 +8,7 @@ const path = require('path')
  * This is a cross-platform replacement for the sed command
  */
 function updateJsonType() {
-  const filePath = path.join(__dirname, '..', 'types.generated.ts')
+  const filePath = path.join(__dirname, '..', 'test', 'types.generated.ts')
 
   try {
     // Read the file
@@ -23,7 +23,7 @@ function updateJsonType() {
     // Write the updated content back to the file
     fs.writeFileSync(filePath, updatedContent, 'utf8')
 
-    console.log('✅ Successfully updated Json type in types.generated.ts')
+    console.log('✅ Successfully updated Json type in test/types.generated.ts')
   } catch (error) {
     console.error('❌ Error updating Json type:', error.message)
     process.exit(1)

packages/core/postgrest-js/src/PostgrestBuilder.ts

@@ -2,14 +2,13 @@
 import nodeFetch from '@supabase/node-fetch'
 
 import type {
-  Fetch,
   PostgrestSingleResponse,
   PostgrestResponseSuccess,
   CheckMatchingArrayTypes,
   MergePartialResult,
   IsValidResultOverride,
-  ClientServerOptions,
-} from './types'
+} from './types/types'
+import { ClientServerOptions, Fetch } from './types/common/common'
 import PostgrestError from './PostgrestError'
 import { ContainsNull } from './select-query-parser/types'
 

packages/core/postgrest-js/src/PostgrestClient.ts

@@ -1,6 +1,7 @@
 import PostgrestQueryBuilder from './PostgrestQueryBuilder'
 import PostgrestFilterBuilder from './PostgrestFilterBuilder'
-import { Fetch, GenericSchema, ClientServerOptions } from './types'
+import { Fetch, GenericSchema, ClientServerOptions } from './types/common/common'
+import { GetRpcFunctionFilterBuilderByArgs } from './types/common/rpc'
 
 /**
  * PostgREST client.
@@ -131,9 +132,17 @@ export default class PostgrestClient<
    * `"estimated"`: Uses exact count for low numbers and planned count for high
    * numbers.
    */
-  rpc<FnName extends string & keyof Schema['Functions'], Fn extends Schema['Functions'][FnName]>(
+  rpc<
+    FnName extends string & keyof Schema['Functions'],
+    Args extends Schema['Functions'][FnName]['Args'] = never,
+    FilterBuilder extends GetRpcFunctionFilterBuilderByArgs<
+      Schema,
+      FnName,
+      Args
+    > = GetRpcFunctionFilterBuilderByArgs<Schema, FnName, Args>,
+  >(
     fn: FnName,
-    args: Fn['Args'] = {},
+    args: Args = {} as Args,
     {
       head = false,
       get = false,
@@ -146,14 +155,10 @@ export default class PostgrestClient<
   ): PostgrestFilterBuilder<
     ClientOptions,
     Schema,
-    Fn['Returns'] extends any[]
-      ? Fn['Returns'][number] extends Record<string, unknown>
-        ? Fn['Returns'][number]
-        : never
-      : never,
-    Fn['Returns'],
-    FnName,
-    null,
+    FilterBuilder['Row'],
+    FilterBuilder['Result'],
+    FilterBuilder['RelationName'],
+    FilterBuilder['Relationships'],
     'RPC'
   > {
     let method: 'HEAD' | 'GET' | 'POST'

packages/core/postgrest-js/src/PostgrestFilterBuilder.ts

@@ -1,6 +1,6 @@
 import PostgrestTransformBuilder from './PostgrestTransformBuilder'
 import { JsonPathToAccessor, JsonPathToType } from './select-query-parser/utils'
-import { ClientServerOptions, GenericSchema } from './types'
+import { ClientServerOptions, GenericSchema } from './types/common/common'
 
 type FilterOperator =
   | 'eq'

packages/core/postgrest-js/src/PostgrestQueryBuilder.ts

@@ -1,6 +1,12 @@
 import PostgrestFilterBuilder from './PostgrestFilterBuilder'
 import { GetResult } from './select-query-parser/result'
-import { ClientServerOptions, Fetch, GenericSchema, GenericTable, GenericView } from './types'
+import {
+  ClientServerOptions,
+  Fetch,
+  GenericSchema,
+  GenericTable,
+  GenericView,
+} from './types/common/common'
 
 export default class PostgrestQueryBuilder<
   ClientOptions extends ClientServerOptions,

packages/core/postgrest-js/src/PostgrestTransformBuilder.ts

@@ -1,12 +1,8 @@
 import PostgrestBuilder from './PostgrestBuilder'
-import { InvalidMethodError } from './PostgrestFilterBuilder'
+import PostgrestFilterBuilder, { InvalidMethodError } from './PostgrestFilterBuilder'
 import { GetResult } from './select-query-parser/result'
-import {
-  GenericSchema,
-  CheckMatchingArrayTypes,
-  ClientServerOptions,
-  MaxAffectedEnabled,
-} from './types'
+import { CheckMatchingArrayTypes, MaxAffectedEnabled } from './types/types'
+import { ClientServerOptions, GenericSchema } from './types/common/common'
 
 export default class PostgrestTransformBuilder<
   ClientOptions extends ClientServerOptions,
@@ -31,11 +27,15 @@ export default class PostgrestTransformBuilder<
     NewResultOne = GetResult<Schema, Row, RelationName, Relationships, Query, ClientOptions>,
   >(
     columns?: Query
-  ): PostgrestTransformBuilder<
+  ): PostgrestFilterBuilder<
     ClientOptions,
     Schema,
     Row,
-    NewResultOne[],
+    Method extends 'RPC'
+      ? Result extends unknown[]
+        ? NewResultOne[]
+        : NewResultOne
+      : NewResultOne[],
     RelationName,
     Relationships,
     Method
@@ -56,11 +56,15 @@ export default class PostgrestTransformBuilder<
       .join('')
     this.url.searchParams.set('select', cleanedColumns)
     this.headers.append('Prefer', 'return=representation')
-    return this as unknown as PostgrestTransformBuilder<
+    return this as unknown as PostgrestFilterBuilder<
       ClientOptions,
       Schema,
       Row,
-      NewResultOne[],
+      Method extends 'RPC'
+        ? Result extends unknown[]
+          ? NewResultOne[]
+          : NewResultOne
+        : NewResultOne[],
       RelationName,
       Relationships,
       Method

packages/core/postgrest-js/src/index.ts

@@ -28,8 +28,8 @@ export type {
   PostgrestResponseSuccess,
   PostgrestSingleResponse,
   PostgrestMaybeSingleResponse,
-  ClientServerOptions as PostgrestClientOptions,
-} from './types'
+} from './types/types'
+export type { ClientServerOptions as PostgrestClientOptions } from './types/common/common'
 // https://github.com/supabase/postgrest-js/issues/551
 // To be replaced with a helper type that only uses public types
 export type { GetResult as UnstableGetResult } from './select-query-parser/result'

packages/core/postgrest-js/src/select-query-parser/parser.ts

@@ -1,7 +1,7 @@
 // Credits to @bnjmnt4n (https://www.npmjs.com/package/postgrest-query)
 // See https://github.com/PostgREST/postgrest/blob/2f91853cb1de18944a4556df09e52450b881cfb3/src/PostgREST/ApiRequest/QueryParams.hs#L282-L284
 
-import { SimplifyDeep } from '../types'
+import { SimplifyDeep } from '../types/types'
 import { JsonPathToAccessor } from './utils'
 
 /**

packages/core/postgrest-js/src/select-query-parser/result.ts

@@ -1,5 +1,3 @@
-import { ClientServerOptions, GenericTable } from '../types'
-import { ContainsNull, GenericRelationship, PostgreSQLTypes } from './types'
 import { Ast, ParseQuery } from './parser'
 import {
   AggregateFunctions,
@@ -9,6 +7,11 @@ import {
   Prettify,
   TablesAndViews,
   TypeScriptTypes,
+  ContainsNull,
+  GenericRelationship,
+  PostgreSQLTypes,
+  GenericTable,
+  ClientServerOptions,
 } from './types'
 import {
   CheckDuplicateEmbededReference,
@@ -366,7 +369,7 @@ export type ProcessEmbeddedResource<
   ResolveRelationship<Schema, Relationships, Field, CurrentTableOrView> extends infer Resolved
     ? Resolved extends {
         referencedTable: Pick<GenericTable, 'Row' | 'Relationships'>
-        relation: GenericRelationship & { match: 'refrel' | 'col' | 'fkname' }
+        relation: GenericRelationship & { match: 'refrel' | 'col' | 'fkname' | 'func' }
         direction: string
       }
       ? ProcessEmbeddedResourceResult<ClientOptions, Schema, Resolved, Field, CurrentTableOrView>
@@ -385,7 +388,12 @@ type ProcessEmbeddedResourceResult<
   Schema extends GenericSchema,
   Resolved extends {
     referencedTable: Pick<GenericTable, 'Row' | 'Relationships'>
-    relation: GenericRelationship & { match: 'refrel' | 'col' | 'fkname' }
+    relation: GenericRelationship & {
+      match: 'refrel' | 'col' | 'fkname' | 'func'
+      isNotNullable?: boolean
+      referencedRelation: string
+      isSetofReturn?: boolean
+    }
     direction: string
   },
   Field extends Ast.FieldNode,
@@ -395,7 +403,11 @@ type ProcessEmbeddedResourceResult<
     ClientOptions,
     Schema,
     Resolved['referencedTable']['Row'],
-    Field['name'],
+    // For embeded function selection, the source of truth is the 'referencedRelation'
+    // coming from the SetofOptions.to parameter
+    Resolved['relation']['match'] extends 'func'
+      ? Resolved['relation']['referencedRelation']
+      : Field['name'],
     Resolved['referencedTable']['Relationships'],
     Field['children'] extends undefined
       ? []
@@ -410,7 +422,18 @@ type ProcessEmbeddedResourceResult<
               ? ProcessedChildren
               : ProcessedChildren[]
             : Resolved['relation']['isOneToOne'] extends true
-              ? ProcessedChildren | null
+              ? Resolved['relation']['match'] extends 'func'
+                ? Resolved['relation']['isNotNullable'] extends true
+                  ? Resolved['relation']['isSetofReturn'] extends true
+                    ? ProcessedChildren
+                    : // TODO: This shouldn't be necessary but is due in an inconsitency in PostgREST v12/13 where if a function
+                      // is declared with RETURNS <table-name> instead of RETURNS SETOF <table-name> ROWS 1
+                      // In case where there is no object matching the relations, the object will be returned with all the properties within it
+                      // set to null, we mimic this buggy behavior for type safety an issue is opened on postgREST here:
+                      // https://github.com/PostgREST/postgrest/issues/4234
+                      { [P in keyof ProcessedChildren]: ProcessedChildren[P] | null }
+                  : ProcessedChildren | null
+                : ProcessedChildren | null
               : ProcessedChildren[]
           : // If the relation is a self-reference it'll always be considered as reverse relationship
             Resolved['relation']['referencedRelation'] extends CurrentTableOrView