aws-core-utils - npm Package Compare versions

Comparing version 5.0.17 to 5.0.18

api-lambdas.js

@@ -0,0 +0,0 @@ 'use strict';

arns.js

@@ -0,0 +0,0 @@ 'use strict';

contexts.js

@@ -0,0 +0,0 @@ 'use strict';

dynamodb-doc-client-cache.js

@@ -0,0 +0,0 @@ 'use strict';

dynamodb-utils.js

@@ -0,0 +0,0 @@ 'use strict';

kinesis-cache.js

@@ -0,0 +0,0 @@ 'use strict';

package.json

 {
   "name": "aws-core-utils",
-  "version": "5.0.17",
+  "version": "5.0.18",
   "description": "Core utilities for working with Amazon Web Services (AWS), including ARNs, regions, stages, Lambdas, AWS errors, stream events, Kinesis, DynamoDB.DocumentClients, etc.",
@@ -5,0 +5,0 @@ "author": "Byron du Preez",

README.md

@@ -1,2 +0,2 @@
-# aws-core-utils v5.0.17
+# aws-core-utils v5.0.18
 
@@ -18,2 +18,4 @@ Core utilities for working with Amazon Web Services (AWS), including ARNs, regions, stages, Lambdas, AWS errors, stream events, Kinesis, DynamoDB.DocumentClients, etc.
     - A module-scope cache of AWS.DynamoDB.DocumentClient instances by region for Lambda.
+- dynamodb-doc-client-utils.js
+    - Utilities for working with AWS DynamoDB.DocumentClient.
 - dynamodb-utils.js
@@ -392,2 +394,7 @@ - Utilities for working with AWS DynamoDB.
 
+### 5.0.18
+- Back-ported add of new `dynamodb-doc-client-utils` module
+- Back-ported changes to `type-defs` module:
+   - Added `DynamoDBGetItemOpts`, `DynamoDBGetItemResult`, `DynamoDBQueryOpts`, `DynamoDBQueryResult` & `ConsumedCapacity` type definitions
+
 ### 5.0.17
@@ -394,0 +401,0 @@ - Fixed critical module-scope defects in `generateHandlerFunction` function in `api-lambdas` module

regions.js

@@ -0,0 +0,0 @@ 'use strict';

stages-options.json

@@ -0,0 +0,0 @@ {

stages.js

@@ -0,0 +0,0 @@ 'use strict';

stream-events.js

@@ -0,0 +0,0 @@ 'use strict';

test/api-lambdas.test.js

@@ -0,0 +0,0 @@ 'use strict';

test/arns.test.js

@@ -0,0 +0,0 @@ 'use strict';

test/contexts.test.js

@@ -0,0 +0,0 @@ 'use strict';

test/dynamodb-doc-client-cache.test.js

@@ -0,0 +0,0 @@ 'use strict';

test/dynamodb-utils.test.js

@@ -0,0 +0,0 @@ 'use strict';

test/kinesis-cache.test.js

@@ -0,0 +0,0 @@ 'use strict';

test/lambdas.test.js

@@ -0,0 +0,0 @@ 'use strict';

test/package.json

 {
   "name": "aws-core-utils-tests",
   "description": "Unit tests for aws-core-utils modules",
-  "version": "5.0.17",
+  "version": "5.0.18",
   "author": "Byron du Preez",
@@ -14,2 +14,3 @@ "license": "Apache-2.0",
   "devDependencies": {
+    "aws-core-test-utils": "1.0.0",
     "tape": "^4.6.3",
@@ -16,0 +17,0 @@ "uuid": "^3.0.1"

test/regions.test.js

@@ -0,0 +0,0 @@ 'use strict';

test/sample-standard-options.json

@@ -0,0 +0,0 @@ {

test/samples.js

@@ -0,0 +0,0 @@ 'use strict';

test/stream-events.test.js

@@ -0,0 +0,0 @@ 'use strict';

type-defs.js

@@ -189,1 +189,45 @@ 'use strict';
 
+// Back-ported type definitions
+
+/**
+ * @typedef {Object} DynamoDBGetOpts - a selection of DynamoDB.DocumentClient `get` method param options to use (other than TableName & Key & legacy parameters)
+ * @property {boolean|undefined} [ConsistentRead] - whether to do a consistent read to obtain a strongly consistent result or not (NB: GSIs ONLY support eventually consistent reads)
+ * @property {string|undefined} [ProjectionExpression] - an optional string that identifies one or more attributes to retrieve from the table
+ * @property {Object|undefined} [ExpressionAttributeNames] - optional one or more substitution tokens for attribute names in an expression
+ * @property {'NONE'|'INDEXES'|'TOTAL'|undefined} [ReturnConsumedCapacity] - determines the level of detail about provisioned throughput consumption that is returned in the response
+ */
+
+/**
+ * @typedef {Object} DynamoDBQueryOpts - a selection of DynamoDB Query options to use (other than TableName, [IndexName], KeyConditionExpression, ProjectionExpression, FilterExpression, ExpressionAttributeNames, ExpressionAttributeValues & legacy parameters)
+ * @property {Object|undefined} [ExclusiveStartKey] - the optional exclusive start key from which to continue a previous query
+ * @property {number|undefined} [Limit] - the optional number of results to which to limit the query
+ * @property {boolean|undefined} [ConsistentRead] - whether to do a consistent read to obtain a strongly consistent result or not (NB: GSIs ONLY support eventually consistent reads)
+ * @property {boolean|undefined} [ReturnConsumedCapacity] - whether to return consumed capacity or not
+ * @property {boolean|undefined} [ScanIndexForward] - use this to get results in forward or reverse order, by sort key
+ * @property {'ALL_ATTRIBUTES'|'ALL_PROJECTED_ATTRIBUTES'|'SPECIFIC_ATTRIBUTES'|'COUNT'|undefined} [Select] - the selected type of result(s) to return
+ * @property {string|undefined} [ProjectionExpression] - an optional string that identifies one or more attributes to retrieve from the table
+ * @property {string|undefined} [FilterExpression] - an optional string that contains conditions that DynamoDB applies after the Query operation, but before the data is returned
+ * @property {Object|undefined} [ExpressionAttributeNames] - optional one or more substitution tokens for attribute names in an expression
+ * @property {Object|undefined} [ExpressionAttributeValues] - optional one or more substitution tokens for attribute names in an expression
+ */
+
+/**
+ * @typedef {Object} DynamoDBGetResult.<I> - a DynamoDB.DocumentClient `get` result (or DynamoDB `getItem` result)
+ * @property {I|undefined} [Item] - the returned item (if found) or undefined (if not)
+ * @property {ConsumedCapacity|undefined} [ConsumedCapacity] - the capacity units consumed by the get operation (if requested)
+ * @template I - the type of item returned in the `Item` property of the `get` result
+ */
+
+/**
+ * @typedef {Object} DynamoDBQueryResult.<I> - a DynamoDB.DocumentClient `query` result (or DynamoDB `query` result)
+ * @property {Array.<I>} Items - the returned items
+ * @property {number} Count - the number of items returned
+ * @property {number} ScannedCount - the number of items scanned before applying any filter
+ * @property {Object|undefined} [LastEvaluatedKey] - the last evaluated key (if any) to be used to get next "page"
+ * @property {ConsumedCapacity|undefined} [ConsumedCapacity] - the capacity units consumed by the query operation (if requested)
+ * @template I - the type of items returned in the `Items` property of the `query` result
+ */
+
+/**
+ * @typedef {Object} ConsumedCapacity - the capacity units consumed by an operation
+ */

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

375215

increased by1.45%

Number of package files

33

increased by10%

Lines of code

5578

increased by3.93%

Number of lines in readme file

640

increased by1.11%

Worsened metrics

Number of low supply chain risk alerts

72

increased by5.88%

No dependency changes