@defra/forms-engine-plugin 2.0.3 → 2.1.0

package/.server/server/forms/page-events.yaml

@@ -0,0 +1,87 @@
+---
+name: Page events
+engine: V2
+schema: 2
+startPage: '/summary'
+pages:
+  - title: Your name
+    path: '/your-name'
+    components:
+      - type: TextField
+        title: What is your first name?
+        name: applicantFirstName
+        shortDescription: Your first name
+        hint: ''
+        options:
+          required: true
+        schema: {}
+        id: 1fb8e182-c709-4792-8f83-e01d8b1fee1a
+      - type: TextField
+        title: What is your last name?
+        name: applicantLastName
+        shortDescription: Your last name
+        hint: ''
+        options:
+          required: true
+        schema: {}
+        id: b68df7f1-d4f4-4c17-83c8-402f584906c9
+    next: []
+    id: 622a35ec-3795-418a-81f3-a45746959045
+  - title: ''
+    path: '/date-of-birth'
+    events:
+      onLoad:
+        type: http
+        options:
+          method: 'POST'
+          url: http://localhost:3009/api/example/on-load-page
+    components:
+      - type: Html
+        # technically context.data.submissionReferenceNumber is redundant as the reference number is available locally as context.referenceNumber
+        # but this is to demonstrate that the server can send data back to the client
+        content: >
+          <p class="govuk-body">
+            The backend received a full copy of the form state even though you haven't submitted the form yet.
+          </p>
+          <p class="govuk-body">
+            Your submission was received with the reference: <strong>{{ context.data.submissionReferenceNumber }}</strong>.
+          </p>
+        id: 334b10dc-3373-4928-8fed-575578a67de8
+      - type: DatePartsField
+        title: When is {{ applicantFirstName }} {{ applicantLastName }}'s birthday?
+        name: dateOfBirth
+        shortDescription: Your birthday
+        hint: ''
+        options:
+          required: true
+        schema: {}
+        id: '00738799-3489-4ab2-a57b-542eecb31bfa'
+    next: []
+    id: da0fbdb4-a2de-4650-be16-9ba552af135f
+  - id: 449a45f6-4541-4a46-91bd-8b8931b07b50
+    title: Summary
+    path: '/summary'
+    controller: SummaryPageController
+    events:
+      onLoad:
+        type: http
+        options:
+          method: 'POST'
+          url: http://localhost:3009/api/example/on-summary
+      onSave:
+        type: http
+        options:
+          method: 'POST'
+          url: http://localhost:3009/api/example/on-summary
+    components:
+      - type: Html
+        content: >
+          <h2 class="govuk-heading-m">Your age</h1>
+          <p class="govuk-body">
+            We've calculated that you are {{ context.data.calculatedAge }} years old. Only proceed if this is correct.
+          </p>
+        id: c42ea488-a38c-4b67-b8fa-4cf543a4f82d
+    next: []
+conditions: []
+sections: []
+lists: []

package/.server/server/index.js

@@ -16,7 +16,7 @@ import pluginErrorPages from "./plugins/errorPages.js";
 import { plugin as pluginViews } from "./plugins/nunjucks/index.js";
 import pluginPulse from "./plugins/pulse.js";
 import pluginSession from "./plugins/session.js";
-import { publicRoutes } from "./routes/index.js";
+import { dummyApiRoutes, publicRoutes } from "./routes/index.js";
 import { prepareSecureContext } from "./secure-context.js";
 const proxyAgent = new ProxyAgent();
 Wreck.agents = {
@@ -96,6 +96,7 @@ export async function createServer(routeConfig) {
       name: 'router',
       register: server => {
         server.route(publicRoutes);
+        server.route(dummyApiRoutes);
       }
     }
   });

