Merge pull request #13 from mindler-olli/main

added PutItemQueryBuilder

README.md

@@ -4,10 +4,6 @@ Type-friendly DynamoDB query builder! Inspired by [Kysely](https://github.com/ky
 
 Usable with AWS SDK v3 `DynamoDBDocumentClient`.
 
-> [!NOTE]
-> Currently this is a POC and a WIP. Currently, `get-item` and `query` operations are
-> supported, but I am planning to add support for the rest of the operations too.
-
 ![](https://github.com/woltsu/tsynamo/blob/main/assets/demo.gif)
 
 # Installation
@@ -163,11 +159,48 @@ await tsynamoClient
 > This would compile as the following FilterExpression:
 > `NOT eventType = "LOG_IN"`, i.e. return all events whose types is not "LOG_IN"
 
-## Delete item
+## Put item
 
-WIP
+### Simple put item
 
-## Put item
+```ts
+await tsynamoClient
+  .putItem("myTable")
+  .item({
+    userId: "123",
+    eventId: 313,
+  })
+  .execute();
+```
+
+### Put item with ConditionExpression
+
+```ts
+await tsynamoClient
+  .putItem("myTable")
+  .item({
+    userId: "123",
+    eventId: 313,
+  })
+  .conditionExpression("userId", "attribute_not_exists")
+  .execute();
+```
+
+### Put item with multiple ConditionExpressions
+
+```ts
+await tsynamoClient
+  .putItem("myTable")
+  .item({
+    userId: "123",
+    eventId: 313,
+  })
+  .conditionExpression("userId", "attribute_not_exists")
+  .orConditionExpression("eventType", "begins_with", "LOG_")
+  .execute();
+```
+
+## Delete item
 
 WIP
 
@@ -180,8 +213,9 @@ WIP
 WIP
 
 # Contributors
+
 <p>
     <a href="https://github.com/woltsu/tsynamo/graphs/contributors">
         <img src="https://contrib.rocks/image?repo=woltsu/tsynamo" />
     </a>
-</p>
+</p>

package.json

@@ -1,7 +1,7 @@
 {
   "name": "tsynamo",
   "author": "woltsu",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "Typed query builder for DynamoDB",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/nodes/expressionComparatorExpression.ts

@@ -0,0 +1,8 @@
+import { ExpressionConditionComparators } from "./operands";
+
+export type ExpressionComparatorExpressions = {
+  readonly kind: "ExpressionComparatorExpressions";
+  readonly key: string;
+  readonly operation: ExpressionConditionComparators;
+  readonly value: unknown;
+};

src/nodes/filterExpressionJoinTypeNode.ts → src/nodes/expressionJoinTypeNode.ts

@@ -3,18 +3,18 @@ import { AttributeNotExistsFunctionExpression } from "./attributeNotExistsFuncti
 import { BeginsWithFunctionExpression } from "./beginsWithFunctionExpression";
 import { BetweenConditionExpression } from "./betweenConditionExpression";
 import { ContainsFunctionExpression } from "./containsFunctionExpression";
-import { FilterExpressionComparatorExpressions } from "./filterExpressionComparatorExpression";
-import { FilterExpressionNode } from "./filterExpressionNode";
-import { FilterExpressionNotExpression } from "./filterExpressionNotExpression";
+import { ExpressionComparatorExpressions } from "./expressionComparatorExpression";
+import { ExpressionNode } from "./expressionNode";
+import { ExpressionNotExpression } from "./expressionNotExpression";
 
 export type JoinType = "AND" | "OR";
 
-export type FilterExpressionJoinTypeNode = {
-  readonly kind: "FilterExpressionJoinTypeNode";
+export type ExpressionJoinTypeNode = {
+  readonly kind: "ExpressionJoinTypeNode";
   readonly expr:
-    | FilterExpressionNode
-    | FilterExpressionComparatorExpressions
-    | FilterExpressionNotExpression
+    | ExpressionNode
+    | ExpressionComparatorExpressions
+    | ExpressionNotExpression
     | AttributeExistsFunctionExpression
     | AttributeNotExistsFunctionExpression
     | BetweenConditionExpression

src/nodes/expressionNode.ts

@@ -0,0 +1,6 @@
+import { ExpressionJoinTypeNode } from "./expressionJoinTypeNode";
+
+export type ExpressionNode = {
+  readonly kind: "ExpressionNode";
+  readonly expressions: ExpressionJoinTypeNode[];
+};

src/nodes/expressionNotExpression.ts

@@ -0,0 +1,6 @@
+import { ExpressionNode } from "./expressionNode";
+
+export type ExpressionNotExpression = {
+  readonly kind: "ExpressionNotExpression";
+  readonly expr: ExpressionNode;
+};

src/nodes/itemNode.ts

@@ -0,0 +1,4 @@
+export type ItemNode = {
+  readonly kind: "ItemNode";
+  readonly item: Record<string, unknown>;
+};

src/nodes/operands.ts

@@ -10,4 +10,4 @@ export type FunctionExpression =
 export type NotExpression = "NOT";
 
 export type KeyConditionComparators = "=" | "<" | "<=" | ">" | ">=";
-export type FilterConditionComparators = KeyConditionComparators | "<>";
+export type ExpressionConditionComparators = KeyConditionComparators | "<>";

src/nodes/putNode.ts

@@ -0,0 +1,12 @@
+import { ExpressionNode } from "./expressionNode";
+import { ItemNode } from "./itemNode";
+import { ReturnValuesNode } from "./returnValuesNode";
+import { TableNode } from "./tableNode";
+
+export type PutNode = {
+  readonly kind: "PutNode";
+  readonly table: TableNode;
+  readonly conditionExpression: ExpressionNode;
+  readonly item?: ItemNode;
+  readonly returnValues?: ReturnValuesNode;
+};

src/nodes/queryNode.ts

@@ -1,6 +1,6 @@
 import { AttributesNode } from "./attributesNode";
 import { ConsistentReadNode } from "./consistentReadNode";
-import { FilterExpressionNode } from "./filterExpressionNode";
+import { ExpressionNode } from "./expressionNode";
 import { KeyConditionNode } from "./keyConditionNode";
 import { LimitNode } from "./limitNode";
 import { ScanIndexForwardNode } from "./scanIndexForwardNode";
@@ -10,7 +10,7 @@ export type QueryNode = {
   readonly kind: "QueryNode";
   readonly table: TableNode;
   readonly keyConditions: KeyConditionNode[];
-  readonly filterExpression: FilterExpressionNode;
+  readonly filterExpression: ExpressionNode;
   readonly consistentRead?: ConsistentReadNode;
   readonly scanIndexForward?: ScanIndexForwardNode;
   readonly limit?: LimitNode;

src/nodes/returnValuesNode.ts

@@ -0,0 +1,11 @@
+export type ReturnValuesOptions =
+  | "NONE"
+  | "ALL_OLD"
+  | "UPDATED_OLD"
+  | "ALL_NEW"
+  | "UPDATED_NEW";
+
+export type ReturnValuesNode = {
+  readonly kind: "ReturnValuesNode";
+  readonly option: ReturnValuesOptions;
+};

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

@@ -0,0 +1,11 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`PutItemQueryBuilder > handles 'contains' ConditionExpression 1`] = `
+{
+  "dataTimestamp": 212,
+  "tags": [
+    "cats",
+  ],
+  "userId": "333",
+}
+`;