electrodb 3.0.0 → 3.1.0

package/index.d.ts

@@ -2935,9 +2935,10 @@ export class ElectroError<E extends Error = Error> extends Error {
   readonly name: "ElectroError";
   readonly code: number;
   readonly date: number;
-  readonly isElectroError: boolean;
   readonly cause: E | undefined;
-  ref: {
+  readonly isElectroError: boolean;
+  readonly params: <T = Record<string, unknown>>() => T | null;
+  readonly ref: {
     readonly code: number;
     readonly section: string;
     readonly name: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "electrodb",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "A library to more easily create and interact with multiple entities and heretical relationships in dynamodb",
   "main": "index.js",
   "scripts": {

package/src/entity.js

@@ -466,8 +466,10 @@ class Entity {
         if (err.__isAWSError) {
           stackTrace.message = `Error thrown by DynamoDB client: "${err.message}" - For more detail on this error reference: https://electrodb.dev/en/reference/errors/#aws-error`;
           stackTrace.cause = err;
+          e.applyParamsFn(stackTrace, err.__edb_params);
           return Promise.reject(stackTrace);
         } else if (err.isElectroError) {
+          e.applyParamsFn(err, err.__edb_params);
           return Promise.reject(err);
         } else {
           stackTrace.message = new e.ElectroError(
@@ -475,6 +477,7 @@ class Entity {
             err.message,
             err,
           ).message;
+          e.applyParamsFn(stackTrace, err.__edb_params);
           return Promise.reject(stackTrace);
         }
       }
@@ -516,6 +519,10 @@ class Entity {
       .catch((err) => {
         notifyQuery();
         notifyResults(err, false);
+        Object.defineProperty(err, '__edb_params', {
+          enumerable: false,
+          value: params,
+        });
         err.__isAWSError = true;
         throw err;
       });
@@ -935,7 +942,7 @@ class Entity {
               response.Item,
               config,
             );
-            if (Object.keys(results).length === 0) {
+            if (Object.keys(results).length === 0 && !config._objectOnEmpty) {
               results = null;
             }
           } else if (!config._objectOnEmpty) {
@@ -957,7 +964,7 @@ class Entity {
                 item,
                 config,
               );
-              if (Object.keys(record).length > 0) {
+              if (Object.keys(record).length > 0 || config._objectOnEmpty) {
                 results.push(record);
               }
             }
@@ -967,7 +974,7 @@ class Entity {
             response.Attributes,
             config,
           );
-          if (Object.keys(results).length === 0) {
+          if (Object.keys(results).length === 0 && !config._objectOnEmpty) {
             results = null;
           }
         } else if (config._objectOnEmpty) {
@@ -1646,6 +1653,7 @@ class Entity {
       order: undefined,
       hydrate: false,
       hydrator: (_entity, _indexName, items) => items,
+      _objectOnEmpty: false,
       _includeOnResponseItem: {},
     };
 
@@ -1727,6 +1735,9 @@ class Entity {
 
       if (Array.isArray(option.attributes)) {
         config.attributes = config.attributes.concat(option.attributes);
+        if (config.attributes.length > 0) {
+          config._objectOnEmpty = true;
+        }
       }
 
       if (option.preserveBatchOrder === true) {
@@ -2898,10 +2909,7 @@ class Entity {
   _getComparisonOperator(comparison, skType, comparisonType) {
     if (skType === "number") {
       return Comparisons[comparison];
-    } else if (
-      comparisonType === ComparisonTypes.attributes ||
-      comparisonType === ComparisonTypes.v2
-    ) {
+    } else if (comparisonType === ComparisonTypes.v2) {
       return KeyAttributesComparisons[comparison];
     } else {
       return Comparisons[comparison];

package/src/errors.js

@@ -280,7 +280,7 @@ function makeMessage(message, section) {
 }
 
 class ElectroError extends Error {
-  constructor(code, message, cause) {
+  constructor(code, message, cause, params = null) {
     super(message, { cause });
     let detail = ErrorCodes.UnknownError;
     if (code && code.sym === ErrorCode) {
@@ -298,9 +298,21 @@ class ElectroError extends Error {
     this.code = detail.code;
     this.date = Date.now();
     this.isElectroError = true;
+    applyParamsFn(this, params);
   }
 }
 
+function applyParamsFn(error, params = null) {
+  Object.defineProperty(error, 'params', {
+    enumerable: false,
+    writable: true,
+    configurable: true,
+    value: () => {
+      return params;
+    }
+  });
+}
+
 class ElectroValidationError extends ElectroError {
   constructor(errors = []) {
     const fields = [];
@@ -389,6 +401,7 @@ class ElectroAttributeValidationError extends ElectroError {
 module.exports = {
   ErrorCodes,
   ElectroError,
+  applyParamsFn,
   ElectroValidationError,
   ElectroUserValidationError,
   ElectroAttributeValidationError,