betterddb 0.5.4 → 0.6.0

package/lib/betterddb.d.ts

@@ -63,7 +63,7 @@ export interface KeysConfig<T> {
 export interface BetterDDBOptions<T> {
     schema: z.ZodType<T, z.ZodTypeDef, any>;
     tableName: string;
-    entityType: string;
+    entityType?: string;
     keys: KeysConfig<T>;
     client: DynamoDBDocumentClient;
     /**
@@ -81,7 +81,7 @@ export interface BetterDDBOptions<T> {
 export declare class BetterDDB<T> {
     protected schema: z.ZodType<T, z.ZodTypeDef, any>;
     protected tableName: string;
-    protected entityType: string;
+    protected entityType?: string;
     protected client: DynamoDBDocumentClient;
     protected keys: KeysConfig<T>;
     protected timestamps: boolean;
@@ -91,7 +91,7 @@ export declare class BetterDDB<T> {
     getClient(): DynamoDBDocumentClient;
     getSchema(): z.ZodType<T, z.ZodTypeDef, any>;
     getTimestamps(): boolean;
-    getEntityType(): string;
+    getEntityType(): string | undefined;
     protected getKeyValue(def: KeyDefinition<T>, rawKey: Partial<T>): string;
     /**
      * Build the primary key from a raw key object.

package/lib/betterddb.js

@@ -13,13 +13,13 @@ const batch_get_builder_1 = require("./builders/batch-get-builder");
  */
 class BetterDDB {
     constructor(options) {
-        var _a;
+        var _a, _b;
         this.schema = options.schema;
         this.tableName = options.tableName;
-        this.entityType = options.entityType.toUpperCase();
+        this.entityType = (_a = options.entityType) === null || _a === void 0 ? void 0 : _a.toUpperCase();
         this.keys = options.keys;
         this.client = options.client;
-        this.timestamps = (_a = options.timestamps) !== null && _a !== void 0 ? _a : false;
+        this.timestamps = (_b = options.timestamps) !== null && _b !== void 0 ? _b : false;
     }
     getKeys() {
         return this.keys;

package/lib/builders/query-builder.js

@@ -140,9 +140,11 @@ class QueryBuilder {
             ExclusiveStartKey: this.lastKey,
             IndexName: (_b = (_a = this.index) === null || _a === void 0 ? void 0 : _a.name) !== null && _b !== void 0 ? _b : undefined,
         };
-        this.filterConditions.push(`#entity = :entity_value`);
-        this.expressionAttributeNames['#entity'] = 'entityType';
-        this.expressionAttributeValues[':entity_value'] = this.parent.getEntityType();
+        if (this.parent.getEntityType()) {
+            this.filterConditions.push(`#entity = :entity_value`);
+            this.expressionAttributeNames['#entity'] = 'entityType';
+            this.expressionAttributeValues[':entity_value'] = this.parent.getEntityType();
+        }
         params.FilterExpression = this.filterConditions.join(' AND ');
         const result = await this.parent.getClient().send(new lib_dynamodb_1.QueryCommand(params));
         return { items: this.parent.getSchema().array().parse(result.Items), lastKey: (_c = result.LastEvaluatedKey) !== null && _c !== void 0 ? _c : undefined };

package/lib/builders/scan-builder.js

@@ -57,9 +57,12 @@ class ScanBuilder {
             Limit: this.limit,
             ExclusiveStartKey: this.lastKey
         };
-        if (this.filters.length > 0) {
-            params.FilterExpression = this.filters.join(' AND ');
+        if (this.parent.getEntityType()) {
+            this.filters.push(`#entity = :entity_value`);
+            this.expressionAttributeNames['#entity'] = 'entityType';
+            this.expressionAttributeValues[':entity_value'] = this.parent.getEntityType();
         }
+        params.FilterExpression = this.filters.join(' AND ');
         const result = await this.parent.getClient().send(new lib_dynamodb_1.ScanCommand(params));
         return { items: this.parent.getSchema().array().parse(result.Items), lastKey: (_a = result.LastEvaluatedKey) !== null && _a !== void 0 ? _a : undefined };
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "betterddb",
-  "version": "0.5.4",
+  "version": "0.6.0",
   "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

@@ -1,4 +1,4 @@
-import { z, ZodSchema } from 'zod';
+import { z } from 'zod';
 import { QueryBuilder } from './builders/query-builder';
 import { ScanBuilder } from './builders/scan-builder';
 import { UpdateBuilder } from './builders/update-builder';
@@ -72,7 +72,7 @@ export interface KeysConfig<T> {
 export interface BetterDDBOptions<T> {
   schema: z.ZodType<T, z.ZodTypeDef, any>;
   tableName: string;
-  entityType: string;
+  entityType?: string;
   keys: KeysConfig<T>;
   client: DynamoDBDocumentClient;
   /**
@@ -91,7 +91,7 @@ export interface BetterDDBOptions<T> {
 export class BetterDDB<T> {
   protected schema: z.ZodType<T, z.ZodTypeDef, any>;
   protected tableName: string;
-  protected entityType: string;
+  protected entityType?: string;
   protected client: DynamoDBDocumentClient;
   protected keys: KeysConfig<T>;
   protected timestamps: boolean;
@@ -99,7 +99,7 @@ export class BetterDDB<T> {
   constructor(options: BetterDDBOptions<T>) {
     this.schema = options.schema;
     this.tableName = options.tableName;
-    this.entityType = options.entityType.toUpperCase();
+    this.entityType = options.entityType?.toUpperCase();
     this.keys = options.keys;
     this.client = options.client;
     this.timestamps = options.timestamps ?? false;
@@ -126,7 +126,7 @@ export class BetterDDB<T> {
     return this.timestamps;
   }
 
-  public getEntityType(): string {
+  public getEntityType(): string | undefined {
     return this.entityType;
   }
 

package/src/builders/query-builder.ts

@@ -163,9 +163,11 @@ export class QueryBuilder<T> {
       IndexName: this.index?.name ?? undefined,
     };
 
-    this.filterConditions.push(`#entity = :entity_value`);
-    this.expressionAttributeNames['#entity'] = 'entityType';
-    this.expressionAttributeValues[':entity_value'] = this.parent.getEntityType();
+    if (this.parent.getEntityType()) {
+      this.filterConditions.push(`#entity = :entity_value`);
+      this.expressionAttributeNames['#entity'] = 'entityType';
+      this.expressionAttributeValues[':entity_value'] = this.parent.getEntityType();
+    }
     params.FilterExpression = this.filterConditions.join(' AND ');
 
     const result = await this.parent.getClient().send(new QueryCommand(params));

package/src/builders/scan-builder.ts

@@ -69,9 +69,12 @@ export class ScanBuilder<T> {
       ExclusiveStartKey: this.lastKey
     };
 
-    if (this.filters.length > 0) {
-      params.FilterExpression = this.filters.join(' AND ');
+    if (this.parent.getEntityType()) {
+      this.filters.push(`#entity = :entity_value`);
+      this.expressionAttributeNames['#entity'] = 'entityType';
+      this.expressionAttributeValues[':entity_value'] = this.parent.getEntityType();
     }
+    params.FilterExpression = this.filters.join(' AND ');
 
     const result = await this.parent.getClient().send(new ScanCommand(params));