@financial-times/dotcom-server-app-context 7.3.0 → 7.3.1

package/package.json

@@ -1,18 +1,17 @@
 {
   "name": "@financial-times/dotcom-server-app-context",
-  "version": "7.3.0",
+  "version": "7.3.1",
   "description": "",
   "main": "dist/node/index.js",
   "types": "src/index.ts",
   "scripts": {
     "generate-schema": "node scripts/schemaToMarkdown.js > schema.md",
     "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"
   },
@@ -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/schema.md

@@ -1,97 +0,0 @@
-# FT App Context Schema
-
-The schema defines the following properties:
-
-## `abTestState` (string)
-
-The A/B test flags data as a comma delimited string
-
-Additional restrictions:
-
-* Regex pattern: `^,*([0-9A-Za-z-_]+:[0-9A-Za-z-_]+,*)+$`
-
-## `appName` (string)
-
-The name of the application
-
-Additional restrictions:
-
-* Regex pattern: `^.+$`
-
-## `appVersion` (string)
-
-The running version of the app (usually a Git commit hash)
-
-Additional restrictions:
-
-* Regex pattern: `^.+$`
-
-## `conceptId` (string)
-
-The UUID of the concept on the current page
-
-Additional restrictions:
-
-* Regex pattern: `^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$`
-
-## `conceptType` (string)
-
-The type of concept on the current page
-
-Additional restrictions:
-
-* Regex pattern: `^http://www.ft.com/ontology/.+$`
-
-## `contentId` (string)
-
-The UUID of the content on the current page
-
-Additional restrictions:
-
-* Regex pattern: `^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$`
-
-## `contentType` (string)
-
-The type or sub-type of the content on the current page
-
-Additional restrictions:
-
-* Regex pattern: `^(article|video|audio|podcast|package|live-blog)$`
-
-## `edition` (string)
-
-The selected FT edition
-
-Additional restrictions:
-
-* Regex pattern: `^(uk|international)$`
-
-## `isProduction` (boolean)
-
-If the app is currently running in a production environment
-
-Default: `false`
-
-## `isUserLoggedIn` (boolean)
-
-If the visitor is signed in to an FT account
-
-Default: `false`
-
-## `product` (string)
-
-The product name
-
-Default: `"next"`
-
-Additional restrictions:
-
-* Regex pattern: `^.+$`
-
-## `publishReference` (string)
-
-The publish reference of the content on the current page
-
-Additional restrictions:
-
-* Regex pattern: `^.+$`

package/scripts/schemaToMarkdown.js

@@ -1,4 +0,0 @@
-const parse = require('json-schema-to-markdown')
-const schema = require('../src/schema.json')
-
-console.log(parse(schema)) // eslint-disable-line no-console

package/src/AppContext.ts

@@ -1,33 +0,0 @@
-import { TAppContext } from './types'
-import validate from './validate'
-import filterEmptyData from './filterEmptyData'
-
-export type TAppContextOptions = {
-  appContext?: Partial<TAppContext>
-}
-
-export class AppContext {
-  private data: Partial<TAppContext> = {}
-
-  constructor(options: TAppContextOptions = {}) {
-    const data = filterEmptyData({ ...options.appContext })
-
-    for (const [property, value] of Object.entries(data)) {
-      this.set(property, value)
-    }
-  }
-
-  get(property: string) {
-    return this.data[property]
-  }
-
-  set(property: string, value: any) {
-    if (validate(property, value)) {
-      this.data[property] = value
-    }
-  }
-
-  getAll(): Partial<TAppContext> {
-    return Object.freeze({ ...this.data })
-  }
-}

package/src/filterEmptyData.ts

@@ -1,19 +0,0 @@
-const isEmptyString = (value) => typeof value === 'string' && value.trim().length === 0
-
-const isDefined = (value) => value !== undefined && value !== null
-
-type AnyObject = {
-  [key: string]: any
-}
-
-export default function filterEmptyProperties(properties: AnyObject): AnyObject {
-  const result = {}
-
-  for (const [key, value] of Object.entries(properties)) {
-    if (isDefined(value) && !isEmptyString(value)) {
-      result[key] = value
-    }
-  }
-
-  return result
-}

package/src/index.ts

@@ -1,2 +0,0 @@
-export * from './AppContext'
-export type { TAppContext } from './types'

package/src/schema.json

@@ -1,88 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "type": "object",
-  "title": "FT App Context Schema",
-  "properties": {
-    "abTestState": {
-      "type": "string",
-      "description": "The A/B test flags data as a comma delimited string",
-      "examples": ["subscriberCohort:on,premiumCohort:on,nonUSACohort:on"],
-      "pattern": "^,*([0-9A-Za-z-_]+:[0-9A-Za-z-_]+,*)+$"
-    },
-    "appName": {
-      "type": "string",
-      "description": "The name of the application",
-      "examples": ["front-page", "stream-page", "article-page"],
-      "pattern": "^.+$"
-    },
-    "appVersion": {
-      "type": "string",
-      "description": "The running version of the app (usually a Git commit hash)",
-      "examples": ["882797258625531f20d604f6441ef8cfcb2d772b"],
-      "pattern": "^.+$"
-    },
-    "conceptId": {
-      "type": "string",
-      "description": "The UUID of the concept on the current page",
-      "examples": ["c5935758-7730-11e9-bbad-7c18c0ea0201"],
-      "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$"
-    },
-    "conceptType": {
-      "type": "string",
-      "description": "The type of concept on the current page",
-      "examples": ["http://www.ft.com/ontology/product/Brand", "http://www.ft.com/ontology/Location"],
-      "pattern": "^http://www.ft.com/ontology/.+$"
-    },
-    "contentId": {
-      "type": "string",
-      "description": "The UUID of the content on the current page",
-      "examples": ["c5935758-7730-11e9-bbad-7c18c0ea0201"],
-      "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$"
-    },
-    "contentType": {
-      "type": "string",
-      "description": "The type or sub-type of the content on the current page",
-      "examples": ["article", "video", "audio", "podcast", "package", "live-blog"],
-      "pattern": "^(article|video|audio|podcast|package|live-blog)$"
-    },
-    "edition": {
-      "type": "string",
-      "description": "The selected FT edition",
-      "examples": ["uk", "international"],
-      "pattern": "^(uk|international)$"
-    },
-    "isProduction": {
-      "type": "boolean",
-      "description": "If the app is currently running in a production environment",
-      "default": false
-    },
-    "isUserLoggedIn": {
-      "type": "boolean",
-      "description": "If the visitor is signed in to an FT account",
-      "default": false
-    },
-    "product": {
-      "type": "string",
-      "description": "The product name",
-      "default": "next",
-      "pattern": "^.+$"
-    },
-    "publishReference": {
-      "type": "string",
-      "description": "The publish reference of the content on the current page",
-      "examples": [
-        "tid_17wmwszvk3",
-        "SYNTHETIC-REQ-MONtid_UrnYVM6Waz_carousel_1534570047",
-        "republish_-453878e5-94e5-4e52-bfba-b16b024f31f8_carousel_1577700591"
-      ],
-      "pattern": "^.+$"
-    },
-    "pageKitVersion": {
-      "type": "string",
-      "description": "The version of Page Kit powering the app",
-      "examples": ["1.0.0"],
-      "pattern": "^.+$"
-    }
-  },
-  "additionalProperties": false
-}

package/src/types.d.ts

@@ -1,15 +0,0 @@
-export interface TAppContext {
-  appName: string
-  appVersion: string
-  product: string
-  edition: string
-  abTestState: string
-  contentId?: string
-  contentType?: string
-  conceptId?: string
-  conceptType?: string
-  isProduction: boolean
-  isUserLoggedIn?: boolean
-  publishReference?: string
-  [key: string]: any
-}

package/src/validate.ts

@@ -1,24 +0,0 @@
-import Ajv from 'ajv'
-import schema from './schema.json'
-
-const ajv = new Ajv()
-
-const isValid = ajv.compile(schema)
-
-export default function validate(field: string, value): boolean {
-  const data = { [field]: value }
-
-  if (isValid(data)) {
-    return true
-  } else {
-    let errorMessage = `Validation error: ${ajv.errorsText(isValid.errors)}, received "${value}"`
-    const hasErrorsForAdditionProperties = isValid.errors.some(
-      (error) => error.keyword === 'additionalProperties'
-    )
-    if (hasErrorsForAdditionProperties) {
-      errorMessage +=
-        '\nIf you want to share application specific data with the client, consider using @financial-times/dotcom-ui-data-embed.'
-    }
-    throw Error(errorMessage)
-  }
-}