@defra/forms-engine-plugin 4.0.43 → 4.0.44

package/.server/server/plugins/payment/types.d.ts

@@ -0,0 +1,172 @@
+export type PaymentResponseState = {
+    /**
+     * - Current status of the payment
+     */
+    status: "created" | "started" | "submitted" | "capturable" | "success" | "failed" | "cancelled" | "error";
+    /**
+     * - Whether the payment process has completed
+     */
+    finished: boolean;
+    /**
+     * - Human-readable message about the payment state
+     */
+    message?: string | undefined;
+    /**
+     * - Error or status code for the payment state
+     */
+    code?: string | undefined;
+};
+export type PaymentLink = {
+    /**
+     * - URL of the linked resource
+     */
+    href: string;
+    /**
+     * - HTTP method to use for the link
+     */
+    method: string;
+};
+export type CreatePaymentRequest = {
+    /**
+     * - Payment amount in pence
+     */
+    amount: number;
+    /**
+     * - Unique reference for the payment
+     */
+    reference: string;
+    /**
+     * - Human-readable description of the payment
+     */
+    description: string;
+    /**
+     * - URL to redirect the user to after payment
+     */
+    return_url: string;
+    /**
+     * - Whether to delay capturing the payment
+     */
+    delayed_capture?: boolean | undefined;
+    /**
+     * - Additional metadata for the payment
+     */
+    metadata?: {
+        formId: string;
+        slug: string;
+    } | undefined;
+};
+export type CreatePaymentResponse = {
+    /**
+     * - Unique identifier for the created payment
+     */
+    payment_id: string;
+    /**
+     * - Current state of the payment
+     */
+    state: PaymentResponseState;
+    /**
+     * - HATEOAS links for the payment
+     */
+    _links: {
+        next_url: PaymentLink;
+    };
+};
+/**
+ * Base response from GOV.UK Pay GET /v1/payments/{PAYMENT_ID} endpoint
+ */
+export type GetPaymentResponseBase = {
+    /**
+     * - Current state of the payment
+     */
+    state: PaymentResponseState;
+    /**
+     * - HATEOAS links for the payment
+     */
+    _links: {
+        self: PaymentLink;
+        next_url?: PaymentLink;
+    };
+    /**
+     * - The paying user's email address
+     */
+    email?: string | undefined;
+};
+/**
+ * Response from GOV.UK Pay GET /v1/payments/{PAYMENT_ID} endpoint - not underscore in property name
+ */
+export type GetPaymentApiResponsePaymentProp = {
+    /**
+     * - Unique identifier for the payment
+     */
+    payment_id: string;
+    /**
+     * - amount of the payment
+     */
+    amount: number;
+};
+/**
+ * Response from GOV.UK Pay GET /v1/payments/{PAYMENT_ID} endpoint
+ */
+export type GetPaymentApiResponse = GetPaymentResponseBase & GetPaymentApiResponsePaymentProp;
+/**
+ * Response returned from getPaymentStatus - subtley different from GetPaymentApiResponse
+ */
+export type GetPaymentResponsePaymentProp = {
+    /**
+     * - Unique identifier for the payment - note no underscore in property name
+     */
+    paymentId: string;
+    /**
+     * - amount of the payment
+     */
+    amount: number;
+};
+/**
+ * Response returned from getPaymentStatus - subtley different from GetPaymentApiResponse
+ */
+export type GetPaymentResponse = GetPaymentResponseBase & GetPaymentResponsePaymentProp;
+/**
+ * Payment session data stored when dispatching to GOV.UK Pay
+ */
+export type PaymentSessionData = {
+    /**
+     * - unique identifier for this payment attempt
+     */
+    uuid: string;
+    /**
+     * - id of the form
+     */
+    formId: string;
+    /**
+     * - form reference number
+     */
+    reference: string;
+    /**
+     * - amount in pounds
+     */
+    amount: number;
+    /**
+     * - payment description
+     */
+    description: string;
+    /**
+     * - GOV.UK Pay payment ID
+     */
+    paymentId: string;
+    /**
+     * - name of the PaymentField component
+     */
+    componentName: string;
+    /**
+     * - URL to redirect to after successful payment
+     */
+    returnUrl: string;
+    /**
+     * - URL to redirect to after failed/cancelled payment
+     */
+    failureUrl: string;
+    /**
+     * - whether the payment is using live API key
+     */
+    isLivePayment: boolean;
+};

