betterddb 0.4.6 → 0.4.7

package/lib/betterddb.d.ts

@@ -6,6 +6,7 @@ import { CreateBuilder } from './builders/create-builder';
 import { GetBuilder } from './builders/get-builder';
 import { DeleteBuilder } from './builders/delete-builder';
 import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb';
+import { BatchGetBuilder } from './builders/batch-get-builder';
 export type PrimaryKeyValue = string | number;
 /**
  * A key definition can be either a simple key (a property name)
@@ -110,6 +111,10 @@ export declare class BetterDDB<T> {
      * Get an item by its primary key.
      */
     get(rawKey: Partial<T>): GetBuilder<T>;
+    /**
+     * Get multiple items by their primary keys.
+     */
+    batchGet(rawKeys: Partial<T>[]): BatchGetBuilder<T>;
     /**
      * Update an item.
      */

package/lib/betterddb.js

@@ -7,6 +7,7 @@ const update_builder_1 = require("./builders/update-builder");
 const create_builder_1 = require("./builders/create-builder");
 const get_builder_1 = require("./builders/get-builder");
 const delete_builder_1 = require("./builders/delete-builder");
+const batch_get_builder_1 = require("./builders/batch-get-builder");
 /**
  * BetterDDB is a definition-based DynamoDB wrapper library.
  */
@@ -114,6 +115,12 @@ class BetterDDB {
     get(rawKey) {
         return new get_builder_1.GetBuilder(this, rawKey);
     }
+    /**
+     * Get multiple items by their primary keys.
+     */
+    batchGet(rawKeys) {
+        return new batch_get_builder_1.BatchGetBuilder(this, rawKeys);
+    }
     /**
      * Update an item.
      */

package/lib/builders/batch-get-builder.d.ts

@@ -0,0 +1,21 @@
+import { BetterDDB } from '../betterddb';
+export declare class BatchGetBuilder<T> {
+    private parent;
+    private keys;
+    private projectionExpression?;
+    private expressionAttributeNames;
+    /**
+     * @param parent - The BetterDDB instance for the table.
+     * @param keys - An array of partial keys for the items you wish to retrieve.
+     */
+    constructor(parent: BetterDDB<T>, keys: Partial<T>[]);
+    /**
+     * Specify a projection by providing an array of attribute names.
+     */
+    withProjection(attributes: (keyof T)[]): this;
+    /**
+     * Executes the batch get operation.
+     * Returns an array of parsed items of type T.
+     */
+    execute(): Promise<T[]>;
+}

package/lib/builders/batch-get-builder.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BatchGetBuilder = void 0;
+const lib_dynamodb_1 = require("@aws-sdk/lib-dynamodb");
+class BatchGetBuilder {
+    /**
+     * @param parent - The BetterDDB instance for the table.
+     * @param keys - An array of partial keys for the items you wish to retrieve.
+     */
+    constructor(parent, keys) {
+        this.parent = parent;
+        this.keys = keys;
+        this.expressionAttributeNames = {};
+    }
+    /**
+     * Specify a projection by providing an array of attribute names.
+     */
+    withProjection(attributes) {
+        this.projectionExpression = attributes.map(attr => `#${String(attr)}`).join(', ');
+        for (const attr of attributes) {
+            this.expressionAttributeNames[`#${String(attr)}`] = String(attr);
+        }
+        return this;
+    }
+    /**
+     * Executes the batch get operation.
+     * Returns an array of parsed items of type T.
+     */
+    async execute() {
+        const tableName = this.parent.getTableName();
+        // Build an array of keys using the parent's key builder.
+        const keysArray = this.keys.map(key => this.parent.buildKey(key));
+        // Construct the BatchGet parameters.
+        const params = {
+            RequestItems: {
+                [tableName]: {
+                    Keys: keysArray,
+                    ...(this.projectionExpression && {
+                        ProjectionExpression: this.projectionExpression,
+                        ExpressionAttributeNames: this.expressionAttributeNames,
+                    }),
+                },
+            },
+        };
+        const result = await this.parent.getClient().send(new lib_dynamodb_1.BatchGetCommand(params));
+        const responses = result.Responses ? result.Responses[tableName] : [];
+        if (!responses) {
+            return [];
+        }
+        return this.parent.getSchema().array().parse(responses);
+    }
+}
+exports.BatchGetBuilder = BatchGetBuilder;

package/lib/builders/create-builder.d.ts

@@ -8,7 +8,4 @@ export declare class CreateBuilder<T> {
     execute(): Promise<T>;
     transactWrite(ops: TransactWriteItem[] | TransactWriteItem): this;
     toTransactPut(): TransactWriteItem;
-    then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
-    catch<TResult = never>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null): Promise<T | TResult>;
-    finally(onfinally?: (() => void) | null): Promise<T>;
 }

