@izara_project/izara-core-library-dynamodb 1.0.5 → 1.0.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@izara_project/izara-core-library-dynamodb",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "description": "Connecting with AWS DynamoDB Resource",
   "main": "index.js",
   "scripts": {

package/src/DynamodbSharedLib.js

@@ -457,15 +457,17 @@ module.exports.query = async (_izContext, tableName, partitionKeyValue, queryEle
       throw new NoRetryError('partitionKeyValue should be "object" type.')
     }
 
+    let attributeReservedNames = ['partitionKeyValue', 'betweenStartValue', 'betweenEndValue'];
+
     // ------------ set payload ---------------
     let payload = {
       TableName: tableName, // require
       // KeyConditionExpression: '',
-      KeyConditionExpression: `${Object.keys(partitionKeyValue)[0]} = :${Object.keys(partitionKeyValue)[0]}`, // require partition key
+      KeyConditionExpression: `${Object.keys(partitionKeyValue)[0]} = :partitionKeyValue`, // require partition key
       ExpressionAttributeValues: {},  // require  value of partition key
       ReturnConsumedCapacity: "TOTAL" // NONE(default) | TOTAL | INDEXES
     }
-    payload.ExpressionAttributeValues[`:${Object.keys(partitionKeyValue)[0]}`] = partitionKeyValue[Object.keys(partitionKeyValue)[0]]
+    payload.ExpressionAttributeValues[`:partitionKeyValue`] = partitionKeyValue[Object.keys(partitionKeyValue)[0]]
 
     // ---- sortKeyCondition ----
     /* NOTE: KeyConditionExpression
@@ -494,20 +496,26 @@ module.exports.query = async (_izContext, tableName, partitionKeyValue, queryEle
         payload.KeyConditionExpression += ' AND '
 
         if (queryElements.sortKeyCondition.comparison == 'between') {
-          // validate between sidehand, should have both side and value is number
-          if (!queryElements.sortKeyCondition.hasOwnProperty('betweenStartValue') || !queryElements.sortKeyCondition.hasOwnProperty('betweenEndValue')
-            || typeof queryElements.sortKeyCondition.betweenStartValue !== 'number' || typeof queryElements.sortKeyCondition.betweenEndValue !== 'number'
-          ) {
-            throw new NoRetryError('sortKeyCondition should set both side-hand betweenStartValue/end and value should be number')
-          }
+          // can compare both numeric and stringfs in Dynamo, but the typoe sent must match the type store in Dynamo
+          // in future maybe check type from objectSchema to make sure they match
+          // if (!queryElements.sortKeyCondition.hasOwnProperty('betweenStartValue') || !queryElements.sortKeyCondition.hasOwnProperty('betweenEndValue')
+          //   || typeof queryElements.sortKeyCondition.betweenStartValue !== 'number' || typeof queryElements.sortKeyCondition.betweenEndValue !== 'number'
+          // ) {
+          //   throw new NoRetryError('sortKeyCondition should set both side-hand betweenStartValue/end and value should be number')
+          // }
           // sortKeyName BETWEEN :sortkeyval1 AND :sortkeyval2
-          payload.KeyConditionExpression += `${queryElements.sortKeyCondition.name} BETWEEN :${queryElements.sortKeyCondition.betweenStartValue} AND :${queryElements.sortKeyCondition.betweenEndValue}`
-          payload.ExpressionAttributeValues[`:${queryElements.sortKeyCondition.betweenStartValue}`] = queryElements.sortKeyCondition.betweenStartValue
-          payload.ExpressionAttributeValues[`:${queryElements.sortKeyCondition.betweenEndValue}`] = queryElements.sortKeyCondition.betweenEndValue
+          payload.KeyConditionExpression += `${queryElements.sortKeyCondition.name} BETWEEN :betweenStartValue AND :betweenEndValue`
+          payload.ExpressionAttributeValues[`:betweenStartValue`] = queryElements.sortKeyCondition.betweenStartValue
+          payload.ExpressionAttributeValues[`:betweenEndValue`] = queryElements.sortKeyCondition.betweenEndValue
 
 
         } else { // others comparisons eg. < > <> = , has one side-hand
 
+          // check does not use attributeReservedNames
+          if (attributeReservedNames.includes(queryElements.sortKeyCondition.name)) {
+            throw new NoRetryError(`sortKeyCondition.name cannot be a attributeReservedName (${queryElements.sortKeyCondition.name})`);
+          };
+
           let subKeyConditionalExpression = null
           if (queryElements.sortKeyCondition.comparison == 'begins_with') { // begins_with ( sortKeyName, :sortkeyval ) ***CANNOT USE WITH NUMBER TYPE
             if (typeof queryElements.sortKeyCondition.value !== 'string') {
@@ -768,7 +776,7 @@ module.exports.putItem = async (
 
         // for (let idx = 0; idx < attributes.length; idx++) { // for loop more performance than for of
         for (let idx = 0, len = attributes.length; idx < len; idx++) {
-          if (attributes[idx].action !== 'REMOVE' && attributes[idx].value === undefined) {
+          if (attributes[idx].action.toUpperCase() !== 'REMOVE' && attributes[idx].value === undefined) {
             continue;
           }
 
@@ -925,7 +933,7 @@ module.exports.updateItem = async (_izContext, tableName, keyValues, attributes,
 
         // ====== for loop to check each element
         for (let idx = 0, len = attributes.length; idx < len; idx++) {
-          if (attributes[idx].action !== 'REMOVE' && (attributes[idx].value === undefined)) continue;
+          if (attributes[idx].action.toUpperCase() !== 'REMOVE' && (attributes[idx].value === undefined)) continue;
 
           // change action string to upperCase
           attributes[idx].action = attributes[idx].action.toUpperCase()