initial work for updateItemQuery

README.md

@@ -266,7 +266,18 @@ await tsynamoClient
 
 ### Update item
 
-WIP
+```ts
+await tsynamoClient
+  .updateItem("myTable")
+  .keys({ userId: "1", dataTimestamp: 2 })
+  .set("nested.nestedBoolean", "=", true)
+  .remove("nested.nestedString")
+  .add("somethingElse", 10)
+  .add("someSet", new Set(["4", "5"]))
+  .delete("nested.nestedSet", new Set(["4", "5"]))
+  .conditionExpression("somethingElse", ">", 0)
+  .execute();
+```
 
 ## Contributors
 

src/nodes/addUpdateExpression.ts

@@ -0,0 +1,5 @@
+export type AddUpdateExpression = {
+  readonly kind: "AddUpdateExpression";
+  readonly key: string;
+  readonly value: unknown;
+};

src/nodes/deleteUpdateExpression.ts

@@ -0,0 +1,5 @@
+export type DeleteUpdateExpression = {
+  readonly kind: "DeleteUpdateExpression";
+  readonly key: string;
+  readonly value: unknown;
+};

src/nodes/operands.ts

@@ -11,3 +11,5 @@ export type NotExpression = "NOT";
 
 export type KeyConditionComparators = "=" | "<" | "<=" | ">" | ">=";
 export type ExpressionConditionComparators = KeyConditionComparators | "<>";
+
+export type UpdateExpressionOperands = "=" | "+=" | "-=";

src/nodes/removeUpdateExpression.ts

@@ -0,0 +1,4 @@
+export type RemoveUpdateExpression = {
+  readonly kind: "RemoveUpdateExpression";
+  readonly attribute: string;
+};

src/nodes/setUpdateExpression.ts

@@ -0,0 +1,11 @@
+import { UpdateExpressionOperands } from "./operands";
+import { SetUpdateExpressionFunction } from "./setUpdateExpressionFunction";
+import { SetUpdateExpressionValue } from "./setUpdateExpressionValue";
+
+export type SetUpdateExpression = {
+  readonly kind: "SetUpdateExpression";
+  readonly key: string;
+  readonly operation: UpdateExpressionOperands;
+  readonly right: SetUpdateExpressionFunction | SetUpdateExpressionValue;
+  readonly value?: number;
+};

src/nodes/setUpdateExpressionFunction.ts

@@ -0,0 +1,20 @@
+import { SetUpdateExpressionValue } from "./setUpdateExpressionValue";
+
+export type SetUpdateExpressionFunction = {
+  readonly kind: "SetUpdateExpressionFunction";
+  readonly function:
+    | SetUpdateExpressionIfNotExistsFunction
+    | SetUpdateExpressionListAppendFunction;
+};
+
+export type SetUpdateExpressionIfNotExistsFunction = {
+  readonly kind: "SetUpdateExpressionIfNotExistsFunction";
+  readonly path: string;
+  readonly right: SetUpdateExpressionFunction | SetUpdateExpressionValue;
+};
+
+export type SetUpdateExpressionListAppendFunction = {
+  readonly kind: "SetUpdateExpressionListAppendFunction";
+  readonly left: SetUpdateExpressionFunction | string;
+  readonly right: SetUpdateExpressionFunction | SetUpdateExpressionValue;
+};

src/nodes/setUpdateExpressionValue.ts

@@ -0,0 +1,4 @@
+export type SetUpdateExpressionValue<O = unknown> = {
+  readonly kind: "SetUpdateExpressionValue";
+  value: O;
+};

src/nodes/updateExpression.ts

@@ -0,0 +1,12 @@
+import { AddUpdateExpression } from "./addUpdateExpression";
+import { DeleteUpdateExpression } from "./deleteUpdateExpression";
+import { RemoveUpdateExpression } from "./removeUpdateExpression";
+import { SetUpdateExpression } from "./setUpdateExpression";
+
+export type UpdateExpression = {
+  readonly kind: "UpdateExpression";
+  readonly setUpdateExpressions: SetUpdateExpression[];
+  readonly removeUpdateExpressions: RemoveUpdateExpression[];
+  readonly addUpdateExpressions: AddUpdateExpression[];
+  readonly deleteUpdateExpressions: DeleteUpdateExpression[];
+};

src/nodes/updateNode.ts

@@ -0,0 +1,15 @@
+import { ExpressionNode } from "./expressionNode";
+import { ItemNode } from "./itemNode";
+import { KeysNode } from "./keysNode";
+import { ReturnValuesNode } from "./returnValuesNode";
+import { TableNode } from "./tableNode";
+import { UpdateExpression } from "./updateExpression";
+
+export type UpdateNode = {
+  readonly kind: "UpdateNode";
+  readonly table: TableNode;
+  readonly conditionExpression: ExpressionNode;
+  readonly updateExpression: UpdateExpression;
+  readonly keys?: KeysNode;
+  readonly returnValues?: ReturnValuesNode;
+};

src/queryBuilders/__snapshots__/updateItemQueryBuilder.integration.test.ts.snap

@@ -0,0 +1,80 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`UpdateItemQueryBuilder > handles update item query with ADD statements 1`] = `
+{
+  "dataTimestamp": 200,
+  "someBoolean": true,
+  "someSet": Set {
+    "item1",
+    "item2",
+  },
+  "somethingElse": 7,
+  "userId": "1010",
+}
+`;
+
+exports[`UpdateItemQueryBuilder > handles update item query with DELETE statements 1`] = `
+{
+  "dataTimestamp": 2,
+  "nested": {
+    "nestedSet": Set {
+      "5",
+    },
+  },
+  "someSet": Set {
+    "1",
+  },
+  "userId": "1",
+}
+`;
+
+exports[`UpdateItemQueryBuilder > handles update item query with REMOVE statements 1`] = `
+{
+  "dataTimestamp": 200,
+  "someBoolean": true,
+  "userId": "1010",
+}
+`;
+
+exports[`UpdateItemQueryBuilder > handles update item query with SET statements 1`] = `
+{
+  "dataTimestamp": 2,
+  "someBoolean": true,
+  "somethingElse": 3,
+  "tags": [
+    "test_tag",
+  ],
+  "userId": "1",
+}
+`;
+
+exports[`UpdateItemQueryBuilder > handles update item query with condition expressions 2`] = `
+{
+  "dataTimestamp": 2,
+  "someSet": Set {
+    "1",
+    "2",
+    "3",
+  },
+  "somethingElse": 0,
+  "userId": "1",
+}
+`;
+
+exports[`UpdateItemQueryBuilder > handles update item query with multiple different operations 1`] = `
+{
+  "dataTimestamp": 2,
+  "nested": {
+    "nestedBoolean": true,
+  },
+  "someSet": Set {
+    "1",
+    "2",
+    "3",
+    "4",
+    "5",
+  },
+  "somethingElse": 10,
+  "userId": "1",
+}
+`;