sql-drizzle build error

[mfukushim]

What version of Effect is running?

3.11.5

What steps can reproduce the bug?

Hello, I am trying to build a small app using Effect and drizzle but I keep getting build errors. I tried to make a small app with Effect and drizzle but i get build errors.

A simple way to reproduce

1. Build the basic app with “pnpm create effect-app@latest”.
2. Replace the contents of src/Program.ts with effect git packages/sql-drizzle/examples/sqlite.ts
3. "pnpm install @effect/sql @effect/sql-drizzle @effect/sql-sqlite-node drizzle-orm@0.31.4" to add missing packages
4. pnpm run build
5. I get the following TS2379 and TS2345 errors

src/Program.ts:28:20 - error TS2379: Argument of type 'SQLiteTableWithColumns<{ name: "users"; schema: undefined; columns: { id: SQLiteColumn<{ name: "id"; tableName: "users"; dataType
: "number"; columnType: "SQLiteInteger"; data: number; driverParam: number; notNull: true; hasDefault: true; enumValues: undefined; baseColumn: never; }, object>; name: SQLiteColumn<...>; ...' is not assignable to parameter of type 'SQLiteTable<TableConfig>' with 'exactOptionalPropertyTypes: true'. Consider adding 'undefined' to the types of the target's properties.
  The types of '_.config.columns' are incompatible between these types.
    Type '{ id: SQLiteColumn<{ name: "id"; tableName: "users"; dataType: "number"; columnType: "SQLiteInteger"; data: number; driverParam: number; notNull: true; hasDefault: true; enumValues: undefined; baseColumn: never; }, object>; name: SQLiteColumn<...>; }' is not assignable to type 'Record<string, SQLiteColumn<any, object>>'.
      Property 'id' is incompatible with index signature.
        Type 'SQLiteColumn<{ name: "id"; tableName: "users"; dataType: "number"; columnType: "SQLiteInteger"; data: number; driverParam: number; notNull: true; hasDefault: true; enumVa
lues: undefined; baseColumn: never; }, object>' is not assignable to type 'SQLiteColumn<any, object>' with 'exactOptionalPropertyTypes: true'. Consider adding 'undefined' to the types of the target's properties.
          The types of 'table._.config.columns' are incompatible between these types.
            Type 'Record<string, import("D:/mfuku/Documents/projects/scratchProj/effect_sample2/node_modules/.pnpm/drizzle-orm@0.31.4_better-sqlite3@11.7.0/node_modules/drizzle-orm/sql
ite-core/columns/common", { with: { "resolution-mode": "import" } }).SQLiteColumn<any, object>>' is not assignable to type 'Record<string, import("D:/mfuku/Documents/projects/scratchProj/effect_sample2/node_modules/.pnpm/drizzle-orm@0.31.4_better-sqlite3@11.7.0/node_modules/drizzle-orm/sqlite-core/columns/common").SQLiteColumn<any, object>>'.
              'string' index signatures are incompatible.
                Type 'import("D:/mfuku/Documents/projects/scratchProj/effect_sample2/node_modules/.pnpm/drizzle-orm@0.31.4_better-sqlite3@11.7.0/node_modules/drizzle-orm/sqlite-core/co
lumns/common", { with: { "resolution-mode": "import" } }).SQLiteColumn<any, object>' is not assignable to type 'import("D:/mfuku/Documents/projects/scratchProj/effect_sample2/node_modu
les/.pnpm/drizzle-orm@0.31.4_better-sqlite3@11.7.0/node_modules/drizzle-orm/sqlite-core/columns/common").SQLiteColumn<any, object>' with 'exactOptionalPropertyTypes: true'. Consider adding 'undefined' to the types of the target's properties.
                  Property 'config' is protected but type 'Column<T, TRuntimeConfig, TTypeConfig>' is not a class derived from 'Column<T, TRuntimeConfig, TTypeConfig>'.

28   yield* db.delete(users)
                      ~~~~~

src/Program.ts:29:20 - error TS2379: Argument of type 'SQLiteTableWithColumns<{ name: "users"; schema: undefined; columns: { id: SQLiteColumn<{ name: "id"; tableName: "users"; dataType
: "number"; columnType: "SQLiteInteger"; data: number; driverParam: number; notNull: true; hasDefault: true; enumValues: undefined; baseColumn: never; }, object>; name: SQLiteColumn<...>; ...' is not assignable to parameter of type 'SQLiteTable<TableConfig>' with 'exactOptionalPropertyTypes: true'. Consider adding 'undefined' to the types of the target's properties.
  The types of '_.config.columns' are incompatible between these types.
    Type '{ id: SQLiteColumn<{ name: "id"; tableName: "users"; dataType: "number"; columnType: "SQLiteInteger"; data: number; driverParam: number; notNull: true; hasDefault: true; enumValues: undefined; baseColumn: never; }, object>; name: SQLiteColumn<...>; }' is not assignable to type 'Record<string, SQLiteColumn<any, object>>'.
      Property 'id' is incompatible with index signature.
        Type 'SQLiteColumn<{ name: "id"; tableName: "users"; dataType: "number"; columnType: "SQLiteInteger"; data: number; driverParam: number; notNull: true; hasDefault: true; enumVa
