@defra/forms-model 3.0.421 → 3.0.422

package/dist/module/form/form-editor/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":[],"sources":["../../../../src/form/form-editor/types.ts"],"sourcesContent":["/**\n * Interface for `FormEditor` Joi schema\n */\nexport interface FormEditor {\n  /**\n   * The type of the page\n   */\n  pageType: string\n\n  /**\n   * The type of the question\n   */\n  questionType: string | undefined\n\n  /**\n   * The sub-type of written answer\n   */\n  writtenAnswerSub: string\n\n  /**\n   * The sub-type of date\n   */\n  dateSub: string\n\n  /**\n   * The name of the question (unique id)\n   */\n  name: string\n\n  /**\n   * The text of the question\n   */\n  question: string\n\n  /**\n   * The hint text of the question\n   */\n  hintText: string\n\n  /**\n   * Denotes if the question is optional\n   */\n  questionOptional: string\n\n  /**\n   * The short description of the question\n   */\n  shortDescription: string\n\n  /**\n   * The value of checkbox to reveal heading and guidance section\n   */\n  pageHeadingAndGuidance: string\n\n  /**\n   * The page heading\n   */\n  pageHeading: string\n\n  /**\n   * The page guidance text\n   */\n  guidanceText: string\n\n  /**\n   * The value of radio to reveal declaration text field\n   */\n  needDeclaration: string\n\n  /**\n   * The check answers declaration text\n   */\n  declarationText: string\n\n  /**\n   * The min length a field can have\n   */\n  minLength: string\n\n  /**\n   * The max length a field can have\n   */\n  maxLength: string\n\n  /**\n   * The regex value of a field\n   */\n  regex: string\n\n  /**\n   * The classes to be applied to a field\n   */\n  classes: string\n}\n\nexport type FormEditorInputPage = Pick<\n  FormEditor,\n  'pageType' | 'questionType' | 'writtenAnswerSub' | 'dateSub'\n>\n\nexport type FormEditorInputCheckAnswersSettings = Pick<\n  FormEditor,\n  'needDeclaration' | 'declarationText'\n>\n\nexport type FormEditorInputQuestion = Pick<\n  FormEditor,\n  | 'questionType'\n  | 'name'\n  | 'question'\n  | 'shortDescription'\n  | 'hintText'\n  | 'questionOptional'\n  | 'minLength'\n  | 'maxLength'\n  | 'regex'\n  | 'classes'\n>\n\nexport type FormEditorInputPageSettings = Pick<\n  FormEditor,\n  'pageHeadingAndGuidance' | 'pageHeading' | 'guidanceText'\n>\n\nexport interface GovukField {\n  id?: string\n  name?: string\n  idPrefix?: string\n  value?: string | boolean | number\n  classes?: string\n  label?: { text?: string; html?: string; classes?: string }\n  hint?: { text?: string; html?: string; classes?: string }\n  items?: { text?: string; value?: string }\n  rows?: number\n}\n\nexport interface FormEditorGovukField {\n  question?: GovukField\n  hintText?: GovukField\n  questionOptional?: GovukField\n  shortDescription?: GovukField\n  minLength?: GovukField\n  maxLength?: GovukField\n  regex?: GovukField\n  classes?: GovukField\n  errorMessage?: { text: string }\n}\n\nexport interface FormEditorGovukFieldList {\n  fields: FormEditorGovukField\n  optionalFieldsPartial?: string\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"types.js","names":[],"sources":["../../../../src/form/form-editor/types.ts"],"sourcesContent":["/**\n * Interface for `FormEditor` Joi schema\n */\nexport interface FormEditor {\n  /**\n   * The type of the page\n   */\n  pageType: string\n\n  /**\n   * The type of the question\n   */\n  questionType: string | undefined\n\n  /**\n   * The sub-type of written answer\n   */\n  writtenAnswerSub: string\n\n  /**\n   * The sub-type of date\n   */\n  dateSub: string\n\n  /**\n   * The name of the question (unique id)\n   */\n  name: string\n\n  /**\n   * The text of the question\n   */\n  question: string\n\n  /**\n   * The hint text of the question\n   */\n  hintText: string\n\n  /**\n   * Denotes if the question is optional\n   */\n  questionOptional: string\n\n  /**\n   * The short description of the question\n   */\n  shortDescription: string\n\n  /**\n   * The value of checkbox to reveal heading and guidance section\n   */\n  pageHeadingAndGuidance: string\n\n  /**\n   * The page heading\n   */\n  pageHeading: string\n\n  /**\n   * The page guidance text\n   */\n  guidanceText: string\n\n  /**\n   * The value of radio to reveal declaration text field\n   */\n  needDeclaration: string\n\n  /**\n   * The check answers declaration text\n   */\n  declarationText: string\n\n  /**\n   * The min length a field can have\n   */\n  minLength: string\n\n  /**\n   * The max length a field can have\n   */\n  maxLength: string\n\n  /**\n   * The regex value of a field\n   */\n  regex: string\n\n  /**\n   * The classes to be applied to a field\n   */\n  classes: string\n}\n\nexport type FormEditorInputPage = Pick<\n  FormEditor,\n  'pageType' | 'questionType' | 'writtenAnswerSub' | 'dateSub'\n>\n\nexport type FormEditorInputCheckAnswersSettings = Pick<\n  FormEditor,\n  'needDeclaration' | 'declarationText'\n>\n\nexport type FormEditorInputQuestion = Pick<\n  FormEditor,\n  | 'questionType'\n  | 'name'\n  | 'question'\n  | 'shortDescription'\n  | 'hintText'\n  | 'questionOptional'\n  | 'minLength'\n  | 'maxLength'\n  | 'regex'\n  | 'classes'\n>\n\nexport type FormEditorInputPageSettings = Pick<\n  FormEditor,\n  'pageHeadingAndGuidance' | 'pageHeading' | 'guidanceText'\n>\n\nexport interface GovukField {\n  id?: string\n  name?: string\n  idPrefix?: string\n  value?: string | boolean | number\n  classes?: string\n  label?: { text?: string; html?: string; classes?: string }\n  hint?: { text?: string; html?: string; classes?: string }\n  items?: { text?: string; value?: string }\n  rows?: number\n  type?: string\n}\n\nexport interface FormEditorGovukField {\n  question?: GovukField\n  hintText?: GovukField\n  questionOptional?: GovukField\n  shortDescription?: GovukField\n  minLength?: GovukField\n  maxLength?: GovukField\n  regex?: GovukField\n  classes?: GovukField\n  errorMessage?: { text: string }\n}\n"],"mappings":"","ignoreList":[]}

