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

package/dist/components/FormPage/FormPage.d.ts

@@ -0,0 +1,36 @@
+export declare const DEFAULT_CLASS = "hods-form__page";
+interface FormPageProps {
+    classBlock?: string;
+    classModifiers?: string | string[];
+    className?: string;
+    hashLink?: boolean;
+    onAction: Function;
+    onWrapperChange?: Function;
+    onChange?: Function;
+    onTopLevelChange?: Function;
+    page: {
+        id: string;
+        title?: string;
+        titleSize?: string;
+        components: string | object[];
+        fieldset?: boolean;
+        hideOptionalSuffix?: boolean;
+        label?: string;
+        required?: boolean;
+        actions?: object | string[];
+        formData: object;
+        customValidation?: {
+            runWhen: {
+                onLoad?: boolean;
+            };
+            message: string;
+        }[];
+    };
+    pages?: object[];
+    submitting?: boolean;
+    pageId: string;
+}
+/** Renders a page on a form with <Link href="https://ukhomeoffice.github.io/cop-react-components/?path=/docs/d-alert--default-story">COP React components</Link>,
+on the basis of a <Link href="/?path=/docs/json-format-page">JSON</Link> configuration */
+declare const FormPage: ({ page, pages, onAction, onWrapperChange, onTopLevelChange, onChange, hashLink, classBlock, classModifiers, className, submitting, pageId }: FormPageProps) => import("react/jsx-runtime").JSX.Element;
+export default FormPage;

package/dist/components/FormPage/index.d.ts

@@ -0,0 +1,2 @@
+import { default as FormPage } from './FormPage';
+export default FormPage;

package/dist/components/FormRenderer/FormRenderer.d.ts

@@ -0,0 +1,39 @@
+import { FormTypes } from '../../models';
+export interface FormRendererProps {
+    classBlock?: string;
+    classModifiers?: string | string[];
+    className?: string;
+    components: object[];
+    cya?: {
+        actions?: (object | string)[];
+        disableTaskSwitch?: boolean;
+    };
+    data?: {
+        formStatus?: {
+            page?: object;
+        };
+    };
+    hashLink?: boolean;
+    hide_title?: boolean;
+    hooks?: object;
+    hub?: {
+        nonSequential?: boolean;
+        sections?: object[];
+    };
+    newPageId?: string;
+    noChangeAction?: boolean;
+    pages: object[];
+    summaryListClassModifiers?: string | string[];
+    title?: string;
+    titleSize?: string;
+    cleanseHiddenData?: boolean;
+    /** See <a href="/?path=/docs/json-format-form-types#formtypes">FormTypes</a>. */
+    type: typeof FormTypes[keyof typeof FormTypes];
+    viewOnly?: boolean;
+    hideBlankRows?: boolean;
+}
+/** Renders a form with <Link href="https://ukhomeoffice.github.io/cop-react-components/?path=/docs/d-alert--default-story">COP React components</Link>,
+on the basis of a <Link href="/?path=/docs/json-format-form">JSON</Link> that describes which elements are required. */
+declare const FormRenderer: ({ title, titleSize, type, cleanseHiddenData, components, pages, hub, cya, data, hashLink, hooks, classBlock, classModifiers, className, hide_title: hideTitle, summaryListClassModifiers, noChangeAction, newPageId, viewOnly, hideBlankRows }: FormRendererProps) => import("react/jsx-runtime").JSX.Element;
+export declare const DEFAULT_CLASS = "hods-form";
+export default FormRenderer;

package/dist/components/FormRenderer/handlers/cyaAction.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Gets the pageId from the invoked CYA action and calls onChange if it is
+ * different to the currentPageId.
+ * @param {object} page The page on which the CYA action was invoked.
+ * @param {string} currentPageId The current pageId.
+ * @param {Function} onChange The handler to call if the pageId is different to the currentPageId.
+ */
+declare const cyaAction: (page: any, currentPageId: any, onChange: any) => void;
+export default cyaAction;

package/dist/components/FormRenderer/handlers/getPageId.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Gets the pageId from the invoked CYA action.
+ * @param {object} action The invoked action.
+ * @param {string} pageId The id of the page on which the action was invoked.
+ * @returns A page id.
+ */
+declare const getPageId: (action: any, pageId: any) => any;
+export default getPageId;

