dynoquery 0.1.19 → 0.1.20

package/README.md

@@ -188,16 +188,16 @@ DynoQuery provides `batchWrite` and `batchRead` for processing multiple items ac
 
 ```typescript
 // 1. Batch Write (Create/Replace multiple items)
-const user1 = db.User('john', 'METADATA');
+const user1 = db.User('john@example.com', 'METADATA');
 user1.name = 'John Doe';
 
-const user2 = db.User('jane', 'METADATA');
+const user2 = db.User('jane@example.com', 'METADATA');
 user2.name = 'Jane Doe';
 
 await db.batchWrite([user1, user2]);
 
 // 2. Batch Read (Fetch multiple items or index queries)
-const userDraft = db.User('john', 'METADATA');
+const userDraft = db.User('john@example.com', 'METADATA');
 const categoryQuery = db.findByCategory('ELECTRONICS', 'p123');
 
 const results = await db.batchRead([userDraft, categoryQuery]);
@@ -209,6 +209,10 @@ results.forEach(item => {
     item.save(); // Second-level methods are available
   }
 });
+
+// 3. Batch Delete
+const userToDelete = db.User('john@example.com').draftDelete('METADATA');
+await db.batchWrite([userToDelete]);
 ```
 
 ## Optional Configuration Parameters
@@ -276,6 +280,7 @@ if (token) {
 - `update(skValue, data)`: Partial update of an item.
 - `delete(skValue)`: Deletes an item.
 - `draft(skValue, data?)`: Returns an `Item` object initialized with `data` (optional).
+- `draftDelete(skValue)`: Returns an `Item` object marked for deletion (for use with `batchWrite`).
 - `deleteAll()`: Deletes all items in the partition.
 - `getLastEvaluatedKey()`: Returns the pagination token from the last `getAll()`.
 

package/dist/index.js

@@ -167,22 +167,34 @@ class DynoQuery {
                 if (!tableGroups[tableName]) {
                     tableGroups[tableName] = [];
                 }
-                const dataToSave = {};
-                for (const key in item) {
-                    if (Object.prototype.hasOwnProperty.call(item, key) &&
-                        !["_indices", "_partition", "_skValue"].includes(key) &&
-                        typeof item[key] !== "function") {
-                        dataToSave[key] = item[key];
+                if (item.toBeDeleted()) {
+                    tableGroups[tableName].push({
+                        DeleteRequest: {
+                            Key: {
+                                [this.pkName]: partition.getPkValue(),
+                                [this.skName]: skValue,
+                            },
+                        },
+                    });
+                }
+                else {
+                    const dataToSave = {};
+                    for (const key in item) {
+                        if (Object.prototype.hasOwnProperty.call(item, key) &&
+                            !["_indices", "_partition", "_skValue", "_toBeDeleted"].includes(key) &&
+                            typeof item[key] !== "function") {
+                            dataToSave[key] = item[key];
+                        }
                     }
+                    // Ensure PK and SK are in the data
+                    dataToSave[this.pkName] = partition.getPkValue();
+                    dataToSave[this.skName] = skValue;
+                    tableGroups[tableName].push({
+                        PutRequest: {
+                            Item: dataToSave,
+                        },
+                    });
                 }
-                // Ensure PK and SK are in the data
-                dataToSave[this.pkName] = partition.getPkValue();
-                dataToSave[this.skName] = skValue;
-                tableGroups[tableName].push({
-                    PutRequest: {
-                        Item: dataToSave,
-                    },
-                });
             });
             const results = [];
             const tableNames = Object.keys(tableGroups);

package/dist/partition.d.ts

@@ -10,6 +10,7 @@ export declare class Item {
     private _indices;
     private _partition;
     private _skValue;
+    private _toBeDeleted;
     constructor(partition: Partition, skValue: string, data: any);
 }
 export declare class Partition {
@@ -55,10 +56,15 @@ export declare class Partition {
     get<T = any>(skValue: string): Promise<T | null>;
     /**
      * Pre-draft an item for creation. Returns an Item object.
-     * @param sk The sort key value
+     * @param skValue The sort key value
      * @param data Initial data for the row
      */
     draft<T = any>(skValue: string, data?: any): T;
+    /**
+     * Pre-draft an item for deletion. Returns an Item object marked for deletion.
+     * @param skValue The sort key value
+     */
+    draftDelete<T = any>(skValue: string): T;
     getTableName(): string;
     getPkValue(): string;
     getLastEvaluatedKey(): any;

package/dist/partition.js

@@ -15,6 +15,7 @@ class Item {
         this._indices = [];
         this._partition = partition;
         this._skValue = skValue;
+        this._toBeDeleted = !!(data === null || data === void 0 ? void 0 : data._toBeDeleted);
         Object.assign(this, data);
         const self = this;
         return new Proxy(this, {
@@ -24,7 +25,7 @@ class Item {
                         const dataToSave = {};
                         for (const key in target) {
                             if (Object.prototype.hasOwnProperty.call(target, key) &&
-                                !["_indices", "_partition", "_skValue"].includes(key) &&
+                                !["_indices", "_partition", "_skValue", "_toBeDeleted"].includes(key) &&
                                 typeof target[key] !== "function") {
                                 dataToSave[key] = target[key];
                             }
@@ -61,6 +62,9 @@ class Item {
                 if (prop === "getSkValue") {
                     return () => skValue;
                 }
+                if (prop === "toBeDeleted") {
+                    return () => self._toBeDeleted;
+                }
                 return Reflect.get(target, prop, receiver);
             },
         });
@@ -219,12 +223,19 @@ class Partition {
     }
     /**
      * Pre-draft an item for creation. Returns an Item object.
-     * @param sk The sort key value
+     * @param skValue The sort key value
      * @param data Initial data for the row
      */
     draft(skValue, data = {}) {
         return new Item(this, skValue, data);
     }
+    /**
+     * Pre-draft an item for deletion. Returns an Item object marked for deletion.
+     * @param skValue The sort key value
+     */
+    draftDelete(skValue) {
+        return new Item(this, skValue, { _toBeDeleted: true });
+    }
     getTableName() {
         return this.tableName || "";
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dynoquery",
-  "version": "0.1.19",
+  "version": "0.1.20",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/devspikejs/dynoquery.git"