fix: deleteItem signature should accept Key instead of Item (#14)

sam-goodwin · Feb 9, 2022 · e49962d · e49962d
1 parent 7be12fa
commit e49962d
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 2 deletions.
diff --git a/src/client.ts b/src/client.ts
@@ -34,10 +34,18 @@ export interface TypeSafeDynamoDB<
   >;
 
   deleteItem<
+    Key extends KeyAttribute<Item, PartitionKey, RangeKey>,
     ConditionExpression extends string | undefined,
     ReturnValue extends DynamoDB.ReturnValue = "NONE"
   >(
-    params: DeleteItemInput<Item, ConditionExpression, ReturnValue>,
+    params: DeleteItemInput<
+      Item,
+      PartitionKey,
+      RangeKey,
+      Key,
+      ConditionExpression,
+      ReturnValue
+    >,
     callback?: Callback<DeleteItemOutput<Item, ReturnValue>, AWSError>
   ): Request<DeleteItemOutput<Item, ReturnValue>, AWSError>;
 

diff --git a/src/delete-item.ts b/src/delete-item.ts
@@ -4,9 +4,13 @@ import {
   ExpressionAttributeNames,
   ExpressionAttributeValues,
 } from "./expression-attributes";
+import { KeyAttribute } from "./key";
 
 export type DeleteItemInput<
   Item extends object,
+  PartitionKey extends keyof Item,
+  RangeKey extends keyof Item | undefined,
+  Key extends KeyAttribute<Item, PartitionKey, RangeKey>,
   ConditionExpression extends string | undefined,
   ReturnValue extends DynamoDB.ReturnValue = "NONE"
 > = Omit<
@@ -19,7 +23,7 @@ export type DeleteItemInput<
 > &
   ExpressionAttributeNames<ConditionExpression> &
   ExpressionAttributeValues<ConditionExpression> & {
-    Item: ToAttributeMap<Item>;
+    Key: Key;
     ReturnValues?: ReturnValue;
     ConditionExpression?: ConditionExpression;
   };

diff --git a/test/dummy.test.ts b/test/dummy.test.ts
@@ -58,6 +58,20 @@ export async function foo() {
     })
     .promise();
 
+  await table
+    .deleteItem({
+      TableName: "",
+      Key: {
+        pk: {
+          S: "",
+        },
+        sk: {
+          S: "",
+        },
+      },
+    })
+    .promise();
+
   await table
     .putItem({
       TableName: "",