@financial-times/dotcom-server-navigation 7.2.7 → 7.3.1

package/package.json

@@ -1,17 +1,16 @@
 {
   "name": "@financial-times/dotcom-server-navigation",
-  "version": "7.2.7",
+  "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,7 +18,7 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
-    "@financial-times/dotcom-types-navigation": "^7.2.7",
+    "@financial-times/dotcom-types-navigation": "file:../dotcom-types-navigation",
     "@types/deep-freeze": "^0.1.1",
     "deep-freeze": "0.0.1",
     "ft-poller": "^7.2.1",
@@ -35,6 +34,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",
@@ -44,4 +46,4 @@
   "volta": {
     "extends": "../../package.json"
   }
-}
+}

package/src/actions.ts

@@ -1,9 +0,0 @@
-import { TNavAction } from '@financial-times/dotcom-types-navigation'
-
-export function getSubscribeAction(): TNavAction {
-  return {
-    id: 'subscribe',
-    name: 'Subscribe for full access',
-    url: '/products?segmentId=4526c036-7527-ab37-9a29-0b0403fa0b5f'
-  }
-}

package/src/decorateMenuData.ts

@@ -1,53 +0,0 @@
-import { TNavMenuItem } from '@financial-times/dotcom-types-navigation'
-
-const isSelected = (url: string, currentPath: string): boolean => {
-  return url === currentPath
-}
-
-const isMenuItem = (item: any): boolean => {
-  return item.hasOwnProperty('label') && item.hasOwnProperty('url')
-}
-
-const decorateURL = (url: string, currentPath: string): string => {
-  if (url && url.includes('${currentPath}')) {
-    // Don't replace the URL placeholder with a barrier or error URL so that
-    // a user logging in is not redirected to a barrier or error!
-    const shouldReplace = !/\/(products|barriers|errors)/.test(currentPath)
-    const redirectPath = shouldReplace ? currentPath : '%2F'
-    return url.replace('${currentPath}', redirectPath)
-  }
-
-  return url
-}
-
-const decorateMenuItem = (item: TNavMenuItem, currentPath: string): void => {
-  item.url = decorateURL(item.url, currentPath)
-  item.selected = isSelected(item.url, currentPath)
-}
-
-// This is a recursive clone function that will decorate objects it recognises as links
-function cloneMenu(value: any, currentPath: string): any {
-  if (Array.isArray(value)) {
-    return value.map((item) => cloneMenu(item, currentPath))
-  }
-
-  if (Object(value) === value) {
-    const cloned = {}
-
-    for (const key of Object.keys(value)) {
-      cloned[key] = cloneMenu(value[key], currentPath)
-    }
-
-    if (isMenuItem(cloned)) {
-      decorateMenuItem(cloned as TNavMenuItem, currentPath)
-    }
-
-    return cloned
-  }
-
-  return value
-}
-
-export function decorateMenuData<Type>(menuData: Type, currentUrl: string): Type {
-  return cloneMenu(menuData, currentUrl)
-}

package/src/editions.ts

@@ -1,27 +0,0 @@
-import { TNavEdition, TNavEditions } from '@financial-times/dotcom-types-navigation'
-
-const availableEditions: TNavEdition[] = [
-  {
-    id: 'uk',
-    name: 'UK',
-    url: '/'
-  },
-  {
-    id: 'international',
-    name: 'International',
-    url: '/'
-  }
-]
-
-const editionIDs = availableEditions.map((edition) => edition.id)
-
-export function isEdition(editionID: string): boolean {
-  return editionIDs.includes(editionID)
-}
-
-export function getEditions(currentEdition: string): TNavEditions {
-  return {
-    current: availableEditions.find((edition) => edition.id === currentEdition),
-    others: availableEditions.filter((edition) => edition.id !== currentEdition)
-  }
-}

package/src/index.ts

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

package/src/navigation.ts

