Add utility getV2ClientTSTypeRef (#230)

Author: trivikr

.changeset/angry-jokes-give.md

@@ -0,0 +1,5 @@
+---
+"aws-sdk-js-codemod": patch
+---
+
+Add utility getV2ClientTSTypeRef

src/transforms/v2-to-v3/utils/get/getV2ClientTSTypeRef.ts

@@ -0,0 +1,34 @@
+import { Identifier, TSQualifiedName, TSTypeReference } from "jscodeshift";
+
+export interface V2ClientTsTypeRefOptions {
+  v2DefaultModuleName?: string;
+  v2ClientName: string;
+  withoutRightSection?: boolean;
+}
+
+export const getV2ClientTSTypeRef = ({
+  v2DefaultModuleName,
+  v2ClientName,
+  withoutRightSection = false,
+}: V2ClientTsTypeRefOptions): TSTypeReference => {
+  if (v2DefaultModuleName) {
+    const idWithGlobalName = {
+      type: "TSQualifiedName",
+      left: { type: "Identifier", name: v2DefaultModuleName },
+      right: { type: "Identifier", name: v2ClientName },
+    } as TSQualifiedName;
+
+    return {
+      typeName: {
+        ...(withoutRightSection ? { left: idWithGlobalName } : idWithGlobalName),
+      },
+    } as TSTypeReference;
+  }
+
+  const idWithClientName = { type: "Identifier", name: v2ClientName } as Identifier;
+  return {
+    typeName: {
+      ...(withoutRightSection ? { left: idWithClientName } : idWithClientName),
+    },
+  } as TSTypeReference;
+};

src/transforms/v2-to-v3/utils/get/getV2ClientTypeNames.ts

@@ -8,56 +8,54 @@ import {
   TSTypeReference,
 } from "jscodeshift";
 
+import { getV2ClientTSTypeRef } from "./getV2ClientTSTypeRef";
 import { getV2ServiceModulePath } from "./getV2ServiceModulePath";
 
 export interface GetV2ClientTypeNamesOptions {
   v2ClientName: string;
   v2DefaultModuleName: string;
 }
 
-const getRightIdentifierName = (node: TSTypeReference) =>
-  ((node.typeName as TSQualifiedName).right as Identifier).name;
+const getRightIdentifierName = (
+  j: JSCodeshift,
+  source: Collection<unknown>,
+  tsTypeRef: TSTypeReference
+) =>
+  source
+    .find(j.TSTypeReference, tsTypeRef)
+    .nodes()
+    .map((node) => (node.typeName as TSQualifiedName).right)
+    .filter((node) => node.type === "Identifier")
+    .map((node) => (node as Identifier).name);
 
 export const getV2ClientTypeNames = (
   j: JSCodeshift,
   source: Collection<unknown>,
   { v2ClientName, v2DefaultModuleName }: GetV2ClientTypeNamesOptions
 ): string[] => {
-  const v2DefaultTypeName = {
-    typeName: {
-      left: {
-        left: { type: "Identifier", name: v2DefaultModuleName },
-        right: { type: "Identifier", name: v2ClientName },
-      },
-    },
-  } as TSTypeReference;
-
-  const v2ClientTypeName = {
-    typeName: {
-      left: { type: "Identifier", name: v2ClientName },
-    },
-  } as TSTypeReference;
+  const v2GlobalTSTypeRef = getV2ClientTSTypeRef({
+    v2ClientName,
+    v2DefaultModuleName,
+    withoutRightSection: true,
+  });
+  const v2ClientTSTypeRef = getV2ClientTSTypeRef({ v2ClientName, withoutRightSection: true });
 
-  const v2ClientTypeFromNamedImport = {
+  const v2ServiceModuleImportDeclaration = {
     type: "ImportDeclaration",
     source: { value: getV2ServiceModulePath(v2ClientName) },
   } as ImportDeclaration;
 
   return [
-    ...source
-      .find(j.TSTypeReference, v2DefaultTypeName)
-      .nodes()
-      .map((node) => getRightIdentifierName(node)),
-    ...source
-      .find(j.TSTypeReference, v2ClientTypeName)
-      .nodes()
-      .map((node) => getRightIdentifierName(node)),
-    ...source
-      .find(j.ImportDeclaration, v2ClientTypeFromNamedImport)
-      .nodes()
-      .map((node) => node.specifiers)
-      .flat()
-      .filter((node) => (node as ImportSpecifier).type === "ImportSpecifier")
-      .map((node) => ((node as ImportSpecifier).local as Identifier).name),
+    ...new Set([
+      ...getRightIdentifierName(j, source, v2GlobalTSTypeRef),
+      ...getRightIdentifierName(j, source, v2ClientTSTypeRef),
+      ...source
+        .find(j.ImportDeclaration, v2ServiceModuleImportDeclaration)
+        .nodes()
+        .map((node) => node.specifiers)
+        .flat()
+        .filter((node) => (node as ImportSpecifier).type === "ImportSpecifier")
+        .map((node) => ((node as ImportSpecifier).local as Identifier).name),
+    ]),
   ];
 };

src/transforms/v2-to-v3/utils/get/index.ts

@@ -5,6 +5,7 @@ export * from "./getV2ClientIdThisExpressions";
 export * from "./getV2ClientNames";
 export * from "./getV2ClientNamesFromDefault";
 export * from "./getV2ClientNewExpression";
+export * from "./getV2ClientTSTypeRef";
 export * from "./getV2ClientTypeNames";
 export * from "./getV2DefaultModuleName";
 export * from "./getV2ServiceModulePath";

src/transforms/v2-to-v3/utils/replace/replaceTSTypeReference.ts

@@ -1,13 +1,6 @@
-import {
-  ASTPath,
-  Collection,
-  Identifier,
-  JSCodeshift,
-  TSQualifiedName,
-  TSTypeReference,
-} from "jscodeshift";
+import { Collection, Identifier, JSCodeshift, TSQualifiedName, TSTypeReference } from "jscodeshift";
 
-import { getV2ClientTypeNames, getV3ClientTypeName } from "../get";
+import { getV2ClientTSTypeRef, getV2ClientTypeNames, getV3ClientTypeName } from "../get";
 import { isV2ClientInputOutputType } from "../isV2ClientInputOutputType";
 
 export interface ReplaceTypeReferenceOptions {
@@ -16,6 +9,9 @@ export interface ReplaceTypeReferenceOptions {
   v2DefaultModuleName: string;
 }
 
+const isRightSectionIdentifier = (node: TSTypeReference) =>
+  (node.typeName as TSQualifiedName).right.type === "Identifier";
+
 const getRightIdentifierName = (node: TSTypeReference) =>
   ((node.typeName as TSQualifiedName).right as Identifier).name;
 
@@ -29,38 +25,25 @@ export const replaceTSTypeReference = (
 ): void => {
   // Replace type reference to client created with default module.
   source
-    .find(j.TSTypeReference, {
-      typeName: {
-        left: { type: "Identifier", name: v2DefaultModuleName },
-        right: { type: "Identifier", name: v2ClientName },
-      },
-    })
+    .find(j.TSTypeReference, getV2ClientTSTypeRef({ v2ClientName, v2DefaultModuleName }))
     .replaceWith((v2ClientType) =>
       j.tsTypeReference(j.identifier(v3ClientName), v2ClientType.node.typeParameters)
     );
 
   // Replace type reference to client input/output created with default module.
   source
-    .find(j.TSTypeReference, {
-      typeName: {
-        type: "TSQualifiedName",
-        left: {
-          left: { type: "Identifier", name: v2DefaultModuleName },
-          right: { type: "Identifier", name: v2ClientName },
-        },
-        right: { type: "Identifier" },
-      },
-    })
+    .find(
+      j.TSTypeReference,
+      getV2ClientTSTypeRef({ v2ClientName, v2DefaultModuleName, withoutRightSection: true })
+    )
+    .filter((v2ClientType) => isRightSectionIdentifier(v2ClientType.node))
     .filter((v2ClientType) => isV2ClientInputOutputType(getRightIdentifierName(v2ClientType.node)))
     .replaceWith((v2ClientType) => getV3ClientTypeName(getRightIdentifierName(v2ClientType.node)));
 
   // Replace type reference to client created with client module.
   source
-    .find(j.TSTypeReference, {
-      typeName: {
-        left: { type: "Identifier", name: v2ClientName },
-      },
-    })
+    .find(j.TSTypeReference, getV2ClientTSTypeRef({ v2ClientName, withoutRightSection: true }))
+    .filter((v2ClientType) => isRightSectionIdentifier(v2ClientType.node))
     .filter((v2ClientType) => isV2ClientInputOutputType(getRightIdentifierName(v2ClientType.node)))
     .replaceWith((v2ClientType) => getV3ClientTypeName(getRightIdentifierName(v2ClientType.node)));
 
@@ -69,9 +52,7 @@ export const replaceTSTypeReference = (
   for (const v2ClientTypeName of v2ClientTypeNames) {
     if (isV2ClientInputOutputType(v2ClientTypeName)) {
       source
-        .find(j.TSTypeReference, {
-          typeName: { type: "Identifier", name: v2ClientTypeName },
-        })
+        .find(j.TSTypeReference, { typeName: { type: "Identifier", name: v2ClientTypeName } })
         .filter((v2ClientType) => isV2ClientInputOutputType(getIdentifierName(v2ClientType.node)))
         .replaceWith((v2ClientType) => getV3ClientTypeName(getIdentifierName(v2ClientType.node)));
     }