lues: undefined; baseColumn: never; }, object>' is not assignable to type 'SQLiteColumn<any, object>' with 'exactOptionalPropertyTypes: true'. Consider adding 'undefined' to the types of the target's properties.
          The types of 'table._.config.columns' are incompatible between these types.
            Type 'Record<string, import("D:/mfuku/Documents/projects/scratchProj/effect_sample2/node_modules/.pnpm/drizzle-orm@0.31.4_better-sqlite3@11.7.0/node_modules/drizzle-orm/sql
ite-core/columns/common", { with: { "resolution-mode": "import" } }).SQLiteColumn<any, object>>' is not assignable to type 'Record<string, import("D:/mfuku/Documents/projects/scratchProj/effect_sample2/node_modules/.pnpm/drizzle-orm@0.31.4_better-sqlite3@11.7.0/node_modules/drizzle-orm/sqlite-core/columns/common").SQLiteColumn<any, object>>'.
              'string' index signatures are incompatible.
                Type 'import("D:/mfuku/Documents/projects/scratchProj/effect_sample2/node_modules/.pnpm/drizzle-orm@0.31.4_better-sqlite3@11.7.0/node_modules/drizzle-orm/sqlite-core/co
lumns/common", { with: { "resolution-mode": "import" } }).SQLiteColumn<any, object>' is not assignable to type 'import("D:/mfuku/Documents/projects/scratchProj/effect_sample2/node_modu
les/.pnpm/drizzle-orm@0.31.4_better-sqlite3@11.7.0/node_modules/drizzle-orm/sqlite-core/columns/common").SQLiteColumn<any, object>' with 'exactOptionalPropertyTypes: true'. Consider adding 'undefined' to the types of the target's properties.
                  Property 'config' is protected but type 'Column<T, TRuntimeConfig, TTypeConfig>' is not a class derived from 'Column<T, TRuntimeConfig, TTypeConfig>'.

29   yield* db.insert(users).values({ id: 1, name: "Alice" })
                      ~~~~~

src/Program.ts:30:43 - error TS2345: Argument of type 'SQLiteTableWithColumns<{ name: "users"; schema: undefined; columns: { id: SQLiteColumn<{ name: "id"; tableName: "users"; dataType
: "number"; columnType: "SQLiteInteger"; data: number; driverParam: number; notNull: true; hasDefault: true; enumValues: undefined; baseColumn: never; }, object>; name: SQLiteColumn<..
.>; ...' is not assignable to parameter of type 'SQLiteTable<TableConfig> | SQL<unknown> | Subquery<string, Record<string, unknown>> | SQLiteViewBase<string, boolean, ColumnsSelection>'.
  Type 'SQLiteTableWithColumns<{ name: "users"; schema: undefined; columns: { id: SQLiteColumn<{ name: "id"; tableName: "users"; dataType: "number"; columnType: "SQLiteInteger"; data: 
number; driverParam: number; notNull: true; hasDefault: true; enumValues: undefined; baseColumn: never; }, object>; name: SQLiteColumn<...>; ...' is not assignable to type 'SQLiteTable<TableConfig>' with 'exactOptionalPropertyTypes: true'. Consider adding 'undefined' to the types of the target's properties.
    The types of '_.config.columns' are incompatible between these types.
      Type '{ id: SQLiteColumn<{ name: "id"; tableName: "users"; dataType: "number"; columnType: "SQLiteInteger"; data: number; driverParam: number; notNull: true; hasDefault: true; enumValues: undefined; baseColumn: never; }, object>; name: SQLiteColumn<...>; }' is not assignable to type 'Record<string, SQLiteColumn<any, object>>'.
        Property 'id' is incompatible with index signature.
          Type 'SQLiteColumn<{ name: "id"; tableName: "users"; dataType: "number"; columnType: "SQLiteInteger"; data: number; driverParam: number; notNull: true; hasDefault: true; enum
Values: undefined; baseColumn: never; }, object>' is not assignable to type 'SQLiteColumn<any, object>' with 'exactOptionalPropertyTypes: true'. Consider adding 'undefined' to the types of the target's properties.
            The types of 'table._.config.columns' are incompatible between these types.
              Type 'Record<string, import("D:/mfuku/Documents/projects/scratchProj/effect_sample2/node_modules/.pnpm/drizzle-orm@0.31.4_better-sqlite3@11.7.0/node_modules/drizzle-orm/s
