@ukhomeoffice/cop-react-form-renderer 7.3.2 → 8.0.0-alpha

package/dist/utils/Hub/index.d.ts

@@ -0,0 +1,4 @@
+declare const Hub: {
+    get: (type: any, hub: any, components: any, formData: any) => any;
+};
+export default Hub;

package/dist/utils/Meta/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const META_PROPERTY = "meta";
+export declare const META_DOCUMENTS_PROPERTY = "documents";

package/dist/utils/Meta/documents/getDocuments.d.ts

@@ -0,0 +1,2 @@
+declare const getDocuments: (formData: any) => any;
+export default getDocuments;

package/dist/utils/Meta/documents/index.d.ts

@@ -0,0 +1,6 @@
+declare const documents: {
+    setForField: (documents: any, formData: any, field: any, allowMultiple: any) => any;
+    get: (formData: any) => any;
+    name: string;
+};
+export default documents;

package/dist/utils/Meta/documents/setDocumentsForField.d.ts

@@ -0,0 +1,2 @@
+declare const setDocumentsForField: (documents: any, formData: any, field: any, allowMultiple: any) => any;
+export default setDocumentsForField;

package/dist/utils/Meta/index.d.ts

@@ -0,0 +1,9 @@
+declare const Meta: {
+    documents: {
+        setForField: (documents: any, formData: any, field: any, allowMultiple: any) => any;
+        get: (formData: any) => any;
+        name: string;
+    };
+    name: string;
+};
+export default Meta;

package/dist/utils/Operate/checkValueIsTruthy.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Simple operation to check if a given value in data is truthy or not.
+ * Supports getting a value from an interpolated field string.
+ * @param {object} config The operation config.
+ * @param {object} data The page's formData.
+ * @returns true if the value is truthy, false if it isn't or doesn't exist.
+ */
+declare const checkValueIsTruthy: (config: any, data: any) => boolean;
+export default checkValueIsTruthy;

package/dist/utils/Operate/deleteValueInFormData.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Simple operation to delete a value in the form data.
+ * @param {object} config The operation config.
+ * @param {object} data The page's formData.
+ * @param {function} onChange The page's onChange handler.
+ */
+declare const deleteValueInFormData: (config: any, data: any, onChange: any) => void;
+export default deleteValueInFormData;

package/dist/utils/Operate/doesContainValue.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Returns if it can find a value in the form data. supports searching in arrays and objects
+ * @param {object} config The config of the operation.
+ * @param {string} config.target the JPath to the object/array that contains the data we want to checkon
+ * @param {string} config.key the JPath to the field we want to check
+ * @param {string} config.value the value that we want to check the the data against
+ * @param {object} data A page's formData.
+ * @returns The index of the matching value if one exists, or null.
+ */
+declare const doesContainValue: (config: any, data: any) => boolean;
+export default doesContainValue;

package/dist/utils/Operate/getFirstOf.d.ts

@@ -0,0 +1,2 @@
+declare const getFirstOf: (config: any, data: any) => any;
+export default getFirstOf;

package/dist/utils/Operate/getIndexOfMatchingValueIn.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Searches for a value in an array in data that matches a value given
+ * in config. A cutoff index can be provided in config if the search
+ * should stop after a certain number of entries. An index to ignore
+ * can also be provided.
+ * @param {object} config The config of the operation.
+ * @param {object} data A page's formData.
+ * @returns The index of the matching value if one exists, or null.
+ */
+declare const getIndexOfMatchingValueIn: (config: any, data: any) => any;
+export default getIndexOfMatchingValueIn;

package/dist/utils/Operate/getLength.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Finds a field within data and returns its length
+ * @param {object} config The config of the operation.
+ * @param {string} config.target The path to the target field. If the path
+ * goes through a collection this can be specified as 'collectionName[]'
+ * and this function will use the active entry within that collection.
+ * @param {object} data A page's formData.
+ * @returns The length of a field if found or 0
+ */
+declare const getLength: (config: any, data: any) => any;
+export default getLength;

package/dist/utils/Operate/index.d.ts

@@ -0,0 +1,4 @@
+declare const Operate: {
+    runPageOperations: (config: any, data: any, onChange: any) => any;
+};
+export default Operate;

package/dist/utils/Operate/persistValueInFormData.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Simple operation to call the page's onChange handler with a specific value
+ * and name. Supports getting a value from an interpolated field string.
+ * @param {object} config The operation config.
+ * @param {object} data The page's formData.
+ * @param {function} onChange The page's onChange handler.
+ */
+declare const persistValueInFormData: (config: any, data: any, onChange: any) => void;
+export default persistValueInFormData;

