@ukhomeoffice/formio-gds-template 2.0.1 → 3.0.0-alpha

package/lib/templates/gds/message/index.js

@@ -1,4 +1,7 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-var form_ejs_1 = require("./form.ejs");
+const form_ejs_1 = __importDefault(require("./form.ejs"));
 exports.default = { form: form_ejs_1.default };

package/lib/templates/gds/panel/index.js

@@ -1,4 +1,7 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-var form_ejs_1 = require("./form.ejs");
+const form_ejs_1 = __importDefault(require("./form.ejs"));
 exports.default = { form: form_ejs_1.default };

package/lib/templates/gds/radio/index.js

@@ -1,4 +1,7 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-var form_ejs_1 = require("./form.ejs");
+const form_ejs_1 = __importDefault(require("./form.ejs"));
 exports.default = { form: form_ejs_1.default };

package/lib/templates/gds/select/index.js

@@ -1,4 +1,7 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-var form_ejs_1 = require("./form.ejs");
+const form_ejs_1 = __importDefault(require("./form.ejs"));
 exports.default = { form: form_ejs_1.default };

package/lib/templates/gds/selectOption/index.js

@@ -1,4 +1,7 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-var form_ejs_1 = require("./form.ejs");
+const form_ejs_1 = __importDefault(require("./form.ejs"));
 exports.default = { form: form_ejs_1.default };

package/lib/templates/gds/selectboxes/index.js

@@ -1,4 +1,7 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-var form_ejs_1 = require("./form.ejs");
+const form_ejs_1 = __importDefault(require("./form.ejs"));
 exports.default = { form: form_ejs_1.default };

package/lib/templates/gds/survey/index.js

@@ -1,4 +1,7 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-var form_ejs_1 = require("./form.ejs");
+const form_ejs_1 = __importDefault(require("./form.ejs"));
 exports.default = { form: form_ejs_1.default };

package/lib/templates/gds/tab/index.js

@@ -1,4 +1,7 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-var form_ejs_1 = require("./form.ejs");
+const form_ejs_1 = __importDefault(require("./form.ejs"));
 exports.default = { form: form_ejs_1.default };

package/lib/templates/gds/table/index.js

@@ -1,4 +1,7 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-var form_ejs_1 = require("./form.ejs");
+const form_ejs_1 = __importDefault(require("./form.ejs"));
 exports.default = { form: form_ejs_1.default };

package/lib/templates/gds/template.css

@@ -112,6 +112,18 @@
 .govuk-details {
   margin-bottom: 0 !important;
 }
+.govuk-details__summary {
+  font-weight: 400 !important;
+}
+
+.formio-component-datagrid > [ref=messageContainer],
+.formio-component-editgrid > [ref=messageContainer],
+.formio-component-datamap > [ref=messageContainer],
+.formio-component-panel > [ref=messageContainer],
+.formio-component-container > [ref=messageContainer],
+.formio-component-fieldset > [ref=messageContainer] {
+  display: none;
+}
 
 .small-button {
   padding: 0.25rem 0.5rem;
@@ -168,4 +180,8 @@
   height: auto;
 }
 
+.govuk-form-group--error .govuk-form-group {
+  overflow: visible;
+}
+
 /*# sourceMappingURL=template.css.map */

package/lib/templates/gds/template.css.map

