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

package/dist/models/CollectionLabels.d.ts

@@ -0,0 +1,7 @@
+declare const CollectionLabels: {
+    add: string;
+    remove: string;
+    change: string;
+    item: string;
+};
+export default CollectionLabels;

package/dist/models/ComponentTypes.d.ts

@@ -0,0 +1,27 @@
+declare const ComponentTypes: {
+    ALERT: string;
+    AUTOCOMPLETE: string;
+    CALCULATION: string;
+    CHECKBOXES: string;
+    COLLECTION: string;
+    COLLECTION_SUMMARY: string;
+    CONTAINER: string;
+    DATE: string;
+    DETAILS: string;
+    EMAIL: string;
+    FILE: string;
+    HEADING: string;
+    HTML: string;
+    INSET_TEXT: string;
+    LIST: string;
+    MULTI_FILE: string;
+    PARAGRAPH: string;
+    PHONE_NUMBER: string;
+    RADIOS: string;
+    SELECT: string;
+    TEXT: string;
+    TEXT_AREA: string;
+    TIME: string;
+    WARNING: string;
+};
+export default ComponentTypes;

package/dist/models/EventTypes.d.ts

@@ -0,0 +1,6 @@
+declare const EventTypes: {
+    BLUR: string;
+    SUBMIT: string;
+    CANCEL: string;
+};
+export default EventTypes;

package/dist/models/FormPages.d.ts

@@ -0,0 +1,6 @@
+declare const FormPages: {
+    CYA: string;
+    HUB: string;
+    PARTIAL_CYA: string;
+};
+export default FormPages;

package/dist/models/FormTypes.d.ts

@@ -0,0 +1,10 @@
+declare const FormTypes: {
+    CYA: string;
+    FORM: string;
+    FORM_WITH_TASK: string;
+    HUB: string;
+    TASK: string;
+    TASK_CYA: string;
+    WIZARD: string;
+};
+export default FormTypes;

package/dist/models/HubFormats.d.ts

@@ -0,0 +1,5 @@
+declare const HubFormats: {
+    CYA: string;
+    TASK: string;
+};
+export default HubFormats;

package/dist/models/PageAction.d.ts

@@ -0,0 +1,89 @@
+export declare const PageActionTypes: {
+    CANCEL: string;
+    COLLECTION_ADD: string;
+    COLLECTION_DUPLICATE: string;
+    COLLECTION_REMOVE: string;
+    NAVIGATE: string;
+    SAVE_AND_CONTINUE: string;
+    SAVE_AND_NAVIGATE: string;
+    SAVE_AND_RETURN: string;
+    SUBMIT: string;
+};
+export declare const DefaultPageActions: {
+    cancel: {
+        type: string;
+        validate: boolean;
+        label: string;
+        classModifiers: string;
+    };
+    collectionAdd: undefined;
+    collectionDuplicate: undefined;
+    collectionRemove: undefined;
+    navigate: undefined;
+    saveAndContinue: {
+        type: string;
+        validate: boolean;
+        label: string;
+    };
+    saveAndNavigate: {
+        type: string;
+        validate: boolean;
+        label: string;
+    };
+    saveAndReturn: {
+        type: string;
+        validate: boolean;
+        label: string;
+        classModifiers: string;
+    };
+    submit: {
+        type: string;
+        validate: boolean;
+    };
+};
+declare const PageAction: {
+    TYPES: {
+        CANCEL: string;
+        COLLECTION_ADD: string;
+        COLLECTION_DUPLICATE: string;
+        COLLECTION_REMOVE: string;
+        NAVIGATE: string;
+        SAVE_AND_CONTINUE: string;
+        SAVE_AND_NAVIGATE: string;
+        SAVE_AND_RETURN: string;
+        SUBMIT: string;
+    };
+    DEFAULTS: {
+        cancel: {
+            type: string;
+            validate: boolean;
+            label: string;
+            classModifiers: string;
+        };
+        collectionAdd: undefined;
+        collectionDuplicate: undefined;
+        collectionRemove: undefined;
+        navigate: undefined;
+        saveAndContinue: {
+            type: string;
+            validate: boolean;
+            label: string;
+        };
+        saveAndNavigate: {
+            type: string;
+            validate: boolean;
+            label: string;
+        };
+        saveAndReturn: {
+            type: string;
+            validate: boolean;
+            label: string;
+            classModifiers: string;
+        };
+        submit: {
+            type: string;
+            validate: boolean;
+        };
+    };
+};
+export default PageAction;