package/dist/types/form/form-editor/types.d.ts

@@ -100,6 +100,7 @@ export interface GovukField {
         value?: string;
     };
     rows?: number;
+    type?: string;
 }
 export interface FormEditorGovukField {
     question?: GovukField;
@@ -114,8 +115,4 @@ export interface FormEditorGovukField {
         text: string;
     };
 }
-export interface FormEditorGovukFieldList {
-    fields: FormEditorGovukField;
-    optionalFieldsPartial?: string;
-}
 //# sourceMappingURL=types.d.ts.map

package/dist/types/form/form-editor/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/form/form-editor/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,SAAS,CAAA;IAEhC;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAA;IAE9B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,MAAM,mBAAmB,GAAG,IAAI,CACpC,UAAU,EACV,UAAU,GAAG,cAAc,GAAG,kBAAkB,GAAG,SAAS,CAC7D,CAAA;AAED,MAAM,MAAM,mCAAmC,GAAG,IAAI,CACpD,UAAU,EACV,iBAAiB,GAAG,iBAAiB,CACtC,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG,IAAI,CACxC,UAAU,EACR,cAAc,GACd,MAAM,GACN,UAAU,GACV,kBAAkB,GAClB,UAAU,GACV,kBAAkB,GAClB,WAAW,GACX,WAAW,GACX,OAAO,GACP,SAAS,CACZ,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG,IAAI,CAC5C,UAAU,EACV,wBAAwB,GAAG,aAAa,GAAG,cAAc,CAC1D,CAAA;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,CAAA;IACjC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IAC1D,IAAI,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IACzD,KAAK,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IACzC,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,EAAE,UAAU,CAAA;IACrB,QAAQ,CAAC,EAAE,UAAU,CAAA;IACrB,gBAAgB,CAAC,EAAE,UAAU,CAAA;IAC7B,gBAAgB,CAAC,EAAE,UAAU,CAAA;IAC7B,SAAS,CAAC,EAAE,UAAU,CAAA;IACtB,SAAS,CAAC,EAAE,UAAU,CAAA;IACtB,KAAK,CAAC,EAAE,UAAU,CAAA;IAClB,OAAO,CAAC,EAAE,UAAU,CAAA;IACpB,YAAY,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;CAChC;AAED,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE,oBAAoB,CAAA;IAC5B,qBAAqB,CAAC,EAAE,MAAM,CAAA;CAC/B"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/form/form-editor/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,SAAS,CAAA;IAEhC;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAA;IAE9B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,MAAM,mBAAmB,GAAG,IAAI,CACpC,UAAU,EACV,UAAU,GAAG,cAAc,GAAG,kBAAkB,GAAG,SAAS,CAC7D,CAAA;AAED,MAAM,MAAM,mCAAmC,GAAG,IAAI,CACpD,UAAU,EACV,iBAAiB,GAAG,iBAAiB,CACtC,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG,IAAI,CACxC,UAAU,EACR,cAAc,GACd,MAAM,GACN,UAAU,GACV,kBAAkB,GAClB,UAAU,GACV,kBAAkB,GAClB,WAAW,GACX,WAAW,GACX,OAAO,GACP,SAAS,CACZ,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG,IAAI,CAC5C,UAAU,EACV,wBAAwB,GAAG,aAAa,GAAG,cAAc,CAC1D,CAAA;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,CAAA;IACjC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IAC1D,IAAI,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IACzD,KAAK,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IACzC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,EAAE,UAAU,CAAA;IACrB,QAAQ,CAAC,EAAE,UAAU,CAAA;IACrB,gBAAgB,CAAC,EAAE,UAAU,CAAA;IAC7B,gBAAgB,CAAC,EAAE,UAAU,CAAA;IAC7B,SAAS,CAAC,EAAE,UAAU,CAAA;IACtB,SAAS,CAAC,EAAE,UAAU,CAAA;IACtB,KAAK,CAAC,EAAE,UAAU,CAAA;IAClB,OAAO,CAAC,EAAE,UAAU,CAAA;IACpB,YAAY,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;CAChC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-model",
-  "version": "3.0.421",
+  "version": "3.0.422",
   "description": "A hapi plugin providing the model for Defra forms",
   "homepage": "https://github.com/DEFRA/forms-designer/tree/main/model#readme",
   "repository": {

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

@@ -56,7 +56,7 @@ export const questionOptionalSchema = Joi.string().optional().valid('', 'true')
 export const shortDescriptionSchema = Joi.string().required()
 export const pageHeadingAndGuidanceSchema = Joi.string().optional()
 export const pageHeadingSchema = Joi.string().required()
-export const guidanceTextSchema = Joi.string().optional().allow('')
+export const guidanceTextSchema = Joi.string()
 export const needDeclarationSchema = Joi.string().required()
 export const declarationTextSchema = Joi.string().required()
 export const minLengthSchema = Joi.number().empty('').min(1)

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

@@ -122,6 +122,11 @@ export type FormEditorInputPageSettings = Pick<
   'pageHeadingAndGuidance' | 'pageHeading' | 'guidanceText'
 >
 
+export type FormEditorInputGuidancePage = Pick<
+  FormEditor,
+  'pageHeading' | 'guidanceText'
+>
+
 export interface GovukField {
   id?: string
   name?: string
@@ -132,6 +137,7 @@ export interface GovukField {
   hint?: { text?: string; html?: string; classes?: string }
   items?: { text?: string; value?: string }
   rows?: number
+  type?: string
 }
 
 export interface FormEditorGovukField {
@@ -145,8 +151,3 @@ export interface FormEditorGovukField {
   classes?: GovukField
   errorMessage?: { text: string }
 }
-
-export interface FormEditorGovukFieldList {
-  fields: FormEditorGovukField
-  optionalFieldsPartial?: string
-}