@izara_project/izara-core-library-dynamodb 1.0.6 → 1.0.8

package/index.js

@@ -18,7 +18,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 'use strict';
 
 // Import the Dynamodb shared library functions
-const dynamodbSharedLib = require('./src/DynamodbSharedLib');
+const dynamodbSharedLib = require('./src/DynamoDBSharedLib');
 
 // Export all the functions
 module.exports = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@izara_project/izara-core-library-dynamodb",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "Connecting with AWS DynamoDB Resource",
   "main": "index.js",
   "scripts": {
@@ -14,18 +14,16 @@
   "license": "AGPL-3.0-or-later",
   "homepage": "https://bitbucket.org/izara-core-libraries/izara-core-library-dynamodb/src/master/README.md",
   "devDependencies": {
-    "jest": "^29.7.0"
+    "jest": "^30.0.5"
   },
   "jest": {
     "testEnvironment": "node"
   },
   "dependencies": {
-    "@aws-sdk/client-dynamodb": "^3.782.0",
-    "@aws-sdk/lib-dynamodb": "^3.782.0",
-    "@aws-sdk/util-dynamodb": "^3.782.0",
-    "@izara_project/izara-core-library-core": "^1.0.18",
-    "@izara_project/izara-core-library-logger": "^1.0.7",
-    "@izara_project/izara-core-library-service-schemas": "^1.0.49",
+    "@aws-sdk/client-dynamodb": "^3.864.0",
+    "@aws-sdk/lib-dynamodb": "^3.864.0",
+    "@aws-sdk/util-dynamodb": "^3.864.0",
+    "@izara_project/izara-core-library-core": "^1.0.20",
     "lodash.clonedeep": "^4.5.0"
   }
 }

package/src/{DynamodbSharedLib.js → DynamoDBSharedLib.js}

@@ -20,10 +20,10 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 const { DynamoDBDocument } = require('@aws-sdk/lib-dynamodb');
 const { DynamoDB } = require('@aws-sdk/client-dynamodb');
 const { marshall, unmarshall } = require('@aws-sdk/util-dynamodb');
+
 const cloneDeep = require('lodash.clonedeep');
 
 // External Izara project imports
-const Logger = require('@izara_project/izara-core-library-logger');
 const NoRetryError = require('@izara_project/izara-core-library-core').NoRetryError;
 // const { getServiceNameWithCache } = require('@izara_project/izara-core-library-service-schemas').serviceConfig;
 
@@ -58,16 +58,6 @@ module.exports.tableName = async (_izContext, tableName, serviceTag = null) => {
     return serviceTag + process.env.iz_stage + tableName;
   }
 }
-// /**
-//  * create table name for external service
-//  * @param {string} tableName  - suffix tablename
-//  *
-//  * @returns {string} full tablename
-//  */
-// module.exports.tableNameExternal = (serviceName, tableName) => {
-//   return serviceName + process.env.iz_stage + tableName;
-// }
-
 
 /**
  * Creates a string set element for use with documentClient
@@ -86,7 +76,7 @@ module.exports.arrayToStringSet = (stringSetArray) => {
     return stringSet
 
   } catch (e) {
-    Logger.error('error arrayToStringSet:', e)
+    console.error('error arrayToStringSet:', e)
     throw (e)
   }
 };
@@ -457,15 +447,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 +486,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') {