@hmcts/opal-frontend-common 0.0.2

package/lib/services/transfer-state-service/interfaces/transfer-state-app-insights-config.interface.d.ts

@@ -0,0 +1,5 @@
+export interface ITransferStateAppInsightsConfig {
+    enabled: boolean | null;
+    connectionString: string | null;
+    cloudRoleName: string | null;
+}

package/lib/services/transfer-state-service/interfaces/transfer-state-launch-darkly-config.interface.d.ts

@@ -0,0 +1,5 @@
+export interface ITransferStateLaunchDarklyConfig {
+    enabled: boolean | null;
+    clientId: string | null;
+    stream: boolean | null;
+}

package/lib/services/transfer-state-service/interfaces/transfer-state-server-state.interface.d.ts

@@ -0,0 +1,7 @@
+import { ITransferStateAppInsightsConfig } from './transfer-state-app-insights-config.interface';
+import { ITransferStateLaunchDarklyConfig } from './transfer-state-launch-darkly-config.interface';
+export interface ITransferStateServerState {
+    launchDarklyConfig: ITransferStateLaunchDarklyConfig;
+    ssoEnabled: boolean;
+    appInsightsConfig: ITransferStateAppInsightsConfig;
+}

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

@@ -0,0 +1,3 @@
+export * from './transfer-state-app-insights-config.mock';
+export * from './transfer-state-launch-darkly-config.mock';
+export * from './transfer-state.mock';

package/lib/services/transfer-state-service/mocks/transfer-state-app-insights-config.mock.d.ts

@@ -0,0 +1,5 @@
+export declare const TRANSFER_STATE_APP_INSIGHTS_CONFIG_MOCK: {
+    enabled: boolean;
+    connectionString: string;
+    cloudRoleName: string;
+};

package/lib/services/transfer-state-service/mocks/transfer-state-launch-darkly-config.mock.d.ts

@@ -0,0 +1,5 @@
+export declare const TRANSFER_STATE_LAUNCH_DARKLY_CONFIG_MOCK: {
+    enabled: boolean;
+    clientId: string;
+    stream: boolean;
+};

package/lib/services/transfer-state-service/mocks/transfer-state.mock.d.ts

@@ -0,0 +1,2 @@
+import { ITransferStateServerState } from '../interfaces/transfer-state-server-state.interface';
+export declare const TRANSFER_STATE_MOCK: ITransferStateServerState;

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

@@ -0,0 +1,23 @@
+import { PLATFORM_ID, TransferState } from '@angular/core';
+import { ITransferStateServerState } from './interfaces/transfer-state-server-state.interface';
+import * as i0 from "@angular/core";
+export 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;
+    static ɵfac: i0.ɵɵFactoryDeclaration<TransferStateService, [null, { optional: true; }, null]>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<TransferStateService>;
+}

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

@@ -0,0 +1,2 @@
+export * from './transformation.service';
+export * from './interfaces';

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

@@ -0,0 +1 @@
+export * from './transform-item.interface';

package/lib/services/transformation-service/interfaces/transform-item.interface.d.ts

@@ -0,0 +1,6 @@
+export interface ITransformItem {
+    key: string;
+    transformType: string;
+    dateInputFormat: string | null;
+    dateOutputFormat: string | null;
+}

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

@@ -0,0 +1,30 @@
+import { ITransformItem } from './interfaces/transform-item.interface';
+import * as i0 from "@angular/core";
+export 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>;
+}

package/lib/services/utils/index.d.ts

@@ -0,0 +1 @@
+export * from './utils.service';

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

@@ -0,0 +1,54 @@
+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;
+    static ɵfac: i0.ɵɵFactoryDeclaration<UtilsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<UtilsService>;
+}

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

@@ -0,0 +1,35 @@
+import { LDFlagSet } from 'launchdarkly-js-client-sdk';
+import { IErrorState } from './interfaces/error-state.interface';
+import { ISessionUserState } from '../../services/session-service/interfaces/session-user-state.interface';
+import { ITransferStateLaunchDarklyConfig } from '../../services/transfer-state-service/interfaces/transfer-state-launch-darkly-config.interface';
+import { ISessionTokenExpiry } from '../../services/session-service/interfaces/session-token-expiry.interface';
+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>;
+    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;
+    setTokenExpiry: (tokenExpiry: ISessionTokenExpiry) => void;
+} & import("@ngrx/signals").StateSource<{
+    authenticated: boolean;
+    error: {
+        error: boolean;
+        message: string;
+    };
+    featureFlags: LDFlagSet;
+    userState: ISessionUserState;
+    ssoEnabled: boolean;
+    launchDarklyConfig: ITransferStateLaunchDarklyConfig;
+    tokenExpiry: ISessionTokenExpiry;
+}>>;

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

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

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

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

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

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

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

