@planning-inspectorate/dynamic-forms 3.15.6 → 3.16.0

package/src/questions/questions.d.ts

@@ -0,0 +1,3 @@
+/** @type {Record<string, import('./question.js').Question>} */
+export const questionClasses: Record<string, import("./question.js").Question>;
+//# sourceMappingURL=questions.d.ts.map

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

@@ -0,0 +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"}

package/src/questions/questions.js

@@ -20,7 +20,7 @@ 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').Question>} */
+/** @type {Record<string, import('./question.js').Question>} */
 export const questionClasses = Object.freeze({
 	[COMPONENT_TYPES.ADDRESS]: AddressQuestion,
 	[COMPONENT_TYPES.CHECKBOX]: CheckboxQuestion,

package/{types/src → src}/section.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @typedef {((response: import('#journey-response').JourneyResponse) => boolean)} QuestionCondition
+ */
 /**
  * A value indicating the final question of a section has been reached
  *
@@ -12,10 +15,10 @@ export class Section {
     /**
      * Implementation of getNextQuestion given a list of questions
      *
-     * @param {import('./section-types.d.ts').StaticGetNextQuestionParams} params
-     * @returns {Question|Symbol|null}
+     * @param {import('#typedefs/section-types.d.ts').StaticGetNextQuestionParams} params
+     * @returns {import('./questions/question.js').Question|Symbol|null}
      */
-    static getNextQuestion({ questions, questionFieldName, response, takeNextQuestion, reverse }: import("./section-types.d.ts").StaticGetNextQuestionParams): Question | Symbol | null;
+    static getNextQuestion({ questions, questionFieldName, response, takeNextQuestion, reverse }: import("#typedefs/section-types.d.ts").StaticGetNextQuestionParams): import("./questions/question.js").Question | Symbol | null;
     /**
      * creates an instance of a section
      * @param {string} name
@@ -31,9 +34,9 @@ export class Section {
      */
     segment: string;
     /**
-     * @type {Array<Question>} - questions within the section
+     * @type {Array<import('./questions/question.js').Question>} - questions within the section
      */
-    questions: Array<Question>;
+    questions: Array<import("./questions/question.js").Question>;
     /**
      * Add a condition to all questions in this section
      *
@@ -70,22 +73,22 @@ export class Section {
     endMultiQuestionCondition(conditionName: string): this;
     /**
      * Get the next question in this section given a questionParam (question fieldName)
-     * @param {import('./section-types.d.ts').GetNextQuestionParams} params
-     * @returns {Question|Symbol|null}
+     * @param {import('#typedefs/section-types.d.ts').GetNextQuestionParams} params
+     * @returns {import('./questions/question.js').Question|Symbol|null}
      */
-    getNextQuestion(params: import("./section-types.d.ts").GetNextQuestionParams): Question | Symbol | null;
+    getNextQuestion(params: import("#typedefs/section-types.d.ts").GetNextQuestionParams): import("./questions/question.js").Question | Symbol | null;
     /**
      * checks answers on response to ensure that a answer is provided for each required question in the section
-     * @param {JourneyResponse} journeyResponse
+     * @param {import('#journey-response').JourneyResponse} journeyResponse
      * @returns {SectionStatus}
      */
-    getStatus(journeyResponse: JourneyResponse): SectionStatus;
+    getStatus(journeyResponse: import("#journey-response").JourneyResponse): SectionStatus;
     /**
      * checks answers on response and return true if the status of the section is complete
-     * @param {JourneyResponse} journeyResponse
+     * @param {import('#journey-response').JourneyResponse} journeyResponse
      * @returns {boolean}
      */
-    isComplete(journeyResponse: JourneyResponse): boolean;
+    isComplete(journeyResponse: import("#journey-response").JourneyResponse): boolean;
     #private;
 }
 export type SECTION_STATUS = SectionStatus;
@@ -100,8 +103,6 @@ export const SECTION_STATUS: Readonly<{
     IN_PROGRESS: "In progress";
     COMPLETE: "Completed";
 }>;
-export type Question = any;
-export type JourneyResponse = any;
-export type QuestionCondition = ((response: JourneyResponse) => boolean);
+export type QuestionCondition = ((response: import("#journey-response").JourneyResponse) => boolean);
 export type SectionStatus = string;
 //# sourceMappingURL=section.d.ts.map

package/src/section.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"section.d.ts","sourceRoot":"","sources":["section.js"],"names":[],"mappings":"AAGA;;GAEG;AAEH;;;;GAIG;AACH,6BAFU,MAAM,CAEuC;AAEvD;;;GAGG;AACH;IAgNC;;;;;OAKG;IACH,8FAHW,OAAO,8BAA8B,EAAE,2BAA2B,GAChE,OAAO,yBAAyB,EAAE,QAAQ,GAAC,MAAM,GAAC,IAAI,CAoBlE;IAvMD;;;;OAIG;IACH,kBAHW,MAAM,WACN,MAAM,EAKhB;IAxCD;;OAEG;IACH,MAFU,MAAM,CAEX;IAEL;;OAEG;IACH,SAFU,MAAM,CAER;IAER;;OAEG;IACH,WAFU,KAAK,CAAC,OAAO,yBAAyB,EAAE,QAAQ,CAAC,CAE5C;IA6Bf;;;;;OAKG;IACH,2CAHW,iBAAiB,GACf,IAAI,CAchB;IAED;;;;;OAKG;IACH,sBAJW,OAAO,yBAAyB,EAAE,QAAQ,sBAC1C,OAAO,iDAAiD,EAAE,iBAAiB,GACzE,IAAI,CAgBhB;IA8BD;;;;OAIG;IACH,qCAHW,iBAAiB,GACf,IAAI,CAahB;IAED,kFAoBC;IAED;;;;;OAKG;IACH,2CAJW,MAAM,yBACN,iBAAiB,GACf,IAAI,CAQhB;IAED;;;;OAIG;IACH,yCAHW,MAAM,GACJ,IAAI,CAQhB;IAED;;;;OAIG;IACH,wBAHW,OAAO,8BAA8B,EAAE,qBAAqB,GAC1D,OAAO,yBAAyB,EAAE,QAAQ,GAAC,MAAM,GAAC,IAAI,CAuBlE;IA4BD;;;;OAIG;IACH,2BAHW,OAAO,mBAAmB,EAAE,eAAe,GACzC,aAAa,CAoDzB;IAED;;;;OAIG;IACH,4BAHW,OAAO,mBAAmB,EAAE,eAAe,GACzC,OAAO,CAInB;;CAKD;6BAOS,aAAa;AALvB;;GAEG;AAEH;;GAEG;AACH;;;;GAIG;gCA1UU,CAAC,CAAC,QAAQ,EAAE,OAAO,mBAAmB,EAAE,eAAe,KAAK,OAAO,CAAC;4BAgUpE,MAAM"}

