@defra/forms-model 3.0.710 → 3.0.713

package/README.md

@@ -138,13 +138,53 @@ Available schema files include:
 
 ##### Common Schemas
 
-- `search-options-schema.json` - Search options validation
-- `query-options-schema.json` - Query options validation
+- `search-options-schema-ui.json` - Search options validation (forms-designer)
+- `search-options-schema-manager.json` - Search options validation (forms-manager)
+- `query-options-schema-ui.json` - Query options validation (forms-designer)
+- `query-options-schema-manager.json` - Query options validation (forms-manager)
 - `pagination-options-schema.json` - Pagination options validation
 - `sorting-options-schema.json` - Sorting options validation
 
 ## Development
 
+This package was previously developed as the `model` workspace of [forms-designer](https://github.com/DEFRA/forms-designer).
+
+### Setup
+
+```shell
+nvm use
+npm install
+npm run build
+```
+
+### Common commands
+
+| Command          | Description                                                      |
+| ---------------- | ---------------------------------------------------------------- |
+| `npm run build`  | Build the type declarations, JavaScript modules and JSON schemas |
+| `npm run lint`   | Run EditorConfig, ESLint and TypeScript checks                   |
+| `npm run format` | Format files with Prettier                                       |
+| `npm test`       | Run the unit tests with coverage                                 |
+
+### Testing changes in a consuming service
+
+To test unpublished changes in a consuming service (for example forms-designer), build this package and link it:
+
+```shell
+# In forms-model
+npm run build
+npm link
+
+# In the consuming service
+npm link @defra/forms-model
+```
+
+Run `npm run build` in forms-model after each change so that the consuming service picks up the new `dist` output. Run `npm unlink @defra/forms-model && npm install` in the consuming service to return to the published version.
+
+### Publishing
+
+Merging to `main` with changes to `src/`, `scripts/`, `babel.config.*` or `.browserslistrc` runs the [Publish](.github/workflows/publish.yml) workflow, which increments the patch version and publishes the package to npm.
+
 ### Test Coverage
 
 Unit test coverage threshold, code coverage below which build will fail is set by using jest config, at the moment line coverage threshold is set as 92%, see [jest.config.js](jest.config.js)

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

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":[],"sources":["../../../../src/form/form-submission/types.ts"],"sourcesContent":["import { type FormStatus } from '~/src/common/enums.js'\nimport {\n  type ConditionEvaluationOutcome,\n  type SecurityQuestionsEnum,\n  type SubmissionEventMessageCategory,\n  type SubmissionEventMessageSchemaVersion,\n  type SubmissionEventMessageSource,\n  type SubmissionEventMessageType\n} from '~/src/form/form-submission/enums.js'\nimport {\n  formSubmitConditionEvaluationSchema,\n  formSubmitConditionReferenceSchema,\n  formSubmitPayloadSchema,\n  formSubmitRecordSchema,\n  formSubmitRecordsetSchema\n} from '~/src/form/form-submission/index.js'\n\n/**\n * Interface for an individual submit record\n * @see {@link formSubmitRecordSchema}\n */\nexport interface SubmitRecord {\n  /**\n   * The field name\n   */\n  name: string\n\n  /**\n   * The field title\n   */\n  title: string\n\n  /**\n   * The field display value\n   */\n  value: string\n}\n\n/**\n * Interface for an individual submit recordset (e.g. a repeater question set)\n * @see {@link formSubmitRecordsetSchema}\n */\nexport interface SubmitRecordset {\n  /**\n   * The name of the recordset\n   */\n  name: string\n\n  /**\n   * The title of the recordset\n   */\n  title: string\n\n  /**\n   * The record items\n   */\n  value: SubmitRecord[][]\n}\n\n/**\n * A component referenced by a condition, and whether the user had answered it\n * when the condition was evaluated.\n *\n * An unanswered question is not absent from the runner's evaluation context -\n * it is present as `null` - so conditions still return a boolean for questions\n * that were skipped or never reached. Negative operators (\"is not\", \"is shorter\n * than\") return `true` in that case. Without knowing which referenced questions\n * were answered, a consumer cannot tell a real match from a vacuous one.\n * @see {@link formSubmitConditionReferenceSchema}\n */\nexport interface SubmitConditionReference {\n  /**\n   * The id of the referenced component\n   */\n  componentId: string\n\n  /**\n   * The name of the referenced component, as used in the submitted records\n   */\n  componentName: string\n\n  /**\n   * Whether the referenced component held an answer at the point of evaluation\n   */\n  answered: boolean\n}\n\n/**\n * The recorded outcome of a single condition at the point of submission.\n * V2 forms only - V1 conditions are not captured.\n * @see {@link formSubmitConditionEvaluationSchema}\n */\nexport interface SubmitConditionEvaluation {\n  /**\n   * The id of the condition, as authored in the V2 form definition\n   */\n  conditionId: string\n\n  /**\n   * The result of evaluating the condition\n   */\n  outcome: ConditionEvaluationOutcome\n\n  /**\n   * Every component the condition depends on, including those reached through\n   * nested condition references, and whether each was answered\n   */\n  references: SubmitConditionReference[]\n}\n\n/**\n * Interface for the submission-api `/submit` payload\n * @see {@link formSubmitPayloadSchema}\n */\nexport interface SubmitPayload {\n  /**\n   * The retrieval key for files created in the submission\n   */\n  retrievalKey: string\n\n  /**\n   * The id of the user session\n   */\n  sessionId: string\n\n  /**\n   * The reference number of the user session\n   */\n  referenceNumber?: string\n\n  /**\n   * The currently-selected language at the point of submission\n   */\n  language?: string\n\n  /**\n   * The main form anwsers\n   */\n  main: SubmitRecord[]\n\n  /**\n   * The repeaters form answers\n   */\n  repeaters: SubmitRecordset[]\n}\n\n/**\n * Interface for the submission-api `/submit` response payload\n */\nexport interface SubmitResponsePayload {\n  message: string\n  result: {\n    files: {\n      main: string\n      repeaters: Record<string, string>\n    }\n  }\n}\n\nexport interface SaveAndExitMessageData {\n  magicLinkGroupId?: string\n  form: {\n    id: string\n    title: string\n    status: FormStatus\n    isPreview: boolean\n    baseUrl: string\n  }\n  email: string\n  security: {\n    question: SecurityQuestionsEnum\n    answer: string\n  }\n  state: object\n}\n\nexport interface SaveAndExitV2MessageData {\n  magicLinkGroupId?: string\n  form: {\n    id: string\n    title: string\n    status: FormStatus\n    isPreview: boolean\n    baseUrl: string\n  }\n  email: string\n  auth: {\n    sub: string\n    issuer: string\n  }\n  state: object\n}\n\nexport interface SaveAndExitMessage {\n  schemaVersion: SubmissionEventMessageSchemaVersion\n  source: SubmissionEventMessageSource\n  createdAt: Date\n  messageCreatedAt: Date\n  category: SubmissionEventMessageCategory.RUNNER\n  type:\n    | SubmissionEventMessageType.RUNNER_SAVE_AND_EXIT\n    | SubmissionEventMessageType.RUNNER_SAVE_AND_EXIT_V2\n  data: SaveAndExitMessageData\n}\n\nexport interface SaveAndExitV2Message {\n  schemaVersion: SubmissionEventMessageSchemaVersion\n  source: SubmissionEventMessageSource\n  createdAt: Date\n  messageCreatedAt: Date\n  category: SubmissionEventMessageCategory.RUNNER\n  type: SubmissionEventMessageType.RUNNER_SAVE_AND_EXIT_V2\n  data: SaveAndExitV2MessageData\n}\n\nexport interface SavedState {\n  $$__referenceNumber: string\n  [key: string]: any\n}\n\nexport interface SaveAndExitRecord {\n  magicLinkId: string\n  magicLinkGroupId?: string\n  form: {\n    id: string\n    status: FormStatus\n    isPreview: boolean\n    baseUrl: string\n  }\n  email: string\n  security: {\n    question: SecurityQuestionsEnum\n    answer: string\n  }\n  state: object\n  invalidPasswordAttempts: number\n  createdAt: Date\n}\n\nexport interface SaveAndExitV2Record {\n  magicLinkId: string\n  magicLinkGroupId?: string\n  form: {\n    id: string\n    status: FormStatus\n    isPreview: boolean\n    baseUrl: string\n  }\n  email: string\n  auth: {\n    sub: string\n    issuer: string\n  }\n  state: SavedState\n  createdAt: Date\n}\n\nexport type RunnerMessage = SaveAndExitMessage\n\nexport interface RunnerRecordBase {\n  messageId: string\n  recordCreatedAt: Date\n}\n\nexport interface RunnerRecordInputMeta extends RunnerRecordBase {\n  id: string\n}\n\nexport type RunnerRecordInput = RunnerMessage & RunnerRecordBase\n\nexport type RunnerRecord = RunnerMessage & RunnerRecordInputMeta\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"types.js","names":[],"sources":["../../../../src/form/form-submission/types.ts"],"sourcesContent":["import { type FormStatus } from '~/src/common/enums.js'\nimport {\n  type ConditionEvaluationOutcome,\n  type SecurityQuestionsEnum,\n  type SubmissionEventMessageCategory,\n  type SubmissionEventMessageSchemaVersion,\n  type SubmissionEventMessageSource,\n  type SubmissionEventMessageType\n} from '~/src/form/form-submission/enums.js'\nimport {\n  formSubmitConditionEvaluationSchema,\n  formSubmitConditionReferenceSchema,\n  formSubmitPayloadSchema,\n  formSubmitRecordSchema,\n  formSubmitRecordsetSchema\n} from '~/src/form/form-submission/index.js'\n\n/**\n * Interface for an individual submit record\n * @see {@link formSubmitRecordSchema}\n */\nexport interface SubmitRecord {\n  /**\n   * The field name\n   */\n  name: string\n\n  /**\n   * The field title\n   */\n  title: string\n\n  /**\n   * The field display value\n   */\n  value: string\n}\n\n/**\n * Interface for an individual submit recordset (e.g. a repeater question set)\n * @see {@link formSubmitRecordsetSchema}\n */\nexport interface SubmitRecordset {\n  /**\n   * The name of the recordset\n   */\n  name: string\n\n  /**\n   * The title of the recordset\n   */\n  title: string\n\n  /**\n   * The record items\n   */\n  value: SubmitRecord[][]\n}\n\n/**\n * A component referenced by a condition, and whether the user had answered it\n * when the condition was evaluated.\n *\n * An unanswered question is not absent from the runner's evaluation context -\n * it is present as `null` - so conditions still return a boolean for questions\n * that were skipped or never reached. Negative operators (\"is not\", \"is shorter\n * than\") return `true` in that case. Without knowing which referenced questions\n * were answered, a consumer cannot tell a real match from a vacuous one.\n * @see {@link formSubmitConditionReferenceSchema}\n */\nexport interface SubmitConditionReference {\n  /**\n   * The id of the referenced component\n   */\n  componentId: string\n\n  /**\n   * The name of the referenced component, as used in the submitted records\n   */\n  componentName: string\n\n  /**\n   * Whether the referenced component held an answer at the point of evaluation\n   */\n  answered: boolean\n}\n\n/**\n * The recorded outcome of a single condition at the point of submission.\n * V2 forms only - V1 conditions are not captured.\n * @see {@link formSubmitConditionEvaluationSchema}\n */\nexport interface SubmitConditionEvaluation {\n  /**\n   * The id of the condition, as authored in the V2 form definition\n   */\n  conditionId: string\n\n  /**\n   * The result of evaluating the condition\n   */\n  outcome: ConditionEvaluationOutcome\n\n  /**\n   * Every component the condition depends on, including those reached through\n   * nested condition references, and whether each was answered\n   */\n  references: SubmitConditionReference[]\n}\n\n/**\n * Interface for the submission-api `/submit` payload\n * @see {@link formSubmitPayloadSchema}\n */\nexport interface SubmitPayload {\n  /**\n   * The retrieval key for files created in the submission\n   */\n  retrievalKey: string\n\n  /**\n   * The id of the user session\n   */\n  sessionId: string\n\n  /**\n   * The reference number of the user session\n   */\n  referenceNumber?: string\n\n  /**\n   * The currently-selected language at the point of submission\n   */\n  language?: string\n\n  /**\n   * The main form anwsers\n   */\n  main: SubmitRecord[]\n\n  /**\n   * The repeaters form answers\n   */\n  repeaters: SubmitRecordset[]\n}\n\n/**\n * Interface for the submission-api `/submit` response payload\n */\nexport interface SubmitResponsePayload {\n  message: string\n  result: {\n    files: {\n      main: string\n      repeaters: Record<string, string>\n    }\n  }\n}\n\nexport interface SaveAndExitMessageData {\n  magicLinkGroupId?: string\n  form: {\n    id: string\n    title: string\n    status: FormStatus\n    isPreview: boolean\n    baseUrl: string\n  }\n  email: string\n  security: {\n    question: SecurityQuestionsEnum\n    answer: string\n  }\n  state: object\n}\n\nexport interface SavedState {\n  $$__referenceNumber: string\n  [key: string]: any\n}\n\nexport interface SaveAndExitV2MessageData {\n  magicLinkGroupId?: string\n  form: {\n    id: string\n    title: string\n    status: FormStatus\n    isPreview: boolean\n    baseUrl: string\n  }\n  email: string\n  auth: {\n    sub: string\n    issuer: string\n  }\n  state: SavedState\n}\n\nexport interface SaveAndExitMessage {\n  schemaVersion: SubmissionEventMessageSchemaVersion\n  source: SubmissionEventMessageSource\n  createdAt: Date\n  messageCreatedAt: Date\n  category: SubmissionEventMessageCategory.RUNNER\n  type:\n    | SubmissionEventMessageType.RUNNER_SAVE_AND_EXIT\n    | SubmissionEventMessageType.RUNNER_SAVE_AND_EXIT_V2\n  data: SaveAndExitMessageData\n}\n\nexport interface SaveAndExitV2Message {\n  schemaVersion: SubmissionEventMessageSchemaVersion\n  source: SubmissionEventMessageSource\n  createdAt: Date\n  messageCreatedAt: Date\n  category: SubmissionEventMessageCategory.RUNNER\n  type: SubmissionEventMessageType.RUNNER_SAVE_AND_EXIT_V2\n  data: SaveAndExitV2MessageData\n}\n\nexport interface SaveAndExitRecord {\n  magicLinkId: string\n  magicLinkGroupId?: string\n  form: {\n    id: string\n    status: FormStatus\n    isPreview: boolean\n    baseUrl: string\n  }\n  email: string\n  security: {\n    question: SecurityQuestionsEnum\n    answer: string\n  }\n  state: object\n  invalidPasswordAttempts: number\n  createdAt: Date\n}\n\nexport interface SaveAndExitV2Record {\n  magicLinkId: string\n  magicLinkGroupId?: string\n  form: {\n    id: string\n    status: FormStatus\n    isPreview: boolean\n    baseUrl: string\n  }\n  email: string\n  auth: {\n    sub: string\n    issuer: string\n  }\n  state: SavedState\n  createdAt: Date\n}\n\nexport type RunnerMessage = SaveAndExitMessage\n\nexport interface RunnerRecordBase {\n  messageId: string\n  recordCreatedAt: Date\n}\n\nexport interface RunnerRecordInputMeta extends RunnerRecordBase {\n  id: string\n}\n\nexport type RunnerRecordInput = RunnerMessage & RunnerRecordBase\n\nexport type RunnerRecord = RunnerMessage & RunnerRecordInputMeta\n"],"mappings":"","ignoreList":[]}

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