package/.server/server/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["Engine","CatboxMemory","CatboxRedis","hapi","inert","Scooter","Wreck","blipp","ProxyAgent","config","requestLogger","requestTracing","buildRedisClient","configureCrumbPlugin","configureEnginePlugin","pluginErrorPages","plugin","pluginViews","pluginPulse","pluginSession","publicRoutes","prepareSecureContext","proxyAgent","agents","https","http","httpsAllowUnauthorized","serverOptions","debug","request","get","port","router","stripTrailingSlash","routes","validate","options","abortEarly","security","hsts","maxAge","includeSubDomains","preload","xss","noSniff","xframe","cache","name","engine","client","createServer","routeConfig","server","register","pluginCrumb","pluginEngine","ext","h","response","continue","header","path","startsWith","route"],"sources":["../../src/server/index.ts"],"sourcesContent":["import { Engine as CatboxMemory } from '@hapi/catbox-memory'\nimport { Engine as CatboxRedis } from '@hapi/catbox-redis'\nimport hapi, {\n  type Request,\n  type ResponseToolkit,\n  type ServerOptions\n} from '@hapi/hapi'\nimport inert from '@hapi/inert'\nimport Scooter from '@hapi/scooter'\nimport Wreck from '@hapi/wreck'\nimport blipp from 'blipp'\nimport { ProxyAgent } from 'proxy-agent'\n\nimport { config } from '~/src/config/index.js'\nimport { requestLogger } from '~/src/server/common/helpers/logging/request-logger.js'\nimport { requestTracing } from '~/src/server/common/helpers/logging/request-tracing.js'\nimport { buildRedisClient } from '~/src/server/common/helpers/redis-client.js'\nimport { configureCrumbPlugin } from '~/src/server/plugins/crumb.js'\nimport { configureEnginePlugin } from '~/src/server/plugins/engine/configureEnginePlugin.js'\nimport pluginErrorPages from '~/src/server/plugins/errorPages.js'\nimport { plugin as pluginViews } from '~/src/server/plugins/nunjucks/index.js'\nimport pluginPulse from '~/src/server/plugins/pulse.js'\nimport pluginSession from '~/src/server/plugins/session.js'\nimport { publicRoutes } from '~/src/server/routes/index.js'\nimport { prepareSecureContext } from '~/src/server/secure-context.js'\nimport { type RouteConfig } from '~/src/server/types.js'\n\nconst proxyAgent = new ProxyAgent()\n\nWreck.agents = {\n  https: proxyAgent,\n  http: proxyAgent,\n  httpsAllowUnauthorized: proxyAgent\n}\n\nconst serverOptions = (): ServerOptions => {\n  const serverOptions: ServerOptions = {\n    debug: { request: [`${config.get('isDevelopment')}`] },\n    port: config.get('port'),\n    router: {\n      stripTrailingSlash: true\n    },\n    routes: {\n      validate: {\n        options: {\n          abortEarly: false\n        }\n      },\n      security: {\n        hsts: {\n          maxAge: 31536000,\n          includeSubDomains: true,\n          preload: false\n        },\n        xss: 'enabled',\n        noSniff: true,\n        xframe: true\n      }\n    },\n    cache: [\n      {\n        name: 'session',\n        engine: config.get('isTest')\n          ? new CatboxMemory()\n          : new CatboxRedis({\n              client: buildRedisClient()\n            })\n      }\n    ]\n  }\n\n  return serverOptions\n}\n\nexport async function createServer(routeConfig?: RouteConfig) {\n  const server = hapi.server(serverOptions())\n\n  await server.register(requestLogger)\n\n  if (config.get('isProduction')) {\n    prepareSecureContext(server)\n  }\n\n  const pluginCrumb = configureCrumbPlugin(routeConfig)\n  const pluginEngine = await configureEnginePlugin(routeConfig)\n\n  await server.register(pluginSession)\n  await server.register(pluginPulse)\n  await server.register(inert)\n  await server.register(Scooter)\n  await server.register(pluginCrumb)\n  await server.register(pluginEngine)\n\n  server.ext('onPreResponse', (request: Request, h: ResponseToolkit) => {\n    const { response } = request\n\n    if ('isBoom' in response) {\n      return h.continue\n    }\n\n    // Prevent search engine indexing\n    response.header('x-robots-tag', 'noindex, nofollow')\n\n    // Disable cache to ensure back/foward navigation updates progress\n    if (\n      !request.path.startsWith('/javascripts/') &&\n      !request.path.startsWith('/stylesheets/') &&\n      !request.path.startsWith('/assets/')\n    ) {\n      response.header('cache-control', 'no-store')\n    }\n\n    return h.continue\n  })\n\n  await server.register(pluginViews)\n\n  await server.register({\n    plugin: {\n      name: 'router',\n      register: (server) => {\n        server.route(publicRoutes)\n      }\n    }\n  })\n\n  await server.register(pluginErrorPages)\n\n  if (config.get('cdpEnvironment') === 'local') {\n    await server.register(blipp)\n  }\n\n  await server.register(requestTracing)\n\n  return server\n}\n"],"mappings":"AAAA,SAASA,MAAM,IAAIC,YAAY,QAAQ,qBAAqB;AAC5D,SAASD,MAAM,IAAIE,WAAW,QAAQ,oBAAoB;AAC1D,OAAOC,IAAI,MAIJ,YAAY;AACnB,OAAOC,KAAK,MAAM,aAAa;AAC/B,OAAOC,OAAO,MAAM,eAAe;AACnC,OAAOC,KAAK,MAAM,aAAa;AAC/B,OAAOC,KAAK,MAAM,OAAO;AACzB,SAASC,UAAU,QAAQ,aAAa;AAExC,SAASC,MAAM;AACf,SAASC,aAAa;AACtB,SAASC,cAAc;AACvB,SAASC,gBAAgB;AACzB,SAASC,oBAAoB;AAC7B,SAASC,qBAAqB;AAC9B,OAAOC,gBAAgB;AACvB,SAASC,MAAM,IAAIC,WAAW;AAC9B,OAAOC,WAAW;AAClB,OAAOC,aAAa;AACpB,SAASC,YAAY;AACrB,SAASC,oBAAoB;AAG7B,MAAMC,UAAU,GAAG,IAAId,UAAU,CAAC,CAAC;AAEnCF,KAAK,CAACiB,MAAM,GAAG;EACbC,KAAK,EAAEF,UAAU;EACjBG,IAAI,EAAEH,UAAU;EAChBI,sBAAsB,EAAEJ;AAC1B,CAAC;AAED,MAAMK,aAAa,GAAGA,CAAA,KAAqB;EACzC,MAAMA,aAA4B,GAAG;IACnCC,KAAK,EAAE;MAAEC,OAAO,EAAE,CAAC,GAAGpB,MAAM,CAACqB,GAAG,CAAC,eAAe,CAAC,EAAE;IAAE,CAAC;IACtDC,IAAI,EAAEtB,MAAM,CAACqB,GAAG,CAAC,MAAM,CAAC;IACxBE,MAAM,EAAE;MACNC,kBAAkB,EAAE;IACtB,CAAC;IACDC,MAAM,EAAE;MACNC,QAAQ,EAAE;QACRC,OAAO,EAAE;UACPC,UAAU,EAAE;QACd;MACF,CAAC;MACDC,QAAQ,EAAE;QACRC,IAAI,EAAE;UACJC,MAAM,EAAE,QAAQ;UAChBC,iBAAiB,EAAE,IAAI;UACvBC,OAAO,EAAE;QACX,CAAC;QACDC,GAAG,EAAE,SAAS;QACdC,OAAO,EAAE,IAAI;QACbC,MAAM,EAAE;MACV;IACF,CAAC;IACDC,KAAK,EAAE,CACL;MACEC,IAAI,EAAE,SAAS;MACfC,MAAM,EAAEvC,MAAM,CAACqB,GAAG,CAAC,QAAQ,CAAC,GACxB,IAAI7B,YAAY,CAAC,CAAC,GAClB,IAAIC,WAAW,CAAC;QACd+C,MAAM,EAAErC,gBAAgB,CAAC;MAC3B,CAAC;IACP,CAAC;EAEL,CAAC;EAED,OAAOe,aAAa;AACtB,CAAC;AAED,OAAO,eAAeuB,YAAYA,CAACC,WAAyB,EAAE;EAC5D,MAAMC,MAAM,GAAGjD,IAAI,CAACiD,MAAM,CAACzB,aAAa,CAAC,CAAC,CAAC;EAE3C,MAAMyB,MAAM,CAACC,QAAQ,CAAC3C,aAAa,CAAC;EAEpC,IAAID,MAAM,CAACqB,GAAG,CAAC,cAAc,CAAC,EAAE;IAC9BT,oBAAoB,CAAC+B,MAAM,CAAC;EAC9B;EAEA,MAAME,WAAW,GAAGzC,oBAAoB,CAACsC,WAAW,CAAC;EACrD,MAAMI,YAAY,GAAG,MAAMzC,qBAAqB,CAACqC,WAAW,CAAC;EAE7D,MAAMC,MAAM,CAACC,QAAQ,CAAClC,aAAa,CAAC;EACpC,MAAMiC,MAAM,CAACC,QAAQ,CAACnC,WAAW,CAAC;EAClC,MAAMkC,MAAM,CAACC,QAAQ,CAACjD,KAAK,CAAC;EAC5B,MAAMgD,MAAM,CAACC,QAAQ,CAAChD,OAAO,CAAC;EAC9B,MAAM+C,MAAM,CAACC,QAAQ,CAACC,WAAW,CAAC;EAClC,MAAMF,MAAM,CAACC,QAAQ,CAACE,YAAY,CAAC;EAEnCH,MAAM,CAACI,GAAG,CAAC,eAAe,EAAE,CAAC3B,OAAgB,EAAE4B,CAAkB,KAAK;IACpE,MAAM;MAAEC;IAAS,CAAC,GAAG7B,OAAO;IAE5B,IAAI,QAAQ,IAAI6B,QAAQ,EAAE;MACxB,OAAOD,CAAC,CAACE,QAAQ;IACnB;;IAEA;IACAD,QAAQ,CAACE,MAAM,CAAC,cAAc,EAAE,mBAAmB,CAAC;;IAEpD;IACA,IACE,CAAC/B,OAAO,CAACgC,IAAI,CAACC,UAAU,CAAC,eAAe,CAAC,IACzC,CAACjC,OAAO,CAACgC,IAAI,CAACC,UAAU,CAAC,eAAe,CAAC,IACzC,CAACjC,OAAO,CAACgC,IAAI,CAACC,UAAU,CAAC,UAAU,CAAC,EACpC;MACAJ,QAAQ,CAACE,MAAM,CAAC,eAAe,EAAE,UAAU,CAAC;IAC9C;IAEA,OAAOH,CAAC,CAACE,QAAQ;EACnB,CAAC,CAAC;EAEF,MAAMP,MAAM,CAACC,QAAQ,CAACpC,WAAW,CAAC;EAElC,MAAMmC,MAAM,CAACC,QAAQ,CAAC;IACpBrC,MAAM,EAAE;MACN+B,IAAI,EAAE,QAAQ;MACdM,QAAQ,EAAGD,MAAM,IAAK;QACpBA,MAAM,CAACW,KAAK,CAAC3C,YAAY,CAAC;MAC5B;IACF;EACF,CAAC,CAAC;EAEF,MAAMgC,MAAM,CAACC,QAAQ,CAACtC,gBAAgB,CAAC;EAEvC,IAAIN,MAAM,CAACqB,GAAG,CAAC,gBAAgB,CAAC,KAAK,OAAO,EAAE;IAC5C,MAAMsB,MAAM,CAACC,QAAQ,CAAC9C,KAAK,CAAC;EAC9B;EAEA,MAAM6C,MAAM,CAACC,QAAQ,CAAC1C,cAAc,CAAC;EAErC,OAAOyC,MAAM;AACf","ignoreList":[]}
+{"version":3,"file":"index.js","names":["Engine","CatboxMemory","CatboxRedis","hapi","inert","Scooter","Wreck","blipp","ProxyAgent","config","requestLogger","requestTracing","buildRedisClient","configureCrumbPlugin","configureEnginePlugin","pluginErrorPages","plugin","pluginViews","pluginPulse","pluginSession","dummyApiRoutes","publicRoutes","prepareSecureContext","proxyAgent","agents","https","http","httpsAllowUnauthorized","serverOptions","debug","request","get","port","router","stripTrailingSlash","routes","validate","options","abortEarly","security","hsts","maxAge","includeSubDomains","preload","xss","noSniff","xframe","cache","name","engine","client","createServer","routeConfig","server","register","pluginCrumb","pluginEngine","ext","h","response","continue","header","path","startsWith","route"],"sources":["../../src/server/index.ts"],"sourcesContent":["import { Engine as CatboxMemory } from '@hapi/catbox-memory'\nimport { Engine as CatboxRedis } from '@hapi/catbox-redis'\nimport hapi, {\n  type Request,\n  type ResponseToolkit,\n  type ServerOptions,\n  type ServerRoute\n} from '@hapi/hapi'\nimport inert from '@hapi/inert'\nimport Scooter from '@hapi/scooter'\nimport Wreck from '@hapi/wreck'\nimport blipp from 'blipp'\nimport { ProxyAgent } from 'proxy-agent'\n\nimport { config } from '~/src/config/index.js'\nimport { requestLogger } from '~/src/server/common/helpers/logging/request-logger.js'\nimport { requestTracing } from '~/src/server/common/helpers/logging/request-tracing.js'\nimport { buildRedisClient } from '~/src/server/common/helpers/redis-client.js'\nimport { configureCrumbPlugin } from '~/src/server/plugins/crumb.js'\nimport { configureEnginePlugin } from '~/src/server/plugins/engine/configureEnginePlugin.js'\nimport pluginErrorPages from '~/src/server/plugins/errorPages.js'\nimport { plugin as pluginViews } from '~/src/server/plugins/nunjucks/index.js'\nimport pluginPulse from '~/src/server/plugins/pulse.js'\nimport pluginSession from '~/src/server/plugins/session.js'\nimport { dummyApiRoutes, publicRoutes } from '~/src/server/routes/index.js'\nimport { prepareSecureContext } from '~/src/server/secure-context.js'\nimport { type RouteConfig } from '~/src/server/types.js'\n\nconst proxyAgent = new ProxyAgent()\n\nWreck.agents = {\n  https: proxyAgent,\n  http: proxyAgent,\n  httpsAllowUnauthorized: proxyAgent\n}\n\nconst serverOptions = (): ServerOptions => {\n  const serverOptions: ServerOptions = {\n    debug: { request: [`${config.get('isDevelopment')}`] },\n    port: config.get('port'),\n    router: {\n      stripTrailingSlash: true\n    },\n    routes: {\n      validate: {\n        options: {\n          abortEarly: false\n        }\n      },\n      security: {\n        hsts: {\n          maxAge: 31536000,\n          includeSubDomains: true,\n          preload: false\n        },\n        xss: 'enabled',\n        noSniff: true,\n        xframe: true\n      }\n    },\n    cache: [\n      {\n        name: 'session',\n        engine: config.get('isTest')\n          ? new CatboxMemory()\n          : new CatboxRedis({\n              client: buildRedisClient()\n            })\n      }\n    ]\n  }\n\n  return serverOptions\n}\n\nexport async function createServer(routeConfig?: RouteConfig) {\n  const server = hapi.server(serverOptions())\n\n  await server.register(requestLogger)\n\n  if (config.get('isProduction')) {\n    prepareSecureContext(server)\n  }\n\n  const pluginCrumb = configureCrumbPlugin(routeConfig)\n  const pluginEngine = await configureEnginePlugin(routeConfig)\n\n  await server.register(pluginSession)\n  await server.register(pluginPulse)\n  await server.register(inert)\n  await server.register(Scooter)\n  await server.register(pluginCrumb)\n  await server.register(pluginEngine)\n\n  server.ext('onPreResponse', (request: Request, h: ResponseToolkit) => {\n    const { response } = request\n\n    if ('isBoom' in response) {\n      return h.continue\n    }\n\n    // Prevent search engine indexing\n    response.header('x-robots-tag', 'noindex, nofollow')\n\n    // Disable cache to ensure back/foward navigation updates progress\n    if (\n      !request.path.startsWith('/javascripts/') &&\n      !request.path.startsWith('/stylesheets/') &&\n      !request.path.startsWith('/assets/')\n    ) {\n      response.header('cache-control', 'no-store')\n    }\n\n    return h.continue\n  })\n\n  await server.register(pluginViews)\n\n  await server.register({\n    plugin: {\n      name: 'router',\n      register: (server) => {\n        server.route(publicRoutes)\n        server.route(dummyApiRoutes as ServerRoute[])\n      }\n    }\n  })\n\n  await server.register(pluginErrorPages)\n\n  if (config.get('cdpEnvironment') === 'local') {\n    await server.register(blipp)\n  }\n\n  await server.register(requestTracing)\n\n  return server\n}\n"],"mappings":"AAAA,SAASA,MAAM,IAAIC,YAAY,QAAQ,qBAAqB;AAC5D,SAASD,MAAM,IAAIE,WAAW,QAAQ,oBAAoB;AAC1D,OAAOC,IAAI,MAKJ,YAAY;AACnB,OAAOC,KAAK,MAAM,aAAa;AAC/B,OAAOC,OAAO,MAAM,eAAe;AACnC,OAAOC,KAAK,MAAM,aAAa;AAC/B,OAAOC,KAAK,MAAM,OAAO;AACzB,SAASC,UAAU,QAAQ,aAAa;AAExC,SAASC,MAAM;AACf,SAASC,aAAa;AACtB,SAASC,cAAc;AACvB,SAASC,gBAAgB;AACzB,SAASC,oBAAoB;AAC7B,SAASC,qBAAqB;AAC9B,OAAOC,gBAAgB;AACvB,SAASC,MAAM,IAAIC,WAAW;AAC9B,OAAOC,WAAW;AAClB,OAAOC,aAAa;AACpB,SAASC,cAAc,EAAEC,YAAY;AACrC,SAASC,oBAAoB;AAG7B,MAAMC,UAAU,GAAG,IAAIf,UAAU,CAAC,CAAC;AAEnCF,KAAK,CAACkB,MAAM,GAAG;EACbC,KAAK,EAAEF,UAAU;EACjBG,IAAI,EAAEH,UAAU;EAChBI,sBAAsB,EAAEJ;AAC1B,CAAC;AAED,MAAMK,aAAa,GAAGA,CAAA,KAAqB;EACzC,MAAMA,aAA4B,GAAG;IACnCC,KAAK,EAAE;MAAEC,OAAO,EAAE,CAAC,GAAGrB,MAAM,CAACsB,GAAG,CAAC,eAAe,CAAC,EAAE;IAAE,CAAC;IACtDC,IAAI,EAAEvB,MAAM,CAACsB,GAAG,CAAC,MAAM,CAAC;IACxBE,MAAM,EAAE;MACNC,kBAAkB,EAAE;IACtB,CAAC;IACDC,MAAM,EAAE;MACNC,QAAQ,EAAE;QACRC,OAAO,EAAE;UACPC,UAAU,EAAE;QACd;MACF,CAAC;MACDC,QAAQ,EAAE;QACRC,IAAI,EAAE;UACJC,MAAM,EAAE,QAAQ;UAChBC,iBAAiB,EAAE,IAAI;UACvBC,OAAO,EAAE;QACX,CAAC;QACDC,GAAG,EAAE,SAAS;QACdC,OAAO,EAAE,IAAI;QACbC,MAAM,EAAE;MACV;IACF,CAAC;IACDC,KAAK,EAAE,CACL;MACEC,IAAI,EAAE,SAAS;MACfC,MAAM,EAAExC,MAAM,CAACsB,GAAG,CAAC,QAAQ,CAAC,GACxB,IAAI9B,YAAY,CAAC,CAAC,GAClB,IAAIC,WAAW,CAAC;QACdgD,MAAM,EAAEtC,gBAAgB,CAAC;MAC3B,CAAC;IACP,CAAC;EAEL,CAAC;EAED,OAAOgB,aAAa;AACtB,CAAC;AAED,OAAO,eAAeuB,YAAYA,CAACC,WAAyB,EAAE;EAC5D,MAAMC,MAAM,GAAGlD,IAAI,CAACkD,MAAM,CAACzB,aAAa,CAAC,CAAC,CAAC;EAE3C,MAAMyB,MAAM,CAACC,QAAQ,CAAC5C,aAAa,CAAC;EAEpC,IAAID,MAAM,CAACsB,GAAG,CAAC,cAAc,CAAC,EAAE;IAC9BT,oBAAoB,CAAC+B,MAAM,CAAC;EAC9B;EAEA,MAAME,WAAW,GAAG1C,oBAAoB,CAACuC,WAAW,CAAC;EACrD,MAAMI,YAAY,GAAG,MAAM1C,qBAAqB,CAACsC,WAAW,CAAC;EAE7D,MAAMC,MAAM,CAACC,QAAQ,CAACnC,aAAa,CAAC;EACpC,MAAMkC,MAAM,CAACC,QAAQ,CAACpC,WAAW,CAAC;EAClC,MAAMmC,MAAM,CAACC,QAAQ,CAAClD,KAAK,CAAC;EAC5B,MAAMiD,MAAM,CAACC,QAAQ,CAACjD,OAAO,CAAC;EAC9B,MAAMgD,MAAM,CAACC,QAAQ,CAACC,WAAW,CAAC;EAClC,MAAMF,MAAM,CAACC,QAAQ,CAACE,YAAY,CAAC;EAEnCH,MAAM,CAACI,GAAG,CAAC,eAAe,EAAE,CAAC3B,OAAgB,EAAE4B,CAAkB,KAAK;IACpE,MAAM;MAAEC;IAAS,CAAC,GAAG7B,OAAO;IAE5B,IAAI,QAAQ,IAAI6B,QAAQ,EAAE;MACxB,OAAOD,CAAC,CAACE,QAAQ;IACnB;;IAEA;IACAD,QAAQ,CAACE,MAAM,CAAC,cAAc,EAAE,mBAAmB,CAAC;;IAEpD;IACA,IACE,CAAC/B,OAAO,CAACgC,IAAI,CAACC,UAAU,CAAC,eAAe,CAAC,IACzC,CAACjC,OAAO,CAACgC,IAAI,CAACC,UAAU,CAAC,eAAe,CAAC,IACzC,CAACjC,OAAO,CAACgC,IAAI,CAACC,UAAU,CAAC,UAAU,CAAC,EACpC;MACAJ,QAAQ,CAACE,MAAM,CAAC,eAAe,EAAE,UAAU,CAAC;IAC9C;IAEA,OAAOH,CAAC,CAACE,QAAQ;EACnB,CAAC,CAAC;EAEF,MAAMP,MAAM,CAACC,QAAQ,CAACrC,WAAW,CAAC;EAElC,MAAMoC,MAAM,CAACC,QAAQ,CAAC;IACpBtC,MAAM,EAAE;MACNgC,IAAI,EAAE,QAAQ;MACdM,QAAQ,EAAGD,MAAM,IAAK;QACpBA,MAAM,CAACW,KAAK,CAAC3C,YAAY,CAAC;QAC1BgC,MAAM,CAACW,KAAK,CAAC5C,cAA+B,CAAC;MAC/C;IACF;EACF,CAAC,CAAC;EAEF,MAAMiC,MAAM,CAACC,QAAQ,CAACvC,gBAAgB,CAAC;EAEvC,IAAIN,MAAM,CAACsB,GAAG,CAAC,gBAAgB,CAAC,KAAK,OAAO,EAAE;IAC5C,MAAMsB,MAAM,CAACC,QAAQ,CAAC/C,KAAK,CAAC;EAC9B;EAEA,MAAM8C,MAAM,CAACC,QAAQ,CAAC3C,cAAc,CAAC;EAErC,OAAO0C,MAAM;AACf","ignoreList":[]}

