@defra/forms-model 3.0.2

package/dist/module/utils/helpers.js

@@ -0,0 +1,35 @@
+"use strict";
+
+exports.__esModule = true;
+exports.clone = void 0;
+exports.filter = filter;
+exports.serialiseAndDeserialise = exports.nanoid = void 0;
+var _nanoid = require("nanoid");
+const serialiseAndDeserialise = obj => {
+  if (typeof obj === 'object' && obj !== null) {
+    return JSON.parse(JSON.stringify(obj));
+  }
+  return obj;
+};
+exports.serialiseAndDeserialise = serialiseAndDeserialise;
+const clone = obj => {
+  if (obj) {
+    if (typeof obj.clone === 'function') {
+      return obj.clone();
+    }
+    return serialiseAndDeserialise(obj);
+  }
+  return obj;
+};
+exports.clone = clone;
+function filter(obj, predicate) {
+  const result = {};
+  for (const [key, value] of Object.entries(obj)) {
+    if (value && predicate(value)) {
+      result[key] = value;
+    }
+  }
+  return result;
+}
+const nanoid = exports.nanoid = (0, _nanoid.customAlphabet)('0123456789_abcdefghijklmnopqrstuvwxyz', 6);
+//# sourceMappingURL=helpers.js.map

package/dist/module/utils/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","names":["_nanoid","require","serialiseAndDeserialise","obj","JSON","parse","stringify","exports","clone","filter","predicate","result","key","value","Object","entries","nanoid","customAlphabet"],"sources":["../../../src/utils/helpers.ts"],"sourcesContent":["import { customAlphabet } from 'nanoid'\n\nexport const serialiseAndDeserialise = <T>(obj: T): T => {\n  if (typeof obj === 'object' && obj !== null) {\n    return JSON.parse(JSON.stringify(obj))\n  }\n\n  return obj\n}\n\nexport const clone = <T>(obj: T & { clone?: () => T }): T => {\n  if (obj) {\n    if (typeof obj.clone === 'function') {\n      return obj.clone()\n    }\n\n    return serialiseAndDeserialise<T>(obj)\n  }\n  return obj\n}\n\nexport function filter<T extends { [key: string]: unknown }>(\n  obj: T,\n  predicate: (value: any) => boolean\n): Partial<T> {\n  const result = {}\n\n  for (const [key, value] of Object.entries(obj)) {\n    if (value && predicate(value)) {\n      result[key] = value\n    }\n  }\n\n  return result\n}\n\nexport const nanoid = customAlphabet('0123456789_abcdefghijklmnopqrstuvwxyz', 6)\n"],"mappings":";;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AAEO,MAAMC,uBAAuB,GAAOC,GAAM,IAAQ;EACvD,IAAI,OAAOA,GAAG,KAAK,QAAQ,IAAIA,GAAG,KAAK,IAAI,EAAE;IAC3C,OAAOC,IAAI,CAACC,KAAK,CAACD,IAAI,CAACE,SAAS,CAACH,GAAG,CAAC,CAAC;EACxC;EAEA,OAAOA,GAAG;AACZ,CAAC;AAAAI,OAAA,CAAAL,uBAAA,GAAAA,uBAAA;AAEM,MAAMM,KAAK,GAAOL,GAA4B,IAAQ;EAC3D,IAAIA,GAAG,EAAE;IACP,IAAI,OAAOA,GAAG,CAACK,KAAK,KAAK,UAAU,EAAE;MACnC,OAAOL,GAAG,CAACK,KAAK,CAAC,CAAC;IACpB;IAEA,OAAON,uBAAuB,CAAIC,GAAG,CAAC;EACxC;EACA,OAAOA,GAAG;AACZ,CAAC;AAAAI,OAAA,CAAAC,KAAA,GAAAA,KAAA;AAEM,SAASC,MAAMA,CACpBN,GAAM,EACNO,SAAkC,EACtB;EACZ,MAAMC,MAAM,GAAG,CAAC,CAAC;EAEjB,KAAK,MAAM,CAACC,GAAG,EAAEC,KAAK,CAAC,IAAIC,MAAM,CAACC,OAAO,CAACZ,GAAG,CAAC,EAAE;IAC9C,IAAIU,KAAK,IAAIH,SAAS,CAACG,KAAK,CAAC,EAAE;MAC7BF,MAAM,CAACC,GAAG,CAAC,GAAGC,KAAK;IACrB;EACF;EAEA,OAAOF,MAAM;AACf;AAEO,MAAMK,MAAM,GAAAT,OAAA,CAAAS,MAAA,GAAG,IAAAC,sBAAc,EAAC,uCAAuC,EAAE,CAAC,CAAC"}

