grantila / typeconv

Convert between JSON Schema, TypeScript, GraphQL, Open API and SureType
MIT License
424 stars 8 forks source link

Overlapping attributes in inherited types fails to convert #38

Open Defrosted opened 1 year ago

Defrosted commented 1 year ago

Hi! Thanks for creating this tool, it's been a life saviour for us for generating OpenAPI definitions. We want to have a single source of truth for our type definitions, so a tool like this comes pretty handy.

However, I found an issue when type converting interfaces that inherit from other interfaces that share common attributes.

Let's imagine we have the following declarations:

interface Base {
  $type: string;
  comment: string;
}

interface A {
  $type: 'a';
  a: string;
}

export interface Foo extends Base, A {
  $type: 'a';
}

The conversion works as expected. However, if interface A has declared an attribute that matches one in the Base interface, the CLI gives an error Cannot read properties of undefined (reading 'length'). With a bit of testing I was able to narrow the issue down to the changes version 2.3.0. Previous versions have no issues with converting this, though, looking at the release notes it's supposedly because they weren't being converted at all 😄

Here's a modified example of the one above that reproduces the error:

interface Base {
  $type: string;
  comment: string;
}

interface A {
  $type: 'a';
  a: string;
  comment: string;
}

export interface Foo extends Base, A {
  $type: 'a';
}

Consideration for debugging: it would be nice to be able to see where the errors are generated from. The error didn't output any information regarding file or line number in regards to what was producing it. My project has quite extensive types that are converted using typeconv, so it took a while to find what was causing the error.

AnotherToaster commented 1 year ago

I ran in to the samen issue with the same error message Cannot read properties of undefined (reading 'length')

export type B = {
    testB: string;
};

export type A = B & {
    testA: string;
};

Worked perfectly with version 1.8.0

trevorpfiz commented 11 months ago

I am getting the same error. Definitely 2.3.0.