Support transformation for types with type annotation (#550)

trivikr · web-flow · commit 5f1a930f60c1 · 2023-08-08T09:33:30.000-07:00
diff --git a/.changeset/tricky-mirrors-buy.md b/.changeset/tricky-mirrors-buy.md
@@ -0,0 +1,5 @@
+---
+"aws-sdk-js-codemod": patch
+---
+
+Support transformation for types with type annotation
diff --git a/src/transforms/v2-to-v3/__fixtures__/api-basic-type/global-require.input.ts b/src/transforms/v2-to-v3/__fixtures__/api-basic-type/global-require.input.ts
@@ -1,3 +1,3 @@
 const AWS = require("aws-sdk");
 
-const testTags: AWS.S3.Tag[] = [{ Key: "key", Value: "value" }];
+const testTags: typeof AWS.S3.Tag[] = [{ Key: "key", Value: "value" }];
diff --git a/src/transforms/v2-to-v3/__fixtures__/api-basic-type/global-require.output.ts b/src/transforms/v2-to-v3/__fixtures__/api-basic-type/global-require.output.ts
@@ -1,3 +1,3 @@
 const AWS_S3 = require("@aws-sdk/client-s3");
 
-const testTags: AWS_S3.Tag[] = [{ Key: "key", Value: "value" }];
+const testTags: typeof AWS_S3.Tag[] = [{ Key: "key", Value: "value" }];
diff --git a/src/transforms/v2-to-v3/__fixtures__/api-basic-type/service-require-deep.input.ts b/src/transforms/v2-to-v3/__fixtures__/api-basic-type/service-require-deep.input.ts
@@ -1,3 +1,3 @@
 const S3 = require("aws-sdk/clients/s3");
 
-const testTags: S3.Tag[] = [{ Key: "key", Value: "value" }];
+const testTags: typeof S3.Tag[] = [{ Key: "key", Value: "value" }];
diff --git a/src/transforms/v2-to-v3/__fixtures__/api-basic-type/service-require-deep.output.ts b/src/transforms/v2-to-v3/__fixtures__/api-basic-type/service-require-deep.output.ts
@@ -1,3 +1,3 @@
 const AWS_S3 = require("@aws-sdk/client-s3");
 
-const testTags: AWS_S3.Tag[] = [{ Key: "key", Value: "value" }];
+const testTags: typeof AWS_S3.Tag[] = [{ Key: "key", Value: "value" }];
diff --git a/src/transforms/v2-to-v3/__fixtures__/api-basic-type/service-require.input.ts b/src/transforms/v2-to-v3/__fixtures__/api-basic-type/service-require.input.ts
@@ -1,3 +1,3 @@
 const { S3 } = require("aws-sdk");
 
-const testTags: S3.Tag[] = [{ Key: "key", Value: "value" }];
+const testTags: typeof S3.Tag[] = [{ Key: "key", Value: "value" }];
diff --git a/src/transforms/v2-to-v3/__fixtures__/api-basic-type/service-require.output.ts b/src/transforms/v2-to-v3/__fixtures__/api-basic-type/service-require.output.ts
@@ -1,3 +1,3 @@
 const AWS_S3 = require("@aws-sdk/client-s3");
 
-const testTags: AWS_S3.Tag[] = [{ Key: "key", Value: "value" }];
+const testTags: typeof AWS_S3.Tag[] = [{ Key: "key", Value: "value" }];
diff --git a/src/transforms/v2-to-v3/__fixtures__/api-input-output-type/global-require.input.ts b/src/transforms/v2-to-v3/__fixtures__/api-input-output-type/global-require.input.ts
@@ -1,13 +1,13 @@
 const AWS = require("aws-sdk");
 
 const ddbClient = new AWS.DynamoDB({ region: "us-west-2" });
-const listTablesInput: AWS.DynamoDB.ListTablesInput = { Limit: 10 };
-const listTablesOutput: AWS.DynamoDB.ListTablesOutput = await ddbClient
+const listTablesInput: typeof AWS.DynamoDB.ListTablesInput = { Limit: 10 };
+const listTablesOutput: typeof AWS.DynamoDB.ListTablesOutput = await ddbClient
   .listTables(listTablesInput)
   .promise();
 
 const stsClient = new AWS.STS({ region: "us-west-2" });
-const getCallerIdentityInput: AWS.STS.GetCallerIdentityRequest = {};
-const getCallerIdentityOutput: AWS.STS.GetCallerIdentityResponse = await stsClient
+const getCallerIdentityInput: typeof AWS.STS.GetCallerIdentityRequest = {};
+const getCallerIdentityOutput: typeof AWS.STS.GetCallerIdentityResponse = await stsClient
   .getCallerIdentity(getCallerIdentityInput)
   .promise();
diff --git a/src/transforms/v2-to-v3/__fixtures__/api-input-output-type/global-require.output.ts b/src/transforms/v2-to-v3/__fixtures__/api-input-output-type/global-require.output.ts
@@ -8,11 +8,11 @@ const AWS_DynamoDB = require("@aws-sdk/client-dynamodb"),
       } = AWS_STS;
 
 const ddbClient = new DynamoDB({ region: "us-west-2" });
