@defra/forms-model 3.0.687 → 3.0.689

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

@@ -0,0 +1,95 @@
+/**
+ * Lookup a translation from a list of translation records.
+ * @param {string} key - The translation key to look up.
+ * @param {Record<string, string> | undefined} translations - The translation values to search.
+ */
+export function lookupTranslation(key: string, translations: Record<string, string> | undefined): string;
+/**
+ * Resolve the underlying content for a translation row from an entity.
+ * Involves using the appropriate child properties if necessary.
+ * @param {string} keyType - The translation row type being resolved.
+ * @param {ComponentDef | Page | Item} entity - The entity that may contain the content to translate.
+ * @param {string} jsonSuffix - The property name to read from the entity.
+ */
+export function drillDown(keyType: string, entity: ComponentDef | Page | Item, jsonSuffix: string): string;
+export namespace TranslationRowTypes {
+    let PageHeading: string;
+    let PageGuidance: string;
+    let RepeatTitle: string;
+    let QuestionText: string;
+    let QuestionHint: string;
+    let ShortDescription: string;
+    let ErrorDescription: string;
+    let ListItemText: string;
+    let ListItemHint: string;
+    let InstructionText: string;
+    let DeclarationBody: string;
+    let PaymentDescription: string;
+}
+export const TEXTAREA_3_ROWS: "textarea3";
+export const TEXTAREA_5_ROWS: "textarea5";
+export const TEXTAREA_12_ROWS_WITH_MARKDOWN: "textarea12markdown";
+export const LIST_ITEM_HINT: "listitemhint";
+export const LIST_ITEM_WITH_HINT_FOLLOWING: "listoptionwithhintfollowing";
+/** @type {Record<string, { jsonPrefix: string, jsonSuffix: string, displayName: string, getLabel: (pageNum: number, questionNum?: number, itemNum?: number) => string }>} */
+export const keyConfig: Record<string, {
+    jsonPrefix: string;
+    jsonSuffix: string;
+    displayName: string;
+    getLabel: (pageNum: number, questionNum?: number, itemNum?: number) => string;
+}>;
+export const IGNORE_FIELDS: ComponentType[];
+export type TranslationRow = {
+    /**
+     * - the key name
+     */
+    name: string;
+    /**
+     * - type of text
+     */
+    type?: string | undefined;
+    /**
+     * - English text
+     */
+    englishContent: string | undefined;
+    /**
+     * - Welsh text
+     */
+    welshContent: string | undefined;
+    /**
+     * - page number
+     */
+    pageNum?: number | undefined;
+    /**
+     * - question number
+     */
+    questionNum?: number | undefined;
+    /**
+     * - list item number
+     */
+    itemNum?: number | undefined;
+    /**
+     * - label for field
+     */
+    label?: string | undefined;
+};
+export type ErrorDetailsItem = {
+    text: string;
+    href?: string;
+};
+export type ErrorDetails = Record<string, ErrorDetailsItem>;
+export type ValidationFailure<Schema extends unknown = any> = {
+    /**
+     * - Formatted errors for error summary
+     */
+    formErrors: ErrorDetails;
+    /**
+     * - Form POST payload from Hapi request
+     */
+    formValues: Schema;
+};
+import type { ComponentDef } from '../../../components/types.js';
+import type { Page } from '../../../form/form-definition/types.js';
+import type { Item } from '../../../form/form-definition/types.js';
+import { ComponentType } from '../../../components/enums.js';
+//# sourceMappingURL=translations-config.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"translations-config.d.ts","sourceRoot":"","sources":["../../../../../src/form/form-editor/translations/translations-config.js"],"names":[],"mappings":"AAoIA;;;;GAIG;AACH,uCAHW,MAAM,gBACN,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,UAO5C;AAED;;;;;;GAMG;AACH,mCAJW,MAAM,UACN,YAAY,GAAG,IAAI,GAAG,IAAI,cAC1B,MAAM,UA+BhB;;;;;;;;;;;;;;;AA3ID,8BAA+B,WAAW,CAAA;AAC1C,8BAA+B,WAAW,CAAA;AAC1C,6CAA8C,oBAAoB,CAAA;AAClE,6BAA8B,cAAc,CAAA;AAC5C,4CAA6C,6BAA6B,CAAA;AAE1E,6KAA6K;AAC7K,wBADW,MAAM,CAAC,MAAM,EAAE;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,KAAK,MAAM,CAAA;CAAE,CAAC,CA4ExK;AAED,4CAKC;;;;;UA9Ha,MAAM;;;;;;;;oBAEN,MAAM,GAAG,SAAS;;;;kBAClB,MAAM,GAAG,SAAS;;;;;;;;;;;;;;;;;;+BAQnB;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE;2BAC/B,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC;8BAItB,MAAM;;;;gBAEf,YAAY;;;;gBACZ,MAAM;;kCAgKa,2BAA2B;0BAC7B,qCAAqC;0BAArC,qCAAqC;8BAxLtC,2BAA2B"}

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

