@middy/input-output-logger 3.0.0-alpha.6 → 3.0.0

package/README.md

@@ -1,26 +1,36 @@
-# Middy input-output-logger middleware
-
-<div align="center">
-  <img alt="Middy logo" src="https://raw.githubusercontent.com/middyjs/middy/main/docs/img/middy-logo.png"/>
-</div>
-
 <div align="center">
+  <h1>Middy input-output-logger middleware</h1>
+  <img alt="Middy logo" src="https://raw.githubusercontent.com/middyjs/middy/main/docs/img/middy-logo.svg"/>
   <p><strong>Input output logger middleware for the middy framework, the stylish Node.js middleware engine for AWS Lambda</strong></p>
-</div>
-
-<div align="center">
 <p>
-  <a href="http://badge.fury.io/js/%40middy%2Finput-output-logger">
+  <a href="https://www.npmjs.com/package/@middy/input-output-logger?activeTab=versions">
     <img src="https://badge.fury.io/js/%40middy%2Finput-output-logger.svg" alt="npm version" style="max-width:100%;">
   </a>
+  <a href="https://packagephobia.com/result?p=@middy/input-output-logger">
+    <img src="https://packagephobia.com/badge?p=@middy/input-output-logger" alt="npm install size" style="max-width:100%;">
+  </a>
+  <a href="https://github.com/middyjs/middy/actions">
+    <img src="https://github.com/middyjs/middy/workflows/Tests/badge.svg" alt="GitHub Actions test status badge" style="max-width:100%;">
+  </a>
+  <br/>
+   <a href="https://standardjs.com/">
+    <img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="Standard Code Style"  style="max-width:100%;">
+  </a>
   <a href="https://snyk.io/test/github/middyjs/middy">
     <img src="https://snyk.io/test/github/middyjs/middy/badge.svg" alt="Known Vulnerabilities" data-canonical-src="https://snyk.io/test/github/middyjs/middy" style="max-width:100%;">
   </a>
-  <a href="https://standardjs.com/">
-    <img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="Standard Code Style"  style="max-width:100%;">
+  <a href="https://lgtm.com/projects/g/middyjs/middy/context:javascript">
+    <img src="https://img.shields.io/lgtm/grade/javascript/g/middyjs/middy.svg?logo=lgtm&logoWidth=18" alt="Language grade: JavaScript" style="max-width:100%;">
+  </a>
+  <a href="https://bestpractices.coreinfrastructure.org/projects/5280">
+    <img src="https://bestpractices.coreinfrastructure.org/projects/5280/badge" alt="Core Infrastructure Initiative (CII) Best Practices"  style="max-width:100%;">
   </a>
+  <br/>
   <a href="https://gitter.im/middyjs/Lobby">
-    <img src="https://badges.gitter.im/gitterHQ/gitter.svg" alt="Chat on Gitter"  style="max-width:100%;">
+    <img src="https://badges.gitter.im/gitterHQ/gitter.svg" alt="Chat on Gitter" style="max-width:100%;">
+  </a>
+  <a href="https://stackoverflow.com/questions/tagged/middy?sort=Newest&uqlId=35052">
+    <img src="https://img.shields.io/badge/StackOverflow-[middy]-yellow" alt="Ask questions on StackOverflow" style="max-width:100%;">
   </a>
 </p>
 </div>
