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

Comparing version 1.8.0 to 1.9.0

lib/config/ConfigService.d.ts

@@ -43,3 +43,3 @@ /**
 }
-export { ConfigService, };
+export { ConfigService };
 //# sourceMappingURL=ConfigService.d.ts.map

lib/config/ConfigService.js

@@ -16,2 +16,2 @@ "use strict";
 exports.ConfigService = ConfigService;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQ29uZmlnU2VydmljZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9jb25maWcvQ29uZmlnU2VydmljZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQTs7Ozs7Ozs7R0FRRztBQUNILE1BQWUsYUFBYTtDQW9DM0I7QUFHQyxzQ0FBYSJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQ29uZmlnU2VydmljZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9jb25maWcvQ29uZmlnU2VydmljZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQTs7Ozs7Ozs7R0FRRztBQUNILE1BQWUsYUFBYTtDQW1DM0I7QUFFUSxzQ0FBYSJ9

lib/config/EnvironmentVariablesService.d.ts

@@ -47,2 +47,11 @@ import { ConfigService } from '.';
     /**
+     * It returns true if the Sampled flag is set in the _X_AMZN_TRACE_ID environment variable.
+     *
+     * The AWS X-Ray Trace data available in the environment variable has this format:
+     * `Root=1-5759e988-bd862e3fe1be46a994272793;Parent=557abcec3ee5a047;Sampled=1`,
+     *
+     * @returns {boolean}
+     */
+    getXrayTraceSampled(): boolean;
+    /**
      * It returns true if the string value represents a boolean true value.
@@ -54,4 +63,9 @@ *
     isValueTrue(value: string): boolean;
+    /**
+     * It parses the key/value data present in the _X_AMZN_TRACE_ID environment variable
+     * and returns it as an object when available.
+     */
+    private getXrayTraceData;
 }
-export { EnvironmentVariablesService, };
+export { EnvironmentVariablesService };
 //# sourceMappingURL=EnvironmentVariablesService.d.ts.map

lib/config/EnvironmentVariablesService.js

