electrodb 1.11.0 → 1.11.1

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "electrodb",
-  "version": "1.11.0",
+  "version": "1.11.1",
   "description": "A library to more easily create and interact with multiple entities and heretical relationships in dynamodb",
   "main": "index.js",
   "scripts": {
-    "test": "npm run test-types && LOCAL_DYNAMO_ENDPOINT=http://localhost:8000 node ./test/init.js && LOCAL_DYNAMO_ENDPOINT=http://localhost:8000 mocha -r ts-node/register ./test/**.spec.*",
-    "test-types": "tsd",
+    "test": "npm run test:types && npm run test:unit",
+    "test:unit": "LOCAL_DYNAMO_ENDPOINT=http://localhost:8000 node ./test/init.js && LOCAL_DYNAMO_ENDPOINT=http://localhost:8000 mocha -r ts-node/register ./test/**.spec.*",
+    "test:types": "tsd",
     "coverage": "nyc npm test && nyc report --reporter=text-lcov | coveralls",
     "coverage-coveralls-local": "nyc npm test && nyc report --reporter=text-lcov | coveralls",
     "coverage-html-local": "nyc npm test && nyc report --reporter=html",

package/src/clauses.js

@@ -1,4 +1,4 @@
-const { QueryTypes, MethodTypes, ItemOperations, ExpressionTypes, TableIndex, TerminalOperation } = require("./types");
+const { QueryTypes, MethodTypes, ItemOperations, ExpressionTypes, TableIndex, TerminalOperation, KeyTypes } = require("./types");
 const {AttributeOperationProxy, UpdateOperations, FilterOperationNames} = require("./operations");
 const {UpdateExpression} = require("./update");
 const {FilterExpression} = require("./where");
@@ -403,7 +403,7 @@ let clauses = {
 					.setType(QueryTypes.is)
 					.setPK(entity._expectFacets(facets, attributes.pk))
 					.ifSK(() => {
-						state.setSK(entity._buildQueryFacets(facets, attributes.sk))
+						state.setSK(entity._buildQueryFacets(facets, attributes.sk));
 					});
 			} catch(err) {
 				state.setError(err);
@@ -635,6 +635,7 @@ class ChainState {
 				data: {},
 			},
 			keys: {
+				provided: [],
 				pk: {},
 				sk: [],
 			},
@@ -676,8 +677,20 @@ class ChainState {
 		return this.query.options;
 	}
 
+	_appendProvided(type, attributes) {
+		const newAttributes = Object.keys(attributes).map(attribute => {
+			return {
+				type,
+				attribute
+			}
+		});
+		return u.getUnique(this.query.keys.provided, newAttributes);
+	}
+
 	setPK(attributes) {
 		this.query.keys.pk = attributes;
+		this.query.keys.provided = this._appendProvided(KeyTypes.pk, attributes);
+
 		return this;
 	}
 
@@ -698,6 +711,7 @@ class ChainState {
 				type: type,
 				facets: attributes
 			});
+			this.query.keys.provided = this._appendProvided(KeyTypes.sk, attributes);
 		}
 		return this;
 	}

package/src/client.js

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

package/src/entity.js

@@ -1478,6 +1478,14 @@ class Entity {
 		let parameters = {};
 		switch (state.query.type) {
 			case QueryTypes.is:
+				parameters = this._makeIsQueryParams(
+					state.query,
+					state.query.index,
+					state.query.filter[ExpressionTypes.FilterExpression],
+					indexKeys.pk,
+					...indexKeys.sk,
+				);
+				break;
 			case QueryTypes.begins:
 				parameters = this._makeBeginsWithQueryParams(
 					state.query.options,
@@ -1551,12 +1559,16 @@ class Entity {
 		return params;
 	}
 
-	_makeBeginsWithQueryParams(options, index, filter, pk, sk) {
+	_makeInclusiveQueryParams(options, index, filter, pk, sk, type) {
 		let keyExpressions = this._queryKeyExpressionAttributeBuilder(index, pk, sk);
 		let KeyConditionExpression = "#pk = :pk";
 
 		if (this.model.lookup.indexHasSortKeys[index] && typeof keyExpressions.ExpressionAttributeValues[":sk1"] === "string" && keyExpressions.ExpressionAttributeValues[":sk1"].length > 0) {
-			KeyConditionExpression = `${KeyConditionExpression} and begins_with(#sk1, :sk1)`;
+			if (type === QueryTypes.is) {
+				KeyConditionExpression = `${KeyConditionExpression} and #sk1 = :sk1`;
+			} else {
+				KeyConditionExpression = `${KeyConditionExpression} and begins_with(#sk1, :sk1)`;
+			}
 		} else {
 			delete keyExpressions.ExpressionAttributeNames["#sk1"];
 			delete keyExpressions.ExpressionAttributeValues[":sk1"];
@@ -1588,6 +1600,35 @@ class Entity {
 		return params;
 	}
 
+	_makeIsQueryParams(query, index, filter, pk, sk) {
+		const { options, keys } = query;
+
+		const providedSks = keys.provided
+			.filter(item => item.type === KeyTypes.sk)
+			.map(item => item.attribute);
+
+		const skDefinition = (this.model.facets.byIndex[index] &&
+			this.model.facets.byIndex[index].sk &&
+			Array.isArray(this.model.facets.byIndex[index].sk) &&
+			this.model.facets.byIndex[index].sk
+		) || [];
+
+		const skCompositeAttributes = new Set(skDefinition);
+		const skIsCompletelyFulfilled = skCompositeAttributes.size === providedSks.length &&
+			skDefinition.every(attr => providedSks.includes(attr));
+
+		if (skIsCompletelyFulfilled) {
+			return this._makeInclusiveQueryParams(options, index, filter, pk, sk, QueryTypes.is);
+		} else {
+			return this._makeBeginsWithQueryParams(options, index, filter, pk, sk);
+		}
+
+	}
+
+	_makeBeginsWithQueryParams(options, index, filter, pk, sk) {
+		return this._makeInclusiveQueryParams(options, index, filter, pk, sk, QueryTypes.begins);
+	}
+
 	_mergeExpressionsAttributes(...expressionAttributes) {
 		let merged = {};
 		for (let obj of expressionAttributes) {

package/src/util.js

@@ -154,7 +154,15 @@ class BatchGetOrderMaintainer {
   }
 }
 
+function getUnique(arr1, arr2) {
+  return Array.from(new Set([
+      ...arr1,
+      ...arr2
+  ]));
+}
+
 module.exports = {
+  getUnique,
   batchItems,
   parseJSONPath,
   getInstanceType,