@defra/fcp-sfd-frontend-engine 0.1.0

package/LICENSE

@@ -0,0 +1,8 @@
+The Open Government Licence (OGL) Version 3
+
+Copyright (c) 2025 Defra
+
+This source code is licensed under the Open Government Licence v3.0. To view this
+licence, visit www.nationalarchives.gov.uk/doc/open-government-licence/version/3
+or write to the Information Policy Team, The National Archives, Kew, Richmond,
+Surrey, TW9 4DU.

package/README.md

@@ -0,0 +1,48 @@
+# Frontend Engine
+
+## Overview
+
+This project aims to create a shared frontend engine used by both the internal and external frontend applications.
+
+The goal is to reduce duplicated code, improve consistency between applications, and simplify long-term maintenance while still allowing each application to evolve independently where needed.
+
+## Architecture Direction
+
+The frontend engine will contain shared frontend functionality such as:
+
+- shared components
+- utilities
+- validation
+- queries and mutations
+- presenters
+
+The internal and external applications will continue to own:
+
+- routes
+- authentication
+- app-specific pages and features
+
+## Development Approach
+
+We are starting with a small incremental implementation rather than a full migration.
+
+The initial focus is to:
+
+- identify common frontend patterns
+- extract reusable functionality into the engine
+- prove the shared architecture works cleanly
+- minimise disruption to the existing applications
+
+## Local Development
+
+During development, the applications will consume the engine as a local package dependency.
+
+Docker-based local development support will be used so engine changes can be picked up quickly during development.
+
+## Principles
+
+- keep the implementation simple and explicit
+- prefer shared reusable modules over duplication
+- avoid premature abstraction
+- maintain clear ownership boundaries between the engine and applications
+- evolve incrementally

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@defra/fcp-sfd-frontend-engine",
+  "version": "0.1.0",
+  "description": "Shared frontend engine used by both the internal and external frontend applications.",
+  "main": "./dist/index.cjs",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "scripts": {
+    "lint": "eslint",
+    "lint:fix": "eslint --fix",
+    "build": "tsup",
+    "test": "npm run build && vitest run --coverage",
+    "test:watch": "vitest"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/DEFRA/fcp-sfd-frontend-engine.git"
+  },
+  "keywords": [
+    "fcp-sfd-frontend",
+    "defra",
+    "fcp"
+  ],
+  "author": "Defra DDTS",
+  "contributors": [
+    "Rebecca Ransome <rebecca.ransome@defra.gov.uk>",
+    "Adam Kay <adam.kay@defra.gov.uk>"
+  ],
+  "license": "OGL-UK-3.0",
+  "type": "module",
+  "bugs": {
+    "url": "https://github.com/DEFRA/fcp-sfd-frontend-engine/issues"
+  },
+  "homepage": "https://github.com/DEFRA/fcp-sfd-frontend-engine#readme",
+  "devDependencies": {
+    "@vitest/coverage-v8": "4.0.16",
+    "eslint": "9.39.2",
+    "neostandard": "0.12.2",
+    "tsup": "8.5.0",
+    "vitest": "4.0.16"
+  },
+  "dependencies": {
+    "joi": "17.13.3"
+  }
+}

package/src/index.js

@@ -0,0 +1 @@
+export { mapPersonalBusinessDetails } from './mappers/personal-business-details-mapper.js'

package/src/mappers/personal-business-details-mapper.js

@@ -0,0 +1,25 @@
+/**
+ * Takes the raw data and maps it to a more usable format
+ *
+ * @param {Object} value - The data from the DAL
+ *
+ * @returns {Object} Formatted personal business details data
+ */
+
+export const mapPersonalBusinessDetails = (value) => {
+  return {
+    info: {
+      userName: [
+        value.customer.info.name.first,
+        value.customer.info.name.last
+      ].filter(Boolean).join(' ')
+    },
+    business: {
+      info: {
+        organisationId: value.business.organisationId ?? null,
+        sbi: value.business.sbi ?? null,
+        name: value.business.info.name ?? null
+      }
+    }
+  }
+}

package/tsup.config.js

@@ -0,0 +1,10 @@
+import { defineConfig } from 'tsup'
+
+export default defineConfig({
+  entry: ['src/index.js'],
+  format: ['esm', 'cjs'],
+  outDir: 'dist',
+  clean: true,
+  splitting: false,
+  sourcemap: false
+})