@@ -57,8 +57,18 @@ "use strict";
     getXrayTraceId() {
-        const xRayTraceId = this.get(this.xRayTraceIdVariable);
-        if (xRayTraceId === '')
-            return undefined;
-        return xRayTraceId.split(';')[0].replace('Root=', '');
+        const xRayTraceData = this.getXrayTraceData();
+        return xRayTraceData?.Root;
     }
     /**
+     * It returns true if the Sampled flag is set in the _X_AMZN_TRACE_ID environment variable.
+     *
+     * The AWS X-Ray Trace data available in the environment variable has this format:
+     * `Root=1-5759e988-bd862e3fe1be46a994272793;Parent=557abcec3ee5a047;Sampled=1`,
+     *
+     * @returns {boolean}
+     */
+    getXrayTraceSampled() {
+        const xRayTraceData = this.getXrayTraceData();
+        return xRayTraceData?.Sampled === '1';
+    }
+    /**
      * It returns true if the string value represents a boolean true value.
@@ -73,4 +83,21 @@ *
     }
+    /**
+     * It parses the key/value data present in the _X_AMZN_TRACE_ID environment variable
+     * and returns it as an object when available.
+     */
+    getXrayTraceData() {
+        const xRayTraceEnv = this.get(this.xRayTraceIdVariable);
+        if (xRayTraceEnv === '')
+            return undefined;
+        if (!xRayTraceEnv.includes('='))
+            return { Root: xRayTraceEnv };
+        const xRayTraceData = {};
+        xRayTraceEnv.split(';').forEach((field) => {
+            const [key, value] = field.split('=');
+            xRayTraceData[key] = value;
+        });
+        return xRayTraceData;
+    }
 }
 exports.EnvironmentVariablesService = EnvironmentVariablesService;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRW52aXJvbm1lbnRWYXJpYWJsZXNTZXJ2aWNlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NvbmZpZy9FbnZpcm9ubWVudFZhcmlhYmxlc1NlcnZpY2UudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEsd0JBQWtDO0FBRWxDOzs7Ozs7Ozs7Ozs7R0FZRztBQUNILE1BQU0sMkJBQTRCLFNBQVEsZ0JBQWE7SUFBdkQ7O1FBRUU7OztXQUdHO1FBQ08sd0JBQW1CLEdBQUcseUJBQXlCLENBQUM7UUFDMUQsaUNBQWlDO1FBQ3pCLHdCQUFtQixHQUFHLGtCQUFrQixDQUFDO0lBbURuRCxDQUFDO0lBakRDOzs7OztPQUtHO0lBQ0ksR0FBRyxDQUFDLElBQVk7UUFDckIsT0FBTyxPQUFPLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxFQUFFLElBQUksRUFBRSxJQUFJLEVBQUUsQ0FBQztJQUN6QyxDQUFDO0lBRUQ7Ozs7T0FJRztJQUNJLGNBQWM7UUFDbkIsT0FBTyxJQUFJLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxtQkFBbUIsQ0FBQyxDQUFDO0lBQzVDLENBQUM7SUFFRDs7Ozs7Ozs7O09BU0c7SUFDSSxjQUFjO1FBQ25CLE1BQU0sV0FBVyxHQUFHLElBQUksQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLG1CQUFtQixDQUFDLENBQUM7UUFFdkQsSUFBSSxXQUFXLEtBQUssRUFBRTtZQUFFLE9BQU8sU0FBUyxDQUFDO1FBRXpDLE9BQU8sV0FBVyxDQUFDLEtBQUssQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxPQUFPLENBQUMsT0FBTyxFQUFFLEVBQUUsQ0FBQyxDQUFDO0lBQ3hELENBQUM7SUFFRDs7Ozs7T0FLRztJQUNJLFdBQVcsQ0FBQyxLQUFhO1FBQzlCLE1BQU0sWUFBWSxHQUFhLENBQUUsR0FBRyxFQUFFLEdBQUcsRUFBRSxLQUFLLEVBQUUsR0FBRyxFQUFFLE1BQU0sRUFBRSxJQUFJLENBQUUsQ0FBQztRQUV0RSxPQUFPLFlBQVksQ0FBQyxRQUFRLENBQUMsS0FBSyxDQUFDLFdBQVcsRUFBRSxDQUFDLENBQUM7SUFDcEQsQ0FBQztDQUVGO0FBR0Msa0VBQTJCIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRW52aXJvbm1lbnRWYXJpYWJsZXNTZXJ2aWNlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NvbmZpZy9FbnZpcm9ubWVudFZhcmlhYmxlc1NlcnZpY2UudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEsd0JBQWtDO0FBRWxDOzs7Ozs7Ozs7Ozs7R0FZRztBQUNILE1BQU0sMkJBQTRCLFNBQVEsZ0JBQWE7SUFBdkQ7O1FBQ0U7OztXQUdHO1FBQ08sd0JBQW1CLEdBQUcseUJBQXlCLENBQUM7UUFDMUQsaUNBQWlDO1FBQ3pCLHdCQUFtQixHQUFHLGtCQUFrQixDQUFDO0lBb0ZuRCxDQUFDO0lBbEZDOzs7OztPQUtHO0lBQ0ksR0FBRyxDQUFDLElBQVk7UUFDckIsT0FBTyxPQUFPLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxFQUFFLElBQUksRUFBRSxJQUFJLEVBQUUsQ0FBQztJQUN6QyxDQUFDO0lBRUQ7Ozs7T0FJRztJQUNJLGNBQWM7UUFDbkIsT0FBTyxJQUFJLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxtQkFBbUIsQ0FBQyxDQUFDO0lBQzVDLENBQUM7SUFFRDs7Ozs7Ozs7O09BU0c7SUFDSSxjQUFjO1FBQ25CLE1BQU0sYUFBYSxHQUFHLElBQUksQ0FBQyxnQkFBZ0IsRUFBRSxDQUFDO1FBRTlDLE9BQU8sYUFBYSxFQUFFLElBQUksQ0FBQztJQUM3QixDQUFDO0lBRUQ7Ozs7Ozs7T0FPRztJQUNJLG1CQUFtQjtRQUN4QixNQUFNLGFBQWEsR0FBRyxJQUFJLENBQUMsZ0JBQWdCLEVBQUUsQ0FBQztRQUU5QyxPQUFPLGFBQWEsRUFBRSxPQUFPLEtBQUssR0FBRyxDQUFDO0lBQ3hDLENBQUM7SUFFRDs7Ozs7T0FLRztJQUNJLFdBQVcsQ0FBQyxLQUFhO1FBQzlCLE1BQU0sWUFBWSxHQUFhLENBQUMsR0FBRyxFQUFFLEdBQUcsRUFBRSxLQUFLLEVBQUUsR0FBRyxFQUFFLE1BQU0sRUFBRSxJQUFJLENBQUMsQ0FBQztRQUVwRSxPQUFPLFlBQVksQ0FBQyxRQUFRLENBQUMsS0FBSyxDQUFDLFdBQVcsRUFBRSxDQUFDLENBQUM7SUFDcEQsQ0FBQztJQUVEOzs7T0FHRztJQUNLLGdCQUFnQjtRQUN0QixNQUFNLFlBQVksR0FBRyxJQUFJLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxtQkFBbUIsQ0FBQyxDQUFDO1FBRXhELElBQUksWUFBWSxLQUFLLEVBQUU7WUFBRSxPQUFPLFNBQVMsQ0FBQztRQUUxQyxJQUFJLENBQUMsWUFBWSxDQUFDLFFBQVEsQ0FBQyxHQUFHLENBQUM7WUFBRSxPQUFPLEVBQUUsSUFBSSxFQUFFLFlBQVksRUFBRSxDQUFDO1FBRS9ELE1BQU0sYUFBYSxHQUEyQixFQUFFLENBQUM7UUFFakQsWUFBWSxDQUFDLEtBQUssQ0FBQyxHQUFHLENBQUMsQ0FBQyxPQUFPLENBQUMsQ0FBQyxLQUFLLEVBQUUsRUFBRTtZQUN4QyxNQUFNLENBQUMsR0FBRyxFQUFFLEtBQUssQ0FBQyxHQUFHLEtBQUssQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUFDLENBQUM7WUFFdEMsYUFBYSxDQUFDLEdBQUcsQ0FBQyxHQUFHLEtBQUssQ0FBQztRQUM3QixDQUFDLENBQUMsQ0FBQztRQUVILE9BQU8sYUFBYSxDQUFDO0lBQ3ZCLENBQUM7Q0FDRjtBQUVRLGtFQUEyQiJ9

