@defra/forms-model 3.0.2

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 (336) hide show
  1. package/LICENCE +8 -0
  2. package/README.md +22 -0
  3. package/dist/browser/components/component-types.d.ts +3 -0
  4. package/dist/browser/components/component-types.d.ts.map +1 -0
  5. package/dist/browser/components/component-types.js +220 -0
  6. package/dist/browser/components/component-types.js.map +1 -0
  7. package/dist/browser/components/conditional-component-types.d.ts +3 -0
  8. package/dist/browser/components/conditional-component-types.d.ts.map +1 -0
  9. package/dist/browser/components/conditional-component-types.js +28 -0
  10. package/dist/browser/components/conditional-component-types.js.map +1 -0
  11. package/dist/browser/components/index.d.ts +4 -0
  12. package/dist/browser/components/index.d.ts.map +1 -0
  13. package/dist/browser/components/index.js +45 -0
  14. package/dist/browser/components/index.js.map +1 -0
  15. package/dist/browser/components/types.d.ts +244 -0
  16. package/dist/browser/components/types.d.ts.map +1 -0
  17. package/dist/browser/components/types.js +56 -0
  18. package/dist/browser/components/types.js.map +1 -0
  19. package/dist/browser/conditions/condition-abstract.d.ts +16 -0
  20. package/dist/browser/conditions/condition-abstract.d.ts.map +1 -0
  21. package/dist/browser/conditions/condition-abstract.js +62 -0
  22. package/dist/browser/conditions/condition-abstract.js.map +1 -0
  23. package/dist/browser/conditions/condition-field.d.ts +13 -0
  24. package/dist/browser/conditions/condition-field.d.ts.map +1 -0
  25. package/dist/browser/conditions/condition-field.js +45 -0
  26. package/dist/browser/conditions/condition-field.js.map +1 -0
  27. package/dist/browser/conditions/condition-group-def.d.ts +10 -0
  28. package/dist/browser/conditions/condition-group-def.d.ts.map +1 -0
  29. package/dist/browser/conditions/condition-group-def.js +45 -0
  30. package/dist/browser/conditions/condition-group-def.js.map +1 -0
  31. package/dist/browser/conditions/condition-group.d.ts +15 -0
  32. package/dist/browser/conditions/condition-group.d.ts.map +1 -0
  33. package/dist/browser/conditions/condition-group.js +64 -0
  34. package/dist/browser/conditions/condition-group.js.map +1 -0
  35. package/dist/browser/conditions/condition-model.d.ts +41 -0
  36. package/dist/browser/conditions/condition-model.d.ts.map +1 -0
  37. package/dist/browser/conditions/condition-model.js +214 -0
  38. package/dist/browser/conditions/condition-model.js.map +1 -0
  39. package/dist/browser/conditions/condition-operators.d.ts +248 -0
  40. package/dist/browser/conditions/condition-operators.d.ts.map +1 -0
  41. package/dist/browser/conditions/condition-operators.js +132 -0
  42. package/dist/browser/conditions/condition-operators.js.map +1 -0
  43. package/dist/browser/conditions/condition-ref.d.ts +12 -0
  44. package/dist/browser/conditions/condition-ref.d.ts.map +1 -0
  45. package/dist/browser/conditions/condition-ref.js +51 -0
  46. package/dist/browser/conditions/condition-ref.js.map +1 -0
  47. package/dist/browser/conditions/condition-value-abstract.d.ts +8 -0
  48. package/dist/browser/conditions/condition-value-abstract.d.ts.map +1 -0
  49. package/dist/browser/conditions/condition-value-abstract.js +41 -0
  50. package/dist/browser/conditions/condition-value-abstract.js.map +1 -0
  51. package/dist/browser/conditions/condition-value-registration.d.ts +10 -0
  52. package/dist/browser/conditions/condition-value-registration.d.ts.map +1 -0
  53. package/dist/browser/conditions/condition-value-registration.js +37 -0
  54. package/dist/browser/conditions/condition-value-registration.js.map +1 -0
  55. package/dist/browser/conditions/condition-values.d.ts +38 -0
  56. package/dist/browser/conditions/condition-values.d.ts.map +1 -0
  57. package/dist/browser/conditions/condition-values.js +127 -0
  58. package/dist/browser/conditions/condition-values.js.map +1 -0
  59. package/dist/browser/conditions/condition.d.ts +15 -0
  60. package/dist/browser/conditions/condition.d.ts.map +1 -0
  61. package/dist/browser/conditions/condition.js +56 -0
  62. package/dist/browser/conditions/condition.js.map +1 -0
  63. package/dist/browser/conditions/helpers.d.ts +3 -0
  64. package/dist/browser/conditions/helpers.d.ts.map +1 -0
  65. package/dist/browser/conditions/helpers.js +26 -0
  66. package/dist/browser/conditions/helpers.js.map +1 -0
  67. package/dist/browser/conditions/index.d.ts +11 -0
  68. package/dist/browser/conditions/index.d.ts.map +1 -0
  69. package/dist/browser/conditions/index.js +144 -0
  70. package/dist/browser/conditions/index.js.map +1 -0
  71. package/dist/browser/conditions/inline-condition-model.d.ts +86 -0
  72. package/dist/browser/conditions/inline-condition-model.d.ts.map +1 -0
  73. package/dist/browser/conditions/inline-condition-model.js +418 -0
  74. package/dist/browser/conditions/inline-condition-model.js.map +1 -0
  75. package/dist/browser/conditions/inline-condition-operators.d.ts +175 -0
  76. package/dist/browser/conditions/inline-condition-operators.d.ts.map +1 -0
  77. package/dist/browser/conditions/inline-condition-operators.js +132 -0
  78. package/dist/browser/conditions/inline-condition-operators.js.map +1 -0
  79. package/dist/browser/conditions/inline-condition-values.d.ts +93 -0
  80. package/dist/browser/conditions/inline-condition-values.d.ts.map +1 -0
  81. package/dist/browser/conditions/inline-condition-values.js +159 -0
  82. package/dist/browser/conditions/inline-condition-values.js.map +1 -0
  83. package/dist/browser/conditions/types.d.ts +38 -0
  84. package/dist/browser/conditions/types.d.ts.map +1 -0
  85. package/dist/browser/conditions/types.js +24 -0
  86. package/dist/browser/conditions/types.js.map +1 -0
  87. package/dist/browser/data-model/conditions-wrapper.d.ts +19 -0
  88. package/dist/browser/data-model/conditions-wrapper.d.ts.map +1 -0
  89. package/dist/browser/data-model/conditions-wrapper.js +49 -0
  90. package/dist/browser/data-model/conditions-wrapper.js.map +1 -0
  91. package/dist/browser/data-model/index.d.ts +4 -0
  92. package/dist/browser/data-model/index.d.ts.map +1 -0
  93. package/dist/browser/data-model/index.js +66 -0
  94. package/dist/browser/data-model/index.js.map +1 -0
  95. package/dist/browser/data-model/input-wrapper.d.ts +16 -0
  96. package/dist/browser/data-model/input-wrapper.d.ts.map +1 -0
  97. package/dist/browser/data-model/input-wrapper.js +49 -0
  98. package/dist/browser/data-model/input-wrapper.js.map +1 -0
  99. package/dist/browser/data-model/types.d.ts +153 -0
  100. package/dist/browser/data-model/types.d.ts.map +1 -0
  101. package/dist/browser/data-model/types.js +34 -0
  102. package/dist/browser/data-model/types.js.map +1 -0
  103. package/dist/browser/form/form-configuration.d.ts +8 -0
  104. package/dist/browser/form/form-configuration.d.ts.map +1 -0
  105. package/dist/browser/form/form-configuration.js +38 -0
  106. package/dist/browser/form/form-configuration.js.map +1 -0
  107. package/dist/browser/form/index.d.ts +2 -0
  108. package/dist/browser/form/index.d.ts.map +1 -0
  109. package/dist/browser/form/index.js +24 -0
  110. package/dist/browser/form/index.js.map +1 -0
  111. package/dist/browser/index.d.ts +12 -0
  112. package/dist/browser/index.d.ts.map +1 -0
  113. package/dist/browser/index.js +138 -0
  114. package/dist/browser/index.js.map +1 -0
  115. package/dist/browser/migration/index.d.ts +2 -0
  116. package/dist/browser/migration/index.d.ts.map +1 -0
  117. package/dist/browser/migration/index.js +24 -0
  118. package/dist/browser/migration/index.js.map +1 -0
  119. package/dist/browser/migration/migration.0-2.d.ts +3 -0
  120. package/dist/browser/migration/migration.0-2.d.ts.map +1 -0
  121. package/dist/browser/migration/migration.0-2.js +65 -0
  122. package/dist/browser/migration/migration.0-2.js.map +1 -0
  123. package/dist/browser/migration/migration.1-2.d.ts +3 -0
  124. package/dist/browser/migration/migration.1-2.d.ts.map +1 -0
  125. package/dist/browser/migration/migration.1-2.js +108 -0
  126. package/dist/browser/migration/migration.1-2.js.map +1 -0
  127. package/dist/browser/migration/types.d.ts +2 -0
  128. package/dist/browser/migration/types.d.ts.map +1 -0
  129. package/dist/browser/migration/types.js +16 -0
  130. package/dist/browser/migration/types.js.map +1 -0
  131. package/dist/browser/migration/whichMigrations.d.ts +7 -0
  132. package/dist/browser/migration/whichMigrations.d.ts.map +1 -0
  133. package/dist/browser/migration/whichMigrations.js +38 -0
  134. package/dist/browser/migration/whichMigrations.js.map +1 -0
  135. package/dist/browser/schema/index.d.ts +2 -0
  136. package/dist/browser/schema/index.d.ts.map +1 -0
  137. package/dist/browser/schema/index.js +30 -0
  138. package/dist/browser/schema/index.js.map +1 -0
  139. package/dist/browser/schema/schema.d.ts +20 -0
  140. package/dist/browser/schema/schema.d.ts.map +1 -0
  141. package/dist/browser/schema/schema.js +255 -0
  142. package/dist/browser/schema/schema.js.map +1 -0
  143. package/dist/browser/utils/helpers.d.ts +9 -0
  144. package/dist/browser/utils/helpers.d.ts.map +1 -0
  145. package/dist/browser/utils/helpers.js +48 -0
  146. package/dist/browser/utils/helpers.js.map +1 -0
  147. package/dist/browser/utils/logger.d.ts +11 -0
  148. package/dist/browser/utils/logger.d.ts.map +1 -0
  149. package/dist/browser/utils/logger.js +46 -0
  150. package/dist/browser/utils/logger.js.map +1 -0
  151. package/dist/module/components/component-types.d.ts +3 -0
  152. package/dist/module/components/component-types.d.ts.map +1 -0
  153. package/dist/module/components/component-types.js +206 -0
  154. package/dist/module/components/component-types.js.map +1 -0
  155. package/dist/module/components/conditional-component-types.d.ts +3 -0
  156. package/dist/module/components/conditional-component-types.d.ts.map +1 -0
  157. package/dist/module/components/conditional-component-types.js +14 -0
  158. package/dist/module/components/conditional-component-types.js.map +1 -0
  159. package/dist/module/components/index.d.ts +4 -0
  160. package/dist/module/components/index.d.ts.map +1 -0
  161. package/dist/module/components/index.js +34 -0
  162. package/dist/module/components/index.js.map +1 -0
  163. package/dist/module/components/types.d.ts +244 -0
  164. package/dist/module/components/types.d.ts.map +1 -0
  165. package/dist/module/components/types.js +42 -0
  166. package/dist/module/components/types.js.map +1 -0
  167. package/dist/module/conditions/condition-abstract.d.ts +16 -0
  168. package/dist/module/conditions/condition-abstract.d.ts.map +1 -0
  169. package/dist/module/conditions/condition-abstract.js +45 -0
  170. package/dist/module/conditions/condition-abstract.js.map +1 -0
  171. package/dist/module/conditions/condition-field.d.ts +13 -0
  172. package/dist/module/conditions/condition-field.d.ts.map +1 -0
  173. package/dist/module/conditions/condition-field.js +26 -0
  174. package/dist/module/conditions/condition-field.js.map +1 -0
  175. package/dist/module/conditions/condition-group-def.d.ts +10 -0
  176. package/dist/module/conditions/condition-group-def.d.ts.map +1 -0
  177. package/dist/module/conditions/condition-group-def.js +26 -0
  178. package/dist/module/conditions/condition-group-def.js.map +1 -0
  179. package/dist/module/conditions/condition-group.d.ts +15 -0
  180. package/dist/module/conditions/condition-group.d.ts.map +1 -0
  181. package/dist/module/conditions/condition-group.js +47 -0
  182. package/dist/module/conditions/condition-group.js.map +1 -0
  183. package/dist/module/conditions/condition-model.d.ts +41 -0
  184. package/dist/module/conditions/condition-model.d.ts.map +1 -0
  185. package/dist/module/conditions/condition-model.js +199 -0
  186. package/dist/module/conditions/condition-model.js.map +1 -0
  187. package/dist/module/conditions/condition-operators.d.ts +248 -0
  188. package/dist/module/conditions/condition-operators.d.ts.map +1 -0
  189. package/dist/module/conditions/condition-operators.js +119 -0
  190. package/dist/module/conditions/condition-operators.js.map +1 -0
  191. package/dist/module/conditions/condition-ref.d.ts +12 -0
  192. package/dist/module/conditions/condition-ref.d.ts.map +1 -0
  193. package/dist/module/conditions/condition-ref.js +33 -0
  194. package/dist/module/conditions/condition-ref.js.map +1 -0
  195. package/dist/module/conditions/condition-value-abstract.d.ts +8 -0
  196. package/dist/module/conditions/condition-value-abstract.d.ts.map +1 -0
  197. package/dist/module/conditions/condition-value-abstract.js +24 -0
  198. package/dist/module/conditions/condition-value-abstract.js.map +1 -0
  199. package/dist/module/conditions/condition-value-registration.d.ts +10 -0
  200. package/dist/module/conditions/condition-value-registration.d.ts.map +1 -0
  201. package/dist/module/conditions/condition-value-registration.js +19 -0
  202. package/dist/module/conditions/condition-value-registration.js.map +1 -0
  203. package/dist/module/conditions/condition-values.d.ts +38 -0
  204. package/dist/module/conditions/condition-values.d.ts.map +1 -0
  205. package/dist/module/conditions/condition-values.js +106 -0
  206. package/dist/module/conditions/condition-values.js.map +1 -0
  207. package/dist/module/conditions/condition.d.ts +15 -0
  208. package/dist/module/conditions/condition.d.ts.map +1 -0
  209. package/dist/module/conditions/condition.js +40 -0
  210. package/dist/module/conditions/condition.js.map +1 -0
  211. package/dist/module/conditions/helpers.d.ts +3 -0
  212. package/dist/module/conditions/helpers.d.ts.map +1 -0
  213. package/dist/module/conditions/helpers.js +12 -0
  214. package/dist/module/conditions/helpers.js.map +1 -0
  215. package/dist/module/conditions/index.d.ts +11 -0
  216. package/dist/module/conditions/index.d.ts.map +1 -0
  217. package/dist/module/conditions/index.js +140 -0
  218. package/dist/module/conditions/index.js.map +1 -0
  219. package/dist/module/conditions/inline-condition-model.d.ts +86 -0
  220. package/dist/module/conditions/inline-condition-model.d.ts.map +1 -0
  221. package/dist/module/conditions/inline-condition-model.js +384 -0
  222. package/dist/module/conditions/inline-condition-model.js.map +1 -0
  223. package/dist/module/conditions/inline-condition-operators.d.ts +175 -0
  224. package/dist/module/conditions/inline-condition-operators.d.ts.map +1 -0
  225. package/dist/module/conditions/inline-condition-operators.js +119 -0
  226. package/dist/module/conditions/inline-condition-operators.js.map +1 -0
  227. package/dist/module/conditions/inline-condition-values.d.ts +93 -0
  228. package/dist/module/conditions/inline-condition-values.d.ts.map +1 -0
  229. package/dist/module/conditions/inline-condition-values.js +134 -0
  230. package/dist/module/conditions/inline-condition-values.js.map +1 -0
  231. package/dist/module/conditions/types.d.ts +38 -0
  232. package/dist/module/conditions/types.d.ts.map +1 -0
  233. package/dist/module/conditions/types.js +10 -0
  234. package/dist/module/conditions/types.js.map +1 -0
  235. package/dist/module/data-model/conditions-wrapper.d.ts +19 -0
  236. package/dist/module/data-model/conditions-wrapper.d.ts.map +1 -0
  237. package/dist/module/data-model/conditions-wrapper.js +30 -0
  238. package/dist/module/data-model/conditions-wrapper.js.map +1 -0
  239. package/dist/module/data-model/index.d.ts +4 -0
  240. package/dist/module/data-model/index.d.ts.map +1 -0
  241. package/dist/module/data-model/index.js +55 -0
  242. package/dist/module/data-model/index.js.map +1 -0
  243. package/dist/module/data-model/input-wrapper.d.ts +16 -0
  244. package/dist/module/data-model/input-wrapper.d.ts.map +1 -0
  245. package/dist/module/data-model/input-wrapper.js +25 -0
  246. package/dist/module/data-model/input-wrapper.js.map +1 -0
  247. package/dist/module/data-model/types.d.ts +153 -0
  248. package/dist/module/data-model/types.d.ts.map +1 -0
  249. package/dist/module/data-model/types.js +20 -0
  250. package/dist/module/data-model/types.js.map +1 -0
  251. package/dist/module/form/form-configuration.d.ts +8 -0
  252. package/dist/module/form/form-configuration.d.ts.map +1 -0
  253. package/dist/module/form/form-configuration.js +17 -0
  254. package/dist/module/form/form-configuration.js.map +1 -0
  255. package/dist/module/form/index.d.ts +2 -0
  256. package/dist/module/form/index.d.ts.map +1 -0
  257. package/dist/module/form/index.js +11 -0
  258. package/dist/module/form/index.js.map +1 -0
  259. package/dist/module/index.d.ts +12 -0
  260. package/dist/module/index.d.ts.map +1 -0
  261. package/dist/module/index.js +135 -0
  262. package/dist/module/index.js.map +1 -0
  263. package/dist/module/migration/index.d.ts +2 -0
  264. package/dist/module/migration/index.d.ts.map +1 -0
  265. package/dist/module/migration/index.js +11 -0
  266. package/dist/module/migration/index.js.map +1 -0
  267. package/dist/module/migration/migration.0-2.d.ts +3 -0
  268. package/dist/module/migration/migration.0-2.d.ts.map +1 -0
  269. package/dist/module/migration/migration.0-2.js +42 -0
  270. package/dist/module/migration/migration.0-2.js.map +1 -0
  271. package/dist/module/migration/migration.1-2.d.ts +3 -0
  272. package/dist/module/migration/migration.1-2.d.ts.map +1 -0
  273. package/dist/module/migration/migration.1-2.js +90 -0
  274. package/dist/module/migration/migration.1-2.js.map +1 -0
  275. package/dist/module/migration/types.d.ts +2 -0
  276. package/dist/module/migration/types.d.ts.map +1 -0
  277. package/dist/module/migration/types.js +1 -0
  278. package/dist/module/migration/types.js.map +1 -0
  279. package/dist/module/migration/whichMigrations.d.ts +7 -0
  280. package/dist/module/migration/whichMigrations.d.ts.map +1 -0
  281. package/dist/module/migration/whichMigrations.js +26 -0
  282. package/dist/module/migration/whichMigrations.js.map +1 -0
  283. package/dist/module/schema/index.d.ts +2 -0
  284. package/dist/module/schema/index.d.ts.map +1 -0
  285. package/dist/module/schema/index.js +17 -0
  286. package/dist/module/schema/index.js.map +1 -0
  287. package/dist/module/schema/schema.d.ts +20 -0
  288. package/dist/module/schema/schema.d.ts.map +1 -0
  289. package/dist/module/schema/schema.js +239 -0
  290. package/dist/module/schema/schema.js.map +1 -0
  291. package/dist/module/utils/helpers.d.ts +9 -0
  292. package/dist/module/utils/helpers.d.ts.map +1 -0
  293. package/dist/module/utils/helpers.js +35 -0
  294. package/dist/module/utils/helpers.js.map +1 -0
  295. package/dist/module/utils/logger.d.ts +11 -0
  296. package/dist/module/utils/logger.d.ts.map +1 -0
  297. package/dist/module/utils/logger.js +27 -0
  298. package/dist/module/utils/logger.js.map +1 -0
  299. package/package.json +35 -0
  300. package/src/components/component-types.ts +229 -0
  301. package/src/components/conditional-component-types.ts +14 -0
  302. package/src/components/index.ts +3 -0
  303. package/src/components/types.ts +362 -0
  304. package/src/conditions/condition-abstract.ts +59 -0
  305. package/src/conditions/condition-field.ts +29 -0
  306. package/src/conditions/condition-group-def.ts +29 -0
  307. package/src/conditions/condition-group.ts +61 -0
  308. package/src/conditions/condition-model.ts +314 -0
  309. package/src/conditions/condition-operators.ts +176 -0
  310. package/src/conditions/condition-ref.ts +47 -0
  311. package/src/conditions/condition-value-abstract.ts +31 -0
  312. package/src/conditions/condition-value-registration.ts +18 -0
  313. package/src/conditions/condition-values.ts +146 -0
  314. package/src/conditions/condition.ts +64 -0
  315. package/src/conditions/helpers.ts +7 -0
  316. package/src/conditions/index.ts +27 -0
  317. package/src/conditions/inline-condition-model.ts +550 -0
  318. package/src/conditions/inline-condition-operators.ts +166 -0
  319. package/src/conditions/inline-condition-values.ts +153 -0
  320. package/src/conditions/types.ts +30 -0
  321. package/src/data-model/conditions-wrapper.ts +42 -0
  322. package/src/data-model/index.ts +3 -0
  323. package/src/data-model/input-wrapper.ts +40 -0
  324. package/src/data-model/types.ts +179 -0
  325. package/src/form/form-configuration.ts +21 -0
  326. package/src/form/index.ts +1 -0
  327. package/src/index.ts +11 -0
  328. package/src/migration/index.ts +1 -0
  329. package/src/migration/migration.0-2.ts +29 -0
  330. package/src/migration/migration.1-2.ts +105 -0
  331. package/src/migration/types.ts +1 -0
  332. package/src/migration/whichMigrations.ts +23 -0
  333. package/src/schema/index.ts +1 -0
  334. package/src/schema/schema.ts +300 -0
  335. package/src/utils/helpers.ts +37 -0
  336. package/src/utils/logger.ts +29 -0