@@ -0,0 +1,14 @@
+/**
+ * Build all translation rows in the form overview section (metatdata values).
+ * @param {FormMetadata} metadata
+ * @param {FormDefinition} definition
+ * @param {Record<string, string>} translations
+ * @param {ValidationFailure<any>} [validation]
+ * @returns {TranslationRow[]}
+ */
+export function buildOverviewSection(metadata: FormMetadata, definition: FormDefinition, translations: Record<string, string>, validation?: ValidationFailure<any>): TranslationRow[];
+import type { FormMetadata } from '../../../form/form-metadata/types.js';
+import type { FormDefinition } from '../../../form/form-definition/types.js';
+import type { ValidationFailure } from '../../../form/form-editor/translations/translations-config.js';
+import type { TranslationRow } from '../../../form/form-editor/translations/translations-config.js';
+//# sourceMappingURL=translations-overview.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"translations-overview.d.ts","sourceRoot":"","sources":["../../../../../src/form/form-editor/translations/translations-overview.js"],"names":[],"mappings":"AAuBA;;;;;;;GAOG;AACH,+CANW,YAAY,cACZ,cAAc,gBACd,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,eACtB,kBAAkB,GAAG,CAAC,GACpB,cAAc,EAAE,CAqG5B;kCAGgC,mCAAmC;oCACjC,qCAAqC;uCACnB,4DAA4D;oCAA5D,4DAA4D"}

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

@@ -0,0 +1,16 @@
+/**
+ * Build the overview and form translation rows for a form definition.
+ * @param {FormMetadata} metadata - The form metadata used to build the overview section.
+ * @param {FormDefinition} definition - The form definition containing pages and components.
+ * @param {ValidationFailure<any>} [validation] - Optional validation context for posted form values.
+ * @returns {{ overviewRows: TranslationRow[], formRows: TranslationRow[] }} The generated overview and form translation rows.
+ */
+export function buildTranslationDataRows(metadata: FormMetadata, definition: FormDefinition, validation?: ValidationFailure<any>): {
+    overviewRows: TranslationRow[];
+    formRows: TranslationRow[];
+};
+import type { FormMetadata } from '../../../form/form-metadata/types.js';
+import type { FormDefinition } from '../../../form/form-definition/types.js';
+import type { ValidationFailure } from '../../../form/form-editor/translations/translations-config.js';
+import type { TranslationRow } from '../../../form/form-editor/translations/translations-config.js';
+//# sourceMappingURL=translations.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"translations.d.ts","sourceRoot":"","sources":["../../../../../src/form/form-editor/translations/translations.js"],"names":[],"mappings":"AA0OA;;;;;;GAMG;AACH,mDALW,YAAY,cACZ,cAAc,eACd,kBAAkB,GAAG,CAAC,GACpB;IAAE,YAAY,EAAE,cAAc,EAAE,CAAC;IAAC,QAAQ,EAAE,cAAc,EAAE,CAAA;CAAE,CAkD1E;kCAIgC,mCAAmC;oCACrB,qCAAqC;uCAC9B,4DAA4D;oCAA5D,4DAA4D"}

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/form/form-submission/index.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAA;AAUrB,OAAO,EACL,KAAK,kBAAkB,EACvB,KAAK,sBAAsB,EAC3B,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,eAAe,EACrB,MAAM,qCAAqC,CAAA;AAE5C;;;GAGG;AACH,eAAO,MAAM,sBAAsB,gCAa0B,CAAA;AAE7D;;;GAGG;AACH,eAAO,MAAM,yBAAyB,mCAoByC,CAAA;AAE/E;;;GAGG;AACH,eAAO,MAAM,uBAAuB,iCAwB2C,CAAA;AAE/E,eAAO,MAAM,sBAAsB,0CAmBD,CAAA;AAElC,eAAO,MAAM,uBAAuB,sCA2BlC,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/form/form-submission/index.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAA;AAUrB,OAAO,EACL,KAAK,kBAAkB,EACvB,KAAK,sBAAsB,EAC3B,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,eAAe,EACrB,MAAM,qCAAqC,CAAA;AAE5C;;;GAGG;AACH,eAAO,MAAM,sBAAsB,gCAa0B,CAAA;AAE7D;;;GAGG;AACH,eAAO,MAAM,yBAAyB,mCAoByC,CAAA;AAE/E;;;GAGG;AACH,eAAO,MAAM,uBAAuB,iCA+B2C,CAAA;AAE/E,eAAO,MAAM,sBAAsB,0CAmBD,CAAA;AAElC,eAAO,MAAM,uBAAuB,sCA2BlC,CAAA"}

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