package/dist/utils/Operate/runPageOperations.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Run operations, specified in a page's config, on formData.
+ *
+ * The result of an operation will be placed in data according
+ * to the operations 'output' string. This string is a dot
+ * separated fieldId. If any part of the output doesn't exist,
+ * then it is created.
+ *
+ * The page's onChange handler is passed in here in case any
+ * operation needs to persist its value within formData. Normally
+ * any operation result only lasts until the page is re-rendered.
+ *
+ * @param {object} config The config for the page.
+ * @param {object} data The page's formData.
+ * @param {function} onChange The page's onChange handler.
+ * @returns data with the results of any operations included.
+ */
+declare const runPageOperations: (config: any, data: any, onChange: any) => any;
+export default runPageOperations;

package/dist/utils/Operate/setValueInFormData.d.ts

@@ -0,0 +1,2 @@
+declare const setValueInFormData: (config: any, data: any) => any;
+export default setValueInFormData;

package/dist/utils/Operate/shouldRun.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Checks whether or not a page operation should run
+ * based on the provided run_when config.
+ * @param {object} config The run_when config.
+ * @param {object} data The page's formData.
+ * @returns
+ */
+declare const shouldRun: (config: any, data: any) => boolean;
+export default shouldRun;

package/dist/utils/Validate/additional/conditionallyPermittedChange.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Additional validator to not permit a value change if a specified item exists in formData.
+ * @param {object} data the changed value
+ * @param {object} config the config for the validation must contain
+ * a property 'base' holding the value for checking
+ * a property 'check' holding the formData item name to check if exists
+ * @param {object} formData the form data
+ * @returns false if:
+ * the 'base' value is not the same as the changed value AND
+ * the 'check' value exists in formData as an item
+ * otherwise returns true
+ */
+declare const conditionallyPermittedChange: (data: any, config: any, _: any, formData: any) => boolean;
+export default conditionallyPermittedChange;

package/dist/utils/Validate/additional/conditionallyRequired.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Additional validator for the Container component type.
+ * @param {object} data the form data
+ * @param {object} config the config for the validation, must contain a property 'base' with the id of the conditionally required component and
+ * a property 'check' which if the corresponding component has a value will turn off the required check for 'base'
+ * @param {object} component the container component
+ * @returns true if the user has entered data into the 'base' field or entered a value into the 'check' field to turn off the validation
+ * otherwise returns false
+ */
+declare const conditionallyRequired: (data: any, config: any, component: any) => boolean;
+export default conditionallyRequired;

package/dist/utils/Validate/additional/index.d.ts

@@ -0,0 +1,2 @@
+declare const runAdditionalComponentValidation: (component: any, value: any, formData: any) => undefined;
+export default runAdditionalComponentValidation;

package/dist/utils/Validate/additional/mustBeAfter.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Checks that a date is after either:
+ *  - A specified, fixed date.
+ *  Or
+ *  - An offset to the current date in days/months/years.
+ *
+ * @param {string} date - date string in a valid date format e.g. DD-MM-YYYY
+ * @param {string} config.date - fixed date string that date must be after, in the format DD-MM-YYYY
+ * @param {string} config.unit - day, month or year
+ * @param {number} config.value - number of the unit to be after
+ * @returns false if date is not after the given date/offset or true if it is.
+ */
+declare const mustBeAfter: (date: any, config: any) => boolean;
+export default mustBeAfter;

package/dist/utils/Validate/additional/mustBeBefore.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Checks that a date is before either:
+ *  - A specified, fixed date.
+ *  Or
+ *  - An offset to the current date in days/months/years.
+ *
+ * @param {string} date - date string in a valid date format e.g. DD-MM-YYYY
+ * @param {string} config.date - fixed date string that date must be before, in the format DD-MM-YYYY
+ * @param {string} config.unit - day, month or year
+ * @param {number} config.value - number of the unit to be before
+ * @returns false if date is not before the given date/offset or true if it is.
+ */
+declare const mustBeBefore: (date: any, config: any) => boolean;
+export default mustBeBefore;

package/dist/utils/Validate/additional/mustBeEarlierDateTime.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Checks whether the combination of a given date & time input is in the past.
+ * NOTE: This additional validation will only work for containers. They get the
+ * date & time from their children - if there's an error then it can be displayed
+ * by wrapping both components.
+ *
+ * @param {object} data A page's formData.
+ * @param {object} config An additionalValidation config obj.
+ * @param {object} container A config obj for a container.
+ * @returns True if the date & time are in the past, or there are errors with
+ * the individual components. False if the date & time is in the future, or
+ * the date/time component can't be found.
+ */
+declare const mustBeEarlierDateTime: (data: any, config: any, container: any) => boolean;
+export default mustBeEarlierDateTime;

