fix(lib-dynamodb): input types conflicts with client-dynamodb

monholm · monholm · commit ccc521ce65c7 · 2024-11-19T17:53:00.000+01:00
aws#6654 added `| undefined` to optional model props, but the types in lib-dynamodb wasn't updated to reflect that change. This leaves consumers using `exactOptionalPropertyTypes: true` with ts errors when trying to use almost any of the commands in lib-dynamodb Fixes aws#6668
diff --git a/lib/lib-dynamodb/src/commands/BatchExecuteStatementCommand.ts b/lib/lib-dynamodb/src/commands/BatchExecuteStatementCommand.ts
@@ -18,7 +18,7 @@ export { DynamoDBDocumentClientCommand, $Command };
 export type BatchExecuteStatementCommandInput = Omit<__BatchExecuteStatementCommandInput, "Statements"> & {
   Statements:
     | (Omit<BatchStatementRequest, "Parameters"> & {
-        Parameters?: NativeAttributeValue[];
+        Parameters?: NativeAttributeValue[] | undefined;
       })[]
     | undefined;
 };
diff --git a/lib/lib-dynamodb/src/commands/BatchWriteCommand.ts b/lib/lib-dynamodb/src/commands/BatchWriteCommand.ts
@@ -20,12 +20,16 @@ export type BatchWriteCommandInput = Omit<__BatchWriteItemCommandInput, "Request
     | Record<
         string,
         (Omit<WriteRequest, "PutRequest" | "DeleteRequest"> & {
-          PutRequest?: Omit<PutRequest, "Item"> & {
-            Item: Record<string, NativeAttributeValue> | undefined;
-          };
-          DeleteRequest?: Omit<DeleteRequest, "Key"> & {
-            Key: Record<string, NativeAttributeValue> | undefined;
-          };
+          PutRequest?:
+            | (Omit<PutRequest, "Item"> & {
+                Item: Record<string, NativeAttributeValue> | undefined;
+              })
+            | undefined;
+          DeleteRequest?:
+            | (Omit<DeleteRequest, "Key"> & {
+                Key: Record<string, NativeAttributeValue> | undefined;
+              })
+            | undefined;
         })[]
       >
     | undefined;