package/.server/server/plugins/payment/types.js

@@ -0,0 +1,78 @@
+/**
+ * @typedef {object} PaymentResponseState
+ * @property {'created' | 'started' | 'submitted' | 'capturable' | 'success' | 'failed' | 'cancelled' | 'error'} status - Current status of the payment
+ * @property {boolean} finished - Whether the payment process has completed
+ * @property {string} [message] - Human-readable message about the payment state
+ * @property {string} [code] - Error or status code for the payment state
+ */
+
+/**
+ * @typedef {object} PaymentLink
+ * @property {string} href - URL of the linked resource
+ * @property {string} method - HTTP method to use for the link
+ */
+
+/**
+ * @typedef {object} CreatePaymentRequest
+ * @property {number} amount - Payment amount in pence
+ * @property {string} reference - Unique reference for the payment
+ * @property {string} description - Human-readable description of the payment
+ * @property {string} return_url - URL to redirect the user to after payment
+ * @property {boolean} [delayed_capture] - Whether to delay capturing the payment
+ * @property {{ formId: string, slug: string }} [metadata] - Additional metadata for the payment
+ */
+
+/**
+ * @typedef {object} CreatePaymentResponse
+ * @property {string} payment_id - Unique identifier for the created payment
+ * @property {PaymentResponseState} state - Current state of the payment
+ * @property {{ next_url: PaymentLink }} _links - HATEOAS links for the payment
+ */
+
+/**
+ * Base response from GOV.UK Pay GET /v1/payments/{PAYMENT_ID} endpoint
+ * @typedef {object} GetPaymentResponseBase
+ * @property {PaymentResponseState} state - Current state of the payment
+ * @property {{ self: PaymentLink, next_url?: PaymentLink }} _links - HATEOAS links for the payment
+ * @property {string} [email] - The paying user's email address
+ */
+
+/**
+ * Response from GOV.UK Pay GET /v1/payments/{PAYMENT_ID} endpoint - not underscore in property name
+ * @typedef {object} GetPaymentApiResponsePaymentProp
+ * @property {string} payment_id - Unique identifier for the payment
+ * @property {number} amount - amount of the payment
+ */
+
+/**
+ * Response from GOV.UK Pay GET /v1/payments/{PAYMENT_ID} endpoint
+ * @typedef {GetPaymentResponseBase & GetPaymentApiResponsePaymentProp} GetPaymentApiResponse
+ */
+
+/**
+ * Response returned from getPaymentStatus - subtley different from GetPaymentApiResponse
+ * @typedef {object} GetPaymentResponsePaymentProp
+ * @property {string} paymentId - Unique identifier for the payment - note no underscore in property name
+ * @property {number} amount - amount of the payment
+ */
+
+/**
+ * Response returned from getPaymentStatus - subtley different from GetPaymentApiResponse
+ * @typedef {GetPaymentResponseBase & GetPaymentResponsePaymentProp} GetPaymentResponse
+ */
+
+/**
+ * Payment session data stored when dispatching to GOV.UK Pay
+ * @typedef {object} PaymentSessionData
+ * @property {string} uuid - unique identifier for this payment attempt
+ * @property {string} formId - id of the form
+ * @property {string} reference - form reference number
+ * @property {number} amount - amount in pounds
+ * @property {string} description - payment description
+ * @property {string} paymentId - GOV.UK Pay payment ID
+ * @property {string} componentName - name of the PaymentField component
+ * @property {string} returnUrl - URL to redirect to after successful payment
+ * @property {string} failureUrl - URL to redirect to after failed/cancelled payment
+ * @property {boolean} isLivePayment - whether the payment is using live API key
+ */
+//# sourceMappingURL=types.js.map

