@defra/forms-model 3.0.201 → 3.0.203

package/dist/module/form/utils/find-start-page.js

@@ -0,0 +1,30 @@
+/**
+ * Find correct start page for form definition
+ *
+ * Computed by counting the next paths in a form definition and returning page
+ * that doesn't have a reference, meaning it must be a start page / root node
+ *
+ * It's possibe for forms to be malformed and have multiple start pages while
+ * they're being developed. This may be valid during development, but in this
+ * scenario we can't detect the real start page and we require the user to fix
+ * this themselves
+ * @param data - Form definition
+ */
+export function findStartPage(data) {
+  const {
+    pages
+  } = data;
+
+  // Get a unique list of all pages that are linked to by other pages
+  const pageReferences = new Set(pages.flatMap(page => page.next?.map(next => next.path)));
+
+  // For each page on the form, work out if it's referenced by another page
+  // those that aren't referenced must be start pages
+  const startPages = pages.map(page => page.path).filter(page => !pageReferences.has(page));
+
+  // We can only set the start page if there is a single one, else the user has made an error
+  if (startPages.length === 1) {
+    return startPages[0];
+  }
+}
+//# sourceMappingURL=find-start-page.js.map

package/dist/module/form/utils/find-start-page.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"find-start-page.js","names":["findStartPage","data","pages","pageReferences","Set","flatMap","page","next","map","path","startPages","filter","has","length"],"sources":["../../../../src/form/utils/find-start-page.ts"],"sourcesContent":["import { type FormDefinition } from '~/src/form/form-definition/types.js'\n\n/**\n * Find correct start page for form definition\n *\n * Computed by counting the next paths in a form definition and returning page\n * that doesn't have a reference, meaning it must be a start page / root node\n *\n * It's possibe for forms to be malformed and have multiple start pages while\n * they're being developed. This may be valid during development, but in this\n * scenario we can't detect the real start page and we require the user to fix\n * this themselves\n * @param data - Form definition\n */\nexport function findStartPage(data: FormDefinition) {\n  const { pages } = data\n\n  // Get a unique list of all pages that are linked to by other pages\n  const pageReferences = new Set(\n    pages.flatMap((page) => page.next?.map((next) => next.path))\n  )\n\n  // For each page on the form, work out if it's referenced by another page\n  // those that aren't referenced must be start pages\n  const startPages = pages\n    .map((page) => page.path)\n    .filter((page) => !pageReferences.has(page))\n\n  // We can only set the start page if there is a single one, else the user has made an error\n  if (startPages.length === 1) {\n    return startPages[0]\n  }\n}\n"],"mappings":"AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASA,aAAaA,CAACC,IAAoB,EAAE;EAClD,MAAM;IAAEC;EAAM,CAAC,GAAGD,IAAI;;EAEtB;EACA,MAAME,cAAc,GAAG,IAAIC,GAAG,CAC5BF,KAAK,CAACG,OAAO,CAAEC,IAAI,IAAKA,IAAI,CAACC,IAAI,EAAEC,GAAG,CAAED,IAAI,IAAKA,IAAI,CAACE,IAAI,CAAC,CAC7D,CAAC;;EAED;EACA;EACA,MAAMC,UAAU,GAAGR,KAAK,CACrBM,GAAG,CAAEF,IAAI,IAAKA,IAAI,CAACG,IAAI,CAAC,CACxBE,MAAM,CAAEL,IAAI,IAAK,CAACH,cAAc,CAACS,GAAG,CAACN,IAAI,CAAC,CAAC;;EAE9C;EACA,IAAII,UAAU,CAACG,MAAM,KAAK,CAAC,EAAE;IAC3B,OAAOH,UAAU,CAAC,CAAC,CAAC;EACtB;AACF","ignoreList":[]}

package/dist/module/form/utils/index.js

@@ -0,0 +1,3 @@
+export { findStartPage } from "./find-start-page.js";
+export { updateStartPage } from "./update-start-page.js";
+//# sourceMappingURL=index.js.map

package/dist/module/form/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["findStartPage","updateStartPage"],"sources":["../../../../src/form/utils/index.ts"],"sourcesContent":["export { findStartPage } from '~/src/form/utils/find-start-page.js'\nexport { updateStartPage } from '~/src/form/utils/update-start-page.js'\n"],"mappings":"AAAA,SAASA,aAAa;AACtB,SAASC,eAAe","ignoreList":[]}

package/dist/module/form/utils/update-start-page.js

@@ -0,0 +1,30 @@
+import { findStartPage } from "./find-start-page.js";
+
+/**
+ * Update start page when pages are modified
+ * @param data - Form definition
+ */
+export function updateStartPage(data) {
+  const startPage = findStartPage(data);
+
+  // Update start page if incorrect
+  if (startPage && (!data.startPage || data.startPage !== startPage)) {
+    return {
+      ...data,
+      startPage
+    };
+  }
+
+  // Remove start page if no pages exist
+  if (!startPage && 'startPage' in data) {
+    const updated = {
+      ...data
+    };
+
+    // Remove without modifying original
+    delete updated.startPage;
+    return updated;
+  }
+  return data;
+}
+//# sourceMappingURL=update-start-page.js.map

