@financial-times/dotcom-ui-flags 7.3.0 → 7.3.2

package/package.json

@@ -1,19 +1,18 @@
 {
   "name": "@financial-times/dotcom-ui-flags",
-  "version": "7.3.0",
+  "version": "7.3.2",
   "description": "",
   "main": "component.js",
   "browser": "browser.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",
     "clean:install": "npm run clean && npm i",
-    "build:node": "npm run tsc -- --module commonjs --outDir ./dist/node",
-    "build:browser": "npm run tsc -- --module es2015 --outDir ./dist/browser",
+    "build:browser": "tsc --module es2015 --outDir ./dist/browser",
+    "build:node": "tsc",
     "build": "npm run build:node && npm run build:browser",
     "dev": "echo -n node browser | parallel -u -d ' ' npm run build:{} -- --watch",
     "preinstall": "[ \"$INIT_CWD\" != \"$PWD\" ] || npm_config_yes=true npx check-engine"
@@ -26,11 +25,18 @@
     "npm": "7.x || 8.x"
   },
   "dependencies": {
-    "@financial-times/dotcom-ui-data-embed": "^7.3.0"
+    "@financial-times/dotcom-ui-data-embed": "file:../dotcom-ui-data-embed"
   },
   "peerDependencies": {
     "react": "16.x || 17.x"
   },
+  "files": [
+    "dist/",
+    "src/",
+    "browser.js",
+    "component.js",
+    "server.js"
+  ],
   "repository": {
     "type": "git",
     "repository": "https://github.com/Financial-Times/dotcom-page-kit.git",
@@ -44,4 +50,4 @@
     "check-engine": "^1.10.1",
     "react": "^16.8.6"
   }
-}
+}

package/src/__test__/client/Flags.spec.ts

@@ -0,0 +1,32 @@
+import Subject from '../../client/Flags'
+
+const fixture = { foo: 1, bar: true }
+
+describe('dotcom-ui-flags/src/client/Flags', () => {
+  let instance
+
+  beforeEach(() => {
+    instance = new Subject(fixture)
+  })
+
+  describe('.get()', () => {
+    it('returns the value of a flag which exists', () => {
+      expect(instance.get('foo')).toBe(1)
+      expect(instance.get('bar')).toBe(true)
+    })
+
+    it('returns undefined for flags which do not exist', () => {
+      expect(instance.get('baz')).toBeUndefined()
+    })
+  })
+
+  describe('.getAll()', () => {
+    it('returns all flags data', () => {
+      expect(instance.getAll()).toEqual(fixture)
+    })
+
+    it('freezes the flags data', () => {
+      expect(Object.isFrozen(instance.getAll())).toBe(true)
+    })
+  })
+})

package/src/__test__/client/loadFlags.spec.ts

@@ -0,0 +1,36 @@
+/**
+ * @jest-environment jsdom
+ */
+
+import subject from '../../client/loadFlags'
+import { SCRIPT_ELEMENT_ID } from '../../constants'
+
+describe('dotcom-ui-flags/src/client/loadFlags', () => {
+  describe('when there is a configuration object', () => {
+    beforeEach(() => {
+      document.body.innerHTML = `
+        <script id="${SCRIPT_ELEMENT_ID}">{"foo":1,"bar":true,"baz":"qux"}</script>
+      `
+    })
+
+    it('returns a frozen object', () => {
+      const result = subject()
+
+      expect(result).toEqual({ foo: 1, bar: true, baz: 'qux' })
+      expect(Object.isFrozen(result)).toBe(true)
+    })
+  })
+
+  describe('when there is no a configuration object', () => {
+    beforeEach(() => {
+      document.body.innerHTML = ''
+    })
+
+    it('returns a frozen empty object', () => {
+      const result = subject()
+
+      expect(result).toEqual({})
+      expect(Object.isFrozen(result)).toBe(true)
+    })
+  })
+})

package/src/__test__/components/FlagsEmbed.spec.ts

@@ -0,0 +1,14 @@
+import renderer from 'react-test-renderer'
+import { FlagsEmbed as subject } from '../../components/FlagsEmbed'
+
+const flags = {
+  foo: 1,
+  baz: 'qux'
+}
+
+describe('dotcom-ui-flags/src/components/FlagsEmbed', () => {
+  it('renders a script element containing flags', () => {
+    const tree = renderer.create(subject({ flags }))
+    expect(tree).toMatchSnapshot()
+  })
+})

package/src/__test__/components/__snapshots__/FlagsEmbed.spec.ts.snap

@@ -0,0 +1,13 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`dotcom-ui-flags/src/components/FlagsEmbed renders a script element containing flags 1`] = `
+<script
+  dangerouslySetInnerHTML={
+    Object {
+      "__html": "{\\"foo\\":1,\\"baz\\":\\"qux\\"}",
+    }
+  }
+  id="page-kit-flags-embed"
+  type="application/json"
+/>
+`;

package/src/__test__/server/formatFlagsJSON.spec.ts

@@ -0,0 +1,10 @@
+import subject from '../../server/formatFlagsJSON'
+
+const fixture = Object.freeze({ foo: 1, bar: false, baz: 'qux' })
+
+describe('dotcom-ui-flags/src/server/formatFlagsJSON', () => {
+  it('filters out properties with falsey values', () => {
+    const result = subject(fixture)
+    expect(result).toStrictEqual({ foo: 1, baz: 'qux' })
+  })
+})