@hmcts/opal-frontend-common 0.0.17 → 0.0.18

package/services/sort-service/index.d.ts

@@ -1,5 +1,67 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/services/sort-service" />
-export * from './public-api';
+import { ISortServiceArrayValues, ISortServiceValues } from '@hmcts/opal-frontend-common/services/sort-service/interfaces';
+import { SortableValuesType } from '@hmcts/opal-frontend-common/components/abstract/abstract-sortable-table/types';
+import * as i0 from '@angular/core';
+
+declare class SortService {
+    /**
+     * Sorts an array of values in ascending order.
+     *
+     * @param array - The array of values to be sorted.
+     * @returns The sorted array in ascending order.
+     */
+    arraySortAsc(array: ISortServiceArrayValues): ISortServiceArrayValues;
+    /**
+     * Sorts an array of values in descending order.
+     *
+     * @param array - The array of values to be sorted.
+     * @returns The sorted array in descending order.
+     */
+    arraySortDesc(array: ISortServiceArrayValues): ISortServiceArrayValues;
+    /**
+     * Sorts an array of objects based on a specified key and sort type.
+     *
+     * @param array - The array of objects to be sorted. Each object should implement the `ISortServiceValues` interface.
+     * @param config - The configuration object containing the key to sort by and the sort type (ascending or descending).
+     * @returns The sorted array of objects.
+     *
+     * @remarks
+     * - If the input array is not an array or the config key is not provided, the original array is returned.
+     * - The `sortType` can be either 'ascending' or 'descending'.
+     *
+     * @example
+     * ```typescript
+     * const array = [
+     *   { name: 'Alice', age: 30 },
+     *   { name: 'Bob', age: 25 },
+     * ];
+     * const config = { key: 'age', sortType: 'ascending' };
+     * const sortedArray = getObjects(array, config);
+     * // sortedArray will be:
+     * // [
+     * //   { name: 'Bob', age: 25 },
+     * //   { name: 'Alice', age: 30 },
+     * // ]
+     * ```
+     */
+    private sortObjectArray;
+    /**
+     * Sorts an array of objects in ascending order based on the specified key.
+     *
+     * @param array - The array of objects to be sorted.
+     * @param key - The key of the object property to sort by.
+     * @returns The sorted array of objects.
+     */
+    sortObjectArrayAsc(array: ISortServiceValues<SortableValuesType>[] | null, key: string): ISortServiceValues<SortableValuesType>[] | null;
+    /**
+     * Sorts an array of objects in descending order based on the specified key.
+     *
+     * @param array - The array of objects to be sorted. Each object should implement the ISortServiceValues interface.
+     * @param key - The key of the object property to sort by.
+     * @returns The sorted array of objects in descending order.
+     */
+    sortObjectArrayDesc(array: ISortServiceValues<SortableValuesType>[] | null, key: string): ISortServiceValues<SortableValuesType>[] | null;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SortService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<SortService>;
+}
+
+export { SortService };

package/services/sort-service/interfaces/index.d.ts

@@ -1,5 +1,15 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/services/sort-service/interfaces" />
-export * from './public-api';
+import { SortableValuesType } from '@hmcts/opal-frontend-common/components/abstract/abstract-sortable-table/types';
+
+interface ISortServiceValues<T extends SortableValuesType> {
+    [key: string]: T;
+}
+interface ISortServiceArrayValues extends Array<SortableValuesType> {
+    [key: number]: SortableValuesType;
+}
+
+interface ISortServiceConfig {
+    key: string;
+    sortType: 'ascending' | 'descending';
+}
+
+export type { ISortServiceArrayValues, ISortServiceConfig, ISortServiceValues };

package/services/transfer-state-service/index.d.ts