package/dist/module/utils/logger.d.ts

@@ -0,0 +1,11 @@
+export declare class Logger {
+    server: any;
+    name: string;
+    constructor(server: any, name: string);
+    error(message: string): void;
+    warn(message: string): void;
+    info(message: string): void;
+    debug(message: string): void;
+    log(level: string, message: string): void;
+}
+//# sourceMappingURL=logger.d.ts.map

package/dist/module/utils/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../../src/utils/logger.ts"],"names":[],"mappings":"AAAA,qBAAa,MAAM;IACjB,MAAM,EAAE,GAAG,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;gBAEA,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM;IAKrC,KAAK,CAAC,OAAO,EAAE,MAAM;IAIrB,IAAI,CAAC,OAAO,EAAE,MAAM;IAIpB,IAAI,CAAC,OAAO,EAAE,MAAM;IAIpB,KAAK,CAAC,OAAO,EAAE,MAAM;IAIrB,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;CAGnC"}

package/dist/module/utils/logger.js

@@ -0,0 +1,27 @@
+"use strict";
+
+exports.__esModule = true;
+exports.Logger = void 0;
+class Logger {
+  constructor(server, name) {
+    this.server = server;
+    this.name = name;
+  }
+  error(message) {
+    this.log('error', message);
+  }
+  warn(message) {
+    this.log('warn', message);
+  }
+  info(message) {
+    this.log('info', message);
+  }
+  debug(message) {
+    this.log('debug', message);
+  }
+  log(level, message) {
+    this.server.log([level, this.name], message);
+  }
+}
+exports.Logger = Logger;
+//# sourceMappingURL=logger.js.map

