Add constant OBJECT_PROPERTY_TYPE_LIST (#387)

Author: trivikr

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

@@ -1,6 +1,13 @@
-import { Collection, Identifier, JSCodeshift, ObjectPattern, Property } from "jscodeshift";
+import {
+  Collection,
+  Identifier,
+  JSCodeshift,
+  ObjectPattern,
+  ObjectProperty,
+  Property,
+} from "jscodeshift";
 
-import { CLIENT_NAMES, PACKAGE_NAME } from "../config";
+import { CLIENT_NAMES, OBJECT_PROPERTY_TYPE_LIST, PACKAGE_NAME } from "../config";
 import { getRequireDeclaratorsWithProperty } from "../modules";
 import { getV2ServiceModulePath } from "../utils";
 import { getRequireIds } from "./getRequireIds";
@@ -15,18 +22,15 @@ export const getV2ClientNamesRecordFromRequire = (
   const idPropertiesFromObjectPattern = getRequireIds(j, source, PACKAGE_NAME)
     .filter((id) => id.type === "ObjectPattern")
     .map((objectPattern) => (objectPattern as ObjectPattern).properties)
-    .flat() as Property[];
+    .flat();
 
   for (const idProperty of idPropertiesFromObjectPattern) {
-    if (!["Property", "ObjectProperty"].includes(idProperty.type)) {
+    if (!OBJECT_PROPERTY_TYPE_LIST.includes(idProperty.type)) {
       continue;
     }
-    const key = idProperty.key as Identifier;
-    if (key.type !== "Identifier") {
-      continue;
-    }
-    const value = idProperty.value as Identifier;
-    if (value.type !== "Identifier") {
+    const key = (idProperty as Property | ObjectProperty).key;
+    const value = (idProperty as Property | ObjectProperty).value;
+    if (key.type !== "Identifier" || value.type !== "Identifier") {
       continue;
     }
     if (CLIENT_NAMES.includes(key.name)) {

src/transforms/v2-to-v3/config/constants.ts

@@ -2,3 +2,5 @@ export const PACKAGE_NAME = "aws-sdk";
 
 export const V2_CLIENT_INPUT_SUFFIX_LIST = ["Input", "Request"];
 export const V2_CLIENT_OUTPUT_SUFFIX_LIST = ["Output", "Response"];
+
+export const OBJECT_PROPERTY_TYPE_LIST = ["Property", "ObjectProperty"];

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

@@ -1,5 +1,6 @@
-import { Collection, JSCodeshift, ObjectPattern } from "jscodeshift";
+import { Collection, JSCodeshift, ObjectPattern, ObjectProperty, Property } from "jscodeshift";
 
+import { OBJECT_PROPERTY_TYPE_LIST } from "../config";
 import { getV3ClientDefaultLocalName } from "../utils";
 import { getRequireDeclarators } from "./getRequireDeclarators";
 import { getRequireDeclaratorsWithIdentifier } from "./getRequireDeclaratorsWithIdentifier";
@@ -33,14 +34,15 @@ export const addV3ClientNamedRequire = (
       existingRequireProperties.find(
         (variableDeclarator) =>
           variableDeclarator.id.type === "ObjectPattern" &&
-          variableDeclarator.id.properties.find(
-            (property) =>
-              property.type === "Property" &&
-              property.key.type === "Identifier" &&
-              property.value.type === "Identifier" &&
-              property.key.name === keyName &&
-              property.value.name === valueName
-          )
+          variableDeclarator.id.properties.find((property) => {
+            if (!OBJECT_PROPERTY_TYPE_LIST.includes(property.type)) return false;
+            const key = (property as Property | ObjectProperty).key;
+            const value = (property as Property | ObjectProperty).value;
+            if (key.type !== "Identifier" || value.type !== "Identifier") {
+              return false;
+            }
+            return key.name === keyName && value.name === valueName;
+          })
       )
     ) {
       return;

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

@@ -1,5 +1,6 @@
-import { Collection, JSCodeshift } from "jscodeshift";
+import { Collection, JSCodeshift, ObjectProperty, Property } from "jscodeshift";
 
+import { OBJECT_PROPERTY_TYPE_LIST } from "../config";
 import { getRequireDeclarators } from "./getRequireDeclarators";
 
 export interface GetRequireDeclaratorsWithObjectPattern {
@@ -17,10 +18,9 @@ export const getRequireDeclaratorsWithObjectPattern = (
       return false;
     }
     const { properties } = declarator.value.id;
-    return properties.some(
-      (property) =>
-        (property.type === "Property" || property.type === "ObjectProperty") &&
-        property.value.type === "Identifier" &&
-        property.value.name === identifierName
-    );
+    return properties.some((property) => {
+      if (!OBJECT_PROPERTY_TYPE_LIST.includes(property.type)) return false;
+      const propertyValue = (property as Property | ObjectProperty).value;
+      return propertyValue.type === "Identifier" && propertyValue.name === identifierName;
+    });
   });

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

@@ -1,5 +1,6 @@
-import { Collection, JSCodeshift, ObjectPattern } from "jscodeshift";
+import { Collection, JSCodeshift, ObjectPattern, ObjectProperty, Property } from "jscodeshift";
 
+import { OBJECT_PROPERTY_TYPE_LIST } from "../config";
 import { getRequireDeclaratorsWithObjectPattern } from "./getRequireDeclaratorsWithObjectPattern";
 
 export interface RemoveRequireObjectPropertyOptions {
@@ -22,12 +23,11 @@ export const removeRequireObjectProperty = (
 
     // Remove ObjectProperty from Variable Declarator.
     const varDeclaratorId = varDeclarator.value.id as ObjectPattern;
-    varDeclaratorId.properties = varDeclaratorId.properties.filter(
-      (property) =>
-        (property.type !== "Property" && property.type !== "ObjectProperty") ||
-        property.value.type !== "Identifier" ||
-        property.value.name !== localName
-    );
+    varDeclaratorId.properties = varDeclaratorId.properties.filter((property) => {
+      if (!OBJECT_PROPERTY_TYPE_LIST.includes(property.type)) return true;
+      const propertyValue = (property as Property | ObjectProperty).value;
+      return propertyValue.type !== "Identifier" || propertyValue.name !== localName;
+    });
 
     // Remove VariableDeclarator if there are no properties.
     if (varDeclaratorId.properties.length === 0) {