@financial-times/dotcom-middleware-navigation 7.3.0 → 7.3.1

package/package.json

@@ -1,17 +1,16 @@
 {
   "name": "@financial-times/dotcom-middleware-navigation",
-  "version": "7.3.0",
+  "version": "7.3.1",
   "description": "",
   "main": "dist/node/index.js",
   "types": "src/index.ts",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "tsc": "../../node_modules/.bin/tsc --incremental",
     "clean": "npm run clean:dist && npm run clean:node_modules",
     "clean:dist": "rm -rf dist",
     "clean:node_modules": "rm -rf node_modules",
+    "build:node": "tsc",
     "build": "npm run build:node",
-    "build:node": "npm run tsc -- --module commonjs --outDir ./dist/node",
     "dev": "npm run build:node -- --watch",
     "preinstall": "[ \"$INIT_CWD\" != \"$PWD\" ] || npm_config_yes=true npx check-engine"
   },
@@ -19,8 +18,8 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
-    "@financial-times/dotcom-server-navigation": "^7.3.0",
-    "@financial-times/dotcom-types-navigation": "^7.3.0"
+    "@financial-times/dotcom-server-navigation": "file:../../packages/dotcom-server-navigation",
+    "@financial-times/dotcom-types-navigation": "file:../dotcom-types-navigation"
   },
   "devDependencies": {
     "check-engine": "^1.10.1",
@@ -30,6 +29,9 @@
     "node": ">= 14.0.0",
     "npm": "7.x || 8.x"
   },
+  "files": [
+    "dist/"
+  ],
   "repository": {
     "type": "git",
     "repository": "https://github.com/Financial-Times/dotcom-page-kit.git",
@@ -39,4 +41,4 @@
   "volta": {
     "extends": "../../package.json"
   }
-}
+}

package/src/handleEdition.ts

@@ -1,28 +0,0 @@
-import { isEdition } from '@financial-times/dotcom-server-navigation'
-import { Request, Response } from 'express'
-
-const defaultEdition = 'uk'
-
-export default (request: Request, response: Response): string => {
-  // NOTE: The FT-Edition header is set by the CDN and/or next-router...
-  // If an edition is selected with a cookie or query string it will be set to that.
-  // Otherwise the router will choose the best setting based on GeoIP.
-  // <https://github.com/Financial-Times/ft.com-cdn/blob/HEAD/src/vcl/next-editions.vcl>
-  // <https://github.com/Financial-Times/next-router/blob/HEAD/server/middleware/editions.js>
-  let currentEdition = request.get('FT-Edition') || defaultEdition
-
-  if (typeof request.query.edition === 'string' && isEdition(request.query.edition)) {
-    currentEdition = request.query.edition
-
-    response.cookie('next-edition', currentEdition, {
-      domain: 'ft.com',
-      maxAge: 1000 * 60 * 60 * 24 * 365 // 1 year
-    })
-  }
-
-  // NOTE: n-express overrides res.set() and res.vary() in order to merge all vary headers together.
-  // <https://github.com/Financial-Times/n-express/blob/HEAD/src/middleware/vary.js>
-  response.vary('FT-Edition')
-
-  return currentEdition
-}

package/src/index.ts

@@ -1 +0,0 @@
-export * from './navigation'

package/src/navigation.ts

@@ -1,57 +0,0 @@
-import { Request, Response, NextFunction } from 'express'
-import { TNavigationData } from '@financial-times/dotcom-types-navigation'
-import { Navigation, TNavOptions } from '@financial-times/dotcom-server-navigation'
-import handleEdition from './handleEdition'
-import normalizePath from './normalizePath'
-
-type MiddlewareOptions = TNavOptions & {
-  enableSubNavigation?: boolean
-  getCurrentPath?: Function
-}
-
-const defaultOptions: MiddlewareOptions = {
-  enableSubNavigation: false,
-  getCurrentPath: (request) => normalizePath(request.get('ft-vanity-url') || request.path)
-}
-
-export const init = (userOptions: MiddlewareOptions = {}) => {
-  const options = { ...defaultOptions, ...userOptions }
-  const navigation = new Navigation(options)
-
-  // Not all pages appear in the navigation so this request will fail often.
-  // Because it's not critical, ignore the error and move on.
-  const getSubNavigationFor = (currentPath) => navigation.getSubNavigationFor(currentPath).catch(() => {})
-
-  return async (request: Request, response: Response, next: NextFunction) => {
-    try {
-      // The vanity URL will usually be referenced in the navigation data
-      // rather than the underlying path, so prefer that when available.
-      // <https://github.com/Financial-Times/ft.com-cdn/blob/4841fbf100e1c561a2f6729b9921ec12bb6b837c/src/vcl/next-preflight.vcl#L213-L219>
-      // NOTE: Next router sets the vanity header inc. any query string so it must be normalized.
-      const currentPath = options.getCurrentPath(request)
-      const currentEdition = handleEdition(request, response)
-
-      const [menusData, subNavigationData] = await Promise.all([
-        navigation.getMenusFor(currentPath, currentEdition),
-        options.enableSubNavigation ? getSubNavigationFor(currentPath) : null
-      ])
-
-      const editions = navigation.getEditionsFor(currentEdition)
-      const subscribeAction = navigation.getSubscribeAction()
-
-      const navigationData: TNavigationData = {
-        editions,
-        subscribeAction,
-        currentPath,
-        ...menusData,
-        ...subNavigationData
-      }
-
-      response.locals.navigation = navigationData
-
-      next()
-    } catch (error) {
-      next(error)
-    }
-  }
-}

package/src/normalizePath.ts

@@ -1,6 +0,0 @@
-import url from 'url'
-
-export default function normalizePath(currentPath: string): string {
-  // NOTE: We're using Node's old URL API because it can handle partial URLs
-  return url.parse(currentPath).pathname || ''
-}