package/dist/models/TaskStates.d.ts

@@ -0,0 +1,39 @@
+export declare const StateTypes: {
+    COMPLETE: string;
+    IN_PROGRESS: string;
+    NOT_STARTED: string;
+    CANNOT_START_YET: string;
+    SKIPPED: string;
+};
+declare const TaskStates: {
+    TYPES: {
+        COMPLETE: string;
+        IN_PROGRESS: string;
+        NOT_STARTED: string;
+        CANNOT_START_YET: string;
+        SKIPPED: string;
+    };
+    DETAILS: {
+        complete: {
+            label: string;
+            colour: string;
+        };
+        inProgress: {
+            label: string;
+            colour: string;
+        };
+        notStarted: {
+            label: string;
+            colour: string;
+        };
+        cannotStartYet: {
+            label: string;
+            colour: string;
+        };
+        skipped: {
+            label: string;
+            colour: string;
+        };
+    };
+};
+export default TaskStates;

package/dist/models/index.d.ts

@@ -0,0 +1,143 @@
+import { default as CollectionLabels } from './CollectionLabels';
+import { default as ComponentTypes } from './ComponentTypes';
+import { default as EventTypes } from './EventTypes';
+import { default as FormPages } from './FormPages';
+import { default as FormTypes } from './FormTypes';
+import { default as HubFormats } from './HubFormats';
+import { default as PageAction } from './PageAction';
+import { default as TaskStates } from './TaskStates';
+declare const Models: {
+    CollectionLabels: {
+        add: string;
+        remove: string;
+        change: string;
+        item: string;
+    };
+    ComponentTypes: {
+        ALERT: string;
+        AUTOCOMPLETE: string;
+        CALCULATION: string;
+        CHECKBOXES: string;
+        COLLECTION: string;
+        COLLECTION_SUMMARY: string;
+        CONTAINER: string;
+        DATE: string;
+        DETAILS: string;
+        EMAIL: string;
+        FILE: string;
+        HEADING: string;
+        HTML: string;
+        INSET_TEXT: string;
+        LIST: string;
+        MULTI_FILE: string;
+        PARAGRAPH: string;
+        PHONE_NUMBER: string;
+        RADIOS: string;
+        SELECT: string;
+        TEXT: string;
+        TEXT_AREA: string;
+        TIME: string;
+        WARNING: string;
+    };
+    EventTypes: {
+        BLUR: string;
+        SUBMIT: string;
+        CANCEL: string;
+    };
+    FormPages: {
+        CYA: string;
+        HUB: string;
+        PARTIAL_CYA: string;
+    };
+    FormTypes: {
+        CYA: string;
+        FORM: string;
+        FORM_WITH_TASK: string;
+        HUB: string;
+        TASK: string;
+        TASK_CYA: string;
+        WIZARD: string;
+    };
+    HubFormats: {
+        CYA: string;
+        TASK: string;
+    };
+    PageAction: {
+        TYPES: {
+            CANCEL: string;
+            COLLECTION_ADD: string;
+            COLLECTION_DUPLICATE: string;
+            COLLECTION_REMOVE: string;
+            NAVIGATE: string;
+            SAVE_AND_CONTINUE: string;
+            SAVE_AND_NAVIGATE: string;
+            SAVE_AND_RETURN: string;
+            SUBMIT: string;
+        };
+        DEFAULTS: {
+            cancel: {
+                type: string;
+                validate: boolean;
+                label: string;
+                classModifiers: string;
+            };
+            collectionAdd: undefined;
+            collectionDuplicate: undefined;
+            collectionRemove: undefined;
+            navigate: undefined;
+            saveAndContinue: {
+                type: string;
+                validate: boolean;
+                label: string;
+            };
+            saveAndNavigate: {
+                type: string;
+                validate: boolean;
+                label: string;
+            };
+            saveAndReturn: {
+                type: string;
+                validate: boolean;
+                label: string;
+                classModifiers: string;
+            };
+            submit: {
+                type: string;
+                validate: boolean;
+            };
+        };
+    };
+    TaskStates: {
+        TYPES: {
+            COMPLETE: string;
+            IN_PROGRESS: string;
+            NOT_STARTED: string;
+            CANNOT_START_YET: string;
+            SKIPPED: string;
+        };
+        DETAILS: {
+            complete: {
+                label: string;
+                colour: string;
+            };
+            inProgress: {
+                label: string;
+                colour: string;
+            };
+            notStarted: {
+                label: string;
+                colour: string;
+            };
+            cannotStartYet: {
+                label: string;
+                colour: string;
+            };
+            skipped: {
+                label: string;
+                colour: string;
+            };
+        };
+    };
+};
+export { CollectionLabels, ComponentTypes, EventTypes, FormPages, FormTypes, HubFormats, PageAction, TaskStates };
+export default Models;

