electrodb 3.0.1 → 3.2.0

package/index.d.ts

@@ -2716,23 +2716,23 @@ type GoBatchGetTerminal<
 > = <Options extends GoBatchGetTerminalOptions<keyof ResponseItem>>(
   options?: Options,
 ) => Options extends GoBatchGetTerminalOptions<infer Attr>
-  ? "preserveBatchOrder" extends keyof Options
-    ? Options["preserveBatchOrder"] extends true
-      ? Promise<{
-          data: Array<
-            Resolve<
-              | {
-                  [Name in keyof ResponseItem as Name extends Attr
-                    ? Name
-                    : never]: ResponseItem[Name];
-                }
-              | null
-            >
-          >;
-          unprocessed: Array<
-            Resolve<AllTableIndexCompositeAttributes<A, F, C, S>>
-          >;
-        }>
+    ? "preserveBatchOrder" extends keyof Options
+      ? Options["preserveBatchOrder"] extends true
+        ? Promise<{
+            data: Array<
+              Resolve<
+                | {
+                    [Name in keyof ResponseItem as Name extends Attr
+                      ? Name
+                      : never]: ResponseItem[Name];
+                  }
+                | null
+              >
+            >;
+            unprocessed: Array<
+              Resolve<AllTableIndexCompositeAttributes<A, F, C, S>>
+            >;
+          }>
       : Promise<{
           data: Array<
             Resolve<{
@@ -2758,23 +2758,23 @@ type GoBatchGetTerminal<
         >;
       }>
   : "preserveBatchOrder" extends keyof Options
-  ? Options["preserveBatchOrder"] extends true
-    ? {
-        data: Array<Resolve<ResponseItem | null>>;
-        unprocessed: Array<
-          Resolve<AllTableIndexCompositeAttributes<A, F, C, S>>
-        >;
-      }
-    : {
+    ? Options["preserveBatchOrder"] extends true
+      ? Promise<{
+          data: Array<Resolve<ResponseItem | null>>;
+          unprocessed: Array<
+            Resolve<AllTableIndexCompositeAttributes<A, F, C, S>>
+          >;
+        }>
+      : Promise<{
+          data: Array<Resolve<ResponseItem>>;
+          unprocessed: Array<
+            Resolve<AllTableIndexCompositeAttributes<A, F, C, S>>
+          >;
+        }>
+    : Promise<{
         data: Array<Resolve<ResponseItem>>;
-        unprocessed: Array<
-          Resolve<AllTableIndexCompositeAttributes<A, F, C, S>>
-        >;
-      }
-  : {
-      data: Array<Resolve<ResponseItem>>;
-      unprocessed: Array<Resolve<AllTableIndexCompositeAttributes<A, F, C, S>>>;
-    };
+        unprocessed: Array<Resolve<AllTableIndexCompositeAttributes<A, F, C, S>>>;
+      }>;
 
 type GoGetTerminal<
   A extends string,
@@ -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.1",
+  "version": "3.2.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,9 +2909,7 @@ class Entity {
   _getComparisonOperator(comparison, skType, comparisonType) {
     if (skType === "number") {
       return Comparisons[comparison];
-    } else if (
-      comparisonType === ComparisonTypes.v2
-    ) {
+    } else if (comparisonType === ComparisonTypes.v2) {
       return KeyAttributesComparisons[comparison];
     } else {
       return Comparisons[comparison];
@@ -4267,6 +4276,7 @@ class Entity {
         facets: parsedPKAttributes.attributes,
         isCustom: parsedPKAttributes.isCustom,
         facetLabels: parsedPKAttributes.labels,
+        template: index.pk.template,
       };
       let sk = {};
       let parsedSKAttributes = {};
@@ -4285,6 +4295,7 @@ class Entity {
           facets: parsedSKAttributes.attributes,
           isCustom: parsedSKAttributes.isCustom,
           facetLabels: parsedSKAttributes.labels,
+          template: index.sk.template,
         };
         facets.fields.push(sk.field);
       }
@@ -4400,10 +4411,12 @@ class Entity {
         const definition = Object.values(facets.byField[pk.field]).find(
           (definition) => definition.index !== indexName,
         );
+
         const definitionsMatch = validations.stringArrayMatch(
           pk.facets,
           definition.facets,
         );
+
         if (!definitionsMatch) {
           throw new e.ElectroError(
             e.ErrorCodes.InconsistentIndexDefinition,
@@ -4418,6 +4431,20 @@ class Entity {
             )}'. Key fields must have the same composite attribute definitions across all indexes they are involved with`,
           );
         }
+
+        const keyTemplatesMatch = pk.template === definition.template
+
+        if (!keyTemplatesMatch) {
+          throw new e.ElectroError(
+            e.ErrorCodes.IncompatibleKeyCompositeAttributeTemplate,
+            `Partition Key (pk) on Access Pattern '${u.formatIndexNameForDisplay(
+              accessPattern,
+            )}' is defined with the template ${pk.template || '(undefined)'}, but the accessPattern '${u.formatIndexNameForDisplay(
+              definition.index,
+            )}' defines this field with the key labels ${definition.template || '(undefined)'}'. Key fields must have the same template definitions across all indexes they are involved with`,
+          );
+        }
+
         seenIndexFields[pk.field].push({ accessPattern, type: "pk" });
       } else {
         seenIndexFields[pk.field] = [];
@@ -4438,7 +4465,8 @@ class Entity {
           const isAlsoDefinedAsPK = seenIndexFields[sk.field].find(
             (field) => field.type === "pk",
           );
-          if (isAlsoDefinedAsPK) {
+
+          if (isAlsoDefinedAsPK && !sk.isCustom) {
             throw new e.ElectroError(
               e.ErrorCodes.InconsistentIndexDefinition,
               `The Sort Key (sk) on Access Pattern '${u.formatIndexNameForDisplay(
@@ -4447,16 +4475,19 @@ class Entity {
                 pk.field
               }' which is already referenced by the Access Pattern(s) '${u.formatIndexNameForDisplay(
                 isAlsoDefinedAsPK.accessPattern,
-              )}' as a Partition Key. Fields mapped to Partition Keys cannot be also mapped to Sort Keys.`,
+              )}' as a Partition Key. Fields mapped to Partition Keys cannot be also mapped to Sort Keys unless their format is defined with a 'template'.`,
             );
           }
+
           const definition = Object.values(facets.byField[sk.field]).find(
             (definition) => definition.index !== indexName,
           );
+
           const definitionsMatch = validations.stringArrayMatch(
             sk.facets,
             definition.facets,
-          );
+          )
+
           if (!definitionsMatch) {
             throw new e.ElectroError(
               e.ErrorCodes.DuplicateIndexFields,
@@ -4471,6 +4502,20 @@ class Entity {
               )}'. Key fields must have the same composite attribute definitions across all indexes they are involved with`,
             );
           }