package/.server/server/plugins/engine/routes/questions.d.ts

@@ -1,4 +1,6 @@
-import { type RouteOptions, type ServerRoute } from '@hapi/hapi';
+import { type ResponseObject, type ResponseToolkit, type RouteOptions, type ServerRoute } from '@hapi/hapi';
 import { type PreparePageEventRequestOptions } from '~/src/server/plugins/engine/types.js';
-import { type FormRequestPayloadRefs, type FormRequestRefs } from '~/src/server/routes/types.js';
+import { type FormRequest, type FormRequestPayload, type FormRequestPayloadRefs, type FormRequestRefs } from '~/src/server/routes/types.js';
+export declare function makeGetHandler(preparePageEventRequestOptions?: PreparePageEventRequestOptions): (request: FormRequest, h: Pick<ResponseToolkit, "redirect" | "view">) => ResponseObject | Promise<ResponseObject>;
+export declare function makePostHandler(preparePageEventRequestOptions?: PreparePageEventRequestOptions): (request: FormRequestPayload, h: Pick<ResponseToolkit, "redirect" | "view">) => Promise<ResponseObject>;
 export declare function getRoutes(getRouteOptions: RouteOptions<FormRequestRefs>, postRouteOptions: RouteOptions<FormRequestPayloadRefs>, preparePageEventRequestOptions?: PreparePageEventRequestOptions): (ServerRoute<FormRequestRefs> | ServerRoute<FormRequestPayloadRefs>)[];

package/.server/server/plugins/engine/routes/questions.js

@@ -8,7 +8,33 @@ import { getFormSubmissionData } from "../pageControllers/SummaryPageController.
 import { dispatchHandler, redirectOrMakeHandler } from "./index.js";
 import { actionSchema, crumbSchema, itemIdSchema, pathSchema, stateSchema } from "../../../schemas/index.js";
 import * as httpService from "../../../services/httpService.js";
-function makeGetHandler(preparePageEventRequestOptions) {
+async function handleHttpEvent(request, page, context, event, model, preparePageEventRequestOptions) {
+  const {
+    options
+  } = event;
+  const {
+    url
+  } = options;
+
+  // TODO: Update structured data POST payload with when helper
+  // is updated to removing the dependency on `SummaryViewModel` etc.
+  const viewModel = new SummaryViewModel(request, page, context);
+  const items = getFormSubmissionData(viewModel.context, viewModel.details);
+
+  // @ts-expect-error - function signature will be refactored in the next iteration of the formatter
+  const payload = format(context, items, model, undefined, undefined);
+  const opts = {
+    payload
+  };
+  if (preparePageEventRequestOptions) {
+    preparePageEventRequestOptions(opts, event, page, context);
+  }
+  const {
+    payload: response
+  } = await httpService.postJson(url, opts);
+  Object.assign(context.data, response);
+}
+export function makeGetHandler(preparePageEventRequestOptions) {
   return function getHandler(request, h) {
     const {
       params
@@ -29,53 +55,51 @@ function makeGetHandler(preparePageEventRequestOptions) {
         throw Boom.notFound(`No model found for /${params.path}`);
       }
       if (events?.onLoad && events.onLoad.type === 'http') {
-        const {
-          options
-        } = events.onLoad;
-        const {
-          url
-        } = options;
-
-        // TODO: Update structured data POST payload with when helper
-        // is updated to removing the dependency on `SummaryViewModel` etc.
-        const viewModel = new SummaryViewModel(request, page, context);
-        const items = getFormSubmissionData(viewModel.context, viewModel.details);
-
-        // @ts-expect-error - function signature will be refactored in the next iteration of the formatter
-        const payload = format(context, items, model, undefined, undefined);
-        const opts = {
-          payload
-        };
-        if (preparePageEventRequestOptions) {
-          preparePageEventRequestOptions(opts, events.onLoad, page, context);
-        }
-        const {
-          payload: response
-        } = await httpService.postJson(url, opts);
-        Object.assign(context.data, response);
+        await handleHttpEvent(request, page, context, events.onLoad, model, preparePageEventRequestOptions);
       }
       return page.makeGetRouteHandler()(request, context, h);
     });
   };
 }
