Skip to content

Commit 8d715ff

Browse files
sandersnsandersn
authored
Error on mapped type w/properties (#46346)
* Error on mapped types with properties 1. Error on properties of type literals with computed properties whose name is a binary expression with `in`, because that's a good sign of a mapped type. 2. Parse following properties on mapped types, and error on them. 3. Stop checking computed property names in (1) to avoid producing errors based on misinterpreting mapped type syntax as an expression. * add comment in types.ts * Update API again * Check interfaces and classes too * Add missed check in updateMappedTypeNode
1 parent 26aea0d commit 8d715ff

16 files changed

+448
-22
lines changed

‎src/compiler/checker.ts‎

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4973,7 +4973,7 @@ namespace ts {
49734973
const typeParameterNode = typeParameterToDeclarationWithConstraint(getTypeParameterFromMappedType(type), context, appropriateConstraintTypeNode);
49744974
const nameTypeNode = type.declaration.nameType ? typeToTypeNodeHelper(getNameTypeFromMappedType(type)!, context) : undefined;
49754975
const templateTypeNode = typeToTypeNodeHelper(removeMissingType(getTemplateTypeFromMappedType(type), !!(getMappedTypeModifiers(type) & MappedTypeModifiers.IncludeOptional)), context);
4976-
const mappedTypeNode = factory.createMappedTypeNode(readonlyToken, typeParameterNode, nameTypeNode, questionToken, templateTypeNode);
4976+
const mappedTypeNode = factory.createMappedTypeNode(readonlyToken, typeParameterNode, nameTypeNode, questionToken, templateTypeNode, /*members*/ undefined);
49774977
context.approximateLength += 10;
49784978
return setEmitFlags(mappedTypeNode, EmitFlags.SingleLine);
49794979
}
@@ -26811,6 +26811,10 @@ namespace ts {
2681126811
function checkComputedPropertyName(node: ComputedPropertyName): Type {
2681226812
const links = getNodeLinks(node.expression);
2681326813
if (!links.resolvedType) {
26814+
if ((isTypeLiteralNode(node.parent.parent) || isClassLike(node.parent.parent) || isInterfaceDeclaration(node.parent.parent))
26815+
&& isBinaryExpression(node.expression) && node.expression.operatorToken.kind === SyntaxKind.InKeyword) {
26816+
return links.resolvedType = errorType;
26817+
}
2681426818
links.resolvedType = checkExpression(node.expression);
2681526819
// The computed property name of a non-static class field within a loop must be stored in a block-scoped binding.
2681626820
// (It needs to be bound at class evaluation time.)
@@ -34736,6 +34740,7 @@ namespace ts {
3473634740
}
3473734741

3473834742
function checkMappedType(node: MappedTypeNode) {
34743+
checkGrammarMappedType(node);
3473934744
checkSourceElement(node.typeParameter);
3474034745
checkSourceElement(node.nameType);
3474134746
checkSourceElement(node.type);
@@ -34755,6 +34760,12 @@ namespace ts {
3475534760
}
3475634761
}
3475734762

34763+
function checkGrammarMappedType(node: MappedTypeNode) {
34764+
if (node.members?.length) {
34765+
return grammarErrorOnNode(node.members[0], Diagnostics.A_mapped_type_may_not_declare_properties_or_methods);
34766+
}
34767+
}
34768+
3475834769
function checkThisType(node: ThisTypeNode) {
3475934770
getTypeFromThisTypeNode(node);
3476034771
}
@@ -43417,6 +43428,11 @@ namespace ts {
4341743428
}
4341843429

4341943430
function checkGrammarProperty(node: PropertyDeclaration | PropertySignature) {
43431+
if (isComputedPropertyName(node.name) && isBinaryExpression(node.name.expression) && node.name.expression.operatorToken.kind === SyntaxKind.InKeyword) {
43432+
return grammarErrorOnNode(
43433+
(node.parent as ClassLikeDeclaration | InterfaceDeclaration | TypeLiteralNode).members[0],
43434+
Diagnostics.A_mapped_type_may_not_declare_properties_or_methods);
43435+
}
4342043436
if (isClassLike(node.parent)) {
4342143437
if (isStringLiteral(node.name) && node.name.text === "constructor") {
4342243438
return grammarErrorOnNode(node.name, Diagnostics.Classes_may_not_have_a_field_named_constructor);
@@ -43436,7 +43452,7 @@ namespace ts {
4343643452
return grammarErrorOnNode(node.initializer, Diagnostics.An_interface_property_cannot_have_an_initializer);
4343743453
}
4343843454
}
43439-
else if (node.parent.kind === SyntaxKind.TypeLiteral) {
43455+
else if (isTypeLiteralNode(node.parent)) {
4344043456
if (checkGrammarForInvalidDynamicName(node.name, Diagnostics.A_computed_property_name_in_a_type_literal_must_refer_to_an_expression_whose_type_is_a_literal_type_or_a_unique_symbol_type)) {
4344143457
return true;
4344243458
}

‎src/compiler/diagnosticMessages.json‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5993,7 +5993,10 @@
59935993
"category": "Error",
59945994
"code": 7060
59955995
},
5996-
5996+
"A mapped type may not declare properties or methods.": {
5997+
"category": "Error",
5998+
"code": 7061
5999+
},
59976000

59986001
"You cannot rename this element.": {
59996002
"category": "Error",

‎src/compiler/factory/nodeFactory.ts‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2112,25 +2112,27 @@ namespace ts {
21122112
}
21132113

21142114
// @api
2115-
function createMappedTypeNode(readonlyToken: ReadonlyKeyword | PlusToken | MinusToken | undefined, typeParameter: TypeParameterDeclaration, nameType: TypeNode | undefined, questionToken: QuestionToken | PlusToken | MinusToken | undefined, type: TypeNode | undefined): MappedTypeNode {
2115+
function createMappedTypeNode(readonlyToken: ReadonlyKeyword | PlusToken | MinusToken | undefined, typeParameter: TypeParameterDeclaration, nameType: TypeNode | undefined, questionToken: QuestionToken | PlusToken | MinusToken | undefined, type: TypeNode | undefined, members: readonly TypeElement[] | undefined): MappedTypeNode {
21162116
const node = createBaseNode<MappedTypeNode>(SyntaxKind.MappedType);
21172117
node.readonlyToken = readonlyToken;
21182118
node.typeParameter = typeParameter;
21192119
node.nameType = nameType;
21202120
node.questionToken = questionToken;
21212121
node.type = type;
2122+
node.members = members && createNodeArray(members);
21222123
node.transformFlags = TransformFlags.ContainsTypeScript;
21232124
return node;
21242125
}
21252126

21262127
// @api
2127-
function updateMappedTypeNode(node: MappedTypeNode, readonlyToken: ReadonlyKeyword | PlusToken | MinusToken | undefined, typeParameter: TypeParameterDeclaration, nameType: TypeNode | undefined, questionToken: QuestionToken | PlusToken | MinusToken | undefined, type: TypeNode | undefined): MappedTypeNode {
2128+
function updateMappedTypeNode(node: MappedTypeNode, readonlyToken: ReadonlyKeyword | PlusToken | MinusToken | undefined, typeParameter: TypeParameterDeclaration, nameType: TypeNode | undefined, questionToken: QuestionToken | PlusToken | MinusToken | undefined, type: TypeNode | undefined, members: NodeArray<TypeElement> | undefined): MappedTypeNode {
21282129
return node.readonlyToken !== readonlyToken
21292130
|| node.typeParameter !== typeParameter
21302131
|| node.nameType !== nameType
21312132
|| node.questionToken !== questionToken
21322133
|| node.type !== type
2133-
? update(createMappedTypeNode(readonlyToken, typeParameter, nameType, questionToken, type), node)
2134+
|| node.members !== members
2135+
? update(createMappedTypeNode(readonlyToken, typeParameter, nameType, questionToken, type, members), node)
21342136
: node;
21352137
}
21362138

‎src/compiler/parser.ts‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,8 @@ namespace ts {
212212
visitNode(cbNode, (node as MappedTypeNode).typeParameter) ||
213213
visitNode(cbNode, (node as MappedTypeNode).nameType) ||
214214
visitNode(cbNode, (node as MappedTypeNode).questionToken) ||
215-
visitNode(cbNode, (node as MappedTypeNode).type);
215+
visitNode(cbNode, (node as MappedTypeNode).type) ||
216+
visitNodes(cbNode, cbNodes, (node as MappedTypeNode).members);
216217
case SyntaxKind.LiteralType:
217218
return visitNode(cbNode, (node as LiteralTypeNode).literal);
218219
case SyntaxKind.NamedTupleMember:
@@ -3534,8 +3535,9 @@ namespace ts {
35343535
}
35353536
const type = parseTypeAnnotation();
35363537
parseSemicolon();
3538+
const members = parseList(ParsingContext.TypeMembers, parseTypeMember);
35373539
parseExpected(SyntaxKind.CloseBraceToken);
3538-
return finishNode(factory.createMappedTypeNode(readonlyToken, typeParameter, nameType, questionToken, type), pos);
3540+
return finishNode(factory.createMappedTypeNode(readonlyToken, typeParameter, nameType, questionToken, type, members), pos);
35393541
}
35403542

35413543
function parseTupleElementType() {

‎src/compiler/types.ts‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1707,6 +1707,8 @@ namespace ts {
17071707
readonly nameType?: TypeNode;
17081708
readonly questionToken?: QuestionToken | PlusToken | MinusToken;
17091709
readonly type?: TypeNode;
1710+
/** Used only to produce grammar errors */
1711+
readonly members?: NodeArray<TypeElement>;
17101712
}
17111713

17121714
export interface LiteralTypeNode extends TypeNode {
@@ -7212,8 +7214,8 @@ namespace ts {
72127214
updateTypeOperatorNode(node: TypeOperatorNode, type: TypeNode): TypeOperatorNode;
72137215
createIndexedAccessTypeNode(objectType: TypeNode, indexType: TypeNode): IndexedAccessTypeNode;
72147216
updateIndexedAccessTypeNode(node: IndexedAccessTypeNode, objectType: TypeNode, indexType: TypeNode): IndexedAccessTypeNode;
7215-
createMappedTypeNode(readonlyToken: ReadonlyKeyword | PlusToken | MinusToken | undefined, typeParameter: TypeParameterDeclaration, nameType: TypeNode | undefined, questionToken: QuestionToken | PlusToken | MinusToken | undefined, type: TypeNode | undefined): MappedTypeNode;
7216-
updateMappedTypeNode(node: MappedTypeNode, readonlyToken: ReadonlyKeyword | PlusToken | MinusToken | undefined, typeParameter: TypeParameterDeclaration, nameType: TypeNode | undefined, questionToken: QuestionToken | PlusToken | MinusToken | undefined, type: TypeNode | undefined): MappedTypeNode;
7217+
createMappedTypeNode(readonlyToken: ReadonlyKeyword | PlusToken | MinusToken | undefined, typeParameter: TypeParameterDeclaration, nameType: TypeNode | undefined, questionToken: QuestionToken | PlusToken | MinusToken | undefined, type: TypeNode | undefined, members: NodeArray<TypeElement> | undefined): MappedTypeNode;
7218+
updateMappedTypeNode(node: MappedTypeNode, readonlyToken: ReadonlyKeyword | PlusToken | MinusToken | undefined, typeParameter: TypeParameterDeclaration, nameType: TypeNode | undefined, questionToken: QuestionToken | PlusToken | MinusToken | undefined, type: TypeNode | undefined, members: NodeArray<TypeElement> | undefined): MappedTypeNode;
72177219
createLiteralTypeNode(literal: LiteralTypeNode["literal"]): LiteralTypeNode;
72187220
updateLiteralTypeNode(node: LiteralTypeNode, literal: LiteralTypeNode["literal"]): LiteralTypeNode;
72197221
createTemplateLiteralType(head: TemplateHead, templateSpans: readonly TemplateLiteralTypeSpan[]): TemplateLiteralTypeNode;

‎src/compiler/visitorPublic.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -629,7 +629,8 @@ namespace ts {
629629
nodeVisitor(node.typeParameter, visitor, isTypeParameterDeclaration),
630630
nodeVisitor(node.nameType, visitor, isTypeNode),
631631
nodeVisitor(node.questionToken, tokenVisitor, isQuestionOrPlusOrMinusToken),
632-
nodeVisitor(node.type, visitor, isTypeNode));
632+
nodeVisitor(node.type, visitor, isTypeNode),
633+
nodesVisitor(node.members, visitor, isTypeElement));
633634

634635
case SyntaxKind.LiteralType:
635636
Debug.type<LiteralTypeNode>(node);

‎src/services/codefixes/convertLiteralTypeToMappedType.ts‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,12 @@ namespace ts.codefix {
4747
}
4848

4949
function doChange(changes: textChanges.ChangeTracker, sourceFile: SourceFile, { container, typeNode, constraint, name }: Info): void {
50-
changes.replaceNode(sourceFile, container, factory.createMappedTypeNode(/*readonlyToken*/ undefined,
51-
factory.createTypeParameterDeclaration(name, factory.createTypeReferenceNode(constraint)), /*nameType*/ undefined, /*questionToken*/ undefined, typeNode));
50+
changes.replaceNode(sourceFile, container, factory.createMappedTypeNode(
51+
/*readonlyToken*/ undefined,
52+
factory.createTypeParameterDeclaration(name, factory.createTypeReferenceNode(constraint)),
53+
/*nameType*/ undefined,
54+
/*questionToken*/ undefined,
55+
typeNode,
56+
/*members*/ undefined));
5257
}
5358
}

‎src/services/codefixes/convertToMappedObjectType.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,8 @@ namespace ts.codefix {
4646
mappedTypeParameter,
4747
/*nameType*/ undefined,
4848
indexSignature.questionToken,
49-
indexSignature.type);
49+
indexSignature.type,
50+
/*members*/ undefined);
5051
const intersectionType = factory.createIntersectionTypeNode([
5152
...getAllSuperTypeNodes(container),
5253
mappedIntersectionType,

‎tests/baselines/reference/api/tsserverlibrary.d.ts‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -973,6 +973,8 @@ declare namespace ts {
973973
readonly nameType?: TypeNode;
974974
readonly questionToken?: QuestionToken | PlusToken | MinusToken;
975975
readonly type?: TypeNode;
976+
/** Used only to produce grammar errors */
977+
readonly members?: NodeArray<TypeElement>;
976978
}
977979
export interface LiteralTypeNode extends TypeNode {
978980
readonly kind: SyntaxKind.LiteralType;
@@ -3420,8 +3422,8 @@ declare namespace ts {
34203422
updateTypeOperatorNode(node: TypeOperatorNode, type: TypeNode): TypeOperatorNode;
34213423
createIndexedAccessTypeNode(objectType: TypeNode, indexType: TypeNode): IndexedAccessTypeNode;
34223424
updateIndexedAccessTypeNode(node: IndexedAccessTypeNode, objectType: TypeNode, indexType: TypeNode): IndexedAccessTypeNode;
3423-
createMappedTypeNode(readonlyToken: ReadonlyKeyword | PlusToken | MinusToken | undefined, typeParameter: TypeParameterDeclaration, nameType: TypeNode | undefined, questionToken: QuestionToken | PlusToken | MinusToken | undefined, type: TypeNode | undefined): MappedTypeNode;
3424-
updateMappedTypeNode(node: MappedTypeNode, readonlyToken: ReadonlyKeyword | PlusToken | MinusToken | undefined, typeParameter: TypeParameterDeclaration, nameType: TypeNode | undefined, questionToken: QuestionToken | PlusToken | MinusToken | undefined, type: TypeNode | undefined): MappedTypeNode;
3425+
createMappedTypeNode(readonlyToken: ReadonlyKeyword | PlusToken | MinusToken | undefined, typeParameter: TypeParameterDeclaration, nameType: TypeNode | undefined, questionToken: QuestionToken | PlusToken | MinusToken | undefined, type: TypeNode | undefined, members: NodeArray<TypeElement> | undefined): MappedTypeNode;
3426+
updateMappedTypeNode(node: MappedTypeNode, readonlyToken: ReadonlyKeyword | PlusToken | MinusToken | undefined, typeParameter: TypeParameterDeclaration, nameType: TypeNode | undefined, questionToken: QuestionToken | PlusToken | MinusToken | undefined, type: TypeNode | undefined, members: NodeArray<TypeElement> | undefined): MappedTypeNode;
34253427
createLiteralTypeNode(literal: LiteralTypeNode["literal"]): LiteralTypeNode;
34263428
updateLiteralTypeNode(node: LiteralTypeNode, literal: LiteralTypeNode["literal"]): LiteralTypeNode;
34273429
createTemplateLiteralType(head: TemplateHead, templateSpans: readonly TemplateLiteralTypeSpan[]): TemplateLiteralTypeNode;
@@ -10779,9 +10781,9 @@ declare namespace ts {
1077910781
/** @deprecated Use `factory.updateIndexedAccessTypeNode` or the factory supplied by your transformation context instead. */
1078010782
const updateIndexedAccessTypeNode: (node: IndexedAccessTypeNode, objectType: TypeNode, indexType: TypeNode) => IndexedAccessTypeNode;
1078110783
/** @deprecated Use `factory.createMappedTypeNode` or the factory supplied by your transformation context instead. */
10782-
const createMappedTypeNode: (readonlyToken: ReadonlyKeyword | PlusToken | MinusToken | undefined, typeParameter: TypeParameterDeclaration, nameType: TypeNode | undefined, questionToken: QuestionToken | PlusToken | MinusToken | undefined, type: TypeNode | undefined) => MappedTypeNode;
10784+
const createMappedTypeNode: (readonlyToken: ReadonlyKeyword | PlusToken | MinusToken | undefined, typeParameter: TypeParameterDeclaration, nameType: TypeNode | undefined, questionToken: QuestionToken | PlusToken | MinusToken | undefined, type: TypeNode | undefined, members: NodeArray<TypeElement> | undefined) => MappedTypeNode;
1078310785
/** @deprecated Use `factory.updateMappedTypeNode` or the factory supplied by your transformation context instead. */
10784-
const updateMappedTypeNode: (node: MappedTypeNode, readonlyToken: ReadonlyKeyword | PlusToken | MinusToken | undefined, typeParameter: TypeParameterDeclaration, nameType: TypeNode | undefined, questionToken: QuestionToken | PlusToken | MinusToken | undefined, type: TypeNode | undefined) => MappedTypeNode;
10786+
const updateMappedTypeNode: (node: MappedTypeNode, readonlyToken: ReadonlyKeyword | PlusToken | MinusToken | undefined, typeParameter: TypeParameterDeclaration, nameType: TypeNode | undefined, questionToken: QuestionToken | PlusToken | MinusToken | undefined, type: TypeNode | undefined, members: NodeArray<TypeElement> | undefined) => MappedTypeNode;
1078510787
/** @deprecated Use `factory.createLiteralTypeNode` or the factory supplied by your transformation context instead. */
1078610788
const createLiteralTypeNode: (literal: LiteralExpression | BooleanLiteral | PrefixUnaryExpression | NullLiteral) => LiteralTypeNode;
1078710789
/** @deprecated Use `factory.updateLiteralTypeNode` or the factory supplied by your transformation context instead. */

0 commit comments

Comments
 (0)