Check for TsTypeReference on v2ClientLocalName (#307)

Author: trivikr

src/transforms/v2-to-v3/modules/addV3ClientImports.ts

@@ -19,8 +19,12 @@ export const addV3ClientImports = (
 
   addV3ClientNamedImport(j, source, options);
 
-  const { v2ClientName, v2GlobalName } = options;
-  const v3ClientTypeNames = getV3ClientTypeNames(j, source, { v2ClientName, v2GlobalName });
+  const { v2ClientLocalName, v2ClientName, v2GlobalName } = options;
+  const v3ClientTypeNames = getV3ClientTypeNames(j, source, {
+    v2ClientLocalName,
+    v2ClientName,
+    v2GlobalName,
+  });
 
   // Add default import for types, if needed.
   if (v3ClientTypeNames.length > 0) {

src/transforms/v2-to-v3/modules/addV3ClientRequires.ts

@@ -11,8 +11,12 @@ export const addV3ClientRequires = (
   source: Collection<unknown>,
   options: V3ClientModulesOptions
 ): void => {
-  const { v2ClientName, v2GlobalName } = options;
-  const v3ClientTypeNames = getV3ClientTypeNames(j, source, { v2ClientName, v2GlobalName });
+  const { v2ClientLocalName, v2ClientName, v2GlobalName } = options;
+  const v3ClientTypeNames = getV3ClientTypeNames(j, source, {
+    v2ClientLocalName,
+    v2ClientName,
+    v2GlobalName,
+  });
 
   // Add default require for types, if needed.
   if (v3ClientTypeNames.length > 0) {

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

@@ -1,19 +1,12 @@
-import {
-  Collection,
-  Identifier,
-  ImportDeclaration,
-  ImportSpecifier,
-  JSCodeshift,
-  TSQualifiedName,
-  TSTypeReference,
-} from "jscodeshift";
-
-import { getV2ServiceModulePath } from "../utils";
-import { getV2ClientTSTypeRef } from "./getV2ClientTSTypeRef";
+import { Collection, Identifier, JSCodeshift, TSQualifiedName, TSTypeReference } from "jscodeshift";
+
+import { getImportSpecifiers } from "../modules";
+import { getV2ClientTSTypeRef, getV2ServiceModulePath } from "../utils";
 
 export interface GetV2ClientTypeNamesOptions {
   v2ClientName: string;
   v2GlobalName?: string;
+  v2ClientLocalName: string;
 }
 
 const getRightIdentifierName = (
@@ -31,31 +24,32 @@ const getRightIdentifierName = (
 export const getV2ClientTypeNames = (
   j: JSCodeshift,
   source: Collection<unknown>,
-  { v2ClientName, v2GlobalName }: GetV2ClientTypeNamesOptions
+  { v2ClientLocalName, v2ClientName, v2GlobalName }: GetV2ClientTypeNamesOptions
 ): string[] => {
-  const v2GlobalTSTypeRef = getV2ClientTSTypeRef({
-    v2ClientName,
-    v2GlobalName,
-    withoutRightSection: true,
-  });
-  const v2ClientTSTypeRef = getV2ClientTSTypeRef({ v2ClientName, withoutRightSection: true });
-
-  const v2ServiceModuleImportDeclaration = {
-    type: "ImportDeclaration",
-    source: { value: getV2ServiceModulePath(v2ClientName) },
-  } as ImportDeclaration;
-
-  return [
-    ...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),
-    ]),
-  ];
+  const v2ClientTypeNames = [];
+
+  if (v2GlobalName) {
+    const v2GlobalTSTypeRef = getV2ClientTSTypeRef({
+      v2ClientName,
+      v2GlobalName,
+      withoutRightSection: true,
+    });
+    v2ClientTypeNames.push(...getRightIdentifierName(j, source, v2GlobalTSTypeRef));
+  }
+
+  const v2ClientTSTypeRef = getV2ClientTSTypeRef({ v2ClientLocalName, withoutRightSection: true });
+  v2ClientTypeNames.push(...getRightIdentifierName(j, source, v2ClientTSTypeRef));
+
+  v2ClientTypeNames.push(
+    ...getImportSpecifiers(j, source, getV2ServiceModulePath(v2ClientName))
+      .filter(
+        (importSpecifier) =>
+          importSpecifier.type === "ImportSpecifier" &&
+          importSpecifier.local &&
+          importSpecifier.local.type === "Identifier"
+      )
+      .map((importSpecifier) => (importSpecifier.local as Identifier).name)
+  );
+
+  return [...new Set(v2ClientTypeNames)];
 };

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

@@ -1,7 +1,6 @@
 import { Collection, Identifier, JSCodeshift, TSQualifiedName, TSTypeReference } from "jscodeshift";
 
-import { getV3ClientDefaultLocalName } from "../utils";
-import { getV2ClientTSTypeRef } from "./getV2ClientTSTypeRef";
+import { getV2ClientTSTypeRef, getV3ClientDefaultLocalName } from "../utils";
 import { getV2ClientTypeNames } from "./getV2ClientTypeNames";
 import { getV3ClientTypeName } from "./getV3ClientTypeName";
 
@@ -36,30 +35,32 @@ export const replaceTSTypeReference = (
   { v2ClientName, v2ClientLocalName, v2GlobalName, v3ClientName }: ReplaceTSTypeReferenceOptions
 ): void => {
   // Replace type reference to client created with global name.
-  source
-    .find(j.TSTypeReference, getV2ClientTSTypeRef({ v2ClientName, v2GlobalName }))
-    .replaceWith((v2ClientType) =>
-      j.tsTypeReference(j.identifier(v3ClientName), v2ClientType.node.typeParameters)
-    );
+  if (v2GlobalName) {
+    source
+      .find(j.TSTypeReference, getV2ClientTSTypeRef({ v2ClientName, v2GlobalName }))
+      .replaceWith((v2ClientType) =>
+        j.tsTypeReference(j.identifier(v3ClientName), v2ClientType.node.typeParameters)
+      );
 
-  // Replace reference to client types created with global name.
-  source
-    .find(
-      j.TSTypeReference,
-      getV2ClientTSTypeRef({ v2ClientName, v2GlobalName, withoutRightSection: true })
-    )
-    .filter((v2ClientType) => isRightSectionIdentifier(v2ClientType.node))
-    .replaceWith((v2ClientType) =>
-      getV3ClientTypeReference(
-        j,
-        v2ClientLocalName,
-        getV3ClientTypeName(getRightIdentifierName(v2ClientType.node))
+    // Replace reference to client types created with global name.
+    source
+      .find(
+        j.TSTypeReference,
+        getV2ClientTSTypeRef({ v2ClientName, v2GlobalName, withoutRightSection: true })
       )
-    );
+      .filter((v2ClientType) => isRightSectionIdentifier(v2ClientType.node))
+      .replaceWith((v2ClientType) =>
+        getV3ClientTypeReference(
+          j,
+          v2ClientLocalName,
+          getV3ClientTypeName(getRightIdentifierName(v2ClientType.node))
+        )
+      );
+  }
 
   // Replace reference to client types created with client module.
   source
-    .find(j.TSTypeReference, getV2ClientTSTypeRef({ v2ClientName, withoutRightSection: true }))
+    .find(j.TSTypeReference, getV2ClientTSTypeRef({ v2ClientLocalName, withoutRightSection: true }))
     .filter((v2ClientType) => isRightSectionIdentifier(v2ClientType.node))
     .replaceWith((v2ClientType) =>
       getV3ClientTypeReference(
@@ -70,7 +71,12 @@ export const replaceTSTypeReference = (
     );
 
   // Replace type reference to client type with modules.
-  const v2ClientTypeNames = getV2ClientTypeNames(j, source, { v2ClientName, v2GlobalName });
+  const v2ClientTypeNames = getV2ClientTypeNames(j, source, {
+    v2ClientLocalName,
+    v2ClientName,
+    v2GlobalName,
+  });
+
   for (const v2ClientTypeName of v2ClientTypeNames) {
     source
       .find(j.TSTypeReference, { typeName: { type: "Identifier", name: v2ClientTypeName } })

src/transforms/v2-to-v3/utils/getV2ClientNewExpression.ts

@@ -13,7 +13,7 @@ export const getV2ClientNewExpression = ({
 }: ClientNewExpressionOptions): NewExpression => {
   if (!v2GlobalName && !v2ClientLocalName) {
     throw new Error(
-      `At least one of the following options must be provided: v2ClientLocalName, v2GlobalName`
+      `One of the following options must be provided: v2ClientLocalName, v2GlobalName`
     );
   }
 

src/transforms/v2-to-v3/ts-type/getV2ClientTSTypeRef.ts renamed to src/transforms/v2-to-v3/utils/getV2ClientTSTypeRef.ts

@@ -1,16 +1,30 @@
 import { Identifier, TSQualifiedName, TSTypeReference } from "jscodeshift";
 
 export interface V2ClientTsTypeRefOptions {
+  v2ClientLocalName?: string;
+  v2ClientName?: string;
   v2GlobalName?: string;
-  v2ClientName: string;
   withoutRightSection?: boolean;
 }
 
 export const getV2ClientTSTypeRef = ({
-  v2GlobalName,
+  v2ClientLocalName,
   v2ClientName,
+  v2GlobalName,
   withoutRightSection = false,
 }: V2ClientTsTypeRefOptions): TSTypeReference => {
+  if (!v2GlobalName && !v2ClientLocalName) {
+    throw new Error(
+      `One of the following options must be provided: v2ClientLocalName, v2GlobalName`
+    );
+  }
+
+  if (v2GlobalName && v2ClientLocalName) {
+    throw new Error(
+      `Only one of the following options must be provided: v2ClientLocalName, v2GlobalName`
+    );
+  }
+
   if (v2GlobalName) {
     const idWithGlobalName = {
       type: "TSQualifiedName",
@@ -25,7 +39,7 @@ export const getV2ClientTSTypeRef = ({
     } as TSTypeReference;
   }
 
-  const idWithClientName = { type: "Identifier", name: v2ClientName } as Identifier;
+  const idWithClientName = { type: "Identifier", name: v2ClientLocalName } as Identifier;
   return {
     typeName: {
       ...(withoutRightSection ? { left: idWithClientName } : idWithClientName),

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

@@ -1,4 +1,5 @@
 export * from "./getV2ClientNewExpression";
+export * from "./getV2ClientTSTypeRef";
 export * from "./getV2ServiceModulePath";
 export * from "./getV3ClientDefaultLocalName";
 export * from "./isTypeScriptFile";