package/dist/module/form/utils/update-start-page.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-start-page.js","names":["findStartPage","updateStartPage","data","startPage","updated"],"sources":["../../../../src/form/utils/update-start-page.ts"],"sourcesContent":["import { type FormDefinition } from '~/src/form/form-definition/types.js'\nimport { findStartPage } from '~/src/form/utils/find-start-page.js'\n\n/**\n * Update start page when pages are modified\n * @param data - Form definition\n */\nexport function updateStartPage(data: FormDefinition) {\n  const startPage = findStartPage(data)\n\n  // Update start page if incorrect\n  if (startPage && (!data.startPage || data.startPage !== startPage)) {\n    return { ...data, startPage }\n  }\n\n  // Remove start page if no pages exist\n  if (!startPage && 'startPage' in data) {\n    const updated = { ...data }\n\n    // Remove without modifying original\n    delete updated.startPage\n    return updated\n  }\n\n  return data\n}\n"],"mappings":"AACA,SAASA,aAAa;;AAEtB;AACA;AACA;AACA;AACA,OAAO,SAASC,eAAeA,CAACC,IAAoB,EAAE;EACpD,MAAMC,SAAS,GAAGH,aAAa,CAACE,IAAI,CAAC;;EAErC;EACA,IAAIC,SAAS,KAAK,CAACD,IAAI,CAACC,SAAS,IAAID,IAAI,CAACC,SAAS,KAAKA,SAAS,CAAC,EAAE;IAClE,OAAO;MAAE,GAAGD,IAAI;MAAEC;IAAU,CAAC;EAC/B;;EAEA;EACA,IAAI,CAACA,SAAS,IAAI,WAAW,IAAID,IAAI,EAAE;IACrC,MAAME,OAAO,GAAG;MAAE,GAAGF;IAAK,CAAC;;IAE3B;IACA,OAAOE,OAAO,CAACD,SAAS;IACxB,OAAOC,OAAO;EAChB;EAEA,OAAOF,IAAI;AACb","ignoreList":[]}

package/dist/module/index.js

@@ -1,6 +1,7 @@
 export * from "./data-model/index.js";
 export * from "./form/form-definition/index.js";
 export * from "./form/form-metadata/index.js";
+export * from "./form/utils/index.js";
 export * from "./components/index.js";
 export * from "./conditions/index.js";
 export * from "./utils/helpers.js";

package/dist/module/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../../src/index.ts"],"sourcesContent":["export * from '~/src/data-model/index.js'\nexport * from '~/src/form/form-definition/index.js'\nexport * from '~/src/form/form-metadata/index.js'\nexport * from '~/src/components/index.js'\nexport * from '~/src/conditions/index.js'\nexport * from '~/src/utils/helpers.js'\nexport type * from '~/src/components/types.js'\nexport type * from '~/src/conditions/types.js'\nexport type * from '~/src/form/form-definition/types.js'\nexport type * from '~/src/form/form-metadata/types.js'\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"index.js","names":[],"sources":["../../src/index.ts"],"sourcesContent":["export * from '~/src/data-model/index.js'\nexport * from '~/src/form/form-definition/index.js'\nexport * from '~/src/form/form-metadata/index.js'\nexport * from '~/src/form/utils/index.js'\nexport * from '~/src/components/index.js'\nexport * from '~/src/conditions/index.js'\nexport * from '~/src/utils/helpers.js'\nexport type * from '~/src/components/types.js'\nexport type * from '~/src/conditions/types.js'\nexport type * from '~/src/form/form-definition/types.js'\nexport type * from '~/src/form/form-metadata/types.js'\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA","ignoreList":[]}

package/dist/types/form/utils/find-start-page.d.ts

@@ -0,0 +1,15 @@
+import { type FormDefinition } from '../../form/form-definition/types.js';
+/**
+ * Find correct start page for form definition
+ *
+ * Computed by counting the next paths in a form definition and returning page
+ * that doesn't have a reference, meaning it must be a start page / root node
+ *
+ * It's possibe for forms to be malformed and have multiple start pages while
+ * they're being developed. This may be valid during development, but in this
+ * scenario we can't detect the real start page and we require the user to fix
+ * this themselves
+ * @param data - Form definition
+ */
+export declare function findStartPage(data: FormDefinition): string | undefined;
+//# sourceMappingURL=find-start-page.d.ts.map

package/dist/types/form/utils/find-start-page.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"find-start-page.d.ts","sourceRoot":"","sources":["../../../../src/form/utils/find-start-page.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,qCAAqC,CAAA;AAEzE;;;;;;;;;;;GAWG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,cAAc,sBAkBjD"}

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

@@ -0,0 +1,3 @@
+export { findStartPage } from '../../form/utils/find-start-page.js';
+export { updateStartPage } from '../../form/utils/update-start-page.js';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/form/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAA;AACnE,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAA"}

package/dist/types/form/utils/update-start-page.d.ts

@@ -0,0 +1,7 @@
+import { type FormDefinition } from '../../form/form-definition/types.js';
+/**
+ * Update start page when pages are modified
+ * @param data - Form definition
+ */
+export declare function updateStartPage(data: FormDefinition): FormDefinition;
+//# sourceMappingURL=update-start-page.d.ts.map

package/dist/types/form/utils/update-start-page.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-start-page.d.ts","sourceRoot":"","sources":["../../../../src/form/utils/update-start-page.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,qCAAqC,CAAA;AAGzE;;;GAGG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,cAAc,kBAkBnD"}

package/dist/types/index.d.ts

@@ -1,6 +1,7 @@
 export * from './data-model/index.js';
 export * from './form/form-definition/index.js';
 export * from './form/form-metadata/index.js';
+export * from './form/utils/index.js';
 export * from './components/index.js';
 export * from './conditions/index.js';
 export * from './utils/helpers.js';

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAA;AACzC,cAAc,qCAAqC,CAAA;AACnD,cAAc,mCAAmC,CAAA;AACjD,cAAc,2BAA2B,CAAA;AACzC,cAAc,2BAA2B,CAAA;AACzC,cAAc,wBAAwB,CAAA;AACtC,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,qCAAqC,CAAA;AACxD,mBAAmB,mCAAmC,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAA;AACzC,cAAc,qCAAqC,CAAA;AACnD,cAAc,mCAAmC,CAAA;AACjD,cAAc,2BAA2B,CAAA;AACzC,cAAc,2BAA2B,CAAA;AACzC,cAAc,2BAA2B,CAAA;AACzC,cAAc,wBAAwB,CAAA;AACtC,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,qCAAqC,CAAA;AACxD,mBAAmB,mCAAmC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-model",
-  "version": "3.0.201",
+  "version": "3.0.203",
   "description": "A hapi plugin providing the model for Defra forms",
   "homepage": "https://github.com/DEFRA/forms-designer/tree/main/model#readme",
   "repository": {

package/src/form/utils/find-start-page.ts

@@ -0,0 +1,33 @@
+import { type FormDefinition } from '~/src/form/form-definition/types.js'
+
+/**
+ * Find correct start page for form definition
+ *
+ * Computed by counting the next paths in a form definition and returning page
+ * that doesn't have a reference, meaning it must be a start page / root node
+ *
+ * It's possibe for forms to be malformed and have multiple start pages while
+ * they're being developed. This may be valid during development, but in this
+ * scenario we can't detect the real start page and we require the user to fix
+ * this themselves
+ * @param data - Form definition
+ */
+export function findStartPage(data: FormDefinition) {
+  const { pages } = data
+
+  // Get a unique list of all pages that are linked to by other pages
+  const pageReferences = new Set(
+    pages.flatMap((page) => page.next?.map((next) => next.path))
+  )
+
+  // For each page on the form, work out if it's referenced by another page
+  // those that aren't referenced must be start pages
+  const startPages = pages
+    .map((page) => page.path)
+    .filter((page) => !pageReferences.has(page))
+
+  // We can only set the start page if there is a single one, else the user has made an error
+  if (startPages.length === 1) {
+    return startPages[0]
+  }
+}

package/src/form/utils/index.ts

@@ -0,0 +1,2 @@
+export { findStartPage } from '~/src/form/utils/find-start-page.js'
+export { updateStartPage } from '~/src/form/utils/update-start-page.js'

package/src/form/utils/update-start-page.ts

@@ -0,0 +1,26 @@
+import { type FormDefinition } from '~/src/form/form-definition/types.js'
+import { findStartPage } from '~/src/form/utils/find-start-page.js'
+
+/**
+ * Update start page when pages are modified
+ * @param data - Form definition
+ */
+export function updateStartPage(data: FormDefinition) {
+  const startPage = findStartPage(data)
+
+  // Update start page if incorrect
+  if (startPage && (!data.startPage || data.startPage !== startPage)) {
+    return { ...data, startPage }
+  }
+
+  // Remove start page if no pages exist
+  if (!startPage && 'startPage' in data) {
+    const updated = { ...data }
+
+    // Remove without modifying original
+    delete updated.startPage
+    return updated
+  }
+
+  return data
+}

package/src/index.ts

@@ -1,6 +1,7 @@
 export * from '~/src/data-model/index.js'
 export * from '~/src/form/form-definition/index.js'
 export * from '~/src/form/form-metadata/index.js'
+export * from '~/src/form/utils/index.js'
 export * from '~/src/components/index.js'
 export * from '~/src/conditions/index.js'
 export * from '~/src/utils/helpers.js'