Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: union types of union types in Records #1933

Merged
merged 4 commits into from
Apr 21, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/NodeParser/MappedTypeNodeParser.ts
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ export class MappedTypeNodeParser implements SubNodeParser {

protected getProperties(node: ts.MappedTypeNode, keyListType: UnionType, context: Context): ObjectProperty[] {
return keyListType
.getTypes()
.getFlattenedTypes(derefType)
.filter((type): type is LiteralType => type instanceof LiteralType)
.map((type) => [type, this.mapKey(node, type, context)])
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
.map((type) => [type, this.mapKey(node, type, context)])
.reduce((acc: LiteralType[], curr: LiteralType) => {
if (
acc.findIndex((val: LiteralType) => {
return val.getId() === curr.getId();
}) < 0
) {
acc.push(curr);
}
return acc;
}, [])
.map((type) => [type, this.mapKey(node, type, context)])

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can use uniqueTypeArray here instead I think.

.filter((value): value is [LiteralType, LiteralType] => value[1] instanceof LiteralType)
Expand Down
17 changes: 16 additions & 1 deletion src/Type/UnionType.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { BaseType } from "./BaseType.js";
import { uniqueTypeArray } from "../Utils/uniqueTypeArray.js";
import { NeverType } from "./NeverType.js";
import { derefType } from "../Utils/derefType.js";
import { derefAliasedType, derefType, isHiddenType } from "../Utils/derefType.js";

export class UnionType extends BaseType {
private readonly types: BaseType[];
Expand Down Expand Up @@ -56,4 +56,19 @@ export class UnionType extends BaseType {
}
}
}

/**
* Get the types in this union as a flat list.
*/
public getFlattenedTypes(deref: (type: BaseType) => BaseType = derefAliasedType): BaseType[] {
return this.getTypes()
.filter((t) => !isHiddenType(t))
.map(deref)
.flatMap((t) => {
if (t instanceof UnionType) {
return t.getFlattenedTypes(deref);
}
return t;
});
}
}
24 changes: 5 additions & 19 deletions src/TypeFormatter/LiteralUnionTypeFormatter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ import { LiteralType, LiteralValue } from "../Type/LiteralType.js";
import { NullType } from "../Type/NullType.js";
import { StringType } from "../Type/StringType.js";
import { UnionType } from "../Type/UnionType.js";
import { derefAliasedType, isHiddenType } from "../Utils/derefType.js";
import { typeName } from "../Utils/typeName.js";
import { uniqueArray } from "../Utils/uniqueArray.js";

Expand All @@ -20,10 +19,10 @@ export class LiteralUnionTypeFormatter implements SubTypeFormatter {
let allStrings = true;
let hasNull = false;

const flattenedTypes = flattenTypes(type);
const literals = type.getFlattenedTypes();

// filter out String types since we need to be more careful about them
const types = flattenedTypes.filter((t) => {
const types = literals.filter((t) => {
if (t instanceof StringType) {
hasString = true;
preserveLiterals = preserveLiterals || t.getPreserveLiterals();
Expand Down Expand Up @@ -70,23 +69,10 @@ export class LiteralUnionTypeFormatter implements SubTypeFormatter {
}
}

function flattenTypes(type: UnionType): (StringType | LiteralType | NullType)[] {
return type
.getTypes()
.filter((t) => !isHiddenType(t))
.map(derefAliasedType)
.flatMap((t) => {
if (t instanceof UnionType) {
return flattenTypes(t);
}
return t as StringType | LiteralType | NullType;
});
}

export function isLiteralUnion(type: UnionType): boolean {
return flattenTypes(type).every(
(item) => item instanceof LiteralType || item instanceof NullType || item instanceof StringType,
);
return type
.getFlattenedTypes()
.every((item) => item instanceof LiteralType || item instanceof NullType || item instanceof StringType);
}

function getLiteralValue(value: LiteralType | NullType): LiteralValue | null {
Expand Down
6 changes: 6 additions & 0 deletions test/valid-data/type-mapped-union/main.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
type MyType1 = "s1";
type MyType2 = MyType1 | "s2" | "s3";
type MyType3 = MyType2 | "s4" | "s5";
type MyType10 = MyType3 | MyType2 | "s6";

export type MyType = Record<MyType10, string>;
40 changes: 40 additions & 0 deletions test/valid-data/type-mapped-union/schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
{
"$ref": "#/definitions/MyType",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"MyType": {
"additionalProperties": {
"type": "string"
},
"properties": {
"s1": {
"type": "string"
},
"s2": {
"type": "string"
},
"s3": {
"type": "string"
},
"s4": {
"type": "string"
},
"s5": {
"type": "string"
},
"s6": {
"type": "string"
}
},
"required": [
"s4",
"s5",
"s2",
"s3",
"s1",
"s6"
],
"type": "object"
}
}
}
Loading