electrodb 2.1.0 → 2.1.2

package/README.md

@@ -3401,7 +3401,7 @@ await StoreLocations
         o.add(a.tenant, newTenant);       // electrodb "set"    -> dynamodb "set"
         o.add(a.rent, 100);               // electrodb "number" -> dynamodb "number"
         o.subtract(a.deposit, 200);       // electrodb "number" -> dynamodb "number"
-        o.remove(a.leaseEndDate);         // electrodb "string" -> dynamodb "string"
+        o.remove(attr.discount);          // electrodb "number" -> dynamodb "number"
         o.append(a.rentalAgreement, [{    // electrodb "list"   -> dynamodb "list"
             type: "ammendment",           // electrodb "map"    -> dynamodb "map"
             detail: "no soup for you"
@@ -3425,40 +3425,49 @@ Response Format:
 Equivalent DocClient Parameters:
 ```json
 {
-  "UpdateExpression": "SET #category = :category_u0, #rent = #rent + :rent_u0, #deposit = #deposit - :deposit_u0, #rentalAgreement = list_append(#rentalAgreement, :rentalAgreement_u0), #totalFees = #totalFees + #petFee REMOVE #leaseEndDate, #gsi2sk ADD #tenant :tenant_u0, #leaseHolders :tenant_u0 DELETE #tags :tags_u0, #contact :contact_u0",
-  "ExpressionAttributeNames": {
-  "#category": "category",
-    "#tenant": "tenant",
-    "#rent": "rent",
-    "#deposit": "deposit",
-    "#leaseEndDate": "leaseEndDate",
-    "#rentalAgreement": "rentalAgreement",
-    "#tags": "tags",
-    "#contact": "contact",
-    "#totalFees": "totalFees",
-    "#petFee": "petFee",
-    "#leaseHolders": "leaseHolders",
-    "#gsi2sk": "gsi2sk"
-  },
-  "ExpressionAttributeValues": {
-    ":category0": "food/coffee",
-    ":category_u0": "food/meal",
-    ":tenant_u0": ["larry"],
-    ":rent_u0": 100,
-    ":deposit_u0": 200,
-    ":rentalAgreement_u0": [{
-      "type": "amendment",
-      "detail": "no soup for you"
-    }],
-    ":tags_u0": ["coffee"], // <- DynamoDB Set
-    ":contact_u0": ["555-345-2222"], // <- DynamoDB Set 
+    "UpdateExpression": "SET #category = :category_u0, #deposit = #deposit - :deposit_u0, #rentalAgreement = list_append(#rentalAgreement, :rentalAgreement_u0), #totalFees = #totalFees + #petFee, #cityId = :cityId_u0, #mallId = :mallId_u0, #buildingId = :buildingId_u0, #storeId = :storeId_u0, #__edb_e__ = :__edb_e___u0, #__edb_v__ = :__edb_v___u0 REMOVE #discount ADD #tenant :tenant_u0, #rent :rent_u0, #leaseHolders :tenant_u0 DELETE #tags :tags_u0, #contact :contact_u0",
+    "ExpressionAttributeNames": {
+        "#category": "category",
+        "#tenant": "tenant",
+        "#rent": "rent",
+        "#deposit": "deposit",
+        "#discount": "discount",
+        "#rentalAgreement": "rentalAgreement",
+        "#tags": "tags",
+        "#contact": "contact",
+        "#totalFees": "totalFees",
+        "#petFee": "petFee",
+        "#leaseHolders": "leaseHolders",
+        "#buildingId": "buildingId",
+        "#cityId": "cityId",
+        "#mallId": "mallId",
+        "#storeId": "storeId",
+        "#__edb_e__": "__edb_e__", "#__edb_v__": "__edb_v__",
     },
-  "TableName": "electro",
-  "Key": {
-    "pk": `$mallstoredirectory#cityid_12345#mallid_eastpointe`,
-    "sk": "$mallstore_1#buildingid_a34#storeid_lattelarrys"
-  },
-  "ConditionExpression": "#category = :category0"
+    "ExpressionAttributeValues": {
+        ":buildingId_u0": "A34",
+        ":cityId_u0": "portland",
+        ":category0": "food/coffee",
+        ":category_u0": "food/meal",
+        ":tenant_u0": ["larry"],
+        ":rent_u0": 100,
+        ":deposit_u0": 200,
+        ":rentalAgreement_u0": [{
+            "type": "amendment",
+            "detail": "no soup for you"
+        }],
+        ":tags_u0": ["coffee"],
+        ":contact_u0": ["555-345-2222"],
+        ":mallId_u0": "EastPointe",
+        ":storeId_u0": "LatteLarrys",
+        ":__edb_e___u0": "MallStore", ":__edb_v___u0": "1",
+    },
+    "TableName": "electro",
+    "Key": {
+        "pk": "$mallstoredirectory#cityid_portland#mallid_eastpointe",
+        "sk": "$mallstore_1#buildingid_a34#storeid_lattelarrys"
+    },
+    "ConditionExpression": "#category = :category0"
 }
 ```
 

package/index.d.ts

@@ -698,7 +698,7 @@ export type BatchWriteGo<ResponseType> = <O extends BulkOptions>(options?: O) =>
 
 export type ParamRecord<Options = ParamOptions> = <P>(options?: Options) => P;
 
-export interface ElectroError extends Error {
+export class ElectroError extends Error {
     readonly name: 'ElectroError';
     readonly code: number;
     readonly date: number;
@@ -733,7 +733,7 @@ export interface ElectroValidationErrorFieldReference<T extends Error = Error> {
     readonly cause: T | undefined;
 }
 
-export interface ElectroValidationError<T extends Error = Error> extends ElectroError {
+export class ElectroValidationError<T extends Error = Error> extends ElectroError {
     readonly fields: ReadonlyArray<ElectroValidationErrorFieldReference<T>>;
 }
 

package/index.js

@@ -1,5 +1,12 @@
 const { Entity } = require("./src/entity");
 const { Service } = require("./src/service");
 const { createCustomAttribute } = require('./src/schema');
+const { ElectroError, ElectroValidationError, ElectroUserValidationError, ElectroAttributeValidationError } = require('./src/errors');
 
-module.exports = { Entity, Service, createCustomAttribute };
+module.exports = {
+    Entity,
+    Service,
+    createCustomAttribute,
+    ElectroError,
+    ElectroValidationError,
+};

package/package.json

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

package/src/clauses.js

@@ -277,6 +277,11 @@ let clauses = {
 			}
 			try {
 				state.query.updateProxy.invokeCallback(cb);
+				for (const path of Object.keys(state.query.update.refs)) {
+					const operation = state.query.update.impacted[path];
+					const attribute = state.query.update.refs[path];
+					entity.model.schema.checkOperation(attribute, operation);
+				}
 				return state;
 			} catch(err) {
 				state.setError(err);

package/src/entity.js

@@ -624,7 +624,7 @@ class Entity {
 
 			if (config._isPagination || response.LastEvaluatedKey) {
 				const nextPage = this._formatReturnPager(config, response.LastEvaluatedKey);
-				return { cursor: nextPage ?? null, data: results };
+				return { cursor: nextPage || null, data: results };
 			}
 
 			return { data: results };
@@ -652,19 +652,19 @@ class Entity {
 	}
 
 	_formatReturnPager(config, lastEvaluatedKey) {
-		let page = lastEvaluatedKey ?? null;
+		let page = lastEvaluatedKey || null;
 		if (config.raw || config.pager === Pager.raw) {
 			return page;
 		}
-		return config.formatCursor.serialize(page) ?? null;
+		return config.formatCursor.serialize(page) || null;
 	}
 
 	_formatExclusiveStartKey(config) {
 		let exclusiveStartKey = config.cursor;
 		if (config.raw || config.pager === Pager.raw) {
-			return exclusiveStartKey ?? null;
+			return exclusiveStartKey || null;
 		}
-		return config.formatCursor.deserialize(exclusiveStartKey) ?? null;
+		return config.formatCursor.deserialize(exclusiveStartKey) || null;
 	}
 
 	_getTableName() {
@@ -1972,7 +1972,7 @@ class Entity {
 	_buildQueryFacets(facets, skFacets) {
 		let queryFacets = this._findProperties(facets, skFacets).reduce(
 			(result, [name, value]) => {
-				if (value) {
+				if (value !== undefined) {
 					result[name] = value;
 				}
 				return result;

package/src/operations.js

@@ -256,6 +256,7 @@ class ExpressionState {
         this.impacted = {};
         this.expression = "";
         this.prefix = prefix || "";
+        this.refs = {};
     }
 
     incrementName(name) {
@@ -316,8 +317,9 @@ class ExpressionState {
         return this.expression;
     }
 
-    setImpacted(operation, path) {
+    setImpacted(operation, path, ref) {
         this.impacted[path] = operation;
+        this.refs[path] = ref;
     }
 }
 
@@ -407,7 +409,7 @@ class AttributeOperationProxy {
                             }
 
                             const formatted = template(options, target, paths.expression, ...attributeValues);
-                            builder.setImpacted(operation, paths.json);
+                            builder.setImpacted(operation, paths.json, target);
                             if (canNest) {
                                 seen.add(paths.expression);
                                 seen.add(formatted);

package/src/schema.js

@@ -1361,6 +1361,16 @@ class Schema {
 		return record;
 	}
 
+	checkOperation(attribute, operation) {
+		if (!attribute) {
+			throw new e.ElectroAttributeValidationError(path, `Attribute "${path}" does not exist on model.`);
+		} else if (attribute.required && operation === 'remove') {
+			throw new e.ElectroAttributeValidationError(attribute.path, `Attribute "${attribute.path}" is Required and cannot be removed`);
+		} else if (attribute.readOnly) {
+			throw new e.ElectroAttributeValidationError(attribute.path, `Attribute "${attribute.path}" is Read-Only and cannot be updated`);
+		}
+	}
+
 	checkRemove(paths = []) {
 		for (const path of paths) {
 			const attribute = this.traverser.getPath(path);