@defra/forms-model 3.0.385 → 3.0.387

package/dist/module/common/pagination/index.js

@@ -0,0 +1,10 @@
+import Joi from 'joi';
+/**
+ * Joi schema for `PaginationOptions` interface
+ * @see {@link PaginationOptions}
+ */
+export const paginationOptionsSchema = Joi.object({
+  page: Joi.number().positive().integer().min(1),
+  perPage: Joi.number().positive().integer().min(1).max(200)
+}).optional();
+//# sourceMappingURL=index.js.map

package/dist/module/common/pagination/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["Joi","paginationOptionsSchema","object","page","number","positive","integer","min","perPage","max","optional"],"sources":["../../../../src/common/pagination/index.ts"],"sourcesContent":["import Joi from 'joi'\n\nimport { type PaginationOptions } from '~/src/common/pagination/types.js'\n\n/**\n * Joi schema for `PaginationOptions` interface\n * @see {@link PaginationOptions}\n */\nexport const paginationOptionsSchema = Joi.object<PaginationOptions>({\n  page: Joi.number().positive().integer().min(1),\n  perPage: Joi.number().positive().integer().min(1).max(200)\n}).optional()\n"],"mappings":"AAAA,OAAOA,GAAG,MAAM,KAAK;AAIrB;AACA;AACA;AACA;AACA,OAAO,MAAMC,uBAAuB,GAAGD,GAAG,CAACE,MAAM,CAAoB;EACnEC,IAAI,EAAEH,GAAG,CAACI,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC,CAACC,OAAO,CAAC,CAAC,CAACC,GAAG,CAAC,CAAC,CAAC;EAC9CC,OAAO,EAAER,GAAG,CAACI,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC,CAACC,OAAO,CAAC,CAAC,CAACC,GAAG,CAAC,CAAC,CAAC,CAACE,GAAG,CAAC,GAAG;AAC3D,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC","ignoreList":[]}

package/dist/module/common/pagination/types.js

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

package/dist/module/common/pagination/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","names":[],"sources":["../../../../src/common/pagination/types.ts"],"sourcesContent":["/**\n * Result of pagination containing page information\n */\nexport interface PaginationResult {\n  /**\n   * The current page number.\n   */\n  page: number\n\n  /**\n   * The number of items per page.\n   */\n  perPage: number\n\n  /**\n   * The total number of items available.\n   */\n  totalItems: number\n\n  /**\n   * The total number of pages available.\n   */\n  totalPages: number\n}\n\n/**\n * Options for paginating results\n * Allows partial specification of page and perPage from PaginationResult\n */\nexport type PaginationOptions = Partial<\n  Pick<PaginationResult, 'page' | 'perPage'>\n>\n\n/**\n * Metadata containing optional pagination information\n */\nexport interface Meta {\n  /**\n   * The pagination details\n   */\n  pagination?: PaginationResult\n}\n\n/**\n * Standard response wrapper for query results with metadata\n */\nexport interface QueryResult<Model> {\n  /**\n   * The array of data items\n   */\n  data: Model[]\n\n  /**\n   * The metadata about the result\n   */\n  meta: Meta\n}\n"],"mappings":"","ignoreList":[]}

