Sql typing no longer works with interface types

[kkorenius]

Trying to use an interface type with an SQL query, for example:

interface Person {
  id: number,
  name: string,
};

const query = sql<Person>`
  SELECT id, name
  FROM person
`;

const onePerson = await connection.one(query);

Expected Behavior

The code above should compile correctly.

Current Behavior

TypeScript compiler gives the following error:

TS2344: Type 'Person' does not satisfy the constraint 'QueryResultRow'.
  Index signature for type 'string' is missing in type 'Person'`.

The code works if the interface is replaced with a type alias.

Possible Solution

The code was working before release 30.4.2. The problem has been probably caused due to adoption of MixedRow

[gajus]

This feature was removed in v31.

I think v30.4.2 was an accidental release.

Can you give 30.4.3 a try?

[kkorenius]

Unfortunately, the same error with v30.4.3.

[gajus]

Released v30.4.4 to npm

[gilamran]

@gajus This is still an issue, it's impossilbe to work with interfaces and sql
I tried all these versions: 30.4.2 30.4.4 and the latest 31.2.4
All show the same error:

[gajus]

Assuming this worked before, downgrading further will eventually find a version that works. It should be v30.4.4 though.

However, given that these are no longer supported, their use is highly discouraged.

[gilamran]

@gajus what isn't supported? interfaces?

[gajus]

Interface support has been removed. All static types are getting removed in favor of Zod in future versions.

https://github.com/gajus/slonik#runtime-validation

[gilamran]

That's BIG... maybe too big

[gajus]

See long discussion in this thread

#364

and this article

https://contra.com/p/gkOQlbLq-validating-postgre-sql-query-results-using-runtime-checks

[mmkal]

@gajus I'm a bit surprised #364 is the reference point for how this dramatic decision was made. That thread, in my opinion, establishes that it would have been unnecessary to remove plain interface support for the zod feature. Then interface support was just removed as a follow up, without any external review or further opportunity for comment by me or others who have contributed to slonik over the years, as far as I could tell.

@gilamran I am on the lookout for a more suitable library for my team and will likely not maintain @slonik/migrator or @slonik/typegen once we have stopped using slonik. There are a few contenders, so happy to chat about it if you're thinking along the same lines. I'm on discord with the same username.

Edit: edited for tone. I'm sorry if that came off unpleasant, I'm very grateful for this library which has been working well in production for us for years. I'd still love to keep working with it, but what we need is a sql client for typescript and slonik is now a sql-zod-client. I did get a bit frustrated at the idea that I was part of that decision, rather than someone who actively resisted it as not necessary, so I'm sorry if I came off ungrateful or rude. 🙏

[gilamran]

@mmkal I totally with you on this. Removing support for interfaces on some minor version is not acceptable in my opinion.
Moving this library to a runtime validation (without any option to opts out) is not what I am looking for.
I've also started looking for alternatives, not doing so will get me stuck on version 30.4.4 forever.

p.s. I don't see your comment as rude. Any contributor's opinion should be heard. This is open source.

@mmkal what's your discord name and 4 digits?