@@ -1,5 +1,31 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/services/transfer-state-service" />
-export * from './public-api';
+import * as i0 from '@angular/core';
+import { PLATFORM_ID, TransferState } from '@angular/core';
+import { ITransferStateServerState } from '@hmcts/opal-frontend-common/services/transfer-state-service/interfaces';
+
+declare class TransferStateService {
+    private readonly platformId;
+    readonly serverTransferState: ITransferStateServerState | null;
+    private readonly transferState;
+    private readonly globalStore;
+    private readonly storedServerTransferState;
+    constructor(platformId: typeof PLATFORM_ID, serverTransferState: ITransferStateServerState | null, transferState: TransferState);
+    /**
+     * Initializes the SSO (Single Sign-On) enabled state.
+     * Sets the SSO enabled state based on the stored server transfer state.
+     */
+    initializeSsoEnabled(): void;
+    /**
+     * Initializes the LaunchDarkly configuration by assigning the stored server transfer state's
+     * launchDarklyConfig value to the globalStore's launchDarklyConfig property.
+     */
+    initializeLaunchDarklyConfig(): void;
+    /**
+     * Initializes the Application Insights configuration by assigning the stored server transfer state's
+     * appInsightsConfig value to the globalStore's appInsightsConfig property.
+     */
+    initializeAppInsightsConfig(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<TransferStateService, [null, { optional: true; }, null]>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<TransferStateService>;
+}
+
+export { TransferStateService };

package/services/transfer-state-service/interfaces/index.d.ts

@@ -1,5 +1,19 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/services/transfer-state-service/interfaces" />
-export * from './public-api';
+interface ITransferStateAppInsightsConfig {
+    enabled: boolean;
+    connectionString: string;
+    cloudRoleName: string;
+}
+
+interface ITransferStateLaunchDarklyConfig {
+    enabled: boolean | null;
+    clientId: string | null;
+    stream: boolean | null;
+}
+
+interface ITransferStateServerState {
+    launchDarklyConfig: ITransferStateLaunchDarklyConfig;
+    ssoEnabled: boolean;
+    appInsightsConfig: ITransferStateAppInsightsConfig;
+}
+
+export type { ITransferStateAppInsightsConfig, ITransferStateLaunchDarklyConfig, ITransferStateServerState };

package/services/transfer-state-service/mocks/index.d.ts

@@ -1,5 +1,17 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/services/transfer-state-service/mocks" />
-export * from './public-api';
+import { ITransferStateServerState } from '@hmcts/opal-frontend-common/services/transfer-state-service/interfaces';
+
+declare const TRANSFER_STATE_APP_INSIGHTS_CONFIG_MOCK: {
+    enabled: boolean;
+    connectionString: string;
+    cloudRoleName: string;
+};
+
+declare const TRANSFER_STATE_LAUNCH_DARKLY_CONFIG_MOCK: {
+    enabled: boolean;
+    clientId: string;
+    stream: boolean;
+};
+
+declare const TRANSFER_STATE_MOCK: ITransferStateServerState;
+
+export { TRANSFER_STATE_APP_INSIGHTS_CONFIG_MOCK, TRANSFER_STATE_LAUNCH_DARKLY_CONFIG_MOCK, TRANSFER_STATE_MOCK };

package/services/transformation-service/index.d.ts

@@ -1,5 +1,33 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/services/transformation-service" />
-export * from './public-api';
+import { ITransformItem } from '@hmcts/opal-frontend-common/services/transformation-service/interfaces';
+import * as i0 from '@angular/core';
+
+declare class TransformationService {
+    private readonly dateService;
+    /**
+     * Applies a transformation to the given value based on the specified transformation configuration.
+     *
+     * @param value - The value to be transformed.
+     * @param transformItem - The configuration for the transformation, including the type of transformation and any necessary format details.
+     * @returns The transformed value, or the original value if no transformation is applied.
+     */
+    private applyTransformation;
+    /**
+     * Transforms the values of an object based on a given transformation configuration.
+     *
+     * @param obj - The object whose values need to be transformed. It should be a non-null object.
+     * @param toTransform - An array of transformation configurations, where each configuration specifies
+     *                      the key to transform and the transformation details.
+     * @returns The transformed object with values modified according to the transformation configuration.
+     *
+     * @remarks
+     * - If the input `obj` is not an object or is null, it returns the input as is.
+     * - The function recursively processes nested objects.
+     */
+    transformObjectValues(obj: {
+        [key: string]: any;
+    }, toTransform: ITransformItem[]): any;
+    static ɵfac: i0.ɵɵFactoryDeclaration<TransformationService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<TransformationService>;
+}
+
+export { TransformationService };

package/services/transformation-service/interfaces/index.d.ts

@@ -1,5 +1,8 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/services/transformation-service/interfaces" />
-export * from './public-api';
+interface ITransformItem {
+    key: string;
+    transformType: string;
+    dateInputFormat: string | null;
+    dateOutputFormat: string | null;
+}
+
+export type { ITransformItem };

package/services/utils-service/index.d.ts

@@ -1,5 +1,88 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/services/utils-service" />
-export * from './public-api';
+import * as i0 from '@angular/core';
+
+declare class UtilsService {
+    private readonly viewportScroller;
+    /**
+     * Converts the first letter of a string to uppercase.
+     * @param str - The input string.
+     * @returns The input string with the first letter capitalized.
+     */
+    upperCaseFirstLetter(str: string): string;
+    /**
+     * Converts the entire string to uppercase.
+     * @param str - The input string.
+     * @returns The input string in uppercase.
+     */
+    upperCaseAllLetters(str: string): string;
+    /**
+     * Converts a number to a monetary string representation.
+     * @param amount - The number to convert.
+     * @returns The monetary string representation of the number.
+     */
+    convertToMonetaryString(amount: number | string): string;
+    /**
+     * Formats a 6-digit number or string as a sort code.
+     * @param value - The 6-digit value to format.
+     * @returns The formatted sort code string (xx-xx-xx).
+     */
+    formatSortCode(value: string | number): string;
+    /**
+     * Filters out null or empty strings from an array of address lines.
+     *
+     * @param address - An array of address lines which may contain strings or null values.
+     * @returns A new array containing only non-empty strings from the input array.
+     */
+    formatAddress(address: (string | null)[]): string[];
+    /**
+     * Scrolls the viewport to the top of the page.
+     * Utilizes the `viewportScroller` service to scroll to the position [0, 0].
+     */
+    scrollToTop(): void;
+    checkFormValues(form: {
+        [key: string]: any;
+    }): boolean;
+    checkFormArrayValues(forms: {
+        [key: string]: any;
+    }[]): boolean;
+    getFormStatus(form: {
+        [key: string]: any;
+    }, providedMessage: string, notProvidedMessage: string): string;
+    getArrayFormStatus(forms: {
+        [key: string]: any;
+    }[], providedMessage: string, notProvidedMessage: string): string;
+    /**
+     * Copies the provided string value to the clipboard.
+     *
+     * @param value - The string value to be copied to the clipboard.
+     *
+     * @remarks
+     * This method uses the `navigator.clipboard.writeText` API to copy text to the clipboard.
+     * Ensure that the browser supports the Clipboard API before using this method.
+     */
+    copyToClipboard(value: string): Promise<void>;
+    /**
+     * Recursively filters out properties from an object where the value is `null` or `undefined`.
+     *
+     * @param obj - The object to filter. Can include nested objects.
+     * @returns A new object with only non-null and non-undefined values.
+     *
+     * @example
+     * ```ts
+     * const input = {
+     *   a: 1,
+     *   b: null,
+     *   c: undefined,
+     *   d: 'hello',
+     *   e: { x: null, y: 2 },
+     *   f: { z: undefined },
+     * };
+     * const result = filterNullOrUndefined(input);
+     * console.log(result); // Output: { a: 1, d: 'hello', e: { y: 2 } }
+     * ```
+     */
+    filterNullOrUndefined(obj: Record<string, unknown>): Record<string, unknown>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<UtilsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<UtilsService>;
+}
+
+export { UtilsService };

package/stores/global/index.d.ts

@@ -1,5 +1,42 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/stores/global" />
-export * from './public-api';
+import * as _ngrx_signals from '@ngrx/signals';
+import * as _angular_core from '@angular/core';
+import { LDFlagSet } from 'launchdarkly-js-client-sdk';
+import { ITransferStateLaunchDarklyConfig, ITransferStateAppInsightsConfig } from '@hmcts/opal-frontend-common/services/transfer-state-service/interfaces';
+import { ISessionUserState, ISessionTokenExpiry } from '@hmcts/opal-frontend-common/services/session-service/interfaces';
+import { IErrorState } from '@hmcts/opal-frontend-common/stores/global/interfaces';
+
+declare const GlobalStore: _angular_core.Type<{
+    authenticated: _angular_core.Signal<boolean>;
+    error: _ngrx_signals.DeepSignal<{
+        error: boolean;
+        message: string;
+    }>;
+    featureFlags: _angular_core.Signal<LDFlagSet>;
+    userState: _ngrx_signals.DeepSignal<ISessionUserState>;
+    ssoEnabled: _angular_core.Signal<boolean>;
+    launchDarklyConfig: _ngrx_signals.DeepSignal<ITransferStateLaunchDarklyConfig>;
+    appInsightsConfig: _ngrx_signals.DeepSignal<ITransferStateAppInsightsConfig>;
+    tokenExpiry: _ngrx_signals.DeepSignal<ISessionTokenExpiry>;
+    setAuthenticated: (authenticated: boolean) => void;
+    setError: (error: IErrorState) => void;
+    setFeatureFlags: (featureFlags: LDFlagSet) => void;
+    setUserState: (userState: ISessionUserState) => void;
+    setSsoEnabled: (ssoEnabled: boolean) => void;
+    setLaunchDarklyConfig: (config: ITransferStateLaunchDarklyConfig) => void;
+    setAppInsightsConfig: (config: ITransferStateAppInsightsConfig) => void;
+    setTokenExpiry: (tokenExpiry: ISessionTokenExpiry) => void;
+} & _ngrx_signals.StateSource<{
+    authenticated: boolean;
+    error: {
+        error: boolean;
+        message: string;
+    };
+    featureFlags: LDFlagSet;
+    userState: ISessionUserState;
+    ssoEnabled: boolean;
+    launchDarklyConfig: ITransferStateLaunchDarklyConfig;
+    appInsightsConfig: ITransferStateAppInsightsConfig;
+    tokenExpiry: ISessionTokenExpiry;
+}>>;
+
+export { GlobalStore };

package/stores/global/interfaces/index.d.ts

@@ -1,5 +1,6 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/stores/global/interfaces" />
-export * from './public-api';
+interface IErrorState {
+    error: boolean;
+    message: string;
+}
+
+export type { IErrorState };

package/stores/global/types/index.d.ts

@@ -1,5 +1,5 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/stores/global/types" />
-export * from './public-api';
+import { GlobalStore } from '@hmcts/opal-frontend-common/stores/global';
+
+type GlobalStoreType = InstanceType<typeof GlobalStore>;
+
+export type { GlobalStoreType };

package/validators/alphabetical-text/index.d.ts

@@ -1,5 +1,5 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/validators/alphabetical-text" />
-export * from './public-api';
+import { ValidatorFn } from '@angular/forms';
+
+declare function alphabeticalTextValidator(): ValidatorFn;
+
+export { alphabeticalTextValidator };

package/validators/amount/index.d.ts

@@ -1,5 +1,5 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/validators/amount" />
-export * from './public-api';
+import { ValidatorFn } from '@angular/forms';
+
+declare function amountValidator(maxIntegers: number, maxDecimals: number): ValidatorFn;
+
+export { amountValidator };

package/validators/date-after-year/index.d.ts

@@ -1,5 +1,5 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/validators/date-after-year" />
-export * from './public-api';
+import { ValidatorFn } from '@angular/forms';
+
+declare function dateAfterYearValidator(year: number): ValidatorFn;
+
+export { dateAfterYearValidator };

package/validators/date-before/index.d.ts

@@ -1,5 +1,5 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/validators/date-before" />
-export * from './public-api';
+import { ValidatorFn } from '@angular/forms';
+
+declare function dateBeforeValidator(targetDate: Date | null): ValidatorFn;
+
+export { dateBeforeValidator };

package/validators/date-of-birth/index.d.ts

@@ -1,5 +1,5 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/validators/date-of-birth" />
-export * from './public-api';
+import { ValidatorFn } from '@angular/forms';
+
+declare function dateOfBirthValidator(): ValidatorFn;
+
+export { dateOfBirthValidator };

package/validators/future-date/index.d.ts

@@ -1,5 +1,5 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/validators/future-date" />
-export * from './public-api';
+import { ValidatorFn } from '@angular/forms';
+
+declare function futureDateValidator(): ValidatorFn;
+
+export { futureDateValidator };

package/validators/invalid-value/index.d.ts

@@ -1,5 +1,5 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/validators/invalid-value" />
-export * from './public-api';
+import { ValidatorFn } from '@angular/forms';
+
+declare function invalidValueValidator(invalidValues: string[]): ValidatorFn;
+
+export { invalidValueValidator };

package/validators/national-insurance-number/index.d.ts

@@ -1,5 +1,5 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/validators/national-insurance-number" />
-export * from './public-api';
+import { ValidatorFn } from '@angular/forms';
+
+declare function nationalInsuranceNumberValidator(): ValidatorFn;
+
+export { nationalInsuranceNumberValidator };

package/validators/numerical-only/index.d.ts

@@ -1,5 +1,5 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/validators/numerical-only" />
-export * from './public-api';
+import { ValidatorFn } from '@angular/forms';
+
+declare function numericalTextValidator(): ValidatorFn;
+
+export { numericalTextValidator };

package/validators/optional-max-length/index.d.ts

@@ -1,5 +1,5 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/validators/optional-max-length" />
-export * from './public-api';
+import { ValidatorFn } from '@angular/forms';
+
+declare function optionalMaxLengthValidator(maxLength: number): ValidatorFn;
+
+export { optionalMaxLengthValidator };

package/validators/optional-valid-date/index.d.ts

@@ -1,5 +1,5 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/validators/optional-valid-date" />
-export * from './public-api';
+import { ValidatorFn } from '@angular/forms';
+
+declare function optionalValidDateValidator(): ValidatorFn;
+
+export { optionalValidDateValidator };

package/validators/optional-valid-email-address/index.d.ts

@@ -1,5 +1,5 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/validators/optional-valid-email-address" />
-export * from './public-api';
+import { ValidatorFn } from '@angular/forms';
+
+declare function optionalEmailAddressValidator(): ValidatorFn;
+
+export { optionalEmailAddressValidator };

package/validators/optional-valid-telephone/index.d.ts

@@ -1,5 +1,5 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/validators/optional-valid-telephone" />
-export * from './public-api';
+import { ValidatorFn } from '@angular/forms';
+
+declare function optionalPhoneNumberValidator(): ValidatorFn;
+
+export { optionalPhoneNumberValidator };

package/validators/over-eighteen/index.d.ts

@@ -1,5 +1,17 @@
+import { ValidatorFn } from '@angular/forms';
+import { DateService } from '@hmcts/opal-frontend-common/services/date-service';
+
 /**
- * Generated bundle index. Do not edit.
+ * Validates whether a date, constructed from provided form controls for day, month and year
+ * is at least 18 years in the past.
+ *
+ * @param dayControl - Name of the control for the day portion of the date
+ * @param monthControl - Name of the control for the month portion of the date
+ * @param yearControl  - Name of the control for the year portion of the date
+ * @param dateService - An instance of DateService
+ * @returns Validator function that returns null if the date is valid and the age is 18 years older,
+ * or an error object within { underEighteen: true } if under 18.
  */
-/// <amd-module name="@hmcts/opal-frontend-common/validators/over-eighteen" />
-export * from './public-api';
+declare const overEighteenValidator: (dayControl: string, monthControl: string, yearControl: string, dateService: DateService) => ValidatorFn;
+
+export { overEighteenValidator };

package/validators/past-date/index.d.ts

@@ -1,5 +1,5 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/validators/past-date" />
-export * from './public-api';
+import { ValidatorFn } from '@angular/forms';
+
+declare function pastDateValidator(): ValidatorFn;
+
+export { pastDateValidator };

package/validators/special-characters/index.d.ts

@@ -1,5 +1,5 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/validators/special-characters" />
-export * from './public-api';
+import { ValidatorFn } from '@angular/forms';
+
+declare function specialCharactersValidator(): ValidatorFn;
+
+export { specialCharactersValidator };

package/validators/two-decimal-places/index.d.ts

@@ -1,5 +1,5 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/validators/two-decimal-places" />
-export * from './public-api';
+import { ValidatorFn } from '@angular/forms';
+
+declare function twoDecimalPlacesValidator(): ValidatorFn;
+
+export { twoDecimalPlacesValidator };

package/validators/valid-value/index.d.ts

@@ -1,5 +1,5 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="@hmcts/opal-frontend-common/validators/valid-value" />
-export * from './public-api';
+import { ValidatorFn } from '@angular/forms';
+
+declare function validValueValidator(validValues: string[]): ValidatorFn;
+
+export { validValueValidator };