aws-core-utils - npm Package Compare versions

Comparing version 7.0.0 to 7.0.1

contexts.js

@@ -106,6 +106,6 @@ 'use strict';
  * stages#configureStageHandling} for details).
- * @param {StageHandling|EventAWSContextAndStageAware} context - the context to configure
+ * @param {StandardContext|StageHandling} context - the context to configure
  * @param {AWSEvent} event - the AWS event, which was passed to your lambda
  * @param {AWSContext} awsContext - the AWS context, which was passed to your lambda
- * @return {EventAWSContextAndStageAware} the given context configured with the given AWS event, AWS context & resolved stage
+ * @return {StandardContext|EventAWSContextAndStageAware} the given context configured with the given AWS event, AWS context & resolved stage
  * @throws {Error} if the resolved stage is blank
@@ -112,0 +112,0 @@ */

package.json

 {
   "name": "aws-core-utils",
-  "version": "7.0.0",
+  "version": "7.0.1",
   "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 v7.0.0
+# aws-core-utils v7.0.1
 
@@ -3,0 +3,0 @@ Core utilities for working with Amazon Web Services (AWS), including ARNs, regions, stages, Lambdas, AWS errors, stream events, Kinesis, DynamoDB.DocumentClients, etc.

release_notes.md

 ## Changes
 
+### 7.0.1
+- Minor patches to type definitions in `type-defs` module & to JsDoc comments in `contexts` module
+
 ### 7.0.0
@@ -4,0 +7,0 @@ - Changes to `type-defs` module:

type-defs.js

@@ -27,12 +27,13 @@ 'use strict';
 /**
- * @typedef {StageHandling} StandardContext - an object configured as a standard context with stage handling, logging,
+ * @typedef {StageHandling|EventAWSContextAndStageAware} StandardContext - an object configured as a standard context with stage handling, logging,
  * custom settings, an optional Kinesis instance and an optional DynamoDB DocumentClient instance and OPTIONALLY also
  * with the current region, the resolved stage and the AWS context
- * @property {CustomSettings|undefined} custom - an object configured with optional custom settings to use
+ * @property {CustomSettings|undefined} [custom] - an object configured with optional custom settings to use
  * @property {AWS.Kinesis|undefined} [kinesis] - an optional AWS.Kinesis instance to use
  * @property {AWS.DynamoDB.DocumentClient|undefined} [dynamoDBDocClient] - an optional AWS.DynamoDB.DocumentClient instance to use
  * @property {string|undefined} [region] - the name of the AWS region to use
- * @property {string|undefined} [stage] - the configured stage to use
+ * @property {string|undefined} [stage] - the resolved or configured stage to use
  * @property {AWSEvent|undefined} [event] - the AWS event passed to your Lambda function on invocation
  * @property {AWSContext|undefined} [awsContext] - the AWS context passed to your Lambda function on invocation
+ * @property {LambdaFunctionNameVersionAndAlias|undefined} [invokedLambda] - the name, version & alias of the invoked Lambda function
  */
@@ -95,12 +96,6 @@
  * @property {AWSContext} awsContext - the AWS context passed to your Lambda function on invocation
- * @property {LambdaFunctionNameVersionAndAlias|undefined} [invokedLambda] - the name, version & alias of the invoked Lambda function
+ * @property {LambdaFunctionNameVersionAndAlias|undefined} invokedLambda - the name, version & alias of the invoked Lambda function
  */
 
 /**
- * @typedef {EventAWSContextAndStageAware} RegionStageAWSContextAware - an object configured with the name of the current AWS region,
- * the AWS context and the resolved stage, which implies pre-configured stage handling settings and logging functionality
- * @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
@@ -557,5 +552,5 @@ * @property {string} stage - the configured stage to use
 /**
- * @typedef {StandardContext} ListEventSourceMappingsResult - the result returned by a call to AWS.Lambda listEventSourceMappings
+ * @typedef {Object} ListEventSourceMappingsResult - the result returned by a call to AWS.Lambda listEventSourceMappings
  * @property {string} NextMarker
  * @property {EventSourceMapping[]} EventSourceMappings
  */

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

Worsened metrics

Total package byte prevSize

553192

decreased by-0.01%

Lines of code

8112

decreased by-0.05%

No dependency changes