Make importedName optional in ImportSpecifierType (#788)

Author: trivikr

.changeset/proud-kings-exercise.md

@@ -0,0 +1,5 @@
+---
+"aws-sdk-js-codemod": patch
+---
+
+Make importedName optional in ImportSpecifierType

src/transforms/v2-to-v3/apis/replaceAwsIdentity.ts

@@ -69,7 +69,7 @@ export const replaceAwsIdentity = (
       if (credsNewExpressions.size() > 0) {
         addNamedModule(j, source, {
           importType,
-          importedName: v3ProviderName,
+          localName: v3ProviderName,
           packageName: identityPackageName,
         });
         credsNewExpressions.replaceWith(({ node }) =>

src/transforms/v2-to-v3/client-names/getClientNamesRecordFromImport.ts

@@ -1,11 +1,7 @@
 import { Collection, JSCodeshift } from "jscodeshift";
 
 import { CLIENT_NAMES, PACKAGE_NAME } from "../config";
-import {
-  ImportSpecifierDefault,
-  ImportSpecifierPattern,
-  getImportEqualsDeclarationType,
-} from "../modules";
+import { getImportEqualsDeclarationType } from "../modules";
 import { getImportSpecifiers } from "../modules/importModule";
 import { getClientDeepImportPath } from "../utils";
 
@@ -17,23 +13,24 @@ export const getClientNamesRecordFromImport = (
   const clientNamesRecord: Record<string, string> = {};
 
   const specifiersFromNamedImport = getImportSpecifiers(j, source, PACKAGE_NAME).filter(
-    (importSpecifier) => typeof importSpecifier === "object"
-  ) as ImportSpecifierPattern[];
+    (importSpecifier) => importSpecifier.importedName
+  );
 
   for (const { importedName, localName } of specifiersFromNamedImport) {
-    if (CLIENT_NAMES.includes(importedName)) {
-      clientNamesRecord[importedName] = localName ?? importedName;
+    const clientName = importedName ?? localName;
+    if (CLIENT_NAMES.includes(clientName)) {
+      clientNamesRecord[clientName] = localName;
     }
   }
 
   for (const clientName of clientNamesFromDeepImport) {
     const deepImportPath = getClientDeepImportPath(clientName);
 
     const specifiersFromDeepImport = getImportSpecifiers(j, source, deepImportPath).filter(
-      (importSpecifier) => typeof importSpecifier === "string"
-    ) as ImportSpecifierDefault[];
+      (importSpecifier) => !importSpecifier.importedName
+    );
     if (specifiersFromDeepImport.length > 0) {
-      clientNamesRecord[clientName] = specifiersFromDeepImport[0];
+      clientNamesRecord[clientName] = specifiersFromDeepImport[0].localName;
     }
 
     const identifiersFromImportEquals = source.find(

src/transforms/v2-to-v3/client-names/getClientNamesRecordFromRequire.ts

@@ -1,7 +1,6 @@
 import { Collection, JSCodeshift } from "jscodeshift";
 
 import { CLIENT_NAMES, PACKAGE_NAME } from "../config";
-import { ImportSpecifierDefault, ImportSpecifierPattern } from "../modules";
 import { getImportSpecifiers } from "../modules/requireModule";
 import { getClientDeepImportPath } from "../utils";
 
@@ -13,22 +12,23 @@ export const getClientNamesRecordFromRequire = (
   const clientNamesRecord: Record<string, string> = {};
 
   const idPropertiesFromObjectPattern = getImportSpecifiers(j, source, PACKAGE_NAME).filter(
-    (importSpecifier) => typeof importSpecifier === "object"
-  ) as ImportSpecifierPattern[];
+    (importSpecifier) => importSpecifier.importedName
+  );
 
   for (const { importedName, localName } of idPropertiesFromObjectPattern) {
-    if (CLIENT_NAMES.includes(importedName)) {
-      clientNamesRecord[importedName] = localName || importedName;
+    const clientName = importedName ?? localName;
+    if (CLIENT_NAMES.includes(clientName)) {
+      clientNamesRecord[clientName] = localName;
     }
   }
 
   for (const clientName of clientNamesFromDeepImport) {
     const deepImportPath = getClientDeepImportPath(clientName);
     const idsFromDefaultImport = getImportSpecifiers(j, source, deepImportPath).filter(
-      (importSpecifier) => typeof importSpecifier === "string"
-    ) as ImportSpecifierDefault[];
+      (importSpecifier) => !importSpecifier.importedName
+    );
     if (idsFromDefaultImport.length) {
-      clientNamesRecord[clientName] = idsFromDefaultImport[0];
+      clientNamesRecord[clientName] = idsFromDefaultImport[0].localName;
     }
   }
 

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

@@ -45,7 +45,7 @@ export const addClientModules = (
   for (const v3ClientType of v3ClientTypes) {
     addNamedModule(j, source, {
       importType,
-      importedName: v3ClientType,
+      localName: v3ClientType,
       packageName: v3ClientPackageName,
     });
   }
@@ -63,7 +63,7 @@ export const addClientModules = (
     const v3WaiterApiName = getV3ClientWaiterApiName(waiterState);
     addNamedModule(j, source, {
       importType,
-      importedName: v3WaiterApiName,
+      localName: v3WaiterApiName,
       packageName: v3ClientPackageName,
     });
   }
@@ -72,21 +72,21 @@ export const addClientModules = (
     if (isS3UploadApiUsed(j, source, clientIdentifiers)) {
       addNamedModule(j, source, {
         importType,
-        importedName: "Upload",
+        localName: "Upload",
         packageName: "@aws-sdk/lib-storage",
       });
     }
 
     if (isS3GetSignedUrlApiUsed(j, source, clientIdentifiers)) {
       addNamedModule(j, source, {
         importType,
-        importedName: "getSignedUrl",
+        localName: "getSignedUrl",
         packageName: "@aws-sdk/s3-request-presigner",
       });
       for (const apiName of getS3SignedUrlApiNames(j, source, clientIdentifiers)) {
         addNamedModule(j, source, {
           importType,
-          importedName: getCommandName(apiName),
+          localName: getCommandName(apiName),
           packageName: v3ClientPackageName,
         });
       }
@@ -111,15 +111,15 @@ export const addClientModules = (
     for (const docClientType of docClientTypes) {
       addNamedModule(j, source, {
         importType,
-        importedName: docClientType,
+        localName: docClientType,
         packageName: "@aws-sdk/lib-dynamodb",
       });
     }
 
     if (docClientNewExpressionCount > 0) {
       addNamedModule(j, source, {
         importType,
-        importedName: DYNAMODB_DOCUMENT,
+        localName: DYNAMODB_DOCUMENT,
         packageName: "@aws-sdk/lib-dynamodb",
       });
     }

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

@@ -4,7 +4,6 @@ import { PACKAGE_NAME } from "../config";
 import { getImportEqualsDeclarationType } from "./getImportEqualsDeclarationType";
 import { getImportSpecifiers } from "./importModule";
 import { getRequireDeclarators } from "./requireModule";
-import { ImportSpecifierDefault } from ".";
 
 export const getGlobalNameFromModule = (
   j: JSCodeshift,
@@ -19,11 +18,11 @@ export const getGlobalNameFromModule = (
   }
 
   const importDefaultSpecifiers = getImportSpecifiers(j, source, PACKAGE_NAME).filter(
-    (importSpecifier) => typeof importSpecifier === "string"
-  ) as ImportSpecifierDefault[];
+    (importSpecifier) => !importSpecifier.importedName
+  );
 
   if (importDefaultSpecifiers.length > 0) {
-    return importDefaultSpecifiers[0];
+    return importDefaultSpecifiers[0].localName;
   }
 
   const importEqualsDeclarations = source.find(

src/transforms/v2-to-v3/modules/importEqualsModule/addNamedModule.ts

@@ -10,7 +10,7 @@ export const addNamedModule = (
   source: Collection<unknown>,
   options: ModulesOptions
 ) => {
-  const { importedName, localName = importedName, packageName } = options;
+  const { localName, importedName = localName, packageName } = options;
 
   const defaultLocalName = getDefaultName(packageName);
 

src/transforms/v2-to-v3/modules/importModule/addNamedModule.ts

@@ -9,7 +9,7 @@ export const addNamedModule = (
   source: Collection<unknown>,
   options: ModulesOptions
 ) => {
-  const { importedName, localName = importedName, packageName } = options;
+  const { localName, importedName = localName, packageName } = options;
 
   const importSpecifiers = getImportSpecifiers(j, source, packageName);
 

src/transforms/v2-to-v3/modules/importModule/getImportSpecifiers.ts

@@ -24,7 +24,7 @@ export const getImportSpecifiers = (
         case "ImportNamespaceSpecifier":
         case "ImportDefaultSpecifier": {
           if (specifier.local) {
-            importSpecifiers.add(specifier.local.name);
+            importSpecifiers.add({ localName: specifier.local.name });
           }
           break;
         }

src/transforms/v2-to-v3/modules/requireModule/addNamedModule.ts

@@ -18,11 +18,11 @@ export const addNamedModule = (
   source: Collection<unknown>,
   options: ModulesOptions
 ) => {
-  const { importedName, localName = importedName, packageName } = options;
+  const { localName, importedName = localName, packageName } = options;
 
   const clientObjectProperty = j.objectProperty.from({
     key: j.identifier(importedName),
-    value: j.identifier(localName ?? importedName),
+    value: j.identifier(localName),
     shorthand: true,
   });
   const existingRequires = getRequireDeclarators(j, source, packageName);