Create types map for DocumentClient (#523)

Author: trivikr

.changeset/dry-carpets-think.md

@@ -0,0 +1,5 @@
+---
+"aws-sdk-js-codemod": patch
+---
+
+Create types map for DocumentClient

scripts/generateClientTypesMap/getClientTypesMap.ts

@@ -1,11 +1,13 @@
 import { readFile } from "fs/promises";
-import jscodeshift, { Identifier, TSArrayType, TSTypeLiteral, TSTypeReference } from "jscodeshift";
 import { join } from "path";
+import jscodeshift, { Identifier, TSArrayType, TSTypeLiteral, TSTypeReference } from "jscodeshift";
 
+import { DOCUMENT_CLIENT } from "../../src/transforms/v2-to-v3/config";
 import { getClientTypesMapWithKeysRemovedFromValues } from "./getClientTypesMapWithKeysRemovedFromValues";
 
 const TYPES_TO_SKIP = ["apiVersion", "ClientConfiguration"];
 const ElementTypeToNativeTypeMap = {
+  TSAnyKeyword: "any",
   TSStringKeyword: "string",
   TSNumberKeyword: "number",
   TSBooleanKeyword: "boolean",
@@ -14,7 +16,10 @@ const ElementTypeToNativeTypeMap = {
 export const getClientTypesMap = async (clientName: string): Promise<Record<string, string>> => {
   const clientTypesMap = {};
 
-  const typesPath = join("node_modules", "aws-sdk", "clients", `${clientName.toLowerCase()}.d.ts`);
+  const typesPath =
+    clientName === DOCUMENT_CLIENT
+      ? join("node_modules", "aws-sdk", "lib", "dynamodb", `document_client.d.ts`)
+      : join("node_modules", "aws-sdk", "clients", `${clientName.toLowerCase()}.d.ts`);
   const relativeTypesPath = join(__dirname, "..", "..", typesPath);
 
   const typesCode = await readFile(relativeTypesPath, "utf8");

scripts/generateClientTypesMap/index.ts

@@ -2,7 +2,7 @@ import { writeFile } from "fs/promises";
 import { join } from "path";
 import { format } from "prettier";
 
-import { CLIENT_NAMES } from "../../src/transforms/v2-to-v3/config";
+import { CLIENT_NAMES, DOCUMENT_CLIENT, DYNAMODB } from "../../src/transforms/v2-to-v3/config";
 import { getClientTypesMap } from "./getClientTypesMap";
 
 const codegenComment = `// This file is generated by scripts/generateClientTypesMap/index.ts
@@ -21,6 +21,9 @@ 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);
+    }
   }
 
   fileContent += JSON.stringify(clientTypesMap);

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

@@ -7162,6 +7162,186 @@ export const CLIENT_TYPES_MAP: Record<string, Record<string, string>> = {
     UpdateExpression: "string",
     WriteRequests: "Array<WriteRequest>",
   },
+  DocumentClient: {
+    _Date: "Date",
+    ArchivalReason: "string",
+    AttributeDefinitions: "Array<AttributeDefinition>",
+    AttributeMap: "Record<string, any>",
+    AttributeName: "string",
+    AttributeNameList: "Array<string>",
+    AttributeUpdates: "Record<string, AttributeValueUpdate>",
+    AttributeValue: "any",
+    AttributeValueList: "Array<any>",
+    AutoScalingPolicyDescriptionList: "Array<AutoScalingPolicyDescription>",
+    AutoScalingPolicyName: "string",
+    AutoScalingRoleArn: "string",
+    Backfilling: "boolean",
+    BackupArn: "string",
+    BackupCreationDateTime: "Date",
+    BackupName: "string",
+    BackupsInputLimit: "number",
+    BackupSizeBytes: "number",
+    BackupSummaries: "Array<BackupSummary>",
+    BatchGetRequestMap: "Record<string, KeysAndAttributes>",
+    BatchGetResponseMap: "Record<string, Array<Record<string, any>>>",
+    BatchWriteItemRequestMap: "Record<string, Array<WriteRequest>>",
+    BilledSizeBytes: "number",
+    BinarySetAttributeValue: "Array<BinaryAttributeValue>",
+    BooleanAttributeValue: "boolean",
+    BooleanObject: "boolean",
+    ClientRequestToken: "string",
+    ClientToken: "string",
+    CloudWatchLogGroupArn: "string",
+    ConditionExpression: "string",
+    ConsistentRead: "boolean",
+    ConsumedCapacityMultiple: "Array<ConsumedCapacity>",
+    ConsumedCapacityUnits: "number",
+    ContributorInsightsRule: "string",
+    ContributorInsightsRuleList: "Array<string>",
+    ContributorInsightsSummaries: "Array<ContributorInsightsSummary>",
+    CsvDelimiter: "string",
+    CsvHeader: "string",
+    CsvHeaderList: "Array<string>",
+    DeletionProtectionEnabled: "boolean",
+    DoubleObject: "number",
+    Endpoints: "Array<Endpoint>",
+    ErrorCount: "number",
+    ExceptionDescription: "string",
+    ExceptionName: "string",
+    ExpectedAttributeMap: "Record<string, ExpectedAttributeValue>",
+    ExportArn: "string",
+    ExportEndTime: "Date",
+    ExportManifest: "string",
+    ExportNextToken: "string",
+    ExportStartTime: "Date",
+    ExportSummaries: "Array<ExportSummary>",
+    ExportTime: "Date",
+    ExpressionAttributeNameMap: "Record<string, string>",
+    ExpressionAttributeNameVariable: "string",
+    ExpressionAttributeValueMap: "Record<string, any>",
+    ExpressionAttributeValueVariable: "string",
+    FailureCode: "string",
+    FailureMessage: "string",
+    FilterConditionMap: "Record<string, Condition>",
+    GlobalSecondaryIndexAutoScalingUpdateList: "Array<GlobalSecondaryIndexAutoScalingUpdate>",
+    GlobalSecondaryIndexDescriptionList: "Array<GlobalSecondaryIndexDescription>",
+    GlobalSecondaryIndexes: "Array<GlobalSecondaryIndexInfo>",
+    GlobalSecondaryIndexList: "Array<GlobalSecondaryIndex>",
+    GlobalSecondaryIndexUpdateList: "Array<GlobalSecondaryIndexUpdate>",
+    GlobalTableArnString: "string",
+    GlobalTableGlobalSecondaryIndexSettingsUpdateList:
+      "Array<GlobalTableGlobalSecondaryIndexSettingsUpdate>",
+    GlobalTableList: "Array<GlobalTable>",
+    ImportArn: "string",
+    ImportedItemCount: "number",
+    ImportEndTime: "Date",
+    ImportNextToken: "string",
+    ImportStartTime: "Date",
+    ImportSummaryList: "Array<ImportSummary>",
+    IndexName: "string",
+    Integer: "number",
+    IntegerObject: "number",
+    ItemCollectionKeyAttributeMap: "Record<string, any>",
+    ItemCollectionMetricsMultiple: "Array<ItemCollectionMetrics>",
+    ItemCollectionMetricsPerTable: "Record<string, Array<ItemCollectionMetrics>>",
+    ItemCollectionSizeEstimateBound: "number",
+    ItemCollectionSizeEstimateRange: "Array<number>",
+    ItemCount: "number",
+    ItemList: "Array<Record<string, any>>",
+    ItemResponseList: "Array<ItemResponse>",
+    Key: "Record<string, any>",
+    KeyConditions: "Record<string, Condition>",
+    KeyExpression: "string",
+    KeyList: "Array<Record<string, any>>",
+    KeySchema: "Array<KeySchemaElement>",
+    KeySchemaAttributeName: "string",
+    KinesisDataStreamDestinations: "Array<KinesisDataStreamDestination>",
+    KMSMasterKeyArn: "string",
+    KMSMasterKeyId: "string",
+    LastUpdateDateTime: "Date",
+    ListAttributeValue: "Array<any>",
+    ListContributorInsightsLimit: "number",
+    ListExportsMaxLimit: "number",
+    ListImportsMaxLimit: "number",
+    ListTablesInputLimit: "number",
+    LocalSecondaryIndexDescriptionList: "Array<LocalSecondaryIndexDescription>",
+    LocalSecondaryIndexes: "Array<LocalSecondaryIndexInfo>",
+    LocalSecondaryIndexList: "Array<LocalSecondaryIndex>",
+    Long: "number",
+    LongObject: "number",
+    MapAttributeValue: "Record<string, any>",
+    NextTokenString: "string",
+    NonKeyAttributeName: "string",
+    NonKeyAttributeNameList: "Array<string>",
+    NonNegativeLongObject: "number",
+    NullAttributeValue: "boolean",
+    NumberAttributeValue: "string",
+    NumberSetAttributeValue: "Array<string>",
+    ParameterizedStatements: "Array<ParameterizedStatement>",
+    PartiQLBatchRequest: "Array<BatchStatementRequest>",
+    PartiQLBatchResponse: "Array<BatchStatementResponse>",
+    PartiQLNextToken: "string",
+    PartiQLStatement: "string",
+    PositiveIntegerObject: "number",
+    PositiveLongObject: "number",
+    PreparedStatementParameters: "Array<any>",
+    ProcessedItemCount: "number",
+    ProjectionExpression: "string",
+    PutItemInputAttributeMap: "Record<string, any>",
+    RegionName: "string",
+    ReplicaAutoScalingDescriptionList: "Array<ReplicaAutoScalingDescription>",
+    ReplicaAutoScalingUpdateList: "Array<ReplicaAutoScalingUpdate>",
+    ReplicaDescriptionList: "Array<ReplicaDescription>",
+    ReplicaGlobalSecondaryIndexAutoScalingDescriptionList:
+      "Array<ReplicaGlobalSecondaryIndexAutoScalingDescription>",
+    ReplicaGlobalSecondaryIndexAutoScalingUpdateList:
+      "Array<ReplicaGlobalSecondaryIndexAutoScalingUpdate>",
+    ReplicaGlobalSecondaryIndexDescriptionList: "Array<ReplicaGlobalSecondaryIndexDescription>",
+    ReplicaGlobalSecondaryIndexList: "Array<ReplicaGlobalSecondaryIndex>",
+    ReplicaGlobalSecondaryIndexSettingsDescriptionList:
+      "Array<ReplicaGlobalSecondaryIndexSettingsDescription>",
+    ReplicaGlobalSecondaryIndexSettingsUpdateList:
+      "Array<ReplicaGlobalSecondaryIndexSettingsUpdate>",
+    ReplicaList: "Array<Replica>",
+    ReplicaSettingsDescriptionList: "Array<ReplicaSettingsDescription>",
+    ReplicaSettingsUpdateList: "Array<ReplicaSettingsUpdate>",
+    ReplicaStatusDescription: "string",
+    ReplicaStatusPercentProgress: "string",
+    ReplicationGroupUpdateList: "Array<ReplicationGroupUpdate>",
+    ReplicaUpdateList: "Array<ReplicaUpdate>",
+    ResourceArnString: "string",
+    RestoreInProgress: "boolean",
+    S3Bucket: "string",
+    S3BucketOwner: "string",
+    S3Prefix: "string",
+    S3SseKmsKeyId: "string",
+    ScanSegment: "number",
+    ScanTotalSegments: "number",
+    SecondaryIndexesCapacityMap: "Record<string, Capacity>",
+    SSEEnabled: "boolean",
+    StreamArn: "string",
+    StreamEnabled: "boolean",
+    String: "string",
+    StringAttributeValue: "string",
+    StringSetAttributeValue: "Array<string>",
+    TableArn: "string",
+    TableCreationDateTime: "Date",
+    TableId: "string",
+    TableName: "string",
+    TableNameList: "Array<string>",
+    TagKeyList: "Array<string>",
+    TagKeyString: "string",
+    TagList: "Array<Tag>",
+    TagValueString: "string",
+    TimeRangeLowerBound: "Date",
+    TimeRangeUpperBound: "Date",
+    TimeToLiveAttributeName: "string",
+    TimeToLiveEnabled: "boolean",
+    TransactGetItemList: "Array<TransactGetItem>",
+    TransactWriteItemList: "Array<TransactWriteItem>",
+    UpdateExpression: "string",
+    WriteRequests: "Array<WriteRequest>",
+  },
   DynamoDBStreams: {
     _Date: "Date",
     AttributeMap: "Record<string, AttributeValue>",