package/.server/server/plugins/payment/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","names":[],"sources":["../../../../src/server/plugins/payment/types.js"],"sourcesContent":["/**\n * @typedef {object} PaymentResponseState\n * @property {'created' | 'started' | 'submitted' | 'capturable' | 'success' | 'failed' | 'cancelled' | 'error'} status - Current status of the payment\n * @property {boolean} finished - Whether the payment process has completed\n * @property {string} [message] - Human-readable message about the payment state\n * @property {string} [code] - Error or status code for the payment state\n */\n\n/**\n * @typedef {object} PaymentLink\n * @property {string} href - URL of the linked resource\n * @property {string} method - HTTP method to use for the link\n */\n\n/**\n * @typedef {object} CreatePaymentRequest\n * @property {number} amount - Payment amount in pence\n * @property {string} reference - Unique reference for the payment\n * @property {string} description - Human-readable description of the payment\n * @property {string} return_url - URL to redirect the user to after payment\n * @property {boolean} [delayed_capture] - Whether to delay capturing the payment\n * @property {{ formId: string, slug: string }} [metadata] - Additional metadata for the payment\n */\n\n/**\n * @typedef {object} CreatePaymentResponse\n * @property {string} payment_id - Unique identifier for the created payment\n * @property {PaymentResponseState} state - Current state of the payment\n * @property {{ next_url: PaymentLink }} _links - HATEOAS links for the payment\n */\n\n/**\n * Base response from GOV.UK Pay GET /v1/payments/{PAYMENT_ID} endpoint\n * @typedef {object} GetPaymentResponseBase\n * @property {PaymentResponseState} state - Current state of the payment\n * @property {{ self: PaymentLink, next_url?: PaymentLink }} _links - HATEOAS links for the payment\n * @property {string} [email] - The paying user's email address\n */\n\n/**\n * Response from GOV.UK Pay GET /v1/payments/{PAYMENT_ID} endpoint - not underscore in property name\n * @typedef {object} GetPaymentApiResponsePaymentProp\n * @property {string} payment_id - Unique identifier for the payment\n * @property {number} amount - amount of the payment\n */\n\n/**\n * Response from GOV.UK Pay GET /v1/payments/{PAYMENT_ID} endpoint\n * @typedef {GetPaymentResponseBase & GetPaymentApiResponsePaymentProp} GetPaymentApiResponse\n */\n\n/**\n * Response returned from getPaymentStatus - subtley different from GetPaymentApiResponse\n * @typedef {object} GetPaymentResponsePaymentProp\n * @property {string} paymentId - Unique identifier for the payment - note no underscore in property name\n * @property {number} amount - amount of the payment\n */\n\n/**\n * Response returned from getPaymentStatus - subtley different from GetPaymentApiResponse\n * @typedef {GetPaymentResponseBase & GetPaymentResponsePaymentProp} GetPaymentResponse\n */\n\n/**\n * Payment session data stored when dispatching to GOV.UK Pay\n * @typedef {object} PaymentSessionData\n * @property {string} uuid - unique identifier for this payment attempt\n * @property {string} formId - id of the form\n * @property {string} reference - form reference number\n * @property {number} amount - amount in pounds\n * @property {string} description - payment description\n * @property {string} paymentId - GOV.UK Pay payment ID\n * @property {string} componentName - name of the PaymentField component\n * @property {string} returnUrl - URL to redirect to after successful payment\n * @property {string} failureUrl - URL to redirect to after failed/cancelled payment\n * @property {boolean} isLivePayment - whether the payment is using live API key\n */\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA","ignoreList":[]}

package/.server/server/types.d.ts

