refactor(postgrest): isolate and share types using symlink

Author: avallete

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

@@ -2,21 +2,20 @@
 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'
 
 export default abstract class PostgrestBuilder<
   ClientOptions extends ClientServerOptions,
   Result,
-  ThrowOnError extends boolean = false,
+  ThrowOnError extends boolean = false
 > implements
     PromiseLike<
       ThrowOnError extends true ? PostgrestResponseSuccess<Result> : PostgrestSingleResponse<Result>
@@ -85,7 +84,7 @@ export default abstract class PostgrestBuilder<
     TResult1 = ThrowOnError extends true
       ? PostgrestResponseSuccess<Result>
       : PostgrestSingleResponse<Result>,
-    TResult2 = never,
+    TResult2 = never
   >(
     onfulfilled?:
       | ((
@@ -275,7 +274,7 @@ export default abstract class PostgrestBuilder<
    */
   overrideTypes<
     NewResult,
-    Options extends { merge?: boolean } = { merge: true },
+    Options extends { merge?: boolean } = { merge: true }
   >(): PostgrestBuilder<
     ClientOptions,
     IsValidResultOverride<Result, NewResult, false, false> extends true

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

@@ -1,11 +1,7 @@
 import PostgrestQueryBuilder from './PostgrestQueryBuilder'
 import PostgrestFilterBuilder from './PostgrestFilterBuilder'
-import {
-  Fetch,
-  GenericSchema,
-  ClientServerOptions,
-  GetRpcFunctionFilterBuilderByArgs,
-} from './types'
+import { Fetch, GenericSchema, ClientServerOptions } from './types/common/common'
+import { GetRpcFunctionFilterBuilderByArgs } from './types/common/rpc'
 
 /**
  * PostgREST client.
@@ -36,7 +32,7 @@ export default class PostgrestClient<
     '__InternalSupabase'
   >[SchemaName] extends GenericSchema
     ? Omit<Database, '__InternalSupabase'>[SchemaName]
-    : any,
+    : any
 > {
   url: string
   headers: Headers
@@ -72,7 +68,7 @@ export default class PostgrestClient<
   }
   from<
     TableName extends string & keyof Schema['Tables'],
-    Table extends Schema['Tables'][TableName],
+    Table extends Schema['Tables'][TableName]
   >(relation: TableName): PostgrestQueryBuilder<ClientOptions, Schema, Table, TableName>
   from<ViewName extends string & keyof Schema['Views'], View extends Schema['Views'][ViewName]>(
     relation: ViewName
@@ -143,7 +139,7 @@ export default class PostgrestClient<
       Schema,
       FnName,
       Args
-    > = GetRpcFunctionFilterBuilderByArgs<Schema, FnName, Args>,
+    > = GetRpcFunctionFilterBuilderByArgs<Schema, FnName, Args>
   >(
     fn: FnName,
     args: Args = {} as Args,

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'
@@ -38,27 +38,27 @@ export type IsStringOperator<Path extends string> = Path extends `${string}->>${
 type ResolveFilterValue<
   Schema extends GenericSchema,
   Row extends Record<string, unknown>,
-  ColumnName extends string,
+  ColumnName extends string
 > = ColumnName extends `${infer RelationshipTable}.${infer Remainder}`
   ? Remainder extends `${infer _}.${infer _}`
     ? ResolveFilterValue<Schema, Row, Remainder>
     : 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
+  ? 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<
   Schema extends GenericSchema,
   RelationshipTable extends string,
-  RelationshipColumn extends string,
+  RelationshipColumn extends string
 > = Schema['Tables'] & Schema['Views'] extends infer TablesAndViews
   ? RelationshipTable extends keyof TablesAndViews
     ? 'Row' extends keyof TablesAndViews[RelationshipTable]
@@ -78,7 +78,7 @@ export default class PostgrestFilterBuilder<
   Result,
   RelationName = unknown,
   Relationships = unknown,
-  Method = unknown,
+  Method = unknown
 > extends PostgrestTransformBuilder<
   ClientOptions,
   Schema,
@@ -101,11 +101,11 @@ export default class PostgrestFilterBuilder<
     value: ResolveFilterValue<Schema, Row, ColumnName> extends never
       ? NonNullable<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
-        ? NonNullable<ResolvedFilterValue>
-        : // We should never enter this case as all the branches are covered above
-          never
+      // 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
@@ -122,8 +122,8 @@ export default class PostgrestFilterBuilder<
     value: ResolveFilterValue<Schema, Row, ColumnName> extends never
       ? unknown
       : ResolveFilterValue<Schema, Row, ColumnName> extends infer ResolvedFilterValue
-        ? ResolvedFilterValue
-        : never
+      ? ResolvedFilterValue
+      : never
   ): this {
     this.url.searchParams.append(column, `neq.${value}`)
     return this
@@ -305,11 +305,11 @@ export default class PostgrestFilterBuilder<
       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
+        // 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))

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

@@ -1,13 +1,19 @@
 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,
   Schema extends GenericSchema,
   Relation extends GenericTable | GenericView,
   RelationName = unknown,
-  Relationships = Relation extends { Relationships: infer R } ? R : unknown,
+  Relationships = Relation extends { Relationships: infer R } ? R : unknown
 > {
   url: URL
   headers: Headers
@@ -63,7 +69,7 @@ export default class PostgrestQueryBuilder<
       Relationships,
       Query,
       ClientOptions
-    >,
+    >
   >(
     columns?: Query,
     options?: {

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

@@ -1,12 +1,8 @@
 import PostgrestBuilder from './PostgrestBuilder'
 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,
@@ -15,7 +11,7 @@ export default class PostgrestTransformBuilder<
   Result,
   RelationName = unknown,
   Relationships = unknown,
-  Method = unknown,
+  Method = unknown
 > extends PostgrestBuilder<ClientOptions, Result> {
   /**
    * Perform a SELECT on the query result.
@@ -28,7 +24,7 @@ export default class PostgrestTransformBuilder<
    */
   select<
     Query extends string = '*',
-    NewResultOne = GetResult<Schema, Row, RelationName, Relationships, Query, ClientOptions>,
+    NewResultOne = GetResult<Schema, Row, RelationName, Relationships, Query, ClientOptions>
   >(
     columns?: Query
   ): PostgrestFilterBuilder<
@@ -226,7 +222,7 @@ export default class PostgrestTransformBuilder<
    * this returns an error.
    */
   maybeSingle<
-    ResultOne = Result extends (infer ResultOne)[] ? ResultOne : never,
+    ResultOne = Result extends (infer ResultOne)[] ? ResultOne : never
   >(): PostgrestBuilder<ClientOptions, ResultOne | null> {
     // Temporary partial fix for https://github.com/supabase/postgrest-js/issues/361
     // Issue persists e.g. for `.insert([...]).select().maybeSingle()`

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

@@ -28,9 +28,8 @@ export type {
   PostgrestResponseSuccess,
   PostgrestSingleResponse,
   PostgrestMaybeSingleResponse,
-  ClientServerOptions as PostgrestClientOptions,
-  GetRpcFunctionFilterBuilderByArgs,
-} 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'