Merge branch 'master' into query-parser-cleanup

Author: bnjmnt4n

package-lock.json

@@ -59,19 +59,19 @@ export default class PostgrestClient<
   from<
     TableName extends string & keyof Schema['Tables'],
     Table extends Schema['Tables'][TableName]
-  >(relation: TableName): PostgrestQueryBuilder<Schema, Table>
+  >(relation: TableName): PostgrestQueryBuilder<Schema, Table, TableName>
   from<ViewName extends string & keyof Schema['Views'], View extends Schema['Views'][ViewName]>(
     relation: ViewName
-  ): PostgrestQueryBuilder<Schema, View>
-  from(relation: string): PostgrestQueryBuilder<Schema, any>
+  ): PostgrestQueryBuilder<Schema, View, ViewName>
+  from(relation: string): PostgrestQueryBuilder<Schema, any, any>
   /**
    * Perform a query on a table or a view.
    *
    * @param relation - The table or view name to query
    */
-  from(relation: string): PostgrestQueryBuilder<Schema, any> {
+  from(relation: string): PostgrestQueryBuilder<Schema, any, any> {
     const url = new URL(`${this.url}/${relation}`)
-    return new PostgrestQueryBuilder<Schema, any>(url, {
+    return new PostgrestQueryBuilder(url, {
       headers: { ...this.headers },
       schema: this.schemaName,
       fetch: this.fetch,
@@ -92,11 +92,7 @@ export default class PostgrestClient<
     DynamicSchema,
     Database[DynamicSchema] extends GenericSchema ? Database[DynamicSchema] : any
   > {
-    return new PostgrestClient<
-      Database,
-      DynamicSchema,
-      Database[DynamicSchema] extends GenericSchema ? Database[DynamicSchema] : any
-    >(this.url, {
+    return new PostgrestClient(this.url, {
       headers: this.headers,
       schema,
       fetch: this.fetch,

src/PostgrestClient.ts

@@ -29,8 +29,9 @@ export default class PostgrestFilterBuilder<
   Schema extends GenericSchema,
   Row extends Record<string, unknown>,
   Result,
+  RelationName = unknown,
   Relationships = unknown
-> extends PostgrestTransformBuilder<Schema, Row, Result, Relationships> {
+> extends PostgrestTransformBuilder<Schema, Row, Result, RelationName, Relationships> {
   eq<ColumnName extends string & keyof Row>(
     column: ColumnName,
     value: NonNullable<Row[ColumnName]>

src/PostgrestFilterBuilder.ts

@@ -6,6 +6,7 @@ import { Fetch, GenericSchema, GenericTable, GenericView } from './types'
 export default class PostgrestQueryBuilder<
   Schema extends GenericSchema,
   Relation extends GenericTable | GenericView,
+  RelationName = unknown,
   Relationships = Relation extends { Relationships: infer R } ? R : unknown
 > {
   url: URL
@@ -55,7 +56,7 @@ export default class PostgrestQueryBuilder<
    */
   select<
     Query extends string = '*',
-    ResultOne = GetResult<Schema, Relation['Row'], Relationships, Query>
+    ResultOne = GetResult<Schema, Relation['Row'], RelationName, Relationships, Query>
   >(
     columns?: Query,
     {
@@ -65,7 +66,7 @@ export default class PostgrestQueryBuilder<
       head?: boolean
       count?: 'exact' | 'planned' | 'estimated'
     } = {}
-  ): PostgrestFilterBuilder<Schema, Relation['Row'], ResultOne[], Relationships> {
+  ): PostgrestFilterBuilder<Schema, Relation['Row'], ResultOne[], RelationName, Relationships> {
     const method = head ? 'HEAD' : 'GET'
     // Remove whitespaces except when quoted
     let quoted = false
@@ -102,14 +103,14 @@ export default class PostgrestQueryBuilder<
     options?: {
       count?: 'exact' | 'planned' | 'estimated'
     }
-  ): PostgrestFilterBuilder<Schema, Relation['Row'], null, Relationships>
+  ): PostgrestFilterBuilder<Schema, Relation['Row'], null, RelationName, Relationships>
   insert<Row extends Relation extends { Insert: unknown } ? Relation['Insert'] : never>(
     values: Row[],
     options?: {
       count?: 'exact' | 'planned' | 'estimated'
       defaultToNull?: boolean
     }
-  ): PostgrestFilterBuilder<Schema, Relation['Row'], null, Relationships>
+  ): PostgrestFilterBuilder<Schema, Relation['Row'], null, RelationName, Relationships>
   /**
    * Perform an INSERT into the table or view.
    *
@@ -145,7 +146,7 @@ export default class PostgrestQueryBuilder<
       count?: 'exact' | 'planned' | 'estimated'
       defaultToNull?: boolean
     } = {}
-  ): PostgrestFilterBuilder<Schema, Relation['Row'], null, Relationships> {
+  ): PostgrestFilterBuilder<Schema, Relation['Row'], null, RelationName, Relationships> {
     const method = 'POST'
 
     const prefersHeaders = []
@@ -187,7 +188,7 @@ export default class PostgrestQueryBuilder<
       ignoreDuplicates?: boolean
       count?: 'exact' | 'planned' | 'estimated'
     }
-  ): PostgrestFilterBuilder<Schema, Relation['Row'], null, Relationships>
+  ): PostgrestFilterBuilder<Schema, Relation['Row'], null, RelationName, Relationships>
   upsert<Row extends Relation extends { Insert: unknown } ? Relation['Insert'] : never>(
     values: Row[],
     options?: {
@@ -196,7 +197,7 @@ export default class PostgrestQueryBuilder<
       count?: 'exact' | 'planned' | 'estimated'
       defaultToNull?: boolean
     }
-  ): PostgrestFilterBuilder<Schema, Relation['Row'], null, Relationships>
+  ): PostgrestFilterBuilder<Schema, Relation['Row'], null, RelationName, Relationships>
   /**
    * Perform an UPSERT on the table or view. Depending on the column(s) passed
    * to `onConflict`, `.upsert()` allows you to perform the equivalent of
@@ -248,7 +249,7 @@ export default class PostgrestQueryBuilder<
       count?: 'exact' | 'planned' | 'estimated'
       defaultToNull?: boolean
     } = {}
-  ): PostgrestFilterBuilder<Schema, Relation['Row'], null, Relationships> {
+  ): PostgrestFilterBuilder<Schema, Relation['Row'], null, RelationName, Relationships> {
     const method = 'POST'
 
     const prefersHeaders = [`resolution=${ignoreDuplicates ? 'ignore' : 'merge'}-duplicates`]
@@ -312,7 +313,7 @@ export default class PostgrestQueryBuilder<
     }: {
       count?: 'exact' | 'planned' | 'estimated'
     } = {}
-  ): PostgrestFilterBuilder<Schema, Relation['Row'], null, Relationships> {
+  ): PostgrestFilterBuilder<Schema, Relation['Row'], null, RelationName, Relationships> {
     const method = 'PATCH'
     const prefersHeaders = []
     if (this.headers['Prefer']) {
@@ -357,7 +358,7 @@ export default class PostgrestQueryBuilder<
     count,
   }: {
     count?: 'exact' | 'planned' | 'estimated'
-  } = {}): PostgrestFilterBuilder<Schema, Relation['Row'], null, Relationships> {
+  } = {}): PostgrestFilterBuilder<Schema, Relation['Row'], null, RelationName, Relationships> {
     const method = 'DELETE'
     const prefersHeaders = []
     if (count) {

src/PostgrestQueryBuilder.ts

@@ -6,6 +6,7 @@ export default class PostgrestTransformBuilder<
   Schema extends GenericSchema,
   Row extends Record<string, unknown>,
   Result,
+  RelationName = unknown,
   Relationships = unknown
 > extends PostgrestBuilder<Result> {
   /**
@@ -17,9 +18,12 @@ export default class PostgrestTransformBuilder<
    *
    * @param columns - The columns to retrieve, separated by commas
    */
-  select<Query extends string = '*', NewResultOne = GetResult<Schema, Row, Relationships, Query>>(
+  select<
+    Query extends string = '*',
+    NewResultOne = GetResult<Schema, Row, RelationName, Relationships, Query>
+  >(
     columns?: Query
-  ): PostgrestTransformBuilder<Schema, Row, NewResultOne[], Relationships> {
+  ): PostgrestTransformBuilder<Schema, Row, NewResultOne[], RelationName, Relationships> {
     // Remove whitespaces except when quoted
     let quoted = false
     const cleanedColumns = (columns ?? '*')
@@ -39,7 +43,13 @@ export default class PostgrestTransformBuilder<
       this.headers['Prefer'] += ','
     }
     this.headers['Prefer'] += 'return=representation'
-    return this as unknown as PostgrestTransformBuilder<Schema, Row, NewResultOne[], Relationships>
+    return this as unknown as PostgrestTransformBuilder<
+      Schema,
+      Row,
+      NewResultOne[],
+      RelationName,
+      Relationships
+    >
   }
 
   order<ColumnName extends string & keyof Row>(
@@ -224,6 +234,10 @@ export default class PostgrestTransformBuilder<
   /**
    * Return `data` as the EXPLAIN plan for the query.
    *
+   * You need to enable the
+   * [db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)
+   * setting before using this method.
+   *
    * @param options - Named parameters
    *
    * @param options.analyze - If `true`, the query will be executed and the
@@ -267,7 +281,7 @@ export default class PostgrestTransformBuilder<
       .filter(Boolean)
       .join('|')
     // An Accept header can carry multiple media types but postgrest-js always sends one
-    const forMediatype = this.headers['Accept']
+    const forMediatype = this.headers['Accept'] ?? 'application/json'
     this.headers[
       'Accept'
     ] = `application/vnd.pgrst.plan+${format}; for="${forMediatype}"; options=${options};`
@@ -294,7 +308,19 @@ export default class PostgrestTransformBuilder<
    *
    * @typeParam NewResult - The new result type to override with
    */
-  returns<NewResult>(): PostgrestTransformBuilder<Schema, Row, NewResult, Relationships> {
-    return this as unknown as PostgrestTransformBuilder<Schema, Row, NewResult, Relationships>
+  returns<NewResult>(): PostgrestTransformBuilder<
+    Schema,
+    Row,
+    NewResult,
+    RelationName,
+    Relationships
+  > {
+    return this as unknown as PostgrestTransformBuilder<
+      Schema,
+      Row,
+      NewResult,
+      RelationName,
+      Relationships
+    >
   }
 }

src/PostgrestTransformBuilder.ts

@@ -76,6 +76,16 @@ type HasFKey<FKeyName, Relationships> = Relationships extends [infer R]
     : HasFKey<FKeyName, Rest>
   : false
 
+type HasUniqueFKey<FKeyName, Relationships> = Relationships extends [infer R]
+  ? R extends { foreignKeyName: FKeyName; isOneToOne: true }
+    ? true
+    : false
+  : Relationships extends [infer R, ...infer Rest]
+  ? HasUniqueFKey<FKeyName, [R]> extends true
+    ? true
+    : HasUniqueFKey<FKeyName, Rest>
+  : false
+
 /**
  * Returns a boolean representing whether there is a foreign key referencing
  * a given relation.
@@ -90,6 +100,16 @@ type HasFKeyToFRel<FRelName, Relationships> = Relationships extends [infer R]
     : HasFKeyToFRel<FRelName, Rest>
   : false
 
+type HasUniqueFKeyToFRel<FRelName, Relationships> = Relationships extends [infer R]
+  ? R extends { referencedRelation: FRelName; isOneToOne: true }
+    ? true
+    : false
+  : Relationships extends [infer R, ...infer Rest]
+  ? HasUniqueFKeyToFRel<FRelName, [R]> extends true
+    ? true
+    : HasUniqueFKeyToFRel<FRelName, Rest>
+  : false
+
 /**
  * Constructs a type definition for a single field of an object.
  *
@@ -101,6 +121,7 @@ type HasFKeyToFRel<FRelName, Relationships> = Relationships extends [infer R]
 type ConstructFieldDefinition<
   Schema extends GenericSchema,
   Row extends Record<string, unknown>,
+  RelationName,
   Relationships,
   Field
 > = Field extends { star: true }
@@ -110,13 +131,24 @@ type ConstructFieldDefinition<
       [_ in Field['name']]: GetResultHelper<
         Schema,
         (Schema['Tables'] & Schema['Views'])[Field['original']]['Row'],
+        Field['original'],
         (Schema['Tables'] & Schema['Views'])[Field['original']] extends { Relationships: infer R }
           ? R
           : unknown,
         Field['children'],
         unknown
       > extends infer Child
-        ? Relationships extends unknown[]
+        ? // One-to-one relationship - referencing column(s) has unique/pkey constraint.
+          HasUniqueFKey<
+            Field['hint'],
+            (Schema['Tables'] & Schema['Views'])[Field['original']] extends {
+              Relationships: infer R
+            }
+              ? R
+              : unknown
+          > extends true
+          ? Child | null
+          : Relationships extends unknown[]
           ? HasFKey<Field['hint'], Relationships> extends true
             ? Child | null
             : Child[]
@@ -128,13 +160,24 @@ type ConstructFieldDefinition<
       [_ in Field['name']]: GetResultHelper<
         Schema,
         (Schema['Tables'] & Schema['Views'])[Field['original']]['Row'],
+        Field['original'],
         (Schema['Tables'] & Schema['Views'])[Field['original']] extends { Relationships: infer R }
           ? R
           : unknown,
         Field['children'],
         unknown
       > extends infer Child
-        ? Relationships extends unknown[]
+        ? // One-to-one relationship - referencing column(s) has unique/pkey constraint.
+          HasUniqueFKeyToFRel<
+            RelationName,
+            (Schema['Tables'] & Schema['Views'])[Field['original']] extends {
+              Relationships: infer R
+            }
+              ? R
+              : unknown
+          > extends true
+          ? Child | null
+          : Relationships extends unknown[]
           ? HasFKeyToFRel<Field['original'], Relationships> extends true
             ? Child | null
             : Child[]
@@ -372,28 +415,35 @@ type ParseQuery<Query extends string> = string extends Query
 type GetResultHelper<
   Schema extends GenericSchema,
   Row extends Record<string, unknown>,
+  RelationName,
   Relationships,
   Fields extends unknown[],
   Acc
 > = Fields extends [infer R]
-  ? ConstructFieldDefinition<Schema, Row, Relationships, R> extends SelectQueryError<infer E>
+  ? ConstructFieldDefinition<Schema, Row, RelationName, Relationships, R> extends SelectQueryError<
+      infer E
+    >
     ? SelectQueryError<E>
     : GetResultHelper<
         Schema,
         Row,
+        RelationName,
         Relationships,
         [],
-        ConstructFieldDefinition<Schema, Row, Relationships, R> & Acc
+        ConstructFieldDefinition<Schema, Row, RelationName, Relationships, R> & Acc
       >
   : Fields extends [infer R, ...infer Rest]
-  ? ConstructFieldDefinition<Schema, Row, Relationships, R> extends SelectQueryError<infer E>
+  ? ConstructFieldDefinition<Schema, Row, RelationName, Relationships, R> extends SelectQueryError<
+      infer E
+    >
     ? SelectQueryError<E>
     : GetResultHelper<
         Schema,
         Row,
+        RelationName,
         Relationships,
         Rest,
-        ConstructFieldDefinition<Schema, Row, Relationships, R> & Acc
+        ConstructFieldDefinition<Schema, Row, RelationName, Relationships, R> & Acc
       >
   : Prettify<Acc>
 
@@ -408,8 +458,9 @@ type GetResultHelper<
 export type GetResult<
   Schema extends GenericSchema,
   Row extends Record<string, unknown>,
+  RelationName,
   Relationships,
   Query extends string
 > = ParseQuery<Query> extends unknown[]
-  ? GetResultHelper<Schema, Row, Relationships, ParseQuery<Query>, unknown>
+  ? GetResultHelper<Schema, Row, RelationName, Relationships, ParseQuery<Query>, unknown>
   : ParseQuery<Query>

src/select-query-parser.ts

@@ -25,6 +25,11 @@ CREATE TABLE public.channels (
 ALTER TABLE public.users REPLICA IDENTITY FULL; -- Send "previous data" to supabase
 COMMENT ON COLUMN public.channels.data IS 'For unstructured data and prototyping.';
 
+create table public.channel_details (
+  id bigint primary key references channels(id),
+  details text default null
+);
+
 -- MESSAGES
 CREATE TABLE public.messages (
   id bigint GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY,

test/db/00-schema.sql

@@ -3,7 +3,7 @@
 version: '3'
 services:
   rest:
-    image: postgrest/postgrest:v11.0.0
+    image: postgrest/postgrest:v11.2.2
     ports:
       - '3000:3000'
     environment: