@defra/forms-engine-plugin 0.0.1

package/.server/server/plugins/engine/models/FormModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FormModel.js","names":["ComponentType","ConditionsModel","ControllerPath","ControllerType","Engine","formDefinitionSchema","hasComponents","hasRepeater","add","Parser","joi","findPage","getError","getPage","createPage","validationOptions","opts","defaultServices","FormAction","merge","FormModel","engine","def","lists","sections","name","values","basePath","conditions","pages","services","controllers","pageDefMap","listDefMap","componentDefMap","pageMap","componentMap","constructor","options","result","validate","abortEarly","error","structuredClone","value","push","title","type","items","text","forEach","conditionDef","condition","makeCondition","map","pageDef","some","controller","Status","path","Map","page","list","filter","flatMap","components","component","collection","makeSchema","makeFilteredSchema","relevantPages","schema","object","required","concat","stateSchema","parser","operators","logical","Object","assign","functions","dateForComparison","timePeriod","timeUnit","Date","toISOString","displayName","expr","toConditionExpression","fn","evaluationState","ctx","toConditionContext","evaluate","context","key","defineProperty","get","from","parse","toExpression","getList","find","getFormContext","request","state","errors","query","currentPath","startPath","getStartPath","isForceAccess","relevantState","payload","getFormDataFromState","paths","data","validateFormPayload","nextPage","initialiseContext","assignEvaluationState","assignRelevantState","getNextPath","validateFormState","assignPaths","V2","keys","getContextValueFromState","includes","action","getFormParams","Validate","update","fields","field","CheckboxesField","undefined","formState","getStateFromValidForm","previousPages","relevantPage","model","stripUnknown","errorsState","details"],"sources":["../../../../../src/server/plugins/engine/models/FormModel.ts"],"sourcesContent":["import {\n  ComponentType,\n  ConditionsModel,\n  ControllerPath,\n  ControllerType,\n  Engine,\n  formDefinitionSchema,\n  hasComponents,\n  hasRepeater,\n  type ComponentDef,\n  type ConditionWrapper,\n  type ConditionsModelData,\n  type DateUnits,\n  type FormDefinition,\n  type List,\n  type Page\n} from '@defra/forms-model'\nimport { add } from 'date-fns'\nimport { Parser, type Value } from 'expr-eval'\nimport joi from 'joi'\n\nimport { type Component } from '~/src/server/plugins/engine/components/helpers.js'\nimport {\n  findPage,\n  getError,\n  getPage\n} from '~/src/server/plugins/engine/helpers.js'\nimport { type ExecutableCondition } from '~/src/server/plugins/engine/models/types.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport {\n  createPage,\n  type PageControllerClass\n} from '~/src/server/plugins/engine/pageControllers/helpers.js'\nimport { validationOptions as opts } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\nimport * as defaultServices from '~/src/server/plugins/engine/services/index.js'\nimport {\n  type FormContext,\n  type FormContextRequest,\n  type FormState,\n  type FormSubmissionError,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\nimport { FormAction } from '~/src/server/routes/types.js'\nimport { merge } from '~/src/server/services/cacheService.js'\nimport { type Services } from '~/src/server/types.js'\n\nexport class FormModel {\n  /** The runtime engine that should be used */\n  engine?: Engine\n\n  /** the entire form JSON as an object */\n  def: FormDefinition\n\n  lists: FormDefinition['lists']\n  sections: FormDefinition['sections'] = []\n  name: string\n  values: FormDefinition\n  basePath: string\n  conditions: Partial<Record<string, ExecutableCondition>>\n  pages: PageControllerClass[]\n  services: Services\n\n  controllers?: Record<string, typeof PageController>\n  pageDefMap: Map<string, Page>\n  listDefMap: Map<string, List>\n  componentDefMap: Map<string, ComponentDef>\n  pageMap: Map<string, PageControllerClass>\n  componentMap: Map<string, Component>\n\n  constructor(\n    def: typeof this.def,\n    options: { basePath: string },\n    services: Services = defaultServices,\n    controllers?: Record<string, typeof PageController>\n  ) {\n    const result = formDefinitionSchema.validate(def, { abortEarly: false })\n\n    if (result.error) {\n      throw result.error\n    }\n\n    // Make a clone of the shallow copy returned\n    // by joi so as not to change the source data.\n    def = structuredClone(result.value)\n\n    // Add default lists\n    def.lists.push({\n      name: '__yesNo',\n      title: 'Yes/No',\n      type: 'boolean',\n      items: [\n        {\n          text: 'Yes',\n          value: true\n        },\n        {\n          text: 'No',\n          value: false\n        }\n      ]\n    })\n\n    this.engine = def.engine\n    this.def = def\n    this.lists = def.lists\n    this.sections = def.sections\n    this.name = def.name ?? ''\n    this.values = result.value\n    this.basePath = options.basePath\n    this.conditions = {}\n    this.services = services\n    this.controllers = controllers\n\n    def.conditions.forEach((conditionDef) => {\n      const condition = this.makeCondition(conditionDef)\n      this.conditions[condition.name] = condition\n    })\n\n    this.pages = def.pages.map((pageDef) => createPage(this, pageDef))\n\n    if (\n      !def.pages.some(\n        ({ controller }) =>\n          // Check for user-provided status page (optional)\n          controller === ControllerType.Status\n      )\n    ) {\n      this.pages.push(\n        createPage(this, {\n          title: 'Form submitted',\n          path: ControllerPath.Status,\n          controller: ControllerType.Status\n        })\n      )\n    }\n\n    this.pageDefMap = new Map(def.pages.map((page) => [page.path, page]))\n    this.listDefMap = new Map(def.lists.map((list) => [list.name, list]))\n    this.componentDefMap = new Map(\n      def.pages\n        .filter(hasComponents)\n        .flatMap((page) =>\n          page.components.map((component) => [component.name, component])\n        )\n    )\n\n    this.pageMap = new Map(this.pages.map((page) => [page.path, page]))\n    this.componentMap = new Map(\n      this.pages.flatMap((page) =>\n        page.collection.components.map((component) => [\n          component.name,\n          component\n        ])\n      )\n    )\n  }\n\n  /**\n   * build the entire model schema from individual pages/sections\n   */\n  makeSchema() {\n    return this.makeFilteredSchema(this.pages)\n  }\n\n  /**\n   * build the entire model schema from individual pages/sections and filter out answers\n   * for pages which are no longer accessible due to an answer that has been changed\n   */\n  makeFilteredSchema(relevantPages: PageControllerClass[]) {\n    // Build the entire model schema\n    // from the individual pages/sections\n    let schema = joi.object<FormSubmissionState>().required()\n\n    relevantPages.forEach((page) => {\n      schema = schema.concat(page.collection.stateSchema)\n    })\n\n    return schema\n  }\n\n  /**\n   * Instantiates a Condition based on {@link ConditionWrapper}\n   * @param condition\n   */\n  makeCondition(condition: ConditionWrapper): ExecutableCondition {\n    const parser = new Parser({\n      operators: {\n        logical: true\n      }\n    })\n\n    Object.assign(parser.functions, {\n      dateForComparison(timePeriod: number, timeUnit: DateUnits) {\n        return add(new Date(), { [timeUnit]: timePeriod }).toISOString()\n      }\n    })\n\n    const { name, displayName, value } = condition\n    const expr = this.toConditionExpression(value, parser)\n\n    const fn = (evaluationState: FormState) => {\n      const ctx = this.toConditionContext(evaluationState, this.conditions)\n      try {\n        return expr.evaluate(ctx) as boolean\n      } catch {\n        return false\n      }\n    }\n\n    return {\n      name,\n      displayName,\n      value,\n      expr,\n      fn\n    }\n  }\n\n  toConditionContext(\n    evaluationState: FormState,\n    conditions: Partial<Record<string, ExecutableCondition>>\n  ) {\n    const context = { ...evaluationState }\n\n    for (const key in conditions) {\n      Object.defineProperty(context, key, {\n        get() {\n          return conditions[key]?.fn(evaluationState)\n        }\n      })\n    }\n\n    return context as Extract<Value, Record<string, Value>>\n  }\n\n  toConditionExpression(value: ConditionsModelData, parser: Parser) {\n    const conditions = ConditionsModel.from(value)\n    return parser.parse(conditions.toExpression())\n  }\n\n  getList(name: string): List | undefined {\n    return this.lists.find((list) => list.name === name)\n  }\n\n  /**\n   * Form context for the current page\n   */\n  getFormContext(\n    request: FormContextRequest,\n    state: FormState,\n    errors?: FormSubmissionError[]\n  ): FormContext {\n    const { query } = request\n\n    const page = getPage(this, request)\n\n    // Determine form paths\n    const currentPath = page.path\n    const startPath = page.getStartPath()\n\n    // Preview URL direct access is allowed\n    const isForceAccess = 'force' in query\n\n    let context: FormContext = {\n      evaluationState: {},\n      relevantState: {},\n      relevantPages: [],\n      payload: page.getFormDataFromState(request, state),\n      state,\n      paths: [],\n      errors,\n      isForceAccess,\n      data: {},\n      pageDefMap: this.pageDefMap,\n      listDefMap: this.listDefMap,\n      componentDefMap: this.componentDefMap,\n      pageMap: this.pageMap,\n      componentMap: this.componentMap\n    }\n\n    // Validate current page\n    context = validateFormPayload(request, page, context)\n\n    // Find start page\n    let nextPage = findPage(this, startPath)\n\n    this.initialiseContext(context)\n\n    // Walk form pages from start\n    while (nextPage) {\n      // Add page to context\n      context.relevantPages.push(nextPage)\n\n      this.assignEvaluationState(context, nextPage)\n\n      this.assignRelevantState(context, nextPage)\n\n      // Stop at current page\n      if (nextPage.path === currentPath) {\n        break\n      }\n\n      // Apply conditions to determine next page\n      nextPage = findPage(this, nextPage.getNextPath(context))\n    }\n\n    // Validate form state\n    context = validateFormState(request, page, context)\n\n    // Add paths for navigation\n    this.assignPaths(context)\n\n    return context\n  }\n\n  private initialiseContext(context: FormContext) {\n    // For the V2 engine, we need to initialise `evaluationState` to null\n    // for all keys. This is because the current condition evaluation\n    // library (eval-expr) will throw if an expression uses a key that is undefined.\n    if (this.engine === Engine.V2) {\n      for (const page of this.pages) {\n        for (const key of page.keys) {\n          context.evaluationState[key] = null\n        }\n      }\n    }\n  }\n\n  private assignEvaluationState(\n    context: FormContext,\n    page: PageControllerClass\n  ) {\n    const { collection, pageDef } = page\n    // Skip evaluation state for repeater pages\n\n    if (!hasRepeater(pageDef)) {\n      Object.assign(\n        context.evaluationState,\n        collection.getContextValueFromState(context.state)\n      )\n    }\n  }\n\n  private assignRelevantState(context: FormContext, page: PageControllerClass) {\n    // Copy relevant state by expected keys\n    for (const key of page.keys) {\n      if (typeof context.state[key] !== 'undefined') {\n        context.relevantState[key] = context.state[key]\n      }\n    }\n  }\n\n  private assignPaths(context: FormContext) {\n    for (const { keys, path } of context.relevantPages) {\n      context.paths.push(path)\n\n      // Stop at page with errors\n      if (\n        context.errors?.some(({ name, path }) => {\n          return keys.includes(name) || keys.some((key) => path.includes(key))\n        })\n      ) {\n        break\n      }\n    }\n  }\n}\n\n/**\n * Validate current page only\n */\nfunction validateFormPayload(\n  request: FormContextRequest,\n  page: PageControllerClass,\n  context: FormContext\n): FormContext {\n  const { collection } = page\n  const { payload, state } = context\n\n  const { action } = page.getFormParams(request)\n\n  // Skip validation GET requests or other actions\n  if (!request.payload || action !== FormAction.Validate) {\n    return context\n  }\n\n  // For checkbox fields missing in the payload (i.e. unchecked),\n  // explicitly set their value to undefined so that any previously\n  // stored value is cleared and required field validation is enforced.\n  const update = { ...request.payload }\n  collection.fields.forEach((field) => {\n    if (\n      field.type === ComponentType.CheckboxesField &&\n      !(field.name in update)\n    ) {\n      update[field.name] = undefined\n    }\n  })\n\n  const { value, errors } = collection.validate({\n    ...payload,\n    ...update\n  })\n\n  // Add sanitised payload (ready to save)\n  const formState = page.getStateFromValidForm(request, state, value)\n\n  return {\n    ...context,\n    payload: merge(payload, value),\n    state: merge(state, formState),\n    errors\n  }\n}\n\n/**\n * Validate entire form state\n */\nfunction validateFormState(\n  request: FormContextRequest,\n  page: PageControllerClass,\n  context: FormContext\n): FormContext {\n  const { errors = [], relevantPages, relevantState } = context\n\n  // Exclude current page\n  const previousPages = relevantPages.filter(\n    (relevantPage) => relevantPage !== page\n  )\n\n  // Validate relevant state\n  const { error } = page.model\n    .makeFilteredSchema(previousPages)\n    .validate(relevantState, { ...opts, stripUnknown: true })\n\n  // Add relevant state errors\n  if (error) {\n    const errorsState = error.details.map(getError)\n    return { ...context, errors: errors.concat(errorsState) }\n  }\n\n  return context\n}\n"],"mappings":"AAAA,SACEA,aAAa,EACbC,eAAe,EACfC,cAAc,EACdC,cAAc,EACdC,MAAM,EACNC,oBAAoB,EACpBC,aAAa,EACbC,WAAW,QAQN,oBAAoB;AAC3B,SAASC,GAAG,QAAQ,UAAU;AAC9B,SAASC,MAAM,QAAoB,WAAW;AAC9C,OAAOC,GAAG,MAAM,KAAK;AAGrB,SACEC,QAAQ,EACRC,QAAQ,EACRC,OAAO;AAIT,SACEC,UAAU;AAGZ,SAASC,iBAAiB,IAAIC,IAAI;AAClC,OAAO,KAAKC,eAAe;AAQ3B,SAASC,UAAU;AACnB,SAASC,KAAK;AAGd,OAAO,MAAMC,SAAS,CAAC;EACrB;EACAC,MAAM;;EAEN;EACAC,GAAG;EAEHC,KAAK;EACLC,QAAQ,GAA+B,EAAE;EACzCC,IAAI;EACJC,MAAM;EACNC,QAAQ;EACRC,UAAU;EACVC,KAAK;EACLC,QAAQ;EAERC,WAAW;EACXC,UAAU;EACVC,UAAU;EACVC,eAAe;EACfC,OAAO;EACPC,YAAY;EAEZC,WAAWA,CACTf,GAAoB,EACpBgB,OAA6B,EAC7BR,QAAkB,GAAGb,eAAe,EACpCc,WAAmD,EACnD;IACA,MAAMQ,MAAM,GAAGlC,oBAAoB,CAACmC,QAAQ,CAAClB,GAAG,EAAE;MAAEmB,UAAU,EAAE;IAAM,CAAC,CAAC;IAExE,IAAIF,MAAM,CAACG,KAAK,EAAE;MAChB,MAAMH,MAAM,CAACG,KAAK;IACpB;;IAEA;IACA;IACApB,GAAG,GAAGqB,eAAe,CAACJ,MAAM,CAACK,KAAK,CAAC;;IAEnC;IACAtB,GAAG,CAACC,KAAK,CAACsB,IAAI,CAAC;MACbpB,IAAI,EAAE,SAAS;MACfqB,KAAK,EAAE,QAAQ;MACfC,IAAI,EAAE,SAAS;MACfC,KAAK,EAAE,CACL;QACEC,IAAI,EAAE,KAAK;QACXL,KAAK,EAAE;MACT,CAAC,EACD;QACEK,IAAI,EAAE,IAAI;QACVL,KAAK,EAAE;MACT,CAAC;IAEL,CAAC,CAAC;IAEF,IAAI,CAACvB,MAAM,GAAGC,GAAG,CAACD,MAAM;IACxB,IAAI,CAACC,GAAG,GAAGA,GAAG;IACd,IAAI,CAACC,KAAK,GAAGD,GAAG,CAACC,KAAK;IACtB,IAAI,CAACC,QAAQ,GAAGF,GAAG,CAACE,QAAQ;IAC5B,IAAI,CAACC,IAAI,GAAGH,GAAG,CAACG,IAAI,IAAI,EAAE;IAC1B,IAAI,CAACC,MAAM,GAAGa,MAAM,CAACK,KAAK;IAC1B,IAAI,CAACjB,QAAQ,GAAGW,OAAO,CAACX,QAAQ;IAChC,IAAI,CAACC,UAAU,GAAG,CAAC,CAAC;IACpB,IAAI,CAACE,QAAQ,GAAGA,QAAQ;IACxB,IAAI,CAACC,WAAW,GAAGA,WAAW;IAE9BT,GAAG,CAACM,UAAU,CAACsB,OAAO,CAAEC,YAAY,IAAK;MACvC,MAAMC,SAAS,GAAG,IAAI,CAACC,aAAa,CAACF,YAAY,CAAC;MAClD,IAAI,CAACvB,UAAU,CAACwB,SAAS,CAAC3B,IAAI,CAAC,GAAG2B,SAAS;IAC7C,CAAC,CAAC;IAEF,IAAI,CAACvB,KAAK,GAAGP,GAAG,CAACO,KAAK,CAACyB,GAAG,CAAEC,OAAO,IAAKzC,UAAU,CAAC,IAAI,EAAEyC,OAAO,CAAC,CAAC;IAElE,IACE,CAACjC,GAAG,CAACO,KAAK,CAAC2B,IAAI,CACb,CAAC;MAAEC;IAAW,CAAC;IACb;IACAA,UAAU,KAAKtD,cAAc,CAACuD,MAClC,CAAC,EACD;MACA,IAAI,CAAC7B,KAAK,CAACgB,IAAI,CACb/B,UAAU,CAAC,IAAI,EAAE;QACfgC,KAAK,EAAE,gBAAgB;QACvBa,IAAI,EAAEzD,cAAc,CAACwD,MAAM;QAC3BD,UAAU,EAAEtD,cAAc,CAACuD;MAC7B,CAAC,CACH,CAAC;IACH;IAEA,IAAI,CAAC1B,UAAU,GAAG,IAAI4B,GAAG,CAACtC,GAAG,CAACO,KAAK,CAACyB,GAAG,CAAEO,IAAI,IAAK,CAACA,IAAI,CAACF,IAAI,EAAEE,IAAI,CAAC,CAAC,CAAC;IACrE,IAAI,CAAC5B,UAAU,GAAG,IAAI2B,GAAG,CAACtC,GAAG,CAACC,KAAK,CAAC+B,GAAG,CAAEQ,IAAI,IAAK,CAACA,IAAI,CAACrC,IAAI,EAAEqC,IAAI,CAAC,CAAC,CAAC;IACrE,IAAI,CAAC5B,eAAe,GAAG,IAAI0B,GAAG,CAC5BtC,GAAG,CAACO,KAAK,CACNkC,MAAM,CAACzD,aAAa,CAAC,CACrB0D,OAAO,CAAEH,IAAI,IACZA,IAAI,CAACI,UAAU,CAACX,GAAG,CAAEY,SAAS,IAAK,CAACA,SAAS,CAACzC,IAAI,EAAEyC,SAAS,CAAC,CAChE,CACJ,CAAC;IAED,IAAI,CAAC/B,OAAO,GAAG,IAAIyB,GAAG,CAAC,IAAI,CAAC/B,KAAK,CAACyB,GAAG,CAAEO,IAAI,IAAK,CAACA,IAAI,CAACF,IAAI,EAAEE,IAAI,CAAC,CAAC,CAAC;IACnE,IAAI,CAACzB,YAAY,GAAG,IAAIwB,GAAG,CACzB,IAAI,CAAC/B,KAAK,CAACmC,OAAO,CAAEH,IAAI,IACtBA,IAAI,CAACM,UAAU,CAACF,UAAU,CAACX,GAAG,CAAEY,SAAS,IAAK,CAC5CA,SAAS,CAACzC,IAAI,EACdyC,SAAS,CACV,CACH,CACF,CAAC;EACH;;EAEA;AACF;AACA;EACEE,UAAUA,CAAA,EAAG;IACX,OAAO,IAAI,CAACC,kBAAkB,CAAC,IAAI,CAACxC,KAAK,CAAC;EAC5C;;EAEA;AACF;AACA;AACA;EACEwC,kBAAkBA,CAACC,aAAoC,EAAE;IACvD;IACA;IACA,IAAIC,MAAM,GAAG7D,GAAG,CAAC8D,MAAM,CAAsB,CAAC,CAACC,QAAQ,CAAC,CAAC;IAEzDH,aAAa,CAACpB,OAAO,CAAEW,IAAI,IAAK;MAC9BU,MAAM,GAAGA,MAAM,CAACG,MAAM,CAACb,IAAI,CAACM,UAAU,CAACQ,WAAW,CAAC;IACrD,CAAC,CAAC;IAEF,OAAOJ,MAAM;EACf;;EAEA;AACF;AACA;AACA;EACElB,aAAaA,CAACD,SAA2B,EAAuB;IAC9D,MAAMwB,MAAM,GAAG,IAAInE,MAAM,CAAC;MACxBoE,SAAS,EAAE;QACTC,OAAO,EAAE;MACX;IACF,CAAC,CAAC;IAEFC,MAAM,CAACC,MAAM,CAACJ,MAAM,CAACK,SAAS,EAAE;MAC9BC,iBAAiBA,CAACC,UAAkB,EAAEC,QAAmB,EAAE;QACzD,OAAO5E,GAAG,CAAC,IAAI6E,IAAI,CAAC,CAAC,EAAE;UAAE,CAACD,QAAQ,GAAGD;QAAW,CAAC,CAAC,CAACG,WAAW,CAAC,CAAC;MAClE;IACF,CAAC,CAAC;IAEF,MAAM;MAAE7D,IAAI;MAAE8D,WAAW;MAAE3C;IAAM,CAAC,GAAGQ,SAAS;IAC9C,MAAMoC,IAAI,GAAG,IAAI,CAACC,qBAAqB,CAAC7C,KAAK,EAAEgC,MAAM,CAAC;IAEtD,MAAMc,EAAE,GAAIC,eAA0B,IAAK;MACzC,MAAMC,GAAG,GAAG,IAAI,CAACC,kBAAkB,CAACF,eAAe,EAAE,IAAI,CAAC/D,UAAU,CAAC;MACrE,IAAI;QACF,OAAO4D,IAAI,CAACM,QAAQ,CAACF,GAAG,CAAC;MAC3B,CAAC,CAAC,MAAM;QACN,OAAO,KAAK;MACd;IACF,CAAC;IAED,OAAO;MACLnE,IAAI;MACJ8D,WAAW;MACX3C,KAAK;MACL4C,IAAI;MACJE;IACF,CAAC;EACH;EAEAG,kBAAkBA,CAChBF,eAA0B,EAC1B/D,UAAwD,EACxD;IACA,MAAMmE,OAAO,GAAG;MAAE,GAAGJ;IAAgB,CAAC;IAEtC,KAAK,MAAMK,GAAG,IAAIpE,UAAU,EAAE;MAC5BmD,MAAM,CAACkB,cAAc,CAACF,OAAO,EAAEC,GAAG,EAAE;QAClCE,GAAGA,CAAA,EAAG;UACJ,OAAOtE,UAAU,CAACoE,GAAG,CAAC,EAAEN,EAAE,CAACC,eAAe,CAAC;QAC7C;MACF,CAAC,CAAC;IACJ;IAEA,OAAOI,OAAO;EAChB;EAEAN,qBAAqBA,CAAC7C,KAA0B,EAAEgC,MAAc,EAAE;IAChE,MAAMhD,UAAU,GAAG3B,eAAe,CAACkG,IAAI,CAACvD,KAAK,CAAC;IAC9C,OAAOgC,MAAM,CAACwB,KAAK,CAACxE,UAAU,CAACyE,YAAY,CAAC,CAAC,CAAC;EAChD;EAEAC,OAAOA,CAAC7E,IAAY,EAAoB;IACtC,OAAO,IAAI,CAACF,KAAK,CAACgF,IAAI,CAAEzC,IAAI,IAAKA,IAAI,CAACrC,IAAI,KAAKA,IAAI,CAAC;EACtD;;EAEA;AACF;AACA;EACE+E,cAAcA,CACZC,OAA2B,EAC3BC,KAAgB,EAChBC,MAA8B,EACjB;IACb,MAAM;MAAEC;IAAM,CAAC,GAAGH,OAAO;IAEzB,MAAM5C,IAAI,GAAGhD,OAAO,CAAC,IAAI,EAAE4F,OAAO,CAAC;;IAEnC;IACA,MAAMI,WAAW,GAAGhD,IAAI,CAACF,IAAI;IAC7B,MAAMmD,SAAS,GAAGjD,IAAI,CAACkD,YAAY,CAAC,CAAC;;IAErC;IACA,MAAMC,aAAa,GAAG,OAAO,IAAIJ,KAAK;IAEtC,IAAIb,OAAoB,GAAG;MACzBJ,eAAe,EAAE,CAAC,CAAC;MACnBsB,aAAa,EAAE,CAAC,CAAC;MACjB3C,aAAa,EAAE,EAAE;MACjB4C,OAAO,EAAErD,IAAI,CAACsD,oBAAoB,CAACV,OAAO,EAAEC,KAAK,CAAC;MAClDA,KAAK;MACLU,KAAK,EAAE,EAAE;MACTT,MAAM;MACNK,aAAa;MACbK,IAAI,EAAE,CAAC,CAAC;MACRrF,UAAU,EAAE,IAAI,CAACA,UAAU;MAC3BC,UAAU,EAAE,IAAI,CAACA,UAAU;MAC3BC,eAAe,EAAE,IAAI,CAACA,eAAe;MACrCC,OAAO,EAAE,IAAI,CAACA,OAAO;MACrBC,YAAY,EAAE,IAAI,CAACA;IACrB,CAAC;;IAED;IACA2D,OAAO,GAAGuB,mBAAmB,CAACb,OAAO,EAAE5C,IAAI,EAAEkC,OAAO,CAAC;;IAErD;IACA,IAAIwB,QAAQ,GAAG5G,QAAQ,CAAC,IAAI,EAAEmG,SAAS,CAAC;IAExC,IAAI,CAACU,iBAAiB,CAACzB,OAAO,CAAC;;IAE/B;IACA,OAAOwB,QAAQ,EAAE;MACf;MACAxB,OAAO,CAACzB,aAAa,CAACzB,IAAI,CAAC0E,QAAQ,CAAC;MAEpC,IAAI,CAACE,qBAAqB,CAAC1B,OAAO,EAAEwB,QAAQ,CAAC;MAE7C,IAAI,CAACG,mBAAmB,CAAC3B,OAAO,EAAEwB,QAAQ,CAAC;;MAE3C;MACA,IAAIA,QAAQ,CAAC5D,IAAI,KAAKkD,WAAW,EAAE;QACjC;MACF;;MAEA;MACAU,QAAQ,GAAG5G,QAAQ,CAAC,IAAI,EAAE4G,QAAQ,CAACI,WAAW,CAAC5B,OAAO,CAAC,CAAC;IAC1D;;IAEA;IACAA,OAAO,GAAG6B,iBAAiB,CAACnB,OAAO,EAAE5C,IAAI,EAAEkC,OAAO,CAAC;;IAEnD;IACA,IAAI,CAAC8B,WAAW,CAAC9B,OAAO,CAAC;IAEzB,OAAOA,OAAO;EAChB;EAEQyB,iBAAiBA,CAACzB,OAAoB,EAAE;IAC9C;IACA;IACA;IACA,IAAI,IAAI,CAAC1E,MAAM,KAAKjB,MAAM,CAAC0H,EAAE,EAAE;MAC7B,KAAK,MAAMjE,IAAI,IAAI,IAAI,CAAChC,KAAK,EAAE;QAC7B,KAAK,MAAMmE,GAAG,IAAInC,IAAI,CAACkE,IAAI,EAAE;UAC3BhC,OAAO,CAACJ,eAAe,CAACK,GAAG,CAAC,GAAG,IAAI;QACrC;MACF;IACF;EACF;EAEQyB,qBAAqBA,CAC3B1B,OAAoB,EACpBlC,IAAyB,EACzB;IACA,MAAM;MAAEM,UAAU;MAAEZ;IAAQ,CAAC,GAAGM,IAAI;IACpC;;IAEA,IAAI,CAACtD,WAAW,CAACgD,OAAO,CAAC,EAAE;MACzBwB,MAAM,CAACC,MAAM,CACXe,OAAO,CAACJ,eAAe,EACvBxB,UAAU,CAAC6D,wBAAwB,CAACjC,OAAO,CAACW,KAAK,CACnD,CAAC;IACH;EACF;EAEQgB,mBAAmBA,CAAC3B,OAAoB,EAAElC,IAAyB,EAAE;IAC3E;IACA,KAAK,MAAMmC,GAAG,IAAInC,IAAI,CAACkE,IAAI,EAAE;MAC3B,IAAI,OAAOhC,OAAO,CAACW,KAAK,CAACV,GAAG,CAAC,KAAK,WAAW,EAAE;QAC7CD,OAAO,CAACkB,aAAa,CAACjB,GAAG,CAAC,GAAGD,OAAO,CAACW,KAAK,CAACV,GAAG,CAAC;MACjD;IACF;EACF;EAEQ6B,WAAWA,CAAC9B,OAAoB,EAAE;IACxC,KAAK,MAAM;MAAEgC,IAAI;MAAEpE;IAAK,CAAC,IAAIoC,OAAO,CAACzB,aAAa,EAAE;MAClDyB,OAAO,CAACqB,KAAK,CAACvE,IAAI,CAACc,IAAI,CAAC;;MAExB;MACA,IACEoC,OAAO,CAACY,MAAM,EAAEnD,IAAI,CAAC,CAAC;QAAE/B,IAAI;QAAEkC;MAAK,CAAC,KAAK;QACvC,OAAOoE,IAAI,CAACE,QAAQ,CAACxG,IAAI,CAAC,IAAIsG,IAAI,CAACvE,IAAI,CAAEwC,GAAG,IAAKrC,IAAI,CAACsE,QAAQ,CAACjC,GAAG,CAAC,CAAC;MACtE,CAAC,CAAC,EACF;QACA;MACF;IACF;EACF;AACF;;AAEA;AACA;AACA;AACA,SAASsB,mBAAmBA,CAC1Bb,OAA2B,EAC3B5C,IAAyB,EACzBkC,OAAoB,EACP;EACb,MAAM;IAAE5B;EAAW,CAAC,GAAGN,IAAI;EAC3B,MAAM;IAAEqD,OAAO;IAAER;EAAM,CAAC,GAAGX,OAAO;EAElC,MAAM;IAAEmC;EAAO,CAAC,GAAGrE,IAAI,CAACsE,aAAa,CAAC1B,OAAO,CAAC;;EAE9C;EACA,IAAI,CAACA,OAAO,CAACS,OAAO,IAAIgB,MAAM,KAAKhH,UAAU,CAACkH,QAAQ,EAAE;IACtD,OAAOrC,OAAO;EAChB;;EAEA;EACA;EACA;EACA,MAAMsC,MAAM,GAAG;IAAE,GAAG5B,OAAO,CAACS;EAAQ,CAAC;EACrC/C,UAAU,CAACmE,MAAM,CAACpF,OAAO,CAAEqF,KAAK,IAAK;IACnC,IACEA,KAAK,CAACxF,IAAI,KAAK/C,aAAa,CAACwI,eAAe,IAC5C,EAAED,KAAK,CAAC9G,IAAI,IAAI4G,MAAM,CAAC,EACvB;MACAA,MAAM,CAACE,KAAK,CAAC9G,IAAI,CAAC,GAAGgH,SAAS;IAChC;EACF,CAAC,CAAC;EAEF,MAAM;IAAE7F,KAAK;IAAE+D;EAAO,CAAC,GAAGxC,UAAU,CAAC3B,QAAQ,CAAC;IAC5C,GAAG0E,OAAO;IACV,GAAGmB;EACL,CAAC,CAAC;;EAEF;EACA,MAAMK,SAAS,GAAG7E,IAAI,CAAC8E,qBAAqB,CAAClC,OAAO,EAAEC,KAAK,EAAE9D,KAAK,CAAC;EAEnE,OAAO;IACL,GAAGmD,OAAO;IACVmB,OAAO,EAAE/F,KAAK,CAAC+F,OAAO,EAAEtE,KAAK,CAAC;IAC9B8D,KAAK,EAAEvF,KAAK,CAACuF,KAAK,EAAEgC,SAAS,CAAC;IAC9B/B;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA,SAASiB,iBAAiBA,CACxBnB,OAA2B,EAC3B5C,IAAyB,EACzBkC,OAAoB,EACP;EACb,MAAM;IAAEY,MAAM,GAAG,EAAE;IAAErC,aAAa;IAAE2C;EAAc,CAAC,GAAGlB,OAAO;;EAE7D;EACA,MAAM6C,aAAa,GAAGtE,aAAa,CAACP,MAAM,CACvC8E,YAAY,IAAKA,YAAY,KAAKhF,IACrC,CAAC;;EAED;EACA,MAAM;IAAEnB;EAAM,CAAC,GAAGmB,IAAI,CAACiF,KAAK,CACzBzE,kBAAkB,CAACuE,aAAa,CAAC,CACjCpG,QAAQ,CAACyE,aAAa,EAAE;IAAE,GAAGjG,IAAI;IAAE+H,YAAY,EAAE;EAAK,CAAC,CAAC;;EAE3D;EACA,IAAIrG,KAAK,EAAE;IACT,MAAMsG,WAAW,GAAGtG,KAAK,CAACuG,OAAO,CAAC3F,GAAG,CAAC1C,QAAQ,CAAC;IAC/C,OAAO;MAAE,GAAGmF,OAAO;MAAEY,MAAM,EAAEA,MAAM,CAACjC,MAAM,CAACsE,WAAW;IAAE,CAAC;EAC3D;EAEA,OAAOjD,OAAO;AAChB","ignoreList":[]}

package/.server/server/plugins/engine/models/RepeatingSummaryViewModel.js

@@ -0,0 +1,2 @@
+
+//# sourceMappingURL=RepeatingSummaryViewModel.js.map

package/.server/server/plugins/engine/models/RepeatingSummaryViewModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RepeatingSummaryViewModel.js","names":[],"sources":["../../../../../src/server/plugins/engine/models/RepeatingSummaryViewModel.ts"],"sourcesContent":[""],"mappings":"","ignoreList":[]}

package/.server/server/plugins/engine/models/Section.js

@@ -0,0 +1,2 @@
+
+//# sourceMappingURL=Section.js.map

package/.server/server/plugins/engine/models/Section.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Section.js","names":[],"sources":["../../../../../src/server/plugins/engine/models/Section.ts"],"sourcesContent":[""],"mappings":"","ignoreList":[]}

package/.server/server/plugins/engine/models/SummaryViewModel.js

@@ -0,0 +1,183 @@
+import { getAnswer } from "../components/helpers.js";
+import { evaluateTemplate, getError, getPageHref } from "../helpers.js";
+import { RepeatPageController } from "../pageControllers/RepeatPageController.js";
+import { validationOptions as opts } from "../pageControllers/validationOptions.js";
+export class SummaryViewModel {
+  /**
+   * Responsible for parsing state values to the govuk-frontend summary list template
+   */
+
+  page;
+  pageTitle;
+  declaration;
+  details;
+  checkAnswers;
+  context;
+  name;
+  backLink;
+  feedbackLink;
+  phaseTag;
+  errors;
+  serviceUrl;
+  hasMissingNotificationEmail;
+  constructor(request, page, context) {
+    const {
+      model
+    } = page;
+    const {
+      basePath,
+      def,
+      sections
+    } = model;
+    const {
+      isForceAccess
+    } = context;
+    this.page = page;
+    this.pageTitle = page.title;
+    this.serviceUrl = `/${basePath}`;
+    this.name = def.name;
+    this.declaration = def.declaration;
+    this.context = context;
+    const result = model.makeFilteredSchema(this.context.relevantPages).validate(this.context.relevantState, {
+      ...opts,
+      stripUnknown: true
+    });
+
+    // Format errors
+    this.errors = result.error?.details.map(getError);
+    this.details = this.summaryDetails(request, sections);
+
+    // Format check answers
+    this.checkAnswers = this.details.map(detail => {
+      const {
+        title
+      } = detail;
+      const rows = detail.items.map(item => {
+        const items = [];
+
+        // Remove summary list actions from previews
+        if (!isForceAccess) {
+          items.push({
+            href: item.href,
+            text: 'Change',
+            classes: 'govuk-link--no-visited-state',
+            visuallyHiddenText: item.label
+          });
+        }
+        return {
+          key: {
+            text: evaluateTemplate(item.title, context)
+          },
+          value: {
+            classes: 'app-prose-scope',
+            html: item.value || 'Not supplied'
+          },
+          actions: {
+            items
+          }
+        };
+      });
+      return {
+        title: title ? {
+          text: title
+        } : undefined,
+        summaryList: {
+          rows
+        }
+      };
+    });
+  }
+  summaryDetails(request, sections) {
+    const {
+      context,
+      errors
+    } = this;
+    const {
+      relevantPages,
+      state
+    } = context;
+    const details = [];
+    [undefined, ...sections].forEach(section => {
+      const items = [];
+      const sectionPages = relevantPages.filter(page => page.section === section);
+      sectionPages.forEach(page => {
+        const {
+          collection,
+          path
+        } = page;
+        if (page instanceof RepeatPageController) {
+          items.push(ItemRepeat(page, state, {
+            path: page.getSummaryPath(request),
+            errors
+          }));
+        } else {
+          for (const field of collection.fields) {
+            items.push(ItemField(page, state, field, {
+              path,
+              errors
+            }));
+          }
+        }
+      });
+      if (items.length) {
+        details.push({
+          name: section?.name,
+          title: section?.title,
+          items
+        });
+      }
+    });
+    return details;
+  }
+}
+
+/**
+ * Creates a repeater detail item
+ * @see {@link DetailItemField}
+ */
+function ItemRepeat(page, state, options) {
+  const {
+    collection,
+    repeat
+  } = page;
+  const {
+    name,
+    title
+  } = repeat.options;
+  const values = page.getListFromState(state);
+  const unit = values.length === 1 ? title : `${title}s`;
+  return {
+    name,
+    label: title,
+    title: values.length ? `${unit} added` : unit,
+    value: values.length ? `You added ${values.length} ${unit}` : '',
+    href: getPageHref(page, options.path, {
+      returnUrl: getPageHref(page, page.getSummaryPath())
+    }),
+    state,
+    page,
+    // Repeater field detail items
+    subItems: values.map(repeatState => collection.fields.map(field => ItemField(page, repeatState, field, options)))
+  };
+}
+
+/**
+ * Creates a form field detail item
+ * @see {@link DetailItemField}
+ */
+function ItemField(page, state, field, options) {
+  return {
+    name: field.name,
+    label: field.title,
+    title: field.title,
+    error: field.getError(options.errors),
+    value: getAnswer(field, state),
+    href: getPageHref(page, options.path, {
+      returnUrl: getPageHref(page, page.getSummaryPath())
+    }),
+    state,
+    page,
+    field
+  };
+}
+//# sourceMappingURL=SummaryViewModel.js.map