+
+          const keyTemplatesMatch = sk.template === definition.template
+
+          if (!keyTemplatesMatch) {
+            throw new e.ElectroError(
+              e.ErrorCodes.IncompatibleKeyCompositeAttributeTemplate,
+              `Sort Key (sk) on Access Pattern '${u.formatIndexNameForDisplay(
+                accessPattern,
+              )}' is defined with the template ${sk.template || '(undefined)'}, but the accessPattern '${u.formatIndexNameForDisplay(
+                definition.index,
+              )}' defines this field with the key labels ${definition.template || '(undefined)'}'. Key fields must have the same template definitions across all indexes they are involved with`,
+            );
+          }
+
           seenIndexFields[sk.field].push({ accessPattern, type: "sk" });
         } else {
           seenIndexFields[sk.field] = [];

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,

package/src/operations.js

@@ -19,6 +19,7 @@ class ExpressionState {
     this.expression = "";
     this.prefix = prefix || "";
     this.refs = {};
+    this.formattedNameToOriginalNameMap = new Map();
   }
 
   incrementName(name) {
@@ -30,14 +31,28 @@ class ExpressionState {
 
   formatName(name = "") {
     const nameWasNotANumber = isNaN(name);
-    name = `${name}`.replaceAll(/[^\w]/g, "");
-    if (name.length === 0) {
-      name = "p";
-    } else if (nameWasNotANumber !== isNaN(name)) {
+    const originalName = `${name}`;
+    let formattedName = originalName.replaceAll(/[^\w]/g, "");
+
+    if (formattedName.length === 0) {
+      formattedName = "p";
+    } else if (nameWasNotANumber !== isNaN(formattedName)) {
       // name became number due to replace
-      name = `p${name}`;
+      formattedName = `p${formattedName}`;
     }
-    return name;
+
+    const originalFormattedName = formattedName;
+    let nameSuffix = 1;
+
+    while (
+      this.formattedNameToOriginalNameMap.has(formattedName) &&
+      this.formattedNameToOriginalNameMap.get(formattedName) !== originalName
+    ) {
+      formattedName = `${originalFormattedName}_${++nameSuffix}`;
+    }
+
+    this.formattedNameToOriginalNameMap.set(formattedName, originalName);
+    return formattedName;
   }
 
   // todo: make the structure: name, value, paths