package/lib/builders/create-builder.js

@@ -62,14 +62,5 @@ class CreateBuilder {
         };
         return { Put: putItem };
     }
-    then(onfulfilled, onrejected) {
-        return this.execute().then(onfulfilled, onrejected);
-    }
-    catch(onrejected) {
-        return this.execute().catch(onrejected);
-    }
-    finally(onfinally) {
-        return this.execute().finally(onfinally);
-    }
 }
 exports.CreateBuilder = CreateBuilder;

package/lib/builders/delete-builder.d.ts

@@ -13,7 +13,4 @@ export declare class DeleteBuilder<T> {
     execute(): Promise<void>;
     transactWrite(ops: TransactWriteItem[] | TransactWriteItem): this;
     toTransactDelete(): TransactWriteItem;
-    then<TResult1 = void, TResult2 = never>(onfulfilled?: ((value: void) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
-    catch<TResult = never>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null): Promise<void | TResult>;
-    finally(onfinally?: (() => void) | null): Promise<void>;
 }

package/lib/builders/delete-builder.js

@@ -68,14 +68,5 @@ class DeleteBuilder {
         }
         return { Delete: deleteItem };
     }
-    then(onfulfilled, onrejected) {
-        return this.execute().then(onfulfilled, onrejected);
-    }
-    catch(onrejected) {
-        return this.execute().catch(onrejected);
-    }
-    finally(onfinally) {
-        return this.execute().finally(onfinally);
-    }
 }
 exports.DeleteBuilder = DeleteBuilder;

package/lib/builders/get-builder.d.ts

@@ -14,7 +14,4 @@ export declare class GetBuilder<T> {
     execute(): Promise<T | null>;
     transactGet(ops: TransactGetItem[] | TransactGetItem): this;
     toTransactGet(): TransactGetItem;
-    then<TResult1 = T | null, TResult2 = never>(onfulfilled?: ((value: T | null) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
-    catch<TResult = never>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null): Promise<T | null | TResult>;
-    finally(onfinally?: (() => void) | null): Promise<T | null>;
 }

package/lib/builders/get-builder.js

@@ -67,14 +67,5 @@ class GetBuilder {
         }
         return { Get: getItem };
     }
-    then(onfulfilled, onrejected) {
-        return this.execute().then(onfulfilled, onrejected);
-    }
-    catch(onrejected) {
-        return this.execute().catch(onrejected);
-    }
-    finally(onfinally) {
-        return this.execute().finally(onfinally);
-    }
 }
 exports.GetBuilder = GetBuilder;

package/lib/builders/query-builder.d.ts