package/dist/module/utils/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","names":["Logger","constructor","server","name","error","message","log","warn","info","debug","level","exports"],"sources":["../../../src/utils/logger.ts"],"sourcesContent":["export class Logger {\n  server: any\n  name: string\n\n  constructor(server: any, name: string) {\n    this.server = server\n    this.name = name\n  }\n\n  error(message: string) {\n    this.log('error', message)\n  }\n\n  warn(message: string) {\n    this.log('warn', message)\n  }\n\n  info(message: string) {\n    this.log('info', message)\n  }\n\n  debug(message: string) {\n    this.log('debug', message)\n  }\n\n  log(level: string, message: string) {\n    this.server.log([level, this.name], message)\n  }\n}\n"],"mappings":";;;;AAAO,MAAMA,MAAM,CAAC;EAIlBC,WAAWA,CAACC,MAAW,EAAEC,IAAY,EAAE;IACrC,IAAI,CAACD,MAAM,GAAGA,MAAM;IACpB,IAAI,CAACC,IAAI,GAAGA,IAAI;EAClB;EAEAC,KAAKA,CAACC,OAAe,EAAE;IACrB,IAAI,CAACC,GAAG,CAAC,OAAO,EAAED,OAAO,CAAC;EAC5B;EAEAE,IAAIA,CAACF,OAAe,EAAE;IACpB,IAAI,CAACC,GAAG,CAAC,MAAM,EAAED,OAAO,CAAC;EAC3B;EAEAG,IAAIA,CAACH,OAAe,EAAE;IACpB,IAAI,CAACC,GAAG,CAAC,MAAM,EAAED,OAAO,CAAC;EAC3B;EAEAI,KAAKA,CAACJ,OAAe,EAAE;IACrB,IAAI,CAACC,GAAG,CAAC,OAAO,EAAED,OAAO,CAAC;EAC5B;EAEAC,GAAGA,CAACI,KAAa,EAAEL,OAAe,EAAE;IAClC,IAAI,CAACH,MAAM,CAACI,GAAG,CAAC,CAACI,KAAK,EAAE,IAAI,CAACP,IAAI,CAAC,EAAEE,OAAO,CAAC;EAC9C;AACF;AAACM,OAAA,CAAAX,MAAA,GAAAA,MAAA"}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@defra/forms-model",
+  "version": "3.0.2",
+  "description": "A hapi plugin providing the model for Defra forms",
+  "homepage": "https://github.com/DEFRA/forms-designer/tree/main/model#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/DEFRA/forms-designer.git",
+    "directory": "model"
+  },
+  "license": "OGL-UK-3.0",
+  "main": "dist/module/index.js",
+  "browser": "dist/browser/index.js",
+  "types": "dist/module/index.d.ts",
+  "scripts": {
+    "build": "npm run build:types && npm run build:node && npm run build:browser",
+    "build:browser": "BABEL_ENV=javascripts babel --extensions \".ts\" --ignore \"**/*.(jt)est.*\" src --out-dir dist/browser",
+    "build:node": "BABEL_ENV=node babel --extensions \".ts\" --ignore \"**/*.(jt)est.*\" src --out-dir dist/module",
+    "build:types": "npm run build:types:node && npm run build:types:browser",
+    "build:types:browser": "tsc --emitDeclarationOnly --declarationDir dist/browser ",
+    "build:types:node": "tsc --emitDeclarationOnly --declarationDir ./dist/module ",
+    "generate-docs": "typedoc src --tsconfig tsconfig.json --out ../docs/model/typedoc --exclude \"**/*+(index|.test|.jest).ts\"",
+    "test": "npm run test-cov",
+    "test-cov": "jest --coverage",
+    "test:dev": "jest --watch"
+  },
+  "dependencies": {
+    "joi": "17.2.1",
+    "nanoid": "^3.3.4"
+  },
+  "engines": {
+    "node": "^20.9.0",
+    "npm": "^10.1.0"
+  }
+}

package/src/components/component-types.ts

