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

package/src/components/datetime/GDSDatetimeComponent.ts

@@ -1,34 +1,54 @@
-import {Components} from 'formiojs';
-import FormioUtils from 'formiojs/utils';
+import { Components } from '@formio/js';
+import { Utils as FormioUtils } from '@formio/js';
 import * as _ from 'lodash';
 import moment from 'moment';
 import TimeHelper from '../util/TimeHelper';
+import { GDSDatetimeComponentSchema } from '../../types';
 
 const Field = Components.components.field;
 const Day = Components.components.day;
 
-// @ts-ignore
 export default class GDSDatetimeComponent extends Day {
 
-    get format() {
+    // Narrow the inherited `component: any` to the GDS datetime schema type.
+    // @formio/core provides the DayComponent + DateTimeComponent shapes;
+    // GDSDatetimeComponentSchema extends them with hour/minute fields.
+    declare component: GDSDatetimeComponentSchema;
+
+    // Narrow inherited base-class properties from `any` / `{}` to precise types.
+    // `declare` emits no runtime code — it only refines the type in this subclass.
+    declare refs: {
+        hour: HTMLInputElement;
+        minute: HTMLInputElement;
+        day: HTMLInputElement;
+        month: HTMLInputElement;
+        year: HTMLInputElement;
+        input: HTMLInputElement[];
+    };
+    declare dataValue: string;
+    declare data: Record<string, unknown>;
+    declare validators: string[];
+    declare shouldDisabled: boolean;
+    declare triggerChange: () => void;
+
+    get format(): string {
         return 'DD-MM-YYYY';
     }
-    // @ts-ignore
-    get defaultValue() {
+
+    get defaultValue(): string {
         let defaultValue = this.component.defaultValue;
         if (!defaultValue && this.component.defaultDate) {
             defaultValue = FormioUtils.getDateSetting(this.component.defaultDate);
             defaultValue = defaultValue ? moment(defaultValue).format() : '';
         }
-        return defaultValue;
+        return defaultValue ?? '';
     }
 
-    // @ts-ignore
-    get emptyValue() {
+    get emptyValue(): null {
         return null;
     }
 
-    get parts() {
+    get parts(): { day: string | null; month: string | null; year: string | null; hour: string | null; minute: string | null } {
         return {
             day: this.getFieldValue('day'),
             month: this.getFieldValue('month'),
@@ -38,25 +58,18 @@ export default class GDSDatetimeComponent extends Day {
         };
     }
 
-    private refs: any;
-    private component: any;
-    private updateValue: any;
-    private renderField: any;
-    private inputDefinition: any;
-    private checkComponentValidity: any;
-    private triggerChange: any;
-
     private timeHelper: TimeHelper = new TimeHelper();
 
-    public attach(element: any) {
-        this.loadRefs(element, {hour: 'single', minute: 'single'});
+    // element typed as `any` to match the base Day.attach(element: any) override signature
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types
+    public attach(element: any): Promise<void> {
+        this.loadRefs(element, { hour: 'single', minute: 'single' });
+
         this.addEventListener(this.refs.hour, 'input', () => {
             this.timeHelper.checkAndValidateHour(this.refs.hour);
             this.setPristine(false);
             this.checkComponentValidity(this.data, true);
-            this.updateValue(null, {
-                modified: true,
-            });
+            this.updateValue(null, { modified: true });
             this.triggerChange();
         });
 
@@ -64,9 +77,7 @@ export default class GDSDatetimeComponent extends Day {
             this.timeHelper.checkAndValidateMinutes(this.refs.minute);
             this.setPristine(false);
             this.checkComponentValidity(this.data, true);
-            this.updateValue(null, {
-                modified: true,
-            });
+            this.updateValue(null, { modified: true });
             this.triggerChange();
         });
 
@@ -94,42 +105,65 @@ export default class GDSDatetimeComponent extends Day {
             this.timeHelper.validateDateInput(this.refs.month, 2);
         });
 
-
         return superAttach;
     }
 
-    public init() {
+    /**
+     * Override t() to remap translation keys emitted by @formio/core validators that
+     * differ from the @formio/js English translation map.
+     *
+     * @formio/core's date validator emits FieldError('invalidDate', ...) (camelCase).
+     * @formio/js translations only define 'invalid_date' (underscore). When t()
+     * cannot find 'invalidDate' it returns the raw key as the error message.
+     *
+     * We map the camelCase core keys to their underscored @formio/js equivalents so
+     * the user sees a proper human-readable message.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types
+    public t(text: any, ...args: any[]): any {
+        const keyMap: Record<string, string> = {
+            invalidDate: 'invalid_date',
+        };
+        return super.t(keyMap[text] ?? text, ...args);
+    }
+
+    public init(): void {
         super.init();
-        this.validators = this.validators.filter((v) => v !== 'day').concat(['date']);
+        // @formio/js@5.x: this.validators is not pre-populated by the base class; guard before filtering
+        this.validators = (this.validators || []).filter((v) => v !== 'day').concat(['date']);
 
-        this.component.maxDate = this.component.datePicker.maxDate;
-        this.component.minDate = this.component.datePicker.minDate;
+        this.component.maxDate = this.component.datePicker?.maxDate ?? undefined;
+        this.component.minDate = this.component.datePicker?.minDate ?? undefined;
         this.component.suffix = null;
 
-        this.component.fields.day.required = this.component.validate.required;
-        this.component.fields.month.required = this.component.validate.required;
-        this.component.fields.year.required = this.component.validate.required;
+        this.component.fields.day.required = this.component.validate?.required;
+        this.component.fields.month.required = this.component.validate?.required;
+        this.component.fields.year.required = this.component.validate?.required;
         this.component.fields.hour = {
-            type: 'number', placeholder: 'HH',
-            required: this.component.validate.required,
+            type: 'number',
+            placeholder: 'HH',
+            required: this.component.validate?.required,
         };
         this.component.fields.minute = {
-            type: 'number', placeholder: 'MM',
-            required: this.component.validate.required,
+            type: 'number',
+            placeholder: 'MM',
+            required: this.component.validate?.required,
         };
     }
 
-    public setErrorClasses(elements, dirty, hasError) {
-        // @ts-ignore
-        super.setErrorClasses( [this.refs.hour, this.refs.minute, ...elements], dirty, hasError);
+    // elements typed as `any` to match the base Day.setErrorClasses(elements: any, ...) override signature
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types
+    public setErrorClasses(elements: any, dirty: any, hasError: any): void {
+        super.setErrorClasses([this.refs.hour, this.refs.minute, ...elements], dirty, hasError);
     }
 
-    public removeInputError(elements) {
-        // @ts-ignore
+    // elements typed as `any` to match the base Component.removeInputError(elements: any) signature
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types
+    public removeInputError(elements: any): void {
         super.removeInputError([this.refs.hour, this.refs.minute, ...elements]);
     }
 
-    public render() {
+    public render(): string {
         return Field.prototype.render.call(this, this.renderTemplate('datetime', {
             component: this.component,
             dataValue: this.dataValue,
@@ -143,8 +177,10 @@ export default class GDSDatetimeComponent extends Day {
         }));
     }
 
-    public getDate(value) {
-        const defaults = [];
+    // value typed as `any` to match the base Day.getDate(value: any): null | string signature
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types
+    public getDate(value: any): string | null {
+        const defaults: Array<string | number | undefined> = [];
         const [DAY, MONTH, YEAR, HOUR, MINUTE] = [0, 1, 2, 3, 4];
         const defaultValue = value || this.component.defaultValue;
 
@@ -156,35 +192,37 @@ export default class GDSDatetimeComponent extends Day {
                 defaults[YEAR] = defaultDate.format('YYYY');
                 defaults[HOUR] = defaultDate.format('HH');
                 defaults[MINUTE] = defaultDate.format('mm');
-            } catch (e) {
+            } catch {
                 // ignored
             }
         }
 
-        let day: any = this.processField('day', defaults, DAY);
-        let month: any = this.processField('month', defaults, MONTH);
-        let year: any = this.processField('year', defaults, YEAR);
-        let hour: any = this.processField('hour', defaults, HOUR);
-        let minute: any = this.processField('minute', defaults, MINUTE);
+        const day: number = this.processField('day', defaults, DAY);
+        const month: number = this.processField('month', defaults, MONTH);
+        const year: number = this.processField('year', defaults, YEAR);
+        const hour: number = this.processField('hour', defaults, HOUR);
+        const minute: number = this.processField('minute', defaults, MINUTE);
 
         if (!day && !month && !year && (!hour && !minute)) {
             return null;
         }
 
-        day = day.toString().padStart(2, 0);
-        month = month.toString().padStart(2, 0);
-        year = year.toString().padStart(4, 0);
-        hour = hour.toString().padStart(2, 0);
-        minute = minute.toString().padStart(2, 0);
+        const dayStr = day.toString().padStart(2, '0');
+        const monthStr = month.toString().padStart(2, '0');
+        const yearStr = year.toString().padStart(4, '0');
+        const hourStr = hour.toString().padStart(2, '0');
+        const minuteStr = minute.toString().padStart(2, '0');
 
-        const toMoment = moment(`${year}-${month}-${day} ${hour}:${minute}`, 'YYYY-MM-DD HH:mm');
+        const toMoment = moment(`${yearStr}-${monthStr}-${dayStr} ${hourStr}:${minuteStr}`, 'YYYY-MM-DD HH:mm');
         return toMoment.format();
     }
 
-    public getFieldValue(name) {
+    // name typed as `any` to match the base Day.getFieldValue(name: any): number signature
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types
+    public getFieldValue(name: any): string | null {
         if (this.dataValue && this.dataValue !== 'Invalid date') {
             try {
-                let val = null;
+                let val: string | null = null;
                 const date = moment(this.dataValue, 'YYYY-MM-DD HH:mm');
 
                 switch (name) {
@@ -205,27 +243,27 @@ export default class GDSDatetimeComponent extends Day {
                         break;
                 }
                 return val;
-            } catch (e) {
+            } catch {
                 return null;
             }
         }
         return null;
     }
 
-    public boolValue(value) {
+    public boolValue(value: unknown): boolean {
         if (_.isBoolean(value)) {
             return value;
-        }
-        else if (_.isString(value)) {
+        } else if (_.isString(value)) {
             return (value.toLowerCase() === 'true');
-        }
-        else {
+        } else {
             return !!value;
         }
     }
-    public setValueAt(index, value) {
-        // temporary solution to avoid input reset
-        // on invalid date.
+
+    // value typed as `any` to match the base Day.setValueAt(index: number, value: any) signature
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types
+    public setValueAt(_index: number, value: any): void {
+        // temporary solution to avoid input reset on invalid date.
         if (!value || value === 'Invalid date') {
             return;
         }
@@ -243,51 +281,48 @@ export default class GDSDatetimeComponent extends Day {
             if (this.refs.hour) {
                 this.refs.hour.value = date.format('HH');
             }
-
             if (this.refs.minute) {
                 this.refs.minute.value = date.format('mm');
             }
         }
-
     }
 
-    public getValueAt(index) {
-        // @ts-ignore
+    public getValueAt(index: number): string | null {
+        // `date` is a public getter declared on DayComponent: get date(): string | null
         const date = this.date;
         if (date) {
             this.refs.input[index].value = date;
             return this.refs.input[index].value;
-        }
-        else {
+        } else {
             this.refs.input[index].value = '';
             return null;
         }
     }
 
-    public normalizeValue(value) {
+    // value typed as `any` to match the base Component.normalizeValue(value: any): any signature
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types
+    public normalizeValue(value: any): any {
         return value;
     }
 
-    public validateRequired(setting, value) {
-        const {day, month, year, minute, hour} = this.parts;
+    // setting/value typed as `any` to match the base Day.validateRequired(setting: any, value: any) signature
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types
+    public validateRequired(setting: any, value: any): boolean {
+        const { day, month, year, minute, hour } = this.parts;
 
-        if (this.component.validate.required && (!day || parseInt(day, 10) === 0)) {
+        if (this.component.validate?.required && (!day || parseInt(day, 10) === 0)) {
             return false;
         }
-
-        if (this.component.validate.required && (!month || parseInt(month, 10) === 0)) {
+        if (this.component.validate?.required && (!month || parseInt(month, 10) === 0)) {
             return false;
         }
-
-        if (this.component.validate.required && (!year || parseInt(year, 10) === 0)) {
+        if (this.component.validate?.required && (!year || parseInt(year, 10) === 0)) {
             return false;
         }
-
-        if (this.component.validate.required && ((this.refs.minute && this.refs.minute.value === '') || !minute)) {
+        if (this.component.validate?.required && (this.refs.minute.value === '' || !minute)) {
             return false;
         }
-
-        if (this.component.validate.required && ((this.refs.hour && this.refs.hour.value === '') || !hour)) {
+        if (this.component.validate?.required && (this.refs.hour.value === '' || !hour)) {
             return false;
         }
 
@@ -297,13 +332,15 @@ export default class GDSDatetimeComponent extends Day {
         return !this.isEmpty(value);
     }
 
-    private processField(field: string, defaults: any[], fieldIndex: number) {
-        let fieldValue = this.refs[`${field}`] ? parseInt(this.refs[`${field}`].value, 10) : undefined;
+    private processField(field: string, defaults: Array<string | number | undefined>, fieldIndex: number): number {
+        const refKey = field as keyof typeof this.refs;
+        const ref = this.refs[refKey];
+        const inputRef = ref instanceof HTMLInputElement ? ref : undefined;
+        let fieldValue: number | undefined = inputRef ? parseInt(inputRef.value, 10) : undefined;
         if (fieldValue === undefined || _.isNaN(fieldValue)) {
-            fieldValue = defaults[fieldIndex] && !_.isNaN(defaults[fieldIndex]) ? defaults[fieldIndex] : 0;
+            fieldValue = defaults[fieldIndex] && !_.isNaN(defaults[fieldIndex]) ? Number(defaults[fieldIndex]) : 0;
         }
         return fieldValue;
-
     }
 
 }

package/src/components/index.ts

@@ -1,11 +1,13 @@
 import datamap from './datamap/GDSDataMap';
 import datetime from './datetime/GDSDatetimeComponent';
+import select from './select/GDSSelect';
 import selectboxes from './selectboxes/GDSCheckBoxes';
 import time from './time/GDSTimeComponent';
 
 export default {
     datamap,
     datetime,
+    select,
     selectboxes,
     time,
 };