aws-core-utils
Advanced tools
aws-core-utils - npm Package Compare versions
Comparing version 5.0.9 to 5.0.10
@@ -170,9 +170,7 @@ 'use strict'; | ||
| * | ||
| * @param {Object} context - the context to configure | ||
| * @param {AWS.DynamoDB.DocumentClient} [context.dynamoDBDocClient] - the current DynamoDB.DocumentClient instance | ||
| * cached on the context (if any) | ||
| * @param {Object|DynamoDBDocClientAware} context - the context to configure | ||
| * @param {Object|undefined} [dynamoDBDocClientOptions] - the optional DynamoDB.DocumentClient constructor options to | ||
| * use if no cached DynamoDB.DocumentClient instance exists | ||
| * @param {string|undefined} [dynamoDBDocClientOptions.region] - an optional region to use instead of the current region | ||
| * @returns {Object} the given context | ||
| * @returns {DynamoDBDocClientAware} the given context configured with an AWS.DynamoDB.DocumentClient instance to use | ||
| */ | ||
@@ -179,0 +177,0 @@ function configureDynamoDBDocClient(context, dynamoDBDocClientOptions) { |
@@ -164,8 +164,7 @@ 'use strict'; | ||
| * | ||
| * @param {Object} context - the context to configure | ||
| * @param {AWS.Kinesis} [context.kinesis] - the current Kinesis instance cached on the context (if any) | ||
| * @param {Object|KinesisAware} context - the context to configure | ||
| * @param {Object|undefined} [kinesisOptions] - the optional Kinesis constructor options to use if no cached Kinesis | ||
| * instance exists | ||
| * @param {string|undefined} [kinesisOptions.region] - an optional region to use instead of the current region | ||
| * @returns {Object} the given context | ||
| * @returns {KinesisAware} the given context configured with an AWS.Kinesis instance | ||
| */ | ||
@@ -172,0 +171,0 @@ function configureKinesis(context, kinesisOptions) { |
| { | ||
| "name": "aws-core-utils", | ||
| "version": "5.0.9", | ||
| "version": "5.0.10", | ||
| "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", |
@@ -1,2 +0,2 @@ | ||
| # aws-core-utils v5.0.9 | ||
| # aws-core-utils v5.0.10 | ||
@@ -294,2 +294,13 @@ Core utilities for working with Amazon Web Services (AWS), including ARNs, regions, stages, Lambdas, AWS errors, stream events, Kinesis, DynamoDB.DocumentClients, etc. | ||
| ### 5.0.10 | ||
| - Fixed broken unit tests by changing incorrect imports of `node-uuid` to `uuid` | ||
| - Added new `RegionAware`, `KinesisAware` and `DynamoDBDocClientAware` typedefs to `type-defs.js` module | ||
| - Changes to `regions.js` module: | ||
| - Changed the `context` argument and return type of `configureRegion` function to use new `RegionAware` typedef | ||
| - Changes to `kinesis-cache.js` module: | ||
| - Changed the `context` argument and return types of `configureKinesis` function to use new `KinesisAware` typedef | ||
| - Changes to `dynamodb-doc-client-cache.js` module: | ||
| - Changed the `context` argument and return type of `configureDynamoDBDocClient` function to use new | ||
| `DynamoDBDocClientAware` typedef | ||
| ### 5.0.9 | ||
@@ -296,0 +307,0 @@ - Updated `logging-utils` dependency to version 3.0.8 |
@@ -219,7 +219,7 @@ 'use strict'; | ||
| * explicitly true or logs a warning. | ||
| * @param {Object} context - a context on which to set the region | ||
| * @param {Object|RegionAware} context - a context on which to set the region | ||
| * @param {boolean|undefined} [failFast] - an optional flag that is only used when AWS_REGION is needed and blank and | ||
| * that determines whether the error will be raised (if failFast is explicitly true) or simply logged as a warning | ||
| * @throws {Error} if failFast is explicitly true and an AWS_REGION env variable is needed and not available | ||
| * @returns {Object} the context with its existing region or the current AWS_REGION env variable value. | ||
| * @returns {RegionAware} the context with its existing region or the current AWS_REGION env variable value. | ||
| */ | ||
@@ -226,0 +226,0 @@ function configureRegion(context, failFast) { |
@@ -10,3 +10,3 @@ 'use strict'; | ||
| const uuid = require("node-uuid"); | ||
| const uuid = require("uuid"); | ||
@@ -13,0 +13,0 @@ // The test subject |
| { | ||
| "name": "aws-core-utils-tests", | ||
| "description": "Unit tests for aws-core-utils modules", | ||
| "version": "5.0.9", | ||
| "version": "5.0.10", | ||
| "author": "Byron du Preez", | ||
@@ -6,0 +6,0 @@ "license": "Apache-2.0", |
@@ -10,3 +10,3 @@ 'use strict'; | ||
| const uuid = require("node-uuid"); | ||
| const uuid = require("uuid"); | ||
@@ -13,0 +13,0 @@ // The test subject |
@@ -8,3 +8,3 @@ 'use strict'; | ||
| const uuid = require('node-uuid'); | ||
| const uuid = require('uuid'); | ||
| const base64 = require('core-functions/base64'); | ||
@@ -11,0 +11,0 @@ |
| 'use strict'; | ||
| /** | ||
| * @typedef {Object} RegionAware - an object configured with the name of an AWS region to use, which is typically the | ||
| * current AWS region sourced from a Lambda's AWS_REGION environment variable | ||
| * @property {string} region - the name of the AWS region to use | ||
| */ | ||
| /** | ||
| * @typedef {StageHandling} StageAware - an object configured with a stage, stage handling settings and logging functionality | ||
@@ -11,2 +17,12 @@ * @property {string} stage - the configured stage to use | ||
| /** | ||
| * @typedef {Object} KinesisAware - an object configured with an AWS.Kinesis instance | ||
| * @property {AWS.Kinesis} kinesis - an AWS.Kinesis instance to use | ||
| */ | ||
| /** | ||
| * @typedef {Object} DynamoDBDocClientAware - an object configured with an AWS.DynamoDB.DocumentClient instance | ||
| * @property {AWS.DynamoDB.DocumentClient} dynamoDBDocClient - an optional AWS.DynamoDB.DocumentClient instance to use | ||
| */ | ||
| /** | ||
| * @typedef {Logging} StageHandling - an object configured with stage handling settings and logging functionality | ||
@@ -13,0 +29,0 @@ * @property {StageHandlingSettings} stageHandling - the configured stage handling settings to use |
New alerts
License Policy Violation
LicenseThis 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
LicenseThis 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
- increased by0.43%
303529
- Lines of code
- increased by0.23%
4350
- Number of lines in readme file
- increased by2.27%
495