winston-middleware 4.0.2 → 4.0.3

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 4.0.3
+* Update lodash to 4.17.15 ([#232](https://github.com/bithavoc/winston-middleware/pull/232))
+* Add missing exceptionToMeta and skip to TypeScript definition ([#234](https://github.com/bithavoc/winston-middleware/pull/234))
+
+## 4.0.2
+* Add blacklist fields to BaseErrorLoggerOptions interface ([#230](https://github.com/bithavoc/winston-middleware/pull/230))
+
 ## 4.0.1
 * Added `headerBlacklist` to BaseLoggerOptions for better typescript support ([#228](https://github.com/bithavoc/winston-middleware/pull/228))
 

package/Readme.md

@@ -124,8 +124,8 @@ The logger needs to be added AFTER the express router(`app.router)`) and BEFORE
     baseMeta: Object, // default meta data to be added to log, this will be merged with the error data.
     meta: Boolean, // control whether you want to log the meta data about the request (default to true).
     metaField: String, // if defined, the meta data will be added in this field instead of the meta root object. Defaults to 'meta'. Set to `null` to store metadata at the root of the log entry.
-    requestField: [String] // the property of the metadata to store the request under (default 'req'). Set to null to exclude request from metadata
-    responseField: [String] // the property of the metadata to store the response under (default 'res'). If set to the same as 'requestField', filtered response and request properties will be merged. Set to null to exclude request from metadata    
+    requestField: [String] // the property of the metadata to store the request under (default 'req'). Set to null to exclude request from metadata    
+    responseField: [String] // the property of the metadata to store the response under (default 'res'). If set to the same as 'requestField', filtered response and request properties will be merged. Set to null to exclude request from metadata
     requestFilter: function (req, propName) { return req[propName]; } // A function to filter/return request values, defaults to returning all values allowed by whitelist. If the function returns undefined, the key/value will not be included in the meta.
     requestWhitelist: [String] // Array of request properties to log. Overrides global requestWhitelist for this instance
     headerBlacklist: [String], // Array of headers to omit from logs. Applied after any previous filters.

package/index.d.ts

@@ -17,11 +17,13 @@ export interface FilterResponse extends Response {
     [other: string]: any;
 }
 
+export type ExceptionToMetaFunction = (err: Error) => object;
 export type DynamicMetaFunction = (req: Request, res: Response, err: Error) => object;
 export type DynamicLevelFunction = (req: Request, res: Response, err: Error) => string;
 export type RequestFilter = (req: FilterRequest, propName: string) => any;
 export type ResponseFilter = (res: FilterResponse, propName: string) => any;
 export type RouteFilter = (req: Request, res: Response) => boolean;
+export type ErrorRouteFilter = (req: Request, res: Response, err: Error) => boolean;
 export type MessageTemplate = string | ((req: Request, res: Response) => string);
 
 export interface BaseLoggerOptions {
@@ -68,16 +70,19 @@ export function logger(options: LoggerOptions): Handler;
 export interface BaseErrorLoggerOptions {
     baseMeta?: object;
     dynamicMeta?: DynamicMetaFunction;
+    exceptionToMeta?: ExceptionToMetaFunction;
     format?: Format;
     level?: string | DynamicLevelFunction;
     meta?: boolean;
     metaField?: string;
     requestField?: string;
+    responseField?: string;
     msg?: MessageTemplate;
     requestFilter?: RequestFilter;
     requestWhitelist?: string[];
     headerBlacklist?: string[];
     blacklistedMetaFields?: string[];
+    skip?: ErrorRouteFilter;
 }
 
 export interface ErrorLoggerOptionsWithTransports extends BaseErrorLoggerOptions {

package/package.json

@@ -17,7 +17,7 @@
     "middleware",
     "colors"
   ],
-  "version": "4.0.2",
+  "version": "4.0.3",
   "repository": {
     "type": "git",
     "url": "https://github.com/bithavoc/winston-middleware.git"
@@ -33,7 +33,7 @@
   },
   "dependencies": {
     "chalk": "^2.4.1",
-    "lodash": "^4.17.10"
+    "lodash": "^4.17.15"
   },
   "devDependencies": {
     "@types/express": "^4.17.1",
@@ -91,4 +91,4 @@
     }
   ],
   "types": "index.d.ts"
-}
+}