package/dist/setupTests.d.ts

@@ -0,0 +1,14 @@
+import { RenderOptions } from '@testing-library/react';
+import { ReactNode } from 'react';
+import { Container } from 'react-dom/client';
+import { HooksContextProvider } from './context';
+import * as React from 'react';
+type RenderOptionsWithHooks = RenderOptions & {
+    hooks: React.ComponentProps<typeof HooksContextProvider>["overrides"];
+};
+export declare const renderWithValidation: (ui: ReactNode, options: RenderOptionsWithHooks) => import('@testing-library/react').RenderResult<typeof import("@testing-library/dom/types/queries"), HTMLElement, HTMLElement>;
+export declare const rerenderWithValidation: (rerenderCallback: (children: ReactNode, options: RenderOptionsWithHooks) => void, ui: ReactNode, options: RenderOptionsWithHooks) => void;
+export declare const renderDomWithValidation: (ui: ReactNode, container: Container, options: RenderOptionsWithHooks) => void;
+export declare const renderHookWithProvider: (hook: Function, options: RenderOptionsWithHooks) => import('@testing-library/react').RenderHookResult<any, unknown>;
+export declare const expectObjectLike: <T extends Record<string, unknown>, P extends Partial<T>>(received: T, expected: P) => void;
+export {};

package/dist/utils/CheckYourAnswers/getCYAAction.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Gets an action object, configured appropriately for a Check your answers component.
+ *
+ * @param {boolean} readonly Whether or not the component is readonly.
+ * @param {object} page A configuration object for the page to link to.
+ * @param {Function} onAction A function to invoke if the link is clicked.
+ *
+ * @returns An action object for a Check your answers row.
+ * @description
+ * `cya_link.href` and `cya_link.url` have been deprecated in favour of `cya_link.page` but this
+ * method will convert both by taking the final part of the relative path:
+ * - `href: '/bravo'` => `page: 'bravo'`
+ */
+declare const getCYAAction: (readonly: any, page: any, onAction: any) => {
+    page: any;
+    label: any;
+    aria_suffix: any;
+    onAction: any;
+} | null;
+export default getCYAAction;

package/dist/utils/CheckYourAnswers/getCYACollectionChangeAction.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Gets an action object that triggers editing of an entry in a page collection.
+ *
+ * @param {object} page The page that the action belongs to.
+ * @param {object} item The item in the collection that is to be edited.
+ * @param {function} onAction The onAction callback passed in to the CYA page from FormRenderer.
+ * @param {string} labelCount The item's index in the collection plus one (for displaying to the user).
+ * @param {object} action The action's config from the form definition.
+ * @param {array} activeIds A list of active Ids that must be set to make Item the active entry.
+ * @returns The resulting action object.
+ */
+declare const getCYACollectionChangeAction: (page: any, item: any, onAction: any, labelCount: any, action: any, activeIds?: {}) => {
+    pageId: any;
+    fieldId: string;
+    key: string;
+    type: string;
+    action: {
+        onAction: (row: any) => void;
+        label: string;
+    };
+};
+export default getCYACollectionChangeAction;

package/dist/utils/CheckYourAnswers/getCYACollectionDeleteAction.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Gets an action object that triggers the removal of an item from a page Collection.
+ *
+ * @param {object} page The page that the action belongs to.
+ * @param {object} item The item in the collection that is being removed.
+ * @param {function} onAction The onAction callback passed in to the CYA page from FormRenderer.
+ * @param {string} labelCount The item's index in the collection plus one (for displaying to the user).
+ * @param {object} action The action's config from the form definition.
+ * @param {array} activeIds A list of active Ids that must be set to make Item the active entry.
+ * @returns The resulting action object.
+ */
+declare const getCYACollectionDeleteAction: (page: any, item: any, onAction: any, labelCount: any, action: any, activeIds: any) => {
+    pageId: any;
+    fieldId: string;
+    key: string;
+    type: string;
+    action: {
+        onAction: () => void;
+        label: string;
+    };
+};
+export default getCYACollectionDeleteAction;