@@ -5,7 +5,7 @@ export declare class QueryBuilder<T> {
     private filters;
     private expressionAttributeNames;
     private expressionAttributeValues;
-    private indexName?;
+    private index?;
     private sortKeyCondition?;
     private limit?;
     private lastKey?;
@@ -21,7 +21,4 @@ export declare class QueryBuilder<T> {
      * Executes the query and returns a Promise that resolves with an array of items.
      */
     execute(): Promise<T[]>;
-    then<TResult1 = T[], TResult2 = never>(onfulfilled?: ((value: T[]) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
-    catch<TResult = never>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null): Promise<T[] | TResult>;
-    finally(onfinally?: (() => void) | null): Promise<T[]>;
 }

package/lib/builders/query-builder.js

@@ -12,7 +12,13 @@ class QueryBuilder {
         this.ascending = true;
     }
     usingIndex(indexName) {
-        this.indexName = indexName;
+        if (!this.parent.getKeys().gsis) {
+            throw new Error('No global secondary indexes defined for this table');
+        }
+        if (!(indexName in this.parent.getKeys().gsis)) {
+            throw new Error('index does not exist');
+        }
+        this.index = this.parent.getKeys().gsis[indexName];
         return this;
     }
     sortAscending() {
@@ -64,19 +70,20 @@ class QueryBuilder {
      * Executes the query and returns a Promise that resolves with an array of items.
      */
     async execute() {
-        // Build a simple key condition for the partition key.
+        var _a, _b;
         const keys = this.parent.getKeys();
-        const pkName = keys.primary.name;
+        let pkName = keys.primary.name;
+        let builtKey = this.parent.buildKey(this.key);
+        if (this.index) {
+            pkName = this.index.primary.name;
+            builtKey = this.parent.buildIndexes(this.key);
+        }
         this.expressionAttributeNames['#pk'] = pkName;
-        // Cast the built key to a record so that we can index by string.
-        const builtKey = this.parent.buildKey(this.key);
-        this.expressionAttributeValues[':pk_value'] = builtKey[pkName];
         let keyConditionExpression = `#pk = :pk_value`;
-        // If a sortKeyCondition was set via another fluent method, append it.
         if (this.sortKeyCondition) {
             keyConditionExpression += ` AND ${this.sortKeyCondition}`;
         }
-        // If any filters were added, set them as FilterExpression.
+        this.expressionAttributeValues[':pk_value'] = builtKey[pkName];
         const params = {
             TableName: this.parent.getTableName(),
             KeyConditionExpression: keyConditionExpression,
@@ -85,7 +92,7 @@ class QueryBuilder {
             ScanIndexForward: this.ascending,
             Limit: this.limit,
             ExclusiveStartKey: this.lastKey,
-            IndexName: this.indexName
+            IndexName: (_b = (_a = this.index) === null || _a === void 0 ? void 0 : _a.name) !== null && _b !== void 0 ? _b : undefined
         };
         if (this.filters.length > 0) {
             params.FilterExpression = this.filters.join(' AND ');
@@ -93,15 +100,5 @@ class QueryBuilder {
         const result = await this.parent.getClient().send(new lib_dynamodb_1.QueryCommand(params));
         return this.parent.getSchema().array().parse(result.Items);
     }
-    // Thenable implementation.
-    then(onfulfilled, onrejected) {
-        return this.execute().then(onfulfilled, onrejected);
-    }
-    catch(onrejected) {
-        return this.execute().catch(onrejected);
-    }
-    finally(onfinally) {
-        return this.execute().finally(onfinally);
-    }
 }
 exports.QueryBuilder = QueryBuilder;

package/lib/builders/scan-builder.d.ts

@@ -14,7 +14,4 @@ export declare class ScanBuilder<T> {
      * Executes the scan and returns a Promise that resolves with an array of items.
      */
     execute(): Promise<T[]>;
-    then<TResult1 = T[], TResult2 = never>(onfulfilled?: ((value: T[]) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
-    catch<TResult = never>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null): Promise<T[] | TResult>;
-    finally(onfinally?: (() => void) | null): Promise<T[]>;
 }

package/lib/builders/scan-builder.js

@@ -63,15 +63,5 @@ class ScanBuilder {
         const result = await this.parent.getClient().send(new lib_dynamodb_1.ScanCommand(params));
         return this.parent.getSchema().array().parse(result.Items);
     }
-    // Thenable implementation.
-    then(onfulfilled, onrejected) {
-        return this.execute().then(onfulfilled, onrejected);
-    }
-    catch(onrejected) {
-        return this.execute().catch(onrejected);
-    }
-    finally(onfinally) {
-        return this.execute().finally(onfinally);
-    }
 }
 exports.ScanBuilder = ScanBuilder;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "betterddb",
-  "version": "0.4.6",
+  "version": "0.4.7",
   "description": "A definition-based DynamoDB wrapper library that provides a schema-driven and fully typesafe DAL.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

package/src/betterddb.ts

@@ -6,6 +6,7 @@ import { CreateBuilder } from './builders/create-builder';
 import { GetBuilder } from './builders/get-builder';
 import { DeleteBuilder } from './builders/delete-builder';
 import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb';
+import { BatchGetBuilder } from './builders/batch-get-builder';
 
 export type PrimaryKeyValue = string | number;
 
@@ -212,6 +213,13 @@ export class BetterDDB<T> {
     return new GetBuilder<T>(this, rawKey);
   }
 
+  /**
+   * Get multiple items by their primary keys.
+   */
+  public batchGet(rawKeys: Partial<T>[]): BatchGetBuilder<T> {
+    return new BatchGetBuilder<T>(this, rawKeys);
+  }
+
   /**
    * Update an item.
    */

package/src/builders/batch-get-builder.ts

@@ -0,0 +1,56 @@
+import { BetterDDB } from '../betterddb';
+import { BatchGetCommand } from '@aws-sdk/lib-dynamodb';
+import { BatchGetItemInput } from '@aws-sdk/client-dynamodb';
+
+export class BatchGetBuilder<T> {
+  private projectionExpression?: string;
+  private expressionAttributeNames: Record<string, string> = {};
+
+  /**
+   * @param parent - The BetterDDB instance for the table.
+   * @param keys - An array of partial keys for the items you wish to retrieve.
+   */
+  constructor(private parent: BetterDDB<T>, private keys: Partial<T>[]) {}
+
+  /**
+   * Specify a projection by providing an array of attribute names.
+   */
+  public withProjection(attributes: (keyof T)[]): this {
+    this.projectionExpression = attributes.map(attr => `#${String(attr)}`).join(', ');
+    for (const attr of attributes) {
+      this.expressionAttributeNames[`#${String(attr)}`] = String(attr);
+    }
+    return this;
+  }
+
+  /**
+   * Executes the batch get operation.
+   * Returns an array of parsed items of type T.
+   */
+  public async execute(): Promise<T[]> {
+    const tableName = this.parent.getTableName();
+    // Build an array of keys using the parent's key builder.
+    const keysArray = this.keys.map(key => this.parent.buildKey(key));
+
+    // Construct the BatchGet parameters.
+    const params: BatchGetItemInput = {
+      RequestItems: {
+        [tableName]: {
+          Keys: keysArray,
+          ...(this.projectionExpression && {
+            ProjectionExpression: this.projectionExpression,
+            ExpressionAttributeNames: this.expressionAttributeNames,
+          }),
+        },
+      },
+    };
+
+    const result = await this.parent.getClient().send(new BatchGetCommand(params));
+    const responses = result.Responses ? result.Responses[tableName] : [];
+    if (!responses) {
+      return [];
+    }
+
+    return this.parent.getSchema().array().parse(responses) as T[];
+  }
+}

package/src/builders/create-builder.ts

@@ -66,19 +66,4 @@ export class CreateBuilder<T> {
     };
     return { Put: putItem };
   }
-
-  public then<TResult1 = T, TResult2 = never>(
-    onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null,
-    onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null
-  ): Promise<TResult1 | TResult2> {
-    return this.execute().then(onfulfilled, onrejected);
-  }
-  public catch<TResult = never>(
-    onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null
-  ): Promise<T | TResult> {
-    return this.execute().catch(onrejected);
-  }
-  public finally(onfinally?: (() => void) | null): Promise<T> {
-    return this.execute().finally(onfinally);
-  }
 }

package/src/builders/delete-builder.ts

@@ -66,19 +66,4 @@ export class DeleteBuilder<T> {
     }
     return { Delete: deleteItem };
   }
-
-  public then<TResult1 = void, TResult2 = never>(
-    onfulfilled?: ((value: void) => TResult1 | PromiseLike<TResult1>) | null,
-    onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null
-  ): Promise<TResult1 | TResult2> {
-    return this.execute().then(onfulfilled, onrejected);
-  }
-  public catch<TResult = never>(
-    onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null
-  ): Promise<void | TResult> {
-    return this.execute().catch(onrejected);
-  }
-  public finally(onfinally?: (() => void) | null): Promise<void> {
-    return this.execute().finally(onfinally);
-  }
 }

package/src/builders/get-builder.ts

@@ -65,19 +65,4 @@ export class GetBuilder<T> {
     }
     return { Get: getItem };
   }
-
-  public then<TResult1 = T | null, TResult2 = never>(
-    onfulfilled?: ((value: T | null) => TResult1 | PromiseLike<TResult1>) | null,
-    onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null
-  ): Promise<TResult1 | TResult2> {
-    return this.execute().then(onfulfilled, onrejected);
-  }
-  public catch<TResult = never>(
-    onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null
-  ): Promise<T | null | TResult> {
-    return this.execute().catch(onrejected);
-  }
-  public finally(onfinally?: (() => void) | null): Promise<T | null> {
-    return this.execute().finally(onfinally);
-  }
 }

