ts-json-schema-generator 2.4.1-next.0 → 2.5.0--canary.76e1a68.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. package/README.md +22 -21
  2. package/dist/factory/generator.js +1 -1
  3. package/dist/factory/generator.js.map +1 -1
  4. package/dist/factory/parser.js +11 -2
  5. package/dist/factory/parser.js.map +1 -1
  6. package/dist/package.json +23 -22
  7. package/dist/src/AnnotationsReader/ExtendedAnnotationsReader.d.ts +2 -1
  8. package/dist/src/AnnotationsReader/ExtendedAnnotationsReader.js +22 -10
  9. package/dist/src/AnnotationsReader/ExtendedAnnotationsReader.js.map +1 -1
  10. package/dist/src/Config.d.ts +5 -2
  11. package/dist/src/Config.js +1 -0
  12. package/dist/src/Config.js.map +1 -1
  13. package/dist/src/NodeParser/IdentifierNodeParser.d.ts +11 -0
  14. package/dist/src/NodeParser/IdentifierNodeParser.js +33 -0
  15. package/dist/src/NodeParser/IdentifierNodeParser.js.map +1 -0
  16. package/dist/src/NodeParser/MappedTypeNodeParser.js +4 -1
  17. package/dist/src/NodeParser/MappedTypeNodeParser.js.map +1 -1
  18. package/dist/src/NodeParser/NewExpressionParser.d.ts +13 -0
  19. package/dist/src/NodeParser/NewExpressionParser.js +41 -0
  20. package/dist/src/NodeParser/NewExpressionParser.js.map +1 -0
  21. package/dist/src/NodeParser/SpreadElementNodeParser.d.ts +10 -0
  22. package/dist/src/NodeParser/SpreadElementNodeParser.js +21 -0
  23. package/dist/src/NodeParser/SpreadElementNodeParser.js.map +1 -0
  24. package/dist/src/NodeParser/TypeOperatorNodeParser.d.ts +1 -1
  25. package/dist/src/NodeParser/TypeOperatorNodeParser.js +2 -1
  26. package/dist/src/NodeParser/TypeOperatorNodeParser.js.map +1 -1
  27. package/dist/src/NodeParser/TypeReferenceNodeParser.js +1 -1
  28. package/dist/src/NodeParser/TypeReferenceNodeParser.js.map +1 -1
  29. package/dist/src/SchemaGenerator.d.ts +2 -2
  30. package/dist/src/SchemaGenerator.js +17 -7
  31. package/dist/src/SchemaGenerator.js.map +1 -1
  32. package/dist/src/TypeFormatter/LiteralUnionTypeFormatter.js +10 -5
  33. package/dist/src/TypeFormatter/LiteralUnionTypeFormatter.js.map +1 -1
  34. package/dist/src/TypeFormatter/PrimitiveUnionTypeFormatter.js +6 -2
  35. package/dist/src/TypeFormatter/PrimitiveUnionTypeFormatter.js.map +1 -1
  36. package/dist/src/Utils/castArray.d.ts +1 -0
  37. package/dist/src/Utils/castArray.js +10 -0
  38. package/dist/src/Utils/castArray.js.map +1 -0
  39. package/dist/src/Utils/derefType.d.ts +1 -0
  40. package/dist/src/Utils/derefType.js +13 -0
  41. package/dist/src/Utils/derefType.js.map +1 -1
  42. package/dist/src/Utils/getFullDescription.d.ts +2 -0
  43. package/dist/src/Utils/getFullDescription.js +33 -0
  44. package/dist/src/Utils/getFullDescription.js.map +1 -0
  45. package/dist/ts-json-schema-generator.js +7 -3
  46. package/dist/ts-json-schema-generator.js.map +1 -1
  47. package/dist/tsconfig.tsbuildinfo +1 -1
  48. package/factory/generator.ts +1 -1
  49. package/factory/parser.ts +17 -2
  50. package/package.json +23 -22
  51. package/src/AnnotationsReader/ExtendedAnnotationsReader.ts +25 -10
  52. package/src/Config.ts +124 -2
  53. package/src/NodeParser/IdentifierNodeParser.ts +38 -0
  54. package/src/NodeParser/MappedTypeNodeParser.ts +6 -2
  55. package/src/NodeParser/NewExpressionParser.ts +46 -0
  56. package/src/NodeParser/SpreadElementNodeParser.ts +25 -0
  57. package/src/NodeParser/TypeOperatorNodeParser.ts +2 -2
  58. package/src/NodeParser/TypeReferenceNodeParser.ts +1 -1
  59. package/src/SchemaGenerator.ts +26 -9
  60. package/src/TypeFormatter/LiteralUnionTypeFormatter.ts +12 -6
  61. package/src/TypeFormatter/PrimitiveUnionTypeFormatter.ts +9 -2
  62. package/src/Utils/castArray.ts +7 -0
  63. package/src/Utils/derefType.ts +19 -0
  64. package/src/Utils/getFullDescription.ts +39 -0
  65. package/ts-json-schema-generator.ts +12 -3
