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

package/.github/workflows/build-and-test.yml

@@ -6,10 +6,10 @@ jobs:
   build_and_test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 14
+          node-version: 20
       - name: Install dependencies
         run: |
           rm -rf node_modules

package/LICENCE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 UKHomeOffice
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -16,6 +16,14 @@ NodeJS version 20
    npm install @ukhomeoffice/formio-gds-template
 ```
 
+The compiled `lib/` directory is generated during packaging and is intentionally not committed to the repository. To publish a local build to an application using Yalc, run:
+
+```bash
+npm run yalc:push
+```
+
+This builds the package before pushing it, so the consuming application imports the same compiled files that would be included in an npm package.
+
 ## Usage
 
 Using vanilla formio

package/eslint.config.mjs

@@ -0,0 +1,59 @@
+// ESLint flat config (ESLint 9.x)
+// Replaces tslint.json — equivalent rules migrated from tslint:recommended subset used in tslint.json
+import tseslint from '@typescript-eslint/eslint-plugin';
+import tsParser from '@typescript-eslint/parser';
+
+export default [
+    {
+        // Exclude spec files — they are excluded from tsconfig.json so @typescript-eslint/parser
+        // cannot resolve them under parserOptions.project.
+        ignores: ['**/*.spec.ts'],
+    },
+    {
+        files: ['src/**/*.ts'],
+        languageOptions: {
+            parser: tsParser,
+            parserOptions: {
+                project: './tsconfig.json',
+                tsconfigRootDir: import.meta.dirname,
+            },
+        },
+        plugins: {
+            '@typescript-eslint': tseslint,
+        },
+        rules: {
+            // Equivalent of tslint quotemark: [true, 'single', 'avoid-escape', 'avoid-template']
+            // Note: @typescript-eslint/quotes was removed in v6; use the base ESLint rule instead.
+            'quotes': ['error', 'single', { avoidEscape: true, allowTemplateLiterals: false }],
+
+            // tslint no-shadowed-variable: false — off
+            'no-shadow': 'off',
+            '@typescript-eslint/no-shadow': 'off',
+
+            // tslint variable-name: allow-leading-underscore, allow-pascal-case, ban-keywords
+            '@typescript-eslint/naming-convention': [
+                'error',
+                {
+                    selector: 'variableLike',
+                    format: ['camelCase', 'PascalCase', 'UPPER_CASE'],
+                    leadingUnderscore: 'allow',
+                },
+                {
+                    selector: 'typeLike',
+                    format: ['PascalCase'],
+                },
+            ],
+
+            // tslint max-classes-per-file: false — off (default)
+            'max-classes-per-file': 'off',
+
+            // Enforce explicit types and disallow untyped variables
+            '@typescript-eslint/no-explicit-any': 'error',
+            // Parameters prefixed with _ are intentionally unused (e.g. _flags in override signatures).
+            '@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
+            // Enforce explicit return types on functions and class methods for clear public API contracts
+            '@typescript-eslint/explicit-function-return-type': ['error', { allowExpressions: true }],
+            '@typescript-eslint/explicit-module-boundary-types': 'error',
+        },
+    },
+];

package/lib/components/datamap/GDSDataMap.d.ts

@@ -1,17 +1,8 @@
-declare const DataMap: import("formiojs").ClassWithEditForm<typeof import("formiojs/types/components/_classes/nested/nestedComponent").NestedComponent>;
+import { DataMapComponent } from '../../types';
+declare const DataMap: any;
 export default class GDSDataMap extends DataMap {
-    private getRows;
-    private hasRowGroups;
-    private getGroups;
-    private visibleColumns;
-    private hasAddButton;
-    private hasRemoveButtons;
-    private hasTopSubmit;
-    private hasBottomSubmit;
-    private hasExtraColumn;
-    private datagridKey;
-    private allowReorder;
-    private getColumns;
-    render(): any;
+    component: DataMapComponent;
+    render(): string;
 }
 export {};
+//# sourceMappingURL=GDSDataMap.d.ts.map

package/lib/components/datamap/GDSDataMap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GDSDataMap.d.ts","sourceRoot":"","sources":["../../../src/components/datamap/GDSDataMap.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAG/C,QAAA,MAAM,OAAO,KAAgC,CAAC;AAE9C,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,OAAO;IAEnC,SAAS,EAAE,gBAAgB,CAAC;IAE7B,MAAM,IAAI,MAAM;CAiB1B"}

package/lib/components/datamap/GDSDataMap.js

@@ -1,33 +1,14 @@
 "use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
 Object.defineProperty(exports, "__esModule", { value: true });
-var formiojs_1 = require("formiojs");
-var Field = formiojs_1.Components.components.field;
-var DataMap = formiojs_1.Components.components.datamap;
-var GDSDataMap = /** @class */ (function (_super) {
-    __extends(GDSDataMap, _super);
-    function GDSDataMap() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    GDSDataMap.prototype.render = function () {
-        var columns = this.getColumns();
+const js_1 = require("@formio/js");
+const Field = js_1.Components.components.field;
+const DataMap = js_1.Components.components.datamap;
+class GDSDataMap extends DataMap {
+    render() {
+        const columns = this.getColumns();
         return Field.prototype.render.call(this, this.renderTemplate('datamap', {
             rows: this.getRows(),
-            columns: columns,
+            columns,
             groups: this.hasRowGroups() ? this.getGroups() : [],
             visibleColumns: this.visibleColumns,
             hasAddButton: this.hasAddButton(),
@@ -39,7 +20,6 @@ var GDSDataMap = /** @class */ (function (_super) {
             allowReorder: this.allowReorder,
             builder: this.builderMode,
         }));
-    };
-    return GDSDataMap;
-}(DataMap));
+    }
+}
 exports.default = GDSDataMap;

package/lib/components/datetime/GDSDatetimeComponent.d.ts

@@ -1,35 +1,56 @@
-declare const Day: import("formiojs").ClassWithEditForm<typeof import("formiojs/types/components/_classes/field/field").Field>;
+import { GDSDatetimeComponentSchema } from '../../types';
+declare const Day: any;
 export default class GDSDatetimeComponent extends Day {
+    component: GDSDatetimeComponentSchema;
+    refs: {
+        hour: HTMLInputElement;
+        minute: HTMLInputElement;
+        day: HTMLInputElement;
+        month: HTMLInputElement;
+        year: HTMLInputElement;
+        input: HTMLInputElement[];
+    };
+    dataValue: string;
+    data: Record<string, unknown>;
+    validators: string[];
+    shouldDisabled: boolean;
+    triggerChange: () => void;
     get format(): string;
-    get defaultValue(): any;
-    get emptyValue(): any;
+    get defaultValue(): string;
+    get emptyValue(): null;
     get parts(): {
-        day: any;
-        month: any;
-        year: any;
-        hour: any;
-        minute: any;
+        day: string | null;
+        month: string | null;
+        year: string | null;
+        hour: string | null;
+        minute: string | null;
     };
-    private refs;
-    private component;
-    private updateValue;
-    private renderField;
-    private inputDefinition;
-    private checkComponentValidity;
-    private triggerChange;
     private timeHelper;
-    attach(element: any): any;
+    attach(element: any): Promise<void>;
+    /**
+     * 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.
+     */
+    t(text: any, ...args: any[]): any;
     init(): void;
     setErrorClasses(elements: any, dirty: any, hasError: any): void;
     removeInputError(elements: any): void;
-    render(): any;
-    getDate(value: any): string;
-    getFieldValue(name: any): any;
-    boolValue(value: any): boolean;
-    setValueAt(index: any, value: any): void;
-    getValueAt(index: any): any;
+    render(): string;
+    getDate(value: any): string | null;
+    getFieldValue(name: any): string | null;
+    boolValue(value: unknown): boolean;
+    setValueAt(_index: number, value: any): void;
+    getValueAt(index: number): string | null;
     normalizeValue(value: any): any;
     validateRequired(setting: any, value: any): boolean;
     private processField;
 }
 export {};
+//# sourceMappingURL=GDSDatetimeComponent.d.ts.map

package/lib/components/datetime/GDSDatetimeComponent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GDSDatetimeComponent.d.ts","sourceRoot":"","sources":["../../../src/components/datetime/GDSDatetimeComponent.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAC;AAGzD,QAAA,MAAM,GAAG,KAA4B,CAAC;AAEtC,MAAM,CAAC,OAAO,OAAO,oBAAqB,SAAQ,GAAG;IAKzC,SAAS,EAAE,0BAA0B,CAAC;IAItC,IAAI,EAAE;QACV,IAAI,EAAE,gBAAgB,CAAC;QACvB,MAAM,EAAE,gBAAgB,CAAC;QACzB,GAAG,EAAE,gBAAgB,CAAC;QACtB,KAAK,EAAE,gBAAgB,CAAC;QACxB,IAAI,EAAE,gBAAgB,CAAC;QACvB,KAAK,EAAE,gBAAgB,EAAE,CAAC;KAC7B,CAAC;IACM,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,cAAc,EAAE,OAAO,CAAC;IACxB,aAAa,EAAE,MAAM,IAAI,CAAC;IAElC,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,IAAI,YAAY,IAAI,MAAM,CAOzB;IAED,IAAI,UAAU,IAAI,IAAI,CAErB;IAED,IAAI,KAAK,IAAI;QAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAQzH;IAED,OAAO,CAAC,UAAU,CAAgC;IAI3C,MAAM,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IA8C1C;;;;;;;;;;OAUG;IAEI,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,GAAG;IAOjC,IAAI,IAAI,IAAI;IA0BZ,eAAe,CAAC,QAAQ,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,GAAG,IAAI;IAM/D,gBAAgB,CAAC,QAAQ,EAAE,GAAG,GAAG,IAAI;IAIrC,MAAM,IAAI,MAAM;IAgBhB,OAAO,CAAC,KAAK,EAAE,GAAG,GAAG,MAAM,GAAG,IAAI;IAwClC,aAAa,CAAC,IAAI,EAAE,GAAG,GAAG,MAAM,GAAG,IAAI;IA+BvC,SAAS,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAYlC,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI;IAyB5C,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAcxC,cAAc,CAAC,KAAK,EAAE,GAAG,GAAG,GAAG;IAM/B,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,GAAG,OAAO;IAyB1D,OAAO,CAAC,YAAY;CAWvB"}