Transform types imported from Types (#726)

trivikr · web-flow · commit aa735f740a58 · 2023-11-13T09:02:01.000-08:00
diff --git a/.changeset/two-cups-fry.md b/.changeset/two-cups-fry.md
@@ -0,0 +1,5 @@
+---
+"aws-sdk-js-codemod": minor
+---
+
+Transform types imported from redundant Types
diff --git a/src/transforms/v2-to-v3/__fixtures__/api-basic-types/global-import-equals.input.ts b/src/transforms/v2-to-v3/__fixtures__/api-basic-types/global-import-equals.input.ts
@@ -0,0 +1,3 @@
+import AWS = require("aws-sdk");
+
+const testTags: AWS.S3.Types.Tag[] = [{ Key: "key", Value: "value" }];
diff --git a/src/transforms/v2-to-v3/__fixtures__/api-basic-types/global-import-equals.output.ts b/src/transforms/v2-to-v3/__fixtures__/api-basic-types/global-import-equals.output.ts
@@ -0,0 +1,4 @@
+import AWS_client_s3 = require("@aws-sdk/client-s3");
+import Tag = AWS_client_s3.Tag;
+
+const testTags: Tag[] = [{ Key: "key", Value: "value" }];
diff --git a/src/transforms/v2-to-v3/__fixtures__/api-basic-types/global-import.input.ts b/src/transforms/v2-to-v3/__fixtures__/api-basic-types/global-import.input.ts
@@ -0,0 +1,3 @@
+import AWS from "aws-sdk";
+
+const testTags: AWS.S3.Types.Tag[] = [{ Key: "key", Value: "value" }];
diff --git a/src/transforms/v2-to-v3/__fixtures__/api-basic-types/global-import.output.ts b/src/transforms/v2-to-v3/__fixtures__/api-basic-types/global-import.output.ts
@@ -0,0 +1,3 @@
+import { Tag } from "@aws-sdk/client-s3";
+
+const testTags: Tag[] = [{ Key: "key", Value: "value" }];
diff --git a/src/transforms/v2-to-v3/__fixtures__/api-basic-types/service-import-deep.input.ts b/src/transforms/v2-to-v3/__fixtures__/api-basic-types/service-import-deep.input.ts
@@ -0,0 +1,3 @@
+import S3 from "aws-sdk/clients/s3";
+
+const testTags: S3.Types.Tag[] = [{ Key: "key", Value: "value" }];
diff --git a/src/transforms/v2-to-v3/__fixtures__/api-basic-types/service-import-deep.output.ts b/src/transforms/v2-to-v3/__fixtures__/api-basic-types/service-import-deep.output.ts
@@ -0,0 +1,3 @@
+import { Tag } from "@aws-sdk/client-s3";
+
+const testTags: Tag[] = [{ Key: "key", Value: "value" }];
diff --git a/src/transforms/v2-to-v3/__fixtures__/api-basic-types/service-import-equals.input.ts b/src/transforms/v2-to-v3/__fixtures__/api-basic-types/service-import-equals.input.ts
@@ -0,0 +1,3 @@
+import S3 = require("aws-sdk/clients/s3");
+
+const testTags: S3.Types.Tag[] = [{ Key: "key", Value: "value" }];
diff --git a/src/transforms/v2-to-v3/__fixtures__/api-basic-types/service-import-equals.output.ts b/src/transforms/v2-to-v3/__fixtures__/api-basic-types/service-import-equals.output.ts
@@ -0,0 +1,4 @@
+import AWS_client_s3 = require("@aws-sdk/client-s3");
+import Tag = AWS_client_s3.Tag;
+
+const testTags: Tag[] = [{ Key: "key", Value: "value" }];
diff --git a/src/transforms/v2-to-v3/__fixtures__/api-basic-types/service-import.input.ts b/src/transforms/v2-to-v3/__fixtures__/api-basic-types/service-import.input.ts
@@ -0,0 +1,3 @@
+import { S3 } from "aws-sdk";
+
+const testTags: S3.Types.Tag[] = [{ Key: "key", Value: "value" }];
diff --git a/src/transforms/v2-to-v3/__fixtures__/api-basic-types/service-import.output.ts b/src/transforms/v2-to-v3/__fixtures__/api-basic-types/service-import.output.ts
@@ -0,0 +1,3 @@
+import { Tag } from "@aws-sdk/client-s3";
+
+const testTags: Tag[] = [{ Key: "key", Value: "value" }];
diff --git a/src/transforms/v2-to-v3/transformer.ts b/src/transforms/v2-to-v3/transformer.ts
@@ -30,7 +30,7 @@ import {
   removeClientModule,
   removeGlobalModule,
 } from "./modules";
-import { replaceTSTypeReference } from "./ts-type";
+import { removeTypesFromTSQualifiedName, replaceTSTypeReference } from "./ts-type";
 import {
   IndentationType,
   getFormattedSourceString,
@@ -91,6 +91,8 @@ const transformer = async (file: FileInfo, api: API) => {
     const v2Options = { v2ClientName, v2ClientLocalName, v2GlobalName };
     const v3Options = { v3ClientName, v3ClientPackageName };
 
+    // Remove redundant `Types` from Client Types.
+    removeTypesFromTSQualifiedName(j, source, v2ClientName);
     addClientModules(j, source, { ...v2Options, ...v3Options, clientIdentifiers, importType });
     replaceTSTypeReference(j, source, { ...v2Options, v3ClientName });
     removeClientModule(j, source, { ...v2Options, importType });
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,5 @@
 export * from "./getClientTypeNames";
 export * from "./getV3ClientType";
 export * from "./getV3ClientTypes";
+export * from "./removeTypesFromTSQualifiedName";
 export * from "./replaceTSTypeReference";
diff --git a/src/transforms/v2-to-v3/ts-type/removeTypesFromTSQualifiedName.ts b/src/transforms/v2-to-v3/ts-type/removeTypesFromTSQualifiedName.ts
@@ -0,0 +1,25 @@
+import { Collection, JSCodeshift } from "jscodeshift";
+
+export const removeTypesFromTSQualifiedName = (
+  j: JSCodeshift,
+  source: Collection<unknown>,
+  v2ClientName: string
+) => {
+  // Support for DynamoDB.DocumentClient
+  const [, clientNameSuffix] = v2ClientName.split(".");
+  const clientName = clientNameSuffix ? clientNameSuffix : v2ClientName;
+
+  source
+    .find(j.TSQualifiedName, {
+      left: { type: "Identifier", name: clientName },
+      right: { type: "Identifier", name: "Types" },
+    })
+    .replaceWith((nodePath) => nodePath.node.left);
+
+  source
+    .find(j.TSQualifiedName, {
+      left: { type: "TSQualifiedName", right: { type: "Identifier", name: clientName } },
+      right: { type: "Identifier", name: "Types" },
+    })
+    .replaceWith((nodePath) => nodePath.node.left);
+};

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"aws-sdk-js-codemod": minor
 +---
++
 +Transform types imported from redundant Types
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import AWS = require("aws-sdk");`
	`2`	`+`
	`3`	`+const testTags: AWS.S3.Types.Tag[] = [{ Key: "key", Value: "value" }];`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import AWS from "aws-sdk";`
	`2`	`+`
	`3`	`+const testTags: AWS.S3.Types.Tag[] = [{ Key: "key", Value: "value" }];`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import { Tag } from "@aws-sdk/client-s3";`
	`2`	`+`
	`3`	`+const testTags: Tag[] = [{ Key: "key", Value: "value" }];`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import S3 from "aws-sdk/clients/s3";`
	`2`	`+`
	`3`	`+const testTags: S3.Types.Tag[] = [{ Key: "key", Value: "value" }];`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import S3 = require("aws-sdk/clients/s3");`
	`2`	`+`
	`3`	`+const testTags: S3.Types.Tag[] = [{ Key: "key", Value: "value" }];`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import { S3 } from "aws-sdk";`
	`2`	`+`
	`3`	`+const testTags: S3.Types.Tag[] = [{ Key: "key", Value: "value" }];`