@@ -53,6 +53,10 @@ export interface SubmitPayload {
      * The reference number of the user session
      */
     referenceNumber?: string;
+    /**
+     * The currently-selected language at the point of submission
+     */
+    language?: string;
     /**
      * The main form anwsers
      */

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/form/form-submission/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,EACL,KAAK,qBAAqB,EAC1B,KAAK,8BAA8B,EACnC,KAAK,mCAAmC,EACxC,KAAK,4BAA4B,EACjC,KAAK,0BAA0B,EAChC,MAAM,qCAAqC,CAAA;AAO5C;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,KAAK,EAAE,YAAY,EAAE,EAAE,CAAA;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,IAAI,EAAE,YAAY,EAAE,CAAA;IAEpB;;OAEG;IACH,SAAS,EAAE,eAAe,EAAE,CAAA;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE;QACN,KAAK,EAAE;YACL,IAAI,EAAE,MAAM,CAAA;YACZ,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;SAClC,CAAA;KACF,CAAA;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,IAAI,EAAE;QACJ,EAAE,EAAE,MAAM,CAAA;QACV,KAAK,EAAE,MAAM,CAAA;QACb,MAAM,EAAE,UAAU,CAAA;QAClB,SAAS,EAAE,OAAO,CAAA;QAClB,OAAO,EAAE,MAAM,CAAA;KAChB,CAAA;IACD,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE;QACR,QAAQ,EAAE,qBAAqB,CAAA;QAC/B,MAAM,EAAE,MAAM,CAAA;KACf,CAAA;IACD,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,kBAAkB;IACjC,aAAa,EAAE,mCAAmC,CAAA;IAClD,MAAM,EAAE,4BAA4B,CAAA;IACpC,SAAS,EAAE,IAAI,CAAA;IACf,gBAAgB,EAAE,IAAI,CAAA;IACtB,QAAQ,EAAE,8BAA8B,CAAC,MAAM,CAAA;IAC/C,IAAI,EAAE,0BAA0B,CAAC,oBAAoB,CAAA;IACrD,IAAI,EAAE,sBAAsB,CAAA;CAC7B;AAED,MAAM,WAAW,iBAAiB;IAChC,WAAW,EAAE,MAAM,CAAA;IACnB,gBAAgB,EAAE,MAAM,CAAA;IACxB,IAAI,EAAE;QACJ,EAAE,EAAE,MAAM,CAAA;QACV,MAAM,EAAE,UAAU,CAAA;QAClB,SAAS,EAAE,OAAO,CAAA;QAClB,OAAO,EAAE,MAAM,CAAA;KAChB,CAAA;IACD,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE;QACR,QAAQ,EAAE,qBAAqB,CAAA;QAC/B,MAAM,EAAE,MAAM,CAAA;KACf,CAAA;IACD,KAAK,EAAE,MAAM,CAAA;IACb,uBAAuB,EAAE,MAAM,CAAA;IAC/B,SAAS,EAAE,IAAI,CAAA;CAChB;AAED,MAAM,MAAM,aAAa,GAAG,kBAAkB,CAAA;AAE9C,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,MAAM,CAAA;IACjB,eAAe,EAAE,IAAI,CAAA;CACtB;AAED,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC7D,EAAE,EAAE,MAAM,CAAA;CACX;AAED,MAAM,MAAM,iBAAiB,GAAG,aAAa,GAAG,gBAAgB,CAAA;AAEhE,MAAM,MAAM,YAAY,GAAG,aAAa,GAAG,qBAAqB,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/form/form-submission/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,EACL,KAAK,qBAAqB,EAC1B,KAAK,8BAA8B,EACnC,KAAK,mCAAmC,EACxC,KAAK,4BAA4B,EACjC,KAAK,0BAA0B,EAChC,MAAM,qCAAqC,CAAA;AAO5C;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,KAAK,EAAE,YAAY,EAAE,EAAE,CAAA;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,IAAI,EAAE,YAAY,EAAE,CAAA;IAEpB;;OAEG;IACH,SAAS,EAAE,eAAe,EAAE,CAAA;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE;QACN,KAAK,EAAE;YACL,IAAI,EAAE,MAAM,CAAA;YACZ,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;SAClC,CAAA;KACF,CAAA;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,IAAI,EAAE;QACJ,EAAE,EAAE,MAAM,CAAA;QACV,KAAK,EAAE,MAAM,CAAA;QACb,MAAM,EAAE,UAAU,CAAA;QAClB,SAAS,EAAE,OAAO,CAAA;QAClB,OAAO,EAAE,MAAM,CAAA;KAChB,CAAA;IACD,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE;QACR,QAAQ,EAAE,qBAAqB,CAAA;QAC/B,MAAM,EAAE,MAAM,CAAA;KACf,CAAA;IACD,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,kBAAkB;IACjC,aAAa,EAAE,mCAAmC,CAAA;IAClD,MAAM,EAAE,4BAA4B,CAAA;IACpC,SAAS,EAAE,IAAI,CAAA;IACf,gBAAgB,EAAE,IAAI,CAAA;IACtB,QAAQ,EAAE,8BAA8B,CAAC,MAAM,CAAA;IAC/C,IAAI,EAAE,0BAA0B,CAAC,oBAAoB,CAAA;IACrD,IAAI,EAAE,sBAAsB,CAAA;CAC7B;AAED,MAAM,WAAW,iBAAiB;IAChC,WAAW,EAAE,MAAM,CAAA;IACnB,gBAAgB,EAAE,MAAM,CAAA;IACxB,IAAI,EAAE;QACJ,EAAE,EAAE,MAAM,CAAA;QACV,MAAM,EAAE,UAAU,CAAA;QAClB,SAAS,EAAE,OAAO,CAAA;QAClB,OAAO,EAAE,MAAM,CAAA;KAChB,CAAA;IACD,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE;QACR,QAAQ,EAAE,qBAAqB,CAAA;QAC/B,MAAM,EAAE,MAAM,CAAA;KACf,CAAA;IACD,KAAK,EAAE,MAAM,CAAA;IACb,uBAAuB,EAAE,MAAM,CAAA;IAC/B,SAAS,EAAE,IAAI,CAAA;CAChB;AAED,MAAM,MAAM,aAAa,GAAG,kBAAkB,CAAA;AAE9C,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,MAAM,CAAA;IACjB,eAAe,EAAE,IAAI,CAAA;CACtB;AAED,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC7D,EAAE,EAAE,MAAM,CAAA;CACX;AAED,MAAM,MAAM,iBAAiB,GAAG,aAAa,GAAG,gBAAgB,CAAA;AAEhE,MAAM,MAAM,YAAY,GAAG,aAAa,GAAG,qBAAqB,CAAA"}

package/dist/types/form/utils/list.d.ts

@@ -1,4 +1,4 @@
-import { type ListComponentsDef } from '../../components/types.js';
+import { type ComponentDef, type ListComponentsDef } from '../../components/types.js';
 import { type FormDefinition, type List } from '../../form/form-definition/types.js';
 /**
  * Given a SelectionComponent finds the associated list
@@ -7,4 +7,11 @@ import { type FormDefinition, type List } from '../../form/form-definition/types
  * @returns {List}
  */
 export declare function findDefinitionListFromComponent(selectionComponent: ListComponentsDef, definition: FormDefinition): List;
+/**
+ * Finds the list in the component, if it exists. Handles a Yes/No list which doesn't link to the list in the normal way
+ * @param { ComponentDef | undefined } component
+ * @param {FormDefinition} definition
+ * @returns { List | undefined }
+ */
+export declare function getListFromComponent(component: ComponentDef | undefined, definition: FormDefinition): List | undefined;
 //# sourceMappingURL=list.d.ts.map

package/dist/types/form/utils/list.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"list.d.ts","sourceRoot":"","sources":["../../../../src/form/utils/list.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,2BAA2B,CAAA;AAClE,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,IAAI,EACV,MAAM,qCAAqC,CAAA;AAE5C;;;;;GAKG;AACH,wBAAgB,+BAA+B,CAC7C,kBAAkB,EAAE,iBAAiB,EACrC,UAAU,EAAE,cAAc,GACzB,IAAI,CASN"}
+{"version":3,"file":"list.d.ts","sourceRoot":"","sources":["../../../../src/form/utils/list.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,iBAAiB,EACvB,MAAM,2BAA2B,CAAA;AAElC,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,IAAI,EACV,MAAM,qCAAqC,CAAA;AAE5C;;;;;GAKG;AACH,wBAAgB,+BAA+B,CAC7C,kBAAkB,EAAE,iBAAiB,EACrC,UAAU,EAAE,cAAc,GACzB,IAAI,CASN;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,SAAS,EAAE,YAAY,GAAG,SAAS,EACnC,UAAU,EAAE,cAAc,oBAiB3B"}

package/dist/types/form/utils/numbering.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @param {FormDefinition} definition
+ * @param {string} pageId
+ */
+export function getPageNum(definition: FormDefinition, pageId: string): number;
+/**
+ * @param {FormDefinition} definition
+ * @param {string} pageId
+ */
+export function getQuestionsOnPage(definition: FormDefinition, pageId: string): import("../../index.js").ComponentDef[];
+/**
+ * @param {FormDefinition} definition
+ * @param {string} pageId
+ * @param {string} questionId
+ */
+export function getQuestionNum(definition: FormDefinition, pageId: string, questionId: string): number;
+import type { FormDefinition } from '../../form/form-definition/types.js';
+//# sourceMappingURL=numbering.d.ts.map

package/dist/types/form/utils/numbering.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"numbering.d.ts","sourceRoot":"","sources":["../../../../src/form/utils/numbering.js"],"names":[],"mappings":"AAOA;;;GAGG;AACH,uCAHW,cAAc,UACd,MAAM,UAQhB;AAED;;;GAGG;AACH,+CAHW,cAAc,UACd,MAAM,2CAKhB;AAED;;;;GAIG;AACH,2CAJW,cAAc,UACd,MAAM,cACN,MAAM,UAWhB;oCAGkC,qCAAqC"}

package/dist/types/index.d.ts

@@ -19,6 +19,8 @@ export * from './form/utils/index.js';
 export * from './form/form-editor/enums.js';
 export * from './form/form-editor/index.js';
 export * from './form/form-editor/preview/index.js';
+export * from './form/form-editor/translations/translations-config.js';
+export * from './form/form-editor/translations/translations.js';
 export * from './form/form-manager/types.js';
 export * from './form/form-manager/errors.js';
 export * from './manage/dead-letter-queues.js';

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAA;AACrC,cAAc,2BAA2B,CAAA;AACzC,cAAc,wBAAwB,CAAA;AACtC,cAAc,kCAAkC,CAAA;AAChD,cAAc,8BAA8B,CAAA;AAC5C,cAAc,+BAA+B,CAAA;AAC7C,cAAc,2BAA2B,CAAA;AACzC,cAAc,2BAA2B,CAAA;AACzC,cAAc,qCAAqC,CAAA;AACnD,cAAc,qCAAqC,CAAA;AACnD,cAAc,uCAAuC,CAAA;AACrD,cAAc,mCAAmC,CAAA;AACjD,cAAc,kCAAkC,CAAA;AAChD,cAAc,kCAAkC,CAAA;AAChD,cAAc,kCAAkC,CAAA;AAChD,cAAc,qCAAqC,CAAA;AACnD,cAAc,qCAAqC,CAAA;AACnD,cAAc,2BAA2B,CAAA;AACzC,cAAc,iCAAiC,CAAA;AAC/C,cAAc,iCAAiC,CAAA;AAC/C,cAAc,yCAAyC,CAAA;AACvD,cAAc,kCAAkC,CAAA;AAChD,cAAc,mCAAmC,CAAA;AACjD,cAAc,oCAAoC,CAAA;AAClD,cAAc,uBAAuB,CAAA;AACrC,cAAc,uBAAuB,CAAA;AACrC,cAAc,sBAAsB,CAAA;AACpC,cAAc,wBAAwB,CAAA;AACtC,cAAc,yBAAyB,CAAA;AACvC,cAAc,gCAAgC,CAAA;AAC9C,cAAc,gCAAgC,CAAA;AAC9C,cAAc,wCAAwC,CAAA;AAEtD,mBAAmB,uBAAuB,CAAA;AAC1C,mBAAmB,kCAAkC,CAAA;AACrD,mBAAmB,8BAA8B,CAAA;AACjD,mBAAmB,+BAA+B,CAAA;AAClD,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,qCAAqC,CAAA;AACxD,mBAAmB,mCAAmC,CAAA;AACtD,mBAAmB,qCAAqC,CAAA;AACxD,mBAAmB,yCAAyC,CAAA;AAC5D,mBAAmB,iCAAiC,CAAA;AACpD,mBAAmB,wCAAwC,CAAA;AAC3D,mBAAmB,gCAAgC,CAAA;AACnD,mBAAmB,uBAAuB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAA;AACrC,cAAc,2BAA2B,CAAA;AACzC,cAAc,wBAAwB,CAAA;AACtC,cAAc,kCAAkC,CAAA;AAChD,cAAc,8BAA8B,CAAA;AAC5C,cAAc,+BAA+B,CAAA;AAC7C,cAAc,2BAA2B,CAAA;AACzC,cAAc,2BAA2B,CAAA;AACzC,cAAc,qCAAqC,CAAA;AACnD,cAAc,qCAAqC,CAAA;AACnD,cAAc,uCAAuC,CAAA;AACrD,cAAc,mCAAmC,CAAA;AACjD,cAAc,kCAAkC,CAAA;AAChD,cAAc,kCAAkC,CAAA;AAChD,cAAc,kCAAkC,CAAA;AAChD,cAAc,qCAAqC,CAAA;AACnD,cAAc,qCAAqC,CAAA;AACnD,cAAc,2BAA2B,CAAA;AACzC,cAAc,iCAAiC,CAAA;AAC/C,cAAc,iCAAiC,CAAA;AAC/C,cAAc,yCAAyC,CAAA;AACvD,cAAc,4DAA4D,CAAA;AAC1E,cAAc,qDAAqD,CAAA;AACnE,cAAc,kCAAkC,CAAA;AAChD,cAAc,mCAAmC,CAAA;AACjD,cAAc,oCAAoC,CAAA;AAClD,cAAc,uBAAuB,CAAA;AACrC,cAAc,uBAAuB,CAAA;AACrC,cAAc,sBAAsB,CAAA;AACpC,cAAc,wBAAwB,CAAA;AACtC,cAAc,yBAAyB,CAAA;AACvC,cAAc,gCAAgC,CAAA;AAC9C,cAAc,gCAAgC,CAAA;AAC9C,cAAc,wCAAwC,CAAA;AAEtD,mBAAmB,uBAAuB,CAAA;AAC1C,mBAAmB,kCAAkC,CAAA;AACrD,mBAAmB,8BAA8B,CAAA;AACjD,mBAAmB,+BAA+B,CAAA;AAClD,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,qCAAqC,CAAA;AACxD,mBAAmB,mCAAmC,CAAA;AACtD,mBAAmB,qCAAqC,CAAA;AACxD,mBAAmB,yCAAyC,CAAA;AAC5D,mBAAmB,iCAAiC,CAAA;AACpD,mBAAmB,wCAAwC,CAAA;AAC3D,mBAAmB,gCAAgC,CAAA;AACnD,mBAAmB,uBAAuB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-model",
-  "version": "3.0.687",
+  "version": "3.0.689",
   "description": "A hapi plugin providing the model for Defra forms",
   "homepage": "https://github.com/DEFRA/forms-designer/tree/main/model#readme",
   "types": "dist/types/index.d.ts",

package/schemas/form-submit-payload-schema.json

@@ -17,6 +17,11 @@
       "description": "Reference number for the form submission",
       "title": "Reference Number"
     },
