Fixed type issues with joins with certain variations of tsconfig (fixes #4535, #4457) (#4603)

Sukairo-02 · web-flow · commit 50a8b163e620 · 2025-06-04T09:50:02.000+03:00
diff --git a/changelogs/drizzle-orm/0.44.2.md b/changelogs/drizzle-orm/0.44.2.md
@@ -0,0 +1 @@
+- [BUG]: Fixed type issues with joins with certain variations of `tsconfig`: [#4535](https://github.com/drizzle-team/drizzle-orm/issues/4535), [#4457](https://github.com/drizzle-team/drizzle-orm/issues/4457)
diff --git a/drizzle-orm/package.json b/drizzle-orm/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "drizzle-orm",
-	"version": "0.44.1",
+	"version": "0.44.2",
 	"description": "Drizzle ORM package for SQL databases",
 	"type": "module",
 	"scripts": {
diff --git a/drizzle-orm/src/gel-core/query-builders/select.ts b/drizzle-orm/src/gel-core/query-builders/select.ts
@@ -41,6 +41,7 @@ import type {
 	CreateGelSelectFromBuilderMode,
 	GelCreateSetOperatorFn,
 	GelSelectConfig,
+	GelSelectCrossJoinFn,
 	GelSelectDynamic,
 	GelSelectHKT,
 	GelSelectHKTBase,
@@ -224,8 +225,10 @@ export abstract class GelSelectQueryBuilderBase<
 	>(
 		joinType: TJoinType,
 		lateral: TIsLateral,
-	): GelSelectJoinFn<this, TDynamic, TJoinType, TIsLateral> {
-		return (
+	): 'cross' extends TJoinType ? GelSelectCrossJoinFn<this, TDynamic, TIsLateral>
+		: GelSelectJoinFn<this, TDynamic, TJoinType, TIsLateral>
+	{
+		return ((
 			table: GelTable | Subquery | GelViewBase | SQL,
 			on?: ((aliases: TSelection) => SQL | undefined) | SQL | undefined,
 		) => {
@@ -300,7 +303,7 @@ export abstract class GelSelectQueryBuilderBase<
 			}
 
 			return this as any;
-		};
+		}) as any;
 	}
 
 	/**
diff --git a/drizzle-orm/src/gel-core/query-builders/select.types.ts b/drizzle-orm/src/gel-core/query-builders/select.types.ts
@@ -113,17 +113,22 @@ export type GelSelectJoinFn<
 	TDynamic extends boolean,
 	TJoinType extends JoinType,
 	TIsLateral extends boolean,
-> = 'cross' extends TJoinType ? <
-		TJoinedTable extends (TIsLateral extends true ? Subquery | SQL : GelTable | Subquery | GelViewBase | SQL),
-		TJoinedName extends GetSelectTableName<TJoinedTable> = GetSelectTableName<TJoinedTable>,
-	>(table: TJoinedTable) => GelSelectJoin<T, TDynamic, TJoinType, TJoinedTable, TJoinedName>
-	: <
-		TJoinedTable extends (TIsLateral extends true ? Subquery | SQL : GelTable | Subquery | GelViewBase | SQL),
-		TJoinedName extends GetSelectTableName<TJoinedTable> = GetSelectTableName<TJoinedTable>,
-	>(
-		table: TJoinedTable,
-		on: ((aliases: T['_']['selection']) => SQL | undefined) | SQL | undefined,
-	) => GelSelectJoin<T, TDynamic, TJoinType, TJoinedTable, TJoinedName>;
+> = <
+	TJoinedTable extends (TIsLateral extends true ? Subquery | SQL : GelTable | Subquery | GelViewBase | SQL),
+	TJoinedName extends GetSelectTableName<TJoinedTable> = GetSelectTableName<TJoinedTable>,
+>(
+	table: TJoinedTable,
+	on: ((aliases: T['_']['selection']) => SQL | undefined) | SQL | undefined,
+) => GelSelectJoin<T, TDynamic, TJoinType, TJoinedTable, TJoinedName>;
+
+export type GelSelectCrossJoinFn<
+	T extends AnyGelSelectQueryBuilder,
+	TDynamic extends boolean,
+	TIsLateral extends boolean,
+> = <
+	TJoinedTable extends (TIsLateral extends true ? Subquery | SQL : GelTable | Subquery | GelViewBase | SQL),
+	TJoinedName extends GetSelectTableName<TJoinedTable> = GetSelectTableName<TJoinedTable>,
+>(table: TJoinedTable) => GelSelectJoin<T, TDynamic, 'cross', TJoinedTable, TJoinedName>;
 
 export type SelectedFieldsFlat = SelectedFieldsFlatBase<GelColumn>;
 
diff --git a/drizzle-orm/src/mysql-core/query-builders/select.ts b/drizzle-orm/src/mysql-core/query-builders/select.ts
@@ -34,6 +34,7 @@ import type {
 	LockConfig,
 	LockStrength,
 	MySqlCreateSetOperatorFn,
+	MySqlCrossJoinFn,
 	MySqlJoinFn,
 	MySqlJoinType,
 	MySqlSelectConfig,
@@ -237,7 +238,9 @@ export abstract class MySqlSelectQueryBuilderBase<
 	>(
 		joinType: TJoinType,
 		lateral: TIsLateral,
-	): MySqlJoinFn<this, TDynamic, TJoinType, TIsLateral> {
+	): 'cross' extends TJoinType ? MySqlCrossJoinFn<this, TDynamic, TIsLateral>
+		: MySqlJoinFn<this, TDynamic, TJoinType, TIsLateral>
+	{
 		return <
 			TJoinedTable extends MySqlTable | Subquery | MySqlViewBase | SQL,
 		>(
diff --git a/drizzle-orm/src/mysql-core/query-builders/select.types.ts b/drizzle-orm/src/mysql-core/query-builders/select.types.ts
@@ -119,27 +119,32 @@ export type MySqlJoinFn<
 	TDynamic extends boolean,
 	TJoinType extends MySqlJoinType,
 	TIsLateral extends boolean,
-> = 'cross' extends TJoinType ? <
-		TJoinedTable extends (TIsLateral extends true ? Subquery | SQL : MySqlTable | Subquery | MySqlViewBase | SQL),
-		TJoinedName extends GetSelectTableName<TJoinedTable> = GetSelectTableName<TJoinedTable>,
-	>(
-		table: TJoinedTable,
-		onIndex?:
-			| (TJoinedTable extends MySqlTable ? IndexConfig
-				: 'Index hint configuration is allowed only for MySqlTable and not for subqueries or views')
-			| undefined,
-	) => MySqlJoin<T, TDynamic, TJoinType, TJoinedTable, TJoinedName>
-	: <
-		TJoinedTable extends (TIsLateral extends true ? Subquery | SQL : MySqlTable | Subquery | MySqlViewBase | SQL),
-		TJoinedName extends GetSelectTableName<TJoinedTable> = GetSelectTableName<TJoinedTable>,
-	>(
-		table: TJoinedTable,
-		on: ((aliases: T['_']['selection']) => SQL | undefined) | SQL | undefined,
-		onIndex?:
-			| (TJoinedTable extends MySqlTable ? IndexConfig
-				: 'Index hint configuration is allowed only for MySqlTable and not for subqueries or views')
-			| undefined,
-	) => MySqlJoin<T, TDynamic, TJoinType, TJoinedTable, TJoinedName>;
+> = <
+	TJoinedTable extends (TIsLateral extends true ? Subquery | SQL : MySqlTable | Subquery | MySqlViewBase | SQL),
+	TJoinedName extends GetSelectTableName<TJoinedTable> = GetSelectTableName<TJoinedTable>,
+>(
+	table: TJoinedTable,
+	on: ((aliases: T['_']['selection']) => SQL | undefined) | SQL | undefined,
+	onIndex?:
+		| (TJoinedTable extends MySqlTable ? IndexConfig
+			: 'Index hint configuration is allowed only for MySqlTable and not for subqueries or views')
+		| undefined,
+) => MySqlJoin<T, TDynamic, TJoinType, TJoinedTable, TJoinedName>;
+
+export type MySqlCrossJoinFn<
+	T extends AnyMySqlSelectQueryBuilder,
+	TDynamic extends boolean,
+	TIsLateral extends boolean,
+> = <
+	TJoinedTable extends (TIsLateral extends true ? Subquery | SQL : MySqlTable | Subquery | MySqlViewBase | SQL),
+	TJoinedName extends GetSelectTableName<TJoinedTable> = GetSelectTableName<TJoinedTable>,
+>(
+	table: TJoinedTable,
+	onIndex?:
+		| (TJoinedTable extends MySqlTable ? IndexConfig
+			: 'Index hint configuration is allowed only for MySqlTable and not for subqueries or views')
+		| undefined,
+) => MySqlJoin<T, TDynamic, 'cross', TJoinedTable, TJoinedName>;
 
 export type SelectedFieldsFlat = SelectedFieldsFlatBase<MySqlColumn>;
 
diff --git a/drizzle-orm/src/pg-core/query-builders/select.ts b/drizzle-orm/src/pg-core/query-builders/select.ts
@@ -45,6 +45,7 @@ import type {
 	LockStrength,
 	PgCreateSetOperatorFn,
 	PgSelectConfig,
+	PgSelectCrossJoinFn,
 	PgSelectDynamic,
 	PgSelectHKT,
 	PgSelectHKTBase,
@@ -231,7 +232,9 @@ export abstract class PgSelectQueryBuilderBase<
 	>(
 		joinType: TJoinType,
 		lateral: TIsLateral,
-	): PgSelectJoinFn<this, TDynamic, TJoinType, TIsLateral> {
+	): 'cross' extends TJoinType ? PgSelectCrossJoinFn<this, TDynamic, TIsLateral>
+		: PgSelectJoinFn<this, TDynamic, TJoinType, TIsLateral>
+	{
 		return ((
 			table: TIsLateral extends true ? Subquery | SQL : PgTable | Subquery | PgViewBase | SQL,
 			on?: ((aliases: TSelection) => SQL | undefined) | SQL | undefined,
diff --git a/drizzle-orm/src/pg-core/query-builders/select.types.ts b/drizzle-orm/src/pg-core/query-builders/select.types.ts
@@ -117,25 +117,30 @@ export type PgSelectJoinFn<
 	TDynamic extends boolean,
 	TJoinType extends JoinType,
 	TIsLateral extends boolean,
-> = 'cross' extends TJoinType ? <
-		TJoinedTable extends (TIsLateral extends true ? Subquery | SQL : PgTable | Subquery | PgViewBase | SQL),
-		TJoinedName extends GetSelectTableName<TJoinedTable> = GetSelectTableName<TJoinedTable>,
-	>(
-		table: TableLikeHasEmptySelection<TJoinedTable> extends true ? DrizzleTypeError<
-				"Cannot reference a data-modifying statement subquery if it doesn't contain a `returning` clause"
-			>
-			: TJoinedTable,
-	) => PgSelectJoin<T, TDynamic, TJoinType, TJoinedTable, TJoinedName>
-	: <
-		TJoinedTable extends (TIsLateral extends true ? Subquery | SQL : PgTable | Subquery | PgViewBase | SQL),
-		TJoinedName extends GetSelectTableName<TJoinedTable> = GetSelectTableName<TJoinedTable>,
-	>(
-		table: TableLikeHasEmptySelection<TJoinedTable> extends true ? DrizzleTypeError<
-				"Cannot reference a data-modifying statement subquery if it doesn't contain a `returning` clause"
-			>
-			: TJoinedTable,
-		on: ((aliases: T['_']['selection']) => SQL | undefined) | SQL | undefined,
-	) => PgSelectJoin<T, TDynamic, TJoinType, TJoinedTable, TJoinedName>;
+> = <
+	TJoinedTable extends (TIsLateral extends true ? Subquery | SQL : PgTable | Subquery | PgViewBase | SQL),
+	TJoinedName extends GetSelectTableName<TJoinedTable> = GetSelectTableName<TJoinedTable>,
+>(
+	table: TableLikeHasEmptySelection<TJoinedTable> extends true ? DrizzleTypeError<
+			"Cannot reference a data-modifying statement subquery if it doesn't contain a `returning` clause"
+		>
+		: TJoinedTable,
+	on: ((aliases: T['_']['selection']) => SQL | undefined) | SQL | undefined,
+) => PgSelectJoin<T, TDynamic, TJoinType, TJoinedTable, TJoinedName>;
+
+export type PgSelectCrossJoinFn<
+	T extends AnyPgSelectQueryBuilder,
+	TDynamic extends boolean,
+	TIsLateral extends boolean,
+> = <
+	TJoinedTable extends (TIsLateral extends true ? Subquery | SQL : PgTable | Subquery | PgViewBase | SQL),
+	TJoinedName extends GetSelectTableName<TJoinedTable> = GetSelectTableName<TJoinedTable>,
+>(
+	table: TableLikeHasEmptySelection<TJoinedTable> extends true ? DrizzleTypeError<
+			"Cannot reference a data-modifying statement subquery if it doesn't contain a `returning` clause"
+		>
+		: TJoinedTable,
+) => PgSelectJoin<T, TDynamic, 'cross', TJoinedTable, TJoinedName>;
 
 export type SelectedFieldsFlat = SelectedFieldsFlatBase<PgColumn>;
 
diff --git a/drizzle-orm/src/singlestore-core/query-builders/select.ts b/drizzle-orm/src/singlestore-core/query-builders/select.ts
@@ -44,6 +44,7 @@ import type {
 	SelectedFields,
 	SetOperatorRightSelect,
 	SingleStoreCreateSetOperatorFn,
+	SingleStoreCrossJoinFn,
 	SingleStoreJoinFn,
 	SingleStoreSelectConfig,
 	SingleStoreSelectDynamic,
@@ -210,7 +211,9 @@ export abstract class SingleStoreSelectQueryBuilderBase<
 	>(
 		joinType: TJoinType,
 		lateral: TIsLateral,
-	): SingleStoreJoinFn<this, TDynamic, TJoinType, TIsLateral> {
+	): 'cross' extends TJoinType ? SingleStoreCrossJoinFn<this, TDynamic, TIsLateral>
+		: SingleStoreJoinFn<this, TDynamic, TJoinType, TIsLateral>
+	{
 		return (
 			table: SingleStoreTable | Subquery | SQL, // | SingleStoreViewBase
 			on?: ((aliases: TSelection) => SQL | undefined) | SQL | undefined,
diff --git a/drizzle-orm/src/singlestore-core/query-builders/select.types.ts b/drizzle-orm/src/singlestore-core/query-builders/select.types.ts
@@ -111,19 +111,24 @@ export type SingleStoreJoinFn<
 	TDynamic extends boolean,
 	TJoinType extends JoinType,
 	TIsLateral extends boolean,
-> = 'cross' extends TJoinType ? <
-		TJoinedTable extends (TIsLateral extends true ? Subquery | SQL
-			: SingleStoreTable | Subquery | SQL /* | SingleStoreViewBase */),
-		TJoinedName extends GetSelectTableName<TJoinedTable> = GetSelectTableName<TJoinedTable>,
-	>(table: TJoinedTable) => SingleStoreJoin<T, TDynamic, TJoinType, TJoinedTable, TJoinedName>
-	: <
-		TJoinedTable extends (TIsLateral extends true ? Subquery | SQL
-			: SingleStoreTable | Subquery | SQL /* | SingleStoreViewBase */),
-		TJoinedName extends GetSelectTableName<TJoinedTable> = GetSelectTableName<TJoinedTable>,
-	>(
-		table: TJoinedTable,
-		on: ((aliases: T['_']['selection']) => SQL | undefined) | SQL | undefined,
-	) => SingleStoreJoin<T, TDynamic, TJoinType, TJoinedTable, TJoinedName>;
+> = <
+	TJoinedTable extends (TIsLateral extends true ? Subquery | SQL
+		: SingleStoreTable | Subquery | SQL /* | SingleStoreViewBase */),
+	TJoinedName extends GetSelectTableName<TJoinedTable> = GetSelectTableName<TJoinedTable>,
+>(
+	table: TJoinedTable,
+	on: ((aliases: T['_']['selection']) => SQL | undefined) | SQL | undefined,
+) => SingleStoreJoin<T, TDynamic, TJoinType, TJoinedTable, TJoinedName>;
+
+export type SingleStoreCrossJoinFn<
+	T extends AnySingleStoreSelectQueryBuilder,
+	TDynamic extends boolean,
+	TIsLateral extends boolean,
+> = <
+	TJoinedTable extends (TIsLateral extends true ? Subquery | SQL
+		: SingleStoreTable | Subquery | SQL /* | SingleStoreViewBase */),
+	TJoinedName extends GetSelectTableName<TJoinedTable> = GetSelectTableName<TJoinedTable>,
+>(table: TJoinedTable) => SingleStoreJoin<T, TDynamic, 'cross', TJoinedTable, TJoinedName>;
 
 export type SelectedFieldsFlat = SelectedFieldsFlatBase<SingleStoreColumn>;
 
diff --git a/drizzle-orm/src/sqlite-core/query-builders/select.ts b/drizzle-orm/src/sqlite-core/query-builders/select.ts
@@ -42,6 +42,7 @@ import type {
 	SetOperatorRightSelect,
 	SQLiteCreateSetOperatorFn,
 	SQLiteSelectConfig,
+	SQLiteSelectCrossJoinFn,
 	SQLiteSelectDynamic,
 	SQLiteSelectExecute,
 	SQLiteSelectHKT,
@@ -205,7 +206,9 @@ export abstract class SQLiteSelectQueryBuilderBase<
 
 	private createJoin<TJoinType extends JoinType>(
 		joinType: TJoinType,
-	): SQLiteSelectJoinFn<this, TDynamic, TJoinType> {
+	): 'cross' extends TJoinType ? SQLiteSelectCrossJoinFn<this, TDynamic>
+		: SQLiteSelectJoinFn<this, TDynamic, TJoinType>
+	{
 		return (
 			table: SQLiteTable | Subquery | SQLiteViewBase | SQL,
 			on?: ((aliases: TSelection) => SQL | undefined) | SQL | undefined,
diff --git a/drizzle-orm/src/sqlite-core/query-builders/select.types.ts b/drizzle-orm/src/sqlite-core/query-builders/select.types.ts
@@ -107,17 +107,21 @@ export type SQLiteSelectJoinFn<
 	T extends AnySQLiteSelectQueryBuilder,
 	TDynamic extends boolean,
 	TJoinType extends JoinType,
-> = 'cross' extends TJoinType ? <
-		TJoinedTable extends SQLiteTable | Subquery | SQLiteViewBase | SQL,
-		TJoinedName extends GetSelectTableName<TJoinedTable> = GetSelectTableName<TJoinedTable>,
-	>(table: TJoinedTable) => SQLiteSelectJoin<T, TDynamic, TJoinType, TJoinedTable, TJoinedName>
-	: <
-		TJoinedTable extends SQLiteTable | Subquery | SQLiteViewBase | SQL,
-		TJoinedName extends GetSelectTableName<TJoinedTable> = GetSelectTableName<TJoinedTable>,
-	>(
-		table: TJoinedTable,
-		on: ((aliases: T['_']['selection']) => SQL | undefined) | SQL | undefined,
-	) => SQLiteSelectJoin<T, TDynamic, TJoinType, TJoinedTable, TJoinedName>;
+> = <
+	TJoinedTable extends SQLiteTable | Subquery | SQLiteViewBase | SQL,
+	TJoinedName extends GetSelectTableName<TJoinedTable> = GetSelectTableName<TJoinedTable>,
+>(
+	table: TJoinedTable,
+	on: ((aliases: T['_']['selection']) => SQL | undefined) | SQL | undefined,
+) => SQLiteSelectJoin<T, TDynamic, TJoinType, TJoinedTable, TJoinedName>;
+
+export type SQLiteSelectCrossJoinFn<
+	T extends AnySQLiteSelectQueryBuilder,
+	TDynamic extends boolean,
+> = <
+	TJoinedTable extends SQLiteTable | Subquery | SQLiteViewBase | SQL,
+	TJoinedName extends GetSelectTableName<TJoinedTable> = GetSelectTableName<TJoinedTable>,
+>(table: TJoinedTable) => SQLiteSelectJoin<T, TDynamic, 'cross', TJoinedTable, TJoinedName>;
 
 export type SelectedFieldsFlat = SelectFieldsFlatBase<SQLiteColumn>;
 
diff --git a/integration-tests/package.json b/integration-tests/package.json
@@ -4,7 +4,7 @@
 	"description": "",
 	"type": "module",
 	"scripts": {
-		"test:types": "tsc",
+		"test:types": "tsc && cd type-tests/join-nodenext && tsc",
 		"test": "pnpm test:vitest",
 		"test:vitest": "vitest run --pass-with-no-tests",
 		"test:esm": "node tests/imports.test.mjs && node tests/imports.test.cjs",
diff --git a/integration-tests/type-tests/join-nodenext/gel.ts b/integration-tests/type-tests/join-nodenext/gel.ts
@@ -0,0 +1,39 @@
+import { eq } from 'drizzle-orm';
+import { drizzle } from 'drizzle-orm/gel';
+import { gelTable, text, uuid } from 'drizzle-orm/gel-core';
+import { expectTypeOf } from 'vitest';
+
+const account = gelTable('accounts', {
+	id: uuid('id').primaryKey().notNull(),
+	userId: uuid('user_id')
+		.notNull()
+		.references(() => users.id),
+	meta: text().notNull(),
+});
+
+const users = gelTable('users', {
+	id: uuid('id').primaryKey(),
+	name: text('name').notNull(),
+	username: text('username').notNull().unique(),
+});
+
+const db = drizzle.mock();
+
+(async () => {
+	const res = await db.select()
+		.from(users)
+		.innerJoin(account, eq(users.id, account.id));
+
+	expectTypeOf(res).toEqualTypeOf<{
+		accounts: {
+			id: string;
+			userId: string;
+			meta: string;
+		};
+		users: {
+			id: string;
+			name: string;
+			username: string;
+		};
+	}[]>();
+});
diff --git a/integration-tests/type-tests/join-nodenext/mysql.ts b/integration-tests/type-tests/join-nodenext/mysql.ts
diff --git a/integration-tests/type-tests/join-nodenext/package.json b/integration-tests/type-tests/join-nodenext/package.json
diff --git a/integration-tests/type-tests/join-nodenext/pg.ts b/integration-tests/type-tests/join-nodenext/pg.ts
diff --git a/integration-tests/type-tests/join-nodenext/singlestore.ts b/integration-tests/type-tests/join-nodenext/singlestore.ts
diff --git a/integration-tests/type-tests/join-nodenext/sqlite.ts b/integration-tests/type-tests/join-nodenext/sqlite.ts
diff --git a/integration-tests/type-tests/join-nodenext/tsconfig.json b/integration-tests/type-tests/join-nodenext/tsconfig.json
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+- [BUG]: Fixed type issues with joins with certain variations of `tsconfig`: [#4535](https://github.com/drizzle-team/drizzle-orm/issues/4535), [#4457](https://github.com/drizzle-team/drizzle-orm/issues/4457)
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "drizzle-orm",`
`3`		`- "version": "0.44.1",`
	`3`	`+ "version": "0.44.2",`
`4`	`4`	`"description": "Drizzle ORM package for SQL databases",`
`5`	`5`	`"type": "module",`
`6`	`6`	`"scripts": {`