@@ -1 +1 @@
-{"version":3,"sourceRoot":"","sources":["../../../src/templates/gds/template.scss","../../../node_modules/govuk-frontend/dist/govuk/vendor/_sass-mq.scss"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAKE;EACE;EACA;EACA;;AAGF;AAAA;EAEE;EACA;EACA;;;AAKJ;EACE;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;;;AAGF;EACE;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;;;AAGF;EACE;EACA;;;AAGF;EACE;IACE;;EAEF;IACE;IACA;IACA;IACA;IACA;IACA;IACA;IACA;;EAGF;IACE;;EAGF;IACE;IACA;;EAGF;IACE;;EAEF;IACE;;;AAKJ;EACE;;;AAGF;EACE;EACA;EACA;;;AAIF;EACE;;AAEA;EACE;EAGA;;;AAKJ;EACE;EACA;;;AAGF;EACE;;;ACqHM;EDhHJ;IACE;;;;AAMJ;EADF;IAEI;IACA;IACA;IACA;IACA;;;;AAIJ;EACE;EACA;EACA;;;AAGF;EACE;EACA;EACA;;;AAGF;EACE","file":"template.css"}
+{"version":3,"sourceRoot":"","sources":["../../../src/templates/gds/template.scss","../../../node_modules/govuk-frontend/dist/govuk/vendor/_sass-mq.scss"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAKE;EACE;EACA;EACA;;AAGF;AAAA;EAEE;EACA;EACA;;;AAKJ;EACE;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;;;AAGF;EACE;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;;;AAGF;EACE;EACA;;;AAGF;EACE;IACE;;EAEF;IACE;IACA;IACA;IACA;IACA;IACA;IACA;IACA;;EAGF;IACE;;EAGF;IACE;IACA;;EAGF;IACE;;EAEF;IACE;;;AAKJ;EACE;;AAGA;EACE;;;AAaF;AAAA;AAAA;AAAA;AAAA;AAAA;EACE;;;AAIJ;EACE;EACA;EACA;;;AAIF;EACE;;AAEA;EACE;EAGA;;;AAKJ;EACE;EACA;;;AAGF;EACE;;;ACkGM;ED7FJ;IACE;;;;AAMJ;EADF;IAEI;IACA;IACA;IACA;IACA;;;;AAIJ;EACE;EACA;EACA;;;AAGF;EACE;EACA;EACA;;;AAGF;EACE;;;AAQA;EACE","file":"template.css"}

package/lib/templates/gds/time/index.js

@@ -1,4 +1,7 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-var form_ejs_1 = require("./form.ejs");
+const form_ejs_1 = __importDefault(require("./form.ejs"));
 exports.default = { form: form_ejs_1.default };

package/lib/templates/gds/warning/index.js

@@ -1,4 +1,7 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-var form_ejs_1 = require("./form.ejs");
+const form_ejs_1 = __importDefault(require("./form.ejs"));
 exports.default = { form: form_ejs_1.default };

package/lib/templates/gds/wizard/index.js

@@ -1,4 +1,7 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-var form_ejs_1 = require("./form.ejs");
+const form_ejs_1 = __importDefault(require("./form.ejs"));
 exports.default = { form: form_ejs_1.default };

package/lib/templates/gds/wizardHeader/index.js

@@ -1,4 +1,7 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-var form_ejs_1 = require("./form.ejs");
+const form_ejs_1 = __importDefault(require("./form.ejs"));
 exports.default = { form: form_ejs_1.default };

package/lib/templates/gds/wizardNav/index.js

@@ -1,4 +1,7 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-var form_ejs_1 = require("./form.ejs");
+const form_ejs_1 = __importDefault(require("./form.ejs"));
 exports.default = { form: form_ejs_1.default };

package/lib/templates/index.d.ts

@@ -1,8 +1,8 @@
 declare const _default: {
     gds: {
-        transform(type: any, text: any): any;
+        transform(type: string, text: string): any;
         defaultIconset: string;
-        iconClass: (iconset: any, name: any, spinning: any) => string;
+        iconClass: (iconset: string, name: string, spinning: boolean) => string;
         cssClasses: {
             'has-error': string;
             'formio-tab-link-container-active': string;

package/lib/templates/index.js

@@ -1,6 +1,9 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-var gds_1 = require("./gds");
+const gds_1 = __importDefault(require("./gds"));
 exports.default = {
     gds: gds_1.default,
 };

package/lib/types.d.ts

@@ -0,0 +1,36 @@
+import type { DayComponent, DateTimeComponent, TimeComponent as CoreTimeComponent, SelectBoxesComponent, DataMapComponent } from '@formio/core';
+/**
+ * Minimal interface for DOM input-like elements.
+ * Used as the typed parameter in TimeHelper methods so callers can pass any
+ * object that has a writable `.value: string` (e.g. HTMLInputElement).
+ */
+export interface InputElementLike {
+    value: string;
+}
+/**
+ * The shape of a single GDS date/time field definition.
+ * Extends the base formio field definition with an optional placeholder.
+ */
+export type GDSFieldDefinition = {
+    type?: string;
+    placeholder?: string;
+    required?: boolean;
+};
+/**
+ * Component schema for GDSDatetimeComponent.
+ *
+ * GDSDatetimeComponent extends the formio Day component but adds hour/minute
+ * fields (from a datetime hybrid) and uses datePicker / defaultDate from
+ * DateTimeComponent. This type captures the full shape of `this.component`
+ * as used in GDSDatetimeComponent.
+ */
+export type GDSDatetimeComponentSchema = Omit<DayComponent, 'suffix' | 'fields'> & Pick<DateTimeComponent, 'datePicker' | 'defaultDate'> & {
+    /** suffix is set to null in init() — null must be allowed */
+    suffix?: string | null;
+    /** fields extended with GDS hour/minute additions */
+    fields: DayComponent['fields'] & {
+        hour?: GDSFieldDefinition;
+        minute?: GDSFieldDefinition;
+    };
+};
+export type { CoreTimeComponent, SelectBoxesComponent, DataMapComponent };

package/lib/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,12 +1,14 @@
 {
   "name": "@ukhomeoffice/formio-gds-template",
-  "version": "2.0.1",
-  "description": "Gov UK design system formio templates",
+  "version": "3.0.0-alpha",
+  "description": "Gov UK design system formio templates — upgraded to @formio/js@5.x",
   "publishConfig": {
     "access": "public"
   },
   "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "scripts": {
+    "prepack": "npm run build",
     "test:coverage": "nyc --reporter=text mocha --reporter spec './{,!(node_modules)/**/}*.spec.js'",
     "test": "mocha --require ts-node/register --reporter spec './{,!(node_modules)/**/}*.spec.ts'",
     "build-sass": "sass src/templates/gds/template.scss lib/templates/gds/template.css",
@@ -15,8 +17,8 @@
     "watch": "concurrently \"npm run watch-ts\" \"npm run watch-sass\"",
     "build": "tsc && gulp templates && npm run build-sass && webpack",
     "tag": "VERSION=$(cat package.json | grep version | head -1 | awk -F: '{ print $2 }' | sed 's/[\",]//g' | tr -d '[[:space:]]');git add -A; git commit -nm \"Build $Version\";git push origin master;git tag v$VERSION;git push origin --tags;",
-    "lint": "tslint --project tsconfig.json",
-    "lint:fix": "tslint --project tsconfig.json --fix",
+    "lint": "eslint 'src/**/*.ts'",
+    "lint:fix": "eslint 'src/**/*.ts' --fix",
     "prepublish": "npm run build"
   },
   "pre-commit": [
@@ -40,13 +42,15 @@
   },
   "homepage": "https://github.com/UKHomeOffice/formio-gds-template#readme",
   "peerDependencies": {
-    "formiojs": "^4.9.26",
+    "@formio/core": "^2.0.0",
+    "@formio/js": "^5.0.0",
     "govuk-frontend": "^5.0.0"
   },
   "dependencies": {
     "lodash": "4.17.21"
   },
   "devDependencies": {
+    "@formio/core": "^2.0.0",
     "@types/chai": "^4.3.16",
     "@types/ejs": "^3.1.5",
     "@types/lodash": "^4.17.5",
@@ -58,7 +62,7 @@
     "chai": "^5.1.1",
     "concurrently": "^8.2.2",
     "css-loader": "^7.1.2",
-    "formiojs": "^4.19.4",
+    "@formio/js": "^5.0.0",
     "govuk-frontend": "^5.4.0",
     "gulp": "^4.0.2",
     "gulp-insert": "^0.5.0",
@@ -74,7 +78,9 @@
     "style-loader": "^4.0.0",
     "ts-node": "^10.9.2",
     "ts-sinon": "^2.0.2",
-    "tslint": "^6.1.2",
+    "eslint": "^9.0.0",
+    "@typescript-eslint/parser": "^8.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.0.0",
     "typed-scss-modules": "^8.0.1",
     "typescript": "^5.5.2",
     "webpack": "^5.92.1",

package/src/components/datamap/GDSDataMap.ts

@@ -1,23 +1,14 @@
-import {Components} from 'formiojs';
+import { Components } from '@formio/js';
+import { DataMapComponent } from '../../types';
 
 const Field = Components.components.field;
 const DataMap = Components.components.datamap;
 
 export default class GDSDataMap extends DataMap {
-    private getRows: any;
-    private hasRowGroups: any;
-    private getGroups: any;
-    private visibleColumns: any;
-    private hasAddButton: any;
-    private hasRemoveButtons: any;
-    private hasTopSubmit: any;
-    private hasBottomSubmit: any;
-    private hasExtraColumn: any;
-    private datagridKey: any;
-    private allowReorder: any;
-    private getColumns: any;
+    // Narrow the inherited `component: any` using the @formio/core DataMapComponent schema.
+    declare component: DataMapComponent;
 
-    public render() {
+    public render(): string {
         const columns = this.getColumns();
         return Field.prototype.render.call(this, this.renderTemplate('datamap', {
             rows: this.getRows(),