package/.server/server/plugins/engine/models/SummaryViewModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SummaryViewModel.js","names":["getAnswer","evaluateTemplate","getError","getPageHref","RepeatPageController","validationOptions","opts","SummaryViewModel","page","pageTitle","declaration","details","checkAnswers","context","name","backLink","feedbackLink","phaseTag","errors","serviceUrl","hasMissingNotificationEmail","constructor","request","model","basePath","def","sections","isForceAccess","title","result","makeFilteredSchema","relevantPages","validate","relevantState","stripUnknown","error","map","summaryDetails","detail","rows","items","item","push","href","text","classes","visuallyHiddenText","label","key","value","html","actions","undefined","summaryList","state","forEach","section","sectionPages","filter","collection","path","ItemRepeat","getSummaryPath","field","fields","ItemField","length","options","repeat","values","getListFromState","unit","returnUrl","subItems","repeatState"],"sources":["../../../../../src/server/plugins/engine/models/SummaryViewModel.ts"],"sourcesContent":["import { type Section } from '@defra/forms-model'\n\nimport {\n  getAnswer,\n  type Field\n} from '~/src/server/plugins/engine/components/helpers.js'\nimport { type BackLink } from '~/src/server/plugins/engine/components/types.js'\nimport {\n  evaluateTemplate,\n  getError,\n  getPageHref\n} from '~/src/server/plugins/engine/helpers.js'\nimport {\n  type Detail,\n  type DetailItem,\n  type DetailItemField,\n  type DetailItemRepeat\n} from '~/src/server/plugins/engine/models/types.js'\nimport { RepeatPageController } from '~/src/server/plugins/engine/pageControllers/RepeatPageController.js'\nimport { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers.js'\nimport { validationOptions as opts } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\nimport {\n  type CheckAnswers,\n  type FormContext,\n  type FormContextRequest,\n  type FormState,\n  type FormSubmissionError,\n  type SummaryListAction,\n  type SummaryListRow\n} from '~/src/server/plugins/engine/types.js'\n\nexport class SummaryViewModel {\n  /**\n   * Responsible for parsing state values to the govuk-frontend summary list template\n   */\n\n  page: PageControllerClass\n  pageTitle: string\n  declaration?: string\n  details: Detail[]\n  checkAnswers: CheckAnswers[]\n  context: FormContext\n  name: string | undefined\n  backLink?: BackLink\n  feedbackLink?: string\n  phaseTag?: string\n  errors?: FormSubmissionError[]\n  serviceUrl: string\n  hasMissingNotificationEmail?: boolean\n\n  constructor(\n    request: FormContextRequest,\n    page: PageControllerClass,\n    context: FormContext\n  ) {\n    const { model } = page\n    const { basePath, def, sections } = model\n    const { isForceAccess } = context\n\n    this.page = page\n    this.pageTitle = page.title\n    this.serviceUrl = `/${basePath}`\n    this.name = def.name\n    this.declaration = def.declaration\n    this.context = context\n\n    const result = model\n      .makeFilteredSchema(this.context.relevantPages)\n      .validate(this.context.relevantState, { ...opts, stripUnknown: true })\n\n    // Format errors\n    this.errors = result.error?.details.map(getError)\n    this.details = this.summaryDetails(request, sections)\n\n    // Format check answers\n    this.checkAnswers = this.details.map((detail): CheckAnswers => {\n      const { title } = detail\n\n      const rows = detail.items.map((item): SummaryListRow => {\n        const items: SummaryListAction[] = []\n\n        // Remove summary list actions from previews\n        if (!isForceAccess) {\n          items.push({\n            href: item.href,\n            text: 'Change',\n            classes: 'govuk-link--no-visited-state',\n            visuallyHiddenText: item.label\n          })\n        }\n\n        return {\n          key: {\n            text: evaluateTemplate(item.title, context)\n          },\n          value: {\n            classes: 'app-prose-scope',\n            html: item.value || 'Not supplied'\n          },\n          actions: {\n            items\n          }\n        }\n      })\n\n      return {\n        title: title ? { text: title } : undefined,\n        summaryList: { rows }\n      }\n    })\n  }\n\n  private summaryDetails(request: FormContextRequest, sections: Section[]) {\n    const { context, errors } = this\n    const { relevantPages, state } = context\n\n    const details: Detail[] = []\n\n    ;[undefined, ...sections].forEach((section) => {\n      const items: DetailItem[] = []\n\n      const sectionPages = relevantPages.filter(\n        (page) => page.section === section\n      )\n\n      sectionPages.forEach((page) => {\n        const { collection, path } = page\n\n        if (page instanceof RepeatPageController) {\n          items.push(\n            ItemRepeat(page, state, {\n              path: page.getSummaryPath(request),\n              errors\n            })\n          )\n        } else {\n          for (const field of collection.fields) {\n            items.push(ItemField(page, state, field, { path, errors }))\n          }\n        }\n      })\n\n      if (items.length) {\n        details.push({\n          name: section?.name,\n          title: section?.title,\n          items\n        })\n      }\n    })\n\n    return details\n  }\n}\n\n/**\n * Creates a repeater detail item\n * @see {@link DetailItemField}\n */\nfunction ItemRepeat(\n  page: RepeatPageController,\n  state: FormState,\n  options: {\n    path: string\n    errors?: FormSubmissionError[]\n  }\n): DetailItemRepeat {\n  const { collection, repeat } = page\n  const { name, title } = repeat.options\n\n  const values = page.getListFromState(state)\n  const unit = values.length === 1 ? title : `${title}s`\n\n  return {\n    name,\n    label: title,\n    title: values.length ? `${unit} added` : unit,\n    value: values.length ? `You added ${values.length} ${unit}` : '',\n    href: getPageHref(page, options.path, {\n      returnUrl: getPageHref(page, page.getSummaryPath())\n    }),\n    state,\n    page,\n\n    // Repeater field detail items\n    subItems: values.map((repeatState) =>\n      collection.fields.map((field) =>\n        ItemField(page, repeatState, field, options)\n      )\n    )\n  }\n}\n\n/**\n * Creates a form field detail item\n * @see {@link DetailItemField}\n */\nfunction ItemField(\n  page: PageControllerClass,\n  state: FormState,\n  field: Field,\n  options: {\n    path: string\n    errors?: FormSubmissionError[]\n  }\n): DetailItemField {\n  return {\n    name: field.name,\n    label: field.title,\n    title: field.title,\n    error: field.getError(options.errors),\n    value: getAnswer(field, state),\n    href: getPageHref(page, options.path, {\n      returnUrl: getPageHref(page, page.getSummaryPath())\n    }),\n    state,\n    page,\n    field\n  }\n}\n"],"mappings":"AAEA,SACEA,SAAS;AAIX,SACEC,gBAAgB,EAChBC,QAAQ,EACRC,WAAW;AAQb,SAASC,oBAAoB;AAE7B,SAASC,iBAAiB,IAAIC,IAAI;AAWlC,OAAO,MAAMC,gBAAgB,CAAC;EAC5B;AACF;AACA;;EAEEC,IAAI;EACJC,SAAS;EACTC,WAAW;EACXC,OAAO;EACPC,YAAY;EACZC,OAAO;EACPC,IAAI;EACJC,QAAQ;EACRC,YAAY;EACZC,QAAQ;EACRC,MAAM;EACNC,UAAU;EACVC,2BAA2B;EAE3BC,WAAWA,CACTC,OAA2B,EAC3Bd,IAAyB,EACzBK,OAAoB,EACpB;IACA,MAAM;MAAEU;IAAM,CAAC,GAAGf,IAAI;IACtB,MAAM;MAAEgB,QAAQ;MAAEC,GAAG;MAAEC;IAAS,CAAC,GAAGH,KAAK;IACzC,MAAM;MAAEI;IAAc,CAAC,GAAGd,OAAO;IAEjC,IAAI,CAACL,IAAI,GAAGA,IAAI;IAChB,IAAI,CAACC,SAAS,GAAGD,IAAI,CAACoB,KAAK;IAC3B,IAAI,CAACT,UAAU,GAAG,IAAIK,QAAQ,EAAE;IAChC,IAAI,CAACV,IAAI,GAAGW,GAAG,CAACX,IAAI;IACpB,IAAI,CAACJ,WAAW,GAAGe,GAAG,CAACf,WAAW;IAClC,IAAI,CAACG,OAAO,GAAGA,OAAO;IAEtB,MAAMgB,MAAM,GAAGN,KAAK,CACjBO,kBAAkB,CAAC,IAAI,CAACjB,OAAO,CAACkB,aAAa,CAAC,CAC9CC,QAAQ,CAAC,IAAI,CAACnB,OAAO,CAACoB,aAAa,EAAE;MAAE,GAAG3B,IAAI;MAAE4B,YAAY,EAAE;IAAK,CAAC,CAAC;;IAExE;IACA,IAAI,CAAChB,MAAM,GAAGW,MAAM,CAACM,KAAK,EAAExB,OAAO,CAACyB,GAAG,CAAClC,QAAQ,CAAC;IACjD,IAAI,CAACS,OAAO,GAAG,IAAI,CAAC0B,cAAc,CAACf,OAAO,EAAEI,QAAQ,CAAC;;IAErD;IACA,IAAI,CAACd,YAAY,GAAG,IAAI,CAACD,OAAO,CAACyB,GAAG,CAAEE,MAAM,IAAmB;MAC7D,MAAM;QAAEV;MAAM,CAAC,GAAGU,MAAM;MAExB,MAAMC,IAAI,GAAGD,MAAM,CAACE,KAAK,CAACJ,GAAG,CAAEK,IAAI,IAAqB;QACtD,MAAMD,KAA0B,GAAG,EAAE;;QAErC;QACA,IAAI,CAACb,aAAa,EAAE;UAClBa,KAAK,CAACE,IAAI,CAAC;YACTC,IAAI,EAAEF,IAAI,CAACE,IAAI;YACfC,IAAI,EAAE,QAAQ;YACdC,OAAO,EAAE,8BAA8B;YACvCC,kBAAkB,EAAEL,IAAI,CAACM;UAC3B,CAAC,CAAC;QACJ;QAEA,OAAO;UACLC,GAAG,EAAE;YACHJ,IAAI,EAAE3C,gBAAgB,CAACwC,IAAI,CAACb,KAAK,EAAEf,OAAO;UAC5C,CAAC;UACDoC,KAAK,EAAE;YACLJ,OAAO,EAAE,iBAAiB;YAC1BK,IAAI,EAAET,IAAI,CAACQ,KAAK,IAAI;UACtB,CAAC;UACDE,OAAO,EAAE;YACPX;UACF;QACF,CAAC;MACH,CAAC,CAAC;MAEF,OAAO;QACLZ,KAAK,EAAEA,KAAK,GAAG;UAAEgB,IAAI,EAAEhB;QAAM,CAAC,GAAGwB,SAAS;QAC1CC,WAAW,EAAE;UAAEd;QAAK;MACtB,CAAC;IACH,CAAC,CAAC;EACJ;EAEQF,cAAcA,CAACf,OAA2B,EAAEI,QAAmB,EAAE;IACvE,MAAM;MAAEb,OAAO;MAAEK;IAAO,CAAC,GAAG,IAAI;IAChC,MAAM;MAAEa,aAAa;MAAEuB;IAAM,CAAC,GAAGzC,OAAO;IAExC,MAAMF,OAAiB,GAAG,EAAE;IAE3B,CAACyC,SAAS,EAAE,GAAG1B,QAAQ,CAAC,CAAC6B,OAAO,CAAEC,OAAO,IAAK;MAC7C,MAAMhB,KAAmB,GAAG,EAAE;MAE9B,MAAMiB,YAAY,GAAG1B,aAAa,CAAC2B,MAAM,CACtClD,IAAI,IAAKA,IAAI,CAACgD,OAAO,KAAKA,OAC7B,CAAC;MAEDC,YAAY,CAACF,OAAO,CAAE/C,IAAI,IAAK;QAC7B,MAAM;UAAEmD,UAAU;UAAEC;QAAK,CAAC,GAAGpD,IAAI;QAEjC,IAAIA,IAAI,YAAYJ,oBAAoB,EAAE;UACxCoC,KAAK,CAACE,IAAI,CACRmB,UAAU,CAACrD,IAAI,EAAE8C,KAAK,EAAE;YACtBM,IAAI,EAAEpD,IAAI,CAACsD,cAAc,CAACxC,OAAO,CAAC;YAClCJ;UACF,CAAC,CACH,CAAC;QACH,CAAC,MAAM;UACL,KAAK,MAAM6C,KAAK,IAAIJ,UAAU,CAACK,MAAM,EAAE;YACrCxB,KAAK,CAACE,IAAI,CAACuB,SAAS,CAACzD,IAAI,EAAE8C,KAAK,EAAES,KAAK,EAAE;cAAEH,IAAI;cAAE1C;YAAO,CAAC,CAAC,CAAC;UAC7D;QACF;MACF,CAAC,CAAC;MAEF,IAAIsB,KAAK,CAAC0B,MAAM,EAAE;QAChBvD,OAAO,CAAC+B,IAAI,CAAC;UACX5B,IAAI,EAAE0C,OAAO,EAAE1C,IAAI;UACnBc,KAAK,EAAE4B,OAAO,EAAE5B,KAAK;UACrBY;QACF,CAAC,CAAC;MACJ;IACF,CAAC,CAAC;IAEF,OAAO7B,OAAO;EAChB;AACF;;AAEA;AACA;AACA;AACA;AACA,SAASkD,UAAUA,CACjBrD,IAA0B,EAC1B8C,KAAgB,EAChBa,OAGC,EACiB;EAClB,MAAM;IAAER,UAAU;IAAES;EAAO,CAAC,GAAG5D,IAAI;EACnC,MAAM;IAAEM,IAAI;IAAEc;EAAM,CAAC,GAAGwC,MAAM,CAACD,OAAO;EAEtC,MAAME,MAAM,GAAG7D,IAAI,CAAC8D,gBAAgB,CAAChB,KAAK,CAAC;EAC3C,MAAMiB,IAAI,GAAGF,MAAM,CAACH,MAAM,KAAK,CAAC,GAAGtC,KAAK,GAAG,GAAGA,KAAK,GAAG;EAEtD,OAAO;IACLd,IAAI;IACJiC,KAAK,EAAEnB,KAAK;IACZA,KAAK,EAAEyC,MAAM,CAACH,MAAM,GAAG,GAAGK,IAAI,QAAQ,GAAGA,IAAI;IAC7CtB,KAAK,EAAEoB,MAAM,CAACH,MAAM,GAAG,aAAaG,MAAM,CAACH,MAAM,IAAIK,IAAI,EAAE,GAAG,EAAE;IAChE5B,IAAI,EAAExC,WAAW,CAACK,IAAI,EAAE2D,OAAO,CAACP,IAAI,EAAE;MACpCY,SAAS,EAAErE,WAAW,CAACK,IAAI,EAAEA,IAAI,CAACsD,cAAc,CAAC,CAAC;IACpD,CAAC,CAAC;IACFR,KAAK;IACL9C,IAAI;IAEJ;IACAiE,QAAQ,EAAEJ,MAAM,CAACjC,GAAG,CAAEsC,WAAW,IAC/Bf,UAAU,CAACK,MAAM,CAAC5B,GAAG,CAAE2B,KAAK,IAC1BE,SAAS,CAACzD,IAAI,EAAEkE,WAAW,EAAEX,KAAK,EAAEI,OAAO,CAC7C,CACF;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA,SAASF,SAASA,CAChBzD,IAAyB,EACzB8C,KAAgB,EAChBS,KAAY,EACZI,OAGC,EACgB;EACjB,OAAO;IACLrD,IAAI,EAAEiD,KAAK,CAACjD,IAAI;IAChBiC,KAAK,EAAEgB,KAAK,CAACnC,KAAK;IAClBA,KAAK,EAAEmC,KAAK,CAACnC,KAAK;IAClBO,KAAK,EAAE4B,KAAK,CAAC7D,QAAQ,CAACiE,OAAO,CAACjD,MAAM,CAAC;IACrC+B,KAAK,EAAEjD,SAAS,CAAC+D,KAAK,EAAET,KAAK,CAAC;IAC9BX,IAAI,EAAExC,WAAW,CAACK,IAAI,EAAE2D,OAAO,CAACP,IAAI,EAAE;MACpCY,SAAS,EAAErE,WAAW,CAACK,IAAI,EAAEA,IAAI,CAACsD,cAAc,CAAC,CAAC;IACpD,CAAC,CAAC;IACFR,KAAK;IACL9C,IAAI;IACJuD;EACF,CAAC;AACH","ignoreList":[]}

package/.server/server/plugins/engine/models/index.js

@@ -0,0 +1,3 @@
+export { FormModel } from "./FormModel.js";
+export { SummaryViewModel } from "./SummaryViewModel.js";
+//# sourceMappingURL=index.js.map

package/.server/server/plugins/engine/models/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["FormModel","SummaryViewModel"],"sources":["../../../../../src/server/plugins/engine/models/index.ts"],"sourcesContent":["export { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'\nexport { SummaryViewModel } from '~/src/server/plugins/engine/models/SummaryViewModel.js'\n"],"mappings":"AAAA,SAASA,SAAS;AAClB,SAASC,gBAAgB","ignoreList":[]}

