@leanstacks/lambda-utils 0.1.0-alpha.1 → 0.1.0-alpha.2

package/dist/index.d.ts

@@ -1 +1 @@
-export { initializeLogger, logger, LoggerConfig } from './logging/logger';
+export { getLogger, initializeLogger, LoggerConfig, withRequestTracking } from './logging/logger';

package/dist/index.js

@@ -1,6 +1,20 @@
 import pino from 'pino';
-import { StructuredLogFormatter, pinoLambdaDestination, CloudwatchLogFormatter } from 'pino-lambda';
+import { lambdaRequestTracker, StructuredLogFormatter, CloudwatchLogFormatter, pinoLambdaDestination } from 'pino-lambda';
 
+/**
+ * Middleware to track AWS Lambda requests
+ * @example
+ * ```typescript
+ * import { withRequestTracking } from '@utils/logging/logger';
+ *
+ * export const handler = async (event, context) => {
+ *   withRequestTracking(event, context);
+ *
+ *   // Your Lambda handler logic here
+ * };
+ * ```
+ */
+const withRequestTracking = lambdaRequestTracker();
 /**
  * Module-level state to store logger configuration
  */
@@ -28,15 +42,6 @@ const _createLogger = () => {
         level: _loggerConfig.level,
     }, lambdaDestination);
 };
-/**
- * Get the cached logger instance, creating it if necessary
- */
-const _getLogger = () => {
-    if (_loggerInstance === null) {
-        _loggerInstance = _createLogger();
-    }
-    return _loggerInstance;
-};
 /**
  * Initialize the logger with configuration
  * Should be called once at Lambda handler entry point
@@ -66,10 +71,20 @@ const initializeLogger = (config) => {
     _loggerInstance = null;
 };
 /**
- * Pino logger instance
- * Configuration is supplied via initializeLogger() and persists across imports
- * Logger instance is cached after first creation for reuse
+ * Get the logger instance
+ *
+ * @example
+ * ```typescript
+ * import { logger } from '@utils/logging/logger';
+ *
+ * logger.info('Hello, world!');
+ * ```
  */
-const logger = _getLogger();
+const getLogger = () => {
+    if (_loggerInstance === null) {
+        _loggerInstance = _createLogger();
+    }
+    return _loggerInstance;
+};
 
-export { initializeLogger, logger };
+export { getLogger, initializeLogger, withRequestTracking };

package/dist/logging/logger.d.ts

@@ -1,4 +1,18 @@
 import pino from 'pino';
+/**
+ * Middleware to track AWS Lambda requests
+ * @example
+ * ```typescript
+ * import { withRequestTracking } from '@utils/logging/logger';
+ *
+ * export const handler = async (event, context) => {
+ *   withRequestTracking(event, context);
+ *
+ *   // Your Lambda handler logic here
+ * };
+ * ```
+ */
+export declare const withRequestTracking: (event: import("pino-lambda").LambdaEvent, context: import("pino-lambda").LambdaContext) => void;
 /**
  * Configuration options for the Pino Lambda logger
  */
@@ -31,8 +45,13 @@ export interface LoggerConfig {
  */
 export declare const initializeLogger: (config: LoggerConfig) => void;
 /**
- * Pino logger instance
- * Configuration is supplied via initializeLogger() and persists across imports
- * Logger instance is cached after first creation for reuse
+ * Get the logger instance
+ *
+ * @example
+ * ```typescript
+ * import { logger } from '@utils/logging/logger';
+ *
+ * logger.info('Hello, world!');
+ * ```
  */
-export declare const logger: pino.Logger<never, boolean>;
+export declare const getLogger: () => pino.Logger;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leanstacks/lambda-utils",
-  "version": "0.1.0-alpha.1",
+  "version": "0.1.0-alpha.2",
   "description": "A collection of utilities and helper functions designed to streamline the development of AWS Lambda functions using TypeScript.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/index.ts

@@ -1 +1 @@
-export { initializeLogger, logger, LoggerConfig } from './logging/logger';
+export { getLogger, initializeLogger, LoggerConfig, withRequestTracking } from './logging/logger';

package/src/logging/logger.ts

@@ -1,5 +1,25 @@
 import pino from 'pino';
-import { CloudwatchLogFormatter, pinoLambdaDestination, StructuredLogFormatter } from 'pino-lambda';
+import {
+  CloudwatchLogFormatter,
+  lambdaRequestTracker,
+  pinoLambdaDestination,
+  StructuredLogFormatter,
+} from 'pino-lambda';
+
+/**
+ * Middleware to track AWS Lambda requests
+ * @example
+ * ```typescript
+ * import { withRequestTracking } from '@utils/logging/logger';
+ *
+ * export const handler = async (event, context) => {
+ *   withRequestTracking(event, context);
+ *
+ *   // Your Lambda handler logic here
+ * };
+ * ```
+ */
+export const withRequestTracking = lambdaRequestTracker();
 
 /**
  * Configuration options for the Pino Lambda logger
@@ -48,16 +68,6 @@ const _createLogger = (): pino.Logger => {
   );
 };
 
-/**
- * Get the cached logger instance, creating it if necessary
- */
-const _getLogger = (): pino.Logger => {
-  if (_loggerInstance === null) {
-    _loggerInstance = _createLogger();
-  }
-  return _loggerInstance;
-};
-
 /**
  * Initialize the logger with configuration
  * Should be called once at Lambda handler entry point
@@ -88,8 +98,18 @@ export const initializeLogger = (config: LoggerConfig): void => {
 };
 
 /**
- * Pino logger instance
- * Configuration is supplied via initializeLogger() and persists across imports
- * Logger instance is cached after first creation for reuse
+ * Get the logger instance
+ *
+ * @example
+ * ```typescript
+ * import { logger } from '@utils/logging/logger';
+ *
+ * logger.info('Hello, world!');
+ * ```
  */
-export const logger = _getLogger();
+export const getLogger = (): pino.Logger => {
+  if (_loggerInstance === null) {
+    _loggerInstance = _createLogger();
+  }
+  return _loggerInstance;
+};