@@ -0,0 +1,229 @@
+import { ComponentDef } from './types'
+
+export const ComponentTypes: ComponentDef[] = [
+  {
+    name: 'TextField',
+    type: 'TextField',
+    title: 'Text field',
+    subType: 'field',
+    hint: '',
+    options: {},
+    schema: {}
+  },
+  {
+    name: 'MultilineTextField',
+    type: 'MultilineTextField',
+    title: 'Multiline text field',
+    subType: 'field',
+    hint: '',
+    options: {},
+    schema: {}
+  },
+  {
+    name: 'YesNoField',
+    type: 'YesNoField',
+    title: 'Yes/No field',
+    subType: 'field',
+    hint: '',
+    options: {},
+    schema: {}
+  },
+  {
+    name: 'DateField',
+    type: 'DateField',
+    title: 'Date field',
+    subType: 'field',
+    hint: '',
+    options: {},
+    schema: {}
+  },
+  {
+    name: 'TimeField',
+    type: 'TimeField',
+    title: 'Time field',
+    subType: 'field',
+    hint: '',
+    options: {},
+    schema: {}
+  },
+  {
+    name: 'DateTimeField',
+    type: 'DateTimeField',
+    title: 'Date time field',
+    subType: 'field',
+    hint: '',
+    options: {},
+    schema: {}
+  },
+  {
+    name: 'DatePartsField',
+    type: 'DatePartsField',
+    title: 'Date parts field',
+    subType: 'field',
+    hint: '',
+    options: {},
+    schema: {}
+  },
+  {
+    name: 'DateTimePartsField',
+    type: 'DateTimePartsField',
+    title: 'Date time parts field',
+    subType: 'field',
+    hint: '',
+    options: {},
+    schema: {}
+  },
+  {
+    name: 'MonthYearField',
+    type: 'MonthYearField',
+    title: 'Month year field',
+    subType: 'field',
+    hint: '',
+    options: {},
+    schema: {}
+  },
+  {
+    name: 'SelectField',
+    type: 'SelectField',
+    title: 'Select field',
+    subType: 'listField',
+    options: {},
+    schema: {},
+    list: ''
+  },
+  {
+    name: 'AutocompleteField',
+    type: 'AutocompleteField',
+    title: 'Autocomplete field',
+    subType: 'listField',
+    options: {},
+    schema: {},
+    list: ''
+  },
+  {
+    name: 'RadiosField',
+    type: 'RadiosField',
+    title: 'Radios field',
+    subType: 'listField',
+    options: {},
+    schema: {},
+    list: ''
+  },
+  {
+    name: 'CheckboxesField',
+    type: 'CheckboxesField',
+    title: 'Checkboxes field',
+    subType: 'listField',
+    options: {},
+    schema: {},
+    list: ''
+  },
+  {
+    name: 'NumberField',
+    type: 'NumberField',
+    title: 'Number field',
+    subType: 'field',
+    hint: '',
+    options: {},
+    schema: {}
+  },
+  {
+    name: 'UkAddressField',
+    type: 'UkAddressField',
+    title: 'UK address field',
+    subType: 'field',
+    hint: '',
+    options: {},
+    schema: {}
+  },
+  {
+    name: 'TelephoneNumberField',
+    type: 'TelephoneNumberField',
+    title: 'Telephone number field',
+    subType: 'field',
+    hint: '',
+    options: {},
+    schema: {}
+  },
+  {
+    name: 'EmailAddressField',
+    type: 'EmailAddressField',
+    title: 'Email address field',
+    subType: 'field',
+    hint: '',
+    options: {},
+    schema: {}
+  },
+  {
+    name: 'FileUploadField',
+    type: 'FileUploadField',
+    title: 'File upload field',
+    subType: 'field',
+    hint: '',
+    options: {},
+    schema: {}
+  },
+  {
+    name: 'Para',
+    type: 'Para',
+    title: 'Paragraph',
+    subType: 'content',
+    content: '',
+    options: {},
+    schema: {}
+  },
+  {
+    name: 'Html',
+    type: 'Html',
+    title: 'Html',
+    subType: 'content',
+    content: '',
+    options: {},
+    schema: {}
+  },
+  {
+    name: 'InsetText',
+    type: 'InsetText',
+    title: 'Inset text',
+    subType: 'content',
+    content: '',
+    options: {},
+    schema: {}
+  },
+  {
+    name: 'Details',
+    type: 'Details',
+    title: 'Details',
+    subType: 'content',
+    content: '',
+    options: {},
+    schema: {}
+  },
+  {
+    name: 'FlashCard',
+    type: 'FlashCard',
+    title: 'Flash card',
+    subType: 'content',
+    options: {},
+    schema: {},
+    list: ''
+  },
+  {
+    name: 'List',
+    type: 'List',
+    title: 'List',
+    subType: 'content',
+    options: {},
+    schema: {},
+    list: ''
+  },
+  {
+    name: 'WebsiteField',
+    type: 'WebsiteField',
+    title: 'Website field',
+    subType: 'field',
+    hint: '',
+    options: {},
+    schema: {}
+  }
+]

package/src/components/conditional-component-types.ts

@@ -0,0 +1,14 @@
+import { ConditionalComponent } from './types'
+
+export const ConditionalComponentTypes: ConditionalComponent[] = [
+  {
+    name: 'TextField',
+    title: 'Text field',
+    subType: 'field'
+  },
+  {
+    name: 'NumberField',
+    title: 'Number field',
+    subType: 'field'
+  }
+]

package/src/components/index.ts

@@ -0,0 +1,3 @@
+export { ComponentTypes } from './component-types'
+export { ConditionalComponentTypes } from './conditional-component-types'
+export * from './types'