@hmcts/opal-frontend-common 0.0.17 → 0.0.19

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

@@ -1,85 +0,0 @@
-import * as i0 from "@angular/core";
-export 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>;
-}

package/stores/global/global.store.d.ts

@@ -1,37 +0,0 @@
-import { LDFlagSet } from 'launchdarkly-js-client-sdk';
-import { ITransferStateLaunchDarklyConfig, ITransferStateAppInsightsConfig } from '@hmcts/opal-frontend-common/services/transfer-state-service/interfaces';
-import { ISessionTokenExpiry, ISessionUserState } from '@hmcts/opal-frontend-common/services/session-service/interfaces';
-import { IErrorState } from '@hmcts/opal-frontend-common/stores/global/interfaces';
-export declare const GlobalStore: import("@angular/core").Type<{
-    authenticated: import("@angular/core").Signal<boolean>;
-    error: import("@ngrx/signals").DeepSignal<{
-        error: boolean;
-        message: string;
-    }>;
-    featureFlags: import("@angular/core").Signal<LDFlagSet>;
-    userState: import("@ngrx/signals").DeepSignal<ISessionUserState>;
-    ssoEnabled: import("@angular/core").Signal<boolean>;
-    launchDarklyConfig: import("@ngrx/signals").DeepSignal<ITransferStateLaunchDarklyConfig>;
-    appInsightsConfig: import("@ngrx/signals").DeepSignal<ITransferStateAppInsightsConfig>;
-    tokenExpiry: import("@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;
-} & import("@ngrx/signals").StateSource<{
-    authenticated: boolean;
-    error: {
-        error: boolean;
-        message: string;
-    };
-    featureFlags: LDFlagSet;
-    userState: ISessionUserState;
-    ssoEnabled: boolean;
-    launchDarklyConfig: ITransferStateLaunchDarklyConfig;
-    appInsightsConfig: ITransferStateAppInsightsConfig;
-    tokenExpiry: ISessionTokenExpiry;
-}>>;

package/stores/global/interfaces/error-state.interface.d.ts

@@ -1,4 +0,0 @@
-export interface IErrorState {
-    error: boolean;
-    message: string;
-}

package/stores/global/interfaces/public-api.d.ts

@@ -1 +0,0 @@
-export * from './error-state.interface';

package/stores/global/public-api.d.ts

@@ -1 +0,0 @@
-export * from './global.store';

package/stores/global/types/global-store.type.d.ts

@@ -1,2 +0,0 @@
-import { GlobalStore } from '@hmcts/opal-frontend-common/stores/global';
-export type GlobalStoreType = InstanceType<typeof GlobalStore>;

package/stores/global/types/public-api.d.ts

@@ -1 +0,0 @@
-export * from './global-store.type';

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

@@ -1,2 +0,0 @@
-import { ValidatorFn } from '@angular/forms';
-export declare function alphabeticalTextValidator(): ValidatorFn;

package/validators/alphabetical-text/public-api.d.ts

@@ -1 +0,0 @@
-export * from './alphabetical-text.validator';

package/validators/amount/amount.validator.d.ts

@@ -1,2 +0,0 @@
-import { ValidatorFn } from '@angular/forms';
-export declare function amountValidator(maxIntegers: number, maxDecimals: number): ValidatorFn;

package/validators/amount/public-api.d.ts

@@ -1 +0,0 @@
-export * from './amount.validator';

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

@@ -1,2 +0,0 @@
-import { ValidatorFn } from '@angular/forms';
-export declare function dateAfterYearValidator(year: number): ValidatorFn;

package/validators/date-after-year/public-api.d.ts

@@ -1 +0,0 @@
-export * from './date-after-year.validator';

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

@@ -1,2 +0,0 @@
-import { ValidatorFn } from '@angular/forms';
-export declare function dateBeforeValidator(targetDate: Date | null): ValidatorFn;

package/validators/date-before/public-api.d.ts

@@ -1 +0,0 @@
-export * from './date-before.validator';

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

@@ -1,2 +0,0 @@
-import { ValidatorFn } from '@angular/forms';
-export declare function dateOfBirthValidator(): ValidatorFn;

package/validators/date-of-birth/public-api.d.ts

@@ -1 +0,0 @@
-export * from './date-of-birth.validator';

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

@@ -1,2 +0,0 @@
-import { ValidatorFn } from '@angular/forms';
-export declare function futureDateValidator(): ValidatorFn;

package/validators/future-date/public-api.d.ts

@@ -1 +0,0 @@
-export * from './future-date.validator';

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

@@ -1,2 +0,0 @@
-import { ValidatorFn } from '@angular/forms';
-export declare function invalidValueValidator(invalidValues: string[]): ValidatorFn;

package/validators/invalid-value/public-api.d.ts

@@ -1 +0,0 @@
-export * from './invalid-value.validator';

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

@@ -1,2 +0,0 @@
-import { ValidatorFn } from '@angular/forms';
-export declare function nationalInsuranceNumberValidator(): ValidatorFn;

package/validators/national-insurance-number/public-api.d.ts

@@ -1 +0,0 @@
-export * from './national-insurance-number.validator';

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

@@ -1,2 +0,0 @@
-import { ValidatorFn } from '@angular/forms';
-export declare function numericalTextValidator(): ValidatorFn;

package/validators/numerical-only/public-api.d.ts

@@ -1 +0,0 @@
-export * from './numerical-only.validator';

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

@@ -1,2 +0,0 @@
-import { ValidatorFn } from '@angular/forms';
-export declare function optionalMaxLengthValidator(maxLength: number): ValidatorFn;

package/validators/optional-max-length/public-api.d.ts

@@ -1 +0,0 @@
-export * from './optional-max-length.validator';

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

@@ -1,2 +0,0 @@
-import { ValidatorFn } from '@angular/forms';
-export declare function optionalValidDateValidator(): ValidatorFn;

package/validators/optional-valid-date/public-api.d.ts

@@ -1 +0,0 @@
-export * from './optional-valid-date.validator';

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

@@ -1,2 +0,0 @@
-import { ValidatorFn } from '@angular/forms';
-export declare function optionalEmailAddressValidator(): ValidatorFn;

package/validators/optional-valid-email-address/public-api.d.ts

@@ -1 +0,0 @@
-export * from './optional-valid-email-address.validator';

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

@@ -1,2 +0,0 @@
-import { ValidatorFn } from '@angular/forms';
-export declare function optionalPhoneNumberValidator(): ValidatorFn;

package/validators/optional-valid-telephone/public-api.d.ts

@@ -1 +0,0 @@
-export * from './optional-valid-telephone.validator';

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

@@ -1,14 +0,0 @@
-import { ValidatorFn } from '@angular/forms';
-import { DateService } from '@hmcts/opal-frontend-common/services/date-service';
-/**
- * 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.
- */
-export declare const overEighteenValidator: (dayControl: string, monthControl: string, yearControl: string, dateService: DateService) => ValidatorFn;

package/validators/over-eighteen/public-api.d.ts

@@ -1 +0,0 @@
-export * from './over-eighteen.validator';

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

@@ -1,2 +0,0 @@
-import { ValidatorFn } from '@angular/forms';
-export declare function pastDateValidator(): ValidatorFn;

package/validators/past-date/public-api.d.ts

@@ -1 +0,0 @@
-export * from './past-date.validator';

package/validators/special-characters/public-api.d.ts

@@ -1 +0,0 @@
-export * from './special-characters.validator';

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

@@ -1,2 +0,0 @@
-import { ValidatorFn } from '@angular/forms';
-export declare function specialCharactersValidator(): ValidatorFn;

package/validators/two-decimal-places/public-api.d.ts

@@ -1 +0,0 @@
-export * from './two-decimal-places.validator';

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

@@ -1,2 +0,0 @@
-import { ValidatorFn } from '@angular/forms';
-export declare function twoDecimalPlacesValidator(): ValidatorFn;

package/validators/valid-value/public-api.d.ts

@@ -1 +0,0 @@
-export * from './valid-value.validator';

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

@@ -1,2 +0,0 @@
-import { ValidatorFn } from '@angular/forms';
-export declare function validValueValidator(validValues: string[]): ValidatorFn;