-const listTablesInput: AWS_DynamoDB.ListTablesCommandInput = { Limit: 10 };
-const listTablesOutput: AWS_DynamoDB.ListTablesCommandOutput = await ddbClient
+const listTablesInput: typeof AWS_DynamoDB.ListTablesCommandInput = { Limit: 10 };
+const listTablesOutput: typeof AWS_DynamoDB.ListTablesCommandOutput = await ddbClient
   .listTables(listTablesInput);
 
 const stsClient = new STS({ region: "us-west-2" });
-const getCallerIdentityInput: AWS_STS.GetCallerIdentityCommandInput = {};
-const getCallerIdentityOutput: AWS_STS.GetCallerIdentityCommandOutput = await stsClient
+const getCallerIdentityInput: typeof AWS_STS.GetCallerIdentityCommandInput = {};
+const getCallerIdentityOutput: typeof AWS_STS.GetCallerIdentityCommandOutput = await stsClient
   .getCallerIdentity(getCallerIdentityInput);
diff --git a/src/transforms/v2-to-v3/__fixtures__/api-input-output-type/service-require-deep.input.ts b/src/transforms/v2-to-v3/__fixtures__/api-input-output-type/service-require-deep.input.ts
@@ -2,13 +2,13 @@ const DynamoDB = require("aws-sdk/clients/dynamodb");
 const STS = require("aws-sdk/clients/sts");
 
 const ddbClient = new DynamoDB({ region: "us-west-2" });
-const listTablesInput: DynamoDB.ListTablesInput = { Limit: 10 };
-const listTablesOutput: DynamoDB.ListTablesOutput = await ddbClient
+const listTablesInput: typeof DynamoDB.ListTablesInput = { Limit: 10 };
+const listTablesOutput: typeof DynamoDB.ListTablesOutput = await ddbClient
   .listTables(listTablesInput)
   .promise();
 
 const stsClient = new STS({ region: "us-west-2" });
-const getCallerIdentityInput: STS.GetCallerIdentityRequest = {};
-const getCallerIdentityOutput: STS.GetCallerIdentityResponse = await stsClient
+const getCallerIdentityInput: typeof STS.GetCallerIdentityRequest = {};
+const getCallerIdentityOutput: typeof STS.GetCallerIdentityResponse = await stsClient
   .getCallerIdentity(getCallerIdentityInput)
   .promise();
diff --git a/src/transforms/v2-to-v3/__fixtures__/api-input-output-type/service-require-deep.output.ts b/src/transforms/v2-to-v3/__fixtures__/api-input-output-type/service-require-deep.output.ts
@@ -8,11 +8,11 @@ const AWS_STS = require("@aws-sdk/client-sts"),
       } = AWS_STS;
 
 const ddbClient = new DynamoDB({ region: "us-west-2" });
-const listTablesInput: AWS_DynamoDB.ListTablesCommandInput = { Limit: 10 };
-const listTablesOutput: AWS_DynamoDB.ListTablesCommandOutput = await ddbClient
+const listTablesInput: typeof AWS_DynamoDB.ListTablesCommandInput = { Limit: 10 };
+const listTablesOutput: typeof AWS_DynamoDB.ListTablesCommandOutput = await ddbClient
   .listTables(listTablesInput);
 
 const stsClient = new STS({ region: "us-west-2" });
-const getCallerIdentityInput: AWS_STS.GetCallerIdentityCommandInput = {};
-const getCallerIdentityOutput: AWS_STS.GetCallerIdentityCommandOutput = await stsClient
+const getCallerIdentityInput: typeof AWS_STS.GetCallerIdentityCommandInput = {};
+const getCallerIdentityOutput: typeof AWS_STS.GetCallerIdentityCommandOutput = await stsClient
   .getCallerIdentity(getCallerIdentityInput);
diff --git a/src/transforms/v2-to-v3/__fixtures__/api-input-output-type/service-require.input.ts b/src/transforms/v2-to-v3/__fixtures__/api-input-output-type/service-require.input.ts
@@ -2,13 +2,13 @@ const { DynamoDB } = require("aws-sdk");
 const { STS } = require("aws-sdk");
 
 const ddbClient = new DynamoDB({ region: "us-west-2" });
