@defra/forms-model 3.0.447 → 3.0.449

package/src/form/form-editor/preview/short-answer.js

@@ -0,0 +1,3 @@
+import { Question } from '~/src/form/form-editor/preview/question.js'
+
+export class ShortAnswerQuestion extends Question {}

package/src/form/form-editor/preview/types.ts

@@ -0,0 +1,60 @@
+import {
+  type ListElement,
+  type ListItemReadonly
+} from '~/src/form/form-editor/types.js'
+
+export interface BaseSettings {
+  question: string
+  hintText: string
+  optional: boolean
+  shortDesc: string
+  items: ListElement[]
+}
+
+export interface DefaultComponent {
+  id?: string
+  text: string
+  classes: string
+}
+
+export interface GovukFieldset {
+  legend: DefaultComponent
+}
+
+export interface QuestionBaseModel {
+  id?: string
+  name?: string
+  label?: DefaultComponent
+  hint?: DefaultComponent
+  fieldset?: GovukFieldset
+  readonly items?: ListItemReadonly[]
+  text?: string
+  formGroup?: { afterInputs: { html: string } }
+}
+
+export type ListenerRow = [
+  HTMLInputElement | null,
+  (target: HTMLInputElement, e: Event) => void,
+  keyof HTMLElementEventMap
+]
+
+export interface QuestionElements {
+  readonly values: BaseSettings
+  setPreviewHTML(value: string): void
+}
+
+export interface RenderContext {
+  model: QuestionBaseModel
+}
+
+export interface HTMLBuilder {
+  buildHTML(questionTemplate: string, renderContext: RenderContext): string
+}
+
+export interface QuestionRenderer {
+  render(questionTemplate: string, questionBaseModel: QuestionBaseModel): void
+}
+
+export interface ListElements extends QuestionElements {
+  afterInputsHTML: string
+}

package/src/form/form-editor/preview/uk-address.js

@@ -0,0 +1,6 @@
+import { Question } from '~/src/form/form-editor/preview/question.js'
+
+export class UkAddressQuestion extends Question {
+  _questionTemplate = 'ukaddressfield.njk'
+  _fieldName = 'addressField'
+}

package/src/form/form-editor/types.ts