lib/samples/resources/contexts/hello-world.d.ts

 import { Context } from 'aws-lambda';
 declare const helloworldContext: Context;
-export { helloworldContext, };
+export { helloworldContext };
 //# sourceMappingURL=hello-world.d.ts.map

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

@@ -19,2 +19,2 @@ "use strict";
 exports.helloworldContext = helloworldContext;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaGVsbG8td29ybGQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvc2FtcGxlcy9yZXNvdXJjZXMvY29udGV4dHMvaGVsbG8td29ybGQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBRUEsTUFBTSxpQkFBaUIsR0FBWTtJQUNqQyw4QkFBOEIsRUFBRSxJQUFJO0lBQ3BDLGVBQWUsRUFBRSxTQUFTO0lBQzFCLFlBQVksRUFBRSxrQkFBa0I7SUFDaEMsZUFBZSxFQUFFLEtBQUs7SUFDdEIsWUFBWSxFQUFFLDJDQUEyQztJQUN6RCxhQUFhLEVBQUUsMERBQTBEO0lBQ3pFLGtCQUFrQixFQUFFLGlFQUFpRTtJQUNyRixZQUFZLEVBQUUsc0NBQXNDO0lBQ3BELHdCQUF3QixFQUFFLEdBQUcsRUFBRSxDQUFDLElBQUk7SUFDcEMsSUFBSSxFQUFFLEdBQUcsRUFBRSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsT0FBTyxDQUFDO0lBQ2hDLElBQUksRUFBRSxHQUFHLEVBQUUsQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLFNBQVMsQ0FBQztJQUNsQyxPQUFPLEVBQUUsR0FBRyxFQUFFLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxZQUFZLENBQUM7Q0FDekMsQ0FBQztBQUdBLDhDQUFpQiJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaGVsbG8td29ybGQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvc2FtcGxlcy9yZXNvdXJjZXMvY29udGV4dHMvaGVsbG8td29ybGQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBRUEsTUFBTSxpQkFBaUIsR0FBWTtJQUNqQyw4QkFBOEIsRUFBRSxJQUFJO0lBQ3BDLGVBQWUsRUFBRSxTQUFTO0lBQzFCLFlBQVksRUFBRSxrQkFBa0I7SUFDaEMsZUFBZSxFQUFFLEtBQUs7SUFDdEIsWUFBWSxFQUFFLDJDQUEyQztJQUN6RCxhQUFhLEVBQUUsMERBQTBEO0lBQ3pFLGtCQUFrQixFQUNoQixpRUFBaUU7SUFDbkUsWUFBWSxFQUFFLHNDQUFzQztJQUNwRCx3QkFBd0IsRUFBRSxHQUFHLEVBQUUsQ0FBQyxJQUFJO0lBQ3BDLElBQUksRUFBRSxHQUFHLEVBQUUsQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLE9BQU8sQ0FBQztJQUNoQyxJQUFJLEVBQUUsR0FBRyxFQUFFLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxTQUFTLENBQUM7SUFDbEMsT0FBTyxFQUFFLEdBQUcsRUFBRSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsWUFBWSxDQUFDO0NBQ3pDLENBQUM7QUFFTyw4Q0FBaUIifQ==

