betterddb 0.4.7 → 0.4.8

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

@@ -2,17 +2,11 @@ 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.

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

@@ -10,17 +10,6 @@ class BatchGetBuilder {
     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.
@@ -35,10 +24,6 @@ class BatchGetBuilder {
             RequestItems: {
                 [tableName]: {
                     Keys: keysArray,
-                    ...(this.projectionExpression && {
-                        ProjectionExpression: this.projectionExpression,
-                        ExpressionAttributeNames: this.expressionAttributeNames,
-                    }),
                 },
             },
         };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "betterddb",
-  "version": "0.4.7",
+  "version": "0.4.8",
   "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/builders/batch-get-builder.ts

@@ -3,26 +3,12 @@ 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.
@@ -37,10 +23,6 @@ export class BatchGetBuilder<T> {
       RequestItems: {
         [tableName]: {
           Keys: keysArray,
-          ...(this.projectionExpression && {
-            ProjectionExpression: this.projectionExpression,
-            ExpressionAttributeNames: this.expressionAttributeNames,
-          }),
         },
       },
     };

package/test/batch-get.test.ts

@@ -0,0 +1,63 @@
+import { z } from 'zod';
+import { BetterDDB } from '../src/betterddb';
+import { createTestTable, deleteTestTable } from './utils/table-setup';
+import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb';
+import { DynamoDB } from '@aws-sdk/client-dynamodb';
+import { KeySchemaElement, AttributeDefinition } from '@aws-sdk/client-dynamodb';
+const TEST_TABLE = "batch-get-test-table";
+const ENDPOINT = 'http://localhost:4566';
+const REGION = 'us-east-1';
+const ENTITY_NAME = 'USER';
+const PRIMARY_KEY = 'id';
+const PRIMARY_KEY_TYPE = 'S';
+const SORT_KEY = 'email';
+const SORT_KEY_TYPE = 'S';
+const KEY_SCHEMA = [{ AttributeName: PRIMARY_KEY, KeyType: 'HASH' }, { AttributeName: SORT_KEY, KeyType: 'RANGE' }] as KeySchemaElement[];
+const ATTRIBUTE_DEFINITIONS = [{ AttributeName: PRIMARY_KEY, AttributeType: PRIMARY_KEY_TYPE }, { AttributeName: SORT_KEY, AttributeType: SORT_KEY_TYPE }] as AttributeDefinition[];
+const client = DynamoDBDocumentClient.from(new DynamoDB({
+  region: REGION,
+  endpoint: ENDPOINT,
+}));
+
+
+const UserSchema = z.object({
+  id: z.string(),
+  name: z.string(),
+  email: z.string().email(),
+  createdAt: z.string(),
+  updatedAt: z.string(),
+});
+
+type User = z.infer<typeof UserSchema>;
+
+const userDdb = new BetterDDB({
+  schema: UserSchema,
+  tableName: TEST_TABLE,
+  entityName: ENTITY_NAME,
+  keys: {
+    primary: { name: PRIMARY_KEY, definition: { build: (raw) => raw.id! } },
+    sort: { name: SORT_KEY, definition: { build: (raw) => raw.email! } },
+  },
+  client,
+  autoTimestamps: true,
+});
+
+beforeAll(async () => {
+  await createTestTable(TEST_TABLE, KEY_SCHEMA, ATTRIBUTE_DEFINITIONS);
+  await userDdb.create({ id: 'user-123', name: 'John Doe', email: 'john@example.com' } as any).execute();
+  await userDdb.create({ id: 'user-124', name: 'John Doe', email: 'john@example.com' } as any).execute();
+  await userDdb.create({ id: 'user-125', name: 'Bob Doe', email: 'bob@example.com' } as any).execute();
+});
+
+afterAll(async () => {
+  await deleteTestTable(TEST_TABLE);
+});
+
+describe('BetterDDB - Get Operation', () => {
+  it('should retrieve an item using GetBuilder', async () => {
+    const users = await userDdb.batchGet([{ id: 'user-123', email: 'john@example.com' }, { id: 'user-124', email: 'john@example.com' }]).execute();
+    expect(users.length).toEqual(2);
+    expect(users[0].id).toBe('user-123');
+    expect(users[1].id).toBe('user-124');
+  });
+});