@hmcts/opal-frontend-common 0.0.2 → 0.0.3

package/components/abstract/abstract-form-alias-base/abstract-form-alias-base.d.ts

@@ -0,0 +1,117 @@
+import { AbstractFormBaseComponent } from '../abstract-form-base/abstract-form-base.component';
+import { OnDestroy, OnInit } from '@angular/core';
+import { IAbstractFormAliasBaseAliasControls } from './interfaces/abstract-form-alias-base-alias-controls.interface';
+import { IAbstractFormArrayControlValidation } from '../interfaces/abstract-form-array-control-validation.interface';
+import { IAbstractFormArrayControls } from '../interfaces/abstract-form-array-controls.interface';
+import { FormArray, FormControl, ValidatorFn } from '@angular/forms';
+import { IAbstractFormArrayControl } from '../interfaces/abstract-form-array-control.interface';
+import * as i0 from "@angular/core";
+export declare abstract class AbstractFormAliasBaseComponent extends AbstractFormBaseComponent implements OnInit, OnDestroy {
+    aliasControls: IAbstractFormAliasBaseAliasControls[];
+    aliasControlsValidation: IAbstractFormArrayControlValidation[];
+    aliasFields: string[];
+    /**
+     * Builds an array of form controls for the given form array.
+     *
+     * @param formControlCount - An array of numbers representing the number of form controls to create.
+     * @param formArrayName - The name of the form array.
+     * @param fieldNames - An array of field names.
+     * @param controlValidation - An array of control validation objects.
+     * @returns An array of form controls for the given form array.
+     */
+    private buildFormAliasControls;
+    /**
+     * Adds alias controls to the form array.
+     *
+     * @param index - The index of the form array.
+     * @param formArrayName - The name of the form array.
+     * @param fieldNames - The names of the fields for the alias controls.
+     * @param controlValidation - The validation rules for the alias controls.
+     * @returns An object containing the form controls.
+     */
+    private addAliasControls;
+    /**
+     * Removes all form alias controls from a FormArray and clears any associated error messages.
+     *
+     * @param formArrayControls - An array of form array controls.
+     * @param formArrayName - The name of the FormArray.
+     * @param fieldNames - An array of field names associated with the form array controls.
+     * @returns An empty array of form array controls.
+     */
+    private removeAllFormAliasControls;
+    /**
+     * Creates a FormArray with the specified validators and controls.
+     *
+     * @param validators - An array of validators to apply to the FormArray.
+     * @param controls - An optional array of initial FormControl instances to add to the FormArray.
+     * @returns A new FormArray instance.
+     */
+    protected createFormAlias(validators: ValidatorFn[], controls?: FormControl[]): FormArray;
+    /**
+     * Removes a form alias control at the specified index from the given form array controls.
+     *
+     * @param index - The index of the form alias control to remove.
+     * @param formArrayControls - The array of form array controls.
+     * @returns The updated array of form array controls after removing the specified control.
+     */
+    protected removeFormAliasControl(index: number, formArrayControls: IAbstractFormArrayControls[]): IAbstractFormArrayControls[];
+    /**
+     * Sets up the alias form controls based on the provided alias count array and form array name.
+     * If there are any aliases, the alias controls will be re-populated.
+     *
+     * @param aliasCountArray - An array containing the count of aliases.
+     * @param formArrayName - The name of the form array.
+     */
+    protected setupAliasFormControls(aliasCountArray: number[], formArrayName: string): void;
+    /**
+     * Removes the form alias controls errors for a specific index in a form array.
+     *
+     * @param index - The index of the form array control.
+     * @param formArrayControls - An array of form array controls.
+     * @param fieldNames - An array of field names to remove errors from.
+     */
+    protected removeFormAliasControlsErrors(index: number, formArrayControls: IAbstractFormArrayControls[], fieldNames: string[]): void;
+    /**
+     * Creates alias controls for the given fields and index.
+     * @param fields - The list of fields for which alias controls need to be created.
+     * @param index - The index value used to generate unique identifiers for the controls.
+     * @returns An object containing the alias controls.
+     */
+    protected createAliasControls(fields: string[], index: number): {
+        [key: string]: IAbstractFormArrayControl;
+    };
+    /**
+     * Sets up the alias checkbox listener.
+     *
+     * @param formCheckboxName - The name of the checkbox control in the form.
+     * @param formArrayName - The name of the form array control in the form.
+     */
+    protected setUpAliasCheckboxListener(formCheckboxName: string, formArrayName: string): void;
+    /**
+     * Removes a form alias control from a form array and updates the list of form array controls.
+     * @param index - The index of the form alias control to be removed.
+     * @param formArrayName - The name of the form array.
+     * @param formArrayControls - The list of form array controls.
+     * @param fieldNames - The names of the fields associated with the form array controls.
+     * @returns The updated list of form array controls after removing the specified control.
+     */
+    removeFormAliasControls(index: number, formArrayName: string, formArrayControls: IAbstractFormArrayControls[], fieldNames: string[]): IAbstractFormArrayControls[];
+    /**
+     * Adds an alias to the specified index of the form array.
+     *
+     * @param index - The index at which to add the alias.
+     * @param formArrayName - The name of the form array.
+     */
+    addAlias(index: number, formArrayName: string): void;
+    /**
+     * Removes an alias from the form array.
+     *
+     * @param index - The index of the alias to remove.
+     * @param formArrayName - The name of the form array.
+     */
+    removeAlias(index: number, formArrayName: string): void;
+    ngOnInit(): void;
+    ngOnDestroy(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AbstractFormAliasBaseComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<AbstractFormAliasBaseComponent, "ng-component", never, {}, {}, never, never, true, never>;
+}

package/components/abstract/abstract-form-alias-base/interfaces/abstract-form-alias-base-alias-controls.interface.d.ts

@@ -0,0 +1,4 @@
+import { IAbstractFormArrayControl } from '../../interfaces/abstract-form-array-control.interface';
+export interface IAbstractFormAliasBaseAliasControls {
+    [key: string]: IAbstractFormArrayControl;
+}

package/components/abstract/abstract-form-array-base/abstract-form-array-base.d.ts

@@ -0,0 +1,158 @@
+import { OnDestroy, OnInit } from '@angular/core';
+import { AbstractFormBaseComponent } from '../abstract-form-base/abstract-form-base.component';
+import { IAbstractFormArrayControls } from '../interfaces/abstract-form-array-controls.interface';
+import { IAbstractFormArrayControlValidation } from '../interfaces/abstract-form-array-control-validation.interface';
+import { AbstractControl, FormArray, FormControl, FormGroup, ValidatorFn } from '@angular/forms';
+import { IAbstractFormArrayControl } from '../interfaces/abstract-form-array-control.interface';
+import * as i0 from "@angular/core";
+export declare abstract class AbstractFormArrayBaseComponent extends AbstractFormBaseComponent implements OnInit, OnDestroy {
+    formArrayControls: IAbstractFormArrayControls[];
+    formArrayControlsValidation: IAbstractFormArrayControlValidation[];
+    formArrayFields: string[];
+    /**
+     * Builds an array of form controls for a form array.
+     *
+     * @param formControlCount - An array of numbers representing the number of form controls to create.
+     * @param formArrayName - The name of the form array.
+     * @param fieldNames - An array of field names for the form controls.
+     * @param controlValidation - An array of control validation configurations.
+     * @returns An array of form controls for the form array.
+     */
+    private buildFormArrayControls;
+    /**
+     * Adds form array controls to the specified form array.
+     *
+     * @param index - The index at which the form array controls should be added.
+     * @param formArrayName - The name of the form array.
+     * @param fieldNames - The names of the form controls to be created.
+     * @param controlValidation - The validation rules for the form controls.
+     * @returns An object containing the form controls that were added.
+     */
+    private addFormArrayControls;
+    /**
+     * Creates a new instance of FormArray with the specified validators and controls.
+     *
+     * @param validators - An array of validator functions to be applied to the form array.
+     * @param controls - An optional array of form controls to initialize the form array with.
+     * @returns A new instance of FormArray.
+     */
+    protected createFormArray(validators: ValidatorFn[], controls?: FormControl[]): FormArray;
+    /**
+     * Sets up the form array form controls based on the provided parameters.
+     *
+     * @param formArrayCountArray - An array of numbers representing the count of form array controls.
+     * @param formArrayName - The name of the form array.
+     */
+    protected setupFormArrayFormControls(formArrayCountArray: number[], formArrayName: string): void;
+    /**
+     * Creates an object with form array controls based on the given fields and index.
+     *
+     * @param fields - An array of field names.
+     * @param index - The index of the form array.
+     * @returns An object with form array controls.
+     */
+    protected createFormArrayControls(fields: string[], index: number): {
+        [key: string]: IAbstractFormArrayControl;
+    };
+    /**
+     * Removes form array controls errors for a specific index.
+     *
+     * @param index - The index of the form array control.
+     * @param formArrayControls - An array of form array controls.
+     * @param fieldNames - An array of field names to remove errors from.
+     */
+    protected removeFormArrayControlsErrors(index: number, formArrayControls: IAbstractFormArrayControls[], fieldNames: string[]): void;
+    /**
+     * Adds controls to the form array at the specified index.
+     *
+     * @param index - The index at which the controls should be added.
+     * @param formArrayName - The name of the form array.
+     */
+    addControlsToFormArray(index: number, formArrayName: string): void;
+    /**
+     * Removes a form array control at the specified index from the given array of form array controls.
+     *
+     * @param index - The index of the form array control to be removed.
+     * @param formArrayControls - The array of form array controls.
+     * @returns The updated array of form array controls after removing the specified control.
+     */
+    protected removeFormArrayControl(index: number, formArrayControls: IAbstractFormArrayControls[]): IAbstractFormArrayControls[];
+    /**
+     * Retrieves the value of a form control or returns a default value if the control is null or undefined.
+     *
+     * @param control - The form control to retrieve the value from.
+     * @param defaultValue - The default value to return if the control is null or undefined.
+     * @returns The value of the control if it exists, otherwise the default value.
+     */
+    protected getControlValueOrDefault(control: AbstractControl | null, defaultValue: any): any;
+    /**
+     * Removes a form array control at the specified index and updates the form array controls and errors.
+     *
+     * @param index - The index of the form array control to remove.
+     * @param formArrayName - The name of the form array.
+     * @param formArrayControls - The list of form array controls.
+     * @param fieldNames - The names of the fields associated with the form array controls.
+     * @returns The updated list of form array controls.
+     */
+    removeFormArrayControls(index: number, formArrayName: string, formArrayControls: IAbstractFormArrayControls[], fieldNames: string[]): IAbstractFormArrayControls[];
+    /**
+     * Removes controls from a form array at the specified index.
+     *
+     * @param index - The index at which to remove the controls.
+     * @param formArrayName - The name of the form array.
+     */
+    removeControlsFromFormArray(index: number, formArrayName: string): void;
+    /**
+     * Removes a form array control from the specified form array.
+     *
+     * @param formArrayControl - The form array control to remove.
+     * @param formArrayName - The name of the form array.
+     */
+    removeFormArrayControlFromArray(formArrayControl: IAbstractFormArrayControls, formArrayName: string): void;
+    /**
+     * Retrieves the FormGroup at the specified index from a FormArray.
+     *
+     * @param index - The index of the FormGroup to retrieve.
+     * @param formArrayName - The name of the FormArray.
+     * @returns The FormGroup at the specified index.
+     */
+    getFormArrayFormGroup(index: number, formArrayName: string): FormGroup;
+    /**
+     * Retrieves the FormControl from a FormGroup within a FormArray at the specified index.
+     *
+     * @param formGroup - The FormGroup containing the FormControl.
+     * @param controlName - The name of the FormControl.
+     * @param index - The index of the FormArray.
+     * @returns The FormControl at the specified index.
+     */
+    getFormArrayFormGroupControl(formGroup: FormGroup, controlName: string, index: number): FormControl;
+    /**
+     * Adds validators to a specific form control within a form array group.
+     *
+     * @param formGroup - The form group containing the form array.
+     * @param controlName - The name of the form control within the form array group.
+     * @param index - The index of the form array group within the form array.
+     * @param validators - An array of validator functions to be added to the form control.
+     */
+    addFormArrayFormGroupControlValidators(formControl: FormControl, validators: ValidatorFn[]): void;
+    /**
+     * Removes validators from a specific form control within a form array group.
+     * @param formGroup - The form group containing the form array.
+     * @param controlName - The name of the form control within the form array group.
+     * @param index - The index of the form array group within the form array.
+     */
+    removeFormArrayFormGroupControlValidators(formControl: FormControl): void;
+    /**
+     * Reverses the form array data by appending the index to each key in the objects.
+     *
+     * @param data - An array of objects containing form data.
+     * @returns An array of objects with keys modified to include their index in the original array.
+     */
+    addIndexToFormArrayData(data: any[]): {
+        [key: string]: any;
+    }[];
+    ngOnInit(): void;
+    ngOnDestroy(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AbstractFormArrayBaseComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<AbstractFormArrayBaseComponent, "ng-component", never, {}, {}, never, never, true, never>;
+}

package/components/abstract/abstract-form-array-parent-base/abstract-form-array-parent-base.component.d.ts

@@ -0,0 +1,13 @@
+import { AbstractFormParentBaseComponent } from '../abstract-form-parent-base/abstract-form-parent-base.component';
+export declare abstract class AbstractFormArrayParentBaseComponent extends AbstractFormParentBaseComponent {
+    /**
+     * Removes index suffixes from keys in an array of objects and restructures the data.
+     *
+     * This function takes an array of objects where keys have an index suffix (e.g., `key_0`, `key_1`),
+     * and returns a new array of objects where the keys are grouped by their base name without the index.
+     *
+     * @param data - The array of objects with indexed keys.
+     * @returns A new array of objects with keys grouped by their base name.
+     */
+    removeIndexFromFormArrayData(data: any[]): any[];
+}

package/components/abstract/abstract-form-array-removal-base/abstract-form-array-removal-base.component.d.ts

@@ -0,0 +1,44 @@
+import { FormArray, FormGroup } from '@angular/forms';
+import { IAbstractFormArrayRemovalBaseControlValue } from './interfaces/abstract-form-array-removal-base-control-value.interface';
+import * as i0 from "@angular/core";
+export declare abstract class AbstractFormArrayRemovalComponent {
+    private readonly router;
+    private readonly activatedRoute;
+    protected getFormArrayControlValue(formArray: FormArray, controlName: string, rowIndex: number, defaultValue: IAbstractFormArrayRemovalBaseControlValue[keyof IAbstractFormArrayRemovalBaseControlValue]): IAbstractFormArrayRemovalBaseControlValue[keyof IAbstractFormArrayRemovalBaseControlValue];
+    /**
+     * Removes a control from the given form array at the specified index and renumbers the remaining controls.
+     *
+     * @param formArray - The form array from which to remove the control.
+     * @param removeIndex - The index of the control to remove.
+     * @param fieldNames - The names of the fields associated with the controls.
+     * @param dynamicFieldPrefix - The prefix used for dynamically generated field names.
+     */
+    protected removeControlAndRenumber(formArray: FormArray, removeIndex: number, fieldNames: string[], dynamicFieldPrefix: string): void;
+    /**
+     * Renumber the controls in a FormArray starting from a specific index.
+     * This method updates the control keys of each FormGroup within the FormArray.
+     *
+     * @param formArray - The FormArray to renumber the controls for.
+     * @param startIndex - The index to start renumbering the controls from.
+     * @param fieldNames - The names of the fields in the FormGroup.
+     * @param dynamicFieldPrefix - The prefix to use for dynamic field names.
+     */
+    protected renumberControls(formArray: FormArray, startIndex: number, fieldNames: string[], dynamicFieldPrefix: string): void;
+    /**
+     * Updates the control keys in a form group based on the provided parameters.
+     * @param formGroup - The form group to update.
+     * @param index - The index of the form group within an array.
+     * @param fieldNames - An array of field names to update.
+     * @param dynamicFieldPrefix - The prefix to use for dynamic field keys.
+     */
+    protected updateControlKeys(formGroup: FormGroup, index: number, fieldNames: string[], dynamicFieldPrefix: string): void;
+    /**
+     * Handles route with the supplied route
+     *
+     * @param route string of route
+     * @param nonRelative boolean indicating if route is relative to the parent
+     */
+    handleRoute(route: string, nonRelative?: boolean, event?: Event): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AbstractFormArrayRemovalComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<AbstractFormArrayRemovalComponent, "ng-component", never, {}, {}, never, never, true, never>;
+}

package/components/abstract/abstract-form-array-removal-base/interfaces/abstract-form-array-removal-base-control-value.interface.d.ts

@@ -0,0 +1,5 @@
+export interface IAbstractFormArrayRemovalBaseControlValue {
+    stringValue: string;
+    numberValue: number;
+    nullValue: null;
+}

package/components/abstract/abstract-form-base/abstract-form-base.component.d.ts

@@ -0,0 +1,232 @@
+import { EventEmitter, OnDestroy, OnInit } from '@angular/core';
+import { FormControl, FormGroup, ValidatorFn } from '@angular/forms';
+import { Subject } from 'rxjs';
+import { IAbstractFormBaseFieldErrors } from './interfaces/abstract-form-base-field-errors.interface';
+import { IAbstractFormBaseFormError } from './interfaces/abstract-form-base-form-error.interface';
+import { IAbstractFormBaseFormErrorSummaryMessage } from '../interfaces/abstract-form-base-form-error-summary-message.interface';
+import { IAbstractFormBaseForm } from './interfaces/abstract-form-base-form.interface';
+import { IAbstractFormControlErrorMessage } from '../interfaces/abstract-form-control-error-message.interface';
+import { IAbstractFormArrayControlValidation } from '../interfaces/abstract-form-array-control-validation.interface';
+import { UtilsService } from '@hmcts/opal-frontend-common/services';
+import * as i0 from "@angular/core";
+export declare abstract class AbstractFormBaseComponent implements OnInit, OnDestroy {
+    protected unsavedChanges: EventEmitter<boolean>;
+    protected formSubmit: EventEmitter<IAbstractFormBaseForm<any>>;
+    private readonly changeDetectorRef;
+    private readonly router;
+    private readonly activatedRoute;
+    protected readonly utilsService: UtilsService;
+    form: FormGroup;
+    formControlErrorMessages: IAbstractFormControlErrorMessage;
+    formErrorSummaryMessage: IAbstractFormBaseFormErrorSummaryMessage[];
+    protected fieldErrors: IAbstractFormBaseFieldErrors;
+    protected formSubmitted: boolean;
+    protected readonly ngUnsubscribe: Subject<void>;
+    formErrors: IAbstractFormBaseFormError[];
+    constructor();
+    /**
+     * Scrolls to the label of the component and focuses on the field id
+     *
+     * @param fieldId - Field id of the component
+     */
+    private scroll;
+    /**
+     * Returns the highest priority form error from the given error keys and field errors.
+     * @param errorKeys - An array of error keys.
+     * @param fieldErrors - An object containing field errors.
+     * @returns The highest priority form error or null if no errors are found.
+     */
+    private getHighestPriorityError;
+    /**
+     * Retrieves the details of the highest priority form error for a given control path.
+     * @param controlPath - The path to the control in the form.
+     * @returns The details of the highest priority form error, or null if there are no errors.
+     */
+    private getFieldErrorDetails;
+    /**
+     * Retrieves all form errors from the provided form and its nested form groups.
+     *
+     * @param form - The form group to retrieve errors from.
+     * @param controlPath - An optional array representing the path to the current control within the form group.
+     * @returns An array of form errors, each containing the field ID, error message, priority, and type.
+     */
+    private getFormErrors;
+    /**
+     * Sets the error messages for the form controls and error summary based on the provided form errors.
+     * @param formErrors - An array of form errors containing field IDs and error messages.
+     */
+    private setErrorMessages;
+    /**
+     * Gets the indexes of the date fields to remove based on the form error summary message.
+     * @returns An array of indexes representing the date fields to remove.
+     */
+    private getDateFieldsToRemoveIndexes;
+    /**
+     * Returns an array of indices corresponding to the positions of the given field IDs in the form error summary message array.
+     *
+     * @param fieldIds - An array of field IDs to search for in the form error summary message array.
+     * @param formErrorSummaryMessage - An array of form error summary messages.
+     * @returns An array of indices corresponding to the positions of the field IDs in the form error summary message array.
+     */
+    private getFormErrorSummaryIndex;
+    /**
+     * Removes error summary messages from the given array based on the specified indexes.
+     *
+     * @param formErrorSummaryMessage - The array of error summary messages.
+     * @param indexes - The indexes of the error summary messages to be removed.
+     * @returns The updated array of error summary messages.
+     */
+    private removeErrorSummaryMessages;
+    /**
+     * Splits the form errors into two arrays based on the provided field IDs.
+     * Errors with field IDs included in the fieldIds array will be moved to the removedFormErrors array,
+     * while the remaining errors will be moved to the cleanFormErrors array.
+     *
+     * @param fieldIds - An array of field IDs to filter the form errors.
+     * @param formErrors - An array of form errors to be split.
+     * @returns An array containing two arrays: cleanFormErrors and removedFormErrors.
+     */
+    private splitFormErrors;
+    /**
+     * Manipulates the error message for specific fields in the formErrors array.
+     * @param fields - An array of field IDs to target for error message manipulation.
+     * @param messageOverride - The new error message to be used for the targeted fields.
+     * @param errorType - The type of error to match for the targeted fields.
+     * @param formErrors - An array of IFormError objects representing the form errors.
+     * @returns An array of IFormError objects with the manipulated error messages.
+     */
+    private manipulateFormErrorMessage;
+    /**
+     * Retrieves the form errors with the highest priority.
+     *
+     * @param formErrors - An array of form errors.
+     * @returns An array of form errors with the highest priority.
+     */
+    private getHighPriorityFormErrors;
+    /**
+     * Focuses on the error summary element and scrolls to the top of the page.
+     *
+     * This method first triggers change detection to ensure the view is up-to-date.
+     * It then selects the error summary element with the class 'govuk-error-summary'.
+     * If the error summary element is found, it sets focus on it without scrolling the page.
+     * Finally, it calls a utility service to scroll to the top of the page.
+     *
+     * @private
+     */
+    private focusAndScrollToErrorSummary;
+    /**
+     * Setup listener for the form value changes and to emit hasUnsavedChanges
+     */
+    private setupListener;
+    /**
+     * Adds controls to a form group.
+     *
+     * @param formGroup - The form group to add controls to.
+     * @param controls - An array of form array control validations.
+     * @param index - The index of the form array control.
+     */
+    protected addControlsToFormGroup(formGroup: FormGroup, controls: IAbstractFormArrayControlValidation[], index: number): void;
+    /**
+     * Creates a form control with the specified validators and initial value.
+     *
+     * @param validators - An array of validator functions.
+     * @param initialValue - The initial value for the form control. Defaults to null.
+     * @returns The created form control.
+     */
+    protected createFormControl(validators: ValidatorFn[], initialValue?: string | null): FormControl;
+    /**
+     * Handles the error messages and populates the relevant variables
+     */
+    protected handleErrorMessages(): void;
+    /**
+     * Checks whether the form has been touched and submitted
+     *
+     * @returns boolean
+     */
+    protected hasUnsavedChanges(): boolean;
+    /**
+     * Sets the value of a specified form control and marks it as touched.
+     *
+     * @param {string} value - The value to set for the form control.
+     * @param {string} control - The name of the form control to update.
+     */
+    protected setInputValue(value: string, control: string): void;
+    /**
+     * Handles the form errors for the date input fields.
+     * @param formErrors - An array of form errors.
+     * @returns An array of form errors with the manipulated error messages.
+     */
+    protected handleDateInputFormErrors(): IAbstractFormBaseFormError[];
+    /**
+     * Sets the initial error messages for the form controls.
+     *
+     * @param form - The FormGroup instance.
+     */
+    protected setInitialErrorMessages(): void;
+    /**
+     * Repopulates the search form with the data from the account enquiry search.
+     * @param state - The state object containing the search form data.
+     */
+    protected rePopulateForm(state: any): void;
+    /**
+     * Adds a new form control to the form group.
+     *
+     * @param controlName - The name of the control to add.
+     * @param validators - An array of validators to apply to the control.
+     */
+    protected createControl(controlName: string, validators: ValidatorFn[]): void;
+    /**
+     * Updates the validators of an existing form control.
+     *
+     * @param controlName - The name of the control to update.
+     * @param validators - An array of validators to apply to the control.
+     */
+    protected updateControl(controlName: string, validators: ValidatorFn[]): void;
+    /**
+     * Removes a control from the form.
+     *
+     * @param controlName - The name of the control to remove.
+     */
+    protected removeControl(controlName: string): void;
+    /**
+     * Removes the error message associated with the specified control name from the formControlErrorMessages object.
+     *
+     * @param controlName - The name of the control for which to remove the error message.
+     */
+    protected removeControlErrors(controlName: string): void;
+    /**
+     * Clears the search form.
+     */
+    handleClearForm(): void;
+    /**
+     * Handles the scroll of the component error from the summary
+     *
+     * @param fieldId - Field id of the component
+     */
+    scrollTo(fieldId: string): void;
+    /**
+     * Handles route with the supplied route
+     *
+     * @param route string of route
+     * @param nonRelative boolean indicating if route is relative to the parent
+     */
+    handleRoute(route: string, nonRelative?: boolean, event?: Event): void;
+    /**
+     * Handles the form submission event.
+     *
+     * @param event - The form submission event.
+     * @returns void
+     */
+    handleFormSubmit(event: SubmitEvent): void;
+    /**
+     * Handles the input event to convert all letters in the input value to uppercase.
+     * This method is triggered by an input event and modifies the input value directly.
+     *
+     * @param event - The input event triggered by the user.
+     */
+    handleUppercaseInputMask(event: Event): void;
+    ngOnInit(): void;
+    ngOnDestroy(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AbstractFormBaseComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<AbstractFormBaseComponent, "ng-component", never, {}, { "unsavedChanges": "unsavedChanges"; "formSubmit": "formSubmit"; }, never, never, true, never>;
+}

package/components/abstract/abstract-form-base/interfaces/abstract-form-base-field-error.interface.d.ts

@@ -0,0 +1,6 @@
+export interface IAbstractFormBaseFieldError {
+    [key: string]: {
+        message: string;
+        priority: number;
+    };
+}

package/components/abstract/abstract-form-base/interfaces/abstract-form-base-field-errors.interface.d.ts

@@ -0,0 +1,4 @@
+import { IAbstractFormBaseFieldError } from './abstract-form-base-field-error.interface';
+export interface IAbstractFormBaseFieldErrors {
+    [key: string]: IAbstractFormBaseFieldError;
+}

package/components/abstract/abstract-form-base/interfaces/abstract-form-base-form-error.interface.d.ts

@@ -0,0 +1,6 @@
+export interface IAbstractFormBaseFormError {
+    fieldId: string;
+    message: string | null;
+    priority: number;
+    type: string | null;
+}

package/components/abstract/abstract-form-base/interfaces/abstract-form-base-form.interface.d.ts

@@ -0,0 +1,4 @@
+export interface IAbstractFormBaseForm<T> {
+    formData: T;
+    nestedFlow: boolean;
+}

package/components/abstract/abstract-form-base/interfaces/abstract-form-base-high-priority-form-error.interface.d.ts

@@ -0,0 +1,5 @@
+export interface IAbstractFormBaseHighPriorityFormError {
+    message: string;
+    priority: number;
+    type: string;
+}

package/components/abstract/abstract-form-base/interfaces/abstract-form-base-status.interface.d.ts

@@ -0,0 +1,3 @@
+export interface IAbstractFormBaseStatus {
+    [key: string]: string;
+}

package/components/abstract/abstract-form-parent-base/abstract-form-parent-base.component.d.ts

@@ -0,0 +1,29 @@
+import { CanDeactivateTypes } from '@hmcts/opal-frontend-common/types';
+export declare abstract class AbstractFormParentBaseComponent {
+    private readonly router;
+    private readonly activatedRoute;
+    stateUnsavedChanges: boolean;
+    /**
+     * If the user navigates externally from the site or closes the tab
+     * Check if there is unsaved changes form state -> warning message
+     * Otherwise -> no warning message
+     *
+     * @returns boolean
+     */
+    canDeactivate(): CanDeactivateTypes;
+    /**
+     * Navigates to the specified route using the Angular router.
+     *
+     * @param route - The route to navigate to.
+     */
+    protected routerNavigate(route: string, nonRelative?: boolean, event?: Event): void;
+    /**
+     * Checks if an object has any non-empty values.
+     *
+     * @param form - The object representing form data with key-value pairs.
+     * @returns A boolean indicating whether the object has any non-empty values.
+     */
+    protected hasFormValues(form: {
+        [key: string]: any;
+    }): boolean;
+}