package/.server/server/plugins/engine/models/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/.server/server/plugins/engine/models/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","names":[],"sources":["../../../../../src/server/plugins/engine/models/types.ts"],"sourcesContent":["import {\n  type ConditionWrapper,\n  type FormComponentsDef,\n  type Section\n} from '@defra/forms-model'\nimport { type Expression } from 'expr-eval'\n\nimport {\n  type Field,\n  type getAnswer\n} from '~/src/server/plugins/engine/components/helpers.js'\nimport { type RepeatPageController } from '~/src/server/plugins/engine/pageControllers/RepeatPageController.js'\nimport { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers.js'\nimport {\n  type FormState,\n  type FormSubmissionError\n} from '~/src/server/plugins/engine/types.js'\n\nexport type ExecutableCondition = ConditionWrapper & {\n  expr: Expression\n  fn: (evaluationState: FormState) => boolean\n}\n\n/**\n * Used to render a row on a Summary List (check your answers)\n */\nexport interface DetailItemBase {\n  /**\n   * Name of the component defined in the JSON\n   * @see {@link FormComponentsDef.name}\n   */\n  name: string\n\n  /**\n   * Field label, used for change link visually hidden text\n   * @see {@link FormComponentsDef.title}\n   */\n  label: string\n\n  /**\n   * Field change link\n   */\n  href: string\n\n  /**\n   * Form submission state (or repeat state for sub items)\n   */\n  state: FormState\n\n  /**\n   * Field submission state error, used to flag unanswered questions\n   * Shown as 'Complete all unanswered questions before submitting the form'\n   */\n  error?: FormSubmissionError\n}\n\nexport interface DetailItemField extends DetailItemBase {\n  /**\n   * Field page controller instance\n   */\n  page: Exclude<PageControllerClass, RepeatPageController>\n\n  /**\n   * Check answers summary list key\n   * For example, 'Date of birth'\n   */\n  title: string\n\n  /**\n   * Check answers summary list value, formatted by {@link getAnswer}\n   * For example, date fields formatted as '25 December 2022'\n   */\n  value: string\n\n  /**\n   * Field component instance\n   */\n  field: Field\n}\n\nexport interface DetailItemRepeat extends DetailItemBase {\n  /**\n   * Repeat page controller instance\n   */\n  page: RepeatPageController\n\n  /**\n   * Check answers summary list key\n   * For example, 'Pizza' or 'Pizza added'\n   */\n  title: string\n\n  /**\n   * Check answers summary list value\n   * For example, 'You added 2 Pizzas'\n   */\n  value: string\n\n  /**\n   * Repeater field detail items\n   */\n  subItems: DetailItemField[][]\n}\n\nexport type DetailItem = DetailItemField | DetailItemRepeat\n\n/**\n * Used to render a row on a Summary List (check your answers)\n */\nexport interface Detail {\n  name?: Section['name']\n  title?: Section['title']\n  items: DetailItem[]\n}\n"],"mappings":"","ignoreList":[]}

package/.server/server/plugins/engine/outputFormatters/human/v1.js

@@ -0,0 +1,44 @@
+import { addDays, format as dateFormat } from 'date-fns';
+import { config } from "../../../../../config/index.js";
+import { escapeMarkdown, getAnswer } from "../../components/helpers.js";
+const designerUrl = config.get('designerUrl');
+export function format(items, model, submitResponse, formStatus) {
+  const {
+    files
+  } = submitResponse.result;
+  const formName = escapeMarkdown(model.name);
+
+  /**
+   * @todo Refactor this below but the code to
+   * generate the question and answers works for now
+   */
+  const now = new Date();
+  const formattedNow = `${dateFormat(now, 'h:mmaaa')} on ${dateFormat(now, 'd MMMM yyyy')}`;
+  const fileExpiryDate = addDays(now, 90);
+  const formattedExpiryDate = `${dateFormat(fileExpiryDate, 'h:mmaaa')} on ${dateFormat(fileExpiryDate, 'eeee d MMMM yyyy')}`;
+  const lines = [];
+  lines.push(`^ For security reasons, the links in this email expire at ${escapeMarkdown(formattedExpiryDate)}\n`);
+  if (formStatus.isPreview) {
+    lines.push(`This is a test of the ${formName} ${formStatus.state} form.\n`);
+  }
+  lines.push(`Form submitted at ${escapeMarkdown(formattedNow)}.\n`);
+  lines.push('---\n');
+  items.forEach(item => {
+    const label = escapeMarkdown(item.label);
+    lines.push(`## ${label}\n`);
+    if ('subItems' in item) {
+      const filename = escapeMarkdown(`Download ${label} (CSV)`);
+      const fileId = files.repeaters[item.name];
+      lines.push(`[${filename}](${designerUrl}/file-download/${fileId})\n`);
+    } else {
+      lines.push(getAnswer(item.field, item.state, {
+        format: 'email'
+      }));
+    }
+    lines.push('---\n');
+  });
+  const filename = escapeMarkdown('Download main form (CSV)');
+  lines.push(`[${filename}](${designerUrl}/file-download/${files.main})\n`);
+  return lines.join('\n');
+}
+//# sourceMappingURL=v1.js.map

package/.server/server/plugins/engine/outputFormatters/human/v1.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"v1.js","names":["addDays","format","dateFormat","config","escapeMarkdown","getAnswer","designerUrl","get","items","model","submitResponse","formStatus","files","result","formName","name","now","Date","formattedNow","fileExpiryDate","formattedExpiryDate","lines","push","isPreview","state","forEach","item","label","filename","fileId","repeaters","field","main","join"],"sources":["../../../../../../src/server/plugins/engine/outputFormatters/human/v1.ts"],"sourcesContent":["import { type SubmitResponsePayload } from '@defra/forms-model'\nimport { addDays, format as dateFormat } from 'date-fns'\n\nimport { config } from '~/src/config/index.js'\nimport {\n  escapeMarkdown,\n  getAnswer\n} from '~/src/server/plugins/engine/components/helpers.js'\nimport { type checkFormStatus } from '~/src/server/plugins/engine/helpers.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type DetailItem } from '~/src/server/plugins/engine/models/types.js'\n\nconst designerUrl = config.get('designerUrl')\n\nexport function format(\n  items: DetailItem[],\n  model: FormModel,\n  submitResponse: SubmitResponsePayload,\n  formStatus: ReturnType<typeof checkFormStatus>\n) {\n  const { files } = submitResponse.result\n\n  const formName = escapeMarkdown(model.name)\n\n  /**\n   * @todo Refactor this below but the code to\n   * generate the question and answers works for now\n   */\n  const now = new Date()\n  const formattedNow = `${dateFormat(now, 'h:mmaaa')} on ${dateFormat(now, 'd MMMM yyyy')}`\n\n  const fileExpiryDate = addDays(now, 90)\n  const formattedExpiryDate = `${dateFormat(fileExpiryDate, 'h:mmaaa')} on ${dateFormat(fileExpiryDate, 'eeee d MMMM yyyy')}`\n\n  const lines: string[] = []\n\n  lines.push(\n    `^ For security reasons, the links in this email expire at ${escapeMarkdown(formattedExpiryDate)}\\n`\n  )\n\n  if (formStatus.isPreview) {\n    lines.push(`This is a test of the ${formName} ${formStatus.state} form.\\n`)\n  }\n\n  lines.push(`Form submitted at ${escapeMarkdown(formattedNow)}.\\n`)\n  lines.push('---\\n')\n\n  items.forEach((item) => {\n    const label = escapeMarkdown(item.label)\n\n    lines.push(`## ${label}\\n`)\n\n    if ('subItems' in item) {\n      const filename = escapeMarkdown(`Download ${label} (CSV)`)\n      const fileId = files.repeaters[item.name]\n\n      lines.push(`[${filename}](${designerUrl}/file-download/${fileId})\\n`)\n    } else {\n      lines.push(\n        getAnswer(item.field, item.state, {\n          format: 'email'\n        })\n      )\n    }\n\n    lines.push('---\\n')\n  })\n\n  const filename = escapeMarkdown('Download main form (CSV)')\n  lines.push(`[${filename}](${designerUrl}/file-download/${files.main})\\n`)\n\n  return lines.join('\\n')\n}\n"],"mappings":"AACA,SAASA,OAAO,EAAEC,MAAM,IAAIC,UAAU,QAAQ,UAAU;AAExD,SAASC,MAAM;AACf,SACEC,cAAc,EACdC,SAAS;AAMX,MAAMC,WAAW,GAAGH,MAAM,CAACI,GAAG,CAAC,aAAa,CAAC;AAE7C,OAAO,SAASN,MAAMA,CACpBO,KAAmB,EACnBC,KAAgB,EAChBC,cAAqC,EACrCC,UAA8C,EAC9C;EACA,MAAM;IAAEC;EAAM,CAAC,GAAGF,cAAc,CAACG,MAAM;EAEvC,MAAMC,QAAQ,GAAGV,cAAc,CAACK,KAAK,CAACM,IAAI,CAAC;;EAE3C;AACF;AACA;AACA;EACE,MAAMC,GAAG,GAAG,IAAIC,IAAI,CAAC,CAAC;EACtB,MAAMC,YAAY,GAAG,GAAGhB,UAAU,CAACc,GAAG,EAAE,SAAS,CAAC,OAAOd,UAAU,CAACc,GAAG,EAAE,aAAa,CAAC,EAAE;EAEzF,MAAMG,cAAc,GAAGnB,OAAO,CAACgB,GAAG,EAAE,EAAE,CAAC;EACvC,MAAMI,mBAAmB,GAAG,GAAGlB,UAAU,CAACiB,cAAc,EAAE,SAAS,CAAC,OAAOjB,UAAU,CAACiB,cAAc,EAAE,kBAAkB,CAAC,EAAE;EAE3H,MAAME,KAAe,GAAG,EAAE;EAE1BA,KAAK,CAACC,IAAI,CACR,6DAA6DlB,cAAc,CAACgB,mBAAmB,CAAC,IAClG,CAAC;EAED,IAAIT,UAAU,CAACY,SAAS,EAAE;IACxBF,KAAK,CAACC,IAAI,CAAC,yBAAyBR,QAAQ,IAAIH,UAAU,CAACa,KAAK,UAAU,CAAC;EAC7E;EAEAH,KAAK,CAACC,IAAI,CAAC,qBAAqBlB,cAAc,CAACc,YAAY,CAAC,KAAK,CAAC;EAClEG,KAAK,CAACC,IAAI,CAAC,OAAO,CAAC;EAEnBd,KAAK,CAACiB,OAAO,CAAEC,IAAI,IAAK;IACtB,MAAMC,KAAK,GAAGvB,cAAc,CAACsB,IAAI,CAACC,KAAK,CAAC;IAExCN,KAAK,CAACC,IAAI,CAAC,MAAMK,KAAK,IAAI,CAAC;IAE3B,IAAI,UAAU,IAAID,IAAI,EAAE;MACtB,MAAME,QAAQ,GAAGxB,cAAc,CAAC,YAAYuB,KAAK,QAAQ,CAAC;MAC1D,MAAME,MAAM,GAAGjB,KAAK,CAACkB,SAAS,CAACJ,IAAI,CAACX,IAAI,CAAC;MAEzCM,KAAK,CAACC,IAAI,CAAC,IAAIM,QAAQ,KAAKtB,WAAW,kBAAkBuB,MAAM,KAAK,CAAC;IACvE,CAAC,MAAM;MACLR,KAAK,CAACC,IAAI,CACRjB,SAAS,CAACqB,IAAI,CAACK,KAAK,EAAEL,IAAI,CAACF,KAAK,EAAE;QAChCvB,MAAM,EAAE;MACV,CAAC,CACH,CAAC;IACH;IAEAoB,KAAK,CAACC,IAAI,CAAC,OAAO,CAAC;EACrB,CAAC,CAAC;EAEF,MAAMM,QAAQ,GAAGxB,cAAc,CAAC,0BAA0B,CAAC;EAC3DiB,KAAK,CAACC,IAAI,CAAC,IAAIM,QAAQ,KAAKtB,WAAW,kBAAkBM,KAAK,CAACoB,IAAI,KAAK,CAAC;EAEzE,OAAOX,KAAK,CAACY,IAAI,CAAC,IAAI,CAAC;AACzB","ignoreList":[]}