-function postHandler(request, h) {
-  const {
-    query
-  } = request;
-  return redirectOrMakeHandler(request, h, (page, context) => {
+export function makePostHandler(preparePageEventRequestOptions) {
+  return function postHandler(request, h) {
     const {
-      pageDef
-    } = page;
-    const {
-      isForceAccess
-    } = context;
+      query
+    } = request;
+    return redirectOrMakeHandler(request, h, async (page, context) => {
+      const {
+        pageDef
+      } = page;
+      const {
+        isForceAccess
+      } = context;
+      const {
+        model
+      } = request.app;
+      const {
+        events
+      } = page;
 
-    // Redirect to GET for preview URL direct access
-    if (isForceAccess && !hasFormComponents(pageDef)) {
-      return proceed(request, h, redirectPath(page.href, query));
-    }
-    return page.makePostRouteHandler()(request, context, h);
-  });
+      // Redirect to GET for preview URL direct access
+      if (isForceAccess && !hasFormComponents(pageDef)) {
+        return proceed(request, h, redirectPath(page.href, query));
+      }
+      if (!model) {
+        throw Boom.notFound(`No model found for /${request.params.path}`);
+      }
+      const response = await page.makePostRouteHandler()(request, context, h);
+      if (events?.onSave && events.onSave.type === 'http' && isSuccessful(response)) {
+        await handleHttpEvent(request, page, context, events.onSave, model, preparePageEventRequestOptions);
+      }
+      return response;
+    });
+  };
+}
+function isSuccessful(response) {
+  const {
+    statusCode
+  } = response;
+  return !Boom.isBoom(response) && statusCode >= 200 && statusCode < 400;
 }
 export function getRoutes(getRouteOptions, postRouteOptions, preparePageEventRequestOptions) {
   return [{
@@ -135,7 +159,7 @@ export function getRoutes(getRouteOptions, postRouteOptions, preparePageEventReq
   }, {
     method: 'post',
     path: '/{slug}/{path}/{itemId?}',
-    handler: postHandler,
+    handler: makePostHandler(preparePageEventRequestOptions),
     options: {
       ...postRouteOptions,
       validate: {
@@ -153,7 +177,7 @@ export function getRoutes(getRouteOptions, postRouteOptions, preparePageEventReq
   }, {
     method: 'post',
     path: '/preview/{state}/{slug}/{path}/{itemId?}',
-    handler: postHandler,
+    handler: makePostHandler(preparePageEventRequestOptions),
     options: {
       ...postRouteOptions,
       validate: {

package/.server/server/plugins/engine/routes/questions.js.map

@@ -1 +1 @@
-{"version":3,"file":"questions.js","names":["hasFormComponents","slugSchema","Boom","Joi","normalisePath","proceed","redirectPath","SummaryViewModel","format","getFormSubmissionData","dispatchHandler","redirectOrMakeHandler","actionSchema","crumbSchema","itemIdSchema","pathSchema","stateSchema","httpService","makeGetHandler","preparePageEventRequestOptions","getHandler","request","h","params","path","page","context","events","model","app","notFound","onLoad","type","options","url","viewModel","items","details","payload","undefined","opts","response","postJson","Object","assign","data","makeGetRouteHandler","postHandler","query","pageDef","isForceAccess","href","makePostRouteHandler","getRoutes","getRouteOptions","postRouteOptions","method","handler","validate","object","keys","slug","state","itemId","optional","crumb","action","unknown","required"],"sources":["../../../../../src/server/plugins/engine/routes/questions.ts"],"sourcesContent":["import { hasFormComponents, slugSchema } from '@defra/forms-model'\nimport Boom from '@hapi/boom'\nimport {\n  type ResponseToolkit,\n  type RouteOptions,\n  type ServerRoute\n} from '@hapi/hapi'\nimport Joi from 'joi'\n\nimport {\n  normalisePath,\n  proceed,\n  redirectPath\n} from '~/src/server/plugins/engine/helpers.js'\nimport { SummaryViewModel } from '~/src/server/plugins/engine/models/index.js'\nimport { format } from '~/src/server/plugins/engine/outputFormatters/machine/v1.js'\nimport { getFormSubmissionData } from '~/src/server/plugins/engine/pageControllers/SummaryPageController.js'\nimport {\n  dispatchHandler,\n  redirectOrMakeHandler\n} from '~/src/server/plugins/engine/routes/index.js'\nimport { type PreparePageEventRequestOptions } from '~/src/server/plugins/engine/types.js'\nimport {\n  type FormRequest,\n  type FormRequestPayload,\n  type FormRequestPayloadRefs,\n  type FormRequestRefs\n} from '~/src/server/routes/types.js'\nimport {\n  actionSchema,\n  crumbSchema,\n  itemIdSchema,\n  pathSchema,\n  stateSchema\n} from '~/src/server/schemas/index.js'\nimport * as httpService from '~/src/server/services/httpService.js'\n\nfunction makeGetHandler(\n  preparePageEventRequestOptions?: PreparePageEventRequestOptions\n) {\n  return function getHandler(\n    request: FormRequest,\n    h: Pick<ResponseToolkit, 'redirect' | 'view'>\n  ) {\n    const { params } = request\n\n    if (normalisePath(params.path) === '') {\n      return dispatchHandler(request, h)\n    }\n\n    return redirectOrMakeHandler(request, h, async (page, context) => {\n      // Check for a page onLoad HTTP event and if one exists,\n      // call it and assign the response to the context data\n      const { events } = page\n      const { model } = request.app\n\n      if (!model) {\n        throw Boom.notFound(`No model found for /${params.path}`)\n      }\n\n      if (events?.onLoad && events.onLoad.type === 'http') {\n        const { options } = events.onLoad\n        const { url } = options\n\n        // TODO: Update structured data POST payload with when helper\n        // is updated to removing the dependency on `SummaryViewModel` etc.\n        const viewModel = new SummaryViewModel(request, page, context)\n        const items = getFormSubmissionData(\n          viewModel.context,\n          viewModel.details\n        )\n\n        // @ts-expect-error - function signature will be refactored in the next iteration of the formatter\n        const payload = format(context, items, model, undefined, undefined)\n        const opts = { payload }\n\n        if (preparePageEventRequestOptions) {\n          preparePageEventRequestOptions(opts, events.onLoad, page, context)\n        }\n\n        const { payload: response } = await httpService.postJson(url, opts)\n\n        Object.assign(context.data, response)\n      }\n\n      return page.makeGetRouteHandler()(request, context, h)\n    })\n  }\n}\n\nfunction postHandler(\n  request: FormRequestPayload,\n  h: Pick<ResponseToolkit, 'redirect' | 'view'>\n) {\n  const { query } = request\n\n  return redirectOrMakeHandler(request, h, (page, context) => {\n    const { pageDef } = page\n    const { isForceAccess } = context\n\n    // Redirect to GET for preview URL direct access\n    if (isForceAccess && !hasFormComponents(pageDef)) {\n      return proceed(request, h, redirectPath(page.href, query))\n    }\n\n    return page.makePostRouteHandler()(request, context, h)\n  })\n}\n\nexport function getRoutes(\n  getRouteOptions: RouteOptions<FormRequestRefs>,\n  postRouteOptions: RouteOptions<FormRequestPayloadRefs>,\n  preparePageEventRequestOptions?: PreparePageEventRequestOptions\n): (ServerRoute<FormRequestRefs> | ServerRoute<FormRequestPayloadRefs>)[] {\n  return [\n    {\n      method: 'get',\n      path: '/{slug}',\n      handler: makeGetHandler(preparePageEventRequestOptions),\n      options: {\n        ...getRouteOptions,\n        validate: {\n          params: Joi.object().keys({\n            slug: slugSchema\n          })\n        }\n      }\n    },\n    {\n      method: 'get',\n      path: '/preview/{state}/{slug}',\n      handler: dispatchHandler,\n      options: {\n        ...getRouteOptions,\n        validate: {\n          params: Joi.object().keys({\n            state: stateSchema,\n            slug: slugSchema\n          })\n        }\n      }\n    },\n    {\n      method: 'get',\n      path: '/{slug}/{path}/{itemId?}',\n      handler: makeGetHandler(preparePageEventRequestOptions),\n      options: {\n        ...getRouteOptions,\n        validate: {\n          params: Joi.object().keys({\n            slug: slugSchema,\n            path: pathSchema,\n            itemId: itemIdSchema.optional()\n          })\n        }\n      }\n    },\n    {\n      method: 'get',\n      path: '/preview/{state}/{slug}/{path}/{itemId?}',\n      handler: makeGetHandler(preparePageEventRequestOptions),\n      options: {\n        ...getRouteOptions,\n        validate: {\n          params: Joi.object().keys({\n            state: stateSchema,\n            slug: slugSchema,\n            path: pathSchema,\n            itemId: itemIdSchema.optional()\n          })\n        }\n      }\n    },\n    {\n      method: 'post',\n      path: '/{slug}/{path}/{itemId?}',\n      handler: postHandler,\n      options: {\n        ...postRouteOptions,\n        validate: {\n          params: Joi.object().keys({\n            slug: slugSchema,\n            path: pathSchema,\n            itemId: itemIdSchema.optional()\n          }),\n          payload: Joi.object()\n            .keys({\n              crumb: crumbSchema,\n              action: actionSchema\n            })\n            .unknown(true)\n            .required()\n        }\n      }\n    },\n    {\n      method: 'post',\n      path: '/preview/{state}/{slug}/{path}/{itemId?}',\n      handler: postHandler,\n      options: {\n        ...postRouteOptions,\n        validate: {\n          params: Joi.object().keys({\n            state: stateSchema,\n            slug: slugSchema,\n            path: pathSchema,\n            itemId: itemIdSchema.optional()\n          }),\n          payload: Joi.object()\n            .keys({\n              crumb: crumbSchema,\n              action: actionSchema\n            })\n            .unknown(true)\n            .required()\n        }\n      }\n    }\n  ]\n}\n"],"mappings":"AAAA,SAASA,iBAAiB,EAAEC,UAAU,QAAQ,oBAAoB;AAClE,OAAOC,IAAI,MAAM,YAAY;AAM7B,OAAOC,GAAG,MAAM,KAAK;AAErB,SACEC,aAAa,EACbC,OAAO,EACPC,YAAY;AAEd,SAASC,gBAAgB;AACzB,SAASC,MAAM;AACf,SAASC,qBAAqB;AAC9B,SACEC,eAAe,EACfC,qBAAqB;AASvB,SACEC,YAAY,EACZC,WAAW,EACXC,YAAY,EACZC,UAAU,EACVC,WAAW;AAEb,OAAO,KAAKC,WAAW;AAEvB,SAASC,cAAcA,CACrBC,8BAA+D,EAC/D;EACA,OAAO,SAASC,UAAUA,CACxBC,OAAoB,EACpBC,CAA6C,EAC7C;IACA,MAAM;MAAEC;IAAO,CAAC,GAAGF,OAAO;IAE1B,IAAIjB,aAAa,CAACmB,MAAM,CAACC,IAAI,CAAC,KAAK,EAAE,EAAE;MACrC,OAAOd,eAAe,CAACW,OAAO,EAAEC,CAAC,CAAC;IACpC;IAEA,OAAOX,qBAAqB,CAACU,OAAO,EAAEC,CAAC,EAAE,OAAOG,IAAI,EAAEC,OAAO,KAAK;MAChE;MACA;MACA,MAAM;QAAEC;MAAO,CAAC,GAAGF,IAAI;MACvB,MAAM;QAAEG;MAAM,CAAC,GAAGP,OAAO,CAACQ,GAAG;MAE7B,IAAI,CAACD,KAAK,EAAE;QACV,MAAM1B,IAAI,CAAC4B,QAAQ,CAAC,uBAAuBP,MAAM,CAACC,IAAI,EAAE,CAAC;MAC3D;MAEA,IAAIG,MAAM,EAAEI,MAAM,IAAIJ,MAAM,CAACI,MAAM,CAACC,IAAI,KAAK,MAAM,EAAE;QACnD,MAAM;UAAEC;QAAQ,CAAC,GAAGN,MAAM,CAACI,MAAM;QACjC,MAAM;UAAEG;QAAI,CAAC,GAAGD,OAAO;;QAEvB;QACA;QACA,MAAME,SAAS,GAAG,IAAI5B,gBAAgB,CAACc,OAAO,EAAEI,IAAI,EAAEC,OAAO,CAAC;QAC9D,MAAMU,KAAK,GAAG3B,qBAAqB,CACjC0B,SAAS,CAACT,OAAO,EACjBS,SAAS,CAACE,OACZ,CAAC;;QAED;QACA,MAAMC,OAAO,GAAG9B,MAAM,CAACkB,OAAO,EAAEU,KAAK,EAAER,KAAK,EAAEW,SAAS,EAAEA,SAAS,CAAC;QACnE,MAAMC,IAAI,GAAG;UAAEF;QAAQ,CAAC;QAExB,IAAInB,8BAA8B,EAAE;UAClCA,8BAA8B,CAACqB,IAAI,EAAEb,MAAM,CAACI,MAAM,EAAEN,IAAI,EAAEC,OAAO,CAAC;QACpE;QAEA,MAAM;UAAEY,OAAO,EAAEG;QAAS,CAAC,GAAG,MAAMxB,WAAW,CAACyB,QAAQ,CAACR,GAAG,EAAEM,IAAI,CAAC;QAEnEG,MAAM,CAACC,MAAM,CAAClB,OAAO,CAACmB,IAAI,EAAEJ,QAAQ,CAAC;MACvC;MAEA,OAAOhB,IAAI,CAACqB,mBAAmB,CAAC,CAAC,CAACzB,OAAO,EAAEK,OAAO,EAAEJ,CAAC,CAAC;IACxD,CAAC,CAAC;EACJ,CAAC;AACH;AAEA,SAASyB,WAAWA,CAClB1B,OAA2B,EAC3BC,CAA6C,EAC7C;EACA,MAAM;IAAE0B;EAAM,CAAC,GAAG3B,OAAO;EAEzB,OAAOV,qBAAqB,CAACU,OAAO,EAAEC,CAAC,EAAE,CAACG,IAAI,EAAEC,OAAO,KAAK;IAC1D,MAAM;MAAEuB;IAAQ,CAAC,GAAGxB,IAAI;IACxB,MAAM;MAAEyB;IAAc,CAAC,GAAGxB,OAAO;;IAEjC;IACA,IAAIwB,aAAa,IAAI,CAAClD,iBAAiB,CAACiD,OAAO,CAAC,EAAE;MAChD,OAAO5C,OAAO,CAACgB,OAAO,EAAEC,CAAC,EAAEhB,YAAY,CAACmB,IAAI,CAAC0B,IAAI,EAAEH,KAAK,CAAC,CAAC;IAC5D;IAEA,OAAOvB,IAAI,CAAC2B,oBAAoB,CAAC,CAAC,CAAC/B,OAAO,EAAEK,OAAO,EAAEJ,CAAC,CAAC;EACzD,CAAC,CAAC;AACJ;AAEA,OAAO,SAAS+B,SAASA,CACvBC,eAA8C,EAC9CC,gBAAsD,EACtDpC,8BAA+D,EACS;EACxE,OAAO,CACL;IACEqC,MAAM,EAAE,KAAK;IACbhC,IAAI,EAAE,SAAS;IACfiC,OAAO,EAAEvC,cAAc,CAACC,8BAA8B,CAAC;IACvDc,OAAO,EAAE;MACP,GAAGqB,eAAe;MAClBI,QAAQ,EAAE;QACRnC,MAAM,EAAEpB,GAAG,CAACwD,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC;UACxBC,IAAI,EAAE5D;QACR,CAAC;MACH;IACF;EACF,CAAC,EACD;IACEuD,MAAM,EAAE,KAAK;IACbhC,IAAI,EAAE,yBAAyB;IAC/BiC,OAAO,EAAE/C,eAAe;IACxBuB,OAAO,EAAE;MACP,GAAGqB,eAAe;MAClBI,QAAQ,EAAE;QACRnC,MAAM,EAAEpB,GAAG,CAACwD,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC;UACxBE,KAAK,EAAE9C,WAAW;UAClB6C,IAAI,EAAE5D;QACR,CAAC;MACH;IACF;EACF,CAAC,EACD;IACEuD,MAAM,EAAE,KAAK;IACbhC,IAAI,EAAE,0BAA0B;IAChCiC,OAAO,EAAEvC,cAAc,CAACC,8BAA8B,CAAC;IACvDc,OAAO,EAAE;MACP,GAAGqB,eAAe;MAClBI,QAAQ,EAAE;QACRnC,MAAM,EAAEpB,GAAG,CAACwD,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC;UACxBC,IAAI,EAAE5D,UAAU;UAChBuB,IAAI,EAAET,UAAU;UAChBgD,MAAM,EAAEjD,YAAY,CAACkD,QAAQ,CAAC;QAChC,CAAC;MACH;IACF;EACF,CAAC,EACD;IACER,MAAM,EAAE,KAAK;IACbhC,IAAI,EAAE,0CAA0C;IAChDiC,OAAO,EAAEvC,cAAc,CAACC,8BAA8B,CAAC;IACvDc,OAAO,EAAE;MACP,GAAGqB,eAAe;MAClBI,QAAQ,EAAE;QACRnC,MAAM,EAAEpB,GAAG,CAACwD,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC;UACxBE,KAAK,EAAE9C,WAAW;UAClB6C,IAAI,EAAE5D,UAAU;UAChBuB,IAAI,EAAET,UAAU;UAChBgD,MAAM,EAAEjD,YAAY,CAACkD,QAAQ,CAAC;QAChC,CAAC;MACH;IACF;EACF,CAAC,EACD;IACER,MAAM,EAAE,MAAM;IACdhC,IAAI,EAAE,0BAA0B;IAChCiC,OAAO,EAAEV,WAAW;IACpBd,OAAO,EAAE;MACP,GAAGsB,gBAAgB;MACnBG,QAAQ,EAAE;QACRnC,MAAM,EAAEpB,GAAG,CAACwD,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC;UACxBC,IAAI,EAAE5D,UAAU;UAChBuB,IAAI,EAAET,UAAU;UAChBgD,MAAM,EAAEjD,YAAY,CAACkD,QAAQ,CAAC;QAChC,CAAC,CAAC;QACF1B,OAAO,EAAEnC,GAAG,CAACwD,MAAM,CAAC,CAAC,CAClBC,IAAI,CAAC;UACJK,KAAK,EAAEpD,WAAW;UAClBqD,MAAM,EAAEtD;QACV,CAAC,CAAC,CACDuD,OAAO,CAAC,IAAI,CAAC,CACbC,QAAQ,CAAC;MACd;IACF;EACF,CAAC,EACD;IACEZ,MAAM,EAAE,MAAM;IACdhC,IAAI,EAAE,0CAA0C;IAChDiC,OAAO,EAAEV,WAAW;IACpBd,OAAO,EAAE;MACP,GAAGsB,gBAAgB;MACnBG,QAAQ,EAAE;QACRnC,MAAM,EAAEpB,GAAG,CAACwD,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC;UACxBE,KAAK,EAAE9C,WAAW;UAClB6C,IAAI,EAAE5D,UAAU;UAChBuB,IAAI,EAAET,UAAU;UAChBgD,MAAM,EAAEjD,YAAY,CAACkD,QAAQ,CAAC;QAChC,CAAC,CAAC;QACF1B,OAAO,EAAEnC,GAAG,CAACwD,MAAM,CAAC,CAAC,CAClBC,IAAI,CAAC;UACJK,KAAK,EAAEpD,WAAW;UAClBqD,MAAM,EAAEtD;QACV,CAAC,CAAC,CACDuD,OAAO,CAAC,IAAI,CAAC,CACbC,QAAQ,CAAC;MACd;IACF;EACF,CAAC,CACF;AACH","ignoreList":[]}
+{"version":3,"file":"questions.js","names":["hasFormComponents","slugSchema","Boom","Joi","normalisePath","proceed","redirectPath","SummaryViewModel","format","getFormSubmissionData","dispatchHandler","redirectOrMakeHandler","actionSchema","crumbSchema","itemIdSchema","pathSchema","stateSchema","httpService","handleHttpEvent","request","page","context","event","model","preparePageEventRequestOptions","options","url","viewModel","items","details","payload","undefined","opts","response","postJson","Object","assign","data","makeGetHandler","getHandler","h","params","path","events","app","notFound","onLoad","type","makeGetRouteHandler","makePostHandler","postHandler","query","pageDef","isForceAccess","href","makePostRouteHandler","onSave","isSuccessful","statusCode","isBoom","getRoutes","getRouteOptions","postRouteOptions","method","handler","validate","object","keys","slug","state","itemId","optional","crumb","action","unknown","required"],"sources":["../../../../../src/server/plugins/engine/routes/questions.ts"],"sourcesContent":["import { hasFormComponents, slugSchema, type Event } from '@defra/forms-model'\nimport Boom from '@hapi/boom'\nimport {\n  type ResponseObject,\n  type ResponseToolkit,\n  type RouteOptions,\n  type ServerRoute\n} from '@hapi/hapi'\nimport Joi from 'joi'\n\nimport {\n  normalisePath,\n  proceed,\n  redirectPath\n} from '~/src/server/plugins/engine/helpers.js'\nimport {\n  SummaryViewModel,\n  type FormModel\n} from '~/src/server/plugins/engine/models/index.js'\nimport { format } from '~/src/server/plugins/engine/outputFormatters/machine/v1.js'\nimport { getFormSubmissionData } from '~/src/server/plugins/engine/pageControllers/SummaryPageController.js'\nimport { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers.js'\nimport {\n  dispatchHandler,\n  redirectOrMakeHandler\n} from '~/src/server/plugins/engine/routes/index.js'\nimport {\n  type FormContext,\n  type PreparePageEventRequestOptions\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  type FormRequest,\n  type FormRequestPayload,\n  type FormRequestPayloadRefs,\n  type FormRequestRefs\n} from '~/src/server/routes/types.js'\nimport {\n  actionSchema,\n  crumbSchema,\n  itemIdSchema,\n  pathSchema,\n  stateSchema\n} from '~/src/server/schemas/index.js'\nimport * as httpService from '~/src/server/services/httpService.js'\n\nasync function handleHttpEvent(\n  request: FormRequest | FormRequestPayload,\n  page: PageControllerClass,\n  context: FormContext,\n  event: Event,\n  model: FormModel,\n  preparePageEventRequestOptions?: PreparePageEventRequestOptions\n) {\n  const { options } = event\n  const { url } = options\n\n  // TODO: Update structured data POST payload with when helper\n  // is updated to removing the dependency on `SummaryViewModel` etc.\n  const viewModel = new SummaryViewModel(request, page, context)\n  const items = getFormSubmissionData(viewModel.context, viewModel.details)\n\n  // @ts-expect-error - function signature will be refactored in the next iteration of the formatter\n  const payload = format(context, items, model, undefined, undefined)\n  const opts = { payload }\n\n  if (preparePageEventRequestOptions) {\n    preparePageEventRequestOptions(opts, event, page, context)\n  }\n\n  const { payload: response } = await httpService.postJson(url, opts)\n\n  Object.assign(context.data, response)\n}\n\nexport function makeGetHandler(\n  preparePageEventRequestOptions?: PreparePageEventRequestOptions\n) {\n  return function getHandler(\n    request: FormRequest,\n    h: Pick<ResponseToolkit, 'redirect' | 'view'>\n  ) {\n    const { params } = request\n\n    if (normalisePath(params.path) === '') {\n      return dispatchHandler(request, h)\n    }\n\n    return redirectOrMakeHandler(request, h, async (page, context) => {\n      // Check for a page onLoad HTTP event and if one exists,\n      // call it and assign the response to the context data\n      const { events } = page\n      const { model } = request.app\n\n      if (!model) {\n        throw Boom.notFound(`No model found for /${params.path}`)\n      }\n\n      if (events?.onLoad && events.onLoad.type === 'http') {\n        await handleHttpEvent(\n          request,\n          page,\n          context,\n          events.onLoad,\n          model,\n          preparePageEventRequestOptions\n        )\n      }\n\n      return page.makeGetRouteHandler()(request, context, h)\n    })\n  }\n}\n\nexport function makePostHandler(\n  preparePageEventRequestOptions?: PreparePageEventRequestOptions\n) {\n  return function postHandler(\n    request: FormRequestPayload,\n    h: Pick<ResponseToolkit, 'redirect' | 'view'>\n  ) {\n    const { query } = request\n\n    return redirectOrMakeHandler(request, h, async (page, context) => {\n      const { pageDef } = page\n      const { isForceAccess } = context\n      const { model } = request.app\n      const { events } = page\n\n      // Redirect to GET for preview URL direct access\n      if (isForceAccess && !hasFormComponents(pageDef)) {\n        return proceed(request, h, redirectPath(page.href, query))\n      }\n\n      if (!model) {\n        throw Boom.notFound(`No model found for /${request.params.path}`)\n      }\n\n      const response = await page.makePostRouteHandler()(request, context, h)\n\n      if (\n        events?.onSave &&\n        events.onSave.type === 'http' &&\n        isSuccessful(response)\n      ) {\n        await handleHttpEvent(\n          request,\n          page,\n          context,\n          events.onSave,\n          model,\n          preparePageEventRequestOptions\n        )\n      }\n\n      return response\n    })\n  }\n}\n\nfunction isSuccessful(response: ResponseObject): boolean {\n  const { statusCode } = response\n\n  return !Boom.isBoom(response) && statusCode >= 200 && statusCode < 400\n}\n\nexport function getRoutes(\n  getRouteOptions: RouteOptions<FormRequestRefs>,\n  postRouteOptions: RouteOptions<FormRequestPayloadRefs>,\n  preparePageEventRequestOptions?: PreparePageEventRequestOptions\n): (ServerRoute<FormRequestRefs> | ServerRoute<FormRequestPayloadRefs>)[] {\n  return [\n    {\n      method: 'get',\n      path: '/{slug}',\n      handler: makeGetHandler(preparePageEventRequestOptions),\n      options: {\n        ...getRouteOptions,\n        validate: {\n          params: Joi.object().keys({\n            slug: slugSchema\n          })\n        }\n      }\n    },\n    {\n      method: 'get',\n      path: '/preview/{state}/{slug}',\n      handler: dispatchHandler,\n      options: {\n        ...getRouteOptions,\n        validate: {\n          params: Joi.object().keys({\n            state: stateSchema,\n            slug: slugSchema\n          })\n        }\n      }\n    },\n    {\n      method: 'get',\n      path: '/{slug}/{path}/{itemId?}',\n      handler: makeGetHandler(preparePageEventRequestOptions),\n      options: {\n        ...getRouteOptions,\n        validate: {\n          params: Joi.object().keys({\n            slug: slugSchema,\n            path: pathSchema,\n            itemId: itemIdSchema.optional()\n          })\n        }\n      }\n    },\n    {\n      method: 'get',\n      path: '/preview/{state}/{slug}/{path}/{itemId?}',\n      handler: makeGetHandler(preparePageEventRequestOptions),\n      options: {\n        ...getRouteOptions,\n        validate: {\n          params: Joi.object().keys({\n            state: stateSchema,\n            slug: slugSchema,\n            path: pathSchema,\n            itemId: itemIdSchema.optional()\n          })\n        }\n      }\n    },\n    {\n      method: 'post',\n      path: '/{slug}/{path}/{itemId?}',\n      handler: makePostHandler(preparePageEventRequestOptions),\n      options: {\n        ...postRouteOptions,\n        validate: {\n          params: Joi.object().keys({\n            slug: slugSchema,\n            path: pathSchema,\n            itemId: itemIdSchema.optional()\n          }),\n          payload: Joi.object()\n            .keys({\n              crumb: crumbSchema,\n              action: actionSchema\n            })\n            .unknown(true)\n            .required()\n        }\n      }\n    },\n    {\n      method: 'post',\n      path: '/preview/{state}/{slug}/{path}/{itemId?}',\n      handler: makePostHandler(preparePageEventRequestOptions),\n      options: {\n        ...postRouteOptions,\n        validate: {\n          params: Joi.object().keys({\n            state: stateSchema,\n            slug: slugSchema,\n            path: pathSchema,\n            itemId: itemIdSchema.optional()\n          }),\n          payload: Joi.object()\n            .keys({\n              crumb: crumbSchema,\n              action: actionSchema\n            })\n            .unknown(true)\n            .required()\n        }\n      }\n    }\n  ]\n}\n"],"mappings":"AAAA,SAASA,iBAAiB,EAAEC,UAAU,QAAoB,oBAAoB;AAC9E,OAAOC,IAAI,MAAM,YAAY;AAO7B,OAAOC,GAAG,MAAM,KAAK;AAErB,SACEC,aAAa,EACbC,OAAO,EACPC,YAAY;AAEd,SACEC,gBAAgB;AAGlB,SAASC,MAAM;AACf,SAASC,qBAAqB;AAE9B,SACEC,eAAe,EACfC,qBAAqB;AAYvB,SACEC,YAAY,EACZC,WAAW,EACXC,YAAY,EACZC,UAAU,EACVC,WAAW;AAEb,OAAO,KAAKC,WAAW;AAEvB,eAAeC,eAAeA,CAC5BC,OAAyC,EACzCC,IAAyB,EACzBC,OAAoB,EACpBC,KAAY,EACZC,KAAgB,EAChBC,8BAA+D,EAC/D;EACA,MAAM;IAAEC;EAAQ,CAAC,GAAGH,KAAK;EACzB,MAAM;IAAEI;EAAI,CAAC,GAAGD,OAAO;;EAEvB;EACA;EACA,MAAME,SAAS,GAAG,IAAIpB,gBAAgB,CAACY,OAAO,EAAEC,IAAI,EAAEC,OAAO,CAAC;EAC9D,MAAMO,KAAK,GAAGnB,qBAAqB,CAACkB,SAAS,CAACN,OAAO,EAAEM,SAAS,CAACE,OAAO,CAAC;;EAEzE;EACA,MAAMC,OAAO,GAAGtB,MAAM,CAACa,OAAO,EAAEO,KAAK,EAAEL,KAAK,EAAEQ,SAAS,EAAEA,SAAS,CAAC;EACnE,MAAMC,IAAI,GAAG;IAAEF;EAAQ,CAAC;EAExB,IAAIN,8BAA8B,EAAE;IAClCA,8BAA8B,CAACQ,IAAI,EAAEV,KAAK,EAAEF,IAAI,EAAEC,OAAO,CAAC;EAC5D;EAEA,MAAM;IAAES,OAAO,EAAEG;EAAS,CAAC,GAAG,MAAMhB,WAAW,CAACiB,QAAQ,CAACR,GAAG,EAAEM,IAAI,CAAC;EAEnEG,MAAM,CAACC,MAAM,CAACf,OAAO,CAACgB,IAAI,EAAEJ,QAAQ,CAAC;AACvC;AAEA,OAAO,SAASK,cAAcA,CAC5Bd,8BAA+D,EAC/D;EACA,OAAO,SAASe,UAAUA,CACxBpB,OAAoB,EACpBqB,CAA6C,EAC7C;IACA,MAAM;MAAEC;IAAO,CAAC,GAAGtB,OAAO;IAE1B,IAAIf,aAAa,CAACqC,MAAM,CAACC,IAAI,CAAC,KAAK,EAAE,EAAE;MACrC,OAAOhC,eAAe,CAACS,OAAO,EAAEqB,CAAC,CAAC;IACpC;IAEA,OAAO7B,qBAAqB,CAACQ,OAAO,EAAEqB,CAAC,EAAE,OAAOpB,IAAI,EAAEC,OAAO,KAAK;MAChE;MACA;MACA,MAAM;QAAEsB;MAAO,CAAC,GAAGvB,IAAI;MACvB,MAAM;QAAEG;MAAM,CAAC,GAAGJ,OAAO,CAACyB,GAAG;MAE7B,IAAI,CAACrB,KAAK,EAAE;QACV,MAAMrB,IAAI,CAAC2C,QAAQ,CAAC,uBAAuBJ,MAAM,CAACC,IAAI,EAAE,CAAC;MAC3D;MAEA,IAAIC,MAAM,EAAEG,MAAM,IAAIH,MAAM,CAACG,MAAM,CAACC,IAAI,KAAK,MAAM,EAAE;QACnD,MAAM7B,eAAe,CACnBC,OAAO,EACPC,IAAI,EACJC,OAAO,EACPsB,MAAM,CAACG,MAAM,EACbvB,KAAK,EACLC,8BACF,CAAC;MACH;MAEA,OAAOJ,IAAI,CAAC4B,mBAAmB,CAAC,CAAC,CAAC7B,OAAO,EAAEE,OAAO,EAAEmB,CAAC,CAAC;IACxD,CAAC,CAAC;EACJ,CAAC;AACH;AAEA,OAAO,SAASS,eAAeA,CAC7BzB,8BAA+D,EAC/D;EACA,OAAO,SAAS0B,WAAWA,CACzB/B,OAA2B,EAC3BqB,CAA6C,EAC7C;IACA,MAAM;MAAEW;IAAM,CAAC,GAAGhC,OAAO;IAEzB,OAAOR,qBAAqB,CAACQ,OAAO,EAAEqB,CAAC,EAAE,OAAOpB,IAAI,EAAEC,OAAO,KAAK;MAChE,MAAM;QAAE+B;MAAQ,CAAC,GAAGhC,IAAI;MACxB,MAAM;QAAEiC;MAAc,CAAC,GAAGhC,OAAO;MACjC,MAAM;QAAEE;MAAM,CAAC,GAAGJ,OAAO,CAACyB,GAAG;MAC7B,MAAM;QAAED;MAAO,CAAC,GAAGvB,IAAI;;MAEvB;MACA,IAAIiC,aAAa,IAAI,CAACrD,iBAAiB,CAACoD,OAAO,CAAC,EAAE;QAChD,OAAO/C,OAAO,CAACc,OAAO,EAAEqB,CAAC,EAAElC,YAAY,CAACc,IAAI,CAACkC,IAAI,EAAEH,KAAK,CAAC,CAAC;MAC5D;MAEA,IAAI,CAAC5B,KAAK,EAAE;QACV,MAAMrB,IAAI,CAAC2C,QAAQ,CAAC,uBAAuB1B,OAAO,CAACsB,MAAM,CAACC,IAAI,EAAE,CAAC;MACnE;MAEA,MAAMT,QAAQ,GAAG,MAAMb,IAAI,CAACmC,oBAAoB,CAAC,CAAC,CAACpC,OAAO,EAAEE,OAAO,EAAEmB,CAAC,CAAC;MAEvE,IACEG,MAAM,EAAEa,MAAM,IACdb,MAAM,CAACa,MAAM,CAACT,IAAI,KAAK,MAAM,IAC7BU,YAAY,CAACxB,QAAQ,CAAC,EACtB;QACA,MAAMf,eAAe,CACnBC,OAAO,EACPC,IAAI,EACJC,OAAO,EACPsB,MAAM,CAACa,MAAM,EACbjC,KAAK,EACLC,8BACF,CAAC;MACH;MAEA,OAAOS,QAAQ;IACjB,CAAC,CAAC;EACJ,CAAC;AACH;AAEA,SAASwB,YAAYA,CAACxB,QAAwB,EAAW;EACvD,MAAM;IAAEyB;EAAW,CAAC,GAAGzB,QAAQ;EAE/B,OAAO,CAAC/B,IAAI,CAACyD,MAAM,CAAC1B,QAAQ,CAAC,IAAIyB,UAAU,IAAI,GAAG,IAAIA,UAAU,GAAG,GAAG;AACxE;AAEA,OAAO,SAASE,SAASA,CACvBC,eAA8C,EAC9CC,gBAAsD,EACtDtC,8BAA+D,EACS;EACxE,OAAO,CACL;IACEuC,MAAM,EAAE,KAAK;IACbrB,IAAI,EAAE,SAAS;IACfsB,OAAO,EAAE1B,cAAc,CAACd,8BAA8B,CAAC;IACvDC,OAAO,EAAE;MACP,GAAGoC,eAAe;MAClBI,QAAQ,EAAE;QACRxB,MAAM,EAAEtC,GAAG,CAAC+D,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC;UACxBC,IAAI,EAAEnE;QACR,CAAC;MACH;IACF;EACF,CAAC,EACD;IACE8D,MAAM,EAAE,KAAK;IACbrB,IAAI,EAAE,yBAAyB;IAC/BsB,OAAO,EAAEtD,eAAe;IACxBe,OAAO,EAAE;MACP,GAAGoC,eAAe;MAClBI,QAAQ,EAAE;QACRxB,MAAM,EAAEtC,GAAG,CAAC+D,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC;UACxBE,KAAK,EAAErD,WAAW;UAClBoD,IAAI,EAAEnE;QACR,CAAC;MACH;IACF;EACF,CAAC,EACD;IACE8D,MAAM,EAAE,KAAK;IACbrB,IAAI,EAAE,0BAA0B;IAChCsB,OAAO,EAAE1B,cAAc,CAACd,8BAA8B,CAAC;IACvDC,OAAO,EAAE;MACP,GAAGoC,eAAe;MAClBI,QAAQ,EAAE;QACRxB,MAAM,EAAEtC,GAAG,CAAC+D,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC;UACxBC,IAAI,EAAEnE,UAAU;UAChByC,IAAI,EAAE3B,UAAU;UAChBuD,MAAM,EAAExD,YAAY,CAACyD,QAAQ,CAAC;QAChC,CAAC;MACH;IACF;EACF,CAAC,EACD;IACER,MAAM,EAAE,KAAK;IACbrB,IAAI,EAAE,0CAA0C;IAChDsB,OAAO,EAAE1B,cAAc,CAACd,8BAA8B,CAAC;IACvDC,OAAO,EAAE;MACP,GAAGoC,eAAe;MAClBI,QAAQ,EAAE;QACRxB,MAAM,EAAEtC,GAAG,CAAC+D,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC;UACxBE,KAAK,EAAErD,WAAW;UAClBoD,IAAI,EAAEnE,UAAU;UAChByC,IAAI,EAAE3B,UAAU;UAChBuD,MAAM,EAAExD,YAAY,CAACyD,QAAQ,CAAC;QAChC,CAAC;MACH;IACF;EACF,CAAC,EACD;IACER,MAAM,EAAE,MAAM;IACdrB,IAAI,EAAE,0BAA0B;IAChCsB,OAAO,EAAEf,eAAe,CAACzB,8BAA8B,CAAC;IACxDC,OAAO,EAAE;MACP,GAAGqC,gBAAgB;MACnBG,QAAQ,EAAE;QACRxB,MAAM,EAAEtC,GAAG,CAAC+D,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC;UACxBC,IAAI,EAAEnE,UAAU;UAChByC,IAAI,EAAE3B,UAAU;UAChBuD,MAAM,EAAExD,YAAY,CAACyD,QAAQ,CAAC;QAChC,CAAC,CAAC;QACFzC,OAAO,EAAE3B,GAAG,CAAC+D,MAAM,CAAC,CAAC,CAClBC,IAAI,CAAC;UACJK,KAAK,EAAE3D,WAAW;UAClB4D,MAAM,EAAE7D;QACV,CAAC,CAAC,CACD8D,OAAO,CAAC,IAAI,CAAC,CACbC,QAAQ,CAAC;MACd;IACF;EACF,CAAC,EACD;IACEZ,MAAM,EAAE,MAAM;IACdrB,IAAI,EAAE,0CAA0C;IAChDsB,OAAO,EAAEf,eAAe,CAACzB,8BAA8B,CAAC;IACxDC,OAAO,EAAE;MACP,GAAGqC,gBAAgB;MACnBG,QAAQ,EAAE;QACRxB,MAAM,EAAEtC,GAAG,CAAC+D,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC;UACxBE,KAAK,EAAErD,WAAW;UAClBoD,IAAI,EAAEnE,UAAU;UAChByC,IAAI,EAAE3B,UAAU;UAChBuD,MAAM,EAAExD,YAAY,CAACyD,QAAQ,CAAC;QAChC,CAAC,CAAC;QACFzC,OAAO,EAAE3B,GAAG,CAAC+D,MAAM,CAAC,CAAC,CAClBC,IAAI,CAAC;UACJK,KAAK,EAAE3D,WAAW;UAClB4D,MAAM,EAAE7D;QACV,CAAC,CAAC,CACD8D,OAAO,CAAC,IAAI,CAAC,CACbC,QAAQ,CAAC;MACd;IACF;EACF,CAAC,CACF;AACH","ignoreList":[]}

package/.server/server/plugins/engine/services/localFormsService.js

@@ -32,20 +32,18 @@ export const formsService = async () => {
   // Instantiate the file loader form service
   const loader = new FileFormService();
 
-  // Add a Json form
-  await loader.addForm('src/server/forms/register-as-a-unicorn-breeder.json', {
+  // Add a Yaml form
+  await loader.addForm('src/server/forms/register-as-a-unicorn-breeder.yaml', {
     ...metadata,
-    id: '95e92559-968d-44ae-8666-2b1ad3dffd31',
+    id: '641aeafd-13dd-40fa-9186-001703800efb',
     title: 'Register as a unicorn breeder',
     slug: 'register-as-a-unicorn-breeder'
   });
-
-  // Add a Yaml form
-  await loader.addForm('src/server/forms/register-as-a-unicorn-breeder.yaml', {
+  await loader.addForm('src/server/forms/page-events.yaml', {
     ...metadata,
-    id: '641aeafd-13dd-40fa-9186-001703800efb',
-    title: 'Register as a unicorn breeder (yaml)',
-    slug: 'register-as-a-unicorn-breeder-yaml' // if we needed to validate any JSON logic, make it available for convenience
+    id: '511db05e-ebbd-42e8-8270-5fe93f5c9762',
+    title: 'Page events demo',
+    slug: 'page-events-demo'
   });
   await loader.addForm('src/server/forms/components.json', {
     ...metadata,

package/.server/server/plugins/engine/services/localFormsService.js.map

@@ -1 +1 @@
-{"version":3,"file":"localFormsService.js","names":["config","FileFormService","now","Date","user","id","displayName","author","createdAt","createdBy","updatedAt","updatedBy","metadata","organisation","teamName","teamEmail","submissionGuidance","notificationEmail","get","live","formsService","loader","addForm","title","slug","toFormsService"],"sources":["../../../../../src/server/plugins/engine/services/localFormsService.js"],"sourcesContent":["import { config } from '~/src/config/index.js'\nimport { FileFormService } from '~/src/server/utils/file-form-service.js'\n\n// Create shared form metadata\nconst now = new Date()\nconst user = { id: 'user', displayName: 'Username' }\nconst author = {\n  createdAt: now,\n  createdBy: user,\n  updatedAt: now,\n  updatedBy: user\n}\nconst metadata = {\n  organisation: 'Defra',\n  teamName: 'Team name',\n  teamEmail: 'team@defra.gov.uk',\n  submissionGuidance: \"Thanks for your submission, we'll be in touch\",\n  notificationEmail: config.get('submissionEmailAddress'),\n  ...author,\n  live: author\n}\n\n/**\n * Return an function rather than the service directly. This is to prevent consumer applications\n * blowing up as they won't have these files on disk. We can defer the execution until when it's\n * needed, i.e. the createServer function of the devtool.\n */\nexport const formsService = async () => {\n  // Instantiate the file loader form service\n  const loader = new FileFormService()\n\n  // Add a Json form\n  await loader.addForm('src/server/forms/register-as-a-unicorn-breeder.json', {\n    ...metadata,\n    id: '95e92559-968d-44ae-8666-2b1ad3dffd31',\n    title: 'Register as a unicorn breeder',\n    slug: 'register-as-a-unicorn-breeder'\n  })\n\n  // Add a Yaml form\n  await loader.addForm('src/server/forms/register-as-a-unicorn-breeder.yaml', {\n    ...metadata,\n    id: '641aeafd-13dd-40fa-9186-001703800efb',\n    title: 'Register as a unicorn breeder (yaml)',\n    slug: 'register-as-a-unicorn-breeder-yaml' // if we needed to validate any JSON logic, make it available for convenience\n  })\n\n  await loader.addForm('src/server/forms/components.json', {\n    ...metadata,\n    id: '6a872d3b-13f9e-804ce3e-4830-5c45fb32',\n    title: 'Components',\n    slug: 'components'\n  })\n\n  return loader.toFormsService()\n}\n"],"mappings":"AAAA,SAASA,MAAM;AACf,SAASC,eAAe;;AAExB;AACA,MAAMC,GAAG,GAAG,IAAIC,IAAI,CAAC,CAAC;AACtB,MAAMC,IAAI,GAAG;EAAEC,EAAE,EAAE,MAAM;EAAEC,WAAW,EAAE;AAAW,CAAC;AACpD,MAAMC,MAAM,GAAG;EACbC,SAAS,EAAEN,GAAG;EACdO,SAAS,EAAEL,IAAI;EACfM,SAAS,EAAER,GAAG;EACdS,SAAS,EAAEP;AACb,CAAC;AACD,MAAMQ,QAAQ,GAAG;EACfC,YAAY,EAAE,OAAO;EACrBC,QAAQ,EAAE,WAAW;EACrBC,SAAS,EAAE,mBAAmB;EAC9BC,kBAAkB,EAAE,+CAA+C;EACnEC,iBAAiB,EAAEjB,MAAM,CAACkB,GAAG,CAAC,wBAAwB,CAAC;EACvD,GAAGX,MAAM;EACTY,IAAI,EAAEZ;AACR,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMa,YAAY,GAAG,MAAAA,CAAA,KAAY;EACtC;EACA,MAAMC,MAAM,GAAG,IAAIpB,eAAe,CAAC,CAAC;;EAEpC;EACA,MAAMoB,MAAM,CAACC,OAAO,CAAC,qDAAqD,EAAE;IAC1E,GAAGV,QAAQ;IACXP,EAAE,EAAE,sCAAsC;IAC1CkB,KAAK,EAAE,+BAA+B;IACtCC,IAAI,EAAE;EACR,CAAC,CAAC;;EAEF;EACA,MAAMH,MAAM,CAACC,OAAO,CAAC,qDAAqD,EAAE;IAC1E,GAAGV,QAAQ;IACXP,EAAE,EAAE,sCAAsC;IAC1CkB,KAAK,EAAE,sCAAsC;IAC7CC,IAAI,EAAE,oCAAoC,CAAC;EAC7C,CAAC,CAAC;EAEF,MAAMH,MAAM,CAACC,OAAO,CAAC,kCAAkC,EAAE;IACvD,GAAGV,QAAQ;IACXP,EAAE,EAAE,sCAAsC;IAC1CkB,KAAK,EAAE,YAAY;IACnBC,IAAI,EAAE;EACR,CAAC,CAAC;EAEF,OAAOH,MAAM,CAACI,cAAc,CAAC,CAAC;AAChC,CAAC","ignoreList":[]}
+{"version":3,"file":"localFormsService.js","names":["config","FileFormService","now","Date","user","id","displayName","author","createdAt","createdBy","updatedAt","updatedBy","metadata","organisation","teamName","teamEmail","submissionGuidance","notificationEmail","get","live","formsService","loader","addForm","title","slug","toFormsService"],"sources":["../../../../../src/server/plugins/engine/services/localFormsService.js"],"sourcesContent":["import { config } from '~/src/config/index.js'\nimport { FileFormService } from '~/src/server/utils/file-form-service.js'\n\n// Create shared form metadata\nconst now = new Date()\nconst user = { id: 'user', displayName: 'Username' }\nconst author = {\n  createdAt: now,\n  createdBy: user,\n  updatedAt: now,\n  updatedBy: user\n}\nconst metadata = {\n  organisation: 'Defra',\n  teamName: 'Team name',\n  teamEmail: 'team@defra.gov.uk',\n  submissionGuidance: \"Thanks for your submission, we'll be in touch\",\n  notificationEmail: config.get('submissionEmailAddress'),\n  ...author,\n  live: author\n}\n\n/**\n * Return an function rather than the service directly. This is to prevent consumer applications\n * blowing up as they won't have these files on disk. We can defer the execution until when it's\n * needed, i.e. the createServer function of the devtool.\n */\nexport const formsService = async () => {\n  // Instantiate the file loader form service\n  const loader = new FileFormService()\n\n  // Add a Yaml form\n  await loader.addForm('src/server/forms/register-as-a-unicorn-breeder.yaml', {\n    ...metadata,\n    id: '641aeafd-13dd-40fa-9186-001703800efb',\n    title: 'Register as a unicorn breeder',\n    slug: 'register-as-a-unicorn-breeder'\n  })\n\n  await loader.addForm('src/server/forms/page-events.yaml', {\n    ...metadata,\n    id: '511db05e-ebbd-42e8-8270-5fe93f5c9762',\n    title: 'Page events demo',\n    slug: 'page-events-demo'\n  })\n\n  await loader.addForm('src/server/forms/components.json', {\n    ...metadata,\n    id: '6a872d3b-13f9e-804ce3e-4830-5c45fb32',\n    title: 'Components',\n    slug: 'components'\n  })\n\n  return loader.toFormsService()\n}\n"],"mappings":"AAAA,SAASA,MAAM;AACf,SAASC,eAAe;;AAExB;AACA,MAAMC,GAAG,GAAG,IAAIC,IAAI,CAAC,CAAC;AACtB,MAAMC,IAAI,GAAG;EAAEC,EAAE,EAAE,MAAM;EAAEC,WAAW,EAAE;AAAW,CAAC;AACpD,MAAMC,MAAM,GAAG;EACbC,SAAS,EAAEN,GAAG;EACdO,SAAS,EAAEL,IAAI;EACfM,SAAS,EAAER,GAAG;EACdS,SAAS,EAAEP;AACb,CAAC;AACD,MAAMQ,QAAQ,GAAG;EACfC,YAAY,EAAE,OAAO;EACrBC,QAAQ,EAAE,WAAW;EACrBC,SAAS,EAAE,mBAAmB;EAC9BC,kBAAkB,EAAE,+CAA+C;EACnEC,iBAAiB,EAAEjB,MAAM,CAACkB,GAAG,CAAC,wBAAwB,CAAC;EACvD,GAAGX,MAAM;EACTY,IAAI,EAAEZ;AACR,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMa,YAAY,GAAG,MAAAA,CAAA,KAAY;EACtC;EACA,MAAMC,MAAM,GAAG,IAAIpB,eAAe,CAAC,CAAC;;EAEpC;EACA,MAAMoB,MAAM,CAACC,OAAO,CAAC,qDAAqD,EAAE;IAC1E,GAAGV,QAAQ;IACXP,EAAE,EAAE,sCAAsC;IAC1CkB,KAAK,EAAE,+BAA+B;IACtCC,IAAI,EAAE;EACR,CAAC,CAAC;EAEF,MAAMH,MAAM,CAACC,OAAO,CAAC,mCAAmC,EAAE;IACxD,GAAGV,QAAQ;IACXP,EAAE,EAAE,sCAAsC;IAC1CkB,KAAK,EAAE,kBAAkB;IACzBC,IAAI,EAAE;EACR,CAAC,CAAC;EAEF,MAAMH,MAAM,CAACC,OAAO,CAAC,kCAAkC,EAAE;IACvD,GAAGV,QAAQ;IACXP,EAAE,EAAE,sCAAsC;IAC1CkB,KAAK,EAAE,YAAY;IACnBC,IAAI,EAAE;EACR,CAAC,CAAC;EAEF,OAAOH,MAAM,CAACI,cAAc,CAAC,CAAC;AAChC,CAAC","ignoreList":[]}

package/.server/server/routes/dummy-api.d.ts

@@ -0,0 +1,38 @@
+import { type Request, type ResponseToolkit } from '@hapi/hapi';
+declare const _default: ({
+    method: string;
+    path: string;
+    handler(request: Request<{
+        Payload: {
+            meta: {
+                referenceNumber: string;
+            };
+        };
+    }>, _h: ResponseToolkit): {
+        submissionEvent: string;
+        submissionReferenceNumber: string;
+    };
+} | {
+    method: string;
+    path: string;
+    handler(request: Request<{
+        Payload: {
+            data: {
+                main: {
+                    applicantFirstName: string;
+                    applicantLastName: string;
+                    dateOfBirth: string;
+                };
+            };
+            meta: {
+                event: string;
+                referenceNumber: string;
+            };
+        };
+    }>, _h: ResponseToolkit): {
+        calculatedAge: number;
+        submissionEvent: string;
+        submissionReferenceNumber: string;
+    };
+})[];
+export default _default;

package/.server/server/routes/dummy-api.js

@@ -0,0 +1,33 @@
+function calculateAge(day, month, year) {
+  const dobDate = new Date(Number(day), Number(month) - 1, Number(year));
+  const today = new Date();
+  let age = today.getFullYear() - dobDate.getFullYear();
+  const m = today.getMonth() - dobDate.getMonth();
+  if (m < 0 || m === 0 && today.getDate() < dobDate.getDate()) {
+    age--;
+  }
+  return age;
+}
+export default [{
+  method: 'POST',
+  path: '/api/example/on-load-page',
+  handler(request, _h) {
+    return {
+      submissionEvent: 'GET',
+      submissionReferenceNumber: request.payload.meta.referenceNumber
+    };
+  }
+}, {
+  method: 'POST',
+  path: '/api/example/on-summary',
+  handler(request, _h) {
+    const [day, month, year] = request.payload.data.main.dateOfBirth.split('-');
+    const age = calculateAge(day, month, year);
+    return {
+      calculatedAge: age,
+      submissionEvent: 'POST',
+      submissionReferenceNumber: request.payload.meta.referenceNumber // example of receiving a payload from DXT
+    };
+  }
+}];
+//# sourceMappingURL=dummy-api.js.map

package/.server/server/routes/dummy-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dummy-api.js","names":["calculateAge","day","month","year","dobDate","Date","Number","today","age","getFullYear","m","getMonth","getDate","method","path","handler","request","_h","submissionEvent","submissionReferenceNumber","payload","meta","referenceNumber","data","main","dateOfBirth","split","calculatedAge"],"sources":["../../../src/server/routes/dummy-api.ts"],"sourcesContent":["import { type Request, type ResponseToolkit } from '@hapi/hapi'\n\nfunction calculateAge(day: string, month: string, year: string) {\n  const dobDate = new Date(Number(day), Number(month) - 1, Number(year))\n\n  const today = new Date()\n\n  let age = today.getFullYear() - dobDate.getFullYear()\n  const m = today.getMonth() - dobDate.getMonth()\n\n  if (m < 0 || (m === 0 && today.getDate() < dobDate.getDate())) {\n    age--\n  }\n\n  return age\n}\n\nexport default [\n  {\n    method: 'POST',\n    path: '/api/example/on-load-page',\n    handler(\n      request: Request<{ Payload: { meta: { referenceNumber: string } } }>,\n      _h: ResponseToolkit\n    ) {\n      return {\n        submissionEvent: 'GET',\n        submissionReferenceNumber: request.payload.meta.referenceNumber\n      }\n    }\n  },\n  {\n    method: 'POST',\n    path: '/api/example/on-summary',\n    handler(\n      request: Request<{\n        Payload: {\n          data: {\n            main: {\n              applicantFirstName: string\n              applicantLastName: string\n              dateOfBirth: string\n            }\n          }\n          meta: { event: string; referenceNumber: string }\n        }\n      }>,\n      _h: ResponseToolkit\n    ) {\n      const [day, month, year] =\n        request.payload.data.main.dateOfBirth.split('-')\n\n      const age = calculateAge(day, month, year)\n\n      return {\n        calculatedAge: age,\n        submissionEvent: 'POST',\n        submissionReferenceNumber: request.payload.meta.referenceNumber // example of receiving a payload from DXT\n      }\n    }\n  }\n]\n"],"mappings":"AAEA,SAASA,YAAYA,CAACC,GAAW,EAAEC,KAAa,EAAEC,IAAY,EAAE;EAC9D,MAAMC,OAAO,GAAG,IAAIC,IAAI,CAACC,MAAM,CAACL,GAAG,CAAC,EAAEK,MAAM,CAACJ,KAAK,CAAC,GAAG,CAAC,EAAEI,MAAM,CAACH,IAAI,CAAC,CAAC;EAEtE,MAAMI,KAAK,GAAG,IAAIF,IAAI,CAAC,CAAC;EAExB,IAAIG,GAAG,GAAGD,KAAK,CAACE,WAAW,CAAC,CAAC,GAAGL,OAAO,CAACK,WAAW,CAAC,CAAC;EACrD,MAAMC,CAAC,GAAGH,KAAK,CAACI,QAAQ,CAAC,CAAC,GAAGP,OAAO,CAACO,QAAQ,CAAC,CAAC;EAE/C,IAAID,CAAC,GAAG,CAAC,IAAKA,CAAC,KAAK,CAAC,IAAIH,KAAK,CAACK,OAAO,CAAC,CAAC,GAAGR,OAAO,CAACQ,OAAO,CAAC,CAAE,EAAE;IAC7DJ,GAAG,EAAE;EACP;EAEA,OAAOA,GAAG;AACZ;AAEA,eAAe,CACb;EACEK,MAAM,EAAE,MAAM;EACdC,IAAI,EAAE,2BAA2B;EACjCC,OAAOA,CACLC,OAAoE,EACpEC,EAAmB,EACnB;IACA,OAAO;MACLC,eAAe,EAAE,KAAK;MACtBC,yBAAyB,EAAEH,OAAO,CAACI,OAAO,CAACC,IAAI,CAACC;IAClD,CAAC;EACH;AACF,CAAC,EACD;EACET,MAAM,EAAE,MAAM;EACdC,IAAI,EAAE,yBAAyB;EAC/BC,OAAOA,CACLC,OAWE,EACFC,EAAmB,EACnB;IACA,MAAM,CAAChB,GAAG,EAAEC,KAAK,EAAEC,IAAI,CAAC,GACtBa,OAAO,CAACI,OAAO,CAACG,IAAI,CAACC,IAAI,CAACC,WAAW,CAACC,KAAK,CAAC,GAAG,CAAC;IAElD,MAAMlB,GAAG,GAAGR,YAAY,CAACC,GAAG,EAAEC,KAAK,EAAEC,IAAI,CAAC;IAE1C,OAAO;MACLwB,aAAa,EAAEnB,GAAG;MAClBU,eAAe,EAAE,MAAM;MACvBC,yBAAyB,EAAEH,OAAO,CAACI,OAAO,CAACC,IAAI,CAACC,eAAe,CAAC;IAClE,CAAC;EACH;AACF,CAAC,CACF","ignoreList":[]}

package/.server/server/routes/index.d.ts

@@ -1 +1,2 @@
 export { default as publicRoutes } from '~/src/server/routes/public.js';
+export { default as dummyApiRoutes } from '~/src/server/routes/dummy-api.js';

package/.server/server/routes/index.js

@@ -1,2 +1,3 @@
 export { default as publicRoutes } from "./public.js";
+export { default as dummyApiRoutes } from "./dummy-api.js";
 //# sourceMappingURL=index.js.map

package/.server/server/routes/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["default","publicRoutes"],"sources":["../../../src/server/routes/index.ts"],"sourcesContent":["export { default as publicRoutes } from '~/src/server/routes/public.js'\n"],"mappings":"AAAA,SAASA,OAAO,IAAIC,YAAY","ignoreList":[]}
+{"version":3,"file":"index.js","names":["default","publicRoutes","dummyApiRoutes"],"sources":["../../../src/server/routes/index.ts"],"sourcesContent":["export { default as publicRoutes } from '~/src/server/routes/public.js'\nexport { default as dummyApiRoutes } from '~/src/server/routes/dummy-api.js'\n"],"mappings":"AAAA,SAASA,OAAO,IAAIC,YAAY;AAChC,SAASD,OAAO,IAAIE,cAAc","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-engine-plugin",
-  "version": "2.0.3",
+  "version": "2.1.0",
   "description": "Defra forms engine",
   "type": "module",
   "files": [
@@ -168,6 +168,8 @@
     "jest-extended": "^4.0.2",
     "jsdom": "^26.1.0",
     "lint-staged": "^15.3.0",
+    "mockdate": "^3.0.5",
+    "nock": "^14.0.8",
     "postcss": "^8.5.6",
     "postcss-load-config": "^6.0.1",
     "postcss-loader": "^8.1.1",

package/src/server/forms/page-events.yaml

@@ -0,0 +1,87 @@
+---
+name: Page events
+engine: V2
+schema: 2
+startPage: '/summary'
+pages:
+  - title: Your name
+    path: '/your-name'
+    components:
+      - type: TextField
+        title: What is your first name?
+        name: applicantFirstName
+        shortDescription: Your first name
+        hint: ''
+        options:
+          required: true
+        schema: {}
+        id: 1fb8e182-c709-4792-8f83-e01d8b1fee1a
+      - type: TextField
+        title: What is your last name?
+        name: applicantLastName
+        shortDescription: Your last name
+        hint: ''
+        options:
+          required: true
+        schema: {}
+        id: b68df7f1-d4f4-4c17-83c8-402f584906c9
+    next: []
+    id: 622a35ec-3795-418a-81f3-a45746959045
+  - title: ''
+    path: '/date-of-birth'
+    events:
+      onLoad:
+        type: http
+        options:
+          method: 'POST'
+          url: http://localhost:3009/api/example/on-load-page
+    components:
+      - type: Html
+        # technically context.data.submissionReferenceNumber is redundant as the reference number is available locally as context.referenceNumber
+        # but this is to demonstrate that the server can send data back to the client
+        content: >
+          <p class="govuk-body">
+            The backend received a full copy of the form state even though you haven't submitted the form yet.
+          </p>
+          <p class="govuk-body">
+            Your submission was received with the reference: <strong>{{ context.data.submissionReferenceNumber }}</strong>.
+          </p>
+        id: 334b10dc-3373-4928-8fed-575578a67de8
+      - type: DatePartsField
+        title: When is {{ applicantFirstName }} {{ applicantLastName }}'s birthday?
+        name: dateOfBirth
+        shortDescription: Your birthday
+        hint: ''
+        options:
+          required: true
+        schema: {}
+        id: '00738799-3489-4ab2-a57b-542eecb31bfa'
+    next: []
+    id: da0fbdb4-a2de-4650-be16-9ba552af135f
+  - id: 449a45f6-4541-4a46-91bd-8b8931b07b50
+    title: Summary
+    path: '/summary'
+    controller: SummaryPageController
+    events:
+      onLoad:
+        type: http
+        options:
+          method: 'POST'
+          url: http://localhost:3009/api/example/on-summary
+      onSave:
+        type: http
+        options:
+          method: 'POST'
+          url: http://localhost:3009/api/example/on-summary
+    components:
+      - type: Html
+        content: >
+          <h2 class="govuk-heading-m">Your age</h1>
+          <p class="govuk-body">
+            We've calculated that you are {{ context.data.calculatedAge }} years old. Only proceed if this is correct.
+          </p>
+        id: c42ea488-a38c-4b67-b8fa-4cf543a4f82d
+    next: []
+conditions: []
+sections: []
+lists: []