package/dist/utils/Validate/additional/mustBeGreaterThan.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @param {*} value - the value to check.
+ * @param {number} config.value - the value must be greater than config.value.
+ * @returns true if value is greater than config.value, false if not.
+ */
+declare const mustBeGreaterThan: (value: any, config: any) => boolean;
+export default mustBeGreaterThan;

package/dist/utils/Validate/additional/mustBeInTheFuture.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Function returns true if the date parameter is a date after today, else returns false
+ * @param {string} date - date string e.g. '03-12-2021'
+ * @param {boolean} config.todayAllowed - true if today should be a valid date
+ * @returns true if date is after current date
+ */
+declare const mustBeInTheFuture: (date: any, config: any) => boolean;
+export default mustBeInTheFuture;

package/dist/utils/Validate/additional/mustBeInThePast.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Function returns true if the date parameter is a date before today, else returns false
+ * dayjs counts today as before today so also cover same day inputs
+ * @param {string} date - date string e.g. '03-12-2021'
+ * @param {boolean} config.todayAllowed - true if today should be a valid date
+ * @returns true if date is before current date
+ */
+declare const mustBeInThePast: (date: any, config: any) => boolean;
+export default mustBeInThePast;

package/dist/utils/Validate/additional/mustBeLessThan.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @param {*} value - the value to check.
+ * @param {number} config.value - the value must be equal or less than config.value.
+ * @returns true if value is equal to or less then config.value, false if not.
+ */
+declare const mustBeLessThan: (value: any, config: any) => boolean;
+export default mustBeLessThan;

package/dist/utils/Validate/additional/mustBeLongerThan.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Function returns true if the string parameter is longer than a given length, false
+ * if it is not.
+ * @param {string} string - the string to check the length of.
+ * @param {number} config.value - the length that string.length must be greater than.
+ * @returns true if string.length is greater than config.value, false if not.
+ */
+declare const mustBeLongerThan: (string: any, config: any) => boolean;
+export default mustBeLongerThan;

package/dist/utils/Validate/additional/mustBeNumbersOnly.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Checks if a string contains only numberical characters.
+ * An optional flag in config can be used to allow commas.
+ * @param {*} value The value to check for only numerical characters.
+ * @param {object} config The config of the validation check.
+ * @returns true if value passes the regex, false if not.
+ */
+declare const mustBeNumbersOnly: (value: any, config: any) => boolean;
+export default mustBeNumbersOnly;

package/dist/utils/Validate/additional/mustBeOneOf.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Function returns true if the string parameter is contained in the passed in array.
+ * @param {string} string - the string to check.
+ * @param {array} config.array - the array that the string will be checked against.
+ * @returns true if string is contained in config.array, false if not.
+ */
+declare const mustBeOneOf: (string: any, config: any) => any;
+export default mustBeOneOf;

package/dist/utils/Validate/additional/mustBeShorterThan.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Function returns true if the string parameter is shorter than a given length, false
+ * if it is not.
+ * @param {string} string - the string to check the length of.
+ * @param {number} config.value - the length that string.length must be less than.
+ * @returns true if string.length is greater than config.value, false if not.
+ */
+declare const mustBeShorterThan: (string: any, config: any) => boolean;
+export default mustBeShorterThan;

package/dist/utils/Validate/additional/mustBeUniqueInCollection.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @param {*} value - the value to check.
+ * @param {string} config.collectionPath - the path to the collection within formData
+ * @param {string} config.caseInsensitive - true to ignore case, assumes string values
+ * @param {object} component - the component definition
+ * @param {object} formData - the current form data
+ * @returns true if components value is not the same in any other entry in the collection
+ */
+declare const mustBeUniqueInCollection: (value: any, config: any, component: any, formData: any) => boolean;
+export default mustBeUniqueInCollection;

package/dist/utils/Validate/additional/mustEnterAtLeastOne.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Additional validator for the Container component type.
+ * @param {*} data the form data
+ * @param {*} component the container component
+ * @returns true if the user has entered data into at least one component within the collection
+ * otherwise returns false
+ */
+declare const mustEnterAtLeastOne: (data: any, _: any, component: any) => any;
+export default mustEnterAtLeastOne;

