From c8f7a59cc8a61416cc0dfbba0f7c2f80688f636f Mon Sep 17 00:00:00 2001
From: shrey <shrey-jain@hotmail.com>
Date: Sun, 4 Mar 2018 12:46:27 -0500
Subject: [PATCH] Add types for `express-bunyan-logger` module.

---
 .../express-bunyan-logger-tests.ts            | 24 +++++++++++++
 types/express-bunyan-logger/index.d.ts        | 34 +++++++++++++++++++
 types/express-bunyan-logger/tsconfig.json     | 23 +++++++++++++
 types/express-bunyan-logger/tslint.json       |  1 +
 4 files changed, 82 insertions(+)
 create mode 100644 types/express-bunyan-logger/express-bunyan-logger-tests.ts
 create mode 100644 types/express-bunyan-logger/index.d.ts
 create mode 100644 types/express-bunyan-logger/tsconfig.json
 create mode 100644 types/express-bunyan-logger/tslint.json

diff --git a/types/express-bunyan-logger/express-bunyan-logger-tests.ts b/types/express-bunyan-logger/express-bunyan-logger-tests.ts
new file mode 100644
index 0000000000..daac949c0e
--- /dev/null
+++ b/types/express-bunyan-logger/express-bunyan-logger-tests.ts
@@ -0,0 +1,24 @@
+import Bunyan = require('bunyan');
+import expressBunyan = require('express-bunyan-logger');
+
+// works with no options
+const middleware = expressBunyan({});
+const middleware2 = expressBunyan.errorLogger({});
+
+// format accepts both string and function
+const middleware3 = expressBunyan({
+    format: ':name'
+});
+const middleware4 = expressBunyan({
+    format(meta: any) {
+        return 'foo';
+    }
+});
+
+// works when provided a bunyan logger
+const logger = Bunyan.createLogger({
+    name: 'myLogger'
+});
+const middleware5 = expressBunyan({
+    logger
+});
diff --git a/types/express-bunyan-logger/index.d.ts b/types/express-bunyan-logger/index.d.ts
new file mode 100644
index 0000000000..aa9c5cc831
--- /dev/null
+++ b/types/express-bunyan-logger/index.d.ts
@@ -0,0 +1,34 @@
+// Type definitions for express-bunyan-logger 1.3
+// Project: https://github.com/villadora/express-bunyan-logger
+// Definitions by: Shrey Jain <https://github.com/shreyjain1994>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+import Bunyan = require('bunyan');
+import express = require('express');
+
+export = Factory;
+
+declare function Factory(options?: Factory.Options): express.RequestHandler;
+
+declare namespace Factory {
+    type FormatFunction = (meta: any) => string;
+    type IncludesFunction = (req: express.Request, res: express.Response) => any;
+    type RequestIdGenFunction = (req: express.Request) => string;
+    type LevelFunction = (status: number, err: Error | null, meta: any) => string;
+
+    interface Options {
+        logger?: Bunyan;
+        format?: string | FormatFunction;
+        parseUA?: boolean;
+        levelFn?: LevelFunction;
+        includesFn?: IncludesFunction;
+        excludes?: string[];
+        obfuscate?: string[];
+        obfuscatePlaceholder?: string;
+        serializers?: { [field: string]: Bunyan.Serializer };
+        immediate?: boolean;
+        genReqId?: RequestIdGenFunction;
+    }
+
+    function errorLogger(options?: Options): express.ErrorRequestHandler;
+}
diff --git a/types/express-bunyan-logger/tsconfig.json b/types/express-bunyan-logger/tsconfig.json
new file mode 100644
index 0000000000..8079293b99
--- /dev/null
+++ b/types/express-bunyan-logger/tsconfig.json
@@ -0,0 +1,23 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": [
+            "es6"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictNullChecks": true,
+        "strictFunctionTypes": true,
+        "baseUrl": "../",
+        "typeRoots": [
+            "../"
+        ],
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "express-bunyan-logger-tests.ts"
+    ]
+}
diff --git a/types/express-bunyan-logger/tslint.json b/types/express-bunyan-logger/tslint.json
new file mode 100644
index 0000000000..3db14f85ea
--- /dev/null
+++ b/types/express-bunyan-logger/tslint.json
@@ -0,0 +1 @@
+{ "extends": "dtslint/dt.json" }