@planning-inspectorate/dynamic-forms 3.20.2 → 3.20.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planning-inspectorate/dynamic-forms",
-  "version": "3.20.2",
+  "version": "3.20.3",
   "description": "This package is for building GDS forms using a configuration-based approach.",
   "main": "./src/index.js",
   "type": "module",
@@ -61,7 +61,7 @@
     "prettier": "^3.6.2",
     "prettier-plugin-organize-imports": "^4.3.0",
     "prettier-plugin-prisma": "^5.0.0",
-    "semantic-release": "^25.0.1"
+    "semantic-release": "^25.0.9"
   },
   "publishConfig": {
     "access": "public"

package/src/questions/questions.d.ts

@@ -1,3 +1,48 @@
-/** @type {Record<string, import('./question.js').Question>} */
-export const questionClasses: Record<string, import("./question.js").Question>;
+/**
+ * A map of component 'type' (or name') to question class
+ *
+ * Pass this to `createQuestions` to generate question instances based on the `type` field of `QuestionProps`.
+ * To support custom questions, create a new object with these properties and the custom ones,
+ * @example
+ * ```
+ * const classes = {
+ *     ...questionClasses,
+ *     ...myCustomQuestions
+ * };
+ * ```
+ */
+export const questionClasses: Readonly<{
+    "site-address": typeof AddressQuestion;
+    checkbox: typeof CheckboxQuestion;
+    boolean: typeof BooleanQuestion;
+    radio: typeof RadioQuestion;
+    date: typeof DateQuestion;
+    "date-period": typeof DatePeriodQuestion;
+    "date-time": typeof DateTimeQuestion;
+    "text-entry": typeof TextEntryQuestion;
+    "text-entry-redact": typeof TextEntryRedactQuestion;
+    select: typeof SelectQuestion;
+    "single-line-input": typeof SingleLineInputQuestion;
+    "multi-field-input": typeof MultiFieldInputQuestion;
+    number: typeof NumberEntryQuestion;
+    "unit-option": typeof UnitOptionEntryQuestion;
+    email: typeof EmailQuestion;
+    "manage-list": typeof ManageListQuestion;
+}>;
+import AddressQuestion from '../components/address/question.js';
+import CheckboxQuestion from '../components/checkbox/question.js';
+import BooleanQuestion from '../components/boolean/question.js';
+import RadioQuestion from '../components/radio/question.js';
+import DateQuestion from '../components/date/question.js';
+import DatePeriodQuestion from '../components/date-period/question.js';
+import DateTimeQuestion from '../components/date-time/question.js';
+import TextEntryQuestion from '../components/text-entry/question.js';
+import TextEntryRedactQuestion from '../components/text-entry-redact/question.js';
+import SelectQuestion from '../components/select/question.js';
+import SingleLineInputQuestion from '../components/single-line-input/question.js';
+import MultiFieldInputQuestion from '../components/multi-field-input/question.js';
+import NumberEntryQuestion from '../components/number-entry/question.js';
+import UnitOptionEntryQuestion from '../components/unit-option-entry/question.js';
+import EmailQuestion from '../components/email/question.js';
+import ManageListQuestion from '../components/manage-list/question.js';
 //# sourceMappingURL=questions.d.ts.map

package/src/questions/questions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"questions.d.ts","sourceRoot":"","sources":["questions.js"],"names":[],"mappings":"AAsBA,+DAA+D;AAC/D,8BADW,MAAM,CAAC,MAAM,EAAE,OAAO,eAAe,EAAE,QAAQ,CAAC,CAkBxD"}
+{"version":3,"file":"questions.d.ts","sourceRoot":"","sources":["questions.js"],"names":[],"mappings":"AAmBA;;;;;;;;;;;;GAYG;AACH;;;;;;;;;;;;;;;;;GAiBG;4BAjDyB,mCAAmC;6BAClC,oCAAoC;4BACrC,mCAAmC;0BACrC,iCAAiC;yBAClC,gCAAgC;+BAC1B,uCAAuC;6BAWzC,qCAAqC;8BAVpC,sCAAsC;oCAShC,6CAA6C;2BARtD,kCAAkC;oCACzB,6CAA6C;oCAC7C,6CAA6C;gCACjD,wCAAwC;oCACpC,6CAA6C;0BACvD,iCAAiC;+BAK5B,uCAAuC"}

package/src/questions/questions.js

@@ -17,10 +17,19 @@ import TextEntryRedactQuestion from '../components/text-entry-redact/question.js
 import DateTimeQuestion from '../components/date-time/question.js';
 import ManageListQuestion from '../components/manage-list/question.js';
 
-// This looks a bit grim because so few of our
-// Questions overlap with Question correctly.
-// Maybe something to fix at some point
-/** @type {Record<string, import('./question.js').Question>} */
+/**
+ * A map of component 'type' (or name') to question class
+ *
+ * Pass this to `createQuestions` to generate question instances based on the `type` field of `QuestionProps`.
+ * To support custom questions, create a new object with these properties and the custom ones,
+ * @example
+ * ```
+ * const classes = {
+ *     ...questionClasses,
+ *     ...myCustomQuestions
+ * };
+ * ```
+ */
 export const questionClasses = Object.freeze({
 	[COMPONENT_TYPES.ADDRESS]: AddressQuestion,
 	[COMPONENT_TYPES.CHECKBOX]: CheckboxQuestion,