package/dist/components/FormRenderer/handlers/index.d.ts

@@ -0,0 +1,6 @@
+declare const handlers: {
+    cyaAction: (page: any, currentPageId: any, onChange: any) => void;
+    navigate: (action: any, currentPageId: any, onNavigate: any, state?: undefined) => void;
+    submissionError: (errors: any, onError: any) => void;
+};
+export default handlers;

package/dist/components/FormRenderer/handlers/navigate.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Gets the pageId from the invoked page action and calls onNavigate if it is
+ * different to the currentPageId.
+ * @param {object} action The invoked action.
+ * @param {string} currentPageId The current pageId.
+ * @param {Function} onNavigate The handler to call if the pageId is different to the currentPageId.
+ * @param {object|undefined} state State to pass to the handler on change
+ */
+declare const navigate: (action: any, currentPageId: any, onNavigate: any, state?: undefined) => void;
+export default navigate;

package/dist/components/FormRenderer/handlers/submissionError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Formats back-end errors and invokes an onError handler.
+ * @param {Array} errors The errors returned by the backend when submitting.
+ * @param {Function} onError The handler to call with the formatted errors.
+ */
+declare const submissionError: (errors: any, onError: any) => void;
+export default submissionError;

package/dist/components/FormRenderer/helpers/canActionProceed.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Assesses whether the action can proceed when navigating, submitting, etc.
+ * Presently, this will validate a page when submitting and, only if the page is
+ * valid will it proceed. If it's simple navigation, it simply returns true.
+ * @param {object} action The action object we're assessing.
+ * @param {object} page The page configuration object this action relates to.
+ * @param {Function} pageValidator A function to validate the page.
+ * @param {Array} errors An array of existing errors.
+ * @returns A boolean where `true` means the action can proceed and `false` means it cannot.
+ */
+declare const canActionProceed: (action: any, page: any, pageValidator: any, errors: any) => boolean;
+export default canActionProceed;

package/dist/components/FormRenderer/helpers/canCYASubmit.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Assesses whether the CYA screen can submit.
+ * Presently, this will validate all of the form pages and, only if all pages are
+ * valid will it proceed.
+ * @param {Array} pages All of the pages contained within the form.
+ * @param {Function} pagesValidator A function to validate the page.
+ * @returns A boolean where `true` means the CYA can submit and `false` means it cannot.
+ */
+declare const canCYASubmit: (pages: any, pagesValidator: any) => boolean;
+export default canCYASubmit;

package/dist/components/FormRenderer/helpers/cleanHiddenNestedData.d.ts

@@ -0,0 +1,2 @@
+declare const cleanHiddenNestedData: (patch: any, page: any) => any;
+export default cleanHiddenNestedData;

package/dist/components/FormRenderer/helpers/clearOutUncompletedRoutes.d.ts

@@ -0,0 +1,51 @@
+/**
+ *
+ * The purpose of this function is to apply the show_when rules defined in the form specification to the
+ * form payload (formData), and remove any data that should not be shown according to those rules.
+ * (the reason this data exists in the payload is that users can answer a question in such a way that
+ * other questions are 'shown' to them, which are then complete. The user can then go back and change the original
+ * question to then 'hide' those questions, but the answers they gave persist in the payload. The must be cleansed
+ * before being submitted.
+ *
+ * There are 2 types of payload data that have to be treated differently by this function for it to work.
+ *
+ * 1. Data from non-repeating pages, containing components.
+ *
+ * Each data item captured will be written to the payload as a field with the name of the fieldId of the payload.
+ * In the case of components that are nested within 'container' components, the payload will reflect the nesting.
+ * There is no limit to the level of nesting in a form.
+ *
+ * To cleanse the payload for this type of data, we do the following (high level description, see method comments for detail):
+ *
+ * - build a map of all components, keyed by their payload path (required for the next step)
+ * - for all of these components that have dependencies (show_when rules), create a graph datastructure to show all components
+ *   on which a component is dependent, and then all components that those components may be dependent on. There is no limit to
+ *   the depth of these chained dependencies.
+ * - the reason for building a graph of these dependency chains is so we know the sequence in which we must resolve the dependencies.
+ *   For any given chain of dependencies it is essential that we resolve the dependencies starting at the end of the chains, and work our way
+ *   back up the chain. If not, we could be resolving a dependency based on a payload item that itself will later be deleted.
+ *   Therefore, the final step is to recursively traverse the dependency graph, resolving the dependency rule for the components in
+ *   the chain from the leaf back up to the parent node.
+ *
+ * 2. Page collection data
+ *
+ * A page collection is a set of one or more pages which (as a group) can be filled in as many times is required
+ * by the user. For example, in EAB, you can add as many item-seal-details to an EAB form as are required. An item-seal-detail
+ * is made up of several different pages, all grouped. The data saved will be an array representing the whole collection, with
+ * each object in the array representing a single collection entry (a single item-seal-detail in this example).
+ *
+ * Cleanse collection data has to be driven from the payload rather than the form, as there are repeated objects in an array
+ * representing the data. Each one has to be treated independently as the data to be cleansed can be different in each one.
+ *
+ * - For each collection type, iterate through each payload object and treat it like an independent payload..
+ * - For each collection payload object, iterate through the collection's pages and components, and apply all the show_when rules
+ *   found at both page and component level to the payload.
+ * - Repeat for each payload object
+ * - Repeat for all collections
+ *
+ * @param {*} form
+ * @param {*} formData
+ * @returns {*} cleansed form data
+ */
+declare const clearOutUncompletedRoutes: (cleanseHiddenData: any, form: any, formData: any) => any;
+export default clearOutUncompletedRoutes;

