electrodb 2.14.3 → 3.0.0

package/src/errors.js

@@ -219,8 +219,8 @@ const ErrorCodes = {
   },
   IncompleteIndexCompositesAttributesProvided: {
     code: 2012,
-    section: 'invalid-index-composite-attributes-provided',
-    name: 'IncompleteIndexCompositesAttributesProvided',
+    section: "invalid-index-composite-attributes-provided",
+    name: "IncompleteIndexCompositesAttributesProvided",
     sym: ErrorCode,
   },
   InvalidAttribute: {

package/src/operations.js

@@ -313,12 +313,15 @@ class AttributeOperationProxy {
           return AttributeOperationProxy.pathProxy(() => {
             const { commit, root, target, builder } = build();
             const attribute = target.getChild(prop);
-            const nestedAny = attribute.type === AttributeTypes.any &&
-                // if the name doesn't match that's because we are nested under 'any'
-                attribute.name !== prop;
+            const nestedAny =
+              attribute.type === AttributeTypes.any &&
+              // if the name doesn't match that's because we are nested under 'any'
+              attribute.name !== prop;
             let field;
             if (attribute === undefined) {
-              throw new Error(`Invalid attribute "${prop}" at path "${target.path}.${prop}"`);
+              throw new Error(
+                `Invalid attribute "${prop}" at path "${target.path}.${prop}"`,
+              );
             } else if (nestedAny) {
               field = prop;
             } else {

package/src/schema.js

@@ -8,6 +8,7 @@ const {
   PathTypes,
   TableIndex,
   ItemOperations,
+  DataOptions,
 } = require("./types");
 const AttributeTypeNames = Object.keys(AttributeTypes);
 const ValidFacetTypes = [
@@ -466,26 +467,18 @@ class Attribute {
     if (typeof definition === "function") {
       return (val) => {
         try {
-          let reason = definition(val);
-          const isValid = !reason;
-          if (isValid) {
-            return [isValid, []];
-          } else if (typeof reason === "boolean") {
-            return [
-              isValid,
-              [
-                new e.ElectroUserValidationError(
-                  this.path,
-                  "Invalid value provided",
-                ),
-              ],
-            ];
-          } else {
-            return [
-              isValid,
-              [new e.ElectroUserValidationError(this.path, reason)],
-            ];
-          }
+          let isValid = !!definition(val);
+          return [
+            isValid,
+            isValid
+              ? []
+              : [
+                  new e.ElectroUserValidationError(
+                    this.path,
+                    "Invalid value provided",
+                  ),
+                ],
+          ];
         } catch (err) {
           return [false, [new e.ElectroUserValidationError(this.path, err)]];
         }
@@ -1687,14 +1680,13 @@ class Schema {
   }
 
   translateFromFields(item = {}, options = {}) {
-    let { includeKeys } = options;
     let data = {};
     let names = this.translationForRetrieval;
     for (let [attr, value] of Object.entries(item)) {
       let name = names[attr];
       if (name) {
         data[name] = value;
-      } else if (includeKeys) {
+      } else if (options.data === DataOptions.includeKeys) {
         data[attr] = value;
       }
     }

package/src/service.js

@@ -9,11 +9,11 @@ const {
   TransactionMethods,
   KeyCasing,
   ServiceVersions,
-  Pager,
   ElectroInstance,
   ElectroInstanceTypes,
   ModelVersions,
   IndexTypes,
+  DataOptions,
 } = require("./types");
 const { FilterFactory } = require("./filters");
 const { FilterOperations } = require("./operations");
@@ -345,7 +345,7 @@ class Service {
   }
 
   cleanseRetrievedData(index = TableIndex, entities, data = {}, config = {}) {
-    if (config.raw) {
+    if (config.data === DataOptions.raw) {
       return data;
     }
     const identifiers = getEntityIdentifiers(entities);
@@ -462,7 +462,7 @@ class Service {
     let options = {
       // expressions, // DynamoDB doesnt return what I expect it would when provided with these entity filters
       parse: (options, data) => {
-        if (options.raw) {
+        if (options.data === DataOptions.raw) {
           return data;
         }
         return this.cleanseRetrievedData(index, entities, data, options);
@@ -634,11 +634,11 @@ 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`,
+        `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`,
       );
     }
 

package/src/transaction.js

@@ -1,4 +1,4 @@
-const { TableIndex, TransactionMethods } = require("./types");
+const { TableIndex, TransactionMethods, DataOptions } = require("./types");
 const { getEntityIdentifiers, matchToEntityAlias } = require("./entity");
 
 function cleanseCanceledData(
@@ -7,7 +7,7 @@ function cleanseCanceledData(
   data = {},
   config = {},
 ) {
-  if (config.raw) {
+  if (config.data === DataOptions.raw) {
     return data;
   }
   const identifiers = getEntityIdentifiers(entities);
@@ -52,7 +52,7 @@ function cleanseTransactionData(
   data = {},
   config = {},
 ) {
-  if (config.raw) {
+  if (config.data === DataOptions.raw) {
     return data;
   }
   const identifiers = getEntityIdentifiers(entities);
@@ -139,7 +139,7 @@ function createTransaction(options) {
       const response = await driver.go(method, params, {
         ...options,
         parse: (options, data) => {
-          if (options.raw) {
+          if (options.data === DataOptions.raw) {
             return data;
           } else if (data.canceled) {
             canceled = true;

package/src/types.js

@@ -3,11 +3,23 @@ const KeyTypes = {
   sk: "sk",
 };
 
+const DataOptions = {
+  raw: "raw",
+  includeKeys: "includeKeys",
+  attributes: "attributes",
+};
+
 const BatchWriteTypes = {
   batch: "batch",
   concurrent: "concurrent",
 };
 
+const ComparisonTypes = {
+  keys: "keys",
+  attributes: "attributes",
+  v2: "v2",
+};
+
 const QueryTypes = {
   and: "and",
   gte: "gte",
@@ -86,7 +98,7 @@ const Comparisons = {
   gt: ">",
 };
 
-const PartialComparisons = {
+const KeyAttributesComparisons = {
   lt: "<",
   gte: ">=",
 
@@ -332,6 +344,7 @@ module.exports = {
   ValueTypes,
   TableIndex,
   MethodTypes,
+  DataOptions,
   Comparisons,
   BuilderTypes,
   ReturnValues,
@@ -341,6 +354,7 @@ module.exports = {
   AttributeTypes,
   EntityVersions,
   CastKeyOptions,
+  ComparisonTypes,
   ServiceVersions,
   ExpressionTypes,
   ElectroInstance,
@@ -348,13 +362,13 @@ module.exports = {
   UnprocessedTypes,
   AttributeWildCard,
   TerminalOperation,
-  PartialComparisons,
   FormatToReturnValues,
   AttributeProxySymbol,
   ElectroInstanceTypes,
   MethodTypeTranslation,
   EventSubscriptionTypes,
   DynamoDBAttributeTypes,
+  KeyAttributesComparisons,
   AttributeMutationMethods,
   AllPages,
   ResultOrderOption,
@@ -363,4 +377,5 @@ module.exports = {
   TransactionOperations,
   TransactionMethods,
   UpsertOperations,
+  BatchWriteTypes,
 };

package/src/validations.js

@@ -122,7 +122,7 @@ const Index = {
         scope: {
           type: "string",
           required: false,
-        }
+        },
       },
     },
     sk: {
@@ -178,7 +178,7 @@ const Index = {
       type: "any",
       required: false,
       format: "isFunction",
-    }
+    },
   },
 };
 

package/src/where.js

@@ -27,7 +27,8 @@ class FilterExpression extends ExpressionState {
     return !expression.replace(/\n|\r|\w/g, "").trim();
   }
 
-  add(newExpression) {
+  add(newExpression, filterOptions = {}) {
+    const asPrefix = !!filterOptions.asPrefix;
     let expression = "";
     let existingExpression = this.expression;
     if (
@@ -39,13 +40,19 @@ class FilterExpression extends ExpressionState {
       if (isEmpty) {
         return existingExpression;
       }
-      let existingNeedsParens =
+
+      if (
+        !asPrefix &&
         !existingExpression.startsWith("(") &&
-        !existingExpression.endsWith(")");
-      if (existingNeedsParens) {
+        !existingExpression.endsWith(")")
+      ) {
         existingExpression = `(${existingExpression})`;
       }
-      expression = `${existingExpression} AND ${newExpression}`;
+      if (asPrefix) {
+        expression = `(${newExpression}) AND ${existingExpression}`;
+      } else {
+        expression = `${existingExpression} AND ${newExpression}`;
+      }
     } else {
       expression = this._trim(newExpression);
     }
@@ -53,7 +60,7 @@ class FilterExpression extends ExpressionState {
   }
 
   // applies operations without verifying them against known attributes. Used internally for key conditions.
-  unsafeSet(operation, name, ...values) {
+  unsafeSet(filterOptions, operation, name, ...values) {
     const { template } = FilterOperations[operation] || {};
     if (template === undefined) {
       throw new Error(
@@ -68,7 +75,7 @@ class FilterExpression extends ExpressionState {
       names.prop,
       ...valueExpressions,
     );
-    this.add(condition);
+    this.add(condition, filterOptions);
   }
 
   build() {