@aws-lambda-powertools/commons - npm Package Compare versions

Comparing version 1.4.1 to 1.5.0

lib/samples/resources/contexts/hello-world.js

@@ -11,4 +11,4 @@ "use strict";
     logStreamName: '2021/03/09/[$LATEST]abcdef123456abcdef123456abcdef123456',
-    invokedFunctionArn: 'arn:aws:lambda:eu-west-1:123456789012:function:Example',
-    awsRequestId: 'c6af9ac6-7b61-11e6-9a41-93e8deadbeef',
+    invokedFunctionArn: 'arn:aws:lambda:eu-west-1:123456789012:function:foo-bar-function',
+    awsRequestId: 'c6af9ac6-7b61-11e6-9a41-93e812345678',
     getRemainingTimeInMillis: () => 1234,
@@ -20,2 +20,2 @@ done: () => console.log('Done!'),
 exports.helloworldContext = helloworldContext;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaGVsbG8td29ybGQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvc2FtcGxlcy9yZXNvdXJjZXMvY29udGV4dHMvaGVsbG8td29ybGQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBRUEsTUFBTSxpQkFBaUIsR0FBWTtJQUNqQyw4QkFBOEIsRUFBRSxJQUFJO0lBQ3BDLGVBQWUsRUFBRSxTQUFTO0lBQzFCLFlBQVksRUFBRSxrQkFBa0I7SUFDaEMsZUFBZSxFQUFFLEtBQUs7SUFDdEIsWUFBWSxFQUFFLDJDQUEyQztJQUN6RCxhQUFhLEVBQUUsMERBQTBEO0lBQ3pFLGtCQUFrQixFQUFFLHdEQUF3RDtJQUM1RSxZQUFZLEVBQUUsc0NBQXNDO0lBQ3BELHdCQUF3QixFQUFFLEdBQUcsRUFBRSxDQUFDLElBQUk7SUFDcEMsSUFBSSxFQUFFLEdBQUcsRUFBRSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsT0FBTyxDQUFDO0lBQ2hDLElBQUksRUFBRSxHQUFHLEVBQUUsQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLFNBQVMsQ0FBQztJQUNsQyxPQUFPLEVBQUUsR0FBRyxFQUFFLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxZQUFZLENBQUM7Q0FDekMsQ0FBQztBQUdBLDhDQUFpQiJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaGVsbG8td29ybGQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvc2FtcGxlcy9yZXNvdXJjZXMvY29udGV4dHMvaGVsbG8td29ybGQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBRUEsTUFBTSxpQkFBaUIsR0FBWTtJQUNqQyw4QkFBOEIsRUFBRSxJQUFJO0lBQ3BDLGVBQWUsRUFBRSxTQUFTO0lBQzFCLFlBQVksRUFBRSxrQkFBa0I7SUFDaEMsZUFBZSxFQUFFLEtBQUs7SUFDdEIsWUFBWSxFQUFFLDJDQUEyQztJQUN6RCxhQUFhLEVBQUUsMERBQTBEO0lBQ3pFLGtCQUFrQixFQUFFLGlFQUFpRTtJQUNyRixZQUFZLEVBQUUsc0NBQXNDO0lBQ3BELHdCQUF3QixFQUFFLEdBQUcsRUFBRSxDQUFDLElBQUk7SUFDcEMsSUFBSSxFQUFFLEdBQUcsRUFBRSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsT0FBTyxDQUFDO0lBQ2hDLElBQUksRUFBRSxHQUFHLEVBQUUsQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLFNBQVMsQ0FBQztJQUNsQyxPQUFPLEVBQUUsR0FBRyxFQUFFLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxZQUFZLENBQUM7Q0FDekMsQ0FBQztBQUdBLDhDQUFpQiJ9

lib/Utility.d.ts

@@ -60,5 +60,14 @@ /**
     private coldStart;
+    private readonly defaultServiceName;
     getColdStart(): boolean;
     isColdStart(): boolean;
+    protected getDefaultServiceName(): string;
+    /**
+   * Validate that the service name provided is valid.
+   * Used internally during initialization.
+   *
+   * @param serviceName - Service name to validate
+   */
+    protected isValidServiceName(serviceName?: string): boolean;
 }
 //# sourceMappingURL=Utility.d.ts.map