package/dist/components/FormRenderer/helpers/clearOutUncompletedRoutesUtils.d.ts

@@ -0,0 +1,179 @@
+/**
+ * Add a value to a map of arrays. If the key exists, append the value to the array.
+ * If not, create the map entry with that key.
+ *
+ * @param {*} key
+ * @param {*} value
+ * @param {*} multiMap
+ */
+export declare const addValue: (key: any, value: any, multiMap: any) => void;
+/**
+ * Given a path, remove a node from this path within an object.
+ *
+ * @param {Object} payload Javascript object from which the node will be deleted. Updated by the method.
+ * @param {String} path A string containing a decimal point delimited path specifying the node to delete.
+ * @return {void}, obj above updated.
+ */
+export declare const deleteNodeByPath: (payload: any, path: any) => void;
+/**
+ * Return the immediate parent of a path string passed in.
+ * Useful for processing 'options' in a form, as nested fieldIds are placed in the payload at
+ * the same level in the heirarchy as the option question they relate to.
+ *
+ * @param {String} path Decimal point delimited path.
+ * @returns {String} Immediate parent of the path passed in.
+ */
+export declare const getImmediateParent: (path: any) => string | null;
+/**
+ * Questions can be nested within options, eg if you answer 'yes' to a radio question, this can
+ * reveal additional nested questions.
+ * The path of the fields from these nested questions are at the same level as the original option
+ * answer, so this utility derives the nested question path from the option path.
+ *
+ * @param {String} optionPath Decimal point delimited path
+ * @param {String} nestedFieldId fieldId (dataname) of the nested question within the above option
+ * @returns {String} Fully qualified path of the nested question
+ */
+export declare const getNestedQuestionPath: (optionPath: any, nestedFieldId: any) => any;
+/**
+ * Pruning a collection payload may have resulted in objects that are only left with their 'id' field, which isn't data
+ * but added by the renderer to find the activeId. If so, remove these objects entirely as they have been pruned.
+ *
+ * @param {Array} array Array of objects. Each object which has only 1 remaining field called 'id' should be removed.
+ * @return {void}, array above updated.
+ */
+export declare const removeObjectWithOnlySingleIdField: (array: any) => void;
+/**
+ * Helper method to establish all the payload paths (dependencies) that an entity (page or component) is
+ * dependent on through its show_when rule.
+ *
+ * This will be used to build a graph of chained dependencies to establish in which order
+ * to resolve dependencies. The exact rule is not required at this point, just the dependencies.
+ *
+ * The form specification allows complex show_when blocks including 1...n levels of nesting, so
+ * recursively search through the show_when block looking for all 'field' data items.
+ *
+ * @param {Object} entity Entity whose show_when rule is to be searched for 'field' data items within.
+ * @returns {Set} Set of payload paths that the entity (page or component) is dependent on.
+ */
+export declare const getDependencies: (entity: any) => Set<unknown> | null;
+/**
+ * Some show_when field values point to data items that are within objects provided by
+ * external calls to refdata, eg modeOfTransport.id. These won't map directly to the path
+ * keyed components in the allComponents map, so go back up levels in the path until we find
+ * the component that creates this field.
+ *
+ * This component might not be found at all, as the dependency might be on a field that is either
+ * provided by cop-ui (eg jobHolderStaffDetails.linemanagerEmail), or by the "addToFormData" function
+ * (eg epmsSubmitted). These will be leaf level in the dependency chain so component is not required.
+ *
+ * @param {String} optionPath Decimal point delimited path
+ * @param {String} nestedFieldId fieldId (dataname) of the nested question within the above option
+ * @returns {String} Fully qualified path of the nested question
+ *
+ */
+export declare const getDependencyObjectFromPath: (dependencyPath: any, allComponents: any) => any;
+/**
+ *
+ * Evaluate the show_when rule to establish if the component should be shown (and the
+ * payload data should not be pruned). If there is no show_when rule, then return true.
+ *
+ * @param {*} entity A page or component that may have a show_when rule associated with it
+ * @param {*} data The payload data used to evaluate the show_when rule
+ * @returns {boolean} true if the show_when rule evaluate to true, or there is no show_when rule
+ */
+export declare const isShowEntity: (entity: any, data: any) => boolean;
+/**
+ *
+ * Components can be assigned to pages in 2 ways in the form specification:
+ *
+ * 1 - They can be included in the page's components array with the 'use' field, e.g.
+ *  {
+ *      "use": "port"
+ *  }
+ * This "use" value will normally match a component's id, but can match its fieldId
+ * NB. In this case, a show_when rule can be applied here, which will supercede any show_when in the component. e.g.
+ *
+ *  {
+ *      "use": "port",
+ *      "show_when": ....
+ *  }
+ *
+ * 2 - The entire component can be embedded as an entry in the page's component array.
+ *
+ *
+ * @param {*} componentId The id of the component to find in the form.
+ * @param {*} componentByIdMap A map of all the form's components keyed on Id, for better performance than searching the form.
+ * @param {*} componentByFieldIdMap A map of all the form's components keyed on fieldId, for better performance than searching the form.
+ * @returns {Object} A cloned component object, containing the full definition of that component.
+ */
+export declare const findComponentDefinitionInForm: (pageComponentDef: any, componentByIdMap: any, componentByFieldIdMap: any) => any;
+/**
+ *
+ * When documents are added to the payload of type multifile, they are also added to a section of the payload
+ * 'meta', specifically an array 'documents'. When we remove the multifile elements, we need to remove
+ * the corresponding meta.document entries.
+ *
+ * @param {*} component The component definition being deleted that needs corresponding meta data also deleted
+ * @param {*} collectionDataObject The payload containing the file data being deleted (for which the corresponding meta needs deleting)
+ * @param {*} formData The entire payload, which will include the meta section
+ * @returns {void}, as the formData will be updated in situ
+ */
+export declare const deleteCorrespondingMetaInfo: (component: any, collectionDataObject: any, formData: any) => void;
+/**
+ * After the payload has been cleansed of individual data items, empty arrays and objects may remain.
+ * Removing an array (when the payload for a collection) may leave a redundant activeId field. The active Id
+ * fields are not part of the payload data, but added by the react renderer to track which collection object
+ * is currently being worked on, so can be removed.
+ *
+ * To tidy this all up, recursively empty arrays and their associated "ActiveId" fields from a nested payload.
+ *
+ * This function traverses a given payload, which can be an array or an object, and performs the following operations:
+ * 1. If an empty array is found inside an array, it is removed using `splice`.
+ * 2. If an empty array is found inside an object:
+ *    - It is removed from the object.
+ *    - If there is a corresponding `<key>ActiveId` field, that field is also removed.
+ * 3. The function operates recursively to handle deeply nested structures.
+ *
+ * @param {any} payload - The input data structure, which can be an array or an object.
+ *
+ */
+export declare const removeEmptyArraysAndUnusedCollectionIDs: (payload: any) => void;
+/**
+ * Helper method to go through each option calling a passed in function for any nested fields.
+ * @param {Object} component The form component representing the path being deleted
+ * @param {Function} action The action to perform on each nested question. Varies for collections and non-collections
+ * @return {void}, obj above updated.
+ */
+export declare const iterateOptions: (component: any, action: any) => void;
+/**
+ * Delete a component's payload item from the overall payload.
+ * A component can be defined in >1 places in the form spec. To cater for this,
+ * if the componentsToKeep counter tells us that there is > 1 uses of this component
+ * still unaccounted for in the form then don't delete, but reduce the count by 1.
+ *
+ * When the counter reaches 1 we know all other occurences of the component have been resolved
+ * so it is safe to delete.
+ *
+ *
+ * @param {*} payload The form payload from which to delete the component data
+ * @param {*} path The payload path of the component
+ * @param {*} component The component whose data we should attempt to delete
+ * @param {*} componentsToKeep A list of all components with a count of their number of uses in the form
+ */
+export declare const deleteComponentData: (payload: any, path: any, component: any, componentsToKeep: any) => void;
+/**
+ *
+ * Takes a single page collection payload object and removes the payload items specified in the componentsToPrune list
+ * as long as they don't appear in the componentsToKeep list.
+ *
+ * Additionally, if the component type is multifile, remove the corresponding data entries that will have been created
+ * in the meta section of the payload by the form renderer.
+ *
+ * @param {Set} pathsToKeep paths that we cannot delete from the collectionDataObject
+ * @param {Map} componentsToPrune paths that we should delete, as long as they are not in the pathsToKeep
+ * @param {Object} collectionDataObject the payload from which to delete the paths
+ * @param {Object} formData The form data, whose meta section may include corresponding documents entries for multifile entries
+ */
+export declare const pruneCollectionEntry: (pathsToKeep: any, componentsToPrune: any, collectionDataObject: any, formData: any) => void;
+export declare const toArray: (value: any) => any[];

