@defra/forms-engine-plugin 0.1.10 → 0.1.12

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 (247) hide show
  1. package/.public/javascripts/file-upload.min.js +1 -1
  2. package/.public/javascripts/file-upload.min.js.map +1 -1
  3. package/.public/stylesheets/application.min.css +1 -1
  4. package/.public/stylesheets/application.min.css.map +1 -1
  5. package/.server/client/javascripts/file-upload.js +45 -4
  6. package/.server/client/javascripts/file-upload.js.map +1 -1
  7. package/.server/client/stylesheets/application.scss +10 -0
  8. package/.server/config/index.js +3 -14
  9. package/.server/config/index.js.map +1 -1
  10. package/.server/server/constants.js +2 -0
  11. package/.server/server/constants.js.map +1 -1
  12. package/.server/server/devserver/dxt-devtool-baselayout.html +71 -0
  13. package/.server/server/forms/register-as-a-unicorn-breeder.json +393 -0
  14. package/.server/server/forms/register-as-a-unicorn-breeder.yaml +251 -0
  15. package/.server/server/index.js +12 -17
  16. package/.server/server/index.js.map +1 -1
  17. package/.server/server/plugins/engine/components/AutocompleteField.js +2 -0
  18. package/.server/server/plugins/engine/components/AutocompleteField.js.map +1 -1
  19. package/.server/server/plugins/engine/components/CheckboxesField.js +3 -4
  20. package/.server/server/plugins/engine/components/CheckboxesField.js.map +1 -1
  21. package/.server/server/plugins/engine/components/ComponentCollection.js +37 -16
  22. package/.server/server/plugins/engine/components/ComponentCollection.js.map +1 -1
  23. package/.server/server/plugins/engine/components/DatePartsField.js +36 -2
  24. package/.server/server/plugins/engine/components/DatePartsField.js.map +1 -1
  25. package/.server/server/plugins/engine/components/EmailAddressField.js +19 -3
  26. package/.server/server/plugins/engine/components/EmailAddressField.js.map +1 -1
  27. package/.server/server/plugins/engine/components/FileUploadField.js +44 -4
  28. package/.server/server/plugins/engine/components/FileUploadField.js.map +1 -1
  29. package/.server/server/plugins/engine/components/FormComponent.js +14 -2
  30. package/.server/server/plugins/engine/components/FormComponent.js.map +1 -1
  31. package/.server/server/plugins/engine/components/ListFormComponent.js +16 -3
  32. package/.server/server/plugins/engine/components/ListFormComponent.js.map +1 -1
  33. package/.server/server/plugins/engine/components/Markdown.js +24 -0
  34. package/.server/server/plugins/engine/components/Markdown.js.map +1 -0
  35. package/.server/server/plugins/engine/components/MonthYearField.js +30 -2
  36. package/.server/server/plugins/engine/components/MonthYearField.js.map +1 -1
  37. package/.server/server/plugins/engine/components/MultilineTextField.js +32 -3
  38. package/.server/server/plugins/engine/components/MultilineTextField.js.map +1 -1
  39. package/.server/server/plugins/engine/components/NumberField.js +28 -3
  40. package/.server/server/plugins/engine/components/NumberField.js.map +1 -1
  41. package/.server/server/plugins/engine/components/SelectionControlField.js +14 -0
  42. package/.server/server/plugins/engine/components/SelectionControlField.js.map +1 -1
  43. package/.server/server/plugins/engine/components/TelephoneNumberField.js +19 -3
  44. package/.server/server/plugins/engine/components/TelephoneNumberField.js.map +1 -1
  45. package/.server/server/plugins/engine/components/TextField.js +22 -3
  46. package/.server/server/plugins/engine/components/TextField.js.map +1 -1
  47. package/.server/server/plugins/engine/components/UkAddressField.js +29 -0
  48. package/.server/server/plugins/engine/components/UkAddressField.js.map +1 -1
  49. package/.server/server/plugins/engine/components/YesNoField.js +18 -0
  50. package/.server/server/plugins/engine/components/YesNoField.js.map +1 -1
  51. package/.server/server/plugins/engine/components/helpers.js +16 -0
  52. package/.server/server/plugins/engine/components/helpers.js.map +1 -1
  53. package/.server/server/plugins/engine/components/index.js +1 -0
  54. package/.server/server/plugins/engine/components/index.js.map +1 -1
  55. package/.server/server/plugins/engine/configureEnginePlugin.js +19 -3
  56. package/.server/server/plugins/engine/configureEnginePlugin.js.map +1 -1
  57. package/.server/server/plugins/engine/helpers.js +38 -18
  58. package/.server/server/plugins/engine/helpers.js.map +1 -1
  59. package/.server/server/plugins/engine/models/FormModel.js +60 -2
  60. package/.server/server/plugins/engine/models/FormModel.js.map +1 -1
  61. package/.server/server/plugins/engine/models/SummaryViewModel.js +3 -2
  62. package/.server/server/plugins/engine/models/SummaryViewModel.js.map +1 -1
  63. package/.server/server/plugins/engine/outputFormatters/human/v1.js +1 -1
  64. package/.server/server/plugins/engine/outputFormatters/human/v1.js.map +1 -1
  65. package/.server/server/plugins/engine/pageControllers/PageController.js +13 -5
  66. package/.server/server/plugins/engine/pageControllers/PageController.js.map +1 -1
  67. package/.server/server/plugins/engine/pageControllers/QuestionPageController.js +2 -2
  68. package/.server/server/plugins/engine/pageControllers/QuestionPageController.js.map +1 -1
  69. package/.server/server/plugins/engine/pageControllers/SummaryPageController.js +19 -5
  70. package/.server/server/plugins/engine/pageControllers/SummaryPageController.js.map +1 -1
  71. package/.server/server/plugins/engine/pageControllers/validationOptions.js +6 -11
  72. package/.server/server/plugins/engine/pageControllers/validationOptions.js.map +1 -1
  73. package/.server/server/plugins/engine/plugin.js +32 -20
  74. package/.server/server/plugins/engine/plugin.js.map +1 -1
  75. package/.server/server/plugins/engine/services/formsService.js +15 -29
  76. package/.server/server/plugins/engine/services/formsService.js.map +1 -1
  77. package/.server/server/plugins/engine/services/localFormsService.js +52 -0
  78. package/.server/server/plugins/engine/services/localFormsService.js.map +1 -0
  79. package/.server/server/plugins/engine/services/notifyService.js +1 -4
  80. package/.server/server/plugins/engine/services/notifyService.js.map +1 -1
  81. package/.server/server/plugins/engine/services/uploadService.js +5 -3
  82. package/.server/server/plugins/engine/services/uploadService.js.map +1 -1
  83. package/.server/server/plugins/engine/types.js.map +1 -1
  84. package/.server/server/plugins/engine/views/components/html.html +1 -1
  85. package/.server/server/plugins/engine/views/components/markdown.html +5 -0
  86. package/.server/server/plugins/engine/views/confirmation.html +1 -1
  87. package/.server/server/plugins/engine/views/file-upload.html +1 -1
  88. package/.server/server/plugins/engine/views/index.html +1 -1
  89. package/.server/server/plugins/engine/views/item-delete.html +1 -1
  90. package/.server/server/plugins/engine/views/repeat-list-summary.html +1 -1
  91. package/.server/server/plugins/engine/views/summary.html +8 -2
  92. package/.server/server/plugins/errorPages.js +4 -26
  93. package/.server/server/plugins/errorPages.js.map +1 -1
  94. package/.server/server/plugins/nunjucks/context.js +43 -33
  95. package/.server/server/plugins/nunjucks/context.js.map +1 -1
  96. package/.server/server/plugins/nunjucks/context.test.js +23 -28
  97. package/.server/server/plugins/nunjucks/context.test.js.map +1 -1
  98. package/.server/server/plugins/nunjucks/enviroment.test.js +6 -3
  99. package/.server/server/plugins/nunjucks/enviroment.test.js.map +1 -1
  100. package/.server/server/plugins/nunjucks/types.js +3 -4
  101. package/.server/server/plugins/nunjucks/types.js.map +1 -1
  102. package/.server/server/routes/index.js +0 -1
  103. package/.server/server/routes/index.js.map +1 -1
  104. package/.server/server/utils/type-utils.js +8 -0
  105. package/.server/server/utils/type-utils.js.map +1 -0
  106. package/.server/typings/hapi/index.d.js.map +1 -1
  107. package/.server/typings/joi/index.d.js.map +1 -1
  108. package/package.json +4 -3
  109. package/src/client/javascripts/file-upload.js +60 -4
  110. package/src/client/stylesheets/application.scss +10 -0
  111. package/src/config/index.ts +4 -17
  112. package/src/server/constants.js +2 -0
  113. package/src/server/devserver/dxt-devtool-baselayout.html +71 -0
  114. package/src/server/forms/register-as-a-unicorn-breeder.json +393 -0
  115. package/src/server/forms/register-as-a-unicorn-breeder.yaml +251 -0
  116. package/src/server/index.test.ts +38 -66
  117. package/src/server/index.ts +15 -17
  118. package/src/server/plugins/engine/components/AutocompleteField.test.ts +71 -3
  119. package/src/server/plugins/engine/components/AutocompleteField.ts +6 -2
  120. package/src/server/plugins/engine/components/CheckboxesField.test.ts +40 -8
  121. package/src/server/plugins/engine/components/CheckboxesField.ts +7 -3
  122. package/src/server/plugins/engine/components/ComponentCollection.ts +45 -18
  123. package/src/server/plugins/engine/components/DatePartsField.test.ts +13 -4
  124. package/src/server/plugins/engine/components/DatePartsField.ts +29 -8
  125. package/src/server/plugins/engine/components/EmailAddressField.test.ts +51 -1
  126. package/src/server/plugins/engine/components/EmailAddressField.ts +17 -2
  127. package/src/server/plugins/engine/components/FileUploadField.test.ts +53 -0
  128. package/src/server/plugins/engine/components/FileUploadField.ts +52 -3
  129. package/src/server/plugins/engine/components/FormComponent.ts +24 -2
  130. package/src/server/plugins/engine/components/ListFormComponent.ts +16 -2
  131. package/src/server/plugins/engine/components/Markdown.test.ts +48 -0
  132. package/src/server/plugins/engine/components/Markdown.ts +29 -0
  133. package/src/server/plugins/engine/components/MonthYearField.test.ts +35 -0
  134. package/src/server/plugins/engine/components/MonthYearField.ts +34 -9
  135. package/src/server/plugins/engine/components/MultilineTextField.test.ts +83 -5
  136. package/src/server/plugins/engine/components/MultilineTextField.ts +37 -2
  137. package/src/server/plugins/engine/components/NumberField.test.ts +24 -2
  138. package/src/server/plugins/engine/components/NumberField.ts +23 -3
  139. package/src/server/plugins/engine/components/RadiosField.test.ts +10 -1
  140. package/src/server/plugins/engine/components/SelectField.test.ts +2 -1
  141. package/src/server/plugins/engine/components/SelectionControlField.ts +14 -0
  142. package/src/server/plugins/engine/components/TelephoneNumberField.test.ts +30 -2
  143. package/src/server/plugins/engine/components/TelephoneNumberField.ts +17 -2
  144. package/src/server/plugins/engine/components/TextField.test.ts +33 -1
  145. package/src/server/plugins/engine/components/TextField.ts +17 -2
  146. package/src/server/plugins/engine/components/UkAddressField.test.ts +46 -3
  147. package/src/server/plugins/engine/components/UkAddressField.ts +28 -0
  148. package/src/server/plugins/engine/components/YesNoField.test.ts +9 -1
  149. package/src/server/plugins/engine/components/YesNoField.ts +24 -0
  150. package/src/server/plugins/engine/components/helpers.test.ts +24 -0
  151. package/src/server/plugins/engine/components/helpers.ts +39 -0
  152. package/src/server/plugins/engine/components/index.ts +1 -0
  153. package/src/server/plugins/engine/configureEnginePlugin.ts +32 -4
  154. package/src/server/plugins/engine/helpers.test.ts +71 -20
  155. package/src/server/plugins/engine/helpers.ts +46 -19
  156. package/src/server/plugins/engine/models/FormModel.test.ts +91 -1
  157. package/src/server/plugins/engine/models/FormModel.ts +86 -3
  158. package/src/server/plugins/engine/models/SummaryViewModel.test.ts +46 -7
  159. package/src/server/plugins/engine/models/SummaryViewModel.ts +7 -3
  160. package/src/server/plugins/engine/outputFormatters/human/v1.test.ts +1 -2
  161. package/src/server/plugins/engine/outputFormatters/human/v1.ts +1 -1
  162. package/src/server/plugins/engine/pageControllers/FileUploadPageController.test.ts +1 -0
  163. package/src/server/plugins/engine/pageControllers/PageController.test.ts +9 -6
  164. package/src/server/plugins/engine/pageControllers/PageController.ts +15 -5
  165. package/src/server/plugins/engine/pageControllers/QuestionPageController.ts +2 -2
  166. package/src/server/plugins/engine/pageControllers/SummaryPageController.ts +21 -6
  167. package/src/server/plugins/engine/pageControllers/validationOptions.ts +31 -17
  168. package/src/server/plugins/engine/plugin.ts +52 -22
  169. package/src/server/plugins/engine/services/formsService.js +17 -35
  170. package/src/server/plugins/engine/services/localFormsService.js +49 -0
  171. package/src/server/plugins/engine/services/notifyService.ts +1 -2
  172. package/src/server/plugins/engine/services/uploadService.js +10 -6
  173. package/src/server/plugins/engine/types.ts +10 -1
  174. package/src/server/plugins/engine/views/components/html.html +1 -1
  175. package/src/server/plugins/engine/views/components/markdown.html +5 -0
  176. package/src/server/plugins/engine/views/confirmation.html +1 -1
  177. package/src/server/plugins/engine/views/file-upload.html +1 -1
  178. package/src/server/plugins/engine/views/index.html +1 -1
  179. package/src/server/plugins/engine/views/item-delete.html +1 -1
  180. package/src/server/plugins/engine/views/repeat-list-summary.html +1 -1
  181. package/src/server/plugins/engine/views/summary.html +8 -2
  182. package/src/server/plugins/errorPages.ts +4 -26
  183. package/src/server/plugins/nunjucks/context.js +44 -34
  184. package/src/server/plugins/nunjucks/context.test.js +24 -27
  185. package/src/server/plugins/nunjucks/enviroment.test.js +9 -3
  186. package/src/server/plugins/nunjucks/types.js +3 -4
  187. package/src/server/routes/index.ts +0 -1
  188. package/src/server/utils/type-utils.ts +15 -0
  189. package/src/typings/hapi/index.d.ts +3 -9
  190. package/src/typings/joi/index.d.ts +8 -0
  191. package/.server/common/cookies.js +0 -55
  192. package/.server/common/cookies.js.map +0 -1
  193. package/.server/common/cookies.test.js +0 -15
  194. package/.server/common/cookies.test.js.map +0 -1
  195. package/.server/common/types.js +0 -6
  196. package/.server/common/types.js.map +0 -1
  197. package/.server/server/forms/README.md +0 -10
  198. package/.server/server/forms/report-a-terrorist.json +0 -270
  199. package/.server/server/forms/runner-components-test.json +0 -365
  200. package/.server/server/forms/test.json +0 -581
  201. package/.server/server/forms/test.yaml +0 -363
  202. package/.server/server/plugins/blankie.js +0 -29
  203. package/.server/server/plugins/blankie.js.map +0 -1
  204. package/.server/server/plugins/engine/services/formsService.test.js +0 -71
  205. package/.server/server/plugins/engine/services/formsService.test.js.map +0 -1
  206. package/.server/server/plugins/engine/views/layout.html +0 -199
  207. package/.server/server/plugins/router.js +0 -169
  208. package/.server/server/plugins/router.js.map +0 -1
  209. package/.server/server/routes/health.js +0 -15
  210. package/.server/server/routes/health.js.map +0 -1
  211. package/.server/server/routes/health.test.js +0 -32
  212. package/.server/server/routes/health.test.js.map +0 -1
  213. package/.server/server/utils/file-form-service.test.js +0 -52
  214. package/.server/server/utils/file-form-service.test.js.map +0 -1
  215. package/.server/server/views/404.html +0 -16
  216. package/.server/server/views/500.html +0 -19
  217. package/.server/server/views/help/accessibility-statement.html +0 -58
  218. package/.server/server/views/help/cookie-preferences.html +0 -57
  219. package/.server/server/views/help/cookies.html +0 -71
  220. package/.server/server/views/help/get-support.html +0 -37
  221. package/.server/server/views/help/privacy-notice.html +0 -68
  222. package/.server/server/views/help/terms-and-conditions.html +0 -83
  223. package/src/common/cookies.js +0 -58
  224. package/src/common/cookies.test.js +0 -23
  225. package/src/common/types.js +0 -5
  226. package/src/server/forms/README.md +0 -10
  227. package/src/server/forms/report-a-terrorist.json +0 -270
  228. package/src/server/forms/runner-components-test.json +0 -365
  229. package/src/server/forms/test.json +0 -581
  230. package/src/server/forms/test.yaml +0 -363
  231. package/src/server/plugins/blankie.test.ts +0 -73
  232. package/src/server/plugins/blankie.ts +0 -48
  233. package/src/server/plugins/engine/services/formsService.test.js +0 -90
  234. package/src/server/plugins/engine/views/layout.html +0 -199
  235. package/src/server/plugins/router.ts +0 -201
  236. package/src/server/routes/health.js +0 -13
  237. package/src/server/routes/health.test.js +0 -35
  238. package/src/server/routes/index.test.ts +0 -125
  239. package/src/server/utils/file-form-service.test.js +0 -79
  240. package/src/server/views/404.html +0 -16
  241. package/src/server/views/500.html +0 -19
  242. package/src/server/views/help/accessibility-statement.html +0 -58
  243. package/src/server/views/help/cookie-preferences.html +0 -57
  244. package/src/server/views/help/cookies.html +0 -71
  245. package/src/server/views/help/get-support.html +0 -37
  246. package/src/server/views/help/privacy-notice.html +0 -68
  247. package/src/server/views/help/terms-and-conditions.html +0 -83