@@ -4,6 +4,7 @@ import { type FormModel } from '~/src/server/plugins/engine/models/index.js';
 import { type DetailItem } from '~/src/server/plugins/engine/models/types.js';
 import { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js';
 import { type FormContext, type OnRequestCallback, type PluginOptions, type PreparePageEventRequestOptions } from '~/src/server/plugins/engine/types.js';
+import { type PaymentService } from '~/src/server/plugins/payment/service.js';
 import { type FormRequestPayload, type FormStatus } from '~/src/server/routes/types.js';
 import { type CacheService } from '~/src/server/services/cacheService.js';
 export interface FormsService {
@@ -22,6 +23,7 @@ export interface Services {
     formsService: FormsService;
     formSubmissionService: FormSubmissionService;
     outputService: OutputService;
+    paymentService?: PaymentService;
 }
 export interface RouteConfig {
     formFileName?: string;

package/.server/server/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":[],"sources":["../../src/server/types.ts"],"sourcesContent":["import {\n  type FormDefinition,\n  type FormMetadata,\n  type SubmitPayload,\n  type SubmitResponsePayload\n} from '@defra/forms-model'\nimport { type Server } from '@hapi/hapi'\n\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type DetailItem } from '~/src/server/plugins/engine/models/types.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport {\n  type FormContext,\n  type OnRequestCallback,\n  type PluginOptions,\n  type PreparePageEventRequestOptions\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  type FormRequestPayload,\n  type FormStatus\n} from '~/src/server/routes/types.js'\nimport { type CacheService } from '~/src/server/services/cacheService.js'\n\nexport interface FormsService {\n  getFormMetadata: (slug: string) => Promise<FormMetadata>\n  getFormMetadataById: (id: string) => Promise<FormMetadata>\n  getFormDefinition: (\n    id: string,\n    state: FormStatus\n  ) => Promise<FormDefinition | undefined>\n}\n\nexport interface FormSubmissionService {\n  persistFiles: (\n    files: { fileId: string; initiatedRetrievalKey: string }[],\n    persistedRetrievalKey: string\n  ) => Promise<object>\n  submit: (data: SubmitPayload) => Promise<SubmitResponsePayload | undefined>\n}\n\nexport interface Services {\n  formsService: FormsService\n  formSubmissionService: FormSubmissionService\n  outputService: OutputService\n}\n\nexport interface RouteConfig {\n  formFileName?: string\n  formFilePath?: string\n  enforceCsrf?: boolean\n  services?: Services\n  controllers?: Record<string, typeof PageController>\n  preparePageEventRequestOptions?: PreparePageEventRequestOptions\n  onRequest?: OnRequestCallback\n  saveAndExit?: PluginOptions['saveAndExit']\n  cacheServiceCreator?: (server: Server) => CacheService\n  ordnanceSurveyApiKey?: string\n  ordnanceSurveyApiSecret?: string\n}\n\nexport interface OutputService {\n  submit: (\n    context: FormContext,\n    request: FormRequestPayload,\n    model: FormModel,\n    emailAddress: string,\n    items: DetailItem[],\n    submitResponse: SubmitResponsePayload,\n    formMetadata?: FormMetadata\n  ) => Promise<void>\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"types.js","names":[],"sources":["../../src/server/types.ts"],"sourcesContent":["import {\n  type FormDefinition,\n  type FormMetadata,\n  type SubmitPayload,\n  type SubmitResponsePayload\n} from '@defra/forms-model'\nimport { type Server } from '@hapi/hapi'\n\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type DetailItem } from '~/src/server/plugins/engine/models/types.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport {\n  type FormContext,\n  type OnRequestCallback,\n  type PluginOptions,\n  type PreparePageEventRequestOptions\n} from '~/src/server/plugins/engine/types.js'\nimport { type PaymentService } from '~/src/server/plugins/payment/service.js'\nimport {\n  type FormRequestPayload,\n  type FormStatus\n} from '~/src/server/routes/types.js'\nimport { type CacheService } from '~/src/server/services/cacheService.js'\n\nexport interface FormsService {\n  getFormMetadata: (slug: string) => Promise<FormMetadata>\n  getFormMetadataById: (id: string) => Promise<FormMetadata>\n  getFormDefinition: (\n    id: string,\n    state: FormStatus\n  ) => Promise<FormDefinition | undefined>\n}\n\nexport interface FormSubmissionService {\n  persistFiles: (\n    files: { fileId: string; initiatedRetrievalKey: string }[],\n    persistedRetrievalKey: string\n  ) => Promise<object>\n  submit: (data: SubmitPayload) => Promise<SubmitResponsePayload | undefined>\n}\n\nexport interface Services {\n  formsService: FormsService\n  formSubmissionService: FormSubmissionService\n  outputService: OutputService\n  paymentService?: PaymentService\n}\n\nexport interface RouteConfig {\n  formFileName?: string\n  formFilePath?: string\n  enforceCsrf?: boolean\n  services?: Services\n  controllers?: Record<string, typeof PageController>\n  preparePageEventRequestOptions?: PreparePageEventRequestOptions\n  onRequest?: OnRequestCallback\n  saveAndExit?: PluginOptions['saveAndExit']\n  cacheServiceCreator?: (server: Server) => CacheService\n  ordnanceSurveyApiKey?: string\n  ordnanceSurveyApiSecret?: string\n}\n\nexport interface OutputService {\n  submit: (\n    context: FormContext,\n    request: FormRequestPayload,\n    model: FormModel,\n    emailAddress: string,\n    items: DetailItem[],\n    submitResponse: SubmitResponsePayload,\n    formMetadata?: FormMetadata\n  ) => Promise<void>\n}\n"],"mappings":"","ignoreList":[]}

package/.server/typings/hapi/index.d.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.js","names":[],"sources":["../../../src/typings/hapi/index.d.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/unified-signatures */\n\nimport { type Plugin } from '@hapi/hapi'\nimport { type ServerYar, type Yar } from '@hapi/yar'\nimport { type Logger } from 'pino'\n\nimport {\n  type COMPONENT_STATE_ERROR,\n  type EXTERNAL_STATE_APPENDAGE,\n  type EXTERNAL_STATE_PAYLOAD\n} from '~/src/server/constants.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport {\n  type AnyFormRequest,\n  type FormSubmissionError,\n  type PluginOptions\n} from '~/src/server/plugins/engine/types.ts'\nimport { type CacheService } from '~/src/server/services/index.js'\n\ndeclare module '@hapi/yar' {\n  interface YarFlashes {\n    [EXTERNAL_STATE_APPENDAGE]: object\n    [EXTERNAL_STATE_PAYLOAD]: object\n    [COMPONENT_STATE_ERROR]: string\n    [key: string]: { errors: FormSubmissionError[] }\n  }\n}\n\ndeclare module '@hapi/hapi' {\n  // Here we are decorating Hapi interface types with\n  // props from plugins which doesn't export @types\n  interface PluginProperties {\n    crumb: {\n      generate?: (request: AnyRequest) => string\n    }\n    'forms-engine-plugin': {\n      baseLayoutPath: string\n      cacheService: CacheService\n      viewContext?: (\n        request: AnyFormRequest | null\n      ) => Record<string, unknown> | Promise<Record<string, unknown>>\n      saveAndExit?: PluginOptions['saveAndExit']\n    }\n  }\n\n  interface Request {\n    logger: Logger\n    yar: Yar\n  }\n\n  interface RequestApplicationState {\n    model?: FormModel\n  }\n\n  interface Server {\n    logger: Logger\n    yar: ServerYar\n  }\n\n  interface ServerApplicationState {\n    model?: FormModel\n    models: Map<string, { model: FormModel; updatedAt: Date }>\n  }\n}\n\ndeclare module 'blankie' {\n  declare const blankie: {\n    plugin: Plugin<Record<string, boolean | string | string[]>>\n  }\n\n  export = blankie\n}\n\ndeclare module 'blipp' {\n  declare const blipp: {\n    plugin: Plugin\n  }\n\n  export = blipp\n}\n\ndeclare module 'hapi-pulse' {\n  declare const hapiPulse: {\n    plugin: Plugin<{\n      timeout: number\n    }>\n  }\n\n  export = hapiPulse\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"index.d.js","names":[],"sources":["../../../src/typings/hapi/index.d.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/unified-signatures */\n\nimport { type Plugin } from '@hapi/hapi'\nimport { type ServerYar, type Yar } from '@hapi/yar'\nimport { type Logger } from 'pino'\n\nimport {\n  type COMPONENT_STATE_ERROR,\n  type EXTERNAL_STATE_APPENDAGE,\n  type EXTERNAL_STATE_PAYLOAD\n} from '~/src/server/constants.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport {\n  type AnyFormRequest,\n  type FormSubmissionError,\n  type PluginOptions\n} from '~/src/server/plugins/engine/types.ts'\nimport { type CacheService } from '~/src/server/services/index.js'\n\ndeclare module '@hapi/yar' {\n  interface YarFlashes {\n    [EXTERNAL_STATE_APPENDAGE]: object\n    [EXTERNAL_STATE_PAYLOAD]: object\n    [COMPONENT_STATE_ERROR]: string\n    [key: string]: { errors: FormSubmissionError[] }\n  }\n}\n\ndeclare module '@hapi/hapi' {\n  // Here we are decorating Hapi interface types with\n  // props from plugins which doesn't export @types\n  interface PluginProperties {\n    crumb: {\n      generate?: (request: AnyRequest) => string\n    }\n    'forms-engine-plugin': {\n      baseLayoutPath: string\n      cacheService: CacheService\n      viewContext?: (\n        request: AnyFormRequest | null\n      ) => Record<string, unknown> | Promise<Record<string, unknown>>\n      saveAndExit?: PluginOptions['saveAndExit']\n      baseUrl: string\n    }\n  }\n\n  interface Request {\n    logger: Logger\n    yar: Yar\n  }\n\n  interface RequestApplicationState {\n    model?: FormModel\n  }\n\n  interface Server {\n    logger: Logger\n    yar: ServerYar\n  }\n\n  interface ServerApplicationState {\n    model?: FormModel\n    models: Map<string, { model: FormModel; updatedAt: Date }>\n  }\n}\n\ndeclare module 'blankie' {\n  declare const blankie: {\n    plugin: Plugin<Record<string, boolean | string | string[]>>\n  }\n\n  export = blankie\n}\n\ndeclare module 'blipp' {\n  declare const blipp: {\n    plugin: Plugin\n  }\n\n  export = blipp\n}\n\ndeclare module 'hapi-pulse' {\n  declare const hapiPulse: {\n    plugin: Plugin<{\n      timeout: number\n    }>\n  }\n\n  export = hapiPulse\n}\n"],"mappings":"","ignoreList":[]}

package/README.md

@@ -6,15 +6,18 @@ It is designed to be embedded in the frontend of a digital service and provide a
 
 ## Table of Contents
 
-- [Demo of DXT](#demo-of-dxt)
-- [Installation](#installation)
-- [Documentation](#documentation)
-- [Publishing the Package](#publishing-the-package)
-  - [Semantic Versioning Control](#semantic-versioning-control)
-  - [Major-Version Release Branches](#major-version-release-branches)
-  - [Manual Workflow Triggers](#manual-workflow-triggers)
-  - [Workflow Triggers](#workflow-triggers)
-  - [Safety and Consistency](#safety-and-consistency)
+- [@defra/forms-engine-plugin](#defraforms-engine-plugin)
+  - [Table of Contents](#table-of-contents)
+  - [Demo of DXT](#demo-of-dxt)
+  - [Installation](#installation)
+  - [Documentation](#documentation)
+  - [Contributing](#contributing)
+  - [Publishing the package](#publishing-the-package)
+    - [Semantic Versioning Control](#semantic-versioning-control)
+    - [Major-Version Release Branches](#major-version-release-branches)
+    - [Manual Workflow Triggers](#manual-workflow-triggers)
+    - [Workflow Triggers](#workflow-triggers)
+    - [Safety and Consistency](#safety-and-consistency)
 
 ## Demo of DXT
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-engine-plugin",
-  "version": "4.0.43",
+  "version": "4.0.44",
   "description": "Defra forms engine",
   "type": "module",
   "files": [
@@ -70,7 +70,7 @@
   },
   "license": "SEE LICENSE IN LICENSE",
   "dependencies": {
-    "@defra/forms-model": "^3.0.603",
+    "@defra/forms-model": "^3.0.611",
     "@defra/hapi-tracing": "^1.29.0",
     "@defra/interactive-map": "^0.0.3-alpha",
     "@elastic/ecs-pino-format": "^1.5.0",

package/src/client/stylesheets/_payment-field.scss

@@ -0,0 +1,8 @@
+@use "govuk-frontend" as *;
+
+.app-payment-field {
+  background-color: govuk-colour("light-grey");
+  border-top: 5px solid govuk-colour("blue");
+  padding: govuk-spacing(4);
+  margin-bottom: govuk-spacing(6);
+}

package/src/client/stylesheets/application.scss

@@ -2,6 +2,8 @@
 @use "shared";
 @use "code";
 @use "tag-env";
+@use "location-fields";
+@use "payment-field";
 
 //  An example of some user-supplied styling
 //  Not great practice but it illustrates the point

package/src/index.ts

@@ -23,7 +23,11 @@ const ordnanceSurveyApiKey = config.get('ordnanceSurveyApiKey')
  * Main entrypoint to the application.
  */
 async function startServer() {
-  const server = await createServer({ ordnanceSurveyApiKey })
+  const server = await createServer({
+    ordnanceSurveyApiKey,
+    // Enable save and exit for devserver
+    saveAndExit: (_request, h) => h.redirect('/')
+  })
   await server.start()
 
   process.send?.('online')

package/src/server/constants.js

@@ -3,3 +3,4 @@ export const FORM_PREFIX = ''
 export const EXTERNAL_STATE_PAYLOAD = 'EXTERNAL_STATE_PAYLOAD'
 export const EXTERNAL_STATE_APPENDAGE = 'EXTERNAL_STATE_APPENDAGE'
 export const COMPONENT_STATE_ERROR = 'COMPONENT_STATE_ERROR'
+export const PAYMENT_EXPIRED_NOTIFICATION = 'PAYMENT_EXPIRED_NOTIFICATION'

package/src/server/forms/payment-test.yaml

@@ -0,0 +1,42 @@
+---
+schema: 2
+name: Payment Test Form
+declaration: "<p class=\"govuk-body\">All the answers you have provided are true to the best of your knowledge.</p>"
+pages:
+  - title: What is your name?
+    path: '/person'
+    components:
+      - name: personName
+        title: What is your name?
+        type: TextField
+        shortDescription: Your name
+        options:
+          required: true
+    next:
+      - path: '/pay-for-your-licence'
+  - title: A page title
+    path: '/pay-for-your-licence'
+    components:
+      - name: pageGuidance
+        type: Html
+        title: Guidance
+        content: "<p class=\"govuk-body\">Random guidance</p>"
+        options: {}
+      - name: licencePayment
+        title: Payment details required
+        type: PaymentField
+        options:
+          required: true
+          amount: 300
+          description: Processing fee for your application.
+    next:
+      - path: '/summary'
+  - title: Summary
+    path: '/summary'
+    controller: './pages/summary.js'
+    components: []
+    next: []
+conditions: []
+sections: []
+lists: []
+startPage: '/person'

package/src/server/forms/register-as-a-unicorn-breeder.yaml

@@ -242,6 +242,20 @@ pages:
         content: 'Fill in this field'
         options:
           required: false
+    next:
+      - path: '/pay-for-your-licence'
+  - title: Pay for your licence
+    path: '/pay-for-your-licence'
+    section: section
+    components:
+      - name: licencePayment
+        title: Unicorn breeder licence fee
+        type: PaymentField
+        hint: You'll be redirected to GOV.UK Pay to complete your payment
+        options:
+          required: true
+          amount: 50
+          description: Unicorn breeder annual licence fee
     next:
       - path: '/summary'
 conditions:

package/src/server/plugins/engine/components/FormComponent.ts

@@ -30,6 +30,7 @@ export class FormComponent extends ComponentBase {
   label: string
 
   isFormComponent = true
+  isAppendageStateSingleObject = false
 
   constructor(
     def: FormComponentsDef,