@ukhomeoffice/formio-gds-template 2.0.2 → 3.0.0-bravo

package/src/templates/gds/index.ts

@@ -31,46 +31,56 @@ import wizard from './wizard';
 import wizardHeader from './wizardHeader';
 import wizardNav from './wizardNav';
 
+// Unwrap CJS default exports to handle ESM/CJS interop in Vite.
+// Uses a generic so the return type matches the input type — no `any` needed.
+const unwrap = <T>(mod: T | { default: T }): T =>
+    (mod !== null && typeof mod === 'object' && 'default' in (mod as object))
+        ? (mod as { default: T }).default
+        : (mod as T);
+
 export default {
-    transform(type, text) {
+    transform(type: string, text: string): string {
         if (!text) {
             return text;
         }
         if (type === 'class') {
-            return this.cssClasses.hasOwnProperty(text.toString()) ? this.cssClasses[text.toString()] : text;
+            const key = text.toString();
+            return Object.prototype.hasOwnProperty.call(this.cssClasses, key)
+                ? this.cssClasses[key as keyof typeof this.cssClasses]
+                : text;
         }
         return text;
     },
     defaultIconset: 'fa',
-    iconClass,
-    cssClasses,
-    button,
-    checkbox,
-    columns,
-    component,
-    container,
-    datetime,
-    day,
-    datagrid,
-    datamap,
-    input,
-    editgrid,
-    field,
-    file,
-    fieldset,
-    label,
-    message,
-    panel,
-    radio,
-    select,
-    selectboxes,
-    selectOption,
-    survey,
-    table,
-    tab,
-    time,
-    warning,
-    wizard,
-    wizardHeader,
-    wizardNav,
+    iconClass: unwrap(iconClass),
+    cssClasses: unwrap(cssClasses),
+    button: unwrap(button),
+    checkbox: unwrap(checkbox),
+    columns: unwrap(columns),
+    component: unwrap(component),
+    container: unwrap(container),
+    datetime: unwrap(datetime),
+    day: unwrap(day),
+    datagrid: unwrap(datagrid),
+    datamap: unwrap(datamap),
+    input: unwrap(input),
+    editgrid: unwrap(editgrid),
+    field: unwrap(field),
+    file: unwrap(file),
+    fieldset: unwrap(fieldset),
+    label: unwrap(label),
+    message: unwrap(message),
+    panel: unwrap(panel),
+    radio: unwrap(radio),
+    select: unwrap(select),
+    selectboxes: unwrap(selectboxes),
+    selectOption: unwrap(selectOption),
+    survey: unwrap(survey),
+    table: unwrap(table),
+    tab: unwrap(tab),
+    time: unwrap(time),
+    warning: unwrap(warning),
+    wizard: unwrap(wizard),
+    wizardHeader: unwrap(wizardHeader),
+    wizardNav: unwrap(wizardNav),
 };

package/src/templates/gds/template.scss

@@ -82,6 +82,36 @@
 
 .govuk-details {
   margin-bottom: 0 !important;
+
+  // govuk-frontend@5.x sets font-weight:bold on the summary — reset to normal
+  &__summary {
+    font-weight: 400 !important;
+  }
+
+  &__summary-text,
+  &__summary:hover &__summary-text {
+    text-decoration: none;
+  }
+}
+
+// @formio/js@5.x injects error messages into messageContainer on container components
+// (datagrid, editgrid, datamap, panel) which causes double error messages since child
+// components already show their own errors. Hide the outer messageContainer for these types.
+.formio-component-datagrid,
+.formio-component-editgrid,
+.formio-component-datamap,
+.formio-component-panel,
+.formio-component-container,
+.formio-component-fieldset {
+  > [ref="messageContainer"] {
+    display: none;
+  }
+}
+
+// Form.io keeps conditionally hidden components in the DOM. Remove their
+// layout contribution as well as their contents.
+.formio-hidden {
+  display: none !important;
 }
 
 .small-button {
@@ -108,6 +138,13 @@
   border-top: none
 }
 
+// GOV.UK grid rows use negative side margins to offset column padding. In a
+// Form.io datagrid those margins can otherwise create a horizontal scroll area
+// on the tbody at fractional browser zoom levels.
+.datagrid-tbody {
+  overflow-x: hidden;
+}
+
 .gov-accordion-no-bottom {
   border-bottom: none !important;
 }
@@ -144,4 +181,14 @@
 
 .govuk-select.auto-height {
   height: auto;
-}
+}
+
+// govuk-frontend@5.4+ sets overflow:clip (with auto visible fallback) on
+// .govuk-form-group--error to contain the error border. This clips the focus
+// rings and left borders of nested formio child components. Reset it so
+// nested form groups are never clipped.
+.govuk-form-group--error {
+  .govuk-form-group {
+    overflow: visible;
+  }
+}

package/src/types.ts

@@ -0,0 +1,56 @@
+import type {
+    DayComponent,
+    DateTimeComponent,
+    TimeComponent as CoreTimeComponent,
+    SelectBoxesComponent,
+    DataMapComponent,
+    SelectComponent,
+} 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 `suffix` from the base so our wider `string | null` declaration wins
+    // the intersection (BaseComponent declares `suffix?: string`, which would
+    // collapse `string | null` back to `string` in a plain &-intersection).
+    // Also omit `fields` so we can extend it with hour/minute below.
+    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;
+        };
+    };
+
+// Re-export @formio/core schema types used as `declare component` overrides
+// in each GDS component class. Aliased to avoid colliding with the @formio/js
+// runtime class variables (e.g. `const Time = Components.components.time`).
+export type { CoreTimeComponent, SelectBoxesComponent, DataMapComponent, SelectComponent };

package/tsconfig.json

@@ -1,14 +1,30 @@
 {
   "compilerOptions": {
-    "target": "es5",
-    "module": "commonjs",
+    "target": "es2018",
+    "lib": ["es2018", "dom"],
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
     "preserveConstEnums": true,
     "outDir": "lib",
-    "noImplicitAny": false,
-    "sourceMap": false,
     "declaration": true,
+    "declarationMap": true,
+    "sourceMap": false,
     "rootDir": "src",
-    "esModuleInterop": true
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "noImplicitAny": true,
+    "strictNullChecks": true,
+    "strictFunctionTypes": true,
+    "strictBindCallApply": true,
+    "strictPropertyInitialization": true,
+    "noImplicitThis": true,
+    "alwaysStrict": true,
+    "useUnknownInCatchVariables": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true
   },
   "include": [
     "src/*.ts",

package/webpack.config.js

@@ -10,7 +10,7 @@ module.exports = {
         filename: 'gds.js',
     },
     externals: {
-        formiojs: 'Formio'
+        '@formio/js': 'Formio'
     },
     module: {
         rules: [

package/tslint.json

@@ -1,22 +0,0 @@
-{
-    "defaultSeverity": "error",
-    "extends": [
-        "tslint:recommended"
-    ],
-    "jsRules": {},
-    "rules": {
-        "quotemark": [true, "single", "avoid-escape", "avoid-template"],
-        "one-line": [false, "check-catch", "check-finally", "check-else"],
-        "object-literal-sort-keys": false,
-        "no-shadowed-variable": false,
-        "variable-name": {
-            "options": [
-                "allow-leading-underscore",
-                "allow-pascal-case",
-                "ban-keywords"
-            ]
-        },
-        "max-classes-per-file": [false]
-    },
-    "rulesDirectory": []
-}