package/dist/module/components/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":[],"sources":["../../../src/components/types.ts"],"sourcesContent":["import { type LanguageMessages } from 'joi'\n\nimport { type ComponentType } from '~/src/components/enums.js'\nimport {\n  type ListTypeContent,\n  type ListTypeOption\n} from '~/src/form/form-definition/types.js'\n\nexport type ConditionalComponentType = Exclude<\n  ConditionalComponentsDef['type'],\n  ContentComponentsDef\n>\n\n/**\n * Types for Components JSON structure which are expected by engine and turned into actual form input/content/lists\n */\n\ninterface FormFieldBase {\n  type: FormComponentsDef['type']\n  name: string\n  title: string\n  hint?: string\n  options: {\n    required?: boolean\n    optionalText?: boolean\n    classes?: string\n    customValidationMessages?: LanguageMessages\n  }\n}\n\ninterface ListFieldBase extends FormFieldBase {\n  type:\n    | ComponentType.AutocompleteField\n    | ComponentType.CheckboxesField\n    | ComponentType.RadiosField\n    | ComponentType.SelectField\n  list: string\n  options: FormFieldBase['options'] & {\n    type?: ListTypeContent\n  }\n}\n\ninterface ContentFieldBase {\n  type:\n    | ComponentType.Details\n    | ComponentType.Html\n    | ComponentType.InsetText\n    | ComponentType.List\n  name: string\n  title: string\n}\n\ninterface DateFieldBase {\n  type: ComponentType.DatePartsField | ComponentType.MonthYearField\n  name: string\n  title: string\n  hint?: string\n  options: {\n    required?: boolean\n    optionalText?: boolean\n    classes?: string\n    maxDaysInPast?: number\n    maxDaysInFuture?: number\n  }\n}\n\n// Text Fields\nexport interface TextFieldComponent extends FormFieldBase {\n  type: ComponentType.TextField\n  options: FormFieldBase['options'] & {\n    autocomplete?: string\n    condition?: string\n    customValidationMessage?: string\n  }\n  schema: {\n    max?: number\n    min?: number\n    length?: number\n    regex?: string\n  }\n}\n\nexport interface EmailAddressFieldComponent extends FormFieldBase {\n  type: ComponentType.EmailAddressField\n  options: FormFieldBase['options'] & {\n    condition?: string\n    customValidationMessage?: string\n  }\n}\n\nexport interface NumberFieldComponent extends FormFieldBase {\n  type: ComponentType.NumberField\n  options: FormFieldBase['options'] & {\n    prefix?: string\n    suffix?: string\n    autocomplete?: string\n    condition?: string\n    customValidationMessage?: string\n  }\n  schema: {\n    max?: number\n    min?: number\n    precision?: number\n  }\n}\n\nexport interface TelephoneNumberFieldComponent extends FormFieldBase {\n  type: ComponentType.TelephoneNumberField\n  options: FormFieldBase['options'] & {\n    condition?: string\n    customValidationMessage?: string\n  }\n}\n\nexport interface FileUploadFieldComponent {\n  type: ComponentType.FileUploadField\n  name: string\n  title: string\n  hint?: string\n  options: {\n    required?: boolean\n    classes?: string\n    optionalText?: boolean\n    accept?: string\n  }\n  schema: {\n    max?: number\n    min?: number\n    length?: number\n  }\n}\n\nexport interface YesNoFieldComponent extends FormFieldBase {\n  type: ComponentType.YesNoField\n  options: FormFieldBase['options'] & {\n    condition?: string\n  }\n}\n\nexport interface MultilineTextFieldComponent extends FormFieldBase {\n  type: ComponentType.MultilineTextField\n  options: FormFieldBase['options'] & {\n    autocomplete?: string\n    condition?: string\n    customValidationMessage?: string\n    rows?: number\n    maxWords?: number\n  }\n  schema: {\n    max?: number\n    min?: number\n    length?: number\n    regex?: string\n  }\n}\n\nexport interface UkAddressFieldComponent extends FormFieldBase {\n  type: ComponentType.UkAddressField\n  options: FormFieldBase['options'] & {\n    hideTitle?: boolean\n  }\n}\n\n// Date Fields\nexport interface DatePartsFieldComponent extends DateFieldBase {\n  type: ComponentType.DatePartsField\n  options: DateFieldBase['options'] & {\n    condition?: string\n  }\n}\n\nexport interface MonthYearFieldComponent extends DateFieldBase {\n  type: ComponentType.MonthYearField\n  options: DateFieldBase['options'] & {\n    customValidationMessage?: string\n  }\n}\n\n// Content Fields\nexport interface DetailsComponent extends ContentFieldBase {\n  type: ComponentType.Details\n  content: string\n  options: {\n    condition?: string\n  }\n}\n\nexport interface HtmlComponent extends ContentFieldBase {\n  type: ComponentType.Html\n  content: string\n  options: {\n    condition?: string\n  }\n}\n\nexport interface InsetTextComponent extends ContentFieldBase {\n  type: ComponentType.InsetText\n  content: string\n}\n\nexport interface ListComponent extends ContentFieldBase {\n  type: ComponentType.List\n  hint?: string\n  list: string\n  options: {\n    type?: ListTypeOption\n    classes?: string\n    hideTitle?: boolean\n    bold?: boolean\n  }\n}\n\nexport interface AutocompleteFieldComponent extends ListFieldBase {\n  type: ComponentType.AutocompleteField\n  options: ListFieldBase['options'] & {\n    condition?: string\n  }\n}\n\nexport interface CheckboxesFieldComponent extends ListFieldBase {\n  type: ComponentType.CheckboxesField\n  options: ListFieldBase['options'] & {\n    bold?: boolean\n    condition?: string\n  }\n}\n\nexport interface RadiosFieldComponent extends ListFieldBase {\n  type: ComponentType.RadiosField\n  options: ListFieldBase['options'] & {\n    bold?: boolean\n    condition?: string\n  }\n}\n\nexport interface SelectFieldComponent extends ListFieldBase {\n  type: ComponentType.SelectField\n  options: ListFieldBase['options'] & {\n    autocomplete?: string\n    condition?: string\n  }\n}\n\nexport type ComponentDef = FormComponentsDef | ContentComponentsDef\n\n// Components that render form fields\nexport type FormComponentsDef =\n  | InputFieldsComponentsDef\n  | SelectionComponentsDef\n\n// Components that render inputs\nexport type InputFieldsComponentsDef =\n  | TextFieldComponent\n  | EmailAddressFieldComponent\n  | NumberFieldComponent\n  | MultilineTextFieldComponent\n  | TelephoneNumberFieldComponent\n  | MonthYearFieldComponent\n  | DatePartsFieldComponent\n  | UkAddressFieldComponent\n  | FileUploadFieldComponent\n\n// Components that render content\nexport type ContentComponentsDef =\n  | DetailsComponent\n  | HtmlComponent\n  | InsetTextComponent\n  | ListComponent\n\n// Components that render lists\nexport type ListComponentsDef =\n  | Exclude<SelectionComponentsDef, YesNoFieldComponent>\n  | ListComponent\n\n// Components that have selection fields\nexport type SelectionComponentsDef =\n  | AutocompleteFieldComponent\n  | CheckboxesFieldComponent\n  | RadiosFieldComponent\n  | SelectFieldComponent\n  | YesNoFieldComponent\n\n// Components that have condition support\nexport type ConditionalComponentsDef = Exclude<\n  ComponentDef,\n  | InsetTextComponent\n  | ListComponent\n  | MonthYearFieldComponent\n  | UkAddressFieldComponent\n  | FileUploadFieldComponent\n>\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"types.js","names":[],"sources":["../../../src/components/types.ts"],"sourcesContent":["import { type LanguageMessages } from 'joi'\n\nimport { type ComponentType } from '~/src/components/enums.js'\nimport {\n  type ListTypeContent,\n  type ListTypeOption\n} from '~/src/form/form-definition/types.js'\n\nexport type ConditionalComponentType = Exclude<\n  ConditionalComponentsDef['type'],\n  ContentComponentsDef\n>\n\n/**\n * Types for Components JSON structure which are expected by engine and turned into actual form input/content/lists\n */\n\ninterface FormFieldBase {\n  type: FormComponentsDef['type']\n  name: string\n  title: string\n  hint?: string\n  options: {\n    required?: boolean\n    optionalText?: boolean\n    classes?: string\n    customValidationMessages?: LanguageMessages\n  }\n}\n\ninterface ListFieldBase extends FormFieldBase {\n  type:\n    | ComponentType.AutocompleteField\n    | ComponentType.CheckboxesField\n    | ComponentType.RadiosField\n    | ComponentType.SelectField\n  list: string\n  options: FormFieldBase['options'] & {\n    type?: ListTypeContent\n  }\n}\n\ninterface ContentFieldBase {\n  type:\n    | ComponentType.Details\n    | ComponentType.Html\n    | ComponentType.InsetText\n    | ComponentType.List\n  name: string\n  title: string\n  options?: {\n    required?: undefined\n    optionalText?: undefined\n  }\n}\n\ninterface DateFieldBase extends FormFieldBase {\n  type: ComponentType.DatePartsField | ComponentType.MonthYearField\n  name: string\n  title: string\n  hint?: string\n  options: FormFieldBase['options'] & {\n    maxDaysInPast?: number\n    maxDaysInFuture?: number\n  }\n}\n\n// Text Fields\nexport interface TextFieldComponent extends FormFieldBase {\n  type: ComponentType.TextField\n  options: FormFieldBase['options'] & {\n    autocomplete?: string\n    condition?: string\n    customValidationMessage?: string\n  }\n  schema: {\n    max?: number\n    min?: number\n    length?: number\n    regex?: string\n  }\n}\n\nexport interface EmailAddressFieldComponent extends FormFieldBase {\n  type: ComponentType.EmailAddressField\n  options: FormFieldBase['options'] & {\n    condition?: string\n    customValidationMessage?: string\n  }\n}\n\nexport interface NumberFieldComponent extends FormFieldBase {\n  type: ComponentType.NumberField\n  options: FormFieldBase['options'] & {\n    prefix?: string\n    suffix?: string\n    autocomplete?: string\n    condition?: string\n    customValidationMessage?: string\n  }\n  schema: {\n    max?: number\n    min?: number\n    precision?: number\n  }\n}\n\nexport interface TelephoneNumberFieldComponent extends FormFieldBase {\n  type: ComponentType.TelephoneNumberField\n  options: FormFieldBase['options'] & {\n    condition?: string\n    customValidationMessage?: string\n  }\n}\n\nexport interface FileUploadFieldComponent extends FormFieldBase {\n  type: ComponentType.FileUploadField\n  name: string\n  title: string\n  hint?: string\n  options: FormFieldBase['options'] & {\n    accept?: string\n  }\n  schema: {\n    max?: number\n    min?: number\n    length?: number\n  }\n}\n\nexport interface YesNoFieldComponent extends FormFieldBase {\n  type: ComponentType.YesNoField\n  options: FormFieldBase['options'] & {\n    condition?: string\n  }\n}\n\nexport interface MultilineTextFieldComponent extends FormFieldBase {\n  type: ComponentType.MultilineTextField\n  options: FormFieldBase['options'] & {\n    autocomplete?: string\n    condition?: string\n    customValidationMessage?: string\n    rows?: number\n    maxWords?: number\n  }\n  schema: {\n    max?: number\n    min?: number\n    length?: number\n    regex?: string\n  }\n}\n\nexport interface UkAddressFieldComponent extends FormFieldBase {\n  type: ComponentType.UkAddressField\n  options: FormFieldBase['options'] & {\n    hideTitle?: boolean\n  }\n}\n\n// Date Fields\nexport interface DatePartsFieldComponent extends DateFieldBase {\n  type: ComponentType.DatePartsField\n  options: DateFieldBase['options'] & {\n    condition?: string\n  }\n}\n\nexport interface MonthYearFieldComponent extends DateFieldBase {\n  type: ComponentType.MonthYearField\n  options: DateFieldBase['options'] & {\n    customValidationMessage?: string\n  }\n}\n\n// Content Fields\nexport interface DetailsComponent extends ContentFieldBase {\n  type: ComponentType.Details\n  content: string\n  options: ContentFieldBase['options'] & {\n    condition?: string\n  }\n}\n\nexport interface HtmlComponent extends ContentFieldBase {\n  type: ComponentType.Html\n  content: string\n  options: ContentFieldBase['options'] & {\n    condition?: string\n  }\n}\n\nexport interface InsetTextComponent extends ContentFieldBase {\n  type: ComponentType.InsetText\n  content: string\n}\n\nexport interface ListComponent extends ContentFieldBase {\n  type: ComponentType.List\n  hint?: string\n  list: string\n  options: ContentFieldBase['options'] & {\n    type?: ListTypeOption\n    classes?: string\n    hideTitle?: boolean\n    bold?: boolean\n  }\n}\n\nexport interface AutocompleteFieldComponent extends ListFieldBase {\n  type: ComponentType.AutocompleteField\n  options: ListFieldBase['options'] & {\n    condition?: string\n  }\n}\n\nexport interface CheckboxesFieldComponent extends ListFieldBase {\n  type: ComponentType.CheckboxesField\n  options: ListFieldBase['options'] & {\n    bold?: boolean\n    condition?: string\n  }\n}\n\nexport interface RadiosFieldComponent extends ListFieldBase {\n  type: ComponentType.RadiosField\n  options: ListFieldBase['options'] & {\n    bold?: boolean\n    condition?: string\n  }\n}\n\nexport interface SelectFieldComponent extends ListFieldBase {\n  type: ComponentType.SelectField\n  options: ListFieldBase['options'] & {\n    autocomplete?: string\n    condition?: string\n  }\n}\n\nexport type ComponentDef = FormComponentsDef | ContentComponentsDef\n\n// Components that render form fields\nexport type FormComponentsDef =\n  | InputFieldsComponentsDef\n  | SelectionComponentsDef\n\n// Components that render inputs\nexport type InputFieldsComponentsDef =\n  | TextFieldComponent\n  | EmailAddressFieldComponent\n  | NumberFieldComponent\n  | MultilineTextFieldComponent\n  | TelephoneNumberFieldComponent\n  | MonthYearFieldComponent\n  | DatePartsFieldComponent\n  | UkAddressFieldComponent\n  | FileUploadFieldComponent\n\n// Components that render content\nexport type ContentComponentsDef =\n  | DetailsComponent\n  | HtmlComponent\n  | InsetTextComponent\n  | ListComponent\n\n// Components that render lists\nexport type ListComponentsDef =\n  | Exclude<SelectionComponentsDef, YesNoFieldComponent>\n  | ListComponent\n\n// Components that have selection fields\nexport type SelectionComponentsDef =\n  | AutocompleteFieldComponent\n  | CheckboxesFieldComponent\n  | RadiosFieldComponent\n  | SelectFieldComponent\n  | YesNoFieldComponent\n\n// Components that have condition support\nexport type ConditionalComponentsDef = Exclude<\n  ComponentDef,\n  | InsetTextComponent\n  | ListComponent\n  | MonthYearFieldComponent\n  | UkAddressFieldComponent\n  | FileUploadFieldComponent\n>\n"],"mappings":"","ignoreList":[]}