package/dist/components/FormRenderer/helpers/getCYA.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Gets a configuration object for the Check your answers screen.
+ * @param {string} pageId The current page identifier.
+ * @param {object} hub The hub, if there is one.
+ * @returns A configuration object for the Check your answers screen.
+ */
+declare const getCYA: (pageId: any, pages: any, hub: any) => {
+    title: string;
+    hideChangeActions?: undefined;
+    hideGroupActions?: undefined;
+} | {
+    title?: undefined;
+    hideChangeActions?: undefined;
+    hideGroupActions?: undefined;
+} | {
+    title: any;
+    hideChangeActions: any;
+    hideGroupActions: any;
+} | undefined;
+export default getCYA;

package/dist/components/FormRenderer/helpers/getFormState.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Sets up the state of the form, including the current page and the Check your answers screen.
+ * @param {string} pageId The current page identifier.
+ * @param {Array} pages All of the pages in the form.
+ * @param {object} hub The hub, if there is one.
+ * @returns The current state of the form.
+ */
+declare const getFormState: (pageId: any, pages: any, hub: any) => {
+    pageId: any;
+    cya: {
+        title: string;
+        hideChangeActions?: undefined;
+        hideGroupActions?: undefined;
+    } | {
+        title?: undefined;
+        hideChangeActions?: undefined;
+        hideGroupActions?: undefined;
+    } | {
+        title: any;
+        hideChangeActions: any;
+        hideGroupActions: any;
+    } | undefined;
+    page: any;
+};
+export default getFormState;