@@ -1,4 +1,4 @@
1
- {% extends "layout.html" %}
1
+ {% extends baseLayoutPath %}
2
2
 
3
3
  {% from "govuk/components/error-summary/macro.njk" import govukErrorSummary %}
4
4
  {% from "govuk/components/button/macro.njk" import govukButton %}
@@ -1,7 +1,8 @@
1
- {% extends "layout.html" %}
1
+ {% extends baseLayoutPath %}
2
2
 
3
3
  {% from "govuk/components/error-summary/macro.njk" import govukErrorSummary %}
4
4
  {% from "govuk/components/summary-list/macro.njk" import govukSummaryList %}
5
+ {% from "partials/components.html" import componentList with context %}
5
6
 
6
7
  {% block content %}
7
8
  <div class="govuk-grid-row">
@@ -34,11 +35,16 @@
34
35
 
35
36
  {% if declaration %}
36
37
  <h2 class="govuk-heading-m" id="declaration">Declaration</h2>
38
+ <div class="govuk-body">
37
39
  {{ declaration | safe }}
40
+ </div>
38
41
  {% endif %}
39
42
 
43
+ {{ componentList(components) }}
44
+
45
+ {% set isDeclaration = declaration or components | length %}
40
46
  <button data-prevent-double-click="true" class="govuk-button" data-module="govuk-button">