package/dist/module/index.js

@@ -1,9 +1,10 @@
+export * from "./common/pagination/index.js";
+export * from "./components/index.js";
+export * from "./conditions/index.js";
 export * from "./form/form-definition/index.js";
 export * from "./form/form-metadata/index.js";
 export * from "./form/form-submission/index.js";
 export * from "./form/utils/index.js";
-export * from "./components/index.js";
-export * from "./conditions/index.js";
 export * from "./pages/index.js";
 export * from "./utils/helpers.js";
 export * from "./utils/markdown.js";

package/dist/module/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../../src/index.ts"],"sourcesContent":["export * from '~/src/form/form-definition/index.js'\nexport * from '~/src/form/form-metadata/index.js'\nexport * from '~/src/form/form-submission/index.js'\nexport * from '~/src/form/utils/index.js'\nexport * from '~/src/components/index.js'\nexport * from '~/src/conditions/index.js'\nexport * from '~/src/pages/index.js'\nexport * from '~/src/utils/helpers.js'\nexport * from '~/src/utils/markdown.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'\nexport type * from '~/src/form/form-submission/types.js'\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"index.js","names":[],"sources":["../../src/index.ts"],"sourcesContent":["export * from '~/src/common/pagination/index.js'\nexport * from '~/src/components/index.js'\nexport * from '~/src/conditions/index.js'\nexport * from '~/src/form/form-definition/index.js'\nexport * from '~/src/form/form-metadata/index.js'\nexport * from '~/src/form/form-submission/index.js'\nexport * from '~/src/form/utils/index.js'\nexport * from '~/src/pages/index.js'\nexport * from '~/src/utils/helpers.js'\nexport * from '~/src/utils/markdown.js'\n\nexport type * from '~/src/common/pagination/types.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'\nexport type * from '~/src/form/form-submission/types.js'\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA","ignoreList":[]}

