graphql-typescript-definitions type collision

[Flufd]

Overview

Typescript type collision is possible with the generated types, in combination with imported schema types. This is because the generated types for a query are based on the key path inside the query, and those key paths could match GQL schema types.

example:

query MarketDetails {
  market(id:123) {
    manager {
      type 
      #...
    }
  }
}

The type on a market.manager is an enum called MarketManager.
The generated query type definitions then becomes:

import { MarketManager } from './where/schema/types/are';

export namespace MarketDetailsQueryData {
  export interface MarketManager {
    type: MarketManager;
  }
}

And then we have a recursive type reference to the containing type, instead of the imported schema type.

If we rename the field to something sensible for consuming code like marketManager, we force a type renaming to MarketMarketManager, which is an okay work around.

query MarketDetails {
  market(id:123) {
    marketManager: manager {
      type 
      #...
    }
  }
}

export namespace MarketDetailsQueryData {
  export interface MarketMarketManager {
    type: MarketManager;
  }
}

But note, if we define this market query part as a fragment, the types for the fragment are generated slightly different, so we get:

initially, there's no collision because the names don't have the Market prefix:

export namespace MarketDetailsFragmentData {
  export interface Manager {
    __typename: "MarketMarketManager";
    type: MarketManager;
  }
}

after the rename we get a collision:

export namespace MarketDetailsFragmentData {
 export interface MarketManager {
    __typename: "MarketMarketManager";
    type: MarketManager;
  }
}

I'm not consuming the fragment types directly, so this is not an issue.

A fix?

Maybe we could detect this and rename the imported schema types as they are imported.

import { MarketManager as _MarketManager } from './where/schema/types/are';

export namespace MarketDetailsFragmentData {
 export interface MarketManager {
    __typename: "MarketMarketManager";
    type: _MarketManager;
  }
}

Consuming repo

What repo were you working in when this issue occurred?
web