package/dist/utils/CheckYourAnswers/getCYARow.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Gets a row object, configured appropriately for a Check your answers component.
+ *
+ * @param {object} page The page to which this component row belongs.
+ * @param {object} component The component to render on this row.
+ * @param {Function} onAction A function to invoke if the change link is clicked.
+ *
+ * @returns A configuration object for a Check your answers row.
+ */
+declare const getCYARow: (page: any, component: any, onAction: any) => {
+    pageId: any;
+    id: any;
+    fieldId: any;
+    full_path: any;
+    key: string;
+    required: any;
+    component: any;
+    value: string;
+    action: {
+        page: any;
+        label: any;
+        aria_suffix: any;
+        onAction: any;
+    } | null;
+};
+export default getCYARow;

package/dist/utils/CheckYourAnswers/getCYARowForGroup.d.ts

@@ -0,0 +1,17 @@
+declare const getCYARowForGroup: (page: any, group: any, rows: any, onAction: any) => {
+    row: {
+        pageId: any;
+        fieldId: any;
+        key: any;
+        required: any;
+        value: import("react/jsx-runtime").JSX.Element;
+        action: {
+            page: any;
+            label: any;
+            aria_suffix: any;
+            onAction: any;
+        } | null;
+    };
+    insertAt: number;
+};
+export default getCYARowForGroup;

package/dist/utils/CheckYourAnswers/getCYARowsForCollection.d.ts

@@ -0,0 +1,2 @@
+declare const getCYARowsForCollection: (page: any, collection: any, items: any, onAction: any, fnOverride: any) => any;
+export default getCYARowsForCollection;

package/dist/utils/CheckYourAnswers/getCYARowsForCollectionPage.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Get the CYA rows for a collection's master page.
+ *
+ * @param {Object} page The master page object.
+ * @param {Object} data The data at this master page's level.
+ * @param {Function} onAction The onAction callback passed in from FormRenderer.
+ * @param {Function} fnOverride Function used to override the creation of container rows.
+ * @param {Object} activeIds The active IDs that must be set for the current item to be active.
+ * @returns An array of CYA rows.
+ */
+declare const getCYARowsForCollectionPage: (page: any, onAction: any, fnOverride: any, data: any, activeIds?: {}) => {
+    pageId: any;
+    fieldId: string;
+    full_path: string;
+    key: any;
+    type: string;
+    size: any;
+    action: {
+        onAction: any;
+        label: string;
+    } | null;
+}[];
+export default getCYARowsForCollectionPage;

package/dist/utils/CheckYourAnswers/getCYARowsForContainer.d.ts

@@ -0,0 +1,2 @@
+declare const getCYARowsForContainer: (page: any, container: any, formData: any, onAction: any, fnOverride: any) => any;
+export default getCYARowsForContainer;

package/dist/utils/CheckYourAnswers/getCYARowsForPage.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Gets an array of row objects, each configured appropriately for a Check your answers component.
+ *
+ * @param {object} page The page to show components for.
+ * @param {Function} onAction A function to invoke if the change link on any row is clicked.
+ * @param {Function} fnOverride An optional override for getting the CYA rows for each component.
+ *
+ * @returns An array of configuration objects for Check your answers rows.
+ */
+declare const getCYARowsForPage: (page: any, onAction: any, fnOverride?: null) => any[];
+export default getCYARowsForPage;

package/dist/utils/CheckYourAnswers/getSummaryListRowForDetails.d.ts

@@ -0,0 +1,3 @@
+import { Utils } from '@ukhomeoffice/cop-react-components';
+declare const getSummaryListRowForDetails: (page: any, component: any, customClasses: ReturnType<typeof Utils.classBuilder>, entryData: any, optionalFieldPlaceholder: any) => import("react/jsx-runtime").JSX.Element;
+export default getSummaryListRowForDetails;

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

@@ -0,0 +1,5 @@
+declare const CheckYourAnswers: {
+    getRows: (page: any, onAction: any, fnOverride?: null) => any[];
+    getCYARowsForContainer: (page: any, container: any, formData: any, onAction: any, fnOverride: any) => any;
+};
+export default CheckYourAnswers;

package/dist/utils/CheckYourAnswers/showComponentCYA.d.ts

@@ -0,0 +1,11 @@
+export declare const EXCLUDE_FROM_CYA: string[];
+/**
+ * Determines whether a given component should display on the Check your answers screen.
+ *
+ * @param {object} options The component options.
+ * @param {object} data The data contained on the form.
+ *
+ * @returns A boolean true if the component should show; otherwise false.
+ */
+declare const showComponentCYA: (options: any, data: any) => any;
+export default showComponentCYA;