package/.server/server/plugins/engine/outputFormatters/index.js

@@ -0,0 +1,24 @@
+import { format as formatHumanV1 } from "./human/v1.js";
+import { format as formatMachineV1 } from "./machine/v1.js";
+import { format as formatMachineV2 } from "./machine/v2.js";
+const formatters = {
+  human: {
+    '1': formatHumanV1
+  },
+  machine: {
+    '1': formatMachineV1,
+    '2': formatMachineV2
+  }
+};
+export function getFormatter(audience, version) {
+  const versions = formatters[audience];
+  if (!versions) {
+    throw new Error('Unknown audience');
+  }
+  const formatter = versions[version];
+  if (!formatter) {
+    throw new Error('Unknown version');
+  }
+  return formatter;
+}
+//# sourceMappingURL=index.js.map

package/.server/server/plugins/engine/outputFormatters/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["format","formatHumanV1","formatMachineV1","formatMachineV2","formatters","human","machine","getFormatter","audience","version","versions","Error","formatter"],"sources":["../../../../../src/server/plugins/engine/outputFormatters/index.ts"],"sourcesContent":["import { type SubmitResponsePayload } from '@defra/forms-model'\n\nimport { type checkFormStatus } from '~/src/server/plugins/engine/helpers.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type DetailItem } from '~/src/server/plugins/engine/models/types.js'\nimport { format as formatHumanV1 } from '~/src/server/plugins/engine/outputFormatters/human/v1.js'\nimport { format as formatMachineV1 } from '~/src/server/plugins/engine/outputFormatters/machine/v1.js'\nimport { format as formatMachineV2 } from '~/src/server/plugins/engine/outputFormatters/machine/v2.js'\n\ntype Formatter = (\n  items: DetailItem[],\n  model: FormModel,\n  submitResponse: SubmitResponsePayload,\n  formStatus: ReturnType<typeof checkFormStatus>\n) => string\n\nconst formatters: Record<\n  string,\n  Record<string, Formatter | undefined> | undefined\n> = {\n  human: {\n    '1': formatHumanV1\n  },\n  machine: {\n    '1': formatMachineV1,\n    '2': formatMachineV2\n  }\n}\n\nexport function getFormatter(audience: string, version: string) {\n  const versions = formatters[audience]\n\n  if (!versions) {\n    throw new Error('Unknown audience')\n  }\n\n  const formatter = versions[version]\n\n  if (!formatter) {\n    throw new Error('Unknown version')\n  }\n\n  return formatter\n}\n"],"mappings":"AAKA,SAASA,MAAM,IAAIC,aAAa;AAChC,SAASD,MAAM,IAAIE,eAAe;AAClC,SAASF,MAAM,IAAIG,eAAe;AASlC,MAAMC,UAGL,GAAG;EACFC,KAAK,EAAE;IACL,GAAG,EAAEJ;EACP,CAAC;EACDK,OAAO,EAAE;IACP,GAAG,EAAEJ,eAAe;IACpB,GAAG,EAAEC;EACP;AACF,CAAC;AAED,OAAO,SAASI,YAAYA,CAACC,QAAgB,EAAEC,OAAe,EAAE;EAC9D,MAAMC,QAAQ,GAAGN,UAAU,CAACI,QAAQ,CAAC;EAErC,IAAI,CAACE,QAAQ,EAAE;IACb,MAAM,IAAIC,KAAK,CAAC,kBAAkB,CAAC;EACrC;EAEA,MAAMC,SAAS,GAAGF,QAAQ,CAACD,OAAO,CAAC;EAEnC,IAAI,CAACG,SAAS,EAAE;IACd,MAAM,IAAID,KAAK,CAAC,iBAAiB,CAAC;EACpC;EAEA,OAAOC,SAAS;AAClB","ignoreList":[]}