lib/Utility.js

@@ -64,2 +64,3 @@ "use strict";
         this.coldStart = true;
+        this.defaultServiceName = 'service_undefined';
     }
@@ -76,4 +77,16 @@ getColdStart() {
     }
+    getDefaultServiceName() {
+        return this.defaultServiceName;
+    }
+    /**
+   * Validate that the service name provided is valid.
+   * Used internally during initialization.
+   *
+   * @param serviceName - Service name to validate
+   */
+    isValidServiceName(serviceName) {
+        return typeof serviceName === 'string' && serviceName.trim().length > 0;
+    }
 }
 exports.Utility = Utility;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiVXRpbGl0eS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9VdGlsaXR5LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQXdERztBQUNILE1BQWEsT0FBTztJQUFwQjtRQUVVLGNBQVMsR0FBWSxJQUFJLENBQUM7SUFnQnBDLENBQUM7SUFkUSxZQUFZO1FBQ2pCLElBQUksSUFBSSxDQUFDLFNBQVMsRUFBRTtZQUNsQixJQUFJLENBQUMsU0FBUyxHQUFHLEtBQUssQ0FBQztZQUV2QixPQUFPLElBQUksQ0FBQztTQUNiO1FBRUQsT0FBTyxLQUFLLENBQUM7SUFDZixDQUFDO0lBRU0sV0FBVztRQUNoQixPQUFPLElBQUksQ0FBQyxZQUFZLEVBQUUsQ0FBQztJQUM3QixDQUFDO0NBRUY7QUFsQkQsMEJBa0JDIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiVXRpbGl0eS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9VdGlsaXR5LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQXdERztBQUNILE1BQWEsT0FBTztJQUFwQjtRQUNVLGNBQVMsR0FBWSxJQUFJLENBQUM7UUFDakIsdUJBQWtCLEdBQVcsbUJBQW1CLENBQUM7SUE2QnBFLENBQUM7SUEzQlEsWUFBWTtRQUNqQixJQUFJLElBQUksQ0FBQyxTQUFTLEVBQUU7WUFDbEIsSUFBSSxDQUFDLFNBQVMsR0FBRyxLQUFLLENBQUM7WUFFdkIsT0FBTyxJQUFJLENBQUM7U0FDYjtRQUVELE9BQU8sS0FBSyxDQUFDO0lBQ2YsQ0FBQztJQUVNLFdBQVc7UUFDaEIsT0FBTyxJQUFJLENBQUMsWUFBWSxFQUFFLENBQUM7SUFDN0IsQ0FBQztJQUVTLHFCQUFxQjtRQUM3QixPQUFPLElBQUksQ0FBQyxrQkFBa0IsQ0FBQztJQUNqQyxDQUFDO0lBRUQ7Ozs7O0tBS0M7SUFDUyxrQkFBa0IsQ0FBQyxXQUFvQjtRQUMvQyxPQUFPLE9BQU8sV0FBVyxLQUFLLFFBQVEsSUFBSSxXQUFXLENBQUMsSUFBSSxFQUFFLENBQUMsTUFBTSxHQUFHLENBQUMsQ0FBQztJQUMxRSxDQUFDO0NBQ0Y7QUEvQkQsMEJBK0JDIn0=

package.json

 {
   "name": "@aws-lambda-powertools/commons",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "description": "A shared utility package for AWS Lambda Powertools for TypeScript libraries",
@@ -48,3 +48,3 @@ "author": {
   ],
-  "gitHead": "103a3a19ee0a2089738864ce2a93df1c2eb44791"
+  "gitHead": "3da04d7ee3a38cf3da3553a9b94fc63eb54eac31"
 }

README.md

@@ -1,9 +0,25 @@
-# AWS Lambda Powertools for TypeScript
+# AWS Lambda Powertools for TypeScript <!-- omit in toc -->
 