@@ -0,0 +1,2 @@
+import { GlobalStore } from '../global.store';
+export type GlobalStoreType = InstanceType<typeof GlobalStore>;

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

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

package/lib/stores/index.d.ts

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

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

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

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

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

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

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

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

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

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

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

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

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

package/lib/validators/index.d.ts

@@ -0,0 +1,19 @@
+import { alphabeticalTextValidator } from './alphabetical-text/alphabetical-text.validator';
+import { amountValidator } from './amount/amount.validator';
+import { dateAfterYearValidator } from './date-after-year/date-after-year.validator';
+import { dateBeforeValidator } from './date-before/date-before.validator';
+import { dateOfBirthValidator } from './date-of-birth/date-of-birth.validator';
+import { futureDateValidator } from './future-date/future-date.validator';
+import { invalidValueValidator } from './invalid-value/invalid-value.validator';
+import { nationalInsuranceNumberValidator } from './national-insurance-number/national-insurance-number.validator';
+import { numericalTextValidator } from './numerical-only/numerical-only.validator';
+import { optionalMaxLengthValidator } from './optional-max-length/optional-max-length.validator';
+import { optionalValidDateValidator } from './optional-valid-date/optional-valid-date.validator';
+import { optionalEmailAddressValidator } from './optional-valid-email-address/optional-valid-email-address.validator';
+import { optionalPhoneNumberValidator } from './optional-valid-telephone/optional-valid-telephone.validator';
+import { overEighteenValidator } from './over-eighteen/over-eighteen.validator';
+import { pastDateValidator } from './past-date/past-date.validator';
+import { specialCharactersValidator } from './special-characters/special-characters.validator';
+import { twoDecimalPlacesValidator } from './two-decimal-places/two-decimal-places.validator';
+import { validValueValidator } from './valid-value/valid-value.validator';
+export { alphabeticalTextValidator, amountValidator, dateAfterYearValidator, dateBeforeValidator, dateOfBirthValidator, futureDateValidator, invalidValueValidator, nationalInsuranceNumberValidator, numericalTextValidator, optionalMaxLengthValidator, optionalValidDateValidator, optionalEmailAddressValidator, optionalPhoneNumberValidator, overEighteenValidator, pastDateValidator, specialCharactersValidator, twoDecimalPlacesValidator, validValueValidator, };

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,14 @@
+import { ValidatorFn } from '@angular/forms';
+import { DateService } from '../../services/date-service/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/lib/validators/past-date/past-date.validator.d.ts

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

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

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

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

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

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

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

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@hmcts/opal-frontend-common",
+  "version": "0.0.2",
+  "peerDependencies": {
+    "@angular/common": "^18.2.0",
+    "@angular/core": "^18.2.0"
+  },
+  "dependencies": {
+    "tslib": "^2.3.0"
+  },
+  "sideEffects": false,
+  "exports": {
+    "./services": {
+      "default": "./services/public-api"
+    },
+    "./package.json": {
+      "default": "./package.json"
+    },
+    ".": {
+      "types": "./index.d.ts",
+      "esm2022": "./esm2022/hmcts-opal-frontend-common.mjs",
+      "esm": "./esm2022/hmcts-opal-frontend-common.mjs",
+      "default": "./fesm2022/hmcts-opal-frontend-common.mjs"
+    }
+  },
+  "module": "fesm2022/hmcts-opal-frontend-common.mjs",
+  "typings": "index.d.ts"
+}

package/public-api.d.ts

@@ -0,0 +1,10 @@
+export * from './lib/opal-frontend-common.module';
+export * from './lib/components/govuk';
+export * from './lib/guards';
+export * from './lib/interceptors';
+export * from './lib/pages';
+export * from './lib/resolvers';
+export * from './lib/routing';
+export * from './lib/services';
+export * from './lib/stores';
+export * from './lib/validators';