@@ -1,104 +0,0 @@
-import Poller from 'ft-poller'
-import httpError from 'http-errors'
-import deepFreeze from 'deep-freeze'
-import fetch from 'node-fetch'
-import {
-  TNavMenus,
-  TNavMenusForEdition,
-  TNavSubNavigation,
-  TNavEditions,
-  TNavAction
-} from '@financial-times/dotcom-types-navigation'
-import { selectMenuDataForEdition } from './selectMenuDataForEdition'
-import { decorateMenuData } from './decorateMenuData'
-import { getEditions, isEdition } from './editions'
-import { getSubscribeAction } from './actions'
-
-// Makes the navigation data completely immutable,
-// To modify the data, clone the parts you need to change then modify in your app
-const parseData = (data: any) => {
-  return deepFreeze(data)
-}
-
-const removeLeadingForwardSlash = (pagePath: string) => {
-  return pagePath.charAt(0) === '/' ? pagePath.substring(1) : pagePath
-}
-
-export type TNavOptions = {
-  menuUrl?: string
-  subNavigationUrl?: string
-  interval?: number
-}
-
-const defaults: TNavOptions = {
-  menuUrl: 'http://next-navigation.ft.com/v2/menus',
-  subNavigationUrl: 'http://next-navigation.ft.com/v2/hierarchy',
-  interval: 15 * 60 * 1000 // poll every 15 minutes
-}
-
-export class Navigation {
-  public options: TNavOptions
-  public poller: Poller
-  public initialPromise: Promise<void>
-  private menuData: TNavMenus
-
-  constructor(options: TNavOptions = {}) {
-    this.options = { ...defaults, ...options }
-
-    this.poller = new Poller({
-      url: this.options.menuUrl,
-      refreshInterval: this.options.interval,
-      parseData
-    })
-
-    this.initialPromise = this.poller.start({ initialRequest: true })
-  }
-
-  async getMenusData(): Promise<TNavMenus> {
-    // initialPromise does not return data but must resolve before `getData` can be called
-    await this.initialPromise
-
-    this.menuData = this.poller.getData()
-
-    return this.menuData
-
-  }
-
-  async getMenusFor(currentPath: string, currentEdition: string = 'uk'): Promise<TNavMenusForEdition> {
-    const menusData = await this.getMenusData()
-    const menusForEdition = selectMenuDataForEdition(menusData, currentEdition)
-
-    return decorateMenuData(menusForEdition, currentPath)
-  }
-
-  async getSubNavigationFor(path: string): Promise<TNavSubNavigation> {
-    const currentPage = removeLeadingForwardSlash(path)
-    const subNavigation = `${this.options.subNavigationUrl}/${currentPage}`
-    const response = await fetch(subNavigation)
-
-    if (response.ok) {
-      const data = await response.json()
-
-      const currentItem = { ...data.item, selected: true }
-
-      return {
-        breadcrumb: data.ancestors.concat(currentItem),
-        subsections: data.children
-      }
-    } else {
-      throw httpError(response.status, `Sub-navigation for ${currentPage} could not be found.`)
-    }
-  }
-
-  getEditionsFor(currentEdition: string = 'uk'): TNavEditions {
-    if (isEdition(currentEdition)) {
-      return getEditions(currentEdition)
-    } else {
-      throw Error(`The provided edition "${currentEdition}" is not a valid edition`)
-    }
-  }
-
-  getSubscribeAction(): TNavAction {
-    return getSubscribeAction()
-  }
-}

package/src/selectMenuDataForEdition.ts

@@ -1,26 +0,0 @@
-import { TNavMenuKeys, TNavMenus, TNavMenusForEdition } from '@financial-times/dotcom-types-navigation'
-
-const sharedMenuKeys: TNavMenuKeys[] = [
-  'account',
-  'anon',
-  'footer',
-  'navbar-simple',
-  'navbar-right',
-  'navbar-right-anon',
-  'user'
-]
-
-export function selectMenuDataForEdition(menuData: TNavMenus, currentEdition: string): TNavMenusForEdition {
-  const output = {
-    navbar: menuData[`navbar-${currentEdition}`],
-    drawer: menuData[`drawer-${currentEdition}`]
-  }
-
-  for (const key of sharedMenuKeys) {
-    if (menuData[key]) {
-      output[key] = menuData[key]
-    }
-  }
-
-  return output as TNavMenusForEdition
-}