@@ -139,6 +139,10 @@ export interface SaveAndExitMessageData {
     };
     state: object;
 }
+export interface SavedState {
+    $$__referenceNumber: string;
+    [key: string]: any;
+}
 export interface SaveAndExitV2MessageData {
     magicLinkGroupId?: string;
     form: {
@@ -153,7 +157,7 @@ export interface SaveAndExitV2MessageData {
         sub: string;
         issuer: string;
     };
-    state: object;
+    state: SavedState;
 }
 export interface SaveAndExitMessage {
     schemaVersion: SubmissionEventMessageSchemaVersion;
@@ -173,10 +177,6 @@ export interface SaveAndExitV2Message {
     type: SubmissionEventMessageType.RUNNER_SAVE_AND_EXIT_V2;
     data: SaveAndExitV2MessageData;
 }
-export interface SavedState {
-    $$__referenceNumber: string;
-    [key: string]: any;
-}
 export interface SaveAndExitRecord {
     magicLinkId: string;
     magicLinkGroupId?: string;

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,0BAA0B,EAC/B,KAAK,qBAAqB,EAC1B,KAAK,8BAA8B,EACnC,KAAK,mCAAmC,EACxC,KAAK,4BAA4B,EACjC,KAAK,0BAA0B,EAChC,MAAM,qCAAqC,CAAA;AAS5C;;;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;;;;;;;;;;GAUG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAA;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,OAAO,EAAE,0BAA0B,CAAA;IAEnC;;;OAGG;IACH,UAAU,EAAE,wBAAwB,EAAE,CAAA;CACvC;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,wBAAwB;IACvC,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,IAAI,EAAE;QACJ,GAAG,EAAE,MAAM,CAAA;QACX,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,EACA,0BAA0B,CAAC,oBAAoB,GAC/C,0BAA0B,CAAC,uBAAuB,CAAA;IACtD,IAAI,EAAE,sBAAsB,CAAA;CAC7B;AAED,MAAM,WAAW,oBAAoB;IACnC,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,uBAAuB,CAAA;IACxD,IAAI,EAAE,wBAAwB,CAAA;CAC/B;AAED,MAAM,WAAW,UAAU;IACzB,mBAAmB,EAAE,MAAM,CAAA;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CACnB;AAED,MAAM,WAAW,iBAAiB;IAChC,WAAW,EAAE,MAAM,CAAA;IACnB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,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,WAAW,mBAAmB;IAClC,WAAW,EAAE,MAAM,CAAA;IACnB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,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,IAAI,EAAE;QACJ,GAAG,EAAE,MAAM,CAAA;QACX,MAAM,EAAE,MAAM,CAAA;KACf,CAAA;IACD,KAAK,EAAE,UAAU,CAAA;IACjB,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,0BAA0B,EAC/B,KAAK,qBAAqB,EAC1B,KAAK,8BAA8B,EACnC,KAAK,mCAAmC,EACxC,KAAK,4BAA4B,EACjC,KAAK,0BAA0B,EAChC,MAAM,qCAAqC,CAAA;AAS5C;;;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;;;;;;;;;;GAUG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAA;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,OAAO,EAAE,0BAA0B,CAAA;IAEnC;;;OAGG;IACH,UAAU,EAAE,wBAAwB,EAAE,CAAA;CACvC;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,UAAU;IACzB,mBAAmB,EAAE,MAAM,CAAA;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CACnB;AAED,MAAM,WAAW,wBAAwB;IACvC,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,IAAI,EAAE;QACJ,GAAG,EAAE,MAAM,CAAA;QACX,MAAM,EAAE,MAAM,CAAA;KACf,CAAA;IACD,KAAK,EAAE,UAAU,CAAA;CAClB;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,EACA,0BAA0B,CAAC,oBAAoB,GAC/C,0BAA0B,CAAC,uBAAuB,CAAA;IACtD,IAAI,EAAE,sBAAsB,CAAA;CAC7B;AAED,MAAM,WAAW,oBAAoB;IACnC,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,uBAAuB,CAAA;IACxD,IAAI,EAAE,wBAAwB,CAAA;CAC/B;AAED,MAAM,WAAW,iBAAiB;IAChC,WAAW,EAAE,MAAM,CAAA;IACnB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,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,WAAW,mBAAmB;IAClC,WAAW,EAAE,MAAM,CAAA;IACnB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,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,IAAI,EAAE;QACJ,GAAG,EAAE,MAAM,CAAA;QACX,MAAM,EAAE,MAAM,CAAA;KACf,CAAA;IACD,KAAK,EAAE,UAAU,CAAA;IACjB,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/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@defra/forms-model",
-  "version": "3.0.710",
+  "version": "3.0.713",
   "description": "A hapi plugin providing the model for Defra forms",
-  "homepage": "https://github.com/DEFRA/forms-designer/tree/main/model#readme",
+  "homepage": "https://github.com/DEFRA/forms-model#readme",
   "types": "dist/types/index.d.ts",
   "main": "dist/module/index.js",
   "exports": {
@@ -19,8 +19,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/DEFRA/forms-designer.git",
-    "directory": "model"
+    "url": "git+https://github.com/DEFRA/forms-model.git"
   },
   "license": "OGL-UK-3.0",
   "sideEffects": false,
@@ -30,7 +29,16 @@
     "build:node": "babel --delete-dir-on-start --extensions \".ts,.js\" --ignore \"**/*.test.*\" --copy-files --no-copy-ignored --source-maps --out-dir ./dist/module ./src",
     "build:types": "tsc --build --force tsconfig.build.json && tsc-alias --project tsconfig.build.json",
     "build:schemas": "node scripts/generate-schemas.js",
+    "format": "npm run format:check -- --write",
+    "format:check": "prettier --cache --cache-location .cache/prettier --cache-strategy content --check \"**/*.{cjs,js,json,md,mjs,ts}\"",
+    "lint": "npm run lint:editorconfig && npm run lint:js && npm run lint:types",
+    "lint:editorconfig": "editorconfig-checker",
+    "lint:fix": "npm run lint:js -- --fix",
+    "lint:js": "eslint --cache --cache-location .cache/eslint --cache-strategy content --color .",
+    "lint:types": "tsc --build tsconfig.json",
+    "prepare": "husky || true",
     "test": "jest --color --coverage --verbose",
+    "test:changed": "jest --coverage --changedSince=origin/main --coverageReporters=text",
     "test:watch": "jest --color --watch"
   },
   "dependencies": {
@@ -41,10 +49,34 @@
     "uuid": "^11.1.0"
   },
   "devDependencies": {
+    "@babel/cli": "^7.29.7",
+    "@babel/core": "^7.29.7",
+    "@babel/preset-env": "^7.29.7",
+    "@babel/preset-typescript": "^7.29.7",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^25.9.1",
     "@types/slug": "^5.0.9",
+    "@typescript-eslint/eslint-plugin": "^8.34.0",
+    "@typescript-eslint/parser": "^8.27.0",
+    "babel-plugin-module-resolver": "^5.0.3",
+    "babel-plugin-replace-import-extension": "^1.1.5",
+    "babel-plugin-transform-import-meta": "^2.3.3",
+    "editorconfig-checker": "^6.2.0",
+    "eslint": "^9.39.3",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-jest": "^29.15.2",
+    "eslint-plugin-jsdoc": "^63.0.1",
+    "globals": "^17.6.0",
+    "husky": "^9.1.7",
+    "jest": "^29.7.0",
     "joi": "^17.13.4",
     "joi-to-json": "^4.3.2",
-    "tsc-alias": "^1.8.11"
+    "lint-staged": "^17.0.7",
+    "neostandard": "^0.12.2",
+    "prettier": "^3.8.3",
+    "tsc-alias": "^1.8.11",
+    "typescript": "^5.8.2",
+    "typescript-eslint": "^8.56.1"
   },
   "peerDependencies": {
     "joi": "^17.0.0"
@@ -52,5 +84,8 @@
   "engines": {
     "node": "^24.19.0",
     "npm": "^11.17.0 || >=12.0.2"
+  },
+  "allowScripts": {
+    "unrs-resolver": true
   }
 }

package/schemas/query-options-schema-manager.json

@@ -0,0 +1,99 @@
+{
+  "type": "object",
+  "properties": {
+    "page": {
+      "type": "number",
+      "description": "Current page number, starting from 1",
+      "default": 1,
+      "exclusiveMinimum": 0,
+      "minimum": 1,
+      "title": "Page"
+    },
+    "perPage": {
+      "type": "number",
+      "description": "Number of items to display per page, between 1 and 200",
+      "default": 24,
+      "exclusiveMinimum": 0,
+      "minimum": 1,
+      "maximum": 200,
+      "title": "Per Page"
+    },
+    "sortBy": {
+      "type": "string",
+      "description": "Field to sort results by",
+      "enum": [
+        "updatedAt",
+        "title"
+      ],
+      "title": "Sort By"
+    },
+    "order": {
+      "type": "string",
+      "description": "Sort order (ascending or descending)",
+      "enum": [
+        "asc",
+        "desc"
+      ],
+      "title": "Order"
+    },
+    "title": {
+      "type": "string",
+      "description": "Search by form title, empty string matches all",
+      "default": "",
+      "maxLength": 255,
+      "title": "Title"
+    },
+    "author": {
+      "type": "string",
+      "description": "Search by form author, empty string matches all",
+      "default": "",
+      "maxLength": 100,
+      "title": "Author"
+    },
+    "organisations": {
+      "type": "array",
+      "description": "Filter by organisation(s), empty array matches all",
+      "default": [],
+      "items": {
+        "type": "string",
+        "enum": [
+          "Animal and Plant Health Agency – APHA",
+          "Centre for Environment, Fisheries and Aquaculture Science – Cefas",
+          "Defra",
+          "Environment Agency",
+          "Forestry Commission",
+          "Marine Management Organisation – MMO",
+          "Natural England",
+          "Rural Payments Agency – RPA",
+          "Veterinary Medicines Directorate – VMD"
+        ],
+        "title": "Organisations Item"
+      },
+      "title": "Organisations"
+    },
+    "offline": {
+      "type": "boolean",
+      "description": "Filter by forms that are offline",
+      "title": "Offline"
+    },
+    "status": {
+      "type": "array",
+      "description": "Filter by form status(es), empty array matches all",
+      "default": [],
+      "items": {
+        "type": "string",
+        "enum": [
+          "draft",
+          "live"
+        ],
+        "title": "Status Item"
+      },
+      "title": "Status"
+    }
+  },
+  "additionalProperties": false,
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Query Options Schema Manager",
+  "description": "JSON Schema for validating Query Options Schema Manager in Defra forms",
+  "$id": "@defra/forms-model/schemas/query-options-schema-manager.json"
+}

package/schemas/query-options-schema-ui.json

@@ -0,0 +1,100 @@
+{
+  "type": "object",
+  "properties": {
+    "page": {
+      "type": "number",
+      "description": "Current page number, starting from 1",
+      "default": 1,
+      "exclusiveMinimum": 0,
+      "minimum": 1,
+      "title": "Page"
+    },
+    "perPage": {
+      "type": "number",
+      "description": "Number of items to display per page, between 1 and 200",
+      "default": 24,
+      "exclusiveMinimum": 0,
+      "minimum": 1,
+      "maximum": 200,
+      "title": "Per Page"
+    },
+    "sortBy": {
+      "type": "string",
+      "description": "Field to sort results by",
+      "enum": [
+        "updatedAt",
+        "title"
+      ],
+      "title": "Sort By"
+    },
+    "order": {
+      "type": "string",
+      "description": "Sort order (ascending or descending)",
+      "enum": [
+        "asc",
+        "desc"
+      ],
+      "title": "Order"
+    },
+    "title": {
+      "type": "string",
+      "description": "Search by form title, empty string matches all",
+      "default": "",
+      "maxLength": 255,
+      "title": "Title"
+    },
+    "author": {
+      "type": "string",
+      "description": "Search by form author, empty string matches all",
+      "default": "",
+      "maxLength": 100,
+      "title": "Author"
+    },
+    "organisations": {
+      "type": "array",
+      "description": "Filter by organisation(s), empty array matches all",
+      "default": [],
+      "items": {
+        "type": "string",
+        "enum": [
+          "Animal and Plant Health Agency – APHA",
+          "Centre for Environment, Fisheries and Aquaculture Science – Cefas",
+          "Defra",
+          "Environment Agency",
+          "Forestry Commission",
+          "Marine Management Organisation – MMO",
+          "Natural England",
+          "Rural Payments Agency – RPA",
+          "Veterinary Medicines Directorate – VMD"
+        ],
+        "title": "Organisations Item"
+      },
+      "title": "Organisations"
+    },
+    "offline": {
+      "type": "boolean",
+      "description": "Filter by forms that are offline",
+      "title": "Offline"
+    },
+    "status": {
+      "type": "array",
+      "description": "Filter by form status(es), empty array matches all",
+      "default": [],
+      "items": {
+        "type": "string",
+        "enum": [
+          "draft",
+          "live",
+          "offline"
+        ],
+        "title": "Status Item"
+      },
+      "title": "Status"
+    }
+  },
+  "additionalProperties": false,
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Query Options Schema Ui",
+  "description": "JSON Schema for validating Query Options Schema Ui in Defra forms",
+  "$id": "@defra/forms-model/schemas/query-options-schema-ui.json"
+}

package/schemas/search-options-schema-manager.json

@@ -0,0 +1,64 @@
+{
+  "type": "object",
+  "properties": {
+    "title": {
+      "type": "string",
+      "description": "Search by form title, empty string matches all",
+      "default": "",
+      "maxLength": 255,
+      "title": "Title"
+    },
+    "author": {
+      "type": "string",
+      "description": "Search by form author, empty string matches all",
+      "default": "",
+      "maxLength": 100,
+      "title": "Author"
+    },
+    "organisations": {
+      "type": "array",
+      "description": "Filter by organisation(s), empty array matches all",
+      "default": [],
+      "items": {
+        "type": "string",
+        "enum": [
+          "Animal and Plant Health Agency – APHA",
+          "Centre for Environment, Fisheries and Aquaculture Science – Cefas",
+          "Defra",
+          "Environment Agency",
+          "Forestry Commission",
+          "Marine Management Organisation – MMO",
+          "Natural England",
+          "Rural Payments Agency – RPA",
+          "Veterinary Medicines Directorate – VMD"
+        ],
+        "title": "Organisations Item"
+      },
+      "title": "Organisations"
+    },
+    "offline": {
+      "type": "boolean",
+      "description": "Filter by forms that are offline",
+      "title": "Offline"
+    },
+    "status": {
+      "type": "array",
+      "description": "Filter by form status(es), empty array matches all",
+      "default": [],
+      "items": {
+        "type": "string",
+        "enum": [
+          "draft",
+          "live"
+        ],
+        "title": "Status Item"
+      },
+      "title": "Status"
+    }
+  },
+  "additionalProperties": false,
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Search Options Schema Manager",
+  "description": "JSON Schema for validating Search Options Schema Manager in Defra forms",
+  "$id": "@defra/forms-model/schemas/search-options-schema-manager.json"
+}

package/schemas/search-options-schema-ui.json

@@ -0,0 +1,65 @@
+{
+  "type": "object",
+  "properties": {
+    "title": {
+      "type": "string",
+      "description": "Search by form title, empty string matches all",
+      "default": "",
+      "maxLength": 255,
+      "title": "Title"
+    },
+    "author": {
+      "type": "string",
+      "description": "Search by form author, empty string matches all",
+      "default": "",
+      "maxLength": 100,
+      "title": "Author"
+    },
+    "organisations": {
+      "type": "array",
+      "description": "Filter by organisation(s), empty array matches all",
+      "default": [],
+      "items": {
+        "type": "string",
+        "enum": [
+          "Animal and Plant Health Agency – APHA",
+          "Centre for Environment, Fisheries and Aquaculture Science – Cefas",
+          "Defra",
+          "Environment Agency",
+          "Forestry Commission",
+          "Marine Management Organisation – MMO",
+          "Natural England",
+          "Rural Payments Agency – RPA",
+          "Veterinary Medicines Directorate – VMD"
+        ],
+        "title": "Organisations Item"
+      },
+      "title": "Organisations"
+    },
+    "offline": {
+      "type": "boolean",
+      "description": "Filter by forms that are offline",
+      "title": "Offline"
+    },
+    "status": {
+      "type": "array",
+      "description": "Filter by form status(es), empty array matches all",
+      "default": [],
+      "items": {
+        "type": "string",
+        "enum": [
+          "draft",
+          "live",
+          "offline"
+        ],
+        "title": "Status Item"
+      },
+      "title": "Status"
+    }
+  },
+  "additionalProperties": false,
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Search Options Schema Ui",
+  "description": "JSON Schema for validating Search Options Schema Ui in Defra forms",
+  "$id": "@defra/forms-model/schemas/search-options-schema-ui.json"
+}

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

@@ -174,6 +174,11 @@ export interface SaveAndExitMessageData {
   state: object
 }
 
+export interface SavedState {
+  $$__referenceNumber: string
+  [key: string]: any
+}
+
 export interface SaveAndExitV2MessageData {
   magicLinkGroupId?: string
   form: {
@@ -188,7 +193,7 @@ export interface SaveAndExitV2MessageData {
     sub: string
     issuer: string
   }
-  state: object
+  state: SavedState
 }
 
 export interface SaveAndExitMessage {
@@ -213,11 +218,6 @@ export interface SaveAndExitV2Message {
   data: SaveAndExitV2MessageData
 }
 
-export interface SavedState {
-  $$__referenceNumber: string
-  [key: string]: any
-}
-
 export interface SaveAndExitRecord {
   magicLinkId: string
   magicLinkGroupId?: string