@@ -0,0 +1,300 @@
1
+ import joi from 'joi'
2
+
3
+ /**
4
+ * If an optional key is added, CURRENT_VERSION does not need to be incremented.
5
+ * Only breaking changes will require an increment, as well as a migration script.
6
+ */
7
+ export const CURRENT_VERSION = 2
8
+ const sectionsSchema = joi.object().keys({
9
+ name: joi.string().required(),
10
+ title: joi.string().required(),
11
+ hideTitle: joi.boolean().default(false)
12
+ })
13
+
14
+ const conditionFieldSchema = joi.object().keys({
15
+ name: joi.string().required(),
16
+ type: joi.string().required(),
17
+ display: joi.string().required()
18
+ })
19
+
20
+ const conditionValueSchema = joi.object().keys({
21
+ type: joi.string().required(),
22
+ value: joi.string().required(),
23
+ display: joi.string().required()
24
+ })
25
+
26
+ const relativeTimeValueSchema = joi.object().keys({
27
+ type: joi.string().required(),
28
+ timePeriod: joi.string().required(),
29
+ timeUnit: joi.string().required(),
30
+ direction: joi.string().required(),
31
+ timeOnly: joi.boolean().required()
32
+ })
33
+
34
+ const conditionRefSchema = joi.object().keys({
35
+ conditionName: joi.string().required(),
36
+ conditionDisplayName: joi.string().required(),
37
+ coordinator: joi.string().optional()
38
+ })
39
+
40
+ const conditionSchema = joi.object().keys({
41
+ field: conditionFieldSchema,
42
+ operator: joi.string().required(),
43
+ value: joi.alternatives().try(conditionValueSchema, relativeTimeValueSchema),
44
+ coordinator: joi.string().optional()
45
+ })
46
+
47
+ const conditionGroupSchema = joi.object().keys({
48
+ conditions: joi
49
+ .array()
50
+ .items(
51
+ joi
52
+ .alternatives()
53
+ .try(
54
+ conditionSchema,
55
+ conditionRefSchema,
56
+ joi.any() /** Should be a joi.link('#conditionGroupSchema') */
57
+ )
58
+ )
59
+ })
60
+
61
+ const conditionsModelSchema = joi.object().keys({
62
+ name: joi.string().required(),
63
+ conditions: joi
64
+ .array()
65
+ .items(
66
+ joi
67
+ .alternatives()
68
+ .try(conditionSchema, conditionRefSchema, conditionGroupSchema)
69
+ )
70
+ })
71
+
72
+ const conditionsSchema = joi.object().keys({
73
+ name: joi.string().required(),
74
+ displayName: joi.string(),
75
+ value: joi.alternatives().try(joi.string(), conditionsModelSchema).required()
76
+ })
77
+
78
+ const localisedString = joi
79
+ .alternatives()
80
+ .try(joi.object({ a: joi.any() }).unknown(), joi.string().allow(''))
81
+
82
+ export const componentSchema = joi
83
+ .object()
84
+ .keys({
85
+ type: joi.string().required(),
86
+ name: joi.string(),
87
+ title: localisedString,
88
+ hint: localisedString.optional(),
89
+ options: joi.object().default({}),
90
+ schema: joi
91
+ .object({ min: joi.number(), max: joi.number() })
92
+ .unknown(true)
93
+ .default({}),
94
+ list: joi.string().optional()
95
+ })
96
+ .unknown(true)
97
+
98
+ const nextSchema = joi.object().keys({
99
+ path: joi.string().required(),
100
+ condition: joi.string().allow('').optional(),
101
+ redirect: joi.string().uri().optional()
102
+ })
103
+
104
+ /**
105
+ * `/status` is a special route for providing a user's application status.
106
+ * It should not be configured via the designer.
107
+ */
108
+ const pageSchema = joi.object().keys({
109
+ path: joi.string().required().disallow('/status'),
110
+ title: localisedString,
111
+ section: joi.string(),
112
+ controller: joi.string(),
113
+ components: joi.array().items(componentSchema),
114
+ next: joi.array().items(nextSchema),
115
+ repeatField: joi.string().optional(),
116
+ options: joi.object().optional(),
117
+ backLinkFallback: joi.string().optional()
118
+ })
119
+
120
+ const toggleableString = joi.alternatives().try(joi.boolean(), joi.string())
121
+
122
+ const confirmationPageSchema = joi.object({
123
+ customText: joi
124
+ .object({
125
+ title: joi.string().default('Application complete'),
126
+ paymentSkipped: toggleableString.default(
127
+ 'Someone will be in touch to make a payment.'
128
+ ),
129
+ nextSteps: toggleableString.default(
130
+ 'You will receive an email with details with the next steps.'
131
+ )
132
+ })
133
+ .default(),
134
+ components: joi.array().items(componentSchema)
135
+ })
136
+
137
+ const paymentSkippedWarningPage = joi.object({
138
+ customText: joi.object({
139
+ title: joi.string().default('Pay for your application').optional(),
140
+ caption: joi.string().default('Payment').optional(),
141
+ body: joi.string().default('').optional()
142
+ })
143
+ })
144
+
145
+ const specialPagesSchema = joi.object().keys({
146
+ confirmationPage: confirmationPageSchema.optional(),
147
+ paymentSkippedWarningPage: paymentSkippedWarningPage.optional()
148
+ })
149
+
150
+ const listItemSchema = joi.object().keys({
151
+ text: localisedString,
152
+ value: joi.alternatives().try(joi.number(), joi.string()),
153
+ description: localisedString.optional(),
154
+ conditional: joi
155
+ .object()
156
+ .keys({
157
+ components: joi
158
+ .array()
159
+ .required()
160
+ .items(componentSchema.unknown(true))
161
+ .unique('name')
162
+ })
163
+ .allow(null)
164
+ .optional(),
165
+ condition: joi.string().allow(null, '').optional()
166
+ })
167
+
168
+ const listSchema = joi.object().keys({
169
+ name: joi.string().required(),
170
+ title: localisedString,
171
+ type: joi.string().required().valid('string', 'number'),
172
+ items: joi.array().items(listItemSchema)
173
+ })
174
+
175
+ const feeSchema = joi.object().keys({
176
+ description: joi.string().required(),
177
+ amount: joi.number().required(),
178
+ multiplier: joi.string().optional(),
179
+ condition: joi.string().optional(),
180
+ prefix: joi.string().optional()
181
+ })
182
+
183
+ const multiApiKeySchema = joi.object({
184
+ test: joi.string().optional(),
185
+ production: joi.string().optional()
186
+ })
187
+
188
+ const replyToConfigurationSchema = joi.object({
189
+ emailReplyToId: joi.string(),
190
+ condition: joi.string().allow('').optional()
191
+ })
192
+
193
+ const notifySchema = joi.object().keys({
194
+ apiKey: [joi.string().allow('').optional(), multiApiKeySchema],
195
+ templateId: joi.string(),
196
+ emailField: joi.string(),
197
+ personalisation: joi.array().items(joi.string()),
198
+ personalisationFieldCustomisation: joi
199
+ .object()
200
+ .pattern(/./, joi.array().items(joi.string()))
201
+ .optional(),
202
+ addReferencesToPersonalisation: joi.boolean().optional(),
203
+ emailReplyToIdConfiguration: joi.array().items(replyToConfigurationSchema)
204
+ })
205
+
206
+ const emailSchema = joi.object().keys({
207
+ emailAddress: joi.string()
208
+ })
209
+
210
+ const webhookSchema = joi.object().keys({
211
+ url: joi.string(),
212
+ allowRetry: joi.boolean().default(true)
213
+ })
214
+
215
+ const outputSchema = joi.object().keys({
216
+ name: joi.string(),
217
+ title: joi.string().optional(),
218
+ type: joi.string().allow('notify', 'email', 'webhook', 'sheets'),
219
+ outputConfiguration: joi
220
+ .alternatives()
221
+ .try(notifySchema, emailSchema, webhookSchema)
222
+ })
223
+
224
+ const feedbackSchema = joi.object().keys({
225
+ feedbackForm: joi.boolean().default(false),
226
+ url: joi.when('feedbackForm', {
227
+ is: joi.boolean().valid(false),
228
+ then: joi.string().optional().allow('')
229
+ }),
230
+ emailAddress: joi
231
+ .string()
232
+ .email({
233
+ tlds: {
234
+ allow: false
235
+ }
236
+ })
237
+ .optional()
238
+ })
239
+
240
+ const phaseBannerSchema = joi.object().keys({
241
+ phase: joi.string().valid('alpha', 'beta')
242
+ })
243
+
244
+ const feeOptionSchema = joi
245
+ .object()
246
+ .keys({
247
+ payApiKey: [joi.string().allow('').optional(), multiApiKeySchema],
248
+ paymentReferenceFormat: [joi.string().optional()],
249
+ payReturnUrl: joi.string().optional(),
250
+ allowSubmissionWithoutPayment: joi.boolean().optional().default(true),
251
+ maxAttempts: joi.number().optional().default(3),
252
+ customPayErrorMessage: joi.string().optional(),
253
+ showPaymentSkippedWarningPage: joi.when('allowSubmissionWithoutPayment', {
254
+ is: true,
255
+ then: joi.boolean().valid(true, false).default(false),
256
+ otherwise: joi.boolean().valid(false).default(false)
257
+ })
258
+ })
259
+ .default(({ payApiKey, paymentReferenceFormat }) => {
260
+ return {
261
+ ...(payApiKey && { payApiKey }),
262
+ ...(paymentReferenceFormat && { paymentReferenceFormat })
263
+ }
264
+ })
265
+
266
+ export const Schema = joi
267
+ .object()
268
+ .required()
269
+ .keys({
270
+ name: localisedString.optional(),
271
+ feedback: feedbackSchema,
272
+ startPage: joi.string().required(),
273
+ pages: joi.array().required().items(pageSchema).unique('path'),
274
+ sections: joi.array().items(sectionsSchema).unique('name').required(),
275
+ conditions: joi.array().items(conditionsSchema).unique('name'),
276
+ lists: joi.array().items(listSchema).unique('name'),
277
+ fees: joi.array().items(feeSchema).optional(),
278
+ paymentReferenceFormat: joi.string().optional(),
279
+ metadata: joi.object({ a: joi.any() }).unknown().optional(),
280
+ declaration: joi.string().allow('').optional(),
281
+ outputs: joi.array().items(outputSchema),
282
+ payApiKey: [joi.string().allow('').optional(), multiApiKeySchema],
283
+ skipSummary: joi.boolean().default(false),
284
+ version: joi.number().default(CURRENT_VERSION),
285
+ phaseBanner: phaseBannerSchema,
286
+ specialPages: specialPagesSchema.optional(),
287
+ feeOptions: feeOptionSchema
288
+ })
289
+
290
+ /**
291
+ * Schema versions:
292
+ * Undefined / 0 - initial version as at 28/8/20. Conditions may be in object structure or string form.
293
+ * 1 - Relevant components (radio, checkbox, select, autocomplete) now contain
294
+ * options as 'values' rather than referencing a data list
295
+ * 2 - Reverse v1. Values populating radio, checkboxes, select, autocomplete are defined in Lists only.
296
+ * TODO:- merge fees and paymentReferenceFormat
297
+ * 2 - 2023-05-04 `feeOptions` has been introduced. paymentReferenceFormat and payApiKey can be configured in top level or feeOptions. feeOptions will take precedent.
298
+ * if feeOptions are empty, it will pull values from the top level keys.
299
+ * WARN: Fee/GOV.UK pay configurations (apart from fees) should no longer be stored in the top level, always within feeOptions.
300
+ **/
@@ -0,0 +1,37 @@
1
+ import { customAlphabet } from 'nanoid'
2
+
3
+ export const serialiseAndDeserialise = <T>(obj: T): T => {
4
+ if (typeof obj === 'object' && obj !== null) {
5
+ return JSON.parse(JSON.stringify(obj))
6
+ }
7
+
8
+ return obj
9
+ }
10
+
11
+ export const clone = <T>(obj: T & { clone?: () => T }): T => {
12
+ if (obj) {
13
+ if (typeof obj.clone === 'function') {
14
+ return obj.clone()
15
+ }
16
+
17
+ return serialiseAndDeserialise<T>(obj)
18
+ }
19
+ return obj
20
+ }
21
+
22
+ export function filter<T extends { [key: string]: unknown }>(
23
+ obj: T,
24
+ predicate: (value: any) => boolean
25
+ ): Partial<T> {
26
+ const result = {}
27
+
28
+ for (const [key, value] of Object.entries(obj)) {
29
+ if (value && predicate(value)) {
30
+ result[key] = value
31
+ }
32
+ }
33
+
34
+ return result
35
+ }
36
+
37
+ export const nanoid = customAlphabet('0123456789_abcdefghijklmnopqrstuvwxyz', 6)
@@ -0,0 +1,29 @@
1
+ export class Logger {
2
+ server: any
3
+ name: string
4
+
5
+ constructor(server: any, name: string) {
6
+ this.server = server
7
+ this.name = name
8
+ }
9
+
10
+ error(message: string) {
11
+ this.log('error', message)
12
+ }
13
+
14
+ warn(message: string) {
15
+ this.log('warn', message)
16
+ }
17
+
18
+ info(message: string) {
19
+ this.log('info', message)
20
+ }
21
+
22
+ debug(message: string) {
23
+ this.log('debug', message)
24
+ }
25
+
26
+ log(level: string, message: string) {
27
+ this.server.log([level, this.name], message)
28
+ }
29
+ }