41
- {{ "Accept and send" if declaration else "Send" }}
47
+ {{ "Accept and send" if isDeclaration else "Send" }}
42
48
  </button>
43
49
  </form>
44
50
  </div>
@@ -3,7 +3,6 @@ import {
3
3
  type ResponseToolkit,
4
4
  type ServerRegisterPluginObject
5
5
  } from '@hapi/hapi'
6
- import { StatusCodes } from 'http-status-codes'
7
6
 
8
7
  /*
9
8
  * Add an `onPreResponse` listener to return error pages
@@ -20,36 +19,15 @@ export default {
20
19
  // processing the request
21
20
  const statusCode = response.output.statusCode
22
21
 
23
- // Check for a form model on the request
24
- // and use it to set the correct service name
25
- // and start page path. In the event of a error
26
- // happening inside a "form" level request, the header
27
- // then displays the contextual form text and href
28
- const model = request.app.model
29
- const viewModel = model
30
- ? {
31
- name: model.name,
32
- serviceUrl: `/${model.basePath}`
33
- }
34
- : undefined
35
-
36
- // In the event of 404
37
- // return the `404` view
38
- if (statusCode === StatusCodes.NOT_FOUND.valueOf()) {
39
- return h.view('404', viewModel).code(statusCode)
40
- }
41
-
42
- request.log('error', {
22
+ const error = {
43
23
  statusCode,
44
- data: response.data,
45
24
  message: response.message,
46
25
  stack: response.stack
47
- })
26
+ }
48
27
 
49
- request.logger.error(response.stack)
28
+ request.log('error', error)
50
29
 
51
- // The return the `500` view
52
- return h.view('500', viewModel).code(statusCode)
30
+ return h.response(error).code(statusCode)
53
31
  }
54
32
  return h.continue
55
33
  })
@@ -5,11 +5,10 @@ import Boom from '@hapi/boom'
5
5
  import { StatusCodes } from 'http-status-codes'
6
6
 
7
7
  import pkg from '~/package.json' with { type: 'json' }
8
- import { parseCookieConsent } from '~/src/common/cookies.js'
9
8
  import { config } from '~/src/config/index.js'
10
9
  import { createLogger } from '~/src/server/common/helpers/logging/logger.js'
11
- import { PREVIEW_PATH_PREFIX } from '~/src/server/constants.js'
12
10
  import {
11
+ checkFormStatus,
13
12
  encodeUrl,
14
13
  safeGenerateCrumb
15
14
  } from '~/src/server/plugins/engine/helpers.js'
@@ -23,66 +22,77 @@ let webpackManifest
23
22
  * @param {FormRequest | FormRequestPayload | null} request
24
23
  */