lib/types/middy.d.ts

@@ -1,6 +0,6 @@
-import { Context } from 'aws-lambda';
+import type { Context } from 'aws-lambda';
 /**
  * We need to define these types and interfaces here because we can't import them from @middy/core.
  * Importing them from @middy/core would introduce a dependency on @middy/core, which we don't want
- * because we want to keep it as an optional dependency. Those users who don't use the Powertools middleware
+ * because we want to keep it as an optional dependency. Those users who don't use the Powertools for AWS Lambda (TypeScript) middleware
  * and use `tsc` to compile their code will get an error if we import from @middy/core, see #1068.
@@ -18,4 +18,4 @@ * Given that we use a subset of the @middy/core types, we can define them here and avoid the dependency.
 };
-declare type MiddlewareFn<TEvent = unknown, TResult = unknown, TErr = Error, TContext extends Context = Context> = (request: Request<TEvent, TResult, TErr, TContext>) => unknown;
-export type MiddlewareLikeObj<TEvent = unknown, TResult = unknown, TErr = Error, TContext extends Context = Context> = {
+type MiddlewareFn<TEvent = unknown, TResult = unknown, TErr = Error, TContext extends Context = Context> = (request: Request<TEvent, TResult, TErr, TContext>) => unknown;
+type MiddlewareLikeObj<TEvent = unknown, TResult = unknown, TErr = Error, TContext extends Context = Context> = {
     before?: MiddlewareFn<TEvent, TResult, TErr, TContext>;
@@ -25,3 +25,3 @@ after?: MiddlewareFn<TEvent, TResult, TErr, TContext>;
 };
-export type MiddyLikeRequest = {
+type MiddyLikeRequest = {
     event: unknown;
@@ -31,4 +31,13 @@ context: Context;
     error: Error | null;
+    internal: {
+        [key: string]: unknown;
+    };
 };
-export {};
+/**
+ * Cleanup function that is used to cleanup resources when a middleware returns early.
+ * Each Powertools for AWS middleware that needs to perform cleanup operations will
+ * store a cleanup function with this signature in the `request.internal` object.
+ */
+type CleanupFunction = (request: MiddyLikeRequest) => Promise<void>;
+export { MiddlewareLikeObj, MiddyLikeRequest, CleanupFunction };
 //# sourceMappingURL=middy.d.ts.map

