@planning-inspectorate/dynamic-forms 3.20.5 → 3.22.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (69) hide show
  1. package/README.md +100 -0
  2. package/docs/Dynamic Sections.md +47 -0
  3. package/docs/Getting Started.md +8 -2
  4. package/package.json +1 -1
  5. package/src/components/boolean/question.d.ts +1 -1
  6. package/src/components/boolean/question.js +1 -1
  7. package/src/components/date/question.d.ts +1 -1
  8. package/src/components/date/question.js +1 -1
  9. package/src/components/date-period/question.d.ts +1 -1
  10. package/src/components/date-period/question.js +1 -1
  11. package/src/components/date-time/question.d.ts +1 -1
  12. package/src/components/date-time/question.js +1 -1
  13. package/src/components/manage-list/question.d.ts.map +1 -1
  14. package/src/components/manage-list/question.js +5 -0
  15. package/src/components/manage-list/question.test.js +3 -1
  16. package/src/components/multi-field-input/question.d.ts.map +1 -1
  17. package/src/components/multi-field-input/question.js +8 -6
  18. package/src/components/multi-field-input/question.test.js +126 -213
  19. package/src/components/single-line-input/index.njk +4 -0
  20. package/src/components/single-line-input/question.d.ts +2 -0
  21. package/src/components/single-line-input/question.d.ts.map +1 -1
  22. package/src/components/single-line-input/question.js +4 -0
  23. package/src/components/single-line-input/question.test.js +6 -0
  24. package/src/components/text-entry-redact/question.d.ts.map +1 -1
  25. package/src/components/text-entry-redact/question.js +3 -1
  26. package/src/components/text-entry-redact/question.test.js +9 -0
  27. package/src/components/unit-option-entry/question.d.ts +1 -1
  28. package/src/components/unit-option-entry/question.d.ts.map +1 -1
  29. package/src/components/unit-option-entry/question.js +4 -2
  30. package/src/components/unit-option-entry/question.test.js +9 -0
  31. package/src/controller.d.ts +15 -3
  32. package/src/controller.d.ts.map +1 -1
  33. package/src/controller.js +19 -11
  34. package/src/controller.test.js +182 -153
  35. package/src/dynamic-section.d.ts +40 -0
  36. package/src/dynamic-section.d.ts.map +1 -0
  37. package/src/dynamic-section.js +51 -0
  38. package/src/dynamic-section.test.js +113 -0
  39. package/src/index.d.ts +2 -1
  40. package/src/index.js +2 -1
  41. package/src/index.test.js +3 -0
  42. package/src/journey/journey.d.ts +10 -0
  43. package/src/journey/journey.d.ts.map +1 -1
  44. package/src/journey/journey.js +15 -0
  45. package/src/lib/answer-utils.d.ts +22 -0
  46. package/src/lib/answer-utils.d.ts.map +1 -0
  47. package/src/lib/answer-utils.js +34 -0
  48. package/src/{components/manage-list/utils.test.js → lib/answer-utils.test.js} +9 -11
  49. package/src/lib/session-answer-store.d.ts.map +1 -1
  50. package/src/lib/session-answer-store.js +14 -6
  51. package/src/lib/session-answer-store.test.js +43 -0
  52. package/src/middleware/redirect-to-unanswered-question.d.ts.map +1 -1
  53. package/src/middleware/redirect-to-unanswered-question.js +4 -3
  54. package/src/middleware/redirect-to-unanswered-question.test.js +32 -0
  55. package/src/questions/options-question.js +1 -1
  56. package/src/questions/question.d.ts +8 -3
  57. package/src/questions/question.d.ts.map +1 -1
  58. package/src/questions/question.js +16 -6
  59. package/src/questions/question.test.js +19 -0
  60. package/src/section.d.ts +19 -0
  61. package/src/section.d.ts.map +1 -1
  62. package/src/section.js +50 -9
  63. package/src/section.test.js +9 -0
  64. package/test/dynamic-journey.test.js +372 -0
  65. package/typedefs/question-props.d.ts +3 -1
  66. package/typedefs/question-types.d.ts +3 -0
  67. package/src/components/manage-list/utils.d.ts +0 -18
  68. package/src/components/manage-list/utils.d.ts.map +0 -1
  69. package/src/components/manage-list/utils.js +0 -35
package/src/components/manage-list/utils.d.ts DELETED
@@ -1,18 +0,0 @@
1
- /**
2
- *
3
- * @param {import('../../journey/journey-response.js').JourneyResponse} response
4
- * @param {import('./question.js')} manageListQuestion
5
- * @param {string} manageListItemId
6
- * @returns {Record<string, unknown>}
7
- */
8
- export function answerObjectForManageList(response: import("../../journey/journey-response.js").JourneyResponse, manageListQuestion: typeof import("./question.js"), manageListItemId: string): Record<string, unknown>;
9
- /**
10
- * Similar to answerObjectForManageList but will edit response and add a new array entry if not found
11
- *
12
- * @param {import('../../journey/journey-response.js').JourneyResponse} response
13
- * @param {import('./question.js')} manageListQuestion
14
- * @param {import('#typedefs/journey-types.d.ts').RouteParams} params
15
- * @returns {import('#typedefs/journey-types.d.ts').ManageListAnswers}
16
- */
17
- export function answerObjectForManageListSaving(response: import("../../journey/journey-response.js").JourneyResponse, manageListQuestion: typeof import("./question.js"), params: import("#typedefs/journey-types.d.ts").RouteParams): import("#typedefs/journey-types.d.ts").ManageListAnswers;
18
- //# sourceMappingURL=utils.d.ts.map
package/src/components/manage-list/utils.d.ts.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["utils.js"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,oDALW,OAAO,mCAAmC,EAAE,eAAe,wEAE3D,MAAM,GACJ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAQnC;AAED;;;;;;;GAOG;AACH,0DALW,OAAO,mCAAmC,EAAE,eAAe,8DAE3D,OAAO,8BAA8B,EAAE,WAAW,GAChD,OAAO,8BAA8B,EAAE,iBAAiB,CAapE"}
package/src/components/manage-list/utils.js DELETED
@@ -1,35 +0,0 @@
1
- /**
2
- *
3
- * @param {import('../../journey/journey-response.js').JourneyResponse} response
4
- * @param {import('./question.js')} manageListQuestion
5
- * @param {string} manageListItemId
6
- * @returns {Record<string, unknown>}
7
- */
8
- export function answerObjectForManageList(response, manageListQuestion, manageListItemId) {
9
- const answers = response.answers[manageListQuestion.fieldName];
10
- if (!Array.isArray(answers)) {
11
- return {};
12
- }
13
- return answers.find((a) => a.id === manageListItemId) || {};
14
- }
15
-
16
- /**
17
- * Similar to answerObjectForManageList but will edit response and add a new array entry if not found
18
- *
19
- * @param {import('../../journey/journey-response.js').JourneyResponse} response
20
- * @param {import('./question.js')} manageListQuestion
21
- * @param {import('#typedefs/journey-types.d.ts').RouteParams} params
22
- * @returns {import('#typedefs/journey-types.d.ts').ManageListAnswers}
23
- */
24
- export function answerObjectForManageListSaving(response, manageListQuestion, params) {
25
- const answersList =
26
- response.answers[manageListQuestion?.fieldName] || (response.answers[manageListQuestion?.fieldName] = []);
27
- let answers = answersList.find((item) => item.id === params.manageListItemId);
28
- if (!answers) {
29
- answers = {
30
- id: params.manageListItemId
31
- };
32
- answersList.push(answers);
33
- }
34
- return answers;
35
- }