25
24
  export function context(request) {
26
- const manifestPath = join(config.get('publicDir'), 'assets-manifest.json')
27
-
28
- if (!webpackManifest) {
29
- try {
30
- // eslint-disable-next-line -- Allow JSON type 'any'
31
- webpackManifest = JSON.parse(readFileSync(manifestPath, 'utf-8'))
32
- } catch {
33
- logger.error(`Webpack ${basename(manifestPath)} not found`)
34
- }
35
- }
25
+ const { params, response } = request ?? {}
36
26
 
37
- const { params, path, query = {}, response, state } = request ?? {}
38
-
39
- const isForceAccess = 'force' in query
40
- const isPreviewMode = path?.startsWith(PREVIEW_PATH_PREFIX)
27
+ const { isPreview: isPreviewMode, state: formState } = checkFormStatus(params)
41
28
 
42
29
  // Only add the slug in to the context if the response is OK.
43
30
  // Footer meta links are not rendered when the slug is missing.
44
31
  const isResponseOK =
45
32
  !Boom.isBoom(response) && response?.statusCode === StatusCodes.OK
46
33
 
34
+ const pluginStorage = request?.server.plugins['forms-engine-plugin']
35
+ let consumerViewContext = {}
36
+
37
+ if (!pluginStorage) {
38
+ throw Error('context called before plugin registered')
39
+ }
40
+
41
+ if (!pluginStorage.baseLayoutPath) {
42
+ throw Error('Missing baseLayoutPath in plugin.options.nunjucks')
43
+ }
44
+
45
+ if ('viewContext' in pluginStorage) {
46
+ consumerViewContext = pluginStorage.viewContext(request)
47
+ }
48
+
47
49
  /** @type {ViewContext} */
48
50
  const ctx = {
51
+ // take consumers props first so we can override it
52
+ ...consumerViewContext,
53
+ baseLayoutPath: pluginStorage.baseLayoutPath,
49
54
  appVersion: pkg.version,
50
- assetPath: '/assets',
51
55
  config: {
52
56
  cdpEnvironment: config.get('cdpEnvironment'),
53
57
  designerUrl: config.get('designerUrl'),
54
58
  feedbackLink: encodeUrl(config.get('feedbackLink')),
55
59
  phaseTag: config.get('phaseTag'),
56
- serviceBannerText: config.get('serviceBannerText'),
57
60
  serviceName: config.get('serviceName'),
58
61
  serviceVersion: config.get('serviceVersion')
59
62
  },
60
63
  crumb: safeGenerateCrumb(request),
61
- cspNonce: request?.plugins.blankie?.nonces?.script,
62
- currentPath: request ? `${request.path}${request.url.search}` : undefined,
63
- previewMode: isPreviewMode ? params?.state : undefined,
64
- slug: isResponseOK ? params?.slug : undefined,
65
-
66
- getAssetPath: (asset = '') => {
67
- return `/${webpackManifest?.[asset] ?? asset}`
68
- }
64
+ currentPath: `${request.path}${request.url.search}`,
65
+ previewMode: isPreviewMode ? formState : undefined,
66
+ slug: isResponseOK ? params?.slug : undefined
69
67
  }
70
68
 
71
- if (!isForceAccess) {
72
- ctx.config.googleAnalyticsTrackingId = config.get(
73
- 'googleAnalyticsTrackingId'
74
- )
69
+ return ctx
70
+ }
71
+
72
+ /**
73
+ * Returns the context for the devtool. Consumers won't have access to this.
74
+ */
75
+ export function devtoolContext() {
76
+ const manifestPath = join(config.get('publicDir'), 'assets-manifest.json')
75
77
 
76
- if (typeof state?.cookieConsent === 'string') {
77
- ctx.cookieConsent = parseCookieConsent(state.cookieConsent)
78
+ if (!webpackManifest) {
79
+ try {
80
+ // eslint-disable-next-line -- Allow JSON type 'any'
81
+ webpackManifest = JSON.parse(readFileSync(manifestPath, 'utf-8'))
82
+ } catch {
83
+ logger.error(`Webpack ${basename(manifestPath)} not found`)
78
84
  }
79
85
  }
80
86
 
81
- return ctx
87
+ return {
88
+ assetPath: '/assets',
89
+ getDxtAssetPath: (asset = '') => {
90
+ return `/${webpackManifest?.[asset] ?? asset}`
91
+ }
92
+ }
82
93
  }
83
94
 
84
95
  /**
85
- * @import { CookieConsent } from '~/src/common/types.js'
86
96
  * @import { ViewContext } from '~/src/server/plugins/nunjucks/types.js'
87
97
  * @import { FormRequest, FormRequestPayload } from '~/src/server/routes/types.js'
88
98
  */
@@ -1,28 +1,29 @@
1
1
  import { tmpdir } from 'node:os'
2
2
 
3
- import { config } from '~/src/config/index.js'
4
- import { encodeUrl } from '~/src/server/plugins/engine/helpers.js'
5
- import { context } from '~/src/server/plugins/nunjucks/context.js'
3
+ import {
4
+ context,
5
+ devtoolContext
6
+ } from '~/src/server/plugins/nunjucks/context.js'
6
7
 
7
8
  describe('Nunjucks context', () => {
8
9
  beforeEach(() => jest.resetModules())
9
10
 
10
11
  describe('Asset path', () => {
11
12
  it("should include 'assetPath' for GOV.UK Frontend icons", () => {
12
- const { assetPath } = context(null)
13
+ const { assetPath } = devtoolContext()
13
14
  expect(assetPath).toBe('/assets')
14
15
  })
15
16
  })
16
17
 
17
18
  describe('Asset helper', () => {
18
19
  it("should locate 'assets-manifest.json' assets", () => {
19
- const { getAssetPath } = context(null)
20
+ const { getDxtAssetPath } = devtoolContext()
20
21
 
21
- expect(getAssetPath('example.scss')).toBe(
22
+ expect(getDxtAssetPath('example.scss')).toBe(
22
23
  '/stylesheets/example.xxxxxxx.min.css'
23
24
  )
24
25
 
25
- expect(getAssetPath('example.mjs')).toBe(
26
+ expect(getDxtAssetPath('example.mjs')).toBe(
26
27
  '/javascripts/example.xxxxxxx.min.js'
27
28
  )
28
29
  })
@@ -32,43 +33,33 @@ describe('Nunjucks context', () => {
32
33
  const { config } = await import('~/src/config/index.js')
33
34
 
34
35
  // Import when isolated to avoid cache
35
- const { context } = await import(
36
+ const { devtoolContext } = await import(
36
37
  '~/src/server/plugins/nunjucks/context.js'
37
38
  )
38
39
 
39
40
  // Update config for missing manifest
40
41
  config.set('publicDir', tmpdir())
41
- const { getAssetPath } = context(null)
42
+ const { getDxtAssetPath } = devtoolContext()
42
43
 
43
44
  // Uses original paths when missing
44
- expect(getAssetPath('example.scss')).toBe('/example.scss')
45
- expect(getAssetPath('example.mjs')).toBe('/example.mjs')
45
+ expect(getDxtAssetPath('example.scss')).toBe('/example.scss')
46
+ expect(getDxtAssetPath('example.mjs')).toBe('/example.mjs')
46
47
  })
47
48
  })
48
49
 
49
50
  it('should return path to unknown assets', () => {
50
- const { getAssetPath } = context(null)
51
+ const { getDxtAssetPath } = devtoolContext()
51
52
 
52
- expect(getAssetPath()).toBe('/')
53
- expect(getAssetPath('example.jpg')).toBe('/example.jpg')
54
- expect(getAssetPath('example.gif')).toBe('/example.gif')
53
+ expect(getDxtAssetPath()).toBe('/')
54
+ expect(getDxtAssetPath('example.jpg')).toBe('/example.jpg')
55
+ expect(getDxtAssetPath('example.gif')).toBe('/example.gif')
55
56
  })
56
57
  })
57
58
 
58
59
  describe('Config', () => {
59
60
  it('should include environment, phase tag and service info', () => {
60
- const ctx = context(null)
61
-
62
- expect(ctx.config).toEqual(
63
- expect.objectContaining({
64
- cdpEnvironment: config.get('cdpEnvironment'),
65
- feedbackLink: encodeUrl(config.get('feedbackLink')),
66
- googleAnalyticsTrackingId: config.get('googleAnalyticsTrackingId'),
67
- phaseTag: config.get('phaseTag'),
68
- serviceBannerText: config.get('serviceBannerText'),
69
- serviceName: config.get('serviceName'),
70
- serviceVersion: config.get('serviceVersion')
71
- })
61
+ expect(() => context(null)).toThrow(
62
+ 'context called before plugin registered'
72
63
  )
73
64
  })
74
65
  })
@@ -83,6 +74,9 @@ describe('Nunjucks context', () => {
83
74
  plugins: {
84
75
  crumb: {
85
76
  generate: jest.fn()
77
+ },
78
+ 'forms-engine-plugin': {
79
+ baseLayoutPath: 'randomValue'
86
80
  }
87
81
  }
88
82
  },
@@ -113,6 +107,9 @@ describe('Nunjucks context', () => {
113
107
  plugins: {
114
108
  crumb: {
115
109
  generate: jest.fn().mockReturnValue(mockCrumb)
110
+ },
111
+ 'forms-engine-plugin': {
112
+ baseLayoutPath: 'randomValue'
116
113
  }
117
114
  }
118
115
  },
@@ -88,7 +88,9 @@ describe('Nunjucks environment', () => {
88
88
  }
89
89
  }
90
90
 
91
- const result = checkComponentTemplates.call(nunjucksCtx, component)
91
+ const result = /** @type {{ model: { content: string } }} */ (
92
+ checkComponentTemplates.call(nunjucksCtx, component)
93
+ )
92
94
 
93
95
  expect(helpers.evaluateTemplate).toHaveBeenCalledWith(
94
96
  'Some {{ context.someData }} content',
@@ -114,7 +116,9 @@ describe('Nunjucks environment', () => {
114
116
  }
115
117
  }
116
118
 
117
- const result = checkComponentTemplates.call(nunjucksCtx, component)
119
+ const result = /** @type {{ model: { content: string } }} */ (
120
+ checkComponentTemplates.call(nunjucksCtx, component)
121
+ )
118
122
 
119
123
  expect(helpers.evaluateTemplate).not.toHaveBeenCalled()
120
124
 
@@ -136,7 +140,9 @@ describe('Nunjucks environment', () => {
136
140
  }
137
141
  }
138
142
 
139
- const result = checkComponentTemplates.call(nunjucksCtx, component)
143
+ const result = /** @type {{ model: { label?: { text: string } } }} */ (
144
+ checkComponentTemplates.call(nunjucksCtx, component)
145
+ )
140
146
 
141
147
  expect(helpers.evaluateTemplate).toHaveBeenCalledWith(
142
148
  'Label with {{ context.someData }}',
@@ -12,16 +12,15 @@
12
12
  /**
13
13
  * @typedef {object} ViewContext - Nunjucks view context
14
14
  * @property {string} appVersion - Application version
15
- * @property {string} assetPath - Asset path
15
+ * @property {string} [baseLayoutPath] - Base layout path
16
16
  * @property {Partial<Config>} config - Application config properties
17
- * @property {CookieConsent} [cookieConsent] - Cookie consent preferences
18
17
  * @property {string} [crumb] - Cross-Site Request Forgery (CSRF) token
19
18
  * @property {string} [cspNonce] - Content Security Policy (CSP) nonce
20
19
  * @property {string} [currentPath] - Current path
21
20
  * @property {string} [previewMode] - Preview mode
22
21
  * @property {string} [slug] - Form slug
23
- * @property {(asset?: string) => string} getAssetPath - Asset path resolver
24
22
  * @property {FormContext} [context] - the current form context
23
+ * @property {PluginOptions['viewContext']} [injectedViewContext] - the current form context
25
24
  */
26
25
 
27
26
  /**
@@ -34,7 +33,7 @@
34
33
  */
35
34
 
36
35
  /**
37
- * @import { CookieConsent } from '~/src/common/types.js'
38
36
  * @import { config } from '~/src/config/index.js'
39
37
  * @import { FormContext } from '~/src/server/plugins/engine/types.js'
38
+ * @import { PluginOptions } from '~/src/server/plugins/engine/plugin.js'
40
39
  */
@@ -1,2 +1 @@
1
1
  export { default as publicRoutes } from '~/src/server/routes/public.js'
2
- export { default as healthRoute } from '~/src/server/routes/health.js'
@@ -0,0 +1,15 @@
1
+ import Joi, {
2
+ type JoiExpression,
3
+ type LanguageMessages,
4
+ type LanguageMessagesExt
5
+ } from 'joi'
6
+
7
+ export function convertToLanguageMessages(
8
+ extLanguageMessages: LanguageMessagesExt
9
+ ): LanguageMessages {
10
+ return extLanguageMessages as unknown as LanguageMessages
11
+ }
12
+
13
+ export function createJoiExpression(expr: string): JoiExpression {
14
+ return Joi.expression(expr) as unknown as JoiExpression
15
+ }
@@ -5,6 +5,7 @@ import { type ServerYar, type Yar } from '@hapi/yar'
5
5
  import { type Logger } from 'pino'
6
6
 
7
7
  import { type FormModel } from '~/src/server/plugins/engine/models/index.js'
8
+ import { type context } from '~/src/server/plugins/engine/nunjucks.js'
8
9
  import {
9
10
  type FormRequest,
10
11
  type FormRequestPayload
@@ -19,16 +20,9 @@ declare module '@hapi/hapi' {
19
20
  generate?: (request: Request | FormRequest | FormRequestPayload) => string
20
21
  }
21
22
  'forms-engine-plugin': {
23
+ baseLayoutPath: string
22
24
  cacheService: CacheService
23
- }
24
- }
25
-
26
- interface PluginsStates {
27
- blankie?: {
28
- nonces?: {
29
- script?: string
30
- style?: string
31
- }
25
+ viewContext: context
32
26
  }
33
27
  }
34
28
 
@@ -19,4 +19,12 @@ declare module 'joi' {
19
19
  title?: string
20
20
  }
21
21
  }
22
+
23
+ interface JoiExpressionReturn {
24
+ render: (p1, p2, p3, p4, p5) => string
25
+ }
26
+
27
+ type JoiExpression = JoiExpressionReturn | string
28
+
29
+ type LanguageMessagesExt = Record<string, JoiExpression>
22
30
  }
@@ -1,55 +0,0 @@
1
- /**
2
- @type {CookieConsent}
3
- */
4
- export const defaultConsent = {
5
- analytics: null,
6
- dismissed: false
7
- };
8
-
9
- /**
10
- * Parses the cookie consent policy
11
- * @param {string} value
12
- */
13
- export function parseCookieConsent(value) {
14
- /** @type {CookieConsent} */
15
- let cookieConsent;
16
- try {
17
- const encodedValue = decodeURIComponent(value);
18
-
19
- // eslint-disable-next-line -- Allow JSON type 'any'
20
- const decodedValue = JSON.parse(encodedValue);
21
- if (isValidConsent(decodedValue)) {
22
- cookieConsent = decodedValue;
23
- } else {
24
- cookieConsent = defaultConsent;
25
- }
26
- } catch {
27
- cookieConsent = defaultConsent;
28
- }
29
- return cookieConsent;
30
- }
31
-
32
- /**
33
- * Serialises the cookie consent policy
34
- * @param {CookieConsent} consent
35
- * @returns {string} cookie value
36
- */
37
- export function serialiseCookieConsent(consent) {
38
- return encodeURIComponent(JSON.stringify(consent));
39
- }
40
-
41
- /**
42
- * @param {unknown} consent
43
- * @returns {consent is CookieConsent}
44
- */
45
- function isValidConsent(consent) {
46
- if (consent === null || Array.isArray(consent)) {
47
- return false;
48
- }
49
- return typeof consent === 'object' && 'analytics' in consent;
50
- }
51
-
52
- /**
53
- * @import {CookieConsent} from '~/src/common/types.js'
54
- */
55
- //# sourceMappingURL=cookies.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"cookies.js","names":["defaultConsent","analytics","dismissed","parseCookieConsent","value","cookieConsent","encodedValue","decodeURIComponent","decodedValue","JSON","parse","isValidConsent","serialiseCookieConsent","consent","encodeURIComponent","stringify","Array","isArray"],"sources":["../../src/common/cookies.js"],"sourcesContent":["/**\n @type {CookieConsent}\n */\nexport const defaultConsent = {\n analytics: null,\n dismissed: false\n}\n\n/**\n * Parses the cookie consent policy\n * @param {string} value\n */\nexport function parseCookieConsent(value) {\n /** @type {CookieConsent} */\n let cookieConsent\n\n try {\n const encodedValue = decodeURIComponent(value)\n\n // eslint-disable-next-line -- Allow JSON type 'any'\n const decodedValue = JSON.parse(encodedValue)\n\n if (isValidConsent(decodedValue)) {\n cookieConsent = decodedValue\n } else {\n cookieConsent = defaultConsent\n }\n } catch {\n cookieConsent = defaultConsent\n }\n\n return cookieConsent\n}\n\n/**\n * Serialises the cookie consent policy\n * @param {CookieConsent} consent\n * @returns {string} cookie value\n */\nexport function serialiseCookieConsent(consent) {\n return encodeURIComponent(JSON.stringify(consent))\n}\n\n/**\n * @param {unknown} consent\n * @returns {consent is CookieConsent}\n */\nfunction isValidConsent(consent) {\n if (consent === null || Array.isArray(consent)) {\n return false\n }\n\n return typeof consent === 'object' && 'analytics' in consent\n}\n\n/**\n * @import {CookieConsent} from '~/src/common/types.js'\n */\n"],"mappings":"AAAA;AACA;AACA;AACA,OAAO,MAAMA,cAAc,GAAG;EAC5BC,SAAS,EAAE,IAAI;EACfC,SAAS,EAAE;AACb,CAAC;;AAED;AACA;AACA;AACA;AACA,OAAO,SAASC,kBAAkBA,CAACC,KAAK,EAAE;EACxC;EACA,IAAIC,aAAa;EAEjB,IAAI;IACF,MAAMC,YAAY,GAAGC,kBAAkB,CAACH,KAAK,CAAC;;IAE9C;IACA,MAAMI,YAAY,GAAGC,IAAI,CAACC,KAAK,CAACJ,YAAY,CAAC;IAE7C,IAAIK,cAAc,CAACH,YAAY,CAAC,EAAE;MAChCH,aAAa,GAAGG,YAAY;IAC9B,CAAC,MAAM;MACLH,aAAa,GAAGL,cAAc;IAChC;EACF,CAAC,CAAC,MAAM;IACNK,aAAa,GAAGL,cAAc;EAChC;EAEA,OAAOK,aAAa;AACtB;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASO,sBAAsBA,CAACC,OAAO,EAAE;EAC9C,OAAOC,kBAAkB,CAACL,IAAI,CAACM,SAAS,CAACF,OAAO,CAAC,CAAC;AACpD;;AAEA;AACA;AACA;AACA;AACA,SAASF,cAAcA,CAACE,OAAO,EAAE;EAC/B,IAAIA,OAAO,KAAK,IAAI,IAAIG,KAAK,CAACC,OAAO,CAACJ,OAAO,CAAC,EAAE;IAC9C,OAAO,KAAK;EACd;EAEA,OAAO,OAAOA,OAAO,KAAK,QAAQ,IAAI,WAAW,IAAIA,OAAO;AAC9D;;AAEA;AACA;AACA","ignoreList":[]}
@@ -1,15 +0,0 @@
1
- import { parseCookieConsent } from "./cookies.js";
2
- describe('cookies', () => {
3
- it('parses a valid policy', () => {
4
- expect(parseCookieConsent('{"analytics":true}')).toEqual({
5
- analytics: true
6
- });
7
- });
8
- it.each(["['not', 'an', 'object']", '{{ not: "an object" }}', '{ additional: AAA }', '{ marketing: 100 }', '', 'null'])('converts a malformed policy to the default', value => {
9
- expect(parseCookieConsent(value)).toEqual({
10
- analytics: null,
11
- dismissed: false
12
- });
13
- });
14
- });
15
- //# sourceMappingURL=cookies.test.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"cookies.test.js","names":["parseCookieConsent","describe","it","expect","toEqual","analytics","each","value","dismissed"],"sources":["../../src/common/cookies.test.js"],"sourcesContent":["import { parseCookieConsent } from '~/src/common/cookies.js'\n\ndescribe('cookies', () => {\n it('parses a valid policy', () => {\n expect(parseCookieConsent('{\"analytics\":true}')).toEqual({\n analytics: true\n })\n })\n\n it.each([\n \"['not', 'an', 'object']\",\n '{{ not: \"an object\" }}',\n '{ additional: AAA }',\n '{ marketing: 100 }',\n '',\n 'null'\n ])('converts a malformed policy to the default', (value) => {\n expect(parseCookieConsent(value)).toEqual({\n analytics: null,\n dismissed: false\n })\n })\n})\n"],"mappings":"AAAA,SAASA,kBAAkB;AAE3BC,QAAQ,CAAC,SAAS,EAAE,MAAM;EACxBC,EAAE,CAAC,uBAAuB,EAAE,MAAM;IAChCC,MAAM,CAACH,kBAAkB,CAAC,oBAAoB,CAAC,CAAC,CAACI,OAAO,CAAC;MACvDC,SAAS,EAAE;IACb,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFH,EAAE,CAACI,IAAI,CAAC,CACN,yBAAyB,EACzB,wBAAwB,EACxB,qBAAqB,EACrB,oBAAoB,EACpB,EAAE,EACF,MAAM,CACP,CAAC,CAAC,4CAA4C,EAAGC,KAAK,IAAK;IAC1DJ,MAAM,CAACH,kBAAkB,CAACO,KAAK,CAAC,CAAC,CAACH,OAAO,CAAC;MACxCC,SAAS,EAAE,IAAI;MACfG,SAAS,EAAE;IACb,CAAC,CAAC;EACJ,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}
@@ -1,6 +0,0 @@
1
- /**
2
- * @typedef CookieConsent
3
- * @property {boolean | null} analytics - whether analytics cookies are allowed
4
- * @property {boolean} dismissed - whether cookie banner has been dismissed
5
- */
6
- //# sourceMappingURL=types.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"types.js","names":[],"sources":["../../src/common/types.js"],"sourcesContent":["/**\n * @typedef CookieConsent\n * @property {boolean | null} analytics - whether analytics cookies are allowed\n * @property {boolean} dismissed - whether cookie banner has been dismissed\n */\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA","ignoreList":[]}
@@ -1,10 +0,0 @@
1
- # Pre-configured Forms
2
-
3
- This folder holds pre-configured form definitions that can be loaded by the runner:
4
-
5
- ```js
6
- const server = await createServer({
7
- formFileName: 'example.js',
8
- formFilePath: join(cwd(), 'server/forms'),
9
- })
10
- ```