package/.server/server/plugins/engine/outputFormatters/machine/v1.js

@@ -0,0 +1,104 @@
+import { config } from "../../../../../config/index.js";
+import { getAnswer } from "../../components/helpers.js";
+import { FileUploadField } from "../../components/index.js";
+const designerUrl = config.get('designerUrl');
+export function format(items, model, _submitResponse, _formStatus) {
+  const now = new Date();
+  const categorisedData = categoriseData(items);
+  const data = {
+    meta: {
+      schemaVersion: '1',
+      timestamp: now.toISOString(),
+      definition: model.def
+    },
+    data: categorisedData
+  };
+  const body = JSON.stringify(data);
+  return body;
+}
+
+/**
+ * Categories the form submission data into the "main" body and "repeaters".
+ *
+ * {
+ *    main: {
+ *       componentName: 'componentValue',
+ *    },
+ *    repeaters: {
+ *      repeaterName: [
+ *        {
+ *          componentName: 'componentValue'
+ *        }
+ *      ]
+ *    },
+ *    files: {
+ *      fileComponentName: [
+ *        {
+ *          fileId: '123-456-789',
+ *          link: 'https://forms-designer/file-download/123-456-789'
+ *        }
+ *      ]
+ *    }
+ * }
+ */
+function categoriseData(items) {
+  const output = {
+    main: {},
+    repeaters: {},
+    files: {}
+  };
+  items.forEach(item => {
+    if ('subItems' in item) {
+      output.repeaters[item.name] = extractRepeaters(item);
+    } else if (isFileUploadFieldItem(item)) {
+      output.files[item.name] = extractFileUploads(item);
+    } else {
+      output.main[item.name] = getAnswer(item.field, item.state, {
+        format: 'data'
+      });
+    }
+  });
+  return output;
+}
+
+/**
+ * Returns the "repeaters" section of the response body
+ * @param item - the repeater item
+ * @returns the repeater item
+ */
+function extractRepeaters(item) {
+  const repeaters = [];
+  item.subItems.forEach(inputRepeaterItem => {
+    const outputRepeaterItem = {};
+    inputRepeaterItem.forEach(repeaterComponent => {
+      outputRepeaterItem[repeaterComponent.name] = getAnswer(repeaterComponent.field, repeaterComponent.state, {
+        format: 'data'
+      });
+    });
+    repeaters.push(outputRepeaterItem);
+  });
+  return repeaters;
+}
+
+/**
+ * Returns the "files" section of the response body
+ * @param item - the file upload item in the form
+ * @returns the file upload data
+ */
+function extractFileUploads(item) {
+  const fileUploadState = item.field.getContextValueFromState(item.state) ?? [];
+  return fileUploadState.map(fileId => {
+    return {
+      fileId,
+      userDownloadLink: `${designerUrl}/file-download/${fileId}`
+    };
+  });
+}
+function isFileUploadFieldItem(item) {
+  return item.field instanceof FileUploadField;
+}
+
+/**
+ * A detail item specifically for files
+ */
+//# sourceMappingURL=v1.js.map