package/dist/types/common/pagination/index.d.ts

@@ -0,0 +1,7 @@
+import Joi from 'joi';
+/**
+ * Joi schema for `PaginationOptions` interface
+ * @see {@link PaginationOptions}
+ */
+export declare const paginationOptionsSchema: Joi.ObjectSchema<Partial<Pick<import("../../common/pagination/types.js").PaginationResult, "page" | "perPage">>>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/common/pagination/index.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAA;AAIrB;;;GAGG;AACH,eAAO,MAAM,uBAAuB,kHAGvB,CAAA"}

package/dist/types/common/pagination/types.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Result of pagination containing page information
+ */
+export interface PaginationResult {
+    /**
+     * The current page number.
+     */
+    page: number;
+    /**
+     * The number of items per page.
+     */
+    perPage: number;
+    /**
+     * The total number of items available.
+     */
+    totalItems: number;
+    /**
+     * The total number of pages available.
+     */
+    totalPages: number;
+}
+/**
+ * Options for paginating results
+ * Allows partial specification of page and perPage from PaginationResult
+ */
+export type PaginationOptions = Partial<Pick<PaginationResult, 'page' | 'perPage'>>;
+/**
+ * Metadata containing optional pagination information
+ */
+export interface Meta {
+    /**
+     * The pagination details
+     */
+    pagination?: PaginationResult;
+}
+/**
+ * Standard response wrapper for query results with metadata
+ */
+export interface QueryResult<Model> {
+    /**
+     * The array of data items
+     */
+    data: Model[];
+    /**
+     * The metadata about the result
+     */
+    meta: Meta;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types/common/pagination/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/common/pagination/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,CACrC,IAAI,CAAC,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAC,CAC3C,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAA;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,KAAK;IAChC;;OAEG;IACH,IAAI,EAAE,KAAK,EAAE,CAAA;IAEb;;OAEG;IACH,IAAI,EAAE,IAAI,CAAA;CACX"}

package/dist/types/components/types.d.ts

@@ -28,16 +28,17 @@ interface ContentFieldBase {
     type: ComponentType.Details | ComponentType.Html | ComponentType.InsetText | ComponentType.List;
     name: string;
     title: string;
+    options?: {
+        required?: undefined;
+        optionalText?: undefined;
+    };
 }
-interface DateFieldBase {
+interface DateFieldBase extends FormFieldBase {
     type: ComponentType.DatePartsField | ComponentType.MonthYearField;
     name: string;
     title: string;
     hint?: string;
-    options: {
-        required?: boolean;
-        optionalText?: boolean;
-        classes?: string;
+    options: FormFieldBase['options'] & {
         maxDaysInPast?: number;
         maxDaysInFuture?: number;
     };
@@ -85,15 +86,12 @@ export interface TelephoneNumberFieldComponent extends FormFieldBase {
         customValidationMessage?: string;
     };
 }
-export interface FileUploadFieldComponent {
+export interface FileUploadFieldComponent extends FormFieldBase {
     type: ComponentType.FileUploadField;
     name: string;
     title: string;
     hint?: string;
-    options: {
-        required?: boolean;
-        classes?: string;
-        optionalText?: boolean;
+    options: FormFieldBase['options'] & {
         accept?: string;
     };
     schema: {
@@ -145,14 +143,14 @@ export interface MonthYearFieldComponent extends DateFieldBase {
 export interface DetailsComponent extends ContentFieldBase {
     type: ComponentType.Details;
     content: string;
-    options: {
+    options: ContentFieldBase['options'] & {
         condition?: string;
     };
 }
 export interface HtmlComponent extends ContentFieldBase {
     type: ComponentType.Html;
     content: string;
-    options: {
+    options: ContentFieldBase['options'] & {
         condition?: string;
     };
 }
@@ -164,7 +162,7 @@ export interface ListComponent extends ContentFieldBase {
     type: ComponentType.List;
     hint?: string;
     list: string;
-    options: {
+    options: ContentFieldBase['options'] & {
         type?: ListTypeOption;
         classes?: string;
         hideTitle?: boolean;

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/components/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,KAAK,CAAA;AAE3C,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAC9D,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,cAAc,EACpB,MAAM,qCAAqC,CAAA;AAE5C,MAAM,MAAM,wBAAwB,GAAG,OAAO,CAC5C,wBAAwB,CAAC,MAAM,CAAC,EAChC,oBAAoB,CACrB,CAAA;AAED;;GAEG;AAEH,UAAU,aAAa;IACrB,IAAI,EAAE,iBAAiB,CAAC,MAAM,CAAC,CAAA;IAC/B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,EAAE;QACP,QAAQ,CAAC,EAAE,OAAO,CAAA;QAClB,YAAY,CAAC,EAAE,OAAO,CAAA;QACtB,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,wBAAwB,CAAC,EAAE,gBAAgB,CAAA;KAC5C,CAAA;CACF;AAED,UAAU,aAAc,SAAQ,aAAa;IAC3C,IAAI,EACA,aAAa,CAAC,iBAAiB,GAC/B,aAAa,CAAC,eAAe,GAC7B,aAAa,CAAC,WAAW,GACzB,aAAa,CAAC,WAAW,CAAA;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,GAAG;QAClC,IAAI,CAAC,EAAE,eAAe,CAAA;KACvB,CAAA;CACF;AAED,UAAU,gBAAgB;IACxB,IAAI,EACA,aAAa,CAAC,OAAO,GACrB,aAAa,CAAC,IAAI,GAClB,aAAa,CAAC,SAAS,GACvB,aAAa,CAAC,IAAI,CAAA;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;CACd;AAED,UAAU,aAAa;IACrB,IAAI,EAAE,aAAa,CAAC,cAAc,GAAG,aAAa,CAAC,cAAc,CAAA;IACjE,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,EAAE;QACP,QAAQ,CAAC,EAAE,OAAO,CAAA;QAClB,YAAY,CAAC,EAAE,OAAO,CAAA;QACtB,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,aAAa,CAAC,EAAE,MAAM,CAAA;QACtB,eAAe,CAAC,EAAE,MAAM,CAAA;KACzB,CAAA;CACF;AAGD,MAAM,WAAW,kBAAmB,SAAQ,aAAa;IACvD,IAAI,EAAE,aAAa,CAAC,SAAS,CAAA;IAC7B,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,GAAG;QAClC,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,uBAAuB,CAAC,EAAE,MAAM,CAAA;KACjC,CAAA;IACD,MAAM,EAAE;QACN,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,KAAK,CAAC,EAAE,MAAM,CAAA;KACf,CAAA;CACF;AAED,MAAM,WAAW,0BAA2B,SAAQ,aAAa;IAC/D,IAAI,EAAE,aAAa,CAAC,iBAAiB,CAAA;IACrC,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,GAAG;QAClC,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,uBAAuB,CAAC,EAAE,MAAM,CAAA;KACjC,CAAA;CACF;AAED,MAAM,WAAW,oBAAqB,SAAQ,aAAa;IACzD,IAAI,EAAE,aAAa,CAAC,WAAW,CAAA;IAC/B,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,GAAG;QAClC,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,uBAAuB,CAAC,EAAE,MAAM,CAAA;KACjC,CAAA;IACD,MAAM,EAAE;QACN,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,CAAA;CACF;AAED,MAAM,WAAW,6BAA8B,SAAQ,aAAa;IAClE,IAAI,EAAE,aAAa,CAAC,oBAAoB,CAAA;IACxC,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,GAAG;QAClC,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,uBAAuB,CAAC,EAAE,MAAM,CAAA;KACjC,CAAA;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,aAAa,CAAC,eAAe,CAAA;IACnC,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,EAAE;QACP,QAAQ,CAAC,EAAE,OAAO,CAAA;QAClB,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,YAAY,CAAC,EAAE,OAAO,CAAA;QACtB,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,CAAA;IACD,MAAM,EAAE;QACN,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,CAAA;CACF;AAED,MAAM,WAAW,mBAAoB,SAAQ,aAAa;IACxD,IAAI,EAAE,aAAa,CAAC,UAAU,CAAA;IAC9B,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,GAAG;QAClC,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,CAAA;CACF;AAED,MAAM,WAAW,2BAA4B,SAAQ,aAAa;IAChE,IAAI,EAAE,aAAa,CAAC,kBAAkB,CAAA;IACtC,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,GAAG;QAClC,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,uBAAuB,CAAC,EAAE,MAAM,CAAA;QAChC,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,QAAQ,CAAC,EAAE,MAAM,CAAA;KAClB,CAAA;IACD,MAAM,EAAE;QACN,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,KAAK,CAAC,EAAE,MAAM,CAAA;KACf,CAAA;CACF;AAED,MAAM,WAAW,uBAAwB,SAAQ,aAAa;IAC5D,IAAI,EAAE,aAAa,CAAC,cAAc,CAAA;IAClC,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,GAAG;QAClC,SAAS,CAAC,EAAE,OAAO,CAAA;KACpB,CAAA;CACF;AAGD,MAAM,WAAW,uBAAwB,SAAQ,aAAa;IAC5D,IAAI,EAAE,aAAa,CAAC,cAAc,CAAA;IAClC,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,GAAG;QAClC,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,CAAA;CACF;AAED,MAAM,WAAW,uBAAwB,SAAQ,aAAa;IAC5D,IAAI,EAAE,aAAa,CAAC,cAAc,CAAA;IAClC,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,GAAG;QAClC,uBAAuB,CAAC,EAAE,MAAM,CAAA;KACjC,CAAA;CACF;AAGD,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACxD,IAAI,EAAE,aAAa,CAAC,OAAO,CAAA;IAC3B,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE;QACP,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,CAAA;CACF;AAED,MAAM,WAAW,aAAc,SAAQ,gBAAgB;IACrD,IAAI,EAAE,aAAa,CAAC,IAAI,CAAA;IACxB,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE;QACP,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,CAAA;CACF;AAED,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC1D,IAAI,EAAE,aAAa,CAAC,SAAS,CAAA;IAC7B,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,aAAc,SAAQ,gBAAgB;IACrD,IAAI,EAAE,aAAa,CAAC,IAAI,CAAA;IACxB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE;QACP,IAAI,CAAC,EAAE,cAAc,CAAA;QACrB,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,SAAS,CAAC,EAAE,OAAO,CAAA;QACnB,IAAI,CAAC,EAAE,OAAO,CAAA;KACf,CAAA;CACF;AAED,MAAM,WAAW,0BAA2B,SAAQ,aAAa;IAC/D,IAAI,EAAE,aAAa,CAAC,iBAAiB,CAAA;IACrC,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,GAAG;QAClC,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,CAAA;CACF;AAED,MAAM,WAAW,wBAAyB,SAAQ,aAAa;IAC7D,IAAI,EAAE,aAAa,CAAC,eAAe,CAAA;IACnC,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,GAAG;QAClC,IAAI,CAAC,EAAE,OAAO,CAAA;QACd,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,CAAA;CACF;AAED,MAAM,WAAW,oBAAqB,SAAQ,aAAa;IACzD,IAAI,EAAE,aAAa,CAAC,WAAW,CAAA;IAC/B,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,GAAG;QAClC,IAAI,CAAC,EAAE,OAAO,CAAA;QACd,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,CAAA;CACF;AAED,MAAM,WAAW,oBAAqB,SAAQ,aAAa;IACzD,IAAI,EAAE,aAAa,CAAC,WAAW,CAAA;IAC/B,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,GAAG;QAClC,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,CAAA;CACF;AAED,MAAM,MAAM,YAAY,GAAG,iBAAiB,GAAG,oBAAoB,CAAA;AAGnE,MAAM,MAAM,iBAAiB,GACzB,wBAAwB,GACxB,sBAAsB,CAAA;AAG1B,MAAM,MAAM,wBAAwB,GAChC,kBAAkB,GAClB,0BAA0B,GAC1B,oBAAoB,GACpB,2BAA2B,GAC3B,6BAA6B,GAC7B,uBAAuB,GACvB,uBAAuB,GACvB,uBAAuB,GACvB,wBAAwB,CAAA;AAG5B,MAAM,MAAM,oBAAoB,GAC5B,gBAAgB,GAChB,aAAa,GACb,kBAAkB,GAClB,aAAa,CAAA;AAGjB,MAAM,MAAM,iBAAiB,GACzB,OAAO,CAAC,sBAAsB,EAAE,mBAAmB,CAAC,GACpD,aAAa,CAAA;AAGjB,MAAM,MAAM,sBAAsB,GAC9B,0BAA0B,GAC1B,wBAAwB,GACxB,oBAAoB,GACpB,oBAAoB,GACpB,mBAAmB,CAAA;AAGvB,MAAM,MAAM,wBAAwB,GAAG,OAAO,CAC5C,YAAY,EACV,kBAAkB,GAClB,aAAa,GACb,uBAAuB,GACvB,uBAAuB,GACvB,wBAAwB,CAC3B,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/components/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,KAAK,CAAA;AAE3C,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAC9D,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,cAAc,EACpB,MAAM,qCAAqC,CAAA;AAE5C,MAAM,MAAM,wBAAwB,GAAG,OAAO,CAC5C,wBAAwB,CAAC,MAAM,CAAC,EAChC,oBAAoB,CACrB,CAAA;AAED;;GAEG;AAEH,UAAU,aAAa;IACrB,IAAI,EAAE,iBAAiB,CAAC,MAAM,CAAC,CAAA;IAC/B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,EAAE;QACP,QAAQ,CAAC,EAAE,OAAO,CAAA;QAClB,YAAY,CAAC,EAAE,OAAO,CAAA;QACtB,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,wBAAwB,CAAC,EAAE,gBAAgB,CAAA;KAC5C,CAAA;CACF;AAED,UAAU,aAAc,SAAQ,aAAa;IAC3C,IAAI,EACA,aAAa,CAAC,iBAAiB,GAC/B,aAAa,CAAC,eAAe,GAC7B,aAAa,CAAC,WAAW,GACzB,aAAa,CAAC,WAAW,CAAA;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,GAAG;QAClC,IAAI,CAAC,EAAE,eAAe,CAAA;KACvB,CAAA;CACF;AAED,UAAU,gBAAgB;IACxB,IAAI,EACA,aAAa,CAAC,OAAO,GACrB,aAAa,CAAC,IAAI,GAClB,aAAa,CAAC,SAAS,GACvB,aAAa,CAAC,IAAI,CAAA;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,EAAE,SAAS,CAAA;QACpB,YAAY,CAAC,EAAE,SAAS,CAAA;KACzB,CAAA;CACF;AAED,UAAU,aAAc,SAAQ,aAAa;IAC3C,IAAI,EAAE,aAAa,CAAC,cAAc,GAAG,aAAa,CAAC,cAAc,CAAA;IACjE,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,GAAG;QAClC,aAAa,CAAC,EAAE,MAAM,CAAA;QACtB,eAAe,CAAC,EAAE,MAAM,CAAA;KACzB,CAAA;CACF;AAGD,MAAM,WAAW,kBAAmB,SAAQ,aAAa;IACvD,IAAI,EAAE,aAAa,CAAC,SAAS,CAAA;IAC7B,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,GAAG;QAClC,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,uBAAuB,CAAC,EAAE,MAAM,CAAA;KACjC,CAAA;IACD,MAAM,EAAE;QACN,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,KAAK,CAAC,EAAE,MAAM,CAAA;KACf,CAAA;CACF;AAED,MAAM,WAAW,0BAA2B,SAAQ,aAAa;IAC/D,IAAI,EAAE,aAAa,CAAC,iBAAiB,CAAA;IACrC,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,GAAG;QAClC,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,uBAAuB,CAAC,EAAE,MAAM,CAAA;KACjC,CAAA;CACF;AAED,MAAM,WAAW,oBAAqB,SAAQ,aAAa;IACzD,IAAI,EAAE,aAAa,CAAC,WAAW,CAAA;IAC/B,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,GAAG;QAClC,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,uBAAuB,CAAC,EAAE,MAAM,CAAA;KACjC,CAAA;IACD,MAAM,EAAE;QACN,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,CAAA;CACF;AAED,MAAM,WAAW,6BAA8B,SAAQ,aAAa;IAClE,IAAI,EAAE,aAAa,CAAC,oBAAoB,CAAA;IACxC,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,GAAG;QAClC,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,uBAAuB,CAAC,EAAE,MAAM,CAAA;KACjC,CAAA;CACF;AAED,MAAM,WAAW,wBAAyB,SAAQ,aAAa;IAC7D,IAAI,EAAE,aAAa,CAAC,eAAe,CAAA;IACnC,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,GAAG;QAClC,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,CAAA;IACD,MAAM,EAAE;QACN,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,CAAA;CACF;AAED,MAAM,WAAW,mBAAoB,SAAQ,aAAa;IACxD,IAAI,EAAE,aAAa,CAAC,UAAU,CAAA;IAC9B,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,GAAG;QAClC,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,CAAA;CACF;AAED,MAAM,WAAW,2BAA4B,SAAQ,aAAa;IAChE,IAAI,EAAE,aAAa,CAAC,kBAAkB,CAAA;IACtC,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,GAAG;QAClC,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,uBAAuB,CAAC,EAAE,MAAM,CAAA;QAChC,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,QAAQ,CAAC,EAAE,MAAM,CAAA;KAClB,CAAA;IACD,MAAM,EAAE;QACN,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,KAAK,CAAC,EAAE,MAAM,CAAA;KACf,CAAA;CACF;AAED,MAAM,WAAW,uBAAwB,SAAQ,aAAa;IAC5D,IAAI,EAAE,aAAa,CAAC,cAAc,CAAA;IAClC,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,GAAG;QAClC,SAAS,CAAC,EAAE,OAAO,CAAA;KACpB,CAAA;CACF;AAGD,MAAM,WAAW,uBAAwB,SAAQ,aAAa;IAC5D,IAAI,EAAE,aAAa,CAAC,cAAc,CAAA;IAClC,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,GAAG;QAClC,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,CAAA;CACF;AAED,MAAM,WAAW,uBAAwB,SAAQ,aAAa;IAC5D,IAAI,EAAE,aAAa,CAAC,cAAc,CAAA;IAClC,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,GAAG;QAClC,uBAAuB,CAAC,EAAE,MAAM,CAAA;KACjC,CAAA;CACF;AAGD,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACxD,IAAI,EAAE,aAAa,CAAC,OAAO,CAAA;IAC3B,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,gBAAgB,CAAC,SAAS,CAAC,GAAG;QACrC,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,CAAA;CACF;AAED,MAAM,WAAW,aAAc,SAAQ,gBAAgB;IACrD,IAAI,EAAE,aAAa,CAAC,IAAI,CAAA;IACxB,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,gBAAgB,CAAC,SAAS,CAAC,GAAG;QACrC,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,CAAA;CACF;AAED,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC1D,IAAI,EAAE,aAAa,CAAC,SAAS,CAAA;IAC7B,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,aAAc,SAAQ,gBAAgB;IACrD,IAAI,EAAE,aAAa,CAAC,IAAI,CAAA;IACxB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,gBAAgB,CAAC,SAAS,CAAC,GAAG;QACrC,IAAI,CAAC,EAAE,cAAc,CAAA;QACrB,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,SAAS,CAAC,EAAE,OAAO,CAAA;QACnB,IAAI,CAAC,EAAE,OAAO,CAAA;KACf,CAAA;CACF;AAED,MAAM,WAAW,0BAA2B,SAAQ,aAAa;IAC/D,IAAI,EAAE,aAAa,CAAC,iBAAiB,CAAA;IACrC,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,GAAG;QAClC,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,CAAA;CACF;AAED,MAAM,WAAW,wBAAyB,SAAQ,aAAa;IAC7D,IAAI,EAAE,aAAa,CAAC,eAAe,CAAA;IACnC,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,GAAG;QAClC,IAAI,CAAC,EAAE,OAAO,CAAA;QACd,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,CAAA;CACF;AAED,MAAM,WAAW,oBAAqB,SAAQ,aAAa;IACzD,IAAI,EAAE,aAAa,CAAC,WAAW,CAAA;IAC/B,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,GAAG;QAClC,IAAI,CAAC,EAAE,OAAO,CAAA;QACd,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,CAAA;CACF;AAED,MAAM,WAAW,oBAAqB,SAAQ,aAAa;IACzD,IAAI,EAAE,aAAa,CAAC,WAAW,CAAA;IAC/B,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,GAAG;QAClC,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,CAAA;CACF;AAED,MAAM,MAAM,YAAY,GAAG,iBAAiB,GAAG,oBAAoB,CAAA;AAGnE,MAAM,MAAM,iBAAiB,GACzB,wBAAwB,GACxB,sBAAsB,CAAA;AAG1B,MAAM,MAAM,wBAAwB,GAChC,kBAAkB,GAClB,0BAA0B,GAC1B,oBAAoB,GACpB,2BAA2B,GAC3B,6BAA6B,GAC7B,uBAAuB,GACvB,uBAAuB,GACvB,uBAAuB,GACvB,wBAAwB,CAAA;AAG5B,MAAM,MAAM,oBAAoB,GAC5B,gBAAgB,GAChB,aAAa,GACb,kBAAkB,GAClB,aAAa,CAAA;AAGjB,MAAM,MAAM,iBAAiB,GACzB,OAAO,CAAC,sBAAsB,EAAE,mBAAmB,CAAC,GACpD,aAAa,CAAA;AAGjB,MAAM,MAAM,sBAAsB,GAC9B,0BAA0B,GAC1B,wBAAwB,GACxB,oBAAoB,GACpB,oBAAoB,GACpB,mBAAmB,CAAA;AAGvB,MAAM,MAAM,wBAAwB,GAAG,OAAO,CAC5C,YAAY,EACV,kBAAkB,GAClB,aAAa,GACb,uBAAuB,GACvB,uBAAuB,GACvB,wBAAwB,CAC3B,CAAA"}

package/dist/types/index.d.ts

@@ -1,12 +1,14 @@
+export * from './common/pagination/index.js';
+export * from './components/index.js';
+export * from './conditions/index.js';
 export * from './form/form-definition/index.js';
 export * from './form/form-metadata/index.js';
 export * from './form/form-submission/index.js';
 export * from './form/utils/index.js';
-export * from './components/index.js';
-export * from './conditions/index.js';
 export * from './pages/index.js';
 export * from './utils/helpers.js';
 export * from './utils/markdown.js';
+export type * from './common/pagination/types.js';
 export type * from './components/types.js';
 export type * from './conditions/types.js';
 export type * from './form/form-definition/types.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,qCAAqC,CAAA;AACnD,cAAc,mCAAmC,CAAA;AACjD,cAAc,qCAAqC,CAAA;AACnD,cAAc,2BAA2B,CAAA;AACzC,cAAc,2BAA2B,CAAA;AACzC,cAAc,2BAA2B,CAAA;AACzC,cAAc,sBAAsB,CAAA;AACpC,cAAc,wBAAwB,CAAA;AACtC,cAAc,yBAAyB,CAAA;AACvC,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,qCAAqC,CAAA;AACxD,mBAAmB,mCAAmC,CAAA;AACtD,mBAAmB,qCAAqC,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kCAAkC,CAAA;AAChD,cAAc,2BAA2B,CAAA;AACzC,cAAc,2BAA2B,CAAA;AACzC,cAAc,qCAAqC,CAAA;AACnD,cAAc,mCAAmC,CAAA;AACjD,cAAc,qCAAqC,CAAA;AACnD,cAAc,2BAA2B,CAAA;AACzC,cAAc,sBAAsB,CAAA;AACpC,cAAc,wBAAwB,CAAA;AACtC,cAAc,yBAAyB,CAAA;AAEvC,mBAAmB,kCAAkC,CAAA;AACrD,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,qCAAqC,CAAA;AACxD,mBAAmB,mCAAmC,CAAA;AACtD,mBAAmB,qCAAqC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-model",
-  "version": "3.0.385",
+  "version": "3.0.387",
   "description": "A hapi plugin providing the model for Defra forms",
   "homepage": "https://github.com/DEFRA/forms-designer/tree/main/model#readme",
   "repository": {
@@ -21,7 +21,7 @@
     "test:watch": "jest --color --watch"
   },
   "dependencies": {
-    "marked": "^15.0.1",
+    "marked": "^15.0.3",
     "slug": "^10.0.0"
   },
   "devDependencies": {

package/src/common/pagination/index.ts

@@ -0,0 +1,12 @@
+import Joi from 'joi'
+
+import { type PaginationOptions } from '~/src/common/pagination/types.js'
+
+/**
+ * Joi schema for `PaginationOptions` interface
+ * @see {@link PaginationOptions}
+ */
+export const paginationOptionsSchema = Joi.object<PaginationOptions>({
+  page: Joi.number().positive().integer().min(1),
+  perPage: Joi.number().positive().integer().min(1).max(200)
+}).optional()

package/src/common/pagination/types.ts

@@ -0,0 +1,57 @@
+/**
+ * Result of pagination containing page information
+ */
+export interface PaginationResult {
+  /**
+   * The current page number.
+   */
+  page: number
+
+  /**
+   * The number of items per page.
+   */
+  perPage: number
+
+  /**
+   * The total number of items available.
+   */
+  totalItems: number
+
+  /**
+   * The total number of pages available.
+   */
+  totalPages: number
+}
+
+/**
+ * Options for paginating results
+ * Allows partial specification of page and perPage from PaginationResult
+ */
+export type PaginationOptions = Partial<
+  Pick<PaginationResult, 'page' | 'perPage'>
+>
+
+/**
+ * Metadata containing optional pagination information
+ */
+export interface Meta {
+  /**
+   * The pagination details
+   */
+  pagination?: PaginationResult
+}
+
+/**
+ * Standard response wrapper for query results with metadata
+ */
+export interface QueryResult<Model> {
+  /**
+   * The array of data items
+   */
+  data: Model[]
+
+  /**
+   * The metadata about the result
+   */
+  meta: Meta
+}

package/src/components/types.ts

@@ -48,17 +48,18 @@ interface ContentFieldBase {
     | ComponentType.List
   name: string
   title: string
+  options?: {
+    required?: undefined
+    optionalText?: undefined
+  }
 }
 
-interface DateFieldBase {
+interface DateFieldBase extends FormFieldBase {
   type: ComponentType.DatePartsField | ComponentType.MonthYearField
   name: string
   title: string
   hint?: string
-  options: {
-    required?: boolean
-    optionalText?: boolean
-    classes?: string
+  options: FormFieldBase['options'] & {
     maxDaysInPast?: number
     maxDaysInFuture?: number
   }
@@ -112,15 +113,12 @@ export interface TelephoneNumberFieldComponent extends FormFieldBase {
   }
 }
 
-export interface FileUploadFieldComponent {
+export interface FileUploadFieldComponent extends FormFieldBase {
   type: ComponentType.FileUploadField
   name: string
   title: string
   hint?: string
-  options: {
-    required?: boolean
-    classes?: string
-    optionalText?: boolean
+  options: FormFieldBase['options'] & {
     accept?: string
   }
   schema: {
@@ -180,7 +178,7 @@ export interface MonthYearFieldComponent extends DateFieldBase {
 export interface DetailsComponent extends ContentFieldBase {
   type: ComponentType.Details
   content: string
-  options: {
+  options: ContentFieldBase['options'] & {
     condition?: string
   }
 }
@@ -188,7 +186,7 @@ export interface DetailsComponent extends ContentFieldBase {
 export interface HtmlComponent extends ContentFieldBase {
   type: ComponentType.Html
   content: string
-  options: {
+  options: ContentFieldBase['options'] & {
     condition?: string
   }
 }
@@ -202,7 +200,7 @@ export interface ListComponent extends ContentFieldBase {
   type: ComponentType.List
   hint?: string
   list: string
-  options: {
+  options: ContentFieldBase['options'] & {
     type?: ListTypeOption
     classes?: string
     hideTitle?: boolean

package/src/index.ts

@@ -1,12 +1,15 @@
+export * from '~/src/common/pagination/index.js'
+export * from '~/src/components/index.js'
+export * from '~/src/conditions/index.js'
 export * from '~/src/form/form-definition/index.js'
 export * from '~/src/form/form-metadata/index.js'
 export * from '~/src/form/form-submission/index.js'
 export * from '~/src/form/utils/index.js'
-export * from '~/src/components/index.js'
-export * from '~/src/conditions/index.js'
 export * from '~/src/pages/index.js'
 export * from '~/src/utils/helpers.js'
 export * from '~/src/utils/markdown.js'
+
+export type * from '~/src/common/pagination/types.js'
 export type * from '~/src/components/types.js'
 export type * from '~/src/conditions/types.js'
 export type * from '~/src/form/form-definition/types.js'