@financial-times/dotcom-middleware-asset-loader 7.3.1 → 7.3.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@financial-times/dotcom-middleware-asset-loader",
-  "version": "7.3.1",
+  "version": "7.3.2",
   "description": "",
   "main": "dist/node/index.js",
   "types": "src/index.ts",
@@ -32,7 +32,8 @@
     "npm": "7.x || 8.x"
   },
   "files": [
-    "dist/"
+    "dist/",
+    "src/"
   ],
   "repository": {
     "type": "git",

package/src/__test__/createMiddleware.spec.ts

@@ -0,0 +1,35 @@
+import subject from '../createMiddleware'
+import httpMocks from 'node-mocks-http'
+
+let instance
+let request
+let response
+let next
+
+jest.mock('@financial-times/dotcom-server-asset-loader')
+
+describe('dotcom-middleware-asset-loader/src/createMiddleware', () => {
+  beforeEach(() => {
+    instance = subject({})
+    request = httpMocks.createRequest({ app: { locals: {} } })
+    response = httpMocks.createResponse()
+    next = jest.fn()
+  })
+
+  afterEach(() => {
+    instance = null
+    request = null
+    response = null
+    next = null
+  })
+
+  it('calls the fallthrough function', () => {
+    instance(request, response, next)
+    expect(next).toHaveBeenCalled()
+  })
+
+  it('adds an instance of the asset loader to response.locals', () => {
+    instance(request, response, next)
+    expect(response.locals.assetLoader).toBeDefined()
+  })
+})

package/src/__test__/index.spec.ts

@@ -0,0 +1,42 @@
+import { init } from '../index'
+
+let instanceWithStaticHost
+let instanceNoStaticHost
+
+jest.mock('@financial-times/dotcom-server-asset-loader')
+
+describe('dotcom-middleware-asset-loader', () => {
+  beforeEach(() => {
+    instanceWithStaticHost = init({ hostStaticAssets: true })
+    instanceNoStaticHost = init({ hostStaticAssets: false })
+  })
+
+  afterEach(() => {
+    instanceWithStaticHost = null
+    instanceNoStaticHost = null
+  })
+
+  it('returns an array of handler functions', () => {
+    expect(instanceWithStaticHost).toBeInstanceOf(Array)
+
+    instanceWithStaticHost.forEach((item) => {
+      expect(item).toBeInstanceOf(Function)
+    })
+  })
+
+  describe('with hostStaticAssets enabled', () => {
+    it('returns multiple handlers', () => {
+      expect(instanceWithStaticHost).toHaveLength(2)
+    })
+
+    it('returns an instance of the router', () => {
+      expect(instanceWithStaticHost[1].name).toEqual('router')
+    })
+  })
+
+  describe('without hostStaticAssets enabled', () => {
+    it('returns one handler', () => {
+      expect(instanceNoStaticHost).toHaveLength(1)
+    })
+  })
+})

package/src/createMiddleware.ts

@@ -0,0 +1,12 @@
+import { AssetLoader } from '@financial-times/dotcom-server-asset-loader'
+import { MiddlewareOptions } from './options'
+import { Handler, Request, Response, NextFunction } from 'express'
+
+export default (options: MiddlewareOptions): Handler => {
+  const loader = new AssetLoader(options)
+
+  return (_: Request, response: Response, next: NextFunction) => {
+    response.locals.assetLoader = loader
+    next()
+  }
+}

package/src/createStaticHost.ts

@@ -0,0 +1,8 @@
+import express, { Handler } from 'express'
+import { MiddlewareOptions } from './options'
+
+export default (options: MiddlewareOptions): Handler => {
+  const router = express.Router()
+  router.use(options.publicPath, express.static(options.fileSystemPath))
+  return router
+}

package/src/index.ts

@@ -0,0 +1,23 @@
+import path from 'path'
+import { Handler } from 'express'
+import { MiddlewareOptions } from './options'
+import createMiddleware from './createMiddleware'
+import createStaticHost from './createStaticHost'
+
+const defaultOptions: MiddlewareOptions = {
+  hostStaticAssets: false,
+  publicPath: '/public',
+  fileSystemPath: path.resolve('./public')
+}
+
+export function init(userOptions: MiddlewareOptions): Handler[] {
+  const options: MiddlewareOptions = { ...defaultOptions, ...userOptions }
+
+  const stack = [createMiddleware(options)]
+
+  if (options.hostStaticAssets) {
+    stack.push(createStaticHost(options))
+  }
+
+  return stack
+}

package/src/options.d.ts

@@ -0,0 +1,9 @@
+import { AssetLoaderOptions } from '@financial-times/dotcom-server-asset-loader'
+
+export interface MiddlewareOptions extends AssetLoaderOptions {
+  /**
+   * Set to true if assets should be served from a local directory
+   * @default false
+   */
+  hostStaticAssets?: boolean
+}