package/dist/utils/CollectionPage/addCollectionPageEntry.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This function effectively adds a new entry to a page collection by
+ * invalidating the current active ID for that collection.
+ *
+ * An invalid active ID for a collection causes a new entry to be created
+ * the next time an onChange is triggered for that page. See PageCollection.jsx.
+ *
+ * @param {string} collectionName The name of the collection to create the new entry for.
+ * @param {object} formData The top level formData object.
+ */
+declare const addCollectionPageEntry: (collectionName: any, formData: any) => void;
+export default addCollectionPageEntry;

package/dist/utils/CollectionPage/duplicateCollectionPageActiveEntry.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Duplicates the currently active entry in a named collection's data.
+ * Once duplicated, the new entry is set as the active entry.
+ *
+ * This functions supports collectionName being a dot-separated string
+ * in the case of nested page collections.
+ *
+ * @param {string} collectionName The name of the collection.
+ * @param {object} formData A page's form data containing the collection's data.
+ * @return true if the entry ws successfully duplicated, false if not.
+ */
+declare const duplicateCollectionPageActiveEntry: (collectionName: any, formData: any) => string | null;
+export default duplicateCollectionPageActiveEntry;

package/dist/utils/CollectionPage/duplicateCollectionPageEntry.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Duplicates an entry with the given ID in the given collection, optionally
+ * ignoring named fields or adding extras to the duplicate if they're provided.
+ *
+ * @param {string} collectionName The name of the collection the entry to duplicate is in.
+ * @param {object} formData The top-level formData object.
+ * @param {string} entryId The ID of the entry to duplicate.
+ * @param {array} fieldsToIgnore An array of field names that shouldn't be copied to the duplicate.
+ * @param {object} fieldsToAdd An object that will be spread to the new entry.
+ * @returns The ID of the duplicate entry.
+ */
+declare const duplicateCollectionPageEntry: (collectionName: any, formData: any, entryId: any, fieldsToIgnore?: never[], fieldsToAdd?: {}) => string | null;
+export default duplicateCollectionPageEntry;

package/dist/utils/CollectionPage/getCollectionPageActiveId.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Takes the name of a collection and returns its active ID.
+ *
+ * If collectionName is a dot-separated string then this function will
+ * return the active ID for the last collection in that string.
+ *
+ * e.g. A collectionName of people.documents will return documentsActiveId.
+ *
+ * @param {string} collectionName The name of the collection, or dot-separated path.
+ * @param {object} data Top-level formData.
+ * @returns The active ID for the collection, or null if it doesn't exist.
+ */
+declare const getCollectionPageActiveId: (collectionName: any, formData: any) => any;
+export default getCollectionPageActiveId;

package/dist/utils/CollectionPage/getCollectionPageActiveIndex.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Takes the name of a collection and returns its active index.
+ * This function supports collectionName being a dot-separated string
+ * of collection names for nested collections:
+ *
+ * e.g. collectionName being 'flights.people.documents' would return
+ * the active index in the nested documents collection, or null if there
+ * isn't one or the path is broken.
+ *
+ * @param {string} collectionName The name of the collection, or dot-separated path.
+ * @param {object} data Top-level formData.
+ * @returns The active index for the collection, or null if it doesn't exist.
+ */
+declare const getCollectionPageActiveIndex: (collectionName: any, formData: any) => any;
+export default getCollectionPageActiveIndex;

package/dist/utils/CollectionPage/getCollectionPageData.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Takes the name of a collection and returns its active index.
+ * This function supports collectionName being a dot-separated string
+ * of collection names for nested collections:
+ *
+ * e.g. collectionName being 'flights.people.documents' would return
+ * the active index in the nested documents collection, or null if there
+ * isn't one or the path is broken.
+ *
+ * @param {string} collectionName The name of the collection, or dot-separated path.
+ * @param {object} data The top level formData object.
+ * @returns The active index for the collection, or null if it doesn't exist.
+ */
+declare const getCollectionPageData: (collectionName: any, formData: any) => any;
+export default getCollectionPageData;

package/dist/utils/CollectionPage/getErrorsForCollection.d.ts

@@ -0,0 +1,2 @@
+declare const getErrorsForCollection: (config: any, masterPage: any, formData: any, hooks: any, activeIds?: {}) => any[];
+export default getErrorsForCollection;