package/src/builders/query-builder.ts

@@ -1,12 +1,12 @@
 import { QueryCommand, QueryCommandInput } from '@aws-sdk/lib-dynamodb';
-import { BetterDDB } from '../betterddb';
+import { BetterDDB, GSIConfig } from '../betterddb';
 
 export class QueryBuilder<T> {
   private filters: string[] = [];
   private expressionAttributeNames: Record<string, string> = {};
   private expressionAttributeValues: Record<string, any> = {};
-  private indexName?: string;
-  private sortKeyCondition?: string; // You can extend this to support a fluent sort builder.
+  private index?: GSIConfig<T>;
+  private sortKeyCondition?: string;
   private limit?: number;
   private lastKey?: Record<string, any>;
   private ascending: boolean = true;
@@ -14,7 +14,14 @@ export class QueryBuilder<T> {
   constructor(private parent: BetterDDB<T>, private key: Partial<T>) {}
 
   public usingIndex(indexName: string): this {
-    this.indexName = indexName;
+    if (!this.parent.getKeys().gsis) {
+      throw new Error('No global secondary indexes defined for this table');
+    }
+    if (!(indexName in this.parent.getKeys().gsis!)) {
+      throw new Error('index does not exist')
+    }
+    
+    this.index = this.parent.getKeys().gsis![indexName];
     return this;
   }
 
@@ -74,22 +81,22 @@ export class QueryBuilder<T> {
    * Executes the query and returns a Promise that resolves with an array of items.
    */
   public async execute(): Promise<T[]> {
-    // Build a simple key condition for the partition key.
     const keys = this.parent.getKeys();
-    const pkName = keys.primary.name;
+    let pkName = keys.primary.name;
+    let builtKey = this.parent.buildKey(this.key) as Record<string, any>;
+    if (this.index) {
+      pkName = this.index.primary.name;
+      builtKey = this.parent.buildIndexes(this.key);
+    }
     this.expressionAttributeNames['#pk'] = pkName;
 
-    // Cast the built key to a record so that we can index by string.
-    const builtKey = this.parent.buildKey(this.key) as Record<string, any>;
-    this.expressionAttributeValues[':pk_value'] = builtKey[pkName];
-
     let keyConditionExpression = `#pk = :pk_value`;
-    // If a sortKeyCondition was set via another fluent method, append it.
     if (this.sortKeyCondition) {
       keyConditionExpression += ` AND ${this.sortKeyCondition}`;
     }
 
-    // If any filters were added, set them as FilterExpression.
+    this.expressionAttributeValues[':pk_value'] = builtKey[pkName];
+
     const params: QueryCommandInput = {
       TableName: this.parent.getTableName(),
       KeyConditionExpression: keyConditionExpression,
@@ -98,7 +105,7 @@ export class QueryBuilder<T> {
       ScanIndexForward: this.ascending,
       Limit: this.limit,
       ExclusiveStartKey: this.lastKey,
-      IndexName: this.indexName
+      IndexName: this.index?.name ?? undefined
     };
 
     if (this.filters.length > 0) {
@@ -108,20 +115,4 @@ export class QueryBuilder<T> {
     const result = await this.parent.getClient().send(new QueryCommand(params));
     return this.parent.getSchema().array().parse(result.Items) as T[];
   }
-
-  // Thenable implementation.
-  public then<TResult1 = T[], TResult2 = never>(
-    onfulfilled?: ((value: T[]) => TResult1 | PromiseLike<TResult1>) | null,
-    onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null
-  ): Promise<TResult1 | TResult2> {
-    return this.execute().then(onfulfilled, onrejected);
-  }
-  public catch<TResult = never>(
-    onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null
-  ): Promise<T[] | TResult> {
-    return this.execute().catch(onrejected);
-  }
-  public finally(onfinally?: (() => void) | null): Promise<T[]> {
-    return this.execute().finally(onfinally);
-  }
 }

package/src/builders/scan-builder.ts

@@ -71,20 +71,4 @@ export class ScanBuilder<T> {
     const result = await this.parent.getClient().send(new ScanCommand(params));
     return this.parent.getSchema().array().parse(result.Items) as T[];
   }
-
-  // Thenable implementation.
-  public then<TResult1 = T[], TResult2 = never>(
-    onfulfilled?: ((value: T[]) => TResult1 | PromiseLike<TResult1>) | null,
-    onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null
-  ): Promise<TResult1 | TResult2> {
-    return this.execute().then(onfulfilled, onrejected);
-  }
-  public catch<TResult = never>(
-    onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null
-  ): Promise<T[] | TResult> {
-    return this.execute().catch(onrejected);
-  }
-  public finally(onfinally?: (() => void) | null): Promise<T[]> {
-    return this.execute().finally(onfinally);
-  }
 }

package/test/create.test.ts

@@ -30,7 +30,7 @@ const UserSchema = z.object({
 
 type User = z.infer<typeof UserSchema>;
 
-const userDdb = new BetterDDB<User>({
+const userDdb = new BetterDDB({
   schema: UserSchema,
   tableName: TEST_TABLE,
   entityName: ENTITY_NAME,

package/test/delete.test.ts

@@ -30,7 +30,7 @@ const UserSchema = z.object({
 
 type User = z.infer<typeof UserSchema>;
 
-const userDdb = new BetterDDB<User>({
+const userDdb = new BetterDDB({
   schema: UserSchema,
   tableName: TEST_TABLE,
   entityName: ENTITY_NAME,

package/test/get.test.ts

@@ -31,7 +31,7 @@ const UserSchema = z.object({
 
 type User = z.infer<typeof UserSchema>;
 
-const userDdb = new BetterDDB<User>({
+const userDdb = new BetterDDB({
   schema: UserSchema,
   tableName: TEST_TABLE,
   entityName: ENTITY_NAME,

package/test/query.test.ts

@@ -29,7 +29,7 @@ const UserSchema = z.object({
 
 type User = z.infer<typeof UserSchema>;
 
-const userDdb = new BetterDDB<User>({
+const userDdb = new BetterDDB({
   schema: UserSchema,
   tableName: TEST_TABLE,
   entityName: ENTITY_NAME,
@@ -48,7 +48,7 @@ const userDdb = new BetterDDB<User>({
 
 beforeAll(async () => {
   await createTestTable(TEST_TABLE, KEY_SCHEMA, ATTRIBUTE_DEFINITIONS);
-  // Insert multiple items.
+
   const items = [
     { id: 'user-1', name: 'Alice', email: 'alice@example.com' },
     { id: 'user-2', name: 'Alice B', email: 'alice@example.com' },
@@ -67,10 +67,21 @@ describe('BetterDDB - Query Operation', () => {
   it('should query items using QueryBuilder', async () => {
     const results = await userDdb.query({ id: 'user-1' })
       .where('name', 'begins_with', 'Alice')
-      .limitResults(5);
+      .limitResults(5).execute();
     expect(results.length).toBeGreaterThanOrEqual(1);
     results.forEach(result => {
       expect(result.name).toMatch(/^Alice/);
     });
   });
+
+  it('should query items using QueryBuilder with index', async () => {
+    const results = await userDdb.query({ email: 'alice@example.com' })
+      .usingIndex('EmailIndex')
+      .limitResults(1)
+      .execute();
+    expect(results.length).toEqual(1);
+    results.forEach(result => {
+      expect(result.email).toEqual('alice@example.com');
+    });
+  });
 });

package/test/scan.test.ts

@@ -30,7 +30,7 @@ const UserSchema = z.object({
 
 type User = z.infer<typeof UserSchema>;
 
-const userDdb = new BetterDDB<User>({
+const userDdb = new BetterDDB({
   schema: UserSchema,
   tableName: TEST_TABLE,
   entityName: ENTITY_NAME,
@@ -61,7 +61,7 @@ describe('BetterDDB - Scan Operation', () => {
   it('should scan items using ScanBuilder', async () => {
     const results = await userDdb.scan()
       .where('email', 'begins_with', 'char')
-      .limitResults(10);
+      .limitResults(10).execute();
     expect(results.length).toBeGreaterThanOrEqual(1);
     results.forEach(result => {
       expect(result.email).toMatch(/^char/i);

package/test/update.test.ts

@@ -31,7 +31,7 @@ const UserSchema = z.object({
 
 type User = z.infer<typeof UserSchema>;
 
-const userDdb = new BetterDDB<User>({
+const userDdb = new BetterDDB({
   schema: UserSchema,
   tableName: TEST_TABLE,
   entityName: ENTITY_NAME,

package/test/utils/table-setup.ts

@@ -14,6 +14,15 @@ export const createTestTable = async (tableName: string, keySchema: CreateTableC
       KeySchema: keySchema,
       AttributeDefinitions: attributeDefinitions,
       BillingMode: 'PAY_PER_REQUEST',
+      GlobalSecondaryIndexes: [
+        {
+          IndexName: 'EmailIndex',
+          KeySchema: [{ AttributeName: 'email', KeyType: 'HASH' }],
+          Projection: {
+            ProjectionType: 'ALL',
+          },
+        },
+      ],
     });
   } catch (error: any) {
     if (error.code === 'ResourceInUseException') {