diff --git a/lib/lib-dynamodb/src/commands/DeleteCommand.ts b/lib/lib-dynamodb/src/commands/DeleteCommand.ts
@@ -17,14 +17,16 @@ export { DynamoDBDocumentClientCommand, $Command };
  */
 export type DeleteCommandInput = Omit<__DeleteItemCommandInput, "Key" | "Expected" | "ExpressionAttributeValues"> & {
   Key: Record<string, NativeAttributeValue> | undefined;
-  Expected?: Record<
-    string,
-    Omit<ExpectedAttributeValue, "Value" | "AttributeValueList"> & {
-      Value?: NativeAttributeValue;
-      AttributeValueList?: NativeAttributeValue[];
-    }
-  >;
-  ExpressionAttributeValues?: Record<string, NativeAttributeValue>;
+  Expected?:
+    | Record<
+        string,
+        | Omit<ExpectedAttributeValue, "Value" | "AttributeValueList"> & {
+            Value?: NativeAttributeValue;
+            AttributeValueList?: NativeAttributeValue[] | undefined;
+          }
+      >
+    | undefined;
+  ExpressionAttributeValues?: Record<string, NativeAttributeValue> | undefined;
 };
 
 /**
diff --git a/lib/lib-dynamodb/src/commands/ExecuteStatementCommand.ts b/lib/lib-dynamodb/src/commands/ExecuteStatementCommand.ts
@@ -16,7 +16,7 @@ export { DynamoDBDocumentClientCommand, $Command };
  * @public
  */
 export type ExecuteStatementCommandInput = Omit<__ExecuteStatementCommandInput, "Parameters"> & {
-  Parameters?: NativeAttributeValue[];
+  Parameters?: NativeAttributeValue[] | undefined;
 };
 
 /**
diff --git a/lib/lib-dynamodb/src/commands/ExecuteTransactionCommand.ts b/lib/lib-dynamodb/src/commands/ExecuteTransactionCommand.ts
@@ -18,7 +18,7 @@ export { DynamoDBDocumentClientCommand, $Command };
 export type ExecuteTransactionCommandInput = Omit<__ExecuteTransactionCommandInput, "TransactStatements"> & {
   TransactStatements:
     | (Omit<ParameterizedStatement, "Parameters"> & {
-        Parameters?: NativeAttributeValue[];
+        Parameters?: NativeAttributeValue[] | undefined;
       })[]
     | undefined;
 };
diff --git a/lib/lib-dynamodb/src/commands/PutCommand.ts b/lib/lib-dynamodb/src/commands/PutCommand.ts
@@ -17,14 +17,16 @@ export { DynamoDBDocumentClientCommand, $Command };
  */
 export type PutCommandInput = Omit<__PutItemCommandInput, "Item" | "Expected" | "ExpressionAttributeValues"> & {
   Item: Record<string, NativeAttributeValue> | undefined;
-  Expected?: Record<
-    string,
-    Omit<ExpectedAttributeValue, "Value" | "AttributeValueList"> & {
-      Value?: NativeAttributeValue;
-      AttributeValueList?: NativeAttributeValue[];
-    }
-  >;
-  ExpressionAttributeValues?: Record<string, NativeAttributeValue>;
+  Expected?:
+    | Record<
+        string,
+        Omit<ExpectedAttributeValue, "Value" | "AttributeValueList"> & {
+          Value?: NativeAttributeValue | undefined;
+          AttributeValueList?: NativeAttributeValue[] | undefined;
+        }
+      >
+    | undefined;
+  ExpressionAttributeValues?: Record<string, NativeAttributeValue> | undefined;
 };
 
 /**
diff --git a/lib/lib-dynamodb/src/commands/QueryCommand.ts b/lib/lib-dynamodb/src/commands/QueryCommand.ts
@@ -19,20 +19,24 @@ export type QueryCommandInput = Omit<
   __QueryCommandInput,
   "KeyConditions" | "QueryFilter" | "ExclusiveStartKey" | "ExpressionAttributeValues"
 > & {
-  KeyConditions?: Record<
-    string,
-    Omit<Condition, "AttributeValueList"> & {
-      AttributeValueList?: NativeAttributeValue[];
-    }
-  >;
-  QueryFilter?: Record<
-    string,
-    Omit<Condition, "AttributeValueList"> & {
-      AttributeValueList?: NativeAttributeValue[];
-    }
-  >;
-  ExclusiveStartKey?: Record<string, NativeAttributeValue>;
-  ExpressionAttributeValues?: Record<string, NativeAttributeValue>;
+  KeyConditions?:
+    | Record<
+        string,
+        Omit<Condition, "AttributeValueList"> & {
+          AttributeValueList?: NativeAttributeValue[] | undefined;
+        }
+      >
+    | undefined;
+  QueryFilter?:
+    | Record<
+        string,
+        Omit<Condition, "AttributeValueList"> & {
+          AttributeValueList?: NativeAttributeValue[] | undefined;
+        }
+      >
+    | undefined;
+  ExclusiveStartKey?: Record<string, NativeAttributeValue> | undefined;
+  ExpressionAttributeValues?: Record<string, NativeAttributeValue> | undefined;
 };
 
 /**
diff --git a/lib/lib-dynamodb/src/commands/ScanCommand.ts b/lib/lib-dynamodb/src/commands/ScanCommand.ts
@@ -19,14 +19,16 @@ export type ScanCommandInput = Omit<
   __ScanCommandInput,
   "ScanFilter" | "ExclusiveStartKey" | "ExpressionAttributeValues"
 > & {
-  ScanFilter?: Record<
-    string,
-    Omit<Condition, "AttributeValueList"> & {
-      AttributeValueList?: NativeAttributeValue[];
-    }
-  >;
-  ExclusiveStartKey?: Record<string, NativeAttributeValue>;
-  ExpressionAttributeValues?: Record<string, NativeAttributeValue>;
+  ScanFilter?:
+    | Record<
+        string,
+        Omit<Condition, "AttributeValueList"> & {
+          AttributeValueList?: NativeAttributeValue[] | undefined;
+        }
+      >
+    | undefined;
+  ExclusiveStartKey?: Record<string, NativeAttributeValue> | undefined;
+  ExpressionAttributeValues?: Record<string, NativeAttributeValue> | undefined;
 };
 
 /**
diff --git a/lib/lib-dynamodb/src/commands/TransactWriteCommand.ts b/lib/lib-dynamodb/src/commands/TransactWriteCommand.ts
@@ -18,22 +18,30 @@ export { DynamoDBDocumentClientCommand, $Command };
 export type TransactWriteCommandInput = Omit<__TransactWriteItemsCommandInput, "TransactItems"> & {
   TransactItems:
     | (Omit<TransactWriteItem, "ConditionCheck" | "Put" | "Delete" | "Update"> & {
-        ConditionCheck?: Omit<ConditionCheck, "Key" | "ExpressionAttributeValues"> & {
-          Key: Record<string, NativeAttributeValue> | undefined;
-          ExpressionAttributeValues?: Record<string, NativeAttributeValue>;
-        };
-        Put?: Omit<Put, "Item" | "ExpressionAttributeValues"> & {
-          Item: Record<string, NativeAttributeValue> | undefined;
-          ExpressionAttributeValues?: Record<string, NativeAttributeValue>;
-        };
-        Delete?: Omit<Delete, "Key" | "ExpressionAttributeValues"> & {
-          Key: Record<string, NativeAttributeValue> | undefined;
-          ExpressionAttributeValues?: Record<string, NativeAttributeValue>;
-        };
-        Update?: Omit<Update, "Key" | "ExpressionAttributeValues"> & {
-          Key: Record<string, NativeAttributeValue> | undefined;
-          ExpressionAttributeValues?: Record<string, NativeAttributeValue>;
-        };
+        ConditionCheck?:
+          | (Omit<ConditionCheck, "Key" | "ExpressionAttributeValues"> & {
+              Key: Record<string, NativeAttributeValue> | undefined;
+              ExpressionAttributeValues?: Record<string, NativeAttributeValue> | undefined;
+            })
+          | undefined;
+        Put?:
+          | (Omit<Put, "Item" | "ExpressionAttributeValues"> & {
+              Item: Record<string, NativeAttributeValue> | undefined;
+              ExpressionAttributeValues?: Record<string, NativeAttributeValue> | undefined;
+            })
+          | undefined;
+        Delete?:
+          | (Omit<Delete, "Key" | "ExpressionAttributeValues"> & {
+              Key: Record<string, NativeAttributeValue> | undefined;
+              ExpressionAttributeValues?: Record<string, NativeAttributeValue> | undefined;
+            })
+          | undefined;
+        Update?:
+          | (Omit<Update, "Key" | "ExpressionAttributeValues"> & {
+              Key: Record<string, NativeAttributeValue> | undefined;
+              ExpressionAttributeValues?: Record<string, NativeAttributeValue> | undefined;
+            })
+          | undefined;
       })[]
     | undefined;
 };
diff --git a/lib/lib-dynamodb/src/commands/UpdateCommand.ts b/lib/lib-dynamodb/src/commands/UpdateCommand.ts
@@ -20,20 +20,24 @@ export type UpdateCommandInput = Omit<
   "Key" | "AttributeUpdates" | "Expected" | "ExpressionAttributeValues"
 > & {
   Key: Record<string, NativeAttributeValue> | undefined;
-  AttributeUpdates?: Record<
-    string,
-    Omit<AttributeValueUpdate, "Value"> & {
-      Value?: NativeAttributeValue;
-    }
-  >;
-  Expected?: Record<
-    string,
-    Omit<ExpectedAttributeValue, "Value" | "AttributeValueList"> & {
-      Value?: NativeAttributeValue;
-      AttributeValueList?: NativeAttributeValue[];
-    }
-  >;
-  ExpressionAttributeValues?: Record<string, NativeAttributeValue>;
+  AttributeUpdates?:
+    | Record<
+        string,
+        Omit<AttributeValueUpdate, "Value"> & {
+          Value?: NativeAttributeValue;
+        }
+      >
+    | undefined;
+  Expected?:
+    | Record<
+        string,
+        Omit<ExpectedAttributeValue, "Value" | "AttributeValueList"> & {
+          Value?: NativeAttributeValue;
+          AttributeValueList?: NativeAttributeValue[] | undefined;
+        }
+      >
+    | undefined;
+  ExpressionAttributeValues?: Record<string, NativeAttributeValue> | undefined;
 };
 
 /**