-A suite of TypeScript utilities for AWS Lambda functions to ease adopting best practices such as tracing, structured logging, custom metrics, and more. (AWS Lambda Powertools for [Python](https://github.com/awslabs/aws-lambda-powertools-python) and AWS Lambda Powertools for [Java](https://github.com/awslabs/aws-lambda-powertools-java) are also available).
+A suite of utilities for AWS Lambda functions to ease the adoption of best practices such as tracing, structured logging, custom metrics, and more.
 
-**[📜 Documentation](https://awslabs.github.io/aws-lambda-powertools-typescript/)** | **[NPM](https://www.npmjs.com/org/aws-lambda-powertools)** | **[Roadmap](https://github.com/awslabs/aws-lambda-powertools-roadmap/projects/1)** | **[Examples](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/examples)**
+You can use the library in both TypeScript and JavaScript code bases.
 
-> **An AWS Developer Acceleration (DevAx) initiative by Specialist Solution Architects | [e-mail]**
+> Also available in [Python](https://github.com/awslabs/aws-lambda-powertools-python), [Java](https://github.com/awslabs/aws-lambda-powertools-java), and [.NET](https://awslabs.github.io/aws-lambda-powertools-dotnet/).
 
+**[Documentation](https://awslabs.github.io/aws-lambda-powertools-typescript/)** | **[npm](https://www.npmjs.com/org/aws-lambda-powertools)** | **[Roadmap](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/roadmap)** | **[Examples](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/examples)**
+
+## Table of contents <!--- omit in toc -->
+
+- [Table of contents](#table-of-contents)
+- [Features](#features)
+- [Getting started](#getting-started)
+  - [Installation](#installation)
+  - [Examples](#examples)
+  - [Serverless TypeScript Demo application](#serverless-typescript-demo-application)
+- [Contribute](#contribute)
+- [Roadmap](#roadmap)
+- [Connect](#connect)
+- [Credits](#credits)
+- [License](#license)
+
 ## Features
@@ -21,5 +37,14 @@
 
-The AWS Lambda Powertools for TypeScript utilities follow a modular approach, similar to the official [AWS SDK v3 for JavaScript](https://github.com/aws/aws-sdk-js-v3).
-Each TypeScript utility is installed as standalone NPM package.
+The AWS Lambda Powertools for TypeScript utilities follow a modular approach, similar to the official [AWS SDK v3 for JavaScript](https://github.com/aws/aws-sdk-js-v3).  
 
+Each TypeScript utility is installed as standalone npm package.
+
+Install all three core utilities at once with this single command:
+
+```shell
+npm install @aws-lambda-powertools/logger @aws-lambda-powertools/tracer @aws-lambda-powertools/metrics
+```
+
+Or refer to the installation guide of each utility:
+
 👉 [Installation guide for the **Tracer** utility](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/tracer#getting-started)
@@ -36,6 +61,16 @@
 
-## Credits
+### Serverless TypeScript Demo application
 
-* Credits for the Lambda Powertools idea go to [DAZN](https://github.com/getndazn) and their [DAZN Lambda Powertools](https://github.com/getndazn/dazn-lambda-powertools/).
+The [Serverless TypeScript Demo](https://github.com/aws-samples/serverless-typescript-demo) shows how to use Lambda Powertools for TypeScript.  
+You can find instructions on how to deploy and load test this application in the [repository](https://github.com/aws-samples/serverless-typescript-demo).
 
+## Contribute
+
+If you are interested in contributing to this project, please refer to our [Contributing Guidelines](https://github.com/awslabs/aws-lambda-powertools-typescript/blob/main/CONTRIBUTING.md).
+
+## Roadmap
+
+The roadmap of Powertools is driven by customers’ demand.  
+Help us prioritize upcoming functionalities or utilities by [upvoting existing RFCs and feature requests](https://github.com/awslabs/aws-lambda-powertools-typescript/issues), or [creating new ones](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/new/choose), in this GitHub repository.
+
 ## Connect
@@ -46,4 +81,8 @@
 
+## Credits
+
+Credits for the Lambda Powertools idea go to [DAZN](https://github.com/getndazn) and their [DAZN Lambda Powertools](https://github.com/getndazn/dazn-lambda-powertools/).
+
 ## License
 
 This library is licensed under the MIT-0 License. See the LICENSE file.

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

33020

increased by9.07%

Lines of code

444

increased by5.21%

Number of lines in readme file

85

increased by84.78%

No dependency changes