package/dist/components/FormRenderer/helpers/getNextPageId.d.ts

@@ -0,0 +1,2 @@
+declare const getNextPageId: (formType: any, pages: any, currentPageId: any, action: any, formData: any) => any;
+export default getNextPageId;

package/dist/components/FormRenderer/helpers/getPage.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Gets the current page to render, which may be undefined if the current page is the "hub".
+ * @param {string} pageId The current page identifier.
+ * @param {Array} pages All of the pages in the form.
+ * @param {object} hub The hub, if there is one.
+ * @returns The current page to render.
+ */
+declare const getPage: (pageId: any, pages: any, hub: any) => any;
+export default getPage;

package/dist/components/FormRenderer/helpers/getRelevantPages.d.ts

@@ -0,0 +1,2 @@
+declare const getRelevantPages: (formState: any, pages: any, currentTaskPages: any) => any;
+export default getRelevantPages;

package/dist/components/FormRenderer/helpers/getSubmissionStatus.d.ts

@@ -0,0 +1,2 @@
+declare const getSubmissionStatus: (formType: any, pages: any, currentPageId: any, action: any, formData: any, currentTask: any, isCompleted: any, sections: any) => any;
+export default getSubmissionStatus;

package/dist/components/FormRenderer/helpers/getUpdatedSectionStates.d.ts