-const listTablesInput: DynamoDB.ListTablesInput = { Limit: 10 };
-const listTablesOutput: DynamoDB.ListTablesOutput = await ddbClient
+const listTablesInput: typeof DynamoDB.ListTablesInput = { Limit: 10 };
+const listTablesOutput: typeof DynamoDB.ListTablesOutput = await ddbClient
   .listTables(listTablesInput)
   .promise();
 
 const stsClient = new STS({ region: "us-west-2" });
-const getCallerIdentityInput: STS.GetCallerIdentityRequest = {};
-const getCallerIdentityOutput: STS.GetCallerIdentityResponse = await stsClient
+const getCallerIdentityInput: typeof STS.GetCallerIdentityRequest = {};
+const getCallerIdentityOutput: typeof STS.GetCallerIdentityResponse = await stsClient
   .getCallerIdentity(getCallerIdentityInput)
   .promise();
diff --git a/src/transforms/v2-to-v3/__fixtures__/api-input-output-type/service-require.output.ts b/src/transforms/v2-to-v3/__fixtures__/api-input-output-type/service-require.output.ts
@@ -8,11 +8,11 @@ const AWS_STS = require("@aws-sdk/client-sts"),
       } = AWS_STS;
 
 const ddbClient = new DynamoDB({ region: "us-west-2" });
-const listTablesInput: AWS_DynamoDB.ListTablesCommandInput = { Limit: 10 };
-const listTablesOutput: AWS_DynamoDB.ListTablesCommandOutput = await ddbClient
+const listTablesInput: typeof AWS_DynamoDB.ListTablesCommandInput = { Limit: 10 };
+const listTablesOutput: typeof AWS_DynamoDB.ListTablesCommandOutput = await ddbClient
   .listTables(listTablesInput);
 
 const stsClient = new STS({ region: "us-west-2" });
-const getCallerIdentityInput: AWS_STS.GetCallerIdentityCommandInput = {};
-const getCallerIdentityOutput: AWS_STS.GetCallerIdentityCommandOutput = await stsClient
+const getCallerIdentityInput: typeof AWS_STS.GetCallerIdentityCommandInput = {};
+const getCallerIdentityOutput: typeof AWS_STS.GetCallerIdentityCommandOutput = await stsClient
   .getCallerIdentity(getCallerIdentityInput);
diff --git a/src/transforms/v2-to-v3/__fixtures__/ddb-doc-client-input-output-type/global-require.input.ts b/src/transforms/v2-to-v3/__fixtures__/ddb-doc-client-input-output-type/global-require.input.ts
@@ -2,10 +2,10 @@ const AWS = require("aws-sdk");
 
 const docClient = new AWS.DynamoDB.DocumentClient({ region: "us-west-2" });
 