package/dist/utils/Validate/additional/mustHaveLessThanDecimalPlaces.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @param {string} string - the string to check
+ * @param {number} config.maxDecimals - the maximum amount of decimal places to allow
+ * @returns true if string has less than maxDecimals decimal places else returns false
+ */
+declare const mustHaveLessThanDecimalPlaces: (string: any, config: any) => boolean;
+export default mustHaveLessThanDecimalPlaces;

package/dist/utils/Validate/additional/mustNotContainSql.d.ts

@@ -0,0 +1,2 @@
+declare const mustNotContainSql: (value: any) => boolean;
+export default mustNotContainSql;

package/dist/utils/Validate/additional/mustSelectOnlyOne.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Additional validator for the Container component type.
+ * @param {object} data the form data
+ * @param {object} component the container component
+ * @returns true if the user has only provided a value for one of the components in the container, otherwise false.
+ */
+declare const mustSelectOnlyOne: (data: any, _: any, component: any) => boolean;
+export default mustSelectOnlyOne;

package/dist/utils/Validate/additional/utils.d.ts

@@ -0,0 +1,4 @@
+declare const formatString: (date: any) => string;
+declare const formattedTime: (time: any) => string;
+declare const DATE_FORMAT = "DD-MM-YYYY";
+export { DATE_FORMAT, formatString, formattedTime };

package/dist/utils/Validate/index.d.ts

@@ -0,0 +1,42 @@
+declare const Validate: {
+    component: (component: any, outerData: any, formData: any) => any[] | {
+        id: any;
+        error: never;
+    } | {
+        id: any;
+        error: any;
+        properties: {} | undefined;
+    } | undefined;
+    container: (container: any, outerData: any, formData: any) => any[] | {
+        id: any;
+        error: never;
+    };
+    email: (value: any, label?: string, customErrors?: never[]) => any;
+    date: (date: any) => {
+        message: undefined;
+        propsInError: undefined;
+    } | {
+        message: string;
+        propsInError: {};
+    } | {
+        message: string;
+        propsInError: {
+            day: boolean;
+            month: boolean;
+            year: boolean;
+        };
+    };
+    multifile: (value: any, customErrors: any) => any;
+    page: (page: any, queuedErrors?: never[]) => any;
+    regex: (value: any, label: any, pattern: any, customErrors: any) => any;
+    required: (value: any, label: any, customErrors: any) => any;
+    textarea: (label: any, value: any, showCharacterCount: any, customErrors: any, required: any, maxLength?: number) => any;
+    time: (time: any) => {
+        message: undefined;
+        propsInError: undefined;
+    } | {
+        message: string;
+        propsInError: {};
+    };
+};
+export default Validate;

package/dist/utils/Validate/validateCollection.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Validates all of the items within a collection.
+ * @param {object} collection The collection to validate.
+ * @param {object} items The data items in the collection.
+ * @param {object} formData The data at the top level of the form.
+ * @returns Errors for all components for all items within the collection.
+ */
+declare const validateCollection: (collection: any, items: any, formData: any) => any[];
+export default validateCollection;

package/dist/utils/Validate/validateComponent.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Validates a single component.
+ * @param {object} component The component to validate.
+ * @param {object} outerData The data to use that holds this component's value.
+ * @param {object} formData The data at the top level of the form.
+ * @returns The first encountered error with the component.
+ */
+declare const validateComponent: (component: any, outerData: any, formData: any) => any[] | {
+    id: any;
+    error: never;
+} | {
+    id: any;
+    error: any;
+    properties: {} | undefined;
+} | undefined;
+export default validateComponent;

package/dist/utils/Validate/validateContainer.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Validates all components within a container.
+ * @param {object} container The container to validate.
+ * @param {object} outerData The data to use that holds this component's value.
+ * @param {object} formData The data at the top level of the form.
+ * @returns Errors for all components within the container.
+ */
+declare const validateContainer: (container: any, outerData: any, formData: any) => any[] | {
+    id: any;
+    error: never;
+};
+export default validateContainer;

package/dist/utils/Validate/validateDate.d.ts

@@ -0,0 +1,29 @@
+declare const maxMonthDays: (month: any, year: any) => 29 | 28 | 30 | 31;
+export { maxMonthDays };
+/**
+ * Checks if a date passed is a valid date.
+ * This will validate for 'leap years', missing components, invalid day, month or year components.
+ * EXAMPLE USE : const { message, propsInError } = validateDate('2-11-2020')
+ *
+ * Note that an empty string is not considered invalid. You should use
+ * validateRequired (Validate.required) for that sort of validation.
+ *
+ * @param {string} date  date as a string
+ * @returns an object with an error message and instructions for which parts of the date are in error
+ * or undefined for both if the date is valid
+ */
+declare const validateDate: (date: any) => {
+    message: undefined;
+    propsInError: undefined;
+} | {
+    message: string;
+    propsInError: {};
+} | {
+    message: string;
+    propsInError: {
+        day: boolean;
+        month: boolean;
+        year: boolean;
+    };
+};
+export default validateDate;

