@planning-inspectorate/dynamic-forms 3.15.5 → 3.15.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planning-inspectorate/dynamic-forms",
-  "version": "3.15.5",
+  "version": "3.15.6",
   "description": "This package is for building GDS forms using a configuration-based approach.",
   "main": "./src/index.js",
   "type": "module",

package/src/questions/create-questions.js

@@ -1,10 +1,11 @@
 /**
+ * @template {string} K Question keys in questionPropsRecord
  * @template {import('./question-props.js').BaseQuestionProps} T
- * @param {{[questionName: string]: T}} questionPropsRecord
+ * @param {{[questionName in K]: T}} questionPropsRecord
  * @param {Record<string, import('./question-types.js').QuestionClass>} questionClasses
  * @param {{[questionType: string]: Record<string, Function>}} questionMethodOverrides
  * @param {{notStartedText?: string, continueButtonText?: string, changeActionText?: string, answerActionText?: string}} [textOverrides] - customise question text
- * @returns {Record<string, InstanceType<import('./question-types.js').QuestionClass>>}
+ * @returns {{[questionName in K]: InstanceType<import('./question-types.js').QuestionClass>}} Returns the same question keys that were passed in with each value being an instantiated question
  */
 export function createQuestions(questionPropsRecord, questionClasses, questionMethodOverrides, textOverrides) {
 	return Object.fromEntries(

package/types/src/questions/create-questions.d.ts

@@ -1,19 +1,18 @@
 /**
+ * @template {string} K Question keys in questionPropsRecord
  * @template {import('./question-props.js').BaseQuestionProps} T
- * @param {{[questionName: string]: T}} questionPropsRecord
+ * @param {{[questionName in K]: T}} questionPropsRecord
  * @param {Record<string, import('./question-types.js').QuestionClass>} questionClasses
  * @param {{[questionType: string]: Record<string, Function>}} questionMethodOverrides
  * @param {{notStartedText?: string, continueButtonText?: string, changeActionText?: string, answerActionText?: string}} [textOverrides] - customise question text
- * @returns {Record<string, InstanceType<import('./question-types.js').QuestionClass>>}
+ * @returns {{[questionName in K]: InstanceType<import('./question-types.js').QuestionClass>}} Returns the same question keys that were passed in with each value being an instantiated question
  */
-export function createQuestions<T extends import("./question-props.js").BaseQuestionProps>(questionPropsRecord: {
-    [questionName: string]: T;
-}, questionClasses: Record<string, import("./question-types.js").QuestionClass>, questionMethodOverrides: {
+export function createQuestions<K extends string, T extends import("./question-props.js").BaseQuestionProps>(questionPropsRecord: { [questionName in K]: T; }, questionClasses: Record<string, import("./question-types.js").QuestionClass>, questionMethodOverrides: {
     [questionType: string]: Record<string, Function>;
 }, textOverrides?: {
     notStartedText?: string;
     continueButtonText?: string;
     changeActionText?: string;
     answerActionText?: string;
-}): Record<string, InstanceType<import("./question-types.js").QuestionClass>>;
+}): { [questionName in K]: InstanceType<import("./question-types.js").QuestionClass>; };
 //# sourceMappingURL=create-questions.d.ts.map

package/types/src/questions/create-questions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create-questions.d.ts","sourceRoot":"","sources":["../../../src/questions/create-questions.js"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,gCAP+D,CAAC,SAAnD,OAAQ,qBAAqB,EAAE,iBAAkB,uBACnD;IAAC,CAAC,YAAY,EAAE,MAAM,GAAG,CAAC,CAAA;CAAC,mBAC3B,MAAM,CAAC,MAAM,EAAE,OAAO,qBAAqB,EAAE,aAAa,CAAC,2BAC3D;IAAC,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,WAAW,CAAA;CAAC,kBAClD;IAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAAC,GAC1G,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,OAAO,qBAAqB,EAAE,aAAa,CAAC,CAAC,CAwBrF"}
+{"version":3,"file":"create-questions.d.ts","sourceRoot":"","sources":["../../../src/questions/create-questions.js"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,gCARsB,CAAC,SAAV,MAAQ,EAC0C,CAAC,SAAnD,OAAQ,qBAAqB,EAAE,iBAAkB,uBACnD,GAAE,YAAY,IAAI,CAAC,GAAG,CAAC,GAAC,mBACxB,MAAM,CAAC,MAAM,EAAE,OAAO,qBAAqB,EAAE,aAAa,CAAC,2BAC3D;IAAC,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,WAAW,CAAA;CAAC,kBAClD;IAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAAC,GAC1G,GAAE,YAAY,IAAI,CAAC,GAAG,YAAY,CAAC,OAAO,qBAAqB,EAAE,aAAa,CAAC,GAAC,CAwB5F"}

package/src/components/identifier/index.njk

@@ -1,62 +0,0 @@
-{% extends layoutTemplate %}
-
-{% from "govuk/components/input/macro.njk" import govukInput %}
-{% from "govuk/components/label/macro.njk" import govukLabel %}
-
-{% block dynQuestionContent %}
-    <div class="govuk-grid-row">
-        <div class="govuk-grid-column-two-thirds">
-            <form action="" method="post" novalidate>
-                {% if _csrf %}<input type="hidden" name="_csrf" value="{{ _csrf }}">{% endif %}
-                {% if question.label %}
-                    <h1 class="govuk-heading-l">
-                        {{ question.question }}
-                    </h1>
-
-                    {% if question.html %}
-                        {% include question.html ignore missing %}
-                    {% endif %}
-
-                    {{ govukInput({
-                        label: {
-                            text: question.label
-                        },
-                        id: question.fieldName,
-                        name: question.fieldName,
-                        value: question.value,
-                        hint: { text: question.hint },
-                        errorMessage: errors[question.fieldName] and {
-                            text: errors[question.fieldName].msg
-                        },
-                        classes: question.inputClasses
-                    }) }}
-                {% else %}
-                    {{ govukLabel({
-                        text: question.question,
-                        isPageHeading: true,
-                        classes: 'govuk-label--l',
-                        for: question.fieldName
-                    }) }}
-
-                    {% if question.html %}
-                        {% include question.html ignore missing %}
-                    {% endif %}
-
-                    {{ govukInput({
-                        id: question.fieldName,
-                        name: question.fieldName,
-                        value: payload and payload[question.fieldName],
-                        hint: { text: question.hint },
-                        errorMessage: errors[question.fieldName] and {
-                            text: errors[question.fieldName].msg
-                        },
-                        classes: question.inputClasses
-                    }) }}
-
-                {% endif %}
-
-                {% include "components/utils/actions.njk" %}
-            </form>
-        </div>
-    </div>
-{% endblock %}

package/src/components/identifier/question.js

@@ -1,33 +0,0 @@
-import { Question } from '#question';
-
-export class IdentifierQuestion extends Question {
-	/** @type {string|undefined} page h1, optional, will default to use question's label */
-	pageHeading;
-	/** @type {string} css classes to apply to input element */
-	inputClasses;
-
-	/**
-	 * @param {import('#question-types').QuestionParameters} params
-	 * @param {string} [params.inputClasses] css class string to be added to the input
-	 * @param {string|undefined} [params.label] if defined this show as a label for the input and the question will just be a standard h1
-	 */
-	constructor({ inputClasses = 'govuk-input--width-10', label, ...params }) {
-		super({
-			...params,
-			viewFolder: 'identifier'
-		});
-
-		this.inputClasses = inputClasses;
-		this.label = label;
-	}
-
-	/**
-	 * @param {import('#question').QuestionViewModel} viewModel
-	 */
-	addCustomDataToViewModel(viewModel) {
-		viewModel.question.inputClasses = this.inputClasses;
-		viewModel.question.label = this.label;
-	}
-}
-
-export default IdentifierQuestion;

package/src/components/identifier/question.test.js

@@ -1,46 +0,0 @@
-import { describe, it } from 'node:test';
-import assert from 'node:assert';
-import IdentifierQuestion from './question.js';
-
-describe('./src/dynamic-forms/components/identifier/question.js', () => {
-	it('should create', () => {
-		const TITLE = 'title';
-		const QUESTION = 'Question?';
-		const DESCRIPTION = 'Describe';
-		const FIELDNAME = 'field-name';
-		const URL = 'url';
-		const PAGE_TITLE = 'this appears in <title>';
-		const VALIDATORS = [1, 2];
-		const HTML = '/path/to/html.njk';
-		const HINT = 'hint';
-		const INPUT_CLASSES = 'govuk-body';
-		const LABEL = 'A label';
-
-		const question = new IdentifierQuestion({
-			title: TITLE,
-			question: QUESTION,
-			description: DESCRIPTION,
-			fieldName: FIELDNAME,
-			url: URL,
-			pageTitle: PAGE_TITLE,
-			validators: VALIDATORS,
-			html: HTML,
-			hint: HINT,
-			inputClasses: INPUT_CLASSES,
-			label: LABEL
-		});
-
-		assert.strictEqual(question.title, TITLE);
-		assert.strictEqual(question.question, QUESTION);
-		assert.strictEqual(question.description, DESCRIPTION);
-		assert.strictEqual(question.fieldName, FIELDNAME);
-		assert.strictEqual(question.viewFolder, 'identifier');
-		assert.strictEqual(question.url, URL);
-		assert.strictEqual(question.pageTitle, PAGE_TITLE);
-		assert.strictEqual(question.validators, VALIDATORS);
-		assert.strictEqual(question.html, HTML);
-		assert.strictEqual(question.hint, HINT);
-		assert.strictEqual(question.inputClasses, INPUT_CLASSES);
-		assert.strictEqual(question.label, LABEL);
-	});
-});

package/types/src/components/identifier/question.d.ts

@@ -1,16 +0,0 @@
-export class IdentifierQuestion extends Question {
-    /**
-     * @param {import('#question-types').QuestionParameters} params
-     * @param {string} [params.inputClasses] css class string to be added to the input
-     * @param {string|undefined} [params.label] if defined this show as a label for the input and the question will just be a standard h1
-     */
-    constructor({ inputClasses, label, ...params }: import("#question-types").QuestionParameters);
-    /** @type {string|undefined} page h1, optional, will default to use question's label */
-    pageHeading: string | undefined;
-    /** @type {string} css classes to apply to input element */
-    inputClasses: string;
-    label: any;
-}
-export default IdentifierQuestion;
-import { Question } from '#question';
-//# sourceMappingURL=question.d.ts.map

package/types/src/components/identifier/question.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["../../../../src/components/identifier/question.js"],"names":[],"mappings":"AAEA;IAMC;;;;OAIG;IACH,gDAJW,OAAO,iBAAiB,EAAE,kBAAkB,EAYtD;IAlBD,uFAAuF;IACvF,aADW,MAAM,GAAC,SAAS,CACf;IACZ,2DAA2D;IAC3D,cADW,MAAM,CACJ;IAcZ,WAAkB;CAUnB;;yBA9BwB,WAAW"}