-const docClientScanInput: AWS.DynamoDB.DocumentClient.ScanInput = {
+const docClientScanInput: typeof AWS.DynamoDB.DocumentClient.ScanInput = {
   TableName: "TableName"
 };
 
-const docClientScanOutput: AWS.DynamoDB.DocumentClient.ScanOutput = await docClient
+const docClientScanOutput: typeof AWS.DynamoDB.DocumentClient.ScanOutput = await docClient
   .scan(docClientScanInput)
   .promise();
diff --git a/src/transforms/v2-to-v3/__fixtures__/ddb-doc-client-input-output-type/global-require.output.ts b/src/transforms/v2-to-v3/__fixtures__/ddb-doc-client-input-output-type/global-require.output.ts
@@ -8,9 +8,9 @@ const AWS_DynamoDBDocumentClient = require("@aws-sdk/lib-dynamodb"),
 
 const docClient = DynamoDBDocument.from(new DynamoDB({ region: "us-west-2" }));
 
-const docClientScanInput: AWS_DynamoDBDocumentClient.ScanCommandInput = {
+const docClientScanInput: typeof AWS_DynamoDBDocumentClient.ScanCommandInput = {
   TableName: "TableName"
 };
 
-const docClientScanOutput: AWS_DynamoDBDocumentClient.ScanCommandOutput = await docClient
+const docClientScanOutput: typeof AWS_DynamoDBDocumentClient.ScanCommandOutput = await docClient
   .scan(docClientScanInput);
diff --git a/src/transforms/v2-to-v3/__fixtures__/ddb-doc-client-input-output-type/service-require-deep.input.ts b/src/transforms/v2-to-v3/__fixtures__/ddb-doc-client-input-output-type/service-require-deep.input.ts
@@ -2,10 +2,10 @@ const DynDB = require("aws-sdk/clients/dynamodb");
 
 const docClient = new DynDB.DocumentClient({ region: "us-west-2" });
 
-const docClientScanInput: DynDB.DocumentClient.ScanInput = {
+const docClientScanInput: typeof DynDB.DocumentClient.ScanInput = {
   TableName: "TableName"
 };
 
-const docClientScanOutput: DynDB.DocumentClient.ScanOutput = await docClient
+const docClientScanOutput: typeof DynDB.DocumentClient.ScanOutput = await docClient
   .scan(docClientScanInput)
   .promise();
diff --git a/src/transforms/v2-to-v3/__fixtures__/ddb-doc-client-input-output-type/service-require-deep.output.ts b/src/transforms/v2-to-v3/__fixtures__/ddb-doc-client-input-output-type/service-require-deep.output.ts
@@ -8,9 +8,9 @@ const AWS_DynDBDocumentClient = require("@aws-sdk/lib-dynamodb"),
 
 const docClient = DynamoDBDocument.from(new DynDB({ region: "us-west-2" }));
 
-const docClientScanInput: AWS_DynDBDocumentClient.ScanCommandInput = {
+const docClientScanInput: typeof AWS_DynDBDocumentClient.ScanCommandInput = {
   TableName: "TableName"
 };
 
-const docClientScanOutput: AWS_DynDBDocumentClient.ScanCommandOutput = await docClient
+const docClientScanOutput: typeof AWS_DynDBDocumentClient.ScanCommandOutput = await docClient
   .scan(docClientScanInput);
diff --git a/src/transforms/v2-to-v3/__fixtures__/ddb-doc-client-input-output-type/service-require.input.ts b/src/transforms/v2-to-v3/__fixtures__/ddb-doc-client-input-output-type/service-require.input.ts
@@ -2,10 +2,10 @@ const { DynamoDB: DynDB } = require("aws-sdk");
 
 const docClient = new DynDB.DocumentClient({ region: "us-west-2" });
 
-const docClientScanInput: DynDB.DocumentClient.ScanInput = {
+const docClientScanInput: typeof DynDB.DocumentClient.ScanInput = {
   TableName: "TableName"
 };
 
-const docClientScanOutput: DynDB.DocumentClient.ScanOutput = await docClient
+const docClientScanOutput: typeof DynDB.DocumentClient.ScanOutput = await docClient
   .scan(docClientScanInput)
   .promise();
diff --git a/src/transforms/v2-to-v3/__fixtures__/ddb-doc-client-input-output-type/service-require.output.ts b/src/transforms/v2-to-v3/__fixtures__/ddb-doc-client-input-output-type/service-require.output.ts
@@ -8,9 +8,9 @@ const AWS_DynDBDocumentClient = require("@aws-sdk/lib-dynamodb"),
 
 const docClient = DynamoDBDocument.from(new DynDB({ region: "us-west-2" }));
 
-const docClientScanInput: AWS_DynDBDocumentClient.ScanCommandInput = {
+const docClientScanInput: typeof AWS_DynDBDocumentClient.ScanCommandInput = {
   TableName: "TableName"
 };
 
-const docClientScanOutput: AWS_DynDBDocumentClient.ScanCommandOutput = await docClient
+const docClientScanOutput: typeof AWS_DynDBDocumentClient.ScanCommandOutput = await docClient
   .scan(docClientScanInput);
diff --git a/src/transforms/v2-to-v3/transformer.ts b/src/transforms/v2-to-v3/transformer.ts
@@ -22,7 +22,7 @@ import {
   removeClientModule,
   removeGlobalModule,
 } from "./modules";
-import { replaceTSTypeReference } from "./ts-type";
+import { replaceTSQualifiedName } from "./ts-type";
 import { isTypeScriptFile } from "./utils";
 
 const transformer = async (file: FileInfo, api: API) => {
@@ -69,7 +69,7 @@ const transformer = async (file: FileInfo, api: API) => {
     const v3Options = { v3ClientName, v3ClientPackageName };
 
     addClientModules(j, source, { ...v2Options, ...v3Options, clientIdentifiers });
-    replaceTSTypeReference(j, source, { ...v2Options, v3ClientName });
+    replaceTSQualifiedName(j, source, { ...v2Options, v3ClientName });
     removeClientModule(j, source, v2Options);
 
     if (v2ClientName === S3) {
diff --git a/src/transforms/v2-to-v3/ts-type/getClientTypeNames.ts b/src/transforms/v2-to-v3/ts-type/getClientTypeNames.ts
@@ -1,4 +1,4 @@
-import { Collection, Identifier, JSCodeshift, TSQualifiedName, TSTypeReference } from "jscodeshift";
+import { Collection, Identifier, JSCodeshift, TSQualifiedName } from "jscodeshift";
 
 import { getImportSpecifiers } from "../modules";
 import { getClientDeepImportPath } from "../utils";
@@ -14,12 +14,13 @@ type DeepPartial<T> = Partial<{ [P in keyof T]: DeepPartial<T[P]> }>;
 const getRightIdentifierName = (
   j: JSCodeshift,
   source: Collection<unknown>,
-  tsTypeRef: DeepPartial<TSTypeReference>
+  tsQualifiedName: DeepPartial<TSQualifiedName>
 ) =>
   source
-    .find(j.TSTypeReference, tsTypeRef)
+    .find(j.TSQualifiedName, tsQualifiedName)
+    .filter((tsQualifiedName) => tsQualifiedName.parentPath?.value.type !== "TSQualifiedName")
     .nodes()
-    .map((node) => (node.typeName as TSQualifiedName).right)
+    .map((node) => node.right)
     .filter((node) => node.type === "Identifier")
     .map((node) => (node as Identifier).name);
 
@@ -36,21 +37,19 @@ export const getClientTypeNames = (
 
     clientTypeNames.push(
       ...getRightIdentifierName(j, source, {
-        typeName: {
-          left: {
-            ...(subClientName
-              ? {
-                  left: {
-                    left: { type: "Identifier", name: v2GlobalName },
-                    right: { type: "Identifier", name: clientName },
-                  },
-                  right: { type: "Identifier", name: subClientName },
-                }
-              : {
+        left: {
+          ...(subClientName
+            ? {
+                left: {
                   left: { type: "Identifier", name: v2GlobalName },
                   right: { type: "Identifier", name: clientName },
-                }),
-          },
+                },
+                right: { type: "Identifier", name: subClientName },
+              }
+            : {
+                left: { type: "Identifier", name: v2GlobalName },
+                right: { type: "Identifier", name: clientName },
+              }),
         },
       })
     );
@@ -61,16 +60,14 @@ export const getClientTypeNames = (
 
   clientTypeNames.push(
     ...getRightIdentifierName(j, source, {
-      typeName: {
-        ...(subClientName
-          ? {
-              left: {
-                left: { type: "Identifier", name: clientName },
-                right: { type: "Identifier", name: subClientName },
-              },
-            }
-          : { left: { type: "Identifier", name: clientName } }),
-      },
+      ...(subClientName
+        ? {
+            left: {
+              left: { type: "Identifier", name: clientName },
+              right: { type: "Identifier", name: subClientName },
+            },
+          }
+        : { left: { type: "Identifier", name: clientName } }),
     })
   );
 
diff --git a/src/transforms/v2-to-v3/ts-type/index.ts b/src/transforms/v2-to-v3/ts-type/index.ts
@@ -1,4 +1,4 @@
 export * from "./getClientTypeNames";
 export * from "./getV3ClientTypeReference";
 export * from "./getV3ClientTypesCount";
-export * from "./replaceTSTypeReference";
+export * from "./replaceTSQualifiedName";
diff --git a/src/transforms/v2-to-v3/ts-type/replaceTSQualifiedName.ts b/src/transforms/v2-to-v3/ts-type/replaceTSQualifiedName.ts

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"aws-sdk-js-codemod": patch
 +---
++
 +Support transformation for types with type annotation
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`const AWS = require("aws-sdk");`
`2`	`2`
`3`		`-const testTags: AWS.S3.Tag[] = [{ Key: "key", Value: "value" }];`
	`3`	`+const testTags: typeof AWS.S3.Tag[] = [{ Key: "key", Value: "value" }];`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`const AWS_S3 = require("@aws-sdk/client-s3");`
`2`	`2`
`3`		`-const testTags: AWS_S3.Tag[] = [{ Key: "key", Value: "value" }];`
	`3`	`+const testTags: typeof AWS_S3.Tag[] = [{ Key: "key", Value: "value" }];`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`const S3 = require("aws-sdk/clients/s3");`
`2`	`2`
`3`		`-const testTags: S3.Tag[] = [{ Key: "key", Value: "value" }];`
	`3`	`+const testTags: typeof S3.Tag[] = [{ Key: "key", Value: "value" }];`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`const { S3 } = require("aws-sdk");`
`2`	`2`
`3`		`-const testTags: S3.Tag[] = [{ Key: "key", Value: "value" }];`
	`3`	`+const testTags: typeof S3.Tag[] = [{ Key: "key", Value: "value" }];`