@@ -0,0 +1,10 @@
+/**
+ * update task states in sections
+ * @param {object[]} sections - array of sections
+ * @param {object} taskStates - update task states
+ * @param {boolean} nonSequential - true if tasks can be performed non-sequentially
+ * @param {object} data - current form data
+ * @returns {object[]} - updated sections - note this is a clone
+ */
+declare const getUpdatedSectionStates: (sections: any, taskStates: any, nonSequential?: boolean, data?: null) => any;
+export default getUpdatedSectionStates;

package/dist/components/FormRenderer/helpers/index.d.ts

@@ -0,0 +1,29 @@
+declare const helpers: {
+    canActionProceed: (action: any, page: any, pageValidator: any, errors: any) => boolean;
+    canCYASubmit: (pages: any, pagesValidator: any) => boolean;
+    cleanHiddenNestedData: (patch: any, page: any) => any;
+    getFormState: (pageId: any, pages: any, hub: any) => {
+        pageId: any;
+        cya: {
+            title: string;
+            hideChangeActions?: undefined;
+            hideGroupActions?: undefined;
+        } | {
+            title?: undefined;
+            hideChangeActions?: undefined;
+            hideGroupActions?: undefined;
+        } | {
+            title: any;
+            hideChangeActions: any;
+            hideGroupActions: any;
+        } | undefined;
+        page: any;
+    };
+    getRelevantPages: (formState: any, pages: any, currentTaskPages: any) => any;
+    getNextPageId: (formType: any, pages: any, currentPageId: any, action: any, formData: any) => any;
+    getPage: (pageId: any, pages: any, hub: any) => any;
+    getSubmissionStatus: (formType: any, pages: any, currentPageId: any, action: any, formData: any, currentTask: any, isCompleted: any, sections: any) => any;
+    getUpdatedSectionStates: (sections: any, taskStates: any, nonSequential?: boolean, data?: null) => any;
+    clearOutUncompletedRoutes: (cleanseHiddenData: any, form: any, formData: any) => any;
+};
+export default helpers;

package/dist/components/FormRenderer/index.d.ts

@@ -0,0 +1,2 @@
+import { default as FormRenderer } from './FormRenderer';
+export default FormRenderer;

package/dist/components/FormRenderer/onCYAAction.d.ts

@@ -0,0 +1,6 @@
+/**
+ *
+ * @param {*} action
+ */
+declare const onCYAAction: (setPagePoint: any, action: any, pages: any, validate: any, cleanseHiddenData: any, components: any, data: any, setData: any, type: any, pageId: any, currentTask: any, hooks: any, addErrors: any, hub: any, onPageChange: any, formState: any, submitting: any, setSubmitting: any) => void;
+export default onCYAAction;

package/dist/components/FormRenderer/onPageAction.d.ts

@@ -0,0 +1,2 @@
+declare const onPageAction: (action: any, patch: any, patchLabel: any, hooks: any, data: any, formState: any, validate: any, onPageChange: any, type: any, cleanseHiddenData: any, pages: any, components: any, pageId: any, setPagePoint: any, currentTask: any, setData: any, hubDetails: any, setSubmitted: any, addErrors: any, submitting: any, setSubmitting: any, existingErrors: any) => void;
+export default onPageAction;

package/dist/components/FormRenderer/onTaskAction.d.ts

@@ -0,0 +1,2 @@
+declare const onTaskAction: (currentTask: any, pages: any, setCurrentTask: any, hubDetails: any, data: any, onPageChange: any) => void;
+export default onTaskAction;

package/dist/components/PageActions/ActionButton.d.ts

@@ -0,0 +1,7 @@
+export declare const DEFAULT_LABEL = "Continue";
+interface ActionButtonProps {
+    action: string | object;
+    onAction: Function;
+}
+declare const ActionButton: ({ action: _action, onAction, ...attrs }: ActionButtonProps) => import("react/jsx-runtime").JSX.Element | null;
+export default ActionButton;