package/.server/server/plugins/engine/outputFormatters/machine/v1.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"v1.js","names":["config","getAnswer","FileUploadField","designerUrl","get","format","items","model","_submitResponse","_formStatus","now","Date","categorisedData","categoriseData","data","meta","schemaVersion","timestamp","toISOString","definition","def","body","JSON","stringify","output","main","repeaters","files","forEach","item","name","extractRepeaters","isFileUploadFieldItem","extractFileUploads","field","state","subItems","inputRepeaterItem","outputRepeaterItem","repeaterComponent","push","fileUploadState","getContextValueFromState","map","fileId","userDownloadLink"],"sources":["../../../../../../src/server/plugins/engine/outputFormatters/machine/v1.ts"],"sourcesContent":["import { type SubmitResponsePayload } from '@defra/forms-model'\n\nimport { config } from '~/src/config/index.js'\nimport { getAnswer } from '~/src/server/plugins/engine/components/helpers.js'\nimport { FileUploadField } from '~/src/server/plugins/engine/components/index.js'\nimport { type checkFormStatus } from '~/src/server/plugins/engine/helpers.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport {\n  type DetailItem,\n  type DetailItemField,\n  type DetailItemRepeat\n} from '~/src/server/plugins/engine/models/types.js'\n\nconst designerUrl = config.get('designerUrl')\n\nexport function format(\n  items: DetailItem[],\n  model: FormModel,\n  _submitResponse: SubmitResponsePayload,\n  _formStatus: ReturnType<typeof checkFormStatus>\n) {\n  const now = new Date()\n\n  const categorisedData = categoriseData(items)\n\n  const data = {\n    meta: {\n      schemaVersion: '1',\n      timestamp: now.toISOString(),\n      definition: model.def\n    },\n    data: categorisedData\n  }\n\n  const body = JSON.stringify(data)\n\n  return body\n}\n\n/**\n * Categories the form submission data into the \"main\" body and \"repeaters\".\n *\n * {\n *    main: {\n *       componentName: 'componentValue',\n *    },\n *    repeaters: {\n *      repeaterName: [\n *        {\n *          componentName: 'componentValue'\n *        }\n *      ]\n *    },\n *    files: {\n *      fileComponentName: [\n *        {\n *          fileId: '123-456-789',\n *          link: 'https://forms-designer/file-download/123-456-789'\n *        }\n *      ]\n *    }\n * }\n */\nfunction categoriseData(items: DetailItem[]) {\n  const output: {\n    main: Record<string, string>\n    repeaters: Record<string, Record<string, string>[]>\n    files: Record<string, Record<string, string>[]>\n  } = { main: {}, repeaters: {}, files: {} }\n\n  items.forEach((item) => {\n    if ('subItems' in item) {\n      output.repeaters[item.name] = extractRepeaters(item)\n    } else if (isFileUploadFieldItem(item)) {\n      output.files[item.name] = extractFileUploads(item)\n    } else {\n      output.main[item.name] = getAnswer(item.field, item.state, {\n        format: 'data'\n      })\n    }\n  })\n\n  return output\n}\n\n/**\n * Returns the \"repeaters\" section of the response body\n * @param item - the repeater item\n * @returns the repeater item\n */\nfunction extractRepeaters(item: DetailItemRepeat) {\n  const repeaters: Record<string, string>[] = []\n\n  item.subItems.forEach((inputRepeaterItem) => {\n    const outputRepeaterItem: Record<string, string> = {}\n\n    inputRepeaterItem.forEach((repeaterComponent) => {\n      outputRepeaterItem[repeaterComponent.name] = getAnswer(\n        repeaterComponent.field,\n        repeaterComponent.state,\n        {\n          format: 'data'\n        }\n      )\n    })\n\n    repeaters.push(outputRepeaterItem)\n  })\n\n  return repeaters\n}\n\n/**\n * Returns the \"files\" section of the response body\n * @param item - the file upload item in the form\n * @returns the file upload data\n */\nfunction extractFileUploads(item: FileUploadFieldDetailitem) {\n  const fileUploadState = item.field.getContextValueFromState(item.state) ?? []\n\n  return fileUploadState.map((fileId) => {\n    return {\n      fileId,\n      userDownloadLink: `${designerUrl}/file-download/${fileId}`\n    }\n  })\n}\n\nfunction isFileUploadFieldItem(\n  item: DetailItemField\n): item is FileUploadFieldDetailitem {\n  return item.field instanceof FileUploadField\n}\n\n/**\n * A detail item specifically for files\n */\ntype FileUploadFieldDetailitem = Omit<DetailItemField, 'field'> & {\n  field: FileUploadField\n}\n"],"mappings":"AAEA,SAASA,MAAM;AACf,SAASC,SAAS;AAClB,SAASC,eAAe;AASxB,MAAMC,WAAW,GAAGH,MAAM,CAACI,GAAG,CAAC,aAAa,CAAC;AAE7C,OAAO,SAASC,MAAMA,CACpBC,KAAmB,EACnBC,KAAgB,EAChBC,eAAsC,EACtCC,WAA+C,EAC/C;EACA,MAAMC,GAAG,GAAG,IAAIC,IAAI,CAAC,CAAC;EAEtB,MAAMC,eAAe,GAAGC,cAAc,CAACP,KAAK,CAAC;EAE7C,MAAMQ,IAAI,GAAG;IACXC,IAAI,EAAE;MACJC,aAAa,EAAE,GAAG;MAClBC,SAAS,EAAEP,GAAG,CAACQ,WAAW,CAAC,CAAC;MAC5BC,UAAU,EAAEZ,KAAK,CAACa;IACpB,CAAC;IACDN,IAAI,EAAEF;EACR,CAAC;EAED,MAAMS,IAAI,GAAGC,IAAI,CAACC,SAAS,CAACT,IAAI,CAAC;EAEjC,OAAOO,IAAI;AACb;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASR,cAAcA,CAACP,KAAmB,EAAE;EAC3C,MAAMkB,MAIL,GAAG;IAAEC,IAAI,EAAE,CAAC,CAAC;IAAEC,SAAS,EAAE,CAAC,CAAC;IAAEC,KAAK,EAAE,CAAC;EAAE,CAAC;EAE1CrB,KAAK,CAACsB,OAAO,CAAEC,IAAI,IAAK;IACtB,IAAI,UAAU,IAAIA,IAAI,EAAE;MACtBL,MAAM,CAACE,SAAS,CAACG,IAAI,CAACC,IAAI,CAAC,GAAGC,gBAAgB,CAACF,IAAI,CAAC;IACtD,CAAC,MAAM,IAAIG,qBAAqB,CAACH,IAAI,CAAC,EAAE;MACtCL,MAAM,CAACG,KAAK,CAACE,IAAI,CAACC,IAAI,CAAC,GAAGG,kBAAkB,CAACJ,IAAI,CAAC;IACpD,CAAC,MAAM;MACLL,MAAM,CAACC,IAAI,CAACI,IAAI,CAACC,IAAI,CAAC,GAAG7B,SAAS,CAAC4B,IAAI,CAACK,KAAK,EAAEL,IAAI,CAACM,KAAK,EAAE;QACzD9B,MAAM,EAAE;MACV,CAAC,CAAC;IACJ;EACF,CAAC,CAAC;EAEF,OAAOmB,MAAM;AACf;;AAEA;AACA;AACA;AACA;AACA;AACA,SAASO,gBAAgBA,CAACF,IAAsB,EAAE;EAChD,MAAMH,SAAmC,GAAG,EAAE;EAE9CG,IAAI,CAACO,QAAQ,CAACR,OAAO,CAAES,iBAAiB,IAAK;IAC3C,MAAMC,kBAA0C,GAAG,CAAC,CAAC;IAErDD,iBAAiB,CAACT,OAAO,CAAEW,iBAAiB,IAAK;MAC/CD,kBAAkB,CAACC,iBAAiB,CAACT,IAAI,CAAC,GAAG7B,SAAS,CACpDsC,iBAAiB,CAACL,KAAK,EACvBK,iBAAiB,CAACJ,KAAK,EACvB;QACE9B,MAAM,EAAE;MACV,CACF,CAAC;IACH,CAAC,CAAC;IAEFqB,SAAS,CAACc,IAAI,CAACF,kBAAkB,CAAC;EACpC,CAAC,CAAC;EAEF,OAAOZ,SAAS;AAClB;;AAEA;AACA;AACA;AACA;AACA;AACA,SAASO,kBAAkBA,CAACJ,IAA+B,EAAE;EAC3D,MAAMY,eAAe,GAAGZ,IAAI,CAACK,KAAK,CAACQ,wBAAwB,CAACb,IAAI,CAACM,KAAK,CAAC,IAAI,EAAE;EAE7E,OAAOM,eAAe,CAACE,GAAG,CAAEC,MAAM,IAAK;IACrC,OAAO;MACLA,MAAM;MACNC,gBAAgB,EAAE,GAAG1C,WAAW,kBAAkByC,MAAM;IAC1D,CAAC;EACH,CAAC,CAAC;AACJ;AAEA,SAASZ,qBAAqBA,CAC5BH,IAAqB,EACc;EACnC,OAAOA,IAAI,CAACK,KAAK,YAAYhC,eAAe;AAC9C;;AAEA;AACA;AACA","ignoreList":[]}

package/.server/server/plugins/engine/outputFormatters/machine/v2.js

