feat(serve-favicon): add serve-favicon middleware

package.json

@@ -44,6 +44,7 @@
     "@types/morgan": "^1.7.35",
     "@types/node": "^8.0.53",
     "@types/response-time": "^2.3.2",
+    "@types/serve-favicon": "^2.2.30",
     "@types/sinon": "^4.0.0",
     "chai": "^4.1.2",
     "coveralls": "^3.0.0",

src/serve-favicon/index.spec.ts

@@ -0,0 +1,34 @@
+import { ServeFaviconMiddleware } from './index';
+import { expect } from 'chai';
+
+describe('ServeFaviconMiddleware', () => {
+    let middleware: ServeFaviconMiddleware;
+    describe('properly configured', () => {
+        beforeEach(() => {
+            ServeFaviconMiddleware.configure('./lerna.json', {});
+            middleware = new ServeFaviconMiddleware();
+        });
+
+        it('should be defined', () => {
+            expect(middleware).to.not.be.undefined;
+        });
+
+        it('should have a function called resolve', () => {
+            expect(middleware.resolve).to.be.instanceof(Function);
+        });
+
+        it('should should return a middleware from calling resolve', () => {
+            expect(middleware.resolve()).to.be.an.instanceof(Function);
+        });
+        afterEach(() => {
+            ServeFaviconMiddleware.configure(undefined);
+        });
+    });
+
+    describe('not configured', () => {
+        middleware = new ServeFaviconMiddleware();
+        it('should should return a middleware from calling resolve', () => {
+            expect(middleware.resolve.bind(middleware)).to.throw(Error);
+        });
+    });
+});

src/serve-favicon/index.ts

@@ -0,0 +1,29 @@
+import * as serveFavicon from 'serve-favicon';
+
+import { Middleware, NestMiddleware } from '@nestjs/common';
+
+import { RequestHandler } from 'express';
+
+@Middleware()
+export class ServeFaviconMiddleware implements NestMiddleware {
+
+    public static configure(path: string, opts?: ServeFaviconOptions) {
+        this.path = path;
+        this.options = opts;
+    }
+
+    private static path: string;
+    private static options: ServeFaviconOptions;
+
+    public resolve(...args: any[]): RequestHandler {
+        if (ServeFaviconMiddleware.path) {
+            return serveFavicon(ServeFaviconMiddleware.path, ServeFaviconMiddleware.options);
+        } else {
+            throw new Error('ServeFaviconMiddleware requires a path in configure.');
+        }
+    }
+}
+
+export interface ServeFaviconOptions {
+    maxAge?: number;
+}

src/serve-favicon/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@nest-middlewares/serve-favicon",
+  "version": "1.0.0",
+  "description": "NestJS Middleware for Serve Favicon",
+  "main": "index",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/wbhob/nest-middlewares.git"
+  },
+  "keywords": [
+    "nest",
+    "middlewares",
+    "express",
+    "node"
+  ],
+  "author": "Wilson Hobbs <wilsonhobbs1@gmail.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/wbhob/nest-middlewares/issues"
+  },
+  "homepage": "https://github.com/wbhob/nest-middlewares#readme",
+  "peerDependencies": {
+    "@nestjs/common": "^4.0.0"
+  },
+  "dependencies": {
+    "serve-favicon": "^2.4.5"
+  }
+}