Schema not generated for types exported from module

[sabrehagen]

Hi,

I'm finding that types exported from an external module do not have schemas generated for them. I have a types library @stemn/types and a schemas library @stemn/schemas.

My intention was to generate my schemas from my types library by exporting my types as so

// schemas.ts
export { IPipelineYmlV1 } from '@stemn/types';

Running

yarn typescript-json-schema schemas.ts IPipelineYmlV1

produces

Error: type IPipelineYmlV1 not found
    at JsonSchemaGenerator.getSchemaForSymbol (/node_modules/typescript-json-schema/typescript-json-schema.js:764:19)

Further testing showed when an imported type is extended its properties do not show in the produced schema. For example

// schemas.ts

import { IPipelineYmlV1 } from '@stemn/types';

export interface IPipelineYmlV2 extends IPipelineYmlV1 {
    child: boolean;
}

run with

yarn typescript-json-schema schemas.ts '*'

produces

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "definitions": {
        "IPipelineYmlV2": {
            "properties": {
                "child": {
                    "type": "boolean"
                }
            },
            "type": "object"
        }
    }
}

Is this expected functionality? If so, is there something I can do to have schemas generated for a directly exported type? Thanks.

[domoritz]

Hmm, can you try to create a tsconfig and call the command with that? Interfaces and types from libraries should work. I don't have access to a computer right now to test it.

[sabrehagen]

I created a minimum viable tsconfig.json that includes all files - no luck.

[nfour]

Im running this library programmatically (v0.20.0) and am having the same issue. The definition file is there, typescript can resolve it and type check it but even if I alias it like so, it doesnt work:

import { IRuleLogic as ILogic } from '@temando/automation-engine';

export type IRuleLogic = ILogic;

/**
 * Logic arguments
 */
export interface IExpectedArgs {
  conditions: IRuleLogic[];
}

Going to try upgrading the library, as Im using TS 3.1

[nfour]

How interesting!

import { IRuleLogic as ILogic } from '@temando/automation-engine/build/types/rules';

export type IRuleLogic = ILogic;

/**
 * Logic arguments
 */
export interface IExpectedArgs {
  conditions: IRuleLogic[];
}

This seems to work!

It does not like the re-exported type from the index of the library it seems @domoritz

[domoritz]

Interesting. I wonder whether https://github.com/vega/ts-json-schema-generator picks up external types more cleanly.