dynoquery 0.1.7 → 0.1.9

package/README.md

@@ -13,7 +13,6 @@ npm install dynoquery
 - Basic CRUD operations (create, get, update, delete)
 - Optimized for **Single-Table Design**
 - Query and Scan support
-- Batch operations (batchGet, batchWrite)
 - TypeScript support
 
 ## Usage
@@ -32,9 +31,9 @@ const db = new DynoQuery({
   models: {
     User: { pkPrefix: 'USER#' }, // TENANT#A#USER#
   },
-  indexes: {
+  findBy: {
     //  TENANT#A#CAT#
-    ByCategory: { indexName: 'GSI1', pkPrefix: 'CAT#' } // pkName defaults to GSI1PK, skName defaults to GSI1SK
+    Category: { indexName: 'GSI1', pkPrefix: 'CAT#' } // pkName defaults to GSI1PK, skName defaults to GSI1SK
   }
 });
 
@@ -45,7 +44,7 @@ async function example() {
   
   // Use registered index
   // Resulting GSI1PK: TENANT#A#CAT#1
-  const categories = db.ByCategory('1');
+  const categories = db.findByCategory('1');
   const items = await categories.get('100');
   const allItems = await categories.getAll();
   
@@ -68,9 +67,8 @@ async function example() {
   // Create an item through partition
   await john.create('PROFILE', { name: 'John Doe', email: 'john@example.com' });
   
-  // You can also use getPkValue() to get the generated PK for the partition or index
-  // This is useful when you need to store it in another attribute (e.g., GSI)
-  const cat = db.ByCategory('USER');
+  // Resulting GSI1PK: TENANT#A#CAT#USER
+  const cat = db.findByCategory('USER');
   await john.create('PROFILE', { 
     name: 'John Doe', 
     email: 'john@example.com', 
@@ -97,48 +95,6 @@ async function example() {
 }
 ```
 
-### Batch Operations
-
-If you have a `tableName` configured in `DynoQuery`, you can use the `Items` property in `batchGet` and `batchWrite` to automatically target that table.
-
-You can also generate items for `batchGet` using the `batchGetInput` method from partitions and indexes:
-
-```typescript
-const john = db.User('john@example.com');
-const jack = db.User('jack@example.com');
-const cat = db.ByCategory('1');
-
-const batchItem1 = john.batchGetInput('METADATA');
-const batchOthers = cat.batchGetInput('METADATA', 'DATA', 'PROFILE');
-const batchCat = cat.batchGetInput(); // No sk defined, so will get partition key only
-
-await db.batchGet(batchItem1, batchOthers, batchCat);
-```
-
-```typescript
-// batchGet with explicit Items
-await db.batchGet({
-  Items: [
-    { PK: 'USER#1', SK: 'METADATA' },
-    { PK: 'USER#2', SK: 'METADATA' }
-  ]
-});
-
-// batchWrite with simplified Items (automatically wrapped in PutRequest)
-await db.batchWrite({
-  Items: [
-    { PK: 'USER#3', SK: 'METADATA', name: 'Alice' },
-    {
-      DeleteRequest: {
-        Key: { PK: 'USER#1', SK: 'SESSION#123' }
-      }
-    }
-  ]
-});
-```
-
-You can still use the standard AWS SDK `RequestItems` if you need to target multiple tables or if you prefer the original syntax.
-
 ## API Reference
 
 ### DynoQuery
@@ -149,8 +105,6 @@ The main client for interacting with DynamoDB.
 - `delete(params)`: Delete an item.
 - `query(params)`: Query items.
 - `scan(params)`: Scan items.
-- `batchGet(params)`: Batch get items.
-- `batchWrite(params)`: Batch write items.
 
 ### Partition
 A way to manage data within a specific partition.
@@ -160,9 +114,6 @@ A way to manage data within a specific partition.
 - `create(sk, data)`: Creates an item in the partition.
 - `update(sk, data)`: Updates an existing item (partial update).
 - `delete(sk)`: Deletes an item.
-- `batchGetInput(...sks)`: Generates items for batch query.
-- `batchWriteInput(...items)`: Generates items for batch write.
-- `batchDeleteInput(...sks)`: Generates items for batch delete.
 - `deleteAll()`: Deletes all items in the partition.
 
 ### IndexQuery
@@ -170,9 +121,6 @@ A way to query Global Secondary Indexes.
 - `getPkValue()`: Returns the generated partition key value for this index.
 - `get(skValue | options)`: Query items in the index. Supports `skValue` (string) for `begins_with` search, or an options object with `skValue`, `limit`, and `scanIndexForward`.
 - `getAll()`: Fetches all items in the index for the given partition key.
-- `batchGetInput(...sks)`: Generates items for batch query.
-- `batchWriteInput(...items)`: Generates items for batch write.
-- `batchDeleteInput(...sks)`: Generates items for batch delete.
 - Automatically identifies the model name in results using `__model` (based on registered models) and provides `getPartition()` helper.
 
 ## License

package/dist/index-query.d.ts

@@ -22,17 +22,5 @@ export declare class IndexQuery {
     }): Promise<T[]>;
     getAll<T = any>(): Promise<T[]>;
     getPkValue(): string;
-    /**
-     * Generates items for batch query.
-     */
-    batchGetInput(...sks: string[]): any[];
-    /**
-     * Generates items for batch write (put).
-     */
-    batchWriteInput(...items: any[]): any[];
-    /**
-     * Generates items for batch delete.
-     */
-    batchDeleteInput(...sks: string[]): any[];
     private mapItemToModel;
 }

package/dist/index-query.js

@@ -71,49 +71,6 @@ class IndexQuery {
     getPkValue() {
         return this.pkValue;
     }
-    /**
-     * Generates items for batch query.
-     */
-    batchGetInput(...sks) {
-        if (sks.length === 0) {
-            return [{
-                    TableName: this.tableName,
-                    Key: { [this.pkName]: this.pkValue }
-                }];
-        }
-        return sks.map(sk => ({
-            TableName: this.tableName,
-            Key: {
-                [this.pkName]: this.pkValue,
-                [this.skName]: sk
-            }
-        }));
-    }
-    /**
-     * Generates items for batch write (put).
-     */
-    batchWriteInput(...items) {
-        return items.map(item => ({
-            TableName: this.tableName,
-            PutRequest: {
-                Item: Object.assign({ [this.pkName]: this.pkValue }, item)
-            }
-        }));
-    }
-    /**
-     * Generates items for batch delete.
-     */
-    batchDeleteInput(...sks) {
-        return sks.map(sk => ({
-            TableName: this.tableName,
-            DeleteRequest: {
-                Key: {
-                    [this.pkName]: this.pkValue,
-                    [this.skName]: sk
-                }
-            }
-        }));
-    }
     mapItemToModel(item) {
         const pkName = this.db.getPkName();
         const pkValue = item[pkName];

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { PutCommandInput, GetCommandInput, UpdateCommandInput, DeleteCommandInput, QueryCommandInput, ScanCommandInput, BatchGetCommandInput, BatchWriteCommandInput } from "@aws-sdk/lib-dynamodb";
+import { PutCommandInput, GetCommandInput, UpdateCommandInput, DeleteCommandInput, QueryCommandInput, ScanCommandInput } from "@aws-sdk/lib-dynamodb";
 export interface DynoQueryConfig {
     tableName?: string;
     pkName?: string;
@@ -14,19 +14,13 @@ export interface DynoQueryConfig {
     models?: Record<string, {
         pkPrefix: string;
     }>;
-    indexes?: Record<string, {
+    findBy?: Record<string, {
         indexName: string;
         pkName?: string;
         skName?: string;
         pkPrefix?: string;
     }>;
 }
-export type BatchGetInput = BatchGetCommandInput & {
-    Items?: any[];
-};
-export type BatchWriteInput = BatchWriteCommandInput & {
-    Items?: any[];
-};
 export declare class DynoQuery {
     private client;
     private docClient;
@@ -61,14 +55,6 @@ export declare class DynoQuery {
      * Scan the table or index for items.
      */
     scan(params: ScanCommandInput): Promise<import("@aws-sdk/lib-dynamodb").ScanCommandOutput>;
-    /**
-     * Get multiple items by their primary keys.
-     */
-    batchGet(params: BatchGetInput | any, ...additionalItems: any[][]): Promise<import("@aws-sdk/lib-dynamodb").BatchGetCommandOutput>;
-    /**
-     * Put or delete multiple items in one or more tables.
-     */
-    batchWrite(params: BatchWriteInput): Promise<import("@aws-sdk/lib-dynamodb").BatchWriteCommandOutput>;
     getTableName(): string | undefined;
     getPkPrefix(): string;
     getPkName(): string;

package/dist/index.js

@@ -41,7 +41,7 @@ const partition_1 = require("./partition");
 class DynoQuery {
     constructor(config = {}) {
         this.registeredModels = {};
-        const { tableName, pkName, skName, pkPrefix, models, indexes } = config, clientConfig = __rest(config, ["tableName", "pkName", "skName", "pkPrefix", "models", "indexes"]);
+        const { tableName, pkName, skName, pkPrefix, models, findBy } = config, clientConfig = __rest(config, ["tableName", "pkName", "skName", "pkPrefix", "models", "findBy"]);
         this.client = new client_dynamodb_1.DynamoDBClient(clientConfig);
         this.docClient = lib_dynamodb_1.DynamoDBDocumentClient.from(this.client, {
             marshallOptions: {
@@ -60,10 +60,11 @@ class DynoQuery {
                 };
             });
         }
-        if (indexes) {
+        if (findBy) {
             const { IndexQuery } = require("./index-query");
-            Object.entries(indexes).forEach(([name, def]) => {
-                this[name] = (id) => {
+            Object.entries(findBy).forEach(([name, def]) => {
+                const methodName = `findBy${name}`;
+                this[methodName] = (id) => {
                     return new IndexQuery(this, {
                         indexName: def.indexName,
                         pkName: def.pkName,
@@ -147,79 +148,6 @@ class DynoQuery {
             return yield this.docClient.send(command);
         });
     }
-    /**
-     * Get multiple items by their primary keys.
-     */
-    batchGet(params, ...additionalItems) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let finalParams;
-            if (params && !params.RequestItems && !params.Items && (Array.isArray(params) || additionalItems.length > 0)) {
-                // Handle the case where arguments are multiple arrays of items
-                const allItems = Array.isArray(params) ? [...params] : [];
-                additionalItems.forEach(chunk => {
-                    if (Array.isArray(chunk)) {
-                        allItems.push(...chunk);
-                    }
-                    else {
-                        allItems.push(chunk);
-                    }
-                });
-                finalParams = {
-                    Items: allItems
-                };
-            }
-            else {
-                finalParams = params;
-            }
-            if (!finalParams.RequestItems && finalParams.Items) {
-                finalParams.RequestItems = {};
-                finalParams.Items.forEach((item) => {
-                    const tableName = item.TableName || this.defaultTableName;
-                    if (!tableName) {
-                        throw new Error("TableName must be provided for batch operations if no default tableName is set");
-                    }
-                    if (!finalParams.RequestItems[tableName]) {
-                        finalParams.RequestItems[tableName] = { Keys: [] };
-                    }
-                    const key = item.Key || item;
-                    finalParams.RequestItems[tableName].Keys.push(key);
-                });
-                delete finalParams.Items;
-            }
-            else if (!finalParams.RequestItems && this.defaultTableName) {
-                finalParams.RequestItems = {};
-            }
-            const command = new lib_dynamodb_1.BatchGetCommand(finalParams);
-            return yield this.docClient.send(command);
-        });
-    }
-    /**
-     * Put or delete multiple items in one or more tables.
-     */
-    batchWrite(params) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!params.RequestItems && params.Items) {
-                params.RequestItems = {};
-                params.Items.forEach((item) => {
-                    const tableName = item.TableName || this.defaultTableName;
-                    if (!tableName) {
-                        throw new Error("TableName must be provided for batch operations if no default tableName is set");
-                    }
-                    if (!params.RequestItems[tableName]) {
-                        params.RequestItems[tableName] = [];
-                    }
-                    const request = item.PutRequest || item.DeleteRequest ? item : { PutRequest: { Item: item } };
-                    params.RequestItems[tableName].push(request);
-                });
-                delete params.Items;
-            }
-            else if (!params.RequestItems && this.defaultTableName) {
-                params.RequestItems = {};
-            }
-            const command = new lib_dynamodb_1.BatchWriteCommand(params);
-            return yield this.docClient.send(command);
-        });
-    }
     getTableName() {
         return this.defaultTableName;
     }

package/dist/partition.d.ts

@@ -37,22 +37,6 @@ export declare class Partition {
      */
     get<T = any>(sk: string): Promise<T | null>;
     getPkValue(): string;
-    /**
-     * Generates items for batch query.
-     * If no SKs are provided, it might not be very useful for batchGet (which requires full keys),
-     * but the requirement says "will get all by pkValue" if no sk defined.
-     * Actually, BatchGetItem requires both PK and SK if the table has both.
-     * If it's for IndexQuery, it might be different.
-     */
-    batchGetInput(...sks: string[]): any[];
-    /**
-     * Generates items for batch write (put).
-     */
-    batchWriteInput(...items: any[]): any[];
-    /**
-     * Generates items for batch delete.
-     */
-    batchDeleteInput(...sks: string[]): any[];
     /**
      * Delete all data in this partition.
      */

package/dist/partition.js

@@ -144,53 +144,6 @@ class Partition {
     getPkValue() {
         return this.pkValue;
     }
-    /**
-     * Generates items for batch query.
-     * If no SKs are provided, it might not be very useful for batchGet (which requires full keys),
-     * but the requirement says "will get all by pkValue" if no sk defined.
-     * Actually, BatchGetItem requires both PK and SK if the table has both.
-     * If it's for IndexQuery, it might be different.
-     */
-    batchGetInput(...sks) {
-        if (sks.length === 0) {
-            return [{
-                    TableName: this.tableName,
-                    Key: { [this.pkName]: this.pkValue }
-                }];
-        }
-        return sks.map(sk => ({
-            TableName: this.tableName,
-            Key: {
-                [this.pkName]: this.pkValue,
-                [this.skName]: sk
-            }
-        }));
-    }
-    /**
-     * Generates items for batch write (put).
-     */
-    batchWriteInput(...items) {
-        return items.map(item => ({
-            TableName: this.tableName,
-            PutRequest: {
-                Item: Object.assign({ [this.pkName]: this.pkValue }, item)
-            }
-        }));
-    }
-    /**
-     * Generates items for batch delete.
-     */
-    batchDeleteInput(...sks) {
-        return sks.map(sk => ({
-            TableName: this.tableName,
-            DeleteRequest: {
-                Key: {
-                    [this.pkName]: this.pkValue,
-                    [this.skName]: sk
-                }
-            }
-        }));
-    }
     /**
      * Delete all data in this partition.
      */
@@ -207,24 +160,12 @@ class Partition {
                 },
             });
             if (response.Items && response.Items.length > 0) {
-                // DynamoDB BatchWriteItem supports up to 25 requests at once
-                const items = response.Items;
-                const chunks = [];
-                for (let i = 0; i < items.length; i += 25) {
-                    chunks.push(items.slice(i, i + 25));
-                }
-                for (const chunk of chunks) {
-                    const deleteRequests = chunk.map((item) => ({
-                        DeleteRequest: {
-                            Key: {
-                                [this.pkName]: item[this.pkName],
-                                [this.skName]: item[this.skName],
-                            },
-                        },
-                    }));
-                    yield this.db.batchWrite({
-                        RequestItems: {
-                            [this.tableName]: deleteRequests,
+                for (const item of response.Items) {
+                    yield this.db.delete({
+                        TableName: this.tableName,
+                        Key: {
+                            [this.pkName]: item[this.pkName],
+                            [this.skName]: item[this.skName],
                         },
                     });
                 }

package/package.json

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