Support transformation of DocumentClient input/output types (#469)

Author: trivikr

.changeset/tricky-panthers-fetch.md

@@ -0,0 +1,5 @@
+---
+"aws-sdk-js-codemod": minor
+---
+
+Support transformation of DocumentClient input/output types

scripts/generateClientTypesMap/index.ts

@@ -2,7 +2,12 @@ import { writeFile } from "fs/promises";
 import { join } from "path";
 import { format } from "prettier";
 
-import { CLIENT_NAMES, DOCUMENT_CLIENT, DYNAMODB } from "../../src/transforms/v2-to-v3/config";
+import {
+  CLIENT_NAMES,
+  DOCUMENT_CLIENT,
+  DYNAMODB,
+  DYNAMODB_DOCUMENT_CLIENT,
+} from "../../src/transforms/v2-to-v3/config";
 import { getClientTypesMap } from "./getClientTypesMap";
 
 const codegenComment = `// This file is generated by scripts/generateClientTypesMap/index.ts
@@ -22,7 +27,7 @@ const relativeFilePath = join(__dirname, "..", "..", filePath);
   for (const clientName of CLIENT_NAMES) {
     clientTypesMap[clientName] = await getClientTypesMap(clientName);
     if (clientName === DYNAMODB) {
-      clientTypesMap[DOCUMENT_CLIENT] = await getClientTypesMap(DOCUMENT_CLIENT);
+      clientTypesMap[DYNAMODB_DOCUMENT_CLIENT] = await getClientTypesMap(DOCUMENT_CLIENT);
     }
   }
 

src/transforms/v2-to-v3/__fixtures__/ddb-doc-client-input-output-type/global-import-equals.input.ts

@@ -0,0 +1,11 @@
+import AWS = require("aws-sdk");
+
+const docClient = new AWS.DynamoDB.DocumentClient({ region: "us-west-2" });
+
+const docClientScanInput: AWS.DynamoDB.DocumentClient.ScanInput = {
+  TableName: "TableName"
+};
+
+const docClientScanOutput: AWS.DynamoDB.DocumentClient.ScanOutput = await docClient
+  .scan(docClientScanInput)
+  .promise();

src/transforms/v2-to-v3/__fixtures__/ddb-doc-client-input-output-type/global-import-equals.output.ts

@@ -0,0 +1,20 @@
+import AWS_lib_dynamodb = require("@aws-sdk/lib-dynamodb");
+
+const {
+  DynamoDBDocument
+} = AWS_lib_dynamodb;
+
+import AWS_DynamoDB = require("@aws-sdk/client-dynamodb");
+
+const {
+  DynamoDB
+} = AWS_DynamoDB;
+
+const docClient = DynamoDBDocument.from(new DynamoDB({ region: "us-west-2" }));
+
+const docClientScanInput: AWS_DynamoDBDocumentClient.ScanCommandInput = {
+  TableName: "TableName"
+};
+
+const docClientScanOutput: AWS_DynamoDBDocumentClient.ScanCommandOutput = await docClient
+  .scan(docClientScanInput);

src/transforms/v2-to-v3/__fixtures__/ddb-doc-client-input-output-type/global-import.input.ts

@@ -0,0 +1,11 @@
+import AWS from "aws-sdk";
+
+const docClient = new AWS.DynamoDB.DocumentClient({ region: "us-west-2" });
+
+const docClientScanInput: AWS.DynamoDB.DocumentClient.ScanInput = {
+  TableName: "TableName"
+};
+
+const docClientScanOutput: AWS.DynamoDB.DocumentClient.ScanOutput = await docClient
+  .scan(docClientScanInput)
+  .promise();

src/transforms/v2-to-v3/__fixtures__/ddb-doc-client-input-output-type/global-import.output.ts

@@ -0,0 +1,11 @@
+import AWS_DynamoDBDocumentClient, { DynamoDBDocument } from "@aws-sdk/lib-dynamodb";
+import { DynamoDB } from "@aws-sdk/client-dynamodb";
+
+const docClient = DynamoDBDocument.from(new DynamoDB({ region: "us-west-2" }));
+
+const docClientScanInput: AWS_DynamoDBDocumentClient.ScanCommandInput = {
+  TableName: "TableName"
+};
+
+const docClientScanOutput: AWS_DynamoDBDocumentClient.ScanCommandOutput = await docClient
+  .scan(docClientScanInput);

src/transforms/v2-to-v3/__fixtures__/ddb-doc-client-input-output-type/global-require.input.ts

@@ -0,0 +1,11 @@
+const AWS = require("aws-sdk");
+
+const docClient = new AWS.DynamoDB.DocumentClient({ region: "us-west-2" });
+
+const docClientScanInput: AWS.DynamoDB.DocumentClient.ScanInput = {
+  TableName: "TableName"
+};
+
+const docClientScanOutput: AWS.DynamoDB.DocumentClient.ScanOutput = await docClient
+  .scan(docClientScanInput)
+  .promise();

src/transforms/v2-to-v3/__fixtures__/ddb-doc-client-input-output-type/global-require.output.ts

@@ -0,0 +1,16 @@
+const AWS_DynamoDBDocumentClient = require("@aws-sdk/lib-dynamodb"),
+      {
+        DynamoDBDocument
+      } = AWS_DynamoDBDocumentClient,
+      {
+        DynamoDB
+      } = require("@aws-sdk/client-dynamodb");
+
+const docClient = DynamoDBDocument.from(new DynamoDB({ region: "us-west-2" }));
+
+const docClientScanInput: AWS_DynamoDBDocumentClient.ScanCommandInput = {
+  TableName: "TableName"
+};
+
+const docClientScanOutput: AWS_DynamoDBDocumentClient.ScanCommandOutput = await docClient
+  .scan(docClientScanInput);

src/transforms/v2-to-v3/__fixtures__/ddb-doc-client-input-output-type/service-import-deep.input.ts

@@ -0,0 +1,11 @@
+import DynDB from "aws-sdk/clients/dynamodb";
+
+const docClient = new DynDB.DocumentClient({ region: "us-west-2" });
+
+const docClientScanInput: DynDB.DocumentClient.ScanInput = {
+  TableName: "TableName"
+};
+
+const docClientScanOutput: DynDB.DocumentClient.ScanOutput = await docClient
+  .scan(docClientScanInput)
+  .promise();

src/transforms/v2-to-v3/__fixtures__/ddb-doc-client-input-output-type/service-import-deep.output.ts

@@ -0,0 +1,11 @@
+import AWS_DynDBDocumentClient, { DynamoDBDocument } from "@aws-sdk/lib-dynamodb";
+import { DynamoDB as DynDB } from "@aws-sdk/client-dynamodb";
+
+const docClient = DynamoDBDocument.from(new DynDB({ region: "us-west-2" }));
+
+const docClientScanInput: AWS_DynDBDocumentClient.ScanCommandInput = {
+  TableName: "TableName"
+};
+
+const docClientScanOutput: AWS_DynDBDocumentClient.ScanCommandOutput = await docClient
+  .scan(docClientScanInput);