@planning-inspectorate/dynamic-forms 3.10.17 → 3.11.0

package/govuk-prototype-kit.config.json

@@ -0,0 +1,6 @@
+{
+	"meta": {
+		"description": "Planning Inspectorate Dynamic Forms package, for building dynamic user journeys with GDS components"
+	},
+	"nunjucksPaths": ["/src"]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planning-inspectorate/dynamic-forms",
-  "version": "3.10.17",
+  "version": "3.11.0",
   "description": "This package is for building GDS forms using a configuration-based approach.",
   "main": "./src/index.js",
   "type": "module",
@@ -45,7 +45,7 @@
     "@eslint/js": "^10.0.1",
     "@types/express": "^5.0.6",
     "body-parser": "^2.2.0",
-    "conventional-changelog-conventionalcommits": "^9.1.0",
+    "conventional-changelog-conventionalcommits": "^10.2.0",
     "cookie-parser": "^1.4.7",
     "eslint": "^10.0.0",
     "eslint-config-prettier": "^10.1.5",

package/src/questions/create-questions.js

@@ -1,10 +1,10 @@
-/** @typedef {import('./question-props').QuestionProps} QuestionProps */
-
 /**
- * @param {{[questionName: string]: QuestionProps}} questionPropsRecord
+ * @template {import('./question-props.js').BaseQuestionProps} T
+ * @param {{[questionName: string]: 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>>}
  */
 export function createQuestions(questionPropsRecord, questionClasses, questionMethodOverrides, textOverrides) {
 	return Object.fromEntries(

package/src/questions/question-props.d.ts

@@ -22,6 +22,13 @@ type CommonQuestionProps = Omit<QuestionParameters, 'viewFolder'> & {
 	type: QuestionTypes;
 };
 
+/**
+ * Generic question props type so that custom components can be used without having to define a new type for each one.
+ */
+export type BaseQuestionProps = Omit<CommonQuestionProps, 'type'> & {
+	type: string;
+};
+
 type Option =
 	| {
 			text: string;

package/types/eslint.config.d.ts

@@ -57,6 +57,7 @@ declare const _default: ({
             PerformanceResourceTiming: false;
             process: false;
             queueMicrotask: false;
+            QuotaExceededError: false;
             ReadableByteStreamController: false;
             ReadableStream: false;
             ReadableStreamBYOBReader: false;
@@ -74,6 +75,7 @@ declare const _default: ({
             structuredClone: false;
             SubtleCrypto: false;
             SuppressedError: false;
+            Temporal: false;
             TextDecoder: false;
             TextDecoderStream: false;
             TextEncoder: false;

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

@@ -1,12 +1,13 @@
-/** @typedef {import('./question-props').QuestionProps} QuestionProps */
 /**
- * @param {{[questionName: string]: QuestionProps}} questionPropsRecord
+ * @template {import('./question-props.js').BaseQuestionProps} T
+ * @param {{[questionName: string]: 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>>}
  */
-export function createQuestions(questionPropsRecord: {
-    [questionName: string]: QuestionProps;
+export function createQuestions<T extends import("./question-props.js").BaseQuestionProps>(questionPropsRecord: {
+    [questionName: string]: T;
 }, questionClasses: Record<string, import("./question-types.js").QuestionClass>, questionMethodOverrides: {
     [questionType: string]: Record<string, Function>;
 }, textOverrides?: {
@@ -14,8 +15,5 @@ export function createQuestions(questionPropsRecord: {
     continueButtonText?: string;
     changeActionText?: string;
     answerActionText?: string;
-}): {
-    [k: string]: Question;
-};
-export type QuestionProps = any;
+}): Record<string, 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,wEAAwE;AAExE;;;;;GAKG;AACH,qDALW;IAAC,CAAC,YAAY,EAAE,MAAM,GAAG,aAAa,CAAA;CAAC,mBACvC,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;;EAwBtH"}
+{"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"}

package/types/src/questions/question-props.d.ts

@@ -22,6 +22,13 @@ type CommonQuestionProps = Omit<QuestionParameters, 'viewFolder'> & {
 	type: QuestionTypes;
 };
 
+/**
+ * Generic question props type so that custom components can be used without having to define a new type for each one.
+ */
+export type BaseQuestionProps = Omit<CommonQuestionProps, 'type'> & {
+	type: string;
+};
+
 type Option =
 	| {
 			text: string;