feature: TSTypeOperator: keyof (#16799)

coderaiser · coderaiser · commit 0f8f3a8ee14b · 2024-12-05T22:36:24.000+02:00
diff --git a/packages/babel-types/scripts/generators/validators.js b/packages/babel-types/scripts/generators/validators.js
@@ -92,6 +92,7 @@ type Opts<Obj> = Partial<{
 `;
 
   Object.keys(VISITOR_KEYS).forEach(type => {
+    if (type === "TSClassImplements") console.log(">>>");
     output += addIsHelper(type);
   });
 
diff --git a/packages/babel-types/src/ast-types/generated/index.ts b/packages/babel-types/src/ast-types/generated/index.ts
@@ -1925,7 +1925,7 @@ export interface TSParenthesizedType extends BaseNode {
 export interface TSTypeOperator extends BaseNode {
   type: "TSTypeOperator";
   typeAnnotation: TSType;
-  operator: string;
+  operator: "keyof" | "readonly" | "unique";
 }
 
 export interface TSIndexedAccessType extends BaseNode {
diff --git a/packages/babel-types/src/builders/generated/index.ts b/packages/babel-types/src/builders/generated/index.ts
@@ -3021,14 +3021,18 @@ export function tsParenthesizedType(
   return node;
 }
 export { tsParenthesizedType as tSParenthesizedType };
-export function tsTypeOperator(typeAnnotation: t.TSType): t.TSTypeOperator {
+export function tsTypeOperator(
+  typeAnnotation: t.TSType,
+  operator: "keyof" | "readonly" | "unique",
+): t.TSTypeOperator {
   const node: t.TSTypeOperator = {
     type: "TSTypeOperator",
     typeAnnotation,
-    operator: null,
+    operator,
   };
   const defs = NODE_FIELDS.TSTypeOperator;
   validate(defs.typeAnnotation, node, "typeAnnotation", typeAnnotation, 1);
+  validate(defs.operator, node, "operator", operator);
   return node;
 }
 export { tsTypeOperator as tSTypeOperator };
diff --git a/packages/babel-types/src/definitions/typescript.ts b/packages/babel-types/src/definitions/typescript.ts
@@ -337,9 +337,11 @@ defineType("TSParenthesizedType", {
 
 defineType("TSTypeOperator", {
   aliases: ["TSType"],
-  visitor: ["typeAnnotation"],
+  visitor: ["typeAnnotation", "operator"],
   fields: {
-    operator: validate(assertValueType("string")),
+    operator: {
+      validate: assertOneOf("keyof", "readonly", "unique"),
+    },
     typeAnnotation: validateType("TSType"),
   },
 });
diff --git a/packages/babel-types/test/builders/typescript/tsTypeOperator.js b/packages/babel-types/test/builders/typescript/tsTypeOperator.js
@@ -0,0 +1,28 @@
+import * as t from "../../../lib/index.js";
+
+describe("builders", function () {
+  describe("typescript", function () {
+    describe("tsTypeOperator", function () {
+      it("accept operator as argument for tsTypeOperator", function () {
+        const tsTypeOperator = t.TSTypeOperator(
+          t.TSTypeQuery(t.Identifier("x")),
+          "keyof",
+        );
+        expect(tsTypeOperator).toMatchInlineSnapshot(`
+          Object {
+            "operator": "keyof",
+            "type": "TSTypeOperator",
+            "typeAnnotation": Object {
+              "exprName": Object {
+                "name": "x",
+                "type": "Identifier",
+              },
+              "type": "TSTypeQuery",
+              "typeParameters": null,
+            },
+          }
+          `);
+      });
+    });
+  });
+});

Original file line number	Diff line number	Diff line change
`@@ -1925,7 +1925,7 @@ export interface TSParenthesizedType extends BaseNode {`
`1925`	`1925`	`export interface TSTypeOperator extends BaseNode {`
`1926`	`1926`	`type: "TSTypeOperator";`
`1927`	`1927`	`typeAnnotation: TSType;`
`1928`		`- operator: string;`
	`1928`	`+ operator: "keyof" \| "readonly" \| "unique";`
`1929`	`1929`	`}`
`1930`	`1930`
`1931`	`1931`	`export interface TSIndexedAccessType extends BaseNode {`