@@ -7,7 +7,7 @@ import { createProgram } from "./program.js";
7
7
 
8
8
  export function createGenerator(config: Config): SchemaGenerator {
9
9
  const completedConfig = { ...DEFAULT_CONFIG, ...config };
10
- const program = createProgram(completedConfig);
10
+ const program = config.tsProgram || createProgram(completedConfig);
11
11
  const parser = createParser(program, completedConfig);
12
12
  const formatter = createFormatter(completedConfig);
13
13
 
package/factory/parser.ts CHANGED
@@ -16,6 +16,7 @@ import { BooleanLiteralNodeParser } from "../src/NodeParser/BooleanLiteralNodePa
16
16
  import { BooleanTypeNodeParser } from "../src/NodeParser/BooleanTypeNodeParser.js";
17
17
  import { CallExpressionParser } from "../src/NodeParser/CallExpressionParser.js";
18
18
  import { ConditionalTypeNodeParser } from "../src/NodeParser/ConditionalTypeNodeParser.js";
19
+ import { NewExpressionParser } from "../src/NodeParser/NewExpressionParser.js";
19
20
  import { ConstructorNodeParser } from "../src/NodeParser/ConstructorNodeParser.js";
20
21
  import { EnumNodeParser } from "../src/NodeParser/EnumNodeParser.js";
21
22
  import { ExpressionWithTypeArgumentsNodeParser } from "../src/NodeParser/ExpressionWithTypeArgumentsNodeParser.js";
@@ -59,6 +60,9 @@ import type { SubNodeParser } from "../src/SubNodeParser.js";
59
60
  import { TopRefNodeParser } from "../src/TopRefNodeParser.js";
60
61
  import { SatisfiesNodeParser } from "../src/NodeParser/SatisfiesNodeParser.js";
61
62
  import { PromiseNodeParser } from "../src/NodeParser/PromiseNodeParser.js";
63
+ import { SpreadElementNodeParser } from "../src/NodeParser/SpreadElementNodeParser.js";
64
+ import { IdentifierNodeParser } from "../src/NodeParser/IdentifierNodeParser.js";
65
+ import { castArray } from "../src/Utils/castArray.js";
62
66
 
63
67
  export type ParserAugmentor = (parser: MutableParser) => void;
64
68
 
@@ -70,14 +74,22 @@ export function createParser(program: ts.Program, config: CompletedConfig, augme
70
74
  return new ExposeNodeParser(typeChecker, nodeParser, config.expose, config.jsDoc);
71
75
  }
72
76
  function withTopRef(nodeParser: NodeParser): NodeParser {
73
- return new TopRefNodeParser(chainNodeParser, config.type, config.topRef);
77
+ const typeArr = castArray(config.type);
78
+ // If we have multiple types, don't set a top-level $ref.
79
+ const topRefFullName = typeArr && typeArr.length === 1 ? typeArr[0] : undefined;
80
+ return new TopRefNodeParser(chainNodeParser, topRefFullName, config.topRef);
74
81
  }
75
82
  function withJsDoc(nodeParser: SubNodeParser): SubNodeParser {
76
83
  const extraTags = new Set(config.extraTags);
77
84
  if (config.jsDoc === "extended") {
78
85
  return new AnnotatedNodeParser(
79
86
  nodeParser,
80
- new ExtendedAnnotationsReader(typeChecker, extraTags, config.markdownDescription),
87
+ new ExtendedAnnotationsReader(
88
+ typeChecker,
89
+ extraTags,
90
+ config.markdownDescription,
91
+ config.fullDescription,
92
+ ),
81
93
  );
82
94
  } else if (config.jsDoc === "basic") {
83
95
  return new AnnotatedNodeParser(nodeParser, new BasicAnnotationsReader(extraTags));
@@ -138,8 +150,11 @@ export function createParser(program: ts.Program, config: CompletedConfig, augme
138
150
  .addNodeParser(new NamedTupleMemberNodeParser(chainNodeParser))
139
151
  .addNodeParser(new OptionalTypeNodeParser(chainNodeParser))
140
152
  .addNodeParser(new RestTypeNodeParser(chainNodeParser))
153
+ .addNodeParser(new IdentifierNodeParser(chainNodeParser, typeChecker))
154
+ .addNodeParser(new SpreadElementNodeParser(chainNodeParser))
141
155
 
142
156
  .addNodeParser(new CallExpressionParser(typeChecker, chainNodeParser))
157
+ .addNodeParser(new NewExpressionParser(typeChecker, chainNodeParser))
143
158
  .addNodeParser(new PropertyAccessExpressionParser(typeChecker, chainNodeParser))
144
159
 
145
160
  .addNodeParser(withCircular(withExpose(withJsDoc(new TypeAliasNodeParser(typeChecker, chainNodeParser)))))
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ts-json-schema-generator",
3
- "version": "2.4.1-next.0",
3
+ "version": "2.5.0--canary.76e1a68.0",
4
4
  "description": "Generate JSON schema from your Typescript sources",
5
5
  "keywords": [
6
6
  "ts",
@@ -57,43 +57,44 @@
57
57
  },
58
58
  "dependencies": {
59
59
  "@types/json-schema": "^7.0.15",
60
- "commander": "^13.1.0",
61
- "glob": "^11.0.1",
60
+ "commander": "^14.0.0",
61
+ "glob": "^13.0.0",
62
62
  "json5": "^2.2.3",
63
63
  "normalize-path": "^3.0.0",
64
64
  "safe-stable-stringify": "^2.5.0",
65
65
  "tslib": "^2.8.1",
66
- "typescript": "^5.8.2"
66
+ "typescript": "^5.8.3",
67
+ "@typescript/vfs": "1.6.2"
67
68
  },
68
69
  "devDependencies": {
69
70
  "@auto-it/conventional-commits": "^11.3.0",
70
71
  "@auto-it/first-time-contributor": "^11.3.0",
71
- "@babel/core": "^7.26.10",
72
- "@babel/preset-env": "^7.26.9",
73
- "@babel/preset-typescript": "^7.27.0",
74
- "@eslint/js": "^9.23.0",
72
+ "@babel/core": "^7.28.0",
73
+ "@babel/preset-env": "^7.28.0",
74
+ "@babel/preset-typescript": "^7.27.1",
75
+ "@eslint/js": "^9.30.1",
75
76
  "@types/eslint": "^9.6.1",
76
- "@types/glob": "^8.1.0",
77
- "@types/jest": "^29.5.14",
78
- "@types/node": "^22.13.14",
77
+ "@types/jest": "^30.0.0",
78
+ "@types/node": "^24.0.10",
79
79
  "@types/normalize-path": "^3.0.2",
80
80
  "ajv": "^8.17.1",
81
81
  "ajv-formats": "^3.0.1",
82
82
  "auto": "^11.3.0",
83
- "chai": "^5.2.0",
84
- "cross-env": "^7.0.3",
85
- "eslint": "9.24.0",
86
- "eslint-config-prettier": "^10.1.1",
87
- "eslint-plugin-prettier": "^5.2.5",
88
- "jest": "^29.7.0",
83
+ "chai": "^6.0.1",
84
+ "cross-env": "^10.0.0",
85
+ "eslint": "9.39.1",
86
+ "eslint-config-prettier": "^10.1.5",
87
+ "eslint-plugin-prettier": "^5.5.1",
88
+ "globals": "^16.3.0",
89
+ "jest": "^30.0.4",
89
90
  "jest-junit": "^16.0.0",
90
- "prettier": "^3.5.3",
91
- "tsx": "^4.19.3",
92
- "typescript-eslint": "^8.28.0",
91
+ "prettier": "^3.6.2",
92
+ "tsx": "^4.20.3",
93
+ "typescript-eslint": "^8.35.1",
93
94
  "vega": "^6.1.2",
94
- "vega-lite": "^6.1.0"
95
+ "vega-lite": "^6.2.0"
95
96
  },
96
- "packageManager": "npm@11.2.0",
97
+ "packageManager": "npm@11.4.2",
97
98
  "engines": {
98
99
  "node": ">=18.0.0"
99
100
  }
@@ -2,6 +2,7 @@ import json5 from "json5";
2
2
  import type ts from "typescript";
3
3
  import type { Annotations } from "../Type/AnnotatedType.js";
4
4
  import { symbolAtNode } from "../Utils/symbolAtNode.js";
5
+ import { getFullDescription } from "../Utils/getFullDescription.js";
5
6
  import { BasicAnnotationsReader } from "./BasicAnnotationsReader.js";
6
7
 
7
8
  export class ExtendedAnnotationsReader extends BasicAnnotationsReader {
@@ -9,6 +10,7 @@ export class ExtendedAnnotationsReader extends BasicAnnotationsReader {
9
10
  private typeChecker: ts.TypeChecker,
10
11
  extraTags?: Set<string>,
11
12
  private markdownDescription?: boolean,
13
+ private fullDescription?: boolean,
12
14
  ) {
13
15
  super(extraTags);
14
16
  }
@@ -44,21 +46,34 @@ export class ExtendedAnnotationsReader extends BasicAnnotationsReader {
44
46
  return undefined;
45
47
  }
46
48
 
49
+ const annotations: { description?: string; markdownDescription?: string; fullDescription?: string } = {};
50
+
47
51
  const comments: ts.SymbolDisplayPart[] = symbol.getDocumentationComment(this.typeChecker);
48
- if (!comments || !comments.length) {
49
- return undefined;
50
- }
51
52
 
52
- const markdownDescription = comments
53
- .map((comment) => comment.text)
54
- .join(" ")
55
- .replace(/\r/g, "")
56
- .trim();
53
+ if (comments && comments.length) {
54
+ const markdownDescription = comments
55
+ .map((comment) => comment.text)
56
+ .join(" ")
57
+ .replace(/\r/g, "")
58
+ .trim();
57
59
 
58
- const description = markdownDescription.replace(/(?<=[^\n])\n(?=[^\n*-])/g, " ").trim();
60
+ annotations.description = markdownDescription.replace(/(?<=[^\n])\n(?=[^\n*-])/g, " ").trim();
61
+
62
+ if (this.markdownDescription) {
63
+ annotations.markdownDescription = markdownDescription;
64
+ }
65
+ }
59
66
 
60
- return this.markdownDescription ? { description, markdownDescription } : { description };
67
+ if (this.fullDescription) {
68
+ const fullDescription = getFullDescription(node)?.trim();
69
+ if (fullDescription) {
70
+ annotations.fullDescription = fullDescription;
71
+ }
72
+ }
73
+
74
+ return Object.keys(annotations).length ? annotations : undefined;
61
75
  }
76
+
62
77
  private getTypeAnnotation(node: ts.Node): Annotations | undefined {
63
78
  const symbol = symbolAtNode(node);
64
79
  if (!symbol) {
package/src/Config.ts CHANGED
@@ -1,32 +1,154 @@
1
+ import type ts from "typescript";
2
+
1
3
  export interface Config {
4
+ /**
5
+ * Glob pattern(s) for source TypeScript files to process.
6
+ * If not provided, falls back to files from tsconfig.
7
+ */
2
8
  path?: string;
3
- type?: string;
9
+
10
+ /**
11
+ * Name of the type(s)/interface(s) to generate schema for.
12
+ * Use "*" to generate schemas for all exported types.
13
+ */
14
+ type?: string | string[];
15
+
16
+ /**
17
+ * Minify the output JSON schema (no whitespace).
18
+ * When false, the schema is pretty-printed with 2-space indentation.
19
+ * @default false
20
+ */
4
21
  minify?: boolean;
22
+
23
+ /**
24
+ * Sets the `$id` property in the root of the generated schema.
25
+ * Used for schema identification and referencing.
26
+ */
5
27
  schemaId?: string;
28
+
29
+ /**
30
+ * Path to a custom tsconfig.json file for TypeScript compilation.
31
+ * If not provided, uses default TypeScript configuration.
32
+ */
6
33
  tsconfig?: string;
34
+
35
+ /**
36
+ * Controls which types are exposed as definitions in the schema.
37
+ * - "all": Exposes all types except type literals
38
+ * - "none": Exposes no types automatically
39
+ * - "export": Only exposes exported types (respects @internal JSDoc tag)
40
+ * @default "export"
41
+ */
7
42
  expose?: "all" | "none" | "export";
43
+
44
+ /**
45
+ * Wraps the root type in a `$ref` definition.
46
+ * When false, inlines the root type definition directly.
47
+ * @default true
48
+ */
8
49
  topRef?: boolean;
50
+
51
+ /**
52
+ * Controls how JSDoc comments are parsed and included in the schema.
53
+ * - "none": Ignores all JSDoc annotations
54
+ * - "basic": Parses standard JSON Schema JSDoc tags
55
+ * - "extended": Parses all tags plus descriptions, examples, and type overrides
56
+ * @default "extended"
57
+ */
9
58
  jsDoc?: "none" | "extended" | "basic";
59
+
60
+ /**
61
+ * Adds a `markdownDescription` field alongside `description` in the schema.
62
+ * Preserves markdown formatting including newlines.
63
+ * Only works with `jsDoc: "extended"`.
64
+ * @default false
65
+ */
10
66
  markdownDescription?: boolean;
67
+
68
+ /**
69
+ * Includes the complete raw JSDoc comment as `fullDescription` in the schema.
70
+ * Only works with `jsDoc: "extended"`.
71
+ * @default false
72
+ */
73
+ fullDescription?: boolean;
74
+
75
+ /**
76
+ * Sorts object properties alphabetically in the output.
77
+ * @default true
78
+ */
11
79
  sortProps?: boolean;
80
+
81
+ /**
82
+ * Controls whether tuples allow additional items beyond their defined length.
83
+ * @default false
84
+ */
12
85
  strictTuples?: boolean;
86
+
87
+ /**
88
+ * Skips TypeScript type checking to improve performance.
89
+ * Speeds up generation but may miss type errors.
90
+ * @default false
91
+ */
13
92
  skipTypeCheck?: boolean;
93
+
94
+ /**
95
+ * URI-encodes `$ref` values (e.g., `#/definitions/Foo%3CBar%3E`).
96
+ * When false, uses raw names in reference paths.
97
+ * @default true
98
+ */
14
99
  encodeRefs?: boolean;
100
+
101
+ /**
102
+ * Array of additional JSDoc tag names to include in the schema.
103
+ * Custom tags (e.g., `@customProperty`) are parsed and included in output.
104
+ * Values are parsed as JSON5.
105
+ * @default []
106
+ */
15
107
  extraTags?: string[];
108
+
109
+ /**
110
+ * Sets default value for `additionalProperties` on objects without index signatures.
111
+ * When false, objects get `additionalProperties: false` by default.
112
+ * When true, allows additional properties on all objects.
113
+ * @default false
114
+ */
16
115
  additionalProperties?: boolean;
116
+
117
+ /**
118
+ * Controls discriminator style for discriminated unions.
119
+ * - "json-schema": Uses `if`/`then`/`allOf` with properties containing discriminator enum
120
+ * - "open-api": Uses OpenAPI 3.x style with `discriminator: { propertyName }` and `oneOf`
121
+ * @default "json-schema"
122
+ */
17
123
  discriminatorType?: "json-schema" | "open-api";
124
+
125
+ /**
126
+ * Controls how function types are handled in the schema.
127
+ * - "fail": Throws error when encountering function types
128
+ * - "comment": Generates schema with `$comment` describing the function signature
129
+ * - "hide": Treats functions as NeverType (excluded from schema)
130
+ * @default "comment"
131
+ */
18
132
  functions?: FunctionOptions;
133
+
134
+ /**
135
+ * Pre-compiled TypeScript Program instance to use.
136
+ * Bypasses the default setup of a TypeScript program, and so some configuration options may not be applied.
137
+ * Useful for programmatic usage with existing TypeScript compilation, or for vfs scenarios where you do not want file-system representation.
138
+ */
139
+ tsProgram?: ts.Program;
19
140
  }
20
141
 
21
142
  export type CompletedConfig = Config & typeof DEFAULT_CONFIG;
22
143
 
23
144
  export type FunctionOptions = "fail" | "comment" | "hide";
24
145
 
25
- export const DEFAULT_CONFIG: Omit<Required<Config>, "path" | "type" | "schemaId" | "tsconfig"> = {
146
+ export const DEFAULT_CONFIG: Omit<Required<Config>, "path" | "type" | "schemaId" | "tsconfig" | "tsProgram"> = {
26
147
  expose: "export",
27
148
  topRef: true,
28
149
  jsDoc: "extended",
29
150
  markdownDescription: false,
151
+ fullDescription: false,
30
152
  sortProps: true,
31
153
  strictTuples: false,
32
154
  skipTypeCheck: false,
@@ -0,0 +1,38 @@
1
+ import ts from "typescript";
2
+ import type { Context, NodeParser } from "../NodeParser.js";
3
+ import type { SubNodeParser } from "../SubNodeParser.js";
4
+ import type { BaseType } from "../Type/BaseType.js";
5
+ import { UnknownNodeError } from "../Error/Errors.js";
6
+
7
+ /**
8
+ * Resolves identifiers whose value is a compile-time constant
9
+ */
10
+ export class IdentifierNodeParser implements SubNodeParser {
11
+ constructor(
12
+ private readonly childNodeParser: NodeParser,
13
+ private readonly checker: ts.TypeChecker,
14
+ ) {}
15
+
16
+ supportsNode(node: ts.Identifier): boolean {
17
+ return node.kind === ts.SyntaxKind.Identifier;
18
+ }
19
+
20
+ createType(node: ts.Identifier, context: Context): BaseType {
21
+ const symbol = this.checker.getSymbolAtLocation(node);
22
+ if (!symbol) {
23
+ throw new UnknownNodeError(node);
24
+ }
25
+
26
+ const decl = symbol.valueDeclaration;
27
+ if (
28
+ decl &&
29
+ ts.isVariableDeclaration(decl) &&
30
+ decl.initializer &&
31
+ ts.getCombinedNodeFlags(decl) & ts.NodeFlags.Const
32
+ ) {
33
+ return this.childNodeParser.createType(decl.initializer, context);
34
+ }
35
+
36
+ throw new UnknownNodeError(node);
37
+ }
38
+ }
@@ -16,7 +16,7 @@ import { ObjectProperty, ObjectType } from "../Type/ObjectType.js";
16
16
  import { StringType } from "../Type/StringType.js";
17
17
  import { SymbolType } from "../Type/SymbolType.js";
18
18
  import { UnionType } from "../Type/UnionType.js";
19
- import { derefAnnotatedType, derefType } from "../Utils/derefType.js";
19
+ import { derefAnnotatedType, derefType, isDeepLiteralUnion } from "../Utils/derefType.js";
20
20
  import { getKey } from "../Utils/nodeKey.js";
21
21
  import { preserveAnnotation } from "../Utils/preserveAnnotation.js";
22
22
  import { removeUndefined } from "../Utils/removeUndefined.js";
@@ -65,7 +65,7 @@ export class MappedTypeNodeParser implements SubNodeParser {
65
65
  return type instanceof NeverType ? new NeverType() : new ArrayType(type);
66
66
  }
67
67
  // Key type widens to `string`
68
- const type = this.childNodeParser.createType(node.type!, context);
68
+ const type = this.childNodeParser.createType(node.type!, this.createSubContext(node, keyListType, context));
69
69
  // const resultType = type instanceof NeverType ? new NeverType() : new ObjectType(id, [], [], type);
70
70
  const resultType = new ObjectType(id, [], [], type);
71
71
  if (resultType) {
@@ -158,6 +158,10 @@ export class MappedTypeNodeParser implements SubNodeParser {
158
158
  keyListType: UnionType,
159
159
  context: Context,
160
160
  ): BaseType | boolean {
161
+ if (isDeepLiteralUnion(keyListType)) {
162
+ return this.additionalProperties;
163
+ }
164
+
161
165
  const key = keyListType.getTypes().filter((type) => !(derefType(type) instanceof LiteralType))[0];
162
166
 
163
167
  if (key) {
@@ -0,0 +1,46 @@
1
+ import ts from "typescript";
2
+ import type { NodeParser } from "../NodeParser.js";
3
+ import { Context } from "../NodeParser.js";
4
+ import type { SubNodeParser } from "../SubNodeParser.js";
5
+ import type { BaseType } from "../Type/BaseType.js";
6
+ import { UnknownNodeError } from "../Error/Errors.js";
7
+
8
+ export class NewExpressionParser implements SubNodeParser {
9
+ public constructor(
10
+ protected typeChecker: ts.TypeChecker,
11
+ protected childNodeParser: NodeParser,
12
+ ) {}
13
+
14
+ public supportsNode(node: ts.NewExpression): boolean {
15
+ return node.kind === ts.SyntaxKind.NewExpression;
16
+ }
17
+
18
+ public createType(node: ts.NewExpression, context: Context): BaseType {
19
+ const type = this.typeChecker.getTypeAtLocation(node);
20
+
21
+ const symbol = type.symbol || type.aliasSymbol;
22
+
23
+ const decl =
24
+ this.typeChecker.typeToTypeNode(type, node, ts.NodeBuilderFlags.IgnoreErrors) ||
25
+ symbol?.valueDeclaration ||
26
+ symbol?.declarations?.[0];
27
+
28
+ if (!decl) {
29
+ throw new UnknownNodeError(node);
30
+ }
31
+
32
+ return this.childNodeParser.createType(decl, this.createSubContext(node, context));
33
+ }
34
+
35
+ protected createSubContext(node: ts.NewExpression, parentContext: Context): Context {
36
+ const subContext = new Context(node);
37
+
38
+ if (node.arguments) {
39
+ for (const arg of node.arguments) {
40
+ const type = this.childNodeParser.createType(arg, parentContext);
41
+ subContext.pushArgument(type);
42
+ }
43
+ }
44
+ return subContext;
45
+ }
46
+ }
@@ -0,0 +1,25 @@
1
+ import ts from "typescript";
2
+ import type { Context, NodeParser } from "../NodeParser.js";
3
+ import type { SubNodeParser } from "../SubNodeParser.js";
4
+ import type { ArrayType } from "../Type/ArrayType.js";
5
+ import type { InferType } from "../Type/InferType.js";
6
+ import type { TupleType } from "../Type/TupleType.js";
7
+ import { RestType } from "../Type/RestType.js";
8
+
9
+ /**
10
+ * Handles `...expr` inside an ArrayLiteralExpression.
11
+ * Turns it into RestType so TupleTypeFormatter can emit correct JSON-Schema.
12
+ */
13
+ export class SpreadElementNodeParser implements SubNodeParser {
14
+ constructor(private readonly childNodeParser: NodeParser) {}
15
+
16
+ supportsNode(node: ts.SpreadElement): boolean {
17
+ return node.kind === ts.SyntaxKind.SpreadElement;
18
+ }
19
+
20
+ createType(node: ts.SpreadElement, context: Context) {
21
+ const inner = this.childNodeParser.createType(node.expression, context) as ArrayType | InferType | TupleType;
22
+
23
+ return new RestType(inner);
24
+ }
25
+ }
@@ -2,7 +2,7 @@ import ts from "typescript";
2
2
  import type { Context, NodeParser } from "../NodeParser.js";
3
3
  import type { SubNodeParser } from "../SubNodeParser.js";
4
4
  import { ArrayType } from "../Type/ArrayType.js";
5
- import type { BaseType } from "../Type/BaseType.js";
5
+ import { BaseType } from "../Type/BaseType.js";
6
6
  import { NumberType } from "../Type/NumberType.js";
7
7
  import { ObjectType } from "../Type/ObjectType.js";
8
8
  import { StringType } from "../Type/StringType.js";
@@ -28,7 +28,7 @@ export class TypeOperatorNodeParser implements SubNodeParser {
28
28
  return new NumberType();
29
29
  }
30
30
  const keys = getTypeKeys(type);
31
- if (derefed instanceof ObjectType && derefed.getAdditionalProperties()) {
31
+ if (derefed instanceof ObjectType && derefed.getAdditionalProperties() instanceof BaseType) {
32
32
  return new UnionType([...keys, new StringType()]);
33
33
  }
34
34
 
@@ -56,7 +56,7 @@ export class TypeReferenceNodeParser implements SubNodeParser {
56
56
  return new AnyType();
57
57
  }
58
58
 
59
- return this.childNodeParser.createType(node.typeArguments[0], this.createSubContext(node, context));
59
+ return this.childNodeParser.createType(node.typeArguments[0], context);
60
60
  }
61
61
 
62
62
  if (typeSymbol.name === "Array" || typeSymbol.name === "ReadonlyArray") {
@@ -10,6 +10,7 @@ import type { TypeFormatter } from "./TypeFormatter.js";
10
10
  import type { StringMap } from "./Utils/StringMap.js";
11
11
  import { hasJsDocTag } from "./Utils/hasJsDocTag.js";
12
12
  import { removeUnreachable } from "./Utils/removeUnreachable.js";
13
+ import { castArray } from "./Utils/castArray.js";
13
14
  import { symbolAtNode } from "./Utils/symbolAtNode.js";
14
15
 
15
16
  export class SchemaGenerator {
@@ -20,8 +21,8 @@ export class SchemaGenerator {
20
21
  protected readonly config?: Config,
21
22
  ) {}
22
23
 
23
- public createSchema(fullName?: string): Schema {
24
- const rootNodes = this.getRootNodes(fullName);
24
+ public createSchema(fullNames?: string | string[]): Schema {
25
+ const rootNodes = this.getRootNodes(castArray(fullNames));
25
26
  return this.createSchemaFromNodes(rootNodes);
26
27
  }
27
28
 
@@ -31,8 +32,8 @@ export class SchemaGenerator {
31
32
  rootType: this.nodeParser.createType(rootNode, new Context()),
32
33
  }));
33
34
 
34
- const rootTypeDefinition =
35
- roots.length === 1 ? this.getRootTypeDefinition(roots[0].rootType, roots[0].rootNode) : undefined;
35
+ const rootTypeDefinitions = roots.map((root) => this.getRootTypeDefinition(root.rootType, root.rootNode));
36
+ const rootTypeDefinition = rootTypeDefinitions.length === 1 ? rootTypeDefinitions[0] : undefined;
36
37
  const definitions: StringMap<Definition> = {};
37
38
 
38
39
  for (const root of roots) {
@@ -47,7 +48,10 @@ export class SchemaGenerator {
47
48
  }
48
49
  }
49
50
 
50
- const reachableDefinitions = removeUnreachable(rootTypeDefinition, definitions);
51
+ const reachableDefinitions = rootTypeDefinitions.reduce<StringMap<Definition>>(
52
+ (acc, def) => Object.assign(acc, removeUnreachable(def, definitions)),
53
+ {},
54
+ );
51
55
 
52
56
  return {
53
57
  ...(this.config?.schemaId ? { $id: this.config.schemaId } : {}),
@@ -57,9 +61,15 @@ export class SchemaGenerator {
57
61
  };
58
62
  }
59
63
 
60
- protected getRootNodes(fullName: string | undefined): ts.Node[] {
61
- if (fullName && fullName !== "*") {
62
- return [this.findNamedNode(fullName)];
64
+ protected getRootNodes(fullNames: string[] | undefined): ts.Node[] {
65
+ // ["*"] means generate everything.
66
+ if (fullNames && fullNames.includes("*") && fullNames.length > 1) {
67
+ throw new Error("Cannot mix '*' with specific type names");
68
+ }
69
+
70
+ const generateAll = !fullNames || fullNames.length === 0 || (fullNames.length === 1 && fullNames[0] === "*");
71
+ if (!generateAll) {
72
+ return fullNames.map((name) => this.findNamedNode(name));
63
73
  }
64
74
 
65
75
  const rootFileNames = this.program.getRootFileNames();
@@ -229,11 +239,18 @@ export class SchemaGenerator {
229
239
  return;
230
240
  }
231
241
 
232
- // export { variable } clauses
242
+ if (node.exportClause) {
243
+ // export { Foo } from './lib' or export { Foo };
244
+ // export * as Foo from './lib' should not import all exports
245
+ ts.forEachChild(node.exportClause, (subnode) => this.inspectNode(subnode, typeChecker, allTypes));
246
+ return;
247
+ }
248
+
233
249
  if (!node.moduleSpecifier) {
234
250
  return;
235
251
  }
236
252
 
253
+ // export * from './lib'
237
254
  const symbol = typeChecker.getSymbolAtLocation(node.moduleSpecifier);
238
255
 
239
256
  // should never hit this (maybe type error in user's code)
@@ -55,12 +55,18 @@ export class LiteralUnionTypeFormatter implements SubTypeFormatter {
55
55
  appendTypeValues(type, typeValues);
56
56
  }
57
57
 
58
- const schema = {
59
- type: toEnumType(Array.from(typeNames)),
60
- enum: Array.from(typeValues),
61
- };
62
-
63
- return preserveLiterals ? { anyOf: [{ type: "string" }, schema] } : schema;
58
+ const schema =
59
+ typeNames.size === 1 && typeValues.size === 1
60
+ ? {
61
+ type: toEnumType(Array.from(typeNames)),
62
+ const: Array.from(typeValues)[0],
63
+ }
64
+ : {
65
+ type: toEnumType(Array.from(typeNames)),
66
+ enum: Array.from(typeValues),
67
+ };
68
+
69
+ return hasString ? { anyOf: [{ type: "string" }, schema] } : schema;
64
70
  }
65
71
 
66
72
  public getChildren(): BaseType[] {
@@ -6,7 +6,6 @@ import type { BaseType } from "../Type/BaseType.js";
6
6
  import { BooleanType } from "../Type/BooleanType.js";
7
7
  import { NullType } from "../Type/NullType.js";
8
8
  import { NumberType } from "../Type/NumberType.js";
9
- import { PrimitiveType } from "../Type/PrimitiveType.js";
10
9
  import { StringType } from "../Type/StringType.js";
11
10
  import { UnionType } from "../Type/UnionType.js";
12
11
  import { uniqueArray } from "../Utils/uniqueArray.js";
@@ -25,7 +24,15 @@ export class PrimitiveUnionTypeFormatter implements SubTypeFormatter {
25
24
  }
26
25
 
27
26
  protected isPrimitiveUnion(type: UnionType): boolean {
28
- return type.getTypes().every((item) => item instanceof PrimitiveType);
27
+ return type
28
+ .getTypes()
29
+ .every(
30
+ (item) =>
31
+ item instanceof StringType ||
32
+ item instanceof NumberType ||
33
+ item instanceof BooleanType ||
34
+ item instanceof NullType,
35
+ );
29
36
  }
30
37
 
31
38
  protected getPrimitiveType(item: BaseType): RawTypeName {