Remove suffix Reference from utilities which return types (#558)

Author: trivikr

src/transforms/v2-to-v3/ts-type/getTypeRefForString.ts renamed to src/transforms/v2-to-v3/ts-type/getTypeForString.ts

@@ -3,7 +3,7 @@ import { JSCodeshift, TSType } from "jscodeshift";
 const arrayRegex = /^Array<(.*)>$/;
 const recordRegex = /^Record<string, (.*)>$/;
 
-export const getTypeRefForString = (
+export const getTypeForString = (
   j: JSCodeshift,
   v3ClientDefaultLocalName: string,
   v3ClientTypeString: string
@@ -27,7 +27,7 @@ export const getTypeRefForString = (
   const arrayRegexMatches = arrayRegex.exec(v3ClientTypeString);
   if (arrayRegexMatches) {
     const type = arrayRegexMatches[1];
-    const typeArgument = getTypeRefForString(j, v3ClientDefaultLocalName, type);
+    const typeArgument = getTypeForString(j, v3ClientDefaultLocalName, type);
     return j.tsTypeReference.from({
       typeName: j.identifier("Array"),
       // eslint-disable-next-line @typescript-eslint/ban-ts-comment
@@ -39,7 +39,7 @@ export const getTypeRefForString = (
   const recordRegexMatches = recordRegex.exec(v3ClientTypeString);
   if (recordRegexMatches) {
     const type = recordRegexMatches[1];
-    const typeArgument = getTypeRefForString(j, v3ClientDefaultLocalName, type);
+    const typeArgument = getTypeForString(j, v3ClientDefaultLocalName, type);
     return j.tsTypeReference.from({
       typeName: j.identifier("Record"),
       // eslint-disable-next-line @typescript-eslint/ban-ts-comment

src/transforms/v2-to-v3/ts-type/getV3ClientTypeReference.ts renamed to src/transforms/v2-to-v3/ts-type/getV3ClientType.ts

@@ -6,9 +6,9 @@ import {
   V2_CLIENT_OUTPUT_SUFFIX_LIST,
 } from "../config";
 import { getDefaultLocalName } from "../utils";
-import { getTypeRefForString } from "./getTypeRefForString";
+import { getTypeForString } from "./getTypeForString";
 
-export interface GetV3ClientTypeReferenceOptions {
+export interface GetV3ClientTypeOptions {
   v2ClientLocalName: string;
   v2ClientName: string;
   v2ClientTypeName: string;
@@ -20,15 +20,15 @@ const getTypeRefWithV3ClientDefaultLocalName = (
   v3ClientTypeName: string
 ) => j.tsTypeReference(j.identifier([v3ClientDefaultLocalName, v3ClientTypeName].join(".")));
 
-export const getV3ClientTypeReference = (
+export const getV3ClientType = (
   j: JSCodeshift,
-  { v2ClientLocalName, v2ClientName, v2ClientTypeName }: GetV3ClientTypeReferenceOptions
+  { v2ClientLocalName, v2ClientName, v2ClientTypeName }: GetV3ClientTypeOptions
 ): TSType => {
   const clientTypesMap = CLIENT_TYPES_MAP[v2ClientName];
   const defaultLocalName = getDefaultLocalName(v2ClientLocalName);
 
   if (Object.keys(clientTypesMap).includes(v2ClientTypeName)) {
-    return getTypeRefForString(j, defaultLocalName, clientTypesMap[v2ClientTypeName]);
+    return getTypeForString(j, defaultLocalName, clientTypesMap[v2ClientTypeName]);
   }
 
   for (const inputSuffix of V2_CLIENT_INPUT_SUFFIX_LIST) {

src/transforms/v2-to-v3/ts-type/index.ts

@@ -1,4 +1,4 @@
 export * from "./getClientTypeNames";
-export * from "./getV3ClientTypeReference";
+export * from "./getV3ClientType";
 export * from "./getV3ClientTypesCount";
 export * from "./replaceTSQualifiedName";

src/transforms/v2-to-v3/ts-type/replaceTSQualifiedName.ts

@@ -3,8 +3,8 @@ import { ASTPath, Collection, Identifier, JSCodeshift, TSQualifiedName } from "j
 import { DOCUMENT_CLIENT, DYNAMODB, DYNAMODB_DOCUMENT_CLIENT } from "../config";
 import { getClientTypeNames } from "./getClientTypeNames";
 import { getTSQualifiedNameFromClientName } from "./getTSQualifiedNameFromClientName";
-import { getV3ClientTypeReference } from "./getV3ClientTypeReference";
-import { updateV2ClientTypeRef } from "./updateV2ClientTypeRef";
+import { getV3ClientType } from "./getV3ClientType";
+import { updateV2ClientType } from "./updateV2ClientType";
 
 export interface ReplaceTSQualifiedNameOptions {
   v2ClientName: string;
@@ -46,11 +46,7 @@ export const replaceTSQualifiedName = (
       )
       .forEach((v2ClientType) => {
         const v2ClientTypeName = getRightIdentifierName(v2ClientType.node);
-        updateV2ClientTypeRef(j, v2ClientType, {
-          v2ClientName,
-          v2ClientTypeName,
-          v2ClientLocalName,
-        });
+        updateV2ClientType(j, v2ClientType, { v2ClientName, v2ClientTypeName, v2ClientLocalName });
       });
   }
 
@@ -73,11 +69,7 @@ export const replaceTSQualifiedName = (
     )
     .forEach((v2ClientType) => {
       const v2ClientTypeName = getRightIdentifierName(v2ClientType.node);
-      updateV2ClientTypeRef(j, v2ClientType, {
-        v2ClientName,
-        v2ClientTypeName,
-        v2ClientLocalName,
-      });
+      updateV2ClientType(j, v2ClientType, { v2ClientName, v2ClientTypeName, v2ClientLocalName });
     });
 
   // Replace type reference to client type with modules.
@@ -96,7 +88,7 @@ export const replaceTSQualifiedName = (
       )
       .replaceWith((v2ClientType) => {
         const v2ClientTypeName = v2ClientType.node.name;
-        return getV3ClientTypeReference(j, { v2ClientName, v2ClientTypeName, v2ClientLocalName });
+        return getV3ClientType(j, { v2ClientName, v2ClientTypeName, v2ClientLocalName });
       });
   }
 

src/transforms/v2-to-v3/ts-type/updateV2ClientType.ts

@@ -0,0 +1,33 @@
+import { ASTPath, Identifier, JSCodeshift, TSQualifiedName, TSTypeReference } from "jscodeshift";
+import { getV3ClientType } from "./getV3ClientType";
+
+const nativeTsRefTypes = ["TSAnyKeyword", "TSStringKeyword", "TSNumberKeyword", "TSBooleanKeyword"];
+const nativeTsIdentifierTypes = ["Date", "Uint8Array", "Array", "Record"];
+
+interface UpdateV2ClientTypeOptions {
+  v2ClientName: string;
+  v2ClientTypeName: string;
+  v2ClientLocalName: string;
+}
+
+export const updateV2ClientType = (
+  j: JSCodeshift,
+  v2ClientType: ASTPath<TSQualifiedName>,
+  { v2ClientName, v2ClientTypeName, v2ClientLocalName }: UpdateV2ClientTypeOptions
+) => {
+  const v3ClientType = getV3ClientType(j, { v2ClientName, v2ClientTypeName, v2ClientLocalName });
+
+  if (
+    (v2ClientType.parentPath?.value.type === "TSTypeQuery" &&
+      nativeTsRefTypes.includes(v3ClientType.type)) ||
+    (v3ClientType.type === "TSTypeReference" &&
+      (v3ClientType as TSTypeReference).typeName.type === "Identifier" &&
+      nativeTsIdentifierTypes.includes(
+        ((v3ClientType as TSTypeReference).typeName as Identifier).name
+      ))
+  ) {
+    v2ClientType.parentPath?.replace(v3ClientType);
+  } else {
+    v2ClientType.replace(v3ClientType);
+  }
+};