package/dist/components/PageActions/PageActions.d.ts

@@ -0,0 +1,7 @@
+interface PageActionsProps {
+    actions: object | string[];
+    onAction: Function;
+}
+/** Renders the buttons at the bottom of a Page */
+declare const PageActions: ({ actions, onAction }: PageActionsProps) => import("react/jsx-runtime").JSX.Element | null;
+export default PageActions;

package/dist/components/PageActions/index.d.ts

@@ -0,0 +1,2 @@
+import { default as PageActions } from './PageActions';
+export default PageActions;

package/dist/components/SummaryList/GroupAction.d.ts

@@ -0,0 +1,12 @@
+export interface GroupActionProps {
+    group: {
+        action?: {
+            label: string;
+            page?: string;
+            aria_suffix?: string;
+            onAction?: Function;
+        };
+    };
+}
+declare const GroupAction: ({ group }: GroupActionProps) => import("react/jsx-runtime").JSX.Element | null;
+export default GroupAction;

package/dist/components/SummaryList/RowAction.d.ts

@@ -0,0 +1,12 @@
+interface RowActionProps {
+    row: {
+        action?: {
+            label: string;
+            page?: string;
+            aria_suffix?: string;
+            onAction?: Function;
+        };
+    };
+}
+declare const RowAction: ({ row }: RowActionProps) => import("react/jsx-runtime").JSX.Element | null;
+export default RowAction;

package/dist/components/SummaryList/SummaryList.d.ts

@@ -0,0 +1,28 @@
+import { ReactNode } from 'react';
+export declare const DEFAULT_CLASS = "govuk-summary-list";
+export interface SummaryListProps {
+    classBlock?: string;
+    classModifiers?: string | string[];
+    className?: string;
+    isGroup?: boolean;
+    noChangeAction?: boolean;
+    noGroupAction?: boolean;
+    showGroupAction?: boolean;
+    rows: {
+        pageId: string;
+        fieldId: string;
+        full_path?: string;
+        key: string;
+        value?: ReactNode;
+        action?: {
+            page?: string;
+            label?: string;
+            aria_suffix?: string;
+            onAction?: Function;
+        };
+    }[];
+}
+/** Renders a list of key-value pairs, most commonly on the **Check your answers** screen, and optionally
+display action links. */
+declare const SummaryList: ({ rows, noChangeAction, noGroupAction, isGroup, classBlock, classModifiers, className, showGroupAction, ...attrs }: SummaryListProps) => import("react/jsx-runtime").JSX.Element;
+export default SummaryList;

package/dist/components/SummaryList/SummaryList.stories.d.ts

@@ -0,0 +1,10 @@
+import { StoryObj } from '@storybook/react-vite';
+declare const meta: {
+    title: string;
+    component: ({ rows, noChangeAction, noGroupAction, isGroup, classBlock, classModifiers, className, showGroupAction, ...attrs }: import('./SummaryList').SummaryListProps) => import("react/jsx-runtime").JSX.Element;
+    tags: string[];
+};
+export default meta;
+type Story = StoryObj<typeof meta>;
+export declare const Default: Story;
+export declare const ReadOnly: Story;

package/dist/components/SummaryList/SummaryListHeadingRow.d.ts

@@ -0,0 +1,7 @@
+interface SummaryListHeadingRowProps {
+    classes: Function;
+    size?: string;
+    title: string;
+}
+declare const SummaryListHeadingRow: ({ title, size, classes }: SummaryListHeadingRowProps) => import("react/jsx-runtime").JSX.Element;
+export default SummaryListHeadingRow;

package/dist/components/SummaryList/SummaryListHeadingRowWithAction.d.ts

@@ -0,0 +1,16 @@
+interface SummaryListHeadingRowWithActionProps {
+    classes: Function;
+    row: {
+        key: string;
+        size?: string;
+        action?: {
+            page?: string;
+            label?: string;
+            aria_suffix?: string;
+            onAction?: Function;
+        };
+    };
+    noChangeAction?: boolean;
+}
+declare const SummaryListHeadingRowWithAction: ({ row, classes, noChangeAction }: SummaryListHeadingRowWithActionProps) => import("react/jsx-runtime").JSX.Element;
+export default SummaryListHeadingRowWithAction;