@@ -44,7 +54,8 @@ npm install --save @middy/input-output-logger
 - `logger` (function) (default `console.log`): logging function that accepts an object
 - `awsContext` (boolean) (default `false`): Include [AWS Lambda context object](https://docs.aws.amazon.com/lambda/latest/dg/nodejs-context.html) to the logger
 - `omitPaths` (string[]) (default `[]`): property accepts an array of paths that will be used to remove particular fields import the logged objects. This could serve as a simple way to redact sensitive data from logs (default []).
-- `replacer` (function) (default undefined): A [replacer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#Parameters) parameter may be passed which will be used `JSON.stringify`ing the request during cloning.
+- `mask` (string) (default `undefined`): When set to a truthy value (i.e. `*** redacted ***`) a path is replaced instead of ommitted.
+- `replacer` (function) (default `undefined`): A [replacer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#Parameters) parameter may be passed which will be used `JSON.stringify`ing the request during cloning.
 
 ## Sample usage
 

package/index.cjs

@@ -0,0 +1,3 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:true});exports.default=void 0;var _util=require("@middy/util");var _a,_b;const defaults={logger:console.log,awsContext:false,omitPaths:[],mask:undefined,replacer:undefined};const inputOutputLoggerMiddleware=(opts={})=>{const{logger,awsContext,omitPaths,mask,replacer}={...defaults,...opts};if(typeof logger!=="function"){throw new Error("[input-output-logger-middleware]: logger must be a function")}const omitPathTree=buildPathOmitTree(omitPaths);const omitAndLog=(param,request)=>{const message={[param]:request[param]};if(awsContext){message.context=pick(request.context,awsContextKeys)}const cloneMessage=(0,_util).jsonSafeParse((0,_util).jsonSafeStringify(message,replacer));omit(cloneMessage,{[param]:omitPathTree[param]});logger(cloneMessage)};const omit=(obj,pathTree={})=>{if(Array.isArray(obj)&&pathTree["[]"]){for(const value of obj){omit(value,pathTree["[]"])}}else if(isObject(obj)){for(const key in pathTree){if(pathTree[key]===true){if(mask){obj[key]=mask}else{delete obj[key]}}else{omit(obj[key],pathTree[key])}}}};const inputOutputLoggerMiddlewareBefore=async request=>omitAndLog("event",request);const inputOutputLoggerMiddlewareAfter=async request=>omitAndLog("response",request);const inputOutputLoggerMiddlewareOnError=async request=>{if(request.response===undefined)return;return omitAndLog("response",request)};return{before:inputOutputLoggerMiddlewareBefore,after:inputOutputLoggerMiddlewareAfter,onError:inputOutputLoggerMiddlewareOnError}};const awsContextKeys=["functionName","functionVersion","invokedFunctionArn","memoryLimitInMB","awsRequestId","logGroupName","logStreamName","identity","clientContext","callbackWaitsForEmptyEventLoop"];const pick=(originalObject={},keysToPick=[])=>{const newObject={};for(const path of keysToPick){if(originalObject[path]!==undefined){newObject[path]=originalObject[path]}}return newObject};const buildPathOmitTree=paths=>{const tree={};for(let path of paths.sort().reverse()){if(!Array.isArray(path))path=path.split(".");if(path.includes("__proto__"))continue;path.slice(0).reduce((a,b,idx)=>{if(idx<path.length-1){(_a=a)[_b=b]??(_a[_b]={});return a[b]}a[b]=true;return true},tree)}return tree};const isObject=value=>value&& typeof value==="object"&&value.constructor===Object;var _default=inputOutputLoggerMiddleware;exports.default=_default
+
+//# sourceMappingURL=index.cjs.map

package/index.js

@@ -1,105 +1,3 @@
-import { jsonSafeParse, jsonSafeStringify } from '@middy/util';
-const defaults = {
-  logger: console.log,
-  awsContext: false,
-  omitPaths: [],
-  replacer: undefined
-};
+var _a,_b;import{jsonSafeParse,jsonSafeStringify}from"@middy/util";const defaults={logger:console.log,awsContext:false,omitPaths:[],mask:undefined,replacer:undefined};const inputOutputLoggerMiddleware=(opts={})=>{const{logger,awsContext,omitPaths,mask,replacer}={...defaults,...opts};if(typeof logger!=="function"){throw new Error("[input-output-logger-middleware]: logger must be a function")}const omitPathTree=buildPathOmitTree(omitPaths);const omitAndLog=(param,request)=>{const message={[param]:request[param]};if(awsContext){message.context=pick(request.context,awsContextKeys)}const cloneMessage=jsonSafeParse(jsonSafeStringify(message,replacer));omit(cloneMessage,{[param]:omitPathTree[param]});logger(cloneMessage)};const omit=(obj,pathTree={})=>{if(Array.isArray(obj)&&pathTree["[]"]){for(const value of obj){omit(value,pathTree["[]"])}}else if(isObject(obj)){for(const key in pathTree){if(pathTree[key]===true){if(mask){obj[key]=mask}else{delete obj[key]}}else{omit(obj[key],pathTree[key])}}}};const inputOutputLoggerMiddlewareBefore=async request=>omitAndLog("event",request);const inputOutputLoggerMiddlewareAfter=async request=>omitAndLog("response",request);const inputOutputLoggerMiddlewareOnError=async request=>{if(request.response===undefined)return;return omitAndLog("response",request)};return{before:inputOutputLoggerMiddlewareBefore,after:inputOutputLoggerMiddlewareAfter,onError:inputOutputLoggerMiddlewareOnError}};const awsContextKeys=["functionName","functionVersion","invokedFunctionArn","memoryLimitInMB","awsRequestId","logGroupName","logStreamName","identity","clientContext","callbackWaitsForEmptyEventLoop"];const pick=(originalObject={},keysToPick=[])=>{const newObject={};for(const path of keysToPick){if(originalObject[path]!==undefined){newObject[path]=originalObject[path]}}return newObject};const buildPathOmitTree=paths=>{const tree={};for(let path of paths.sort().reverse()){if(!Array.isArray(path))path=path.split(".");if(path.includes("__proto__"))continue;path.slice(0).reduce((a,b,idx)=>{if(idx<path.length-1){(_a=a)[_b=b]??(_a[_b]={});return a[b]}a[b]=true;return true},tree)}return tree};const isObject=value=>value&& typeof value==="object"&&value.constructor===Object;export default inputOutputLoggerMiddleware
 
-const inputOutputLoggerMiddleware = (opts = {}) => {
-  let {
-    logger,
-    awsContext,
-    omitPaths,
-    replacer
-  } = { ...defaults,
-    ...opts
-  };
-  if (typeof logger !== 'function') logger = null;
-  const omitPathTree = buildPathOmitTree(omitPaths);
-
-  const omitAndLog = (param, request) => {
-    const message = {
-      [param]: request[param]
-    };
-
-    if (awsContext) {
-      message.context = pick(request.context, awsContextKeys);
-    }
-
-    const cloneMessage = jsonSafeParse(jsonSafeStringify(message, replacer));
-    omit(cloneMessage, {
-      [param]: omitPathTree[param]
-    });
-    logger(cloneMessage);
-  };
-
-  const inputOutputLoggerMiddlewareBefore = async request => omitAndLog('event', request);
-
-  const inputOutputLoggerMiddlewareAfter = async request => omitAndLog('response', request);
-
-  const inputOutputLoggerMiddlewareOnError = async request => {
-    if (request.response === undefined) return;
-    return omitAndLog('response', request);
-  };
-
-  return {
-    before: logger ? inputOutputLoggerMiddlewareBefore : undefined,
-    after: logger ? inputOutputLoggerMiddlewareAfter : undefined,
-    onError: logger ? inputOutputLoggerMiddlewareOnError : undefined
-  };
-};
-
-const awsContextKeys = ['functionName', 'functionVersion', 'invokedFunctionArn', 'memoryLimitInMB', 'awsRequestId', 'logGroupName', 'logStreamName', 'identity', 'clientContext', 'callbackWaitsForEmptyEventLoop'];
-
-const pick = (originalObject = {}, keysToPick = []) => {
-  const newObject = {};
-
-  for (const path of keysToPick) {
-    if (originalObject[path] !== undefined) {
-      newObject[path] = originalObject[path];
-    }
-  }
-
-  return newObject;
-};
-
-const buildPathOmitTree = paths => {
-  const tree = {};
-
-  for (let path of paths.sort().reverse()) {
-    if (!Array.isArray(path)) path = path.split('.');
-    if (path.includes('__proto__')) continue;
-    path.slice(0).reduce((a, b, idx) => {
-      if (idx < path.length - 1) {
-        a[b] ?? (a[b] = {});
-        return a[b];
-      }
-
-      a[b] = true;
-      return true;
-    }, tree);
-  }
-
-  return tree;
-};
-
-const omit = (obj, pathTree = {}) => {
-  if (Array.isArray(obj) && pathTree['[]']) {
-    for (const value of obj) {
-      omit(value, pathTree['[]']);
-    }
-  } else if (isObject(obj)) {
-    for (const key in pathTree) {
-      if (pathTree[key] === true) {
-        delete obj[key];
-      } else {
-        omit(obj[key], pathTree[key]);
-      }
-    }
-  }
-};
-
-const isObject = value => value && typeof value === 'object' && value.constructor === Object;
-
-export default inputOutputLoggerMiddleware;
+//# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@middy/input-output-logger",
-  "version": "3.0.0-alpha.6",
+  "version": "3.0.0",
   "description": "Input and output logger middleware for the middy framework",
   "type": "module",
   "engines": {
@@ -10,10 +10,17 @@
   "publishConfig": {
     "access": "public"
   },
-  "exports": "./index.js",
+  "exports": {
+    ".": {
+      "import": "./index.js",
+      "require": "./index.cjs",
+      "types": "./index.d.ts"
+    }
+  },
   "types": "index.d.ts",
   "files": [
     "index.js",
+    "index.cjs",
     "index.d.ts"
   ],
   "scripts": {
@@ -46,13 +53,13 @@
   "bugs": {
     "url": "https://github.com/middyjs/middy/issues"
   },
-  "homepage": "https://github.com/middyjs/middy#readme",
+  "homepage": "https://middy.js.org",
   "dependencies": {
-    "@middy/util": "^3.0.0-alpha.6"
+    "@middy/util": "^3.0.0"
   },
   "devDependencies": {
-    "@middy/core": "^3.0.0-alpha.6",
+    "@middy/core": "^3.0.0",
     "@types/node": "^17.0.0"
   },
-  "gitHead": "176660ed3e0716d6bfb635c77251b301e0e24720"
+  "gitHead": "01520fa8628a36c2f89e126cad656a16547ea0d6"
 }