+    "language": {
+      "type": "string",
+      "description": "The currently-selected language at point of form submission",
+      "title": "Language"
+    },
     "main": {
       "type": "array",
       "description": "Main (non-repeating) field values from the form",

package/src/__stubs__/examples.js

@@ -0,0 +1,231 @@
+import {
+  buildDeclarationFieldComponent,
+  buildLatLongFieldComponent,
+  buildMarkdownComponent,
+  buildRadiosComponent,
+  buildTextFieldComponent
+} from '~/src/__stubs__/components.js'
+import { buildDefinition } from '~/src/__stubs__/form-definition.js'
+import {
+  buildQuestionPage,
+  buildRepeaterPage,
+  buildSummaryPage
+} from '~/src/__stubs__/pages.js'
+
+export const formDefinitionWithSinglePage = buildDefinition({
+  pages: [
+    buildQuestionPage({
+      id: 'p1',
+      section: 'section',
+      components: [
+        buildTextFieldComponent({
+          id: 'c1',
+          name: 'textField',
+          title: 'This is your first field',
+          hint: 'Help text'
+        })
+      ],
+      next: [{ path: '/summary' }]
+    }),
+    buildSummaryPage({
+      id: 'c2'
+    })
+  ]
+})
+
+export const formDefinitionWithoutSummary = buildDefinition({
+  pages: [
+    buildQuestionPage({
+      id: 'p1',
+      section: 'section',
+      components: [
+        buildTextFieldComponent({
+          id: 'c1',
+          name: 'textField',
+          title: 'This is your first field',
+          hint: 'Help text'
+        })
+      ],
+      next: [{ path: '/summary' }]
+    })
+  ]
+})
+
+export const formDefinitionWithTwoQuestions = buildDefinition({
+  pages: [
+    buildQuestionPage({
+      id: 'p1',
+      section: 'section',
+      components: [
+        buildTextFieldComponent({
+          id: 'q1',
+          name: 'textField',
+          title: 'This is your first question',
+          hint: 'Help text'
+        }),
+        buildTextFieldComponent({
+          id: 'q2',
+          name: 'textField',
+          title: 'This is your second question',
+          hint: 'Help text'
+        })
+      ],
+      next: [{ path: '/summary' }]
+    }),
+    buildSummaryPage({
+      id: 'p2'
+    })
+  ]
+})
+
+export const formDefinitionWithTwoQuestionsAndGuidance = buildDefinition({
+  pages: [
+    buildQuestionPage({
+      id: 'p1',
+      section: 'section',
+      components: [
+        buildMarkdownComponent({ content: 'My markdown text' }),
+        buildTextFieldComponent({
+          id: 'q1',
+          name: 'textField',
+          title: 'This is the first textfield question',
+          hint: 'Help text'
+        }),
+        buildTextFieldComponent({
+          id: 'q2',
+          name: 'textField',
+          title: 'This is the second textfield question',
+          hint: 'Help text'
+        })
+      ],
+      next: [{ path: '/summary' }]
+    }),
+    buildSummaryPage({
+      id: 'p2'
+    })
+  ]
+})
+
+export const formDefinitionWithLocationAndDeclaration = buildDefinition({
+  pages: [
+    buildQuestionPage({
+      id: 'p1',
+      section: 'section',
+      components: [
+        buildLatLongFieldComponent({
+          id: 'q1',
+          name: 'latLongField',
+          title: 'This is the first lat long field question',
+          hint: 'Hint text',
+          options: {
+            instructionText: 'Some instruction text'
+          }
+        }),
+        buildDeclarationFieldComponent({
+          id: 'q2',
+          name: 'declarationField',
+          title: 'This is a declaration question',
+          hint: 'Declaration hint text',
+          content: 'This is the declaration that needs agreeing to',
+          shortDescription: 'Declaration short desc'
+        })
+      ],
+      next: [{ path: '/summary' }]
+    }),
+    buildSummaryPage({
+      id: 'p2'
+    })
+  ]
+})
+
+export const formDefinitionWithRepeater = buildDefinition({
+  pages: [
+    buildRepeaterPage({
+      id: 'p1',
+      section: 'section',
+      components: [
+        buildTextFieldComponent({
+          id: 'q1',
+          name: 'TextField',
+          title: 'This is the first text field field question',
+          hint: 'Hint text',
+          shortDescription: 'Short desc'
+        })
+      ],
+      next: [{ path: '/summary' }]
+    }),
+    buildSummaryPage({
+      id: 'p2'
+    })
+  ]
+})
+
+export const formDefinitionWithNoQuestions = buildDefinition({
+  pages: [
+    buildQuestionPage({
+      id: 'p1',
+      section: 'section',
+      components: [],
+      next: [{ path: '/summary' }]
+    }),
+    buildSummaryPage({
+      id: 'p2'
+    })
+  ]
+})
+
+export const formDefinitionWithRadioQuestion = buildDefinition({
+  pages: [
+    buildQuestionPage({
+      id: 'p1',
+      section: 'section',
+      components: [
+        buildRadiosComponent({
+          id: 'q1',
+          name: 'radioField',
+          title: 'This is a radio question',
+          hint: 'Help text',
+          list: 'my-list-id'
+        })
+      ],
+      next: [{ path: '/summary' }]
+    }),
+    buildSummaryPage({
+      id: 'p2'
+    })
+  ],
+  lists: [
+    {
+      name: 'my-list',
+      id: 'my-list-id',
+      type: 'string',
+      title: 'list for radio',
+      items: [
+        {
+          id: 'option-1',
+          text: 'Option 1',
+          hint: {
+            text: 'Option 1 hint'
+          },
+          value: 'Option1'
+        },
+        {
+          id: 'option-2',
+          text: 'Option 2',
+          hint: {
+            text: 'Option 2 hint'
+          },
+          value: 'Option2'
+        },
+        {
+          id: 'option-3',
+          text: 'Option 3',
+          hint: {
+            text: 'Option 3 hint'
+          },
+          value: 'Option3'
+        }
+      ]
+    }
+  ]
+})

package/src/components/helpers.ts

@@ -2,6 +2,7 @@ import { ComponentTypes } from '~/src/components/component-types.js'
 import { ComponentType } from '~/src/components/enums.js'
 import {
   type ComponentDef,
+  type ComponentsDefWithInstructions,
   type ConditionalComponentType,
   type ConditionalComponentsDef,
   type ContentComponentsDef,
@@ -145,6 +146,19 @@ export function isListType(
   return !!type && allowedTypes.includes(type)
 }
 
+export function isTypeWithInstructions(
+  type?: ComponentType
+): type is ComponentsDefWithInstructions['type'] {
+  const allowedTypes = [
+    ComponentType.EastingNorthingField,
+    ComponentType.OsGridRefField,
+    ComponentType.NationalGridFieldNumberField,
+    ComponentType.LatLongField
+  ]
+
+  return !!type && allowedTypes.includes(type)
+}
+
 /**
  * Filter known form components with input fields
  * (excludes content and selection fields)

package/src/components/types.ts

@@ -443,6 +443,13 @@ export type SelectionComponentsDef =
   | SelectFieldComponent
   | YesNoFieldComponent
 
+// Components that have instruction fields
+export type ComponentsDefWithInstructions =
+  | EastingNorthingFieldComponent
+  | OsGridRefFieldComponent
+  | NationalGridFieldNumberFieldComponent
+  | LatLongFieldComponent
+
 // Components that have condition support
 export type ConditionalComponentsDef = Exclude<
   ComponentDef,