package/src/section.js

@@ -1,12 +1,10 @@
-/**
- * @typedef {import('./questions/question').Question} Question
- * @typedef {import('./journey/journey-response').JourneyResponse} JourneyResponse
- * @typedef {((response: JourneyResponse) => boolean)} QuestionCondition
- */
-
 import RequiredValidator from './validator/required-validator.js';
 import { answerObjectForManageList } from '#src/components/manage-list/utils.js';
 
+/**
+ * @typedef {((response: import('#journey-response').JourneyResponse) => boolean)} QuestionCondition
+ */
+
 /**
  * A value indicating the final question of a section has been reached
  *
@@ -30,7 +28,7 @@ export class Section {
 	segment;
 
 	/**
-	 * @type {Array<Question>} - questions within the section
+	 * @type {Array<import('./questions/question.js').Question>} - questions within the section
 	 */
 	questions = [];
 
@@ -105,7 +103,7 @@ export class Section {
 
 	/**
 	 * Apply conditions to the given question
-	 * @param {any} question
+	 * @param {import('./questions/question.js').Question} question
 	 * @param [condition] - specific condition for this question
 	 */
 	#applyConditions(question, condition) {
@@ -200,8 +198,8 @@ export class Section {
 
 	/**
 	 * Get the next question in this section given a questionParam (question fieldName)
-	 * @param {import('./section-types.d.ts').GetNextQuestionParams} params
-	 * @returns {Question|Symbol|null}
+	 * @param {import('#typedefs/section-types.d.ts').GetNextQuestionParams} params
+	 * @returns {import('./questions/question.js').Question|Symbol|null}
 	 */
 	getNextQuestion(params) {
 		const { response, manageListQuestion, routeParams } = params;
@@ -229,8 +227,8 @@ export class Section {
 	/**
 	 * Implementation of getNextQuestion given a list of questions
 	 *
-	 * @param {import('./section-types.d.ts').StaticGetNextQuestionParams} params
-	 * @returns {Question|Symbol|null}
+	 * @param {import('#typedefs/section-types.d.ts').StaticGetNextQuestionParams} params
+	 * @returns {import('./questions/question.js').Question|Symbol|null}
 	 */
 	static getNextQuestion({ questions, questionFieldName, response, takeNextQuestion = false, reverse = false }) {
 		const numberOfQuestions = questions.length;
@@ -254,7 +252,7 @@ export class Section {
 
 	/**
 	 * checks answers on response to ensure that a answer is provided for each required question in the section
-	 * @param {JourneyResponse} journeyResponse
+	 * @param {import('#journey-response').JourneyResponse} journeyResponse
 	 * @returns {SectionStatus}
 	 */
 	getStatus(journeyResponse) {
@@ -311,7 +309,7 @@ export class Section {
 
 	/**
 	 * checks answers on response and return true if the status of the section is complete
-	 * @param {JourneyResponse} journeyResponse
+	 * @param {import('#journey-response').JourneyResponse} journeyResponse
 	 * @returns {boolean}
 	 */
 	isComplete(journeyResponse) {

package/src/validator/address-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"address-validator.d.ts","sourceRoot":"","sources":["address-validator.js"],"names":[],"mappings":"AAIO,4EAQN;AAGD,oCAAqC,GAAG,CAAC;AACzC,oCAAqC,CAAC,CAAC;AACvC,oCAAqC,GAAG,CAAC;AACzC,oCAAqC,CAAC,CAAC;AACvC,gCAAiC,GAAG,CAAC;AACrC,gCAAiC,CAAC,CAAC;AACnC,8BAA+B,GAAG,CAAC;AACnC,8BAA+B,CAAC,CAAC;AACjC,gCAAiC,CAAC,CAAC;AACnC,gCAAiC,CAAC,CAAC;AAEnC;;;GAGG;AACH;IACC;;;;OAIG;IACH,mBAFG;QAAqH,cAAc;0BAA5G,OAAO;0BAAgB,OAAO;sBAAY,OAAO;oBAAU,OAAO;sBAAY,OAAO;;KAAwB,EAKtI;IADA;sBAJyB,OAAO;sBAAgB,OAAO;kBAAY,OAAO;gBAAU,OAAO;kBAAY,OAAO;kBAIpE;IAG3C;;;OAGG;IACH,sBAFW,OAAO,0BAA0B,EAAE,QAAQ,iDAYrD;;CAqGD;;0BA1JyB,qBAAqB"}

package/src/validator/base-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-validator.d.ts","sourceRoot":"","sources":["base-validator.js"],"names":[],"mappings":"AAAA;;;GAGG;AACH;IACC;;OAEG;IACH,cAFU,MAAM,CAEH;IAQb;;;;;;;OAOG;IAEH,sBALW;QAAC,SAAS,EAAE,MAAM,CAAA;KAAC,oBACnB,OAAO,gCAAgC,EAAE,eAAe,GACtD,OAAO,mBAAmB,EAAE,eAAe,GAAG,OAAO,mBAAmB,EAAE,eAAe,EAAE,CAKvG;IAED;;;;;OAKG;IACH,sBAEC;CACD"}

package/src/validator/conditional-required-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"conditional-required-validator.d.ts","sourceRoot":"","sources":["conditional-required-validator.js"],"names":[],"mappings":"AAKA;;GAEG;AAEH;;;GAGG;AACH;IAMC;;;OAGG;IACH,2BAFW,MAAM,EAQhB;IAED;;;OAGG;IACH,sBAFW,OAAO,kCAAkC,EAAE,eAAe,WAcpE;IAED,+DAEC;IAED,2FAKC;CACD;;;0BAzDyB,qBAAqB"}

package/src/validator/confirmation-checkbox-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"confirmation-checkbox-validator.d.ts","sourceRoot":"","sources":["confirmation-checkbox-validator.js"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;GAGG;AACH;IAMC;;;;;OAKG;IACH,4CAHG;QAAuB,YAAY,EAA3B,MAAM;QACS,YAAY,EAA3B,MAAM;KAChB,EAMA;IAFA,qBAAgC;IAIjC;;OAEG;IACH,wDAEC;CACD;;;0BAnCyB,qBAAqB"}

package/src/validator/coordinates-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"coordinates-validator.d.ts","sourceRoot":"","sources":["coordinates-validator.js"],"names":[],"mappings":"AAGA,uCAAwC,CAAC,CAAC;AAE1C;;;;GAIG;AACH;IACC;;;OAGG;IACH,sBAHW,eAAe,WACf,eAAe,EAMzB;IAFA,0BAAwB;IACxB,yBAAsB;IAGvB,0DAkCC;CACD;;;WAjDa,MAAM;eACN,MAAM;;0BARM,qBAAqB"}

package/src/validator/cross-question-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cross-question-validator.d.ts","sourceRoot":"","sources":["cross-question-validator.js"],"names":[],"mappings":"AAGA;;GAEG;AACH;IAUC;;;;;;;;OAQG;IACH,kGAPG;QAAuB,mBAAmB,EAAlC,MAAM;QACyE,kBAAkB,EAAjG,CAAC,CAAC,aAAa,EAAE,OAAO,EAAE,gBAAgB,EAAE,OAAO,KAAK,OAAO,CAAC,GAAE,IAAI;QACrD,aAAa;QACb,uBAAuB;KAChD,EAsBF;IArCD,qBAAqB;IACrB,qBADW,MAAM,CACG;IACpB,+EAA+E;IAC/E,oBADW,CAAC,CAAC,aAAa,EAAE,OAAO,EAAE,gBAAgB,EAAE,OAAO,KAAK,OAAO,CAAC,CACxD;IACnB,sBAAsB;IACtB,eADW,OAAO,CACJ;IACd,sBAAsB;IACtB,yBADW,OAAO,CACM;IA8CxB;;;;;;;OAOG;IACH,sBAJW,OAAO,0BAA0B,EAAE,QAAQ,oBAC3C,OAAO,gCAAgC,EAAE,eAAe,GACtD,OAAO,mBAAmB,EAAE,eAAe,EAAE,CAuCzD;;CACD;;0BA1GyB,qBAAqB"}

package/src/validator/date-period-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"date-period-validator.d.ts","sourceRoot":"","sources":["date-period-validator.js"],"names":[],"mappings":"AAQA;;;;GAIG;AAEH;;;GAGG;AACH;IAIC;;;;;OAKG;IACH,wBAJW,MAAM,2BACN,sBAAsB,kBACtB,MAAM,EAgChB;IAvCD,qCAAqC;IACrC,wBADW,sBAAsB,CACV;IAoBtB,uBAAmG;IACnG,uBAAmG;IACnG,yBAAyG;IACzG,wBAAsG;IACtG,4BAAkH;IAClH,2BAA+G;IAC/G,6BACuF;IACvF,6BACuF;IACvF,8BACyF;IACzF,6BACuF;IACvF,4BAAkH;IAClH,0BAA4G;IAK7G;;;OAGG;IACH,sBAFW,OAAO,gCAAgC,EAAE,YAAY,iDAsB/D;IAED;;;;sDAuCC;IAED;;;;sDAwBC;IAED;;;;sDAuBC;;CA6BD;;;;;;0BAxMyB,qBAAqB"}

package/src/validator/date-time-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"date-time-validator.d.ts","sourceRoot":"","sources":["date-time-validator.js"],"names":[],"mappings":"AAGA;;;GAGG;AACH;IACC;;;;;;OAMG;IACH,4BALW,MAAM,mBACN,MAAM,2BACN,sBAAsB,sBACtB,MAAM,EAahB;IADA,uBAAoC;IAGrC;;;OAGG;IACH,sBAFW,OAAO,qCAAqC,EAAE,gBAAgB,iDAsCxE;CACD;;0BApEyB,qBAAqB"}

package/src/validator/date-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"date-validator.d.ts","sourceRoot":"","sources":["date-validator.js"],"names":[],"mappings":"AAOA;;;;;GAKG;AAEH;;;GAGG;AACH;IAIC;;;;;OAKG;IACH,wBAJW,MAAM,2BACN,sBAAsB,kBACtB,MAAM,EAiChB;IAxCD,qCAAqC;IACrC,wBADW,sBAAsB,CACV;IAqBtB,uBAAmG;IACnG,uBAAmG;IACnG,yBAAyG;IACzG,wBAAsG;IACtG,4BAAkH;IAClH,2BAA+G;IAC/G,6BACuF;IACvF,6BACuF;IACvF,8BACyF;IACzF,6BACuF;IACvF,4BAAkH;IAClH,0BAA4G;IAS7G;;;OAGG;IACH,sBAFW,OAAO,gCAAgC,EAAE,YAAY,iDA0H/D;;CA6BD;;;;;;;0BAtNyB,qBAAqB"}

package/src/validator/document-upload-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-upload-validator.d.ts","sourceRoot":"","sources":["document-upload-validator.js"],"names":[],"mappings":"AAGA;IACC;;;OAGG;IACH,uBAHW,MAAM,iBACN,MAAM,EAMhB;IAFA,kBAA0B;IAI3B,0DAYC;CACD;;0BA3ByB,qBAAqB"}

package/src/validator/email-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"email-validator.d.ts","sourceRoot":"","sources":["email-validator.js"],"names":[],"mappings":"AAIA;;;;;;;GAOG;AAEH;IACC;;;;;OAKG;IACH,mDAJG;QAAwC,OAAO;QACvB,YAAY;QACZ,SAAS;KACnC,EAcA;IAVA;;;;;;;;;;;;;;;;;;;;;;;;;MAMC;IAGD,8BAA0B;IAG3B,wEAIC;CACD;;;;;;;;;;;;;;;;;;;;;;;;0BAtCyB,qBAAqB"}

package/{types/src → src}/validator/multi-field-input-validator.d.ts

@@ -1,17 +1,17 @@
 /**
  * @typedef {Object} Regex
  * @property {String | RegExp} regex
- * @property {String} regexMessage
+ * @property {string} regexMessage
  */
 /**
  * @typedef {Object} MinLength
  * @property {Number} minLength
- * @property {String} minLengthMessage
+ * @property {string} minLengthMessage
  */
 /**
  * @typedef {Object} MaxLength
  * @property {Number} maxLength
- * @property {String} maxLengthMessage
+ * @property {string} maxLengthMessage
  */
 /**
  * @typedef {Object} FieldBase

package/src/validator/multi-field-input-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"multi-field-input-validator.d.ts","sourceRoot":"","sources":["multi-field-input-validator.js"],"names":[],"mappings":"AAGA;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;;;GAMG;AAEH;;;;;GAKG;AAEH;;;;;GAKG;AAEH;;GAEG;AAEH;IACC;;;;OAIG;IACH,0CAHG;QAAyB,MAAM;QACP,eAAe;KAAC,EAQ1C;IAFA,gBAAoB;IACpB,wBAAwE;IAGzE;;OAEG;IAEH,0DA8BC;IAKD;;;;OAIG;IACH,gCAHW,MAAM,GACJ,OAAO,CAQnB;CACD;;;WA3Ga,SAAS,MAAM;kBACf,MAAM;;;;sBAMN,MAAM;;;;sBAMN,MAAM;;;eAKN,MAAM;;;;;4BAOP,SAAS,GAAG;IACpB,QAAQ,EAAE,IAAI,CAAC;IACf,YAAY,EAAE,MAAM,CAAA;CACrB;4BAIS,SAAS,GAAG;IACpB,QAAQ,CAAC,EAAE,KAAK,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;oBAIS,aAAa,GAAG,aAAa;0BA1ChB,qBAAqB"}

package/src/validator/multi-field-input-validator.js

@@ -4,19 +4,19 @@ import BaseValidator from './base-validator.js';
 /**
  * @typedef {Object} Regex
  * @property {String | RegExp} regex
- * @property {String} regexMessage
+ * @property {string} regexMessage
  */
 
 /**
  * @typedef {Object} MinLength
  * @property {Number} minLength
- * @property {String} minLengthMessage
+ * @property {string} minLengthMessage
  */
 
 /**
  * @typedef {Object} MaxLength
  * @property {Number} maxLength
- * @property {String} maxLengthMessage
+ * @property {string} maxLengthMessage
  */
 
 /**

package/{types/src → src}/validator/numeric-validator.d.ts

@@ -1,12 +1,12 @@
 /**
  * @typedef {Object} MinValue
  * @property {Number} min
- * @property {String} minMessage
+ * @property {string} minMessage
  */
 /**
  * @typedef {Object} MaxValue
  * @property {Number} max
- * @property {String} maxMessage
+ * @property {string} maxMessage
  */
 export class NumericValidator extends BaseValidator {
     /**

package/src/validator/numeric-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"numeric-validator.d.ts","sourceRoot":"","sources":["numeric-validator.js"],"names":[],"mappings":"AAIA;;;;GAIG;AAEH;;;;GAIG;AAEH;IACC;;;;;;;;;OASG;IACH,mFARG;QAAwB,GAAG;QACH,UAAU;QACV,GAAG;QACH,UAAU;QACV,KAAK;QACL,YAAY;QACZ,SAAS;KAAC,EAWpC;IAPA,wBAAc;IACd,mBAAmE;IACnE,wBAAc;IACd,mBAAkE;IAClE,0BAAkB;IAClB,qBAA0D;IAC1D,8BAA0B;IAG3B,wEAgBC;CACD;;;;gBAhDa,MAAM;;;;gBAMN,MAAM;;0BAXM,qBAAqB"}

package/src/validator/numeric-validator.js

@@ -5,13 +5,13 @@ import BaseValidator from './base-validator.js';
 /**
  * @typedef {Object} MinValue
  * @property {Number} min
- * @property {String} minMessage
+ * @property {string} minMessage
  */
 
 /**
  * @typedef {Object} MaxValue
  * @property {Number} max
- * @property {String} maxMessage
+ * @property {string} maxMessage
  */
 
 export class NumericValidator extends BaseValidator {

package/src/validator/required-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"required-validator.d.ts","sourceRoot":"","sources":["required-validator.js"],"names":[],"mappings":"AAIA;;;GAGG;AACH;IAMC;;;OAGG;IACH,2BAFW,MAAM,EAQhB;IAED;;;OAGG;IACH,sBAFW,OAAO,0BAA0B,EAAE,QAAQ,+CAIrD;CAKD;;0BAnCyB,qBAAqB"}

package/src/validator/same-answer-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"same-answer-validator.d.ts","sourceRoot":"","sources":["same-answer-validator.js"],"names":[],"mappings":"AAGA;;GAEG;AACH;IACC;;;OAGG;IAEH,iCAJW,MAAM,EAAE,iBACR,MAAM,EAOhB;IAFA,8BAAoD;IAIrD;;;OAGG;IACH,wEAQC;CACD;;0BA9ByB,qBAAqB"}

package/{types/src → src}/validator/string-validator.d.ts

@@ -1,17 +1,17 @@
 /**
  * @typedef {Object} MinLength
  * @property {Number} minLength
- * @property {String} [minLengthMessage]
+ * @property {string} [minLengthMessage]
  */
 /**
  * @typedef {Object} MaxLength
  * @property {Number} maxLength
- * @property {String} [maxLengthMessage]
+ * @property {string} [maxLengthMessage]
  */
 /**
  * @typedef {Object} Regex
  * @property {String | RegExp} regex
- * @property {String} [regexMessage]
+ * @property {string} [regexMessage]
  */
 export class StringValidator extends BaseValidator {
     /**

package/src/validator/string-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"string-validator.d.ts","sourceRoot":"","sources":["string-validator.js"],"names":[],"mappings":"AAGA;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH;IAcC;;;;;;OAMG;IACH,yDALG;QAA2B,SAAS;QACT,SAAS;QACb,KAAK;QACJ,SAAS;KAAC,EAmBpC;IArCD;;;MAGE;IACF;;;MAGE;IACF;;;MAGE;IAyBD,8BAA0B;IAG3B,wEAkBC;CACD;;;;;;;;;;;WA/Da,SAAS,MAAM;;;0BAfH,qBAAqB"}

package/src/validator/string-validator.js

@@ -4,19 +4,19 @@ import BaseValidator from './base-validator.js';
 /**
  * @typedef {Object} MinLength
  * @property {Number} minLength
- * @property {String} [minLengthMessage]
+ * @property {string} [minLengthMessage]
  */
 
 /**
  * @typedef {Object} MaxLength
  * @property {Number} maxLength
- * @property {String} [maxLengthMessage]
+ * @property {string} [maxLengthMessage]
  */
 
 /**
  * @typedef {Object} Regex
  * @property {String | RegExp} regex
- * @property {String} [regexMessage]
+ * @property {string} [regexMessage]
  */
 
 export class StringValidator extends BaseValidator {

package/src/validator/unit-option-entry-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unit-option-entry-validator.d.ts","sourceRoot":"","sources":["unit-option-entry-validator.js"],"names":[],"mappings":"AAKA;;;GAGG;AACH;IACC;;;;;;;;OAQG;IAEH,oEARG;QAAwB,YAAY;QACZ,IAAI;QACJ,GAAG;QACH,GAAG;QACJ,KAAK;QACJ,YAAY;KAAC,EAWvC;IALA,aAA2B;IAC3B,wBAAc;IACd,wBAAc;IACd,WAAkB;IAClB,qBAA0D;IAG3D;;;OAGG;IACH,sBAFW,OAAO,6CAA6C,EAAE,uBAAuB,WA4CvF;IAED,2FAKC;CACD;;0BAlFyB,qBAAqB"}

package/src/validator/valid-option-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"valid-option-validator.d.ts","sourceRoot":"","sources":["valid-option-validator.js"],"names":[],"mappings":"AAKA;;;GAGG;AACH;IACC;;;OAGG;IACH,2BAFW,MAAM,EAUhB;IAED;;;OAGG;IACH,sBAFW,OAAO,kCAAkC,EAAE,OAAO,+CAU5D;CACD;;0BAnCyB,qBAAqB"}

package/src/validator/validation-error-handler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation-error-handler.d.ts","sourceRoot":"","sources":["validation-error-handler.js"],"names":[],"mappings":"AAEA;;;;GAIG;AAEH;;GAEG;AACH,sDAFU,cAAc,CAkBtB;AAQK,uDAJI,OAAO,mBAAmB,EAAE,aAAa,CAAC,OAAO,mBAAmB,EAAE,eAAe,CAAC,mBACtF,cAAc,GACZ,OAAO,SAAS,EAAE,OAAO,CA2BrC;AAED,+DAAoE;6BA3DvD;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAC,EAAE;;;;6BAE9B,CAAC,MAAM,EAAE,uBAAuB,KAAK,cAAc"}

package/src/validator/validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validator.d.ts","sourceRoot":"","sources":["validator.js"],"names":[],"mappings":"AA4BA,oDACe,QAAG,EAAE,QAAG,EAAE,SAAI,kBAM5B;;AAjCD,wCAAwC;AACxC,wBADW,OAAO,SAAS,EAAE,OAAO,CAsBlC"}

package/test/questions.js

@@ -4,7 +4,7 @@ import { questionClasses } from '../src/questions/questions.js';
 import EmailValidator from '../src/validator/email-validator.js';
 
 /**
- * @typedef {import('../src/questions/question-props.js').QuestionProps} Props
+ * @typedef {import('#typedefs/question-props.d.ts').QuestionProps} Props
  */
 
 /** @type {Record<string, Props>} */

package/test/secondary-actions.test.js

@@ -10,7 +10,7 @@ import { mockRandomUUID } from '#test/mock/uuid.js';
 import { createJourney as createTestJourney, JOURNEY_ID } from '#test/journey.js';
 
 /**
- * @type {import('../src/questions/question-types.d.ts').SecondaryAction[]}
+ * @type {import('#typedefs/question-types.d.ts').SecondaryAction[]}
  */
 const testSecondaryActions = [
 	{

package/tsconfig.json

@@ -1,6 +1,14 @@
 {
 	"include": ["**/*.ts", "**/*.js"],
-	"exclude": ["node_modules", "packages/database/src/client/**", "**/*.test.ts", "**/*.test.js", "test/**"],
+	"exclude": [
+		"node_modules",
+		"packages/database/src/client/**",
+		"**/*.test.ts",
+		"**/*.test.js",
+		"test/**",
+		"*.config.js",
+		"typedefs/**"
+	],
 	"compilerOptions": {
 		"allowImportingTsExtensions": true,
 		"allowJs": true,
@@ -14,13 +22,12 @@
 		"esModuleInterop": true,
 		"module": "NodeNext",
 		"moduleResolution": "nodenext",
-		"outDir": "types",
-		"rootDir": ".",
 		"strict": true,
 		"target": "esnext",
 		"skipLibCheck": true,
 		"paths": {
-			"#question-types": ["./src/questions/question-types.d.ts"],
+			"#question-types": ["./typedefs/question-types.d.ts"],
+			"#typedefs/*": ["./typedefs/*"],
 			"#src/*": ["./src/*"],
 			"#test/*": ["./test/*"],
 			"#question": ["./src/questions/question.js"],

package/{types/src/questions → typedefs}/question-props.d.ts

@@ -1,6 +1,6 @@
-import type { QuestionParameters } from '#src/questions/question-types.d.ts';
+import type { QuestionParameters } from './question-types.d.ts';
 
-type QuestionTypes =
+export type QuestionTypes =
 	| 'boolean'
 	| 'checkbox'
 	| 'date'
@@ -26,7 +26,7 @@ export type CommonQuestionParams = Omit<QuestionParameters, 'viewFolder'>;
 /**
  * Full props including type for routing/factory layer
  */
-type CommonQuestionProps = CommonQuestionParams & {
+export type CommonQuestionProps = CommonQuestionParams & {
 	type: QuestionTypes;
 };
 
@@ -37,29 +37,31 @@ export type BaseQuestionProps = CommonQuestionParams & {
 	type: string;
 };
 
-type Option =
-	| {
-			text: string;
-			value: string;
-			hint?: object;
-			checked?: boolean | undefined;
-			attributes?: Record<string, string>;
-			behaviour?: 'exclusive';
-			conditional?: {
-				question: string;
-				type: string;
-				fieldName: string;
-				inputClasses?: string;
-				html?: string;
-				value?: unknown;
-				label?: string;
-				hint?: string;
-			};
-			conditionalText?: {
-				html: string;
-			};
-	  }
-	| { divider?: string };
+export type SelectableOption = {
+	text: string;
+	value: string;
+	hint?: object;
+	checked?: boolean | undefined;
+	attributes?: Record<string, string>;
+	behaviour?: 'exclusive';
+	conditional?: {
+		question: string;
+		type: string;
+		fieldName: string;
+		inputClasses?: string;
+		html?: string;
+		value?: unknown;
+		label?: string;
+		hint?: string;
+	};
+	conditionalText?: {
+		html: string;
+	};
+};
+
+export type DividerOption = { divider?: string };
+
+export type Option = SelectableOption | DividerOption;
 
 type Affix = {
 	text: string;

package/{src/questions → typedefs}/question-types.d.ts

@@ -1,7 +1,7 @@
-import type { RouteParams } from '#src/journey/journey-types.d.ts';
+import type { RouteParams } from './journey-types.d.ts';
 import type ManageListQuestion from '#src/components/manage-list/question.js';
-import type BaseValidator from '../validator/base-validator.js';
-import type { JourneyResponse } from '../journey/journey-response.js';
+import type BaseValidator from '#src/validator/base-validator.js';
+import type { JourneyResponse } from '#src/journey/journey-response.js';
 
 export interface QuestionParameters {
 	title: string;
@@ -55,23 +55,33 @@ export interface SecondaryActionLink {
 	classes?: string;
 }
 
-export interface QuestionViewModel {
-	question: {
-		value: string | number | Record<string, any>;
-		question: string;
-		fieldName: string;
-		pageTitle: string;
-		description?: string;
-		html?: string;
-	};
+interface BaseQuestionViewData {
+	value: unknown;
+	question: string;
+	fieldName: string;
+	pageTitle: string;
+	description?: string;
+	html?: string;
+	hint?: string;
+	interfaceType?: string;
+	autocomplete?: string;
+}
+
+export interface QuestionViewModel<TQuestionViewData extends BaseQuestionViewData = BaseQuestionViewData> {
+	question: TQuestionViewData;
+	answer: unknown;
 	layoutTemplate: string;
-	pageCaption: string;
+	pageCaption?: string;
 	continueButtonText: string;
-	backLink: string;
-	showBackToListLink: string;
+	backLink?: string;
+	showBackToListLink: boolean;
 	listLink: string;
 	journeyTitle: string;
-	[k: string]: any;
+	payload?: unknown;
+	util: {
+		trimTrailingSlash: (str: string) => string;
+	};
+	[key: string]: unknown;
 }
 
 export interface PrepQuestionForRenderingOptions {
@@ -84,3 +94,21 @@ export interface PrepQuestionForRenderingOptions {
  * Question class and still pass them to the createQuestions function.
  */
 export type QuestionClass<TQuestion extends Question = Question> = new (...args: never[]) => TQuestion;
+
+/**
+ * Action link displayed in summary lists
+ */
+export interface ActionView {
+	href: string;
+	text: string;
+	visuallyHiddenText?: string;
+}
+
+/**
+ * A row in a summary list, returned by formatAnswerForSummary
+ */
+export interface SummaryRow {
+	key: string;
+	value: string;
+	action?: ActionView | ActionView[];
+}

package/{src → typedefs}/section-types.d.ts

@@ -1,7 +1,7 @@
 import { JourneyResponse } from '#src/journey/journey-response.js';
 import ManageListQuestion from '#src/components/manage-list/question.js';
 import { Question } from '#src/questions/question.js';
-import { RouteParams } from '#src/journey/journey-types.d.ts';
+import { RouteParams } from './journey-types.d.ts';
 
 export interface GetNextQuestionParams {
 	questionFieldName: string;

package/typedefs/section-types.js

@@ -0,0 +1 @@
+// empty source file to go with .d.ts file

package/move-types.js

@@ -1,12 +0,0 @@
-import { copyFile } from 'node:fs/promises';
-import path from 'path';
-
-const filesToCopy = ['questions/question-props.d.ts', 'questions/question-types.d.ts', 'journey/journey-types.d.ts'];
-
-// copy some of the type definition files to the types output that are not automatically included
-for (const file of filesToCopy) {
-	const src = path.join(import.meta.dirname, 'src', file);
-	const dest = path.join(import.meta.dirname, 'types', 'src', file);
-	await copyFile(src, dest);
-	console.log(`Copied ${src} to ${dest}`);
-}