qlite-core/columns/common", { with: { "resolution-mode": "import" } }).SQLiteColumn<any, object>>' is not assignable to type 'Record<string, import("D:/mfuku/Documents/projects/scratchProj/effect_sample2/node_modules/.pnpm/drizzle-orm@0.31.4_better-sqlite3@11.7.0/node_modules/drizzle-orm/sqlite-core/columns/common").SQLiteColumn<any, object>>'.
                'string' index signatures are incompatible.
                  Type 'import("D:/mfuku/Documents/projects/scratchProj/effect_sample2/node_modules/.pnpm/drizzle-orm@0.31.4_better-sqlite3@11.7.0/node_modules/drizzle-orm/sqlite-core/
columns/common", { with: { "resolution-mode": "import" } }).SQLiteColumn<any, object>' is not assignable to type 'import("D:/mfuku/Documents/projects/scratchProj/effect_sample2/node_mo
dules/.pnpm/drizzle-orm@0.31.4_better-sqlite3@11.7.0/node_modules/drizzle-orm/sqlite-core/columns/common").SQLiteColumn<any, object>' with 'exactOptionalPropertyTypes: true'. Consider adding 'undefined' to the types of the target's properties.
                    Property 'config' is protected but type 'Column<T, TRuntimeConfig, TTypeConfig>' is not a class derived from 'Column<T, TRuntimeConfig, TTypeConfig>'.

30   const results = yield* db.select().from(users)
                                             ~~~~~


Found 3 errors.

What is the expected behavior?

I found to build bellow setting

tsconfig.base.json

    "moduleResolution": "node",
    "module": "commonjs",

Is there a way to build without changing the settings? Is there any problem with this workaround?

What do you see instead?

No response

Additional information

No response

[EgorPopovPP]

Same problem :(

[mfukushim]

Hello.
I don't know the cause of the problem either. Currently I am tentatively using the original drizzle wrapped with stubs instead of @effect/sql-drizzle. It is working fine for the time being, but I would like to know how to deal with it officially.

import {drizzle} from 'drizzle-orm/libsql';

    const stub = <T>(qy: Promise<T>) => Effect.tryPromise({
      try: () => qy,
      catch: error => {
        return new Error(`${error}`);
      }
    })

const db = drizzle(dbPath);

function getData(id:number) {
      return stub(db.select().from(data_schema).where(eq(data_schema.id, id))).pipe(Effect.tap(a => Effect.log(a)))
}

[EgorPopovPP]

Here my reproduction

https://github.com/EgorPopovPP/effect-issue-reproduction

[xesrevinu]

# env.d.ts
import type { PgRemoteQueryResultHKT } from "drizzle-orm/pg-proxy";

declare interface PgRemoteDatabase<
  TSchema extends Record<string, unknown> = Record<string, never>,
> extends PgDatabase<PgRemoteQueryResultHKT, TSchema> {}

declare module "drizzle-orm" {
  export interface QueryPromise<T> extends Effect.Effect<T, SqlError> {}
}

# sql.ts
const DB: Context.Tag<PgDrizzle.PgDrizzle, PgRemoteDatabase> =
  PgDrizzle.PgDrizzle as any;

There are indeed some strange problems here, which can be temporarily bypassed in this way.
@mfukushim Tested in EgorPopovPP/effect-issue-reproduction, contact me anytime if you have any findings.

[EgorPopovPP]

@xesrevinu Thank you! You are amazing!

[mfukushim]

@xesrevinu
Thanks for the reply.
I tried pulling https://github.com/EgorPopovPP/effect-issue-reproduction in my environment and got the following error suggestions.
It's too complicated for me to fully understand, but hopefully something will help you.

[xesrevinu]

@xesrevinu

Thanks for the reply.

I tried pulling https://github.com/EgorPopovPP/effect-issue-reproduction in my environment and got the following error suggestions.

It's too complicated for me to fully understand, but hopefully something will help you.

#4125 (comment)

Have you tried to add this?

[mfukushim]

@xesrevinu
Sorry for the late reply.
As you pointed out, the code you wrote was not being applied. However, my problem was occurring with sqlite, so I didn't know how to reflect the above code.
I have placed my reproduced code below.

https://github.com/mfukushim/sample_effect_drizzle

This is just the contents of Program.ts in the program generated by pnpm create effect-app@latest, replaced with https://github.com/Effect-TS/effect/blob/main/packages/sql-drizzle/examples/sqlite.ts. At this time, I didn't know how to solve the error message in Program.ts.

I'm not in a hurry because I'm using my own stub to get around the problem, but if there are any points to be made about how to use sqlite with sql-drizzle, please let me know.