lib/Utility.d.ts

 /**
  * ## Intro
- * Utility is a base class that other Powertools utilites can extend to inherit shared logic.
+ * Utility is a base class that other Powertools for AWS Lambda (TypeScript) utilites can extend to inherit shared logic.
  *
@@ -17,3 +17,3 @@ *
  *
- * As a Powertools user you probably won't be using this class directly, in fact if you use other Powertools utilities the cold start heuristic found here is already used to:
+ * As a Powertools for AWS Lambda (TypeScript) user you probably won't be using this class directly, in fact if you use other Powertools for AWS utilities the cold start heuristic found here is already used to:
  * * Add a `coldStart` key to the structured logs when injecting context information in `Logger`
@@ -66,9 +66,9 @@ * * Emit a metric during a cold start function invocation in `Metrics`
     /**
-   * Validate that the service name provided is valid.
-   * Used internally during initialization.
-   *
-   * @param serviceName - Service name to validate
-   */
+     * 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

@@ -6,3 +6,3 @@ "use strict";
  * ## Intro
- * Utility is a base class that other Powertools utilites can extend to inherit shared logic.
+ * Utility is a base class that other Powertools for AWS Lambda (TypeScript) utilites can extend to inherit shared logic.
  *
@@ -21,3 +21,3 @@ *
  *
- * As a Powertools user you probably won't be using this class directly, in fact if you use other Powertools utilities the cold start heuristic found here is already used to:
+ * As a Powertools for AWS Lambda (TypeScript) user you probably won't be using this class directly, in fact if you use other Powertools for AWS utilities the cold start heuristic found here is already used to:
  * * Add a `coldStart` key to the structured logs when injecting context information in `Logger`