package/dist/utils/Validate/validateEmail.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Validates an email address, ensuring it is in the correct domain and
+ * complies with the Home Office email address standards.
+ *
+ * Note that an empty string is not considered invalid. You should use
+ * validateRequired (Validate.required) for that sort of validation.
+ * @param {*} value The value to validate.
+ * @param {string} label The label to use in any error message.
+ * @param {array} customErrors The array of custom errors to use for format message.
+ * @returns An error if the email address is invalid.
+ */
+declare const validateEmail: (value: any, label?: string, customErrors?: never[]) => any;
+export default validateEmail;

package/dist/utils/Validate/validateMultifile.d.ts

@@ -0,0 +1,3 @@
+export declare const DEFAULT_ERROR = "Invalid files must be deleted";
+declare const validateMultifile: (value: any, customErrors: any) => any;
+export default validateMultifile;

package/dist/utils/Validate/validateOnPageLoad.d.ts

@@ -0,0 +1 @@
+export declare const doValidateOnPageLoad: (page: any) => boolean;

package/dist/utils/Validate/validatePage.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Validate all of the components on a page.
+ * @param {object} page The page to validate
+ * @param {array} queuedErrors Any errors that have been found before this validation.
+ * @returns An array containing all of the errors.
+ */
+declare const validatePage: (page: any, queuedErrors?: never[]) => any;
+export default validatePage;

package/dist/utils/Validate/validateRegex.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Validates an components value against a given regex pattern.
+ *
+ * An empty string for value is considered valid as not all components
+ * with pattern validation have to be required.
+ * @param {*} value The value to validate.
+ * @param {string} label The label to use in the default error message.
+ * @param {string} pattern The regex pattern to validate against.
+ * @param {array} customErrors The array of custom errors for the component.
+ * @returns An error if the value doesn't match the regex pattern.
+ */
+declare const validateRegex: (value: any, label: any, pattern: any, customErrors: any) => any;
+export default validateRegex;

package/dist/utils/Validate/validateRequired.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Validates that a value is not nullish, which includes ensuring
+ * a string isn't just whitespace, an array is not empty, etc.
+ * @param {any} value The value to validate.
+ * @param {string} label The label to use in any error message.
+ * @returns An error if the value is nullish.
+ */
+declare const validateRequired: (value: any, label: any, customErrors: any) => any;
+export default validateRequired;

package/dist/utils/Validate/validateTextArea.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Validates a text area when showCharacterCount property has been set.
+ *
+ * @param {string} label The label to use in any error message.
+ * @param {*} value The value to validate.
+ * @param {string} showCharacterCount The flag to enable character count validation.
+ * @param {array} customErrors An array of custom errors for the component.
+ * @param {boolean} required If the component is required.
+ * @param {number} maxLength The maximum allowable number of characters (by default, this is 1000 characters).
+ * @returns An error if the value exceeds the maximum allowable number of characters.
+ */
+declare const validateTextArea: (label: any, value: any, showCharacterCount: any, customErrors: any, required: any, maxLength?: number) => any;
+export default validateTextArea;

package/dist/utils/Validate/validateTime.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Checks if a time passed is a valid time.
+ * This will validate for missing components, invalid hour or minute components.
+ * EXAMPLE USE : const { message, propsInError } = validateTime('15:30')
+ *
+ * Note that an empty string is not considered invalid. You should use
+ * validateRequired (Validate.required) for that sort of validation.
+ *
+ * @param {string} time time as a string
+ * @returns an object with an error message and instructions for which parts of the time are in error
+ * or undefined for both if the time is valid
+ */
+declare const validateTime: (time: any) => {
+    message: undefined;
+    propsInError: undefined;
+} | {
+    message: string;
+    propsInError: {};
+};
+export default validateTime;

package/dist/utils/canOverrideFieldRequired.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Check to see if the field required status can be overridden.
+ * All conditions need to be met in order for the override to be permitted.
+ * @param {array} requiredOverrideConditions The conditions to evaluate.
+ * @param {object} data The form data to check.
+ * @returns true or false.
+ */
+declare const canOverrideFieldRequired: (requiredOverrideConditions: any, data: any) => boolean;
+export default canOverrideFieldRequired;