electrodb 2.10.6 → 2.11.0

package/index.d.ts

@@ -3655,6 +3655,7 @@ export interface Schema<A extends string, F extends string, C extends string> {
     [accessPattern: string]: {
       readonly project?: "keys_only";
       readonly index?: string;
+      readonly scope?: string;
       readonly type?: "clustered" | "isolated";
       readonly collection?: AccessPatternCollection<C>;
       readonly pk: {

package/package.json

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

package/src/client.js

@@ -1,5 +1,5 @@
-const lib = require("@aws-sdk/lib-dynamodb");
-const util = require("@aws-sdk/lib-dynamodb/dist-cjs/commands/utils");
+const lib = require('@aws-sdk/lib-dynamodb')
+const util = require('@aws-sdk/lib-dynamodb/dist-cjs/commands/utils')
 const { isFunction } = require("./validations");
 const { ElectroError, ErrorCodes } = require("./errors");
 const DocumentClientVersions = {

package/src/entity.js

@@ -494,7 +494,7 @@ class Entity {
   async go(method, parameters = {}, config = {}) {
     let stackTrace;
     if (!config.originalErr) {
-      stackTrace = new e.ElectroError(e.ErrorCodes.AWSError).stack;
+      stackTrace = new e.ElectroError(e.ErrorCodes.AWSError);
     }
     try {
       switch (method) {
@@ -513,13 +513,9 @@ class Entity {
         return Promise.reject(err);
       } else {
         if (err.__isAWSError) {
-          const error = new e.ElectroError(
-            e.ErrorCodes.AWSError,
-            `Error thrown by DynamoDB client: "${err.message}"`,
-            err,
-          );
-          error.stack = stackTrace;
-          return Promise.reject(error);
+          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;
+          return Promise.reject(stackTrace);
         } else if (err.isElectroError) {
           return Promise.reject(err);
         } else {
@@ -926,7 +922,7 @@ class Entity {
   formatResponse(response, index, config = {}) {
     let stackTrace;
     if (!config.originalErr) {
-      stackTrace = new e.ElectroError(e.ErrorCodes.AWSError).stack;
+      stackTrace = new e.ElectroError(e.ErrorCodes.AWSError);
     }
     try {
       let results = {};
@@ -1021,14 +1017,9 @@ class Entity {
       ) {
         throw err;
       } else {
-        const error = new e.ElectroError(
-          e.ErrorCodes.AWSError,
-          err.message,
-          err,
-        );
-        error.stack = stackTrace;
-
-        throw error;
+        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;
+        throw stackTrace;
       }
     }
   }
@@ -3231,6 +3222,9 @@ class Entity {
 
     // If keys are not custom, set the prefixes
     if (!keys.pk.isCustom) {
+      if (tableIndex.scope) {
+        pk = `${pk}_${tableIndex.scope}`;
+      }
       keys.pk.prefix = u.formatKeyCasing(pk, tableIndex.pk.casing);
     }
 
@@ -3851,6 +3845,7 @@ class Entity {
       let indexName = index.index || TableIndex;
       let indexType =
         typeof index.type === "string" ? index.type : IndexTypes.isolated;
+      let indexScope = index.scope || "";
       if (indexType === "clustered") {
         clusteredIndexes.add(accessPattern);
       }
@@ -3949,14 +3944,15 @@ class Entity {
         }
       }
 
-      let definition = {
+      let definition= {
         pk,
         sk,
-        collection,
         hasSk,
+        collection,
         customFacets,
-        index: indexName,
         type: indexType,
+        index: indexName,
+        scope: indexScope,
       };
 
       indexHasSubCollections[indexName] =

package/src/service.js

@@ -584,6 +584,7 @@ class Service {
     let pkFieldMatch = definition.pk.field === providedIndex.pk.field;
     let pkFacetLengthMatch =
       definition.pk.facets.length === providedIndex.pk.facets.length;
+    let scopeMatch = definition.scope === providedIndex.scope;
     let mismatchedFacetLabels = [];
     let collectionDifferences = [];
     let definitionIndexName = u.formatIndexNameForDisplay(definition.index);
@@ -631,6 +632,16 @@ class Service {
       }
     }
 
+    if (!scopeMatch) {
+      collectionDifferences.push(
+          `The index scope value provided "${
+              providedIndex.scope || "undefined"
+          }" does not match established index scope value "${
+              definition.scope || "undefined"
+          }" on index "${providedIndexName}". Index scope options must match across all entities participating in a collection`,
+      );
+    }
+
     if (!isCustomMatchPK) {
       collectionDifferences.push(
         `The usage of key templates the partition key on index ${definitionIndexName} must be consistent across all Entities, some entities provided use template while others do not`,

package/src/validations.js

@@ -119,6 +119,10 @@ const Index = {
           enum: ["string", "number"],
           required: false,
         },
+        scope: {
+          type: "string",
+          required: false,
+        }
       },
     },
     sk: {