Merge pull request #597 from supabase/fix/issue-1354-type-instanciation-error

fix(types): type instantiation is excessively deep and possibly infinite

Author: avallete

package-lock.json

@@ -59,8 +59,9 @@
     "ts-expect": "^1.3.0",
     "ts-jest": "^28.0.3",
     "tsd": "^0.31.2",
+    "type-fest": "^4.32.0",
     "typedoc": "^0.22.16",
-    "typescript": "4.5.5",
+    "typescript": "^4.5.5",
     "wait-for-localhost-cli": "^3.0.0"
   }
 }

package.json

@@ -1,4 +1,5 @@
 import PostgrestTransformBuilder from './PostgrestTransformBuilder'
+import { JsonPathToAccessor, JsonPathToType } from './select-query-parser/utils'
 import { GenericSchema } from './types'
 
 type FilterOperator =
@@ -25,6 +26,10 @@ type FilterOperator =
   | 'phfts'
   | 'wfts'
 
+export type IsStringOperator<Path extends string> = Path extends `${string}->>${string}`
+  ? true
+  : false
+
 // Match relationship filters with `table.column` syntax and resolve underlying
 // column value. If not matched, fallback to generic type.
 // TODO: Validate the relationship itself ala select-query-parser. Currently we
@@ -40,6 +45,14 @@ type ResolveFilterValue<
     : ResolveFilterRelationshipValue<Schema, RelationshipTable, Remainder>
   : ColumnName extends keyof Row
   ? Row[ColumnName]
+  : // If the column selection is a jsonpath like `data->value` or `data->>value` we attempt to match
+  // the expected type with the parsed custom json type
+  IsStringOperator<ColumnName> extends true
+  ? string
+  : JsonPathToType<Row, JsonPathToAccessor<ColumnName>> extends infer JsonPathValue
+  ? JsonPathValue extends never
+    ? never
+    : JsonPathValue
   : never
 
 type ResolveFilterRelationshipValue<
@@ -75,7 +88,12 @@ export default class PostgrestFilterBuilder<
     column: ColumnName,
     value: ResolveFilterValue<Schema, Row, ColumnName> extends never
       ? NonNullable<unknown>
-      : NonNullable<ResolveFilterValue<Schema, Row, ColumnName>>
+      : // We want to infer the type before wrapping it into a `NonNullable` to avoid too deep
+      // type resolution error
+      ResolveFilterValue<Schema, Row, ColumnName> extends infer ResolvedFilterValue
+      ? NonNullable<ResolvedFilterValue>
+      : // We should never enter this case as all the branches are covered above
+        never
   ): this {
     this.url.searchParams.append(column, `eq.${value}`)
     return this
@@ -91,7 +109,9 @@ export default class PostgrestFilterBuilder<
     column: ColumnName,
     value: ResolveFilterValue<Schema, Row, ColumnName> extends never
       ? unknown
-      : ResolveFilterValue<Schema, Row, ColumnName>
+      : ResolveFilterValue<Schema, Row, ColumnName> extends infer ResolvedFilterValue
+      ? ResolvedFilterValue
+      : never
   ): this {
     this.url.searchParams.append(column, `neq.${value}`)
     return this
@@ -269,9 +289,16 @@ export default class PostgrestFilterBuilder<
    */
   in<ColumnName extends string>(
     column: ColumnName,
-    values: ResolveFilterValue<Schema, Row, ColumnName> extends never
-      ? unknown[]
-      : ReadonlyArray<ResolveFilterValue<Schema, Row, ColumnName>>
+    values: ReadonlyArray<
+      ResolveFilterValue<Schema, Row, ColumnName> extends never
+        ? unknown
+        : // We want to infer the type before wrapping it into a `NonNullable` to avoid too deep
+        // type resolution error
+        ResolveFilterValue<Schema, Row, ColumnName> extends infer ResolvedFilterValue
+        ? ResolvedFilterValue
+        : // We should never enter this case as all the branches are covered above
+          never
+    >
   ): this {
     const cleanedValues = Array.from(new Set(values))
       .map((s) => {