@@ -0,0 +1,110 @@
+import { config } from "../../../../../config/index.js";
+import { FileUploadField } from "../../components/index.js";
+const designerUrl = config.get('designerUrl');
+export function format(items, model, _submitResponse, _formStatus) {
+  const now = new Date();
+  const categorisedData = categoriseData(items);
+  const data = {
+    meta: {
+      schemaVersion: '2',
+      timestamp: now.toISOString(),
+      definition: model.def
+    },
+    data: categorisedData
+  };
+  const body = JSON.stringify(data);
+  return body;
+}
+
+/**
+ * Categories the form submission data into the "main" body and "repeaters".
+ *
+ * {
+ *    main: {
+ *       componentName: 'componentValue',
+ *    },
+ *    repeaters: {
+ *      repeaterName: [
+ *        {
+ *          textComponentName: 'componentValue'
+ *        },
+ *        {
+ *          richComponentName: { foo: 'bar', 'baz': true }
+ *        }
+ *      ]
+ *    },
+ *    files: {
+ *      fileComponentName: [
+ *        {
+ *          fileId: '123-456-789',
+ *          link: 'https://forms-designer/file-download/123-456-789'
+ *        }
+ *      ]
+ *    }
+ * }
+ */
+function categoriseData(items) {
+  const output = {
+    main: {},
+    repeaters: {},
+    files: {}
+  };
+  items.forEach(item => {
+    const {
+      name,
+      state
+    } = item;
+    if ('subItems' in item) {
+      output.repeaters[name] = extractRepeaters(item);
+    } else if (isFileUploadFieldItem(item)) {
+      output.files[name] = extractFileUploads(item);
+    } else {
+      output.main[name] = item.field.getFormValueFromState(state);
+    }
+  });
+  return output;
+}
+
+/**
+ * Returns the "repeaters" section of the response body
+ * @param item - the repeater item
+ * @returns the repeater item
+ */
+function extractRepeaters(item) {
+  const repeaters = [];
+  item.subItems.forEach(inputRepeaterItem => {
+    const outputRepeaterItem = {};
+    inputRepeaterItem.forEach(repeaterComponent => {
+      const {
+        field,
+        state
+      } = repeaterComponent;
+      outputRepeaterItem[repeaterComponent.name] = field.getFormValueFromState(state);
+    });
+    repeaters.push(outputRepeaterItem);
+  });
+  return repeaters;
+}
+
+/**
+ * Returns the "files" section of the response body
+ * @param item - the file upload item in the form
+ * @returns the file upload data
+ */
+function extractFileUploads(item) {
+  const fileUploadState = item.field.getContextValueFromState(item.state) ?? [];
+  return fileUploadState.map(fileId => {
+    return {
+      fileId,
+      userDownloadLink: `${designerUrl}/file-download/${fileId}`
+    };
+  });
+}
+function isFileUploadFieldItem(item) {
+  return item.field instanceof FileUploadField;
+}
+
+/**
+ * A detail item specifically for files
+ */
+//# sourceMappingURL=v2.js.map

package/.server/server/plugins/engine/outputFormatters/machine/v2.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"v2.js","names":["config","FileUploadField","designerUrl","get","format","items","model","_submitResponse","_formStatus","now","Date","categorisedData","categoriseData","data","meta","schemaVersion","timestamp","toISOString","definition","def","body","JSON","stringify","output","main","repeaters","files","forEach","item","name","state","extractRepeaters","isFileUploadFieldItem","extractFileUploads","field","getFormValueFromState","subItems","inputRepeaterItem","outputRepeaterItem","repeaterComponent","push","fileUploadState","getContextValueFromState","map","fileId","userDownloadLink"],"sources":["../../../../../../src/server/plugins/engine/outputFormatters/machine/v2.ts"],"sourcesContent":["import { type SubmitResponsePayload } from '@defra/forms-model'\n\nimport { config } from '~/src/config/index.js'\nimport { type DatePartsState } from '~/src/server/plugins/engine/components/DatePartsField.js'\nimport { type MonthYearState } from '~/src/server/plugins/engine/components/MonthYearField.js'\nimport { type UkAddressState } from '~/src/server/plugins/engine/components/UkAddressField.js'\nimport { FileUploadField } from '~/src/server/plugins/engine/components/index.js'\nimport { type checkFormStatus } from '~/src/server/plugins/engine/helpers.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport {\n  type DetailItem,\n  type DetailItemField,\n  type DetailItemRepeat\n} from '~/src/server/plugins/engine/models/types.js'\nimport {\n  type FormPayload,\n  type FormValue\n} from '~/src/server/plugins/engine/types.js'\n\nconst designerUrl = config.get('designerUrl')\n\nexport function format(\n  items: DetailItem[],\n  model: FormModel,\n  _submitResponse: SubmitResponsePayload,\n  _formStatus: ReturnType<typeof checkFormStatus>\n) {\n  const now = new Date()\n\n  const categorisedData = categoriseData(items)\n\n  const data = {\n    meta: {\n      schemaVersion: '2',\n      timestamp: now.toISOString(),\n      definition: model.def\n    },\n    data: categorisedData\n  }\n\n  const body = JSON.stringify(data)\n\n  return body\n}\n\n/**\n * Categories the form submission data into the \"main\" body and \"repeaters\".\n *\n * {\n *    main: {\n *       componentName: 'componentValue',\n *    },\n *    repeaters: {\n *      repeaterName: [\n *        {\n *          textComponentName: 'componentValue'\n *        },\n *        {\n *          richComponentName: { foo: 'bar', 'baz': true }\n *        }\n *      ]\n *    },\n *    files: {\n *      fileComponentName: [\n *        {\n *          fileId: '123-456-789',\n *          link: 'https://forms-designer/file-download/123-456-789'\n *        }\n *      ]\n *    }\n * }\n */\nfunction categoriseData(items: DetailItem[]) {\n  const output: {\n    main: Record<string, RichFormValue>\n    repeaters: Record<string, Record<string, RichFormValue>[]>\n    files: Record<string, Record<string, string>[]>\n  } = { main: {}, repeaters: {}, files: {} }\n\n  items.forEach((item) => {\n    const { name, state } = item\n\n    if ('subItems' in item) {\n      output.repeaters[name] = extractRepeaters(item)\n    } else if (isFileUploadFieldItem(item)) {\n      output.files[name] = extractFileUploads(item)\n    } else {\n      output.main[name] = item.field.getFormValueFromState(state)\n    }\n  })\n\n  return output\n}\n\n/**\n * Returns the \"repeaters\" section of the response body\n * @param item - the repeater item\n * @returns the repeater item\n */\nfunction extractRepeaters(item: DetailItemRepeat) {\n  const repeaters: Record<string, RichFormValue>[] = []\n\n  item.subItems.forEach((inputRepeaterItem) => {\n    const outputRepeaterItem: Record<string, RichFormValue> = {}\n\n    inputRepeaterItem.forEach((repeaterComponent) => {\n      const { field, state } = repeaterComponent\n\n      outputRepeaterItem[repeaterComponent.name] =\n        field.getFormValueFromState(state)\n    })\n\n    repeaters.push(outputRepeaterItem)\n  })\n\n  return repeaters\n}\n\n/**\n * Returns the \"files\" section of the response body\n * @param item - the file upload item in the form\n * @returns the file upload data\n */\nfunction extractFileUploads(item: FileUploadFieldDetailitem) {\n  const fileUploadState = item.field.getContextValueFromState(item.state) ?? []\n\n  return fileUploadState.map((fileId) => {\n    return {\n      fileId,\n      userDownloadLink: `${designerUrl}/file-download/${fileId}`\n    }\n  })\n}\n\nfunction isFileUploadFieldItem(\n  item: DetailItemField\n): item is FileUploadFieldDetailitem {\n  return item.field instanceof FileUploadField\n}\n\n/**\n * A detail item specifically for files\n */\ntype FileUploadFieldDetailitem = Omit<DetailItemField, 'field'> & {\n  field: FileUploadField\n}\n\ntype RichFormValue =\n  | FormValue\n  | FormPayload\n  | DatePartsState\n  | MonthYearState\n  | UkAddressState\n"],"mappings":"AAEA,SAASA,MAAM;AAIf,SAASC,eAAe;AAaxB,MAAMC,WAAW,GAAGF,MAAM,CAACG,GAAG,CAAC,aAAa,CAAC;AAE7C,OAAO,SAASC,MAAMA,CACpBC,KAAmB,EACnBC,KAAgB,EAChBC,eAAsC,EACtCC,WAA+C,EAC/C;EACA,MAAMC,GAAG,GAAG,IAAIC,IAAI,CAAC,CAAC;EAEtB,MAAMC,eAAe,GAAGC,cAAc,CAACP,KAAK,CAAC;EAE7C,MAAMQ,IAAI,GAAG;IACXC,IAAI,EAAE;MACJC,aAAa,EAAE,GAAG;MAClBC,SAAS,EAAEP,GAAG,CAACQ,WAAW,CAAC,CAAC;MAC5BC,UAAU,EAAEZ,KAAK,CAACa;IACpB,CAAC;IACDN,IAAI,EAAEF;EACR,CAAC;EAED,MAAMS,IAAI,GAAGC,IAAI,CAACC,SAAS,CAACT,IAAI,CAAC;EAEjC,OAAOO,IAAI;AACb;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASR,cAAcA,CAACP,KAAmB,EAAE;EAC3C,MAAMkB,MAIL,GAAG;IAAEC,IAAI,EAAE,CAAC,CAAC;IAAEC,SAAS,EAAE,CAAC,CAAC;IAAEC,KAAK,EAAE,CAAC;EAAE,CAAC;EAE1CrB,KAAK,CAACsB,OAAO,CAAEC,IAAI,IAAK;IACtB,MAAM;MAAEC,IAAI;MAAEC;IAAM,CAAC,GAAGF,IAAI;IAE5B,IAAI,UAAU,IAAIA,IAAI,EAAE;MACtBL,MAAM,CAACE,SAAS,CAACI,IAAI,CAAC,GAAGE,gBAAgB,CAACH,IAAI,CAAC;IACjD,CAAC,MAAM,IAAII,qBAAqB,CAACJ,IAAI,CAAC,EAAE;MACtCL,MAAM,CAACG,KAAK,CAACG,IAAI,CAAC,GAAGI,kBAAkB,CAACL,IAAI,CAAC;IAC/C,CAAC,MAAM;MACLL,MAAM,CAACC,IAAI,CAACK,IAAI,CAAC,GAAGD,IAAI,CAACM,KAAK,CAACC,qBAAqB,CAACL,KAAK,CAAC;IAC7D;EACF,CAAC,CAAC;EAEF,OAAOP,MAAM;AACf;;AAEA;AACA;AACA;AACA;AACA;AACA,SAASQ,gBAAgBA,CAACH,IAAsB,EAAE;EAChD,MAAMH,SAA0C,GAAG,EAAE;EAErDG,IAAI,CAACQ,QAAQ,CAACT,OAAO,CAAEU,iBAAiB,IAAK;IAC3C,MAAMC,kBAAiD,GAAG,CAAC,CAAC;IAE5DD,iBAAiB,CAACV,OAAO,CAAEY,iBAAiB,IAAK;MAC/C,MAAM;QAAEL,KAAK;QAAEJ;MAAM,CAAC,GAAGS,iBAAiB;MAE1CD,kBAAkB,CAACC,iBAAiB,CAACV,IAAI,CAAC,GACxCK,KAAK,CAACC,qBAAqB,CAACL,KAAK,CAAC;IACtC,CAAC,CAAC;IAEFL,SAAS,CAACe,IAAI,CAACF,kBAAkB,CAAC;EACpC,CAAC,CAAC;EAEF,OAAOb,SAAS;AAClB;;AAEA;AACA;AACA;AACA;AACA;AACA,SAASQ,kBAAkBA,CAACL,IAA+B,EAAE;EAC3D,MAAMa,eAAe,GAAGb,IAAI,CAACM,KAAK,CAACQ,wBAAwB,CAACd,IAAI,CAACE,KAAK,CAAC,IAAI,EAAE;EAE7E,OAAOW,eAAe,CAACE,GAAG,CAAEC,MAAM,IAAK;IACrC,OAAO;MACLA,MAAM;MACNC,gBAAgB,EAAE,GAAG3C,WAAW,kBAAkB0C,MAAM;IAC1D,CAAC;EACH,CAAC,CAAC;AACJ;AAEA,SAASZ,qBAAqBA,CAC5BJ,IAAqB,EACc;EACnC,OAAOA,IAAI,CAACM,KAAK,YAAYjC,eAAe;AAC9C;;AAEA;AACA;AACA","ignoreList":[]}