@moicky/dynamodb 1.1.1 → 1.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@moicky/dynamodb",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "description": "Contains a collection of convenience functions for working with AWS DynamoDB",

package/readme.md

@@ -1,7 +1,5 @@
 # @moicky/dynamodb
 
-## Stats
-
 ![](https://img.shields.io/github/languages/top/moicky/dynamodb)
 ![](https://img.shields.io/github/actions/workflow/status/moicky/dynamodb/npm-publish.yml?label=build)
 ![](https://img.shields.io/github/actions/workflow/status/moicky/dynamodb/run-tests.yml?label=tests)
@@ -14,6 +12,7 @@ Contains convenience functions for all major dynamodb operations. Requires very
 
 - 🎁 Will **automatically marshall and unmarshall** items
 - 📦 Will **group items into batches** to avoid aws limits and improve performance
+- ⏱ Will **automatically** add `createdAt` and `updatedAt` attributes on all items to track their most recent create/update operation timestamp. Example value: `Date.now() -> 1685138436000`
 - 🔄 Will **retry** some operations (getItems, deleteItems) **up to 3 times** on unprocessed items
 - 🔒 When specifying an item using its keySchema, all additional attributes (apart from **PK** and **SK**) will be removed to avoid errors
 - 👻 Will **use placeholders** to avoid colliding with [reserved words](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html) if applicable
@@ -98,28 +97,20 @@ await getAllItems();
 ```ts
 import { deleteItem, deleteItems } from "@moicky/dynamodb";
 
-// Passing more than just the key is possible, but will be removed to avoid errors
-
 // Delete single item
 await deleteItem({
   PK: "User/1",
   SK: "Book/1",
-  title: "The Great Gatsby", // additional fields will be removed before sending
+  title: "The Great Gatsby", // additional fields will be removed before sending to avoid errors
   author: "F. Scott Fitzgerald",
   released: 1925,
 });
 
 // Delete multiple items
-// Keys will be grouped into batches of 25 and will be retried up to 3 times if there are unprocessed items
-// Will also only delete each keySchema once, even if it is present multiple times in the array to improve performance
+// KeySchemas will be grouped into batches of 25 and will be retried up to 3 times if there are unprocessed items
+// Will only delete each keySchema only once, even if it is present multiple times in the array to improve performance
 await deleteItems([
-  {
-    PK: "User/1",
-    SK: "Book/1",
-    title: "The Great Gatsby", // additional fields will be removed before sending
-    author: "F. Scott Fitzgerald",
-    released: 1925,
-  },
+  { PK: "User/1", SK: "Book/1" },
   // ... infinite more items (will be grouped into batches of 25 due to aws limit) and retried up to 3 times
 ]);
 ```
@@ -129,27 +120,13 @@ await deleteItems([
 ```ts
 import { updateItem, removeAttributes } from "@moicky/dynamodb";
 
-// Passing more than just the key is possible, but will be removed to avoid errors
-
 // Update the item and overwrite all supplied fields
 await updateItem(
-  {
-    PK: "User/1",
-    SK: "Book/1",
-    title: "The Great Gatsby", // additional fields will be removed before sending
-  },
+  { PK: "User/1", SK: "Book/1" },
   { description: "A book about a rich guy", author: "F. Scott Fitzgerald" }
 );
 
-// Completely remove fields from the item
-await removeAttributes(
-  {
-    PK: "User/1",
-    SK: "Book/1",
-    title: "The Great Gatsby", // additional fields will be removed before sending
-  },
-  ["description"]
-);
+await removeAttributes({ PK: "User/1", SK: "Book/1" }, ["description"]);
 ```
 
 ### Query Items
@@ -157,7 +134,7 @@ await removeAttributes(
 ```ts
 import { query, queryItems, queryAllItems } from "@moicky/dynamodb";
 
-// You have to use placeholders for the keyCondition & filterExpression:
+// You HAVE TO use placeholders for the keyCondition & filterExpression:
 // prefix the attributeNames with a hash (#) and the attributeValues with a colon (:)
 
 // Query only using keyCondition and retrieve complete response
@@ -189,7 +166,7 @@ const booksWithFilter = await queryAllItems(
     to: 2000,
   },
   // additional args with filterExpression
-  { FilterExpression: "#released BETWEEN :from AND :to" }
+  { FilterExpression: "#released BETWEEN :from AND :to" } // allows to override all args
 );
 ```
 
@@ -202,15 +179,14 @@ import { itemExists, getNewId } from "@moicky/dynamodb";
 const exists = await itemExists({ PK: "User/1", SK: "Book/1" });
 
 // Generate ascending ID
+
 // Example Structure 1: PK: "User/1", SK: "{{ ASCENDING_ID }}"
 // Last item: { PK: "User/1", SK: "00000009" }
-
 const id1 = await getNewId({ PK: "User/1" });
 console.log(id1); // "00000010"
 
 // Example Structure 2: PK: "User/1", SK: "Book/{{ ASCENDING_ID }}"
 // Last item: { PK: "User/1", SK: "Book/00000009" }
-
 const id2 = await getNewId({ PK: "User/1", SK: "Book" });
 console.log(id2); // "00000010"