@@ -82,7 +82,7 @@ * * Emit a metric during a cold start function invocation in `Metrics`
     /**
-   * Validate that the service name provided is valid.
-   * Used internally during initialization.
-   *
-   * @param serviceName - Service name to validate
-   */
+     * Validate that the service name provided is valid.
+     * Used internally during initialization.
+     *
+     * @param serviceName - Service name to validate
+     */
     isValidServiceName(serviceName) {
@@ -93,2 +93,2 @@ return typeof serviceName === 'string' && serviceName.trim().length > 0;
 exports.Utility = Utility;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiVXRpbGl0eS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9VdGlsaXR5LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQXdERztBQUNILE1BQWEsT0FBTztJQUFwQjtRQUNVLGNBQVMsR0FBWSxJQUFJLENBQUM7UUFDakIsdUJBQWtCLEdBQVcsbUJBQW1CLENBQUM7SUE2QnBFLENBQUM7SUEzQlEsWUFBWTtRQUNqQixJQUFJLElBQUksQ0FBQyxTQUFTLEVBQUU7WUFDbEIsSUFBSSxDQUFDLFNBQVMsR0FBRyxLQUFLLENBQUM7WUFFdkIsT0FBTyxJQUFJLENBQUM7U0FDYjtRQUVELE9BQU8sS0FBSyxDQUFDO0lBQ2YsQ0FBQztJQUVNLFdBQVc7UUFDaEIsT0FBTyxJQUFJLENBQUMsWUFBWSxFQUFFLENBQUM7SUFDN0IsQ0FBQztJQUVTLHFCQUFxQjtRQUM3QixPQUFPLElBQUksQ0FBQyxrQkFBa0IsQ0FBQztJQUNqQyxDQUFDO0lBRUQ7Ozs7O0tBS0M7SUFDUyxrQkFBa0IsQ0FBQyxXQUFvQjtRQUMvQyxPQUFPLE9BQU8sV0FBVyxLQUFLLFFBQVEsSUFBSSxXQUFXLENBQUMsSUFBSSxFQUFFLENBQUMsTUFBTSxHQUFHLENBQUMsQ0FBQztJQUMxRSxDQUFDO0NBQ0Y7QUEvQkQsMEJBK0JDIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiVXRpbGl0eS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9VdGlsaXR5LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQXdERztBQUNILE1BQWEsT0FBTztJQUFwQjtRQUNVLGNBQVMsR0FBRyxJQUFJLENBQUM7UUFDUix1QkFBa0IsR0FBVyxtQkFBbUIsQ0FBQztJQTZCcEUsQ0FBQztJQTNCUSxZQUFZO1FBQ2pCLElBQUksSUFBSSxDQUFDLFNBQVMsRUFBRTtZQUNsQixJQUFJLENBQUMsU0FBUyxHQUFHLEtBQUssQ0FBQztZQUV2QixPQUFPLElBQUksQ0FBQztTQUNiO1FBRUQsT0FBTyxLQUFLLENBQUM7SUFDZixDQUFDO0lBRU0sV0FBVztRQUNoQixPQUFPLElBQUksQ0FBQyxZQUFZLEVBQUUsQ0FBQztJQUM3QixDQUFDO0lBRVMscUJBQXFCO1FBQzdCLE9BQU8sSUFBSSxDQUFDLGtCQUFrQixDQUFDO0lBQ2pDLENBQUM7SUFFRDs7Ozs7T0FLRztJQUNPLGtCQUFrQixDQUFDLFdBQW9CO1FBQy9DLE9BQU8sT0FBTyxXQUFXLEtBQUssUUFBUSxJQUFJLFdBQVcsQ0FBQyxJQUFJLEVBQUUsQ0FBQyxNQUFNLEdBQUcsQ0FBQyxDQUFDO0lBQzFFLENBQUM7Q0FDRjtBQS9CRCwwQkErQkMifQ==

package.json

 {
   "name": "@aws-lambda-powertools/commons",
-  "version": "1.8.0",
-  "description": "A shared utility package for AWS Lambda Powertools for TypeScript libraries",
+  "version": "1.9.0",
+  "description": "A shared utility package for Powertools for AWS Lambda (TypeScript) libraries",
   "author": {
@@ -19,4 +19,4 @@ "name": "Amazon Web Services",
     "build": "tsc",
-    "lint": "eslint --ext .ts --no-error-on-unmatched-pattern src tests",
-    "lint-fix": "eslint --fix --ext .ts --no-error-on-unmatched-pattern src tests",
+    "lint": "eslint --ext .ts,.js --no-error-on-unmatched-pattern .",
+    "lint-fix": "eslint --fix --ext .ts,.js --no-error-on-unmatched-pattern .",
     "package": "mkdir -p dist/ && npm pack && mv *.tgz dist/",
@@ -27,3 +27,4 @@ "package-bundle": "../../package-bundler.sh commons-bundle ./dist",
   "lint-staged": {
-    "*.ts": "npm run lint-fix"
+    "*.ts": "npm run lint-fix",
+    "*.js": "npm run lint-fix"
   },
@@ -52,3 +53,7 @@ "homepage": "https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/packages/metrics#readme",
   ],
-  "gitHead": "8d8c585d4a9ed2aef25a4be3d6b041ef47a28c00"
+  "devDependencies": {
+    "@aws-sdk/client-lambda": "^3.310.0",
+    "@aws-sdk/util-utf8-node": "^3.259.0"
+  },
+  "gitHead": "8d62a62452bfc1b6f1621144e8b3d011b5a189fc"
 }

README.md

@@ -1,4 +0,4 @@
-# AWS Lambda Powertools for TypeScript <!-- omit in toc -->
+# Powertools for AWS Lambda (TypeScript) <!-- omit in toc -->
 
-Powertools is a developer toolkit to implement Serverless [best practices and increase developer velocity](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#features).
+Powertools for AWS Lambda (TypeScript) is a developer toolkit to implement Serverless [best practices and increase developer velocity](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#features).
 
@@ -13,3 +13,3 @@ You can use the library in both TypeScript and JavaScript code bases.
 
-- [Table of contents](#table-of-contents)
+- [Table of contents ](#table-of-contents-)
 - [Features](#features)
@@ -23,2 +23,6 @@ - [Getting started](#getting-started)
 - [Connect](#connect)
+- [How to support Powertools for AWS Lambda (TypeScript)?](#how-to-support-powertools-for-aws-lambda-typescript)
+  - [Becoming a reference customer](#becoming-a-reference-customer)
+  - [Sharing your work](#sharing-your-work)
+  - [Using Lambda Layer](#using-lambda-layer)
 - [Credits](#credits)
@@ -40,3 +44,3 @@ - [License](#license)
 
-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).  
+The Powertools for AWS Lambda (TypeScript) utilities follow a modular approach, similar to the official [AWS SDK v3 for JavaScript](https://github.com/aws/aws-sdk-js-v3).  
 
@@ -68,3 +72,3 @@ Each TypeScript utility is installed as standalone npm package.
 
-The [Serverless TypeScript Demo](https://github.com/aws-samples/serverless-typescript-demo) shows how to use Lambda Powertools for TypeScript.  
+The [Serverless TypeScript Demo](https://github.com/aws-samples/serverless-typescript-demo) shows how to use Powertools for AWS Lambda (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).
@@ -78,3 +82,3 @@
 
-The roadmap of Powertools is driven by customers’ demand.  
+The roadmap of Powertools for AWS Lambda (TypeScript) 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.
@@ -84,8 +88,32 @@
 
-* **AWS Lambda Powertools on Discord**: `#typescript` - **[Invite link](https://discord.gg/B8zZKbbyET)**
+* **Powertools for AWS Lambda on Discord**: `#typescript` - **[Invite link](https://discord.gg/B8zZKbbyET)**
 * **Email**: [e-mail]
 
+## How to support Powertools for AWS Lambda (TypeScript)?
+
+### Becoming a reference customer
+
+Knowing which companies are using this library is important to help prioritize the project internally. If your company is using Powertools for AWS Lambda (TypeScript), you can request to have your name and logo added to the README file by raising a [Support Powertools for AWS Lambda (TypeScript) (become a reference)](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/new?assignees=&labels=customer-reference&template=support_powertools.yml&title=%5BSupport+Lambda+Powertools%5D%3A+%3Cyour+organization+name%3E) issue.
+
+The following companies, among others, use Powertools:
+
+* [Hashnode](https://hashnode.com/)
+* [Trek10](https://www.trek10.com/)
+* [Elva](https://elva-group.com)
+* [globaldatanet](https://globaldatanet.com/)
+* [Bailey Nelson](https://www.baileynelson.com.au)
+* [Perfect Post](https://www.perfectpost.fr)
+* [Sennder](https://sennder.com/)
+
+### Sharing your work
+
+Share what you did with Powertools for AWS Lambda (TypeScript) 💞💞. Blog post, workshops, presentation, sample apps and others. Check out what the community has already shared about Powertools for AWS Lambda (TypeScript) [here](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/we_made_this).
+
+### Using Lambda Layer
+
+This helps us understand who uses Powertools for AWS Lambda (TypeScript) in a non-intrusive way, and helps us gain future investments for other Powertools for AWS Lambda languages. When [using Layers](#lambda-layers), you can add Powertools for AWS Lambda (TypeScript) as a dev dependency (or as part of your virtual env) to not impact the development process.
+
 ## 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/).
+Credits for the Lambda Powertools for AWS Lambda (TypeScript) idea go to [DAZN](https://github.com/getndazn) and their [DAZN Lambda Powertools](https://github.com/getndazn/dazn-lambda-powertools/).
 
@@ -92,0 +120,0 @@ ## License

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

53951

increased by36.81%

Number of package files

49

increased by22.5%

Lines of code

747

increased by39.63%

Number of lines in readme file

117

increased by31.46%

Worsened metrics

Dev dependency count

2

increased byInfinity%

No dependency changes