@@ -71,6 +71,26 @@ export interface FormEditor {
    */
   guidanceText: string
 
+  /**
+   * The value of checkbox to reveal repeater section
+   */
+  repeater: string
+
+  /**
+   * The maximum number of repeater items
+   */
+  minItems: number
+
+  /**
+   * The minimum number of repeater items
+   */
+  maxItems: number
+
+  /**
+   * The repeater question set name
+   */
+  questionSetName: string
+
   /**
    * The value of radio to reveal declaration text field
    */
@@ -277,7 +297,13 @@ export type FormEditorInputQuestion = Pick<
 
 export type FormEditorInputPageSettings = Pick<
   FormEditor,
-  'pageHeadingAndGuidance' | 'pageHeading' | 'guidanceText'
+  | 'pageHeadingAndGuidance'
+  | 'pageHeading'
+  | 'guidanceText'
+  | 'repeater'
+  | 'minItems'
+  | 'maxItems'
+  | 'questionSetName'
 >
 
 export type FormEditorInputGuidancePage = Pick<
@@ -354,6 +380,12 @@ export interface QuestionSessionState {
   lastMoveDirection?: string
 }
 
+export interface GovukFieldItem {
+  text?: string
+  value?: string
+  checked?: boolean
+}
+
 export interface GovukField {
   id?: string
   name?: string
@@ -370,12 +402,25 @@ export interface GovukField {
     isPageHeading?: boolean
   }
   hint?: { text?: string; html?: string; classes?: string }
-  items?: { text?: string; value?: string; checked?: boolean }[]
+  items?: GovukFieldItem[]
   rows?: number
   type?: string
   customTemplate?: string
 }
 
+export type GovukFieldQuestionOptional = Omit<GovukField, 'name' | 'items'> & {
+  name: 'questionOptional'
+  items: [
+    {
+      text?: string
+      value?: string
+      checked: boolean
+    }
+  ]
+}
+
+export type GovukStringField = Omit<GovukField, 'value'> & { value: string }
+
 export interface FormEditorGovukField {
   question?: GovukField
   hintText?: GovukField

package/src/form/form-manager/types.ts

@@ -1,7 +1,7 @@
-import { type Page } from '~/src/index.js'
+import { type PageRepeat } from '~/src/index.js'
 
 export type PatchPageFields = Partial<
-  Pick<Page, 'title' | 'path' | 'controller'>
+  Pick<PageRepeat, 'title' | 'path' | 'controller' | 'repeat'>
 >
 
 export interface AddComponentQueryOptions {

package/src/index.ts

@@ -12,7 +12,7 @@ export * from '~/src/form/form-metadata/index.js'
 export * from '~/src/form/form-submission/index.js'
 export * from '~/src/form/utils/index.js'
 export * from '~/src/form/form-editor/index.js'
-export * from '~/src/form/form-manager/index.js'
+export * from '~/src/form/form-editor/preview/index.js'
 export * from '~/src/form/form-manager/types.js'
 export * from '~/src/pages/index.js'
 export * from '~/src/utils/helpers.js'
@@ -27,4 +27,5 @@ export type * from '~/src/conditions/types.js'
 export type * from '~/src/form/form-definition/types.js'
 export type * from '~/src/form/form-metadata/types.js'
 export type * from '~/src/form/form-submission/types.js'
+export type * from '~/src/form/form-editor/preview/types.js'
 export type * from '~/src/form/form-editor/types.js'

package/dist/module/form/form-manager/index.js

@@ -1,7 +0,0 @@
-import Joi from 'joi';
-import { pageSchema } from "../form-definition/index.js";
-export const patchPageSchema = Joi.object().keys({
-  title: pageSchema.extract('title').optional().description('New title to set for the page'),
-  path: pageSchema.extract('path').optional().description('New URL path to set for the page')
-}).required().min(1).description('Schema for partially updating a page, requiring at least one field to be provided');
-//# sourceMappingURL=index.js.map

package/dist/module/form/form-manager/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","names":["Joi","pageSchema","patchPageSchema","object","keys","title","extract","optional","description","path","required","min"],"sources":["../../../../src/form/form-manager/index.ts"],"sourcesContent":["import Joi from 'joi'\n\nimport { pageSchema } from '~/src/form/form-definition/index.js'\nimport { type PatchPageFields } from '~/src/form/form-manager/types.js'\n\nexport const patchPageSchema = Joi.object<PatchPageFields>()\n  .keys({\n    title: pageSchema\n      .extract('title')\n      .optional()\n      .description('New title to set for the page'),\n    path: pageSchema\n      .extract('path')\n      .optional()\n      .description('New URL path to set for the page')\n  })\n  .required()\n  .min(1)\n  .description(\n    'Schema for partially updating a page, requiring at least one field to be provided'\n  )\n"],"mappings":"AAAA,OAAOA,GAAG,MAAM,KAAK;AAErB,SAASC,UAAU;AAGnB,OAAO,MAAMC,eAAe,GAAGF,GAAG,CAACG,MAAM,CAAkB,CAAC,CACzDC,IAAI,CAAC;EACJC,KAAK,EAAEJ,UAAU,CACdK,OAAO,CAAC,OAAO,CAAC,CAChBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,+BAA+B,CAAC;EAC/CC,IAAI,EAAER,UAAU,CACbK,OAAO,CAAC,MAAM,CAAC,CACfC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,kCAAkC;AACnD,CAAC,CAAC,CACDE,QAAQ,CAAC,CAAC,CACVC,GAAG,CAAC,CAAC,CAAC,CACNH,WAAW,CACV,mFACF,CAAC","ignoreList":[]}

package/dist/types/form/form-manager/index.d.ts

@@ -1,3 +0,0 @@
-import Joi from 'joi';
-export declare const patchPageSchema: Joi.ObjectSchema<Partial<Pick<import("../form-definition/types.js").Page, "title" | "path" | "controller">>>;
-//# sourceMappingURL=index.d.ts.map

package/dist/types/form/form-manager/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/form/form-manager/index.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAA;AAKrB,eAAO,MAAM,eAAe,8GAezB,CAAA"}

package/schemas/patch-page-schema.json

@@ -1,26 +0,0 @@
-{
-  "type": "object",
-  "description": "Schema for partially updating a page, requiring at least one field to be provided",
-  "properties": {
-    "title": {
-      "type": "string",
-      "description": "New title to set for the page",
-      "title": "Title"
-    },
-    "path": {
-      "type": "string",
-      "description": "New URL path to set for the page",
-      "not": {
-        "type": "string",
-        "enum": [
-          "/status"
-        ]
-      },
-      "title": "Path"
-    }
-  },
-  "additionalProperties": false,
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "Patch Page Schema",
-  "$id": "@defra/forms-model/schemas/patch-page-schema.json"
-}

package/src/form/form-manager/index.ts

@@ -1,21 +0,0 @@
-import Joi from 'joi'
-
-import { pageSchema } from '~/src/form/form-definition/index.js'
-import { type PatchPageFields } from '~/src/form/form-manager/types.js'
-
-export const patchPageSchema = Joi.object<PatchPageFields>()
-  .keys({
-    title: pageSchema
-      .extract('title')
-      .optional()
-      .description('New title to set for the page'),
-    path: pageSchema
-      .extract('path')
-      .optional()
-      .description('New URL path to set for the page')
-  })
-  .required()
-  .min(1)
-  .description(
-    'Schema for partially updating a page, requiring at least one field to be provided'
-  )