add scan support, misc updates

jeremydaly · jeremydaly · commit 9d43fec4ccbb · 2020-04-22T09:49:08.000-04:00
diff --git a/README.md b/README.md
@@ -9,6 +9,61 @@
 
 # DOCUMENTATION IS NOT COMPLETE FOR v0.2
 
+### TODOs:
+
+**QUERY** implementation:
+- [x] Select (ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT)
+- [x] Sync generateQueryParams - how to handle entity projections?
+
+**GET** implemention:
+- [x] Consistent Read
+- [x] Consumed Capacity (INDEXES, TOTAL, NONE)
+- [x] Projections
+- [x] Update tests
+
+**DELETE** implemention:
+- [x] Conditions
+- [x] Consumed Capacity (INDEXES, TOTAL, NONE)
+- [x] Collection Metrics (SIZE, NONE)
+- [x] Return Values (NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW)
+
+**PUT** implemention:
+- [x] Conditions
+- [x] Consumed Capacity (INDEXES, TOTAL, NONE)
+- [x] Collection Metrics (SIZE, NONE)
+- [x] Return Values (NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW)
+- [x] Null values
+
+**UPDATE** implemention:
+- [x] Conditions
+- [x] Consumed Capacity (INDEXES, TOTAL, NONE)
+- [x] Collection Metrics (SIZE, NONE)
+- [x] Return Values (NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW)
+- [x] Null values
+
+**BATCH GET**
+- [ ] Implement interface
+
+**BATCH WRITE**
+- [ ] Implement interface
+
+**SCAN**
+- [x] Specify index
+- [x] Limit
+- [x] Consistent Read
+- [x] Select (ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT)
+- [x] Start Key
+- [x] Consumed Capacity (INDEXES, TOTAL, NONE)
+- [x] Segments
+- [x] Segment
+- [x] Projections
+- [x] Filters
+
+**MISC:**
+- [x] convertEmptyValues (update DocumentClient options)
+- [x] Make `convertEmptyValues` optional - set it to false in your DocumentClient options
+- [ ] Check param merging
+
 ### **NOTE:** This project is in BETA. Please submit [issues/feedback](https://github.com/jeremydaly/dynamodb-toolbox/issues) or feel free to contact me on Twitter [@jeremy_daly](https://twitter.com/jeremy_daly).
 
 The **DynamoDB Toolbox** is a simple set of tools for working with [Amazon DynamoDB](https://aws.amazon.com/dynamodb/) and the [DocumentClient](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/dynamodb-example-document-client.html). It lets you define your data models (with typings and aliases) and map them to your DynamoDB table. You can then **generate parameters** to `put`, `get`, `delete`, and `update` data by passing in a JavaScript object. The DynamoDB Toolbox will map aliases, validate and coerce types, and even write complex `UpdateExpression`s for you. 😉
diff --git a/__tests__/projectionBuilder.unit.test.js b/__tests__/projectionBuilder.unit.test.js
@@ -49,10 +49,10 @@ describe('projectionBuilder',() => {
       { User: ['family','name','roles','test.subpath','friends[1]'] }
     ]
 
-    const result = projectionBuilder(proj, DefaultTable)
+    // Get projection with type
+    const result = projectionBuilder(proj, DefaultTable,null,true)
 
     // console.log(JSON.stringify(result.names,null,2))
-    // console.log(result)
     expect(result.names).toEqual({
       '#proj1': 'pk',
       '#proj2': 'sk',
diff --git a/classes/Entity.js b/classes/Entity.js
@@ -392,6 +392,62 @@ class Entity {
     // Merge defaults
     const data = normalizeData(this.DocumentClient)(schema.attributes,linked,Object.assign({},defaults,item))
 
+    // Extract valid options
+    const {
+      conditions, // ConditionExpression
+      capacity, // ReturnConsumedCapacity (none, total, or indexes)
+      metrics, // ReturnItemCollectionMetrics: (size or none)
+      returnValues, // Return Values (none, all_old, updated_old, all_new, updated_new)
+      ..._args
+    } = options
+
+    // Remove other valid options from options
+    const args = Object.keys(_args).filter(x => !['execute','parse'].includes(x))
+
+    // Error on extraneous arguments
+    if (args.length > 0)
+      error(`Invalid delete options: ${args.join(', ')}`)
+    
+    // Verify metrics
+    if (metrics !== undefined
+      && (typeof metrics !== 'string' || !['NONE','SIZE'].includes(metrics.toUpperCase())))
+      error(`'metrics' must be one of 'NONE' OR 'SIZE'`)
+
+    // Verify capacity
+    if (capacity !== undefined
+      && (typeof capacity !== 'string' || !['NONE','TOTAL','INDEXES'].includes(capacity.toUpperCase())))
+      error(`'capacity' must be one of 'NONE','TOTAL', OR 'INDEXES'`)
+
+    // Verify returnValues
+    if (returnValues !== undefined
+      && (typeof returnValues !== 'string' 
+      || !['NONE', 'ALL_OLD', 'UPDATED_OLD', 'ALL_NEW', 'UPDATED_NEW'].includes(returnValues.toUpperCase())))
+      error(`'returnValues' must be one of 'NONE', 'ALL_OLD', 'UPDATED_OLD', 'ALL_NEW', OR 'UPDATED_NEW'`)
+    
+    let ConditionExpression // init ConditionExpression
+
+    // If conditions
+    if (conditions) {
+      
+      // Parse the conditions
+      const {
+        expression,
+        names,
+        values
+      } = parseConditions(conditions,this.table,this.name)
+
+      if (Object.keys(names).length > 0) {
+
+        // TODO: alias attribute field names        
+        // Add names, values and condition expression
+        ExpressionAttributeNames = Object.assign(ExpressionAttributeNames,names)
+        ExpressionAttributeValues = Object.assign(ExpressionAttributeValues,values)
+        ConditionExpression = expression
+      } // end if names
+      
+    } // end if conditions
+
+
     // Check for required fields
     Object.keys(required).forEach(field =>
       required[field] && !data[field] && error(`'${field}' is a required field`)
@@ -555,7 +611,7 @@ class Entity {
     ).trim()
 
     // Merge attribute values
-    const attr_values = Object.assign(values,ExpressionAttributeValues)
+    ExpressionAttributeValues = Object.assign(values,ExpressionAttributeValues)
 
     // Generate the payload
     const payload = Object.assign(
@@ -566,13 +622,16 @@ class Entity {
         ExpressionAttributeNames: Object.assign(names,ExpressionAttributeNames)
       },
       typeof params === 'object' ? params : {},
-      Object.keys(attr_values).length > 0 ? { ExpressionAttributeValues: attr_values } : {}
+      Object.keys(ExpressionAttributeValues).length > 0 ? { ExpressionAttributeValues } : {},
+      ConditionExpression ? { ConditionExpression } : {}
     ) // end assign
     
     // console.log(payload)
     
     return payload
 
+    // TODO: Check why primary/secondary GSIs are using if_not_exists
+
   } // end updateSync
 
 
@@ -607,6 +666,65 @@ class Entity {
     // Merge defaults
     const data = normalizeData(this.DocumentClient)(schema.attributes,linked,Object.assign({},defaults,item))
 
+    // Extract valid options
+    const {
+      conditions, // ConditionExpression
+      capacity, // ReturnConsumedCapacity (none, total, or indexes)
+      metrics, // ReturnItemCollectionMetrics: (size or none)
+      returnValues, // Return Values (none, all_old, updated_old, all_new, updated_new)
+      ..._args
+    } = options
+
+    // Remove other valid options from options
+    const args = Object.keys(_args).filter(x => !['execute','parse'].includes(x))
+
+    // Error on extraneous arguments
+    if (args.length > 0)
+      error(`Invalid delete options: ${args.join(', ')}`)
+    
+    // Verify metrics
+    if (metrics !== undefined
+      && (typeof metrics !== 'string' || !['NONE','SIZE'].includes(metrics.toUpperCase())))
+      error(`'metrics' must be one of 'NONE' OR 'SIZE'`)
+
+    // Verify capacity
+    if (capacity !== undefined
+      && (typeof capacity !== 'string' || !['NONE','TOTAL','INDEXES'].includes(capacity.toUpperCase())))
+      error(`'capacity' must be one of 'NONE','TOTAL', OR 'INDEXES'`)
+
+    // Verify returnValues
+    // TODO: Check this, conflicts with dynalite
+    if (returnValues !== undefined
+      && (typeof returnValues !== 'string' 
+      || !['NONE', 'ALL_OLD', 'UPDATED_OLD', 'ALL_NEW', 'UPDATED_NEW'].includes(returnValues.toUpperCase())))
+      error(`'returnValues' must be one of 'NONE', 'ALL_OLD', 'UPDATED_OLD', 'ALL_NEW', or 'UPDATED_NEW'`)
+    
+    let ExpressionAttributeNames // init ExpressionAttributeNames
+    let ExpressionAttributeValues // init ExpressionAttributeValues
+    let ConditionExpression // init ConditionExpression
+
+    // If conditions
+    if (conditions) {
+      
+      // Parse the conditions
+      const {
+        expression,
+        names,
+        values
+      } = parseConditions(conditions,this.table,this.name)
+
+      if (Object.keys(names).length > 0) {
+
+        // TODO: alias attribute field names        
+        // Add names, values and condition expression
+        ExpressionAttributeNames = names
+        ExpressionAttributeValues = values
+        ConditionExpression = expression
+      } // end if names
+      
+    } // end if filters
+
+
     // Check for required fields
     Object.keys(required).forEach(field =>
       required[field] !== undefined && !data[field] && error(`'${field}' is a required field`)
@@ -631,6 +749,12 @@ class Entity {
             }) : acc
         },{})
       },
+      ExpressionAttributeNames ? { ExpressionAttributeNames } : null,
+      ExpressionAttributeValues ? { ExpressionAttributeValues } : null,
+      ConditionExpression ? { ConditionExpression } : null,
+      capacity ? { ReturnConsumedCapacity: capacity.toUpperCase() } : null,
+      metrics ? { ReturnItemCollectionMetrics: metrics.toUpperCase() } : null,
+      returnValues ? { ReturnValues: returnValues.toUpperCase() } : null,
       typeof params === 'object' ? params : {}
     )
 
diff --git a/classes/Table.js b/classes/Table.js
